qemu-img.c

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