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"
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 gint
compare_data(gconstpointer a
, gconstpointer b
, gpointer user
)
61 return g_strcmp0(a
, b
);
64 static void print_format(gpointer data
, gpointer user
)
66 printf(" %s", (char *)data
);
69 static void add_format_to_seq(void *opaque
, const char *fmt_name
)
71 GSequence
*seq
= opaque
;
73 g_sequence_insert_sorted(seq
, (gpointer
)fmt_name
,
77 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
81 error_printf("qemu-img: ");
84 error_vprintf(fmt
, ap
);
87 error_printf("\nTry 'qemu-img --help' for more information\n");
91 /* Please keep in synch with qemu-img.texi */
92 static void QEMU_NORETURN
help(void)
94 const char *help_msg
=
96 "usage: qemu-img command [command options]\n"
97 "QEMU disk image utility\n"
100 #define DEF(option, callback, arg_string) \
102 #include "qemu-img-cmds.h"
106 "Command parameters:\n"
107 " 'filename' is a disk image filename\n"
108 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
109 " 'cache' is the cache mode used to write the output disk image, the valid\n"
110 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
111 " 'directsync' and 'unsafe' (default for convert)\n"
112 " 'size' is the disk image size in bytes. Optional suffixes\n"
113 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
114 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
115 " supported. 'b' is ignored.\n"
116 " 'output_filename' is the destination disk image filename\n"
117 " 'output_fmt' is the destination format\n"
118 " 'options' is a comma separated list of format specific options in a\n"
119 " name=value format. Use -o ? for an overview of the options supported by the\n"
121 " 'snapshot_param' is param used for internal snapshot, format\n"
122 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
124 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
126 " '-c' indicates that target image must be compressed (qcow format only)\n"
127 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
128 " match exactly. The image doesn't need a working backing file before\n"
129 " rebasing in this case (useful for renaming the backing file)\n"
130 " '-h' with or without a command shows this help and lists the supported formats\n"
131 " '-p' show progress of command (only certain commands)\n"
132 " '-q' use Quiet mode - do not print any output (except errors)\n"
133 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
134 " contain only zeros for qemu-img to create a sparse image during\n"
135 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
136 " unallocated or zero sectors, and the destination image will always be\n"
138 " '--output' takes the format in which the output must be done (human or json)\n"
139 " '-n' skips the target volume creation (useful if the volume is created\n"
140 " prior to running qemu-img)\n"
142 "Parameters to check subcommand:\n"
143 " '-r' tries to repair any inconsistencies that are found during the check.\n"
144 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
145 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
146 " hiding corruption that has already occurred.\n"
148 "Parameters to snapshot subcommand:\n"
149 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
150 " '-a' applies a snapshot (revert disk to saved state)\n"
151 " '-c' creates a snapshot\n"
152 " '-d' deletes a snapshot\n"
153 " '-l' lists all snapshots in the given image\n"
155 "Parameters to compare subcommand:\n"
156 " '-f' first image format\n"
157 " '-F' second image format\n"
158 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
161 printf("%s\nSupported formats:", help_msg
);
162 seq
= g_sequence_new(NULL
);
163 bdrv_iterate_format(add_format_to_seq
, seq
);
164 g_sequence_foreach(seq
, print_format
, NULL
);
166 g_sequence_free(seq
);
171 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
177 ret
= vprintf(fmt
, args
);
184 /* XXX: put correct support for win32 */
185 static int read_password(char *buf
, int buf_size
)
189 printf("Password: ");
197 } else if (c
== '\n') {
199 } else if (i
< (buf_size
- 1)) {
211 static struct termios oldtty
;
213 static void term_exit(void)
215 tcsetattr (0, TCSANOW
, &oldtty
);
218 static void term_init(void)
225 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
226 |INLCR
|IGNCR
|ICRNL
|IXON
);
227 tty
.c_oflag
|= OPOST
;
228 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
229 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
234 tcsetattr (0, TCSANOW
, &tty
);
239 static int read_password(char *buf
, int buf_size
)
244 printf("password: ");
249 ret
= read(0, &ch
, 1);
251 if (errno
== EAGAIN
|| errno
== EINTR
) {
256 } else if (ret
== 0) {
264 if (i
< (buf_size
- 1))
275 static int print_block_option_help(const char *filename
, const char *fmt
)
277 BlockDriver
*drv
, *proto_drv
;
278 QemuOptsList
*create_opts
= NULL
;
280 /* Find driver and parse its options */
281 drv
= bdrv_find_format(fmt
);
283 error_report("Unknown file format '%s'", fmt
);
287 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
289 proto_drv
= bdrv_find_protocol(filename
, true);
291 error_report("Unknown protocol '%s'", filename
);
292 qemu_opts_free(create_opts
);
295 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
298 qemu_opts_print_help(create_opts
);
299 qemu_opts_free(create_opts
);
303 static BlockDriverState
*bdrv_new_open(const char *id
,
304 const char *filename
,
310 BlockDriverState
*bs
;
313 Error
*local_err
= NULL
;
316 bs
= bdrv_new(id
, &error_abort
);
319 drv
= bdrv_find_format(fmt
);
321 error_report("Unknown file format '%s'", fmt
);
328 ret
= bdrv_open(&bs
, filename
, NULL
, NULL
, flags
, drv
, &local_err
);
330 error_report("Could not open '%s': %s", filename
,
331 error_get_pretty(local_err
));
332 error_free(local_err
);
336 if (bdrv_is_encrypted(bs
) && require_io
) {
337 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
338 if (read_password(password
, sizeof(password
)) < 0) {
339 error_report("No password given");
342 if (bdrv_set_key(bs
, password
) < 0) {
343 error_report("invalid password");
353 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
354 const char *base_filename
,
355 const char *base_fmt
)
358 if (qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
)) {
359 error_report("Backing file not supported for file format '%s'",
365 if (qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
366 error_report("Backing file format not supported for file "
374 static int img_create(int argc
, char **argv
)
377 uint64_t img_size
= -1;
378 const char *fmt
= "raw";
379 const char *base_fmt
= NULL
;
380 const char *filename
;
381 const char *base_filename
= NULL
;
382 char *options
= NULL
;
383 Error
*local_err
= NULL
;
387 c
= getopt(argc
, argv
, "F:b:f:he6o:q");
400 base_filename
= optarg
;
406 error_report("option -e is deprecated, please use \'-o "
407 "encryption\' instead!");
410 error_report("option -6 is deprecated, please use \'-o "
411 "compat6\' instead!");
414 if (!is_valid_option_list(optarg
)) {
415 error_report("Invalid option list: %s", optarg
);
419 options
= g_strdup(optarg
);
421 char *old_options
= options
;
422 options
= g_strdup_printf("%s,%s", options
, optarg
);
432 /* Get the filename */
433 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
434 if (options
&& has_help_option(options
)) {
436 return print_block_option_help(filename
, fmt
);
439 if (optind
>= argc
) {
440 error_exit("Expecting image file name");
444 /* Get image size, if specified */
448 sval
= strtosz_suffix(argv
[optind
++], &end
, STRTOSZ_DEFSUFFIX_B
);
449 if (sval
< 0 || *end
) {
450 if (sval
== -ERANGE
) {
451 error_report("Image size must be less than 8 EiB!");
453 error_report("Invalid image size specified! You may use k, M, "
454 "G, T, P or E suffixes for ");
455 error_report("kilobytes, megabytes, gigabytes, terabytes, "
456 "petabytes and exabytes.");
460 img_size
= (uint64_t)sval
;
462 if (optind
!= argc
) {
463 error_exit("Unexpected argument: %s", argv
[optind
]);
466 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
467 options
, img_size
, BDRV_O_FLAGS
, &local_err
, quiet
);
469 error_report("%s: %s", filename
, error_get_pretty(local_err
));
470 error_free(local_err
);
482 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
484 Error
*local_err
= NULL
;
486 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
488 visit_type_ImageCheck(qmp_output_get_visitor(ov
),
489 &check
, NULL
, &local_err
);
490 obj
= qmp_output_get_qobject(ov
);
491 str
= qobject_to_json_pretty(obj
);
493 qprintf(quiet
, "%s\n", qstring_get_str(str
));
495 qmp_output_visitor_cleanup(ov
);
499 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
501 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
502 qprintf(quiet
, "No errors were found on the image.\n");
504 if (check
->corruptions
) {
505 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
506 "Data may be corrupted, or further writes to the image "
513 "\n%" PRId64
" leaked clusters were found on the image.\n"
514 "This means waste of disk space, but no harm to data.\n",
518 if (check
->check_errors
) {
521 " internal errors have occurred during the check.\n",
522 check
->check_errors
);
526 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
527 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
528 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
529 check
->allocated_clusters
, check
->total_clusters
,
530 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
531 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
532 check
->compressed_clusters
* 100.0 /
533 check
->allocated_clusters
);
536 if (check
->image_end_offset
) {
538 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
542 static int collect_image_check(BlockDriverState
*bs
,
544 const char *filename
,
549 BdrvCheckResult result
;
551 ret
= bdrv_check(bs
, &result
, fix
);
556 check
->filename
= g_strdup(filename
);
557 check
->format
= g_strdup(bdrv_get_format_name(bs
));
558 check
->check_errors
= result
.check_errors
;
559 check
->corruptions
= result
.corruptions
;
560 check
->has_corruptions
= result
.corruptions
!= 0;
561 check
->leaks
= result
.leaks
;
562 check
->has_leaks
= result
.leaks
!= 0;
563 check
->corruptions_fixed
= result
.corruptions_fixed
;
564 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
565 check
->leaks_fixed
= result
.leaks_fixed
;
566 check
->has_leaks_fixed
= result
.leaks
!= 0;
567 check
->image_end_offset
= result
.image_end_offset
;
568 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
569 check
->total_clusters
= result
.bfi
.total_clusters
;
570 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
571 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
572 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
573 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
574 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
575 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
576 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
582 * Checks an image for consistency. Exit codes:
584 * 0 - Check completed, image is good
585 * 1 - Check not completed because of internal errors
586 * 2 - Check completed, image is corrupted
587 * 3 - Check completed, image has leaked clusters, but is good otherwise
588 * 63 - Checks are not supported by the image format
590 static int img_check(int argc
, char **argv
)
593 OutputFormat output_format
= OFORMAT_HUMAN
;
594 const char *filename
, *fmt
, *output
;
595 BlockDriverState
*bs
;
597 int flags
= BDRV_O_FLAGS
| BDRV_O_CHECK
;
604 int option_index
= 0;
605 static const struct option long_options
[] = {
606 {"help", no_argument
, 0, 'h'},
607 {"format", required_argument
, 0, 'f'},
608 {"repair", required_argument
, 0, 'r'},
609 {"output", required_argument
, 0, OPTION_OUTPUT
},
612 c
= getopt_long(argc
, argv
, "f:hr:q",
613 long_options
, &option_index
);
626 flags
|= BDRV_O_RDWR
;
628 if (!strcmp(optarg
, "leaks")) {
629 fix
= BDRV_FIX_LEAKS
;
630 } else if (!strcmp(optarg
, "all")) {
631 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
633 error_exit("Unknown option value for -r "
634 "(expecting 'leaks' or 'all'): %s", optarg
);
645 if (optind
!= argc
- 1) {
646 error_exit("Expecting one image file name");
648 filename
= argv
[optind
++];
650 if (output
&& !strcmp(output
, "json")) {
651 output_format
= OFORMAT_JSON
;
652 } else if (output
&& !strcmp(output
, "human")) {
653 output_format
= OFORMAT_HUMAN
;
655 error_report("--output must be used with human or json as argument.");
659 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
664 check
= g_new0(ImageCheck
, 1);
665 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
667 if (ret
== -ENOTSUP
) {
668 error_report("This image format does not support checks");
673 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
674 int corruptions_fixed
, leaks_fixed
;
676 leaks_fixed
= check
->leaks_fixed
;
677 corruptions_fixed
= check
->corruptions_fixed
;
679 if (output_format
== OFORMAT_HUMAN
) {
681 "The following inconsistencies were found and repaired:\n\n"
682 " %" PRId64
" leaked clusters\n"
683 " %" PRId64
" corruptions\n\n"
684 "Double checking the fixed image now...\n",
686 check
->corruptions_fixed
);
689 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
691 check
->leaks_fixed
= leaks_fixed
;
692 check
->corruptions_fixed
= corruptions_fixed
;
695 switch (output_format
) {
697 dump_human_image_check(check
, quiet
);
700 dump_json_image_check(check
, quiet
);
704 if (ret
|| check
->check_errors
) {
709 if (check
->corruptions
) {
711 } else if (check
->leaks
) {
718 qapi_free_ImageCheck(check
);
724 static int img_commit(int argc
, char **argv
)
727 const char *filename
, *fmt
, *cache
;
728 BlockDriverState
*bs
;
732 cache
= BDRV_DEFAULT_CACHE
;
734 c
= getopt(argc
, argv
, "f:ht:q");
754 if (optind
!= argc
- 1) {
755 error_exit("Expecting one image file name");
757 filename
= argv
[optind
++];
760 ret
= bdrv_parse_cache_flags(cache
, &flags
);
762 error_report("Invalid cache option: %s", cache
);
766 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
770 ret
= bdrv_commit(bs
);
773 qprintf(quiet
, "Image committed.\n");
776 error_report("No disk inserted");
779 error_report("Image is read-only");
782 error_report("Image is already committed");
785 error_report("Error while committing image");
797 * Returns true iff the first sector pointed to by 'buf' contains at least
800 * 'pnum' is set to the number of sectors (including and immediately following
801 * the first one) that are known to be in the same allocated/unallocated state.
803 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
812 is_zero
= buffer_is_zero(buf
, 512);
813 for(i
= 1; i
< n
; i
++) {
815 if (is_zero
!= buffer_is_zero(buf
, 512)) {
824 * Like is_allocated_sectors, but if the buffer starts with a used sector,
825 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
826 * breaking up write requests for only small sparse areas.
828 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
832 int num_checked
, num_used
;
838 ret
= is_allocated_sectors(buf
, n
, pnum
);
844 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
846 num_checked
= num_used
;
849 ret
= is_allocated_sectors(buf
, n
, pnum
);
851 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
853 num_checked
+= *pnum
;
855 num_used
= num_checked
;
856 } else if (*pnum
>= min
) {
866 * Compares two buffers sector by sector. Returns 0 if the first sector of both
867 * buffers matches, non-zero otherwise.
869 * pnum is set to the number of sectors (including and immediately following
870 * the first one) that are known to have the same comparison result
872 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
882 res
= !!memcmp(buf1
, buf2
, 512);
883 for(i
= 1; i
< n
; i
++) {
887 if (!!memcmp(buf1
, buf2
, 512) != res
) {
896 #define IO_BUF_SIZE (2 * 1024 * 1024)
898 static int64_t sectors_to_bytes(int64_t sectors
)
900 return sectors
<< BDRV_SECTOR_BITS
;
903 static int64_t sectors_to_process(int64_t total
, int64_t from
)
905 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
909 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
911 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
912 * data and negative value on error.
914 * @param bs: Driver used for accessing file
915 * @param sect_num: Number of first sector to check
916 * @param sect_count: Number of sectors to check
917 * @param filename: Name of disk file we are checking (logging purpose)
918 * @param buffer: Allocated buffer for storing read data
919 * @param quiet: Flag for quiet mode
921 static int check_empty_sectors(BlockDriverState
*bs
, int64_t sect_num
,
922 int sect_count
, const char *filename
,
923 uint8_t *buffer
, bool quiet
)
926 ret
= bdrv_read(bs
, sect_num
, buffer
, sect_count
);
928 error_report("Error while reading offset %" PRId64
" of %s: %s",
929 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
932 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
933 if (ret
|| pnum
!= sect_count
) {
934 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
935 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
943 * Compares two images. Exit codes:
945 * 0 - Images are identical
947 * >1 - Error occurred
949 static int img_compare(int argc
, char **argv
)
951 const char *fmt1
= NULL
, *fmt2
= NULL
, *filename1
, *filename2
;
952 BlockDriverState
*bs1
, *bs2
;
953 int64_t total_sectors1
, total_sectors2
;
954 uint8_t *buf1
= NULL
, *buf2
= NULL
;
956 int allocated1
, allocated2
;
957 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
958 bool progress
= false, quiet
= false, strict
= false;
959 int64_t total_sectors
;
960 int64_t sector_num
= 0;
963 uint64_t progress_base
;
966 c
= getopt(argc
, argv
, "hpf:F:sq");
993 /* Progress is not shown in Quiet mode */
999 if (optind
!= argc
- 2) {
1000 error_exit("Expecting two image file names");
1002 filename1
= argv
[optind
++];
1003 filename2
= argv
[optind
++];
1005 /* Initialize before goto out */
1006 qemu_progress_init(progress
, 2.0);
1008 bs1
= bdrv_new_open("image 1", filename1
, fmt1
, BDRV_O_FLAGS
, true, quiet
);
1010 error_report("Can't open file %s", filename1
);
1015 bs2
= bdrv_new_open("image 2", filename2
, fmt2
, BDRV_O_FLAGS
, true, quiet
);
1017 error_report("Can't open file %s", filename2
);
1022 buf1
= qemu_blockalign(bs1
, IO_BUF_SIZE
);
1023 buf2
= qemu_blockalign(bs2
, IO_BUF_SIZE
);
1024 total_sectors1
= bdrv_nb_sectors(bs1
);
1025 if (total_sectors1
< 0) {
1026 error_report("Can't get size of %s: %s",
1027 filename1
, strerror(-total_sectors1
));
1031 total_sectors2
= bdrv_nb_sectors(bs2
);
1032 if (total_sectors2
< 0) {
1033 error_report("Can't get size of %s: %s",
1034 filename2
, strerror(-total_sectors2
));
1038 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1039 progress_base
= MAX(total_sectors1
, total_sectors2
);
1041 qemu_progress_print(0, 100);
1043 if (strict
&& total_sectors1
!= total_sectors2
) {
1045 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1050 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1051 if (nb_sectors
<= 0) {
1054 allocated1
= bdrv_is_allocated_above(bs1
, NULL
, sector_num
, nb_sectors
,
1056 if (allocated1
< 0) {
1058 error_report("Sector allocation test failed for %s", filename1
);
1062 allocated2
= bdrv_is_allocated_above(bs2
, NULL
, sector_num
, nb_sectors
,
1064 if (allocated2
< 0) {
1066 error_report("Sector allocation test failed for %s", filename2
);
1069 nb_sectors
= MIN(pnum1
, pnum2
);
1071 if (allocated1
== allocated2
) {
1073 ret
= bdrv_read(bs1
, sector_num
, buf1
, nb_sectors
);
1075 error_report("Error while reading offset %" PRId64
" of %s:"
1076 " %s", sectors_to_bytes(sector_num
), filename1
,
1081 ret
= bdrv_read(bs2
, sector_num
, buf2
, nb_sectors
);
1083 error_report("Error while reading offset %" PRId64
1084 " of %s: %s", sectors_to_bytes(sector_num
),
1085 filename2
, strerror(-ret
));
1089 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1090 if (ret
|| pnum
!= nb_sectors
) {
1091 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1093 ret
? sector_num
: sector_num
+ pnum
));
1101 qprintf(quiet
, "Strict mode: Offset %" PRId64
1102 " allocation mismatch!\n",
1103 sectors_to_bytes(sector_num
));
1108 ret
= check_empty_sectors(bs1
, sector_num
, nb_sectors
,
1109 filename1
, buf1
, quiet
);
1111 ret
= check_empty_sectors(bs2
, sector_num
, nb_sectors
,
1112 filename2
, buf1
, quiet
);
1116 error_report("Error while reading offset %" PRId64
": %s",
1117 sectors_to_bytes(sector_num
), strerror(-ret
));
1123 sector_num
+= nb_sectors
;
1124 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1127 if (total_sectors1
!= total_sectors2
) {
1128 BlockDriverState
*bs_over
;
1129 int64_t total_sectors_over
;
1130 const char *filename_over
;
1132 qprintf(quiet
, "Warning: Image size mismatch!\n");
1133 if (total_sectors1
> total_sectors2
) {
1134 total_sectors_over
= total_sectors1
;
1136 filename_over
= filename1
;
1138 total_sectors_over
= total_sectors2
;
1140 filename_over
= filename2
;
1144 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1145 if (nb_sectors
<= 0) {
1148 ret
= bdrv_is_allocated_above(bs_over
, NULL
, sector_num
,
1152 error_report("Sector allocation test failed for %s",
1159 ret
= check_empty_sectors(bs_over
, sector_num
, nb_sectors
,
1160 filename_over
, buf1
, quiet
);
1163 error_report("Error while reading offset %" PRId64
1164 " of %s: %s", sectors_to_bytes(sector_num
),
1165 filename_over
, strerror(-ret
));
1171 sector_num
+= nb_sectors
;
1172 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1176 qprintf(quiet
, "Images are identical.\n");
1186 qemu_progress_end();
1190 static int img_convert(int argc
, char **argv
)
1192 int c
, n
, n1
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1194 int progress
= 0, flags
;
1195 const char *fmt
, *out_fmt
, *cache
, *out_baseimg
, *out_filename
;
1196 BlockDriver
*drv
, *proto_drv
;
1197 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1198 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
1199 int64_t *bs_sectors
= NULL
;
1200 uint8_t * buf
= NULL
;
1201 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1202 const uint8_t *buf1
;
1203 BlockDriverInfo bdi
;
1204 QemuOpts
*opts
= NULL
;
1205 QemuOptsList
*create_opts
= NULL
;
1206 const char *out_baseimg_param
;
1207 char *options
= NULL
;
1208 const char *snapshot_name
= NULL
;
1209 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1211 Error
*local_err
= NULL
;
1212 QemuOpts
*sn_opts
= NULL
;
1221 c
= getopt(argc
, argv
, "f:O:B:s:hce6o:pS:t:qnl:");
1237 out_baseimg
= optarg
;
1243 error_report("option -e is deprecated, please use \'-o "
1244 "encryption\' instead!");
1248 error_report("option -6 is deprecated, please use \'-o "
1249 "compat6\' instead!");
1253 if (!is_valid_option_list(optarg
)) {
1254 error_report("Invalid option list: %s", optarg
);
1259 options
= g_strdup(optarg
);
1261 char *old_options
= options
;
1262 options
= g_strdup_printf("%s,%s", options
, optarg
);
1263 g_free(old_options
);
1267 snapshot_name
= optarg
;
1270 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1271 sn_opts
= qemu_opts_parse(&internal_snapshot_opts
, optarg
, 0);
1273 error_report("Failed in parsing snapshot param '%s'",
1279 snapshot_name
= optarg
;
1286 sval
= strtosz_suffix(optarg
, &end
, STRTOSZ_DEFSUFFIX_B
);
1287 if (sval
< 0 || *end
) {
1288 error_report("Invalid minimum zero buffer size for sparse output specified");
1293 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1311 /* Initialize before goto out */
1315 qemu_progress_init(progress
, 1.0);
1318 bs_n
= argc
- optind
- 1;
1319 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1321 if (options
&& has_help_option(options
)) {
1322 ret
= print_block_option_help(out_filename
, out_fmt
);
1327 error_exit("Must specify image file name");
1331 if (bs_n
> 1 && out_baseimg
) {
1332 error_report("-B makes no sense when concatenating multiple input "
1338 qemu_progress_print(0, 100);
1340 bs
= g_new0(BlockDriverState
*, bs_n
);
1341 bs_sectors
= g_new(int64_t, bs_n
);
1344 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1345 char *id
= bs_n
> 1 ? g_strdup_printf("source %d", bs_i
)
1346 : g_strdup("source");
1347 bs
[bs_i
] = bdrv_new_open(id
, argv
[optind
+ bs_i
], fmt
, BDRV_O_FLAGS
,
1351 error_report("Could not open '%s'", argv
[optind
+ bs_i
]);
1355 bs_sectors
[bs_i
] = bdrv_nb_sectors(bs
[bs_i
]);
1356 if (bs_sectors
[bs_i
] < 0) {
1357 error_report("Could not get size of %s: %s",
1358 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1362 total_sectors
+= bs_sectors
[bs_i
];
1366 ret
= bdrv_snapshot_load_tmp(bs
[0],
1367 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1368 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1370 } else if (snapshot_name
!= NULL
) {
1372 error_report("No support for concatenating multiple snapshot");
1377 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1380 error_report("Failed to load snapshot: %s",
1381 error_get_pretty(local_err
));
1382 error_free(local_err
);
1387 /* Find driver and parse its options */
1388 drv
= bdrv_find_format(out_fmt
);
1390 error_report("Unknown file format '%s'", out_fmt
);
1395 proto_drv
= bdrv_find_protocol(out_filename
, true);
1397 error_report("Unknown protocol '%s'", out_filename
);
1402 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1403 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1405 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1406 if (options
&& qemu_opts_do_parse(opts
, options
, NULL
)) {
1407 error_report("Invalid options for file format '%s'", out_fmt
);
1412 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512);
1413 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
1418 /* Get backing file name if -o backing_file was used */
1419 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
1420 if (out_baseimg_param
) {
1421 out_baseimg
= out_baseimg_param
;
1424 /* Check if compression is supported */
1427 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
1428 const char *preallocation
=
1429 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
1431 if (!drv
->bdrv_write_compressed
) {
1432 error_report("Compression not supported for this file format");
1438 error_report("Compression and encryption not supported at "
1445 && strcmp(preallocation
, "off"))
1447 error_report("Compression and preallocation not supported at "
1455 /* Create the new image */
1456 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
1458 error_report("%s: error while converting %s: %s",
1459 out_filename
, out_fmt
, error_get_pretty(local_err
));
1460 error_free(local_err
);
1465 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
1466 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1468 error_report("Invalid cache option: %s", cache
);
1472 out_bs
= bdrv_new_open("target", out_filename
, out_fmt
, flags
, true, quiet
);
1481 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1482 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1484 bufsectors
= MIN(32768,
1485 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
1486 out_bs
->bl
.discard_alignment
))
1489 buf
= qemu_blockalign(out_bs
, bufsectors
* BDRV_SECTOR_SIZE
);
1492 int64_t output_sectors
= bdrv_nb_sectors(out_bs
);
1493 if (output_sectors
< 0) {
1494 error_report("unable to get output image length: %s\n",
1495 strerror(-output_sectors
));
1498 } else if (output_sectors
< total_sectors
) {
1499 error_report("output file is smaller than input file");
1505 cluster_sectors
= 0;
1506 ret
= bdrv_get_info(out_bs
, &bdi
);
1509 error_report("could not get block driver info");
1513 compress
= compress
|| bdi
.needs_compressed_writes
;
1514 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
1518 if (cluster_sectors
<= 0 || cluster_sectors
> bufsectors
) {
1519 error_report("invalid cluster size");
1525 nb_sectors
= total_sectors
;
1532 nb_sectors
= total_sectors
- sector_num
;
1533 if (nb_sectors
<= 0)
1535 if (nb_sectors
>= cluster_sectors
)
1536 n
= cluster_sectors
;
1540 bs_num
= sector_num
- bs_offset
;
1541 assert (bs_num
>= 0);
1544 while (remainder
> 0) {
1546 while (bs_num
== bs_sectors
[bs_i
]) {
1547 bs_offset
+= bs_sectors
[bs_i
];
1549 assert (bs_i
< bs_n
);
1551 /* printf("changing part: sector_num=%" PRId64 ", "
1552 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1553 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1555 assert (bs_num
< bs_sectors
[bs_i
]);
1557 nlow
= remainder
> bs_sectors
[bs_i
] - bs_num
1558 ? bs_sectors
[bs_i
] - bs_num
: remainder
;
1560 ret
= bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
);
1562 error_report("error while reading sector %" PRId64
": %s",
1563 bs_num
, strerror(-ret
));
1572 assert (remainder
== 0);
1574 if (!buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)) {
1575 ret
= bdrv_write_compressed(out_bs
, sector_num
, buf
, n
);
1577 error_report("error while compressing sector %" PRId64
1578 ": %s", sector_num
, strerror(-ret
));
1583 qemu_progress_print(100.0 * sector_num
/ total_sectors
, 0);
1585 /* signal EOF to align */
1586 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
1588 int64_t sectors_to_read
, sectors_read
, sector_num_next_status
;
1589 bool count_allocated_sectors
;
1590 int has_zero_init
= min_sparse
? bdrv_has_zero_init(out_bs
) : 0;
1592 if (!has_zero_init
&& bdrv_can_write_zeroes_with_unmap(out_bs
)) {
1593 ret
= bdrv_make_zero(out_bs
, BDRV_REQ_MAY_UNMAP
);
1600 sectors_to_read
= total_sectors
;
1601 count_allocated_sectors
= progress
&& (out_baseimg
|| has_zero_init
);
1603 sector_num
= 0; // total number of sectors converted so far
1605 sector_num_next_status
= 0;
1608 nb_sectors
= total_sectors
- sector_num
;
1609 if (nb_sectors
<= 0) {
1610 if (count_allocated_sectors
) {
1611 sectors_to_read
= sectors_read
;
1612 count_allocated_sectors
= false;
1619 while (sector_num
- bs_offset
>= bs_sectors
[bs_i
]) {
1620 bs_offset
+= bs_sectors
[bs_i
];
1622 assert (bs_i
< bs_n
);
1623 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1624 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1625 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1628 if ((out_baseimg
|| has_zero_init
) &&
1629 sector_num
>= sector_num_next_status
) {
1630 n
= nb_sectors
> INT_MAX
? INT_MAX
: nb_sectors
;
1631 ret
= bdrv_get_block_status(bs
[bs_i
], sector_num
- bs_offset
,
1634 error_report("error while reading block status of sector %"
1635 PRId64
": %s", sector_num
- bs_offset
,
1639 /* If the output image is zero initialized, we are not working
1640 * on a shared base and the input is zero we can skip the next
1642 if (has_zero_init
&& !out_baseimg
&& (ret
& BDRV_BLOCK_ZERO
)) {
1646 /* If the output image is being created as a copy on write
1647 * image, assume that sectors which are unallocated in the
1648 * input image are present in both the output's and input's
1649 * base images (no need to copy them). */
1651 if (!(ret
& BDRV_BLOCK_DATA
)) {
1655 /* The next 'n1' sectors are allocated in the input image.
1656 * Copy only those as they may be followed by unallocated
1660 /* avoid redundant callouts to get_block_status */
1661 sector_num_next_status
= sector_num
+ n1
;
1664 n
= MIN(nb_sectors
, bufsectors
);
1666 /* round down request length to an aligned sector, but
1667 * do not bother doing this on short requests. They happen
1668 * when we found an all-zero area, and the next sector to
1669 * write will not be sector_num + n. */
1670 if (cluster_sectors
> 0 && n
>= cluster_sectors
) {
1671 int64_t next_aligned_sector
= (sector_num
+ n
);
1672 next_aligned_sector
-= next_aligned_sector
% cluster_sectors
;
1673 if (sector_num
+ n
> next_aligned_sector
) {
1674 n
= next_aligned_sector
- sector_num
;
1678 n
= MIN(n
, bs_sectors
[bs_i
] - (sector_num
- bs_offset
));
1681 if (count_allocated_sectors
) {
1687 ret
= bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
);
1689 error_report("error while reading sector %" PRId64
": %s",
1690 sector_num
- bs_offset
, strerror(-ret
));
1693 /* NOTE: at the same time we convert, we do not write zero
1694 sectors to have a chance to compress the image. Ideally, we
1695 should add a specific call to have the info to go faster */
1698 if (!has_zero_init
||
1699 is_allocated_sectors_min(buf1
, n
, &n1
, min_sparse
)) {
1700 ret
= bdrv_write(out_bs
, sector_num
, buf1
, n1
);
1702 error_report("error while writing sector %" PRId64
1703 ": %s", sector_num
, strerror(-ret
));
1711 qemu_progress_print(100.0 * sectors_read
/ sectors_to_read
, 0);
1716 qemu_progress_print(100, 0);
1718 qemu_progress_end();
1719 qemu_opts_del(opts
);
1720 qemu_opts_free(create_opts
);
1723 qemu_opts_del(sn_opts
);
1729 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1731 bdrv_unref(bs
[bs_i
]);
1747 static void dump_snapshots(BlockDriverState
*bs
)
1749 QEMUSnapshotInfo
*sn_tab
, *sn
;
1752 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
1755 printf("Snapshot list:\n");
1756 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
1758 for(i
= 0; i
< nb_sns
; i
++) {
1760 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
1766 static void dump_json_image_info_list(ImageInfoList
*list
)
1768 Error
*local_err
= NULL
;
1770 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1772 visit_type_ImageInfoList(qmp_output_get_visitor(ov
),
1773 &list
, NULL
, &local_err
);
1774 obj
= qmp_output_get_qobject(ov
);
1775 str
= qobject_to_json_pretty(obj
);
1776 assert(str
!= NULL
);
1777 printf("%s\n", qstring_get_str(str
));
1778 qobject_decref(obj
);
1779 qmp_output_visitor_cleanup(ov
);
1783 static void dump_json_image_info(ImageInfo
*info
)
1785 Error
*local_err
= NULL
;
1787 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1789 visit_type_ImageInfo(qmp_output_get_visitor(ov
),
1790 &info
, 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_human_image_info_list(ImageInfoList
*list
)
1802 ImageInfoList
*elem
;
1805 for (elem
= list
; elem
; elem
= elem
->next
) {
1811 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
1815 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
1817 return strcmp(a
, b
) == 0;
1821 * Open an image file chain and return an ImageInfoList
1823 * @filename: topmost image filename
1824 * @fmt: topmost image format (may be NULL to autodetect)
1825 * @chain: true - enumerate entire backing file chain
1826 * false - only topmost image file
1828 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1829 * image file. If there was an error a message will have been printed to
1832 static ImageInfoList
*collect_image_info_list(const char *filename
,
1836 ImageInfoList
*head
= NULL
;
1837 ImageInfoList
**last
= &head
;
1838 GHashTable
*filenames
;
1841 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
1844 BlockDriverState
*bs
;
1846 ImageInfoList
*elem
;
1848 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
1849 error_report("Backing file '%s' creates an infinite loop.",
1853 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
1855 bs
= bdrv_new_open("image", filename
, fmt
,
1856 BDRV_O_FLAGS
| BDRV_O_NO_BACKING
, false, false);
1861 bdrv_query_image_info(bs
, &info
, &err
);
1863 error_report("%s", error_get_pretty(err
));
1869 elem
= g_new0(ImageInfoList
, 1);
1876 filename
= fmt
= NULL
;
1878 if (info
->has_full_backing_filename
) {
1879 filename
= info
->full_backing_filename
;
1880 } else if (info
->has_backing_filename
) {
1881 filename
= info
->backing_filename
;
1883 if (info
->has_backing_filename_format
) {
1884 fmt
= info
->backing_filename_format
;
1888 g_hash_table_destroy(filenames
);
1892 qapi_free_ImageInfoList(head
);
1893 g_hash_table_destroy(filenames
);
1897 static int img_info(int argc
, char **argv
)
1900 OutputFormat output_format
= OFORMAT_HUMAN
;
1902 const char *filename
, *fmt
, *output
;
1903 ImageInfoList
*list
;
1908 int option_index
= 0;
1909 static const struct option long_options
[] = {
1910 {"help", no_argument
, 0, 'h'},
1911 {"format", required_argument
, 0, 'f'},
1912 {"output", required_argument
, 0, OPTION_OUTPUT
},
1913 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
1916 c
= getopt_long(argc
, argv
, "f:h",
1917 long_options
, &option_index
);
1932 case OPTION_BACKING_CHAIN
:
1937 if (optind
!= argc
- 1) {
1938 error_exit("Expecting one image file name");
1940 filename
= argv
[optind
++];
1942 if (output
&& !strcmp(output
, "json")) {
1943 output_format
= OFORMAT_JSON
;
1944 } else if (output
&& !strcmp(output
, "human")) {
1945 output_format
= OFORMAT_HUMAN
;
1946 } else if (output
) {
1947 error_report("--output must be used with human or json as argument.");
1951 list
= collect_image_info_list(filename
, fmt
, chain
);
1956 switch (output_format
) {
1958 dump_human_image_info_list(list
);
1962 dump_json_image_info_list(list
);
1964 dump_json_image_info(list
->value
);
1969 qapi_free_ImageInfoList(list
);
1973 static int img_update(int argc
, char **argv
)
1976 const char *filename
, *fmt
;
1977 BlockDriverState
*bs
;
1981 c
= getopt(argc
, argv
, "f:h");
1996 filename
= argv
[optind
++];
1998 bs
= bdrv_new_open("image", filename
, fmt
,
1999 BDRV_O_FLAGS
| BDRV_O_NO_BACKING
| BDRV_O_RDWR
,
2005 if (bs
->drv
->bdrv_update
==NULL
) {
2006 error_report("the 'update' command is not supported for the "
2007 "'%s' image format.", bdrv_get_format_name(bs
));
2010 bs
->drv
->bdrv_update(bs
, argc
-optind
, &argv
[optind
]);
2016 typedef struct MapEntry
{
2022 BlockDriverState
*bs
;
2025 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2028 switch (output_format
) {
2030 if ((e
->flags
& BDRV_BLOCK_DATA
) &&
2031 !(e
->flags
& BDRV_BLOCK_OFFSET_VALID
)) {
2032 error_report("File contains external, encrypted or compressed clusters.");
2035 if ((e
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) == BDRV_BLOCK_DATA
) {
2036 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2037 e
->start
, e
->length
, e
->offset
, e
->bs
->filename
);
2039 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2040 * Modify the flags here to allow more coalescing.
2043 (next
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) != BDRV_BLOCK_DATA
) {
2044 next
->flags
&= ~BDRV_BLOCK_DATA
;
2045 next
->flags
|= BDRV_BLOCK_ZERO
;
2049 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
", \"depth\": %d,"
2050 " \"zero\": %s, \"data\": %s",
2051 (e
->start
== 0 ? "[" : ",\n"),
2052 e
->start
, e
->length
, e
->depth
,
2053 (e
->flags
& BDRV_BLOCK_ZERO
) ? "true" : "false",
2054 (e
->flags
& BDRV_BLOCK_DATA
) ? "true" : "false");
2055 if (e
->flags
& BDRV_BLOCK_OFFSET_VALID
) {
2056 printf(", \"offset\": %"PRId64
"", e
->offset
);
2067 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2068 int nb_sectors
, MapEntry
*e
)
2073 /* As an optimization, we could cache the current range of unallocated
2074 * clusters in each file of the chain, and avoid querying the same
2080 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
);
2085 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2088 bs
= bs
->backing_hd
;
2097 e
->start
= sector_num
* BDRV_SECTOR_SIZE
;
2098 e
->length
= nb_sectors
* BDRV_SECTOR_SIZE
;
2099 e
->flags
= ret
& ~BDRV_BLOCK_OFFSET_MASK
;
2100 e
->offset
= ret
& BDRV_BLOCK_OFFSET_MASK
;
2106 static int img_map(int argc
, char **argv
)
2109 OutputFormat output_format
= OFORMAT_HUMAN
;
2110 BlockDriverState
*bs
;
2111 const char *filename
, *fmt
, *output
;
2113 MapEntry curr
= { .length
= 0 }, next
;
2119 int option_index
= 0;
2120 static const struct option long_options
[] = {
2121 {"help", no_argument
, 0, 'h'},
2122 {"format", required_argument
, 0, 'f'},
2123 {"output", required_argument
, 0, OPTION_OUTPUT
},
2126 c
= getopt_long(argc
, argv
, "f:h",
2127 long_options
, &option_index
);
2144 if (optind
!= argc
- 1) {
2145 error_exit("Expecting one image file name");
2147 filename
= argv
[optind
];
2149 if (output
&& !strcmp(output
, "json")) {
2150 output_format
= OFORMAT_JSON
;
2151 } else if (output
&& !strcmp(output
, "human")) {
2152 output_format
= OFORMAT_HUMAN
;
2153 } else if (output
) {
2154 error_report("--output must be used with human or json as argument.");
2158 bs
= bdrv_new_open("image", filename
, fmt
, BDRV_O_FLAGS
, true, false);
2163 if (output_format
== OFORMAT_HUMAN
) {
2164 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2167 length
= bdrv_getlength(bs
);
2168 while (curr
.start
+ curr
.length
< length
) {
2169 int64_t nsectors_left
;
2173 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2175 /* Probe up to 1 GiB at a time. */
2176 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2177 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2178 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2181 error_report("Could not read file metadata: %s", strerror(-ret
));
2185 if (curr
.length
!= 0 && curr
.flags
== next
.flags
&&
2186 curr
.depth
== next
.depth
&&
2187 ((curr
.flags
& BDRV_BLOCK_OFFSET_VALID
) == 0 ||
2188 curr
.offset
+ curr
.length
== next
.offset
)) {
2189 curr
.length
+= next
.length
;
2193 if (curr
.length
> 0) {
2194 dump_map_entry(output_format
, &curr
, &next
);
2199 dump_map_entry(output_format
, &curr
, NULL
);
2206 #define SNAPSHOT_LIST 1
2207 #define SNAPSHOT_CREATE 2
2208 #define SNAPSHOT_APPLY 3
2209 #define SNAPSHOT_DELETE 4
2211 static int img_snapshot(int argc
, char **argv
)
2213 BlockDriverState
*bs
;
2214 QEMUSnapshotInfo sn
;
2215 char *filename
, *snapshot_name
= NULL
;
2216 int c
, ret
= 0, bdrv_oflags
;
2222 bdrv_oflags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2223 /* Parse commandline parameters */
2225 c
= getopt(argc
, argv
, "la:c:d:hq");
2236 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2239 action
= SNAPSHOT_LIST
;
2240 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2244 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2247 action
= SNAPSHOT_APPLY
;
2248 snapshot_name
= optarg
;
2252 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2255 action
= SNAPSHOT_CREATE
;
2256 snapshot_name
= optarg
;
2260 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2263 action
= SNAPSHOT_DELETE
;
2264 snapshot_name
= optarg
;
2272 if (optind
!= argc
- 1) {
2273 error_exit("Expecting one image file name");
2275 filename
= argv
[optind
++];
2277 /* Open the image */
2278 bs
= bdrv_new_open("image", filename
, NULL
, bdrv_oflags
, true, quiet
);
2283 /* Perform the requested action */
2289 case SNAPSHOT_CREATE
:
2290 memset(&sn
, 0, sizeof(sn
));
2291 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2293 qemu_gettimeofday(&tv
);
2294 sn
.date_sec
= tv
.tv_sec
;
2295 sn
.date_nsec
= tv
.tv_usec
* 1000;
2297 ret
= bdrv_snapshot_create(bs
, &sn
);
2299 error_report("Could not create snapshot '%s': %d (%s)",
2300 snapshot_name
, ret
, strerror(-ret
));
2304 case SNAPSHOT_APPLY
:
2305 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2307 error_report("Could not apply snapshot '%s': %d (%s)",
2308 snapshot_name
, ret
, strerror(-ret
));
2312 case SNAPSHOT_DELETE
:
2313 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2315 error_report("Could not delete snapshot '%s': (%s)",
2316 snapshot_name
, error_get_pretty(err
));
2331 static int img_rebase(int argc
, char **argv
)
2333 BlockDriverState
*bs
, *bs_old_backing
= NULL
, *bs_new_backing
= NULL
;
2334 BlockDriver
*old_backing_drv
, *new_backing_drv
;
2336 const char *fmt
, *cache
, *out_basefmt
, *out_baseimg
;
2341 Error
*local_err
= NULL
;
2343 /* Parse commandline parameters */
2345 cache
= BDRV_DEFAULT_CACHE
;
2349 c
= getopt(argc
, argv
, "uhf:F:b:pt:q");
2362 out_basefmt
= optarg
;
2365 out_baseimg
= optarg
;
2386 if (optind
!= argc
- 1) {
2387 error_exit("Expecting one image file name");
2389 if (!unsafe
&& !out_baseimg
) {
2390 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2392 filename
= argv
[optind
++];
2394 qemu_progress_init(progress
, 2.0);
2395 qemu_progress_print(0, 100);
2397 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2398 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2400 error_report("Invalid cache option: %s", cache
);
2407 * Ignore the old backing file for unsafe rebase in case we want to correct
2408 * the reference to a renamed or moved backing file.
2410 bs
= bdrv_new_open("image", filename
, fmt
, flags
, true, quiet
);
2415 /* Find the right drivers for the backing files */
2416 old_backing_drv
= NULL
;
2417 new_backing_drv
= NULL
;
2419 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
2420 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
2421 if (old_backing_drv
== NULL
) {
2422 error_report("Invalid format name: '%s'", bs
->backing_format
);
2428 if (out_basefmt
!= NULL
) {
2429 new_backing_drv
= bdrv_find_format(out_basefmt
);
2430 if (new_backing_drv
== NULL
) {
2431 error_report("Invalid format name: '%s'", out_basefmt
);
2437 /* For safe rebasing we need to compare old and new backing file */
2439 /* Make the compiler happy */
2440 bs_old_backing
= NULL
;
2441 bs_new_backing
= NULL
;
2443 char backing_name
[1024];
2445 bs_old_backing
= bdrv_new("old_backing", &error_abort
);
2446 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2447 ret
= bdrv_open(&bs_old_backing
, backing_name
, NULL
, NULL
, BDRV_O_FLAGS
,
2448 old_backing_drv
, &local_err
);
2450 error_report("Could not open old backing file '%s': %s",
2451 backing_name
, error_get_pretty(local_err
));
2452 error_free(local_err
);
2455 if (out_baseimg
[0]) {
2456 bs_new_backing
= bdrv_new("new_backing", &error_abort
);
2457 ret
= bdrv_open(&bs_new_backing
, out_baseimg
, NULL
, NULL
,
2458 BDRV_O_FLAGS
, new_backing_drv
, &local_err
);
2460 error_report("Could not open new backing file '%s': %s",
2461 out_baseimg
, error_get_pretty(local_err
));
2462 error_free(local_err
);
2469 * Check each unallocated cluster in the COW file. If it is unallocated,
2470 * accesses go to the backing file. We must therefore compare this cluster
2471 * in the old and new backing file, and if they differ we need to copy it
2472 * from the old backing file into the COW file.
2474 * If qemu-img crashes during this step, no harm is done. The content of
2475 * the image is the same as the original one at any time.
2478 int64_t num_sectors
;
2479 int64_t old_backing_num_sectors
;
2480 int64_t new_backing_num_sectors
= 0;
2485 float local_progress
= 0;
2487 buf_old
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2488 buf_new
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2490 num_sectors
= bdrv_nb_sectors(bs
);
2491 if (num_sectors
< 0) {
2492 error_report("Could not get size of '%s': %s",
2493 filename
, strerror(-num_sectors
));
2497 old_backing_num_sectors
= bdrv_nb_sectors(bs_old_backing
);
2498 if (old_backing_num_sectors
< 0) {
2499 char backing_name
[1024];
2501 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2502 error_report("Could not get size of '%s': %s",
2503 backing_name
, strerror(-old_backing_num_sectors
));
2507 if (bs_new_backing
) {
2508 new_backing_num_sectors
= bdrv_nb_sectors(bs_new_backing
);
2509 if (new_backing_num_sectors
< 0) {
2510 error_report("Could not get size of '%s': %s",
2511 out_baseimg
, strerror(-new_backing_num_sectors
));
2517 if (num_sectors
!= 0) {
2518 local_progress
= (float)100 /
2519 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
2522 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
2524 /* How many sectors can we handle with the next read? */
2525 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
2526 n
= (IO_BUF_SIZE
/ 512);
2528 n
= num_sectors
- sector
;
2531 /* If the cluster is allocated, we don't need to take action */
2532 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
2534 error_report("error while reading image metadata: %s",
2543 * Read old and new backing file and take into consideration that
2544 * backing files may be smaller than the COW image.
2546 if (sector
>= old_backing_num_sectors
) {
2547 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
2549 if (sector
+ n
> old_backing_num_sectors
) {
2550 n
= old_backing_num_sectors
- sector
;
2553 ret
= bdrv_read(bs_old_backing
, sector
, buf_old
, n
);
2555 error_report("error while reading from old backing file");
2560 if (sector
>= new_backing_num_sectors
|| !bs_new_backing
) {
2561 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
2563 if (sector
+ n
> new_backing_num_sectors
) {
2564 n
= new_backing_num_sectors
- sector
;
2567 ret
= bdrv_read(bs_new_backing
, sector
, buf_new
, n
);
2569 error_report("error while reading from new backing file");
2574 /* If they differ, we need to write to the COW file */
2575 uint64_t written
= 0;
2577 while (written
< n
) {
2580 if (compare_sectors(buf_old
+ written
* 512,
2581 buf_new
+ written
* 512, n
- written
, &pnum
))
2583 ret
= bdrv_write(bs
, sector
+ written
,
2584 buf_old
+ written
* 512, pnum
);
2586 error_report("Error while writing to COW image: %s",
2594 qemu_progress_print(local_progress
, 100);
2597 qemu_vfree(buf_old
);
2598 qemu_vfree(buf_new
);
2602 * Change the backing file. All clusters that are different from the old
2603 * backing file are overwritten in the COW file now, so the visible content
2604 * doesn't change when we switch the backing file.
2606 if (out_baseimg
&& *out_baseimg
) {
2607 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
2609 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
2612 if (ret
== -ENOSPC
) {
2613 error_report("Could not change the backing file to '%s': No "
2614 "space left in the file header", out_baseimg
);
2615 } else if (ret
< 0) {
2616 error_report("Could not change the backing file to '%s': %s",
2617 out_baseimg
, strerror(-ret
));
2620 qemu_progress_print(100, 0);
2622 * TODO At this point it is possible to check if any clusters that are
2623 * allocated in the COW file are the same in the backing file. If so, they
2624 * could be dropped from the COW file. Don't do this before switching the
2625 * backing file, in case of a crash this would lead to corruption.
2628 qemu_progress_end();
2631 if (bs_old_backing
!= NULL
) {
2632 bdrv_unref(bs_old_backing
);
2634 if (bs_new_backing
!= NULL
) {
2635 bdrv_unref(bs_new_backing
);
2646 static int img_resize(int argc
, char **argv
)
2648 int c
, ret
, relative
;
2649 const char *filename
, *fmt
, *size
;
2650 int64_t n
, total_size
;
2652 BlockDriverState
*bs
= NULL
;
2654 static QemuOptsList resize_options
= {
2655 .name
= "resize_options",
2656 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
2659 .name
= BLOCK_OPT_SIZE
,
2660 .type
= QEMU_OPT_SIZE
,
2661 .help
= "Virtual disk size"
2668 /* Remove size from argv manually so that negative numbers are not treated
2669 * as options by getopt. */
2671 error_exit("Not enough arguments");
2675 size
= argv
[--argc
];
2677 /* Parse getopt arguments */
2680 c
= getopt(argc
, argv
, "f:hq");
2697 if (optind
!= argc
- 1) {
2698 error_exit("Expecting one image file name");
2700 filename
= argv
[optind
++];
2702 /* Choose grow, shrink, or absolute resize mode */
2718 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
2719 if (qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
)) {
2720 /* Error message already printed when size parsing fails */
2722 qemu_opts_del(param
);
2725 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
2726 qemu_opts_del(param
);
2728 bs
= bdrv_new_open("image", filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
,
2736 total_size
= bdrv_getlength(bs
) + n
* relative
;
2740 if (total_size
<= 0) {
2741 error_report("New image size must be positive");
2746 ret
= bdrv_truncate(bs
, total_size
);
2749 qprintf(quiet
, "Image resized.\n");
2752 error_report("This image does not support resize");
2755 error_report("Image is read-only");
2758 error_report("Error resizing image (%d)", -ret
);
2771 static int img_amend(int argc
, char **argv
)
2774 char *options
= NULL
;
2775 QemuOptsList
*create_opts
= NULL
;
2776 QemuOpts
*opts
= NULL
;
2777 const char *fmt
= NULL
, *filename
;
2779 BlockDriverState
*bs
= NULL
;
2782 c
= getopt(argc
, argv
, "hqf:o:");
2793 if (!is_valid_option_list(optarg
)) {
2794 error_report("Invalid option list: %s", optarg
);
2799 options
= g_strdup(optarg
);
2801 char *old_options
= options
;
2802 options
= g_strdup_printf("%s,%s", options
, optarg
);
2803 g_free(old_options
);
2816 error_exit("Must specify options (-o)");
2819 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
2820 if (fmt
&& has_help_option(options
)) {
2821 /* If a format is explicitly specified (and possibly no filename is
2822 * given), print option help here */
2823 ret
= print_block_option_help(filename
, fmt
);
2827 if (optind
!= argc
- 1) {
2828 error_exit("Expecting one image file name");
2831 bs
= bdrv_new_open("image", filename
, fmt
,
2832 BDRV_O_FLAGS
| BDRV_O_RDWR
, true, quiet
);
2834 error_report("Could not open image '%s'", filename
);
2839 fmt
= bs
->drv
->format_name
;
2841 if (has_help_option(options
)) {
2842 /* If the format was auto-detected, print option help here */
2843 ret
= print_block_option_help(filename
, fmt
);
2847 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
2848 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2849 if (options
&& qemu_opts_do_parse(opts
, options
, NULL
)) {
2850 error_report("Invalid options for file format '%s'", fmt
);
2855 ret
= bdrv_amend_options(bs
, opts
);
2857 error_report("Error while amending options: %s", strerror(-ret
));
2865 qemu_opts_del(opts
);
2866 qemu_opts_free(create_opts
);
2875 static const img_cmd_t img_cmds
[] = {
2876 #define DEF(option, callback, arg_string) \
2877 { option, callback },
2878 #include "qemu-img-cmds.h"
2884 int main(int argc
, char **argv
)
2886 const img_cmd_t
*cmd
;
2887 const char *cmdname
;
2889 static const struct option long_options
[] = {
2890 {"help", no_argument
, 0, 'h'},
2891 {"version", no_argument
, 0, 'v'},
2896 signal(SIGPIPE
, SIG_IGN
);
2899 error_set_progname(argv
[0]);
2900 qemu_init_exec_dir(argv
[0]);
2902 qemu_init_main_loop();
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
);