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 "qapi-visit.h"
25 #include "qapi/qmp-output-visitor.h"
26 #include "qapi/qmp/qjson.h"
27 #include "qemu-common.h"
28 #include "qemu/option.h"
29 #include "qemu/error-report.h"
30 #include "qemu/osdep.h"
31 #include "sysemu/sysemu.h"
32 #include "sysemu/block-backend.h"
33 #include "block/block_int.h"
34 #include "block/qapi.h"
37 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION \
38 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
40 typedef struct img_cmd_t {
42 int (*handler)(int argc, char **argv);
47 OPTION_BACKING_CHAIN = 257,
50 typedef enum OutputFormat {
55 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
56 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
57 #define BDRV_DEFAULT_CACHE "writeback"
59 static void format_print(void *opaque, const char *name)
64 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
68 error_printf("qemu-img: ");
71 error_vprintf(fmt, ap);
74 error_printf("\nTry 'qemu-img --help' for more information\n");
78 /* Please keep in synch with qemu-img.texi */
79 static void QEMU_NORETURN help(void)
81 const char *help_msg =
83 "usage: qemu-img command [command options]\n"
84 "QEMU disk image utility\n"
87 #define DEF(option, callback, arg_string) \
89 #include "qemu-img-cmds.h"
93 "Command parameters:\n"
94 " 'filename' is a disk image filename\n"
95 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
96 " 'cache' is the cache mode used to write the output disk image, the valid\n"
97 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
98 " 'directsync' and 'unsafe' (default for convert)\n"
99 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
100 " options are the same as for the 'cache' option\n"
101 " 'size' is the disk image size in bytes. Optional suffixes\n"
102 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
103 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
104 " supported. 'b' is ignored.\n"
105 " 'output_filename' is the destination disk image filename\n"
106 " 'output_fmt' is the destination format\n"
107 " 'options' is a comma separated list of format specific options in a\n"
108 " name=value format. Use -o ? for an overview of the options supported by the\n"
110 " 'snapshot_param' is param used for internal snapshot, format\n"
111 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
113 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
115 " '-c' indicates that target image must be compressed (qcow format only)\n"
116 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
117 " match exactly. The image doesn't need a working backing file before\n"
118 " rebasing in this case (useful for renaming the backing file)\n"
119 " '-h' with or without a command shows this help and lists the supported formats\n"
120 " '-p' show progress of command (only certain commands)\n"
121 " '-q' use Quiet mode - do not print any output (except errors)\n"
122 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
123 " contain only zeros for qemu-img to create a sparse image during\n"
124 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
125 " unallocated or zero sectors, and the destination image will always be\n"
127 " '--output' takes the format in which the output must be done (human or json)\n"
128 " '-n' skips the target volume creation (useful if the volume is created\n"
129 " prior to running qemu-img)\n"
131 "Parameters to check subcommand:\n"
132 " '-r' tries to repair any inconsistencies that are found during the check.\n"
133 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
134 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
135 " hiding corruption that has already occurred.\n"
137 "Parameters to snapshot subcommand:\n"
138 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
139 " '-a' applies a snapshot (revert disk to saved state)\n"
140 " '-c' creates a snapshot\n"
141 " '-d' deletes a snapshot\n"
142 " '-l' lists all snapshots in the given image\n"
144 "Parameters to compare subcommand:\n"
145 " '-f' first image format\n"
146 " '-F' second image format\n"
147 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
149 printf("%s\nSupported formats:", help_msg);
150 bdrv_iterate_format(format_print, NULL);
155 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
161 ret = vprintf(fmt, args);
168 /* XXX: put correct support for win32 */
169 static int read_password(char *buf, int buf_size)
173 printf("Password: ");
181 } else if (c == '\n') {
183 } else if (i < (buf_size - 1)) {
195 static struct termios oldtty;
197 static void term_exit(void)
199 tcsetattr (0, TCSANOW, &oldtty);
202 static void term_init(void)
209 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
210 |INLCR|IGNCR|ICRNL|IXON);
211 tty.c_oflag |= OPOST;
212 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
213 tty.c_cflag &= ~(CSIZE|PARENB);
218 tcsetattr (0, TCSANOW, &tty);
223 static int read_password(char *buf, int buf_size)
228 printf("password: ");
233 ret = read(0, &ch, 1);
235 if (errno == EAGAIN || errno == EINTR) {
240 } else if (ret == 0) {
248 if (i < (buf_size - 1))
259 static int print_block_option_help(const char *filename, const char *fmt)
261 BlockDriver *drv, *proto_drv;
262 QemuOptsList *create_opts = NULL;
264 /* Find driver and parse its options */
265 drv = bdrv_find_format(fmt);
267 error_report("Unknown file format '%s'", fmt);
271 create_opts = qemu_opts_append(create_opts, drv->create_opts);
273 proto_drv = bdrv_find_protocol(filename, true);
275 error_report("Unknown protocol '%s'", filename);
276 qemu_opts_free(create_opts);
279 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
282 qemu_opts_print_help(create_opts);
283 qemu_opts_free(create_opts);
287 static BlockBackend *img_open(const char *id, const char *filename,
288 const char *fmt, int flags,
289 bool require_io, bool quiet)
292 BlockDriverState *bs;
295 Error *local_err = NULL;
298 blk = blk_new_with_bs(id, &error_abort);
302 drv = bdrv_find_format(fmt);
304 error_report("Unknown file format '%s'", fmt);
311 ret = bdrv_open(&bs, filename, NULL, NULL, flags, drv, &local_err);
313 error_report("Could not open '%s': %s", filename,
314 error_get_pretty(local_err));
315 error_free(local_err);
319 if (bdrv_is_encrypted(bs) && require_io) {
320 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
321 if (read_password(password, sizeof(password)) < 0) {
322 error_report("No password given");
325 if (bdrv_set_key(bs, password) < 0) {
326 error_report("invalid password");
336 static int add_old_style_options(const char *fmt, QemuOpts *opts,
337 const char *base_filename,
338 const char *base_fmt)
341 if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename)) {
342 error_report("Backing file not supported for file format '%s'",
348 if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt)) {
349 error_report("Backing file format not supported for file "
357 static int img_create(int argc, char **argv)
360 uint64_t img_size = -1;
361 const char *fmt = "raw";
362 const char *base_fmt = NULL;
363 const char *filename;
364 const char *base_filename = NULL;
365 char *options = NULL;
366 Error *local_err = NULL;
370 c = getopt(argc, argv, "F:b:f:he6o:q");
383 base_filename = optarg;
389 error_report("option -e is deprecated, please use \'-o "
390 "encryption\' instead!");
393 error_report("option -6 is deprecated, please use \'-o "
394 "compat6\' instead!");
397 if (!is_valid_option_list(optarg)) {
398 error_report("Invalid option list: %s", optarg);
402 options = g_strdup(optarg);
404 char *old_options = options;
405 options = g_strdup_printf("%s,%s", options, optarg);
415 /* Get the filename */
416 filename = (optind < argc) ? argv[optind] : NULL;
417 if (options && has_help_option(options)) {
419 return print_block_option_help(filename, fmt);
422 if (optind >= argc) {
423 error_exit("Expecting image file name");
427 /* Get image size, if specified */
431 sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
432 if (sval < 0 || *end) {
433 if (sval == -ERANGE) {
434 error_report("Image size must be less than 8 EiB!");
436 error_report("Invalid image size specified! You may use k, M, "
437 "G, T, P or E suffixes for ");
438 error_report("kilobytes, megabytes, gigabytes, terabytes, "
439 "petabytes and exabytes.");
443 img_size = (uint64_t)sval;
445 if (optind != argc) {
446 error_exit("Unexpected argument: %s", argv[optind]);
449 bdrv_img_create(filename, fmt, base_filename, base_fmt,
450 options, img_size, BDRV_O_FLAGS, &local_err, quiet);
452 error_report("%s: %s", filename, error_get_pretty(local_err));
453 error_free(local_err);
465 static void dump_json_image_check(ImageCheck *check, bool quiet)
467 Error *local_err = NULL;
469 QmpOutputVisitor *ov = qmp_output_visitor_new();
471 visit_type_ImageCheck(qmp_output_get_visitor(ov),
472 &check, NULL, &local_err);
473 obj = qmp_output_get_qobject(ov);
474 str = qobject_to_json_pretty(obj);
476 qprintf(quiet, "%s\n", qstring_get_str(str));
478 qmp_output_visitor_cleanup(ov);
482 static void dump_human_image_check(ImageCheck *check, bool quiet)
484 if (!(check->corruptions || check->leaks || check->check_errors)) {
485 qprintf(quiet, "No errors were found on the image.\n");
487 if (check->corruptions) {
488 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
489 "Data may be corrupted, or further writes to the image "
496 "\n%" PRId64 " leaked clusters were found on the image.\n"
497 "This means waste of disk space, but no harm to data.\n",
501 if (check->check_errors) {
504 " internal errors have occurred during the check.\n",
505 check->check_errors);
509 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
510 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
511 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
512 check->allocated_clusters, check->total_clusters,
513 check->allocated_clusters * 100.0 / check->total_clusters,
514 check->fragmented_clusters * 100.0 / check->allocated_clusters,
515 check->compressed_clusters * 100.0 /
516 check->allocated_clusters);
519 if (check->image_end_offset) {
521 "Image end offset: %" PRId64 "\n", check->image_end_offset);
525 static int collect_image_check(BlockDriverState *bs,
527 const char *filename,
532 BdrvCheckResult result;
534 ret = bdrv_check(bs, &result, fix);
539 check->filename = g_strdup(filename);
540 check->format = g_strdup(bdrv_get_format_name(bs));
541 check->check_errors = result.check_errors;
542 check->corruptions = result.corruptions;
543 check->has_corruptions = result.corruptions != 0;
544 check->leaks = result.leaks;
545 check->has_leaks = result.leaks != 0;
546 check->corruptions_fixed = result.corruptions_fixed;
547 check->has_corruptions_fixed = result.corruptions != 0;
548 check->leaks_fixed = result.leaks_fixed;
549 check->has_leaks_fixed = result.leaks != 0;
550 check->image_end_offset = result.image_end_offset;
551 check->has_image_end_offset = result.image_end_offset != 0;
552 check->total_clusters = result.bfi.total_clusters;
553 check->has_total_clusters = result.bfi.total_clusters != 0;
554 check->allocated_clusters = result.bfi.allocated_clusters;
555 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
556 check->fragmented_clusters = result.bfi.fragmented_clusters;
557 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
558 check->compressed_clusters = result.bfi.compressed_clusters;
559 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
565 * Checks an image for consistency. Exit codes:
567 * 0 - Check completed, image is good
568 * 1 - Check not completed because of internal errors
569 * 2 - Check completed, image is corrupted
570 * 3 - Check completed, image has leaked clusters, but is good otherwise
571 * 63 - Checks are not supported by the image format
573 static int img_check(int argc, char **argv)
576 OutputFormat output_format = OFORMAT_HUMAN;
577 const char *filename, *fmt, *output, *cache;
579 BlockDriverState *bs;
581 int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
587 cache = BDRV_DEFAULT_CACHE;
589 int option_index = 0;
590 static const struct option long_options[] = {
591 {"help", no_argument, 0, 'h'},
592 {"format", required_argument, 0, 'f'},
593 {"repair", required_argument, 0, 'r'},
594 {"output", required_argument, 0, OPTION_OUTPUT},
597 c = getopt_long(argc, argv, "hf:r:T:q",
598 long_options, &option_index);
611 flags |= BDRV_O_RDWR;
613 if (!strcmp(optarg, "leaks")) {
614 fix = BDRV_FIX_LEAKS;
615 } else if (!strcmp(optarg, "all")) {
616 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
618 error_exit("Unknown option value for -r "
619 "(expecting 'leaks' or 'all'): %s", optarg);
633 if (optind != argc - 1) {
634 error_exit("Expecting one image file name");
636 filename = argv[optind++];
638 if (output && !strcmp(output, "json")) {
639 output_format = OFORMAT_JSON;
640 } else if (output && !strcmp(output, "human")) {
641 output_format = OFORMAT_HUMAN;
643 error_report("--output must be used with human or json as argument.");
647 ret = bdrv_parse_cache_flags(cache, &flags);
649 error_report("Invalid source cache option: %s", cache);
653 blk = img_open("image", filename, fmt, flags, true, quiet);
659 check = g_new0(ImageCheck, 1);
660 ret = collect_image_check(bs, check, filename, fmt, fix);
662 if (ret == -ENOTSUP) {
663 error_report("This image format does not support checks");
668 if (check->corruptions_fixed || check->leaks_fixed) {
669 int corruptions_fixed, leaks_fixed;
671 leaks_fixed = check->leaks_fixed;
672 corruptions_fixed = check->corruptions_fixed;
674 if (output_format == OFORMAT_HUMAN) {
676 "The following inconsistencies were found and repaired:\n\n"
677 " %" PRId64 " leaked clusters\n"
678 " %" PRId64 " corruptions\n\n"
679 "Double checking the fixed image now...\n",
681 check->corruptions_fixed);
684 ret = collect_image_check(bs, check, filename, fmt, 0);
686 check->leaks_fixed = leaks_fixed;
687 check->corruptions_fixed = corruptions_fixed;
691 switch (output_format) {
693 dump_human_image_check(check, quiet);
696 dump_json_image_check(check, quiet);
701 if (ret || check->check_errors) {
703 error_report("Check failed: %s", strerror(-ret));
705 error_report("Check failed");
711 if (check->corruptions) {
713 } else if (check->leaks) {
720 qapi_free_ImageCheck(check);
725 static int img_commit(int argc, char **argv)
728 const char *filename, *fmt, *cache;
730 BlockDriverState *bs;
734 cache = BDRV_DEFAULT_CACHE;
736 c = getopt(argc, argv, "f:ht:q");
756 if (optind != argc - 1) {
757 error_exit("Expecting one image file name");
759 filename = argv[optind++];
762 ret = bdrv_parse_cache_flags(cache, &flags);
764 error_report("Invalid cache option: %s", cache);
768 blk = img_open("image", filename, fmt, flags, true, quiet);
774 ret = bdrv_commit(bs);
777 qprintf(quiet, "Image committed.\n");
780 error_report("No disk inserted");
783 error_report("Image is read-only");
786 error_report("Image is already committed");
789 error_report("Error while committing image");
801 * Returns true iff the first sector pointed to by 'buf' contains at least
804 * 'pnum' is set to the number of sectors (including and immediately following
805 * the first one) that are known to be in the same allocated/unallocated state.
807 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
816 is_zero = buffer_is_zero(buf, 512);
817 for(i = 1; i < n; i++) {
819 if (is_zero != buffer_is_zero(buf, 512)) {
828 * Like is_allocated_sectors, but if the buffer starts with a used sector,
829 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
830 * breaking up write requests for only small sparse areas.
832 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
836 int num_checked, num_used;
842 ret = is_allocated_sectors(buf, n, pnum);
848 buf += BDRV_SECTOR_SIZE * *pnum;
850 num_checked = num_used;
853 ret = is_allocated_sectors(buf, n, pnum);
855 buf += BDRV_SECTOR_SIZE * *pnum;
857 num_checked += *pnum;
859 num_used = num_checked;
860 } else if (*pnum >= min) {
870 * Compares two buffers sector by sector. Returns 0 if the first sector of both
871 * buffers matches, non-zero otherwise.
873 * pnum is set to the number of sectors (including and immediately following
874 * the first one) that are known to have the same comparison result
876 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
886 res = !!memcmp(buf1, buf2, 512);
887 for(i = 1; i < n; i++) {
891 if (!!memcmp(buf1, buf2, 512) != res) {
900 #define IO_BUF_SIZE (2 * 1024 * 1024)
902 static int64_t sectors_to_bytes(int64_t sectors)
904 return sectors << BDRV_SECTOR_BITS;
907 static int64_t sectors_to_process(int64_t total, int64_t from)
909 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
913 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
915 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
916 * data and negative value on error.
918 * @param bs: Driver used for accessing file
919 * @param sect_num: Number of first sector to check
920 * @param sect_count: Number of sectors to check
921 * @param filename: Name of disk file we are checking (logging purpose)
922 * @param buffer: Allocated buffer for storing read data
923 * @param quiet: Flag for quiet mode
925 static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
926 int sect_count, const char *filename,
927 uint8_t *buffer, bool quiet)
930 ret = bdrv_read(bs, sect_num, buffer, sect_count);
932 error_report("Error while reading offset %" PRId64 " of %s: %s",
933 sectors_to_bytes(sect_num), filename, strerror(-ret));
936 ret = is_allocated_sectors(buffer, sect_count, &pnum);
937 if (ret || pnum != sect_count) {
938 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
939 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
947 * Compares two images. Exit codes:
949 * 0 - Images are identical
951 * >1 - Error occurred
953 static int img_compare(int argc, char **argv)
955 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
956 BlockBackend *blk1, *blk2;
957 BlockDriverState *bs1, *bs2;
958 int64_t total_sectors1, total_sectors2;
959 uint8_t *buf1 = NULL, *buf2 = NULL;
961 int allocated1, allocated2;
962 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
963 bool progress = false, quiet = false, strict = false;
965 int64_t total_sectors;
966 int64_t sector_num = 0;
969 uint64_t progress_base;
971 cache = BDRV_DEFAULT_CACHE;
973 c = getopt(argc, argv, "hf:F:T:pqs");
1003 /* Progress is not shown in Quiet mode */
1009 if (optind != argc - 2) {
1010 error_exit("Expecting two image file names");
1012 filename1 = argv[optind++];
1013 filename2 = argv[optind++];
1015 /* Initialize before goto out */
1016 qemu_progress_init(progress, 2.0);
1018 flags = BDRV_O_FLAGS;
1019 ret = bdrv_parse_cache_flags(cache, &flags);
1021 error_report("Invalid source cache option: %s", cache);
1026 blk1 = img_open("image_1", filename1, fmt1, flags, true, quiet);
1028 error_report("Can't open file %s", filename1);
1034 blk2 = img_open("image_2", filename2, fmt2, flags, true, quiet);
1036 error_report("Can't open file %s", filename2);
1042 buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
1043 buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
1044 total_sectors1 = bdrv_nb_sectors(bs1);
1045 if (total_sectors1 < 0) {
1046 error_report("Can't get size of %s: %s",
1047 filename1, strerror(-total_sectors1));
1051 total_sectors2 = bdrv_nb_sectors(bs2);
1052 if (total_sectors2 < 0) {
1053 error_report("Can't get size of %s: %s",
1054 filename2, strerror(-total_sectors2));
1058 total_sectors = MIN(total_sectors1, total_sectors2);
1059 progress_base = MAX(total_sectors1, total_sectors2);
1061 qemu_progress_print(0, 100);
1063 if (strict && total_sectors1 != total_sectors2) {
1065 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1070 nb_sectors = sectors_to_process(total_sectors, sector_num);
1071 if (nb_sectors <= 0) {
1074 allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1076 if (allocated1 < 0) {
1078 error_report("Sector allocation test failed for %s", filename1);
1082 allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1084 if (allocated2 < 0) {
1086 error_report("Sector allocation test failed for %s", filename2);
1089 nb_sectors = MIN(pnum1, pnum2);
1091 if (allocated1 == allocated2) {
1093 ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
1095 error_report("Error while reading offset %" PRId64 " of %s:"
1096 " %s", sectors_to_bytes(sector_num), filename1,
1101 ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
1103 error_report("Error while reading offset %" PRId64
1104 " of %s: %s", sectors_to_bytes(sector_num),
1105 filename2, strerror(-ret));
1109 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1110 if (ret || pnum != nb_sectors) {
1111 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1113 ret ? sector_num : sector_num + pnum));
1121 qprintf(quiet, "Strict mode: Offset %" PRId64
1122 " allocation mismatch!\n",
1123 sectors_to_bytes(sector_num));
1128 ret = check_empty_sectors(bs1, sector_num, nb_sectors,
1129 filename1, buf1, quiet);
1131 ret = check_empty_sectors(bs2, sector_num, nb_sectors,
1132 filename2, buf1, quiet);
1136 error_report("Error while reading offset %" PRId64 ": %s",
1137 sectors_to_bytes(sector_num), strerror(-ret));
1143 sector_num += nb_sectors;
1144 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1147 if (total_sectors1 != total_sectors2) {
1148 BlockDriverState *bs_over;
1149 int64_t total_sectors_over;
1150 const char *filename_over;
1152 qprintf(quiet, "Warning: Image size mismatch!\n");
1153 if (total_sectors1 > total_sectors2) {
1154 total_sectors_over = total_sectors1;
1156 filename_over = filename1;
1158 total_sectors_over = total_sectors2;
1160 filename_over = filename2;
1164 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1165 if (nb_sectors <= 0) {
1168 ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
1172 error_report("Sector allocation test failed for %s",
1179 ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
1180 filename_over, buf1, quiet);
1183 error_report("Error while reading offset %" PRId64
1184 " of %s: %s", sectors_to_bytes(sector_num),
1185 filename_over, strerror(-ret));
1191 sector_num += nb_sectors;
1192 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1196 qprintf(quiet, "Images are identical.\n");
1206 qemu_progress_end();
1210 static int img_convert(int argc, char **argv)
1212 int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
1214 int progress = 0, flags, src_flags;
1215 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1216 BlockDriver *drv, *proto_drv;
1217 BlockBackend **blk = NULL, *out_blk = NULL;
1218 BlockDriverState **bs = NULL, *out_bs = NULL;
1219 int64_t total_sectors, nb_sectors, sector_num, bs_offset;
1220 int64_t *bs_sectors = NULL;
1221 uint8_t * buf = NULL;
1222 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1223 const uint8_t *buf1;
1224 BlockDriverInfo bdi;
1225 QemuOpts *opts = NULL;
1226 QemuOptsList *create_opts = NULL;
1227 const char *out_baseimg_param;
1228 char *options = NULL;
1229 const char *snapshot_name = NULL;
1230 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1232 Error *local_err = NULL;
1233 QemuOpts *sn_opts = NULL;
1238 src_cache = BDRV_DEFAULT_CACHE;
1243 c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1259 out_baseimg = optarg;
1265 error_report("option -e is deprecated, please use \'-o "
1266 "encryption\' instead!");
1270 error_report("option -6 is deprecated, please use \'-o "
1271 "compat6\' instead!");
1275 if (!is_valid_option_list(optarg)) {
1276 error_report("Invalid option list: %s", optarg);
1281 options = g_strdup(optarg);
1283 char *old_options = options;
1284 options = g_strdup_printf("%s,%s", options, optarg);
1285 g_free(old_options);
1289 snapshot_name = optarg;
1292 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1293 sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
1295 error_report("Failed in parsing snapshot param '%s'",
1301 snapshot_name = optarg;
1308 sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
1309 if (sval < 0 || *end) {
1310 error_report("Invalid minimum zero buffer size for sparse output specified");
1315 min_sparse = sval / BDRV_SECTOR_SIZE;
1336 /* Initialize before goto out */
1340 qemu_progress_init(progress, 1.0);
1343 bs_n = argc - optind - 1;
1344 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1346 if (options && has_help_option(options)) {
1347 ret = print_block_option_help(out_filename, out_fmt);
1352 error_exit("Must specify image file name");
1356 if (bs_n > 1 && out_baseimg) {
1357 error_report("-B makes no sense when concatenating multiple input "
1363 src_flags = BDRV_O_FLAGS;
1364 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
1366 error_report("Invalid source cache option: %s", src_cache);
1370 qemu_progress_print(0, 100);
1372 blk = g_new0(BlockBackend *, bs_n);
1373 bs = g_new0(BlockDriverState *, bs_n);
1374 bs_sectors = g_new(int64_t, bs_n);
1377 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1378 char *id = bs_n > 1 ? g_strdup_printf("source_%d", bs_i)
1379 : g_strdup("source");
1380 blk[bs_i] = img_open(id, argv[optind + bs_i], fmt, src_flags,
1384 error_report("Could not open '%s'", argv[optind + bs_i]);
1388 bs[bs_i] = blk_bs(blk[bs_i]);
1389 bs_sectors[bs_i] = bdrv_nb_sectors(bs[bs_i]);
1390 if (bs_sectors[bs_i] < 0) {
1391 error_report("Could not get size of %s: %s",
1392 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1396 total_sectors += bs_sectors[bs_i];
1400 ret = bdrv_snapshot_load_tmp(bs[0],
1401 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1402 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1404 } else if (snapshot_name != NULL) {
1406 error_report("No support for concatenating multiple snapshot");
1411 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1414 error_report("Failed to load snapshot: %s",
1415 error_get_pretty(local_err));
1416 error_free(local_err);
1421 /* Find driver and parse its options */
1422 drv = bdrv_find_format(out_fmt);
1424 error_report("Unknown file format '%s'", out_fmt);
1429 proto_drv = bdrv_find_protocol(out_filename, true);
1431 error_report("Unknown protocol '%s'", out_filename);
1436 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1437 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1439 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1440 if (options && qemu_opts_do_parse(opts, options, NULL)) {
1441 error_report("Invalid options for file format '%s'", out_fmt);
1446 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512);
1447 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
1452 /* Get backing file name if -o backing_file was used */
1453 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1454 if (out_baseimg_param) {
1455 out_baseimg = out_baseimg_param;
1458 /* Check if compression is supported */
1461 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
1462 const char *preallocation =
1463 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
1465 if (!drv->bdrv_write_compressed) {
1466 error_report("Compression not supported for this file format");
1472 error_report("Compression and encryption not supported at "
1479 && strcmp(preallocation, "off"))
1481 error_report("Compression and preallocation not supported at "
1489 /* Create the new image */
1490 ret = bdrv_create(drv, out_filename, opts, &local_err);
1492 error_report("%s: error while converting %s: %s",
1493 out_filename, out_fmt, error_get_pretty(local_err));
1494 error_free(local_err);
1499 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1500 ret = bdrv_parse_cache_flags(cache, &flags);
1502 error_report("Invalid cache option: %s", cache);
1506 out_blk = img_open("target", out_filename, out_fmt, flags, true, quiet);
1511 out_bs = blk_bs(out_blk);
1516 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1517 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1519 bufsectors = MIN(32768,
1520 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
1521 out_bs->bl.discard_alignment))
1524 buf = qemu_blockalign(out_bs, bufsectors * BDRV_SECTOR_SIZE);
1527 int64_t output_sectors = bdrv_nb_sectors(out_bs);
1528 if (output_sectors < 0) {
1529 error_report("unable to get output image length: %s\n",
1530 strerror(-output_sectors));
1533 } else if (output_sectors < total_sectors) {
1534 error_report("output file is smaller than input file");
1540 cluster_sectors = 0;
1541 ret = bdrv_get_info(out_bs, &bdi);
1544 error_report("could not get block driver info");
1548 compress = compress || bdi.needs_compressed_writes;
1549 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1553 if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
1554 error_report("invalid cluster size");
1560 nb_sectors = total_sectors;
1567 nb_sectors = total_sectors - sector_num;
1568 if (nb_sectors <= 0)
1570 if (nb_sectors >= cluster_sectors)
1571 n = cluster_sectors;
1575 bs_num = sector_num - bs_offset;
1576 assert (bs_num >= 0);
1579 while (remainder > 0) {
1581 while (bs_num == bs_sectors[bs_i]) {
1582 bs_offset += bs_sectors[bs_i];
1584 assert (bs_i < bs_n);
1586 /* printf("changing part: sector_num=%" PRId64 ", "
1587 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1588 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1590 assert (bs_num < bs_sectors[bs_i]);
1592 nlow = remainder > bs_sectors[bs_i] - bs_num
1593 ? bs_sectors[bs_i] - bs_num : remainder;
1595 ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
1597 error_report("error while reading sector %" PRId64 ": %s",
1598 bs_num, strerror(-ret));
1607 assert (remainder == 0);
1609 if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
1610 ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
1612 error_report("error while compressing sector %" PRId64
1613 ": %s", sector_num, strerror(-ret));
1618 qemu_progress_print(100.0 * sector_num / total_sectors, 0);
1620 /* signal EOF to align */
1621 bdrv_write_compressed(out_bs, 0, NULL, 0);
1623 int64_t sectors_to_read, sectors_read, sector_num_next_status;
1624 bool count_allocated_sectors;
1625 int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
1627 if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
1628 ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
1635 sectors_to_read = total_sectors;
1636 count_allocated_sectors = progress && (out_baseimg || has_zero_init);
1638 sector_num = 0; // total number of sectors converted so far
1640 sector_num_next_status = 0;
1643 nb_sectors = total_sectors - sector_num;
1644 if (nb_sectors <= 0) {
1645 if (count_allocated_sectors) {
1646 sectors_to_read = sectors_read;
1647 count_allocated_sectors = false;
1654 while (sector_num - bs_offset >= bs_sectors[bs_i]) {
1655 bs_offset += bs_sectors[bs_i];
1657 assert (bs_i < bs_n);
1658 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1659 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1660 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1663 if ((out_baseimg || has_zero_init) &&
1664 sector_num >= sector_num_next_status) {
1665 n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
1666 ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
1669 error_report("error while reading block status of sector %"
1670 PRId64 ": %s", sector_num - bs_offset,
1674 /* If the output image is zero initialized, we are not working
1675 * on a shared base and the input is zero we can skip the next
1677 if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
1681 /* If the output image is being created as a copy on write
1682 * image, assume that sectors which are unallocated in the
1683 * input image are present in both the output's and input's
1684 * base images (no need to copy them). */
1686 if (!(ret & BDRV_BLOCK_DATA)) {
1690 /* The next 'n1' sectors are allocated in the input image.
1691 * Copy only those as they may be followed by unallocated
1695 /* avoid redundant callouts to get_block_status */
1696 sector_num_next_status = sector_num + n1;
1699 n = MIN(nb_sectors, bufsectors);
1701 /* round down request length to an aligned sector, but
1702 * do not bother doing this on short requests. They happen
1703 * when we found an all-zero area, and the next sector to
1704 * write will not be sector_num + n. */
1705 if (cluster_sectors > 0 && n >= cluster_sectors) {
1706 int64_t next_aligned_sector = (sector_num + n);
1707 next_aligned_sector -= next_aligned_sector % cluster_sectors;
1708 if (sector_num + n > next_aligned_sector) {
1709 n = next_aligned_sector - sector_num;
1713 n = MIN(n, bs_sectors[bs_i] - (sector_num - bs_offset));
1716 if (count_allocated_sectors) {
1722 ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
1724 error_report("error while reading sector %" PRId64 ": %s",
1725 sector_num - bs_offset, strerror(-ret));
1728 /* NOTE: at the same time we convert, we do not write zero
1729 sectors to have a chance to compress the image. Ideally, we
1730 should add a specific call to have the info to go faster */
1733 if (!has_zero_init ||
1734 is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1735 ret = bdrv_write(out_bs, sector_num, buf1, n1);
1737 error_report("error while writing sector %" PRId64
1738 ": %s", sector_num, strerror(-ret));
1746 qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
1751 qemu_progress_print(100, 0);
1753 qemu_progress_end();
1754 qemu_opts_del(opts);
1755 qemu_opts_free(create_opts);
1757 qemu_opts_del(sn_opts);
1761 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1762 blk_unref(blk[bs_i]);
1777 static void dump_snapshots(BlockDriverState *bs)
1779 QEMUSnapshotInfo *sn_tab, *sn;
1782 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1785 printf("Snapshot list:\n");
1786 bdrv_snapshot_dump(fprintf, stdout, NULL);
1788 for(i = 0; i < nb_sns; i++) {
1790 bdrv_snapshot_dump(fprintf, stdout, sn);
1796 static void dump_json_image_info_list(ImageInfoList *list)
1798 Error *local_err = NULL;
1800 QmpOutputVisitor *ov = qmp_output_visitor_new();
1802 visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1803 &list, NULL, &local_err);
1804 obj = qmp_output_get_qobject(ov);
1805 str = qobject_to_json_pretty(obj);
1806 assert(str != NULL);
1807 printf("%s\n", qstring_get_str(str));
1808 qobject_decref(obj);
1809 qmp_output_visitor_cleanup(ov);
1813 static void dump_json_image_info(ImageInfo *info)
1815 Error *local_err = NULL;
1817 QmpOutputVisitor *ov = qmp_output_visitor_new();
1819 visit_type_ImageInfo(qmp_output_get_visitor(ov),
1820 &info, NULL, &local_err);
1821 obj = qmp_output_get_qobject(ov);
1822 str = qobject_to_json_pretty(obj);
1823 assert(str != NULL);
1824 printf("%s\n", qstring_get_str(str));
1825 qobject_decref(obj);
1826 qmp_output_visitor_cleanup(ov);
1830 static void dump_human_image_info_list(ImageInfoList *list)
1832 ImageInfoList *elem;
1835 for (elem = list; elem; elem = elem->next) {
1841 bdrv_image_info_dump(fprintf, stdout, elem->value);
1845 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1847 return strcmp(a, b) == 0;
1851 * Open an image file chain and return an ImageInfoList
1853 * @filename: topmost image filename
1854 * @fmt: topmost image format (may be NULL to autodetect)
1855 * @chain: true - enumerate entire backing file chain
1856 * false - only topmost image file
1858 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1859 * image file. If there was an error a message will have been printed to
1862 static ImageInfoList *collect_image_info_list(const char *filename,
1866 ImageInfoList *head = NULL;
1867 ImageInfoList **last = &head;
1868 GHashTable *filenames;
1871 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
1875 BlockDriverState *bs;
1877 ImageInfoList *elem;
1879 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
1880 error_report("Backing file '%s' creates an infinite loop.",
1884 g_hash_table_insert(filenames, (gpointer)filename, NULL);
1886 blk = img_open("image", filename, fmt,
1887 BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
1893 bdrv_query_image_info(bs, &info, &err);
1895 error_report("%s", error_get_pretty(err));
1901 elem = g_new0(ImageInfoList, 1);
1908 filename = fmt = NULL;
1910 if (info->has_full_backing_filename) {
1911 filename = info->full_backing_filename;
1912 } else if (info->has_backing_filename) {
1913 filename = info->backing_filename;
1915 if (info->has_backing_filename_format) {
1916 fmt = info->backing_filename_format;
1920 g_hash_table_destroy(filenames);
1924 qapi_free_ImageInfoList(head);
1925 g_hash_table_destroy(filenames);
1929 static int img_info(int argc, char **argv)
1932 OutputFormat output_format = OFORMAT_HUMAN;
1934 const char *filename, *fmt, *output;
1935 ImageInfoList *list;
1940 int option_index = 0;
1941 static const struct option long_options[] = {
1942 {"help", no_argument, 0, 'h'},
1943 {"format", required_argument, 0, 'f'},
1944 {"output", required_argument, 0, OPTION_OUTPUT},
1945 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
1948 c = getopt_long(argc, argv, "f:h",
1949 long_options, &option_index);
1964 case OPTION_BACKING_CHAIN:
1969 if (optind != argc - 1) {
1970 error_exit("Expecting one image file name");
1972 filename = argv[optind++];
1974 if (output && !strcmp(output, "json")) {
1975 output_format = OFORMAT_JSON;
1976 } else if (output && !strcmp(output, "human")) {
1977 output_format = OFORMAT_HUMAN;
1978 } else if (output) {
1979 error_report("--output must be used with human or json as argument.");
1983 list = collect_image_info_list(filename, fmt, chain);
1988 switch (output_format) {
1990 dump_human_image_info_list(list);
1994 dump_json_image_info_list(list);
1996 dump_json_image_info(list->value);
2001 qapi_free_ImageInfoList(list);
2006 typedef struct MapEntry {
2012 BlockDriverState *bs;
2015 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2018 switch (output_format) {
2020 if ((e->flags & BDRV_BLOCK_DATA) &&
2021 !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
2022 error_report("File contains external, encrypted or compressed clusters.");
2025 if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
2026 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2027 e->start, e->length, e->offset, e->bs->filename);
2029 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2030 * Modify the flags here to allow more coalescing.
2033 (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
2034 next->flags &= ~BDRV_BLOCK_DATA;
2035 next->flags |= BDRV_BLOCK_ZERO;
2039 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
2040 " \"zero\": %s, \"data\": %s",
2041 (e->start == 0 ? "[" : ",\n"),
2042 e->start, e->length, e->depth,
2043 (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
2044 (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
2045 if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
2046 printf(", \"offset\": %"PRId64"", e->offset);
2057 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2058 int nb_sectors, MapEntry *e)
2063 /* As an optimization, we could cache the current range of unallocated
2064 * clusters in each file of the chain, and avoid querying the same
2070 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
2075 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2078 bs = bs->backing_hd;
2087 e->start = sector_num * BDRV_SECTOR_SIZE;
2088 e->length = nb_sectors * BDRV_SECTOR_SIZE;
2089 e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2090 e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2096 static int img_map(int argc, char **argv)
2099 OutputFormat output_format = OFORMAT_HUMAN;
2101 BlockDriverState *bs;
2102 const char *filename, *fmt, *output;
2104 MapEntry curr = { .length = 0 }, next;
2110 int option_index = 0;
2111 static const struct option long_options[] = {
2112 {"help", no_argument, 0, 'h'},
2113 {"format", required_argument, 0, 'f'},
2114 {"output", required_argument, 0, OPTION_OUTPUT},
2117 c = getopt_long(argc, argv, "f:h",
2118 long_options, &option_index);
2135 if (optind != argc - 1) {
2136 error_exit("Expecting one image file name");
2138 filename = argv[optind];
2140 if (output && !strcmp(output, "json")) {
2141 output_format = OFORMAT_JSON;
2142 } else if (output && !strcmp(output, "human")) {
2143 output_format = OFORMAT_HUMAN;
2144 } else if (output) {
2145 error_report("--output must be used with human or json as argument.");
2149 blk = img_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
2155 if (output_format == OFORMAT_HUMAN) {
2156 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2159 length = bdrv_getlength(bs);
2160 while (curr.start + curr.length < length) {
2161 int64_t nsectors_left;
2165 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2167 /* Probe up to 1 GiB at a time. */
2168 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2169 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2170 ret = get_block_status(bs, sector_num, n, &next);
2173 error_report("Could not read file metadata: %s", strerror(-ret));
2177 if (curr.length != 0 && curr.flags == next.flags &&
2178 curr.depth == next.depth &&
2179 ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2180 curr.offset + curr.length == next.offset)) {
2181 curr.length += next.length;
2185 if (curr.length > 0) {
2186 dump_map_entry(output_format, &curr, &next);
2191 dump_map_entry(output_format, &curr, NULL);
2198 #define SNAPSHOT_LIST 1
2199 #define SNAPSHOT_CREATE 2
2200 #define SNAPSHOT_APPLY 3
2201 #define SNAPSHOT_DELETE 4
2203 static int img_snapshot(int argc, char **argv)
2206 BlockDriverState *bs;
2207 QEMUSnapshotInfo sn;
2208 char *filename, *snapshot_name = NULL;
2209 int c, ret = 0, bdrv_oflags;
2215 bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2216 /* Parse commandline parameters */
2218 c = getopt(argc, argv, "la:c:d:hq");
2229 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2232 action = SNAPSHOT_LIST;
2233 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2237 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2240 action = SNAPSHOT_APPLY;
2241 snapshot_name = optarg;
2245 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2248 action = SNAPSHOT_CREATE;
2249 snapshot_name = optarg;
2253 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2256 action = SNAPSHOT_DELETE;
2257 snapshot_name = optarg;
2265 if (optind != argc - 1) {
2266 error_exit("Expecting one image file name");
2268 filename = argv[optind++];
2270 /* Open the image */
2271 blk = img_open("image", filename, NULL, bdrv_oflags, true, quiet);
2277 /* Perform the requested action */
2283 case SNAPSHOT_CREATE:
2284 memset(&sn, 0, sizeof(sn));
2285 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2287 qemu_gettimeofday(&tv);
2288 sn.date_sec = tv.tv_sec;
2289 sn.date_nsec = tv.tv_usec * 1000;
2291 ret = bdrv_snapshot_create(bs, &sn);
2293 error_report("Could not create snapshot '%s': %d (%s)",
2294 snapshot_name, ret, strerror(-ret));
2298 case SNAPSHOT_APPLY:
2299 ret = bdrv_snapshot_goto(bs, snapshot_name);
2301 error_report("Could not apply snapshot '%s': %d (%s)",
2302 snapshot_name, ret, strerror(-ret));
2306 case SNAPSHOT_DELETE:
2307 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2309 error_report("Could not delete snapshot '%s': (%s)",
2310 snapshot_name, error_get_pretty(err));
2325 static int img_rebase(int argc, char **argv)
2327 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2328 BlockDriverState *bs = NULL, *bs_old_backing = NULL, *bs_new_backing = NULL;
2329 BlockDriver *old_backing_drv, *new_backing_drv;
2331 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2332 int c, flags, src_flags, ret;
2336 Error *local_err = NULL;
2338 /* Parse commandline parameters */
2340 cache = BDRV_DEFAULT_CACHE;
2341 src_cache = BDRV_DEFAULT_CACHE;
2345 c = getopt(argc, argv, "hf:F:b:upt:T:q");
2358 out_basefmt = optarg;
2361 out_baseimg = optarg;
2385 if (optind != argc - 1) {
2386 error_exit("Expecting one image file name");
2388 if (!unsafe && !out_baseimg) {
2389 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2391 filename = argv[optind++];
2393 qemu_progress_init(progress, 2.0);
2394 qemu_progress_print(0, 100);
2396 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2397 ret = bdrv_parse_cache_flags(cache, &flags);
2399 error_report("Invalid cache option: %s", cache);
2403 src_flags = BDRV_O_FLAGS;
2404 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
2406 error_report("Invalid source cache option: %s", src_cache);
2413 * Ignore the old backing file for unsafe rebase in case we want to correct
2414 * the reference to a renamed or moved backing file.
2416 blk = img_open("image", filename, fmt, flags, true, quiet);
2423 /* Find the right drivers for the backing files */
2424 old_backing_drv = NULL;
2425 new_backing_drv = NULL;
2427 if (!unsafe && bs->backing_format[0] != '\0') {
2428 old_backing_drv = bdrv_find_format(bs->backing_format);
2429 if (old_backing_drv == NULL) {
2430 error_report("Invalid format name: '%s'", bs->backing_format);
2436 if (out_basefmt != NULL) {
2437 new_backing_drv = bdrv_find_format(out_basefmt);
2438 if (new_backing_drv == NULL) {
2439 error_report("Invalid format name: '%s'", out_basefmt);
2445 /* For safe rebasing we need to compare old and new backing file */
2447 char backing_name[1024];
2449 blk_old_backing = blk_new_with_bs("old_backing", &error_abort);
2450 bs_old_backing = blk_bs(blk_old_backing);
2451 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2452 ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, src_flags,
2453 old_backing_drv, &local_err);
2455 error_report("Could not open old backing file '%s': %s",
2456 backing_name, error_get_pretty(local_err));
2457 error_free(local_err);
2460 if (out_baseimg[0]) {
2461 blk_new_backing = blk_new_with_bs("new_backing", &error_abort);
2462 bs_new_backing = blk_bs(blk_new_backing);
2463 ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL, src_flags,
2464 new_backing_drv, &local_err);
2466 error_report("Could not open new backing file '%s': %s",
2467 out_baseimg, error_get_pretty(local_err));
2468 error_free(local_err);
2475 * Check each unallocated cluster in the COW file. If it is unallocated,
2476 * accesses go to the backing file. We must therefore compare this cluster
2477 * in the old and new backing file, and if they differ we need to copy it
2478 * from the old backing file into the COW file.
2480 * If qemu-img crashes during this step, no harm is done. The content of
2481 * the image is the same as the original one at any time.
2484 int64_t num_sectors;
2485 int64_t old_backing_num_sectors;
2486 int64_t new_backing_num_sectors = 0;
2491 float local_progress = 0;
2493 buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
2494 buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
2496 num_sectors = bdrv_nb_sectors(bs);
2497 if (num_sectors < 0) {
2498 error_report("Could not get size of '%s': %s",
2499 filename, strerror(-num_sectors));
2503 old_backing_num_sectors = bdrv_nb_sectors(bs_old_backing);
2504 if (old_backing_num_sectors < 0) {
2505 char backing_name[1024];
2507 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2508 error_report("Could not get size of '%s': %s",
2509 backing_name, strerror(-old_backing_num_sectors));
2513 if (bs_new_backing) {
2514 new_backing_num_sectors = bdrv_nb_sectors(bs_new_backing);
2515 if (new_backing_num_sectors < 0) {
2516 error_report("Could not get size of '%s': %s",
2517 out_baseimg, strerror(-new_backing_num_sectors));
2523 if (num_sectors != 0) {
2524 local_progress = (float)100 /
2525 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2528 for (sector = 0; sector < num_sectors; sector += n) {
2530 /* How many sectors can we handle with the next read? */
2531 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2532 n = (IO_BUF_SIZE / 512);
2534 n = num_sectors - sector;
2537 /* If the cluster is allocated, we don't need to take action */
2538 ret = bdrv_is_allocated(bs, sector, n, &n);
2540 error_report("error while reading image metadata: %s",
2549 * Read old and new backing file and take into consideration that
2550 * backing files may be smaller than the COW image.
2552 if (sector >= old_backing_num_sectors) {
2553 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2555 if (sector + n > old_backing_num_sectors) {
2556 n = old_backing_num_sectors - sector;
2559 ret = bdrv_read(bs_old_backing, sector, buf_old, n);
2561 error_report("error while reading from old backing file");
2566 if (sector >= new_backing_num_sectors || !bs_new_backing) {
2567 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2569 if (sector + n > new_backing_num_sectors) {
2570 n = new_backing_num_sectors - sector;
2573 ret = bdrv_read(bs_new_backing, sector, buf_new, n);
2575 error_report("error while reading from new backing file");
2580 /* If they differ, we need to write to the COW file */
2581 uint64_t written = 0;
2583 while (written < n) {
2586 if (compare_sectors(buf_old + written * 512,
2587 buf_new + written * 512, n - written, &pnum))
2589 ret = bdrv_write(bs, sector + written,
2590 buf_old + written * 512, pnum);
2592 error_report("Error while writing to COW image: %s",
2600 qemu_progress_print(local_progress, 100);
2603 qemu_vfree(buf_old);
2604 qemu_vfree(buf_new);
2608 * Change the backing file. All clusters that are different from the old
2609 * backing file are overwritten in the COW file now, so the visible content
2610 * doesn't change when we switch the backing file.
2612 if (out_baseimg && *out_baseimg) {
2613 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2615 ret = bdrv_change_backing_file(bs, NULL, NULL);
2618 if (ret == -ENOSPC) {
2619 error_report("Could not change the backing file to '%s': No "
2620 "space left in the file header", out_baseimg);
2621 } else if (ret < 0) {
2622 error_report("Could not change the backing file to '%s': %s",
2623 out_baseimg, strerror(-ret));
2626 qemu_progress_print(100, 0);
2628 * TODO At this point it is possible to check if any clusters that are
2629 * allocated in the COW file are the same in the backing file. If so, they
2630 * could be dropped from the COW file. Don't do this before switching the
2631 * backing file, in case of a crash this would lead to corruption.
2634 qemu_progress_end();
2637 blk_unref(blk_old_backing);
2638 blk_unref(blk_new_backing);
2648 static int img_resize(int argc, char **argv)
2650 int c, ret, relative;
2651 const char *filename, *fmt, *size;
2652 int64_t n, total_size;
2654 BlockBackend *blk = NULL;
2655 BlockDriverState *bs = NULL;
2657 static QemuOptsList resize_options = {
2658 .name = "resize_options",
2659 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2662 .name = BLOCK_OPT_SIZE,
2663 .type = QEMU_OPT_SIZE,
2664 .help = "Virtual disk size"
2671 /* Remove size from argv manually so that negative numbers are not treated
2672 * as options by getopt. */
2674 error_exit("Not enough arguments");
2678 size = argv[--argc];
2680 /* Parse getopt arguments */
2683 c = getopt(argc, argv, "f:hq");
2700 if (optind != argc - 1) {
2701 error_exit("Expecting one image file name");
2703 filename = argv[optind++];
2705 /* Choose grow, shrink, or absolute resize mode */
2721 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2722 if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
2723 /* Error message already printed when size parsing fails */
2725 qemu_opts_del(param);
2728 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2729 qemu_opts_del(param);
2731 blk = img_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
2740 total_size = bdrv_getlength(bs) + n * relative;
2744 if (total_size <= 0) {
2745 error_report("New image size must be positive");
2750 ret = bdrv_truncate(bs, total_size);
2753 qprintf(quiet, "Image resized.\n");
2756 error_report("This image does not support resize");
2759 error_report("Image is read-only");
2762 error_report("Error resizing image (%d)", -ret);
2773 static int img_amend(int argc, char **argv)
2776 char *options = NULL;
2777 QemuOptsList *create_opts = NULL;
2778 QemuOpts *opts = NULL;
2779 const char *fmt = NULL, *filename, *cache;
2782 BlockBackend *blk = NULL;
2783 BlockDriverState *bs = NULL;
2785 cache = BDRV_DEFAULT_CACHE;
2787 c = getopt(argc, argv, "ho:f:t:q");
2798 if (!is_valid_option_list(optarg)) {
2799 error_report("Invalid option list: %s", optarg);
2804 options = g_strdup(optarg);
2806 char *old_options = options;
2807 options = g_strdup_printf("%s,%s", options, optarg);
2808 g_free(old_options);
2824 error_exit("Must specify options (-o)");
2827 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2828 if (fmt && has_help_option(options)) {
2829 /* If a format is explicitly specified (and possibly no filename is
2830 * given), print option help here */
2831 ret = print_block_option_help(filename, fmt);
2835 if (optind != argc - 1) {
2836 error_exit("Expecting one image file name");
2839 flags = BDRV_O_FLAGS | BDRV_O_RDWR;
2840 ret = bdrv_parse_cache_flags(cache, &flags);
2842 error_report("Invalid cache option: %s", cache);
2846 blk = img_open("image", filename, fmt, flags, true, quiet);
2848 error_report("Could not open image '%s'", filename);
2854 fmt = bs->drv->format_name;
2856 if (has_help_option(options)) {
2857 /* If the format was auto-detected, print option help here */
2858 ret = print_block_option_help(filename, fmt);
2862 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
2863 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2864 if (options && qemu_opts_do_parse(opts, options, NULL)) {
2865 error_report("Invalid options for file format '%s'", fmt);
2870 ret = bdrv_amend_options(bs, opts);
2872 error_report("Error while amending options: %s", strerror(-ret));
2878 qemu_opts_del(opts);
2879 qemu_opts_free(create_opts);
2888 static const img_cmd_t img_cmds[] = {
2889 #define DEF(option, callback, arg_string) \
2890 { option, callback },
2891 #include "qemu-img-cmds.h"
2897 int main(int argc, char **argv)
2899 const img_cmd_t *cmd;
2900 const char *cmdname;
2901 Error *local_error = NULL;
2903 static const struct option long_options[] = {
2904 {"help", no_argument, 0, 'h'},
2905 {"version", no_argument, 0, 'v'},
2910 signal(SIGPIPE, SIG_IGN);
2913 error_set_progname(argv[0]);
2914 qemu_init_exec_dir(argv[0]);
2916 if (qemu_init_main_loop(&local_error)) {
2917 error_report("%s", error_get_pretty(local_error));
2918 error_free(local_error);
2924 error_exit("Not enough arguments");
2928 /* find the command */
2929 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
2930 if (!strcmp(cmdname, cmd->name)) {
2931 return cmd->handler(argc - 1, argv + 1);
2935 c = getopt_long(argc, argv, "h", long_options, NULL);
2941 printf(QEMU_IMG_VERSION);
2946 error_exit("Command not found: %s", cmdname);