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