blockdev.c

   1 /*
   2  * QEMU host block devices
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  *
   6  * This work is licensed under the terms of the GNU GPL, version 2 or
   7  * later.  See the COPYING file in the top-level directory.
   8  *
   9  * This file incorporates work covered by the following copyright and
  10  * permission notice:
  11  *
  12  * Copyright (c) 2003-2008 Fabrice Bellard
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a copy
  15  * of this software and associated documentation files (the "Software"), to deal
  16  * in the Software without restriction, including without limitation the rights
  17  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  18  * copies of the Software, and to permit persons to whom the Software is
  19  * furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice shall be included in
  22  * all copies or substantial portions of the Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  27  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  29  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  30  * THE SOFTWARE.
  31  */
  32
  33 #include "qemu/osdep.h"
  34 #include "sysemu/block-backend.h"
  35 #include "sysemu/blockdev.h"
  36 #include "hw/block/block.h"
  37 #include "block/blockjob.h"
  38 #include "block/dirty-bitmap.h"
  39 #include "block/qdict.h"
  40 #include "block/throttle-groups.h"
  41 #include "monitor/monitor.h"
  42 #include "qemu/error-report.h"
  43 #include "qemu/option.h"
  44 #include "qemu/qemu-print.h"
  45 #include "qemu/config-file.h"
  46 #include "qapi/qapi-commands-block.h"
  47 #include "qapi/qapi-commands-transaction.h"
  48 #include "qapi/qapi-visit-block-core.h"
  49 #include "qapi/qmp/qdict.h"
  50 #include "qapi/qmp/qnum.h"
  51 #include "qapi/qmp/qstring.h"
  52 #include "qapi/error.h"
  53 #include "qapi/qmp/qerror.h"
  54 #include "qapi/qmp/qlist.h"
  55 #include "qapi/qobject-output-visitor.h"
  56 #include "sysemu/sysemu.h"
  57 #include "sysemu/iothread.h"
  58 #include "block/block_int.h"
  59 #include "block/trace.h"
  60 #include "sysemu/runstate.h"
  61 #include "sysemu/replay.h"
  62 #include "qemu/cutils.h"
  63 #include "qemu/help_option.h"
  64 #include "qemu/main-loop.h"
  65 #include "qemu/throttle-options.h"
  66
  67 /* Protected by BQL */
  68 QTAILQ_HEAD(, BlockDriverState) monitor_bdrv_states =
  69     QTAILQ_HEAD_INITIALIZER(monitor_bdrv_states);
  70
  71 void bdrv_set_monitor_owned(BlockDriverState *bs)
  72 {
  73     GLOBAL_STATE_CODE();
  74     QTAILQ_INSERT_TAIL(&monitor_bdrv_states, bs, monitor_list);
  75 }
  76
  77 static const char *const if_name[IF_COUNT] = {
  78     [IF_NONE] = "none",
  79     [IF_IDE] = "ide",
  80     [IF_SCSI] = "scsi",
  81     [IF_FLOPPY] = "floppy",
  82     [IF_PFLASH] = "pflash",
  83     [IF_MTD] = "mtd",
  84     [IF_SD] = "sd",
  85     [IF_VIRTIO] = "virtio",
  86     [IF_XEN] = "xen",
  87 };
  88
  89 static int if_max_devs[IF_COUNT] = {
  90     /*
  91      * Do not change these numbers!  They govern how drive option
  92      * index maps to unit and bus.  That mapping is ABI.
  93      *
  94      * All controllers used to implement if=T drives need to support
  95      * if_max_devs[T] units, for any T with if_max_devs[T] != 0.
  96      * Otherwise, some index values map to "impossible" bus, unit
  97      * values.
  98      *
  99      * For instance, if you change [IF_SCSI] to 255, -drive
 100      * if=scsi,index=12 no longer means bus=1,unit=5, but
 101      * bus=0,unit=12.  With an lsi53c895a controller (7 units max),
 102      * the drive can't be set up.  Regression.
 103      */
 104     [IF_IDE] = 2,
 105     [IF_SCSI] = 7,
 106 };
 107
 108 /**
 109  * Boards may call this to offer board-by-board overrides
 110  * of the default, global values.
 111  */
 112 void override_max_devs(BlockInterfaceType type, int max_devs)
 113 {
 114     BlockBackend *blk;
 115     DriveInfo *dinfo;
 116
 117     GLOBAL_STATE_CODE();
 118
 119     if (max_devs <= 0) {
 120         return;
 121     }
 122
 123     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 124         dinfo = blk_legacy_dinfo(blk);
 125         if (dinfo->type == type) {
 126             fprintf(stderr, "Cannot override units-per-bus property of"
 127                     " the %s interface, because a drive of that type has"
 128                     " already been added.\n", if_name[type]);
 129             g_assert_not_reached();
 130         }
 131     }
 132
 133     if_max_devs[type] = max_devs;
 134 }
 135
 136 /*
 137  * We automatically delete the drive when a device using it gets
 138  * unplugged.  Questionable feature, but we can't just drop it.
 139  * Device models call blockdev_mark_auto_del() to schedule the
 140  * automatic deletion, and generic qdev code calls blockdev_auto_del()
 141  * when deletion is actually safe.
 142  */
 143 void blockdev_mark_auto_del(BlockBackend *blk)
 144 {
 145     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 146     BlockJob *job;
 147
 148     GLOBAL_STATE_CODE();
 149
 150     if (!dinfo) {
 151         return;
 152     }
 153
 154     JOB_LOCK_GUARD();
 155
 156     do {
 157         job = block_job_next_locked(NULL);
 158         while (job && (job->job.cancelled ||
 159                        job->job.deferred_to_main_loop ||
 160                        !block_job_has_bdrv(job, blk_bs(blk))))
 161         {
 162             job = block_job_next_locked(job);
 163         }
 164         if (job) {
 165             /*
 166              * This drops the job lock temporarily and polls, so we need to
 167              * restart processing the list from the start after this.
 168              */
 169             job_cancel_locked(&job->job, false);
 170         }
 171     } while (job);
 172
 173     dinfo->auto_del = 1;
 174 }
 175
 176 void blockdev_auto_del(BlockBackend *blk)
 177 {
 178     DriveInfo *dinfo = blk_legacy_dinfo(blk);
 179     GLOBAL_STATE_CODE();
 180
 181     if (dinfo && dinfo->auto_del) {
 182         monitor_remove_blk(blk);
 183         blk_unref(blk);
 184     }
 185 }
 186
 187 static int drive_index_to_bus_id(BlockInterfaceType type, int index)
 188 {
 189     int max_devs = if_max_devs[type];
 190     return max_devs ? index / max_devs : 0;
 191 }
 192
 193 static int drive_index_to_unit_id(BlockInterfaceType type, int index)
 194 {
 195     int max_devs = if_max_devs[type];
 196     return max_devs ? index % max_devs : index;
 197 }
 198
 199 QemuOpts *drive_add(BlockInterfaceType type, int index, const char *file,
 200                     const char *optstr)
 201 {
 202     QemuOpts *opts;
 203
 204     GLOBAL_STATE_CODE();
 205
 206     opts = qemu_opts_parse_noisily(qemu_find_opts("drive"), optstr, false);
 207     if (!opts) {
 208         return NULL;
 209     }
 210     if (type != IF_DEFAULT) {
 211         qemu_opt_set(opts, "if", if_name[type], &error_abort);
 212     }
 213     if (index >= 0) {
 214         qemu_opt_set_number(opts, "index", index, &error_abort);
 215     }
 216     if (file)
 217         qemu_opt_set(opts, "file", file, &error_abort);
 218     return opts;
 219 }
 220
 221 DriveInfo *drive_get(BlockInterfaceType type, int bus, int unit)
 222 {
 223     BlockBackend *blk;
 224     DriveInfo *dinfo;
 225
 226     GLOBAL_STATE_CODE();
 227
 228     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 229         dinfo = blk_legacy_dinfo(blk);
 230         if (dinfo && dinfo->type == type
 231             && dinfo->bus == bus && dinfo->unit == unit) {
 232             return dinfo;
 233         }
 234     }
 235
 236     return NULL;
 237 }
 238
 239 /*
 240  * Check board claimed all -drive that are meant to be claimed.
 241  * Fatal error if any remain unclaimed.
 242  */
 243 void drive_check_orphaned(void)
 244 {
 245     BlockBackend *blk;
 246     DriveInfo *dinfo;
 247     Location loc;
 248     bool orphans = false;
 249
 250     GLOBAL_STATE_CODE();
 251
 252     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 253         dinfo = blk_legacy_dinfo(blk);
 254         /*
 255          * Ignore default drives, because we create certain default
 256          * drives unconditionally, then leave them unclaimed.  Not the
 257          * users fault.
 258          * Ignore IF_VIRTIO, because it gets desugared into -device,
 259          * so we can leave failing to -device.
 260          * Ignore IF_NONE, because leaving unclaimed IF_NONE remains
 261          * available for device_add is a feature.
 262          */
 263         if (dinfo->is_default || dinfo->type == IF_VIRTIO
 264             || dinfo->type == IF_NONE) {
 265             continue;
 266         }
 267         if (!blk_get_attached_dev(blk)) {
 268             loc_push_none(&loc);
 269             qemu_opts_loc_restore(dinfo->opts);
 270             error_report("machine type does not support"
 271                          " if=%s,bus=%d,unit=%d",
 272                          if_name[dinfo->type], dinfo->bus, dinfo->unit);
 273             loc_pop(&loc);
 274             orphans = true;
 275         }
 276     }
 277
 278     if (orphans) {
 279         exit(1);
 280     }
 281 }
 282
 283 DriveInfo *drive_get_by_index(BlockInterfaceType type, int index)
 284 {
 285     GLOBAL_STATE_CODE();
 286     return drive_get(type,
 287                      drive_index_to_bus_id(type, index),
 288                      drive_index_to_unit_id(type, index));
 289 }
 290
 291 int drive_get_max_bus(BlockInterfaceType type)
 292 {
 293     int max_bus;
 294     BlockBackend *blk;
 295     DriveInfo *dinfo;
 296
 297     GLOBAL_STATE_CODE();
 298
 299     max_bus = -1;
 300     for (blk = blk_next(NULL); blk; blk = blk_next(blk)) {
 301         dinfo = blk_legacy_dinfo(blk);
 302         if (dinfo && dinfo->type == type && dinfo->bus > max_bus) {
 303             max_bus = dinfo->bus;
 304         }
 305     }
 306     return max_bus;
 307 }
 308
 309 static void bdrv_format_print(void *opaque, const char *name)
 310 {
 311     qemu_printf(" %s", name);
 312 }
 313
 314 typedef struct {
 315     QEMUBH *bh;
 316     BlockDriverState *bs;
 317 } BDRVPutRefBH;
 318
 319 static int parse_block_error_action(const char *buf, bool is_read, Error **errp)
 320 {
 321     if (!strcmp(buf, "ignore")) {
 322         return BLOCKDEV_ON_ERROR_IGNORE;
 323     } else if (!is_read && !strcmp(buf, "enospc")) {
 324         return BLOCKDEV_ON_ERROR_ENOSPC;
 325     } else if (!strcmp(buf, "stop")) {
 326         return BLOCKDEV_ON_ERROR_STOP;
 327     } else if (!strcmp(buf, "report")) {
 328         return BLOCKDEV_ON_ERROR_REPORT;
 329     } else {
 330         error_setg(errp, "'%s' invalid %s error action",
 331                    buf, is_read ? "read" : "write");
 332         return -1;
 333     }
 334 }
 335
 336 static bool parse_stats_intervals(BlockAcctStats *stats, QList *intervals,
 337                                   Error **errp)
 338 {
 339     const QListEntry *entry;
 340     for (entry = qlist_first(intervals); entry; entry = qlist_next(entry)) {
 341         switch (qobject_type(entry->value)) {
 342
 343         case QTYPE_QSTRING: {
 344             unsigned long long length;
 345             const char *str = qstring_get_str(qobject_to(QString,
 346                                                          entry->value));
 347             if (parse_uint_full(str, &length, 10) == 0 &&
 348                 length > 0 && length <= UINT_MAX) {
 349                 block_acct_add_interval(stats, (unsigned) length);
 350             } else {
 351                 error_setg(errp, "Invalid interval length: %s", str);
 352                 return false;
 353             }
 354             break;
 355         }
 356
 357         case QTYPE_QNUM: {
 358             int64_t length = qnum_get_int(qobject_to(QNum, entry->value));
 359
 360             if (length > 0 && length <= UINT_MAX) {
 361                 block_acct_add_interval(stats, (unsigned) length);
 362             } else {
 363                 error_setg(errp, "Invalid interval length: %" PRId64, length);
 364                 return false;
 365             }
 366             break;
 367         }
 368
 369         default:
 370             error_setg(errp, "The specification of stats-intervals is invalid");
 371             return false;
 372         }
 373     }
 374     return true;
 375 }
 376
 377 typedef enum { MEDIA_DISK, MEDIA_CDROM } DriveMediaType;
 378
 379 /* All parameters but @opts are optional and may be set to NULL. */
 380 static void extract_common_blockdev_options(QemuOpts *opts, int *bdrv_flags,
 381     const char **throttling_group, ThrottleConfig *throttle_cfg,
 382     BlockdevDetectZeroesOptions *detect_zeroes, Error **errp)
 383 {
 384     Error *local_error = NULL;
 385     const char *aio;
 386
 387     if (bdrv_flags) {
 388         if (qemu_opt_get_bool(opts, "copy-on-read", false)) {
 389             *bdrv_flags |= BDRV_O_COPY_ON_READ;
 390         }
 391
 392         if ((aio = qemu_opt_get(opts, "aio")) != NULL) {
 393             if (bdrv_parse_aio(aio, bdrv_flags) < 0) {
 394                 error_setg(errp, "invalid aio option");
 395                 return;
 396             }
 397         }
 398     }
 399
 400     /* disk I/O throttling */
 401     if (throttling_group) {
 402         *throttling_group = qemu_opt_get(opts, "throttling.group");
 403     }
 404
 405     if (throttle_cfg) {
 406         throttle_config_init(throttle_cfg);
 407         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].avg =
 408             qemu_opt_get_number(opts, "throttling.bps-total", 0);
 409         throttle_cfg->buckets[THROTTLE_BPS_READ].avg  =
 410             qemu_opt_get_number(opts, "throttling.bps-read", 0);
 411         throttle_cfg->buckets[THROTTLE_BPS_WRITE].avg =
 412             qemu_opt_get_number(opts, "throttling.bps-write", 0);
 413         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].avg =
 414             qemu_opt_get_number(opts, "throttling.iops-total", 0);
 415         throttle_cfg->buckets[THROTTLE_OPS_READ].avg =
 416             qemu_opt_get_number(opts, "throttling.iops-read", 0);
 417         throttle_cfg->buckets[THROTTLE_OPS_WRITE].avg =
 418             qemu_opt_get_number(opts, "throttling.iops-write", 0);
 419
 420         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].max =
 421             qemu_opt_get_number(opts, "throttling.bps-total-max", 0);
 422         throttle_cfg->buckets[THROTTLE_BPS_READ].max  =
 423             qemu_opt_get_number(opts, "throttling.bps-read-max", 0);
 424         throttle_cfg->buckets[THROTTLE_BPS_WRITE].max =
 425             qemu_opt_get_number(opts, "throttling.bps-write-max", 0);
 426         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].max =
 427             qemu_opt_get_number(opts, "throttling.iops-total-max", 0);
 428         throttle_cfg->buckets[THROTTLE_OPS_READ].max =
 429             qemu_opt_get_number(opts, "throttling.iops-read-max", 0);
 430         throttle_cfg->buckets[THROTTLE_OPS_WRITE].max =
 431             qemu_opt_get_number(opts, "throttling.iops-write-max", 0);
 432
 433         throttle_cfg->buckets[THROTTLE_BPS_TOTAL].burst_length =
 434             qemu_opt_get_number(opts, "throttling.bps-total-max-length", 1);
 435         throttle_cfg->buckets[THROTTLE_BPS_READ].burst_length  =
 436             qemu_opt_get_number(opts, "throttling.bps-read-max-length", 1);
 437         throttle_cfg->buckets[THROTTLE_BPS_WRITE].burst_length =
 438             qemu_opt_get_number(opts, "throttling.bps-write-max-length", 1);
 439         throttle_cfg->buckets[THROTTLE_OPS_TOTAL].burst_length =
 440             qemu_opt_get_number(opts, "throttling.iops-total-max-length", 1);
 441         throttle_cfg->buckets[THROTTLE_OPS_READ].burst_length =
 442             qemu_opt_get_number(opts, "throttling.iops-read-max-length", 1);
 443         throttle_cfg->buckets[THROTTLE_OPS_WRITE].burst_length =
 444             qemu_opt_get_number(opts, "throttling.iops-write-max-length", 1);
 445
 446         throttle_cfg->op_size =
 447             qemu_opt_get_number(opts, "throttling.iops-size", 0);
 448
 449         if (!throttle_is_valid(throttle_cfg, errp)) {
 450             return;
 451         }
 452     }
 453
 454     if (detect_zeroes) {
 455         *detect_zeroes =
 456             qapi_enum_parse(&BlockdevDetectZeroesOptions_lookup,
 457                             qemu_opt_get(opts, "detect-zeroes"),
 458                             BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF,
 459                             &local_error);
 460         if (local_error) {
 461             error_propagate(errp, local_error);
 462             return;
 463         }
 464     }
 465 }
 466
 467 static OnOffAuto account_get_opt(QemuOpts *opts, const char *name)
 468 {
 469     if (!qemu_opt_find(opts, name)) {
 470         return ON_OFF_AUTO_AUTO;
 471     }
 472     if (qemu_opt_get_bool(opts, name, true)) {
 473         return ON_OFF_AUTO_ON;
 474     }
 475     return ON_OFF_AUTO_OFF;
 476 }
 477
 478 /* Takes the ownership of bs_opts */
 479 static BlockBackend *blockdev_init(const char *file, QDict *bs_opts,
 480                                    Error **errp)
 481 {
 482     const char *buf;
 483     int bdrv_flags = 0;
 484     int on_read_error, on_write_error;
 485     OnOffAuto account_invalid, account_failed;
 486     bool writethrough, read_only;
 487     BlockBackend *blk;
 488     BlockDriverState *bs;
 489     ThrottleConfig cfg;
 490     int snapshot = 0;
 491     Error *error = NULL;
 492     QemuOpts *opts;
 493     QDict *interval_dict = NULL;
 494     QList *interval_list = NULL;
 495     const char *id;
 496     BlockdevDetectZeroesOptions detect_zeroes =
 497         BLOCKDEV_DETECT_ZEROES_OPTIONS_OFF;
 498     const char *throttling_group = NULL;
 499
 500     /* Check common options by copying from bs_opts to opts, all other options
 501      * stay in bs_opts for processing by bdrv_open(). */
 502     id = qdict_get_try_str(bs_opts, "id");
 503     opts = qemu_opts_create(&qemu_common_drive_opts, id, 1, errp);
 504     if (!opts) {
 505         goto err_no_opts;
 506     }
 507
 508     if (!qemu_opts_absorb_qdict(opts, bs_opts, errp)) {
 509         goto early_err;
 510     }
 511
 512     if (id) {
 513         qdict_del(bs_opts, "id");
 514     }
 515
 516     /* extract parameters */
 517     snapshot = qemu_opt_get_bool(opts, "snapshot", 0);
 518
 519     account_invalid = account_get_opt(opts, "stats-account-invalid");
 520     account_failed = account_get_opt(opts, "stats-account-failed");
 521
 522     writethrough = !qemu_opt_get_bool(opts, BDRV_OPT_CACHE_WB, true);
 523
 524     id = qemu_opts_id(opts);
 525
 526     qdict_extract_subqdict(bs_opts, &interval_dict, "stats-intervals.");
 527     qdict_array_split(interval_dict, &interval_list);
 528
 529     if (qdict_size(interval_dict) != 0) {
 530         error_setg(errp, "Invalid option stats-intervals.%s",
 531                    qdict_first(interval_dict)->key);
 532         goto early_err;
 533     }
 534
 535     extract_common_blockdev_options(opts, &bdrv_flags, &throttling_group, &cfg,
 536                                     &detect_zeroes, &error);
 537     if (error) {
 538         error_propagate(errp, error);
 539         goto early_err;
 540     }
 541
 542     if ((buf = qemu_opt_get(opts, "format")) != NULL) {
 543         if (is_help_option(buf)) {
 544             qemu_printf("Supported formats:");
 545             bdrv_iterate_format(bdrv_format_print, NULL, false);
 546             qemu_printf("\nSupported formats (read-only):");
 547             bdrv_iterate_format(bdrv_format_print, NULL, true);
 548             qemu_printf("\n");
 549             goto early_err;
 550         }
 551
 552         if (qdict_haskey(bs_opts, "driver")) {
 553             error_setg(errp, "Cannot specify both 'driver' and 'format'");
 554             goto early_err;
 555         }
 556         qdict_put_str(bs_opts, "driver", buf);
 557     }
 558
 559     on_write_error = BLOCKDEV_ON_ERROR_ENOSPC;
 560     if ((buf = qemu_opt_get(opts, "werror")) != NULL) {
 561         on_write_error = parse_block_error_action(buf, 0, &error);
 562         if (error) {
 563             error_propagate(errp, error);
 564             goto early_err;
 565         }
 566     }
 567
 568     on_read_error = BLOCKDEV_ON_ERROR_REPORT;
 569     if ((buf = qemu_opt_get(opts, "rerror")) != NULL) {
 570         on_read_error = parse_block_error_action(buf, 1, &error);
 571         if (error) {
 572             error_propagate(errp, error);
 573             goto early_err;
 574         }
 575     }
 576
 577     if (snapshot) {
 578         bdrv_flags |= BDRV_O_SNAPSHOT;
 579     }
 580
 581     read_only = qemu_opt_get_bool(opts, BDRV_OPT_READ_ONLY, false);
 582
 583     /* init */
 584     if ((!file || !*file) && !qdict_size(bs_opts)) {
 585         BlockBackendRootState *blk_rs;
 586
 587         blk = blk_new(qemu_get_aio_context(), 0, BLK_PERM_ALL);
 588         blk_rs = blk_get_root_state(blk);
 589         blk_rs->open_flags    = bdrv_flags | (read_only ? 0 : BDRV_O_RDWR);
 590         blk_rs->detect_zeroes = detect_zeroes;
 591
 592         qobject_unref(bs_opts);
 593     } else {
 594         if (file && !*file) {
 595             file = NULL;
 596         }
 597
 598         /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
 599          * with other callers) rather than what we want as the real defaults.
 600          * Apply the defaults here instead. */
 601         qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
 602         qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
 603         qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY,
 604                               read_only ? "on" : "off");
 605         qdict_set_default_str(bs_opts, BDRV_OPT_AUTO_READ_ONLY, "on");
 606         assert((bdrv_flags & BDRV_O_CACHE_MASK) == 0);
 607
 608         if (runstate_check(RUN_STATE_INMIGRATE)) {
 609             bdrv_flags |= BDRV_O_INACTIVE;
 610         }
 611
 612         blk = blk_new_open(file, NULL, bs_opts, bdrv_flags, errp);
 613         if (!blk) {
 614             goto err_no_bs_opts;
 615         }
 616         bs = blk_bs(blk);
 617
 618         bs->detect_zeroes = detect_zeroes;
 619
 620         block_acct_setup(blk_get_stats(blk), account_invalid, account_failed);
 621
 622         if (!parse_stats_intervals(blk_get_stats(blk), interval_list, errp)) {
 623             blk_unref(blk);
 624             blk = NULL;
 625             goto err_no_bs_opts;
 626         }
 627     }
 628
 629     /* disk I/O throttling */
 630     if (throttle_enabled(&cfg)) {
 631         if (!throttling_group) {
 632             throttling_group = id;
 633         }
 634         blk_io_limits_enable(blk, throttling_group);
 635         blk_set_io_limits(blk, &cfg);
 636     }
 637
 638     blk_set_enable_write_cache(blk, !writethrough);
 639     blk_set_on_error(blk, on_read_error, on_write_error);
 640
 641     if (!monitor_add_blk(blk, id, errp)) {
 642         blk_unref(blk);
 643         blk = NULL;
 644         goto err_no_bs_opts;
 645     }
 646
 647 err_no_bs_opts:
 648     qemu_opts_del(opts);
 649     qobject_unref(interval_dict);
 650     qobject_unref(interval_list);
 651     return blk;
 652
 653 early_err:
 654     qemu_opts_del(opts);
 655     qobject_unref(interval_dict);
 656     qobject_unref(interval_list);
 657 err_no_opts:
 658     qobject_unref(bs_opts);
 659     return NULL;
 660 }
 661
 662 /* Takes the ownership of bs_opts */
 663 BlockDriverState *bds_tree_init(QDict *bs_opts, Error **errp)
 664 {
 665     int bdrv_flags = 0;
 666
 667     GLOBAL_STATE_CODE();
 668     /* bdrv_open() defaults to the values in bdrv_flags (for compatibility
 669      * with other callers) rather than what we want as the real defaults.
 670      * Apply the defaults here instead. */
 671     qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_DIRECT, "off");
 672     qdict_set_default_str(bs_opts, BDRV_OPT_CACHE_NO_FLUSH, "off");
 673     qdict_set_default_str(bs_opts, BDRV_OPT_READ_ONLY, "off");
 674
 675     if (runstate_check(RUN_STATE_INMIGRATE)) {
 676         bdrv_flags |= BDRV_O_INACTIVE;
 677     }
 678
 679     return bdrv_open(NULL, NULL, bs_opts, bdrv_flags, errp);
 680 }
 681
 682 void blockdev_close_all_bdrv_states(void)
 683 {
 684     BlockDriverState *bs, *next_bs;
 685
 686     GLOBAL_STATE_CODE();
 687     QTAILQ_FOREACH_SAFE(bs, &monitor_bdrv_states, monitor_list, next_bs) {
 688         AioContext *ctx = bdrv_get_aio_context(bs);
 689
 690         aio_context_acquire(ctx);
 691         bdrv_unref(bs);
 692         aio_context_release(ctx);
 693     }
 694 }
 695
 696 /* Iterates over the list of monitor-owned BlockDriverStates */
 697 BlockDriverState *bdrv_next_monitor_owned(BlockDriverState *bs)
 698 {
 699     GLOBAL_STATE_CODE();
 700     return bs ? QTAILQ_NEXT(bs, monitor_list)
 701               : QTAILQ_FIRST(&monitor_bdrv_states);
 702 }
 703
 704 static bool qemu_opt_rename(QemuOpts *opts, const char *from, const char *to,
 705                             Error **errp)
 706 {
 707     const char *value;
 708
 709     value = qemu_opt_get(opts, from);
 710     if (value) {
 711         if (qemu_opt_find(opts, to)) {
 712             error_setg(errp, "'%s' and its alias '%s' can't be used at the "
 713                        "same time", to, from);
 714             return false;
 715         }
 716     }
 717
 718     /* rename all items in opts */
 719     while ((value = qemu_opt_get(opts, from))) {
 720         qemu_opt_set(opts, to, value, &error_abort);
 721         qemu_opt_unset(opts, from);
 722     }
 723     return true;
 724 }
 725
 726 QemuOptsList qemu_legacy_drive_opts = {
 727     .name = "drive",
 728     .head = QTAILQ_HEAD_INITIALIZER(qemu_legacy_drive_opts.head),
 729     .desc = {
 730         {
 731             .name = "bus",
 732             .type = QEMU_OPT_NUMBER,
 733             .help = "bus number",
 734         },{
 735             .name = "unit",
 736             .type = QEMU_OPT_NUMBER,
 737             .help = "unit number (i.e. lun for scsi)",
 738         },{
 739             .name = "index",
 740             .type = QEMU_OPT_NUMBER,
 741             .help = "index number",
 742         },{
 743             .name = "media",
 744             .type = QEMU_OPT_STRING,
 745             .help = "media type (disk, cdrom)",
 746         },{
 747             .name = "if",
 748             .type = QEMU_OPT_STRING,
 749             .help = "interface (ide, scsi, sd, mtd, floppy, pflash, virtio)",
 750         },{
 751             .name = "file",
 752             .type = QEMU_OPT_STRING,
 753             .help = "file name",
 754         },
 755
 756         /* Options that are passed on, but have special semantics with -drive */
 757         {
 758             .name = BDRV_OPT_READ_ONLY,
 759             .type = QEMU_OPT_BOOL,
 760             .help = "open drive file as read-only",
 761         },{
 762             .name = "rerror",
 763             .type = QEMU_OPT_STRING,
 764             .help = "read error action",
 765         },{
 766             .name = "werror",
 767             .type = QEMU_OPT_STRING,
 768             .help = "write error action",
 769         },{
 770             .name = "copy-on-read",
 771             .type = QEMU_OPT_BOOL,
 772             .help = "copy read data from backing file into image file",
 773         },
 774
 775         { /* end of list */ }
 776     },
 777 };
 778
 779 DriveInfo *drive_new(QemuOpts *all_opts, BlockInterfaceType block_default_type,
 780                      Error **errp)
 781 {
 782     const char *value;
 783     BlockBackend *blk;
 784     DriveInfo *dinfo = NULL;
 785     QDict *bs_opts;
 786     QemuOpts *legacy_opts;
 787     DriveMediaType media = MEDIA_DISK;
 788     BlockInterfaceType type;
 789     int max_devs, bus_id, unit_id, index;
 790     const char *werror, *rerror;
 791     bool read_only = false;
 792     bool copy_on_read;
 793     const char *filename;
 794     int i;
 795
 796     GLOBAL_STATE_CODE();
 797
 798     /* Change legacy command line options into QMP ones */
 799     static const struct {
 800         const char *from;
 801         const char *to;
 802     } opt_renames[] = {
 803         { "iops",           "throttling.iops-total" },
 804         { "iops_rd",        "throttling.iops-read" },
 805         { "iops_wr",        "throttling.iops-write" },
 806
 807         { "bps",            "throttling.bps-total" },
 808         { "bps_rd",         "throttling.bps-read" },
 809         { "bps_wr",         "throttling.bps-write" },
 810
 811         { "iops_max",       "throttling.iops-total-max" },
 812         { "iops_rd_max",    "throttling.iops-read-max" },
 813         { "iops_wr_max",    "throttling.iops-write-max" },
 814
 815         { "bps_max",        "throttling.bps-total-max" },
 816         { "bps_rd_max",     "throttling.bps-read-max" },
 817         { "bps_wr_max",     "throttling.bps-write-max" },
 818
 819         { "iops_size",      "throttling.iops-size" },
 820
 821         { "group",          "throttling.group" },
 822
 823         { "readonly",       BDRV_OPT_READ_ONLY },
 824     };
 825
 826     for (i = 0; i < ARRAY_SIZE(opt_renames); i++) {
 827         if (!qemu_opt_rename(all_opts, opt_renames[i].from,
 828                              opt_renames[i].to, errp)) {
 829             return NULL;
 830         }
 831     }
 832
 833     value = qemu_opt_get(all_opts, "cache");
 834     if (value) {
 835         int flags = 0;
 836         bool writethrough;
 837
 838         if (bdrv_parse_cache_mode(value, &flags, &writethrough) != 0) {
 839             error_setg(errp, "invalid cache option");
 840             return NULL;
 841         }
 842
 843         /* Specific options take precedence */
 844         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_WB)) {
 845             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_WB,
 846                               !writethrough, &error_abort);
 847         }
 848         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_DIRECT)) {
 849             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_DIRECT,
 850                               !!(flags & BDRV_O_NOCACHE), &error_abort);
 851         }
 852         if (!qemu_opt_get(all_opts, BDRV_OPT_CACHE_NO_FLUSH)) {
 853             qemu_opt_set_bool(all_opts, BDRV_OPT_CACHE_NO_FLUSH,
 854                               !!(flags & BDRV_O_NO_FLUSH), &error_abort);
 855         }
 856         qemu_opt_unset(all_opts, "cache");
 857     }
 858
 859     /* Get a QDict for processing the options */
 860     bs_opts = qdict_new();
 861     qemu_opts_to_qdict(all_opts, bs_opts);
 862
 863     legacy_opts = qemu_opts_create(&qemu_legacy_drive_opts, NULL, 0,
 864                                    &error_abort);
 865     if (!qemu_opts_absorb_qdict(legacy_opts, bs_opts, errp)) {
 866         goto fail;
 867     }
 868
 869     /* Media type */
 870     value = qemu_opt_get(legacy_opts, "media");
 871     if (value) {
 872         if (!strcmp(value, "disk")) {
 873             media = MEDIA_DISK;
 874         } else if (!strcmp(value, "cdrom")) {
 875             media = MEDIA_CDROM;
 876             read_only = true;
 877         } else {
 878             error_setg(errp, "'%s' invalid media", value);
 879             goto fail;
 880         }
 881     }
 882
 883     /* copy-on-read is disabled with a warning for read-only devices */
 884     read_only |= qemu_opt_get_bool(legacy_opts, BDRV_OPT_READ_ONLY, false);
 885     copy_on_read = qemu_opt_get_bool(legacy_opts, "copy-on-read", false);
 886
 887     if (read_only && copy_on_read) {
 888         warn_report("disabling copy-on-read on read-only drive");
 889         copy_on_read = false;
 890     }
 891
 892     qdict_put_str(bs_opts, BDRV_OPT_READ_ONLY, read_only ? "on" : "off");
 893     qdict_put_str(bs_opts, "copy-on-read", copy_on_read ? "on" : "off");
 894
 895     /* Controller type */
 896     value = qemu_opt_get(legacy_opts, "if");
 897     if (value) {
 898         for (type = 0;
 899              type < IF_COUNT && strcmp(value, if_name[type]);
 900              type++) {
 901         }
 902         if (type == IF_COUNT) {
 903             error_setg(errp, "unsupported bus type '%s'", value);
 904             goto fail;
 905         }
 906     } else {
 907         type = block_default_type;
 908     }
 909
 910     /* Device address specified by bus/unit or index.
 911      * If none was specified, try to find the first free one. */
 912     bus_id  = qemu_opt_get_number(legacy_opts, "bus", 0);
 913     unit_id = qemu_opt_get_number(legacy_opts, "unit", -1);
 914     index   = qemu_opt_get_number(legacy_opts, "index", -1);
 915
 916     max_devs = if_max_devs[type];
 917
 918     if (index != -1) {
 919         if (bus_id != 0 || unit_id != -1) {
 920             error_setg(errp, "index cannot be used with bus and unit");
 921             goto fail;
 922         }
 923         bus_id = drive_index_to_bus_id(type, index);
 924         unit_id = drive_index_to_unit_id(type, index);
 925     }
 926
 927     if (unit_id == -1) {
 928        unit_id = 0;
 929        while (drive_get(type, bus_id, unit_id) != NULL) {
 930            unit_id++;
 931            if (max_devs && unit_id >= max_devs) {
 932                unit_id -= max_devs;
 933                bus_id++;
 934            }
 935        }
 936     }
 937
 938     if (max_devs && unit_id >= max_devs) {
 939         error_setg(errp, "unit %d too big (max is %d)", unit_id, max_devs - 1);
 940         goto fail;
 941     }
 942
 943     if (drive_get(type, bus_id, unit_id) != NULL) {
 944         error_setg(errp, "drive with bus=%d, unit=%d (index=%d) exists",
 945                    bus_id, unit_id, index);
 946         goto fail;
 947     }
 948
 949     /* no id supplied -> create one */
 950     if (qemu_opts_id(all_opts) == NULL) {
 951         char *new_id;
 952         const char *mediastr = "";
 953         if (type == IF_IDE || type == IF_SCSI) {
 954             mediastr = (media == MEDIA_CDROM) ? "-cd" : "-hd";
 955         }
 956         if (max_devs) {
 957             new_id = g_strdup_printf("%s%i%s%i", if_name[type], bus_id,
 958                                      mediastr, unit_id);
 959         } else {
 960             new_id = g_strdup_printf("%s%s%i", if_name[type],
 961                                      mediastr, unit_id);
 962         }
 963         qdict_put_str(bs_opts, "id", new_id);
 964         g_free(new_id);
 965     }
 966
 967     /* Add virtio block device */
 968     if (type == IF_VIRTIO) {
 969         QemuOpts *devopts;
 970         devopts = qemu_opts_create(qemu_find_opts("device"), NULL, 0,
 971                                    &error_abort);
 972         qemu_opt_set(devopts, "driver", "virtio-blk", &error_abort);
 973         qemu_opt_set(devopts, "drive", qdict_get_str(bs_opts, "id"),
 974                      &error_abort);
 975     }
 976
 977     filename = qemu_opt_get(legacy_opts, "file");
 978
 979     /* Check werror/rerror compatibility with if=... */
 980     werror = qemu_opt_get(legacy_opts, "werror");
 981     if (werror != NULL) {
 982         if (type != IF_IDE && type != IF_SCSI && type != IF_VIRTIO &&
 983             type != IF_NONE) {
 984             error_setg(errp, "werror is not supported by this bus type");
 985             goto fail;
 986         }
 987         qdict_put_str(bs_opts, "werror", werror);
 988     }
 989
 990     rerror = qemu_opt_get(legacy_opts, "rerror");
 991     if (rerror != NULL) {
 992         if (type != IF_IDE && type != IF_VIRTIO && type != IF_SCSI &&
 993             type != IF_NONE) {
 994             error_setg(errp, "rerror is not supported by this bus type");
 995             goto fail;
 996         }
 997         qdict_put_str(bs_opts, "rerror", rerror);
 998     }
 999
1000     /* Actual block device init: Functionality shared with blockdev-add */
1001     blk = blockdev_init(filename, bs_opts, errp);
1002     bs_opts = NULL;
1003     if (!blk) {
1004         goto fail;
1005     }
1006
1007     /* Create legacy DriveInfo */
1008     dinfo = g_malloc0(sizeof(*dinfo));
1009     dinfo->opts = all_opts;
1010
1011     dinfo->type = type;
1012     dinfo->bus = bus_id;
1013     dinfo->unit = unit_id;
1014
1015     blk_set_legacy_dinfo(blk, dinfo);
1016
1017     switch(type) {
1018     case IF_IDE:
1019     case IF_SCSI:
1020     case IF_XEN:
1021     case IF_NONE:
1022         dinfo->media_cd = media == MEDIA_CDROM;
1023         break;
1024     default:
1025         break;
1026     }
1027
1028 fail:
1029     qemu_opts_del(legacy_opts);
1030     qobject_unref(bs_opts);
1031     return dinfo;
1032 }
1033
1034 static BlockDriverState *qmp_get_root_bs(const char *name, Error **errp)
1035 {
1036     BlockDriverState *bs;
1037     AioContext *aio_context;
1038
1039     bs = bdrv_lookup_bs(name, name, errp);
1040     if (bs == NULL) {
1041         return NULL;
1042     }
1043
1044     if (!bdrv_is_root_node(bs)) {
1045         error_setg(errp, "Need a root block node");
1046         return NULL;
1047     }
1048
1049     aio_context = bdrv_get_aio_context(bs);
1050     aio_context_acquire(aio_context);
1051
1052     if (!bdrv_is_inserted(bs)) {
1053         error_setg(errp, "Device has no medium");
1054         bs = NULL;
1055     }
1056
1057     aio_context_release(aio_context);
1058
1059     return bs;
1060 }
1061
1062 static void blockdev_do_action(TransactionAction *action, Error **errp)
1063 {
1064     TransactionActionList list;
1065
1066     list.value = action;
1067     list.next = NULL;
1068     qmp_transaction(&list, NULL, errp);
1069 }
1070
1071 void qmp_blockdev_snapshot_sync(const char *device, const char *node_name,
1072                                 const char *snapshot_file,
1073                                 const char *snapshot_node_name,
1074                                 const char *format,
1075                                 bool has_mode, NewImageMode mode, Error **errp)
1076 {
1077     BlockdevSnapshotSync snapshot = {
1078         .device = (char *) device,
1079         .node_name = (char *) node_name,
1080         .snapshot_file = (char *) snapshot_file,
1081         .snapshot_node_name = (char *) snapshot_node_name,
1082         .format = (char *) format,
1083         .has_mode = has_mode,
1084         .mode = mode,
1085     };
1086     TransactionAction action = {
1087         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC,
1088         .u.blockdev_snapshot_sync.data = &snapshot,
1089     };
1090     blockdev_do_action(&action, errp);
1091 }
1092
1093 void qmp_blockdev_snapshot(const char *node, const char *overlay,
1094                            Error **errp)
1095 {
1096     BlockdevSnapshot snapshot_data = {
1097         .node = (char *) node,
1098         .overlay = (char *) overlay
1099     };
1100     TransactionAction action = {
1101         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT,
1102         .u.blockdev_snapshot.data = &snapshot_data,
1103     };
1104     blockdev_do_action(&action, errp);
1105 }
1106
1107 void qmp_blockdev_snapshot_internal_sync(const char *device,
1108                                          const char *name,
1109                                          Error **errp)
1110 {
1111     BlockdevSnapshotInternal snapshot = {
1112         .device = (char *) device,
1113         .name = (char *) name
1114     };
1115     TransactionAction action = {
1116         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC,
1117         .u.blockdev_snapshot_internal_sync.data = &snapshot,
1118     };
1119     blockdev_do_action(&action, errp);
1120 }
1121
1122 SnapshotInfo *qmp_blockdev_snapshot_delete_internal_sync(const char *device,
1123                                                          const char *id,
1124                                                          const char *name,
1125                                                          Error **errp)
1126 {
1127     BlockDriverState *bs;
1128     AioContext *aio_context;
1129     QEMUSnapshotInfo sn;
1130     Error *local_err = NULL;
1131     SnapshotInfo *info = NULL;
1132     int ret;
1133
1134     bs = qmp_get_root_bs(device, errp);
1135     if (!bs) {
1136         return NULL;
1137     }
1138     aio_context = bdrv_get_aio_context(bs);
1139     aio_context_acquire(aio_context);
1140
1141     if (!id && !name) {
1142         error_setg(errp, "Name or id must be provided");
1143         goto out_aio_context;
1144     }
1145
1146     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT_DELETE, errp)) {
1147         goto out_aio_context;
1148     }
1149
1150     ret = bdrv_snapshot_find_by_id_and_name(bs, id, name, &sn, &local_err);
1151     if (local_err) {
1152         error_propagate(errp, local_err);
1153         goto out_aio_context;
1154     }
1155     if (!ret) {
1156         error_setg(errp,
1157                    "Snapshot with id '%s' and name '%s' does not exist on "
1158                    "device '%s'",
1159                    STR_OR_NULL(id), STR_OR_NULL(name), device);
1160         goto out_aio_context;
1161     }
1162
1163     bdrv_snapshot_delete(bs, id, name, &local_err);
1164     if (local_err) {
1165         error_propagate(errp, local_err);
1166         goto out_aio_context;
1167     }
1168
1169     aio_context_release(aio_context);
1170
1171     info = g_new0(SnapshotInfo, 1);
1172     info->id = g_strdup(sn.id_str);
1173     info->name = g_strdup(sn.name);
1174     info->date_nsec = sn.date_nsec;
1175     info->date_sec = sn.date_sec;
1176     info->vm_state_size = sn.vm_state_size;
1177     info->vm_clock_nsec = sn.vm_clock_nsec % 1000000000;
1178     info->vm_clock_sec = sn.vm_clock_nsec / 1000000000;
1179     if (sn.icount != -1ULL) {
1180         info->icount = sn.icount;
1181         info->has_icount = true;
1182     }
1183
1184     return info;
1185
1186 out_aio_context:
1187     aio_context_release(aio_context);
1188     return NULL;
1189 }
1190
1191 /* New and old BlockDriverState structs for atomic group operations */
1192
1193 typedef struct BlkActionState BlkActionState;
1194
1195 /**
1196  * BlkActionOps:
1197  * Table of operations that define an Action.
1198  *
1199  * @instance_size: Size of state struct, in bytes.
1200  * @prepare: Prepare the work, must NOT be NULL.
1201  * @commit: Commit the changes, can be NULL.
1202  * @abort: Abort the changes on fail, can be NULL.
1203  * @clean: Clean up resources after all transaction actions have called
1204  *         commit() or abort(). Can be NULL.
1205  *
1206  * Only prepare() may fail. In a single transaction, only one of commit() or
1207  * abort() will be called. clean() will always be called if it is present.
1208  *
1209  * Always run under BQL.
1210  */
1211 typedef struct BlkActionOps {
1212     size_t instance_size;
1213     void (*action)(BlkActionState *common, Transaction *tran, Error **errp);
1214 } BlkActionOps;
1215
1216 /**
1217  * BlkActionState:
1218  * Describes one Action's state within a Transaction.
1219  *
1220  * @action: QAPI-defined enum identifying which Action to perform.
1221  * @ops: Table of ActionOps this Action can perform.
1222  * @block_job_txn: Transaction which this action belongs to.
1223  * @entry: List membership for all Actions in this Transaction.
1224  *
1225  * This structure must be arranged as first member in a subclassed type,
1226  * assuming that the compiler will also arrange it to the same offsets as the
1227  * base class.
1228  */
1229 struct BlkActionState {
1230     TransactionAction *action;
1231     const BlkActionOps *ops;
1232     JobTxn *block_job_txn;
1233     QTAILQ_ENTRY(BlkActionState) entry;
1234 };
1235
1236 /* internal snapshot private data */
1237 typedef struct InternalSnapshotState {
1238     BlkActionState common;
1239     BlockDriverState *bs;
1240     QEMUSnapshotInfo sn;
1241     bool created;
1242 } InternalSnapshotState;
1243
1244 static void internal_snapshot_abort(void *opaque);
1245 static void internal_snapshot_clean(void *opaque);
1246 TransactionActionDrv internal_snapshot_drv = {
1247     .abort = internal_snapshot_abort,
1248     .clean = internal_snapshot_clean,
1249 };
1250
1251 static void internal_snapshot_action(BlkActionState *common,
1252                                      Transaction *tran, Error **errp)
1253 {
1254     Error *local_err = NULL;
1255     const char *device;
1256     const char *name;
1257     BlockDriverState *bs;
1258     QEMUSnapshotInfo old_sn, *sn;
1259     bool ret;
1260     int64_t rt;
1261     BlockdevSnapshotInternal *internal;
1262     InternalSnapshotState *state;
1263     AioContext *aio_context;
1264     int ret1;
1265
1266     g_assert(common->action->type ==
1267              TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC);
1268     internal = common->action->u.blockdev_snapshot_internal_sync.data;
1269     state = DO_UPCAST(InternalSnapshotState, common, common);
1270
1271     tran_add(tran, &internal_snapshot_drv, state);
1272
1273     device = internal->device;
1274     name = internal->name;
1275
1276     bs = qmp_get_root_bs(device, errp);
1277     if (!bs) {
1278         return;
1279     }
1280
1281     aio_context = bdrv_get_aio_context(bs);
1282     aio_context_acquire(aio_context);
1283
1284     state->bs = bs;
1285
1286     /* Paired with .clean() */
1287     bdrv_drained_begin(bs);
1288
1289     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_INTERNAL_SNAPSHOT, errp)) {
1290         goto out;
1291     }
1292
1293     if (bdrv_is_read_only(bs)) {
1294         error_setg(errp, "Device '%s' is read only", device);
1295         goto out;
1296     }
1297
1298     if (!bdrv_can_snapshot(bs)) {
1299         error_setg(errp, "Block format '%s' used by device '%s' "
1300                    "does not support internal snapshots",
1301                    bs->drv->format_name, device);
1302         goto out;
1303     }
1304
1305     if (!strlen(name)) {
1306         error_setg(errp, "Name is empty");
1307         goto out;
1308     }
1309
1310     /* check whether a snapshot with name exist */
1311     ret = bdrv_snapshot_find_by_id_and_name(bs, NULL, name, &old_sn,
1312                                             &local_err);
1313     if (local_err) {
1314         error_propagate(errp, local_err);
1315         goto out;
1316     } else if (ret) {
1317         error_setg(errp,
1318                    "Snapshot with name '%s' already exists on device '%s'",
1319                    name, device);
1320         goto out;
1321     }
1322
1323     /* 3. take the snapshot */
1324     sn = &state->sn;
1325     pstrcpy(sn->name, sizeof(sn->name), name);
1326     rt = g_get_real_time();
1327     sn->date_sec = rt / G_USEC_PER_SEC;
1328     sn->date_nsec = (rt % G_USEC_PER_SEC) * 1000;
1329     sn->vm_clock_nsec = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL);
1330     if (replay_mode != REPLAY_MODE_NONE) {
1331         sn->icount = replay_get_current_icount();
1332     } else {
1333         sn->icount = -1ULL;
1334     }
1335
1336     ret1 = bdrv_snapshot_create(bs, sn);
1337     if (ret1 < 0) {
1338         error_setg_errno(errp, -ret1,
1339                          "Failed to create snapshot '%s' on device '%s'",
1340                          name, device);
1341         goto out;
1342     }
1343
1344     /* 4. succeed, mark a snapshot is created */
1345     state->created = true;
1346
1347 out:
1348     aio_context_release(aio_context);
1349 }
1350
1351 static void internal_snapshot_abort(void *opaque)
1352 {
1353     InternalSnapshotState *state = opaque;
1354     BlockDriverState *bs = state->bs;
1355     QEMUSnapshotInfo *sn = &state->sn;
1356     AioContext *aio_context;
1357     Error *local_error = NULL;
1358
1359     if (!state->created) {
1360         return;
1361     }
1362
1363     aio_context = bdrv_get_aio_context(state->bs);
1364     aio_context_acquire(aio_context);
1365
1366     if (bdrv_snapshot_delete(bs, sn->id_str, sn->name, &local_error) < 0) {
1367         error_reportf_err(local_error,
1368                           "Failed to delete snapshot with id '%s' and "
1369                           "name '%s' on device '%s' in abort: ",
1370                           sn->id_str, sn->name,
1371                           bdrv_get_device_name(bs));
1372     }
1373
1374     aio_context_release(aio_context);
1375 }
1376
1377 static void internal_snapshot_clean(void *opaque)
1378 {
1379     g_autofree InternalSnapshotState *state = opaque;
1380     AioContext *aio_context;
1381
1382     if (!state->bs) {
1383         return;
1384     }
1385
1386     aio_context = bdrv_get_aio_context(state->bs);
1387     aio_context_acquire(aio_context);
1388
1389     bdrv_drained_end(state->bs);
1390
1391     aio_context_release(aio_context);
1392 }
1393
1394 /* external snapshot private data */
1395 typedef struct ExternalSnapshotState {
1396     BlkActionState common;
1397     BlockDriverState *old_bs;
1398     BlockDriverState *new_bs;
1399     bool overlay_appended;
1400 } ExternalSnapshotState;
1401
1402 static void external_snapshot_commit(void *opaque);
1403 static void external_snapshot_abort(void *opaque);
1404 static void external_snapshot_clean(void *opaque);
1405 TransactionActionDrv external_snapshot_drv = {
1406     .commit = external_snapshot_commit,
1407     .abort = external_snapshot_abort,
1408     .clean = external_snapshot_clean,
1409 };
1410
1411 static void external_snapshot_action(BlkActionState *common, Transaction *tran,
1412                                      Error **errp)
1413 {
1414     int ret;
1415     int flags = 0;
1416     QDict *options = NULL;
1417     Error *local_err = NULL;
1418     /* Device and node name of the image to generate the snapshot from */
1419     const char *device;
1420     const char *node_name;
1421     /* Reference to the new image (for 'blockdev-snapshot') */
1422     const char *snapshot_ref;
1423     /* File name of the new image (for 'blockdev-snapshot-sync') */
1424     const char *new_image_file;
1425     ExternalSnapshotState *state =
1426                              DO_UPCAST(ExternalSnapshotState, common, common);
1427     TransactionAction *action = common->action;
1428     AioContext *aio_context;
1429     uint64_t perm, shared;
1430
1431     tran_add(tran, &external_snapshot_drv, state);
1432
1433     /* 'blockdev-snapshot' and 'blockdev-snapshot-sync' have similar
1434      * purpose but a different set of parameters */
1435     switch (action->type) {
1436     case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT:
1437         {
1438             BlockdevSnapshot *s = action->u.blockdev_snapshot.data;
1439             device = s->node;
1440             node_name = s->node;
1441             new_image_file = NULL;
1442             snapshot_ref = s->overlay;
1443         }
1444         break;
1445     case TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC:
1446         {
1447             BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1448             device = s->device;
1449             node_name = s->node_name;
1450             new_image_file = s->snapshot_file;
1451             snapshot_ref = NULL;
1452         }
1453         break;
1454     default:
1455         g_assert_not_reached();
1456     }
1457
1458     /* start processing */
1459
1460     state->old_bs = bdrv_lookup_bs(device, node_name, errp);
1461     if (!state->old_bs) {
1462         return;
1463     }
1464
1465     aio_context = bdrv_get_aio_context(state->old_bs);
1466     aio_context_acquire(aio_context);
1467
1468     /* Paired with .clean() */
1469     bdrv_drained_begin(state->old_bs);
1470
1471     if (!bdrv_is_inserted(state->old_bs)) {
1472         error_setg(errp, QERR_DEVICE_HAS_NO_MEDIUM, device);
1473         goto out;
1474     }
1475
1476     if (bdrv_op_is_blocked(state->old_bs,
1477                            BLOCK_OP_TYPE_EXTERNAL_SNAPSHOT, errp)) {
1478         goto out;
1479     }
1480
1481     if (!bdrv_is_read_only(state->old_bs)) {
1482         if (bdrv_flush(state->old_bs)) {
1483             error_setg(errp, QERR_IO_ERROR);
1484             goto out;
1485         }
1486     }
1487
1488     if (action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC) {
1489         BlockdevSnapshotSync *s = action->u.blockdev_snapshot_sync.data;
1490         const char *format = s->format ?: "qcow2";
1491         enum NewImageMode mode;
1492         const char *snapshot_node_name = s->snapshot_node_name;
1493
1494         if (node_name && !snapshot_node_name) {
1495             error_setg(errp, "New overlay node-name missing");
1496             goto out;
1497         }
1498
1499         if (snapshot_node_name &&
1500             bdrv_lookup_bs(snapshot_node_name, snapshot_node_name, NULL)) {
1501             error_setg(errp, "New overlay node-name already in use");
1502             goto out;
1503         }
1504
1505         flags = state->old_bs->open_flags;
1506         flags &= ~(BDRV_O_SNAPSHOT | BDRV_O_COPY_ON_READ);
1507         flags |= BDRV_O_NO_BACKING;
1508
1509         /* create new image w/backing file */
1510         mode = s->has_mode ? s->mode : NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1511         if (mode != NEW_IMAGE_MODE_EXISTING) {
1512             int64_t size = bdrv_getlength(state->old_bs);
1513             if (size < 0) {
1514                 error_setg_errno(errp, -size, "bdrv_getlength failed");
1515                 goto out;
1516             }
1517             bdrv_refresh_filename(state->old_bs);
1518
1519             aio_context_release(aio_context);
1520             bdrv_img_create(new_image_file, format,
1521                             state->old_bs->filename,
1522                             state->old_bs->drv->format_name,
1523                             NULL, size, flags, false, &local_err);
1524             aio_context_acquire(aio_context);
1525
1526             if (local_err) {
1527                 error_propagate(errp, local_err);
1528                 goto out;
1529             }
1530         }
1531
1532         options = qdict_new();
1533         if (snapshot_node_name) {
1534             qdict_put_str(options, "node-name", snapshot_node_name);
1535         }
1536         qdict_put_str(options, "driver", format);
1537     }
1538
1539     state->new_bs = bdrv_open(new_image_file, snapshot_ref, options, flags,
1540                               errp);
1541     /* We will manually add the backing_hd field to the bs later */
1542     if (!state->new_bs) {
1543         goto out;
1544     }
1545
1546     /*
1547      * Allow attaching a backing file to an overlay that's already in use only
1548      * if the parents don't assume that they are already seeing a valid image.
1549      * (Specifically, allow it as a mirror target, which is write-only access.)
1550      */
1551     bdrv_get_cumulative_perm(state->new_bs, &perm, &shared);
1552     if (perm & BLK_PERM_CONSISTENT_READ) {
1553         error_setg(errp, "The overlay is already in use");
1554         goto out;
1555     }
1556
1557     if (state->new_bs->drv->is_filter) {
1558         error_setg(errp, "Filters cannot be used as overlays");
1559         goto out;
1560     }
1561
1562     if (bdrv_cow_child(state->new_bs)) {
1563         error_setg(errp, "The overlay already has a backing image");
1564         goto out;
1565     }
1566
1567     if (!state->new_bs->drv->supports_backing) {
1568         error_setg(errp, "The overlay does not support backing images");
1569         goto out;
1570     }
1571
1572     ret = bdrv_append(state->new_bs, state->old_bs, errp);
1573     if (ret < 0) {
1574         goto out;
1575     }
1576     state->overlay_appended = true;
1577
1578 out:
1579     aio_context_release(aio_context);
1580 }
1581
1582 static void external_snapshot_commit(void *opaque)
1583 {
1584     ExternalSnapshotState *state = opaque;
1585     AioContext *aio_context;
1586
1587     aio_context = bdrv_get_aio_context(state->old_bs);
1588     aio_context_acquire(aio_context);
1589
1590     /* We don't need (or want) to use the transactional
1591      * bdrv_reopen_multiple() across all the entries at once, because we
1592      * don't want to abort all of them if one of them fails the reopen */
1593     if (!qatomic_read(&state->old_bs->copy_on_read)) {
1594         bdrv_reopen_set_read_only(state->old_bs, true, NULL);
1595     }
1596
1597     aio_context_release(aio_context);
1598 }
1599
1600 static void external_snapshot_abort(void *opaque)
1601 {
1602     ExternalSnapshotState *state = opaque;
1603     if (state->new_bs) {
1604         if (state->overlay_appended) {
1605             AioContext *aio_context;
1606             AioContext *tmp_context;
1607             int ret;
1608
1609             aio_context = bdrv_get_aio_context(state->old_bs);
1610             aio_context_acquire(aio_context);
1611
1612             bdrv_ref(state->old_bs);   /* we can't let bdrv_set_backind_hd()
1613                                           close state->old_bs; we need it */
1614             bdrv_set_backing_hd(state->new_bs, NULL, &error_abort);
1615
1616             /*
1617              * The call to bdrv_set_backing_hd() above returns state->old_bs to
1618              * the main AioContext. As we're still going to be using it, return
1619              * it to the AioContext it was before.
1620              */
1621             tmp_context = bdrv_get_aio_context(state->old_bs);
1622             if (aio_context != tmp_context) {
1623                 aio_context_release(aio_context);
1624                 aio_context_acquire(tmp_context);
1625
1626                 ret = bdrv_try_change_aio_context(state->old_bs,
1627                                                   aio_context, NULL, NULL);
1628                 assert(ret == 0);
1629
1630                 aio_context_release(tmp_context);
1631                 aio_context_acquire(aio_context);
1632             }
1633
1634             bdrv_replace_node(state->new_bs, state->old_bs, &error_abort);
1635             bdrv_unref(state->old_bs); /* bdrv_replace_node() ref'ed old_bs */
1636
1637             aio_context_release(aio_context);
1638         }
1639     }
1640 }
1641
1642 static void external_snapshot_clean(void *opaque)
1643 {
1644     g_autofree ExternalSnapshotState *state = opaque;
1645     AioContext *aio_context;
1646
1647     if (!state->old_bs) {
1648         return;
1649     }
1650
1651     aio_context = bdrv_get_aio_context(state->old_bs);
1652     aio_context_acquire(aio_context);
1653
1654     bdrv_drained_end(state->old_bs);
1655     bdrv_unref(state->new_bs);
1656
1657     aio_context_release(aio_context);
1658 }
1659
1660 typedef struct DriveBackupState {
1661     BlkActionState common;
1662     BlockDriverState *bs;
1663     BlockJob *job;
1664 } DriveBackupState;
1665
1666 static BlockJob *do_backup_common(BackupCommon *backup,
1667                                   BlockDriverState *bs,
1668                                   BlockDriverState *target_bs,
1669                                   AioContext *aio_context,
1670                                   JobTxn *txn, Error **errp);
1671
1672 static void drive_backup_commit(void *opaque);
1673 static void drive_backup_abort(void *opaque);
1674 static void drive_backup_clean(void *opaque);
1675 TransactionActionDrv drive_backup_drv = {
1676     .commit = drive_backup_commit,
1677     .abort = drive_backup_abort,
1678     .clean = drive_backup_clean,
1679 };
1680
1681 static void drive_backup_action(BlkActionState *common, Transaction *tran,
1682                                 Error **errp)
1683 {
1684     DriveBackupState *state = DO_UPCAST(DriveBackupState, common, common);
1685     DriveBackup *backup;
1686     BlockDriverState *bs;
1687     BlockDriverState *target_bs;
1688     BlockDriverState *source = NULL;
1689     AioContext *aio_context;
1690     AioContext *old_context;
1691     const char *format;
1692     QDict *options;
1693     Error *local_err = NULL;
1694     int flags;
1695     int64_t size;
1696     bool set_backing_hd = false;
1697     int ret;
1698
1699     tran_add(tran, &drive_backup_drv, state);
1700
1701     assert(common->action->type == TRANSACTION_ACTION_KIND_DRIVE_BACKUP);
1702     backup = common->action->u.drive_backup.data;
1703
1704     if (!backup->has_mode) {
1705         backup->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
1706     }
1707
1708     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1709     if (!bs) {
1710         return;
1711     }
1712
1713     if (!bs->drv) {
1714         error_setg(errp, "Device has no medium");
1715         return;
1716     }
1717
1718     aio_context = bdrv_get_aio_context(bs);
1719     aio_context_acquire(aio_context);
1720
1721     state->bs = bs;
1722     /* Paired with .clean() */
1723     bdrv_drained_begin(bs);
1724
1725     format = backup->format;
1726     if (!format && backup->mode != NEW_IMAGE_MODE_EXISTING) {
1727         format = bs->drv->format_name;
1728     }
1729
1730     /* Early check to avoid creating target */
1731     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_BACKUP_SOURCE, errp)) {
1732         goto out;
1733     }
1734
1735     flags = bs->open_flags | BDRV_O_RDWR;
1736
1737     /*
1738      * See if we have a backing HD we can use to create our new image
1739      * on top of.
1740      */
1741     if (backup->sync == MIRROR_SYNC_MODE_TOP) {
1742         /*
1743          * Backup will not replace the source by the target, so none
1744          * of the filters skipped here will be removed (in contrast to
1745          * mirror).  Therefore, we can skip all of them when looking
1746          * for the first COW relationship.
1747          */
1748         source = bdrv_cow_bs(bdrv_skip_filters(bs));
1749         if (!source) {
1750             backup->sync = MIRROR_SYNC_MODE_FULL;
1751         }
1752     }
1753     if (backup->sync == MIRROR_SYNC_MODE_NONE) {
1754         source = bs;
1755         flags |= BDRV_O_NO_BACKING;
1756         set_backing_hd = true;
1757     }
1758
1759     size = bdrv_getlength(bs);
1760     if (size < 0) {
1761         error_setg_errno(errp, -size, "bdrv_getlength failed");
1762         goto out;
1763     }
1764
1765     if (backup->mode != NEW_IMAGE_MODE_EXISTING) {
1766         assert(format);
1767         if (source) {
1768             /* Implicit filters should not appear in the filename */
1769             BlockDriverState *explicit_backing =
1770                 bdrv_skip_implicit_filters(source);
1771
1772             bdrv_refresh_filename(explicit_backing);
1773             bdrv_img_create(backup->target, format,
1774                             explicit_backing->filename,
1775                             explicit_backing->drv->format_name, NULL,
1776                             size, flags, false, &local_err);
1777         } else {
1778             bdrv_img_create(backup->target, format, NULL, NULL, NULL,
1779                             size, flags, false, &local_err);
1780         }
1781     }
1782
1783     if (local_err) {
1784         error_propagate(errp, local_err);
1785         goto out;
1786     }
1787
1788     options = qdict_new();
1789     qdict_put_str(options, "discard", "unmap");
1790     qdict_put_str(options, "detect-zeroes", "unmap");
1791     if (format) {
1792         qdict_put_str(options, "driver", format);
1793     }
1794
1795     target_bs = bdrv_open(backup->target, NULL, options, flags, errp);
1796     if (!target_bs) {
1797         goto out;
1798     }
1799
1800     /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
1801     old_context = bdrv_get_aio_context(target_bs);
1802     aio_context_release(aio_context);
1803     aio_context_acquire(old_context);
1804
1805     ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
1806     if (ret < 0) {
1807         bdrv_unref(target_bs);
1808         aio_context_release(old_context);
1809         return;
1810     }
1811
1812     aio_context_release(old_context);
1813     aio_context_acquire(aio_context);
1814
1815     if (set_backing_hd) {
1816         if (bdrv_set_backing_hd(target_bs, source, errp) < 0) {
1817             goto unref;
1818         }
1819     }
1820
1821     state->job = do_backup_common(qapi_DriveBackup_base(backup),
1822                                   bs, target_bs, aio_context,
1823                                   common->block_job_txn, errp);
1824
1825 unref:
1826     bdrv_unref(target_bs);
1827 out:
1828     aio_context_release(aio_context);
1829 }
1830
1831 static void drive_backup_commit(void *opaque)
1832 {
1833     DriveBackupState *state = opaque;
1834     AioContext *aio_context;
1835
1836     aio_context = bdrv_get_aio_context(state->bs);
1837     aio_context_acquire(aio_context);
1838
1839     assert(state->job);
1840     job_start(&state->job->job);
1841
1842     aio_context_release(aio_context);
1843 }
1844
1845 static void drive_backup_abort(void *opaque)
1846 {
1847     DriveBackupState *state = opaque;
1848
1849     if (state->job) {
1850         job_cancel_sync(&state->job->job, true);
1851     }
1852 }
1853
1854 static void drive_backup_clean(void *opaque)
1855 {
1856     g_autofree DriveBackupState *state = opaque;
1857     AioContext *aio_context;
1858
1859     if (!state->bs) {
1860         return;
1861     }
1862
1863     aio_context = bdrv_get_aio_context(state->bs);
1864     aio_context_acquire(aio_context);
1865
1866     bdrv_drained_end(state->bs);
1867
1868     aio_context_release(aio_context);
1869 }
1870
1871 typedef struct BlockdevBackupState {
1872     BlkActionState common;
1873     BlockDriverState *bs;
1874     BlockJob *job;
1875 } BlockdevBackupState;
1876
1877 static void blockdev_backup_commit(void *opaque);
1878 static void blockdev_backup_abort(void *opaque);
1879 static void blockdev_backup_clean(void *opaque);
1880 TransactionActionDrv blockdev_backup_drv = {
1881     .commit = blockdev_backup_commit,
1882     .abort = blockdev_backup_abort,
1883     .clean = blockdev_backup_clean,
1884 };
1885
1886 static void blockdev_backup_action(BlkActionState *common, Transaction *tran,
1887                                    Error **errp)
1888 {
1889     BlockdevBackupState *state = DO_UPCAST(BlockdevBackupState, common, common);
1890     BlockdevBackup *backup;
1891     BlockDriverState *bs;
1892     BlockDriverState *target_bs;
1893     AioContext *aio_context;
1894     AioContext *old_context;
1895     int ret;
1896
1897     tran_add(tran, &blockdev_backup_drv, state);
1898
1899     assert(common->action->type == TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP);
1900     backup = common->action->u.blockdev_backup.data;
1901
1902     bs = bdrv_lookup_bs(backup->device, backup->device, errp);
1903     if (!bs) {
1904         return;
1905     }
1906
1907     target_bs = bdrv_lookup_bs(backup->target, backup->target, errp);
1908     if (!target_bs) {
1909         return;
1910     }
1911
1912     /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
1913     aio_context = bdrv_get_aio_context(bs);
1914     old_context = bdrv_get_aio_context(target_bs);
1915     aio_context_acquire(old_context);
1916
1917     ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
1918     if (ret < 0) {
1919         aio_context_release(old_context);
1920         return;
1921     }
1922
1923     aio_context_release(old_context);
1924     aio_context_acquire(aio_context);
1925     state->bs = bs;
1926
1927     /* Paired with .clean() */
1928     bdrv_drained_begin(state->bs);
1929
1930     state->job = do_backup_common(qapi_BlockdevBackup_base(backup),
1931                                   bs, target_bs, aio_context,
1932                                   common->block_job_txn, errp);
1933
1934     aio_context_release(aio_context);
1935 }
1936
1937 static void blockdev_backup_commit(void *opaque)
1938 {
1939     BlockdevBackupState *state = opaque;
1940     AioContext *aio_context;
1941
1942     aio_context = bdrv_get_aio_context(state->bs);
1943     aio_context_acquire(aio_context);
1944
1945     assert(state->job);
1946     job_start(&state->job->job);
1947
1948     aio_context_release(aio_context);
1949 }
1950
1951 static void blockdev_backup_abort(void *opaque)
1952 {
1953     BlockdevBackupState *state = opaque;
1954
1955     if (state->job) {
1956         job_cancel_sync(&state->job->job, true);
1957     }
1958 }
1959
1960 static void blockdev_backup_clean(void *opaque)
1961 {
1962     g_autofree BlockdevBackupState *state = opaque;
1963     AioContext *aio_context;
1964
1965     if (!state->bs) {
1966         return;
1967     }
1968
1969     aio_context = bdrv_get_aio_context(state->bs);
1970     aio_context_acquire(aio_context);
1971
1972     bdrv_drained_end(state->bs);
1973
1974     aio_context_release(aio_context);
1975 }
1976
1977 typedef struct BlockDirtyBitmapState {
1978     BlkActionState common;
1979     BdrvDirtyBitmap *bitmap;
1980     BlockDriverState *bs;
1981     HBitmap *backup;
1982     bool was_enabled;
1983 } BlockDirtyBitmapState;
1984
1985 static void block_dirty_bitmap_add_abort(void *opaque);
1986 TransactionActionDrv block_dirty_bitmap_add_drv = {
1987     .abort = block_dirty_bitmap_add_abort,
1988     .clean = g_free,
1989 };
1990
1991 static void block_dirty_bitmap_add_action(BlkActionState *common,
1992                                           Transaction *tran, Error **errp)
1993 {
1994     Error *local_err = NULL;
1995     BlockDirtyBitmapAdd *action;
1996     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
1997                                              common, common);
1998
1999     tran_add(tran, &block_dirty_bitmap_add_drv, state);
2000
2001     action = common->action->u.block_dirty_bitmap_add.data;
2002     /* AIO context taken and released within qmp_block_dirty_bitmap_add */
2003     qmp_block_dirty_bitmap_add(action->node, action->name,
2004                                action->has_granularity, action->granularity,
2005                                action->has_persistent, action->persistent,
2006                                action->has_disabled, action->disabled,
2007                                &local_err);
2008
2009     if (!local_err) {
2010         state->bitmap = block_dirty_bitmap_lookup(action->node, action->name,
2011                                                   NULL, &error_abort);
2012     } else {
2013         error_propagate(errp, local_err);
2014     }
2015 }
2016
2017 static void block_dirty_bitmap_add_abort(void *opaque)
2018 {
2019     BlockDirtyBitmapState *state = opaque;
2020
2021     if (state->bitmap) {
2022         bdrv_release_dirty_bitmap(state->bitmap);
2023     }
2024 }
2025
2026 static void block_dirty_bitmap_restore(void *opaque);
2027 static void block_dirty_bitmap_free_backup(void *opaque);
2028 TransactionActionDrv block_dirty_bitmap_clear_drv = {
2029     .abort = block_dirty_bitmap_restore,
2030     .commit = block_dirty_bitmap_free_backup,
2031     .clean = g_free,
2032 };
2033
2034 static void block_dirty_bitmap_clear_action(BlkActionState *common,
2035                                             Transaction *tran, Error **errp)
2036 {
2037     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2038                                              common, common);
2039     BlockDirtyBitmap *action;
2040
2041     tran_add(tran, &block_dirty_bitmap_clear_drv, state);
2042
2043     action = common->action->u.block_dirty_bitmap_clear.data;
2044     state->bitmap = block_dirty_bitmap_lookup(action->node,
2045                                               action->name,
2046                                               &state->bs,
2047                                               errp);
2048     if (!state->bitmap) {
2049         return;
2050     }
2051
2052     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_DEFAULT, errp)) {
2053         return;
2054     }
2055
2056     bdrv_clear_dirty_bitmap(state->bitmap, &state->backup);
2057 }
2058
2059 static void block_dirty_bitmap_restore(void *opaque)
2060 {
2061     BlockDirtyBitmapState *state = opaque;
2062
2063     if (state->backup) {
2064         bdrv_restore_dirty_bitmap(state->bitmap, state->backup);
2065     }
2066 }
2067
2068 static void block_dirty_bitmap_free_backup(void *opaque)
2069 {
2070     BlockDirtyBitmapState *state = opaque;
2071
2072     hbitmap_free(state->backup);
2073 }
2074
2075 static void block_dirty_bitmap_enable_abort(void *opaque);
2076 TransactionActionDrv block_dirty_bitmap_enable_drv = {
2077     .abort = block_dirty_bitmap_enable_abort,
2078     .clean = g_free,
2079 };
2080
2081 static void block_dirty_bitmap_enable_action(BlkActionState *common,
2082                                              Transaction *tran, Error **errp)
2083 {
2084     BlockDirtyBitmap *action;
2085     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2086                                              common, common);
2087
2088     tran_add(tran, &block_dirty_bitmap_enable_drv, state);
2089
2090     action = common->action->u.block_dirty_bitmap_enable.data;
2091     state->bitmap = block_dirty_bitmap_lookup(action->node,
2092                                               action->name,
2093                                               NULL,
2094                                               errp);
2095     if (!state->bitmap) {
2096         return;
2097     }
2098
2099     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2100         return;
2101     }
2102
2103     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2104     bdrv_enable_dirty_bitmap(state->bitmap);
2105 }
2106
2107 static void block_dirty_bitmap_enable_abort(void *opaque)
2108 {
2109     BlockDirtyBitmapState *state = opaque;
2110
2111     if (!state->was_enabled) {
2112         bdrv_disable_dirty_bitmap(state->bitmap);
2113     }
2114 }
2115
2116 static void block_dirty_bitmap_disable_abort(void *opaque);
2117 TransactionActionDrv block_dirty_bitmap_disable_drv = {
2118     .abort = block_dirty_bitmap_disable_abort,
2119     .clean = g_free,
2120 };
2121
2122 static void block_dirty_bitmap_disable_action(BlkActionState *common,
2123                                               Transaction *tran, Error **errp)
2124 {
2125     BlockDirtyBitmap *action;
2126     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2127                                              common, common);
2128
2129     tran_add(tran, &block_dirty_bitmap_disable_drv, state);
2130
2131     action = common->action->u.block_dirty_bitmap_disable.data;
2132     state->bitmap = block_dirty_bitmap_lookup(action->node,
2133                                               action->name,
2134                                               NULL,
2135                                               errp);
2136     if (!state->bitmap) {
2137         return;
2138     }
2139
2140     if (bdrv_dirty_bitmap_check(state->bitmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2141         return;
2142     }
2143
2144     state->was_enabled = bdrv_dirty_bitmap_enabled(state->bitmap);
2145     bdrv_disable_dirty_bitmap(state->bitmap);
2146 }
2147
2148 static void block_dirty_bitmap_disable_abort(void *opaque)
2149 {
2150     BlockDirtyBitmapState *state = opaque;
2151
2152     if (state->was_enabled) {
2153         bdrv_enable_dirty_bitmap(state->bitmap);
2154     }
2155 }
2156
2157 TransactionActionDrv block_dirty_bitmap_merge_drv = {
2158     .commit = block_dirty_bitmap_free_backup,
2159     .abort = block_dirty_bitmap_restore,
2160     .clean = g_free,
2161 };
2162
2163 static void block_dirty_bitmap_merge_action(BlkActionState *common,
2164                                             Transaction *tran, Error **errp)
2165 {
2166     BlockDirtyBitmapMerge *action;
2167     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2168                                              common, common);
2169
2170     tran_add(tran, &block_dirty_bitmap_merge_drv, state);
2171
2172     action = common->action->u.block_dirty_bitmap_merge.data;
2173
2174     state->bitmap = block_dirty_bitmap_merge(action->node, action->target,
2175                                              action->bitmaps, &state->backup,
2176                                              errp);
2177 }
2178
2179 static void block_dirty_bitmap_remove_commit(void *opaque);
2180 static void block_dirty_bitmap_remove_abort(void *opaque);
2181 TransactionActionDrv block_dirty_bitmap_remove_drv = {
2182     .commit = block_dirty_bitmap_remove_commit,
2183     .abort = block_dirty_bitmap_remove_abort,
2184     .clean = g_free,
2185 };
2186
2187 static void block_dirty_bitmap_remove_action(BlkActionState *common,
2188                                              Transaction *tran, Error **errp)
2189 {
2190     BlockDirtyBitmap *action;
2191     BlockDirtyBitmapState *state = DO_UPCAST(BlockDirtyBitmapState,
2192                                              common, common);
2193
2194     tran_add(tran, &block_dirty_bitmap_remove_drv, state);
2195
2196     action = common->action->u.block_dirty_bitmap_remove.data;
2197
2198     state->bitmap = block_dirty_bitmap_remove(action->node, action->name,
2199                                               false, &state->bs, errp);
2200     if (state->bitmap) {
2201         bdrv_dirty_bitmap_skip_store(state->bitmap, true);
2202         bdrv_dirty_bitmap_set_busy(state->bitmap, true);
2203     }
2204 }
2205
2206 static void block_dirty_bitmap_remove_abort(void *opaque)
2207 {
2208     BlockDirtyBitmapState *state = opaque;
2209
2210     if (state->bitmap) {
2211         bdrv_dirty_bitmap_skip_store(state->bitmap, false);
2212         bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2213     }
2214 }
2215
2216 static void block_dirty_bitmap_remove_commit(void *opaque)
2217 {
2218     BlockDirtyBitmapState *state = opaque;
2219
2220     bdrv_dirty_bitmap_set_busy(state->bitmap, false);
2221     bdrv_release_dirty_bitmap(state->bitmap);
2222 }
2223
2224 static void abort_commit(void *opaque);
2225 TransactionActionDrv abort_drv = {
2226     .commit = abort_commit,
2227     .clean = g_free,
2228 };
2229
2230 static void abort_action(BlkActionState *common, Transaction *tran,
2231                          Error **errp)
2232 {
2233     tran_add(tran, &abort_drv, common);
2234     error_setg(errp, "Transaction aborted using Abort action");
2235 }
2236
2237 static void abort_commit(void *opaque)
2238 {
2239     g_assert_not_reached(); /* this action never succeeds */
2240 }
2241
2242 static const BlkActionOps actions_map[] = {
2243     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT] = {
2244         .instance_size = sizeof(ExternalSnapshotState),
2245         .action  = external_snapshot_action,
2246     },
2247     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_SYNC] = {
2248         .instance_size = sizeof(ExternalSnapshotState),
2249         .action  = external_snapshot_action,
2250     },
2251     [TRANSACTION_ACTION_KIND_DRIVE_BACKUP] = {
2252         .instance_size = sizeof(DriveBackupState),
2253         .action = drive_backup_action,
2254     },
2255     [TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP] = {
2256         .instance_size = sizeof(BlockdevBackupState),
2257         .action = blockdev_backup_action,
2258     },
2259     [TRANSACTION_ACTION_KIND_ABORT] = {
2260         .instance_size = sizeof(BlkActionState),
2261         .action = abort_action,
2262     },
2263     [TRANSACTION_ACTION_KIND_BLOCKDEV_SNAPSHOT_INTERNAL_SYNC] = {
2264         .instance_size = sizeof(InternalSnapshotState),
2265         .action  = internal_snapshot_action,
2266     },
2267     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ADD] = {
2268         .instance_size = sizeof(BlockDirtyBitmapState),
2269         .action = block_dirty_bitmap_add_action,
2270     },
2271     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_CLEAR] = {
2272         .instance_size = sizeof(BlockDirtyBitmapState),
2273         .action = block_dirty_bitmap_clear_action,
2274     },
2275     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_ENABLE] = {
2276         .instance_size = sizeof(BlockDirtyBitmapState),
2277         .action = block_dirty_bitmap_enable_action,
2278     },
2279     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_DISABLE] = {
2280         .instance_size = sizeof(BlockDirtyBitmapState),
2281         .action = block_dirty_bitmap_disable_action,
2282     },
2283     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_MERGE] = {
2284         .instance_size = sizeof(BlockDirtyBitmapState),
2285         .action = block_dirty_bitmap_merge_action,
2286     },
2287     [TRANSACTION_ACTION_KIND_BLOCK_DIRTY_BITMAP_REMOVE] = {
2288         .instance_size = sizeof(BlockDirtyBitmapState),
2289         .action = block_dirty_bitmap_remove_action,
2290     },
2291     /* Where are transactions for MIRROR, COMMIT and STREAM?
2292      * Although these blockjobs use transaction callbacks like the backup job,
2293      * these jobs do not necessarily adhere to transaction semantics.
2294      * These jobs may not fully undo all of their actions on abort, nor do they
2295      * necessarily work in transactions with more than one job in them.
2296      */
2297 };
2298
2299 /*
2300  * 'Atomic' group operations.  The operations are performed as a set, and if
2301  * any fail then we roll back all operations in the group.
2302  *
2303  * Always run under BQL.
2304  */
2305 void qmp_transaction(TransactionActionList *actions,
2306                      struct TransactionProperties *properties,
2307                      Error **errp)
2308 {
2309     TransactionActionList *act;
2310     JobTxn *block_job_txn = NULL;
2311     Error *local_err = NULL;
2312     Transaction *tran;
2313     ActionCompletionMode comp_mode =
2314         properties ? properties->completion_mode :
2315         ACTION_COMPLETION_MODE_INDIVIDUAL;
2316
2317     GLOBAL_STATE_CODE();
2318
2319     /* Does this transaction get canceled as a group on failure?
2320      * If not, we don't really need to make a JobTxn.
2321      */
2322     if (comp_mode != ACTION_COMPLETION_MODE_INDIVIDUAL) {
2323         for (act = actions; act; act = act->next) {
2324             TransactionActionKind type = act->value->type;
2325
2326             if (type != TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP &&
2327                 type != TRANSACTION_ACTION_KIND_DRIVE_BACKUP)
2328             {
2329                 error_setg(errp,
2330                            "Action '%s' does not support transaction property "
2331                            "completion-mode = %s",
2332                            TransactionActionKind_str(type),
2333                            ActionCompletionMode_str(comp_mode));
2334                 return;
2335             }
2336         }
2337
2338         block_job_txn = job_txn_new();
2339     }
2340
2341     /* drain all i/o before any operations */
2342     bdrv_drain_all();
2343
2344     tran = tran_new();
2345
2346     /* We don't do anything in this loop that commits us to the operations */
2347     for (act = actions; act; act = act->next) {
2348         TransactionAction *dev_info = act->value;
2349         const BlkActionOps *ops;
2350         BlkActionState *state;
2351
2352         assert(dev_info->type < ARRAY_SIZE(actions_map));
2353
2354         ops = &actions_map[dev_info->type];
2355         assert(ops->instance_size > 0);
2356
2357         state = g_malloc0(ops->instance_size);
2358         state->ops = ops;
2359         state->action = dev_info;
2360         state->block_job_txn = block_job_txn;
2361
2362         state->ops->action(state, tran, &local_err);
2363         if (local_err) {
2364             error_propagate(errp, local_err);
2365             goto delete_and_fail;
2366         }
2367     }
2368
2369     tran_commit(tran);
2370
2371     /* success */
2372     goto exit;
2373
2374 delete_and_fail:
2375     /* failure, and it is all-or-none; roll back all operations */
2376     tran_abort(tran);
2377 exit:
2378     job_txn_unref(block_job_txn);
2379 }
2380
2381 BlockDirtyBitmapSha256 *qmp_x_debug_block_dirty_bitmap_sha256(const char *node,
2382                                                               const char *name,
2383                                                               Error **errp)
2384 {
2385     BdrvDirtyBitmap *bitmap;
2386     BlockDriverState *bs;
2387     BlockDirtyBitmapSha256 *ret = NULL;
2388     char *sha256;
2389
2390     bitmap = block_dirty_bitmap_lookup(node, name, &bs, errp);
2391     if (!bitmap || !bs) {
2392         return NULL;
2393     }
2394
2395     sha256 = bdrv_dirty_bitmap_sha256(bitmap, errp);
2396     if (sha256 == NULL) {
2397         return NULL;
2398     }
2399
2400     ret = g_new(BlockDirtyBitmapSha256, 1);
2401     ret->sha256 = sha256;
2402
2403     return ret;
2404 }
2405
2406 void coroutine_fn qmp_block_resize(const char *device, const char *node_name,
2407                                    int64_t size, Error **errp)
2408 {
2409     Error *local_err = NULL;
2410     BlockBackend *blk;
2411     BlockDriverState *bs;
2412     AioContext *old_ctx;
2413
2414     bs = bdrv_lookup_bs(device, node_name, &local_err);
2415     if (local_err) {
2416         error_propagate(errp, local_err);
2417         return;
2418     }
2419
2420     if (size < 0) {
2421         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "size", "a >0 size");
2422         return;
2423     }
2424
2425     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_RESIZE, NULL)) {
2426         error_setg(errp, QERR_DEVICE_IN_USE, device);
2427         return;
2428     }
2429
2430     blk = blk_co_new_with_bs(bs, BLK_PERM_RESIZE, BLK_PERM_ALL, errp);
2431     if (!blk) {
2432         return;
2433     }
2434
2435     bdrv_co_lock(bs);
2436     bdrv_drained_begin(bs);
2437     bdrv_co_unlock(bs);
2438
2439     old_ctx = bdrv_co_enter(bs);
2440     blk_co_truncate(blk, size, false, PREALLOC_MODE_OFF, 0, errp);
2441     bdrv_co_leave(bs, old_ctx);
2442
2443     bdrv_co_lock(bs);
2444     bdrv_drained_end(bs);
2445     blk_co_unref(blk);
2446     bdrv_co_unlock(bs);
2447 }
2448
2449 void qmp_block_stream(const char *job_id, const char *device,
2450                       const char *base,
2451                       const char *base_node,
2452                       const char *backing_file,
2453                       const char *bottom,
2454                       bool has_speed, int64_t speed,
2455                       bool has_on_error, BlockdevOnError on_error,
2456                       const char *filter_node_name,
2457                       bool has_auto_finalize, bool auto_finalize,
2458                       bool has_auto_dismiss, bool auto_dismiss,
2459                       Error **errp)
2460 {
2461     BlockDriverState *bs, *iter, *iter_end;
2462     BlockDriverState *base_bs = NULL;
2463     BlockDriverState *bottom_bs = NULL;
2464     AioContext *aio_context;
2465     Error *local_err = NULL;
2466     int job_flags = JOB_DEFAULT;
2467
2468     if (base && base_node) {
2469         error_setg(errp, "'base' and 'base-node' cannot be specified "
2470                    "at the same time");
2471         return;
2472     }
2473
2474     if (base && bottom) {
2475         error_setg(errp, "'base' and 'bottom' cannot be specified "
2476                    "at the same time");
2477         return;
2478     }
2479
2480     if (bottom && base_node) {
2481         error_setg(errp, "'bottom' and 'base-node' cannot be specified "
2482                    "at the same time");
2483         return;
2484     }
2485
2486     if (!has_on_error) {
2487         on_error = BLOCKDEV_ON_ERROR_REPORT;
2488     }
2489
2490     bs = bdrv_lookup_bs(device, device, errp);
2491     if (!bs) {
2492         return;
2493     }
2494
2495     aio_context = bdrv_get_aio_context(bs);
2496     aio_context_acquire(aio_context);
2497
2498     if (base) {
2499         base_bs = bdrv_find_backing_image(bs, base);
2500         if (base_bs == NULL) {
2501             error_setg(errp, "Can't find '%s' in the backing chain", base);
2502             goto out;
2503         }
2504         assert(bdrv_get_aio_context(base_bs) == aio_context);
2505     }
2506
2507     if (base_node) {
2508         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2509         if (!base_bs) {
2510             goto out;
2511         }
2512         if (bs == base_bs || !bdrv_chain_contains(bs, base_bs)) {
2513             error_setg(errp, "Node '%s' is not a backing image of '%s'",
2514                        base_node, device);
2515             goto out;
2516         }
2517         assert(bdrv_get_aio_context(base_bs) == aio_context);
2518         bdrv_refresh_filename(base_bs);
2519     }
2520
2521     if (bottom) {
2522         bottom_bs = bdrv_lookup_bs(NULL, bottom, errp);
2523         if (!bottom_bs) {
2524             goto out;
2525         }
2526         if (!bottom_bs->drv) {
2527             error_setg(errp, "Node '%s' is not open", bottom);
2528             goto out;
2529         }
2530         if (bottom_bs->drv->is_filter) {
2531             error_setg(errp, "Node '%s' is a filter, use a non-filter node "
2532                        "as 'bottom'", bottom);
2533             goto out;
2534         }
2535         if (!bdrv_chain_contains(bs, bottom_bs)) {
2536             error_setg(errp, "Node '%s' is not in a chain starting from '%s'",
2537                        bottom, device);
2538             goto out;
2539         }
2540         assert(bdrv_get_aio_context(bottom_bs) == aio_context);
2541     }
2542
2543     /*
2544      * Check for op blockers in the whole chain between bs and base (or bottom)
2545      */
2546     iter_end = bottom ? bdrv_filter_or_cow_bs(bottom_bs) : base_bs;
2547     for (iter = bs; iter && iter != iter_end;
2548          iter = bdrv_filter_or_cow_bs(iter))
2549     {
2550         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_STREAM, errp)) {
2551             goto out;
2552         }
2553     }
2554
2555     /* if we are streaming the entire chain, the result will have no backing
2556      * file, and specifying one is therefore an error */
2557     if (!base_bs && backing_file) {
2558         error_setg(errp, "backing file specified, but streaming the "
2559                          "entire chain");
2560         goto out;
2561     }
2562
2563     if (has_auto_finalize && !auto_finalize) {
2564         job_flags |= JOB_MANUAL_FINALIZE;
2565     }
2566     if (has_auto_dismiss && !auto_dismiss) {
2567         job_flags |= JOB_MANUAL_DISMISS;
2568     }
2569
2570     stream_start(job_id, bs, base_bs, backing_file,
2571                  bottom_bs, job_flags, has_speed ? speed : 0, on_error,
2572                  filter_node_name, &local_err);
2573     if (local_err) {
2574         error_propagate(errp, local_err);
2575         goto out;
2576     }
2577
2578     trace_qmp_block_stream(bs);
2579
2580 out:
2581     aio_context_release(aio_context);
2582 }
2583
2584 void qmp_block_commit(const char *job_id, const char *device,
2585                       const char *base_node,
2586                       const char *base,
2587                       const char *top_node,
2588                       const char *top,
2589                       const char *backing_file,
2590                       bool has_speed, int64_t speed,
2591                       bool has_on_error, BlockdevOnError on_error,
2592                       const char *filter_node_name,
2593                       bool has_auto_finalize, bool auto_finalize,
2594                       bool has_auto_dismiss, bool auto_dismiss,
2595                       Error **errp)
2596 {
2597     BlockDriverState *bs;
2598     BlockDriverState *iter;
2599     BlockDriverState *base_bs, *top_bs;
2600     AioContext *aio_context;
2601     Error *local_err = NULL;
2602     int job_flags = JOB_DEFAULT;
2603     uint64_t top_perm, top_shared;
2604
2605     if (!has_speed) {
2606         speed = 0;
2607     }
2608     if (!has_on_error) {
2609         on_error = BLOCKDEV_ON_ERROR_REPORT;
2610     }
2611     if (has_auto_finalize && !auto_finalize) {
2612         job_flags |= JOB_MANUAL_FINALIZE;
2613     }
2614     if (has_auto_dismiss && !auto_dismiss) {
2615         job_flags |= JOB_MANUAL_DISMISS;
2616     }
2617
2618     /* Important Note:
2619      *  libvirt relies on the DeviceNotFound error class in order to probe for
2620      *  live commit feature versions; for this to work, we must make sure to
2621      *  perform the device lookup before any generic errors that may occur in a
2622      *  scenario in which all optional arguments are omitted. */
2623     bs = qmp_get_root_bs(device, &local_err);
2624     if (!bs) {
2625         bs = bdrv_lookup_bs(device, device, NULL);
2626         if (!bs) {
2627             error_free(local_err);
2628             error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
2629                       "Device '%s' not found", device);
2630         } else {
2631             error_propagate(errp, local_err);
2632         }
2633         return;
2634     }
2635
2636     aio_context = bdrv_get_aio_context(bs);
2637     aio_context_acquire(aio_context);
2638
2639     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_COMMIT_SOURCE, errp)) {
2640         goto out;
2641     }
2642
2643     /* default top_bs is the active layer */
2644     top_bs = bs;
2645
2646     if (top_node && top) {
2647         error_setg(errp, "'top-node' and 'top' are mutually exclusive");
2648         goto out;
2649     } else if (top_node) {
2650         top_bs = bdrv_lookup_bs(NULL, top_node, errp);
2651         if (top_bs == NULL) {
2652             goto out;
2653         }
2654         if (!bdrv_chain_contains(bs, top_bs)) {
2655             error_setg(errp, "'%s' is not in this backing file chain",
2656                        top_node);
2657             goto out;
2658         }
2659     } else if (top) {
2660         /* This strcmp() is just a shortcut, there is no need to
2661          * refresh @bs's filename.  If it mismatches,
2662          * bdrv_find_backing_image() will do the refresh and may still
2663          * return @bs. */
2664         if (strcmp(bs->filename, top) != 0) {
2665             top_bs = bdrv_find_backing_image(bs, top);
2666         }
2667     }
2668
2669     if (top_bs == NULL) {
2670         error_setg(errp, "Top image file %s not found", top ? top : "NULL");
2671         goto out;
2672     }
2673
2674     assert(bdrv_get_aio_context(top_bs) == aio_context);
2675
2676     if (base_node && base) {
2677         error_setg(errp, "'base-node' and 'base' are mutually exclusive");
2678         goto out;
2679     } else if (base_node) {
2680         base_bs = bdrv_lookup_bs(NULL, base_node, errp);
2681         if (base_bs == NULL) {
2682             goto out;
2683         }
2684         if (!bdrv_chain_contains(top_bs, base_bs)) {
2685             error_setg(errp, "'%s' is not in this backing file chain",
2686                        base_node);
2687             goto out;
2688         }
2689     } else if (base) {
2690         base_bs = bdrv_find_backing_image(top_bs, base);
2691         if (base_bs == NULL) {
2692             error_setg(errp, "Can't find '%s' in the backing chain", base);
2693             goto out;
2694         }
2695     } else {
2696         base_bs = bdrv_find_base(top_bs);
2697         if (base_bs == NULL) {
2698             error_setg(errp, "There is no backimg image");
2699             goto out;
2700         }
2701     }
2702
2703     assert(bdrv_get_aio_context(base_bs) == aio_context);
2704
2705     for (iter = top_bs; iter != bdrv_filter_or_cow_bs(base_bs);
2706          iter = bdrv_filter_or_cow_bs(iter))
2707     {
2708         if (bdrv_op_is_blocked(iter, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2709             goto out;
2710         }
2711     }
2712
2713     /* Do not allow attempts to commit an image into itself */
2714     if (top_bs == base_bs) {
2715         error_setg(errp, "cannot commit an image into itself");
2716         goto out;
2717     }
2718
2719     /*
2720      * Active commit is required if and only if someone has taken a
2721      * WRITE permission on the top node.  Historically, we have always
2722      * used active commit for top nodes, so continue that practice
2723      * lest we possibly break clients that rely on this behavior, e.g.
2724      * to later attach this node to a writing parent.
2725      * (Active commit is never really wrong.)
2726      */
2727     bdrv_get_cumulative_perm(top_bs, &top_perm, &top_shared);
2728     if (top_perm & BLK_PERM_WRITE ||
2729         bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs))
2730     {
2731         if (backing_file) {
2732             if (bdrv_skip_filters(top_bs) == bdrv_skip_filters(bs)) {
2733                 error_setg(errp, "'backing-file' specified,"
2734                                  " but 'top' is the active layer");
2735             } else {
2736                 error_setg(errp, "'backing-file' specified, but 'top' has a "
2737                                  "writer on it");
2738             }
2739             goto out;
2740         }
2741         if (!job_id) {
2742             /*
2743              * Emulate here what block_job_create() does, because it
2744              * is possible that @bs != @top_bs (the block job should
2745              * be named after @bs, even if @top_bs is the actual
2746              * source)
2747              */
2748             job_id = bdrv_get_device_name(bs);
2749         }
2750         commit_active_start(job_id, top_bs, base_bs, job_flags, speed, on_error,
2751                             filter_node_name, NULL, NULL, false, &local_err);
2752     } else {
2753         BlockDriverState *overlay_bs = bdrv_find_overlay(bs, top_bs);
2754         if (bdrv_op_is_blocked(overlay_bs, BLOCK_OP_TYPE_COMMIT_TARGET, errp)) {
2755             goto out;
2756         }
2757         commit_start(job_id, bs, base_bs, top_bs, job_flags,
2758                      speed, on_error, backing_file,
2759                      filter_node_name, &local_err);
2760     }
2761     if (local_err != NULL) {
2762         error_propagate(errp, local_err);
2763         goto out;
2764     }
2765
2766 out:
2767     aio_context_release(aio_context);
2768 }
2769
2770 /* Common QMP interface for drive-backup and blockdev-backup */
2771 static BlockJob *do_backup_common(BackupCommon *backup,
2772                                   BlockDriverState *bs,
2773                                   BlockDriverState *target_bs,
2774                                   AioContext *aio_context,
2775                                   JobTxn *txn, Error **errp)
2776 {
2777     BlockJob *job = NULL;
2778     BdrvDirtyBitmap *bmap = NULL;
2779     BackupPerf perf = { .max_workers = 64 };
2780     int job_flags = JOB_DEFAULT;
2781
2782     if (!backup->has_speed) {
2783         backup->speed = 0;
2784     }
2785     if (!backup->has_on_source_error) {
2786         backup->on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2787     }
2788     if (!backup->has_on_target_error) {
2789         backup->on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2790     }
2791     if (!backup->has_auto_finalize) {
2792         backup->auto_finalize = true;
2793     }
2794     if (!backup->has_auto_dismiss) {
2795         backup->auto_dismiss = true;
2796     }
2797     if (!backup->has_compress) {
2798         backup->compress = false;
2799     }
2800
2801     if (backup->x_perf) {
2802         if (backup->x_perf->has_use_copy_range) {
2803             perf.use_copy_range = backup->x_perf->use_copy_range;
2804         }
2805         if (backup->x_perf->has_max_workers) {
2806             perf.max_workers = backup->x_perf->max_workers;
2807         }
2808         if (backup->x_perf->has_max_chunk) {
2809             perf.max_chunk = backup->x_perf->max_chunk;
2810         }
2811     }
2812
2813     if ((backup->sync == MIRROR_SYNC_MODE_BITMAP) ||
2814         (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL)) {
2815         /* done before desugaring 'incremental' to print the right message */
2816         if (!backup->bitmap) {
2817             error_setg(errp, "must provide a valid bitmap name for "
2818                        "'%s' sync mode", MirrorSyncMode_str(backup->sync));
2819             return NULL;
2820         }
2821     }
2822
2823     if (backup->sync == MIRROR_SYNC_MODE_INCREMENTAL) {
2824         if (backup->has_bitmap_mode &&
2825             backup->bitmap_mode != BITMAP_SYNC_MODE_ON_SUCCESS) {
2826             error_setg(errp, "Bitmap sync mode must be '%s' "
2827                        "when using sync mode '%s'",
2828                        BitmapSyncMode_str(BITMAP_SYNC_MODE_ON_SUCCESS),
2829                        MirrorSyncMode_str(backup->sync));
2830             return NULL;
2831         }
2832         backup->has_bitmap_mode = true;
2833         backup->sync = MIRROR_SYNC_MODE_BITMAP;
2834         backup->bitmap_mode = BITMAP_SYNC_MODE_ON_SUCCESS;
2835     }
2836
2837     if (backup->bitmap) {
2838         bmap = bdrv_find_dirty_bitmap(bs, backup->bitmap);
2839         if (!bmap) {
2840             error_setg(errp, "Bitmap '%s' could not be found", backup->bitmap);
2841             return NULL;
2842         }
2843         if (!backup->has_bitmap_mode) {
2844             error_setg(errp, "Bitmap sync mode must be given "
2845                        "when providing a bitmap");
2846             return NULL;
2847         }
2848         if (bdrv_dirty_bitmap_check(bmap, BDRV_BITMAP_ALLOW_RO, errp)) {
2849             return NULL;
2850         }
2851
2852         /* This does not produce a useful bitmap artifact: */
2853         if (backup->sync == MIRROR_SYNC_MODE_NONE) {
2854             error_setg(errp, "sync mode '%s' does not produce meaningful bitmap"
2855                        " outputs", MirrorSyncMode_str(backup->sync));
2856             return NULL;
2857         }
2858
2859         /* If the bitmap isn't used for input or output, this is useless: */
2860         if (backup->bitmap_mode == BITMAP_SYNC_MODE_NEVER &&
2861             backup->sync != MIRROR_SYNC_MODE_BITMAP) {
2862             error_setg(errp, "Bitmap sync mode '%s' has no meaningful effect"
2863                        " when combined with sync mode '%s'",
2864                        BitmapSyncMode_str(backup->bitmap_mode),
2865                        MirrorSyncMode_str(backup->sync));
2866             return NULL;
2867         }
2868     }
2869
2870     if (!backup->bitmap && backup->has_bitmap_mode) {
2871         error_setg(errp, "Cannot specify bitmap sync mode without a bitmap");
2872         return NULL;
2873     }
2874
2875     if (!backup->auto_finalize) {
2876         job_flags |= JOB_MANUAL_FINALIZE;
2877     }
2878     if (!backup->auto_dismiss) {
2879         job_flags |= JOB_MANUAL_DISMISS;
2880     }
2881
2882     job = backup_job_create(backup->job_id, bs, target_bs, backup->speed,
2883                             backup->sync, bmap, backup->bitmap_mode,
2884                             backup->compress,
2885                             backup->filter_node_name,
2886                             &perf,
2887                             backup->on_source_error,
2888                             backup->on_target_error,
2889                             job_flags, NULL, NULL, txn, errp);
2890     return job;
2891 }
2892
2893 void qmp_drive_backup(DriveBackup *backup, Error **errp)
2894 {
2895     TransactionAction action = {
2896         .type = TRANSACTION_ACTION_KIND_DRIVE_BACKUP,
2897         .u.drive_backup.data = backup,
2898     };
2899     blockdev_do_action(&action, errp);
2900 }
2901
2902 BlockDeviceInfoList *qmp_query_named_block_nodes(bool has_flat,
2903                                                  bool flat,
2904                                                  Error **errp)
2905 {
2906     bool return_flat = has_flat && flat;
2907
2908     return bdrv_named_nodes_list(return_flat, errp);
2909 }
2910
2911 XDbgBlockGraph *qmp_x_debug_query_block_graph(Error **errp)
2912 {
2913     return bdrv_get_xdbg_block_graph(errp);
2914 }
2915
2916 void qmp_blockdev_backup(BlockdevBackup *backup, Error **errp)
2917 {
2918     TransactionAction action = {
2919         .type = TRANSACTION_ACTION_KIND_BLOCKDEV_BACKUP,
2920         .u.blockdev_backup.data = backup,
2921     };
2922     blockdev_do_action(&action, errp);
2923 }
2924
2925 /* Parameter check and block job starting for drive mirroring.
2926  * Caller should hold @device and @target's aio context (must be the same).
2927  **/
2928 static void blockdev_mirror_common(const char *job_id, BlockDriverState *bs,
2929                                    BlockDriverState *target,
2930                                    const char *replaces,
2931                                    enum MirrorSyncMode sync,
2932                                    BlockMirrorBackingMode backing_mode,
2933                                    bool zero_target,
2934                                    bool has_speed, int64_t speed,
2935                                    bool has_granularity, uint32_t granularity,
2936                                    bool has_buf_size, int64_t buf_size,
2937                                    bool has_on_source_error,
2938                                    BlockdevOnError on_source_error,
2939                                    bool has_on_target_error,
2940                                    BlockdevOnError on_target_error,
2941                                    bool has_unmap, bool unmap,
2942                                    const char *filter_node_name,
2943                                    bool has_copy_mode, MirrorCopyMode copy_mode,
2944                                    bool has_auto_finalize, bool auto_finalize,
2945                                    bool has_auto_dismiss, bool auto_dismiss,
2946                                    Error **errp)
2947 {
2948     BlockDriverState *unfiltered_bs;
2949     int job_flags = JOB_DEFAULT;
2950
2951     GLOBAL_STATE_CODE();
2952     GRAPH_RDLOCK_GUARD_MAINLOOP();
2953
2954     if (!has_speed) {
2955         speed = 0;
2956     }
2957     if (!has_on_source_error) {
2958         on_source_error = BLOCKDEV_ON_ERROR_REPORT;
2959     }
2960     if (!has_on_target_error) {
2961         on_target_error = BLOCKDEV_ON_ERROR_REPORT;
2962     }
2963     if (!has_granularity) {
2964         granularity = 0;
2965     }
2966     if (!has_buf_size) {
2967         buf_size = 0;
2968     }
2969     if (!has_unmap) {
2970         unmap = true;
2971     }
2972     if (!has_copy_mode) {
2973         copy_mode = MIRROR_COPY_MODE_BACKGROUND;
2974     }
2975     if (has_auto_finalize && !auto_finalize) {
2976         job_flags |= JOB_MANUAL_FINALIZE;
2977     }
2978     if (has_auto_dismiss && !auto_dismiss) {
2979         job_flags |= JOB_MANUAL_DISMISS;
2980     }
2981
2982     if (granularity != 0 && (granularity < 512 || granularity > 1048576 * 64)) {
2983         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2984                    "a value in range [512B, 64MB]");
2985         return;
2986     }
2987     if (granularity & (granularity - 1)) {
2988         error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "granularity",
2989                    "a power of 2");
2990         return;
2991     }
2992
2993     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
2994         return;
2995     }
2996     if (bdrv_op_is_blocked(target, BLOCK_OP_TYPE_MIRROR_TARGET, errp)) {
2997         return;
2998     }
2999
3000     if (!bdrv_backing_chain_next(bs) && sync == MIRROR_SYNC_MODE_TOP) {
3001         sync = MIRROR_SYNC_MODE_FULL;
3002     }
3003
3004     if (!replaces) {
3005         /* We want to mirror from @bs, but keep implicit filters on top */
3006         unfiltered_bs = bdrv_skip_implicit_filters(bs);
3007         if (unfiltered_bs != bs) {
3008             replaces = unfiltered_bs->node_name;
3009         }
3010     }
3011
3012     if (replaces) {
3013         BlockDriverState *to_replace_bs;
3014         AioContext *replace_aio_context;
3015         int64_t bs_size, replace_size;
3016
3017         bs_size = bdrv_getlength(bs);
3018         if (bs_size < 0) {
3019             error_setg_errno(errp, -bs_size, "Failed to query device's size");
3020             return;
3021         }
3022
3023         to_replace_bs = check_to_replace_node(bs, replaces, errp);
3024         if (!to_replace_bs) {
3025             return;
3026         }
3027
3028         replace_aio_context = bdrv_get_aio_context(to_replace_bs);
3029         aio_context_acquire(replace_aio_context);
3030         replace_size = bdrv_getlength(to_replace_bs);
3031         aio_context_release(replace_aio_context);
3032
3033         if (replace_size < 0) {
3034             error_setg_errno(errp, -replace_size,
3035                              "Failed to query the replacement node's size");
3036             return;
3037         }
3038         if (bs_size != replace_size) {
3039             error_setg(errp, "cannot replace image with a mirror image of "
3040                              "different size");
3041             return;
3042         }
3043     }
3044
3045     /* pass the node name to replace to mirror start since it's loose coupling
3046      * and will allow to check whether the node still exist at mirror completion
3047      */
3048     mirror_start(job_id, bs, target,
3049                  replaces, job_flags,
3050                  speed, granularity, buf_size, sync, backing_mode, zero_target,
3051                  on_source_error, on_target_error, unmap, filter_node_name,
3052                  copy_mode, errp);
3053 }
3054
3055 void qmp_drive_mirror(DriveMirror *arg, Error **errp)
3056 {
3057     BlockDriverState *bs;
3058     BlockDriverState *target_backing_bs, *target_bs;
3059     AioContext *aio_context;
3060     AioContext *old_context;
3061     BlockMirrorBackingMode backing_mode;
3062     Error *local_err = NULL;
3063     QDict *options = NULL;
3064     int flags;
3065     int64_t size;
3066     const char *format = arg->format;
3067     bool zero_target;
3068     int ret;
3069
3070     bs = qmp_get_root_bs(arg->device, errp);
3071     if (!bs) {
3072         return;
3073     }
3074
3075     /* Early check to avoid creating target */
3076     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_MIRROR_SOURCE, errp)) {
3077         return;
3078     }
3079
3080     aio_context = bdrv_get_aio_context(bs);
3081     aio_context_acquire(aio_context);
3082
3083     if (!arg->has_mode) {
3084         arg->mode = NEW_IMAGE_MODE_ABSOLUTE_PATHS;
3085     }
3086
3087     if (!arg->format) {
3088         format = (arg->mode == NEW_IMAGE_MODE_EXISTING
3089                   ? NULL : bs->drv->format_name);
3090     }
3091
3092     flags = bs->open_flags | BDRV_O_RDWR;
3093     target_backing_bs = bdrv_cow_bs(bdrv_skip_filters(bs));
3094     if (!target_backing_bs && arg->sync == MIRROR_SYNC_MODE_TOP) {
3095         arg->sync = MIRROR_SYNC_MODE_FULL;
3096     }
3097     if (arg->sync == MIRROR_SYNC_MODE_NONE) {
3098         target_backing_bs = bs;
3099     }
3100
3101     size = bdrv_getlength(bs);
3102     if (size < 0) {
3103         error_setg_errno(errp, -size, "bdrv_getlength failed");
3104         goto out;
3105     }
3106
3107     if (arg->replaces) {
3108         if (!arg->node_name) {
3109             error_setg(errp, "a node-name must be provided when replacing a"
3110                              " named node of the graph");
3111             goto out;
3112         }
3113     }
3114
3115     if (arg->mode == NEW_IMAGE_MODE_ABSOLUTE_PATHS) {
3116         backing_mode = MIRROR_SOURCE_BACKING_CHAIN;
3117     } else {
3118         backing_mode = MIRROR_OPEN_BACKING_CHAIN;
3119     }
3120
3121     /* Don't open backing image in create() */
3122     flags |= BDRV_O_NO_BACKING;
3123
3124     if ((arg->sync == MIRROR_SYNC_MODE_FULL || !target_backing_bs)
3125         && arg->mode != NEW_IMAGE_MODE_EXISTING)
3126     {
3127         /* create new image w/o backing file */
3128         assert(format);
3129         bdrv_img_create(arg->target, format,
3130                         NULL, NULL, NULL, size, flags, false, &local_err);
3131     } else {
3132         /* Implicit filters should not appear in the filename */
3133         BlockDriverState *explicit_backing =
3134             bdrv_skip_implicit_filters(target_backing_bs);
3135
3136         switch (arg->mode) {
3137         case NEW_IMAGE_MODE_EXISTING:
3138             break;
3139         case NEW_IMAGE_MODE_ABSOLUTE_PATHS:
3140             /* create new image with backing file */
3141             bdrv_refresh_filename(explicit_backing);
3142             bdrv_img_create(arg->target, format,
3143                             explicit_backing->filename,
3144                             explicit_backing->drv->format_name,
3145                             NULL, size, flags, false, &local_err);
3146             break;
3147         default:
3148             abort();
3149         }
3150     }
3151
3152     if (local_err) {
3153         error_propagate(errp, local_err);
3154         goto out;
3155     }
3156
3157     options = qdict_new();
3158     if (arg->node_name) {
3159         qdict_put_str(options, "node-name", arg->node_name);
3160     }
3161     if (format) {
3162         qdict_put_str(options, "driver", format);
3163     }
3164
3165     /* Mirroring takes care of copy-on-write using the source's backing
3166      * file.
3167      */
3168     target_bs = bdrv_open(arg->target, NULL, options, flags, errp);
3169     if (!target_bs) {
3170         goto out;
3171     }
3172
3173     zero_target = (arg->sync == MIRROR_SYNC_MODE_FULL &&
3174                    (arg->mode == NEW_IMAGE_MODE_EXISTING ||
3175                     !bdrv_has_zero_init(target_bs)));
3176
3177
3178     /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
3179     old_context = bdrv_get_aio_context(target_bs);
3180     aio_context_release(aio_context);
3181     aio_context_acquire(old_context);
3182
3183     ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
3184     if (ret < 0) {
3185         bdrv_unref(target_bs);
3186         aio_context_release(old_context);
3187         return;
3188     }
3189
3190     aio_context_release(old_context);
3191     aio_context_acquire(aio_context);
3192
3193     blockdev_mirror_common(arg->job_id, bs, target_bs,
3194                            arg->replaces, arg->sync,
3195                            backing_mode, zero_target,
3196                            arg->has_speed, arg->speed,
3197                            arg->has_granularity, arg->granularity,
3198                            arg->has_buf_size, arg->buf_size,
3199                            arg->has_on_source_error, arg->on_source_error,
3200                            arg->has_on_target_error, arg->on_target_error,
3201                            arg->has_unmap, arg->unmap,
3202                            NULL,
3203                            arg->has_copy_mode, arg->copy_mode,
3204                            arg->has_auto_finalize, arg->auto_finalize,
3205                            arg->has_auto_dismiss, arg->auto_dismiss,
3206                            errp);
3207     bdrv_unref(target_bs);
3208 out:
3209     aio_context_release(aio_context);
3210 }
3211
3212 void qmp_blockdev_mirror(const char *job_id,
3213                          const char *device, const char *target,
3214                          const char *replaces,
3215                          MirrorSyncMode sync,
3216                          bool has_speed, int64_t speed,
3217                          bool has_granularity, uint32_t granularity,
3218                          bool has_buf_size, int64_t buf_size,
3219                          bool has_on_source_error,
3220                          BlockdevOnError on_source_error,
3221                          bool has_on_target_error,
3222                          BlockdevOnError on_target_error,
3223                          const char *filter_node_name,
3224                          bool has_copy_mode, MirrorCopyMode copy_mode,
3225                          bool has_auto_finalize, bool auto_finalize,
3226                          bool has_auto_dismiss, bool auto_dismiss,
3227                          Error **errp)
3228 {
3229     BlockDriverState *bs;
3230     BlockDriverState *target_bs;
3231     AioContext *aio_context;
3232     AioContext *old_context;
3233     BlockMirrorBackingMode backing_mode = MIRROR_LEAVE_BACKING_CHAIN;
3234     bool zero_target;
3235     int ret;
3236
3237     bs = qmp_get_root_bs(device, errp);
3238     if (!bs) {
3239         return;
3240     }
3241
3242     target_bs = bdrv_lookup_bs(target, target, errp);
3243     if (!target_bs) {
3244         return;
3245     }
3246
3247     zero_target = (sync == MIRROR_SYNC_MODE_FULL);
3248
3249     /* Honor bdrv_try_change_aio_context() context acquisition requirements. */
3250     old_context = bdrv_get_aio_context(target_bs);
3251     aio_context = bdrv_get_aio_context(bs);
3252     aio_context_acquire(old_context);
3253
3254     ret = bdrv_try_change_aio_context(target_bs, aio_context, NULL, errp);
3255
3256     aio_context_release(old_context);
3257     aio_context_acquire(aio_context);
3258
3259     if (ret < 0) {
3260         goto out;
3261     }
3262
3263     blockdev_mirror_common(job_id, bs, target_bs,
3264                            replaces, sync, backing_mode,
3265                            zero_target, has_speed, speed,
3266                            has_granularity, granularity,
3267                            has_buf_size, buf_size,
3268                            has_on_source_error, on_source_error,
3269                            has_on_target_error, on_target_error,
3270                            true, true, filter_node_name,
3271                            has_copy_mode, copy_mode,
3272                            has_auto_finalize, auto_finalize,
3273                            has_auto_dismiss, auto_dismiss,
3274                            errp);
3275 out:
3276     aio_context_release(aio_context);
3277 }
3278
3279 /*
3280  * Get a block job using its ID. Called with job_mutex held.
3281  */
3282 static BlockJob *find_block_job_locked(const char *id, Error **errp)
3283 {
3284     BlockJob *job;
3285
3286     assert(id != NULL);
3287
3288     job = block_job_get_locked(id);
3289
3290     if (!job) {
3291         error_set(errp, ERROR_CLASS_DEVICE_NOT_ACTIVE,
3292                   "Block job '%s' not found", id);
3293         return NULL;
3294     }
3295
3296     return job;
3297 }
3298
3299 void qmp_block_job_set_speed(const char *device, int64_t speed, Error **errp)
3300 {
3301     BlockJob *job;
3302
3303     JOB_LOCK_GUARD();
3304     job = find_block_job_locked(device, errp);
3305
3306     if (!job) {
3307         return;
3308     }
3309
3310     block_job_set_speed_locked(job, speed, errp);
3311 }
3312
3313 void qmp_block_job_cancel(const char *device,
3314                           bool has_force, bool force, Error **errp)
3315 {
3316     BlockJob *job;
3317
3318     JOB_LOCK_GUARD();
3319     job = find_block_job_locked(device, errp);
3320
3321     if (!job) {
3322         return;
3323     }
3324
3325     if (!has_force) {
3326         force = false;
3327     }
3328
3329     if (job_user_paused_locked(&job->job) && !force) {
3330         error_setg(errp, "The block job for device '%s' is currently paused",
3331                    device);
3332         return;
3333     }
3334
3335     trace_qmp_block_job_cancel(job);
3336     job_user_cancel_locked(&job->job, force, errp);
3337 }
3338
3339 void qmp_block_job_pause(const char *device, Error **errp)
3340 {
3341     BlockJob *job;
3342
3343     JOB_LOCK_GUARD();
3344     job = find_block_job_locked(device, errp);
3345
3346     if (!job) {
3347         return;
3348     }
3349
3350     trace_qmp_block_job_pause(job);
3351     job_user_pause_locked(&job->job, errp);
3352 }
3353
3354 void qmp_block_job_resume(const char *device, Error **errp)
3355 {
3356     BlockJob *job;
3357
3358     JOB_LOCK_GUARD();
3359     job = find_block_job_locked(device, errp);
3360
3361     if (!job) {
3362         return;
3363     }
3364
3365     trace_qmp_block_job_resume(job);
3366     job_user_resume_locked(&job->job, errp);
3367 }
3368
3369 void qmp_block_job_complete(const char *device, Error **errp)
3370 {
3371     BlockJob *job;
3372
3373     JOB_LOCK_GUARD();
3374     job = find_block_job_locked(device, errp);
3375
3376     if (!job) {
3377         return;
3378     }
3379
3380     trace_qmp_block_job_complete(job);
3381     job_complete_locked(&job->job, errp);
3382 }
3383
3384 void qmp_block_job_finalize(const char *id, Error **errp)
3385 {
3386     BlockJob *job;
3387
3388     JOB_LOCK_GUARD();
3389     job = find_block_job_locked(id, errp);
3390
3391     if (!job) {
3392         return;
3393     }
3394
3395     trace_qmp_block_job_finalize(job);
3396     job_ref_locked(&job->job);
3397     job_finalize_locked(&job->job, errp);
3398
3399     job_unref_locked(&job->job);
3400 }
3401
3402 void qmp_block_job_dismiss(const char *id, Error **errp)
3403 {
3404     BlockJob *bjob;
3405     Job *job;
3406
3407     JOB_LOCK_GUARD();
3408     bjob = find_block_job_locked(id, errp);
3409
3410     if (!bjob) {
3411         return;
3412     }
3413
3414     trace_qmp_block_job_dismiss(bjob);
3415     job = &bjob->job;
3416     job_dismiss_locked(&job, errp);
3417 }
3418
3419 void qmp_change_backing_file(const char *device,
3420                              const char *image_node_name,
3421                              const char *backing_file,
3422                              Error **errp)
3423 {
3424     BlockDriverState *bs = NULL;
3425     AioContext *aio_context;
3426     BlockDriverState *image_bs = NULL;
3427     Error *local_err = NULL;
3428     bool ro;
3429     int ret;
3430
3431     bs = qmp_get_root_bs(device, errp);
3432     if (!bs) {
3433         return;
3434     }
3435
3436     aio_context = bdrv_get_aio_context(bs);
3437     aio_context_acquire(aio_context);
3438
3439     image_bs = bdrv_lookup_bs(NULL, image_node_name, &local_err);
3440     if (local_err) {
3441         error_propagate(errp, local_err);
3442         goto out;
3443     }
3444
3445     if (!image_bs) {
3446         error_setg(errp, "image file not found");
3447         goto out;
3448     }
3449
3450     if (bdrv_find_base(image_bs) == image_bs) {
3451         error_setg(errp, "not allowing backing file change on an image "
3452                          "without a backing file");
3453         goto out;
3454     }
3455
3456     /* even though we are not necessarily operating on bs, we need it to
3457      * determine if block ops are currently prohibited on the chain */
3458     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_CHANGE, errp)) {
3459         goto out;
3460     }
3461
3462     /* final sanity check */
3463     if (!bdrv_chain_contains(bs, image_bs)) {
3464         error_setg(errp, "'%s' and image file are not in the same chain",
3465                    device);
3466         goto out;
3467     }
3468
3469     /* if not r/w, reopen to make r/w */
3470     ro = bdrv_is_read_only(image_bs);
3471
3472     if (ro) {
3473         if (bdrv_reopen_set_read_only(image_bs, false, errp) != 0) {
3474             goto out;
3475         }
3476     }
3477
3478     ret = bdrv_change_backing_file(image_bs, backing_file,
3479                                    image_bs->drv ? image_bs->drv->format_name : "",
3480                                    false);
3481
3482     if (ret < 0) {
3483         error_setg_errno(errp, -ret, "Could not change backing file to '%s'",
3484                          backing_file);
3485         /* don't exit here, so we can try to restore open flags if
3486          * appropriate */
3487     }
3488
3489     if (ro) {
3490         bdrv_reopen_set_read_only(image_bs, true, errp);
3491     }
3492
3493 out:
3494     aio_context_release(aio_context);
3495 }
3496
3497 void qmp_blockdev_add(BlockdevOptions *options, Error **errp)
3498 {
3499     BlockDriverState *bs;
3500     QObject *obj;
3501     Visitor *v = qobject_output_visitor_new(&obj);
3502     QDict *qdict;
3503
3504     visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3505     visit_complete(v, &obj);
3506     qdict = qobject_to(QDict, obj);
3507
3508     qdict_flatten(qdict);
3509
3510     if (!qdict_get_try_str(qdict, "node-name")) {
3511         error_setg(errp, "'node-name' must be specified for the root node");
3512         goto fail;
3513     }
3514
3515     bs = bds_tree_init(qdict, errp);
3516     if (!bs) {
3517         goto fail;
3518     }
3519
3520     bdrv_set_monitor_owned(bs);
3521
3522 fail:
3523     visit_free(v);
3524 }
3525
3526 void qmp_blockdev_reopen(BlockdevOptionsList *reopen_list, Error **errp)
3527 {
3528     BlockReopenQueue *queue = NULL;
3529
3530     /* Add each one of the BDS that we want to reopen to the queue */
3531     for (; reopen_list != NULL; reopen_list = reopen_list->next) {
3532         BlockdevOptions *options = reopen_list->value;
3533         BlockDriverState *bs;
3534         AioContext *ctx;
3535         QObject *obj;
3536         Visitor *v;
3537         QDict *qdict;
3538
3539         /* Check for the selected node name */
3540         if (!options->node_name) {
3541             error_setg(errp, "node-name not specified");
3542             goto fail;
3543         }
3544
3545         bs = bdrv_find_node(options->node_name);
3546         if (!bs) {
3547             error_setg(errp, "Failed to find node with node-name='%s'",
3548                        options->node_name);
3549             goto fail;
3550         }
3551
3552         /* Put all options in a QDict and flatten it */
3553         v = qobject_output_visitor_new(&obj);
3554         visit_type_BlockdevOptions(v, NULL, &options, &error_abort);
3555         visit_complete(v, &obj);
3556         visit_free(v);
3557
3558         qdict = qobject_to(QDict, obj);
3559
3560         qdict_flatten(qdict);
3561
3562         ctx = bdrv_get_aio_context(bs);
3563         aio_context_acquire(ctx);
3564
3565         queue = bdrv_reopen_queue(queue, bs, qdict, false);
3566
3567         aio_context_release(ctx);
3568     }
3569
3570     /* Perform the reopen operation */
3571     bdrv_reopen_multiple(queue, errp);
3572     queue = NULL;
3573
3574 fail:
3575     bdrv_reopen_queue_free(queue);
3576 }
3577
3578 void qmp_blockdev_del(const char *node_name, Error **errp)
3579 {
3580     AioContext *aio_context;
3581     BlockDriverState *bs;
3582
3583     GLOBAL_STATE_CODE();
3584
3585     bs = bdrv_find_node(node_name);
3586     if (!bs) {
3587         error_setg(errp, "Failed to find node with node-name='%s'", node_name);
3588         return;
3589     }
3590     if (bdrv_has_blk(bs)) {
3591         error_setg(errp, "Node %s is in use", node_name);
3592         return;
3593     }
3594     aio_context = bdrv_get_aio_context(bs);
3595     aio_context_acquire(aio_context);
3596
3597     if (bdrv_op_is_blocked(bs, BLOCK_OP_TYPE_DRIVE_DEL, errp)) {
3598         goto out;
3599     }
3600
3601     if (!QTAILQ_IN_USE(bs, monitor_list)) {
3602         error_setg(errp, "Node %s is not owned by the monitor",
3603                    bs->node_name);
3604         goto out;
3605     }
3606
3607     if (bs->refcnt > 1) {
3608         error_setg(errp, "Block device %s is in use",
3609                    bdrv_get_device_or_node_name(bs));
3610         goto out;
3611     }
3612
3613     QTAILQ_REMOVE(&monitor_bdrv_states, bs, monitor_list);
3614     bdrv_unref(bs);
3615
3616 out:
3617     aio_context_release(aio_context);
3618 }
3619
3620 static BdrvChild *bdrv_find_child(BlockDriverState *parent_bs,
3621                                   const char *child_name)
3622 {
3623     BdrvChild *child;
3624
3625     QLIST_FOREACH(child, &parent_bs->children, next) {
3626         if (strcmp(child->name, child_name) == 0) {
3627             return child;
3628         }
3629     }
3630
3631     return NULL;
3632 }
3633
3634 void qmp_x_blockdev_change(const char *parent, const char *child,
3635                            const char *node, Error **errp)
3636 {
3637     BlockDriverState *parent_bs, *new_bs = NULL;
3638     BdrvChild *p_child;
3639
3640     parent_bs = bdrv_lookup_bs(parent, parent, errp);
3641     if (!parent_bs) {
3642         return;
3643     }
3644
3645     if (!child == !node) {
3646         if (child) {
3647             error_setg(errp, "The parameters child and node are in conflict");
3648         } else {
3649             error_setg(errp, "Either child or node must be specified");
3650         }
3651         return;
3652     }
3653
3654     if (child) {
3655         p_child = bdrv_find_child(parent_bs, child);
3656         if (!p_child) {
3657             error_setg(errp, "Node '%s' does not have child '%s'",
3658                        parent, child);
3659             return;
3660         }
3661         bdrv_del_child(parent_bs, p_child, errp);
3662     }
3663
3664     if (node) {
3665         new_bs = bdrv_find_node(node);
3666         if (!new_bs) {
3667             error_setg(errp, "Node '%s' not found", node);
3668             return;
3669         }
3670         bdrv_add_child(parent_bs, new_bs, errp);
3671     }
3672 }
3673
3674 BlockJobInfoList *qmp_query_block_jobs(Error **errp)
3675 {
3676     BlockJobInfoList *head = NULL, **tail = &head;
3677     BlockJob *job;
3678
3679     JOB_LOCK_GUARD();
3680
3681     for (job = block_job_next_locked(NULL); job;
3682          job = block_job_next_locked(job)) {
3683         BlockJobInfo *value;
3684
3685         if (block_job_is_internal(job)) {
3686             continue;
3687         }
3688         value = block_job_query_locked(job, errp);
3689         if (!value) {
3690             qapi_free_BlockJobInfoList(head);
3691             return NULL;
3692         }
3693         QAPI_LIST_APPEND(tail, value);
3694     }
3695
3696     return head;
3697 }
3698
3699 void qmp_x_blockdev_set_iothread(const char *node_name, StrOrNull *iothread,
3700                                  bool has_force, bool force, Error **errp)
3701 {
3702     AioContext *old_context;
3703     AioContext *new_context;
3704     BlockDriverState *bs;
3705
3706     bs = bdrv_find_node(node_name);
3707     if (!bs) {
3708         error_setg(errp, "Failed to find node with node-name='%s'", node_name);
3709         return;
3710     }
3711
3712     /* Protects against accidents. */
3713     if (!(has_force && force) && bdrv_has_blk(bs)) {
3714         error_setg(errp, "Node %s is associated with a BlockBackend and could "
3715                          "be in use (use force=true to override this check)",
3716                          node_name);
3717         return;
3718     }
3719
3720     if (iothread->type == QTYPE_QSTRING) {
3721         IOThread *obj = iothread_by_id(iothread->u.s);
3722         if (!obj) {
3723             error_setg(errp, "Cannot find iothread %s", iothread->u.s);
3724             return;
3725         }
3726
3727         new_context = iothread_get_aio_context(obj);
3728     } else {
3729         new_context = qemu_get_aio_context();
3730     }
3731
3732     old_context = bdrv_get_aio_context(bs);
3733     aio_context_acquire(old_context);
3734
3735     bdrv_try_change_aio_context(bs, new_context, NULL, errp);
3736
3737     aio_context_release(old_context);
3738 }
3739
3740 QemuOptsList qemu_common_drive_opts = {
3741     .name = "drive",
3742     .head = QTAILQ_HEAD_INITIALIZER(qemu_common_drive_opts.head),
3743     .desc = {
3744         {
3745             .name = "snapshot",
3746             .type = QEMU_OPT_BOOL,
3747             .help = "enable/disable snapshot mode",
3748         },{
3749             .name = "aio",
3750             .type = QEMU_OPT_STRING,
3751             .help = "host AIO implementation (threads, native, io_uring)",
3752         },{
3753             .name = BDRV_OPT_CACHE_WB,
3754             .type = QEMU_OPT_BOOL,
3755             .help = "Enable writeback mode",
3756         },{
3757             .name = "format",
3758             .type = QEMU_OPT_STRING,
3759             .help = "disk format (raw, qcow2, ...)",
3760         },{
3761             .name = "rerror",
3762             .type = QEMU_OPT_STRING,
3763             .help = "read error action",
3764         },{
3765             .name = "werror",
3766             .type = QEMU_OPT_STRING,
3767             .help = "write error action",
3768         },{
3769             .name = BDRV_OPT_READ_ONLY,
3770             .type = QEMU_OPT_BOOL,
3771             .help = "open drive file as read-only",
3772         },
3773
3774         THROTTLE_OPTS,
3775
3776         {
3777             .name = "throttling.group",
3778             .type = QEMU_OPT_STRING,
3779             .help = "name of the block throttling group",
3780         },{
3781             .name = "copy-on-read",
3782             .type = QEMU_OPT_BOOL,
3783             .help = "copy read data from backing file into image file",
3784         },{
3785             .name = "detect-zeroes",
3786             .type = QEMU_OPT_STRING,
3787             .help = "try to optimize zero writes (off, on, unmap)",
3788         },{
3789             .name = "stats-account-invalid",
3790             .type = QEMU_OPT_BOOL,
3791             .help = "whether to account for invalid I/O operations "
3792                     "in the statistics",
3793         },{
3794             .name = "stats-account-failed",
3795             .type = QEMU_OPT_BOOL,
3796             .help = "whether to account for failed I/O operations "
3797                     "in the statistics",
3798         },
3799         { /* end of list */ }
3800     },
3801 };
3802
3803 QemuOptsList qemu_drive_opts = {
3804     .name = "drive",
3805     .head = QTAILQ_HEAD_INITIALIZER(qemu_drive_opts.head),
3806     .desc = {
3807         /*
3808          * no elements => accept any params
3809          * validation will happen later
3810          */
3811         { /* end of list */ }
3812     },
3813 };