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 "block/block_int.h"
33 #include "block/qapi.h"
36 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION \
37 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
39 typedef struct img_cmd_t
{
41 int (*handler
)(int argc
, char **argv
);
46 OPTION_BACKING_CHAIN
= 257,
49 typedef enum OutputFormat
{
54 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
55 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
56 #define BDRV_DEFAULT_CACHE "writeback"
58 static void format_print(void *opaque
, const char *name
)
63 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
67 error_printf("qemu-img: ");
70 error_vprintf(fmt
, ap
);
73 error_printf("\nTry 'qemu-img --help' for more information\n");
77 /* Please keep in synch with qemu-img.texi */
78 static void QEMU_NORETURN
help(void)
80 const char *help_msg
=
82 "usage: qemu-img command [command options]\n"
83 "QEMU disk image utility\n"
86 #define DEF(option, callback, arg_string) \
88 #include "qemu-img-cmds.h"
92 "Command parameters:\n"
93 " 'filename' is a disk image filename\n"
94 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
95 " 'cache' is the cache mode used to write the output disk image, the valid\n"
96 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
97 " 'directsync' and 'unsafe' (default for convert)\n"
98 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
99 " options are the same as for the 'cache' option\n"
100 " 'size' is the disk image size in bytes. Optional suffixes\n"
101 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
102 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
103 " supported. 'b' is ignored.\n"
104 " 'output_filename' is the destination disk image filename\n"
105 " 'output_fmt' is the destination format\n"
106 " 'options' is a comma separated list of format specific options in a\n"
107 " name=value format. Use -o ? for an overview of the options supported by the\n"
109 " 'snapshot_param' is param used for internal snapshot, format\n"
110 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
112 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
114 " '-c' indicates that target image must be compressed (qcow format only)\n"
115 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
116 " match exactly. The image doesn't need a working backing file before\n"
117 " rebasing in this case (useful for renaming the backing file)\n"
118 " '-h' with or without a command shows this help and lists the supported formats\n"
119 " '-p' show progress of command (only certain commands)\n"
120 " '-q' use Quiet mode - do not print any output (except errors)\n"
121 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
122 " contain only zeros for qemu-img to create a sparse image during\n"
123 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
124 " unallocated or zero sectors, and the destination image will always be\n"
126 " '--output' takes the format in which the output must be done (human or json)\n"
127 " '-n' skips the target volume creation (useful if the volume is created\n"
128 " prior to running qemu-img)\n"
130 "Parameters to check subcommand:\n"
131 " '-r' tries to repair any inconsistencies that are found during the check.\n"
132 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
133 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
134 " hiding corruption that has already occurred.\n"
136 "Parameters to snapshot subcommand:\n"
137 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
138 " '-a' applies a snapshot (revert disk to saved state)\n"
139 " '-c' creates a snapshot\n"
140 " '-d' deletes a snapshot\n"
141 " '-l' lists all snapshots in the given image\n"
143 "Parameters to compare subcommand:\n"
144 " '-f' first image format\n"
145 " '-F' second image format\n"
146 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
148 printf("%s\nSupported formats:", help_msg
);
149 bdrv_iterate_format(format_print
, NULL
);
154 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
160 ret
= vprintf(fmt
, args
);
167 /* XXX: put correct support for win32 */
168 static int read_password(char *buf
, int buf_size
)
172 printf("Password: ");
180 } else if (c
== '\n') {
182 } else if (i
< (buf_size
- 1)) {
194 static struct termios oldtty
;
196 static void term_exit(void)
198 tcsetattr (0, TCSANOW
, &oldtty
);
201 static void term_init(void)
208 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
209 |INLCR
|IGNCR
|ICRNL
|IXON
);
210 tty
.c_oflag
|= OPOST
;
211 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
212 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
217 tcsetattr (0, TCSANOW
, &tty
);
222 static int read_password(char *buf
, int buf_size
)
227 printf("password: ");
232 ret
= read(0, &ch
, 1);
234 if (errno
== EAGAIN
|| errno
== EINTR
) {
239 } else if (ret
== 0) {
247 if (i
< (buf_size
- 1))
258 static int print_block_option_help(const char *filename
, const char *fmt
)
260 BlockDriver
*drv
, *proto_drv
;
261 QemuOptsList
*create_opts
= NULL
;
263 /* Find driver and parse its options */
264 drv
= bdrv_find_format(fmt
);
266 error_report("Unknown file format '%s'", fmt
);
270 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
272 proto_drv
= bdrv_find_protocol(filename
, true);
274 error_report("Unknown protocol '%s'", filename
);
275 qemu_opts_free(create_opts
);
278 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
281 qemu_opts_print_help(create_opts
);
282 qemu_opts_free(create_opts
);
286 static BlockDriverState
*bdrv_new_open(const char *id
,
287 const char *filename
,
293 BlockDriverState
*bs
;
296 Error
*local_err
= NULL
;
299 bs
= bdrv_new(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
;
578 BlockDriverState
*bs
;
580 int flags
= BDRV_O_FLAGS
| BDRV_O_CHECK
;
586 cache
= BDRV_DEFAULT_CACHE
;
588 int option_index
= 0;
589 static const struct option long_options
[] = {
590 {"help", no_argument
, 0, 'h'},
591 {"format", required_argument
, 0, 'f'},
592 {"repair", required_argument
, 0, 'r'},
593 {"output", required_argument
, 0, OPTION_OUTPUT
},
596 c
= getopt_long(argc
, argv
, "hf:r:T:q",
597 long_options
, &option_index
);
610 flags
|= BDRV_O_RDWR
;
612 if (!strcmp(optarg
, "leaks")) {
613 fix
= BDRV_FIX_LEAKS
;
614 } else if (!strcmp(optarg
, "all")) {
615 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
617 error_exit("Unknown option value for -r "
618 "(expecting 'leaks' or 'all'): %s", optarg
);
632 if (optind
!= argc
- 1) {
633 error_exit("Expecting one image file name");
635 filename
= argv
[optind
++];
637 if (output
&& !strcmp(output
, "json")) {
638 output_format
= OFORMAT_JSON
;
639 } else if (output
&& !strcmp(output
, "human")) {
640 output_format
= OFORMAT_HUMAN
;
642 error_report("--output must be used with human or json as argument.");
646 ret
= bdrv_parse_cache_flags(cache
, &flags
);
648 error_report("Invalid source cache option: %s", cache
);
652 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
657 check
= g_new0(ImageCheck
, 1);
658 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
660 if (ret
== -ENOTSUP
) {
661 error_report("This image format does not support checks");
666 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
667 int corruptions_fixed
, leaks_fixed
;
669 leaks_fixed
= check
->leaks_fixed
;
670 corruptions_fixed
= check
->corruptions_fixed
;
672 if (output_format
== OFORMAT_HUMAN
) {
674 "The following inconsistencies were found and repaired:\n\n"
675 " %" PRId64
" leaked clusters\n"
676 " %" PRId64
" corruptions\n\n"
677 "Double checking the fixed image now...\n",
679 check
->corruptions_fixed
);
682 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
684 check
->leaks_fixed
= leaks_fixed
;
685 check
->corruptions_fixed
= corruptions_fixed
;
688 switch (output_format
) {
690 dump_human_image_check(check
, quiet
);
693 dump_json_image_check(check
, quiet
);
697 if (ret
|| check
->check_errors
) {
702 if (check
->corruptions
) {
704 } else if (check
->leaks
) {
711 qapi_free_ImageCheck(check
);
717 static int img_commit(int argc
, char **argv
)
720 const char *filename
, *fmt
, *cache
;
721 BlockDriverState
*bs
;
725 cache
= BDRV_DEFAULT_CACHE
;
727 c
= getopt(argc
, argv
, "f:ht:q");
747 if (optind
!= argc
- 1) {
748 error_exit("Expecting one image file name");
750 filename
= argv
[optind
++];
753 ret
= bdrv_parse_cache_flags(cache
, &flags
);
755 error_report("Invalid cache option: %s", cache
);
759 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
763 ret
= bdrv_commit(bs
);
766 qprintf(quiet
, "Image committed.\n");
769 error_report("No disk inserted");
772 error_report("Image is read-only");
775 error_report("Image is already committed");
778 error_report("Error while committing image");
790 * Returns true iff the first sector pointed to by 'buf' contains at least
793 * 'pnum' is set to the number of sectors (including and immediately following
794 * the first one) that are known to be in the same allocated/unallocated state.
796 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
805 is_zero
= buffer_is_zero(buf
, 512);
806 for(i
= 1; i
< n
; i
++) {
808 if (is_zero
!= buffer_is_zero(buf
, 512)) {
817 * Like is_allocated_sectors, but if the buffer starts with a used sector,
818 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
819 * breaking up write requests for only small sparse areas.
821 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
825 int num_checked
, num_used
;
831 ret
= is_allocated_sectors(buf
, n
, pnum
);
837 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
839 num_checked
= num_used
;
842 ret
= is_allocated_sectors(buf
, n
, pnum
);
844 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
846 num_checked
+= *pnum
;
848 num_used
= num_checked
;
849 } else if (*pnum
>= min
) {
859 * Compares two buffers sector by sector. Returns 0 if the first sector of both
860 * buffers matches, non-zero otherwise.
862 * pnum is set to the number of sectors (including and immediately following
863 * the first one) that are known to have the same comparison result
865 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
875 res
= !!memcmp(buf1
, buf2
, 512);
876 for(i
= 1; i
< n
; i
++) {
880 if (!!memcmp(buf1
, buf2
, 512) != res
) {
889 #define IO_BUF_SIZE (2 * 1024 * 1024)
891 static int64_t sectors_to_bytes(int64_t sectors
)
893 return sectors
<< BDRV_SECTOR_BITS
;
896 static int64_t sectors_to_process(int64_t total
, int64_t from
)
898 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
902 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
904 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
905 * data and negative value on error.
907 * @param bs: Driver used for accessing file
908 * @param sect_num: Number of first sector to check
909 * @param sect_count: Number of sectors to check
910 * @param filename: Name of disk file we are checking (logging purpose)
911 * @param buffer: Allocated buffer for storing read data
912 * @param quiet: Flag for quiet mode
914 static int check_empty_sectors(BlockDriverState
*bs
, int64_t sect_num
,
915 int sect_count
, const char *filename
,
916 uint8_t *buffer
, bool quiet
)
919 ret
= bdrv_read(bs
, sect_num
, buffer
, sect_count
);
921 error_report("Error while reading offset %" PRId64
" of %s: %s",
922 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
925 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
926 if (ret
|| pnum
!= sect_count
) {
927 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
928 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
936 * Compares two images. Exit codes:
938 * 0 - Images are identical
940 * >1 - Error occurred
942 static int img_compare(int argc
, char **argv
)
944 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
945 BlockDriverState
*bs1
, *bs2
;
946 int64_t total_sectors1
, total_sectors2
;
947 uint8_t *buf1
= NULL
, *buf2
= NULL
;
949 int allocated1
, allocated2
;
950 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
951 bool progress
= false, quiet
= false, strict
= false;
953 int64_t total_sectors
;
954 int64_t sector_num
= 0;
957 uint64_t progress_base
;
959 cache
= BDRV_DEFAULT_CACHE
;
961 c
= getopt(argc
, argv
, "hf:F:T:pqs");
991 /* Progress is not shown in Quiet mode */
997 if (optind
!= argc
- 2) {
998 error_exit("Expecting two image file names");
1000 filename1
= argv
[optind
++];
1001 filename2
= argv
[optind
++];
1003 /* Initialize before goto out */
1004 qemu_progress_init(progress
, 2.0);
1006 flags
= BDRV_O_FLAGS
;
1007 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1009 error_report("Invalid source cache option: %s", cache
);
1014 bs1
= bdrv_new_open("image_1", filename1
, fmt1
, flags
, true, quiet
);
1016 error_report("Can't open file %s", filename1
);
1021 bs2
= bdrv_new_open("image_2", filename2
, fmt2
, flags
, true, quiet
);
1023 error_report("Can't open file %s", filename2
);
1028 buf1
= qemu_blockalign(bs1
, IO_BUF_SIZE
);
1029 buf2
= qemu_blockalign(bs2
, IO_BUF_SIZE
);
1030 total_sectors1
= bdrv_nb_sectors(bs1
);
1031 if (total_sectors1
< 0) {
1032 error_report("Can't get size of %s: %s",
1033 filename1
, strerror(-total_sectors1
));
1037 total_sectors2
= bdrv_nb_sectors(bs2
);
1038 if (total_sectors2
< 0) {
1039 error_report("Can't get size of %s: %s",
1040 filename2
, strerror(-total_sectors2
));
1044 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1045 progress_base
= MAX(total_sectors1
, total_sectors2
);
1047 qemu_progress_print(0, 100);
1049 if (strict
&& total_sectors1
!= total_sectors2
) {
1051 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1056 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1057 if (nb_sectors
<= 0) {
1060 allocated1
= bdrv_is_allocated_above(bs1
, NULL
, sector_num
, nb_sectors
,
1062 if (allocated1
< 0) {
1064 error_report("Sector allocation test failed for %s", filename1
);
1068 allocated2
= bdrv_is_allocated_above(bs2
, NULL
, sector_num
, nb_sectors
,
1070 if (allocated2
< 0) {
1072 error_report("Sector allocation test failed for %s", filename2
);
1075 nb_sectors
= MIN(pnum1
, pnum2
);
1077 if (allocated1
== allocated2
) {
1079 ret
= bdrv_read(bs1
, sector_num
, buf1
, nb_sectors
);
1081 error_report("Error while reading offset %" PRId64
" of %s:"
1082 " %s", sectors_to_bytes(sector_num
), filename1
,
1087 ret
= bdrv_read(bs2
, sector_num
, buf2
, nb_sectors
);
1089 error_report("Error while reading offset %" PRId64
1090 " of %s: %s", sectors_to_bytes(sector_num
),
1091 filename2
, strerror(-ret
));
1095 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1096 if (ret
|| pnum
!= nb_sectors
) {
1097 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1099 ret
? sector_num
: sector_num
+ pnum
));
1107 qprintf(quiet
, "Strict mode: Offset %" PRId64
1108 " allocation mismatch!\n",
1109 sectors_to_bytes(sector_num
));
1114 ret
= check_empty_sectors(bs1
, sector_num
, nb_sectors
,
1115 filename1
, buf1
, quiet
);
1117 ret
= check_empty_sectors(bs2
, sector_num
, nb_sectors
,
1118 filename2
, buf1
, quiet
);
1122 error_report("Error while reading offset %" PRId64
": %s",
1123 sectors_to_bytes(sector_num
), strerror(-ret
));
1129 sector_num
+= nb_sectors
;
1130 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1133 if (total_sectors1
!= total_sectors2
) {
1134 BlockDriverState
*bs_over
;
1135 int64_t total_sectors_over
;
1136 const char *filename_over
;
1138 qprintf(quiet
, "Warning: Image size mismatch!\n");
1139 if (total_sectors1
> total_sectors2
) {
1140 total_sectors_over
= total_sectors1
;
1142 filename_over
= filename1
;
1144 total_sectors_over
= total_sectors2
;
1146 filename_over
= filename2
;
1150 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1151 if (nb_sectors
<= 0) {
1154 ret
= bdrv_is_allocated_above(bs_over
, NULL
, sector_num
,
1158 error_report("Sector allocation test failed for %s",
1165 ret
= check_empty_sectors(bs_over
, sector_num
, nb_sectors
,
1166 filename_over
, buf1
, quiet
);
1169 error_report("Error while reading offset %" PRId64
1170 " of %s: %s", sectors_to_bytes(sector_num
),
1171 filename_over
, strerror(-ret
));
1177 sector_num
+= nb_sectors
;
1178 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1182 qprintf(quiet
, "Images are identical.\n");
1192 qemu_progress_end();
1196 static int img_convert(int argc
, char **argv
)
1198 int c
, n
, n1
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1200 int progress
= 0, flags
, src_flags
;
1201 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1202 BlockDriver
*drv
, *proto_drv
;
1203 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1204 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
1205 int64_t *bs_sectors
= NULL
;
1206 uint8_t * buf
= NULL
;
1207 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1208 const uint8_t *buf1
;
1209 BlockDriverInfo bdi
;
1210 QemuOpts
*opts
= NULL
;
1211 QemuOptsList
*create_opts
= NULL
;
1212 const char *out_baseimg_param
;
1213 char *options
= NULL
;
1214 const char *snapshot_name
= NULL
;
1215 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1217 Error
*local_err
= NULL
;
1218 QemuOpts
*sn_opts
= NULL
;
1223 src_cache
= BDRV_DEFAULT_CACHE
;
1228 c
= getopt(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1244 out_baseimg
= optarg
;
1250 error_report("option -e is deprecated, please use \'-o "
1251 "encryption\' instead!");
1255 error_report("option -6 is deprecated, please use \'-o "
1256 "compat6\' instead!");
1260 if (!is_valid_option_list(optarg
)) {
1261 error_report("Invalid option list: %s", optarg
);
1266 options
= g_strdup(optarg
);
1268 char *old_options
= options
;
1269 options
= g_strdup_printf("%s,%s", options
, optarg
);
1270 g_free(old_options
);
1274 snapshot_name
= optarg
;
1277 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1278 sn_opts
= qemu_opts_parse(&internal_snapshot_opts
, optarg
, 0);
1280 error_report("Failed in parsing snapshot param '%s'",
1286 snapshot_name
= optarg
;
1293 sval
= strtosz_suffix(optarg
, &end
, STRTOSZ_DEFSUFFIX_B
);
1294 if (sval
< 0 || *end
) {
1295 error_report("Invalid minimum zero buffer size for sparse output specified");
1300 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1321 /* Initialize before goto out */
1325 qemu_progress_init(progress
, 1.0);
1328 bs_n
= argc
- optind
- 1;
1329 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1331 if (options
&& has_help_option(options
)) {
1332 ret
= print_block_option_help(out_filename
, out_fmt
);
1337 error_exit("Must specify image file name");
1341 if (bs_n
> 1 && out_baseimg
) {
1342 error_report("-B makes no sense when concatenating multiple input "
1348 src_flags
= BDRV_O_FLAGS
;
1349 ret
= bdrv_parse_cache_flags(src_cache
, &src_flags
);
1351 error_report("Invalid source cache option: %s", src_cache
);
1355 qemu_progress_print(0, 100);
1357 bs
= g_new0(BlockDriverState
*, bs_n
);
1358 bs_sectors
= g_new(int64_t, bs_n
);
1361 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1362 char *id
= bs_n
> 1 ? g_strdup_printf("source_%d", bs_i
)
1363 : g_strdup("source");
1364 bs
[bs_i
] = bdrv_new_open(id
, argv
[optind
+ bs_i
], fmt
, src_flags
,
1368 error_report("Could not open '%s'", argv
[optind
+ bs_i
]);
1372 bs_sectors
[bs_i
] = bdrv_nb_sectors(bs
[bs_i
]);
1373 if (bs_sectors
[bs_i
] < 0) {
1374 error_report("Could not get size of %s: %s",
1375 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1379 total_sectors
+= bs_sectors
[bs_i
];
1383 ret
= bdrv_snapshot_load_tmp(bs
[0],
1384 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1385 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1387 } else if (snapshot_name
!= NULL
) {
1389 error_report("No support for concatenating multiple snapshot");
1394 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1397 error_report("Failed to load snapshot: %s",
1398 error_get_pretty(local_err
));
1399 error_free(local_err
);
1404 /* Find driver and parse its options */
1405 drv
= bdrv_find_format(out_fmt
);
1407 error_report("Unknown file format '%s'", out_fmt
);
1412 proto_drv
= bdrv_find_protocol(out_filename
, true);
1414 error_report("Unknown protocol '%s'", out_filename
);
1419 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1420 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1422 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1423 if (options
&& qemu_opts_do_parse(opts
, options
, NULL
)) {
1424 error_report("Invalid options for file format '%s'", out_fmt
);
1429 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512);
1430 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
1435 /* Get backing file name if -o backing_file was used */
1436 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
1437 if (out_baseimg_param
) {
1438 out_baseimg
= out_baseimg_param
;
1441 /* Check if compression is supported */
1444 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
1445 const char *preallocation
=
1446 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
1448 if (!drv
->bdrv_write_compressed
) {
1449 error_report("Compression not supported for this file format");
1455 error_report("Compression and encryption not supported at "
1462 && strcmp(preallocation
, "off"))
1464 error_report("Compression and preallocation not supported at "
1472 /* Create the new image */
1473 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
1475 error_report("%s: error while converting %s: %s",
1476 out_filename
, out_fmt
, error_get_pretty(local_err
));
1477 error_free(local_err
);
1482 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
1483 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1485 error_report("Invalid cache option: %s", cache
);
1489 out_bs
= bdrv_new_open("target", out_filename
, out_fmt
, flags
, true, quiet
);
1498 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1499 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1501 bufsectors
= MIN(32768,
1502 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
1503 out_bs
->bl
.discard_alignment
))
1506 buf
= qemu_blockalign(out_bs
, bufsectors
* BDRV_SECTOR_SIZE
);
1509 int64_t output_sectors
= bdrv_nb_sectors(out_bs
);
1510 if (output_sectors
< 0) {
1511 error_report("unable to get output image length: %s\n",
1512 strerror(-output_sectors
));
1515 } else if (output_sectors
< total_sectors
) {
1516 error_report("output file is smaller than input file");
1522 cluster_sectors
= 0;
1523 ret
= bdrv_get_info(out_bs
, &bdi
);
1526 error_report("could not get block driver info");
1530 compress
= compress
|| bdi
.needs_compressed_writes
;
1531 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
1535 if (cluster_sectors
<= 0 || cluster_sectors
> bufsectors
) {
1536 error_report("invalid cluster size");
1542 nb_sectors
= total_sectors
;
1549 nb_sectors
= total_sectors
- sector_num
;
1550 if (nb_sectors
<= 0)
1552 if (nb_sectors
>= cluster_sectors
)
1553 n
= cluster_sectors
;
1557 bs_num
= sector_num
- bs_offset
;
1558 assert (bs_num
>= 0);
1561 while (remainder
> 0) {
1563 while (bs_num
== bs_sectors
[bs_i
]) {
1564 bs_offset
+= bs_sectors
[bs_i
];
1566 assert (bs_i
< bs_n
);
1568 /* printf("changing part: sector_num=%" PRId64 ", "
1569 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1570 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1572 assert (bs_num
< bs_sectors
[bs_i
]);
1574 nlow
= remainder
> bs_sectors
[bs_i
] - bs_num
1575 ? bs_sectors
[bs_i
] - bs_num
: remainder
;
1577 ret
= bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
);
1579 error_report("error while reading sector %" PRId64
": %s",
1580 bs_num
, strerror(-ret
));
1589 assert (remainder
== 0);
1591 if (!buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)) {
1592 ret
= bdrv_write_compressed(out_bs
, sector_num
, buf
, n
);
1594 error_report("error while compressing sector %" PRId64
1595 ": %s", sector_num
, strerror(-ret
));
1600 qemu_progress_print(100.0 * sector_num
/ total_sectors
, 0);
1602 /* signal EOF to align */
1603 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
1605 int64_t sectors_to_read
, sectors_read
, sector_num_next_status
;
1606 bool count_allocated_sectors
;
1607 int has_zero_init
= min_sparse
? bdrv_has_zero_init(out_bs
) : 0;
1609 if (!has_zero_init
&& bdrv_can_write_zeroes_with_unmap(out_bs
)) {
1610 ret
= bdrv_make_zero(out_bs
, BDRV_REQ_MAY_UNMAP
);
1617 sectors_to_read
= total_sectors
;
1618 count_allocated_sectors
= progress
&& (out_baseimg
|| has_zero_init
);
1620 sector_num
= 0; // total number of sectors converted so far
1622 sector_num_next_status
= 0;
1625 nb_sectors
= total_sectors
- sector_num
;
1626 if (nb_sectors
<= 0) {
1627 if (count_allocated_sectors
) {
1628 sectors_to_read
= sectors_read
;
1629 count_allocated_sectors
= false;
1636 while (sector_num
- bs_offset
>= bs_sectors
[bs_i
]) {
1637 bs_offset
+= bs_sectors
[bs_i
];
1639 assert (bs_i
< bs_n
);
1640 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1641 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1642 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1645 if ((out_baseimg
|| has_zero_init
) &&
1646 sector_num
>= sector_num_next_status
) {
1647 n
= nb_sectors
> INT_MAX
? INT_MAX
: nb_sectors
;
1648 ret
= bdrv_get_block_status(bs
[bs_i
], sector_num
- bs_offset
,
1651 error_report("error while reading block status of sector %"
1652 PRId64
": %s", sector_num
- bs_offset
,
1656 /* If the output image is zero initialized, we are not working
1657 * on a shared base and the input is zero we can skip the next
1659 if (has_zero_init
&& !out_baseimg
&& (ret
& BDRV_BLOCK_ZERO
)) {
1663 /* If the output image is being created as a copy on write
1664 * image, assume that sectors which are unallocated in the
1665 * input image are present in both the output's and input's
1666 * base images (no need to copy them). */
1668 if (!(ret
& BDRV_BLOCK_DATA
)) {
1672 /* The next 'n1' sectors are allocated in the input image.
1673 * Copy only those as they may be followed by unallocated
1677 /* avoid redundant callouts to get_block_status */
1678 sector_num_next_status
= sector_num
+ n1
;
1681 n
= MIN(nb_sectors
, bufsectors
);
1683 /* round down request length to an aligned sector, but
1684 * do not bother doing this on short requests. They happen
1685 * when we found an all-zero area, and the next sector to
1686 * write will not be sector_num + n. */
1687 if (cluster_sectors
> 0 && n
>= cluster_sectors
) {
1688 int64_t next_aligned_sector
= (sector_num
+ n
);
1689 next_aligned_sector
-= next_aligned_sector
% cluster_sectors
;
1690 if (sector_num
+ n
> next_aligned_sector
) {
1691 n
= next_aligned_sector
- sector_num
;
1695 n
= MIN(n
, bs_sectors
[bs_i
] - (sector_num
- bs_offset
));
1698 if (count_allocated_sectors
) {
1704 ret
= bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
);
1706 error_report("error while reading sector %" PRId64
": %s",
1707 sector_num
- bs_offset
, strerror(-ret
));
1710 /* NOTE: at the same time we convert, we do not write zero
1711 sectors to have a chance to compress the image. Ideally, we
1712 should add a specific call to have the info to go faster */
1715 if (!has_zero_init
||
1716 is_allocated_sectors_min(buf1
, n
, &n1
, min_sparse
)) {
1717 ret
= bdrv_write(out_bs
, sector_num
, buf1
, n1
);
1719 error_report("error while writing sector %" PRId64
1720 ": %s", sector_num
, strerror(-ret
));
1728 qemu_progress_print(100.0 * sectors_read
/ sectors_to_read
, 0);
1733 qemu_progress_print(100, 0);
1735 qemu_progress_end();
1736 qemu_opts_del(opts
);
1737 qemu_opts_free(create_opts
);
1740 qemu_opts_del(sn_opts
);
1746 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1748 bdrv_unref(bs
[bs_i
]);
1764 static void dump_snapshots(BlockDriverState
*bs
)
1766 QEMUSnapshotInfo
*sn_tab
, *sn
;
1769 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
1772 printf("Snapshot list:\n");
1773 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
1775 for(i
= 0; i
< nb_sns
; i
++) {
1777 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
1783 static void dump_json_image_info_list(ImageInfoList
*list
)
1785 Error
*local_err
= NULL
;
1787 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1789 visit_type_ImageInfoList(qmp_output_get_visitor(ov
),
1790 &list
, NULL
, &local_err
);
1791 obj
= qmp_output_get_qobject(ov
);
1792 str
= qobject_to_json_pretty(obj
);
1793 assert(str
!= NULL
);
1794 printf("%s\n", qstring_get_str(str
));
1795 qobject_decref(obj
);
1796 qmp_output_visitor_cleanup(ov
);
1800 static void dump_json_image_info(ImageInfo
*info
)
1802 Error
*local_err
= NULL
;
1804 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1806 visit_type_ImageInfo(qmp_output_get_visitor(ov
),
1807 &info
, NULL
, &local_err
);
1808 obj
= qmp_output_get_qobject(ov
);
1809 str
= qobject_to_json_pretty(obj
);
1810 assert(str
!= NULL
);
1811 printf("%s\n", qstring_get_str(str
));
1812 qobject_decref(obj
);
1813 qmp_output_visitor_cleanup(ov
);
1817 static void dump_human_image_info_list(ImageInfoList
*list
)
1819 ImageInfoList
*elem
;
1822 for (elem
= list
; elem
; elem
= elem
->next
) {
1828 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
1832 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
1834 return strcmp(a
, b
) == 0;
1838 * Open an image file chain and return an ImageInfoList
1840 * @filename: topmost image filename
1841 * @fmt: topmost image format (may be NULL to autodetect)
1842 * @chain: true - enumerate entire backing file chain
1843 * false - only topmost image file
1845 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1846 * image file. If there was an error a message will have been printed to
1849 static ImageInfoList
*collect_image_info_list(const char *filename
,
1853 ImageInfoList
*head
= NULL
;
1854 ImageInfoList
**last
= &head
;
1855 GHashTable
*filenames
;
1858 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
1861 BlockDriverState
*bs
;
1863 ImageInfoList
*elem
;
1865 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
1866 error_report("Backing file '%s' creates an infinite loop.",
1870 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
1872 bs
= bdrv_new_open("image", filename
, fmt
,
1873 BDRV_O_FLAGS
| BDRV_O_NO_BACKING
, false, false);
1878 bdrv_query_image_info(bs
, &info
, &err
);
1880 error_report("%s", error_get_pretty(err
));
1886 elem
= g_new0(ImageInfoList
, 1);
1893 filename
= fmt
= NULL
;
1895 if (info
->has_full_backing_filename
) {
1896 filename
= info
->full_backing_filename
;
1897 } else if (info
->has_backing_filename
) {
1898 filename
= info
->backing_filename
;
1900 if (info
->has_backing_filename_format
) {
1901 fmt
= info
->backing_filename_format
;
1905 g_hash_table_destroy(filenames
);
1909 qapi_free_ImageInfoList(head
);
1910 g_hash_table_destroy(filenames
);
1914 static int img_info(int argc
, char **argv
)
1917 OutputFormat output_format
= OFORMAT_HUMAN
;
1919 const char *filename
, *fmt
, *output
;
1920 ImageInfoList
*list
;
1925 int option_index
= 0;
1926 static const struct option long_options
[] = {
1927 {"help", no_argument
, 0, 'h'},
1928 {"format", required_argument
, 0, 'f'},
1929 {"output", required_argument
, 0, OPTION_OUTPUT
},
1930 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
1933 c
= getopt_long(argc
, argv
, "f:h",
1934 long_options
, &option_index
);
1949 case OPTION_BACKING_CHAIN
:
1954 if (optind
!= argc
- 1) {
1955 error_exit("Expecting one image file name");
1957 filename
= argv
[optind
++];
1959 if (output
&& !strcmp(output
, "json")) {
1960 output_format
= OFORMAT_JSON
;
1961 } else if (output
&& !strcmp(output
, "human")) {
1962 output_format
= OFORMAT_HUMAN
;
1963 } else if (output
) {
1964 error_report("--output must be used with human or json as argument.");
1968 list
= collect_image_info_list(filename
, fmt
, chain
);
1973 switch (output_format
) {
1975 dump_human_image_info_list(list
);
1979 dump_json_image_info_list(list
);
1981 dump_json_image_info(list
->value
);
1986 qapi_free_ImageInfoList(list
);
1991 typedef struct MapEntry
{
1997 BlockDriverState
*bs
;
2000 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2003 switch (output_format
) {
2005 if ((e
->flags
& BDRV_BLOCK_DATA
) &&
2006 !(e
->flags
& BDRV_BLOCK_OFFSET_VALID
)) {
2007 error_report("File contains external, encrypted or compressed clusters.");
2010 if ((e
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) == BDRV_BLOCK_DATA
) {
2011 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2012 e
->start
, e
->length
, e
->offset
, e
->bs
->filename
);
2014 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2015 * Modify the flags here to allow more coalescing.
2018 (next
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) != BDRV_BLOCK_DATA
) {
2019 next
->flags
&= ~BDRV_BLOCK_DATA
;
2020 next
->flags
|= BDRV_BLOCK_ZERO
;
2024 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
", \"depth\": %d,"
2025 " \"zero\": %s, \"data\": %s",
2026 (e
->start
== 0 ? "[" : ",\n"),
2027 e
->start
, e
->length
, e
->depth
,
2028 (e
->flags
& BDRV_BLOCK_ZERO
) ? "true" : "false",
2029 (e
->flags
& BDRV_BLOCK_DATA
) ? "true" : "false");
2030 if (e
->flags
& BDRV_BLOCK_OFFSET_VALID
) {
2031 printf(", \"offset\": %"PRId64
"", e
->offset
);
2042 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2043 int nb_sectors
, MapEntry
*e
)
2048 /* As an optimization, we could cache the current range of unallocated
2049 * clusters in each file of the chain, and avoid querying the same
2055 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
);
2060 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2063 bs
= bs
->backing_hd
;
2072 e
->start
= sector_num
* BDRV_SECTOR_SIZE
;
2073 e
->length
= nb_sectors
* BDRV_SECTOR_SIZE
;
2074 e
->flags
= ret
& ~BDRV_BLOCK_OFFSET_MASK
;
2075 e
->offset
= ret
& BDRV_BLOCK_OFFSET_MASK
;
2081 static int img_map(int argc
, char **argv
)
2084 OutputFormat output_format
= OFORMAT_HUMAN
;
2085 BlockDriverState
*bs
;
2086 const char *filename
, *fmt
, *output
;
2088 MapEntry curr
= { .length
= 0 }, next
;
2094 int option_index
= 0;
2095 static const struct option long_options
[] = {
2096 {"help", no_argument
, 0, 'h'},
2097 {"format", required_argument
, 0, 'f'},
2098 {"output", required_argument
, 0, OPTION_OUTPUT
},
2101 c
= getopt_long(argc
, argv
, "f:h",
2102 long_options
, &option_index
);
2119 if (optind
!= argc
- 1) {
2120 error_exit("Expecting one image file name");
2122 filename
= argv
[optind
];
2124 if (output
&& !strcmp(output
, "json")) {
2125 output_format
= OFORMAT_JSON
;
2126 } else if (output
&& !strcmp(output
, "human")) {
2127 output_format
= OFORMAT_HUMAN
;
2128 } else if (output
) {
2129 error_report("--output must be used with human or json as argument.");
2133 bs
= bdrv_new_open("image", filename
, fmt
, BDRV_O_FLAGS
, true, false);
2138 if (output_format
== OFORMAT_HUMAN
) {
2139 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2142 length
= bdrv_getlength(bs
);
2143 while (curr
.start
+ curr
.length
< length
) {
2144 int64_t nsectors_left
;
2148 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2150 /* Probe up to 1 GiB at a time. */
2151 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2152 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2153 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2156 error_report("Could not read file metadata: %s", strerror(-ret
));
2160 if (curr
.length
!= 0 && curr
.flags
== next
.flags
&&
2161 curr
.depth
== next
.depth
&&
2162 ((curr
.flags
& BDRV_BLOCK_OFFSET_VALID
) == 0 ||
2163 curr
.offset
+ curr
.length
== next
.offset
)) {
2164 curr
.length
+= next
.length
;
2168 if (curr
.length
> 0) {
2169 dump_map_entry(output_format
, &curr
, &next
);
2174 dump_map_entry(output_format
, &curr
, NULL
);
2181 #define SNAPSHOT_LIST 1
2182 #define SNAPSHOT_CREATE 2
2183 #define SNAPSHOT_APPLY 3
2184 #define SNAPSHOT_DELETE 4
2186 static int img_snapshot(int argc
, char **argv
)
2188 BlockDriverState
*bs
;
2189 QEMUSnapshotInfo sn
;
2190 char *filename
, *snapshot_name
= NULL
;
2191 int c
, ret
= 0, bdrv_oflags
;
2197 bdrv_oflags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2198 /* Parse commandline parameters */
2200 c
= getopt(argc
, argv
, "la:c:d:hq");
2211 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2214 action
= SNAPSHOT_LIST
;
2215 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2219 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2222 action
= SNAPSHOT_APPLY
;
2223 snapshot_name
= optarg
;
2227 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2230 action
= SNAPSHOT_CREATE
;
2231 snapshot_name
= optarg
;
2235 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2238 action
= SNAPSHOT_DELETE
;
2239 snapshot_name
= optarg
;
2247 if (optind
!= argc
- 1) {
2248 error_exit("Expecting one image file name");
2250 filename
= argv
[optind
++];
2252 /* Open the image */
2253 bs
= bdrv_new_open("image", filename
, NULL
, bdrv_oflags
, true, quiet
);
2258 /* Perform the requested action */
2264 case SNAPSHOT_CREATE
:
2265 memset(&sn
, 0, sizeof(sn
));
2266 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2268 qemu_gettimeofday(&tv
);
2269 sn
.date_sec
= tv
.tv_sec
;
2270 sn
.date_nsec
= tv
.tv_usec
* 1000;
2272 ret
= bdrv_snapshot_create(bs
, &sn
);
2274 error_report("Could not create snapshot '%s': %d (%s)",
2275 snapshot_name
, ret
, strerror(-ret
));
2279 case SNAPSHOT_APPLY
:
2280 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2282 error_report("Could not apply snapshot '%s': %d (%s)",
2283 snapshot_name
, ret
, strerror(-ret
));
2287 case SNAPSHOT_DELETE
:
2288 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2290 error_report("Could not delete snapshot '%s': (%s)",
2291 snapshot_name
, error_get_pretty(err
));
2306 static int img_rebase(int argc
, char **argv
)
2308 BlockDriverState
*bs
= NULL
, *bs_old_backing
= NULL
, *bs_new_backing
= NULL
;
2309 BlockDriver
*old_backing_drv
, *new_backing_drv
;
2311 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2312 int c
, flags
, src_flags
, ret
;
2316 Error
*local_err
= NULL
;
2318 /* Parse commandline parameters */
2320 cache
= BDRV_DEFAULT_CACHE
;
2321 src_cache
= BDRV_DEFAULT_CACHE
;
2325 c
= getopt(argc
, argv
, "hf:F:b:upt:T:q");
2338 out_basefmt
= optarg
;
2341 out_baseimg
= optarg
;
2365 if (optind
!= argc
- 1) {
2366 error_exit("Expecting one image file name");
2368 if (!unsafe
&& !out_baseimg
) {
2369 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2371 filename
= argv
[optind
++];
2373 qemu_progress_init(progress
, 2.0);
2374 qemu_progress_print(0, 100);
2376 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2377 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2379 error_report("Invalid cache option: %s", cache
);
2383 src_flags
= BDRV_O_FLAGS
;
2384 ret
= bdrv_parse_cache_flags(src_cache
, &src_flags
);
2386 error_report("Invalid source cache option: %s", src_cache
);
2393 * Ignore the old backing file for unsafe rebase in case we want to correct
2394 * the reference to a renamed or moved backing file.
2396 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
2402 /* Find the right drivers for the backing files */
2403 old_backing_drv
= NULL
;
2404 new_backing_drv
= NULL
;
2406 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
2407 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
2408 if (old_backing_drv
== NULL
) {
2409 error_report("Invalid format name: '%s'", bs
->backing_format
);
2415 if (out_basefmt
!= NULL
) {
2416 new_backing_drv
= bdrv_find_format(out_basefmt
);
2417 if (new_backing_drv
== NULL
) {
2418 error_report("Invalid format name: '%s'", out_basefmt
);
2424 /* For safe rebasing we need to compare old and new backing file */
2426 char backing_name
[1024];
2428 bs_old_backing
= bdrv_new("old_backing", &error_abort
);
2429 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2430 ret
= bdrv_open(&bs_old_backing
, backing_name
, NULL
, NULL
, src_flags
,
2431 old_backing_drv
, &local_err
);
2433 error_report("Could not open old backing file '%s': %s",
2434 backing_name
, error_get_pretty(local_err
));
2435 error_free(local_err
);
2438 if (out_baseimg
[0]) {
2439 bs_new_backing
= bdrv_new("new_backing", &error_abort
);
2440 ret
= bdrv_open(&bs_new_backing
, out_baseimg
, NULL
, NULL
, src_flags
,
2441 new_backing_drv
, &local_err
);
2443 error_report("Could not open new backing file '%s': %s",
2444 out_baseimg
, error_get_pretty(local_err
));
2445 error_free(local_err
);
2452 * Check each unallocated cluster in the COW file. If it is unallocated,
2453 * accesses go to the backing file. We must therefore compare this cluster
2454 * in the old and new backing file, and if they differ we need to copy it
2455 * from the old backing file into the COW file.
2457 * If qemu-img crashes during this step, no harm is done. The content of
2458 * the image is the same as the original one at any time.
2461 int64_t num_sectors
;
2462 int64_t old_backing_num_sectors
;
2463 int64_t new_backing_num_sectors
= 0;
2468 float local_progress
= 0;
2470 buf_old
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2471 buf_new
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2473 num_sectors
= bdrv_nb_sectors(bs
);
2474 if (num_sectors
< 0) {
2475 error_report("Could not get size of '%s': %s",
2476 filename
, strerror(-num_sectors
));
2480 old_backing_num_sectors
= bdrv_nb_sectors(bs_old_backing
);
2481 if (old_backing_num_sectors
< 0) {
2482 char backing_name
[1024];
2484 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2485 error_report("Could not get size of '%s': %s",
2486 backing_name
, strerror(-old_backing_num_sectors
));
2490 if (bs_new_backing
) {
2491 new_backing_num_sectors
= bdrv_nb_sectors(bs_new_backing
);
2492 if (new_backing_num_sectors
< 0) {
2493 error_report("Could not get size of '%s': %s",
2494 out_baseimg
, strerror(-new_backing_num_sectors
));
2500 if (num_sectors
!= 0) {
2501 local_progress
= (float)100 /
2502 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
2505 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
2507 /* How many sectors can we handle with the next read? */
2508 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
2509 n
= (IO_BUF_SIZE
/ 512);
2511 n
= num_sectors
- sector
;
2514 /* If the cluster is allocated, we don't need to take action */
2515 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
2517 error_report("error while reading image metadata: %s",
2526 * Read old and new backing file and take into consideration that
2527 * backing files may be smaller than the COW image.
2529 if (sector
>= old_backing_num_sectors
) {
2530 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
2532 if (sector
+ n
> old_backing_num_sectors
) {
2533 n
= old_backing_num_sectors
- sector
;
2536 ret
= bdrv_read(bs_old_backing
, sector
, buf_old
, n
);
2538 error_report("error while reading from old backing file");
2543 if (sector
>= new_backing_num_sectors
|| !bs_new_backing
) {
2544 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
2546 if (sector
+ n
> new_backing_num_sectors
) {
2547 n
= new_backing_num_sectors
- sector
;
2550 ret
= bdrv_read(bs_new_backing
, sector
, buf_new
, n
);
2552 error_report("error while reading from new backing file");
2557 /* If they differ, we need to write to the COW file */
2558 uint64_t written
= 0;
2560 while (written
< n
) {
2563 if (compare_sectors(buf_old
+ written
* 512,
2564 buf_new
+ written
* 512, n
- written
, &pnum
))
2566 ret
= bdrv_write(bs
, sector
+ written
,
2567 buf_old
+ written
* 512, pnum
);
2569 error_report("Error while writing to COW image: %s",
2577 qemu_progress_print(local_progress
, 100);
2580 qemu_vfree(buf_old
);
2581 qemu_vfree(buf_new
);
2585 * Change the backing file. All clusters that are different from the old
2586 * backing file are overwritten in the COW file now, so the visible content
2587 * doesn't change when we switch the backing file.
2589 if (out_baseimg
&& *out_baseimg
) {
2590 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
2592 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
2595 if (ret
== -ENOSPC
) {
2596 error_report("Could not change the backing file to '%s': No "
2597 "space left in the file header", out_baseimg
);
2598 } else if (ret
< 0) {
2599 error_report("Could not change the backing file to '%s': %s",
2600 out_baseimg
, strerror(-ret
));
2603 qemu_progress_print(100, 0);
2605 * TODO At this point it is possible to check if any clusters that are
2606 * allocated in the COW file are the same in the backing file. If so, they
2607 * could be dropped from the COW file. Don't do this before switching the
2608 * backing file, in case of a crash this would lead to corruption.
2611 qemu_progress_end();
2614 if (bs_old_backing
!= NULL
) {
2615 bdrv_unref(bs_old_backing
);
2617 if (bs_new_backing
!= NULL
) {
2618 bdrv_unref(bs_new_backing
);
2629 static int img_resize(int argc
, char **argv
)
2631 int c
, ret
, relative
;
2632 const char *filename
, *fmt
, *size
;
2633 int64_t n
, total_size
;
2635 BlockDriverState
*bs
= NULL
;
2637 static QemuOptsList resize_options
= {
2638 .name
= "resize_options",
2639 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
2642 .name
= BLOCK_OPT_SIZE
,
2643 .type
= QEMU_OPT_SIZE
,
2644 .help
= "Virtual disk size"
2651 /* Remove size from argv manually so that negative numbers are not treated
2652 * as options by getopt. */
2654 error_exit("Not enough arguments");
2658 size
= argv
[--argc
];
2660 /* Parse getopt arguments */
2663 c
= getopt(argc
, argv
, "f:hq");
2680 if (optind
!= argc
- 1) {
2681 error_exit("Expecting one image file name");
2683 filename
= argv
[optind
++];
2685 /* Choose grow, shrink, or absolute resize mode */
2701 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
2702 if (qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
)) {
2703 /* Error message already printed when size parsing fails */
2705 qemu_opts_del(param
);
2708 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
2709 qemu_opts_del(param
);
2711 bs
= bdrv_new_open("image", filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
,
2719 total_size
= bdrv_getlength(bs
) + n
* relative
;
2723 if (total_size
<= 0) {
2724 error_report("New image size must be positive");
2729 ret
= bdrv_truncate(bs
, total_size
);
2732 qprintf(quiet
, "Image resized.\n");
2735 error_report("This image does not support resize");
2738 error_report("Image is read-only");
2741 error_report("Error resizing image (%d)", -ret
);
2754 static int img_amend(int argc
, char **argv
)
2757 char *options
= NULL
;
2758 QemuOptsList
*create_opts
= NULL
;
2759 QemuOpts
*opts
= NULL
;
2760 const char *fmt
= NULL
, *filename
, *cache
;
2763 BlockDriverState
*bs
= NULL
;
2765 cache
= BDRV_DEFAULT_CACHE
;
2767 c
= getopt(argc
, argv
, "ho:f:t:q");
2778 if (!is_valid_option_list(optarg
)) {
2779 error_report("Invalid option list: %s", optarg
);
2784 options
= g_strdup(optarg
);
2786 char *old_options
= options
;
2787 options
= g_strdup_printf("%s,%s", options
, optarg
);
2788 g_free(old_options
);
2804 error_exit("Must specify options (-o)");
2807 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
2808 if (fmt
&& has_help_option(options
)) {
2809 /* If a format is explicitly specified (and possibly no filename is
2810 * given), print option help here */
2811 ret
= print_block_option_help(filename
, fmt
);
2815 if (optind
!= argc
- 1) {
2816 error_exit("Expecting one image file name");
2819 flags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2820 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2822 error_report("Invalid cache option: %s", cache
);
2826 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
2828 error_report("Could not open image '%s'", filename
);
2833 fmt
= bs
->drv
->format_name
;
2835 if (has_help_option(options
)) {
2836 /* If the format was auto-detected, print option help here */
2837 ret
= print_block_option_help(filename
, fmt
);
2841 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
2842 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2843 if (options
&& qemu_opts_do_parse(opts
, options
, NULL
)) {
2844 error_report("Invalid options for file format '%s'", fmt
);
2849 ret
= bdrv_amend_options(bs
, opts
);
2851 error_report("Error while amending options: %s", strerror(-ret
));
2859 qemu_opts_del(opts
);
2860 qemu_opts_free(create_opts
);
2869 static const img_cmd_t img_cmds
[] = {
2870 #define DEF(option, callback, arg_string) \
2871 { option, callback },
2872 #include "qemu-img-cmds.h"
2878 int main(int argc
, char **argv
)
2880 const img_cmd_t
*cmd
;
2881 const char *cmdname
;
2882 Error
*local_error
= NULL
;
2884 static const struct option long_options
[] = {
2885 {"help", no_argument
, 0, 'h'},
2886 {"version", no_argument
, 0, 'v'},
2891 signal(SIGPIPE
, SIG_IGN
);
2894 error_set_progname(argv
[0]);
2895 qemu_init_exec_dir(argv
[0]);
2897 if (qemu_init_main_loop(&local_error
)) {
2898 error_report("%s", error_get_pretty(local_error
));
2899 error_free(local_error
);
2905 error_exit("Not enough arguments");
2909 /* find the command */
2910 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
2911 if (!strcmp(cmdname
, cmd
->name
)) {
2912 return cmd
->handler(argc
- 1, argv
+ 1);
2916 c
= getopt_long(argc
, argv
, "h", long_options
, NULL
);
2922 printf(QEMU_IMG_VERSION
);
2927 error_exit("Command not found: %s", cmdname
);