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