qemu-img.c

   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 #include "qapi-visit.h"
  25 #include "qapi/qmp-output-visitor.h"
  26 #include "qapi/qmp/qerror.h"
  27 #include "qapi/qmp/qjson.h"
  28 #include "qemu-common.h"
  29 #include "qemu/option.h"
  30 #include "qemu/error-report.h"
  31 #include "qemu/osdep.h"
  32 #include "sysemu/sysemu.h"
  33 #include "sysemu/block-backend.h"
  34 #include "block/block_int.h"
  35 #include "block/blockjob.h"
  36 #include "block/qapi.h"
  37 #include <getopt.h>
  38
  39 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
  40                           ", Copyright (c) 2004-2008 Fabrice Bellard\n"
  41
  42 typedef struct img_cmd_t {
  43     const char *name;
  44     int (*handler)(int argc, char **argv);
  45 } img_cmd_t;
  46
  47 enum {
  48     OPTION_OUTPUT = 256,
  49     OPTION_BACKING_CHAIN = 257,
  50 };
  51
  52 typedef enum OutputFormat {
  53     OFORMAT_JSON,
  54     OFORMAT_HUMAN,
  55 } OutputFormat;
  56
  57 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
  58 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
  59 #define BDRV_DEFAULT_CACHE "writeback"
  60
  61 static void format_print(void *opaque, const char *name)
  62 {
  63     printf(" %s", name);
  64 }
  65
  66 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
  67 {
  68     va_list ap;
  69
  70     error_printf("qemu-img: ");
  71
  72     va_start(ap, fmt);
  73     error_vprintf(fmt, ap);
  74     va_end(ap);
  75
  76     error_printf("\nTry 'qemu-img --help' for more information\n");
  77     exit(EXIT_FAILURE);
  78 }
  79
  80 /* Please keep in synch with qemu-img.texi */
  81 static void QEMU_NORETURN help(void)
  82 {
  83     const char *help_msg =
  84            QEMU_IMG_VERSION
  85            "usage: qemu-img command [command options]\n"
  86            "QEMU disk image utility\n"
  87            "\n"
  88            "Command syntax:\n"
  89 #define DEF(option, callback, arg_string)        \
  90            "  " arg_string "\n"
  91 #include "qemu-img-cmds.h"
  92 #undef DEF
  93 #undef GEN_DOCS
  94            "\n"
  95            "Command parameters:\n"
  96            "  'filename' is a disk image filename\n"
  97            "  'fmt' is the disk image format. It is guessed automatically in most cases\n"
  98            "  'cache' is the cache mode used to write the output disk image, the valid\n"
  99            "    options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
 100            "    'directsync' and 'unsafe' (default for convert)\n"
 101            "  'src_cache' is the cache mode used to read input disk images, the valid\n"
 102            "    options are the same as for the 'cache' option\n"
 103            "  'size' is the disk image size in bytes. Optional suffixes\n"
 104            "    'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
 105            "    'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P)  are\n"
 106            "    supported. 'b' is ignored.\n"
 107            "  'output_filename' is the destination disk image filename\n"
 108            "  'output_fmt' is the destination format\n"
 109            "  'options' is a comma separated list of format specific options in a\n"
 110            "    name=value format. Use -o ? for an overview of the options supported by the\n"
 111            "    used format\n"
 112            "  'snapshot_param' is param used for internal snapshot, format\n"
 113            "    is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
 114            "    '[ID_OR_NAME]'\n"
 115            "  'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
 116            "    instead\n"
 117            "  '-c' indicates that target image must be compressed (qcow format only)\n"
 118            "  '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
 119            "       match exactly. The image doesn't need a working backing file before\n"
 120            "       rebasing in this case (useful for renaming the backing file)\n"
 121            "  '-h' with or without a command shows this help and lists the supported formats\n"
 122            "  '-p' show progress of command (only certain commands)\n"
 123            "  '-q' use Quiet mode - do not print any output (except errors)\n"
 124            "  '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
 125            "       contain only zeros for qemu-img to create a sparse image during\n"
 126            "       conversion. If the number of bytes is 0, the source will not be scanned for\n"
 127            "       unallocated or zero sectors, and the destination image will always be\n"
 128            "       fully allocated\n"
 129            "  '--output' takes the format in which the output must be done (human or json)\n"
 130            "  '-n' skips the target volume creation (useful if the volume is created\n"
 131            "       prior to running qemu-img)\n"
 132            "\n"
 133            "Parameters to check subcommand:\n"
 134            "  '-r' tries to repair any inconsistencies that are found during the check.\n"
 135            "       '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
 136            "       kinds of errors, with a higher risk of choosing the wrong fix or\n"
 137            "       hiding corruption that has already occurred.\n"
 138            "\n"
 139            "Parameters to snapshot subcommand:\n"
 140            "  'snapshot' is the name of the snapshot to create, apply or delete\n"
 141            "  '-a' applies a snapshot (revert disk to saved state)\n"
 142            "  '-c' creates a snapshot\n"
 143            "  '-d' deletes a snapshot\n"
 144            "  '-l' lists all snapshots in the given image\n"
 145            "\n"
 146            "Parameters to compare subcommand:\n"
 147            "  '-f' first image format\n"
 148            "  '-F' second image format\n"
 149            "  '-s' run in Strict mode - fail on different image size or sector allocation\n";
 150
 151     printf("%s\nSupported formats:", help_msg);
 152     bdrv_iterate_format(format_print, NULL);
 153     printf("\n");
 154     exit(EXIT_SUCCESS);
 155 }
 156
 157 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
 158 {
 159     int ret = 0;
 160     if (!quiet) {
 161         va_list args;
 162         va_start(args, fmt);
 163         ret = vprintf(fmt, args);
 164         va_end(args);
 165     }
 166     return ret;
 167 }
 168
 169
 170 static int print_block_option_help(const char *filename, const char *fmt)
 171 {
 172     BlockDriver *drv, *proto_drv;
 173     QemuOptsList *create_opts = NULL;
 174     Error *local_err = NULL;
 175
 176     /* Find driver and parse its options */
 177     drv = bdrv_find_format(fmt);
 178     if (!drv) {
 179         error_report("Unknown file format '%s'", fmt);
 180         return 1;
 181     }
 182
 183     create_opts = qemu_opts_append(create_opts, drv->create_opts);
 184     if (filename) {
 185         proto_drv = bdrv_find_protocol(filename, true, &local_err);
 186         if (!proto_drv) {
 187             error_report_err(local_err);
 188             qemu_opts_free(create_opts);
 189             return 1;
 190         }
 191         create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
 192     }
 193
 194     qemu_opts_print_help(create_opts);
 195     qemu_opts_free(create_opts);
 196     return 0;
 197 }
 198
 199 static BlockBackend *img_open(const char *id, const char *filename,
 200                               const char *fmt, int flags,
 201                               bool require_io, bool quiet)
 202 {
 203     BlockBackend *blk;
 204     BlockDriverState *bs;
 205     char password[256];
 206     Error *local_err = NULL;
 207     QDict *options = NULL;
 208
 209     if (fmt) {
 210         options = qdict_new();
 211         qdict_put(options, "driver", qstring_from_str(fmt));
 212     }
 213
 214     blk = blk_new_open(id, filename, NULL, options, flags, &local_err);
 215     if (!blk) {
 216         error_reportf_err(local_err, "Could not open '%s': ", filename);
 217         goto fail;
 218     }
 219
 220     bs = blk_bs(blk);
 221     if (bdrv_is_encrypted(bs) && require_io) {
 222         qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
 223         if (qemu_read_password(password, sizeof(password)) < 0) {
 224             error_report("No password given");
 225             goto fail;
 226         }
 227         if (bdrv_set_key(bs, password) < 0) {
 228             error_report("invalid password");
 229             goto fail;
 230         }
 231     }
 232     return blk;
 233 fail:
 234     blk_unref(blk);
 235     return NULL;
 236 }
 237
 238 static int add_old_style_options(const char *fmt, QemuOpts *opts,
 239                                  const char *base_filename,
 240                                  const char *base_fmt)
 241 {
 242     Error *err = NULL;
 243
 244     if (base_filename) {
 245         qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
 246         if (err) {
 247             error_report("Backing file not supported for file format '%s'",
 248                          fmt);
 249             error_free(err);
 250             return -1;
 251         }
 252     }
 253     if (base_fmt) {
 254         qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
 255         if (err) {
 256             error_report("Backing file format not supported for file "
 257                          "format '%s'", fmt);
 258             error_free(err);
 259             return -1;
 260         }
 261     }
 262     return 0;
 263 }
 264
 265 static int img_create(int argc, char **argv)
 266 {
 267     int c;
 268     uint64_t img_size = -1;
 269     const char *fmt = "raw";
 270     const char *base_fmt = NULL;
 271     const char *filename;
 272     const char *base_filename = NULL;
 273     char *options = NULL;
 274     Error *local_err = NULL;
 275     bool quiet = false;
 276
 277     for(;;) {
 278         c = getopt(argc, argv, "F:b:f:he6o:q");
 279         if (c == -1) {
 280             break;
 281         }
 282         switch(c) {
 283         case '?':
 284         case 'h':
 285             help();
 286             break;
 287         case 'F':
 288             base_fmt = optarg;
 289             break;
 290         case 'b':
 291             base_filename = optarg;
 292             break;
 293         case 'f':
 294             fmt = optarg;
 295             break;
 296         case 'e':
 297             error_report("option -e is deprecated, please use \'-o "
 298                   "encryption\' instead!");
 299             goto fail;
 300         case '6':
 301             error_report("option -6 is deprecated, please use \'-o "
 302                   "compat6\' instead!");
 303             goto fail;
 304         case 'o':
 305             if (!is_valid_option_list(optarg)) {
 306                 error_report("Invalid option list: %s", optarg);
 307                 goto fail;
 308             }
 309             if (!options) {
 310                 options = g_strdup(optarg);
 311             } else {
 312                 char *old_options = options;
 313                 options = g_strdup_printf("%s,%s", options, optarg);
 314                 g_free(old_options);
 315             }
 316             break;
 317         case 'q':
 318             quiet = true;
 319             break;
 320         }
 321     }
 322
 323     /* Get the filename */
 324     filename = (optind < argc) ? argv[optind] : NULL;
 325     if (options && has_help_option(options)) {
 326         g_free(options);
 327         return print_block_option_help(filename, fmt);
 328     }
 329
 330     if (optind >= argc) {
 331         error_exit("Expecting image file name");
 332     }
 333     optind++;
 334
 335     /* Get image size, if specified */
 336     if (optind < argc) {
 337         int64_t sval;
 338         char *end;
 339         sval = qemu_strtosz_suffix(argv[optind++], &end,
 340                                    QEMU_STRTOSZ_DEFSUFFIX_B);
 341         if (sval < 0 || *end) {
 342             if (sval == -ERANGE) {
 343                 error_report("Image size must be less than 8 EiB!");
 344             } else {
 345                 error_report("Invalid image size specified! You may use k, M, "
 346                       "G, T, P or E suffixes for ");
 347                 error_report("kilobytes, megabytes, gigabytes, terabytes, "
 348                              "petabytes and exabytes.");
 349             }
 350             goto fail;
 351         }
 352         img_size = (uint64_t)sval;
 353     }
 354     if (optind != argc) {
 355         error_exit("Unexpected argument: %s", argv[optind]);
 356     }
 357
 358     bdrv_img_create(filename, fmt, base_filename, base_fmt,
 359                     options, img_size, BDRV_O_FLAGS, &local_err, quiet);
 360     if (local_err) {
 361         error_reportf_err(local_err, "%s: ", filename);
 362         goto fail;
 363     }
 364
 365     g_free(options);
 366     return 0;
 367
 368 fail:
 369     g_free(options);
 370     return 1;
 371 }
 372
 373 static void dump_json_image_check(ImageCheck *check, bool quiet)
 374 {
 375     Error *local_err = NULL;
 376     QString *str;
 377     QmpOutputVisitor *ov = qmp_output_visitor_new();
 378     QObject *obj;
 379     visit_type_ImageCheck(qmp_output_get_visitor(ov),
 380                           &check, NULL, &local_err);
 381     obj = qmp_output_get_qobject(ov);
 382     str = qobject_to_json_pretty(obj);
 383     assert(str != NULL);
 384     qprintf(quiet, "%s\n", qstring_get_str(str));
 385     qobject_decref(obj);
 386     qmp_output_visitor_cleanup(ov);
 387     QDECREF(str);
 388 }
 389
 390 static void dump_human_image_check(ImageCheck *check, bool quiet)
 391 {
 392     if (!(check->corruptions || check->leaks || check->check_errors)) {
 393         qprintf(quiet, "No errors were found on the image.\n");
 394     } else {
 395         if (check->corruptions) {
 396             qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
 397                     "Data may be corrupted, or further writes to the image "
 398                     "may corrupt it.\n",
 399                     check->corruptions);
 400         }
 401
 402         if (check->leaks) {
 403             qprintf(quiet,
 404                     "\n%" PRId64 " leaked clusters were found on the image.\n"
 405                     "This means waste of disk space, but no harm to data.\n",
 406                     check->leaks);
 407         }
 408
 409         if (check->check_errors) {
 410             qprintf(quiet,
 411                     "\n%" PRId64
 412                     " internal errors have occurred during the check.\n",
 413                     check->check_errors);
 414         }
 415     }
 416
 417     if (check->total_clusters != 0 && check->allocated_clusters != 0) {
 418         qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
 419                 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
 420                 check->allocated_clusters, check->total_clusters,
 421                 check->allocated_clusters * 100.0 / check->total_clusters,
 422                 check->fragmented_clusters * 100.0 / check->allocated_clusters,
 423                 check->compressed_clusters * 100.0 /
 424                 check->allocated_clusters);
 425     }
 426
 427     if (check->image_end_offset) {
 428         qprintf(quiet,
 429                 "Image end offset: %" PRId64 "\n", check->image_end_offset);
 430     }
 431 }
 432
 433 static int collect_image_check(BlockDriverState *bs,
 434                    ImageCheck *check,
 435                    const char *filename,
 436                    const char *fmt,
 437                    int fix)
 438 {
 439     int ret;
 440     BdrvCheckResult result;
 441
 442     ret = bdrv_check(bs, &result, fix);
 443     if (ret < 0) {
 444         return ret;
 445     }
 446
 447     check->filename                 = g_strdup(filename);
 448     check->format                   = g_strdup(bdrv_get_format_name(bs));
 449     check->check_errors             = result.check_errors;
 450     check->corruptions              = result.corruptions;
 451     check->has_corruptions          = result.corruptions != 0;
 452     check->leaks                    = result.leaks;
 453     check->has_leaks                = result.leaks != 0;
 454     check->corruptions_fixed        = result.corruptions_fixed;
 455     check->has_corruptions_fixed    = result.corruptions != 0;
 456     check->leaks_fixed              = result.leaks_fixed;
 457     check->has_leaks_fixed          = result.leaks != 0;
 458     check->image_end_offset         = result.image_end_offset;
 459     check->has_image_end_offset     = result.image_end_offset != 0;
 460     check->total_clusters           = result.bfi.total_clusters;
 461     check->has_total_clusters       = result.bfi.total_clusters != 0;
 462     check->allocated_clusters       = result.bfi.allocated_clusters;
 463     check->has_allocated_clusters   = result.bfi.allocated_clusters != 0;
 464     check->fragmented_clusters      = result.bfi.fragmented_clusters;
 465     check->has_fragmented_clusters  = result.bfi.fragmented_clusters != 0;
 466     check->compressed_clusters      = result.bfi.compressed_clusters;
 467     check->has_compressed_clusters  = result.bfi.compressed_clusters != 0;
 468
 469     return 0;
 470 }
 471
 472 /*
 473  * Checks an image for consistency. Exit codes:
 474  *
 475  *  0 - Check completed, image is good
 476  *  1 - Check not completed because of internal errors
 477  *  2 - Check completed, image is corrupted
 478  *  3 - Check completed, image has leaked clusters, but is good otherwise
 479  * 63 - Checks are not supported by the image format
 480  */
 481 static int img_check(int argc, char **argv)
 482 {
 483     int c, ret;
 484     OutputFormat output_format = OFORMAT_HUMAN;
 485     const char *filename, *fmt, *output, *cache;
 486     BlockBackend *blk;
 487     BlockDriverState *bs;
 488     int fix = 0;
 489     int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
 490     ImageCheck *check;
 491     bool quiet = false;
 492
 493     fmt = NULL;
 494     output = NULL;
 495     cache = BDRV_DEFAULT_CACHE;
 496     for(;;) {
 497         int option_index = 0;
 498         static const struct option long_options[] = {
 499             {"help", no_argument, 0, 'h'},
 500             {"format", required_argument, 0, 'f'},
 501             {"repair", required_argument, 0, 'r'},
 502             {"output", required_argument, 0, OPTION_OUTPUT},
 503             {0, 0, 0, 0}
 504         };
 505         c = getopt_long(argc, argv, "hf:r:T:q",
 506                         long_options, &option_index);
 507         if (c == -1) {
 508             break;
 509         }
 510         switch(c) {
 511         case '?':
 512         case 'h':
 513             help();
 514             break;
 515         case 'f':
 516             fmt = optarg;
 517             break;
 518         case 'r':
 519             flags |= BDRV_O_RDWR;
 520
 521             if (!strcmp(optarg, "leaks")) {
 522                 fix = BDRV_FIX_LEAKS;
 523             } else if (!strcmp(optarg, "all")) {
 524                 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
 525             } else {
 526                 error_exit("Unknown option value for -r "
 527                            "(expecting 'leaks' or 'all'): %s", optarg);
 528             }
 529             break;
 530         case OPTION_OUTPUT:
 531             output = optarg;
 532             break;
 533         case 'T':
 534             cache = optarg;
 535             break;
 536         case 'q':
 537             quiet = true;
 538             break;
 539         }
 540     }
 541     if (optind != argc - 1) {
 542         error_exit("Expecting one image file name");
 543     }
 544     filename = argv[optind++];
 545
 546     if (output && !strcmp(output, "json")) {
 547         output_format = OFORMAT_JSON;
 548     } else if (output && !strcmp(output, "human")) {
 549         output_format = OFORMAT_HUMAN;
 550     } else if (output) {
 551         error_report("--output must be used with human or json as argument.");
 552         return 1;
 553     }
 554
 555     ret = bdrv_parse_cache_flags(cache, &flags);
 556     if (ret < 0) {
 557         error_report("Invalid source cache option: %s", cache);
 558         return 1;
 559     }
 560
 561     blk = img_open("image", filename, fmt, flags, true, quiet);
 562     if (!blk) {
 563         return 1;
 564     }
 565     bs = blk_bs(blk);
 566
 567     check = g_new0(ImageCheck, 1);
 568     ret = collect_image_check(bs, check, filename, fmt, fix);
 569
 570     if (ret == -ENOTSUP) {
 571         error_report("This image format does not support checks");
 572         ret = 63;
 573         goto fail;
 574     }
 575
 576     if (check->corruptions_fixed || check->leaks_fixed) {
 577         int corruptions_fixed, leaks_fixed;
 578
 579         leaks_fixed         = check->leaks_fixed;
 580         corruptions_fixed   = check->corruptions_fixed;
 581
 582         if (output_format == OFORMAT_HUMAN) {
 583             qprintf(quiet,
 584                     "The following inconsistencies were found and repaired:\n\n"
 585                     "    %" PRId64 " leaked clusters\n"
 586                     "    %" PRId64 " corruptions\n\n"
 587                     "Double checking the fixed image now...\n",
 588                     check->leaks_fixed,
 589                     check->corruptions_fixed);
 590         }
 591
 592         ret = collect_image_check(bs, check, filename, fmt, 0);
 593
 594         check->leaks_fixed          = leaks_fixed;
 595         check->corruptions_fixed    = corruptions_fixed;
 596     }
 597
 598     if (!ret) {
 599         switch (output_format) {
 600         case OFORMAT_HUMAN:
 601             dump_human_image_check(check, quiet);
 602             break;
 603         case OFORMAT_JSON:
 604             dump_json_image_check(check, quiet);
 605             break;
 606         }
 607     }
 608
 609     if (ret || check->check_errors) {
 610         if (ret) {
 611             error_report("Check failed: %s", strerror(-ret));
 612         } else {
 613             error_report("Check failed");
 614         }
 615         ret = 1;
 616         goto fail;
 617     }
 618
 619     if (check->corruptions) {
 620         ret = 2;
 621     } else if (check->leaks) {
 622         ret = 3;
 623     } else {
 624         ret = 0;
 625     }
 626
 627 fail:
 628     qapi_free_ImageCheck(check);
 629     blk_unref(blk);
 630     return ret;
 631 }
 632
 633 typedef struct CommonBlockJobCBInfo {
 634     BlockDriverState *bs;
 635     Error **errp;
 636 } CommonBlockJobCBInfo;
 637
 638 static void common_block_job_cb(void *opaque, int ret)
 639 {
 640     CommonBlockJobCBInfo *cbi = opaque;
 641
 642     if (ret < 0) {
 643         error_setg_errno(cbi->errp, -ret, "Block job failed");
 644     }
 645 }
 646
 647 static void run_block_job(BlockJob *job, Error **errp)
 648 {
 649     AioContext *aio_context = bdrv_get_aio_context(job->bs);
 650
 651     do {
 652         aio_poll(aio_context, true);
 653         qemu_progress_print(job->len ?
 654                             ((float)job->offset / job->len * 100.f) : 0.0f, 0);
 655     } while (!job->ready);
 656
 657     block_job_complete_sync(job, errp);
 658
 659     /* A block job may finish instantaneously without publishing any progress,
 660      * so just signal completion here */
 661     qemu_progress_print(100.f, 0);
 662 }
 663
 664 static int img_commit(int argc, char **argv)
 665 {
 666     int c, ret, flags;
 667     const char *filename, *fmt, *cache, *base;
 668     BlockBackend *blk;
 669     BlockDriverState *bs, *base_bs;
 670     bool progress = false, quiet = false, drop = false;
 671     Error *local_err = NULL;
 672     CommonBlockJobCBInfo cbi;
 673
 674     fmt = NULL;
 675     cache = BDRV_DEFAULT_CACHE;
 676     base = NULL;
 677     for(;;) {
 678         c = getopt(argc, argv, "f:ht:b:dpq");
 679         if (c == -1) {
 680             break;
 681         }
 682         switch(c) {
 683         case '?':
 684         case 'h':
 685             help();
 686             break;
 687         case 'f':
 688             fmt = optarg;
 689             break;
 690         case 't':
 691             cache = optarg;
 692             break;
 693         case 'b':
 694             base = optarg;
 695             /* -b implies -d */
 696             drop = true;
 697             break;
 698         case 'd':
 699             drop = true;
 700             break;
 701         case 'p':
 702             progress = true;
 703             break;
 704         case 'q':
 705             quiet = true;
 706             break;
 707         }
 708     }
 709
 710     /* Progress is not shown in Quiet mode */
 711     if (quiet) {
 712         progress = false;
 713     }
 714
 715     if (optind != argc - 1) {
 716         error_exit("Expecting one image file name");
 717     }
 718     filename = argv[optind++];
 719
 720     flags = BDRV_O_RDWR | BDRV_O_UNMAP;
 721     ret = bdrv_parse_cache_flags(cache, &flags);
 722     if (ret < 0) {
 723         error_report("Invalid cache option: %s", cache);
 724         return 1;
 725     }
 726
 727     blk = img_open("image", filename, fmt, flags, true, quiet);
 728     if (!blk) {
 729         return 1;
 730     }
 731     bs = blk_bs(blk);
 732
 733     qemu_progress_init(progress, 1.f);
 734     qemu_progress_print(0.f, 100);
 735
 736     if (base) {
 737         base_bs = bdrv_find_backing_image(bs, base);
 738         if (!base_bs) {
 739             error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
 740             goto done;
 741         }
 742     } else {
 743         /* This is different from QMP, which by default uses the deepest file in
 744          * the backing chain (i.e., the very base); however, the traditional
 745          * behavior of qemu-img commit is using the immediate backing file. */
 746         base_bs = backing_bs(bs);
 747         if (!base_bs) {
 748             error_setg(&local_err, "Image does not have a backing file");
 749             goto done;
 750         }
 751     }
 752
 753     cbi = (CommonBlockJobCBInfo){
 754         .errp = &local_err,
 755         .bs   = bs,
 756     };
 757
 758     commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
 759                         common_block_job_cb, &cbi, &local_err);
 760     if (local_err) {
 761         goto done;
 762     }
 763
 764     /* When the block job completes, the BlockBackend reference will point to
 765      * the old backing file. In order to avoid that the top image is already
 766      * deleted, so we can still empty it afterwards, increment the reference
 767      * counter here preemptively. */
 768     if (!drop) {
 769         bdrv_ref(bs);
 770     }
 771
 772     run_block_job(bs->job, &local_err);
 773     if (local_err) {
 774         goto unref_backing;
 775     }
 776
 777     if (!drop && bs->drv->bdrv_make_empty) {
 778         ret = bs->drv->bdrv_make_empty(bs);
 779         if (ret) {
 780             error_setg_errno(&local_err, -ret, "Could not empty %s",
 781                              filename);
 782             goto unref_backing;
 783         }
 784     }
 785
 786 unref_backing:
 787     if (!drop) {
 788         bdrv_unref(bs);
 789     }
 790
 791 done:
 792     qemu_progress_end();
 793
 794     blk_unref(blk);
 795
 796     if (local_err) {
 797         error_report_err(local_err);
 798         return 1;
 799     }
 800
 801     qprintf(quiet, "Image committed.\n");
 802     return 0;
 803 }
 804
 805 /*
 806  * Returns true iff the first sector pointed to by 'buf' contains at least
 807  * a non-NUL byte.
 808  *
 809  * 'pnum' is set to the number of sectors (including and immediately following
 810  * the first one) that are known to be in the same allocated/unallocated state.
 811  */
 812 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
 813 {
 814     bool is_zero;
 815     int i;
 816
 817     if (n <= 0) {
 818         *pnum = 0;
 819         return 0;
 820     }
 821     is_zero = buffer_is_zero(buf, 512);
 822     for(i = 1; i < n; i++) {
 823         buf += 512;
 824         if (is_zero != buffer_is_zero(buf, 512)) {
 825             break;
 826         }
 827     }
 828     *pnum = i;
 829     return !is_zero;
 830 }
 831
 832 /*
 833  * Like is_allocated_sectors, but if the buffer starts with a used sector,
 834  * up to 'min' consecutive sectors containing zeros are ignored. This avoids
 835  * breaking up write requests for only small sparse areas.
 836  */
 837 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
 838     int min)
 839 {
 840     int ret;
 841     int num_checked, num_used;
 842
 843     if (n < min) {
 844         min = n;
 845     }
 846
 847     ret = is_allocated_sectors(buf, n, pnum);
 848     if (!ret) {
 849         return ret;
 850     }
 851
 852     num_used = *pnum;
 853     buf += BDRV_SECTOR_SIZE * *pnum;
 854     n -= *pnum;
 855     num_checked = num_used;
 856
 857     while (n > 0) {
 858         ret = is_allocated_sectors(buf, n, pnum);
 859
 860         buf += BDRV_SECTOR_SIZE * *pnum;
 861         n -= *pnum;
 862         num_checked += *pnum;
 863         if (ret) {
 864             num_used = num_checked;
 865         } else if (*pnum >= min) {
 866             break;
 867         }
 868     }
 869
 870     *pnum = num_used;
 871     return 1;
 872 }
 873
 874 /*
 875  * Compares two buffers sector by sector. Returns 0 if the first sector of both
 876  * buffers matches, non-zero otherwise.
 877  *
 878  * pnum is set to the number of sectors (including and immediately following
 879  * the first one) that are known to have the same comparison result
 880  */
 881 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
 882     int *pnum)
 883 {
 884     bool res;
 885     int i;
 886
 887     if (n <= 0) {
 888         *pnum = 0;
 889         return 0;
 890     }
 891
 892     res = !!memcmp(buf1, buf2, 512);
 893     for(i = 1; i < n; i++) {
 894         buf1 += 512;
 895         buf2 += 512;
 896
 897         if (!!memcmp(buf1, buf2, 512) != res) {
 898             break;
 899         }
 900     }
 901
 902     *pnum = i;
 903     return res;
 904 }
 905
 906 #define IO_BUF_SIZE (2 * 1024 * 1024)
 907
 908 static int64_t sectors_to_bytes(int64_t sectors)
 909 {
 910     return sectors << BDRV_SECTOR_BITS;
 911 }
 912
 913 static int64_t sectors_to_process(int64_t total, int64_t from)
 914 {
 915     return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
 916 }
 917
 918 /*
 919  * Check if passed sectors are empty (not allocated or contain only 0 bytes)
 920  *
 921  * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
 922  * data and negative value on error.
 923  *
 924  * @param blk:  BlockBackend for the image
 925  * @param sect_num: Number of first sector to check
 926  * @param sect_count: Number of sectors to check
 927  * @param filename: Name of disk file we are checking (logging purpose)
 928  * @param buffer: Allocated buffer for storing read data
 929  * @param quiet: Flag for quiet mode
 930  */
 931 static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
 932                                int sect_count, const char *filename,
 933                                uint8_t *buffer, bool quiet)
 934 {
 935     int pnum, ret = 0;
 936     ret = blk_read(blk, sect_num, buffer, sect_count);
 937     if (ret < 0) {
 938         error_report("Error while reading offset %" PRId64 " of %s: %s",
 939                      sectors_to_bytes(sect_num), filename, strerror(-ret));
 940         return ret;
 941     }
 942     ret = is_allocated_sectors(buffer, sect_count, &pnum);
 943     if (ret || pnum != sect_count) {
 944         qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
 945                 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
 946         return 1;
 947     }
 948
 949     return 0;
 950 }
 951
 952 /*
 953  * Compares two images. Exit codes:
 954  *
 955  * 0 - Images are identical
 956  * 1 - Images differ
 957  * >1 - Error occurred
 958  */
 959 static int img_compare(int argc, char **argv)
 960 {
 961     const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
 962     BlockBackend *blk1, *blk2;
 963     BlockDriverState *bs1, *bs2;
 964     int64_t total_sectors1, total_sectors2;
 965     uint8_t *buf1 = NULL, *buf2 = NULL;
 966     int pnum1, pnum2;
 967     int allocated1, allocated2;
 968     int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
 969     bool progress = false, quiet = false, strict = false;
 970     int flags;
 971     int64_t total_sectors;
 972     int64_t sector_num = 0;
 973     int64_t nb_sectors;
 974     int c, pnum;
 975     uint64_t progress_base;
 976
 977     cache = BDRV_DEFAULT_CACHE;
 978     for (;;) {
 979         c = getopt(argc, argv, "hf:F:T:pqs");
 980         if (c == -1) {
 981             break;
 982         }
 983         switch (c) {
 984         case '?':
 985         case 'h':
 986             help();
 987             break;
 988         case 'f':
 989             fmt1 = optarg;
 990             break;
 991         case 'F':
 992             fmt2 = optarg;
 993             break;
 994         case 'T':
 995             cache = optarg;
 996             break;
 997         case 'p':
 998             progress = true;
 999             break;
1000         case 'q':
1001             quiet = true;
1002             break;
1003         case 's':
1004             strict = true;
1005             break;
1006         }
1007     }
1008
1009     /* Progress is not shown in Quiet mode */
1010     if (quiet) {
1011         progress = false;
1012     }
1013
1014
1015     if (optind != argc - 2) {
1016         error_exit("Expecting two image file names");
1017     }
1018     filename1 = argv[optind++];
1019     filename2 = argv[optind++];
1020
1021     /* Initialize before goto out */
1022     qemu_progress_init(progress, 2.0);
1023
1024     flags = BDRV_O_FLAGS;
1025     ret = bdrv_parse_cache_flags(cache, &flags);
1026     if (ret < 0) {
1027         error_report("Invalid source cache option: %s", cache);
1028         ret = 2;
1029         goto out3;
1030     }
1031
1032     blk1 = img_open("image_1", filename1, fmt1, flags, true, quiet);
1033     if (!blk1) {
1034         ret = 2;
1035         goto out3;
1036     }
1037     bs1 = blk_bs(blk1);
1038
1039     blk2 = img_open("image_2", filename2, fmt2, flags, true, quiet);
1040     if (!blk2) {
1041         ret = 2;
1042         goto out2;
1043     }
1044     bs2 = blk_bs(blk2);
1045
1046     buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1047     buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1048     total_sectors1 = blk_nb_sectors(blk1);
1049     if (total_sectors1 < 0) {
1050         error_report("Can't get size of %s: %s",
1051                      filename1, strerror(-total_sectors1));
1052         ret = 4;
1053         goto out;
1054     }
1055     total_sectors2 = blk_nb_sectors(blk2);
1056     if (total_sectors2 < 0) {
1057         error_report("Can't get size of %s: %s",
1058                      filename2, strerror(-total_sectors2));
1059         ret = 4;
1060         goto out;
1061     }
1062     total_sectors = MIN(total_sectors1, total_sectors2);
1063     progress_base = MAX(total_sectors1, total_sectors2);
1064
1065     qemu_progress_print(0, 100);
1066
1067     if (strict && total_sectors1 != total_sectors2) {
1068         ret = 1;
1069         qprintf(quiet, "Strict mode: Image size mismatch!\n");
1070         goto out;
1071     }
1072
1073     for (;;) {
1074         nb_sectors = sectors_to_process(total_sectors, sector_num);
1075         if (nb_sectors <= 0) {
1076             break;
1077         }
1078         allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1079                                              &pnum1);
1080         if (allocated1 < 0) {
1081             ret = 3;
1082             error_report("Sector allocation test failed for %s", filename1);
1083             goto out;
1084         }
1085
1086         allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1087                                              &pnum2);
1088         if (allocated2 < 0) {
1089             ret = 3;
1090             error_report("Sector allocation test failed for %s", filename2);
1091             goto out;
1092         }
1093         nb_sectors = MIN(pnum1, pnum2);
1094
1095         if (allocated1 == allocated2) {
1096             if (allocated1) {
1097                 ret = blk_read(blk1, sector_num, buf1, nb_sectors);
1098                 if (ret < 0) {
1099                     error_report("Error while reading offset %" PRId64 " of %s:"
1100                                  " %s", sectors_to_bytes(sector_num), filename1,
1101                                  strerror(-ret));
1102                     ret = 4;
1103                     goto out;
1104                 }
1105                 ret = blk_read(blk2, sector_num, buf2, nb_sectors);
1106                 if (ret < 0) {
1107                     error_report("Error while reading offset %" PRId64
1108                                  " of %s: %s", sectors_to_bytes(sector_num),
1109                                  filename2, strerror(-ret));
1110                     ret = 4;
1111                     goto out;
1112                 }
1113                 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1114                 if (ret || pnum != nb_sectors) {
1115                     qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1116                             sectors_to_bytes(
1117                                 ret ? sector_num : sector_num + pnum));
1118                     ret = 1;
1119                     goto out;
1120                 }
1121             }
1122         } else {
1123             if (strict) {
1124                 ret = 1;
1125                 qprintf(quiet, "Strict mode: Offset %" PRId64
1126                         " allocation mismatch!\n",
1127                         sectors_to_bytes(sector_num));
1128                 goto out;
1129             }
1130
1131             if (allocated1) {
1132                 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1133                                           filename1, buf1, quiet);
1134             } else {
1135                 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1136                                           filename2, buf1, quiet);
1137             }
1138             if (ret) {
1139                 if (ret < 0) {
1140                     error_report("Error while reading offset %" PRId64 ": %s",
1141                                  sectors_to_bytes(sector_num), strerror(-ret));
1142                     ret = 4;
1143                 }
1144                 goto out;
1145             }
1146         }
1147         sector_num += nb_sectors;
1148         qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1149     }
1150
1151     if (total_sectors1 != total_sectors2) {
1152         BlockBackend *blk_over;
1153         int64_t total_sectors_over;
1154         const char *filename_over;
1155
1156         qprintf(quiet, "Warning: Image size mismatch!\n");
1157         if (total_sectors1 > total_sectors2) {
1158             total_sectors_over = total_sectors1;
1159             blk_over = blk1;
1160             filename_over = filename1;
1161         } else {
1162             total_sectors_over = total_sectors2;
1163             blk_over = blk2;
1164             filename_over = filename2;
1165         }
1166
1167         for (;;) {
1168             nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1169             if (nb_sectors <= 0) {
1170                 break;
1171             }
1172             ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1173                                           nb_sectors, &pnum);
1174             if (ret < 0) {
1175                 ret = 3;
1176                 error_report("Sector allocation test failed for %s",
1177                              filename_over);
1178                 goto out;
1179
1180             }
1181             nb_sectors = pnum;
1182             if (ret) {
1183                 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1184                                           filename_over, buf1, quiet);
1185                 if (ret) {
1186                     if (ret < 0) {
1187                         error_report("Error while reading offset %" PRId64
1188                                      " of %s: %s", sectors_to_bytes(sector_num),
1189                                      filename_over, strerror(-ret));
1190                         ret = 4;
1191                     }
1192                     goto out;
1193                 }
1194             }
1195             sector_num += nb_sectors;
1196             qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1197         }
1198     }
1199
1200     qprintf(quiet, "Images are identical.\n");
1201     ret = 0;
1202
1203 out:
1204     qemu_vfree(buf1);
1205     qemu_vfree(buf2);
1206     blk_unref(blk2);
1207 out2:
1208     blk_unref(blk1);
1209 out3:
1210     qemu_progress_end();
1211     return ret;
1212 }
1213
1214 enum ImgConvertBlockStatus {
1215     BLK_DATA,
1216     BLK_ZERO,
1217     BLK_BACKING_FILE,
1218 };
1219
1220 typedef struct ImgConvertState {
1221     BlockBackend **src;
1222     int64_t *src_sectors;
1223     int src_cur, src_num;
1224     int64_t src_cur_offset;
1225     int64_t total_sectors;
1226     int64_t allocated_sectors;
1227     enum ImgConvertBlockStatus status;
1228     int64_t sector_next_status;
1229     BlockBackend *target;
1230     bool has_zero_init;
1231     bool compressed;
1232     bool target_has_backing;
1233     int min_sparse;
1234     size_t cluster_sectors;
1235     size_t buf_sectors;
1236 } ImgConvertState;
1237
1238 static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1239 {
1240     assert(sector_num >= s->src_cur_offset);
1241     while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1242         s->src_cur_offset += s->src_sectors[s->src_cur];
1243         s->src_cur++;
1244         assert(s->src_cur < s->src_num);
1245     }
1246 }
1247
1248 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1249 {
1250     int64_t ret;
1251     int n;
1252
1253     convert_select_part(s, sector_num);
1254
1255     assert(s->total_sectors > sector_num);
1256     n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1257
1258     if (s->sector_next_status <= sector_num) {
1259         ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1260                                     sector_num - s->src_cur_offset,
1261                                     n, &n);
1262         if (ret < 0) {
1263             return ret;
1264         }
1265
1266         if (ret & BDRV_BLOCK_ZERO) {
1267             s->status = BLK_ZERO;
1268         } else if (ret & BDRV_BLOCK_DATA) {
1269             s->status = BLK_DATA;
1270         } else if (!s->target_has_backing) {
1271             /* Without a target backing file we must copy over the contents of
1272              * the backing file as well. */
1273             /* TODO Check block status of the backing file chain to avoid
1274              * needlessly reading zeroes and limiting the iteration to the
1275              * buffer size */
1276             s->status = BLK_DATA;
1277         } else {
1278             s->status = BLK_BACKING_FILE;
1279         }
1280
1281         s->sector_next_status = sector_num + n;
1282     }
1283
1284     n = MIN(n, s->sector_next_status - sector_num);
1285     if (s->status == BLK_DATA) {
1286         n = MIN(n, s->buf_sectors);
1287     }
1288
1289     /* We need to write complete clusters for compressed images, so if an
1290      * unallocated area is shorter than that, we must consider the whole
1291      * cluster allocated. */
1292     if (s->compressed) {
1293         if (n < s->cluster_sectors) {
1294             n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1295             s->status = BLK_DATA;
1296         } else {
1297             n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1298         }
1299     }
1300
1301     return n;
1302 }
1303
1304 static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1305                         uint8_t *buf)
1306 {
1307     int n;
1308     int ret;
1309
1310     if (s->status == BLK_ZERO || s->status == BLK_BACKING_FILE) {
1311         return 0;
1312     }
1313
1314     assert(nb_sectors <= s->buf_sectors);
1315     while (nb_sectors > 0) {
1316         BlockBackend *blk;
1317         int64_t bs_sectors;
1318
1319         /* In the case of compression with multiple source files, we can get a
1320          * nb_sectors that spreads into the next part. So we must be able to
1321          * read across multiple BDSes for one convert_read() call. */
1322         convert_select_part(s, sector_num);
1323         blk = s->src[s->src_cur];
1324         bs_sectors = s->src_sectors[s->src_cur];
1325
1326         n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1327         ret = blk_read(blk, sector_num - s->src_cur_offset, buf, n);
1328         if (ret < 0) {
1329             return ret;
1330         }
1331
1332         sector_num += n;
1333         nb_sectors -= n;
1334         buf += n * BDRV_SECTOR_SIZE;
1335     }
1336
1337     return 0;
1338 }
1339
1340 static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1341                          const uint8_t *buf)
1342 {
1343     int ret;
1344
1345     while (nb_sectors > 0) {
1346         int n = nb_sectors;
1347
1348         switch (s->status) {
1349         case BLK_BACKING_FILE:
1350             /* If we have a backing file, leave clusters unallocated that are
1351              * unallocated in the source image, so that the backing file is
1352              * visible at the respective offset. */
1353             assert(s->target_has_backing);
1354             break;
1355
1356         case BLK_DATA:
1357             /* We must always write compressed clusters as a whole, so don't
1358              * try to find zeroed parts in the buffer. We can only save the
1359              * write if the buffer is completely zeroed and we're allowed to
1360              * keep the target sparse. */
1361             if (s->compressed) {
1362                 if (s->has_zero_init && s->min_sparse &&
1363                     buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1364                 {
1365                     assert(!s->target_has_backing);
1366                     break;
1367                 }
1368
1369                 ret = blk_write_compressed(s->target, sector_num, buf, n);
1370                 if (ret < 0) {
1371                     return ret;
1372                 }
1373                 break;
1374             }
1375
1376             /* If there is real non-zero data or we're told to keep the target
1377              * fully allocated (-S 0), we must write it. Otherwise we can treat
1378              * it as zero sectors. */
1379             if (!s->min_sparse ||
1380                 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1381             {
1382                 ret = blk_write(s->target, sector_num, buf, n);
1383                 if (ret < 0) {
1384                     return ret;
1385                 }
1386                 break;
1387             }
1388             /* fall-through */
1389
1390         case BLK_ZERO:
1391             if (s->has_zero_init) {
1392                 break;
1393             }
1394             ret = blk_write_zeroes(s->target, sector_num, n, 0);
1395             if (ret < 0) {
1396                 return ret;
1397             }
1398             break;
1399         }
1400
1401         sector_num += n;
1402         nb_sectors -= n;
1403         buf += n * BDRV_SECTOR_SIZE;
1404     }
1405
1406     return 0;
1407 }
1408
1409 static int convert_do_copy(ImgConvertState *s)
1410 {
1411     uint8_t *buf = NULL;
1412     int64_t sector_num, allocated_done;
1413     int ret;
1414     int n;
1415
1416     /* Check whether we have zero initialisation or can get it efficiently */
1417     s->has_zero_init = s->min_sparse && !s->target_has_backing
1418                      ? bdrv_has_zero_init(blk_bs(s->target))
1419                      : false;
1420
1421     if (!s->has_zero_init && !s->target_has_backing &&
1422         bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1423     {
1424         ret = bdrv_make_zero(blk_bs(s->target), BDRV_REQ_MAY_UNMAP);
1425         if (ret == 0) {
1426             s->has_zero_init = true;
1427         }
1428     }
1429
1430     /* Allocate buffer for copied data. For compressed images, only one cluster
1431      * can be copied at a time. */
1432     if (s->compressed) {
1433         if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1434             error_report("invalid cluster size");
1435             ret = -EINVAL;
1436             goto fail;
1437         }
1438         s->buf_sectors = s->cluster_sectors;
1439     }
1440     buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1441
1442     /* Calculate allocated sectors for progress */
1443     s->allocated_sectors = 0;
1444     sector_num = 0;
1445     while (sector_num < s->total_sectors) {
1446         n = convert_iteration_sectors(s, sector_num);
1447         if (n < 0) {
1448             ret = n;
1449             goto fail;
1450         }
1451         if (s->status == BLK_DATA) {
1452             s->allocated_sectors += n;
1453         }
1454         sector_num += n;
1455     }
1456
1457     /* Do the copy */
1458     s->src_cur = 0;
1459     s->src_cur_offset = 0;
1460     s->sector_next_status = 0;
1461
1462     sector_num = 0;
1463     allocated_done = 0;
1464
1465     while (sector_num < s->total_sectors) {
1466         n = convert_iteration_sectors(s, sector_num);
1467         if (n < 0) {
1468             ret = n;
1469             goto fail;
1470         }
1471         if (s->status == BLK_DATA) {
1472             allocated_done += n;
1473             qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1474                                 0);
1475         }
1476
1477         ret = convert_read(s, sector_num, n, buf);
1478         if (ret < 0) {
1479             error_report("error while reading sector %" PRId64
1480                          ": %s", sector_num, strerror(-ret));
1481             goto fail;
1482         }
1483
1484         ret = convert_write(s, sector_num, n, buf);
1485         if (ret < 0) {
1486             error_report("error while writing sector %" PRId64
1487                          ": %s", sector_num, strerror(-ret));
1488             goto fail;
1489         }
1490
1491         sector_num += n;
1492     }
1493
1494     if (s->compressed) {
1495         /* signal EOF to align */
1496         ret = blk_write_compressed(s->target, 0, NULL, 0);
1497         if (ret < 0) {
1498             goto fail;
1499         }
1500     }
1501
1502     ret = 0;
1503 fail:
1504     qemu_vfree(buf);
1505     return ret;
1506 }
1507
1508 static int img_convert(int argc, char **argv)
1509 {
1510     int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1511     int64_t ret = 0;
1512     int progress = 0, flags, src_flags;
1513     const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1514     BlockDriver *drv, *proto_drv;
1515     BlockBackend **blk = NULL, *out_blk = NULL;
1516     BlockDriverState **bs = NULL, *out_bs = NULL;
1517     int64_t total_sectors;
1518     int64_t *bs_sectors = NULL;
1519     size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1520     BlockDriverInfo bdi;
1521     QemuOpts *opts = NULL;
1522     QemuOptsList *create_opts = NULL;
1523     const char *out_baseimg_param;
1524     char *options = NULL;
1525     const char *snapshot_name = NULL;
1526     int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1527     bool quiet = false;
1528     Error *local_err = NULL;
1529     QemuOpts *sn_opts = NULL;
1530     ImgConvertState state;
1531
1532     fmt = NULL;
1533     out_fmt = "raw";
1534     cache = "unsafe";
1535     src_cache = BDRV_DEFAULT_CACHE;
1536     out_baseimg = NULL;
1537     compress = 0;
1538     skip_create = 0;
1539     for(;;) {
1540         c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1541         if (c == -1) {
1542             break;
1543         }
1544         switch(c) {
1545         case '?':
1546         case 'h':
1547             help();
1548             break;
1549         case 'f':
1550             fmt = optarg;
1551             break;
1552         case 'O':
1553             out_fmt = optarg;
1554             break;
1555         case 'B':
1556             out_baseimg = optarg;
1557             break;
1558         case 'c':
1559             compress = 1;
1560             break;
1561         case 'e':
1562             error_report("option -e is deprecated, please use \'-o "
1563                   "encryption\' instead!");
1564             ret = -1;
1565             goto fail_getopt;
1566         case '6':
1567             error_report("option -6 is deprecated, please use \'-o "
1568                   "compat6\' instead!");
1569             ret = -1;
1570             goto fail_getopt;
1571         case 'o':
1572             if (!is_valid_option_list(optarg)) {
1573                 error_report("Invalid option list: %s", optarg);
1574                 ret = -1;
1575                 goto fail_getopt;
1576             }
1577             if (!options) {
1578                 options = g_strdup(optarg);
1579             } else {
1580                 char *old_options = options;
1581                 options = g_strdup_printf("%s,%s", options, optarg);
1582                 g_free(old_options);
1583             }
1584             break;
1585         case 's':
1586             snapshot_name = optarg;
1587             break;
1588         case 'l':
1589             if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1590                 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1591                                                   optarg, false);
1592                 if (!sn_opts) {
1593                     error_report("Failed in parsing snapshot param '%s'",
1594                                  optarg);
1595                     ret = -1;
1596                     goto fail_getopt;
1597                 }
1598             } else {
1599                 snapshot_name = optarg;
1600             }
1601             break;
1602         case 'S':
1603         {
1604             int64_t sval;
1605             char *end;
1606             sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1607             if (sval < 0 || *end) {
1608                 error_report("Invalid minimum zero buffer size for sparse output specified");
1609                 ret = -1;
1610                 goto fail_getopt;
1611             }
1612
1613             min_sparse = sval / BDRV_SECTOR_SIZE;
1614             break;
1615         }
1616         case 'p':
1617             progress = 1;
1618             break;
1619         case 't':
1620             cache = optarg;
1621             break;
1622         case 'T':
1623             src_cache = optarg;
1624             break;
1625         case 'q':
1626             quiet = true;
1627             break;
1628         case 'n':
1629             skip_create = 1;
1630             break;
1631         }
1632     }
1633
1634     /* Initialize before goto out */
1635     if (quiet) {
1636         progress = 0;
1637     }
1638     qemu_progress_init(progress, 1.0);
1639
1640
1641     bs_n = argc - optind - 1;
1642     out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1643
1644     if (options && has_help_option(options)) {
1645         ret = print_block_option_help(out_filename, out_fmt);
1646         goto out;
1647     }
1648
1649     if (bs_n < 1) {
1650         error_exit("Must specify image file name");
1651     }
1652
1653
1654     if (bs_n > 1 && out_baseimg) {
1655         error_report("-B makes no sense when concatenating multiple input "
1656                      "images");
1657         ret = -1;
1658         goto out;
1659     }
1660
1661     src_flags = BDRV_O_FLAGS;
1662     ret = bdrv_parse_cache_flags(src_cache, &src_flags);
1663     if (ret < 0) {
1664         error_report("Invalid source cache option: %s", src_cache);
1665         goto out;
1666     }
1667
1668     qemu_progress_print(0, 100);
1669
1670     blk = g_new0(BlockBackend *, bs_n);
1671     bs = g_new0(BlockDriverState *, bs_n);
1672     bs_sectors = g_new(int64_t, bs_n);
1673
1674     total_sectors = 0;
1675     for (bs_i = 0; bs_i < bs_n; bs_i++) {
1676         char *id = bs_n > 1 ? g_strdup_printf("source_%d", bs_i)
1677                             : g_strdup("source");
1678         blk[bs_i] = img_open(id, argv[optind + bs_i], fmt, src_flags,
1679                              true, quiet);
1680         g_free(id);
1681         if (!blk[bs_i]) {
1682             ret = -1;
1683             goto out;
1684         }
1685         bs[bs_i] = blk_bs(blk[bs_i]);
1686         bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1687         if (bs_sectors[bs_i] < 0) {
1688             error_report("Could not get size of %s: %s",
1689                          argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1690             ret = -1;
1691             goto out;
1692         }
1693         total_sectors += bs_sectors[bs_i];
1694     }
1695
1696     if (sn_opts) {
1697         ret = bdrv_snapshot_load_tmp(bs[0],
1698                                      qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1699                                      qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1700                                      &local_err);
1701     } else if (snapshot_name != NULL) {
1702         if (bs_n > 1) {
1703             error_report("No support for concatenating multiple snapshot");
1704             ret = -1;
1705             goto out;
1706         }
1707
1708         bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1709     }
1710     if (local_err) {
1711         error_reportf_err(local_err, "Failed to load snapshot: ");
1712         ret = -1;
1713         goto out;
1714     }
1715
1716     /* Find driver and parse its options */
1717     drv = bdrv_find_format(out_fmt);
1718     if (!drv) {
1719         error_report("Unknown file format '%s'", out_fmt);
1720         ret = -1;
1721         goto out;
1722     }
1723
1724     proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1725     if (!proto_drv) {
1726         error_report_err(local_err);
1727         ret = -1;
1728         goto out;
1729     }
1730
1731     if (!skip_create) {
1732         if (!drv->create_opts) {
1733             error_report("Format driver '%s' does not support image creation",
1734                          drv->format_name);
1735             ret = -1;
1736             goto out;
1737         }
1738
1739         if (!proto_drv->create_opts) {
1740             error_report("Protocol driver '%s' does not support image creation",
1741                          proto_drv->format_name);
1742             ret = -1;
1743             goto out;
1744         }
1745
1746         create_opts = qemu_opts_append(create_opts, drv->create_opts);
1747         create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1748
1749         opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1750         if (options) {
1751             qemu_opts_do_parse(opts, options, NULL, &local_err);
1752             if (local_err) {
1753                 error_report_err(local_err);
1754                 ret = -1;
1755                 goto out;
1756             }
1757         }
1758
1759         qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
1760                             &error_abort);
1761         ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
1762         if (ret < 0) {
1763             goto out;
1764         }
1765     }
1766
1767     /* Get backing file name if -o backing_file was used */
1768     out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1769     if (out_baseimg_param) {
1770         out_baseimg = out_baseimg_param;
1771     }
1772
1773     /* Check if compression is supported */
1774     if (compress) {
1775         bool encryption =
1776             qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
1777         const char *preallocation =
1778             qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
1779
1780         if (!drv->bdrv_write_compressed) {
1781             error_report("Compression not supported for this file format");
1782             ret = -1;
1783             goto out;
1784         }
1785
1786         if (encryption) {
1787             error_report("Compression and encryption not supported at "
1788                          "the same time");
1789             ret = -1;
1790             goto out;
1791         }
1792
1793         if (preallocation
1794             && strcmp(preallocation, "off"))
1795         {
1796             error_report("Compression and preallocation not supported at "
1797                          "the same time");
1798             ret = -1;
1799             goto out;
1800         }
1801     }
1802
1803     if (!skip_create) {
1804         /* Create the new image */
1805         ret = bdrv_create(drv, out_filename, opts, &local_err);
1806         if (ret < 0) {
1807             error_reportf_err(local_err, "%s: error while converting %s: ",
1808                               out_filename, out_fmt);
1809             goto out;
1810         }
1811     }
1812
1813     flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1814     ret = bdrv_parse_cache_flags(cache, &flags);
1815     if (ret < 0) {
1816         error_report("Invalid cache option: %s", cache);
1817         goto out;
1818     }
1819
1820     out_blk = img_open("target", out_filename, out_fmt, flags, true, quiet);
1821     if (!out_blk) {
1822         ret = -1;
1823         goto out;
1824     }
1825     out_bs = blk_bs(out_blk);
1826
1827     /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1828      * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1829      * as maximum. */
1830     bufsectors = MIN(32768,
1831                      MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
1832                                          out_bs->bl.discard_alignment))
1833                     );
1834
1835     if (skip_create) {
1836         int64_t output_sectors = blk_nb_sectors(out_blk);
1837         if (output_sectors < 0) {
1838             error_report("unable to get output image length: %s",
1839                          strerror(-output_sectors));
1840             ret = -1;
1841             goto out;
1842         } else if (output_sectors < total_sectors) {
1843             error_report("output file is smaller than input file");
1844             ret = -1;
1845             goto out;
1846         }
1847     }
1848
1849     cluster_sectors = 0;
1850     ret = bdrv_get_info(out_bs, &bdi);
1851     if (ret < 0) {
1852         if (compress) {
1853             error_report("could not get block driver info");
1854             goto out;
1855         }
1856     } else {
1857         compress = compress || bdi.needs_compressed_writes;
1858         cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1859     }
1860
1861     state = (ImgConvertState) {
1862         .src                = blk,
1863         .src_sectors        = bs_sectors,
1864         .src_num            = bs_n,
1865         .total_sectors      = total_sectors,
1866         .target             = out_blk,
1867         .compressed         = compress,
1868         .target_has_backing = (bool) out_baseimg,
1869         .min_sparse         = min_sparse,
1870         .cluster_sectors    = cluster_sectors,
1871         .buf_sectors        = bufsectors,
1872     };
1873     ret = convert_do_copy(&state);
1874
1875 out:
1876     if (!ret) {
1877         qemu_progress_print(100, 0);
1878     }
1879     qemu_progress_end();
1880     qemu_opts_del(opts);
1881     qemu_opts_free(create_opts);
1882     qemu_opts_del(sn_opts);
1883     blk_unref(out_blk);
1884     g_free(bs);
1885     if (blk) {
1886         for (bs_i = 0; bs_i < bs_n; bs_i++) {
1887             blk_unref(blk[bs_i]);
1888         }
1889         g_free(blk);
1890     }
1891     g_free(bs_sectors);
1892 fail_getopt:
1893     g_free(options);
1894
1895     if (ret) {
1896         return 1;
1897     }
1898     return 0;
1899 }
1900
1901
1902 static void dump_snapshots(BlockDriverState *bs)
1903 {
1904     QEMUSnapshotInfo *sn_tab, *sn;
1905     int nb_sns, i;
1906
1907     nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1908     if (nb_sns <= 0)
1909         return;
1910     printf("Snapshot list:\n");
1911     bdrv_snapshot_dump(fprintf, stdout, NULL);
1912     printf("\n");
1913     for(i = 0; i < nb_sns; i++) {
1914         sn = &sn_tab[i];
1915         bdrv_snapshot_dump(fprintf, stdout, sn);
1916         printf("\n");
1917     }
1918     g_free(sn_tab);
1919 }
1920
1921 static void dump_json_image_info_list(ImageInfoList *list)
1922 {
1923     Error *local_err = NULL;
1924     QString *str;
1925     QmpOutputVisitor *ov = qmp_output_visitor_new();
1926     QObject *obj;
1927     visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1928                              &list, NULL, &local_err);
1929     obj = qmp_output_get_qobject(ov);
1930     str = qobject_to_json_pretty(obj);
1931     assert(str != NULL);
1932     printf("%s\n", qstring_get_str(str));
1933     qobject_decref(obj);
1934     qmp_output_visitor_cleanup(ov);
1935     QDECREF(str);
1936 }
1937
1938 static void dump_json_image_info(ImageInfo *info)
1939 {
1940     Error *local_err = NULL;
1941     QString *str;
1942     QmpOutputVisitor *ov = qmp_output_visitor_new();
1943     QObject *obj;
1944     visit_type_ImageInfo(qmp_output_get_visitor(ov),
1945                          &info, NULL, &local_err);
1946     obj = qmp_output_get_qobject(ov);
1947     str = qobject_to_json_pretty(obj);
1948     assert(str != NULL);
1949     printf("%s\n", qstring_get_str(str));
1950     qobject_decref(obj);
1951     qmp_output_visitor_cleanup(ov);
1952     QDECREF(str);
1953 }
1954
1955 static void dump_human_image_info_list(ImageInfoList *list)
1956 {
1957     ImageInfoList *elem;
1958     bool delim = false;
1959
1960     for (elem = list; elem; elem = elem->next) {
1961         if (delim) {
1962             printf("\n");
1963         }
1964         delim = true;
1965
1966         bdrv_image_info_dump(fprintf, stdout, elem->value);
1967     }
1968 }
1969
1970 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1971 {
1972     return strcmp(a, b) == 0;
1973 }
1974
1975 /**
1976  * Open an image file chain and return an ImageInfoList
1977  *
1978  * @filename: topmost image filename
1979  * @fmt: topmost image format (may be NULL to autodetect)
1980  * @chain: true  - enumerate entire backing file chain
1981  *         false - only topmost image file
1982  *
1983  * Returns a list of ImageInfo objects or NULL if there was an error opening an
1984  * image file.  If there was an error a message will have been printed to
1985  * stderr.
1986  */
1987 static ImageInfoList *collect_image_info_list(const char *filename,
1988                                               const char *fmt,
1989                                               bool chain)
1990 {
1991     ImageInfoList *head = NULL;
1992     ImageInfoList **last = &head;
1993     GHashTable *filenames;
1994     Error *err = NULL;
1995
1996     filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
1997
1998     while (filename) {
1999         BlockBackend *blk;
2000         BlockDriverState *bs;
2001         ImageInfo *info;
2002         ImageInfoList *elem;
2003
2004         if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2005             error_report("Backing file '%s' creates an infinite loop.",
2006                          filename);
2007             goto err;
2008         }
2009         g_hash_table_insert(filenames, (gpointer)filename, NULL);
2010
2011         blk = img_open("image", filename, fmt,
2012                        BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
2013         if (!blk) {
2014             goto err;
2015         }
2016         bs = blk_bs(blk);
2017
2018         bdrv_query_image_info(bs, &info, &err);
2019         if (err) {
2020             error_report_err(err);
2021             blk_unref(blk);
2022             goto err;
2023         }
2024
2025         elem = g_new0(ImageInfoList, 1);
2026         elem->value = info;
2027         *last = elem;
2028         last = &elem->next;
2029
2030         blk_unref(blk);
2031
2032         filename = fmt = NULL;
2033         if (chain) {
2034             if (info->has_full_backing_filename) {
2035                 filename = info->full_backing_filename;
2036             } else if (info->has_backing_filename) {
2037                 error_report("Could not determine absolute backing filename,"
2038                              " but backing filename '%s' present",
2039                              info->backing_filename);
2040                 goto err;
2041             }
2042             if (info->has_backing_filename_format) {
2043                 fmt = info->backing_filename_format;
2044             }
2045         }
2046     }
2047     g_hash_table_destroy(filenames);
2048     return head;
2049
2050 err:
2051     qapi_free_ImageInfoList(head);
2052     g_hash_table_destroy(filenames);
2053     return NULL;
2054 }
2055
2056 static int img_info(int argc, char **argv)
2057 {
2058     int c;
2059     OutputFormat output_format = OFORMAT_HUMAN;
2060     bool chain = false;
2061     const char *filename, *fmt, *output;
2062     ImageInfoList *list;
2063
2064     fmt = NULL;
2065     output = NULL;
2066     for(;;) {
2067         int option_index = 0;
2068         static const struct option long_options[] = {
2069             {"help", no_argument, 0, 'h'},
2070             {"format", required_argument, 0, 'f'},
2071             {"output", required_argument, 0, OPTION_OUTPUT},
2072             {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2073             {0, 0, 0, 0}
2074         };
2075         c = getopt_long(argc, argv, "f:h",
2076                         long_options, &option_index);
2077         if (c == -1) {
2078             break;
2079         }
2080         switch(c) {
2081         case '?':
2082         case 'h':
2083             help();
2084             break;
2085         case 'f':
2086             fmt = optarg;
2087             break;
2088         case OPTION_OUTPUT:
2089             output = optarg;
2090             break;
2091         case OPTION_BACKING_CHAIN:
2092             chain = true;
2093             break;
2094         }
2095     }
2096     if (optind != argc - 1) {
2097         error_exit("Expecting one image file name");
2098     }
2099     filename = argv[optind++];
2100
2101     if (output && !strcmp(output, "json")) {
2102         output_format = OFORMAT_JSON;
2103     } else if (output && !strcmp(output, "human")) {
2104         output_format = OFORMAT_HUMAN;
2105     } else if (output) {
2106         error_report("--output must be used with human or json as argument.");
2107         return 1;
2108     }
2109
2110     list = collect_image_info_list(filename, fmt, chain);
2111     if (!list) {
2112         return 1;
2113     }
2114
2115     switch (output_format) {
2116     case OFORMAT_HUMAN:
2117         dump_human_image_info_list(list);
2118         break;
2119     case OFORMAT_JSON:
2120         if (chain) {
2121             dump_json_image_info_list(list);
2122         } else {
2123             dump_json_image_info(list->value);
2124         }
2125         break;
2126     }
2127
2128     qapi_free_ImageInfoList(list);
2129     return 0;
2130 }
2131
2132
2133 typedef struct MapEntry {
2134     int flags;
2135     int depth;
2136     int64_t start;
2137     int64_t length;
2138     int64_t offset;
2139     BlockDriverState *bs;
2140 } MapEntry;
2141
2142 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2143                            MapEntry *next)
2144 {
2145     switch (output_format) {
2146     case OFORMAT_HUMAN:
2147         if ((e->flags & BDRV_BLOCK_DATA) &&
2148             !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
2149             error_report("File contains external, encrypted or compressed clusters.");
2150             exit(1);
2151         }
2152         if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
2153             printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2154                    e->start, e->length, e->offset, e->bs->filename);
2155         }
2156         /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2157          * Modify the flags here to allow more coalescing.
2158          */
2159         if (next &&
2160             (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
2161             next->flags &= ~BDRV_BLOCK_DATA;
2162             next->flags |= BDRV_BLOCK_ZERO;
2163         }
2164         break;
2165     case OFORMAT_JSON:
2166         printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
2167                " \"zero\": %s, \"data\": %s",
2168                (e->start == 0 ? "[" : ",\n"),
2169                e->start, e->length, e->depth,
2170                (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
2171                (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
2172         if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
2173             printf(", \"offset\": %"PRId64"", e->offset);
2174         }
2175         putchar('}');
2176
2177         if (!next) {
2178             printf("]\n");
2179         }
2180         break;
2181     }
2182 }
2183
2184 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2185                             int nb_sectors, MapEntry *e)
2186 {
2187     int64_t ret;
2188     int depth;
2189
2190     /* As an optimization, we could cache the current range of unallocated
2191      * clusters in each file of the chain, and avoid querying the same
2192      * range repeatedly.
2193      */
2194
2195     depth = 0;
2196     for (;;) {
2197         ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
2198         if (ret < 0) {
2199             return ret;
2200         }
2201         assert(nb_sectors);
2202         if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2203             break;
2204         }
2205         bs = backing_bs(bs);
2206         if (bs == NULL) {
2207             ret = 0;
2208             break;
2209         }
2210
2211         depth++;
2212     }
2213
2214     e->start = sector_num * BDRV_SECTOR_SIZE;
2215     e->length = nb_sectors * BDRV_SECTOR_SIZE;
2216     e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2217     e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2218     e->depth = depth;
2219     e->bs = bs;
2220     return 0;
2221 }
2222
2223 static int img_map(int argc, char **argv)
2224 {
2225     int c;
2226     OutputFormat output_format = OFORMAT_HUMAN;
2227     BlockBackend *blk;
2228     BlockDriverState *bs;
2229     const char *filename, *fmt, *output;
2230     int64_t length;
2231     MapEntry curr = { .length = 0 }, next;
2232     int ret = 0;
2233
2234     fmt = NULL;
2235     output = NULL;
2236     for (;;) {
2237         int option_index = 0;
2238         static const struct option long_options[] = {
2239             {"help", no_argument, 0, 'h'},
2240             {"format", required_argument, 0, 'f'},
2241             {"output", required_argument, 0, OPTION_OUTPUT},
2242             {0, 0, 0, 0}
2243         };
2244         c = getopt_long(argc, argv, "f:h",
2245                         long_options, &option_index);
2246         if (c == -1) {
2247             break;
2248         }
2249         switch (c) {
2250         case '?':
2251         case 'h':
2252             help();
2253             break;
2254         case 'f':
2255             fmt = optarg;
2256             break;
2257         case OPTION_OUTPUT:
2258             output = optarg;
2259             break;
2260         }
2261     }
2262     if (optind != argc - 1) {
2263         error_exit("Expecting one image file name");
2264     }
2265     filename = argv[optind];
2266
2267     if (output && !strcmp(output, "json")) {
2268         output_format = OFORMAT_JSON;
2269     } else if (output && !strcmp(output, "human")) {
2270         output_format = OFORMAT_HUMAN;
2271     } else if (output) {
2272         error_report("--output must be used with human or json as argument.");
2273         return 1;
2274     }
2275
2276     blk = img_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
2277     if (!blk) {
2278         return 1;
2279     }
2280     bs = blk_bs(blk);
2281
2282     if (output_format == OFORMAT_HUMAN) {
2283         printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2284     }
2285
2286     length = blk_getlength(blk);
2287     while (curr.start + curr.length < length) {
2288         int64_t nsectors_left;
2289         int64_t sector_num;
2290         int n;
2291
2292         sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2293
2294         /* Probe up to 1 GiB at a time.  */
2295         nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2296         n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2297         ret = get_block_status(bs, sector_num, n, &next);
2298
2299         if (ret < 0) {
2300             error_report("Could not read file metadata: %s", strerror(-ret));
2301             goto out;
2302         }
2303
2304         if (curr.length != 0 && curr.flags == next.flags &&
2305             curr.depth == next.depth &&
2306             ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2307              curr.offset + curr.length == next.offset)) {
2308             curr.length += next.length;
2309             continue;
2310         }
2311
2312         if (curr.length > 0) {
2313             dump_map_entry(output_format, &curr, &next);
2314         }
2315         curr = next;
2316     }
2317
2318     dump_map_entry(output_format, &curr, NULL);
2319
2320 out:
2321     blk_unref(blk);
2322     return ret < 0;
2323 }
2324
2325 #define SNAPSHOT_LIST   1
2326 #define SNAPSHOT_CREATE 2
2327 #define SNAPSHOT_APPLY  3
2328 #define SNAPSHOT_DELETE 4
2329
2330 static int img_snapshot(int argc, char **argv)
2331 {
2332     BlockBackend *blk;
2333     BlockDriverState *bs;
2334     QEMUSnapshotInfo sn;
2335     char *filename, *snapshot_name = NULL;
2336     int c, ret = 0, bdrv_oflags;
2337     int action = 0;
2338     qemu_timeval tv;
2339     bool quiet = false;
2340     Error *err = NULL;
2341
2342     bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2343     /* Parse commandline parameters */
2344     for(;;) {
2345         c = getopt(argc, argv, "la:c:d:hq");
2346         if (c == -1) {
2347             break;
2348         }
2349         switch(c) {
2350         case '?':
2351         case 'h':
2352             help();
2353             return 0;
2354         case 'l':
2355             if (action) {
2356                 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2357                 return 0;
2358             }
2359             action = SNAPSHOT_LIST;
2360             bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2361             break;
2362         case 'a':
2363             if (action) {
2364                 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2365                 return 0;
2366             }
2367             action = SNAPSHOT_APPLY;
2368             snapshot_name = optarg;
2369             break;
2370         case 'c':
2371             if (action) {
2372                 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2373                 return 0;
2374             }
2375             action = SNAPSHOT_CREATE;
2376             snapshot_name = optarg;
2377             break;
2378         case 'd':
2379             if (action) {
2380                 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2381                 return 0;
2382             }
2383             action = SNAPSHOT_DELETE;
2384             snapshot_name = optarg;
2385             break;
2386         case 'q':
2387             quiet = true;
2388             break;
2389         }
2390     }
2391
2392     if (optind != argc - 1) {
2393         error_exit("Expecting one image file name");
2394     }
2395     filename = argv[optind++];
2396
2397     /* Open the image */
2398     blk = img_open("image", filename, NULL, bdrv_oflags, true, quiet);
2399     if (!blk) {
2400         return 1;
2401     }
2402     bs = blk_bs(blk);
2403
2404     /* Perform the requested action */
2405     switch(action) {
2406     case SNAPSHOT_LIST:
2407         dump_snapshots(bs);
2408         break;
2409
2410     case SNAPSHOT_CREATE:
2411         memset(&sn, 0, sizeof(sn));
2412         pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2413
2414         qemu_gettimeofday(&tv);
2415         sn.date_sec = tv.tv_sec;
2416         sn.date_nsec = tv.tv_usec * 1000;
2417
2418         ret = bdrv_snapshot_create(bs, &sn);
2419         if (ret) {
2420             error_report("Could not create snapshot '%s': %d (%s)",
2421                 snapshot_name, ret, strerror(-ret));
2422         }
2423         break;
2424
2425     case SNAPSHOT_APPLY:
2426         ret = bdrv_snapshot_goto(bs, snapshot_name);
2427         if (ret) {
2428             error_report("Could not apply snapshot '%s': %d (%s)",
2429                 snapshot_name, ret, strerror(-ret));
2430         }
2431         break;
2432
2433     case SNAPSHOT_DELETE:
2434         bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2435         if (err) {
2436             error_reportf_err(err, "Could not delete snapshot '%s': ",
2437                               snapshot_name);
2438             ret = 1;
2439         }
2440         break;
2441     }
2442
2443     /* Cleanup */
2444     blk_unref(blk);
2445     if (ret) {
2446         return 1;
2447     }
2448     return 0;
2449 }
2450
2451 static int img_rebase(int argc, char **argv)
2452 {
2453     BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2454     BlockDriverState *bs = NULL;
2455     char *filename;
2456     const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2457     int c, flags, src_flags, ret;
2458     int unsafe = 0;
2459     int progress = 0;
2460     bool quiet = false;
2461     Error *local_err = NULL;
2462
2463     /* Parse commandline parameters */
2464     fmt = NULL;
2465     cache = BDRV_DEFAULT_CACHE;
2466     src_cache = BDRV_DEFAULT_CACHE;
2467     out_baseimg = NULL;
2468     out_basefmt = NULL;
2469     for(;;) {
2470         c = getopt(argc, argv, "hf:F:b:upt:T:q");
2471         if (c == -1) {
2472             break;
2473         }
2474         switch(c) {
2475         case '?':
2476         case 'h':
2477             help();
2478             return 0;
2479         case 'f':
2480             fmt = optarg;
2481             break;
2482         case 'F':
2483             out_basefmt = optarg;
2484             break;
2485         case 'b':
2486             out_baseimg = optarg;
2487             break;
2488         case 'u':
2489             unsafe = 1;
2490             break;
2491         case 'p':
2492             progress = 1;
2493             break;
2494         case 't':
2495             cache = optarg;
2496             break;
2497         case 'T':
2498             src_cache = optarg;
2499             break;
2500         case 'q':
2501             quiet = true;
2502             break;
2503         }
2504     }
2505
2506     if (quiet) {
2507         progress = 0;
2508     }
2509
2510     if (optind != argc - 1) {
2511         error_exit("Expecting one image file name");
2512     }
2513     if (!unsafe && !out_baseimg) {
2514         error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2515     }
2516     filename = argv[optind++];
2517
2518     qemu_progress_init(progress, 2.0);
2519     qemu_progress_print(0, 100);
2520
2521     flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2522     ret = bdrv_parse_cache_flags(cache, &flags);
2523     if (ret < 0) {
2524         error_report("Invalid cache option: %s", cache);
2525         goto out;
2526     }
2527
2528     src_flags = BDRV_O_FLAGS;
2529     ret = bdrv_parse_cache_flags(src_cache, &src_flags);
2530     if (ret < 0) {
2531         error_report("Invalid source cache option: %s", src_cache);
2532         goto out;
2533     }
2534
2535     /*
2536      * Open the images.
2537      *
2538      * Ignore the old backing file for unsafe rebase in case we want to correct
2539      * the reference to a renamed or moved backing file.
2540      */
2541     blk = img_open("image", filename, fmt, flags, true, quiet);
2542     if (!blk) {
2543         ret = -1;
2544         goto out;
2545     }
2546     bs = blk_bs(blk);
2547
2548     if (out_basefmt != NULL) {
2549         if (bdrv_find_format(out_basefmt) == NULL) {
2550             error_report("Invalid format name: '%s'", out_basefmt);
2551             ret = -1;
2552             goto out;
2553         }
2554     }
2555
2556     /* For safe rebasing we need to compare old and new backing file */
2557     if (!unsafe) {
2558         char backing_name[PATH_MAX];
2559         QDict *options = NULL;
2560
2561         if (bs->backing_format[0] != '\0') {
2562             options = qdict_new();
2563             qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2564         }
2565
2566         bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2567         blk_old_backing = blk_new_open("old_backing", backing_name, NULL,
2568                                        options, src_flags, &local_err);
2569         if (!blk_old_backing) {
2570             error_reportf_err(local_err,
2571                               "Could not open old backing file '%s': ",
2572                               backing_name);
2573             goto out;
2574         }
2575
2576         if (out_baseimg[0]) {
2577             if (out_basefmt) {
2578                 options = qdict_new();
2579                 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2580             } else {
2581                 options = NULL;
2582             }
2583
2584             blk_new_backing = blk_new_open("new_backing", out_baseimg, NULL,
2585                                            options, src_flags, &local_err);
2586             if (!blk_new_backing) {
2587                 error_reportf_err(local_err,
2588                                   "Could not open new backing file '%s': ",
2589                                   out_baseimg);
2590                 goto out;
2591             }
2592         }
2593     }
2594
2595     /*
2596      * Check each unallocated cluster in the COW file. If it is unallocated,
2597      * accesses go to the backing file. We must therefore compare this cluster
2598      * in the old and new backing file, and if they differ we need to copy it
2599      * from the old backing file into the COW file.
2600      *
2601      * If qemu-img crashes during this step, no harm is done. The content of
2602      * the image is the same as the original one at any time.
2603      */
2604     if (!unsafe) {
2605         int64_t num_sectors;
2606         int64_t old_backing_num_sectors;
2607         int64_t new_backing_num_sectors = 0;
2608         uint64_t sector;
2609         int n;
2610         uint8_t * buf_old;
2611         uint8_t * buf_new;
2612         float local_progress = 0;
2613
2614         buf_old = blk_blockalign(blk, IO_BUF_SIZE);
2615         buf_new = blk_blockalign(blk, IO_BUF_SIZE);
2616
2617         num_sectors = blk_nb_sectors(blk);
2618         if (num_sectors < 0) {
2619             error_report("Could not get size of '%s': %s",
2620                          filename, strerror(-num_sectors));
2621             ret = -1;
2622             goto out;
2623         }
2624         old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2625         if (old_backing_num_sectors < 0) {
2626             char backing_name[PATH_MAX];
2627
2628             bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2629             error_report("Could not get size of '%s': %s",
2630                          backing_name, strerror(-old_backing_num_sectors));
2631             ret = -1;
2632             goto out;
2633         }
2634         if (blk_new_backing) {
2635             new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
2636             if (new_backing_num_sectors < 0) {
2637                 error_report("Could not get size of '%s': %s",
2638                              out_baseimg, strerror(-new_backing_num_sectors));
2639                 ret = -1;
2640                 goto out;
2641             }
2642         }
2643
2644         if (num_sectors != 0) {
2645             local_progress = (float)100 /
2646                 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2647         }
2648
2649         for (sector = 0; sector < num_sectors; sector += n) {
2650
2651             /* How many sectors can we handle with the next read? */
2652             if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2653                 n = (IO_BUF_SIZE / 512);
2654             } else {
2655                 n = num_sectors - sector;
2656             }
2657
2658             /* If the cluster is allocated, we don't need to take action */
2659             ret = bdrv_is_allocated(bs, sector, n, &n);
2660             if (ret < 0) {
2661                 error_report("error while reading image metadata: %s",
2662                              strerror(-ret));
2663                 goto out;
2664             }
2665             if (ret) {
2666                 continue;
2667             }
2668
2669             /*
2670              * Read old and new backing file and take into consideration that
2671              * backing files may be smaller than the COW image.
2672              */
2673             if (sector >= old_backing_num_sectors) {
2674                 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2675             } else {
2676                 if (sector + n > old_backing_num_sectors) {
2677                     n = old_backing_num_sectors - sector;
2678                 }
2679
2680                 ret = blk_read(blk_old_backing, sector, buf_old, n);
2681                 if (ret < 0) {
2682                     error_report("error while reading from old backing file");
2683                     goto out;
2684                 }
2685             }
2686
2687             if (sector >= new_backing_num_sectors || !blk_new_backing) {
2688                 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2689             } else {
2690                 if (sector + n > new_backing_num_sectors) {
2691                     n = new_backing_num_sectors - sector;
2692                 }
2693
2694                 ret = blk_read(blk_new_backing, sector, buf_new, n);
2695                 if (ret < 0) {
2696                     error_report("error while reading from new backing file");
2697                     goto out;
2698                 }
2699             }
2700
2701             /* If they differ, we need to write to the COW file */
2702             uint64_t written = 0;
2703
2704             while (written < n) {
2705                 int pnum;
2706
2707                 if (compare_sectors(buf_old + written * 512,
2708                     buf_new + written * 512, n - written, &pnum))
2709                 {
2710                     ret = blk_write(blk, sector + written,
2711                                     buf_old + written * 512, pnum);
2712                     if (ret < 0) {
2713                         error_report("Error while writing to COW image: %s",
2714                             strerror(-ret));
2715                         goto out;
2716                     }
2717                 }
2718
2719                 written += pnum;
2720             }
2721             qemu_progress_print(local_progress, 100);
2722         }
2723
2724         qemu_vfree(buf_old);
2725         qemu_vfree(buf_new);
2726     }
2727
2728     /*
2729      * Change the backing file. All clusters that are different from the old
2730      * backing file are overwritten in the COW file now, so the visible content
2731      * doesn't change when we switch the backing file.
2732      */
2733     if (out_baseimg && *out_baseimg) {
2734         ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2735     } else {
2736         ret = bdrv_change_backing_file(bs, NULL, NULL);
2737     }
2738
2739     if (ret == -ENOSPC) {
2740         error_report("Could not change the backing file to '%s': No "
2741                      "space left in the file header", out_baseimg);
2742     } else if (ret < 0) {
2743         error_report("Could not change the backing file to '%s': %s",
2744             out_baseimg, strerror(-ret));
2745     }
2746
2747     qemu_progress_print(100, 0);
2748     /*
2749      * TODO At this point it is possible to check if any clusters that are
2750      * allocated in the COW file are the same in the backing file. If so, they
2751      * could be dropped from the COW file. Don't do this before switching the
2752      * backing file, in case of a crash this would lead to corruption.
2753      */
2754 out:
2755     qemu_progress_end();
2756     /* Cleanup */
2757     if (!unsafe) {
2758         blk_unref(blk_old_backing);
2759         blk_unref(blk_new_backing);
2760     }
2761
2762     blk_unref(blk);
2763     if (ret) {
2764         return 1;
2765     }
2766     return 0;
2767 }
2768
2769 static int img_resize(int argc, char **argv)
2770 {
2771     Error *err = NULL;
2772     int c, ret, relative;
2773     const char *filename, *fmt, *size;
2774     int64_t n, total_size;
2775     bool quiet = false;
2776     BlockBackend *blk = NULL;
2777     QemuOpts *param;
2778     static QemuOptsList resize_options = {
2779         .name = "resize_options",
2780         .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2781         .desc = {
2782             {
2783                 .name = BLOCK_OPT_SIZE,
2784                 .type = QEMU_OPT_SIZE,
2785                 .help = "Virtual disk size"
2786             }, {
2787                 /* end of list */
2788             }
2789         },
2790     };
2791
2792     /* Remove size from argv manually so that negative numbers are not treated
2793      * as options by getopt. */
2794     if (argc < 3) {
2795         error_exit("Not enough arguments");
2796         return 1;
2797     }
2798
2799     size = argv[--argc];
2800
2801     /* Parse getopt arguments */
2802     fmt = NULL;
2803     for(;;) {
2804         c = getopt(argc, argv, "f:hq");
2805         if (c == -1) {
2806             break;
2807         }
2808         switch(c) {
2809         case '?':
2810         case 'h':
2811             help();
2812             break;
2813         case 'f':
2814             fmt = optarg;
2815             break;
2816         case 'q':
2817             quiet = true;
2818             break;
2819         }
2820     }
2821     if (optind != argc - 1) {
2822         error_exit("Expecting one image file name");
2823     }
2824     filename = argv[optind++];
2825
2826     /* Choose grow, shrink, or absolute resize mode */
2827     switch (size[0]) {
2828     case '+':
2829         relative = 1;
2830         size++;
2831         break;
2832     case '-':
2833         relative = -1;
2834         size++;
2835         break;
2836     default:
2837         relative = 0;
2838         break;
2839     }
2840
2841     /* Parse size */
2842     param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2843     qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
2844     if (err) {
2845         error_report_err(err);
2846         ret = -1;
2847         qemu_opts_del(param);
2848         goto out;
2849     }
2850     n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2851     qemu_opts_del(param);
2852
2853     blk = img_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
2854                    true, quiet);
2855     if (!blk) {
2856         ret = -1;
2857         goto out;
2858     }
2859
2860     if (relative) {
2861         total_size = blk_getlength(blk) + n * relative;
2862     } else {
2863         total_size = n;
2864     }
2865     if (total_size <= 0) {
2866         error_report("New image size must be positive");
2867         ret = -1;
2868         goto out;
2869     }
2870
2871     ret = blk_truncate(blk, total_size);
2872     switch (ret) {
2873     case 0:
2874         qprintf(quiet, "Image resized.\n");
2875         break;
2876     case -ENOTSUP:
2877         error_report("This image does not support resize");
2878         break;
2879     case -EACCES:
2880         error_report("Image is read-only");
2881         break;
2882     default:
2883         error_report("Error resizing image (%d)", -ret);
2884         break;
2885     }
2886 out:
2887     blk_unref(blk);
2888     if (ret) {
2889         return 1;
2890     }
2891     return 0;
2892 }
2893
2894 static void amend_status_cb(BlockDriverState *bs,
2895                             int64_t offset, int64_t total_work_size,
2896                             void *opaque)
2897 {
2898     qemu_progress_print(100.f * offset / total_work_size, 0);
2899 }
2900
2901 static int img_amend(int argc, char **argv)
2902 {
2903     Error *err = NULL;
2904     int c, ret = 0;
2905     char *options = NULL;
2906     QemuOptsList *create_opts = NULL;
2907     QemuOpts *opts = NULL;
2908     const char *fmt = NULL, *filename, *cache;
2909     int flags;
2910     bool quiet = false, progress = false;
2911     BlockBackend *blk = NULL;
2912     BlockDriverState *bs = NULL;
2913
2914     cache = BDRV_DEFAULT_CACHE;
2915     for (;;) {
2916         c = getopt(argc, argv, "ho:f:t:pq");
2917         if (c == -1) {
2918             break;
2919         }
2920
2921         switch (c) {
2922             case 'h':
2923             case '?':
2924                 help();
2925                 break;
2926             case 'o':
2927                 if (!is_valid_option_list(optarg)) {
2928                     error_report("Invalid option list: %s", optarg);
2929                     ret = -1;
2930                     goto out_no_progress;
2931                 }
2932                 if (!options) {
2933                     options = g_strdup(optarg);
2934                 } else {
2935                     char *old_options = options;
2936                     options = g_strdup_printf("%s,%s", options, optarg);
2937                     g_free(old_options);
2938                 }
2939                 break;
2940             case 'f':
2941                 fmt = optarg;
2942                 break;
2943             case 't':
2944                 cache = optarg;
2945                 break;
2946             case 'p':
2947                 progress = true;
2948                 break;
2949             case 'q':
2950                 quiet = true;
2951                 break;
2952         }
2953     }
2954
2955     if (!options) {
2956         error_exit("Must specify options (-o)");
2957     }
2958
2959     if (quiet) {
2960         progress = false;
2961     }
2962     qemu_progress_init(progress, 1.0);
2963
2964     filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2965     if (fmt && has_help_option(options)) {
2966         /* If a format is explicitly specified (and possibly no filename is
2967          * given), print option help here */
2968         ret = print_block_option_help(filename, fmt);
2969         goto out;
2970     }
2971
2972     if (optind != argc - 1) {
2973         error_report("Expecting one image file name");
2974         ret = -1;
2975         goto out;
2976     }
2977
2978     flags = BDRV_O_FLAGS | BDRV_O_RDWR;
2979     ret = bdrv_parse_cache_flags(cache, &flags);
2980     if (ret < 0) {
2981         error_report("Invalid cache option: %s", cache);
2982         goto out;
2983     }
2984
2985     blk = img_open("image", filename, fmt, flags, true, quiet);
2986     if (!blk) {
2987         ret = -1;
2988         goto out;
2989     }
2990     bs = blk_bs(blk);
2991
2992     fmt = bs->drv->format_name;
2993
2994     if (has_help_option(options)) {
2995         /* If the format was auto-detected, print option help here */
2996         ret = print_block_option_help(filename, fmt);
2997         goto out;
2998     }
2999
3000     if (!bs->drv->create_opts) {
3001         error_report("Format driver '%s' does not support any options to amend",
3002                      fmt);
3003         ret = -1;
3004         goto out;
3005     }
3006
3007     create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3008     opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3009     if (options) {
3010         qemu_opts_do_parse(opts, options, NULL, &err);
3011         if (err) {
3012             error_report_err(err);
3013             ret = -1;
3014             goto out;
3015         }
3016     }
3017
3018     /* In case the driver does not call amend_status_cb() */
3019     qemu_progress_print(0.f, 0);
3020     ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3021     qemu_progress_print(100.f, 0);
3022     if (ret < 0) {
3023         error_report("Error while amending options: %s", strerror(-ret));
3024         goto out;
3025     }
3026
3027 out:
3028     qemu_progress_end();
3029
3030 out_no_progress:
3031     blk_unref(blk);
3032     qemu_opts_del(opts);
3033     qemu_opts_free(create_opts);
3034     g_free(options);
3035
3036     if (ret) {
3037         return 1;
3038     }
3039     return 0;
3040 }
3041
3042 static const img_cmd_t img_cmds[] = {
3043 #define DEF(option, callback, arg_string)        \
3044     { option, callback },
3045 #include "qemu-img-cmds.h"
3046 #undef DEF
3047 #undef GEN_DOCS
3048     { NULL, NULL, },
3049 };
3050
3051 int main(int argc, char **argv)
3052 {
3053     const img_cmd_t *cmd;
3054     const char *cmdname;
3055     Error *local_error = NULL;
3056     int c;
3057     static const struct option long_options[] = {
3058         {"help", no_argument, 0, 'h'},
3059         {"version", no_argument, 0, 'v'},
3060         {0, 0, 0, 0}
3061     };
3062
3063 #ifdef CONFIG_POSIX
3064     signal(SIGPIPE, SIG_IGN);
3065 #endif
3066
3067     error_set_progname(argv[0]);
3068     qemu_init_exec_dir(argv[0]);
3069
3070     if (qemu_init_main_loop(&local_error)) {
3071         error_report_err(local_error);
3072         exit(EXIT_FAILURE);
3073     }
3074
3075     bdrv_init();
3076     if (argc < 2) {
3077         error_exit("Not enough arguments");
3078     }
3079     cmdname = argv[1];
3080
3081     /* find the command */
3082     for (cmd = img_cmds; cmd->name != NULL; cmd++) {
3083         if (!strcmp(cmdname, cmd->name)) {
3084             return cmd->handler(argc - 1, argv + 1);
3085         }
3086     }
3087
3088     c = getopt_long(argc, argv, "h", long_options, NULL);
3089
3090     if (c == 'h') {
3091         help();
3092     }
3093     if (c == 'v') {
3094         printf(QEMU_IMG_VERSION);
3095         return 0;
3096     }
3097
3098     /* not found */
3099     error_exit("Command not found: %s", cmdname);
3100 }