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"
42 typedef struct img_cmd_t
{
44 int (*handler
)(int argc
, char **argv
);
49 OPTION_BACKING_CHAIN
= 257,
52 typedef enum OutputFormat
{
57 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
58 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
59 #define BDRV_DEFAULT_CACHE "writeback"
61 static void format_print(void *opaque
, const char *name
)
66 /* Please keep in synch with qemu-img.texi */
67 static void QEMU_NORETURN
help(void)
69 const char *help_msg
=
70 "qemu-img version " QEMU_VERSION
", Copyright (c) 2004-2008 Fabrice Bellard\n"
71 "usage: qemu-img command [command options]\n"
72 "QEMU disk image utility\n"
75 #define DEF(option, callback, arg_string) \
77 #include "qemu-img-cmds.h"
81 "Command parameters:\n"
82 " 'filename' is a disk image filename\n"
83 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
84 " 'cache' is the cache mode used to write the output disk image, the valid\n"
85 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
86 " 'directsync' and 'unsafe' (default for convert)\n"
87 " 'size' is the disk image size in bytes. Optional suffixes\n"
88 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
89 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
90 " supported. 'b' is ignored.\n"
91 " 'output_filename' is the destination disk image filename\n"
92 " 'output_fmt' is the destination format\n"
93 " 'options' is a comma separated list of format specific options in a\n"
94 " name=value format. Use -o ? for an overview of the options supported by the\n"
96 " 'snapshot_param' is param used for internal snapshot, format\n"
97 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
99 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
101 " '-c' indicates that target image must be compressed (qcow format only)\n"
102 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
103 " match exactly. The image doesn't need a working backing file before\n"
104 " rebasing in this case (useful for renaming the backing file)\n"
105 " '-h' with or without a command shows this help and lists the supported formats\n"
106 " '-p' show progress of command (only certain commands)\n"
107 " '-q' use Quiet mode - do not print any output (except errors)\n"
108 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
109 " contain only zeros for qemu-img to create a sparse image during\n"
110 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
111 " unallocated or zero sectors, and the destination image will always be\n"
113 " '--output' takes the format in which the output must be done (human or json)\n"
114 " '-n' skips the target volume creation (useful if the volume is created\n"
115 " prior to running qemu-img)\n"
117 "Parameters to check subcommand:\n"
118 " '-r' tries to repair any inconsistencies that are found during the check.\n"
119 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
120 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
121 " hiding corruption that has already occurred.\n"
123 "Parameters to snapshot subcommand:\n"
124 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
125 " '-a' applies a snapshot (revert disk to saved state)\n"
126 " '-c' creates a snapshot\n"
127 " '-d' deletes a snapshot\n"
128 " '-l' lists all snapshots in the given image\n"
130 "Parameters to compare subcommand:\n"
131 " '-f' first image format\n"
132 " '-F' second image format\n"
133 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
135 printf("%s\nSupported formats:", help_msg
);
136 bdrv_iterate_format(format_print
, NULL
);
141 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
147 ret
= vprintf(fmt
, args
);
154 /* XXX: put correct support for win32 */
155 static int read_password(char *buf
, int buf_size
)
158 printf("Password: ");
165 if (i
< (buf_size
- 1))
176 static struct termios oldtty
;
178 static void term_exit(void)
180 tcsetattr (0, TCSANOW
, &oldtty
);
183 static void term_init(void)
190 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
191 |INLCR
|IGNCR
|ICRNL
|IXON
);
192 tty
.c_oflag
|= OPOST
;
193 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
194 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
199 tcsetattr (0, TCSANOW
, &tty
);
204 static int read_password(char *buf
, int buf_size
)
209 printf("password: ");
214 ret
= read(0, &ch
, 1);
216 if (errno
== EAGAIN
|| errno
== EINTR
) {
222 } else if (ret
== 0) {
230 if (i
< (buf_size
- 1))
241 static int print_block_option_help(const char *filename
, const char *fmt
)
243 BlockDriver
*drv
, *proto_drv
;
244 QEMUOptionParameter
*create_options
= NULL
;
246 /* Find driver and parse its options */
247 drv
= bdrv_find_format(fmt
);
249 error_report("Unknown file format '%s'", fmt
);
253 proto_drv
= bdrv_find_protocol(filename
, true);
255 error_report("Unknown protocol '%s'", filename
);
259 create_options
= append_option_parameters(create_options
,
260 drv
->create_options
);
261 create_options
= append_option_parameters(create_options
,
262 proto_drv
->create_options
);
263 print_option_help(create_options
);
264 free_option_parameters(create_options
);
268 static BlockDriverState
*bdrv_new_open(const char *filename
,
274 BlockDriverState
*bs
;
277 Error
*local_err
= NULL
;
280 bs
= bdrv_new("image");
283 drv
= bdrv_find_format(fmt
);
285 error_report("Unknown file format '%s'", fmt
);
292 ret
= bdrv_open(bs
, filename
, NULL
, flags
, drv
, &local_err
);
294 error_report("Could not open '%s': %s", filename
,
295 error_get_pretty(local_err
));
296 error_free(local_err
);
300 if (bdrv_is_encrypted(bs
) && require_io
) {
301 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
302 if (read_password(password
, sizeof(password
)) < 0) {
303 error_report("No password given");
306 if (bdrv_set_key(bs
, password
) < 0) {
307 error_report("invalid password");
319 static int add_old_style_options(const char *fmt
, QEMUOptionParameter
*list
,
320 const char *base_filename
,
321 const char *base_fmt
)
324 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FILE
, base_filename
)) {
325 error_report("Backing file not supported for file format '%s'",
331 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
332 error_report("Backing file format not supported for file "
340 static int img_create(int argc
, char **argv
)
343 uint64_t img_size
= -1;
344 const char *fmt
= "raw";
345 const char *base_fmt
= NULL
;
346 const char *filename
;
347 const char *base_filename
= NULL
;
348 char *options
= NULL
;
349 Error
*local_err
= NULL
;
353 c
= getopt(argc
, argv
, "F:b:f:he6o:q");
366 base_filename
= optarg
;
372 error_report("option -e is deprecated, please use \'-o "
373 "encryption\' instead!");
376 error_report("option -6 is deprecated, please use \'-o "
377 "compat6\' instead!");
388 /* Get the filename */
389 if (optind
>= argc
) {
392 filename
= argv
[optind
++];
394 /* Get image size, if specified */
398 sval
= strtosz_suffix(argv
[optind
++], &end
, STRTOSZ_DEFSUFFIX_B
);
399 if (sval
< 0 || *end
) {
400 if (sval
== -ERANGE
) {
401 error_report("Image size must be less than 8 EiB!");
403 error_report("Invalid image size specified! You may use k, M, "
404 "G, T, P or E suffixes for ");
405 error_report("kilobytes, megabytes, gigabytes, terabytes, "
406 "petabytes and exabytes.");
410 img_size
= (uint64_t)sval
;
412 if (optind
!= argc
) {
416 if (options
&& is_help_option(options
)) {
417 return print_block_option_help(filename
, fmt
);
420 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
421 options
, img_size
, BDRV_O_FLAGS
, &local_err
, quiet
);
422 if (error_is_set(&local_err
)) {
423 error_report("%s: %s", filename
, error_get_pretty(local_err
));
424 error_free(local_err
);
431 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
435 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
437 visit_type_ImageCheck(qmp_output_get_visitor(ov
),
438 &check
, NULL
, &errp
);
439 obj
= qmp_output_get_qobject(ov
);
440 str
= qobject_to_json_pretty(obj
);
442 qprintf(quiet
, "%s\n", qstring_get_str(str
));
444 qmp_output_visitor_cleanup(ov
);
448 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
450 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
451 qprintf(quiet
, "No errors were found on the image.\n");
453 if (check
->corruptions
) {
454 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
455 "Data may be corrupted, or further writes to the image "
462 "\n%" PRId64
" leaked clusters were found on the image.\n"
463 "This means waste of disk space, but no harm to data.\n",
467 if (check
->check_errors
) {
470 " internal errors have occurred during the check.\n",
471 check
->check_errors
);
475 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
476 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
477 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
478 check
->allocated_clusters
, check
->total_clusters
,
479 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
480 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
481 check
->compressed_clusters
* 100.0 /
482 check
->allocated_clusters
);
485 if (check
->image_end_offset
) {
487 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
491 static int collect_image_check(BlockDriverState
*bs
,
493 const char *filename
,
498 BdrvCheckResult result
;
500 ret
= bdrv_check(bs
, &result
, fix
);
505 check
->filename
= g_strdup(filename
);
506 check
->format
= g_strdup(bdrv_get_format_name(bs
));
507 check
->check_errors
= result
.check_errors
;
508 check
->corruptions
= result
.corruptions
;
509 check
->has_corruptions
= result
.corruptions
!= 0;
510 check
->leaks
= result
.leaks
;
511 check
->has_leaks
= result
.leaks
!= 0;
512 check
->corruptions_fixed
= result
.corruptions_fixed
;
513 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
514 check
->leaks_fixed
= result
.leaks_fixed
;
515 check
->has_leaks_fixed
= result
.leaks
!= 0;
516 check
->image_end_offset
= result
.image_end_offset
;
517 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
518 check
->total_clusters
= result
.bfi
.total_clusters
;
519 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
520 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
521 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
522 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
523 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
524 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
525 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
531 * Checks an image for consistency. Exit codes:
533 * 0 - Check completed, image is good
534 * 1 - Check not completed because of internal errors
535 * 2 - Check completed, image is corrupted
536 * 3 - Check completed, image has leaked clusters, but is good otherwise
538 static int img_check(int argc
, char **argv
)
541 OutputFormat output_format
= OFORMAT_HUMAN
;
542 const char *filename
, *fmt
, *output
;
543 BlockDriverState
*bs
;
545 int flags
= BDRV_O_FLAGS
| BDRV_O_CHECK
;
552 int option_index
= 0;
553 static const struct option long_options
[] = {
554 {"help", no_argument
, 0, 'h'},
555 {"format", required_argument
, 0, 'f'},
556 {"repair", no_argument
, 0, 'r'},
557 {"output", required_argument
, 0, OPTION_OUTPUT
},
560 c
= getopt_long(argc
, argv
, "f:hr:q",
561 long_options
, &option_index
);
574 flags
|= BDRV_O_RDWR
;
576 if (!strcmp(optarg
, "leaks")) {
577 fix
= BDRV_FIX_LEAKS
;
578 } else if (!strcmp(optarg
, "all")) {
579 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
592 if (optind
!= argc
- 1) {
595 filename
= argv
[optind
++];
597 if (output
&& !strcmp(output
, "json")) {
598 output_format
= OFORMAT_JSON
;
599 } else if (output
&& !strcmp(output
, "human")) {
600 output_format
= OFORMAT_HUMAN
;
602 error_report("--output must be used with human or json as argument.");
606 bs
= bdrv_new_open(filename
, fmt
, flags
, true, quiet
);
611 check
= g_new0(ImageCheck
, 1);
612 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
614 if (ret
== -ENOTSUP
) {
615 if (output_format
== OFORMAT_HUMAN
) {
616 error_report("This image format does not support checks");
622 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
623 int corruptions_fixed
, leaks_fixed
;
625 leaks_fixed
= check
->leaks_fixed
;
626 corruptions_fixed
= check
->corruptions_fixed
;
628 if (output_format
== OFORMAT_HUMAN
) {
630 "The following inconsistencies were found and repaired:\n\n"
631 " %" PRId64
" leaked clusters\n"
632 " %" PRId64
" corruptions\n\n"
633 "Double checking the fixed image now...\n",
635 check
->corruptions_fixed
);
638 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
640 check
->leaks_fixed
= leaks_fixed
;
641 check
->corruptions_fixed
= corruptions_fixed
;
644 switch (output_format
) {
646 dump_human_image_check(check
, quiet
);
649 dump_json_image_check(check
, quiet
);
653 if (ret
|| check
->check_errors
) {
658 if (check
->corruptions
) {
660 } else if (check
->leaks
) {
667 qapi_free_ImageCheck(check
);
673 static int img_commit(int argc
, char **argv
)
676 const char *filename
, *fmt
, *cache
;
677 BlockDriverState
*bs
;
681 cache
= BDRV_DEFAULT_CACHE
;
683 c
= getopt(argc
, argv
, "f:ht:q");
703 if (optind
!= argc
- 1) {
706 filename
= argv
[optind
++];
709 ret
= bdrv_parse_cache_flags(cache
, &flags
);
711 error_report("Invalid cache option: %s", cache
);
715 bs
= bdrv_new_open(filename
, fmt
, flags
, true, quiet
);
719 ret
= bdrv_commit(bs
);
722 qprintf(quiet
, "Image committed.\n");
725 error_report("No disk inserted");
728 error_report("Image is read-only");
731 error_report("Image is already committed");
734 error_report("Error while committing image");
746 * Returns true iff the first sector pointed to by 'buf' contains at least
749 * 'pnum' is set to the number of sectors (including and immediately following
750 * the first one) that are known to be in the same allocated/unallocated state.
752 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
761 is_zero
= buffer_is_zero(buf
, 512);
762 for(i
= 1; i
< n
; i
++) {
764 if (is_zero
!= buffer_is_zero(buf
, 512)) {
773 * Like is_allocated_sectors, but if the buffer starts with a used sector,
774 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
775 * breaking up write requests for only small sparse areas.
777 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
781 int num_checked
, num_used
;
787 ret
= is_allocated_sectors(buf
, n
, pnum
);
793 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
795 num_checked
= num_used
;
798 ret
= is_allocated_sectors(buf
, n
, pnum
);
800 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
802 num_checked
+= *pnum
;
804 num_used
= num_checked
;
805 } else if (*pnum
>= min
) {
815 * Compares two buffers sector by sector. Returns 0 if the first sector of both
816 * buffers matches, non-zero otherwise.
818 * pnum is set to the number of sectors (including and immediately following
819 * the first one) that are known to have the same comparison result
821 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
831 res
= !!memcmp(buf1
, buf2
, 512);
832 for(i
= 1; i
< n
; i
++) {
836 if (!!memcmp(buf1
, buf2
, 512) != res
) {
845 #define IO_BUF_SIZE (2 * 1024 * 1024)
847 static int64_t sectors_to_bytes(int64_t sectors
)
849 return sectors
<< BDRV_SECTOR_BITS
;
852 static int64_t sectors_to_process(int64_t total
, int64_t from
)
854 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
858 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
860 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
861 * data and negative value on error.
863 * @param bs: Driver used for accessing file
864 * @param sect_num: Number of first sector to check
865 * @param sect_count: Number of sectors to check
866 * @param filename: Name of disk file we are checking (logging purpose)
867 * @param buffer: Allocated buffer for storing read data
868 * @param quiet: Flag for quiet mode
870 static int check_empty_sectors(BlockDriverState
*bs
, int64_t sect_num
,
871 int sect_count
, const char *filename
,
872 uint8_t *buffer
, bool quiet
)
875 ret
= bdrv_read(bs
, sect_num
, buffer
, sect_count
);
877 error_report("Error while reading offset %" PRId64
" of %s: %s",
878 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
881 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
882 if (ret
|| pnum
!= sect_count
) {
883 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
884 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
892 * Compares two images. Exit codes:
894 * 0 - Images are identical
896 * >1 - Error occurred
898 static int img_compare(int argc
, char **argv
)
900 const char *fmt1
= NULL
, *fmt2
= NULL
, *filename1
, *filename2
;
901 BlockDriverState
*bs1
, *bs2
;
902 int64_t total_sectors1
, total_sectors2
;
903 uint8_t *buf1
= NULL
, *buf2
= NULL
;
905 int allocated1
, allocated2
;
906 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
907 bool progress
= false, quiet
= false, strict
= false;
908 int64_t total_sectors
;
909 int64_t sector_num
= 0;
913 uint64_t progress_base
;
916 c
= getopt(argc
, argv
, "hpf:F:sq");
943 /* Progress is not shown in Quiet mode */
949 if (optind
!= argc
- 2) {
952 filename1
= argv
[optind
++];
953 filename2
= argv
[optind
++];
955 /* Initialize before goto out */
956 qemu_progress_init(progress
, 2.0);
958 bs1
= bdrv_new_open(filename1
, fmt1
, BDRV_O_FLAGS
, true, quiet
);
960 error_report("Can't open file %s", filename1
);
965 bs2
= bdrv_new_open(filename2
, fmt2
, BDRV_O_FLAGS
, true, quiet
);
967 error_report("Can't open file %s", filename2
);
972 buf1
= qemu_blockalign(bs1
, IO_BUF_SIZE
);
973 buf2
= qemu_blockalign(bs2
, IO_BUF_SIZE
);
974 bdrv_get_geometry(bs1
, &bs_sectors
);
975 total_sectors1
= bs_sectors
;
976 bdrv_get_geometry(bs2
, &bs_sectors
);
977 total_sectors2
= bs_sectors
;
978 total_sectors
= MIN(total_sectors1
, total_sectors2
);
979 progress_base
= MAX(total_sectors1
, total_sectors2
);
981 qemu_progress_print(0, 100);
983 if (strict
&& total_sectors1
!= total_sectors2
) {
985 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
990 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
991 if (nb_sectors
<= 0) {
994 allocated1
= bdrv_is_allocated_above(bs1
, NULL
, sector_num
, nb_sectors
,
996 if (allocated1
< 0) {
998 error_report("Sector allocation test failed for %s", filename1
);
1002 allocated2
= bdrv_is_allocated_above(bs2
, NULL
, sector_num
, nb_sectors
,
1004 if (allocated2
< 0) {
1006 error_report("Sector allocation test failed for %s", filename2
);
1009 nb_sectors
= MIN(pnum1
, pnum2
);
1011 if (allocated1
== allocated2
) {
1013 ret
= bdrv_read(bs1
, sector_num
, buf1
, nb_sectors
);
1015 error_report("Error while reading offset %" PRId64
" of %s:"
1016 " %s", sectors_to_bytes(sector_num
), filename1
,
1021 ret
= bdrv_read(bs2
, sector_num
, buf2
, nb_sectors
);
1023 error_report("Error while reading offset %" PRId64
1024 " of %s: %s", sectors_to_bytes(sector_num
),
1025 filename2
, strerror(-ret
));
1029 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1030 if (ret
|| pnum
!= nb_sectors
) {
1031 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1033 ret
? sector_num
: sector_num
+ pnum
));
1041 qprintf(quiet
, "Strict mode: Offset %" PRId64
1042 " allocation mismatch!\n",
1043 sectors_to_bytes(sector_num
));
1048 ret
= check_empty_sectors(bs1
, sector_num
, nb_sectors
,
1049 filename1
, buf1
, quiet
);
1051 ret
= check_empty_sectors(bs2
, sector_num
, nb_sectors
,
1052 filename2
, buf1
, quiet
);
1056 error_report("Error while reading offset %" PRId64
": %s",
1057 sectors_to_bytes(sector_num
), strerror(-ret
));
1063 sector_num
+= nb_sectors
;
1064 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1067 if (total_sectors1
!= total_sectors2
) {
1068 BlockDriverState
*bs_over
;
1069 int64_t total_sectors_over
;
1070 const char *filename_over
;
1072 qprintf(quiet
, "Warning: Image size mismatch!\n");
1073 if (total_sectors1
> total_sectors2
) {
1074 total_sectors_over
= total_sectors1
;
1076 filename_over
= filename1
;
1078 total_sectors_over
= total_sectors2
;
1080 filename_over
= filename2
;
1084 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1085 if (nb_sectors
<= 0) {
1088 ret
= bdrv_is_allocated_above(bs_over
, NULL
, sector_num
,
1092 error_report("Sector allocation test failed for %s",
1099 ret
= check_empty_sectors(bs_over
, sector_num
, nb_sectors
,
1100 filename_over
, buf1
, quiet
);
1103 error_report("Error while reading offset %" PRId64
1104 " of %s: %s", sectors_to_bytes(sector_num
),
1105 filename_over
, strerror(-ret
));
1111 sector_num
+= nb_sectors
;
1112 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1116 qprintf(quiet
, "Images are identical.\n");
1126 qemu_progress_end();
1130 static int img_convert(int argc
, char **argv
)
1132 int c
, n
, n1
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1134 int progress
= 0, flags
;
1135 const char *fmt
, *out_fmt
, *cache
, *out_baseimg
, *out_filename
;
1136 BlockDriver
*drv
, *proto_drv
;
1137 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1138 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
1139 uint64_t bs_sectors
;
1140 uint8_t * buf
= NULL
;
1141 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1142 const uint8_t *buf1
;
1143 BlockDriverInfo bdi
;
1144 QEMUOptionParameter
*param
= NULL
, *create_options
= NULL
;
1145 QEMUOptionParameter
*out_baseimg_param
;
1146 char *options
= NULL
;
1147 const char *snapshot_name
= NULL
;
1148 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1150 Error
*local_err
= NULL
;
1151 QemuOpts
*sn_opts
= NULL
;
1160 c
= getopt(argc
, argv
, "f:O:B:s:hce6o:pS:t:qnl:");
1176 out_baseimg
= optarg
;
1182 error_report("option -e is deprecated, please use \'-o "
1183 "encryption\' instead!");
1186 error_report("option -6 is deprecated, please use \'-o "
1187 "compat6\' instead!");
1193 snapshot_name
= optarg
;
1196 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1197 sn_opts
= qemu_opts_parse(&internal_snapshot_opts
, optarg
, 0);
1199 error_report("Failed in parsing snapshot param '%s'",
1204 snapshot_name
= optarg
;
1211 sval
= strtosz_suffix(optarg
, &end
, STRTOSZ_DEFSUFFIX_B
);
1212 if (sval
< 0 || *end
) {
1213 error_report("Invalid minimum zero buffer size for sparse output specified");
1217 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1239 bs_n
= argc
- optind
- 1;
1244 out_filename
= argv
[argc
- 1];
1246 /* Initialize before goto out */
1247 qemu_progress_init(progress
, 1.0);
1249 if (options
&& is_help_option(options
)) {
1250 ret
= print_block_option_help(out_filename
, out_fmt
);
1254 if (bs_n
> 1 && out_baseimg
) {
1255 error_report("-B makes no sense when concatenating multiple input "
1261 qemu_progress_print(0, 100);
1263 bs
= g_malloc0(bs_n
* sizeof(BlockDriverState
*));
1266 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1267 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
, BDRV_O_FLAGS
, true,
1270 error_report("Could not open '%s'", argv
[optind
+ bs_i
]);
1274 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
1275 total_sectors
+= bs_sectors
;
1279 ret
= bdrv_snapshot_load_tmp(bs
[0],
1280 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1281 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1283 } else if (snapshot_name
!= NULL
) {
1285 error_report("No support for concatenating multiple snapshot");
1290 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1292 if (error_is_set(&local_err
)) {
1293 error_report("Failed to load snapshot: %s",
1294 error_get_pretty(local_err
));
1295 error_free(local_err
);
1300 /* Find driver and parse its options */
1301 drv
= bdrv_find_format(out_fmt
);
1303 error_report("Unknown file format '%s'", out_fmt
);
1308 proto_drv
= bdrv_find_protocol(out_filename
, true);
1310 error_report("Unknown protocol '%s'", out_filename
);
1315 create_options
= append_option_parameters(create_options
,
1316 drv
->create_options
);
1317 create_options
= append_option_parameters(create_options
,
1318 proto_drv
->create_options
);
1321 param
= parse_option_parameters(options
, create_options
, param
);
1322 if (param
== NULL
) {
1323 error_report("Invalid options for file format '%s'.", out_fmt
);
1328 param
= parse_option_parameters("", create_options
, param
);
1331 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, total_sectors
* 512);
1332 ret
= add_old_style_options(out_fmt
, param
, out_baseimg
, NULL
);
1337 /* Get backing file name if -o backing_file was used */
1338 out_baseimg_param
= get_option_parameter(param
, BLOCK_OPT_BACKING_FILE
);
1339 if (out_baseimg_param
) {
1340 out_baseimg
= out_baseimg_param
->value
.s
;
1343 /* Check if compression is supported */
1345 QEMUOptionParameter
*encryption
=
1346 get_option_parameter(param
, BLOCK_OPT_ENCRYPT
);
1347 QEMUOptionParameter
*preallocation
=
1348 get_option_parameter(param
, BLOCK_OPT_PREALLOC
);
1350 if (!drv
->bdrv_write_compressed
) {
1351 error_report("Compression not supported for this file format");
1356 if (encryption
&& encryption
->value
.n
) {
1357 error_report("Compression and encryption not supported at "
1363 if (preallocation
&& preallocation
->value
.s
1364 && strcmp(preallocation
->value
.s
, "off"))
1366 error_report("Compression and preallocation not supported at "
1374 /* Create the new image */
1375 ret
= bdrv_create(drv
, out_filename
, param
, &local_err
);
1377 error_report("%s: error while converting %s: %s",
1378 out_filename
, out_fmt
, error_get_pretty(local_err
));
1379 error_free(local_err
);
1384 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
1385 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1387 error_report("Invalid cache option: %s", cache
);
1391 out_bs
= bdrv_new_open(out_filename
, out_fmt
, flags
, true, quiet
);
1399 bdrv_get_geometry(bs
[0], &bs_sectors
);
1401 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1402 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1404 bufsectors
= MIN(32768,
1405 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
1406 out_bs
->bl
.discard_alignment
))
1409 buf
= qemu_blockalign(out_bs
, bufsectors
* BDRV_SECTOR_SIZE
);
1412 int64_t output_length
= bdrv_getlength(out_bs
);
1413 if (output_length
< 0) {
1414 error_report("unable to get output image length: %s\n",
1415 strerror(-output_length
));
1418 } else if (output_length
< total_sectors
<< BDRV_SECTOR_BITS
) {
1419 error_report("output file is smaller than input file");
1425 cluster_sectors
= 0;
1426 ret
= bdrv_get_info(out_bs
, &bdi
);
1429 error_report("could not get block driver info");
1433 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
1437 if (cluster_sectors
<= 0 || cluster_sectors
> bufsectors
) {
1438 error_report("invalid cluster size");
1444 nb_sectors
= total_sectors
;
1451 nb_sectors
= total_sectors
- sector_num
;
1452 if (nb_sectors
<= 0)
1454 if (nb_sectors
>= cluster_sectors
)
1455 n
= cluster_sectors
;
1459 bs_num
= sector_num
- bs_offset
;
1460 assert (bs_num
>= 0);
1463 while (remainder
> 0) {
1465 while (bs_num
== bs_sectors
) {
1467 assert (bs_i
< bs_n
);
1468 bs_offset
+= bs_sectors
;
1469 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
1471 /* printf("changing part: sector_num=%" PRId64 ", "
1472 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1473 "\n", sector_num, bs_i, bs_offset, bs_sectors); */
1475 assert (bs_num
< bs_sectors
);
1477 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
1479 ret
= bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
);
1481 error_report("error while reading sector %" PRId64
": %s",
1482 bs_num
, strerror(-ret
));
1491 assert (remainder
== 0);
1493 if (!buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)) {
1494 ret
= bdrv_write_compressed(out_bs
, sector_num
, buf
, n
);
1496 error_report("error while compressing sector %" PRId64
1497 ": %s", sector_num
, strerror(-ret
));
1502 qemu_progress_print(100.0 * sector_num
/ total_sectors
, 0);
1504 /* signal EOF to align */
1505 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
1507 int64_t sectors_to_read
, sectors_read
, sector_num_next_status
;
1508 bool count_allocated_sectors
;
1509 int has_zero_init
= min_sparse
? bdrv_has_zero_init(out_bs
) : 0;
1511 if (!has_zero_init
&& bdrv_can_write_zeroes_with_unmap(out_bs
)) {
1512 ret
= bdrv_make_zero(out_bs
, BDRV_REQ_MAY_UNMAP
);
1519 sectors_to_read
= total_sectors
;
1520 count_allocated_sectors
= progress
&& (out_baseimg
|| has_zero_init
);
1522 sector_num
= 0; // total number of sectors converted so far
1524 sector_num_next_status
= 0;
1527 nb_sectors
= total_sectors
- sector_num
;
1528 if (nb_sectors
<= 0) {
1529 if (count_allocated_sectors
) {
1530 sectors_to_read
= sectors_read
;
1531 count_allocated_sectors
= false;
1538 while (sector_num
- bs_offset
>= bs_sectors
) {
1540 assert (bs_i
< bs_n
);
1541 bs_offset
+= bs_sectors
;
1542 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
1543 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1544 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1545 sector_num, bs_i, bs_offset, bs_sectors); */
1548 if ((out_baseimg
|| has_zero_init
) &&
1549 sector_num
>= sector_num_next_status
) {
1550 n
= nb_sectors
> INT_MAX
? INT_MAX
: nb_sectors
;
1551 ret
= bdrv_get_block_status(bs
[bs_i
], sector_num
- bs_offset
,
1554 error_report("error while reading block status of sector %"
1555 PRId64
": %s", sector_num
- bs_offset
,
1559 /* If the output image is zero initialized, we are not working
1560 * on a shared base and the input is zero we can skip the next
1562 if (has_zero_init
&& !out_baseimg
&& (ret
& BDRV_BLOCK_ZERO
)) {
1566 /* If the output image is being created as a copy on write
1567 * image, assume that sectors which are unallocated in the
1568 * input image are present in both the output's and input's
1569 * base images (no need to copy them). */
1571 if (!(ret
& BDRV_BLOCK_DATA
)) {
1575 /* The next 'n1' sectors are allocated in the input image.
1576 * Copy only those as they may be followed by unallocated
1580 /* avoid redundant callouts to get_block_status */
1581 sector_num_next_status
= sector_num
+ n1
;
1584 n
= MIN(nb_sectors
, bufsectors
);
1586 /* round down request length to an aligned sector, but
1587 * do not bother doing this on short requests. They happen
1588 * when we found an all-zero area, and the next sector to
1589 * write will not be sector_num + n. */
1590 if (cluster_sectors
> 0 && n
>= cluster_sectors
) {
1591 int64_t next_aligned_sector
= (sector_num
+ n
);
1592 next_aligned_sector
-= next_aligned_sector
% cluster_sectors
;
1593 if (sector_num
+ n
> next_aligned_sector
) {
1594 n
= next_aligned_sector
- sector_num
;
1598 n
= MIN(n
, bs_sectors
- (sector_num
- bs_offset
));
1601 if (count_allocated_sectors
) {
1607 ret
= bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
);
1609 error_report("error while reading sector %" PRId64
": %s",
1610 sector_num
- bs_offset
, strerror(-ret
));
1613 /* NOTE: at the same time we convert, we do not write zero
1614 sectors to have a chance to compress the image. Ideally, we
1615 should add a specific call to have the info to go faster */
1618 if (!has_zero_init
||
1619 is_allocated_sectors_min(buf1
, n
, &n1
, min_sparse
)) {
1620 ret
= bdrv_write(out_bs
, sector_num
, buf1
, n1
);
1622 error_report("error while writing sector %" PRId64
1623 ": %s", sector_num
, strerror(-ret
));
1631 qemu_progress_print(100.0 * sectors_read
/ sectors_to_read
, 0);
1636 qemu_progress_print(100, 0);
1638 qemu_progress_end();
1639 free_option_parameters(create_options
);
1640 free_option_parameters(param
);
1643 qemu_opts_del(sn_opts
);
1649 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1651 bdrv_unref(bs
[bs_i
]);
1663 static void dump_snapshots(BlockDriverState
*bs
)
1665 QEMUSnapshotInfo
*sn_tab
, *sn
;
1668 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
1671 printf("Snapshot list:\n");
1672 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
1674 for(i
= 0; i
< nb_sns
; i
++) {
1676 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
1682 static void dump_json_image_info_list(ImageInfoList
*list
)
1686 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1688 visit_type_ImageInfoList(qmp_output_get_visitor(ov
),
1689 &list
, NULL
, &errp
);
1690 obj
= qmp_output_get_qobject(ov
);
1691 str
= qobject_to_json_pretty(obj
);
1692 assert(str
!= NULL
);
1693 printf("%s\n", qstring_get_str(str
));
1694 qobject_decref(obj
);
1695 qmp_output_visitor_cleanup(ov
);
1699 static void dump_json_image_info(ImageInfo
*info
)
1703 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1705 visit_type_ImageInfo(qmp_output_get_visitor(ov
),
1706 &info
, NULL
, &errp
);
1707 obj
= qmp_output_get_qobject(ov
);
1708 str
= qobject_to_json_pretty(obj
);
1709 assert(str
!= NULL
);
1710 printf("%s\n", qstring_get_str(str
));
1711 qobject_decref(obj
);
1712 qmp_output_visitor_cleanup(ov
);
1716 static void dump_human_image_info_list(ImageInfoList
*list
)
1718 ImageInfoList
*elem
;
1721 for (elem
= list
; elem
; elem
= elem
->next
) {
1727 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
1731 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
1733 return strcmp(a
, b
) == 0;
1737 * Open an image file chain and return an ImageInfoList
1739 * @filename: topmost image filename
1740 * @fmt: topmost image format (may be NULL to autodetect)
1741 * @chain: true - enumerate entire backing file chain
1742 * false - only topmost image file
1744 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1745 * image file. If there was an error a message will have been printed to
1748 static ImageInfoList
*collect_image_info_list(const char *filename
,
1752 ImageInfoList
*head
= NULL
;
1753 ImageInfoList
**last
= &head
;
1754 GHashTable
*filenames
;
1757 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
1760 BlockDriverState
*bs
;
1762 ImageInfoList
*elem
;
1764 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
1765 error_report("Backing file '%s' creates an infinite loop.",
1769 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
1771 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_NO_BACKING
,
1777 bdrv_query_image_info(bs
, &info
, &err
);
1778 if (error_is_set(&err
)) {
1779 error_report("%s", error_get_pretty(err
));
1784 elem
= g_new0(ImageInfoList
, 1);
1791 filename
= fmt
= NULL
;
1793 if (info
->has_full_backing_filename
) {
1794 filename
= info
->full_backing_filename
;
1795 } else if (info
->has_backing_filename
) {
1796 filename
= info
->backing_filename
;
1798 if (info
->has_backing_filename_format
) {
1799 fmt
= info
->backing_filename_format
;
1803 g_hash_table_destroy(filenames
);
1807 qapi_free_ImageInfoList(head
);
1808 g_hash_table_destroy(filenames
);
1812 static int img_info(int argc
, char **argv
)
1815 OutputFormat output_format
= OFORMAT_HUMAN
;
1817 const char *filename
, *fmt
, *output
;
1818 ImageInfoList
*list
;
1823 int option_index
= 0;
1824 static const struct option long_options
[] = {
1825 {"help", no_argument
, 0, 'h'},
1826 {"format", required_argument
, 0, 'f'},
1827 {"output", required_argument
, 0, OPTION_OUTPUT
},
1828 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
1831 c
= getopt_long(argc
, argv
, "f:h",
1832 long_options
, &option_index
);
1847 case OPTION_BACKING_CHAIN
:
1852 if (optind
!= argc
- 1) {
1855 filename
= argv
[optind
++];
1857 if (output
&& !strcmp(output
, "json")) {
1858 output_format
= OFORMAT_JSON
;
1859 } else if (output
&& !strcmp(output
, "human")) {
1860 output_format
= OFORMAT_HUMAN
;
1861 } else if (output
) {
1862 error_report("--output must be used with human or json as argument.");
1866 list
= collect_image_info_list(filename
, fmt
, chain
);
1871 switch (output_format
) {
1873 dump_human_image_info_list(list
);
1877 dump_json_image_info_list(list
);
1879 dump_json_image_info(list
->value
);
1884 qapi_free_ImageInfoList(list
);
1888 static int img_update(int argc
, char **argv
)
1891 const char *filename
, *fmt
;
1892 BlockDriverState
*bs
;
1896 c
= getopt(argc
, argv
, "f:h");
1911 filename
= argv
[optind
++];
1913 bs
= bdrv_new_open(filename
, fmt
,
1914 BDRV_O_FLAGS
| BDRV_O_NO_BACKING
| BDRV_O_RDWR
,
1920 if (bs
->drv
->bdrv_update
==NULL
) {
1921 error_report("the 'update' command is not supported for the "
1922 "'%s' image format.", bdrv_get_format_name(bs
));
1925 bs
->drv
->bdrv_update(bs
, argc
-optind
, &argv
[optind
]);
1931 typedef struct MapEntry
{
1937 BlockDriverState
*bs
;
1940 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
1943 switch (output_format
) {
1945 if ((e
->flags
& BDRV_BLOCK_DATA
) &&
1946 !(e
->flags
& BDRV_BLOCK_OFFSET_VALID
)) {
1947 error_report("File contains external, encrypted or compressed clusters.");
1950 if ((e
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) == BDRV_BLOCK_DATA
) {
1951 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
1952 e
->start
, e
->length
, e
->offset
, e
->bs
->filename
);
1954 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
1955 * Modify the flags here to allow more coalescing.
1958 (next
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) != BDRV_BLOCK_DATA
) {
1959 next
->flags
&= ~BDRV_BLOCK_DATA
;
1960 next
->flags
|= BDRV_BLOCK_ZERO
;
1964 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
", \"depth\": %d,"
1965 " \"zero\": %s, \"data\": %s",
1966 (e
->start
== 0 ? "[" : ",\n"),
1967 e
->start
, e
->length
, e
->depth
,
1968 (e
->flags
& BDRV_BLOCK_ZERO
) ? "true" : "false",
1969 (e
->flags
& BDRV_BLOCK_DATA
) ? "true" : "false");
1970 if (e
->flags
& BDRV_BLOCK_OFFSET_VALID
) {
1971 printf(", \"offset\": %"PRId64
"", e
->offset
);
1982 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
1983 int nb_sectors
, MapEntry
*e
)
1988 /* As an optimization, we could cache the current range of unallocated
1989 * clusters in each file of the chain, and avoid querying the same
1995 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
);
2000 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2003 bs
= bs
->backing_hd
;
2012 e
->start
= sector_num
* BDRV_SECTOR_SIZE
;
2013 e
->length
= nb_sectors
* BDRV_SECTOR_SIZE
;
2014 e
->flags
= ret
& ~BDRV_BLOCK_OFFSET_MASK
;
2015 e
->offset
= ret
& BDRV_BLOCK_OFFSET_MASK
;
2021 static int img_map(int argc
, char **argv
)
2024 OutputFormat output_format
= OFORMAT_HUMAN
;
2025 BlockDriverState
*bs
;
2026 const char *filename
, *fmt
, *output
;
2028 MapEntry curr
= { .length
= 0 }, next
;
2034 int option_index
= 0;
2035 static const struct option long_options
[] = {
2036 {"help", no_argument
, 0, 'h'},
2037 {"format", required_argument
, 0, 'f'},
2038 {"output", required_argument
, 0, OPTION_OUTPUT
},
2041 c
= getopt_long(argc
, argv
, "f:h",
2042 long_options
, &option_index
);
2059 if (optind
>= argc
) {
2062 filename
= argv
[optind
++];
2064 if (output
&& !strcmp(output
, "json")) {
2065 output_format
= OFORMAT_JSON
;
2066 } else if (output
&& !strcmp(output
, "human")) {
2067 output_format
= OFORMAT_HUMAN
;
2068 } else if (output
) {
2069 error_report("--output must be used with human or json as argument.");
2073 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
, true, false);
2078 if (output_format
== OFORMAT_HUMAN
) {
2079 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2082 length
= bdrv_getlength(bs
);
2083 while (curr
.start
+ curr
.length
< length
) {
2084 int64_t nsectors_left
;
2088 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2090 /* Probe up to 1 GiB at a time. */
2091 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2092 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2093 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2096 error_report("Could not read file metadata: %s", strerror(-ret
));
2100 if (curr
.length
!= 0 && curr
.flags
== next
.flags
&&
2101 curr
.depth
== next
.depth
&&
2102 ((curr
.flags
& BDRV_BLOCK_OFFSET_VALID
) == 0 ||
2103 curr
.offset
+ curr
.length
== next
.offset
)) {
2104 curr
.length
+= next
.length
;
2108 if (curr
.length
> 0) {
2109 dump_map_entry(output_format
, &curr
, &next
);
2114 dump_map_entry(output_format
, &curr
, NULL
);
2121 #define SNAPSHOT_LIST 1
2122 #define SNAPSHOT_CREATE 2
2123 #define SNAPSHOT_APPLY 3
2124 #define SNAPSHOT_DELETE 4
2126 static int img_snapshot(int argc
, char **argv
)
2128 BlockDriverState
*bs
;
2129 QEMUSnapshotInfo sn
;
2130 char *filename
, *snapshot_name
= NULL
;
2131 int c
, ret
= 0, bdrv_oflags
;
2137 bdrv_oflags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2138 /* Parse commandline parameters */
2140 c
= getopt(argc
, argv
, "la:c:d:hq");
2154 action
= SNAPSHOT_LIST
;
2155 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2162 action
= SNAPSHOT_APPLY
;
2163 snapshot_name
= optarg
;
2170 action
= SNAPSHOT_CREATE
;
2171 snapshot_name
= optarg
;
2178 action
= SNAPSHOT_DELETE
;
2179 snapshot_name
= optarg
;
2187 if (optind
!= argc
- 1) {
2190 filename
= argv
[optind
++];
2192 /* Open the image */
2193 bs
= bdrv_new_open(filename
, NULL
, bdrv_oflags
, true, quiet
);
2198 /* Perform the requested action */
2204 case SNAPSHOT_CREATE
:
2205 memset(&sn
, 0, sizeof(sn
));
2206 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2208 qemu_gettimeofday(&tv
);
2209 sn
.date_sec
= tv
.tv_sec
;
2210 sn
.date_nsec
= tv
.tv_usec
* 1000;
2212 ret
= bdrv_snapshot_create(bs
, &sn
);
2214 error_report("Could not create snapshot '%s': %d (%s)",
2215 snapshot_name
, ret
, strerror(-ret
));
2219 case SNAPSHOT_APPLY
:
2220 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2222 error_report("Could not apply snapshot '%s': %d (%s)",
2223 snapshot_name
, ret
, strerror(-ret
));
2227 case SNAPSHOT_DELETE
:
2228 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2229 if (error_is_set(&err
)) {
2230 error_report("Could not delete snapshot '%s': (%s)",
2231 snapshot_name
, error_get_pretty(err
));
2246 static int img_rebase(int argc
, char **argv
)
2248 BlockDriverState
*bs
, *bs_old_backing
= NULL
, *bs_new_backing
= NULL
;
2249 BlockDriver
*old_backing_drv
, *new_backing_drv
;
2251 const char *fmt
, *cache
, *out_basefmt
, *out_baseimg
;
2256 Error
*local_err
= NULL
;
2258 /* Parse commandline parameters */
2260 cache
= BDRV_DEFAULT_CACHE
;
2264 c
= getopt(argc
, argv
, "uhf:F:b:pt:q");
2277 out_basefmt
= optarg
;
2280 out_baseimg
= optarg
;
2301 if ((optind
!= argc
- 1) || (!unsafe
&& !out_baseimg
)) {
2304 filename
= argv
[optind
++];
2306 qemu_progress_init(progress
, 2.0);
2307 qemu_progress_print(0, 100);
2309 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2310 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2312 error_report("Invalid cache option: %s", cache
);
2319 * Ignore the old backing file for unsafe rebase in case we want to correct
2320 * the reference to a renamed or moved backing file.
2322 bs
= bdrv_new_open(filename
, fmt
, flags
, true, quiet
);
2327 /* Find the right drivers for the backing files */
2328 old_backing_drv
= NULL
;
2329 new_backing_drv
= NULL
;
2331 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
2332 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
2333 if (old_backing_drv
== NULL
) {
2334 error_report("Invalid format name: '%s'", bs
->backing_format
);
2340 if (out_basefmt
!= NULL
) {
2341 new_backing_drv
= bdrv_find_format(out_basefmt
);
2342 if (new_backing_drv
== NULL
) {
2343 error_report("Invalid format name: '%s'", out_basefmt
);
2349 /* For safe rebasing we need to compare old and new backing file */
2351 /* Make the compiler happy */
2352 bs_old_backing
= NULL
;
2353 bs_new_backing
= NULL
;
2355 char backing_name
[1024];
2357 bs_old_backing
= bdrv_new("old_backing");
2358 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2359 ret
= bdrv_open(bs_old_backing
, backing_name
, NULL
, BDRV_O_FLAGS
,
2360 old_backing_drv
, &local_err
);
2362 error_report("Could not open old backing file '%s': %s",
2363 backing_name
, error_get_pretty(local_err
));
2364 error_free(local_err
);
2367 if (out_baseimg
[0]) {
2368 bs_new_backing
= bdrv_new("new_backing");
2369 ret
= bdrv_open(bs_new_backing
, out_baseimg
, NULL
, BDRV_O_FLAGS
,
2370 new_backing_drv
, &local_err
);
2372 error_report("Could not open new backing file '%s': %s",
2373 out_baseimg
, error_get_pretty(local_err
));
2374 error_free(local_err
);
2381 * Check each unallocated cluster in the COW file. If it is unallocated,
2382 * accesses go to the backing file. We must therefore compare this cluster
2383 * in the old and new backing file, and if they differ we need to copy it
2384 * from the old backing file into the COW file.
2386 * If qemu-img crashes during this step, no harm is done. The content of
2387 * the image is the same as the original one at any time.
2390 uint64_t num_sectors
;
2391 uint64_t old_backing_num_sectors
;
2392 uint64_t new_backing_num_sectors
= 0;
2397 float local_progress
= 0;
2399 buf_old
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2400 buf_new
= qemu_blockalign(bs
, IO_BUF_SIZE
);
2402 bdrv_get_geometry(bs
, &num_sectors
);
2403 bdrv_get_geometry(bs_old_backing
, &old_backing_num_sectors
);
2404 if (bs_new_backing
) {
2405 bdrv_get_geometry(bs_new_backing
, &new_backing_num_sectors
);
2408 if (num_sectors
!= 0) {
2409 local_progress
= (float)100 /
2410 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
2413 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
2415 /* How many sectors can we handle with the next read? */
2416 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
2417 n
= (IO_BUF_SIZE
/ 512);
2419 n
= num_sectors
- sector
;
2422 /* If the cluster is allocated, we don't need to take action */
2423 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
2425 error_report("error while reading image metadata: %s",
2434 * Read old and new backing file and take into consideration that
2435 * backing files may be smaller than the COW image.
2437 if (sector
>= old_backing_num_sectors
) {
2438 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
2440 if (sector
+ n
> old_backing_num_sectors
) {
2441 n
= old_backing_num_sectors
- sector
;
2444 ret
= bdrv_read(bs_old_backing
, sector
, buf_old
, n
);
2446 error_report("error while reading from old backing file");
2451 if (sector
>= new_backing_num_sectors
|| !bs_new_backing
) {
2452 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
2454 if (sector
+ n
> new_backing_num_sectors
) {
2455 n
= new_backing_num_sectors
- sector
;
2458 ret
= bdrv_read(bs_new_backing
, sector
, buf_new
, n
);
2460 error_report("error while reading from new backing file");
2465 /* If they differ, we need to write to the COW file */
2466 uint64_t written
= 0;
2468 while (written
< n
) {
2471 if (compare_sectors(buf_old
+ written
* 512,
2472 buf_new
+ written
* 512, n
- written
, &pnum
))
2474 ret
= bdrv_write(bs
, sector
+ written
,
2475 buf_old
+ written
* 512, pnum
);
2477 error_report("Error while writing to COW image: %s",
2485 qemu_progress_print(local_progress
, 100);
2488 qemu_vfree(buf_old
);
2489 qemu_vfree(buf_new
);
2493 * Change the backing file. All clusters that are different from the old
2494 * backing file are overwritten in the COW file now, so the visible content
2495 * doesn't change when we switch the backing file.
2497 if (out_baseimg
&& *out_baseimg
) {
2498 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
2500 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
2503 if (ret
== -ENOSPC
) {
2504 error_report("Could not change the backing file to '%s': No "
2505 "space left in the file header", out_baseimg
);
2506 } else if (ret
< 0) {
2507 error_report("Could not change the backing file to '%s': %s",
2508 out_baseimg
, strerror(-ret
));
2511 qemu_progress_print(100, 0);
2513 * TODO At this point it is possible to check if any clusters that are
2514 * allocated in the COW file are the same in the backing file. If so, they
2515 * could be dropped from the COW file. Don't do this before switching the
2516 * backing file, in case of a crash this would lead to corruption.
2519 qemu_progress_end();
2522 if (bs_old_backing
!= NULL
) {
2523 bdrv_unref(bs_old_backing
);
2525 if (bs_new_backing
!= NULL
) {
2526 bdrv_unref(bs_new_backing
);
2537 static int img_resize(int argc
, char **argv
)
2539 int c
, ret
, relative
;
2540 const char *filename
, *fmt
, *size
;
2541 int64_t n
, total_size
;
2543 BlockDriverState
*bs
= NULL
;
2545 static QemuOptsList resize_options
= {
2546 .name
= "resize_options",
2547 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
2550 .name
= BLOCK_OPT_SIZE
,
2551 .type
= QEMU_OPT_SIZE
,
2552 .help
= "Virtual disk size"
2559 /* Remove size from argv manually so that negative numbers are not treated
2560 * as options by getopt. */
2566 size
= argv
[--argc
];
2568 /* Parse getopt arguments */
2571 c
= getopt(argc
, argv
, "f:hq");
2588 if (optind
!= argc
- 1) {
2591 filename
= argv
[optind
++];
2593 /* Choose grow, shrink, or absolute resize mode */
2609 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
2610 if (qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
)) {
2611 /* Error message already printed when size parsing fails */
2613 qemu_opts_del(param
);
2616 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
2617 qemu_opts_del(param
);
2619 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
, true, quiet
);
2626 total_size
= bdrv_getlength(bs
) + n
* relative
;
2630 if (total_size
<= 0) {
2631 error_report("New image size must be positive");
2636 ret
= bdrv_truncate(bs
, total_size
);
2639 qprintf(quiet
, "Image resized.\n");
2642 error_report("This image does not support resize");
2645 error_report("Image is read-only");
2648 error_report("Error resizing image (%d)", -ret
);
2661 static int img_amend(int argc
, char **argv
)
2664 char *options
= NULL
;
2665 QEMUOptionParameter
*create_options
= NULL
, *options_param
= NULL
;
2666 const char *fmt
= NULL
, *filename
;
2668 BlockDriverState
*bs
= NULL
;
2671 c
= getopt(argc
, argv
, "hqf:o:");
2693 if (optind
!= argc
- 1) {
2701 filename
= argv
[argc
- 1];
2703 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
, true, quiet
);
2705 error_report("Could not open image '%s'", filename
);
2710 fmt
= bs
->drv
->format_name
;
2712 if (is_help_option(options
)) {
2713 ret
= print_block_option_help(filename
, fmt
);
2717 create_options
= append_option_parameters(create_options
,
2718 bs
->drv
->create_options
);
2719 options_param
= parse_option_parameters(options
, create_options
,
2721 if (options_param
== NULL
) {
2722 error_report("Invalid options for file format '%s'", fmt
);
2727 ret
= bdrv_amend_options(bs
, options_param
);
2729 error_report("Error while amending options: %s", strerror(-ret
));
2737 free_option_parameters(create_options
);
2738 free_option_parameters(options_param
);
2745 static const img_cmd_t img_cmds
[] = {
2746 #define DEF(option, callback, arg_string) \
2747 { option, callback },
2748 #include "qemu-img-cmds.h"
2754 int main(int argc
, char **argv
)
2756 const img_cmd_t
*cmd
;
2757 const char *cmdname
;
2760 signal(SIGPIPE
, SIG_IGN
);
2763 error_set_progname(argv
[0]);
2765 qemu_init_main_loop();
2772 /* find the command */
2773 for(cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
2774 if (!strcmp(cmdname
, cmd
->name
)) {
2775 return cmd
->handler(argc
, argv
);