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:he6o:q",
474 missing_argument(argv
[optind
- 1]);
477 unrecognized_option(argv
[optind
- 1]);
486 base_filename
= optarg
;
492 error_report("option -e is deprecated, please use \'-o "
493 "encryption\' instead!");
496 error_report("option -6 is deprecated, please use \'-o "
497 "compat6\' instead!");
500 if (!is_valid_option_list(optarg
)) {
501 error_report("Invalid option list: %s", optarg
);
505 options
= g_strdup(optarg
);
507 char *old_options
= options
;
508 options
= g_strdup_printf("%s,%s", options
, optarg
);
515 case OPTION_OBJECT
: {
517 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
526 /* Get the filename */
527 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
528 if (options
&& has_help_option(options
)) {
530 return print_block_option_help(filename
, fmt
);
533 if (optind
>= argc
) {
534 error_exit("Expecting image file name");
538 if (qemu_opts_foreach(&qemu_object_opts
,
539 user_creatable_add_opts_foreach
,
544 /* Get image size, if specified */
548 sval
= cvtnum(argv
[optind
++]);
550 if (sval
== -ERANGE
) {
551 error_report("Image size must be less than 8 EiB!");
553 error_report("Invalid image size specified! You may use k, M, "
554 "G, T, P or E suffixes for ");
555 error_report("kilobytes, megabytes, gigabytes, terabytes, "
556 "petabytes and exabytes.");
560 img_size
= (uint64_t)sval
;
562 if (optind
!= argc
) {
563 error_exit("Unexpected argument: %s", argv
[optind
]);
566 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
567 options
, img_size
, 0, quiet
, &local_err
);
569 error_reportf_err(local_err
, "%s: ", filename
);
581 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
585 Visitor
*v
= qobject_output_visitor_new(&obj
);
587 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
588 visit_complete(v
, &obj
);
589 str
= qobject_to_json_pretty(obj
);
591 qprintf(quiet
, "%s\n", qstring_get_str(str
));
597 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
599 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
600 qprintf(quiet
, "No errors were found on the image.\n");
602 if (check
->corruptions
) {
603 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
604 "Data may be corrupted, or further writes to the image "
611 "\n%" PRId64
" leaked clusters were found on the image.\n"
612 "This means waste of disk space, but no harm to data.\n",
616 if (check
->check_errors
) {
619 " internal errors have occurred during the check.\n",
620 check
->check_errors
);
624 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
625 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
626 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
627 check
->allocated_clusters
, check
->total_clusters
,
628 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
629 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
630 check
->compressed_clusters
* 100.0 /
631 check
->allocated_clusters
);
634 if (check
->image_end_offset
) {
636 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
640 static int collect_image_check(BlockDriverState
*bs
,
642 const char *filename
,
647 BdrvCheckResult result
;
649 ret
= bdrv_check(bs
, &result
, fix
);
654 check
->filename
= g_strdup(filename
);
655 check
->format
= g_strdup(bdrv_get_format_name(bs
));
656 check
->check_errors
= result
.check_errors
;
657 check
->corruptions
= result
.corruptions
;
658 check
->has_corruptions
= result
.corruptions
!= 0;
659 check
->leaks
= result
.leaks
;
660 check
->has_leaks
= result
.leaks
!= 0;
661 check
->corruptions_fixed
= result
.corruptions_fixed
;
662 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
663 check
->leaks_fixed
= result
.leaks_fixed
;
664 check
->has_leaks_fixed
= result
.leaks
!= 0;
665 check
->image_end_offset
= result
.image_end_offset
;
666 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
667 check
->total_clusters
= result
.bfi
.total_clusters
;
668 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
669 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
670 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
671 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
672 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
673 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
674 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
680 * Checks an image for consistency. Exit codes:
682 * 0 - Check completed, image is good
683 * 1 - Check not completed because of internal errors
684 * 2 - Check completed, image is corrupted
685 * 3 - Check completed, image has leaked clusters, but is good otherwise
686 * 63 - Checks are not supported by the image format
688 static int img_check(int argc
, char **argv
)
691 OutputFormat output_format
= OFORMAT_HUMAN
;
692 const char *filename
, *fmt
, *output
, *cache
;
694 BlockDriverState
*bs
;
696 int flags
= BDRV_O_CHECK
;
700 bool image_opts
= false;
701 bool force_share
= false;
705 cache
= BDRV_DEFAULT_CACHE
;
708 int option_index
= 0;
709 static const struct option long_options
[] = {
710 {"help", no_argument
, 0, 'h'},
711 {"format", required_argument
, 0, 'f'},
712 {"repair", required_argument
, 0, 'r'},
713 {"output", required_argument
, 0, OPTION_OUTPUT
},
714 {"object", required_argument
, 0, OPTION_OBJECT
},
715 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
716 {"force-share", no_argument
, 0, 'U'},
719 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
720 long_options
, &option_index
);
726 missing_argument(argv
[optind
- 1]);
729 unrecognized_option(argv
[optind
- 1]);
738 flags
|= BDRV_O_RDWR
;
740 if (!strcmp(optarg
, "leaks")) {
741 fix
= BDRV_FIX_LEAKS
;
742 } else if (!strcmp(optarg
, "all")) {
743 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
745 error_exit("Unknown option value for -r "
746 "(expecting 'leaks' or 'all'): %s", optarg
);
761 case OPTION_OBJECT
: {
763 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
769 case OPTION_IMAGE_OPTS
:
774 if (optind
!= argc
- 1) {
775 error_exit("Expecting one image file name");
777 filename
= argv
[optind
++];
779 if (output
&& !strcmp(output
, "json")) {
780 output_format
= OFORMAT_JSON
;
781 } else if (output
&& !strcmp(output
, "human")) {
782 output_format
= OFORMAT_HUMAN
;
784 error_report("--output must be used with human or json as argument.");
788 if (qemu_opts_foreach(&qemu_object_opts
,
789 user_creatable_add_opts_foreach
,
794 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
796 error_report("Invalid source cache option: %s", cache
);
800 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
807 check
= g_new0(ImageCheck
, 1);
808 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
810 if (ret
== -ENOTSUP
) {
811 error_report("This image format does not support checks");
816 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
817 int corruptions_fixed
, leaks_fixed
;
819 leaks_fixed
= check
->leaks_fixed
;
820 corruptions_fixed
= check
->corruptions_fixed
;
822 if (output_format
== OFORMAT_HUMAN
) {
824 "The following inconsistencies were found and repaired:\n\n"
825 " %" PRId64
" leaked clusters\n"
826 " %" PRId64
" corruptions\n\n"
827 "Double checking the fixed image now...\n",
829 check
->corruptions_fixed
);
832 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
834 check
->leaks_fixed
= leaks_fixed
;
835 check
->corruptions_fixed
= corruptions_fixed
;
839 switch (output_format
) {
841 dump_human_image_check(check
, quiet
);
844 dump_json_image_check(check
, quiet
);
849 if (ret
|| check
->check_errors
) {
851 error_report("Check failed: %s", strerror(-ret
));
853 error_report("Check failed");
859 if (check
->corruptions
) {
861 } else if (check
->leaks
) {
868 qapi_free_ImageCheck(check
);
873 typedef struct CommonBlockJobCBInfo
{
874 BlockDriverState
*bs
;
876 } CommonBlockJobCBInfo
;
878 static void common_block_job_cb(void *opaque
, int ret
)
880 CommonBlockJobCBInfo
*cbi
= opaque
;
883 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
887 static void run_block_job(BlockJob
*job
, Error
**errp
)
889 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
892 aio_context_acquire(aio_context
);
895 aio_poll(aio_context
, true);
896 qemu_progress_print(job
->len
?
897 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
898 } while (!job
->ready
&& !job
->completed
);
900 if (!job
->completed
) {
901 ret
= block_job_complete_sync(job
, errp
);
905 block_job_unref(job
);
906 aio_context_release(aio_context
);
908 /* publish completion progress only when success */
910 qemu_progress_print(100.f
, 0);
914 static int img_commit(int argc
, char **argv
)
917 const char *filename
, *fmt
, *cache
, *base
;
919 BlockDriverState
*bs
, *base_bs
;
921 bool progress
= false, quiet
= false, drop
= false;
923 Error
*local_err
= NULL
;
924 CommonBlockJobCBInfo cbi
;
925 bool image_opts
= false;
926 AioContext
*aio_context
;
929 cache
= BDRV_DEFAULT_CACHE
;
932 static const struct option long_options
[] = {
933 {"help", no_argument
, 0, 'h'},
934 {"object", required_argument
, 0, OPTION_OBJECT
},
935 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
938 c
= getopt_long(argc
, argv
, ":f:ht:b:dpq",
945 missing_argument(argv
[optind
- 1]);
948 unrecognized_option(argv
[optind
- 1]);
973 case OPTION_OBJECT
: {
975 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
981 case OPTION_IMAGE_OPTS
:
987 /* Progress is not shown in Quiet mode */
992 if (optind
!= argc
- 1) {
993 error_exit("Expecting one image file name");
995 filename
= argv
[optind
++];
997 if (qemu_opts_foreach(&qemu_object_opts
,
998 user_creatable_add_opts_foreach
,
1003 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
1004 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1006 error_report("Invalid cache option: %s", cache
);
1010 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
1017 qemu_progress_init(progress
, 1.f
);
1018 qemu_progress_print(0.f
, 100);
1021 base_bs
= bdrv_find_backing_image(bs
, base
);
1023 error_setg(&local_err
,
1024 "Did not find '%s' in the backing chain of '%s'",
1029 /* This is different from QMP, which by default uses the deepest file in
1030 * the backing chain (i.e., the very base); however, the traditional
1031 * behavior of qemu-img commit is using the immediate backing file. */
1032 base_bs
= backing_bs(bs
);
1034 error_setg(&local_err
, "Image does not have a backing file");
1039 cbi
= (CommonBlockJobCBInfo
){
1044 aio_context
= bdrv_get_aio_context(bs
);
1045 aio_context_acquire(aio_context
);
1046 commit_active_start("commit", bs
, base_bs
, BLOCK_JOB_DEFAULT
, 0,
1047 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1048 &cbi
, false, &local_err
);
1049 aio_context_release(aio_context
);
1054 /* When the block job completes, the BlockBackend reference will point to
1055 * the old backing file. In order to avoid that the top image is already
1056 * deleted, so we can still empty it afterwards, increment the reference
1057 * counter here preemptively. */
1062 job
= block_job_get("commit");
1063 run_block_job(job
, &local_err
);
1068 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
1069 ret
= bs
->drv
->bdrv_make_empty(bs
);
1071 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
1083 qemu_progress_end();
1088 error_report_err(local_err
);
1092 qprintf(quiet
, "Image committed.\n");
1097 * Returns true iff the first sector pointed to by 'buf' contains at least
1100 * 'pnum' is set to the number of sectors (including and immediately following
1101 * the first one) that are known to be in the same allocated/unallocated state.
1103 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
1112 is_zero
= buffer_is_zero(buf
, 512);
1113 for(i
= 1; i
< n
; i
++) {
1115 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1124 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1125 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1126 * breaking up write requests for only small sparse areas.
1128 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1132 int num_checked
, num_used
;
1138 ret
= is_allocated_sectors(buf
, n
, pnum
);
1144 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1146 num_checked
= num_used
;
1149 ret
= is_allocated_sectors(buf
, n
, pnum
);
1151 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1153 num_checked
+= *pnum
;
1155 num_used
= num_checked
;
1156 } else if (*pnum
>= min
) {
1166 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1167 * buffers matches, non-zero otherwise.
1169 * pnum is set to the number of sectors (including and immediately following
1170 * the first one) that are known to have the same comparison result
1172 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1183 res
= !!memcmp(buf1
, buf2
, 512);
1184 for(i
= 1; i
< n
; i
++) {
1188 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1197 #define IO_BUF_SIZE (2 * 1024 * 1024)
1199 static int64_t sectors_to_bytes(int64_t sectors
)
1201 return sectors
<< BDRV_SECTOR_BITS
;
1204 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1206 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1210 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1212 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1213 * data and negative value on error.
1215 * @param blk: BlockBackend for the image
1216 * @param sect_num: Number of first sector to check
1217 * @param sect_count: Number of sectors to check
1218 * @param filename: Name of disk file we are checking (logging purpose)
1219 * @param buffer: Allocated buffer for storing read data
1220 * @param quiet: Flag for quiet mode
1222 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1223 int sect_count
, const char *filename
,
1224 uint8_t *buffer
, bool quiet
)
1227 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1228 sect_count
<< BDRV_SECTOR_BITS
);
1230 error_report("Error while reading offset %" PRId64
" of %s: %s",
1231 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1234 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1235 if (ret
|| pnum
!= sect_count
) {
1236 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1237 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1245 * Compares two images. Exit codes:
1247 * 0 - Images are identical
1249 * >1 - Error occurred
1251 static int img_compare(int argc
, char **argv
)
1253 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1254 BlockBackend
*blk1
, *blk2
;
1255 BlockDriverState
*bs1
, *bs2
;
1256 int64_t total_sectors1
, total_sectors2
;
1257 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1259 int allocated1
, allocated2
;
1260 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1261 bool progress
= false, quiet
= false, strict
= false;
1264 int64_t total_sectors
;
1265 int64_t sector_num
= 0;
1268 uint64_t progress_base
;
1269 bool image_opts
= false;
1270 bool force_share
= false;
1272 cache
= BDRV_DEFAULT_CACHE
;
1274 static const struct option long_options
[] = {
1275 {"help", no_argument
, 0, 'h'},
1276 {"object", required_argument
, 0, OPTION_OBJECT
},
1277 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1278 {"force-share", no_argument
, 0, 'U'},
1281 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1282 long_options
, NULL
);
1288 missing_argument(argv
[optind
- 1]);
1291 unrecognized_option(argv
[optind
- 1]);
1317 case OPTION_OBJECT
: {
1319 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1326 case OPTION_IMAGE_OPTS
:
1332 /* Progress is not shown in Quiet mode */
1338 if (optind
!= argc
- 2) {
1339 error_exit("Expecting two image file names");
1341 filename1
= argv
[optind
++];
1342 filename2
= argv
[optind
++];
1344 if (qemu_opts_foreach(&qemu_object_opts
,
1345 user_creatable_add_opts_foreach
,
1351 /* Initialize before goto out */
1352 qemu_progress_init(progress
, 2.0);
1355 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1357 error_report("Invalid source cache option: %s", cache
);
1362 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1369 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1378 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1379 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1380 total_sectors1
= blk_nb_sectors(blk1
);
1381 if (total_sectors1
< 0) {
1382 error_report("Can't get size of %s: %s",
1383 filename1
, strerror(-total_sectors1
));
1387 total_sectors2
= blk_nb_sectors(blk2
);
1388 if (total_sectors2
< 0) {
1389 error_report("Can't get size of %s: %s",
1390 filename2
, strerror(-total_sectors2
));
1394 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1395 progress_base
= MAX(total_sectors1
, total_sectors2
);
1397 qemu_progress_print(0, 100);
1399 if (strict
&& total_sectors1
!= total_sectors2
) {
1401 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1406 int64_t status1
, status2
;
1407 BlockDriverState
*file
;
1409 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1410 if (nb_sectors
<= 0) {
1413 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1414 total_sectors1
- sector_num
,
1418 error_report("Sector allocation test failed for %s", filename1
);
1421 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1423 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1424 total_sectors2
- sector_num
,
1428 error_report("Sector allocation test failed for %s", filename2
);
1431 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1433 nb_sectors
= MIN(nb_sectors
, pnum1
);
1436 nb_sectors
= MIN(nb_sectors
, pnum2
);
1440 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1441 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1443 qprintf(quiet
, "Strict mode: Offset %" PRId64
1444 " block status mismatch!\n",
1445 sectors_to_bytes(sector_num
));
1449 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1450 nb_sectors
= MIN(pnum1
, pnum2
);
1451 } else if (allocated1
== allocated2
) {
1453 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1454 nb_sectors
<< BDRV_SECTOR_BITS
);
1456 error_report("Error while reading offset %" PRId64
" of %s:"
1457 " %s", sectors_to_bytes(sector_num
), filename1
,
1462 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1463 nb_sectors
<< BDRV_SECTOR_BITS
);
1465 error_report("Error while reading offset %" PRId64
1466 " of %s: %s", sectors_to_bytes(sector_num
),
1467 filename2
, strerror(-ret
));
1471 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1472 if (ret
|| pnum
!= nb_sectors
) {
1473 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1475 ret
? sector_num
: sector_num
+ pnum
));
1483 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1484 filename1
, buf1
, quiet
);
1486 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1487 filename2
, buf1
, quiet
);
1491 error_report("Error while reading offset %" PRId64
": %s",
1492 sectors_to_bytes(sector_num
), strerror(-ret
));
1498 sector_num
+= nb_sectors
;
1499 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1502 if (total_sectors1
!= total_sectors2
) {
1503 BlockBackend
*blk_over
;
1504 int64_t total_sectors_over
;
1505 const char *filename_over
;
1507 qprintf(quiet
, "Warning: Image size mismatch!\n");
1508 if (total_sectors1
> total_sectors2
) {
1509 total_sectors_over
= total_sectors1
;
1511 filename_over
= filename1
;
1513 total_sectors_over
= total_sectors2
;
1515 filename_over
= filename2
;
1519 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1520 if (nb_sectors
<= 0) {
1523 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1527 error_report("Sector allocation test failed for %s",
1534 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1535 filename_over
, buf1
, quiet
);
1538 error_report("Error while reading offset %" PRId64
1539 " of %s: %s", sectors_to_bytes(sector_num
),
1540 filename_over
, strerror(-ret
));
1546 sector_num
+= nb_sectors
;
1547 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1551 qprintf(quiet
, "Images are identical.\n");
1561 qemu_progress_end();
1566 enum ImgConvertBlockStatus
{
1572 #define MAX_COROUTINES 16
1574 typedef struct ImgConvertState
{
1576 int64_t *src_sectors
;
1578 int64_t total_sectors
;
1579 int64_t allocated_sectors
;
1580 int64_t allocated_done
;
1583 enum ImgConvertBlockStatus status
;
1584 int64_t sector_next_status
;
1585 BlockBackend
*target
;
1588 bool target_has_backing
;
1591 size_t cluster_sectors
;
1593 long num_coroutines
;
1594 int running_coroutines
;
1595 Coroutine
*co
[MAX_COROUTINES
];
1596 int64_t wait_sector_num
[MAX_COROUTINES
];
1601 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1602 int *src_cur
, int64_t *src_cur_offset
)
1605 *src_cur_offset
= 0;
1606 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1607 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1609 assert(*src_cur
< s
->src_num
);
1613 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1615 int64_t ret
, src_cur_offset
;
1618 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1620 assert(s
->total_sectors
> sector_num
);
1621 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1623 if (s
->sector_next_status
<= sector_num
) {
1624 BlockDriverState
*file
;
1625 if (s
->target_has_backing
) {
1626 ret
= bdrv_get_block_status(blk_bs(s
->src
[src_cur
]),
1627 sector_num
- src_cur_offset
,
1630 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1631 sector_num
- src_cur_offset
,
1638 if (ret
& BDRV_BLOCK_ZERO
) {
1639 s
->status
= BLK_ZERO
;
1640 } else if (ret
& BDRV_BLOCK_DATA
) {
1641 s
->status
= BLK_DATA
;
1643 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1646 s
->sector_next_status
= sector_num
+ n
;
1649 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1650 if (s
->status
== BLK_DATA
) {
1651 n
= MIN(n
, s
->buf_sectors
);
1654 /* We need to write complete clusters for compressed images, so if an
1655 * unallocated area is shorter than that, we must consider the whole
1656 * cluster allocated. */
1657 if (s
->compressed
) {
1658 if (n
< s
->cluster_sectors
) {
1659 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1660 s
->status
= BLK_DATA
;
1662 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1669 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1670 int nb_sectors
, uint8_t *buf
)
1676 assert(nb_sectors
<= s
->buf_sectors
);
1677 while (nb_sectors
> 0) {
1680 int64_t bs_sectors
, src_cur_offset
;
1682 /* In the case of compression with multiple source files, we can get a
1683 * nb_sectors that spreads into the next part. So we must be able to
1684 * read across multiple BDSes for one convert_read() call. */
1685 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1686 blk
= s
->src
[src_cur
];
1687 bs_sectors
= s
->src_sectors
[src_cur
];
1689 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1691 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1692 qemu_iovec_init_external(&qiov
, &iov
, 1);
1694 ret
= blk_co_preadv(
1695 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1696 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1703 buf
+= n
* BDRV_SECTOR_SIZE
;
1710 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1711 int nb_sectors
, uint8_t *buf
,
1712 enum ImgConvertBlockStatus status
)
1718 while (nb_sectors
> 0) {
1720 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1723 case BLK_BACKING_FILE
:
1724 /* If we have a backing file, leave clusters unallocated that are
1725 * unallocated in the source image, so that the backing file is
1726 * visible at the respective offset. */
1727 assert(s
->target_has_backing
);
1731 /* If we're told to keep the target fully allocated (-S 0) or there
1732 * is real non-zero data, we must write it. Otherwise we can treat
1733 * it as zero sectors.
1734 * Compressed clusters need to be written as a whole, so in that
1735 * case we can only save the write if the buffer is completely
1737 if (!s
->min_sparse
||
1739 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
)) ||
1741 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1744 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1745 qemu_iovec_init_external(&qiov
, &iov
, 1);
1747 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1748 n
<< BDRV_SECTOR_BITS
, &qiov
, flags
);
1757 if (s
->has_zero_init
) {
1758 assert(!s
->target_has_backing
);
1761 ret
= blk_co_pwrite_zeroes(s
->target
,
1762 sector_num
<< BDRV_SECTOR_BITS
,
1763 n
<< BDRV_SECTOR_BITS
, 0);
1772 buf
+= n
* BDRV_SECTOR_SIZE
;
1778 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1780 ImgConvertState
*s
= opaque
;
1781 uint8_t *buf
= NULL
;
1785 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1786 if (s
->co
[i
] == qemu_coroutine_self()) {
1793 s
->running_coroutines
++;
1794 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1799 enum ImgConvertBlockStatus status
;
1801 qemu_co_mutex_lock(&s
->lock
);
1802 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1803 qemu_co_mutex_unlock(&s
->lock
);
1806 n
= convert_iteration_sectors(s
, s
->sector_num
);
1808 qemu_co_mutex_unlock(&s
->lock
);
1812 /* save current sector and allocation status to local variables */
1813 sector_num
= s
->sector_num
;
1815 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1816 n
= MIN(n
, s
->buf_sectors
);
1818 /* increment global sector counter so that other coroutines can
1819 * already continue reading beyond this request */
1821 qemu_co_mutex_unlock(&s
->lock
);
1823 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1824 s
->allocated_done
+= n
;
1825 qemu_progress_print(100.0 * s
->allocated_done
/
1826 s
->allocated_sectors
, 0);
1829 if (status
== BLK_DATA
) {
1830 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1832 error_report("error while reading sector %" PRId64
1833 ": %s", sector_num
, strerror(-ret
));
1836 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1838 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1841 if (s
->wr_in_order
) {
1842 /* keep writes in order */
1843 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
1844 s
->wait_sector_num
[index
] = sector_num
;
1845 qemu_coroutine_yield();
1847 s
->wait_sector_num
[index
] = -1;
1850 if (s
->ret
== -EINPROGRESS
) {
1851 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1853 error_report("error while writing sector %" PRId64
1854 ": %s", sector_num
, strerror(-ret
));
1859 if (s
->wr_in_order
) {
1860 /* reenter the coroutine that might have waited
1861 * for this write to complete */
1862 s
->wr_offs
= sector_num
+ n
;
1863 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1864 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1866 * A -> B -> A cannot occur because A has
1867 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1868 * B will never enter A during this time window.
1870 qemu_coroutine_enter(s
->co
[i
]);
1878 s
->co
[index
] = NULL
;
1879 s
->running_coroutines
--;
1880 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1881 /* the convert job finished successfully */
1886 static int convert_do_copy(ImgConvertState
*s
)
1889 int64_t sector_num
= 0;
1891 /* Check whether we have zero initialisation or can get it efficiently */
1892 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1893 ? bdrv_has_zero_init(blk_bs(s
->target
))
1896 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1897 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1899 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1901 s
->has_zero_init
= true;
1905 /* Allocate buffer for copied data. For compressed images, only one cluster
1906 * can be copied at a time. */
1907 if (s
->compressed
) {
1908 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1909 error_report("invalid cluster size");
1912 s
->buf_sectors
= s
->cluster_sectors
;
1915 while (sector_num
< s
->total_sectors
) {
1916 n
= convert_iteration_sectors(s
, sector_num
);
1920 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1922 s
->allocated_sectors
+= n
;
1928 s
->sector_next_status
= 0;
1929 s
->ret
= -EINPROGRESS
;
1931 qemu_co_mutex_init(&s
->lock
);
1932 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1933 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1934 s
->wait_sector_num
[i
] = -1;
1935 qemu_coroutine_enter(s
->co
[i
]);
1938 while (s
->running_coroutines
) {
1939 main_loop_wait(false);
1942 if (s
->compressed
&& !s
->ret
) {
1943 /* signal EOF to align */
1944 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1953 static int img_convert(int argc
, char **argv
)
1955 int c
, bs_i
, flags
, src_flags
= 0;
1956 const char *fmt
= NULL
, *out_fmt
= NULL
, *cache
= "unsafe",
1957 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
1958 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
1959 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
1960 BlockDriverInfo bdi
;
1961 BlockDriverState
*out_bs
;
1962 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
1963 QemuOptsList
*create_opts
= NULL
;
1964 char *options
= NULL
;
1965 Error
*local_err
= NULL
;
1966 bool writethrough
, src_writethrough
, quiet
= false, image_opts
= false,
1967 skip_create
= false, progress
= false, tgt_image_opts
= false;
1968 int64_t ret
= -EINVAL
;
1969 bool force_share
= false;
1971 ImgConvertState s
= (ImgConvertState
) {
1972 /* Need at least 4k of zeros for sparse detection */
1974 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
1975 .wr_in_order
= true,
1976 .num_coroutines
= 8,
1980 static const struct option long_options
[] = {
1981 {"help", no_argument
, 0, 'h'},
1982 {"object", required_argument
, 0, OPTION_OBJECT
},
1983 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1984 {"force-share", no_argument
, 0, 'U'},
1985 {"target-image-opts", no_argument
, 0, OPTION_TARGET_IMAGE_OPTS
},
1988 c
= getopt_long(argc
, argv
, ":hf:O:B:ce6o:s:l:S:pt:T:qnm:WU",
1989 long_options
, NULL
);
1995 missing_argument(argv
[optind
- 1]);
1998 unrecognized_option(argv
[optind
- 1]);
2010 out_baseimg
= optarg
;
2013 s
.compressed
= true;
2016 error_report("option -e is deprecated, please use \'-o "
2017 "encryption\' instead!");
2020 error_report("option -6 is deprecated, please use \'-o "
2021 "compat6\' instead!");
2024 if (!is_valid_option_list(optarg
)) {
2025 error_report("Invalid option list: %s", optarg
);
2029 options
= g_strdup(optarg
);
2031 char *old_options
= options
;
2032 options
= g_strdup_printf("%s,%s", options
, optarg
);
2033 g_free(old_options
);
2037 snapshot_name
= optarg
;
2040 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2041 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2044 error_report("Failed in parsing snapshot param '%s'",
2049 snapshot_name
= optarg
;
2056 sval
= cvtnum(optarg
);
2058 error_report("Invalid minimum zero buffer size for sparse output specified");
2062 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2081 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2082 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2083 error_report("Invalid number of coroutines. Allowed number of"
2084 " coroutines is between 1 and %d", MAX_COROUTINES
);
2089 s
.wr_in_order
= false;
2094 case OPTION_OBJECT
: {
2095 QemuOpts
*object_opts
;
2096 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2103 case OPTION_IMAGE_OPTS
:
2106 case OPTION_TARGET_IMAGE_OPTS
:
2107 tgt_image_opts
= true;
2112 if (!out_fmt
&& !tgt_image_opts
) {
2116 if (qemu_opts_foreach(&qemu_object_opts
,
2117 user_creatable_add_opts_foreach
,
2122 if (!s
.wr_in_order
&& s
.compressed
) {
2123 error_report("Out of order write and compress are mutually exclusive");
2127 if (tgt_image_opts
&& !skip_create
) {
2128 error_report("--target-image-opts requires use of -n flag");
2132 s
.src_num
= argc
- optind
- 1;
2133 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2135 if (options
&& has_help_option(options
)) {
2137 ret
= print_block_option_help(out_filename
, out_fmt
);
2140 error_report("Option help requires a format be specified");
2145 if (s
.src_num
< 1) {
2146 error_report("Must specify image file name");
2151 /* ret is still -EINVAL until here */
2152 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2154 error_report("Invalid source cache option: %s", src_cache
);
2158 /* Initialize before goto out */
2162 qemu_progress_init(progress
, 1.0);
2163 qemu_progress_print(0, 100);
2165 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2166 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2168 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2169 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2170 fmt
, src_flags
, src_writethrough
, quiet
,
2176 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2177 if (s
.src_sectors
[bs_i
] < 0) {
2178 error_report("Could not get size of %s: %s",
2179 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2183 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2187 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2188 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2189 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2191 } else if (snapshot_name
!= NULL
) {
2192 if (s
.src_num
> 1) {
2193 error_report("No support for concatenating multiple snapshot");
2198 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2202 error_reportf_err(local_err
, "Failed to load snapshot: ");
2208 /* Find driver and parse its options */
2209 drv
= bdrv_find_format(out_fmt
);
2211 error_report("Unknown file format '%s'", out_fmt
);
2216 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2218 error_report_err(local_err
);
2223 if (!drv
->create_opts
) {
2224 error_report("Format driver '%s' does not support image creation",
2230 if (!proto_drv
->create_opts
) {
2231 error_report("Protocol driver '%s' does not support image creation",
2232 proto_drv
->format_name
);
2237 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2238 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2240 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2242 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2244 error_report_err(local_err
);
2250 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, s
.total_sectors
* 512,
2252 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2258 /* Get backing file name if -o backing_file was used */
2259 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2260 if (out_baseimg_param
) {
2261 out_baseimg
= out_baseimg_param
;
2263 s
.target_has_backing
= (bool) out_baseimg
;
2265 if (s
.src_num
> 1 && out_baseimg
) {
2266 error_report("Having a backing file for the target makes no sense when "
2267 "concatenating multiple input images");
2272 /* Check if compression is supported */
2275 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2276 const char *preallocation
=
2277 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2279 if (drv
&& !drv
->bdrv_co_pwritev_compressed
) {
2280 error_report("Compression not supported for this file format");
2286 error_report("Compression and encryption not supported at "
2293 && strcmp(preallocation
, "off"))
2295 error_report("Compression and preallocation not supported at "
2303 /* Create the new image */
2304 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2306 error_reportf_err(local_err
, "%s: error while converting %s: ",
2307 out_filename
, out_fmt
);
2312 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2313 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2315 error_report("Invalid cache option: %s", cache
);
2320 s
.target
= img_open(tgt_image_opts
, out_filename
, out_fmt
,
2321 flags
, writethrough
, quiet
, false);
2323 /* TODO ultimately we should allow --target-image-opts
2324 * to be used even when -n is not given.
2325 * That has to wait for bdrv_create to be improved
2326 * to allow filenames in option syntax
2328 s
.target
= img_open_new_file(out_filename
, opts
, out_fmt
,
2329 flags
, writethrough
, quiet
, false);
2335 out_bs
= blk_bs(s
.target
);
2337 if (s
.compressed
&& !out_bs
->drv
->bdrv_co_pwritev_compressed
) {
2338 error_report("Compression not supported for this file format");
2343 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2344 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2346 s
.buf_sectors
= MIN(32768,
2348 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2349 out_bs
->bl
.pdiscard_alignment
>>
2350 BDRV_SECTOR_BITS
)));
2353 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2354 if (output_sectors
< 0) {
2355 error_report("unable to get output image length: %s",
2356 strerror(-output_sectors
));
2359 } else if (output_sectors
< s
.total_sectors
) {
2360 error_report("output file is smaller than input file");
2366 ret
= bdrv_get_info(out_bs
, &bdi
);
2369 error_report("could not get block driver info");
2373 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2374 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2377 ret
= convert_do_copy(&s
);
2380 qemu_progress_print(100, 0);
2382 qemu_progress_end();
2383 qemu_opts_del(opts
);
2384 qemu_opts_free(create_opts
);
2385 qemu_opts_del(sn_opts
);
2386 blk_unref(s
.target
);
2388 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2389 blk_unref(s
.src
[bs_i
]);
2393 g_free(s
.src_sectors
);
2401 static void dump_snapshots(BlockDriverState
*bs
)
2403 QEMUSnapshotInfo
*sn_tab
, *sn
;
2406 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2409 printf("Snapshot list:\n");
2410 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2412 for(i
= 0; i
< nb_sns
; i
++) {
2414 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2420 static void dump_json_image_info_list(ImageInfoList
*list
)
2424 Visitor
*v
= qobject_output_visitor_new(&obj
);
2426 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2427 visit_complete(v
, &obj
);
2428 str
= qobject_to_json_pretty(obj
);
2429 assert(str
!= NULL
);
2430 printf("%s\n", qstring_get_str(str
));
2431 qobject_decref(obj
);
2436 static void dump_json_image_info(ImageInfo
*info
)
2440 Visitor
*v
= qobject_output_visitor_new(&obj
);
2442 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2443 visit_complete(v
, &obj
);
2444 str
= qobject_to_json_pretty(obj
);
2445 assert(str
!= NULL
);
2446 printf("%s\n", qstring_get_str(str
));
2447 qobject_decref(obj
);
2452 static void dump_human_image_info_list(ImageInfoList
*list
)
2454 ImageInfoList
*elem
;
2457 for (elem
= list
; elem
; elem
= elem
->next
) {
2463 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2467 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2469 return strcmp(a
, b
) == 0;
2473 * Open an image file chain and return an ImageInfoList
2475 * @filename: topmost image filename
2476 * @fmt: topmost image format (may be NULL to autodetect)
2477 * @chain: true - enumerate entire backing file chain
2478 * false - only topmost image file
2480 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2481 * image file. If there was an error a message will have been printed to
2484 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2485 const char *filename
,
2487 bool chain
, bool force_share
)
2489 ImageInfoList
*head
= NULL
;
2490 ImageInfoList
**last
= &head
;
2491 GHashTable
*filenames
;
2494 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2498 BlockDriverState
*bs
;
2500 ImageInfoList
*elem
;
2502 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2503 error_report("Backing file '%s' creates an infinite loop.",
2507 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2509 blk
= img_open(image_opts
, filename
, fmt
,
2510 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2517 bdrv_query_image_info(bs
, &info
, &err
);
2519 error_report_err(err
);
2524 elem
= g_new0(ImageInfoList
, 1);
2531 filename
= fmt
= NULL
;
2533 if (info
->has_full_backing_filename
) {
2534 filename
= info
->full_backing_filename
;
2535 } else if (info
->has_backing_filename
) {
2536 error_report("Could not determine absolute backing filename,"
2537 " but backing filename '%s' present",
2538 info
->backing_filename
);
2541 if (info
->has_backing_filename_format
) {
2542 fmt
= info
->backing_filename_format
;
2546 g_hash_table_destroy(filenames
);
2550 qapi_free_ImageInfoList(head
);
2551 g_hash_table_destroy(filenames
);
2555 static int img_info(int argc
, char **argv
)
2558 OutputFormat output_format
= OFORMAT_HUMAN
;
2560 const char *filename
, *fmt
, *output
;
2561 ImageInfoList
*list
;
2562 bool image_opts
= false;
2563 bool force_share
= false;
2568 int option_index
= 0;
2569 static const struct option long_options
[] = {
2570 {"help", no_argument
, 0, 'h'},
2571 {"format", required_argument
, 0, 'f'},
2572 {"output", required_argument
, 0, OPTION_OUTPUT
},
2573 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2574 {"object", required_argument
, 0, OPTION_OBJECT
},
2575 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2576 {"force-share", no_argument
, 0, 'U'},
2579 c
= getopt_long(argc
, argv
, ":f:hU",
2580 long_options
, &option_index
);
2586 missing_argument(argv
[optind
- 1]);
2589 unrecognized_option(argv
[optind
- 1]);
2603 case OPTION_BACKING_CHAIN
:
2606 case OPTION_OBJECT
: {
2608 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2614 case OPTION_IMAGE_OPTS
:
2619 if (optind
!= argc
- 1) {
2620 error_exit("Expecting one image file name");
2622 filename
= argv
[optind
++];
2624 if (output
&& !strcmp(output
, "json")) {
2625 output_format
= OFORMAT_JSON
;
2626 } else if (output
&& !strcmp(output
, "human")) {
2627 output_format
= OFORMAT_HUMAN
;
2628 } else if (output
) {
2629 error_report("--output must be used with human or json as argument.");
2633 if (qemu_opts_foreach(&qemu_object_opts
,
2634 user_creatable_add_opts_foreach
,
2639 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
2645 switch (output_format
) {
2647 dump_human_image_info_list(list
);
2651 dump_json_image_info_list(list
);
2653 dump_json_image_info(list
->value
);
2658 qapi_free_ImageInfoList(list
);
2662 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2665 switch (output_format
) {
2667 if (e
->data
&& !e
->has_offset
) {
2668 error_report("File contains external, encrypted or compressed clusters.");
2671 if (e
->data
&& !e
->zero
) {
2672 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2673 e
->start
, e
->length
,
2674 e
->has_offset
? e
->offset
: 0,
2675 e
->has_filename
? e
->filename
: "");
2677 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2678 * Modify the flags here to allow more coalescing.
2680 if (next
&& (!next
->data
|| next
->zero
)) {
2686 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2687 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2688 (e
->start
== 0 ? "[" : ",\n"),
2689 e
->start
, e
->length
, e
->depth
,
2690 e
->zero
? "true" : "false",
2691 e
->data
? "true" : "false");
2692 if (e
->has_offset
) {
2693 printf(", \"offset\": %"PRId64
"", e
->offset
);
2704 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2705 int nb_sectors
, MapEntry
*e
)
2709 BlockDriverState
*file
;
2712 /* As an optimization, we could cache the current range of unallocated
2713 * clusters in each file of the chain, and avoid querying the same
2719 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2725 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2728 bs
= backing_bs(bs
);
2737 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2740 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2741 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2742 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2743 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2744 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2745 .has_offset
= has_offset
,
2747 .has_filename
= file
&& has_offset
,
2748 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2754 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2756 if (curr
->length
== 0) {
2759 if (curr
->zero
!= next
->zero
||
2760 curr
->data
!= next
->data
||
2761 curr
->depth
!= next
->depth
||
2762 curr
->has_filename
!= next
->has_filename
||
2763 curr
->has_offset
!= next
->has_offset
) {
2766 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2769 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2775 static int img_map(int argc
, char **argv
)
2778 OutputFormat output_format
= OFORMAT_HUMAN
;
2780 BlockDriverState
*bs
;
2781 const char *filename
, *fmt
, *output
;
2783 MapEntry curr
= { .length
= 0 }, next
;
2785 bool image_opts
= false;
2786 bool force_share
= false;
2791 int option_index
= 0;
2792 static const struct option long_options
[] = {
2793 {"help", no_argument
, 0, 'h'},
2794 {"format", required_argument
, 0, 'f'},
2795 {"output", required_argument
, 0, OPTION_OUTPUT
},
2796 {"object", required_argument
, 0, OPTION_OBJECT
},
2797 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2798 {"force-share", no_argument
, 0, 'U'},
2801 c
= getopt_long(argc
, argv
, ":f:hU",
2802 long_options
, &option_index
);
2808 missing_argument(argv
[optind
- 1]);
2811 unrecognized_option(argv
[optind
- 1]);
2825 case OPTION_OBJECT
: {
2827 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2833 case OPTION_IMAGE_OPTS
:
2838 if (optind
!= argc
- 1) {
2839 error_exit("Expecting one image file name");
2841 filename
= argv
[optind
];
2843 if (output
&& !strcmp(output
, "json")) {
2844 output_format
= OFORMAT_JSON
;
2845 } else if (output
&& !strcmp(output
, "human")) {
2846 output_format
= OFORMAT_HUMAN
;
2847 } else if (output
) {
2848 error_report("--output must be used with human or json as argument.");
2852 if (qemu_opts_foreach(&qemu_object_opts
,
2853 user_creatable_add_opts_foreach
,
2858 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
2864 if (output_format
== OFORMAT_HUMAN
) {
2865 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2868 length
= blk_getlength(blk
);
2869 while (curr
.start
+ curr
.length
< length
) {
2870 int64_t nsectors_left
;
2874 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2876 /* Probe up to 1 GiB at a time. */
2877 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2878 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2879 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2882 error_report("Could not read file metadata: %s", strerror(-ret
));
2886 if (entry_mergeable(&curr
, &next
)) {
2887 curr
.length
+= next
.length
;
2891 if (curr
.length
> 0) {
2892 dump_map_entry(output_format
, &curr
, &next
);
2897 dump_map_entry(output_format
, &curr
, NULL
);
2904 #define SNAPSHOT_LIST 1
2905 #define SNAPSHOT_CREATE 2
2906 #define SNAPSHOT_APPLY 3
2907 #define SNAPSHOT_DELETE 4
2909 static int img_snapshot(int argc
, char **argv
)
2912 BlockDriverState
*bs
;
2913 QEMUSnapshotInfo sn
;
2914 char *filename
, *snapshot_name
= NULL
;
2915 int c
, ret
= 0, bdrv_oflags
;
2920 bool image_opts
= false;
2921 bool force_share
= false;
2923 bdrv_oflags
= BDRV_O_RDWR
;
2924 /* Parse commandline parameters */
2926 static const struct option long_options
[] = {
2927 {"help", no_argument
, 0, 'h'},
2928 {"object", required_argument
, 0, OPTION_OBJECT
},
2929 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2930 {"force-share", no_argument
, 0, 'U'},
2933 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
2934 long_options
, NULL
);
2940 missing_argument(argv
[optind
- 1]);
2943 unrecognized_option(argv
[optind
- 1]);
2950 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2953 action
= SNAPSHOT_LIST
;
2954 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2958 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2961 action
= SNAPSHOT_APPLY
;
2962 snapshot_name
= optarg
;
2966 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2969 action
= SNAPSHOT_CREATE
;
2970 snapshot_name
= optarg
;
2974 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2977 action
= SNAPSHOT_DELETE
;
2978 snapshot_name
= optarg
;
2986 case OPTION_OBJECT
: {
2988 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2994 case OPTION_IMAGE_OPTS
:
3000 if (optind
!= argc
- 1) {
3001 error_exit("Expecting one image file name");
3003 filename
= argv
[optind
++];
3005 if (qemu_opts_foreach(&qemu_object_opts
,
3006 user_creatable_add_opts_foreach
,
3011 /* Open the image */
3012 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
3019 /* Perform the requested action */
3025 case SNAPSHOT_CREATE
:
3026 memset(&sn
, 0, sizeof(sn
));
3027 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
3029 qemu_gettimeofday(&tv
);
3030 sn
.date_sec
= tv
.tv_sec
;
3031 sn
.date_nsec
= tv
.tv_usec
* 1000;
3033 ret
= bdrv_snapshot_create(bs
, &sn
);
3035 error_report("Could not create snapshot '%s': %d (%s)",
3036 snapshot_name
, ret
, strerror(-ret
));
3040 case SNAPSHOT_APPLY
:
3041 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
3043 error_report("Could not apply snapshot '%s': %d (%s)",
3044 snapshot_name
, ret
, strerror(-ret
));
3048 case SNAPSHOT_DELETE
:
3049 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
3051 error_reportf_err(err
, "Could not delete snapshot '%s': ",
3066 static int img_rebase(int argc
, char **argv
)
3068 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3069 uint8_t *buf_old
= NULL
;
3070 uint8_t *buf_new
= NULL
;
3071 BlockDriverState
*bs
= NULL
;
3073 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3074 int c
, flags
, src_flags
, ret
;
3075 bool writethrough
, src_writethrough
;
3077 bool force_share
= false;
3080 Error
*local_err
= NULL
;
3081 bool image_opts
= false;
3083 /* Parse commandline parameters */
3085 cache
= BDRV_DEFAULT_CACHE
;
3086 src_cache
= BDRV_DEFAULT_CACHE
;
3090 static const struct option long_options
[] = {
3091 {"help", no_argument
, 0, 'h'},
3092 {"object", required_argument
, 0, OPTION_OBJECT
},
3093 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3094 {"force-share", no_argument
, 0, 'U'},
3097 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3098 long_options
, NULL
);
3104 missing_argument(argv
[optind
- 1]);
3107 unrecognized_option(argv
[optind
- 1]);
3116 out_basefmt
= optarg
;
3119 out_baseimg
= optarg
;
3136 case OPTION_OBJECT
: {
3138 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3144 case OPTION_IMAGE_OPTS
:
3157 if (optind
!= argc
- 1) {
3158 error_exit("Expecting one image file name");
3160 if (!unsafe
&& !out_baseimg
) {
3161 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3163 filename
= argv
[optind
++];
3165 if (qemu_opts_foreach(&qemu_object_opts
,
3166 user_creatable_add_opts_foreach
,
3171 qemu_progress_init(progress
, 2.0);
3172 qemu_progress_print(0, 100);
3174 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3175 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3177 error_report("Invalid cache option: %s", cache
);
3182 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3184 error_report("Invalid source cache option: %s", src_cache
);
3188 /* The source files are opened read-only, don't care about WCE */
3189 assert((src_flags
& BDRV_O_RDWR
) == 0);
3190 (void) src_writethrough
;
3195 * Ignore the old backing file for unsafe rebase in case we want to correct
3196 * the reference to a renamed or moved backing file.
3198 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3206 if (out_basefmt
!= NULL
) {
3207 if (bdrv_find_format(out_basefmt
) == NULL
) {
3208 error_report("Invalid format name: '%s'", out_basefmt
);
3214 /* For safe rebasing we need to compare old and new backing file */
3216 char backing_name
[PATH_MAX
];
3217 QDict
*options
= NULL
;
3219 if (bs
->backing_format
[0] != '\0') {
3220 options
= qdict_new();
3221 qdict_put_str(options
, "driver", bs
->backing_format
);
3226 options
= qdict_new();
3228 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3230 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3231 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3232 options
, src_flags
, &local_err
);
3233 if (!blk_old_backing
) {
3234 error_reportf_err(local_err
,
3235 "Could not open old backing file '%s': ",
3241 if (out_baseimg
[0]) {
3242 options
= qdict_new();
3244 qdict_put_str(options
, "driver", out_basefmt
);
3247 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3250 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
3251 options
, src_flags
, &local_err
);
3252 if (!blk_new_backing
) {
3253 error_reportf_err(local_err
,
3254 "Could not open new backing file '%s': ",
3263 * Check each unallocated cluster in the COW file. If it is unallocated,
3264 * accesses go to the backing file. We must therefore compare this cluster
3265 * in the old and new backing file, and if they differ we need to copy it
3266 * from the old backing file into the COW file.
3268 * If qemu-img crashes during this step, no harm is done. The content of
3269 * the image is the same as the original one at any time.
3272 int64_t num_sectors
;
3273 int64_t old_backing_num_sectors
;
3274 int64_t new_backing_num_sectors
= 0;
3277 float local_progress
= 0;
3279 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3280 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3282 num_sectors
= blk_nb_sectors(blk
);
3283 if (num_sectors
< 0) {
3284 error_report("Could not get size of '%s': %s",
3285 filename
, strerror(-num_sectors
));
3289 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3290 if (old_backing_num_sectors
< 0) {
3291 char backing_name
[PATH_MAX
];
3293 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3294 error_report("Could not get size of '%s': %s",
3295 backing_name
, strerror(-old_backing_num_sectors
));
3299 if (blk_new_backing
) {
3300 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3301 if (new_backing_num_sectors
< 0) {
3302 error_report("Could not get size of '%s': %s",
3303 out_baseimg
, strerror(-new_backing_num_sectors
));
3309 if (num_sectors
!= 0) {
3310 local_progress
= (float)100 /
3311 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3314 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3316 /* How many sectors can we handle with the next read? */
3317 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3318 n
= (IO_BUF_SIZE
/ 512);
3320 n
= num_sectors
- sector
;
3323 /* If the cluster is allocated, we don't need to take action */
3324 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3326 error_report("error while reading image metadata: %s",
3335 * Read old and new backing file and take into consideration that
3336 * backing files may be smaller than the COW image.
3338 if (sector
>= old_backing_num_sectors
) {
3339 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3341 if (sector
+ n
> old_backing_num_sectors
) {
3342 n
= old_backing_num_sectors
- sector
;
3345 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3346 buf_old
, n
<< BDRV_SECTOR_BITS
);
3348 error_report("error while reading from old backing file");
3353 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3354 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3356 if (sector
+ n
> new_backing_num_sectors
) {
3357 n
= new_backing_num_sectors
- sector
;
3360 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3361 buf_new
, n
<< BDRV_SECTOR_BITS
);
3363 error_report("error while reading from new backing file");
3368 /* If they differ, we need to write to the COW file */
3369 uint64_t written
= 0;
3371 while (written
< n
) {
3374 if (compare_sectors(buf_old
+ written
* 512,
3375 buf_new
+ written
* 512, n
- written
, &pnum
))
3377 ret
= blk_pwrite(blk
,
3378 (sector
+ written
) << BDRV_SECTOR_BITS
,
3379 buf_old
+ written
* 512,
3380 pnum
<< BDRV_SECTOR_BITS
, 0);
3382 error_report("Error while writing to COW image: %s",
3390 qemu_progress_print(local_progress
, 100);
3395 * Change the backing file. All clusters that are different from the old
3396 * backing file are overwritten in the COW file now, so the visible content
3397 * doesn't change when we switch the backing file.
3399 if (out_baseimg
&& *out_baseimg
) {
3400 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3402 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3405 if (ret
== -ENOSPC
) {
3406 error_report("Could not change the backing file to '%s': No "
3407 "space left in the file header", out_baseimg
);
3408 } else if (ret
< 0) {
3409 error_report("Could not change the backing file to '%s': %s",
3410 out_baseimg
, strerror(-ret
));
3413 qemu_progress_print(100, 0);
3415 * TODO At this point it is possible to check if any clusters that are
3416 * allocated in the COW file are the same in the backing file. If so, they
3417 * could be dropped from the COW file. Don't do this before switching the
3418 * backing file, in case of a crash this would lead to corruption.
3421 qemu_progress_end();
3424 blk_unref(blk_old_backing
);
3425 blk_unref(blk_new_backing
);
3427 qemu_vfree(buf_old
);
3428 qemu_vfree(buf_new
);
3437 static int img_resize(int argc
, char **argv
)
3440 int c
, ret
, relative
;
3441 const char *filename
, *fmt
, *size
;
3442 int64_t n
, total_size
;
3444 BlockBackend
*blk
= NULL
;
3447 static QemuOptsList resize_options
= {
3448 .name
= "resize_options",
3449 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3452 .name
= BLOCK_OPT_SIZE
,
3453 .type
= QEMU_OPT_SIZE
,
3454 .help
= "Virtual disk size"
3460 bool image_opts
= false;
3462 /* Remove size from argv manually so that negative numbers are not treated
3463 * as options by getopt. */
3465 error_exit("Not enough arguments");
3469 size
= argv
[--argc
];
3471 /* Parse getopt arguments */
3474 static const struct option long_options
[] = {
3475 {"help", no_argument
, 0, 'h'},
3476 {"object", required_argument
, 0, OPTION_OBJECT
},
3477 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3480 c
= getopt_long(argc
, argv
, ":f:hq",
3481 long_options
, NULL
);
3487 missing_argument(argv
[optind
- 1]);
3490 unrecognized_option(argv
[optind
- 1]);
3501 case OPTION_OBJECT
: {
3503 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3509 case OPTION_IMAGE_OPTS
:
3514 if (optind
!= argc
- 1) {
3515 error_exit("Expecting one image file name");
3517 filename
= argv
[optind
++];
3519 if (qemu_opts_foreach(&qemu_object_opts
,
3520 user_creatable_add_opts_foreach
,
3525 /* Choose grow, shrink, or absolute resize mode */
3541 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3542 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3544 error_report_err(err
);
3546 qemu_opts_del(param
);
3549 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3550 qemu_opts_del(param
);
3552 blk
= img_open(image_opts
, filename
, fmt
,
3553 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
3561 total_size
= blk_getlength(blk
) + n
* relative
;
3565 if (total_size
<= 0) {
3566 error_report("New image size must be positive");
3571 ret
= blk_truncate(blk
, total_size
, &err
);
3573 qprintf(quiet
, "Image resized.\n");
3575 error_report_err(err
);
3585 static void amend_status_cb(BlockDriverState
*bs
,
3586 int64_t offset
, int64_t total_work_size
,
3589 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3592 static int img_amend(int argc
, char **argv
)
3596 char *options
= NULL
;
3597 QemuOptsList
*create_opts
= NULL
;
3598 QemuOpts
*opts
= NULL
;
3599 const char *fmt
= NULL
, *filename
, *cache
;
3602 bool quiet
= false, progress
= false;
3603 BlockBackend
*blk
= NULL
;
3604 BlockDriverState
*bs
= NULL
;
3605 bool image_opts
= false;
3607 cache
= BDRV_DEFAULT_CACHE
;
3609 static const struct option long_options
[] = {
3610 {"help", no_argument
, 0, 'h'},
3611 {"object", required_argument
, 0, OPTION_OBJECT
},
3612 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3615 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
3616 long_options
, NULL
);
3623 missing_argument(argv
[optind
- 1]);
3626 unrecognized_option(argv
[optind
- 1]);
3632 if (!is_valid_option_list(optarg
)) {
3633 error_report("Invalid option list: %s", optarg
);
3635 goto out_no_progress
;
3638 options
= g_strdup(optarg
);
3640 char *old_options
= options
;
3641 options
= g_strdup_printf("%s,%s", options
, optarg
);
3642 g_free(old_options
);
3658 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3662 goto out_no_progress
;
3665 case OPTION_IMAGE_OPTS
:
3672 error_exit("Must specify options (-o)");
3675 if (qemu_opts_foreach(&qemu_object_opts
,
3676 user_creatable_add_opts_foreach
,
3679 goto out_no_progress
;
3685 qemu_progress_init(progress
, 1.0);
3687 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3688 if (fmt
&& has_help_option(options
)) {
3689 /* If a format is explicitly specified (and possibly no filename is
3690 * given), print option help here */
3691 ret
= print_block_option_help(filename
, fmt
);
3695 if (optind
!= argc
- 1) {
3696 error_report("Expecting one image file name");
3701 flags
= BDRV_O_RDWR
;
3702 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3704 error_report("Invalid cache option: %s", cache
);
3708 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3716 fmt
= bs
->drv
->format_name
;
3718 if (has_help_option(options
)) {
3719 /* If the format was auto-detected, print option help here */
3720 ret
= print_block_option_help(filename
, fmt
);
3724 if (!bs
->drv
->create_opts
) {
3725 error_report("Format driver '%s' does not support any options to amend",
3731 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3732 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3733 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3735 error_report_err(err
);
3740 /* In case the driver does not call amend_status_cb() */
3741 qemu_progress_print(0.f
, 0);
3742 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3743 qemu_progress_print(100.f
, 0);
3745 error_report("Error while amending options: %s", strerror(-ret
));
3750 qemu_progress_end();
3754 qemu_opts_del(opts
);
3755 qemu_opts_free(create_opts
);
3764 typedef struct BenchData
{
3766 uint64_t image_size
;
3773 bool drain_on_flush
;
3782 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3785 error_report("Failed flush request: %s", strerror(-ret
));
3790 static void bench_cb(void *opaque
, int ret
)
3792 BenchData
*b
= opaque
;
3796 error_report("Failed request: %s", strerror(-ret
));
3801 /* Just finished a flush with drained queue: Start next requests */
3802 assert(b
->in_flight
== 0);
3803 b
->in_flush
= false;
3804 } else if (b
->in_flight
> 0) {
3805 int remaining
= b
->n
- b
->in_flight
;
3810 /* Time for flush? Drain queue if requested, then flush */
3811 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3812 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3813 BlockCompletionFunc
*cb
;
3815 if (b
->drain_on_flush
) {
3819 cb
= bench_undrained_flush_cb
;
3822 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3824 error_report("Failed to issue flush request");
3828 if (b
->drain_on_flush
) {
3834 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3835 int64_t offset
= b
->offset
;
3836 /* blk_aio_* might look for completed I/Os and kick bench_cb
3837 * again, so make sure this operation is counted by in_flight
3838 * and b->offset is ready for the next submission.
3841 b
->offset
+= b
->step
;
3842 b
->offset
%= b
->image_size
;
3844 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3846 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3849 error_report("Failed to issue request");
3855 static int img_bench(int argc
, char **argv
)
3858 const char *fmt
= NULL
, *filename
;
3860 bool image_opts
= false;
3861 bool is_write
= false;
3865 size_t bufsize
= 4096;
3868 int flush_interval
= 0;
3869 bool drain_on_flush
= true;
3871 BlockBackend
*blk
= NULL
;
3872 BenchData data
= {};
3874 bool writethrough
= false;
3875 struct timeval t1
, t2
;
3877 bool force_share
= false;
3880 static const struct option long_options
[] = {
3881 {"help", no_argument
, 0, 'h'},
3882 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3883 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3884 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3885 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3886 {"force-share", no_argument
, 0, 'U'},
3889 c
= getopt_long(argc
, argv
, ":hc:d:f:no:qs:S:t:wU", long_options
, NULL
);
3896 missing_argument(argv
[optind
- 1]);
3899 unrecognized_option(argv
[optind
- 1]);
3908 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3909 error_report("Invalid request count specified");
3919 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3920 error_report("Invalid queue depth specified");
3930 flags
|= BDRV_O_NATIVE_AIO
;
3934 offset
= cvtnum(optarg
);
3936 error_report("Invalid offset specified");
3949 sval
= cvtnum(optarg
);
3950 if (sval
< 0 || sval
> INT_MAX
) {
3951 error_report("Invalid buffer size specified");
3962 sval
= cvtnum(optarg
);
3963 if (sval
< 0 || sval
> INT_MAX
) {
3964 error_report("Invalid step size specified");
3972 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3974 error_report("Invalid cache mode");
3980 flags
|= BDRV_O_RDWR
;
3986 case OPTION_PATTERN
:
3990 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
3991 error_report("Invalid pattern byte specified");
3997 case OPTION_FLUSH_INTERVAL
:
4001 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
4002 error_report("Invalid flush interval specified");
4005 flush_interval
= res
;
4008 case OPTION_NO_DRAIN
:
4009 drain_on_flush
= false;
4011 case OPTION_IMAGE_OPTS
:
4017 if (optind
!= argc
- 1) {
4018 error_exit("Expecting one image file name");
4020 filename
= argv
[argc
- 1];
4022 if (!is_write
&& flush_interval
) {
4023 error_report("--flush-interval is only available in write tests");
4027 if (flush_interval
&& flush_interval
< depth
) {
4028 error_report("Flush interval can't be smaller than depth");
4033 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
4040 image_size
= blk_getlength(blk
);
4041 if (image_size
< 0) {
4046 data
= (BenchData
) {
4048 .image_size
= image_size
,
4050 .step
= step
?: bufsize
,
4055 .flush_interval
= flush_interval
,
4056 .drain_on_flush
= drain_on_flush
,
4058 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4059 "(starting at offset %" PRId64
", step size %d)\n",
4060 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
4061 data
.offset
, data
.step
);
4062 if (flush_interval
) {
4063 printf("Sending flush every %d requests\n", flush_interval
);
4066 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
4067 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4069 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4070 for (i
= 0; i
< data
.nrreq
; i
++) {
4071 qemu_iovec_init(&data
.qiov
[i
], 1);
4072 qemu_iovec_add(&data
.qiov
[i
],
4073 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4076 gettimeofday(&t1
, NULL
);
4079 while (data
.n
> 0) {
4080 main_loop_wait(false);
4082 gettimeofday(&t2
, NULL
);
4084 printf("Run completed in %3.3f seconds.\n",
4085 (t2
.tv_sec
- t1
.tv_sec
)
4086 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4089 qemu_vfree(data
.buf
);
4110 int bsz
; /* Block size */
4118 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4122 static int img_dd_bs(const char *arg
,
4123 struct DdIo
*in
, struct DdIo
*out
,
4130 if (res
<= 0 || res
> INT_MAX
) {
4131 error_report("invalid number: '%s'", arg
);
4134 in
->bsz
= out
->bsz
= res
;
4139 static int img_dd_count(const char *arg
,
4140 struct DdIo
*in
, struct DdIo
*out
,
4143 dd
->count
= cvtnum(arg
);
4145 if (dd
->count
< 0) {
4146 error_report("invalid number: '%s'", arg
);
4153 static int img_dd_if(const char *arg
,
4154 struct DdIo
*in
, struct DdIo
*out
,
4157 in
->filename
= g_strdup(arg
);
4162 static int img_dd_of(const char *arg
,
4163 struct DdIo
*in
, struct DdIo
*out
,
4166 out
->filename
= g_strdup(arg
);
4171 static int img_dd_skip(const char *arg
,
4172 struct DdIo
*in
, struct DdIo
*out
,
4175 in
->offset
= cvtnum(arg
);
4177 if (in
->offset
< 0) {
4178 error_report("invalid number: '%s'", arg
);
4185 static int img_dd(int argc
, char **argv
)
4190 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4191 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4192 QemuOpts
*opts
= NULL
;
4193 QemuOptsList
*create_opts
= NULL
;
4194 Error
*local_err
= NULL
;
4195 bool image_opts
= false;
4197 const char *out_fmt
= "raw";
4198 const char *fmt
= NULL
;
4200 int64_t block_count
= 0, out_pos
, in_pos
;
4201 bool force_share
= false;
4202 struct DdInfo dd
= {
4207 .bsz
= 512, /* Block size is by default 512 bytes */
4219 const struct DdOpts options
[] = {
4220 { "bs", img_dd_bs
, C_BS
},
4221 { "count", img_dd_count
, C_COUNT
},
4222 { "if", img_dd_if
, C_IF
},
4223 { "of", img_dd_of
, C_OF
},
4224 { "skip", img_dd_skip
, C_SKIP
},
4227 const struct option long_options
[] = {
4228 { "help", no_argument
, 0, 'h'},
4229 { "object", required_argument
, 0, OPTION_OBJECT
},
4230 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4231 { "force-share", no_argument
, 0, 'U'},
4235 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
4247 missing_argument(argv
[optind
- 1]);
4250 unrecognized_option(argv
[optind
- 1]);
4259 if (!qemu_opts_parse_noisily(&qemu_object_opts
, optarg
, true)) {
4264 case OPTION_IMAGE_OPTS
:
4270 for (i
= optind
; i
< argc
; i
++) {
4272 arg
= g_strdup(argv
[i
]);
4274 tmp
= strchr(arg
, '=');
4276 error_report("unrecognized operand %s", arg
);
4283 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4284 if (!strcmp(arg
, options
[j
].name
)) {
4288 if (options
[j
].name
== NULL
) {
4289 error_report("unrecognized operand %s", arg
);
4294 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4298 dd
.flags
|= options
[j
].flag
;
4303 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4304 error_report("Must specify both input and output files");
4309 if (qemu_opts_foreach(&qemu_object_opts
,
4310 user_creatable_add_opts_foreach
,
4316 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
4324 drv
= bdrv_find_format(out_fmt
);
4326 error_report("Unknown file format");
4330 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4333 error_report_err(local_err
);
4337 if (!drv
->create_opts
) {
4338 error_report("Format driver '%s' does not support image creation",
4343 if (!proto_drv
->create_opts
) {
4344 error_report("Protocol driver '%s' does not support image creation",
4345 proto_drv
->format_name
);
4349 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4350 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4352 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4354 size
= blk_getlength(blk1
);
4356 error_report("Failed to get size for '%s'", in
.filename
);
4361 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4362 dd
.count
* in
.bsz
< size
) {
4363 size
= dd
.count
* in
.bsz
;
4366 /* Overflow means the specified offset is beyond input image's size */
4367 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4368 size
< in
.bsz
* in
.offset
)) {
4369 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4371 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4372 size
- in
.bsz
* in
.offset
, &error_abort
);
4375 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4377 error_reportf_err(local_err
,
4378 "%s: error while creating output image: ",
4384 /* TODO, we can't honour --image-opts for the target,
4385 * since it needs to be given in a format compatible
4386 * with the bdrv_create() call above which does not
4387 * support image-opts style.
4389 blk2
= img_open_file(out
.filename
, NULL
, out_fmt
, BDRV_O_RDWR
,
4390 false, false, false);
4397 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4398 size
< in
.offset
* in
.bsz
)) {
4399 /* We give a warning if the skip option is bigger than the input
4400 * size and create an empty output disk image (i.e. like dd(1)).
4402 error_report("%s: cannot skip to specified offset", in
.filename
);
4405 in_pos
= in
.offset
* in
.bsz
;
4408 in
.buf
= g_new(uint8_t, in
.bsz
);
4410 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4411 int in_ret
, out_ret
;
4413 if (in_pos
+ in
.bsz
> size
) {
4414 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4416 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4419 error_report("error while reading from input image file: %s",
4426 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4429 error_report("error while writing to output image file: %s",
4430 strerror(-out_ret
));
4439 qemu_opts_del(opts
);
4440 qemu_opts_free(create_opts
);
4443 g_free(in
.filename
);
4444 g_free(out
.filename
);
4455 static const img_cmd_t img_cmds
[] = {
4456 #define DEF(option, callback, arg_string) \
4457 { option, callback },
4458 #include "qemu-img-cmds.h"
4464 int main(int argc
, char **argv
)
4466 const img_cmd_t
*cmd
;
4467 const char *cmdname
;
4468 Error
*local_error
= NULL
;
4469 char *trace_file
= NULL
;
4471 static const struct option long_options
[] = {
4472 {"help", no_argument
, 0, 'h'},
4473 {"version", no_argument
, 0, 'V'},
4474 {"trace", required_argument
, NULL
, 'T'},
4479 signal(SIGPIPE
, SIG_IGN
);
4482 module_call_init(MODULE_INIT_TRACE
);
4483 error_set_progname(argv
[0]);
4484 qemu_init_exec_dir(argv
[0]);
4486 if (qemu_init_main_loop(&local_error
)) {
4487 error_report_err(local_error
);
4491 qcrypto_init(&error_fatal
);
4493 module_call_init(MODULE_INIT_QOM
);
4496 error_exit("Not enough arguments");
4499 qemu_add_opts(&qemu_object_opts
);
4500 qemu_add_opts(&qemu_source_opts
);
4501 qemu_add_opts(&qemu_trace_opts
);
4503 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
4506 missing_argument(argv
[optind
- 1]);
4509 unrecognized_option(argv
[optind
- 1]);
4515 printf(QEMU_IMG_VERSION
);
4519 trace_file
= trace_opt_parse(optarg
);
4524 cmdname
= argv
[optind
];
4526 /* reset getopt_long scanning */
4534 if (!trace_init_backends()) {
4537 trace_init_file(trace_file
);
4538 qemu_set_log(LOG_TRACE
);
4540 /* find the command */
4541 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4542 if (!strcmp(cmdname
, cmd
->name
)) {
4543 return cmd
->handler(argc
, argv
);
4548 error_exit("Command not found: %s", cmdname
);