1 /* 2 * QEMU disk image utility 3 * 4 * Copyright (c) 2003-2008 Fabrice Bellard 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to deal 8 * in the Software without restriction, including without limitation the rights 9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in 14 * all copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 22 * THE SOFTWARE. 23 */ 24 25 #include "qemu/osdep.h" 26 #include <getopt.h> 27 28 #include "qemu/help-texts.h" 29 #include "qemu/qemu-progress.h" 30 #include "qemu-version.h" 31 #include "qapi/error.h" 32 #include "qapi/qapi-commands-block-core.h" 33 #include "qapi/qapi-visit-block-core.h" 34 #include "qapi/qobject-output-visitor.h" 35 #include "qapi/qmp/qjson.h" 36 #include "qapi/qmp/qdict.h" 37 #include "qemu/cutils.h" 38 #include "qemu/config-file.h" 39 #include "qemu/option.h" 40 #include "qemu/error-report.h" 41 #include "qemu/log.h" 42 #include "qemu/main-loop.h" 43 #include "qemu/module.h" 44 #include "qemu/sockets.h" 45 #include "qemu/units.h" 46 #include "qemu/memalign.h" 47 #include "qom/object_interfaces.h" 48 #include "sysemu/block-backend.h" 49 #include "block/block_int.h" 50 #include "block/blockjob.h" 51 #include "block/dirty-bitmap.h" 52 #include "block/qapi.h" 53 #include "crypto/init.h" 54 #include "trace/control.h" 55 #include "qemu/throttle.h" 56 #include "block/throttle-groups.h" 57 58 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \ 59 "\n" QEMU_COPYRIGHT "\n" 60 61 typedef struct img_cmd_t { 62 const char *name; 63 int (*handler)(int argc, char **argv); 64 } img_cmd_t; 65 66 enum { 67 OPTION_OUTPUT = 256, 68 OPTION_BACKING_CHAIN = 257, 69 OPTION_OBJECT = 258, 70 OPTION_IMAGE_OPTS = 259, 71 OPTION_PATTERN = 260, 72 OPTION_FLUSH_INTERVAL = 261, 73 OPTION_NO_DRAIN = 262, 74 OPTION_TARGET_IMAGE_OPTS = 263, 75 OPTION_SIZE = 264, 76 OPTION_PREALLOCATION = 265, 77 OPTION_SHRINK = 266, 78 OPTION_SALVAGE = 267, 79 OPTION_TARGET_IS_ZERO = 268, 80 OPTION_ADD = 269, 81 OPTION_REMOVE = 270, 82 OPTION_CLEAR = 271, 83 OPTION_ENABLE = 272, 84 OPTION_DISABLE = 273, 85 OPTION_MERGE = 274, 86 OPTION_BITMAPS = 275, 87 OPTION_FORCE = 276, 88 OPTION_SKIP_BROKEN = 277, 89 }; 90 91 typedef enum OutputFormat { 92 OFORMAT_JSON, 93 OFORMAT_HUMAN, 94 } OutputFormat; 95 96 /* Default to cache=writeback as data integrity is not important for qemu-img */ 97 #define BDRV_DEFAULT_CACHE "writeback" 98 99 static void format_print(void *opaque, const char *name) 100 { 101 printf(" %s", name); 102 } 103 104 static G_NORETURN G_GNUC_PRINTF(1, 2) 105 void error_exit(const char *fmt, ...) 106 { 107 va_list ap; 108 109 va_start(ap, fmt); 110 error_vreport(fmt, ap); 111 va_end(ap); 112 113 error_printf("Try 'qemu-img --help' for more information\n"); 114 exit(EXIT_FAILURE); 115 } 116 117 static G_NORETURN 118 void missing_argument(const char *option) 119 { 120 error_exit("missing argument for option '%s'", option); 121 } 122 123 static G_NORETURN 124 void unrecognized_option(const char *option) 125 { 126 error_exit("unrecognized option '%s'", option); 127 } 128 129 /* Please keep in synch with docs/tools/qemu-img.rst */ 130 static G_NORETURN 131 void help(void) 132 { 133 const char *help_msg = 134 QEMU_IMG_VERSION 135 "usage: qemu-img [standard options] command [command options]\n" 136 "QEMU disk image utility\n" 137 "\n" 138 " '-h', '--help' display this help and exit\n" 139 " '-V', '--version' output version information and exit\n" 140 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 141 " specify tracing options\n" 142 "\n" 143 "Command syntax:\n" 144 #define DEF(option, callback, arg_string) \ 145 " " arg_string "\n" 146 #include "qemu-img-cmds.h" 147 #undef DEF 148 "\n" 149 "Command parameters:\n" 150 " 'filename' is a disk image filename\n" 151 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n" 152 " manual page for a description of the object properties. The most common\n" 153 " object type is a 'secret', which is used to supply passwords and/or\n" 154 " encryption keys.\n" 155 " 'fmt' is the disk image format. It is guessed automatically in most cases\n" 156 " 'cache' is the cache mode used to write the output disk image, the valid\n" 157 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n" 158 " 'directsync' and 'unsafe' (default for convert)\n" 159 " 'src_cache' is the cache mode used to read input disk images, the valid\n" 160 " options are the same as for the 'cache' option\n" 161 " 'size' is the disk image size in bytes. Optional suffixes\n" 162 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n" 163 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n" 164 " supported. 'b' is ignored.\n" 165 " 'output_filename' is the destination disk image filename\n" 166 " 'output_fmt' is the destination format\n" 167 " 'options' is a comma separated list of format specific options in a\n" 168 " name=value format. Use -o help for an overview of the options supported by\n" 169 " the used format\n" 170 " 'snapshot_param' is param used for internal snapshot, format\n" 171 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n" 172 " '[ID_OR_NAME]'\n" 173 " '-c' indicates that target image must be compressed (qcow format only)\n" 174 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n" 175 " new backing file match exactly. The image doesn't need a working\n" 176 " backing file before rebasing in this case (useful for renaming the\n" 177 " backing file). For image creation, allow creating without attempting\n" 178 " to open the backing file.\n" 179 " '-h' with or without a command shows this help and lists the supported formats\n" 180 " '-p' show progress of command (only certain commands)\n" 181 " '-q' use Quiet mode - do not print any output (except errors)\n" 182 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n" 183 " contain only zeros for qemu-img to create a sparse image during\n" 184 " conversion. If the number of bytes is 0, the source will not be scanned for\n" 185 " unallocated or zero sectors, and the destination image will always be\n" 186 " fully allocated\n" 187 " '--output' takes the format in which the output must be done (human or json)\n" 188 " '-n' skips the target volume creation (useful if the volume is created\n" 189 " prior to running qemu-img)\n" 190 "\n" 191 "Parameters to bitmap subcommand:\n" 192 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n" 193 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n" 194 " or '--merge source'\n" 195 " '-g granularity' sets the granularity for '--add' actions\n" 196 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n" 197 " bitmaps from an alternative file\n" 198 "\n" 199 "Parameters to check subcommand:\n" 200 " '-r' tries to repair any inconsistencies that are found during the check.\n" 201 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n" 202 " kinds of errors, with a higher risk of choosing the wrong fix or\n" 203 " hiding corruption that has already occurred.\n" 204 "\n" 205 "Parameters to convert subcommand:\n" 206 " '--bitmaps' copies all top-level persistent bitmaps to destination\n" 207 " '-m' specifies how many coroutines work in parallel during the convert\n" 208 " process (defaults to 8)\n" 209 " '-W' allow to write to the target out of order rather than sequential\n" 210 "\n" 211 "Parameters to snapshot subcommand:\n" 212 " 'snapshot' is the name of the snapshot to create, apply or delete\n" 213 " '-a' applies a snapshot (revert disk to saved state)\n" 214 " '-c' creates a snapshot\n" 215 " '-d' deletes a snapshot\n" 216 " '-l' lists all snapshots in the given image\n" 217 "\n" 218 "Parameters to compare subcommand:\n" 219 " '-f' first image format\n" 220 " '-F' second image format\n" 221 " '-s' run in Strict mode - fail on different image size or sector allocation\n" 222 "\n" 223 "Parameters to dd subcommand:\n" 224 " 'bs=BYTES' read and write up to BYTES bytes at a time " 225 "(default: 512)\n" 226 " 'count=N' copy only N input blocks\n" 227 " 'if=FILE' read from FILE\n" 228 " 'of=FILE' write to FILE\n" 229 " 'skip=N' skip N bs-sized blocks at the start of input\n"; 230 231 printf("%s\nSupported formats:", help_msg); 232 bdrv_iterate_format(format_print, NULL, false); 233 printf("\n\n" QEMU_HELP_BOTTOM "\n"); 234 exit(EXIT_SUCCESS); 235 } 236 237 /* 238 * Is @optarg safe for accumulate_options()? 239 * It is when multiple of them can be joined together separated by ','. 240 * To make that work, @optarg must not start with ',' (or else a 241 * separating ',' preceding it gets escaped), and it must not end with 242 * an odd number of ',' (or else a separating ',' following it gets 243 * escaped), or be empty (or else a separating ',' preceding it can 244 * escape a separating ',' following it). 245 * 246 */ 247 static bool is_valid_option_list(const char *optarg) 248 { 249 size_t len = strlen(optarg); 250 size_t i; 251 252 if (!optarg[0] || optarg[0] == ',') { 253 return false; 254 } 255 256 for (i = len; i > 0 && optarg[i - 1] == ','; i--) { 257 } 258 if ((len - i) % 2) { 259 return false; 260 } 261 262 return true; 263 } 264 265 static int accumulate_options(char **options, char *optarg) 266 { 267 char *new_options; 268 269 if (!is_valid_option_list(optarg)) { 270 error_report("Invalid option list: %s", optarg); 271 return -1; 272 } 273 274 if (!*options) { 275 *options = g_strdup(optarg); 276 } else { 277 new_options = g_strdup_printf("%s,%s", *options, optarg); 278 g_free(*options); 279 *options = new_options; 280 } 281 return 0; 282 } 283 284 static QemuOptsList qemu_source_opts = { 285 .name = "source", 286 .implied_opt_name = "file", 287 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head), 288 .desc = { 289 { } 290 }, 291 }; 292 293 static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet, const char *fmt, ...) 294 { 295 int ret = 0; 296 if (!quiet) { 297 va_list args; 298 va_start(args, fmt); 299 ret = vprintf(fmt, args); 300 va_end(args); 301 } 302 return ret; 303 } 304 305 306 static int print_block_option_help(const char *filename, const char *fmt) 307 { 308 BlockDriver *drv, *proto_drv; 309 QemuOptsList *create_opts = NULL; 310 Error *local_err = NULL; 311 312 /* Find driver and parse its options */ 313 drv = bdrv_find_format(fmt); 314 if (!drv) { 315 error_report("Unknown file format '%s'", fmt); 316 return 1; 317 } 318 319 if (!drv->create_opts) { 320 error_report("Format driver '%s' does not support image creation", fmt); 321 return 1; 322 } 323 324 create_opts = qemu_opts_append(create_opts, drv->create_opts); 325 if (filename) { 326 proto_drv = bdrv_find_protocol(filename, true, &local_err); 327 if (!proto_drv) { 328 error_report_err(local_err); 329 qemu_opts_free(create_opts); 330 return 1; 331 } 332 if (!proto_drv->create_opts) { 333 error_report("Protocol driver '%s' does not support image creation", 334 proto_drv->format_name); 335 qemu_opts_free(create_opts); 336 return 1; 337 } 338 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); 339 } 340 341 if (filename) { 342 printf("Supported options:\n"); 343 } else { 344 printf("Supported %s options:\n", fmt); 345 } 346 qemu_opts_print_help(create_opts, false); 347 qemu_opts_free(create_opts); 348 349 if (!filename) { 350 printf("\n" 351 "The protocol level may support further options.\n" 352 "Specify the target filename to include those options.\n"); 353 } 354 355 return 0; 356 } 357 358 359 static BlockBackend *img_open_opts(const char *optstr, 360 QemuOpts *opts, int flags, bool writethrough, 361 bool quiet, bool force_share) 362 { 363 QDict *options; 364 Error *local_err = NULL; 365 BlockBackend *blk; 366 options = qemu_opts_to_qdict(opts, NULL); 367 if (force_share) { 368 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE) 369 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) { 370 error_report("--force-share/-U conflicts with image options"); 371 qobject_unref(options); 372 return NULL; 373 } 374 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on"); 375 } 376 blk = blk_new_open(NULL, NULL, options, flags, &local_err); 377 if (!blk) { 378 error_reportf_err(local_err, "Could not open '%s': ", optstr); 379 return NULL; 380 } 381 blk_set_enable_write_cache(blk, !writethrough); 382 383 return blk; 384 } 385 386 static BlockBackend *img_open_file(const char *filename, 387 QDict *options, 388 const char *fmt, int flags, 389 bool writethrough, bool quiet, 390 bool force_share) 391 { 392 BlockBackend *blk; 393 Error *local_err = NULL; 394 395 if (!options) { 396 options = qdict_new(); 397 } 398 if (fmt) { 399 qdict_put_str(options, "driver", fmt); 400 } 401 402 if (force_share) { 403 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true); 404 } 405 blk = blk_new_open(filename, NULL, options, flags, &local_err); 406 if (!blk) { 407 error_reportf_err(local_err, "Could not open '%s': ", filename); 408 return NULL; 409 } 410 blk_set_enable_write_cache(blk, !writethrough); 411 412 return blk; 413 } 414 415 416 static int img_add_key_secrets(void *opaque, 417 const char *name, const char *value, 418 Error **errp) 419 { 420 QDict *options = opaque; 421 422 if (g_str_has_suffix(name, "key-secret")) { 423 qdict_put_str(options, name, value); 424 } 425 426 return 0; 427 } 428 429 430 static BlockBackend *img_open(bool image_opts, 431 const char *filename, 432 const char *fmt, int flags, bool writethrough, 433 bool quiet, bool force_share) 434 { 435 BlockBackend *blk; 436 if (image_opts) { 437 QemuOpts *opts; 438 if (fmt) { 439 error_report("--image-opts and --format are mutually exclusive"); 440 return NULL; 441 } 442 opts = qemu_opts_parse_noisily(qemu_find_opts("source"), 443 filename, true); 444 if (!opts) { 445 return NULL; 446 } 447 blk = img_open_opts(filename, opts, flags, writethrough, quiet, 448 force_share); 449 } else { 450 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet, 451 force_share); 452 } 453 454 if (blk) { 455 blk_set_force_allow_inactivate(blk); 456 } 457 458 return blk; 459 } 460 461 462 static int add_old_style_options(const char *fmt, QemuOpts *opts, 463 const char *base_filename, 464 const char *base_fmt) 465 { 466 if (base_filename) { 467 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, 468 NULL)) { 469 error_report("Backing file not supported for file format '%s'", 470 fmt); 471 return -1; 472 } 473 } 474 if (base_fmt) { 475 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) { 476 error_report("Backing file format not supported for file " 477 "format '%s'", fmt); 478 return -1; 479 } 480 } 481 return 0; 482 } 483 484 static int64_t cvtnum_full(const char *name, const char *value, int64_t min, 485 int64_t max) 486 { 487 int err; 488 uint64_t res; 489 490 err = qemu_strtosz(value, NULL, &res); 491 if (err < 0 && err != -ERANGE) { 492 error_report("Invalid %s specified. You may use " 493 "k, M, G, T, P or E suffixes for", name); 494 error_report("kilobytes, megabytes, gigabytes, terabytes, " 495 "petabytes and exabytes."); 496 return err; 497 } 498 if (err == -ERANGE || res > max || res < min) { 499 error_report("Invalid %s specified. Must be between %" PRId64 500 " and %" PRId64 ".", name, min, max); 501 return -ERANGE; 502 } 503 return res; 504 } 505 506 static int64_t cvtnum(const char *name, const char *value) 507 { 508 return cvtnum_full(name, value, 0, INT64_MAX); 509 } 510 511 static int img_create(int argc, char **argv) 512 { 513 int c; 514 uint64_t img_size = -1; 515 const char *fmt = "raw"; 516 const char *base_fmt = NULL; 517 const char *filename; 518 const char *base_filename = NULL; 519 char *options = NULL; 520 Error *local_err = NULL; 521 bool quiet = false; 522 int flags = 0; 523 524 for(;;) { 525 static const struct option long_options[] = { 526 {"help", no_argument, 0, 'h'}, 527 {"object", required_argument, 0, OPTION_OBJECT}, 528 {0, 0, 0, 0} 529 }; 530 c = getopt_long(argc, argv, ":F:b:f:ho:qu", 531 long_options, NULL); 532 if (c == -1) { 533 break; 534 } 535 switch(c) { 536 case ':': 537 missing_argument(argv[optind - 1]); 538 break; 539 case '?': 540 unrecognized_option(argv[optind - 1]); 541 break; 542 case 'h': 543 help(); 544 break; 545 case 'F': 546 base_fmt = optarg; 547 break; 548 case 'b': 549 base_filename = optarg; 550 break; 551 case 'f': 552 fmt = optarg; 553 break; 554 case 'o': 555 if (accumulate_options(&options, optarg) < 0) { 556 goto fail; 557 } 558 break; 559 case 'q': 560 quiet = true; 561 break; 562 case 'u': 563 flags |= BDRV_O_NO_BACKING; 564 break; 565 case OPTION_OBJECT: 566 user_creatable_process_cmdline(optarg); 567 break; 568 } 569 } 570 571 /* Get the filename */ 572 filename = (optind < argc) ? argv[optind] : NULL; 573 if (options && has_help_option(options)) { 574 g_free(options); 575 return print_block_option_help(filename, fmt); 576 } 577 578 if (optind >= argc) { 579 error_exit("Expecting image file name"); 580 } 581 optind++; 582 583 /* Get image size, if specified */ 584 if (optind < argc) { 585 int64_t sval; 586 587 sval = cvtnum("image size", argv[optind++]); 588 if (sval < 0) { 589 goto fail; 590 } 591 img_size = (uint64_t)sval; 592 } 593 if (optind != argc) { 594 error_exit("Unexpected argument: %s", argv[optind]); 595 } 596 597 bdrv_img_create(filename, fmt, base_filename, base_fmt, 598 options, img_size, flags, quiet, &local_err); 599 if (local_err) { 600 error_reportf_err(local_err, "%s: ", filename); 601 goto fail; 602 } 603 604 g_free(options); 605 return 0; 606 607 fail: 608 g_free(options); 609 return 1; 610 } 611 612 static void dump_json_image_check(ImageCheck *check, bool quiet) 613 { 614 GString *str; 615 QObject *obj; 616 Visitor *v = qobject_output_visitor_new(&obj); 617 618 visit_type_ImageCheck(v, NULL, &check, &error_abort); 619 visit_complete(v, &obj); 620 str = qobject_to_json_pretty(obj, true); 621 assert(str != NULL); 622 qprintf(quiet, "%s\n", str->str); 623 qobject_unref(obj); 624 visit_free(v); 625 g_string_free(str, true); 626 } 627 628 static void dump_human_image_check(ImageCheck *check, bool quiet) 629 { 630 if (!(check->corruptions || check->leaks || check->check_errors)) { 631 qprintf(quiet, "No errors were found on the image.\n"); 632 } else { 633 if (check->corruptions) { 634 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n" 635 "Data may be corrupted, or further writes to the image " 636 "may corrupt it.\n", 637 check->corruptions); 638 } 639 640 if (check->leaks) { 641 qprintf(quiet, 642 "\n%" PRId64 " leaked clusters were found on the image.\n" 643 "This means waste of disk space, but no harm to data.\n", 644 check->leaks); 645 } 646 647 if (check->check_errors) { 648 qprintf(quiet, 649 "\n%" PRId64 650 " internal errors have occurred during the check.\n", 651 check->check_errors); 652 } 653 } 654 655 if (check->total_clusters != 0 && check->allocated_clusters != 0) { 656 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, " 657 "%0.2f%% fragmented, %0.2f%% compressed clusters\n", 658 check->allocated_clusters, check->total_clusters, 659 check->allocated_clusters * 100.0 / check->total_clusters, 660 check->fragmented_clusters * 100.0 / check->allocated_clusters, 661 check->compressed_clusters * 100.0 / 662 check->allocated_clusters); 663 } 664 665 if (check->image_end_offset) { 666 qprintf(quiet, 667 "Image end offset: %" PRId64 "\n", check->image_end_offset); 668 } 669 } 670 671 static int collect_image_check(BlockDriverState *bs, 672 ImageCheck *check, 673 const char *filename, 674 const char *fmt, 675 int fix) 676 { 677 int ret; 678 BdrvCheckResult result; 679 680 ret = bdrv_check(bs, &result, fix); 681 if (ret < 0) { 682 return ret; 683 } 684 685 check->filename = g_strdup(filename); 686 check->format = g_strdup(bdrv_get_format_name(bs)); 687 check->check_errors = result.check_errors; 688 check->corruptions = result.corruptions; 689 check->has_corruptions = result.corruptions != 0; 690 check->leaks = result.leaks; 691 check->has_leaks = result.leaks != 0; 692 check->corruptions_fixed = result.corruptions_fixed; 693 check->has_corruptions_fixed = result.corruptions_fixed != 0; 694 check->leaks_fixed = result.leaks_fixed; 695 check->has_leaks_fixed = result.leaks_fixed != 0; 696 check->image_end_offset = result.image_end_offset; 697 check->has_image_end_offset = result.image_end_offset != 0; 698 check->total_clusters = result.bfi.total_clusters; 699 check->has_total_clusters = result.bfi.total_clusters != 0; 700 check->allocated_clusters = result.bfi.allocated_clusters; 701 check->has_allocated_clusters = result.bfi.allocated_clusters != 0; 702 check->fragmented_clusters = result.bfi.fragmented_clusters; 703 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0; 704 check->compressed_clusters = result.bfi.compressed_clusters; 705 check->has_compressed_clusters = result.bfi.compressed_clusters != 0; 706 707 return 0; 708 } 709 710 /* 711 * Checks an image for consistency. Exit codes: 712 * 713 * 0 - Check completed, image is good 714 * 1 - Check not completed because of internal errors 715 * 2 - Check completed, image is corrupted 716 * 3 - Check completed, image has leaked clusters, but is good otherwise 717 * 63 - Checks are not supported by the image format 718 */ 719 static int img_check(int argc, char **argv) 720 { 721 int c, ret; 722 OutputFormat output_format = OFORMAT_HUMAN; 723 const char *filename, *fmt, *output, *cache; 724 BlockBackend *blk; 725 BlockDriverState *bs; 726 int fix = 0; 727 int flags = BDRV_O_CHECK; 728 bool writethrough; 729 ImageCheck *check; 730 bool quiet = false; 731 bool image_opts = false; 732 bool force_share = false; 733 734 fmt = NULL; 735 output = NULL; 736 cache = BDRV_DEFAULT_CACHE; 737 738 for(;;) { 739 int option_index = 0; 740 static const struct option long_options[] = { 741 {"help", no_argument, 0, 'h'}, 742 {"format", required_argument, 0, 'f'}, 743 {"repair", required_argument, 0, 'r'}, 744 {"output", required_argument, 0, OPTION_OUTPUT}, 745 {"object", required_argument, 0, OPTION_OBJECT}, 746 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 747 {"force-share", no_argument, 0, 'U'}, 748 {0, 0, 0, 0} 749 }; 750 c = getopt_long(argc, argv, ":hf:r:T:qU", 751 long_options, &option_index); 752 if (c == -1) { 753 break; 754 } 755 switch(c) { 756 case ':': 757 missing_argument(argv[optind - 1]); 758 break; 759 case '?': 760 unrecognized_option(argv[optind - 1]); 761 break; 762 case 'h': 763 help(); 764 break; 765 case 'f': 766 fmt = optarg; 767 break; 768 case 'r': 769 flags |= BDRV_O_RDWR; 770 771 if (!strcmp(optarg, "leaks")) { 772 fix = BDRV_FIX_LEAKS; 773 } else if (!strcmp(optarg, "all")) { 774 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS; 775 } else { 776 error_exit("Unknown option value for -r " 777 "(expecting 'leaks' or 'all'): %s", optarg); 778 } 779 break; 780 case OPTION_OUTPUT: 781 output = optarg; 782 break; 783 case 'T': 784 cache = optarg; 785 break; 786 case 'q': 787 quiet = true; 788 break; 789 case 'U': 790 force_share = true; 791 break; 792 case OPTION_OBJECT: 793 user_creatable_process_cmdline(optarg); 794 break; 795 case OPTION_IMAGE_OPTS: 796 image_opts = true; 797 break; 798 } 799 } 800 if (optind != argc - 1) { 801 error_exit("Expecting one image file name"); 802 } 803 filename = argv[optind++]; 804 805 if (output && !strcmp(output, "json")) { 806 output_format = OFORMAT_JSON; 807 } else if (output && !strcmp(output, "human")) { 808 output_format = OFORMAT_HUMAN; 809 } else if (output) { 810 error_report("--output must be used with human or json as argument."); 811 return 1; 812 } 813 814 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough); 815 if (ret < 0) { 816 error_report("Invalid source cache option: %s", cache); 817 return 1; 818 } 819 820 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet, 821 force_share); 822 if (!blk) { 823 return 1; 824 } 825 bs = blk_bs(blk); 826 827 check = g_new0(ImageCheck, 1); 828 ret = collect_image_check(bs, check, filename, fmt, fix); 829 830 if (ret == -ENOTSUP) { 831 error_report("This image format does not support checks"); 832 ret = 63; 833 goto fail; 834 } 835 836 if (check->corruptions_fixed || check->leaks_fixed) { 837 int corruptions_fixed, leaks_fixed; 838 bool has_leaks_fixed, has_corruptions_fixed; 839 840 leaks_fixed = check->leaks_fixed; 841 has_leaks_fixed = check->has_leaks_fixed; 842 corruptions_fixed = check->corruptions_fixed; 843 has_corruptions_fixed = check->has_corruptions_fixed; 844 845 if (output_format == OFORMAT_HUMAN) { 846 qprintf(quiet, 847 "The following inconsistencies were found and repaired:\n\n" 848 " %" PRId64 " leaked clusters\n" 849 " %" PRId64 " corruptions\n\n" 850 "Double checking the fixed image now...\n", 851 check->leaks_fixed, 852 check->corruptions_fixed); 853 } 854 855 qapi_free_ImageCheck(check); 856 check = g_new0(ImageCheck, 1); 857 ret = collect_image_check(bs, check, filename, fmt, 0); 858 859 check->leaks_fixed = leaks_fixed; 860 check->has_leaks_fixed = has_leaks_fixed; 861 check->corruptions_fixed = corruptions_fixed; 862 check->has_corruptions_fixed = has_corruptions_fixed; 863 } 864 865 if (!ret) { 866 switch (output_format) { 867 case OFORMAT_HUMAN: 868 dump_human_image_check(check, quiet); 869 break; 870 case OFORMAT_JSON: 871 dump_json_image_check(check, quiet); 872 break; 873 } 874 } 875 876 if (ret || check->check_errors) { 877 if (ret) { 878 error_report("Check failed: %s", strerror(-ret)); 879 } else { 880 error_report("Check failed"); 881 } 882 ret = 1; 883 goto fail; 884 } 885 886 if (check->corruptions) { 887 ret = 2; 888 } else if (check->leaks) { 889 ret = 3; 890 } else { 891 ret = 0; 892 } 893 894 fail: 895 qapi_free_ImageCheck(check); 896 blk_unref(blk); 897 return ret; 898 } 899 900 typedef struct CommonBlockJobCBInfo { 901 BlockDriverState *bs; 902 Error **errp; 903 } CommonBlockJobCBInfo; 904 905 static void common_block_job_cb(void *opaque, int ret) 906 { 907 CommonBlockJobCBInfo *cbi = opaque; 908 909 if (ret < 0) { 910 error_setg_errno(cbi->errp, -ret, "Block job failed"); 911 } 912 } 913 914 static void run_block_job(BlockJob *job, Error **errp) 915 { 916 uint64_t progress_current, progress_total; 917 AioContext *aio_context = block_job_get_aio_context(job); 918 int ret = 0; 919 920 job_lock(); 921 job_ref_locked(&job->job); 922 do { 923 float progress = 0.0f; 924 job_unlock(); 925 aio_poll(aio_context, true); 926 927 progress_get_snapshot(&job->job.progress, &progress_current, 928 &progress_total); 929 if (progress_total) { 930 progress = (float)progress_current / progress_total * 100.f; 931 } 932 qemu_progress_print(progress, 0); 933 job_lock(); 934 } while (!job_is_ready_locked(&job->job) && 935 !job_is_completed_locked(&job->job)); 936 937 if (!job_is_completed_locked(&job->job)) { 938 ret = job_complete_sync_locked(&job->job, errp); 939 } else { 940 ret = job->job.ret; 941 } 942 job_unref_locked(&job->job); 943 job_unlock(); 944 945 /* publish completion progress only when success */ 946 if (!ret) { 947 qemu_progress_print(100.f, 0); 948 } 949 } 950 951 static int img_commit(int argc, char **argv) 952 { 953 int c, ret, flags; 954 const char *filename, *fmt, *cache, *base; 955 BlockBackend *blk; 956 BlockDriverState *bs, *base_bs; 957 BlockJob *job; 958 bool progress = false, quiet = false, drop = false; 959 bool writethrough; 960 Error *local_err = NULL; 961 CommonBlockJobCBInfo cbi; 962 bool image_opts = false; 963 AioContext *aio_context; 964 int64_t rate_limit = 0; 965 966 fmt = NULL; 967 cache = BDRV_DEFAULT_CACHE; 968 base = NULL; 969 for(;;) { 970 static const struct option long_options[] = { 971 {"help", no_argument, 0, 'h'}, 972 {"object", required_argument, 0, OPTION_OBJECT}, 973 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 974 {0, 0, 0, 0} 975 }; 976 c = getopt_long(argc, argv, ":f:ht:b:dpqr:", 977 long_options, NULL); 978 if (c == -1) { 979 break; 980 } 981 switch(c) { 982 case ':': 983 missing_argument(argv[optind - 1]); 984 break; 985 case '?': 986 unrecognized_option(argv[optind - 1]); 987 break; 988 case 'h': 989 help(); 990 break; 991 case 'f': 992 fmt = optarg; 993 break; 994 case 't': 995 cache = optarg; 996 break; 997 case 'b': 998 base = optarg; 999 /* -b implies -d */ 1000 drop = true; 1001 break; 1002 case 'd': 1003 drop = true; 1004 break; 1005 case 'p': 1006 progress = true; 1007 break; 1008 case 'q': 1009 quiet = true; 1010 break; 1011 case 'r': 1012 rate_limit = cvtnum("rate limit", optarg); 1013 if (rate_limit < 0) { 1014 return 1; 1015 } 1016 break; 1017 case OPTION_OBJECT: 1018 user_creatable_process_cmdline(optarg); 1019 break; 1020 case OPTION_IMAGE_OPTS: 1021 image_opts = true; 1022 break; 1023 } 1024 } 1025 1026 /* Progress is not shown in Quiet mode */ 1027 if (quiet) { 1028 progress = false; 1029 } 1030 1031 if (optind != argc - 1) { 1032 error_exit("Expecting one image file name"); 1033 } 1034 filename = argv[optind++]; 1035 1036 flags = BDRV_O_RDWR | BDRV_O_UNMAP; 1037 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough); 1038 if (ret < 0) { 1039 error_report("Invalid cache option: %s", cache); 1040 return 1; 1041 } 1042 1043 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet, 1044 false); 1045 if (!blk) { 1046 return 1; 1047 } 1048 bs = blk_bs(blk); 1049 1050 qemu_progress_init(progress, 1.f); 1051 qemu_progress_print(0.f, 100); 1052 1053 if (base) { 1054 base_bs = bdrv_find_backing_image(bs, base); 1055 if (!base_bs) { 1056 error_setg(&local_err, 1057 "Did not find '%s' in the backing chain of '%s'", 1058 base, filename); 1059 goto done; 1060 } 1061 } else { 1062 /* This is different from QMP, which by default uses the deepest file in 1063 * the backing chain (i.e., the very base); however, the traditional 1064 * behavior of qemu-img commit is using the immediate backing file. */ 1065 base_bs = bdrv_backing_chain_next(bs); 1066 if (!base_bs) { 1067 error_setg(&local_err, "Image does not have a backing file"); 1068 goto done; 1069 } 1070 } 1071 1072 cbi = (CommonBlockJobCBInfo){ 1073 .errp = &local_err, 1074 .bs = bs, 1075 }; 1076 1077 aio_context = bdrv_get_aio_context(bs); 1078 aio_context_acquire(aio_context); 1079 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit, 1080 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb, 1081 &cbi, false, &local_err); 1082 aio_context_release(aio_context); 1083 if (local_err) { 1084 goto done; 1085 } 1086 1087 /* When the block job completes, the BlockBackend reference will point to 1088 * the old backing file. In order to avoid that the top image is already 1089 * deleted, so we can still empty it afterwards, increment the reference 1090 * counter here preemptively. */ 1091 if (!drop) { 1092 bdrv_ref(bs); 1093 } 1094 1095 job = block_job_get("commit"); 1096 assert(job); 1097 run_block_job(job, &local_err); 1098 if (local_err) { 1099 goto unref_backing; 1100 } 1101 1102 if (!drop) { 1103 BlockBackend *old_backing_blk; 1104 1105 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL, 1106 &local_err); 1107 if (!old_backing_blk) { 1108 goto unref_backing; 1109 } 1110 ret = blk_make_empty(old_backing_blk, &local_err); 1111 blk_unref(old_backing_blk); 1112 if (ret == -ENOTSUP) { 1113 error_free(local_err); 1114 local_err = NULL; 1115 } else if (ret < 0) { 1116 goto unref_backing; 1117 } 1118 } 1119 1120 unref_backing: 1121 if (!drop) { 1122 bdrv_unref(bs); 1123 } 1124 1125 done: 1126 qemu_progress_end(); 1127 1128 /* 1129 * Manually inactivate the image first because this way we can know whether 1130 * an error occurred. blk_unref() doesn't tell us about failures. 1131 */ 1132 ret = bdrv_inactivate_all(); 1133 if (ret < 0 && !local_err) { 1134 error_setg_errno(&local_err, -ret, "Error while closing the image"); 1135 } 1136 blk_unref(blk); 1137 1138 if (local_err) { 1139 error_report_err(local_err); 1140 return 1; 1141 } 1142 1143 qprintf(quiet, "Image committed.\n"); 1144 return 0; 1145 } 1146 1147 /* 1148 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index 1149 * of the first sector boundary within buf where the sector contains a 1150 * non-zero byte. This function is robust to a buffer that is not 1151 * sector-aligned. 1152 */ 1153 static int64_t find_nonzero(const uint8_t *buf, int64_t n) 1154 { 1155 int64_t i; 1156 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE); 1157 1158 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) { 1159 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) { 1160 return i; 1161 } 1162 } 1163 if (i < n && !buffer_is_zero(buf + i, n - end)) { 1164 return i; 1165 } 1166 return -1; 1167 } 1168 1169 /* 1170 * Returns true iff the first sector pointed to by 'buf' contains at least 1171 * a non-NUL byte. 1172 * 1173 * 'pnum' is set to the number of sectors (including and immediately following 1174 * the first one) that are known to be in the same allocated/unallocated state. 1175 * The function will try to align the end offset to alignment boundaries so 1176 * that the request will at least end aligned and consecutive requests will 1177 * also start at an aligned offset. 1178 */ 1179 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum, 1180 int64_t sector_num, int alignment) 1181 { 1182 bool is_zero; 1183 int i, tail; 1184 1185 if (n <= 0) { 1186 *pnum = 0; 1187 return 0; 1188 } 1189 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE); 1190 for(i = 1; i < n; i++) { 1191 buf += BDRV_SECTOR_SIZE; 1192 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) { 1193 break; 1194 } 1195 } 1196 1197 if (i == n) { 1198 /* 1199 * The whole buf is the same. 1200 * No reason to split it into chunks, so return now. 1201 */ 1202 *pnum = i; 1203 return !is_zero; 1204 } 1205 1206 tail = (sector_num + i) & (alignment - 1); 1207 if (tail) { 1208 if (is_zero && i <= tail) { 1209 /* 1210 * For sure next sector after i is data, and it will rewrite this 1211 * tail anyway due to RMW. So, let's just write data now. 1212 */ 1213 is_zero = false; 1214 } 1215 if (!is_zero) { 1216 /* If possible, align up end offset of allocated areas. */ 1217 i += alignment - tail; 1218 i = MIN(i, n); 1219 } else { 1220 /* 1221 * For sure next sector after i is data, and it will rewrite this 1222 * tail anyway due to RMW. Better is avoid RMW and write zeroes up 1223 * to aligned bound. 1224 */ 1225 i -= tail; 1226 } 1227 } 1228 *pnum = i; 1229 return !is_zero; 1230 } 1231 1232 /* 1233 * Like is_allocated_sectors, but if the buffer starts with a used sector, 1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids 1235 * breaking up write requests for only small sparse areas. 1236 */ 1237 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum, 1238 int min, int64_t sector_num, int alignment) 1239 { 1240 int ret; 1241 int num_checked, num_used; 1242 1243 if (n < min) { 1244 min = n; 1245 } 1246 1247 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment); 1248 if (!ret) { 1249 return ret; 1250 } 1251 1252 num_used = *pnum; 1253 buf += BDRV_SECTOR_SIZE * *pnum; 1254 n -= *pnum; 1255 sector_num += *pnum; 1256 num_checked = num_used; 1257 1258 while (n > 0) { 1259 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment); 1260 1261 buf += BDRV_SECTOR_SIZE * *pnum; 1262 n -= *pnum; 1263 sector_num += *pnum; 1264 num_checked += *pnum; 1265 if (ret) { 1266 num_used = num_checked; 1267 } else if (*pnum >= min) { 1268 break; 1269 } 1270 } 1271 1272 *pnum = num_used; 1273 return 1; 1274 } 1275 1276 /* 1277 * Compares two buffers sector by sector. Returns 0 if the first 1278 * sector of each buffer matches, non-zero otherwise. 1279 * 1280 * pnum is set to the sector-aligned size of the buffer prefix that 1281 * has the same matching status as the first sector. 1282 */ 1283 static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2, 1284 int64_t bytes, int64_t *pnum) 1285 { 1286 bool res; 1287 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE); 1288 1289 assert(bytes > 0); 1290 1291 res = !!memcmp(buf1, buf2, i); 1292 while (i < bytes) { 1293 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE); 1294 1295 if (!!memcmp(buf1 + i, buf2 + i, len) != res) { 1296 break; 1297 } 1298 i += len; 1299 } 1300 1301 *pnum = i; 1302 return res; 1303 } 1304 1305 #define IO_BUF_SIZE (2 * MiB) 1306 1307 /* 1308 * Check if passed sectors are empty (not allocated or contain only 0 bytes) 1309 * 1310 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are 1311 * filled with 0, 1 if sectors contain non-zero data (this is a comparison 1312 * failure), and 4 on error (the exit status for read errors), after emitting 1313 * an error message. 1314 * 1315 * @param blk: BlockBackend for the image 1316 * @param offset: Starting offset to check 1317 * @param bytes: Number of bytes to check 1318 * @param filename: Name of disk file we are checking (logging purpose) 1319 * @param buffer: Allocated buffer for storing read data 1320 * @param quiet: Flag for quiet mode 1321 */ 1322 static int check_empty_sectors(BlockBackend *blk, int64_t offset, 1323 int64_t bytes, const char *filename, 1324 uint8_t *buffer, bool quiet) 1325 { 1326 int ret = 0; 1327 int64_t idx; 1328 1329 ret = blk_pread(blk, offset, bytes, buffer, 0); 1330 if (ret < 0) { 1331 error_report("Error while reading offset %" PRId64 " of %s: %s", 1332 offset, filename, strerror(-ret)); 1333 return 4; 1334 } 1335 idx = find_nonzero(buffer, bytes); 1336 if (idx >= 0) { 1337 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n", 1338 offset + idx); 1339 return 1; 1340 } 1341 1342 return 0; 1343 } 1344 1345 /* 1346 * Compares two images. Exit codes: 1347 * 1348 * 0 - Images are identical or the requested help was printed 1349 * 1 - Images differ 1350 * >1 - Error occurred 1351 */ 1352 static int img_compare(int argc, char **argv) 1353 { 1354 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2; 1355 BlockBackend *blk1, *blk2; 1356 BlockDriverState *bs1, *bs2; 1357 int64_t total_size1, total_size2; 1358 uint8_t *buf1 = NULL, *buf2 = NULL; 1359 int64_t pnum1, pnum2; 1360 int allocated1, allocated2; 1361 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */ 1362 bool progress = false, quiet = false, strict = false; 1363 int flags; 1364 bool writethrough; 1365 int64_t total_size; 1366 int64_t offset = 0; 1367 int64_t chunk; 1368 int c; 1369 uint64_t progress_base; 1370 bool image_opts = false; 1371 bool force_share = false; 1372 1373 cache = BDRV_DEFAULT_CACHE; 1374 for (;;) { 1375 static const struct option long_options[] = { 1376 {"help", no_argument, 0, 'h'}, 1377 {"object", required_argument, 0, OPTION_OBJECT}, 1378 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 1379 {"force-share", no_argument, 0, 'U'}, 1380 {0, 0, 0, 0} 1381 }; 1382 c = getopt_long(argc, argv, ":hf:F:T:pqsU", 1383 long_options, NULL); 1384 if (c == -1) { 1385 break; 1386 } 1387 switch (c) { 1388 case ':': 1389 missing_argument(argv[optind - 1]); 1390 break; 1391 case '?': 1392 unrecognized_option(argv[optind - 1]); 1393 break; 1394 case 'h': 1395 help(); 1396 break; 1397 case 'f': 1398 fmt1 = optarg; 1399 break; 1400 case 'F': 1401 fmt2 = optarg; 1402 break; 1403 case 'T': 1404 cache = optarg; 1405 break; 1406 case 'p': 1407 progress = true; 1408 break; 1409 case 'q': 1410 quiet = true; 1411 break; 1412 case 's': 1413 strict = true; 1414 break; 1415 case 'U': 1416 force_share = true; 1417 break; 1418 case OPTION_OBJECT: 1419 { 1420 Error *local_err = NULL; 1421 1422 if (!user_creatable_add_from_str(optarg, &local_err)) { 1423 if (local_err) { 1424 error_report_err(local_err); 1425 exit(2); 1426 } else { 1427 /* Help was printed */ 1428 exit(EXIT_SUCCESS); 1429 } 1430 } 1431 break; 1432 } 1433 case OPTION_IMAGE_OPTS: 1434 image_opts = true; 1435 break; 1436 } 1437 } 1438 1439 /* Progress is not shown in Quiet mode */ 1440 if (quiet) { 1441 progress = false; 1442 } 1443 1444 1445 if (optind != argc - 2) { 1446 error_exit("Expecting two image file names"); 1447 } 1448 filename1 = argv[optind++]; 1449 filename2 = argv[optind++]; 1450 1451 /* Initialize before goto out */ 1452 qemu_progress_init(progress, 2.0); 1453 1454 flags = 0; 1455 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough); 1456 if (ret < 0) { 1457 error_report("Invalid source cache option: %s", cache); 1458 ret = 2; 1459 goto out3; 1460 } 1461 1462 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet, 1463 force_share); 1464 if (!blk1) { 1465 ret = 2; 1466 goto out3; 1467 } 1468 1469 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet, 1470 force_share); 1471 if (!blk2) { 1472 ret = 2; 1473 goto out2; 1474 } 1475 bs1 = blk_bs(blk1); 1476 bs2 = blk_bs(blk2); 1477 1478 buf1 = blk_blockalign(blk1, IO_BUF_SIZE); 1479 buf2 = blk_blockalign(blk2, IO_BUF_SIZE); 1480 total_size1 = blk_getlength(blk1); 1481 if (total_size1 < 0) { 1482 error_report("Can't get size of %s: %s", 1483 filename1, strerror(-total_size1)); 1484 ret = 4; 1485 goto out; 1486 } 1487 total_size2 = blk_getlength(blk2); 1488 if (total_size2 < 0) { 1489 error_report("Can't get size of %s: %s", 1490 filename2, strerror(-total_size2)); 1491 ret = 4; 1492 goto out; 1493 } 1494 total_size = MIN(total_size1, total_size2); 1495 progress_base = MAX(total_size1, total_size2); 1496 1497 qemu_progress_print(0, 100); 1498 1499 if (strict && total_size1 != total_size2) { 1500 ret = 1; 1501 qprintf(quiet, "Strict mode: Image size mismatch!\n"); 1502 goto out; 1503 } 1504 1505 while (offset < total_size) { 1506 int status1, status2; 1507 1508 status1 = bdrv_block_status_above(bs1, NULL, offset, 1509 total_size1 - offset, &pnum1, NULL, 1510 NULL); 1511 if (status1 < 0) { 1512 ret = 3; 1513 error_report("Sector allocation test failed for %s", filename1); 1514 goto out; 1515 } 1516 allocated1 = status1 & BDRV_BLOCK_ALLOCATED; 1517 1518 status2 = bdrv_block_status_above(bs2, NULL, offset, 1519 total_size2 - offset, &pnum2, NULL, 1520 NULL); 1521 if (status2 < 0) { 1522 ret = 3; 1523 error_report("Sector allocation test failed for %s", filename2); 1524 goto out; 1525 } 1526 allocated2 = status2 & BDRV_BLOCK_ALLOCATED; 1527 1528 assert(pnum1 && pnum2); 1529 chunk = MIN(pnum1, pnum2); 1530 1531 if (strict) { 1532 if (status1 != status2) { 1533 ret = 1; 1534 qprintf(quiet, "Strict mode: Offset %" PRId64 1535 " block status mismatch!\n", offset); 1536 goto out; 1537 } 1538 } 1539 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) { 1540 /* nothing to do */ 1541 } else if (allocated1 == allocated2) { 1542 if (allocated1) { 1543 int64_t pnum; 1544 1545 chunk = MIN(chunk, IO_BUF_SIZE); 1546 ret = blk_pread(blk1, offset, chunk, buf1, 0); 1547 if (ret < 0) { 1548 error_report("Error while reading offset %" PRId64 1549 " of %s: %s", 1550 offset, filename1, strerror(-ret)); 1551 ret = 4; 1552 goto out; 1553 } 1554 ret = blk_pread(blk2, offset, chunk, buf2, 0); 1555 if (ret < 0) { 1556 error_report("Error while reading offset %" PRId64 1557 " of %s: %s", 1558 offset, filename2, strerror(-ret)); 1559 ret = 4; 1560 goto out; 1561 } 1562 ret = compare_buffers(buf1, buf2, chunk, &pnum); 1563 if (ret || pnum != chunk) { 1564 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n", 1565 offset + (ret ? 0 : pnum)); 1566 ret = 1; 1567 goto out; 1568 } 1569 } 1570 } else { 1571 chunk = MIN(chunk, IO_BUF_SIZE); 1572 if (allocated1) { 1573 ret = check_empty_sectors(blk1, offset, chunk, 1574 filename1, buf1, quiet); 1575 } else { 1576 ret = check_empty_sectors(blk2, offset, chunk, 1577 filename2, buf1, quiet); 1578 } 1579 if (ret) { 1580 goto out; 1581 } 1582 } 1583 offset += chunk; 1584 qemu_progress_print(((float) chunk / progress_base) * 100, 100); 1585 } 1586 1587 if (total_size1 != total_size2) { 1588 BlockBackend *blk_over; 1589 const char *filename_over; 1590 1591 qprintf(quiet, "Warning: Image size mismatch!\n"); 1592 if (total_size1 > total_size2) { 1593 blk_over = blk1; 1594 filename_over = filename1; 1595 } else { 1596 blk_over = blk2; 1597 filename_over = filename2; 1598 } 1599 1600 while (offset < progress_base) { 1601 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset, 1602 progress_base - offset, &chunk, 1603 NULL, NULL); 1604 if (ret < 0) { 1605 ret = 3; 1606 error_report("Sector allocation test failed for %s", 1607 filename_over); 1608 goto out; 1609 1610 } 1611 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) { 1612 chunk = MIN(chunk, IO_BUF_SIZE); 1613 ret = check_empty_sectors(blk_over, offset, chunk, 1614 filename_over, buf1, quiet); 1615 if (ret) { 1616 goto out; 1617 } 1618 } 1619 offset += chunk; 1620 qemu_progress_print(((float) chunk / progress_base) * 100, 100); 1621 } 1622 } 1623 1624 qprintf(quiet, "Images are identical.\n"); 1625 ret = 0; 1626 1627 out: 1628 qemu_vfree(buf1); 1629 qemu_vfree(buf2); 1630 blk_unref(blk2); 1631 out2: 1632 blk_unref(blk1); 1633 out3: 1634 qemu_progress_end(); 1635 return ret; 1636 } 1637 1638 /* Convenience wrapper around qmp_block_dirty_bitmap_merge */ 1639 static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name, 1640 const char *src_node, const char *src_name, 1641 Error **errp) 1642 { 1643 BlockDirtyBitmapOrStr *merge_src; 1644 BlockDirtyBitmapOrStrList *list = NULL; 1645 1646 merge_src = g_new0(BlockDirtyBitmapOrStr, 1); 1647 merge_src->type = QTYPE_QDICT; 1648 merge_src->u.external.node = g_strdup(src_node); 1649 merge_src->u.external.name = g_strdup(src_name); 1650 QAPI_LIST_PREPEND(list, merge_src); 1651 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp); 1652 qapi_free_BlockDirtyBitmapOrStrList(list); 1653 } 1654 1655 enum ImgConvertBlockStatus { 1656 BLK_DATA, 1657 BLK_ZERO, 1658 BLK_BACKING_FILE, 1659 }; 1660 1661 #define MAX_COROUTINES 16 1662 #define CONVERT_THROTTLE_GROUP "img_convert" 1663 1664 typedef struct ImgConvertState { 1665 BlockBackend **src; 1666 int64_t *src_sectors; 1667 int *src_alignment; 1668 int src_num; 1669 int64_t total_sectors; 1670 int64_t allocated_sectors; 1671 int64_t allocated_done; 1672 int64_t sector_num; 1673 int64_t wr_offs; 1674 enum ImgConvertBlockStatus status; 1675 int64_t sector_next_status; 1676 BlockBackend *target; 1677 bool has_zero_init; 1678 bool compressed; 1679 bool target_is_new; 1680 bool target_has_backing; 1681 int64_t target_backing_sectors; /* negative if unknown */ 1682 bool wr_in_order; 1683 bool copy_range; 1684 bool salvage; 1685 bool quiet; 1686 int min_sparse; 1687 int alignment; 1688 size_t cluster_sectors; 1689 size_t buf_sectors; 1690 long num_coroutines; 1691 int running_coroutines; 1692 Coroutine *co[MAX_COROUTINES]; 1693 int64_t wait_sector_num[MAX_COROUTINES]; 1694 CoMutex lock; 1695 int ret; 1696 } ImgConvertState; 1697 1698 static void convert_select_part(ImgConvertState *s, int64_t sector_num, 1699 int *src_cur, int64_t *src_cur_offset) 1700 { 1701 *src_cur = 0; 1702 *src_cur_offset = 0; 1703 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) { 1704 *src_cur_offset += s->src_sectors[*src_cur]; 1705 (*src_cur)++; 1706 assert(*src_cur < s->src_num); 1707 } 1708 } 1709 1710 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num) 1711 { 1712 int64_t src_cur_offset; 1713 int ret, n, src_cur; 1714 bool post_backing_zero = false; 1715 1716 convert_select_part(s, sector_num, &src_cur, &src_cur_offset); 1717 1718 assert(s->total_sectors > sector_num); 1719 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS); 1720 1721 if (s->target_backing_sectors >= 0) { 1722 if (sector_num >= s->target_backing_sectors) { 1723 post_backing_zero = true; 1724 } else if (sector_num + n > s->target_backing_sectors) { 1725 /* Split requests around target_backing_sectors (because 1726 * starting from there, zeros are handled differently) */ 1727 n = s->target_backing_sectors - sector_num; 1728 } 1729 } 1730 1731 if (s->sector_next_status <= sector_num) { 1732 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE; 1733 int64_t count; 1734 int tail; 1735 BlockDriverState *src_bs = blk_bs(s->src[src_cur]); 1736 BlockDriverState *base; 1737 1738 if (s->target_has_backing) { 1739 base = bdrv_cow_bs(bdrv_skip_filters(src_bs)); 1740 } else { 1741 base = NULL; 1742 } 1743 1744 do { 1745 count = n * BDRV_SECTOR_SIZE; 1746 1747 ret = bdrv_block_status_above(src_bs, base, offset, count, &count, 1748 NULL, NULL); 1749 1750 if (ret < 0) { 1751 if (s->salvage) { 1752 if (n == 1) { 1753 if (!s->quiet) { 1754 warn_report("error while reading block status at " 1755 "offset %" PRIu64 ": %s", offset, 1756 strerror(-ret)); 1757 } 1758 /* Just try to read the data, then */ 1759 ret = BDRV_BLOCK_DATA; 1760 count = BDRV_SECTOR_SIZE; 1761 } else { 1762 /* Retry on a shorter range */ 1763 n = DIV_ROUND_UP(n, 4); 1764 } 1765 } else { 1766 error_report("error while reading block status at offset " 1767 "%" PRIu64 ": %s", offset, strerror(-ret)); 1768 return ret; 1769 } 1770 } 1771 } while (ret < 0); 1772 1773 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE); 1774 1775 /* 1776 * Avoid that s->sector_next_status becomes unaligned to the source 1777 * request alignment and/or cluster size to avoid unnecessary read 1778 * cycles. 1779 */ 1780 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur]; 1781 if (n > tail) { 1782 n -= tail; 1783 } 1784 1785 if (ret & BDRV_BLOCK_ZERO) { 1786 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO; 1787 } else if (ret & BDRV_BLOCK_DATA) { 1788 s->status = BLK_DATA; 1789 } else { 1790 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA; 1791 } 1792 1793 s->sector_next_status = sector_num + n; 1794 } 1795 1796 n = MIN(n, s->sector_next_status - sector_num); 1797 if (s->status == BLK_DATA) { 1798 n = MIN(n, s->buf_sectors); 1799 } 1800 1801 /* We need to write complete clusters for compressed images, so if an 1802 * unallocated area is shorter than that, we must consider the whole 1803 * cluster allocated. */ 1804 if (s->compressed) { 1805 if (n < s->cluster_sectors) { 1806 n = MIN(s->cluster_sectors, s->total_sectors - sector_num); 1807 s->status = BLK_DATA; 1808 } else { 1809 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors); 1810 } 1811 } 1812 1813 return n; 1814 } 1815 1816 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num, 1817 int nb_sectors, uint8_t *buf) 1818 { 1819 uint64_t single_read_until = 0; 1820 int n, ret; 1821 1822 assert(nb_sectors <= s->buf_sectors); 1823 while (nb_sectors > 0) { 1824 BlockBackend *blk; 1825 int src_cur; 1826 int64_t bs_sectors, src_cur_offset; 1827 uint64_t offset; 1828 1829 /* In the case of compression with multiple source files, we can get a 1830 * nb_sectors that spreads into the next part. So we must be able to 1831 * read across multiple BDSes for one convert_read() call. */ 1832 convert_select_part(s, sector_num, &src_cur, &src_cur_offset); 1833 blk = s->src[src_cur]; 1834 bs_sectors = s->src_sectors[src_cur]; 1835 1836 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS; 1837 1838 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset)); 1839 if (single_read_until > offset) { 1840 n = 1; 1841 } 1842 1843 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0); 1844 if (ret < 0) { 1845 if (s->salvage) { 1846 if (n > 1) { 1847 single_read_until = offset + (n << BDRV_SECTOR_BITS); 1848 continue; 1849 } else { 1850 if (!s->quiet) { 1851 warn_report("error while reading offset %" PRIu64 1852 ": %s", offset, strerror(-ret)); 1853 } 1854 memset(buf, 0, BDRV_SECTOR_SIZE); 1855 } 1856 } else { 1857 return ret; 1858 } 1859 } 1860 1861 sector_num += n; 1862 nb_sectors -= n; 1863 buf += n * BDRV_SECTOR_SIZE; 1864 } 1865 1866 return 0; 1867 } 1868 1869 1870 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num, 1871 int nb_sectors, uint8_t *buf, 1872 enum ImgConvertBlockStatus status) 1873 { 1874 int ret; 1875 1876 while (nb_sectors > 0) { 1877 int n = nb_sectors; 1878 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0; 1879 1880 switch (status) { 1881 case BLK_BACKING_FILE: 1882 /* If we have a backing file, leave clusters unallocated that are 1883 * unallocated in the source image, so that the backing file is 1884 * visible at the respective offset. */ 1885 assert(s->target_has_backing); 1886 break; 1887 1888 case BLK_DATA: 1889 /* If we're told to keep the target fully allocated (-S 0) or there 1890 * is real non-zero data, we must write it. Otherwise we can treat 1891 * it as zero sectors. 1892 * Compressed clusters need to be written as a whole, so in that 1893 * case we can only save the write if the buffer is completely 1894 * zeroed. */ 1895 if (!s->min_sparse || 1896 (!s->compressed && 1897 is_allocated_sectors_min(buf, n, &n, s->min_sparse, 1898 sector_num, s->alignment)) || 1899 (s->compressed && 1900 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))) 1901 { 1902 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS, 1903 n << BDRV_SECTOR_BITS, buf, flags); 1904 if (ret < 0) { 1905 return ret; 1906 } 1907 break; 1908 } 1909 /* fall-through */ 1910 1911 case BLK_ZERO: 1912 if (s->has_zero_init) { 1913 assert(!s->target_has_backing); 1914 break; 1915 } 1916 ret = blk_co_pwrite_zeroes(s->target, 1917 sector_num << BDRV_SECTOR_BITS, 1918 n << BDRV_SECTOR_BITS, 1919 BDRV_REQ_MAY_UNMAP); 1920 if (ret < 0) { 1921 return ret; 1922 } 1923 break; 1924 } 1925 1926 sector_num += n; 1927 nb_sectors -= n; 1928 buf += n * BDRV_SECTOR_SIZE; 1929 } 1930 1931 return 0; 1932 } 1933 1934 static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num, 1935 int nb_sectors) 1936 { 1937 int n, ret; 1938 1939 while (nb_sectors > 0) { 1940 BlockBackend *blk; 1941 int src_cur; 1942 int64_t bs_sectors, src_cur_offset; 1943 int64_t offset; 1944 1945 convert_select_part(s, sector_num, &src_cur, &src_cur_offset); 1946 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS; 1947 blk = s->src[src_cur]; 1948 bs_sectors = s->src_sectors[src_cur]; 1949 1950 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset)); 1951 1952 ret = blk_co_copy_range(blk, offset, s->target, 1953 sector_num << BDRV_SECTOR_BITS, 1954 n << BDRV_SECTOR_BITS, 0, 0); 1955 if (ret < 0) { 1956 return ret; 1957 } 1958 1959 sector_num += n; 1960 nb_sectors -= n; 1961 } 1962 return 0; 1963 } 1964 1965 static void coroutine_fn convert_co_do_copy(void *opaque) 1966 { 1967 ImgConvertState *s = opaque; 1968 uint8_t *buf = NULL; 1969 int ret, i; 1970 int index = -1; 1971 1972 for (i = 0; i < s->num_coroutines; i++) { 1973 if (s->co[i] == qemu_coroutine_self()) { 1974 index = i; 1975 break; 1976 } 1977 } 1978 assert(index >= 0); 1979 1980 s->running_coroutines++; 1981 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE); 1982 1983 while (1) { 1984 int n; 1985 int64_t sector_num; 1986 enum ImgConvertBlockStatus status; 1987 bool copy_range; 1988 1989 qemu_co_mutex_lock(&s->lock); 1990 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) { 1991 qemu_co_mutex_unlock(&s->lock); 1992 break; 1993 } 1994 WITH_GRAPH_RDLOCK_GUARD() { 1995 n = convert_iteration_sectors(s, s->sector_num); 1996 } 1997 if (n < 0) { 1998 qemu_co_mutex_unlock(&s->lock); 1999 s->ret = n; 2000 break; 2001 } 2002 /* save current sector and allocation status to local variables */ 2003 sector_num = s->sector_num; 2004 status = s->status; 2005 if (!s->min_sparse && s->status == BLK_ZERO) { 2006 n = MIN(n, s->buf_sectors); 2007 } 2008 /* increment global sector counter so that other coroutines can 2009 * already continue reading beyond this request */ 2010 s->sector_num += n; 2011 qemu_co_mutex_unlock(&s->lock); 2012 2013 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) { 2014 s->allocated_done += n; 2015 qemu_progress_print(100.0 * s->allocated_done / 2016 s->allocated_sectors, 0); 2017 } 2018 2019 retry: 2020 copy_range = s->copy_range && s->status == BLK_DATA; 2021 if (status == BLK_DATA && !copy_range) { 2022 ret = convert_co_read(s, sector_num, n, buf); 2023 if (ret < 0) { 2024 error_report("error while reading at byte %lld: %s", 2025 sector_num * BDRV_SECTOR_SIZE, strerror(-ret)); 2026 s->ret = ret; 2027 } 2028 } else if (!s->min_sparse && status == BLK_ZERO) { 2029 status = BLK_DATA; 2030 memset(buf, 0x00, n * BDRV_SECTOR_SIZE); 2031 } 2032 2033 if (s->wr_in_order) { 2034 /* keep writes in order */ 2035 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) { 2036 s->wait_sector_num[index] = sector_num; 2037 qemu_coroutine_yield(); 2038 } 2039 s->wait_sector_num[index] = -1; 2040 } 2041 2042 if (s->ret == -EINPROGRESS) { 2043 if (copy_range) { 2044 WITH_GRAPH_RDLOCK_GUARD() { 2045 ret = convert_co_copy_range(s, sector_num, n); 2046 } 2047 if (ret) { 2048 s->copy_range = false; 2049 goto retry; 2050 } 2051 } else { 2052 ret = convert_co_write(s, sector_num, n, buf, status); 2053 } 2054 if (ret < 0) { 2055 error_report("error while writing at byte %lld: %s", 2056 sector_num * BDRV_SECTOR_SIZE, strerror(-ret)); 2057 s->ret = ret; 2058 } 2059 } 2060 2061 if (s->wr_in_order) { 2062 /* reenter the coroutine that might have waited 2063 * for this write to complete */ 2064 s->wr_offs = sector_num + n; 2065 for (i = 0; i < s->num_coroutines; i++) { 2066 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) { 2067 /* 2068 * A -> B -> A cannot occur because A has 2069 * s->wait_sector_num[i] == -1 during A -> B. Therefore 2070 * B will never enter A during this time window. 2071 */ 2072 qemu_coroutine_enter(s->co[i]); 2073 break; 2074 } 2075 } 2076 } 2077 } 2078 2079 qemu_vfree(buf); 2080 s->co[index] = NULL; 2081 s->running_coroutines--; 2082 if (!s->running_coroutines && s->ret == -EINPROGRESS) { 2083 /* the convert job finished successfully */ 2084 s->ret = 0; 2085 } 2086 } 2087 2088 static int convert_do_copy(ImgConvertState *s) 2089 { 2090 int ret, i, n; 2091 int64_t sector_num = 0; 2092 2093 /* Check whether we have zero initialisation or can get it efficiently */ 2094 if (!s->has_zero_init && s->target_is_new && s->min_sparse && 2095 !s->target_has_backing) { 2096 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target)); 2097 } 2098 2099 /* Allocate buffer for copied data. For compressed images, only one cluster 2100 * can be copied at a time. */ 2101 if (s->compressed) { 2102 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) { 2103 error_report("invalid cluster size"); 2104 return -EINVAL; 2105 } 2106 s->buf_sectors = s->cluster_sectors; 2107 } 2108 2109 while (sector_num < s->total_sectors) { 2110 n = convert_iteration_sectors(s, sector_num); 2111 if (n < 0) { 2112 return n; 2113 } 2114 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO)) 2115 { 2116 s->allocated_sectors += n; 2117 } 2118 sector_num += n; 2119 } 2120 2121 /* Do the copy */ 2122 s->sector_next_status = 0; 2123 s->ret = -EINPROGRESS; 2124 2125 qemu_co_mutex_init(&s->lock); 2126 for (i = 0; i < s->num_coroutines; i++) { 2127 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s); 2128 s->wait_sector_num[i] = -1; 2129 qemu_coroutine_enter(s->co[i]); 2130 } 2131 2132 while (s->running_coroutines) { 2133 main_loop_wait(false); 2134 } 2135 2136 if (s->compressed && !s->ret) { 2137 /* signal EOF to align */ 2138 ret = blk_pwrite_compressed(s->target, 0, 0, NULL); 2139 if (ret < 0) { 2140 return ret; 2141 } 2142 } 2143 2144 return s->ret; 2145 } 2146 2147 /* Check that bitmaps can be copied, or output an error */ 2148 static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken) 2149 { 2150 BdrvDirtyBitmap *bm; 2151 2152 if (!bdrv_supports_persistent_dirty_bitmap(src)) { 2153 error_report("Source lacks bitmap support"); 2154 return -1; 2155 } 2156 FOR_EACH_DIRTY_BITMAP(src, bm) { 2157 if (!bdrv_dirty_bitmap_get_persistence(bm)) { 2158 continue; 2159 } 2160 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) { 2161 error_report("Cannot copy inconsistent bitmap '%s'", 2162 bdrv_dirty_bitmap_name(bm)); 2163 error_printf("Try --skip-broken-bitmaps, or " 2164 "use 'qemu-img bitmap --remove' to delete it\n"); 2165 return -1; 2166 } 2167 } 2168 return 0; 2169 } 2170 2171 static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst, 2172 bool skip_broken) 2173 { 2174 BdrvDirtyBitmap *bm; 2175 Error *err = NULL; 2176 2177 FOR_EACH_DIRTY_BITMAP(src, bm) { 2178 const char *name; 2179 2180 if (!bdrv_dirty_bitmap_get_persistence(bm)) { 2181 continue; 2182 } 2183 name = bdrv_dirty_bitmap_name(bm); 2184 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) { 2185 warn_report("Skipping inconsistent bitmap '%s'", name); 2186 continue; 2187 } 2188 qmp_block_dirty_bitmap_add(dst->node_name, name, 2189 true, bdrv_dirty_bitmap_granularity(bm), 2190 true, true, 2191 true, !bdrv_dirty_bitmap_enabled(bm), 2192 &err); 2193 if (err) { 2194 error_reportf_err(err, "Failed to create bitmap %s: ", name); 2195 return -1; 2196 } 2197 2198 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name, 2199 &err); 2200 if (err) { 2201 error_reportf_err(err, "Failed to populate bitmap %s: ", name); 2202 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL); 2203 return -1; 2204 } 2205 } 2206 2207 return 0; 2208 } 2209 2210 #define MAX_BUF_SECTORS 32768 2211 2212 static void set_rate_limit(BlockBackend *blk, int64_t rate_limit) 2213 { 2214 ThrottleConfig cfg; 2215 2216 throttle_config_init(&cfg); 2217 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit; 2218 2219 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP); 2220 blk_set_io_limits(blk, &cfg); 2221 } 2222 2223 static int img_convert(int argc, char **argv) 2224 { 2225 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE; 2226 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe", 2227 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL, 2228 *out_filename, *out_baseimg_param, *snapshot_name = NULL, 2229 *backing_fmt = NULL; 2230 BlockDriver *drv = NULL, *proto_drv = NULL; 2231 BlockDriverInfo bdi; 2232 BlockDriverState *out_bs; 2233 QemuOpts *opts = NULL, *sn_opts = NULL; 2234 QemuOptsList *create_opts = NULL; 2235 QDict *open_opts = NULL; 2236 char *options = NULL; 2237 Error *local_err = NULL; 2238 bool writethrough, src_writethrough, image_opts = false, 2239 skip_create = false, progress = false, tgt_image_opts = false; 2240 int64_t ret = -EINVAL; 2241 bool force_share = false; 2242 bool explict_min_sparse = false; 2243 bool bitmaps = false; 2244 bool skip_broken = false; 2245 int64_t rate_limit = 0; 2246 2247 ImgConvertState s = (ImgConvertState) { 2248 /* Need at least 4k of zeros for sparse detection */ 2249 .min_sparse = 8, 2250 .copy_range = false, 2251 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE, 2252 .wr_in_order = true, 2253 .num_coroutines = 8, 2254 }; 2255 2256 for(;;) { 2257 static const struct option long_options[] = { 2258 {"help", no_argument, 0, 'h'}, 2259 {"object", required_argument, 0, OPTION_OBJECT}, 2260 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 2261 {"force-share", no_argument, 0, 'U'}, 2262 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS}, 2263 {"salvage", no_argument, 0, OPTION_SALVAGE}, 2264 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO}, 2265 {"bitmaps", no_argument, 0, OPTION_BITMAPS}, 2266 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN}, 2267 {0, 0, 0, 0} 2268 }; 2269 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:", 2270 long_options, NULL); 2271 if (c == -1) { 2272 break; 2273 } 2274 switch(c) { 2275 case ':': 2276 missing_argument(argv[optind - 1]); 2277 break; 2278 case '?': 2279 unrecognized_option(argv[optind - 1]); 2280 break; 2281 case 'h': 2282 help(); 2283 break; 2284 case 'f': 2285 fmt = optarg; 2286 break; 2287 case 'O': 2288 out_fmt = optarg; 2289 break; 2290 case 'B': 2291 out_baseimg = optarg; 2292 break; 2293 case 'C': 2294 s.copy_range = true; 2295 break; 2296 case 'c': 2297 s.compressed = true; 2298 break; 2299 case 'F': 2300 backing_fmt = optarg; 2301 break; 2302 case 'o': 2303 if (accumulate_options(&options, optarg) < 0) { 2304 goto fail_getopt; 2305 } 2306 break; 2307 case 'l': 2308 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) { 2309 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts, 2310 optarg, false); 2311 if (!sn_opts) { 2312 error_report("Failed in parsing snapshot param '%s'", 2313 optarg); 2314 goto fail_getopt; 2315 } 2316 } else { 2317 snapshot_name = optarg; 2318 } 2319 break; 2320 case 'S': 2321 { 2322 int64_t sval; 2323 2324 sval = cvtnum("buffer size for sparse output", optarg); 2325 if (sval < 0) { 2326 goto fail_getopt; 2327 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) || 2328 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) { 2329 error_report("Invalid buffer size for sparse output specified. " 2330 "Valid sizes are multiples of %llu up to %llu. Select " 2331 "0 to disable sparse detection (fully allocates output).", 2332 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE); 2333 goto fail_getopt; 2334 } 2335 2336 s.min_sparse = sval / BDRV_SECTOR_SIZE; 2337 explict_min_sparse = true; 2338 break; 2339 } 2340 case 'p': 2341 progress = true; 2342 break; 2343 case 't': 2344 cache = optarg; 2345 break; 2346 case 'T': 2347 src_cache = optarg; 2348 break; 2349 case 'q': 2350 s.quiet = true; 2351 break; 2352 case 'n': 2353 skip_create = true; 2354 break; 2355 case 'm': 2356 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) || 2357 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) { 2358 error_report("Invalid number of coroutines. Allowed number of" 2359 " coroutines is between 1 and %d", MAX_COROUTINES); 2360 goto fail_getopt; 2361 } 2362 break; 2363 case 'W': 2364 s.wr_in_order = false; 2365 break; 2366 case 'U': 2367 force_share = true; 2368 break; 2369 case 'r': 2370 rate_limit = cvtnum("rate limit", optarg); 2371 if (rate_limit < 0) { 2372 goto fail_getopt; 2373 } 2374 break; 2375 case OPTION_OBJECT: 2376 user_creatable_process_cmdline(optarg); 2377 break; 2378 case OPTION_IMAGE_OPTS: 2379 image_opts = true; 2380 break; 2381 case OPTION_SALVAGE: 2382 s.salvage = true; 2383 break; 2384 case OPTION_TARGET_IMAGE_OPTS: 2385 tgt_image_opts = true; 2386 break; 2387 case OPTION_TARGET_IS_ZERO: 2388 /* 2389 * The user asserting that the target is blank has the 2390 * same effect as the target driver supporting zero 2391 * initialisation. 2392 */ 2393 s.has_zero_init = true; 2394 break; 2395 case OPTION_BITMAPS: 2396 bitmaps = true; 2397 break; 2398 case OPTION_SKIP_BROKEN: 2399 skip_broken = true; 2400 break; 2401 } 2402 } 2403 2404 if (!out_fmt && !tgt_image_opts) { 2405 out_fmt = "raw"; 2406 } 2407 2408 if (skip_broken && !bitmaps) { 2409 error_report("Use of --skip-broken-bitmaps requires --bitmaps"); 2410 goto fail_getopt; 2411 } 2412 2413 if (s.compressed && s.copy_range) { 2414 error_report("Cannot enable copy offloading when -c is used"); 2415 goto fail_getopt; 2416 } 2417 2418 if (explict_min_sparse && s.copy_range) { 2419 error_report("Cannot enable copy offloading when -S is used"); 2420 goto fail_getopt; 2421 } 2422 2423 if (s.copy_range && s.salvage) { 2424 error_report("Cannot use copy offloading in salvaging mode"); 2425 goto fail_getopt; 2426 } 2427 2428 if (tgt_image_opts && !skip_create) { 2429 error_report("--target-image-opts requires use of -n flag"); 2430 goto fail_getopt; 2431 } 2432 2433 if (skip_create && options) { 2434 error_report("-o has no effect when skipping image creation"); 2435 goto fail_getopt; 2436 } 2437 2438 if (s.has_zero_init && !skip_create) { 2439 error_report("--target-is-zero requires use of -n flag"); 2440 goto fail_getopt; 2441 } 2442 2443 s.src_num = argc - optind - 1; 2444 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL; 2445 2446 if (options && has_help_option(options)) { 2447 if (out_fmt) { 2448 ret = print_block_option_help(out_filename, out_fmt); 2449 goto fail_getopt; 2450 } else { 2451 error_report("Option help requires a format be specified"); 2452 goto fail_getopt; 2453 } 2454 } 2455 2456 if (s.src_num < 1) { 2457 error_report("Must specify image file name"); 2458 goto fail_getopt; 2459 } 2460 2461 /* ret is still -EINVAL until here */ 2462 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough); 2463 if (ret < 0) { 2464 error_report("Invalid source cache option: %s", src_cache); 2465 goto fail_getopt; 2466 } 2467 2468 /* Initialize before goto out */ 2469 if (s.quiet) { 2470 progress = false; 2471 } 2472 qemu_progress_init(progress, 1.0); 2473 qemu_progress_print(0, 100); 2474 2475 s.src = g_new0(BlockBackend *, s.src_num); 2476 s.src_sectors = g_new(int64_t, s.src_num); 2477 s.src_alignment = g_new(int, s.src_num); 2478 2479 for (bs_i = 0; bs_i < s.src_num; bs_i++) { 2480 BlockDriverState *src_bs; 2481 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i], 2482 fmt, src_flags, src_writethrough, s.quiet, 2483 force_share); 2484 if (!s.src[bs_i]) { 2485 ret = -1; 2486 goto out; 2487 } 2488 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]); 2489 if (s.src_sectors[bs_i] < 0) { 2490 error_report("Could not get size of %s: %s", 2491 argv[optind + bs_i], strerror(-s.src_sectors[bs_i])); 2492 ret = -1; 2493 goto out; 2494 } 2495 src_bs = blk_bs(s.src[bs_i]); 2496 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment, 2497 BDRV_SECTOR_SIZE); 2498 if (!bdrv_get_info(src_bs, &bdi)) { 2499 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i], 2500 bdi.cluster_size / BDRV_SECTOR_SIZE); 2501 } 2502 s.total_sectors += s.src_sectors[bs_i]; 2503 } 2504 2505 if (sn_opts) { 2506 bdrv_snapshot_load_tmp(blk_bs(s.src[0]), 2507 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID), 2508 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME), 2509 &local_err); 2510 } else if (snapshot_name != NULL) { 2511 if (s.src_num > 1) { 2512 error_report("No support for concatenating multiple snapshot"); 2513 ret = -1; 2514 goto out; 2515 } 2516 2517 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name, 2518 &local_err); 2519 } 2520 if (local_err) { 2521 error_reportf_err(local_err, "Failed to load snapshot: "); 2522 ret = -1; 2523 goto out; 2524 } 2525 2526 if (!skip_create) { 2527 /* Find driver and parse its options */ 2528 drv = bdrv_find_format(out_fmt); 2529 if (!drv) { 2530 error_report("Unknown file format '%s'", out_fmt); 2531 ret = -1; 2532 goto out; 2533 } 2534 2535 proto_drv = bdrv_find_protocol(out_filename, true, &local_err); 2536 if (!proto_drv) { 2537 error_report_err(local_err); 2538 ret = -1; 2539 goto out; 2540 } 2541 2542 if (!drv->create_opts) { 2543 error_report("Format driver '%s' does not support image creation", 2544 drv->format_name); 2545 ret = -1; 2546 goto out; 2547 } 2548 2549 if (!proto_drv->create_opts) { 2550 error_report("Protocol driver '%s' does not support image creation", 2551 proto_drv->format_name); 2552 ret = -1; 2553 goto out; 2554 } 2555 2556 create_opts = qemu_opts_append(create_opts, drv->create_opts); 2557 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); 2558 2559 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); 2560 if (options) { 2561 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) { 2562 error_report_err(local_err); 2563 ret = -1; 2564 goto out; 2565 } 2566 } 2567 2568 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 2569 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort); 2570 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt); 2571 if (ret < 0) { 2572 goto out; 2573 } 2574 } 2575 2576 /* Get backing file name if -o backing_file was used */ 2577 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE); 2578 if (out_baseimg_param) { 2579 out_baseimg = out_baseimg_param; 2580 } 2581 s.target_has_backing = (bool) out_baseimg; 2582 2583 if (s.has_zero_init && s.target_has_backing) { 2584 error_report("Cannot use --target-is-zero when the destination " 2585 "image has a backing file"); 2586 goto out; 2587 } 2588 2589 if (s.src_num > 1 && out_baseimg) { 2590 error_report("Having a backing file for the target makes no sense when " 2591 "concatenating multiple input images"); 2592 ret = -1; 2593 goto out; 2594 } 2595 2596 if (out_baseimg_param) { 2597 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) { 2598 error_report("Use of backing file requires explicit " 2599 "backing format"); 2600 ret = -1; 2601 goto out; 2602 } 2603 } 2604 2605 /* Check if compression is supported */ 2606 if (s.compressed) { 2607 bool encryption = 2608 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false); 2609 const char *encryptfmt = 2610 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT); 2611 const char *preallocation = 2612 qemu_opt_get(opts, BLOCK_OPT_PREALLOC); 2613 2614 if (drv && !block_driver_can_compress(drv)) { 2615 error_report("Compression not supported for this file format"); 2616 ret = -1; 2617 goto out; 2618 } 2619 2620 if (encryption || encryptfmt) { 2621 error_report("Compression and encryption not supported at " 2622 "the same time"); 2623 ret = -1; 2624 goto out; 2625 } 2626 2627 if (preallocation 2628 && strcmp(preallocation, "off")) 2629 { 2630 error_report("Compression and preallocation not supported at " 2631 "the same time"); 2632 ret = -1; 2633 goto out; 2634 } 2635 } 2636 2637 /* Determine if bitmaps need copying */ 2638 if (bitmaps) { 2639 if (s.src_num > 1) { 2640 error_report("Copying bitmaps only possible with single source"); 2641 ret = -1; 2642 goto out; 2643 } 2644 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken); 2645 if (ret < 0) { 2646 goto out; 2647 } 2648 } 2649 2650 /* 2651 * The later open call will need any decryption secrets, and 2652 * bdrv_create() will purge "opts", so extract them now before 2653 * they are lost. 2654 */ 2655 if (!skip_create) { 2656 open_opts = qdict_new(); 2657 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort); 2658 2659 /* Create the new image */ 2660 ret = bdrv_create(drv, out_filename, opts, &local_err); 2661 if (ret < 0) { 2662 error_reportf_err(local_err, "%s: error while converting %s: ", 2663 out_filename, out_fmt); 2664 goto out; 2665 } 2666 } 2667 2668 s.target_is_new = !skip_create; 2669 2670 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR; 2671 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough); 2672 if (ret < 0) { 2673 error_report("Invalid cache option: %s", cache); 2674 goto out; 2675 } 2676 2677 if (flags & BDRV_O_NOCACHE) { 2678 /* 2679 * If we open the target with O_DIRECT, it may be necessary to 2680 * extend its size to align to the physical sector size. 2681 */ 2682 flags |= BDRV_O_RESIZE; 2683 } 2684 2685 if (skip_create) { 2686 s.target = img_open(tgt_image_opts, out_filename, out_fmt, 2687 flags, writethrough, s.quiet, false); 2688 } else { 2689 /* TODO ultimately we should allow --target-image-opts 2690 * to be used even when -n is not given. 2691 * That has to wait for bdrv_create to be improved 2692 * to allow filenames in option syntax 2693 */ 2694 s.target = img_open_file(out_filename, open_opts, out_fmt, 2695 flags, writethrough, s.quiet, false); 2696 open_opts = NULL; /* blk_new_open will have freed it */ 2697 } 2698 if (!s.target) { 2699 ret = -1; 2700 goto out; 2701 } 2702 out_bs = blk_bs(s.target); 2703 2704 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) { 2705 error_report("Format driver '%s' does not support bitmaps", 2706 out_bs->drv->format_name); 2707 ret = -1; 2708 goto out; 2709 } 2710 2711 if (s.compressed && !block_driver_can_compress(out_bs->drv)) { 2712 error_report("Compression not supported for this file format"); 2713 ret = -1; 2714 goto out; 2715 } 2716 2717 /* increase bufsectors from the default 4096 (2M) if opt_transfer 2718 * or discard_alignment of the out_bs is greater. Limit to 2719 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */ 2720 s.buf_sectors = MIN(MAX_BUF_SECTORS, 2721 MAX(s.buf_sectors, 2722 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS, 2723 out_bs->bl.pdiscard_alignment >> 2724 BDRV_SECTOR_BITS))); 2725 2726 /* try to align the write requests to the destination to avoid unnecessary 2727 * RMW cycles. */ 2728 s.alignment = MAX(pow2floor(s.min_sparse), 2729 DIV_ROUND_UP(out_bs->bl.request_alignment, 2730 BDRV_SECTOR_SIZE)); 2731 assert(is_power_of_2(s.alignment)); 2732 2733 if (skip_create) { 2734 int64_t output_sectors = blk_nb_sectors(s.target); 2735 if (output_sectors < 0) { 2736 error_report("unable to get output image length: %s", 2737 strerror(-output_sectors)); 2738 ret = -1; 2739 goto out; 2740 } else if (output_sectors < s.total_sectors) { 2741 error_report("output file is smaller than input file"); 2742 ret = -1; 2743 goto out; 2744 } 2745 } 2746 2747 if (s.target_has_backing && s.target_is_new) { 2748 /* Errors are treated as "backing length unknown" (which means 2749 * s.target_backing_sectors has to be negative, which it will 2750 * be automatically). The backing file length is used only 2751 * for optimizations, so such a case is not fatal. */ 2752 s.target_backing_sectors = 2753 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs)); 2754 } else { 2755 s.target_backing_sectors = -1; 2756 } 2757 2758 ret = bdrv_get_info(out_bs, &bdi); 2759 if (ret < 0) { 2760 if (s.compressed) { 2761 error_report("could not get block driver info"); 2762 goto out; 2763 } 2764 } else { 2765 s.compressed = s.compressed || bdi.needs_compressed_writes; 2766 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE; 2767 } 2768 2769 if (rate_limit) { 2770 set_rate_limit(s.target, rate_limit); 2771 } 2772 2773 ret = convert_do_copy(&s); 2774 2775 /* Now copy the bitmaps */ 2776 if (bitmaps && ret == 0) { 2777 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken); 2778 } 2779 2780 out: 2781 if (!ret) { 2782 qemu_progress_print(100, 0); 2783 } 2784 qemu_progress_end(); 2785 qemu_opts_del(opts); 2786 qemu_opts_free(create_opts); 2787 qobject_unref(open_opts); 2788 blk_unref(s.target); 2789 if (s.src) { 2790 for (bs_i = 0; bs_i < s.src_num; bs_i++) { 2791 blk_unref(s.src[bs_i]); 2792 } 2793 g_free(s.src); 2794 } 2795 g_free(s.src_sectors); 2796 g_free(s.src_alignment); 2797 fail_getopt: 2798 qemu_opts_del(sn_opts); 2799 g_free(options); 2800 2801 return !!ret; 2802 } 2803 2804 2805 static void dump_snapshots(BlockDriverState *bs) 2806 { 2807 QEMUSnapshotInfo *sn_tab, *sn; 2808 int nb_sns, i; 2809 2810 nb_sns = bdrv_snapshot_list(bs, &sn_tab); 2811 if (nb_sns <= 0) 2812 return; 2813 printf("Snapshot list:\n"); 2814 bdrv_snapshot_dump(NULL); 2815 printf("\n"); 2816 for(i = 0; i < nb_sns; i++) { 2817 sn = &sn_tab[i]; 2818 bdrv_snapshot_dump(sn); 2819 printf("\n"); 2820 } 2821 g_free(sn_tab); 2822 } 2823 2824 static void dump_json_block_graph_info_list(BlockGraphInfoList *list) 2825 { 2826 GString *str; 2827 QObject *obj; 2828 Visitor *v = qobject_output_visitor_new(&obj); 2829 2830 visit_type_BlockGraphInfoList(v, NULL, &list, &error_abort); 2831 visit_complete(v, &obj); 2832 str = qobject_to_json_pretty(obj, true); 2833 assert(str != NULL); 2834 printf("%s\n", str->str); 2835 qobject_unref(obj); 2836 visit_free(v); 2837 g_string_free(str, true); 2838 } 2839 2840 static void dump_json_block_graph_info(BlockGraphInfo *info) 2841 { 2842 GString *str; 2843 QObject *obj; 2844 Visitor *v = qobject_output_visitor_new(&obj); 2845 2846 visit_type_BlockGraphInfo(v, NULL, &info, &error_abort); 2847 visit_complete(v, &obj); 2848 str = qobject_to_json_pretty(obj, true); 2849 assert(str != NULL); 2850 printf("%s\n", str->str); 2851 qobject_unref(obj); 2852 visit_free(v); 2853 g_string_free(str, true); 2854 } 2855 2856 static void dump_human_image_info(BlockGraphInfo *info, int indentation, 2857 const char *path) 2858 { 2859 BlockChildInfoList *children_list; 2860 2861 bdrv_node_info_dump(qapi_BlockGraphInfo_base(info), indentation, 2862 info->children == NULL); 2863 2864 for (children_list = info->children; children_list; 2865 children_list = children_list->next) 2866 { 2867 BlockChildInfo *child = children_list->value; 2868 g_autofree char *child_path = NULL; 2869 2870 printf("%*sChild node '%s%s':\n", 2871 indentation * 4, "", path, child->name); 2872 child_path = g_strdup_printf("%s%s/", path, child->name); 2873 dump_human_image_info(child->info, indentation + 1, child_path); 2874 } 2875 } 2876 2877 static void dump_human_image_info_list(BlockGraphInfoList *list) 2878 { 2879 BlockGraphInfoList *elem; 2880 bool delim = false; 2881 2882 for (elem = list; elem; elem = elem->next) { 2883 if (delim) { 2884 printf("\n"); 2885 } 2886 delim = true; 2887 2888 dump_human_image_info(elem->value, 0, "/"); 2889 } 2890 } 2891 2892 static gboolean str_equal_func(gconstpointer a, gconstpointer b) 2893 { 2894 return strcmp(a, b) == 0; 2895 } 2896 2897 /** 2898 * Open an image file chain and return an BlockGraphInfoList 2899 * 2900 * @filename: topmost image filename 2901 * @fmt: topmost image format (may be NULL to autodetect) 2902 * @chain: true - enumerate entire backing file chain 2903 * false - only topmost image file 2904 * 2905 * Returns a list of BlockNodeInfo objects or NULL if there was an error 2906 * opening an image file. If there was an error a message will have been 2907 * printed to stderr. 2908 */ 2909 static BlockGraphInfoList *collect_image_info_list(bool image_opts, 2910 const char *filename, 2911 const char *fmt, 2912 bool chain, bool force_share) 2913 { 2914 BlockGraphInfoList *head = NULL; 2915 BlockGraphInfoList **tail = &head; 2916 GHashTable *filenames; 2917 Error *err = NULL; 2918 2919 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL); 2920 2921 while (filename) { 2922 BlockBackend *blk; 2923 BlockDriverState *bs; 2924 BlockGraphInfo *info; 2925 2926 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) { 2927 error_report("Backing file '%s' creates an infinite loop.", 2928 filename); 2929 goto err; 2930 } 2931 g_hash_table_insert(filenames, (gpointer)filename, NULL); 2932 2933 blk = img_open(image_opts, filename, fmt, 2934 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false, 2935 force_share); 2936 if (!blk) { 2937 goto err; 2938 } 2939 bs = blk_bs(blk); 2940 2941 GRAPH_RDLOCK_GUARD_MAINLOOP(); 2942 2943 /* 2944 * Note that the returned BlockGraphInfo object will not have 2945 * information about this image's backing node, because we have opened 2946 * it with BDRV_O_NO_BACKING. Printing this object will therefore not 2947 * duplicate the backing chain information that we obtain by walking 2948 * the chain manually here. 2949 */ 2950 bdrv_query_block_graph_info(bs, &info, &err); 2951 if (err) { 2952 error_report_err(err); 2953 blk_unref(blk); 2954 goto err; 2955 } 2956 2957 QAPI_LIST_APPEND(tail, info); 2958 2959 blk_unref(blk); 2960 2961 /* Clear parameters that only apply to the topmost image */ 2962 filename = fmt = NULL; 2963 image_opts = false; 2964 2965 if (chain) { 2966 if (info->full_backing_filename) { 2967 filename = info->full_backing_filename; 2968 } else if (info->backing_filename) { 2969 error_report("Could not determine absolute backing filename," 2970 " but backing filename '%s' present", 2971 info->backing_filename); 2972 goto err; 2973 } 2974 if (info->backing_filename_format) { 2975 fmt = info->backing_filename_format; 2976 } 2977 } 2978 } 2979 g_hash_table_destroy(filenames); 2980 return head; 2981 2982 err: 2983 qapi_free_BlockGraphInfoList(head); 2984 g_hash_table_destroy(filenames); 2985 return NULL; 2986 } 2987 2988 static int img_info(int argc, char **argv) 2989 { 2990 int c; 2991 OutputFormat output_format = OFORMAT_HUMAN; 2992 bool chain = false; 2993 const char *filename, *fmt, *output; 2994 BlockGraphInfoList *list; 2995 bool image_opts = false; 2996 bool force_share = false; 2997 2998 fmt = NULL; 2999 output = NULL; 3000 for(;;) { 3001 int option_index = 0; 3002 static const struct option long_options[] = { 3003 {"help", no_argument, 0, 'h'}, 3004 {"format", required_argument, 0, 'f'}, 3005 {"output", required_argument, 0, OPTION_OUTPUT}, 3006 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN}, 3007 {"object", required_argument, 0, OPTION_OBJECT}, 3008 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 3009 {"force-share", no_argument, 0, 'U'}, 3010 {0, 0, 0, 0} 3011 }; 3012 c = getopt_long(argc, argv, ":f:hU", 3013 long_options, &option_index); 3014 if (c == -1) { 3015 break; 3016 } 3017 switch(c) { 3018 case ':': 3019 missing_argument(argv[optind - 1]); 3020 break; 3021 case '?': 3022 unrecognized_option(argv[optind - 1]); 3023 break; 3024 case 'h': 3025 help(); 3026 break; 3027 case 'f': 3028 fmt = optarg; 3029 break; 3030 case 'U': 3031 force_share = true; 3032 break; 3033 case OPTION_OUTPUT: 3034 output = optarg; 3035 break; 3036 case OPTION_BACKING_CHAIN: 3037 chain = true; 3038 break; 3039 case OPTION_OBJECT: 3040 user_creatable_process_cmdline(optarg); 3041 break; 3042 case OPTION_IMAGE_OPTS: 3043 image_opts = true; 3044 break; 3045 } 3046 } 3047 if (optind != argc - 1) { 3048 error_exit("Expecting one image file name"); 3049 } 3050 filename = argv[optind++]; 3051 3052 if (output && !strcmp(output, "json")) { 3053 output_format = OFORMAT_JSON; 3054 } else if (output && !strcmp(output, "human")) { 3055 output_format = OFORMAT_HUMAN; 3056 } else if (output) { 3057 error_report("--output must be used with human or json as argument."); 3058 return 1; 3059 } 3060 3061 list = collect_image_info_list(image_opts, filename, fmt, chain, 3062 force_share); 3063 if (!list) { 3064 return 1; 3065 } 3066 3067 switch (output_format) { 3068 case OFORMAT_HUMAN: 3069 dump_human_image_info_list(list); 3070 break; 3071 case OFORMAT_JSON: 3072 if (chain) { 3073 dump_json_block_graph_info_list(list); 3074 } else { 3075 dump_json_block_graph_info(list->value); 3076 } 3077 break; 3078 } 3079 3080 qapi_free_BlockGraphInfoList(list); 3081 return 0; 3082 } 3083 3084 static int dump_map_entry(OutputFormat output_format, MapEntry *e, 3085 MapEntry *next) 3086 { 3087 switch (output_format) { 3088 case OFORMAT_HUMAN: 3089 if (e->data && !e->has_offset) { 3090 error_report("File contains external, encrypted or compressed clusters."); 3091 return -1; 3092 } 3093 if (e->data && !e->zero) { 3094 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n", 3095 e->start, e->length, 3096 e->has_offset ? e->offset : 0, 3097 e->filename ?: ""); 3098 } 3099 /* This format ignores the distinction between 0, ZERO and ZERO|DATA. 3100 * Modify the flags here to allow more coalescing. 3101 */ 3102 if (next && (!next->data || next->zero)) { 3103 next->data = false; 3104 next->zero = true; 3105 } 3106 break; 3107 case OFORMAT_JSON: 3108 printf("{ \"start\": %"PRId64", \"length\": %"PRId64"," 3109 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s," 3110 " \"data\": %s", e->start, e->length, e->depth, 3111 e->present ? "true" : "false", 3112 e->zero ? "true" : "false", 3113 e->data ? "true" : "false"); 3114 if (e->has_offset) { 3115 printf(", \"offset\": %"PRId64"", e->offset); 3116 } 3117 putchar('}'); 3118 3119 if (next) { 3120 puts(","); 3121 } 3122 break; 3123 } 3124 return 0; 3125 } 3126 3127 static int get_block_status(BlockDriverState *bs, int64_t offset, 3128 int64_t bytes, MapEntry *e) 3129 { 3130 int ret; 3131 int depth; 3132 BlockDriverState *file; 3133 bool has_offset; 3134 int64_t map; 3135 char *filename = NULL; 3136 3137 /* As an optimization, we could cache the current range of unallocated 3138 * clusters in each file of the chain, and avoid querying the same 3139 * range repeatedly. 3140 */ 3141 3142 depth = 0; 3143 for (;;) { 3144 bs = bdrv_skip_filters(bs); 3145 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file); 3146 if (ret < 0) { 3147 return ret; 3148 } 3149 assert(bytes); 3150 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) { 3151 break; 3152 } 3153 bs = bdrv_cow_bs(bs); 3154 if (bs == NULL) { 3155 ret = 0; 3156 break; 3157 } 3158 3159 depth++; 3160 } 3161 3162 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID); 3163 3164 if (file && has_offset) { 3165 bdrv_refresh_filename(file); 3166 filename = file->filename; 3167 } 3168 3169 *e = (MapEntry) { 3170 .start = offset, 3171 .length = bytes, 3172 .data = !!(ret & BDRV_BLOCK_DATA), 3173 .zero = !!(ret & BDRV_BLOCK_ZERO), 3174 .offset = map, 3175 .has_offset = has_offset, 3176 .depth = depth, 3177 .present = !!(ret & BDRV_BLOCK_ALLOCATED), 3178 .filename = filename, 3179 }; 3180 3181 return 0; 3182 } 3183 3184 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next) 3185 { 3186 if (curr->length == 0) { 3187 return false; 3188 } 3189 if (curr->zero != next->zero || 3190 curr->data != next->data || 3191 curr->depth != next->depth || 3192 curr->present != next->present || 3193 !curr->filename != !next->filename || 3194 curr->has_offset != next->has_offset) { 3195 return false; 3196 } 3197 if (curr->filename && strcmp(curr->filename, next->filename)) { 3198 return false; 3199 } 3200 if (curr->has_offset && curr->offset + curr->length != next->offset) { 3201 return false; 3202 } 3203 return true; 3204 } 3205 3206 static int img_map(int argc, char **argv) 3207 { 3208 int c; 3209 OutputFormat output_format = OFORMAT_HUMAN; 3210 BlockBackend *blk; 3211 BlockDriverState *bs; 3212 const char *filename, *fmt, *output; 3213 int64_t length; 3214 MapEntry curr = { .length = 0 }, next; 3215 int ret = 0; 3216 bool image_opts = false; 3217 bool force_share = false; 3218 int64_t start_offset = 0; 3219 int64_t max_length = -1; 3220 3221 fmt = NULL; 3222 output = NULL; 3223 for (;;) { 3224 int option_index = 0; 3225 static const struct option long_options[] = { 3226 {"help", no_argument, 0, 'h'}, 3227 {"format", required_argument, 0, 'f'}, 3228 {"output", required_argument, 0, OPTION_OUTPUT}, 3229 {"object", required_argument, 0, OPTION_OBJECT}, 3230 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 3231 {"force-share", no_argument, 0, 'U'}, 3232 {"start-offset", required_argument, 0, 's'}, 3233 {"max-length", required_argument, 0, 'l'}, 3234 {0, 0, 0, 0} 3235 }; 3236 c = getopt_long(argc, argv, ":f:s:l:hU", 3237 long_options, &option_index); 3238 if (c == -1) { 3239 break; 3240 } 3241 switch (c) { 3242 case ':': 3243 missing_argument(argv[optind - 1]); 3244 break; 3245 case '?': 3246 unrecognized_option(argv[optind - 1]); 3247 break; 3248 case 'h': 3249 help(); 3250 break; 3251 case 'f': 3252 fmt = optarg; 3253 break; 3254 case 'U': 3255 force_share = true; 3256 break; 3257 case OPTION_OUTPUT: 3258 output = optarg; 3259 break; 3260 case 's': 3261 start_offset = cvtnum("start offset", optarg); 3262 if (start_offset < 0) { 3263 return 1; 3264 } 3265 break; 3266 case 'l': 3267 max_length = cvtnum("max length", optarg); 3268 if (max_length < 0) { 3269 return 1; 3270 } 3271 break; 3272 case OPTION_OBJECT: 3273 user_creatable_process_cmdline(optarg); 3274 break; 3275 case OPTION_IMAGE_OPTS: 3276 image_opts = true; 3277 break; 3278 } 3279 } 3280 if (optind != argc - 1) { 3281 error_exit("Expecting one image file name"); 3282 } 3283 filename = argv[optind]; 3284 3285 if (output && !strcmp(output, "json")) { 3286 output_format = OFORMAT_JSON; 3287 } else if (output && !strcmp(output, "human")) { 3288 output_format = OFORMAT_HUMAN; 3289 } else if (output) { 3290 error_report("--output must be used with human or json as argument."); 3291 return 1; 3292 } 3293 3294 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share); 3295 if (!blk) { 3296 return 1; 3297 } 3298 bs = blk_bs(blk); 3299 3300 if (output_format == OFORMAT_HUMAN) { 3301 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File"); 3302 } else if (output_format == OFORMAT_JSON) { 3303 putchar('['); 3304 } 3305 3306 length = blk_getlength(blk); 3307 if (length < 0) { 3308 error_report("Failed to get size for '%s'", filename); 3309 return 1; 3310 } 3311 if (max_length != -1) { 3312 length = MIN(start_offset + max_length, length); 3313 } 3314 3315 curr.start = start_offset; 3316 while (curr.start + curr.length < length) { 3317 int64_t offset = curr.start + curr.length; 3318 int64_t n = length - offset; 3319 3320 ret = get_block_status(bs, offset, n, &next); 3321 if (ret < 0) { 3322 error_report("Could not read file metadata: %s", strerror(-ret)); 3323 goto out; 3324 } 3325 3326 if (entry_mergeable(&curr, &next)) { 3327 curr.length += next.length; 3328 continue; 3329 } 3330 3331 if (curr.length > 0) { 3332 ret = dump_map_entry(output_format, &curr, &next); 3333 if (ret < 0) { 3334 goto out; 3335 } 3336 } 3337 curr = next; 3338 } 3339 3340 ret = dump_map_entry(output_format, &curr, NULL); 3341 if (output_format == OFORMAT_JSON) { 3342 puts("]"); 3343 } 3344 3345 out: 3346 blk_unref(blk); 3347 return ret < 0; 3348 } 3349 3350 #define SNAPSHOT_LIST 1 3351 #define SNAPSHOT_CREATE 2 3352 #define SNAPSHOT_APPLY 3 3353 #define SNAPSHOT_DELETE 4 3354 3355 static int img_snapshot(int argc, char **argv) 3356 { 3357 BlockBackend *blk; 3358 BlockDriverState *bs; 3359 QEMUSnapshotInfo sn; 3360 char *filename, *snapshot_name = NULL; 3361 int c, ret = 0, bdrv_oflags; 3362 int action = 0; 3363 bool quiet = false; 3364 Error *err = NULL; 3365 bool image_opts = false; 3366 bool force_share = false; 3367 int64_t rt; 3368 3369 bdrv_oflags = BDRV_O_RDWR; 3370 /* Parse commandline parameters */ 3371 for(;;) { 3372 static const struct option long_options[] = { 3373 {"help", no_argument, 0, 'h'}, 3374 {"object", required_argument, 0, OPTION_OBJECT}, 3375 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 3376 {"force-share", no_argument, 0, 'U'}, 3377 {0, 0, 0, 0} 3378 }; 3379 c = getopt_long(argc, argv, ":la:c:d:hqU", 3380 long_options, NULL); 3381 if (c == -1) { 3382 break; 3383 } 3384 switch(c) { 3385 case ':': 3386 missing_argument(argv[optind - 1]); 3387 break; 3388 case '?': 3389 unrecognized_option(argv[optind - 1]); 3390 break; 3391 case 'h': 3392 help(); 3393 return 0; 3394 case 'l': 3395 if (action) { 3396 error_exit("Cannot mix '-l', '-a', '-c', '-d'"); 3397 return 0; 3398 } 3399 action = SNAPSHOT_LIST; 3400 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */ 3401 break; 3402 case 'a': 3403 if (action) { 3404 error_exit("Cannot mix '-l', '-a', '-c', '-d'"); 3405 return 0; 3406 } 3407 action = SNAPSHOT_APPLY; 3408 snapshot_name = optarg; 3409 break; 3410 case 'c': 3411 if (action) { 3412 error_exit("Cannot mix '-l', '-a', '-c', '-d'"); 3413 return 0; 3414 } 3415 action = SNAPSHOT_CREATE; 3416 snapshot_name = optarg; 3417 break; 3418 case 'd': 3419 if (action) { 3420 error_exit("Cannot mix '-l', '-a', '-c', '-d'"); 3421 return 0; 3422 } 3423 action = SNAPSHOT_DELETE; 3424 snapshot_name = optarg; 3425 break; 3426 case 'q': 3427 quiet = true; 3428 break; 3429 case 'U': 3430 force_share = true; 3431 break; 3432 case OPTION_OBJECT: 3433 user_creatable_process_cmdline(optarg); 3434 break; 3435 case OPTION_IMAGE_OPTS: 3436 image_opts = true; 3437 break; 3438 } 3439 } 3440 3441 if (optind != argc - 1) { 3442 error_exit("Expecting one image file name"); 3443 } 3444 filename = argv[optind++]; 3445 3446 /* Open the image */ 3447 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet, 3448 force_share); 3449 if (!blk) { 3450 return 1; 3451 } 3452 bs = blk_bs(blk); 3453 3454 /* Perform the requested action */ 3455 switch(action) { 3456 case SNAPSHOT_LIST: 3457 dump_snapshots(bs); 3458 break; 3459 3460 case SNAPSHOT_CREATE: 3461 memset(&sn, 0, sizeof(sn)); 3462 pstrcpy(sn.name, sizeof(sn.name), snapshot_name); 3463 3464 rt = g_get_real_time(); 3465 sn.date_sec = rt / G_USEC_PER_SEC; 3466 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000; 3467 3468 ret = bdrv_snapshot_create(bs, &sn); 3469 if (ret) { 3470 error_report("Could not create snapshot '%s': %d (%s)", 3471 snapshot_name, ret, strerror(-ret)); 3472 } 3473 break; 3474 3475 case SNAPSHOT_APPLY: 3476 ret = bdrv_snapshot_goto(bs, snapshot_name, &err); 3477 if (ret) { 3478 error_reportf_err(err, "Could not apply snapshot '%s': ", 3479 snapshot_name); 3480 } 3481 break; 3482 3483 case SNAPSHOT_DELETE: 3484 ret = bdrv_snapshot_find(bs, &sn, snapshot_name); 3485 if (ret < 0) { 3486 error_report("Could not delete snapshot '%s': snapshot not " 3487 "found", snapshot_name); 3488 ret = 1; 3489 } else { 3490 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err); 3491 if (ret < 0) { 3492 error_reportf_err(err, "Could not delete snapshot '%s': ", 3493 snapshot_name); 3494 ret = 1; 3495 } 3496 } 3497 break; 3498 } 3499 3500 /* Cleanup */ 3501 blk_unref(blk); 3502 if (ret) { 3503 return 1; 3504 } 3505 return 0; 3506 } 3507 3508 static int img_rebase(int argc, char **argv) 3509 { 3510 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL; 3511 uint8_t *buf_old = NULL; 3512 uint8_t *buf_new = NULL; 3513 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL; 3514 BlockDriverState *unfiltered_bs; 3515 char *filename; 3516 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg; 3517 int c, flags, src_flags, ret; 3518 bool writethrough, src_writethrough; 3519 int unsafe = 0; 3520 bool force_share = false; 3521 int progress = 0; 3522 bool quiet = false; 3523 Error *local_err = NULL; 3524 bool image_opts = false; 3525 3526 /* Parse commandline parameters */ 3527 fmt = NULL; 3528 cache = BDRV_DEFAULT_CACHE; 3529 src_cache = BDRV_DEFAULT_CACHE; 3530 out_baseimg = NULL; 3531 out_basefmt = NULL; 3532 for(;;) { 3533 static const struct option long_options[] = { 3534 {"help", no_argument, 0, 'h'}, 3535 {"object", required_argument, 0, OPTION_OBJECT}, 3536 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 3537 {"force-share", no_argument, 0, 'U'}, 3538 {0, 0, 0, 0} 3539 }; 3540 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU", 3541 long_options, NULL); 3542 if (c == -1) { 3543 break; 3544 } 3545 switch(c) { 3546 case ':': 3547 missing_argument(argv[optind - 1]); 3548 break; 3549 case '?': 3550 unrecognized_option(argv[optind - 1]); 3551 break; 3552 case 'h': 3553 help(); 3554 return 0; 3555 case 'f': 3556 fmt = optarg; 3557 break; 3558 case 'F': 3559 out_basefmt = optarg; 3560 break; 3561 case 'b': 3562 out_baseimg = optarg; 3563 break; 3564 case 'u': 3565 unsafe = 1; 3566 break; 3567 case 'p': 3568 progress = 1; 3569 break; 3570 case 't': 3571 cache = optarg; 3572 break; 3573 case 'T': 3574 src_cache = optarg; 3575 break; 3576 case 'q': 3577 quiet = true; 3578 break; 3579 case OPTION_OBJECT: 3580 user_creatable_process_cmdline(optarg); 3581 break; 3582 case OPTION_IMAGE_OPTS: 3583 image_opts = true; 3584 break; 3585 case 'U': 3586 force_share = true; 3587 break; 3588 } 3589 } 3590 3591 if (quiet) { 3592 progress = 0; 3593 } 3594 3595 if (optind != argc - 1) { 3596 error_exit("Expecting one image file name"); 3597 } 3598 if (!unsafe && !out_baseimg) { 3599 error_exit("Must specify backing file (-b) or use unsafe mode (-u)"); 3600 } 3601 filename = argv[optind++]; 3602 3603 qemu_progress_init(progress, 2.0); 3604 qemu_progress_print(0, 100); 3605 3606 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0); 3607 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough); 3608 if (ret < 0) { 3609 error_report("Invalid cache option: %s", cache); 3610 goto out; 3611 } 3612 3613 src_flags = 0; 3614 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough); 3615 if (ret < 0) { 3616 error_report("Invalid source cache option: %s", src_cache); 3617 goto out; 3618 } 3619 3620 /* The source files are opened read-only, don't care about WCE */ 3621 assert((src_flags & BDRV_O_RDWR) == 0); 3622 (void) src_writethrough; 3623 3624 /* 3625 * Open the images. 3626 * 3627 * Ignore the old backing file for unsafe rebase in case we want to correct 3628 * the reference to a renamed or moved backing file. 3629 */ 3630 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet, 3631 false); 3632 if (!blk) { 3633 ret = -1; 3634 goto out; 3635 } 3636 bs = blk_bs(blk); 3637 3638 unfiltered_bs = bdrv_skip_filters(bs); 3639 3640 if (out_basefmt != NULL) { 3641 if (bdrv_find_format(out_basefmt) == NULL) { 3642 error_report("Invalid format name: '%s'", out_basefmt); 3643 ret = -1; 3644 goto out; 3645 } 3646 } 3647 3648 /* For safe rebasing we need to compare old and new backing file */ 3649 if (!unsafe) { 3650 QDict *options = NULL; 3651 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs); 3652 3653 if (base_bs) { 3654 blk_old_backing = blk_new(qemu_get_aio_context(), 3655 BLK_PERM_CONSISTENT_READ, 3656 BLK_PERM_ALL); 3657 ret = blk_insert_bs(blk_old_backing, base_bs, 3658 &local_err); 3659 if (ret < 0) { 3660 error_reportf_err(local_err, 3661 "Could not reuse old backing file '%s': ", 3662 base_bs->filename); 3663 goto out; 3664 } 3665 } else { 3666 blk_old_backing = NULL; 3667 } 3668 3669 if (out_baseimg[0]) { 3670 const char *overlay_filename; 3671 char *out_real_path; 3672 3673 options = qdict_new(); 3674 if (out_basefmt) { 3675 qdict_put_str(options, "driver", out_basefmt); 3676 } 3677 if (force_share) { 3678 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true); 3679 } 3680 3681 bdrv_refresh_filename(bs); 3682 overlay_filename = bs->exact_filename[0] ? bs->exact_filename 3683 : bs->filename; 3684 out_real_path = 3685 bdrv_get_full_backing_filename_from_filename(overlay_filename, 3686 out_baseimg, 3687 &local_err); 3688 if (local_err) { 3689 qobject_unref(options); 3690 error_reportf_err(local_err, 3691 "Could not resolve backing filename: "); 3692 ret = -1; 3693 goto out; 3694 } 3695 3696 /* 3697 * Find out whether we rebase an image on top of a previous image 3698 * in its chain. 3699 */ 3700 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path); 3701 if (prefix_chain_bs) { 3702 qobject_unref(options); 3703 g_free(out_real_path); 3704 3705 blk_new_backing = blk_new(qemu_get_aio_context(), 3706 BLK_PERM_CONSISTENT_READ, 3707 BLK_PERM_ALL); 3708 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs, 3709 &local_err); 3710 if (ret < 0) { 3711 error_reportf_err(local_err, 3712 "Could not reuse backing file '%s': ", 3713 out_baseimg); 3714 goto out; 3715 } 3716 } else { 3717 blk_new_backing = blk_new_open(out_real_path, NULL, 3718 options, src_flags, &local_err); 3719 g_free(out_real_path); 3720 if (!blk_new_backing) { 3721 error_reportf_err(local_err, 3722 "Could not open new backing file '%s': ", 3723 out_baseimg); 3724 ret = -1; 3725 goto out; 3726 } 3727 } 3728 } 3729 } 3730 3731 /* 3732 * Check each unallocated cluster in the COW file. If it is unallocated, 3733 * accesses go to the backing file. We must therefore compare this cluster 3734 * in the old and new backing file, and if they differ we need to copy it 3735 * from the old backing file into the COW file. 3736 * 3737 * If qemu-img crashes during this step, no harm is done. The content of 3738 * the image is the same as the original one at any time. 3739 */ 3740 if (!unsafe) { 3741 int64_t size; 3742 int64_t old_backing_size = 0; 3743 int64_t new_backing_size = 0; 3744 uint64_t offset; 3745 int64_t n; 3746 float local_progress = 0; 3747 3748 buf_old = blk_blockalign(blk, IO_BUF_SIZE); 3749 buf_new = blk_blockalign(blk, IO_BUF_SIZE); 3750 3751 size = blk_getlength(blk); 3752 if (size < 0) { 3753 error_report("Could not get size of '%s': %s", 3754 filename, strerror(-size)); 3755 ret = -1; 3756 goto out; 3757 } 3758 if (blk_old_backing) { 3759 old_backing_size = blk_getlength(blk_old_backing); 3760 if (old_backing_size < 0) { 3761 char backing_name[PATH_MAX]; 3762 3763 bdrv_get_backing_filename(bs, backing_name, 3764 sizeof(backing_name)); 3765 error_report("Could not get size of '%s': %s", 3766 backing_name, strerror(-old_backing_size)); 3767 ret = -1; 3768 goto out; 3769 } 3770 } 3771 if (blk_new_backing) { 3772 new_backing_size = blk_getlength(blk_new_backing); 3773 if (new_backing_size < 0) { 3774 error_report("Could not get size of '%s': %s", 3775 out_baseimg, strerror(-new_backing_size)); 3776 ret = -1; 3777 goto out; 3778 } 3779 } 3780 3781 if (size != 0) { 3782 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE)); 3783 } 3784 3785 for (offset = 0; offset < size; offset += n) { 3786 bool buf_old_is_zero = false; 3787 3788 /* How many bytes can we handle with the next read? */ 3789 n = MIN(IO_BUF_SIZE, size - offset); 3790 3791 /* If the cluster is allocated, we don't need to take action */ 3792 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n); 3793 if (ret < 0) { 3794 error_report("error while reading image metadata: %s", 3795 strerror(-ret)); 3796 goto out; 3797 } 3798 if (ret) { 3799 continue; 3800 } 3801 3802 if (prefix_chain_bs) { 3803 /* 3804 * If cluster wasn't changed since prefix_chain, we don't need 3805 * to take action 3806 */ 3807 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs), 3808 prefix_chain_bs, false, 3809 offset, n, &n); 3810 if (ret < 0) { 3811 error_report("error while reading image metadata: %s", 3812 strerror(-ret)); 3813 goto out; 3814 } 3815 if (!ret) { 3816 continue; 3817 } 3818 } 3819 3820 /* 3821 * Read old and new backing file and take into consideration that 3822 * backing files may be smaller than the COW image. 3823 */ 3824 if (offset >= old_backing_size) { 3825 memset(buf_old, 0, n); 3826 buf_old_is_zero = true; 3827 } else { 3828 if (offset + n > old_backing_size) { 3829 n = old_backing_size - offset; 3830 } 3831 3832 ret = blk_pread(blk_old_backing, offset, n, buf_old, 0); 3833 if (ret < 0) { 3834 error_report("error while reading from old backing file"); 3835 goto out; 3836 } 3837 } 3838 3839 if (offset >= new_backing_size || !blk_new_backing) { 3840 memset(buf_new, 0, n); 3841 } else { 3842 if (offset + n > new_backing_size) { 3843 n = new_backing_size - offset; 3844 } 3845 3846 ret = blk_pread(blk_new_backing, offset, n, buf_new, 0); 3847 if (ret < 0) { 3848 error_report("error while reading from new backing file"); 3849 goto out; 3850 } 3851 } 3852 3853 /* If they differ, we need to write to the COW file */ 3854 uint64_t written = 0; 3855 3856 while (written < n) { 3857 int64_t pnum; 3858 3859 if (compare_buffers(buf_old + written, buf_new + written, 3860 n - written, &pnum)) 3861 { 3862 if (buf_old_is_zero) { 3863 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0); 3864 } else { 3865 ret = blk_pwrite(blk, offset + written, pnum, 3866 buf_old + written, 0); 3867 } 3868 if (ret < 0) { 3869 error_report("Error while writing to COW image: %s", 3870 strerror(-ret)); 3871 goto out; 3872 } 3873 } 3874 3875 written += pnum; 3876 } 3877 qemu_progress_print(local_progress, 100); 3878 } 3879 } 3880 3881 /* 3882 * Change the backing file. All clusters that are different from the old 3883 * backing file are overwritten in the COW file now, so the visible content 3884 * doesn't change when we switch the backing file. 3885 */ 3886 if (out_baseimg && *out_baseimg) { 3887 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt, 3888 true); 3889 } else { 3890 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false); 3891 } 3892 3893 if (ret == -ENOSPC) { 3894 error_report("Could not change the backing file to '%s': No " 3895 "space left in the file header", out_baseimg); 3896 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) { 3897 error_report("Could not change the backing file to '%s': backing " 3898 "format must be specified", out_baseimg); 3899 } else if (ret < 0) { 3900 error_report("Could not change the backing file to '%s': %s", 3901 out_baseimg, strerror(-ret)); 3902 } 3903 3904 qemu_progress_print(100, 0); 3905 /* 3906 * TODO At this point it is possible to check if any clusters that are 3907 * allocated in the COW file are the same in the backing file. If so, they 3908 * could be dropped from the COW file. Don't do this before switching the 3909 * backing file, in case of a crash this would lead to corruption. 3910 */ 3911 out: 3912 qemu_progress_end(); 3913 /* Cleanup */ 3914 if (!unsafe) { 3915 blk_unref(blk_old_backing); 3916 blk_unref(blk_new_backing); 3917 } 3918 qemu_vfree(buf_old); 3919 qemu_vfree(buf_new); 3920 3921 blk_unref(blk); 3922 if (ret) { 3923 return 1; 3924 } 3925 return 0; 3926 } 3927 3928 static int img_resize(int argc, char **argv) 3929 { 3930 Error *err = NULL; 3931 int c, ret, relative; 3932 const char *filename, *fmt, *size; 3933 int64_t n, total_size, current_size; 3934 bool quiet = false; 3935 BlockBackend *blk = NULL; 3936 PreallocMode prealloc = PREALLOC_MODE_OFF; 3937 QemuOpts *param; 3938 3939 static QemuOptsList resize_options = { 3940 .name = "resize_options", 3941 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head), 3942 .desc = { 3943 { 3944 .name = BLOCK_OPT_SIZE, 3945 .type = QEMU_OPT_SIZE, 3946 .help = "Virtual disk size" 3947 }, { 3948 /* end of list */ 3949 } 3950 }, 3951 }; 3952 bool image_opts = false; 3953 bool shrink = false; 3954 3955 /* Remove size from argv manually so that negative numbers are not treated 3956 * as options by getopt. */ 3957 if (argc < 3) { 3958 error_exit("Not enough arguments"); 3959 return 1; 3960 } 3961 3962 size = argv[--argc]; 3963 3964 /* Parse getopt arguments */ 3965 fmt = NULL; 3966 for(;;) { 3967 static const struct option long_options[] = { 3968 {"help", no_argument, 0, 'h'}, 3969 {"object", required_argument, 0, OPTION_OBJECT}, 3970 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 3971 {"preallocation", required_argument, 0, OPTION_PREALLOCATION}, 3972 {"shrink", no_argument, 0, OPTION_SHRINK}, 3973 {0, 0, 0, 0} 3974 }; 3975 c = getopt_long(argc, argv, ":f:hq", 3976 long_options, NULL); 3977 if (c == -1) { 3978 break; 3979 } 3980 switch(c) { 3981 case ':': 3982 missing_argument(argv[optind - 1]); 3983 break; 3984 case '?': 3985 unrecognized_option(argv[optind - 1]); 3986 break; 3987 case 'h': 3988 help(); 3989 break; 3990 case 'f': 3991 fmt = optarg; 3992 break; 3993 case 'q': 3994 quiet = true; 3995 break; 3996 case OPTION_OBJECT: 3997 user_creatable_process_cmdline(optarg); 3998 break; 3999 case OPTION_IMAGE_OPTS: 4000 image_opts = true; 4001 break; 4002 case OPTION_PREALLOCATION: 4003 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg, 4004 PREALLOC_MODE__MAX, NULL); 4005 if (prealloc == PREALLOC_MODE__MAX) { 4006 error_report("Invalid preallocation mode '%s'", optarg); 4007 return 1; 4008 } 4009 break; 4010 case OPTION_SHRINK: 4011 shrink = true; 4012 break; 4013 } 4014 } 4015 if (optind != argc - 1) { 4016 error_exit("Expecting image file name and size"); 4017 } 4018 filename = argv[optind++]; 4019 4020 /* Choose grow, shrink, or absolute resize mode */ 4021 switch (size[0]) { 4022 case '+': 4023 relative = 1; 4024 size++; 4025 break; 4026 case '-': 4027 relative = -1; 4028 size++; 4029 break; 4030 default: 4031 relative = 0; 4032 break; 4033 } 4034 4035 /* Parse size */ 4036 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort); 4037 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) { 4038 error_report_err(err); 4039 ret = -1; 4040 qemu_opts_del(param); 4041 goto out; 4042 } 4043 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0); 4044 qemu_opts_del(param); 4045 4046 blk = img_open(image_opts, filename, fmt, 4047 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet, 4048 false); 4049 if (!blk) { 4050 ret = -1; 4051 goto out; 4052 } 4053 4054 current_size = blk_getlength(blk); 4055 if (current_size < 0) { 4056 error_report("Failed to inquire current image length: %s", 4057 strerror(-current_size)); 4058 ret = -1; 4059 goto out; 4060 } 4061 4062 if (relative) { 4063 total_size = current_size + n * relative; 4064 } else { 4065 total_size = n; 4066 } 4067 if (total_size <= 0) { 4068 error_report("New image size must be positive"); 4069 ret = -1; 4070 goto out; 4071 } 4072 4073 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) { 4074 error_report("Preallocation can only be used for growing images"); 4075 ret = -1; 4076 goto out; 4077 } 4078 4079 if (total_size < current_size && !shrink) { 4080 error_report("Use the --shrink option to perform a shrink operation."); 4081 warn_report("Shrinking an image will delete all data beyond the " 4082 "shrunken image's end. Before performing such an " 4083 "operation, make sure there is no important data there."); 4084 ret = -1; 4085 goto out; 4086 } 4087 4088 /* 4089 * The user expects the image to have the desired size after 4090 * resizing, so pass @exact=true. It is of no use to report 4091 * success when the image has not actually been resized. 4092 */ 4093 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err); 4094 if (!ret) { 4095 qprintf(quiet, "Image resized.\n"); 4096 } else { 4097 error_report_err(err); 4098 } 4099 out: 4100 blk_unref(blk); 4101 if (ret) { 4102 return 1; 4103 } 4104 return 0; 4105 } 4106 4107 static void amend_status_cb(BlockDriverState *bs, 4108 int64_t offset, int64_t total_work_size, 4109 void *opaque) 4110 { 4111 qemu_progress_print(100.f * offset / total_work_size, 0); 4112 } 4113 4114 static int print_amend_option_help(const char *format) 4115 { 4116 BlockDriver *drv; 4117 4118 /* Find driver and parse its options */ 4119 drv = bdrv_find_format(format); 4120 if (!drv) { 4121 error_report("Unknown file format '%s'", format); 4122 return 1; 4123 } 4124 4125 if (!drv->bdrv_amend_options) { 4126 error_report("Format driver '%s' does not support option amendment", 4127 format); 4128 return 1; 4129 } 4130 4131 /* Every driver supporting amendment must have amend_opts */ 4132 assert(drv->amend_opts); 4133 4134 printf("Amend options for '%s':\n", format); 4135 qemu_opts_print_help(drv->amend_opts, false); 4136 return 0; 4137 } 4138 4139 static int img_amend(int argc, char **argv) 4140 { 4141 Error *err = NULL; 4142 int c, ret = 0; 4143 char *options = NULL; 4144 QemuOptsList *amend_opts = NULL; 4145 QemuOpts *opts = NULL; 4146 const char *fmt = NULL, *filename, *cache; 4147 int flags; 4148 bool writethrough; 4149 bool quiet = false, progress = false; 4150 BlockBackend *blk = NULL; 4151 BlockDriverState *bs = NULL; 4152 bool image_opts = false; 4153 bool force = false; 4154 4155 cache = BDRV_DEFAULT_CACHE; 4156 for (;;) { 4157 static const struct option long_options[] = { 4158 {"help", no_argument, 0, 'h'}, 4159 {"object", required_argument, 0, OPTION_OBJECT}, 4160 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 4161 {"force", no_argument, 0, OPTION_FORCE}, 4162 {0, 0, 0, 0} 4163 }; 4164 c = getopt_long(argc, argv, ":ho:f:t:pq", 4165 long_options, NULL); 4166 if (c == -1) { 4167 break; 4168 } 4169 4170 switch (c) { 4171 case ':': 4172 missing_argument(argv[optind - 1]); 4173 break; 4174 case '?': 4175 unrecognized_option(argv[optind - 1]); 4176 break; 4177 case 'h': 4178 help(); 4179 break; 4180 case 'o': 4181 if (accumulate_options(&options, optarg) < 0) { 4182 ret = -1; 4183 goto out_no_progress; 4184 } 4185 break; 4186 case 'f': 4187 fmt = optarg; 4188 break; 4189 case 't': 4190 cache = optarg; 4191 break; 4192 case 'p': 4193 progress = true; 4194 break; 4195 case 'q': 4196 quiet = true; 4197 break; 4198 case OPTION_OBJECT: 4199 user_creatable_process_cmdline(optarg); 4200 break; 4201 case OPTION_IMAGE_OPTS: 4202 image_opts = true; 4203 break; 4204 case OPTION_FORCE: 4205 force = true; 4206 break; 4207 } 4208 } 4209 4210 if (!options) { 4211 error_exit("Must specify options (-o)"); 4212 } 4213 4214 if (quiet) { 4215 progress = false; 4216 } 4217 qemu_progress_init(progress, 1.0); 4218 4219 filename = (optind == argc - 1) ? argv[argc - 1] : NULL; 4220 if (fmt && has_help_option(options)) { 4221 /* If a format is explicitly specified (and possibly no filename is 4222 * given), print option help here */ 4223 ret = print_amend_option_help(fmt); 4224 goto out; 4225 } 4226 4227 if (optind != argc - 1) { 4228 error_report("Expecting one image file name"); 4229 ret = -1; 4230 goto out; 4231 } 4232 4233 flags = BDRV_O_RDWR; 4234 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough); 4235 if (ret < 0) { 4236 error_report("Invalid cache option: %s", cache); 4237 goto out; 4238 } 4239 4240 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet, 4241 false); 4242 if (!blk) { 4243 ret = -1; 4244 goto out; 4245 } 4246 bs = blk_bs(blk); 4247 4248 fmt = bs->drv->format_name; 4249 4250 if (has_help_option(options)) { 4251 /* If the format was auto-detected, print option help here */ 4252 ret = print_amend_option_help(fmt); 4253 goto out; 4254 } 4255 4256 if (!bs->drv->bdrv_amend_options) { 4257 error_report("Format driver '%s' does not support option amendment", 4258 fmt); 4259 ret = -1; 4260 goto out; 4261 } 4262 4263 /* Every driver supporting amendment must have amend_opts */ 4264 assert(bs->drv->amend_opts); 4265 4266 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts); 4267 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort); 4268 if (!qemu_opts_do_parse(opts, options, NULL, &err)) { 4269 /* Try to parse options using the create options */ 4270 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts); 4271 qemu_opts_del(opts); 4272 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort); 4273 if (qemu_opts_do_parse(opts, options, NULL, NULL)) { 4274 error_append_hint(&err, 4275 "This option is only supported for image creation\n"); 4276 } 4277 4278 error_report_err(err); 4279 ret = -1; 4280 goto out; 4281 } 4282 4283 /* In case the driver does not call amend_status_cb() */ 4284 qemu_progress_print(0.f, 0); 4285 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err); 4286 qemu_progress_print(100.f, 0); 4287 if (ret < 0) { 4288 error_report_err(err); 4289 goto out; 4290 } 4291 4292 out: 4293 qemu_progress_end(); 4294 4295 out_no_progress: 4296 blk_unref(blk); 4297 qemu_opts_del(opts); 4298 qemu_opts_free(amend_opts); 4299 g_free(options); 4300 4301 if (ret) { 4302 return 1; 4303 } 4304 return 0; 4305 } 4306 4307 typedef struct BenchData { 4308 BlockBackend *blk; 4309 uint64_t image_size; 4310 bool write; 4311 int bufsize; 4312 int step; 4313 int nrreq; 4314 int n; 4315 int flush_interval; 4316 bool drain_on_flush; 4317 uint8_t *buf; 4318 QEMUIOVector *qiov; 4319 4320 int in_flight; 4321 bool in_flush; 4322 uint64_t offset; 4323 } BenchData; 4324 4325 static void bench_undrained_flush_cb(void *opaque, int ret) 4326 { 4327 if (ret < 0) { 4328 error_report("Failed flush request: %s", strerror(-ret)); 4329 exit(EXIT_FAILURE); 4330 } 4331 } 4332 4333 static void bench_cb(void *opaque, int ret) 4334 { 4335 BenchData *b = opaque; 4336 BlockAIOCB *acb; 4337 4338 if (ret < 0) { 4339 error_report("Failed request: %s", strerror(-ret)); 4340 exit(EXIT_FAILURE); 4341 } 4342 4343 if (b->in_flush) { 4344 /* Just finished a flush with drained queue: Start next requests */ 4345 assert(b->in_flight == 0); 4346 b->in_flush = false; 4347 } else if (b->in_flight > 0) { 4348 int remaining = b->n - b->in_flight; 4349 4350 b->n--; 4351 b->in_flight--; 4352 4353 /* Time for flush? Drain queue if requested, then flush */ 4354 if (b->flush_interval && remaining % b->flush_interval == 0) { 4355 if (!b->in_flight || !b->drain_on_flush) { 4356 BlockCompletionFunc *cb; 4357 4358 if (b->drain_on_flush) { 4359 b->in_flush = true; 4360 cb = bench_cb; 4361 } else { 4362 cb = bench_undrained_flush_cb; 4363 } 4364 4365 acb = blk_aio_flush(b->blk, cb, b); 4366 if (!acb) { 4367 error_report("Failed to issue flush request"); 4368 exit(EXIT_FAILURE); 4369 } 4370 } 4371 if (b->drain_on_flush) { 4372 return; 4373 } 4374 } 4375 } 4376 4377 while (b->n > b->in_flight && b->in_flight < b->nrreq) { 4378 int64_t offset = b->offset; 4379 /* blk_aio_* might look for completed I/Os and kick bench_cb 4380 * again, so make sure this operation is counted by in_flight 4381 * and b->offset is ready for the next submission. 4382 */ 4383 b->in_flight++; 4384 b->offset += b->step; 4385 b->offset %= b->image_size; 4386 if (b->write) { 4387 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b); 4388 } else { 4389 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b); 4390 } 4391 if (!acb) { 4392 error_report("Failed to issue request"); 4393 exit(EXIT_FAILURE); 4394 } 4395 } 4396 } 4397 4398 static int img_bench(int argc, char **argv) 4399 { 4400 int c, ret = 0; 4401 const char *fmt = NULL, *filename; 4402 bool quiet = false; 4403 bool image_opts = false; 4404 bool is_write = false; 4405 int count = 75000; 4406 int depth = 64; 4407 int64_t offset = 0; 4408 size_t bufsize = 4096; 4409 int pattern = 0; 4410 size_t step = 0; 4411 int flush_interval = 0; 4412 bool drain_on_flush = true; 4413 int64_t image_size; 4414 BlockBackend *blk = NULL; 4415 BenchData data = {}; 4416 int flags = 0; 4417 bool writethrough = false; 4418 struct timeval t1, t2; 4419 int i; 4420 bool force_share = false; 4421 size_t buf_size = 0; 4422 4423 for (;;) { 4424 static const struct option long_options[] = { 4425 {"help", no_argument, 0, 'h'}, 4426 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL}, 4427 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 4428 {"pattern", required_argument, 0, OPTION_PATTERN}, 4429 {"no-drain", no_argument, 0, OPTION_NO_DRAIN}, 4430 {"force-share", no_argument, 0, 'U'}, 4431 {0, 0, 0, 0} 4432 }; 4433 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options, 4434 NULL); 4435 if (c == -1) { 4436 break; 4437 } 4438 4439 switch (c) { 4440 case ':': 4441 missing_argument(argv[optind - 1]); 4442 break; 4443 case '?': 4444 unrecognized_option(argv[optind - 1]); 4445 break; 4446 case 'h': 4447 help(); 4448 break; 4449 case 'c': 4450 { 4451 unsigned long res; 4452 4453 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) { 4454 error_report("Invalid request count specified"); 4455 return 1; 4456 } 4457 count = res; 4458 break; 4459 } 4460 case 'd': 4461 { 4462 unsigned long res; 4463 4464 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) { 4465 error_report("Invalid queue depth specified"); 4466 return 1; 4467 } 4468 depth = res; 4469 break; 4470 } 4471 case 'f': 4472 fmt = optarg; 4473 break; 4474 case 'n': 4475 flags |= BDRV_O_NATIVE_AIO; 4476 break; 4477 case 'i': 4478 ret = bdrv_parse_aio(optarg, &flags); 4479 if (ret < 0) { 4480 error_report("Invalid aio option: %s", optarg); 4481 ret = -1; 4482 goto out; 4483 } 4484 break; 4485 case 'o': 4486 { 4487 offset = cvtnum("offset", optarg); 4488 if (offset < 0) { 4489 return 1; 4490 } 4491 break; 4492 } 4493 break; 4494 case 'q': 4495 quiet = true; 4496 break; 4497 case 's': 4498 { 4499 int64_t sval; 4500 4501 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX); 4502 if (sval < 0) { 4503 return 1; 4504 } 4505 4506 bufsize = sval; 4507 break; 4508 } 4509 case 'S': 4510 { 4511 int64_t sval; 4512 4513 sval = cvtnum_full("step_size", optarg, 0, INT_MAX); 4514 if (sval < 0) { 4515 return 1; 4516 } 4517 4518 step = sval; 4519 break; 4520 } 4521 case 't': 4522 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough); 4523 if (ret < 0) { 4524 error_report("Invalid cache mode"); 4525 ret = -1; 4526 goto out; 4527 } 4528 break; 4529 case 'w': 4530 flags |= BDRV_O_RDWR; 4531 is_write = true; 4532 break; 4533 case 'U': 4534 force_share = true; 4535 break; 4536 case OPTION_PATTERN: 4537 { 4538 unsigned long res; 4539 4540 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) { 4541 error_report("Invalid pattern byte specified"); 4542 return 1; 4543 } 4544 pattern = res; 4545 break; 4546 } 4547 case OPTION_FLUSH_INTERVAL: 4548 { 4549 unsigned long res; 4550 4551 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) { 4552 error_report("Invalid flush interval specified"); 4553 return 1; 4554 } 4555 flush_interval = res; 4556 break; 4557 } 4558 case OPTION_NO_DRAIN: 4559 drain_on_flush = false; 4560 break; 4561 case OPTION_IMAGE_OPTS: 4562 image_opts = true; 4563 break; 4564 } 4565 } 4566 4567 if (optind != argc - 1) { 4568 error_exit("Expecting one image file name"); 4569 } 4570 filename = argv[argc - 1]; 4571 4572 if (!is_write && flush_interval) { 4573 error_report("--flush-interval is only available in write tests"); 4574 ret = -1; 4575 goto out; 4576 } 4577 if (flush_interval && flush_interval < depth) { 4578 error_report("Flush interval can't be smaller than depth"); 4579 ret = -1; 4580 goto out; 4581 } 4582 4583 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet, 4584 force_share); 4585 if (!blk) { 4586 ret = -1; 4587 goto out; 4588 } 4589 4590 image_size = blk_getlength(blk); 4591 if (image_size < 0) { 4592 ret = image_size; 4593 goto out; 4594 } 4595 4596 data = (BenchData) { 4597 .blk = blk, 4598 .image_size = image_size, 4599 .bufsize = bufsize, 4600 .step = step ?: bufsize, 4601 .nrreq = depth, 4602 .n = count, 4603 .offset = offset, 4604 .write = is_write, 4605 .flush_interval = flush_interval, 4606 .drain_on_flush = drain_on_flush, 4607 }; 4608 printf("Sending %d %s requests, %d bytes each, %d in parallel " 4609 "(starting at offset %" PRId64 ", step size %d)\n", 4610 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq, 4611 data.offset, data.step); 4612 if (flush_interval) { 4613 printf("Sending flush every %d requests\n", flush_interval); 4614 } 4615 4616 buf_size = data.nrreq * data.bufsize; 4617 data.buf = blk_blockalign(blk, buf_size); 4618 memset(data.buf, pattern, data.nrreq * data.bufsize); 4619 4620 blk_register_buf(blk, data.buf, buf_size, &error_fatal); 4621 4622 data.qiov = g_new(QEMUIOVector, data.nrreq); 4623 for (i = 0; i < data.nrreq; i++) { 4624 qemu_iovec_init(&data.qiov[i], 1); 4625 qemu_iovec_add(&data.qiov[i], 4626 data.buf + i * data.bufsize, data.bufsize); 4627 } 4628 4629 gettimeofday(&t1, NULL); 4630 bench_cb(&data, 0); 4631 4632 while (data.n > 0) { 4633 main_loop_wait(false); 4634 } 4635 gettimeofday(&t2, NULL); 4636 4637 printf("Run completed in %3.3f seconds.\n", 4638 (t2.tv_sec - t1.tv_sec) 4639 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000)); 4640 4641 out: 4642 if (data.buf) { 4643 blk_unregister_buf(blk, data.buf, buf_size); 4644 } 4645 qemu_vfree(data.buf); 4646 blk_unref(blk); 4647 4648 if (ret) { 4649 return 1; 4650 } 4651 return 0; 4652 } 4653 4654 enum ImgBitmapAct { 4655 BITMAP_ADD, 4656 BITMAP_REMOVE, 4657 BITMAP_CLEAR, 4658 BITMAP_ENABLE, 4659 BITMAP_DISABLE, 4660 BITMAP_MERGE, 4661 }; 4662 typedef struct ImgBitmapAction { 4663 enum ImgBitmapAct act; 4664 const char *src; /* only used for merge */ 4665 QSIMPLEQ_ENTRY(ImgBitmapAction) next; 4666 } ImgBitmapAction; 4667 4668 static int img_bitmap(int argc, char **argv) 4669 { 4670 Error *err = NULL; 4671 int c, ret = 1; 4672 QemuOpts *opts = NULL; 4673 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL; 4674 const char *filename, *bitmap; 4675 BlockBackend *blk = NULL, *src = NULL; 4676 BlockDriverState *bs = NULL, *src_bs = NULL; 4677 bool image_opts = false; 4678 int64_t granularity = 0; 4679 bool add = false, merge = false; 4680 QSIMPLEQ_HEAD(, ImgBitmapAction) actions; 4681 ImgBitmapAction *act, *act_next; 4682 const char *op; 4683 int inactivate_ret; 4684 4685 QSIMPLEQ_INIT(&actions); 4686 4687 for (;;) { 4688 static const struct option long_options[] = { 4689 {"help", no_argument, 0, 'h'}, 4690 {"object", required_argument, 0, OPTION_OBJECT}, 4691 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 4692 {"add", no_argument, 0, OPTION_ADD}, 4693 {"remove", no_argument, 0, OPTION_REMOVE}, 4694 {"clear", no_argument, 0, OPTION_CLEAR}, 4695 {"enable", no_argument, 0, OPTION_ENABLE}, 4696 {"disable", no_argument, 0, OPTION_DISABLE}, 4697 {"merge", required_argument, 0, OPTION_MERGE}, 4698 {"granularity", required_argument, 0, 'g'}, 4699 {"source-file", required_argument, 0, 'b'}, 4700 {"source-format", required_argument, 0, 'F'}, 4701 {0, 0, 0, 0} 4702 }; 4703 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL); 4704 if (c == -1) { 4705 break; 4706 } 4707 4708 switch (c) { 4709 case ':': 4710 missing_argument(argv[optind - 1]); 4711 break; 4712 case '?': 4713 unrecognized_option(argv[optind - 1]); 4714 break; 4715 case 'h': 4716 help(); 4717 break; 4718 case 'b': 4719 src_filename = optarg; 4720 break; 4721 case 'f': 4722 fmt = optarg; 4723 break; 4724 case 'F': 4725 src_fmt = optarg; 4726 break; 4727 case 'g': 4728 granularity = cvtnum("granularity", optarg); 4729 if (granularity < 0) { 4730 return 1; 4731 } 4732 break; 4733 case OPTION_ADD: 4734 act = g_new0(ImgBitmapAction, 1); 4735 act->act = BITMAP_ADD; 4736 QSIMPLEQ_INSERT_TAIL(&actions, act, next); 4737 add = true; 4738 break; 4739 case OPTION_REMOVE: 4740 act = g_new0(ImgBitmapAction, 1); 4741 act->act = BITMAP_REMOVE; 4742 QSIMPLEQ_INSERT_TAIL(&actions, act, next); 4743 break; 4744 case OPTION_CLEAR: 4745 act = g_new0(ImgBitmapAction, 1); 4746 act->act = BITMAP_CLEAR; 4747 QSIMPLEQ_INSERT_TAIL(&actions, act, next); 4748 break; 4749 case OPTION_ENABLE: 4750 act = g_new0(ImgBitmapAction, 1); 4751 act->act = BITMAP_ENABLE; 4752 QSIMPLEQ_INSERT_TAIL(&actions, act, next); 4753 break; 4754 case OPTION_DISABLE: 4755 act = g_new0(ImgBitmapAction, 1); 4756 act->act = BITMAP_DISABLE; 4757 QSIMPLEQ_INSERT_TAIL(&actions, act, next); 4758 break; 4759 case OPTION_MERGE: 4760 act = g_new0(ImgBitmapAction, 1); 4761 act->act = BITMAP_MERGE; 4762 act->src = optarg; 4763 QSIMPLEQ_INSERT_TAIL(&actions, act, next); 4764 merge = true; 4765 break; 4766 case OPTION_OBJECT: 4767 user_creatable_process_cmdline(optarg); 4768 break; 4769 case OPTION_IMAGE_OPTS: 4770 image_opts = true; 4771 break; 4772 } 4773 } 4774 4775 if (QSIMPLEQ_EMPTY(&actions)) { 4776 error_report("Need at least one of --add, --remove, --clear, " 4777 "--enable, --disable, or --merge"); 4778 goto out; 4779 } 4780 4781 if (granularity && !add) { 4782 error_report("granularity only supported with --add"); 4783 goto out; 4784 } 4785 if (src_fmt && !src_filename) { 4786 error_report("-F only supported with -b"); 4787 goto out; 4788 } 4789 if (src_filename && !merge) { 4790 error_report("Merge bitmap source file only supported with " 4791 "--merge"); 4792 goto out; 4793 } 4794 4795 if (optind != argc - 2) { 4796 error_report("Expecting filename and bitmap name"); 4797 goto out; 4798 } 4799 4800 filename = argv[optind]; 4801 bitmap = argv[optind + 1]; 4802 4803 /* 4804 * No need to open backing chains; we will be manipulating bitmaps 4805 * directly in this image without reference to image contents. 4806 */ 4807 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING, 4808 false, false, false); 4809 if (!blk) { 4810 goto out; 4811 } 4812 bs = blk_bs(blk); 4813 if (src_filename) { 4814 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING, 4815 false, false, false); 4816 if (!src) { 4817 goto out; 4818 } 4819 src_bs = blk_bs(src); 4820 } else { 4821 src_bs = bs; 4822 } 4823 4824 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) { 4825 switch (act->act) { 4826 case BITMAP_ADD: 4827 qmp_block_dirty_bitmap_add(bs->node_name, bitmap, 4828 !!granularity, granularity, true, true, 4829 false, false, &err); 4830 op = "add"; 4831 break; 4832 case BITMAP_REMOVE: 4833 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err); 4834 op = "remove"; 4835 break; 4836 case BITMAP_CLEAR: 4837 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err); 4838 op = "clear"; 4839 break; 4840 case BITMAP_ENABLE: 4841 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err); 4842 op = "enable"; 4843 break; 4844 case BITMAP_DISABLE: 4845 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err); 4846 op = "disable"; 4847 break; 4848 case BITMAP_MERGE: 4849 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name, 4850 act->src, &err); 4851 op = "merge"; 4852 break; 4853 default: 4854 g_assert_not_reached(); 4855 } 4856 4857 if (err) { 4858 error_reportf_err(err, "Operation %s on bitmap %s failed: ", 4859 op, bitmap); 4860 goto out; 4861 } 4862 g_free(act); 4863 } 4864 4865 ret = 0; 4866 4867 out: 4868 /* 4869 * Manually inactivate the images first because this way we can know whether 4870 * an error occurred. blk_unref() doesn't tell us about failures. 4871 */ 4872 inactivate_ret = bdrv_inactivate_all(); 4873 if (inactivate_ret < 0) { 4874 error_report("Error while closing the image: %s", strerror(-inactivate_ret)); 4875 ret = 1; 4876 } 4877 4878 blk_unref(src); 4879 blk_unref(blk); 4880 qemu_opts_del(opts); 4881 return ret; 4882 } 4883 4884 #define C_BS 01 4885 #define C_COUNT 02 4886 #define C_IF 04 4887 #define C_OF 010 4888 #define C_SKIP 020 4889 4890 struct DdInfo { 4891 unsigned int flags; 4892 int64_t count; 4893 }; 4894 4895 struct DdIo { 4896 int bsz; /* Block size */ 4897 char *filename; 4898 uint8_t *buf; 4899 int64_t offset; 4900 }; 4901 4902 struct DdOpts { 4903 const char *name; 4904 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *); 4905 unsigned int flag; 4906 }; 4907 4908 static int img_dd_bs(const char *arg, 4909 struct DdIo *in, struct DdIo *out, 4910 struct DdInfo *dd) 4911 { 4912 int64_t res; 4913 4914 res = cvtnum_full("bs", arg, 1, INT_MAX); 4915 4916 if (res < 0) { 4917 return 1; 4918 } 4919 in->bsz = out->bsz = res; 4920 4921 return 0; 4922 } 4923 4924 static int img_dd_count(const char *arg, 4925 struct DdIo *in, struct DdIo *out, 4926 struct DdInfo *dd) 4927 { 4928 dd->count = cvtnum("count", arg); 4929 4930 if (dd->count < 0) { 4931 return 1; 4932 } 4933 4934 return 0; 4935 } 4936 4937 static int img_dd_if(const char *arg, 4938 struct DdIo *in, struct DdIo *out, 4939 struct DdInfo *dd) 4940 { 4941 in->filename = g_strdup(arg); 4942 4943 return 0; 4944 } 4945 4946 static int img_dd_of(const char *arg, 4947 struct DdIo *in, struct DdIo *out, 4948 struct DdInfo *dd) 4949 { 4950 out->filename = g_strdup(arg); 4951 4952 return 0; 4953 } 4954 4955 static int img_dd_skip(const char *arg, 4956 struct DdIo *in, struct DdIo *out, 4957 struct DdInfo *dd) 4958 { 4959 in->offset = cvtnum("skip", arg); 4960 4961 if (in->offset < 0) { 4962 return 1; 4963 } 4964 4965 return 0; 4966 } 4967 4968 static int img_dd(int argc, char **argv) 4969 { 4970 int ret = 0; 4971 char *arg = NULL; 4972 char *tmp; 4973 BlockDriver *drv = NULL, *proto_drv = NULL; 4974 BlockBackend *blk1 = NULL, *blk2 = NULL; 4975 QemuOpts *opts = NULL; 4976 QemuOptsList *create_opts = NULL; 4977 Error *local_err = NULL; 4978 bool image_opts = false; 4979 int c, i; 4980 const char *out_fmt = "raw"; 4981 const char *fmt = NULL; 4982 int64_t size = 0; 4983 int64_t out_pos, in_pos; 4984 bool force_share = false; 4985 struct DdInfo dd = { 4986 .flags = 0, 4987 .count = 0, 4988 }; 4989 struct DdIo in = { 4990 .bsz = 512, /* Block size is by default 512 bytes */ 4991 .filename = NULL, 4992 .buf = NULL, 4993 .offset = 0 4994 }; 4995 struct DdIo out = { 4996 .bsz = 512, 4997 .filename = NULL, 4998 .buf = NULL, 4999 .offset = 0 5000 }; 5001 5002 const struct DdOpts options[] = { 5003 { "bs", img_dd_bs, C_BS }, 5004 { "count", img_dd_count, C_COUNT }, 5005 { "if", img_dd_if, C_IF }, 5006 { "of", img_dd_of, C_OF }, 5007 { "skip", img_dd_skip, C_SKIP }, 5008 { NULL, NULL, 0 } 5009 }; 5010 const struct option long_options[] = { 5011 { "help", no_argument, 0, 'h'}, 5012 { "object", required_argument, 0, OPTION_OBJECT}, 5013 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 5014 { "force-share", no_argument, 0, 'U'}, 5015 { 0, 0, 0, 0 } 5016 }; 5017 5018 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) { 5019 if (c == EOF) { 5020 break; 5021 } 5022 switch (c) { 5023 case 'O': 5024 out_fmt = optarg; 5025 break; 5026 case 'f': 5027 fmt = optarg; 5028 break; 5029 case ':': 5030 missing_argument(argv[optind - 1]); 5031 break; 5032 case '?': 5033 unrecognized_option(argv[optind - 1]); 5034 break; 5035 case 'h': 5036 help(); 5037 break; 5038 case 'U': 5039 force_share = true; 5040 break; 5041 case OPTION_OBJECT: 5042 user_creatable_process_cmdline(optarg); 5043 break; 5044 case OPTION_IMAGE_OPTS: 5045 image_opts = true; 5046 break; 5047 } 5048 } 5049 5050 for (i = optind; i < argc; i++) { 5051 int j; 5052 arg = g_strdup(argv[i]); 5053 5054 tmp = strchr(arg, '='); 5055 if (tmp == NULL) { 5056 error_report("unrecognized operand %s", arg); 5057 ret = -1; 5058 goto out; 5059 } 5060 5061 *tmp++ = '\0'; 5062 5063 for (j = 0; options[j].name != NULL; j++) { 5064 if (!strcmp(arg, options[j].name)) { 5065 break; 5066 } 5067 } 5068 if (options[j].name == NULL) { 5069 error_report("unrecognized operand %s", arg); 5070 ret = -1; 5071 goto out; 5072 } 5073 5074 if (options[j].f(tmp, &in, &out, &dd) != 0) { 5075 ret = -1; 5076 goto out; 5077 } 5078 dd.flags |= options[j].flag; 5079 g_free(arg); 5080 arg = NULL; 5081 } 5082 5083 if (!(dd.flags & C_IF && dd.flags & C_OF)) { 5084 error_report("Must specify both input and output files"); 5085 ret = -1; 5086 goto out; 5087 } 5088 5089 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false, 5090 force_share); 5091 5092 if (!blk1) { 5093 ret = -1; 5094 goto out; 5095 } 5096 5097 drv = bdrv_find_format(out_fmt); 5098 if (!drv) { 5099 error_report("Unknown file format"); 5100 ret = -1; 5101 goto out; 5102 } 5103 proto_drv = bdrv_find_protocol(out.filename, true, &local_err); 5104 5105 if (!proto_drv) { 5106 error_report_err(local_err); 5107 ret = -1; 5108 goto out; 5109 } 5110 if (!drv->create_opts) { 5111 error_report("Format driver '%s' does not support image creation", 5112 drv->format_name); 5113 ret = -1; 5114 goto out; 5115 } 5116 if (!proto_drv->create_opts) { 5117 error_report("Protocol driver '%s' does not support image creation", 5118 proto_drv->format_name); 5119 ret = -1; 5120 goto out; 5121 } 5122 create_opts = qemu_opts_append(create_opts, drv->create_opts); 5123 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts); 5124 5125 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); 5126 5127 size = blk_getlength(blk1); 5128 if (size < 0) { 5129 error_report("Failed to get size for '%s'", in.filename); 5130 ret = -1; 5131 goto out; 5132 } 5133 5134 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz && 5135 dd.count * in.bsz < size) { 5136 size = dd.count * in.bsz; 5137 } 5138 5139 /* Overflow means the specified offset is beyond input image's size */ 5140 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz || 5141 size < in.bsz * in.offset)) { 5142 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort); 5143 } else { 5144 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 5145 size - in.bsz * in.offset, &error_abort); 5146 } 5147 5148 ret = bdrv_create(drv, out.filename, opts, &local_err); 5149 if (ret < 0) { 5150 error_reportf_err(local_err, 5151 "%s: error while creating output image: ", 5152 out.filename); 5153 ret = -1; 5154 goto out; 5155 } 5156 5157 /* TODO, we can't honour --image-opts for the target, 5158 * since it needs to be given in a format compatible 5159 * with the bdrv_create() call above which does not 5160 * support image-opts style. 5161 */ 5162 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR, 5163 false, false, false); 5164 5165 if (!blk2) { 5166 ret = -1; 5167 goto out; 5168 } 5169 5170 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz || 5171 size < in.offset * in.bsz)) { 5172 /* We give a warning if the skip option is bigger than the input 5173 * size and create an empty output disk image (i.e. like dd(1)). 5174 */ 5175 error_report("%s: cannot skip to specified offset", in.filename); 5176 in_pos = size; 5177 } else { 5178 in_pos = in.offset * in.bsz; 5179 } 5180 5181 in.buf = g_new(uint8_t, in.bsz); 5182 5183 for (out_pos = 0; in_pos < size; ) { 5184 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz; 5185 5186 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0); 5187 if (ret < 0) { 5188 error_report("error while reading from input image file: %s", 5189 strerror(-ret)); 5190 goto out; 5191 } 5192 in_pos += bytes; 5193 5194 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0); 5195 if (ret < 0) { 5196 error_report("error while writing to output image file: %s", 5197 strerror(-ret)); 5198 goto out; 5199 } 5200 out_pos += bytes; 5201 } 5202 5203 out: 5204 g_free(arg); 5205 qemu_opts_del(opts); 5206 qemu_opts_free(create_opts); 5207 blk_unref(blk1); 5208 blk_unref(blk2); 5209 g_free(in.filename); 5210 g_free(out.filename); 5211 g_free(in.buf); 5212 g_free(out.buf); 5213 5214 if (ret) { 5215 return 1; 5216 } 5217 return 0; 5218 } 5219 5220 static void dump_json_block_measure_info(BlockMeasureInfo *info) 5221 { 5222 GString *str; 5223 QObject *obj; 5224 Visitor *v = qobject_output_visitor_new(&obj); 5225 5226 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort); 5227 visit_complete(v, &obj); 5228 str = qobject_to_json_pretty(obj, true); 5229 assert(str != NULL); 5230 printf("%s\n", str->str); 5231 qobject_unref(obj); 5232 visit_free(v); 5233 g_string_free(str, true); 5234 } 5235 5236 static int img_measure(int argc, char **argv) 5237 { 5238 static const struct option long_options[] = { 5239 {"help", no_argument, 0, 'h'}, 5240 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS}, 5241 {"object", required_argument, 0, OPTION_OBJECT}, 5242 {"output", required_argument, 0, OPTION_OUTPUT}, 5243 {"size", required_argument, 0, OPTION_SIZE}, 5244 {"force-share", no_argument, 0, 'U'}, 5245 {0, 0, 0, 0} 5246 }; 5247 OutputFormat output_format = OFORMAT_HUMAN; 5248 BlockBackend *in_blk = NULL; 5249 BlockDriver *drv; 5250 const char *filename = NULL; 5251 const char *fmt = NULL; 5252 const char *out_fmt = "raw"; 5253 char *options = NULL; 5254 char *snapshot_name = NULL; 5255 bool force_share = false; 5256 QemuOpts *opts = NULL; 5257 QemuOpts *object_opts = NULL; 5258 QemuOpts *sn_opts = NULL; 5259 QemuOptsList *create_opts = NULL; 5260 bool image_opts = false; 5261 uint64_t img_size = UINT64_MAX; 5262 BlockMeasureInfo *info = NULL; 5263 Error *local_err = NULL; 5264 int ret = 1; 5265 int c; 5266 5267 while ((c = getopt_long(argc, argv, "hf:O:o:l:U", 5268 long_options, NULL)) != -1) { 5269 switch (c) { 5270 case '?': 5271 case 'h': 5272 help(); 5273 break; 5274 case 'f': 5275 fmt = optarg; 5276 break; 5277 case 'O': 5278 out_fmt = optarg; 5279 break; 5280 case 'o': 5281 if (accumulate_options(&options, optarg) < 0) { 5282 goto out; 5283 } 5284 break; 5285 case 'l': 5286 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) { 5287 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts, 5288 optarg, false); 5289 if (!sn_opts) { 5290 error_report("Failed in parsing snapshot param '%s'", 5291 optarg); 5292 goto out; 5293 } 5294 } else { 5295 snapshot_name = optarg; 5296 } 5297 break; 5298 case 'U': 5299 force_share = true; 5300 break; 5301 case OPTION_OBJECT: 5302 user_creatable_process_cmdline(optarg); 5303 break; 5304 case OPTION_IMAGE_OPTS: 5305 image_opts = true; 5306 break; 5307 case OPTION_OUTPUT: 5308 if (!strcmp(optarg, "json")) { 5309 output_format = OFORMAT_JSON; 5310 } else if (!strcmp(optarg, "human")) { 5311 output_format = OFORMAT_HUMAN; 5312 } else { 5313 error_report("--output must be used with human or json " 5314 "as argument."); 5315 goto out; 5316 } 5317 break; 5318 case OPTION_SIZE: 5319 { 5320 int64_t sval; 5321 5322 sval = cvtnum("image size", optarg); 5323 if (sval < 0) { 5324 goto out; 5325 } 5326 img_size = (uint64_t)sval; 5327 } 5328 break; 5329 } 5330 } 5331 5332 if (argc - optind > 1) { 5333 error_report("At most one filename argument is allowed."); 5334 goto out; 5335 } else if (argc - optind == 1) { 5336 filename = argv[optind]; 5337 } 5338 5339 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) { 5340 error_report("--image-opts, -f, and -l require a filename argument."); 5341 goto out; 5342 } 5343 if (filename && img_size != UINT64_MAX) { 5344 error_report("--size N cannot be used together with a filename."); 5345 goto out; 5346 } 5347 if (!filename && img_size == UINT64_MAX) { 5348 error_report("Either --size N or one filename must be specified."); 5349 goto out; 5350 } 5351 5352 if (filename) { 5353 in_blk = img_open(image_opts, filename, fmt, 0, 5354 false, false, force_share); 5355 if (!in_blk) { 5356 goto out; 5357 } 5358 5359 if (sn_opts) { 5360 bdrv_snapshot_load_tmp(blk_bs(in_blk), 5361 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID), 5362 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME), 5363 &local_err); 5364 } else if (snapshot_name != NULL) { 5365 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk), 5366 snapshot_name, &local_err); 5367 } 5368 if (local_err) { 5369 error_reportf_err(local_err, "Failed to load snapshot: "); 5370 goto out; 5371 } 5372 } 5373 5374 drv = bdrv_find_format(out_fmt); 5375 if (!drv) { 5376 error_report("Unknown file format '%s'", out_fmt); 5377 goto out; 5378 } 5379 if (!drv->create_opts) { 5380 error_report("Format driver '%s' does not support image creation", 5381 drv->format_name); 5382 goto out; 5383 } 5384 5385 create_opts = qemu_opts_append(create_opts, drv->create_opts); 5386 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts); 5387 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort); 5388 if (options) { 5389 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) { 5390 error_report_err(local_err); 5391 error_report("Invalid options for file format '%s'", out_fmt); 5392 goto out; 5393 } 5394 } 5395 if (img_size != UINT64_MAX) { 5396 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort); 5397 } 5398 5399 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err); 5400 if (local_err) { 5401 error_report_err(local_err); 5402 goto out; 5403 } 5404 5405 if (output_format == OFORMAT_HUMAN) { 5406 printf("required size: %" PRIu64 "\n", info->required); 5407 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated); 5408 if (info->has_bitmaps) { 5409 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps); 5410 } 5411 } else { 5412 dump_json_block_measure_info(info); 5413 } 5414 5415 ret = 0; 5416 5417 out: 5418 qapi_free_BlockMeasureInfo(info); 5419 qemu_opts_del(object_opts); 5420 qemu_opts_del(opts); 5421 qemu_opts_del(sn_opts); 5422 qemu_opts_free(create_opts); 5423 g_free(options); 5424 blk_unref(in_blk); 5425 return ret; 5426 } 5427 5428 static const img_cmd_t img_cmds[] = { 5429 #define DEF(option, callback, arg_string) \ 5430 { option, callback }, 5431 #include "qemu-img-cmds.h" 5432 #undef DEF 5433 { NULL, NULL, }, 5434 }; 5435 5436 int main(int argc, char **argv) 5437 { 5438 const img_cmd_t *cmd; 5439 const char *cmdname; 5440 int c; 5441 static const struct option long_options[] = { 5442 {"help", no_argument, 0, 'h'}, 5443 {"version", no_argument, 0, 'V'}, 5444 {"trace", required_argument, NULL, 'T'}, 5445 {0, 0, 0, 0} 5446 }; 5447 5448 #ifdef CONFIG_POSIX 5449 signal(SIGPIPE, SIG_IGN); 5450 #endif 5451 5452 socket_init(); 5453 error_init(argv[0]); 5454 module_call_init(MODULE_INIT_TRACE); 5455 qemu_init_exec_dir(argv[0]); 5456 5457 qemu_init_main_loop(&error_fatal); 5458 5459 qcrypto_init(&error_fatal); 5460 5461 module_call_init(MODULE_INIT_QOM); 5462 bdrv_init(); 5463 if (argc < 2) { 5464 error_exit("Not enough arguments"); 5465 } 5466 5467 qemu_add_opts(&qemu_source_opts); 5468 qemu_add_opts(&qemu_trace_opts); 5469 5470 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) { 5471 switch (c) { 5472 case ':': 5473 missing_argument(argv[optind - 1]); 5474 return 0; 5475 case '?': 5476 unrecognized_option(argv[optind - 1]); 5477 return 0; 5478 case 'h': 5479 help(); 5480 return 0; 5481 case 'V': 5482 printf(QEMU_IMG_VERSION); 5483 return 0; 5484 case 'T': 5485 trace_opt_parse(optarg); 5486 break; 5487 } 5488 } 5489 5490 cmdname = argv[optind]; 5491 5492 /* reset getopt_long scanning */ 5493 argc -= optind; 5494 if (argc < 1) { 5495 return 0; 5496 } 5497 argv += optind; 5498 qemu_reset_optind(); 5499 5500 if (!trace_init_backends()) { 5501 exit(1); 5502 } 5503 trace_init_file(); 5504 qemu_set_log(LOG_TRACE, &error_fatal); 5505 5506 /* find the command */ 5507 for (cmd = img_cmds; cmd->name != NULL; cmd++) { 5508 if (!strcmp(cmdname, cmd->name)) { 5509 return cmd->handler(argc, argv); 5510 } 5511 } 5512 5513 /* not found */ 5514 error_exit("Command not found: %s", cmdname); 5515 } 5516