2 * QEMU disk image utility
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "qapi-visit.h"
25 #include "qapi/qmp-output-visitor.h"
26 #include "qapi/qmp/qjson.h"
27 #include "qemu-common.h"
28 #include "qemu/option.h"
29 #include "qemu/error-report.h"
30 #include "qemu/osdep.h"
31 #include "sysemu/sysemu.h"
32 #include "sysemu/block-backend.h"
33 #include "block/block_int.h"
34 #include "block/blockjob.h"
35 #include "block/qapi.h"
38 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
39 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
41 typedef struct img_cmd_t
{
43 int (*handler
)(int argc
, char **argv
);
48 OPTION_BACKING_CHAIN
= 257,
51 typedef enum OutputFormat
{
56 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
57 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
58 #define BDRV_DEFAULT_CACHE "writeback"
60 static void format_print(void *opaque
, const char *name
)
65 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
69 error_printf("qemu-img: ");
72 error_vprintf(fmt
, ap
);
75 error_printf("\nTry 'qemu-img --help' for more information\n");
79 /* Please keep in synch with qemu-img.texi */
80 static void QEMU_NORETURN
help(void)
82 const char *help_msg
=
84 "usage: qemu-img command [command options]\n"
85 "QEMU disk image utility\n"
88 #define DEF(option, callback, arg_string) \
90 #include "qemu-img-cmds.h"
94 "Command parameters:\n"
95 " 'filename' is a disk image filename\n"
96 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
97 " 'cache' is the cache mode used to write the output disk image, the valid\n"
98 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
99 " 'directsync' and 'unsafe' (default for convert)\n"
100 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
101 " options are the same as for the 'cache' option\n"
102 " 'size' is the disk image size in bytes. Optional suffixes\n"
103 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
104 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
105 " supported. 'b' is ignored.\n"
106 " 'output_filename' is the destination disk image filename\n"
107 " 'output_fmt' is the destination format\n"
108 " 'options' is a comma separated list of format specific options in a\n"
109 " name=value format. Use -o ? for an overview of the options supported by the\n"
111 " 'snapshot_param' is param used for internal snapshot, format\n"
112 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
114 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
116 " '-c' indicates that target image must be compressed (qcow format only)\n"
117 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
118 " match exactly. The image doesn't need a working backing file before\n"
119 " rebasing in this case (useful for renaming the backing file)\n"
120 " '-h' with or without a command shows this help and lists the supported formats\n"
121 " '-p' show progress of command (only certain commands)\n"
122 " '-q' use Quiet mode - do not print any output (except errors)\n"
123 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
124 " contain only zeros for qemu-img to create a sparse image during\n"
125 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
126 " unallocated or zero sectors, and the destination image will always be\n"
128 " '--output' takes the format in which the output must be done (human or json)\n"
129 " '-n' skips the target volume creation (useful if the volume is created\n"
130 " prior to running qemu-img)\n"
132 "Parameters to check subcommand:\n"
133 " '-r' tries to repair any inconsistencies that are found during the check.\n"
134 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
135 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
136 " hiding corruption that has already occurred.\n"
138 "Parameters to snapshot subcommand:\n"
139 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
140 " '-a' applies a snapshot (revert disk to saved state)\n"
141 " '-c' creates a snapshot\n"
142 " '-d' deletes a snapshot\n"
143 " '-l' lists all snapshots in the given image\n"
145 "Parameters to compare subcommand:\n"
146 " '-f' first image format\n"
147 " '-F' second image format\n"
148 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
150 printf("%s\nSupported formats:", help_msg
);
151 bdrv_iterate_format(format_print
, NULL
);
156 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
162 ret
= vprintf(fmt
, args
);
169 /* XXX: put correct support for win32 */
170 static int read_password(char *buf
, int buf_size
)
174 printf("Password: ");
182 } else if (c
== '\n') {
184 } else if (i
< (buf_size
- 1)) {
196 static struct termios oldtty
;
198 static void term_exit(void)
200 tcsetattr (0, TCSANOW
, &oldtty
);
203 static void term_init(void)
210 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
211 |INLCR
|IGNCR
|ICRNL
|IXON
);
212 tty
.c_oflag
|= OPOST
;
213 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
214 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
219 tcsetattr (0, TCSANOW
, &tty
);
224 static int read_password(char *buf
, int buf_size
)
229 printf("password: ");
234 ret
= read(0, &ch
, 1);
236 if (errno
== EAGAIN
|| errno
== EINTR
) {
241 } else if (ret
== 0) {
249 if (i
< (buf_size
- 1))
260 static int print_block_option_help(const char *filename
, const char *fmt
)
262 BlockDriver
*drv
, *proto_drv
;
263 QemuOptsList
*create_opts
= NULL
;
264 Error
*local_err
= NULL
;
266 /* Find driver and parse its options */
267 drv
= bdrv_find_format(fmt
);
269 error_report("Unknown file format '%s'", fmt
);
273 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
275 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
277 qerror_report_err(local_err
);
278 error_free(local_err
);
279 qemu_opts_free(create_opts
);
282 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
285 qemu_opts_print_help(create_opts
);
286 qemu_opts_free(create_opts
);
290 static BlockBackend
*img_open(const char *id
, const char *filename
,
291 const char *fmt
, int flags
,
292 bool require_io
, bool quiet
)
295 BlockDriverState
*bs
;
297 Error
*local_err
= NULL
;
298 QDict
*options
= NULL
;
301 options
= qdict_new();
302 qdict_put(options
, "driver", qstring_from_str(fmt
));
305 blk
= blk_new_open(id
, filename
, NULL
, options
, flags
, &local_err
);
307 error_report("Could not open '%s': %s", filename
,
308 error_get_pretty(local_err
));
309 error_free(local_err
);
314 if (bdrv_is_encrypted(bs
) && require_io
) {
315 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
316 if (read_password(password
, sizeof(password
)) < 0) {
317 error_report("No password given");
320 if (bdrv_set_key(bs
, password
) < 0) {
321 error_report("invalid password");
331 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
332 const char *base_filename
,
333 const char *base_fmt
)
338 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
340 error_report("Backing file not supported for file format '%s'",
347 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
349 error_report("Backing file format not supported for file "
358 static int img_create(int argc
, char **argv
)
361 uint64_t img_size
= -1;
362 const char *fmt
= "raw";
363 const char *base_fmt
= NULL
;
364 const char *filename
;
365 const char *base_filename
= NULL
;
366 char *options
= NULL
;
367 Error
*local_err
= NULL
;
371 c
= getopt(argc
, argv
, "F:b:f:he6o:q");
384 base_filename
= optarg
;
390 error_report("option -e is deprecated, please use \'-o "
391 "encryption\' instead!");
394 error_report("option -6 is deprecated, please use \'-o "
395 "compat6\' instead!");
398 if (!is_valid_option_list(optarg
)) {
399 error_report("Invalid option list: %s", optarg
);
403 options
= g_strdup(optarg
);
405 char *old_options
= options
;
406 options
= g_strdup_printf("%s,%s", options
, optarg
);
416 /* Get the filename */
417 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
418 if (options
&& has_help_option(options
)) {
420 return print_block_option_help(filename
, fmt
);
423 if (optind
>= argc
) {
424 error_exit("Expecting image file name");
428 /* Get image size, if specified */
432 sval
= strtosz_suffix(argv
[optind
++], &end
, STRTOSZ_DEFSUFFIX_B
);
433 if (sval
< 0 || *end
) {
434 if (sval
== -ERANGE
) {
435 error_report("Image size must be less than 8 EiB!");
437 error_report("Invalid image size specified! You may use k, M, "
438 "G, T, P or E suffixes for ");
439 error_report("kilobytes, megabytes, gigabytes, terabytes, "
440 "petabytes and exabytes.");
444 img_size
= (uint64_t)sval
;
446 if (optind
!= argc
) {
447 error_exit("Unexpected argument: %s", argv
[optind
]);
450 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
451 options
, img_size
, BDRV_O_FLAGS
, &local_err
, quiet
);
453 error_report("%s: %s", filename
, error_get_pretty(local_err
));
454 error_free(local_err
);
466 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
468 Error
*local_err
= NULL
;
470 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
472 visit_type_ImageCheck(qmp_output_get_visitor(ov
),
473 &check
, NULL
, &local_err
);
474 obj
= qmp_output_get_qobject(ov
);
475 str
= qobject_to_json_pretty(obj
);
477 qprintf(quiet
, "%s\n", qstring_get_str(str
));
479 qmp_output_visitor_cleanup(ov
);
483 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
485 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
486 qprintf(quiet
, "No errors were found on the image.\n");
488 if (check
->corruptions
) {
489 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
490 "Data may be corrupted, or further writes to the image "
497 "\n%" PRId64
" leaked clusters were found on the image.\n"
498 "This means waste of disk space, but no harm to data.\n",
502 if (check
->check_errors
) {
505 " internal errors have occurred during the check.\n",
506 check
->check_errors
);
510 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
511 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
512 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
513 check
->allocated_clusters
, check
->total_clusters
,
514 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
515 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
516 check
->compressed_clusters
* 100.0 /
517 check
->allocated_clusters
);
520 if (check
->image_end_offset
) {
522 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
526 static int collect_image_check(BlockDriverState
*bs
,
528 const char *filename
,
533 BdrvCheckResult result
;
535 ret
= bdrv_check(bs
, &result
, fix
);
540 check
->filename
= g_strdup(filename
);
541 check
->format
= g_strdup(bdrv_get_format_name(bs
));
542 check
->check_errors
= result
.check_errors
;
543 check
->corruptions
= result
.corruptions
;
544 check
->has_corruptions
= result
.corruptions
!= 0;
545 check
->leaks
= result
.leaks
;
546 check
->has_leaks
= result
.leaks
!= 0;
547 check
->corruptions_fixed
= result
.corruptions_fixed
;
548 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
549 check
->leaks_fixed
= result
.leaks_fixed
;
550 check
->has_leaks_fixed
= result
.leaks
!= 0;
551 check
->image_end_offset
= result
.image_end_offset
;
552 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
553 check
->total_clusters
= result
.bfi
.total_clusters
;
554 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
555 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
556 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
557 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
558 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
559 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
560 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
566 * Checks an image for consistency. Exit codes:
568 * 0 - Check completed, image is good
569 * 1 - Check not completed because of internal errors
570 * 2 - Check completed, image is corrupted
571 * 3 - Check completed, image has leaked clusters, but is good otherwise
572 * 63 - Checks are not supported by the image format
574 static int img_check(int argc
, char **argv
)
577 OutputFormat output_format
= OFORMAT_HUMAN
;
578 const char *filename
, *fmt
, *output
, *cache
;
580 BlockDriverState
*bs
;
582 int flags
= BDRV_O_FLAGS
| BDRV_O_CHECK
;
588 cache
= BDRV_DEFAULT_CACHE
;
590 int option_index
= 0;
591 static const struct option long_options
[] = {
592 {"help", no_argument
, 0, 'h'},
593 {"format", required_argument
, 0, 'f'},
594 {"repair", required_argument
, 0, 'r'},
595 {"output", required_argument
, 0, OPTION_OUTPUT
},
598 c
= getopt_long(argc
, argv
, "hf:r:T:q",
599 long_options
, &option_index
);
612 flags
|= BDRV_O_RDWR
;
614 if (!strcmp(optarg
, "leaks")) {
615 fix
= BDRV_FIX_LEAKS
;
616 } else if (!strcmp(optarg
, "all")) {
617 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
619 error_exit("Unknown option value for -r "
620 "(expecting 'leaks' or 'all'): %s", optarg
);
634 if (optind
!= argc
- 1) {
635 error_exit("Expecting one image file name");
637 filename
= argv
[optind
++];
639 if (output
&& !strcmp(output
, "json")) {
640 output_format
= OFORMAT_JSON
;
641 } else if (output
&& !strcmp(output
, "human")) {
642 output_format
= OFORMAT_HUMAN
;
644 error_report("--output must be used with human or json as argument.");
648 ret
= bdrv_parse_cache_flags(cache
, &flags
);
650 error_report("Invalid source cache option: %s", cache
);
654 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
660 check
= g_new0(ImageCheck
, 1);
661 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
663 if (ret
== -ENOTSUP
) {
664 error_report("This image format does not support checks");
669 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
670 int corruptions_fixed
, leaks_fixed
;
672 leaks_fixed
= check
->leaks_fixed
;
673 corruptions_fixed
= check
->corruptions_fixed
;
675 if (output_format
== OFORMAT_HUMAN
) {
677 "The following inconsistencies were found and repaired:\n\n"
678 " %" PRId64
" leaked clusters\n"
679 " %" PRId64
" corruptions\n\n"
680 "Double checking the fixed image now...\n",
682 check
->corruptions_fixed
);
685 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
687 check
->leaks_fixed
= leaks_fixed
;
688 check
->corruptions_fixed
= corruptions_fixed
;
692 switch (output_format
) {
694 dump_human_image_check(check
, quiet
);
697 dump_json_image_check(check
, quiet
);
702 if (ret
|| check
->check_errors
) {
704 error_report("Check failed: %s", strerror(-ret
));
706 error_report("Check failed");
712 if (check
->corruptions
) {
714 } else if (check
->leaks
) {
721 qapi_free_ImageCheck(check
);
726 typedef struct CommonBlockJobCBInfo
{
727 BlockDriverState
*bs
;
729 } CommonBlockJobCBInfo
;
731 static void common_block_job_cb(void *opaque
, int ret
)
733 CommonBlockJobCBInfo
*cbi
= opaque
;
736 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
739 /* Drop this block job's reference */
743 static void run_block_job(BlockJob
*job
, Error
**errp
)
745 AioContext
*aio_context
= bdrv_get_aio_context(job
->bs
);
748 aio_poll(aio_context
, true);
749 qemu_progress_print((float)job
->offset
/ job
->len
* 100.f
, 0);
750 } while (!job
->ready
);
752 block_job_complete_sync(job
, errp
);
754 /* A block job may finish instantaneously without publishing any progress,
755 * so just signal completion here */
756 qemu_progress_print(100.f
, 0);
759 static int img_commit(int argc
, char **argv
)
762 const char *filename
, *fmt
, *cache
, *base
;
764 BlockDriverState
*bs
, *base_bs
;
765 bool progress
= false, quiet
= false, drop
= false;
766 Error
*local_err
= NULL
;
767 CommonBlockJobCBInfo cbi
;
770 cache
= BDRV_DEFAULT_CACHE
;
773 c
= getopt(argc
, argv
, "f:ht:b:dpq");
805 /* Progress is not shown in Quiet mode */
810 if (optind
!= argc
- 1) {
811 error_exit("Expecting one image file name");
813 filename
= argv
[optind
++];
815 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
816 ret
= bdrv_parse_cache_flags(cache
, &flags
);
818 error_report("Invalid cache option: %s", cache
);
822 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
828 qemu_progress_init(progress
, 1.f
);
829 qemu_progress_print(0.f
, 100);
832 base_bs
= bdrv_find_backing_image(bs
, base
);
834 error_set(&local_err
, QERR_BASE_NOT_FOUND
, base
);
838 /* This is different from QMP, which by default uses the deepest file in
839 * the backing chain (i.e., the very base); however, the traditional
840 * behavior of qemu-img commit is using the immediate backing file. */
841 base_bs
= bs
->backing_hd
;
843 error_setg(&local_err
, "Image does not have a backing file");
848 cbi
= (CommonBlockJobCBInfo
){
853 commit_active_start(bs
, base_bs
, 0, BLOCKDEV_ON_ERROR_REPORT
,
854 common_block_job_cb
, &cbi
, &local_err
);
859 /* The block job will swap base_bs and bs (which is not what we really want
860 * here, but okay) and unref base_bs (after the swap, i.e., the old top
861 * image). In order to still be able to empty that top image afterwards,
862 * increment the reference counter here preemptively. */
867 run_block_job(bs
->job
, &local_err
);
872 if (!drop
&& base_bs
->drv
->bdrv_make_empty
) {
873 ret
= base_bs
->drv
->bdrv_make_empty(base_bs
);
875 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
892 error_report_err(local_err
);
896 qprintf(quiet
, "Image committed.\n");
901 * Returns true iff the first sector pointed to by 'buf' contains at least
904 * 'pnum' is set to the number of sectors (including and immediately following
905 * the first one) that are known to be in the same allocated/unallocated state.
907 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
916 is_zero
= buffer_is_zero(buf
, 512);
917 for(i
= 1; i
< n
; i
++) {
919 if (is_zero
!= buffer_is_zero(buf
, 512)) {
928 * Like is_allocated_sectors, but if the buffer starts with a used sector,
929 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
930 * breaking up write requests for only small sparse areas.
932 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
936 int num_checked
, num_used
;
942 ret
= is_allocated_sectors(buf
, n
, pnum
);
948 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
950 num_checked
= num_used
;
953 ret
= is_allocated_sectors(buf
, n
, pnum
);
955 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
957 num_checked
+= *pnum
;
959 num_used
= num_checked
;
960 } else if (*pnum
>= min
) {
970 * Compares two buffers sector by sector. Returns 0 if the first sector of both
971 * buffers matches, non-zero otherwise.
973 * pnum is set to the number of sectors (including and immediately following
974 * the first one) that are known to have the same comparison result
976 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
986 res
= !!memcmp(buf1
, buf2
, 512);
987 for(i
= 1; i
< n
; i
++) {
991 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1000 #define IO_BUF_SIZE (2 * 1024 * 1024)
1002 static int64_t sectors_to_bytes(int64_t sectors
)
1004 return sectors
<< BDRV_SECTOR_BITS
;
1007 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1009 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1013 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1015 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1016 * data and negative value on error.
1018 * @param blk: BlockBackend for the image
1019 * @param sect_num: Number of first sector to check
1020 * @param sect_count: Number of sectors to check
1021 * @param filename: Name of disk file we are checking (logging purpose)
1022 * @param buffer: Allocated buffer for storing read data
1023 * @param quiet: Flag for quiet mode
1025 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1026 int sect_count
, const char *filename
,
1027 uint8_t *buffer
, bool quiet
)
1030 ret
= blk_read(blk
, sect_num
, buffer
, sect_count
);
1032 error_report("Error while reading offset %" PRId64
" of %s: %s",
1033 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1036 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1037 if (ret
|| pnum
!= sect_count
) {
1038 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1039 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1047 * Compares two images. Exit codes:
1049 * 0 - Images are identical
1051 * >1 - Error occurred
1053 static int img_compare(int argc
, char **argv
)
1055 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1056 BlockBackend
*blk1
, *blk2
;
1057 BlockDriverState
*bs1
, *bs2
;
1058 int64_t total_sectors1
, total_sectors2
;
1059 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1061 int allocated1
, allocated2
;
1062 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1063 bool progress
= false, quiet
= false, strict
= false;
1065 int64_t total_sectors
;
1066 int64_t sector_num
= 0;
1069 uint64_t progress_base
;
1071 cache
= BDRV_DEFAULT_CACHE
;
1073 c
= getopt(argc
, argv
, "hf:F:T:pqs");
1103 /* Progress is not shown in Quiet mode */
1109 if (optind
!= argc
- 2) {
1110 error_exit("Expecting two image file names");
1112 filename1
= argv
[optind
++];
1113 filename2
= argv
[optind
++];
1115 /* Initialize before goto out */
1116 qemu_progress_init(progress
, 2.0);
1118 flags
= BDRV_O_FLAGS
;
1119 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1121 error_report("Invalid source cache option: %s", cache
);
1126 blk1
= img_open("image_1", filename1
, fmt1
, flags
, true, quiet
);
1133 blk2
= img_open("image_2", filename2
, fmt2
, flags
, true, quiet
);
1140 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1141 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1142 total_sectors1
= blk_nb_sectors(blk1
);
1143 if (total_sectors1
< 0) {
1144 error_report("Can't get size of %s: %s",
1145 filename1
, strerror(-total_sectors1
));
1149 total_sectors2
= blk_nb_sectors(blk2
);
1150 if (total_sectors2
< 0) {
1151 error_report("Can't get size of %s: %s",
1152 filename2
, strerror(-total_sectors2
));
1156 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1157 progress_base
= MAX(total_sectors1
, total_sectors2
);
1159 qemu_progress_print(0, 100);
1161 if (strict
&& total_sectors1
!= total_sectors2
) {
1163 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1168 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1169 if (nb_sectors
<= 0) {
1172 allocated1
= bdrv_is_allocated_above(bs1
, NULL
, sector_num
, nb_sectors
,
1174 if (allocated1
< 0) {
1176 error_report("Sector allocation test failed for %s", filename1
);
1180 allocated2
= bdrv_is_allocated_above(bs2
, NULL
, sector_num
, nb_sectors
,
1182 if (allocated2
< 0) {
1184 error_report("Sector allocation test failed for %s", filename2
);
1187 nb_sectors
= MIN(pnum1
, pnum2
);
1189 if (allocated1
== allocated2
) {
1191 ret
= blk_read(blk1
, sector_num
, buf1
, nb_sectors
);
1193 error_report("Error while reading offset %" PRId64
" of %s:"
1194 " %s", sectors_to_bytes(sector_num
), filename1
,
1199 ret
= blk_read(blk2
, sector_num
, buf2
, nb_sectors
);
1201 error_report("Error while reading offset %" PRId64
1202 " of %s: %s", sectors_to_bytes(sector_num
),
1203 filename2
, strerror(-ret
));
1207 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1208 if (ret
|| pnum
!= nb_sectors
) {
1209 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1211 ret
? sector_num
: sector_num
+ pnum
));
1219 qprintf(quiet
, "Strict mode: Offset %" PRId64
1220 " allocation mismatch!\n",
1221 sectors_to_bytes(sector_num
));
1226 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1227 filename1
, buf1
, quiet
);
1229 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1230 filename2
, buf1
, quiet
);
1234 error_report("Error while reading offset %" PRId64
": %s",
1235 sectors_to_bytes(sector_num
), strerror(-ret
));
1241 sector_num
+= nb_sectors
;
1242 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1245 if (total_sectors1
!= total_sectors2
) {
1246 BlockBackend
*blk_over
;
1247 int64_t total_sectors_over
;
1248 const char *filename_over
;
1250 qprintf(quiet
, "Warning: Image size mismatch!\n");
1251 if (total_sectors1
> total_sectors2
) {
1252 total_sectors_over
= total_sectors1
;
1254 filename_over
= filename1
;
1256 total_sectors_over
= total_sectors2
;
1258 filename_over
= filename2
;
1262 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1263 if (nb_sectors
<= 0) {
1266 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1270 error_report("Sector allocation test failed for %s",
1277 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1278 filename_over
, buf1
, quiet
);
1281 error_report("Error while reading offset %" PRId64
1282 " of %s: %s", sectors_to_bytes(sector_num
),
1283 filename_over
, strerror(-ret
));
1289 sector_num
+= nb_sectors
;
1290 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1294 qprintf(quiet
, "Images are identical.\n");
1304 qemu_progress_end();
1308 static int img_convert(int argc
, char **argv
)
1310 int c
, n
, n1
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1312 int progress
= 0, flags
, src_flags
;
1313 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1314 BlockDriver
*drv
, *proto_drv
;
1315 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1316 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1317 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
1318 int64_t *bs_sectors
= NULL
;
1319 uint8_t * buf
= NULL
;
1320 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1321 const uint8_t *buf1
;
1322 BlockDriverInfo bdi
;
1323 QemuOpts
*opts
= NULL
;
1324 QemuOptsList
*create_opts
= NULL
;
1325 const char *out_baseimg_param
;
1326 char *options
= NULL
;
1327 const char *snapshot_name
= NULL
;
1328 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1330 Error
*local_err
= NULL
;
1331 QemuOpts
*sn_opts
= NULL
;
1336 src_cache
= BDRV_DEFAULT_CACHE
;
1341 c
= getopt(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1357 out_baseimg
= optarg
;
1363 error_report("option -e is deprecated, please use \'-o "
1364 "encryption\' instead!");
1368 error_report("option -6 is deprecated, please use \'-o "
1369 "compat6\' instead!");
1373 if (!is_valid_option_list(optarg
)) {
1374 error_report("Invalid option list: %s", optarg
);
1379 options
= g_strdup(optarg
);
1381 char *old_options
= options
;
1382 options
= g_strdup_printf("%s,%s", options
, optarg
);
1383 g_free(old_options
);
1387 snapshot_name
= optarg
;
1390 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1391 sn_opts
= qemu_opts_parse(&internal_snapshot_opts
, optarg
, 0);
1393 error_report("Failed in parsing snapshot param '%s'",
1399 snapshot_name
= optarg
;
1406 sval
= strtosz_suffix(optarg
, &end
, STRTOSZ_DEFSUFFIX_B
);
1407 if (sval
< 0 || *end
) {
1408 error_report("Invalid minimum zero buffer size for sparse output specified");
1413 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1434 /* Initialize before goto out */
1438 qemu_progress_init(progress
, 1.0);
1441 bs_n
= argc
- optind
- 1;
1442 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1444 if (options
&& has_help_option(options
)) {
1445 ret
= print_block_option_help(out_filename
, out_fmt
);
1450 error_exit("Must specify image file name");
1454 if (bs_n
> 1 && out_baseimg
) {
1455 error_report("-B makes no sense when concatenating multiple input "
1461 src_flags
= BDRV_O_FLAGS
;
1462 ret
= bdrv_parse_cache_flags(src_cache
, &src_flags
);
1464 error_report("Invalid source cache option: %s", src_cache
);
1468 qemu_progress_print(0, 100);
1470 blk
= g_new0(BlockBackend
*, bs_n
);
1471 bs
= g_new0(BlockDriverState
*, bs_n
);
1472 bs_sectors
= g_new(int64_t, bs_n
);
1475 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1476 char *id
= bs_n
> 1 ? g_strdup_printf("source_%d", bs_i
)
1477 : g_strdup("source");
1478 blk
[bs_i
] = img_open(id
, argv
[optind
+ bs_i
], fmt
, src_flags
,
1485 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1486 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
1487 if (bs_sectors
[bs_i
] < 0) {
1488 error_report("Could not get size of %s: %s",
1489 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1493 total_sectors
+= bs_sectors
[bs_i
];
1497 ret
= bdrv_snapshot_load_tmp(bs
[0],
1498 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1499 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1501 } else if (snapshot_name
!= NULL
) {
1503 error_report("No support for concatenating multiple snapshot");
1508 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1511 error_report("Failed to load snapshot: %s",
1512 error_get_pretty(local_err
));
1513 error_free(local_err
);
1518 /* Find driver and parse its options */
1519 drv
= bdrv_find_format(out_fmt
);
1521 error_report("Unknown file format '%s'", out_fmt
);
1526 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
1528 qerror_report_err(local_err
);
1529 error_free(local_err
);
1535 if (!drv
->create_opts
) {
1536 error_report("Format driver '%s' does not support image creation",
1542 if (!proto_drv
->create_opts
) {
1543 error_report("Protocol driver '%s' does not support image creation",
1544 proto_drv
->format_name
);
1549 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1550 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1552 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1554 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
1556 error_report("Invalid options for file format '%s'", out_fmt
);
1557 error_free(local_err
);
1563 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
1565 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
1571 /* Get backing file name if -o backing_file was used */
1572 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
1573 if (out_baseimg_param
) {
1574 out_baseimg
= out_baseimg_param
;
1577 /* Check if compression is supported */
1580 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
1581 const char *preallocation
=
1582 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
1584 if (!drv
->bdrv_write_compressed
) {
1585 error_report("Compression not supported for this file format");
1591 error_report("Compression and encryption not supported at "
1598 && strcmp(preallocation
, "off"))
1600 error_report("Compression and preallocation not supported at "
1608 /* Create the new image */
1609 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
1611 error_report("%s: error while converting %s: %s",
1612 out_filename
, out_fmt
, error_get_pretty(local_err
));
1613 error_free(local_err
);
1618 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
1619 ret
= bdrv_parse_cache_flags(cache
, &flags
);
1621 error_report("Invalid cache option: %s", cache
);
1625 out_blk
= img_open("target", out_filename
, out_fmt
, flags
, true, quiet
);
1630 out_bs
= blk_bs(out_blk
);
1635 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1636 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1638 bufsectors
= MIN(32768,
1639 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
1640 out_bs
->bl
.discard_alignment
))
1643 buf
= blk_blockalign(out_blk
, bufsectors
* BDRV_SECTOR_SIZE
);
1646 int64_t output_sectors
= blk_nb_sectors(out_blk
);
1647 if (output_sectors
< 0) {
1648 error_report("unable to get output image length: %s",
1649 strerror(-output_sectors
));
1652 } else if (output_sectors
< total_sectors
) {
1653 error_report("output file is smaller than input file");
1659 cluster_sectors
= 0;
1660 ret
= bdrv_get_info(out_bs
, &bdi
);
1663 error_report("could not get block driver info");
1667 compress
= compress
|| bdi
.needs_compressed_writes
;
1668 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
1672 if (cluster_sectors
<= 0 || cluster_sectors
> bufsectors
) {
1673 error_report("invalid cluster size");
1679 nb_sectors
= total_sectors
;
1686 nb_sectors
= total_sectors
- sector_num
;
1687 if (nb_sectors
<= 0)
1689 if (nb_sectors
>= cluster_sectors
)
1690 n
= cluster_sectors
;
1694 bs_num
= sector_num
- bs_offset
;
1695 assert (bs_num
>= 0);
1698 while (remainder
> 0) {
1700 while (bs_num
== bs_sectors
[bs_i
]) {
1701 bs_offset
+= bs_sectors
[bs_i
];
1703 assert (bs_i
< bs_n
);
1705 /* printf("changing part: sector_num=%" PRId64 ", "
1706 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1707 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1709 assert (bs_num
< bs_sectors
[bs_i
]);
1711 nlow
= remainder
> bs_sectors
[bs_i
] - bs_num
1712 ? bs_sectors
[bs_i
] - bs_num
: remainder
;
1714 ret
= blk_read(blk
[bs_i
], bs_num
, buf2
, nlow
);
1716 error_report("error while reading sector %" PRId64
": %s",
1717 bs_num
, strerror(-ret
));
1726 assert (remainder
== 0);
1728 if (!buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)) {
1729 ret
= blk_write_compressed(out_blk
, sector_num
, buf
, n
);
1731 error_report("error while compressing sector %" PRId64
1732 ": %s", sector_num
, strerror(-ret
));
1737 qemu_progress_print(100.0 * sector_num
/ total_sectors
, 0);
1739 /* signal EOF to align */
1740 blk_write_compressed(out_blk
, 0, NULL
, 0);
1742 int64_t sectors_to_read
, sectors_read
, sector_num_next_status
;
1743 bool count_allocated_sectors
;
1744 int has_zero_init
= min_sparse
? bdrv_has_zero_init(out_bs
) : 0;
1746 if (!has_zero_init
&& bdrv_can_write_zeroes_with_unmap(out_bs
)) {
1747 ret
= bdrv_make_zero(out_bs
, BDRV_REQ_MAY_UNMAP
);
1754 sectors_to_read
= total_sectors
;
1755 count_allocated_sectors
= progress
&& (out_baseimg
|| has_zero_init
);
1757 sector_num
= 0; // total number of sectors converted so far
1759 sector_num_next_status
= 0;
1762 nb_sectors
= total_sectors
- sector_num
;
1763 if (nb_sectors
<= 0) {
1764 if (count_allocated_sectors
) {
1765 sectors_to_read
= sectors_read
;
1766 count_allocated_sectors
= false;
1773 while (sector_num
- bs_offset
>= bs_sectors
[bs_i
]) {
1774 bs_offset
+= bs_sectors
[bs_i
];
1776 assert (bs_i
< bs_n
);
1777 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1778 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1779 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1782 if ((out_baseimg
|| has_zero_init
) &&
1783 sector_num
>= sector_num_next_status
) {
1784 n
= nb_sectors
> INT_MAX
? INT_MAX
: nb_sectors
;
1785 ret
= bdrv_get_block_status(bs
[bs_i
], sector_num
- bs_offset
,
1788 error_report("error while reading block status of sector %"
1789 PRId64
": %s", sector_num
- bs_offset
,
1793 /* If the output image is zero initialized, we are not working
1794 * on a shared base and the input is zero we can skip the next
1796 if (has_zero_init
&& !out_baseimg
&& (ret
& BDRV_BLOCK_ZERO
)) {
1800 /* If the output image is being created as a copy on write
1801 * image, assume that sectors which are unallocated in the
1802 * input image are present in both the output's and input's
1803 * base images (no need to copy them). */
1805 if (!(ret
& BDRV_BLOCK_DATA
)) {
1809 /* The next 'n1' sectors are allocated in the input image.
1810 * Copy only those as they may be followed by unallocated
1814 /* avoid redundant callouts to get_block_status */
1815 sector_num_next_status
= sector_num
+ n1
;
1818 n
= MIN(nb_sectors
, bufsectors
);
1820 /* round down request length to an aligned sector, but
1821 * do not bother doing this on short requests. They happen
1822 * when we found an all-zero area, and the next sector to
1823 * write will not be sector_num + n. */
1824 if (cluster_sectors
> 0 && n
>= cluster_sectors
) {
1825 int64_t next_aligned_sector
= (sector_num
+ n
);
1826 next_aligned_sector
-= next_aligned_sector
% cluster_sectors
;
1827 if (sector_num
+ n
> next_aligned_sector
) {
1828 n
= next_aligned_sector
- sector_num
;
1832 n
= MIN(n
, bs_sectors
[bs_i
] - (sector_num
- bs_offset
));
1835 if (count_allocated_sectors
) {
1841 ret
= blk_read(blk
[bs_i
], sector_num
- bs_offset
, buf
, n
);
1843 error_report("error while reading sector %" PRId64
": %s",
1844 sector_num
- bs_offset
, strerror(-ret
));
1847 /* NOTE: at the same time we convert, we do not write zero
1848 sectors to have a chance to compress the image. Ideally, we
1849 should add a specific call to have the info to go faster */
1852 if (!has_zero_init
||
1853 is_allocated_sectors_min(buf1
, n
, &n1
, min_sparse
)) {
1854 ret
= blk_write(out_blk
, sector_num
, buf1
, n1
);
1856 error_report("error while writing sector %" PRId64
1857 ": %s", sector_num
, strerror(-ret
));
1865 qemu_progress_print(100.0 * sectors_read
/ sectors_to_read
, 0);
1870 qemu_progress_print(100, 0);
1872 qemu_progress_end();
1873 qemu_opts_del(opts
);
1874 qemu_opts_free(create_opts
);
1876 qemu_opts_del(sn_opts
);
1880 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1881 blk_unref(blk
[bs_i
]);
1896 static void dump_snapshots(BlockDriverState
*bs
)
1898 QEMUSnapshotInfo
*sn_tab
, *sn
;
1901 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
1904 printf("Snapshot list:\n");
1905 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
1907 for(i
= 0; i
< nb_sns
; i
++) {
1909 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
1915 static void dump_json_image_info_list(ImageInfoList
*list
)
1917 Error
*local_err
= NULL
;
1919 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1921 visit_type_ImageInfoList(qmp_output_get_visitor(ov
),
1922 &list
, NULL
, &local_err
);
1923 obj
= qmp_output_get_qobject(ov
);
1924 str
= qobject_to_json_pretty(obj
);
1925 assert(str
!= NULL
);
1926 printf("%s\n", qstring_get_str(str
));
1927 qobject_decref(obj
);
1928 qmp_output_visitor_cleanup(ov
);
1932 static void dump_json_image_info(ImageInfo
*info
)
1934 Error
*local_err
= NULL
;
1936 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
1938 visit_type_ImageInfo(qmp_output_get_visitor(ov
),
1939 &info
, NULL
, &local_err
);
1940 obj
= qmp_output_get_qobject(ov
);
1941 str
= qobject_to_json_pretty(obj
);
1942 assert(str
!= NULL
);
1943 printf("%s\n", qstring_get_str(str
));
1944 qobject_decref(obj
);
1945 qmp_output_visitor_cleanup(ov
);
1949 static void dump_human_image_info_list(ImageInfoList
*list
)
1951 ImageInfoList
*elem
;
1954 for (elem
= list
; elem
; elem
= elem
->next
) {
1960 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
1964 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
1966 return strcmp(a
, b
) == 0;
1970 * Open an image file chain and return an ImageInfoList
1972 * @filename: topmost image filename
1973 * @fmt: topmost image format (may be NULL to autodetect)
1974 * @chain: true - enumerate entire backing file chain
1975 * false - only topmost image file
1977 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1978 * image file. If there was an error a message will have been printed to
1981 static ImageInfoList
*collect_image_info_list(const char *filename
,
1985 ImageInfoList
*head
= NULL
;
1986 ImageInfoList
**last
= &head
;
1987 GHashTable
*filenames
;
1990 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
1994 BlockDriverState
*bs
;
1996 ImageInfoList
*elem
;
1998 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
1999 error_report("Backing file '%s' creates an infinite loop.",
2003 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2005 blk
= img_open("image", filename
, fmt
,
2006 BDRV_O_FLAGS
| BDRV_O_NO_BACKING
, false, false);
2012 bdrv_query_image_info(bs
, &info
, &err
);
2014 error_report_err(err
);
2019 elem
= g_new0(ImageInfoList
, 1);
2026 filename
= fmt
= NULL
;
2028 if (info
->has_full_backing_filename
) {
2029 filename
= info
->full_backing_filename
;
2030 } else if (info
->has_backing_filename
) {
2031 filename
= info
->backing_filename
;
2033 if (info
->has_backing_filename_format
) {
2034 fmt
= info
->backing_filename_format
;
2038 g_hash_table_destroy(filenames
);
2042 qapi_free_ImageInfoList(head
);
2043 g_hash_table_destroy(filenames
);
2047 static int img_info(int argc
, char **argv
)
2050 OutputFormat output_format
= OFORMAT_HUMAN
;
2052 const char *filename
, *fmt
, *output
;
2053 ImageInfoList
*list
;
2058 int option_index
= 0;
2059 static const struct option long_options
[] = {
2060 {"help", no_argument
, 0, 'h'},
2061 {"format", required_argument
, 0, 'f'},
2062 {"output", required_argument
, 0, OPTION_OUTPUT
},
2063 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2066 c
= getopt_long(argc
, argv
, "f:h",
2067 long_options
, &option_index
);
2082 case OPTION_BACKING_CHAIN
:
2087 if (optind
!= argc
- 1) {
2088 error_exit("Expecting one image file name");
2090 filename
= argv
[optind
++];
2092 if (output
&& !strcmp(output
, "json")) {
2093 output_format
= OFORMAT_JSON
;
2094 } else if (output
&& !strcmp(output
, "human")) {
2095 output_format
= OFORMAT_HUMAN
;
2096 } else if (output
) {
2097 error_report("--output must be used with human or json as argument.");
2101 list
= collect_image_info_list(filename
, fmt
, chain
);
2106 switch (output_format
) {
2108 dump_human_image_info_list(list
);
2112 dump_json_image_info_list(list
);
2114 dump_json_image_info(list
->value
);
2119 qapi_free_ImageInfoList(list
);
2124 typedef struct MapEntry
{
2130 BlockDriverState
*bs
;
2133 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2136 switch (output_format
) {
2138 if ((e
->flags
& BDRV_BLOCK_DATA
) &&
2139 !(e
->flags
& BDRV_BLOCK_OFFSET_VALID
)) {
2140 error_report("File contains external, encrypted or compressed clusters.");
2143 if ((e
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) == BDRV_BLOCK_DATA
) {
2144 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2145 e
->start
, e
->length
, e
->offset
, e
->bs
->filename
);
2147 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2148 * Modify the flags here to allow more coalescing.
2151 (next
->flags
& (BDRV_BLOCK_DATA
|BDRV_BLOCK_ZERO
)) != BDRV_BLOCK_DATA
) {
2152 next
->flags
&= ~BDRV_BLOCK_DATA
;
2153 next
->flags
|= BDRV_BLOCK_ZERO
;
2157 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
", \"depth\": %d,"
2158 " \"zero\": %s, \"data\": %s",
2159 (e
->start
== 0 ? "[" : ",\n"),
2160 e
->start
, e
->length
, e
->depth
,
2161 (e
->flags
& BDRV_BLOCK_ZERO
) ? "true" : "false",
2162 (e
->flags
& BDRV_BLOCK_DATA
) ? "true" : "false");
2163 if (e
->flags
& BDRV_BLOCK_OFFSET_VALID
) {
2164 printf(", \"offset\": %"PRId64
"", e
->offset
);
2175 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2176 int nb_sectors
, MapEntry
*e
)
2181 /* As an optimization, we could cache the current range of unallocated
2182 * clusters in each file of the chain, and avoid querying the same
2188 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
);
2193 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2196 bs
= bs
->backing_hd
;
2205 e
->start
= sector_num
* BDRV_SECTOR_SIZE
;
2206 e
->length
= nb_sectors
* BDRV_SECTOR_SIZE
;
2207 e
->flags
= ret
& ~BDRV_BLOCK_OFFSET_MASK
;
2208 e
->offset
= ret
& BDRV_BLOCK_OFFSET_MASK
;
2214 static int img_map(int argc
, char **argv
)
2217 OutputFormat output_format
= OFORMAT_HUMAN
;
2219 BlockDriverState
*bs
;
2220 const char *filename
, *fmt
, *output
;
2222 MapEntry curr
= { .length
= 0 }, next
;
2228 int option_index
= 0;
2229 static const struct option long_options
[] = {
2230 {"help", no_argument
, 0, 'h'},
2231 {"format", required_argument
, 0, 'f'},
2232 {"output", required_argument
, 0, OPTION_OUTPUT
},
2235 c
= getopt_long(argc
, argv
, "f:h",
2236 long_options
, &option_index
);
2253 if (optind
!= argc
- 1) {
2254 error_exit("Expecting one image file name");
2256 filename
= argv
[optind
];
2258 if (output
&& !strcmp(output
, "json")) {
2259 output_format
= OFORMAT_JSON
;
2260 } else if (output
&& !strcmp(output
, "human")) {
2261 output_format
= OFORMAT_HUMAN
;
2262 } else if (output
) {
2263 error_report("--output must be used with human or json as argument.");
2267 blk
= img_open("image", filename
, fmt
, BDRV_O_FLAGS
, true, false);
2273 if (output_format
== OFORMAT_HUMAN
) {
2274 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2277 length
= blk_getlength(blk
);
2278 while (curr
.start
+ curr
.length
< length
) {
2279 int64_t nsectors_left
;
2283 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2285 /* Probe up to 1 GiB at a time. */
2286 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2287 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2288 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2291 error_report("Could not read file metadata: %s", strerror(-ret
));
2295 if (curr
.length
!= 0 && curr
.flags
== next
.flags
&&
2296 curr
.depth
== next
.depth
&&
2297 ((curr
.flags
& BDRV_BLOCK_OFFSET_VALID
) == 0 ||
2298 curr
.offset
+ curr
.length
== next
.offset
)) {
2299 curr
.length
+= next
.length
;
2303 if (curr
.length
> 0) {
2304 dump_map_entry(output_format
, &curr
, &next
);
2309 dump_map_entry(output_format
, &curr
, NULL
);
2316 #define SNAPSHOT_LIST 1
2317 #define SNAPSHOT_CREATE 2
2318 #define SNAPSHOT_APPLY 3
2319 #define SNAPSHOT_DELETE 4
2321 static int img_snapshot(int argc
, char **argv
)
2324 BlockDriverState
*bs
;
2325 QEMUSnapshotInfo sn
;
2326 char *filename
, *snapshot_name
= NULL
;
2327 int c
, ret
= 0, bdrv_oflags
;
2333 bdrv_oflags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2334 /* Parse commandline parameters */
2336 c
= getopt(argc
, argv
, "la:c:d:hq");
2347 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2350 action
= SNAPSHOT_LIST
;
2351 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2355 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2358 action
= SNAPSHOT_APPLY
;
2359 snapshot_name
= optarg
;
2363 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2366 action
= SNAPSHOT_CREATE
;
2367 snapshot_name
= optarg
;
2371 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2374 action
= SNAPSHOT_DELETE
;
2375 snapshot_name
= optarg
;
2383 if (optind
!= argc
- 1) {
2384 error_exit("Expecting one image file name");
2386 filename
= argv
[optind
++];
2388 /* Open the image */
2389 blk
= img_open("image", filename
, NULL
, bdrv_oflags
, true, quiet
);
2395 /* Perform the requested action */
2401 case SNAPSHOT_CREATE
:
2402 memset(&sn
, 0, sizeof(sn
));
2403 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2405 qemu_gettimeofday(&tv
);
2406 sn
.date_sec
= tv
.tv_sec
;
2407 sn
.date_nsec
= tv
.tv_usec
* 1000;
2409 ret
= bdrv_snapshot_create(bs
, &sn
);
2411 error_report("Could not create snapshot '%s': %d (%s)",
2412 snapshot_name
, ret
, strerror(-ret
));
2416 case SNAPSHOT_APPLY
:
2417 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2419 error_report("Could not apply snapshot '%s': %d (%s)",
2420 snapshot_name
, ret
, strerror(-ret
));
2424 case SNAPSHOT_DELETE
:
2425 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2427 error_report("Could not delete snapshot '%s': (%s)",
2428 snapshot_name
, error_get_pretty(err
));
2443 static int img_rebase(int argc
, char **argv
)
2445 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2446 BlockDriverState
*bs
= NULL
;
2448 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2449 int c
, flags
, src_flags
, ret
;
2453 Error
*local_err
= NULL
;
2455 /* Parse commandline parameters */
2457 cache
= BDRV_DEFAULT_CACHE
;
2458 src_cache
= BDRV_DEFAULT_CACHE
;
2462 c
= getopt(argc
, argv
, "hf:F:b:upt:T:q");
2475 out_basefmt
= optarg
;
2478 out_baseimg
= optarg
;
2502 if (optind
!= argc
- 1) {
2503 error_exit("Expecting one image file name");
2505 if (!unsafe
&& !out_baseimg
) {
2506 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2508 filename
= argv
[optind
++];
2510 qemu_progress_init(progress
, 2.0);
2511 qemu_progress_print(0, 100);
2513 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2514 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2516 error_report("Invalid cache option: %s", cache
);
2520 src_flags
= BDRV_O_FLAGS
;
2521 ret
= bdrv_parse_cache_flags(src_cache
, &src_flags
);
2523 error_report("Invalid source cache option: %s", src_cache
);
2530 * Ignore the old backing file for unsafe rebase in case we want to correct
2531 * the reference to a renamed or moved backing file.
2533 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
2540 if (out_basefmt
!= NULL
) {
2541 if (bdrv_find_format(out_basefmt
) == NULL
) {
2542 error_report("Invalid format name: '%s'", out_basefmt
);
2548 /* For safe rebasing we need to compare old and new backing file */
2550 char backing_name
[PATH_MAX
];
2551 QDict
*options
= NULL
;
2553 if (bs
->backing_format
[0] != '\0') {
2554 options
= qdict_new();
2555 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
2558 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2559 blk_old_backing
= blk_new_open("old_backing", backing_name
, NULL
,
2560 options
, src_flags
, &local_err
);
2561 if (!blk_old_backing
) {
2562 error_report("Could not open old backing file '%s': %s",
2563 backing_name
, error_get_pretty(local_err
));
2564 error_free(local_err
);
2568 if (out_baseimg
[0]) {
2570 options
= qdict_new();
2571 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
2576 blk_new_backing
= blk_new_open("new_backing", out_baseimg
, NULL
,
2577 options
, src_flags
, &local_err
);
2578 if (!blk_new_backing
) {
2579 error_report("Could not open new backing file '%s': %s",
2580 out_baseimg
, error_get_pretty(local_err
));
2581 error_free(local_err
);
2588 * Check each unallocated cluster in the COW file. If it is unallocated,
2589 * accesses go to the backing file. We must therefore compare this cluster
2590 * in the old and new backing file, and if they differ we need to copy it
2591 * from the old backing file into the COW file.
2593 * If qemu-img crashes during this step, no harm is done. The content of
2594 * the image is the same as the original one at any time.
2597 int64_t num_sectors
;
2598 int64_t old_backing_num_sectors
;
2599 int64_t new_backing_num_sectors
= 0;
2604 float local_progress
= 0;
2606 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
2607 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
2609 num_sectors
= blk_nb_sectors(blk
);
2610 if (num_sectors
< 0) {
2611 error_report("Could not get size of '%s': %s",
2612 filename
, strerror(-num_sectors
));
2616 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
2617 if (old_backing_num_sectors
< 0) {
2618 char backing_name
[PATH_MAX
];
2620 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2621 error_report("Could not get size of '%s': %s",
2622 backing_name
, strerror(-old_backing_num_sectors
));
2626 if (blk_new_backing
) {
2627 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
2628 if (new_backing_num_sectors
< 0) {
2629 error_report("Could not get size of '%s': %s",
2630 out_baseimg
, strerror(-new_backing_num_sectors
));
2636 if (num_sectors
!= 0) {
2637 local_progress
= (float)100 /
2638 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
2641 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
2643 /* How many sectors can we handle with the next read? */
2644 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
2645 n
= (IO_BUF_SIZE
/ 512);
2647 n
= num_sectors
- sector
;
2650 /* If the cluster is allocated, we don't need to take action */
2651 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
2653 error_report("error while reading image metadata: %s",
2662 * Read old and new backing file and take into consideration that
2663 * backing files may be smaller than the COW image.
2665 if (sector
>= old_backing_num_sectors
) {
2666 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
2668 if (sector
+ n
> old_backing_num_sectors
) {
2669 n
= old_backing_num_sectors
- sector
;
2672 ret
= blk_read(blk_old_backing
, sector
, buf_old
, n
);
2674 error_report("error while reading from old backing file");
2679 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
2680 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
2682 if (sector
+ n
> new_backing_num_sectors
) {
2683 n
= new_backing_num_sectors
- sector
;
2686 ret
= blk_read(blk_new_backing
, sector
, buf_new
, n
);
2688 error_report("error while reading from new backing file");
2693 /* If they differ, we need to write to the COW file */
2694 uint64_t written
= 0;
2696 while (written
< n
) {
2699 if (compare_sectors(buf_old
+ written
* 512,
2700 buf_new
+ written
* 512, n
- written
, &pnum
))
2702 ret
= blk_write(blk
, sector
+ written
,
2703 buf_old
+ written
* 512, pnum
);
2705 error_report("Error while writing to COW image: %s",
2713 qemu_progress_print(local_progress
, 100);
2716 qemu_vfree(buf_old
);
2717 qemu_vfree(buf_new
);
2721 * Change the backing file. All clusters that are different from the old
2722 * backing file are overwritten in the COW file now, so the visible content
2723 * doesn't change when we switch the backing file.
2725 if (out_baseimg
&& *out_baseimg
) {
2726 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
2728 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
2731 if (ret
== -ENOSPC
) {
2732 error_report("Could not change the backing file to '%s': No "
2733 "space left in the file header", out_baseimg
);
2734 } else if (ret
< 0) {
2735 error_report("Could not change the backing file to '%s': %s",
2736 out_baseimg
, strerror(-ret
));
2739 qemu_progress_print(100, 0);
2741 * TODO At this point it is possible to check if any clusters that are
2742 * allocated in the COW file are the same in the backing file. If so, they
2743 * could be dropped from the COW file. Don't do this before switching the
2744 * backing file, in case of a crash this would lead to corruption.
2747 qemu_progress_end();
2750 blk_unref(blk_old_backing
);
2751 blk_unref(blk_new_backing
);
2761 static int img_resize(int argc
, char **argv
)
2764 int c
, ret
, relative
;
2765 const char *filename
, *fmt
, *size
;
2766 int64_t n
, total_size
;
2768 BlockBackend
*blk
= NULL
;
2770 static QemuOptsList resize_options
= {
2771 .name
= "resize_options",
2772 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
2775 .name
= BLOCK_OPT_SIZE
,
2776 .type
= QEMU_OPT_SIZE
,
2777 .help
= "Virtual disk size"
2784 /* Remove size from argv manually so that negative numbers are not treated
2785 * as options by getopt. */
2787 error_exit("Not enough arguments");
2791 size
= argv
[--argc
];
2793 /* Parse getopt arguments */
2796 c
= getopt(argc
, argv
, "f:hq");
2813 if (optind
!= argc
- 1) {
2814 error_exit("Expecting one image file name");
2816 filename
= argv
[optind
++];
2818 /* Choose grow, shrink, or absolute resize mode */
2834 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
2835 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
2837 error_report_err(err
);
2839 qemu_opts_del(param
);
2842 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
2843 qemu_opts_del(param
);
2845 blk
= img_open("image", filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
,
2853 total_size
= blk_getlength(blk
) + n
* relative
;
2857 if (total_size
<= 0) {
2858 error_report("New image size must be positive");
2863 ret
= blk_truncate(blk
, total_size
);
2866 qprintf(quiet
, "Image resized.\n");
2869 error_report("This image does not support resize");
2872 error_report("Image is read-only");
2875 error_report("Error resizing image (%d)", -ret
);
2886 static void amend_status_cb(BlockDriverState
*bs
,
2887 int64_t offset
, int64_t total_work_size
)
2889 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
2892 static int img_amend(int argc
, char **argv
)
2896 char *options
= NULL
;
2897 QemuOptsList
*create_opts
= NULL
;
2898 QemuOpts
*opts
= NULL
;
2899 const char *fmt
= NULL
, *filename
, *cache
;
2901 bool quiet
= false, progress
= false;
2902 BlockBackend
*blk
= NULL
;
2903 BlockDriverState
*bs
= NULL
;
2905 cache
= BDRV_DEFAULT_CACHE
;
2907 c
= getopt(argc
, argv
, "ho:f:t:pq");
2918 if (!is_valid_option_list(optarg
)) {
2919 error_report("Invalid option list: %s", optarg
);
2924 options
= g_strdup(optarg
);
2926 char *old_options
= options
;
2927 options
= g_strdup_printf("%s,%s", options
, optarg
);
2928 g_free(old_options
);
2947 error_exit("Must specify options (-o)");
2953 qemu_progress_init(progress
, 1.0);
2955 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
2956 if (fmt
&& has_help_option(options
)) {
2957 /* If a format is explicitly specified (and possibly no filename is
2958 * given), print option help here */
2959 ret
= print_block_option_help(filename
, fmt
);
2963 if (optind
!= argc
- 1) {
2964 error_report("Expecting one image file name");
2969 flags
= BDRV_O_FLAGS
| BDRV_O_RDWR
;
2970 ret
= bdrv_parse_cache_flags(cache
, &flags
);
2972 error_report("Invalid cache option: %s", cache
);
2976 blk
= img_open("image", filename
, fmt
, flags
, true, quiet
);
2983 fmt
= bs
->drv
->format_name
;
2985 if (has_help_option(options
)) {
2986 /* If the format was auto-detected, print option help here */
2987 ret
= print_block_option_help(filename
, fmt
);
2991 if (!bs
->drv
->create_opts
) {
2992 error_report("Format driver '%s' does not support any options to amend",
2998 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
2999 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3001 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3003 error_report("Invalid options for file format '%s'", fmt
);
3010 /* In case the driver does not call amend_status_cb() */
3011 qemu_progress_print(0.f
, 0);
3012 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
);
3013 qemu_progress_print(100.f
, 0);
3015 error_report("Error while amending options: %s", strerror(-ret
));
3020 qemu_progress_end();
3023 qemu_opts_del(opts
);
3024 qemu_opts_free(create_opts
);
3033 static const img_cmd_t img_cmds
[] = {
3034 #define DEF(option, callback, arg_string) \
3035 { option, callback },
3036 #include "qemu-img-cmds.h"
3042 int main(int argc
, char **argv
)
3044 const img_cmd_t
*cmd
;
3045 const char *cmdname
;
3046 Error
*local_error
= NULL
;
3048 static const struct option long_options
[] = {
3049 {"help", no_argument
, 0, 'h'},
3050 {"version", no_argument
, 0, 'v'},
3055 signal(SIGPIPE
, SIG_IGN
);
3058 error_set_progname(argv
[0]);
3059 qemu_init_exec_dir(argv
[0]);
3061 if (qemu_init_main_loop(&local_error
)) {
3062 error_report_err(local_error
);
3068 error_exit("Not enough arguments");
3072 /* find the command */
3073 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
3074 if (!strcmp(cmdname
, cmd
->name
)) {
3075 return cmd
->handler(argc
- 1, argv
+ 1);
3079 c
= getopt_long(argc
, argv
, "h", long_options
, NULL
);
3085 printf(QEMU_IMG_VERSION
);
3090 error_exit("Command not found: %s", cmdname
);