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
25 #include "qemu/osdep.h"
28 #include "qemu-version.h"
29 #include "qapi/error.h"
30 #include "qapi/qapi-visit-block-core.h"
31 #include "qapi/qobject-output-visitor.h"
32 #include "qapi/qmp/qjson.h"
33 #include "qapi/qmp/qdict.h"
34 #include "qapi/qmp/qstring.h"
35 #include "qemu/cutils.h"
36 #include "qemu/config-file.h"
37 #include "qemu/option.h"
38 #include "qemu/error-report.h"
40 #include "qom/object_interfaces.h"
41 #include "sysemu/sysemu.h"
42 #include "sysemu/block-backend.h"
43 #include "block/block_int.h"
44 #include "block/blockjob.h"
45 #include "block/qapi.h"
46 #include "crypto/init.h"
47 #include "trace/control.h"
49 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
50 "\n" QEMU_COPYRIGHT "\n"
52 typedef struct img_cmd_t
{
54 int (*handler
)(int argc
, char **argv
);
59 OPTION_BACKING_CHAIN
= 257,
61 OPTION_IMAGE_OPTS
= 259,
63 OPTION_FLUSH_INTERVAL
= 261,
64 OPTION_NO_DRAIN
= 262,
65 OPTION_TARGET_IMAGE_OPTS
= 263,
67 OPTION_PREALLOCATION
= 265,
71 typedef enum OutputFormat
{
76 /* Default to cache=writeback as data integrity is not important for qemu-img */
77 #define BDRV_DEFAULT_CACHE "writeback"
79 static void format_print(void *opaque
, const char *name
)
84 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
88 error_printf("qemu-img: ");
91 error_vprintf(fmt
, ap
);
94 error_printf("\nTry 'qemu-img --help' for more information\n");
98 static void QEMU_NORETURN
missing_argument(const char *option
)
100 error_exit("missing argument for option '%s'", option
);
103 static void QEMU_NORETURN
unrecognized_option(const char *option
)
105 error_exit("unrecognized option '%s'", option
);
108 /* Please keep in synch with qemu-img.texi */
109 static void QEMU_NORETURN
help(void)
111 const char *help_msg
=
113 "usage: qemu-img [standard options] command [command options]\n"
114 "QEMU disk image utility\n"
116 " '-h', '--help' display this help and exit\n"
117 " '-V', '--version' output version information and exit\n"
118 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
119 " specify tracing options\n"
122 #define DEF(option, callback, arg_string) \
124 #include "qemu-img-cmds.h"
127 "Command parameters:\n"
128 " 'filename' is a disk image filename\n"
129 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
130 " manual page for a description of the object properties. The most common\n"
131 " object type is a 'secret', which is used to supply passwords and/or\n"
132 " encryption keys.\n"
133 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
134 " 'cache' is the cache mode used to write the output disk image, the valid\n"
135 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
136 " 'directsync' and 'unsafe' (default for convert)\n"
137 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
138 " options are the same as for the 'cache' option\n"
139 " 'size' is the disk image size in bytes. Optional suffixes\n"
140 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
141 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
142 " supported. 'b' is ignored.\n"
143 " 'output_filename' is the destination disk image filename\n"
144 " 'output_fmt' is the destination format\n"
145 " 'options' is a comma separated list of format specific options in a\n"
146 " name=value format. Use -o ? for an overview of the options supported by the\n"
148 " 'snapshot_param' is param used for internal snapshot, format\n"
149 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
151 " '-c' indicates that target image must be compressed (qcow format only)\n"
152 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
153 " new backing file match exactly. The image doesn't need a working\n"
154 " backing file before rebasing in this case (useful for renaming the\n"
155 " backing file). For image creation, allow creating without attempting\n"
156 " to open the backing file.\n"
157 " '-h' with or without a command shows this help and lists the supported formats\n"
158 " '-p' show progress of command (only certain commands)\n"
159 " '-q' use Quiet mode - do not print any output (except errors)\n"
160 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
161 " contain only zeros for qemu-img to create a sparse image during\n"
162 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
163 " unallocated or zero sectors, and the destination image will always be\n"
165 " '--output' takes the format in which the output must be done (human or json)\n"
166 " '-n' skips the target volume creation (useful if the volume is created\n"
167 " prior to running qemu-img)\n"
169 "Parameters to check subcommand:\n"
170 " '-r' tries to repair any inconsistencies that are found during the check.\n"
171 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
172 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
173 " hiding corruption that has already occurred.\n"
175 "Parameters to convert subcommand:\n"
176 " '-m' specifies how many coroutines work in parallel during the convert\n"
177 " process (defaults to 8)\n"
178 " '-W' allow to write to the target out of order rather than sequential\n"
180 "Parameters to snapshot subcommand:\n"
181 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
182 " '-a' applies a snapshot (revert disk to saved state)\n"
183 " '-c' creates a snapshot\n"
184 " '-d' deletes a snapshot\n"
185 " '-l' lists all snapshots in the given image\n"
187 "Parameters to compare subcommand:\n"
188 " '-f' first image format\n"
189 " '-F' second image format\n"
190 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
192 "Parameters to dd subcommand:\n"
193 " 'bs=BYTES' read and write up to BYTES bytes at a time "
195 " 'count=N' copy only N input blocks\n"
196 " 'if=FILE' read from FILE\n"
197 " 'of=FILE' write to FILE\n"
198 " 'skip=N' skip N bs-sized blocks at the start of input\n";
200 printf("%s\nSupported formats:", help_msg
);
201 bdrv_iterate_format(format_print
, NULL
);
202 printf("\n\n" QEMU_HELP_BOTTOM
"\n");
206 static QemuOptsList qemu_object_opts
= {
208 .implied_opt_name
= "qom-type",
209 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
215 static QemuOptsList qemu_source_opts
= {
217 .implied_opt_name
= "file",
218 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
224 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
230 ret
= vprintf(fmt
, args
);
237 static int print_block_option_help(const char *filename
, const char *fmt
)
239 BlockDriver
*drv
, *proto_drv
;
240 QemuOptsList
*create_opts
= NULL
;
241 Error
*local_err
= NULL
;
243 /* Find driver and parse its options */
244 drv
= bdrv_find_format(fmt
);
246 error_report("Unknown file format '%s'", fmt
);
250 if (!drv
->create_opts
) {
251 error_report("Format driver '%s' does not support image creation", fmt
);
255 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
257 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
259 error_report_err(local_err
);
260 qemu_opts_free(create_opts
);
263 if (!proto_drv
->create_opts
) {
264 error_report("Protocal driver '%s' does not support image creation",
265 proto_drv
->format_name
);
268 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
271 printf("Supported options:\n");
272 qemu_opts_print_help(create_opts
);
273 qemu_opts_free(create_opts
);
278 static BlockBackend
*img_open_opts(const char *optstr
,
279 QemuOpts
*opts
, int flags
, bool writethrough
,
280 bool quiet
, bool force_share
)
283 Error
*local_err
= NULL
;
285 options
= qemu_opts_to_qdict(opts
, NULL
);
287 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
288 && strcmp(qdict_get_str(options
, BDRV_OPT_FORCE_SHARE
), "on")) {
289 error_report("--force-share/-U conflicts with image options");
290 qobject_unref(options
);
293 qdict_put_str(options
, BDRV_OPT_FORCE_SHARE
, "on");
295 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
297 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
300 blk_set_enable_write_cache(blk
, !writethrough
);
305 static BlockBackend
*img_open_file(const char *filename
,
307 const char *fmt
, int flags
,
308 bool writethrough
, bool quiet
,
312 Error
*local_err
= NULL
;
315 options
= qdict_new();
318 qdict_put_str(options
, "driver", fmt
);
322 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
324 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
326 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
329 blk_set_enable_write_cache(blk
, !writethrough
);
335 static int img_add_key_secrets(void *opaque
,
336 const char *name
, const char *value
,
339 QDict
*options
= opaque
;
341 if (g_str_has_suffix(name
, "key-secret")) {
342 qdict_put_str(options
, name
, value
);
348 static BlockBackend
*img_open_new_file(const char *filename
,
349 QemuOpts
*create_opts
,
350 const char *fmt
, int flags
,
351 bool writethrough
, bool quiet
,
354 QDict
*options
= NULL
;
356 options
= qdict_new();
357 qemu_opt_foreach(create_opts
, img_add_key_secrets
, options
, &error_abort
);
359 return img_open_file(filename
, options
, fmt
, flags
, writethrough
, quiet
,
364 static BlockBackend
*img_open(bool image_opts
,
365 const char *filename
,
366 const char *fmt
, int flags
, bool writethrough
,
367 bool quiet
, bool force_share
)
373 error_report("--image-opts and --format are mutually exclusive");
376 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
381 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
384 blk
= img_open_file(filename
, NULL
, fmt
, flags
, writethrough
, quiet
,
391 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
392 const char *base_filename
,
393 const char *base_fmt
)
398 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
400 error_report("Backing file not supported for file format '%s'",
407 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
409 error_report("Backing file format not supported for file "
418 static int64_t cvtnum(const char *s
)
423 err
= qemu_strtosz(s
, NULL
, &value
);
427 if (value
> INT64_MAX
) {
433 static int img_create(int argc
, char **argv
)
436 uint64_t img_size
= -1;
437 const char *fmt
= "raw";
438 const char *base_fmt
= NULL
;
439 const char *filename
;
440 const char *base_filename
= NULL
;
441 char *options
= NULL
;
442 Error
*local_err
= NULL
;
447 static const struct option long_options
[] = {
448 {"help", no_argument
, 0, 'h'},
449 {"object", required_argument
, 0, OPTION_OBJECT
},
452 c
= getopt_long(argc
, argv
, ":F:b:f:ho:qu",
459 missing_argument(argv
[optind
- 1]);
462 unrecognized_option(argv
[optind
- 1]);
471 base_filename
= optarg
;
477 if (!is_valid_option_list(optarg
)) {
478 error_report("Invalid option list: %s", optarg
);
482 options
= g_strdup(optarg
);
484 char *old_options
= options
;
485 options
= g_strdup_printf("%s,%s", options
, optarg
);
493 flags
|= BDRV_O_NO_BACKING
;
495 case OPTION_OBJECT
: {
497 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
506 /* Get the filename */
507 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
508 if (options
&& has_help_option(options
)) {
510 return print_block_option_help(filename
, fmt
);
513 if (optind
>= argc
) {
514 error_exit("Expecting image file name");
518 if (qemu_opts_foreach(&qemu_object_opts
,
519 user_creatable_add_opts_foreach
,
524 /* Get image size, if specified */
528 sval
= cvtnum(argv
[optind
++]);
530 if (sval
== -ERANGE
) {
531 error_report("Image size must be less than 8 EiB!");
533 error_report("Invalid image size specified! You may use k, M, "
534 "G, T, P or E suffixes for ");
535 error_report("kilobytes, megabytes, gigabytes, terabytes, "
536 "petabytes and exabytes.");
540 img_size
= (uint64_t)sval
;
542 if (optind
!= argc
) {
543 error_exit("Unexpected argument: %s", argv
[optind
]);
546 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
547 options
, img_size
, flags
, quiet
, &local_err
);
549 error_reportf_err(local_err
, "%s: ", filename
);
561 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
565 Visitor
*v
= qobject_output_visitor_new(&obj
);
567 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
568 visit_complete(v
, &obj
);
569 str
= qobject_to_json_pretty(obj
);
571 qprintf(quiet
, "%s\n", qstring_get_str(str
));
577 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
579 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
580 qprintf(quiet
, "No errors were found on the image.\n");
582 if (check
->corruptions
) {
583 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
584 "Data may be corrupted, or further writes to the image "
591 "\n%" PRId64
" leaked clusters were found on the image.\n"
592 "This means waste of disk space, but no harm to data.\n",
596 if (check
->check_errors
) {
599 " internal errors have occurred during the check.\n",
600 check
->check_errors
);
604 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
605 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
606 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
607 check
->allocated_clusters
, check
->total_clusters
,
608 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
609 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
610 check
->compressed_clusters
* 100.0 /
611 check
->allocated_clusters
);
614 if (check
->image_end_offset
) {
616 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
620 static int collect_image_check(BlockDriverState
*bs
,
622 const char *filename
,
627 BdrvCheckResult result
;
629 ret
= bdrv_check(bs
, &result
, fix
);
634 check
->filename
= g_strdup(filename
);
635 check
->format
= g_strdup(bdrv_get_format_name(bs
));
636 check
->check_errors
= result
.check_errors
;
637 check
->corruptions
= result
.corruptions
;
638 check
->has_corruptions
= result
.corruptions
!= 0;
639 check
->leaks
= result
.leaks
;
640 check
->has_leaks
= result
.leaks
!= 0;
641 check
->corruptions_fixed
= result
.corruptions_fixed
;
642 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
643 check
->leaks_fixed
= result
.leaks_fixed
;
644 check
->has_leaks_fixed
= result
.leaks
!= 0;
645 check
->image_end_offset
= result
.image_end_offset
;
646 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
647 check
->total_clusters
= result
.bfi
.total_clusters
;
648 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
649 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
650 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
651 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
652 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
653 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
654 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
660 * Checks an image for consistency. Exit codes:
662 * 0 - Check completed, image is good
663 * 1 - Check not completed because of internal errors
664 * 2 - Check completed, image is corrupted
665 * 3 - Check completed, image has leaked clusters, but is good otherwise
666 * 63 - Checks are not supported by the image format
668 static int img_check(int argc
, char **argv
)
671 OutputFormat output_format
= OFORMAT_HUMAN
;
672 const char *filename
, *fmt
, *output
, *cache
;
674 BlockDriverState
*bs
;
676 int flags
= BDRV_O_CHECK
;
680 bool image_opts
= false;
681 bool force_share
= false;
685 cache
= BDRV_DEFAULT_CACHE
;
688 int option_index
= 0;
689 static const struct option long_options
[] = {
690 {"help", no_argument
, 0, 'h'},
691 {"format", required_argument
, 0, 'f'},
692 {"repair", required_argument
, 0, 'r'},
693 {"output", required_argument
, 0, OPTION_OUTPUT
},
694 {"object", required_argument
, 0, OPTION_OBJECT
},
695 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
696 {"force-share", no_argument
, 0, 'U'},
699 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
700 long_options
, &option_index
);
706 missing_argument(argv
[optind
- 1]);
709 unrecognized_option(argv
[optind
- 1]);
718 flags
|= BDRV_O_RDWR
;
720 if (!strcmp(optarg
, "leaks")) {
721 fix
= BDRV_FIX_LEAKS
;
722 } else if (!strcmp(optarg
, "all")) {
723 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
725 error_exit("Unknown option value for -r "
726 "(expecting 'leaks' or 'all'): %s", optarg
);
741 case OPTION_OBJECT
: {
743 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
749 case OPTION_IMAGE_OPTS
:
754 if (optind
!= argc
- 1) {
755 error_exit("Expecting one image file name");
757 filename
= argv
[optind
++];
759 if (output
&& !strcmp(output
, "json")) {
760 output_format
= OFORMAT_JSON
;
761 } else if (output
&& !strcmp(output
, "human")) {
762 output_format
= OFORMAT_HUMAN
;
764 error_report("--output must be used with human or json as argument.");
768 if (qemu_opts_foreach(&qemu_object_opts
,
769 user_creatable_add_opts_foreach
,
774 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
776 error_report("Invalid source cache option: %s", cache
);
780 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
787 check
= g_new0(ImageCheck
, 1);
788 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
790 if (ret
== -ENOTSUP
) {
791 error_report("This image format does not support checks");
796 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
797 int corruptions_fixed
, leaks_fixed
;
799 leaks_fixed
= check
->leaks_fixed
;
800 corruptions_fixed
= check
->corruptions_fixed
;
802 if (output_format
== OFORMAT_HUMAN
) {
804 "The following inconsistencies were found and repaired:\n\n"
805 " %" PRId64
" leaked clusters\n"
806 " %" PRId64
" corruptions\n\n"
807 "Double checking the fixed image now...\n",
809 check
->corruptions_fixed
);
812 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
814 check
->leaks_fixed
= leaks_fixed
;
815 check
->corruptions_fixed
= corruptions_fixed
;
819 switch (output_format
) {
821 dump_human_image_check(check
, quiet
);
824 dump_json_image_check(check
, quiet
);
829 if (ret
|| check
->check_errors
) {
831 error_report("Check failed: %s", strerror(-ret
));
833 error_report("Check failed");
839 if (check
->corruptions
) {
841 } else if (check
->leaks
) {
848 qapi_free_ImageCheck(check
);
853 typedef struct CommonBlockJobCBInfo
{
854 BlockDriverState
*bs
;
856 } CommonBlockJobCBInfo
;
858 static void common_block_job_cb(void *opaque
, int ret
)
860 CommonBlockJobCBInfo
*cbi
= opaque
;
863 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
867 static void run_block_job(BlockJob
*job
, Error
**errp
)
869 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
872 aio_context_acquire(aio_context
);
875 float progress
= 0.0f
;
876 aio_poll(aio_context
, true);
877 if (job
->job
.progress_total
) {
878 progress
= (float)job
->job
.progress_current
/
879 job
->job
.progress_total
* 100.f
;
881 qemu_progress_print(progress
, 0);
882 } while (!job_is_ready(&job
->job
) && !job_is_completed(&job
->job
));
884 if (!job_is_completed(&job
->job
)) {
885 ret
= job_complete_sync(&job
->job
, errp
);
889 job_unref(&job
->job
);
890 aio_context_release(aio_context
);
892 /* publish completion progress only when success */
894 qemu_progress_print(100.f
, 0);
898 static int img_commit(int argc
, char **argv
)
901 const char *filename
, *fmt
, *cache
, *base
;
903 BlockDriverState
*bs
, *base_bs
;
905 bool progress
= false, quiet
= false, drop
= false;
907 Error
*local_err
= NULL
;
908 CommonBlockJobCBInfo cbi
;
909 bool image_opts
= false;
910 AioContext
*aio_context
;
913 cache
= BDRV_DEFAULT_CACHE
;
916 static const struct option long_options
[] = {
917 {"help", no_argument
, 0, 'h'},
918 {"object", required_argument
, 0, OPTION_OBJECT
},
919 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
922 c
= getopt_long(argc
, argv
, ":f:ht:b:dpq",
929 missing_argument(argv
[optind
- 1]);
932 unrecognized_option(argv
[optind
- 1]);
957 case OPTION_OBJECT
: {
959 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
965 case OPTION_IMAGE_OPTS
:
971 /* Progress is not shown in Quiet mode */
976 if (optind
!= argc
- 1) {
977 error_exit("Expecting one image file name");
979 filename
= argv
[optind
++];
981 if (qemu_opts_foreach(&qemu_object_opts
,
982 user_creatable_add_opts_foreach
,
987 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
988 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
990 error_report("Invalid cache option: %s", cache
);
994 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
1001 qemu_progress_init(progress
, 1.f
);
1002 qemu_progress_print(0.f
, 100);
1005 base_bs
= bdrv_find_backing_image(bs
, base
);
1007 error_setg(&local_err
,
1008 "Did not find '%s' in the backing chain of '%s'",
1013 /* This is different from QMP, which by default uses the deepest file in
1014 * the backing chain (i.e., the very base); however, the traditional
1015 * behavior of qemu-img commit is using the immediate backing file. */
1016 base_bs
= backing_bs(bs
);
1018 error_setg(&local_err
, "Image does not have a backing file");
1023 cbi
= (CommonBlockJobCBInfo
){
1028 aio_context
= bdrv_get_aio_context(bs
);
1029 aio_context_acquire(aio_context
);
1030 commit_active_start("commit", bs
, base_bs
, JOB_DEFAULT
, 0,
1031 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1032 &cbi
, false, &local_err
);
1033 aio_context_release(aio_context
);
1038 /* When the block job completes, the BlockBackend reference will point to
1039 * the old backing file. In order to avoid that the top image is already
1040 * deleted, so we can still empty it afterwards, increment the reference
1041 * counter here preemptively. */
1046 job
= block_job_get("commit");
1047 run_block_job(job
, &local_err
);
1052 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
1053 ret
= bs
->drv
->bdrv_make_empty(bs
);
1055 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
1067 qemu_progress_end();
1072 error_report_err(local_err
);
1076 qprintf(quiet
, "Image committed.\n");
1081 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1082 * of the first sector boundary within buf where the sector contains a
1083 * non-zero byte. This function is robust to a buffer that is not
1086 static int64_t find_nonzero(const uint8_t *buf
, int64_t n
)
1089 int64_t end
= QEMU_ALIGN_DOWN(n
, BDRV_SECTOR_SIZE
);
1091 for (i
= 0; i
< end
; i
+= BDRV_SECTOR_SIZE
) {
1092 if (!buffer_is_zero(buf
+ i
, BDRV_SECTOR_SIZE
)) {
1096 if (i
< n
&& !buffer_is_zero(buf
+ i
, n
- end
)) {
1103 * Returns true iff the first sector pointed to by 'buf' contains at least
1106 * 'pnum' is set to the number of sectors (including and immediately following
1107 * the first one) that are known to be in the same allocated/unallocated state.
1108 * The function will try to align the end offset to alignment boundaries so
1109 * that the request will at least end aligned and consequtive requests will
1110 * also start at an aligned offset.
1112 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
,
1113 int64_t sector_num
, int alignment
)
1122 is_zero
= buffer_is_zero(buf
, 512);
1123 for(i
= 1; i
< n
; i
++) {
1125 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1130 tail
= (sector_num
+ i
) & (alignment
- 1);
1132 if (is_zero
&& i
<= tail
) {
1133 /* treat unallocated areas which only consist
1134 * of a small tail as allocated. */
1138 /* align up end offset of allocated areas. */
1139 i
+= alignment
- tail
;
1142 /* align down end offset of zero areas. */
1151 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1152 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1153 * breaking up write requests for only small sparse areas.
1155 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1156 int min
, int64_t sector_num
, int alignment
)
1159 int num_checked
, num_used
;
1165 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1171 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1173 sector_num
+= *pnum
;
1174 num_checked
= num_used
;
1177 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1179 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1181 sector_num
+= *pnum
;
1182 num_checked
+= *pnum
;
1184 num_used
= num_checked
;
1185 } else if (*pnum
>= min
) {
1195 * Compares two buffers sector by sector. Returns 0 if the first
1196 * sector of each buffer matches, non-zero otherwise.
1198 * pnum is set to the sector-aligned size of the buffer prefix that
1199 * has the same matching status as the first sector.
1201 static int compare_buffers(const uint8_t *buf1
, const uint8_t *buf2
,
1202 int64_t bytes
, int64_t *pnum
)
1205 int64_t i
= MIN(bytes
, BDRV_SECTOR_SIZE
);
1209 res
= !!memcmp(buf1
, buf2
, i
);
1211 int64_t len
= MIN(bytes
- i
, BDRV_SECTOR_SIZE
);
1213 if (!!memcmp(buf1
+ i
, buf2
+ i
, len
) != res
) {
1223 #define IO_BUF_SIZE (2 * 1024 * 1024)
1226 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1228 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1229 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1230 * failure), and 4 on error (the exit status for read errors), after emitting
1233 * @param blk: BlockBackend for the image
1234 * @param offset: Starting offset to check
1235 * @param bytes: Number of bytes to check
1236 * @param filename: Name of disk file we are checking (logging purpose)
1237 * @param buffer: Allocated buffer for storing read data
1238 * @param quiet: Flag for quiet mode
1240 static int check_empty_sectors(BlockBackend
*blk
, int64_t offset
,
1241 int64_t bytes
, const char *filename
,
1242 uint8_t *buffer
, bool quiet
)
1247 ret
= blk_pread(blk
, offset
, buffer
, bytes
);
1249 error_report("Error while reading offset %" PRId64
" of %s: %s",
1250 offset
, filename
, strerror(-ret
));
1253 idx
= find_nonzero(buffer
, bytes
);
1255 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1264 * Compares two images. Exit codes:
1266 * 0 - Images are identical
1268 * >1 - Error occurred
1270 static int img_compare(int argc
, char **argv
)
1272 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1273 BlockBackend
*blk1
, *blk2
;
1274 BlockDriverState
*bs1
, *bs2
;
1275 int64_t total_size1
, total_size2
;
1276 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1277 int64_t pnum1
, pnum2
;
1278 int allocated1
, allocated2
;
1279 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1280 bool progress
= false, quiet
= false, strict
= false;
1287 uint64_t progress_base
;
1288 bool image_opts
= false;
1289 bool force_share
= false;
1291 cache
= BDRV_DEFAULT_CACHE
;
1293 static const struct option long_options
[] = {
1294 {"help", no_argument
, 0, 'h'},
1295 {"object", required_argument
, 0, OPTION_OBJECT
},
1296 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1297 {"force-share", no_argument
, 0, 'U'},
1300 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1301 long_options
, NULL
);
1307 missing_argument(argv
[optind
- 1]);
1310 unrecognized_option(argv
[optind
- 1]);
1336 case OPTION_OBJECT
: {
1338 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1345 case OPTION_IMAGE_OPTS
:
1351 /* Progress is not shown in Quiet mode */
1357 if (optind
!= argc
- 2) {
1358 error_exit("Expecting two image file names");
1360 filename1
= argv
[optind
++];
1361 filename2
= argv
[optind
++];
1363 if (qemu_opts_foreach(&qemu_object_opts
,
1364 user_creatable_add_opts_foreach
,
1370 /* Initialize before goto out */
1371 qemu_progress_init(progress
, 2.0);
1374 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1376 error_report("Invalid source cache option: %s", cache
);
1381 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1388 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1397 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1398 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1399 total_size1
= blk_getlength(blk1
);
1400 if (total_size1
< 0) {
1401 error_report("Can't get size of %s: %s",
1402 filename1
, strerror(-total_size1
));
1406 total_size2
= blk_getlength(blk2
);
1407 if (total_size2
< 0) {
1408 error_report("Can't get size of %s: %s",
1409 filename2
, strerror(-total_size2
));
1413 total_size
= MIN(total_size1
, total_size2
);
1414 progress_base
= MAX(total_size1
, total_size2
);
1416 qemu_progress_print(0, 100);
1418 if (strict
&& total_size1
!= total_size2
) {
1420 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1424 while (offset
< total_size
) {
1425 int status1
, status2
;
1427 status1
= bdrv_block_status_above(bs1
, NULL
, offset
,
1428 total_size1
- offset
, &pnum1
, NULL
,
1432 error_report("Sector allocation test failed for %s", filename1
);
1435 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1437 status2
= bdrv_block_status_above(bs2
, NULL
, offset
,
1438 total_size2
- offset
, &pnum2
, NULL
,
1442 error_report("Sector allocation test failed for %s", filename2
);
1445 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1447 assert(pnum1
&& pnum2
);
1448 chunk
= MIN(pnum1
, pnum2
);
1451 if (status1
!= status2
) {
1453 qprintf(quiet
, "Strict mode: Offset %" PRId64
1454 " block status mismatch!\n", offset
);
1458 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1460 } else if (allocated1
== allocated2
) {
1464 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1465 ret
= blk_pread(blk1
, offset
, buf1
, chunk
);
1467 error_report("Error while reading offset %" PRId64
1469 offset
, filename1
, strerror(-ret
));
1473 ret
= blk_pread(blk2
, offset
, buf2
, chunk
);
1475 error_report("Error while reading offset %" PRId64
1477 offset
, filename2
, strerror(-ret
));
1481 ret
= compare_buffers(buf1
, buf2
, chunk
, &pnum
);
1482 if (ret
|| pnum
!= chunk
) {
1483 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1484 offset
+ (ret
? 0 : pnum
));
1490 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1492 ret
= check_empty_sectors(blk1
, offset
, chunk
,
1493 filename1
, buf1
, quiet
);
1495 ret
= check_empty_sectors(blk2
, offset
, chunk
,
1496 filename2
, buf1
, quiet
);
1503 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1506 if (total_size1
!= total_size2
) {
1507 BlockBackend
*blk_over
;
1508 const char *filename_over
;
1510 qprintf(quiet
, "Warning: Image size mismatch!\n");
1511 if (total_size1
> total_size2
) {
1513 filename_over
= filename1
;
1516 filename_over
= filename2
;
1519 while (offset
< progress_base
) {
1520 ret
= bdrv_block_status_above(blk_bs(blk_over
), NULL
, offset
,
1521 progress_base
- offset
, &chunk
,
1525 error_report("Sector allocation test failed for %s",
1530 if (ret
& BDRV_BLOCK_ALLOCATED
&& !(ret
& BDRV_BLOCK_ZERO
)) {
1531 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1532 ret
= check_empty_sectors(blk_over
, offset
, chunk
,
1533 filename_over
, buf1
, quiet
);
1539 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1543 qprintf(quiet
, "Images are identical.\n");
1553 qemu_progress_end();
1558 enum ImgConvertBlockStatus
{
1564 #define MAX_COROUTINES 16
1566 typedef struct ImgConvertState
{
1568 int64_t *src_sectors
;
1570 int64_t total_sectors
;
1571 int64_t allocated_sectors
;
1572 int64_t allocated_done
;
1575 enum ImgConvertBlockStatus status
;
1576 int64_t sector_next_status
;
1577 BlockBackend
*target
;
1580 bool unallocated_blocks_are_zero
;
1581 bool target_has_backing
;
1582 int64_t target_backing_sectors
; /* negative if unknown */
1587 size_t cluster_sectors
;
1589 long num_coroutines
;
1590 int running_coroutines
;
1591 Coroutine
*co
[MAX_COROUTINES
];
1592 int64_t wait_sector_num
[MAX_COROUTINES
];
1597 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1598 int *src_cur
, int64_t *src_cur_offset
)
1601 *src_cur_offset
= 0;
1602 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1603 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1605 assert(*src_cur
< s
->src_num
);
1609 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1611 int64_t src_cur_offset
;
1612 int ret
, n
, src_cur
;
1613 bool post_backing_zero
= false;
1615 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1617 assert(s
->total_sectors
> sector_num
);
1618 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1620 if (s
->target_backing_sectors
>= 0) {
1621 if (sector_num
>= s
->target_backing_sectors
) {
1622 post_backing_zero
= s
->unallocated_blocks_are_zero
;
1623 } else if (sector_num
+ n
> s
->target_backing_sectors
) {
1624 /* Split requests around target_backing_sectors (because
1625 * starting from there, zeros are handled differently) */
1626 n
= s
->target_backing_sectors
- sector_num
;
1630 if (s
->sector_next_status
<= sector_num
) {
1631 int64_t count
= n
* BDRV_SECTOR_SIZE
;
1633 if (s
->target_has_backing
) {
1635 ret
= bdrv_block_status(blk_bs(s
->src
[src_cur
]),
1636 (sector_num
- src_cur_offset
) *
1638 count
, &count
, NULL
, NULL
);
1640 ret
= bdrv_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1641 (sector_num
- src_cur_offset
) *
1643 count
, &count
, NULL
, NULL
);
1648 n
= DIV_ROUND_UP(count
, BDRV_SECTOR_SIZE
);
1650 if (ret
& BDRV_BLOCK_ZERO
) {
1651 s
->status
= post_backing_zero
? BLK_BACKING_FILE
: BLK_ZERO
;
1652 } else if (ret
& BDRV_BLOCK_DATA
) {
1653 s
->status
= BLK_DATA
;
1655 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1658 s
->sector_next_status
= sector_num
+ n
;
1661 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1662 if (s
->status
== BLK_DATA
) {
1663 n
= MIN(n
, s
->buf_sectors
);
1666 /* We need to write complete clusters for compressed images, so if an
1667 * unallocated area is shorter than that, we must consider the whole
1668 * cluster allocated. */
1669 if (s
->compressed
) {
1670 if (n
< s
->cluster_sectors
) {
1671 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1672 s
->status
= BLK_DATA
;
1674 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1681 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1682 int nb_sectors
, uint8_t *buf
)
1688 assert(nb_sectors
<= s
->buf_sectors
);
1689 while (nb_sectors
> 0) {
1692 int64_t bs_sectors
, src_cur_offset
;
1694 /* In the case of compression with multiple source files, we can get a
1695 * nb_sectors that spreads into the next part. So we must be able to
1696 * read across multiple BDSes for one convert_read() call. */
1697 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1698 blk
= s
->src
[src_cur
];
1699 bs_sectors
= s
->src_sectors
[src_cur
];
1701 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1703 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1704 qemu_iovec_init_external(&qiov
, &iov
, 1);
1706 ret
= blk_co_preadv(
1707 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1708 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1715 buf
+= n
* BDRV_SECTOR_SIZE
;
1722 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1723 int nb_sectors
, uint8_t *buf
,
1724 enum ImgConvertBlockStatus status
)
1730 while (nb_sectors
> 0) {
1732 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1735 case BLK_BACKING_FILE
:
1736 /* If we have a backing file, leave clusters unallocated that are
1737 * unallocated in the source image, so that the backing file is
1738 * visible at the respective offset. */
1739 assert(s
->target_has_backing
);
1743 /* If we're told to keep the target fully allocated (-S 0) or there
1744 * is real non-zero data, we must write it. Otherwise we can treat
1745 * it as zero sectors.
1746 * Compressed clusters need to be written as a whole, so in that
1747 * case we can only save the write if the buffer is completely
1749 if (!s
->min_sparse
||
1751 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
,
1752 sector_num
, s
->alignment
)) ||
1754 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1757 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1758 qemu_iovec_init_external(&qiov
, &iov
, 1);
1760 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1761 n
<< BDRV_SECTOR_BITS
, &qiov
, flags
);
1770 if (s
->has_zero_init
) {
1771 assert(!s
->target_has_backing
);
1774 ret
= blk_co_pwrite_zeroes(s
->target
,
1775 sector_num
<< BDRV_SECTOR_BITS
,
1776 n
<< BDRV_SECTOR_BITS
, 0);
1785 buf
+= n
* BDRV_SECTOR_SIZE
;
1791 static int coroutine_fn
convert_co_copy_range(ImgConvertState
*s
, int64_t sector_num
,
1796 while (nb_sectors
> 0) {
1799 int64_t bs_sectors
, src_cur_offset
;
1802 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1803 offset
= (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
;
1804 blk
= s
->src
[src_cur
];
1805 bs_sectors
= s
->src_sectors
[src_cur
];
1807 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1809 ret
= blk_co_copy_range(blk
, offset
, s
->target
,
1810 sector_num
<< BDRV_SECTOR_BITS
,
1811 n
<< BDRV_SECTOR_BITS
, 0, 0);
1822 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1824 ImgConvertState
*s
= opaque
;
1825 uint8_t *buf
= NULL
;
1829 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1830 if (s
->co
[i
] == qemu_coroutine_self()) {
1837 s
->running_coroutines
++;
1838 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1843 enum ImgConvertBlockStatus status
;
1846 qemu_co_mutex_lock(&s
->lock
);
1847 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1848 qemu_co_mutex_unlock(&s
->lock
);
1851 n
= convert_iteration_sectors(s
, s
->sector_num
);
1853 qemu_co_mutex_unlock(&s
->lock
);
1857 /* save current sector and allocation status to local variables */
1858 sector_num
= s
->sector_num
;
1860 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1861 n
= MIN(n
, s
->buf_sectors
);
1863 /* increment global sector counter so that other coroutines can
1864 * already continue reading beyond this request */
1866 qemu_co_mutex_unlock(&s
->lock
);
1868 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1869 s
->allocated_done
+= n
;
1870 qemu_progress_print(100.0 * s
->allocated_done
/
1871 s
->allocated_sectors
, 0);
1875 copy_range
= s
->copy_range
&& s
->status
== BLK_DATA
;
1876 if (status
== BLK_DATA
&& !copy_range
) {
1877 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1879 error_report("error while reading sector %" PRId64
1880 ": %s", sector_num
, strerror(-ret
));
1883 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1885 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1888 if (s
->wr_in_order
) {
1889 /* keep writes in order */
1890 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
1891 s
->wait_sector_num
[index
] = sector_num
;
1892 qemu_coroutine_yield();
1894 s
->wait_sector_num
[index
] = -1;
1897 if (s
->ret
== -EINPROGRESS
) {
1899 ret
= convert_co_copy_range(s
, sector_num
, n
);
1901 s
->copy_range
= false;
1905 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1908 error_report("error while writing sector %" PRId64
1909 ": %s", sector_num
, strerror(-ret
));
1914 if (s
->wr_in_order
) {
1915 /* reenter the coroutine that might have waited
1916 * for this write to complete */
1917 s
->wr_offs
= sector_num
+ n
;
1918 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1919 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1921 * A -> B -> A cannot occur because A has
1922 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1923 * B will never enter A during this time window.
1925 qemu_coroutine_enter(s
->co
[i
]);
1933 s
->co
[index
] = NULL
;
1934 s
->running_coroutines
--;
1935 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1936 /* the convert job finished successfully */
1941 static int convert_do_copy(ImgConvertState
*s
)
1944 int64_t sector_num
= 0;
1946 /* Check whether we have zero initialisation or can get it efficiently */
1947 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1948 ? bdrv_has_zero_init(blk_bs(s
->target
))
1951 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1952 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1954 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1956 s
->has_zero_init
= true;
1960 /* Allocate buffer for copied data. For compressed images, only one cluster
1961 * can be copied at a time. */
1962 if (s
->compressed
) {
1963 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1964 error_report("invalid cluster size");
1967 s
->buf_sectors
= s
->cluster_sectors
;
1970 while (sector_num
< s
->total_sectors
) {
1971 n
= convert_iteration_sectors(s
, sector_num
);
1975 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1977 s
->allocated_sectors
+= n
;
1983 s
->sector_next_status
= 0;
1984 s
->ret
= -EINPROGRESS
;
1986 qemu_co_mutex_init(&s
->lock
);
1987 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1988 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1989 s
->wait_sector_num
[i
] = -1;
1990 qemu_coroutine_enter(s
->co
[i
]);
1993 while (s
->running_coroutines
) {
1994 main_loop_wait(false);
1997 if (s
->compressed
&& !s
->ret
) {
1998 /* signal EOF to align */
1999 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
2008 #define MAX_BUF_SECTORS 32768
2010 static int img_convert(int argc
, char **argv
)
2012 int c
, bs_i
, flags
, src_flags
= 0;
2013 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
2014 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
2015 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
2016 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
2017 BlockDriverInfo bdi
;
2018 BlockDriverState
*out_bs
;
2019 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
2020 QemuOptsList
*create_opts
= NULL
;
2021 char *options
= NULL
;
2022 Error
*local_err
= NULL
;
2023 bool writethrough
, src_writethrough
, quiet
= false, image_opts
= false,
2024 skip_create
= false, progress
= false, tgt_image_opts
= false;
2025 int64_t ret
= -EINVAL
;
2026 bool force_share
= false;
2028 ImgConvertState s
= (ImgConvertState
) {
2029 /* Need at least 4k of zeros for sparse detection */
2032 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
2033 .wr_in_order
= true,
2034 .num_coroutines
= 8,
2038 static const struct option long_options
[] = {
2039 {"help", no_argument
, 0, 'h'},
2040 {"object", required_argument
, 0, OPTION_OBJECT
},
2041 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2042 {"force-share", no_argument
, 0, 'U'},
2043 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
2046 c
= getopt_long(argc
, argv
, ":hf:O:B:co:l:S:pt:T:qnm:WU",
2047 long_options
, NULL
);
2053 missing_argument(argv
[optind
- 1]);
2056 unrecognized_option(argv
[optind
- 1]);
2068 out_baseimg
= optarg
;
2071 s
.compressed
= true;
2072 s
.copy_range
= false;
2075 if (!is_valid_option_list(optarg
)) {
2076 error_report("Invalid option list: %s", optarg
);
2080 options
= g_strdup(optarg
);
2082 char *old_options
= options
;
2083 options
= g_strdup_printf("%s,%s", options
, optarg
);
2084 g_free(old_options
);
2088 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2089 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2092 error_report("Failed in parsing snapshot param '%s'",
2097 snapshot_name
= optarg
;
2104 sval
= cvtnum(optarg
);
2105 if (sval
< 0 || sval
& (BDRV_SECTOR_SIZE
- 1) ||
2106 sval
/ BDRV_SECTOR_SIZE
> MAX_BUF_SECTORS
) {
2107 error_report("Invalid buffer size for sparse output specified. "
2108 "Valid sizes are multiples of %llu up to %llu. Select "
2109 "0 to disable sparse detection (fully allocates output).",
2110 BDRV_SECTOR_SIZE
, MAX_BUF_SECTORS
* BDRV_SECTOR_SIZE
);
2114 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2115 s
.copy_range
= false;
2134 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2135 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2136 error_report("Invalid number of coroutines. Allowed number of"
2137 " coroutines is between 1 and %d", MAX_COROUTINES
);
2142 s
.wr_in_order
= false;
2147 case OPTION_OBJECT
: {
2148 QemuOpts
*object_opts
;
2149 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2156 case OPTION_IMAGE_OPTS
:
2159 case OPTION_TARGET_IMAGE_OPTS
:
2160 tgt_image_opts
= true;
2165 if (!out_fmt
&& !tgt_image_opts
) {
2169 if (qemu_opts_foreach(&qemu_object_opts
,
2170 user_creatable_add_opts_foreach
,
2175 if (tgt_image_opts
&& !skip_create
) {
2176 error_report("--target-image-opts requires use of -n flag");
2180 s
.src_num
= argc
- optind
- 1;
2181 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2183 if (options
&& has_help_option(options
)) {
2185 ret
= print_block_option_help(out_filename
, out_fmt
);
2188 error_report("Option help requires a format be specified");
2193 if (s
.src_num
< 1) {
2194 error_report("Must specify image file name");
2199 /* ret is still -EINVAL until here */
2200 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2202 error_report("Invalid source cache option: %s", src_cache
);
2206 /* Initialize before goto out */
2210 qemu_progress_init(progress
, 1.0);
2211 qemu_progress_print(0, 100);
2213 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2214 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2216 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2217 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2218 fmt
, src_flags
, src_writethrough
, quiet
,
2224 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2225 if (s
.src_sectors
[bs_i
] < 0) {
2226 error_report("Could not get size of %s: %s",
2227 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2231 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2235 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2236 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2237 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2239 } else if (snapshot_name
!= NULL
) {
2240 if (s
.src_num
> 1) {
2241 error_report("No support for concatenating multiple snapshot");
2246 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2250 error_reportf_err(local_err
, "Failed to load snapshot: ");
2256 /* Find driver and parse its options */
2257 drv
= bdrv_find_format(out_fmt
);
2259 error_report("Unknown file format '%s'", out_fmt
);
2264 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2266 error_report_err(local_err
);
2271 if (!drv
->create_opts
) {
2272 error_report("Format driver '%s' does not support image creation",
2278 if (!proto_drv
->create_opts
) {
2279 error_report("Protocol driver '%s' does not support image creation",
2280 proto_drv
->format_name
);
2285 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2286 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2288 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2290 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2292 error_report_err(local_err
);
2298 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, s
.total_sectors
* 512,
2300 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2306 /* Get backing file name if -o backing_file was used */
2307 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2308 if (out_baseimg_param
) {
2309 out_baseimg
= out_baseimg_param
;
2311 s
.target_has_backing
= (bool) out_baseimg
;
2313 if (s
.src_num
> 1 && out_baseimg
) {
2314 error_report("Having a backing file for the target makes no sense when "
2315 "concatenating multiple input images");
2320 /* Check if compression is supported */
2323 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2324 const char *encryptfmt
=
2325 qemu_opt_get(opts
, BLOCK_OPT_ENCRYPT_FORMAT
);
2326 const char *preallocation
=
2327 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2329 if (drv
&& !drv
->bdrv_co_pwritev_compressed
) {
2330 error_report("Compression not supported for this file format");
2335 if (encryption
|| encryptfmt
) {
2336 error_report("Compression and encryption not supported at "
2343 && strcmp(preallocation
, "off"))
2345 error_report("Compression and preallocation not supported at "
2353 /* Create the new image */
2354 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2356 error_reportf_err(local_err
, "%s: error while converting %s: ",
2357 out_filename
, out_fmt
);
2362 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2363 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2365 error_report("Invalid cache option: %s", cache
);
2370 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2371 flags
, writethrough
, quiet
, false);
2373 /* TODO ultimately we should allow --target-image-opts
2374 * to be used even when -n is not given.
2375 * That has to wait for bdrv_create to be improved
2376 * to allow filenames in option syntax
2378 s
.target
= img_open_new_file(out_filename
, opts
, out_fmt
,
2379 flags
, writethrough
, quiet
, false);
2385 out_bs
= blk_bs(s
.target
);
2387 if (s
.compressed
&& !out_bs
->drv
->bdrv_co_pwritev_compressed
) {
2388 error_report("Compression not supported for this file format");
2393 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2394 * or discard_alignment of the out_bs is greater. Limit to
2395 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2396 s
.buf_sectors
= MIN(MAX_BUF_SECTORS
,
2398 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2399 out_bs
->bl
.pdiscard_alignment
>>
2400 BDRV_SECTOR_BITS
)));
2402 /* try to align the write requests to the destination to avoid unnecessary
2404 s
.alignment
= MAX(pow2floor(s
.min_sparse
),
2405 DIV_ROUND_UP(out_bs
->bl
.request_alignment
,
2407 assert(is_power_of_2(s
.alignment
));
2410 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2411 if (output_sectors
< 0) {
2412 error_report("unable to get output image length: %s",
2413 strerror(-output_sectors
));
2416 } else if (output_sectors
< s
.total_sectors
) {
2417 error_report("output file is smaller than input file");
2423 if (s
.target_has_backing
) {
2424 /* Errors are treated as "backing length unknown" (which means
2425 * s.target_backing_sectors has to be negative, which it will
2426 * be automatically). The backing file length is used only
2427 * for optimizations, so such a case is not fatal. */
2428 s
.target_backing_sectors
= bdrv_nb_sectors(out_bs
->backing
->bs
);
2430 s
.target_backing_sectors
= -1;
2433 ret
= bdrv_get_info(out_bs
, &bdi
);
2436 error_report("could not get block driver info");
2440 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2441 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2442 s
.unallocated_blocks_are_zero
= bdi
.unallocated_blocks_are_zero
;
2445 ret
= convert_do_copy(&s
);
2448 qemu_progress_print(100, 0);
2450 qemu_progress_end();
2451 qemu_opts_del(opts
);
2452 qemu_opts_free(create_opts
);
2453 qemu_opts_del(sn_opts
);
2454 blk_unref(s
.target
);
2456 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2457 blk_unref(s
.src
[bs_i
]);
2461 g_free(s
.src_sectors
);
2469 static void dump_snapshots(BlockDriverState
*bs
)
2471 QEMUSnapshotInfo
*sn_tab
, *sn
;
2474 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2477 printf("Snapshot list:\n");
2478 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2480 for(i
= 0; i
< nb_sns
; i
++) {
2482 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2488 static void dump_json_image_info_list(ImageInfoList
*list
)
2492 Visitor
*v
= qobject_output_visitor_new(&obj
);
2494 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2495 visit_complete(v
, &obj
);
2496 str
= qobject_to_json_pretty(obj
);
2497 assert(str
!= NULL
);
2498 printf("%s\n", qstring_get_str(str
));
2504 static void dump_json_image_info(ImageInfo
*info
)
2508 Visitor
*v
= qobject_output_visitor_new(&obj
);
2510 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2511 visit_complete(v
, &obj
);
2512 str
= qobject_to_json_pretty(obj
);
2513 assert(str
!= NULL
);
2514 printf("%s\n", qstring_get_str(str
));
2520 static void dump_human_image_info_list(ImageInfoList
*list
)
2522 ImageInfoList
*elem
;
2525 for (elem
= list
; elem
; elem
= elem
->next
) {
2531 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2535 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2537 return strcmp(a
, b
) == 0;
2541 * Open an image file chain and return an ImageInfoList
2543 * @filename: topmost image filename
2544 * @fmt: topmost image format (may be NULL to autodetect)
2545 * @chain: true - enumerate entire backing file chain
2546 * false - only topmost image file
2548 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2549 * image file. If there was an error a message will have been printed to
2552 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2553 const char *filename
,
2555 bool chain
, bool force_share
)
2557 ImageInfoList
*head
= NULL
;
2558 ImageInfoList
**last
= &head
;
2559 GHashTable
*filenames
;
2562 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2566 BlockDriverState
*bs
;
2568 ImageInfoList
*elem
;
2570 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2571 error_report("Backing file '%s' creates an infinite loop.",
2575 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2577 blk
= img_open(image_opts
, filename
, fmt
,
2578 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2585 bdrv_query_image_info(bs
, &info
, &err
);
2587 error_report_err(err
);
2592 elem
= g_new0(ImageInfoList
, 1);
2599 filename
= fmt
= NULL
;
2601 if (info
->has_full_backing_filename
) {
2602 filename
= info
->full_backing_filename
;
2603 } else if (info
->has_backing_filename
) {
2604 error_report("Could not determine absolute backing filename,"
2605 " but backing filename '%s' present",
2606 info
->backing_filename
);
2609 if (info
->has_backing_filename_format
) {
2610 fmt
= info
->backing_filename_format
;
2614 g_hash_table_destroy(filenames
);
2618 qapi_free_ImageInfoList(head
);
2619 g_hash_table_destroy(filenames
);
2623 static int img_info(int argc
, char **argv
)
2626 OutputFormat output_format
= OFORMAT_HUMAN
;
2628 const char *filename
, *fmt
, *output
;
2629 ImageInfoList
*list
;
2630 bool image_opts
= false;
2631 bool force_share
= false;
2636 int option_index
= 0;
2637 static const struct option long_options
[] = {
2638 {"help", no_argument
, 0, 'h'},
2639 {"format", required_argument
, 0, 'f'},
2640 {"output", required_argument
, 0, OPTION_OUTPUT
},
2641 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2642 {"object", required_argument
, 0, OPTION_OBJECT
},
2643 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2644 {"force-share", no_argument
, 0, 'U'},
2647 c
= getopt_long(argc
, argv
, ":f:hU",
2648 long_options
, &option_index
);
2654 missing_argument(argv
[optind
- 1]);
2657 unrecognized_option(argv
[optind
- 1]);
2671 case OPTION_BACKING_CHAIN
:
2674 case OPTION_OBJECT
: {
2676 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2682 case OPTION_IMAGE_OPTS
:
2687 if (optind
!= argc
- 1) {
2688 error_exit("Expecting one image file name");
2690 filename
= argv
[optind
++];
2692 if (output
&& !strcmp(output
, "json")) {
2693 output_format
= OFORMAT_JSON
;
2694 } else if (output
&& !strcmp(output
, "human")) {
2695 output_format
= OFORMAT_HUMAN
;
2696 } else if (output
) {
2697 error_report("--output must be used with human or json as argument.");
2701 if (qemu_opts_foreach(&qemu_object_opts
,
2702 user_creatable_add_opts_foreach
,
2707 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
2713 switch (output_format
) {
2715 dump_human_image_info_list(list
);
2719 dump_json_image_info_list(list
);
2721 dump_json_image_info(list
->value
);
2726 qapi_free_ImageInfoList(list
);
2730 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2733 switch (output_format
) {
2735 if (e
->data
&& !e
->has_offset
) {
2736 error_report("File contains external, encrypted or compressed clusters.");
2739 if (e
->data
&& !e
->zero
) {
2740 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2741 e
->start
, e
->length
,
2742 e
->has_offset
? e
->offset
: 0,
2743 e
->has_filename
? e
->filename
: "");
2745 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2746 * Modify the flags here to allow more coalescing.
2748 if (next
&& (!next
->data
|| next
->zero
)) {
2754 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2755 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2756 (e
->start
== 0 ? "[" : ",\n"),
2757 e
->start
, e
->length
, e
->depth
,
2758 e
->zero
? "true" : "false",
2759 e
->data
? "true" : "false");
2760 if (e
->has_offset
) {
2761 printf(", \"offset\": %"PRId64
"", e
->offset
);
2772 static int get_block_status(BlockDriverState
*bs
, int64_t offset
,
2773 int64_t bytes
, MapEntry
*e
)
2777 BlockDriverState
*file
;
2781 /* As an optimization, we could cache the current range of unallocated
2782 * clusters in each file of the chain, and avoid querying the same
2788 ret
= bdrv_block_status(bs
, offset
, bytes
, &bytes
, &map
, &file
);
2793 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2796 bs
= backing_bs(bs
);
2805 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2810 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2811 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2813 .has_offset
= has_offset
,
2815 .has_filename
= file
&& has_offset
,
2816 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2822 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2824 if (curr
->length
== 0) {
2827 if (curr
->zero
!= next
->zero
||
2828 curr
->data
!= next
->data
||
2829 curr
->depth
!= next
->depth
||
2830 curr
->has_filename
!= next
->has_filename
||
2831 curr
->has_offset
!= next
->has_offset
) {
2834 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2837 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2843 static int img_map(int argc
, char **argv
)
2846 OutputFormat output_format
= OFORMAT_HUMAN
;
2848 BlockDriverState
*bs
;
2849 const char *filename
, *fmt
, *output
;
2851 MapEntry curr
= { .length
= 0 }, next
;
2853 bool image_opts
= false;
2854 bool force_share
= false;
2859 int option_index
= 0;
2860 static const struct option long_options
[] = {
2861 {"help", no_argument
, 0, 'h'},
2862 {"format", required_argument
, 0, 'f'},
2863 {"output", required_argument
, 0, OPTION_OUTPUT
},
2864 {"object", required_argument
, 0, OPTION_OBJECT
},
2865 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2866 {"force-share", no_argument
, 0, 'U'},
2869 c
= getopt_long(argc
, argv
, ":f:hU",
2870 long_options
, &option_index
);
2876 missing_argument(argv
[optind
- 1]);
2879 unrecognized_option(argv
[optind
- 1]);
2893 case OPTION_OBJECT
: {
2895 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2901 case OPTION_IMAGE_OPTS
:
2906 if (optind
!= argc
- 1) {
2907 error_exit("Expecting one image file name");
2909 filename
= argv
[optind
];
2911 if (output
&& !strcmp(output
, "json")) {
2912 output_format
= OFORMAT_JSON
;
2913 } else if (output
&& !strcmp(output
, "human")) {
2914 output_format
= OFORMAT_HUMAN
;
2915 } else if (output
) {
2916 error_report("--output must be used with human or json as argument.");
2920 if (qemu_opts_foreach(&qemu_object_opts
,
2921 user_creatable_add_opts_foreach
,
2926 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
2932 if (output_format
== OFORMAT_HUMAN
) {
2933 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2936 length
= blk_getlength(blk
);
2937 while (curr
.start
+ curr
.length
< length
) {
2938 int64_t offset
= curr
.start
+ curr
.length
;
2941 /* Probe up to 1 GiB at a time. */
2942 n
= MIN(1 << 30, length
- offset
);
2943 ret
= get_block_status(bs
, offset
, n
, &next
);
2946 error_report("Could not read file metadata: %s", strerror(-ret
));
2950 if (entry_mergeable(&curr
, &next
)) {
2951 curr
.length
+= next
.length
;
2955 if (curr
.length
> 0) {
2956 dump_map_entry(output_format
, &curr
, &next
);
2961 dump_map_entry(output_format
, &curr
, NULL
);
2968 #define SNAPSHOT_LIST 1
2969 #define SNAPSHOT_CREATE 2
2970 #define SNAPSHOT_APPLY 3
2971 #define SNAPSHOT_DELETE 4
2973 static int img_snapshot(int argc
, char **argv
)
2976 BlockDriverState
*bs
;
2977 QEMUSnapshotInfo sn
;
2978 char *filename
, *snapshot_name
= NULL
;
2979 int c
, ret
= 0, bdrv_oflags
;
2984 bool image_opts
= false;
2985 bool force_share
= false;
2987 bdrv_oflags
= BDRV_O_RDWR
;
2988 /* Parse commandline parameters */
2990 static const struct option long_options
[] = {
2991 {"help", no_argument
, 0, 'h'},
2992 {"object", required_argument
, 0, OPTION_OBJECT
},
2993 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2994 {"force-share", no_argument
, 0, 'U'},
2997 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
2998 long_options
, NULL
);
3004 missing_argument(argv
[optind
- 1]);
3007 unrecognized_option(argv
[optind
- 1]);
3014 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3017 action
= SNAPSHOT_LIST
;
3018 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
3022 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3025 action
= SNAPSHOT_APPLY
;
3026 snapshot_name
= optarg
;
3030 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3033 action
= SNAPSHOT_CREATE
;
3034 snapshot_name
= optarg
;
3038 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3041 action
= SNAPSHOT_DELETE
;
3042 snapshot_name
= optarg
;
3050 case OPTION_OBJECT
: {
3052 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3058 case OPTION_IMAGE_OPTS
:
3064 if (optind
!= argc
- 1) {
3065 error_exit("Expecting one image file name");
3067 filename
= argv
[optind
++];
3069 if (qemu_opts_foreach(&qemu_object_opts
,
3070 user_creatable_add_opts_foreach
,
3075 /* Open the image */
3076 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
3083 /* Perform the requested action */
3089 case SNAPSHOT_CREATE
:
3090 memset(&sn
, 0, sizeof(sn
));
3091 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3093 qemu_gettimeofday(&tv
);
3094 sn
.date_sec
= tv
.tv_sec
;
3095 sn
.date_nsec
= tv
.tv_usec
* 1000;
3097 ret
= bdrv_snapshot_create(bs
, &sn
);
3099 error_report("Could not create snapshot '%s': %d (%s)",
3100 snapshot_name
, ret
, strerror(-ret
));
3104 case SNAPSHOT_APPLY
:
3105 ret
= bdrv_snapshot_goto(bs
, snapshot_name
, &err
);
3107 error_reportf_err(err
, "Could not apply snapshot '%s': ",
3112 case SNAPSHOT_DELETE
:
3113 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
3115 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3130 static int img_rebase(int argc
, char **argv
)
3132 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3133 uint8_t *buf_old
= NULL
;
3134 uint8_t *buf_new
= NULL
;
3135 BlockDriverState
*bs
= NULL
;
3137 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3138 int c
, flags
, src_flags
, ret
;
3139 bool writethrough
, src_writethrough
;
3141 bool force_share
= false;
3144 Error
*local_err
= NULL
;
3145 bool image_opts
= false;
3147 /* Parse commandline parameters */
3149 cache
= BDRV_DEFAULT_CACHE
;
3150 src_cache
= BDRV_DEFAULT_CACHE
;
3154 static const struct option long_options
[] = {
3155 {"help", no_argument
, 0, 'h'},
3156 {"object", required_argument
, 0, OPTION_OBJECT
},
3157 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3158 {"force-share", no_argument
, 0, 'U'},
3161 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3162 long_options
, NULL
);
3168 missing_argument(argv
[optind
- 1]);
3171 unrecognized_option(argv
[optind
- 1]);
3180 out_basefmt
= optarg
;
3183 out_baseimg
= optarg
;
3200 case OPTION_OBJECT
: {
3202 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3208 case OPTION_IMAGE_OPTS
:
3221 if (optind
!= argc
- 1) {
3222 error_exit("Expecting one image file name");
3224 if (!unsafe
&& !out_baseimg
) {
3225 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3227 filename
= argv
[optind
++];
3229 if (qemu_opts_foreach(&qemu_object_opts
,
3230 user_creatable_add_opts_foreach
,
3235 qemu_progress_init(progress
, 2.0);
3236 qemu_progress_print(0, 100);
3238 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3239 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3241 error_report("Invalid cache option: %s", cache
);
3246 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3248 error_report("Invalid source cache option: %s", src_cache
);
3252 /* The source files are opened read-only, don't care about WCE */
3253 assert((src_flags
& BDRV_O_RDWR
) == 0);
3254 (void) src_writethrough
;
3259 * Ignore the old backing file for unsafe rebase in case we want to correct
3260 * the reference to a renamed or moved backing file.
3262 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3270 if (out_basefmt
!= NULL
) {
3271 if (bdrv_find_format(out_basefmt
) == NULL
) {
3272 error_report("Invalid format name: '%s'", out_basefmt
);
3278 /* For safe rebasing we need to compare old and new backing file */
3280 char backing_name
[PATH_MAX
];
3281 QDict
*options
= NULL
;
3283 if (bs
->backing_format
[0] != '\0') {
3284 options
= qdict_new();
3285 qdict_put_str(options
, "driver", bs
->backing_format
);
3290 options
= qdict_new();
3292 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3294 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3295 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3296 options
, src_flags
, &local_err
);
3297 if (!blk_old_backing
) {
3298 error_reportf_err(local_err
,
3299 "Could not open old backing file '%s': ",
3305 if (out_baseimg
[0]) {
3306 const char *overlay_filename
;
3307 char *out_real_path
;
3309 options
= qdict_new();
3311 qdict_put_str(options
, "driver", out_basefmt
);
3314 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3317 overlay_filename
= bs
->exact_filename
[0] ? bs
->exact_filename
3319 out_real_path
= g_malloc(PATH_MAX
);
3321 bdrv_get_full_backing_filename_from_filename(overlay_filename
,
3327 error_reportf_err(local_err
,
3328 "Could not resolve backing filename: ");
3330 g_free(out_real_path
);
3334 blk_new_backing
= blk_new_open(out_real_path
, NULL
,
3335 options
, src_flags
, &local_err
);
3336 g_free(out_real_path
);
3337 if (!blk_new_backing
) {
3338 error_reportf_err(local_err
,
3339 "Could not open new backing file '%s': ",
3348 * Check each unallocated cluster in the COW file. If it is unallocated,
3349 * accesses go to the backing file. We must therefore compare this cluster
3350 * in the old and new backing file, and if they differ we need to copy it
3351 * from the old backing file into the COW file.
3353 * If qemu-img crashes during this step, no harm is done. The content of
3354 * the image is the same as the original one at any time.
3358 int64_t old_backing_size
;
3359 int64_t new_backing_size
= 0;
3362 float local_progress
= 0;
3364 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3365 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3367 size
= blk_getlength(blk
);
3369 error_report("Could not get size of '%s': %s",
3370 filename
, strerror(-size
));
3374 old_backing_size
= blk_getlength(blk_old_backing
);
3375 if (old_backing_size
< 0) {
3376 char backing_name
[PATH_MAX
];
3378 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3379 error_report("Could not get size of '%s': %s",
3380 backing_name
, strerror(-old_backing_size
));
3384 if (blk_new_backing
) {
3385 new_backing_size
= blk_getlength(blk_new_backing
);
3386 if (new_backing_size
< 0) {
3387 error_report("Could not get size of '%s': %s",
3388 out_baseimg
, strerror(-new_backing_size
));
3395 local_progress
= (float)100 / (size
/ MIN(size
, IO_BUF_SIZE
));
3398 for (offset
= 0; offset
< size
; offset
+= n
) {
3399 /* How many bytes can we handle with the next read? */
3400 n
= MIN(IO_BUF_SIZE
, size
- offset
);
3402 /* If the cluster is allocated, we don't need to take action */
3403 ret
= bdrv_is_allocated(bs
, offset
, n
, &n
);
3405 error_report("error while reading image metadata: %s",
3414 * Read old and new backing file and take into consideration that
3415 * backing files may be smaller than the COW image.
3417 if (offset
>= old_backing_size
) {
3418 memset(buf_old
, 0, n
);
3420 if (offset
+ n
> old_backing_size
) {
3421 n
= old_backing_size
- offset
;
3424 ret
= blk_pread(blk_old_backing
, offset
, buf_old
, n
);
3426 error_report("error while reading from old backing file");
3431 if (offset
>= new_backing_size
|| !blk_new_backing
) {
3432 memset(buf_new
, 0, n
);
3434 if (offset
+ n
> new_backing_size
) {
3435 n
= new_backing_size
- offset
;
3438 ret
= blk_pread(blk_new_backing
, offset
, buf_new
, n
);
3440 error_report("error while reading from new backing file");
3445 /* If they differ, we need to write to the COW file */
3446 uint64_t written
= 0;
3448 while (written
< n
) {
3451 if (compare_buffers(buf_old
+ written
, buf_new
+ written
,
3452 n
- written
, &pnum
))
3454 ret
= blk_pwrite(blk
, offset
+ written
,
3455 buf_old
+ written
, pnum
, 0);
3457 error_report("Error while writing to COW image: %s",
3465 qemu_progress_print(local_progress
, 100);
3470 * Change the backing file. All clusters that are different from the old
3471 * backing file are overwritten in the COW file now, so the visible content
3472 * doesn't change when we switch the backing file.
3474 if (out_baseimg
&& *out_baseimg
) {
3475 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3477 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3480 if (ret
== -ENOSPC
) {
3481 error_report("Could not change the backing file to '%s': No "
3482 "space left in the file header", out_baseimg
);
3483 } else if (ret
< 0) {
3484 error_report("Could not change the backing file to '%s': %s",
3485 out_baseimg
, strerror(-ret
));
3488 qemu_progress_print(100, 0);
3490 * TODO At this point it is possible to check if any clusters that are
3491 * allocated in the COW file are the same in the backing file. If so, they
3492 * could be dropped from the COW file. Don't do this before switching the
3493 * backing file, in case of a crash this would lead to corruption.
3496 qemu_progress_end();
3499 blk_unref(blk_old_backing
);
3500 blk_unref(blk_new_backing
);
3502 qemu_vfree(buf_old
);
3503 qemu_vfree(buf_new
);
3512 static int img_resize(int argc
, char **argv
)
3515 int c
, ret
, relative
;
3516 const char *filename
, *fmt
, *size
;
3517 int64_t n
, total_size
, current_size
, new_size
;
3519 BlockBackend
*blk
= NULL
;
3520 PreallocMode prealloc
= PREALLOC_MODE_OFF
;
3523 static QemuOptsList resize_options
= {
3524 .name
= "resize_options",
3525 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3528 .name
= BLOCK_OPT_SIZE
,
3529 .type
= QEMU_OPT_SIZE
,
3530 .help
= "Virtual disk size"
3536 bool image_opts
= false;
3537 bool shrink
= false;
3539 /* Remove size from argv manually so that negative numbers are not treated
3540 * as options by getopt. */
3542 error_exit("Not enough arguments");
3546 size
= argv
[--argc
];
3548 /* Parse getopt arguments */
3551 static const struct option long_options
[] = {
3552 {"help", no_argument
, 0, 'h'},
3553 {"object", required_argument
, 0, OPTION_OBJECT
},
3554 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3555 {"preallocation", required_argument
, 0, OPTION_PREALLOCATION
},
3556 {"shrink", no_argument
, 0, OPTION_SHRINK
},
3559 c
= getopt_long(argc
, argv
, ":f:hq",
3560 long_options
, NULL
);
3566 missing_argument(argv
[optind
- 1]);
3569 unrecognized_option(argv
[optind
- 1]);
3580 case OPTION_OBJECT
: {
3582 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3588 case OPTION_IMAGE_OPTS
:
3591 case OPTION_PREALLOCATION
:
3592 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, optarg
,
3593 PREALLOC_MODE__MAX
, NULL
);
3594 if (prealloc
== PREALLOC_MODE__MAX
) {
3595 error_report("Invalid preallocation mode '%s'", optarg
);
3604 if (optind
!= argc
- 1) {
3605 error_exit("Expecting image file name and size");
3607 filename
= argv
[optind
++];
3609 if (qemu_opts_foreach(&qemu_object_opts
,
3610 user_creatable_add_opts_foreach
,
3615 /* Choose grow, shrink, or absolute resize mode */
3631 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3632 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3634 error_report_err(err
);
3636 qemu_opts_del(param
);
3639 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3640 qemu_opts_del(param
);
3642 blk
= img_open(image_opts
, filename
, fmt
,
3643 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
3650 current_size
= blk_getlength(blk
);
3651 if (current_size
< 0) {
3652 error_report("Failed to inquire current image length: %s",
3653 strerror(-current_size
));
3659 total_size
= current_size
+ n
* relative
;
3663 if (total_size
<= 0) {
3664 error_report("New image size must be positive");
3669 if (total_size
<= current_size
&& prealloc
!= PREALLOC_MODE_OFF
) {
3670 error_report("Preallocation can only be used for growing images");
3675 if (total_size
< current_size
&& !shrink
) {
3676 warn_report("Shrinking an image will delete all data beyond the "
3677 "shrunken image's end. Before performing such an "
3678 "operation, make sure there is no important data there.");
3680 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk
)), "raw") != 0) {
3682 "Use the --shrink option to perform a shrink operation.");
3686 warn_report("Using the --shrink option will suppress this message. "
3687 "Note that future versions of qemu-img may refuse to "
3688 "shrink images without this option.");
3692 ret
= blk_truncate(blk
, total_size
, prealloc
, &err
);
3694 error_report_err(err
);
3698 new_size
= blk_getlength(blk
);
3700 error_report("Failed to verify truncated image length: %s",
3701 strerror(-new_size
));
3706 /* Some block drivers implement a truncation method, but only so
3707 * the user can cause qemu to refresh the image's size from disk.
3708 * The idea is that the user resizes the image outside of qemu and
3709 * then invokes block_resize to inform qemu about it.
3710 * (This includes iscsi and file-posix for device files.)
3711 * Of course, that is not the behavior someone invoking
3712 * qemu-img resize would find useful, so we catch that behavior
3713 * here and tell the user. */
3714 if (new_size
!= total_size
&& new_size
== current_size
) {
3715 error_report("Image was not resized; resizing may not be supported "
3721 if (new_size
!= total_size
) {
3722 warn_report("Image should have been resized to %" PRIi64
3723 " bytes, but was resized to %" PRIi64
" bytes",
3724 total_size
, new_size
);
3727 qprintf(quiet
, "Image resized.\n");
3737 static void amend_status_cb(BlockDriverState
*bs
,
3738 int64_t offset
, int64_t total_work_size
,
3741 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3744 static int print_amend_option_help(const char *format
)
3748 /* Find driver and parse its options */
3749 drv
= bdrv_find_format(format
);
3751 error_report("Unknown file format '%s'", format
);
3755 if (!drv
->bdrv_amend_options
) {
3756 error_report("Format driver '%s' does not support option amendment",
3761 /* Every driver supporting amendment must have create_opts */
3762 assert(drv
->create_opts
);
3764 printf("Creation options for '%s':\n", format
);
3765 qemu_opts_print_help(drv
->create_opts
);
3766 printf("\nNote that not all of these options may be amendable.\n");
3770 static int img_amend(int argc
, char **argv
)
3774 char *options
= NULL
;
3775 QemuOptsList
*create_opts
= NULL
;
3776 QemuOpts
*opts
= NULL
;
3777 const char *fmt
= NULL
, *filename
, *cache
;
3780 bool quiet
= false, progress
= false;
3781 BlockBackend
*blk
= NULL
;
3782 BlockDriverState
*bs
= NULL
;
3783 bool image_opts
= false;
3785 cache
= BDRV_DEFAULT_CACHE
;
3787 static const struct option long_options
[] = {
3788 {"help", no_argument
, 0, 'h'},
3789 {"object", required_argument
, 0, OPTION_OBJECT
},
3790 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3793 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
3794 long_options
, NULL
);
3801 missing_argument(argv
[optind
- 1]);
3804 unrecognized_option(argv
[optind
- 1]);
3810 if (!is_valid_option_list(optarg
)) {
3811 error_report("Invalid option list: %s", optarg
);
3813 goto out_no_progress
;
3816 options
= g_strdup(optarg
);
3818 char *old_options
= options
;
3819 options
= g_strdup_printf("%s,%s", options
, optarg
);
3820 g_free(old_options
);
3836 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3840 goto out_no_progress
;
3843 case OPTION_IMAGE_OPTS
:
3850 error_exit("Must specify options (-o)");
3853 if (qemu_opts_foreach(&qemu_object_opts
,
3854 user_creatable_add_opts_foreach
,
3857 goto out_no_progress
;
3863 qemu_progress_init(progress
, 1.0);
3865 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3866 if (fmt
&& has_help_option(options
)) {
3867 /* If a format is explicitly specified (and possibly no filename is
3868 * given), print option help here */
3869 ret
= print_amend_option_help(fmt
);
3873 if (optind
!= argc
- 1) {
3874 error_report("Expecting one image file name");
3879 flags
= BDRV_O_RDWR
;
3880 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3882 error_report("Invalid cache option: %s", cache
);
3886 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3894 fmt
= bs
->drv
->format_name
;
3896 if (has_help_option(options
)) {
3897 /* If the format was auto-detected, print option help here */
3898 ret
= print_amend_option_help(fmt
);
3902 if (!bs
->drv
->bdrv_amend_options
) {
3903 error_report("Format driver '%s' does not support option amendment",
3909 /* Every driver supporting amendment must have create_opts */
3910 assert(bs
->drv
->create_opts
);
3912 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3913 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3914 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3916 error_report_err(err
);
3921 /* In case the driver does not call amend_status_cb() */
3922 qemu_progress_print(0.f
, 0);
3923 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
, &err
);
3924 qemu_progress_print(100.f
, 0);
3926 error_report_err(err
);
3931 qemu_progress_end();
3935 qemu_opts_del(opts
);
3936 qemu_opts_free(create_opts
);
3945 typedef struct BenchData
{
3947 uint64_t image_size
;
3954 bool drain_on_flush
;
3963 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3966 error_report("Failed flush request: %s", strerror(-ret
));
3971 static void bench_cb(void *opaque
, int ret
)
3973 BenchData
*b
= opaque
;
3977 error_report("Failed request: %s", strerror(-ret
));
3982 /* Just finished a flush with drained queue: Start next requests */
3983 assert(b
->in_flight
== 0);
3984 b
->in_flush
= false;
3985 } else if (b
->in_flight
> 0) {
3986 int remaining
= b
->n
- b
->in_flight
;
3991 /* Time for flush? Drain queue if requested, then flush */
3992 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3993 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3994 BlockCompletionFunc
*cb
;
3996 if (b
->drain_on_flush
) {
4000 cb
= bench_undrained_flush_cb
;
4003 acb
= blk_aio_flush(b
->blk
, cb
, b
);
4005 error_report("Failed to issue flush request");
4009 if (b
->drain_on_flush
) {
4015 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
4016 int64_t offset
= b
->offset
;
4017 /* blk_aio_* might look for completed I/Os and kick bench_cb
4018 * again, so make sure this operation is counted by in_flight
4019 * and b->offset is ready for the next submission.
4022 b
->offset
+= b
->step
;
4023 b
->offset
%= b
->image_size
;
4025 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4027 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4030 error_report("Failed to issue request");
4036 static int img_bench(int argc
, char **argv
)
4039 const char *fmt
= NULL
, *filename
;
4041 bool image_opts
= false;
4042 bool is_write
= false;
4046 size_t bufsize
= 4096;
4049 int flush_interval
= 0;
4050 bool drain_on_flush
= true;
4052 BlockBackend
*blk
= NULL
;
4053 BenchData data
= {};
4055 bool writethrough
= false;
4056 struct timeval t1
, t2
;
4058 bool force_share
= false;
4062 static const struct option long_options
[] = {
4063 {"help", no_argument
, 0, 'h'},
4064 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
4065 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4066 {"pattern", required_argument
, 0, OPTION_PATTERN
},
4067 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
4068 {"force-share", no_argument
, 0, 'U'},
4071 c
= getopt_long(argc
, argv
, ":hc:d:f:no:qs:S:t:wU", long_options
, NULL
);
4078 missing_argument(argv
[optind
- 1]);
4081 unrecognized_option(argv
[optind
- 1]);
4090 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4091 error_report("Invalid request count specified");
4101 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4102 error_report("Invalid queue depth specified");
4112 flags
|= BDRV_O_NATIVE_AIO
;
4116 offset
= cvtnum(optarg
);
4118 error_report("Invalid offset specified");
4131 sval
= cvtnum(optarg
);
4132 if (sval
< 0 || sval
> INT_MAX
) {
4133 error_report("Invalid buffer size specified");
4144 sval
= cvtnum(optarg
);
4145 if (sval
< 0 || sval
> INT_MAX
) {
4146 error_report("Invalid step size specified");
4154 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
4156 error_report("Invalid cache mode");
4162 flags
|= BDRV_O_RDWR
;
4168 case OPTION_PATTERN
:
4172 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
4173 error_report("Invalid pattern byte specified");
4179 case OPTION_FLUSH_INTERVAL
:
4183 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4184 error_report("Invalid flush interval specified");
4187 flush_interval
= res
;
4190 case OPTION_NO_DRAIN
:
4191 drain_on_flush
= false;
4193 case OPTION_IMAGE_OPTS
:
4199 if (optind
!= argc
- 1) {
4200 error_exit("Expecting one image file name");
4202 filename
= argv
[argc
- 1];
4204 if (!is_write
&& flush_interval
) {
4205 error_report("--flush-interval is only available in write tests");
4209 if (flush_interval
&& flush_interval
< depth
) {
4210 error_report("Flush interval can't be smaller than depth");
4215 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4222 image_size
= blk_getlength(blk
);
4223 if (image_size
< 0) {
4228 data
= (BenchData
) {
4230 .image_size
= image_size
,
4232 .step
= step
?: bufsize
,
4237 .flush_interval
= flush_interval
,
4238 .drain_on_flush
= drain_on_flush
,
4240 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4241 "(starting at offset %" PRId64
", step size %d)\n",
4242 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4243 data
.offset
, data
.step
);
4244 if (flush_interval
) {
4245 printf("Sending flush every %d requests\n", flush_interval
);
4248 buf_size
= data
.nrreq
* data
.bufsize
;
4249 data
.buf
= blk_blockalign(blk
, buf_size
);
4250 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4252 blk_register_buf(blk
, data
.buf
, buf_size
);
4254 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4255 for (i
= 0; i
< data
.nrreq
; i
++) {
4256 qemu_iovec_init(&data
.qiov
[i
], 1);
4257 qemu_iovec_add(&data
.qiov
[i
],
4258 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4261 gettimeofday(&t1
, NULL
);
4264 while (data
.n
> 0) {
4265 main_loop_wait(false);
4267 gettimeofday(&t2
, NULL
);
4269 printf("Run completed in %3.3f seconds.\n",
4270 (t2
.tv_sec
- t1
.tv_sec
)
4271 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4275 blk_unregister_buf(blk
, data
.buf
);
4277 qemu_vfree(data
.buf
);
4298 int bsz
; /* Block size */
4306 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4310 static int img_dd_bs(const char *arg
,
4311 struct DdIo
*in
, struct DdIo
*out
,
4318 if (res
<= 0 || res
> INT_MAX
) {
4319 error_report("invalid number: '%s'", arg
);
4322 in
->bsz
= out
->bsz
= res
;
4327 static int img_dd_count(const char *arg
,
4328 struct DdIo
*in
, struct DdIo
*out
,
4331 dd
->count
= cvtnum(arg
);
4333 if (dd
->count
< 0) {
4334 error_report("invalid number: '%s'", arg
);
4341 static int img_dd_if(const char *arg
,
4342 struct DdIo
*in
, struct DdIo
*out
,
4345 in
->filename
= g_strdup(arg
);
4350 static int img_dd_of(const char *arg
,
4351 struct DdIo
*in
, struct DdIo
*out
,
4354 out
->filename
= g_strdup(arg
);
4359 static int img_dd_skip(const char *arg
,
4360 struct DdIo
*in
, struct DdIo
*out
,
4363 in
->offset
= cvtnum(arg
);
4365 if (in
->offset
< 0) {
4366 error_report("invalid number: '%s'", arg
);
4373 static int img_dd(int argc
, char **argv
)
4378 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4379 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4380 QemuOpts
*opts
= NULL
;
4381 QemuOptsList
*create_opts
= NULL
;
4382 Error
*local_err
= NULL
;
4383 bool image_opts
= false;
4385 const char *out_fmt
= "raw";
4386 const char *fmt
= NULL
;
4388 int64_t block_count
= 0, out_pos
, in_pos
;
4389 bool force_share
= false;
4390 struct DdInfo dd
= {
4395 .bsz
= 512, /* Block size is by default 512 bytes */
4407 const struct DdOpts options
[] = {
4408 { "bs", img_dd_bs
, C_BS
},
4409 { "count", img_dd_count
, C_COUNT
},
4410 { "if", img_dd_if
, C_IF
},
4411 { "of", img_dd_of
, C_OF
},
4412 { "skip", img_dd_skip
, C_SKIP
},
4415 const struct option long_options
[] = {
4416 { "help", no_argument
, 0, 'h'},
4417 { "object", required_argument
, 0, OPTION_OBJECT
},
4418 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4419 { "force-share", no_argument
, 0, 'U'},
4423 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
4435 missing_argument(argv
[optind
- 1]);
4438 unrecognized_option(argv
[optind
- 1]);
4447 if (!qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true)) {
4452 case OPTION_IMAGE_OPTS
:
4458 for (i
= optind
; i
< argc
; i
++) {
4460 arg
= g_strdup(argv
[i
]);
4462 tmp
= strchr(arg
, '=');
4464 error_report("unrecognized operand %s", arg
);
4471 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4472 if (!strcmp(arg
, options
[j
].name
)) {
4476 if (options
[j
].name
== NULL
) {
4477 error_report("unrecognized operand %s", arg
);
4482 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4486 dd
.flags
|= options
[j
].flag
;
4491 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4492 error_report("Must specify both input and output files");
4497 if (qemu_opts_foreach(&qemu_object_opts
,
4498 user_creatable_add_opts_foreach
,
4504 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
4512 drv
= bdrv_find_format(out_fmt
);
4514 error_report("Unknown file format");
4518 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4521 error_report_err(local_err
);
4525 if (!drv
->create_opts
) {
4526 error_report("Format driver '%s' does not support image creation",
4531 if (!proto_drv
->create_opts
) {
4532 error_report("Protocol driver '%s' does not support image creation",
4533 proto_drv
->format_name
);
4537 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4538 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4540 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4542 size
= blk_getlength(blk1
);
4544 error_report("Failed to get size for '%s'", in
.filename
);
4549 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4550 dd
.count
* in
.bsz
< size
) {
4551 size
= dd
.count
* in
.bsz
;
4554 /* Overflow means the specified offset is beyond input image's size */
4555 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4556 size
< in
.bsz
* in
.offset
)) {
4557 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4559 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4560 size
- in
.bsz
* in
.offset
, &error_abort
);
4563 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4565 error_reportf_err(local_err
,
4566 "%s: error while creating output image: ",
4572 /* TODO, we can't honour --image-opts for the target,
4573 * since it needs to be given in a format compatible
4574 * with the bdrv_create() call above which does not
4575 * support image-opts style.
4577 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
4578 false, false, false);
4585 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4586 size
< in
.offset
* in
.bsz
)) {
4587 /* We give a warning if the skip option is bigger than the input
4588 * size and create an empty output disk image (i.e. like dd(1)).
4590 error_report("%s: cannot skip to specified offset", in
.filename
);
4593 in_pos
= in
.offset
* in
.bsz
;
4596 in
.buf
= g_new(uint8_t, in
.bsz
);
4598 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4599 int in_ret
, out_ret
;
4601 if (in_pos
+ in
.bsz
> size
) {
4602 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4604 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4607 error_report("error while reading from input image file: %s",
4614 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4617 error_report("error while writing to output image file: %s",
4618 strerror(-out_ret
));
4627 qemu_opts_del(opts
);
4628 qemu_opts_free(create_opts
);
4631 g_free(in
.filename
);
4632 g_free(out
.filename
);
4642 static void dump_json_block_measure_info(BlockMeasureInfo
*info
)
4646 Visitor
*v
= qobject_output_visitor_new(&obj
);
4648 visit_type_BlockMeasureInfo(v
, NULL
, &info
, &error_abort
);
4649 visit_complete(v
, &obj
);
4650 str
= qobject_to_json_pretty(obj
);
4651 assert(str
!= NULL
);
4652 printf("%s\n", qstring_get_str(str
));
4658 static int img_measure(int argc
, char **argv
)
4660 static const struct option long_options
[] = {
4661 {"help", no_argument
, 0, 'h'},
4662 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4663 {"object", required_argument
, 0, OPTION_OBJECT
},
4664 {"output", required_argument
, 0, OPTION_OUTPUT
},
4665 {"size", required_argument
, 0, OPTION_SIZE
},
4666 {"force-share", no_argument
, 0, 'U'},
4669 OutputFormat output_format
= OFORMAT_HUMAN
;
4670 BlockBackend
*in_blk
= NULL
;
4672 const char *filename
= NULL
;
4673 const char *fmt
= NULL
;
4674 const char *out_fmt
= "raw";
4675 char *options
= NULL
;
4676 char *snapshot_name
= NULL
;
4677 bool force_share
= false;
4678 QemuOpts
*opts
= NULL
;
4679 QemuOpts
*object_opts
= NULL
;
4680 QemuOpts
*sn_opts
= NULL
;
4681 QemuOptsList
*create_opts
= NULL
;
4682 bool image_opts
= false;
4683 uint64_t img_size
= UINT64_MAX
;
4684 BlockMeasureInfo
*info
= NULL
;
4685 Error
*local_err
= NULL
;
4689 while ((c
= getopt_long(argc
, argv
, "hf:O:o:l:U",
4690 long_options
, NULL
)) != -1) {
4703 if (!is_valid_option_list(optarg
)) {
4704 error_report("Invalid option list: %s", optarg
);
4708 options
= g_strdup(optarg
);
4710 char *old_options
= options
;
4711 options
= g_strdup_printf("%s,%s", options
, optarg
);
4712 g_free(old_options
);
4716 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
4717 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
4720 error_report("Failed in parsing snapshot param '%s'",
4725 snapshot_name
= optarg
;
4732 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
4738 case OPTION_IMAGE_OPTS
:
4742 if (!strcmp(optarg
, "json")) {
4743 output_format
= OFORMAT_JSON
;
4744 } else if (!strcmp(optarg
, "human")) {
4745 output_format
= OFORMAT_HUMAN
;
4747 error_report("--output must be used with human or json "
4756 sval
= cvtnum(optarg
);
4758 if (sval
== -ERANGE
) {
4759 error_report("Image size must be less than 8 EiB!");
4761 error_report("Invalid image size specified! You may use "
4762 "k, M, G, T, P or E suffixes for ");
4763 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4764 "petabytes and exabytes.");
4768 img_size
= (uint64_t)sval
;
4774 if (qemu_opts_foreach(&qemu_object_opts
,
4775 user_creatable_add_opts_foreach
,
4780 if (argc
- optind
> 1) {
4781 error_report("At most one filename argument is allowed.");
4783 } else if (argc
- optind
== 1) {
4784 filename
= argv
[optind
];
4788 (object_opts
|| image_opts
|| fmt
|| snapshot_name
|| sn_opts
)) {
4789 error_report("--object, --image-opts, -f, and -l "
4790 "require a filename argument.");
4793 if (filename
&& img_size
!= UINT64_MAX
) {
4794 error_report("--size N cannot be used together with a filename.");
4797 if (!filename
&& img_size
== UINT64_MAX
) {
4798 error_report("Either --size N or one filename must be specified.");
4803 in_blk
= img_open(image_opts
, filename
, fmt
, 0,
4804 false, false, force_share
);
4810 bdrv_snapshot_load_tmp(blk_bs(in_blk
),
4811 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
4812 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
4814 } else if (snapshot_name
!= NULL
) {
4815 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk
),
4816 snapshot_name
, &local_err
);
4819 error_reportf_err(local_err
, "Failed to load snapshot: ");
4824 drv
= bdrv_find_format(out_fmt
);
4826 error_report("Unknown file format '%s'", out_fmt
);
4829 if (!drv
->create_opts
) {
4830 error_report("Format driver '%s' does not support image creation",
4835 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4836 create_opts
= qemu_opts_append(create_opts
, bdrv_file
.create_opts
);
4837 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4839 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
4841 error_report_err(local_err
);
4842 error_report("Invalid options for file format '%s'", out_fmt
);
4846 if (img_size
!= UINT64_MAX
) {
4847 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, img_size
, &error_abort
);
4850 info
= bdrv_measure(drv
, opts
, in_blk
? blk_bs(in_blk
) : NULL
, &local_err
);
4852 error_report_err(local_err
);
4856 if (output_format
== OFORMAT_HUMAN
) {
4857 printf("required size: %" PRIu64
"\n", info
->required
);
4858 printf("fully allocated size: %" PRIu64
"\n", info
->fully_allocated
);
4860 dump_json_block_measure_info(info
);
4866 qapi_free_BlockMeasureInfo(info
);
4867 qemu_opts_del(object_opts
);
4868 qemu_opts_del(opts
);
4869 qemu_opts_del(sn_opts
);
4870 qemu_opts_free(create_opts
);
4876 static const img_cmd_t img_cmds
[] = {
4877 #define DEF(option, callback, arg_string) \
4878 { option, callback },
4879 #include "qemu-img-cmds.h"
4884 int main(int argc
, char **argv
)
4886 const img_cmd_t
*cmd
;
4887 const char *cmdname
;
4888 Error
*local_error
= NULL
;
4889 char *trace_file
= NULL
;
4891 static const struct option long_options
[] = {
4892 {"help", no_argument
, 0, 'h'},
4893 {"version", no_argument
, 0, 'V'},
4894 {"trace", required_argument
, NULL
, 'T'},
4899 signal(SIGPIPE
, SIG_IGN
);
4902 module_call_init(MODULE_INIT_TRACE
);
4903 error_set_progname(argv
[0]);
4904 qemu_init_exec_dir(argv
[0]);
4906 if (qemu_init_main_loop(&local_error
)) {
4907 error_report_err(local_error
);
4911 qcrypto_init(&error_fatal
);
4913 module_call_init(MODULE_INIT_QOM
);
4916 error_exit("Not enough arguments");
4919 qemu_add_opts(&qemu_object_opts
);
4920 qemu_add_opts(&qemu_source_opts
);
4921 qemu_add_opts(&qemu_trace_opts
);
4923 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
4926 missing_argument(argv
[optind
- 1]);
4929 unrecognized_option(argv
[optind
- 1]);
4935 printf(QEMU_IMG_VERSION
);
4939 trace_file
= trace_opt_parse(optarg
);
4944 cmdname
= argv
[optind
];
4946 /* reset getopt_long scanning */
4954 if (!trace_init_backends()) {
4957 trace_init_file(trace_file
);
4958 qemu_set_log(LOG_TRACE
);
4960 /* find the command */
4961 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4962 if (!strcmp(cmdname
, cmd
->name
)) {
4963 return cmd
->handler(argc
, argv
);
4968 error_exit("Command not found: %s", cmdname
);