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
24 #include "qemu/osdep.h"
25 #include "qemu-version.h"
26 #include "qapi/error.h"
27 #include "qapi-visit.h"
28 #include "qapi/qobject-output-visitor.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qapi/qmp/qjson.h"
31 #include "qemu/cutils.h"
32 #include "qemu/config-file.h"
33 #include "qemu/option.h"
34 #include "qemu/error-report.h"
36 #include "qom/object_interfaces.h"
37 #include "sysemu/sysemu.h"
38 #include "sysemu/block-backend.h"
39 #include "block/block_int.h"
40 #include "block/blockjob.h"
41 #include "block/qapi.h"
42 #include "crypto/init.h"
43 #include "trace/control.h"
46 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
47 "\n" QEMU_COPYRIGHT "\n"
49 typedef struct img_cmd_t {
51 int (*handler)(int argc, char **argv);
56 OPTION_BACKING_CHAIN = 257,
58 OPTION_IMAGE_OPTS = 259,
60 OPTION_FLUSH_INTERVAL = 261,
61 OPTION_NO_DRAIN = 262,
64 typedef enum OutputFormat {
69 /* Default to cache=writeback as data integrity is not important for qemu-img */
70 #define BDRV_DEFAULT_CACHE "writeback"
72 static void format_print(void *opaque, const char *name)
77 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
81 error_printf("qemu-img: ");
84 error_vprintf(fmt, ap);
87 error_printf("\nTry 'qemu-img --help' for more information\n");
91 static void QEMU_NORETURN missing_argument(const char *option)
93 error_exit("missing argument for option '%s'", option);
96 static void QEMU_NORETURN unrecognized_option(const char *option)
98 error_exit("unrecognized option '%s'", option);
101 /* Please keep in synch with qemu-img.texi */
102 static void QEMU_NORETURN help(void)
104 const char *help_msg =
106 "usage: qemu-img [standard options] command [command options]\n"
107 "QEMU disk image utility\n"
109 " '-h', '--help' display this help and exit\n"
110 " '-V', '--version' output version information and exit\n"
111 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
112 " specify tracing options\n"
115 #define DEF(option, callback, arg_string) \
117 #include "qemu-img-cmds.h"
121 "Command parameters:\n"
122 " 'filename' is a disk image filename\n"
123 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
124 " manual page for a description of the object properties. The most common\n"
125 " object type is a 'secret', which is used to supply passwords and/or\n"
126 " encryption keys.\n"
127 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
128 " 'cache' is the cache mode used to write the output disk image, the valid\n"
129 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
130 " 'directsync' and 'unsafe' (default for convert)\n"
131 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
132 " options are the same as for the 'cache' option\n"
133 " 'size' is the disk image size in bytes. Optional suffixes\n"
134 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
135 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
136 " supported. 'b' is ignored.\n"
137 " 'output_filename' is the destination disk image filename\n"
138 " 'output_fmt' is the destination format\n"
139 " 'options' is a comma separated list of format specific options in a\n"
140 " name=value format. Use -o ? for an overview of the options supported by the\n"
142 " 'snapshot_param' is param used for internal snapshot, format\n"
143 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
145 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
147 " '-c' indicates that target image must be compressed (qcow format only)\n"
148 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
149 " match exactly. The image doesn't need a working backing file before\n"
150 " rebasing in this case (useful for renaming the backing file)\n"
151 " '-h' with or without a command shows this help and lists the supported formats\n"
152 " '-p' show progress of command (only certain commands)\n"
153 " '-q' use Quiet mode - do not print any output (except errors)\n"
154 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
155 " contain only zeros for qemu-img to create a sparse image during\n"
156 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
157 " unallocated or zero sectors, and the destination image will always be\n"
159 " '--output' takes the format in which the output must be done (human or json)\n"
160 " '-n' skips the target volume creation (useful if the volume is created\n"
161 " prior to running qemu-img)\n"
163 "Parameters to check subcommand:\n"
164 " '-r' tries to repair any inconsistencies that are found during the check.\n"
165 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
166 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
167 " hiding corruption that has already occurred.\n"
169 "Parameters to convert subcommand:\n"
170 " '-m' specifies how many coroutines work in parallel during the convert\n"
171 " process (defaults to 8)\n"
172 " '-W' allow to write to the target out of order rather than sequential\n"
174 "Parameters to snapshot subcommand:\n"
175 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
176 " '-a' applies a snapshot (revert disk to saved state)\n"
177 " '-c' creates a snapshot\n"
178 " '-d' deletes a snapshot\n"
179 " '-l' lists all snapshots in the given image\n"
181 "Parameters to compare subcommand:\n"
182 " '-f' first image format\n"
183 " '-F' second image format\n"
184 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
186 "Parameters to dd subcommand:\n"
187 " 'bs=BYTES' read and write up to BYTES bytes at a time "
189 " 'count=N' copy only N input blocks\n"
190 " 'if=FILE' read from FILE\n"
191 " 'of=FILE' write to FILE\n"
192 " 'skip=N' skip N bs-sized blocks at the start of input\n";
194 printf("%s\nSupported formats:", help_msg);
195 bdrv_iterate_format(format_print, NULL);
200 static QemuOptsList qemu_object_opts = {
202 .implied_opt_name = "qom-type",
203 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
209 static QemuOptsList qemu_source_opts = {
211 .implied_opt_name = "file",
212 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
218 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
224 ret = vprintf(fmt, args);
231 static int print_block_option_help(const char *filename, const char *fmt)
233 BlockDriver *drv, *proto_drv;
234 QemuOptsList *create_opts = NULL;
235 Error *local_err = NULL;
237 /* Find driver and parse its options */
238 drv = bdrv_find_format(fmt);
240 error_report("Unknown file format '%s'", fmt);
244 create_opts = qemu_opts_append(create_opts, drv->create_opts);
246 proto_drv = bdrv_find_protocol(filename, true, &local_err);
248 error_report_err(local_err);
249 qemu_opts_free(create_opts);
252 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
255 qemu_opts_print_help(create_opts);
256 qemu_opts_free(create_opts);
261 static int img_open_password(BlockBackend *blk, const char *filename,
262 int flags, bool quiet)
264 BlockDriverState *bs;
268 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
269 !(flags & BDRV_O_NO_IO)) {
270 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
271 if (qemu_read_password(password, sizeof(password)) < 0) {
272 error_report("No password given");
275 if (bdrv_set_key(bs, password) < 0) {
276 error_report("invalid password");
284 static BlockBackend *img_open_opts(const char *optstr,
285 QemuOpts *opts, int flags, bool writethrough,
289 Error *local_err = NULL;
291 options = qemu_opts_to_qdict(opts, NULL);
292 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
294 error_reportf_err(local_err, "Could not open '%s': ", optstr);
297 blk_set_enable_write_cache(blk, !writethrough);
299 if (img_open_password(blk, optstr, flags, quiet) < 0) {
306 static BlockBackend *img_open_file(const char *filename,
307 const char *fmt, int flags,
308 bool writethrough, bool quiet)
311 Error *local_err = NULL;
312 QDict *options = NULL;
315 options = qdict_new();
316 qdict_put(options, "driver", qstring_from_str(fmt));
319 blk = blk_new_open(filename, NULL, options, flags, &local_err);
321 error_reportf_err(local_err, "Could not open '%s': ", filename);
324 blk_set_enable_write_cache(blk, !writethrough);
326 if (img_open_password(blk, filename, flags, quiet) < 0) {
334 static BlockBackend *img_open(bool image_opts,
335 const char *filename,
336 const char *fmt, int flags, bool writethrough,
343 error_report("--image-opts and --format are mutually exclusive");
346 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
351 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
353 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
359 static int add_old_style_options(const char *fmt, QemuOpts *opts,
360 const char *base_filename,
361 const char *base_fmt)
366 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
368 error_report("Backing file not supported for file format '%s'",
375 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
377 error_report("Backing file format not supported for file "
386 static int64_t cvtnum(const char *s)
391 err = qemu_strtosz(s, NULL, &value);
395 if (value > INT64_MAX) {
401 static int img_create(int argc, char **argv)
404 uint64_t img_size = -1;
405 const char *fmt = "raw";
406 const char *base_fmt = NULL;
407 const char *filename;
408 const char *base_filename = NULL;
409 char *options = NULL;
410 Error *local_err = NULL;
414 static const struct option long_options[] = {
415 {"help", no_argument, 0, 'h'},
416 {"object", required_argument, 0, OPTION_OBJECT},
419 c = getopt_long(argc, argv, ":F:b:f:he6o:q",
426 missing_argument(argv[optind - 1]);
429 unrecognized_option(argv[optind - 1]);
438 base_filename = optarg;
444 error_report("option -e is deprecated, please use \'-o "
445 "encryption\' instead!");
448 error_report("option -6 is deprecated, please use \'-o "
449 "compat6\' instead!");
452 if (!is_valid_option_list(optarg)) {
453 error_report("Invalid option list: %s", optarg);
457 options = g_strdup(optarg);
459 char *old_options = options;
460 options = g_strdup_printf("%s,%s", options, optarg);
467 case OPTION_OBJECT: {
469 opts = qemu_opts_parse_noisily(&qemu_object_opts,
478 /* Get the filename */
479 filename = (optind < argc) ? argv[optind] : NULL;
480 if (options && has_help_option(options)) {
482 return print_block_option_help(filename, fmt);
485 if (optind >= argc) {
486 error_exit("Expecting image file name");
490 if (qemu_opts_foreach(&qemu_object_opts,
491 user_creatable_add_opts_foreach,
496 /* Get image size, if specified */
500 sval = cvtnum(argv[optind++]);
502 if (sval == -ERANGE) {
503 error_report("Image size must be less than 8 EiB!");
505 error_report("Invalid image size specified! You may use k, M, "
506 "G, T, P or E suffixes for ");
507 error_report("kilobytes, megabytes, gigabytes, terabytes, "
508 "petabytes and exabytes.");
512 img_size = (uint64_t)sval;
514 if (optind != argc) {
515 error_exit("Unexpected argument: %s", argv[optind]);
518 bdrv_img_create(filename, fmt, base_filename, base_fmt,
519 options, img_size, 0, quiet, &local_err);
521 error_reportf_err(local_err, "%s: ", filename);
533 static void dump_json_image_check(ImageCheck *check, bool quiet)
537 Visitor *v = qobject_output_visitor_new(&obj);
539 visit_type_ImageCheck(v, NULL, &check, &error_abort);
540 visit_complete(v, &obj);
541 str = qobject_to_json_pretty(obj);
543 qprintf(quiet, "%s\n", qstring_get_str(str));
549 static void dump_human_image_check(ImageCheck *check, bool quiet)
551 if (!(check->corruptions || check->leaks || check->check_errors)) {
552 qprintf(quiet, "No errors were found on the image.\n");
554 if (check->corruptions) {
555 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
556 "Data may be corrupted, or further writes to the image "
563 "\n%" PRId64 " leaked clusters were found on the image.\n"
564 "This means waste of disk space, but no harm to data.\n",
568 if (check->check_errors) {
571 " internal errors have occurred during the check.\n",
572 check->check_errors);
576 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
577 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
578 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
579 check->allocated_clusters, check->total_clusters,
580 check->allocated_clusters * 100.0 / check->total_clusters,
581 check->fragmented_clusters * 100.0 / check->allocated_clusters,
582 check->compressed_clusters * 100.0 /
583 check->allocated_clusters);
586 if (check->image_end_offset) {
588 "Image end offset: %" PRId64 "\n", check->image_end_offset);
592 static int collect_image_check(BlockDriverState *bs,
594 const char *filename,
599 BdrvCheckResult result;
601 ret = bdrv_check(bs, &result, fix);
606 check->filename = g_strdup(filename);
607 check->format = g_strdup(bdrv_get_format_name(bs));
608 check->check_errors = result.check_errors;
609 check->corruptions = result.corruptions;
610 check->has_corruptions = result.corruptions != 0;
611 check->leaks = result.leaks;
612 check->has_leaks = result.leaks != 0;
613 check->corruptions_fixed = result.corruptions_fixed;
614 check->has_corruptions_fixed = result.corruptions != 0;
615 check->leaks_fixed = result.leaks_fixed;
616 check->has_leaks_fixed = result.leaks != 0;
617 check->image_end_offset = result.image_end_offset;
618 check->has_image_end_offset = result.image_end_offset != 0;
619 check->total_clusters = result.bfi.total_clusters;
620 check->has_total_clusters = result.bfi.total_clusters != 0;
621 check->allocated_clusters = result.bfi.allocated_clusters;
622 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
623 check->fragmented_clusters = result.bfi.fragmented_clusters;
624 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
625 check->compressed_clusters = result.bfi.compressed_clusters;
626 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
632 * Checks an image for consistency. Exit codes:
634 * 0 - Check completed, image is good
635 * 1 - Check not completed because of internal errors
636 * 2 - Check completed, image is corrupted
637 * 3 - Check completed, image has leaked clusters, but is good otherwise
638 * 63 - Checks are not supported by the image format
640 static int img_check(int argc, char **argv)
643 OutputFormat output_format = OFORMAT_HUMAN;
644 const char *filename, *fmt, *output, *cache;
646 BlockDriverState *bs;
648 int flags = BDRV_O_CHECK;
652 bool image_opts = false;
656 cache = BDRV_DEFAULT_CACHE;
659 int option_index = 0;
660 static const struct option long_options[] = {
661 {"help", no_argument, 0, 'h'},
662 {"format", required_argument, 0, 'f'},
663 {"repair", required_argument, 0, 'r'},
664 {"output", required_argument, 0, OPTION_OUTPUT},
665 {"object", required_argument, 0, OPTION_OBJECT},
666 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
669 c = getopt_long(argc, argv, ":hf:r:T:q",
670 long_options, &option_index);
676 missing_argument(argv[optind - 1]);
679 unrecognized_option(argv[optind - 1]);
688 flags |= BDRV_O_RDWR;
690 if (!strcmp(optarg, "leaks")) {
691 fix = BDRV_FIX_LEAKS;
692 } else if (!strcmp(optarg, "all")) {
693 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
695 error_exit("Unknown option value for -r "
696 "(expecting 'leaks' or 'all'): %s", optarg);
708 case OPTION_OBJECT: {
710 opts = qemu_opts_parse_noisily(&qemu_object_opts,
716 case OPTION_IMAGE_OPTS:
721 if (optind != argc - 1) {
722 error_exit("Expecting one image file name");
724 filename = argv[optind++];
726 if (output && !strcmp(output, "json")) {
727 output_format = OFORMAT_JSON;
728 } else if (output && !strcmp(output, "human")) {
729 output_format = OFORMAT_HUMAN;
731 error_report("--output must be used with human or json as argument.");
735 if (qemu_opts_foreach(&qemu_object_opts,
736 user_creatable_add_opts_foreach,
741 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
743 error_report("Invalid source cache option: %s", cache);
747 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
753 check = g_new0(ImageCheck, 1);
754 ret = collect_image_check(bs, check, filename, fmt, fix);
756 if (ret == -ENOTSUP) {
757 error_report("This image format does not support checks");
762 if (check->corruptions_fixed || check->leaks_fixed) {
763 int corruptions_fixed, leaks_fixed;
765 leaks_fixed = check->leaks_fixed;
766 corruptions_fixed = check->corruptions_fixed;
768 if (output_format == OFORMAT_HUMAN) {
770 "The following inconsistencies were found and repaired:\n\n"
771 " %" PRId64 " leaked clusters\n"
772 " %" PRId64 " corruptions\n\n"
773 "Double checking the fixed image now...\n",
775 check->corruptions_fixed);
778 ret = collect_image_check(bs, check, filename, fmt, 0);
780 check->leaks_fixed = leaks_fixed;
781 check->corruptions_fixed = corruptions_fixed;
785 switch (output_format) {
787 dump_human_image_check(check, quiet);
790 dump_json_image_check(check, quiet);
795 if (ret || check->check_errors) {
797 error_report("Check failed: %s", strerror(-ret));
799 error_report("Check failed");
805 if (check->corruptions) {
807 } else if (check->leaks) {
814 qapi_free_ImageCheck(check);
819 typedef struct CommonBlockJobCBInfo {
820 BlockDriverState *bs;
822 } CommonBlockJobCBInfo;
824 static void common_block_job_cb(void *opaque, int ret)
826 CommonBlockJobCBInfo *cbi = opaque;
829 error_setg_errno(cbi->errp, -ret, "Block job failed");
833 static void run_block_job(BlockJob *job, Error **errp)
835 AioContext *aio_context = blk_get_aio_context(job->blk);
837 /* FIXME In error cases, the job simply goes away and we access a dangling
839 aio_context_acquire(aio_context);
841 aio_poll(aio_context, true);
842 qemu_progress_print(job->len ?
843 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
844 } while (!job->ready);
846 block_job_complete_sync(job, errp);
847 aio_context_release(aio_context);
849 /* A block job may finish instantaneously without publishing any progress,
850 * so just signal completion here */
851 qemu_progress_print(100.f, 0);
854 static int img_commit(int argc, char **argv)
857 const char *filename, *fmt, *cache, *base;
859 BlockDriverState *bs, *base_bs;
861 bool progress = false, quiet = false, drop = false;
863 Error *local_err = NULL;
864 CommonBlockJobCBInfo cbi;
865 bool image_opts = false;
866 AioContext *aio_context;
869 cache = BDRV_DEFAULT_CACHE;
872 static const struct option long_options[] = {
873 {"help", no_argument, 0, 'h'},
874 {"object", required_argument, 0, OPTION_OBJECT},
875 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
878 c = getopt_long(argc, argv, ":f:ht:b:dpq",
885 missing_argument(argv[optind - 1]);
888 unrecognized_option(argv[optind - 1]);
913 case OPTION_OBJECT: {
915 opts = qemu_opts_parse_noisily(&qemu_object_opts,
921 case OPTION_IMAGE_OPTS:
927 /* Progress is not shown in Quiet mode */
932 if (optind != argc - 1) {
933 error_exit("Expecting one image file name");
935 filename = argv[optind++];
937 if (qemu_opts_foreach(&qemu_object_opts,
938 user_creatable_add_opts_foreach,
943 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
944 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
946 error_report("Invalid cache option: %s", cache);
950 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
956 qemu_progress_init(progress, 1.f);
957 qemu_progress_print(0.f, 100);
960 base_bs = bdrv_find_backing_image(bs, base);
962 error_setg(&local_err,
963 "Did not find '%s' in the backing chain of '%s'",
968 /* This is different from QMP, which by default uses the deepest file in
969 * the backing chain (i.e., the very base); however, the traditional
970 * behavior of qemu-img commit is using the immediate backing file. */
971 base_bs = backing_bs(bs);
973 error_setg(&local_err, "Image does not have a backing file");
978 cbi = (CommonBlockJobCBInfo){
983 aio_context = bdrv_get_aio_context(bs);
984 aio_context_acquire(aio_context);
985 commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
986 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
987 &cbi, false, &local_err);
988 aio_context_release(aio_context);
993 /* When the block job completes, the BlockBackend reference will point to
994 * the old backing file. In order to avoid that the top image is already
995 * deleted, so we can still empty it afterwards, increment the reference
996 * counter here preemptively. */
1001 job = block_job_get("commit");
1002 run_block_job(job, &local_err);
1007 if (!drop && bs->drv->bdrv_make_empty) {
1008 ret = bs->drv->bdrv_make_empty(bs);
1010 error_setg_errno(&local_err, -ret, "Could not empty %s",
1022 qemu_progress_end();
1027 error_report_err(local_err);
1031 qprintf(quiet, "Image committed.\n");
1036 * Returns true iff the first sector pointed to by 'buf' contains at least
1039 * 'pnum' is set to the number of sectors (including and immediately following
1040 * the first one) that are known to be in the same allocated/unallocated state.
1042 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
1051 is_zero = buffer_is_zero(buf, 512);
1052 for(i = 1; i < n; i++) {
1054 if (is_zero != buffer_is_zero(buf, 512)) {
1063 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1064 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1065 * breaking up write requests for only small sparse areas.
1067 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1071 int num_checked, num_used;
1077 ret = is_allocated_sectors(buf, n, pnum);
1083 buf += BDRV_SECTOR_SIZE * *pnum;
1085 num_checked = num_used;
1088 ret = is_allocated_sectors(buf, n, pnum);
1090 buf += BDRV_SECTOR_SIZE * *pnum;
1092 num_checked += *pnum;
1094 num_used = num_checked;
1095 } else if (*pnum >= min) {
1105 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1106 * buffers matches, non-zero otherwise.
1108 * pnum is set to the number of sectors (including and immediately following
1109 * the first one) that are known to have the same comparison result
1111 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1122 res = !!memcmp(buf1, buf2, 512);
1123 for(i = 1; i < n; i++) {
1127 if (!!memcmp(buf1, buf2, 512) != res) {
1136 #define IO_BUF_SIZE (2 * 1024 * 1024)
1138 static int64_t sectors_to_bytes(int64_t sectors)
1140 return sectors << BDRV_SECTOR_BITS;
1143 static int64_t sectors_to_process(int64_t total, int64_t from)
1145 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1149 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1151 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1152 * data and negative value on error.
1154 * @param blk: BlockBackend for the image
1155 * @param sect_num: Number of first sector to check
1156 * @param sect_count: Number of sectors to check
1157 * @param filename: Name of disk file we are checking (logging purpose)
1158 * @param buffer: Allocated buffer for storing read data
1159 * @param quiet: Flag for quiet mode
1161 static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1162 int sect_count, const char *filename,
1163 uint8_t *buffer, bool quiet)
1166 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1167 sect_count << BDRV_SECTOR_BITS);
1169 error_report("Error while reading offset %" PRId64 " of %s: %s",
1170 sectors_to_bytes(sect_num), filename, strerror(-ret));
1173 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1174 if (ret || pnum != sect_count) {
1175 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1176 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1184 * Compares two images. Exit codes:
1186 * 0 - Images are identical
1188 * >1 - Error occurred
1190 static int img_compare(int argc, char **argv)
1192 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1193 BlockBackend *blk1, *blk2;
1194 BlockDriverState *bs1, *bs2;
1195 int64_t total_sectors1, total_sectors2;
1196 uint8_t *buf1 = NULL, *buf2 = NULL;
1198 int allocated1, allocated2;
1199 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1200 bool progress = false, quiet = false, strict = false;
1203 int64_t total_sectors;
1204 int64_t sector_num = 0;
1207 uint64_t progress_base;
1208 bool image_opts = false;
1210 cache = BDRV_DEFAULT_CACHE;
1212 static const struct option long_options[] = {
1213 {"help", no_argument, 0, 'h'},
1214 {"object", required_argument, 0, OPTION_OBJECT},
1215 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1218 c = getopt_long(argc, argv, ":hf:F:T:pqs",
1219 long_options, NULL);
1225 missing_argument(argv[optind - 1]);
1228 unrecognized_option(argv[optind - 1]);
1251 case OPTION_OBJECT: {
1253 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1260 case OPTION_IMAGE_OPTS:
1266 /* Progress is not shown in Quiet mode */
1272 if (optind != argc - 2) {
1273 error_exit("Expecting two image file names");
1275 filename1 = argv[optind++];
1276 filename2 = argv[optind++];
1278 if (qemu_opts_foreach(&qemu_object_opts,
1279 user_creatable_add_opts_foreach,
1285 /* Initialize before goto out */
1286 qemu_progress_init(progress, 2.0);
1289 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1291 error_report("Invalid source cache option: %s", cache);
1296 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1302 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1310 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1311 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1312 total_sectors1 = blk_nb_sectors(blk1);
1313 if (total_sectors1 < 0) {
1314 error_report("Can't get size of %s: %s",
1315 filename1, strerror(-total_sectors1));
1319 total_sectors2 = blk_nb_sectors(blk2);
1320 if (total_sectors2 < 0) {
1321 error_report("Can't get size of %s: %s",
1322 filename2, strerror(-total_sectors2));
1326 total_sectors = MIN(total_sectors1, total_sectors2);
1327 progress_base = MAX(total_sectors1, total_sectors2);
1329 qemu_progress_print(0, 100);
1331 if (strict && total_sectors1 != total_sectors2) {
1333 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1338 int64_t status1, status2;
1339 BlockDriverState *file;
1341 nb_sectors = sectors_to_process(total_sectors, sector_num);
1342 if (nb_sectors <= 0) {
1345 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1346 total_sectors1 - sector_num,
1350 error_report("Sector allocation test failed for %s", filename1);
1353 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1355 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1356 total_sectors2 - sector_num,
1360 error_report("Sector allocation test failed for %s", filename2);
1363 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1365 nb_sectors = MIN(nb_sectors, pnum1);
1368 nb_sectors = MIN(nb_sectors, pnum2);
1372 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1373 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1375 qprintf(quiet, "Strict mode: Offset %" PRId64
1376 " block status mismatch!\n",
1377 sectors_to_bytes(sector_num));
1381 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1382 nb_sectors = MIN(pnum1, pnum2);
1383 } else if (allocated1 == allocated2) {
1385 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1386 nb_sectors << BDRV_SECTOR_BITS);
1388 error_report("Error while reading offset %" PRId64 " of %s:"
1389 " %s", sectors_to_bytes(sector_num), filename1,
1394 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1395 nb_sectors << BDRV_SECTOR_BITS);
1397 error_report("Error while reading offset %" PRId64
1398 " of %s: %s", sectors_to_bytes(sector_num),
1399 filename2, strerror(-ret));
1403 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1404 if (ret || pnum != nb_sectors) {
1405 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1407 ret ? sector_num : sector_num + pnum));
1415 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1416 filename1, buf1, quiet);
1418 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1419 filename2, buf1, quiet);
1423 error_report("Error while reading offset %" PRId64 ": %s",
1424 sectors_to_bytes(sector_num), strerror(-ret));
1430 sector_num += nb_sectors;
1431 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1434 if (total_sectors1 != total_sectors2) {
1435 BlockBackend *blk_over;
1436 int64_t total_sectors_over;
1437 const char *filename_over;
1439 qprintf(quiet, "Warning: Image size mismatch!\n");
1440 if (total_sectors1 > total_sectors2) {
1441 total_sectors_over = total_sectors1;
1443 filename_over = filename1;
1445 total_sectors_over = total_sectors2;
1447 filename_over = filename2;
1451 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1452 if (nb_sectors <= 0) {
1455 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1459 error_report("Sector allocation test failed for %s",
1466 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1467 filename_over, buf1, quiet);
1470 error_report("Error while reading offset %" PRId64
1471 " of %s: %s", sectors_to_bytes(sector_num),
1472 filename_over, strerror(-ret));
1478 sector_num += nb_sectors;
1479 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1483 qprintf(quiet, "Images are identical.\n");
1493 qemu_progress_end();
1498 enum ImgConvertBlockStatus {
1504 #define MAX_COROUTINES 16
1506 typedef struct ImgConvertState {
1508 int64_t *src_sectors;
1510 int64_t total_sectors;
1511 int64_t allocated_sectors;
1512 int64_t allocated_done;
1515 enum ImgConvertBlockStatus status;
1516 int64_t sector_next_status;
1517 BlockBackend *target;
1520 bool target_has_backing;
1523 size_t cluster_sectors;
1525 long num_coroutines;
1526 int running_coroutines;
1527 Coroutine *co[MAX_COROUTINES];
1528 int64_t wait_sector_num[MAX_COROUTINES];
1533 static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1534 int *src_cur, int64_t *src_cur_offset)
1537 *src_cur_offset = 0;
1538 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1539 *src_cur_offset += s->src_sectors[*src_cur];
1541 assert(*src_cur < s->src_num);
1545 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1547 int64_t ret, src_cur_offset;
1550 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1552 assert(s->total_sectors > sector_num);
1553 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1555 if (s->sector_next_status <= sector_num) {
1556 BlockDriverState *file;
1557 if (s->target_has_backing) {
1558 ret = bdrv_get_block_status(blk_bs(s->src[src_cur]),
1559 sector_num - src_cur_offset,
1562 ret = bdrv_get_block_status_above(blk_bs(s->src[src_cur]), NULL,
1563 sector_num - src_cur_offset,
1570 if (ret & BDRV_BLOCK_ZERO) {
1571 s->status = BLK_ZERO;
1572 } else if (ret & BDRV_BLOCK_DATA) {
1573 s->status = BLK_DATA;
1575 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1578 s->sector_next_status = sector_num + n;
1581 n = MIN(n, s->sector_next_status - sector_num);
1582 if (s->status == BLK_DATA) {
1583 n = MIN(n, s->buf_sectors);
1586 /* We need to write complete clusters for compressed images, so if an
1587 * unallocated area is shorter than that, we must consider the whole
1588 * cluster allocated. */
1589 if (s->compressed) {
1590 if (n < s->cluster_sectors) {
1591 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1592 s->status = BLK_DATA;
1594 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1601 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1602 int nb_sectors, uint8_t *buf)
1608 assert(nb_sectors <= s->buf_sectors);
1609 while (nb_sectors > 0) {
1612 int64_t bs_sectors, src_cur_offset;
1614 /* In the case of compression with multiple source files, we can get a
1615 * nb_sectors that spreads into the next part. So we must be able to
1616 * read across multiple BDSes for one convert_read() call. */
1617 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1618 blk = s->src[src_cur];
1619 bs_sectors = s->src_sectors[src_cur];
1621 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1623 iov.iov_len = n << BDRV_SECTOR_BITS;
1624 qemu_iovec_init_external(&qiov, &iov, 1);
1626 ret = blk_co_preadv(
1627 blk, (sector_num - src_cur_offset) << BDRV_SECTOR_BITS,
1628 n << BDRV_SECTOR_BITS, &qiov, 0);
1635 buf += n * BDRV_SECTOR_SIZE;
1642 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1643 int nb_sectors, uint8_t *buf,
1644 enum ImgConvertBlockStatus status)
1650 while (nb_sectors > 0) {
1652 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1655 case BLK_BACKING_FILE:
1656 /* If we have a backing file, leave clusters unallocated that are
1657 * unallocated in the source image, so that the backing file is
1658 * visible at the respective offset. */
1659 assert(s->target_has_backing);
1663 /* If we're told to keep the target fully allocated (-S 0) or there
1664 * is real non-zero data, we must write it. Otherwise we can treat
1665 * it as zero sectors.
1666 * Compressed clusters need to be written as a whole, so in that
1667 * case we can only save the write if the buffer is completely
1669 if (!s->min_sparse ||
1671 is_allocated_sectors_min(buf, n, &n, s->min_sparse)) ||
1673 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1676 iov.iov_len = n << BDRV_SECTOR_BITS;
1677 qemu_iovec_init_external(&qiov, &iov, 1);
1679 ret = blk_co_pwritev(s->target, sector_num << BDRV_SECTOR_BITS,
1680 n << BDRV_SECTOR_BITS, &qiov, flags);
1689 if (s->has_zero_init) {
1690 assert(!s->target_has_backing);
1693 ret = blk_co_pwrite_zeroes(s->target,
1694 sector_num << BDRV_SECTOR_BITS,
1695 n << BDRV_SECTOR_BITS, 0);
1704 buf += n * BDRV_SECTOR_SIZE;
1710 static void coroutine_fn convert_co_do_copy(void *opaque)
1712 ImgConvertState *s = opaque;
1713 uint8_t *buf = NULL;
1717 for (i = 0; i < s->num_coroutines; i++) {
1718 if (s->co[i] == qemu_coroutine_self()) {
1725 s->running_coroutines++;
1726 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1731 enum ImgConvertBlockStatus status;
1733 qemu_co_mutex_lock(&s->lock);
1734 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1735 qemu_co_mutex_unlock(&s->lock);
1738 n = convert_iteration_sectors(s, s->sector_num);
1740 qemu_co_mutex_unlock(&s->lock);
1744 /* save current sector and allocation status to local variables */
1745 sector_num = s->sector_num;
1747 if (!s->min_sparse && s->status == BLK_ZERO) {
1748 n = MIN(n, s->buf_sectors);
1750 /* increment global sector counter so that other coroutines can
1751 * already continue reading beyond this request */
1753 qemu_co_mutex_unlock(&s->lock);
1755 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
1756 s->allocated_done += n;
1757 qemu_progress_print(100.0 * s->allocated_done /
1758 s->allocated_sectors, 0);
1761 if (status == BLK_DATA) {
1762 ret = convert_co_read(s, sector_num, n, buf);
1764 error_report("error while reading sector %" PRId64
1765 ": %s", sector_num, strerror(-ret));
1769 } else if (!s->min_sparse && status == BLK_ZERO) {
1771 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
1774 if (s->wr_in_order) {
1775 /* keep writes in order */
1776 while (s->wr_offs != sector_num) {
1777 if (s->ret != -EINPROGRESS) {
1780 s->wait_sector_num[index] = sector_num;
1781 qemu_coroutine_yield();
1783 s->wait_sector_num[index] = -1;
1786 ret = convert_co_write(s, sector_num, n, buf, status);
1788 error_report("error while writing sector %" PRId64
1789 ": %s", sector_num, strerror(-ret));
1794 if (s->wr_in_order) {
1795 /* reenter the coroutine that might have waited
1796 * for this write to complete */
1797 s->wr_offs = sector_num + n;
1798 for (i = 0; i < s->num_coroutines; i++) {
1799 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
1801 * A -> B -> A cannot occur because A has
1802 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1803 * B will never enter A during this time window.
1805 qemu_coroutine_enter(s->co[i]);
1814 s->co[index] = NULL;
1815 s->running_coroutines--;
1816 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
1817 /* the convert job finished successfully */
1822 static int convert_do_copy(ImgConvertState *s)
1825 int64_t sector_num = 0;
1827 /* Check whether we have zero initialisation or can get it efficiently */
1828 s->has_zero_init = s->min_sparse && !s->target_has_backing
1829 ? bdrv_has_zero_init(blk_bs(s->target))
1832 if (!s->has_zero_init && !s->target_has_backing &&
1833 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1835 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1837 s->has_zero_init = true;
1841 /* Allocate buffer for copied data. For compressed images, only one cluster
1842 * can be copied at a time. */
1843 if (s->compressed) {
1844 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1845 error_report("invalid cluster size");
1848 s->buf_sectors = s->cluster_sectors;
1851 while (sector_num < s->total_sectors) {
1852 n = convert_iteration_sectors(s, sector_num);
1856 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1858 s->allocated_sectors += n;
1864 s->sector_next_status = 0;
1865 s->ret = -EINPROGRESS;
1867 qemu_co_mutex_init(&s->lock);
1868 for (i = 0; i < s->num_coroutines; i++) {
1869 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
1870 s->wait_sector_num[i] = -1;
1871 qemu_coroutine_enter(s->co[i]);
1874 while (s->ret == -EINPROGRESS) {
1875 main_loop_wait(false);
1878 if (s->compressed && !s->ret) {
1879 /* signal EOF to align */
1880 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1889 static int img_convert(int argc, char **argv)
1891 int c, bs_i, flags, src_flags = 0;
1892 const char *fmt = NULL, *out_fmt = "raw", *cache = "unsafe",
1893 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
1894 *out_filename, *out_baseimg_param, *snapshot_name = NULL;
1895 BlockDriver *drv, *proto_drv;
1896 BlockDriverInfo bdi;
1897 BlockDriverState *out_bs;
1898 QemuOpts *opts = NULL, *sn_opts = NULL;
1899 QemuOptsList *create_opts = NULL;
1900 char *options = NULL;
1901 Error *local_err = NULL;
1902 bool writethrough, src_writethrough, quiet = false, image_opts = false,
1903 skip_create = false, progress = false;
1904 int64_t ret = -EINVAL;
1906 ImgConvertState s = (ImgConvertState) {
1907 /* Need at least 4k of zeros for sparse detection */
1909 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
1910 .wr_in_order = true,
1911 .num_coroutines = 8,
1915 static const struct option long_options[] = {
1916 {"help", no_argument, 0, 'h'},
1917 {"object", required_argument, 0, OPTION_OBJECT},
1918 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1921 c = getopt_long(argc, argv, ":hf:O:B:ce6o:s:l:S:pt:T:qnm:W",
1922 long_options, NULL);
1928 missing_argument(argv[optind - 1]);
1931 unrecognized_option(argv[optind - 1]);
1943 out_baseimg = optarg;
1946 s.compressed = true;
1949 error_report("option -e is deprecated, please use \'-o "
1950 "encryption\' instead!");
1953 error_report("option -6 is deprecated, please use \'-o "
1954 "compat6\' instead!");
1957 if (!is_valid_option_list(optarg)) {
1958 error_report("Invalid option list: %s", optarg);
1962 options = g_strdup(optarg);
1964 char *old_options = options;
1965 options = g_strdup_printf("%s,%s", options, optarg);
1966 g_free(old_options);
1970 snapshot_name = optarg;
1973 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1974 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1977 error_report("Failed in parsing snapshot param '%s'",
1982 snapshot_name = optarg;
1989 sval = cvtnum(optarg);
1991 error_report("Invalid minimum zero buffer size for sparse output specified");
1995 s.min_sparse = sval / BDRV_SECTOR_SIZE;
2014 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2015 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2016 error_report("Invalid number of coroutines. Allowed number of"
2017 " coroutines is between 1 and %d", MAX_COROUTINES);
2022 s.wr_in_order = false;
2024 case OPTION_OBJECT: {
2025 QemuOpts *object_opts;
2026 object_opts = qemu_opts_parse_noisily(&qemu_object_opts,
2033 case OPTION_IMAGE_OPTS:
2039 if (qemu_opts_foreach(&qemu_object_opts,
2040 user_creatable_add_opts_foreach,
2045 if (!s.wr_in_order && s.compressed) {
2046 error_report("Out of order write and compress are mutually exclusive");
2050 s.src_num = argc - optind - 1;
2051 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2053 if (options && has_help_option(options)) {
2054 ret = print_block_option_help(out_filename, out_fmt);
2058 if (s.src_num < 1) {
2059 error_report("Must specify image file name");
2064 /* ret is still -EINVAL until here */
2065 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2067 error_report("Invalid source cache option: %s", src_cache);
2071 /* Initialize before goto out */
2075 qemu_progress_init(progress, 1.0);
2076 qemu_progress_print(0, 100);
2078 s.src = g_new0(BlockBackend *, s.src_num);
2079 s.src_sectors = g_new(int64_t, s.src_num);
2081 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2082 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2083 fmt, src_flags, src_writethrough, quiet);
2088 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2089 if (s.src_sectors[bs_i] < 0) {
2090 error_report("Could not get size of %s: %s",
2091 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2095 s.total_sectors += s.src_sectors[bs_i];
2099 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2100 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2101 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2103 } else if (snapshot_name != NULL) {
2104 if (s.src_num > 1) {
2105 error_report("No support for concatenating multiple snapshot");
2110 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2114 error_reportf_err(local_err, "Failed to load snapshot: ");
2119 /* Find driver and parse its options */
2120 drv = bdrv_find_format(out_fmt);
2122 error_report("Unknown file format '%s'", out_fmt);
2127 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2129 error_report_err(local_err);
2135 if (!drv->create_opts) {
2136 error_report("Format driver '%s' does not support image creation",
2142 if (!proto_drv->create_opts) {
2143 error_report("Protocol driver '%s' does not support image creation",
2144 proto_drv->format_name);
2149 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2150 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2152 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2154 qemu_opts_do_parse(opts, options, NULL, &local_err);
2156 error_report_err(local_err);
2162 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, s.total_sectors * 512,
2164 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2170 /* Get backing file name if -o backing_file was used */
2171 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2172 if (out_baseimg_param) {
2173 out_baseimg = out_baseimg_param;
2175 s.target_has_backing = (bool) out_baseimg;
2177 if (s.src_num > 1 && out_baseimg) {
2178 error_report("Having a backing file for the target makes no sense when "
2179 "concatenating multiple input images");
2184 /* Check if compression is supported */
2187 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2188 const char *preallocation =
2189 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2191 if (!drv->bdrv_co_pwritev_compressed) {
2192 error_report("Compression not supported for this file format");
2198 error_report("Compression and encryption not supported at "
2205 && strcmp(preallocation, "off"))
2207 error_report("Compression and preallocation not supported at "
2215 /* Create the new image */
2216 ret = bdrv_create(drv, out_filename, opts, &local_err);
2218 error_reportf_err(local_err, "%s: error while converting %s: ",
2219 out_filename, out_fmt);
2224 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2225 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2227 error_report("Invalid cache option: %s", cache);
2231 /* XXX we should allow --image-opts to trigger use of
2232 * img_open() here, but then we have trouble with
2233 * the bdrv_create() call which takes different params.
2234 * Not critical right now, so fix can wait...
2236 s.target = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2241 out_bs = blk_bs(s.target);
2243 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2244 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2246 s.buf_sectors = MIN(32768,
2248 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2249 out_bs->bl.pdiscard_alignment >>
2250 BDRV_SECTOR_BITS)));
2253 int64_t output_sectors = blk_nb_sectors(s.target);
2254 if (output_sectors < 0) {
2255 error_report("unable to get output image length: %s",
2256 strerror(-output_sectors));
2259 } else if (output_sectors < s.total_sectors) {
2260 error_report("output file is smaller than input file");
2266 ret = bdrv_get_info(out_bs, &bdi);
2269 error_report("could not get block driver info");
2273 s.compressed = s.compressed || bdi.needs_compressed_writes;
2274 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2277 ret = convert_do_copy(&s);
2280 qemu_progress_print(100, 0);
2282 qemu_progress_end();
2283 qemu_opts_del(opts);
2284 qemu_opts_free(create_opts);
2285 qemu_opts_del(sn_opts);
2286 blk_unref(s.target);
2288 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2289 blk_unref(s.src[bs_i]);
2293 g_free(s.src_sectors);
2301 static void dump_snapshots(BlockDriverState *bs)
2303 QEMUSnapshotInfo *sn_tab, *sn;
2306 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2309 printf("Snapshot list:\n");
2310 bdrv_snapshot_dump(fprintf, stdout, NULL);
2312 for(i = 0; i < nb_sns; i++) {
2314 bdrv_snapshot_dump(fprintf, stdout, sn);
2320 static void dump_json_image_info_list(ImageInfoList *list)
2324 Visitor *v = qobject_output_visitor_new(&obj);
2326 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2327 visit_complete(v, &obj);
2328 str = qobject_to_json_pretty(obj);
2329 assert(str != NULL);
2330 printf("%s\n", qstring_get_str(str));
2331 qobject_decref(obj);
2336 static void dump_json_image_info(ImageInfo *info)
2340 Visitor *v = qobject_output_visitor_new(&obj);
2342 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2343 visit_complete(v, &obj);
2344 str = qobject_to_json_pretty(obj);
2345 assert(str != NULL);
2346 printf("%s\n", qstring_get_str(str));
2347 qobject_decref(obj);
2352 static void dump_human_image_info_list(ImageInfoList *list)
2354 ImageInfoList *elem;
2357 for (elem = list; elem; elem = elem->next) {
2363 bdrv_image_info_dump(fprintf, stdout, elem->value);
2367 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2369 return strcmp(a, b) == 0;
2373 * Open an image file chain and return an ImageInfoList
2375 * @filename: topmost image filename
2376 * @fmt: topmost image format (may be NULL to autodetect)
2377 * @chain: true - enumerate entire backing file chain
2378 * false - only topmost image file
2380 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2381 * image file. If there was an error a message will have been printed to
2384 static ImageInfoList *collect_image_info_list(bool image_opts,
2385 const char *filename,
2389 ImageInfoList *head = NULL;
2390 ImageInfoList **last = &head;
2391 GHashTable *filenames;
2394 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2398 BlockDriverState *bs;
2400 ImageInfoList *elem;
2402 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2403 error_report("Backing file '%s' creates an infinite loop.",
2407 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2409 blk = img_open(image_opts, filename, fmt,
2410 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2416 bdrv_query_image_info(bs, &info, &err);
2418 error_report_err(err);
2423 elem = g_new0(ImageInfoList, 1);
2430 filename = fmt = NULL;
2432 if (info->has_full_backing_filename) {
2433 filename = info->full_backing_filename;
2434 } else if (info->has_backing_filename) {
2435 error_report("Could not determine absolute backing filename,"
2436 " but backing filename '%s' present",
2437 info->backing_filename);
2440 if (info->has_backing_filename_format) {
2441 fmt = info->backing_filename_format;
2445 g_hash_table_destroy(filenames);
2449 qapi_free_ImageInfoList(head);
2450 g_hash_table_destroy(filenames);
2454 static int img_info(int argc, char **argv)
2457 OutputFormat output_format = OFORMAT_HUMAN;
2459 const char *filename, *fmt, *output;
2460 ImageInfoList *list;
2461 bool image_opts = false;
2466 int option_index = 0;
2467 static const struct option long_options[] = {
2468 {"help", no_argument, 0, 'h'},
2469 {"format", required_argument, 0, 'f'},
2470 {"output", required_argument, 0, OPTION_OUTPUT},
2471 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2472 {"object", required_argument, 0, OPTION_OBJECT},
2473 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2476 c = getopt_long(argc, argv, ":f:h",
2477 long_options, &option_index);
2483 missing_argument(argv[optind - 1]);
2486 unrecognized_option(argv[optind - 1]);
2497 case OPTION_BACKING_CHAIN:
2500 case OPTION_OBJECT: {
2502 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2508 case OPTION_IMAGE_OPTS:
2513 if (optind != argc - 1) {
2514 error_exit("Expecting one image file name");
2516 filename = argv[optind++];
2518 if (output && !strcmp(output, "json")) {
2519 output_format = OFORMAT_JSON;
2520 } else if (output && !strcmp(output, "human")) {
2521 output_format = OFORMAT_HUMAN;
2522 } else if (output) {
2523 error_report("--output must be used with human or json as argument.");
2527 if (qemu_opts_foreach(&qemu_object_opts,
2528 user_creatable_add_opts_foreach,
2533 list = collect_image_info_list(image_opts, filename, fmt, chain);
2538 switch (output_format) {
2540 dump_human_image_info_list(list);
2544 dump_json_image_info_list(list);
2546 dump_json_image_info(list->value);
2551 qapi_free_ImageInfoList(list);
2555 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2558 switch (output_format) {
2560 if (e->data && !e->has_offset) {
2561 error_report("File contains external, encrypted or compressed clusters.");
2564 if (e->data && !e->zero) {
2565 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2566 e->start, e->length,
2567 e->has_offset ? e->offset : 0,
2568 e->has_filename ? e->filename : "");
2570 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2571 * Modify the flags here to allow more coalescing.
2573 if (next && (!next->data || next->zero)) {
2579 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2580 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2581 (e->start == 0 ? "[" : ",\n"),
2582 e->start, e->length, e->depth,
2583 e->zero ? "true" : "false",
2584 e->data ? "true" : "false");
2585 if (e->has_offset) {
2586 printf(", \"offset\": %"PRId64"", e->offset);
2597 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2598 int nb_sectors, MapEntry *e)
2602 BlockDriverState *file;
2605 /* As an optimization, we could cache the current range of unallocated
2606 * clusters in each file of the chain, and avoid querying the same
2612 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2618 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2621 bs = backing_bs(bs);
2630 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2633 .start = sector_num * BDRV_SECTOR_SIZE,
2634 .length = nb_sectors * BDRV_SECTOR_SIZE,
2635 .data = !!(ret & BDRV_BLOCK_DATA),
2636 .zero = !!(ret & BDRV_BLOCK_ZERO),
2637 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2638 .has_offset = has_offset,
2640 .has_filename = file && has_offset,
2641 .filename = file && has_offset ? file->filename : NULL,
2647 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2649 if (curr->length == 0) {
2652 if (curr->zero != next->zero ||
2653 curr->data != next->data ||
2654 curr->depth != next->depth ||
2655 curr->has_filename != next->has_filename ||
2656 curr->has_offset != next->has_offset) {
2659 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2662 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2668 static int img_map(int argc, char **argv)
2671 OutputFormat output_format = OFORMAT_HUMAN;
2673 BlockDriverState *bs;
2674 const char *filename, *fmt, *output;
2676 MapEntry curr = { .length = 0 }, next;
2678 bool image_opts = false;
2683 int option_index = 0;
2684 static const struct option long_options[] = {
2685 {"help", no_argument, 0, 'h'},
2686 {"format", required_argument, 0, 'f'},
2687 {"output", required_argument, 0, OPTION_OUTPUT},
2688 {"object", required_argument, 0, OPTION_OBJECT},
2689 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2692 c = getopt_long(argc, argv, ":f:h",
2693 long_options, &option_index);
2699 missing_argument(argv[optind - 1]);
2702 unrecognized_option(argv[optind - 1]);
2713 case OPTION_OBJECT: {
2715 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2721 case OPTION_IMAGE_OPTS:
2726 if (optind != argc - 1) {
2727 error_exit("Expecting one image file name");
2729 filename = argv[optind];
2731 if (output && !strcmp(output, "json")) {
2732 output_format = OFORMAT_JSON;
2733 } else if (output && !strcmp(output, "human")) {
2734 output_format = OFORMAT_HUMAN;
2735 } else if (output) {
2736 error_report("--output must be used with human or json as argument.");
2740 if (qemu_opts_foreach(&qemu_object_opts,
2741 user_creatable_add_opts_foreach,
2746 blk = img_open(image_opts, filename, fmt, 0, false, false);
2752 if (output_format == OFORMAT_HUMAN) {
2753 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2756 length = blk_getlength(blk);
2757 while (curr.start + curr.length < length) {
2758 int64_t nsectors_left;
2762 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2764 /* Probe up to 1 GiB at a time. */
2765 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2766 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2767 ret = get_block_status(bs, sector_num, n, &next);
2770 error_report("Could not read file metadata: %s", strerror(-ret));
2774 if (entry_mergeable(&curr, &next)) {
2775 curr.length += next.length;
2779 if (curr.length > 0) {
2780 dump_map_entry(output_format, &curr, &next);
2785 dump_map_entry(output_format, &curr, NULL);
2792 #define SNAPSHOT_LIST 1
2793 #define SNAPSHOT_CREATE 2
2794 #define SNAPSHOT_APPLY 3
2795 #define SNAPSHOT_DELETE 4
2797 static int img_snapshot(int argc, char **argv)
2800 BlockDriverState *bs;
2801 QEMUSnapshotInfo sn;
2802 char *filename, *snapshot_name = NULL;
2803 int c, ret = 0, bdrv_oflags;
2808 bool image_opts = false;
2810 bdrv_oflags = BDRV_O_RDWR;
2811 /* Parse commandline parameters */
2813 static const struct option long_options[] = {
2814 {"help", no_argument, 0, 'h'},
2815 {"object", required_argument, 0, OPTION_OBJECT},
2816 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2819 c = getopt_long(argc, argv, ":la:c:d:hq",
2820 long_options, NULL);
2826 missing_argument(argv[optind - 1]);
2829 unrecognized_option(argv[optind - 1]);
2836 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2839 action = SNAPSHOT_LIST;
2840 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2844 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2847 action = SNAPSHOT_APPLY;
2848 snapshot_name = optarg;
2852 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2855 action = SNAPSHOT_CREATE;
2856 snapshot_name = optarg;
2860 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2863 action = SNAPSHOT_DELETE;
2864 snapshot_name = optarg;
2869 case OPTION_OBJECT: {
2871 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2877 case OPTION_IMAGE_OPTS:
2883 if (optind != argc - 1) {
2884 error_exit("Expecting one image file name");
2886 filename = argv[optind++];
2888 if (qemu_opts_foreach(&qemu_object_opts,
2889 user_creatable_add_opts_foreach,
2894 /* Open the image */
2895 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2901 /* Perform the requested action */
2907 case SNAPSHOT_CREATE:
2908 memset(&sn, 0, sizeof(sn));
2909 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2911 qemu_gettimeofday(&tv);
2912 sn.date_sec = tv.tv_sec;
2913 sn.date_nsec = tv.tv_usec * 1000;
2915 ret = bdrv_snapshot_create(bs, &sn);
2917 error_report("Could not create snapshot '%s': %d (%s)",
2918 snapshot_name, ret, strerror(-ret));
2922 case SNAPSHOT_APPLY:
2923 ret = bdrv_snapshot_goto(bs, snapshot_name);
2925 error_report("Could not apply snapshot '%s': %d (%s)",
2926 snapshot_name, ret, strerror(-ret));
2930 case SNAPSHOT_DELETE:
2931 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2933 error_reportf_err(err, "Could not delete snapshot '%s': ",
2948 static int img_rebase(int argc, char **argv)
2950 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2951 uint8_t *buf_old = NULL;
2952 uint8_t *buf_new = NULL;
2953 BlockDriverState *bs = NULL;
2955 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2956 int c, flags, src_flags, ret;
2957 bool writethrough, src_writethrough;
2961 Error *local_err = NULL;
2962 bool image_opts = false;
2964 /* Parse commandline parameters */
2966 cache = BDRV_DEFAULT_CACHE;
2967 src_cache = BDRV_DEFAULT_CACHE;
2971 static const struct option long_options[] = {
2972 {"help", no_argument, 0, 'h'},
2973 {"object", required_argument, 0, OPTION_OBJECT},
2974 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2977 c = getopt_long(argc, argv, ":hf:F:b:upt:T:q",
2978 long_options, NULL);
2984 missing_argument(argv[optind - 1]);
2987 unrecognized_option(argv[optind - 1]);
2996 out_basefmt = optarg;
2999 out_baseimg = optarg;
3016 case OPTION_OBJECT: {
3018 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3024 case OPTION_IMAGE_OPTS:
3034 if (optind != argc - 1) {
3035 error_exit("Expecting one image file name");
3037 if (!unsafe && !out_baseimg) {
3038 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3040 filename = argv[optind++];
3042 if (qemu_opts_foreach(&qemu_object_opts,
3043 user_creatable_add_opts_foreach,
3048 qemu_progress_init(progress, 2.0);
3049 qemu_progress_print(0, 100);
3051 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3052 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3054 error_report("Invalid cache option: %s", cache);
3059 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3061 error_report("Invalid source cache option: %s", src_cache);
3065 /* The source files are opened read-only, don't care about WCE */
3066 assert((src_flags & BDRV_O_RDWR) == 0);
3067 (void) src_writethrough;
3072 * Ignore the old backing file for unsafe rebase in case we want to correct
3073 * the reference to a renamed or moved backing file.
3075 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3082 if (out_basefmt != NULL) {
3083 if (bdrv_find_format(out_basefmt) == NULL) {
3084 error_report("Invalid format name: '%s'", out_basefmt);
3090 /* For safe rebasing we need to compare old and new backing file */
3092 char backing_name[PATH_MAX];
3093 QDict *options = NULL;
3095 if (bs->backing_format[0] != '\0') {
3096 options = qdict_new();
3097 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
3100 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3101 blk_old_backing = blk_new_open(backing_name, NULL,
3102 options, src_flags, &local_err);
3103 if (!blk_old_backing) {
3104 error_reportf_err(local_err,
3105 "Could not open old backing file '%s': ",
3111 if (out_baseimg[0]) {
3113 options = qdict_new();
3114 qdict_put(options, "driver", qstring_from_str(out_basefmt));
3119 blk_new_backing = blk_new_open(out_baseimg, NULL,
3120 options, src_flags, &local_err);
3121 if (!blk_new_backing) {
3122 error_reportf_err(local_err,
3123 "Could not open new backing file '%s': ",
3132 * Check each unallocated cluster in the COW file. If it is unallocated,
3133 * accesses go to the backing file. We must therefore compare this cluster
3134 * in the old and new backing file, and if they differ we need to copy it
3135 * from the old backing file into the COW file.
3137 * If qemu-img crashes during this step, no harm is done. The content of
3138 * the image is the same as the original one at any time.
3141 int64_t num_sectors;
3142 int64_t old_backing_num_sectors;
3143 int64_t new_backing_num_sectors = 0;
3146 float local_progress = 0;
3148 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3149 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3151 num_sectors = blk_nb_sectors(blk);
3152 if (num_sectors < 0) {
3153 error_report("Could not get size of '%s': %s",
3154 filename, strerror(-num_sectors));
3158 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3159 if (old_backing_num_sectors < 0) {
3160 char backing_name[PATH_MAX];
3162 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3163 error_report("Could not get size of '%s': %s",
3164 backing_name, strerror(-old_backing_num_sectors));
3168 if (blk_new_backing) {
3169 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3170 if (new_backing_num_sectors < 0) {
3171 error_report("Could not get size of '%s': %s",
3172 out_baseimg, strerror(-new_backing_num_sectors));
3178 if (num_sectors != 0) {
3179 local_progress = (float)100 /
3180 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3183 for (sector = 0; sector < num_sectors; sector += n) {
3185 /* How many sectors can we handle with the next read? */
3186 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3187 n = (IO_BUF_SIZE / 512);
3189 n = num_sectors - sector;
3192 /* If the cluster is allocated, we don't need to take action */
3193 ret = bdrv_is_allocated(bs, sector, n, &n);
3195 error_report("error while reading image metadata: %s",
3204 * Read old and new backing file and take into consideration that
3205 * backing files may be smaller than the COW image.
3207 if (sector >= old_backing_num_sectors) {
3208 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3210 if (sector + n > old_backing_num_sectors) {
3211 n = old_backing_num_sectors - sector;
3214 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3215 buf_old, n << BDRV_SECTOR_BITS);
3217 error_report("error while reading from old backing file");
3222 if (sector >= new_backing_num_sectors || !blk_new_backing) {
3223 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3225 if (sector + n > new_backing_num_sectors) {
3226 n = new_backing_num_sectors - sector;
3229 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3230 buf_new, n << BDRV_SECTOR_BITS);
3232 error_report("error while reading from new backing file");
3237 /* If they differ, we need to write to the COW file */
3238 uint64_t written = 0;
3240 while (written < n) {
3243 if (compare_sectors(buf_old + written * 512,
3244 buf_new + written * 512, n - written, &pnum))
3246 ret = blk_pwrite(blk,
3247 (sector + written) << BDRV_SECTOR_BITS,
3248 buf_old + written * 512,
3249 pnum << BDRV_SECTOR_BITS, 0);
3251 error_report("Error while writing to COW image: %s",
3259 qemu_progress_print(local_progress, 100);
3264 * Change the backing file. All clusters that are different from the old
3265 * backing file are overwritten in the COW file now, so the visible content
3266 * doesn't change when we switch the backing file.
3268 if (out_baseimg && *out_baseimg) {
3269 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3271 ret = bdrv_change_backing_file(bs, NULL, NULL);
3274 if (ret == -ENOSPC) {
3275 error_report("Could not change the backing file to '%s': No "
3276 "space left in the file header", out_baseimg);
3277 } else if (ret < 0) {
3278 error_report("Could not change the backing file to '%s': %s",
3279 out_baseimg, strerror(-ret));
3282 qemu_progress_print(100, 0);
3284 * TODO At this point it is possible to check if any clusters that are
3285 * allocated in the COW file are the same in the backing file. If so, they
3286 * could be dropped from the COW file. Don't do this before switching the
3287 * backing file, in case of a crash this would lead to corruption.
3290 qemu_progress_end();
3293 blk_unref(blk_old_backing);
3294 blk_unref(blk_new_backing);
3296 qemu_vfree(buf_old);
3297 qemu_vfree(buf_new);
3306 static int img_resize(int argc, char **argv)
3309 int c, ret, relative;
3310 const char *filename, *fmt, *size;
3311 int64_t n, total_size;
3313 BlockBackend *blk = NULL;
3316 static QemuOptsList resize_options = {
3317 .name = "resize_options",
3318 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3321 .name = BLOCK_OPT_SIZE,
3322 .type = QEMU_OPT_SIZE,
3323 .help = "Virtual disk size"
3329 bool image_opts = false;
3331 /* Remove size from argv manually so that negative numbers are not treated
3332 * as options by getopt. */
3334 error_exit("Not enough arguments");
3338 size = argv[--argc];
3340 /* Parse getopt arguments */
3343 static const struct option long_options[] = {
3344 {"help", no_argument, 0, 'h'},
3345 {"object", required_argument, 0, OPTION_OBJECT},
3346 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3349 c = getopt_long(argc, argv, ":f:hq",
3350 long_options, NULL);
3356 missing_argument(argv[optind - 1]);
3359 unrecognized_option(argv[optind - 1]);
3370 case OPTION_OBJECT: {
3372 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3378 case OPTION_IMAGE_OPTS:
3383 if (optind != argc - 1) {
3384 error_exit("Expecting one image file name");
3386 filename = argv[optind++];
3388 if (qemu_opts_foreach(&qemu_object_opts,
3389 user_creatable_add_opts_foreach,
3394 /* Choose grow, shrink, or absolute resize mode */
3410 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3411 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3413 error_report_err(err);
3415 qemu_opts_del(param);
3418 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3419 qemu_opts_del(param);
3421 blk = img_open(image_opts, filename, fmt,
3422 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet);
3429 total_size = blk_getlength(blk) + n * relative;
3433 if (total_size <= 0) {
3434 error_report("New image size must be positive");
3439 ret = blk_truncate(blk, total_size, &err);
3441 qprintf(quiet, "Image resized.\n");
3443 error_report_err(err);
3453 static void amend_status_cb(BlockDriverState *bs,
3454 int64_t offset, int64_t total_work_size,
3457 qemu_progress_print(100.f * offset / total_work_size, 0);
3460 static int img_amend(int argc, char **argv)
3464 char *options = NULL;
3465 QemuOptsList *create_opts = NULL;
3466 QemuOpts *opts = NULL;
3467 const char *fmt = NULL, *filename, *cache;
3470 bool quiet = false, progress = false;
3471 BlockBackend *blk = NULL;
3472 BlockDriverState *bs = NULL;
3473 bool image_opts = false;
3475 cache = BDRV_DEFAULT_CACHE;
3477 static const struct option long_options[] = {
3478 {"help", no_argument, 0, 'h'},
3479 {"object", required_argument, 0, OPTION_OBJECT},
3480 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3483 c = getopt_long(argc, argv, ":ho:f:t:pq",
3484 long_options, NULL);
3491 missing_argument(argv[optind - 1]);
3494 unrecognized_option(argv[optind - 1]);
3500 if (!is_valid_option_list(optarg)) {
3501 error_report("Invalid option list: %s", optarg);
3503 goto out_no_progress;
3506 options = g_strdup(optarg);
3508 char *old_options = options;
3509 options = g_strdup_printf("%s,%s", options, optarg);
3510 g_free(old_options);
3526 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3530 goto out_no_progress;
3533 case OPTION_IMAGE_OPTS:
3540 error_exit("Must specify options (-o)");
3543 if (qemu_opts_foreach(&qemu_object_opts,
3544 user_creatable_add_opts_foreach,
3547 goto out_no_progress;
3553 qemu_progress_init(progress, 1.0);
3555 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3556 if (fmt && has_help_option(options)) {
3557 /* If a format is explicitly specified (and possibly no filename is
3558 * given), print option help here */
3559 ret = print_block_option_help(filename, fmt);
3563 if (optind != argc - 1) {
3564 error_report("Expecting one image file name");
3569 flags = BDRV_O_RDWR;
3570 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3572 error_report("Invalid cache option: %s", cache);
3576 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3583 fmt = bs->drv->format_name;
3585 if (has_help_option(options)) {
3586 /* If the format was auto-detected, print option help here */
3587 ret = print_block_option_help(filename, fmt);
3591 if (!bs->drv->create_opts) {
3592 error_report("Format driver '%s' does not support any options to amend",
3598 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3599 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3600 qemu_opts_do_parse(opts, options, NULL, &err);
3602 error_report_err(err);
3607 /* In case the driver does not call amend_status_cb() */
3608 qemu_progress_print(0.f, 0);
3609 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3610 qemu_progress_print(100.f, 0);
3612 error_report("Error while amending options: %s", strerror(-ret));
3617 qemu_progress_end();
3621 qemu_opts_del(opts);
3622 qemu_opts_free(create_opts);
3631 typedef struct BenchData {
3633 uint64_t image_size;
3640 bool drain_on_flush;
3649 static void bench_undrained_flush_cb(void *opaque, int ret)
3652 error_report("Failed flush request: %s", strerror(-ret));
3657 static void bench_cb(void *opaque, int ret)
3659 BenchData *b = opaque;
3663 error_report("Failed request: %s", strerror(-ret));
3668 /* Just finished a flush with drained queue: Start next requests */
3669 assert(b->in_flight == 0);
3670 b->in_flush = false;
3671 } else if (b->in_flight > 0) {
3672 int remaining = b->n - b->in_flight;
3677 /* Time for flush? Drain queue if requested, then flush */
3678 if (b->flush_interval && remaining % b->flush_interval == 0) {
3679 if (!b->in_flight || !b->drain_on_flush) {
3680 BlockCompletionFunc *cb;
3682 if (b->drain_on_flush) {
3686 cb = bench_undrained_flush_cb;
3689 acb = blk_aio_flush(b->blk, cb, b);
3691 error_report("Failed to issue flush request");
3695 if (b->drain_on_flush) {
3701 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3702 int64_t offset = b->offset;
3703 /* blk_aio_* might look for completed I/Os and kick bench_cb
3704 * again, so make sure this operation is counted by in_flight
3705 * and b->offset is ready for the next submission.
3708 b->offset += b->step;
3709 b->offset %= b->image_size;
3711 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
3713 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
3716 error_report("Failed to issue request");
3722 static int img_bench(int argc, char **argv)
3725 const char *fmt = NULL, *filename;
3727 bool image_opts = false;
3728 bool is_write = false;
3732 size_t bufsize = 4096;
3735 int flush_interval = 0;
3736 bool drain_on_flush = true;
3738 BlockBackend *blk = NULL;
3739 BenchData data = {};
3741 bool writethrough = false;
3742 struct timeval t1, t2;
3746 static const struct option long_options[] = {
3747 {"help", no_argument, 0, 'h'},
3748 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
3749 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3750 {"pattern", required_argument, 0, OPTION_PATTERN},
3751 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
3754 c = getopt_long(argc, argv, ":hc:d:f:no:qs:S:t:w", long_options, NULL);
3761 missing_argument(argv[optind - 1]);
3764 unrecognized_option(argv[optind - 1]);
3773 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3774 error_report("Invalid request count specified");
3784 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3785 error_report("Invalid queue depth specified");
3795 flags |= BDRV_O_NATIVE_AIO;
3799 offset = cvtnum(optarg);
3801 error_report("Invalid offset specified");
3814 sval = cvtnum(optarg);
3815 if (sval < 0 || sval > INT_MAX) {
3816 error_report("Invalid buffer size specified");
3827 sval = cvtnum(optarg);
3828 if (sval < 0 || sval > INT_MAX) {
3829 error_report("Invalid step size specified");
3837 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
3839 error_report("Invalid cache mode");
3845 flags |= BDRV_O_RDWR;
3848 case OPTION_PATTERN:
3852 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
3853 error_report("Invalid pattern byte specified");
3859 case OPTION_FLUSH_INTERVAL:
3863 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
3864 error_report("Invalid flush interval specified");
3867 flush_interval = res;
3870 case OPTION_NO_DRAIN:
3871 drain_on_flush = false;
3873 case OPTION_IMAGE_OPTS:
3879 if (optind != argc - 1) {
3880 error_exit("Expecting one image file name");
3882 filename = argv[argc - 1];
3884 if (!is_write && flush_interval) {
3885 error_report("--flush-interval is only available in write tests");
3889 if (flush_interval && flush_interval < depth) {
3890 error_report("Flush interval can't be smaller than depth");
3895 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3901 image_size = blk_getlength(blk);
3902 if (image_size < 0) {
3907 data = (BenchData) {
3909 .image_size = image_size,
3911 .step = step ?: bufsize,
3916 .flush_interval = flush_interval,
3917 .drain_on_flush = drain_on_flush,
3919 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3920 "(starting at offset %" PRId64 ", step size %d)\n",
3921 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3922 data.offset, data.step);
3923 if (flush_interval) {
3924 printf("Sending flush every %d requests\n", flush_interval);
3927 data.buf = blk_blockalign(blk, data.nrreq * data.bufsize);
3928 memset(data.buf, pattern, data.nrreq * data.bufsize);
3930 data.qiov = g_new(QEMUIOVector, data.nrreq);
3931 for (i = 0; i < data.nrreq; i++) {
3932 qemu_iovec_init(&data.qiov[i], 1);
3933 qemu_iovec_add(&data.qiov[i],
3934 data.buf + i * data.bufsize, data.bufsize);
3937 gettimeofday(&t1, NULL);
3940 while (data.n > 0) {
3941 main_loop_wait(false);
3943 gettimeofday(&t2, NULL);
3945 printf("Run completed in %3.3f seconds.\n",
3946 (t2.tv_sec - t1.tv_sec)
3947 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
3950 qemu_vfree(data.buf);
3971 int bsz; /* Block size */
3979 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
3983 static int img_dd_bs(const char *arg,
3984 struct DdIo *in, struct DdIo *out,
3991 if (res <= 0 || res > INT_MAX) {
3992 error_report("invalid number: '%s'", arg);
3995 in->bsz = out->bsz = res;
4000 static int img_dd_count(const char *arg,
4001 struct DdIo *in, struct DdIo *out,
4004 dd->count = cvtnum(arg);
4006 if (dd->count < 0) {
4007 error_report("invalid number: '%s'", arg);
4014 static int img_dd_if(const char *arg,
4015 struct DdIo *in, struct DdIo *out,
4018 in->filename = g_strdup(arg);
4023 static int img_dd_of(const char *arg,
4024 struct DdIo *in, struct DdIo *out,
4027 out->filename = g_strdup(arg);
4032 static int img_dd_skip(const char *arg,
4033 struct DdIo *in, struct DdIo *out,
4036 in->offset = cvtnum(arg);
4038 if (in->offset < 0) {
4039 error_report("invalid number: '%s'", arg);
4046 static int img_dd(int argc, char **argv)
4051 BlockDriver *drv = NULL, *proto_drv = NULL;
4052 BlockBackend *blk1 = NULL, *blk2 = NULL;
4053 QemuOpts *opts = NULL;
4054 QemuOptsList *create_opts = NULL;
4055 Error *local_err = NULL;
4056 bool image_opts = false;
4058 const char *out_fmt = "raw";
4059 const char *fmt = NULL;
4061 int64_t block_count = 0, out_pos, in_pos;
4062 struct DdInfo dd = {
4067 .bsz = 512, /* Block size is by default 512 bytes */
4079 const struct DdOpts options[] = {
4080 { "bs", img_dd_bs, C_BS },
4081 { "count", img_dd_count, C_COUNT },
4082 { "if", img_dd_if, C_IF },
4083 { "of", img_dd_of, C_OF },
4084 { "skip", img_dd_skip, C_SKIP },
4087 const struct option long_options[] = {
4088 { "help", no_argument, 0, 'h'},
4089 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4093 while ((c = getopt_long(argc, argv, ":hf:O:", long_options, NULL))) {
4105 missing_argument(argv[optind - 1]);
4108 unrecognized_option(argv[optind - 1]);
4113 case OPTION_IMAGE_OPTS:
4119 for (i = optind; i < argc; i++) {
4121 arg = g_strdup(argv[i]);
4123 tmp = strchr(arg, '=');
4125 error_report("unrecognized operand %s", arg);
4132 for (j = 0; options[j].name != NULL; j++) {
4133 if (!strcmp(arg, options[j].name)) {
4137 if (options[j].name == NULL) {
4138 error_report("unrecognized operand %s", arg);
4143 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4147 dd.flags |= options[j].flag;
4152 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4153 error_report("Must specify both input and output files");
4157 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);
4164 drv = bdrv_find_format(out_fmt);
4166 error_report("Unknown file format");
4170 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4173 error_report_err(local_err);
4177 if (!drv->create_opts) {
4178 error_report("Format driver '%s' does not support image creation",
4183 if (!proto_drv->create_opts) {
4184 error_report("Protocol driver '%s' does not support image creation",
4185 proto_drv->format_name);
4189 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4190 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4192 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4194 size = blk_getlength(blk1);
4196 error_report("Failed to get size for '%s'", in.filename);
4201 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4202 dd.count * in.bsz < size) {
4203 size = dd.count * in.bsz;
4206 /* Overflow means the specified offset is beyond input image's size */
4207 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4208 size < in.bsz * in.offset)) {
4209 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4211 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4212 size - in.bsz * in.offset, &error_abort);
4215 ret = bdrv_create(drv, out.filename, opts, &local_err);
4217 error_reportf_err(local_err,
4218 "%s: error while creating output image: ",
4224 blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
4232 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4233 size < in.offset * in.bsz)) {
4234 /* We give a warning if the skip option is bigger than the input
4235 * size and create an empty output disk image (i.e. like dd(1)).
4237 error_report("%s: cannot skip to specified offset", in.filename);
4240 in_pos = in.offset * in.bsz;
4243 in.buf = g_new(uint8_t, in.bsz);
4245 for (out_pos = 0; in_pos < size; block_count++) {
4246 int in_ret, out_ret;
4248 if (in_pos + in.bsz > size) {
4249 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4251 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4254 error_report("error while reading from input image file: %s",
4261 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4264 error_report("error while writing to output image file: %s",
4265 strerror(-out_ret));
4274 qemu_opts_del(opts);
4275 qemu_opts_free(create_opts);
4278 g_free(in.filename);
4279 g_free(out.filename);
4290 static const img_cmd_t img_cmds[] = {
4291 #define DEF(option, callback, arg_string) \
4292 { option, callback },
4293 #include "qemu-img-cmds.h"
4299 int main(int argc, char **argv)
4301 const img_cmd_t *cmd;
4302 const char *cmdname;
4303 Error *local_error = NULL;
4304 char *trace_file = NULL;
4306 static const struct option long_options[] = {
4307 {"help", no_argument, 0, 'h'},
4308 {"version", no_argument, 0, 'V'},
4309 {"trace", required_argument, NULL, 'T'},
4314 signal(SIGPIPE, SIG_IGN);
4317 module_call_init(MODULE_INIT_TRACE);
4318 error_set_progname(argv[0]);
4319 qemu_init_exec_dir(argv[0]);
4321 if (qemu_init_main_loop(&local_error)) {
4322 error_report_err(local_error);
4326 qcrypto_init(&error_fatal);
4328 module_call_init(MODULE_INIT_QOM);
4331 error_exit("Not enough arguments");
4334 qemu_add_opts(&qemu_object_opts);
4335 qemu_add_opts(&qemu_source_opts);
4336 qemu_add_opts(&qemu_trace_opts);
4338 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
4341 missing_argument(argv[optind - 1]);
4344 unrecognized_option(argv[optind - 1]);
4350 printf(QEMU_IMG_VERSION);
4354 trace_file = trace_opt_parse(optarg);
4359 cmdname = argv[optind];
4361 /* reset getopt_long scanning */
4369 if (!trace_init_backends()) {
4372 trace_init_file(trace_file);
4373 qemu_set_log(LOG_TRACE);
4375 /* find the command */
4376 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4377 if (!strcmp(cmdname, cmd->name)) {
4378 return cmd->handler(argc, argv);
4383 error_exit("Command not found: %s", cmdname);