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