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_read(blk
, sect_num
, buffer
, sect_count
);
1093 error_report("Error while reading offset %" PRId64
" of %s: %s",
1094 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1097 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1098 if (ret
|| pnum
!= sect_count
) {
1099 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1100 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1108 * Compares two images. Exit codes:
1110 * 0 - Images are identical
1112 * >1 - Error occurred
1114 static int img_compare(int argc
, char **argv
)
1116 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1117 BlockBackend
*blk1
, *blk2
;
1118 BlockDriverState
*bs1
, *bs2
;
1119 int64_t total_sectors1
, total_sectors2
;
1120 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1122 int allocated1
, allocated2
;
1123 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1124 bool progress
= false, quiet
= false, strict
= false;
1127 int64_t total_sectors
;
1128 int64_t sector_num
= 0;
1131 uint64_t progress_base
;
1132 bool image_opts
= false;
1134 cache
= BDRV_DEFAULT_CACHE
;
1136 static const struct option long_options
[] = {
1137 {"help", no_argument
, 0, 'h'},
1138 {"object", required_argument
, 0, OPTION_OBJECT
},
1139 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1142 c
= getopt_long(argc
, argv
, "hf:F:T:pqs",
1143 long_options
, NULL
);
1170 case OPTION_OBJECT
: {
1172 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1179 case OPTION_IMAGE_OPTS
:
1185 /* Progress is not shown in Quiet mode */
1191 if (optind
!= argc
- 2) {
1192 error_exit("Expecting two image file names");
1194 filename1
= argv
[optind
++];
1195 filename2
= argv
[optind
++];
1197 if (qemu_opts_foreach(&qemu_object_opts
,
1198 user_creatable_add_opts_foreach
,
1204 /* Initialize before goto out */
1205 qemu_progress_init(progress
, 2.0);
1208 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1210 error_report("Invalid source cache option: %s", cache
);
1215 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
);
1221 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
);
1229 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1230 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1231 total_sectors1
= blk_nb_sectors(blk1
);
1232 if (total_sectors1
< 0) {
1233 error_report("Can't get size of %s: %s",
1234 filename1
, strerror(-total_sectors1
));
1238 total_sectors2
= blk_nb_sectors(blk2
);
1239 if (total_sectors2
< 0) {
1240 error_report("Can't get size of %s: %s",
1241 filename2
, strerror(-total_sectors2
));
1245 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1246 progress_base
= MAX(total_sectors1
, total_sectors2
);
1248 qemu_progress_print(0, 100);
1250 if (strict
&& total_sectors1
!= total_sectors2
) {
1252 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1257 int64_t status1
, status2
;
1258 BlockDriverState
*file
;
1260 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1261 if (nb_sectors
<= 0) {
1264 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1265 total_sectors1
- sector_num
,
1269 error_report("Sector allocation test failed for %s", filename1
);
1272 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1274 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1275 total_sectors2
- sector_num
,
1279 error_report("Sector allocation test failed for %s", filename2
);
1282 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1284 nb_sectors
= MIN(nb_sectors
, pnum1
);
1287 nb_sectors
= MIN(nb_sectors
, pnum2
);
1291 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1292 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1294 qprintf(quiet
, "Strict mode: Offset %" PRId64
1295 " block status mismatch!\n",
1296 sectors_to_bytes(sector_num
));
1300 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1301 nb_sectors
= MIN(pnum1
, pnum2
);
1302 } else if (allocated1
== allocated2
) {
1304 ret
= blk_read(blk1
, sector_num
, buf1
, nb_sectors
);
1306 error_report("Error while reading offset %" PRId64
" of %s:"
1307 " %s", sectors_to_bytes(sector_num
), filename1
,
1312 ret
= blk_read(blk2
, sector_num
, buf2
, nb_sectors
);
1314 error_report("Error while reading offset %" PRId64
1315 " of %s: %s", sectors_to_bytes(sector_num
),
1316 filename2
, strerror(-ret
));
1320 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1321 if (ret
|| pnum
!= nb_sectors
) {
1322 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1324 ret
? sector_num
: sector_num
+ pnum
));
1332 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1333 filename1
, buf1
, quiet
);
1335 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1336 filename2
, buf1
, quiet
);
1340 error_report("Error while reading offset %" PRId64
": %s",
1341 sectors_to_bytes(sector_num
), strerror(-ret
));
1347 sector_num
+= nb_sectors
;
1348 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1351 if (total_sectors1
!= total_sectors2
) {
1352 BlockBackend
*blk_over
;
1353 int64_t total_sectors_over
;
1354 const char *filename_over
;
1356 qprintf(quiet
, "Warning: Image size mismatch!\n");
1357 if (total_sectors1
> total_sectors2
) {
1358 total_sectors_over
= total_sectors1
;
1360 filename_over
= filename1
;
1362 total_sectors_over
= total_sectors2
;
1364 filename_over
= filename2
;
1368 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1369 if (nb_sectors
<= 0) {
1372 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1376 error_report("Sector allocation test failed for %s",
1383 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1384 filename_over
, buf1
, quiet
);
1387 error_report("Error while reading offset %" PRId64
1388 " of %s: %s", sectors_to_bytes(sector_num
),
1389 filename_over
, strerror(-ret
));
1395 sector_num
+= nb_sectors
;
1396 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1400 qprintf(quiet
, "Images are identical.\n");
1410 qemu_progress_end();
1415 enum ImgConvertBlockStatus
{
1421 typedef struct ImgConvertState
{
1423 int64_t *src_sectors
;
1424 int src_cur
, src_num
;
1425 int64_t src_cur_offset
;
1426 int64_t total_sectors
;
1427 int64_t allocated_sectors
;
1428 enum ImgConvertBlockStatus status
;
1429 int64_t sector_next_status
;
1430 BlockBackend
*target
;
1433 bool target_has_backing
;
1435 size_t cluster_sectors
;
1439 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
)
1441 assert(sector_num
>= s
->src_cur_offset
);
1442 while (sector_num
- s
->src_cur_offset
>= s
->src_sectors
[s
->src_cur
]) {
1443 s
->src_cur_offset
+= s
->src_sectors
[s
->src_cur
];
1445 assert(s
->src_cur
< s
->src_num
);
1449 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1454 convert_select_part(s
, sector_num
);
1456 assert(s
->total_sectors
> sector_num
);
1457 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1459 if (s
->sector_next_status
<= sector_num
) {
1460 BlockDriverState
*file
;
1461 ret
= bdrv_get_block_status(blk_bs(s
->src
[s
->src_cur
]),
1462 sector_num
- s
->src_cur_offset
,
1468 if (ret
& BDRV_BLOCK_ZERO
) {
1469 s
->status
= BLK_ZERO
;
1470 } else if (ret
& BDRV_BLOCK_DATA
) {
1471 s
->status
= BLK_DATA
;
1472 } else if (!s
->target_has_backing
) {
1473 /* Without a target backing file we must copy over the contents of
1474 * the backing file as well. */
1475 /* TODO Check block status of the backing file chain to avoid
1476 * needlessly reading zeroes and limiting the iteration to the
1478 s
->status
= BLK_DATA
;
1480 s
->status
= BLK_BACKING_FILE
;
1483 s
->sector_next_status
= sector_num
+ n
;
1486 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1487 if (s
->status
== BLK_DATA
) {
1488 n
= MIN(n
, s
->buf_sectors
);
1491 /* We need to write complete clusters for compressed images, so if an
1492 * unallocated area is shorter than that, we must consider the whole
1493 * cluster allocated. */
1494 if (s
->compressed
) {
1495 if (n
< s
->cluster_sectors
) {
1496 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1497 s
->status
= BLK_DATA
;
1499 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1506 static int convert_read(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1512 assert(nb_sectors
<= s
->buf_sectors
);
1513 while (nb_sectors
> 0) {
1517 /* In the case of compression with multiple source files, we can get a
1518 * nb_sectors that spreads into the next part. So we must be able to
1519 * read across multiple BDSes for one convert_read() call. */
1520 convert_select_part(s
, sector_num
);
1521 blk
= s
->src
[s
->src_cur
];
1522 bs_sectors
= s
->src_sectors
[s
->src_cur
];
1524 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- s
->src_cur_offset
));
1525 ret
= blk_read(blk
, sector_num
- s
->src_cur_offset
, buf
, n
);
1532 buf
+= n
* BDRV_SECTOR_SIZE
;
1538 static int convert_write(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1543 while (nb_sectors
> 0) {
1546 switch (s
->status
) {
1547 case BLK_BACKING_FILE
:
1548 /* If we have a backing file, leave clusters unallocated that are
1549 * unallocated in the source image, so that the backing file is
1550 * visible at the respective offset. */
1551 assert(s
->target_has_backing
);
1555 /* We must always write compressed clusters as a whole, so don't
1556 * try to find zeroed parts in the buffer. We can only save the
1557 * write if the buffer is completely zeroed and we're allowed to
1558 * keep the target sparse. */
1559 if (s
->compressed
) {
1560 if (s
->has_zero_init
&& s
->min_sparse
&&
1561 buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
))
1563 assert(!s
->target_has_backing
);
1567 ret
= blk_write_compressed(s
->target
, sector_num
, buf
, n
);
1574 /* If there is real non-zero data or we're told to keep the target
1575 * fully allocated (-S 0), we must write it. Otherwise we can treat
1576 * it as zero sectors. */
1577 if (!s
->min_sparse
||
1578 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
))
1580 ret
= blk_write(s
->target
, sector_num
, buf
, n
);
1589 if (s
->has_zero_init
) {
1592 ret
= blk_write_zeroes(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1593 n
<< BDRV_SECTOR_BITS
, 0);
1602 buf
+= n
* BDRV_SECTOR_SIZE
;
1608 static int convert_do_copy(ImgConvertState
*s
)
1610 uint8_t *buf
= NULL
;
1611 int64_t sector_num
, allocated_done
;
1615 /* Check whether we have zero initialisation or can get it efficiently */
1616 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1617 ? bdrv_has_zero_init(blk_bs(s
->target
))
1620 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1621 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1623 ret
= bdrv_make_zero(blk_bs(s
->target
), BDRV_REQ_MAY_UNMAP
);
1625 s
->has_zero_init
= true;
1629 /* Allocate buffer for copied data. For compressed images, only one cluster
1630 * can be copied at a time. */
1631 if (s
->compressed
) {
1632 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1633 error_report("invalid cluster size");
1637 s
->buf_sectors
= s
->cluster_sectors
;
1639 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1641 /* Calculate allocated sectors for progress */
1642 s
->allocated_sectors
= 0;
1644 while (sector_num
< s
->total_sectors
) {
1645 n
= convert_iteration_sectors(s
, sector_num
);
1650 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1652 s
->allocated_sectors
+= n
;
1659 s
->src_cur_offset
= 0;
1660 s
->sector_next_status
= 0;
1665 while (sector_num
< s
->total_sectors
) {
1666 n
= convert_iteration_sectors(s
, sector_num
);
1671 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1673 allocated_done
+= n
;
1674 qemu_progress_print(100.0 * allocated_done
/ s
->allocated_sectors
,
1678 if (s
->status
== BLK_DATA
) {
1679 ret
= convert_read(s
, sector_num
, n
, buf
);
1681 error_report("error while reading sector %" PRId64
1682 ": %s", sector_num
, strerror(-ret
));
1685 } else if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1686 n
= MIN(n
, s
->buf_sectors
);
1687 memset(buf
, 0, n
* BDRV_SECTOR_SIZE
);
1688 s
->status
= BLK_DATA
;
1691 ret
= convert_write(s
, sector_num
, n
, buf
);
1693 error_report("error while writing sector %" PRId64
1694 ": %s", sector_num
, strerror(-ret
));
1701 if (s
->compressed
) {
1702 /* signal EOF to align */
1703 ret
= blk_write_compressed(s
->target
, 0, NULL
, 0);
1715 static int img_convert(int argc
, char **argv
)
1717 int c
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1719 int progress
= 0, flags
, src_flags
;
1720 bool writethrough
, src_writethrough
;
1721 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1722 BlockDriver
*drv
, *proto_drv
;
1723 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1724 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1725 int64_t total_sectors
;
1726 int64_t *bs_sectors
= NULL
;
1727 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1728 BlockDriverInfo bdi
;
1729 QemuOpts
*opts
= NULL
;
1730 QemuOptsList
*create_opts
= NULL
;
1731 const char *out_baseimg_param
;
1732 char *options
= NULL
;
1733 const char *snapshot_name
= NULL
;
1734 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1736 Error
*local_err
= NULL
;
1737 QemuOpts
*sn_opts
= NULL
;
1738 ImgConvertState state
;
1739 bool image_opts
= false;
1744 src_cache
= BDRV_DEFAULT_CACHE
;
1749 static const struct option long_options
[] = {
1750 {"help", no_argument
, 0, 'h'},
1751 {"object", required_argument
, 0, OPTION_OBJECT
},
1752 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1755 c
= getopt_long(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1756 long_options
, NULL
);
1772 out_baseimg
= optarg
;
1778 error_report("option -e is deprecated, please use \'-o "
1779 "encryption\' instead!");
1783 error_report("option -6 is deprecated, please use \'-o "
1784 "compat6\' instead!");
1788 if (!is_valid_option_list(optarg
)) {
1789 error_report("Invalid option list: %s", optarg
);
1794 options
= g_strdup(optarg
);
1796 char *old_options
= options
;
1797 options
= g_strdup_printf("%s,%s", options
, optarg
);
1798 g_free(old_options
);
1802 snapshot_name
= optarg
;
1805 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1806 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
1809 error_report("Failed in parsing snapshot param '%s'",
1815 snapshot_name
= optarg
;
1822 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
1823 if (sval
< 0 || *end
) {
1824 error_report("Invalid minimum zero buffer size for sparse output specified");
1829 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1848 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1854 case OPTION_IMAGE_OPTS
:
1860 if (qemu_opts_foreach(&qemu_object_opts
,
1861 user_creatable_add_opts_foreach
,
1866 /* Initialize before goto out */
1870 qemu_progress_init(progress
, 1.0);
1872 bs_n
= argc
- optind
- 1;
1873 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1875 if (options
&& has_help_option(options
)) {
1876 ret
= print_block_option_help(out_filename
, out_fmt
);
1881 error_exit("Must specify image file name");
1885 if (bs_n
> 1 && out_baseimg
) {
1886 error_report("-B makes no sense when concatenating multiple input "
1893 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
1895 error_report("Invalid source cache option: %s", src_cache
);
1899 qemu_progress_print(0, 100);
1901 blk
= g_new0(BlockBackend
*, bs_n
);
1902 bs
= g_new0(BlockDriverState
*, bs_n
);
1903 bs_sectors
= g_new(int64_t, bs_n
);
1906 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1907 blk
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
1908 fmt
, src_flags
, src_writethrough
, quiet
);
1913 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1914 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
1915 if (bs_sectors
[bs_i
] < 0) {
1916 error_report("Could not get size of %s: %s",
1917 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1921 total_sectors
+= bs_sectors
[bs_i
];
1925 ret
= bdrv_snapshot_load_tmp(bs
[0],
1926 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1927 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1929 } else if (snapshot_name
!= NULL
) {
1931 error_report("No support for concatenating multiple snapshot");
1936 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1939 error_reportf_err(local_err
, "Failed to load snapshot: ");
1944 /* Find driver and parse its options */
1945 drv
= bdrv_find_format(out_fmt
);
1947 error_report("Unknown file format '%s'", out_fmt
);
1952 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
1954 error_report_err(local_err
);
1960 if (!drv
->create_opts
) {
1961 error_report("Format driver '%s' does not support image creation",
1967 if (!proto_drv
->create_opts
) {
1968 error_report("Protocol driver '%s' does not support image creation",
1969 proto_drv
->format_name
);
1974 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1975 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1977 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1979 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
1981 error_report_err(local_err
);
1987 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
1989 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
1995 /* Get backing file name if -o backing_file was used */
1996 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
1997 if (out_baseimg_param
) {
1998 out_baseimg
= out_baseimg_param
;
2001 /* Check if compression is supported */
2004 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2005 const char *preallocation
=
2006 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2008 if (!drv
->bdrv_write_compressed
) {
2009 error_report("Compression not supported for this file format");
2015 error_report("Compression and encryption not supported at "
2022 && strcmp(preallocation
, "off"))
2024 error_report("Compression and preallocation not supported at "
2032 /* Create the new image */
2033 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2035 error_reportf_err(local_err
, "%s: error while converting %s: ",
2036 out_filename
, out_fmt
);
2041 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2042 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2044 error_report("Invalid cache option: %s", cache
);
2048 /* XXX we should allow --image-opts to trigger use of
2049 * img_open() here, but then we have trouble with
2050 * the bdrv_create() call which takes different params.
2051 * Not critical right now, so fix can wait...
2053 out_blk
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
);
2058 out_bs
= blk_bs(out_blk
);
2060 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
2061 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2063 bufsectors
= MIN(32768,
2064 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
2065 out_bs
->bl
.discard_alignment
))
2069 int64_t output_sectors
= blk_nb_sectors(out_blk
);
2070 if (output_sectors
< 0) {
2071 error_report("unable to get output image length: %s",
2072 strerror(-output_sectors
));
2075 } else if (output_sectors
< total_sectors
) {
2076 error_report("output file is smaller than input file");
2082 cluster_sectors
= 0;
2083 ret
= bdrv_get_info(out_bs
, &bdi
);
2086 error_report("could not get block driver info");
2090 compress
= compress
|| bdi
.needs_compressed_writes
;
2091 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2094 state
= (ImgConvertState
) {
2096 .src_sectors
= bs_sectors
,
2098 .total_sectors
= total_sectors
,
2100 .compressed
= compress
,
2101 .target_has_backing
= (bool) out_baseimg
,
2102 .min_sparse
= min_sparse
,
2103 .cluster_sectors
= cluster_sectors
,
2104 .buf_sectors
= bufsectors
,
2106 ret
= convert_do_copy(&state
);
2110 qemu_progress_print(100, 0);
2112 qemu_progress_end();
2113 qemu_opts_del(opts
);
2114 qemu_opts_free(create_opts
);
2115 qemu_opts_del(sn_opts
);
2119 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2120 blk_unref(blk
[bs_i
]);
2135 static void dump_snapshots(BlockDriverState
*bs
)
2137 QEMUSnapshotInfo
*sn_tab
, *sn
;
2140 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2143 printf("Snapshot list:\n");
2144 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2146 for(i
= 0; i
< nb_sns
; i
++) {
2148 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2154 static void dump_json_image_info_list(ImageInfoList
*list
)
2156 Error
*local_err
= NULL
;
2158 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2160 visit_type_ImageInfoList(qmp_output_get_visitor(ov
), NULL
, &list
,
2162 obj
= qmp_output_get_qobject(ov
);
2163 str
= qobject_to_json_pretty(obj
);
2164 assert(str
!= NULL
);
2165 printf("%s\n", qstring_get_str(str
));
2166 qobject_decref(obj
);
2167 qmp_output_visitor_cleanup(ov
);
2171 static void dump_json_image_info(ImageInfo
*info
)
2173 Error
*local_err
= NULL
;
2175 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2177 visit_type_ImageInfo(qmp_output_get_visitor(ov
), NULL
, &info
, &local_err
);
2178 obj
= qmp_output_get_qobject(ov
);
2179 str
= qobject_to_json_pretty(obj
);
2180 assert(str
!= NULL
);
2181 printf("%s\n", qstring_get_str(str
));
2182 qobject_decref(obj
);
2183 qmp_output_visitor_cleanup(ov
);
2187 static void dump_human_image_info_list(ImageInfoList
*list
)
2189 ImageInfoList
*elem
;
2192 for (elem
= list
; elem
; elem
= elem
->next
) {
2198 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2202 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2204 return strcmp(a
, b
) == 0;
2208 * Open an image file chain and return an ImageInfoList
2210 * @filename: topmost image filename
2211 * @fmt: topmost image format (may be NULL to autodetect)
2212 * @chain: true - enumerate entire backing file chain
2213 * false - only topmost image file
2215 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2216 * image file. If there was an error a message will have been printed to
2219 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2220 const char *filename
,
2224 ImageInfoList
*head
= NULL
;
2225 ImageInfoList
**last
= &head
;
2226 GHashTable
*filenames
;
2229 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2233 BlockDriverState
*bs
;
2235 ImageInfoList
*elem
;
2237 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2238 error_report("Backing file '%s' creates an infinite loop.",
2242 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2244 blk
= img_open(image_opts
, filename
, fmt
,
2245 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false);
2251 bdrv_query_image_info(bs
, &info
, &err
);
2253 error_report_err(err
);
2258 elem
= g_new0(ImageInfoList
, 1);
2265 filename
= fmt
= NULL
;
2267 if (info
->has_full_backing_filename
) {
2268 filename
= info
->full_backing_filename
;
2269 } else if (info
->has_backing_filename
) {
2270 error_report("Could not determine absolute backing filename,"
2271 " but backing filename '%s' present",
2272 info
->backing_filename
);
2275 if (info
->has_backing_filename_format
) {
2276 fmt
= info
->backing_filename_format
;
2280 g_hash_table_destroy(filenames
);
2284 qapi_free_ImageInfoList(head
);
2285 g_hash_table_destroy(filenames
);
2289 static int img_info(int argc
, char **argv
)
2292 OutputFormat output_format
= OFORMAT_HUMAN
;
2294 const char *filename
, *fmt
, *output
;
2295 ImageInfoList
*list
;
2296 bool image_opts
= false;
2301 int option_index
= 0;
2302 static const struct option long_options
[] = {
2303 {"help", no_argument
, 0, 'h'},
2304 {"format", required_argument
, 0, 'f'},
2305 {"output", required_argument
, 0, OPTION_OUTPUT
},
2306 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2307 {"object", required_argument
, 0, OPTION_OBJECT
},
2308 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2311 c
= getopt_long(argc
, argv
, "f:h",
2312 long_options
, &option_index
);
2327 case OPTION_BACKING_CHAIN
:
2330 case OPTION_OBJECT
: {
2332 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2338 case OPTION_IMAGE_OPTS
:
2343 if (optind
!= argc
- 1) {
2344 error_exit("Expecting one image file name");
2346 filename
= argv
[optind
++];
2348 if (output
&& !strcmp(output
, "json")) {
2349 output_format
= OFORMAT_JSON
;
2350 } else if (output
&& !strcmp(output
, "human")) {
2351 output_format
= OFORMAT_HUMAN
;
2352 } else if (output
) {
2353 error_report("--output must be used with human or json as argument.");
2357 if (qemu_opts_foreach(&qemu_object_opts
,
2358 user_creatable_add_opts_foreach
,
2363 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
);
2368 switch (output_format
) {
2370 dump_human_image_info_list(list
);
2374 dump_json_image_info_list(list
);
2376 dump_json_image_info(list
->value
);
2381 qapi_free_ImageInfoList(list
);
2385 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2388 switch (output_format
) {
2390 if (e
->data
&& !e
->has_offset
) {
2391 error_report("File contains external, encrypted or compressed clusters.");
2394 if (e
->data
&& !e
->zero
) {
2395 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2396 e
->start
, e
->length
,
2397 e
->has_offset
? e
->offset
: 0,
2398 e
->has_filename
? e
->filename
: "");
2400 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2401 * Modify the flags here to allow more coalescing.
2403 if (next
&& (!next
->data
|| next
->zero
)) {
2409 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2410 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2411 (e
->start
== 0 ? "[" : ",\n"),
2412 e
->start
, e
->length
, e
->depth
,
2413 e
->zero
? "true" : "false",
2414 e
->data
? "true" : "false");
2415 if (e
->has_offset
) {
2416 printf(", \"offset\": %"PRId64
"", e
->offset
);
2427 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2428 int nb_sectors
, MapEntry
*e
)
2432 BlockDriverState
*file
;
2435 /* As an optimization, we could cache the current range of unallocated
2436 * clusters in each file of the chain, and avoid querying the same
2442 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2448 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2451 bs
= backing_bs(bs
);
2460 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2463 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2464 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2465 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2466 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2467 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2468 .has_offset
= has_offset
,
2470 .has_filename
= file
&& has_offset
,
2471 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2477 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2479 if (curr
->length
== 0) {
2482 if (curr
->zero
!= next
->zero
||
2483 curr
->data
!= next
->data
||
2484 curr
->depth
!= next
->depth
||
2485 curr
->has_filename
!= next
->has_filename
||
2486 curr
->has_offset
!= next
->has_offset
) {
2489 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2492 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2498 static int img_map(int argc
, char **argv
)
2501 OutputFormat output_format
= OFORMAT_HUMAN
;
2503 BlockDriverState
*bs
;
2504 const char *filename
, *fmt
, *output
;
2506 MapEntry curr
= { .length
= 0 }, next
;
2508 bool image_opts
= false;
2513 int option_index
= 0;
2514 static const struct option long_options
[] = {
2515 {"help", no_argument
, 0, 'h'},
2516 {"format", required_argument
, 0, 'f'},
2517 {"output", required_argument
, 0, OPTION_OUTPUT
},
2518 {"object", required_argument
, 0, OPTION_OBJECT
},
2519 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2522 c
= getopt_long(argc
, argv
, "f:h",
2523 long_options
, &option_index
);
2538 case OPTION_OBJECT
: {
2540 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2546 case OPTION_IMAGE_OPTS
:
2551 if (optind
!= argc
- 1) {
2552 error_exit("Expecting one image file name");
2554 filename
= argv
[optind
];
2556 if (output
&& !strcmp(output
, "json")) {
2557 output_format
= OFORMAT_JSON
;
2558 } else if (output
&& !strcmp(output
, "human")) {
2559 output_format
= OFORMAT_HUMAN
;
2560 } else if (output
) {
2561 error_report("--output must be used with human or json as argument.");
2565 if (qemu_opts_foreach(&qemu_object_opts
,
2566 user_creatable_add_opts_foreach
,
2571 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false);
2577 if (output_format
== OFORMAT_HUMAN
) {
2578 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2581 length
= blk_getlength(blk
);
2582 while (curr
.start
+ curr
.length
< length
) {
2583 int64_t nsectors_left
;
2587 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2589 /* Probe up to 1 GiB at a time. */
2590 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2591 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2592 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2595 error_report("Could not read file metadata: %s", strerror(-ret
));
2599 if (entry_mergeable(&curr
, &next
)) {
2600 curr
.length
+= next
.length
;
2604 if (curr
.length
> 0) {
2605 dump_map_entry(output_format
, &curr
, &next
);
2610 dump_map_entry(output_format
, &curr
, NULL
);
2617 #define SNAPSHOT_LIST 1
2618 #define SNAPSHOT_CREATE 2
2619 #define SNAPSHOT_APPLY 3
2620 #define SNAPSHOT_DELETE 4
2622 static int img_snapshot(int argc
, char **argv
)
2625 BlockDriverState
*bs
;
2626 QEMUSnapshotInfo sn
;
2627 char *filename
, *snapshot_name
= NULL
;
2628 int c
, ret
= 0, bdrv_oflags
;
2633 bool image_opts
= false;
2635 bdrv_oflags
= BDRV_O_RDWR
;
2636 /* Parse commandline parameters */
2638 static const struct option long_options
[] = {
2639 {"help", no_argument
, 0, 'h'},
2640 {"object", required_argument
, 0, OPTION_OBJECT
},
2641 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2644 c
= getopt_long(argc
, argv
, "la:c:d:hq",
2645 long_options
, NULL
);
2656 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2659 action
= SNAPSHOT_LIST
;
2660 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2664 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2667 action
= SNAPSHOT_APPLY
;
2668 snapshot_name
= optarg
;
2672 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2675 action
= SNAPSHOT_CREATE
;
2676 snapshot_name
= optarg
;
2680 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2683 action
= SNAPSHOT_DELETE
;
2684 snapshot_name
= optarg
;
2689 case OPTION_OBJECT
: {
2691 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2697 case OPTION_IMAGE_OPTS
:
2703 if (optind
!= argc
- 1) {
2704 error_exit("Expecting one image file name");
2706 filename
= argv
[optind
++];
2708 if (qemu_opts_foreach(&qemu_object_opts
,
2709 user_creatable_add_opts_foreach
,
2714 /* Open the image */
2715 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
);
2721 /* Perform the requested action */
2727 case SNAPSHOT_CREATE
:
2728 memset(&sn
, 0, sizeof(sn
));
2729 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2731 qemu_gettimeofday(&tv
);
2732 sn
.date_sec
= tv
.tv_sec
;
2733 sn
.date_nsec
= tv
.tv_usec
* 1000;
2735 ret
= bdrv_snapshot_create(bs
, &sn
);
2737 error_report("Could not create snapshot '%s': %d (%s)",
2738 snapshot_name
, ret
, strerror(-ret
));
2742 case SNAPSHOT_APPLY
:
2743 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2745 error_report("Could not apply snapshot '%s': %d (%s)",
2746 snapshot_name
, ret
, strerror(-ret
));
2750 case SNAPSHOT_DELETE
:
2751 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2753 error_reportf_err(err
, "Could not delete snapshot '%s': ",
2768 static int img_rebase(int argc
, char **argv
)
2770 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2771 uint8_t *buf_old
= NULL
;
2772 uint8_t *buf_new
= NULL
;
2773 BlockDriverState
*bs
= NULL
;
2775 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2776 int c
, flags
, src_flags
, ret
;
2777 bool writethrough
, src_writethrough
;
2781 Error
*local_err
= NULL
;
2782 bool image_opts
= false;
2784 /* Parse commandline parameters */
2786 cache
= BDRV_DEFAULT_CACHE
;
2787 src_cache
= BDRV_DEFAULT_CACHE
;
2791 static const struct option long_options
[] = {
2792 {"help", no_argument
, 0, 'h'},
2793 {"object", required_argument
, 0, OPTION_OBJECT
},
2794 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2797 c
= getopt_long(argc
, argv
, "hf:F:b:upt:T:q",
2798 long_options
, NULL
);
2811 out_basefmt
= optarg
;
2814 out_baseimg
= optarg
;
2831 case OPTION_OBJECT
: {
2833 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2839 case OPTION_IMAGE_OPTS
:
2849 if (optind
!= argc
- 1) {
2850 error_exit("Expecting one image file name");
2852 if (!unsafe
&& !out_baseimg
) {
2853 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2855 filename
= argv
[optind
++];
2857 if (qemu_opts_foreach(&qemu_object_opts
,
2858 user_creatable_add_opts_foreach
,
2863 qemu_progress_init(progress
, 2.0);
2864 qemu_progress_print(0, 100);
2866 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2867 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2869 error_report("Invalid cache option: %s", cache
);
2874 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2876 error_report("Invalid source cache option: %s", src_cache
);
2880 /* The source files are opened read-only, don't care about WCE */
2881 assert((src_flags
& BDRV_O_RDWR
) == 0);
2882 (void) src_writethrough
;
2887 * Ignore the old backing file for unsafe rebase in case we want to correct
2888 * the reference to a renamed or moved backing file.
2890 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
2897 if (out_basefmt
!= NULL
) {
2898 if (bdrv_find_format(out_basefmt
) == NULL
) {
2899 error_report("Invalid format name: '%s'", out_basefmt
);
2905 /* For safe rebasing we need to compare old and new backing file */
2907 char backing_name
[PATH_MAX
];
2908 QDict
*options
= NULL
;
2910 if (bs
->backing_format
[0] != '\0') {
2911 options
= qdict_new();
2912 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
2915 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2916 blk_old_backing
= blk_new_open(backing_name
, NULL
,
2917 options
, src_flags
, &local_err
);
2918 if (!blk_old_backing
) {
2919 error_reportf_err(local_err
,
2920 "Could not open old backing file '%s': ",
2925 if (out_baseimg
[0]) {
2927 options
= qdict_new();
2928 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
2933 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
2934 options
, src_flags
, &local_err
);
2935 if (!blk_new_backing
) {
2936 error_reportf_err(local_err
,
2937 "Could not open new backing file '%s': ",
2945 * Check each unallocated cluster in the COW file. If it is unallocated,
2946 * accesses go to the backing file. We must therefore compare this cluster
2947 * in the old and new backing file, and if they differ we need to copy it
2948 * from the old backing file into the COW file.
2950 * If qemu-img crashes during this step, no harm is done. The content of
2951 * the image is the same as the original one at any time.
2954 int64_t num_sectors
;
2955 int64_t old_backing_num_sectors
;
2956 int64_t new_backing_num_sectors
= 0;
2959 float local_progress
= 0;
2961 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
2962 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
2964 num_sectors
= blk_nb_sectors(blk
);
2965 if (num_sectors
< 0) {
2966 error_report("Could not get size of '%s': %s",
2967 filename
, strerror(-num_sectors
));
2971 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
2972 if (old_backing_num_sectors
< 0) {
2973 char backing_name
[PATH_MAX
];
2975 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2976 error_report("Could not get size of '%s': %s",
2977 backing_name
, strerror(-old_backing_num_sectors
));
2981 if (blk_new_backing
) {
2982 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
2983 if (new_backing_num_sectors
< 0) {
2984 error_report("Could not get size of '%s': %s",
2985 out_baseimg
, strerror(-new_backing_num_sectors
));
2991 if (num_sectors
!= 0) {
2992 local_progress
= (float)100 /
2993 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
2996 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
2998 /* How many sectors can we handle with the next read? */
2999 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3000 n
= (IO_BUF_SIZE
/ 512);
3002 n
= num_sectors
- sector
;
3005 /* If the cluster is allocated, we don't need to take action */
3006 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3008 error_report("error while reading image metadata: %s",
3017 * Read old and new backing file and take into consideration that
3018 * backing files may be smaller than the COW image.
3020 if (sector
>= old_backing_num_sectors
) {
3021 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3023 if (sector
+ n
> old_backing_num_sectors
) {
3024 n
= old_backing_num_sectors
- sector
;
3027 ret
= blk_read(blk_old_backing
, sector
, buf_old
, n
);
3029 error_report("error while reading from old backing file");
3034 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3035 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3037 if (sector
+ n
> new_backing_num_sectors
) {
3038 n
= new_backing_num_sectors
- sector
;
3041 ret
= blk_read(blk_new_backing
, sector
, buf_new
, n
);
3043 error_report("error while reading from new backing file");
3048 /* If they differ, we need to write to the COW file */
3049 uint64_t written
= 0;
3051 while (written
< n
) {
3054 if (compare_sectors(buf_old
+ written
* 512,
3055 buf_new
+ written
* 512, n
- written
, &pnum
))
3057 ret
= blk_write(blk
, sector
+ written
,
3058 buf_old
+ written
* 512, pnum
);
3060 error_report("Error while writing to COW image: %s",
3068 qemu_progress_print(local_progress
, 100);
3073 * Change the backing file. All clusters that are different from the old
3074 * backing file are overwritten in the COW file now, so the visible content
3075 * doesn't change when we switch the backing file.
3077 if (out_baseimg
&& *out_baseimg
) {
3078 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3080 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3083 if (ret
== -ENOSPC
) {
3084 error_report("Could not change the backing file to '%s': No "
3085 "space left in the file header", out_baseimg
);
3086 } else if (ret
< 0) {
3087 error_report("Could not change the backing file to '%s': %s",
3088 out_baseimg
, strerror(-ret
));
3091 qemu_progress_print(100, 0);
3093 * TODO At this point it is possible to check if any clusters that are
3094 * allocated in the COW file are the same in the backing file. If so, they
3095 * could be dropped from the COW file. Don't do this before switching the
3096 * backing file, in case of a crash this would lead to corruption.
3099 qemu_progress_end();
3102 blk_unref(blk_old_backing
);
3103 blk_unref(blk_new_backing
);
3105 qemu_vfree(buf_old
);
3106 qemu_vfree(buf_new
);
3115 static int img_resize(int argc
, char **argv
)
3118 int c
, ret
, relative
;
3119 const char *filename
, *fmt
, *size
;
3120 int64_t n
, total_size
;
3122 BlockBackend
*blk
= NULL
;
3125 static QemuOptsList resize_options
= {
3126 .name
= "resize_options",
3127 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3130 .name
= BLOCK_OPT_SIZE
,
3131 .type
= QEMU_OPT_SIZE
,
3132 .help
= "Virtual disk size"
3138 bool image_opts
= false;
3140 /* Remove size from argv manually so that negative numbers are not treated
3141 * as options by getopt. */
3143 error_exit("Not enough arguments");
3147 size
= argv
[--argc
];
3149 /* Parse getopt arguments */
3152 static const struct option long_options
[] = {
3153 {"help", no_argument
, 0, 'h'},
3154 {"object", required_argument
, 0, OPTION_OBJECT
},
3155 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3158 c
= getopt_long(argc
, argv
, "f:hq",
3159 long_options
, NULL
);
3174 case OPTION_OBJECT
: {
3176 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3182 case OPTION_IMAGE_OPTS
:
3187 if (optind
!= argc
- 1) {
3188 error_exit("Expecting one image file name");
3190 filename
= argv
[optind
++];
3192 if (qemu_opts_foreach(&qemu_object_opts
,
3193 user_creatable_add_opts_foreach
,
3198 /* Choose grow, shrink, or absolute resize mode */
3214 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3215 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3217 error_report_err(err
);
3219 qemu_opts_del(param
);
3222 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3223 qemu_opts_del(param
);
3225 blk
= img_open(image_opts
, filename
, fmt
,
3226 BDRV_O_RDWR
, false, quiet
);
3233 total_size
= blk_getlength(blk
) + n
* relative
;
3237 if (total_size
<= 0) {
3238 error_report("New image size must be positive");
3243 ret
= blk_truncate(blk
, total_size
);
3246 qprintf(quiet
, "Image resized.\n");
3249 error_report("This image does not support resize");
3252 error_report("Image is read-only");
3255 error_report("Error resizing image (%d)", -ret
);
3266 static void amend_status_cb(BlockDriverState
*bs
,
3267 int64_t offset
, int64_t total_work_size
,
3270 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3273 static int img_amend(int argc
, char **argv
)
3277 char *options
= NULL
;
3278 QemuOptsList
*create_opts
= NULL
;
3279 QemuOpts
*opts
= NULL
;
3280 const char *fmt
= NULL
, *filename
, *cache
;
3283 bool quiet
= false, progress
= false;
3284 BlockBackend
*blk
= NULL
;
3285 BlockDriverState
*bs
= NULL
;
3286 bool image_opts
= false;
3288 cache
= BDRV_DEFAULT_CACHE
;
3290 static const struct option long_options
[] = {
3291 {"help", no_argument
, 0, 'h'},
3292 {"object", required_argument
, 0, OPTION_OBJECT
},
3293 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3296 c
= getopt_long(argc
, argv
, "ho:f:t:pq",
3297 long_options
, NULL
);
3308 if (!is_valid_option_list(optarg
)) {
3309 error_report("Invalid option list: %s", optarg
);
3311 goto out_no_progress
;
3314 options
= g_strdup(optarg
);
3316 char *old_options
= options
;
3317 options
= g_strdup_printf("%s,%s", options
, optarg
);
3318 g_free(old_options
);
3334 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3338 goto out_no_progress
;
3341 case OPTION_IMAGE_OPTS
:
3348 error_exit("Must specify options (-o)");
3351 if (qemu_opts_foreach(&qemu_object_opts
,
3352 user_creatable_add_opts_foreach
,
3355 goto out_no_progress
;
3361 qemu_progress_init(progress
, 1.0);
3363 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3364 if (fmt
&& has_help_option(options
)) {
3365 /* If a format is explicitly specified (and possibly no filename is
3366 * given), print option help here */
3367 ret
= print_block_option_help(filename
, fmt
);
3371 if (optind
!= argc
- 1) {
3372 error_report("Expecting one image file name");
3377 flags
= BDRV_O_RDWR
;
3378 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3380 error_report("Invalid cache option: %s", cache
);
3384 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3391 fmt
= bs
->drv
->format_name
;
3393 if (has_help_option(options
)) {
3394 /* If the format was auto-detected, print option help here */
3395 ret
= print_block_option_help(filename
, fmt
);
3399 if (!bs
->drv
->create_opts
) {
3400 error_report("Format driver '%s' does not support any options to amend",
3406 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3407 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3409 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3411 error_report_err(err
);
3417 /* In case the driver does not call amend_status_cb() */
3418 qemu_progress_print(0.f
, 0);
3419 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3420 qemu_progress_print(100.f
, 0);
3422 error_report("Error while amending options: %s", strerror(-ret
));
3427 qemu_progress_end();
3431 qemu_opts_del(opts
);
3432 qemu_opts_free(create_opts
);
3441 static const img_cmd_t img_cmds
[] = {
3442 #define DEF(option, callback, arg_string) \
3443 { option, callback },
3444 #include "qemu-img-cmds.h"
3450 int main(int argc
, char **argv
)
3452 const img_cmd_t
*cmd
;
3453 const char *cmdname
;
3454 Error
*local_error
= NULL
;
3456 static const struct option long_options
[] = {
3457 {"help", no_argument
, 0, 'h'},
3458 {"version", no_argument
, 0, 'v'},
3463 signal(SIGPIPE
, SIG_IGN
);
3466 error_set_progname(argv
[0]);
3467 qemu_init_exec_dir(argv
[0]);
3469 if (qemu_init_main_loop(&local_error
)) {
3470 error_report_err(local_error
);
3474 if (qcrypto_init(&local_error
) < 0) {
3475 error_reportf_err(local_error
, "cannot initialize crypto: ");
3479 module_call_init(MODULE_INIT_QOM
);
3482 error_exit("Not enough arguments");
3486 qemu_add_opts(&qemu_object_opts
);
3487 qemu_add_opts(&qemu_source_opts
);
3489 /* find the command */
3490 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
3491 if (!strcmp(cmdname
, cmd
->name
)) {
3492 return cmd
->handler(argc
- 1, argv
+ 1);
3496 c
= getopt_long(argc
, argv
, "h", long_options
, NULL
);
3502 printf(QEMU_IMG_VERSION
);
3507 error_exit("Command not found: %s", cmdname
);