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