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