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"
42 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
43 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
45 typedef struct img_cmd_t
{
47 int (*handler
)(int argc
, char **argv
);
52 OPTION_BACKING_CHAIN
= 257,
54 OPTION_IMAGE_OPTS
= 259,
57 typedef enum OutputFormat
{
62 /* Default to cache=writeback as data integrity is not important for qemu-img */
63 #define BDRV_DEFAULT_CACHE "writeback"
65 static void format_print(void *opaque
, const char *name
)
70 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
74 error_printf("qemu-img: ");
77 error_vprintf(fmt
, ap
);
80 error_printf("\nTry 'qemu-img --help' for more information\n");
84 /* Please keep in synch with qemu-img.texi */
85 static void QEMU_NORETURN
help(void)
87 const char *help_msg
=
89 "usage: qemu-img command [command options]\n"
90 "QEMU disk image utility\n"
93 #define DEF(option, callback, arg_string) \
95 #include "qemu-img-cmds.h"
99 "Command parameters:\n"
100 " 'filename' is a disk image filename\n"
101 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
102 " manual page for a description of the object properties. The most common\n"
103 " object type is a 'secret', which is used to supply passwords and/or\n"
104 " encryption keys.\n"
105 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
106 " 'cache' is the cache mode used to write the output disk image, the valid\n"
107 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
108 " 'directsync' and 'unsafe' (default for convert)\n"
109 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
110 " options are the same as for the 'cache' option\n"
111 " 'size' is the disk image size in bytes. Optional suffixes\n"
112 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
113 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
114 " supported. 'b' is ignored.\n"
115 " 'output_filename' is the destination disk image filename\n"
116 " 'output_fmt' is the destination format\n"
117 " 'options' is a comma separated list of format specific options in a\n"
118 " name=value format. Use -o ? for an overview of the options supported by the\n"
120 " 'snapshot_param' is param used for internal snapshot, format\n"
121 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
123 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
125 " '-c' indicates that target image must be compressed (qcow format only)\n"
126 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
127 " match exactly. The image doesn't need a working backing file before\n"
128 " rebasing in this case (useful for renaming the backing file)\n"
129 " '-h' with or without a command shows this help and lists the supported formats\n"
130 " '-p' show progress of command (only certain commands)\n"
131 " '-q' use Quiet mode - do not print any output (except errors)\n"
132 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
133 " contain only zeros for qemu-img to create a sparse image during\n"
134 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
135 " unallocated or zero sectors, and the destination image will always be\n"
137 " '--output' takes the format in which the output must be done (human or json)\n"
138 " '-n' skips the target volume creation (useful if the volume is created\n"
139 " prior to running qemu-img)\n"
141 "Parameters to check subcommand:\n"
142 " '-r' tries to repair any inconsistencies that are found during the check.\n"
143 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
144 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
145 " hiding corruption that has already occurred.\n"
147 "Parameters to snapshot subcommand:\n"
148 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
149 " '-a' applies a snapshot (revert disk to saved state)\n"
150 " '-c' creates a snapshot\n"
151 " '-d' deletes a snapshot\n"
152 " '-l' lists all snapshots in the given image\n"
154 "Parameters to compare subcommand:\n"
155 " '-f' first image format\n"
156 " '-F' second image format\n"
157 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
159 printf("%s\nSupported formats:", help_msg
);
160 bdrv_iterate_format(format_print
, NULL
);
165 static QemuOptsList qemu_object_opts
= {
167 .implied_opt_name
= "qom-type",
168 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
174 static QemuOptsList qemu_source_opts
= {
176 .implied_opt_name
= "file",
177 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
183 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
189 ret
= vprintf(fmt
, args
);
196 static int print_block_option_help(const char *filename
, const char *fmt
)
198 BlockDriver
*drv
, *proto_drv
;
199 QemuOptsList
*create_opts
= NULL
;
200 Error
*local_err
= NULL
;
202 /* Find driver and parse its options */
203 drv
= bdrv_find_format(fmt
);
205 error_report("Unknown file format '%s'", fmt
);
209 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
211 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
213 error_report_err(local_err
);
214 qemu_opts_free(create_opts
);
217 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
220 qemu_opts_print_help(create_opts
);
221 qemu_opts_free(create_opts
);
226 static int img_open_password(BlockBackend
*blk
, const char *filename
,
227 int flags
, bool quiet
)
229 BlockDriverState
*bs
;
233 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
234 !(flags
& BDRV_O_NO_IO
)) {
235 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
236 if (qemu_read_password(password
, sizeof(password
)) < 0) {
237 error_report("No password given");
240 if (bdrv_set_key(bs
, password
) < 0) {
241 error_report("invalid password");
249 static BlockBackend
*img_open_opts(const char *optstr
,
250 QemuOpts
*opts
, int flags
, bool writethrough
,
254 Error
*local_err
= NULL
;
256 options
= qemu_opts_to_qdict(opts
, NULL
);
257 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
259 error_reportf_err(local_err
, "Could not open '%s'", optstr
);
262 blk_set_enable_write_cache(blk
, !writethrough
);
264 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
271 static BlockBackend
*img_open_file(const char *filename
,
272 const char *fmt
, int flags
,
273 bool writethrough
, bool quiet
)
276 Error
*local_err
= NULL
;
277 QDict
*options
= NULL
;
280 options
= qdict_new();
281 qdict_put(options
, "driver", qstring_from_str(fmt
));
284 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
286 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
289 blk_set_enable_write_cache(blk
, !writethrough
);
291 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
299 static BlockBackend
*img_open(bool image_opts
,
300 const char *filename
,
301 const char *fmt
, int flags
, bool writethrough
,
308 error_report("--image-opts and --format are mutually exclusive");
311 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
316 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
);
318 blk
= img_open_file(filename
, fmt
, flags
, writethrough
, quiet
);
324 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
325 const char *base_filename
,
326 const char *base_fmt
)
331 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
333 error_report("Backing file not supported for file format '%s'",
340 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
342 error_report("Backing file format not supported for file "
351 static int img_create(int argc
, char **argv
)
354 uint64_t img_size
= -1;
355 const char *fmt
= "raw";
356 const char *base_fmt
= NULL
;
357 const char *filename
;
358 const char *base_filename
= NULL
;
359 char *options
= NULL
;
360 Error
*local_err
= NULL
;
364 static const struct option long_options
[] = {
365 {"help", no_argument
, 0, 'h'},
366 {"object", required_argument
, 0, OPTION_OBJECT
},
369 c
= getopt_long(argc
, argv
, "F:b:f:he6o:q",
383 base_filename
= optarg
;
389 error_report("option -e is deprecated, please use \'-o "
390 "encryption\' instead!");
393 error_report("option -6 is deprecated, please use \'-o "
394 "compat6\' instead!");
397 if (!is_valid_option_list(optarg
)) {
398 error_report("Invalid option list: %s", optarg
);
402 options
= g_strdup(optarg
);
404 char *old_options
= options
;
405 options
= g_strdup_printf("%s,%s", options
, optarg
);
412 case OPTION_OBJECT
: {
414 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
423 /* Get the filename */
424 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
425 if (options
&& has_help_option(options
)) {
427 return print_block_option_help(filename
, fmt
);
430 if (optind
>= argc
) {
431 error_exit("Expecting image file name");
435 if (qemu_opts_foreach(&qemu_object_opts
,
436 user_creatable_add_opts_foreach
,
438 error_report_err(local_err
);
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 Error
*local_err
= NULL
;
601 bool image_opts
= false;
605 cache
= BDRV_DEFAULT_CACHE
;
608 int option_index
= 0;
609 static const struct option long_options
[] = {
610 {"help", no_argument
, 0, 'h'},
611 {"format", required_argument
, 0, 'f'},
612 {"repair", required_argument
, 0, 'r'},
613 {"output", required_argument
, 0, OPTION_OUTPUT
},
614 {"object", required_argument
, 0, OPTION_OBJECT
},
615 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
618 c
= getopt_long(argc
, argv
, "hf:r:T:q",
619 long_options
, &option_index
);
632 flags
|= BDRV_O_RDWR
;
634 if (!strcmp(optarg
, "leaks")) {
635 fix
= BDRV_FIX_LEAKS
;
636 } else if (!strcmp(optarg
, "all")) {
637 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
639 error_exit("Unknown option value for -r "
640 "(expecting 'leaks' or 'all'): %s", optarg
);
652 case OPTION_OBJECT
: {
654 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
660 case OPTION_IMAGE_OPTS
:
665 if (optind
!= argc
- 1) {
666 error_exit("Expecting one image file name");
668 filename
= argv
[optind
++];
670 if (output
&& !strcmp(output
, "json")) {
671 output_format
= OFORMAT_JSON
;
672 } else if (output
&& !strcmp(output
, "human")) {
673 output_format
= OFORMAT_HUMAN
;
675 error_report("--output must be used with human or json as argument.");
679 if (qemu_opts_foreach(&qemu_object_opts
,
680 user_creatable_add_opts_foreach
,
682 error_report_err(local_err
);
686 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
688 error_report("Invalid source cache option: %s", cache
);
692 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
698 check
= g_new0(ImageCheck
, 1);
699 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
701 if (ret
== -ENOTSUP
) {
702 error_report("This image format does not support checks");
707 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
708 int corruptions_fixed
, leaks_fixed
;
710 leaks_fixed
= check
->leaks_fixed
;
711 corruptions_fixed
= check
->corruptions_fixed
;
713 if (output_format
== OFORMAT_HUMAN
) {
715 "The following inconsistencies were found and repaired:\n\n"
716 " %" PRId64
" leaked clusters\n"
717 " %" PRId64
" corruptions\n\n"
718 "Double checking the fixed image now...\n",
720 check
->corruptions_fixed
);
723 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
725 check
->leaks_fixed
= leaks_fixed
;
726 check
->corruptions_fixed
= corruptions_fixed
;
730 switch (output_format
) {
732 dump_human_image_check(check
, quiet
);
735 dump_json_image_check(check
, quiet
);
740 if (ret
|| check
->check_errors
) {
742 error_report("Check failed: %s", strerror(-ret
));
744 error_report("Check failed");
750 if (check
->corruptions
) {
752 } else if (check
->leaks
) {
759 qapi_free_ImageCheck(check
);
764 typedef struct CommonBlockJobCBInfo
{
765 BlockDriverState
*bs
;
767 } CommonBlockJobCBInfo
;
769 static void common_block_job_cb(void *opaque
, int ret
)
771 CommonBlockJobCBInfo
*cbi
= opaque
;
774 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
778 static void run_block_job(BlockJob
*job
, Error
**errp
)
780 AioContext
*aio_context
= bdrv_get_aio_context(job
->bs
);
783 aio_poll(aio_context
, true);
784 qemu_progress_print(job
->len
?
785 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
786 } while (!job
->ready
);
788 block_job_complete_sync(job
, errp
);
790 /* A block job may finish instantaneously without publishing any progress,
791 * so just signal completion here */
792 qemu_progress_print(100.f
, 0);
795 static int img_commit(int argc
, char **argv
)
798 const char *filename
, *fmt
, *cache
, *base
;
800 BlockDriverState
*bs
, *base_bs
;
801 bool progress
= false, quiet
= false, drop
= false;
803 Error
*local_err
= NULL
;
804 CommonBlockJobCBInfo cbi
;
805 bool image_opts
= false;
808 cache
= BDRV_DEFAULT_CACHE
;
811 static const struct option long_options
[] = {
812 {"help", no_argument
, 0, 'h'},
813 {"object", required_argument
, 0, OPTION_OBJECT
},
814 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
817 c
= getopt_long(argc
, argv
, "f:ht:b:dpq",
847 case OPTION_OBJECT
: {
849 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
855 case OPTION_IMAGE_OPTS
:
861 /* Progress is not shown in Quiet mode */
866 if (optind
!= argc
- 1) {
867 error_exit("Expecting one image file name");
869 filename
= argv
[optind
++];
871 if (qemu_opts_foreach(&qemu_object_opts
,
872 user_creatable_add_opts_foreach
,
874 error_report_err(local_err
);
878 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
879 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
881 error_report("Invalid cache option: %s", cache
);
885 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
891 qemu_progress_init(progress
, 1.f
);
892 qemu_progress_print(0.f
, 100);
895 base_bs
= bdrv_find_backing_image(bs
, base
);
897 error_setg(&local_err
, QERR_BASE_NOT_FOUND
, base
);
901 /* This is different from QMP, which by default uses the deepest file in
902 * the backing chain (i.e., the very base); however, the traditional
903 * behavior of qemu-img commit is using the immediate backing file. */
904 base_bs
= backing_bs(bs
);
906 error_setg(&local_err
, "Image does not have a backing file");
911 cbi
= (CommonBlockJobCBInfo
){
916 commit_active_start(bs
, base_bs
, 0, BLOCKDEV_ON_ERROR_REPORT
,
917 common_block_job_cb
, &cbi
, &local_err
);
922 /* When the block job completes, the BlockBackend reference will point to
923 * the old backing file. In order to avoid that the top image is already
924 * deleted, so we can still empty it afterwards, increment the reference
925 * counter here preemptively. */
930 run_block_job(bs
->job
, &local_err
);
935 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
936 ret
= bs
->drv
->bdrv_make_empty(bs
);
938 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
955 error_report_err(local_err
);
959 qprintf(quiet
, "Image committed.\n");
964 * Returns true iff the first sector pointed to by 'buf' contains at least
967 * 'pnum' is set to the number of sectors (including and immediately following
968 * the first one) that are known to be in the same allocated/unallocated state.
970 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
979 is_zero
= buffer_is_zero(buf
, 512);
980 for(i
= 1; i
< n
; i
++) {
982 if (is_zero
!= buffer_is_zero(buf
, 512)) {
991 * Like is_allocated_sectors, but if the buffer starts with a used sector,
992 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
993 * breaking up write requests for only small sparse areas.
995 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
999 int num_checked
, num_used
;
1005 ret
= is_allocated_sectors(buf
, n
, pnum
);
1011 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1013 num_checked
= num_used
;
1016 ret
= is_allocated_sectors(buf
, n
, pnum
);
1018 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1020 num_checked
+= *pnum
;
1022 num_used
= num_checked
;
1023 } else if (*pnum
>= min
) {
1033 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1034 * buffers matches, non-zero otherwise.
1036 * pnum is set to the number of sectors (including and immediately following
1037 * the first one) that are known to have the same comparison result
1039 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1050 res
= !!memcmp(buf1
, buf2
, 512);
1051 for(i
= 1; i
< n
; i
++) {
1055 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1064 #define IO_BUF_SIZE (2 * 1024 * 1024)
1066 static int64_t sectors_to_bytes(int64_t sectors
)
1068 return sectors
<< BDRV_SECTOR_BITS
;
1071 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1073 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1077 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1079 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1080 * data and negative value on error.
1082 * @param blk: BlockBackend for the image
1083 * @param sect_num: Number of first sector to check
1084 * @param sect_count: Number of sectors to check
1085 * @param filename: Name of disk file we are checking (logging purpose)
1086 * @param buffer: Allocated buffer for storing read data
1087 * @param quiet: Flag for quiet mode
1089 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1090 int sect_count
, const char *filename
,
1091 uint8_t *buffer
, bool quiet
)
1094 ret
= blk_read(blk
, sect_num
, buffer
, sect_count
);
1096 error_report("Error while reading offset %" PRId64
" of %s: %s",
1097 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1100 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1101 if (ret
|| pnum
!= sect_count
) {
1102 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1103 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1111 * Compares two images. Exit codes:
1113 * 0 - Images are identical
1115 * >1 - Error occurred
1117 static int img_compare(int argc
, char **argv
)
1119 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1120 BlockBackend
*blk1
, *blk2
;
1121 BlockDriverState
*bs1
, *bs2
;
1122 int64_t total_sectors1
, total_sectors2
;
1123 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1125 int allocated1
, allocated2
;
1126 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1127 bool progress
= false, quiet
= false, strict
= false;
1130 int64_t total_sectors
;
1131 int64_t sector_num
= 0;
1134 uint64_t progress_base
;
1135 Error
*local_err
= NULL
;
1136 bool image_opts
= false;
1138 cache
= BDRV_DEFAULT_CACHE
;
1140 static const struct option long_options
[] = {
1141 {"help", no_argument
, 0, 'h'},
1142 {"object", required_argument
, 0, OPTION_OBJECT
},
1143 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1146 c
= getopt_long(argc
, argv
, "hf:F:T:pqs",
1147 long_options
, NULL
);
1174 case OPTION_OBJECT
: {
1176 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1183 case OPTION_IMAGE_OPTS
:
1189 /* Progress is not shown in Quiet mode */
1195 if (optind
!= argc
- 2) {
1196 error_exit("Expecting two image file names");
1198 filename1
= argv
[optind
++];
1199 filename2
= argv
[optind
++];
1201 if (qemu_opts_foreach(&qemu_object_opts
,
1202 user_creatable_add_opts_foreach
,
1203 NULL
, &local_err
)) {
1204 error_report_err(local_err
);
1209 /* Initialize before goto out */
1210 qemu_progress_init(progress
, 2.0);
1213 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1215 error_report("Invalid source cache option: %s", cache
);
1220 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
);
1226 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
);
1234 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1235 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1236 total_sectors1
= blk_nb_sectors(blk1
);
1237 if (total_sectors1
< 0) {
1238 error_report("Can't get size of %s: %s",
1239 filename1
, strerror(-total_sectors1
));
1243 total_sectors2
= blk_nb_sectors(blk2
);
1244 if (total_sectors2
< 0) {
1245 error_report("Can't get size of %s: %s",
1246 filename2
, strerror(-total_sectors2
));
1250 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1251 progress_base
= MAX(total_sectors1
, total_sectors2
);
1253 qemu_progress_print(0, 100);
1255 if (strict
&& total_sectors1
!= total_sectors2
) {
1257 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1262 int64_t status1
, status2
;
1263 BlockDriverState
*file
;
1265 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1266 if (nb_sectors
<= 0) {
1269 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1270 total_sectors1
- sector_num
,
1274 error_report("Sector allocation test failed for %s", filename1
);
1277 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1279 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1280 total_sectors2
- sector_num
,
1284 error_report("Sector allocation test failed for %s", filename2
);
1287 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1289 nb_sectors
= MIN(nb_sectors
, pnum1
);
1292 nb_sectors
= MIN(nb_sectors
, pnum2
);
1296 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1297 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1299 qprintf(quiet
, "Strict mode: Offset %" PRId64
1300 " block status mismatch!\n",
1301 sectors_to_bytes(sector_num
));
1305 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1306 nb_sectors
= MIN(pnum1
, pnum2
);
1307 } else if (allocated1
== allocated2
) {
1309 ret
= blk_read(blk1
, sector_num
, buf1
, nb_sectors
);
1311 error_report("Error while reading offset %" PRId64
" of %s:"
1312 " %s", sectors_to_bytes(sector_num
), filename1
,
1317 ret
= blk_read(blk2
, sector_num
, buf2
, nb_sectors
);
1319 error_report("Error while reading offset %" PRId64
1320 " of %s: %s", sectors_to_bytes(sector_num
),
1321 filename2
, strerror(-ret
));
1325 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1326 if (ret
|| pnum
!= nb_sectors
) {
1327 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1329 ret
? sector_num
: sector_num
+ pnum
));
1337 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1338 filename1
, buf1
, quiet
);
1340 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1341 filename2
, buf1
, quiet
);
1345 error_report("Error while reading offset %" PRId64
": %s",
1346 sectors_to_bytes(sector_num
), strerror(-ret
));
1352 sector_num
+= nb_sectors
;
1353 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1356 if (total_sectors1
!= total_sectors2
) {
1357 BlockBackend
*blk_over
;
1358 int64_t total_sectors_over
;
1359 const char *filename_over
;
1361 qprintf(quiet
, "Warning: Image size mismatch!\n");
1362 if (total_sectors1
> total_sectors2
) {
1363 total_sectors_over
= total_sectors1
;
1365 filename_over
= filename1
;
1367 total_sectors_over
= total_sectors2
;
1369 filename_over
= filename2
;
1373 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1374 if (nb_sectors
<= 0) {
1377 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1381 error_report("Sector allocation test failed for %s",
1388 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1389 filename_over
, buf1
, quiet
);
1392 error_report("Error while reading offset %" PRId64
1393 " of %s: %s", sectors_to_bytes(sector_num
),
1394 filename_over
, strerror(-ret
));
1400 sector_num
+= nb_sectors
;
1401 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1405 qprintf(quiet
, "Images are identical.\n");
1415 qemu_progress_end();
1420 enum ImgConvertBlockStatus
{
1426 typedef struct ImgConvertState
{
1428 int64_t *src_sectors
;
1429 int src_cur
, src_num
;
1430 int64_t src_cur_offset
;
1431 int64_t total_sectors
;
1432 int64_t allocated_sectors
;
1433 enum ImgConvertBlockStatus status
;
1434 int64_t sector_next_status
;
1435 BlockBackend
*target
;
1438 bool target_has_backing
;
1440 size_t cluster_sectors
;
1444 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
)
1446 assert(sector_num
>= s
->src_cur_offset
);
1447 while (sector_num
- s
->src_cur_offset
>= s
->src_sectors
[s
->src_cur
]) {
1448 s
->src_cur_offset
+= s
->src_sectors
[s
->src_cur
];
1450 assert(s
->src_cur
< s
->src_num
);
1454 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1459 convert_select_part(s
, sector_num
);
1461 assert(s
->total_sectors
> sector_num
);
1462 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1464 if (s
->sector_next_status
<= sector_num
) {
1465 BlockDriverState
*file
;
1466 ret
= bdrv_get_block_status(blk_bs(s
->src
[s
->src_cur
]),
1467 sector_num
- s
->src_cur_offset
,
1473 if (ret
& BDRV_BLOCK_ZERO
) {
1474 s
->status
= BLK_ZERO
;
1475 } else if (ret
& BDRV_BLOCK_DATA
) {
1476 s
->status
= BLK_DATA
;
1477 } else if (!s
->target_has_backing
) {
1478 /* Without a target backing file we must copy over the contents of
1479 * the backing file as well. */
1480 /* TODO Check block status of the backing file chain to avoid
1481 * needlessly reading zeroes and limiting the iteration to the
1483 s
->status
= BLK_DATA
;
1485 s
->status
= BLK_BACKING_FILE
;
1488 s
->sector_next_status
= sector_num
+ n
;
1491 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1492 if (s
->status
== BLK_DATA
) {
1493 n
= MIN(n
, s
->buf_sectors
);
1496 /* We need to write complete clusters for compressed images, so if an
1497 * unallocated area is shorter than that, we must consider the whole
1498 * cluster allocated. */
1499 if (s
->compressed
) {
1500 if (n
< s
->cluster_sectors
) {
1501 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1502 s
->status
= BLK_DATA
;
1504 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1511 static int convert_read(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1517 if (s
->status
== BLK_ZERO
|| s
->status
== BLK_BACKING_FILE
) {
1521 assert(nb_sectors
<= s
->buf_sectors
);
1522 while (nb_sectors
> 0) {
1526 /* In the case of compression with multiple source files, we can get a
1527 * nb_sectors that spreads into the next part. So we must be able to
1528 * read across multiple BDSes for one convert_read() call. */
1529 convert_select_part(s
, sector_num
);
1530 blk
= s
->src
[s
->src_cur
];
1531 bs_sectors
= s
->src_sectors
[s
->src_cur
];
1533 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- s
->src_cur_offset
));
1534 ret
= blk_read(blk
, sector_num
- s
->src_cur_offset
, buf
, n
);
1541 buf
+= n
* BDRV_SECTOR_SIZE
;
1547 static int convert_write(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1552 while (nb_sectors
> 0) {
1555 switch (s
->status
) {
1556 case BLK_BACKING_FILE
:
1557 /* If we have a backing file, leave clusters unallocated that are
1558 * unallocated in the source image, so that the backing file is
1559 * visible at the respective offset. */
1560 assert(s
->target_has_backing
);
1564 /* We must always write compressed clusters as a whole, so don't
1565 * try to find zeroed parts in the buffer. We can only save the
1566 * write if the buffer is completely zeroed and we're allowed to
1567 * keep the target sparse. */
1568 if (s
->compressed
) {
1569 if (s
->has_zero_init
&& s
->min_sparse
&&
1570 buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
))
1572 assert(!s
->target_has_backing
);
1576 ret
= blk_write_compressed(s
->target
, sector_num
, buf
, n
);
1583 /* If there is real non-zero data or we're told to keep the target
1584 * fully allocated (-S 0), we must write it. Otherwise we can treat
1585 * it as zero sectors. */
1586 if (!s
->min_sparse
||
1587 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
))
1589 ret
= blk_write(s
->target
, sector_num
, buf
, n
);
1598 if (s
->has_zero_init
) {
1601 ret
= blk_write_zeroes(s
->target
, sector_num
, n
, 0);
1610 buf
+= n
* BDRV_SECTOR_SIZE
;
1616 static int convert_do_copy(ImgConvertState
*s
)
1618 uint8_t *buf
= NULL
;
1619 int64_t sector_num
, allocated_done
;
1623 /* Check whether we have zero initialisation or can get it efficiently */
1624 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1625 ? bdrv_has_zero_init(blk_bs(s
->target
))
1628 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1629 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1631 ret
= bdrv_make_zero(blk_bs(s
->target
), BDRV_REQ_MAY_UNMAP
);
1633 s
->has_zero_init
= true;
1637 /* Allocate buffer for copied data. For compressed images, only one cluster
1638 * can be copied at a time. */
1639 if (s
->compressed
) {
1640 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1641 error_report("invalid cluster size");
1645 s
->buf_sectors
= s
->cluster_sectors
;
1647 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1649 /* Calculate allocated sectors for progress */
1650 s
->allocated_sectors
= 0;
1652 while (sector_num
< s
->total_sectors
) {
1653 n
= convert_iteration_sectors(s
, sector_num
);
1658 if (s
->status
== BLK_DATA
) {
1659 s
->allocated_sectors
+= n
;
1666 s
->src_cur_offset
= 0;
1667 s
->sector_next_status
= 0;
1672 while (sector_num
< s
->total_sectors
) {
1673 n
= convert_iteration_sectors(s
, sector_num
);
1678 if (s
->status
== BLK_DATA
) {
1679 allocated_done
+= n
;
1680 qemu_progress_print(100.0 * allocated_done
/ s
->allocated_sectors
,
1684 ret
= convert_read(s
, sector_num
, n
, buf
);
1686 error_report("error while reading sector %" PRId64
1687 ": %s", sector_num
, strerror(-ret
));
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
,
1862 NULL
, &local_err
)) {
1863 error_report_err(local_err
);
1867 /* Initialize before goto out */
1871 qemu_progress_init(progress
, 1.0);
1873 bs_n
= argc
- optind
- 1;
1874 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1876 if (options
&& has_help_option(options
)) {
1877 ret
= print_block_option_help(out_filename
, out_fmt
);
1882 error_exit("Must specify image file name");
1886 if (bs_n
> 1 && out_baseimg
) {
1887 error_report("-B makes no sense when concatenating multiple input "
1894 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
1896 error_report("Invalid source cache option: %s", src_cache
);
1900 qemu_progress_print(0, 100);
1902 blk
= g_new0(BlockBackend
*, bs_n
);
1903 bs
= g_new0(BlockDriverState
*, bs_n
);
1904 bs_sectors
= g_new(int64_t, bs_n
);
1907 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1908 blk
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
1909 fmt
, src_flags
, src_writethrough
, quiet
);
1914 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1915 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
1916 if (bs_sectors
[bs_i
] < 0) {
1917 error_report("Could not get size of %s: %s",
1918 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1922 total_sectors
+= bs_sectors
[bs_i
];
1926 ret
= bdrv_snapshot_load_tmp(bs
[0],
1927 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1928 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1930 } else if (snapshot_name
!= NULL
) {
1932 error_report("No support for concatenating multiple snapshot");
1937 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1940 error_reportf_err(local_err
, "Failed to load snapshot: ");
1945 /* Find driver and parse its options */
1946 drv
= bdrv_find_format(out_fmt
);
1948 error_report("Unknown file format '%s'", out_fmt
);
1953 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
1955 error_report_err(local_err
);
1961 if (!drv
->create_opts
) {
1962 error_report("Format driver '%s' does not support image creation",
1968 if (!proto_drv
->create_opts
) {
1969 error_report("Protocol driver '%s' does not support image creation",
1970 proto_drv
->format_name
);
1975 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
1976 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
1978 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
1980 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
1982 error_report_err(local_err
);
1988 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
1990 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
1996 /* Get backing file name if -o backing_file was used */
1997 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
1998 if (out_baseimg_param
) {
1999 out_baseimg
= out_baseimg_param
;
2002 /* Check if compression is supported */
2005 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2006 const char *preallocation
=
2007 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2009 if (!drv
->bdrv_write_compressed
) {
2010 error_report("Compression not supported for this file format");
2016 error_report("Compression and encryption not supported at "
2023 && strcmp(preallocation
, "off"))
2025 error_report("Compression and preallocation not supported at "
2033 /* Create the new image */
2034 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2036 error_reportf_err(local_err
, "%s: error while converting %s: ",
2037 out_filename
, out_fmt
);
2042 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2043 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2045 error_report("Invalid cache option: %s", cache
);
2049 /* XXX we should allow --image-opts to trigger use of
2050 * img_open() here, but then we have trouble with
2051 * the bdrv_create() call which takes different params.
2052 * Not critical right now, so fix can wait...
2054 out_blk
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
);
2059 out_bs
= blk_bs(out_blk
);
2061 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
2062 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2064 bufsectors
= MIN(32768,
2065 MAX(bufsectors
, MAX(out_bs
->bl
.opt_transfer_length
,
2066 out_bs
->bl
.discard_alignment
))
2070 int64_t output_sectors
= blk_nb_sectors(out_blk
);
2071 if (output_sectors
< 0) {
2072 error_report("unable to get output image length: %s",
2073 strerror(-output_sectors
));
2076 } else if (output_sectors
< total_sectors
) {
2077 error_report("output file is smaller than input file");
2083 cluster_sectors
= 0;
2084 ret
= bdrv_get_info(out_bs
, &bdi
);
2087 error_report("could not get block driver info");
2091 compress
= compress
|| bdi
.needs_compressed_writes
;
2092 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2095 state
= (ImgConvertState
) {
2097 .src_sectors
= bs_sectors
,
2099 .total_sectors
= total_sectors
,
2101 .compressed
= compress
,
2102 .target_has_backing
= (bool) out_baseimg
,
2103 .min_sparse
= min_sparse
,
2104 .cluster_sectors
= cluster_sectors
,
2105 .buf_sectors
= bufsectors
,
2107 ret
= convert_do_copy(&state
);
2111 qemu_progress_print(100, 0);
2113 qemu_progress_end();
2114 qemu_opts_del(opts
);
2115 qemu_opts_free(create_opts
);
2116 qemu_opts_del(sn_opts
);
2120 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2121 blk_unref(blk
[bs_i
]);
2136 static void dump_snapshots(BlockDriverState
*bs
)
2138 QEMUSnapshotInfo
*sn_tab
, *sn
;
2141 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2144 printf("Snapshot list:\n");
2145 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2147 for(i
= 0; i
< nb_sns
; i
++) {
2149 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2155 static void dump_json_image_info_list(ImageInfoList
*list
)
2157 Error
*local_err
= NULL
;
2159 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2161 visit_type_ImageInfoList(qmp_output_get_visitor(ov
), NULL
, &list
,
2163 obj
= qmp_output_get_qobject(ov
);
2164 str
= qobject_to_json_pretty(obj
);
2165 assert(str
!= NULL
);
2166 printf("%s\n", qstring_get_str(str
));
2167 qobject_decref(obj
);
2168 qmp_output_visitor_cleanup(ov
);
2172 static void dump_json_image_info(ImageInfo
*info
)
2174 Error
*local_err
= NULL
;
2176 QmpOutputVisitor
*ov
= qmp_output_visitor_new();
2178 visit_type_ImageInfo(qmp_output_get_visitor(ov
), NULL
, &info
, &local_err
);
2179 obj
= qmp_output_get_qobject(ov
);
2180 str
= qobject_to_json_pretty(obj
);
2181 assert(str
!= NULL
);
2182 printf("%s\n", qstring_get_str(str
));
2183 qobject_decref(obj
);
2184 qmp_output_visitor_cleanup(ov
);
2188 static void dump_human_image_info_list(ImageInfoList
*list
)
2190 ImageInfoList
*elem
;
2193 for (elem
= list
; elem
; elem
= elem
->next
) {
2199 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2203 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2205 return strcmp(a
, b
) == 0;
2209 * Open an image file chain and return an ImageInfoList
2211 * @filename: topmost image filename
2212 * @fmt: topmost image format (may be NULL to autodetect)
2213 * @chain: true - enumerate entire backing file chain
2214 * false - only topmost image file
2216 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2217 * image file. If there was an error a message will have been printed to
2220 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2221 const char *filename
,
2225 ImageInfoList
*head
= NULL
;
2226 ImageInfoList
**last
= &head
;
2227 GHashTable
*filenames
;
2230 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2234 BlockDriverState
*bs
;
2236 ImageInfoList
*elem
;
2238 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2239 error_report("Backing file '%s' creates an infinite loop.",
2243 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2245 blk
= img_open(image_opts
, filename
, fmt
,
2246 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false);
2252 bdrv_query_image_info(bs
, &info
, &err
);
2254 error_report_err(err
);
2259 elem
= g_new0(ImageInfoList
, 1);
2266 filename
= fmt
= NULL
;
2268 if (info
->has_full_backing_filename
) {
2269 filename
= info
->full_backing_filename
;
2270 } else if (info
->has_backing_filename
) {
2271 error_report("Could not determine absolute backing filename,"
2272 " but backing filename '%s' present",
2273 info
->backing_filename
);
2276 if (info
->has_backing_filename_format
) {
2277 fmt
= info
->backing_filename_format
;
2281 g_hash_table_destroy(filenames
);
2285 qapi_free_ImageInfoList(head
);
2286 g_hash_table_destroy(filenames
);
2290 static int img_info(int argc
, char **argv
)
2293 OutputFormat output_format
= OFORMAT_HUMAN
;
2295 const char *filename
, *fmt
, *output
;
2296 ImageInfoList
*list
;
2297 Error
*local_err
= NULL
;
2298 bool image_opts
= false;
2303 int option_index
= 0;
2304 static const struct option long_options
[] = {
2305 {"help", no_argument
, 0, 'h'},
2306 {"format", required_argument
, 0, 'f'},
2307 {"output", required_argument
, 0, OPTION_OUTPUT
},
2308 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2309 {"object", required_argument
, 0, OPTION_OBJECT
},
2310 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2313 c
= getopt_long(argc
, argv
, "f:h",
2314 long_options
, &option_index
);
2329 case OPTION_BACKING_CHAIN
:
2332 case OPTION_OBJECT
: {
2334 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2340 case OPTION_IMAGE_OPTS
:
2345 if (optind
!= argc
- 1) {
2346 error_exit("Expecting one image file name");
2348 filename
= argv
[optind
++];
2350 if (output
&& !strcmp(output
, "json")) {
2351 output_format
= OFORMAT_JSON
;
2352 } else if (output
&& !strcmp(output
, "human")) {
2353 output_format
= OFORMAT_HUMAN
;
2354 } else if (output
) {
2355 error_report("--output must be used with human or json as argument.");
2359 if (qemu_opts_foreach(&qemu_object_opts
,
2360 user_creatable_add_opts_foreach
,
2361 NULL
, &local_err
)) {
2362 error_report_err(local_err
);
2366 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
);
2371 switch (output_format
) {
2373 dump_human_image_info_list(list
);
2377 dump_json_image_info_list(list
);
2379 dump_json_image_info(list
->value
);
2384 qapi_free_ImageInfoList(list
);
2388 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2391 switch (output_format
) {
2393 if (e
->data
&& !e
->has_offset
) {
2394 error_report("File contains external, encrypted or compressed clusters.");
2397 if (e
->data
&& !e
->zero
) {
2398 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2399 e
->start
, e
->length
,
2400 e
->has_offset
? e
->offset
: 0,
2401 e
->has_filename
? e
->filename
: "");
2403 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2404 * Modify the flags here to allow more coalescing.
2406 if (next
&& (!next
->data
|| next
->zero
)) {
2412 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2413 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2414 (e
->start
== 0 ? "[" : ",\n"),
2415 e
->start
, e
->length
, e
->depth
,
2416 e
->zero
? "true" : "false",
2417 e
->data
? "true" : "false");
2418 if (e
->has_offset
) {
2419 printf(", \"offset\": %"PRId64
"", e
->offset
);
2430 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2431 int nb_sectors
, MapEntry
*e
)
2435 BlockDriverState
*file
;
2438 /* As an optimization, we could cache the current range of unallocated
2439 * clusters in each file of the chain, and avoid querying the same
2445 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2451 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2454 bs
= backing_bs(bs
);
2463 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2466 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2467 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2468 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2469 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2470 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2471 .has_offset
= has_offset
,
2473 .has_filename
= file
&& has_offset
,
2474 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2480 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2482 if (curr
->length
== 0) {
2485 if (curr
->zero
!= next
->zero
||
2486 curr
->data
!= next
->data
||
2487 curr
->depth
!= next
->depth
||
2488 curr
->has_filename
!= next
->has_filename
||
2489 curr
->has_offset
!= next
->has_offset
) {
2492 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2495 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2501 static int img_map(int argc
, char **argv
)
2504 OutputFormat output_format
= OFORMAT_HUMAN
;
2506 BlockDriverState
*bs
;
2507 const char *filename
, *fmt
, *output
;
2509 MapEntry curr
= { .length
= 0 }, next
;
2511 Error
*local_err
= NULL
;
2512 bool image_opts
= false;
2517 int option_index
= 0;
2518 static const struct option long_options
[] = {
2519 {"help", no_argument
, 0, 'h'},
2520 {"format", required_argument
, 0, 'f'},
2521 {"output", required_argument
, 0, OPTION_OUTPUT
},
2522 {"object", required_argument
, 0, OPTION_OBJECT
},
2523 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2526 c
= getopt_long(argc
, argv
, "f:h",
2527 long_options
, &option_index
);
2542 case OPTION_OBJECT
: {
2544 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2550 case OPTION_IMAGE_OPTS
:
2555 if (optind
!= argc
- 1) {
2556 error_exit("Expecting one image file name");
2558 filename
= argv
[optind
];
2560 if (output
&& !strcmp(output
, "json")) {
2561 output_format
= OFORMAT_JSON
;
2562 } else if (output
&& !strcmp(output
, "human")) {
2563 output_format
= OFORMAT_HUMAN
;
2564 } else if (output
) {
2565 error_report("--output must be used with human or json as argument.");
2569 if (qemu_opts_foreach(&qemu_object_opts
,
2570 user_creatable_add_opts_foreach
,
2571 NULL
, &local_err
)) {
2572 error_report_err(local_err
);
2576 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false);
2582 if (output_format
== OFORMAT_HUMAN
) {
2583 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2586 length
= blk_getlength(blk
);
2587 while (curr
.start
+ curr
.length
< length
) {
2588 int64_t nsectors_left
;
2592 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2594 /* Probe up to 1 GiB at a time. */
2595 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2596 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2597 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2600 error_report("Could not read file metadata: %s", strerror(-ret
));
2604 if (entry_mergeable(&curr
, &next
)) {
2605 curr
.length
+= next
.length
;
2609 if (curr
.length
> 0) {
2610 dump_map_entry(output_format
, &curr
, &next
);
2615 dump_map_entry(output_format
, &curr
, NULL
);
2622 #define SNAPSHOT_LIST 1
2623 #define SNAPSHOT_CREATE 2
2624 #define SNAPSHOT_APPLY 3
2625 #define SNAPSHOT_DELETE 4
2627 static int img_snapshot(int argc
, char **argv
)
2630 BlockDriverState
*bs
;
2631 QEMUSnapshotInfo sn
;
2632 char *filename
, *snapshot_name
= NULL
;
2633 int c
, ret
= 0, bdrv_oflags
;
2638 bool image_opts
= false;
2640 bdrv_oflags
= BDRV_O_RDWR
;
2641 /* Parse commandline parameters */
2643 static const struct option long_options
[] = {
2644 {"help", no_argument
, 0, 'h'},
2645 {"object", required_argument
, 0, OPTION_OBJECT
},
2646 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2649 c
= getopt_long(argc
, argv
, "la:c:d:hq",
2650 long_options
, NULL
);
2661 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2664 action
= SNAPSHOT_LIST
;
2665 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2669 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2672 action
= SNAPSHOT_APPLY
;
2673 snapshot_name
= optarg
;
2677 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2680 action
= SNAPSHOT_CREATE
;
2681 snapshot_name
= optarg
;
2685 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2688 action
= SNAPSHOT_DELETE
;
2689 snapshot_name
= optarg
;
2694 case OPTION_OBJECT
: {
2696 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2702 case OPTION_IMAGE_OPTS
:
2708 if (optind
!= argc
- 1) {
2709 error_exit("Expecting one image file name");
2711 filename
= argv
[optind
++];
2713 if (qemu_opts_foreach(&qemu_object_opts
,
2714 user_creatable_add_opts_foreach
,
2716 error_report_err(err
);
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
,
2865 NULL
, &local_err
)) {
2866 error_report_err(local_err
);
2870 qemu_progress_init(progress
, 2.0);
2871 qemu_progress_print(0, 100);
2873 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2874 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2876 error_report("Invalid cache option: %s", cache
);
2881 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2883 error_report("Invalid source cache option: %s", src_cache
);
2887 /* The source files are opened read-only, don't care about WCE */
2888 assert((src_flags
& BDRV_O_RDWR
) == 0);
2889 (void) src_writethrough
;
2894 * Ignore the old backing file for unsafe rebase in case we want to correct
2895 * the reference to a renamed or moved backing file.
2897 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
2904 if (out_basefmt
!= NULL
) {
2905 if (bdrv_find_format(out_basefmt
) == NULL
) {
2906 error_report("Invalid format name: '%s'", out_basefmt
);
2912 /* For safe rebasing we need to compare old and new backing file */
2914 char backing_name
[PATH_MAX
];
2915 QDict
*options
= NULL
;
2917 if (bs
->backing_format
[0] != '\0') {
2918 options
= qdict_new();
2919 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
2922 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2923 blk_old_backing
= blk_new_open(backing_name
, NULL
,
2924 options
, src_flags
, &local_err
);
2925 if (!blk_old_backing
) {
2926 error_reportf_err(local_err
,
2927 "Could not open old backing file '%s': ",
2932 if (out_baseimg
[0]) {
2934 options
= qdict_new();
2935 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
2940 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
2941 options
, src_flags
, &local_err
);
2942 if (!blk_new_backing
) {
2943 error_reportf_err(local_err
,
2944 "Could not open new backing file '%s': ",
2952 * Check each unallocated cluster in the COW file. If it is unallocated,
2953 * accesses go to the backing file. We must therefore compare this cluster
2954 * in the old and new backing file, and if they differ we need to copy it
2955 * from the old backing file into the COW file.
2957 * If qemu-img crashes during this step, no harm is done. The content of
2958 * the image is the same as the original one at any time.
2961 int64_t num_sectors
;
2962 int64_t old_backing_num_sectors
;
2963 int64_t new_backing_num_sectors
= 0;
2966 float local_progress
= 0;
2968 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
2969 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
2971 num_sectors
= blk_nb_sectors(blk
);
2972 if (num_sectors
< 0) {
2973 error_report("Could not get size of '%s': %s",
2974 filename
, strerror(-num_sectors
));
2978 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
2979 if (old_backing_num_sectors
< 0) {
2980 char backing_name
[PATH_MAX
];
2982 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2983 error_report("Could not get size of '%s': %s",
2984 backing_name
, strerror(-old_backing_num_sectors
));
2988 if (blk_new_backing
) {
2989 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
2990 if (new_backing_num_sectors
< 0) {
2991 error_report("Could not get size of '%s': %s",
2992 out_baseimg
, strerror(-new_backing_num_sectors
));
2998 if (num_sectors
!= 0) {
2999 local_progress
= (float)100 /
3000 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3003 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3005 /* How many sectors can we handle with the next read? */
3006 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3007 n
= (IO_BUF_SIZE
/ 512);
3009 n
= num_sectors
- sector
;
3012 /* If the cluster is allocated, we don't need to take action */
3013 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3015 error_report("error while reading image metadata: %s",
3024 * Read old and new backing file and take into consideration that
3025 * backing files may be smaller than the COW image.
3027 if (sector
>= old_backing_num_sectors
) {
3028 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3030 if (sector
+ n
> old_backing_num_sectors
) {
3031 n
= old_backing_num_sectors
- sector
;
3034 ret
= blk_read(blk_old_backing
, sector
, buf_old
, n
);
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_read(blk_new_backing
, sector
, buf_new
, n
);
3050 error_report("error while reading from new backing file");
3055 /* If they differ, we need to write to the COW file */
3056 uint64_t written
= 0;
3058 while (written
< n
) {
3061 if (compare_sectors(buf_old
+ written
* 512,
3062 buf_new
+ written
* 512, n
- written
, &pnum
))
3064 ret
= blk_write(blk
, sector
+ written
,
3065 buf_old
+ written
* 512, pnum
);
3067 error_report("Error while writing to COW image: %s",
3075 qemu_progress_print(local_progress
, 100);
3080 * Change the backing file. All clusters that are different from the old
3081 * backing file are overwritten in the COW file now, so the visible content
3082 * doesn't change when we switch the backing file.
3084 if (out_baseimg
&& *out_baseimg
) {
3085 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3087 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3090 if (ret
== -ENOSPC
) {
3091 error_report("Could not change the backing file to '%s': No "
3092 "space left in the file header", out_baseimg
);
3093 } else if (ret
< 0) {
3094 error_report("Could not change the backing file to '%s': %s",
3095 out_baseimg
, strerror(-ret
));
3098 qemu_progress_print(100, 0);
3100 * TODO At this point it is possible to check if any clusters that are
3101 * allocated in the COW file are the same in the backing file. If so, they
3102 * could be dropped from the COW file. Don't do this before switching the
3103 * backing file, in case of a crash this would lead to corruption.
3106 qemu_progress_end();
3109 blk_unref(blk_old_backing
);
3110 blk_unref(blk_new_backing
);
3112 qemu_vfree(buf_old
);
3113 qemu_vfree(buf_new
);
3122 static int img_resize(int argc
, char **argv
)
3125 int c
, ret
, relative
;
3126 const char *filename
, *fmt
, *size
;
3127 int64_t n
, total_size
;
3129 BlockBackend
*blk
= NULL
;
3131 Error
*local_err
= NULL
;
3133 static QemuOptsList resize_options
= {
3134 .name
= "resize_options",
3135 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3138 .name
= BLOCK_OPT_SIZE
,
3139 .type
= QEMU_OPT_SIZE
,
3140 .help
= "Virtual disk size"
3146 bool image_opts
= false;
3148 /* Remove size from argv manually so that negative numbers are not treated
3149 * as options by getopt. */
3151 error_exit("Not enough arguments");
3155 size
= argv
[--argc
];
3157 /* Parse getopt arguments */
3160 static const struct option long_options
[] = {
3161 {"help", no_argument
, 0, 'h'},
3162 {"object", required_argument
, 0, OPTION_OBJECT
},
3163 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3166 c
= getopt_long(argc
, argv
, "f:hq",
3167 long_options
, NULL
);
3182 case OPTION_OBJECT
: {
3184 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3190 case OPTION_IMAGE_OPTS
:
3195 if (optind
!= argc
- 1) {
3196 error_exit("Expecting one image file name");
3198 filename
= argv
[optind
++];
3200 if (qemu_opts_foreach(&qemu_object_opts
,
3201 user_creatable_add_opts_foreach
,
3202 NULL
, &local_err
)) {
3203 error_report_err(local_err
);
3207 /* Choose grow, shrink, or absolute resize mode */
3223 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3224 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3226 error_report_err(err
);
3228 qemu_opts_del(param
);
3231 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3232 qemu_opts_del(param
);
3234 blk
= img_open(image_opts
, filename
, fmt
,
3235 BDRV_O_RDWR
, false, quiet
);
3242 total_size
= blk_getlength(blk
) + n
* relative
;
3246 if (total_size
<= 0) {
3247 error_report("New image size must be positive");
3252 ret
= blk_truncate(blk
, total_size
);
3255 qprintf(quiet
, "Image resized.\n");
3258 error_report("This image does not support resize");
3261 error_report("Image is read-only");
3264 error_report("Error resizing image (%d)", -ret
);
3275 static void amend_status_cb(BlockDriverState
*bs
,
3276 int64_t offset
, int64_t total_work_size
,
3279 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3282 static int img_amend(int argc
, char **argv
)
3286 char *options
= NULL
;
3287 QemuOptsList
*create_opts
= NULL
;
3288 QemuOpts
*opts
= NULL
;
3289 const char *fmt
= NULL
, *filename
, *cache
;
3292 bool quiet
= false, progress
= false;
3293 BlockBackend
*blk
= NULL
;
3294 BlockDriverState
*bs
= NULL
;
3295 Error
*local_err
= 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
,
3363 NULL
, &local_err
)) {
3364 error_report_err(local_err
);
3366 goto out_no_progress
;
3372 qemu_progress_init(progress
, 1.0);
3374 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3375 if (fmt
&& has_help_option(options
)) {
3376 /* If a format is explicitly specified (and possibly no filename is
3377 * given), print option help here */
3378 ret
= print_block_option_help(filename
, fmt
);
3382 if (optind
!= argc
- 1) {
3383 error_report("Expecting one image file name");
3388 flags
= BDRV_O_RDWR
;
3389 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3391 error_report("Invalid cache option: %s", cache
);
3395 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3402 fmt
= bs
->drv
->format_name
;
3404 if (has_help_option(options
)) {
3405 /* If the format was auto-detected, print option help here */
3406 ret
= print_block_option_help(filename
, fmt
);
3410 if (!bs
->drv
->create_opts
) {
3411 error_report("Format driver '%s' does not support any options to amend",
3417 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3418 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3420 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3422 error_report_err(err
);
3428 /* In case the driver does not call amend_status_cb() */
3429 qemu_progress_print(0.f
, 0);
3430 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3431 qemu_progress_print(100.f
, 0);
3433 error_report("Error while amending options: %s", strerror(-ret
));
3438 qemu_progress_end();
3442 qemu_opts_del(opts
);
3443 qemu_opts_free(create_opts
);
3452 static const img_cmd_t img_cmds
[] = {
3453 #define DEF(option, callback, arg_string) \
3454 { option, callback },
3455 #include "qemu-img-cmds.h"
3461 int main(int argc
, char **argv
)
3463 const img_cmd_t
*cmd
;
3464 const char *cmdname
;
3465 Error
*local_error
= NULL
;
3467 static const struct option long_options
[] = {
3468 {"help", no_argument
, 0, 'h'},
3469 {"version", no_argument
, 0, 'v'},
3474 signal(SIGPIPE
, SIG_IGN
);
3477 error_set_progname(argv
[0]);
3478 qemu_init_exec_dir(argv
[0]);
3480 if (qemu_init_main_loop(&local_error
)) {
3481 error_report_err(local_error
);
3485 module_call_init(MODULE_INIT_QOM
);
3488 error_exit("Not enough arguments");
3492 qemu_add_opts(&qemu_object_opts
);
3493 qemu_add_opts(&qemu_source_opts
);
3495 /* find the command */
3496 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
3497 if (!strcmp(cmdname
, cmd
->name
)) {
3498 return cmd
->handler(argc
- 1, argv
+ 1);
3502 c
= getopt_long(argc
, argv
, "h", long_options
, NULL
);
3508 printf(QEMU_IMG_VERSION
);
3513 error_exit("Command not found: %s", cmdname
);