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
, ...)
89 error_vreport(fmt
, ap
);
92 error_printf("Try 'qemu-img --help' for more information\n");
96 static void QEMU_NORETURN
missing_argument(const char *option
)
98 error_exit("missing argument for option '%s'", option
);
101 static void QEMU_NORETURN
unrecognized_option(const char *option
)
103 error_exit("unrecognized option '%s'", option
);
106 /* Please keep in synch with qemu-img.texi */
107 static void QEMU_NORETURN
help(void)
109 const char *help_msg
=
111 "usage: qemu-img [standard options] command [command options]\n"
112 "QEMU disk image utility\n"
114 " '-h', '--help' display this help and exit\n"
115 " '-V', '--version' output version information and exit\n"
116 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
117 " specify tracing options\n"
120 #define DEF(option, callback, arg_string) \
122 #include "qemu-img-cmds.h"
125 "Command parameters:\n"
126 " 'filename' is a disk image filename\n"
127 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
128 " manual page for a description of the object properties. The most common\n"
129 " object type is a 'secret', which is used to supply passwords and/or\n"
130 " encryption keys.\n"
131 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
132 " 'cache' is the cache mode used to write the output disk image, the valid\n"
133 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
134 " 'directsync' and 'unsafe' (default for convert)\n"
135 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
136 " options are the same as for the 'cache' option\n"
137 " 'size' is the disk image size in bytes. Optional suffixes\n"
138 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
139 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
140 " supported. 'b' is ignored.\n"
141 " 'output_filename' is the destination disk image filename\n"
142 " 'output_fmt' is the destination format\n"
143 " 'options' is a comma separated list of format specific options in a\n"
144 " name=value format. Use -o ? for an overview of the options supported by the\n"
146 " 'snapshot_param' is param used for internal snapshot, format\n"
147 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
149 " '-c' indicates that target image must be compressed (qcow format only)\n"
150 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
151 " new backing file match exactly. The image doesn't need a working\n"
152 " backing file before rebasing in this case (useful for renaming the\n"
153 " backing file). For image creation, allow creating without attempting\n"
154 " to open the backing file.\n"
155 " '-h' with or without a command shows this help and lists the supported formats\n"
156 " '-p' show progress of command (only certain commands)\n"
157 " '-q' use Quiet mode - do not print any output (except errors)\n"
158 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
159 " contain only zeros for qemu-img to create a sparse image during\n"
160 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
161 " unallocated or zero sectors, and the destination image will always be\n"
163 " '--output' takes the format in which the output must be done (human or json)\n"
164 " '-n' skips the target volume creation (useful if the volume is created\n"
165 " prior to running qemu-img)\n"
167 "Parameters to check subcommand:\n"
168 " '-r' tries to repair any inconsistencies that are found during the check.\n"
169 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
170 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
171 " hiding corruption that has already occurred.\n"
173 "Parameters to convert subcommand:\n"
174 " '-m' specifies how many coroutines work in parallel during the convert\n"
175 " process (defaults to 8)\n"
176 " '-W' allow to write to the target out of order rather than sequential\n"
178 "Parameters to snapshot subcommand:\n"
179 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
180 " '-a' applies a snapshot (revert disk to saved state)\n"
181 " '-c' creates a snapshot\n"
182 " '-d' deletes a snapshot\n"
183 " '-l' lists all snapshots in the given image\n"
185 "Parameters to compare subcommand:\n"
186 " '-f' first image format\n"
187 " '-F' second image format\n"
188 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
190 "Parameters to dd subcommand:\n"
191 " 'bs=BYTES' read and write up to BYTES bytes at a time "
193 " 'count=N' copy only N input blocks\n"
194 " 'if=FILE' read from FILE\n"
195 " 'of=FILE' write to FILE\n"
196 " 'skip=N' skip N bs-sized blocks at the start of input\n";
198 printf("%s\nSupported formats:", help_msg
);
199 bdrv_iterate_format(format_print
, NULL
, false);
200 printf("\n\n" QEMU_HELP_BOTTOM
"\n");
204 static QemuOptsList qemu_object_opts
= {
206 .implied_opt_name
= "qom-type",
207 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
213 static QemuOptsList qemu_source_opts
= {
215 .implied_opt_name
= "file",
216 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
222 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
228 ret
= vprintf(fmt
, args
);
235 static int print_block_option_help(const char *filename
, const char *fmt
)
237 BlockDriver
*drv
, *proto_drv
;
238 QemuOptsList
*create_opts
= NULL
;
239 Error
*local_err
= NULL
;
241 /* Find driver and parse its options */
242 drv
= bdrv_find_format(fmt
);
244 error_report("Unknown file format '%s'", fmt
);
248 if (!drv
->create_opts
) {
249 error_report("Format driver '%s' does not support image creation", fmt
);
253 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
255 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
257 error_report_err(local_err
);
258 qemu_opts_free(create_opts
);
261 if (!proto_drv
->create_opts
) {
262 error_report("Protocol driver '%s' does not support image creation",
263 proto_drv
->format_name
);
264 qemu_opts_free(create_opts
);
267 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
271 printf("Supported options:\n");
273 printf("Supported %s options:\n", fmt
);
275 qemu_opts_print_help(create_opts
, false);
276 qemu_opts_free(create_opts
);
280 "The protocol level may support further options.\n"
281 "Specify the target filename to include those options.\n");
288 static BlockBackend
*img_open_opts(const char *optstr
,
289 QemuOpts
*opts
, int flags
, bool writethrough
,
290 bool quiet
, bool force_share
)
293 Error
*local_err
= NULL
;
295 options
= qemu_opts_to_qdict(opts
, NULL
);
297 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
298 && strcmp(qdict_get_str(options
, BDRV_OPT_FORCE_SHARE
), "on")) {
299 error_report("--force-share/-U conflicts with image options");
300 qobject_unref(options
);
303 qdict_put_str(options
, BDRV_OPT_FORCE_SHARE
, "on");
305 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
307 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
310 blk_set_enable_write_cache(blk
, !writethrough
);
315 static BlockBackend
*img_open_file(const char *filename
,
317 const char *fmt
, int flags
,
318 bool writethrough
, bool quiet
,
322 Error
*local_err
= NULL
;
325 options
= qdict_new();
328 qdict_put_str(options
, "driver", fmt
);
332 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
334 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
336 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
339 blk_set_enable_write_cache(blk
, !writethrough
);
345 static int img_add_key_secrets(void *opaque
,
346 const char *name
, const char *value
,
349 QDict
*options
= opaque
;
351 if (g_str_has_suffix(name
, "key-secret")) {
352 qdict_put_str(options
, name
, value
);
359 static BlockBackend
*img_open(bool image_opts
,
360 const char *filename
,
361 const char *fmt
, int flags
, bool writethrough
,
362 bool quiet
, bool force_share
)
368 error_report("--image-opts and --format are mutually exclusive");
371 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
376 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
379 blk
= img_open_file(filename
, NULL
, fmt
, flags
, writethrough
, quiet
,
386 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
387 const char *base_filename
,
388 const char *base_fmt
)
393 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
395 error_report("Backing file not supported for file format '%s'",
402 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
404 error_report("Backing file format not supported for file "
413 static int64_t cvtnum(const char *s
)
418 err
= qemu_strtosz(s
, NULL
, &value
);
422 if (value
> INT64_MAX
) {
428 static int img_create(int argc
, char **argv
)
431 uint64_t img_size
= -1;
432 const char *fmt
= "raw";
433 const char *base_fmt
= NULL
;
434 const char *filename
;
435 const char *base_filename
= NULL
;
436 char *options
= NULL
;
437 Error
*local_err
= NULL
;
442 static const struct option long_options
[] = {
443 {"help", no_argument
, 0, 'h'},
444 {"object", required_argument
, 0, OPTION_OBJECT
},
447 c
= getopt_long(argc
, argv
, ":F:b:f:ho:qu",
454 missing_argument(argv
[optind
- 1]);
457 unrecognized_option(argv
[optind
- 1]);
466 base_filename
= optarg
;
472 if (!is_valid_option_list(optarg
)) {
473 error_report("Invalid option list: %s", optarg
);
477 options
= g_strdup(optarg
);
479 char *old_options
= options
;
480 options
= g_strdup_printf("%s,%s", options
, optarg
);
488 flags
|= BDRV_O_NO_BACKING
;
490 case OPTION_OBJECT
: {
492 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
501 /* Get the filename */
502 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
503 if (options
&& has_help_option(options
)) {
505 return print_block_option_help(filename
, fmt
);
508 if (optind
>= argc
) {
509 error_exit("Expecting image file name");
513 if (qemu_opts_foreach(&qemu_object_opts
,
514 user_creatable_add_opts_foreach
,
515 NULL
, &error_fatal
)) {
519 /* Get image size, if specified */
523 sval
= cvtnum(argv
[optind
++]);
525 if (sval
== -ERANGE
) {
526 error_report("Image size must be less than 8 EiB!");
528 error_report("Invalid image size specified! You may use k, M, "
529 "G, T, P or E suffixes for ");
530 error_report("kilobytes, megabytes, gigabytes, terabytes, "
531 "petabytes and exabytes.");
535 img_size
= (uint64_t)sval
;
537 if (optind
!= argc
) {
538 error_exit("Unexpected argument: %s", argv
[optind
]);
541 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
542 options
, img_size
, flags
, quiet
, &local_err
);
544 error_reportf_err(local_err
, "%s: ", filename
);
556 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
560 Visitor
*v
= qobject_output_visitor_new(&obj
);
562 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
563 visit_complete(v
, &obj
);
564 str
= qobject_to_json_pretty(obj
);
566 qprintf(quiet
, "%s\n", qstring_get_str(str
));
572 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
574 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
575 qprintf(quiet
, "No errors were found on the image.\n");
577 if (check
->corruptions
) {
578 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
579 "Data may be corrupted, or further writes to the image "
586 "\n%" PRId64
" leaked clusters were found on the image.\n"
587 "This means waste of disk space, but no harm to data.\n",
591 if (check
->check_errors
) {
594 " internal errors have occurred during the check.\n",
595 check
->check_errors
);
599 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
600 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
601 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
602 check
->allocated_clusters
, check
->total_clusters
,
603 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
604 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
605 check
->compressed_clusters
* 100.0 /
606 check
->allocated_clusters
);
609 if (check
->image_end_offset
) {
611 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
615 static int collect_image_check(BlockDriverState
*bs
,
617 const char *filename
,
622 BdrvCheckResult result
;
624 ret
= bdrv_check(bs
, &result
, fix
);
629 check
->filename
= g_strdup(filename
);
630 check
->format
= g_strdup(bdrv_get_format_name(bs
));
631 check
->check_errors
= result
.check_errors
;
632 check
->corruptions
= result
.corruptions
;
633 check
->has_corruptions
= result
.corruptions
!= 0;
634 check
->leaks
= result
.leaks
;
635 check
->has_leaks
= result
.leaks
!= 0;
636 check
->corruptions_fixed
= result
.corruptions_fixed
;
637 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
638 check
->leaks_fixed
= result
.leaks_fixed
;
639 check
->has_leaks_fixed
= result
.leaks
!= 0;
640 check
->image_end_offset
= result
.image_end_offset
;
641 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
642 check
->total_clusters
= result
.bfi
.total_clusters
;
643 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
644 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
645 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
646 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
647 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
648 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
649 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
655 * Checks an image for consistency. Exit codes:
657 * 0 - Check completed, image is good
658 * 1 - Check not completed because of internal errors
659 * 2 - Check completed, image is corrupted
660 * 3 - Check completed, image has leaked clusters, but is good otherwise
661 * 63 - Checks are not supported by the image format
663 static int img_check(int argc
, char **argv
)
666 OutputFormat output_format
= OFORMAT_HUMAN
;
667 const char *filename
, *fmt
, *output
, *cache
;
669 BlockDriverState
*bs
;
671 int flags
= BDRV_O_CHECK
;
675 bool image_opts
= false;
676 bool force_share
= false;
680 cache
= BDRV_DEFAULT_CACHE
;
683 int option_index
= 0;
684 static const struct option long_options
[] = {
685 {"help", no_argument
, 0, 'h'},
686 {"format", required_argument
, 0, 'f'},
687 {"repair", required_argument
, 0, 'r'},
688 {"output", required_argument
, 0, OPTION_OUTPUT
},
689 {"object", required_argument
, 0, OPTION_OBJECT
},
690 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
691 {"force-share", no_argument
, 0, 'U'},
694 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
695 long_options
, &option_index
);
701 missing_argument(argv
[optind
- 1]);
704 unrecognized_option(argv
[optind
- 1]);
713 flags
|= BDRV_O_RDWR
;
715 if (!strcmp(optarg
, "leaks")) {
716 fix
= BDRV_FIX_LEAKS
;
717 } else if (!strcmp(optarg
, "all")) {
718 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
720 error_exit("Unknown option value for -r "
721 "(expecting 'leaks' or 'all'): %s", optarg
);
736 case OPTION_OBJECT
: {
738 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
744 case OPTION_IMAGE_OPTS
:
749 if (optind
!= argc
- 1) {
750 error_exit("Expecting one image file name");
752 filename
= argv
[optind
++];
754 if (output
&& !strcmp(output
, "json")) {
755 output_format
= OFORMAT_JSON
;
756 } else if (output
&& !strcmp(output
, "human")) {
757 output_format
= OFORMAT_HUMAN
;
759 error_report("--output must be used with human or json as argument.");
763 if (qemu_opts_foreach(&qemu_object_opts
,
764 user_creatable_add_opts_foreach
,
765 NULL
, &error_fatal
)) {
769 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
771 error_report("Invalid source cache option: %s", cache
);
775 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
782 check
= g_new0(ImageCheck
, 1);
783 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
785 if (ret
== -ENOTSUP
) {
786 error_report("This image format does not support checks");
791 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
792 int corruptions_fixed
, leaks_fixed
;
794 leaks_fixed
= check
->leaks_fixed
;
795 corruptions_fixed
= check
->corruptions_fixed
;
797 if (output_format
== OFORMAT_HUMAN
) {
799 "The following inconsistencies were found and repaired:\n\n"
800 " %" PRId64
" leaked clusters\n"
801 " %" PRId64
" corruptions\n\n"
802 "Double checking the fixed image now...\n",
804 check
->corruptions_fixed
);
807 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
809 check
->leaks_fixed
= leaks_fixed
;
810 check
->corruptions_fixed
= corruptions_fixed
;
814 switch (output_format
) {
816 dump_human_image_check(check
, quiet
);
819 dump_json_image_check(check
, quiet
);
824 if (ret
|| check
->check_errors
) {
826 error_report("Check failed: %s", strerror(-ret
));
828 error_report("Check failed");
834 if (check
->corruptions
) {
836 } else if (check
->leaks
) {
843 qapi_free_ImageCheck(check
);
848 typedef struct CommonBlockJobCBInfo
{
849 BlockDriverState
*bs
;
851 } CommonBlockJobCBInfo
;
853 static void common_block_job_cb(void *opaque
, int ret
)
855 CommonBlockJobCBInfo
*cbi
= opaque
;
858 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
862 static void run_block_job(BlockJob
*job
, Error
**errp
)
864 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
867 aio_context_acquire(aio_context
);
870 float progress
= 0.0f
;
871 aio_poll(aio_context
, true);
872 if (job
->job
.progress_total
) {
873 progress
= (float)job
->job
.progress_current
/
874 job
->job
.progress_total
* 100.f
;
876 qemu_progress_print(progress
, 0);
877 } while (!job_is_ready(&job
->job
) && !job_is_completed(&job
->job
));
879 if (!job_is_completed(&job
->job
)) {
880 ret
= job_complete_sync(&job
->job
, errp
);
884 job_unref(&job
->job
);
885 aio_context_release(aio_context
);
887 /* publish completion progress only when success */
889 qemu_progress_print(100.f
, 0);
893 static int img_commit(int argc
, char **argv
)
896 const char *filename
, *fmt
, *cache
, *base
;
898 BlockDriverState
*bs
, *base_bs
;
900 bool progress
= false, quiet
= false, drop
= false;
902 Error
*local_err
= NULL
;
903 CommonBlockJobCBInfo cbi
;
904 bool image_opts
= false;
905 AioContext
*aio_context
;
908 cache
= BDRV_DEFAULT_CACHE
;
911 static const struct option long_options
[] = {
912 {"help", no_argument
, 0, 'h'},
913 {"object", required_argument
, 0, OPTION_OBJECT
},
914 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
917 c
= getopt_long(argc
, argv
, ":f:ht:b:dpq",
924 missing_argument(argv
[optind
- 1]);
927 unrecognized_option(argv
[optind
- 1]);
952 case OPTION_OBJECT
: {
954 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
960 case OPTION_IMAGE_OPTS
:
966 /* Progress is not shown in Quiet mode */
971 if (optind
!= argc
- 1) {
972 error_exit("Expecting one image file name");
974 filename
= argv
[optind
++];
976 if (qemu_opts_foreach(&qemu_object_opts
,
977 user_creatable_add_opts_foreach
,
978 NULL
, &error_fatal
)) {
982 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
983 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
985 error_report("Invalid cache option: %s", cache
);
989 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
996 qemu_progress_init(progress
, 1.f
);
997 qemu_progress_print(0.f
, 100);
1000 base_bs
= bdrv_find_backing_image(bs
, base
);
1002 error_setg(&local_err
,
1003 "Did not find '%s' in the backing chain of '%s'",
1008 /* This is different from QMP, which by default uses the deepest file in
1009 * the backing chain (i.e., the very base); however, the traditional
1010 * behavior of qemu-img commit is using the immediate backing file. */
1011 base_bs
= backing_bs(bs
);
1013 error_setg(&local_err
, "Image does not have a backing file");
1018 cbi
= (CommonBlockJobCBInfo
){
1023 aio_context
= bdrv_get_aio_context(bs
);
1024 aio_context_acquire(aio_context
);
1025 commit_active_start("commit", bs
, base_bs
, JOB_DEFAULT
, 0,
1026 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1027 &cbi
, false, &local_err
);
1028 aio_context_release(aio_context
);
1033 /* When the block job completes, the BlockBackend reference will point to
1034 * the old backing file. In order to avoid that the top image is already
1035 * deleted, so we can still empty it afterwards, increment the reference
1036 * counter here preemptively. */
1041 job
= block_job_get("commit");
1043 run_block_job(job
, &local_err
);
1048 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
1049 ret
= bs
->drv
->bdrv_make_empty(bs
);
1051 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
1063 qemu_progress_end();
1068 error_report_err(local_err
);
1072 qprintf(quiet
, "Image committed.\n");
1077 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1078 * of the first sector boundary within buf where the sector contains a
1079 * non-zero byte. This function is robust to a buffer that is not
1082 static int64_t find_nonzero(const uint8_t *buf
, int64_t n
)
1085 int64_t end
= QEMU_ALIGN_DOWN(n
, BDRV_SECTOR_SIZE
);
1087 for (i
= 0; i
< end
; i
+= BDRV_SECTOR_SIZE
) {
1088 if (!buffer_is_zero(buf
+ i
, BDRV_SECTOR_SIZE
)) {
1092 if (i
< n
&& !buffer_is_zero(buf
+ i
, n
- end
)) {
1099 * Returns true iff the first sector pointed to by 'buf' contains at least
1102 * 'pnum' is set to the number of sectors (including and immediately following
1103 * the first one) that are known to be in the same allocated/unallocated state.
1104 * The function will try to align the end offset to alignment boundaries so
1105 * that the request will at least end aligned and consequtive requests will
1106 * also start at an aligned offset.
1108 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
,
1109 int64_t sector_num
, int alignment
)
1118 is_zero
= buffer_is_zero(buf
, 512);
1119 for(i
= 1; i
< n
; i
++) {
1121 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1126 tail
= (sector_num
+ i
) & (alignment
- 1);
1128 if (is_zero
&& i
<= tail
) {
1129 /* treat unallocated areas which only consist
1130 * of a small tail as allocated. */
1134 /* align up end offset of allocated areas. */
1135 i
+= alignment
- tail
;
1138 /* align down end offset of zero areas. */
1147 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1148 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1149 * breaking up write requests for only small sparse areas.
1151 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1152 int min
, int64_t sector_num
, int alignment
)
1155 int num_checked
, num_used
;
1161 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1167 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1169 sector_num
+= *pnum
;
1170 num_checked
= num_used
;
1173 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1175 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1177 sector_num
+= *pnum
;
1178 num_checked
+= *pnum
;
1180 num_used
= num_checked
;
1181 } else if (*pnum
>= min
) {
1191 * Compares two buffers sector by sector. Returns 0 if the first
1192 * sector of each buffer matches, non-zero otherwise.
1194 * pnum is set to the sector-aligned size of the buffer prefix that
1195 * has the same matching status as the first sector.
1197 static int compare_buffers(const uint8_t *buf1
, const uint8_t *buf2
,
1198 int64_t bytes
, int64_t *pnum
)
1201 int64_t i
= MIN(bytes
, BDRV_SECTOR_SIZE
);
1205 res
= !!memcmp(buf1
, buf2
, i
);
1207 int64_t len
= MIN(bytes
- i
, BDRV_SECTOR_SIZE
);
1209 if (!!memcmp(buf1
+ i
, buf2
+ i
, len
) != res
) {
1219 #define IO_BUF_SIZE (2 * 1024 * 1024)
1222 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1224 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1225 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1226 * failure), and 4 on error (the exit status for read errors), after emitting
1229 * @param blk: BlockBackend for the image
1230 * @param offset: Starting offset to check
1231 * @param bytes: Number of bytes to check
1232 * @param filename: Name of disk file we are checking (logging purpose)
1233 * @param buffer: Allocated buffer for storing read data
1234 * @param quiet: Flag for quiet mode
1236 static int check_empty_sectors(BlockBackend
*blk
, int64_t offset
,
1237 int64_t bytes
, const char *filename
,
1238 uint8_t *buffer
, bool quiet
)
1243 ret
= blk_pread(blk
, offset
, buffer
, bytes
);
1245 error_report("Error while reading offset %" PRId64
" of %s: %s",
1246 offset
, filename
, strerror(-ret
));
1249 idx
= find_nonzero(buffer
, bytes
);
1251 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1260 * Compares two images. Exit codes:
1262 * 0 - Images are identical
1264 * >1 - Error occurred
1266 static int img_compare(int argc
, char **argv
)
1268 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1269 BlockBackend
*blk1
, *blk2
;
1270 BlockDriverState
*bs1
, *bs2
;
1271 int64_t total_size1
, total_size2
;
1272 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1273 int64_t pnum1
, pnum2
;
1274 int allocated1
, allocated2
;
1275 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1276 bool progress
= false, quiet
= false, strict
= false;
1283 uint64_t progress_base
;
1284 bool image_opts
= false;
1285 bool force_share
= false;
1287 cache
= BDRV_DEFAULT_CACHE
;
1289 static const struct option long_options
[] = {
1290 {"help", no_argument
, 0, 'h'},
1291 {"object", required_argument
, 0, OPTION_OBJECT
},
1292 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1293 {"force-share", no_argument
, 0, 'U'},
1296 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1297 long_options
, NULL
);
1303 missing_argument(argv
[optind
- 1]);
1306 unrecognized_option(argv
[optind
- 1]);
1332 case OPTION_OBJECT
: {
1334 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1341 case OPTION_IMAGE_OPTS
:
1347 /* Progress is not shown in Quiet mode */
1353 if (optind
!= argc
- 2) {
1354 error_exit("Expecting two image file names");
1356 filename1
= argv
[optind
++];
1357 filename2
= argv
[optind
++];
1359 if (qemu_opts_foreach(&qemu_object_opts
,
1360 user_creatable_add_opts_foreach
,
1361 NULL
, &error_fatal
)) {
1366 /* Initialize before goto out */
1367 qemu_progress_init(progress
, 2.0);
1370 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1372 error_report("Invalid source cache option: %s", cache
);
1377 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1384 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1393 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1394 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1395 total_size1
= blk_getlength(blk1
);
1396 if (total_size1
< 0) {
1397 error_report("Can't get size of %s: %s",
1398 filename1
, strerror(-total_size1
));
1402 total_size2
= blk_getlength(blk2
);
1403 if (total_size2
< 0) {
1404 error_report("Can't get size of %s: %s",
1405 filename2
, strerror(-total_size2
));
1409 total_size
= MIN(total_size1
, total_size2
);
1410 progress_base
= MAX(total_size1
, total_size2
);
1412 qemu_progress_print(0, 100);
1414 if (strict
&& total_size1
!= total_size2
) {
1416 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1420 while (offset
< total_size
) {
1421 int status1
, status2
;
1423 status1
= bdrv_block_status_above(bs1
, NULL
, offset
,
1424 total_size1
- offset
, &pnum1
, NULL
,
1428 error_report("Sector allocation test failed for %s", filename1
);
1431 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1433 status2
= bdrv_block_status_above(bs2
, NULL
, offset
,
1434 total_size2
- offset
, &pnum2
, NULL
,
1438 error_report("Sector allocation test failed for %s", filename2
);
1441 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1443 assert(pnum1
&& pnum2
);
1444 chunk
= MIN(pnum1
, pnum2
);
1447 if (status1
!= status2
) {
1449 qprintf(quiet
, "Strict mode: Offset %" PRId64
1450 " block status mismatch!\n", offset
);
1454 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1456 } else if (allocated1
== allocated2
) {
1460 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1461 ret
= blk_pread(blk1
, offset
, buf1
, chunk
);
1463 error_report("Error while reading offset %" PRId64
1465 offset
, filename1
, strerror(-ret
));
1469 ret
= blk_pread(blk2
, offset
, buf2
, chunk
);
1471 error_report("Error while reading offset %" PRId64
1473 offset
, filename2
, strerror(-ret
));
1477 ret
= compare_buffers(buf1
, buf2
, chunk
, &pnum
);
1478 if (ret
|| pnum
!= chunk
) {
1479 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1480 offset
+ (ret
? 0 : pnum
));
1486 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1488 ret
= check_empty_sectors(blk1
, offset
, chunk
,
1489 filename1
, buf1
, quiet
);
1491 ret
= check_empty_sectors(blk2
, offset
, chunk
,
1492 filename2
, buf1
, quiet
);
1499 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1502 if (total_size1
!= total_size2
) {
1503 BlockBackend
*blk_over
;
1504 const char *filename_over
;
1506 qprintf(quiet
, "Warning: Image size mismatch!\n");
1507 if (total_size1
> total_size2
) {
1509 filename_over
= filename1
;
1512 filename_over
= filename2
;
1515 while (offset
< progress_base
) {
1516 ret
= bdrv_block_status_above(blk_bs(blk_over
), NULL
, offset
,
1517 progress_base
- offset
, &chunk
,
1521 error_report("Sector allocation test failed for %s",
1526 if (ret
& BDRV_BLOCK_ALLOCATED
&& !(ret
& BDRV_BLOCK_ZERO
)) {
1527 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1528 ret
= check_empty_sectors(blk_over
, offset
, chunk
,
1529 filename_over
, buf1
, quiet
);
1535 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1539 qprintf(quiet
, "Images are identical.\n");
1549 qemu_progress_end();
1554 enum ImgConvertBlockStatus
{
1560 #define MAX_COROUTINES 16
1562 typedef struct ImgConvertState
{
1564 int64_t *src_sectors
;
1566 int64_t total_sectors
;
1567 int64_t allocated_sectors
;
1568 int64_t allocated_done
;
1571 enum ImgConvertBlockStatus status
;
1572 int64_t sector_next_status
;
1573 BlockBackend
*target
;
1576 bool unallocated_blocks_are_zero
;
1577 bool target_has_backing
;
1578 int64_t target_backing_sectors
; /* negative if unknown */
1583 size_t cluster_sectors
;
1585 long num_coroutines
;
1586 int running_coroutines
;
1587 Coroutine
*co
[MAX_COROUTINES
];
1588 int64_t wait_sector_num
[MAX_COROUTINES
];
1593 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1594 int *src_cur
, int64_t *src_cur_offset
)
1597 *src_cur_offset
= 0;
1598 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1599 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1601 assert(*src_cur
< s
->src_num
);
1605 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1607 int64_t src_cur_offset
;
1608 int ret
, n
, src_cur
;
1609 bool post_backing_zero
= false;
1611 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1613 assert(s
->total_sectors
> sector_num
);
1614 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1616 if (s
->target_backing_sectors
>= 0) {
1617 if (sector_num
>= s
->target_backing_sectors
) {
1618 post_backing_zero
= s
->unallocated_blocks_are_zero
;
1619 } else if (sector_num
+ n
> s
->target_backing_sectors
) {
1620 /* Split requests around target_backing_sectors (because
1621 * starting from there, zeros are handled differently) */
1622 n
= s
->target_backing_sectors
- sector_num
;
1626 if (s
->sector_next_status
<= sector_num
) {
1627 int64_t count
= n
* BDRV_SECTOR_SIZE
;
1629 if (s
->target_has_backing
) {
1631 ret
= bdrv_block_status(blk_bs(s
->src
[src_cur
]),
1632 (sector_num
- src_cur_offset
) *
1634 count
, &count
, NULL
, NULL
);
1636 ret
= bdrv_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1637 (sector_num
- src_cur_offset
) *
1639 count
, &count
, NULL
, NULL
);
1642 error_report("error while reading block status of sector %" PRId64
1643 ": %s", sector_num
, strerror(-ret
));
1646 n
= DIV_ROUND_UP(count
, BDRV_SECTOR_SIZE
);
1648 if (ret
& BDRV_BLOCK_ZERO
) {
1649 s
->status
= post_backing_zero
? BLK_BACKING_FILE
: BLK_ZERO
;
1650 } else if (ret
& BDRV_BLOCK_DATA
) {
1651 s
->status
= BLK_DATA
;
1653 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1656 s
->sector_next_status
= sector_num
+ n
;
1659 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1660 if (s
->status
== BLK_DATA
) {
1661 n
= MIN(n
, s
->buf_sectors
);
1664 /* We need to write complete clusters for compressed images, so if an
1665 * unallocated area is shorter than that, we must consider the whole
1666 * cluster allocated. */
1667 if (s
->compressed
) {
1668 if (n
< s
->cluster_sectors
) {
1669 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1670 s
->status
= BLK_DATA
;
1672 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1679 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1680 int nb_sectors
, uint8_t *buf
)
1685 assert(nb_sectors
<= s
->buf_sectors
);
1686 while (nb_sectors
> 0) {
1689 int64_t bs_sectors
, src_cur_offset
;
1691 /* In the case of compression with multiple source files, we can get a
1692 * nb_sectors that spreads into the next part. So we must be able to
1693 * read across multiple BDSes for one convert_read() call. */
1694 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1695 blk
= s
->src
[src_cur
];
1696 bs_sectors
= s
->src_sectors
[src_cur
];
1698 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1699 qemu_iovec_init_buf(&qiov
, buf
, n
<< BDRV_SECTOR_BITS
);
1701 ret
= blk_co_preadv(
1702 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1703 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1710 buf
+= n
* BDRV_SECTOR_SIZE
;
1717 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1718 int nb_sectors
, uint8_t *buf
,
1719 enum ImgConvertBlockStatus status
)
1724 while (nb_sectors
> 0) {
1726 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1729 case BLK_BACKING_FILE
:
1730 /* If we have a backing file, leave clusters unallocated that are
1731 * unallocated in the source image, so that the backing file is
1732 * visible at the respective offset. */
1733 assert(s
->target_has_backing
);
1737 /* If we're told to keep the target fully allocated (-S 0) or there
1738 * is real non-zero data, we must write it. Otherwise we can treat
1739 * it as zero sectors.
1740 * Compressed clusters need to be written as a whole, so in that
1741 * case we can only save the write if the buffer is completely
1743 if (!s
->min_sparse
||
1745 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
,
1746 sector_num
, s
->alignment
)) ||
1748 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1750 qemu_iovec_init_buf(&qiov
, buf
, n
<< BDRV_SECTOR_BITS
);
1752 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1753 n
<< BDRV_SECTOR_BITS
, &qiov
, flags
);
1762 if (s
->has_zero_init
) {
1763 assert(!s
->target_has_backing
);
1766 ret
= blk_co_pwrite_zeroes(s
->target
,
1767 sector_num
<< BDRV_SECTOR_BITS
,
1768 n
<< BDRV_SECTOR_BITS
,
1769 BDRV_REQ_MAY_UNMAP
);
1778 buf
+= n
* BDRV_SECTOR_SIZE
;
1784 static int coroutine_fn
convert_co_copy_range(ImgConvertState
*s
, int64_t sector_num
,
1789 while (nb_sectors
> 0) {
1792 int64_t bs_sectors
, src_cur_offset
;
1795 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1796 offset
= (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
;
1797 blk
= s
->src
[src_cur
];
1798 bs_sectors
= s
->src_sectors
[src_cur
];
1800 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1802 ret
= blk_co_copy_range(blk
, offset
, s
->target
,
1803 sector_num
<< BDRV_SECTOR_BITS
,
1804 n
<< BDRV_SECTOR_BITS
, 0, 0);
1815 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1817 ImgConvertState
*s
= opaque
;
1818 uint8_t *buf
= NULL
;
1822 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1823 if (s
->co
[i
] == qemu_coroutine_self()) {
1830 s
->running_coroutines
++;
1831 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1836 enum ImgConvertBlockStatus status
;
1839 qemu_co_mutex_lock(&s
->lock
);
1840 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1841 qemu_co_mutex_unlock(&s
->lock
);
1844 n
= convert_iteration_sectors(s
, s
->sector_num
);
1846 qemu_co_mutex_unlock(&s
->lock
);
1850 /* save current sector and allocation status to local variables */
1851 sector_num
= s
->sector_num
;
1853 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1854 n
= MIN(n
, s
->buf_sectors
);
1856 /* increment global sector counter so that other coroutines can
1857 * already continue reading beyond this request */
1859 qemu_co_mutex_unlock(&s
->lock
);
1861 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1862 s
->allocated_done
+= n
;
1863 qemu_progress_print(100.0 * s
->allocated_done
/
1864 s
->allocated_sectors
, 0);
1868 copy_range
= s
->copy_range
&& s
->status
== BLK_DATA
;
1869 if (status
== BLK_DATA
&& !copy_range
) {
1870 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1872 error_report("error while reading sector %" PRId64
1873 ": %s", sector_num
, strerror(-ret
));
1876 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1878 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1881 if (s
->wr_in_order
) {
1882 /* keep writes in order */
1883 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
1884 s
->wait_sector_num
[index
] = sector_num
;
1885 qemu_coroutine_yield();
1887 s
->wait_sector_num
[index
] = -1;
1890 if (s
->ret
== -EINPROGRESS
) {
1892 ret
= convert_co_copy_range(s
, sector_num
, n
);
1894 s
->copy_range
= false;
1898 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1901 error_report("error while writing sector %" PRId64
1902 ": %s", sector_num
, strerror(-ret
));
1907 if (s
->wr_in_order
) {
1908 /* reenter the coroutine that might have waited
1909 * for this write to complete */
1910 s
->wr_offs
= sector_num
+ n
;
1911 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1912 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1914 * A -> B -> A cannot occur because A has
1915 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1916 * B will never enter A during this time window.
1918 qemu_coroutine_enter(s
->co
[i
]);
1926 s
->co
[index
] = NULL
;
1927 s
->running_coroutines
--;
1928 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1929 /* the convert job finished successfully */
1934 static int convert_do_copy(ImgConvertState
*s
)
1937 int64_t sector_num
= 0;
1939 /* Check whether we have zero initialisation or can get it efficiently */
1940 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1941 ? bdrv_has_zero_init(blk_bs(s
->target
))
1944 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1945 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1947 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
| BDRV_REQ_NO_FALLBACK
);
1949 s
->has_zero_init
= true;
1953 /* Allocate buffer for copied data. For compressed images, only one cluster
1954 * can be copied at a time. */
1955 if (s
->compressed
) {
1956 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1957 error_report("invalid cluster size");
1960 s
->buf_sectors
= s
->cluster_sectors
;
1963 while (sector_num
< s
->total_sectors
) {
1964 n
= convert_iteration_sectors(s
, sector_num
);
1968 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1970 s
->allocated_sectors
+= n
;
1976 s
->sector_next_status
= 0;
1977 s
->ret
= -EINPROGRESS
;
1979 qemu_co_mutex_init(&s
->lock
);
1980 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1981 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1982 s
->wait_sector_num
[i
] = -1;
1983 qemu_coroutine_enter(s
->co
[i
]);
1986 while (s
->running_coroutines
) {
1987 main_loop_wait(false);
1990 if (s
->compressed
&& !s
->ret
) {
1991 /* signal EOF to align */
1992 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
2001 #define MAX_BUF_SECTORS 32768
2003 static int img_convert(int argc
, char **argv
)
2005 int c
, bs_i
, flags
, src_flags
= 0;
2006 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
2007 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
2008 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
2009 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
2010 BlockDriverInfo bdi
;
2011 BlockDriverState
*out_bs
;
2012 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
2013 QemuOptsList
*create_opts
= NULL
;
2014 QDict
*open_opts
= NULL
;
2015 char *options
= NULL
;
2016 Error
*local_err
= NULL
;
2017 bool writethrough
, src_writethrough
, quiet
= false, image_opts
= false,
2018 skip_create
= false, progress
= false, tgt_image_opts
= false;
2019 int64_t ret
= -EINVAL
;
2020 bool force_share
= false;
2021 bool explict_min_sparse
= false;
2023 ImgConvertState s
= (ImgConvertState
) {
2024 /* Need at least 4k of zeros for sparse detection */
2026 .copy_range
= false,
2027 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
2028 .wr_in_order
= true,
2029 .num_coroutines
= 8,
2033 static const struct option long_options
[] = {
2034 {"help", no_argument
, 0, 'h'},
2035 {"object", required_argument
, 0, OPTION_OBJECT
},
2036 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2037 {"force-share", no_argument
, 0, 'U'},
2038 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
2041 c
= getopt_long(argc
, argv
, ":hf:O:B:Cco:l:S:pt:T:qnm:WU",
2042 long_options
, NULL
);
2048 missing_argument(argv
[optind
- 1]);
2051 unrecognized_option(argv
[optind
- 1]);
2063 out_baseimg
= optarg
;
2066 s
.copy_range
= true;
2069 s
.compressed
= true;
2072 if (!is_valid_option_list(optarg
)) {
2073 error_report("Invalid option list: %s", optarg
);
2077 options
= g_strdup(optarg
);
2079 char *old_options
= options
;
2080 options
= g_strdup_printf("%s,%s", options
, optarg
);
2081 g_free(old_options
);
2085 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2086 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2089 error_report("Failed in parsing snapshot param '%s'",
2094 snapshot_name
= optarg
;
2101 sval
= cvtnum(optarg
);
2102 if (sval
< 0 || sval
& (BDRV_SECTOR_SIZE
- 1) ||
2103 sval
/ BDRV_SECTOR_SIZE
> MAX_BUF_SECTORS
) {
2104 error_report("Invalid buffer size for sparse output specified. "
2105 "Valid sizes are multiples of %llu up to %llu. Select "
2106 "0 to disable sparse detection (fully allocates output).",
2107 BDRV_SECTOR_SIZE
, MAX_BUF_SECTORS
* BDRV_SECTOR_SIZE
);
2111 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2112 explict_min_sparse
= true;
2131 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2132 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2133 error_report("Invalid number of coroutines. Allowed number of"
2134 " coroutines is between 1 and %d", MAX_COROUTINES
);
2139 s
.wr_in_order
= false;
2144 case OPTION_OBJECT
: {
2145 QemuOpts
*object_opts
;
2146 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2153 case OPTION_IMAGE_OPTS
:
2156 case OPTION_TARGET_IMAGE_OPTS
:
2157 tgt_image_opts
= true;
2162 if (!out_fmt
&& !tgt_image_opts
) {
2166 if (qemu_opts_foreach(&qemu_object_opts
,
2167 user_creatable_add_opts_foreach
,
2168 NULL
, &error_fatal
)) {
2172 if (s
.compressed
&& s
.copy_range
) {
2173 error_report("Cannot enable copy offloading when -c is used");
2177 if (explict_min_sparse
&& s
.copy_range
) {
2178 error_report("Cannot enable copy offloading when -S is used");
2182 if (tgt_image_opts
&& !skip_create
) {
2183 error_report("--target-image-opts requires use of -n flag");
2187 s
.src_num
= argc
- optind
- 1;
2188 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2190 if (options
&& has_help_option(options
)) {
2192 ret
= print_block_option_help(out_filename
, out_fmt
);
2195 error_report("Option help requires a format be specified");
2200 if (s
.src_num
< 1) {
2201 error_report("Must specify image file name");
2206 /* ret is still -EINVAL until here */
2207 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2209 error_report("Invalid source cache option: %s", src_cache
);
2213 /* Initialize before goto out */
2217 qemu_progress_init(progress
, 1.0);
2218 qemu_progress_print(0, 100);
2220 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2221 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2223 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2224 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2225 fmt
, src_flags
, src_writethrough
, quiet
,
2231 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2232 if (s
.src_sectors
[bs_i
] < 0) {
2233 error_report("Could not get size of %s: %s",
2234 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2238 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2242 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2243 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2244 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2246 } else if (snapshot_name
!= NULL
) {
2247 if (s
.src_num
> 1) {
2248 error_report("No support for concatenating multiple snapshot");
2253 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2257 error_reportf_err(local_err
, "Failed to load snapshot: ");
2263 /* Find driver and parse its options */
2264 drv
= bdrv_find_format(out_fmt
);
2266 error_report("Unknown file format '%s'", out_fmt
);
2271 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2273 error_report_err(local_err
);
2278 if (!drv
->create_opts
) {
2279 error_report("Format driver '%s' does not support image creation",
2285 if (!proto_drv
->create_opts
) {
2286 error_report("Protocol driver '%s' does not support image creation",
2287 proto_drv
->format_name
);
2292 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2293 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2295 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2297 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2299 error_report_err(local_err
);
2305 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, s
.total_sectors
* 512,
2307 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2313 /* Get backing file name if -o backing_file was used */
2314 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2315 if (out_baseimg_param
) {
2316 out_baseimg
= out_baseimg_param
;
2318 s
.target_has_backing
= (bool) out_baseimg
;
2320 if (s
.src_num
> 1 && out_baseimg
) {
2321 error_report("Having a backing file for the target makes no sense when "
2322 "concatenating multiple input images");
2327 /* Check if compression is supported */
2330 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2331 const char *encryptfmt
=
2332 qemu_opt_get(opts
, BLOCK_OPT_ENCRYPT_FORMAT
);
2333 const char *preallocation
=
2334 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2336 if (drv
&& !drv
->bdrv_co_pwritev_compressed
) {
2337 error_report("Compression not supported for this file format");
2342 if (encryption
|| encryptfmt
) {
2343 error_report("Compression and encryption not supported at "
2350 && strcmp(preallocation
, "off"))
2352 error_report("Compression and preallocation not supported at "
2360 * The later open call will need any decryption secrets, and
2361 * bdrv_create() will purge "opts", so extract them now before
2365 open_opts
= qdict_new();
2366 qemu_opt_foreach(opts
, img_add_key_secrets
, open_opts
, &error_abort
);
2370 /* Create the new image */
2371 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2373 error_reportf_err(local_err
, "%s: error while converting %s: ",
2374 out_filename
, out_fmt
);
2379 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2380 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2382 error_report("Invalid cache option: %s", cache
);
2387 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2388 flags
, writethrough
, quiet
, false);
2390 /* TODO ultimately we should allow --target-image-opts
2391 * to be used even when -n is not given.
2392 * That has to wait for bdrv_create to be improved
2393 * to allow filenames in option syntax
2395 s
.target
= img_open_file(out_filename
, open_opts
, out_fmt
,
2396 flags
, writethrough
, quiet
, false);
2397 open_opts
= NULL
; /* blk_new_open will have freed it */
2403 out_bs
= blk_bs(s
.target
);
2405 if (s
.compressed
&& !out_bs
->drv
->bdrv_co_pwritev_compressed
) {
2406 error_report("Compression not supported for this file format");
2411 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2412 * or discard_alignment of the out_bs is greater. Limit to
2413 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2414 s
.buf_sectors
= MIN(MAX_BUF_SECTORS
,
2416 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2417 out_bs
->bl
.pdiscard_alignment
>>
2418 BDRV_SECTOR_BITS
)));
2420 /* try to align the write requests to the destination to avoid unnecessary
2422 s
.alignment
= MAX(pow2floor(s
.min_sparse
),
2423 DIV_ROUND_UP(out_bs
->bl
.request_alignment
,
2425 assert(is_power_of_2(s
.alignment
));
2428 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2429 if (output_sectors
< 0) {
2430 error_report("unable to get output image length: %s",
2431 strerror(-output_sectors
));
2434 } else if (output_sectors
< s
.total_sectors
) {
2435 error_report("output file is smaller than input file");
2441 if (s
.target_has_backing
) {
2442 /* Errors are treated as "backing length unknown" (which means
2443 * s.target_backing_sectors has to be negative, which it will
2444 * be automatically). The backing file length is used only
2445 * for optimizations, so such a case is not fatal. */
2446 s
.target_backing_sectors
= bdrv_nb_sectors(out_bs
->backing
->bs
);
2448 s
.target_backing_sectors
= -1;
2451 ret
= bdrv_get_info(out_bs
, &bdi
);
2454 error_report("could not get block driver info");
2458 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2459 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2460 s
.unallocated_blocks_are_zero
= bdi
.unallocated_blocks_are_zero
;
2463 ret
= convert_do_copy(&s
);
2466 qemu_progress_print(100, 0);
2468 qemu_progress_end();
2469 qemu_opts_del(opts
);
2470 qemu_opts_free(create_opts
);
2471 qemu_opts_del(sn_opts
);
2472 qobject_unref(open_opts
);
2473 blk_unref(s
.target
);
2475 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2476 blk_unref(s
.src
[bs_i
]);
2480 g_free(s
.src_sectors
);
2488 static void dump_snapshots(BlockDriverState
*bs
)
2490 QEMUSnapshotInfo
*sn_tab
, *sn
;
2493 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2496 printf("Snapshot list:\n");
2497 bdrv_snapshot_dump(NULL
);
2499 for(i
= 0; i
< nb_sns
; i
++) {
2501 bdrv_snapshot_dump(sn
);
2507 static void dump_json_image_info_list(ImageInfoList
*list
)
2511 Visitor
*v
= qobject_output_visitor_new(&obj
);
2513 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2514 visit_complete(v
, &obj
);
2515 str
= qobject_to_json_pretty(obj
);
2516 assert(str
!= NULL
);
2517 printf("%s\n", qstring_get_str(str
));
2523 static void dump_json_image_info(ImageInfo
*info
)
2527 Visitor
*v
= qobject_output_visitor_new(&obj
);
2529 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2530 visit_complete(v
, &obj
);
2531 str
= qobject_to_json_pretty(obj
);
2532 assert(str
!= NULL
);
2533 printf("%s\n", qstring_get_str(str
));
2539 static void dump_human_image_info_list(ImageInfoList
*list
)
2541 ImageInfoList
*elem
;
2544 for (elem
= list
; elem
; elem
= elem
->next
) {
2550 bdrv_image_info_dump(elem
->value
);
2554 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2556 return strcmp(a
, b
) == 0;
2560 * Open an image file chain and return an ImageInfoList
2562 * @filename: topmost image filename
2563 * @fmt: topmost image format (may be NULL to autodetect)
2564 * @chain: true - enumerate entire backing file chain
2565 * false - only topmost image file
2567 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2568 * image file. If there was an error a message will have been printed to
2571 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2572 const char *filename
,
2574 bool chain
, bool force_share
)
2576 ImageInfoList
*head
= NULL
;
2577 ImageInfoList
**last
= &head
;
2578 GHashTable
*filenames
;
2581 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2585 BlockDriverState
*bs
;
2587 ImageInfoList
*elem
;
2589 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2590 error_report("Backing file '%s' creates an infinite loop.",
2594 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2596 blk
= img_open(image_opts
, filename
, fmt
,
2597 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2604 bdrv_query_image_info(bs
, &info
, &err
);
2606 error_report_err(err
);
2611 elem
= g_new0(ImageInfoList
, 1);
2618 filename
= fmt
= NULL
;
2620 if (info
->has_full_backing_filename
) {
2621 filename
= info
->full_backing_filename
;
2622 } else if (info
->has_backing_filename
) {
2623 error_report("Could not determine absolute backing filename,"
2624 " but backing filename '%s' present",
2625 info
->backing_filename
);
2628 if (info
->has_backing_filename_format
) {
2629 fmt
= info
->backing_filename_format
;
2633 g_hash_table_destroy(filenames
);
2637 qapi_free_ImageInfoList(head
);
2638 g_hash_table_destroy(filenames
);
2642 static int img_info(int argc
, char **argv
)
2645 OutputFormat output_format
= OFORMAT_HUMAN
;
2647 const char *filename
, *fmt
, *output
;
2648 ImageInfoList
*list
;
2649 bool image_opts
= false;
2650 bool force_share
= false;
2655 int option_index
= 0;
2656 static const struct option long_options
[] = {
2657 {"help", no_argument
, 0, 'h'},
2658 {"format", required_argument
, 0, 'f'},
2659 {"output", required_argument
, 0, OPTION_OUTPUT
},
2660 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2661 {"object", required_argument
, 0, OPTION_OBJECT
},
2662 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2663 {"force-share", no_argument
, 0, 'U'},
2666 c
= getopt_long(argc
, argv
, ":f:hU",
2667 long_options
, &option_index
);
2673 missing_argument(argv
[optind
- 1]);
2676 unrecognized_option(argv
[optind
- 1]);
2690 case OPTION_BACKING_CHAIN
:
2693 case OPTION_OBJECT
: {
2695 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2701 case OPTION_IMAGE_OPTS
:
2706 if (optind
!= argc
- 1) {
2707 error_exit("Expecting one image file name");
2709 filename
= argv
[optind
++];
2711 if (output
&& !strcmp(output
, "json")) {
2712 output_format
= OFORMAT_JSON
;
2713 } else if (output
&& !strcmp(output
, "human")) {
2714 output_format
= OFORMAT_HUMAN
;
2715 } else if (output
) {
2716 error_report("--output must be used with human or json as argument.");
2720 if (qemu_opts_foreach(&qemu_object_opts
,
2721 user_creatable_add_opts_foreach
,
2722 NULL
, &error_fatal
)) {
2726 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
2732 switch (output_format
) {
2734 dump_human_image_info_list(list
);
2738 dump_json_image_info_list(list
);
2740 dump_json_image_info(list
->value
);
2745 qapi_free_ImageInfoList(list
);
2749 static int dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2752 switch (output_format
) {
2754 if (e
->data
&& !e
->has_offset
) {
2755 error_report("File contains external, encrypted or compressed clusters.");
2758 if (e
->data
&& !e
->zero
) {
2759 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2760 e
->start
, e
->length
,
2761 e
->has_offset
? e
->offset
: 0,
2762 e
->has_filename
? e
->filename
: "");
2764 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2765 * Modify the flags here to allow more coalescing.
2767 if (next
&& (!next
->data
|| next
->zero
)) {
2773 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2774 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2775 (e
->start
== 0 ? "[" : ",\n"),
2776 e
->start
, e
->length
, e
->depth
,
2777 e
->zero
? "true" : "false",
2778 e
->data
? "true" : "false");
2779 if (e
->has_offset
) {
2780 printf(", \"offset\": %"PRId64
"", e
->offset
);
2792 static int get_block_status(BlockDriverState
*bs
, int64_t offset
,
2793 int64_t bytes
, MapEntry
*e
)
2797 BlockDriverState
*file
;
2800 char *filename
= NULL
;
2802 /* As an optimization, we could cache the current range of unallocated
2803 * clusters in each file of the chain, and avoid querying the same
2809 ret
= bdrv_block_status(bs
, offset
, bytes
, &bytes
, &map
, &file
);
2814 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2817 bs
= backing_bs(bs
);
2826 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2828 if (file
&& has_offset
) {
2829 bdrv_refresh_filename(file
);
2830 filename
= file
->filename
;
2836 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2837 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2839 .has_offset
= has_offset
,
2841 .has_filename
= filename
,
2842 .filename
= filename
,
2848 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2850 if (curr
->length
== 0) {
2853 if (curr
->zero
!= next
->zero
||
2854 curr
->data
!= next
->data
||
2855 curr
->depth
!= next
->depth
||
2856 curr
->has_filename
!= next
->has_filename
||
2857 curr
->has_offset
!= next
->has_offset
) {
2860 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2863 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2869 static int img_map(int argc
, char **argv
)
2872 OutputFormat output_format
= OFORMAT_HUMAN
;
2874 BlockDriverState
*bs
;
2875 const char *filename
, *fmt
, *output
;
2877 MapEntry curr
= { .length
= 0 }, next
;
2879 bool image_opts
= false;
2880 bool force_share
= false;
2885 int option_index
= 0;
2886 static const struct option long_options
[] = {
2887 {"help", no_argument
, 0, 'h'},
2888 {"format", required_argument
, 0, 'f'},
2889 {"output", required_argument
, 0, OPTION_OUTPUT
},
2890 {"object", required_argument
, 0, OPTION_OBJECT
},
2891 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2892 {"force-share", no_argument
, 0, 'U'},
2895 c
= getopt_long(argc
, argv
, ":f:hU",
2896 long_options
, &option_index
);
2902 missing_argument(argv
[optind
- 1]);
2905 unrecognized_option(argv
[optind
- 1]);
2919 case OPTION_OBJECT
: {
2921 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2927 case OPTION_IMAGE_OPTS
:
2932 if (optind
!= argc
- 1) {
2933 error_exit("Expecting one image file name");
2935 filename
= argv
[optind
];
2937 if (output
&& !strcmp(output
, "json")) {
2938 output_format
= OFORMAT_JSON
;
2939 } else if (output
&& !strcmp(output
, "human")) {
2940 output_format
= OFORMAT_HUMAN
;
2941 } else if (output
) {
2942 error_report("--output must be used with human or json as argument.");
2946 if (qemu_opts_foreach(&qemu_object_opts
,
2947 user_creatable_add_opts_foreach
,
2948 NULL
, &error_fatal
)) {
2952 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
2958 if (output_format
== OFORMAT_HUMAN
) {
2959 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2962 length
= blk_getlength(blk
);
2963 while (curr
.start
+ curr
.length
< length
) {
2964 int64_t offset
= curr
.start
+ curr
.length
;
2967 /* Probe up to 1 GiB at a time. */
2968 n
= MIN(1 << 30, length
- offset
);
2969 ret
= get_block_status(bs
, offset
, n
, &next
);
2972 error_report("Could not read file metadata: %s", strerror(-ret
));
2976 if (entry_mergeable(&curr
, &next
)) {
2977 curr
.length
+= next
.length
;
2981 if (curr
.length
> 0) {
2982 ret
= dump_map_entry(output_format
, &curr
, &next
);
2990 ret
= dump_map_entry(output_format
, &curr
, NULL
);
2997 #define SNAPSHOT_LIST 1
2998 #define SNAPSHOT_CREATE 2
2999 #define SNAPSHOT_APPLY 3
3000 #define SNAPSHOT_DELETE 4
3002 static int img_snapshot(int argc
, char **argv
)
3005 BlockDriverState
*bs
;
3006 QEMUSnapshotInfo sn
;
3007 char *filename
, *snapshot_name
= NULL
;
3008 int c
, ret
= 0, bdrv_oflags
;
3013 bool image_opts
= false;
3014 bool force_share
= false;
3016 bdrv_oflags
= BDRV_O_RDWR
;
3017 /* Parse commandline parameters */
3019 static const struct option long_options
[] = {
3020 {"help", no_argument
, 0, 'h'},
3021 {"object", required_argument
, 0, OPTION_OBJECT
},
3022 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3023 {"force-share", no_argument
, 0, 'U'},
3026 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
3027 long_options
, NULL
);
3033 missing_argument(argv
[optind
- 1]);
3036 unrecognized_option(argv
[optind
- 1]);
3043 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3046 action
= SNAPSHOT_LIST
;
3047 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
3051 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3054 action
= SNAPSHOT_APPLY
;
3055 snapshot_name
= optarg
;
3059 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3062 action
= SNAPSHOT_CREATE
;
3063 snapshot_name
= optarg
;
3067 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3070 action
= SNAPSHOT_DELETE
;
3071 snapshot_name
= optarg
;
3079 case OPTION_OBJECT
: {
3081 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3087 case OPTION_IMAGE_OPTS
:
3093 if (optind
!= argc
- 1) {
3094 error_exit("Expecting one image file name");
3096 filename
= argv
[optind
++];
3098 if (qemu_opts_foreach(&qemu_object_opts
,
3099 user_creatable_add_opts_foreach
,
3100 NULL
, &error_fatal
)) {
3104 /* Open the image */
3105 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
3112 /* Perform the requested action */
3118 case SNAPSHOT_CREATE
:
3119 memset(&sn
, 0, sizeof(sn
));
3120 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3122 qemu_gettimeofday(&tv
);
3123 sn
.date_sec
= tv
.tv_sec
;
3124 sn
.date_nsec
= tv
.tv_usec
* 1000;
3126 ret
= bdrv_snapshot_create(bs
, &sn
);
3128 error_report("Could not create snapshot '%s': %d (%s)",
3129 snapshot_name
, ret
, strerror(-ret
));
3133 case SNAPSHOT_APPLY
:
3134 ret
= bdrv_snapshot_goto(bs
, snapshot_name
, &err
);
3136 error_reportf_err(err
, "Could not apply snapshot '%s': ",
3141 case SNAPSHOT_DELETE
:
3142 ret
= bdrv_snapshot_find(bs
, &sn
, snapshot_name
);
3144 error_report("Could not delete snapshot '%s': snapshot not "
3145 "found", snapshot_name
);
3148 ret
= bdrv_snapshot_delete(bs
, sn
.id_str
, sn
.name
, &err
);
3150 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3166 static int img_rebase(int argc
, char **argv
)
3168 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3169 uint8_t *buf_old
= NULL
;
3170 uint8_t *buf_new
= NULL
;
3171 BlockDriverState
*bs
= NULL
;
3173 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3174 int c
, flags
, src_flags
, ret
;
3175 bool writethrough
, src_writethrough
;
3177 bool force_share
= false;
3180 Error
*local_err
= NULL
;
3181 bool image_opts
= false;
3183 /* Parse commandline parameters */
3185 cache
= BDRV_DEFAULT_CACHE
;
3186 src_cache
= BDRV_DEFAULT_CACHE
;
3190 static const struct option long_options
[] = {
3191 {"help", no_argument
, 0, 'h'},
3192 {"object", required_argument
, 0, OPTION_OBJECT
},
3193 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3194 {"force-share", no_argument
, 0, 'U'},
3197 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3198 long_options
, NULL
);
3204 missing_argument(argv
[optind
- 1]);
3207 unrecognized_option(argv
[optind
- 1]);
3216 out_basefmt
= optarg
;
3219 out_baseimg
= optarg
;
3236 case OPTION_OBJECT
: {
3238 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3244 case OPTION_IMAGE_OPTS
:
3257 if (optind
!= argc
- 1) {
3258 error_exit("Expecting one image file name");
3260 if (!unsafe
&& !out_baseimg
) {
3261 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3263 filename
= argv
[optind
++];
3265 if (qemu_opts_foreach(&qemu_object_opts
,
3266 user_creatable_add_opts_foreach
,
3267 NULL
, &error_fatal
)) {
3271 qemu_progress_init(progress
, 2.0);
3272 qemu_progress_print(0, 100);
3274 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3275 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3277 error_report("Invalid cache option: %s", cache
);
3282 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3284 error_report("Invalid source cache option: %s", src_cache
);
3288 /* The source files are opened read-only, don't care about WCE */
3289 assert((src_flags
& BDRV_O_RDWR
) == 0);
3290 (void) src_writethrough
;
3295 * Ignore the old backing file for unsafe rebase in case we want to correct
3296 * the reference to a renamed or moved backing file.
3298 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3306 if (out_basefmt
!= NULL
) {
3307 if (bdrv_find_format(out_basefmt
) == NULL
) {
3308 error_report("Invalid format name: '%s'", out_basefmt
);
3314 /* For safe rebasing we need to compare old and new backing file */
3316 char backing_name
[PATH_MAX
];
3317 QDict
*options
= NULL
;
3319 if (bs
->backing_format
[0] != '\0') {
3320 options
= qdict_new();
3321 qdict_put_str(options
, "driver", bs
->backing_format
);
3326 options
= qdict_new();
3328 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3330 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3331 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3332 options
, src_flags
, &local_err
);
3333 if (!blk_old_backing
) {
3334 error_reportf_err(local_err
,
3335 "Could not open old backing file '%s': ",
3341 if (out_baseimg
[0]) {
3342 const char *overlay_filename
;
3343 char *out_real_path
;
3345 options
= qdict_new();
3347 qdict_put_str(options
, "driver", out_basefmt
);
3350 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3353 bdrv_refresh_filename(bs
);
3354 overlay_filename
= bs
->exact_filename
[0] ? bs
->exact_filename
3357 bdrv_get_full_backing_filename_from_filename(overlay_filename
,
3361 error_reportf_err(local_err
,
3362 "Could not resolve backing filename: ");
3367 blk_new_backing
= blk_new_open(out_real_path
, NULL
,
3368 options
, src_flags
, &local_err
);
3369 g_free(out_real_path
);
3370 if (!blk_new_backing
) {
3371 error_reportf_err(local_err
,
3372 "Could not open new backing file '%s': ",
3381 * Check each unallocated cluster in the COW file. If it is unallocated,
3382 * accesses go to the backing file. We must therefore compare this cluster
3383 * in the old and new backing file, and if they differ we need to copy it
3384 * from the old backing file into the COW file.
3386 * If qemu-img crashes during this step, no harm is done. The content of
3387 * the image is the same as the original one at any time.
3391 int64_t old_backing_size
;
3392 int64_t new_backing_size
= 0;
3395 float local_progress
= 0;
3397 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3398 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3400 size
= blk_getlength(blk
);
3402 error_report("Could not get size of '%s': %s",
3403 filename
, strerror(-size
));
3407 old_backing_size
= blk_getlength(blk_old_backing
);
3408 if (old_backing_size
< 0) {
3409 char backing_name
[PATH_MAX
];
3411 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3412 error_report("Could not get size of '%s': %s",
3413 backing_name
, strerror(-old_backing_size
));
3417 if (blk_new_backing
) {
3418 new_backing_size
= blk_getlength(blk_new_backing
);
3419 if (new_backing_size
< 0) {
3420 error_report("Could not get size of '%s': %s",
3421 out_baseimg
, strerror(-new_backing_size
));
3428 local_progress
= (float)100 / (size
/ MIN(size
, IO_BUF_SIZE
));
3431 for (offset
= 0; offset
< size
; offset
+= n
) {
3432 /* How many bytes can we handle with the next read? */
3433 n
= MIN(IO_BUF_SIZE
, size
- offset
);
3435 /* If the cluster is allocated, we don't need to take action */
3436 ret
= bdrv_is_allocated(bs
, offset
, n
, &n
);
3438 error_report("error while reading image metadata: %s",
3447 * Read old and new backing file and take into consideration that
3448 * backing files may be smaller than the COW image.
3450 if (offset
>= old_backing_size
) {
3451 memset(buf_old
, 0, n
);
3453 if (offset
+ n
> old_backing_size
) {
3454 n
= old_backing_size
- offset
;
3457 ret
= blk_pread(blk_old_backing
, offset
, buf_old
, n
);
3459 error_report("error while reading from old backing file");
3464 if (offset
>= new_backing_size
|| !blk_new_backing
) {
3465 memset(buf_new
, 0, n
);
3467 if (offset
+ n
> new_backing_size
) {
3468 n
= new_backing_size
- offset
;
3471 ret
= blk_pread(blk_new_backing
, offset
, buf_new
, n
);
3473 error_report("error while reading from new backing file");
3478 /* If they differ, we need to write to the COW file */
3479 uint64_t written
= 0;
3481 while (written
< n
) {
3484 if (compare_buffers(buf_old
+ written
, buf_new
+ written
,
3485 n
- written
, &pnum
))
3487 ret
= blk_pwrite(blk
, offset
+ written
,
3488 buf_old
+ written
, pnum
, 0);
3490 error_report("Error while writing to COW image: %s",
3498 qemu_progress_print(local_progress
, 100);
3503 * Change the backing file. All clusters that are different from the old
3504 * backing file are overwritten in the COW file now, so the visible content
3505 * doesn't change when we switch the backing file.
3507 if (out_baseimg
&& *out_baseimg
) {
3508 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3510 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3513 if (ret
== -ENOSPC
) {
3514 error_report("Could not change the backing file to '%s': No "
3515 "space left in the file header", out_baseimg
);
3516 } else if (ret
< 0) {
3517 error_report("Could not change the backing file to '%s': %s",
3518 out_baseimg
, strerror(-ret
));
3521 qemu_progress_print(100, 0);
3523 * TODO At this point it is possible to check if any clusters that are
3524 * allocated in the COW file are the same in the backing file. If so, they
3525 * could be dropped from the COW file. Don't do this before switching the
3526 * backing file, in case of a crash this would lead to corruption.
3529 qemu_progress_end();
3532 blk_unref(blk_old_backing
);
3533 blk_unref(blk_new_backing
);
3535 qemu_vfree(buf_old
);
3536 qemu_vfree(buf_new
);
3545 static int img_resize(int argc
, char **argv
)
3548 int c
, ret
, relative
;
3549 const char *filename
, *fmt
, *size
;
3550 int64_t n
, total_size
, current_size
, new_size
;
3552 BlockBackend
*blk
= NULL
;
3553 PreallocMode prealloc
= PREALLOC_MODE_OFF
;
3556 static QemuOptsList resize_options
= {
3557 .name
= "resize_options",
3558 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3561 .name
= BLOCK_OPT_SIZE
,
3562 .type
= QEMU_OPT_SIZE
,
3563 .help
= "Virtual disk size"
3569 bool image_opts
= false;
3570 bool shrink
= false;
3572 /* Remove size from argv manually so that negative numbers are not treated
3573 * as options by getopt. */
3575 error_exit("Not enough arguments");
3579 size
= argv
[--argc
];
3581 /* Parse getopt arguments */
3584 static const struct option long_options
[] = {
3585 {"help", no_argument
, 0, 'h'},
3586 {"object", required_argument
, 0, OPTION_OBJECT
},
3587 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3588 {"preallocation", required_argument
, 0, OPTION_PREALLOCATION
},
3589 {"shrink", no_argument
, 0, OPTION_SHRINK
},
3592 c
= getopt_long(argc
, argv
, ":f:hq",
3593 long_options
, NULL
);
3599 missing_argument(argv
[optind
- 1]);
3602 unrecognized_option(argv
[optind
- 1]);
3613 case OPTION_OBJECT
: {
3615 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3621 case OPTION_IMAGE_OPTS
:
3624 case OPTION_PREALLOCATION
:
3625 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, optarg
,
3626 PREALLOC_MODE__MAX
, NULL
);
3627 if (prealloc
== PREALLOC_MODE__MAX
) {
3628 error_report("Invalid preallocation mode '%s'", optarg
);
3637 if (optind
!= argc
- 1) {
3638 error_exit("Expecting image file name and size");
3640 filename
= argv
[optind
++];
3642 if (qemu_opts_foreach(&qemu_object_opts
,
3643 user_creatable_add_opts_foreach
,
3644 NULL
, &error_fatal
)) {
3648 /* Choose grow, shrink, or absolute resize mode */
3664 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3665 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3667 error_report_err(err
);
3669 qemu_opts_del(param
);
3672 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3673 qemu_opts_del(param
);
3675 blk
= img_open(image_opts
, filename
, fmt
,
3676 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
3683 current_size
= blk_getlength(blk
);
3684 if (current_size
< 0) {
3685 error_report("Failed to inquire current image length: %s",
3686 strerror(-current_size
));
3692 total_size
= current_size
+ n
* relative
;
3696 if (total_size
<= 0) {
3697 error_report("New image size must be positive");
3702 if (total_size
<= current_size
&& prealloc
!= PREALLOC_MODE_OFF
) {
3703 error_report("Preallocation can only be used for growing images");
3708 if (total_size
< current_size
&& !shrink
) {
3709 warn_report("Shrinking an image will delete all data beyond the "
3710 "shrunken image's end. Before performing such an "
3711 "operation, make sure there is no important data there.");
3713 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk
)), "raw") != 0) {
3715 "Use the --shrink option to perform a shrink operation.");
3719 warn_report("Using the --shrink option will suppress this message. "
3720 "Note that future versions of qemu-img may refuse to "
3721 "shrink images without this option.");
3725 ret
= blk_truncate(blk
, total_size
, prealloc
, &err
);
3727 error_report_err(err
);
3731 new_size
= blk_getlength(blk
);
3733 error_report("Failed to verify truncated image length: %s",
3734 strerror(-new_size
));
3739 /* Some block drivers implement a truncation method, but only so
3740 * the user can cause qemu to refresh the image's size from disk.
3741 * The idea is that the user resizes the image outside of qemu and
3742 * then invokes block_resize to inform qemu about it.
3743 * (This includes iscsi and file-posix for device files.)
3744 * Of course, that is not the behavior someone invoking
3745 * qemu-img resize would find useful, so we catch that behavior
3746 * here and tell the user. */
3747 if (new_size
!= total_size
&& new_size
== current_size
) {
3748 error_report("Image was not resized; resizing may not be supported "
3754 if (new_size
!= total_size
) {
3755 warn_report("Image should have been resized to %" PRIi64
3756 " bytes, but was resized to %" PRIi64
" bytes",
3757 total_size
, new_size
);
3760 qprintf(quiet
, "Image resized.\n");
3770 static void amend_status_cb(BlockDriverState
*bs
,
3771 int64_t offset
, int64_t total_work_size
,
3774 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3777 static int print_amend_option_help(const char *format
)
3781 /* Find driver and parse its options */
3782 drv
= bdrv_find_format(format
);
3784 error_report("Unknown file format '%s'", format
);
3788 if (!drv
->bdrv_amend_options
) {
3789 error_report("Format driver '%s' does not support option amendment",
3794 /* Every driver supporting amendment must have create_opts */
3795 assert(drv
->create_opts
);
3797 printf("Creation options for '%s':\n", format
);
3798 qemu_opts_print_help(drv
->create_opts
, false);
3799 printf("\nNote that not all of these options may be amendable.\n");
3803 static int img_amend(int argc
, char **argv
)
3807 char *options
= NULL
;
3808 QemuOptsList
*create_opts
= NULL
;
3809 QemuOpts
*opts
= NULL
;
3810 const char *fmt
= NULL
, *filename
, *cache
;
3813 bool quiet
= false, progress
= false;
3814 BlockBackend
*blk
= NULL
;
3815 BlockDriverState
*bs
= NULL
;
3816 bool image_opts
= false;
3818 cache
= BDRV_DEFAULT_CACHE
;
3820 static const struct option long_options
[] = {
3821 {"help", no_argument
, 0, 'h'},
3822 {"object", required_argument
, 0, OPTION_OBJECT
},
3823 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3826 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
3827 long_options
, NULL
);
3834 missing_argument(argv
[optind
- 1]);
3837 unrecognized_option(argv
[optind
- 1]);
3843 if (!is_valid_option_list(optarg
)) {
3844 error_report("Invalid option list: %s", optarg
);
3846 goto out_no_progress
;
3849 options
= g_strdup(optarg
);
3851 char *old_options
= options
;
3852 options
= g_strdup_printf("%s,%s", options
, optarg
);
3853 g_free(old_options
);
3869 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3873 goto out_no_progress
;
3876 case OPTION_IMAGE_OPTS
:
3883 error_exit("Must specify options (-o)");
3886 if (qemu_opts_foreach(&qemu_object_opts
,
3887 user_creatable_add_opts_foreach
,
3888 NULL
, &error_fatal
)) {
3890 goto out_no_progress
;
3896 qemu_progress_init(progress
, 1.0);
3898 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3899 if (fmt
&& has_help_option(options
)) {
3900 /* If a format is explicitly specified (and possibly no filename is
3901 * given), print option help here */
3902 ret
= print_amend_option_help(fmt
);
3906 if (optind
!= argc
- 1) {
3907 error_report("Expecting one image file name");
3912 flags
= BDRV_O_RDWR
;
3913 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3915 error_report("Invalid cache option: %s", cache
);
3919 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3927 fmt
= bs
->drv
->format_name
;
3929 if (has_help_option(options
)) {
3930 /* If the format was auto-detected, print option help here */
3931 ret
= print_amend_option_help(fmt
);
3935 if (!bs
->drv
->bdrv_amend_options
) {
3936 error_report("Format driver '%s' does not support option amendment",
3942 /* Every driver supporting amendment must have create_opts */
3943 assert(bs
->drv
->create_opts
);
3945 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3946 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3947 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3949 error_report_err(err
);
3954 /* In case the driver does not call amend_status_cb() */
3955 qemu_progress_print(0.f
, 0);
3956 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
, &err
);
3957 qemu_progress_print(100.f
, 0);
3959 error_report_err(err
);
3964 qemu_progress_end();
3968 qemu_opts_del(opts
);
3969 qemu_opts_free(create_opts
);
3978 typedef struct BenchData
{
3980 uint64_t image_size
;
3987 bool drain_on_flush
;
3996 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3999 error_report("Failed flush request: %s", strerror(-ret
));
4004 static void bench_cb(void *opaque
, int ret
)
4006 BenchData
*b
= opaque
;
4010 error_report("Failed request: %s", strerror(-ret
));
4015 /* Just finished a flush with drained queue: Start next requests */
4016 assert(b
->in_flight
== 0);
4017 b
->in_flush
= false;
4018 } else if (b
->in_flight
> 0) {
4019 int remaining
= b
->n
- b
->in_flight
;
4024 /* Time for flush? Drain queue if requested, then flush */
4025 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
4026 if (!b
->in_flight
|| !b
->drain_on_flush
) {
4027 BlockCompletionFunc
*cb
;
4029 if (b
->drain_on_flush
) {
4033 cb
= bench_undrained_flush_cb
;
4036 acb
= blk_aio_flush(b
->blk
, cb
, b
);
4038 error_report("Failed to issue flush request");
4042 if (b
->drain_on_flush
) {
4048 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
4049 int64_t offset
= b
->offset
;
4050 /* blk_aio_* might look for completed I/Os and kick bench_cb
4051 * again, so make sure this operation is counted by in_flight
4052 * and b->offset is ready for the next submission.
4055 b
->offset
+= b
->step
;
4056 b
->offset
%= b
->image_size
;
4058 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4060 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4063 error_report("Failed to issue request");
4069 static int img_bench(int argc
, char **argv
)
4072 const char *fmt
= NULL
, *filename
;
4074 bool image_opts
= false;
4075 bool is_write
= false;
4079 size_t bufsize
= 4096;
4082 int flush_interval
= 0;
4083 bool drain_on_flush
= true;
4085 BlockBackend
*blk
= NULL
;
4086 BenchData data
= {};
4088 bool writethrough
= false;
4089 struct timeval t1
, t2
;
4091 bool force_share
= false;
4095 static const struct option long_options
[] = {
4096 {"help", no_argument
, 0, 'h'},
4097 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
4098 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4099 {"pattern", required_argument
, 0, OPTION_PATTERN
},
4100 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
4101 {"force-share", no_argument
, 0, 'U'},
4104 c
= getopt_long(argc
, argv
, ":hc:d:f:no:qs:S:t:wU", long_options
, NULL
);
4111 missing_argument(argv
[optind
- 1]);
4114 unrecognized_option(argv
[optind
- 1]);
4123 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4124 error_report("Invalid request count specified");
4134 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4135 error_report("Invalid queue depth specified");
4145 flags
|= BDRV_O_NATIVE_AIO
;
4149 offset
= cvtnum(optarg
);
4151 error_report("Invalid offset specified");
4164 sval
= cvtnum(optarg
);
4165 if (sval
< 0 || sval
> INT_MAX
) {
4166 error_report("Invalid buffer size specified");
4177 sval
= cvtnum(optarg
);
4178 if (sval
< 0 || sval
> INT_MAX
) {
4179 error_report("Invalid step size specified");
4187 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
4189 error_report("Invalid cache mode");
4195 flags
|= BDRV_O_RDWR
;
4201 case OPTION_PATTERN
:
4205 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
4206 error_report("Invalid pattern byte specified");
4212 case OPTION_FLUSH_INTERVAL
:
4216 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4217 error_report("Invalid flush interval specified");
4220 flush_interval
= res
;
4223 case OPTION_NO_DRAIN
:
4224 drain_on_flush
= false;
4226 case OPTION_IMAGE_OPTS
:
4232 if (optind
!= argc
- 1) {
4233 error_exit("Expecting one image file name");
4235 filename
= argv
[argc
- 1];
4237 if (!is_write
&& flush_interval
) {
4238 error_report("--flush-interval is only available in write tests");
4242 if (flush_interval
&& flush_interval
< depth
) {
4243 error_report("Flush interval can't be smaller than depth");
4248 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4255 image_size
= blk_getlength(blk
);
4256 if (image_size
< 0) {
4261 data
= (BenchData
) {
4263 .image_size
= image_size
,
4265 .step
= step
?: bufsize
,
4270 .flush_interval
= flush_interval
,
4271 .drain_on_flush
= drain_on_flush
,
4273 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4274 "(starting at offset %" PRId64
", step size %d)\n",
4275 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4276 data
.offset
, data
.step
);
4277 if (flush_interval
) {
4278 printf("Sending flush every %d requests\n", flush_interval
);
4281 buf_size
= data
.nrreq
* data
.bufsize
;
4282 data
.buf
= blk_blockalign(blk
, buf_size
);
4283 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4285 blk_register_buf(blk
, data
.buf
, buf_size
);
4287 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4288 for (i
= 0; i
< data
.nrreq
; i
++) {
4289 qemu_iovec_init(&data
.qiov
[i
], 1);
4290 qemu_iovec_add(&data
.qiov
[i
],
4291 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4294 gettimeofday(&t1
, NULL
);
4297 while (data
.n
> 0) {
4298 main_loop_wait(false);
4300 gettimeofday(&t2
, NULL
);
4302 printf("Run completed in %3.3f seconds.\n",
4303 (t2
.tv_sec
- t1
.tv_sec
)
4304 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4308 blk_unregister_buf(blk
, data
.buf
);
4310 qemu_vfree(data
.buf
);
4331 int bsz
; /* Block size */
4339 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4343 static int img_dd_bs(const char *arg
,
4344 struct DdIo
*in
, struct DdIo
*out
,
4351 if (res
<= 0 || res
> INT_MAX
) {
4352 error_report("invalid number: '%s'", arg
);
4355 in
->bsz
= out
->bsz
= res
;
4360 static int img_dd_count(const char *arg
,
4361 struct DdIo
*in
, struct DdIo
*out
,
4364 dd
->count
= cvtnum(arg
);
4366 if (dd
->count
< 0) {
4367 error_report("invalid number: '%s'", arg
);
4374 static int img_dd_if(const char *arg
,
4375 struct DdIo
*in
, struct DdIo
*out
,
4378 in
->filename
= g_strdup(arg
);
4383 static int img_dd_of(const char *arg
,
4384 struct DdIo
*in
, struct DdIo
*out
,
4387 out
->filename
= g_strdup(arg
);
4392 static int img_dd_skip(const char *arg
,
4393 struct DdIo
*in
, struct DdIo
*out
,
4396 in
->offset
= cvtnum(arg
);
4398 if (in
->offset
< 0) {
4399 error_report("invalid number: '%s'", arg
);
4406 static int img_dd(int argc
, char **argv
)
4411 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4412 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4413 QemuOpts
*opts
= NULL
;
4414 QemuOptsList
*create_opts
= NULL
;
4415 Error
*local_err
= NULL
;
4416 bool image_opts
= false;
4418 const char *out_fmt
= "raw";
4419 const char *fmt
= NULL
;
4421 int64_t block_count
= 0, out_pos
, in_pos
;
4422 bool force_share
= false;
4423 struct DdInfo dd
= {
4428 .bsz
= 512, /* Block size is by default 512 bytes */
4440 const struct DdOpts options
[] = {
4441 { "bs", img_dd_bs
, C_BS
},
4442 { "count", img_dd_count
, C_COUNT
},
4443 { "if", img_dd_if
, C_IF
},
4444 { "of", img_dd_of
, C_OF
},
4445 { "skip", img_dd_skip
, C_SKIP
},
4448 const struct option long_options
[] = {
4449 { "help", no_argument
, 0, 'h'},
4450 { "object", required_argument
, 0, OPTION_OBJECT
},
4451 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4452 { "force-share", no_argument
, 0, 'U'},
4456 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
4468 missing_argument(argv
[optind
- 1]);
4471 unrecognized_option(argv
[optind
- 1]);
4480 if (!qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true)) {
4485 case OPTION_IMAGE_OPTS
:
4491 for (i
= optind
; i
< argc
; i
++) {
4493 arg
= g_strdup(argv
[i
]);
4495 tmp
= strchr(arg
, '=');
4497 error_report("unrecognized operand %s", arg
);
4504 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4505 if (!strcmp(arg
, options
[j
].name
)) {
4509 if (options
[j
].name
== NULL
) {
4510 error_report("unrecognized operand %s", arg
);
4515 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4519 dd
.flags
|= options
[j
].flag
;
4524 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4525 error_report("Must specify both input and output files");
4530 if (qemu_opts_foreach(&qemu_object_opts
,
4531 user_creatable_add_opts_foreach
,
4532 NULL
, &error_fatal
)) {
4537 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
4545 drv
= bdrv_find_format(out_fmt
);
4547 error_report("Unknown file format");
4551 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4554 error_report_err(local_err
);
4558 if (!drv
->create_opts
) {
4559 error_report("Format driver '%s' does not support image creation",
4564 if (!proto_drv
->create_opts
) {
4565 error_report("Protocol driver '%s' does not support image creation",
4566 proto_drv
->format_name
);
4570 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4571 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4573 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4575 size
= blk_getlength(blk1
);
4577 error_report("Failed to get size for '%s'", in
.filename
);
4582 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4583 dd
.count
* in
.bsz
< size
) {
4584 size
= dd
.count
* in
.bsz
;
4587 /* Overflow means the specified offset is beyond input image's size */
4588 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4589 size
< in
.bsz
* in
.offset
)) {
4590 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4592 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4593 size
- in
.bsz
* in
.offset
, &error_abort
);
4596 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4598 error_reportf_err(local_err
,
4599 "%s: error while creating output image: ",
4605 /* TODO, we can't honour --image-opts for the target,
4606 * since it needs to be given in a format compatible
4607 * with the bdrv_create() call above which does not
4608 * support image-opts style.
4610 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
4611 false, false, false);
4618 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4619 size
< in
.offset
* in
.bsz
)) {
4620 /* We give a warning if the skip option is bigger than the input
4621 * size and create an empty output disk image (i.e. like dd(1)).
4623 error_report("%s: cannot skip to specified offset", in
.filename
);
4626 in_pos
= in
.offset
* in
.bsz
;
4629 in
.buf
= g_new(uint8_t, in
.bsz
);
4631 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4632 int in_ret
, out_ret
;
4634 if (in_pos
+ in
.bsz
> size
) {
4635 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4637 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4640 error_report("error while reading from input image file: %s",
4647 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4650 error_report("error while writing to output image file: %s",
4651 strerror(-out_ret
));
4660 qemu_opts_del(opts
);
4661 qemu_opts_free(create_opts
);
4664 g_free(in
.filename
);
4665 g_free(out
.filename
);
4675 static void dump_json_block_measure_info(BlockMeasureInfo
*info
)
4679 Visitor
*v
= qobject_output_visitor_new(&obj
);
4681 visit_type_BlockMeasureInfo(v
, NULL
, &info
, &error_abort
);
4682 visit_complete(v
, &obj
);
4683 str
= qobject_to_json_pretty(obj
);
4684 assert(str
!= NULL
);
4685 printf("%s\n", qstring_get_str(str
));
4691 static int img_measure(int argc
, char **argv
)
4693 static const struct option long_options
[] = {
4694 {"help", no_argument
, 0, 'h'},
4695 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4696 {"object", required_argument
, 0, OPTION_OBJECT
},
4697 {"output", required_argument
, 0, OPTION_OUTPUT
},
4698 {"size", required_argument
, 0, OPTION_SIZE
},
4699 {"force-share", no_argument
, 0, 'U'},
4702 OutputFormat output_format
= OFORMAT_HUMAN
;
4703 BlockBackend
*in_blk
= NULL
;
4705 const char *filename
= NULL
;
4706 const char *fmt
= NULL
;
4707 const char *out_fmt
= "raw";
4708 char *options
= NULL
;
4709 char *snapshot_name
= NULL
;
4710 bool force_share
= false;
4711 QemuOpts
*opts
= NULL
;
4712 QemuOpts
*object_opts
= NULL
;
4713 QemuOpts
*sn_opts
= NULL
;
4714 QemuOptsList
*create_opts
= NULL
;
4715 bool image_opts
= false;
4716 uint64_t img_size
= UINT64_MAX
;
4717 BlockMeasureInfo
*info
= NULL
;
4718 Error
*local_err
= NULL
;
4722 while ((c
= getopt_long(argc
, argv
, "hf:O:o:l:U",
4723 long_options
, NULL
)) != -1) {
4736 if (!is_valid_option_list(optarg
)) {
4737 error_report("Invalid option list: %s", optarg
);
4741 options
= g_strdup(optarg
);
4743 char *old_options
= options
;
4744 options
= g_strdup_printf("%s,%s", options
, optarg
);
4745 g_free(old_options
);
4749 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
4750 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
4753 error_report("Failed in parsing snapshot param '%s'",
4758 snapshot_name
= optarg
;
4765 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
4771 case OPTION_IMAGE_OPTS
:
4775 if (!strcmp(optarg
, "json")) {
4776 output_format
= OFORMAT_JSON
;
4777 } else if (!strcmp(optarg
, "human")) {
4778 output_format
= OFORMAT_HUMAN
;
4780 error_report("--output must be used with human or json "
4789 sval
= cvtnum(optarg
);
4791 if (sval
== -ERANGE
) {
4792 error_report("Image size must be less than 8 EiB!");
4794 error_report("Invalid image size specified! You may use "
4795 "k, M, G, T, P or E suffixes for ");
4796 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4797 "petabytes and exabytes.");
4801 img_size
= (uint64_t)sval
;
4807 if (qemu_opts_foreach(&qemu_object_opts
,
4808 user_creatable_add_opts_foreach
,
4809 NULL
, &error_fatal
)) {
4813 if (argc
- optind
> 1) {
4814 error_report("At most one filename argument is allowed.");
4816 } else if (argc
- optind
== 1) {
4817 filename
= argv
[optind
];
4821 (object_opts
|| image_opts
|| fmt
|| snapshot_name
|| sn_opts
)) {
4822 error_report("--object, --image-opts, -f, and -l "
4823 "require a filename argument.");
4826 if (filename
&& img_size
!= UINT64_MAX
) {
4827 error_report("--size N cannot be used together with a filename.");
4830 if (!filename
&& img_size
== UINT64_MAX
) {
4831 error_report("Either --size N or one filename must be specified.");
4836 in_blk
= img_open(image_opts
, filename
, fmt
, 0,
4837 false, false, force_share
);
4843 bdrv_snapshot_load_tmp(blk_bs(in_blk
),
4844 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
4845 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
4847 } else if (snapshot_name
!= NULL
) {
4848 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk
),
4849 snapshot_name
, &local_err
);
4852 error_reportf_err(local_err
, "Failed to load snapshot: ");
4857 drv
= bdrv_find_format(out_fmt
);
4859 error_report("Unknown file format '%s'", out_fmt
);
4862 if (!drv
->create_opts
) {
4863 error_report("Format driver '%s' does not support image creation",
4868 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4869 create_opts
= qemu_opts_append(create_opts
, bdrv_file
.create_opts
);
4870 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4872 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
4874 error_report_err(local_err
);
4875 error_report("Invalid options for file format '%s'", out_fmt
);
4879 if (img_size
!= UINT64_MAX
) {
4880 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, img_size
, &error_abort
);
4883 info
= bdrv_measure(drv
, opts
, in_blk
? blk_bs(in_blk
) : NULL
, &local_err
);
4885 error_report_err(local_err
);
4889 if (output_format
== OFORMAT_HUMAN
) {
4890 printf("required size: %" PRIu64
"\n", info
->required
);
4891 printf("fully allocated size: %" PRIu64
"\n", info
->fully_allocated
);
4893 dump_json_block_measure_info(info
);
4899 qapi_free_BlockMeasureInfo(info
);
4900 qemu_opts_del(object_opts
);
4901 qemu_opts_del(opts
);
4902 qemu_opts_del(sn_opts
);
4903 qemu_opts_free(create_opts
);
4909 static const img_cmd_t img_cmds
[] = {
4910 #define DEF(option, callback, arg_string) \
4911 { option, callback },
4912 #include "qemu-img-cmds.h"
4917 int main(int argc
, char **argv
)
4919 const img_cmd_t
*cmd
;
4920 const char *cmdname
;
4921 Error
*local_error
= NULL
;
4922 char *trace_file
= NULL
;
4924 static const struct option long_options
[] = {
4925 {"help", no_argument
, 0, 'h'},
4926 {"version", no_argument
, 0, 'V'},
4927 {"trace", required_argument
, NULL
, 'T'},
4932 signal(SIGPIPE
, SIG_IGN
);
4935 error_init(argv
[0]);
4936 module_call_init(MODULE_INIT_TRACE
);
4937 qemu_init_exec_dir(argv
[0]);
4939 if (qemu_init_main_loop(&local_error
)) {
4940 error_report_err(local_error
);
4944 qcrypto_init(&error_fatal
);
4946 module_call_init(MODULE_INIT_QOM
);
4949 error_exit("Not enough arguments");
4952 qemu_add_opts(&qemu_object_opts
);
4953 qemu_add_opts(&qemu_source_opts
);
4954 qemu_add_opts(&qemu_trace_opts
);
4956 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
4959 missing_argument(argv
[optind
- 1]);
4962 unrecognized_option(argv
[optind
- 1]);
4968 printf(QEMU_IMG_VERSION
);
4972 trace_file
= trace_opt_parse(optarg
);
4977 cmdname
= argv
[optind
];
4979 /* reset getopt_long scanning */
4985 qemu_reset_optind();
4987 if (!trace_init_backends()) {
4990 trace_init_file(trace_file
);
4991 qemu_set_log(LOG_TRACE
);
4993 /* find the command */
4994 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4995 if (!strcmp(cmdname
, cmd
->name
)) {
4996 return cmd
->handler(argc
, argv
);
5001 error_exit("Command not found: %s", cmdname
);