2 * QEMU disk image utility
4 * Copyright (c) 2003-2008 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "qemu/osdep.h"
27 #include "qemu-version.h"
28 #include "qapi/error.h"
29 #include "qapi-visit.h"
30 #include "qapi/qobject-output-visitor.h"
31 #include "qapi/qmp/qerror.h"
32 #include "qapi/qmp/qjson.h"
33 #include "qapi/qmp/qbool.h"
34 #include "qemu/cutils.h"
35 #include "qemu/config-file.h"
36 #include "qemu/option.h"
37 #include "qemu/error-report.h"
39 #include "qom/object_interfaces.h"
40 #include "sysemu/sysemu.h"
41 #include "sysemu/block-backend.h"
42 #include "block/block_int.h"
43 #include "block/blockjob.h"
44 #include "block/qapi.h"
45 #include "crypto/init.h"
46 #include "trace/control.h"
48 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
49 "\n" QEMU_COPYRIGHT "\n"
51 typedef struct img_cmd_t
{
53 int (*handler
)(int argc
, char **argv
);
58 OPTION_BACKING_CHAIN
= 257,
60 OPTION_IMAGE_OPTS
= 259,
62 OPTION_FLUSH_INTERVAL
= 261,
63 OPTION_NO_DRAIN
= 262,
64 OPTION_TARGET_IMAGE_OPTS
= 263,
66 OPTION_PREALLOCATION
= 265,
70 typedef enum OutputFormat
{
75 /* Default to cache=writeback as data integrity is not important for qemu-img */
76 #define BDRV_DEFAULT_CACHE "writeback"
78 static void format_print(void *opaque
, const char *name
)
83 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
87 error_printf("qemu-img: ");
90 error_vprintf(fmt
, ap
);
93 error_printf("\nTry 'qemu-img --help' for more information\n");
97 static void QEMU_NORETURN
missing_argument(const char *option
)
99 error_exit("missing argument for option '%s'", option
);
102 static void QEMU_NORETURN
unrecognized_option(const char *option
)
104 error_exit("unrecognized option '%s'", option
);
107 /* Please keep in synch with qemu-img.texi */
108 static void QEMU_NORETURN
help(void)
110 const char *help_msg
=
112 "usage: qemu-img [standard options] command [command options]\n"
113 "QEMU disk image utility\n"
115 " '-h', '--help' display this help and exit\n"
116 " '-V', '--version' output version information and exit\n"
117 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
118 " specify tracing options\n"
121 #define DEF(option, callback, arg_string) \
123 #include "qemu-img-cmds.h"
127 "Command parameters:\n"
128 " 'filename' is a disk image filename\n"
129 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
130 " manual page for a description of the object properties. The most common\n"
131 " object type is a 'secret', which is used to supply passwords and/or\n"
132 " encryption keys.\n"
133 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
134 " 'cache' is the cache mode used to write the output disk image, the valid\n"
135 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
136 " 'directsync' and 'unsafe' (default for convert)\n"
137 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
138 " options are the same as for the 'cache' option\n"
139 " 'size' is the disk image size in bytes. Optional suffixes\n"
140 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
141 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
142 " supported. 'b' is ignored.\n"
143 " 'output_filename' is the destination disk image filename\n"
144 " 'output_fmt' is the destination format\n"
145 " 'options' is a comma separated list of format specific options in a\n"
146 " name=value format. Use -o ? for an overview of the options supported by the\n"
148 " 'snapshot_param' is param used for internal snapshot, format\n"
149 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
151 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
153 " '-c' indicates that target image must be compressed (qcow format only)\n"
154 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
155 " new backing file match exactly. The image doesn't need a working\n"
156 " backing file before rebasing in this case (useful for renaming the\n"
157 " backing file). For image creation, allow creating without attempting\n"
158 " to open the backing file.\n"
159 " '-h' with or without a command shows this help and lists the supported formats\n"
160 " '-p' show progress of command (only certain commands)\n"
161 " '-q' use Quiet mode - do not print any output (except errors)\n"
162 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
163 " contain only zeros for qemu-img to create a sparse image during\n"
164 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
165 " unallocated or zero sectors, and the destination image will always be\n"
167 " '--output' takes the format in which the output must be done (human or json)\n"
168 " '-n' skips the target volume creation (useful if the volume is created\n"
169 " prior to running qemu-img)\n"
171 "Parameters to check subcommand:\n"
172 " '-r' tries to repair any inconsistencies that are found during the check.\n"
173 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
174 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
175 " hiding corruption that has already occurred.\n"
177 "Parameters to convert subcommand:\n"
178 " '-m' specifies how many coroutines work in parallel during the convert\n"
179 " process (defaults to 8)\n"
180 " '-W' allow to write to the target out of order rather than sequential\n"
182 "Parameters to snapshot subcommand:\n"
183 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
184 " '-a' applies a snapshot (revert disk to saved state)\n"
185 " '-c' creates a snapshot\n"
186 " '-d' deletes a snapshot\n"
187 " '-l' lists all snapshots in the given image\n"
189 "Parameters to compare subcommand:\n"
190 " '-f' first image format\n"
191 " '-F' second image format\n"
192 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
194 "Parameters to dd subcommand:\n"
195 " 'bs=BYTES' read and write up to BYTES bytes at a time "
197 " 'count=N' copy only N input blocks\n"
198 " 'if=FILE' read from FILE\n"
199 " 'of=FILE' write to FILE\n"
200 " 'skip=N' skip N bs-sized blocks at the start of input\n";
202 printf("%s\nSupported formats:", help_msg
);
203 bdrv_iterate_format(format_print
, NULL
);
204 printf("\n\n" QEMU_HELP_BOTTOM
"\n");
208 static QemuOptsList qemu_object_opts
= {
210 .implied_opt_name
= "qom-type",
211 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
217 static QemuOptsList qemu_source_opts
= {
219 .implied_opt_name
= "file",
220 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
226 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
232 ret
= vprintf(fmt
, args
);
239 static int print_block_option_help(const char *filename
, const char *fmt
)
241 BlockDriver
*drv
, *proto_drv
;
242 QemuOptsList
*create_opts
= NULL
;
243 Error
*local_err
= NULL
;
245 /* Find driver and parse its options */
246 drv
= bdrv_find_format(fmt
);
248 error_report("Unknown file format '%s'", fmt
);
252 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
254 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
256 error_report_err(local_err
);
257 qemu_opts_free(create_opts
);
260 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
263 qemu_opts_print_help(create_opts
);
264 qemu_opts_free(create_opts
);
269 static BlockBackend
*img_open_opts(const char *optstr
,
270 QemuOpts
*opts
, int flags
, bool writethrough
,
271 bool quiet
, bool force_share
)
274 Error
*local_err
= NULL
;
276 options
= qemu_opts_to_qdict(opts
, NULL
);
278 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
279 && !qdict_get_bool(options
, BDRV_OPT_FORCE_SHARE
)) {
280 error_report("--force-share/-U conflicts with image options");
284 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
286 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
288 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
291 blk_set_enable_write_cache(blk
, !writethrough
);
296 static BlockBackend
*img_open_file(const char *filename
,
298 const char *fmt
, int flags
,
299 bool writethrough
, bool quiet
,
303 Error
*local_err
= NULL
;
306 options
= qdict_new();
309 qdict_put_str(options
, "driver", fmt
);
313 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
315 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
317 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
320 blk_set_enable_write_cache(blk
, !writethrough
);
326 static int img_add_key_secrets(void *opaque
,
327 const char *name
, const char *value
,
330 QDict
*options
= opaque
;
332 if (g_str_has_suffix(name
, "key-secret")) {
333 qdict_put_str(options
, name
, value
);
339 static BlockBackend
*img_open_new_file(const char *filename
,
340 QemuOpts
*create_opts
,
341 const char *fmt
, int flags
,
342 bool writethrough
, bool quiet
,
345 QDict
*options
= NULL
;
347 options
= qdict_new();
348 qemu_opt_foreach(create_opts
, img_add_key_secrets
, options
, &error_abort
);
350 return img_open_file(filename
, options
, fmt
, flags
, writethrough
, quiet
,
355 static BlockBackend
*img_open(bool image_opts
,
356 const char *filename
,
357 const char *fmt
, int flags
, bool writethrough
,
358 bool quiet
, bool force_share
)
364 error_report("--image-opts and --format are mutually exclusive");
367 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
372 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
375 blk
= img_open_file(filename
, NULL
, fmt
, flags
, writethrough
, quiet
,
382 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
383 const char *base_filename
,
384 const char *base_fmt
)
389 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
391 error_report("Backing file not supported for file format '%s'",
398 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
400 error_report("Backing file format not supported for file "
409 static int64_t cvtnum(const char *s
)
414 err
= qemu_strtosz(s
, NULL
, &value
);
418 if (value
> INT64_MAX
) {
424 static int img_create(int argc
, char **argv
)
427 uint64_t img_size
= -1;
428 const char *fmt
= "raw";
429 const char *base_fmt
= NULL
;
430 const char *filename
;
431 const char *base_filename
= NULL
;
432 char *options
= NULL
;
433 Error
*local_err
= NULL
;
438 static const struct option long_options
[] = {
439 {"help", no_argument
, 0, 'h'},
440 {"object", required_argument
, 0, OPTION_OBJECT
},
443 c
= getopt_long(argc
, argv
, ":F:b:f:ho:qu",
450 missing_argument(argv
[optind
- 1]);
453 unrecognized_option(argv
[optind
- 1]);
462 base_filename
= optarg
;
468 if (!is_valid_option_list(optarg
)) {
469 error_report("Invalid option list: %s", optarg
);
473 options
= g_strdup(optarg
);
475 char *old_options
= options
;
476 options
= g_strdup_printf("%s,%s", options
, optarg
);
484 flags
|= BDRV_O_NO_BACKING
;
486 case OPTION_OBJECT
: {
488 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
497 /* Get the filename */
498 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
499 if (options
&& has_help_option(options
)) {
501 return print_block_option_help(filename
, fmt
);
504 if (optind
>= argc
) {
505 error_exit("Expecting image file name");
509 if (qemu_opts_foreach(&qemu_object_opts
,
510 user_creatable_add_opts_foreach
,
515 /* Get image size, if specified */
519 sval
= cvtnum(argv
[optind
++]);
521 if (sval
== -ERANGE
) {
522 error_report("Image size must be less than 8 EiB!");
524 error_report("Invalid image size specified! You may use k, M, "
525 "G, T, P or E suffixes for ");
526 error_report("kilobytes, megabytes, gigabytes, terabytes, "
527 "petabytes and exabytes.");
531 img_size
= (uint64_t)sval
;
533 if (optind
!= argc
) {
534 error_exit("Unexpected argument: %s", argv
[optind
]);
537 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
538 options
, img_size
, flags
, quiet
, &local_err
);
540 error_reportf_err(local_err
, "%s: ", filename
);
552 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
556 Visitor
*v
= qobject_output_visitor_new(&obj
);
558 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
559 visit_complete(v
, &obj
);
560 str
= qobject_to_json_pretty(obj
);
562 qprintf(quiet
, "%s\n", qstring_get_str(str
));
568 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
570 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
571 qprintf(quiet
, "No errors were found on the image.\n");
573 if (check
->corruptions
) {
574 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
575 "Data may be corrupted, or further writes to the image "
582 "\n%" PRId64
" leaked clusters were found on the image.\n"
583 "This means waste of disk space, but no harm to data.\n",
587 if (check
->check_errors
) {
590 " internal errors have occurred during the check.\n",
591 check
->check_errors
);
595 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
596 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
597 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
598 check
->allocated_clusters
, check
->total_clusters
,
599 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
600 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
601 check
->compressed_clusters
* 100.0 /
602 check
->allocated_clusters
);
605 if (check
->image_end_offset
) {
607 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
611 static int collect_image_check(BlockDriverState
*bs
,
613 const char *filename
,
618 BdrvCheckResult result
;
620 ret
= bdrv_check(bs
, &result
, fix
);
625 check
->filename
= g_strdup(filename
);
626 check
->format
= g_strdup(bdrv_get_format_name(bs
));
627 check
->check_errors
= result
.check_errors
;
628 check
->corruptions
= result
.corruptions
;
629 check
->has_corruptions
= result
.corruptions
!= 0;
630 check
->leaks
= result
.leaks
;
631 check
->has_leaks
= result
.leaks
!= 0;
632 check
->corruptions_fixed
= result
.corruptions_fixed
;
633 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
634 check
->leaks_fixed
= result
.leaks_fixed
;
635 check
->has_leaks_fixed
= result
.leaks
!= 0;
636 check
->image_end_offset
= result
.image_end_offset
;
637 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
638 check
->total_clusters
= result
.bfi
.total_clusters
;
639 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
640 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
641 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
642 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
643 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
644 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
645 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
651 * Checks an image for consistency. Exit codes:
653 * 0 - Check completed, image is good
654 * 1 - Check not completed because of internal errors
655 * 2 - Check completed, image is corrupted
656 * 3 - Check completed, image has leaked clusters, but is good otherwise
657 * 63 - Checks are not supported by the image format
659 static int img_check(int argc
, char **argv
)
662 OutputFormat output_format
= OFORMAT_HUMAN
;
663 const char *filename
, *fmt
, *output
, *cache
;
665 BlockDriverState
*bs
;
667 int flags
= BDRV_O_CHECK
;
671 bool image_opts
= false;
672 bool force_share
= false;
676 cache
= BDRV_DEFAULT_CACHE
;
679 int option_index
= 0;
680 static const struct option long_options
[] = {
681 {"help", no_argument
, 0, 'h'},
682 {"format", required_argument
, 0, 'f'},
683 {"repair", required_argument
, 0, 'r'},
684 {"output", required_argument
, 0, OPTION_OUTPUT
},
685 {"object", required_argument
, 0, OPTION_OBJECT
},
686 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
687 {"force-share", no_argument
, 0, 'U'},
690 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
691 long_options
, &option_index
);
697 missing_argument(argv
[optind
- 1]);
700 unrecognized_option(argv
[optind
- 1]);
709 flags
|= BDRV_O_RDWR
;
711 if (!strcmp(optarg
, "leaks")) {
712 fix
= BDRV_FIX_LEAKS
;
713 } else if (!strcmp(optarg
, "all")) {
714 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
716 error_exit("Unknown option value for -r "
717 "(expecting 'leaks' or 'all'): %s", optarg
);
732 case OPTION_OBJECT
: {
734 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
740 case OPTION_IMAGE_OPTS
:
745 if (optind
!= argc
- 1) {
746 error_exit("Expecting one image file name");
748 filename
= argv
[optind
++];
750 if (output
&& !strcmp(output
, "json")) {
751 output_format
= OFORMAT_JSON
;
752 } else if (output
&& !strcmp(output
, "human")) {
753 output_format
= OFORMAT_HUMAN
;
755 error_report("--output must be used with human or json as argument.");
759 if (qemu_opts_foreach(&qemu_object_opts
,
760 user_creatable_add_opts_foreach
,
765 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
767 error_report("Invalid source cache option: %s", cache
);
771 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
778 check
= g_new0(ImageCheck
, 1);
779 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
781 if (ret
== -ENOTSUP
) {
782 error_report("This image format does not support checks");
787 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
788 int corruptions_fixed
, leaks_fixed
;
790 leaks_fixed
= check
->leaks_fixed
;
791 corruptions_fixed
= check
->corruptions_fixed
;
793 if (output_format
== OFORMAT_HUMAN
) {
795 "The following inconsistencies were found and repaired:\n\n"
796 " %" PRId64
" leaked clusters\n"
797 " %" PRId64
" corruptions\n\n"
798 "Double checking the fixed image now...\n",
800 check
->corruptions_fixed
);
803 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
805 check
->leaks_fixed
= leaks_fixed
;
806 check
->corruptions_fixed
= corruptions_fixed
;
810 switch (output_format
) {
812 dump_human_image_check(check
, quiet
);
815 dump_json_image_check(check
, quiet
);
820 if (ret
|| check
->check_errors
) {
822 error_report("Check failed: %s", strerror(-ret
));
824 error_report("Check failed");
830 if (check
->corruptions
) {
832 } else if (check
->leaks
) {
839 qapi_free_ImageCheck(check
);
844 typedef struct CommonBlockJobCBInfo
{
845 BlockDriverState
*bs
;
847 } CommonBlockJobCBInfo
;
849 static void common_block_job_cb(void *opaque
, int ret
)
851 CommonBlockJobCBInfo
*cbi
= opaque
;
854 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
858 static void run_block_job(BlockJob
*job
, Error
**errp
)
860 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
863 aio_context_acquire(aio_context
);
866 aio_poll(aio_context
, true);
867 qemu_progress_print(job
->len
?
868 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
869 } while (!job
->ready
&& !job
->completed
);
871 if (!job
->completed
) {
872 ret
= block_job_complete_sync(job
, errp
);
876 block_job_unref(job
);
877 aio_context_release(aio_context
);
879 /* publish completion progress only when success */
881 qemu_progress_print(100.f
, 0);
885 static int img_commit(int argc
, char **argv
)
888 const char *filename
, *fmt
, *cache
, *base
;
890 BlockDriverState
*bs
, *base_bs
;
892 bool progress
= false, quiet
= false, drop
= false;
894 Error
*local_err
= NULL
;
895 CommonBlockJobCBInfo cbi
;
896 bool image_opts
= false;
897 AioContext
*aio_context
;
900 cache
= BDRV_DEFAULT_CACHE
;
903 static const struct option long_options
[] = {
904 {"help", no_argument
, 0, 'h'},
905 {"object", required_argument
, 0, OPTION_OBJECT
},
906 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
909 c
= getopt_long(argc
, argv
, ":f:ht:b:dpq",
916 missing_argument(argv
[optind
- 1]);
919 unrecognized_option(argv
[optind
- 1]);
944 case OPTION_OBJECT
: {
946 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
952 case OPTION_IMAGE_OPTS
:
958 /* Progress is not shown in Quiet mode */
963 if (optind
!= argc
- 1) {
964 error_exit("Expecting one image file name");
966 filename
= argv
[optind
++];
968 if (qemu_opts_foreach(&qemu_object_opts
,
969 user_creatable_add_opts_foreach
,
974 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
975 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
977 error_report("Invalid cache option: %s", cache
);
981 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
988 qemu_progress_init(progress
, 1.f
);
989 qemu_progress_print(0.f
, 100);
992 base_bs
= bdrv_find_backing_image(bs
, base
);
994 error_setg(&local_err
,
995 "Did not find '%s' in the backing chain of '%s'",
1000 /* This is different from QMP, which by default uses the deepest file in
1001 * the backing chain (i.e., the very base); however, the traditional
1002 * behavior of qemu-img commit is using the immediate backing file. */
1003 base_bs
= backing_bs(bs
);
1005 error_setg(&local_err
, "Image does not have a backing file");
1010 cbi
= (CommonBlockJobCBInfo
){
1015 aio_context
= bdrv_get_aio_context(bs
);
1016 aio_context_acquire(aio_context
);
1017 commit_active_start("commit", bs
, base_bs
, BLOCK_JOB_DEFAULT
, 0,
1018 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1019 &cbi
, false, &local_err
);
1020 aio_context_release(aio_context
);
1025 /* When the block job completes, the BlockBackend reference will point to
1026 * the old backing file. In order to avoid that the top image is already
1027 * deleted, so we can still empty it afterwards, increment the reference
1028 * counter here preemptively. */
1033 job
= block_job_get("commit");
1034 run_block_job(job
, &local_err
);
1039 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
1040 ret
= bs
->drv
->bdrv_make_empty(bs
);
1042 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
1054 qemu_progress_end();
1059 error_report_err(local_err
);
1063 qprintf(quiet
, "Image committed.\n");
1068 * Returns true iff the first sector pointed to by 'buf' contains at least
1071 * 'pnum' is set to the number of sectors (including and immediately following
1072 * the first one) that are known to be in the same allocated/unallocated state.
1074 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
1083 is_zero
= buffer_is_zero(buf
, 512);
1084 for(i
= 1; i
< n
; i
++) {
1086 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1095 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1096 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1097 * breaking up write requests for only small sparse areas.
1099 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1103 int num_checked
, num_used
;
1109 ret
= is_allocated_sectors(buf
, n
, pnum
);
1115 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1117 num_checked
= num_used
;
1120 ret
= is_allocated_sectors(buf
, n
, pnum
);
1122 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1124 num_checked
+= *pnum
;
1126 num_used
= num_checked
;
1127 } else if (*pnum
>= min
) {
1137 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1138 * buffers matches, non-zero otherwise.
1140 * pnum is set to the number of sectors (including and immediately following
1141 * the first one) that are known to have the same comparison result
1143 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1154 res
= !!memcmp(buf1
, buf2
, 512);
1155 for(i
= 1; i
< n
; i
++) {
1159 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1168 #define IO_BUF_SIZE (2 * 1024 * 1024)
1170 static int64_t sectors_to_bytes(int64_t sectors
)
1172 return sectors
<< BDRV_SECTOR_BITS
;
1175 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1177 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1181 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1183 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1184 * data and negative value on error.
1186 * @param blk: BlockBackend for the image
1187 * @param sect_num: Number of first sector to check
1188 * @param sect_count: Number of sectors to check
1189 * @param filename: Name of disk file we are checking (logging purpose)
1190 * @param buffer: Allocated buffer for storing read data
1191 * @param quiet: Flag for quiet mode
1193 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1194 int sect_count
, const char *filename
,
1195 uint8_t *buffer
, bool quiet
)
1198 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1199 sect_count
<< BDRV_SECTOR_BITS
);
1201 error_report("Error while reading offset %" PRId64
" of %s: %s",
1202 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1205 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1206 if (ret
|| pnum
!= sect_count
) {
1207 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1208 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1216 * Compares two images. Exit codes:
1218 * 0 - Images are identical
1220 * >1 - Error occurred
1222 static int img_compare(int argc
, char **argv
)
1224 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1225 BlockBackend
*blk1
, *blk2
;
1226 BlockDriverState
*bs1
, *bs2
;
1227 int64_t total_sectors1
, total_sectors2
;
1228 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1230 int allocated1
, allocated2
;
1231 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1232 bool progress
= false, quiet
= false, strict
= false;
1235 int64_t total_sectors
;
1236 int64_t sector_num
= 0;
1239 uint64_t progress_base
;
1240 bool image_opts
= false;
1241 bool force_share
= false;
1243 cache
= BDRV_DEFAULT_CACHE
;
1245 static const struct option long_options
[] = {
1246 {"help", no_argument
, 0, 'h'},
1247 {"object", required_argument
, 0, OPTION_OBJECT
},
1248 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1249 {"force-share", no_argument
, 0, 'U'},
1252 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1253 long_options
, NULL
);
1259 missing_argument(argv
[optind
- 1]);
1262 unrecognized_option(argv
[optind
- 1]);
1288 case OPTION_OBJECT
: {
1290 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1297 case OPTION_IMAGE_OPTS
:
1303 /* Progress is not shown in Quiet mode */
1309 if (optind
!= argc
- 2) {
1310 error_exit("Expecting two image file names");
1312 filename1
= argv
[optind
++];
1313 filename2
= argv
[optind
++];
1315 if (qemu_opts_foreach(&qemu_object_opts
,
1316 user_creatable_add_opts_foreach
,
1322 /* Initialize before goto out */
1323 qemu_progress_init(progress
, 2.0);
1326 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1328 error_report("Invalid source cache option: %s", cache
);
1333 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1340 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1349 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1350 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1351 total_sectors1
= blk_nb_sectors(blk1
);
1352 if (total_sectors1
< 0) {
1353 error_report("Can't get size of %s: %s",
1354 filename1
, strerror(-total_sectors1
));
1358 total_sectors2
= blk_nb_sectors(blk2
);
1359 if (total_sectors2
< 0) {
1360 error_report("Can't get size of %s: %s",
1361 filename2
, strerror(-total_sectors2
));
1365 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1366 progress_base
= MAX(total_sectors1
, total_sectors2
);
1368 qemu_progress_print(0, 100);
1370 if (strict
&& total_sectors1
!= total_sectors2
) {
1372 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1377 int64_t status1
, status2
;
1378 BlockDriverState
*file
;
1380 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1381 if (nb_sectors
<= 0) {
1384 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1385 total_sectors1
- sector_num
,
1389 error_report("Sector allocation test failed for %s", filename1
);
1392 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1394 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1395 total_sectors2
- sector_num
,
1399 error_report("Sector allocation test failed for %s", filename2
);
1402 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1404 nb_sectors
= MIN(nb_sectors
, pnum1
);
1407 nb_sectors
= MIN(nb_sectors
, pnum2
);
1411 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1412 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1414 qprintf(quiet
, "Strict mode: Offset %" PRId64
1415 " block status mismatch!\n",
1416 sectors_to_bytes(sector_num
));
1420 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1421 nb_sectors
= MIN(pnum1
, pnum2
);
1422 } else if (allocated1
== allocated2
) {
1424 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1425 nb_sectors
<< BDRV_SECTOR_BITS
);
1427 error_report("Error while reading offset %" PRId64
" of %s:"
1428 " %s", sectors_to_bytes(sector_num
), filename1
,
1433 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1434 nb_sectors
<< BDRV_SECTOR_BITS
);
1436 error_report("Error while reading offset %" PRId64
1437 " of %s: %s", sectors_to_bytes(sector_num
),
1438 filename2
, strerror(-ret
));
1442 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1443 if (ret
|| pnum
!= nb_sectors
) {
1444 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1446 ret
? sector_num
: sector_num
+ pnum
));
1454 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1455 filename1
, buf1
, quiet
);
1457 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1458 filename2
, buf1
, quiet
);
1462 error_report("Error while reading offset %" PRId64
": %s",
1463 sectors_to_bytes(sector_num
), strerror(-ret
));
1469 sector_num
+= nb_sectors
;
1470 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1473 if (total_sectors1
!= total_sectors2
) {
1474 BlockBackend
*blk_over
;
1475 int64_t total_sectors_over
;
1476 const char *filename_over
;
1478 qprintf(quiet
, "Warning: Image size mismatch!\n");
1479 if (total_sectors1
> total_sectors2
) {
1480 total_sectors_over
= total_sectors1
;
1482 filename_over
= filename1
;
1484 total_sectors_over
= total_sectors2
;
1486 filename_over
= filename2
;
1492 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1493 if (nb_sectors
<= 0) {
1496 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
,
1497 sector_num
* BDRV_SECTOR_SIZE
,
1498 nb_sectors
* BDRV_SECTOR_SIZE
,
1502 error_report("Sector allocation test failed for %s",
1507 /* TODO relax this once bdrv_is_allocated_above does not enforce
1508 * sector alignment */
1509 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
1510 nb_sectors
= count
>> BDRV_SECTOR_BITS
;
1512 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1513 filename_over
, buf1
, quiet
);
1516 error_report("Error while reading offset %" PRId64
1517 " of %s: %s", sectors_to_bytes(sector_num
),
1518 filename_over
, strerror(-ret
));
1524 sector_num
+= nb_sectors
;
1525 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1529 qprintf(quiet
, "Images are identical.\n");
1539 qemu_progress_end();
1544 enum ImgConvertBlockStatus
{
1550 #define MAX_COROUTINES 16
1552 typedef struct ImgConvertState
{
1554 int64_t *src_sectors
;
1556 int64_t total_sectors
;
1557 int64_t allocated_sectors
;
1558 int64_t allocated_done
;
1561 enum ImgConvertBlockStatus status
;
1562 int64_t sector_next_status
;
1563 BlockBackend
*target
;
1566 bool target_has_backing
;
1569 size_t cluster_sectors
;
1571 long num_coroutines
;
1572 int running_coroutines
;
1573 Coroutine
*co
[MAX_COROUTINES
];
1574 int64_t wait_sector_num
[MAX_COROUTINES
];
1579 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1580 int *src_cur
, int64_t *src_cur_offset
)
1583 *src_cur_offset
= 0;
1584 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1585 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1587 assert(*src_cur
< s
->src_num
);
1591 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1593 int64_t ret
, src_cur_offset
;
1596 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1598 assert(s
->total_sectors
> sector_num
);
1599 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1601 if (s
->sector_next_status
<= sector_num
) {
1602 BlockDriverState
*file
;
1603 if (s
->target_has_backing
) {
1604 ret
= bdrv_get_block_status(blk_bs(s
->src
[src_cur
]),
1605 sector_num
- src_cur_offset
,
1608 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1609 sector_num
- src_cur_offset
,
1616 if (ret
& BDRV_BLOCK_ZERO
) {
1617 s
->status
= BLK_ZERO
;
1618 } else if (ret
& BDRV_BLOCK_DATA
) {
1619 s
->status
= BLK_DATA
;
1621 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1624 s
->sector_next_status
= sector_num
+ n
;
1627 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1628 if (s
->status
== BLK_DATA
) {
1629 n
= MIN(n
, s
->buf_sectors
);
1632 /* We need to write complete clusters for compressed images, so if an
1633 * unallocated area is shorter than that, we must consider the whole
1634 * cluster allocated. */
1635 if (s
->compressed
) {
1636 if (n
< s
->cluster_sectors
) {
1637 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1638 s
->status
= BLK_DATA
;
1640 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1647 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1648 int nb_sectors
, uint8_t *buf
)
1654 assert(nb_sectors
<= s
->buf_sectors
);
1655 while (nb_sectors
> 0) {
1658 int64_t bs_sectors
, src_cur_offset
;
1660 /* In the case of compression with multiple source files, we can get a
1661 * nb_sectors that spreads into the next part. So we must be able to
1662 * read across multiple BDSes for one convert_read() call. */
1663 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1664 blk
= s
->src
[src_cur
];
1665 bs_sectors
= s
->src_sectors
[src_cur
];
1667 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1669 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1670 qemu_iovec_init_external(&qiov
, &iov
, 1);
1672 ret
= blk_co_preadv(
1673 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1674 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1681 buf
+= n
* BDRV_SECTOR_SIZE
;
1688 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1689 int nb_sectors
, uint8_t *buf
,
1690 enum ImgConvertBlockStatus status
)
1696 while (nb_sectors
> 0) {
1698 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1701 case BLK_BACKING_FILE
:
1702 /* If we have a backing file, leave clusters unallocated that are
1703 * unallocated in the source image, so that the backing file is
1704 * visible at the respective offset. */
1705 assert(s
->target_has_backing
);
1709 /* If we're told to keep the target fully allocated (-S 0) or there
1710 * is real non-zero data, we must write it. Otherwise we can treat
1711 * it as zero sectors.
1712 * Compressed clusters need to be written as a whole, so in that
1713 * case we can only save the write if the buffer is completely
1715 if (!s
->min_sparse
||
1717 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
)) ||
1719 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1722 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1723 qemu_iovec_init_external(&qiov
, &iov
, 1);
1725 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1726 n
<< BDRV_SECTOR_BITS
, &qiov
, flags
);
1735 if (s
->has_zero_init
) {
1736 assert(!s
->target_has_backing
);
1739 ret
= blk_co_pwrite_zeroes(s
->target
,
1740 sector_num
<< BDRV_SECTOR_BITS
,
1741 n
<< BDRV_SECTOR_BITS
, 0);
1750 buf
+= n
* BDRV_SECTOR_SIZE
;
1756 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1758 ImgConvertState
*s
= opaque
;
1759 uint8_t *buf
= NULL
;
1763 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1764 if (s
->co
[i
] == qemu_coroutine_self()) {
1771 s
->running_coroutines
++;
1772 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1777 enum ImgConvertBlockStatus status
;
1779 qemu_co_mutex_lock(&s
->lock
);
1780 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1781 qemu_co_mutex_unlock(&s
->lock
);
1784 n
= convert_iteration_sectors(s
, s
->sector_num
);
1786 qemu_co_mutex_unlock(&s
->lock
);
1790 /* save current sector and allocation status to local variables */
1791 sector_num
= s
->sector_num
;
1793 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1794 n
= MIN(n
, s
->buf_sectors
);
1796 /* increment global sector counter so that other coroutines can
1797 * already continue reading beyond this request */
1799 qemu_co_mutex_unlock(&s
->lock
);
1801 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1802 s
->allocated_done
+= n
;
1803 qemu_progress_print(100.0 * s
->allocated_done
/
1804 s
->allocated_sectors
, 0);
1807 if (status
== BLK_DATA
) {
1808 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1810 error_report("error while reading sector %" PRId64
1811 ": %s", sector_num
, strerror(-ret
));
1814 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1816 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1819 if (s
->wr_in_order
) {
1820 /* keep writes in order */
1821 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
1822 s
->wait_sector_num
[index
] = sector_num
;
1823 qemu_coroutine_yield();
1825 s
->wait_sector_num
[index
] = -1;
1828 if (s
->ret
== -EINPROGRESS
) {
1829 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1831 error_report("error while writing sector %" PRId64
1832 ": %s", sector_num
, strerror(-ret
));
1837 if (s
->wr_in_order
) {
1838 /* reenter the coroutine that might have waited
1839 * for this write to complete */
1840 s
->wr_offs
= sector_num
+ n
;
1841 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1842 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1844 * A -> B -> A cannot occur because A has
1845 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1846 * B will never enter A during this time window.
1848 qemu_coroutine_enter(s
->co
[i
]);
1856 s
->co
[index
] = NULL
;
1857 s
->running_coroutines
--;
1858 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1859 /* the convert job finished successfully */
1864 static int convert_do_copy(ImgConvertState
*s
)
1867 int64_t sector_num
= 0;
1869 /* Check whether we have zero initialisation or can get it efficiently */
1870 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1871 ? bdrv_has_zero_init(blk_bs(s
->target
))
1874 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1875 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1877 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1879 s
->has_zero_init
= true;
1883 /* Allocate buffer for copied data. For compressed images, only one cluster
1884 * can be copied at a time. */
1885 if (s
->compressed
) {
1886 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1887 error_report("invalid cluster size");
1890 s
->buf_sectors
= s
->cluster_sectors
;
1893 while (sector_num
< s
->total_sectors
) {
1894 n
= convert_iteration_sectors(s
, sector_num
);
1898 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1900 s
->allocated_sectors
+= n
;
1906 s
->sector_next_status
= 0;
1907 s
->ret
= -EINPROGRESS
;
1909 qemu_co_mutex_init(&s
->lock
);
1910 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1911 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1912 s
->wait_sector_num
[i
] = -1;
1913 qemu_coroutine_enter(s
->co
[i
]);
1916 while (s
->running_coroutines
) {
1917 main_loop_wait(false);
1920 if (s
->compressed
&& !s
->ret
) {
1921 /* signal EOF to align */
1922 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1931 static int img_convert(int argc
, char **argv
)
1933 int c
, bs_i
, flags
, src_flags
= 0;
1934 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
1935 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
1936 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
1937 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
1938 BlockDriverInfo bdi
;
1939 BlockDriverState
*out_bs
;
1940 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
1941 QemuOptsList
*create_opts
= NULL
;
1942 char *options
= NULL
;
1943 Error
*local_err
= NULL
;
1944 bool writethrough
, src_writethrough
, quiet
= false, image_opts
= false,
1945 skip_create
= false, progress
= false, tgt_image_opts
= false;
1946 int64_t ret
= -EINVAL
;
1947 bool force_share
= false;
1949 ImgConvertState s
= (ImgConvertState
) {
1950 /* Need at least 4k of zeros for sparse detection */
1952 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
1953 .wr_in_order
= true,
1954 .num_coroutines
= 8,
1958 static const struct option long_options
[] = {
1959 {"help", no_argument
, 0, 'h'},
1960 {"object", required_argument
, 0, OPTION_OBJECT
},
1961 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1962 {"force-share", no_argument
, 0, 'U'},
1963 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
1966 c
= getopt_long(argc
, argv
, ":hf:O:B:co:s:l:S:pt:T:qnm:WU",
1967 long_options
, NULL
);
1973 missing_argument(argv
[optind
- 1]);
1976 unrecognized_option(argv
[optind
- 1]);
1988 out_baseimg
= optarg
;
1991 s
.compressed
= true;
1994 if (!is_valid_option_list(optarg
)) {
1995 error_report("Invalid option list: %s", optarg
);
1999 options
= g_strdup(optarg
);
2001 char *old_options
= options
;
2002 options
= g_strdup_printf("%s,%s", options
, optarg
);
2003 g_free(old_options
);
2007 snapshot_name
= optarg
;
2010 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2011 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2014 error_report("Failed in parsing snapshot param '%s'",
2019 snapshot_name
= optarg
;
2026 sval
= cvtnum(optarg
);
2028 error_report("Invalid minimum zero buffer size for sparse output specified");
2032 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2051 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2052 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2053 error_report("Invalid number of coroutines. Allowed number of"
2054 " coroutines is between 1 and %d", MAX_COROUTINES
);
2059 s
.wr_in_order
= false;
2064 case OPTION_OBJECT
: {
2065 QemuOpts
*object_opts
;
2066 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2073 case OPTION_IMAGE_OPTS
:
2076 case OPTION_TARGET_IMAGE_OPTS
:
2077 tgt_image_opts
= true;
2082 if (!out_fmt
&& !tgt_image_opts
) {
2086 if (qemu_opts_foreach(&qemu_object_opts
,
2087 user_creatable_add_opts_foreach
,
2092 if (!s
.wr_in_order
&& s
.compressed
) {
2093 error_report("Out of order write and compress are mutually exclusive");
2097 if (tgt_image_opts
&& !skip_create
) {
2098 error_report("--target-image-opts requires use of -n flag");
2102 s
.src_num
= argc
- optind
- 1;
2103 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2105 if (options
&& has_help_option(options
)) {
2107 ret
= print_block_option_help(out_filename
, out_fmt
);
2110 error_report("Option help requires a format be specified");
2115 if (s
.src_num
< 1) {
2116 error_report("Must specify image file name");
2121 /* ret is still -EINVAL until here */
2122 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2124 error_report("Invalid source cache option: %s", src_cache
);
2128 /* Initialize before goto out */
2132 qemu_progress_init(progress
, 1.0);
2133 qemu_progress_print(0, 100);
2135 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2136 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2138 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2139 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2140 fmt
, src_flags
, src_writethrough
, quiet
,
2146 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2147 if (s
.src_sectors
[bs_i
] < 0) {
2148 error_report("Could not get size of %s: %s",
2149 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2153 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2157 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2158 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2159 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2161 } else if (snapshot_name
!= NULL
) {
2162 if (s
.src_num
> 1) {
2163 error_report("No support for concatenating multiple snapshot");
2168 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2172 error_reportf_err(local_err
, "Failed to load snapshot: ");
2178 /* Find driver and parse its options */
2179 drv
= bdrv_find_format(out_fmt
);
2181 error_report("Unknown file format '%s'", out_fmt
);
2186 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2188 error_report_err(local_err
);
2193 if (!drv
->create_opts
) {
2194 error_report("Format driver '%s' does not support image creation",
2200 if (!proto_drv
->create_opts
) {
2201 error_report("Protocol driver '%s' does not support image creation",
2202 proto_drv
->format_name
);
2207 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2208 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2210 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2212 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2214 error_report_err(local_err
);
2220 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, s
.total_sectors
* 512,
2222 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2228 /* Get backing file name if -o backing_file was used */
2229 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2230 if (out_baseimg_param
) {
2231 out_baseimg
= out_baseimg_param
;
2233 s
.target_has_backing
= (bool) out_baseimg
;
2235 if (s
.src_num
> 1 && out_baseimg
) {
2236 error_report("Having a backing file for the target makes no sense when "
2237 "concatenating multiple input images");
2242 /* Check if compression is supported */
2245 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2246 const char *encryptfmt
=
2247 qemu_opt_get(opts
, BLOCK_OPT_ENCRYPT_FORMAT
);
2248 const char *preallocation
=
2249 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2251 if (drv
&& !drv
->bdrv_co_pwritev_compressed
) {
2252 error_report("Compression not supported for this file format");
2257 if (encryption
|| encryptfmt
) {
2258 error_report("Compression and encryption not supported at "
2265 && strcmp(preallocation
, "off"))
2267 error_report("Compression and preallocation not supported at "
2275 /* Create the new image */
2276 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2278 error_reportf_err(local_err
, "%s: error while converting %s: ",
2279 out_filename
, out_fmt
);
2284 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2285 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2287 error_report("Invalid cache option: %s", cache
);
2292 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2293 flags
, writethrough
, quiet
, false);
2295 /* TODO ultimately we should allow --target-image-opts
2296 * to be used even when -n is not given.
2297 * That has to wait for bdrv_create to be improved
2298 * to allow filenames in option syntax
2300 s
.target
= img_open_new_file(out_filename
, opts
, out_fmt
,
2301 flags
, writethrough
, quiet
, false);
2307 out_bs
= blk_bs(s
.target
);
2309 if (s
.compressed
&& !out_bs
->drv
->bdrv_co_pwritev_compressed
) {
2310 error_report("Compression not supported for this file format");
2315 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2316 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2318 s
.buf_sectors
= MIN(32768,
2320 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2321 out_bs
->bl
.pdiscard_alignment
>>
2322 BDRV_SECTOR_BITS
)));
2325 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2326 if (output_sectors
< 0) {
2327 error_report("unable to get output image length: %s",
2328 strerror(-output_sectors
));
2331 } else if (output_sectors
< s
.total_sectors
) {
2332 error_report("output file is smaller than input file");
2338 ret
= bdrv_get_info(out_bs
, &bdi
);
2341 error_report("could not get block driver info");
2345 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2346 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2349 ret
= convert_do_copy(&s
);
2352 qemu_progress_print(100, 0);
2354 qemu_progress_end();
2355 qemu_opts_del(opts
);
2356 qemu_opts_free(create_opts
);
2357 qemu_opts_del(sn_opts
);
2358 blk_unref(s
.target
);
2360 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2361 blk_unref(s
.src
[bs_i
]);
2365 g_free(s
.src_sectors
);
2373 static void dump_snapshots(BlockDriverState
*bs
)
2375 QEMUSnapshotInfo
*sn_tab
, *sn
;
2378 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2381 printf("Snapshot list:\n");
2382 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2384 for(i
= 0; i
< nb_sns
; i
++) {
2386 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2392 static void dump_json_image_info_list(ImageInfoList
*list
)
2396 Visitor
*v
= qobject_output_visitor_new(&obj
);
2398 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2399 visit_complete(v
, &obj
);
2400 str
= qobject_to_json_pretty(obj
);
2401 assert(str
!= NULL
);
2402 printf("%s\n", qstring_get_str(str
));
2403 qobject_decref(obj
);
2408 static void dump_json_image_info(ImageInfo
*info
)
2412 Visitor
*v
= qobject_output_visitor_new(&obj
);
2414 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2415 visit_complete(v
, &obj
);
2416 str
= qobject_to_json_pretty(obj
);
2417 assert(str
!= NULL
);
2418 printf("%s\n", qstring_get_str(str
));
2419 qobject_decref(obj
);
2424 static void dump_human_image_info_list(ImageInfoList
*list
)
2426 ImageInfoList
*elem
;
2429 for (elem
= list
; elem
; elem
= elem
->next
) {
2435 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2439 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2441 return strcmp(a
, b
) == 0;
2445 * Open an image file chain and return an ImageInfoList
2447 * @filename: topmost image filename
2448 * @fmt: topmost image format (may be NULL to autodetect)
2449 * @chain: true - enumerate entire backing file chain
2450 * false - only topmost image file
2452 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2453 * image file. If there was an error a message will have been printed to
2456 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2457 const char *filename
,
2459 bool chain
, bool force_share
)
2461 ImageInfoList
*head
= NULL
;
2462 ImageInfoList
**last
= &head
;
2463 GHashTable
*filenames
;
2466 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2470 BlockDriverState
*bs
;
2472 ImageInfoList
*elem
;
2474 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2475 error_report("Backing file '%s' creates an infinite loop.",
2479 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2481 blk
= img_open(image_opts
, filename
, fmt
,
2482 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2489 bdrv_query_image_info(bs
, &info
, &err
);
2491 error_report_err(err
);
2496 elem
= g_new0(ImageInfoList
, 1);
2503 filename
= fmt
= NULL
;
2505 if (info
->has_full_backing_filename
) {
2506 filename
= info
->full_backing_filename
;
2507 } else if (info
->has_backing_filename
) {
2508 error_report("Could not determine absolute backing filename,"
2509 " but backing filename '%s' present",
2510 info
->backing_filename
);
2513 if (info
->has_backing_filename_format
) {
2514 fmt
= info
->backing_filename_format
;
2518 g_hash_table_destroy(filenames
);
2522 qapi_free_ImageInfoList(head
);
2523 g_hash_table_destroy(filenames
);
2527 static int img_info(int argc
, char **argv
)
2530 OutputFormat output_format
= OFORMAT_HUMAN
;
2532 const char *filename
, *fmt
, *output
;
2533 ImageInfoList
*list
;
2534 bool image_opts
= false;
2535 bool force_share
= false;
2540 int option_index
= 0;
2541 static const struct option long_options
[] = {
2542 {"help", no_argument
, 0, 'h'},
2543 {"format", required_argument
, 0, 'f'},
2544 {"output", required_argument
, 0, OPTION_OUTPUT
},
2545 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2546 {"object", required_argument
, 0, OPTION_OBJECT
},
2547 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2548 {"force-share", no_argument
, 0, 'U'},
2551 c
= getopt_long(argc
, argv
, ":f:hU",
2552 long_options
, &option_index
);
2558 missing_argument(argv
[optind
- 1]);
2561 unrecognized_option(argv
[optind
- 1]);
2575 case OPTION_BACKING_CHAIN
:
2578 case OPTION_OBJECT
: {
2580 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2586 case OPTION_IMAGE_OPTS
:
2591 if (optind
!= argc
- 1) {
2592 error_exit("Expecting one image file name");
2594 filename
= argv
[optind
++];
2596 if (output
&& !strcmp(output
, "json")) {
2597 output_format
= OFORMAT_JSON
;
2598 } else if (output
&& !strcmp(output
, "human")) {
2599 output_format
= OFORMAT_HUMAN
;
2600 } else if (output
) {
2601 error_report("--output must be used with human or json as argument.");
2605 if (qemu_opts_foreach(&qemu_object_opts
,
2606 user_creatable_add_opts_foreach
,
2611 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
2617 switch (output_format
) {
2619 dump_human_image_info_list(list
);
2623 dump_json_image_info_list(list
);
2625 dump_json_image_info(list
->value
);
2630 qapi_free_ImageInfoList(list
);
2634 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2637 switch (output_format
) {
2639 if (e
->data
&& !e
->has_offset
) {
2640 error_report("File contains external, encrypted or compressed clusters.");
2643 if (e
->data
&& !e
->zero
) {
2644 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2645 e
->start
, e
->length
,
2646 e
->has_offset
? e
->offset
: 0,
2647 e
->has_filename
? e
->filename
: "");
2649 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2650 * Modify the flags here to allow more coalescing.
2652 if (next
&& (!next
->data
|| next
->zero
)) {
2658 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2659 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2660 (e
->start
== 0 ? "[" : ",\n"),
2661 e
->start
, e
->length
, e
->depth
,
2662 e
->zero
? "true" : "false",
2663 e
->data
? "true" : "false");
2664 if (e
->has_offset
) {
2665 printf(", \"offset\": %"PRId64
"", e
->offset
);
2676 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2677 int nb_sectors
, MapEntry
*e
)
2681 BlockDriverState
*file
;
2684 /* As an optimization, we could cache the current range of unallocated
2685 * clusters in each file of the chain, and avoid querying the same
2691 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2697 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2700 bs
= backing_bs(bs
);
2709 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2712 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2713 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2714 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2715 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2716 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2717 .has_offset
= has_offset
,
2719 .has_filename
= file
&& has_offset
,
2720 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2726 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2728 if (curr
->length
== 0) {
2731 if (curr
->zero
!= next
->zero
||
2732 curr
->data
!= next
->data
||
2733 curr
->depth
!= next
->depth
||
2734 curr
->has_filename
!= next
->has_filename
||
2735 curr
->has_offset
!= next
->has_offset
) {
2738 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2741 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2747 static int img_map(int argc
, char **argv
)
2750 OutputFormat output_format
= OFORMAT_HUMAN
;
2752 BlockDriverState
*bs
;
2753 const char *filename
, *fmt
, *output
;
2755 MapEntry curr
= { .length
= 0 }, next
;
2757 bool image_opts
= false;
2758 bool force_share
= false;
2763 int option_index
= 0;
2764 static const struct option long_options
[] = {
2765 {"help", no_argument
, 0, 'h'},
2766 {"format", required_argument
, 0, 'f'},
2767 {"output", required_argument
, 0, OPTION_OUTPUT
},
2768 {"object", required_argument
, 0, OPTION_OBJECT
},
2769 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2770 {"force-share", no_argument
, 0, 'U'},
2773 c
= getopt_long(argc
, argv
, ":f:hU",
2774 long_options
, &option_index
);
2780 missing_argument(argv
[optind
- 1]);
2783 unrecognized_option(argv
[optind
- 1]);
2797 case OPTION_OBJECT
: {
2799 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2805 case OPTION_IMAGE_OPTS
:
2810 if (optind
!= argc
- 1) {
2811 error_exit("Expecting one image file name");
2813 filename
= argv
[optind
];
2815 if (output
&& !strcmp(output
, "json")) {
2816 output_format
= OFORMAT_JSON
;
2817 } else if (output
&& !strcmp(output
, "human")) {
2818 output_format
= OFORMAT_HUMAN
;
2819 } else if (output
) {
2820 error_report("--output must be used with human or json as argument.");
2824 if (qemu_opts_foreach(&qemu_object_opts
,
2825 user_creatable_add_opts_foreach
,
2830 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
2836 if (output_format
== OFORMAT_HUMAN
) {
2837 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2840 length
= blk_getlength(blk
);
2841 while (curr
.start
+ curr
.length
< length
) {
2842 int64_t nsectors_left
;
2846 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2848 /* Probe up to 1 GiB at a time. */
2849 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2850 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2851 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2854 error_report("Could not read file metadata: %s", strerror(-ret
));
2858 if (entry_mergeable(&curr
, &next
)) {
2859 curr
.length
+= next
.length
;
2863 if (curr
.length
> 0) {
2864 dump_map_entry(output_format
, &curr
, &next
);
2869 dump_map_entry(output_format
, &curr
, NULL
);
2876 #define SNAPSHOT_LIST 1
2877 #define SNAPSHOT_CREATE 2
2878 #define SNAPSHOT_APPLY 3
2879 #define SNAPSHOT_DELETE 4
2881 static int img_snapshot(int argc
, char **argv
)
2884 BlockDriverState
*bs
;
2885 QEMUSnapshotInfo sn
;
2886 char *filename
, *snapshot_name
= NULL
;
2887 int c
, ret
= 0, bdrv_oflags
;
2892 bool image_opts
= false;
2893 bool force_share
= false;
2895 bdrv_oflags
= BDRV_O_RDWR
;
2896 /* Parse commandline parameters */
2898 static const struct option long_options
[] = {
2899 {"help", no_argument
, 0, 'h'},
2900 {"object", required_argument
, 0, OPTION_OBJECT
},
2901 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2902 {"force-share", no_argument
, 0, 'U'},
2905 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
2906 long_options
, NULL
);
2912 missing_argument(argv
[optind
- 1]);
2915 unrecognized_option(argv
[optind
- 1]);
2922 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2925 action
= SNAPSHOT_LIST
;
2926 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2930 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2933 action
= SNAPSHOT_APPLY
;
2934 snapshot_name
= optarg
;
2938 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2941 action
= SNAPSHOT_CREATE
;
2942 snapshot_name
= optarg
;
2946 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2949 action
= SNAPSHOT_DELETE
;
2950 snapshot_name
= optarg
;
2958 case OPTION_OBJECT
: {
2960 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2966 case OPTION_IMAGE_OPTS
:
2972 if (optind
!= argc
- 1) {
2973 error_exit("Expecting one image file name");
2975 filename
= argv
[optind
++];
2977 if (qemu_opts_foreach(&qemu_object_opts
,
2978 user_creatable_add_opts_foreach
,
2983 /* Open the image */
2984 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
2991 /* Perform the requested action */
2997 case SNAPSHOT_CREATE
:
2998 memset(&sn
, 0, sizeof(sn
));
2999 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3001 qemu_gettimeofday(&tv
);
3002 sn
.date_sec
= tv
.tv_sec
;
3003 sn
.date_nsec
= tv
.tv_usec
* 1000;
3005 ret
= bdrv_snapshot_create(bs
, &sn
);
3007 error_report("Could not create snapshot '%s': %d (%s)",
3008 snapshot_name
, ret
, strerror(-ret
));
3012 case SNAPSHOT_APPLY
:
3013 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
3015 error_report("Could not apply snapshot '%s': %d (%s)",
3016 snapshot_name
, ret
, strerror(-ret
));
3020 case SNAPSHOT_DELETE
:
3021 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
3023 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3038 static int img_rebase(int argc
, char **argv
)
3040 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3041 uint8_t *buf_old
= NULL
;
3042 uint8_t *buf_new
= NULL
;
3043 BlockDriverState
*bs
= NULL
;
3045 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3046 int c
, flags
, src_flags
, ret
;
3047 bool writethrough
, src_writethrough
;
3049 bool force_share
= false;
3052 Error
*local_err
= NULL
;
3053 bool image_opts
= false;
3055 /* Parse commandline parameters */
3057 cache
= BDRV_DEFAULT_CACHE
;
3058 src_cache
= BDRV_DEFAULT_CACHE
;
3062 static const struct option long_options
[] = {
3063 {"help", no_argument
, 0, 'h'},
3064 {"object", required_argument
, 0, OPTION_OBJECT
},
3065 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3066 {"force-share", no_argument
, 0, 'U'},
3069 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3070 long_options
, NULL
);
3076 missing_argument(argv
[optind
- 1]);
3079 unrecognized_option(argv
[optind
- 1]);
3088 out_basefmt
= optarg
;
3091 out_baseimg
= optarg
;
3108 case OPTION_OBJECT
: {
3110 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3116 case OPTION_IMAGE_OPTS
:
3129 if (optind
!= argc
- 1) {
3130 error_exit("Expecting one image file name");
3132 if (!unsafe
&& !out_baseimg
) {
3133 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3135 filename
= argv
[optind
++];
3137 if (qemu_opts_foreach(&qemu_object_opts
,
3138 user_creatable_add_opts_foreach
,
3143 qemu_progress_init(progress
, 2.0);
3144 qemu_progress_print(0, 100);
3146 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3147 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3149 error_report("Invalid cache option: %s", cache
);
3154 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3156 error_report("Invalid source cache option: %s", src_cache
);
3160 /* The source files are opened read-only, don't care about WCE */
3161 assert((src_flags
& BDRV_O_RDWR
) == 0);
3162 (void) src_writethrough
;
3167 * Ignore the old backing file for unsafe rebase in case we want to correct
3168 * the reference to a renamed or moved backing file.
3170 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3178 if (out_basefmt
!= NULL
) {
3179 if (bdrv_find_format(out_basefmt
) == NULL
) {
3180 error_report("Invalid format name: '%s'", out_basefmt
);
3186 /* For safe rebasing we need to compare old and new backing file */
3188 char backing_name
[PATH_MAX
];
3189 QDict
*options
= NULL
;
3191 if (bs
->backing_format
[0] != '\0') {
3192 options
= qdict_new();
3193 qdict_put_str(options
, "driver", bs
->backing_format
);
3198 options
= qdict_new();
3200 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3202 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3203 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3204 options
, src_flags
, &local_err
);
3205 if (!blk_old_backing
) {
3206 error_reportf_err(local_err
,
3207 "Could not open old backing file '%s': ",
3213 if (out_baseimg
[0]) {
3214 options
= qdict_new();
3216 qdict_put_str(options
, "driver", out_basefmt
);
3219 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3222 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
3223 options
, src_flags
, &local_err
);
3224 if (!blk_new_backing
) {
3225 error_reportf_err(local_err
,
3226 "Could not open new backing file '%s': ",
3235 * Check each unallocated cluster in the COW file. If it is unallocated,
3236 * accesses go to the backing file. We must therefore compare this cluster
3237 * in the old and new backing file, and if they differ we need to copy it
3238 * from the old backing file into the COW file.
3240 * If qemu-img crashes during this step, no harm is done. The content of
3241 * the image is the same as the original one at any time.
3244 int64_t num_sectors
;
3245 int64_t old_backing_num_sectors
;
3246 int64_t new_backing_num_sectors
= 0;
3250 float local_progress
= 0;
3252 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3253 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3255 num_sectors
= blk_nb_sectors(blk
);
3256 if (num_sectors
< 0) {
3257 error_report("Could not get size of '%s': %s",
3258 filename
, strerror(-num_sectors
));
3262 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3263 if (old_backing_num_sectors
< 0) {
3264 char backing_name
[PATH_MAX
];
3266 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3267 error_report("Could not get size of '%s': %s",
3268 backing_name
, strerror(-old_backing_num_sectors
));
3272 if (blk_new_backing
) {
3273 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3274 if (new_backing_num_sectors
< 0) {
3275 error_report("Could not get size of '%s': %s",
3276 out_baseimg
, strerror(-new_backing_num_sectors
));
3282 if (num_sectors
!= 0) {
3283 local_progress
= (float)100 /
3284 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3287 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3289 /* How many sectors can we handle with the next read? */
3290 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3291 n
= (IO_BUF_SIZE
/ 512);
3293 n
= num_sectors
- sector
;
3296 /* If the cluster is allocated, we don't need to take action */
3297 ret
= bdrv_is_allocated(bs
, sector
<< BDRV_SECTOR_BITS
,
3298 n
<< BDRV_SECTOR_BITS
, &count
);
3300 error_report("error while reading image metadata: %s",
3304 /* TODO relax this once bdrv_is_allocated does not enforce
3305 * sector alignment */
3306 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
3307 n
= count
>> BDRV_SECTOR_BITS
;
3313 * Read old and new backing file and take into consideration that
3314 * backing files may be smaller than the COW image.
3316 if (sector
>= old_backing_num_sectors
) {
3317 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3319 if (sector
+ n
> old_backing_num_sectors
) {
3320 n
= old_backing_num_sectors
- sector
;
3323 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3324 buf_old
, n
<< BDRV_SECTOR_BITS
);
3326 error_report("error while reading from old backing file");
3331 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3332 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3334 if (sector
+ n
> new_backing_num_sectors
) {
3335 n
= new_backing_num_sectors
- sector
;
3338 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3339 buf_new
, n
<< BDRV_SECTOR_BITS
);
3341 error_report("error while reading from new backing file");
3346 /* If they differ, we need to write to the COW file */
3347 uint64_t written
= 0;
3349 while (written
< n
) {
3352 if (compare_sectors(buf_old
+ written
* 512,
3353 buf_new
+ written
* 512, n
- written
, &pnum
))
3355 ret
= blk_pwrite(blk
,
3356 (sector
+ written
) << BDRV_SECTOR_BITS
,
3357 buf_old
+ written
* 512,
3358 pnum
<< BDRV_SECTOR_BITS
, 0);
3360 error_report("Error while writing to COW image: %s",
3368 qemu_progress_print(local_progress
, 100);
3373 * Change the backing file. All clusters that are different from the old
3374 * backing file are overwritten in the COW file now, so the visible content
3375 * doesn't change when we switch the backing file.
3377 if (out_baseimg
&& *out_baseimg
) {
3378 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3380 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3383 if (ret
== -ENOSPC
) {
3384 error_report("Could not change the backing file to '%s': No "
3385 "space left in the file header", out_baseimg
);
3386 } else if (ret
< 0) {
3387 error_report("Could not change the backing file to '%s': %s",
3388 out_baseimg
, strerror(-ret
));
3391 qemu_progress_print(100, 0);
3393 * TODO At this point it is possible to check if any clusters that are
3394 * allocated in the COW file are the same in the backing file. If so, they
3395 * could be dropped from the COW file. Don't do this before switching the
3396 * backing file, in case of a crash this would lead to corruption.
3399 qemu_progress_end();
3402 blk_unref(blk_old_backing
);
3403 blk_unref(blk_new_backing
);
3405 qemu_vfree(buf_old
);
3406 qemu_vfree(buf_new
);
3415 static int img_resize(int argc
, char **argv
)
3418 int c
, ret
, relative
;
3419 const char *filename
, *fmt
, *size
;
3420 int64_t n
, total_size
, current_size
;
3422 BlockBackend
*blk
= NULL
;
3423 PreallocMode prealloc
= PREALLOC_MODE_OFF
;
3426 static QemuOptsList resize_options
= {
3427 .name
= "resize_options",
3428 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3431 .name
= BLOCK_OPT_SIZE
,
3432 .type
= QEMU_OPT_SIZE
,
3433 .help
= "Virtual disk size"
3439 bool image_opts
= false;
3440 bool shrink
= false;
3442 /* Remove size from argv manually so that negative numbers are not treated
3443 * as options by getopt. */
3445 error_exit("Not enough arguments");
3449 size
= argv
[--argc
];
3451 /* Parse getopt arguments */
3454 static const struct option long_options
[] = {
3455 {"help", no_argument
, 0, 'h'},
3456 {"object", required_argument
, 0, OPTION_OBJECT
},
3457 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3458 {"preallocation", required_argument
, 0, OPTION_PREALLOCATION
},
3459 {"shrink", no_argument
, 0, OPTION_SHRINK
},
3462 c
= getopt_long(argc
, argv
, ":f:hq",
3463 long_options
, NULL
);
3469 missing_argument(argv
[optind
- 1]);
3472 unrecognized_option(argv
[optind
- 1]);
3483 case OPTION_OBJECT
: {
3485 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3491 case OPTION_IMAGE_OPTS
:
3494 case OPTION_PREALLOCATION
:
3495 prealloc
= qapi_enum_parse(&PreallocMode_lookup
, optarg
,
3496 PREALLOC_MODE__MAX
, NULL
);
3497 if (prealloc
== PREALLOC_MODE__MAX
) {
3498 error_report("Invalid preallocation mode '%s'", optarg
);
3507 if (optind
!= argc
- 1) {
3508 error_exit("Expecting one image file name");
3510 filename
= argv
[optind
++];
3512 if (qemu_opts_foreach(&qemu_object_opts
,
3513 user_creatable_add_opts_foreach
,
3518 /* Choose grow, shrink, or absolute resize mode */
3534 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3535 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3537 error_report_err(err
);
3539 qemu_opts_del(param
);
3542 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3543 qemu_opts_del(param
);
3545 blk
= img_open(image_opts
, filename
, fmt
,
3546 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
3553 current_size
= blk_getlength(blk
);
3554 if (current_size
< 0) {
3555 error_report("Failed to inquire current image length: %s",
3556 strerror(-current_size
));
3562 total_size
= current_size
+ n
* relative
;
3566 if (total_size
<= 0) {
3567 error_report("New image size must be positive");
3572 if (total_size
<= current_size
&& prealloc
!= PREALLOC_MODE_OFF
) {
3573 error_report("Preallocation can only be used for growing images");
3578 if (total_size
< current_size
&& !shrink
) {
3579 warn_report("Shrinking an image will delete all data beyond the "
3580 "shrunken image's end. Before performing such an "
3581 "operation, make sure there is no important data there.");
3583 if (g_strcmp0(bdrv_get_format_name(blk_bs(blk
)), "raw") != 0) {
3585 "Use the --shrink option to perform a shrink operation.");
3589 warn_report("Using the --shrink option will suppress this message. "
3590 "Note that future versions of qemu-img may refuse to "
3591 "shrink images without this option.");
3595 ret
= blk_truncate(blk
, total_size
, prealloc
, &err
);
3597 qprintf(quiet
, "Image resized.\n");
3599 error_report_err(err
);
3609 static void amend_status_cb(BlockDriverState
*bs
,
3610 int64_t offset
, int64_t total_work_size
,
3613 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3616 static int img_amend(int argc
, char **argv
)
3620 char *options
= NULL
;
3621 QemuOptsList
*create_opts
= NULL
;
3622 QemuOpts
*opts
= NULL
;
3623 const char *fmt
= NULL
, *filename
, *cache
;
3626 bool quiet
= false, progress
= false;
3627 BlockBackend
*blk
= NULL
;
3628 BlockDriverState
*bs
= NULL
;
3629 bool image_opts
= false;
3631 cache
= BDRV_DEFAULT_CACHE
;
3633 static const struct option long_options
[] = {
3634 {"help", no_argument
, 0, 'h'},
3635 {"object", required_argument
, 0, OPTION_OBJECT
},
3636 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3639 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
3640 long_options
, NULL
);
3647 missing_argument(argv
[optind
- 1]);
3650 unrecognized_option(argv
[optind
- 1]);
3656 if (!is_valid_option_list(optarg
)) {
3657 error_report("Invalid option list: %s", optarg
);
3659 goto out_no_progress
;
3662 options
= g_strdup(optarg
);
3664 char *old_options
= options
;
3665 options
= g_strdup_printf("%s,%s", options
, optarg
);
3666 g_free(old_options
);
3682 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3686 goto out_no_progress
;
3689 case OPTION_IMAGE_OPTS
:
3696 error_exit("Must specify options (-o)");
3699 if (qemu_opts_foreach(&qemu_object_opts
,
3700 user_creatable_add_opts_foreach
,
3703 goto out_no_progress
;
3709 qemu_progress_init(progress
, 1.0);
3711 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3712 if (fmt
&& has_help_option(options
)) {
3713 /* If a format is explicitly specified (and possibly no filename is
3714 * given), print option help here */
3715 ret
= print_block_option_help(filename
, fmt
);
3719 if (optind
!= argc
- 1) {
3720 error_report("Expecting one image file name");
3725 flags
= BDRV_O_RDWR
;
3726 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3728 error_report("Invalid cache option: %s", cache
);
3732 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3740 fmt
= bs
->drv
->format_name
;
3742 if (has_help_option(options
)) {
3743 /* If the format was auto-detected, print option help here */
3744 ret
= print_block_option_help(filename
, fmt
);
3748 if (!bs
->drv
->create_opts
) {
3749 error_report("Format driver '%s' does not support any options to amend",
3755 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3756 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3757 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3759 error_report_err(err
);
3764 /* In case the driver does not call amend_status_cb() */
3765 qemu_progress_print(0.f
, 0);
3766 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3767 qemu_progress_print(100.f
, 0);
3769 error_report("Error while amending options: %s", strerror(-ret
));
3774 qemu_progress_end();
3778 qemu_opts_del(opts
);
3779 qemu_opts_free(create_opts
);
3788 typedef struct BenchData
{
3790 uint64_t image_size
;
3797 bool drain_on_flush
;
3806 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3809 error_report("Failed flush request: %s", strerror(-ret
));
3814 static void bench_cb(void *opaque
, int ret
)
3816 BenchData
*b
= opaque
;
3820 error_report("Failed request: %s", strerror(-ret
));
3825 /* Just finished a flush with drained queue: Start next requests */
3826 assert(b
->in_flight
== 0);
3827 b
->in_flush
= false;
3828 } else if (b
->in_flight
> 0) {
3829 int remaining
= b
->n
- b
->in_flight
;
3834 /* Time for flush? Drain queue if requested, then flush */
3835 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3836 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3837 BlockCompletionFunc
*cb
;
3839 if (b
->drain_on_flush
) {
3843 cb
= bench_undrained_flush_cb
;
3846 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3848 error_report("Failed to issue flush request");
3852 if (b
->drain_on_flush
) {
3858 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3859 int64_t offset
= b
->offset
;
3860 /* blk_aio_* might look for completed I/Os and kick bench_cb
3861 * again, so make sure this operation is counted by in_flight
3862 * and b->offset is ready for the next submission.
3865 b
->offset
+= b
->step
;
3866 b
->offset
%= b
->image_size
;
3868 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3870 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3873 error_report("Failed to issue request");
3879 static int img_bench(int argc
, char **argv
)
3882 const char *fmt
= NULL
, *filename
;
3884 bool image_opts
= false;
3885 bool is_write
= false;
3889 size_t bufsize
= 4096;
3892 int flush_interval
= 0;
3893 bool drain_on_flush
= true;
3895 BlockBackend
*blk
= NULL
;
3896 BenchData data
= {};
3898 bool writethrough
= false;
3899 struct timeval t1
, t2
;
3901 bool force_share
= false;
3904 static const struct option long_options
[] = {
3905 {"help", no_argument
, 0, 'h'},
3906 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3907 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3908 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3909 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3910 {"force-share", no_argument
, 0, 'U'},
3913 c
= getopt_long(argc
, argv
, ":hc:d:f:no:qs:S:t:wU", long_options
, NULL
);
3920 missing_argument(argv
[optind
- 1]);
3923 unrecognized_option(argv
[optind
- 1]);
3932 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3933 error_report("Invalid request count specified");
3943 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3944 error_report("Invalid queue depth specified");
3954 flags
|= BDRV_O_NATIVE_AIO
;
3958 offset
= cvtnum(optarg
);
3960 error_report("Invalid offset specified");
3973 sval
= cvtnum(optarg
);
3974 if (sval
< 0 || sval
> INT_MAX
) {
3975 error_report("Invalid buffer size specified");
3986 sval
= cvtnum(optarg
);
3987 if (sval
< 0 || sval
> INT_MAX
) {
3988 error_report("Invalid step size specified");
3996 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3998 error_report("Invalid cache mode");
4004 flags
|= BDRV_O_RDWR
;
4010 case OPTION_PATTERN
:
4014 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
4015 error_report("Invalid pattern byte specified");
4021 case OPTION_FLUSH_INTERVAL
:
4025 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4026 error_report("Invalid flush interval specified");
4029 flush_interval
= res
;
4032 case OPTION_NO_DRAIN
:
4033 drain_on_flush
= false;
4035 case OPTION_IMAGE_OPTS
:
4041 if (optind
!= argc
- 1) {
4042 error_exit("Expecting one image file name");
4044 filename
= argv
[argc
- 1];
4046 if (!is_write
&& flush_interval
) {
4047 error_report("--flush-interval is only available in write tests");
4051 if (flush_interval
&& flush_interval
< depth
) {
4052 error_report("Flush interval can't be smaller than depth");
4057 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4064 image_size
= blk_getlength(blk
);
4065 if (image_size
< 0) {
4070 data
= (BenchData
) {
4072 .image_size
= image_size
,
4074 .step
= step
?: bufsize
,
4079 .flush_interval
= flush_interval
,
4080 .drain_on_flush
= drain_on_flush
,
4082 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4083 "(starting at offset %" PRId64
", step size %d)\n",
4084 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4085 data
.offset
, data
.step
);
4086 if (flush_interval
) {
4087 printf("Sending flush every %d requests\n", flush_interval
);
4090 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
4091 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4093 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4094 for (i
= 0; i
< data
.nrreq
; i
++) {
4095 qemu_iovec_init(&data
.qiov
[i
], 1);
4096 qemu_iovec_add(&data
.qiov
[i
],
4097 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4100 gettimeofday(&t1
, NULL
);
4103 while (data
.n
> 0) {
4104 main_loop_wait(false);
4106 gettimeofday(&t2
, NULL
);
4108 printf("Run completed in %3.3f seconds.\n",
4109 (t2
.tv_sec
- t1
.tv_sec
)
4110 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4113 qemu_vfree(data
.buf
);
4134 int bsz
; /* Block size */
4142 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4146 static int img_dd_bs(const char *arg
,
4147 struct DdIo
*in
, struct DdIo
*out
,
4154 if (res
<= 0 || res
> INT_MAX
) {
4155 error_report("invalid number: '%s'", arg
);
4158 in
->bsz
= out
->bsz
= res
;
4163 static int img_dd_count(const char *arg
,
4164 struct DdIo
*in
, struct DdIo
*out
,
4167 dd
->count
= cvtnum(arg
);
4169 if (dd
->count
< 0) {
4170 error_report("invalid number: '%s'", arg
);
4177 static int img_dd_if(const char *arg
,
4178 struct DdIo
*in
, struct DdIo
*out
,
4181 in
->filename
= g_strdup(arg
);
4186 static int img_dd_of(const char *arg
,
4187 struct DdIo
*in
, struct DdIo
*out
,
4190 out
->filename
= g_strdup(arg
);
4195 static int img_dd_skip(const char *arg
,
4196 struct DdIo
*in
, struct DdIo
*out
,
4199 in
->offset
= cvtnum(arg
);
4201 if (in
->offset
< 0) {
4202 error_report("invalid number: '%s'", arg
);
4209 static int img_dd(int argc
, char **argv
)
4214 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4215 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4216 QemuOpts
*opts
= NULL
;
4217 QemuOptsList
*create_opts
= NULL
;
4218 Error
*local_err
= NULL
;
4219 bool image_opts
= false;
4221 const char *out_fmt
= "raw";
4222 const char *fmt
= NULL
;
4224 int64_t block_count
= 0, out_pos
, in_pos
;
4225 bool force_share
= false;
4226 struct DdInfo dd
= {
4231 .bsz
= 512, /* Block size is by default 512 bytes */
4243 const struct DdOpts options
[] = {
4244 { "bs", img_dd_bs
, C_BS
},
4245 { "count", img_dd_count
, C_COUNT
},
4246 { "if", img_dd_if
, C_IF
},
4247 { "of", img_dd_of
, C_OF
},
4248 { "skip", img_dd_skip
, C_SKIP
},
4251 const struct option long_options
[] = {
4252 { "help", no_argument
, 0, 'h'},
4253 { "object", required_argument
, 0, OPTION_OBJECT
},
4254 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4255 { "force-share", no_argument
, 0, 'U'},
4259 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
4271 missing_argument(argv
[optind
- 1]);
4274 unrecognized_option(argv
[optind
- 1]);
4283 if (!qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true)) {
4288 case OPTION_IMAGE_OPTS
:
4294 for (i
= optind
; i
< argc
; i
++) {
4296 arg
= g_strdup(argv
[i
]);
4298 tmp
= strchr(arg
, '=');
4300 error_report("unrecognized operand %s", arg
);
4307 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4308 if (!strcmp(arg
, options
[j
].name
)) {
4312 if (options
[j
].name
== NULL
) {
4313 error_report("unrecognized operand %s", arg
);
4318 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4322 dd
.flags
|= options
[j
].flag
;
4327 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4328 error_report("Must specify both input and output files");
4333 if (qemu_opts_foreach(&qemu_object_opts
,
4334 user_creatable_add_opts_foreach
,
4340 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
4348 drv
= bdrv_find_format(out_fmt
);
4350 error_report("Unknown file format");
4354 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4357 error_report_err(local_err
);
4361 if (!drv
->create_opts
) {
4362 error_report("Format driver '%s' does not support image creation",
4367 if (!proto_drv
->create_opts
) {
4368 error_report("Protocol driver '%s' does not support image creation",
4369 proto_drv
->format_name
);
4373 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4374 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4376 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4378 size
= blk_getlength(blk1
);
4380 error_report("Failed to get size for '%s'", in
.filename
);
4385 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4386 dd
.count
* in
.bsz
< size
) {
4387 size
= dd
.count
* in
.bsz
;
4390 /* Overflow means the specified offset is beyond input image's size */
4391 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4392 size
< in
.bsz
* in
.offset
)) {
4393 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4395 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4396 size
- in
.bsz
* in
.offset
, &error_abort
);
4399 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4401 error_reportf_err(local_err
,
4402 "%s: error while creating output image: ",
4408 /* TODO, we can't honour --image-opts for the target,
4409 * since it needs to be given in a format compatible
4410 * with the bdrv_create() call above which does not
4411 * support image-opts style.
4413 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
4414 false, false, false);
4421 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4422 size
< in
.offset
* in
.bsz
)) {
4423 /* We give a warning if the skip option is bigger than the input
4424 * size and create an empty output disk image (i.e. like dd(1)).
4426 error_report("%s: cannot skip to specified offset", in
.filename
);
4429 in_pos
= in
.offset
* in
.bsz
;
4432 in
.buf
= g_new(uint8_t, in
.bsz
);
4434 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4435 int in_ret
, out_ret
;
4437 if (in_pos
+ in
.bsz
> size
) {
4438 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4440 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4443 error_report("error while reading from input image file: %s",
4450 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4453 error_report("error while writing to output image file: %s",
4454 strerror(-out_ret
));
4463 qemu_opts_del(opts
);
4464 qemu_opts_free(create_opts
);
4467 g_free(in
.filename
);
4468 g_free(out
.filename
);
4478 static void dump_json_block_measure_info(BlockMeasureInfo
*info
)
4482 Visitor
*v
= qobject_output_visitor_new(&obj
);
4484 visit_type_BlockMeasureInfo(v
, NULL
, &info
, &error_abort
);
4485 visit_complete(v
, &obj
);
4486 str
= qobject_to_json_pretty(obj
);
4487 assert(str
!= NULL
);
4488 printf("%s\n", qstring_get_str(str
));
4489 qobject_decref(obj
);
4494 static int img_measure(int argc
, char **argv
)
4496 static const struct option long_options
[] = {
4497 {"help", no_argument
, 0, 'h'},
4498 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4499 {"object", required_argument
, 0, OPTION_OBJECT
},
4500 {"output", required_argument
, 0, OPTION_OUTPUT
},
4501 {"size", required_argument
, 0, OPTION_SIZE
},
4502 {"force-share", no_argument
, 0, 'U'},
4505 OutputFormat output_format
= OFORMAT_HUMAN
;
4506 BlockBackend
*in_blk
= NULL
;
4508 const char *filename
= NULL
;
4509 const char *fmt
= NULL
;
4510 const char *out_fmt
= "raw";
4511 char *options
= NULL
;
4512 char *snapshot_name
= NULL
;
4513 bool force_share
= false;
4514 QemuOpts
*opts
= NULL
;
4515 QemuOpts
*object_opts
= NULL
;
4516 QemuOpts
*sn_opts
= NULL
;
4517 QemuOptsList
*create_opts
= NULL
;
4518 bool image_opts
= false;
4519 uint64_t img_size
= UINT64_MAX
;
4520 BlockMeasureInfo
*info
= NULL
;
4521 Error
*local_err
= NULL
;
4525 while ((c
= getopt_long(argc
, argv
, "hf:O:o:l:U",
4526 long_options
, NULL
)) != -1) {
4539 if (!is_valid_option_list(optarg
)) {
4540 error_report("Invalid option list: %s", optarg
);
4544 options
= g_strdup(optarg
);
4546 char *old_options
= options
;
4547 options
= g_strdup_printf("%s,%s", options
, optarg
);
4548 g_free(old_options
);
4552 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
4553 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
4556 error_report("Failed in parsing snapshot param '%s'",
4561 snapshot_name
= optarg
;
4568 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
4574 case OPTION_IMAGE_OPTS
:
4578 if (!strcmp(optarg
, "json")) {
4579 output_format
= OFORMAT_JSON
;
4580 } else if (!strcmp(optarg
, "human")) {
4581 output_format
= OFORMAT_HUMAN
;
4583 error_report("--output must be used with human or json "
4592 sval
= cvtnum(optarg
);
4594 if (sval
== -ERANGE
) {
4595 error_report("Image size must be less than 8 EiB!");
4597 error_report("Invalid image size specified! You may use "
4598 "k, M, G, T, P or E suffixes for ");
4599 error_report("kilobytes, megabytes, gigabytes, terabytes, "
4600 "petabytes and exabytes.");
4604 img_size
= (uint64_t)sval
;
4610 if (qemu_opts_foreach(&qemu_object_opts
,
4611 user_creatable_add_opts_foreach
,
4616 if (argc
- optind
> 1) {
4617 error_report("At most one filename argument is allowed.");
4619 } else if (argc
- optind
== 1) {
4620 filename
= argv
[optind
];
4624 (object_opts
|| image_opts
|| fmt
|| snapshot_name
|| sn_opts
)) {
4625 error_report("--object, --image-opts, -f, and -l "
4626 "require a filename argument.");
4629 if (filename
&& img_size
!= UINT64_MAX
) {
4630 error_report("--size N cannot be used together with a filename.");
4633 if (!filename
&& img_size
== UINT64_MAX
) {
4634 error_report("Either --size N or one filename must be specified.");
4639 in_blk
= img_open(image_opts
, filename
, fmt
, 0,
4640 false, false, force_share
);
4646 bdrv_snapshot_load_tmp(blk_bs(in_blk
),
4647 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
4648 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
4650 } else if (snapshot_name
!= NULL
) {
4651 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk
),
4652 snapshot_name
, &local_err
);
4655 error_reportf_err(local_err
, "Failed to load snapshot: ");
4660 drv
= bdrv_find_format(out_fmt
);
4662 error_report("Unknown file format '%s'", out_fmt
);
4665 if (!drv
->create_opts
) {
4666 error_report("Format driver '%s' does not support image creation",
4671 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4672 create_opts
= qemu_opts_append(create_opts
, bdrv_file
.create_opts
);
4673 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4675 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
4677 error_report_err(local_err
);
4678 error_report("Invalid options for file format '%s'", out_fmt
);
4682 if (img_size
!= UINT64_MAX
) {
4683 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, img_size
, &error_abort
);
4686 info
= bdrv_measure(drv
, opts
, in_blk
? blk_bs(in_blk
) : NULL
, &local_err
);
4688 error_report_err(local_err
);
4692 if (output_format
== OFORMAT_HUMAN
) {
4693 printf("required size: %" PRIu64
"\n", info
->required
);
4694 printf("fully allocated size: %" PRIu64
"\n", info
->fully_allocated
);
4696 dump_json_block_measure_info(info
);
4702 qapi_free_BlockMeasureInfo(info
);
4703 qemu_opts_del(object_opts
);
4704 qemu_opts_del(opts
);
4705 qemu_opts_del(sn_opts
);
4706 qemu_opts_free(create_opts
);
4712 static const img_cmd_t img_cmds
[] = {
4713 #define DEF(option, callback, arg_string) \
4714 { option, callback },
4715 #include "qemu-img-cmds.h"
4721 int main(int argc
, char **argv
)
4723 const img_cmd_t
*cmd
;
4724 const char *cmdname
;
4725 Error
*local_error
= NULL
;
4726 char *trace_file
= NULL
;
4728 static const struct option long_options
[] = {
4729 {"help", no_argument
, 0, 'h'},
4730 {"version", no_argument
, 0, 'V'},
4731 {"trace", required_argument
, NULL
, 'T'},
4736 signal(SIGPIPE
, SIG_IGN
);
4739 module_call_init(MODULE_INIT_TRACE
);
4740 error_set_progname(argv
[0]);
4741 qemu_init_exec_dir(argv
[0]);
4743 if (qemu_init_main_loop(&local_error
)) {
4744 error_report_err(local_error
);
4748 qcrypto_init(&error_fatal
);
4750 module_call_init(MODULE_INIT_QOM
);
4753 error_exit("Not enough arguments");
4756 qemu_add_opts(&qemu_object_opts
);
4757 qemu_add_opts(&qemu_source_opts
);
4758 qemu_add_opts(&qemu_trace_opts
);
4760 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
4763 missing_argument(argv
[optind
- 1]);
4766 unrecognized_option(argv
[optind
- 1]);
4772 printf(QEMU_IMG_VERSION
);
4776 trace_file
= trace_opt_parse(optarg
);
4781 cmdname
= argv
[optind
];
4783 /* reset getopt_long scanning */
4791 if (!trace_init_backends()) {
4794 trace_init_file(trace_file
);
4795 qemu_set_log(LOG_TRACE
);
4797 /* find the command */
4798 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4799 if (!strcmp(cmdname
, cmd
->name
)) {
4800 return cmd
->handler(argc
, argv
);
4805 error_exit("Command not found: %s", cmdname
);