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