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-common.h"
29 #include "qemu-version.h"
30 #include "qapi/error.h"
31 #include "qapi/qapi-commands-block-core.h"
32 #include "qapi/qapi-visit-block-core.h"
33 #include "qapi/qobject-output-visitor.h"
34 #include "qapi/qmp/qjson.h"
35 #include "qapi/qmp/qdict.h"
36 #include "qapi/qmp/qstring.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/units.h"
45 #include "qom/object_interfaces.h"
46 #include "sysemu/block-backend.h"
47 #include "block/block_int.h"
48 #include "block/blockjob.h"
49 #include "block/qapi.h"
50 #include "crypto/init.h"
51 #include "trace/control.h"
53 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
54 "\n" QEMU_COPYRIGHT "\n"
56 typedef struct img_cmd_t {
58 int (*handler)(int argc, char **argv);
63 OPTION_BACKING_CHAIN = 257,
65 OPTION_IMAGE_OPTS = 259,
67 OPTION_FLUSH_INTERVAL = 261,
68 OPTION_NO_DRAIN = 262,
69 OPTION_TARGET_IMAGE_OPTS = 263,
71 OPTION_PREALLOCATION = 265,
74 OPTION_TARGET_IS_ZERO = 268,
85 typedef enum OutputFormat {
90 /* Default to cache=writeback as data integrity is not important for qemu-img */
91 #define BDRV_DEFAULT_CACHE "writeback"
93 static void format_print(void *opaque, const char *name)
98 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
103 error_vreport(fmt, ap);
106 error_printf("Try 'qemu-img --help' for more information\n");
110 static void QEMU_NORETURN missing_argument(const char *option)
112 error_exit("missing argument for option '%s'", option);
115 static void QEMU_NORETURN unrecognized_option(const char *option)
117 error_exit("unrecognized option '%s'", option);
120 /* Please keep in synch with docs/tools/qemu-img.rst */
121 static void QEMU_NORETURN help(void)
123 const char *help_msg =
125 "usage: qemu-img [standard options] command [command options]\n"
126 "QEMU disk image utility\n"
128 " '-h', '--help' display this help and exit\n"
129 " '-V', '--version' output version information and exit\n"
130 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
131 " specify tracing options\n"
134 #define DEF(option, callback, arg_string) \
136 #include "qemu-img-cmds.h"
139 "Command parameters:\n"
140 " 'filename' is a disk image filename\n"
141 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
142 " manual page for a description of the object properties. The most common\n"
143 " object type is a 'secret', which is used to supply passwords and/or\n"
144 " encryption keys.\n"
145 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
146 " 'cache' is the cache mode used to write the output disk image, the valid\n"
147 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
148 " 'directsync' and 'unsafe' (default for convert)\n"
149 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
150 " options are the same as for the 'cache' option\n"
151 " 'size' is the disk image size in bytes. Optional suffixes\n"
152 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
153 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
154 " supported. 'b' is ignored.\n"
155 " 'output_filename' is the destination disk image filename\n"
156 " 'output_fmt' is the destination format\n"
157 " 'options' is a comma separated list of format specific options in a\n"
158 " name=value format. Use -o ? for an overview of the options supported by the\n"
160 " 'snapshot_param' is param used for internal snapshot, format\n"
161 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
163 " '-c' indicates that target image must be compressed (qcow format only)\n"
164 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
165 " new backing file match exactly. The image doesn't need a working\n"
166 " backing file before rebasing in this case (useful for renaming the\n"
167 " backing file). For image creation, allow creating without attempting\n"
168 " to open the backing file.\n"
169 " '-h' with or without a command shows this help and lists the supported formats\n"
170 " '-p' show progress of command (only certain commands)\n"
171 " '-q' use Quiet mode - do not print any output (except errors)\n"
172 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
173 " contain only zeros for qemu-img to create a sparse image during\n"
174 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
175 " unallocated or zero sectors, and the destination image will always be\n"
177 " '--output' takes the format in which the output must be done (human or json)\n"
178 " '-n' skips the target volume creation (useful if the volume is created\n"
179 " prior to running qemu-img)\n"
181 "Parameters to bitmap subcommand:\n"
182 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
183 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
184 " or '--merge source'\n"
185 " '-g granularity' sets the granularity for '--add' actions\n"
186 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
187 " bitmaps from an alternative file\n"
189 "Parameters to check subcommand:\n"
190 " '-r' tries to repair any inconsistencies that are found during the check.\n"
191 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
192 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
193 " hiding corruption that has already occurred.\n"
195 "Parameters to convert subcommand:\n"
196 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
197 " '-m' specifies how many coroutines work in parallel during the convert\n"
198 " process (defaults to 8)\n"
199 " '-W' allow to write to the target out of order rather than sequential\n"
201 "Parameters to snapshot subcommand:\n"
202 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
203 " '-a' applies a snapshot (revert disk to saved state)\n"
204 " '-c' creates a snapshot\n"
205 " '-d' deletes a snapshot\n"
206 " '-l' lists all snapshots in the given image\n"
208 "Parameters to compare subcommand:\n"
209 " '-f' first image format\n"
210 " '-F' second image format\n"
211 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
213 "Parameters to dd subcommand:\n"
214 " 'bs=BYTES' read and write up to BYTES bytes at a time "
216 " 'count=N' copy only N input blocks\n"
217 " 'if=FILE' read from FILE\n"
218 " 'of=FILE' write to FILE\n"
219 " 'skip=N' skip N bs-sized blocks at the start of input\n";
221 printf("%s\nSupported formats:", help_msg);
222 bdrv_iterate_format(format_print, NULL, false);
223 printf("\n\n" QEMU_HELP_BOTTOM "\n");
227 static QemuOptsList qemu_object_opts = {
229 .implied_opt_name = "qom-type",
230 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
236 static bool qemu_img_object_print_help(const char *type, QemuOpts *opts)
238 if (user_creatable_print_help(type, opts)) {
245 * Is @optarg safe for accumulate_options()?
246 * It is when multiple of them can be joined together separated by ','.
247 * To make that work, @optarg must not start with ',' (or else a
248 * separating ',' preceding it gets escaped), and it must not end with
249 * an odd number of ',' (or else a separating ',' following it gets
250 * escaped), or be empty (or else a separating ',' preceding it can
251 * escape a separating ',' following it).
254 static bool is_valid_option_list(const char *optarg)
256 size_t len = strlen(optarg);
259 if (!optarg[0] || optarg[0] == ',') {
263 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
272 static int accumulate_options(char **options, char *optarg)
276 if (!is_valid_option_list(optarg)) {
277 error_report("Invalid option list: %s", optarg);
282 *options = g_strdup(optarg);
284 new_options = g_strdup_printf("%s,%s", *options, optarg);
286 *options = new_options;
291 static QemuOptsList qemu_source_opts = {
293 .implied_opt_name = "file",
294 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
300 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
306 ret = vprintf(fmt, args);
313 static int print_block_option_help(const char *filename, const char *fmt)
315 BlockDriver *drv, *proto_drv;
316 QemuOptsList *create_opts = NULL;
317 Error *local_err = NULL;
319 /* Find driver and parse its options */
320 drv = bdrv_find_format(fmt);
322 error_report("Unknown file format '%s'", fmt);
326 if (!drv->create_opts) {
327 error_report("Format driver '%s' does not support image creation", fmt);
331 create_opts = qemu_opts_append(create_opts, drv->create_opts);
333 proto_drv = bdrv_find_protocol(filename, true, &local_err);
335 error_report_err(local_err);
336 qemu_opts_free(create_opts);
339 if (!proto_drv->create_opts) {
340 error_report("Protocol driver '%s' does not support image creation",
341 proto_drv->format_name);
342 qemu_opts_free(create_opts);
345 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
349 printf("Supported options:\n");
351 printf("Supported %s options:\n", fmt);
353 qemu_opts_print_help(create_opts, false);
354 qemu_opts_free(create_opts);
358 "The protocol level may support further options.\n"
359 "Specify the target filename to include those options.\n");
366 static BlockBackend *img_open_opts(const char *optstr,
367 QemuOpts *opts, int flags, bool writethrough,
368 bool quiet, bool force_share)
371 Error *local_err = NULL;
373 options = qemu_opts_to_qdict(opts, NULL);
375 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
376 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
377 error_report("--force-share/-U conflicts with image options");
378 qobject_unref(options);
381 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
383 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
385 error_reportf_err(local_err, "Could not open '%s': ", optstr);
388 blk_set_enable_write_cache(blk, !writethrough);
393 static BlockBackend *img_open_file(const char *filename,
395 const char *fmt, int flags,
396 bool writethrough, bool quiet,
400 Error *local_err = NULL;
403 options = qdict_new();
406 qdict_put_str(options, "driver", fmt);
410 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
412 blk = blk_new_open(filename, NULL, options, flags, &local_err);
414 error_reportf_err(local_err, "Could not open '%s': ", filename);
417 blk_set_enable_write_cache(blk, !writethrough);
423 static int img_add_key_secrets(void *opaque,
424 const char *name, const char *value,
427 QDict *options = opaque;
429 if (g_str_has_suffix(name, "key-secret")) {
430 qdict_put_str(options, name, value);
437 static BlockBackend *img_open(bool image_opts,
438 const char *filename,
439 const char *fmt, int flags, bool writethrough,
440 bool quiet, bool force_share)
446 error_report("--image-opts and --format are mutually exclusive");
449 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
454 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
457 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
464 static int add_old_style_options(const char *fmt, QemuOpts *opts,
465 const char *base_filename,
466 const char *base_fmt)
469 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
471 error_report("Backing file not supported for file format '%s'",
477 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
478 error_report("Backing file format not supported for file "
486 static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
492 err = qemu_strtosz(value, NULL, &res);
493 if (err < 0 && err != -ERANGE) {
494 error_report("Invalid %s specified. You may use "
495 "k, M, G, T, P or E suffixes for", name);
496 error_report("kilobytes, megabytes, gigabytes, terabytes, "
497 "petabytes and exabytes.");
500 if (err == -ERANGE || res > max || res < min) {
501 error_report("Invalid %s specified. Must be between %" PRId64
502 " and %" PRId64 ".", name, min, max);
508 static int64_t cvtnum(const char *name, const char *value)
510 return cvtnum_full(name, value, 0, INT64_MAX);
513 static int img_create(int argc, char **argv)
516 uint64_t img_size = -1;
517 const char *fmt = "raw";
518 const char *base_fmt = NULL;
519 const char *filename;
520 const char *base_filename = NULL;
521 char *options = NULL;
522 Error *local_err = NULL;
527 static const struct option long_options[] = {
528 {"help", no_argument, 0, 'h'},
529 {"object", required_argument, 0, OPTION_OBJECT},
532 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
539 missing_argument(argv[optind - 1]);
542 unrecognized_option(argv[optind - 1]);
551 base_filename = optarg;
557 if (accumulate_options(&options, optarg) < 0) {
565 flags |= BDRV_O_NO_BACKING;
567 case OPTION_OBJECT: {
569 opts = qemu_opts_parse_noisily(&qemu_object_opts,
578 /* Get the filename */
579 filename = (optind < argc) ? argv[optind] : NULL;
580 if (options && has_help_option(options)) {
582 return print_block_option_help(filename, fmt);
585 if (optind >= argc) {
586 error_exit("Expecting image file name");
590 if (qemu_opts_foreach(&qemu_object_opts,
591 user_creatable_add_opts_foreach,
592 qemu_img_object_print_help, &error_fatal)) {
596 /* Get image size, if specified */
600 sval = cvtnum("image size", argv[optind++]);
604 img_size = (uint64_t)sval;
606 if (optind != argc) {
607 error_exit("Unexpected argument: %s", argv[optind]);
610 bdrv_img_create(filename, fmt, base_filename, base_fmt,
611 options, img_size, flags, quiet, &local_err);
613 error_reportf_err(local_err, "%s: ", filename);
625 static void dump_json_image_check(ImageCheck *check, bool quiet)
629 Visitor *v = qobject_output_visitor_new(&obj);
631 visit_type_ImageCheck(v, NULL, &check, &error_abort);
632 visit_complete(v, &obj);
633 str = qobject_to_json_pretty(obj);
635 qprintf(quiet, "%s\n", qstring_get_str(str));
641 static void dump_human_image_check(ImageCheck *check, bool quiet)
643 if (!(check->corruptions || check->leaks || check->check_errors)) {
644 qprintf(quiet, "No errors were found on the image.\n");
646 if (check->corruptions) {
647 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
648 "Data may be corrupted, or further writes to the image "
655 "\n%" PRId64 " leaked clusters were found on the image.\n"
656 "This means waste of disk space, but no harm to data.\n",
660 if (check->check_errors) {
663 " internal errors have occurred during the check.\n",
664 check->check_errors);
668 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
669 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
670 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
671 check->allocated_clusters, check->total_clusters,
672 check->allocated_clusters * 100.0 / check->total_clusters,
673 check->fragmented_clusters * 100.0 / check->allocated_clusters,
674 check->compressed_clusters * 100.0 /
675 check->allocated_clusters);
678 if (check->image_end_offset) {
680 "Image end offset: %" PRId64 "\n", check->image_end_offset);
684 static int collect_image_check(BlockDriverState *bs,
686 const char *filename,
691 BdrvCheckResult result;
693 ret = bdrv_check(bs, &result, fix);
698 check->filename = g_strdup(filename);
699 check->format = g_strdup(bdrv_get_format_name(bs));
700 check->check_errors = result.check_errors;
701 check->corruptions = result.corruptions;
702 check->has_corruptions = result.corruptions != 0;
703 check->leaks = result.leaks;
704 check->has_leaks = result.leaks != 0;
705 check->corruptions_fixed = result.corruptions_fixed;
706 check->has_corruptions_fixed = result.corruptions_fixed != 0;
707 check->leaks_fixed = result.leaks_fixed;
708 check->has_leaks_fixed = result.leaks_fixed != 0;
709 check->image_end_offset = result.image_end_offset;
710 check->has_image_end_offset = result.image_end_offset != 0;
711 check->total_clusters = result.bfi.total_clusters;
712 check->has_total_clusters = result.bfi.total_clusters != 0;
713 check->allocated_clusters = result.bfi.allocated_clusters;
714 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
715 check->fragmented_clusters = result.bfi.fragmented_clusters;
716 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
717 check->compressed_clusters = result.bfi.compressed_clusters;
718 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
724 * Checks an image for consistency. Exit codes:
726 * 0 - Check completed, image is good
727 * 1 - Check not completed because of internal errors
728 * 2 - Check completed, image is corrupted
729 * 3 - Check completed, image has leaked clusters, but is good otherwise
730 * 63 - Checks are not supported by the image format
732 static int img_check(int argc, char **argv)
735 OutputFormat output_format = OFORMAT_HUMAN;
736 const char *filename, *fmt, *output, *cache;
738 BlockDriverState *bs;
740 int flags = BDRV_O_CHECK;
744 bool image_opts = false;
745 bool force_share = false;
749 cache = BDRV_DEFAULT_CACHE;
752 int option_index = 0;
753 static const struct option long_options[] = {
754 {"help", no_argument, 0, 'h'},
755 {"format", required_argument, 0, 'f'},
756 {"repair", required_argument, 0, 'r'},
757 {"output", required_argument, 0, OPTION_OUTPUT},
758 {"object", required_argument, 0, OPTION_OBJECT},
759 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
760 {"force-share", no_argument, 0, 'U'},
763 c = getopt_long(argc, argv, ":hf:r:T:qU",
764 long_options, &option_index);
770 missing_argument(argv[optind - 1]);
773 unrecognized_option(argv[optind - 1]);
782 flags |= BDRV_O_RDWR;
784 if (!strcmp(optarg, "leaks")) {
785 fix = BDRV_FIX_LEAKS;
786 } else if (!strcmp(optarg, "all")) {
787 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
789 error_exit("Unknown option value for -r "
790 "(expecting 'leaks' or 'all'): %s", optarg);
805 case OPTION_OBJECT: {
807 opts = qemu_opts_parse_noisily(&qemu_object_opts,
813 case OPTION_IMAGE_OPTS:
818 if (optind != argc - 1) {
819 error_exit("Expecting one image file name");
821 filename = argv[optind++];
823 if (output && !strcmp(output, "json")) {
824 output_format = OFORMAT_JSON;
825 } else if (output && !strcmp(output, "human")) {
826 output_format = OFORMAT_HUMAN;
828 error_report("--output must be used with human or json as argument.");
832 if (qemu_opts_foreach(&qemu_object_opts,
833 user_creatable_add_opts_foreach,
834 qemu_img_object_print_help, &error_fatal)) {
838 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
840 error_report("Invalid source cache option: %s", cache);
844 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
851 check = g_new0(ImageCheck, 1);
852 ret = collect_image_check(bs, check, filename, fmt, fix);
854 if (ret == -ENOTSUP) {
855 error_report("This image format does not support checks");
860 if (check->corruptions_fixed || check->leaks_fixed) {
861 int corruptions_fixed, leaks_fixed;
862 bool has_leaks_fixed, has_corruptions_fixed;
864 leaks_fixed = check->leaks_fixed;
865 has_leaks_fixed = check->has_leaks_fixed;
866 corruptions_fixed = check->corruptions_fixed;
867 has_corruptions_fixed = check->has_corruptions_fixed;
869 if (output_format == OFORMAT_HUMAN) {
871 "The following inconsistencies were found and repaired:\n\n"
872 " %" PRId64 " leaked clusters\n"
873 " %" PRId64 " corruptions\n\n"
874 "Double checking the fixed image now...\n",
876 check->corruptions_fixed);
879 qapi_free_ImageCheck(check);
880 check = g_new0(ImageCheck, 1);
881 ret = collect_image_check(bs, check, filename, fmt, 0);
883 check->leaks_fixed = leaks_fixed;
884 check->has_leaks_fixed = has_leaks_fixed;
885 check->corruptions_fixed = corruptions_fixed;
886 check->has_corruptions_fixed = has_corruptions_fixed;
890 switch (output_format) {
892 dump_human_image_check(check, quiet);
895 dump_json_image_check(check, quiet);
900 if (ret || check->check_errors) {
902 error_report("Check failed: %s", strerror(-ret));
904 error_report("Check failed");
910 if (check->corruptions) {
912 } else if (check->leaks) {
919 qapi_free_ImageCheck(check);
924 typedef struct CommonBlockJobCBInfo {
925 BlockDriverState *bs;
927 } CommonBlockJobCBInfo;
929 static void common_block_job_cb(void *opaque, int ret)
931 CommonBlockJobCBInfo *cbi = opaque;
934 error_setg_errno(cbi->errp, -ret, "Block job failed");
938 static void run_block_job(BlockJob *job, Error **errp)
940 AioContext *aio_context = blk_get_aio_context(job->blk);
943 aio_context_acquire(aio_context);
946 float progress = 0.0f;
947 aio_poll(aio_context, true);
948 if (job->job.progress.total) {
949 progress = (float)job->job.progress.current /
950 job->job.progress.total * 100.f;
952 qemu_progress_print(progress, 0);
953 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
955 if (!job_is_completed(&job->job)) {
956 ret = job_complete_sync(&job->job, errp);
960 job_unref(&job->job);
961 aio_context_release(aio_context);
963 /* publish completion progress only when success */
965 qemu_progress_print(100.f, 0);
969 static int img_commit(int argc, char **argv)
972 const char *filename, *fmt, *cache, *base;
974 BlockDriverState *bs, *base_bs;
976 bool progress = false, quiet = false, drop = false;
978 Error *local_err = NULL;
979 CommonBlockJobCBInfo cbi;
980 bool image_opts = false;
981 AioContext *aio_context;
984 cache = BDRV_DEFAULT_CACHE;
987 static const struct option long_options[] = {
988 {"help", no_argument, 0, 'h'},
989 {"object", required_argument, 0, OPTION_OBJECT},
990 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
993 c = getopt_long(argc, argv, ":f:ht:b:dpq",
1000 missing_argument(argv[optind - 1]);
1003 unrecognized_option(argv[optind - 1]);
1028 case OPTION_OBJECT: {
1030 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1036 case OPTION_IMAGE_OPTS:
1042 /* Progress is not shown in Quiet mode */
1047 if (optind != argc - 1) {
1048 error_exit("Expecting one image file name");
1050 filename = argv[optind++];
1052 if (qemu_opts_foreach(&qemu_object_opts,
1053 user_creatable_add_opts_foreach,
1054 qemu_img_object_print_help, &error_fatal)) {
1058 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
1059 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1061 error_report("Invalid cache option: %s", cache);
1065 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1072 qemu_progress_init(progress, 1.f);
1073 qemu_progress_print(0.f, 100);
1076 base_bs = bdrv_find_backing_image(bs, base);
1078 error_setg(&local_err,
1079 "Did not find '%s' in the backing chain of '%s'",
1084 /* This is different from QMP, which by default uses the deepest file in
1085 * the backing chain (i.e., the very base); however, the traditional
1086 * behavior of qemu-img commit is using the immediate backing file. */
1087 base_bs = backing_bs(bs);
1089 error_setg(&local_err, "Image does not have a backing file");
1094 cbi = (CommonBlockJobCBInfo){
1099 aio_context = bdrv_get_aio_context(bs);
1100 aio_context_acquire(aio_context);
1101 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
1102 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1103 &cbi, false, &local_err);
1104 aio_context_release(aio_context);
1109 /* When the block job completes, the BlockBackend reference will point to
1110 * the old backing file. In order to avoid that the top image is already
1111 * deleted, so we can still empty it afterwards, increment the reference
1112 * counter here preemptively. */
1117 job = block_job_get("commit");
1119 run_block_job(job, &local_err);
1125 BlockBackend *old_backing_blk;
1127 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1129 if (!old_backing_blk) {
1132 ret = blk_make_empty(old_backing_blk, &local_err);
1133 blk_unref(old_backing_blk);
1134 if (ret == -ENOTSUP) {
1135 error_free(local_err);
1137 } else if (ret < 0) {
1148 qemu_progress_end();
1153 error_report_err(local_err);
1157 qprintf(quiet, "Image committed.\n");
1162 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1163 * of the first sector boundary within buf where the sector contains a
1164 * non-zero byte. This function is robust to a buffer that is not
1167 static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1170 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1172 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1173 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1177 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1184 * Returns true iff the first sector pointed to by 'buf' contains at least
1187 * 'pnum' is set to the number of sectors (including and immediately following
1188 * the first one) that are known to be in the same allocated/unallocated state.
1189 * The function will try to align the end offset to alignment boundaries so
1190 * that the request will at least end aligned and consequtive requests will
1191 * also start at an aligned offset.
1193 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1194 int64_t sector_num, int alignment)
1203 is_zero = buffer_is_zero(buf, 512);
1204 for(i = 1; i < n; i++) {
1206 if (is_zero != buffer_is_zero(buf, 512)) {
1211 tail = (sector_num + i) & (alignment - 1);
1213 if (is_zero && i <= tail) {
1214 /* treat unallocated areas which only consist
1215 * of a small tail as allocated. */
1219 /* align up end offset of allocated areas. */
1220 i += alignment - tail;
1223 /* align down end offset of zero areas. */
1232 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1233 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1234 * breaking up write requests for only small sparse areas.
1236 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1237 int min, int64_t sector_num, int alignment)
1240 int num_checked, num_used;
1246 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1252 buf += BDRV_SECTOR_SIZE * *pnum;
1254 sector_num += *pnum;
1255 num_checked = num_used;
1258 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1260 buf += BDRV_SECTOR_SIZE * *pnum;
1262 sector_num += *pnum;
1263 num_checked += *pnum;
1265 num_used = num_checked;
1266 } else if (*pnum >= min) {
1276 * Compares two buffers sector by sector. Returns 0 if the first
1277 * sector of each buffer matches, non-zero otherwise.
1279 * pnum is set to the sector-aligned size of the buffer prefix that
1280 * has the same matching status as the first sector.
1282 static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1283 int64_t bytes, int64_t *pnum)
1286 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
1290 res = !!memcmp(buf1, buf2, i);
1292 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
1294 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
1304 #define IO_BUF_SIZE (2 * MiB)
1307 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1309 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1310 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1311 * failure), and 4 on error (the exit status for read errors), after emitting
1314 * @param blk: BlockBackend for the image
1315 * @param offset: Starting offset to check
1316 * @param bytes: Number of bytes to check
1317 * @param filename: Name of disk file we are checking (logging purpose)
1318 * @param buffer: Allocated buffer for storing read data
1319 * @param quiet: Flag for quiet mode
1321 static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1322 int64_t bytes, const char *filename,
1323 uint8_t *buffer, bool quiet)
1328 ret = blk_pread(blk, offset, buffer, bytes);
1330 error_report("Error while reading offset %" PRId64 " of %s: %s",
1331 offset, filename, strerror(-ret));
1334 idx = find_nonzero(buffer, bytes);
1336 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1345 * Compares two images. Exit codes:
1347 * 0 - Images are identical
1349 * >1 - Error occurred
1351 static int img_compare(int argc, char **argv)
1353 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1354 BlockBackend *blk1, *blk2;
1355 BlockDriverState *bs1, *bs2;
1356 int64_t total_size1, total_size2;
1357 uint8_t *buf1 = NULL, *buf2 = NULL;
1358 int64_t pnum1, pnum2;
1359 int allocated1, allocated2;
1360 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1361 bool progress = false, quiet = false, strict = false;
1368 uint64_t progress_base;
1369 bool image_opts = false;
1370 bool force_share = false;
1372 cache = BDRV_DEFAULT_CACHE;
1374 static const struct option long_options[] = {
1375 {"help", no_argument, 0, 'h'},
1376 {"object", required_argument, 0, OPTION_OBJECT},
1377 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1378 {"force-share", no_argument, 0, 'U'},
1381 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1382 long_options, NULL);
1388 missing_argument(argv[optind - 1]);
1391 unrecognized_option(argv[optind - 1]);
1417 case OPTION_OBJECT: {
1419 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1426 case OPTION_IMAGE_OPTS:
1432 /* Progress is not shown in Quiet mode */
1438 if (optind != argc - 2) {
1439 error_exit("Expecting two image file names");
1441 filename1 = argv[optind++];
1442 filename2 = argv[optind++];
1444 if (qemu_opts_foreach(&qemu_object_opts,
1445 user_creatable_add_opts_foreach,
1446 qemu_img_object_print_help, &error_fatal)) {
1451 /* Initialize before goto out */
1452 qemu_progress_init(progress, 2.0);
1455 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1457 error_report("Invalid source cache option: %s", cache);
1462 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1469 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1478 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1479 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1480 total_size1 = blk_getlength(blk1);
1481 if (total_size1 < 0) {
1482 error_report("Can't get size of %s: %s",
1483 filename1, strerror(-total_size1));
1487 total_size2 = blk_getlength(blk2);
1488 if (total_size2 < 0) {
1489 error_report("Can't get size of %s: %s",
1490 filename2, strerror(-total_size2));
1494 total_size = MIN(total_size1, total_size2);
1495 progress_base = MAX(total_size1, total_size2);
1497 qemu_progress_print(0, 100);
1499 if (strict && total_size1 != total_size2) {
1501 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1505 while (offset < total_size) {
1506 int status1, status2;
1508 status1 = bdrv_block_status_above(bs1, NULL, offset,
1509 total_size1 - offset, &pnum1, NULL,
1513 error_report("Sector allocation test failed for %s", filename1);
1516 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1518 status2 = bdrv_block_status_above(bs2, NULL, offset,
1519 total_size2 - offset, &pnum2, NULL,
1523 error_report("Sector allocation test failed for %s", filename2);
1526 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1528 assert(pnum1 && pnum2);
1529 chunk = MIN(pnum1, pnum2);
1532 if (status1 != status2) {
1534 qprintf(quiet, "Strict mode: Offset %" PRId64
1535 " block status mismatch!\n", offset);
1539 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1541 } else if (allocated1 == allocated2) {
1545 chunk = MIN(chunk, IO_BUF_SIZE);
1546 ret = blk_pread(blk1, offset, buf1, chunk);
1548 error_report("Error while reading offset %" PRId64
1550 offset, filename1, strerror(-ret));
1554 ret = blk_pread(blk2, offset, buf2, chunk);
1556 error_report("Error while reading offset %" PRId64
1558 offset, filename2, strerror(-ret));
1562 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1563 if (ret || pnum != chunk) {
1564 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1565 offset + (ret ? 0 : pnum));
1571 chunk = MIN(chunk, IO_BUF_SIZE);
1573 ret = check_empty_sectors(blk1, offset, chunk,
1574 filename1, buf1, quiet);
1576 ret = check_empty_sectors(blk2, offset, chunk,
1577 filename2, buf1, quiet);
1584 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1587 if (total_size1 != total_size2) {
1588 BlockBackend *blk_over;
1589 const char *filename_over;
1591 qprintf(quiet, "Warning: Image size mismatch!\n");
1592 if (total_size1 > total_size2) {
1594 filename_over = filename1;
1597 filename_over = filename2;
1600 while (offset < progress_base) {
1601 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1602 progress_base - offset, &chunk,
1606 error_report("Sector allocation test failed for %s",
1611 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1612 chunk = MIN(chunk, IO_BUF_SIZE);
1613 ret = check_empty_sectors(blk_over, offset, chunk,
1614 filename_over, buf1, quiet);
1620 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1624 qprintf(quiet, "Images are identical.\n");
1634 qemu_progress_end();
1639 /* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1640 static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1641 const char *src_node, const char *src_name,
1644 BlockDirtyBitmapMergeSource *merge_src;
1645 BlockDirtyBitmapMergeSourceList *list;
1647 merge_src = g_new0(BlockDirtyBitmapMergeSource, 1);
1648 merge_src->type = QTYPE_QDICT;
1649 merge_src->u.external.node = g_strdup(src_node);
1650 merge_src->u.external.name = g_strdup(src_name);
1651 list = g_new0(BlockDirtyBitmapMergeSourceList, 1);
1652 list->value = merge_src;
1653 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1654 qapi_free_BlockDirtyBitmapMergeSourceList(list);
1657 enum ImgConvertBlockStatus {
1663 #define MAX_COROUTINES 16
1665 typedef struct ImgConvertState {
1667 int64_t *src_sectors;
1669 int64_t total_sectors;
1670 int64_t allocated_sectors;
1671 int64_t allocated_done;
1674 enum ImgConvertBlockStatus status;
1675 int64_t sector_next_status;
1676 BlockBackend *target;
1680 bool target_has_backing;
1681 int64_t target_backing_sectors; /* negative if unknown */
1688 size_t cluster_sectors;
1690 long num_coroutines;
1691 int running_coroutines;
1692 Coroutine *co[MAX_COROUTINES];
1693 int64_t wait_sector_num[MAX_COROUTINES];
1698 static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1699 int *src_cur, int64_t *src_cur_offset)
1702 *src_cur_offset = 0;
1703 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1704 *src_cur_offset += s->src_sectors[*src_cur];
1706 assert(*src_cur < s->src_num);
1710 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1712 int64_t src_cur_offset;
1713 int ret, n, src_cur;
1714 bool post_backing_zero = false;
1716 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1718 assert(s->total_sectors > sector_num);
1719 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1721 if (s->target_backing_sectors >= 0) {
1722 if (sector_num >= s->target_backing_sectors) {
1723 post_backing_zero = true;
1724 } else if (sector_num + n > s->target_backing_sectors) {
1725 /* Split requests around target_backing_sectors (because
1726 * starting from there, zeros are handled differently) */
1727 n = s->target_backing_sectors - sector_num;
1731 if (s->sector_next_status <= sector_num) {
1732 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1736 count = n * BDRV_SECTOR_SIZE;
1738 if (s->target_has_backing) {
1739 ret = bdrv_block_status(blk_bs(s->src[src_cur]), offset,
1740 count, &count, NULL, NULL);
1742 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1743 offset, count, &count, NULL,
1751 warn_report("error while reading block status at "
1752 "offset %" PRIu64 ": %s", offset,
1755 /* Just try to read the data, then */
1756 ret = BDRV_BLOCK_DATA;
1757 count = BDRV_SECTOR_SIZE;
1759 /* Retry on a shorter range */
1760 n = DIV_ROUND_UP(n, 4);
1763 error_report("error while reading block status at offset "
1764 "%" PRIu64 ": %s", offset, strerror(-ret));
1770 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1772 if (ret & BDRV_BLOCK_ZERO) {
1773 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1774 } else if (ret & BDRV_BLOCK_DATA) {
1775 s->status = BLK_DATA;
1777 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1780 s->sector_next_status = sector_num + n;
1783 n = MIN(n, s->sector_next_status - sector_num);
1784 if (s->status == BLK_DATA) {
1785 n = MIN(n, s->buf_sectors);
1788 /* We need to write complete clusters for compressed images, so if an
1789 * unallocated area is shorter than that, we must consider the whole
1790 * cluster allocated. */
1791 if (s->compressed) {
1792 if (n < s->cluster_sectors) {
1793 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1794 s->status = BLK_DATA;
1796 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1803 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1804 int nb_sectors, uint8_t *buf)
1806 uint64_t single_read_until = 0;
1809 assert(nb_sectors <= s->buf_sectors);
1810 while (nb_sectors > 0) {
1813 int64_t bs_sectors, src_cur_offset;
1816 /* In the case of compression with multiple source files, we can get a
1817 * nb_sectors that spreads into the next part. So we must be able to
1818 * read across multiple BDSes for one convert_read() call. */
1819 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1820 blk = s->src[src_cur];
1821 bs_sectors = s->src_sectors[src_cur];
1823 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1825 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1826 if (single_read_until > offset) {
1830 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
1834 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1838 warn_report("error while reading offset %" PRIu64
1839 ": %s", offset, strerror(-ret));
1841 memset(buf, 0, BDRV_SECTOR_SIZE);
1850 buf += n * BDRV_SECTOR_SIZE;
1857 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1858 int nb_sectors, uint8_t *buf,
1859 enum ImgConvertBlockStatus status)
1863 while (nb_sectors > 0) {
1865 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1868 case BLK_BACKING_FILE:
1869 /* If we have a backing file, leave clusters unallocated that are
1870 * unallocated in the source image, so that the backing file is
1871 * visible at the respective offset. */
1872 assert(s->target_has_backing);
1876 /* If we're told to keep the target fully allocated (-S 0) or there
1877 * is real non-zero data, we must write it. Otherwise we can treat
1878 * it as zero sectors.
1879 * Compressed clusters need to be written as a whole, so in that
1880 * case we can only save the write if the buffer is completely
1882 if (!s->min_sparse ||
1884 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1885 sector_num, s->alignment)) ||
1887 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1889 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1890 n << BDRV_SECTOR_BITS, buf, flags);
1899 if (s->has_zero_init) {
1900 assert(!s->target_has_backing);
1903 ret = blk_co_pwrite_zeroes(s->target,
1904 sector_num << BDRV_SECTOR_BITS,
1905 n << BDRV_SECTOR_BITS,
1906 BDRV_REQ_MAY_UNMAP);
1915 buf += n * BDRV_SECTOR_SIZE;
1921 static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1926 while (nb_sectors > 0) {
1929 int64_t bs_sectors, src_cur_offset;
1932 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1933 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1934 blk = s->src[src_cur];
1935 bs_sectors = s->src_sectors[src_cur];
1937 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1939 ret = blk_co_copy_range(blk, offset, s->target,
1940 sector_num << BDRV_SECTOR_BITS,
1941 n << BDRV_SECTOR_BITS, 0, 0);
1952 static void coroutine_fn convert_co_do_copy(void *opaque)
1954 ImgConvertState *s = opaque;
1955 uint8_t *buf = NULL;
1959 for (i = 0; i < s->num_coroutines; i++) {
1960 if (s->co[i] == qemu_coroutine_self()) {
1967 s->running_coroutines++;
1968 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1973 enum ImgConvertBlockStatus status;
1976 qemu_co_mutex_lock(&s->lock);
1977 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1978 qemu_co_mutex_unlock(&s->lock);
1981 n = convert_iteration_sectors(s, s->sector_num);
1983 qemu_co_mutex_unlock(&s->lock);
1987 /* save current sector and allocation status to local variables */
1988 sector_num = s->sector_num;
1990 if (!s->min_sparse && s->status == BLK_ZERO) {
1991 n = MIN(n, s->buf_sectors);
1993 /* increment global sector counter so that other coroutines can
1994 * already continue reading beyond this request */
1996 qemu_co_mutex_unlock(&s->lock);
1998 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1999 s->allocated_done += n;
2000 qemu_progress_print(100.0 * s->allocated_done /
2001 s->allocated_sectors, 0);
2005 copy_range = s->copy_range && s->status == BLK_DATA;
2006 if (status == BLK_DATA && !copy_range) {
2007 ret = convert_co_read(s, sector_num, n, buf);
2009 error_report("error while reading at byte %lld: %s",
2010 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2013 } else if (!s->min_sparse && status == BLK_ZERO) {
2015 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2018 if (s->wr_in_order) {
2019 /* keep writes in order */
2020 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
2021 s->wait_sector_num[index] = sector_num;
2022 qemu_coroutine_yield();
2024 s->wait_sector_num[index] = -1;
2027 if (s->ret == -EINPROGRESS) {
2029 ret = convert_co_copy_range(s, sector_num, n);
2031 s->copy_range = false;
2035 ret = convert_co_write(s, sector_num, n, buf, status);
2038 error_report("error while writing at byte %lld: %s",
2039 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2044 if (s->wr_in_order) {
2045 /* reenter the coroutine that might have waited
2046 * for this write to complete */
2047 s->wr_offs = sector_num + n;
2048 for (i = 0; i < s->num_coroutines; i++) {
2049 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2051 * A -> B -> A cannot occur because A has
2052 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2053 * B will never enter A during this time window.
2055 qemu_coroutine_enter(s->co[i]);
2063 s->co[index] = NULL;
2064 s->running_coroutines--;
2065 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2066 /* the convert job finished successfully */
2071 static int convert_do_copy(ImgConvertState *s)
2074 int64_t sector_num = 0;
2076 /* Check whether we have zero initialisation or can get it efficiently */
2077 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2078 !s->target_has_backing) {
2079 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
2082 /* Allocate buffer for copied data. For compressed images, only one cluster
2083 * can be copied at a time. */
2084 if (s->compressed) {
2085 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2086 error_report("invalid cluster size");
2089 s->buf_sectors = s->cluster_sectors;
2092 while (sector_num < s->total_sectors) {
2093 n = convert_iteration_sectors(s, sector_num);
2097 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2099 s->allocated_sectors += n;
2105 s->sector_next_status = 0;
2106 s->ret = -EINPROGRESS;
2108 qemu_co_mutex_init(&s->lock);
2109 for (i = 0; i < s->num_coroutines; i++) {
2110 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2111 s->wait_sector_num[i] = -1;
2112 qemu_coroutine_enter(s->co[i]);
2115 while (s->running_coroutines) {
2116 main_loop_wait(false);
2119 if (s->compressed && !s->ret) {
2120 /* signal EOF to align */
2121 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
2130 static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst)
2132 BdrvDirtyBitmap *bm;
2135 FOR_EACH_DIRTY_BITMAP(src, bm) {
2138 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2141 name = bdrv_dirty_bitmap_name(bm);
2142 qmp_block_dirty_bitmap_add(dst->node_name, name,
2143 true, bdrv_dirty_bitmap_granularity(bm),
2145 true, !bdrv_dirty_bitmap_enabled(bm),
2148 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2152 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2155 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
2163 #define MAX_BUF_SECTORS 32768
2165 static int img_convert(int argc, char **argv)
2167 int c, bs_i, flags, src_flags = 0;
2168 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
2169 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2170 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
2171 BlockDriver *drv = NULL, *proto_drv = NULL;
2172 BlockDriverInfo bdi;
2173 BlockDriverState *out_bs;
2174 QemuOpts *opts = NULL, *sn_opts = NULL;
2175 QemuOptsList *create_opts = NULL;
2176 QDict *open_opts = NULL;
2177 char *options = NULL;
2178 Error *local_err = NULL;
2179 bool writethrough, src_writethrough, image_opts = false,
2180 skip_create = false, progress = false, tgt_image_opts = false;
2181 int64_t ret = -EINVAL;
2182 bool force_share = false;
2183 bool explict_min_sparse = false;
2184 bool bitmaps = false;
2186 ImgConvertState s = (ImgConvertState) {
2187 /* Need at least 4k of zeros for sparse detection */
2189 .copy_range = false,
2190 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2191 .wr_in_order = true,
2192 .num_coroutines = 8,
2196 static const struct option long_options[] = {
2197 {"help", no_argument, 0, 'h'},
2198 {"object", required_argument, 0, OPTION_OBJECT},
2199 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2200 {"force-share", no_argument, 0, 'U'},
2201 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2202 {"salvage", no_argument, 0, OPTION_SALVAGE},
2203 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
2204 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
2207 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
2208 long_options, NULL);
2214 missing_argument(argv[optind - 1]);
2217 unrecognized_option(argv[optind - 1]);
2229 out_baseimg = optarg;
2232 s.copy_range = true;
2235 s.compressed = true;
2238 if (accumulate_options(&options, optarg) < 0) {
2243 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2244 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2247 error_report("Failed in parsing snapshot param '%s'",
2252 snapshot_name = optarg;
2259 sval = cvtnum("buffer size for sparse output", optarg);
2262 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
2263 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2264 error_report("Invalid buffer size for sparse output specified. "
2265 "Valid sizes are multiples of %llu up to %llu. Select "
2266 "0 to disable sparse detection (fully allocates output).",
2267 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2271 s.min_sparse = sval / BDRV_SECTOR_SIZE;
2272 explict_min_sparse = true;
2291 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2292 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2293 error_report("Invalid number of coroutines. Allowed number of"
2294 " coroutines is between 1 and %d", MAX_COROUTINES);
2299 s.wr_in_order = false;
2304 case OPTION_OBJECT: {
2305 QemuOpts *object_opts;
2306 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2313 case OPTION_IMAGE_OPTS:
2316 case OPTION_SALVAGE:
2319 case OPTION_TARGET_IMAGE_OPTS:
2320 tgt_image_opts = true;
2322 case OPTION_TARGET_IS_ZERO:
2324 * The user asserting that the target is blank has the
2325 * same effect as the target driver supporting zero
2328 s.has_zero_init = true;
2330 case OPTION_BITMAPS:
2336 if (!out_fmt && !tgt_image_opts) {
2340 if (qemu_opts_foreach(&qemu_object_opts,
2341 user_creatable_add_opts_foreach,
2342 qemu_img_object_print_help, &error_fatal)) {
2346 if (s.compressed && s.copy_range) {
2347 error_report("Cannot enable copy offloading when -c is used");
2351 if (explict_min_sparse && s.copy_range) {
2352 error_report("Cannot enable copy offloading when -S is used");
2356 if (s.copy_range && s.salvage) {
2357 error_report("Cannot use copy offloading in salvaging mode");
2361 if (tgt_image_opts && !skip_create) {
2362 error_report("--target-image-opts requires use of -n flag");
2366 if (skip_create && options) {
2367 error_report("-o has no effect when skipping image creation");
2371 if (s.has_zero_init && !skip_create) {
2372 error_report("--target-is-zero requires use of -n flag");
2376 s.src_num = argc - optind - 1;
2377 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2379 if (options && has_help_option(options)) {
2381 ret = print_block_option_help(out_filename, out_fmt);
2384 error_report("Option help requires a format be specified");
2389 if (s.src_num < 1) {
2390 error_report("Must specify image file name");
2394 /* ret is still -EINVAL until here */
2395 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2397 error_report("Invalid source cache option: %s", src_cache);
2401 /* Initialize before goto out */
2405 qemu_progress_init(progress, 1.0);
2406 qemu_progress_print(0, 100);
2408 s.src = g_new0(BlockBackend *, s.src_num);
2409 s.src_sectors = g_new(int64_t, s.src_num);
2411 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2412 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2413 fmt, src_flags, src_writethrough, s.quiet,
2419 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2420 if (s.src_sectors[bs_i] < 0) {
2421 error_report("Could not get size of %s: %s",
2422 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2426 s.total_sectors += s.src_sectors[bs_i];
2430 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2431 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2432 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2434 } else if (snapshot_name != NULL) {
2435 if (s.src_num > 1) {
2436 error_report("No support for concatenating multiple snapshot");
2441 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2445 error_reportf_err(local_err, "Failed to load snapshot: ");
2451 /* Find driver and parse its options */
2452 drv = bdrv_find_format(out_fmt);
2454 error_report("Unknown file format '%s'", out_fmt);
2459 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2461 error_report_err(local_err);
2466 if (!drv->create_opts) {
2467 error_report("Format driver '%s' does not support image creation",
2473 if (!proto_drv->create_opts) {
2474 error_report("Protocol driver '%s' does not support image creation",
2475 proto_drv->format_name);
2480 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2481 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2483 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2485 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
2486 error_report_err(local_err);
2492 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2494 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2500 /* Get backing file name if -o backing_file was used */
2501 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2502 if (out_baseimg_param) {
2503 out_baseimg = out_baseimg_param;
2505 s.target_has_backing = (bool) out_baseimg;
2507 if (s.has_zero_init && s.target_has_backing) {
2508 error_report("Cannot use --target-is-zero when the destination "
2509 "image has a backing file");
2513 if (s.src_num > 1 && out_baseimg) {
2514 error_report("Having a backing file for the target makes no sense when "
2515 "concatenating multiple input images");
2520 if (out_baseimg_param) {
2521 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
2522 warn_report("Deprecated use of backing file without explicit "
2527 /* Check if compression is supported */
2530 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2531 const char *encryptfmt =
2532 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2533 const char *preallocation =
2534 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2536 if (drv && !block_driver_can_compress(drv)) {
2537 error_report("Compression not supported for this file format");
2542 if (encryption || encryptfmt) {
2543 error_report("Compression and encryption not supported at "
2550 && strcmp(preallocation, "off"))
2552 error_report("Compression and preallocation not supported at "
2559 /* Determine if bitmaps need copying */
2561 if (s.src_num > 1) {
2562 error_report("Copying bitmaps only possible with single source");
2566 if (!bdrv_supports_persistent_dirty_bitmap(blk_bs(s.src[0]))) {
2567 error_report("Source lacks bitmap support");
2574 * The later open call will need any decryption secrets, and
2575 * bdrv_create() will purge "opts", so extract them now before
2579 open_opts = qdict_new();
2580 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2582 /* Create the new image */
2583 ret = bdrv_create(drv, out_filename, opts, &local_err);
2585 error_reportf_err(local_err, "%s: error while converting %s: ",
2586 out_filename, out_fmt);
2591 s.target_is_new = !skip_create;
2593 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2594 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2596 error_report("Invalid cache option: %s", cache);
2601 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
2602 flags, writethrough, s.quiet, false);
2604 /* TODO ultimately we should allow --target-image-opts
2605 * to be used even when -n is not given.
2606 * That has to wait for bdrv_create to be improved
2607 * to allow filenames in option syntax
2609 s.target = img_open_file(out_filename, open_opts, out_fmt,
2610 flags, writethrough, s.quiet, false);
2611 open_opts = NULL; /* blk_new_open will have freed it */
2617 out_bs = blk_bs(s.target);
2619 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2620 error_report("Format driver '%s' does not support bitmaps",
2621 out_bs->drv->format_name);
2626 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
2627 error_report("Compression not supported for this file format");
2632 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2633 * or discard_alignment of the out_bs is greater. Limit to
2634 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2635 s.buf_sectors = MIN(MAX_BUF_SECTORS,
2637 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2638 out_bs->bl.pdiscard_alignment >>
2639 BDRV_SECTOR_BITS)));
2641 /* try to align the write requests to the destination to avoid unnecessary
2643 s.alignment = MAX(pow2floor(s.min_sparse),
2644 DIV_ROUND_UP(out_bs->bl.request_alignment,
2646 assert(is_power_of_2(s.alignment));
2649 int64_t output_sectors = blk_nb_sectors(s.target);
2650 if (output_sectors < 0) {
2651 error_report("unable to get output image length: %s",
2652 strerror(-output_sectors));
2655 } else if (output_sectors < s.total_sectors) {
2656 error_report("output file is smaller than input file");
2662 if (s.target_has_backing && s.target_is_new) {
2663 /* Errors are treated as "backing length unknown" (which means
2664 * s.target_backing_sectors has to be negative, which it will
2665 * be automatically). The backing file length is used only
2666 * for optimizations, so such a case is not fatal. */
2667 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2669 s.target_backing_sectors = -1;
2672 ret = bdrv_get_info(out_bs, &bdi);
2675 error_report("could not get block driver info");
2679 s.compressed = s.compressed || bdi.needs_compressed_writes;
2680 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2683 ret = convert_do_copy(&s);
2685 /* Now copy the bitmaps */
2686 if (bitmaps && ret == 0) {
2687 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs);
2692 qemu_progress_print(100, 0);
2694 qemu_progress_end();
2695 qemu_opts_del(opts);
2696 qemu_opts_free(create_opts);
2697 qemu_opts_del(sn_opts);
2698 qobject_unref(open_opts);
2699 blk_unref(s.target);
2701 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2702 blk_unref(s.src[bs_i]);
2706 g_free(s.src_sectors);
2714 static void dump_snapshots(BlockDriverState *bs)
2716 QEMUSnapshotInfo *sn_tab, *sn;
2719 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2722 printf("Snapshot list:\n");
2723 bdrv_snapshot_dump(NULL);
2725 for(i = 0; i < nb_sns; i++) {
2727 bdrv_snapshot_dump(sn);
2733 static void dump_json_image_info_list(ImageInfoList *list)
2737 Visitor *v = qobject_output_visitor_new(&obj);
2739 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2740 visit_complete(v, &obj);
2741 str = qobject_to_json_pretty(obj);
2742 assert(str != NULL);
2743 printf("%s\n", qstring_get_str(str));
2749 static void dump_json_image_info(ImageInfo *info)
2753 Visitor *v = qobject_output_visitor_new(&obj);
2755 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2756 visit_complete(v, &obj);
2757 str = qobject_to_json_pretty(obj);
2758 assert(str != NULL);
2759 printf("%s\n", qstring_get_str(str));
2765 static void dump_human_image_info_list(ImageInfoList *list)
2767 ImageInfoList *elem;
2770 for (elem = list; elem; elem = elem->next) {
2776 bdrv_image_info_dump(elem->value);
2780 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2782 return strcmp(a, b) == 0;
2786 * Open an image file chain and return an ImageInfoList
2788 * @filename: topmost image filename
2789 * @fmt: topmost image format (may be NULL to autodetect)
2790 * @chain: true - enumerate entire backing file chain
2791 * false - only topmost image file
2793 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2794 * image file. If there was an error a message will have been printed to
2797 static ImageInfoList *collect_image_info_list(bool image_opts,
2798 const char *filename,
2800 bool chain, bool force_share)
2802 ImageInfoList *head = NULL;
2803 ImageInfoList **last = &head;
2804 GHashTable *filenames;
2807 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2811 BlockDriverState *bs;
2813 ImageInfoList *elem;
2815 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2816 error_report("Backing file '%s' creates an infinite loop.",
2820 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2822 blk = img_open(image_opts, filename, fmt,
2823 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2830 bdrv_query_image_info(bs, &info, &err);
2832 error_report_err(err);
2837 elem = g_new0(ImageInfoList, 1);
2844 /* Clear parameters that only apply to the topmost image */
2845 filename = fmt = NULL;
2849 if (info->has_full_backing_filename) {
2850 filename = info->full_backing_filename;
2851 } else if (info->has_backing_filename) {
2852 error_report("Could not determine absolute backing filename,"
2853 " but backing filename '%s' present",
2854 info->backing_filename);
2857 if (info->has_backing_filename_format) {
2858 fmt = info->backing_filename_format;
2862 g_hash_table_destroy(filenames);
2866 qapi_free_ImageInfoList(head);
2867 g_hash_table_destroy(filenames);
2871 static int img_info(int argc, char **argv)
2874 OutputFormat output_format = OFORMAT_HUMAN;
2876 const char *filename, *fmt, *output;
2877 ImageInfoList *list;
2878 bool image_opts = false;
2879 bool force_share = false;
2884 int option_index = 0;
2885 static const struct option long_options[] = {
2886 {"help", no_argument, 0, 'h'},
2887 {"format", required_argument, 0, 'f'},
2888 {"output", required_argument, 0, OPTION_OUTPUT},
2889 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2890 {"object", required_argument, 0, OPTION_OBJECT},
2891 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2892 {"force-share", no_argument, 0, 'U'},
2895 c = getopt_long(argc, argv, ":f:hU",
2896 long_options, &option_index);
2902 missing_argument(argv[optind - 1]);
2905 unrecognized_option(argv[optind - 1]);
2919 case OPTION_BACKING_CHAIN:
2922 case OPTION_OBJECT: {
2924 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2930 case OPTION_IMAGE_OPTS:
2935 if (optind != argc - 1) {
2936 error_exit("Expecting one image file name");
2938 filename = argv[optind++];
2940 if (output && !strcmp(output, "json")) {
2941 output_format = OFORMAT_JSON;
2942 } else if (output && !strcmp(output, "human")) {
2943 output_format = OFORMAT_HUMAN;
2944 } else if (output) {
2945 error_report("--output must be used with human or json as argument.");
2949 if (qemu_opts_foreach(&qemu_object_opts,
2950 user_creatable_add_opts_foreach,
2951 qemu_img_object_print_help, &error_fatal)) {
2955 list = collect_image_info_list(image_opts, filename, fmt, chain,
2961 switch (output_format) {
2963 dump_human_image_info_list(list);
2967 dump_json_image_info_list(list);
2969 dump_json_image_info(list->value);
2974 qapi_free_ImageInfoList(list);
2978 static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2981 switch (output_format) {
2983 if (e->data && !e->has_offset) {
2984 error_report("File contains external, encrypted or compressed clusters.");
2987 if (e->data && !e->zero) {
2988 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2989 e->start, e->length,
2990 e->has_offset ? e->offset : 0,
2991 e->has_filename ? e->filename : "");
2993 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2994 * Modify the flags here to allow more coalescing.
2996 if (next && (!next->data || next->zero)) {
3002 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
3003 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
3004 e->start, e->length, e->depth,
3005 e->zero ? "true" : "false",
3006 e->data ? "true" : "false");
3007 if (e->has_offset) {
3008 printf(", \"offset\": %"PRId64"", e->offset);
3020 static int get_block_status(BlockDriverState *bs, int64_t offset,
3021 int64_t bytes, MapEntry *e)
3025 BlockDriverState *file;
3028 char *filename = NULL;
3030 /* As an optimization, we could cache the current range of unallocated
3031 * clusters in each file of the chain, and avoid querying the same
3037 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
3042 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3045 bs = backing_bs(bs);
3054 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3056 if (file && has_offset) {
3057 bdrv_refresh_filename(file);
3058 filename = file->filename;
3064 .data = !!(ret & BDRV_BLOCK_DATA),
3065 .zero = !!(ret & BDRV_BLOCK_ZERO),
3067 .has_offset = has_offset,
3069 .has_filename = filename,
3070 .filename = filename,
3076 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3078 if (curr->length == 0) {
3081 if (curr->zero != next->zero ||
3082 curr->data != next->data ||
3083 curr->depth != next->depth ||
3084 curr->has_filename != next->has_filename ||
3085 curr->has_offset != next->has_offset) {
3088 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
3091 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3097 static int img_map(int argc, char **argv)
3100 OutputFormat output_format = OFORMAT_HUMAN;
3102 BlockDriverState *bs;
3103 const char *filename, *fmt, *output;
3105 MapEntry curr = { .length = 0 }, next;
3107 bool image_opts = false;
3108 bool force_share = false;
3109 int64_t start_offset = 0;
3110 int64_t max_length = -1;
3115 int option_index = 0;
3116 static const struct option long_options[] = {
3117 {"help", no_argument, 0, 'h'},
3118 {"format", required_argument, 0, 'f'},
3119 {"output", required_argument, 0, OPTION_OUTPUT},
3120 {"object", required_argument, 0, OPTION_OBJECT},
3121 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3122 {"force-share", no_argument, 0, 'U'},
3123 {"start-offset", required_argument, 0, 's'},
3124 {"max-length", required_argument, 0, 'l'},
3127 c = getopt_long(argc, argv, ":f:s:l:hU",
3128 long_options, &option_index);
3134 missing_argument(argv[optind - 1]);
3137 unrecognized_option(argv[optind - 1]);
3152 start_offset = cvtnum("start offset", optarg);
3153 if (start_offset < 0) {
3158 max_length = cvtnum("max length", optarg);
3159 if (max_length < 0) {
3163 case OPTION_OBJECT: {
3165 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3171 case OPTION_IMAGE_OPTS:
3176 if (optind != argc - 1) {
3177 error_exit("Expecting one image file name");
3179 filename = argv[optind];
3181 if (output && !strcmp(output, "json")) {
3182 output_format = OFORMAT_JSON;
3183 } else if (output && !strcmp(output, "human")) {
3184 output_format = OFORMAT_HUMAN;
3185 } else if (output) {
3186 error_report("--output must be used with human or json as argument.");
3190 if (qemu_opts_foreach(&qemu_object_opts,
3191 user_creatable_add_opts_foreach,
3192 qemu_img_object_print_help, &error_fatal)) {
3196 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
3202 if (output_format == OFORMAT_HUMAN) {
3203 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3204 } else if (output_format == OFORMAT_JSON) {
3208 length = blk_getlength(blk);
3210 error_report("Failed to get size for '%s'", filename);
3213 if (max_length != -1) {
3214 length = MIN(start_offset + max_length, length);
3217 curr.start = start_offset;
3218 while (curr.start + curr.length < length) {
3219 int64_t offset = curr.start + curr.length;
3220 int64_t n = length - offset;
3222 ret = get_block_status(bs, offset, n, &next);
3224 error_report("Could not read file metadata: %s", strerror(-ret));
3228 if (entry_mergeable(&curr, &next)) {
3229 curr.length += next.length;
3233 if (curr.length > 0) {
3234 ret = dump_map_entry(output_format, &curr, &next);
3242 ret = dump_map_entry(output_format, &curr, NULL);
3243 if (output_format == OFORMAT_JSON) {
3252 #define SNAPSHOT_LIST 1
3253 #define SNAPSHOT_CREATE 2
3254 #define SNAPSHOT_APPLY 3
3255 #define SNAPSHOT_DELETE 4
3257 static int img_snapshot(int argc, char **argv)
3260 BlockDriverState *bs;
3261 QEMUSnapshotInfo sn;
3262 char *filename, *snapshot_name = NULL;
3263 int c, ret = 0, bdrv_oflags;
3268 bool image_opts = false;
3269 bool force_share = false;
3271 bdrv_oflags = BDRV_O_RDWR;
3272 /* Parse commandline parameters */
3274 static const struct option long_options[] = {
3275 {"help", no_argument, 0, 'h'},
3276 {"object", required_argument, 0, OPTION_OBJECT},
3277 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3278 {"force-share", no_argument, 0, 'U'},
3281 c = getopt_long(argc, argv, ":la:c:d:hqU",
3282 long_options, NULL);
3288 missing_argument(argv[optind - 1]);
3291 unrecognized_option(argv[optind - 1]);
3298 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3301 action = SNAPSHOT_LIST;
3302 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3306 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3309 action = SNAPSHOT_APPLY;
3310 snapshot_name = optarg;
3314 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3317 action = SNAPSHOT_CREATE;
3318 snapshot_name = optarg;
3322 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3325 action = SNAPSHOT_DELETE;
3326 snapshot_name = optarg;
3334 case OPTION_OBJECT: {
3336 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3342 case OPTION_IMAGE_OPTS:
3348 if (optind != argc - 1) {
3349 error_exit("Expecting one image file name");
3351 filename = argv[optind++];
3353 if (qemu_opts_foreach(&qemu_object_opts,
3354 user_creatable_add_opts_foreach,
3355 qemu_img_object_print_help, &error_fatal)) {
3359 /* Open the image */
3360 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3367 /* Perform the requested action */
3373 case SNAPSHOT_CREATE:
3374 memset(&sn, 0, sizeof(sn));
3375 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3377 qemu_gettimeofday(&tv);
3378 sn.date_sec = tv.tv_sec;
3379 sn.date_nsec = tv.tv_usec * 1000;
3381 ret = bdrv_snapshot_create(bs, &sn);
3383 error_report("Could not create snapshot '%s': %d (%s)",
3384 snapshot_name, ret, strerror(-ret));
3388 case SNAPSHOT_APPLY:
3389 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3391 error_reportf_err(err, "Could not apply snapshot '%s': ",
3396 case SNAPSHOT_DELETE:
3397 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3399 error_report("Could not delete snapshot '%s': snapshot not "
3400 "found", snapshot_name);
3403 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3405 error_reportf_err(err, "Could not delete snapshot '%s': ",
3421 static int img_rebase(int argc, char **argv)
3423 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
3424 uint8_t *buf_old = NULL;
3425 uint8_t *buf_new = NULL;
3426 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
3428 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3429 int c, flags, src_flags, ret;
3430 bool writethrough, src_writethrough;
3432 bool force_share = false;
3435 Error *local_err = NULL;
3436 bool image_opts = false;
3438 /* Parse commandline parameters */
3440 cache = BDRV_DEFAULT_CACHE;
3441 src_cache = BDRV_DEFAULT_CACHE;
3445 static const struct option long_options[] = {
3446 {"help", no_argument, 0, 'h'},
3447 {"object", required_argument, 0, OPTION_OBJECT},
3448 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3449 {"force-share", no_argument, 0, 'U'},
3452 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3453 long_options, NULL);
3459 missing_argument(argv[optind - 1]);
3462 unrecognized_option(argv[optind - 1]);
3471 out_basefmt = optarg;
3474 out_baseimg = optarg;
3491 case OPTION_OBJECT: {
3493 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3499 case OPTION_IMAGE_OPTS:
3512 if (optind != argc - 1) {
3513 error_exit("Expecting one image file name");
3515 if (!unsafe && !out_baseimg) {
3516 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3518 filename = argv[optind++];
3520 if (qemu_opts_foreach(&qemu_object_opts,
3521 user_creatable_add_opts_foreach,
3522 qemu_img_object_print_help, &error_fatal)) {
3526 qemu_progress_init(progress, 2.0);
3527 qemu_progress_print(0, 100);
3529 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3530 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3532 error_report("Invalid cache option: %s", cache);
3537 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3539 error_report("Invalid source cache option: %s", src_cache);
3543 /* The source files are opened read-only, don't care about WCE */
3544 assert((src_flags & BDRV_O_RDWR) == 0);
3545 (void) src_writethrough;
3550 * Ignore the old backing file for unsafe rebase in case we want to correct
3551 * the reference to a renamed or moved backing file.
3553 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3561 if (out_basefmt != NULL) {
3562 if (bdrv_find_format(out_basefmt) == NULL) {
3563 error_report("Invalid format name: '%s'", out_basefmt);
3569 /* For safe rebasing we need to compare old and new backing file */
3571 QDict *options = NULL;
3572 BlockDriverState *base_bs = backing_bs(bs);
3575 blk_old_backing = blk_new(qemu_get_aio_context(),
3576 BLK_PERM_CONSISTENT_READ,
3578 ret = blk_insert_bs(blk_old_backing, base_bs,
3581 error_reportf_err(local_err,
3582 "Could not reuse old backing file '%s': ",
3587 blk_old_backing = NULL;
3590 if (out_baseimg[0]) {
3591 const char *overlay_filename;
3592 char *out_real_path;
3594 options = qdict_new();
3596 qdict_put_str(options, "driver", out_basefmt);
3599 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3602 bdrv_refresh_filename(bs);
3603 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3606 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3610 qobject_unref(options);
3611 error_reportf_err(local_err,
3612 "Could not resolve backing filename: ");
3618 * Find out whether we rebase an image on top of a previous image
3621 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
3622 if (prefix_chain_bs) {
3623 qobject_unref(options);
3624 g_free(out_real_path);
3626 blk_new_backing = blk_new(qemu_get_aio_context(),
3627 BLK_PERM_CONSISTENT_READ,
3629 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3632 error_reportf_err(local_err,
3633 "Could not reuse backing file '%s': ",
3638 blk_new_backing = blk_new_open(out_real_path, NULL,
3639 options, src_flags, &local_err);
3640 g_free(out_real_path);
3641 if (!blk_new_backing) {
3642 error_reportf_err(local_err,
3643 "Could not open new backing file '%s': ",
3653 * Check each unallocated cluster in the COW file. If it is unallocated,
3654 * accesses go to the backing file. We must therefore compare this cluster
3655 * in the old and new backing file, and if they differ we need to copy it
3656 * from the old backing file into the COW file.
3658 * If qemu-img crashes during this step, no harm is done. The content of
3659 * the image is the same as the original one at any time.
3663 int64_t old_backing_size = 0;
3664 int64_t new_backing_size = 0;
3667 float local_progress = 0;
3669 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3670 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3672 size = blk_getlength(blk);
3674 error_report("Could not get size of '%s': %s",
3675 filename, strerror(-size));
3679 if (blk_old_backing) {
3680 old_backing_size = blk_getlength(blk_old_backing);
3681 if (old_backing_size < 0) {
3682 char backing_name[PATH_MAX];
3684 bdrv_get_backing_filename(bs, backing_name,
3685 sizeof(backing_name));
3686 error_report("Could not get size of '%s': %s",
3687 backing_name, strerror(-old_backing_size));
3692 if (blk_new_backing) {
3693 new_backing_size = blk_getlength(blk_new_backing);
3694 if (new_backing_size < 0) {
3695 error_report("Could not get size of '%s': %s",
3696 out_baseimg, strerror(-new_backing_size));
3703 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3706 for (offset = 0; offset < size; offset += n) {
3707 bool buf_old_is_zero = false;
3709 /* How many bytes can we handle with the next read? */
3710 n = MIN(IO_BUF_SIZE, size - offset);
3712 /* If the cluster is allocated, we don't need to take action */
3713 ret = bdrv_is_allocated(bs, offset, n, &n);
3715 error_report("error while reading image metadata: %s",
3723 if (prefix_chain_bs) {
3725 * If cluster wasn't changed since prefix_chain, we don't need
3728 ret = bdrv_is_allocated_above(backing_bs(bs), prefix_chain_bs,
3729 false, offset, n, &n);
3731 error_report("error while reading image metadata: %s",
3741 * Read old and new backing file and take into consideration that
3742 * backing files may be smaller than the COW image.
3744 if (offset >= old_backing_size) {
3745 memset(buf_old, 0, n);
3746 buf_old_is_zero = true;
3748 if (offset + n > old_backing_size) {
3749 n = old_backing_size - offset;
3752 ret = blk_pread(blk_old_backing, offset, buf_old, n);
3754 error_report("error while reading from old backing file");
3759 if (offset >= new_backing_size || !blk_new_backing) {
3760 memset(buf_new, 0, n);
3762 if (offset + n > new_backing_size) {
3763 n = new_backing_size - offset;
3766 ret = blk_pread(blk_new_backing, offset, buf_new, n);
3768 error_report("error while reading from new backing file");
3773 /* If they differ, we need to write to the COW file */
3774 uint64_t written = 0;
3776 while (written < n) {
3779 if (compare_buffers(buf_old + written, buf_new + written,
3780 n - written, &pnum))
3782 if (buf_old_is_zero) {
3783 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3785 ret = blk_pwrite(blk, offset + written,
3786 buf_old + written, pnum, 0);
3789 error_report("Error while writing to COW image: %s",
3797 qemu_progress_print(local_progress, 100);
3802 * Change the backing file. All clusters that are different from the old
3803 * backing file are overwritten in the COW file now, so the visible content
3804 * doesn't change when we switch the backing file.
3806 if (out_baseimg && *out_baseimg) {
3807 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt, true);
3809 ret = bdrv_change_backing_file(bs, NULL, NULL, false);
3812 if (ret == -ENOSPC) {
3813 error_report("Could not change the backing file to '%s': No "
3814 "space left in the file header", out_baseimg);
3815 } else if (ret < 0) {
3816 error_report("Could not change the backing file to '%s': %s",
3817 out_baseimg, strerror(-ret));
3820 qemu_progress_print(100, 0);
3822 * TODO At this point it is possible to check if any clusters that are
3823 * allocated in the COW file are the same in the backing file. If so, they
3824 * could be dropped from the COW file. Don't do this before switching the
3825 * backing file, in case of a crash this would lead to corruption.
3828 qemu_progress_end();
3831 blk_unref(blk_old_backing);
3832 blk_unref(blk_new_backing);
3834 qemu_vfree(buf_old);
3835 qemu_vfree(buf_new);
3844 static int img_resize(int argc, char **argv)
3847 int c, ret, relative;
3848 const char *filename, *fmt, *size;
3849 int64_t n, total_size, current_size;
3851 BlockBackend *blk = NULL;
3852 PreallocMode prealloc = PREALLOC_MODE_OFF;
3855 static QemuOptsList resize_options = {
3856 .name = "resize_options",
3857 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3860 .name = BLOCK_OPT_SIZE,
3861 .type = QEMU_OPT_SIZE,
3862 .help = "Virtual disk size"
3868 bool image_opts = false;
3869 bool shrink = false;
3871 /* Remove size from argv manually so that negative numbers are not treated
3872 * as options by getopt. */
3874 error_exit("Not enough arguments");
3878 size = argv[--argc];
3880 /* Parse getopt arguments */
3883 static const struct option long_options[] = {
3884 {"help", no_argument, 0, 'h'},
3885 {"object", required_argument, 0, OPTION_OBJECT},
3886 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3887 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3888 {"shrink", no_argument, 0, OPTION_SHRINK},
3891 c = getopt_long(argc, argv, ":f:hq",
3892 long_options, NULL);
3898 missing_argument(argv[optind - 1]);
3901 unrecognized_option(argv[optind - 1]);
3912 case OPTION_OBJECT: {
3914 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3920 case OPTION_IMAGE_OPTS:
3923 case OPTION_PREALLOCATION:
3924 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
3925 PREALLOC_MODE__MAX, NULL);
3926 if (prealloc == PREALLOC_MODE__MAX) {
3927 error_report("Invalid preallocation mode '%s'", optarg);
3936 if (optind != argc - 1) {
3937 error_exit("Expecting image file name and size");
3939 filename = argv[optind++];
3941 if (qemu_opts_foreach(&qemu_object_opts,
3942 user_creatable_add_opts_foreach,
3943 qemu_img_object_print_help, &error_fatal)) {
3947 /* Choose grow, shrink, or absolute resize mode */
3963 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3964 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
3965 error_report_err(err);
3967 qemu_opts_del(param);
3970 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3971 qemu_opts_del(param);
3973 blk = img_open(image_opts, filename, fmt,
3974 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3981 current_size = blk_getlength(blk);
3982 if (current_size < 0) {
3983 error_report("Failed to inquire current image length: %s",
3984 strerror(-current_size));
3990 total_size = current_size + n * relative;
3994 if (total_size <= 0) {
3995 error_report("New image size must be positive");
4000 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4001 error_report("Preallocation can only be used for growing images");
4006 if (total_size < current_size && !shrink) {
4007 error_report("Use the --shrink option to perform a shrink operation.");
4008 warn_report("Shrinking an image will delete all data beyond the "
4009 "shrunken image's end. Before performing such an "
4010 "operation, make sure there is no important data there.");
4016 * The user expects the image to have the desired size after
4017 * resizing, so pass @exact=true. It is of no use to report
4018 * success when the image has not actually been resized.
4020 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
4022 qprintf(quiet, "Image resized.\n");
4024 error_report_err(err);
4034 static void amend_status_cb(BlockDriverState *bs,
4035 int64_t offset, int64_t total_work_size,
4038 qemu_progress_print(100.f * offset / total_work_size, 0);
4041 static int print_amend_option_help(const char *format)
4045 /* Find driver and parse its options */
4046 drv = bdrv_find_format(format);
4048 error_report("Unknown file format '%s'", format);
4052 if (!drv->bdrv_amend_options) {
4053 error_report("Format driver '%s' does not support option amendment",
4058 /* Every driver supporting amendment must have amend_opts */
4059 assert(drv->amend_opts);
4061 printf("Amend options for '%s':\n", format);
4062 qemu_opts_print_help(drv->amend_opts, false);
4066 static int img_amend(int argc, char **argv)
4070 char *options = NULL;
4071 QemuOptsList *amend_opts = NULL;
4072 QemuOpts *opts = NULL;
4073 const char *fmt = NULL, *filename, *cache;
4076 bool quiet = false, progress = false;
4077 BlockBackend *blk = NULL;
4078 BlockDriverState *bs = NULL;
4079 bool image_opts = false;
4082 cache = BDRV_DEFAULT_CACHE;
4084 static const struct option long_options[] = {
4085 {"help", no_argument, 0, 'h'},
4086 {"object", required_argument, 0, OPTION_OBJECT},
4087 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4088 {"force", no_argument, 0, OPTION_FORCE},
4091 c = getopt_long(argc, argv, ":ho:f:t:pq",
4092 long_options, NULL);
4099 missing_argument(argv[optind - 1]);
4102 unrecognized_option(argv[optind - 1]);
4108 if (accumulate_options(&options, optarg) < 0) {
4110 goto out_no_progress;
4126 opts = qemu_opts_parse_noisily(&qemu_object_opts,
4130 goto out_no_progress;
4133 case OPTION_IMAGE_OPTS:
4143 error_exit("Must specify options (-o)");
4146 if (qemu_opts_foreach(&qemu_object_opts,
4147 user_creatable_add_opts_foreach,
4148 qemu_img_object_print_help, &error_fatal)) {
4150 goto out_no_progress;
4156 qemu_progress_init(progress, 1.0);
4158 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4159 if (fmt && has_help_option(options)) {
4160 /* If a format is explicitly specified (and possibly no filename is
4161 * given), print option help here */
4162 ret = print_amend_option_help(fmt);
4166 if (optind != argc - 1) {
4167 error_report("Expecting one image file name");
4172 flags = BDRV_O_RDWR;
4173 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
4175 error_report("Invalid cache option: %s", cache);
4179 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4187 fmt = bs->drv->format_name;
4189 if (has_help_option(options)) {
4190 /* If the format was auto-detected, print option help here */
4191 ret = print_amend_option_help(fmt);
4195 if (!bs->drv->bdrv_amend_options) {
4196 error_report("Format driver '%s' does not support option amendment",
4202 /* Every driver supporting amendment must have amend_opts */
4203 assert(bs->drv->amend_opts);
4205 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4206 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
4207 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
4208 /* Try to parse options using the create options */
4209 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4210 qemu_opts_del(opts);
4211 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
4212 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
4213 error_append_hint(&err,
4214 "This option is only supported for image creation\n");
4217 error_report_err(err);
4222 /* In case the driver does not call amend_status_cb() */
4223 qemu_progress_print(0.f, 0);
4224 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
4225 qemu_progress_print(100.f, 0);
4227 error_report_err(err);
4232 qemu_progress_end();
4236 qemu_opts_del(opts);
4237 qemu_opts_free(amend_opts);
4246 typedef struct BenchData {
4248 uint64_t image_size;
4255 bool drain_on_flush;
4264 static void bench_undrained_flush_cb(void *opaque, int ret)
4267 error_report("Failed flush request: %s", strerror(-ret));
4272 static void bench_cb(void *opaque, int ret)
4274 BenchData *b = opaque;
4278 error_report("Failed request: %s", strerror(-ret));
4283 /* Just finished a flush with drained queue: Start next requests */
4284 assert(b->in_flight == 0);
4285 b->in_flush = false;
4286 } else if (b->in_flight > 0) {
4287 int remaining = b->n - b->in_flight;
4292 /* Time for flush? Drain queue if requested, then flush */
4293 if (b->flush_interval && remaining % b->flush_interval == 0) {
4294 if (!b->in_flight || !b->drain_on_flush) {
4295 BlockCompletionFunc *cb;
4297 if (b->drain_on_flush) {
4301 cb = bench_undrained_flush_cb;
4304 acb = blk_aio_flush(b->blk, cb, b);
4306 error_report("Failed to issue flush request");
4310 if (b->drain_on_flush) {
4316 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4317 int64_t offset = b->offset;
4318 /* blk_aio_* might look for completed I/Os and kick bench_cb
4319 * again, so make sure this operation is counted by in_flight
4320 * and b->offset is ready for the next submission.
4323 b->offset += b->step;
4324 b->offset %= b->image_size;
4326 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
4328 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
4331 error_report("Failed to issue request");
4337 static int img_bench(int argc, char **argv)
4340 const char *fmt = NULL, *filename;
4342 bool image_opts = false;
4343 bool is_write = false;
4347 size_t bufsize = 4096;
4350 int flush_interval = 0;
4351 bool drain_on_flush = true;
4353 BlockBackend *blk = NULL;
4354 BenchData data = {};
4356 bool writethrough = false;
4357 struct timeval t1, t2;
4359 bool force_share = false;
4363 static const struct option long_options[] = {
4364 {"help", no_argument, 0, 'h'},
4365 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
4366 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4367 {"pattern", required_argument, 0, OPTION_PATTERN},
4368 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4369 {"force-share", no_argument, 0, 'U'},
4372 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4380 missing_argument(argv[optind - 1]);
4383 unrecognized_option(argv[optind - 1]);
4392 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4393 error_report("Invalid request count specified");
4403 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4404 error_report("Invalid queue depth specified");
4414 flags |= BDRV_O_NATIVE_AIO;
4417 ret = bdrv_parse_aio(optarg, &flags);
4419 error_report("Invalid aio option: %s", optarg);
4426 offset = cvtnum("offset", optarg);
4440 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4452 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4461 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4463 error_report("Invalid cache mode");
4469 flags |= BDRV_O_RDWR;
4475 case OPTION_PATTERN:
4479 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
4480 error_report("Invalid pattern byte specified");
4486 case OPTION_FLUSH_INTERVAL:
4490 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4491 error_report("Invalid flush interval specified");
4494 flush_interval = res;
4497 case OPTION_NO_DRAIN:
4498 drain_on_flush = false;
4500 case OPTION_IMAGE_OPTS:
4506 if (optind != argc - 1) {
4507 error_exit("Expecting one image file name");
4509 filename = argv[argc - 1];
4511 if (!is_write && flush_interval) {
4512 error_report("--flush-interval is only available in write tests");
4516 if (flush_interval && flush_interval < depth) {
4517 error_report("Flush interval can't be smaller than depth");
4522 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4529 image_size = blk_getlength(blk);
4530 if (image_size < 0) {
4535 data = (BenchData) {
4537 .image_size = image_size,
4539 .step = step ?: bufsize,
4544 .flush_interval = flush_interval,
4545 .drain_on_flush = drain_on_flush,
4547 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4548 "(starting at offset %" PRId64 ", step size %d)\n",
4549 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4550 data.offset, data.step);
4551 if (flush_interval) {
4552 printf("Sending flush every %d requests\n", flush_interval);
4555 buf_size = data.nrreq * data.bufsize;
4556 data.buf = blk_blockalign(blk, buf_size);
4557 memset(data.buf, pattern, data.nrreq * data.bufsize);
4559 blk_register_buf(blk, data.buf, buf_size);
4561 data.qiov = g_new(QEMUIOVector, data.nrreq);
4562 for (i = 0; i < data.nrreq; i++) {
4563 qemu_iovec_init(&data.qiov[i], 1);
4564 qemu_iovec_add(&data.qiov[i],
4565 data.buf + i * data.bufsize, data.bufsize);
4568 gettimeofday(&t1, NULL);
4571 while (data.n > 0) {
4572 main_loop_wait(false);
4574 gettimeofday(&t2, NULL);
4576 printf("Run completed in %3.3f seconds.\n",
4577 (t2.tv_sec - t1.tv_sec)
4578 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4582 blk_unregister_buf(blk, data.buf);
4584 qemu_vfree(data.buf);
4601 typedef struct ImgBitmapAction {
4602 enum ImgBitmapAct act;
4603 const char *src; /* only used for merge */
4604 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4607 static int img_bitmap(int argc, char **argv)
4611 QemuOpts *opts = NULL;
4612 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4613 const char *filename, *bitmap;
4614 BlockBackend *blk = NULL, *src = NULL;
4615 BlockDriverState *bs = NULL, *src_bs = NULL;
4616 bool image_opts = false;
4617 int64_t granularity = 0;
4618 bool add = false, merge = false;
4619 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4620 ImgBitmapAction *act, *act_next;
4623 QSIMPLEQ_INIT(&actions);
4626 static const struct option long_options[] = {
4627 {"help", no_argument, 0, 'h'},
4628 {"object", required_argument, 0, OPTION_OBJECT},
4629 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4630 {"add", no_argument, 0, OPTION_ADD},
4631 {"remove", no_argument, 0, OPTION_REMOVE},
4632 {"clear", no_argument, 0, OPTION_CLEAR},
4633 {"enable", no_argument, 0, OPTION_ENABLE},
4634 {"disable", no_argument, 0, OPTION_DISABLE},
4635 {"merge", required_argument, 0, OPTION_MERGE},
4636 {"granularity", required_argument, 0, 'g'},
4637 {"source-file", required_argument, 0, 'b'},
4638 {"source-format", required_argument, 0, 'F'},
4641 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4648 missing_argument(argv[optind - 1]);
4651 unrecognized_option(argv[optind - 1]);
4657 src_filename = optarg;
4666 granularity = cvtnum("granularity", optarg);
4667 if (granularity < 0) {
4672 act = g_new0(ImgBitmapAction, 1);
4673 act->act = BITMAP_ADD;
4674 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4678 act = g_new0(ImgBitmapAction, 1);
4679 act->act = BITMAP_REMOVE;
4680 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4683 act = g_new0(ImgBitmapAction, 1);
4684 act->act = BITMAP_CLEAR;
4685 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4688 act = g_new0(ImgBitmapAction, 1);
4689 act->act = BITMAP_ENABLE;
4690 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4692 case OPTION_DISABLE:
4693 act = g_new0(ImgBitmapAction, 1);
4694 act->act = BITMAP_DISABLE;
4695 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4698 act = g_new0(ImgBitmapAction, 1);
4699 act->act = BITMAP_MERGE;
4701 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4705 opts = qemu_opts_parse_noisily(&qemu_object_opts, optarg, true);
4710 case OPTION_IMAGE_OPTS:
4716 if (qemu_opts_foreach(&qemu_object_opts,
4717 user_creatable_add_opts_foreach,
4718 qemu_img_object_print_help, &error_fatal)) {
4722 if (QSIMPLEQ_EMPTY(&actions)) {
4723 error_report("Need at least one of --add, --remove, --clear, "
4724 "--enable, --disable, or --merge");
4728 if (granularity && !add) {
4729 error_report("granularity only supported with --add");
4732 if (src_fmt && !src_filename) {
4733 error_report("-F only supported with -b");
4736 if (src_filename && !merge) {
4737 error_report("Merge bitmap source file only supported with "
4742 if (optind != argc - 2) {
4743 error_report("Expecting filename and bitmap name");
4747 filename = argv[optind];
4748 bitmap = argv[optind + 1];
4750 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR, false, false,
4757 src = img_open(false, src_filename, src_fmt, 0, false, false, false);
4761 src_bs = blk_bs(src);
4766 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4769 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4770 !!granularity, granularity, true, true,
4771 false, false, &err);
4775 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4779 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4783 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4786 case BITMAP_DISABLE:
4787 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4791 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4796 g_assert_not_reached();
4800 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4812 qemu_opts_del(opts);
4828 int bsz; /* Block size */
4836 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4840 static int img_dd_bs(const char *arg,
4841 struct DdIo *in, struct DdIo *out,
4846 res = cvtnum_full("bs", arg, 1, INT_MAX);
4851 in->bsz = out->bsz = res;
4856 static int img_dd_count(const char *arg,
4857 struct DdIo *in, struct DdIo *out,
4860 dd->count = cvtnum("count", arg);
4862 if (dd->count < 0) {
4869 static int img_dd_if(const char *arg,
4870 struct DdIo *in, struct DdIo *out,
4873 in->filename = g_strdup(arg);
4878 static int img_dd_of(const char *arg,
4879 struct DdIo *in, struct DdIo *out,
4882 out->filename = g_strdup(arg);
4887 static int img_dd_skip(const char *arg,
4888 struct DdIo *in, struct DdIo *out,
4891 in->offset = cvtnum("skip", arg);
4893 if (in->offset < 0) {
4900 static int img_dd(int argc, char **argv)
4905 BlockDriver *drv = NULL, *proto_drv = NULL;
4906 BlockBackend *blk1 = NULL, *blk2 = NULL;
4907 QemuOpts *opts = NULL;
4908 QemuOptsList *create_opts = NULL;
4909 Error *local_err = NULL;
4910 bool image_opts = false;
4912 const char *out_fmt = "raw";
4913 const char *fmt = NULL;
4915 int64_t block_count = 0, out_pos, in_pos;
4916 bool force_share = false;
4917 struct DdInfo dd = {
4922 .bsz = 512, /* Block size is by default 512 bytes */
4934 const struct DdOpts options[] = {
4935 { "bs", img_dd_bs, C_BS },
4936 { "count", img_dd_count, C_COUNT },
4937 { "if", img_dd_if, C_IF },
4938 { "of", img_dd_of, C_OF },
4939 { "skip", img_dd_skip, C_SKIP },
4942 const struct option long_options[] = {
4943 { "help", no_argument, 0, 'h'},
4944 { "object", required_argument, 0, OPTION_OBJECT},
4945 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4946 { "force-share", no_argument, 0, 'U'},
4950 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
4962 missing_argument(argv[optind - 1]);
4965 unrecognized_option(argv[optind - 1]);
4974 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4979 case OPTION_IMAGE_OPTS:
4985 for (i = optind; i < argc; i++) {
4987 arg = g_strdup(argv[i]);
4989 tmp = strchr(arg, '=');
4991 error_report("unrecognized operand %s", arg);
4998 for (j = 0; options[j].name != NULL; j++) {
4999 if (!strcmp(arg, options[j].name)) {
5003 if (options[j].name == NULL) {
5004 error_report("unrecognized operand %s", arg);
5009 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5013 dd.flags |= options[j].flag;
5018 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5019 error_report("Must specify both input and output files");
5024 if (qemu_opts_foreach(&qemu_object_opts,
5025 user_creatable_add_opts_foreach,
5026 qemu_img_object_print_help, &error_fatal)) {
5031 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5039 drv = bdrv_find_format(out_fmt);
5041 error_report("Unknown file format");
5045 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5048 error_report_err(local_err);
5052 if (!drv->create_opts) {
5053 error_report("Format driver '%s' does not support image creation",
5058 if (!proto_drv->create_opts) {
5059 error_report("Protocol driver '%s' does not support image creation",
5060 proto_drv->format_name);
5064 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5065 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5067 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5069 size = blk_getlength(blk1);
5071 error_report("Failed to get size for '%s'", in.filename);
5076 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5077 dd.count * in.bsz < size) {
5078 size = dd.count * in.bsz;
5081 /* Overflow means the specified offset is beyond input image's size */
5082 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5083 size < in.bsz * in.offset)) {
5084 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5086 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5087 size - in.bsz * in.offset, &error_abort);
5090 ret = bdrv_create(drv, out.filename, opts, &local_err);
5092 error_reportf_err(local_err,
5093 "%s: error while creating output image: ",
5099 /* TODO, we can't honour --image-opts for the target,
5100 * since it needs to be given in a format compatible
5101 * with the bdrv_create() call above which does not
5102 * support image-opts style.
5104 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
5105 false, false, false);
5112 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5113 size < in.offset * in.bsz)) {
5114 /* We give a warning if the skip option is bigger than the input
5115 * size and create an empty output disk image (i.e. like dd(1)).
5117 error_report("%s: cannot skip to specified offset", in.filename);
5120 in_pos = in.offset * in.bsz;
5123 in.buf = g_new(uint8_t, in.bsz);
5125 for (out_pos = 0; in_pos < size; block_count++) {
5126 int in_ret, out_ret;
5128 if (in_pos + in.bsz > size) {
5129 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
5131 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
5134 error_report("error while reading from input image file: %s",
5141 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
5144 error_report("error while writing to output image file: %s",
5145 strerror(-out_ret));
5154 qemu_opts_del(opts);
5155 qemu_opts_free(create_opts);
5158 g_free(in.filename);
5159 g_free(out.filename);
5169 static void dump_json_block_measure_info(BlockMeasureInfo *info)
5173 Visitor *v = qobject_output_visitor_new(&obj);
5175 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5176 visit_complete(v, &obj);
5177 str = qobject_to_json_pretty(obj);
5178 assert(str != NULL);
5179 printf("%s\n", qstring_get_str(str));
5185 static int img_measure(int argc, char **argv)
5187 static const struct option long_options[] = {
5188 {"help", no_argument, 0, 'h'},
5189 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5190 {"object", required_argument, 0, OPTION_OBJECT},
5191 {"output", required_argument, 0, OPTION_OUTPUT},
5192 {"size", required_argument, 0, OPTION_SIZE},
5193 {"force-share", no_argument, 0, 'U'},
5196 OutputFormat output_format = OFORMAT_HUMAN;
5197 BlockBackend *in_blk = NULL;
5199 const char *filename = NULL;
5200 const char *fmt = NULL;
5201 const char *out_fmt = "raw";
5202 char *options = NULL;
5203 char *snapshot_name = NULL;
5204 bool force_share = false;
5205 QemuOpts *opts = NULL;
5206 QemuOpts *object_opts = NULL;
5207 QemuOpts *sn_opts = NULL;
5208 QemuOptsList *create_opts = NULL;
5209 bool image_opts = false;
5210 uint64_t img_size = UINT64_MAX;
5211 BlockMeasureInfo *info = NULL;
5212 Error *local_err = NULL;
5216 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5217 long_options, NULL)) != -1) {
5230 if (accumulate_options(&options, optarg) < 0) {
5235 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5236 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5239 error_report("Failed in parsing snapshot param '%s'",
5244 snapshot_name = optarg;
5251 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
5257 case OPTION_IMAGE_OPTS:
5261 if (!strcmp(optarg, "json")) {
5262 output_format = OFORMAT_JSON;
5263 } else if (!strcmp(optarg, "human")) {
5264 output_format = OFORMAT_HUMAN;
5266 error_report("--output must be used with human or json "
5275 sval = cvtnum("image size", optarg);
5279 img_size = (uint64_t)sval;
5285 if (qemu_opts_foreach(&qemu_object_opts,
5286 user_creatable_add_opts_foreach,
5287 qemu_img_object_print_help, &error_fatal)) {
5291 if (argc - optind > 1) {
5292 error_report("At most one filename argument is allowed.");
5294 } else if (argc - optind == 1) {
5295 filename = argv[optind];
5298 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5299 error_report("--image-opts, -f, and -l require a filename argument.");
5302 if (filename && img_size != UINT64_MAX) {
5303 error_report("--size N cannot be used together with a filename.");
5306 if (!filename && img_size == UINT64_MAX) {
5307 error_report("Either --size N or one filename must be specified.");
5312 in_blk = img_open(image_opts, filename, fmt, 0,
5313 false, false, force_share);
5319 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5320 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5321 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5323 } else if (snapshot_name != NULL) {
5324 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5325 snapshot_name, &local_err);
5328 error_reportf_err(local_err, "Failed to load snapshot: ");
5333 drv = bdrv_find_format(out_fmt);
5335 error_report("Unknown file format '%s'", out_fmt);
5338 if (!drv->create_opts) {
5339 error_report("Format driver '%s' does not support image creation",
5344 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5345 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5346 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5348 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
5349 error_report_err(local_err);
5350 error_report("Invalid options for file format '%s'", out_fmt);
5354 if (img_size != UINT64_MAX) {
5355 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5358 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5360 error_report_err(local_err);
5364 if (output_format == OFORMAT_HUMAN) {
5365 printf("required size: %" PRIu64 "\n", info->required);
5366 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
5367 if (info->has_bitmaps) {
5368 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5371 dump_json_block_measure_info(info);
5377 qapi_free_BlockMeasureInfo(info);
5378 qemu_opts_del(object_opts);
5379 qemu_opts_del(opts);
5380 qemu_opts_del(sn_opts);
5381 qemu_opts_free(create_opts);
5387 static const img_cmd_t img_cmds[] = {
5388 #define DEF(option, callback, arg_string) \
5389 { option, callback },
5390 #include "qemu-img-cmds.h"
5395 int main(int argc, char **argv)
5397 const img_cmd_t *cmd;
5398 const char *cmdname;
5399 Error *local_error = NULL;
5400 char *trace_file = NULL;
5402 static const struct option long_options[] = {
5403 {"help", no_argument, 0, 'h'},
5404 {"version", no_argument, 0, 'V'},
5405 {"trace", required_argument, NULL, 'T'},
5410 signal(SIGPIPE, SIG_IGN);
5413 error_init(argv[0]);
5414 module_call_init(MODULE_INIT_TRACE);
5415 qemu_init_exec_dir(argv[0]);
5417 if (qemu_init_main_loop(&local_error)) {
5418 error_report_err(local_error);
5422 qcrypto_init(&error_fatal);
5424 module_call_init(MODULE_INIT_QOM);
5427 error_exit("Not enough arguments");
5430 qemu_add_opts(&qemu_object_opts);
5431 qemu_add_opts(&qemu_source_opts);
5432 qemu_add_opts(&qemu_trace_opts);
5434 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
5437 missing_argument(argv[optind - 1]);
5440 unrecognized_option(argv[optind - 1]);
5446 printf(QEMU_IMG_VERSION);
5450 trace_file = trace_opt_parse(optarg);
5455 cmdname = argv[optind];
5457 /* reset getopt_long scanning */
5463 qemu_reset_optind();
5465 if (!trace_init_backends()) {
5468 trace_init_file(trace_file);
5469 qemu_set_log(LOG_TRACE);
5471 /* find the command */
5472 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5473 if (!strcmp(cmdname, cmd->name)) {
5474 return cmd->handler(argc, argv);
5479 error_exit("Command not found: %s", cmdname);