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