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