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-common.h"
29 #include "qemu-version.h"
30 #include "qapi/error.h"
31 #include "qapi/qapi-commands-block-core.h"
32 #include "qapi/qapi-visit-block-core.h"
33 #include "qapi/qobject-output-visitor.h"
34 #include "qapi/qmp/qjson.h"
35 #include "qapi/qmp/qdict.h"
36 #include "qapi/qmp/qstring.h"
37 #include "qemu/cutils.h"
38 #include "qemu/config-file.h"
39 #include "qemu/option.h"
40 #include "qemu/error-report.h"
42 #include "qemu/main-loop.h"
43 #include "qemu/module.h"
44 #include "qemu/sockets.h"
45 #include "qemu/units.h"
46 #include "qom/object_interfaces.h"
47 #include "sysemu/block-backend.h"
48 #include "block/block_int.h"
49 #include "block/blockjob.h"
50 #include "block/qapi.h"
51 #include "crypto/init.h"
52 #include "trace/control.h"
53 #include "qemu/throttle.h"
54 #include "block/throttle-groups.h"
56 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
57 "\n" QEMU_COPYRIGHT "\n"
59 typedef struct img_cmd_t
{
61 int (*handler
)(int argc
, char **argv
);
66 OPTION_BACKING_CHAIN
= 257,
68 OPTION_IMAGE_OPTS
= 259,
70 OPTION_FLUSH_INTERVAL
= 261,
71 OPTION_NO_DRAIN
= 262,
72 OPTION_TARGET_IMAGE_OPTS
= 263,
74 OPTION_PREALLOCATION
= 265,
77 OPTION_TARGET_IS_ZERO
= 268,
88 typedef enum OutputFormat
{
93 /* Default to cache=writeback as data integrity is not important for qemu-img */
94 #define BDRV_DEFAULT_CACHE "writeback"
96 static void format_print(void *opaque
, const char *name
)
101 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
106 error_vreport(fmt
, ap
);
109 error_printf("Try 'qemu-img --help' for more information\n");
113 static void QEMU_NORETURN
missing_argument(const char *option
)
115 error_exit("missing argument for option '%s'", option
);
118 static void QEMU_NORETURN
unrecognized_option(const char *option
)
120 error_exit("unrecognized option '%s'", option
);
123 /* Please keep in synch with docs/tools/qemu-img.rst */
124 static void QEMU_NORETURN
help(void)
126 const char *help_msg
=
128 "usage: qemu-img [standard options] command [command options]\n"
129 "QEMU disk image utility\n"
131 " '-h', '--help' display this help and exit\n"
132 " '-V', '--version' output version information and exit\n"
133 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
134 " specify tracing options\n"
137 #define DEF(option, callback, arg_string) \
139 #include "qemu-img-cmds.h"
142 "Command parameters:\n"
143 " 'filename' is a disk image filename\n"
144 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
145 " manual page for a description of the object properties. The most common\n"
146 " object type is a 'secret', which is used to supply passwords and/or\n"
147 " encryption keys.\n"
148 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
149 " 'cache' is the cache mode used to write the output disk image, the valid\n"
150 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
151 " 'directsync' and 'unsafe' (default for convert)\n"
152 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
153 " options are the same as for the 'cache' option\n"
154 " 'size' is the disk image size in bytes. Optional suffixes\n"
155 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
156 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
157 " supported. 'b' is ignored.\n"
158 " 'output_filename' is the destination disk image filename\n"
159 " 'output_fmt' is the destination format\n"
160 " 'options' is a comma separated list of format specific options in a\n"
161 " name=value format. Use -o ? for an overview of the options supported by the\n"
163 " 'snapshot_param' is param used for internal snapshot, format\n"
164 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
166 " '-c' indicates that target image must be compressed (qcow format only)\n"
167 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
168 " new backing file match exactly. The image doesn't need a working\n"
169 " backing file before rebasing in this case (useful for renaming the\n"
170 " backing file). For image creation, allow creating without attempting\n"
171 " to open the backing file.\n"
172 " '-h' with or without a command shows this help and lists the supported formats\n"
173 " '-p' show progress of command (only certain commands)\n"
174 " '-q' use Quiet mode - do not print any output (except errors)\n"
175 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
176 " contain only zeros for qemu-img to create a sparse image during\n"
177 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
178 " unallocated or zero sectors, and the destination image will always be\n"
180 " '--output' takes the format in which the output must be done (human or json)\n"
181 " '-n' skips the target volume creation (useful if the volume is created\n"
182 " prior to running qemu-img)\n"
184 "Parameters to bitmap subcommand:\n"
185 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
186 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
187 " or '--merge source'\n"
188 " '-g granularity' sets the granularity for '--add' actions\n"
189 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
190 " bitmaps from an alternative file\n"
192 "Parameters to check subcommand:\n"
193 " '-r' tries to repair any inconsistencies that are found during the check.\n"
194 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
195 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
196 " hiding corruption that has already occurred.\n"
198 "Parameters to convert subcommand:\n"
199 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
200 " '-m' specifies how many coroutines work in parallel during the convert\n"
201 " process (defaults to 8)\n"
202 " '-W' allow to write to the target out of order rather than sequential\n"
204 "Parameters to snapshot subcommand:\n"
205 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
206 " '-a' applies a snapshot (revert disk to saved state)\n"
207 " '-c' creates a snapshot\n"
208 " '-d' deletes a snapshot\n"
209 " '-l' lists all snapshots in the given image\n"
211 "Parameters to compare subcommand:\n"
212 " '-f' first image format\n"
213 " '-F' second image format\n"
214 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
216 "Parameters to dd subcommand:\n"
217 " 'bs=BYTES' read and write up to BYTES bytes at a time "
219 " 'count=N' copy only N input blocks\n"
220 " 'if=FILE' read from FILE\n"
221 " 'of=FILE' write to FILE\n"
222 " 'skip=N' skip N bs-sized blocks at the start of input\n";
224 printf("%s\nSupported formats:", help_msg
);
225 bdrv_iterate_format(format_print
, NULL
, false);
226 printf("\n\n" QEMU_HELP_BOTTOM
"\n");
230 static QemuOptsList qemu_object_opts
= {
232 .implied_opt_name
= "qom-type",
233 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
239 static bool qemu_img_object_print_help(const char *type
, QemuOpts
*opts
)
241 if (user_creatable_print_help(type
, opts
)) {
248 * Is @optarg safe for accumulate_options()?
249 * It is when multiple of them can be joined together separated by ','.
250 * To make that work, @optarg must not start with ',' (or else a
251 * separating ',' preceding it gets escaped), and it must not end with
252 * an odd number of ',' (or else a separating ',' following it gets
253 * escaped), or be empty (or else a separating ',' preceding it can
254 * escape a separating ',' following it).
257 static bool is_valid_option_list(const char *optarg
)
259 size_t len
= strlen(optarg
);
262 if (!optarg
[0] || optarg
[0] == ',') {
266 for (i
= len
; i
> 0 && optarg
[i
- 1] == ','; i
--) {
275 static int accumulate_options(char **options
, char *optarg
)
279 if (!is_valid_option_list(optarg
)) {
280 error_report("Invalid option list: %s", optarg
);
285 *options
= g_strdup(optarg
);
287 new_options
= g_strdup_printf("%s,%s", *options
, optarg
);
289 *options
= new_options
;
294 static QemuOptsList qemu_source_opts
= {
296 .implied_opt_name
= "file",
297 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
303 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
309 ret
= vprintf(fmt
, args
);
316 static int print_block_option_help(const char *filename
, const char *fmt
)
318 BlockDriver
*drv
, *proto_drv
;
319 QemuOptsList
*create_opts
= NULL
;
320 Error
*local_err
= NULL
;
322 /* Find driver and parse its options */
323 drv
= bdrv_find_format(fmt
);
325 error_report("Unknown file format '%s'", fmt
);
329 if (!drv
->create_opts
) {
330 error_report("Format driver '%s' does not support image creation", fmt
);
334 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
336 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
338 error_report_err(local_err
);
339 qemu_opts_free(create_opts
);
342 if (!proto_drv
->create_opts
) {
343 error_report("Protocol driver '%s' does not support image creation",
344 proto_drv
->format_name
);
345 qemu_opts_free(create_opts
);
348 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
352 printf("Supported options:\n");
354 printf("Supported %s options:\n", fmt
);
356 qemu_opts_print_help(create_opts
, false);
357 qemu_opts_free(create_opts
);
361 "The protocol level may support further options.\n"
362 "Specify the target filename to include those options.\n");
369 static BlockBackend
*img_open_opts(const char *optstr
,
370 QemuOpts
*opts
, int flags
, bool writethrough
,
371 bool quiet
, bool force_share
)
374 Error
*local_err
= NULL
;
376 options
= qemu_opts_to_qdict(opts
, NULL
);
378 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
379 && strcmp(qdict_get_str(options
, BDRV_OPT_FORCE_SHARE
), "on")) {
380 error_report("--force-share/-U conflicts with image options");
381 qobject_unref(options
);
384 qdict_put_str(options
, BDRV_OPT_FORCE_SHARE
, "on");
386 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
388 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
391 blk_set_enable_write_cache(blk
, !writethrough
);
396 static BlockBackend
*img_open_file(const char *filename
,
398 const char *fmt
, int flags
,
399 bool writethrough
, bool quiet
,
403 Error
*local_err
= NULL
;
406 options
= qdict_new();
409 qdict_put_str(options
, "driver", fmt
);
413 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
415 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
417 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
420 blk_set_enable_write_cache(blk
, !writethrough
);
426 static int img_add_key_secrets(void *opaque
,
427 const char *name
, const char *value
,
430 QDict
*options
= opaque
;
432 if (g_str_has_suffix(name
, "key-secret")) {
433 qdict_put_str(options
, name
, value
);
440 static BlockBackend
*img_open(bool image_opts
,
441 const char *filename
,
442 const char *fmt
, int flags
, bool writethrough
,
443 bool quiet
, bool force_share
)
449 error_report("--image-opts and --format are mutually exclusive");
452 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
457 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
460 blk
= img_open_file(filename
, NULL
, fmt
, flags
, writethrough
, quiet
,
467 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
468 const char *base_filename
,
469 const char *base_fmt
)
472 if (!qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
,
474 error_report("Backing file not supported for file format '%s'",
480 if (!qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, NULL
)) {
481 error_report("Backing file format not supported for file "
489 static int64_t cvtnum_full(const char *name
, const char *value
, int64_t min
,
495 err
= qemu_strtosz(value
, NULL
, &res
);
496 if (err
< 0 && err
!= -ERANGE
) {
497 error_report("Invalid %s specified. You may use "
498 "k, M, G, T, P or E suffixes for", name
);
499 error_report("kilobytes, megabytes, gigabytes, terabytes, "
500 "petabytes and exabytes.");
503 if (err
== -ERANGE
|| res
> max
|| res
< min
) {
504 error_report("Invalid %s specified. Must be between %" PRId64
505 " and %" PRId64
".", name
, min
, max
);
511 static int64_t cvtnum(const char *name
, const char *value
)
513 return cvtnum_full(name
, value
, 0, INT64_MAX
);
516 static int img_create(int argc
, char **argv
)
519 uint64_t img_size
= -1;
520 const char *fmt
= "raw";
521 const char *base_fmt
= NULL
;
522 const char *filename
;
523 const char *base_filename
= NULL
;
524 char *options
= NULL
;
525 Error
*local_err
= NULL
;
530 static const struct option long_options
[] = {
531 {"help", no_argument
, 0, 'h'},
532 {"object", required_argument
, 0, OPTION_OBJECT
},
535 c
= getopt_long(argc
, argv
, ":F:b:f:ho:qu",
542 missing_argument(argv
[optind
- 1]);
545 unrecognized_option(argv
[optind
- 1]);
554 base_filename
= optarg
;
560 if (accumulate_options(&options
, optarg
) < 0) {
568 flags
|= BDRV_O_NO_BACKING
;
570 case OPTION_OBJECT
: {
572 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
581 /* Get the filename */
582 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
583 if (options
&& has_help_option(options
)) {
585 return print_block_option_help(filename
, fmt
);
588 if (optind
>= argc
) {
589 error_exit("Expecting image file name");
593 if (qemu_opts_foreach(&qemu_object_opts
,
594 user_creatable_add_opts_foreach
,
595 qemu_img_object_print_help
, &error_fatal
)) {
599 /* Get image size, if specified */
603 sval
= cvtnum("image size", argv
[optind
++]);
607 img_size
= (uint64_t)sval
;
609 if (optind
!= argc
) {
610 error_exit("Unexpected argument: %s", argv
[optind
]);
613 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
614 options
, img_size
, flags
, quiet
, &local_err
);
616 error_reportf_err(local_err
, "%s: ", filename
);
628 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
632 Visitor
*v
= qobject_output_visitor_new(&obj
);
634 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
635 visit_complete(v
, &obj
);
636 str
= qobject_to_json_pretty(obj
, true);
638 qprintf(quiet
, "%s\n", qstring_get_str(str
));
644 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
646 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
647 qprintf(quiet
, "No errors were found on the image.\n");
649 if (check
->corruptions
) {
650 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
651 "Data may be corrupted, or further writes to the image "
658 "\n%" PRId64
" leaked clusters were found on the image.\n"
659 "This means waste of disk space, but no harm to data.\n",
663 if (check
->check_errors
) {
666 " internal errors have occurred during the check.\n",
667 check
->check_errors
);
671 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
672 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
673 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
674 check
->allocated_clusters
, check
->total_clusters
,
675 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
676 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
677 check
->compressed_clusters
* 100.0 /
678 check
->allocated_clusters
);
681 if (check
->image_end_offset
) {
683 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
687 static int collect_image_check(BlockDriverState
*bs
,
689 const char *filename
,
694 BdrvCheckResult result
;
696 ret
= bdrv_check(bs
, &result
, fix
);
701 check
->filename
= g_strdup(filename
);
702 check
->format
= g_strdup(bdrv_get_format_name(bs
));
703 check
->check_errors
= result
.check_errors
;
704 check
->corruptions
= result
.corruptions
;
705 check
->has_corruptions
= result
.corruptions
!= 0;
706 check
->leaks
= result
.leaks
;
707 check
->has_leaks
= result
.leaks
!= 0;
708 check
->corruptions_fixed
= result
.corruptions_fixed
;
709 check
->has_corruptions_fixed
= result
.corruptions_fixed
!= 0;
710 check
->leaks_fixed
= result
.leaks_fixed
;
711 check
->has_leaks_fixed
= result
.leaks_fixed
!= 0;
712 check
->image_end_offset
= result
.image_end_offset
;
713 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
714 check
->total_clusters
= result
.bfi
.total_clusters
;
715 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
716 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
717 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
718 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
719 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
720 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
721 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
727 * Checks an image for consistency. Exit codes:
729 * 0 - Check completed, image is good
730 * 1 - Check not completed because of internal errors
731 * 2 - Check completed, image is corrupted
732 * 3 - Check completed, image has leaked clusters, but is good otherwise
733 * 63 - Checks are not supported by the image format
735 static int img_check(int argc
, char **argv
)
738 OutputFormat output_format
= OFORMAT_HUMAN
;
739 const char *filename
, *fmt
, *output
, *cache
;
741 BlockDriverState
*bs
;
743 int flags
= BDRV_O_CHECK
;
747 bool image_opts
= false;
748 bool force_share
= false;
752 cache
= BDRV_DEFAULT_CACHE
;
755 int option_index
= 0;
756 static const struct option long_options
[] = {
757 {"help", no_argument
, 0, 'h'},
758 {"format", required_argument
, 0, 'f'},
759 {"repair", required_argument
, 0, 'r'},
760 {"output", required_argument
, 0, OPTION_OUTPUT
},
761 {"object", required_argument
, 0, OPTION_OBJECT
},
762 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
763 {"force-share", no_argument
, 0, 'U'},
766 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
767 long_options
, &option_index
);
773 missing_argument(argv
[optind
- 1]);
776 unrecognized_option(argv
[optind
- 1]);
785 flags
|= BDRV_O_RDWR
;
787 if (!strcmp(optarg
, "leaks")) {
788 fix
= BDRV_FIX_LEAKS
;
789 } else if (!strcmp(optarg
, "all")) {
790 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
792 error_exit("Unknown option value for -r "
793 "(expecting 'leaks' or 'all'): %s", optarg
);
808 case OPTION_OBJECT
: {
810 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
816 case OPTION_IMAGE_OPTS
:
821 if (optind
!= argc
- 1) {
822 error_exit("Expecting one image file name");
824 filename
= argv
[optind
++];
826 if (output
&& !strcmp(output
, "json")) {
827 output_format
= OFORMAT_JSON
;
828 } else if (output
&& !strcmp(output
, "human")) {
829 output_format
= OFORMAT_HUMAN
;
831 error_report("--output must be used with human or json as argument.");
835 if (qemu_opts_foreach(&qemu_object_opts
,
836 user_creatable_add_opts_foreach
,
837 qemu_img_object_print_help
, &error_fatal
)) {
841 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
843 error_report("Invalid source cache option: %s", cache
);
847 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
854 check
= g_new0(ImageCheck
, 1);
855 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
857 if (ret
== -ENOTSUP
) {
858 error_report("This image format does not support checks");
863 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
864 int corruptions_fixed
, leaks_fixed
;
865 bool has_leaks_fixed
, has_corruptions_fixed
;
867 leaks_fixed
= check
->leaks_fixed
;
868 has_leaks_fixed
= check
->has_leaks_fixed
;
869 corruptions_fixed
= check
->corruptions_fixed
;
870 has_corruptions_fixed
= check
->has_corruptions_fixed
;
872 if (output_format
== OFORMAT_HUMAN
) {
874 "The following inconsistencies were found and repaired:\n\n"
875 " %" PRId64
" leaked clusters\n"
876 " %" PRId64
" corruptions\n\n"
877 "Double checking the fixed image now...\n",
879 check
->corruptions_fixed
);
882 qapi_free_ImageCheck(check
);
883 check
= g_new0(ImageCheck
, 1);
884 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
886 check
->leaks_fixed
= leaks_fixed
;
887 check
->has_leaks_fixed
= has_leaks_fixed
;
888 check
->corruptions_fixed
= corruptions_fixed
;
889 check
->has_corruptions_fixed
= has_corruptions_fixed
;
893 switch (output_format
) {
895 dump_human_image_check(check
, quiet
);
898 dump_json_image_check(check
, quiet
);
903 if (ret
|| check
->check_errors
) {
905 error_report("Check failed: %s", strerror(-ret
));
907 error_report("Check failed");
913 if (check
->corruptions
) {
915 } else if (check
->leaks
) {
922 qapi_free_ImageCheck(check
);
927 typedef struct CommonBlockJobCBInfo
{
928 BlockDriverState
*bs
;
930 } CommonBlockJobCBInfo
;
932 static void common_block_job_cb(void *opaque
, int ret
)
934 CommonBlockJobCBInfo
*cbi
= opaque
;
937 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
941 static void run_block_job(BlockJob
*job
, Error
**errp
)
943 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
946 aio_context_acquire(aio_context
);
949 float progress
= 0.0f
;
950 aio_poll(aio_context
, true);
951 if (job
->job
.progress
.total
) {
952 progress
= (float)job
->job
.progress
.current
/
953 job
->job
.progress
.total
* 100.f
;
955 qemu_progress_print(progress
, 0);
956 } while (!job_is_ready(&job
->job
) && !job_is_completed(&job
->job
));
958 if (!job_is_completed(&job
->job
)) {
959 ret
= job_complete_sync(&job
->job
, errp
);
963 job_unref(&job
->job
);
964 aio_context_release(aio_context
);
966 /* publish completion progress only when success */
968 qemu_progress_print(100.f
, 0);
972 static int img_commit(int argc
, char **argv
)
975 const char *filename
, *fmt
, *cache
, *base
;
977 BlockDriverState
*bs
, *base_bs
;
979 bool progress
= false, quiet
= false, drop
= false;
981 Error
*local_err
= NULL
;
982 CommonBlockJobCBInfo cbi
;
983 bool image_opts
= false;
984 AioContext
*aio_context
;
985 int64_t rate_limit
= 0;
988 cache
= BDRV_DEFAULT_CACHE
;
991 static const struct option long_options
[] = {
992 {"help", no_argument
, 0, 'h'},
993 {"object", required_argument
, 0, OPTION_OBJECT
},
994 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
997 c
= getopt_long(argc
, argv
, ":f:ht:b:dpqr:",
1004 missing_argument(argv
[optind
- 1]);
1007 unrecognized_option(argv
[optind
- 1]);
1033 rate_limit
= cvtnum("rate limit", optarg
);
1034 if (rate_limit
< 0) {
1038 case OPTION_OBJECT
: {
1040 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1046 case OPTION_IMAGE_OPTS
:
1052 /* Progress is not shown in Quiet mode */
1057 if (optind
!= argc
- 1) {
1058 error_exit("Expecting one image file name");
1060 filename
= argv
[optind
++];
1062 if (qemu_opts_foreach(&qemu_object_opts
,
1063 user_creatable_add_opts_foreach
,
1064 qemu_img_object_print_help
, &error_fatal
)) {
1068 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
1069 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1071 error_report("Invalid cache option: %s", cache
);
1075 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
1082 qemu_progress_init(progress
, 1.f
);
1083 qemu_progress_print(0.f
, 100);
1086 base_bs
= bdrv_find_backing_image(bs
, base
);
1088 error_setg(&local_err
,
1089 "Did not find '%s' in the backing chain of '%s'",
1094 /* This is different from QMP, which by default uses the deepest file in
1095 * the backing chain (i.e., the very base); however, the traditional
1096 * behavior of qemu-img commit is using the immediate backing file. */
1097 base_bs
= bdrv_backing_chain_next(bs
);
1099 error_setg(&local_err
, "Image does not have a backing file");
1104 cbi
= (CommonBlockJobCBInfo
){
1109 aio_context
= bdrv_get_aio_context(bs
);
1110 aio_context_acquire(aio_context
);
1111 commit_active_start("commit", bs
, base_bs
, JOB_DEFAULT
, rate_limit
,
1112 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1113 &cbi
, false, &local_err
);
1114 aio_context_release(aio_context
);
1119 /* When the block job completes, the BlockBackend reference will point to
1120 * the old backing file. In order to avoid that the top image is already
1121 * deleted, so we can still empty it afterwards, increment the reference
1122 * counter here preemptively. */
1127 job
= block_job_get("commit");
1129 run_block_job(job
, &local_err
);
1135 BlockBackend
*old_backing_blk
;
1137 old_backing_blk
= blk_new_with_bs(bs
, BLK_PERM_WRITE
, BLK_PERM_ALL
,
1139 if (!old_backing_blk
) {
1142 ret
= blk_make_empty(old_backing_blk
, &local_err
);
1143 blk_unref(old_backing_blk
);
1144 if (ret
== -ENOTSUP
) {
1145 error_free(local_err
);
1147 } else if (ret
< 0) {
1158 qemu_progress_end();
1163 error_report_err(local_err
);
1167 qprintf(quiet
, "Image committed.\n");
1172 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1173 * of the first sector boundary within buf where the sector contains a
1174 * non-zero byte. This function is robust to a buffer that is not
1177 static int64_t find_nonzero(const uint8_t *buf
, int64_t n
)
1180 int64_t end
= QEMU_ALIGN_DOWN(n
, BDRV_SECTOR_SIZE
);
1182 for (i
= 0; i
< end
; i
+= BDRV_SECTOR_SIZE
) {
1183 if (!buffer_is_zero(buf
+ i
, BDRV_SECTOR_SIZE
)) {
1187 if (i
< n
&& !buffer_is_zero(buf
+ i
, n
- end
)) {
1194 * Returns true iff the first sector pointed to by 'buf' contains at least
1197 * 'pnum' is set to the number of sectors (including and immediately following
1198 * the first one) that are known to be in the same allocated/unallocated state.
1199 * The function will try to align the end offset to alignment boundaries so
1200 * that the request will at least end aligned and consecutive requests will
1201 * also start at an aligned offset.
1203 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
,
1204 int64_t sector_num
, int alignment
)
1213 is_zero
= buffer_is_zero(buf
, BDRV_SECTOR_SIZE
);
1214 for(i
= 1; i
< n
; i
++) {
1215 buf
+= BDRV_SECTOR_SIZE
;
1216 if (is_zero
!= buffer_is_zero(buf
, BDRV_SECTOR_SIZE
)) {
1221 tail
= (sector_num
+ i
) & (alignment
- 1);
1223 if (is_zero
&& i
<= tail
) {
1224 /* treat unallocated areas which only consist
1225 * of a small tail as allocated. */
1229 /* align up end offset of allocated areas. */
1230 i
+= alignment
- tail
;
1233 /* align down end offset of zero areas. */
1242 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1243 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1244 * breaking up write requests for only small sparse areas.
1246 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1247 int min
, int64_t sector_num
, int alignment
)
1250 int num_checked
, num_used
;
1256 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1262 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1264 sector_num
+= *pnum
;
1265 num_checked
= num_used
;
1268 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1270 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1272 sector_num
+= *pnum
;
1273 num_checked
+= *pnum
;
1275 num_used
= num_checked
;
1276 } else if (*pnum
>= min
) {
1286 * Compares two buffers sector by sector. Returns 0 if the first
1287 * sector of each buffer matches, non-zero otherwise.
1289 * pnum is set to the sector-aligned size of the buffer prefix that
1290 * has the same matching status as the first sector.
1292 static int compare_buffers(const uint8_t *buf1
, const uint8_t *buf2
,
1293 int64_t bytes
, int64_t *pnum
)
1296 int64_t i
= MIN(bytes
, BDRV_SECTOR_SIZE
);
1300 res
= !!memcmp(buf1
, buf2
, i
);
1302 int64_t len
= MIN(bytes
- i
, BDRV_SECTOR_SIZE
);
1304 if (!!memcmp(buf1
+ i
, buf2
+ i
, len
) != res
) {
1314 #define IO_BUF_SIZE (2 * MiB)
1317 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1319 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1320 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1321 * failure), and 4 on error (the exit status for read errors), after emitting
1324 * @param blk: BlockBackend for the image
1325 * @param offset: Starting offset to check
1326 * @param bytes: Number of bytes to check
1327 * @param filename: Name of disk file we are checking (logging purpose)
1328 * @param buffer: Allocated buffer for storing read data
1329 * @param quiet: Flag for quiet mode
1331 static int check_empty_sectors(BlockBackend
*blk
, int64_t offset
,
1332 int64_t bytes
, const char *filename
,
1333 uint8_t *buffer
, bool quiet
)
1338 ret
= blk_pread(blk
, offset
, buffer
, bytes
);
1340 error_report("Error while reading offset %" PRId64
" of %s: %s",
1341 offset
, filename
, strerror(-ret
));
1344 idx
= find_nonzero(buffer
, bytes
);
1346 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1355 * Compares two images. Exit codes:
1357 * 0 - Images are identical
1359 * >1 - Error occurred
1361 static int img_compare(int argc
, char **argv
)
1363 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1364 BlockBackend
*blk1
, *blk2
;
1365 BlockDriverState
*bs1
, *bs2
;
1366 int64_t total_size1
, total_size2
;
1367 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1368 int64_t pnum1
, pnum2
;
1369 int allocated1
, allocated2
;
1370 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1371 bool progress
= false, quiet
= false, strict
= false;
1378 uint64_t progress_base
;
1379 bool image_opts
= false;
1380 bool force_share
= false;
1382 cache
= BDRV_DEFAULT_CACHE
;
1384 static const struct option long_options
[] = {
1385 {"help", no_argument
, 0, 'h'},
1386 {"object", required_argument
, 0, OPTION_OBJECT
},
1387 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1388 {"force-share", no_argument
, 0, 'U'},
1391 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1392 long_options
, NULL
);
1398 missing_argument(argv
[optind
- 1]);
1401 unrecognized_option(argv
[optind
- 1]);
1427 case OPTION_OBJECT
: {
1429 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1436 case OPTION_IMAGE_OPTS
:
1442 /* Progress is not shown in Quiet mode */
1448 if (optind
!= argc
- 2) {
1449 error_exit("Expecting two image file names");
1451 filename1
= argv
[optind
++];
1452 filename2
= argv
[optind
++];
1454 if (qemu_opts_foreach(&qemu_object_opts
,
1455 user_creatable_add_opts_foreach
,
1456 qemu_img_object_print_help
, &error_fatal
)) {
1461 /* Initialize before goto out */
1462 qemu_progress_init(progress
, 2.0);
1465 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1467 error_report("Invalid source cache option: %s", cache
);
1472 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1479 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1488 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1489 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1490 total_size1
= blk_getlength(blk1
);
1491 if (total_size1
< 0) {
1492 error_report("Can't get size of %s: %s",
1493 filename1
, strerror(-total_size1
));
1497 total_size2
= blk_getlength(blk2
);
1498 if (total_size2
< 0) {
1499 error_report("Can't get size of %s: %s",
1500 filename2
, strerror(-total_size2
));
1504 total_size
= MIN(total_size1
, total_size2
);
1505 progress_base
= MAX(total_size1
, total_size2
);
1507 qemu_progress_print(0, 100);
1509 if (strict
&& total_size1
!= total_size2
) {
1511 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1515 while (offset
< total_size
) {
1516 int status1
, status2
;
1518 status1
= bdrv_block_status_above(bs1
, NULL
, offset
,
1519 total_size1
- offset
, &pnum1
, NULL
,
1523 error_report("Sector allocation test failed for %s", filename1
);
1526 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1528 status2
= bdrv_block_status_above(bs2
, NULL
, offset
,
1529 total_size2
- offset
, &pnum2
, NULL
,
1533 error_report("Sector allocation test failed for %s", filename2
);
1536 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1538 assert(pnum1
&& pnum2
);
1539 chunk
= MIN(pnum1
, pnum2
);
1542 if (status1
!= status2
) {
1544 qprintf(quiet
, "Strict mode: Offset %" PRId64
1545 " block status mismatch!\n", offset
);
1549 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1551 } else if (allocated1
== allocated2
) {
1555 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1556 ret
= blk_pread(blk1
, offset
, buf1
, chunk
);
1558 error_report("Error while reading offset %" PRId64
1560 offset
, filename1
, strerror(-ret
));
1564 ret
= blk_pread(blk2
, offset
, buf2
, chunk
);
1566 error_report("Error while reading offset %" PRId64
1568 offset
, filename2
, strerror(-ret
));
1572 ret
= compare_buffers(buf1
, buf2
, chunk
, &pnum
);
1573 if (ret
|| pnum
!= chunk
) {
1574 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1575 offset
+ (ret
? 0 : pnum
));
1581 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1583 ret
= check_empty_sectors(blk1
, offset
, chunk
,
1584 filename1
, buf1
, quiet
);
1586 ret
= check_empty_sectors(blk2
, offset
, chunk
,
1587 filename2
, buf1
, quiet
);
1594 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1597 if (total_size1
!= total_size2
) {
1598 BlockBackend
*blk_over
;
1599 const char *filename_over
;
1601 qprintf(quiet
, "Warning: Image size mismatch!\n");
1602 if (total_size1
> total_size2
) {
1604 filename_over
= filename1
;
1607 filename_over
= filename2
;
1610 while (offset
< progress_base
) {
1611 ret
= bdrv_block_status_above(blk_bs(blk_over
), NULL
, offset
,
1612 progress_base
- offset
, &chunk
,
1616 error_report("Sector allocation test failed for %s",
1621 if (ret
& BDRV_BLOCK_ALLOCATED
&& !(ret
& BDRV_BLOCK_ZERO
)) {
1622 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1623 ret
= check_empty_sectors(blk_over
, offset
, chunk
,
1624 filename_over
, buf1
, quiet
);
1630 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1634 qprintf(quiet
, "Images are identical.\n");
1644 qemu_progress_end();
1649 /* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1650 static void do_dirty_bitmap_merge(const char *dst_node
, const char *dst_name
,
1651 const char *src_node
, const char *src_name
,
1654 BlockDirtyBitmapMergeSource
*merge_src
;
1655 BlockDirtyBitmapMergeSourceList
*list
= NULL
;
1657 merge_src
= g_new0(BlockDirtyBitmapMergeSource
, 1);
1658 merge_src
->type
= QTYPE_QDICT
;
1659 merge_src
->u
.external
.node
= g_strdup(src_node
);
1660 merge_src
->u
.external
.name
= g_strdup(src_name
);
1661 QAPI_LIST_PREPEND(list
, merge_src
);
1662 qmp_block_dirty_bitmap_merge(dst_node
, dst_name
, list
, errp
);
1663 qapi_free_BlockDirtyBitmapMergeSourceList(list
);
1666 enum ImgConvertBlockStatus
{
1672 #define MAX_COROUTINES 16
1673 #define CONVERT_THROTTLE_GROUP "img_convert"
1675 typedef struct ImgConvertState
{
1677 int64_t *src_sectors
;
1680 int64_t total_sectors
;
1681 int64_t allocated_sectors
;
1682 int64_t allocated_done
;
1685 enum ImgConvertBlockStatus status
;
1686 int64_t sector_next_status
;
1687 BlockBackend
*target
;
1691 bool target_has_backing
;
1692 int64_t target_backing_sectors
; /* negative if unknown */
1699 size_t cluster_sectors
;
1701 long num_coroutines
;
1702 int running_coroutines
;
1703 Coroutine
*co
[MAX_COROUTINES
];
1704 int64_t wait_sector_num
[MAX_COROUTINES
];
1709 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1710 int *src_cur
, int64_t *src_cur_offset
)
1713 *src_cur_offset
= 0;
1714 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1715 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1717 assert(*src_cur
< s
->src_num
);
1721 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1723 int64_t src_cur_offset
;
1724 int ret
, n
, src_cur
;
1725 bool post_backing_zero
= false;
1727 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1729 assert(s
->total_sectors
> sector_num
);
1730 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1732 if (s
->target_backing_sectors
>= 0) {
1733 if (sector_num
>= s
->target_backing_sectors
) {
1734 post_backing_zero
= true;
1735 } else if (sector_num
+ n
> s
->target_backing_sectors
) {
1736 /* Split requests around target_backing_sectors (because
1737 * starting from there, zeros are handled differently) */
1738 n
= s
->target_backing_sectors
- sector_num
;
1742 if (s
->sector_next_status
<= sector_num
) {
1743 uint64_t offset
= (sector_num
- src_cur_offset
) * BDRV_SECTOR_SIZE
;
1746 BlockDriverState
*src_bs
= blk_bs(s
->src
[src_cur
]);
1747 BlockDriverState
*base
;
1749 if (s
->target_has_backing
) {
1750 base
= bdrv_cow_bs(bdrv_skip_filters(src_bs
));
1756 count
= n
* BDRV_SECTOR_SIZE
;
1758 ret
= bdrv_block_status_above(src_bs
, base
, offset
, count
, &count
,
1765 warn_report("error while reading block status at "
1766 "offset %" PRIu64
": %s", offset
,
1769 /* Just try to read the data, then */
1770 ret
= BDRV_BLOCK_DATA
;
1771 count
= BDRV_SECTOR_SIZE
;
1773 /* Retry on a shorter range */
1774 n
= DIV_ROUND_UP(n
, 4);
1777 error_report("error while reading block status at offset "
1778 "%" PRIu64
": %s", offset
, strerror(-ret
));
1784 n
= DIV_ROUND_UP(count
, BDRV_SECTOR_SIZE
);
1787 * Avoid that s->sector_next_status becomes unaligned to the source
1788 * request alignment and/or cluster size to avoid unnecessary read
1791 tail
= (sector_num
- src_cur_offset
+ n
) % s
->src_alignment
[src_cur
];
1796 if (ret
& BDRV_BLOCK_ZERO
) {
1797 s
->status
= post_backing_zero
? BLK_BACKING_FILE
: BLK_ZERO
;
1798 } else if (ret
& BDRV_BLOCK_DATA
) {
1799 s
->status
= BLK_DATA
;
1801 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1804 s
->sector_next_status
= sector_num
+ n
;
1807 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1808 if (s
->status
== BLK_DATA
) {
1809 n
= MIN(n
, s
->buf_sectors
);
1812 /* We need to write complete clusters for compressed images, so if an
1813 * unallocated area is shorter than that, we must consider the whole
1814 * cluster allocated. */
1815 if (s
->compressed
) {
1816 if (n
< s
->cluster_sectors
) {
1817 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1818 s
->status
= BLK_DATA
;
1820 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1827 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1828 int nb_sectors
, uint8_t *buf
)
1830 uint64_t single_read_until
= 0;
1833 assert(nb_sectors
<= s
->buf_sectors
);
1834 while (nb_sectors
> 0) {
1837 int64_t bs_sectors
, src_cur_offset
;
1840 /* In the case of compression with multiple source files, we can get a
1841 * nb_sectors that spreads into the next part. So we must be able to
1842 * read across multiple BDSes for one convert_read() call. */
1843 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1844 blk
= s
->src
[src_cur
];
1845 bs_sectors
= s
->src_sectors
[src_cur
];
1847 offset
= (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
;
1849 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1850 if (single_read_until
> offset
) {
1854 ret
= blk_co_pread(blk
, offset
, n
<< BDRV_SECTOR_BITS
, buf
, 0);
1858 single_read_until
= offset
+ (n
<< BDRV_SECTOR_BITS
);
1862 warn_report("error while reading offset %" PRIu64
1863 ": %s", offset
, strerror(-ret
));
1865 memset(buf
, 0, BDRV_SECTOR_SIZE
);
1874 buf
+= n
* BDRV_SECTOR_SIZE
;
1881 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1882 int nb_sectors
, uint8_t *buf
,
1883 enum ImgConvertBlockStatus status
)
1887 while (nb_sectors
> 0) {
1889 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1892 case BLK_BACKING_FILE
:
1893 /* If we have a backing file, leave clusters unallocated that are
1894 * unallocated in the source image, so that the backing file is
1895 * visible at the respective offset. */
1896 assert(s
->target_has_backing
);
1900 /* If we're told to keep the target fully allocated (-S 0) or there
1901 * is real non-zero data, we must write it. Otherwise we can treat
1902 * it as zero sectors.
1903 * Compressed clusters need to be written as a whole, so in that
1904 * case we can only save the write if the buffer is completely
1906 if (!s
->min_sparse
||
1908 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
,
1909 sector_num
, s
->alignment
)) ||
1911 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1913 ret
= blk_co_pwrite(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1914 n
<< BDRV_SECTOR_BITS
, buf
, flags
);
1923 if (s
->has_zero_init
) {
1924 assert(!s
->target_has_backing
);
1927 ret
= blk_co_pwrite_zeroes(s
->target
,
1928 sector_num
<< BDRV_SECTOR_BITS
,
1929 n
<< BDRV_SECTOR_BITS
,
1930 BDRV_REQ_MAY_UNMAP
);
1939 buf
+= n
* BDRV_SECTOR_SIZE
;
1945 static int coroutine_fn
convert_co_copy_range(ImgConvertState
*s
, int64_t sector_num
,
1950 while (nb_sectors
> 0) {
1953 int64_t bs_sectors
, src_cur_offset
;
1956 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1957 offset
= (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
;
1958 blk
= s
->src
[src_cur
];
1959 bs_sectors
= s
->src_sectors
[src_cur
];
1961 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1963 ret
= blk_co_copy_range(blk
, offset
, s
->target
,
1964 sector_num
<< BDRV_SECTOR_BITS
,
1965 n
<< BDRV_SECTOR_BITS
, 0, 0);
1976 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1978 ImgConvertState
*s
= opaque
;
1979 uint8_t *buf
= NULL
;
1983 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1984 if (s
->co
[i
] == qemu_coroutine_self()) {
1991 s
->running_coroutines
++;
1992 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1997 enum ImgConvertBlockStatus status
;
2000 qemu_co_mutex_lock(&s
->lock
);
2001 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
2002 qemu_co_mutex_unlock(&s
->lock
);
2005 n
= convert_iteration_sectors(s
, s
->sector_num
);
2007 qemu_co_mutex_unlock(&s
->lock
);
2011 /* save current sector and allocation status to local variables */
2012 sector_num
= s
->sector_num
;
2014 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
2015 n
= MIN(n
, s
->buf_sectors
);
2017 /* increment global sector counter so that other coroutines can
2018 * already continue reading beyond this request */
2020 qemu_co_mutex_unlock(&s
->lock
);
2022 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
2023 s
->allocated_done
+= n
;
2024 qemu_progress_print(100.0 * s
->allocated_done
/
2025 s
->allocated_sectors
, 0);
2029 copy_range
= s
->copy_range
&& s
->status
== BLK_DATA
;
2030 if (status
== BLK_DATA
&& !copy_range
) {
2031 ret
= convert_co_read(s
, sector_num
, n
, buf
);
2033 error_report("error while reading at byte %lld: %s",
2034 sector_num
* BDRV_SECTOR_SIZE
, strerror(-ret
));
2037 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
2039 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
2042 if (s
->wr_in_order
) {
2043 /* keep writes in order */
2044 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
2045 s
->wait_sector_num
[index
] = sector_num
;
2046 qemu_coroutine_yield();
2048 s
->wait_sector_num
[index
] = -1;
2051 if (s
->ret
== -EINPROGRESS
) {
2053 ret
= convert_co_copy_range(s
, sector_num
, n
);
2055 s
->copy_range
= false;
2059 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
2062 error_report("error while writing at byte %lld: %s",
2063 sector_num
* BDRV_SECTOR_SIZE
, strerror(-ret
));
2068 if (s
->wr_in_order
) {
2069 /* reenter the coroutine that might have waited
2070 * for this write to complete */
2071 s
->wr_offs
= sector_num
+ n
;
2072 for (i
= 0; i
< s
->num_coroutines
; i
++) {
2073 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
2075 * A -> B -> A cannot occur because A has
2076 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2077 * B will never enter A during this time window.
2079 qemu_coroutine_enter(s
->co
[i
]);
2087 s
->co
[index
] = NULL
;
2088 s
->running_coroutines
--;
2089 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
2090 /* the convert job finished successfully */
2095 static int convert_do_copy(ImgConvertState
*s
)
2098 int64_t sector_num
= 0;
2100 /* Check whether we have zero initialisation or can get it efficiently */
2101 if (!s
->has_zero_init
&& s
->target_is_new
&& s
->min_sparse
&&
2102 !s
->target_has_backing
) {
2103 s
->has_zero_init
= bdrv_has_zero_init(blk_bs(s
->target
));
2106 /* Allocate buffer for copied data. For compressed images, only one cluster
2107 * can be copied at a time. */
2108 if (s
->compressed
) {
2109 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
2110 error_report("invalid cluster size");
2113 s
->buf_sectors
= s
->cluster_sectors
;
2116 while (sector_num
< s
->total_sectors
) {
2117 n
= convert_iteration_sectors(s
, sector_num
);
2121 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
2123 s
->allocated_sectors
+= n
;
2129 s
->sector_next_status
= 0;
2130 s
->ret
= -EINPROGRESS
;
2132 qemu_co_mutex_init(&s
->lock
);
2133 for (i
= 0; i
< s
->num_coroutines
; i
++) {
2134 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
2135 s
->wait_sector_num
[i
] = -1;
2136 qemu_coroutine_enter(s
->co
[i
]);
2139 while (s
->running_coroutines
) {
2140 main_loop_wait(false);
2143 if (s
->compressed
&& !s
->ret
) {
2144 /* signal EOF to align */
2145 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
2154 static int convert_copy_bitmaps(BlockDriverState
*src
, BlockDriverState
*dst
)
2156 BdrvDirtyBitmap
*bm
;
2159 FOR_EACH_DIRTY_BITMAP(src
, bm
) {
2162 if (!bdrv_dirty_bitmap_get_persistence(bm
)) {
2165 name
= bdrv_dirty_bitmap_name(bm
);
2166 qmp_block_dirty_bitmap_add(dst
->node_name
, name
,
2167 true, bdrv_dirty_bitmap_granularity(bm
),
2169 true, !bdrv_dirty_bitmap_enabled(bm
),
2172 error_reportf_err(err
, "Failed to create bitmap %s: ", name
);
2176 do_dirty_bitmap_merge(dst
->node_name
, name
, src
->node_name
, name
,
2179 error_reportf_err(err
, "Failed to populate bitmap %s: ", name
);
2187 #define MAX_BUF_SECTORS 32768
2189 static void set_rate_limit(BlockBackend
*blk
, int64_t rate_limit
)
2193 throttle_config_init(&cfg
);
2194 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= rate_limit
;
2196 blk_io_limits_enable(blk
, CONVERT_THROTTLE_GROUP
);
2197 blk_set_io_limits(blk
, &cfg
);
2200 static int img_convert(int argc
, char **argv
)
2202 int c
, bs_i
, flags
, src_flags
= 0;
2203 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
2204 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
2205 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
2206 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
2207 BlockDriverInfo bdi
;
2208 BlockDriverState
*out_bs
;
2209 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
2210 QemuOptsList
*create_opts
= NULL
;
2211 QDict
*open_opts
= NULL
;
2212 char *options
= NULL
;
2213 Error
*local_err
= NULL
;
2214 bool writethrough
, src_writethrough
, image_opts
= false,
2215 skip_create
= false, progress
= false, tgt_image_opts
= false;
2216 int64_t ret
= -EINVAL
;
2217 bool force_share
= false;
2218 bool explict_min_sparse
= false;
2219 bool bitmaps
= false;
2220 int64_t rate_limit
= 0;
2222 ImgConvertState s
= (ImgConvertState
) {
2223 /* Need at least 4k of zeros for sparse detection */
2225 .copy_range
= false,
2226 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
2227 .wr_in_order
= true,
2228 .num_coroutines
= 8,
2232 static const struct option long_options
[] = {
2233 {"help", no_argument
, 0, 'h'},
2234 {"object", required_argument
, 0, OPTION_OBJECT
},
2235 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2236 {"force-share", no_argument
, 0, 'U'},
2237 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
2238 {"salvage", no_argument
, 0, OPTION_SALVAGE
},
2239 {"target-is-zero", no_argument
, 0, OPTION_TARGET_IS_ZERO
},
2240 {"bitmaps", no_argument
, 0, OPTION_BITMAPS
},
2243 c
= getopt_long(argc
, argv
, ":hf:O:B:Cco:l:S:pt:T:qnm:WUr:",
2244 long_options
, NULL
);
2250 missing_argument(argv
[optind
- 1]);
2253 unrecognized_option(argv
[optind
- 1]);
2265 out_baseimg
= optarg
;
2268 s
.copy_range
= true;
2271 s
.compressed
= true;
2274 if (accumulate_options(&options
, optarg
) < 0) {
2279 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2280 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2283 error_report("Failed in parsing snapshot param '%s'",
2288 snapshot_name
= optarg
;
2295 sval
= cvtnum("buffer size for sparse output", optarg
);
2298 } else if (!QEMU_IS_ALIGNED(sval
, BDRV_SECTOR_SIZE
) ||
2299 sval
/ BDRV_SECTOR_SIZE
> MAX_BUF_SECTORS
) {
2300 error_report("Invalid buffer size for sparse output specified. "
2301 "Valid sizes are multiples of %llu up to %llu. Select "
2302 "0 to disable sparse detection (fully allocates output).",
2303 BDRV_SECTOR_SIZE
, MAX_BUF_SECTORS
* BDRV_SECTOR_SIZE
);
2307 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2308 explict_min_sparse
= true;
2327 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2328 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2329 error_report("Invalid number of coroutines. Allowed number of"
2330 " coroutines is between 1 and %d", MAX_COROUTINES
);
2335 s
.wr_in_order
= false;
2341 rate_limit
= cvtnum("rate limit", optarg
);
2342 if (rate_limit
< 0) {
2346 case OPTION_OBJECT
: {
2347 QemuOpts
*object_opts
;
2348 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2355 case OPTION_IMAGE_OPTS
:
2358 case OPTION_SALVAGE
:
2361 case OPTION_TARGET_IMAGE_OPTS
:
2362 tgt_image_opts
= true;
2364 case OPTION_TARGET_IS_ZERO
:
2366 * The user asserting that the target is blank has the
2367 * same effect as the target driver supporting zero
2370 s
.has_zero_init
= true;
2372 case OPTION_BITMAPS
:
2378 if (!out_fmt
&& !tgt_image_opts
) {
2382 if (qemu_opts_foreach(&qemu_object_opts
,
2383 user_creatable_add_opts_foreach
,
2384 qemu_img_object_print_help
, &error_fatal
)) {
2388 if (s
.compressed
&& s
.copy_range
) {
2389 error_report("Cannot enable copy offloading when -c is used");
2393 if (explict_min_sparse
&& s
.copy_range
) {
2394 error_report("Cannot enable copy offloading when -S is used");
2398 if (s
.copy_range
&& s
.salvage
) {
2399 error_report("Cannot use copy offloading in salvaging mode");
2403 if (tgt_image_opts
&& !skip_create
) {
2404 error_report("--target-image-opts requires use of -n flag");
2408 if (skip_create
&& options
) {
2409 error_report("-o has no effect when skipping image creation");
2413 if (s
.has_zero_init
&& !skip_create
) {
2414 error_report("--target-is-zero requires use of -n flag");
2418 s
.src_num
= argc
- optind
- 1;
2419 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2421 if (options
&& has_help_option(options
)) {
2423 ret
= print_block_option_help(out_filename
, out_fmt
);
2426 error_report("Option help requires a format be specified");
2431 if (s
.src_num
< 1) {
2432 error_report("Must specify image file name");
2436 /* ret is still -EINVAL until here */
2437 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2439 error_report("Invalid source cache option: %s", src_cache
);
2443 /* Initialize before goto out */
2447 qemu_progress_init(progress
, 1.0);
2448 qemu_progress_print(0, 100);
2450 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2451 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2452 s
.src_alignment
= g_new(int, s
.src_num
);
2454 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2455 BlockDriverState
*src_bs
;
2456 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2457 fmt
, src_flags
, src_writethrough
, s
.quiet
,
2463 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2464 if (s
.src_sectors
[bs_i
] < 0) {
2465 error_report("Could not get size of %s: %s",
2466 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2470 src_bs
= blk_bs(s
.src
[bs_i
]);
2471 s
.src_alignment
[bs_i
] = DIV_ROUND_UP(src_bs
->bl
.request_alignment
,
2473 if (!bdrv_get_info(src_bs
, &bdi
)) {
2474 s
.src_alignment
[bs_i
] = MAX(s
.src_alignment
[bs_i
],
2475 bdi
.cluster_size
/ BDRV_SECTOR_SIZE
);
2477 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2481 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2482 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2483 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2485 } else if (snapshot_name
!= NULL
) {
2486 if (s
.src_num
> 1) {
2487 error_report("No support for concatenating multiple snapshot");
2492 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2496 error_reportf_err(local_err
, "Failed to load snapshot: ");
2502 /* Find driver and parse its options */
2503 drv
= bdrv_find_format(out_fmt
);
2505 error_report("Unknown file format '%s'", out_fmt
);
2510 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2512 error_report_err(local_err
);
2517 if (!drv
->create_opts
) {
2518 error_report("Format driver '%s' does not support image creation",
2524 if (!proto_drv
->create_opts
) {
2525 error_report("Protocol driver '%s' does not support image creation",
2526 proto_drv
->format_name
);
2531 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2532 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2534 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2536 if (!qemu_opts_do_parse(opts
, options
, NULL
, &local_err
)) {
2537 error_report_err(local_err
);
2543 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
2544 s
.total_sectors
* BDRV_SECTOR_SIZE
, &error_abort
);
2545 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2551 /* Get backing file name if -o backing_file was used */
2552 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2553 if (out_baseimg_param
) {
2554 out_baseimg
= out_baseimg_param
;
2556 s
.target_has_backing
= (bool) out_baseimg
;
2558 if (s
.has_zero_init
&& s
.target_has_backing
) {
2559 error_report("Cannot use --target-is-zero when the destination "
2560 "image has a backing file");
2564 if (s
.src_num
> 1 && out_baseimg
) {
2565 error_report("Having a backing file for the target makes no sense when "
2566 "concatenating multiple input images");
2571 if (out_baseimg_param
) {
2572 if (!qemu_opt_get(opts
, BLOCK_OPT_BACKING_FMT
)) {
2573 warn_report("Deprecated use of backing file without explicit "
2578 /* Check if compression is supported */
2581 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2582 const char *encryptfmt
=
2583 qemu_opt_get(opts
, BLOCK_OPT_ENCRYPT_FORMAT
);
2584 const char *preallocation
=
2585 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2587 if (drv
&& !block_driver_can_compress(drv
)) {
2588 error_report("Compression not supported for this file format");
2593 if (encryption
|| encryptfmt
) {
2594 error_report("Compression and encryption not supported at "
2601 && strcmp(preallocation
, "off"))
2603 error_report("Compression and preallocation not supported at "
2610 /* Determine if bitmaps need copying */
2612 if (s
.src_num
> 1) {
2613 error_report("Copying bitmaps only possible with single source");
2617 if (!bdrv_supports_persistent_dirty_bitmap(blk_bs(s
.src
[0]))) {
2618 error_report("Source lacks bitmap support");
2625 * The later open call will need any decryption secrets, and
2626 * bdrv_create() will purge "opts", so extract them now before
2630 open_opts
= qdict_new();
2631 qemu_opt_foreach(opts
, img_add_key_secrets
, open_opts
, &error_abort
);
2633 /* Create the new image */
2634 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2636 error_reportf_err(local_err
, "%s: error while converting %s: ",
2637 out_filename
, out_fmt
);
2642 s
.target_is_new
= !skip_create
;
2644 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2645 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2647 error_report("Invalid cache option: %s", cache
);
2652 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2653 flags
, writethrough
, s
.quiet
, false);
2655 /* TODO ultimately we should allow --target-image-opts
2656 * to be used even when -n is not given.
2657 * That has to wait for bdrv_create to be improved
2658 * to allow filenames in option syntax
2660 s
.target
= img_open_file(out_filename
, open_opts
, out_fmt
,
2661 flags
, writethrough
, s
.quiet
, false);
2662 open_opts
= NULL
; /* blk_new_open will have freed it */
2668 out_bs
= blk_bs(s
.target
);
2670 if (bitmaps
&& !bdrv_supports_persistent_dirty_bitmap(out_bs
)) {
2671 error_report("Format driver '%s' does not support bitmaps",
2672 out_bs
->drv
->format_name
);
2677 if (s
.compressed
&& !block_driver_can_compress(out_bs
->drv
)) {
2678 error_report("Compression not supported for this file format");
2683 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2684 * or discard_alignment of the out_bs is greater. Limit to
2685 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2686 s
.buf_sectors
= MIN(MAX_BUF_SECTORS
,
2688 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2689 out_bs
->bl
.pdiscard_alignment
>>
2690 BDRV_SECTOR_BITS
)));
2692 /* try to align the write requests to the destination to avoid unnecessary
2694 s
.alignment
= MAX(pow2floor(s
.min_sparse
),
2695 DIV_ROUND_UP(out_bs
->bl
.request_alignment
,
2697 assert(is_power_of_2(s
.alignment
));
2700 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2701 if (output_sectors
< 0) {
2702 error_report("unable to get output image length: %s",
2703 strerror(-output_sectors
));
2706 } else if (output_sectors
< s
.total_sectors
) {
2707 error_report("output file is smaller than input file");
2713 if (s
.target_has_backing
&& s
.target_is_new
) {
2714 /* Errors are treated as "backing length unknown" (which means
2715 * s.target_backing_sectors has to be negative, which it will
2716 * be automatically). The backing file length is used only
2717 * for optimizations, so such a case is not fatal. */
2718 s
.target_backing_sectors
=
2719 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs
));
2721 s
.target_backing_sectors
= -1;
2724 ret
= bdrv_get_info(out_bs
, &bdi
);
2727 error_report("could not get block driver info");
2731 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2732 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2736 set_rate_limit(s
.target
, rate_limit
);
2739 ret
= convert_do_copy(&s
);
2741 /* Now copy the bitmaps */
2742 if (bitmaps
&& ret
== 0) {
2743 ret
= convert_copy_bitmaps(blk_bs(s
.src
[0]), out_bs
);
2748 qemu_progress_print(100, 0);
2750 qemu_progress_end();
2751 qemu_opts_del(opts
);
2752 qemu_opts_free(create_opts
);
2753 qobject_unref(open_opts
);
2754 blk_unref(s
.target
);
2756 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2757 blk_unref(s
.src
[bs_i
]);
2761 g_free(s
.src_sectors
);
2762 g_free(s
.src_alignment
);
2764 qemu_opts_del(sn_opts
);
2771 static void dump_snapshots(BlockDriverState
*bs
)
2773 QEMUSnapshotInfo
*sn_tab
, *sn
;
2776 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2779 printf("Snapshot list:\n");
2780 bdrv_snapshot_dump(NULL
);
2782 for(i
= 0; i
< nb_sns
; i
++) {
2784 bdrv_snapshot_dump(sn
);
2790 static void dump_json_image_info_list(ImageInfoList
*list
)
2794 Visitor
*v
= qobject_output_visitor_new(&obj
);
2796 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2797 visit_complete(v
, &obj
);
2798 str
= qobject_to_json_pretty(obj
, true);
2799 assert(str
!= NULL
);
2800 printf("%s\n", qstring_get_str(str
));
2806 static void dump_json_image_info(ImageInfo
*info
)
2810 Visitor
*v
= qobject_output_visitor_new(&obj
);
2812 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2813 visit_complete(v
, &obj
);
2814 str
= qobject_to_json_pretty(obj
, true);
2815 assert(str
!= NULL
);
2816 printf("%s\n", qstring_get_str(str
));
2822 static void dump_human_image_info_list(ImageInfoList
*list
)
2824 ImageInfoList
*elem
;
2827 for (elem
= list
; elem
; elem
= elem
->next
) {
2833 bdrv_image_info_dump(elem
->value
);
2837 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2839 return strcmp(a
, b
) == 0;
2843 * Open an image file chain and return an ImageInfoList
2845 * @filename: topmost image filename
2846 * @fmt: topmost image format (may be NULL to autodetect)
2847 * @chain: true - enumerate entire backing file chain
2848 * false - only topmost image file
2850 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2851 * image file. If there was an error a message will have been printed to
2854 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2855 const char *filename
,
2857 bool chain
, bool force_share
)
2859 ImageInfoList
*head
= NULL
;
2860 ImageInfoList
**last
= &head
;
2861 GHashTable
*filenames
;
2864 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2868 BlockDriverState
*bs
;
2870 ImageInfoList
*elem
;
2872 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2873 error_report("Backing file '%s' creates an infinite loop.",
2877 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2879 blk
= img_open(image_opts
, filename
, fmt
,
2880 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2887 bdrv_query_image_info(bs
, &info
, &err
);
2889 error_report_err(err
);
2894 elem
= g_new0(ImageInfoList
, 1);
2901 /* Clear parameters that only apply to the topmost image */
2902 filename
= fmt
= NULL
;
2906 if (info
->has_full_backing_filename
) {
2907 filename
= info
->full_backing_filename
;
2908 } else if (info
->has_backing_filename
) {
2909 error_report("Could not determine absolute backing filename,"
2910 " but backing filename '%s' present",
2911 info
->backing_filename
);
2914 if (info
->has_backing_filename_format
) {
2915 fmt
= info
->backing_filename_format
;
2919 g_hash_table_destroy(filenames
);
2923 qapi_free_ImageInfoList(head
);
2924 g_hash_table_destroy(filenames
);
2928 static int img_info(int argc
, char **argv
)
2931 OutputFormat output_format
= OFORMAT_HUMAN
;
2933 const char *filename
, *fmt
, *output
;
2934 ImageInfoList
*list
;
2935 bool image_opts
= false;
2936 bool force_share
= false;
2941 int option_index
= 0;
2942 static const struct option long_options
[] = {
2943 {"help", no_argument
, 0, 'h'},
2944 {"format", required_argument
, 0, 'f'},
2945 {"output", required_argument
, 0, OPTION_OUTPUT
},
2946 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2947 {"object", required_argument
, 0, OPTION_OBJECT
},
2948 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2949 {"force-share", no_argument
, 0, 'U'},
2952 c
= getopt_long(argc
, argv
, ":f:hU",
2953 long_options
, &option_index
);
2959 missing_argument(argv
[optind
- 1]);
2962 unrecognized_option(argv
[optind
- 1]);
2976 case OPTION_BACKING_CHAIN
:
2979 case OPTION_OBJECT
: {
2981 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2987 case OPTION_IMAGE_OPTS
:
2992 if (optind
!= argc
- 1) {
2993 error_exit("Expecting one image file name");
2995 filename
= argv
[optind
++];
2997 if (output
&& !strcmp(output
, "json")) {
2998 output_format
= OFORMAT_JSON
;
2999 } else if (output
&& !strcmp(output
, "human")) {
3000 output_format
= OFORMAT_HUMAN
;
3001 } else if (output
) {
3002 error_report("--output must be used with human or json as argument.");
3006 if (qemu_opts_foreach(&qemu_object_opts
,
3007 user_creatable_add_opts_foreach
,
3008 qemu_img_object_print_help
, &error_fatal
)) {
3012 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
3018 switch (output_format
) {
3020 dump_human_image_info_list(list
);
3024 dump_json_image_info_list(list
);
3026 dump_json_image_info(list
->value
);
3031 qapi_free_ImageInfoList(list
);
3035 static int dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
3038 switch (output_format
) {
3040 if (e
->data
&& !e
->has_offset
) {
3041 error_report("File contains external, encrypted or compressed clusters.");
3044 if (e
->data
&& !e
->zero
) {
3045 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
3046 e
->start
, e
->length
,
3047 e
->has_offset
? e
->offset
: 0,
3048 e
->has_filename
? e
->filename
: "");
3050 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3051 * Modify the flags here to allow more coalescing.
3053 if (next
&& (!next
->data
|| next
->zero
)) {
3059 printf("{ \"start\": %"PRId64
", \"length\": %"PRId64
","
3060 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
3061 e
->start
, e
->length
, e
->depth
,
3062 e
->zero
? "true" : "false",
3063 e
->data
? "true" : "false");
3064 if (e
->has_offset
) {
3065 printf(", \"offset\": %"PRId64
"", e
->offset
);
3077 static int get_block_status(BlockDriverState
*bs
, int64_t offset
,
3078 int64_t bytes
, MapEntry
*e
)
3082 BlockDriverState
*file
;
3085 char *filename
= NULL
;
3087 /* As an optimization, we could cache the current range of unallocated
3088 * clusters in each file of the chain, and avoid querying the same
3094 bs
= bdrv_skip_filters(bs
);
3095 ret
= bdrv_block_status(bs
, offset
, bytes
, &bytes
, &map
, &file
);
3100 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
3103 bs
= bdrv_cow_bs(bs
);
3112 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
3114 if (file
&& has_offset
) {
3115 bdrv_refresh_filename(file
);
3116 filename
= file
->filename
;
3122 .data
= !!(ret
& BDRV_BLOCK_DATA
),
3123 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
3125 .has_offset
= has_offset
,
3127 .has_filename
= filename
,
3128 .filename
= filename
,
3134 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
3136 if (curr
->length
== 0) {
3139 if (curr
->zero
!= next
->zero
||
3140 curr
->data
!= next
->data
||
3141 curr
->depth
!= next
->depth
||
3142 curr
->has_filename
!= next
->has_filename
||
3143 curr
->has_offset
!= next
->has_offset
) {
3146 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
3149 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
3155 static int img_map(int argc
, char **argv
)
3158 OutputFormat output_format
= OFORMAT_HUMAN
;
3160 BlockDriverState
*bs
;
3161 const char *filename
, *fmt
, *output
;
3163 MapEntry curr
= { .length
= 0 }, next
;
3165 bool image_opts
= false;
3166 bool force_share
= false;
3167 int64_t start_offset
= 0;
3168 int64_t max_length
= -1;
3173 int option_index
= 0;
3174 static const struct option long_options
[] = {
3175 {"help", no_argument
, 0, 'h'},
3176 {"format", required_argument
, 0, 'f'},
3177 {"output", required_argument
, 0, OPTION_OUTPUT
},
3178 {"object", required_argument
, 0, OPTION_OBJECT
},
3179 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3180 {"force-share", no_argument
, 0, 'U'},
3181 {"start-offset", required_argument
, 0, 's'},
3182 {"max-length", required_argument
, 0, 'l'},
3185 c
= getopt_long(argc
, argv
, ":f:s:l:hU",
3186 long_options
, &option_index
);
3192 missing_argument(argv
[optind
- 1]);
3195 unrecognized_option(argv
[optind
- 1]);
3210 start_offset
= cvtnum("start offset", optarg
);
3211 if (start_offset
< 0) {
3216 max_length
= cvtnum("max length", optarg
);
3217 if (max_length
< 0) {
3221 case OPTION_OBJECT
: {
3223 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3229 case OPTION_IMAGE_OPTS
:
3234 if (optind
!= argc
- 1) {
3235 error_exit("Expecting one image file name");
3237 filename
= argv
[optind
];
3239 if (output
&& !strcmp(output
, "json")) {
3240 output_format
= OFORMAT_JSON
;
3241 } else if (output
&& !strcmp(output
, "human")) {
3242 output_format
= OFORMAT_HUMAN
;
3243 } else if (output
) {
3244 error_report("--output must be used with human or json as argument.");
3248 if (qemu_opts_foreach(&qemu_object_opts
,
3249 user_creatable_add_opts_foreach
,
3250 qemu_img_object_print_help
, &error_fatal
)) {
3254 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
3260 if (output_format
== OFORMAT_HUMAN
) {
3261 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3262 } else if (output_format
== OFORMAT_JSON
) {
3266 length
= blk_getlength(blk
);
3268 error_report("Failed to get size for '%s'", filename
);
3271 if (max_length
!= -1) {
3272 length
= MIN(start_offset
+ max_length
, length
);
3275 curr
.start
= start_offset
;
3276 while (curr
.start
+ curr
.length
< length
) {
3277 int64_t offset
= curr
.start
+ curr
.length
;
3278 int64_t n
= length
- offset
;
3280 ret
= get_block_status(bs
, offset
, n
, &next
);
3282 error_report("Could not read file metadata: %s", strerror(-ret
));
3286 if (entry_mergeable(&curr
, &next
)) {
3287 curr
.length
+= next
.length
;
3291 if (curr
.length
> 0) {
3292 ret
= dump_map_entry(output_format
, &curr
, &next
);
3300 ret
= dump_map_entry(output_format
, &curr
, NULL
);
3301 if (output_format
== OFORMAT_JSON
) {
3310 #define SNAPSHOT_LIST 1
3311 #define SNAPSHOT_CREATE 2
3312 #define SNAPSHOT_APPLY 3
3313 #define SNAPSHOT_DELETE 4
3315 static int img_snapshot(int argc
, char **argv
)
3318 BlockDriverState
*bs
;
3319 QEMUSnapshotInfo sn
;
3320 char *filename
, *snapshot_name
= NULL
;
3321 int c
, ret
= 0, bdrv_oflags
;
3326 bool image_opts
= false;
3327 bool force_share
= false;
3329 bdrv_oflags
= BDRV_O_RDWR
;
3330 /* Parse commandline parameters */
3332 static const struct option long_options
[] = {
3333 {"help", no_argument
, 0, 'h'},
3334 {"object", required_argument
, 0, OPTION_OBJECT
},
3335 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3336 {"force-share", no_argument
, 0, 'U'},
3339 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
3340 long_options
, NULL
);
3346 missing_argument(argv
[optind
- 1]);
3349 unrecognized_option(argv
[optind
- 1]);
3356 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3359 action
= SNAPSHOT_LIST
;
3360 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
3364 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3367 action
= SNAPSHOT_APPLY
;
3368 snapshot_name
= optarg
;
3372 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3375 action
= SNAPSHOT_CREATE
;
3376 snapshot_name
= optarg
;
3380 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3383 action
= SNAPSHOT_DELETE
;
3384 snapshot_name
= optarg
;
3392 case OPTION_OBJECT
: {
3394 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3400 case OPTION_IMAGE_OPTS
:
3406 if (optind
!= argc
- 1) {
3407 error_exit("Expecting one image file name");
3409 filename
= argv
[optind
++];
3411 if (qemu_opts_foreach(&qemu_object_opts
,
3412 user_creatable_add_opts_foreach
,
3413 qemu_img_object_print_help
, &error_fatal
)) {
3417 /* Open the image */
3418 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
3425 /* Perform the requested action */
3431 case SNAPSHOT_CREATE
:
3432 memset(&sn
, 0, sizeof(sn
));
3433 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3435 qemu_gettimeofday(&tv
);
3436 sn
.date_sec
= tv
.tv_sec
;
3437 sn
.date_nsec
= tv
.tv_usec
* 1000;
3439 ret
= bdrv_snapshot_create(bs
, &sn
);
3441 error_report("Could not create snapshot '%s': %d (%s)",
3442 snapshot_name
, ret
, strerror(-ret
));
3446 case SNAPSHOT_APPLY
:
3447 ret
= bdrv_snapshot_goto(bs
, snapshot_name
, &err
);
3449 error_reportf_err(err
, "Could not apply snapshot '%s': ",
3454 case SNAPSHOT_DELETE
:
3455 ret
= bdrv_snapshot_find(bs
, &sn
, snapshot_name
);
3457 error_report("Could not delete snapshot '%s': snapshot not "
3458 "found", snapshot_name
);
3461 ret
= bdrv_snapshot_delete(bs
, sn
.id_str
, sn
.name
, &err
);
3463 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3479 static int img_rebase(int argc
, char **argv
)
3481 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3482 uint8_t *buf_old
= NULL
;
3483 uint8_t *buf_new
= NULL
;
3484 BlockDriverState
*bs
= NULL
, *prefix_chain_bs
= NULL
;
3485 BlockDriverState
*unfiltered_bs
;
3487 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3488 int c
, flags
, src_flags
, ret
;
3489 bool writethrough
, src_writethrough
;
3491 bool force_share
= false;
3494 Error
*local_err
= NULL
;
3495 bool image_opts
= false;
3497 /* Parse commandline parameters */
3499 cache
= BDRV_DEFAULT_CACHE
;
3500 src_cache
= BDRV_DEFAULT_CACHE
;
3504 static const struct option long_options
[] = {
3505 {"help", no_argument
, 0, 'h'},
3506 {"object", required_argument
, 0, OPTION_OBJECT
},
3507 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3508 {"force-share", no_argument
, 0, 'U'},
3511 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3512 long_options
, NULL
);
3518 missing_argument(argv
[optind
- 1]);
3521 unrecognized_option(argv
[optind
- 1]);
3530 out_basefmt
= optarg
;
3533 out_baseimg
= optarg
;
3550 case OPTION_OBJECT
: {
3552 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3558 case OPTION_IMAGE_OPTS
:
3571 if (optind
!= argc
- 1) {
3572 error_exit("Expecting one image file name");
3574 if (!unsafe
&& !out_baseimg
) {
3575 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3577 filename
= argv
[optind
++];
3579 if (qemu_opts_foreach(&qemu_object_opts
,
3580 user_creatable_add_opts_foreach
,
3581 qemu_img_object_print_help
, &error_fatal
)) {
3585 qemu_progress_init(progress
, 2.0);
3586 qemu_progress_print(0, 100);
3588 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3589 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3591 error_report("Invalid cache option: %s", cache
);
3596 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3598 error_report("Invalid source cache option: %s", src_cache
);
3602 /* The source files are opened read-only, don't care about WCE */
3603 assert((src_flags
& BDRV_O_RDWR
) == 0);
3604 (void) src_writethrough
;
3609 * Ignore the old backing file for unsafe rebase in case we want to correct
3610 * the reference to a renamed or moved backing file.
3612 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3620 unfiltered_bs
= bdrv_skip_filters(bs
);
3622 if (out_basefmt
!= NULL
) {
3623 if (bdrv_find_format(out_basefmt
) == NULL
) {
3624 error_report("Invalid format name: '%s'", out_basefmt
);
3630 /* For safe rebasing we need to compare old and new backing file */
3632 QDict
*options
= NULL
;
3633 BlockDriverState
*base_bs
= bdrv_cow_bs(unfiltered_bs
);
3636 blk_old_backing
= blk_new(qemu_get_aio_context(),
3637 BLK_PERM_CONSISTENT_READ
,
3639 ret
= blk_insert_bs(blk_old_backing
, base_bs
,
3642 error_reportf_err(local_err
,
3643 "Could not reuse old backing file '%s': ",
3648 blk_old_backing
= NULL
;
3651 if (out_baseimg
[0]) {
3652 const char *overlay_filename
;
3653 char *out_real_path
;
3655 options
= qdict_new();
3657 qdict_put_str(options
, "driver", out_basefmt
);
3660 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3663 bdrv_refresh_filename(bs
);
3664 overlay_filename
= bs
->exact_filename
[0] ? bs
->exact_filename
3667 bdrv_get_full_backing_filename_from_filename(overlay_filename
,
3671 qobject_unref(options
);
3672 error_reportf_err(local_err
,
3673 "Could not resolve backing filename: ");
3679 * Find out whether we rebase an image on top of a previous image
3682 prefix_chain_bs
= bdrv_find_backing_image(bs
, out_real_path
);
3683 if (prefix_chain_bs
) {
3684 qobject_unref(options
);
3685 g_free(out_real_path
);
3687 blk_new_backing
= blk_new(qemu_get_aio_context(),
3688 BLK_PERM_CONSISTENT_READ
,
3690 ret
= blk_insert_bs(blk_new_backing
, prefix_chain_bs
,
3693 error_reportf_err(local_err
,
3694 "Could not reuse backing file '%s': ",
3699 blk_new_backing
= blk_new_open(out_real_path
, NULL
,
3700 options
, src_flags
, &local_err
);
3701 g_free(out_real_path
);
3702 if (!blk_new_backing
) {
3703 error_reportf_err(local_err
,
3704 "Could not open new backing file '%s': ",
3714 * Check each unallocated cluster in the COW file. If it is unallocated,
3715 * accesses go to the backing file. We must therefore compare this cluster
3716 * in the old and new backing file, and if they differ we need to copy it
3717 * from the old backing file into the COW file.
3719 * If qemu-img crashes during this step, no harm is done. The content of
3720 * the image is the same as the original one at any time.
3724 int64_t old_backing_size
= 0;
3725 int64_t new_backing_size
= 0;
3728 float local_progress
= 0;
3730 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3731 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3733 size
= blk_getlength(blk
);
3735 error_report("Could not get size of '%s': %s",
3736 filename
, strerror(-size
));
3740 if (blk_old_backing
) {
3741 old_backing_size
= blk_getlength(blk_old_backing
);
3742 if (old_backing_size
< 0) {
3743 char backing_name
[PATH_MAX
];
3745 bdrv_get_backing_filename(bs
, backing_name
,
3746 sizeof(backing_name
));
3747 error_report("Could not get size of '%s': %s",
3748 backing_name
, strerror(-old_backing_size
));
3753 if (blk_new_backing
) {
3754 new_backing_size
= blk_getlength(blk_new_backing
);
3755 if (new_backing_size
< 0) {
3756 error_report("Could not get size of '%s': %s",
3757 out_baseimg
, strerror(-new_backing_size
));
3764 local_progress
= (float)100 / (size
/ MIN(size
, IO_BUF_SIZE
));
3767 for (offset
= 0; offset
< size
; offset
+= n
) {
3768 bool buf_old_is_zero
= false;
3770 /* How many bytes can we handle with the next read? */
3771 n
= MIN(IO_BUF_SIZE
, size
- offset
);
3773 /* If the cluster is allocated, we don't need to take action */
3774 ret
= bdrv_is_allocated(unfiltered_bs
, offset
, n
, &n
);
3776 error_report("error while reading image metadata: %s",
3784 if (prefix_chain_bs
) {
3786 * If cluster wasn't changed since prefix_chain, we don't need
3789 ret
= bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs
),
3790 prefix_chain_bs
, false,
3793 error_report("error while reading image metadata: %s",
3803 * Read old and new backing file and take into consideration that
3804 * backing files may be smaller than the COW image.
3806 if (offset
>= old_backing_size
) {
3807 memset(buf_old
, 0, n
);
3808 buf_old_is_zero
= true;
3810 if (offset
+ n
> old_backing_size
) {
3811 n
= old_backing_size
- offset
;
3814 ret
= blk_pread(blk_old_backing
, offset
, buf_old
, n
);
3816 error_report("error while reading from old backing file");
3821 if (offset
>= new_backing_size
|| !blk_new_backing
) {
3822 memset(buf_new
, 0, n
);
3824 if (offset
+ n
> new_backing_size
) {
3825 n
= new_backing_size
- offset
;
3828 ret
= blk_pread(blk_new_backing
, offset
, buf_new
, n
);
3830 error_report("error while reading from new backing file");
3835 /* If they differ, we need to write to the COW file */
3836 uint64_t written
= 0;
3838 while (written
< n
) {
3841 if (compare_buffers(buf_old
+ written
, buf_new
+ written
,
3842 n
- written
, &pnum
))
3844 if (buf_old_is_zero
) {
3845 ret
= blk_pwrite_zeroes(blk
, offset
+ written
, pnum
, 0);
3847 ret
= blk_pwrite(blk
, offset
+ written
,
3848 buf_old
+ written
, pnum
, 0);
3851 error_report("Error while writing to COW image: %s",
3859 qemu_progress_print(local_progress
, 100);
3864 * Change the backing file. All clusters that are different from the old
3865 * backing file are overwritten in the COW file now, so the visible content
3866 * doesn't change when we switch the backing file.
3868 if (out_baseimg
&& *out_baseimg
) {
3869 ret
= bdrv_change_backing_file(unfiltered_bs
, out_baseimg
, out_basefmt
,
3872 ret
= bdrv_change_backing_file(unfiltered_bs
, NULL
, NULL
, false);
3875 if (ret
== -ENOSPC
) {
3876 error_report("Could not change the backing file to '%s': No "
3877 "space left in the file header", out_baseimg
);
3878 } else if (ret
< 0) {
3879 error_report("Could not change the backing file to '%s': %s",
3880 out_baseimg
, strerror(-ret
));
3883 qemu_progress_print(100, 0);
3885 * TODO At this point it is possible to check if any clusters that are
3886 * allocated in the COW file are the same in the backing file. If so, they
3887 * could be dropped from the COW file. Don't do this before switching the
3888 * backing file, in case of a crash this would lead to corruption.
3891 qemu_progress_end();
3894 blk_unref(blk_old_backing
);
3895 blk_unref(blk_new_backing
);
3897 qemu_vfree(buf_old
);
3898 qemu_vfree(buf_new
);
3907 static int img_resize(int argc
, char **argv
)
3910 int c
, ret
, relative
;
3911 const char *filename
, *fmt
, *size
;
3912 int64_t n
, total_size
, current_size
;
3914 BlockBackend
*blk
= NULL
;
3915 PreallocMode prealloc
= PREALLOC_MODE_OFF
;
3918 static QemuOptsList resize_options
= {
3919 .name
= "resize_options",
3920 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3923 .name
= BLOCK_OPT_SIZE
,
3924 .type
= QEMU_OPT_SIZE
,
3925 .help
= "Virtual disk size"
3931 bool image_opts
= false;
3932 bool shrink
= false;
3934 /* Remove size from argv manually so that negative numbers are not treated
3935 * as options by getopt. */
3937 error_exit("Not enough arguments");
3941 size
= argv
[--argc
];
3943 /* Parse getopt arguments */
3946 static const struct option long_options
[] = {
3947 {"help", no_argument
, 0, 'h'},
3948 {"object", required_argument
, 0, OPTION_OBJECT
},
3949 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3950 {"preallocation", required_argument
, 0, OPTION_PREALLOCATION
},
3951 {"shrink", no_argument
, 0, OPTION_SHRINK
},
3954 c
= getopt_long(argc
, argv
, ":f:hq",
3955 long_options
, NULL
);
3961 missing_argument(argv
[optind
- 1]);
3964 unrecognized_option(argv
[optind
- 1]);
3975 case OPTION_OBJECT
: {
3977 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3983 case OPTION_IMAGE_OPTS
:
3986 case OPTION_PREALLOCATION
:
3987 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, optarg
,
3988 PREALLOC_MODE__MAX
, NULL
);
3989 if (prealloc
== PREALLOC_MODE__MAX
) {
3990 error_report("Invalid preallocation mode '%s'", optarg
);
3999 if (optind
!= argc
- 1) {
4000 error_exit("Expecting image file name and size");
4002 filename
= argv
[optind
++];
4004 if (qemu_opts_foreach(&qemu_object_opts
,
4005 user_creatable_add_opts_foreach
,
4006 qemu_img_object_print_help
, &error_fatal
)) {
4010 /* Choose grow, shrink, or absolute resize mode */
4026 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
4027 if (!qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
)) {
4028 error_report_err(err
);
4030 qemu_opts_del(param
);
4033 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
4034 qemu_opts_del(param
);
4036 blk
= img_open(image_opts
, filename
, fmt
,
4037 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
4044 current_size
= blk_getlength(blk
);
4045 if (current_size
< 0) {
4046 error_report("Failed to inquire current image length: %s",
4047 strerror(-current_size
));
4053 total_size
= current_size
+ n
* relative
;
4057 if (total_size
<= 0) {
4058 error_report("New image size must be positive");
4063 if (total_size
<= current_size
&& prealloc
!= PREALLOC_MODE_OFF
) {
4064 error_report("Preallocation can only be used for growing images");
4069 if (total_size
< current_size
&& !shrink
) {
4070 error_report("Use the --shrink option to perform a shrink operation.");
4071 warn_report("Shrinking an image will delete all data beyond the "
4072 "shrunken image's end. Before performing such an "
4073 "operation, make sure there is no important data there.");
4079 * The user expects the image to have the desired size after
4080 * resizing, so pass @exact=true. It is of no use to report
4081 * success when the image has not actually been resized.
4083 ret
= blk_truncate(blk
, total_size
, true, prealloc
, 0, &err
);
4085 qprintf(quiet
, "Image resized.\n");
4087 error_report_err(err
);
4097 static void amend_status_cb(BlockDriverState
*bs
,
4098 int64_t offset
, int64_t total_work_size
,
4101 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
4104 static int print_amend_option_help(const char *format
)
4108 /* Find driver and parse its options */
4109 drv
= bdrv_find_format(format
);
4111 error_report("Unknown file format '%s'", format
);
4115 if (!drv
->bdrv_amend_options
) {
4116 error_report("Format driver '%s' does not support option amendment",
4121 /* Every driver supporting amendment must have amend_opts */
4122 assert(drv
->amend_opts
);
4124 printf("Amend options for '%s':\n", format
);
4125 qemu_opts_print_help(drv
->amend_opts
, false);
4129 static int img_amend(int argc
, char **argv
)
4133 char *options
= NULL
;
4134 QemuOptsList
*amend_opts
= NULL
;
4135 QemuOpts
*opts
= NULL
;
4136 const char *fmt
= NULL
, *filename
, *cache
;
4139 bool quiet
= false, progress
= false;
4140 BlockBackend
*blk
= NULL
;
4141 BlockDriverState
*bs
= NULL
;
4142 bool image_opts
= false;
4145 cache
= BDRV_DEFAULT_CACHE
;
4147 static const struct option long_options
[] = {
4148 {"help", no_argument
, 0, 'h'},
4149 {"object", required_argument
, 0, OPTION_OBJECT
},
4150 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4151 {"force", no_argument
, 0, OPTION_FORCE
},
4154 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
4155 long_options
, NULL
);
4162 missing_argument(argv
[optind
- 1]);
4165 unrecognized_option(argv
[optind
- 1]);
4171 if (accumulate_options(&options
, optarg
) < 0) {
4173 goto out_no_progress
;
4189 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
4193 goto out_no_progress
;
4196 case OPTION_IMAGE_OPTS
:
4206 error_exit("Must specify options (-o)");
4209 if (qemu_opts_foreach(&qemu_object_opts
,
4210 user_creatable_add_opts_foreach
,
4211 qemu_img_object_print_help
, &error_fatal
)) {
4213 goto out_no_progress
;
4219 qemu_progress_init(progress
, 1.0);
4221 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
4222 if (fmt
&& has_help_option(options
)) {
4223 /* If a format is explicitly specified (and possibly no filename is
4224 * given), print option help here */
4225 ret
= print_amend_option_help(fmt
);
4229 if (optind
!= argc
- 1) {
4230 error_report("Expecting one image file name");
4235 flags
= BDRV_O_RDWR
;
4236 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
4238 error_report("Invalid cache option: %s", cache
);
4242 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4250 fmt
= bs
->drv
->format_name
;
4252 if (has_help_option(options
)) {
4253 /* If the format was auto-detected, print option help here */
4254 ret
= print_amend_option_help(fmt
);
4258 if (!bs
->drv
->bdrv_amend_options
) {
4259 error_report("Format driver '%s' does not support option amendment",
4265 /* Every driver supporting amendment must have amend_opts */
4266 assert(bs
->drv
->amend_opts
);
4268 amend_opts
= qemu_opts_append(amend_opts
, bs
->drv
->amend_opts
);
4269 opts
= qemu_opts_create(amend_opts
, NULL
, 0, &error_abort
);
4270 if (!qemu_opts_do_parse(opts
, options
, NULL
, &err
)) {
4271 /* Try to parse options using the create options */
4272 amend_opts
= qemu_opts_append(amend_opts
, bs
->drv
->create_opts
);
4273 qemu_opts_del(opts
);
4274 opts
= qemu_opts_create(amend_opts
, NULL
, 0, &error_abort
);
4275 if (qemu_opts_do_parse(opts
, options
, NULL
, NULL
)) {
4276 error_append_hint(&err
,
4277 "This option is only supported for image creation\n");
4280 error_report_err(err
);
4285 /* In case the driver does not call amend_status_cb() */
4286 qemu_progress_print(0.f
, 0);
4287 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
, force
, &err
);
4288 qemu_progress_print(100.f
, 0);
4290 error_report_err(err
);
4295 qemu_progress_end();
4299 qemu_opts_del(opts
);
4300 qemu_opts_free(amend_opts
);
4309 typedef struct BenchData
{
4311 uint64_t image_size
;
4318 bool drain_on_flush
;
4327 static void bench_undrained_flush_cb(void *opaque
, int ret
)
4330 error_report("Failed flush request: %s", strerror(-ret
));
4335 static void bench_cb(void *opaque
, int ret
)
4337 BenchData
*b
= opaque
;
4341 error_report("Failed request: %s", strerror(-ret
));
4346 /* Just finished a flush with drained queue: Start next requests */
4347 assert(b
->in_flight
== 0);
4348 b
->in_flush
= false;
4349 } else if (b
->in_flight
> 0) {
4350 int remaining
= b
->n
- b
->in_flight
;
4355 /* Time for flush? Drain queue if requested, then flush */
4356 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
4357 if (!b
->in_flight
|| !b
->drain_on_flush
) {
4358 BlockCompletionFunc
*cb
;
4360 if (b
->drain_on_flush
) {
4364 cb
= bench_undrained_flush_cb
;
4367 acb
= blk_aio_flush(b
->blk
, cb
, b
);
4369 error_report("Failed to issue flush request");
4373 if (b
->drain_on_flush
) {
4379 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
4380 int64_t offset
= b
->offset
;
4381 /* blk_aio_* might look for completed I/Os and kick bench_cb
4382 * again, so make sure this operation is counted by in_flight
4383 * and b->offset is ready for the next submission.
4386 b
->offset
+= b
->step
;
4387 b
->offset
%= b
->image_size
;
4389 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4391 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4394 error_report("Failed to issue request");
4400 static int img_bench(int argc
, char **argv
)
4403 const char *fmt
= NULL
, *filename
;
4405 bool image_opts
= false;
4406 bool is_write
= false;
4410 size_t bufsize
= 4096;
4413 int flush_interval
= 0;
4414 bool drain_on_flush
= true;
4416 BlockBackend
*blk
= NULL
;
4417 BenchData data
= {};
4419 bool writethrough
= false;
4420 struct timeval t1
, t2
;
4422 bool force_share
= false;
4426 static const struct option long_options
[] = {
4427 {"help", no_argument
, 0, 'h'},
4428 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
4429 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4430 {"pattern", required_argument
, 0, OPTION_PATTERN
},
4431 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
4432 {"force-share", no_argument
, 0, 'U'},
4435 c
= getopt_long(argc
, argv
, ":hc:d:f:ni:o:qs:S:t:wU", long_options
,
4443 missing_argument(argv
[optind
- 1]);
4446 unrecognized_option(argv
[optind
- 1]);
4455 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4456 error_report("Invalid request count specified");
4466 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4467 error_report("Invalid queue depth specified");
4477 flags
|= BDRV_O_NATIVE_AIO
;
4480 ret
= bdrv_parse_aio(optarg
, &flags
);
4482 error_report("Invalid aio option: %s", optarg
);
4489 offset
= cvtnum("offset", optarg
);
4503 sval
= cvtnum_full("buffer size", optarg
, 0, INT_MAX
);
4515 sval
= cvtnum_full("step_size", optarg
, 0, INT_MAX
);
4524 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
4526 error_report("Invalid cache mode");
4532 flags
|= BDRV_O_RDWR
;
4538 case OPTION_PATTERN
:
4542 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
4543 error_report("Invalid pattern byte specified");
4549 case OPTION_FLUSH_INTERVAL
:
4553 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4554 error_report("Invalid flush interval specified");
4557 flush_interval
= res
;
4560 case OPTION_NO_DRAIN
:
4561 drain_on_flush
= false;
4563 case OPTION_IMAGE_OPTS
:
4569 if (optind
!= argc
- 1) {
4570 error_exit("Expecting one image file name");
4572 filename
= argv
[argc
- 1];
4574 if (!is_write
&& flush_interval
) {
4575 error_report("--flush-interval is only available in write tests");
4579 if (flush_interval
&& flush_interval
< depth
) {
4580 error_report("Flush interval can't be smaller than depth");
4585 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4592 image_size
= blk_getlength(blk
);
4593 if (image_size
< 0) {
4598 data
= (BenchData
) {
4600 .image_size
= image_size
,
4602 .step
= step
?: bufsize
,
4607 .flush_interval
= flush_interval
,
4608 .drain_on_flush
= drain_on_flush
,
4610 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4611 "(starting at offset %" PRId64
", step size %d)\n",
4612 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4613 data
.offset
, data
.step
);
4614 if (flush_interval
) {
4615 printf("Sending flush every %d requests\n", flush_interval
);
4618 buf_size
= data
.nrreq
* data
.bufsize
;
4619 data
.buf
= blk_blockalign(blk
, buf_size
);
4620 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4622 blk_register_buf(blk
, data
.buf
, buf_size
);
4624 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4625 for (i
= 0; i
< data
.nrreq
; i
++) {
4626 qemu_iovec_init(&data
.qiov
[i
], 1);
4627 qemu_iovec_add(&data
.qiov
[i
],
4628 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4631 gettimeofday(&t1
, NULL
);
4634 while (data
.n
> 0) {
4635 main_loop_wait(false);
4637 gettimeofday(&t2
, NULL
);
4639 printf("Run completed in %3.3f seconds.\n",
4640 (t2
.tv_sec
- t1
.tv_sec
)
4641 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4645 blk_unregister_buf(blk
, data
.buf
);
4647 qemu_vfree(data
.buf
);
4664 typedef struct ImgBitmapAction
{
4665 enum ImgBitmapAct act
;
4666 const char *src
; /* only used for merge */
4667 QSIMPLEQ_ENTRY(ImgBitmapAction
) next
;
4670 static int img_bitmap(int argc
, char **argv
)
4674 QemuOpts
*opts
= NULL
;
4675 const char *fmt
= NULL
, *src_fmt
= NULL
, *src_filename
= NULL
;
4676 const char *filename
, *bitmap
;
4677 BlockBackend
*blk
= NULL
, *src
= NULL
;
4678 BlockDriverState
*bs
= NULL
, *src_bs
= NULL
;
4679 bool image_opts
= false;
4680 int64_t granularity
= 0;
4681 bool add
= false, merge
= false;
4682 QSIMPLEQ_HEAD(, ImgBitmapAction
) actions
;
4683 ImgBitmapAction
*act
, *act_next
;
4686 QSIMPLEQ_INIT(&actions
);
4689 static const struct option long_options
[] = {
4690 {"help", no_argument
, 0, 'h'},
4691 {"object", required_argument
, 0, OPTION_OBJECT
},
4692 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4693 {"add", no_argument
, 0, OPTION_ADD
},
4694 {"remove", no_argument
, 0, OPTION_REMOVE
},
4695 {"clear", no_argument
, 0, OPTION_CLEAR
},
4696 {"enable", no_argument
, 0, OPTION_ENABLE
},
4697 {"disable", no_argument
, 0, OPTION_DISABLE
},
4698 {"merge", required_argument
, 0, OPTION_MERGE
},
4699 {"granularity", required_argument
, 0, 'g'},
4700 {"source-file", required_argument
, 0, 'b'},
4701 {"source-format", required_argument
, 0, 'F'},
4704 c
= getopt_long(argc
, argv
, ":b:f:F:g:h", long_options
, NULL
);
4711 missing_argument(argv
[optind
- 1]);
4714 unrecognized_option(argv
[optind
- 1]);
4720 src_filename
= optarg
;
4729 granularity
= cvtnum("granularity", optarg
);
4730 if (granularity
< 0) {
4735 act
= g_new0(ImgBitmapAction
, 1);
4736 act
->act
= BITMAP_ADD
;
4737 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4741 act
= g_new0(ImgBitmapAction
, 1);
4742 act
->act
= BITMAP_REMOVE
;
4743 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4746 act
= g_new0(ImgBitmapAction
, 1);
4747 act
->act
= BITMAP_CLEAR
;
4748 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4751 act
= g_new0(ImgBitmapAction
, 1);
4752 act
->act
= BITMAP_ENABLE
;
4753 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4755 case OPTION_DISABLE
:
4756 act
= g_new0(ImgBitmapAction
, 1);
4757 act
->act
= BITMAP_DISABLE
;
4758 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4761 act
= g_new0(ImgBitmapAction
, 1);
4762 act
->act
= BITMAP_MERGE
;
4764 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4768 opts
= qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true);
4773 case OPTION_IMAGE_OPTS
:
4779 if (qemu_opts_foreach(&qemu_object_opts
,
4780 user_creatable_add_opts_foreach
,
4781 qemu_img_object_print_help
, &error_fatal
)) {
4785 if (QSIMPLEQ_EMPTY(&actions
)) {
4786 error_report("Need at least one of --add, --remove, --clear, "
4787 "--enable, --disable, or --merge");
4791 if (granularity
&& !add
) {
4792 error_report("granularity only supported with --add");
4795 if (src_fmt
&& !src_filename
) {
4796 error_report("-F only supported with -b");
4799 if (src_filename
&& !merge
) {
4800 error_report("Merge bitmap source file only supported with "
4805 if (optind
!= argc
- 2) {
4806 error_report("Expecting filename and bitmap name");
4810 filename
= argv
[optind
];
4811 bitmap
= argv
[optind
+ 1];
4814 * No need to open backing chains; we will be manipulating bitmaps
4815 * directly in this image without reference to image contents.
4817 blk
= img_open(image_opts
, filename
, fmt
, BDRV_O_RDWR
| BDRV_O_NO_BACKING
,
4818 false, false, false);
4824 src
= img_open(false, src_filename
, src_fmt
, BDRV_O_NO_BACKING
,
4825 false, false, false);
4829 src_bs
= blk_bs(src
);
4834 QSIMPLEQ_FOREACH_SAFE(act
, &actions
, next
, act_next
) {
4837 qmp_block_dirty_bitmap_add(bs
->node_name
, bitmap
,
4838 !!granularity
, granularity
, true, true,
4839 false, false, &err
);
4843 qmp_block_dirty_bitmap_remove(bs
->node_name
, bitmap
, &err
);
4847 qmp_block_dirty_bitmap_clear(bs
->node_name
, bitmap
, &err
);
4851 qmp_block_dirty_bitmap_enable(bs
->node_name
, bitmap
, &err
);
4854 case BITMAP_DISABLE
:
4855 qmp_block_dirty_bitmap_disable(bs
->node_name
, bitmap
, &err
);
4859 do_dirty_bitmap_merge(bs
->node_name
, bitmap
, src_bs
->node_name
,
4864 g_assert_not_reached();
4868 error_reportf_err(err
, "Operation %s on bitmap %s failed: ",
4880 qemu_opts_del(opts
);
4896 int bsz
; /* Block size */
4904 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4908 static int img_dd_bs(const char *arg
,
4909 struct DdIo
*in
, struct DdIo
*out
,
4914 res
= cvtnum_full("bs", arg
, 1, INT_MAX
);
4919 in
->bsz
= out
->bsz
= res
;
4924 static int img_dd_count(const char *arg
,
4925 struct DdIo
*in
, struct DdIo
*out
,
4928 dd
->count
= cvtnum("count", arg
);
4930 if (dd
->count
< 0) {
4937 static int img_dd_if(const char *arg
,
4938 struct DdIo
*in
, struct DdIo
*out
,
4941 in
->filename
= g_strdup(arg
);
4946 static int img_dd_of(const char *arg
,
4947 struct DdIo
*in
, struct DdIo
*out
,
4950 out
->filename
= g_strdup(arg
);
4955 static int img_dd_skip(const char *arg
,
4956 struct DdIo
*in
, struct DdIo
*out
,
4959 in
->offset
= cvtnum("skip", arg
);
4961 if (in
->offset
< 0) {
4968 static int img_dd(int argc
, char **argv
)
4973 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4974 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4975 QemuOpts
*opts
= NULL
;
4976 QemuOptsList
*create_opts
= NULL
;
4977 Error
*local_err
= NULL
;
4978 bool image_opts
= false;
4980 const char *out_fmt
= "raw";
4981 const char *fmt
= NULL
;
4983 int64_t block_count
= 0, out_pos
, in_pos
;
4984 bool force_share
= false;
4985 struct DdInfo dd
= {
4990 .bsz
= 512, /* Block size is by default 512 bytes */
5002 const struct DdOpts options
[] = {
5003 { "bs", img_dd_bs
, C_BS
},
5004 { "count", img_dd_count
, C_COUNT
},
5005 { "if", img_dd_if
, C_IF
},
5006 { "of", img_dd_of
, C_OF
},
5007 { "skip", img_dd_skip
, C_SKIP
},
5010 const struct option long_options
[] = {
5011 { "help", no_argument
, 0, 'h'},
5012 { "object", required_argument
, 0, OPTION_OBJECT
},
5013 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
5014 { "force-share", no_argument
, 0, 'U'},
5018 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
5030 missing_argument(argv
[optind
- 1]);
5033 unrecognized_option(argv
[optind
- 1]);
5042 if (!qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true)) {
5047 case OPTION_IMAGE_OPTS
:
5053 for (i
= optind
; i
< argc
; i
++) {
5055 arg
= g_strdup(argv
[i
]);
5057 tmp
= strchr(arg
, '=');
5059 error_report("unrecognized operand %s", arg
);
5066 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
5067 if (!strcmp(arg
, options
[j
].name
)) {
5071 if (options
[j
].name
== NULL
) {
5072 error_report("unrecognized operand %s", arg
);
5077 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
5081 dd
.flags
|= options
[j
].flag
;
5086 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
5087 error_report("Must specify both input and output files");
5092 if (qemu_opts_foreach(&qemu_object_opts
,
5093 user_creatable_add_opts_foreach
,
5094 qemu_img_object_print_help
, &error_fatal
)) {
5099 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
5107 drv
= bdrv_find_format(out_fmt
);
5109 error_report("Unknown file format");
5113 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
5116 error_report_err(local_err
);
5120 if (!drv
->create_opts
) {
5121 error_report("Format driver '%s' does not support image creation",
5126 if (!proto_drv
->create_opts
) {
5127 error_report("Protocol driver '%s' does not support image creation",
5128 proto_drv
->format_name
);
5132 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
5133 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
5135 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
5137 size
= blk_getlength(blk1
);
5139 error_report("Failed to get size for '%s'", in
.filename
);
5144 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
5145 dd
.count
* in
.bsz
< size
) {
5146 size
= dd
.count
* in
.bsz
;
5149 /* Overflow means the specified offset is beyond input image's size */
5150 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
5151 size
< in
.bsz
* in
.offset
)) {
5152 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
5154 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
5155 size
- in
.bsz
* in
.offset
, &error_abort
);
5158 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
5160 error_reportf_err(local_err
,
5161 "%s: error while creating output image: ",
5167 /* TODO, we can't honour --image-opts for the target,
5168 * since it needs to be given in a format compatible
5169 * with the bdrv_create() call above which does not
5170 * support image-opts style.
5172 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
5173 false, false, false);
5180 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
5181 size
< in
.offset
* in
.bsz
)) {
5182 /* We give a warning if the skip option is bigger than the input
5183 * size and create an empty output disk image (i.e. like dd(1)).
5185 error_report("%s: cannot skip to specified offset", in
.filename
);
5188 in_pos
= in
.offset
* in
.bsz
;
5191 in
.buf
= g_new(uint8_t, in
.bsz
);
5193 for (out_pos
= 0; in_pos
< size
; block_count
++) {
5194 int in_ret
, out_ret
;
5196 if (in_pos
+ in
.bsz
> size
) {
5197 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
5199 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
5202 error_report("error while reading from input image file: %s",
5209 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
5212 error_report("error while writing to output image file: %s",
5213 strerror(-out_ret
));
5222 qemu_opts_del(opts
);
5223 qemu_opts_free(create_opts
);
5226 g_free(in
.filename
);
5227 g_free(out
.filename
);
5237 static void dump_json_block_measure_info(BlockMeasureInfo
*info
)
5241 Visitor
*v
= qobject_output_visitor_new(&obj
);
5243 visit_type_BlockMeasureInfo(v
, NULL
, &info
, &error_abort
);
5244 visit_complete(v
, &obj
);
5245 str
= qobject_to_json_pretty(obj
, true);
5246 assert(str
!= NULL
);
5247 printf("%s\n", qstring_get_str(str
));
5253 static int img_measure(int argc
, char **argv
)
5255 static const struct option long_options
[] = {
5256 {"help", no_argument
, 0, 'h'},
5257 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
5258 {"object", required_argument
, 0, OPTION_OBJECT
},
5259 {"output", required_argument
, 0, OPTION_OUTPUT
},
5260 {"size", required_argument
, 0, OPTION_SIZE
},
5261 {"force-share", no_argument
, 0, 'U'},
5264 OutputFormat output_format
= OFORMAT_HUMAN
;
5265 BlockBackend
*in_blk
= NULL
;
5267 const char *filename
= NULL
;
5268 const char *fmt
= NULL
;
5269 const char *out_fmt
= "raw";
5270 char *options
= NULL
;
5271 char *snapshot_name
= NULL
;
5272 bool force_share
= false;
5273 QemuOpts
*opts
= NULL
;
5274 QemuOpts
*object_opts
= NULL
;
5275 QemuOpts
*sn_opts
= NULL
;
5276 QemuOptsList
*create_opts
= NULL
;
5277 bool image_opts
= false;
5278 uint64_t img_size
= UINT64_MAX
;
5279 BlockMeasureInfo
*info
= NULL
;
5280 Error
*local_err
= NULL
;
5284 while ((c
= getopt_long(argc
, argv
, "hf:O:o:l:U",
5285 long_options
, NULL
)) != -1) {
5298 if (accumulate_options(&options
, optarg
) < 0) {
5303 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
5304 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
5307 error_report("Failed in parsing snapshot param '%s'",
5312 snapshot_name
= optarg
;
5319 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
5325 case OPTION_IMAGE_OPTS
:
5329 if (!strcmp(optarg
, "json")) {
5330 output_format
= OFORMAT_JSON
;
5331 } else if (!strcmp(optarg
, "human")) {
5332 output_format
= OFORMAT_HUMAN
;
5334 error_report("--output must be used with human or json "
5343 sval
= cvtnum("image size", optarg
);
5347 img_size
= (uint64_t)sval
;
5353 if (qemu_opts_foreach(&qemu_object_opts
,
5354 user_creatable_add_opts_foreach
,
5355 qemu_img_object_print_help
, &error_fatal
)) {
5359 if (argc
- optind
> 1) {
5360 error_report("At most one filename argument is allowed.");
5362 } else if (argc
- optind
== 1) {
5363 filename
= argv
[optind
];
5366 if (!filename
&& (image_opts
|| fmt
|| snapshot_name
|| sn_opts
)) {
5367 error_report("--image-opts, -f, and -l require a filename argument.");
5370 if (filename
&& img_size
!= UINT64_MAX
) {
5371 error_report("--size N cannot be used together with a filename.");
5374 if (!filename
&& img_size
== UINT64_MAX
) {
5375 error_report("Either --size N or one filename must be specified.");
5380 in_blk
= img_open(image_opts
, filename
, fmt
, 0,
5381 false, false, force_share
);
5387 bdrv_snapshot_load_tmp(blk_bs(in_blk
),
5388 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
5389 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
5391 } else if (snapshot_name
!= NULL
) {
5392 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk
),
5393 snapshot_name
, &local_err
);
5396 error_reportf_err(local_err
, "Failed to load snapshot: ");
5401 drv
= bdrv_find_format(out_fmt
);
5403 error_report("Unknown file format '%s'", out_fmt
);
5406 if (!drv
->create_opts
) {
5407 error_report("Format driver '%s' does not support image creation",
5412 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
5413 create_opts
= qemu_opts_append(create_opts
, bdrv_file
.create_opts
);
5414 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
5416 if (!qemu_opts_do_parse(opts
, options
, NULL
, &local_err
)) {
5417 error_report_err(local_err
);
5418 error_report("Invalid options for file format '%s'", out_fmt
);
5422 if (img_size
!= UINT64_MAX
) {
5423 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, img_size
, &error_abort
);
5426 info
= bdrv_measure(drv
, opts
, in_blk
? blk_bs(in_blk
) : NULL
, &local_err
);
5428 error_report_err(local_err
);
5432 if (output_format
== OFORMAT_HUMAN
) {
5433 printf("required size: %" PRIu64
"\n", info
->required
);
5434 printf("fully allocated size: %" PRIu64
"\n", info
->fully_allocated
);
5435 if (info
->has_bitmaps
) {
5436 printf("bitmaps size: %" PRIu64
"\n", info
->bitmaps
);
5439 dump_json_block_measure_info(info
);
5445 qapi_free_BlockMeasureInfo(info
);
5446 qemu_opts_del(object_opts
);
5447 qemu_opts_del(opts
);
5448 qemu_opts_del(sn_opts
);
5449 qemu_opts_free(create_opts
);
5455 static const img_cmd_t img_cmds
[] = {
5456 #define DEF(option, callback, arg_string) \
5457 { option, callback },
5458 #include "qemu-img-cmds.h"
5463 int main(int argc
, char **argv
)
5465 const img_cmd_t
*cmd
;
5466 const char *cmdname
;
5467 Error
*local_error
= NULL
;
5469 static const struct option long_options
[] = {
5470 {"help", no_argument
, 0, 'h'},
5471 {"version", no_argument
, 0, 'V'},
5472 {"trace", required_argument
, NULL
, 'T'},
5477 signal(SIGPIPE
, SIG_IGN
);
5481 error_init(argv
[0]);
5482 module_call_init(MODULE_INIT_TRACE
);
5483 qemu_init_exec_dir(argv
[0]);
5485 if (qemu_init_main_loop(&local_error
)) {
5486 error_report_err(local_error
);
5490 qcrypto_init(&error_fatal
);
5492 module_call_init(MODULE_INIT_QOM
);
5495 error_exit("Not enough arguments");
5498 qemu_add_opts(&qemu_object_opts
);
5499 qemu_add_opts(&qemu_source_opts
);
5500 qemu_add_opts(&qemu_trace_opts
);
5502 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
5505 missing_argument(argv
[optind
- 1]);
5508 unrecognized_option(argv
[optind
- 1]);
5514 printf(QEMU_IMG_VERSION
);
5517 trace_opt_parse(optarg
);
5522 cmdname
= argv
[optind
];
5524 /* reset getopt_long scanning */
5530 qemu_reset_optind();
5532 if (!trace_init_backends()) {
5536 qemu_set_log(LOG_TRACE
);
5538 /* find the command */
5539 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
5540 if (!strcmp(cmdname
, cmd
->name
)) {
5541 return cmd
->handler(argc
, argv
);
5546 error_exit("Command not found: %s", cmdname
);