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 /* Please keep in synch with qemu-img.texi */
92 static void QEMU_NORETURN help(void)
94 const char *help_msg =
96 "usage: qemu-img [standard options] command [command options]\n"
97 "QEMU disk image utility\n"
99 " '-h', '--help' display this help and exit\n"
100 " '-V', '--version' output version information and exit\n"
101 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
102 " specify tracing options\n"
105 #define DEF(option, callback, arg_string) \
107 #include "qemu-img-cmds.h"
111 "Command parameters:\n"
112 " 'filename' is a disk image filename\n"
113 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
114 " manual page for a description of the object properties. The most common\n"
115 " object type is a 'secret', which is used to supply passwords and/or\n"
116 " encryption keys.\n"
117 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
118 " 'cache' is the cache mode used to write the output disk image, the valid\n"
119 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
120 " 'directsync' and 'unsafe' (default for convert)\n"
121 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
122 " options are the same as for the 'cache' option\n"
123 " 'size' is the disk image size in bytes. Optional suffixes\n"
124 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
125 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
126 " supported. 'b' is ignored.\n"
127 " 'output_filename' is the destination disk image filename\n"
128 " 'output_fmt' is the destination format\n"
129 " 'options' is a comma separated list of format specific options in a\n"
130 " name=value format. Use -o ? for an overview of the options supported by the\n"
132 " 'snapshot_param' is param used for internal snapshot, format\n"
133 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
135 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
137 " '-c' indicates that target image must be compressed (qcow format only)\n"
138 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
139 " match exactly. The image doesn't need a working backing file before\n"
140 " rebasing in this case (useful for renaming the backing file)\n"
141 " '-h' with or without a command shows this help and lists the supported formats\n"
142 " '-p' show progress of command (only certain commands)\n"
143 " '-q' use Quiet mode - do not print any output (except errors)\n"
144 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
145 " contain only zeros for qemu-img to create a sparse image during\n"
146 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
147 " unallocated or zero sectors, and the destination image will always be\n"
149 " '--output' takes the format in which the output must be done (human or json)\n"
150 " '-n' skips the target volume creation (useful if the volume is created\n"
151 " prior to running qemu-img)\n"
153 "Parameters to check subcommand:\n"
154 " '-r' tries to repair any inconsistencies that are found during the check.\n"
155 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
156 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
157 " hiding corruption that has already occurred.\n"
159 "Parameters to snapshot subcommand:\n"
160 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
161 " '-a' applies a snapshot (revert disk to saved state)\n"
162 " '-c' creates a snapshot\n"
163 " '-d' deletes a snapshot\n"
164 " '-l' lists all snapshots in the given image\n"
166 "Parameters to compare subcommand:\n"
167 " '-f' first image format\n"
168 " '-F' second image format\n"
169 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
171 "Parameters to dd subcommand:\n"
172 " 'bs=BYTES' read and write up to BYTES bytes at a time "
174 " 'count=N' copy only N input blocks\n"
175 " 'if=FILE' read from FILE\n"
176 " 'of=FILE' write to FILE\n"
177 " 'skip=N' skip N bs-sized blocks at the start of input\n";
179 printf("%s\nSupported formats:", help_msg);
180 bdrv_iterate_format(format_print, NULL);
185 static QemuOptsList qemu_object_opts = {
187 .implied_opt_name = "qom-type",
188 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
194 static QemuOptsList qemu_source_opts = {
196 .implied_opt_name = "file",
197 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
203 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
209 ret = vprintf(fmt, args);
216 static int print_block_option_help(const char *filename, const char *fmt)
218 BlockDriver *drv, *proto_drv;
219 QemuOptsList *create_opts = NULL;
220 Error *local_err = NULL;
222 /* Find driver and parse its options */
223 drv = bdrv_find_format(fmt);
225 error_report("Unknown file format '%s'", fmt);
229 create_opts = qemu_opts_append(create_opts, drv->create_opts);
231 proto_drv = bdrv_find_protocol(filename, true, &local_err);
233 error_report_err(local_err);
234 qemu_opts_free(create_opts);
237 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
240 qemu_opts_print_help(create_opts);
241 qemu_opts_free(create_opts);
246 static int img_open_password(BlockBackend *blk, const char *filename,
247 int flags, bool quiet)
249 BlockDriverState *bs;
253 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
254 !(flags & BDRV_O_NO_IO)) {
255 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
256 if (qemu_read_password(password, sizeof(password)) < 0) {
257 error_report("No password given");
260 if (bdrv_set_key(bs, password) < 0) {
261 error_report("invalid password");
269 static BlockBackend *img_open_opts(const char *optstr,
270 QemuOpts *opts, int flags, bool writethrough,
274 Error *local_err = NULL;
276 options = qemu_opts_to_qdict(opts, NULL);
277 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
279 error_reportf_err(local_err, "Could not open '%s': ", optstr);
282 blk_set_enable_write_cache(blk, !writethrough);
284 if (img_open_password(blk, optstr, flags, quiet) < 0) {
291 static BlockBackend *img_open_file(const char *filename,
292 const char *fmt, int flags,
293 bool writethrough, bool quiet)
296 Error *local_err = NULL;
297 QDict *options = NULL;
300 options = qdict_new();
301 qdict_put(options, "driver", qstring_from_str(fmt));
304 blk = blk_new_open(filename, NULL, options, flags, &local_err);
306 error_reportf_err(local_err, "Could not open '%s': ", filename);
309 blk_set_enable_write_cache(blk, !writethrough);
311 if (img_open_password(blk, filename, flags, quiet) < 0) {
319 static BlockBackend *img_open(bool image_opts,
320 const char *filename,
321 const char *fmt, int flags, bool writethrough,
328 error_report("--image-opts and --format are mutually exclusive");
331 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
336 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
338 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
344 static int add_old_style_options(const char *fmt, QemuOpts *opts,
345 const char *base_filename,
346 const char *base_fmt)
351 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
353 error_report("Backing file not supported for file format '%s'",
360 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
362 error_report("Backing file format not supported for file "
371 static int img_create(int argc, char **argv)
374 uint64_t img_size = -1;
375 const char *fmt = "raw";
376 const char *base_fmt = NULL;
377 const char *filename;
378 const char *base_filename = NULL;
379 char *options = NULL;
380 Error *local_err = NULL;
384 static const struct option long_options[] = {
385 {"help", no_argument, 0, 'h'},
386 {"object", required_argument, 0, OPTION_OBJECT},
389 c = getopt_long(argc, argv, "F:b:f:he6o:q",
403 base_filename = optarg;
409 error_report("option -e is deprecated, please use \'-o "
410 "encryption\' instead!");
413 error_report("option -6 is deprecated, please use \'-o "
414 "compat6\' instead!");
417 if (!is_valid_option_list(optarg)) {
418 error_report("Invalid option list: %s", optarg);
422 options = g_strdup(optarg);
424 char *old_options = options;
425 options = g_strdup_printf("%s,%s", options, optarg);
432 case OPTION_OBJECT: {
434 opts = qemu_opts_parse_noisily(&qemu_object_opts,
443 /* Get the filename */
444 filename = (optind < argc) ? argv[optind] : NULL;
445 if (options && has_help_option(options)) {
447 return print_block_option_help(filename, fmt);
450 if (optind >= argc) {
451 error_exit("Expecting image file name");
455 if (qemu_opts_foreach(&qemu_object_opts,
456 user_creatable_add_opts_foreach,
461 /* Get image size, if specified */
465 sval = qemu_strtosz_suffix(argv[optind++], &end,
466 QEMU_STRTOSZ_DEFSUFFIX_B);
467 if (sval < 0 || *end) {
468 if (sval == -ERANGE) {
469 error_report("Image size must be less than 8 EiB!");
471 error_report("Invalid image size specified! You may use k, M, "
472 "G, T, P or E suffixes for ");
473 error_report("kilobytes, megabytes, gigabytes, terabytes, "
474 "petabytes and exabytes.");
478 img_size = (uint64_t)sval;
480 if (optind != argc) {
481 error_exit("Unexpected argument: %s", argv[optind]);
484 bdrv_img_create(filename, fmt, base_filename, base_fmt,
485 options, img_size, 0, &local_err, quiet);
487 error_reportf_err(local_err, "%s: ", filename);
499 static void dump_json_image_check(ImageCheck *check, bool quiet)
503 Visitor *v = qobject_output_visitor_new(&obj);
505 visit_type_ImageCheck(v, NULL, &check, &error_abort);
506 visit_complete(v, &obj);
507 str = qobject_to_json_pretty(obj);
509 qprintf(quiet, "%s\n", qstring_get_str(str));
515 static void dump_human_image_check(ImageCheck *check, bool quiet)
517 if (!(check->corruptions || check->leaks || check->check_errors)) {
518 qprintf(quiet, "No errors were found on the image.\n");
520 if (check->corruptions) {
521 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
522 "Data may be corrupted, or further writes to the image "
529 "\n%" PRId64 " leaked clusters were found on the image.\n"
530 "This means waste of disk space, but no harm to data.\n",
534 if (check->check_errors) {
537 " internal errors have occurred during the check.\n",
538 check->check_errors);
542 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
543 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
544 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
545 check->allocated_clusters, check->total_clusters,
546 check->allocated_clusters * 100.0 / check->total_clusters,
547 check->fragmented_clusters * 100.0 / check->allocated_clusters,
548 check->compressed_clusters * 100.0 /
549 check->allocated_clusters);
552 if (check->image_end_offset) {
554 "Image end offset: %" PRId64 "\n", check->image_end_offset);
558 static int collect_image_check(BlockDriverState *bs,
560 const char *filename,
565 BdrvCheckResult result;
567 ret = bdrv_check(bs, &result, fix);
572 check->filename = g_strdup(filename);
573 check->format = g_strdup(bdrv_get_format_name(bs));
574 check->check_errors = result.check_errors;
575 check->corruptions = result.corruptions;
576 check->has_corruptions = result.corruptions != 0;
577 check->leaks = result.leaks;
578 check->has_leaks = result.leaks != 0;
579 check->corruptions_fixed = result.corruptions_fixed;
580 check->has_corruptions_fixed = result.corruptions != 0;
581 check->leaks_fixed = result.leaks_fixed;
582 check->has_leaks_fixed = result.leaks != 0;
583 check->image_end_offset = result.image_end_offset;
584 check->has_image_end_offset = result.image_end_offset != 0;
585 check->total_clusters = result.bfi.total_clusters;
586 check->has_total_clusters = result.bfi.total_clusters != 0;
587 check->allocated_clusters = result.bfi.allocated_clusters;
588 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
589 check->fragmented_clusters = result.bfi.fragmented_clusters;
590 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
591 check->compressed_clusters = result.bfi.compressed_clusters;
592 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
598 * Checks an image for consistency. Exit codes:
600 * 0 - Check completed, image is good
601 * 1 - Check not completed because of internal errors
602 * 2 - Check completed, image is corrupted
603 * 3 - Check completed, image has leaked clusters, but is good otherwise
604 * 63 - Checks are not supported by the image format
606 static int img_check(int argc, char **argv)
609 OutputFormat output_format = OFORMAT_HUMAN;
610 const char *filename, *fmt, *output, *cache;
612 BlockDriverState *bs;
614 int flags = BDRV_O_CHECK;
618 bool image_opts = false;
622 cache = BDRV_DEFAULT_CACHE;
625 int option_index = 0;
626 static const struct option long_options[] = {
627 {"help", no_argument, 0, 'h'},
628 {"format", required_argument, 0, 'f'},
629 {"repair", required_argument, 0, 'r'},
630 {"output", required_argument, 0, OPTION_OUTPUT},
631 {"object", required_argument, 0, OPTION_OBJECT},
632 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
635 c = getopt_long(argc, argv, "hf:r:T:q",
636 long_options, &option_index);
649 flags |= BDRV_O_RDWR;
651 if (!strcmp(optarg, "leaks")) {
652 fix = BDRV_FIX_LEAKS;
653 } else if (!strcmp(optarg, "all")) {
654 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
656 error_exit("Unknown option value for -r "
657 "(expecting 'leaks' or 'all'): %s", optarg);
669 case OPTION_OBJECT: {
671 opts = qemu_opts_parse_noisily(&qemu_object_opts,
677 case OPTION_IMAGE_OPTS:
682 if (optind != argc - 1) {
683 error_exit("Expecting one image file name");
685 filename = argv[optind++];
687 if (output && !strcmp(output, "json")) {
688 output_format = OFORMAT_JSON;
689 } else if (output && !strcmp(output, "human")) {
690 output_format = OFORMAT_HUMAN;
692 error_report("--output must be used with human or json as argument.");
696 if (qemu_opts_foreach(&qemu_object_opts,
697 user_creatable_add_opts_foreach,
702 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
704 error_report("Invalid source cache option: %s", cache);
708 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
714 check = g_new0(ImageCheck, 1);
715 ret = collect_image_check(bs, check, filename, fmt, fix);
717 if (ret == -ENOTSUP) {
718 error_report("This image format does not support checks");
723 if (check->corruptions_fixed || check->leaks_fixed) {
724 int corruptions_fixed, leaks_fixed;
726 leaks_fixed = check->leaks_fixed;
727 corruptions_fixed = check->corruptions_fixed;
729 if (output_format == OFORMAT_HUMAN) {
731 "The following inconsistencies were found and repaired:\n\n"
732 " %" PRId64 " leaked clusters\n"
733 " %" PRId64 " corruptions\n\n"
734 "Double checking the fixed image now...\n",
736 check->corruptions_fixed);
739 ret = collect_image_check(bs, check, filename, fmt, 0);
741 check->leaks_fixed = leaks_fixed;
742 check->corruptions_fixed = corruptions_fixed;
746 switch (output_format) {
748 dump_human_image_check(check, quiet);
751 dump_json_image_check(check, quiet);
756 if (ret || check->check_errors) {
758 error_report("Check failed: %s", strerror(-ret));
760 error_report("Check failed");
766 if (check->corruptions) {
768 } else if (check->leaks) {
775 qapi_free_ImageCheck(check);
780 typedef struct CommonBlockJobCBInfo {
781 BlockDriverState *bs;
783 } CommonBlockJobCBInfo;
785 static void common_block_job_cb(void *opaque, int ret)
787 CommonBlockJobCBInfo *cbi = opaque;
790 error_setg_errno(cbi->errp, -ret, "Block job failed");
794 static void run_block_job(BlockJob *job, Error **errp)
796 AioContext *aio_context = blk_get_aio_context(job->blk);
798 aio_context_acquire(aio_context);
800 aio_poll(aio_context, true);
801 qemu_progress_print(job->len ?
802 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
803 } while (!job->ready);
805 block_job_complete_sync(job, errp);
806 aio_context_release(aio_context);
808 /* A block job may finish instantaneously without publishing any progress,
809 * so just signal completion here */
810 qemu_progress_print(100.f, 0);
813 static int img_commit(int argc, char **argv)
816 const char *filename, *fmt, *cache, *base;
818 BlockDriverState *bs, *base_bs;
819 bool progress = false, quiet = false, drop = false;
821 Error *local_err = NULL;
822 CommonBlockJobCBInfo cbi;
823 bool image_opts = false;
824 AioContext *aio_context;
827 cache = BDRV_DEFAULT_CACHE;
830 static const struct option long_options[] = {
831 {"help", no_argument, 0, 'h'},
832 {"object", required_argument, 0, OPTION_OBJECT},
833 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
836 c = getopt_long(argc, argv, "f:ht:b:dpq",
866 case OPTION_OBJECT: {
868 opts = qemu_opts_parse_noisily(&qemu_object_opts,
874 case OPTION_IMAGE_OPTS:
880 /* Progress is not shown in Quiet mode */
885 if (optind != argc - 1) {
886 error_exit("Expecting one image file name");
888 filename = argv[optind++];
890 if (qemu_opts_foreach(&qemu_object_opts,
891 user_creatable_add_opts_foreach,
896 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
897 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
899 error_report("Invalid cache option: %s", cache);
903 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
909 qemu_progress_init(progress, 1.f);
910 qemu_progress_print(0.f, 100);
913 base_bs = bdrv_find_backing_image(bs, base);
915 error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
919 /* This is different from QMP, which by default uses the deepest file in
920 * the backing chain (i.e., the very base); however, the traditional
921 * behavior of qemu-img commit is using the immediate backing file. */
922 base_bs = backing_bs(bs);
924 error_setg(&local_err, "Image does not have a backing file");
929 cbi = (CommonBlockJobCBInfo){
934 aio_context = bdrv_get_aio_context(bs);
935 aio_context_acquire(aio_context);
936 commit_active_start("commit", bs, base_bs, BLOCK_JOB_DEFAULT, 0,
937 BLOCKDEV_ON_ERROR_REPORT, common_block_job_cb, &cbi,
939 aio_context_release(aio_context);
944 /* When the block job completes, the BlockBackend reference will point to
945 * the old backing file. In order to avoid that the top image is already
946 * deleted, so we can still empty it afterwards, increment the reference
947 * counter here preemptively. */
952 run_block_job(bs->job, &local_err);
957 if (!drop && bs->drv->bdrv_make_empty) {
958 ret = bs->drv->bdrv_make_empty(bs);
960 error_setg_errno(&local_err, -ret, "Could not empty %s",
977 error_report_err(local_err);
981 qprintf(quiet, "Image committed.\n");
986 * Returns true iff the first sector pointed to by 'buf' contains at least
989 * 'pnum' is set to the number of sectors (including and immediately following
990 * the first one) that are known to be in the same allocated/unallocated state.
992 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
1001 is_zero = buffer_is_zero(buf, 512);
1002 for(i = 1; i < n; i++) {
1004 if (is_zero != buffer_is_zero(buf, 512)) {
1013 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1014 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1015 * breaking up write requests for only small sparse areas.
1017 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1021 int num_checked, num_used;
1027 ret = is_allocated_sectors(buf, n, pnum);
1033 buf += BDRV_SECTOR_SIZE * *pnum;
1035 num_checked = num_used;
1038 ret = is_allocated_sectors(buf, n, pnum);
1040 buf += BDRV_SECTOR_SIZE * *pnum;
1042 num_checked += *pnum;
1044 num_used = num_checked;
1045 } else if (*pnum >= min) {
1055 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1056 * buffers matches, non-zero otherwise.
1058 * pnum is set to the number of sectors (including and immediately following
1059 * the first one) that are known to have the same comparison result
1061 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1072 res = !!memcmp(buf1, buf2, 512);
1073 for(i = 1; i < n; i++) {
1077 if (!!memcmp(buf1, buf2, 512) != res) {
1086 #define IO_BUF_SIZE (2 * 1024 * 1024)
1088 static int64_t sectors_to_bytes(int64_t sectors)
1090 return sectors << BDRV_SECTOR_BITS;
1093 static int64_t sectors_to_process(int64_t total, int64_t from)
1095 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1099 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1101 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1102 * data and negative value on error.
1104 * @param blk: BlockBackend for the image
1105 * @param sect_num: Number of first sector to check
1106 * @param sect_count: Number of sectors to check
1107 * @param filename: Name of disk file we are checking (logging purpose)
1108 * @param buffer: Allocated buffer for storing read data
1109 * @param quiet: Flag for quiet mode
1111 static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1112 int sect_count, const char *filename,
1113 uint8_t *buffer, bool quiet)
1116 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1117 sect_count << BDRV_SECTOR_BITS);
1119 error_report("Error while reading offset %" PRId64 " of %s: %s",
1120 sectors_to_bytes(sect_num), filename, strerror(-ret));
1123 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1124 if (ret || pnum != sect_count) {
1125 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1126 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1134 * Compares two images. Exit codes:
1136 * 0 - Images are identical
1138 * >1 - Error occurred
1140 static int img_compare(int argc, char **argv)
1142 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1143 BlockBackend *blk1, *blk2;
1144 BlockDriverState *bs1, *bs2;
1145 int64_t total_sectors1, total_sectors2;
1146 uint8_t *buf1 = NULL, *buf2 = NULL;
1148 int allocated1, allocated2;
1149 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1150 bool progress = false, quiet = false, strict = false;
1153 int64_t total_sectors;
1154 int64_t sector_num = 0;
1157 uint64_t progress_base;
1158 bool image_opts = false;
1160 cache = BDRV_DEFAULT_CACHE;
1162 static const struct option long_options[] = {
1163 {"help", no_argument, 0, 'h'},
1164 {"object", required_argument, 0, OPTION_OBJECT},
1165 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1168 c = getopt_long(argc, argv, "hf:F:T:pqs",
1169 long_options, NULL);
1196 case OPTION_OBJECT: {
1198 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1205 case OPTION_IMAGE_OPTS:
1211 /* Progress is not shown in Quiet mode */
1217 if (optind != argc - 2) {
1218 error_exit("Expecting two image file names");
1220 filename1 = argv[optind++];
1221 filename2 = argv[optind++];
1223 if (qemu_opts_foreach(&qemu_object_opts,
1224 user_creatable_add_opts_foreach,
1230 /* Initialize before goto out */
1231 qemu_progress_init(progress, 2.0);
1234 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1236 error_report("Invalid source cache option: %s", cache);
1241 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1247 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1255 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1256 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1257 total_sectors1 = blk_nb_sectors(blk1);
1258 if (total_sectors1 < 0) {
1259 error_report("Can't get size of %s: %s",
1260 filename1, strerror(-total_sectors1));
1264 total_sectors2 = blk_nb_sectors(blk2);
1265 if (total_sectors2 < 0) {
1266 error_report("Can't get size of %s: %s",
1267 filename2, strerror(-total_sectors2));
1271 total_sectors = MIN(total_sectors1, total_sectors2);
1272 progress_base = MAX(total_sectors1, total_sectors2);
1274 qemu_progress_print(0, 100);
1276 if (strict && total_sectors1 != total_sectors2) {
1278 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1283 int64_t status1, status2;
1284 BlockDriverState *file;
1286 nb_sectors = sectors_to_process(total_sectors, sector_num);
1287 if (nb_sectors <= 0) {
1290 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1291 total_sectors1 - sector_num,
1295 error_report("Sector allocation test failed for %s", filename1);
1298 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1300 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1301 total_sectors2 - sector_num,
1305 error_report("Sector allocation test failed for %s", filename2);
1308 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1310 nb_sectors = MIN(nb_sectors, pnum1);
1313 nb_sectors = MIN(nb_sectors, pnum2);
1317 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1318 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1320 qprintf(quiet, "Strict mode: Offset %" PRId64
1321 " block status mismatch!\n",
1322 sectors_to_bytes(sector_num));
1326 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1327 nb_sectors = MIN(pnum1, pnum2);
1328 } else if (allocated1 == allocated2) {
1330 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1331 nb_sectors << BDRV_SECTOR_BITS);
1333 error_report("Error while reading offset %" PRId64 " of %s:"
1334 " %s", sectors_to_bytes(sector_num), filename1,
1339 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1340 nb_sectors << BDRV_SECTOR_BITS);
1342 error_report("Error while reading offset %" PRId64
1343 " of %s: %s", sectors_to_bytes(sector_num),
1344 filename2, strerror(-ret));
1348 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1349 if (ret || pnum != nb_sectors) {
1350 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1352 ret ? sector_num : sector_num + pnum));
1360 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1361 filename1, buf1, quiet);
1363 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1364 filename2, buf1, quiet);
1368 error_report("Error while reading offset %" PRId64 ": %s",
1369 sectors_to_bytes(sector_num), strerror(-ret));
1375 sector_num += nb_sectors;
1376 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1379 if (total_sectors1 != total_sectors2) {
1380 BlockBackend *blk_over;
1381 int64_t total_sectors_over;
1382 const char *filename_over;
1384 qprintf(quiet, "Warning: Image size mismatch!\n");
1385 if (total_sectors1 > total_sectors2) {
1386 total_sectors_over = total_sectors1;
1388 filename_over = filename1;
1390 total_sectors_over = total_sectors2;
1392 filename_over = filename2;
1396 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1397 if (nb_sectors <= 0) {
1400 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1404 error_report("Sector allocation test failed for %s",
1411 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1412 filename_over, buf1, quiet);
1415 error_report("Error while reading offset %" PRId64
1416 " of %s: %s", sectors_to_bytes(sector_num),
1417 filename_over, strerror(-ret));
1423 sector_num += nb_sectors;
1424 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1428 qprintf(quiet, "Images are identical.\n");
1438 qemu_progress_end();
1443 enum ImgConvertBlockStatus {
1449 typedef struct ImgConvertState {
1451 int64_t *src_sectors;
1452 int src_cur, src_num;
1453 int64_t src_cur_offset;
1454 int64_t total_sectors;
1455 int64_t allocated_sectors;
1456 enum ImgConvertBlockStatus status;
1457 int64_t sector_next_status;
1458 BlockBackend *target;
1461 bool target_has_backing;
1463 size_t cluster_sectors;
1467 static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1469 assert(sector_num >= s->src_cur_offset);
1470 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1471 s->src_cur_offset += s->src_sectors[s->src_cur];
1473 assert(s->src_cur < s->src_num);
1477 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1482 convert_select_part(s, sector_num);
1484 assert(s->total_sectors > sector_num);
1485 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1487 if (s->sector_next_status <= sector_num) {
1488 BlockDriverState *file;
1489 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1490 sector_num - s->src_cur_offset,
1496 if (ret & BDRV_BLOCK_ZERO) {
1497 s->status = BLK_ZERO;
1498 } else if (ret & BDRV_BLOCK_DATA) {
1499 s->status = BLK_DATA;
1500 } else if (!s->target_has_backing) {
1501 /* Without a target backing file we must copy over the contents of
1502 * the backing file as well. */
1503 /* Check block status of the backing file chain to avoid
1504 * needlessly reading zeroes and limiting the iteration to the
1506 ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
1507 sector_num - s->src_cur_offset,
1513 if (ret & BDRV_BLOCK_ZERO) {
1514 s->status = BLK_ZERO;
1516 s->status = BLK_DATA;
1519 s->status = BLK_BACKING_FILE;
1522 s->sector_next_status = sector_num + n;
1525 n = MIN(n, s->sector_next_status - sector_num);
1526 if (s->status == BLK_DATA) {
1527 n = MIN(n, s->buf_sectors);
1530 /* We need to write complete clusters for compressed images, so if an
1531 * unallocated area is shorter than that, we must consider the whole
1532 * cluster allocated. */
1533 if (s->compressed) {
1534 if (n < s->cluster_sectors) {
1535 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1536 s->status = BLK_DATA;
1538 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1545 static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1551 assert(nb_sectors <= s->buf_sectors);
1552 while (nb_sectors > 0) {
1556 /* In the case of compression with multiple source files, we can get a
1557 * nb_sectors that spreads into the next part. So we must be able to
1558 * read across multiple BDSes for one convert_read() call. */
1559 convert_select_part(s, sector_num);
1560 blk = s->src[s->src_cur];
1561 bs_sectors = s->src_sectors[s->src_cur];
1563 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1564 ret = blk_pread(blk,
1565 (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
1566 buf, n << BDRV_SECTOR_BITS);
1573 buf += n * BDRV_SECTOR_SIZE;
1579 static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1584 while (nb_sectors > 0) {
1587 switch (s->status) {
1588 case BLK_BACKING_FILE:
1589 /* If we have a backing file, leave clusters unallocated that are
1590 * unallocated in the source image, so that the backing file is
1591 * visible at the respective offset. */
1592 assert(s->target_has_backing);
1596 /* We must always write compressed clusters as a whole, so don't
1597 * try to find zeroed parts in the buffer. We can only save the
1598 * write if the buffer is completely zeroed and we're allowed to
1599 * keep the target sparse. */
1600 if (s->compressed) {
1601 if (s->has_zero_init && s->min_sparse &&
1602 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1604 assert(!s->target_has_backing);
1608 ret = blk_pwrite_compressed(s->target,
1609 sector_num << BDRV_SECTOR_BITS,
1610 buf, n << BDRV_SECTOR_BITS);
1617 /* If there is real non-zero data or we're told to keep the target
1618 * fully allocated (-S 0), we must write it. Otherwise we can treat
1619 * it as zero sectors. */
1620 if (!s->min_sparse ||
1621 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1623 ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1624 buf, n << BDRV_SECTOR_BITS, 0);
1633 if (s->has_zero_init) {
1636 ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
1637 n << BDRV_SECTOR_BITS, 0);
1646 buf += n * BDRV_SECTOR_SIZE;
1652 static int convert_do_copy(ImgConvertState *s)
1654 uint8_t *buf = NULL;
1655 int64_t sector_num, allocated_done;
1659 /* Check whether we have zero initialisation or can get it efficiently */
1660 s->has_zero_init = s->min_sparse && !s->target_has_backing
1661 ? bdrv_has_zero_init(blk_bs(s->target))
1664 if (!s->has_zero_init && !s->target_has_backing &&
1665 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1667 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1669 s->has_zero_init = true;
1673 /* Allocate buffer for copied data. For compressed images, only one cluster
1674 * can be copied at a time. */
1675 if (s->compressed) {
1676 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1677 error_report("invalid cluster size");
1681 s->buf_sectors = s->cluster_sectors;
1683 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1685 /* Calculate allocated sectors for progress */
1686 s->allocated_sectors = 0;
1688 while (sector_num < s->total_sectors) {
1689 n = convert_iteration_sectors(s, sector_num);
1694 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1696 s->allocated_sectors += n;
1703 s->src_cur_offset = 0;
1704 s->sector_next_status = 0;
1709 while (sector_num < s->total_sectors) {
1710 n = convert_iteration_sectors(s, sector_num);
1715 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1717 allocated_done += n;
1718 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1722 if (s->status == BLK_DATA) {
1723 ret = convert_read(s, sector_num, n, buf);
1725 error_report("error while reading sector %" PRId64
1726 ": %s", sector_num, strerror(-ret));
1729 } else if (!s->min_sparse && s->status == BLK_ZERO) {
1730 n = MIN(n, s->buf_sectors);
1731 memset(buf, 0, n * BDRV_SECTOR_SIZE);
1732 s->status = BLK_DATA;
1735 ret = convert_write(s, sector_num, n, buf);
1737 error_report("error while writing sector %" PRId64
1738 ": %s", sector_num, strerror(-ret));
1745 if (s->compressed) {
1746 /* signal EOF to align */
1747 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1759 static int img_convert(int argc, char **argv)
1761 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1763 int progress = 0, flags, src_flags;
1764 bool writethrough, src_writethrough;
1765 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1766 BlockDriver *drv, *proto_drv;
1767 BlockBackend **blk = NULL, *out_blk = NULL;
1768 BlockDriverState **bs = NULL, *out_bs = NULL;
1769 int64_t total_sectors;
1770 int64_t *bs_sectors = NULL;
1771 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1772 BlockDriverInfo bdi;
1773 QemuOpts *opts = NULL;
1774 QemuOptsList *create_opts = NULL;
1775 const char *out_baseimg_param;
1776 char *options = NULL;
1777 const char *snapshot_name = NULL;
1778 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1780 Error *local_err = NULL;
1781 QemuOpts *sn_opts = NULL;
1782 ImgConvertState state;
1783 bool image_opts = false;
1788 src_cache = BDRV_DEFAULT_CACHE;
1793 static const struct option long_options[] = {
1794 {"help", no_argument, 0, 'h'},
1795 {"object", required_argument, 0, OPTION_OBJECT},
1796 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1799 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1800 long_options, NULL);
1816 out_baseimg = optarg;
1822 error_report("option -e is deprecated, please use \'-o "
1823 "encryption\' instead!");
1827 error_report("option -6 is deprecated, please use \'-o "
1828 "compat6\' instead!");
1832 if (!is_valid_option_list(optarg)) {
1833 error_report("Invalid option list: %s", optarg);
1838 options = g_strdup(optarg);
1840 char *old_options = options;
1841 options = g_strdup_printf("%s,%s", options, optarg);
1842 g_free(old_options);
1846 snapshot_name = optarg;
1849 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1850 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1853 error_report("Failed in parsing snapshot param '%s'",
1859 snapshot_name = optarg;
1866 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1867 if (sval < 0 || *end) {
1868 error_report("Invalid minimum zero buffer size for sparse output specified");
1873 min_sparse = sval / BDRV_SECTOR_SIZE;
1892 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1898 case OPTION_IMAGE_OPTS:
1904 if (qemu_opts_foreach(&qemu_object_opts,
1905 user_creatable_add_opts_foreach,
1910 /* Initialize before goto out */
1914 qemu_progress_init(progress, 1.0);
1916 bs_n = argc - optind - 1;
1917 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1919 if (options && has_help_option(options)) {
1920 ret = print_block_option_help(out_filename, out_fmt);
1925 error_exit("Must specify image file name");
1929 if (bs_n > 1 && out_baseimg) {
1930 error_report("-B makes no sense when concatenating multiple input "
1937 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1939 error_report("Invalid source cache option: %s", src_cache);
1943 qemu_progress_print(0, 100);
1945 blk = g_new0(BlockBackend *, bs_n);
1946 bs = g_new0(BlockDriverState *, bs_n);
1947 bs_sectors = g_new(int64_t, bs_n);
1950 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1951 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1952 fmt, src_flags, src_writethrough, quiet);
1957 bs[bs_i] = blk_bs(blk[bs_i]);
1958 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1959 if (bs_sectors[bs_i] < 0) {
1960 error_report("Could not get size of %s: %s",
1961 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1965 total_sectors += bs_sectors[bs_i];
1969 ret = bdrv_snapshot_load_tmp(bs[0],
1970 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1971 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1973 } else if (snapshot_name != NULL) {
1975 error_report("No support for concatenating multiple snapshot");
1980 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1983 error_reportf_err(local_err, "Failed to load snapshot: ");
1988 /* Find driver and parse its options */
1989 drv = bdrv_find_format(out_fmt);
1991 error_report("Unknown file format '%s'", out_fmt);
1996 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1998 error_report_err(local_err);
2004 if (!drv->create_opts) {
2005 error_report("Format driver '%s' does not support image creation",
2011 if (!proto_drv->create_opts) {
2012 error_report("Protocol driver '%s' does not support image creation",
2013 proto_drv->format_name);
2018 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2019 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2021 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2023 qemu_opts_do_parse(opts, options, NULL, &local_err);
2025 error_report_err(local_err);
2031 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
2033 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2039 /* Get backing file name if -o backing_file was used */
2040 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2041 if (out_baseimg_param) {
2042 out_baseimg = out_baseimg_param;
2045 /* Check if compression is supported */
2048 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2049 const char *preallocation =
2050 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2052 if (!drv->bdrv_co_pwritev_compressed) {
2053 error_report("Compression not supported for this file format");
2059 error_report("Compression and encryption not supported at "
2066 && strcmp(preallocation, "off"))
2068 error_report("Compression and preallocation not supported at "
2076 /* Create the new image */
2077 ret = bdrv_create(drv, out_filename, opts, &local_err);
2079 error_reportf_err(local_err, "%s: error while converting %s: ",
2080 out_filename, out_fmt);
2085 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2086 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2088 error_report("Invalid cache option: %s", cache);
2092 /* XXX we should allow --image-opts to trigger use of
2093 * img_open() here, but then we have trouble with
2094 * the bdrv_create() call which takes different params.
2095 * Not critical right now, so fix can wait...
2097 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2102 out_bs = blk_bs(out_blk);
2104 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2105 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2107 bufsectors = MIN(32768,
2109 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2110 out_bs->bl.pdiscard_alignment >>
2111 BDRV_SECTOR_BITS)));
2114 int64_t output_sectors = blk_nb_sectors(out_blk);
2115 if (output_sectors < 0) {
2116 error_report("unable to get output image length: %s",
2117 strerror(-output_sectors));
2120 } else if (output_sectors < total_sectors) {
2121 error_report("output file is smaller than input file");
2127 cluster_sectors = 0;
2128 ret = bdrv_get_info(out_bs, &bdi);
2131 error_report("could not get block driver info");
2135 compress = compress || bdi.needs_compressed_writes;
2136 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2139 state = (ImgConvertState) {
2141 .src_sectors = bs_sectors,
2143 .total_sectors = total_sectors,
2145 .compressed = compress,
2146 .target_has_backing = (bool) out_baseimg,
2147 .min_sparse = min_sparse,
2148 .cluster_sectors = cluster_sectors,
2149 .buf_sectors = bufsectors,
2151 ret = convert_do_copy(&state);
2155 qemu_progress_print(100, 0);
2157 qemu_progress_end();
2158 qemu_opts_del(opts);
2159 qemu_opts_free(create_opts);
2160 qemu_opts_del(sn_opts);
2164 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2165 blk_unref(blk[bs_i]);
2180 static void dump_snapshots(BlockDriverState *bs)
2182 QEMUSnapshotInfo *sn_tab, *sn;
2185 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2188 printf("Snapshot list:\n");
2189 bdrv_snapshot_dump(fprintf, stdout, NULL);
2191 for(i = 0; i < nb_sns; i++) {
2193 bdrv_snapshot_dump(fprintf, stdout, sn);
2199 static void dump_json_image_info_list(ImageInfoList *list)
2203 Visitor *v = qobject_output_visitor_new(&obj);
2205 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2206 visit_complete(v, &obj);
2207 str = qobject_to_json_pretty(obj);
2208 assert(str != NULL);
2209 printf("%s\n", qstring_get_str(str));
2210 qobject_decref(obj);
2215 static void dump_json_image_info(ImageInfo *info)
2219 Visitor *v = qobject_output_visitor_new(&obj);
2221 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2222 visit_complete(v, &obj);
2223 str = qobject_to_json_pretty(obj);
2224 assert(str != NULL);
2225 printf("%s\n", qstring_get_str(str));
2226 qobject_decref(obj);
2231 static void dump_human_image_info_list(ImageInfoList *list)
2233 ImageInfoList *elem;
2236 for (elem = list; elem; elem = elem->next) {
2242 bdrv_image_info_dump(fprintf, stdout, elem->value);
2246 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2248 return strcmp(a, b) == 0;
2252 * Open an image file chain and return an ImageInfoList
2254 * @filename: topmost image filename
2255 * @fmt: topmost image format (may be NULL to autodetect)
2256 * @chain: true - enumerate entire backing file chain
2257 * false - only topmost image file
2259 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2260 * image file. If there was an error a message will have been printed to
2263 static ImageInfoList *collect_image_info_list(bool image_opts,
2264 const char *filename,
2268 ImageInfoList *head = NULL;
2269 ImageInfoList **last = &head;
2270 GHashTable *filenames;
2273 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2277 BlockDriverState *bs;
2279 ImageInfoList *elem;
2281 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2282 error_report("Backing file '%s' creates an infinite loop.",
2286 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2288 blk = img_open(image_opts, filename, fmt,
2289 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2295 bdrv_query_image_info(bs, &info, &err);
2297 error_report_err(err);
2302 elem = g_new0(ImageInfoList, 1);
2309 filename = fmt = NULL;
2311 if (info->has_full_backing_filename) {
2312 filename = info->full_backing_filename;
2313 } else if (info->has_backing_filename) {
2314 error_report("Could not determine absolute backing filename,"
2315 " but backing filename '%s' present",
2316 info->backing_filename);
2319 if (info->has_backing_filename_format) {
2320 fmt = info->backing_filename_format;
2324 g_hash_table_destroy(filenames);
2328 qapi_free_ImageInfoList(head);
2329 g_hash_table_destroy(filenames);
2333 static int img_info(int argc, char **argv)
2336 OutputFormat output_format = OFORMAT_HUMAN;
2338 const char *filename, *fmt, *output;
2339 ImageInfoList *list;
2340 bool image_opts = false;
2345 int option_index = 0;
2346 static const struct option long_options[] = {
2347 {"help", no_argument, 0, 'h'},
2348 {"format", required_argument, 0, 'f'},
2349 {"output", required_argument, 0, OPTION_OUTPUT},
2350 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2351 {"object", required_argument, 0, OPTION_OBJECT},
2352 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2355 c = getopt_long(argc, argv, "f:h",
2356 long_options, &option_index);
2371 case OPTION_BACKING_CHAIN:
2374 case OPTION_OBJECT: {
2376 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2382 case OPTION_IMAGE_OPTS:
2387 if (optind != argc - 1) {
2388 error_exit("Expecting one image file name");
2390 filename = argv[optind++];
2392 if (output && !strcmp(output, "json")) {
2393 output_format = OFORMAT_JSON;
2394 } else if (output && !strcmp(output, "human")) {
2395 output_format = OFORMAT_HUMAN;
2396 } else if (output) {
2397 error_report("--output must be used with human or json as argument.");
2401 if (qemu_opts_foreach(&qemu_object_opts,
2402 user_creatable_add_opts_foreach,
2407 list = collect_image_info_list(image_opts, filename, fmt, chain);
2412 switch (output_format) {
2414 dump_human_image_info_list(list);
2418 dump_json_image_info_list(list);
2420 dump_json_image_info(list->value);
2425 qapi_free_ImageInfoList(list);
2429 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2432 switch (output_format) {
2434 if (e->data && !e->has_offset) {
2435 error_report("File contains external, encrypted or compressed clusters.");
2438 if (e->data && !e->zero) {
2439 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2440 e->start, e->length,
2441 e->has_offset ? e->offset : 0,
2442 e->has_filename ? e->filename : "");
2444 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2445 * Modify the flags here to allow more coalescing.
2447 if (next && (!next->data || next->zero)) {
2453 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2454 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2455 (e->start == 0 ? "[" : ",\n"),
2456 e->start, e->length, e->depth,
2457 e->zero ? "true" : "false",
2458 e->data ? "true" : "false");
2459 if (e->has_offset) {
2460 printf(", \"offset\": %"PRId64"", e->offset);
2471 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2472 int nb_sectors, MapEntry *e)
2476 BlockDriverState *file;
2479 /* As an optimization, we could cache the current range of unallocated
2480 * clusters in each file of the chain, and avoid querying the same
2486 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2492 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2495 bs = backing_bs(bs);
2504 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2507 .start = sector_num * BDRV_SECTOR_SIZE,
2508 .length = nb_sectors * BDRV_SECTOR_SIZE,
2509 .data = !!(ret & BDRV_BLOCK_DATA),
2510 .zero = !!(ret & BDRV_BLOCK_ZERO),
2511 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2512 .has_offset = has_offset,
2514 .has_filename = file && has_offset,
2515 .filename = file && has_offset ? file->filename : NULL,
2521 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2523 if (curr->length == 0) {
2526 if (curr->zero != next->zero ||
2527 curr->data != next->data ||
2528 curr->depth != next->depth ||
2529 curr->has_filename != next->has_filename ||
2530 curr->has_offset != next->has_offset) {
2533 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2536 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2542 static int img_map(int argc, char **argv)
2545 OutputFormat output_format = OFORMAT_HUMAN;
2547 BlockDriverState *bs;
2548 const char *filename, *fmt, *output;
2550 MapEntry curr = { .length = 0 }, next;
2552 bool image_opts = false;
2557 int option_index = 0;
2558 static const struct option long_options[] = {
2559 {"help", no_argument, 0, 'h'},
2560 {"format", required_argument, 0, 'f'},
2561 {"output", required_argument, 0, OPTION_OUTPUT},
2562 {"object", required_argument, 0, OPTION_OBJECT},
2563 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2566 c = getopt_long(argc, argv, "f:h",
2567 long_options, &option_index);
2582 case OPTION_OBJECT: {
2584 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2590 case OPTION_IMAGE_OPTS:
2595 if (optind != argc - 1) {
2596 error_exit("Expecting one image file name");
2598 filename = argv[optind];
2600 if (output && !strcmp(output, "json")) {
2601 output_format = OFORMAT_JSON;
2602 } else if (output && !strcmp(output, "human")) {
2603 output_format = OFORMAT_HUMAN;
2604 } else if (output) {
2605 error_report("--output must be used with human or json as argument.");
2609 if (qemu_opts_foreach(&qemu_object_opts,
2610 user_creatable_add_opts_foreach,
2615 blk = img_open(image_opts, filename, fmt, 0, false, false);
2621 if (output_format == OFORMAT_HUMAN) {
2622 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2625 length = blk_getlength(blk);
2626 while (curr.start + curr.length < length) {
2627 int64_t nsectors_left;
2631 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2633 /* Probe up to 1 GiB at a time. */
2634 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2635 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2636 ret = get_block_status(bs, sector_num, n, &next);
2639 error_report("Could not read file metadata: %s", strerror(-ret));
2643 if (entry_mergeable(&curr, &next)) {
2644 curr.length += next.length;
2648 if (curr.length > 0) {
2649 dump_map_entry(output_format, &curr, &next);
2654 dump_map_entry(output_format, &curr, NULL);
2661 #define SNAPSHOT_LIST 1
2662 #define SNAPSHOT_CREATE 2
2663 #define SNAPSHOT_APPLY 3
2664 #define SNAPSHOT_DELETE 4
2666 static int img_snapshot(int argc, char **argv)
2669 BlockDriverState *bs;
2670 QEMUSnapshotInfo sn;
2671 char *filename, *snapshot_name = NULL;
2672 int c, ret = 0, bdrv_oflags;
2677 bool image_opts = false;
2679 bdrv_oflags = BDRV_O_RDWR;
2680 /* Parse commandline parameters */
2682 static const struct option long_options[] = {
2683 {"help", no_argument, 0, 'h'},
2684 {"object", required_argument, 0, OPTION_OBJECT},
2685 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2688 c = getopt_long(argc, argv, "la:c:d:hq",
2689 long_options, NULL);
2700 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2703 action = SNAPSHOT_LIST;
2704 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2708 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2711 action = SNAPSHOT_APPLY;
2712 snapshot_name = optarg;
2716 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2719 action = SNAPSHOT_CREATE;
2720 snapshot_name = optarg;
2724 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2727 action = SNAPSHOT_DELETE;
2728 snapshot_name = optarg;
2733 case OPTION_OBJECT: {
2735 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2741 case OPTION_IMAGE_OPTS:
2747 if (optind != argc - 1) {
2748 error_exit("Expecting one image file name");
2750 filename = argv[optind++];
2752 if (qemu_opts_foreach(&qemu_object_opts,
2753 user_creatable_add_opts_foreach,
2758 /* Open the image */
2759 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2765 /* Perform the requested action */
2771 case SNAPSHOT_CREATE:
2772 memset(&sn, 0, sizeof(sn));
2773 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2775 qemu_gettimeofday(&tv);
2776 sn.date_sec = tv.tv_sec;
2777 sn.date_nsec = tv.tv_usec * 1000;
2779 ret = bdrv_snapshot_create(bs, &sn);
2781 error_report("Could not create snapshot '%s': %d (%s)",
2782 snapshot_name, ret, strerror(-ret));
2786 case SNAPSHOT_APPLY:
2787 ret = bdrv_snapshot_goto(bs, snapshot_name);
2789 error_report("Could not apply snapshot '%s': %d (%s)",
2790 snapshot_name, ret, strerror(-ret));
2794 case SNAPSHOT_DELETE:
2795 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2797 error_reportf_err(err, "Could not delete snapshot '%s': ",
2812 static int img_rebase(int argc, char **argv)
2814 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2815 uint8_t *buf_old = NULL;
2816 uint8_t *buf_new = NULL;
2817 BlockDriverState *bs = NULL;
2819 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2820 int c, flags, src_flags, ret;
2821 bool writethrough, src_writethrough;
2825 Error *local_err = NULL;
2826 bool image_opts = false;
2828 /* Parse commandline parameters */
2830 cache = BDRV_DEFAULT_CACHE;
2831 src_cache = BDRV_DEFAULT_CACHE;
2835 static const struct option long_options[] = {
2836 {"help", no_argument, 0, 'h'},
2837 {"object", required_argument, 0, OPTION_OBJECT},
2838 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2841 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2842 long_options, NULL);
2855 out_basefmt = optarg;
2858 out_baseimg = optarg;
2875 case OPTION_OBJECT: {
2877 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2883 case OPTION_IMAGE_OPTS:
2893 if (optind != argc - 1) {
2894 error_exit("Expecting one image file name");
2896 if (!unsafe && !out_baseimg) {
2897 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2899 filename = argv[optind++];
2901 if (qemu_opts_foreach(&qemu_object_opts,
2902 user_creatable_add_opts_foreach,
2907 qemu_progress_init(progress, 2.0);
2908 qemu_progress_print(0, 100);
2910 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2911 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2913 error_report("Invalid cache option: %s", cache);
2918 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2920 error_report("Invalid source cache option: %s", src_cache);
2924 /* The source files are opened read-only, don't care about WCE */
2925 assert((src_flags & BDRV_O_RDWR) == 0);
2926 (void) src_writethrough;
2931 * Ignore the old backing file for unsafe rebase in case we want to correct
2932 * the reference to a renamed or moved backing file.
2934 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2941 if (out_basefmt != NULL) {
2942 if (bdrv_find_format(out_basefmt) == NULL) {
2943 error_report("Invalid format name: '%s'", out_basefmt);
2949 /* For safe rebasing we need to compare old and new backing file */
2951 char backing_name[PATH_MAX];
2952 QDict *options = NULL;
2954 if (bs->backing_format[0] != '\0') {
2955 options = qdict_new();
2956 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2959 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2960 blk_old_backing = blk_new_open(backing_name, NULL,
2961 options, src_flags, &local_err);
2962 if (!blk_old_backing) {
2963 error_reportf_err(local_err,
2964 "Could not open old backing file '%s': ",
2970 if (out_baseimg[0]) {
2972 options = qdict_new();
2973 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2978 blk_new_backing = blk_new_open(out_baseimg, NULL,
2979 options, src_flags, &local_err);
2980 if (!blk_new_backing) {
2981 error_reportf_err(local_err,
2982 "Could not open new backing file '%s': ",
2991 * Check each unallocated cluster in the COW file. If it is unallocated,
2992 * accesses go to the backing file. We must therefore compare this cluster
2993 * in the old and new backing file, and if they differ we need to copy it
2994 * from the old backing file into the COW file.
2996 * If qemu-img crashes during this step, no harm is done. The content of
2997 * the image is the same as the original one at any time.
3000 int64_t num_sectors;
3001 int64_t old_backing_num_sectors;
3002 int64_t new_backing_num_sectors = 0;
3005 float local_progress = 0;
3007 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3008 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3010 num_sectors = blk_nb_sectors(blk);
3011 if (num_sectors < 0) {
3012 error_report("Could not get size of '%s': %s",
3013 filename, strerror(-num_sectors));
3017 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3018 if (old_backing_num_sectors < 0) {
3019 char backing_name[PATH_MAX];
3021 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3022 error_report("Could not get size of '%s': %s",
3023 backing_name, strerror(-old_backing_num_sectors));
3027 if (blk_new_backing) {
3028 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3029 if (new_backing_num_sectors < 0) {
3030 error_report("Could not get size of '%s': %s",
3031 out_baseimg, strerror(-new_backing_num_sectors));
3037 if (num_sectors != 0) {
3038 local_progress = (float)100 /
3039 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3042 for (sector = 0; sector < num_sectors; sector += n) {
3044 /* How many sectors can we handle with the next read? */
3045 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3046 n = (IO_BUF_SIZE / 512);
3048 n = num_sectors - sector;
3051 /* If the cluster is allocated, we don't need to take action */
3052 ret = bdrv_is_allocated(bs, sector, n, &n);
3054 error_report("error while reading image metadata: %s",
3063 * Read old and new backing file and take into consideration that
3064 * backing files may be smaller than the COW image.
3066 if (sector >= old_backing_num_sectors) {
3067 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3069 if (sector + n > old_backing_num_sectors) {
3070 n = old_backing_num_sectors - sector;
3073 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3074 buf_old, n << BDRV_SECTOR_BITS);
3076 error_report("error while reading from old backing file");
3081 if (sector >= new_backing_num_sectors || !blk_new_backing) {
3082 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3084 if (sector + n > new_backing_num_sectors) {
3085 n = new_backing_num_sectors - sector;
3088 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3089 buf_new, n << BDRV_SECTOR_BITS);
3091 error_report("error while reading from new backing file");
3096 /* If they differ, we need to write to the COW file */
3097 uint64_t written = 0;
3099 while (written < n) {
3102 if (compare_sectors(buf_old + written * 512,
3103 buf_new + written * 512, n - written, &pnum))
3105 ret = blk_pwrite(blk,
3106 (sector + written) << BDRV_SECTOR_BITS,
3107 buf_old + written * 512,
3108 pnum << BDRV_SECTOR_BITS, 0);
3110 error_report("Error while writing to COW image: %s",
3118 qemu_progress_print(local_progress, 100);
3123 * Change the backing file. All clusters that are different from the old
3124 * backing file are overwritten in the COW file now, so the visible content
3125 * doesn't change when we switch the backing file.
3127 if (out_baseimg && *out_baseimg) {
3128 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3130 ret = bdrv_change_backing_file(bs, NULL, NULL);
3133 if (ret == -ENOSPC) {
3134 error_report("Could not change the backing file to '%s': No "
3135 "space left in the file header", out_baseimg);
3136 } else if (ret < 0) {
3137 error_report("Could not change the backing file to '%s': %s",
3138 out_baseimg, strerror(-ret));
3141 qemu_progress_print(100, 0);
3143 * TODO At this point it is possible to check if any clusters that are
3144 * allocated in the COW file are the same in the backing file. If so, they
3145 * could be dropped from the COW file. Don't do this before switching the
3146 * backing file, in case of a crash this would lead to corruption.
3149 qemu_progress_end();
3152 blk_unref(blk_old_backing);
3153 blk_unref(blk_new_backing);
3155 qemu_vfree(buf_old);
3156 qemu_vfree(buf_new);
3165 static int img_resize(int argc, char **argv)
3168 int c, ret, relative;
3169 const char *filename, *fmt, *size;
3170 int64_t n, total_size;
3172 BlockBackend *blk = NULL;
3175 static QemuOptsList resize_options = {
3176 .name = "resize_options",
3177 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3180 .name = BLOCK_OPT_SIZE,
3181 .type = QEMU_OPT_SIZE,
3182 .help = "Virtual disk size"
3188 bool image_opts = false;
3190 /* Remove size from argv manually so that negative numbers are not treated
3191 * as options by getopt. */
3193 error_exit("Not enough arguments");
3197 size = argv[--argc];
3199 /* Parse getopt arguments */
3202 static const struct option long_options[] = {
3203 {"help", no_argument, 0, 'h'},
3204 {"object", required_argument, 0, OPTION_OBJECT},
3205 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3208 c = getopt_long(argc, argv, "f:hq",
3209 long_options, NULL);
3224 case OPTION_OBJECT: {
3226 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3232 case OPTION_IMAGE_OPTS:
3237 if (optind != argc - 1) {
3238 error_exit("Expecting one image file name");
3240 filename = argv[optind++];
3242 if (qemu_opts_foreach(&qemu_object_opts,
3243 user_creatable_add_opts_foreach,
3248 /* Choose grow, shrink, or absolute resize mode */
3264 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3265 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3267 error_report_err(err);
3269 qemu_opts_del(param);
3272 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3273 qemu_opts_del(param);
3275 blk = img_open(image_opts, filename, fmt,
3276 BDRV_O_RDWR, false, quiet);
3283 total_size = blk_getlength(blk) + n * relative;
3287 if (total_size <= 0) {
3288 error_report("New image size must be positive");
3293 ret = blk_truncate(blk, total_size);
3296 qprintf(quiet, "Image resized.\n");
3299 error_report("This image does not support resize");
3302 error_report("Image is read-only");
3305 error_report("Error resizing image: %s", strerror(-ret));
3316 static void amend_status_cb(BlockDriverState *bs,
3317 int64_t offset, int64_t total_work_size,
3320 qemu_progress_print(100.f * offset / total_work_size, 0);
3323 static int img_amend(int argc, char **argv)
3327 char *options = NULL;
3328 QemuOptsList *create_opts = NULL;
3329 QemuOpts *opts = NULL;
3330 const char *fmt = NULL, *filename, *cache;
3333 bool quiet = false, progress = false;
3334 BlockBackend *blk = NULL;
3335 BlockDriverState *bs = NULL;
3336 bool image_opts = false;
3338 cache = BDRV_DEFAULT_CACHE;
3340 static const struct option long_options[] = {
3341 {"help", no_argument, 0, 'h'},
3342 {"object", required_argument, 0, OPTION_OBJECT},
3343 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3346 c = getopt_long(argc, argv, "ho:f:t:pq",
3347 long_options, NULL);
3358 if (!is_valid_option_list(optarg)) {
3359 error_report("Invalid option list: %s", optarg);
3361 goto out_no_progress;
3364 options = g_strdup(optarg);
3366 char *old_options = options;
3367 options = g_strdup_printf("%s,%s", options, optarg);
3368 g_free(old_options);
3384 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3388 goto out_no_progress;
3391 case OPTION_IMAGE_OPTS:
3398 error_exit("Must specify options (-o)");
3401 if (qemu_opts_foreach(&qemu_object_opts,
3402 user_creatable_add_opts_foreach,
3405 goto out_no_progress;
3411 qemu_progress_init(progress, 1.0);
3413 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3414 if (fmt && has_help_option(options)) {
3415 /* If a format is explicitly specified (and possibly no filename is
3416 * given), print option help here */
3417 ret = print_block_option_help(filename, fmt);
3421 if (optind != argc - 1) {
3422 error_report("Expecting one image file name");
3427 flags = BDRV_O_RDWR;
3428 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3430 error_report("Invalid cache option: %s", cache);
3434 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3441 fmt = bs->drv->format_name;
3443 if (has_help_option(options)) {
3444 /* If the format was auto-detected, print option help here */
3445 ret = print_block_option_help(filename, fmt);
3449 if (!bs->drv->create_opts) {
3450 error_report("Format driver '%s' does not support any options to amend",
3456 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3457 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3459 qemu_opts_do_parse(opts, options, NULL, &err);
3461 error_report_err(err);
3467 /* In case the driver does not call amend_status_cb() */
3468 qemu_progress_print(0.f, 0);
3469 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3470 qemu_progress_print(100.f, 0);
3472 error_report("Error while amending options: %s", strerror(-ret));
3477 qemu_progress_end();
3481 qemu_opts_del(opts);
3482 qemu_opts_free(create_opts);
3491 typedef struct BenchData {
3493 uint64_t image_size;
3500 bool drain_on_flush;
3509 static void bench_undrained_flush_cb(void *opaque, int ret)
3512 error_report("Failed flush request: %s", strerror(-ret));
3517 static void bench_cb(void *opaque, int ret)
3519 BenchData *b = opaque;
3523 error_report("Failed request: %s", strerror(-ret));
3528 /* Just finished a flush with drained queue: Start next requests */
3529 assert(b->in_flight == 0);
3530 b->in_flush = false;
3531 } else if (b->in_flight > 0) {
3532 int remaining = b->n - b->in_flight;
3537 /* Time for flush? Drain queue if requested, then flush */
3538 if (b->flush_interval && remaining % b->flush_interval == 0) {
3539 if (!b->in_flight || !b->drain_on_flush) {
3540 BlockCompletionFunc *cb;
3542 if (b->drain_on_flush) {
3546 cb = bench_undrained_flush_cb;
3549 acb = blk_aio_flush(b->blk, cb, b);
3551 error_report("Failed to issue flush request");
3555 if (b->drain_on_flush) {
3561 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3562 int64_t offset = b->offset;
3563 /* blk_aio_* might look for completed I/Os and kick bench_cb
3564 * again, so make sure this operation is counted by in_flight
3565 * and b->offset is ready for the next submission.
3568 b->offset += b->step;
3569 b->offset %= b->image_size;
3571 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
3573 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
3576 error_report("Failed to issue request");
3582 static int img_bench(int argc, char **argv)
3585 const char *fmt = NULL, *filename;
3587 bool image_opts = false;
3588 bool is_write = false;
3592 size_t bufsize = 4096;
3595 int flush_interval = 0;
3596 bool drain_on_flush = true;
3598 BlockBackend *blk = NULL;
3599 BenchData data = {};
3601 bool writethrough = false;
3602 struct timeval t1, t2;
3606 static const struct option long_options[] = {
3607 {"help", no_argument, 0, 'h'},
3608 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
3609 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3610 {"pattern", required_argument, 0, OPTION_PATTERN},
3611 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
3614 c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL);
3628 count = strtoul(optarg, &end, 0);
3629 if (errno || *end || count > INT_MAX) {
3630 error_report("Invalid request count specified");
3639 depth = strtoul(optarg, &end, 0);
3640 if (errno || *end || depth > INT_MAX) {
3641 error_report("Invalid queue depth specified");
3650 flags |= BDRV_O_NATIVE_AIO;
3656 offset = qemu_strtosz_suffix(optarg, &end,
3657 QEMU_STRTOSZ_DEFSUFFIX_B);
3658 if (offset < 0|| *end) {
3659 error_report("Invalid offset specified");
3673 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3674 if (sval < 0 || sval > INT_MAX || *end) {
3675 error_report("Invalid buffer size specified");
3687 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3688 if (sval < 0 || sval > INT_MAX || *end) {
3689 error_report("Invalid step size specified");
3697 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
3699 error_report("Invalid cache mode");
3705 flags |= BDRV_O_RDWR;
3708 case OPTION_PATTERN:
3712 pattern = strtoul(optarg, &end, 0);
3713 if (errno || *end || pattern > 0xff) {
3714 error_report("Invalid pattern byte specified");
3719 case OPTION_FLUSH_INTERVAL:
3723 flush_interval = strtoul(optarg, &end, 0);
3724 if (errno || *end || flush_interval > INT_MAX) {
3725 error_report("Invalid flush interval specified");
3730 case OPTION_NO_DRAIN:
3731 drain_on_flush = false;
3733 case OPTION_IMAGE_OPTS:
3739 if (optind != argc - 1) {
3740 error_exit("Expecting one image file name");
3742 filename = argv[argc - 1];
3744 if (!is_write && flush_interval) {
3745 error_report("--flush-interval is only available in write tests");
3749 if (flush_interval && flush_interval < depth) {
3750 error_report("Flush interval can't be smaller than depth");
3755 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3761 image_size = blk_getlength(blk);
3762 if (image_size < 0) {
3767 data = (BenchData) {
3769 .image_size = image_size,
3771 .step = step ?: bufsize,
3776 .flush_interval = flush_interval,
3777 .drain_on_flush = drain_on_flush,
3779 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3780 "(starting at offset %" PRId64 ", step size %d)\n",
3781 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3782 data.offset, data.step);
3783 if (flush_interval) {
3784 printf("Sending flush every %d requests\n", flush_interval);
3787 data.buf = blk_blockalign(blk, data.nrreq * data.bufsize);
3788 memset(data.buf, pattern, data.nrreq * data.bufsize);
3790 data.qiov = g_new(QEMUIOVector, data.nrreq);
3791 for (i = 0; i < data.nrreq; i++) {
3792 qemu_iovec_init(&data.qiov[i], 1);
3793 qemu_iovec_add(&data.qiov[i],
3794 data.buf + i * data.bufsize, data.bufsize);
3797 gettimeofday(&t1, NULL);
3800 while (data.n > 0) {
3801 main_loop_wait(false);
3803 gettimeofday(&t2, NULL);
3805 printf("Run completed in %3.3f seconds.\n",
3806 (t2.tv_sec - t1.tv_sec)
3807 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
3810 qemu_vfree(data.buf);
3831 int bsz; /* Block size */
3839 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
3843 static int img_dd_bs(const char *arg,
3844 struct DdIo *in, struct DdIo *out,
3850 res = qemu_strtosz_suffix(arg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3852 if (res <= 0 || res > INT_MAX || *end) {
3853 error_report("invalid number: '%s'", arg);
3856 in->bsz = out->bsz = res;
3861 static int img_dd_count(const char *arg,
3862 struct DdIo *in, struct DdIo *out,
3867 dd->count = qemu_strtosz_suffix(arg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3869 if (dd->count < 0 || *end) {
3870 error_report("invalid number: '%s'", arg);
3877 static int img_dd_if(const char *arg,
3878 struct DdIo *in, struct DdIo *out,
3881 in->filename = g_strdup(arg);
3886 static int img_dd_of(const char *arg,
3887 struct DdIo *in, struct DdIo *out,
3890 out->filename = g_strdup(arg);
3895 static int img_dd_skip(const char *arg,
3896 struct DdIo *in, struct DdIo *out,
3901 in->offset = qemu_strtosz_suffix(arg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3903 if (in->offset < 0 || *end) {
3904 error_report("invalid number: '%s'", arg);
3911 static int img_dd(int argc, char **argv)
3916 BlockDriver *drv = NULL, *proto_drv = NULL;
3917 BlockBackend *blk1 = NULL, *blk2 = NULL;
3918 QemuOpts *opts = NULL;
3919 QemuOptsList *create_opts = NULL;
3920 Error *local_err = NULL;
3921 bool image_opts = false;
3923 const char *out_fmt = "raw";
3924 const char *fmt = NULL;
3926 int64_t block_count = 0, out_pos, in_pos;
3927 struct DdInfo dd = {
3932 .bsz = 512, /* Block size is by default 512 bytes */
3944 const struct DdOpts options[] = {
3945 { "bs", img_dd_bs, C_BS },
3946 { "count", img_dd_count, C_COUNT },
3947 { "if", img_dd_if, C_IF },
3948 { "of", img_dd_of, C_OF },
3949 { "skip", img_dd_skip, C_SKIP },
3952 const struct option long_options[] = {
3953 { "help", no_argument, 0, 'h'},
3954 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3958 while ((c = getopt_long(argc, argv, "hf:O:", long_options, NULL))) {
3970 error_report("Try 'qemu-img --help' for more information.");
3976 case OPTION_IMAGE_OPTS:
3982 for (i = optind; i < argc; i++) {
3984 arg = g_strdup(argv[i]);
3986 tmp = strchr(arg, '=');
3988 error_report("unrecognized operand %s", arg);
3995 for (j = 0; options[j].name != NULL; j++) {
3996 if (!strcmp(arg, options[j].name)) {
4000 if (options[j].name == NULL) {
4001 error_report("unrecognized operand %s", arg);
4006 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4010 dd.flags |= options[j].flag;
4015 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4016 error_report("Must specify both input and output files");
4020 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);
4027 drv = bdrv_find_format(out_fmt);
4029 error_report("Unknown file format");
4033 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4036 error_report_err(local_err);
4040 if (!drv->create_opts) {
4041 error_report("Format driver '%s' does not support image creation",
4046 if (!proto_drv->create_opts) {
4047 error_report("Protocol driver '%s' does not support image creation",
4048 proto_drv->format_name);
4052 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4053 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4055 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4057 size = blk_getlength(blk1);
4059 error_report("Failed to get size for '%s'", in.filename);
4064 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4065 dd.count * in.bsz < size) {
4066 size = dd.count * in.bsz;
4069 /* Overflow means the specified offset is beyond input image's size */
4070 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4071 size < in.bsz * in.offset)) {
4072 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4074 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4075 size - in.bsz * in.offset, &error_abort);
4078 ret = bdrv_create(drv, out.filename, opts, &local_err);
4080 error_reportf_err(local_err,
4081 "%s: error while creating output image: ",
4087 blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
4095 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4096 size < in.offset * in.bsz)) {
4097 /* We give a warning if the skip option is bigger than the input
4098 * size and create an empty output disk image (i.e. like dd(1)).
4100 error_report("%s: cannot skip to specified offset", in.filename);
4103 in_pos = in.offset * in.bsz;
4106 in.buf = g_new(uint8_t, in.bsz);
4108 for (out_pos = 0; in_pos < size; block_count++) {
4109 int in_ret, out_ret;
4111 if (in_pos + in.bsz > size) {
4112 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4114 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4117 error_report("error while reading from input image file: %s",
4124 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4127 error_report("error while writing to output image file: %s",
4128 strerror(-out_ret));
4137 qemu_opts_del(opts);
4138 qemu_opts_free(create_opts);
4141 g_free(in.filename);
4142 g_free(out.filename);
4153 static const img_cmd_t img_cmds[] = {
4154 #define DEF(option, callback, arg_string) \
4155 { option, callback },
4156 #include "qemu-img-cmds.h"
4162 int main(int argc, char **argv)
4164 const img_cmd_t *cmd;
4165 const char *cmdname;
4166 Error *local_error = NULL;
4167 char *trace_file = NULL;
4169 static const struct option long_options[] = {
4170 {"help", no_argument, 0, 'h'},
4171 {"version", no_argument, 0, 'V'},
4172 {"trace", required_argument, NULL, 'T'},
4177 signal(SIGPIPE, SIG_IGN);
4180 module_call_init(MODULE_INIT_TRACE);
4181 error_set_progname(argv[0]);
4182 qemu_init_exec_dir(argv[0]);
4184 if (qemu_init_main_loop(&local_error)) {
4185 error_report_err(local_error);
4189 qcrypto_init(&error_fatal);
4191 module_call_init(MODULE_INIT_QOM);
4194 error_exit("Not enough arguments");
4197 qemu_add_opts(&qemu_object_opts);
4198 qemu_add_opts(&qemu_source_opts);
4199 qemu_add_opts(&qemu_trace_opts);
4201 while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) {
4207 printf(QEMU_IMG_VERSION);
4211 trace_file = trace_opt_parse(optarg);
4216 cmdname = argv[optind];
4218 /* reset getopt_long scanning */
4226 if (!trace_init_backends()) {
4229 trace_init_file(trace_file);
4230 qemu_set_log(LOG_TRACE);
4232 /* find the command */
4233 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4234 if (!strcmp(cmdname, cmd->name)) {
4235 return cmd->handler(argc, argv);
4240 error_exit("Command not found: %s", cmdname);