blockdev-backup: utilize do_backup_common
[qemu/ar7.git] / qemu-img.c
blobc920e3564cba3f635ddf5ab7d1afcef959790d12
1 /*
2 * QEMU disk image utility
4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
25 #include "qemu/osdep.h"
26 #include <getopt.h>
28 #include "qemu-common.h"
29 #include "qemu-version.h"
30 #include "qapi/error.h"
31 #include "qapi/qapi-visit-block-core.h"
32 #include "qapi/qobject-output-visitor.h"
33 #include "qapi/qmp/qjson.h"
34 #include "qapi/qmp/qdict.h"
35 #include "qapi/qmp/qstring.h"
36 #include "qemu/cutils.h"
37 #include "qemu/config-file.h"
38 #include "qemu/option.h"
39 #include "qemu/error-report.h"
40 #include "qemu/log.h"
41 #include "qemu/main-loop.h"
42 #include "qemu/module.h"
43 #include "qemu/units.h"
44 #include "qom/object_interfaces.h"
45 #include "sysemu/block-backend.h"
46 #include "block/block_int.h"
47 #include "block/blockjob.h"
48 #include "block/qapi.h"
49 #include "crypto/init.h"
50 #include "trace/control.h"
52 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
53 "\n" QEMU_COPYRIGHT "\n"
55 typedef struct img_cmd_t {
56 const char *name;
57 int (*handler)(int argc, char **argv);
58 } img_cmd_t;
60 enum {
61 OPTION_OUTPUT = 256,
62 OPTION_BACKING_CHAIN = 257,
63 OPTION_OBJECT = 258,
64 OPTION_IMAGE_OPTS = 259,
65 OPTION_PATTERN = 260,
66 OPTION_FLUSH_INTERVAL = 261,
67 OPTION_NO_DRAIN = 262,
68 OPTION_TARGET_IMAGE_OPTS = 263,
69 OPTION_SIZE = 264,
70 OPTION_PREALLOCATION = 265,
71 OPTION_SHRINK = 266,
72 OPTION_SALVAGE = 267,
75 typedef enum OutputFormat {
76 OFORMAT_JSON,
77 OFORMAT_HUMAN,
78 } OutputFormat;
80 /* Default to cache=writeback as data integrity is not important for qemu-img */
81 #define BDRV_DEFAULT_CACHE "writeback"
83 static void format_print(void *opaque, const char *name)
85 printf(" %s", name);
88 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
90 va_list ap;
92 va_start(ap, fmt);
93 error_vreport(fmt, ap);
94 va_end(ap);
96 error_printf("Try 'qemu-img --help' for more information\n");
97 exit(EXIT_FAILURE);
100 static void QEMU_NORETURN missing_argument(const char *option)
102 error_exit("missing argument for option '%s'", option);
105 static void QEMU_NORETURN unrecognized_option(const char *option)
107 error_exit("unrecognized option '%s'", option);
110 /* Please keep in synch with qemu-img.texi */
111 static void QEMU_NORETURN help(void)
113 const char *help_msg =
114 QEMU_IMG_VERSION
115 "usage: qemu-img [standard options] command [command options]\n"
116 "QEMU disk image utility\n"
117 "\n"
118 " '-h', '--help' display this help and exit\n"
119 " '-V', '--version' output version information and exit\n"
120 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
121 " specify tracing options\n"
122 "\n"
123 "Command syntax:\n"
124 #define DEF(option, callback, arg_string) \
125 " " arg_string "\n"
126 #include "qemu-img-cmds.h"
127 #undef DEF
128 "\n"
129 "Command parameters:\n"
130 " 'filename' is a disk image filename\n"
131 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
132 " manual page for a description of the object properties. The most common\n"
133 " object type is a 'secret', which is used to supply passwords and/or\n"
134 " encryption keys.\n"
135 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
136 " 'cache' is the cache mode used to write the output disk image, the valid\n"
137 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
138 " 'directsync' and 'unsafe' (default for convert)\n"
139 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
140 " options are the same as for the 'cache' option\n"
141 " 'size' is the disk image size in bytes. Optional suffixes\n"
142 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
143 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
144 " supported. 'b' is ignored.\n"
145 " 'output_filename' is the destination disk image filename\n"
146 " 'output_fmt' is the destination format\n"
147 " 'options' is a comma separated list of format specific options in a\n"
148 " name=value format. Use -o ? for an overview of the options supported by the\n"
149 " used format\n"
150 " 'snapshot_param' is param used for internal snapshot, format\n"
151 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
152 " '[ID_OR_NAME]'\n"
153 " '-c' indicates that target image must be compressed (qcow format only)\n"
154 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
155 " new backing file match exactly. The image doesn't need a working\n"
156 " backing file before rebasing in this case (useful for renaming the\n"
157 " backing file). For image creation, allow creating without attempting\n"
158 " to open the backing file.\n"
159 " '-h' with or without a command shows this help and lists the supported formats\n"
160 " '-p' show progress of command (only certain commands)\n"
161 " '-q' use Quiet mode - do not print any output (except errors)\n"
162 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
163 " contain only zeros for qemu-img to create a sparse image during\n"
164 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
165 " unallocated or zero sectors, and the destination image will always be\n"
166 " fully allocated\n"
167 " '--output' takes the format in which the output must be done (human or json)\n"
168 " '-n' skips the target volume creation (useful if the volume is created\n"
169 " prior to running qemu-img)\n"
170 "\n"
171 "Parameters to check subcommand:\n"
172 " '-r' tries to repair any inconsistencies that are found during the check.\n"
173 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
174 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
175 " hiding corruption that has already occurred.\n"
176 "\n"
177 "Parameters to convert subcommand:\n"
178 " '-m' specifies how many coroutines work in parallel during the convert\n"
179 " process (defaults to 8)\n"
180 " '-W' allow to write to the target out of order rather than sequential\n"
181 "\n"
182 "Parameters to snapshot subcommand:\n"
183 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
184 " '-a' applies a snapshot (revert disk to saved state)\n"
185 " '-c' creates a snapshot\n"
186 " '-d' deletes a snapshot\n"
187 " '-l' lists all snapshots in the given image\n"
188 "\n"
189 "Parameters to compare subcommand:\n"
190 " '-f' first image format\n"
191 " '-F' second image format\n"
192 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
193 "\n"
194 "Parameters to dd subcommand:\n"
195 " 'bs=BYTES' read and write up to BYTES bytes at a time "
196 "(default: 512)\n"
197 " 'count=N' copy only N input blocks\n"
198 " 'if=FILE' read from FILE\n"
199 " 'of=FILE' write to FILE\n"
200 " 'skip=N' skip N bs-sized blocks at the start of input\n";
202 printf("%s\nSupported formats:", help_msg);
203 bdrv_iterate_format(format_print, NULL, false);
204 printf("\n\n" QEMU_HELP_BOTTOM "\n");
205 exit(EXIT_SUCCESS);
208 static QemuOptsList qemu_object_opts = {
209 .name = "object",
210 .implied_opt_name = "qom-type",
211 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
212 .desc = {
217 static QemuOptsList qemu_source_opts = {
218 .name = "source",
219 .implied_opt_name = "file",
220 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
221 .desc = {
226 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
228 int ret = 0;
229 if (!quiet) {
230 va_list args;
231 va_start(args, fmt);
232 ret = vprintf(fmt, args);
233 va_end(args);
235 return ret;
239 static int print_block_option_help(const char *filename, const char *fmt)
241 BlockDriver *drv, *proto_drv;
242 QemuOptsList *create_opts = NULL;
243 Error *local_err = NULL;
245 /* Find driver and parse its options */
246 drv = bdrv_find_format(fmt);
247 if (!drv) {
248 error_report("Unknown file format '%s'", fmt);
249 return 1;
252 if (!drv->create_opts) {
253 error_report("Format driver '%s' does not support image creation", fmt);
254 return 1;
257 create_opts = qemu_opts_append(create_opts, drv->create_opts);
258 if (filename) {
259 proto_drv = bdrv_find_protocol(filename, true, &local_err);
260 if (!proto_drv) {
261 error_report_err(local_err);
262 qemu_opts_free(create_opts);
263 return 1;
265 if (!proto_drv->create_opts) {
266 error_report("Protocol driver '%s' does not support image creation",
267 proto_drv->format_name);
268 qemu_opts_free(create_opts);
269 return 1;
271 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
274 if (filename) {
275 printf("Supported options:\n");
276 } else {
277 printf("Supported %s options:\n", fmt);
279 qemu_opts_print_help(create_opts, false);
280 qemu_opts_free(create_opts);
282 if (!filename) {
283 printf("\n"
284 "The protocol level may support further options.\n"
285 "Specify the target filename to include those options.\n");
288 return 0;
292 static BlockBackend *img_open_opts(const char *optstr,
293 QemuOpts *opts, int flags, bool writethrough,
294 bool quiet, bool force_share)
296 QDict *options;
297 Error *local_err = NULL;
298 BlockBackend *blk;
299 options = qemu_opts_to_qdict(opts, NULL);
300 if (force_share) {
301 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
302 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
303 error_report("--force-share/-U conflicts with image options");
304 qobject_unref(options);
305 return NULL;
307 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
309 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
310 if (!blk) {
311 error_reportf_err(local_err, "Could not open '%s': ", optstr);
312 return NULL;
314 blk_set_enable_write_cache(blk, !writethrough);
316 return blk;
319 static BlockBackend *img_open_file(const char *filename,
320 QDict *options,
321 const char *fmt, int flags,
322 bool writethrough, bool quiet,
323 bool force_share)
325 BlockBackend *blk;
326 Error *local_err = NULL;
328 if (!options) {
329 options = qdict_new();
331 if (fmt) {
332 qdict_put_str(options, "driver", fmt);
335 if (force_share) {
336 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
338 blk = blk_new_open(filename, NULL, options, flags, &local_err);
339 if (!blk) {
340 error_reportf_err(local_err, "Could not open '%s': ", filename);
341 return NULL;
343 blk_set_enable_write_cache(blk, !writethrough);
345 return blk;
349 static int img_add_key_secrets(void *opaque,
350 const char *name, const char *value,
351 Error **errp)
353 QDict *options = opaque;
355 if (g_str_has_suffix(name, "key-secret")) {
356 qdict_put_str(options, name, value);
359 return 0;
363 static BlockBackend *img_open(bool image_opts,
364 const char *filename,
365 const char *fmt, int flags, bool writethrough,
366 bool quiet, bool force_share)
368 BlockBackend *blk;
369 if (image_opts) {
370 QemuOpts *opts;
371 if (fmt) {
372 error_report("--image-opts and --format are mutually exclusive");
373 return NULL;
375 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
376 filename, true);
377 if (!opts) {
378 return NULL;
380 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
381 force_share);
382 } else {
383 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
384 force_share);
386 return blk;
390 static int add_old_style_options(const char *fmt, QemuOpts *opts,
391 const char *base_filename,
392 const char *base_fmt)
394 Error *err = NULL;
396 if (base_filename) {
397 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
398 if (err) {
399 error_report("Backing file not supported for file format '%s'",
400 fmt);
401 error_free(err);
402 return -1;
405 if (base_fmt) {
406 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
407 if (err) {
408 error_report("Backing file format not supported for file "
409 "format '%s'", fmt);
410 error_free(err);
411 return -1;
414 return 0;
417 static int64_t cvtnum(const char *s)
419 int err;
420 uint64_t value;
422 err = qemu_strtosz(s, NULL, &value);
423 if (err < 0) {
424 return err;
426 if (value > INT64_MAX) {
427 return -ERANGE;
429 return value;
432 static int img_create(int argc, char **argv)
434 int c;
435 uint64_t img_size = -1;
436 const char *fmt = "raw";
437 const char *base_fmt = NULL;
438 const char *filename;
439 const char *base_filename = NULL;
440 char *options = NULL;
441 Error *local_err = NULL;
442 bool quiet = false;
443 int flags = 0;
445 for(;;) {
446 static const struct option long_options[] = {
447 {"help", no_argument, 0, 'h'},
448 {"object", required_argument, 0, OPTION_OBJECT},
449 {0, 0, 0, 0}
451 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
452 long_options, NULL);
453 if (c == -1) {
454 break;
456 switch(c) {
457 case ':':
458 missing_argument(argv[optind - 1]);
459 break;
460 case '?':
461 unrecognized_option(argv[optind - 1]);
462 break;
463 case 'h':
464 help();
465 break;
466 case 'F':
467 base_fmt = optarg;
468 break;
469 case 'b':
470 base_filename = optarg;
471 break;
472 case 'f':
473 fmt = optarg;
474 break;
475 case 'o':
476 if (!is_valid_option_list(optarg)) {
477 error_report("Invalid option list: %s", optarg);
478 goto fail;
480 if (!options) {
481 options = g_strdup(optarg);
482 } else {
483 char *old_options = options;
484 options = g_strdup_printf("%s,%s", options, optarg);
485 g_free(old_options);
487 break;
488 case 'q':
489 quiet = true;
490 break;
491 case 'u':
492 flags |= BDRV_O_NO_BACKING;
493 break;
494 case OPTION_OBJECT: {
495 QemuOpts *opts;
496 opts = qemu_opts_parse_noisily(&qemu_object_opts,
497 optarg, true);
498 if (!opts) {
499 goto fail;
501 } break;
505 /* Get the filename */
506 filename = (optind < argc) ? argv[optind] : NULL;
507 if (options && has_help_option(options)) {
508 g_free(options);
509 return print_block_option_help(filename, fmt);
512 if (optind >= argc) {
513 error_exit("Expecting image file name");
515 optind++;
517 if (qemu_opts_foreach(&qemu_object_opts,
518 user_creatable_add_opts_foreach,
519 NULL, &error_fatal)) {
520 goto fail;
523 /* Get image size, if specified */
524 if (optind < argc) {
525 int64_t sval;
527 sval = cvtnum(argv[optind++]);
528 if (sval < 0) {
529 if (sval == -ERANGE) {
530 error_report("Image size must be less than 8 EiB!");
531 } else {
532 error_report("Invalid image size specified! You may use k, M, "
533 "G, T, P or E suffixes for ");
534 error_report("kilobytes, megabytes, gigabytes, terabytes, "
535 "petabytes and exabytes.");
537 goto fail;
539 img_size = (uint64_t)sval;
541 if (optind != argc) {
542 error_exit("Unexpected argument: %s", argv[optind]);
545 bdrv_img_create(filename, fmt, base_filename, base_fmt,
546 options, img_size, flags, quiet, &local_err);
547 if (local_err) {
548 error_reportf_err(local_err, "%s: ", filename);
549 goto fail;
552 g_free(options);
553 return 0;
555 fail:
556 g_free(options);
557 return 1;
560 static void dump_json_image_check(ImageCheck *check, bool quiet)
562 QString *str;
563 QObject *obj;
564 Visitor *v = qobject_output_visitor_new(&obj);
566 visit_type_ImageCheck(v, NULL, &check, &error_abort);
567 visit_complete(v, &obj);
568 str = qobject_to_json_pretty(obj);
569 assert(str != NULL);
570 qprintf(quiet, "%s\n", qstring_get_str(str));
571 qobject_unref(obj);
572 visit_free(v);
573 qobject_unref(str);
576 static void dump_human_image_check(ImageCheck *check, bool quiet)
578 if (!(check->corruptions || check->leaks || check->check_errors)) {
579 qprintf(quiet, "No errors were found on the image.\n");
580 } else {
581 if (check->corruptions) {
582 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
583 "Data may be corrupted, or further writes to the image "
584 "may corrupt it.\n",
585 check->corruptions);
588 if (check->leaks) {
589 qprintf(quiet,
590 "\n%" PRId64 " leaked clusters were found on the image.\n"
591 "This means waste of disk space, but no harm to data.\n",
592 check->leaks);
595 if (check->check_errors) {
596 qprintf(quiet,
597 "\n%" PRId64
598 " internal errors have occurred during the check.\n",
599 check->check_errors);
603 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
604 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
605 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
606 check->allocated_clusters, check->total_clusters,
607 check->allocated_clusters * 100.0 / check->total_clusters,
608 check->fragmented_clusters * 100.0 / check->allocated_clusters,
609 check->compressed_clusters * 100.0 /
610 check->allocated_clusters);
613 if (check->image_end_offset) {
614 qprintf(quiet,
615 "Image end offset: %" PRId64 "\n", check->image_end_offset);
619 static int collect_image_check(BlockDriverState *bs,
620 ImageCheck *check,
621 const char *filename,
622 const char *fmt,
623 int fix)
625 int ret;
626 BdrvCheckResult result;
628 ret = bdrv_check(bs, &result, fix);
629 if (ret < 0) {
630 return ret;
633 check->filename = g_strdup(filename);
634 check->format = g_strdup(bdrv_get_format_name(bs));
635 check->check_errors = result.check_errors;
636 check->corruptions = result.corruptions;
637 check->has_corruptions = result.corruptions != 0;
638 check->leaks = result.leaks;
639 check->has_leaks = result.leaks != 0;
640 check->corruptions_fixed = result.corruptions_fixed;
641 check->has_corruptions_fixed = result.corruptions != 0;
642 check->leaks_fixed = result.leaks_fixed;
643 check->has_leaks_fixed = result.leaks != 0;
644 check->image_end_offset = result.image_end_offset;
645 check->has_image_end_offset = result.image_end_offset != 0;
646 check->total_clusters = result.bfi.total_clusters;
647 check->has_total_clusters = result.bfi.total_clusters != 0;
648 check->allocated_clusters = result.bfi.allocated_clusters;
649 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
650 check->fragmented_clusters = result.bfi.fragmented_clusters;
651 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
652 check->compressed_clusters = result.bfi.compressed_clusters;
653 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
655 return 0;
659 * Checks an image for consistency. Exit codes:
661 * 0 - Check completed, image is good
662 * 1 - Check not completed because of internal errors
663 * 2 - Check completed, image is corrupted
664 * 3 - Check completed, image has leaked clusters, but is good otherwise
665 * 63 - Checks are not supported by the image format
667 static int img_check(int argc, char **argv)
669 int c, ret;
670 OutputFormat output_format = OFORMAT_HUMAN;
671 const char *filename, *fmt, *output, *cache;
672 BlockBackend *blk;
673 BlockDriverState *bs;
674 int fix = 0;
675 int flags = BDRV_O_CHECK;
676 bool writethrough;
677 ImageCheck *check;
678 bool quiet = false;
679 bool image_opts = false;
680 bool force_share = false;
682 fmt = NULL;
683 output = NULL;
684 cache = BDRV_DEFAULT_CACHE;
686 for(;;) {
687 int option_index = 0;
688 static const struct option long_options[] = {
689 {"help", no_argument, 0, 'h'},
690 {"format", required_argument, 0, 'f'},
691 {"repair", required_argument, 0, 'r'},
692 {"output", required_argument, 0, OPTION_OUTPUT},
693 {"object", required_argument, 0, OPTION_OBJECT},
694 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
695 {"force-share", no_argument, 0, 'U'},
696 {0, 0, 0, 0}
698 c = getopt_long(argc, argv, ":hf:r:T:qU",
699 long_options, &option_index);
700 if (c == -1) {
701 break;
703 switch(c) {
704 case ':':
705 missing_argument(argv[optind - 1]);
706 break;
707 case '?':
708 unrecognized_option(argv[optind - 1]);
709 break;
710 case 'h':
711 help();
712 break;
713 case 'f':
714 fmt = optarg;
715 break;
716 case 'r':
717 flags |= BDRV_O_RDWR;
719 if (!strcmp(optarg, "leaks")) {
720 fix = BDRV_FIX_LEAKS;
721 } else if (!strcmp(optarg, "all")) {
722 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
723 } else {
724 error_exit("Unknown option value for -r "
725 "(expecting 'leaks' or 'all'): %s", optarg);
727 break;
728 case OPTION_OUTPUT:
729 output = optarg;
730 break;
731 case 'T':
732 cache = optarg;
733 break;
734 case 'q':
735 quiet = true;
736 break;
737 case 'U':
738 force_share = true;
739 break;
740 case OPTION_OBJECT: {
741 QemuOpts *opts;
742 opts = qemu_opts_parse_noisily(&qemu_object_opts,
743 optarg, true);
744 if (!opts) {
745 return 1;
747 } break;
748 case OPTION_IMAGE_OPTS:
749 image_opts = true;
750 break;
753 if (optind != argc - 1) {
754 error_exit("Expecting one image file name");
756 filename = argv[optind++];
758 if (output && !strcmp(output, "json")) {
759 output_format = OFORMAT_JSON;
760 } else if (output && !strcmp(output, "human")) {
761 output_format = OFORMAT_HUMAN;
762 } else if (output) {
763 error_report("--output must be used with human or json as argument.");
764 return 1;
767 if (qemu_opts_foreach(&qemu_object_opts,
768 user_creatable_add_opts_foreach,
769 NULL, &error_fatal)) {
770 return 1;
773 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
774 if (ret < 0) {
775 error_report("Invalid source cache option: %s", cache);
776 return 1;
779 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
780 force_share);
781 if (!blk) {
782 return 1;
784 bs = blk_bs(blk);
786 check = g_new0(ImageCheck, 1);
787 ret = collect_image_check(bs, check, filename, fmt, fix);
789 if (ret == -ENOTSUP) {
790 error_report("This image format does not support checks");
791 ret = 63;
792 goto fail;
795 if (check->corruptions_fixed || check->leaks_fixed) {
796 int corruptions_fixed, leaks_fixed;
798 leaks_fixed = check->leaks_fixed;
799 corruptions_fixed = check->corruptions_fixed;
801 if (output_format == OFORMAT_HUMAN) {
802 qprintf(quiet,
803 "The following inconsistencies were found and repaired:\n\n"
804 " %" PRId64 " leaked clusters\n"
805 " %" PRId64 " corruptions\n\n"
806 "Double checking the fixed image now...\n",
807 check->leaks_fixed,
808 check->corruptions_fixed);
811 ret = collect_image_check(bs, check, filename, fmt, 0);
813 check->leaks_fixed = leaks_fixed;
814 check->corruptions_fixed = corruptions_fixed;
817 if (!ret) {
818 switch (output_format) {
819 case OFORMAT_HUMAN:
820 dump_human_image_check(check, quiet);
821 break;
822 case OFORMAT_JSON:
823 dump_json_image_check(check, quiet);
824 break;
828 if (ret || check->check_errors) {
829 if (ret) {
830 error_report("Check failed: %s", strerror(-ret));
831 } else {
832 error_report("Check failed");
834 ret = 1;
835 goto fail;
838 if (check->corruptions) {
839 ret = 2;
840 } else if (check->leaks) {
841 ret = 3;
842 } else {
843 ret = 0;
846 fail:
847 qapi_free_ImageCheck(check);
848 blk_unref(blk);
849 return ret;
852 typedef struct CommonBlockJobCBInfo {
853 BlockDriverState *bs;
854 Error **errp;
855 } CommonBlockJobCBInfo;
857 static void common_block_job_cb(void *opaque, int ret)
859 CommonBlockJobCBInfo *cbi = opaque;
861 if (ret < 0) {
862 error_setg_errno(cbi->errp, -ret, "Block job failed");
866 static void run_block_job(BlockJob *job, Error **errp)
868 AioContext *aio_context = blk_get_aio_context(job->blk);
869 int ret = 0;
871 aio_context_acquire(aio_context);
872 job_ref(&job->job);
873 do {
874 float progress = 0.0f;
875 aio_poll(aio_context, true);
876 if (job->job.progress_total) {
877 progress = (float)job->job.progress_current /
878 job->job.progress_total * 100.f;
880 qemu_progress_print(progress, 0);
881 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
883 if (!job_is_completed(&job->job)) {
884 ret = job_complete_sync(&job->job, errp);
885 } else {
886 ret = job->job.ret;
888 job_unref(&job->job);
889 aio_context_release(aio_context);
891 /* publish completion progress only when success */
892 if (!ret) {
893 qemu_progress_print(100.f, 0);
897 static int img_commit(int argc, char **argv)
899 int c, ret, flags;
900 const char *filename, *fmt, *cache, *base;
901 BlockBackend *blk;
902 BlockDriverState *bs, *base_bs;
903 BlockJob *job;
904 bool progress = false, quiet = false, drop = false;
905 bool writethrough;
906 Error *local_err = NULL;
907 CommonBlockJobCBInfo cbi;
908 bool image_opts = false;
909 AioContext *aio_context;
911 fmt = NULL;
912 cache = BDRV_DEFAULT_CACHE;
913 base = NULL;
914 for(;;) {
915 static const struct option long_options[] = {
916 {"help", no_argument, 0, 'h'},
917 {"object", required_argument, 0, OPTION_OBJECT},
918 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
919 {0, 0, 0, 0}
921 c = getopt_long(argc, argv, ":f:ht:b:dpq",
922 long_options, NULL);
923 if (c == -1) {
924 break;
926 switch(c) {
927 case ':':
928 missing_argument(argv[optind - 1]);
929 break;
930 case '?':
931 unrecognized_option(argv[optind - 1]);
932 break;
933 case 'h':
934 help();
935 break;
936 case 'f':
937 fmt = optarg;
938 break;
939 case 't':
940 cache = optarg;
941 break;
942 case 'b':
943 base = optarg;
944 /* -b implies -d */
945 drop = true;
946 break;
947 case 'd':
948 drop = true;
949 break;
950 case 'p':
951 progress = true;
952 break;
953 case 'q':
954 quiet = true;
955 break;
956 case OPTION_OBJECT: {
957 QemuOpts *opts;
958 opts = qemu_opts_parse_noisily(&qemu_object_opts,
959 optarg, true);
960 if (!opts) {
961 return 1;
963 } break;
964 case OPTION_IMAGE_OPTS:
965 image_opts = true;
966 break;
970 /* Progress is not shown in Quiet mode */
971 if (quiet) {
972 progress = false;
975 if (optind != argc - 1) {
976 error_exit("Expecting one image file name");
978 filename = argv[optind++];
980 if (qemu_opts_foreach(&qemu_object_opts,
981 user_creatable_add_opts_foreach,
982 NULL, &error_fatal)) {
983 return 1;
986 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
987 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
988 if (ret < 0) {
989 error_report("Invalid cache option: %s", cache);
990 return 1;
993 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
994 false);
995 if (!blk) {
996 return 1;
998 bs = blk_bs(blk);
1000 qemu_progress_init(progress, 1.f);
1001 qemu_progress_print(0.f, 100);
1003 if (base) {
1004 base_bs = bdrv_find_backing_image(bs, base);
1005 if (!base_bs) {
1006 error_setg(&local_err,
1007 "Did not find '%s' in the backing chain of '%s'",
1008 base, filename);
1009 goto done;
1011 } else {
1012 /* This is different from QMP, which by default uses the deepest file in
1013 * the backing chain (i.e., the very base); however, the traditional
1014 * behavior of qemu-img commit is using the immediate backing file. */
1015 base_bs = backing_bs(bs);
1016 if (!base_bs) {
1017 error_setg(&local_err, "Image does not have a backing file");
1018 goto done;
1022 cbi = (CommonBlockJobCBInfo){
1023 .errp = &local_err,
1024 .bs = bs,
1027 aio_context = bdrv_get_aio_context(bs);
1028 aio_context_acquire(aio_context);
1029 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
1030 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1031 &cbi, false, &local_err);
1032 aio_context_release(aio_context);
1033 if (local_err) {
1034 goto done;
1037 /* When the block job completes, the BlockBackend reference will point to
1038 * the old backing file. In order to avoid that the top image is already
1039 * deleted, so we can still empty it afterwards, increment the reference
1040 * counter here preemptively. */
1041 if (!drop) {
1042 bdrv_ref(bs);
1045 job = block_job_get("commit");
1046 assert(job);
1047 run_block_job(job, &local_err);
1048 if (local_err) {
1049 goto unref_backing;
1052 if (!drop && bs->drv->bdrv_make_empty) {
1053 ret = bs->drv->bdrv_make_empty(bs);
1054 if (ret) {
1055 error_setg_errno(&local_err, -ret, "Could not empty %s",
1056 filename);
1057 goto unref_backing;
1061 unref_backing:
1062 if (!drop) {
1063 bdrv_unref(bs);
1066 done:
1067 qemu_progress_end();
1069 blk_unref(blk);
1071 if (local_err) {
1072 error_report_err(local_err);
1073 return 1;
1076 qprintf(quiet, "Image committed.\n");
1077 return 0;
1081 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1082 * of the first sector boundary within buf where the sector contains a
1083 * non-zero byte. This function is robust to a buffer that is not
1084 * sector-aligned.
1086 static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1088 int64_t i;
1089 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1091 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1092 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1093 return i;
1096 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1097 return i;
1099 return -1;
1103 * Returns true iff the first sector pointed to by 'buf' contains at least
1104 * a non-NUL byte.
1106 * 'pnum' is set to the number of sectors (including and immediately following
1107 * the first one) that are known to be in the same allocated/unallocated state.
1108 * The function will try to align the end offset to alignment boundaries so
1109 * that the request will at least end aligned and consequtive requests will
1110 * also start at an aligned offset.
1112 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1113 int64_t sector_num, int alignment)
1115 bool is_zero;
1116 int i, tail;
1118 if (n <= 0) {
1119 *pnum = 0;
1120 return 0;
1122 is_zero = buffer_is_zero(buf, 512);
1123 for(i = 1; i < n; i++) {
1124 buf += 512;
1125 if (is_zero != buffer_is_zero(buf, 512)) {
1126 break;
1130 tail = (sector_num + i) & (alignment - 1);
1131 if (tail) {
1132 if (is_zero && i <= tail) {
1133 /* treat unallocated areas which only consist
1134 * of a small tail as allocated. */
1135 is_zero = false;
1137 if (!is_zero) {
1138 /* align up end offset of allocated areas. */
1139 i += alignment - tail;
1140 i = MIN(i, n);
1141 } else {
1142 /* align down end offset of zero areas. */
1143 i -= tail;
1146 *pnum = i;
1147 return !is_zero;
1151 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1152 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1153 * breaking up write requests for only small sparse areas.
1155 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1156 int min, int64_t sector_num, int alignment)
1158 int ret;
1159 int num_checked, num_used;
1161 if (n < min) {
1162 min = n;
1165 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1166 if (!ret) {
1167 return ret;
1170 num_used = *pnum;
1171 buf += BDRV_SECTOR_SIZE * *pnum;
1172 n -= *pnum;
1173 sector_num += *pnum;
1174 num_checked = num_used;
1176 while (n > 0) {
1177 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1179 buf += BDRV_SECTOR_SIZE * *pnum;
1180 n -= *pnum;
1181 sector_num += *pnum;
1182 num_checked += *pnum;
1183 if (ret) {
1184 num_used = num_checked;
1185 } else if (*pnum >= min) {
1186 break;
1190 *pnum = num_used;
1191 return 1;
1195 * Compares two buffers sector by sector. Returns 0 if the first
1196 * sector of each buffer matches, non-zero otherwise.
1198 * pnum is set to the sector-aligned size of the buffer prefix that
1199 * has the same matching status as the first sector.
1201 static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1202 int64_t bytes, int64_t *pnum)
1204 bool res;
1205 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
1207 assert(bytes > 0);
1209 res = !!memcmp(buf1, buf2, i);
1210 while (i < bytes) {
1211 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
1213 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
1214 break;
1216 i += len;
1219 *pnum = i;
1220 return res;
1223 #define IO_BUF_SIZE (2 * MiB)
1226 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1228 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1229 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1230 * failure), and 4 on error (the exit status for read errors), after emitting
1231 * an error message.
1233 * @param blk: BlockBackend for the image
1234 * @param offset: Starting offset to check
1235 * @param bytes: Number of bytes to check
1236 * @param filename: Name of disk file we are checking (logging purpose)
1237 * @param buffer: Allocated buffer for storing read data
1238 * @param quiet: Flag for quiet mode
1240 static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1241 int64_t bytes, const char *filename,
1242 uint8_t *buffer, bool quiet)
1244 int ret = 0;
1245 int64_t idx;
1247 ret = blk_pread(blk, offset, buffer, bytes);
1248 if (ret < 0) {
1249 error_report("Error while reading offset %" PRId64 " of %s: %s",
1250 offset, filename, strerror(-ret));
1251 return 4;
1253 idx = find_nonzero(buffer, bytes);
1254 if (idx >= 0) {
1255 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1256 offset + idx);
1257 return 1;
1260 return 0;
1264 * Compares two images. Exit codes:
1266 * 0 - Images are identical
1267 * 1 - Images differ
1268 * >1 - Error occurred
1270 static int img_compare(int argc, char **argv)
1272 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1273 BlockBackend *blk1, *blk2;
1274 BlockDriverState *bs1, *bs2;
1275 int64_t total_size1, total_size2;
1276 uint8_t *buf1 = NULL, *buf2 = NULL;
1277 int64_t pnum1, pnum2;
1278 int allocated1, allocated2;
1279 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1280 bool progress = false, quiet = false, strict = false;
1281 int flags;
1282 bool writethrough;
1283 int64_t total_size;
1284 int64_t offset = 0;
1285 int64_t chunk;
1286 int c;
1287 uint64_t progress_base;
1288 bool image_opts = false;
1289 bool force_share = false;
1291 cache = BDRV_DEFAULT_CACHE;
1292 for (;;) {
1293 static const struct option long_options[] = {
1294 {"help", no_argument, 0, 'h'},
1295 {"object", required_argument, 0, OPTION_OBJECT},
1296 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1297 {"force-share", no_argument, 0, 'U'},
1298 {0, 0, 0, 0}
1300 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1301 long_options, NULL);
1302 if (c == -1) {
1303 break;
1305 switch (c) {
1306 case ':':
1307 missing_argument(argv[optind - 1]);
1308 break;
1309 case '?':
1310 unrecognized_option(argv[optind - 1]);
1311 break;
1312 case 'h':
1313 help();
1314 break;
1315 case 'f':
1316 fmt1 = optarg;
1317 break;
1318 case 'F':
1319 fmt2 = optarg;
1320 break;
1321 case 'T':
1322 cache = optarg;
1323 break;
1324 case 'p':
1325 progress = true;
1326 break;
1327 case 'q':
1328 quiet = true;
1329 break;
1330 case 's':
1331 strict = true;
1332 break;
1333 case 'U':
1334 force_share = true;
1335 break;
1336 case OPTION_OBJECT: {
1337 QemuOpts *opts;
1338 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1339 optarg, true);
1340 if (!opts) {
1341 ret = 2;
1342 goto out4;
1344 } break;
1345 case OPTION_IMAGE_OPTS:
1346 image_opts = true;
1347 break;
1351 /* Progress is not shown in Quiet mode */
1352 if (quiet) {
1353 progress = false;
1357 if (optind != argc - 2) {
1358 error_exit("Expecting two image file names");
1360 filename1 = argv[optind++];
1361 filename2 = argv[optind++];
1363 if (qemu_opts_foreach(&qemu_object_opts,
1364 user_creatable_add_opts_foreach,
1365 NULL, &error_fatal)) {
1366 ret = 2;
1367 goto out4;
1370 /* Initialize before goto out */
1371 qemu_progress_init(progress, 2.0);
1373 flags = 0;
1374 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1375 if (ret < 0) {
1376 error_report("Invalid source cache option: %s", cache);
1377 ret = 2;
1378 goto out3;
1381 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1382 force_share);
1383 if (!blk1) {
1384 ret = 2;
1385 goto out3;
1388 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1389 force_share);
1390 if (!blk2) {
1391 ret = 2;
1392 goto out2;
1394 bs1 = blk_bs(blk1);
1395 bs2 = blk_bs(blk2);
1397 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1398 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1399 total_size1 = blk_getlength(blk1);
1400 if (total_size1 < 0) {
1401 error_report("Can't get size of %s: %s",
1402 filename1, strerror(-total_size1));
1403 ret = 4;
1404 goto out;
1406 total_size2 = blk_getlength(blk2);
1407 if (total_size2 < 0) {
1408 error_report("Can't get size of %s: %s",
1409 filename2, strerror(-total_size2));
1410 ret = 4;
1411 goto out;
1413 total_size = MIN(total_size1, total_size2);
1414 progress_base = MAX(total_size1, total_size2);
1416 qemu_progress_print(0, 100);
1418 if (strict && total_size1 != total_size2) {
1419 ret = 1;
1420 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1421 goto out;
1424 while (offset < total_size) {
1425 int status1, status2;
1427 status1 = bdrv_block_status_above(bs1, NULL, offset,
1428 total_size1 - offset, &pnum1, NULL,
1429 NULL);
1430 if (status1 < 0) {
1431 ret = 3;
1432 error_report("Sector allocation test failed for %s", filename1);
1433 goto out;
1435 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1437 status2 = bdrv_block_status_above(bs2, NULL, offset,
1438 total_size2 - offset, &pnum2, NULL,
1439 NULL);
1440 if (status2 < 0) {
1441 ret = 3;
1442 error_report("Sector allocation test failed for %s", filename2);
1443 goto out;
1445 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1447 assert(pnum1 && pnum2);
1448 chunk = MIN(pnum1, pnum2);
1450 if (strict) {
1451 if (status1 != status2) {
1452 ret = 1;
1453 qprintf(quiet, "Strict mode: Offset %" PRId64
1454 " block status mismatch!\n", offset);
1455 goto out;
1458 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1459 /* nothing to do */
1460 } else if (allocated1 == allocated2) {
1461 if (allocated1) {
1462 int64_t pnum;
1464 chunk = MIN(chunk, IO_BUF_SIZE);
1465 ret = blk_pread(blk1, offset, buf1, chunk);
1466 if (ret < 0) {
1467 error_report("Error while reading offset %" PRId64
1468 " of %s: %s",
1469 offset, filename1, strerror(-ret));
1470 ret = 4;
1471 goto out;
1473 ret = blk_pread(blk2, offset, buf2, chunk);
1474 if (ret < 0) {
1475 error_report("Error while reading offset %" PRId64
1476 " of %s: %s",
1477 offset, filename2, strerror(-ret));
1478 ret = 4;
1479 goto out;
1481 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1482 if (ret || pnum != chunk) {
1483 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1484 offset + (ret ? 0 : pnum));
1485 ret = 1;
1486 goto out;
1489 } else {
1490 chunk = MIN(chunk, IO_BUF_SIZE);
1491 if (allocated1) {
1492 ret = check_empty_sectors(blk1, offset, chunk,
1493 filename1, buf1, quiet);
1494 } else {
1495 ret = check_empty_sectors(blk2, offset, chunk,
1496 filename2, buf1, quiet);
1498 if (ret) {
1499 goto out;
1502 offset += chunk;
1503 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1506 if (total_size1 != total_size2) {
1507 BlockBackend *blk_over;
1508 const char *filename_over;
1510 qprintf(quiet, "Warning: Image size mismatch!\n");
1511 if (total_size1 > total_size2) {
1512 blk_over = blk1;
1513 filename_over = filename1;
1514 } else {
1515 blk_over = blk2;
1516 filename_over = filename2;
1519 while (offset < progress_base) {
1520 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1521 progress_base - offset, &chunk,
1522 NULL, NULL);
1523 if (ret < 0) {
1524 ret = 3;
1525 error_report("Sector allocation test failed for %s",
1526 filename_over);
1527 goto out;
1530 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1531 chunk = MIN(chunk, IO_BUF_SIZE);
1532 ret = check_empty_sectors(blk_over, offset, chunk,
1533 filename_over, buf1, quiet);
1534 if (ret) {
1535 goto out;
1538 offset += chunk;
1539 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1543 qprintf(quiet, "Images are identical.\n");
1544 ret = 0;
1546 out:
1547 qemu_vfree(buf1);
1548 qemu_vfree(buf2);
1549 blk_unref(blk2);
1550 out2:
1551 blk_unref(blk1);
1552 out3:
1553 qemu_progress_end();
1554 out4:
1555 return ret;
1558 enum ImgConvertBlockStatus {
1559 BLK_DATA,
1560 BLK_ZERO,
1561 BLK_BACKING_FILE,
1564 #define MAX_COROUTINES 16
1566 typedef struct ImgConvertState {
1567 BlockBackend **src;
1568 int64_t *src_sectors;
1569 int src_num;
1570 int64_t total_sectors;
1571 int64_t allocated_sectors;
1572 int64_t allocated_done;
1573 int64_t sector_num;
1574 int64_t wr_offs;
1575 enum ImgConvertBlockStatus status;
1576 int64_t sector_next_status;
1577 BlockBackend *target;
1578 bool has_zero_init;
1579 bool compressed;
1580 bool unallocated_blocks_are_zero;
1581 bool target_has_backing;
1582 int64_t target_backing_sectors; /* negative if unknown */
1583 bool wr_in_order;
1584 bool copy_range;
1585 bool salvage;
1586 bool quiet;
1587 int min_sparse;
1588 int alignment;
1589 size_t cluster_sectors;
1590 size_t buf_sectors;
1591 long num_coroutines;
1592 int running_coroutines;
1593 Coroutine *co[MAX_COROUTINES];
1594 int64_t wait_sector_num[MAX_COROUTINES];
1595 CoMutex lock;
1596 int ret;
1597 } ImgConvertState;
1599 static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1600 int *src_cur, int64_t *src_cur_offset)
1602 *src_cur = 0;
1603 *src_cur_offset = 0;
1604 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1605 *src_cur_offset += s->src_sectors[*src_cur];
1606 (*src_cur)++;
1607 assert(*src_cur < s->src_num);
1611 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1613 int64_t src_cur_offset;
1614 int ret, n, src_cur;
1615 bool post_backing_zero = false;
1617 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1619 assert(s->total_sectors > sector_num);
1620 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1622 if (s->target_backing_sectors >= 0) {
1623 if (sector_num >= s->target_backing_sectors) {
1624 post_backing_zero = s->unallocated_blocks_are_zero;
1625 } else if (sector_num + n > s->target_backing_sectors) {
1626 /* Split requests around target_backing_sectors (because
1627 * starting from there, zeros are handled differently) */
1628 n = s->target_backing_sectors - sector_num;
1632 if (s->sector_next_status <= sector_num) {
1633 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1634 int64_t count;
1636 do {
1637 count = n * BDRV_SECTOR_SIZE;
1639 if (s->target_has_backing) {
1640 ret = bdrv_block_status(blk_bs(s->src[src_cur]), offset,
1641 count, &count, NULL, NULL);
1642 } else {
1643 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1644 offset, count, &count, NULL,
1645 NULL);
1648 if (ret < 0) {
1649 if (s->salvage) {
1650 if (n == 1) {
1651 if (!s->quiet) {
1652 warn_report("error while reading block status at "
1653 "offset %" PRIu64 ": %s", offset,
1654 strerror(-ret));
1656 /* Just try to read the data, then */
1657 ret = BDRV_BLOCK_DATA;
1658 count = BDRV_SECTOR_SIZE;
1659 } else {
1660 /* Retry on a shorter range */
1661 n = DIV_ROUND_UP(n, 4);
1663 } else {
1664 error_report("error while reading block status at offset "
1665 "%" PRIu64 ": %s", offset, strerror(-ret));
1666 return ret;
1669 } while (ret < 0);
1671 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1673 if (ret & BDRV_BLOCK_ZERO) {
1674 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1675 } else if (ret & BDRV_BLOCK_DATA) {
1676 s->status = BLK_DATA;
1677 } else {
1678 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1681 s->sector_next_status = sector_num + n;
1684 n = MIN(n, s->sector_next_status - sector_num);
1685 if (s->status == BLK_DATA) {
1686 n = MIN(n, s->buf_sectors);
1689 /* We need to write complete clusters for compressed images, so if an
1690 * unallocated area is shorter than that, we must consider the whole
1691 * cluster allocated. */
1692 if (s->compressed) {
1693 if (n < s->cluster_sectors) {
1694 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1695 s->status = BLK_DATA;
1696 } else {
1697 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1701 return n;
1704 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1705 int nb_sectors, uint8_t *buf)
1707 uint64_t single_read_until = 0;
1708 int n, ret;
1710 assert(nb_sectors <= s->buf_sectors);
1711 while (nb_sectors > 0) {
1712 BlockBackend *blk;
1713 int src_cur;
1714 int64_t bs_sectors, src_cur_offset;
1715 uint64_t offset;
1717 /* In the case of compression with multiple source files, we can get a
1718 * nb_sectors that spreads into the next part. So we must be able to
1719 * read across multiple BDSes for one convert_read() call. */
1720 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1721 blk = s->src[src_cur];
1722 bs_sectors = s->src_sectors[src_cur];
1724 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1726 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1727 if (single_read_until > offset) {
1728 n = 1;
1731 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
1732 if (ret < 0) {
1733 if (s->salvage) {
1734 if (n > 1) {
1735 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1736 continue;
1737 } else {
1738 if (!s->quiet) {
1739 warn_report("error while reading offset %" PRIu64
1740 ": %s", offset, strerror(-ret));
1742 memset(buf, 0, BDRV_SECTOR_SIZE);
1744 } else {
1745 return ret;
1749 sector_num += n;
1750 nb_sectors -= n;
1751 buf += n * BDRV_SECTOR_SIZE;
1754 return 0;
1758 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1759 int nb_sectors, uint8_t *buf,
1760 enum ImgConvertBlockStatus status)
1762 int ret;
1764 while (nb_sectors > 0) {
1765 int n = nb_sectors;
1766 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1768 switch (status) {
1769 case BLK_BACKING_FILE:
1770 /* If we have a backing file, leave clusters unallocated that are
1771 * unallocated in the source image, so that the backing file is
1772 * visible at the respective offset. */
1773 assert(s->target_has_backing);
1774 break;
1776 case BLK_DATA:
1777 /* If we're told to keep the target fully allocated (-S 0) or there
1778 * is real non-zero data, we must write it. Otherwise we can treat
1779 * it as zero sectors.
1780 * Compressed clusters need to be written as a whole, so in that
1781 * case we can only save the write if the buffer is completely
1782 * zeroed. */
1783 if (!s->min_sparse ||
1784 (!s->compressed &&
1785 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1786 sector_num, s->alignment)) ||
1787 (s->compressed &&
1788 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1790 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1791 n << BDRV_SECTOR_BITS, buf, flags);
1792 if (ret < 0) {
1793 return ret;
1795 break;
1797 /* fall-through */
1799 case BLK_ZERO:
1800 if (s->has_zero_init) {
1801 assert(!s->target_has_backing);
1802 break;
1804 ret = blk_co_pwrite_zeroes(s->target,
1805 sector_num << BDRV_SECTOR_BITS,
1806 n << BDRV_SECTOR_BITS,
1807 BDRV_REQ_MAY_UNMAP);
1808 if (ret < 0) {
1809 return ret;
1811 break;
1814 sector_num += n;
1815 nb_sectors -= n;
1816 buf += n * BDRV_SECTOR_SIZE;
1819 return 0;
1822 static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1823 int nb_sectors)
1825 int n, ret;
1827 while (nb_sectors > 0) {
1828 BlockBackend *blk;
1829 int src_cur;
1830 int64_t bs_sectors, src_cur_offset;
1831 int64_t offset;
1833 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1834 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1835 blk = s->src[src_cur];
1836 bs_sectors = s->src_sectors[src_cur];
1838 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1840 ret = blk_co_copy_range(blk, offset, s->target,
1841 sector_num << BDRV_SECTOR_BITS,
1842 n << BDRV_SECTOR_BITS, 0, 0);
1843 if (ret < 0) {
1844 return ret;
1847 sector_num += n;
1848 nb_sectors -= n;
1850 return 0;
1853 static void coroutine_fn convert_co_do_copy(void *opaque)
1855 ImgConvertState *s = opaque;
1856 uint8_t *buf = NULL;
1857 int ret, i;
1858 int index = -1;
1860 for (i = 0; i < s->num_coroutines; i++) {
1861 if (s->co[i] == qemu_coroutine_self()) {
1862 index = i;
1863 break;
1866 assert(index >= 0);
1868 s->running_coroutines++;
1869 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1871 while (1) {
1872 int n;
1873 int64_t sector_num;
1874 enum ImgConvertBlockStatus status;
1875 bool copy_range;
1877 qemu_co_mutex_lock(&s->lock);
1878 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1879 qemu_co_mutex_unlock(&s->lock);
1880 break;
1882 n = convert_iteration_sectors(s, s->sector_num);
1883 if (n < 0) {
1884 qemu_co_mutex_unlock(&s->lock);
1885 s->ret = n;
1886 break;
1888 /* save current sector and allocation status to local variables */
1889 sector_num = s->sector_num;
1890 status = s->status;
1891 if (!s->min_sparse && s->status == BLK_ZERO) {
1892 n = MIN(n, s->buf_sectors);
1894 /* increment global sector counter so that other coroutines can
1895 * already continue reading beyond this request */
1896 s->sector_num += n;
1897 qemu_co_mutex_unlock(&s->lock);
1899 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1900 s->allocated_done += n;
1901 qemu_progress_print(100.0 * s->allocated_done /
1902 s->allocated_sectors, 0);
1905 retry:
1906 copy_range = s->copy_range && s->status == BLK_DATA;
1907 if (status == BLK_DATA && !copy_range) {
1908 ret = convert_co_read(s, sector_num, n, buf);
1909 if (ret < 0) {
1910 error_report("error while reading sector %" PRId64
1911 ": %s", sector_num, strerror(-ret));
1912 s->ret = ret;
1914 } else if (!s->min_sparse && status == BLK_ZERO) {
1915 status = BLK_DATA;
1916 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1919 if (s->wr_in_order) {
1920 /* keep writes in order */
1921 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
1922 s->wait_sector_num[index] = sector_num;
1923 qemu_coroutine_yield();
1925 s->wait_sector_num[index] = -1;
1928 if (s->ret == -EINPROGRESS) {
1929 if (copy_range) {
1930 ret = convert_co_copy_range(s, sector_num, n);
1931 if (ret) {
1932 s->copy_range = false;
1933 goto retry;
1935 } else {
1936 ret = convert_co_write(s, sector_num, n, buf, status);
1938 if (ret < 0) {
1939 error_report("error while writing sector %" PRId64
1940 ": %s", sector_num, strerror(-ret));
1941 s->ret = ret;
1945 if (s->wr_in_order) {
1946 /* reenter the coroutine that might have waited
1947 * for this write to complete */
1948 s->wr_offs = sector_num + n;
1949 for (i = 0; i < s->num_coroutines; i++) {
1950 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1952 * A -> B -> A cannot occur because A has
1953 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1954 * B will never enter A during this time window.
1956 qemu_coroutine_enter(s->co[i]);
1957 break;
1963 qemu_vfree(buf);
1964 s->co[index] = NULL;
1965 s->running_coroutines--;
1966 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1967 /* the convert job finished successfully */
1968 s->ret = 0;
1972 static int convert_do_copy(ImgConvertState *s)
1974 int ret, i, n;
1975 int64_t sector_num = 0;
1977 /* Check whether we have zero initialisation or can get it efficiently */
1978 s->has_zero_init = s->min_sparse && !s->target_has_backing
1979 ? bdrv_has_zero_init(blk_bs(s->target))
1980 : false;
1982 if (!s->has_zero_init && !s->target_has_backing &&
1983 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1985 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK);
1986 if (ret == 0) {
1987 s->has_zero_init = true;
1991 /* Allocate buffer for copied data. For compressed images, only one cluster
1992 * can be copied at a time. */
1993 if (s->compressed) {
1994 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1995 error_report("invalid cluster size");
1996 return -EINVAL;
1998 s->buf_sectors = s->cluster_sectors;
2001 while (sector_num < s->total_sectors) {
2002 n = convert_iteration_sectors(s, sector_num);
2003 if (n < 0) {
2004 return n;
2006 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2008 s->allocated_sectors += n;
2010 sector_num += n;
2013 /* Do the copy */
2014 s->sector_next_status = 0;
2015 s->ret = -EINPROGRESS;
2017 qemu_co_mutex_init(&s->lock);
2018 for (i = 0; i < s->num_coroutines; i++) {
2019 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2020 s->wait_sector_num[i] = -1;
2021 qemu_coroutine_enter(s->co[i]);
2024 while (s->running_coroutines) {
2025 main_loop_wait(false);
2028 if (s->compressed && !s->ret) {
2029 /* signal EOF to align */
2030 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
2031 if (ret < 0) {
2032 return ret;
2036 return s->ret;
2039 #define MAX_BUF_SECTORS 32768
2041 static int img_convert(int argc, char **argv)
2043 int c, bs_i, flags, src_flags = 0;
2044 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
2045 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2046 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
2047 BlockDriver *drv = NULL, *proto_drv = NULL;
2048 BlockDriverInfo bdi;
2049 BlockDriverState *out_bs;
2050 QemuOpts *opts = NULL, *sn_opts = NULL;
2051 QemuOptsList *create_opts = NULL;
2052 QDict *open_opts = NULL;
2053 char *options = NULL;
2054 Error *local_err = NULL;
2055 bool writethrough, src_writethrough, image_opts = false,
2056 skip_create = false, progress = false, tgt_image_opts = false;
2057 int64_t ret = -EINVAL;
2058 bool force_share = false;
2059 bool explict_min_sparse = false;
2061 ImgConvertState s = (ImgConvertState) {
2062 /* Need at least 4k of zeros for sparse detection */
2063 .min_sparse = 8,
2064 .copy_range = false,
2065 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2066 .wr_in_order = true,
2067 .num_coroutines = 8,
2070 for(;;) {
2071 static const struct option long_options[] = {
2072 {"help", no_argument, 0, 'h'},
2073 {"object", required_argument, 0, OPTION_OBJECT},
2074 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2075 {"force-share", no_argument, 0, 'U'},
2076 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2077 {"salvage", no_argument, 0, OPTION_SALVAGE},
2078 {0, 0, 0, 0}
2080 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
2081 long_options, NULL);
2082 if (c == -1) {
2083 break;
2085 switch(c) {
2086 case ':':
2087 missing_argument(argv[optind - 1]);
2088 break;
2089 case '?':
2090 unrecognized_option(argv[optind - 1]);
2091 break;
2092 case 'h':
2093 help();
2094 break;
2095 case 'f':
2096 fmt = optarg;
2097 break;
2098 case 'O':
2099 out_fmt = optarg;
2100 break;
2101 case 'B':
2102 out_baseimg = optarg;
2103 break;
2104 case 'C':
2105 s.copy_range = true;
2106 break;
2107 case 'c':
2108 s.compressed = true;
2109 break;
2110 case 'o':
2111 if (!is_valid_option_list(optarg)) {
2112 error_report("Invalid option list: %s", optarg);
2113 goto fail_getopt;
2115 if (!options) {
2116 options = g_strdup(optarg);
2117 } else {
2118 char *old_options = options;
2119 options = g_strdup_printf("%s,%s", options, optarg);
2120 g_free(old_options);
2122 break;
2123 case 'l':
2124 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2125 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2126 optarg, false);
2127 if (!sn_opts) {
2128 error_report("Failed in parsing snapshot param '%s'",
2129 optarg);
2130 goto fail_getopt;
2132 } else {
2133 snapshot_name = optarg;
2135 break;
2136 case 'S':
2138 int64_t sval;
2140 sval = cvtnum(optarg);
2141 if (sval < 0 || sval & (BDRV_SECTOR_SIZE - 1) ||
2142 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2143 error_report("Invalid buffer size for sparse output specified. "
2144 "Valid sizes are multiples of %llu up to %llu. Select "
2145 "0 to disable sparse detection (fully allocates output).",
2146 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2147 goto fail_getopt;
2150 s.min_sparse = sval / BDRV_SECTOR_SIZE;
2151 explict_min_sparse = true;
2152 break;
2154 case 'p':
2155 progress = true;
2156 break;
2157 case 't':
2158 cache = optarg;
2159 break;
2160 case 'T':
2161 src_cache = optarg;
2162 break;
2163 case 'q':
2164 s.quiet = true;
2165 break;
2166 case 'n':
2167 skip_create = true;
2168 break;
2169 case 'm':
2170 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2171 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2172 error_report("Invalid number of coroutines. Allowed number of"
2173 " coroutines is between 1 and %d", MAX_COROUTINES);
2174 goto fail_getopt;
2176 break;
2177 case 'W':
2178 s.wr_in_order = false;
2179 break;
2180 case 'U':
2181 force_share = true;
2182 break;
2183 case OPTION_OBJECT: {
2184 QemuOpts *object_opts;
2185 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2186 optarg, true);
2187 if (!object_opts) {
2188 goto fail_getopt;
2190 break;
2192 case OPTION_IMAGE_OPTS:
2193 image_opts = true;
2194 break;
2195 case OPTION_SALVAGE:
2196 s.salvage = true;
2197 break;
2198 case OPTION_TARGET_IMAGE_OPTS:
2199 tgt_image_opts = true;
2200 break;
2204 if (!out_fmt && !tgt_image_opts) {
2205 out_fmt = "raw";
2208 if (qemu_opts_foreach(&qemu_object_opts,
2209 user_creatable_add_opts_foreach,
2210 NULL, &error_fatal)) {
2211 goto fail_getopt;
2214 if (s.compressed && s.copy_range) {
2215 error_report("Cannot enable copy offloading when -c is used");
2216 goto fail_getopt;
2219 if (explict_min_sparse && s.copy_range) {
2220 error_report("Cannot enable copy offloading when -S is used");
2221 goto fail_getopt;
2224 if (s.copy_range && s.salvage) {
2225 error_report("Cannot use copy offloading in salvaging mode");
2226 goto fail_getopt;
2229 if (tgt_image_opts && !skip_create) {
2230 error_report("--target-image-opts requires use of -n flag");
2231 goto fail_getopt;
2234 if (skip_create && options) {
2235 warn_report("-o has no effect when skipping image creation");
2236 warn_report("This will become an error in future QEMU versions.");
2239 s.src_num = argc - optind - 1;
2240 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2242 if (options && has_help_option(options)) {
2243 if (out_fmt) {
2244 ret = print_block_option_help(out_filename, out_fmt);
2245 goto fail_getopt;
2246 } else {
2247 error_report("Option help requires a format be specified");
2248 goto fail_getopt;
2252 if (s.src_num < 1) {
2253 error_report("Must specify image file name");
2254 goto fail_getopt;
2258 /* ret is still -EINVAL until here */
2259 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2260 if (ret < 0) {
2261 error_report("Invalid source cache option: %s", src_cache);
2262 goto fail_getopt;
2265 /* Initialize before goto out */
2266 if (s.quiet) {
2267 progress = false;
2269 qemu_progress_init(progress, 1.0);
2270 qemu_progress_print(0, 100);
2272 s.src = g_new0(BlockBackend *, s.src_num);
2273 s.src_sectors = g_new(int64_t, s.src_num);
2275 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2276 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2277 fmt, src_flags, src_writethrough, s.quiet,
2278 force_share);
2279 if (!s.src[bs_i]) {
2280 ret = -1;
2281 goto out;
2283 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2284 if (s.src_sectors[bs_i] < 0) {
2285 error_report("Could not get size of %s: %s",
2286 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2287 ret = -1;
2288 goto out;
2290 s.total_sectors += s.src_sectors[bs_i];
2293 if (sn_opts) {
2294 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2295 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2296 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2297 &local_err);
2298 } else if (snapshot_name != NULL) {
2299 if (s.src_num > 1) {
2300 error_report("No support for concatenating multiple snapshot");
2301 ret = -1;
2302 goto out;
2305 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2306 &local_err);
2308 if (local_err) {
2309 error_reportf_err(local_err, "Failed to load snapshot: ");
2310 ret = -1;
2311 goto out;
2314 if (!skip_create) {
2315 /* Find driver and parse its options */
2316 drv = bdrv_find_format(out_fmt);
2317 if (!drv) {
2318 error_report("Unknown file format '%s'", out_fmt);
2319 ret = -1;
2320 goto out;
2323 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2324 if (!proto_drv) {
2325 error_report_err(local_err);
2326 ret = -1;
2327 goto out;
2330 if (!drv->create_opts) {
2331 error_report("Format driver '%s' does not support image creation",
2332 drv->format_name);
2333 ret = -1;
2334 goto out;
2337 if (!proto_drv->create_opts) {
2338 error_report("Protocol driver '%s' does not support image creation",
2339 proto_drv->format_name);
2340 ret = -1;
2341 goto out;
2344 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2345 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2347 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2348 if (options) {
2349 qemu_opts_do_parse(opts, options, NULL, &local_err);
2350 if (local_err) {
2351 error_report_err(local_err);
2352 ret = -1;
2353 goto out;
2357 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2358 &error_abort);
2359 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2360 if (ret < 0) {
2361 goto out;
2365 /* Get backing file name if -o backing_file was used */
2366 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2367 if (out_baseimg_param) {
2368 out_baseimg = out_baseimg_param;
2370 s.target_has_backing = (bool) out_baseimg;
2372 if (s.src_num > 1 && out_baseimg) {
2373 error_report("Having a backing file for the target makes no sense when "
2374 "concatenating multiple input images");
2375 ret = -1;
2376 goto out;
2379 /* Check if compression is supported */
2380 if (s.compressed) {
2381 bool encryption =
2382 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2383 const char *encryptfmt =
2384 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2385 const char *preallocation =
2386 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2388 if (drv && !drv->bdrv_co_pwritev_compressed) {
2389 error_report("Compression not supported for this file format");
2390 ret = -1;
2391 goto out;
2394 if (encryption || encryptfmt) {
2395 error_report("Compression and encryption not supported at "
2396 "the same time");
2397 ret = -1;
2398 goto out;
2401 if (preallocation
2402 && strcmp(preallocation, "off"))
2404 error_report("Compression and preallocation not supported at "
2405 "the same time");
2406 ret = -1;
2407 goto out;
2412 * The later open call will need any decryption secrets, and
2413 * bdrv_create() will purge "opts", so extract them now before
2414 * they are lost.
2416 if (!skip_create) {
2417 open_opts = qdict_new();
2418 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2421 if (!skip_create) {
2422 /* Create the new image */
2423 ret = bdrv_create(drv, out_filename, opts, &local_err);
2424 if (ret < 0) {
2425 error_reportf_err(local_err, "%s: error while converting %s: ",
2426 out_filename, out_fmt);
2427 goto out;
2431 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2432 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2433 if (ret < 0) {
2434 error_report("Invalid cache option: %s", cache);
2435 goto out;
2438 if (skip_create) {
2439 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
2440 flags, writethrough, s.quiet, false);
2441 } else {
2442 /* TODO ultimately we should allow --target-image-opts
2443 * to be used even when -n is not given.
2444 * That has to wait for bdrv_create to be improved
2445 * to allow filenames in option syntax
2447 s.target = img_open_file(out_filename, open_opts, out_fmt,
2448 flags, writethrough, s.quiet, false);
2449 open_opts = NULL; /* blk_new_open will have freed it */
2451 if (!s.target) {
2452 ret = -1;
2453 goto out;
2455 out_bs = blk_bs(s.target);
2457 if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
2458 error_report("Compression not supported for this file format");
2459 ret = -1;
2460 goto out;
2463 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2464 * or discard_alignment of the out_bs is greater. Limit to
2465 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2466 s.buf_sectors = MIN(MAX_BUF_SECTORS,
2467 MAX(s.buf_sectors,
2468 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2469 out_bs->bl.pdiscard_alignment >>
2470 BDRV_SECTOR_BITS)));
2472 /* try to align the write requests to the destination to avoid unnecessary
2473 * RMW cycles. */
2474 s.alignment = MAX(pow2floor(s.min_sparse),
2475 DIV_ROUND_UP(out_bs->bl.request_alignment,
2476 BDRV_SECTOR_SIZE));
2477 assert(is_power_of_2(s.alignment));
2479 if (skip_create) {
2480 int64_t output_sectors = blk_nb_sectors(s.target);
2481 if (output_sectors < 0) {
2482 error_report("unable to get output image length: %s",
2483 strerror(-output_sectors));
2484 ret = -1;
2485 goto out;
2486 } else if (output_sectors < s.total_sectors) {
2487 error_report("output file is smaller than input file");
2488 ret = -1;
2489 goto out;
2493 if (s.target_has_backing) {
2494 /* Errors are treated as "backing length unknown" (which means
2495 * s.target_backing_sectors has to be negative, which it will
2496 * be automatically). The backing file length is used only
2497 * for optimizations, so such a case is not fatal. */
2498 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2499 } else {
2500 s.target_backing_sectors = -1;
2503 ret = bdrv_get_info(out_bs, &bdi);
2504 if (ret < 0) {
2505 if (s.compressed) {
2506 error_report("could not get block driver info");
2507 goto out;
2509 } else {
2510 s.compressed = s.compressed || bdi.needs_compressed_writes;
2511 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2512 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
2515 ret = convert_do_copy(&s);
2516 out:
2517 if (!ret) {
2518 qemu_progress_print(100, 0);
2520 qemu_progress_end();
2521 qemu_opts_del(opts);
2522 qemu_opts_free(create_opts);
2523 qemu_opts_del(sn_opts);
2524 qobject_unref(open_opts);
2525 blk_unref(s.target);
2526 if (s.src) {
2527 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2528 blk_unref(s.src[bs_i]);
2530 g_free(s.src);
2532 g_free(s.src_sectors);
2533 fail_getopt:
2534 g_free(options);
2536 return !!ret;
2540 static void dump_snapshots(BlockDriverState *bs)
2542 QEMUSnapshotInfo *sn_tab, *sn;
2543 int nb_sns, i;
2545 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2546 if (nb_sns <= 0)
2547 return;
2548 printf("Snapshot list:\n");
2549 bdrv_snapshot_dump(NULL);
2550 printf("\n");
2551 for(i = 0; i < nb_sns; i++) {
2552 sn = &sn_tab[i];
2553 bdrv_snapshot_dump(sn);
2554 printf("\n");
2556 g_free(sn_tab);
2559 static void dump_json_image_info_list(ImageInfoList *list)
2561 QString *str;
2562 QObject *obj;
2563 Visitor *v = qobject_output_visitor_new(&obj);
2565 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2566 visit_complete(v, &obj);
2567 str = qobject_to_json_pretty(obj);
2568 assert(str != NULL);
2569 printf("%s\n", qstring_get_str(str));
2570 qobject_unref(obj);
2571 visit_free(v);
2572 qobject_unref(str);
2575 static void dump_json_image_info(ImageInfo *info)
2577 QString *str;
2578 QObject *obj;
2579 Visitor *v = qobject_output_visitor_new(&obj);
2581 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2582 visit_complete(v, &obj);
2583 str = qobject_to_json_pretty(obj);
2584 assert(str != NULL);
2585 printf("%s\n", qstring_get_str(str));
2586 qobject_unref(obj);
2587 visit_free(v);
2588 qobject_unref(str);
2591 static void dump_human_image_info_list(ImageInfoList *list)
2593 ImageInfoList *elem;
2594 bool delim = false;
2596 for (elem = list; elem; elem = elem->next) {
2597 if (delim) {
2598 printf("\n");
2600 delim = true;
2602 bdrv_image_info_dump(elem->value);
2606 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2608 return strcmp(a, b) == 0;
2612 * Open an image file chain and return an ImageInfoList
2614 * @filename: topmost image filename
2615 * @fmt: topmost image format (may be NULL to autodetect)
2616 * @chain: true - enumerate entire backing file chain
2617 * false - only topmost image file
2619 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2620 * image file. If there was an error a message will have been printed to
2621 * stderr.
2623 static ImageInfoList *collect_image_info_list(bool image_opts,
2624 const char *filename,
2625 const char *fmt,
2626 bool chain, bool force_share)
2628 ImageInfoList *head = NULL;
2629 ImageInfoList **last = &head;
2630 GHashTable *filenames;
2631 Error *err = NULL;
2633 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2635 while (filename) {
2636 BlockBackend *blk;
2637 BlockDriverState *bs;
2638 ImageInfo *info;
2639 ImageInfoList *elem;
2641 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2642 error_report("Backing file '%s' creates an infinite loop.",
2643 filename);
2644 goto err;
2646 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2648 blk = img_open(image_opts, filename, fmt,
2649 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2650 force_share);
2651 if (!blk) {
2652 goto err;
2654 bs = blk_bs(blk);
2656 bdrv_query_image_info(bs, &info, &err);
2657 if (err) {
2658 error_report_err(err);
2659 blk_unref(blk);
2660 goto err;
2663 elem = g_new0(ImageInfoList, 1);
2664 elem->value = info;
2665 *last = elem;
2666 last = &elem->next;
2668 blk_unref(blk);
2670 filename = fmt = NULL;
2671 if (chain) {
2672 if (info->has_full_backing_filename) {
2673 filename = info->full_backing_filename;
2674 } else if (info->has_backing_filename) {
2675 error_report("Could not determine absolute backing filename,"
2676 " but backing filename '%s' present",
2677 info->backing_filename);
2678 goto err;
2680 if (info->has_backing_filename_format) {
2681 fmt = info->backing_filename_format;
2685 g_hash_table_destroy(filenames);
2686 return head;
2688 err:
2689 qapi_free_ImageInfoList(head);
2690 g_hash_table_destroy(filenames);
2691 return NULL;
2694 static int img_info(int argc, char **argv)
2696 int c;
2697 OutputFormat output_format = OFORMAT_HUMAN;
2698 bool chain = false;
2699 const char *filename, *fmt, *output;
2700 ImageInfoList *list;
2701 bool image_opts = false;
2702 bool force_share = false;
2704 fmt = NULL;
2705 output = NULL;
2706 for(;;) {
2707 int option_index = 0;
2708 static const struct option long_options[] = {
2709 {"help", no_argument, 0, 'h'},
2710 {"format", required_argument, 0, 'f'},
2711 {"output", required_argument, 0, OPTION_OUTPUT},
2712 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2713 {"object", required_argument, 0, OPTION_OBJECT},
2714 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2715 {"force-share", no_argument, 0, 'U'},
2716 {0, 0, 0, 0}
2718 c = getopt_long(argc, argv, ":f:hU",
2719 long_options, &option_index);
2720 if (c == -1) {
2721 break;
2723 switch(c) {
2724 case ':':
2725 missing_argument(argv[optind - 1]);
2726 break;
2727 case '?':
2728 unrecognized_option(argv[optind - 1]);
2729 break;
2730 case 'h':
2731 help();
2732 break;
2733 case 'f':
2734 fmt = optarg;
2735 break;
2736 case 'U':
2737 force_share = true;
2738 break;
2739 case OPTION_OUTPUT:
2740 output = optarg;
2741 break;
2742 case OPTION_BACKING_CHAIN:
2743 chain = true;
2744 break;
2745 case OPTION_OBJECT: {
2746 QemuOpts *opts;
2747 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2748 optarg, true);
2749 if (!opts) {
2750 return 1;
2752 } break;
2753 case OPTION_IMAGE_OPTS:
2754 image_opts = true;
2755 break;
2758 if (optind != argc - 1) {
2759 error_exit("Expecting one image file name");
2761 filename = argv[optind++];
2763 if (output && !strcmp(output, "json")) {
2764 output_format = OFORMAT_JSON;
2765 } else if (output && !strcmp(output, "human")) {
2766 output_format = OFORMAT_HUMAN;
2767 } else if (output) {
2768 error_report("--output must be used with human or json as argument.");
2769 return 1;
2772 if (qemu_opts_foreach(&qemu_object_opts,
2773 user_creatable_add_opts_foreach,
2774 NULL, &error_fatal)) {
2775 return 1;
2778 list = collect_image_info_list(image_opts, filename, fmt, chain,
2779 force_share);
2780 if (!list) {
2781 return 1;
2784 switch (output_format) {
2785 case OFORMAT_HUMAN:
2786 dump_human_image_info_list(list);
2787 break;
2788 case OFORMAT_JSON:
2789 if (chain) {
2790 dump_json_image_info_list(list);
2791 } else {
2792 dump_json_image_info(list->value);
2794 break;
2797 qapi_free_ImageInfoList(list);
2798 return 0;
2801 static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2802 MapEntry *next)
2804 switch (output_format) {
2805 case OFORMAT_HUMAN:
2806 if (e->data && !e->has_offset) {
2807 error_report("File contains external, encrypted or compressed clusters.");
2808 return -1;
2810 if (e->data && !e->zero) {
2811 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2812 e->start, e->length,
2813 e->has_offset ? e->offset : 0,
2814 e->has_filename ? e->filename : "");
2816 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2817 * Modify the flags here to allow more coalescing.
2819 if (next && (!next->data || next->zero)) {
2820 next->data = false;
2821 next->zero = true;
2823 break;
2824 case OFORMAT_JSON:
2825 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2826 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2827 (e->start == 0 ? "[" : ",\n"),
2828 e->start, e->length, e->depth,
2829 e->zero ? "true" : "false",
2830 e->data ? "true" : "false");
2831 if (e->has_offset) {
2832 printf(", \"offset\": %"PRId64"", e->offset);
2834 putchar('}');
2836 if (!next) {
2837 printf("]\n");
2839 break;
2841 return 0;
2844 static int get_block_status(BlockDriverState *bs, int64_t offset,
2845 int64_t bytes, MapEntry *e)
2847 int ret;
2848 int depth;
2849 BlockDriverState *file;
2850 bool has_offset;
2851 int64_t map;
2852 char *filename = NULL;
2854 /* As an optimization, we could cache the current range of unallocated
2855 * clusters in each file of the chain, and avoid querying the same
2856 * range repeatedly.
2859 depth = 0;
2860 for (;;) {
2861 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
2862 if (ret < 0) {
2863 return ret;
2865 assert(bytes);
2866 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2867 break;
2869 bs = backing_bs(bs);
2870 if (bs == NULL) {
2871 ret = 0;
2872 break;
2875 depth++;
2878 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2880 if (file && has_offset) {
2881 bdrv_refresh_filename(file);
2882 filename = file->filename;
2885 *e = (MapEntry) {
2886 .start = offset,
2887 .length = bytes,
2888 .data = !!(ret & BDRV_BLOCK_DATA),
2889 .zero = !!(ret & BDRV_BLOCK_ZERO),
2890 .offset = map,
2891 .has_offset = has_offset,
2892 .depth = depth,
2893 .has_filename = filename,
2894 .filename = filename,
2897 return 0;
2900 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2902 if (curr->length == 0) {
2903 return false;
2905 if (curr->zero != next->zero ||
2906 curr->data != next->data ||
2907 curr->depth != next->depth ||
2908 curr->has_filename != next->has_filename ||
2909 curr->has_offset != next->has_offset) {
2910 return false;
2912 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2913 return false;
2915 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2916 return false;
2918 return true;
2921 static int img_map(int argc, char **argv)
2923 int c;
2924 OutputFormat output_format = OFORMAT_HUMAN;
2925 BlockBackend *blk;
2926 BlockDriverState *bs;
2927 const char *filename, *fmt, *output;
2928 int64_t length;
2929 MapEntry curr = { .length = 0 }, next;
2930 int ret = 0;
2931 bool image_opts = false;
2932 bool force_share = false;
2934 fmt = NULL;
2935 output = NULL;
2936 for (;;) {
2937 int option_index = 0;
2938 static const struct option long_options[] = {
2939 {"help", no_argument, 0, 'h'},
2940 {"format", required_argument, 0, 'f'},
2941 {"output", required_argument, 0, OPTION_OUTPUT},
2942 {"object", required_argument, 0, OPTION_OBJECT},
2943 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2944 {"force-share", no_argument, 0, 'U'},
2945 {0, 0, 0, 0}
2947 c = getopt_long(argc, argv, ":f:hU",
2948 long_options, &option_index);
2949 if (c == -1) {
2950 break;
2952 switch (c) {
2953 case ':':
2954 missing_argument(argv[optind - 1]);
2955 break;
2956 case '?':
2957 unrecognized_option(argv[optind - 1]);
2958 break;
2959 case 'h':
2960 help();
2961 break;
2962 case 'f':
2963 fmt = optarg;
2964 break;
2965 case 'U':
2966 force_share = true;
2967 break;
2968 case OPTION_OUTPUT:
2969 output = optarg;
2970 break;
2971 case OPTION_OBJECT: {
2972 QemuOpts *opts;
2973 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2974 optarg, true);
2975 if (!opts) {
2976 return 1;
2978 } break;
2979 case OPTION_IMAGE_OPTS:
2980 image_opts = true;
2981 break;
2984 if (optind != argc - 1) {
2985 error_exit("Expecting one image file name");
2987 filename = argv[optind];
2989 if (output && !strcmp(output, "json")) {
2990 output_format = OFORMAT_JSON;
2991 } else if (output && !strcmp(output, "human")) {
2992 output_format = OFORMAT_HUMAN;
2993 } else if (output) {
2994 error_report("--output must be used with human or json as argument.");
2995 return 1;
2998 if (qemu_opts_foreach(&qemu_object_opts,
2999 user_creatable_add_opts_foreach,
3000 NULL, &error_fatal)) {
3001 return 1;
3004 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
3005 if (!blk) {
3006 return 1;
3008 bs = blk_bs(blk);
3010 if (output_format == OFORMAT_HUMAN) {
3011 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3014 length = blk_getlength(blk);
3015 while (curr.start + curr.length < length) {
3016 int64_t offset = curr.start + curr.length;
3017 int64_t n;
3019 /* Probe up to 1 GiB at a time. */
3020 n = MIN(1 * GiB, length - offset);
3021 ret = get_block_status(bs, offset, n, &next);
3023 if (ret < 0) {
3024 error_report("Could not read file metadata: %s", strerror(-ret));
3025 goto out;
3028 if (entry_mergeable(&curr, &next)) {
3029 curr.length += next.length;
3030 continue;
3033 if (curr.length > 0) {
3034 ret = dump_map_entry(output_format, &curr, &next);
3035 if (ret < 0) {
3036 goto out;
3039 curr = next;
3042 ret = dump_map_entry(output_format, &curr, NULL);
3044 out:
3045 blk_unref(blk);
3046 return ret < 0;
3049 #define SNAPSHOT_LIST 1
3050 #define SNAPSHOT_CREATE 2
3051 #define SNAPSHOT_APPLY 3
3052 #define SNAPSHOT_DELETE 4
3054 static int img_snapshot(int argc, char **argv)
3056 BlockBackend *blk;
3057 BlockDriverState *bs;
3058 QEMUSnapshotInfo sn;
3059 char *filename, *snapshot_name = NULL;
3060 int c, ret = 0, bdrv_oflags;
3061 int action = 0;
3062 qemu_timeval tv;
3063 bool quiet = false;
3064 Error *err = NULL;
3065 bool image_opts = false;
3066 bool force_share = false;
3068 bdrv_oflags = BDRV_O_RDWR;
3069 /* Parse commandline parameters */
3070 for(;;) {
3071 static const struct option long_options[] = {
3072 {"help", no_argument, 0, 'h'},
3073 {"object", required_argument, 0, OPTION_OBJECT},
3074 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3075 {"force-share", no_argument, 0, 'U'},
3076 {0, 0, 0, 0}
3078 c = getopt_long(argc, argv, ":la:c:d:hqU",
3079 long_options, NULL);
3080 if (c == -1) {
3081 break;
3083 switch(c) {
3084 case ':':
3085 missing_argument(argv[optind - 1]);
3086 break;
3087 case '?':
3088 unrecognized_option(argv[optind - 1]);
3089 break;
3090 case 'h':
3091 help();
3092 return 0;
3093 case 'l':
3094 if (action) {
3095 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3096 return 0;
3098 action = SNAPSHOT_LIST;
3099 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3100 break;
3101 case 'a':
3102 if (action) {
3103 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3104 return 0;
3106 action = SNAPSHOT_APPLY;
3107 snapshot_name = optarg;
3108 break;
3109 case 'c':
3110 if (action) {
3111 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3112 return 0;
3114 action = SNAPSHOT_CREATE;
3115 snapshot_name = optarg;
3116 break;
3117 case 'd':
3118 if (action) {
3119 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3120 return 0;
3122 action = SNAPSHOT_DELETE;
3123 snapshot_name = optarg;
3124 break;
3125 case 'q':
3126 quiet = true;
3127 break;
3128 case 'U':
3129 force_share = true;
3130 break;
3131 case OPTION_OBJECT: {
3132 QemuOpts *opts;
3133 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3134 optarg, true);
3135 if (!opts) {
3136 return 1;
3138 } break;
3139 case OPTION_IMAGE_OPTS:
3140 image_opts = true;
3141 break;
3145 if (optind != argc - 1) {
3146 error_exit("Expecting one image file name");
3148 filename = argv[optind++];
3150 if (qemu_opts_foreach(&qemu_object_opts,
3151 user_creatable_add_opts_foreach,
3152 NULL, &error_fatal)) {
3153 return 1;
3156 /* Open the image */
3157 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3158 force_share);
3159 if (!blk) {
3160 return 1;
3162 bs = blk_bs(blk);
3164 /* Perform the requested action */
3165 switch(action) {
3166 case SNAPSHOT_LIST:
3167 dump_snapshots(bs);
3168 break;
3170 case SNAPSHOT_CREATE:
3171 memset(&sn, 0, sizeof(sn));
3172 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3174 qemu_gettimeofday(&tv);
3175 sn.date_sec = tv.tv_sec;
3176 sn.date_nsec = tv.tv_usec * 1000;
3178 ret = bdrv_snapshot_create(bs, &sn);
3179 if (ret) {
3180 error_report("Could not create snapshot '%s': %d (%s)",
3181 snapshot_name, ret, strerror(-ret));
3183 break;
3185 case SNAPSHOT_APPLY:
3186 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3187 if (ret) {
3188 error_reportf_err(err, "Could not apply snapshot '%s': ",
3189 snapshot_name);
3191 break;
3193 case SNAPSHOT_DELETE:
3194 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3195 if (ret < 0) {
3196 error_report("Could not delete snapshot '%s': snapshot not "
3197 "found", snapshot_name);
3198 ret = 1;
3199 } else {
3200 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3201 if (ret < 0) {
3202 error_reportf_err(err, "Could not delete snapshot '%s': ",
3203 snapshot_name);
3204 ret = 1;
3207 break;
3210 /* Cleanup */
3211 blk_unref(blk);
3212 if (ret) {
3213 return 1;
3215 return 0;
3218 static int img_rebase(int argc, char **argv)
3220 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
3221 uint8_t *buf_old = NULL;
3222 uint8_t *buf_new = NULL;
3223 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
3224 char *filename;
3225 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3226 int c, flags, src_flags, ret;
3227 bool writethrough, src_writethrough;
3228 int unsafe = 0;
3229 bool force_share = false;
3230 int progress = 0;
3231 bool quiet = false;
3232 Error *local_err = NULL;
3233 bool image_opts = false;
3235 /* Parse commandline parameters */
3236 fmt = NULL;
3237 cache = BDRV_DEFAULT_CACHE;
3238 src_cache = BDRV_DEFAULT_CACHE;
3239 out_baseimg = NULL;
3240 out_basefmt = NULL;
3241 for(;;) {
3242 static const struct option long_options[] = {
3243 {"help", no_argument, 0, 'h'},
3244 {"object", required_argument, 0, OPTION_OBJECT},
3245 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3246 {"force-share", no_argument, 0, 'U'},
3247 {0, 0, 0, 0}
3249 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3250 long_options, NULL);
3251 if (c == -1) {
3252 break;
3254 switch(c) {
3255 case ':':
3256 missing_argument(argv[optind - 1]);
3257 break;
3258 case '?':
3259 unrecognized_option(argv[optind - 1]);
3260 break;
3261 case 'h':
3262 help();
3263 return 0;
3264 case 'f':
3265 fmt = optarg;
3266 break;
3267 case 'F':
3268 out_basefmt = optarg;
3269 break;
3270 case 'b':
3271 out_baseimg = optarg;
3272 break;
3273 case 'u':
3274 unsafe = 1;
3275 break;
3276 case 'p':
3277 progress = 1;
3278 break;
3279 case 't':
3280 cache = optarg;
3281 break;
3282 case 'T':
3283 src_cache = optarg;
3284 break;
3285 case 'q':
3286 quiet = true;
3287 break;
3288 case OPTION_OBJECT: {
3289 QemuOpts *opts;
3290 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3291 optarg, true);
3292 if (!opts) {
3293 return 1;
3295 } break;
3296 case OPTION_IMAGE_OPTS:
3297 image_opts = true;
3298 break;
3299 case 'U':
3300 force_share = true;
3301 break;
3305 if (quiet) {
3306 progress = 0;
3309 if (optind != argc - 1) {
3310 error_exit("Expecting one image file name");
3312 if (!unsafe && !out_baseimg) {
3313 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3315 filename = argv[optind++];
3317 if (qemu_opts_foreach(&qemu_object_opts,
3318 user_creatable_add_opts_foreach,
3319 NULL, &error_fatal)) {
3320 return 1;
3323 qemu_progress_init(progress, 2.0);
3324 qemu_progress_print(0, 100);
3326 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3327 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3328 if (ret < 0) {
3329 error_report("Invalid cache option: %s", cache);
3330 goto out;
3333 src_flags = 0;
3334 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3335 if (ret < 0) {
3336 error_report("Invalid source cache option: %s", src_cache);
3337 goto out;
3340 /* The source files are opened read-only, don't care about WCE */
3341 assert((src_flags & BDRV_O_RDWR) == 0);
3342 (void) src_writethrough;
3345 * Open the images.
3347 * Ignore the old backing file for unsafe rebase in case we want to correct
3348 * the reference to a renamed or moved backing file.
3350 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3351 false);
3352 if (!blk) {
3353 ret = -1;
3354 goto out;
3356 bs = blk_bs(blk);
3358 if (out_basefmt != NULL) {
3359 if (bdrv_find_format(out_basefmt) == NULL) {
3360 error_report("Invalid format name: '%s'", out_basefmt);
3361 ret = -1;
3362 goto out;
3366 /* For safe rebasing we need to compare old and new backing file */
3367 if (!unsafe) {
3368 QDict *options = NULL;
3369 BlockDriverState *base_bs = backing_bs(bs);
3371 if (base_bs) {
3372 blk_old_backing = blk_new(qemu_get_aio_context(),
3373 BLK_PERM_CONSISTENT_READ,
3374 BLK_PERM_ALL);
3375 ret = blk_insert_bs(blk_old_backing, base_bs,
3376 &local_err);
3377 if (ret < 0) {
3378 error_reportf_err(local_err,
3379 "Could not reuse old backing file '%s': ",
3380 base_bs->filename);
3381 goto out;
3383 } else {
3384 blk_old_backing = NULL;
3387 if (out_baseimg[0]) {
3388 const char *overlay_filename;
3389 char *out_real_path;
3391 options = qdict_new();
3392 if (out_basefmt) {
3393 qdict_put_str(options, "driver", out_basefmt);
3395 if (force_share) {
3396 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3399 bdrv_refresh_filename(bs);
3400 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3401 : bs->filename;
3402 out_real_path =
3403 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3404 out_baseimg,
3405 &local_err);
3406 if (local_err) {
3407 qobject_unref(options);
3408 error_reportf_err(local_err,
3409 "Could not resolve backing filename: ");
3410 ret = -1;
3411 goto out;
3415 * Find out whether we rebase an image on top of a previous image
3416 * in its chain.
3418 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
3419 if (prefix_chain_bs) {
3420 qobject_unref(options);
3421 g_free(out_real_path);
3423 blk_new_backing = blk_new(qemu_get_aio_context(),
3424 BLK_PERM_CONSISTENT_READ,
3425 BLK_PERM_ALL);
3426 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3427 &local_err);
3428 if (ret < 0) {
3429 error_reportf_err(local_err,
3430 "Could not reuse backing file '%s': ",
3431 out_baseimg);
3432 goto out;
3434 } else {
3435 blk_new_backing = blk_new_open(out_real_path, NULL,
3436 options, src_flags, &local_err);
3437 g_free(out_real_path);
3438 if (!blk_new_backing) {
3439 error_reportf_err(local_err,
3440 "Could not open new backing file '%s': ",
3441 out_baseimg);
3442 ret = -1;
3443 goto out;
3450 * Check each unallocated cluster in the COW file. If it is unallocated,
3451 * accesses go to the backing file. We must therefore compare this cluster
3452 * in the old and new backing file, and if they differ we need to copy it
3453 * from the old backing file into the COW file.
3455 * If qemu-img crashes during this step, no harm is done. The content of
3456 * the image is the same as the original one at any time.
3458 if (!unsafe) {
3459 int64_t size;
3460 int64_t old_backing_size = 0;
3461 int64_t new_backing_size = 0;
3462 uint64_t offset;
3463 int64_t n;
3464 float local_progress = 0;
3466 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3467 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3469 size = blk_getlength(blk);
3470 if (size < 0) {
3471 error_report("Could not get size of '%s': %s",
3472 filename, strerror(-size));
3473 ret = -1;
3474 goto out;
3476 if (blk_old_backing) {
3477 old_backing_size = blk_getlength(blk_old_backing);
3478 if (old_backing_size < 0) {
3479 char backing_name[PATH_MAX];
3481 bdrv_get_backing_filename(bs, backing_name,
3482 sizeof(backing_name));
3483 error_report("Could not get size of '%s': %s",
3484 backing_name, strerror(-old_backing_size));
3485 ret = -1;
3486 goto out;
3489 if (blk_new_backing) {
3490 new_backing_size = blk_getlength(blk_new_backing);
3491 if (new_backing_size < 0) {
3492 error_report("Could not get size of '%s': %s",
3493 out_baseimg, strerror(-new_backing_size));
3494 ret = -1;
3495 goto out;
3499 if (size != 0) {
3500 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3503 for (offset = 0; offset < size; offset += n) {
3504 bool buf_old_is_zero = false;
3506 /* How many bytes can we handle with the next read? */
3507 n = MIN(IO_BUF_SIZE, size - offset);
3509 /* If the cluster is allocated, we don't need to take action */
3510 ret = bdrv_is_allocated(bs, offset, n, &n);
3511 if (ret < 0) {
3512 error_report("error while reading image metadata: %s",
3513 strerror(-ret));
3514 goto out;
3516 if (ret) {
3517 continue;
3520 if (prefix_chain_bs) {
3522 * If cluster wasn't changed since prefix_chain, we don't need
3523 * to take action
3525 ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
3526 false, offset, n, &n);
3527 if (ret < 0) {
3528 error_report("error while reading image metadata: %s",
3529 strerror(-ret));
3530 goto out;
3532 if (!ret) {
3533 continue;
3538 * Read old and new backing file and take into consideration that
3539 * backing files may be smaller than the COW image.
3541 if (offset >= old_backing_size) {
3542 memset(buf_old, 0, n);
3543 buf_old_is_zero = true;
3544 } else {
3545 if (offset + n > old_backing_size) {
3546 n = old_backing_size - offset;
3549 ret = blk_pread(blk_old_backing, offset, buf_old, n);
3550 if (ret < 0) {
3551 error_report("error while reading from old backing file");
3552 goto out;
3556 if (offset >= new_backing_size || !blk_new_backing) {
3557 memset(buf_new, 0, n);
3558 } else {
3559 if (offset + n > new_backing_size) {
3560 n = new_backing_size - offset;
3563 ret = blk_pread(blk_new_backing, offset, buf_new, n);
3564 if (ret < 0) {
3565 error_report("error while reading from new backing file");
3566 goto out;
3570 /* If they differ, we need to write to the COW file */
3571 uint64_t written = 0;
3573 while (written < n) {
3574 int64_t pnum;
3576 if (compare_buffers(buf_old + written, buf_new + written,
3577 n - written, &pnum))
3579 if (buf_old_is_zero) {
3580 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3581 } else {
3582 ret = blk_pwrite(blk, offset + written,
3583 buf_old + written, pnum, 0);
3585 if (ret < 0) {
3586 error_report("Error while writing to COW image: %s",
3587 strerror(-ret));
3588 goto out;
3592 written += pnum;
3594 qemu_progress_print(local_progress, 100);
3599 * Change the backing file. All clusters that are different from the old
3600 * backing file are overwritten in the COW file now, so the visible content
3601 * doesn't change when we switch the backing file.
3603 if (out_baseimg && *out_baseimg) {
3604 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3605 } else {
3606 ret = bdrv_change_backing_file(bs, NULL, NULL);
3609 if (ret == -ENOSPC) {
3610 error_report("Could not change the backing file to '%s': No "
3611 "space left in the file header", out_baseimg);
3612 } else if (ret < 0) {
3613 error_report("Could not change the backing file to '%s': %s",
3614 out_baseimg, strerror(-ret));
3617 qemu_progress_print(100, 0);
3619 * TODO At this point it is possible to check if any clusters that are
3620 * allocated in the COW file are the same in the backing file. If so, they
3621 * could be dropped from the COW file. Don't do this before switching the
3622 * backing file, in case of a crash this would lead to corruption.
3624 out:
3625 qemu_progress_end();
3626 /* Cleanup */
3627 if (!unsafe) {
3628 blk_unref(blk_old_backing);
3629 blk_unref(blk_new_backing);
3631 qemu_vfree(buf_old);
3632 qemu_vfree(buf_new);
3634 blk_unref(blk);
3635 if (ret) {
3636 return 1;
3638 return 0;
3641 static int img_resize(int argc, char **argv)
3643 Error *err = NULL;
3644 int c, ret, relative;
3645 const char *filename, *fmt, *size;
3646 int64_t n, total_size, current_size, new_size;
3647 bool quiet = false;
3648 BlockBackend *blk = NULL;
3649 PreallocMode prealloc = PREALLOC_MODE_OFF;
3650 QemuOpts *param;
3652 static QemuOptsList resize_options = {
3653 .name = "resize_options",
3654 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3655 .desc = {
3657 .name = BLOCK_OPT_SIZE,
3658 .type = QEMU_OPT_SIZE,
3659 .help = "Virtual disk size"
3660 }, {
3661 /* end of list */
3665 bool image_opts = false;
3666 bool shrink = false;
3668 /* Remove size from argv manually so that negative numbers are not treated
3669 * as options by getopt. */
3670 if (argc < 3) {
3671 error_exit("Not enough arguments");
3672 return 1;
3675 size = argv[--argc];
3677 /* Parse getopt arguments */
3678 fmt = NULL;
3679 for(;;) {
3680 static const struct option long_options[] = {
3681 {"help", no_argument, 0, 'h'},
3682 {"object", required_argument, 0, OPTION_OBJECT},
3683 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3684 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3685 {"shrink", no_argument, 0, OPTION_SHRINK},
3686 {0, 0, 0, 0}
3688 c = getopt_long(argc, argv, ":f:hq",
3689 long_options, NULL);
3690 if (c == -1) {
3691 break;
3693 switch(c) {
3694 case ':':
3695 missing_argument(argv[optind - 1]);
3696 break;
3697 case '?':
3698 unrecognized_option(argv[optind - 1]);
3699 break;
3700 case 'h':
3701 help();
3702 break;
3703 case 'f':
3704 fmt = optarg;
3705 break;
3706 case 'q':
3707 quiet = true;
3708 break;
3709 case OPTION_OBJECT: {
3710 QemuOpts *opts;
3711 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3712 optarg, true);
3713 if (!opts) {
3714 return 1;
3716 } break;
3717 case OPTION_IMAGE_OPTS:
3718 image_opts = true;
3719 break;
3720 case OPTION_PREALLOCATION:
3721 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
3722 PREALLOC_MODE__MAX, NULL);
3723 if (prealloc == PREALLOC_MODE__MAX) {
3724 error_report("Invalid preallocation mode '%s'", optarg);
3725 return 1;
3727 break;
3728 case OPTION_SHRINK:
3729 shrink = true;
3730 break;
3733 if (optind != argc - 1) {
3734 error_exit("Expecting image file name and size");
3736 filename = argv[optind++];
3738 if (qemu_opts_foreach(&qemu_object_opts,
3739 user_creatable_add_opts_foreach,
3740 NULL, &error_fatal)) {
3741 return 1;
3744 /* Choose grow, shrink, or absolute resize mode */
3745 switch (size[0]) {
3746 case '+':
3747 relative = 1;
3748 size++;
3749 break;
3750 case '-':
3751 relative = -1;
3752 size++;
3753 break;
3754 default:
3755 relative = 0;
3756 break;
3759 /* Parse size */
3760 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3761 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3762 if (err) {
3763 error_report_err(err);
3764 ret = -1;
3765 qemu_opts_del(param);
3766 goto out;
3768 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3769 qemu_opts_del(param);
3771 blk = img_open(image_opts, filename, fmt,
3772 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3773 false);
3774 if (!blk) {
3775 ret = -1;
3776 goto out;
3779 current_size = blk_getlength(blk);
3780 if (current_size < 0) {
3781 error_report("Failed to inquire current image length: %s",
3782 strerror(-current_size));
3783 ret = -1;
3784 goto out;
3787 if (relative) {
3788 total_size = current_size + n * relative;
3789 } else {
3790 total_size = n;
3792 if (total_size <= 0) {
3793 error_report("New image size must be positive");
3794 ret = -1;
3795 goto out;
3798 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3799 error_report("Preallocation can only be used for growing images");
3800 ret = -1;
3801 goto out;
3804 if (total_size < current_size && !shrink) {
3805 warn_report("Shrinking an image will delete all data beyond the "
3806 "shrunken image's end. Before performing such an "
3807 "operation, make sure there is no important data there.");
3809 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3810 error_report(
3811 "Use the --shrink option to perform a shrink operation.");
3812 ret = -1;
3813 goto out;
3814 } else {
3815 warn_report("Using the --shrink option will suppress this message. "
3816 "Note that future versions of qemu-img may refuse to "
3817 "shrink images without this option.");
3821 ret = blk_truncate(blk, total_size, prealloc, &err);
3822 if (ret < 0) {
3823 error_report_err(err);
3824 goto out;
3827 new_size = blk_getlength(blk);
3828 if (new_size < 0) {
3829 error_report("Failed to verify truncated image length: %s",
3830 strerror(-new_size));
3831 ret = -1;
3832 goto out;
3835 /* Some block drivers implement a truncation method, but only so
3836 * the user can cause qemu to refresh the image's size from disk.
3837 * The idea is that the user resizes the image outside of qemu and
3838 * then invokes block_resize to inform qemu about it.
3839 * (This includes iscsi and file-posix for device files.)
3840 * Of course, that is not the behavior someone invoking
3841 * qemu-img resize would find useful, so we catch that behavior
3842 * here and tell the user. */
3843 if (new_size != total_size && new_size == current_size) {
3844 error_report("Image was not resized; resizing may not be supported "
3845 "for this image");
3846 ret = -1;
3847 goto out;
3850 if (new_size != total_size) {
3851 warn_report("Image should have been resized to %" PRIi64
3852 " bytes, but was resized to %" PRIi64 " bytes",
3853 total_size, new_size);
3856 qprintf(quiet, "Image resized.\n");
3858 out:
3859 blk_unref(blk);
3860 if (ret) {
3861 return 1;
3863 return 0;
3866 static void amend_status_cb(BlockDriverState *bs,
3867 int64_t offset, int64_t total_work_size,
3868 void *opaque)
3870 qemu_progress_print(100.f * offset / total_work_size, 0);
3873 static int print_amend_option_help(const char *format)
3875 BlockDriver *drv;
3877 /* Find driver and parse its options */
3878 drv = bdrv_find_format(format);
3879 if (!drv) {
3880 error_report("Unknown file format '%s'", format);
3881 return 1;
3884 if (!drv->bdrv_amend_options) {
3885 error_report("Format driver '%s' does not support option amendment",
3886 format);
3887 return 1;
3890 /* Every driver supporting amendment must have create_opts */
3891 assert(drv->create_opts);
3893 printf("Creation options for '%s':\n", format);
3894 qemu_opts_print_help(drv->create_opts, false);
3895 printf("\nNote that not all of these options may be amendable.\n");
3896 return 0;
3899 static int img_amend(int argc, char **argv)
3901 Error *err = NULL;
3902 int c, ret = 0;
3903 char *options = NULL;
3904 QemuOptsList *create_opts = NULL;
3905 QemuOpts *opts = NULL;
3906 const char *fmt = NULL, *filename, *cache;
3907 int flags;
3908 bool writethrough;
3909 bool quiet = false, progress = false;
3910 BlockBackend *blk = NULL;
3911 BlockDriverState *bs = NULL;
3912 bool image_opts = false;
3914 cache = BDRV_DEFAULT_CACHE;
3915 for (;;) {
3916 static const struct option long_options[] = {
3917 {"help", no_argument, 0, 'h'},
3918 {"object", required_argument, 0, OPTION_OBJECT},
3919 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3920 {0, 0, 0, 0}
3922 c = getopt_long(argc, argv, ":ho:f:t:pq",
3923 long_options, NULL);
3924 if (c == -1) {
3925 break;
3928 switch (c) {
3929 case ':':
3930 missing_argument(argv[optind - 1]);
3931 break;
3932 case '?':
3933 unrecognized_option(argv[optind - 1]);
3934 break;
3935 case 'h':
3936 help();
3937 break;
3938 case 'o':
3939 if (!is_valid_option_list(optarg)) {
3940 error_report("Invalid option list: %s", optarg);
3941 ret = -1;
3942 goto out_no_progress;
3944 if (!options) {
3945 options = g_strdup(optarg);
3946 } else {
3947 char *old_options = options;
3948 options = g_strdup_printf("%s,%s", options, optarg);
3949 g_free(old_options);
3951 break;
3952 case 'f':
3953 fmt = optarg;
3954 break;
3955 case 't':
3956 cache = optarg;
3957 break;
3958 case 'p':
3959 progress = true;
3960 break;
3961 case 'q':
3962 quiet = true;
3963 break;
3964 case OPTION_OBJECT:
3965 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3966 optarg, true);
3967 if (!opts) {
3968 ret = -1;
3969 goto out_no_progress;
3971 break;
3972 case OPTION_IMAGE_OPTS:
3973 image_opts = true;
3974 break;
3978 if (!options) {
3979 error_exit("Must specify options (-o)");
3982 if (qemu_opts_foreach(&qemu_object_opts,
3983 user_creatable_add_opts_foreach,
3984 NULL, &error_fatal)) {
3985 ret = -1;
3986 goto out_no_progress;
3989 if (quiet) {
3990 progress = false;
3992 qemu_progress_init(progress, 1.0);
3994 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3995 if (fmt && has_help_option(options)) {
3996 /* If a format is explicitly specified (and possibly no filename is
3997 * given), print option help here */
3998 ret = print_amend_option_help(fmt);
3999 goto out;
4002 if (optind != argc - 1) {
4003 error_report("Expecting one image file name");
4004 ret = -1;
4005 goto out;
4008 flags = BDRV_O_RDWR;
4009 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
4010 if (ret < 0) {
4011 error_report("Invalid cache option: %s", cache);
4012 goto out;
4015 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4016 false);
4017 if (!blk) {
4018 ret = -1;
4019 goto out;
4021 bs = blk_bs(blk);
4023 fmt = bs->drv->format_name;
4025 if (has_help_option(options)) {
4026 /* If the format was auto-detected, print option help here */
4027 ret = print_amend_option_help(fmt);
4028 goto out;
4031 if (!bs->drv->bdrv_amend_options) {
4032 error_report("Format driver '%s' does not support option amendment",
4033 fmt);
4034 ret = -1;
4035 goto out;
4038 /* Every driver supporting amendment must have create_opts */
4039 assert(bs->drv->create_opts);
4041 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
4042 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4043 qemu_opts_do_parse(opts, options, NULL, &err);
4044 if (err) {
4045 error_report_err(err);
4046 ret = -1;
4047 goto out;
4050 /* In case the driver does not call amend_status_cb() */
4051 qemu_progress_print(0.f, 0);
4052 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
4053 qemu_progress_print(100.f, 0);
4054 if (ret < 0) {
4055 error_report_err(err);
4056 goto out;
4059 out:
4060 qemu_progress_end();
4062 out_no_progress:
4063 blk_unref(blk);
4064 qemu_opts_del(opts);
4065 qemu_opts_free(create_opts);
4066 g_free(options);
4068 if (ret) {
4069 return 1;
4071 return 0;
4074 typedef struct BenchData {
4075 BlockBackend *blk;
4076 uint64_t image_size;
4077 bool write;
4078 int bufsize;
4079 int step;
4080 int nrreq;
4081 int n;
4082 int flush_interval;
4083 bool drain_on_flush;
4084 uint8_t *buf;
4085 QEMUIOVector *qiov;
4087 int in_flight;
4088 bool in_flush;
4089 uint64_t offset;
4090 } BenchData;
4092 static void bench_undrained_flush_cb(void *opaque, int ret)
4094 if (ret < 0) {
4095 error_report("Failed flush request: %s", strerror(-ret));
4096 exit(EXIT_FAILURE);
4100 static void bench_cb(void *opaque, int ret)
4102 BenchData *b = opaque;
4103 BlockAIOCB *acb;
4105 if (ret < 0) {
4106 error_report("Failed request: %s", strerror(-ret));
4107 exit(EXIT_FAILURE);
4110 if (b->in_flush) {
4111 /* Just finished a flush with drained queue: Start next requests */
4112 assert(b->in_flight == 0);
4113 b->in_flush = false;
4114 } else if (b->in_flight > 0) {
4115 int remaining = b->n - b->in_flight;
4117 b->n--;
4118 b->in_flight--;
4120 /* Time for flush? Drain queue if requested, then flush */
4121 if (b->flush_interval && remaining % b->flush_interval == 0) {
4122 if (!b->in_flight || !b->drain_on_flush) {
4123 BlockCompletionFunc *cb;
4125 if (b->drain_on_flush) {
4126 b->in_flush = true;
4127 cb = bench_cb;
4128 } else {
4129 cb = bench_undrained_flush_cb;
4132 acb = blk_aio_flush(b->blk, cb, b);
4133 if (!acb) {
4134 error_report("Failed to issue flush request");
4135 exit(EXIT_FAILURE);
4138 if (b->drain_on_flush) {
4139 return;
4144 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4145 int64_t offset = b->offset;
4146 /* blk_aio_* might look for completed I/Os and kick bench_cb
4147 * again, so make sure this operation is counted by in_flight
4148 * and b->offset is ready for the next submission.
4150 b->in_flight++;
4151 b->offset += b->step;
4152 b->offset %= b->image_size;
4153 if (b->write) {
4154 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
4155 } else {
4156 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
4158 if (!acb) {
4159 error_report("Failed to issue request");
4160 exit(EXIT_FAILURE);
4165 static int img_bench(int argc, char **argv)
4167 int c, ret = 0;
4168 const char *fmt = NULL, *filename;
4169 bool quiet = false;
4170 bool image_opts = false;
4171 bool is_write = false;
4172 int count = 75000;
4173 int depth = 64;
4174 int64_t offset = 0;
4175 size_t bufsize = 4096;
4176 int pattern = 0;
4177 size_t step = 0;
4178 int flush_interval = 0;
4179 bool drain_on_flush = true;
4180 int64_t image_size;
4181 BlockBackend *blk = NULL;
4182 BenchData data = {};
4183 int flags = 0;
4184 bool writethrough = false;
4185 struct timeval t1, t2;
4186 int i;
4187 bool force_share = false;
4188 size_t buf_size;
4190 for (;;) {
4191 static const struct option long_options[] = {
4192 {"help", no_argument, 0, 'h'},
4193 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
4194 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4195 {"pattern", required_argument, 0, OPTION_PATTERN},
4196 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4197 {"force-share", no_argument, 0, 'U'},
4198 {0, 0, 0, 0}
4200 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
4201 if (c == -1) {
4202 break;
4205 switch (c) {
4206 case ':':
4207 missing_argument(argv[optind - 1]);
4208 break;
4209 case '?':
4210 unrecognized_option(argv[optind - 1]);
4211 break;
4212 case 'h':
4213 help();
4214 break;
4215 case 'c':
4217 unsigned long res;
4219 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4220 error_report("Invalid request count specified");
4221 return 1;
4223 count = res;
4224 break;
4226 case 'd':
4228 unsigned long res;
4230 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4231 error_report("Invalid queue depth specified");
4232 return 1;
4234 depth = res;
4235 break;
4237 case 'f':
4238 fmt = optarg;
4239 break;
4240 case 'n':
4241 flags |= BDRV_O_NATIVE_AIO;
4242 break;
4243 case 'o':
4245 offset = cvtnum(optarg);
4246 if (offset < 0) {
4247 error_report("Invalid offset specified");
4248 return 1;
4250 break;
4252 break;
4253 case 'q':
4254 quiet = true;
4255 break;
4256 case 's':
4258 int64_t sval;
4260 sval = cvtnum(optarg);
4261 if (sval < 0 || sval > INT_MAX) {
4262 error_report("Invalid buffer size specified");
4263 return 1;
4266 bufsize = sval;
4267 break;
4269 case 'S':
4271 int64_t sval;
4273 sval = cvtnum(optarg);
4274 if (sval < 0 || sval > INT_MAX) {
4275 error_report("Invalid step size specified");
4276 return 1;
4279 step = sval;
4280 break;
4282 case 't':
4283 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4284 if (ret < 0) {
4285 error_report("Invalid cache mode");
4286 ret = -1;
4287 goto out;
4289 break;
4290 case 'w':
4291 flags |= BDRV_O_RDWR;
4292 is_write = true;
4293 break;
4294 case 'U':
4295 force_share = true;
4296 break;
4297 case OPTION_PATTERN:
4299 unsigned long res;
4301 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
4302 error_report("Invalid pattern byte specified");
4303 return 1;
4305 pattern = res;
4306 break;
4308 case OPTION_FLUSH_INTERVAL:
4310 unsigned long res;
4312 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4313 error_report("Invalid flush interval specified");
4314 return 1;
4316 flush_interval = res;
4317 break;
4319 case OPTION_NO_DRAIN:
4320 drain_on_flush = false;
4321 break;
4322 case OPTION_IMAGE_OPTS:
4323 image_opts = true;
4324 break;
4328 if (optind != argc - 1) {
4329 error_exit("Expecting one image file name");
4331 filename = argv[argc - 1];
4333 if (!is_write && flush_interval) {
4334 error_report("--flush-interval is only available in write tests");
4335 ret = -1;
4336 goto out;
4338 if (flush_interval && flush_interval < depth) {
4339 error_report("Flush interval can't be smaller than depth");
4340 ret = -1;
4341 goto out;
4344 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4345 force_share);
4346 if (!blk) {
4347 ret = -1;
4348 goto out;
4351 image_size = blk_getlength(blk);
4352 if (image_size < 0) {
4353 ret = image_size;
4354 goto out;
4357 data = (BenchData) {
4358 .blk = blk,
4359 .image_size = image_size,
4360 .bufsize = bufsize,
4361 .step = step ?: bufsize,
4362 .nrreq = depth,
4363 .n = count,
4364 .offset = offset,
4365 .write = is_write,
4366 .flush_interval = flush_interval,
4367 .drain_on_flush = drain_on_flush,
4369 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4370 "(starting at offset %" PRId64 ", step size %d)\n",
4371 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4372 data.offset, data.step);
4373 if (flush_interval) {
4374 printf("Sending flush every %d requests\n", flush_interval);
4377 buf_size = data.nrreq * data.bufsize;
4378 data.buf = blk_blockalign(blk, buf_size);
4379 memset(data.buf, pattern, data.nrreq * data.bufsize);
4381 blk_register_buf(blk, data.buf, buf_size);
4383 data.qiov = g_new(QEMUIOVector, data.nrreq);
4384 for (i = 0; i < data.nrreq; i++) {
4385 qemu_iovec_init(&data.qiov[i], 1);
4386 qemu_iovec_add(&data.qiov[i],
4387 data.buf + i * data.bufsize, data.bufsize);
4390 gettimeofday(&t1, NULL);
4391 bench_cb(&data, 0);
4393 while (data.n > 0) {
4394 main_loop_wait(false);
4396 gettimeofday(&t2, NULL);
4398 printf("Run completed in %3.3f seconds.\n",
4399 (t2.tv_sec - t1.tv_sec)
4400 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4402 out:
4403 if (data.buf) {
4404 blk_unregister_buf(blk, data.buf);
4406 qemu_vfree(data.buf);
4407 blk_unref(blk);
4409 if (ret) {
4410 return 1;
4412 return 0;
4415 #define C_BS 01
4416 #define C_COUNT 02
4417 #define C_IF 04
4418 #define C_OF 010
4419 #define C_SKIP 020
4421 struct DdInfo {
4422 unsigned int flags;
4423 int64_t count;
4426 struct DdIo {
4427 int bsz; /* Block size */
4428 char *filename;
4429 uint8_t *buf;
4430 int64_t offset;
4433 struct DdOpts {
4434 const char *name;
4435 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4436 unsigned int flag;
4439 static int img_dd_bs(const char *arg,
4440 struct DdIo *in, struct DdIo *out,
4441 struct DdInfo *dd)
4443 int64_t res;
4445 res = cvtnum(arg);
4447 if (res <= 0 || res > INT_MAX) {
4448 error_report("invalid number: '%s'", arg);
4449 return 1;
4451 in->bsz = out->bsz = res;
4453 return 0;
4456 static int img_dd_count(const char *arg,
4457 struct DdIo *in, struct DdIo *out,
4458 struct DdInfo *dd)
4460 dd->count = cvtnum(arg);
4462 if (dd->count < 0) {
4463 error_report("invalid number: '%s'", arg);
4464 return 1;
4467 return 0;
4470 static int img_dd_if(const char *arg,
4471 struct DdIo *in, struct DdIo *out,
4472 struct DdInfo *dd)
4474 in->filename = g_strdup(arg);
4476 return 0;
4479 static int img_dd_of(const char *arg,
4480 struct DdIo *in, struct DdIo *out,
4481 struct DdInfo *dd)
4483 out->filename = g_strdup(arg);
4485 return 0;
4488 static int img_dd_skip(const char *arg,
4489 struct DdIo *in, struct DdIo *out,
4490 struct DdInfo *dd)
4492 in->offset = cvtnum(arg);
4494 if (in->offset < 0) {
4495 error_report("invalid number: '%s'", arg);
4496 return 1;
4499 return 0;
4502 static int img_dd(int argc, char **argv)
4504 int ret = 0;
4505 char *arg = NULL;
4506 char *tmp;
4507 BlockDriver *drv = NULL, *proto_drv = NULL;
4508 BlockBackend *blk1 = NULL, *blk2 = NULL;
4509 QemuOpts *opts = NULL;
4510 QemuOptsList *create_opts = NULL;
4511 Error *local_err = NULL;
4512 bool image_opts = false;
4513 int c, i;
4514 const char *out_fmt = "raw";
4515 const char *fmt = NULL;
4516 int64_t size = 0;
4517 int64_t block_count = 0, out_pos, in_pos;
4518 bool force_share = false;
4519 struct DdInfo dd = {
4520 .flags = 0,
4521 .count = 0,
4523 struct DdIo in = {
4524 .bsz = 512, /* Block size is by default 512 bytes */
4525 .filename = NULL,
4526 .buf = NULL,
4527 .offset = 0
4529 struct DdIo out = {
4530 .bsz = 512,
4531 .filename = NULL,
4532 .buf = NULL,
4533 .offset = 0
4536 const struct DdOpts options[] = {
4537 { "bs", img_dd_bs, C_BS },
4538 { "count", img_dd_count, C_COUNT },
4539 { "if", img_dd_if, C_IF },
4540 { "of", img_dd_of, C_OF },
4541 { "skip", img_dd_skip, C_SKIP },
4542 { NULL, NULL, 0 }
4544 const struct option long_options[] = {
4545 { "help", no_argument, 0, 'h'},
4546 { "object", required_argument, 0, OPTION_OBJECT},
4547 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4548 { "force-share", no_argument, 0, 'U'},
4549 { 0, 0, 0, 0 }
4552 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
4553 if (c == EOF) {
4554 break;
4556 switch (c) {
4557 case 'O':
4558 out_fmt = optarg;
4559 break;
4560 case 'f':
4561 fmt = optarg;
4562 break;
4563 case ':':
4564 missing_argument(argv[optind - 1]);
4565 break;
4566 case '?':
4567 unrecognized_option(argv[optind - 1]);
4568 break;
4569 case 'h':
4570 help();
4571 break;
4572 case 'U':
4573 force_share = true;
4574 break;
4575 case OPTION_OBJECT:
4576 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4577 ret = -1;
4578 goto out;
4580 break;
4581 case OPTION_IMAGE_OPTS:
4582 image_opts = true;
4583 break;
4587 for (i = optind; i < argc; i++) {
4588 int j;
4589 arg = g_strdup(argv[i]);
4591 tmp = strchr(arg, '=');
4592 if (tmp == NULL) {
4593 error_report("unrecognized operand %s", arg);
4594 ret = -1;
4595 goto out;
4598 *tmp++ = '\0';
4600 for (j = 0; options[j].name != NULL; j++) {
4601 if (!strcmp(arg, options[j].name)) {
4602 break;
4605 if (options[j].name == NULL) {
4606 error_report("unrecognized operand %s", arg);
4607 ret = -1;
4608 goto out;
4611 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4612 ret = -1;
4613 goto out;
4615 dd.flags |= options[j].flag;
4616 g_free(arg);
4617 arg = NULL;
4620 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4621 error_report("Must specify both input and output files");
4622 ret = -1;
4623 goto out;
4626 if (qemu_opts_foreach(&qemu_object_opts,
4627 user_creatable_add_opts_foreach,
4628 NULL, &error_fatal)) {
4629 ret = -1;
4630 goto out;
4633 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4634 force_share);
4636 if (!blk1) {
4637 ret = -1;
4638 goto out;
4641 drv = bdrv_find_format(out_fmt);
4642 if (!drv) {
4643 error_report("Unknown file format");
4644 ret = -1;
4645 goto out;
4647 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4649 if (!proto_drv) {
4650 error_report_err(local_err);
4651 ret = -1;
4652 goto out;
4654 if (!drv->create_opts) {
4655 error_report("Format driver '%s' does not support image creation",
4656 drv->format_name);
4657 ret = -1;
4658 goto out;
4660 if (!proto_drv->create_opts) {
4661 error_report("Protocol driver '%s' does not support image creation",
4662 proto_drv->format_name);
4663 ret = -1;
4664 goto out;
4666 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4667 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4669 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4671 size = blk_getlength(blk1);
4672 if (size < 0) {
4673 error_report("Failed to get size for '%s'", in.filename);
4674 ret = -1;
4675 goto out;
4678 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4679 dd.count * in.bsz < size) {
4680 size = dd.count * in.bsz;
4683 /* Overflow means the specified offset is beyond input image's size */
4684 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4685 size < in.bsz * in.offset)) {
4686 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4687 } else {
4688 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4689 size - in.bsz * in.offset, &error_abort);
4692 ret = bdrv_create(drv, out.filename, opts, &local_err);
4693 if (ret < 0) {
4694 error_reportf_err(local_err,
4695 "%s: error while creating output image: ",
4696 out.filename);
4697 ret = -1;
4698 goto out;
4701 /* TODO, we can't honour --image-opts for the target,
4702 * since it needs to be given in a format compatible
4703 * with the bdrv_create() call above which does not
4704 * support image-opts style.
4706 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4707 false, false, false);
4709 if (!blk2) {
4710 ret = -1;
4711 goto out;
4714 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4715 size < in.offset * in.bsz)) {
4716 /* We give a warning if the skip option is bigger than the input
4717 * size and create an empty output disk image (i.e. like dd(1)).
4719 error_report("%s: cannot skip to specified offset", in.filename);
4720 in_pos = size;
4721 } else {
4722 in_pos = in.offset * in.bsz;
4725 in.buf = g_new(uint8_t, in.bsz);
4727 for (out_pos = 0; in_pos < size; block_count++) {
4728 int in_ret, out_ret;
4730 if (in_pos + in.bsz > size) {
4731 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4732 } else {
4733 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4735 if (in_ret < 0) {
4736 error_report("error while reading from input image file: %s",
4737 strerror(-in_ret));
4738 ret = -1;
4739 goto out;
4741 in_pos += in_ret;
4743 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4745 if (out_ret < 0) {
4746 error_report("error while writing to output image file: %s",
4747 strerror(-out_ret));
4748 ret = -1;
4749 goto out;
4751 out_pos += out_ret;
4754 out:
4755 g_free(arg);
4756 qemu_opts_del(opts);
4757 qemu_opts_free(create_opts);
4758 blk_unref(blk1);
4759 blk_unref(blk2);
4760 g_free(in.filename);
4761 g_free(out.filename);
4762 g_free(in.buf);
4763 g_free(out.buf);
4765 if (ret) {
4766 return 1;
4768 return 0;
4771 static void dump_json_block_measure_info(BlockMeasureInfo *info)
4773 QString *str;
4774 QObject *obj;
4775 Visitor *v = qobject_output_visitor_new(&obj);
4777 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
4778 visit_complete(v, &obj);
4779 str = qobject_to_json_pretty(obj);
4780 assert(str != NULL);
4781 printf("%s\n", qstring_get_str(str));
4782 qobject_unref(obj);
4783 visit_free(v);
4784 qobject_unref(str);
4787 static int img_measure(int argc, char **argv)
4789 static const struct option long_options[] = {
4790 {"help", no_argument, 0, 'h'},
4791 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4792 {"object", required_argument, 0, OPTION_OBJECT},
4793 {"output", required_argument, 0, OPTION_OUTPUT},
4794 {"size", required_argument, 0, OPTION_SIZE},
4795 {"force-share", no_argument, 0, 'U'},
4796 {0, 0, 0, 0}
4798 OutputFormat output_format = OFORMAT_HUMAN;
4799 BlockBackend *in_blk = NULL;
4800 BlockDriver *drv;
4801 const char *filename = NULL;
4802 const char *fmt = NULL;
4803 const char *out_fmt = "raw";
4804 char *options = NULL;
4805 char *snapshot_name = NULL;
4806 bool force_share = false;
4807 QemuOpts *opts = NULL;
4808 QemuOpts *object_opts = NULL;
4809 QemuOpts *sn_opts = NULL;
4810 QemuOptsList *create_opts = NULL;
4811 bool image_opts = false;
4812 uint64_t img_size = UINT64_MAX;
4813 BlockMeasureInfo *info = NULL;
4814 Error *local_err = NULL;
4815 int ret = 1;
4816 int c;
4818 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
4819 long_options, NULL)) != -1) {
4820 switch (c) {
4821 case '?':
4822 case 'h':
4823 help();
4824 break;
4825 case 'f':
4826 fmt = optarg;
4827 break;
4828 case 'O':
4829 out_fmt = optarg;
4830 break;
4831 case 'o':
4832 if (!is_valid_option_list(optarg)) {
4833 error_report("Invalid option list: %s", optarg);
4834 goto out;
4836 if (!options) {
4837 options = g_strdup(optarg);
4838 } else {
4839 char *old_options = options;
4840 options = g_strdup_printf("%s,%s", options, optarg);
4841 g_free(old_options);
4843 break;
4844 case 'l':
4845 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
4846 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
4847 optarg, false);
4848 if (!sn_opts) {
4849 error_report("Failed in parsing snapshot param '%s'",
4850 optarg);
4851 goto out;
4853 } else {
4854 snapshot_name = optarg;
4856 break;
4857 case 'U':
4858 force_share = true;
4859 break;
4860 case OPTION_OBJECT:
4861 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
4862 optarg, true);
4863 if (!object_opts) {
4864 goto out;
4866 break;
4867 case OPTION_IMAGE_OPTS:
4868 image_opts = true;
4869 break;
4870 case OPTION_OUTPUT:
4871 if (!strcmp(optarg, "json")) {
4872 output_format = OFORMAT_JSON;
4873 } else if (!strcmp(optarg, "human")) {
4874 output_format = OFORMAT_HUMAN;
4875 } else {
4876 error_report("--output must be used with human or json "
4877 "as argument.");
4878 goto out;
4880 break;
4881 case OPTION_SIZE:
4883 int64_t sval;
4885 sval = cvtnum(optarg);
4886 if (sval < 0) {
4887 if (sval == -ERANGE) {
4888 error_report("Image size must be less than 8 EiB!");
4889 } else {
4890 error_report("Invalid image size specified! You may use "
4891 "k, M, G, T, P or E suffixes for ");
4892 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4893 "petabytes and exabytes.");
4895 goto out;
4897 img_size = (uint64_t)sval;
4899 break;
4903 if (qemu_opts_foreach(&qemu_object_opts,
4904 user_creatable_add_opts_foreach,
4905 NULL, &error_fatal)) {
4906 goto out;
4909 if (argc - optind > 1) {
4910 error_report("At most one filename argument is allowed.");
4911 goto out;
4912 } else if (argc - optind == 1) {
4913 filename = argv[optind];
4916 if (!filename &&
4917 (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
4918 error_report("--object, --image-opts, -f, and -l "
4919 "require a filename argument.");
4920 goto out;
4922 if (filename && img_size != UINT64_MAX) {
4923 error_report("--size N cannot be used together with a filename.");
4924 goto out;
4926 if (!filename && img_size == UINT64_MAX) {
4927 error_report("Either --size N or one filename must be specified.");
4928 goto out;
4931 if (filename) {
4932 in_blk = img_open(image_opts, filename, fmt, 0,
4933 false, false, force_share);
4934 if (!in_blk) {
4935 goto out;
4938 if (sn_opts) {
4939 bdrv_snapshot_load_tmp(blk_bs(in_blk),
4940 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
4941 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
4942 &local_err);
4943 } else if (snapshot_name != NULL) {
4944 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
4945 snapshot_name, &local_err);
4947 if (local_err) {
4948 error_reportf_err(local_err, "Failed to load snapshot: ");
4949 goto out;
4953 drv = bdrv_find_format(out_fmt);
4954 if (!drv) {
4955 error_report("Unknown file format '%s'", out_fmt);
4956 goto out;
4958 if (!drv->create_opts) {
4959 error_report("Format driver '%s' does not support image creation",
4960 drv->format_name);
4961 goto out;
4964 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4965 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
4966 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4967 if (options) {
4968 qemu_opts_do_parse(opts, options, NULL, &local_err);
4969 if (local_err) {
4970 error_report_err(local_err);
4971 error_report("Invalid options for file format '%s'", out_fmt);
4972 goto out;
4975 if (img_size != UINT64_MAX) {
4976 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
4979 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
4980 if (local_err) {
4981 error_report_err(local_err);
4982 goto out;
4985 if (output_format == OFORMAT_HUMAN) {
4986 printf("required size: %" PRIu64 "\n", info->required);
4987 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
4988 } else {
4989 dump_json_block_measure_info(info);
4992 ret = 0;
4994 out:
4995 qapi_free_BlockMeasureInfo(info);
4996 qemu_opts_del(object_opts);
4997 qemu_opts_del(opts);
4998 qemu_opts_del(sn_opts);
4999 qemu_opts_free(create_opts);
5000 g_free(options);
5001 blk_unref(in_blk);
5002 return ret;
5005 static const img_cmd_t img_cmds[] = {
5006 #define DEF(option, callback, arg_string) \
5007 { option, callback },
5008 #include "qemu-img-cmds.h"
5009 #undef DEF
5010 { NULL, NULL, },
5013 int main(int argc, char **argv)
5015 const img_cmd_t *cmd;
5016 const char *cmdname;
5017 Error *local_error = NULL;
5018 char *trace_file = NULL;
5019 int c;
5020 static const struct option long_options[] = {
5021 {"help", no_argument, 0, 'h'},
5022 {"version", no_argument, 0, 'V'},
5023 {"trace", required_argument, NULL, 'T'},
5024 {0, 0, 0, 0}
5027 #ifdef CONFIG_POSIX
5028 signal(SIGPIPE, SIG_IGN);
5029 #endif
5031 error_init(argv[0]);
5032 module_call_init(MODULE_INIT_TRACE);
5033 qemu_init_exec_dir(argv[0]);
5035 if (qemu_init_main_loop(&local_error)) {
5036 error_report_err(local_error);
5037 exit(EXIT_FAILURE);
5040 qcrypto_init(&error_fatal);
5042 module_call_init(MODULE_INIT_QOM);
5043 bdrv_init();
5044 if (argc < 2) {
5045 error_exit("Not enough arguments");
5048 qemu_add_opts(&qemu_object_opts);
5049 qemu_add_opts(&qemu_source_opts);
5050 qemu_add_opts(&qemu_trace_opts);
5052 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
5053 switch (c) {
5054 case ':':
5055 missing_argument(argv[optind - 1]);
5056 return 0;
5057 case '?':
5058 unrecognized_option(argv[optind - 1]);
5059 return 0;
5060 case 'h':
5061 help();
5062 return 0;
5063 case 'V':
5064 printf(QEMU_IMG_VERSION);
5065 return 0;
5066 case 'T':
5067 g_free(trace_file);
5068 trace_file = trace_opt_parse(optarg);
5069 break;
5073 cmdname = argv[optind];
5075 /* reset getopt_long scanning */
5076 argc -= optind;
5077 if (argc < 1) {
5078 return 0;
5080 argv += optind;
5081 qemu_reset_optind();
5083 if (!trace_init_backends()) {
5084 exit(1);
5086 trace_init_file(trace_file);
5087 qemu_set_log(LOG_TRACE);
5089 /* find the command */
5090 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5091 if (!strcmp(cmdname, cmd->name)) {
5092 return cmd->handler(argc, argv);
5096 /* not found */
5097 error_exit("Command not found: %s", cmdname);