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"
25 #include "qemu-version.h"
26 #include "qapi/error.h"
27 #include "qapi-visit.h"
28 #include "qapi/qobject-output-visitor.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qapi/qmp/qjson.h"
31 #include "qapi/qmp/qbool.h"
32 #include "qemu/cutils.h"
33 #include "qemu/config-file.h"
34 #include "qemu/option.h"
35 #include "qemu/error-report.h"
37 #include "qom/object_interfaces.h"
38 #include "sysemu/sysemu.h"
39 #include "sysemu/block-backend.h"
40 #include "block/block_int.h"
41 #include "block/blockjob.h"
42 #include "block/qapi.h"
43 #include "crypto/init.h"
44 #include "trace/control.h"
47 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
48 "\n" QEMU_COPYRIGHT "\n"
50 typedef struct img_cmd_t
{
52 int (*handler
)(int argc
, char **argv
);
57 OPTION_BACKING_CHAIN
= 257,
59 OPTION_IMAGE_OPTS
= 259,
61 OPTION_FLUSH_INTERVAL
= 261,
62 OPTION_NO_DRAIN
= 262,
63 OPTION_TARGET_IMAGE_OPTS
= 263,
66 typedef enum OutputFormat
{
71 /* Default to cache=writeback as data integrity is not important for qemu-img */
72 #define BDRV_DEFAULT_CACHE "writeback"
74 static void format_print(void *opaque
, const char *name
)
79 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
83 error_printf("qemu-img: ");
86 error_vprintf(fmt
, ap
);
89 error_printf("\nTry 'qemu-img --help' for more information\n");
93 static void QEMU_NORETURN
missing_argument(const char *option
)
95 error_exit("missing argument for option '%s'", option
);
98 static void QEMU_NORETURN
unrecognized_option(const char *option
)
100 error_exit("unrecognized option '%s'", option
);
103 /* Please keep in synch with qemu-img.texi */
104 static void QEMU_NORETURN
help(void)
106 const char *help_msg
=
108 "usage: qemu-img [standard options] command [command options]\n"
109 "QEMU disk image utility\n"
111 " '-h', '--help' display this help and exit\n"
112 " '-V', '--version' output version information and exit\n"
113 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
114 " specify tracing options\n"
117 #define DEF(option, callback, arg_string) \
119 #include "qemu-img-cmds.h"
123 "Command parameters:\n"
124 " 'filename' is a disk image filename\n"
125 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
126 " manual page for a description of the object properties. The most common\n"
127 " object type is a 'secret', which is used to supply passwords and/or\n"
128 " encryption keys.\n"
129 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
130 " 'cache' is the cache mode used to write the output disk image, the valid\n"
131 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
132 " 'directsync' and 'unsafe' (default for convert)\n"
133 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
134 " options are the same as for the 'cache' option\n"
135 " 'size' is the disk image size in bytes. Optional suffixes\n"
136 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
137 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
138 " supported. 'b' is ignored.\n"
139 " 'output_filename' is the destination disk image filename\n"
140 " 'output_fmt' is the destination format\n"
141 " 'options' is a comma separated list of format specific options in a\n"
142 " name=value format. Use -o ? for an overview of the options supported by the\n"
144 " 'snapshot_param' is param used for internal snapshot, format\n"
145 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
147 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
149 " '-c' indicates that target image must be compressed (qcow format only)\n"
150 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
151 " match exactly. The image doesn't need a working backing file before\n"
152 " rebasing in this case (useful for renaming the backing file)\n"
153 " '-h' with or without a command shows this help and lists the supported formats\n"
154 " '-p' show progress of command (only certain commands)\n"
155 " '-q' use Quiet mode - do not print any output (except errors)\n"
156 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
157 " contain only zeros for qemu-img to create a sparse image during\n"
158 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
159 " unallocated or zero sectors, and the destination image will always be\n"
161 " '--output' takes the format in which the output must be done (human or json)\n"
162 " '-n' skips the target volume creation (useful if the volume is created\n"
163 " prior to running qemu-img)\n"
165 "Parameters to check subcommand:\n"
166 " '-r' tries to repair any inconsistencies that are found during the check.\n"
167 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
168 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
169 " hiding corruption that has already occurred.\n"
171 "Parameters to convert subcommand:\n"
172 " '-m' specifies how many coroutines work in parallel during the convert\n"
173 " process (defaults to 8)\n"
174 " '-W' allow to write to the target out of order rather than sequential\n"
176 "Parameters to snapshot subcommand:\n"
177 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
178 " '-a' applies a snapshot (revert disk to saved state)\n"
179 " '-c' creates a snapshot\n"
180 " '-d' deletes a snapshot\n"
181 " '-l' lists all snapshots in the given image\n"
183 "Parameters to compare subcommand:\n"
184 " '-f' first image format\n"
185 " '-F' second image format\n"
186 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
188 "Parameters to dd subcommand:\n"
189 " 'bs=BYTES' read and write up to BYTES bytes at a time "
191 " 'count=N' copy only N input blocks\n"
192 " 'if=FILE' read from FILE\n"
193 " 'of=FILE' write to FILE\n"
194 " 'skip=N' skip N bs-sized blocks at the start of input\n";
196 printf("%s\nSupported formats:", help_msg
);
197 bdrv_iterate_format(format_print
, NULL
);
202 static QemuOptsList qemu_object_opts
= {
204 .implied_opt_name
= "qom-type",
205 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
211 static QemuOptsList qemu_source_opts
= {
213 .implied_opt_name
= "file",
214 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
220 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
226 ret
= vprintf(fmt
, args
);
233 static int print_block_option_help(const char *filename
, const char *fmt
)
235 BlockDriver
*drv
, *proto_drv
;
236 QemuOptsList
*create_opts
= NULL
;
237 Error
*local_err
= NULL
;
239 /* Find driver and parse its options */
240 drv
= bdrv_find_format(fmt
);
242 error_report("Unknown file format '%s'", fmt
);
246 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
248 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
250 error_report_err(local_err
);
251 qemu_opts_free(create_opts
);
254 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
257 qemu_opts_print_help(create_opts
);
258 qemu_opts_free(create_opts
);
263 static int img_open_password(BlockBackend
*blk
, const char *filename
,
264 int flags
, bool quiet
)
266 BlockDriverState
*bs
;
270 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
271 !(flags
& BDRV_O_NO_IO
)) {
272 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
273 if (qemu_read_password(password
, sizeof(password
)) < 0) {
274 error_report("No password given");
277 if (bdrv_set_key(bs
, password
) < 0) {
278 error_report("invalid password");
286 static BlockBackend
*img_open_opts(const char *optstr
,
287 QemuOpts
*opts
, int flags
, bool writethrough
,
288 bool quiet
, bool force_share
)
291 Error
*local_err
= NULL
;
293 options
= qemu_opts_to_qdict(opts
, NULL
);
295 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
296 && !qdict_get_bool(options
, BDRV_OPT_FORCE_SHARE
)) {
297 error_report("--force-share/-U conflicts with image options");
301 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
303 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
305 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
308 blk_set_enable_write_cache(blk
, !writethrough
);
310 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
317 static BlockBackend
*img_open_file(const char *filename
,
319 const char *fmt
, int flags
,
320 bool writethrough
, bool quiet
,
324 Error
*local_err
= NULL
;
327 options
= qdict_new();
330 qdict_put_str(options
, "driver", fmt
);
334 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
336 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
338 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
341 blk_set_enable_write_cache(blk
, !writethrough
);
343 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
351 static int img_add_key_secrets(void *opaque
,
352 const char *name
, const char *value
,
355 QDict
*options
= opaque
;
357 if (g_str_has_suffix(name
, "key-secret")) {
358 qdict_put(options
, name
, qstring_from_str(value
));
364 static BlockBackend
*img_open_new_file(const char *filename
,
365 QemuOpts
*create_opts
,
366 const char *fmt
, int flags
,
367 bool writethrough
, bool quiet
,
370 QDict
*options
= NULL
;
372 options
= qdict_new();
373 qemu_opt_foreach(create_opts
, img_add_key_secrets
, options
, &error_abort
);
375 return img_open_file(filename
, options
, fmt
, flags
, writethrough
, quiet
,
380 static BlockBackend
*img_open(bool image_opts
,
381 const char *filename
,
382 const char *fmt
, int flags
, bool writethrough
,
383 bool quiet
, bool force_share
)
389 error_report("--image-opts and --format are mutually exclusive");
392 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
397 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
400 blk
= img_open_file(filename
, NULL
, fmt
, flags
, writethrough
, quiet
,
407 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
408 const char *base_filename
,
409 const char *base_fmt
)
414 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
416 error_report("Backing file not supported for file format '%s'",
423 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
425 error_report("Backing file format not supported for file "
434 static int64_t cvtnum(const char *s
)
439 err
= qemu_strtosz(s
, NULL
, &value
);
443 if (value
> INT64_MAX
) {
449 static int img_create(int argc
, char **argv
)
452 uint64_t img_size
= -1;
453 const char *fmt
= "raw";
454 const char *base_fmt
= NULL
;
455 const char *filename
;
456 const char *base_filename
= NULL
;
457 char *options
= NULL
;
458 Error
*local_err
= NULL
;
462 static const struct option long_options
[] = {
463 {"help", no_argument
, 0, 'h'},
464 {"object", required_argument
, 0, OPTION_OBJECT
},
467 c
= getopt_long(argc
, argv
, ":F:b:f:ho:q",
474 missing_argument(argv
[optind
- 1]);
477 unrecognized_option(argv
[optind
- 1]);
486 base_filename
= optarg
;
492 if (!is_valid_option_list(optarg
)) {
493 error_report("Invalid option list: %s", optarg
);
497 options
= g_strdup(optarg
);
499 char *old_options
= options
;
500 options
= g_strdup_printf("%s,%s", options
, optarg
);
507 case OPTION_OBJECT
: {
509 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
518 /* Get the filename */
519 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
520 if (options
&& has_help_option(options
)) {
522 return print_block_option_help(filename
, fmt
);
525 if (optind
>= argc
) {
526 error_exit("Expecting image file name");
530 if (qemu_opts_foreach(&qemu_object_opts
,
531 user_creatable_add_opts_foreach
,
536 /* Get image size, if specified */
540 sval
= cvtnum(argv
[optind
++]);
542 if (sval
== -ERANGE
) {
543 error_report("Image size must be less than 8 EiB!");
545 error_report("Invalid image size specified! You may use k, M, "
546 "G, T, P or E suffixes for ");
547 error_report("kilobytes, megabytes, gigabytes, terabytes, "
548 "petabytes and exabytes.");
552 img_size
= (uint64_t)sval
;
554 if (optind
!= argc
) {
555 error_exit("Unexpected argument: %s", argv
[optind
]);
558 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
559 options
, img_size
, 0, quiet
, &local_err
);
561 error_reportf_err(local_err
, "%s: ", filename
);
573 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
577 Visitor
*v
= qobject_output_visitor_new(&obj
);
579 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
580 visit_complete(v
, &obj
);
581 str
= qobject_to_json_pretty(obj
);
583 qprintf(quiet
, "%s\n", qstring_get_str(str
));
589 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
591 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
592 qprintf(quiet
, "No errors were found on the image.\n");
594 if (check
->corruptions
) {
595 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
596 "Data may be corrupted, or further writes to the image "
603 "\n%" PRId64
" leaked clusters were found on the image.\n"
604 "This means waste of disk space, but no harm to data.\n",
608 if (check
->check_errors
) {
611 " internal errors have occurred during the check.\n",
612 check
->check_errors
);
616 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
617 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
618 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
619 check
->allocated_clusters
, check
->total_clusters
,
620 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
621 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
622 check
->compressed_clusters
* 100.0 /
623 check
->allocated_clusters
);
626 if (check
->image_end_offset
) {
628 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
632 static int collect_image_check(BlockDriverState
*bs
,
634 const char *filename
,
639 BdrvCheckResult result
;
641 ret
= bdrv_check(bs
, &result
, fix
);
646 check
->filename
= g_strdup(filename
);
647 check
->format
= g_strdup(bdrv_get_format_name(bs
));
648 check
->check_errors
= result
.check_errors
;
649 check
->corruptions
= result
.corruptions
;
650 check
->has_corruptions
= result
.corruptions
!= 0;
651 check
->leaks
= result
.leaks
;
652 check
->has_leaks
= result
.leaks
!= 0;
653 check
->corruptions_fixed
= result
.corruptions_fixed
;
654 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
655 check
->leaks_fixed
= result
.leaks_fixed
;
656 check
->has_leaks_fixed
= result
.leaks
!= 0;
657 check
->image_end_offset
= result
.image_end_offset
;
658 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
659 check
->total_clusters
= result
.bfi
.total_clusters
;
660 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
661 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
662 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
663 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
664 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
665 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
666 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
672 * Checks an image for consistency. Exit codes:
674 * 0 - Check completed, image is good
675 * 1 - Check not completed because of internal errors
676 * 2 - Check completed, image is corrupted
677 * 3 - Check completed, image has leaked clusters, but is good otherwise
678 * 63 - Checks are not supported by the image format
680 static int img_check(int argc
, char **argv
)
683 OutputFormat output_format
= OFORMAT_HUMAN
;
684 const char *filename
, *fmt
, *output
, *cache
;
686 BlockDriverState
*bs
;
688 int flags
= BDRV_O_CHECK
;
692 bool image_opts
= false;
693 bool force_share
= false;
697 cache
= BDRV_DEFAULT_CACHE
;
700 int option_index
= 0;
701 static const struct option long_options
[] = {
702 {"help", no_argument
, 0, 'h'},
703 {"format", required_argument
, 0, 'f'},
704 {"repair", required_argument
, 0, 'r'},
705 {"output", required_argument
, 0, OPTION_OUTPUT
},
706 {"object", required_argument
, 0, OPTION_OBJECT
},
707 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
708 {"force-share", no_argument
, 0, 'U'},
711 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
712 long_options
, &option_index
);
718 missing_argument(argv
[optind
- 1]);
721 unrecognized_option(argv
[optind
- 1]);
730 flags
|= BDRV_O_RDWR
;
732 if (!strcmp(optarg
, "leaks")) {
733 fix
= BDRV_FIX_LEAKS
;
734 } else if (!strcmp(optarg
, "all")) {
735 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
737 error_exit("Unknown option value for -r "
738 "(expecting 'leaks' or 'all'): %s", optarg
);
753 case OPTION_OBJECT
: {
755 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
761 case OPTION_IMAGE_OPTS
:
766 if (optind
!= argc
- 1) {
767 error_exit("Expecting one image file name");
769 filename
= argv
[optind
++];
771 if (output
&& !strcmp(output
, "json")) {
772 output_format
= OFORMAT_JSON
;
773 } else if (output
&& !strcmp(output
, "human")) {
774 output_format
= OFORMAT_HUMAN
;
776 error_report("--output must be used with human or json as argument.");
780 if (qemu_opts_foreach(&qemu_object_opts
,
781 user_creatable_add_opts_foreach
,
786 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
788 error_report("Invalid source cache option: %s", cache
);
792 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
799 check
= g_new0(ImageCheck
, 1);
800 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
802 if (ret
== -ENOTSUP
) {
803 error_report("This image format does not support checks");
808 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
809 int corruptions_fixed
, leaks_fixed
;
811 leaks_fixed
= check
->leaks_fixed
;
812 corruptions_fixed
= check
->corruptions_fixed
;
814 if (output_format
== OFORMAT_HUMAN
) {
816 "The following inconsistencies were found and repaired:\n\n"
817 " %" PRId64
" leaked clusters\n"
818 " %" PRId64
" corruptions\n\n"
819 "Double checking the fixed image now...\n",
821 check
->corruptions_fixed
);
824 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
826 check
->leaks_fixed
= leaks_fixed
;
827 check
->corruptions_fixed
= corruptions_fixed
;
831 switch (output_format
) {
833 dump_human_image_check(check
, quiet
);
836 dump_json_image_check(check
, quiet
);
841 if (ret
|| check
->check_errors
) {
843 error_report("Check failed: %s", strerror(-ret
));
845 error_report("Check failed");
851 if (check
->corruptions
) {
853 } else if (check
->leaks
) {
860 qapi_free_ImageCheck(check
);
865 typedef struct CommonBlockJobCBInfo
{
866 BlockDriverState
*bs
;
868 } CommonBlockJobCBInfo
;
870 static void common_block_job_cb(void *opaque
, int ret
)
872 CommonBlockJobCBInfo
*cbi
= opaque
;
875 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
879 static void run_block_job(BlockJob
*job
, Error
**errp
)
881 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
884 aio_context_acquire(aio_context
);
887 aio_poll(aio_context
, true);
888 qemu_progress_print(job
->len
?
889 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
890 } while (!job
->ready
&& !job
->completed
);
892 if (!job
->completed
) {
893 ret
= block_job_complete_sync(job
, errp
);
897 block_job_unref(job
);
898 aio_context_release(aio_context
);
900 /* publish completion progress only when success */
902 qemu_progress_print(100.f
, 0);
906 static int img_commit(int argc
, char **argv
)
909 const char *filename
, *fmt
, *cache
, *base
;
911 BlockDriverState
*bs
, *base_bs
;
913 bool progress
= false, quiet
= false, drop
= false;
915 Error
*local_err
= NULL
;
916 CommonBlockJobCBInfo cbi
;
917 bool image_opts
= false;
918 AioContext
*aio_context
;
921 cache
= BDRV_DEFAULT_CACHE
;
924 static const struct option long_options
[] = {
925 {"help", no_argument
, 0, 'h'},
926 {"object", required_argument
, 0, OPTION_OBJECT
},
927 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
930 c
= getopt_long(argc
, argv
, ":f:ht:b:dpq",
937 missing_argument(argv
[optind
- 1]);
940 unrecognized_option(argv
[optind
- 1]);
965 case OPTION_OBJECT
: {
967 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
973 case OPTION_IMAGE_OPTS
:
979 /* Progress is not shown in Quiet mode */
984 if (optind
!= argc
- 1) {
985 error_exit("Expecting one image file name");
987 filename
= argv
[optind
++];
989 if (qemu_opts_foreach(&qemu_object_opts
,
990 user_creatable_add_opts_foreach
,
995 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
996 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
998 error_report("Invalid cache option: %s", cache
);
1002 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
1009 qemu_progress_init(progress
, 1.f
);
1010 qemu_progress_print(0.f
, 100);
1013 base_bs
= bdrv_find_backing_image(bs
, base
);
1015 error_setg(&local_err
,
1016 "Did not find '%s' in the backing chain of '%s'",
1021 /* This is different from QMP, which by default uses the deepest file in
1022 * the backing chain (i.e., the very base); however, the traditional
1023 * behavior of qemu-img commit is using the immediate backing file. */
1024 base_bs
= backing_bs(bs
);
1026 error_setg(&local_err
, "Image does not have a backing file");
1031 cbi
= (CommonBlockJobCBInfo
){
1036 aio_context
= bdrv_get_aio_context(bs
);
1037 aio_context_acquire(aio_context
);
1038 commit_active_start("commit", bs
, base_bs
, BLOCK_JOB_DEFAULT
, 0,
1039 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1040 &cbi
, false, &local_err
);
1041 aio_context_release(aio_context
);
1046 /* When the block job completes, the BlockBackend reference will point to
1047 * the old backing file. In order to avoid that the top image is already
1048 * deleted, so we can still empty it afterwards, increment the reference
1049 * counter here preemptively. */
1054 job
= block_job_get("commit");
1055 run_block_job(job
, &local_err
);
1060 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
1061 ret
= bs
->drv
->bdrv_make_empty(bs
);
1063 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
1075 qemu_progress_end();
1080 error_report_err(local_err
);
1084 qprintf(quiet
, "Image committed.\n");
1089 * Returns true iff the first sector pointed to by 'buf' contains at least
1092 * 'pnum' is set to the number of sectors (including and immediately following
1093 * the first one) that are known to be in the same allocated/unallocated state.
1095 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
1104 is_zero
= buffer_is_zero(buf
, 512);
1105 for(i
= 1; i
< n
; i
++) {
1107 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1116 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1117 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1118 * breaking up write requests for only small sparse areas.
1120 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1124 int num_checked
, num_used
;
1130 ret
= is_allocated_sectors(buf
, n
, pnum
);
1136 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1138 num_checked
= num_used
;
1141 ret
= is_allocated_sectors(buf
, n
, pnum
);
1143 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1145 num_checked
+= *pnum
;
1147 num_used
= num_checked
;
1148 } else if (*pnum
>= min
) {
1158 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1159 * buffers matches, non-zero otherwise.
1161 * pnum is set to the number of sectors (including and immediately following
1162 * the first one) that are known to have the same comparison result
1164 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1175 res
= !!memcmp(buf1
, buf2
, 512);
1176 for(i
= 1; i
< n
; i
++) {
1180 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1189 #define IO_BUF_SIZE (2 * 1024 * 1024)
1191 static int64_t sectors_to_bytes(int64_t sectors
)
1193 return sectors
<< BDRV_SECTOR_BITS
;
1196 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1198 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1202 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1204 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1205 * data and negative value on error.
1207 * @param blk: BlockBackend for the image
1208 * @param sect_num: Number of first sector to check
1209 * @param sect_count: Number of sectors to check
1210 * @param filename: Name of disk file we are checking (logging purpose)
1211 * @param buffer: Allocated buffer for storing read data
1212 * @param quiet: Flag for quiet mode
1214 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1215 int sect_count
, const char *filename
,
1216 uint8_t *buffer
, bool quiet
)
1219 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1220 sect_count
<< BDRV_SECTOR_BITS
);
1222 error_report("Error while reading offset %" PRId64
" of %s: %s",
1223 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1226 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1227 if (ret
|| pnum
!= sect_count
) {
1228 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1229 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1237 * Compares two images. Exit codes:
1239 * 0 - Images are identical
1241 * >1 - Error occurred
1243 static int img_compare(int argc
, char **argv
)
1245 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1246 BlockBackend
*blk1
, *blk2
;
1247 BlockDriverState
*bs1
, *bs2
;
1248 int64_t total_sectors1
, total_sectors2
;
1249 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1251 int allocated1
, allocated2
;
1252 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1253 bool progress
= false, quiet
= false, strict
= false;
1256 int64_t total_sectors
;
1257 int64_t sector_num
= 0;
1260 uint64_t progress_base
;
1261 bool image_opts
= false;
1262 bool force_share
= false;
1264 cache
= BDRV_DEFAULT_CACHE
;
1266 static const struct option long_options
[] = {
1267 {"help", no_argument
, 0, 'h'},
1268 {"object", required_argument
, 0, OPTION_OBJECT
},
1269 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1270 {"force-share", no_argument
, 0, 'U'},
1273 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1274 long_options
, NULL
);
1280 missing_argument(argv
[optind
- 1]);
1283 unrecognized_option(argv
[optind
- 1]);
1309 case OPTION_OBJECT
: {
1311 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1318 case OPTION_IMAGE_OPTS
:
1324 /* Progress is not shown in Quiet mode */
1330 if (optind
!= argc
- 2) {
1331 error_exit("Expecting two image file names");
1333 filename1
= argv
[optind
++];
1334 filename2
= argv
[optind
++];
1336 if (qemu_opts_foreach(&qemu_object_opts
,
1337 user_creatable_add_opts_foreach
,
1343 /* Initialize before goto out */
1344 qemu_progress_init(progress
, 2.0);
1347 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1349 error_report("Invalid source cache option: %s", cache
);
1354 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1361 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1370 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1371 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1372 total_sectors1
= blk_nb_sectors(blk1
);
1373 if (total_sectors1
< 0) {
1374 error_report("Can't get size of %s: %s",
1375 filename1
, strerror(-total_sectors1
));
1379 total_sectors2
= blk_nb_sectors(blk2
);
1380 if (total_sectors2
< 0) {
1381 error_report("Can't get size of %s: %s",
1382 filename2
, strerror(-total_sectors2
));
1386 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1387 progress_base
= MAX(total_sectors1
, total_sectors2
);
1389 qemu_progress_print(0, 100);
1391 if (strict
&& total_sectors1
!= total_sectors2
) {
1393 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1398 int64_t status1
, status2
;
1399 BlockDriverState
*file
;
1401 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1402 if (nb_sectors
<= 0) {
1405 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1406 total_sectors1
- sector_num
,
1410 error_report("Sector allocation test failed for %s", filename1
);
1413 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1415 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1416 total_sectors2
- sector_num
,
1420 error_report("Sector allocation test failed for %s", filename2
);
1423 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1425 nb_sectors
= MIN(nb_sectors
, pnum1
);
1428 nb_sectors
= MIN(nb_sectors
, pnum2
);
1432 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1433 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1435 qprintf(quiet
, "Strict mode: Offset %" PRId64
1436 " block status mismatch!\n",
1437 sectors_to_bytes(sector_num
));
1441 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1442 nb_sectors
= MIN(pnum1
, pnum2
);
1443 } else if (allocated1
== allocated2
) {
1445 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1446 nb_sectors
<< BDRV_SECTOR_BITS
);
1448 error_report("Error while reading offset %" PRId64
" of %s:"
1449 " %s", sectors_to_bytes(sector_num
), filename1
,
1454 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1455 nb_sectors
<< BDRV_SECTOR_BITS
);
1457 error_report("Error while reading offset %" PRId64
1458 " of %s: %s", sectors_to_bytes(sector_num
),
1459 filename2
, strerror(-ret
));
1463 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1464 if (ret
|| pnum
!= nb_sectors
) {
1465 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1467 ret
? sector_num
: sector_num
+ pnum
));
1475 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1476 filename1
, buf1
, quiet
);
1478 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1479 filename2
, buf1
, quiet
);
1483 error_report("Error while reading offset %" PRId64
": %s",
1484 sectors_to_bytes(sector_num
), strerror(-ret
));
1490 sector_num
+= nb_sectors
;
1491 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1494 if (total_sectors1
!= total_sectors2
) {
1495 BlockBackend
*blk_over
;
1496 int64_t total_sectors_over
;
1497 const char *filename_over
;
1499 qprintf(quiet
, "Warning: Image size mismatch!\n");
1500 if (total_sectors1
> total_sectors2
) {
1501 total_sectors_over
= total_sectors1
;
1503 filename_over
= filename1
;
1505 total_sectors_over
= total_sectors2
;
1507 filename_over
= filename2
;
1513 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1514 if (nb_sectors
<= 0) {
1517 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
,
1518 sector_num
* BDRV_SECTOR_SIZE
,
1519 nb_sectors
* BDRV_SECTOR_SIZE
,
1523 error_report("Sector allocation test failed for %s",
1528 /* TODO relax this once bdrv_is_allocated_above does not enforce
1529 * sector alignment */
1530 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
1531 nb_sectors
= count
>> BDRV_SECTOR_BITS
;
1533 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1534 filename_over
, buf1
, quiet
);
1537 error_report("Error while reading offset %" PRId64
1538 " of %s: %s", sectors_to_bytes(sector_num
),
1539 filename_over
, strerror(-ret
));
1545 sector_num
+= nb_sectors
;
1546 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1550 qprintf(quiet
, "Images are identical.\n");
1560 qemu_progress_end();
1565 enum ImgConvertBlockStatus
{
1571 #define MAX_COROUTINES 16
1573 typedef struct ImgConvertState
{
1575 int64_t *src_sectors
;
1577 int64_t total_sectors
;
1578 int64_t allocated_sectors
;
1579 int64_t allocated_done
;
1582 enum ImgConvertBlockStatus status
;
1583 int64_t sector_next_status
;
1584 BlockBackend
*target
;
1587 bool target_has_backing
;
1590 size_t cluster_sectors
;
1592 long num_coroutines
;
1593 int running_coroutines
;
1594 Coroutine
*co
[MAX_COROUTINES
];
1595 int64_t wait_sector_num
[MAX_COROUTINES
];
1600 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1601 int *src_cur
, int64_t *src_cur_offset
)
1604 *src_cur_offset
= 0;
1605 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1606 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1608 assert(*src_cur
< s
->src_num
);
1612 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1614 int64_t ret
, src_cur_offset
;
1617 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1619 assert(s
->total_sectors
> sector_num
);
1620 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1622 if (s
->sector_next_status
<= sector_num
) {
1623 BlockDriverState
*file
;
1624 if (s
->target_has_backing
) {
1625 ret
= bdrv_get_block_status(blk_bs(s
->src
[src_cur
]),
1626 sector_num
- src_cur_offset
,
1629 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1630 sector_num
- src_cur_offset
,
1637 if (ret
& BDRV_BLOCK_ZERO
) {
1638 s
->status
= BLK_ZERO
;
1639 } else if (ret
& BDRV_BLOCK_DATA
) {
1640 s
->status
= BLK_DATA
;
1642 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1645 s
->sector_next_status
= sector_num
+ n
;
1648 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1649 if (s
->status
== BLK_DATA
) {
1650 n
= MIN(n
, s
->buf_sectors
);
1653 /* We need to write complete clusters for compressed images, so if an
1654 * unallocated area is shorter than that, we must consider the whole
1655 * cluster allocated. */
1656 if (s
->compressed
) {
1657 if (n
< s
->cluster_sectors
) {
1658 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1659 s
->status
= BLK_DATA
;
1661 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1668 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1669 int nb_sectors
, uint8_t *buf
)
1675 assert(nb_sectors
<= s
->buf_sectors
);
1676 while (nb_sectors
> 0) {
1679 int64_t bs_sectors
, src_cur_offset
;
1681 /* In the case of compression with multiple source files, we can get a
1682 * nb_sectors that spreads into the next part. So we must be able to
1683 * read across multiple BDSes for one convert_read() call. */
1684 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1685 blk
= s
->src
[src_cur
];
1686 bs_sectors
= s
->src_sectors
[src_cur
];
1688 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1690 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1691 qemu_iovec_init_external(&qiov
, &iov
, 1);
1693 ret
= blk_co_preadv(
1694 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1695 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1702 buf
+= n
* BDRV_SECTOR_SIZE
;
1709 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1710 int nb_sectors
, uint8_t *buf
,
1711 enum ImgConvertBlockStatus status
)
1717 while (nb_sectors
> 0) {
1719 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1722 case BLK_BACKING_FILE
:
1723 /* If we have a backing file, leave clusters unallocated that are
1724 * unallocated in the source image, so that the backing file is
1725 * visible at the respective offset. */
1726 assert(s
->target_has_backing
);
1730 /* If we're told to keep the target fully allocated (-S 0) or there
1731 * is real non-zero data, we must write it. Otherwise we can treat
1732 * it as zero sectors.
1733 * Compressed clusters need to be written as a whole, so in that
1734 * case we can only save the write if the buffer is completely
1736 if (!s
->min_sparse
||
1738 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
)) ||
1740 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1743 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1744 qemu_iovec_init_external(&qiov
, &iov
, 1);
1746 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1747 n
<< BDRV_SECTOR_BITS
, &qiov
, flags
);
1756 if (s
->has_zero_init
) {
1757 assert(!s
->target_has_backing
);
1760 ret
= blk_co_pwrite_zeroes(s
->target
,
1761 sector_num
<< BDRV_SECTOR_BITS
,
1762 n
<< BDRV_SECTOR_BITS
, 0);
1771 buf
+= n
* BDRV_SECTOR_SIZE
;
1777 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1779 ImgConvertState
*s
= opaque
;
1780 uint8_t *buf
= NULL
;
1784 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1785 if (s
->co
[i
] == qemu_coroutine_self()) {
1792 s
->running_coroutines
++;
1793 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1798 enum ImgConvertBlockStatus status
;
1800 qemu_co_mutex_lock(&s
->lock
);
1801 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1802 qemu_co_mutex_unlock(&s
->lock
);
1805 n
= convert_iteration_sectors(s
, s
->sector_num
);
1807 qemu_co_mutex_unlock(&s
->lock
);
1811 /* save current sector and allocation status to local variables */
1812 sector_num
= s
->sector_num
;
1814 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1815 n
= MIN(n
, s
->buf_sectors
);
1817 /* increment global sector counter so that other coroutines can
1818 * already continue reading beyond this request */
1820 qemu_co_mutex_unlock(&s
->lock
);
1822 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1823 s
->allocated_done
+= n
;
1824 qemu_progress_print(100.0 * s
->allocated_done
/
1825 s
->allocated_sectors
, 0);
1828 if (status
== BLK_DATA
) {
1829 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1831 error_report("error while reading sector %" PRId64
1832 ": %s", sector_num
, strerror(-ret
));
1835 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1837 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1840 if (s
->wr_in_order
) {
1841 /* keep writes in order */
1842 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
1843 s
->wait_sector_num
[index
] = sector_num
;
1844 qemu_coroutine_yield();
1846 s
->wait_sector_num
[index
] = -1;
1849 if (s
->ret
== -EINPROGRESS
) {
1850 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1852 error_report("error while writing sector %" PRId64
1853 ": %s", sector_num
, strerror(-ret
));
1858 if (s
->wr_in_order
) {
1859 /* reenter the coroutine that might have waited
1860 * for this write to complete */
1861 s
->wr_offs
= sector_num
+ n
;
1862 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1863 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1865 * A -> B -> A cannot occur because A has
1866 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1867 * B will never enter A during this time window.
1869 qemu_coroutine_enter(s
->co
[i
]);
1877 s
->co
[index
] = NULL
;
1878 s
->running_coroutines
--;
1879 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1880 /* the convert job finished successfully */
1885 static int convert_do_copy(ImgConvertState
*s
)
1888 int64_t sector_num
= 0;
1890 /* Check whether we have zero initialisation or can get it efficiently */
1891 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1892 ? bdrv_has_zero_init(blk_bs(s
->target
))
1895 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1896 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1898 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1900 s
->has_zero_init
= true;
1904 /* Allocate buffer for copied data. For compressed images, only one cluster
1905 * can be copied at a time. */
1906 if (s
->compressed
) {
1907 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1908 error_report("invalid cluster size");
1911 s
->buf_sectors
= s
->cluster_sectors
;
1914 while (sector_num
< s
->total_sectors
) {
1915 n
= convert_iteration_sectors(s
, sector_num
);
1919 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1921 s
->allocated_sectors
+= n
;
1927 s
->sector_next_status
= 0;
1928 s
->ret
= -EINPROGRESS
;
1930 qemu_co_mutex_init(&s
->lock
);
1931 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1932 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1933 s
->wait_sector_num
[i
] = -1;
1934 qemu_coroutine_enter(s
->co
[i
]);
1937 while (s
->running_coroutines
) {
1938 main_loop_wait(false);
1941 if (s
->compressed
&& !s
->ret
) {
1942 /* signal EOF to align */
1943 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1952 static int img_convert(int argc
, char **argv
)
1954 int c
, bs_i
, flags
, src_flags
= 0;
1955 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
1956 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
1957 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
1958 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
1959 BlockDriverInfo bdi
;
1960 BlockDriverState
*out_bs
;
1961 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
1962 QemuOptsList
*create_opts
= NULL
;
1963 char *options
= NULL
;
1964 Error
*local_err
= NULL
;
1965 bool writethrough
, src_writethrough
, quiet
= false, image_opts
= false,
1966 skip_create
= false, progress
= false, tgt_image_opts
= false;
1967 int64_t ret
= -EINVAL
;
1968 bool force_share
= false;
1970 ImgConvertState s
= (ImgConvertState
) {
1971 /* Need at least 4k of zeros for sparse detection */
1973 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
1974 .wr_in_order
= true,
1975 .num_coroutines
= 8,
1979 static const struct option long_options
[] = {
1980 {"help", no_argument
, 0, 'h'},
1981 {"object", required_argument
, 0, OPTION_OBJECT
},
1982 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1983 {"force-share", no_argument
, 0, 'U'},
1984 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
1987 c
= getopt_long(argc
, argv
, ":hf:O:B:co:s:l:S:pt:T:qnm:WU",
1988 long_options
, NULL
);
1994 missing_argument(argv
[optind
- 1]);
1997 unrecognized_option(argv
[optind
- 1]);
2009 out_baseimg
= optarg
;
2012 s
.compressed
= true;
2015 if (!is_valid_option_list(optarg
)) {
2016 error_report("Invalid option list: %s", optarg
);
2020 options
= g_strdup(optarg
);
2022 char *old_options
= options
;
2023 options
= g_strdup_printf("%s,%s", options
, optarg
);
2024 g_free(old_options
);
2028 snapshot_name
= optarg
;
2031 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2032 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2035 error_report("Failed in parsing snapshot param '%s'",
2040 snapshot_name
= optarg
;
2047 sval
= cvtnum(optarg
);
2049 error_report("Invalid minimum zero buffer size for sparse output specified");
2053 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2072 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2073 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2074 error_report("Invalid number of coroutines. Allowed number of"
2075 " coroutines is between 1 and %d", MAX_COROUTINES
);
2080 s
.wr_in_order
= false;
2085 case OPTION_OBJECT
: {
2086 QemuOpts
*object_opts
;
2087 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2094 case OPTION_IMAGE_OPTS
:
2097 case OPTION_TARGET_IMAGE_OPTS
:
2098 tgt_image_opts
= true;
2103 if (!out_fmt
&& !tgt_image_opts
) {
2107 if (qemu_opts_foreach(&qemu_object_opts
,
2108 user_creatable_add_opts_foreach
,
2113 if (!s
.wr_in_order
&& s
.compressed
) {
2114 error_report("Out of order write and compress are mutually exclusive");
2118 if (tgt_image_opts
&& !skip_create
) {
2119 error_report("--target-image-opts requires use of -n flag");
2123 s
.src_num
= argc
- optind
- 1;
2124 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2126 if (options
&& has_help_option(options
)) {
2128 ret
= print_block_option_help(out_filename
, out_fmt
);
2131 error_report("Option help requires a format be specified");
2136 if (s
.src_num
< 1) {
2137 error_report("Must specify image file name");
2142 /* ret is still -EINVAL until here */
2143 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2145 error_report("Invalid source cache option: %s", src_cache
);
2149 /* Initialize before goto out */
2153 qemu_progress_init(progress
, 1.0);
2154 qemu_progress_print(0, 100);
2156 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2157 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2159 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2160 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2161 fmt
, src_flags
, src_writethrough
, quiet
,
2167 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2168 if (s
.src_sectors
[bs_i
] < 0) {
2169 error_report("Could not get size of %s: %s",
2170 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2174 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2178 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2179 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2180 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2182 } else if (snapshot_name
!= NULL
) {
2183 if (s
.src_num
> 1) {
2184 error_report("No support for concatenating multiple snapshot");
2189 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2193 error_reportf_err(local_err
, "Failed to load snapshot: ");
2199 /* Find driver and parse its options */
2200 drv
= bdrv_find_format(out_fmt
);
2202 error_report("Unknown file format '%s'", out_fmt
);
2207 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2209 error_report_err(local_err
);
2214 if (!drv
->create_opts
) {
2215 error_report("Format driver '%s' does not support image creation",
2221 if (!proto_drv
->create_opts
) {
2222 error_report("Protocol driver '%s' does not support image creation",
2223 proto_drv
->format_name
);
2228 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2229 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2231 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2233 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2235 error_report_err(local_err
);
2241 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, s
.total_sectors
* 512,
2243 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2249 /* Get backing file name if -o backing_file was used */
2250 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2251 if (out_baseimg_param
) {
2252 out_baseimg
= out_baseimg_param
;
2254 s
.target_has_backing
= (bool) out_baseimg
;
2256 if (s
.src_num
> 1 && out_baseimg
) {
2257 error_report("Having a backing file for the target makes no sense when "
2258 "concatenating multiple input images");
2263 /* Check if compression is supported */
2266 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2267 const char *preallocation
=
2268 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2270 if (drv
&& !drv
->bdrv_co_pwritev_compressed
) {
2271 error_report("Compression not supported for this file format");
2277 error_report("Compression and encryption not supported at "
2284 && strcmp(preallocation
, "off"))
2286 error_report("Compression and preallocation not supported at "
2294 /* Create the new image */
2295 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2297 error_reportf_err(local_err
, "%s: error while converting %s: ",
2298 out_filename
, out_fmt
);
2303 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2304 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2306 error_report("Invalid cache option: %s", cache
);
2311 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2312 flags
, writethrough
, quiet
, false);
2314 /* TODO ultimately we should allow --target-image-opts
2315 * to be used even when -n is not given.
2316 * That has to wait for bdrv_create to be improved
2317 * to allow filenames in option syntax
2319 s
.target
= img_open_new_file(out_filename
, opts
, out_fmt
,
2320 flags
, writethrough
, quiet
, false);
2326 out_bs
= blk_bs(s
.target
);
2328 if (s
.compressed
&& !out_bs
->drv
->bdrv_co_pwritev_compressed
) {
2329 error_report("Compression not supported for this file format");
2334 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2335 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2337 s
.buf_sectors
= MIN(32768,
2339 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2340 out_bs
->bl
.pdiscard_alignment
>>
2341 BDRV_SECTOR_BITS
)));
2344 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2345 if (output_sectors
< 0) {
2346 error_report("unable to get output image length: %s",
2347 strerror(-output_sectors
));
2350 } else if (output_sectors
< s
.total_sectors
) {
2351 error_report("output file is smaller than input file");
2357 ret
= bdrv_get_info(out_bs
, &bdi
);
2360 error_report("could not get block driver info");
2364 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2365 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2368 ret
= convert_do_copy(&s
);
2371 qemu_progress_print(100, 0);
2373 qemu_progress_end();
2374 qemu_opts_del(opts
);
2375 qemu_opts_free(create_opts
);
2376 qemu_opts_del(sn_opts
);
2377 blk_unref(s
.target
);
2379 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2380 blk_unref(s
.src
[bs_i
]);
2384 g_free(s
.src_sectors
);
2392 static void dump_snapshots(BlockDriverState
*bs
)
2394 QEMUSnapshotInfo
*sn_tab
, *sn
;
2397 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2400 printf("Snapshot list:\n");
2401 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2403 for(i
= 0; i
< nb_sns
; i
++) {
2405 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2411 static void dump_json_image_info_list(ImageInfoList
*list
)
2415 Visitor
*v
= qobject_output_visitor_new(&obj
);
2417 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2418 visit_complete(v
, &obj
);
2419 str
= qobject_to_json_pretty(obj
);
2420 assert(str
!= NULL
);
2421 printf("%s\n", qstring_get_str(str
));
2422 qobject_decref(obj
);
2427 static void dump_json_image_info(ImageInfo
*info
)
2431 Visitor
*v
= qobject_output_visitor_new(&obj
);
2433 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2434 visit_complete(v
, &obj
);
2435 str
= qobject_to_json_pretty(obj
);
2436 assert(str
!= NULL
);
2437 printf("%s\n", qstring_get_str(str
));
2438 qobject_decref(obj
);
2443 static void dump_human_image_info_list(ImageInfoList
*list
)
2445 ImageInfoList
*elem
;
2448 for (elem
= list
; elem
; elem
= elem
->next
) {
2454 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2458 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2460 return strcmp(a
, b
) == 0;
2464 * Open an image file chain and return an ImageInfoList
2466 * @filename: topmost image filename
2467 * @fmt: topmost image format (may be NULL to autodetect)
2468 * @chain: true - enumerate entire backing file chain
2469 * false - only topmost image file
2471 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2472 * image file. If there was an error a message will have been printed to
2475 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2476 const char *filename
,
2478 bool chain
, bool force_share
)
2480 ImageInfoList
*head
= NULL
;
2481 ImageInfoList
**last
= &head
;
2482 GHashTable
*filenames
;
2485 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2489 BlockDriverState
*bs
;
2491 ImageInfoList
*elem
;
2493 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2494 error_report("Backing file '%s' creates an infinite loop.",
2498 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2500 blk
= img_open(image_opts
, filename
, fmt
,
2501 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2508 bdrv_query_image_info(bs
, &info
, &err
);
2510 error_report_err(err
);
2515 elem
= g_new0(ImageInfoList
, 1);
2522 filename
= fmt
= NULL
;
2524 if (info
->has_full_backing_filename
) {
2525 filename
= info
->full_backing_filename
;
2526 } else if (info
->has_backing_filename
) {
2527 error_report("Could not determine absolute backing filename,"
2528 " but backing filename '%s' present",
2529 info
->backing_filename
);
2532 if (info
->has_backing_filename_format
) {
2533 fmt
= info
->backing_filename_format
;
2537 g_hash_table_destroy(filenames
);
2541 qapi_free_ImageInfoList(head
);
2542 g_hash_table_destroy(filenames
);
2546 static int img_info(int argc
, char **argv
)
2549 OutputFormat output_format
= OFORMAT_HUMAN
;
2551 const char *filename
, *fmt
, *output
;
2552 ImageInfoList
*list
;
2553 bool image_opts
= false;
2554 bool force_share
= false;
2559 int option_index
= 0;
2560 static const struct option long_options
[] = {
2561 {"help", no_argument
, 0, 'h'},
2562 {"format", required_argument
, 0, 'f'},
2563 {"output", required_argument
, 0, OPTION_OUTPUT
},
2564 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2565 {"object", required_argument
, 0, OPTION_OBJECT
},
2566 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2567 {"force-share", no_argument
, 0, 'U'},
2570 c
= getopt_long(argc
, argv
, ":f:hU",
2571 long_options
, &option_index
);
2577 missing_argument(argv
[optind
- 1]);
2580 unrecognized_option(argv
[optind
- 1]);
2594 case OPTION_BACKING_CHAIN
:
2597 case OPTION_OBJECT
: {
2599 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2605 case OPTION_IMAGE_OPTS
:
2610 if (optind
!= argc
- 1) {
2611 error_exit("Expecting one image file name");
2613 filename
= argv
[optind
++];
2615 if (output
&& !strcmp(output
, "json")) {
2616 output_format
= OFORMAT_JSON
;
2617 } else if (output
&& !strcmp(output
, "human")) {
2618 output_format
= OFORMAT_HUMAN
;
2619 } else if (output
) {
2620 error_report("--output must be used with human or json as argument.");
2624 if (qemu_opts_foreach(&qemu_object_opts
,
2625 user_creatable_add_opts_foreach
,
2630 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
2636 switch (output_format
) {
2638 dump_human_image_info_list(list
);
2642 dump_json_image_info_list(list
);
2644 dump_json_image_info(list
->value
);
2649 qapi_free_ImageInfoList(list
);
2653 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2656 switch (output_format
) {
2658 if (e
->data
&& !e
->has_offset
) {
2659 error_report("File contains external, encrypted or compressed clusters.");
2662 if (e
->data
&& !e
->zero
) {
2663 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2664 e
->start
, e
->length
,
2665 e
->has_offset
? e
->offset
: 0,
2666 e
->has_filename
? e
->filename
: "");
2668 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2669 * Modify the flags here to allow more coalescing.
2671 if (next
&& (!next
->data
|| next
->zero
)) {
2677 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2678 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2679 (e
->start
== 0 ? "[" : ",\n"),
2680 e
->start
, e
->length
, e
->depth
,
2681 e
->zero
? "true" : "false",
2682 e
->data
? "true" : "false");
2683 if (e
->has_offset
) {
2684 printf(", \"offset\": %"PRId64
"", e
->offset
);
2695 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2696 int nb_sectors
, MapEntry
*e
)
2700 BlockDriverState
*file
;
2703 /* As an optimization, we could cache the current range of unallocated
2704 * clusters in each file of the chain, and avoid querying the same
2710 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2716 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2719 bs
= backing_bs(bs
);
2728 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2731 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2732 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2733 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2734 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2735 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2736 .has_offset
= has_offset
,
2738 .has_filename
= file
&& has_offset
,
2739 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2745 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2747 if (curr
->length
== 0) {
2750 if (curr
->zero
!= next
->zero
||
2751 curr
->data
!= next
->data
||
2752 curr
->depth
!= next
->depth
||
2753 curr
->has_filename
!= next
->has_filename
||
2754 curr
->has_offset
!= next
->has_offset
) {
2757 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2760 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2766 static int img_map(int argc
, char **argv
)
2769 OutputFormat output_format
= OFORMAT_HUMAN
;
2771 BlockDriverState
*bs
;
2772 const char *filename
, *fmt
, *output
;
2774 MapEntry curr
= { .length
= 0 }, next
;
2776 bool image_opts
= false;
2777 bool force_share
= false;
2782 int option_index
= 0;
2783 static const struct option long_options
[] = {
2784 {"help", no_argument
, 0, 'h'},
2785 {"format", required_argument
, 0, 'f'},
2786 {"output", required_argument
, 0, OPTION_OUTPUT
},
2787 {"object", required_argument
, 0, OPTION_OBJECT
},
2788 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2789 {"force-share", no_argument
, 0, 'U'},
2792 c
= getopt_long(argc
, argv
, ":f:hU",
2793 long_options
, &option_index
);
2799 missing_argument(argv
[optind
- 1]);
2802 unrecognized_option(argv
[optind
- 1]);
2816 case OPTION_OBJECT
: {
2818 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2824 case OPTION_IMAGE_OPTS
:
2829 if (optind
!= argc
- 1) {
2830 error_exit("Expecting one image file name");
2832 filename
= argv
[optind
];
2834 if (output
&& !strcmp(output
, "json")) {
2835 output_format
= OFORMAT_JSON
;
2836 } else if (output
&& !strcmp(output
, "human")) {
2837 output_format
= OFORMAT_HUMAN
;
2838 } else if (output
) {
2839 error_report("--output must be used with human or json as argument.");
2843 if (qemu_opts_foreach(&qemu_object_opts
,
2844 user_creatable_add_opts_foreach
,
2849 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
2855 if (output_format
== OFORMAT_HUMAN
) {
2856 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2859 length
= blk_getlength(blk
);
2860 while (curr
.start
+ curr
.length
< length
) {
2861 int64_t nsectors_left
;
2865 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2867 /* Probe up to 1 GiB at a time. */
2868 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2869 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2870 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2873 error_report("Could not read file metadata: %s", strerror(-ret
));
2877 if (entry_mergeable(&curr
, &next
)) {
2878 curr
.length
+= next
.length
;
2882 if (curr
.length
> 0) {
2883 dump_map_entry(output_format
, &curr
, &next
);
2888 dump_map_entry(output_format
, &curr
, NULL
);
2895 #define SNAPSHOT_LIST 1
2896 #define SNAPSHOT_CREATE 2
2897 #define SNAPSHOT_APPLY 3
2898 #define SNAPSHOT_DELETE 4
2900 static int img_snapshot(int argc
, char **argv
)
2903 BlockDriverState
*bs
;
2904 QEMUSnapshotInfo sn
;
2905 char *filename
, *snapshot_name
= NULL
;
2906 int c
, ret
= 0, bdrv_oflags
;
2911 bool image_opts
= false;
2912 bool force_share
= false;
2914 bdrv_oflags
= BDRV_O_RDWR
;
2915 /* Parse commandline parameters */
2917 static const struct option long_options
[] = {
2918 {"help", no_argument
, 0, 'h'},
2919 {"object", required_argument
, 0, OPTION_OBJECT
},
2920 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2921 {"force-share", no_argument
, 0, 'U'},
2924 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
2925 long_options
, NULL
);
2931 missing_argument(argv
[optind
- 1]);
2934 unrecognized_option(argv
[optind
- 1]);
2941 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2944 action
= SNAPSHOT_LIST
;
2945 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2949 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2952 action
= SNAPSHOT_APPLY
;
2953 snapshot_name
= optarg
;
2957 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2960 action
= SNAPSHOT_CREATE
;
2961 snapshot_name
= optarg
;
2965 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2968 action
= SNAPSHOT_DELETE
;
2969 snapshot_name
= optarg
;
2977 case OPTION_OBJECT
: {
2979 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2985 case OPTION_IMAGE_OPTS
:
2991 if (optind
!= argc
- 1) {
2992 error_exit("Expecting one image file name");
2994 filename
= argv
[optind
++];
2996 if (qemu_opts_foreach(&qemu_object_opts
,
2997 user_creatable_add_opts_foreach
,
3002 /* Open the image */
3003 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
3010 /* Perform the requested action */
3016 case SNAPSHOT_CREATE
:
3017 memset(&sn
, 0, sizeof(sn
));
3018 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3020 qemu_gettimeofday(&tv
);
3021 sn
.date_sec
= tv
.tv_sec
;
3022 sn
.date_nsec
= tv
.tv_usec
* 1000;
3024 ret
= bdrv_snapshot_create(bs
, &sn
);
3026 error_report("Could not create snapshot '%s': %d (%s)",
3027 snapshot_name
, ret
, strerror(-ret
));
3031 case SNAPSHOT_APPLY
:
3032 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
3034 error_report("Could not apply snapshot '%s': %d (%s)",
3035 snapshot_name
, ret
, strerror(-ret
));
3039 case SNAPSHOT_DELETE
:
3040 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
3042 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3057 static int img_rebase(int argc
, char **argv
)
3059 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3060 uint8_t *buf_old
= NULL
;
3061 uint8_t *buf_new
= NULL
;
3062 BlockDriverState
*bs
= NULL
;
3064 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3065 int c
, flags
, src_flags
, ret
;
3066 bool writethrough
, src_writethrough
;
3068 bool force_share
= false;
3071 Error
*local_err
= NULL
;
3072 bool image_opts
= false;
3074 /* Parse commandline parameters */
3076 cache
= BDRV_DEFAULT_CACHE
;
3077 src_cache
= BDRV_DEFAULT_CACHE
;
3081 static const struct option long_options
[] = {
3082 {"help", no_argument
, 0, 'h'},
3083 {"object", required_argument
, 0, OPTION_OBJECT
},
3084 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3085 {"force-share", no_argument
, 0, 'U'},
3088 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3089 long_options
, NULL
);
3095 missing_argument(argv
[optind
- 1]);
3098 unrecognized_option(argv
[optind
- 1]);
3107 out_basefmt
= optarg
;
3110 out_baseimg
= optarg
;
3127 case OPTION_OBJECT
: {
3129 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3135 case OPTION_IMAGE_OPTS
:
3148 if (optind
!= argc
- 1) {
3149 error_exit("Expecting one image file name");
3151 if (!unsafe
&& !out_baseimg
) {
3152 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3154 filename
= argv
[optind
++];
3156 if (qemu_opts_foreach(&qemu_object_opts
,
3157 user_creatable_add_opts_foreach
,
3162 qemu_progress_init(progress
, 2.0);
3163 qemu_progress_print(0, 100);
3165 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3166 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3168 error_report("Invalid cache option: %s", cache
);
3173 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3175 error_report("Invalid source cache option: %s", src_cache
);
3179 /* The source files are opened read-only, don't care about WCE */
3180 assert((src_flags
& BDRV_O_RDWR
) == 0);
3181 (void) src_writethrough
;
3186 * Ignore the old backing file for unsafe rebase in case we want to correct
3187 * the reference to a renamed or moved backing file.
3189 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3197 if (out_basefmt
!= NULL
) {
3198 if (bdrv_find_format(out_basefmt
) == NULL
) {
3199 error_report("Invalid format name: '%s'", out_basefmt
);
3205 /* For safe rebasing we need to compare old and new backing file */
3207 char backing_name
[PATH_MAX
];
3208 QDict
*options
= NULL
;
3210 if (bs
->backing_format
[0] != '\0') {
3211 options
= qdict_new();
3212 qdict_put_str(options
, "driver", bs
->backing_format
);
3217 options
= qdict_new();
3219 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3221 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3222 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3223 options
, src_flags
, &local_err
);
3224 if (!blk_old_backing
) {
3225 error_reportf_err(local_err
,
3226 "Could not open old backing file '%s': ",
3232 if (out_baseimg
[0]) {
3233 options
= qdict_new();
3235 qdict_put_str(options
, "driver", out_basefmt
);
3238 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3241 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
3242 options
, src_flags
, &local_err
);
3243 if (!blk_new_backing
) {
3244 error_reportf_err(local_err
,
3245 "Could not open new backing file '%s': ",
3254 * Check each unallocated cluster in the COW file. If it is unallocated,
3255 * accesses go to the backing file. We must therefore compare this cluster
3256 * in the old and new backing file, and if they differ we need to copy it
3257 * from the old backing file into the COW file.
3259 * If qemu-img crashes during this step, no harm is done. The content of
3260 * the image is the same as the original one at any time.
3263 int64_t num_sectors
;
3264 int64_t old_backing_num_sectors
;
3265 int64_t new_backing_num_sectors
= 0;
3269 float local_progress
= 0;
3271 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3272 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3274 num_sectors
= blk_nb_sectors(blk
);
3275 if (num_sectors
< 0) {
3276 error_report("Could not get size of '%s': %s",
3277 filename
, strerror(-num_sectors
));
3281 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3282 if (old_backing_num_sectors
< 0) {
3283 char backing_name
[PATH_MAX
];
3285 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3286 error_report("Could not get size of '%s': %s",
3287 backing_name
, strerror(-old_backing_num_sectors
));
3291 if (blk_new_backing
) {
3292 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3293 if (new_backing_num_sectors
< 0) {
3294 error_report("Could not get size of '%s': %s",
3295 out_baseimg
, strerror(-new_backing_num_sectors
));
3301 if (num_sectors
!= 0) {
3302 local_progress
= (float)100 /
3303 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3306 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3308 /* How many sectors can we handle with the next read? */
3309 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3310 n
= (IO_BUF_SIZE
/ 512);
3312 n
= num_sectors
- sector
;
3315 /* If the cluster is allocated, we don't need to take action */
3316 ret
= bdrv_is_allocated(bs
, sector
<< BDRV_SECTOR_BITS
,
3317 n
<< BDRV_SECTOR_BITS
, &count
);
3319 error_report("error while reading image metadata: %s",
3323 /* TODO relax this once bdrv_is_allocated does not enforce
3324 * sector alignment */
3325 assert(QEMU_IS_ALIGNED(count
, BDRV_SECTOR_SIZE
));
3326 n
= count
>> BDRV_SECTOR_BITS
;
3332 * Read old and new backing file and take into consideration that
3333 * backing files may be smaller than the COW image.
3335 if (sector
>= old_backing_num_sectors
) {
3336 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3338 if (sector
+ n
> old_backing_num_sectors
) {
3339 n
= old_backing_num_sectors
- sector
;
3342 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3343 buf_old
, n
<< BDRV_SECTOR_BITS
);
3345 error_report("error while reading from old backing file");
3350 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3351 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3353 if (sector
+ n
> new_backing_num_sectors
) {
3354 n
= new_backing_num_sectors
- sector
;
3357 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3358 buf_new
, n
<< BDRV_SECTOR_BITS
);
3360 error_report("error while reading from new backing file");
3365 /* If they differ, we need to write to the COW file */
3366 uint64_t written
= 0;
3368 while (written
< n
) {
3371 if (compare_sectors(buf_old
+ written
* 512,
3372 buf_new
+ written
* 512, n
- written
, &pnum
))
3374 ret
= blk_pwrite(blk
,
3375 (sector
+ written
) << BDRV_SECTOR_BITS
,
3376 buf_old
+ written
* 512,
3377 pnum
<< BDRV_SECTOR_BITS
, 0);
3379 error_report("Error while writing to COW image: %s",
3387 qemu_progress_print(local_progress
, 100);
3392 * Change the backing file. All clusters that are different from the old
3393 * backing file are overwritten in the COW file now, so the visible content
3394 * doesn't change when we switch the backing file.
3396 if (out_baseimg
&& *out_baseimg
) {
3397 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3399 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3402 if (ret
== -ENOSPC
) {
3403 error_report("Could not change the backing file to '%s': No "
3404 "space left in the file header", out_baseimg
);
3405 } else if (ret
< 0) {
3406 error_report("Could not change the backing file to '%s': %s",
3407 out_baseimg
, strerror(-ret
));
3410 qemu_progress_print(100, 0);
3412 * TODO At this point it is possible to check if any clusters that are
3413 * allocated in the COW file are the same in the backing file. If so, they
3414 * could be dropped from the COW file. Don't do this before switching the
3415 * backing file, in case of a crash this would lead to corruption.
3418 qemu_progress_end();
3421 blk_unref(blk_old_backing
);
3422 blk_unref(blk_new_backing
);
3424 qemu_vfree(buf_old
);
3425 qemu_vfree(buf_new
);
3434 static int img_resize(int argc
, char **argv
)
3437 int c
, ret
, relative
;
3438 const char *filename
, *fmt
, *size
;
3439 int64_t n
, total_size
;
3441 BlockBackend
*blk
= NULL
;
3444 static QemuOptsList resize_options
= {
3445 .name
= "resize_options",
3446 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3449 .name
= BLOCK_OPT_SIZE
,
3450 .type
= QEMU_OPT_SIZE
,
3451 .help
= "Virtual disk size"
3457 bool image_opts
= false;
3459 /* Remove size from argv manually so that negative numbers are not treated
3460 * as options by getopt. */
3462 error_exit("Not enough arguments");
3466 size
= argv
[--argc
];
3468 /* Parse getopt arguments */
3471 static const struct option long_options
[] = {
3472 {"help", no_argument
, 0, 'h'},
3473 {"object", required_argument
, 0, OPTION_OBJECT
},
3474 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3477 c
= getopt_long(argc
, argv
, ":f:hq",
3478 long_options
, NULL
);
3484 missing_argument(argv
[optind
- 1]);
3487 unrecognized_option(argv
[optind
- 1]);
3498 case OPTION_OBJECT
: {
3500 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3506 case OPTION_IMAGE_OPTS
:
3511 if (optind
!= argc
- 1) {
3512 error_exit("Expecting one image file name");
3514 filename
= argv
[optind
++];
3516 if (qemu_opts_foreach(&qemu_object_opts
,
3517 user_creatable_add_opts_foreach
,
3522 /* Choose grow, shrink, or absolute resize mode */
3538 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3539 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3541 error_report_err(err
);
3543 qemu_opts_del(param
);
3546 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3547 qemu_opts_del(param
);
3549 blk
= img_open(image_opts
, filename
, fmt
,
3550 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
3558 total_size
= blk_getlength(blk
) + n
* relative
;
3562 if (total_size
<= 0) {
3563 error_report("New image size must be positive");
3568 ret
= blk_truncate(blk
, total_size
, &err
);
3570 qprintf(quiet
, "Image resized.\n");
3572 error_report_err(err
);
3582 static void amend_status_cb(BlockDriverState
*bs
,
3583 int64_t offset
, int64_t total_work_size
,
3586 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3589 static int img_amend(int argc
, char **argv
)
3593 char *options
= NULL
;
3594 QemuOptsList
*create_opts
= NULL
;
3595 QemuOpts
*opts
= NULL
;
3596 const char *fmt
= NULL
, *filename
, *cache
;
3599 bool quiet
= false, progress
= false;
3600 BlockBackend
*blk
= NULL
;
3601 BlockDriverState
*bs
= NULL
;
3602 bool image_opts
= false;
3604 cache
= BDRV_DEFAULT_CACHE
;
3606 static const struct option long_options
[] = {
3607 {"help", no_argument
, 0, 'h'},
3608 {"object", required_argument
, 0, OPTION_OBJECT
},
3609 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3612 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
3613 long_options
, NULL
);
3620 missing_argument(argv
[optind
- 1]);
3623 unrecognized_option(argv
[optind
- 1]);
3629 if (!is_valid_option_list(optarg
)) {
3630 error_report("Invalid option list: %s", optarg
);
3632 goto out_no_progress
;
3635 options
= g_strdup(optarg
);
3637 char *old_options
= options
;
3638 options
= g_strdup_printf("%s,%s", options
, optarg
);
3639 g_free(old_options
);
3655 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3659 goto out_no_progress
;
3662 case OPTION_IMAGE_OPTS
:
3669 error_exit("Must specify options (-o)");
3672 if (qemu_opts_foreach(&qemu_object_opts
,
3673 user_creatable_add_opts_foreach
,
3676 goto out_no_progress
;
3682 qemu_progress_init(progress
, 1.0);
3684 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3685 if (fmt
&& has_help_option(options
)) {
3686 /* If a format is explicitly specified (and possibly no filename is
3687 * given), print option help here */
3688 ret
= print_block_option_help(filename
, fmt
);
3692 if (optind
!= argc
- 1) {
3693 error_report("Expecting one image file name");
3698 flags
= BDRV_O_RDWR
;
3699 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3701 error_report("Invalid cache option: %s", cache
);
3705 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3713 fmt
= bs
->drv
->format_name
;
3715 if (has_help_option(options
)) {
3716 /* If the format was auto-detected, print option help here */
3717 ret
= print_block_option_help(filename
, fmt
);
3721 if (!bs
->drv
->create_opts
) {
3722 error_report("Format driver '%s' does not support any options to amend",
3728 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3729 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3730 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3732 error_report_err(err
);
3737 /* In case the driver does not call amend_status_cb() */
3738 qemu_progress_print(0.f
, 0);
3739 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3740 qemu_progress_print(100.f
, 0);
3742 error_report("Error while amending options: %s", strerror(-ret
));
3747 qemu_progress_end();
3751 qemu_opts_del(opts
);
3752 qemu_opts_free(create_opts
);
3761 typedef struct BenchData
{
3763 uint64_t image_size
;
3770 bool drain_on_flush
;
3779 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3782 error_report("Failed flush request: %s", strerror(-ret
));
3787 static void bench_cb(void *opaque
, int ret
)
3789 BenchData
*b
= opaque
;
3793 error_report("Failed request: %s", strerror(-ret
));
3798 /* Just finished a flush with drained queue: Start next requests */
3799 assert(b
->in_flight
== 0);
3800 b
->in_flush
= false;
3801 } else if (b
->in_flight
> 0) {
3802 int remaining
= b
->n
- b
->in_flight
;
3807 /* Time for flush? Drain queue if requested, then flush */
3808 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3809 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3810 BlockCompletionFunc
*cb
;
3812 if (b
->drain_on_flush
) {
3816 cb
= bench_undrained_flush_cb
;
3819 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3821 error_report("Failed to issue flush request");
3825 if (b
->drain_on_flush
) {
3831 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3832 int64_t offset
= b
->offset
;
3833 /* blk_aio_* might look for completed I/Os and kick bench_cb
3834 * again, so make sure this operation is counted by in_flight
3835 * and b->offset is ready for the next submission.
3838 b
->offset
+= b
->step
;
3839 b
->offset
%= b
->image_size
;
3841 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3843 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3846 error_report("Failed to issue request");
3852 static int img_bench(int argc
, char **argv
)
3855 const char *fmt
= NULL
, *filename
;
3857 bool image_opts
= false;
3858 bool is_write
= false;
3862 size_t bufsize
= 4096;
3865 int flush_interval
= 0;
3866 bool drain_on_flush
= true;
3868 BlockBackend
*blk
= NULL
;
3869 BenchData data
= {};
3871 bool writethrough
= false;
3872 struct timeval t1
, t2
;
3874 bool force_share
= false;
3877 static const struct option long_options
[] = {
3878 {"help", no_argument
, 0, 'h'},
3879 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3880 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3881 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3882 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3883 {"force-share", no_argument
, 0, 'U'},
3886 c
= getopt_long(argc
, argv
, ":hc:d:f:no:qs:S:t:wU", long_options
, NULL
);
3893 missing_argument(argv
[optind
- 1]);
3896 unrecognized_option(argv
[optind
- 1]);
3905 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3906 error_report("Invalid request count specified");
3916 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3917 error_report("Invalid queue depth specified");
3927 flags
|= BDRV_O_NATIVE_AIO
;
3931 offset
= cvtnum(optarg
);
3933 error_report("Invalid offset specified");
3946 sval
= cvtnum(optarg
);
3947 if (sval
< 0 || sval
> INT_MAX
) {
3948 error_report("Invalid buffer size specified");
3959 sval
= cvtnum(optarg
);
3960 if (sval
< 0 || sval
> INT_MAX
) {
3961 error_report("Invalid step size specified");
3969 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3971 error_report("Invalid cache mode");
3977 flags
|= BDRV_O_RDWR
;
3983 case OPTION_PATTERN
:
3987 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
3988 error_report("Invalid pattern byte specified");
3994 case OPTION_FLUSH_INTERVAL
:
3998 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3999 error_report("Invalid flush interval specified");
4002 flush_interval
= res
;
4005 case OPTION_NO_DRAIN
:
4006 drain_on_flush
= false;
4008 case OPTION_IMAGE_OPTS
:
4014 if (optind
!= argc
- 1) {
4015 error_exit("Expecting one image file name");
4017 filename
= argv
[argc
- 1];
4019 if (!is_write
&& flush_interval
) {
4020 error_report("--flush-interval is only available in write tests");
4024 if (flush_interval
&& flush_interval
< depth
) {
4025 error_report("Flush interval can't be smaller than depth");
4030 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4037 image_size
= blk_getlength(blk
);
4038 if (image_size
< 0) {
4043 data
= (BenchData
) {
4045 .image_size
= image_size
,
4047 .step
= step
?: bufsize
,
4052 .flush_interval
= flush_interval
,
4053 .drain_on_flush
= drain_on_flush
,
4055 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4056 "(starting at offset %" PRId64
", step size %d)\n",
4057 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4058 data
.offset
, data
.step
);
4059 if (flush_interval
) {
4060 printf("Sending flush every %d requests\n", flush_interval
);
4063 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
4064 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4066 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4067 for (i
= 0; i
< data
.nrreq
; i
++) {
4068 qemu_iovec_init(&data
.qiov
[i
], 1);
4069 qemu_iovec_add(&data
.qiov
[i
],
4070 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4073 gettimeofday(&t1
, NULL
);
4076 while (data
.n
> 0) {
4077 main_loop_wait(false);
4079 gettimeofday(&t2
, NULL
);
4081 printf("Run completed in %3.3f seconds.\n",
4082 (t2
.tv_sec
- t1
.tv_sec
)
4083 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4086 qemu_vfree(data
.buf
);
4107 int bsz
; /* Block size */
4115 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4119 static int img_dd_bs(const char *arg
,
4120 struct DdIo
*in
, struct DdIo
*out
,
4127 if (res
<= 0 || res
> INT_MAX
) {
4128 error_report("invalid number: '%s'", arg
);
4131 in
->bsz
= out
->bsz
= res
;
4136 static int img_dd_count(const char *arg
,
4137 struct DdIo
*in
, struct DdIo
*out
,
4140 dd
->count
= cvtnum(arg
);
4142 if (dd
->count
< 0) {
4143 error_report("invalid number: '%s'", arg
);
4150 static int img_dd_if(const char *arg
,
4151 struct DdIo
*in
, struct DdIo
*out
,
4154 in
->filename
= g_strdup(arg
);
4159 static int img_dd_of(const char *arg
,
4160 struct DdIo
*in
, struct DdIo
*out
,
4163 out
->filename
= g_strdup(arg
);
4168 static int img_dd_skip(const char *arg
,
4169 struct DdIo
*in
, struct DdIo
*out
,
4172 in
->offset
= cvtnum(arg
);
4174 if (in
->offset
< 0) {
4175 error_report("invalid number: '%s'", arg
);
4182 static int img_dd(int argc
, char **argv
)
4187 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4188 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4189 QemuOpts
*opts
= NULL
;
4190 QemuOptsList
*create_opts
= NULL
;
4191 Error
*local_err
= NULL
;
4192 bool image_opts
= false;
4194 const char *out_fmt
= "raw";
4195 const char *fmt
= NULL
;
4197 int64_t block_count
= 0, out_pos
, in_pos
;
4198 bool force_share
= false;
4199 struct DdInfo dd
= {
4204 .bsz
= 512, /* Block size is by default 512 bytes */
4216 const struct DdOpts options
[] = {
4217 { "bs", img_dd_bs
, C_BS
},
4218 { "count", img_dd_count
, C_COUNT
},
4219 { "if", img_dd_if
, C_IF
},
4220 { "of", img_dd_of
, C_OF
},
4221 { "skip", img_dd_skip
, C_SKIP
},
4224 const struct option long_options
[] = {
4225 { "help", no_argument
, 0, 'h'},
4226 { "object", required_argument
, 0, OPTION_OBJECT
},
4227 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4228 { "force-share", no_argument
, 0, 'U'},
4232 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
4244 missing_argument(argv
[optind
- 1]);
4247 unrecognized_option(argv
[optind
- 1]);
4256 if (!qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true)) {
4261 case OPTION_IMAGE_OPTS
:
4267 for (i
= optind
; i
< argc
; i
++) {
4269 arg
= g_strdup(argv
[i
]);
4271 tmp
= strchr(arg
, '=');
4273 error_report("unrecognized operand %s", arg
);
4280 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4281 if (!strcmp(arg
, options
[j
].name
)) {
4285 if (options
[j
].name
== NULL
) {
4286 error_report("unrecognized operand %s", arg
);
4291 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4295 dd
.flags
|= options
[j
].flag
;
4300 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4301 error_report("Must specify both input and output files");
4306 if (qemu_opts_foreach(&qemu_object_opts
,
4307 user_creatable_add_opts_foreach
,
4313 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
4321 drv
= bdrv_find_format(out_fmt
);
4323 error_report("Unknown file format");
4327 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4330 error_report_err(local_err
);
4334 if (!drv
->create_opts
) {
4335 error_report("Format driver '%s' does not support image creation",
4340 if (!proto_drv
->create_opts
) {
4341 error_report("Protocol driver '%s' does not support image creation",
4342 proto_drv
->format_name
);
4346 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4347 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4349 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4351 size
= blk_getlength(blk1
);
4353 error_report("Failed to get size for '%s'", in
.filename
);
4358 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4359 dd
.count
* in
.bsz
< size
) {
4360 size
= dd
.count
* in
.bsz
;
4363 /* Overflow means the specified offset is beyond input image's size */
4364 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4365 size
< in
.bsz
* in
.offset
)) {
4366 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4368 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4369 size
- in
.bsz
* in
.offset
, &error_abort
);
4372 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4374 error_reportf_err(local_err
,
4375 "%s: error while creating output image: ",
4381 /* TODO, we can't honour --image-opts for the target,
4382 * since it needs to be given in a format compatible
4383 * with the bdrv_create() call above which does not
4384 * support image-opts style.
4386 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
4387 false, false, false);
4394 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4395 size
< in
.offset
* in
.bsz
)) {
4396 /* We give a warning if the skip option is bigger than the input
4397 * size and create an empty output disk image (i.e. like dd(1)).
4399 error_report("%s: cannot skip to specified offset", in
.filename
);
4402 in_pos
= in
.offset
* in
.bsz
;
4405 in
.buf
= g_new(uint8_t, in
.bsz
);
4407 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4408 int in_ret
, out_ret
;
4410 if (in_pos
+ in
.bsz
> size
) {
4411 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4413 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4416 error_report("error while reading from input image file: %s",
4423 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4426 error_report("error while writing to output image file: %s",
4427 strerror(-out_ret
));
4436 qemu_opts_del(opts
);
4437 qemu_opts_free(create_opts
);
4440 g_free(in
.filename
);
4441 g_free(out
.filename
);
4452 static const img_cmd_t img_cmds
[] = {
4453 #define DEF(option, callback, arg_string) \
4454 { option, callback },
4455 #include "qemu-img-cmds.h"
4461 int main(int argc
, char **argv
)
4463 const img_cmd_t
*cmd
;
4464 const char *cmdname
;
4465 Error
*local_error
= NULL
;
4466 char *trace_file
= NULL
;
4468 static const struct option long_options
[] = {
4469 {"help", no_argument
, 0, 'h'},
4470 {"version", no_argument
, 0, 'V'},
4471 {"trace", required_argument
, NULL
, 'T'},
4476 signal(SIGPIPE
, SIG_IGN
);
4479 module_call_init(MODULE_INIT_TRACE
);
4480 error_set_progname(argv
[0]);
4481 qemu_init_exec_dir(argv
[0]);
4483 if (qemu_init_main_loop(&local_error
)) {
4484 error_report_err(local_error
);
4488 qcrypto_init(&error_fatal
);
4490 module_call_init(MODULE_INIT_QOM
);
4493 error_exit("Not enough arguments");
4496 qemu_add_opts(&qemu_object_opts
);
4497 qemu_add_opts(&qemu_source_opts
);
4498 qemu_add_opts(&qemu_trace_opts
);
4500 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
4503 missing_argument(argv
[optind
- 1]);
4506 unrecognized_option(argv
[optind
- 1]);
4512 printf(QEMU_IMG_VERSION
);
4516 trace_file
= trace_opt_parse(optarg
);
4521 cmdname
= argv
[optind
];
4523 /* reset getopt_long scanning */
4531 if (!trace_init_backends()) {
4534 trace_init_file(trace_file
);
4535 qemu_set_log(LOG_TRACE
);
4537 /* find the command */
4538 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4539 if (!strcmp(cmdname
, cmd
->name
)) {
4540 return cmd
->handler(argc
, argv
);
4545 error_exit("Command not found: %s", cmdname
);