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