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
;
690 switch (output_format
) {
692 dump_human_image_check(check
, quiet
);
695 dump_json_image_check(check
, quiet
);
699 if (ret
|| check
->check_errors
) {
704 if (check
->corruptions
) {
706 } else if (check
->leaks
) {
713 qapi_free_ImageCheck(check
);
718 static int img_commit(int argc
, char **argv
)
721 const char *filename
, *fmt
, *cache
;
723 BlockDriverState
*bs
;
727 cache
= BDRV_DEFAULT_CACHE
;
729 c
= getopt(argc
, argv
, "f:ht:q");
749 if (optind
!= argc
- 1) {
750 error_exit("Expecting one image file name");
752 filename
= argv
[optind
++];
755 ret
= bdrv_parse_cache_flags(cache
, &flags
);
757 error_report("Invalid cache option: %s", cache
);
761 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
767 ret
= bdrv_commit(bs
);
770 qprintf(quiet
, "Image committed.\n");
773 error_report("No disk inserted");
776 error_report("Image is read-only");
779 error_report("Image is already committed");
782 error_report("Error while committing image");
794 * Returns true iff the first sector pointed to by 'buf' contains at least
797 * 'pnum' is set to the number of sectors (including and immediately following
798 * the first one) that are known to be in the same allocated/unallocated state.
800 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
809 is_zero
= buffer_is_zero(buf
, 512);
810 for(i
= 1; i
< n
; i
++) {
812 if (is_zero
!= buffer_is_zero(buf
, 512)) {
821 * Like is_allocated_sectors, but if the buffer starts with a used sector,
822 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
823 * breaking up write requests for only small sparse areas.
825 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
829 int num_checked
, num_used
;
835 ret
= is_allocated_sectors(buf
, n
, pnum
);
841 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
843 num_checked
= num_used
;
846 ret
= is_allocated_sectors(buf
, n
, pnum
);
848 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
850 num_checked
+= *pnum
;
852 num_used
= num_checked
;
853 } else if (*pnum
>= min
) {
863 * Compares two buffers sector by sector. Returns 0 if the first sector of both
864 * buffers matches, non-zero otherwise.
866 * pnum is set to the number of sectors (including and immediately following
867 * the first one) that are known to have the same comparison result
869 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
879 res
= !!memcmp(buf1
, buf2
, 512);
880 for(i
= 1; i
< n
; i
++) {
884 if (!!memcmp(buf1
, buf2
, 512) != res
) {
893 #define IO_BUF_SIZE (2 * 1024 * 1024)
895 static int64_t sectors_to_bytes(int64_t sectors
)
897 return sectors
<< BDRV_SECTOR_BITS
;
900 static int64_t sectors_to_process(int64_t total
, int64_t from
)
902 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
906 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
908 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
909 * data and negative value on error.
911 * @param bs: Driver used for accessing file
912 * @param sect_num: Number of first sector to check
913 * @param sect_count: Number of sectors to check
914 * @param filename: Name of disk file we are checking (logging purpose)
915 * @param buffer: Allocated buffer for storing read data
916 * @param quiet: Flag for quiet mode
918 static int check_empty_sectors(BlockDriverState
*bs
, int64_t sect_num
,
919 int sect_count
, const char *filename
,
920 uint8_t *buffer
, bool quiet
)
923 ret
= bdrv_read(bs
, sect_num
, buffer
, sect_count
);
925 error_report("Error while reading offset %" PRId64
" of %s: %s",
926 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
929 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
930 if (ret
|| pnum
!= sect_count
) {
931 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
932 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
940 * Compares two images. Exit codes:
942 * 0 - Images are identical
944 * >1 - Error occurred
946 static int img_compare(int argc
, char **argv
)
948 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
949 BlockBackend
*blk1
, *blk2
;
950 BlockDriverState
*bs1
, *bs2
;
951 int64_t total_sectors1
, total_sectors2
;
952 uint8_t *buf1
= NULL
, *buf2
= NULL
;
954 int allocated1
, allocated2
;
955 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
956 bool progress
= false, quiet
= false, strict
= false;
958 int64_t total_sectors
;
959 int64_t sector_num
= 0;
962 uint64_t progress_base
;
964 cache
= BDRV_DEFAULT_CACHE
;
966 c
= getopt(argc
, argv
, "hf:F:T:pqs");
996 /* Progress is not shown in Quiet mode */
1002 if (optind
!= argc
- 2) {
1003 error_exit("Expecting two image file names");
1005 filename1
= argv
[optind
++];
1006 filename2
= argv
[optind
++];
1008 /* Initialize before goto out */
1009 qemu_progress_init(progress
, 2.0);
1011 flags
= BDRV_O_FLAGS
;
1012 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1014 error_report("Invalid source cache option: %s", cache
);
1019 blk1
= img_open("image_1", filename1
, fmt1
, flags
, true, quiet
);
1021 error_report("Can't open file %s", filename1
);
1027 blk2
= img_open("image_2", filename2
, fmt2
, flags
, true, quiet
);
1029 error_report("Can't open file %s", filename2
);
1035 buf1
= qemu_blockalign(bs1
, IO_BUF_SIZE
);
1036 buf2
= qemu_blockalign(bs2
, IO_BUF_SIZE
);
1037 total_sectors1
= bdrv_nb_sectors(bs1
);
1038 if (total_sectors1
< 0) {
1039 error_report("Can't get size of %s: %s",
1040 filename1
, strerror(-total_sectors1
));
1044 total_sectors2
= bdrv_nb_sectors(bs2
);
1045 if (total_sectors2
< 0) {
1046 error_report("Can't get size of %s: %s",
1047 filename2
, strerror(-total_sectors2
));
1051 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1052 progress_base
= MAX(total_sectors1
, total_sectors2
);
1054 qemu_progress_print(0, 100);
1056 if (strict
&& total_sectors1
!= total_sectors2
) {
1058 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1063 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1064 if (nb_sectors
<= 0) {
1067 allocated1
= bdrv_is_allocated_above(bs1
, NULL
, sector_num
, nb_sectors
,
1069 if (allocated1
< 0) {
1071 error_report("Sector allocation test failed for %s", filename1
);
1075 allocated2
= bdrv_is_allocated_above(bs2
, NULL
, sector_num
, nb_sectors
,
1077 if (allocated2
< 0) {
1079 error_report("Sector allocation test failed for %s", filename2
);
1082 nb_sectors
= MIN(pnum1
, pnum2
);
1084 if (allocated1
== allocated2
) {
1086 ret
= bdrv_read(bs1
, sector_num
, buf1
, nb_sectors
);
1088 error_report("Error while reading offset %" PRId64
" of %s:"
1089 " %s", sectors_to_bytes(sector_num
), filename1
,
1094 ret
= bdrv_read(bs2
, sector_num
, buf2
, nb_sectors
);
1096 error_report("Error while reading offset %" PRId64
1097 " of %s: %s", sectors_to_bytes(sector_num
),
1098 filename2
, strerror(-ret
));
1102 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1103 if (ret
|| pnum
!= nb_sectors
) {
1104 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1106 ret
? sector_num
: sector_num
+ pnum
));
1114 qprintf(quiet
, "Strict mode: Offset %" PRId64
1115 " allocation mismatch!\n",
1116 sectors_to_bytes(sector_num
));
1121 ret
= check_empty_sectors(bs1
, sector_num
, nb_sectors
,
1122 filename1
, buf1
, quiet
);
1124 ret
= check_empty_sectors(bs2
, sector_num
, nb_sectors
,
1125 filename2
, buf1
, quiet
);
1129 error_report("Error while reading offset %" PRId64
": %s",
1130 sectors_to_bytes(sector_num
), strerror(-ret
));
1136 sector_num
+= nb_sectors
;
1137 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1140 if (total_sectors1
!= total_sectors2
) {
1141 BlockDriverState
*bs_over
;
1142 int64_t total_sectors_over
;
1143 const char *filename_over
;
1145 qprintf(quiet
, "Warning: Image size mismatch!\n");
1146 if (total_sectors1
> total_sectors2
) {
1147 total_sectors_over
= total_sectors1
;
1149 filename_over
= filename1
;
1151 total_sectors_over
= total_sectors2
;
1153 filename_over
= filename2
;
1157 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1158 if (nb_sectors
<= 0) {
1161 ret
= bdrv_is_allocated_above(bs_over
, NULL
, sector_num
,
1165 error_report("Sector allocation test failed for %s",
1172 ret
= check_empty_sectors(bs_over
, sector_num
, nb_sectors
,
1173 filename_over
, buf1
, quiet
);
1176 error_report("Error while reading offset %" PRId64
1177 " of %s: %s", sectors_to_bytes(sector_num
),
1178 filename_over
, strerror(-ret
));
1184 sector_num
+= nb_sectors
;
1185 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1189 qprintf(quiet
, "Images are identical.\n");
1199 qemu_progress_end();
1203 static int img_convert(int argc
, char **argv
)
1205 int c
, n
, n1
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1207 int progress
= 0, flags
, src_flags
;
1208 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1209 BlockDriver
*drv
, *proto_drv
;
1210 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1211 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1212 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
1213 int64_t *bs_sectors
= NULL
;
1214 uint8_t * buf
= NULL
;
1215 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1216 const uint8_t *buf1
;
1217 BlockDriverInfo bdi
;
1218 QemuOpts
*opts
= NULL
;
1219 QemuOptsList
*create_opts
= NULL
;
1220 const char *out_baseimg_param
;
1221 char *options
= NULL
;
1222 const char *snapshot_name
= NULL
;
1223 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1225 Error
*local_err
= NULL
;
1226 QemuOpts
*sn_opts
= NULL
;
1231 src_cache
= BDRV_DEFAULT_CACHE
;
1236 c
= getopt(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1252 out_baseimg
= optarg
;
1258 error_report("option -e is deprecated, please use \'-o "
1259 "encryption\' instead!");
1263 error_report("option -6 is deprecated, please use \'-o "
1264 "compat6\' instead!");
1268 if (!is_valid_option_list(optarg
)) {
1269 error_report("Invalid option list: %s", optarg
);
1274 options
= g_strdup(optarg
);
1276 char *old_options
= options
;
1277 options
= g_strdup_printf("%s,%s", options
, optarg
);
1278 g_free(old_options
);
1282 snapshot_name
= optarg
;
1285 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1286 sn_opts
= qemu_opts_parse(&internal_snapshot_opts
, optarg
, 0);
1288 error_report("Failed in parsing snapshot param '%s'",
1294 snapshot_name
= optarg
;
1301 sval
= strtosz_suffix(optarg
, &end
, STRTOSZ_DEFSUFFIX_B
);
1302 if (sval
< 0 || *end
) {
1303 error_report("Invalid minimum zero buffer size for sparse output specified");
1308 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1329 /* Initialize before goto out */
1333 qemu_progress_init(progress
, 1.0);
1336 bs_n
= argc
- optind
- 1;
1337 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1339 if (options
&& has_help_option(options
)) {
1340 ret
= print_block_option_help(out_filename
, out_fmt
);
1345 error_exit("Must specify image file name");
1349 if (bs_n
> 1 && out_baseimg
) {
1350 error_report("-B makes no sense when concatenating multiple input "
1356 src_flags
= BDRV_O_FLAGS
;
1357 ret
= bdrv_parse_cache_flags(src_cache
, &src_flags
);
1359 error_report("Invalid source cache option: %s", src_cache
);
1363 qemu_progress_print(0, 100);
1365 blk
= g_new0(BlockBackend
*, bs_n
);
1366 bs
= g_new0(BlockDriverState
*, bs_n
);
1367 bs_sectors
= g_new(int64_t, bs_n
);
1370 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1371 char *id
= bs_n
> 1 ? g_strdup_printf("source_%d", bs_i
)
1372 : g_strdup("source");
1373 blk
[bs_i
] = img_open(id
, argv
[optind
+ bs_i
], fmt
, src_flags
,
1377 error_report("Could not open '%s'", argv
[optind
+ bs_i
]);
1381 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1382 bs_sectors
[bs_i
] = bdrv_nb_sectors(bs
[bs_i
]);
1383 if (bs_sectors
[bs_i
] < 0) {
1384 error_report("Could not get size of %s: %s",
1385 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1389 total_sectors
+= bs_sectors
[bs_i
];
1393 ret
= bdrv_snapshot_load_tmp(bs
[0],
1394 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1395 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1397 } else if (snapshot_name
!= NULL
) {
1399 error_report("No support for concatenating multiple snapshot");
1404 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1407 error_report("Failed to load snapshot: %s",
1408 error_get_pretty(local_err
));
1409 error_free(local_err
);
1414 /* Find driver and parse its options */
1415 drv
= bdrv_find_format(out_fmt
);
1417 error_report("Unknown file format '%s'", out_fmt
);
1422 proto_drv
= bdrv_find_protocol(out_filename
, true);
1424 error_report("Unknown protocol '%s'", out_filename
);
1429 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1430 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1432 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1433 if (options
&& qemu_opts_do_parse(opts
, options
, NULL
)) {
1434 error_report("Invalid options for file format '%s'", out_fmt
);
1439 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512);
1440 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
1445 /* Get backing file name if -o backing_file was used */
1446 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
1447 if (out_baseimg_param
) {
1448 out_baseimg
= out_baseimg_param
;
1451 /* Check if compression is supported */
1454 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
1455 const char *preallocation
=
1456 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
1458 if (!drv
->bdrv_write_compressed
) {
1459 error_report("Compression not supported for this file format");
1465 error_report("Compression and encryption not supported at "
1472 && strcmp(preallocation
, "off"))
1474 error_report("Compression and preallocation not supported at "
1482 /* Create the new image */
1483 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
1485 error_report("%s: error while converting %s: %s",
1486 out_filename
, out_fmt
, error_get_pretty(local_err
));
1487 error_free(local_err
);
1492 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
1493 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1495 error_report("Invalid cache option: %s", cache
);
1499 out_blk
= img_open("target", out_filename
, out_fmt
, flags
, true, quiet
);
1504 out_bs
= blk_bs(out_blk
);
1509 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1510 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1512 bufsectors
= MIN(32768,
1513 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
1514 out_bs
->bl
.discard_alignment
))
1517 buf
= qemu_blockalign(out_bs
, bufsectors
* BDRV_SECTOR_SIZE
);
1520 int64_t output_sectors
= bdrv_nb_sectors(out_bs
);
1521 if (output_sectors
< 0) {
1522 error_report("unable to get output image length: %s\n",
1523 strerror(-output_sectors
));
1526 } else if (output_sectors
< total_sectors
) {
1527 error_report("output file is smaller than input file");
1533 cluster_sectors
= 0;
1534 ret
= bdrv_get_info(out_bs
, &bdi
);
1537 error_report("could not get block driver info");
1541 compress
= compress
|| bdi
.needs_compressed_writes
;
1542 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
1546 if (cluster_sectors
<= 0 || cluster_sectors
> bufsectors
) {
1547 error_report("invalid cluster size");
1553 nb_sectors
= total_sectors
;
1560 nb_sectors
= total_sectors
- sector_num
;
1561 if (nb_sectors
<= 0)
1563 if (nb_sectors
>= cluster_sectors
)
1564 n
= cluster_sectors
;
1568 bs_num
= sector_num
- bs_offset
;
1569 assert (bs_num
>= 0);
1572 while (remainder
> 0) {
1574 while (bs_num
== bs_sectors
[bs_i
]) {
1575 bs_offset
+= bs_sectors
[bs_i
];
1577 assert (bs_i
< bs_n
);
1579 /* printf("changing part: sector_num=%" PRId64 ", "
1580 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1581 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1583 assert (bs_num
< bs_sectors
[bs_i
]);
1585 nlow
= remainder
> bs_sectors
[bs_i
] - bs_num
1586 ? bs_sectors
[bs_i
] - bs_num
: remainder
;
1588 ret
= bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
);
1590 error_report("error while reading sector %" PRId64
": %s",
1591 bs_num
, strerror(-ret
));
1600 assert (remainder
== 0);
1602 if (!buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)) {
1603 ret
= bdrv_write_compressed(out_bs
, sector_num
, buf
, n
);
1605 error_report("error while compressing sector %" PRId64
1606 ": %s", sector_num
, strerror(-ret
));
1611 qemu_progress_print(100.0 * sector_num
/ total_sectors
, 0);
1613 /* signal EOF to align */
1614 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
1616 int64_t sectors_to_read
, sectors_read
, sector_num_next_status
;
1617 bool count_allocated_sectors
;
1618 int has_zero_init
= min_sparse
? bdrv_has_zero_init(out_bs
) : 0;
1620 if (!has_zero_init
&& bdrv_can_write_zeroes_with_unmap(out_bs
)) {
1621 ret
= bdrv_make_zero(out_bs
, BDRV_REQ_MAY_UNMAP
);
1628 sectors_to_read
= total_sectors
;
1629 count_allocated_sectors
= progress
&& (out_baseimg
|| has_zero_init
);
1631 sector_num
= 0; // total number of sectors converted so far
1633 sector_num_next_status
= 0;
1636 nb_sectors
= total_sectors
- sector_num
;
1637 if (nb_sectors
<= 0) {
1638 if (count_allocated_sectors
) {
1639 sectors_to_read
= sectors_read
;
1640 count_allocated_sectors
= false;
1647 while (sector_num
- bs_offset
>= bs_sectors
[bs_i
]) {
1648 bs_offset
+= bs_sectors
[bs_i
];
1650 assert (bs_i
< bs_n
);
1651 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1652 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1653 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1656 if ((out_baseimg
|| has_zero_init
) &&
1657 sector_num
>= sector_num_next_status
) {
1658 n
= nb_sectors
> INT_MAX
? INT_MAX
: nb_sectors
;
1659 ret
= bdrv_get_block_status(bs
[bs_i
], sector_num
- bs_offset
,
1662 error_report("error while reading block status of sector %"
1663 PRId64
": %s", sector_num
- bs_offset
,
1667 /* If the output image is zero initialized, we are not working
1668 * on a shared base and the input is zero we can skip the next
1670 if (has_zero_init
&& !out_baseimg
&& (ret
& BDRV_BLOCK_ZERO
)) {
1674 /* If the output image is being created as a copy on write
1675 * image, assume that sectors which are unallocated in the
1676 * input image are present in both the output's and input's
1677 * base images (no need to copy them). */
1679 if (!(ret
& BDRV_BLOCK_DATA
)) {
1683 /* The next 'n1' sectors are allocated in the input image.
1684 * Copy only those as they may be followed by unallocated
1688 /* avoid redundant callouts to get_block_status */
1689 sector_num_next_status
= sector_num
+ n1
;
1692 n
= MIN(nb_sectors
, bufsectors
);
1694 /* round down request length to an aligned sector, but
1695 * do not bother doing this on short requests. They happen
1696 * when we found an all-zero area, and the next sector to
1697 * write will not be sector_num + n. */
1698 if (cluster_sectors
> 0 && n
>= cluster_sectors
) {
1699 int64_t next_aligned_sector
= (sector_num
+ n
);
1700 next_aligned_sector
-= next_aligned_sector
% cluster_sectors
;
1701 if (sector_num
+ n
> next_aligned_sector
) {
1702 n
= next_aligned_sector
- sector_num
;
1706 n
= MIN(n
, bs_sectors
[bs_i
] - (sector_num
- bs_offset
));
1709 if (count_allocated_sectors
) {
1715 ret
= bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
);
1717 error_report("error while reading sector %" PRId64
": %s",
1718 sector_num
- bs_offset
, strerror(-ret
));
1721 /* NOTE: at the same time we convert, we do not write zero
1722 sectors to have a chance to compress the image. Ideally, we
1723 should add a specific call to have the info to go faster */
1726 if (!has_zero_init
||
1727 is_allocated_sectors_min(buf1
, n
, &n1
, min_sparse
)) {
1728 ret
= bdrv_write(out_bs
, sector_num
, buf1
, n1
);
1730 error_report("error while writing sector %" PRId64
1731 ": %s", sector_num
, strerror(-ret
));
1739 qemu_progress_print(100.0 * sectors_read
/ sectors_to_read
, 0);
1744 qemu_progress_print(100, 0);
1746 qemu_progress_end();
1747 qemu_opts_del(opts
);
1748 qemu_opts_free(create_opts
);
1750 qemu_opts_del(sn_opts
);
1754 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1755 blk_unref(blk
[bs_i
]);
1770 static void dump_snapshots(BlockDriverState
*bs
)
1772 QEMUSnapshotInfo
*sn_tab
, *sn
;
1775 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
1778 printf("Snapshot list:\n");
1779 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
1781 for(i
= 0; i
< nb_sns
; i
++) {
1783 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
1789 static void dump_json_image_info_list(ImageInfoList
*list
)
1791 Error
*local_err
= NULL
;
1793 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1795 visit_type_ImageInfoList(qmp_output_get_visitor(ov
),
1796 &list
, NULL
, &local_err
);
1797 obj
= qmp_output_get_qobject(ov
);
1798 str
= qobject_to_json_pretty(obj
);
1799 assert(str
!= NULL
);
1800 printf("%s\n", qstring_get_str(str
));
1801 qobject_decref(obj
);
1802 qmp_output_visitor_cleanup(ov
);
1806 static void dump_json_image_info(ImageInfo
*info
)
1808 Error
*local_err
= NULL
;
1810 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1812 visit_type_ImageInfo(qmp_output_get_visitor(ov
),
1813 &info
, NULL
, &local_err
);
1814 obj
= qmp_output_get_qobject(ov
);
1815 str
= qobject_to_json_pretty(obj
);
1816 assert(str
!= NULL
);
1817 printf("%s\n", qstring_get_str(str
));
1818 qobject_decref(obj
);
1819 qmp_output_visitor_cleanup(ov
);
1823 static void dump_human_image_info_list(ImageInfoList
*list
)
1825 ImageInfoList
*elem
;
1828 for (elem
= list
; elem
; elem
= elem
->next
) {
1834 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
1838 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
1840 return strcmp(a
, b
) == 0;
1844 * Open an image file chain and return an ImageInfoList
1846 * @filename: topmost image filename
1847 * @fmt: topmost image format (may be NULL to autodetect)
1848 * @chain: true - enumerate entire backing file chain
1849 * false - only topmost image file
1851 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1852 * image file. If there was an error a message will have been printed to
1855 static ImageInfoList
*collect_image_info_list(const char *filename
,
1859 ImageInfoList
*head
= NULL
;
1860 ImageInfoList
**last
= &head
;
1861 GHashTable
*filenames
;
1864 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
1868 BlockDriverState
*bs
;
1870 ImageInfoList
*elem
;
1872 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
1873 error_report("Backing file '%s' creates an infinite loop.",
1877 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
1879 blk
= img_open("image", filename
, fmt
,
1880 BDRV_O_FLAGS
| BDRV_O_NO_BACKING
, false, false);
1886 bdrv_query_image_info(bs
, &info
, &err
);
1888 error_report("%s", error_get_pretty(err
));
1894 elem
= g_new0(ImageInfoList
, 1);
1901 filename
= fmt
= NULL
;
1903 if (info
->has_full_backing_filename
) {
1904 filename
= info
->full_backing_filename
;
1905 } else if (info
->has_backing_filename
) {
1906 filename
= info
->backing_filename
;
1908 if (info
->has_backing_filename_format
) {
1909 fmt
= info
->backing_filename_format
;
1913 g_hash_table_destroy(filenames
);
1917 qapi_free_ImageInfoList(head
);
1918 g_hash_table_destroy(filenames
);
1922 static int img_info(int argc
, char **argv
)
1925 OutputFormat output_format
= OFORMAT_HUMAN
;
1927 const char *filename
, *fmt
, *output
;
1928 ImageInfoList
*list
;
1933 int option_index
= 0;
1934 static const struct option long_options
[] = {
1935 {"help", no_argument
, 0, 'h'},
1936 {"format", required_argument
, 0, 'f'},
1937 {"output", required_argument
, 0, OPTION_OUTPUT
},
1938 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
1941 c
= getopt_long(argc
, argv
, "f:h",
1942 long_options
, &option_index
);
1957 case OPTION_BACKING_CHAIN
:
1962 if (optind
!= argc
- 1) {
1963 error_exit("Expecting one image file name");
1965 filename
= argv
[optind
++];
1967 if (output
&& !strcmp(output
, "json")) {
1968 output_format
= OFORMAT_JSON
;
1969 } else if (output
&& !strcmp(output
, "human")) {
1970 output_format
= OFORMAT_HUMAN
;
1971 } else if (output
) {
1972 error_report("--output must be used with human or json as argument.");
1976 list
= collect_image_info_list(filename
, fmt
, chain
);
1981 switch (output_format
) {
1983 dump_human_image_info_list(list
);
1987 dump_json_image_info_list(list
);
1989 dump_json_image_info(list
->value
);
1994 qapi_free_ImageInfoList(list
);
1999 typedef struct MapEntry
{
2005 BlockDriverState
*bs
;
2008 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2011 switch (output_format
) {
2013 if ((e
->flags
& BDRV_BLOCK_DATA
) &&
2014 !(e
->flags
& BDRV_BLOCK_OFFSET_VALID
)) {
2015 error_report("File contains external, encrypted or compressed clusters.");
2018 if ((e
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) == BDRV_BLOCK_DATA
) {
2019 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2020 e
->start
, e
->length
, e
->offset
, e
->bs
->filename
);
2022 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2023 * Modify the flags here to allow more coalescing.
2026 (next
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) != BDRV_BLOCK_DATA
) {
2027 next
->flags
&= ~BDRV_BLOCK_DATA
;
2028 next
->flags
|= BDRV_BLOCK_ZERO
;
2032 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
", \"depth\": %d,"
2033 " \"zero\": %s, \"data\": %s",
2034 (e
->start
== 0 ? "[" : ",\n"),
2035 e
->start
, e
->length
, e
->depth
,
2036 (e
->flags
& BDRV_BLOCK_ZERO
) ? "true" : "false",
2037 (e
->flags
& BDRV_BLOCK_DATA
) ? "true" : "false");
2038 if (e
->flags
& BDRV_BLOCK_OFFSET_VALID
) {
2039 printf(", \"offset\": %"PRId64
"", e
->offset
);
2050 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2051 int nb_sectors
, MapEntry
*e
)
2056 /* As an optimization, we could cache the current range of unallocated
2057 * clusters in each file of the chain, and avoid querying the same
2063 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
);
2068 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2071 bs
= bs
->backing_hd
;
2080 e
->start
= sector_num
* BDRV_SECTOR_SIZE
;
2081 e
->length
= nb_sectors
* BDRV_SECTOR_SIZE
;
2082 e
->flags
= ret
& ~BDRV_BLOCK_OFFSET_MASK
;
2083 e
->offset
= ret
& BDRV_BLOCK_OFFSET_MASK
;
2089 static int img_map(int argc
, char **argv
)
2092 OutputFormat output_format
= OFORMAT_HUMAN
;
2094 BlockDriverState
*bs
;
2095 const char *filename
, *fmt
, *output
;
2097 MapEntry curr
= { .length
= 0 }, next
;
2103 int option_index
= 0;
2104 static const struct option long_options
[] = {
2105 {"help", no_argument
, 0, 'h'},
2106 {"format", required_argument
, 0, 'f'},
2107 {"output", required_argument
, 0, OPTION_OUTPUT
},
2110 c
= getopt_long(argc
, argv
, "f:h",
2111 long_options
, &option_index
);
2128 if (optind
!= argc
- 1) {
2129 error_exit("Expecting one image file name");
2131 filename
= argv
[optind
];
2133 if (output
&& !strcmp(output
, "json")) {
2134 output_format
= OFORMAT_JSON
;
2135 } else if (output
&& !strcmp(output
, "human")) {
2136 output_format
= OFORMAT_HUMAN
;
2137 } else if (output
) {
2138 error_report("--output must be used with human or json as argument.");
2142 blk
= img_open("image", filename
, fmt
, BDRV_O_FLAGS
, true, false);
2148 if (output_format
== OFORMAT_HUMAN
) {
2149 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2152 length
= bdrv_getlength(bs
);
2153 while (curr
.start
+ curr
.length
< length
) {
2154 int64_t nsectors_left
;
2158 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2160 /* Probe up to 1 GiB at a time. */
2161 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2162 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2163 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2166 error_report("Could not read file metadata: %s", strerror(-ret
));
2170 if (curr
.length
!= 0 && curr
.flags
== next
.flags
&&
2171 curr
.depth
== next
.depth
&&
2172 ((curr
.flags
& BDRV_BLOCK_OFFSET_VALID
) == 0 ||
2173 curr
.offset
+ curr
.length
== next
.offset
)) {
2174 curr
.length
+= next
.length
;
2178 if (curr
.length
> 0) {
2179 dump_map_entry(output_format
, &curr
, &next
);
2184 dump_map_entry(output_format
, &curr
, NULL
);
2191 #define SNAPSHOT_LIST 1
2192 #define SNAPSHOT_CREATE 2
2193 #define SNAPSHOT_APPLY 3
2194 #define SNAPSHOT_DELETE 4
2196 static int img_snapshot(int argc
, char **argv
)
2199 BlockDriverState
*bs
;
2200 QEMUSnapshotInfo sn
;
2201 char *filename
, *snapshot_name
= NULL
;
2202 int c
, ret
= 0, bdrv_oflags
;
2208 bdrv_oflags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2209 /* Parse commandline parameters */
2211 c
= getopt(argc
, argv
, "la:c:d:hq");
2222 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2225 action
= SNAPSHOT_LIST
;
2226 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2230 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2233 action
= SNAPSHOT_APPLY
;
2234 snapshot_name
= optarg
;
2238 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2241 action
= SNAPSHOT_CREATE
;
2242 snapshot_name
= optarg
;
2246 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2249 action
= SNAPSHOT_DELETE
;
2250 snapshot_name
= optarg
;
2258 if (optind
!= argc
- 1) {
2259 error_exit("Expecting one image file name");
2261 filename
= argv
[optind
++];
2263 /* Open the image */
2264 blk
= img_open("image", filename
, NULL
, bdrv_oflags
, true, quiet
);
2270 /* Perform the requested action */
2276 case SNAPSHOT_CREATE
:
2277 memset(&sn
, 0, sizeof(sn
));
2278 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2280 qemu_gettimeofday(&tv
);
2281 sn
.date_sec
= tv
.tv_sec
;
2282 sn
.date_nsec
= tv
.tv_usec
* 1000;
2284 ret
= bdrv_snapshot_create(bs
, &sn
);
2286 error_report("Could not create snapshot '%s': %d (%s)",
2287 snapshot_name
, ret
, strerror(-ret
));
2291 case SNAPSHOT_APPLY
:
2292 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2294 error_report("Could not apply snapshot '%s': %d (%s)",
2295 snapshot_name
, ret
, strerror(-ret
));
2299 case SNAPSHOT_DELETE
:
2300 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2302 error_report("Could not delete snapshot '%s': (%s)",
2303 snapshot_name
, error_get_pretty(err
));
2318 static int img_rebase(int argc
, char **argv
)
2320 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2321 BlockDriverState
*bs
= NULL
, *bs_old_backing
= NULL
, *bs_new_backing
= NULL
;
2322 BlockDriver
*old_backing_drv
, *new_backing_drv
;
2324 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2325 int c
, flags
, src_flags
, ret
;
2329 Error
*local_err
= NULL
;
2331 /* Parse commandline parameters */
2333 cache
= BDRV_DEFAULT_CACHE
;
2334 src_cache
= BDRV_DEFAULT_CACHE
;
2338 c
= getopt(argc
, argv
, "hf:F:b:upt:T:q");
2351 out_basefmt
= optarg
;
2354 out_baseimg
= optarg
;
2378 if (optind
!= argc
- 1) {
2379 error_exit("Expecting one image file name");
2381 if (!unsafe
&& !out_baseimg
) {
2382 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2384 filename
= argv
[optind
++];
2386 qemu_progress_init(progress
, 2.0);
2387 qemu_progress_print(0, 100);
2389 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2390 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2392 error_report("Invalid cache option: %s", cache
);
2396 src_flags
= BDRV_O_FLAGS
;
2397 ret
= bdrv_parse_cache_flags(src_cache
, &src_flags
);
2399 error_report("Invalid source cache option: %s", src_cache
);
2406 * Ignore the old backing file for unsafe rebase in case we want to correct
2407 * the reference to a renamed or moved backing file.
2409 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
2416 /* Find the right drivers for the backing files */
2417 old_backing_drv
= NULL
;
2418 new_backing_drv
= NULL
;
2420 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
2421 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
2422 if (old_backing_drv
== NULL
) {
2423 error_report("Invalid format name: '%s'", bs
->backing_format
);
2429 if (out_basefmt
!= NULL
) {
2430 new_backing_drv
= bdrv_find_format(out_basefmt
);
2431 if (new_backing_drv
== NULL
) {
2432 error_report("Invalid format name: '%s'", out_basefmt
);
2438 /* For safe rebasing we need to compare old and new backing file */
2440 char backing_name
[1024];
2442 blk_old_backing
= blk_new_with_bs("old_backing", &error_abort
);
2443 bs_old_backing
= blk_bs(blk_old_backing
);
2444 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2445 ret
= bdrv_open(&bs_old_backing
, backing_name
, NULL
, NULL
, src_flags
,
2446 old_backing_drv
, &local_err
);
2448 error_report("Could not open old backing file '%s': %s",
2449 backing_name
, error_get_pretty(local_err
));
2450 error_free(local_err
);
2453 if (out_baseimg
[0]) {
2454 blk_new_backing
= blk_new_with_bs("new_backing", &error_abort
);
2455 bs_new_backing
= blk_bs(blk_new_backing
);
2456 ret
= bdrv_open(&bs_new_backing
, out_baseimg
, NULL
, NULL
, src_flags
,
2457 new_backing_drv
, &local_err
);
2459 error_report("Could not open new backing file '%s': %s",
2460 out_baseimg
, error_get_pretty(local_err
));
2461 error_free(local_err
);
2468 * Check each unallocated cluster in the COW file. If it is unallocated,
2469 * accesses go to the backing file. We must therefore compare this cluster
2470 * in the old and new backing file, and if they differ we need to copy it
2471 * from the old backing file into the COW file.
2473 * If qemu-img crashes during this step, no harm is done. The content of
2474 * the image is the same as the original one at any time.
2477 int64_t num_sectors
;
2478 int64_t old_backing_num_sectors
;
2479 int64_t new_backing_num_sectors
= 0;
2484 float local_progress
= 0;
2486 buf_old
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2487 buf_new
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2489 num_sectors
= bdrv_nb_sectors(bs
);
2490 if (num_sectors
< 0) {
2491 error_report("Could not get size of '%s': %s",
2492 filename
, strerror(-num_sectors
));
2496 old_backing_num_sectors
= bdrv_nb_sectors(bs_old_backing
);
2497 if (old_backing_num_sectors
< 0) {
2498 char backing_name
[1024];
2500 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2501 error_report("Could not get size of '%s': %s",
2502 backing_name
, strerror(-old_backing_num_sectors
));
2506 if (bs_new_backing
) {
2507 new_backing_num_sectors
= bdrv_nb_sectors(bs_new_backing
);
2508 if (new_backing_num_sectors
< 0) {
2509 error_report("Could not get size of '%s': %s",
2510 out_baseimg
, strerror(-new_backing_num_sectors
));
2516 if (num_sectors
!= 0) {
2517 local_progress
= (float)100 /
2518 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
2521 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
2523 /* How many sectors can we handle with the next read? */
2524 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
2525 n
= (IO_BUF_SIZE
/ 512);
2527 n
= num_sectors
- sector
;
2530 /* If the cluster is allocated, we don't need to take action */
2531 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
2533 error_report("error while reading image metadata: %s",
2542 * Read old and new backing file and take into consideration that
2543 * backing files may be smaller than the COW image.
2545 if (sector
>= old_backing_num_sectors
) {
2546 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
2548 if (sector
+ n
> old_backing_num_sectors
) {
2549 n
= old_backing_num_sectors
- sector
;
2552 ret
= bdrv_read(bs_old_backing
, sector
, buf_old
, n
);
2554 error_report("error while reading from old backing file");
2559 if (sector
>= new_backing_num_sectors
|| !bs_new_backing
) {
2560 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
2562 if (sector
+ n
> new_backing_num_sectors
) {
2563 n
= new_backing_num_sectors
- sector
;
2566 ret
= bdrv_read(bs_new_backing
, sector
, buf_new
, n
);
2568 error_report("error while reading from new backing file");
2573 /* If they differ, we need to write to the COW file */
2574 uint64_t written
= 0;
2576 while (written
< n
) {
2579 if (compare_sectors(buf_old
+ written
* 512,
2580 buf_new
+ written
* 512, n
- written
, &pnum
))
2582 ret
= bdrv_write(bs
, sector
+ written
,
2583 buf_old
+ written
* 512, pnum
);
2585 error_report("Error while writing to COW image: %s",
2593 qemu_progress_print(local_progress
, 100);
2596 qemu_vfree(buf_old
);
2597 qemu_vfree(buf_new
);
2601 * Change the backing file. All clusters that are different from the old
2602 * backing file are overwritten in the COW file now, so the visible content
2603 * doesn't change when we switch the backing file.
2605 if (out_baseimg
&& *out_baseimg
) {
2606 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
2608 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
2611 if (ret
== -ENOSPC
) {
2612 error_report("Could not change the backing file to '%s': No "
2613 "space left in the file header", out_baseimg
);
2614 } else if (ret
< 0) {
2615 error_report("Could not change the backing file to '%s': %s",
2616 out_baseimg
, strerror(-ret
));
2619 qemu_progress_print(100, 0);
2621 * TODO At this point it is possible to check if any clusters that are
2622 * allocated in the COW file are the same in the backing file. If so, they
2623 * could be dropped from the COW file. Don't do this before switching the
2624 * backing file, in case of a crash this would lead to corruption.
2627 qemu_progress_end();
2630 blk_unref(blk_old_backing
);
2631 blk_unref(blk_new_backing
);
2641 static int img_resize(int argc
, char **argv
)
2643 int c
, ret
, relative
;
2644 const char *filename
, *fmt
, *size
;
2645 int64_t n
, total_size
;
2647 BlockBackend
*blk
= NULL
;
2648 BlockDriverState
*bs
= NULL
;
2650 static QemuOptsList resize_options
= {
2651 .name
= "resize_options",
2652 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
2655 .name
= BLOCK_OPT_SIZE
,
2656 .type
= QEMU_OPT_SIZE
,
2657 .help
= "Virtual disk size"
2664 /* Remove size from argv manually so that negative numbers are not treated
2665 * as options by getopt. */
2667 error_exit("Not enough arguments");
2671 size
= argv
[--argc
];
2673 /* Parse getopt arguments */
2676 c
= getopt(argc
, argv
, "f:hq");
2693 if (optind
!= argc
- 1) {
2694 error_exit("Expecting one image file name");
2696 filename
= argv
[optind
++];
2698 /* Choose grow, shrink, or absolute resize mode */
2714 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
2715 if (qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
)) {
2716 /* Error message already printed when size parsing fails */
2718 qemu_opts_del(param
);
2721 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
2722 qemu_opts_del(param
);
2724 blk
= img_open("image", filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
,
2733 total_size
= bdrv_getlength(bs
) + n
* relative
;
2737 if (total_size
<= 0) {
2738 error_report("New image size must be positive");
2743 ret
= bdrv_truncate(bs
, total_size
);
2746 qprintf(quiet
, "Image resized.\n");
2749 error_report("This image does not support resize");
2752 error_report("Image is read-only");
2755 error_report("Error resizing image (%d)", -ret
);
2766 static int img_amend(int argc
, char **argv
)
2769 char *options
= NULL
;
2770 QemuOptsList
*create_opts
= NULL
;
2771 QemuOpts
*opts
= NULL
;
2772 const char *fmt
= NULL
, *filename
, *cache
;
2775 BlockBackend
*blk
= NULL
;
2776 BlockDriverState
*bs
= NULL
;
2778 cache
= BDRV_DEFAULT_CACHE
;
2780 c
= getopt(argc
, argv
, "ho:f:t:q");
2791 if (!is_valid_option_list(optarg
)) {
2792 error_report("Invalid option list: %s", optarg
);
2797 options
= g_strdup(optarg
);
2799 char *old_options
= options
;
2800 options
= g_strdup_printf("%s,%s", options
, optarg
);
2801 g_free(old_options
);
2817 error_exit("Must specify options (-o)");
2820 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
2821 if (fmt
&& has_help_option(options
)) {
2822 /* If a format is explicitly specified (and possibly no filename is
2823 * given), print option help here */
2824 ret
= print_block_option_help(filename
, fmt
);
2828 if (optind
!= argc
- 1) {
2829 error_exit("Expecting one image file name");
2832 flags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2833 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2835 error_report("Invalid cache option: %s", cache
);
2839 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
2841 error_report("Could not open image '%s'", filename
);
2847 fmt
= bs
->drv
->format_name
;
2849 if (has_help_option(options
)) {
2850 /* If the format was auto-detected, print option help here */
2851 ret
= print_block_option_help(filename
, fmt
);
2855 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
2856 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2857 if (options
&& qemu_opts_do_parse(opts
, options
, NULL
)) {
2858 error_report("Invalid options for file format '%s'", fmt
);
2863 ret
= bdrv_amend_options(bs
, opts
);
2865 error_report("Error while amending options: %s", strerror(-ret
));
2871 qemu_opts_del(opts
);
2872 qemu_opts_free(create_opts
);
2881 static const img_cmd_t img_cmds
[] = {
2882 #define DEF(option, callback, arg_string) \
2883 { option, callback },
2884 #include "qemu-img-cmds.h"
2890 int main(int argc
, char **argv
)
2892 const img_cmd_t
*cmd
;
2893 const char *cmdname
;
2894 Error
*local_error
= NULL
;
2896 static const struct option long_options
[] = {
2897 {"help", no_argument
, 0, 'h'},
2898 {"version", no_argument
, 0, 'v'},
2903 signal(SIGPIPE
, SIG_IGN
);
2906 error_set_progname(argv
[0]);
2907 qemu_init_exec_dir(argv
[0]);
2909 if (qemu_init_main_loop(&local_error
)) {
2910 error_report("%s", error_get_pretty(local_error
));
2911 error_free(local_error
);
2917 error_exit("Not enough arguments");
2921 /* find the command */
2922 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
2923 if (!strcmp(cmdname
, cmd
->name
)) {
2924 return cmd
->handler(argc
- 1, argv
+ 1);
2928 c
= getopt_long(argc
, argv
, "h", long_options
, NULL
);
2934 printf(QEMU_IMG_VERSION
);
2939 error_exit("Command not found: %s", cmdname
);