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-version.h"
29 #include "qapi/error.h"
30 #include "qapi/qapi-visit-block-core.h"
31 #include "qapi/qobject-output-visitor.h"
32 #include "qapi/qmp/qjson.h"
33 #include "qapi/qmp/qdict.h"
34 #include "qapi/qmp/qstring.h"
35 #include "qemu/cutils.h"
36 #include "qemu/config-file.h"
37 #include "qemu/option.h"
38 #include "qemu/error-report.h"
40 #include "qom/object_interfaces.h"
41 #include "sysemu/sysemu.h"
42 #include "sysemu/block-backend.h"
43 #include "block/block_int.h"
44 #include "block/blockjob.h"
45 #include "block/qapi.h"
46 #include "crypto/init.h"
47 #include "trace/control.h"
49 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
50 "\n" QEMU_COPYRIGHT "\n"
52 typedef struct img_cmd_t {
54 int (*handler)(int argc, char **argv);
59 OPTION_BACKING_CHAIN = 257,
61 OPTION_IMAGE_OPTS = 259,
63 OPTION_FLUSH_INTERVAL = 261,
64 OPTION_NO_DRAIN = 262,
65 OPTION_TARGET_IMAGE_OPTS = 263,
67 OPTION_PREALLOCATION = 265,
71 typedef enum OutputFormat {
76 /* Default to cache=writeback as data integrity is not important for qemu-img */
77 #define BDRV_DEFAULT_CACHE "writeback"
79 static void format_print(void *opaque, const char *name)
84 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
88 error_printf("qemu-img: ");
91 error_vprintf(fmt, ap);
94 error_printf("\nTry 'qemu-img --help' for more information\n");
98 static void QEMU_NORETURN missing_argument(const char *option)
100 error_exit("missing argument for option '%s'", option);
103 static void QEMU_NORETURN unrecognized_option(const char *option)
105 error_exit("unrecognized option '%s'", option);
108 /* Please keep in synch with qemu-img.texi */
109 static void QEMU_NORETURN help(void)
111 const char *help_msg =
113 "usage: qemu-img [standard options] command [command options]\n"
114 "QEMU disk image utility\n"
116 " '-h', '--help' display this help and exit\n"
117 " '-V', '--version' output version information and exit\n"
118 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
119 " specify tracing options\n"
122 #define DEF(option, callback, arg_string) \
124 #include "qemu-img-cmds.h"
127 "Command parameters:\n"
128 " 'filename' is a disk image filename\n"
129 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
130 " manual page for a description of the object properties. The most common\n"
131 " object type is a 'secret', which is used to supply passwords and/or\n"
132 " encryption keys.\n"
133 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
134 " 'cache' is the cache mode used to write the output disk image, the valid\n"
135 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
136 " 'directsync' and 'unsafe' (default for convert)\n"
137 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
138 " options are the same as for the 'cache' option\n"
139 " 'size' is the disk image size in bytes. Optional suffixes\n"
140 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
141 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
142 " supported. 'b' is ignored.\n"
143 " 'output_filename' is the destination disk image filename\n"
144 " 'output_fmt' is the destination format\n"
145 " 'options' is a comma separated list of format specific options in a\n"
146 " name=value format. Use -o ? for an overview of the options supported by the\n"
148 " 'snapshot_param' is param used for internal snapshot, format\n"
149 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
151 " '-c' indicates that target image must be compressed (qcow format only)\n"
152 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
153 " new backing file match exactly. The image doesn't need a working\n"
154 " backing file before rebasing in this case (useful for renaming the\n"
155 " backing file). For image creation, allow creating without attempting\n"
156 " to open the backing file.\n"
157 " '-h' with or without a command shows this help and lists the supported formats\n"
158 " '-p' show progress of command (only certain commands)\n"
159 " '-q' use Quiet mode - do not print any output (except errors)\n"
160 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
161 " contain only zeros for qemu-img to create a sparse image during\n"
162 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
163 " unallocated or zero sectors, and the destination image will always be\n"
165 " '--output' takes the format in which the output must be done (human or json)\n"
166 " '-n' skips the target volume creation (useful if the volume is created\n"
167 " prior to running qemu-img)\n"
169 "Parameters to check subcommand:\n"
170 " '-r' tries to repair any inconsistencies that are found during the check.\n"
171 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
172 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
173 " hiding corruption that has already occurred.\n"
175 "Parameters to convert subcommand:\n"
176 " '-m' specifies how many coroutines work in parallel during the convert\n"
177 " process (defaults to 8)\n"
178 " '-W' allow to write to the target out of order rather than sequential\n"
180 "Parameters to snapshot subcommand:\n"
181 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
182 " '-a' applies a snapshot (revert disk to saved state)\n"
183 " '-c' creates a snapshot\n"
184 " '-d' deletes a snapshot\n"
185 " '-l' lists all snapshots in the given image\n"
187 "Parameters to compare subcommand:\n"
188 " '-f' first image format\n"
189 " '-F' second image format\n"
190 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
192 "Parameters to dd subcommand:\n"
193 " 'bs=BYTES' read and write up to BYTES bytes at a time "
195 " 'count=N' copy only N input blocks\n"
196 " 'if=FILE' read from FILE\n"
197 " 'of=FILE' write to FILE\n"
198 " 'skip=N' skip N bs-sized blocks at the start of input\n";
200 printf("%s\nSupported formats:", help_msg);
201 bdrv_iterate_format(format_print, NULL, false);
202 printf("\n\n" QEMU_HELP_BOTTOM "\n");
206 static QemuOptsList qemu_object_opts = {
208 .implied_opt_name = "qom-type",
209 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
215 static QemuOptsList qemu_source_opts = {
217 .implied_opt_name = "file",
218 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
224 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
230 ret = vprintf(fmt, args);
237 static int print_block_option_help(const char *filename, const char *fmt)
239 BlockDriver *drv, *proto_drv;
240 QemuOptsList *create_opts = NULL;
241 Error *local_err = NULL;
243 /* Find driver and parse its options */
244 drv = bdrv_find_format(fmt);
246 error_report("Unknown file format '%s'", fmt);
250 if (!drv->create_opts) {
251 error_report("Format driver '%s' does not support image creation", fmt);
255 create_opts = qemu_opts_append(create_opts, drv->create_opts);
257 proto_drv = bdrv_find_protocol(filename, true, &local_err);
259 error_report_err(local_err);
260 qemu_opts_free(create_opts);
263 if (!proto_drv->create_opts) {
264 error_report("Protocol driver '%s' does not support image creation",
265 proto_drv->format_name);
266 qemu_opts_free(create_opts);
269 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
272 printf("Supported options:\n");
273 qemu_opts_print_help(create_opts, false);
274 qemu_opts_free(create_opts);
279 static BlockBackend *img_open_opts(const char *optstr,
280 QemuOpts *opts, int flags, bool writethrough,
281 bool quiet, bool force_share)
284 Error *local_err = NULL;
286 options = qemu_opts_to_qdict(opts, NULL);
288 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
289 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
290 error_report("--force-share/-U conflicts with image options");
291 qobject_unref(options);
294 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
296 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
298 error_reportf_err(local_err, "Could not open '%s': ", optstr);
301 blk_set_enable_write_cache(blk, !writethrough);
306 static BlockBackend *img_open_file(const char *filename,
308 const char *fmt, int flags,
309 bool writethrough, bool quiet,
313 Error *local_err = NULL;
316 options = qdict_new();
319 qdict_put_str(options, "driver", fmt);
323 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
325 blk = blk_new_open(filename, NULL, options, flags, &local_err);
327 error_reportf_err(local_err, "Could not open '%s': ", filename);
330 blk_set_enable_write_cache(blk, !writethrough);
336 static int img_add_key_secrets(void *opaque,
337 const char *name, const char *value,
340 QDict *options = opaque;
342 if (g_str_has_suffix(name, "key-secret")) {
343 qdict_put_str(options, name, value);
350 static BlockBackend *img_open(bool image_opts,
351 const char *filename,
352 const char *fmt, int flags, bool writethrough,
353 bool quiet, bool force_share)
359 error_report("--image-opts and --format are mutually exclusive");
362 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
367 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
370 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
377 static int add_old_style_options(const char *fmt, QemuOpts *opts,
378 const char *base_filename,
379 const char *base_fmt)
384 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
386 error_report("Backing file not supported for file format '%s'",
393 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
395 error_report("Backing file format not supported for file "
404 static int64_t cvtnum(const char *s)
409 err = qemu_strtosz(s, NULL, &value);
413 if (value > INT64_MAX) {
419 static int img_create(int argc, char **argv)
422 uint64_t img_size = -1;
423 const char *fmt = "raw";
424 const char *base_fmt = NULL;
425 const char *filename;
426 const char *base_filename = NULL;
427 char *options = NULL;
428 Error *local_err = NULL;
433 static const struct option long_options[] = {
434 {"help", no_argument, 0, 'h'},
435 {"object", required_argument, 0, OPTION_OBJECT},
438 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
445 missing_argument(argv[optind - 1]);
448 unrecognized_option(argv[optind - 1]);
457 base_filename = optarg;
463 if (!is_valid_option_list(optarg)) {
464 error_report("Invalid option list: %s", optarg);
468 options = g_strdup(optarg);
470 char *old_options = options;
471 options = g_strdup_printf("%s,%s", options, optarg);
479 flags |= BDRV_O_NO_BACKING;
481 case OPTION_OBJECT: {
483 opts = qemu_opts_parse_noisily(&qemu_object_opts,
492 /* Get the filename */
493 filename = (optind < argc) ? argv[optind] : NULL;
494 if (options && has_help_option(options)) {
496 return print_block_option_help(filename, fmt);
499 if (optind >= argc) {
500 error_exit("Expecting image file name");
504 if (qemu_opts_foreach(&qemu_object_opts,
505 user_creatable_add_opts_foreach,
506 NULL, &error_fatal)) {
510 /* Get image size, if specified */
514 sval = cvtnum(argv[optind++]);
516 if (sval == -ERANGE) {
517 error_report("Image size must be less than 8 EiB!");
519 error_report("Invalid image size specified! You may use k, M, "
520 "G, T, P or E suffixes for ");
521 error_report("kilobytes, megabytes, gigabytes, terabytes, "
522 "petabytes and exabytes.");
526 img_size = (uint64_t)sval;
528 if (optind != argc) {
529 error_exit("Unexpected argument: %s", argv[optind]);
532 bdrv_img_create(filename, fmt, base_filename, base_fmt,
533 options, img_size, flags, quiet, &local_err);
535 error_reportf_err(local_err, "%s: ", filename);
547 static void dump_json_image_check(ImageCheck *check, bool quiet)
551 Visitor *v = qobject_output_visitor_new(&obj);
553 visit_type_ImageCheck(v, NULL, &check, &error_abort);
554 visit_complete(v, &obj);
555 str = qobject_to_json_pretty(obj);
557 qprintf(quiet, "%s\n", qstring_get_str(str));
563 static void dump_human_image_check(ImageCheck *check, bool quiet)
565 if (!(check->corruptions || check->leaks || check->check_errors)) {
566 qprintf(quiet, "No errors were found on the image.\n");
568 if (check->corruptions) {
569 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
570 "Data may be corrupted, or further writes to the image "
577 "\n%" PRId64 " leaked clusters were found on the image.\n"
578 "This means waste of disk space, but no harm to data.\n",
582 if (check->check_errors) {
585 " internal errors have occurred during the check.\n",
586 check->check_errors);
590 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
591 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
592 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
593 check->allocated_clusters, check->total_clusters,
594 check->allocated_clusters * 100.0 / check->total_clusters,
595 check->fragmented_clusters * 100.0 / check->allocated_clusters,
596 check->compressed_clusters * 100.0 /
597 check->allocated_clusters);
600 if (check->image_end_offset) {
602 "Image end offset: %" PRId64 "\n", check->image_end_offset);
606 static int collect_image_check(BlockDriverState *bs,
608 const char *filename,
613 BdrvCheckResult result;
615 ret = bdrv_check(bs, &result, fix);
620 check->filename = g_strdup(filename);
621 check->format = g_strdup(bdrv_get_format_name(bs));
622 check->check_errors = result.check_errors;
623 check->corruptions = result.corruptions;
624 check->has_corruptions = result.corruptions != 0;
625 check->leaks = result.leaks;
626 check->has_leaks = result.leaks != 0;
627 check->corruptions_fixed = result.corruptions_fixed;
628 check->has_corruptions_fixed = result.corruptions != 0;
629 check->leaks_fixed = result.leaks_fixed;
630 check->has_leaks_fixed = result.leaks != 0;
631 check->image_end_offset = result.image_end_offset;
632 check->has_image_end_offset = result.image_end_offset != 0;
633 check->total_clusters = result.bfi.total_clusters;
634 check->has_total_clusters = result.bfi.total_clusters != 0;
635 check->allocated_clusters = result.bfi.allocated_clusters;
636 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
637 check->fragmented_clusters = result.bfi.fragmented_clusters;
638 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
639 check->compressed_clusters = result.bfi.compressed_clusters;
640 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
646 * Checks an image for consistency. Exit codes:
648 * 0 - Check completed, image is good
649 * 1 - Check not completed because of internal errors
650 * 2 - Check completed, image is corrupted
651 * 3 - Check completed, image has leaked clusters, but is good otherwise
652 * 63 - Checks are not supported by the image format
654 static int img_check(int argc, char **argv)
657 OutputFormat output_format = OFORMAT_HUMAN;
658 const char *filename, *fmt, *output, *cache;
660 BlockDriverState *bs;
662 int flags = BDRV_O_CHECK;
666 bool image_opts = false;
667 bool force_share = false;
671 cache = BDRV_DEFAULT_CACHE;
674 int option_index = 0;
675 static const struct option long_options[] = {
676 {"help", no_argument, 0, 'h'},
677 {"format", required_argument, 0, 'f'},
678 {"repair", required_argument, 0, 'r'},
679 {"output", required_argument, 0, OPTION_OUTPUT},
680 {"object", required_argument, 0, OPTION_OBJECT},
681 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
682 {"force-share", no_argument, 0, 'U'},
685 c = getopt_long(argc, argv, ":hf:r:T:qU",
686 long_options, &option_index);
692 missing_argument(argv[optind - 1]);
695 unrecognized_option(argv[optind - 1]);
704 flags |= BDRV_O_RDWR;
706 if (!strcmp(optarg, "leaks")) {
707 fix = BDRV_FIX_LEAKS;
708 } else if (!strcmp(optarg, "all")) {
709 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
711 error_exit("Unknown option value for -r "
712 "(expecting 'leaks' or 'all'): %s", optarg);
727 case OPTION_OBJECT: {
729 opts = qemu_opts_parse_noisily(&qemu_object_opts,
735 case OPTION_IMAGE_OPTS:
740 if (optind != argc - 1) {
741 error_exit("Expecting one image file name");
743 filename = argv[optind++];
745 if (output && !strcmp(output, "json")) {
746 output_format = OFORMAT_JSON;
747 } else if (output && !strcmp(output, "human")) {
748 output_format = OFORMAT_HUMAN;
750 error_report("--output must be used with human or json as argument.");
754 if (qemu_opts_foreach(&qemu_object_opts,
755 user_creatable_add_opts_foreach,
756 NULL, &error_fatal)) {
760 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
762 error_report("Invalid source cache option: %s", cache);
766 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
773 check = g_new0(ImageCheck, 1);
774 ret = collect_image_check(bs, check, filename, fmt, fix);
776 if (ret == -ENOTSUP) {
777 error_report("This image format does not support checks");
782 if (check->corruptions_fixed || check->leaks_fixed) {
783 int corruptions_fixed, leaks_fixed;
785 leaks_fixed = check->leaks_fixed;
786 corruptions_fixed = check->corruptions_fixed;
788 if (output_format == OFORMAT_HUMAN) {
790 "The following inconsistencies were found and repaired:\n\n"
791 " %" PRId64 " leaked clusters\n"
792 " %" PRId64 " corruptions\n\n"
793 "Double checking the fixed image now...\n",
795 check->corruptions_fixed);
798 ret = collect_image_check(bs, check, filename, fmt, 0);
800 check->leaks_fixed = leaks_fixed;
801 check->corruptions_fixed = corruptions_fixed;
805 switch (output_format) {
807 dump_human_image_check(check, quiet);
810 dump_json_image_check(check, quiet);
815 if (ret || check->check_errors) {
817 error_report("Check failed: %s", strerror(-ret));
819 error_report("Check failed");
825 if (check->corruptions) {
827 } else if (check->leaks) {
834 qapi_free_ImageCheck(check);
839 typedef struct CommonBlockJobCBInfo {
840 BlockDriverState *bs;
842 } CommonBlockJobCBInfo;
844 static void common_block_job_cb(void *opaque, int ret)
846 CommonBlockJobCBInfo *cbi = opaque;
849 error_setg_errno(cbi->errp, -ret, "Block job failed");
853 static void run_block_job(BlockJob *job, Error **errp)
855 AioContext *aio_context = blk_get_aio_context(job->blk);
858 aio_context_acquire(aio_context);
861 float progress = 0.0f;
862 aio_poll(aio_context, true);
863 if (job->job.progress_total) {
864 progress = (float)job->job.progress_current /
865 job->job.progress_total * 100.f;
867 qemu_progress_print(progress, 0);
868 } while (!job_is_ready(&job->job) && !job_is_completed(&job->job));
870 if (!job_is_completed(&job->job)) {
871 ret = job_complete_sync(&job->job, errp);
875 job_unref(&job->job);
876 aio_context_release(aio_context);
878 /* publish completion progress only when success */
880 qemu_progress_print(100.f, 0);
884 static int img_commit(int argc, char **argv)
887 const char *filename, *fmt, *cache, *base;
889 BlockDriverState *bs, *base_bs;
891 bool progress = false, quiet = false, drop = false;
893 Error *local_err = NULL;
894 CommonBlockJobCBInfo cbi;
895 bool image_opts = false;
896 AioContext *aio_context;
899 cache = BDRV_DEFAULT_CACHE;
902 static const struct option long_options[] = {
903 {"help", no_argument, 0, 'h'},
904 {"object", required_argument, 0, OPTION_OBJECT},
905 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
908 c = getopt_long(argc, argv, ":f:ht:b:dpq",
915 missing_argument(argv[optind - 1]);
918 unrecognized_option(argv[optind - 1]);
943 case OPTION_OBJECT: {
945 opts = qemu_opts_parse_noisily(&qemu_object_opts,
951 case OPTION_IMAGE_OPTS:
957 /* Progress is not shown in Quiet mode */
962 if (optind != argc - 1) {
963 error_exit("Expecting one image file name");
965 filename = argv[optind++];
967 if (qemu_opts_foreach(&qemu_object_opts,
968 user_creatable_add_opts_foreach,
969 NULL, &error_fatal)) {
973 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
974 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
976 error_report("Invalid cache option: %s", cache);
980 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
987 qemu_progress_init(progress, 1.f);
988 qemu_progress_print(0.f, 100);
991 base_bs = bdrv_find_backing_image(bs, base);
993 error_setg(&local_err,
994 "Did not find '%s' in the backing chain of '%s'",
999 /* This is different from QMP, which by default uses the deepest file in
1000 * the backing chain (i.e., the very base); however, the traditional
1001 * behavior of qemu-img commit is using the immediate backing file. */
1002 base_bs = backing_bs(bs);
1004 error_setg(&local_err, "Image does not have a backing file");
1009 cbi = (CommonBlockJobCBInfo){
1014 aio_context = bdrv_get_aio_context(bs);
1015 aio_context_acquire(aio_context);
1016 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, 0,
1017 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1018 &cbi, false, &local_err);
1019 aio_context_release(aio_context);
1024 /* When the block job completes, the BlockBackend reference will point to
1025 * the old backing file. In order to avoid that the top image is already
1026 * deleted, so we can still empty it afterwards, increment the reference
1027 * counter here preemptively. */
1032 job = block_job_get("commit");
1034 run_block_job(job, &local_err);
1039 if (!drop && bs->drv->bdrv_make_empty) {
1040 ret = bs->drv->bdrv_make_empty(bs);
1042 error_setg_errno(&local_err, -ret, "Could not empty %s",
1054 qemu_progress_end();
1059 error_report_err(local_err);
1063 qprintf(quiet, "Image committed.\n");
1068 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1069 * of the first sector boundary within buf where the sector contains a
1070 * non-zero byte. This function is robust to a buffer that is not
1073 static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1076 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1078 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1079 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1083 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1090 * Returns true iff the first sector pointed to by 'buf' contains at least
1093 * 'pnum' is set to the number of sectors (including and immediately following
1094 * the first one) that are known to be in the same allocated/unallocated state.
1095 * The function will try to align the end offset to alignment boundaries so
1096 * that the request will at least end aligned and consequtive requests will
1097 * also start at an aligned offset.
1099 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1100 int64_t sector_num, int alignment)
1109 is_zero = buffer_is_zero(buf, 512);
1110 for(i = 1; i < n; i++) {
1112 if (is_zero != buffer_is_zero(buf, 512)) {
1117 tail = (sector_num + i) & (alignment - 1);
1119 if (is_zero && i <= tail) {
1120 /* treat unallocated areas which only consist
1121 * of a small tail as allocated. */
1125 /* align up end offset of allocated areas. */
1126 i += alignment - tail;
1129 /* align down end offset of zero areas. */
1138 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1139 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1140 * breaking up write requests for only small sparse areas.
1142 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1143 int min, int64_t sector_num, int alignment)
1146 int num_checked, num_used;
1152 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1158 buf += BDRV_SECTOR_SIZE * *pnum;
1160 sector_num += *pnum;
1161 num_checked = num_used;
1164 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1166 buf += BDRV_SECTOR_SIZE * *pnum;
1168 sector_num += *pnum;
1169 num_checked += *pnum;
1171 num_used = num_checked;
1172 } else if (*pnum >= min) {
1182 * Compares two buffers sector by sector. Returns 0 if the first
1183 * sector of each buffer matches, non-zero otherwise.
1185 * pnum is set to the sector-aligned size of the buffer prefix that
1186 * has the same matching status as the first sector.
1188 static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1189 int64_t bytes, int64_t *pnum)
1192 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
1196 res = !!memcmp(buf1, buf2, i);
1198 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
1200 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
1210 #define IO_BUF_SIZE (2 * 1024 * 1024)
1213 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1215 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1216 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1217 * failure), and 4 on error (the exit status for read errors), after emitting
1220 * @param blk: BlockBackend for the image
1221 * @param offset: Starting offset to check
1222 * @param bytes: Number of bytes to check
1223 * @param filename: Name of disk file we are checking (logging purpose)
1224 * @param buffer: Allocated buffer for storing read data
1225 * @param quiet: Flag for quiet mode
1227 static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1228 int64_t bytes, const char *filename,
1229 uint8_t *buffer, bool quiet)
1234 ret = blk_pread(blk, offset, buffer, bytes);
1236 error_report("Error while reading offset %" PRId64 " of %s: %s",
1237 offset, filename, strerror(-ret));
1240 idx = find_nonzero(buffer, bytes);
1242 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1251 * Compares two images. Exit codes:
1253 * 0 - Images are identical
1255 * >1 - Error occurred
1257 static int img_compare(int argc, char **argv)
1259 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1260 BlockBackend *blk1, *blk2;
1261 BlockDriverState *bs1, *bs2;
1262 int64_t total_size1, total_size2;
1263 uint8_t *buf1 = NULL, *buf2 = NULL;
1264 int64_t pnum1, pnum2;
1265 int allocated1, allocated2;
1266 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1267 bool progress = false, quiet = false, strict = false;
1274 uint64_t progress_base;
1275 bool image_opts = false;
1276 bool force_share = false;
1278 cache = BDRV_DEFAULT_CACHE;
1280 static const struct option long_options[] = {
1281 {"help", no_argument, 0, 'h'},
1282 {"object", required_argument, 0, OPTION_OBJECT},
1283 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1284 {"force-share", no_argument, 0, 'U'},
1287 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1288 long_options, NULL);
1294 missing_argument(argv[optind - 1]);
1297 unrecognized_option(argv[optind - 1]);
1323 case OPTION_OBJECT: {
1325 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1332 case OPTION_IMAGE_OPTS:
1338 /* Progress is not shown in Quiet mode */
1344 if (optind != argc - 2) {
1345 error_exit("Expecting two image file names");
1347 filename1 = argv[optind++];
1348 filename2 = argv[optind++];
1350 if (qemu_opts_foreach(&qemu_object_opts,
1351 user_creatable_add_opts_foreach,
1352 NULL, &error_fatal)) {
1357 /* Initialize before goto out */
1358 qemu_progress_init(progress, 2.0);
1361 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1363 error_report("Invalid source cache option: %s", cache);
1368 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1375 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1384 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1385 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1386 total_size1 = blk_getlength(blk1);
1387 if (total_size1 < 0) {
1388 error_report("Can't get size of %s: %s",
1389 filename1, strerror(-total_size1));
1393 total_size2 = blk_getlength(blk2);
1394 if (total_size2 < 0) {
1395 error_report("Can't get size of %s: %s",
1396 filename2, strerror(-total_size2));
1400 total_size = MIN(total_size1, total_size2);
1401 progress_base = MAX(total_size1, total_size2);
1403 qemu_progress_print(0, 100);
1405 if (strict && total_size1 != total_size2) {
1407 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1411 while (offset < total_size) {
1412 int status1, status2;
1414 status1 = bdrv_block_status_above(bs1, NULL, offset,
1415 total_size1 - offset, &pnum1, NULL,
1419 error_report("Sector allocation test failed for %s", filename1);
1422 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1424 status2 = bdrv_block_status_above(bs2, NULL, offset,
1425 total_size2 - offset, &pnum2, NULL,
1429 error_report("Sector allocation test failed for %s", filename2);
1432 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1434 assert(pnum1 && pnum2);
1435 chunk = MIN(pnum1, pnum2);
1438 if (status1 != status2) {
1440 qprintf(quiet, "Strict mode: Offset %" PRId64
1441 " block status mismatch!\n", offset);
1445 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1447 } else if (allocated1 == allocated2) {
1451 chunk = MIN(chunk, IO_BUF_SIZE);
1452 ret = blk_pread(blk1, offset, buf1, chunk);
1454 error_report("Error while reading offset %" PRId64
1456 offset, filename1, strerror(-ret));
1460 ret = blk_pread(blk2, offset, buf2, chunk);
1462 error_report("Error while reading offset %" PRId64
1464 offset, filename2, strerror(-ret));
1468 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1469 if (ret || pnum != chunk) {
1470 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1471 offset + (ret ? 0 : pnum));
1477 chunk = MIN(chunk, IO_BUF_SIZE);
1479 ret = check_empty_sectors(blk1, offset, chunk,
1480 filename1, buf1, quiet);
1482 ret = check_empty_sectors(blk2, offset, chunk,
1483 filename2, buf1, quiet);
1490 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1493 if (total_size1 != total_size2) {
1494 BlockBackend *blk_over;
1495 const char *filename_over;
1497 qprintf(quiet, "Warning: Image size mismatch!\n");
1498 if (total_size1 > total_size2) {
1500 filename_over = filename1;
1503 filename_over = filename2;
1506 while (offset < progress_base) {
1507 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1508 progress_base - offset, &chunk,
1512 error_report("Sector allocation test failed for %s",
1517 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1518 chunk = MIN(chunk, IO_BUF_SIZE);
1519 ret = check_empty_sectors(blk_over, offset, chunk,
1520 filename_over, buf1, quiet);
1526 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1530 qprintf(quiet, "Images are identical.\n");
1540 qemu_progress_end();
1545 enum ImgConvertBlockStatus {
1551 #define MAX_COROUTINES 16
1553 typedef struct ImgConvertState {
1555 int64_t *src_sectors;
1557 int64_t total_sectors;
1558 int64_t allocated_sectors;
1559 int64_t allocated_done;
1562 enum ImgConvertBlockStatus status;
1563 int64_t sector_next_status;
1564 BlockBackend *target;
1567 bool unallocated_blocks_are_zero;
1568 bool target_has_backing;
1569 int64_t target_backing_sectors; /* negative if unknown */
1574 size_t cluster_sectors;
1576 long num_coroutines;
1577 int running_coroutines;
1578 Coroutine *co[MAX_COROUTINES];
1579 int64_t wait_sector_num[MAX_COROUTINES];
1584 static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1585 int *src_cur, int64_t *src_cur_offset)
1588 *src_cur_offset = 0;
1589 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1590 *src_cur_offset += s->src_sectors[*src_cur];
1592 assert(*src_cur < s->src_num);
1596 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1598 int64_t src_cur_offset;
1599 int ret, n, src_cur;
1600 bool post_backing_zero = false;
1602 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1604 assert(s->total_sectors > sector_num);
1605 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1607 if (s->target_backing_sectors >= 0) {
1608 if (sector_num >= s->target_backing_sectors) {
1609 post_backing_zero = s->unallocated_blocks_are_zero;
1610 } else if (sector_num + n > s->target_backing_sectors) {
1611 /* Split requests around target_backing_sectors (because
1612 * starting from there, zeros are handled differently) */
1613 n = s->target_backing_sectors - sector_num;
1617 if (s->sector_next_status <= sector_num) {
1618 int64_t count = n * BDRV_SECTOR_SIZE;
1620 if (s->target_has_backing) {
1622 ret = bdrv_block_status(blk_bs(s->src[src_cur]),
1623 (sector_num - src_cur_offset) *
1625 count, &count, NULL, NULL);
1627 ret = bdrv_block_status_above(blk_bs(s->src[src_cur]), NULL,
1628 (sector_num - src_cur_offset) *
1630 count, &count, NULL, NULL);
1633 error_report("error while reading block status of sector %" PRId64
1634 ": %s", sector_num, strerror(-ret));
1637 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1639 if (ret & BDRV_BLOCK_ZERO) {
1640 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1641 } else if (ret & BDRV_BLOCK_DATA) {
1642 s->status = BLK_DATA;
1644 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1647 s->sector_next_status = sector_num + n;
1650 n = MIN(n, s->sector_next_status - sector_num);
1651 if (s->status == BLK_DATA) {
1652 n = MIN(n, s->buf_sectors);
1655 /* We need to write complete clusters for compressed images, so if an
1656 * unallocated area is shorter than that, we must consider the whole
1657 * cluster allocated. */
1658 if (s->compressed) {
1659 if (n < s->cluster_sectors) {
1660 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1661 s->status = BLK_DATA;
1663 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1670 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1671 int nb_sectors, uint8_t *buf)
1676 assert(nb_sectors <= s->buf_sectors);
1677 while (nb_sectors > 0) {
1680 int64_t bs_sectors, src_cur_offset;
1682 /* In the case of compression with multiple source files, we can get a
1683 * nb_sectors that spreads into the next part. So we must be able to
1684 * read across multiple BDSes for one convert_read() call. */
1685 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1686 blk = s->src[src_cur];
1687 bs_sectors = s->src_sectors[src_cur];
1689 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1690 qemu_iovec_init_buf(&qiov, buf, n << BDRV_SECTOR_BITS);
1692 ret = blk_co_preadv(
1693 blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
1694 n << BDRV_SECTOR_BITS, &qiov, 0);
1701 buf += n * BDRV_SECTOR_SIZE;
1708 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1709 int nb_sectors, uint8_t *buf,
1710 enum ImgConvertBlockStatus status)
1715 while (nb_sectors > 0) {
1717 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1720 case BLK_BACKING_FILE:
1721 /* If we have a backing file, leave clusters unallocated that are
1722 * unallocated in the source image, so that the backing file is
1723 * visible at the respective offset. */
1724 assert(s->target_has_backing);
1728 /* If we're told to keep the target fully allocated (-S 0) or there
1729 * is real non-zero data, we must write it. Otherwise we can treat
1730 * it as zero sectors.
1731 * Compressed clusters need to be written as a whole, so in that
1732 * case we can only save the write if the buffer is completely
1734 if (!s->min_sparse ||
1736 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1737 sector_num, s->alignment)) ||
1739 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1741 qemu_iovec_init_buf(&qiov, buf, n << BDRV_SECTOR_BITS);
1743 ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
1744 n << BDRV_SECTOR_BITS, &qiov, flags);
1753 if (s->has_zero_init) {
1754 assert(!s->target_has_backing);
1757 ret = blk_co_pwrite_zeroes(s->target,
1758 sector_num << BDRV_SECTOR_BITS,
1759 n << BDRV_SECTOR_BITS, 0);
1768 buf += n * BDRV_SECTOR_SIZE;
1774 static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1779 while (nb_sectors > 0) {
1782 int64_t bs_sectors, src_cur_offset;
1785 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1786 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1787 blk = s->src[src_cur];
1788 bs_sectors = s->src_sectors[src_cur];
1790 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1792 ret = blk_co_copy_range(blk, offset, s->target,
1793 sector_num << BDRV_SECTOR_BITS,
1794 n << BDRV_SECTOR_BITS, 0, 0);
1805 static void coroutine_fn convert_co_do_copy(void *opaque)
1807 ImgConvertState *s = opaque;
1808 uint8_t *buf = NULL;
1812 for (i = 0; i < s->num_coroutines; i++) {
1813 if (s->co[i] == qemu_coroutine_self()) {
1820 s->running_coroutines++;
1821 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1826 enum ImgConvertBlockStatus status;
1829 qemu_co_mutex_lock(&s->lock);
1830 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1831 qemu_co_mutex_unlock(&s->lock);
1834 n = convert_iteration_sectors(s, s->sector_num);
1836 qemu_co_mutex_unlock(&s->lock);
1840 /* save current sector and allocation status to local variables */
1841 sector_num = s->sector_num;
1843 if (!s->min_sparse && s->status == BLK_ZERO) {
1844 n = MIN(n, s->buf_sectors);
1846 /* increment global sector counter so that other coroutines can
1847 * already continue reading beyond this request */
1849 qemu_co_mutex_unlock(&s->lock);
1851 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1852 s->allocated_done += n;
1853 qemu_progress_print(100.0 * s->allocated_done /
1854 s->allocated_sectors, 0);
1858 copy_range = s->copy_range && s->status == BLK_DATA;
1859 if (status == BLK_DATA && !copy_range) {
1860 ret = convert_co_read(s, sector_num, n, buf);
1862 error_report("error while reading sector %" PRId64
1863 ": %s", sector_num, strerror(-ret));
1866 } else if (!s->min_sparse && status == BLK_ZERO) {
1868 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1871 if (s->wr_in_order) {
1872 /* keep writes in order */
1873 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
1874 s->wait_sector_num[index] = sector_num;
1875 qemu_coroutine_yield();
1877 s->wait_sector_num[index] = -1;
1880 if (s->ret == -EINPROGRESS) {
1882 ret = convert_co_copy_range(s, sector_num, n);
1884 s->copy_range = false;
1888 ret = convert_co_write(s, sector_num, n, buf, status);
1891 error_report("error while writing sector %" PRId64
1892 ": %s", sector_num, strerror(-ret));
1897 if (s->wr_in_order) {
1898 /* reenter the coroutine that might have waited
1899 * for this write to complete */
1900 s->wr_offs = sector_num + n;
1901 for (i = 0; i < s->num_coroutines; i++) {
1902 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1904 * A -> B -> A cannot occur because A has
1905 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1906 * B will never enter A during this time window.
1908 qemu_coroutine_enter(s->co[i]);
1916 s->co[index] = NULL;
1917 s->running_coroutines--;
1918 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1919 /* the convert job finished successfully */
1924 static int convert_do_copy(ImgConvertState *s)
1927 int64_t sector_num = 0;
1929 /* Check whether we have zero initialisation or can get it efficiently */
1930 s->has_zero_init = s->min_sparse && !s->target_has_backing
1931 ? bdrv_has_zero_init(blk_bs(s->target))
1934 if (!s->has_zero_init && !s->target_has_backing &&
1935 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1937 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP | BDRV_REQ_NO_FALLBACK);
1939 s->has_zero_init = true;
1943 /* Allocate buffer for copied data. For compressed images, only one cluster
1944 * can be copied at a time. */
1945 if (s->compressed) {
1946 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1947 error_report("invalid cluster size");
1950 s->buf_sectors = s->cluster_sectors;
1953 while (sector_num < s->total_sectors) {
1954 n = convert_iteration_sectors(s, sector_num);
1958 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1960 s->allocated_sectors += n;
1966 s->sector_next_status = 0;
1967 s->ret = -EINPROGRESS;
1969 qemu_co_mutex_init(&s->lock);
1970 for (i = 0; i < s->num_coroutines; i++) {
1971 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
1972 s->wait_sector_num[i] = -1;
1973 qemu_coroutine_enter(s->co[i]);
1976 while (s->running_coroutines) {
1977 main_loop_wait(false);
1980 if (s->compressed && !s->ret) {
1981 /* signal EOF to align */
1982 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1991 #define MAX_BUF_SECTORS 32768
1993 static int img_convert(int argc, char **argv)
1995 int c, bs_i, flags, src_flags = 0;
1996 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
1997 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
1998 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
1999 BlockDriver *drv = NULL, *proto_drv = NULL;
2000 BlockDriverInfo bdi;
2001 BlockDriverState *out_bs;
2002 QemuOpts *opts = NULL, *sn_opts = NULL;
2003 QemuOptsList *create_opts = NULL;
2004 QDict *open_opts = NULL;
2005 char *options = NULL;
2006 Error *local_err = NULL;
2007 bool writethrough, src_writethrough, quiet = false, image_opts = false,
2008 skip_create = false, progress = false, tgt_image_opts = false;
2009 int64_t ret = -EINVAL;
2010 bool force_share = false;
2011 bool explict_min_sparse = false;
2013 ImgConvertState s = (ImgConvertState) {
2014 /* Need at least 4k of zeros for sparse detection */
2016 .copy_range = false,
2017 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2018 .wr_in_order = true,
2019 .num_coroutines = 8,
2023 static const struct option long_options[] = {
2024 {"help", no_argument, 0, 'h'},
2025 {"object", required_argument, 0, OPTION_OBJECT},
2026 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2027 {"force-share", no_argument, 0, 'U'},
2028 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2031 c = getopt_long(argc, argv, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
2032 long_options, NULL);
2038 missing_argument(argv[optind - 1]);
2041 unrecognized_option(argv[optind - 1]);
2053 out_baseimg = optarg;
2056 s.copy_range = true;
2059 s.compressed = true;
2062 if (!is_valid_option_list(optarg)) {
2063 error_report("Invalid option list: %s", optarg);
2067 options = g_strdup(optarg);
2069 char *old_options = options;
2070 options = g_strdup_printf("%s,%s", options, optarg);
2071 g_free(old_options);
2075 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2076 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2079 error_report("Failed in parsing snapshot param '%s'",
2084 snapshot_name = optarg;
2091 sval = cvtnum(optarg);
2092 if (sval < 0 || sval & (BDRV_SECTOR_SIZE - 1) ||
2093 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2094 error_report("Invalid buffer size for sparse output specified. "
2095 "Valid sizes are multiples of %llu up to %llu. Select "
2096 "0 to disable sparse detection (fully allocates output).",
2097 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2101 s.min_sparse = sval / BDRV_SECTOR_SIZE;
2102 explict_min_sparse = true;
2121 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2122 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2123 error_report("Invalid number of coroutines. Allowed number of"
2124 " coroutines is between 1 and %d", MAX_COROUTINES);
2129 s.wr_in_order = false;
2134 case OPTION_OBJECT: {
2135 QemuOpts *object_opts;
2136 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2143 case OPTION_IMAGE_OPTS:
2146 case OPTION_TARGET_IMAGE_OPTS:
2147 tgt_image_opts = true;
2152 if (!out_fmt && !tgt_image_opts) {
2156 if (qemu_opts_foreach(&qemu_object_opts,
2157 user_creatable_add_opts_foreach,
2158 NULL, &error_fatal)) {
2162 if (s.compressed && s.copy_range) {
2163 error_report("Cannot enable copy offloading when -c is used");
2167 if (explict_min_sparse && s.copy_range) {
2168 error_report("Cannot enable copy offloading when -S is used");
2172 if (tgt_image_opts && !skip_create) {
2173 error_report("--target-image-opts requires use of -n flag");
2177 s.src_num = argc - optind - 1;
2178 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2180 if (options && has_help_option(options)) {
2182 ret = print_block_option_help(out_filename, out_fmt);
2185 error_report("Option help requires a format be specified");
2190 if (s.src_num < 1) {
2191 error_report("Must specify image file name");
2196 /* ret is still -EINVAL until here */
2197 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2199 error_report("Invalid source cache option: %s", src_cache);
2203 /* Initialize before goto out */
2207 qemu_progress_init(progress, 1.0);
2208 qemu_progress_print(0, 100);
2210 s.src = g_new0(BlockBackend *, s.src_num);
2211 s.src_sectors = g_new(int64_t, s.src_num);
2213 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2214 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2215 fmt, src_flags, src_writethrough, quiet,
2221 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2222 if (s.src_sectors[bs_i] < 0) {
2223 error_report("Could not get size of %s: %s",
2224 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2228 s.total_sectors += s.src_sectors[bs_i];
2232 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2233 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2234 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2236 } else if (snapshot_name != NULL) {
2237 if (s.src_num > 1) {
2238 error_report("No support for concatenating multiple snapshot");
2243 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2247 error_reportf_err(local_err, "Failed to load snapshot: ");
2253 /* Find driver and parse its options */
2254 drv = bdrv_find_format(out_fmt);
2256 error_report("Unknown file format '%s'", out_fmt);
2261 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2263 error_report_err(local_err);
2268 if (!drv->create_opts) {
2269 error_report("Format driver '%s' does not support image creation",
2275 if (!proto_drv->create_opts) {
2276 error_report("Protocol driver '%s' does not support image creation",
2277 proto_drv->format_name);
2282 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2283 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2285 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2287 qemu_opts_do_parse(opts, options, NULL, &local_err);
2289 error_report_err(local_err);
2295 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2297 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2303 /* Get backing file name if -o backing_file was used */
2304 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2305 if (out_baseimg_param) {
2306 out_baseimg = out_baseimg_param;
2308 s.target_has_backing = (bool) out_baseimg;
2310 if (s.src_num > 1 && out_baseimg) {
2311 error_report("Having a backing file for the target makes no sense when "
2312 "concatenating multiple input images");
2317 /* Check if compression is supported */
2320 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2321 const char *encryptfmt =
2322 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2323 const char *preallocation =
2324 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2326 if (drv && !drv->bdrv_co_pwritev_compressed) {
2327 error_report("Compression not supported for this file format");
2332 if (encryption || encryptfmt) {
2333 error_report("Compression and encryption not supported at "
2340 && strcmp(preallocation, "off"))
2342 error_report("Compression and preallocation not supported at "
2350 * The later open call will need any decryption secrets, and
2351 * bdrv_create() will purge "opts", so extract them now before
2355 open_opts = qdict_new();
2356 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2360 /* Create the new image */
2361 ret = bdrv_create(drv, out_filename, opts, &local_err);
2363 error_reportf_err(local_err, "%s: error while converting %s: ",
2364 out_filename, out_fmt);
2369 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2370 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2372 error_report("Invalid cache option: %s", cache);
2377 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
2378 flags, writethrough, quiet, false);
2380 /* TODO ultimately we should allow --target-image-opts
2381 * to be used even when -n is not given.
2382 * That has to wait for bdrv_create to be improved
2383 * to allow filenames in option syntax
2385 s.target = img_open_file(out_filename, open_opts, out_fmt,
2386 flags, writethrough, quiet, false);
2387 open_opts = NULL; /* blk_new_open will have freed it */
2393 out_bs = blk_bs(s.target);
2395 if (s.compressed && !out_bs->drv->bdrv_co_pwritev_compressed) {
2396 error_report("Compression not supported for this file format");
2401 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2402 * or discard_alignment of the out_bs is greater. Limit to
2403 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2404 s.buf_sectors = MIN(MAX_BUF_SECTORS,
2406 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2407 out_bs->bl.pdiscard_alignment >>
2408 BDRV_SECTOR_BITS)));
2410 /* try to align the write requests to the destination to avoid unnecessary
2412 s.alignment = MAX(pow2floor(s.min_sparse),
2413 DIV_ROUND_UP(out_bs->bl.request_alignment,
2415 assert(is_power_of_2(s.alignment));
2418 int64_t output_sectors = blk_nb_sectors(s.target);
2419 if (output_sectors < 0) {
2420 error_report("unable to get output image length: %s",
2421 strerror(-output_sectors));
2424 } else if (output_sectors < s.total_sectors) {
2425 error_report("output file is smaller than input file");
2431 if (s.target_has_backing) {
2432 /* Errors are treated as "backing length unknown" (which means
2433 * s.target_backing_sectors has to be negative, which it will
2434 * be automatically). The backing file length is used only
2435 * for optimizations, so such a case is not fatal. */
2436 s.target_backing_sectors = bdrv_nb_sectors(out_bs->backing->bs);
2438 s.target_backing_sectors = -1;
2441 ret = bdrv_get_info(out_bs, &bdi);
2444 error_report("could not get block driver info");
2448 s.compressed = s.compressed || bdi.needs_compressed_writes;
2449 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2450 s.unallocated_blocks_are_zero = bdi.unallocated_blocks_are_zero;
2453 ret = convert_do_copy(&s);
2456 qemu_progress_print(100, 0);
2458 qemu_progress_end();
2459 qemu_opts_del(opts);
2460 qemu_opts_free(create_opts);
2461 qemu_opts_del(sn_opts);
2462 qobject_unref(open_opts);
2463 blk_unref(s.target);
2465 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2466 blk_unref(s.src[bs_i]);
2470 g_free(s.src_sectors);
2478 static void dump_snapshots(BlockDriverState *bs)
2480 QEMUSnapshotInfo *sn_tab, *sn;
2483 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2486 printf("Snapshot list:\n");
2487 bdrv_snapshot_dump(fprintf, stdout, NULL);
2489 for(i = 0; i < nb_sns; i++) {
2491 bdrv_snapshot_dump(fprintf, stdout, sn);
2497 static void dump_json_image_info_list(ImageInfoList *list)
2501 Visitor *v = qobject_output_visitor_new(&obj);
2503 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2504 visit_complete(v, &obj);
2505 str = qobject_to_json_pretty(obj);
2506 assert(str != NULL);
2507 printf("%s\n", qstring_get_str(str));
2513 static void dump_json_image_info(ImageInfo *info)
2517 Visitor *v = qobject_output_visitor_new(&obj);
2519 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2520 visit_complete(v, &obj);
2521 str = qobject_to_json_pretty(obj);
2522 assert(str != NULL);
2523 printf("%s\n", qstring_get_str(str));
2529 static void dump_human_image_info_list(ImageInfoList *list)
2531 ImageInfoList *elem;
2534 for (elem = list; elem; elem = elem->next) {
2540 bdrv_image_info_dump(fprintf, stdout, elem->value);
2544 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2546 return strcmp(a, b) == 0;
2550 * Open an image file chain and return an ImageInfoList
2552 * @filename: topmost image filename
2553 * @fmt: topmost image format (may be NULL to autodetect)
2554 * @chain: true - enumerate entire backing file chain
2555 * false - only topmost image file
2557 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2558 * image file. If there was an error a message will have been printed to
2561 static ImageInfoList *collect_image_info_list(bool image_opts,
2562 const char *filename,
2564 bool chain, bool force_share)
2566 ImageInfoList *head = NULL;
2567 ImageInfoList **last = &head;
2568 GHashTable *filenames;
2571 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2575 BlockDriverState *bs;
2577 ImageInfoList *elem;
2579 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2580 error_report("Backing file '%s' creates an infinite loop.",
2584 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2586 blk = img_open(image_opts, filename, fmt,
2587 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2594 bdrv_query_image_info(bs, &info, &err);
2596 error_report_err(err);
2601 elem = g_new0(ImageInfoList, 1);
2608 filename = fmt = NULL;
2610 if (info->has_full_backing_filename) {
2611 filename = info->full_backing_filename;
2612 } else if (info->has_backing_filename) {
2613 error_report("Could not determine absolute backing filename,"
2614 " but backing filename '%s' present",
2615 info->backing_filename);
2618 if (info->has_backing_filename_format) {
2619 fmt = info->backing_filename_format;
2623 g_hash_table_destroy(filenames);
2627 qapi_free_ImageInfoList(head);
2628 g_hash_table_destroy(filenames);
2632 static int img_info(int argc, char **argv)
2635 OutputFormat output_format = OFORMAT_HUMAN;
2637 const char *filename, *fmt, *output;
2638 ImageInfoList *list;
2639 bool image_opts = false;
2640 bool force_share = false;
2645 int option_index = 0;
2646 static const struct option long_options[] = {
2647 {"help", no_argument, 0, 'h'},
2648 {"format", required_argument, 0, 'f'},
2649 {"output", required_argument, 0, OPTION_OUTPUT},
2650 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2651 {"object", required_argument, 0, OPTION_OBJECT},
2652 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2653 {"force-share", no_argument, 0, 'U'},
2656 c = getopt_long(argc, argv, ":f:hU",
2657 long_options, &option_index);
2663 missing_argument(argv[optind - 1]);
2666 unrecognized_option(argv[optind - 1]);
2680 case OPTION_BACKING_CHAIN:
2683 case OPTION_OBJECT: {
2685 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2691 case OPTION_IMAGE_OPTS:
2696 if (optind != argc - 1) {
2697 error_exit("Expecting one image file name");
2699 filename = argv[optind++];
2701 if (output && !strcmp(output, "json")) {
2702 output_format = OFORMAT_JSON;
2703 } else if (output && !strcmp(output, "human")) {
2704 output_format = OFORMAT_HUMAN;
2705 } else if (output) {
2706 error_report("--output must be used with human or json as argument.");
2710 if (qemu_opts_foreach(&qemu_object_opts,
2711 user_creatable_add_opts_foreach,
2712 NULL, &error_fatal)) {
2716 list = collect_image_info_list(image_opts, filename, fmt, chain,
2722 switch (output_format) {
2724 dump_human_image_info_list(list);
2728 dump_json_image_info_list(list);
2730 dump_json_image_info(list->value);
2735 qapi_free_ImageInfoList(list);
2739 static int dump_map_entry(OutputFormat output_format, MapEntry *e,
2742 switch (output_format) {
2744 if (e->data && !e->has_offset) {
2745 error_report("File contains external, encrypted or compressed clusters.");
2748 if (e->data && !e->zero) {
2749 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2750 e->start, e->length,
2751 e->has_offset ? e->offset : 0,
2752 e->has_filename ? e->filename : "");
2754 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2755 * Modify the flags here to allow more coalescing.
2757 if (next && (!next->data || next->zero)) {
2763 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2764 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2765 (e->start == 0 ? "[" : ",\n"),
2766 e->start, e->length, e->depth,
2767 e->zero ? "true" : "false",
2768 e->data ? "true" : "false");
2769 if (e->has_offset) {
2770 printf(", \"offset\": %"PRId64"", e->offset);
2782 static int get_block_status(BlockDriverState *bs, int64_t offset,
2783 int64_t bytes, MapEntry *e)
2787 BlockDriverState *file;
2790 char *filename = NULL;
2792 /* As an optimization, we could cache the current range of unallocated
2793 * clusters in each file of the chain, and avoid querying the same
2799 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
2804 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2807 bs = backing_bs(bs);
2816 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2818 if (file && has_offset) {
2819 bdrv_refresh_filename(file);
2820 filename = file->filename;
2826 .data = !!(ret & BDRV_BLOCK_DATA),
2827 .zero = !!(ret & BDRV_BLOCK_ZERO),
2829 .has_offset = has_offset,
2831 .has_filename = filename,
2832 .filename = filename,
2838 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2840 if (curr->length == 0) {
2843 if (curr->zero != next->zero ||
2844 curr->data != next->data ||
2845 curr->depth != next->depth ||
2846 curr->has_filename != next->has_filename ||
2847 curr->has_offset != next->has_offset) {
2850 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2853 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2859 static int img_map(int argc, char **argv)
2862 OutputFormat output_format = OFORMAT_HUMAN;
2864 BlockDriverState *bs;
2865 const char *filename, *fmt, *output;
2867 MapEntry curr = { .length = 0 }, next;
2869 bool image_opts = false;
2870 bool force_share = false;
2875 int option_index = 0;
2876 static const struct option long_options[] = {
2877 {"help", no_argument, 0, 'h'},
2878 {"format", required_argument, 0, 'f'},
2879 {"output", required_argument, 0, OPTION_OUTPUT},
2880 {"object", required_argument, 0, OPTION_OBJECT},
2881 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2882 {"force-share", no_argument, 0, 'U'},
2885 c = getopt_long(argc, argv, ":f:hU",
2886 long_options, &option_index);
2892 missing_argument(argv[optind - 1]);
2895 unrecognized_option(argv[optind - 1]);
2909 case OPTION_OBJECT: {
2911 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2917 case OPTION_IMAGE_OPTS:
2922 if (optind != argc - 1) {
2923 error_exit("Expecting one image file name");
2925 filename = argv[optind];
2927 if (output && !strcmp(output, "json")) {
2928 output_format = OFORMAT_JSON;
2929 } else if (output && !strcmp(output, "human")) {
2930 output_format = OFORMAT_HUMAN;
2931 } else if (output) {
2932 error_report("--output must be used with human or json as argument.");
2936 if (qemu_opts_foreach(&qemu_object_opts,
2937 user_creatable_add_opts_foreach,
2938 NULL, &error_fatal)) {
2942 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
2948 if (output_format == OFORMAT_HUMAN) {
2949 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2952 length = blk_getlength(blk);
2953 while (curr.start + curr.length < length) {
2954 int64_t offset = curr.start + curr.length;
2957 /* Probe up to 1 GiB at a time. */
2958 n = MIN(1 << 30, length - offset);
2959 ret = get_block_status(bs, offset, n, &next);
2962 error_report("Could not read file metadata: %s", strerror(-ret));
2966 if (entry_mergeable(&curr, &next)) {
2967 curr.length += next.length;
2971 if (curr.length > 0) {
2972 ret = dump_map_entry(output_format, &curr, &next);
2980 ret = dump_map_entry(output_format, &curr, NULL);
2987 #define SNAPSHOT_LIST 1
2988 #define SNAPSHOT_CREATE 2
2989 #define SNAPSHOT_APPLY 3
2990 #define SNAPSHOT_DELETE 4
2992 static int img_snapshot(int argc, char **argv)
2995 BlockDriverState *bs;
2996 QEMUSnapshotInfo sn;
2997 char *filename, *snapshot_name = NULL;
2998 int c, ret = 0, bdrv_oflags;
3003 bool image_opts = false;
3004 bool force_share = false;
3006 bdrv_oflags = BDRV_O_RDWR;
3007 /* Parse commandline parameters */
3009 static const struct option long_options[] = {
3010 {"help", no_argument, 0, 'h'},
3011 {"object", required_argument, 0, OPTION_OBJECT},
3012 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3013 {"force-share", no_argument, 0, 'U'},
3016 c = getopt_long(argc, argv, ":la:c:d:hqU",
3017 long_options, NULL);
3023 missing_argument(argv[optind - 1]);
3026 unrecognized_option(argv[optind - 1]);
3033 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3036 action = SNAPSHOT_LIST;
3037 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3041 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3044 action = SNAPSHOT_APPLY;
3045 snapshot_name = optarg;
3049 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3052 action = SNAPSHOT_CREATE;
3053 snapshot_name = optarg;
3057 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3060 action = SNAPSHOT_DELETE;
3061 snapshot_name = optarg;
3069 case OPTION_OBJECT: {
3071 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3077 case OPTION_IMAGE_OPTS:
3083 if (optind != argc - 1) {
3084 error_exit("Expecting one image file name");
3086 filename = argv[optind++];
3088 if (qemu_opts_foreach(&qemu_object_opts,
3089 user_creatable_add_opts_foreach,
3090 NULL, &error_fatal)) {
3094 /* Open the image */
3095 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3102 /* Perform the requested action */
3108 case SNAPSHOT_CREATE:
3109 memset(&sn, 0, sizeof(sn));
3110 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3112 qemu_gettimeofday(&tv);
3113 sn.date_sec = tv.tv_sec;
3114 sn.date_nsec = tv.tv_usec * 1000;
3116 ret = bdrv_snapshot_create(bs, &sn);
3118 error_report("Could not create snapshot '%s': %d (%s)",
3119 snapshot_name, ret, strerror(-ret));
3123 case SNAPSHOT_APPLY:
3124 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3126 error_reportf_err(err, "Could not apply snapshot '%s': ",
3131 case SNAPSHOT_DELETE:
3132 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3134 error_report("Could not delete snapshot '%s': snapshot not "
3135 "found", snapshot_name);
3138 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3140 error_reportf_err(err, "Could not delete snapshot '%s': ",
3156 static int img_rebase(int argc, char **argv)
3158 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
3159 uint8_t *buf_old = NULL;
3160 uint8_t *buf_new = NULL;
3161 BlockDriverState *bs = NULL;
3163 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3164 int c, flags, src_flags, ret;
3165 bool writethrough, src_writethrough;
3167 bool force_share = false;
3170 Error *local_err = NULL;
3171 bool image_opts = false;
3173 /* Parse commandline parameters */
3175 cache = BDRV_DEFAULT_CACHE;
3176 src_cache = BDRV_DEFAULT_CACHE;
3180 static const struct option long_options[] = {
3181 {"help", no_argument, 0, 'h'},
3182 {"object", required_argument, 0, OPTION_OBJECT},
3183 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3184 {"force-share", no_argument, 0, 'U'},
3187 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3188 long_options, NULL);
3194 missing_argument(argv[optind - 1]);
3197 unrecognized_option(argv[optind - 1]);
3206 out_basefmt = optarg;
3209 out_baseimg = optarg;
3226 case OPTION_OBJECT: {
3228 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3234 case OPTION_IMAGE_OPTS:
3247 if (optind != argc - 1) {
3248 error_exit("Expecting one image file name");
3250 if (!unsafe && !out_baseimg) {
3251 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3253 filename = argv[optind++];
3255 if (qemu_opts_foreach(&qemu_object_opts,
3256 user_creatable_add_opts_foreach,
3257 NULL, &error_fatal)) {
3261 qemu_progress_init(progress, 2.0);
3262 qemu_progress_print(0, 100);
3264 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3265 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3267 error_report("Invalid cache option: %s", cache);
3272 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3274 error_report("Invalid source cache option: %s", src_cache);
3278 /* The source files are opened read-only, don't care about WCE */
3279 assert((src_flags & BDRV_O_RDWR) == 0);
3280 (void) src_writethrough;
3285 * Ignore the old backing file for unsafe rebase in case we want to correct
3286 * the reference to a renamed or moved backing file.
3288 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3296 if (out_basefmt != NULL) {
3297 if (bdrv_find_format(out_basefmt) == NULL) {
3298 error_report("Invalid format name: '%s'", out_basefmt);
3304 /* For safe rebasing we need to compare old and new backing file */
3306 char backing_name[PATH_MAX];
3307 QDict *options = NULL;
3309 if (bs->backing_format[0] != '\0') {
3310 options = qdict_new();
3311 qdict_put_str(options, "driver", bs->backing_format);
3316 options = qdict_new();
3318 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3320 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3321 blk_old_backing = blk_new_open(backing_name, NULL,
3322 options, src_flags, &local_err);
3323 if (!blk_old_backing) {
3324 error_reportf_err(local_err,
3325 "Could not open old backing file '%s': ",
3331 if (out_baseimg[0]) {
3332 const char *overlay_filename;
3333 char *out_real_path;
3335 options = qdict_new();
3337 qdict_put_str(options, "driver", out_basefmt);
3340 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3343 bdrv_refresh_filename(bs);
3344 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3347 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3351 error_reportf_err(local_err,
3352 "Could not resolve backing filename: ");
3357 blk_new_backing = blk_new_open(out_real_path, NULL,
3358 options, src_flags, &local_err);
3359 g_free(out_real_path);
3360 if (!blk_new_backing) {
3361 error_reportf_err(local_err,
3362 "Could not open new backing file '%s': ",
3371 * Check each unallocated cluster in the COW file. If it is unallocated,
3372 * accesses go to the backing file. We must therefore compare this cluster
3373 * in the old and new backing file, and if they differ we need to copy it
3374 * from the old backing file into the COW file.
3376 * If qemu-img crashes during this step, no harm is done. The content of
3377 * the image is the same as the original one at any time.
3381 int64_t old_backing_size;
3382 int64_t new_backing_size = 0;
3385 float local_progress = 0;
3387 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3388 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3390 size = blk_getlength(blk);
3392 error_report("Could not get size of '%s': %s",
3393 filename, strerror(-size));
3397 old_backing_size = blk_getlength(blk_old_backing);
3398 if (old_backing_size < 0) {
3399 char backing_name[PATH_MAX];
3401 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3402 error_report("Could not get size of '%s': %s",
3403 backing_name, strerror(-old_backing_size));
3407 if (blk_new_backing) {
3408 new_backing_size = blk_getlength(blk_new_backing);
3409 if (new_backing_size < 0) {
3410 error_report("Could not get size of '%s': %s",
3411 out_baseimg, strerror(-new_backing_size));
3418 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3421 for (offset = 0; offset < size; offset += n) {
3422 /* How many bytes can we handle with the next read? */
3423 n = MIN(IO_BUF_SIZE, size - offset);
3425 /* If the cluster is allocated, we don't need to take action */
3426 ret = bdrv_is_allocated(bs, offset, n, &n);
3428 error_report("error while reading image metadata: %s",
3437 * Read old and new backing file and take into consideration that
3438 * backing files may be smaller than the COW image.
3440 if (offset >= old_backing_size) {
3441 memset(buf_old, 0, n);
3443 if (offset + n > old_backing_size) {
3444 n = old_backing_size - offset;
3447 ret = blk_pread(blk_old_backing, offset, buf_old, n);
3449 error_report("error while reading from old backing file");
3454 if (offset >= new_backing_size || !blk_new_backing) {
3455 memset(buf_new, 0, n);
3457 if (offset + n > new_backing_size) {
3458 n = new_backing_size - offset;
3461 ret = blk_pread(blk_new_backing, offset, buf_new, n);
3463 error_report("error while reading from new backing file");
3468 /* If they differ, we need to write to the COW file */
3469 uint64_t written = 0;
3471 while (written < n) {
3474 if (compare_buffers(buf_old + written, buf_new + written,
3475 n - written, &pnum))
3477 ret = blk_pwrite(blk, offset + written,
3478 buf_old + written, pnum, 0);
3480 error_report("Error while writing to COW image: %s",
3488 qemu_progress_print(local_progress, 100);
3493 * Change the backing file. All clusters that are different from the old
3494 * backing file are overwritten in the COW file now, so the visible content
3495 * doesn't change when we switch the backing file.
3497 if (out_baseimg && *out_baseimg) {
3498 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3500 ret = bdrv_change_backing_file(bs, NULL, NULL);
3503 if (ret == -ENOSPC) {
3504 error_report("Could not change the backing file to '%s': No "
3505 "space left in the file header", out_baseimg);
3506 } else if (ret < 0) {
3507 error_report("Could not change the backing file to '%s': %s",
3508 out_baseimg, strerror(-ret));
3511 qemu_progress_print(100, 0);
3513 * TODO At this point it is possible to check if any clusters that are
3514 * allocated in the COW file are the same in the backing file. If so, they
3515 * could be dropped from the COW file. Don't do this before switching the
3516 * backing file, in case of a crash this would lead to corruption.
3519 qemu_progress_end();
3522 blk_unref(blk_old_backing);
3523 blk_unref(blk_new_backing);
3525 qemu_vfree(buf_old);
3526 qemu_vfree(buf_new);
3535 static int img_resize(int argc, char **argv)
3538 int c, ret, relative;
3539 const char *filename, *fmt, *size;
3540 int64_t n, total_size, current_size, new_size;
3542 BlockBackend *blk = NULL;
3543 PreallocMode prealloc = PREALLOC_MODE_OFF;
3546 static QemuOptsList resize_options = {
3547 .name = "resize_options",
3548 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3551 .name = BLOCK_OPT_SIZE,
3552 .type = QEMU_OPT_SIZE,
3553 .help = "Virtual disk size"
3559 bool image_opts = false;
3560 bool shrink = false;
3562 /* Remove size from argv manually so that negative numbers are not treated
3563 * as options by getopt. */
3565 error_exit("Not enough arguments");
3569 size = argv[--argc];
3571 /* Parse getopt arguments */
3574 static const struct option long_options[] = {
3575 {"help", no_argument, 0, 'h'},
3576 {"object", required_argument, 0, OPTION_OBJECT},
3577 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3578 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3579 {"shrink", no_argument, 0, OPTION_SHRINK},
3582 c = getopt_long(argc, argv, ":f:hq",
3583 long_options, NULL);
3589 missing_argument(argv[optind - 1]);
3592 unrecognized_option(argv[optind - 1]);
3603 case OPTION_OBJECT: {
3605 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3611 case OPTION_IMAGE_OPTS:
3614 case OPTION_PREALLOCATION:
3615 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
3616 PREALLOC_MODE__MAX, NULL);
3617 if (prealloc == PREALLOC_MODE__MAX) {
3618 error_report("Invalid preallocation mode '%s'", optarg);
3627 if (optind != argc - 1) {
3628 error_exit("Expecting image file name and size");
3630 filename = argv[optind++];
3632 if (qemu_opts_foreach(&qemu_object_opts,
3633 user_creatable_add_opts_foreach,
3634 NULL, &error_fatal)) {
3638 /* Choose grow, shrink, or absolute resize mode */
3654 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3655 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3657 error_report_err(err);
3659 qemu_opts_del(param);
3662 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3663 qemu_opts_del(param);
3665 blk = img_open(image_opts, filename, fmt,
3666 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
3673 current_size = blk_getlength(blk);
3674 if (current_size < 0) {
3675 error_report("Failed to inquire current image length: %s",
3676 strerror(-current_size));
3682 total_size = current_size + n * relative;
3686 if (total_size <= 0) {
3687 error_report("New image size must be positive");
3692 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
3693 error_report("Preallocation can only be used for growing images");
3698 if (total_size < current_size && !shrink) {
3699 warn_report("Shrinking an image will delete all data beyond the "
3700 "shrunken image's end. Before performing such an "
3701 "operation, make sure there is no important data there.");
3703 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk)), "raw") != 0) {
3705 "Use the --shrink option to perform a shrink operation.");
3709 warn_report("Using the --shrink option will suppress this message. "
3710 "Note that future versions of qemu-img may refuse to "
3711 "shrink images without this option.");
3715 ret = blk_truncate(blk, total_size, prealloc, &err);
3717 error_report_err(err);
3721 new_size = blk_getlength(blk);
3723 error_report("Failed to verify truncated image length: %s",
3724 strerror(-new_size));
3729 /* Some block drivers implement a truncation method, but only so
3730 * the user can cause qemu to refresh the image's size from disk.
3731 * The idea is that the user resizes the image outside of qemu and
3732 * then invokes block_resize to inform qemu about it.
3733 * (This includes iscsi and file-posix for device files.)
3734 * Of course, that is not the behavior someone invoking
3735 * qemu-img resize would find useful, so we catch that behavior
3736 * here and tell the user. */
3737 if (new_size != total_size && new_size == current_size) {
3738 error_report("Image was not resized; resizing may not be supported "
3744 if (new_size != total_size) {
3745 warn_report("Image should have been resized to %" PRIi64
3746 " bytes, but was resized to %" PRIi64 " bytes",
3747 total_size, new_size);
3750 qprintf(quiet, "Image resized.\n");
3760 static void amend_status_cb(BlockDriverState *bs,
3761 int64_t offset, int64_t total_work_size,
3764 qemu_progress_print(100.f * offset / total_work_size, 0);
3767 static int print_amend_option_help(const char *format)
3771 /* Find driver and parse its options */
3772 drv = bdrv_find_format(format);
3774 error_report("Unknown file format '%s'", format);
3778 if (!drv->bdrv_amend_options) {
3779 error_report("Format driver '%s' does not support option amendment",
3784 /* Every driver supporting amendment must have create_opts */
3785 assert(drv->create_opts);
3787 printf("Creation options for '%s':\n", format);
3788 qemu_opts_print_help(drv->create_opts, false);
3789 printf("\nNote that not all of these options may be amendable.\n");
3793 static int img_amend(int argc, char **argv)
3797 char *options = NULL;
3798 QemuOptsList *create_opts = NULL;
3799 QemuOpts *opts = NULL;
3800 const char *fmt = NULL, *filename, *cache;
3803 bool quiet = false, progress = false;
3804 BlockBackend *blk = NULL;
3805 BlockDriverState *bs = NULL;
3806 bool image_opts = false;
3808 cache = BDRV_DEFAULT_CACHE;
3810 static const struct option long_options[] = {
3811 {"help", no_argument, 0, 'h'},
3812 {"object", required_argument, 0, OPTION_OBJECT},
3813 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3816 c = getopt_long(argc, argv, ":ho:f:t:pq",
3817 long_options, NULL);
3824 missing_argument(argv[optind - 1]);
3827 unrecognized_option(argv[optind - 1]);
3833 if (!is_valid_option_list(optarg)) {
3834 error_report("Invalid option list: %s", optarg);
3836 goto out_no_progress;
3839 options = g_strdup(optarg);
3841 char *old_options = options;
3842 options = g_strdup_printf("%s,%s", options, optarg);
3843 g_free(old_options);
3859 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3863 goto out_no_progress;
3866 case OPTION_IMAGE_OPTS:
3873 error_exit("Must specify options (-o)");
3876 if (qemu_opts_foreach(&qemu_object_opts,
3877 user_creatable_add_opts_foreach,
3878 NULL, &error_fatal)) {
3880 goto out_no_progress;
3886 qemu_progress_init(progress, 1.0);
3888 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3889 if (fmt && has_help_option(options)) {
3890 /* If a format is explicitly specified (and possibly no filename is
3891 * given), print option help here */
3892 ret = print_amend_option_help(fmt);
3896 if (optind != argc - 1) {
3897 error_report("Expecting one image file name");
3902 flags = BDRV_O_RDWR;
3903 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3905 error_report("Invalid cache option: %s", cache);
3909 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3917 fmt = bs->drv->format_name;
3919 if (has_help_option(options)) {
3920 /* If the format was auto-detected, print option help here */
3921 ret = print_amend_option_help(fmt);
3925 if (!bs->drv->bdrv_amend_options) {
3926 error_report("Format driver '%s' does not support option amendment",
3932 /* Every driver supporting amendment must have create_opts */
3933 assert(bs->drv->create_opts);
3935 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3936 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3937 qemu_opts_do_parse(opts, options, NULL, &err);
3939 error_report_err(err);
3944 /* In case the driver does not call amend_status_cb() */
3945 qemu_progress_print(0.f, 0);
3946 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, &err);
3947 qemu_progress_print(100.f, 0);
3949 error_report_err(err);
3954 qemu_progress_end();
3958 qemu_opts_del(opts);
3959 qemu_opts_free(create_opts);
3968 typedef struct BenchData {
3970 uint64_t image_size;
3977 bool drain_on_flush;
3986 static void bench_undrained_flush_cb(void *opaque, int ret)
3989 error_report("Failed flush request: %s", strerror(-ret));
3994 static void bench_cb(void *opaque, int ret)
3996 BenchData *b = opaque;
4000 error_report("Failed request: %s", strerror(-ret));
4005 /* Just finished a flush with drained queue: Start next requests */
4006 assert(b->in_flight == 0);
4007 b->in_flush = false;
4008 } else if (b->in_flight > 0) {
4009 int remaining = b->n - b->in_flight;
4014 /* Time for flush? Drain queue if requested, then flush */
4015 if (b->flush_interval && remaining % b->flush_interval == 0) {
4016 if (!b->in_flight || !b->drain_on_flush) {
4017 BlockCompletionFunc *cb;
4019 if (b->drain_on_flush) {
4023 cb = bench_undrained_flush_cb;
4026 acb = blk_aio_flush(b->blk, cb, b);
4028 error_report("Failed to issue flush request");
4032 if (b->drain_on_flush) {
4038 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4039 int64_t offset = b->offset;
4040 /* blk_aio_* might look for completed I/Os and kick bench_cb
4041 * again, so make sure this operation is counted by in_flight
4042 * and b->offset is ready for the next submission.
4045 b->offset += b->step;
4046 b->offset %= b->image_size;
4048 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
4050 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
4053 error_report("Failed to issue request");
4059 static int img_bench(int argc, char **argv)
4062 const char *fmt = NULL, *filename;
4064 bool image_opts = false;
4065 bool is_write = false;
4069 size_t bufsize = 4096;
4072 int flush_interval = 0;
4073 bool drain_on_flush = true;
4075 BlockBackend *blk = NULL;
4076 BenchData data = {};
4078 bool writethrough = false;
4079 struct timeval t1, t2;
4081 bool force_share = false;
4085 static const struct option long_options[] = {
4086 {"help", no_argument, 0, 'h'},
4087 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
4088 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4089 {"pattern", required_argument, 0, OPTION_PATTERN},
4090 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4091 {"force-share", no_argument, 0, 'U'},
4094 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:wU", long_options, NULL);
4101 missing_argument(argv[optind - 1]);
4104 unrecognized_option(argv[optind - 1]);
4113 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4114 error_report("Invalid request count specified");
4124 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4125 error_report("Invalid queue depth specified");
4135 flags |= BDRV_O_NATIVE_AIO;
4139 offset = cvtnum(optarg);
4141 error_report("Invalid offset specified");
4154 sval = cvtnum(optarg);
4155 if (sval < 0 || sval > INT_MAX) {
4156 error_report("Invalid buffer size specified");
4167 sval = cvtnum(optarg);
4168 if (sval < 0 || sval > INT_MAX) {
4169 error_report("Invalid step size specified");
4177 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4179 error_report("Invalid cache mode");
4185 flags |= BDRV_O_RDWR;
4191 case OPTION_PATTERN:
4195 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
4196 error_report("Invalid pattern byte specified");
4202 case OPTION_FLUSH_INTERVAL:
4206 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4207 error_report("Invalid flush interval specified");
4210 flush_interval = res;
4213 case OPTION_NO_DRAIN:
4214 drain_on_flush = false;
4216 case OPTION_IMAGE_OPTS:
4222 if (optind != argc - 1) {
4223 error_exit("Expecting one image file name");
4225 filename = argv[argc - 1];
4227 if (!is_write && flush_interval) {
4228 error_report("--flush-interval is only available in write tests");
4232 if (flush_interval && flush_interval < depth) {
4233 error_report("Flush interval can't be smaller than depth");
4238 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4245 image_size = blk_getlength(blk);
4246 if (image_size < 0) {
4251 data = (BenchData) {
4253 .image_size = image_size,
4255 .step = step ?: bufsize,
4260 .flush_interval = flush_interval,
4261 .drain_on_flush = drain_on_flush,
4263 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4264 "(starting at offset %" PRId64 ", step size %d)\n",
4265 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4266 data.offset, data.step);
4267 if (flush_interval) {
4268 printf("Sending flush every %d requests\n", flush_interval);
4271 buf_size = data.nrreq * data.bufsize;
4272 data.buf = blk_blockalign(blk, buf_size);
4273 memset(data.buf, pattern, data.nrreq * data.bufsize);
4275 blk_register_buf(blk, data.buf, buf_size);
4277 data.qiov = g_new(QEMUIOVector, data.nrreq);
4278 for (i = 0; i < data.nrreq; i++) {
4279 qemu_iovec_init(&data.qiov[i], 1);
4280 qemu_iovec_add(&data.qiov[i],
4281 data.buf + i * data.bufsize, data.bufsize);
4284 gettimeofday(&t1, NULL);
4287 while (data.n > 0) {
4288 main_loop_wait(false);
4290 gettimeofday(&t2, NULL);
4292 printf("Run completed in %3.3f seconds.\n",
4293 (t2.tv_sec - t1.tv_sec)
4294 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4298 blk_unregister_buf(blk, data.buf);
4300 qemu_vfree(data.buf);
4321 int bsz; /* Block size */
4329 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4333 static int img_dd_bs(const char *arg,
4334 struct DdIo *in, struct DdIo *out,
4341 if (res <= 0 || res > INT_MAX) {
4342 error_report("invalid number: '%s'", arg);
4345 in->bsz = out->bsz = res;
4350 static int img_dd_count(const char *arg,
4351 struct DdIo *in, struct DdIo *out,
4354 dd->count = cvtnum(arg);
4356 if (dd->count < 0) {
4357 error_report("invalid number: '%s'", arg);
4364 static int img_dd_if(const char *arg,
4365 struct DdIo *in, struct DdIo *out,
4368 in->filename = g_strdup(arg);
4373 static int img_dd_of(const char *arg,
4374 struct DdIo *in, struct DdIo *out,
4377 out->filename = g_strdup(arg);
4382 static int img_dd_skip(const char *arg,
4383 struct DdIo *in, struct DdIo *out,
4386 in->offset = cvtnum(arg);
4388 if (in->offset < 0) {
4389 error_report("invalid number: '%s'", arg);
4396 static int img_dd(int argc, char **argv)
4401 BlockDriver *drv = NULL, *proto_drv = NULL;
4402 BlockBackend *blk1 = NULL, *blk2 = NULL;
4403 QemuOpts *opts = NULL;
4404 QemuOptsList *create_opts = NULL;
4405 Error *local_err = NULL;
4406 bool image_opts = false;
4408 const char *out_fmt = "raw";
4409 const char *fmt = NULL;
4411 int64_t block_count = 0, out_pos, in_pos;
4412 bool force_share = false;
4413 struct DdInfo dd = {
4418 .bsz = 512, /* Block size is by default 512 bytes */
4430 const struct DdOpts options[] = {
4431 { "bs", img_dd_bs, C_BS },
4432 { "count", img_dd_count, C_COUNT },
4433 { "if", img_dd_if, C_IF },
4434 { "of", img_dd_of, C_OF },
4435 { "skip", img_dd_skip, C_SKIP },
4438 const struct option long_options[] = {
4439 { "help", no_argument, 0, 'h'},
4440 { "object", required_argument, 0, OPTION_OBJECT},
4441 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4442 { "force-share", no_argument, 0, 'U'},
4446 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
4458 missing_argument(argv[optind - 1]);
4461 unrecognized_option(argv[optind - 1]);
4470 if (!qemu_opts_parse_noisily(&qemu_object_opts, optarg, true)) {
4475 case OPTION_IMAGE_OPTS:
4481 for (i = optind; i < argc; i++) {
4483 arg = g_strdup(argv[i]);
4485 tmp = strchr(arg, '=');
4487 error_report("unrecognized operand %s", arg);
4494 for (j = 0; options[j].name != NULL; j++) {
4495 if (!strcmp(arg, options[j].name)) {
4499 if (options[j].name == NULL) {
4500 error_report("unrecognized operand %s", arg);
4505 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4509 dd.flags |= options[j].flag;
4514 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4515 error_report("Must specify both input and output files");
4520 if (qemu_opts_foreach(&qemu_object_opts,
4521 user_creatable_add_opts_foreach,
4522 NULL, &error_fatal)) {
4527 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
4535 drv = bdrv_find_format(out_fmt);
4537 error_report("Unknown file format");
4541 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4544 error_report_err(local_err);
4548 if (!drv->create_opts) {
4549 error_report("Format driver '%s' does not support image creation",
4554 if (!proto_drv->create_opts) {
4555 error_report("Protocol driver '%s' does not support image creation",
4556 proto_drv->format_name);
4560 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4561 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4563 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4565 size = blk_getlength(blk1);
4567 error_report("Failed to get size for '%s'", in.filename);
4572 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4573 dd.count * in.bsz < size) {
4574 size = dd.count * in.bsz;
4577 /* Overflow means the specified offset is beyond input image's size */
4578 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4579 size < in.bsz * in.offset)) {
4580 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4582 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4583 size - in.bsz * in.offset, &error_abort);
4586 ret = bdrv_create(drv, out.filename, opts, &local_err);
4588 error_reportf_err(local_err,
4589 "%s: error while creating output image: ",
4595 /* TODO, we can't honour --image-opts for the target,
4596 * since it needs to be given in a format compatible
4597 * with the bdrv_create() call above which does not
4598 * support image-opts style.
4600 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
4601 false, false, false);
4608 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4609 size < in.offset * in.bsz)) {
4610 /* We give a warning if the skip option is bigger than the input
4611 * size and create an empty output disk image (i.e. like dd(1)).
4613 error_report("%s: cannot skip to specified offset", in.filename);
4616 in_pos = in.offset * in.bsz;
4619 in.buf = g_new(uint8_t, in.bsz);
4621 for (out_pos = 0; in_pos < size; block_count++) {
4622 int in_ret, out_ret;
4624 if (in_pos + in.bsz > size) {
4625 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4627 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4630 error_report("error while reading from input image file: %s",
4637 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4640 error_report("error while writing to output image file: %s",
4641 strerror(-out_ret));
4650 qemu_opts_del(opts);
4651 qemu_opts_free(create_opts);
4654 g_free(in.filename);
4655 g_free(out.filename);
4665 static void dump_json_block_measure_info(BlockMeasureInfo *info)
4669 Visitor *v = qobject_output_visitor_new(&obj);
4671 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
4672 visit_complete(v, &obj);
4673 str = qobject_to_json_pretty(obj);
4674 assert(str != NULL);
4675 printf("%s\n", qstring_get_str(str));
4681 static int img_measure(int argc, char **argv)
4683 static const struct option long_options[] = {
4684 {"help", no_argument, 0, 'h'},
4685 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4686 {"object", required_argument, 0, OPTION_OBJECT},
4687 {"output", required_argument, 0, OPTION_OUTPUT},
4688 {"size", required_argument, 0, OPTION_SIZE},
4689 {"force-share", no_argument, 0, 'U'},
4692 OutputFormat output_format = OFORMAT_HUMAN;
4693 BlockBackend *in_blk = NULL;
4695 const char *filename = NULL;
4696 const char *fmt = NULL;
4697 const char *out_fmt = "raw";
4698 char *options = NULL;
4699 char *snapshot_name = NULL;
4700 bool force_share = false;
4701 QemuOpts *opts = NULL;
4702 QemuOpts *object_opts = NULL;
4703 QemuOpts *sn_opts = NULL;
4704 QemuOptsList *create_opts = NULL;
4705 bool image_opts = false;
4706 uint64_t img_size = UINT64_MAX;
4707 BlockMeasureInfo *info = NULL;
4708 Error *local_err = NULL;
4712 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
4713 long_options, NULL)) != -1) {
4726 if (!is_valid_option_list(optarg)) {
4727 error_report("Invalid option list: %s", optarg);
4731 options = g_strdup(optarg);
4733 char *old_options = options;
4734 options = g_strdup_printf("%s,%s", options, optarg);
4735 g_free(old_options);
4739 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
4740 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
4743 error_report("Failed in parsing snapshot param '%s'",
4748 snapshot_name = optarg;
4755 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
4761 case OPTION_IMAGE_OPTS:
4765 if (!strcmp(optarg, "json")) {
4766 output_format = OFORMAT_JSON;
4767 } else if (!strcmp(optarg, "human")) {
4768 output_format = OFORMAT_HUMAN;
4770 error_report("--output must be used with human or json "
4779 sval = cvtnum(optarg);
4781 if (sval == -ERANGE) {
4782 error_report("Image size must be less than 8 EiB!");
4784 error_report("Invalid image size specified! You may use "
4785 "k, M, G, T, P or E suffixes for ");
4786 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4787 "petabytes and exabytes.");
4791 img_size = (uint64_t)sval;
4797 if (qemu_opts_foreach(&qemu_object_opts,
4798 user_creatable_add_opts_foreach,
4799 NULL, &error_fatal)) {
4803 if (argc - optind > 1) {
4804 error_report("At most one filename argument is allowed.");
4806 } else if (argc - optind == 1) {
4807 filename = argv[optind];
4811 (object_opts || image_opts || fmt || snapshot_name || sn_opts)) {
4812 error_report("--object, --image-opts, -f, and -l "
4813 "require a filename argument.");
4816 if (filename && img_size != UINT64_MAX) {
4817 error_report("--size N cannot be used together with a filename.");
4820 if (!filename && img_size == UINT64_MAX) {
4821 error_report("Either --size N or one filename must be specified.");
4826 in_blk = img_open(image_opts, filename, fmt, 0,
4827 false, false, force_share);
4833 bdrv_snapshot_load_tmp(blk_bs(in_blk),
4834 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
4835 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
4837 } else if (snapshot_name != NULL) {
4838 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
4839 snapshot_name, &local_err);
4842 error_reportf_err(local_err, "Failed to load snapshot: ");
4847 drv = bdrv_find_format(out_fmt);
4849 error_report("Unknown file format '%s'", out_fmt);
4852 if (!drv->create_opts) {
4853 error_report("Format driver '%s' does not support image creation",
4858 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4859 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
4860 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4862 qemu_opts_do_parse(opts, options, NULL, &local_err);
4864 error_report_err(local_err);
4865 error_report("Invalid options for file format '%s'", out_fmt);
4869 if (img_size != UINT64_MAX) {
4870 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
4873 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
4875 error_report_err(local_err);
4879 if (output_format == OFORMAT_HUMAN) {
4880 printf("required size: %" PRIu64 "\n", info->required);
4881 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
4883 dump_json_block_measure_info(info);
4889 qapi_free_BlockMeasureInfo(info);
4890 qemu_opts_del(object_opts);
4891 qemu_opts_del(opts);
4892 qemu_opts_del(sn_opts);
4893 qemu_opts_free(create_opts);
4899 static const img_cmd_t img_cmds[] = {
4900 #define DEF(option, callback, arg_string) \
4901 { option, callback },
4902 #include "qemu-img-cmds.h"
4907 int main(int argc, char **argv)
4909 const img_cmd_t *cmd;
4910 const char *cmdname;
4911 Error *local_error = NULL;
4912 char *trace_file = NULL;
4914 static const struct option long_options[] = {
4915 {"help", no_argument, 0, 'h'},
4916 {"version", no_argument, 0, 'V'},
4917 {"trace", required_argument, NULL, 'T'},
4922 signal(SIGPIPE, SIG_IGN);
4925 module_call_init(MODULE_INIT_TRACE);
4926 error_set_progname(argv[0]);
4927 qemu_init_exec_dir(argv[0]);
4929 if (qemu_init_main_loop(&local_error)) {
4930 error_report_err(local_error);
4934 qcrypto_init(&error_fatal);
4936 module_call_init(MODULE_INIT_QOM);
4939 error_exit("Not enough arguments");
4942 qemu_add_opts(&qemu_object_opts);
4943 qemu_add_opts(&qemu_source_opts);
4944 qemu_add_opts(&qemu_trace_opts);
4946 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4949 missing_argument(argv[optind - 1]);
4952 unrecognized_option(argv[optind - 1]);
4958 printf(QEMU_IMG_VERSION);
4962 trace_file = trace_opt_parse(optarg);
4967 cmdname = argv[optind];
4969 /* reset getopt_long scanning */
4975 qemu_reset_optind();
4977 if (!trace_init_backends()) {
4980 trace_init_file(trace_file);
4981 qemu_set_log(LOG_TRACE);
4983 /* find the command */
4984 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4985 if (!strcmp(cmdname, cmd->name)) {
4986 return cmd->handler(argc, argv);
4991 error_exit("Command not found: %s", cmdname);