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
25 #include "qemu/osdep.h"
28 #include "qemu/help-texts.h"
29 #include "qemu/qemu-progress.h"
30 #include "qemu-version.h"
31 #include "qapi/error.h"
32 #include "qapi/qapi-commands-block-core.h"
33 #include "qapi/qapi-visit-block-core.h"
34 #include "qapi/qobject-output-visitor.h"
35 #include "qapi/qmp/qjson.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qemu/cutils.h"
38 #include "qemu/config-file.h"
39 #include "qemu/option.h"
40 #include "qemu/error-report.h"
42 #include "qemu/main-loop.h"
43 #include "qemu/module.h"
44 #include "qemu/sockets.h"
45 #include "qemu/units.h"
46 #include "qemu/memalign.h"
47 #include "qom/object_interfaces.h"
48 #include "sysemu/block-backend.h"
49 #include "block/block_int.h"
50 #include "block/blockjob.h"
51 #include "block/dirty-bitmap.h"
52 #include "block/qapi.h"
53 #include "crypto/init.h"
54 #include "trace/control.h"
55 #include "qemu/throttle.h"
56 #include "block/throttle-groups.h"
58 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
59 "\n" QEMU_COPYRIGHT "\n"
61 typedef struct img_cmd_t {
63 int (*handler)(int argc, char **argv);
68 OPTION_BACKING_CHAIN = 257,
70 OPTION_IMAGE_OPTS = 259,
72 OPTION_FLUSH_INTERVAL = 261,
73 OPTION_NO_DRAIN = 262,
74 OPTION_TARGET_IMAGE_OPTS = 263,
76 OPTION_PREALLOCATION = 265,
79 OPTION_TARGET_IS_ZERO = 268,
88 OPTION_SKIP_BROKEN = 277,
91 typedef enum OutputFormat {
96 /* Default to cache=writeback as data integrity is not important for qemu-img */
97 #define BDRV_DEFAULT_CACHE "writeback"
99 static void format_print(void *opaque, const char *name)
104 static G_NORETURN G_GNUC_PRINTF(1, 2)
105 void error_exit(const char *fmt, ...)
110 error_vreport(fmt, ap);
113 error_printf("Try 'qemu-img --help' for more information\n");
118 void missing_argument(const char *option)
120 error_exit("missing argument for option '%s'", option);
124 void unrecognized_option(const char *option)
126 error_exit("unrecognized option '%s'", option);
129 /* Please keep in synch with docs/tools/qemu-img.rst */
133 const char *help_msg =
135 "usage: qemu-img [standard options] command [command options]\n"
136 "QEMU disk image utility\n"
138 " '-h', '--help' display this help and exit\n"
139 " '-V', '--version' output version information and exit\n"
140 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
141 " specify tracing options\n"
144 #define DEF(option, callback, arg_string) \
146 #include "qemu-img-cmds.h"
149 "Command parameters:\n"
150 " 'filename' is a disk image filename\n"
151 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
152 " manual page for a description of the object properties. The most common\n"
153 " object type is a 'secret', which is used to supply passwords and/or\n"
154 " encryption keys.\n"
155 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
156 " 'cache' is the cache mode used to write the output disk image, the valid\n"
157 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
158 " 'directsync' and 'unsafe' (default for convert)\n"
159 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
160 " options are the same as for the 'cache' option\n"
161 " 'size' is the disk image size in bytes. Optional suffixes\n"
162 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
163 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
164 " supported. 'b' is ignored.\n"
165 " 'output_filename' is the destination disk image filename\n"
166 " 'output_fmt' is the destination format\n"
167 " 'options' is a comma separated list of format specific options in a\n"
168 " name=value format. Use -o help for an overview of the options supported by\n"
170 " 'snapshot_param' is param used for internal snapshot, format\n"
171 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
173 " '-c' indicates that target image must be compressed (qcow format only)\n"
174 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
175 " new backing file match exactly. The image doesn't need a working\n"
176 " backing file before rebasing in this case (useful for renaming the\n"
177 " backing file). For image creation, allow creating without attempting\n"
178 " to open the backing file.\n"
179 " '-h' with or without a command shows this help and lists the supported formats\n"
180 " '-p' show progress of command (only certain commands)\n"
181 " '-q' use Quiet mode - do not print any output (except errors)\n"
182 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
183 " contain only zeros for qemu-img to create a sparse image during\n"
184 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
185 " unallocated or zero sectors, and the destination image will always be\n"
187 " '--output' takes the format in which the output must be done (human or json)\n"
188 " '-n' skips the target volume creation (useful if the volume is created\n"
189 " prior to running qemu-img)\n"
191 "Parameters to bitmap subcommand:\n"
192 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
193 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
194 " or '--merge source'\n"
195 " '-g granularity' sets the granularity for '--add' actions\n"
196 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
197 " bitmaps from an alternative file\n"
199 "Parameters to check subcommand:\n"
200 " '-r' tries to repair any inconsistencies that are found during the check.\n"
201 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
202 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
203 " hiding corruption that has already occurred.\n"
205 "Parameters to convert subcommand:\n"
206 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
207 " '-m' specifies how many coroutines work in parallel during the convert\n"
208 " process (defaults to 8)\n"
209 " '-W' allow to write to the target out of order rather than sequential\n"
211 "Parameters to snapshot subcommand:\n"
212 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
213 " '-a' applies a snapshot (revert disk to saved state)\n"
214 " '-c' creates a snapshot\n"
215 " '-d' deletes a snapshot\n"
216 " '-l' lists all snapshots in the given image\n"
218 "Parameters to compare subcommand:\n"
219 " '-f' first image format\n"
220 " '-F' second image format\n"
221 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
223 "Parameters to dd subcommand:\n"
224 " 'bs=BYTES' read and write up to BYTES bytes at a time "
226 " 'count=N' copy only N input blocks\n"
227 " 'if=FILE' read from FILE\n"
228 " 'of=FILE' write to FILE\n"
229 " 'skip=N' skip N bs-sized blocks at the start of input\n";
231 printf("%s\nSupported formats:", help_msg);
232 bdrv_iterate_format(format_print, NULL, false);
233 printf("\n\n" QEMU_HELP_BOTTOM "\n");
238 * Is @list safe for accumulate_options()?
239 * It is when multiple of them can be joined together separated by ','.
240 * To make that work, @list must not start with ',' (or else a
241 * separating ',' preceding it gets escaped), and it must not end with
242 * an odd number of ',' (or else a separating ',' following it gets
243 * escaped), or be empty (or else a separating ',' preceding it can
244 * escape a separating ',' following it).
247 static bool is_valid_option_list(const char *list)
249 size_t len = strlen(list);
252 if (!list[0] || list[0] == ',') {
256 for (i = len; i > 0 && list[i - 1] == ','; i--) {
265 static int accumulate_options(char **options, char *list)
269 if (!is_valid_option_list(list)) {
270 error_report("Invalid option list: %s", list);
275 *options = g_strdup(list);
277 new_options = g_strdup_printf("%s,%s", *options, list);
279 *options = new_options;
284 static QemuOptsList qemu_source_opts = {
286 .implied_opt_name = "file",
287 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
293 static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet, const char *fmt, ...)
299 ret = vprintf(fmt, args);
306 static int print_block_option_help(const char *filename, const char *fmt)
308 BlockDriver *drv, *proto_drv;
309 QemuOptsList *create_opts = NULL;
310 Error *local_err = NULL;
312 /* Find driver and parse its options */
313 drv = bdrv_find_format(fmt);
315 error_report("Unknown file format '%s'", fmt);
319 if (!drv->create_opts) {
320 error_report("Format driver '%s' does not support image creation", fmt);
324 create_opts = qemu_opts_append(create_opts, drv->create_opts);
326 proto_drv = bdrv_find_protocol(filename, true, &local_err);
328 error_report_err(local_err);
329 qemu_opts_free(create_opts);
332 if (!proto_drv->create_opts) {
333 error_report("Protocol driver '%s' does not support image creation",
334 proto_drv->format_name);
335 qemu_opts_free(create_opts);
338 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
342 printf("Supported options:\n");
344 printf("Supported %s options:\n", fmt);
346 qemu_opts_print_help(create_opts, false);
347 qemu_opts_free(create_opts);
351 "The protocol level may support further options.\n"
352 "Specify the target filename to include those options.\n");
359 static BlockBackend *img_open_opts(const char *optstr,
360 QemuOpts *opts, int flags, bool writethrough,
361 bool quiet, bool force_share)
364 Error *local_err = NULL;
366 options = qemu_opts_to_qdict(opts, NULL);
368 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
369 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
370 error_report("--force-share/-U conflicts with image options");
371 qobject_unref(options);
374 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
376 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
378 error_reportf_err(local_err, "Could not open '%s': ", optstr);
381 blk_set_enable_write_cache(blk, !writethrough);
386 static BlockBackend *img_open_file(const char *filename,
388 const char *fmt, int flags,
389 bool writethrough, bool quiet,
393 Error *local_err = NULL;
396 options = qdict_new();
399 qdict_put_str(options, "driver", fmt);
403 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
405 blk = blk_new_open(filename, NULL, options, flags, &local_err);
407 error_reportf_err(local_err, "Could not open '%s': ", filename);
410 blk_set_enable_write_cache(blk, !writethrough);
416 static int img_add_key_secrets(void *opaque,
417 const char *name, const char *value,
420 QDict *options = opaque;
422 if (g_str_has_suffix(name, "key-secret")) {
423 qdict_put_str(options, name, value);
430 static BlockBackend *img_open(bool image_opts,
431 const char *filename,
432 const char *fmt, int flags, bool writethrough,
433 bool quiet, bool force_share)
439 error_report("--image-opts and --format are mutually exclusive");
442 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
447 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
450 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
455 blk_set_force_allow_inactivate(blk);
462 static int add_old_style_options(const char *fmt, QemuOpts *opts,
463 const char *base_filename,
464 const char *base_fmt)
467 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
469 error_report("Backing file not supported for file format '%s'",
475 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
476 error_report("Backing file format not supported for file "
484 static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
490 err = qemu_strtosz(value, NULL, &res);
491 if (err < 0 && err != -ERANGE) {
492 error_report("Invalid %s specified. You may use "
493 "k, M, G, T, P or E suffixes for", name);
494 error_report("kilobytes, megabytes, gigabytes, terabytes, "
495 "petabytes and exabytes.");
498 if (err == -ERANGE || res > max || res < min) {
499 error_report("Invalid %s specified. Must be between %" PRId64
500 " and %" PRId64 ".", name, min, max);
506 static int64_t cvtnum(const char *name, const char *value)
508 return cvtnum_full(name, value, 0, INT64_MAX);
511 static int img_create(int argc, char **argv)
514 uint64_t img_size = -1;
515 const char *fmt = "raw";
516 const char *base_fmt = NULL;
517 const char *filename;
518 const char *base_filename = NULL;
519 char *options = NULL;
520 Error *local_err = NULL;
525 static const struct option long_options[] = {
526 {"help", no_argument, 0, 'h'},
527 {"object", required_argument, 0, OPTION_OBJECT},
530 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
537 missing_argument(argv[optind - 1]);
540 unrecognized_option(argv[optind - 1]);
549 base_filename = optarg;
555 if (accumulate_options(&options, optarg) < 0) {
563 flags |= BDRV_O_NO_BACKING;
566 user_creatable_process_cmdline(optarg);
571 /* Get the filename */
572 filename = (optind < argc) ? argv[optind] : NULL;
573 if (options && has_help_option(options)) {
575 return print_block_option_help(filename, fmt);
578 if (optind >= argc) {
579 error_exit("Expecting image file name");
583 /* Get image size, if specified */
587 sval = cvtnum("image size", argv[optind++]);
591 img_size = (uint64_t)sval;
593 if (optind != argc) {
594 error_exit("Unexpected argument: %s", argv[optind]);
597 bdrv_img_create(filename, fmt, base_filename, base_fmt,
598 options, img_size, flags, quiet, &local_err);
600 error_reportf_err(local_err, "%s: ", filename);
612 static void dump_json_image_check(ImageCheck *check, bool quiet)
616 Visitor *v = qobject_output_visitor_new(&obj);
618 visit_type_ImageCheck(v, NULL, &check, &error_abort);
619 visit_complete(v, &obj);
620 str = qobject_to_json_pretty(obj, true);
622 qprintf(quiet, "%s\n", str->str);
625 g_string_free(str, true);
628 static void dump_human_image_check(ImageCheck *check, bool quiet)
630 if (!(check->corruptions || check->leaks || check->check_errors)) {
631 qprintf(quiet, "No errors were found on the image.\n");
633 if (check->corruptions) {
634 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
635 "Data may be corrupted, or further writes to the image "
642 "\n%" PRId64 " leaked clusters were found on the image.\n"
643 "This means waste of disk space, but no harm to data.\n",
647 if (check->check_errors) {
650 " internal errors have occurred during the check.\n",
651 check->check_errors);
655 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
656 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
657 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
658 check->allocated_clusters, check->total_clusters,
659 check->allocated_clusters * 100.0 / check->total_clusters,
660 check->fragmented_clusters * 100.0 / check->allocated_clusters,
661 check->compressed_clusters * 100.0 /
662 check->allocated_clusters);
665 if (check->image_end_offset) {
667 "Image end offset: %" PRId64 "\n", check->image_end_offset);
671 static int collect_image_check(BlockDriverState *bs,
673 const char *filename,
678 BdrvCheckResult result;
680 ret = bdrv_check(bs, &result, fix);
685 check->filename = g_strdup(filename);
686 check->format = g_strdup(bdrv_get_format_name(bs));
687 check->check_errors = result.check_errors;
688 check->corruptions = result.corruptions;
689 check->has_corruptions = result.corruptions != 0;
690 check->leaks = result.leaks;
691 check->has_leaks = result.leaks != 0;
692 check->corruptions_fixed = result.corruptions_fixed;
693 check->has_corruptions_fixed = result.corruptions_fixed != 0;
694 check->leaks_fixed = result.leaks_fixed;
695 check->has_leaks_fixed = result.leaks_fixed != 0;
696 check->image_end_offset = result.image_end_offset;
697 check->has_image_end_offset = result.image_end_offset != 0;
698 check->total_clusters = result.bfi.total_clusters;
699 check->has_total_clusters = result.bfi.total_clusters != 0;
700 check->allocated_clusters = result.bfi.allocated_clusters;
701 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
702 check->fragmented_clusters = result.bfi.fragmented_clusters;
703 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
704 check->compressed_clusters = result.bfi.compressed_clusters;
705 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
711 * Checks an image for consistency. Exit codes:
713 * 0 - Check completed, image is good
714 * 1 - Check not completed because of internal errors
715 * 2 - Check completed, image is corrupted
716 * 3 - Check completed, image has leaked clusters, but is good otherwise
717 * 63 - Checks are not supported by the image format
719 static int img_check(int argc, char **argv)
722 OutputFormat output_format = OFORMAT_HUMAN;
723 const char *filename, *fmt, *output, *cache;
725 BlockDriverState *bs;
727 int flags = BDRV_O_CHECK;
731 bool image_opts = false;
732 bool force_share = false;
736 cache = BDRV_DEFAULT_CACHE;
739 int option_index = 0;
740 static const struct option long_options[] = {
741 {"help", no_argument, 0, 'h'},
742 {"format", required_argument, 0, 'f'},
743 {"repair", required_argument, 0, 'r'},
744 {"output", required_argument, 0, OPTION_OUTPUT},
745 {"object", required_argument, 0, OPTION_OBJECT},
746 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
747 {"force-share", no_argument, 0, 'U'},
750 c = getopt_long(argc, argv, ":hf:r:T:qU",
751 long_options, &option_index);
757 missing_argument(argv[optind - 1]);
760 unrecognized_option(argv[optind - 1]);
769 flags |= BDRV_O_RDWR;
771 if (!strcmp(optarg, "leaks")) {
772 fix = BDRV_FIX_LEAKS;
773 } else if (!strcmp(optarg, "all")) {
774 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
776 error_exit("Unknown option value for -r "
777 "(expecting 'leaks' or 'all'): %s", optarg);
793 user_creatable_process_cmdline(optarg);
795 case OPTION_IMAGE_OPTS:
800 if (optind != argc - 1) {
801 error_exit("Expecting one image file name");
803 filename = argv[optind++];
805 if (output && !strcmp(output, "json")) {
806 output_format = OFORMAT_JSON;
807 } else if (output && !strcmp(output, "human")) {
808 output_format = OFORMAT_HUMAN;
810 error_report("--output must be used with human or json as argument.");
814 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
816 error_report("Invalid source cache option: %s", cache);
820 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
827 check = g_new0(ImageCheck, 1);
828 ret = collect_image_check(bs, check, filename, fmt, fix);
830 if (ret == -ENOTSUP) {
831 error_report("This image format does not support checks");
836 if (check->corruptions_fixed || check->leaks_fixed) {
837 int corruptions_fixed, leaks_fixed;
838 bool has_leaks_fixed, has_corruptions_fixed;
840 leaks_fixed = check->leaks_fixed;
841 has_leaks_fixed = check->has_leaks_fixed;
842 corruptions_fixed = check->corruptions_fixed;
843 has_corruptions_fixed = check->has_corruptions_fixed;
845 if (output_format == OFORMAT_HUMAN) {
847 "The following inconsistencies were found and repaired:\n\n"
848 " %" PRId64 " leaked clusters\n"
849 " %" PRId64 " corruptions\n\n"
850 "Double checking the fixed image now...\n",
852 check->corruptions_fixed);
855 qapi_free_ImageCheck(check);
856 check = g_new0(ImageCheck, 1);
857 ret = collect_image_check(bs, check, filename, fmt, 0);
859 check->leaks_fixed = leaks_fixed;
860 check->has_leaks_fixed = has_leaks_fixed;
861 check->corruptions_fixed = corruptions_fixed;
862 check->has_corruptions_fixed = has_corruptions_fixed;
866 switch (output_format) {
868 dump_human_image_check(check, quiet);
871 dump_json_image_check(check, quiet);
876 if (ret || check->check_errors) {
878 error_report("Check failed: %s", strerror(-ret));
880 error_report("Check failed");
886 if (check->corruptions) {
888 } else if (check->leaks) {
895 qapi_free_ImageCheck(check);
900 typedef struct CommonBlockJobCBInfo {
901 BlockDriverState *bs;
903 } CommonBlockJobCBInfo;
905 static void common_block_job_cb(void *opaque, int ret)
907 CommonBlockJobCBInfo *cbi = opaque;
910 error_setg_errno(cbi->errp, -ret, "Block job failed");
914 static void run_block_job(BlockJob *job, Error **errp)
916 uint64_t progress_current, progress_total;
917 AioContext *aio_context = block_job_get_aio_context(job);
921 job_ref_locked(&job->job);
923 float progress = 0.0f;
925 aio_poll(aio_context, true);
927 progress_get_snapshot(&job->job.progress, &progress_current,
929 if (progress_total) {
930 progress = (float)progress_current / progress_total * 100.f;
932 qemu_progress_print(progress, 0);
934 } while (!job_is_ready_locked(&job->job) &&
935 !job_is_completed_locked(&job->job));
937 if (!job_is_completed_locked(&job->job)) {
938 ret = job_complete_sync_locked(&job->job, errp);
942 job_unref_locked(&job->job);
945 /* publish completion progress only when success */
947 qemu_progress_print(100.f, 0);
951 static int img_commit(int argc, char **argv)
954 const char *filename, *fmt, *cache, *base;
956 BlockDriverState *bs, *base_bs;
958 bool progress = false, quiet = false, drop = false;
960 Error *local_err = NULL;
961 CommonBlockJobCBInfo cbi;
962 bool image_opts = false;
963 AioContext *aio_context;
964 int64_t rate_limit = 0;
967 cache = BDRV_DEFAULT_CACHE;
970 static const struct option long_options[] = {
971 {"help", no_argument, 0, 'h'},
972 {"object", required_argument, 0, OPTION_OBJECT},
973 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
976 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
983 missing_argument(argv[optind - 1]);
986 unrecognized_option(argv[optind - 1]);
1012 rate_limit = cvtnum("rate limit", optarg);
1013 if (rate_limit < 0) {
1018 user_creatable_process_cmdline(optarg);
1020 case OPTION_IMAGE_OPTS:
1026 /* Progress is not shown in Quiet mode */
1031 if (optind != argc - 1) {
1032 error_exit("Expecting one image file name");
1034 filename = argv[optind++];
1036 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
1037 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1039 error_report("Invalid cache option: %s", cache);
1043 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1050 qemu_progress_init(progress, 1.f);
1051 qemu_progress_print(0.f, 100);
1054 base_bs = bdrv_find_backing_image(bs, base);
1056 error_setg(&local_err,
1057 "Did not find '%s' in the backing chain of '%s'",
1062 /* This is different from QMP, which by default uses the deepest file in
1063 * the backing chain (i.e., the very base); however, the traditional
1064 * behavior of qemu-img commit is using the immediate backing file. */
1065 base_bs = bdrv_backing_chain_next(bs);
1067 error_setg(&local_err, "Image does not have a backing file");
1072 cbi = (CommonBlockJobCBInfo){
1077 aio_context = bdrv_get_aio_context(bs);
1078 aio_context_acquire(aio_context);
1079 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
1080 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1081 &cbi, false, &local_err);
1082 aio_context_release(aio_context);
1087 /* When the block job completes, the BlockBackend reference will point to
1088 * the old backing file. In order to avoid that the top image is already
1089 * deleted, so we can still empty it afterwards, increment the reference
1090 * counter here preemptively. */
1095 job = block_job_get("commit");
1097 run_block_job(job, &local_err);
1103 BlockBackend *old_backing_blk;
1105 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1107 if (!old_backing_blk) {
1110 ret = blk_make_empty(old_backing_blk, &local_err);
1111 blk_unref(old_backing_blk);
1112 if (ret == -ENOTSUP) {
1113 error_free(local_err);
1115 } else if (ret < 0) {
1126 qemu_progress_end();
1129 * Manually inactivate the image first because this way we can know whether
1130 * an error occurred. blk_unref() doesn't tell us about failures.
1132 ret = bdrv_inactivate_all();
1133 if (ret < 0 && !local_err) {
1134 error_setg_errno(&local_err, -ret, "Error while closing the image");
1139 error_report_err(local_err);
1143 qprintf(quiet, "Image committed.\n");
1148 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1149 * of the first sector boundary within buf where the sector contains a
1150 * non-zero byte. This function is robust to a buffer that is not
1153 static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1156 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1158 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1159 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1163 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1170 * Returns true iff the first sector pointed to by 'buf' contains at least
1173 * 'pnum' is set to the number of sectors (including and immediately following
1174 * the first one) that are known to be in the same allocated/unallocated state.
1175 * The function will try to align the end offset to alignment boundaries so
1176 * that the request will at least end aligned and consecutive requests will
1177 * also start at an aligned offset.
1179 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1180 int64_t sector_num, int alignment)
1189 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
1190 for(i = 1; i < n; i++) {
1191 buf += BDRV_SECTOR_SIZE;
1192 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
1199 * The whole buf is the same.
1200 * No reason to split it into chunks, so return now.
1206 tail = (sector_num + i) & (alignment - 1);
1208 if (is_zero && i <= tail) {
1210 * For sure next sector after i is data, and it will rewrite this
1211 * tail anyway due to RMW. So, let's just write data now.
1216 /* If possible, align up end offset of allocated areas. */
1217 i += alignment - tail;
1221 * For sure next sector after i is data, and it will rewrite this
1222 * tail anyway due to RMW. Better is avoid RMW and write zeroes up
1233 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1235 * breaking up write requests for only small sparse areas.
1237 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1238 int min, int64_t sector_num, int alignment)
1241 int num_checked, num_used;
1247 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1253 buf += BDRV_SECTOR_SIZE * *pnum;
1255 sector_num += *pnum;
1256 num_checked = num_used;
1259 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1261 buf += BDRV_SECTOR_SIZE * *pnum;
1263 sector_num += *pnum;
1264 num_checked += *pnum;
1266 num_used = num_checked;
1267 } else if (*pnum >= min) {
1277 * Compares two buffers chunk by chunk, where @chsize is the chunk size.
1278 * If @chsize is 0, default chunk size of BDRV_SECTOR_SIZE is used.
1279 * Returns 0 if the first chunk of each buffer matches, non-zero otherwise.
1281 * @pnum is set to the size of the buffer prefix aligned to @chsize that
1282 * has the same matching status as the first chunk.
1284 static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1285 int64_t bytes, uint64_t chsize, int64_t *pnum)
1293 chsize = BDRV_SECTOR_SIZE;
1295 i = MIN(bytes, chsize);
1297 res = !!memcmp(buf1, buf2, i);
1299 int64_t len = MIN(bytes - i, chsize);
1301 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
1311 #define IO_BUF_SIZE (2 * MiB)
1314 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1316 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1317 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1318 * failure), and 4 on error (the exit status for read errors), after emitting
1321 * @param blk: BlockBackend for the image
1322 * @param offset: Starting offset to check
1323 * @param bytes: Number of bytes to check
1324 * @param filename: Name of disk file we are checking (logging purpose)
1325 * @param buffer: Allocated buffer for storing read data
1326 * @param quiet: Flag for quiet mode
1328 static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1329 int64_t bytes, const char *filename,
1330 uint8_t *buffer, bool quiet)
1335 ret = blk_pread(blk, offset, bytes, buffer, 0);
1337 error_report("Error while reading offset %" PRId64 " of %s: %s",
1338 offset, filename, strerror(-ret));
1341 idx = find_nonzero(buffer, bytes);
1343 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1352 * Compares two images. Exit codes:
1354 * 0 - Images are identical or the requested help was printed
1356 * >1 - Error occurred
1358 static int img_compare(int argc, char **argv)
1360 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1361 BlockBackend *blk1, *blk2;
1362 BlockDriverState *bs1, *bs2;
1363 int64_t total_size1, total_size2;
1364 uint8_t *buf1 = NULL, *buf2 = NULL;
1365 int64_t pnum1, pnum2;
1366 int allocated1, allocated2;
1367 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1368 bool progress = false, quiet = false, strict = false;
1375 uint64_t progress_base;
1376 bool image_opts = false;
1377 bool force_share = false;
1379 cache = BDRV_DEFAULT_CACHE;
1381 static const struct option long_options[] = {
1382 {"help", no_argument, 0, 'h'},
1383 {"object", required_argument, 0, OPTION_OBJECT},
1384 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1385 {"force-share", no_argument, 0, 'U'},
1388 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1389 long_options, NULL);
1395 missing_argument(argv[optind - 1]);
1398 unrecognized_option(argv[optind - 1]);
1426 Error *local_err = NULL;
1428 if (!user_creatable_add_from_str(optarg, &local_err)) {
1430 error_report_err(local_err);
1433 /* Help was printed */
1439 case OPTION_IMAGE_OPTS:
1445 /* Progress is not shown in Quiet mode */
1451 if (optind != argc - 2) {
1452 error_exit("Expecting two image file names");
1454 filename1 = argv[optind++];
1455 filename2 = argv[optind++];
1457 /* Initialize before goto out */
1458 qemu_progress_init(progress, 2.0);
1461 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1463 error_report("Invalid source cache option: %s", cache);
1468 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1475 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1484 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1485 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1486 total_size1 = blk_getlength(blk1);
1487 if (total_size1 < 0) {
1488 error_report("Can't get size of %s: %s",
1489 filename1, strerror(-total_size1));
1493 total_size2 = blk_getlength(blk2);
1494 if (total_size2 < 0) {
1495 error_report("Can't get size of %s: %s",
1496 filename2, strerror(-total_size2));
1500 total_size = MIN(total_size1, total_size2);
1501 progress_base = MAX(total_size1, total_size2);
1503 qemu_progress_print(0, 100);
1505 if (strict && total_size1 != total_size2) {
1507 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1511 while (offset < total_size) {
1512 int status1, status2;
1514 status1 = bdrv_block_status_above(bs1, NULL, offset,
1515 total_size1 - offset, &pnum1, NULL,
1519 error_report("Sector allocation test failed for %s", filename1);
1522 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1524 status2 = bdrv_block_status_above(bs2, NULL, offset,
1525 total_size2 - offset, &pnum2, NULL,
1529 error_report("Sector allocation test failed for %s", filename2);
1532 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1534 assert(pnum1 && pnum2);
1535 chunk = MIN(pnum1, pnum2);
1538 if (status1 != status2) {
1540 qprintf(quiet, "Strict mode: Offset %" PRId64
1541 " block status mismatch!\n", offset);
1545 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1547 } else if (allocated1 == allocated2) {
1551 chunk = MIN(chunk, IO_BUF_SIZE);
1552 ret = blk_pread(blk1, offset, chunk, buf1, 0);
1554 error_report("Error while reading offset %" PRId64
1556 offset, filename1, strerror(-ret));
1560 ret = blk_pread(blk2, offset, chunk, buf2, 0);
1562 error_report("Error while reading offset %" PRId64
1564 offset, filename2, strerror(-ret));
1568 ret = compare_buffers(buf1, buf2, chunk, 0, &pnum);
1569 if (ret || pnum != chunk) {
1570 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1571 offset + (ret ? 0 : pnum));
1577 chunk = MIN(chunk, IO_BUF_SIZE);
1579 ret = check_empty_sectors(blk1, offset, chunk,
1580 filename1, buf1, quiet);
1582 ret = check_empty_sectors(blk2, offset, chunk,
1583 filename2, buf1, quiet);
1590 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1593 if (total_size1 != total_size2) {
1594 BlockBackend *blk_over;
1595 const char *filename_over;
1597 qprintf(quiet, "Warning: Image size mismatch!\n");
1598 if (total_size1 > total_size2) {
1600 filename_over = filename1;
1603 filename_over = filename2;
1606 while (offset < progress_base) {
1607 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1608 progress_base - offset, &chunk,
1612 error_report("Sector allocation test failed for %s",
1617 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1618 chunk = MIN(chunk, IO_BUF_SIZE);
1619 ret = check_empty_sectors(blk_over, offset, chunk,
1620 filename_over, buf1, quiet);
1626 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1630 qprintf(quiet, "Images are identical.\n");
1640 qemu_progress_end();
1644 /* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1645 static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1646 const char *src_node, const char *src_name,
1649 BlockDirtyBitmapOrStr *merge_src;
1650 BlockDirtyBitmapOrStrList *list = NULL;
1652 merge_src = g_new0(BlockDirtyBitmapOrStr, 1);
1653 merge_src->type = QTYPE_QDICT;
1654 merge_src->u.external.node = g_strdup(src_node);
1655 merge_src->u.external.name = g_strdup(src_name);
1656 QAPI_LIST_PREPEND(list, merge_src);
1657 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1658 qapi_free_BlockDirtyBitmapOrStrList(list);
1661 enum ImgConvertBlockStatus {
1667 #define MAX_COROUTINES 16
1668 #define CONVERT_THROTTLE_GROUP "img_convert"
1670 typedef struct ImgConvertState {
1672 int64_t *src_sectors;
1675 int64_t total_sectors;
1676 int64_t allocated_sectors;
1677 int64_t allocated_done;
1680 enum ImgConvertBlockStatus status;
1681 int64_t sector_next_status;
1682 BlockBackend *target;
1686 bool target_has_backing;
1687 int64_t target_backing_sectors; /* negative if unknown */
1694 size_t cluster_sectors;
1696 long num_coroutines;
1697 int running_coroutines;
1698 Coroutine *co[MAX_COROUTINES];
1699 int64_t wait_sector_num[MAX_COROUTINES];
1704 static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1705 int *src_cur, int64_t *src_cur_offset)
1708 *src_cur_offset = 0;
1709 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1710 *src_cur_offset += s->src_sectors[*src_cur];
1712 assert(*src_cur < s->src_num);
1716 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1718 int64_t src_cur_offset;
1719 int ret, n, src_cur;
1720 bool post_backing_zero = false;
1722 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1724 assert(s->total_sectors > sector_num);
1725 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1727 if (s->target_backing_sectors >= 0) {
1728 if (sector_num >= s->target_backing_sectors) {
1729 post_backing_zero = true;
1730 } else if (sector_num + n > s->target_backing_sectors) {
1731 /* Split requests around target_backing_sectors (because
1732 * starting from there, zeros are handled differently) */
1733 n = s->target_backing_sectors - sector_num;
1737 if (s->sector_next_status <= sector_num) {
1738 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1741 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1742 BlockDriverState *base;
1744 if (s->target_has_backing) {
1745 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1751 count = n * BDRV_SECTOR_SIZE;
1753 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1760 warn_report("error while reading block status at "
1761 "offset %" PRIu64 ": %s", offset,
1764 /* Just try to read the data, then */
1765 ret = BDRV_BLOCK_DATA;
1766 count = BDRV_SECTOR_SIZE;
1768 /* Retry on a shorter range */
1769 n = DIV_ROUND_UP(n, 4);
1772 error_report("error while reading block status at offset "
1773 "%" PRIu64 ": %s", offset, strerror(-ret));
1779 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1782 * Avoid that s->sector_next_status becomes unaligned to the source
1783 * request alignment and/or cluster size to avoid unnecessary read
1786 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1791 if (ret & BDRV_BLOCK_ZERO) {
1792 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1793 } else if (ret & BDRV_BLOCK_DATA) {
1794 s->status = BLK_DATA;
1796 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1799 s->sector_next_status = sector_num + n;
1802 n = MIN(n, s->sector_next_status - sector_num);
1803 if (s->status == BLK_DATA) {
1804 n = MIN(n, s->buf_sectors);
1807 /* We need to write complete clusters for compressed images, so if an
1808 * unallocated area is shorter than that, we must consider the whole
1809 * cluster allocated. */
1810 if (s->compressed) {
1811 if (n < s->cluster_sectors) {
1812 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1813 s->status = BLK_DATA;
1815 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1822 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1823 int nb_sectors, uint8_t *buf)
1825 uint64_t single_read_until = 0;
1828 assert(nb_sectors <= s->buf_sectors);
1829 while (nb_sectors > 0) {
1832 int64_t bs_sectors, src_cur_offset;
1835 /* In the case of compression with multiple source files, we can get a
1836 * nb_sectors that spreads into the next part. So we must be able to
1837 * read across multiple BDSes for one convert_read() call. */
1838 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1839 blk = s->src[src_cur];
1840 bs_sectors = s->src_sectors[src_cur];
1842 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1844 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1845 if (single_read_until > offset) {
1849 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
1853 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1857 warn_report("error while reading offset %" PRIu64
1858 ": %s", offset, strerror(-ret));
1860 memset(buf, 0, BDRV_SECTOR_SIZE);
1869 buf += n * BDRV_SECTOR_SIZE;
1876 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1877 int nb_sectors, uint8_t *buf,
1878 enum ImgConvertBlockStatus status)
1882 while (nb_sectors > 0) {
1884 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1887 case BLK_BACKING_FILE:
1888 /* If we have a backing file, leave clusters unallocated that are
1889 * unallocated in the source image, so that the backing file is
1890 * visible at the respective offset. */
1891 assert(s->target_has_backing);
1895 /* If we're told to keep the target fully allocated (-S 0) or there
1896 * is real non-zero data, we must write it. Otherwise we can treat
1897 * it as zero sectors.
1898 * Compressed clusters need to be written as a whole, so in that
1899 * case we can only save the write if the buffer is completely
1901 if (!s->min_sparse ||
1903 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1904 sector_num, s->alignment)) ||
1906 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1908 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1909 n << BDRV_SECTOR_BITS, buf, flags);
1918 if (s->has_zero_init) {
1919 assert(!s->target_has_backing);
1922 ret = blk_co_pwrite_zeroes(s->target,
1923 sector_num << BDRV_SECTOR_BITS,
1924 n << BDRV_SECTOR_BITS,
1925 BDRV_REQ_MAY_UNMAP);
1934 buf += n * BDRV_SECTOR_SIZE;
1940 static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1945 while (nb_sectors > 0) {
1948 int64_t bs_sectors, src_cur_offset;
1951 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1952 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1953 blk = s->src[src_cur];
1954 bs_sectors = s->src_sectors[src_cur];
1956 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1958 ret = blk_co_copy_range(blk, offset, s->target,
1959 sector_num << BDRV_SECTOR_BITS,
1960 n << BDRV_SECTOR_BITS, 0, 0);
1971 static void coroutine_fn convert_co_do_copy(void *opaque)
1973 ImgConvertState *s = opaque;
1974 uint8_t *buf = NULL;
1978 for (i = 0; i < s->num_coroutines; i++) {
1979 if (s->co[i] == qemu_coroutine_self()) {
1986 s->running_coroutines++;
1987 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1992 enum ImgConvertBlockStatus status;
1995 qemu_co_mutex_lock(&s->lock);
1996 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1997 qemu_co_mutex_unlock(&s->lock);
2000 WITH_GRAPH_RDLOCK_GUARD() {
2001 n = convert_iteration_sectors(s, s->sector_num);
2004 qemu_co_mutex_unlock(&s->lock);
2008 /* save current sector and allocation status to local variables */
2009 sector_num = s->sector_num;
2011 if (!s->min_sparse && s->status == BLK_ZERO) {
2012 n = MIN(n, s->buf_sectors);
2014 /* increment global sector counter so that other coroutines can
2015 * already continue reading beyond this request */
2017 qemu_co_mutex_unlock(&s->lock);
2019 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
2020 s->allocated_done += n;
2021 qemu_progress_print(100.0 * s->allocated_done /
2022 s->allocated_sectors, 0);
2026 copy_range = s->copy_range && s->status == BLK_DATA;
2027 if (status == BLK_DATA && !copy_range) {
2028 ret = convert_co_read(s, sector_num, n, buf);
2030 error_report("error while reading at byte %lld: %s",
2031 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2034 } else if (!s->min_sparse && status == BLK_ZERO) {
2036 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2039 if (s->wr_in_order) {
2040 /* keep writes in order */
2041 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
2042 s->wait_sector_num[index] = sector_num;
2043 qemu_coroutine_yield();
2045 s->wait_sector_num[index] = -1;
2048 if (s->ret == -EINPROGRESS) {
2050 WITH_GRAPH_RDLOCK_GUARD() {
2051 ret = convert_co_copy_range(s, sector_num, n);
2054 s->copy_range = false;
2058 ret = convert_co_write(s, sector_num, n, buf, status);
2061 error_report("error while writing at byte %lld: %s",
2062 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2067 if (s->wr_in_order) {
2068 /* reenter the coroutine that might have waited
2069 * for this write to complete */
2070 s->wr_offs = sector_num + n;
2071 for (i = 0; i < s->num_coroutines; i++) {
2072 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2074 * A -> B -> A cannot occur because A has
2075 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2076 * B will never enter A during this time window.
2078 qemu_coroutine_enter(s->co[i]);
2086 s->co[index] = NULL;
2087 s->running_coroutines--;
2088 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2089 /* the convert job finished successfully */
2094 static int convert_do_copy(ImgConvertState *s)
2097 int64_t sector_num = 0;
2099 /* Check whether we have zero initialisation or can get it efficiently */
2100 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2101 !s->target_has_backing) {
2102 bdrv_graph_rdlock_main_loop();
2103 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
2104 bdrv_graph_rdunlock_main_loop();
2107 /* Allocate buffer for copied data. For compressed images, only one cluster
2108 * can be copied at a time. */
2109 if (s->compressed) {
2110 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2111 error_report("invalid cluster size");
2114 s->buf_sectors = s->cluster_sectors;
2117 while (sector_num < s->total_sectors) {
2118 n = convert_iteration_sectors(s, sector_num);
2122 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2124 s->allocated_sectors += n;
2130 s->sector_next_status = 0;
2131 s->ret = -EINPROGRESS;
2133 qemu_co_mutex_init(&s->lock);
2134 for (i = 0; i < s->num_coroutines; i++) {
2135 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2136 s->wait_sector_num[i] = -1;
2137 qemu_coroutine_enter(s->co[i]);
2140 while (s->running_coroutines) {
2141 main_loop_wait(false);
2144 if (s->compressed && !s->ret) {
2145 /* signal EOF to align */
2146 ret = blk_pwrite_compressed(s->target, 0, 0, NULL);
2155 /* Check that bitmaps can be copied, or output an error */
2156 static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
2158 BdrvDirtyBitmap *bm;
2160 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2161 error_report("Source lacks bitmap support");
2164 FOR_EACH_DIRTY_BITMAP(src, bm) {
2165 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2168 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2169 error_report("Cannot copy inconsistent bitmap '%s'",
2170 bdrv_dirty_bitmap_name(bm));
2171 error_printf("Try --skip-broken-bitmaps, or "
2172 "use 'qemu-img bitmap --remove' to delete it\n");
2179 static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2182 BdrvDirtyBitmap *bm;
2185 FOR_EACH_DIRTY_BITMAP(src, bm) {
2188 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2191 name = bdrv_dirty_bitmap_name(bm);
2192 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2193 warn_report("Skipping inconsistent bitmap '%s'", name);
2196 qmp_block_dirty_bitmap_add(dst->node_name, name,
2197 true, bdrv_dirty_bitmap_granularity(bm),
2199 true, !bdrv_dirty_bitmap_enabled(bm),
2202 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2206 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2209 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
2210 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
2218 #define MAX_BUF_SECTORS 32768
2220 static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2224 throttle_config_init(&cfg);
2225 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2227 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2228 blk_set_io_limits(blk, &cfg);
2231 static int img_convert(int argc, char **argv)
2233 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
2234 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
2235 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2236 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2237 *backing_fmt = NULL;
2238 BlockDriver *drv = NULL, *proto_drv = NULL;
2239 BlockDriverInfo bdi;
2240 BlockDriverState *out_bs;
2241 QemuOpts *opts = NULL, *sn_opts = NULL;
2242 QemuOptsList *create_opts = NULL;
2243 QDict *open_opts = NULL;
2244 char *options = NULL;
2245 Error *local_err = NULL;
2246 bool writethrough, src_writethrough, image_opts = false,
2247 skip_create = false, progress = false, tgt_image_opts = false;
2248 int64_t ret = -EINVAL;
2249 bool force_share = false;
2250 bool explict_min_sparse = false;
2251 bool bitmaps = false;
2252 bool skip_broken = false;
2253 int64_t rate_limit = 0;
2255 ImgConvertState s = (ImgConvertState) {
2256 /* Need at least 4k of zeros for sparse detection */
2258 .copy_range = false,
2259 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2260 .wr_in_order = true,
2261 .num_coroutines = 8,
2265 static const struct option long_options[] = {
2266 {"help", no_argument, 0, 'h'},
2267 {"object", required_argument, 0, OPTION_OBJECT},
2268 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2269 {"force-share", no_argument, 0, 'U'},
2270 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2271 {"salvage", no_argument, 0, OPTION_SALVAGE},
2272 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
2273 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
2274 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
2277 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
2278 long_options, NULL);
2284 missing_argument(argv[optind - 1]);
2287 unrecognized_option(argv[optind - 1]);
2299 out_baseimg = optarg;
2302 s.copy_range = true;
2305 s.compressed = true;
2308 backing_fmt = optarg;
2311 if (accumulate_options(&options, optarg) < 0) {
2316 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2317 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2320 error_report("Failed in parsing snapshot param '%s'",
2325 snapshot_name = optarg;
2332 sval = cvtnum("buffer size for sparse output", optarg);
2335 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
2336 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2337 error_report("Invalid buffer size for sparse output specified. "
2338 "Valid sizes are multiples of %llu up to %llu. Select "
2339 "0 to disable sparse detection (fully allocates output).",
2340 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2344 s.min_sparse = sval / BDRV_SECTOR_SIZE;
2345 explict_min_sparse = true;
2364 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2365 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2366 error_report("Invalid number of coroutines. Allowed number of"
2367 " coroutines is between 1 and %d", MAX_COROUTINES);
2372 s.wr_in_order = false;
2378 rate_limit = cvtnum("rate limit", optarg);
2379 if (rate_limit < 0) {
2384 user_creatable_process_cmdline(optarg);
2386 case OPTION_IMAGE_OPTS:
2389 case OPTION_SALVAGE:
2392 case OPTION_TARGET_IMAGE_OPTS:
2393 tgt_image_opts = true;
2395 case OPTION_TARGET_IS_ZERO:
2397 * The user asserting that the target is blank has the
2398 * same effect as the target driver supporting zero
2401 s.has_zero_init = true;
2403 case OPTION_BITMAPS:
2406 case OPTION_SKIP_BROKEN:
2412 if (!out_fmt && !tgt_image_opts) {
2416 if (skip_broken && !bitmaps) {
2417 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2421 if (s.compressed && s.copy_range) {
2422 error_report("Cannot enable copy offloading when -c is used");
2426 if (explict_min_sparse && s.copy_range) {
2427 error_report("Cannot enable copy offloading when -S is used");
2431 if (s.copy_range && s.salvage) {
2432 error_report("Cannot use copy offloading in salvaging mode");
2436 if (tgt_image_opts && !skip_create) {
2437 error_report("--target-image-opts requires use of -n flag");
2441 if (skip_create && options) {
2442 error_report("-o has no effect when skipping image creation");
2446 if (s.has_zero_init && !skip_create) {
2447 error_report("--target-is-zero requires use of -n flag");
2451 s.src_num = argc - optind - 1;
2452 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2454 if (options && has_help_option(options)) {
2456 ret = print_block_option_help(out_filename, out_fmt);
2459 error_report("Option help requires a format be specified");
2464 if (s.src_num < 1) {
2465 error_report("Must specify image file name");
2469 /* ret is still -EINVAL until here */
2470 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2472 error_report("Invalid source cache option: %s", src_cache);
2476 /* Initialize before goto out */
2480 qemu_progress_init(progress, 1.0);
2481 qemu_progress_print(0, 100);
2483 s.src = g_new0(BlockBackend *, s.src_num);
2484 s.src_sectors = g_new(int64_t, s.src_num);
2485 s.src_alignment = g_new(int, s.src_num);
2487 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2488 BlockDriverState *src_bs;
2489 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2490 fmt, src_flags, src_writethrough, s.quiet,
2496 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2497 if (s.src_sectors[bs_i] < 0) {
2498 error_report("Could not get size of %s: %s",
2499 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2503 src_bs = blk_bs(s.src[bs_i]);
2504 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2506 if (!bdrv_get_info(src_bs, &bdi)) {
2507 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2508 bdi.cluster_size / BDRV_SECTOR_SIZE);
2510 s.total_sectors += s.src_sectors[bs_i];
2514 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2515 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2516 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2518 } else if (snapshot_name != NULL) {
2519 if (s.src_num > 1) {
2520 error_report("No support for concatenating multiple snapshot");
2525 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2529 error_reportf_err(local_err, "Failed to load snapshot: ");
2535 /* Find driver and parse its options */
2536 drv = bdrv_find_format(out_fmt);
2538 error_report("Unknown file format '%s'", out_fmt);
2543 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2545 error_report_err(local_err);
2550 if (!drv->create_opts) {
2551 error_report("Format driver '%s' does not support image creation",
2557 if (!proto_drv->create_opts) {
2558 error_report("Protocol driver '%s' does not support image creation",
2559 proto_drv->format_name);
2564 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2565 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2567 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2569 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
2570 error_report_err(local_err);
2576 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2577 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
2578 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
2584 /* Get backing file name if -o backing_file was used */
2585 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2586 if (out_baseimg_param) {
2587 out_baseimg = out_baseimg_param;
2589 s.target_has_backing = (bool) out_baseimg;
2591 if (s.has_zero_init && s.target_has_backing) {
2592 error_report("Cannot use --target-is-zero when the destination "
2593 "image has a backing file");
2597 if (s.src_num > 1 && out_baseimg) {
2598 error_report("Having a backing file for the target makes no sense when "
2599 "concatenating multiple input images");
2604 if (out_baseimg_param) {
2605 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
2606 error_report("Use of backing file requires explicit "
2613 /* Check if compression is supported */
2616 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2617 const char *encryptfmt =
2618 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2619 const char *preallocation =
2620 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2622 if (drv && !block_driver_can_compress(drv)) {
2623 error_report("Compression not supported for this file format");
2628 if (encryption || encryptfmt) {
2629 error_report("Compression and encryption not supported at "
2636 && strcmp(preallocation, "off"))
2638 error_report("Compression and preallocation not supported at "
2645 /* Determine if bitmaps need copying */
2647 if (s.src_num > 1) {
2648 error_report("Copying bitmaps only possible with single source");
2652 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
2659 * The later open call will need any decryption secrets, and
2660 * bdrv_create() will purge "opts", so extract them now before
2664 open_opts = qdict_new();
2665 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2667 /* Create the new image */
2668 ret = bdrv_create(drv, out_filename, opts, &local_err);
2670 error_reportf_err(local_err, "%s: error while converting %s: ",
2671 out_filename, out_fmt);
2676 s.target_is_new = !skip_create;
2678 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2679 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2681 error_report("Invalid cache option: %s", cache);
2685 if (flags & BDRV_O_NOCACHE) {
2687 * If we open the target with O_DIRECT, it may be necessary to
2688 * extend its size to align to the physical sector size.
2690 flags |= BDRV_O_RESIZE;
2694 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
2695 flags, writethrough, s.quiet, false);
2697 /* TODO ultimately we should allow --target-image-opts
2698 * to be used even when -n is not given.
2699 * That has to wait for bdrv_create to be improved
2700 * to allow filenames in option syntax
2702 s.target = img_open_file(out_filename, open_opts, out_fmt,
2703 flags, writethrough, s.quiet, false);
2704 open_opts = NULL; /* blk_new_open will have freed it */
2710 out_bs = blk_bs(s.target);
2712 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2713 error_report("Format driver '%s' does not support bitmaps",
2714 out_bs->drv->format_name);
2719 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
2720 error_report("Compression not supported for this file format");
2725 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2726 * or discard_alignment of the out_bs is greater. Limit to
2727 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2728 s.buf_sectors = MIN(MAX_BUF_SECTORS,
2730 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2731 out_bs->bl.pdiscard_alignment >>
2732 BDRV_SECTOR_BITS)));
2734 /* try to align the write requests to the destination to avoid unnecessary
2736 s.alignment = MAX(pow2floor(s.min_sparse),
2737 DIV_ROUND_UP(out_bs->bl.request_alignment,
2739 assert(is_power_of_2(s.alignment));
2742 int64_t output_sectors = blk_nb_sectors(s.target);
2743 if (output_sectors < 0) {
2744 error_report("unable to get output image length: %s",
2745 strerror(-output_sectors));
2748 } else if (output_sectors < s.total_sectors) {
2749 error_report("output file is smaller than input file");
2755 if (s.target_has_backing && s.target_is_new) {
2756 /* Errors are treated as "backing length unknown" (which means
2757 * s.target_backing_sectors has to be negative, which it will
2758 * be automatically). The backing file length is used only
2759 * for optimizations, so such a case is not fatal. */
2760 s.target_backing_sectors =
2761 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
2763 s.target_backing_sectors = -1;
2766 ret = bdrv_get_info(out_bs, &bdi);
2769 error_report("could not get block driver info");
2773 s.compressed = s.compressed || bdi.needs_compressed_writes;
2774 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2778 set_rate_limit(s.target, rate_limit);
2781 ret = convert_do_copy(&s);
2783 /* Now copy the bitmaps */
2784 if (bitmaps && ret == 0) {
2785 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
2790 qemu_progress_print(100, 0);
2792 qemu_progress_end();
2793 qemu_opts_del(opts);
2794 qemu_opts_free(create_opts);
2795 qobject_unref(open_opts);
2796 blk_unref(s.target);
2798 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2799 blk_unref(s.src[bs_i]);
2803 g_free(s.src_sectors);
2804 g_free(s.src_alignment);
2806 qemu_opts_del(sn_opts);
2813 static void dump_snapshots(BlockDriverState *bs)
2815 QEMUSnapshotInfo *sn_tab, *sn;
2818 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2821 printf("Snapshot list:\n");
2822 bdrv_snapshot_dump(NULL);
2824 for(i = 0; i < nb_sns; i++) {
2826 bdrv_snapshot_dump(sn);
2832 static void dump_json_block_graph_info_list(BlockGraphInfoList *list)
2836 Visitor *v = qobject_output_visitor_new(&obj);
2838 visit_type_BlockGraphInfoList(v, NULL, &list, &error_abort);
2839 visit_complete(v, &obj);
2840 str = qobject_to_json_pretty(obj, true);
2841 assert(str != NULL);
2842 printf("%s\n", str->str);
2845 g_string_free(str, true);
2848 static void dump_json_block_graph_info(BlockGraphInfo *info)
2852 Visitor *v = qobject_output_visitor_new(&obj);
2854 visit_type_BlockGraphInfo(v, NULL, &info, &error_abort);
2855 visit_complete(v, &obj);
2856 str = qobject_to_json_pretty(obj, true);
2857 assert(str != NULL);
2858 printf("%s\n", str->str);
2861 g_string_free(str, true);
2864 static void dump_human_image_info(BlockGraphInfo *info, int indentation,
2867 BlockChildInfoList *children_list;
2869 bdrv_node_info_dump(qapi_BlockGraphInfo_base(info), indentation,
2870 info->children == NULL);
2872 for (children_list = info->children; children_list;
2873 children_list = children_list->next)
2875 BlockChildInfo *child = children_list->value;
2876 g_autofree char *child_path = NULL;
2878 printf("%*sChild node '%s%s':\n",
2879 indentation * 4, "", path, child->name);
2880 child_path = g_strdup_printf("%s%s/", path, child->name);
2881 dump_human_image_info(child->info, indentation + 1, child_path);
2885 static void dump_human_image_info_list(BlockGraphInfoList *list)
2887 BlockGraphInfoList *elem;
2890 for (elem = list; elem; elem = elem->next) {
2896 dump_human_image_info(elem->value, 0, "/");
2900 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2902 return strcmp(a, b) == 0;
2906 * Open an image file chain and return an BlockGraphInfoList
2908 * @filename: topmost image filename
2909 * @fmt: topmost image format (may be NULL to autodetect)
2910 * @chain: true - enumerate entire backing file chain
2911 * false - only topmost image file
2913 * Returns a list of BlockNodeInfo objects or NULL if there was an error
2914 * opening an image file. If there was an error a message will have been
2915 * printed to stderr.
2917 static BlockGraphInfoList *collect_image_info_list(bool image_opts,
2918 const char *filename,
2920 bool chain, bool force_share)
2922 BlockGraphInfoList *head = NULL;
2923 BlockGraphInfoList **tail = &head;
2924 GHashTable *filenames;
2927 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2931 BlockDriverState *bs;
2932 BlockGraphInfo *info;
2934 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2935 error_report("Backing file '%s' creates an infinite loop.",
2939 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2941 blk = img_open(image_opts, filename, fmt,
2942 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2950 * Note that the returned BlockGraphInfo object will not have
2951 * information about this image's backing node, because we have opened
2952 * it with BDRV_O_NO_BACKING. Printing this object will therefore not
2953 * duplicate the backing chain information that we obtain by walking
2954 * the chain manually here.
2956 bdrv_graph_rdlock_main_loop();
2957 bdrv_query_block_graph_info(bs, &info, &err);
2958 bdrv_graph_rdunlock_main_loop();
2961 error_report_err(err);
2966 QAPI_LIST_APPEND(tail, info);
2970 /* Clear parameters that only apply to the topmost image */
2971 filename = fmt = NULL;
2975 if (info->full_backing_filename) {
2976 filename = info->full_backing_filename;
2977 } else if (info->backing_filename) {
2978 error_report("Could not determine absolute backing filename,"
2979 " but backing filename '%s' present",
2980 info->backing_filename);
2983 if (info->backing_filename_format) {
2984 fmt = info->backing_filename_format;
2988 g_hash_table_destroy(filenames);
2992 qapi_free_BlockGraphInfoList(head);
2993 g_hash_table_destroy(filenames);
2997 static int img_info(int argc, char **argv)
3000 OutputFormat output_format = OFORMAT_HUMAN;
3002 const char *filename, *fmt, *output;
3003 BlockGraphInfoList *list;
3004 bool image_opts = false;
3005 bool force_share = false;
3010 int option_index = 0;
3011 static const struct option long_options[] = {
3012 {"help", no_argument, 0, 'h'},
3013 {"format", required_argument, 0, 'f'},
3014 {"output", required_argument, 0, OPTION_OUTPUT},
3015 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
3016 {"object", required_argument, 0, OPTION_OBJECT},
3017 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3018 {"force-share", no_argument, 0, 'U'},
3021 c = getopt_long(argc, argv, ":f:hU",
3022 long_options, &option_index);
3028 missing_argument(argv[optind - 1]);
3031 unrecognized_option(argv[optind - 1]);
3045 case OPTION_BACKING_CHAIN:
3049 user_creatable_process_cmdline(optarg);
3051 case OPTION_IMAGE_OPTS:
3056 if (optind != argc - 1) {
3057 error_exit("Expecting one image file name");
3059 filename = argv[optind++];
3061 if (output && !strcmp(output, "json")) {
3062 output_format = OFORMAT_JSON;
3063 } else if (output && !strcmp(output, "human")) {
3064 output_format = OFORMAT_HUMAN;
3065 } else if (output) {
3066 error_report("--output must be used with human or json as argument.");
3070 list = collect_image_info_list(image_opts, filename, fmt, chain,
3076 switch (output_format) {
3078 dump_human_image_info_list(list);
3082 dump_json_block_graph_info_list(list);
3084 dump_json_block_graph_info(list->value);
3089 qapi_free_BlockGraphInfoList(list);
3093 static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3096 switch (output_format) {
3098 if (e->data && !e->has_offset) {
3099 error_report("File contains external, encrypted or compressed clusters.");
3102 if (e->data && !e->zero) {
3103 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
3104 e->start, e->length,
3105 e->has_offset ? e->offset : 0,
3108 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3109 * Modify the flags here to allow more coalescing.
3111 if (next && (!next->data || next->zero)) {
3117 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
3118 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
3119 " \"data\": %s, \"compressed\": %s",
3120 e->start, e->length, e->depth,
3121 e->present ? "true" : "false",
3122 e->zero ? "true" : "false",
3123 e->data ? "true" : "false",
3124 e->compressed ? "true" : "false");
3125 if (e->has_offset) {
3126 printf(", \"offset\": %"PRId64"", e->offset);
3138 static int get_block_status(BlockDriverState *bs, int64_t offset,
3139 int64_t bytes, MapEntry *e)
3143 BlockDriverState *file;
3146 char *filename = NULL;
3148 /* As an optimization, we could cache the current range of unallocated
3149 * clusters in each file of the chain, and avoid querying the same
3155 bs = bdrv_skip_filters(bs);
3156 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
3161 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3164 bs = bdrv_cow_bs(bs);
3173 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3175 if (file && has_offset) {
3176 bdrv_graph_rdlock_main_loop();
3177 bdrv_refresh_filename(file);
3178 bdrv_graph_rdunlock_main_loop();
3179 filename = file->filename;
3185 .data = !!(ret & BDRV_BLOCK_DATA),
3186 .zero = !!(ret & BDRV_BLOCK_ZERO),
3187 .compressed = !!(ret & BDRV_BLOCK_COMPRESSED),
3189 .has_offset = has_offset,
3191 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
3192 .filename = filename,
3198 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3200 if (curr->length == 0) {
3203 if (curr->zero != next->zero ||
3204 curr->data != next->data ||
3205 curr->compressed != next->compressed ||
3206 curr->depth != next->depth ||
3207 curr->present != next->present ||
3208 !curr->filename != !next->filename ||
3209 curr->has_offset != next->has_offset) {
3212 if (curr->filename && strcmp(curr->filename, next->filename)) {
3215 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3221 static int img_map(int argc, char **argv)
3224 OutputFormat output_format = OFORMAT_HUMAN;
3226 BlockDriverState *bs;
3227 const char *filename, *fmt, *output;
3229 MapEntry curr = { .length = 0 }, next;
3231 bool image_opts = false;
3232 bool force_share = false;
3233 int64_t start_offset = 0;
3234 int64_t max_length = -1;
3239 int option_index = 0;
3240 static const struct option long_options[] = {
3241 {"help", no_argument, 0, 'h'},
3242 {"format", required_argument, 0, 'f'},
3243 {"output", required_argument, 0, OPTION_OUTPUT},
3244 {"object", required_argument, 0, OPTION_OBJECT},
3245 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3246 {"force-share", no_argument, 0, 'U'},
3247 {"start-offset", required_argument, 0, 's'},
3248 {"max-length", required_argument, 0, 'l'},
3251 c = getopt_long(argc, argv, ":f:s:l:hU",
3252 long_options, &option_index);
3258 missing_argument(argv[optind - 1]);
3261 unrecognized_option(argv[optind - 1]);
3276 start_offset = cvtnum("start offset", optarg);
3277 if (start_offset < 0) {
3282 max_length = cvtnum("max length", optarg);
3283 if (max_length < 0) {
3288 user_creatable_process_cmdline(optarg);
3290 case OPTION_IMAGE_OPTS:
3295 if (optind != argc - 1) {
3296 error_exit("Expecting one image file name");
3298 filename = argv[optind];
3300 if (output && !strcmp(output, "json")) {
3301 output_format = OFORMAT_JSON;
3302 } else if (output && !strcmp(output, "human")) {
3303 output_format = OFORMAT_HUMAN;
3304 } else if (output) {
3305 error_report("--output must be used with human or json as argument.");
3309 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
3315 if (output_format == OFORMAT_HUMAN) {
3316 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3317 } else if (output_format == OFORMAT_JSON) {
3321 length = blk_getlength(blk);
3323 error_report("Failed to get size for '%s'", filename);
3326 if (max_length != -1) {
3327 length = MIN(start_offset + max_length, length);
3330 curr.start = start_offset;
3331 while (curr.start + curr.length < length) {
3332 int64_t offset = curr.start + curr.length;
3333 int64_t n = length - offset;
3335 ret = get_block_status(bs, offset, n, &next);
3337 error_report("Could not read file metadata: %s", strerror(-ret));
3341 if (entry_mergeable(&curr, &next)) {
3342 curr.length += next.length;
3346 if (curr.length > 0) {
3347 ret = dump_map_entry(output_format, &curr, &next);
3355 ret = dump_map_entry(output_format, &curr, NULL);
3356 if (output_format == OFORMAT_JSON) {
3365 #define SNAPSHOT_LIST 1
3366 #define SNAPSHOT_CREATE 2
3367 #define SNAPSHOT_APPLY 3
3368 #define SNAPSHOT_DELETE 4
3370 static int img_snapshot(int argc, char **argv)
3373 BlockDriverState *bs;
3374 QEMUSnapshotInfo sn;
3375 char *filename, *snapshot_name = NULL;
3376 int c, ret = 0, bdrv_oflags;
3380 bool image_opts = false;
3381 bool force_share = false;
3384 bdrv_oflags = BDRV_O_RDWR;
3385 /* Parse commandline parameters */
3387 static const struct option long_options[] = {
3388 {"help", no_argument, 0, 'h'},
3389 {"object", required_argument, 0, OPTION_OBJECT},
3390 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3391 {"force-share", no_argument, 0, 'U'},
3394 c = getopt_long(argc, argv, ":la:c:d:hqU",
3395 long_options, NULL);
3401 missing_argument(argv[optind - 1]);
3404 unrecognized_option(argv[optind - 1]);
3411 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3414 action = SNAPSHOT_LIST;
3415 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3419 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3422 action = SNAPSHOT_APPLY;
3423 snapshot_name = optarg;
3427 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3430 action = SNAPSHOT_CREATE;
3431 snapshot_name = optarg;
3435 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3438 action = SNAPSHOT_DELETE;
3439 snapshot_name = optarg;
3448 user_creatable_process_cmdline(optarg);
3450 case OPTION_IMAGE_OPTS:
3456 if (optind != argc - 1) {
3457 error_exit("Expecting one image file name");
3459 filename = argv[optind++];
3461 /* Open the image */
3462 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3469 /* Perform the requested action */
3475 case SNAPSHOT_CREATE:
3476 memset(&sn, 0, sizeof(sn));
3477 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3479 rt = g_get_real_time();
3480 sn.date_sec = rt / G_USEC_PER_SEC;
3481 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000;
3483 bdrv_graph_rdlock_main_loop();
3484 ret = bdrv_snapshot_create(bs, &sn);
3485 bdrv_graph_rdunlock_main_loop();
3488 error_report("Could not create snapshot '%s': %s",
3489 snapshot_name, strerror(-ret));
3493 case SNAPSHOT_APPLY:
3494 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3496 error_reportf_err(err, "Could not apply snapshot '%s': ",
3501 case SNAPSHOT_DELETE:
3502 bdrv_graph_rdlock_main_loop();
3503 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3505 error_report("Could not delete snapshot '%s': snapshot not "
3506 "found", snapshot_name);
3509 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3511 error_reportf_err(err, "Could not delete snapshot '%s': ",
3516 bdrv_graph_rdunlock_main_loop();
3528 static int img_rebase(int argc, char **argv)
3530 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
3531 uint8_t *buf_old = NULL;
3532 uint8_t *buf_new = NULL;
3533 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
3534 BlockDriverState *unfiltered_bs;
3535 BlockDriverInfo bdi = {0};
3537 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3538 int c, flags, src_flags, ret;
3539 BdrvRequestFlags write_flags = 0;
3540 bool writethrough, src_writethrough;
3542 bool force_share = false;
3545 bool compress = false;
3546 Error *local_err = NULL;
3547 bool image_opts = false;
3548 int64_t write_align;
3550 /* Parse commandline parameters */
3552 cache = BDRV_DEFAULT_CACHE;
3553 src_cache = BDRV_DEFAULT_CACHE;
3557 static const struct option long_options[] = {
3558 {"help", no_argument, 0, 'h'},
3559 {"object", required_argument, 0, OPTION_OBJECT},
3560 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3561 {"force-share", no_argument, 0, 'U'},
3562 {"compress", no_argument, 0, 'c'},
3565 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qUc",
3566 long_options, NULL);
3572 missing_argument(argv[optind - 1]);
3575 unrecognized_option(argv[optind - 1]);
3584 out_basefmt = optarg;
3587 out_baseimg = optarg;
3605 user_creatable_process_cmdline(optarg);
3607 case OPTION_IMAGE_OPTS:
3623 if (optind != argc - 1) {
3624 error_exit("Expecting one image file name");
3626 if (!unsafe && !out_baseimg) {
3627 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3629 filename = argv[optind++];
3631 qemu_progress_init(progress, 2.0);
3632 qemu_progress_print(0, 100);
3634 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3635 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3637 error_report("Invalid cache option: %s", cache);
3642 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3644 error_report("Invalid source cache option: %s", src_cache);
3648 /* The source files are opened read-only, don't care about WCE */
3649 assert((src_flags & BDRV_O_RDWR) == 0);
3650 (void) src_writethrough;
3655 * Ignore the old backing file for unsafe rebase in case we want to correct
3656 * the reference to a renamed or moved backing file.
3658 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3666 unfiltered_bs = bdrv_skip_filters(bs);
3668 if (compress && !block_driver_can_compress(unfiltered_bs->drv)) {
3669 error_report("Compression not supported for this file format");
3672 } else if (compress) {
3673 write_flags |= BDRV_REQ_WRITE_COMPRESSED;
3676 if (out_basefmt != NULL) {
3677 if (bdrv_find_format(out_basefmt) == NULL) {
3678 error_report("Invalid format name: '%s'", out_basefmt);
3685 * We need overlay subcluster size (or cluster size in case writes are
3686 * compressed) to make sure write requests are aligned.
3688 ret = bdrv_get_info(unfiltered_bs, &bdi);
3690 error_report("could not get block driver info");
3692 } else if (bdi.subcluster_size == 0) {
3693 bdi.cluster_size = bdi.subcluster_size = 1;
3696 write_align = compress ? bdi.cluster_size : bdi.subcluster_size;
3698 /* For safe rebasing we need to compare old and new backing file */
3700 QDict *options = NULL;
3701 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
3704 blk_old_backing = blk_new(qemu_get_aio_context(),
3705 BLK_PERM_CONSISTENT_READ,
3707 ret = blk_insert_bs(blk_old_backing, base_bs,
3710 error_reportf_err(local_err,
3711 "Could not reuse old backing file '%s': ",
3716 blk_old_backing = NULL;
3719 if (out_baseimg[0]) {
3720 const char *overlay_filename;
3721 char *out_real_path;
3723 options = qdict_new();
3725 qdict_put_str(options, "driver", out_basefmt);
3728 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3731 bdrv_graph_rdlock_main_loop();
3732 bdrv_refresh_filename(bs);
3733 bdrv_graph_rdunlock_main_loop();
3734 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3737 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3741 qobject_unref(options);
3742 error_reportf_err(local_err,
3743 "Could not resolve backing filename: ");
3749 * Find out whether we rebase an image on top of a previous image
3752 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
3753 if (prefix_chain_bs) {
3754 qobject_unref(options);
3755 g_free(out_real_path);
3757 blk_new_backing = blk_new(qemu_get_aio_context(),
3758 BLK_PERM_CONSISTENT_READ,
3760 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3763 error_reportf_err(local_err,
3764 "Could not reuse backing file '%s': ",
3769 blk_new_backing = blk_new_open(out_real_path, NULL,
3770 options, src_flags, &local_err);
3771 g_free(out_real_path);
3772 if (!blk_new_backing) {
3773 error_reportf_err(local_err,
3774 "Could not open new backing file '%s': ",
3784 * Check each unallocated cluster in the COW file. If it is unallocated,
3785 * accesses go to the backing file. We must therefore compare this cluster
3786 * in the old and new backing file, and if they differ we need to copy it
3787 * from the old backing file into the COW file.
3789 * If qemu-img crashes during this step, no harm is done. The content of
3790 * the image is the same as the original one at any time.
3794 int64_t old_backing_size = 0;
3795 int64_t new_backing_size = 0;
3797 int64_t n, n_old = 0, n_new = 0;
3798 float local_progress = 0;
3800 if (blk_old_backing && bdrv_opt_mem_align(blk_bs(blk_old_backing)) >
3801 bdrv_opt_mem_align(blk_bs(blk))) {
3802 buf_old = blk_blockalign(blk_old_backing, IO_BUF_SIZE);
3804 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3806 buf_new = blk_blockalign(blk_new_backing, IO_BUF_SIZE);
3808 size = blk_getlength(blk);
3810 error_report("Could not get size of '%s': %s",
3811 filename, strerror(-size));
3815 if (blk_old_backing) {
3816 old_backing_size = blk_getlength(blk_old_backing);
3817 if (old_backing_size < 0) {
3818 char backing_name[PATH_MAX];
3820 bdrv_get_backing_filename(bs, backing_name,
3821 sizeof(backing_name));
3822 error_report("Could not get size of '%s': %s",
3823 backing_name, strerror(-old_backing_size));
3828 if (blk_new_backing) {
3829 new_backing_size = blk_getlength(blk_new_backing);
3830 if (new_backing_size < 0) {
3831 error_report("Could not get size of '%s': %s",
3832 out_baseimg, strerror(-new_backing_size));
3839 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3842 for (offset = 0; offset < size; offset += n) {
3843 bool old_backing_eof = false;
3846 /* How many bytes can we handle with the next read? */
3847 n = MIN(IO_BUF_SIZE, size - offset);
3849 /* If the cluster is allocated, we don't need to take action */
3850 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
3852 error_report("error while reading image metadata: %s",
3860 if (prefix_chain_bs) {
3864 * If cluster wasn't changed since prefix_chain, we don't need
3867 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3868 prefix_chain_bs, false,
3871 error_report("error while reading image metadata: %s",
3880 * If we've reached EOF of the old backing, it means that
3881 * offsets beyond the old backing size were read as zeroes.
3882 * Now we will need to explicitly zero the cluster in
3883 * order to preserve that state after the rebase.
3890 * At this point we know that the region [offset; offset + n)
3891 * is unallocated within the target image. This region might be
3892 * unaligned to the target image's (sub)cluster boundaries, as
3893 * old backing may have smaller clusters (or have subclusters).
3894 * We extend it to the aligned boundaries to avoid CoW on
3895 * partial writes in blk_pwrite(),
3897 n += offset - QEMU_ALIGN_DOWN(offset, write_align);
3898 offset = QEMU_ALIGN_DOWN(offset, write_align);
3899 n += QEMU_ALIGN_UP(offset + n, write_align) - (offset + n);
3900 n = MIN(n, size - offset);
3901 assert(!bdrv_is_allocated(unfiltered_bs, offset, n, &n_alloc) &&
3905 * Much like with the target image, we'll try to read as much
3906 * of the old and new backings as we can.
3908 n_old = MIN(n, MAX(0, old_backing_size - (int64_t) offset));
3909 n_new = MIN(n, MAX(0, new_backing_size - (int64_t) offset));
3912 * Read old and new backing file and take into consideration that
3913 * backing files may be smaller than the COW image.
3915 memset(buf_old + n_old, 0, n - n_old);
3917 old_backing_eof = true;
3919 ret = blk_pread(blk_old_backing, offset, n_old, buf_old, 0);
3921 error_report("error while reading from old backing file");
3926 memset(buf_new + n_new, 0, n - n_new);
3928 ret = blk_pread(blk_new_backing, offset, n_new, buf_new, 0);
3930 error_report("error while reading from new backing file");
3935 /* If they differ, we need to write to the COW file */
3936 uint64_t written = 0;
3938 while (written < n) {
3941 if (compare_buffers(buf_old + written, buf_new + written,
3942 n - written, write_align, &pnum))
3944 if (old_backing_eof) {
3945 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3947 assert(written + pnum <= IO_BUF_SIZE);
3948 ret = blk_pwrite(blk, offset + written, pnum,
3949 buf_old + written, write_flags);
3952 error_report("Error while writing to COW image: %s",
3959 if (offset + written >= old_backing_size) {
3960 old_backing_eof = true;
3963 qemu_progress_print(local_progress, 100);
3968 * Change the backing file. All clusters that are different from the old
3969 * backing file are overwritten in the COW file now, so the visible content
3970 * doesn't change when we switch the backing file.
3972 if (out_baseimg && *out_baseimg) {
3973 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3976 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
3979 if (ret == -ENOSPC) {
3980 error_report("Could not change the backing file to '%s': No "
3981 "space left in the file header", out_baseimg);
3982 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3983 error_report("Could not change the backing file to '%s': backing "
3984 "format must be specified", out_baseimg);
3985 } else if (ret < 0) {
3986 error_report("Could not change the backing file to '%s': %s",
3987 out_baseimg, strerror(-ret));
3990 qemu_progress_print(100, 0);
3992 * TODO At this point it is possible to check if any clusters that are
3993 * allocated in the COW file are the same in the backing file. If so, they
3994 * could be dropped from the COW file. Don't do this before switching the
3995 * backing file, in case of a crash this would lead to corruption.
3998 qemu_progress_end();
4001 blk_unref(blk_old_backing);
4002 blk_unref(blk_new_backing);
4004 qemu_vfree(buf_old);
4005 qemu_vfree(buf_new);
4014 static int img_resize(int argc, char **argv)
4017 int c, ret, relative;
4018 const char *filename, *fmt, *size;
4019 int64_t n, total_size, current_size;
4021 BlockBackend *blk = NULL;
4022 PreallocMode prealloc = PREALLOC_MODE_OFF;
4025 static QemuOptsList resize_options = {
4026 .name = "resize_options",
4027 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
4030 .name = BLOCK_OPT_SIZE,
4031 .type = QEMU_OPT_SIZE,
4032 .help = "Virtual disk size"
4038 bool image_opts = false;
4039 bool shrink = false;
4041 /* Remove size from argv manually so that negative numbers are not treated
4042 * as options by getopt. */
4044 error_exit("Not enough arguments");
4048 size = argv[--argc];
4050 /* Parse getopt arguments */
4053 static const struct option long_options[] = {
4054 {"help", no_argument, 0, 'h'},
4055 {"object", required_argument, 0, OPTION_OBJECT},
4056 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4057 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
4058 {"shrink", no_argument, 0, OPTION_SHRINK},
4061 c = getopt_long(argc, argv, ":f:hq",
4062 long_options, NULL);
4068 missing_argument(argv[optind - 1]);
4071 unrecognized_option(argv[optind - 1]);
4083 user_creatable_process_cmdline(optarg);
4085 case OPTION_IMAGE_OPTS:
4088 case OPTION_PREALLOCATION:
4089 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
4090 PREALLOC_MODE__MAX, NULL);
4091 if (prealloc == PREALLOC_MODE__MAX) {
4092 error_report("Invalid preallocation mode '%s'", optarg);
4101 if (optind != argc - 1) {
4102 error_exit("Expecting image file name and size");
4104 filename = argv[optind++];
4106 /* Choose grow, shrink, or absolute resize mode */
4122 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
4123 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
4124 error_report_err(err);
4126 qemu_opts_del(param);
4129 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
4130 qemu_opts_del(param);
4132 blk = img_open(image_opts, filename, fmt,
4133 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4140 current_size = blk_getlength(blk);
4141 if (current_size < 0) {
4142 error_report("Failed to inquire current image length: %s",
4143 strerror(-current_size));
4149 total_size = current_size + n * relative;
4153 if (total_size <= 0) {
4154 error_report("New image size must be positive");
4159 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4160 error_report("Preallocation can only be used for growing images");
4165 if (total_size < current_size && !shrink) {
4166 error_report("Use the --shrink option to perform a shrink operation.");
4167 warn_report("Shrinking an image will delete all data beyond the "
4168 "shrunken image's end. Before performing such an "
4169 "operation, make sure there is no important data there.");
4175 * The user expects the image to have the desired size after
4176 * resizing, so pass @exact=true. It is of no use to report
4177 * success when the image has not actually been resized.
4179 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
4181 qprintf(quiet, "Image resized.\n");
4183 error_report_err(err);
4193 static void amend_status_cb(BlockDriverState *bs,
4194 int64_t offset, int64_t total_work_size,
4197 qemu_progress_print(100.f * offset / total_work_size, 0);
4200 static int print_amend_option_help(const char *format)
4204 GRAPH_RDLOCK_GUARD_MAINLOOP();
4206 /* Find driver and parse its options */
4207 drv = bdrv_find_format(format);
4209 error_report("Unknown file format '%s'", format);
4213 if (!drv->bdrv_amend_options) {
4214 error_report("Format driver '%s' does not support option amendment",
4219 /* Every driver supporting amendment must have amend_opts */
4220 assert(drv->amend_opts);
4222 printf("Amend options for '%s':\n", format);
4223 qemu_opts_print_help(drv->amend_opts, false);
4227 static int img_amend(int argc, char **argv)
4231 char *options = NULL;
4232 QemuOptsList *amend_opts = NULL;
4233 QemuOpts *opts = NULL;
4234 const char *fmt = NULL, *filename, *cache;
4237 bool quiet = false, progress = false;
4238 BlockBackend *blk = NULL;
4239 BlockDriverState *bs = NULL;
4240 bool image_opts = false;
4243 cache = BDRV_DEFAULT_CACHE;
4245 static const struct option long_options[] = {
4246 {"help", no_argument, 0, 'h'},
4247 {"object", required_argument, 0, OPTION_OBJECT},
4248 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4249 {"force", no_argument, 0, OPTION_FORCE},
4252 c = getopt_long(argc, argv, ":ho:f:t:pq",
4253 long_options, NULL);
4260 missing_argument(argv[optind - 1]);
4263 unrecognized_option(argv[optind - 1]);
4269 if (accumulate_options(&options, optarg) < 0) {
4271 goto out_no_progress;
4287 user_creatable_process_cmdline(optarg);
4289 case OPTION_IMAGE_OPTS:
4299 error_exit("Must specify options (-o)");
4305 qemu_progress_init(progress, 1.0);
4307 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4308 if (fmt && has_help_option(options)) {
4309 /* If a format is explicitly specified (and possibly no filename is
4310 * given), print option help here */
4311 ret = print_amend_option_help(fmt);
4315 if (optind != argc - 1) {
4316 error_report("Expecting one image file name");
4321 flags = BDRV_O_RDWR;
4322 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
4324 error_report("Invalid cache option: %s", cache);
4328 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4336 fmt = bs->drv->format_name;
4338 if (has_help_option(options)) {
4339 /* If the format was auto-detected, print option help here */
4340 ret = print_amend_option_help(fmt);
4344 bdrv_graph_rdlock_main_loop();
4345 if (!bs->drv->bdrv_amend_options) {
4346 error_report("Format driver '%s' does not support option amendment",
4348 bdrv_graph_rdunlock_main_loop();
4353 /* Every driver supporting amendment must have amend_opts */
4354 assert(bs->drv->amend_opts);
4356 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4357 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
4358 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
4359 /* Try to parse options using the create options */
4360 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4361 qemu_opts_del(opts);
4362 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
4363 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
4364 error_append_hint(&err,
4365 "This option is only supported for image creation\n");
4368 bdrv_graph_rdunlock_main_loop();
4369 error_report_err(err);
4374 /* In case the driver does not call amend_status_cb() */
4375 qemu_progress_print(0.f, 0);
4376 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
4377 qemu_progress_print(100.f, 0);
4378 bdrv_graph_rdunlock_main_loop();
4381 error_report_err(err);
4386 qemu_progress_end();
4390 qemu_opts_del(opts);
4391 qemu_opts_free(amend_opts);
4400 typedef struct BenchData {
4402 uint64_t image_size;
4409 bool drain_on_flush;
4418 static void bench_undrained_flush_cb(void *opaque, int ret)
4421 error_report("Failed flush request: %s", strerror(-ret));
4426 static void bench_cb(void *opaque, int ret)
4428 BenchData *b = opaque;
4432 error_report("Failed request: %s", strerror(-ret));
4437 /* Just finished a flush with drained queue: Start next requests */
4438 assert(b->in_flight == 0);
4439 b->in_flush = false;
4440 } else if (b->in_flight > 0) {
4441 int remaining = b->n - b->in_flight;
4446 /* Time for flush? Drain queue if requested, then flush */
4447 if (b->flush_interval && remaining % b->flush_interval == 0) {
4448 if (!b->in_flight || !b->drain_on_flush) {
4449 BlockCompletionFunc *cb;
4451 if (b->drain_on_flush) {
4455 cb = bench_undrained_flush_cb;
4458 acb = blk_aio_flush(b->blk, cb, b);
4460 error_report("Failed to issue flush request");
4464 if (b->drain_on_flush) {
4470 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4471 int64_t offset = b->offset;
4472 /* blk_aio_* might look for completed I/Os and kick bench_cb
4473 * again, so make sure this operation is counted by in_flight
4474 * and b->offset is ready for the next submission.
4477 b->offset += b->step;
4478 b->offset %= b->image_size;
4480 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
4482 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
4485 error_report("Failed to issue request");
4491 static int img_bench(int argc, char **argv)
4494 const char *fmt = NULL, *filename;
4496 bool image_opts = false;
4497 bool is_write = false;
4501 size_t bufsize = 4096;
4504 int flush_interval = 0;
4505 bool drain_on_flush = true;
4507 BlockBackend *blk = NULL;
4508 BenchData data = {};
4510 bool writethrough = false;
4511 struct timeval t1, t2;
4513 bool force_share = false;
4514 size_t buf_size = 0;
4517 static const struct option long_options[] = {
4518 {"help", no_argument, 0, 'h'},
4519 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
4520 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4521 {"pattern", required_argument, 0, OPTION_PATTERN},
4522 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4523 {"force-share", no_argument, 0, 'U'},
4526 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4534 missing_argument(argv[optind - 1]);
4537 unrecognized_option(argv[optind - 1]);
4546 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4547 error_report("Invalid request count specified");
4557 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4558 error_report("Invalid queue depth specified");
4568 flags |= BDRV_O_NATIVE_AIO;
4571 ret = bdrv_parse_aio(optarg, &flags);
4573 error_report("Invalid aio option: %s", optarg);
4580 offset = cvtnum("offset", optarg);
4594 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4606 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4615 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4617 error_report("Invalid cache mode");
4623 flags |= BDRV_O_RDWR;
4629 case OPTION_PATTERN:
4633 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
4634 error_report("Invalid pattern byte specified");
4640 case OPTION_FLUSH_INTERVAL:
4644 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4645 error_report("Invalid flush interval specified");
4648 flush_interval = res;
4651 case OPTION_NO_DRAIN:
4652 drain_on_flush = false;
4654 case OPTION_IMAGE_OPTS:
4660 if (optind != argc - 1) {
4661 error_exit("Expecting one image file name");
4663 filename = argv[argc - 1];
4665 if (!is_write && flush_interval) {
4666 error_report("--flush-interval is only available in write tests");
4670 if (flush_interval && flush_interval < depth) {
4671 error_report("Flush interval can't be smaller than depth");
4676 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4683 image_size = blk_getlength(blk);
4684 if (image_size < 0) {
4689 data = (BenchData) {
4691 .image_size = image_size,
4693 .step = step ?: bufsize,
4698 .flush_interval = flush_interval,
4699 .drain_on_flush = drain_on_flush,
4701 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4702 "(starting at offset %" PRId64 ", step size %d)\n",
4703 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4704 data.offset, data.step);
4705 if (flush_interval) {
4706 printf("Sending flush every %d requests\n", flush_interval);
4709 buf_size = data.nrreq * data.bufsize;
4710 data.buf = blk_blockalign(blk, buf_size);
4711 memset(data.buf, pattern, data.nrreq * data.bufsize);
4713 blk_register_buf(blk, data.buf, buf_size, &error_fatal);
4715 data.qiov = g_new(QEMUIOVector, data.nrreq);
4716 for (i = 0; i < data.nrreq; i++) {
4717 qemu_iovec_init(&data.qiov[i], 1);
4718 qemu_iovec_add(&data.qiov[i],
4719 data.buf + i * data.bufsize, data.bufsize);
4722 gettimeofday(&t1, NULL);
4725 while (data.n > 0) {
4726 main_loop_wait(false);
4728 gettimeofday(&t2, NULL);
4730 printf("Run completed in %3.3f seconds.\n",
4731 (t2.tv_sec - t1.tv_sec)
4732 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4736 blk_unregister_buf(blk, data.buf, buf_size);
4738 qemu_vfree(data.buf);
4755 typedef struct ImgBitmapAction {
4756 enum ImgBitmapAct act;
4757 const char *src; /* only used for merge */
4758 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4761 static int img_bitmap(int argc, char **argv)
4765 QemuOpts *opts = NULL;
4766 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4767 const char *filename, *bitmap;
4768 BlockBackend *blk = NULL, *src = NULL;
4769 BlockDriverState *bs = NULL, *src_bs = NULL;
4770 bool image_opts = false;
4771 int64_t granularity = 0;
4772 bool add = false, merge = false;
4773 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4774 ImgBitmapAction *act, *act_next;
4778 QSIMPLEQ_INIT(&actions);
4781 static const struct option long_options[] = {
4782 {"help", no_argument, 0, 'h'},
4783 {"object", required_argument, 0, OPTION_OBJECT},
4784 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4785 {"add", no_argument, 0, OPTION_ADD},
4786 {"remove", no_argument, 0, OPTION_REMOVE},
4787 {"clear", no_argument, 0, OPTION_CLEAR},
4788 {"enable", no_argument, 0, OPTION_ENABLE},
4789 {"disable", no_argument, 0, OPTION_DISABLE},
4790 {"merge", required_argument, 0, OPTION_MERGE},
4791 {"granularity", required_argument, 0, 'g'},
4792 {"source-file", required_argument, 0, 'b'},
4793 {"source-format", required_argument, 0, 'F'},
4796 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4803 missing_argument(argv[optind - 1]);
4806 unrecognized_option(argv[optind - 1]);
4812 src_filename = optarg;
4821 granularity = cvtnum("granularity", optarg);
4822 if (granularity < 0) {
4827 act = g_new0(ImgBitmapAction, 1);
4828 act->act = BITMAP_ADD;
4829 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4833 act = g_new0(ImgBitmapAction, 1);
4834 act->act = BITMAP_REMOVE;
4835 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4838 act = g_new0(ImgBitmapAction, 1);
4839 act->act = BITMAP_CLEAR;
4840 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4843 act = g_new0(ImgBitmapAction, 1);
4844 act->act = BITMAP_ENABLE;
4845 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4847 case OPTION_DISABLE:
4848 act = g_new0(ImgBitmapAction, 1);
4849 act->act = BITMAP_DISABLE;
4850 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4853 act = g_new0(ImgBitmapAction, 1);
4854 act->act = BITMAP_MERGE;
4856 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4860 user_creatable_process_cmdline(optarg);
4862 case OPTION_IMAGE_OPTS:
4868 if (QSIMPLEQ_EMPTY(&actions)) {
4869 error_report("Need at least one of --add, --remove, --clear, "
4870 "--enable, --disable, or --merge");
4874 if (granularity && !add) {
4875 error_report("granularity only supported with --add");
4878 if (src_fmt && !src_filename) {
4879 error_report("-F only supported with -b");
4882 if (src_filename && !merge) {
4883 error_report("Merge bitmap source file only supported with "
4888 if (optind != argc - 2) {
4889 error_report("Expecting filename and bitmap name");
4893 filename = argv[optind];
4894 bitmap = argv[optind + 1];
4897 * No need to open backing chains; we will be manipulating bitmaps
4898 * directly in this image without reference to image contents.
4900 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4901 false, false, false);
4907 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4908 false, false, false);
4912 src_bs = blk_bs(src);
4917 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4920 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4921 !!granularity, granularity, true, true,
4922 false, false, &err);
4926 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4930 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4934 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4937 case BITMAP_DISABLE:
4938 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4942 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4947 g_assert_not_reached();
4951 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4962 * Manually inactivate the images first because this way we can know whether
4963 * an error occurred. blk_unref() doesn't tell us about failures.
4965 inactivate_ret = bdrv_inactivate_all();
4966 if (inactivate_ret < 0) {
4967 error_report("Error while closing the image: %s", strerror(-inactivate_ret));
4973 qemu_opts_del(opts);
4989 int bsz; /* Block size */
4997 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
5001 static int img_dd_bs(const char *arg,
5002 struct DdIo *in, struct DdIo *out,
5007 res = cvtnum_full("bs", arg, 1, INT_MAX);
5012 in->bsz = out->bsz = res;
5017 static int img_dd_count(const char *arg,
5018 struct DdIo *in, struct DdIo *out,
5021 dd->count = cvtnum("count", arg);
5023 if (dd->count < 0) {
5030 static int img_dd_if(const char *arg,
5031 struct DdIo *in, struct DdIo *out,
5034 in->filename = g_strdup(arg);
5039 static int img_dd_of(const char *arg,
5040 struct DdIo *in, struct DdIo *out,
5043 out->filename = g_strdup(arg);
5048 static int img_dd_skip(const char *arg,
5049 struct DdIo *in, struct DdIo *out,
5052 in->offset = cvtnum("skip", arg);
5054 if (in->offset < 0) {
5061 static int img_dd(int argc, char **argv)
5066 BlockDriver *drv = NULL, *proto_drv = NULL;
5067 BlockBackend *blk1 = NULL, *blk2 = NULL;
5068 QemuOpts *opts = NULL;
5069 QemuOptsList *create_opts = NULL;
5070 Error *local_err = NULL;
5071 bool image_opts = false;
5073 const char *out_fmt = "raw";
5074 const char *fmt = NULL;
5076 int64_t out_pos, in_pos;
5077 bool force_share = false;
5078 struct DdInfo dd = {
5083 .bsz = 512, /* Block size is by default 512 bytes */
5095 const struct DdOpts options[] = {
5096 { "bs", img_dd_bs, C_BS },
5097 { "count", img_dd_count, C_COUNT },
5098 { "if", img_dd_if, C_IF },
5099 { "of", img_dd_of, C_OF },
5100 { "skip", img_dd_skip, C_SKIP },
5103 const struct option long_options[] = {
5104 { "help", no_argument, 0, 'h'},
5105 { "object", required_argument, 0, OPTION_OBJECT},
5106 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5107 { "force-share", no_argument, 0, 'U'},
5111 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
5123 missing_argument(argv[optind - 1]);
5126 unrecognized_option(argv[optind - 1]);
5135 user_creatable_process_cmdline(optarg);
5137 case OPTION_IMAGE_OPTS:
5143 for (i = optind; i < argc; i++) {
5145 arg = g_strdup(argv[i]);
5147 tmp = strchr(arg, '=');
5149 error_report("unrecognized operand %s", arg);
5156 for (j = 0; options[j].name != NULL; j++) {
5157 if (!strcmp(arg, options[j].name)) {
5161 if (options[j].name == NULL) {
5162 error_report("unrecognized operand %s", arg);
5167 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5171 dd.flags |= options[j].flag;
5176 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5177 error_report("Must specify both input and output files");
5182 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5190 drv = bdrv_find_format(out_fmt);
5192 error_report("Unknown file format");
5196 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5199 error_report_err(local_err);
5203 if (!drv->create_opts) {
5204 error_report("Format driver '%s' does not support image creation",
5209 if (!proto_drv->create_opts) {
5210 error_report("Protocol driver '%s' does not support image creation",
5211 proto_drv->format_name);
5215 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5216 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5218 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5220 size = blk_getlength(blk1);
5222 error_report("Failed to get size for '%s'", in.filename);
5227 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5228 dd.count * in.bsz < size) {
5229 size = dd.count * in.bsz;
5232 /* Overflow means the specified offset is beyond input image's size */
5233 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5234 size < in.bsz * in.offset)) {
5235 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5237 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5238 size - in.bsz * in.offset, &error_abort);
5241 ret = bdrv_create(drv, out.filename, opts, &local_err);
5243 error_reportf_err(local_err,
5244 "%s: error while creating output image: ",
5250 /* TODO, we can't honour --image-opts for the target,
5251 * since it needs to be given in a format compatible
5252 * with the bdrv_create() call above which does not
5253 * support image-opts style.
5255 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
5256 false, false, false);
5263 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5264 size < in.offset * in.bsz)) {
5265 /* We give a warning if the skip option is bigger than the input
5266 * size and create an empty output disk image (i.e. like dd(1)).
5268 error_report("%s: cannot skip to specified offset", in.filename);
5271 in_pos = in.offset * in.bsz;
5274 in.buf = g_new(uint8_t, in.bsz);
5276 for (out_pos = 0; in_pos < size; ) {
5277 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz;
5279 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0);
5281 error_report("error while reading from input image file: %s",
5287 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0);
5289 error_report("error while writing to output image file: %s",
5298 qemu_opts_del(opts);
5299 qemu_opts_free(create_opts);
5302 g_free(in.filename);
5303 g_free(out.filename);
5313 static void dump_json_block_measure_info(BlockMeasureInfo *info)
5317 Visitor *v = qobject_output_visitor_new(&obj);
5319 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5320 visit_complete(v, &obj);
5321 str = qobject_to_json_pretty(obj, true);
5322 assert(str != NULL);
5323 printf("%s\n", str->str);
5326 g_string_free(str, true);
5329 static int img_measure(int argc, char **argv)
5331 static const struct option long_options[] = {
5332 {"help", no_argument, 0, 'h'},
5333 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5334 {"object", required_argument, 0, OPTION_OBJECT},
5335 {"output", required_argument, 0, OPTION_OUTPUT},
5336 {"size", required_argument, 0, OPTION_SIZE},
5337 {"force-share", no_argument, 0, 'U'},
5340 OutputFormat output_format = OFORMAT_HUMAN;
5341 BlockBackend *in_blk = NULL;
5343 const char *filename = NULL;
5344 const char *fmt = NULL;
5345 const char *out_fmt = "raw";
5346 char *options = NULL;
5347 char *snapshot_name = NULL;
5348 bool force_share = false;
5349 QemuOpts *opts = NULL;
5350 QemuOpts *object_opts = NULL;
5351 QemuOpts *sn_opts = NULL;
5352 QemuOptsList *create_opts = NULL;
5353 bool image_opts = false;
5354 uint64_t img_size = UINT64_MAX;
5355 BlockMeasureInfo *info = NULL;
5356 Error *local_err = NULL;
5360 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5361 long_options, NULL)) != -1) {
5374 if (accumulate_options(&options, optarg) < 0) {
5379 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5380 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5383 error_report("Failed in parsing snapshot param '%s'",
5388 snapshot_name = optarg;
5395 user_creatable_process_cmdline(optarg);
5397 case OPTION_IMAGE_OPTS:
5401 if (!strcmp(optarg, "json")) {
5402 output_format = OFORMAT_JSON;
5403 } else if (!strcmp(optarg, "human")) {
5404 output_format = OFORMAT_HUMAN;
5406 error_report("--output must be used with human or json "
5415 sval = cvtnum("image size", optarg);
5419 img_size = (uint64_t)sval;
5425 if (argc - optind > 1) {
5426 error_report("At most one filename argument is allowed.");
5428 } else if (argc - optind == 1) {
5429 filename = argv[optind];
5432 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5433 error_report("--image-opts, -f, and -l require a filename argument.");
5436 if (filename && img_size != UINT64_MAX) {
5437 error_report("--size N cannot be used together with a filename.");
5440 if (!filename && img_size == UINT64_MAX) {
5441 error_report("Either --size N or one filename must be specified.");
5446 in_blk = img_open(image_opts, filename, fmt, 0,
5447 false, false, force_share);
5453 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5454 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5455 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5457 } else if (snapshot_name != NULL) {
5458 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5459 snapshot_name, &local_err);
5462 error_reportf_err(local_err, "Failed to load snapshot: ");
5467 drv = bdrv_find_format(out_fmt);
5469 error_report("Unknown file format '%s'", out_fmt);
5472 if (!drv->create_opts) {
5473 error_report("Format driver '%s' does not support image creation",
5478 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5479 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5480 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5482 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
5483 error_report_err(local_err);
5484 error_report("Invalid options for file format '%s'", out_fmt);
5488 if (img_size != UINT64_MAX) {
5489 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5492 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5494 error_report_err(local_err);
5498 if (output_format == OFORMAT_HUMAN) {
5499 printf("required size: %" PRIu64 "\n", info->required);
5500 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
5501 if (info->has_bitmaps) {
5502 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5505 dump_json_block_measure_info(info);
5511 qapi_free_BlockMeasureInfo(info);
5512 qemu_opts_del(object_opts);
5513 qemu_opts_del(opts);
5514 qemu_opts_del(sn_opts);
5515 qemu_opts_free(create_opts);
5521 static const img_cmd_t img_cmds[] = {
5522 #define DEF(option, callback, arg_string) \
5523 { option, callback },
5524 #include "qemu-img-cmds.h"
5529 int main(int argc, char **argv)
5531 const img_cmd_t *cmd;
5532 const char *cmdname;
5534 static const struct option long_options[] = {
5535 {"help", no_argument, 0, 'h'},
5536 {"version", no_argument, 0, 'V'},
5537 {"trace", required_argument, NULL, 'T'},
5542 signal(SIGPIPE, SIG_IGN);
5546 error_init(argv[0]);
5547 module_call_init(MODULE_INIT_TRACE);
5548 qemu_init_exec_dir(argv[0]);
5550 qemu_init_main_loop(&error_fatal);
5552 qcrypto_init(&error_fatal);
5554 module_call_init(MODULE_INIT_QOM);
5557 error_exit("Not enough arguments");
5560 qemu_add_opts(&qemu_source_opts);
5561 qemu_add_opts(&qemu_trace_opts);
5563 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
5566 missing_argument(argv[optind - 1]);
5569 unrecognized_option(argv[optind - 1]);
5575 printf(QEMU_IMG_VERSION);
5578 trace_opt_parse(optarg);
5583 cmdname = argv[optind];
5585 /* reset getopt_long scanning */
5591 qemu_reset_optind();
5593 if (!trace_init_backends()) {
5597 qemu_set_log(LOG_TRACE, &error_fatal);
5599 /* find the command */
5600 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5601 if (!strcmp(cmdname, cmd->name)) {
5602 return cmd->handler(argc, argv);
5607 error_exit("Command not found: %s", cmdname);