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/help-texts.h"
29 #include "qemu/qemu-progress.h"
30 #include "qemu-version.h"
31 #include "qapi/error.h"
32 #include "qapi/qapi-commands-block-core.h"
33 #include "qapi/qapi-visit-block-core.h"
34 #include "qapi/qobject-output-visitor.h"
35 #include "qapi/qmp/qjson.h"
36 #include "qapi/qmp/qdict.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 "qemu/memalign.h"
47 #include "qom/object_interfaces.h"
48 #include "sysemu/block-backend.h"
49 #include "block/block_int.h"
50 #include "block/blockjob.h"
51 #include "block/dirty-bitmap.h"
52 #include "block/qapi.h"
53 #include "crypto/init.h"
54 #include "trace/control.h"
55 #include "qemu/throttle.h"
56 #include "block/throttle-groups.h"
58 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
59 "\n" QEMU_COPYRIGHT "\n"
61 typedef struct img_cmd_t
{
63 int (*handler
)(int argc
, char **argv
);
68 OPTION_BACKING_CHAIN
= 257,
70 OPTION_IMAGE_OPTS
= 259,
72 OPTION_FLUSH_INTERVAL
= 261,
73 OPTION_NO_DRAIN
= 262,
74 OPTION_TARGET_IMAGE_OPTS
= 263,
76 OPTION_PREALLOCATION
= 265,
79 OPTION_TARGET_IS_ZERO
= 268,
88 OPTION_SKIP_BROKEN
= 277,
91 typedef enum OutputFormat
{
96 /* Default to cache=writeback as data integrity is not important for qemu-img */
97 #define BDRV_DEFAULT_CACHE "writeback"
99 static void format_print(void *opaque
, const char *name
)
104 static G_NORETURN
G_GNUC_PRINTF(1, 2)
105 void error_exit(const char *fmt
, ...)
110 error_vreport(fmt
, ap
);
113 error_printf("Try 'qemu-img --help' for more information\n");
118 void missing_argument(const char *option
)
120 error_exit("missing argument for option '%s'", option
);
124 void unrecognized_option(const char *option
)
126 error_exit("unrecognized option '%s'", option
);
129 /* Please keep in synch with docs/tools/qemu-img.rst */
133 const char *help_msg
=
135 "usage: qemu-img [standard options] command [command options]\n"
136 "QEMU disk image utility\n"
138 " '-h', '--help' display this help and exit\n"
139 " '-V', '--version' output version information and exit\n"
140 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
141 " specify tracing options\n"
144 #define DEF(option, callback, arg_string) \
146 #include "qemu-img-cmds.h"
149 "Command parameters:\n"
150 " 'filename' is a disk image filename\n"
151 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
152 " manual page for a description of the object properties. The most common\n"
153 " object type is a 'secret', which is used to supply passwords and/or\n"
154 " encryption keys.\n"
155 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
156 " 'cache' is the cache mode used to write the output disk image, the valid\n"
157 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
158 " 'directsync' and 'unsafe' (default for convert)\n"
159 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
160 " options are the same as for the 'cache' option\n"
161 " 'size' is the disk image size in bytes. Optional suffixes\n"
162 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
163 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
164 " supported. 'b' is ignored.\n"
165 " 'output_filename' is the destination disk image filename\n"
166 " 'output_fmt' is the destination format\n"
167 " 'options' is a comma separated list of format specific options in a\n"
168 " name=value format. Use -o help for an overview of the options supported by\n"
170 " 'snapshot_param' is param used for internal snapshot, format\n"
171 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
173 " '-c' indicates that target image must be compressed (qcow format only)\n"
174 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
175 " new backing file match exactly. The image doesn't need a working\n"
176 " backing file before rebasing in this case (useful for renaming the\n"
177 " backing file). For image creation, allow creating without attempting\n"
178 " to open the backing file.\n"
179 " '-h' with or without a command shows this help and lists the supported formats\n"
180 " '-p' show progress of command (only certain commands)\n"
181 " '-q' use Quiet mode - do not print any output (except errors)\n"
182 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
183 " contain only zeros for qemu-img to create a sparse image during\n"
184 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
185 " unallocated or zero sectors, and the destination image will always be\n"
187 " '--output' takes the format in which the output must be done (human or json)\n"
188 " '-n' skips the target volume creation (useful if the volume is created\n"
189 " prior to running qemu-img)\n"
191 "Parameters to bitmap subcommand:\n"
192 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
193 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
194 " or '--merge source'\n"
195 " '-g granularity' sets the granularity for '--add' actions\n"
196 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
197 " bitmaps from an alternative file\n"
199 "Parameters to check subcommand:\n"
200 " '-r' tries to repair any inconsistencies that are found during the check.\n"
201 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
202 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
203 " hiding corruption that has already occurred.\n"
205 "Parameters to convert subcommand:\n"
206 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
207 " '-m' specifies how many coroutines work in parallel during the convert\n"
208 " process (defaults to 8)\n"
209 " '-W' allow to write to the target out of order rather than sequential\n"
211 "Parameters to snapshot subcommand:\n"
212 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
213 " '-a' applies a snapshot (revert disk to saved state)\n"
214 " '-c' creates a snapshot\n"
215 " '-d' deletes a snapshot\n"
216 " '-l' lists all snapshots in the given image\n"
218 "Parameters to compare subcommand:\n"
219 " '-f' first image format\n"
220 " '-F' second image format\n"
221 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
223 "Parameters to dd subcommand:\n"
224 " 'bs=BYTES' read and write up to BYTES bytes at a time "
226 " 'count=N' copy only N input blocks\n"
227 " 'if=FILE' read from FILE\n"
228 " 'of=FILE' write to FILE\n"
229 " 'skip=N' skip N bs-sized blocks at the start of input\n";
231 printf("%s\nSupported formats:", help_msg
);
232 bdrv_iterate_format(format_print
, NULL
, false);
233 printf("\n\n" QEMU_HELP_BOTTOM
"\n");
238 * Is @list safe for accumulate_options()?
239 * It is when multiple of them can be joined together separated by ','.
240 * To make that work, @list must not start with ',' (or else a
241 * separating ',' preceding it gets escaped), and it must not end with
242 * an odd number of ',' (or else a separating ',' following it gets
243 * escaped), or be empty (or else a separating ',' preceding it can
244 * escape a separating ',' following it).
247 static bool is_valid_option_list(const char *list
)
249 size_t len
= strlen(list
);
252 if (!list
[0] || list
[0] == ',') {
256 for (i
= len
; i
> 0 && list
[i
- 1] == ','; i
--) {
265 static int accumulate_options(char **options
, char *list
)
269 if (!is_valid_option_list(list
)) {
270 error_report("Invalid option list: %s", list
);
275 *options
= g_strdup(list
);
277 new_options
= g_strdup_printf("%s,%s", *options
, list
);
279 *options
= new_options
;
284 static QemuOptsList qemu_source_opts
= {
286 .implied_opt_name
= "file",
287 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
293 static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
299 ret
= vprintf(fmt
, args
);
306 static int print_block_option_help(const char *filename
, const char *fmt
)
308 BlockDriver
*drv
, *proto_drv
;
309 QemuOptsList
*create_opts
= NULL
;
310 Error
*local_err
= NULL
;
312 /* Find driver and parse its options */
313 drv
= bdrv_find_format(fmt
);
315 error_report("Unknown file format '%s'", fmt
);
319 if (!drv
->create_opts
) {
320 error_report("Format driver '%s' does not support image creation", fmt
);
324 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
326 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
328 error_report_err(local_err
);
329 qemu_opts_free(create_opts
);
332 if (!proto_drv
->create_opts
) {
333 error_report("Protocol driver '%s' does not support image creation",
334 proto_drv
->format_name
);
335 qemu_opts_free(create_opts
);
338 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
342 printf("Supported options:\n");
344 printf("Supported %s options:\n", fmt
);
346 qemu_opts_print_help(create_opts
, false);
347 qemu_opts_free(create_opts
);
351 "The protocol level may support further options.\n"
352 "Specify the target filename to include those options.\n");
359 static BlockBackend
*img_open_opts(const char *optstr
,
360 QemuOpts
*opts
, int flags
, bool writethrough
,
361 bool quiet
, bool force_share
)
364 Error
*local_err
= NULL
;
366 options
= qemu_opts_to_qdict(opts
, NULL
);
368 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
369 && strcmp(qdict_get_str(options
, BDRV_OPT_FORCE_SHARE
), "on")) {
370 error_report("--force-share/-U conflicts with image options");
371 qobject_unref(options
);
374 qdict_put_str(options
, BDRV_OPT_FORCE_SHARE
, "on");
376 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
378 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
381 blk_set_enable_write_cache(blk
, !writethrough
);
386 static BlockBackend
*img_open_file(const char *filename
,
388 const char *fmt
, int flags
,
389 bool writethrough
, bool quiet
,
393 Error
*local_err
= NULL
;
396 options
= qdict_new();
399 qdict_put_str(options
, "driver", fmt
);
403 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
405 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
407 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
410 blk_set_enable_write_cache(blk
, !writethrough
);
416 static int img_add_key_secrets(void *opaque
,
417 const char *name
, const char *value
,
420 QDict
*options
= opaque
;
422 if (g_str_has_suffix(name
, "key-secret")) {
423 qdict_put_str(options
, name
, value
);
430 static BlockBackend
*img_open(bool image_opts
,
431 const char *filename
,
432 const char *fmt
, int flags
, bool writethrough
,
433 bool quiet
, bool force_share
)
439 error_report("--image-opts and --format are mutually exclusive");
442 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
447 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
450 blk
= img_open_file(filename
, NULL
, fmt
, flags
, writethrough
, quiet
,
455 blk_set_force_allow_inactivate(blk
);
462 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
463 const char *base_filename
,
464 const char *base_fmt
)
467 if (!qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
,
469 error_report("Backing file not supported for file format '%s'",
475 if (!qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, NULL
)) {
476 error_report("Backing file format not supported for file "
484 static int64_t cvtnum_full(const char *name
, const char *value
, int64_t min
,
490 err
= qemu_strtosz(value
, NULL
, &res
);
491 if (err
< 0 && err
!= -ERANGE
) {
492 error_report("Invalid %s specified. You may use "
493 "k, M, G, T, P or E suffixes for", name
);
494 error_report("kilobytes, megabytes, gigabytes, terabytes, "
495 "petabytes and exabytes.");
498 if (err
== -ERANGE
|| res
> max
|| res
< min
) {
499 error_report("Invalid %s specified. Must be between %" PRId64
500 " and %" PRId64
".", name
, min
, max
);
506 static int64_t cvtnum(const char *name
, const char *value
)
508 return cvtnum_full(name
, value
, 0, INT64_MAX
);
511 static int img_create(int argc
, char **argv
)
514 uint64_t img_size
= -1;
515 const char *fmt
= "raw";
516 const char *base_fmt
= NULL
;
517 const char *filename
;
518 const char *base_filename
= NULL
;
519 char *options
= NULL
;
520 Error
*local_err
= NULL
;
525 static const struct option long_options
[] = {
526 {"help", no_argument
, 0, 'h'},
527 {"object", required_argument
, 0, OPTION_OBJECT
},
530 c
= getopt_long(argc
, argv
, ":F:b:f:ho:qu",
537 missing_argument(argv
[optind
- 1]);
540 unrecognized_option(argv
[optind
- 1]);
549 base_filename
= optarg
;
555 if (accumulate_options(&options
, optarg
) < 0) {
563 flags
|= BDRV_O_NO_BACKING
;
566 user_creatable_process_cmdline(optarg
);
571 /* Get the filename */
572 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
573 if (options
&& has_help_option(options
)) {
575 return print_block_option_help(filename
, fmt
);
578 if (optind
>= argc
) {
579 error_exit("Expecting image file name");
583 /* Get image size, if specified */
587 sval
= cvtnum("image size", argv
[optind
++]);
591 img_size
= (uint64_t)sval
;
593 if (optind
!= argc
) {
594 error_exit("Unexpected argument: %s", argv
[optind
]);
597 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
598 options
, img_size
, flags
, quiet
, &local_err
);
600 error_reportf_err(local_err
, "%s: ", filename
);
612 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
616 Visitor
*v
= qobject_output_visitor_new(&obj
);
618 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
619 visit_complete(v
, &obj
);
620 str
= qobject_to_json_pretty(obj
, true);
622 qprintf(quiet
, "%s\n", str
->str
);
625 g_string_free(str
, true);
628 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
630 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
631 qprintf(quiet
, "No errors were found on the image.\n");
633 if (check
->corruptions
) {
634 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
635 "Data may be corrupted, or further writes to the image "
642 "\n%" PRId64
" leaked clusters were found on the image.\n"
643 "This means waste of disk space, but no harm to data.\n",
647 if (check
->check_errors
) {
650 " internal errors have occurred during the check.\n",
651 check
->check_errors
);
655 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
656 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
657 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
658 check
->allocated_clusters
, check
->total_clusters
,
659 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
660 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
661 check
->compressed_clusters
* 100.0 /
662 check
->allocated_clusters
);
665 if (check
->image_end_offset
) {
667 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
671 static int collect_image_check(BlockDriverState
*bs
,
673 const char *filename
,
678 BdrvCheckResult result
;
680 ret
= bdrv_check(bs
, &result
, fix
);
685 check
->filename
= g_strdup(filename
);
686 check
->format
= g_strdup(bdrv_get_format_name(bs
));
687 check
->check_errors
= result
.check_errors
;
688 check
->corruptions
= result
.corruptions
;
689 check
->has_corruptions
= result
.corruptions
!= 0;
690 check
->leaks
= result
.leaks
;
691 check
->has_leaks
= result
.leaks
!= 0;
692 check
->corruptions_fixed
= result
.corruptions_fixed
;
693 check
->has_corruptions_fixed
= result
.corruptions_fixed
!= 0;
694 check
->leaks_fixed
= result
.leaks_fixed
;
695 check
->has_leaks_fixed
= result
.leaks_fixed
!= 0;
696 check
->image_end_offset
= result
.image_end_offset
;
697 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
698 check
->total_clusters
= result
.bfi
.total_clusters
;
699 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
700 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
701 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
702 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
703 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
704 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
705 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
711 * Checks an image for consistency. Exit codes:
713 * 0 - Check completed, image is good
714 * 1 - Check not completed because of internal errors
715 * 2 - Check completed, image is corrupted
716 * 3 - Check completed, image has leaked clusters, but is good otherwise
717 * 63 - Checks are not supported by the image format
719 static int img_check(int argc
, char **argv
)
722 OutputFormat output_format
= OFORMAT_HUMAN
;
723 const char *filename
, *fmt
, *output
, *cache
;
725 BlockDriverState
*bs
;
727 int flags
= BDRV_O_CHECK
;
731 bool image_opts
= false;
732 bool force_share
= false;
736 cache
= BDRV_DEFAULT_CACHE
;
739 int option_index
= 0;
740 static const struct option long_options
[] = {
741 {"help", no_argument
, 0, 'h'},
742 {"format", required_argument
, 0, 'f'},
743 {"repair", required_argument
, 0, 'r'},
744 {"output", required_argument
, 0, OPTION_OUTPUT
},
745 {"object", required_argument
, 0, OPTION_OBJECT
},
746 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
747 {"force-share", no_argument
, 0, 'U'},
750 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
751 long_options
, &option_index
);
757 missing_argument(argv
[optind
- 1]);
760 unrecognized_option(argv
[optind
- 1]);
769 flags
|= BDRV_O_RDWR
;
771 if (!strcmp(optarg
, "leaks")) {
772 fix
= BDRV_FIX_LEAKS
;
773 } else if (!strcmp(optarg
, "all")) {
774 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
776 error_exit("Unknown option value for -r "
777 "(expecting 'leaks' or 'all'): %s", optarg
);
793 user_creatable_process_cmdline(optarg
);
795 case OPTION_IMAGE_OPTS
:
800 if (optind
!= argc
- 1) {
801 error_exit("Expecting one image file name");
803 filename
= argv
[optind
++];
805 if (output
&& !strcmp(output
, "json")) {
806 output_format
= OFORMAT_JSON
;
807 } else if (output
&& !strcmp(output
, "human")) {
808 output_format
= OFORMAT_HUMAN
;
810 error_report("--output must be used with human or json as argument.");
814 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
816 error_report("Invalid source cache option: %s", cache
);
820 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
827 check
= g_new0(ImageCheck
, 1);
828 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
830 if (ret
== -ENOTSUP
) {
831 error_report("This image format does not support checks");
836 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
837 int corruptions_fixed
, leaks_fixed
;
838 bool has_leaks_fixed
, has_corruptions_fixed
;
840 leaks_fixed
= check
->leaks_fixed
;
841 has_leaks_fixed
= check
->has_leaks_fixed
;
842 corruptions_fixed
= check
->corruptions_fixed
;
843 has_corruptions_fixed
= check
->has_corruptions_fixed
;
845 if (output_format
== OFORMAT_HUMAN
) {
847 "The following inconsistencies were found and repaired:\n\n"
848 " %" PRId64
" leaked clusters\n"
849 " %" PRId64
" corruptions\n\n"
850 "Double checking the fixed image now...\n",
852 check
->corruptions_fixed
);
855 qapi_free_ImageCheck(check
);
856 check
= g_new0(ImageCheck
, 1);
857 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
859 check
->leaks_fixed
= leaks_fixed
;
860 check
->has_leaks_fixed
= has_leaks_fixed
;
861 check
->corruptions_fixed
= corruptions_fixed
;
862 check
->has_corruptions_fixed
= has_corruptions_fixed
;
866 switch (output_format
) {
868 dump_human_image_check(check
, quiet
);
871 dump_json_image_check(check
, quiet
);
876 if (ret
|| check
->check_errors
) {
878 error_report("Check failed: %s", strerror(-ret
));
880 error_report("Check failed");
886 if (check
->corruptions
) {
888 } else if (check
->leaks
) {
895 qapi_free_ImageCheck(check
);
900 typedef struct CommonBlockJobCBInfo
{
901 BlockDriverState
*bs
;
903 } CommonBlockJobCBInfo
;
905 static void common_block_job_cb(void *opaque
, int ret
)
907 CommonBlockJobCBInfo
*cbi
= opaque
;
910 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
914 static void run_block_job(BlockJob
*job
, Error
**errp
)
916 uint64_t progress_current
, progress_total
;
917 AioContext
*aio_context
= block_job_get_aio_context(job
);
921 job_ref_locked(&job
->job
);
923 float progress
= 0.0f
;
925 aio_poll(aio_context
, true);
927 progress_get_snapshot(&job
->job
.progress
, &progress_current
,
929 if (progress_total
) {
930 progress
= (float)progress_current
/ progress_total
* 100.f
;
932 qemu_progress_print(progress
, 0);
934 } while (!job_is_ready_locked(&job
->job
) &&
935 !job_is_completed_locked(&job
->job
));
937 if (!job_is_completed_locked(&job
->job
)) {
938 ret
= job_complete_sync_locked(&job
->job
, errp
);
942 job_unref_locked(&job
->job
);
945 /* publish completion progress only when success */
947 qemu_progress_print(100.f
, 0);
951 static int img_commit(int argc
, char **argv
)
954 const char *filename
, *fmt
, *cache
, *base
;
956 BlockDriverState
*bs
, *base_bs
;
958 bool progress
= false, quiet
= false, drop
= false;
960 Error
*local_err
= NULL
;
961 CommonBlockJobCBInfo cbi
;
962 bool image_opts
= false;
963 int64_t rate_limit
= 0;
966 cache
= BDRV_DEFAULT_CACHE
;
969 static const struct option long_options
[] = {
970 {"help", no_argument
, 0, 'h'},
971 {"object", required_argument
, 0, OPTION_OBJECT
},
972 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
975 c
= getopt_long(argc
, argv
, ":f:ht:b:dpqr:",
982 missing_argument(argv
[optind
- 1]);
985 unrecognized_option(argv
[optind
- 1]);
1011 rate_limit
= cvtnum("rate limit", optarg
);
1012 if (rate_limit
< 0) {
1017 user_creatable_process_cmdline(optarg
);
1019 case OPTION_IMAGE_OPTS
:
1025 /* Progress is not shown in Quiet mode */
1030 if (optind
!= argc
- 1) {
1031 error_exit("Expecting one image file name");
1033 filename
= argv
[optind
++];
1035 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
1036 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1038 error_report("Invalid cache option: %s", cache
);
1042 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
1049 qemu_progress_init(progress
, 1.f
);
1050 qemu_progress_print(0.f
, 100);
1052 bdrv_graph_rdlock_main_loop();
1054 base_bs
= bdrv_find_backing_image(bs
, base
);
1056 error_setg(&local_err
,
1057 "Did not find '%s' in the backing chain of '%s'",
1059 bdrv_graph_rdunlock_main_loop();
1063 /* This is different from QMP, which by default uses the deepest file in
1064 * the backing chain (i.e., the very base); however, the traditional
1065 * behavior of qemu-img commit is using the immediate backing file. */
1066 base_bs
= bdrv_backing_chain_next(bs
);
1068 error_setg(&local_err
, "Image does not have a backing file");
1069 bdrv_graph_rdunlock_main_loop();
1073 bdrv_graph_rdunlock_main_loop();
1075 cbi
= (CommonBlockJobCBInfo
){
1080 commit_active_start("commit", bs
, base_bs
, JOB_DEFAULT
, rate_limit
,
1081 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1082 &cbi
, false, &local_err
);
1087 /* When the block job completes, the BlockBackend reference will point to
1088 * the old backing file. In order to avoid that the top image is already
1089 * deleted, so we can still empty it afterwards, increment the reference
1090 * counter here preemptively. */
1095 job
= block_job_get("commit");
1097 run_block_job(job
, &local_err
);
1103 BlockBackend
*old_backing_blk
;
1105 old_backing_blk
= blk_new_with_bs(bs
, BLK_PERM_WRITE
, BLK_PERM_ALL
,
1107 if (!old_backing_blk
) {
1110 ret
= blk_make_empty(old_backing_blk
, &local_err
);
1111 blk_unref(old_backing_blk
);
1112 if (ret
== -ENOTSUP
) {
1113 error_free(local_err
);
1115 } else if (ret
< 0) {
1126 qemu_progress_end();
1129 * Manually inactivate the image first because this way we can know whether
1130 * an error occurred. blk_unref() doesn't tell us about failures.
1132 ret
= bdrv_inactivate_all();
1133 if (ret
< 0 && !local_err
) {
1134 error_setg_errno(&local_err
, -ret
, "Error while closing the image");
1139 error_report_err(local_err
);
1143 qprintf(quiet
, "Image committed.\n");
1148 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1149 * of the first sector boundary within buf where the sector contains a
1150 * non-zero byte. This function is robust to a buffer that is not
1153 static int64_t find_nonzero(const uint8_t *buf
, int64_t n
)
1156 int64_t end
= QEMU_ALIGN_DOWN(n
, BDRV_SECTOR_SIZE
);
1158 for (i
= 0; i
< end
; i
+= BDRV_SECTOR_SIZE
) {
1159 if (!buffer_is_zero(buf
+ i
, BDRV_SECTOR_SIZE
)) {
1163 if (i
< n
&& !buffer_is_zero(buf
+ i
, n
- end
)) {
1170 * Returns true iff the first sector pointed to by 'buf' contains at least
1173 * 'pnum' is set to the number of sectors (including and immediately following
1174 * the first one) that are known to be in the same allocated/unallocated state.
1175 * The function will try to align the end offset to alignment boundaries so
1176 * that the request will at least end aligned and consecutive requests will
1177 * also start at an aligned offset.
1179 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
,
1180 int64_t sector_num
, int alignment
)
1189 is_zero
= buffer_is_zero(buf
, BDRV_SECTOR_SIZE
);
1190 for(i
= 1; i
< n
; i
++) {
1191 buf
+= BDRV_SECTOR_SIZE
;
1192 if (is_zero
!= buffer_is_zero(buf
, BDRV_SECTOR_SIZE
)) {
1199 * The whole buf is the same.
1200 * No reason to split it into chunks, so return now.
1206 tail
= (sector_num
+ i
) & (alignment
- 1);
1208 if (is_zero
&& i
<= tail
) {
1210 * For sure next sector after i is data, and it will rewrite this
1211 * tail anyway due to RMW. So, let's just write data now.
1216 /* If possible, align up end offset of allocated areas. */
1217 i
+= alignment
- tail
;
1221 * For sure next sector after i is data, and it will rewrite this
1222 * tail anyway due to RMW. Better is avoid RMW and write zeroes up
1233 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1235 * breaking up write requests for only small sparse areas.
1237 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1238 int min
, int64_t sector_num
, int alignment
)
1241 int num_checked
, num_used
;
1247 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1253 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1255 sector_num
+= *pnum
;
1256 num_checked
= num_used
;
1259 ret
= is_allocated_sectors(buf
, n
, pnum
, sector_num
, alignment
);
1261 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1263 sector_num
+= *pnum
;
1264 num_checked
+= *pnum
;
1266 num_used
= num_checked
;
1267 } else if (*pnum
>= min
) {
1277 * Compares two buffers chunk by chunk, where @chsize is the chunk size.
1278 * If @chsize is 0, default chunk size of BDRV_SECTOR_SIZE is used.
1279 * Returns 0 if the first chunk of each buffer matches, non-zero otherwise.
1281 * @pnum is set to the size of the buffer prefix aligned to @chsize that
1282 * has the same matching status as the first chunk.
1284 static int compare_buffers(const uint8_t *buf1
, const uint8_t *buf2
,
1285 int64_t bytes
, uint64_t chsize
, int64_t *pnum
)
1293 chsize
= BDRV_SECTOR_SIZE
;
1295 i
= MIN(bytes
, chsize
);
1297 res
= !!memcmp(buf1
, buf2
, i
);
1299 int64_t len
= MIN(bytes
- i
, chsize
);
1301 if (!!memcmp(buf1
+ i
, buf2
+ i
, len
) != res
) {
1311 #define IO_BUF_SIZE (2 * MiB)
1314 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1316 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1317 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1318 * failure), and 4 on error (the exit status for read errors), after emitting
1321 * @param blk: BlockBackend for the image
1322 * @param offset: Starting offset to check
1323 * @param bytes: Number of bytes to check
1324 * @param filename: Name of disk file we are checking (logging purpose)
1325 * @param buffer: Allocated buffer for storing read data
1326 * @param quiet: Flag for quiet mode
1328 static int check_empty_sectors(BlockBackend
*blk
, int64_t offset
,
1329 int64_t bytes
, const char *filename
,
1330 uint8_t *buffer
, bool quiet
)
1335 ret
= blk_pread(blk
, offset
, bytes
, buffer
, 0);
1337 error_report("Error while reading offset %" PRId64
" of %s: %s",
1338 offset
, filename
, strerror(-ret
));
1341 idx
= find_nonzero(buffer
, bytes
);
1343 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1352 * Compares two images. Exit codes:
1354 * 0 - Images are identical or the requested help was printed
1356 * >1 - Error occurred
1358 static int img_compare(int argc
, char **argv
)
1360 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1361 BlockBackend
*blk1
, *blk2
;
1362 BlockDriverState
*bs1
, *bs2
;
1363 int64_t total_size1
, total_size2
;
1364 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1365 int64_t pnum1
, pnum2
;
1366 int allocated1
, allocated2
;
1367 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1368 bool progress
= false, quiet
= false, strict
= false;
1375 uint64_t progress_base
;
1376 bool image_opts
= false;
1377 bool force_share
= false;
1379 cache
= BDRV_DEFAULT_CACHE
;
1381 static const struct option long_options
[] = {
1382 {"help", no_argument
, 0, 'h'},
1383 {"object", required_argument
, 0, OPTION_OBJECT
},
1384 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1385 {"force-share", no_argument
, 0, 'U'},
1388 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1389 long_options
, NULL
);
1395 missing_argument(argv
[optind
- 1]);
1398 unrecognized_option(argv
[optind
- 1]);
1426 Error
*local_err
= NULL
;
1428 if (!user_creatable_add_from_str(optarg
, &local_err
)) {
1430 error_report_err(local_err
);
1433 /* Help was printed */
1439 case OPTION_IMAGE_OPTS
:
1445 /* Progress is not shown in Quiet mode */
1451 if (optind
!= argc
- 2) {
1452 error_exit("Expecting two image file names");
1454 filename1
= argv
[optind
++];
1455 filename2
= argv
[optind
++];
1457 /* Initialize before goto out */
1458 qemu_progress_init(progress
, 2.0);
1461 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1463 error_report("Invalid source cache option: %s", cache
);
1468 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1475 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1484 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1485 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1486 total_size1
= blk_getlength(blk1
);
1487 if (total_size1
< 0) {
1488 error_report("Can't get size of %s: %s",
1489 filename1
, strerror(-total_size1
));
1493 total_size2
= blk_getlength(blk2
);
1494 if (total_size2
< 0) {
1495 error_report("Can't get size of %s: %s",
1496 filename2
, strerror(-total_size2
));
1500 total_size
= MIN(total_size1
, total_size2
);
1501 progress_base
= MAX(total_size1
, total_size2
);
1503 qemu_progress_print(0, 100);
1505 if (strict
&& total_size1
!= total_size2
) {
1507 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1511 while (offset
< total_size
) {
1512 int status1
, status2
;
1514 status1
= bdrv_block_status_above(bs1
, NULL
, offset
,
1515 total_size1
- offset
, &pnum1
, NULL
,
1519 error_report("Sector allocation test failed for %s", filename1
);
1522 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1524 status2
= bdrv_block_status_above(bs2
, NULL
, offset
,
1525 total_size2
- offset
, &pnum2
, NULL
,
1529 error_report("Sector allocation test failed for %s", filename2
);
1532 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1534 assert(pnum1
&& pnum2
);
1535 chunk
= MIN(pnum1
, pnum2
);
1538 if (status1
!= status2
) {
1540 qprintf(quiet
, "Strict mode: Offset %" PRId64
1541 " block status mismatch!\n", offset
);
1545 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1547 } else if (allocated1
== allocated2
) {
1551 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1552 ret
= blk_pread(blk1
, offset
, chunk
, buf1
, 0);
1554 error_report("Error while reading offset %" PRId64
1556 offset
, filename1
, strerror(-ret
));
1560 ret
= blk_pread(blk2
, offset
, chunk
, buf2
, 0);
1562 error_report("Error while reading offset %" PRId64
1564 offset
, filename2
, strerror(-ret
));
1568 ret
= compare_buffers(buf1
, buf2
, chunk
, 0, &pnum
);
1569 if (ret
|| pnum
!= chunk
) {
1570 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1571 offset
+ (ret
? 0 : pnum
));
1577 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1579 ret
= check_empty_sectors(blk1
, offset
, chunk
,
1580 filename1
, buf1
, quiet
);
1582 ret
= check_empty_sectors(blk2
, offset
, chunk
,
1583 filename2
, buf1
, quiet
);
1590 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1593 if (total_size1
!= total_size2
) {
1594 BlockBackend
*blk_over
;
1595 const char *filename_over
;
1597 qprintf(quiet
, "Warning: Image size mismatch!\n");
1598 if (total_size1
> total_size2
) {
1600 filename_over
= filename1
;
1603 filename_over
= filename2
;
1606 while (offset
< progress_base
) {
1607 ret
= bdrv_block_status_above(blk_bs(blk_over
), NULL
, offset
,
1608 progress_base
- offset
, &chunk
,
1612 error_report("Sector allocation test failed for %s",
1617 if (ret
& BDRV_BLOCK_ALLOCATED
&& !(ret
& BDRV_BLOCK_ZERO
)) {
1618 chunk
= MIN(chunk
, IO_BUF_SIZE
);
1619 ret
= check_empty_sectors(blk_over
, offset
, chunk
,
1620 filename_over
, buf1
, quiet
);
1626 qemu_progress_print(((float) chunk
/ progress_base
) * 100, 100);
1630 qprintf(quiet
, "Images are identical.\n");
1640 qemu_progress_end();
1644 /* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1645 static void do_dirty_bitmap_merge(const char *dst_node
, const char *dst_name
,
1646 const char *src_node
, const char *src_name
,
1649 BlockDirtyBitmapOrStr
*merge_src
;
1650 BlockDirtyBitmapOrStrList
*list
= NULL
;
1652 merge_src
= g_new0(BlockDirtyBitmapOrStr
, 1);
1653 merge_src
->type
= QTYPE_QDICT
;
1654 merge_src
->u
.external
.node
= g_strdup(src_node
);
1655 merge_src
->u
.external
.name
= g_strdup(src_name
);
1656 QAPI_LIST_PREPEND(list
, merge_src
);
1657 qmp_block_dirty_bitmap_merge(dst_node
, dst_name
, list
, errp
);
1658 qapi_free_BlockDirtyBitmapOrStrList(list
);
1661 enum ImgConvertBlockStatus
{
1667 #define MAX_COROUTINES 16
1668 #define CONVERT_THROTTLE_GROUP "img_convert"
1670 typedef struct ImgConvertState
{
1672 int64_t *src_sectors
;
1675 int64_t total_sectors
;
1676 int64_t allocated_sectors
;
1677 int64_t allocated_done
;
1680 enum ImgConvertBlockStatus status
;
1681 int64_t sector_next_status
;
1682 BlockBackend
*target
;
1686 bool target_has_backing
;
1687 int64_t target_backing_sectors
; /* negative if unknown */
1694 size_t cluster_sectors
;
1696 long num_coroutines
;
1697 int running_coroutines
;
1698 Coroutine
*co
[MAX_COROUTINES
];
1699 int64_t wait_sector_num
[MAX_COROUTINES
];
1704 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1705 int *src_cur
, int64_t *src_cur_offset
)
1708 *src_cur_offset
= 0;
1709 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1710 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1712 assert(*src_cur
< s
->src_num
);
1716 static int coroutine_mixed_fn GRAPH_RDLOCK
1717 convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1719 int64_t src_cur_offset
;
1720 int ret
, n
, src_cur
;
1721 bool post_backing_zero
= false;
1723 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1725 assert(s
->total_sectors
> sector_num
);
1726 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1728 if (s
->target_backing_sectors
>= 0) {
1729 if (sector_num
>= s
->target_backing_sectors
) {
1730 post_backing_zero
= true;
1731 } else if (sector_num
+ n
> s
->target_backing_sectors
) {
1732 /* Split requests around target_backing_sectors (because
1733 * starting from there, zeros are handled differently) */
1734 n
= s
->target_backing_sectors
- sector_num
;
1738 if (s
->sector_next_status
<= sector_num
) {
1739 uint64_t offset
= (sector_num
- src_cur_offset
) * BDRV_SECTOR_SIZE
;
1742 BlockDriverState
*src_bs
= blk_bs(s
->src
[src_cur
]);
1743 BlockDriverState
*base
;
1745 if (s
->target_has_backing
) {
1746 base
= bdrv_cow_bs(bdrv_skip_filters(src_bs
));
1752 count
= n
* BDRV_SECTOR_SIZE
;
1754 ret
= bdrv_block_status_above(src_bs
, base
, offset
, count
, &count
,
1761 warn_report("error while reading block status at "
1762 "offset %" PRIu64
": %s", offset
,
1765 /* Just try to read the data, then */
1766 ret
= BDRV_BLOCK_DATA
;
1767 count
= BDRV_SECTOR_SIZE
;
1769 /* Retry on a shorter range */
1770 n
= DIV_ROUND_UP(n
, 4);
1773 error_report("error while reading block status at offset "
1774 "%" PRIu64
": %s", offset
, strerror(-ret
));
1780 n
= DIV_ROUND_UP(count
, BDRV_SECTOR_SIZE
);
1783 * Avoid that s->sector_next_status becomes unaligned to the source
1784 * request alignment and/or cluster size to avoid unnecessary read
1787 tail
= (sector_num
- src_cur_offset
+ n
) % s
->src_alignment
[src_cur
];
1792 if (ret
& BDRV_BLOCK_ZERO
) {
1793 s
->status
= post_backing_zero
? BLK_BACKING_FILE
: BLK_ZERO
;
1794 } else if (ret
& BDRV_BLOCK_DATA
) {
1795 s
->status
= BLK_DATA
;
1797 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1800 s
->sector_next_status
= sector_num
+ n
;
1803 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1804 if (s
->status
== BLK_DATA
) {
1805 n
= MIN(n
, s
->buf_sectors
);
1808 /* We need to write complete clusters for compressed images, so if an
1809 * unallocated area is shorter than that, we must consider the whole
1810 * cluster allocated. */
1811 if (s
->compressed
) {
1812 if (n
< s
->cluster_sectors
) {
1813 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1814 s
->status
= BLK_DATA
;
1816 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1823 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1824 int nb_sectors
, uint8_t *buf
)
1826 uint64_t single_read_until
= 0;
1829 assert(nb_sectors
<= s
->buf_sectors
);
1830 while (nb_sectors
> 0) {
1833 int64_t bs_sectors
, src_cur_offset
;
1836 /* In the case of compression with multiple source files, we can get a
1837 * nb_sectors that spreads into the next part. So we must be able to
1838 * read across multiple BDSes for one convert_read() call. */
1839 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1840 blk
= s
->src
[src_cur
];
1841 bs_sectors
= s
->src_sectors
[src_cur
];
1843 offset
= (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
;
1845 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1846 if (single_read_until
> offset
) {
1850 ret
= blk_co_pread(blk
, offset
, n
<< BDRV_SECTOR_BITS
, buf
, 0);
1854 single_read_until
= offset
+ (n
<< BDRV_SECTOR_BITS
);
1858 warn_report("error while reading offset %" PRIu64
1859 ": %s", offset
, strerror(-ret
));
1861 memset(buf
, 0, BDRV_SECTOR_SIZE
);
1870 buf
+= n
* BDRV_SECTOR_SIZE
;
1877 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1878 int nb_sectors
, uint8_t *buf
,
1879 enum ImgConvertBlockStatus status
)
1883 while (nb_sectors
> 0) {
1885 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1888 case BLK_BACKING_FILE
:
1889 /* If we have a backing file, leave clusters unallocated that are
1890 * unallocated in the source image, so that the backing file is
1891 * visible at the respective offset. */
1892 assert(s
->target_has_backing
);
1896 /* If we're told to keep the target fully allocated (-S 0) or there
1897 * is real non-zero data, we must write it. Otherwise we can treat
1898 * it as zero sectors.
1899 * Compressed clusters need to be written as a whole, so in that
1900 * case we can only save the write if the buffer is completely
1902 if (!s
->min_sparse
||
1904 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
,
1905 sector_num
, s
->alignment
)) ||
1907 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1909 ret
= blk_co_pwrite(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1910 n
<< BDRV_SECTOR_BITS
, buf
, flags
);
1919 if (s
->has_zero_init
) {
1920 assert(!s
->target_has_backing
);
1923 ret
= blk_co_pwrite_zeroes(s
->target
,
1924 sector_num
<< BDRV_SECTOR_BITS
,
1925 n
<< BDRV_SECTOR_BITS
,
1926 BDRV_REQ_MAY_UNMAP
);
1935 buf
+= n
* BDRV_SECTOR_SIZE
;
1941 static int coroutine_fn
convert_co_copy_range(ImgConvertState
*s
, int64_t sector_num
,
1946 while (nb_sectors
> 0) {
1949 int64_t bs_sectors
, src_cur_offset
;
1952 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1953 offset
= (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
;
1954 blk
= s
->src
[src_cur
];
1955 bs_sectors
= s
->src_sectors
[src_cur
];
1957 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1959 ret
= blk_co_copy_range(blk
, offset
, s
->target
,
1960 sector_num
<< BDRV_SECTOR_BITS
,
1961 n
<< BDRV_SECTOR_BITS
, 0, 0);
1972 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1974 ImgConvertState
*s
= opaque
;
1975 uint8_t *buf
= NULL
;
1979 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1980 if (s
->co
[i
] == qemu_coroutine_self()) {
1987 s
->running_coroutines
++;
1988 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1993 enum ImgConvertBlockStatus status
;
1996 qemu_co_mutex_lock(&s
->lock
);
1997 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1998 qemu_co_mutex_unlock(&s
->lock
);
2001 WITH_GRAPH_RDLOCK_GUARD() {
2002 n
= convert_iteration_sectors(s
, s
->sector_num
);
2005 qemu_co_mutex_unlock(&s
->lock
);
2009 /* save current sector and allocation status to local variables */
2010 sector_num
= s
->sector_num
;
2012 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
2013 n
= MIN(n
, s
->buf_sectors
);
2015 /* increment global sector counter so that other coroutines can
2016 * already continue reading beyond this request */
2018 qemu_co_mutex_unlock(&s
->lock
);
2020 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
2021 s
->allocated_done
+= n
;
2022 qemu_progress_print(100.0 * s
->allocated_done
/
2023 s
->allocated_sectors
, 0);
2027 copy_range
= s
->copy_range
&& s
->status
== BLK_DATA
;
2028 if (status
== BLK_DATA
&& !copy_range
) {
2029 ret
= convert_co_read(s
, sector_num
, n
, buf
);
2031 error_report("error while reading at byte %lld: %s",
2032 sector_num
* BDRV_SECTOR_SIZE
, strerror(-ret
));
2035 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
2037 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
2040 if (s
->wr_in_order
) {
2041 /* keep writes in order */
2042 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
2043 s
->wait_sector_num
[index
] = sector_num
;
2044 qemu_coroutine_yield();
2046 s
->wait_sector_num
[index
] = -1;
2049 if (s
->ret
== -EINPROGRESS
) {
2051 WITH_GRAPH_RDLOCK_GUARD() {
2052 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 bdrv_graph_rdlock_main_loop();
2104 s
->has_zero_init
= bdrv_has_zero_init(blk_bs(s
->target
));
2105 bdrv_graph_rdunlock_main_loop();
2108 /* Allocate buffer for copied data. For compressed images, only one cluster
2109 * can be copied at a time. */
2110 if (s
->compressed
) {
2111 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
2112 error_report("invalid cluster size");
2115 s
->buf_sectors
= s
->cluster_sectors
;
2118 while (sector_num
< s
->total_sectors
) {
2119 bdrv_graph_rdlock_main_loop();
2120 n
= convert_iteration_sectors(s
, sector_num
);
2121 bdrv_graph_rdunlock_main_loop();
2125 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
2127 s
->allocated_sectors
+= n
;
2133 s
->sector_next_status
= 0;
2134 s
->ret
= -EINPROGRESS
;
2136 qemu_co_mutex_init(&s
->lock
);
2137 for (i
= 0; i
< s
->num_coroutines
; i
++) {
2138 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
2139 s
->wait_sector_num
[i
] = -1;
2140 qemu_coroutine_enter(s
->co
[i
]);
2143 while (s
->running_coroutines
) {
2144 main_loop_wait(false);
2147 if (s
->compressed
&& !s
->ret
) {
2148 /* signal EOF to align */
2149 ret
= blk_pwrite_compressed(s
->target
, 0, 0, NULL
);
2158 /* Check that bitmaps can be copied, or output an error */
2159 static int convert_check_bitmaps(BlockDriverState
*src
, bool skip_broken
)
2161 BdrvDirtyBitmap
*bm
;
2163 if (!bdrv_supports_persistent_dirty_bitmap(src
)) {
2164 error_report("Source lacks bitmap support");
2167 FOR_EACH_DIRTY_BITMAP(src
, bm
) {
2168 if (!bdrv_dirty_bitmap_get_persistence(bm
)) {
2171 if (!skip_broken
&& bdrv_dirty_bitmap_inconsistent(bm
)) {
2172 error_report("Cannot copy inconsistent bitmap '%s'",
2173 bdrv_dirty_bitmap_name(bm
));
2174 error_printf("Try --skip-broken-bitmaps, or "
2175 "use 'qemu-img bitmap --remove' to delete it\n");
2182 static int convert_copy_bitmaps(BlockDriverState
*src
, BlockDriverState
*dst
,
2185 BdrvDirtyBitmap
*bm
;
2188 FOR_EACH_DIRTY_BITMAP(src
, bm
) {
2191 if (!bdrv_dirty_bitmap_get_persistence(bm
)) {
2194 name
= bdrv_dirty_bitmap_name(bm
);
2195 if (skip_broken
&& bdrv_dirty_bitmap_inconsistent(bm
)) {
2196 warn_report("Skipping inconsistent bitmap '%s'", name
);
2199 qmp_block_dirty_bitmap_add(dst
->node_name
, name
,
2200 true, bdrv_dirty_bitmap_granularity(bm
),
2202 true, !bdrv_dirty_bitmap_enabled(bm
),
2205 error_reportf_err(err
, "Failed to create bitmap %s: ", name
);
2209 do_dirty_bitmap_merge(dst
->node_name
, name
, src
->node_name
, name
,
2212 error_reportf_err(err
, "Failed to populate bitmap %s: ", name
);
2213 qmp_block_dirty_bitmap_remove(dst
->node_name
, name
, NULL
);
2221 #define MAX_BUF_SECTORS 32768
2223 static void set_rate_limit(BlockBackend
*blk
, int64_t rate_limit
)
2227 throttle_config_init(&cfg
);
2228 cfg
.buckets
[THROTTLE_BPS_WRITE
].avg
= rate_limit
;
2230 blk_io_limits_enable(blk
, CONVERT_THROTTLE_GROUP
);
2231 blk_set_io_limits(blk
, &cfg
);
2234 static int img_convert(int argc
, char **argv
)
2236 int c
, bs_i
, flags
, src_flags
= BDRV_O_NO_SHARE
;
2237 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
2238 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
2239 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
,
2240 *backing_fmt
= NULL
;
2241 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
2242 BlockDriverInfo bdi
;
2243 BlockDriverState
*out_bs
;
2244 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
2245 QemuOptsList
*create_opts
= NULL
;
2246 QDict
*open_opts
= NULL
;
2247 char *options
= NULL
;
2248 Error
*local_err
= NULL
;
2249 bool writethrough
, src_writethrough
, image_opts
= false,
2250 skip_create
= false, progress
= false, tgt_image_opts
= false;
2251 int64_t ret
= -EINVAL
;
2252 bool force_share
= false;
2253 bool explict_min_sparse
= false;
2254 bool bitmaps
= false;
2255 bool skip_broken
= false;
2256 int64_t rate_limit
= 0;
2258 ImgConvertState s
= (ImgConvertState
) {
2259 /* Need at least 4k of zeros for sparse detection */
2261 .copy_range
= false,
2262 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
2263 .wr_in_order
= true,
2264 .num_coroutines
= 8,
2268 static const struct option long_options
[] = {
2269 {"help", no_argument
, 0, 'h'},
2270 {"object", required_argument
, 0, OPTION_OBJECT
},
2271 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2272 {"force-share", no_argument
, 0, 'U'},
2273 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
2274 {"salvage", no_argument
, 0, OPTION_SALVAGE
},
2275 {"target-is-zero", no_argument
, 0, OPTION_TARGET_IS_ZERO
},
2276 {"bitmaps", no_argument
, 0, OPTION_BITMAPS
},
2277 {"skip-broken-bitmaps", no_argument
, 0, OPTION_SKIP_BROKEN
},
2280 c
= getopt_long(argc
, argv
, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
2281 long_options
, NULL
);
2287 missing_argument(argv
[optind
- 1]);
2290 unrecognized_option(argv
[optind
- 1]);
2302 out_baseimg
= optarg
;
2305 s
.copy_range
= true;
2308 s
.compressed
= true;
2311 backing_fmt
= optarg
;
2314 if (accumulate_options(&options
, optarg
) < 0) {
2319 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2320 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2323 error_report("Failed in parsing snapshot param '%s'",
2328 snapshot_name
= optarg
;
2335 sval
= cvtnum("buffer size for sparse output", optarg
);
2338 } else if (!QEMU_IS_ALIGNED(sval
, BDRV_SECTOR_SIZE
) ||
2339 sval
/ BDRV_SECTOR_SIZE
> MAX_BUF_SECTORS
) {
2340 error_report("Invalid buffer size for sparse output specified. "
2341 "Valid sizes are multiples of %llu up to %llu. Select "
2342 "0 to disable sparse detection (fully allocates output).",
2343 BDRV_SECTOR_SIZE
, MAX_BUF_SECTORS
* BDRV_SECTOR_SIZE
);
2347 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2348 explict_min_sparse
= true;
2367 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2368 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2369 error_report("Invalid number of coroutines. Allowed number of"
2370 " coroutines is between 1 and %d", MAX_COROUTINES
);
2375 s
.wr_in_order
= false;
2381 rate_limit
= cvtnum("rate limit", optarg
);
2382 if (rate_limit
< 0) {
2387 user_creatable_process_cmdline(optarg
);
2389 case OPTION_IMAGE_OPTS
:
2392 case OPTION_SALVAGE
:
2395 case OPTION_TARGET_IMAGE_OPTS
:
2396 tgt_image_opts
= true;
2398 case OPTION_TARGET_IS_ZERO
:
2400 * The user asserting that the target is blank has the
2401 * same effect as the target driver supporting zero
2404 s
.has_zero_init
= true;
2406 case OPTION_BITMAPS
:
2409 case OPTION_SKIP_BROKEN
:
2415 if (!out_fmt
&& !tgt_image_opts
) {
2419 if (skip_broken
&& !bitmaps
) {
2420 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2424 if (s
.compressed
&& s
.copy_range
) {
2425 error_report("Cannot enable copy offloading when -c is used");
2429 if (explict_min_sparse
&& s
.copy_range
) {
2430 error_report("Cannot enable copy offloading when -S is used");
2434 if (s
.copy_range
&& s
.salvage
) {
2435 error_report("Cannot use copy offloading in salvaging mode");
2439 if (tgt_image_opts
&& !skip_create
) {
2440 error_report("--target-image-opts requires use of -n flag");
2444 if (skip_create
&& options
) {
2445 error_report("-o has no effect when skipping image creation");
2449 if (s
.has_zero_init
&& !skip_create
) {
2450 error_report("--target-is-zero requires use of -n flag");
2454 s
.src_num
= argc
- optind
- 1;
2455 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2457 if (options
&& has_help_option(options
)) {
2459 ret
= print_block_option_help(out_filename
, out_fmt
);
2462 error_report("Option help requires a format be specified");
2467 if (s
.src_num
< 1) {
2468 error_report("Must specify image file name");
2472 /* ret is still -EINVAL until here */
2473 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2475 error_report("Invalid source cache option: %s", src_cache
);
2479 /* Initialize before goto out */
2483 qemu_progress_init(progress
, 1.0);
2484 qemu_progress_print(0, 100);
2486 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2487 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2488 s
.src_alignment
= g_new(int, s
.src_num
);
2490 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2491 BlockDriverState
*src_bs
;
2492 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2493 fmt
, src_flags
, src_writethrough
, s
.quiet
,
2499 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2500 if (s
.src_sectors
[bs_i
] < 0) {
2501 error_report("Could not get size of %s: %s",
2502 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2506 src_bs
= blk_bs(s
.src
[bs_i
]);
2507 s
.src_alignment
[bs_i
] = DIV_ROUND_UP(src_bs
->bl
.request_alignment
,
2509 if (!bdrv_get_info(src_bs
, &bdi
)) {
2510 s
.src_alignment
[bs_i
] = MAX(s
.src_alignment
[bs_i
],
2511 bdi
.cluster_size
/ BDRV_SECTOR_SIZE
);
2513 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2517 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2518 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2519 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2521 } else if (snapshot_name
!= NULL
) {
2522 if (s
.src_num
> 1) {
2523 error_report("No support for concatenating multiple snapshot");
2528 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2532 error_reportf_err(local_err
, "Failed to load snapshot: ");
2538 /* Find driver and parse its options */
2539 drv
= bdrv_find_format(out_fmt
);
2541 error_report("Unknown file format '%s'", out_fmt
);
2546 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2548 error_report_err(local_err
);
2553 if (!drv
->create_opts
) {
2554 error_report("Format driver '%s' does not support image creation",
2560 if (!proto_drv
->create_opts
) {
2561 error_report("Protocol driver '%s' does not support image creation",
2562 proto_drv
->format_name
);
2567 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2568 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2570 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2572 if (!qemu_opts_do_parse(opts
, options
, NULL
, &local_err
)) {
2573 error_report_err(local_err
);
2579 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
2580 s
.total_sectors
* BDRV_SECTOR_SIZE
, &error_abort
);
2581 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, backing_fmt
);
2587 /* Get backing file name if -o backing_file was used */
2588 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2589 if (out_baseimg_param
) {
2590 out_baseimg
= out_baseimg_param
;
2592 s
.target_has_backing
= (bool) out_baseimg
;
2594 if (s
.has_zero_init
&& s
.target_has_backing
) {
2595 error_report("Cannot use --target-is-zero when the destination "
2596 "image has a backing file");
2600 if (s
.src_num
> 1 && out_baseimg
) {
2601 error_report("Having a backing file for the target makes no sense when "
2602 "concatenating multiple input images");
2607 if (out_baseimg_param
) {
2608 if (!qemu_opt_get(opts
, BLOCK_OPT_BACKING_FMT
)) {
2609 error_report("Use of backing file requires explicit "
2616 /* Check if compression is supported */
2619 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2620 const char *encryptfmt
=
2621 qemu_opt_get(opts
, BLOCK_OPT_ENCRYPT_FORMAT
);
2622 const char *preallocation
=
2623 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2625 if (drv
&& !block_driver_can_compress(drv
)) {
2626 error_report("Compression not supported for this file format");
2631 if (encryption
|| encryptfmt
) {
2632 error_report("Compression and encryption not supported at "
2639 && strcmp(preallocation
, "off"))
2641 error_report("Compression and preallocation not supported at "
2648 /* Determine if bitmaps need copying */
2650 if (s
.src_num
> 1) {
2651 error_report("Copying bitmaps only possible with single source");
2655 ret
= convert_check_bitmaps(blk_bs(s
.src
[0]), skip_broken
);
2662 * The later open call will need any decryption secrets, and
2663 * bdrv_create() will purge "opts", so extract them now before
2667 open_opts
= qdict_new();
2668 qemu_opt_foreach(opts
, img_add_key_secrets
, open_opts
, &error_abort
);
2670 /* Create the new image */
2671 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2673 error_reportf_err(local_err
, "%s: error while converting %s: ",
2674 out_filename
, out_fmt
);
2679 s
.target_is_new
= !skip_create
;
2681 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2682 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2684 error_report("Invalid cache option: %s", cache
);
2688 if (flags
& BDRV_O_NOCACHE
) {
2690 * If we open the target with O_DIRECT, it may be necessary to
2691 * extend its size to align to the physical sector size.
2693 flags
|= BDRV_O_RESIZE
;
2697 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2698 flags
, writethrough
, s
.quiet
, false);
2700 /* TODO ultimately we should allow --target-image-opts
2701 * to be used even when -n is not given.
2702 * That has to wait for bdrv_create to be improved
2703 * to allow filenames in option syntax
2705 s
.target
= img_open_file(out_filename
, open_opts
, out_fmt
,
2706 flags
, writethrough
, s
.quiet
, false);
2707 open_opts
= NULL
; /* blk_new_open will have freed it */
2713 out_bs
= blk_bs(s
.target
);
2715 if (bitmaps
&& !bdrv_supports_persistent_dirty_bitmap(out_bs
)) {
2716 error_report("Format driver '%s' does not support bitmaps",
2717 out_bs
->drv
->format_name
);
2722 if (s
.compressed
&& !block_driver_can_compress(out_bs
->drv
)) {
2723 error_report("Compression not supported for this file format");
2728 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2729 * or discard_alignment of the out_bs is greater. Limit to
2730 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2731 s
.buf_sectors
= MIN(MAX_BUF_SECTORS
,
2733 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2734 out_bs
->bl
.pdiscard_alignment
>>
2735 BDRV_SECTOR_BITS
)));
2737 /* try to align the write requests to the destination to avoid unnecessary
2739 s
.alignment
= MAX(pow2floor(s
.min_sparse
),
2740 DIV_ROUND_UP(out_bs
->bl
.request_alignment
,
2742 assert(is_power_of_2(s
.alignment
));
2745 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2746 if (output_sectors
< 0) {
2747 error_report("unable to get output image length: %s",
2748 strerror(-output_sectors
));
2751 } else if (output_sectors
< s
.total_sectors
) {
2752 error_report("output file is smaller than input file");
2758 if (s
.target_has_backing
&& s
.target_is_new
) {
2759 /* Errors are treated as "backing length unknown" (which means
2760 * s.target_backing_sectors has to be negative, which it will
2761 * be automatically). The backing file length is used only
2762 * for optimizations, so such a case is not fatal. */
2763 bdrv_graph_rdlock_main_loop();
2764 s
.target_backing_sectors
=
2765 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs
));
2766 bdrv_graph_rdunlock_main_loop();
2768 s
.target_backing_sectors
= -1;
2771 ret
= bdrv_get_info(out_bs
, &bdi
);
2774 error_report("could not get block driver info");
2778 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2779 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2783 set_rate_limit(s
.target
, rate_limit
);
2786 ret
= convert_do_copy(&s
);
2788 /* Now copy the bitmaps */
2789 if (bitmaps
&& ret
== 0) {
2790 ret
= convert_copy_bitmaps(blk_bs(s
.src
[0]), out_bs
, skip_broken
);
2795 qemu_progress_print(100, 0);
2797 qemu_progress_end();
2798 qemu_opts_del(opts
);
2799 qemu_opts_free(create_opts
);
2800 qobject_unref(open_opts
);
2801 blk_unref(s
.target
);
2803 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2804 blk_unref(s
.src
[bs_i
]);
2808 g_free(s
.src_sectors
);
2809 g_free(s
.src_alignment
);
2811 qemu_opts_del(sn_opts
);
2818 static void dump_snapshots(BlockDriverState
*bs
)
2820 QEMUSnapshotInfo
*sn_tab
, *sn
;
2823 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2826 printf("Snapshot list:\n");
2827 bdrv_snapshot_dump(NULL
);
2829 for(i
= 0; i
< nb_sns
; i
++) {
2831 bdrv_snapshot_dump(sn
);
2837 static void dump_json_block_graph_info_list(BlockGraphInfoList
*list
)
2841 Visitor
*v
= qobject_output_visitor_new(&obj
);
2843 visit_type_BlockGraphInfoList(v
, NULL
, &list
, &error_abort
);
2844 visit_complete(v
, &obj
);
2845 str
= qobject_to_json_pretty(obj
, true);
2846 assert(str
!= NULL
);
2847 printf("%s\n", str
->str
);
2850 g_string_free(str
, true);
2853 static void dump_json_block_graph_info(BlockGraphInfo
*info
)
2857 Visitor
*v
= qobject_output_visitor_new(&obj
);
2859 visit_type_BlockGraphInfo(v
, NULL
, &info
, &error_abort
);
2860 visit_complete(v
, &obj
);
2861 str
= qobject_to_json_pretty(obj
, true);
2862 assert(str
!= NULL
);
2863 printf("%s\n", str
->str
);
2866 g_string_free(str
, true);
2869 static void dump_human_image_info(BlockGraphInfo
*info
, int indentation
,
2872 BlockChildInfoList
*children_list
;
2874 bdrv_node_info_dump(qapi_BlockGraphInfo_base(info
), indentation
,
2875 info
->children
== NULL
);
2877 for (children_list
= info
->children
; children_list
;
2878 children_list
= children_list
->next
)
2880 BlockChildInfo
*child
= children_list
->value
;
2881 g_autofree
char *child_path
= NULL
;
2883 printf("%*sChild node '%s%s':\n",
2884 indentation
* 4, "", path
, child
->name
);
2885 child_path
= g_strdup_printf("%s%s/", path
, child
->name
);
2886 dump_human_image_info(child
->info
, indentation
+ 1, child_path
);
2890 static void dump_human_image_info_list(BlockGraphInfoList
*list
)
2892 BlockGraphInfoList
*elem
;
2895 for (elem
= list
; elem
; elem
= elem
->next
) {
2901 dump_human_image_info(elem
->value
, 0, "/");
2905 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2907 return strcmp(a
, b
) == 0;
2911 * Open an image file chain and return an BlockGraphInfoList
2913 * @filename: topmost image filename
2914 * @fmt: topmost image format (may be NULL to autodetect)
2915 * @chain: true - enumerate entire backing file chain
2916 * false - only topmost image file
2918 * Returns a list of BlockNodeInfo objects or NULL if there was an error
2919 * opening an image file. If there was an error a message will have been
2920 * printed to stderr.
2922 static BlockGraphInfoList
*collect_image_info_list(bool image_opts
,
2923 const char *filename
,
2925 bool chain
, bool force_share
)
2927 BlockGraphInfoList
*head
= NULL
;
2928 BlockGraphInfoList
**tail
= &head
;
2929 GHashTable
*filenames
;
2932 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2936 BlockDriverState
*bs
;
2937 BlockGraphInfo
*info
;
2939 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2940 error_report("Backing file '%s' creates an infinite loop.",
2944 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2946 blk
= img_open(image_opts
, filename
, fmt
,
2947 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2955 * Note that the returned BlockGraphInfo object will not have
2956 * information about this image's backing node, because we have opened
2957 * it with BDRV_O_NO_BACKING. Printing this object will therefore not
2958 * duplicate the backing chain information that we obtain by walking
2959 * the chain manually here.
2961 bdrv_graph_rdlock_main_loop();
2962 bdrv_query_block_graph_info(bs
, &info
, &err
);
2963 bdrv_graph_rdunlock_main_loop();
2966 error_report_err(err
);
2971 QAPI_LIST_APPEND(tail
, info
);
2975 /* Clear parameters that only apply to the topmost image */
2976 filename
= fmt
= NULL
;
2980 if (info
->full_backing_filename
) {
2981 filename
= info
->full_backing_filename
;
2982 } else if (info
->backing_filename
) {
2983 error_report("Could not determine absolute backing filename,"
2984 " but backing filename '%s' present",
2985 info
->backing_filename
);
2988 if (info
->backing_filename_format
) {
2989 fmt
= info
->backing_filename_format
;
2993 g_hash_table_destroy(filenames
);
2997 qapi_free_BlockGraphInfoList(head
);
2998 g_hash_table_destroy(filenames
);
3002 static int img_info(int argc
, char **argv
)
3005 OutputFormat output_format
= OFORMAT_HUMAN
;
3007 const char *filename
, *fmt
, *output
;
3008 BlockGraphInfoList
*list
;
3009 bool image_opts
= false;
3010 bool force_share
= false;
3015 int option_index
= 0;
3016 static const struct option long_options
[] = {
3017 {"help", no_argument
, 0, 'h'},
3018 {"format", required_argument
, 0, 'f'},
3019 {"output", required_argument
, 0, OPTION_OUTPUT
},
3020 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
3021 {"object", required_argument
, 0, OPTION_OBJECT
},
3022 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3023 {"force-share", no_argument
, 0, 'U'},
3026 c
= getopt_long(argc
, argv
, ":f:hU",
3027 long_options
, &option_index
);
3033 missing_argument(argv
[optind
- 1]);
3036 unrecognized_option(argv
[optind
- 1]);
3050 case OPTION_BACKING_CHAIN
:
3054 user_creatable_process_cmdline(optarg
);
3056 case OPTION_IMAGE_OPTS
:
3061 if (optind
!= argc
- 1) {
3062 error_exit("Expecting one image file name");
3064 filename
= argv
[optind
++];
3066 if (output
&& !strcmp(output
, "json")) {
3067 output_format
= OFORMAT_JSON
;
3068 } else if (output
&& !strcmp(output
, "human")) {
3069 output_format
= OFORMAT_HUMAN
;
3070 } else if (output
) {
3071 error_report("--output must be used with human or json as argument.");
3075 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
3081 switch (output_format
) {
3083 dump_human_image_info_list(list
);
3087 dump_json_block_graph_info_list(list
);
3089 dump_json_block_graph_info(list
->value
);
3094 qapi_free_BlockGraphInfoList(list
);
3098 static int dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
3101 switch (output_format
) {
3103 if (e
->data
&& !e
->has_offset
) {
3104 error_report("File contains external, encrypted or compressed clusters.");
3107 if (e
->data
&& !e
->zero
) {
3108 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
3109 e
->start
, e
->length
,
3110 e
->has_offset
? e
->offset
: 0,
3113 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3114 * Modify the flags here to allow more coalescing.
3116 if (next
&& (!next
->data
|| next
->zero
)) {
3122 printf("{ \"start\": %"PRId64
", \"length\": %"PRId64
","
3123 " \"depth\": %"PRId64
", \"present\": %s, \"zero\": %s,"
3124 " \"data\": %s, \"compressed\": %s",
3125 e
->start
, e
->length
, e
->depth
,
3126 e
->present
? "true" : "false",
3127 e
->zero
? "true" : "false",
3128 e
->data
? "true" : "false",
3129 e
->compressed
? "true" : "false");
3130 if (e
->has_offset
) {
3131 printf(", \"offset\": %"PRId64
"", e
->offset
);
3143 static int get_block_status(BlockDriverState
*bs
, int64_t offset
,
3144 int64_t bytes
, MapEntry
*e
)
3148 BlockDriverState
*file
;
3151 char *filename
= NULL
;
3153 GLOBAL_STATE_CODE();
3154 GRAPH_RDLOCK_GUARD_MAINLOOP();
3156 /* As an optimization, we could cache the current range of unallocated
3157 * clusters in each file of the chain, and avoid querying the same
3163 bs
= bdrv_skip_filters(bs
);
3164 ret
= bdrv_block_status(bs
, offset
, bytes
, &bytes
, &map
, &file
);
3169 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
3172 bs
= bdrv_cow_bs(bs
);
3181 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
3183 if (file
&& has_offset
) {
3184 bdrv_refresh_filename(file
);
3185 filename
= file
->filename
;
3191 .data
= !!(ret
& BDRV_BLOCK_DATA
),
3192 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
3193 .compressed
= !!(ret
& BDRV_BLOCK_COMPRESSED
),
3195 .has_offset
= has_offset
,
3197 .present
= !!(ret
& BDRV_BLOCK_ALLOCATED
),
3198 .filename
= filename
,
3204 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
3206 if (curr
->length
== 0) {
3209 if (curr
->zero
!= next
->zero
||
3210 curr
->data
!= next
->data
||
3211 curr
->compressed
!= next
->compressed
||
3212 curr
->depth
!= next
->depth
||
3213 curr
->present
!= next
->present
||
3214 !curr
->filename
!= !next
->filename
||
3215 curr
->has_offset
!= next
->has_offset
) {
3218 if (curr
->filename
&& strcmp(curr
->filename
, next
->filename
)) {
3221 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
3227 static int img_map(int argc
, char **argv
)
3230 OutputFormat output_format
= OFORMAT_HUMAN
;
3232 BlockDriverState
*bs
;
3233 const char *filename
, *fmt
, *output
;
3235 MapEntry curr
= { .length
= 0 }, next
;
3237 bool image_opts
= false;
3238 bool force_share
= false;
3239 int64_t start_offset
= 0;
3240 int64_t max_length
= -1;
3245 int option_index
= 0;
3246 static const struct option long_options
[] = {
3247 {"help", no_argument
, 0, 'h'},
3248 {"format", required_argument
, 0, 'f'},
3249 {"output", required_argument
, 0, OPTION_OUTPUT
},
3250 {"object", required_argument
, 0, OPTION_OBJECT
},
3251 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3252 {"force-share", no_argument
, 0, 'U'},
3253 {"start-offset", required_argument
, 0, 's'},
3254 {"max-length", required_argument
, 0, 'l'},
3257 c
= getopt_long(argc
, argv
, ":f:s:l:hU",
3258 long_options
, &option_index
);
3264 missing_argument(argv
[optind
- 1]);
3267 unrecognized_option(argv
[optind
- 1]);
3282 start_offset
= cvtnum("start offset", optarg
);
3283 if (start_offset
< 0) {
3288 max_length
= cvtnum("max length", optarg
);
3289 if (max_length
< 0) {
3294 user_creatable_process_cmdline(optarg
);
3296 case OPTION_IMAGE_OPTS
:
3301 if (optind
!= argc
- 1) {
3302 error_exit("Expecting one image file name");
3304 filename
= argv
[optind
];
3306 if (output
&& !strcmp(output
, "json")) {
3307 output_format
= OFORMAT_JSON
;
3308 } else if (output
&& !strcmp(output
, "human")) {
3309 output_format
= OFORMAT_HUMAN
;
3310 } else if (output
) {
3311 error_report("--output must be used with human or json as argument.");
3315 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
3321 if (output_format
== OFORMAT_HUMAN
) {
3322 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3323 } else if (output_format
== OFORMAT_JSON
) {
3327 length
= blk_getlength(blk
);
3329 error_report("Failed to get size for '%s'", filename
);
3332 if (max_length
!= -1) {
3333 length
= MIN(start_offset
+ max_length
, length
);
3336 curr
.start
= start_offset
;
3337 while (curr
.start
+ curr
.length
< length
) {
3338 int64_t offset
= curr
.start
+ curr
.length
;
3339 int64_t n
= length
- offset
;
3341 ret
= get_block_status(bs
, offset
, n
, &next
);
3343 error_report("Could not read file metadata: %s", strerror(-ret
));
3347 if (entry_mergeable(&curr
, &next
)) {
3348 curr
.length
+= next
.length
;
3352 if (curr
.length
> 0) {
3353 ret
= dump_map_entry(output_format
, &curr
, &next
);
3361 ret
= dump_map_entry(output_format
, &curr
, NULL
);
3362 if (output_format
== OFORMAT_JSON
) {
3371 #define SNAPSHOT_LIST 1
3372 #define SNAPSHOT_CREATE 2
3373 #define SNAPSHOT_APPLY 3
3374 #define SNAPSHOT_DELETE 4
3376 static int img_snapshot(int argc
, char **argv
)
3379 BlockDriverState
*bs
;
3380 QEMUSnapshotInfo sn
;
3381 char *filename
, *snapshot_name
= NULL
;
3382 int c
, ret
= 0, bdrv_oflags
;
3386 bool image_opts
= false;
3387 bool force_share
= false;
3390 bdrv_oflags
= BDRV_O_RDWR
;
3391 /* Parse commandline parameters */
3393 static const struct option long_options
[] = {
3394 {"help", no_argument
, 0, 'h'},
3395 {"object", required_argument
, 0, OPTION_OBJECT
},
3396 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3397 {"force-share", no_argument
, 0, 'U'},
3400 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
3401 long_options
, NULL
);
3407 missing_argument(argv
[optind
- 1]);
3410 unrecognized_option(argv
[optind
- 1]);
3417 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3420 action
= SNAPSHOT_LIST
;
3421 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
3425 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3428 action
= SNAPSHOT_APPLY
;
3429 snapshot_name
= optarg
;
3433 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3436 action
= SNAPSHOT_CREATE
;
3437 snapshot_name
= optarg
;
3441 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3444 action
= SNAPSHOT_DELETE
;
3445 snapshot_name
= optarg
;
3454 user_creatable_process_cmdline(optarg
);
3456 case OPTION_IMAGE_OPTS
:
3462 if (optind
!= argc
- 1) {
3463 error_exit("Expecting one image file name");
3465 filename
= argv
[optind
++];
3467 /* Open the image */
3468 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
3475 /* Perform the requested action */
3481 case SNAPSHOT_CREATE
:
3482 memset(&sn
, 0, sizeof(sn
));
3483 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3485 rt
= g_get_real_time();
3486 sn
.date_sec
= rt
/ G_USEC_PER_SEC
;
3487 sn
.date_nsec
= (rt
% G_USEC_PER_SEC
) * 1000;
3489 bdrv_graph_rdlock_main_loop();
3490 ret
= bdrv_snapshot_create(bs
, &sn
);
3491 bdrv_graph_rdunlock_main_loop();
3494 error_report("Could not create snapshot '%s': %s",
3495 snapshot_name
, strerror(-ret
));
3499 case SNAPSHOT_APPLY
:
3500 ret
= bdrv_snapshot_goto(bs
, snapshot_name
, &err
);
3502 error_reportf_err(err
, "Could not apply snapshot '%s': ",
3507 case SNAPSHOT_DELETE
:
3508 bdrv_graph_rdlock_main_loop();
3509 ret
= bdrv_snapshot_find(bs
, &sn
, snapshot_name
);
3511 error_report("Could not delete snapshot '%s': snapshot not "
3512 "found", snapshot_name
);
3515 ret
= bdrv_snapshot_delete(bs
, sn
.id_str
, sn
.name
, &err
);
3517 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3522 bdrv_graph_rdunlock_main_loop();
3534 static int img_rebase(int argc
, char **argv
)
3536 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3537 uint8_t *buf_old
= NULL
;
3538 uint8_t *buf_new
= NULL
;
3539 BlockDriverState
*bs
= NULL
, *prefix_chain_bs
= NULL
;
3540 BlockDriverState
*unfiltered_bs
, *unfiltered_bs_cow
;
3541 BlockDriverInfo bdi
= {0};
3543 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3544 int c
, flags
, src_flags
, ret
;
3545 BdrvRequestFlags write_flags
= 0;
3546 bool writethrough
, src_writethrough
;
3548 bool force_share
= false;
3551 bool compress
= false;
3552 Error
*local_err
= NULL
;
3553 bool image_opts
= false;
3554 int64_t write_align
;
3556 /* Parse commandline parameters */
3558 cache
= BDRV_DEFAULT_CACHE
;
3559 src_cache
= BDRV_DEFAULT_CACHE
;
3563 static const struct option long_options
[] = {
3564 {"help", no_argument
, 0, 'h'},
3565 {"object", required_argument
, 0, OPTION_OBJECT
},
3566 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3567 {"force-share", no_argument
, 0, 'U'},
3568 {"compress", no_argument
, 0, 'c'},
3571 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qUc",
3572 long_options
, NULL
);
3578 missing_argument(argv
[optind
- 1]);
3581 unrecognized_option(argv
[optind
- 1]);
3590 out_basefmt
= optarg
;
3593 out_baseimg
= optarg
;
3611 user_creatable_process_cmdline(optarg
);
3613 case OPTION_IMAGE_OPTS
:
3629 if (optind
!= argc
- 1) {
3630 error_exit("Expecting one image file name");
3632 if (!unsafe
&& !out_baseimg
) {
3633 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3635 filename
= argv
[optind
++];
3637 qemu_progress_init(progress
, 2.0);
3638 qemu_progress_print(0, 100);
3640 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3641 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3643 error_report("Invalid cache option: %s", cache
);
3648 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3650 error_report("Invalid source cache option: %s", src_cache
);
3654 /* The source files are opened read-only, don't care about WCE */
3655 assert((src_flags
& BDRV_O_RDWR
) == 0);
3656 (void) src_writethrough
;
3661 * Ignore the old backing file for unsafe rebase in case we want to correct
3662 * the reference to a renamed or moved backing file.
3664 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3672 bdrv_graph_rdlock_main_loop();
3673 unfiltered_bs
= bdrv_skip_filters(bs
);
3674 unfiltered_bs_cow
= bdrv_cow_bs(unfiltered_bs
);
3675 bdrv_graph_rdunlock_main_loop();
3677 if (compress
&& !block_driver_can_compress(unfiltered_bs
->drv
)) {
3678 error_report("Compression not supported for this file format");
3681 } else if (compress
) {
3682 write_flags
|= BDRV_REQ_WRITE_COMPRESSED
;
3685 if (out_basefmt
!= NULL
) {
3686 if (bdrv_find_format(out_basefmt
) == NULL
) {
3687 error_report("Invalid format name: '%s'", out_basefmt
);
3694 * We need overlay subcluster size (or cluster size in case writes are
3695 * compressed) to make sure write requests are aligned.
3697 ret
= bdrv_get_info(unfiltered_bs
, &bdi
);
3699 error_report("could not get block driver info");
3701 } else if (bdi
.subcluster_size
== 0) {
3702 bdi
.cluster_size
= bdi
.subcluster_size
= 1;
3705 write_align
= compress
? bdi
.cluster_size
: bdi
.subcluster_size
;
3707 /* For safe rebasing we need to compare old and new backing file */
3709 QDict
*options
= NULL
;
3710 BlockDriverState
*base_bs
;
3712 bdrv_graph_rdlock_main_loop();
3713 base_bs
= bdrv_cow_bs(unfiltered_bs
);
3714 bdrv_graph_rdunlock_main_loop();
3717 blk_old_backing
= blk_new(qemu_get_aio_context(),
3718 BLK_PERM_CONSISTENT_READ
,
3720 ret
= blk_insert_bs(blk_old_backing
, base_bs
,
3723 error_reportf_err(local_err
,
3724 "Could not reuse old backing file '%s': ",
3729 blk_old_backing
= NULL
;
3732 if (out_baseimg
[0]) {
3733 const char *overlay_filename
;
3734 char *out_real_path
;
3736 options
= qdict_new();
3738 qdict_put_str(options
, "driver", out_basefmt
);
3741 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3744 bdrv_graph_rdlock_main_loop();
3745 bdrv_refresh_filename(bs
);
3746 bdrv_graph_rdunlock_main_loop();
3747 overlay_filename
= bs
->exact_filename
[0] ? bs
->exact_filename
3750 bdrv_get_full_backing_filename_from_filename(overlay_filename
,
3754 qobject_unref(options
);
3755 error_reportf_err(local_err
,
3756 "Could not resolve backing filename: ");
3762 * Find out whether we rebase an image on top of a previous image
3765 prefix_chain_bs
= bdrv_find_backing_image(bs
, out_real_path
);
3766 if (prefix_chain_bs
) {
3767 qobject_unref(options
);
3768 g_free(out_real_path
);
3770 blk_new_backing
= blk_new(qemu_get_aio_context(),
3771 BLK_PERM_CONSISTENT_READ
,
3773 ret
= blk_insert_bs(blk_new_backing
, prefix_chain_bs
,
3776 error_reportf_err(local_err
,
3777 "Could not reuse backing file '%s': ",
3782 blk_new_backing
= blk_new_open(out_real_path
, NULL
,
3783 options
, src_flags
, &local_err
);
3784 g_free(out_real_path
);
3785 if (!blk_new_backing
) {
3786 error_reportf_err(local_err
,
3787 "Could not open new backing file '%s': ",
3797 * Check each unallocated cluster in the COW file. If it is unallocated,
3798 * accesses go to the backing file. We must therefore compare this cluster
3799 * in the old and new backing file, and if they differ we need to copy it
3800 * from the old backing file into the COW file.
3802 * If qemu-img crashes during this step, no harm is done. The content of
3803 * the image is the same as the original one at any time.
3807 int64_t old_backing_size
= 0;
3808 int64_t new_backing_size
= 0;
3810 int64_t n
, n_old
= 0, n_new
= 0;
3811 float local_progress
= 0;
3813 if (blk_old_backing
&& bdrv_opt_mem_align(blk_bs(blk_old_backing
)) >
3814 bdrv_opt_mem_align(blk_bs(blk
))) {
3815 buf_old
= blk_blockalign(blk_old_backing
, IO_BUF_SIZE
);
3817 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3819 buf_new
= blk_blockalign(blk_new_backing
, IO_BUF_SIZE
);
3821 size
= blk_getlength(blk
);
3823 error_report("Could not get size of '%s': %s",
3824 filename
, strerror(-size
));
3828 if (blk_old_backing
) {
3829 old_backing_size
= blk_getlength(blk_old_backing
);
3830 if (old_backing_size
< 0) {
3831 char backing_name
[PATH_MAX
];
3833 bdrv_get_backing_filename(bs
, backing_name
,
3834 sizeof(backing_name
));
3835 error_report("Could not get size of '%s': %s",
3836 backing_name
, strerror(-old_backing_size
));
3841 if (blk_new_backing
) {
3842 new_backing_size
= blk_getlength(blk_new_backing
);
3843 if (new_backing_size
< 0) {
3844 error_report("Could not get size of '%s': %s",
3845 out_baseimg
, strerror(-new_backing_size
));
3852 local_progress
= (float)100 / (size
/ MIN(size
, IO_BUF_SIZE
));
3855 for (offset
= 0; offset
< size
; offset
+= n
) {
3856 bool old_backing_eof
= false;
3859 /* How many bytes can we handle with the next read? */
3860 n
= MIN(IO_BUF_SIZE
, size
- offset
);
3862 /* If the cluster is allocated, we don't need to take action */
3863 ret
= bdrv_is_allocated(unfiltered_bs
, offset
, n
, &n
);
3865 error_report("error while reading image metadata: %s",
3873 if (prefix_chain_bs
) {
3877 * If cluster wasn't changed since prefix_chain, we don't need
3880 ret
= bdrv_is_allocated_above(unfiltered_bs_cow
,
3881 prefix_chain_bs
, false,
3884 error_report("error while reading image metadata: %s",
3893 * If we've reached EOF of the old backing, it means that
3894 * offsets beyond the old backing size were read as zeroes.
3895 * Now we will need to explicitly zero the cluster in
3896 * order to preserve that state after the rebase.
3903 * At this point we know that the region [offset; offset + n)
3904 * is unallocated within the target image. This region might be
3905 * unaligned to the target image's (sub)cluster boundaries, as
3906 * old backing may have smaller clusters (or have subclusters).
3907 * We extend it to the aligned boundaries to avoid CoW on
3908 * partial writes in blk_pwrite(),
3910 n
+= offset
- QEMU_ALIGN_DOWN(offset
, write_align
);
3911 offset
= QEMU_ALIGN_DOWN(offset
, write_align
);
3912 n
+= QEMU_ALIGN_UP(offset
+ n
, write_align
) - (offset
+ n
);
3913 n
= MIN(n
, size
- offset
);
3914 assert(!bdrv_is_allocated(unfiltered_bs
, offset
, n
, &n_alloc
) &&
3918 * Much like with the target image, we'll try to read as much
3919 * of the old and new backings as we can.
3921 n_old
= MIN(n
, MAX(0, old_backing_size
- (int64_t) offset
));
3922 n_new
= MIN(n
, MAX(0, new_backing_size
- (int64_t) offset
));
3925 * Read old and new backing file and take into consideration that
3926 * backing files may be smaller than the COW image.
3928 memset(buf_old
+ n_old
, 0, n
- n_old
);
3930 old_backing_eof
= true;
3932 ret
= blk_pread(blk_old_backing
, offset
, n_old
, buf_old
, 0);
3934 error_report("error while reading from old backing file");
3939 memset(buf_new
+ n_new
, 0, n
- n_new
);
3941 ret
= blk_pread(blk_new_backing
, offset
, n_new
, buf_new
, 0);
3943 error_report("error while reading from new backing file");
3948 /* If they differ, we need to write to the COW file */
3949 uint64_t written
= 0;
3951 while (written
< n
) {
3954 if (compare_buffers(buf_old
+ written
, buf_new
+ written
,
3955 n
- written
, write_align
, &pnum
))
3957 if (old_backing_eof
) {
3958 ret
= blk_pwrite_zeroes(blk
, offset
+ written
, pnum
, 0);
3960 assert(written
+ pnum
<= IO_BUF_SIZE
);
3961 ret
= blk_pwrite(blk
, offset
+ written
, pnum
,
3962 buf_old
+ written
, write_flags
);
3965 error_report("Error while writing to COW image: %s",
3972 if (offset
+ written
>= old_backing_size
) {
3973 old_backing_eof
= true;
3976 qemu_progress_print(local_progress
, 100);
3981 * Change the backing file. All clusters that are different from the old
3982 * backing file are overwritten in the COW file now, so the visible content
3983 * doesn't change when we switch the backing file.
3985 if (out_baseimg
&& *out_baseimg
) {
3986 ret
= bdrv_change_backing_file(unfiltered_bs
, out_baseimg
, out_basefmt
,
3989 ret
= bdrv_change_backing_file(unfiltered_bs
, NULL
, NULL
, false);
3992 if (ret
== -ENOSPC
) {
3993 error_report("Could not change the backing file to '%s': No "
3994 "space left in the file header", out_baseimg
);
3995 } else if (ret
== -EINVAL
&& out_baseimg
&& !out_basefmt
) {
3996 error_report("Could not change the backing file to '%s': backing "
3997 "format must be specified", out_baseimg
);
3998 } else if (ret
< 0) {
3999 error_report("Could not change the backing file to '%s': %s",
4000 out_baseimg
, strerror(-ret
));
4003 qemu_progress_print(100, 0);
4005 * TODO At this point it is possible to check if any clusters that are
4006 * allocated in the COW file are the same in the backing file. If so, they
4007 * could be dropped from the COW file. Don't do this before switching the
4008 * backing file, in case of a crash this would lead to corruption.
4011 qemu_progress_end();
4014 blk_unref(blk_old_backing
);
4015 blk_unref(blk_new_backing
);
4017 qemu_vfree(buf_old
);
4018 qemu_vfree(buf_new
);
4027 static int img_resize(int argc
, char **argv
)
4030 int c
, ret
, relative
;
4031 const char *filename
, *fmt
, *size
;
4032 int64_t n
, total_size
, current_size
;
4034 BlockBackend
*blk
= NULL
;
4035 PreallocMode prealloc
= PREALLOC_MODE_OFF
;
4038 static QemuOptsList resize_options
= {
4039 .name
= "resize_options",
4040 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
4043 .name
= BLOCK_OPT_SIZE
,
4044 .type
= QEMU_OPT_SIZE
,
4045 .help
= "Virtual disk size"
4051 bool image_opts
= false;
4052 bool shrink
= false;
4054 /* Remove size from argv manually so that negative numbers are not treated
4055 * as options by getopt. */
4057 error_exit("Not enough arguments");
4061 size
= argv
[--argc
];
4063 /* Parse getopt arguments */
4066 static const struct option long_options
[] = {
4067 {"help", no_argument
, 0, 'h'},
4068 {"object", required_argument
, 0, OPTION_OBJECT
},
4069 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4070 {"preallocation", required_argument
, 0, OPTION_PREALLOCATION
},
4071 {"shrink", no_argument
, 0, OPTION_SHRINK
},
4074 c
= getopt_long(argc
, argv
, ":f:hq",
4075 long_options
, NULL
);
4081 missing_argument(argv
[optind
- 1]);
4084 unrecognized_option(argv
[optind
- 1]);
4096 user_creatable_process_cmdline(optarg
);
4098 case OPTION_IMAGE_OPTS
:
4101 case OPTION_PREALLOCATION
:
4102 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, optarg
,
4103 PREALLOC_MODE__MAX
, NULL
);
4104 if (prealloc
== PREALLOC_MODE__MAX
) {
4105 error_report("Invalid preallocation mode '%s'", optarg
);
4114 if (optind
!= argc
- 1) {
4115 error_exit("Expecting image file name and size");
4117 filename
= argv
[optind
++];
4119 /* Choose grow, shrink, or absolute resize mode */
4135 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
4136 if (!qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
)) {
4137 error_report_err(err
);
4139 qemu_opts_del(param
);
4142 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
4143 qemu_opts_del(param
);
4145 blk
= img_open(image_opts
, filename
, fmt
,
4146 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
4153 current_size
= blk_getlength(blk
);
4154 if (current_size
< 0) {
4155 error_report("Failed to inquire current image length: %s",
4156 strerror(-current_size
));
4162 total_size
= current_size
+ n
* relative
;
4166 if (total_size
<= 0) {
4167 error_report("New image size must be positive");
4172 if (total_size
<= current_size
&& prealloc
!= PREALLOC_MODE_OFF
) {
4173 error_report("Preallocation can only be used for growing images");
4178 if (total_size
< current_size
&& !shrink
) {
4179 error_report("Use the --shrink option to perform a shrink operation.");
4180 warn_report("Shrinking an image will delete all data beyond the "
4181 "shrunken image's end. Before performing such an "
4182 "operation, make sure there is no important data there.");
4188 * The user expects the image to have the desired size after
4189 * resizing, so pass @exact=true. It is of no use to report
4190 * success when the image has not actually been resized.
4192 ret
= blk_truncate(blk
, total_size
, true, prealloc
, 0, &err
);
4194 qprintf(quiet
, "Image resized.\n");
4196 error_report_err(err
);
4206 static void amend_status_cb(BlockDriverState
*bs
,
4207 int64_t offset
, int64_t total_work_size
,
4210 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
4213 static int print_amend_option_help(const char *format
)
4217 GRAPH_RDLOCK_GUARD_MAINLOOP();
4219 /* Find driver and parse its options */
4220 drv
= bdrv_find_format(format
);
4222 error_report("Unknown file format '%s'", format
);
4226 if (!drv
->bdrv_amend_options
) {
4227 error_report("Format driver '%s' does not support option amendment",
4232 /* Every driver supporting amendment must have amend_opts */
4233 assert(drv
->amend_opts
);
4235 printf("Amend options for '%s':\n", format
);
4236 qemu_opts_print_help(drv
->amend_opts
, false);
4240 static int img_amend(int argc
, char **argv
)
4244 char *options
= NULL
;
4245 QemuOptsList
*amend_opts
= NULL
;
4246 QemuOpts
*opts
= NULL
;
4247 const char *fmt
= NULL
, *filename
, *cache
;
4250 bool quiet
= false, progress
= false;
4251 BlockBackend
*blk
= NULL
;
4252 BlockDriverState
*bs
= NULL
;
4253 bool image_opts
= false;
4256 cache
= BDRV_DEFAULT_CACHE
;
4258 static const struct option long_options
[] = {
4259 {"help", no_argument
, 0, 'h'},
4260 {"object", required_argument
, 0, OPTION_OBJECT
},
4261 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4262 {"force", no_argument
, 0, OPTION_FORCE
},
4265 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
4266 long_options
, NULL
);
4273 missing_argument(argv
[optind
- 1]);
4276 unrecognized_option(argv
[optind
- 1]);
4282 if (accumulate_options(&options
, optarg
) < 0) {
4284 goto out_no_progress
;
4300 user_creatable_process_cmdline(optarg
);
4302 case OPTION_IMAGE_OPTS
:
4312 error_exit("Must specify options (-o)");
4318 qemu_progress_init(progress
, 1.0);
4320 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
4321 if (fmt
&& has_help_option(options
)) {
4322 /* If a format is explicitly specified (and possibly no filename is
4323 * given), print option help here */
4324 ret
= print_amend_option_help(fmt
);
4328 if (optind
!= argc
- 1) {
4329 error_report("Expecting one image file name");
4334 flags
= BDRV_O_RDWR
;
4335 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
4337 error_report("Invalid cache option: %s", cache
);
4341 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4349 fmt
= bs
->drv
->format_name
;
4351 if (has_help_option(options
)) {
4352 /* If the format was auto-detected, print option help here */
4353 ret
= print_amend_option_help(fmt
);
4357 bdrv_graph_rdlock_main_loop();
4358 if (!bs
->drv
->bdrv_amend_options
) {
4359 error_report("Format driver '%s' does not support option amendment",
4361 bdrv_graph_rdunlock_main_loop();
4366 /* Every driver supporting amendment must have amend_opts */
4367 assert(bs
->drv
->amend_opts
);
4369 amend_opts
= qemu_opts_append(amend_opts
, bs
->drv
->amend_opts
);
4370 opts
= qemu_opts_create(amend_opts
, NULL
, 0, &error_abort
);
4371 if (!qemu_opts_do_parse(opts
, options
, NULL
, &err
)) {
4372 /* Try to parse options using the create options */
4373 amend_opts
= qemu_opts_append(amend_opts
, bs
->drv
->create_opts
);
4374 qemu_opts_del(opts
);
4375 opts
= qemu_opts_create(amend_opts
, NULL
, 0, &error_abort
);
4376 if (qemu_opts_do_parse(opts
, options
, NULL
, NULL
)) {
4377 error_append_hint(&err
,
4378 "This option is only supported for image creation\n");
4381 bdrv_graph_rdunlock_main_loop();
4382 error_report_err(err
);
4387 /* In case the driver does not call amend_status_cb() */
4388 qemu_progress_print(0.f
, 0);
4389 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
, force
, &err
);
4390 qemu_progress_print(100.f
, 0);
4391 bdrv_graph_rdunlock_main_loop();
4394 error_report_err(err
);
4399 qemu_progress_end();
4403 qemu_opts_del(opts
);
4404 qemu_opts_free(amend_opts
);
4413 typedef struct BenchData
{
4415 uint64_t image_size
;
4422 bool drain_on_flush
;
4431 static void bench_undrained_flush_cb(void *opaque
, int ret
)
4434 error_report("Failed flush request: %s", strerror(-ret
));
4439 static void bench_cb(void *opaque
, int ret
)
4441 BenchData
*b
= opaque
;
4445 error_report("Failed request: %s", strerror(-ret
));
4450 /* Just finished a flush with drained queue: Start next requests */
4451 assert(b
->in_flight
== 0);
4452 b
->in_flush
= false;
4453 } else if (b
->in_flight
> 0) {
4454 int remaining
= b
->n
- b
->in_flight
;
4459 /* Time for flush? Drain queue if requested, then flush */
4460 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
4461 if (!b
->in_flight
|| !b
->drain_on_flush
) {
4462 BlockCompletionFunc
*cb
;
4464 if (b
->drain_on_flush
) {
4468 cb
= bench_undrained_flush_cb
;
4471 acb
= blk_aio_flush(b
->blk
, cb
, b
);
4473 error_report("Failed to issue flush request");
4477 if (b
->drain_on_flush
) {
4483 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
4484 int64_t offset
= b
->offset
;
4485 /* blk_aio_* might look for completed I/Os and kick bench_cb
4486 * again, so make sure this operation is counted by in_flight
4487 * and b->offset is ready for the next submission.
4490 b
->offset
+= b
->step
;
4491 b
->offset
%= b
->image_size
;
4493 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4495 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
4498 error_report("Failed to issue request");
4504 static int img_bench(int argc
, char **argv
)
4507 const char *fmt
= NULL
, *filename
;
4509 bool image_opts
= false;
4510 bool is_write
= false;
4514 size_t bufsize
= 4096;
4517 int flush_interval
= 0;
4518 bool drain_on_flush
= true;
4520 BlockBackend
*blk
= NULL
;
4521 BenchData data
= {};
4523 bool writethrough
= false;
4524 struct timeval t1
, t2
;
4526 bool force_share
= false;
4527 size_t buf_size
= 0;
4530 static const struct option long_options
[] = {
4531 {"help", no_argument
, 0, 'h'},
4532 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
4533 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4534 {"pattern", required_argument
, 0, OPTION_PATTERN
},
4535 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
4536 {"force-share", no_argument
, 0, 'U'},
4539 c
= getopt_long(argc
, argv
, ":hc:d:f:ni:o:qs:S:t:wU", long_options
,
4547 missing_argument(argv
[optind
- 1]);
4550 unrecognized_option(argv
[optind
- 1]);
4559 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4560 error_report("Invalid request count specified");
4570 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4571 error_report("Invalid queue depth specified");
4581 flags
|= BDRV_O_NATIVE_AIO
;
4584 ret
= bdrv_parse_aio(optarg
, &flags
);
4586 error_report("Invalid aio option: %s", optarg
);
4593 offset
= cvtnum("offset", optarg
);
4607 sval
= cvtnum_full("buffer size", optarg
, 0, INT_MAX
);
4619 sval
= cvtnum_full("step_size", optarg
, 0, INT_MAX
);
4628 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
4630 error_report("Invalid cache mode");
4636 flags
|= BDRV_O_RDWR
;
4642 case OPTION_PATTERN
:
4646 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
4647 error_report("Invalid pattern byte specified");
4653 case OPTION_FLUSH_INTERVAL
:
4657 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4658 error_report("Invalid flush interval specified");
4661 flush_interval
= res
;
4664 case OPTION_NO_DRAIN
:
4665 drain_on_flush
= false;
4667 case OPTION_IMAGE_OPTS
:
4673 if (optind
!= argc
- 1) {
4674 error_exit("Expecting one image file name");
4676 filename
= argv
[argc
- 1];
4678 if (!is_write
&& flush_interval
) {
4679 error_report("--flush-interval is only available in write tests");
4683 if (flush_interval
&& flush_interval
< depth
) {
4684 error_report("Flush interval can't be smaller than depth");
4689 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4696 image_size
= blk_getlength(blk
);
4697 if (image_size
< 0) {
4702 data
= (BenchData
) {
4704 .image_size
= image_size
,
4706 .step
= step
?: bufsize
,
4711 .flush_interval
= flush_interval
,
4712 .drain_on_flush
= drain_on_flush
,
4714 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4715 "(starting at offset %" PRId64
", step size %d)\n",
4716 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4717 data
.offset
, data
.step
);
4718 if (flush_interval
) {
4719 printf("Sending flush every %d requests\n", flush_interval
);
4722 buf_size
= data
.nrreq
* data
.bufsize
;
4723 data
.buf
= blk_blockalign(blk
, buf_size
);
4724 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4726 blk_register_buf(blk
, data
.buf
, buf_size
, &error_fatal
);
4728 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4729 for (i
= 0; i
< data
.nrreq
; i
++) {
4730 qemu_iovec_init(&data
.qiov
[i
], 1);
4731 qemu_iovec_add(&data
.qiov
[i
],
4732 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4735 gettimeofday(&t1
, NULL
);
4738 while (data
.n
> 0) {
4739 main_loop_wait(false);
4741 gettimeofday(&t2
, NULL
);
4743 printf("Run completed in %3.3f seconds.\n",
4744 (t2
.tv_sec
- t1
.tv_sec
)
4745 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4749 blk_unregister_buf(blk
, data
.buf
, buf_size
);
4751 qemu_vfree(data
.buf
);
4768 typedef struct ImgBitmapAction
{
4769 enum ImgBitmapAct act
;
4770 const char *src
; /* only used for merge */
4771 QSIMPLEQ_ENTRY(ImgBitmapAction
) next
;
4774 static int img_bitmap(int argc
, char **argv
)
4778 QemuOpts
*opts
= NULL
;
4779 const char *fmt
= NULL
, *src_fmt
= NULL
, *src_filename
= NULL
;
4780 const char *filename
, *bitmap
;
4781 BlockBackend
*blk
= NULL
, *src
= NULL
;
4782 BlockDriverState
*bs
= NULL
, *src_bs
= NULL
;
4783 bool image_opts
= false;
4784 int64_t granularity
= 0;
4785 bool add
= false, merge
= false;
4786 QSIMPLEQ_HEAD(, ImgBitmapAction
) actions
;
4787 ImgBitmapAction
*act
, *act_next
;
4791 QSIMPLEQ_INIT(&actions
);
4794 static const struct option long_options
[] = {
4795 {"help", no_argument
, 0, 'h'},
4796 {"object", required_argument
, 0, OPTION_OBJECT
},
4797 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4798 {"add", no_argument
, 0, OPTION_ADD
},
4799 {"remove", no_argument
, 0, OPTION_REMOVE
},
4800 {"clear", no_argument
, 0, OPTION_CLEAR
},
4801 {"enable", no_argument
, 0, OPTION_ENABLE
},
4802 {"disable", no_argument
, 0, OPTION_DISABLE
},
4803 {"merge", required_argument
, 0, OPTION_MERGE
},
4804 {"granularity", required_argument
, 0, 'g'},
4805 {"source-file", required_argument
, 0, 'b'},
4806 {"source-format", required_argument
, 0, 'F'},
4809 c
= getopt_long(argc
, argv
, ":b:f:F:g:h", long_options
, NULL
);
4816 missing_argument(argv
[optind
- 1]);
4819 unrecognized_option(argv
[optind
- 1]);
4825 src_filename
= optarg
;
4834 granularity
= cvtnum("granularity", optarg
);
4835 if (granularity
< 0) {
4840 act
= g_new0(ImgBitmapAction
, 1);
4841 act
->act
= BITMAP_ADD
;
4842 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4846 act
= g_new0(ImgBitmapAction
, 1);
4847 act
->act
= BITMAP_REMOVE
;
4848 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4851 act
= g_new0(ImgBitmapAction
, 1);
4852 act
->act
= BITMAP_CLEAR
;
4853 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4856 act
= g_new0(ImgBitmapAction
, 1);
4857 act
->act
= BITMAP_ENABLE
;
4858 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4860 case OPTION_DISABLE
:
4861 act
= g_new0(ImgBitmapAction
, 1);
4862 act
->act
= BITMAP_DISABLE
;
4863 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4866 act
= g_new0(ImgBitmapAction
, 1);
4867 act
->act
= BITMAP_MERGE
;
4869 QSIMPLEQ_INSERT_TAIL(&actions
, act
, next
);
4873 user_creatable_process_cmdline(optarg
);
4875 case OPTION_IMAGE_OPTS
:
4881 if (QSIMPLEQ_EMPTY(&actions
)) {
4882 error_report("Need at least one of --add, --remove, --clear, "
4883 "--enable, --disable, or --merge");
4887 if (granularity
&& !add
) {
4888 error_report("granularity only supported with --add");
4891 if (src_fmt
&& !src_filename
) {
4892 error_report("-F only supported with -b");
4895 if (src_filename
&& !merge
) {
4896 error_report("Merge bitmap source file only supported with "
4901 if (optind
!= argc
- 2) {
4902 error_report("Expecting filename and bitmap name");
4906 filename
= argv
[optind
];
4907 bitmap
= argv
[optind
+ 1];
4910 * No need to open backing chains; we will be manipulating bitmaps
4911 * directly in this image without reference to image contents.
4913 blk
= img_open(image_opts
, filename
, fmt
, BDRV_O_RDWR
| BDRV_O_NO_BACKING
,
4914 false, false, false);
4920 src
= img_open(false, src_filename
, src_fmt
, BDRV_O_NO_BACKING
,
4921 false, false, false);
4925 src_bs
= blk_bs(src
);
4930 QSIMPLEQ_FOREACH_SAFE(act
, &actions
, next
, act_next
) {
4933 qmp_block_dirty_bitmap_add(bs
->node_name
, bitmap
,
4934 !!granularity
, granularity
, true, true,
4935 false, false, &err
);
4939 qmp_block_dirty_bitmap_remove(bs
->node_name
, bitmap
, &err
);
4943 qmp_block_dirty_bitmap_clear(bs
->node_name
, bitmap
, &err
);
4947 qmp_block_dirty_bitmap_enable(bs
->node_name
, bitmap
, &err
);
4950 case BITMAP_DISABLE
:
4951 qmp_block_dirty_bitmap_disable(bs
->node_name
, bitmap
, &err
);
4955 do_dirty_bitmap_merge(bs
->node_name
, bitmap
, src_bs
->node_name
,
4960 g_assert_not_reached();
4964 error_reportf_err(err
, "Operation %s on bitmap %s failed: ",
4975 * Manually inactivate the images first because this way we can know whether
4976 * an error occurred. blk_unref() doesn't tell us about failures.
4978 inactivate_ret
= bdrv_inactivate_all();
4979 if (inactivate_ret
< 0) {
4980 error_report("Error while closing the image: %s", strerror(-inactivate_ret
));
4986 qemu_opts_del(opts
);
5002 int bsz
; /* Block size */
5010 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
5014 static int img_dd_bs(const char *arg
,
5015 struct DdIo
*in
, struct DdIo
*out
,
5020 res
= cvtnum_full("bs", arg
, 1, INT_MAX
);
5025 in
->bsz
= out
->bsz
= res
;
5030 static int img_dd_count(const char *arg
,
5031 struct DdIo
*in
, struct DdIo
*out
,
5034 dd
->count
= cvtnum("count", arg
);
5036 if (dd
->count
< 0) {
5043 static int img_dd_if(const char *arg
,
5044 struct DdIo
*in
, struct DdIo
*out
,
5047 in
->filename
= g_strdup(arg
);
5052 static int img_dd_of(const char *arg
,
5053 struct DdIo
*in
, struct DdIo
*out
,
5056 out
->filename
= g_strdup(arg
);
5061 static int img_dd_skip(const char *arg
,
5062 struct DdIo
*in
, struct DdIo
*out
,
5065 in
->offset
= cvtnum("skip", arg
);
5067 if (in
->offset
< 0) {
5074 static int img_dd(int argc
, char **argv
)
5079 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
5080 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
5081 QemuOpts
*opts
= NULL
;
5082 QemuOptsList
*create_opts
= NULL
;
5083 Error
*local_err
= NULL
;
5084 bool image_opts
= false;
5086 const char *out_fmt
= "raw";
5087 const char *fmt
= NULL
;
5089 int64_t out_pos
, in_pos
;
5090 bool force_share
= false;
5091 struct DdInfo dd
= {
5096 .bsz
= 512, /* Block size is by default 512 bytes */
5108 const struct DdOpts options
[] = {
5109 { "bs", img_dd_bs
, C_BS
},
5110 { "count", img_dd_count
, C_COUNT
},
5111 { "if", img_dd_if
, C_IF
},
5112 { "of", img_dd_of
, C_OF
},
5113 { "skip", img_dd_skip
, C_SKIP
},
5116 const struct option long_options
[] = {
5117 { "help", no_argument
, 0, 'h'},
5118 { "object", required_argument
, 0, OPTION_OBJECT
},
5119 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
5120 { "force-share", no_argument
, 0, 'U'},
5124 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
5136 missing_argument(argv
[optind
- 1]);
5139 unrecognized_option(argv
[optind
- 1]);
5148 user_creatable_process_cmdline(optarg
);
5150 case OPTION_IMAGE_OPTS
:
5156 for (i
= optind
; i
< argc
; i
++) {
5158 arg
= g_strdup(argv
[i
]);
5160 tmp
= strchr(arg
, '=');
5162 error_report("unrecognized operand %s", arg
);
5169 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
5170 if (!strcmp(arg
, options
[j
].name
)) {
5174 if (options
[j
].name
== NULL
) {
5175 error_report("unrecognized operand %s", arg
);
5180 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
5184 dd
.flags
|= options
[j
].flag
;
5189 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
5190 error_report("Must specify both input and output files");
5195 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
5203 drv
= bdrv_find_format(out_fmt
);
5205 error_report("Unknown file format");
5209 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
5212 error_report_err(local_err
);
5216 if (!drv
->create_opts
) {
5217 error_report("Format driver '%s' does not support image creation",
5222 if (!proto_drv
->create_opts
) {
5223 error_report("Protocol driver '%s' does not support image creation",
5224 proto_drv
->format_name
);
5228 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
5229 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
5231 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
5233 size
= blk_getlength(blk1
);
5235 error_report("Failed to get size for '%s'", in
.filename
);
5240 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
5241 dd
.count
* in
.bsz
< size
) {
5242 size
= dd
.count
* in
.bsz
;
5245 /* Overflow means the specified offset is beyond input image's size */
5246 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
5247 size
< in
.bsz
* in
.offset
)) {
5248 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
5250 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
5251 size
- in
.bsz
* in
.offset
, &error_abort
);
5254 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
5256 error_reportf_err(local_err
,
5257 "%s: error while creating output image: ",
5263 /* TODO, we can't honour --image-opts for the target,
5264 * since it needs to be given in a format compatible
5265 * with the bdrv_create() call above which does not
5266 * support image-opts style.
5268 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
5269 false, false, false);
5276 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
5277 size
< in
.offset
* in
.bsz
)) {
5278 /* We give a warning if the skip option is bigger than the input
5279 * size and create an empty output disk image (i.e. like dd(1)).
5281 error_report("%s: cannot skip to specified offset", in
.filename
);
5284 in_pos
= in
.offset
* in
.bsz
;
5287 in
.buf
= g_new(uint8_t, in
.bsz
);
5289 for (out_pos
= 0; in_pos
< size
; ) {
5290 int bytes
= (in_pos
+ in
.bsz
> size
) ? size
- in_pos
: in
.bsz
;
5292 ret
= blk_pread(blk1
, in_pos
, bytes
, in
.buf
, 0);
5294 error_report("error while reading from input image file: %s",
5300 ret
= blk_pwrite(blk2
, out_pos
, bytes
, in
.buf
, 0);
5302 error_report("error while writing to output image file: %s",
5311 qemu_opts_del(opts
);
5312 qemu_opts_free(create_opts
);
5315 g_free(in
.filename
);
5316 g_free(out
.filename
);
5326 static void dump_json_block_measure_info(BlockMeasureInfo
*info
)
5330 Visitor
*v
= qobject_output_visitor_new(&obj
);
5332 visit_type_BlockMeasureInfo(v
, NULL
, &info
, &error_abort
);
5333 visit_complete(v
, &obj
);
5334 str
= qobject_to_json_pretty(obj
, true);
5335 assert(str
!= NULL
);
5336 printf("%s\n", str
->str
);
5339 g_string_free(str
, true);
5342 static int img_measure(int argc
, char **argv
)
5344 static const struct option long_options
[] = {
5345 {"help", no_argument
, 0, 'h'},
5346 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
5347 {"object", required_argument
, 0, OPTION_OBJECT
},
5348 {"output", required_argument
, 0, OPTION_OUTPUT
},
5349 {"size", required_argument
, 0, OPTION_SIZE
},
5350 {"force-share", no_argument
, 0, 'U'},
5353 OutputFormat output_format
= OFORMAT_HUMAN
;
5354 BlockBackend
*in_blk
= NULL
;
5356 const char *filename
= NULL
;
5357 const char *fmt
= NULL
;
5358 const char *out_fmt
= "raw";
5359 char *options
= NULL
;
5360 char *snapshot_name
= NULL
;
5361 bool force_share
= false;
5362 QemuOpts
*opts
= NULL
;
5363 QemuOpts
*object_opts
= NULL
;
5364 QemuOpts
*sn_opts
= NULL
;
5365 QemuOptsList
*create_opts
= NULL
;
5366 bool image_opts
= false;
5367 uint64_t img_size
= UINT64_MAX
;
5368 BlockMeasureInfo
*info
= NULL
;
5369 Error
*local_err
= NULL
;
5373 while ((c
= getopt_long(argc
, argv
, "hf:O:o:l:U",
5374 long_options
, NULL
)) != -1) {
5387 if (accumulate_options(&options
, optarg
) < 0) {
5392 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
5393 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
5396 error_report("Failed in parsing snapshot param '%s'",
5401 snapshot_name
= optarg
;
5408 user_creatable_process_cmdline(optarg
);
5410 case OPTION_IMAGE_OPTS
:
5414 if (!strcmp(optarg
, "json")) {
5415 output_format
= OFORMAT_JSON
;
5416 } else if (!strcmp(optarg
, "human")) {
5417 output_format
= OFORMAT_HUMAN
;
5419 error_report("--output must be used with human or json "
5428 sval
= cvtnum("image size", optarg
);
5432 img_size
= (uint64_t)sval
;
5438 if (argc
- optind
> 1) {
5439 error_report("At most one filename argument is allowed.");
5441 } else if (argc
- optind
== 1) {
5442 filename
= argv
[optind
];
5445 if (!filename
&& (image_opts
|| fmt
|| snapshot_name
|| sn_opts
)) {
5446 error_report("--image-opts, -f, and -l require a filename argument.");
5449 if (filename
&& img_size
!= UINT64_MAX
) {
5450 error_report("--size N cannot be used together with a filename.");
5453 if (!filename
&& img_size
== UINT64_MAX
) {
5454 error_report("Either --size N or one filename must be specified.");
5459 in_blk
= img_open(image_opts
, filename
, fmt
, 0,
5460 false, false, force_share
);
5466 bdrv_snapshot_load_tmp(blk_bs(in_blk
),
5467 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
5468 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
5470 } else if (snapshot_name
!= NULL
) {
5471 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk
),
5472 snapshot_name
, &local_err
);
5475 error_reportf_err(local_err
, "Failed to load snapshot: ");
5480 drv
= bdrv_find_format(out_fmt
);
5482 error_report("Unknown file format '%s'", out_fmt
);
5485 if (!drv
->create_opts
) {
5486 error_report("Format driver '%s' does not support image creation",
5491 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
5492 create_opts
= qemu_opts_append(create_opts
, bdrv_file
.create_opts
);
5493 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
5495 if (!qemu_opts_do_parse(opts
, options
, NULL
, &local_err
)) {
5496 error_report_err(local_err
);
5497 error_report("Invalid options for file format '%s'", out_fmt
);
5501 if (img_size
!= UINT64_MAX
) {
5502 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, img_size
, &error_abort
);
5505 info
= bdrv_measure(drv
, opts
, in_blk
? blk_bs(in_blk
) : NULL
, &local_err
);
5507 error_report_err(local_err
);
5511 if (output_format
== OFORMAT_HUMAN
) {
5512 printf("required size: %" PRIu64
"\n", info
->required
);
5513 printf("fully allocated size: %" PRIu64
"\n", info
->fully_allocated
);
5514 if (info
->has_bitmaps
) {
5515 printf("bitmaps size: %" PRIu64
"\n", info
->bitmaps
);
5518 dump_json_block_measure_info(info
);
5524 qapi_free_BlockMeasureInfo(info
);
5525 qemu_opts_del(object_opts
);
5526 qemu_opts_del(opts
);
5527 qemu_opts_del(sn_opts
);
5528 qemu_opts_free(create_opts
);
5534 static const img_cmd_t img_cmds
[] = {
5535 #define DEF(option, callback, arg_string) \
5536 { option, callback },
5537 #include "qemu-img-cmds.h"
5542 int main(int argc
, char **argv
)
5544 const img_cmd_t
*cmd
;
5545 const char *cmdname
;
5547 static const struct option long_options
[] = {
5548 {"help", no_argument
, 0, 'h'},
5549 {"version", no_argument
, 0, 'V'},
5550 {"trace", required_argument
, NULL
, 'T'},
5555 signal(SIGPIPE
, SIG_IGN
);
5559 error_init(argv
[0]);
5560 module_call_init(MODULE_INIT_TRACE
);
5561 qemu_init_exec_dir(argv
[0]);
5563 qemu_init_main_loop(&error_fatal
);
5565 qcrypto_init(&error_fatal
);
5567 module_call_init(MODULE_INIT_QOM
);
5570 error_exit("Not enough arguments");
5573 qemu_add_opts(&qemu_source_opts
);
5574 qemu_add_opts(&qemu_trace_opts
);
5576 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
5579 missing_argument(argv
[optind
- 1]);
5582 unrecognized_option(argv
[optind
- 1]);
5588 printf(QEMU_IMG_VERSION
);
5591 trace_opt_parse(optarg
);
5596 cmdname
= argv
[optind
];
5598 /* reset getopt_long scanning */
5604 qemu_reset_optind();
5606 if (!trace_init_backends()) {
5610 qemu_set_log(LOG_TRACE
, &error_fatal
);
5612 /* find the command */
5613 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
5614 if (!strcmp(cmdname
, cmd
->name
)) {
5615 return cmd
->handler(argc
, argv
);
5620 error_exit("Command not found: %s", cmdname
);