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 "qemu/osdep.h"
25 #include "qapi/error.h"
26 #include "qapi-visit.h"
27 #include "qapi/qmp-output-visitor.h"
28 #include "qapi/qmp/qerror.h"
29 #include "qapi/qmp/qjson.h"
30 #include "qemu/cutils.h"
31 #include "qemu/config-file.h"
32 #include "qemu/option.h"
33 #include "qemu/error-report.h"
34 #include "qom/object_interfaces.h"
35 #include "sysemu/sysemu.h"
36 #include "sysemu/block-backend.h"
37 #include "block/block_int.h"
38 #include "block/blockjob.h"
39 #include "block/qapi.h"
40 #include "crypto/init.h"
43 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
44 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
46 typedef struct img_cmd_t
{
48 int (*handler
)(int argc
, char **argv
);
53 OPTION_BACKING_CHAIN
= 257,
55 OPTION_IMAGE_OPTS
= 259,
58 typedef enum OutputFormat
{
63 /* Default to cache=writeback as data integrity is not important for qemu-img */
64 #define BDRV_DEFAULT_CACHE "writeback"
66 static void format_print(void *opaque
, const char *name
)
71 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
75 error_printf("qemu-img: ");
78 error_vprintf(fmt
, ap
);
81 error_printf("\nTry 'qemu-img --help' for more information\n");
85 /* Please keep in synch with qemu-img.texi */
86 static void QEMU_NORETURN
help(void)
88 const char *help_msg
=
90 "usage: qemu-img command [command options]\n"
91 "QEMU disk image utility\n"
94 #define DEF(option, callback, arg_string) \
96 #include "qemu-img-cmds.h"
100 "Command parameters:\n"
101 " 'filename' is a disk image filename\n"
102 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
103 " manual page for a description of the object properties. The most common\n"
104 " object type is a 'secret', which is used to supply passwords and/or\n"
105 " encryption keys.\n"
106 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
107 " 'cache' is the cache mode used to write the output disk image, the valid\n"
108 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
109 " 'directsync' and 'unsafe' (default for convert)\n"
110 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
111 " options are the same as for the 'cache' option\n"
112 " 'size' is the disk image size in bytes. Optional suffixes\n"
113 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
114 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
115 " supported. 'b' is ignored.\n"
116 " 'output_filename' is the destination disk image filename\n"
117 " 'output_fmt' is the destination format\n"
118 " 'options' is a comma separated list of format specific options in a\n"
119 " name=value format. Use -o ? for an overview of the options supported by the\n"
121 " 'snapshot_param' is param used for internal snapshot, format\n"
122 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
124 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
126 " '-c' indicates that target image must be compressed (qcow format only)\n"
127 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
128 " match exactly. The image doesn't need a working backing file before\n"
129 " rebasing in this case (useful for renaming the backing file)\n"
130 " '-h' with or without a command shows this help and lists the supported formats\n"
131 " '-p' show progress of command (only certain commands)\n"
132 " '-q' use Quiet mode - do not print any output (except errors)\n"
133 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
134 " contain only zeros for qemu-img to create a sparse image during\n"
135 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
136 " unallocated or zero sectors, and the destination image will always be\n"
138 " '--output' takes the format in which the output must be done (human or json)\n"
139 " '-n' skips the target volume creation (useful if the volume is created\n"
140 " prior to running qemu-img)\n"
142 "Parameters to check subcommand:\n"
143 " '-r' tries to repair any inconsistencies that are found during the check.\n"
144 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
145 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
146 " hiding corruption that has already occurred.\n"
148 "Parameters to snapshot subcommand:\n"
149 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
150 " '-a' applies a snapshot (revert disk to saved state)\n"
151 " '-c' creates a snapshot\n"
152 " '-d' deletes a snapshot\n"
153 " '-l' lists all snapshots in the given image\n"
155 "Parameters to compare subcommand:\n"
156 " '-f' first image format\n"
157 " '-F' second image format\n"
158 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
160 printf("%s\nSupported formats:", help_msg
);
161 bdrv_iterate_format(format_print
, NULL
);
166 static QemuOptsList qemu_object_opts
= {
168 .implied_opt_name
= "qom-type",
169 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
175 static QemuOptsList qemu_source_opts
= {
177 .implied_opt_name
= "file",
178 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
184 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
190 ret
= vprintf(fmt
, args
);
197 static int print_block_option_help(const char *filename
, const char *fmt
)
199 BlockDriver
*drv
, *proto_drv
;
200 QemuOptsList
*create_opts
= NULL
;
201 Error
*local_err
= NULL
;
203 /* Find driver and parse its options */
204 drv
= bdrv_find_format(fmt
);
206 error_report("Unknown file format '%s'", fmt
);
210 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
212 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
214 error_report_err(local_err
);
215 qemu_opts_free(create_opts
);
218 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
221 qemu_opts_print_help(create_opts
);
222 qemu_opts_free(create_opts
);
227 static int img_open_password(BlockBackend
*blk
, const char *filename
,
228 int flags
, bool quiet
)
230 BlockDriverState
*bs
;
234 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
235 !(flags
& BDRV_O_NO_IO
)) {
236 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
237 if (qemu_read_password(password
, sizeof(password
)) < 0) {
238 error_report("No password given");
241 if (bdrv_set_key(bs
, password
) < 0) {
242 error_report("invalid password");
250 static BlockBackend
*img_open_opts(const char *optstr
,
251 QemuOpts
*opts
, int flags
, bool writethrough
,
255 Error
*local_err
= NULL
;
257 options
= qemu_opts_to_qdict(opts
, NULL
);
258 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
260 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
263 blk_set_enable_write_cache(blk
, !writethrough
);
265 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
272 static BlockBackend
*img_open_file(const char *filename
,
273 const char *fmt
, int flags
,
274 bool writethrough
, bool quiet
)
277 Error
*local_err
= NULL
;
278 QDict
*options
= NULL
;
281 options
= qdict_new();
282 qdict_put(options
, "driver", qstring_from_str(fmt
));
285 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
287 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
290 blk_set_enable_write_cache(blk
, !writethrough
);
292 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
300 static BlockBackend
*img_open(bool image_opts
,
301 const char *filename
,
302 const char *fmt
, int flags
, bool writethrough
,
309 error_report("--image-opts and --format are mutually exclusive");
312 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
317 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
);
319 blk
= img_open_file(filename
, fmt
, flags
, writethrough
, quiet
);
325 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
326 const char *base_filename
,
327 const char *base_fmt
)
332 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
334 error_report("Backing file not supported for file format '%s'",
341 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
343 error_report("Backing file format not supported for file "
352 static int img_create(int argc
, char **argv
)
355 uint64_t img_size
= -1;
356 const char *fmt
= "raw";
357 const char *base_fmt
= NULL
;
358 const char *filename
;
359 const char *base_filename
= NULL
;
360 char *options
= NULL
;
361 Error
*local_err
= NULL
;
365 static const struct option long_options
[] = {
366 {"help", no_argument
, 0, 'h'},
367 {"object", required_argument
, 0, OPTION_OBJECT
},
370 c
= getopt_long(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
);
413 case OPTION_OBJECT
: {
415 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
424 /* Get the filename */
425 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
426 if (options
&& has_help_option(options
)) {
428 return print_block_option_help(filename
, fmt
);
431 if (optind
>= argc
) {
432 error_exit("Expecting image file name");
436 if (qemu_opts_foreach(&qemu_object_opts
,
437 user_creatable_add_opts_foreach
,
442 /* Get image size, if specified */
446 sval
= qemu_strtosz_suffix(argv
[optind
++], &end
,
447 QEMU_STRTOSZ_DEFSUFFIX_B
);
448 if (sval
< 0 || *end
) {
449 if (sval
== -ERANGE
) {
450 error_report("Image size must be less than 8 EiB!");
452 error_report("Invalid image size specified! You may use k, M, "
453 "G, T, P or E suffixes for ");
454 error_report("kilobytes, megabytes, gigabytes, terabytes, "
455 "petabytes and exabytes.");
459 img_size
= (uint64_t)sval
;
461 if (optind
!= argc
) {
462 error_exit("Unexpected argument: %s", argv
[optind
]);
465 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
466 options
, img_size
, 0, &local_err
, quiet
);
468 error_reportf_err(local_err
, "%s: ", filename
);
480 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
482 Error
*local_err
= NULL
;
484 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
486 visit_type_ImageCheck(qmp_output_get_visitor(ov
), NULL
, &check
,
488 obj
= qmp_output_get_qobject(ov
);
489 str
= qobject_to_json_pretty(obj
);
491 qprintf(quiet
, "%s\n", qstring_get_str(str
));
493 qmp_output_visitor_cleanup(ov
);
497 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
499 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
500 qprintf(quiet
, "No errors were found on the image.\n");
502 if (check
->corruptions
) {
503 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
504 "Data may be corrupted, or further writes to the image "
511 "\n%" PRId64
" leaked clusters were found on the image.\n"
512 "This means waste of disk space, but no harm to data.\n",
516 if (check
->check_errors
) {
519 " internal errors have occurred during the check.\n",
520 check
->check_errors
);
524 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
525 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
526 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
527 check
->allocated_clusters
, check
->total_clusters
,
528 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
529 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
530 check
->compressed_clusters
* 100.0 /
531 check
->allocated_clusters
);
534 if (check
->image_end_offset
) {
536 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
540 static int collect_image_check(BlockDriverState
*bs
,
542 const char *filename
,
547 BdrvCheckResult result
;
549 ret
= bdrv_check(bs
, &result
, fix
);
554 check
->filename
= g_strdup(filename
);
555 check
->format
= g_strdup(bdrv_get_format_name(bs
));
556 check
->check_errors
= result
.check_errors
;
557 check
->corruptions
= result
.corruptions
;
558 check
->has_corruptions
= result
.corruptions
!= 0;
559 check
->leaks
= result
.leaks
;
560 check
->has_leaks
= result
.leaks
!= 0;
561 check
->corruptions_fixed
= result
.corruptions_fixed
;
562 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
563 check
->leaks_fixed
= result
.leaks_fixed
;
564 check
->has_leaks_fixed
= result
.leaks
!= 0;
565 check
->image_end_offset
= result
.image_end_offset
;
566 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
567 check
->total_clusters
= result
.bfi
.total_clusters
;
568 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
569 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
570 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
571 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
572 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
573 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
574 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
580 * Checks an image for consistency. Exit codes:
582 * 0 - Check completed, image is good
583 * 1 - Check not completed because of internal errors
584 * 2 - Check completed, image is corrupted
585 * 3 - Check completed, image has leaked clusters, but is good otherwise
586 * 63 - Checks are not supported by the image format
588 static int img_check(int argc
, char **argv
)
591 OutputFormat output_format
= OFORMAT_HUMAN
;
592 const char *filename
, *fmt
, *output
, *cache
;
594 BlockDriverState
*bs
;
596 int flags
= BDRV_O_CHECK
;
600 bool image_opts
= false;
604 cache
= BDRV_DEFAULT_CACHE
;
607 int option_index
= 0;
608 static const struct option long_options
[] = {
609 {"help", no_argument
, 0, 'h'},
610 {"format", required_argument
, 0, 'f'},
611 {"repair", required_argument
, 0, 'r'},
612 {"output", required_argument
, 0, OPTION_OUTPUT
},
613 {"object", required_argument
, 0, OPTION_OBJECT
},
614 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
617 c
= getopt_long(argc
, argv
, "hf:r:T:q",
618 long_options
, &option_index
);
631 flags
|= BDRV_O_RDWR
;
633 if (!strcmp(optarg
, "leaks")) {
634 fix
= BDRV_FIX_LEAKS
;
635 } else if (!strcmp(optarg
, "all")) {
636 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
638 error_exit("Unknown option value for -r "
639 "(expecting 'leaks' or 'all'): %s", optarg
);
651 case OPTION_OBJECT
: {
653 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
659 case OPTION_IMAGE_OPTS
:
664 if (optind
!= argc
- 1) {
665 error_exit("Expecting one image file name");
667 filename
= argv
[optind
++];
669 if (output
&& !strcmp(output
, "json")) {
670 output_format
= OFORMAT_JSON
;
671 } else if (output
&& !strcmp(output
, "human")) {
672 output_format
= OFORMAT_HUMAN
;
674 error_report("--output must be used with human or json as argument.");
678 if (qemu_opts_foreach(&qemu_object_opts
,
679 user_creatable_add_opts_foreach
,
684 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
686 error_report("Invalid source cache option: %s", cache
);
690 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
696 check
= g_new0(ImageCheck
, 1);
697 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
699 if (ret
== -ENOTSUP
) {
700 error_report("This image format does not support checks");
705 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
706 int corruptions_fixed
, leaks_fixed
;
708 leaks_fixed
= check
->leaks_fixed
;
709 corruptions_fixed
= check
->corruptions_fixed
;
711 if (output_format
== OFORMAT_HUMAN
) {
713 "The following inconsistencies were found and repaired:\n\n"
714 " %" PRId64
" leaked clusters\n"
715 " %" PRId64
" corruptions\n\n"
716 "Double checking the fixed image now...\n",
718 check
->corruptions_fixed
);
721 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
723 check
->leaks_fixed
= leaks_fixed
;
724 check
->corruptions_fixed
= corruptions_fixed
;
728 switch (output_format
) {
730 dump_human_image_check(check
, quiet
);
733 dump_json_image_check(check
, quiet
);
738 if (ret
|| check
->check_errors
) {
740 error_report("Check failed: %s", strerror(-ret
));
742 error_report("Check failed");
748 if (check
->corruptions
) {
750 } else if (check
->leaks
) {
757 qapi_free_ImageCheck(check
);
762 typedef struct CommonBlockJobCBInfo
{
763 BlockDriverState
*bs
;
765 } CommonBlockJobCBInfo
;
767 static void common_block_job_cb(void *opaque
, int ret
)
769 CommonBlockJobCBInfo
*cbi
= opaque
;
772 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
776 static void run_block_job(BlockJob
*job
, Error
**errp
)
778 AioContext
*aio_context
= bdrv_get_aio_context(job
->bs
);
781 aio_poll(aio_context
, true);
782 qemu_progress_print(job
->len
?
783 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
784 } while (!job
->ready
);
786 block_job_complete_sync(job
, errp
);
788 /* A block job may finish instantaneously without publishing any progress,
789 * so just signal completion here */
790 qemu_progress_print(100.f
, 0);
793 static int img_commit(int argc
, char **argv
)
796 const char *filename
, *fmt
, *cache
, *base
;
798 BlockDriverState
*bs
, *base_bs
;
799 bool progress
= false, quiet
= false, drop
= false;
801 Error
*local_err
= NULL
;
802 CommonBlockJobCBInfo cbi
;
803 bool image_opts
= false;
806 cache
= BDRV_DEFAULT_CACHE
;
809 static const struct option long_options
[] = {
810 {"help", no_argument
, 0, 'h'},
811 {"object", required_argument
, 0, OPTION_OBJECT
},
812 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
815 c
= getopt_long(argc
, argv
, "f:ht:b:dpq",
845 case OPTION_OBJECT
: {
847 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
853 case OPTION_IMAGE_OPTS
:
859 /* Progress is not shown in Quiet mode */
864 if (optind
!= argc
- 1) {
865 error_exit("Expecting one image file name");
867 filename
= argv
[optind
++];
869 if (qemu_opts_foreach(&qemu_object_opts
,
870 user_creatable_add_opts_foreach
,
875 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
876 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
878 error_report("Invalid cache option: %s", cache
);
882 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
888 qemu_progress_init(progress
, 1.f
);
889 qemu_progress_print(0.f
, 100);
892 base_bs
= bdrv_find_backing_image(bs
, base
);
894 error_setg(&local_err
, QERR_BASE_NOT_FOUND
, base
);
898 /* This is different from QMP, which by default uses the deepest file in
899 * the backing chain (i.e., the very base); however, the traditional
900 * behavior of qemu-img commit is using the immediate backing file. */
901 base_bs
= backing_bs(bs
);
903 error_setg(&local_err
, "Image does not have a backing file");
908 cbi
= (CommonBlockJobCBInfo
){
913 commit_active_start(bs
, base_bs
, 0, BLOCKDEV_ON_ERROR_REPORT
,
914 common_block_job_cb
, &cbi
, &local_err
);
919 /* When the block job completes, the BlockBackend reference will point to
920 * the old backing file. In order to avoid that the top image is already
921 * deleted, so we can still empty it afterwards, increment the reference
922 * counter here preemptively. */
927 run_block_job(bs
->job
, &local_err
);
932 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
933 ret
= bs
->drv
->bdrv_make_empty(bs
);
935 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
952 error_report_err(local_err
);
956 qprintf(quiet
, "Image committed.\n");
961 * Returns true iff the first sector pointed to by 'buf' contains at least
964 * 'pnum' is set to the number of sectors (including and immediately following
965 * the first one) that are known to be in the same allocated/unallocated state.
967 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
976 is_zero
= buffer_is_zero(buf
, 512);
977 for(i
= 1; i
< n
; i
++) {
979 if (is_zero
!= buffer_is_zero(buf
, 512)) {
988 * Like is_allocated_sectors, but if the buffer starts with a used sector,
989 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
990 * breaking up write requests for only small sparse areas.
992 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
996 int num_checked
, num_used
;
1002 ret
= is_allocated_sectors(buf
, n
, pnum
);
1008 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1010 num_checked
= num_used
;
1013 ret
= is_allocated_sectors(buf
, n
, pnum
);
1015 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1017 num_checked
+= *pnum
;
1019 num_used
= num_checked
;
1020 } else if (*pnum
>= min
) {
1030 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1031 * buffers matches, non-zero otherwise.
1033 * pnum is set to the number of sectors (including and immediately following
1034 * the first one) that are known to have the same comparison result
1036 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1047 res
= !!memcmp(buf1
, buf2
, 512);
1048 for(i
= 1; i
< n
; i
++) {
1052 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1061 #define IO_BUF_SIZE (2 * 1024 * 1024)
1063 static int64_t sectors_to_bytes(int64_t sectors
)
1065 return sectors
<< BDRV_SECTOR_BITS
;
1068 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1070 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1074 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1076 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1077 * data and negative value on error.
1079 * @param blk: BlockBackend for the image
1080 * @param sect_num: Number of first sector to check
1081 * @param sect_count: Number of sectors to check
1082 * @param filename: Name of disk file we are checking (logging purpose)
1083 * @param buffer: Allocated buffer for storing read data
1084 * @param quiet: Flag for quiet mode
1086 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1087 int sect_count
, const char *filename
,
1088 uint8_t *buffer
, bool quiet
)
1091 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1092 sect_count
<< BDRV_SECTOR_BITS
);
1094 error_report("Error while reading offset %" PRId64
" of %s: %s",
1095 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1098 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1099 if (ret
|| pnum
!= sect_count
) {
1100 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1101 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1109 * Compares two images. Exit codes:
1111 * 0 - Images are identical
1113 * >1 - Error occurred
1115 static int img_compare(int argc
, char **argv
)
1117 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1118 BlockBackend
*blk1
, *blk2
;
1119 BlockDriverState
*bs1
, *bs2
;
1120 int64_t total_sectors1
, total_sectors2
;
1121 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1123 int allocated1
, allocated2
;
1124 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1125 bool progress
= false, quiet
= false, strict
= false;
1128 int64_t total_sectors
;
1129 int64_t sector_num
= 0;
1132 uint64_t progress_base
;
1133 bool image_opts
= false;
1135 cache
= BDRV_DEFAULT_CACHE
;
1137 static const struct option long_options
[] = {
1138 {"help", no_argument
, 0, 'h'},
1139 {"object", required_argument
, 0, OPTION_OBJECT
},
1140 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1143 c
= getopt_long(argc
, argv
, "hf:F:T:pqs",
1144 long_options
, NULL
);
1171 case OPTION_OBJECT
: {
1173 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1180 case OPTION_IMAGE_OPTS
:
1186 /* Progress is not shown in Quiet mode */
1192 if (optind
!= argc
- 2) {
1193 error_exit("Expecting two image file names");
1195 filename1
= argv
[optind
++];
1196 filename2
= argv
[optind
++];
1198 if (qemu_opts_foreach(&qemu_object_opts
,
1199 user_creatable_add_opts_foreach
,
1205 /* Initialize before goto out */
1206 qemu_progress_init(progress
, 2.0);
1209 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1211 error_report("Invalid source cache option: %s", cache
);
1216 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
);
1222 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
);
1230 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1231 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1232 total_sectors1
= blk_nb_sectors(blk1
);
1233 if (total_sectors1
< 0) {
1234 error_report("Can't get size of %s: %s",
1235 filename1
, strerror(-total_sectors1
));
1239 total_sectors2
= blk_nb_sectors(blk2
);
1240 if (total_sectors2
< 0) {
1241 error_report("Can't get size of %s: %s",
1242 filename2
, strerror(-total_sectors2
));
1246 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1247 progress_base
= MAX(total_sectors1
, total_sectors2
);
1249 qemu_progress_print(0, 100);
1251 if (strict
&& total_sectors1
!= total_sectors2
) {
1253 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1258 int64_t status1
, status2
;
1259 BlockDriverState
*file
;
1261 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1262 if (nb_sectors
<= 0) {
1265 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1266 total_sectors1
- sector_num
,
1270 error_report("Sector allocation test failed for %s", filename1
);
1273 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1275 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1276 total_sectors2
- sector_num
,
1280 error_report("Sector allocation test failed for %s", filename2
);
1283 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1285 nb_sectors
= MIN(nb_sectors
, pnum1
);
1288 nb_sectors
= MIN(nb_sectors
, pnum2
);
1292 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1293 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1295 qprintf(quiet
, "Strict mode: Offset %" PRId64
1296 " block status mismatch!\n",
1297 sectors_to_bytes(sector_num
));
1301 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1302 nb_sectors
= MIN(pnum1
, pnum2
);
1303 } else if (allocated1
== allocated2
) {
1305 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1306 nb_sectors
<< BDRV_SECTOR_BITS
);
1308 error_report("Error while reading offset %" PRId64
" of %s:"
1309 " %s", sectors_to_bytes(sector_num
), filename1
,
1314 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1315 nb_sectors
<< BDRV_SECTOR_BITS
);
1317 error_report("Error while reading offset %" PRId64
1318 " of %s: %s", sectors_to_bytes(sector_num
),
1319 filename2
, strerror(-ret
));
1323 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1324 if (ret
|| pnum
!= nb_sectors
) {
1325 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1327 ret
? sector_num
: sector_num
+ pnum
));
1335 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1336 filename1
, buf1
, quiet
);
1338 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1339 filename2
, buf1
, quiet
);
1343 error_report("Error while reading offset %" PRId64
": %s",
1344 sectors_to_bytes(sector_num
), strerror(-ret
));
1350 sector_num
+= nb_sectors
;
1351 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1354 if (total_sectors1
!= total_sectors2
) {
1355 BlockBackend
*blk_over
;
1356 int64_t total_sectors_over
;
1357 const char *filename_over
;
1359 qprintf(quiet
, "Warning: Image size mismatch!\n");
1360 if (total_sectors1
> total_sectors2
) {
1361 total_sectors_over
= total_sectors1
;
1363 filename_over
= filename1
;
1365 total_sectors_over
= total_sectors2
;
1367 filename_over
= filename2
;
1371 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1372 if (nb_sectors
<= 0) {
1375 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1379 error_report("Sector allocation test failed for %s",
1386 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1387 filename_over
, buf1
, quiet
);
1390 error_report("Error while reading offset %" PRId64
1391 " of %s: %s", sectors_to_bytes(sector_num
),
1392 filename_over
, strerror(-ret
));
1398 sector_num
+= nb_sectors
;
1399 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1403 qprintf(quiet
, "Images are identical.\n");
1413 qemu_progress_end();
1418 enum ImgConvertBlockStatus
{
1424 typedef struct ImgConvertState
{
1426 int64_t *src_sectors
;
1427 int src_cur
, src_num
;
1428 int64_t src_cur_offset
;
1429 int64_t total_sectors
;
1430 int64_t allocated_sectors
;
1431 enum ImgConvertBlockStatus status
;
1432 int64_t sector_next_status
;
1433 BlockBackend
*target
;
1436 bool target_has_backing
;
1438 size_t cluster_sectors
;
1442 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
)
1444 assert(sector_num
>= s
->src_cur_offset
);
1445 while (sector_num
- s
->src_cur_offset
>= s
->src_sectors
[s
->src_cur
]) {
1446 s
->src_cur_offset
+= s
->src_sectors
[s
->src_cur
];
1448 assert(s
->src_cur
< s
->src_num
);
1452 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1457 convert_select_part(s
, sector_num
);
1459 assert(s
->total_sectors
> sector_num
);
1460 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1462 if (s
->sector_next_status
<= sector_num
) {
1463 BlockDriverState
*file
;
1464 ret
= bdrv_get_block_status(blk_bs(s
->src
[s
->src_cur
]),
1465 sector_num
- s
->src_cur_offset
,
1471 if (ret
& BDRV_BLOCK_ZERO
) {
1472 s
->status
= BLK_ZERO
;
1473 } else if (ret
& BDRV_BLOCK_DATA
) {
1474 s
->status
= BLK_DATA
;
1475 } else if (!s
->target_has_backing
) {
1476 /* Without a target backing file we must copy over the contents of
1477 * the backing file as well. */
1478 /* TODO Check block status of the backing file chain to avoid
1479 * needlessly reading zeroes and limiting the iteration to the
1481 s
->status
= BLK_DATA
;
1483 s
->status
= BLK_BACKING_FILE
;
1486 s
->sector_next_status
= sector_num
+ n
;
1489 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1490 if (s
->status
== BLK_DATA
) {
1491 n
= MIN(n
, s
->buf_sectors
);
1494 /* We need to write complete clusters for compressed images, so if an
1495 * unallocated area is shorter than that, we must consider the whole
1496 * cluster allocated. */
1497 if (s
->compressed
) {
1498 if (n
< s
->cluster_sectors
) {
1499 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1500 s
->status
= BLK_DATA
;
1502 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1509 static int convert_read(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1515 assert(nb_sectors
<= s
->buf_sectors
);
1516 while (nb_sectors
> 0) {
1520 /* In the case of compression with multiple source files, we can get a
1521 * nb_sectors that spreads into the next part. So we must be able to
1522 * read across multiple BDSes for one convert_read() call. */
1523 convert_select_part(s
, sector_num
);
1524 blk
= s
->src
[s
->src_cur
];
1525 bs_sectors
= s
->src_sectors
[s
->src_cur
];
1527 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- s
->src_cur_offset
));
1528 ret
= blk_pread(blk
,
1529 (sector_num
- s
->src_cur_offset
) << BDRV_SECTOR_BITS
,
1530 buf
, n
<< BDRV_SECTOR_BITS
);
1537 buf
+= n
* BDRV_SECTOR_SIZE
;
1543 static int convert_write(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1548 while (nb_sectors
> 0) {
1551 switch (s
->status
) {
1552 case BLK_BACKING_FILE
:
1553 /* If we have a backing file, leave clusters unallocated that are
1554 * unallocated in the source image, so that the backing file is
1555 * visible at the respective offset. */
1556 assert(s
->target_has_backing
);
1560 /* We must always write compressed clusters as a whole, so don't
1561 * try to find zeroed parts in the buffer. We can only save the
1562 * write if the buffer is completely zeroed and we're allowed to
1563 * keep the target sparse. */
1564 if (s
->compressed
) {
1565 if (s
->has_zero_init
&& s
->min_sparse
&&
1566 buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
))
1568 assert(!s
->target_has_backing
);
1572 ret
= blk_write_compressed(s
->target
, sector_num
, buf
, n
);
1579 /* If there is real non-zero data or we're told to keep the target
1580 * fully allocated (-S 0), we must write it. Otherwise we can treat
1581 * it as zero sectors. */
1582 if (!s
->min_sparse
||
1583 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
))
1585 ret
= blk_pwrite(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1586 buf
, n
<< BDRV_SECTOR_BITS
, 0);
1595 if (s
->has_zero_init
) {
1598 ret
= blk_write_zeroes(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1599 n
<< BDRV_SECTOR_BITS
, 0);
1608 buf
+= n
* BDRV_SECTOR_SIZE
;
1614 static int convert_do_copy(ImgConvertState
*s
)
1616 uint8_t *buf
= NULL
;
1617 int64_t sector_num
, allocated_done
;
1621 /* Check whether we have zero initialisation or can get it efficiently */
1622 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1623 ? bdrv_has_zero_init(blk_bs(s
->target
))
1626 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1627 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1629 ret
= bdrv_make_zero(blk_bs(s
->target
), BDRV_REQ_MAY_UNMAP
);
1631 s
->has_zero_init
= true;
1635 /* Allocate buffer for copied data. For compressed images, only one cluster
1636 * can be copied at a time. */
1637 if (s
->compressed
) {
1638 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1639 error_report("invalid cluster size");
1643 s
->buf_sectors
= s
->cluster_sectors
;
1645 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1647 /* Calculate allocated sectors for progress */
1648 s
->allocated_sectors
= 0;
1650 while (sector_num
< s
->total_sectors
) {
1651 n
= convert_iteration_sectors(s
, sector_num
);
1656 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1658 s
->allocated_sectors
+= n
;
1665 s
->src_cur_offset
= 0;
1666 s
->sector_next_status
= 0;
1671 while (sector_num
< s
->total_sectors
) {
1672 n
= convert_iteration_sectors(s
, sector_num
);
1677 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1679 allocated_done
+= n
;
1680 qemu_progress_print(100.0 * allocated_done
/ s
->allocated_sectors
,
1684 if (s
->status
== BLK_DATA
) {
1685 ret
= convert_read(s
, sector_num
, n
, buf
);
1687 error_report("error while reading sector %" PRId64
1688 ": %s", sector_num
, strerror(-ret
));
1691 } else if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1692 n
= MIN(n
, s
->buf_sectors
);
1693 memset(buf
, 0, n
* BDRV_SECTOR_SIZE
);
1694 s
->status
= BLK_DATA
;
1697 ret
= convert_write(s
, sector_num
, n
, buf
);
1699 error_report("error while writing sector %" PRId64
1700 ": %s", sector_num
, strerror(-ret
));
1707 if (s
->compressed
) {
1708 /* signal EOF to align */
1709 ret
= blk_write_compressed(s
->target
, 0, NULL
, 0);
1721 static int img_convert(int argc
, char **argv
)
1723 int c
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1725 int progress
= 0, flags
, src_flags
;
1726 bool writethrough
, src_writethrough
;
1727 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1728 BlockDriver
*drv
, *proto_drv
;
1729 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1730 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1731 int64_t total_sectors
;
1732 int64_t *bs_sectors
= NULL
;
1733 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1734 BlockDriverInfo bdi
;
1735 QemuOpts
*opts
= NULL
;
1736 QemuOptsList
*create_opts
= NULL
;
1737 const char *out_baseimg_param
;
1738 char *options
= NULL
;
1739 const char *snapshot_name
= NULL
;
1740 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1742 Error
*local_err
= NULL
;
1743 QemuOpts
*sn_opts
= NULL
;
1744 ImgConvertState state
;
1745 bool image_opts
= false;
1750 src_cache
= BDRV_DEFAULT_CACHE
;
1755 static const struct option long_options
[] = {
1756 {"help", no_argument
, 0, 'h'},
1757 {"object", required_argument
, 0, OPTION_OBJECT
},
1758 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1761 c
= getopt_long(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1762 long_options
, NULL
);
1778 out_baseimg
= optarg
;
1784 error_report("option -e is deprecated, please use \'-o "
1785 "encryption\' instead!");
1789 error_report("option -6 is deprecated, please use \'-o "
1790 "compat6\' instead!");
1794 if (!is_valid_option_list(optarg
)) {
1795 error_report("Invalid option list: %s", optarg
);
1800 options
= g_strdup(optarg
);
1802 char *old_options
= options
;
1803 options
= g_strdup_printf("%s,%s", options
, optarg
);
1804 g_free(old_options
);
1808 snapshot_name
= optarg
;
1811 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1812 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
1815 error_report("Failed in parsing snapshot param '%s'",
1821 snapshot_name
= optarg
;
1828 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
1829 if (sval
< 0 || *end
) {
1830 error_report("Invalid minimum zero buffer size for sparse output specified");
1835 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1854 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1860 case OPTION_IMAGE_OPTS
:
1866 if (qemu_opts_foreach(&qemu_object_opts
,
1867 user_creatable_add_opts_foreach
,
1872 /* Initialize before goto out */
1876 qemu_progress_init(progress
, 1.0);
1878 bs_n
= argc
- optind
- 1;
1879 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1881 if (options
&& has_help_option(options
)) {
1882 ret
= print_block_option_help(out_filename
, out_fmt
);
1887 error_exit("Must specify image file name");
1891 if (bs_n
> 1 && out_baseimg
) {
1892 error_report("-B makes no sense when concatenating multiple input "
1899 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
1901 error_report("Invalid source cache option: %s", src_cache
);
1905 qemu_progress_print(0, 100);
1907 blk
= g_new0(BlockBackend
*, bs_n
);
1908 bs
= g_new0(BlockDriverState
*, bs_n
);
1909 bs_sectors
= g_new(int64_t, bs_n
);
1912 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1913 blk
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
1914 fmt
, src_flags
, src_writethrough
, quiet
);
1919 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1920 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
1921 if (bs_sectors
[bs_i
] < 0) {
1922 error_report("Could not get size of %s: %s",
1923 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1927 total_sectors
+= bs_sectors
[bs_i
];
1931 ret
= bdrv_snapshot_load_tmp(bs
[0],
1932 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1933 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1935 } else if (snapshot_name
!= NULL
) {
1937 error_report("No support for concatenating multiple snapshot");
1942 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1945 error_reportf_err(local_err
, "Failed to load snapshot: ");
1950 /* Find driver and parse its options */
1951 drv
= bdrv_find_format(out_fmt
);
1953 error_report("Unknown file format '%s'", out_fmt
);
1958 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
1960 error_report_err(local_err
);
1966 if (!drv
->create_opts
) {
1967 error_report("Format driver '%s' does not support image creation",
1973 if (!proto_drv
->create_opts
) {
1974 error_report("Protocol driver '%s' does not support image creation",
1975 proto_drv
->format_name
);
1980 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1981 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1983 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1985 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
1987 error_report_err(local_err
);
1993 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
1995 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2001 /* Get backing file name if -o backing_file was used */
2002 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2003 if (out_baseimg_param
) {
2004 out_baseimg
= out_baseimg_param
;
2007 /* Check if compression is supported */
2010 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2011 const char *preallocation
=
2012 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2014 if (!drv
->bdrv_write_compressed
) {
2015 error_report("Compression not supported for this file format");
2021 error_report("Compression and encryption not supported at "
2028 && strcmp(preallocation
, "off"))
2030 error_report("Compression and preallocation not supported at "
2038 /* Create the new image */
2039 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2041 error_reportf_err(local_err
, "%s: error while converting %s: ",
2042 out_filename
, out_fmt
);
2047 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2048 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2050 error_report("Invalid cache option: %s", cache
);
2054 /* XXX we should allow --image-opts to trigger use of
2055 * img_open() here, but then we have trouble with
2056 * the bdrv_create() call which takes different params.
2057 * Not critical right now, so fix can wait...
2059 out_blk
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
);
2064 out_bs
= blk_bs(out_blk
);
2066 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
2067 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2069 bufsectors
= MIN(32768,
2070 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
2071 out_bs
->bl
.discard_alignment
))
2075 int64_t output_sectors
= blk_nb_sectors(out_blk
);
2076 if (output_sectors
< 0) {
2077 error_report("unable to get output image length: %s",
2078 strerror(-output_sectors
));
2081 } else if (output_sectors
< total_sectors
) {
2082 error_report("output file is smaller than input file");
2088 cluster_sectors
= 0;
2089 ret
= bdrv_get_info(out_bs
, &bdi
);
2092 error_report("could not get block driver info");
2096 compress
= compress
|| bdi
.needs_compressed_writes
;
2097 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2100 state
= (ImgConvertState
) {
2102 .src_sectors
= bs_sectors
,
2104 .total_sectors
= total_sectors
,
2106 .compressed
= compress
,
2107 .target_has_backing
= (bool) out_baseimg
,
2108 .min_sparse
= min_sparse
,
2109 .cluster_sectors
= cluster_sectors
,
2110 .buf_sectors
= bufsectors
,
2112 ret
= convert_do_copy(&state
);
2116 qemu_progress_print(100, 0);
2118 qemu_progress_end();
2119 qemu_opts_del(opts
);
2120 qemu_opts_free(create_opts
);
2121 qemu_opts_del(sn_opts
);
2125 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2126 blk_unref(blk
[bs_i
]);
2141 static void dump_snapshots(BlockDriverState
*bs
)
2143 QEMUSnapshotInfo
*sn_tab
, *sn
;
2146 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2149 printf("Snapshot list:\n");
2150 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2152 for(i
= 0; i
< nb_sns
; i
++) {
2154 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2160 static void dump_json_image_info_list(ImageInfoList
*list
)
2162 Error
*local_err
= NULL
;
2164 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2166 visit_type_ImageInfoList(qmp_output_get_visitor(ov
), NULL
, &list
,
2168 obj
= qmp_output_get_qobject(ov
);
2169 str
= qobject_to_json_pretty(obj
);
2170 assert(str
!= NULL
);
2171 printf("%s\n", qstring_get_str(str
));
2172 qobject_decref(obj
);
2173 qmp_output_visitor_cleanup(ov
);
2177 static void dump_json_image_info(ImageInfo
*info
)
2179 Error
*local_err
= NULL
;
2181 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2183 visit_type_ImageInfo(qmp_output_get_visitor(ov
), NULL
, &info
, &local_err
);
2184 obj
= qmp_output_get_qobject(ov
);
2185 str
= qobject_to_json_pretty(obj
);
2186 assert(str
!= NULL
);
2187 printf("%s\n", qstring_get_str(str
));
2188 qobject_decref(obj
);
2189 qmp_output_visitor_cleanup(ov
);
2193 static void dump_human_image_info_list(ImageInfoList
*list
)
2195 ImageInfoList
*elem
;
2198 for (elem
= list
; elem
; elem
= elem
->next
) {
2204 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2208 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2210 return strcmp(a
, b
) == 0;
2214 * Open an image file chain and return an ImageInfoList
2216 * @filename: topmost image filename
2217 * @fmt: topmost image format (may be NULL to autodetect)
2218 * @chain: true - enumerate entire backing file chain
2219 * false - only topmost image file
2221 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2222 * image file. If there was an error a message will have been printed to
2225 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2226 const char *filename
,
2230 ImageInfoList
*head
= NULL
;
2231 ImageInfoList
**last
= &head
;
2232 GHashTable
*filenames
;
2235 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2239 BlockDriverState
*bs
;
2241 ImageInfoList
*elem
;
2243 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2244 error_report("Backing file '%s' creates an infinite loop.",
2248 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2250 blk
= img_open(image_opts
, filename
, fmt
,
2251 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false);
2257 bdrv_query_image_info(bs
, &info
, &err
);
2259 error_report_err(err
);
2264 elem
= g_new0(ImageInfoList
, 1);
2271 filename
= fmt
= NULL
;
2273 if (info
->has_full_backing_filename
) {
2274 filename
= info
->full_backing_filename
;
2275 } else if (info
->has_backing_filename
) {
2276 error_report("Could not determine absolute backing filename,"
2277 " but backing filename '%s' present",
2278 info
->backing_filename
);
2281 if (info
->has_backing_filename_format
) {
2282 fmt
= info
->backing_filename_format
;
2286 g_hash_table_destroy(filenames
);
2290 qapi_free_ImageInfoList(head
);
2291 g_hash_table_destroy(filenames
);
2295 static int img_info(int argc
, char **argv
)
2298 OutputFormat output_format
= OFORMAT_HUMAN
;
2300 const char *filename
, *fmt
, *output
;
2301 ImageInfoList
*list
;
2302 bool image_opts
= false;
2307 int option_index
= 0;
2308 static const struct option long_options
[] = {
2309 {"help", no_argument
, 0, 'h'},
2310 {"format", required_argument
, 0, 'f'},
2311 {"output", required_argument
, 0, OPTION_OUTPUT
},
2312 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2313 {"object", required_argument
, 0, OPTION_OBJECT
},
2314 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2317 c
= getopt_long(argc
, argv
, "f:h",
2318 long_options
, &option_index
);
2333 case OPTION_BACKING_CHAIN
:
2336 case OPTION_OBJECT
: {
2338 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2344 case OPTION_IMAGE_OPTS
:
2349 if (optind
!= argc
- 1) {
2350 error_exit("Expecting one image file name");
2352 filename
= argv
[optind
++];
2354 if (output
&& !strcmp(output
, "json")) {
2355 output_format
= OFORMAT_JSON
;
2356 } else if (output
&& !strcmp(output
, "human")) {
2357 output_format
= OFORMAT_HUMAN
;
2358 } else if (output
) {
2359 error_report("--output must be used with human or json as argument.");
2363 if (qemu_opts_foreach(&qemu_object_opts
,
2364 user_creatable_add_opts_foreach
,
2369 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
);
2374 switch (output_format
) {
2376 dump_human_image_info_list(list
);
2380 dump_json_image_info_list(list
);
2382 dump_json_image_info(list
->value
);
2387 qapi_free_ImageInfoList(list
);
2391 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2394 switch (output_format
) {
2396 if (e
->data
&& !e
->has_offset
) {
2397 error_report("File contains external, encrypted or compressed clusters.");
2400 if (e
->data
&& !e
->zero
) {
2401 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2402 e
->start
, e
->length
,
2403 e
->has_offset
? e
->offset
: 0,
2404 e
->has_filename
? e
->filename
: "");
2406 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2407 * Modify the flags here to allow more coalescing.
2409 if (next
&& (!next
->data
|| next
->zero
)) {
2415 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2416 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2417 (e
->start
== 0 ? "[" : ",\n"),
2418 e
->start
, e
->length
, e
->depth
,
2419 e
->zero
? "true" : "false",
2420 e
->data
? "true" : "false");
2421 if (e
->has_offset
) {
2422 printf(", \"offset\": %"PRId64
"", e
->offset
);
2433 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2434 int nb_sectors
, MapEntry
*e
)
2438 BlockDriverState
*file
;
2441 /* As an optimization, we could cache the current range of unallocated
2442 * clusters in each file of the chain, and avoid querying the same
2448 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2454 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2457 bs
= backing_bs(bs
);
2466 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2469 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2470 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2471 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2472 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2473 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2474 .has_offset
= has_offset
,
2476 .has_filename
= file
&& has_offset
,
2477 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2483 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2485 if (curr
->length
== 0) {
2488 if (curr
->zero
!= next
->zero
||
2489 curr
->data
!= next
->data
||
2490 curr
->depth
!= next
->depth
||
2491 curr
->has_filename
!= next
->has_filename
||
2492 curr
->has_offset
!= next
->has_offset
) {
2495 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2498 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2504 static int img_map(int argc
, char **argv
)
2507 OutputFormat output_format
= OFORMAT_HUMAN
;
2509 BlockDriverState
*bs
;
2510 const char *filename
, *fmt
, *output
;
2512 MapEntry curr
= { .length
= 0 }, next
;
2514 bool image_opts
= false;
2519 int option_index
= 0;
2520 static const struct option long_options
[] = {
2521 {"help", no_argument
, 0, 'h'},
2522 {"format", required_argument
, 0, 'f'},
2523 {"output", required_argument
, 0, OPTION_OUTPUT
},
2524 {"object", required_argument
, 0, OPTION_OBJECT
},
2525 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2528 c
= getopt_long(argc
, argv
, "f:h",
2529 long_options
, &option_index
);
2544 case OPTION_OBJECT
: {
2546 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2552 case OPTION_IMAGE_OPTS
:
2557 if (optind
!= argc
- 1) {
2558 error_exit("Expecting one image file name");
2560 filename
= argv
[optind
];
2562 if (output
&& !strcmp(output
, "json")) {
2563 output_format
= OFORMAT_JSON
;
2564 } else if (output
&& !strcmp(output
, "human")) {
2565 output_format
= OFORMAT_HUMAN
;
2566 } else if (output
) {
2567 error_report("--output must be used with human or json as argument.");
2571 if (qemu_opts_foreach(&qemu_object_opts
,
2572 user_creatable_add_opts_foreach
,
2577 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false);
2583 if (output_format
== OFORMAT_HUMAN
) {
2584 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2587 length
= blk_getlength(blk
);
2588 while (curr
.start
+ curr
.length
< length
) {
2589 int64_t nsectors_left
;
2593 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2595 /* Probe up to 1 GiB at a time. */
2596 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2597 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2598 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2601 error_report("Could not read file metadata: %s", strerror(-ret
));
2605 if (entry_mergeable(&curr
, &next
)) {
2606 curr
.length
+= next
.length
;
2610 if (curr
.length
> 0) {
2611 dump_map_entry(output_format
, &curr
, &next
);
2616 dump_map_entry(output_format
, &curr
, NULL
);
2623 #define SNAPSHOT_LIST 1
2624 #define SNAPSHOT_CREATE 2
2625 #define SNAPSHOT_APPLY 3
2626 #define SNAPSHOT_DELETE 4
2628 static int img_snapshot(int argc
, char **argv
)
2631 BlockDriverState
*bs
;
2632 QEMUSnapshotInfo sn
;
2633 char *filename
, *snapshot_name
= NULL
;
2634 int c
, ret
= 0, bdrv_oflags
;
2639 bool image_opts
= false;
2641 bdrv_oflags
= BDRV_O_RDWR
;
2642 /* Parse commandline parameters */
2644 static const struct option long_options
[] = {
2645 {"help", no_argument
, 0, 'h'},
2646 {"object", required_argument
, 0, OPTION_OBJECT
},
2647 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2650 c
= getopt_long(argc
, argv
, "la:c:d:hq",
2651 long_options
, NULL
);
2662 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2665 action
= SNAPSHOT_LIST
;
2666 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2670 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2673 action
= SNAPSHOT_APPLY
;
2674 snapshot_name
= optarg
;
2678 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2681 action
= SNAPSHOT_CREATE
;
2682 snapshot_name
= optarg
;
2686 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2689 action
= SNAPSHOT_DELETE
;
2690 snapshot_name
= optarg
;
2695 case OPTION_OBJECT
: {
2697 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2703 case OPTION_IMAGE_OPTS
:
2709 if (optind
!= argc
- 1) {
2710 error_exit("Expecting one image file name");
2712 filename
= argv
[optind
++];
2714 if (qemu_opts_foreach(&qemu_object_opts
,
2715 user_creatable_add_opts_foreach
,
2720 /* Open the image */
2721 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
);
2727 /* Perform the requested action */
2733 case SNAPSHOT_CREATE
:
2734 memset(&sn
, 0, sizeof(sn
));
2735 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2737 qemu_gettimeofday(&tv
);
2738 sn
.date_sec
= tv
.tv_sec
;
2739 sn
.date_nsec
= tv
.tv_usec
* 1000;
2741 ret
= bdrv_snapshot_create(bs
, &sn
);
2743 error_report("Could not create snapshot '%s': %d (%s)",
2744 snapshot_name
, ret
, strerror(-ret
));
2748 case SNAPSHOT_APPLY
:
2749 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2751 error_report("Could not apply snapshot '%s': %d (%s)",
2752 snapshot_name
, ret
, strerror(-ret
));
2756 case SNAPSHOT_DELETE
:
2757 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2759 error_reportf_err(err
, "Could not delete snapshot '%s': ",
2774 static int img_rebase(int argc
, char **argv
)
2776 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2777 uint8_t *buf_old
= NULL
;
2778 uint8_t *buf_new
= NULL
;
2779 BlockDriverState
*bs
= NULL
;
2781 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2782 int c
, flags
, src_flags
, ret
;
2783 bool writethrough
, src_writethrough
;
2787 Error
*local_err
= NULL
;
2788 bool image_opts
= false;
2790 /* Parse commandline parameters */
2792 cache
= BDRV_DEFAULT_CACHE
;
2793 src_cache
= BDRV_DEFAULT_CACHE
;
2797 static const struct option long_options
[] = {
2798 {"help", no_argument
, 0, 'h'},
2799 {"object", required_argument
, 0, OPTION_OBJECT
},
2800 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2803 c
= getopt_long(argc
, argv
, "hf:F:b:upt:T:q",
2804 long_options
, NULL
);
2817 out_basefmt
= optarg
;
2820 out_baseimg
= optarg
;
2837 case OPTION_OBJECT
: {
2839 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2845 case OPTION_IMAGE_OPTS
:
2855 if (optind
!= argc
- 1) {
2856 error_exit("Expecting one image file name");
2858 if (!unsafe
&& !out_baseimg
) {
2859 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2861 filename
= argv
[optind
++];
2863 if (qemu_opts_foreach(&qemu_object_opts
,
2864 user_creatable_add_opts_foreach
,
2869 qemu_progress_init(progress
, 2.0);
2870 qemu_progress_print(0, 100);
2872 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2873 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2875 error_report("Invalid cache option: %s", cache
);
2880 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2882 error_report("Invalid source cache option: %s", src_cache
);
2886 /* The source files are opened read-only, don't care about WCE */
2887 assert((src_flags
& BDRV_O_RDWR
) == 0);
2888 (void) src_writethrough
;
2893 * Ignore the old backing file for unsafe rebase in case we want to correct
2894 * the reference to a renamed or moved backing file.
2896 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
2903 if (out_basefmt
!= NULL
) {
2904 if (bdrv_find_format(out_basefmt
) == NULL
) {
2905 error_report("Invalid format name: '%s'", out_basefmt
);
2911 /* For safe rebasing we need to compare old and new backing file */
2913 char backing_name
[PATH_MAX
];
2914 QDict
*options
= NULL
;
2916 if (bs
->backing_format
[0] != '\0') {
2917 options
= qdict_new();
2918 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
2921 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2922 blk_old_backing
= blk_new_open(backing_name
, NULL
,
2923 options
, src_flags
, &local_err
);
2924 if (!blk_old_backing
) {
2925 error_reportf_err(local_err
,
2926 "Could not open old backing file '%s': ",
2931 if (out_baseimg
[0]) {
2933 options
= qdict_new();
2934 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
2939 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
2940 options
, src_flags
, &local_err
);
2941 if (!blk_new_backing
) {
2942 error_reportf_err(local_err
,
2943 "Could not open new backing file '%s': ",
2951 * Check each unallocated cluster in the COW file. If it is unallocated,
2952 * accesses go to the backing file. We must therefore compare this cluster
2953 * in the old and new backing file, and if they differ we need to copy it
2954 * from the old backing file into the COW file.
2956 * If qemu-img crashes during this step, no harm is done. The content of
2957 * the image is the same as the original one at any time.
2960 int64_t num_sectors
;
2961 int64_t old_backing_num_sectors
;
2962 int64_t new_backing_num_sectors
= 0;
2965 float local_progress
= 0;
2967 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
2968 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
2970 num_sectors
= blk_nb_sectors(blk
);
2971 if (num_sectors
< 0) {
2972 error_report("Could not get size of '%s': %s",
2973 filename
, strerror(-num_sectors
));
2977 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
2978 if (old_backing_num_sectors
< 0) {
2979 char backing_name
[PATH_MAX
];
2981 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2982 error_report("Could not get size of '%s': %s",
2983 backing_name
, strerror(-old_backing_num_sectors
));
2987 if (blk_new_backing
) {
2988 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
2989 if (new_backing_num_sectors
< 0) {
2990 error_report("Could not get size of '%s': %s",
2991 out_baseimg
, strerror(-new_backing_num_sectors
));
2997 if (num_sectors
!= 0) {
2998 local_progress
= (float)100 /
2999 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3002 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3004 /* How many sectors can we handle with the next read? */
3005 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3006 n
= (IO_BUF_SIZE
/ 512);
3008 n
= num_sectors
- sector
;
3011 /* If the cluster is allocated, we don't need to take action */
3012 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3014 error_report("error while reading image metadata: %s",
3023 * Read old and new backing file and take into consideration that
3024 * backing files may be smaller than the COW image.
3026 if (sector
>= old_backing_num_sectors
) {
3027 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3029 if (sector
+ n
> old_backing_num_sectors
) {
3030 n
= old_backing_num_sectors
- sector
;
3033 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3034 buf_old
, n
<< BDRV_SECTOR_BITS
);
3036 error_report("error while reading from old backing file");
3041 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3042 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3044 if (sector
+ n
> new_backing_num_sectors
) {
3045 n
= new_backing_num_sectors
- sector
;
3048 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3049 buf_new
, n
<< BDRV_SECTOR_BITS
);
3051 error_report("error while reading from new backing file");
3056 /* If they differ, we need to write to the COW file */
3057 uint64_t written
= 0;
3059 while (written
< n
) {
3062 if (compare_sectors(buf_old
+ written
* 512,
3063 buf_new
+ written
* 512, n
- written
, &pnum
))
3065 ret
= blk_pwrite(blk
,
3066 (sector
+ written
) << BDRV_SECTOR_BITS
,
3067 buf_old
+ written
* 512,
3068 pnum
<< BDRV_SECTOR_BITS
, 0);
3070 error_report("Error while writing to COW image: %s",
3078 qemu_progress_print(local_progress
, 100);
3083 * Change the backing file. All clusters that are different from the old
3084 * backing file are overwritten in the COW file now, so the visible content
3085 * doesn't change when we switch the backing file.
3087 if (out_baseimg
&& *out_baseimg
) {
3088 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3090 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3093 if (ret
== -ENOSPC
) {
3094 error_report("Could not change the backing file to '%s': No "
3095 "space left in the file header", out_baseimg
);
3096 } else if (ret
< 0) {
3097 error_report("Could not change the backing file to '%s': %s",
3098 out_baseimg
, strerror(-ret
));
3101 qemu_progress_print(100, 0);
3103 * TODO At this point it is possible to check if any clusters that are
3104 * allocated in the COW file are the same in the backing file. If so, they
3105 * could be dropped from the COW file. Don't do this before switching the
3106 * backing file, in case of a crash this would lead to corruption.
3109 qemu_progress_end();
3112 blk_unref(blk_old_backing
);
3113 blk_unref(blk_new_backing
);
3115 qemu_vfree(buf_old
);
3116 qemu_vfree(buf_new
);
3125 static int img_resize(int argc
, char **argv
)
3128 int c
, ret
, relative
;
3129 const char *filename
, *fmt
, *size
;
3130 int64_t n
, total_size
;
3132 BlockBackend
*blk
= NULL
;
3135 static QemuOptsList resize_options
= {
3136 .name
= "resize_options",
3137 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3140 .name
= BLOCK_OPT_SIZE
,
3141 .type
= QEMU_OPT_SIZE
,
3142 .help
= "Virtual disk size"
3148 bool image_opts
= false;
3150 /* Remove size from argv manually so that negative numbers are not treated
3151 * as options by getopt. */
3153 error_exit("Not enough arguments");
3157 size
= argv
[--argc
];
3159 /* Parse getopt arguments */
3162 static const struct option long_options
[] = {
3163 {"help", no_argument
, 0, 'h'},
3164 {"object", required_argument
, 0, OPTION_OBJECT
},
3165 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3168 c
= getopt_long(argc
, argv
, "f:hq",
3169 long_options
, NULL
);
3184 case OPTION_OBJECT
: {
3186 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3192 case OPTION_IMAGE_OPTS
:
3197 if (optind
!= argc
- 1) {
3198 error_exit("Expecting one image file name");
3200 filename
= argv
[optind
++];
3202 if (qemu_opts_foreach(&qemu_object_opts
,
3203 user_creatable_add_opts_foreach
,
3208 /* Choose grow, shrink, or absolute resize mode */
3224 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3225 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3227 error_report_err(err
);
3229 qemu_opts_del(param
);
3232 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3233 qemu_opts_del(param
);
3235 blk
= img_open(image_opts
, filename
, fmt
,
3236 BDRV_O_RDWR
, false, quiet
);
3243 total_size
= blk_getlength(blk
) + n
* relative
;
3247 if (total_size
<= 0) {
3248 error_report("New image size must be positive");
3253 ret
= blk_truncate(blk
, total_size
);
3256 qprintf(quiet
, "Image resized.\n");
3259 error_report("This image does not support resize");
3262 error_report("Image is read-only");
3265 error_report("Error resizing image (%d)", -ret
);
3276 static void amend_status_cb(BlockDriverState
*bs
,
3277 int64_t offset
, int64_t total_work_size
,
3280 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3283 static int img_amend(int argc
, char **argv
)
3287 char *options
= NULL
;
3288 QemuOptsList
*create_opts
= NULL
;
3289 QemuOpts
*opts
= NULL
;
3290 const char *fmt
= NULL
, *filename
, *cache
;
3293 bool quiet
= false, progress
= false;
3294 BlockBackend
*blk
= NULL
;
3295 BlockDriverState
*bs
= NULL
;
3296 bool image_opts
= false;
3298 cache
= BDRV_DEFAULT_CACHE
;
3300 static const struct option long_options
[] = {
3301 {"help", no_argument
, 0, 'h'},
3302 {"object", required_argument
, 0, OPTION_OBJECT
},
3303 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3306 c
= getopt_long(argc
, argv
, "ho:f:t:pq",
3307 long_options
, NULL
);
3318 if (!is_valid_option_list(optarg
)) {
3319 error_report("Invalid option list: %s", optarg
);
3321 goto out_no_progress
;
3324 options
= g_strdup(optarg
);
3326 char *old_options
= options
;
3327 options
= g_strdup_printf("%s,%s", options
, optarg
);
3328 g_free(old_options
);
3344 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3348 goto out_no_progress
;
3351 case OPTION_IMAGE_OPTS
:
3358 error_exit("Must specify options (-o)");
3361 if (qemu_opts_foreach(&qemu_object_opts
,
3362 user_creatable_add_opts_foreach
,
3365 goto out_no_progress
;
3371 qemu_progress_init(progress
, 1.0);
3373 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3374 if (fmt
&& has_help_option(options
)) {
3375 /* If a format is explicitly specified (and possibly no filename is
3376 * given), print option help here */
3377 ret
= print_block_option_help(filename
, fmt
);
3381 if (optind
!= argc
- 1) {
3382 error_report("Expecting one image file name");
3387 flags
= BDRV_O_RDWR
;
3388 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3390 error_report("Invalid cache option: %s", cache
);
3394 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3401 fmt
= bs
->drv
->format_name
;
3403 if (has_help_option(options
)) {
3404 /* If the format was auto-detected, print option help here */
3405 ret
= print_block_option_help(filename
, fmt
);
3409 if (!bs
->drv
->create_opts
) {
3410 error_report("Format driver '%s' does not support any options to amend",
3416 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3417 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3419 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3421 error_report_err(err
);
3427 /* In case the driver does not call amend_status_cb() */
3428 qemu_progress_print(0.f
, 0);
3429 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3430 qemu_progress_print(100.f
, 0);
3432 error_report("Error while amending options: %s", strerror(-ret
));
3437 qemu_progress_end();
3441 qemu_opts_del(opts
);
3442 qemu_opts_free(create_opts
);
3451 static const img_cmd_t img_cmds
[] = {
3452 #define DEF(option, callback, arg_string) \
3453 { option, callback },
3454 #include "qemu-img-cmds.h"
3460 int main(int argc
, char **argv
)
3462 const img_cmd_t
*cmd
;
3463 const char *cmdname
;
3464 Error
*local_error
= NULL
;
3466 static const struct option long_options
[] = {
3467 {"help", no_argument
, 0, 'h'},
3468 {"version", no_argument
, 0, 'v'},
3473 signal(SIGPIPE
, SIG_IGN
);
3476 error_set_progname(argv
[0]);
3477 qemu_init_exec_dir(argv
[0]);
3479 if (qemu_init_main_loop(&local_error
)) {
3480 error_report_err(local_error
);
3484 if (qcrypto_init(&local_error
) < 0) {
3485 error_reportf_err(local_error
, "cannot initialize crypto: ");
3489 module_call_init(MODULE_INIT_QOM
);
3492 error_exit("Not enough arguments");
3496 qemu_add_opts(&qemu_object_opts
);
3497 qemu_add_opts(&qemu_source_opts
);
3499 /* find the command */
3500 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
3501 if (!strcmp(cmdname
, cmd
->name
)) {
3502 return cmd
->handler(argc
- 1, argv
+ 1);
3506 c
= getopt_long(argc
, argv
, "h", long_options
, NULL
);
3512 printf(QEMU_IMG_VERSION
);
3517 error_exit("Command not found: %s", cmdname
);