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,
65 typedef enum OutputFormat
{
70 /* Default to cache=writeback as data integrity is not important for qemu-img */
71 #define BDRV_DEFAULT_CACHE "writeback"
73 static void format_print(void *opaque
, const char *name
)
78 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
82 error_printf("qemu-img: ");
85 error_vprintf(fmt
, ap
);
88 error_printf("\nTry 'qemu-img --help' for more information\n");
92 static void QEMU_NORETURN
missing_argument(const char *option
)
94 error_exit("missing argument for option '%s'", option
);
97 static void QEMU_NORETURN
unrecognized_option(const char *option
)
99 error_exit("unrecognized option '%s'", option
);
102 /* Please keep in synch with qemu-img.texi */
103 static void QEMU_NORETURN
help(void)
105 const char *help_msg
=
107 "usage: qemu-img [standard options] command [command options]\n"
108 "QEMU disk image utility\n"
110 " '-h', '--help' display this help and exit\n"
111 " '-V', '--version' output version information and exit\n"
112 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
113 " specify tracing options\n"
116 #define DEF(option, callback, arg_string) \
118 #include "qemu-img-cmds.h"
122 "Command parameters:\n"
123 " 'filename' is a disk image filename\n"
124 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
125 " manual page for a description of the object properties. The most common\n"
126 " object type is a 'secret', which is used to supply passwords and/or\n"
127 " encryption keys.\n"
128 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
129 " 'cache' is the cache mode used to write the output disk image, the valid\n"
130 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
131 " 'directsync' and 'unsafe' (default for convert)\n"
132 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
133 " options are the same as for the 'cache' option\n"
134 " 'size' is the disk image size in bytes. Optional suffixes\n"
135 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
136 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
137 " supported. 'b' is ignored.\n"
138 " 'output_filename' is the destination disk image filename\n"
139 " 'output_fmt' is the destination format\n"
140 " 'options' is a comma separated list of format specific options in a\n"
141 " name=value format. Use -o ? for an overview of the options supported by the\n"
143 " 'snapshot_param' is param used for internal snapshot, format\n"
144 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
146 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
148 " '-c' indicates that target image must be compressed (qcow format only)\n"
149 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
150 " match exactly. The image doesn't need a working backing file before\n"
151 " rebasing in this case (useful for renaming the backing file)\n"
152 " '-h' with or without a command shows this help and lists the supported formats\n"
153 " '-p' show progress of command (only certain commands)\n"
154 " '-q' use Quiet mode - do not print any output (except errors)\n"
155 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
156 " contain only zeros for qemu-img to create a sparse image during\n"
157 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
158 " unallocated or zero sectors, and the destination image will always be\n"
160 " '--output' takes the format in which the output must be done (human or json)\n"
161 " '-n' skips the target volume creation (useful if the volume is created\n"
162 " prior to running qemu-img)\n"
164 "Parameters to check subcommand:\n"
165 " '-r' tries to repair any inconsistencies that are found during the check.\n"
166 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
167 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
168 " hiding corruption that has already occurred.\n"
170 "Parameters to convert subcommand:\n"
171 " '-m' specifies how many coroutines work in parallel during the convert\n"
172 " process (defaults to 8)\n"
173 " '-W' allow to write to the target out of order rather than sequential\n"
175 "Parameters to snapshot subcommand:\n"
176 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
177 " '-a' applies a snapshot (revert disk to saved state)\n"
178 " '-c' creates a snapshot\n"
179 " '-d' deletes a snapshot\n"
180 " '-l' lists all snapshots in the given image\n"
182 "Parameters to compare subcommand:\n"
183 " '-f' first image format\n"
184 " '-F' second image format\n"
185 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
187 "Parameters to dd subcommand:\n"
188 " 'bs=BYTES' read and write up to BYTES bytes at a time "
190 " 'count=N' copy only N input blocks\n"
191 " 'if=FILE' read from FILE\n"
192 " 'of=FILE' write to FILE\n"
193 " 'skip=N' skip N bs-sized blocks at the start of input\n";
195 printf("%s\nSupported formats:", help_msg
);
196 bdrv_iterate_format(format_print
, NULL
);
201 static QemuOptsList qemu_object_opts
= {
203 .implied_opt_name
= "qom-type",
204 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
210 static QemuOptsList qemu_source_opts
= {
212 .implied_opt_name
= "file",
213 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
219 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
225 ret
= vprintf(fmt
, args
);
232 static int print_block_option_help(const char *filename
, const char *fmt
)
234 BlockDriver
*drv
, *proto_drv
;
235 QemuOptsList
*create_opts
= NULL
;
236 Error
*local_err
= NULL
;
238 /* Find driver and parse its options */
239 drv
= bdrv_find_format(fmt
);
241 error_report("Unknown file format '%s'", fmt
);
245 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
247 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
249 error_report_err(local_err
);
250 qemu_opts_free(create_opts
);
253 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
256 qemu_opts_print_help(create_opts
);
257 qemu_opts_free(create_opts
);
262 static int img_open_password(BlockBackend
*blk
, const char *filename
,
263 int flags
, bool quiet
)
265 BlockDriverState
*bs
;
269 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
270 !(flags
& BDRV_O_NO_IO
)) {
271 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
272 if (qemu_read_password(password
, sizeof(password
)) < 0) {
273 error_report("No password given");
276 if (bdrv_set_key(bs
, password
) < 0) {
277 error_report("invalid password");
285 static BlockBackend
*img_open_opts(const char *optstr
,
286 QemuOpts
*opts
, int flags
, bool writethrough
,
287 bool quiet
, bool force_share
)
290 Error
*local_err
= NULL
;
292 options
= qemu_opts_to_qdict(opts
, NULL
);
294 if (qdict_haskey(options
, BDRV_OPT_FORCE_SHARE
)
295 && !qdict_get_bool(options
, BDRV_OPT_FORCE_SHARE
)) {
296 error_report("--force-share/-U conflicts with image options");
299 qdict_put(options
, BDRV_OPT_FORCE_SHARE
, qbool_from_bool(true));
301 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
303 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
306 blk_set_enable_write_cache(blk
, !writethrough
);
308 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
315 static BlockBackend
*img_open_file(const char *filename
,
316 const char *fmt
, int flags
,
317 bool writethrough
, bool quiet
,
321 Error
*local_err
= NULL
;
322 QDict
*options
= qdict_new();
325 qdict_put_str(options
, "driver", fmt
);
329 qdict_put(options
, BDRV_OPT_FORCE_SHARE
, qbool_from_bool(true));
331 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
333 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
336 blk_set_enable_write_cache(blk
, !writethrough
);
338 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
346 static BlockBackend
*img_open(bool image_opts
,
347 const char *filename
,
348 const char *fmt
, int flags
, bool writethrough
,
349 bool quiet
, bool force_share
)
355 error_report("--image-opts and --format are mutually exclusive");
358 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
363 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
,
366 blk
= img_open_file(filename
, fmt
, flags
, writethrough
, quiet
,
373 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
374 const char *base_filename
,
375 const char *base_fmt
)
380 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
382 error_report("Backing file not supported for file format '%s'",
389 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
391 error_report("Backing file format not supported for file "
400 static int64_t cvtnum(const char *s
)
405 err
= qemu_strtosz(s
, NULL
, &value
);
409 if (value
> INT64_MAX
) {
415 static int img_create(int argc
, char **argv
)
418 uint64_t img_size
= -1;
419 const char *fmt
= "raw";
420 const char *base_fmt
= NULL
;
421 const char *filename
;
422 const char *base_filename
= NULL
;
423 char *options
= NULL
;
424 Error
*local_err
= NULL
;
428 static const struct option long_options
[] = {
429 {"help", no_argument
, 0, 'h'},
430 {"object", required_argument
, 0, OPTION_OBJECT
},
433 c
= getopt_long(argc
, argv
, ":F:b:f:he6o:q",
440 missing_argument(argv
[optind
- 1]);
443 unrecognized_option(argv
[optind
- 1]);
452 base_filename
= optarg
;
458 error_report("option -e is deprecated, please use \'-o "
459 "encryption\' instead!");
462 error_report("option -6 is deprecated, please use \'-o "
463 "compat6\' instead!");
466 if (!is_valid_option_list(optarg
)) {
467 error_report("Invalid option list: %s", optarg
);
471 options
= g_strdup(optarg
);
473 char *old_options
= options
;
474 options
= g_strdup_printf("%s,%s", options
, optarg
);
481 case OPTION_OBJECT
: {
483 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
492 /* Get the filename */
493 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
494 if (options
&& has_help_option(options
)) {
496 return print_block_option_help(filename
, fmt
);
499 if (optind
>= argc
) {
500 error_exit("Expecting image file name");
504 if (qemu_opts_foreach(&qemu_object_opts
,
505 user_creatable_add_opts_foreach
,
510 /* Get image size, if specified */
514 sval
= cvtnum(argv
[optind
++]);
516 if (sval
== -ERANGE
) {
517 error_report("Image size must be less than 8 EiB!");
519 error_report("Invalid image size specified! You may use k, M, "
520 "G, T, P or E suffixes for ");
521 error_report("kilobytes, megabytes, gigabytes, terabytes, "
522 "petabytes and exabytes.");
526 img_size
= (uint64_t)sval
;
528 if (optind
!= argc
) {
529 error_exit("Unexpected argument: %s", argv
[optind
]);
532 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
533 options
, img_size
, 0, quiet
, &local_err
);
535 error_reportf_err(local_err
, "%s: ", filename
);
547 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
551 Visitor
*v
= qobject_output_visitor_new(&obj
);
553 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
554 visit_complete(v
, &obj
);
555 str
= qobject_to_json_pretty(obj
);
557 qprintf(quiet
, "%s\n", qstring_get_str(str
));
563 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
565 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
566 qprintf(quiet
, "No errors were found on the image.\n");
568 if (check
->corruptions
) {
569 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
570 "Data may be corrupted, or further writes to the image "
577 "\n%" PRId64
" leaked clusters were found on the image.\n"
578 "This means waste of disk space, but no harm to data.\n",
582 if (check
->check_errors
) {
585 " internal errors have occurred during the check.\n",
586 check
->check_errors
);
590 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
591 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
592 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
593 check
->allocated_clusters
, check
->total_clusters
,
594 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
595 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
596 check
->compressed_clusters
* 100.0 /
597 check
->allocated_clusters
);
600 if (check
->image_end_offset
) {
602 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
606 static int collect_image_check(BlockDriverState
*bs
,
608 const char *filename
,
613 BdrvCheckResult result
;
615 ret
= bdrv_check(bs
, &result
, fix
);
620 check
->filename
= g_strdup(filename
);
621 check
->format
= g_strdup(bdrv_get_format_name(bs
));
622 check
->check_errors
= result
.check_errors
;
623 check
->corruptions
= result
.corruptions
;
624 check
->has_corruptions
= result
.corruptions
!= 0;
625 check
->leaks
= result
.leaks
;
626 check
->has_leaks
= result
.leaks
!= 0;
627 check
->corruptions_fixed
= result
.corruptions_fixed
;
628 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
629 check
->leaks_fixed
= result
.leaks_fixed
;
630 check
->has_leaks_fixed
= result
.leaks
!= 0;
631 check
->image_end_offset
= result
.image_end_offset
;
632 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
633 check
->total_clusters
= result
.bfi
.total_clusters
;
634 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
635 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
636 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
637 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
638 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
639 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
640 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
646 * Checks an image for consistency. Exit codes:
648 * 0 - Check completed, image is good
649 * 1 - Check not completed because of internal errors
650 * 2 - Check completed, image is corrupted
651 * 3 - Check completed, image has leaked clusters, but is good otherwise
652 * 63 - Checks are not supported by the image format
654 static int img_check(int argc
, char **argv
)
657 OutputFormat output_format
= OFORMAT_HUMAN
;
658 const char *filename
, *fmt
, *output
, *cache
;
660 BlockDriverState
*bs
;
662 int flags
= BDRV_O_CHECK
;
666 bool image_opts
= false;
667 bool force_share
= false;
671 cache
= BDRV_DEFAULT_CACHE
;
674 int option_index
= 0;
675 static const struct option long_options
[] = {
676 {"help", no_argument
, 0, 'h'},
677 {"format", required_argument
, 0, 'f'},
678 {"repair", required_argument
, 0, 'r'},
679 {"output", required_argument
, 0, OPTION_OUTPUT
},
680 {"object", required_argument
, 0, OPTION_OBJECT
},
681 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
682 {"force-share", no_argument
, 0, 'U'},
685 c
= getopt_long(argc
, argv
, ":hf:r:T:qU",
686 long_options
, &option_index
);
692 missing_argument(argv
[optind
- 1]);
695 unrecognized_option(argv
[optind
- 1]);
704 flags
|= BDRV_O_RDWR
;
706 if (!strcmp(optarg
, "leaks")) {
707 fix
= BDRV_FIX_LEAKS
;
708 } else if (!strcmp(optarg
, "all")) {
709 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
711 error_exit("Unknown option value for -r "
712 "(expecting 'leaks' or 'all'): %s", optarg
);
727 case OPTION_OBJECT
: {
729 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
735 case OPTION_IMAGE_OPTS
:
740 if (optind
!= argc
- 1) {
741 error_exit("Expecting one image file name");
743 filename
= argv
[optind
++];
745 if (output
&& !strcmp(output
, "json")) {
746 output_format
= OFORMAT_JSON
;
747 } else if (output
&& !strcmp(output
, "human")) {
748 output_format
= OFORMAT_HUMAN
;
750 error_report("--output must be used with human or json as argument.");
754 if (qemu_opts_foreach(&qemu_object_opts
,
755 user_creatable_add_opts_foreach
,
760 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
762 error_report("Invalid source cache option: %s", cache
);
766 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
773 check
= g_new0(ImageCheck
, 1);
774 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
776 if (ret
== -ENOTSUP
) {
777 error_report("This image format does not support checks");
782 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
783 int corruptions_fixed
, leaks_fixed
;
785 leaks_fixed
= check
->leaks_fixed
;
786 corruptions_fixed
= check
->corruptions_fixed
;
788 if (output_format
== OFORMAT_HUMAN
) {
790 "The following inconsistencies were found and repaired:\n\n"
791 " %" PRId64
" leaked clusters\n"
792 " %" PRId64
" corruptions\n\n"
793 "Double checking the fixed image now...\n",
795 check
->corruptions_fixed
);
798 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
800 check
->leaks_fixed
= leaks_fixed
;
801 check
->corruptions_fixed
= corruptions_fixed
;
805 switch (output_format
) {
807 dump_human_image_check(check
, quiet
);
810 dump_json_image_check(check
, quiet
);
815 if (ret
|| check
->check_errors
) {
817 error_report("Check failed: %s", strerror(-ret
));
819 error_report("Check failed");
825 if (check
->corruptions
) {
827 } else if (check
->leaks
) {
834 qapi_free_ImageCheck(check
);
839 typedef struct CommonBlockJobCBInfo
{
840 BlockDriverState
*bs
;
842 } CommonBlockJobCBInfo
;
844 static void common_block_job_cb(void *opaque
, int ret
)
846 CommonBlockJobCBInfo
*cbi
= opaque
;
849 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
853 static void run_block_job(BlockJob
*job
, Error
**errp
)
855 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
857 /* FIXME In error cases, the job simply goes away and we access a dangling
859 aio_context_acquire(aio_context
);
861 aio_poll(aio_context
, true);
862 qemu_progress_print(job
->len
?
863 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
864 } while (!job
->ready
);
866 block_job_complete_sync(job
, errp
);
867 aio_context_release(aio_context
);
869 /* A block job may finish instantaneously without publishing any progress,
870 * so just signal completion here */
871 qemu_progress_print(100.f
, 0);
874 static int img_commit(int argc
, char **argv
)
877 const char *filename
, *fmt
, *cache
, *base
;
879 BlockDriverState
*bs
, *base_bs
;
881 bool progress
= false, quiet
= false, drop
= false;
883 Error
*local_err
= NULL
;
884 CommonBlockJobCBInfo cbi
;
885 bool image_opts
= false;
886 AioContext
*aio_context
;
889 cache
= BDRV_DEFAULT_CACHE
;
892 static const struct option long_options
[] = {
893 {"help", no_argument
, 0, 'h'},
894 {"object", required_argument
, 0, OPTION_OBJECT
},
895 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
898 c
= getopt_long(argc
, argv
, ":f:ht:b:dpq",
905 missing_argument(argv
[optind
- 1]);
908 unrecognized_option(argv
[optind
- 1]);
933 case OPTION_OBJECT
: {
935 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
941 case OPTION_IMAGE_OPTS
:
947 /* Progress is not shown in Quiet mode */
952 if (optind
!= argc
- 1) {
953 error_exit("Expecting one image file name");
955 filename
= argv
[optind
++];
957 if (qemu_opts_foreach(&qemu_object_opts
,
958 user_creatable_add_opts_foreach
,
963 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
964 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
966 error_report("Invalid cache option: %s", cache
);
970 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
977 qemu_progress_init(progress
, 1.f
);
978 qemu_progress_print(0.f
, 100);
981 base_bs
= bdrv_find_backing_image(bs
, base
);
983 error_setg(&local_err
,
984 "Did not find '%s' in the backing chain of '%s'",
989 /* This is different from QMP, which by default uses the deepest file in
990 * the backing chain (i.e., the very base); however, the traditional
991 * behavior of qemu-img commit is using the immediate backing file. */
992 base_bs
= backing_bs(bs
);
994 error_setg(&local_err
, "Image does not have a backing file");
999 cbi
= (CommonBlockJobCBInfo
){
1004 aio_context
= bdrv_get_aio_context(bs
);
1005 aio_context_acquire(aio_context
);
1006 commit_active_start("commit", bs
, base_bs
, BLOCK_JOB_DEFAULT
, 0,
1007 BLOCKDEV_ON_ERROR_REPORT
, NULL
, common_block_job_cb
,
1008 &cbi
, false, &local_err
);
1009 aio_context_release(aio_context
);
1014 /* When the block job completes, the BlockBackend reference will point to
1015 * the old backing file. In order to avoid that the top image is already
1016 * deleted, so we can still empty it afterwards, increment the reference
1017 * counter here preemptively. */
1022 job
= block_job_get("commit");
1023 run_block_job(job
, &local_err
);
1028 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
1029 ret
= bs
->drv
->bdrv_make_empty(bs
);
1031 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
1043 qemu_progress_end();
1048 error_report_err(local_err
);
1052 qprintf(quiet
, "Image committed.\n");
1057 * Returns true iff the first sector pointed to by 'buf' contains at least
1060 * 'pnum' is set to the number of sectors (including and immediately following
1061 * the first one) that are known to be in the same allocated/unallocated state.
1063 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
1072 is_zero
= buffer_is_zero(buf
, 512);
1073 for(i
= 1; i
< n
; i
++) {
1075 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1084 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1085 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1086 * breaking up write requests for only small sparse areas.
1088 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1092 int num_checked
, num_used
;
1098 ret
= is_allocated_sectors(buf
, n
, pnum
);
1104 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1106 num_checked
= num_used
;
1109 ret
= is_allocated_sectors(buf
, n
, pnum
);
1111 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1113 num_checked
+= *pnum
;
1115 num_used
= num_checked
;
1116 } else if (*pnum
>= min
) {
1126 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1127 * buffers matches, non-zero otherwise.
1129 * pnum is set to the number of sectors (including and immediately following
1130 * the first one) that are known to have the same comparison result
1132 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1143 res
= !!memcmp(buf1
, buf2
, 512);
1144 for(i
= 1; i
< n
; i
++) {
1148 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1157 #define IO_BUF_SIZE (2 * 1024 * 1024)
1159 static int64_t sectors_to_bytes(int64_t sectors
)
1161 return sectors
<< BDRV_SECTOR_BITS
;
1164 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1166 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1170 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1172 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1173 * data and negative value on error.
1175 * @param blk: BlockBackend for the image
1176 * @param sect_num: Number of first sector to check
1177 * @param sect_count: Number of sectors to check
1178 * @param filename: Name of disk file we are checking (logging purpose)
1179 * @param buffer: Allocated buffer for storing read data
1180 * @param quiet: Flag for quiet mode
1182 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1183 int sect_count
, const char *filename
,
1184 uint8_t *buffer
, bool quiet
)
1187 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1188 sect_count
<< BDRV_SECTOR_BITS
);
1190 error_report("Error while reading offset %" PRId64
" of %s: %s",
1191 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1194 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1195 if (ret
|| pnum
!= sect_count
) {
1196 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1197 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1205 * Compares two images. Exit codes:
1207 * 0 - Images are identical
1209 * >1 - Error occurred
1211 static int img_compare(int argc
, char **argv
)
1213 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1214 BlockBackend
*blk1
, *blk2
;
1215 BlockDriverState
*bs1
, *bs2
;
1216 int64_t total_sectors1
, total_sectors2
;
1217 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1219 int allocated1
, allocated2
;
1220 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1221 bool progress
= false, quiet
= false, strict
= false;
1224 int64_t total_sectors
;
1225 int64_t sector_num
= 0;
1228 uint64_t progress_base
;
1229 bool image_opts
= false;
1230 bool force_share
= false;
1232 cache
= BDRV_DEFAULT_CACHE
;
1234 static const struct option long_options
[] = {
1235 {"help", no_argument
, 0, 'h'},
1236 {"object", required_argument
, 0, OPTION_OBJECT
},
1237 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1238 {"force-share", no_argument
, 0, 'U'},
1241 c
= getopt_long(argc
, argv
, ":hf:F:T:pqsU",
1242 long_options
, NULL
);
1248 missing_argument(argv
[optind
- 1]);
1251 unrecognized_option(argv
[optind
- 1]);
1277 case OPTION_OBJECT
: {
1279 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1286 case OPTION_IMAGE_OPTS
:
1292 /* Progress is not shown in Quiet mode */
1298 if (optind
!= argc
- 2) {
1299 error_exit("Expecting two image file names");
1301 filename1
= argv
[optind
++];
1302 filename2
= argv
[optind
++];
1304 if (qemu_opts_foreach(&qemu_object_opts
,
1305 user_creatable_add_opts_foreach
,
1311 /* Initialize before goto out */
1312 qemu_progress_init(progress
, 2.0);
1315 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1317 error_report("Invalid source cache option: %s", cache
);
1322 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
,
1329 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
,
1338 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1339 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1340 total_sectors1
= blk_nb_sectors(blk1
);
1341 if (total_sectors1
< 0) {
1342 error_report("Can't get size of %s: %s",
1343 filename1
, strerror(-total_sectors1
));
1347 total_sectors2
= blk_nb_sectors(blk2
);
1348 if (total_sectors2
< 0) {
1349 error_report("Can't get size of %s: %s",
1350 filename2
, strerror(-total_sectors2
));
1354 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1355 progress_base
= MAX(total_sectors1
, total_sectors2
);
1357 qemu_progress_print(0, 100);
1359 if (strict
&& total_sectors1
!= total_sectors2
) {
1361 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1366 int64_t status1
, status2
;
1367 BlockDriverState
*file
;
1369 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1370 if (nb_sectors
<= 0) {
1373 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1374 total_sectors1
- sector_num
,
1378 error_report("Sector allocation test failed for %s", filename1
);
1381 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1383 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1384 total_sectors2
- sector_num
,
1388 error_report("Sector allocation test failed for %s", filename2
);
1391 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1393 nb_sectors
= MIN(nb_sectors
, pnum1
);
1396 nb_sectors
= MIN(nb_sectors
, pnum2
);
1400 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1401 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1403 qprintf(quiet
, "Strict mode: Offset %" PRId64
1404 " block status mismatch!\n",
1405 sectors_to_bytes(sector_num
));
1409 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1410 nb_sectors
= MIN(pnum1
, pnum2
);
1411 } else if (allocated1
== allocated2
) {
1413 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1414 nb_sectors
<< BDRV_SECTOR_BITS
);
1416 error_report("Error while reading offset %" PRId64
" of %s:"
1417 " %s", sectors_to_bytes(sector_num
), filename1
,
1422 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1423 nb_sectors
<< BDRV_SECTOR_BITS
);
1425 error_report("Error while reading offset %" PRId64
1426 " of %s: %s", sectors_to_bytes(sector_num
),
1427 filename2
, strerror(-ret
));
1431 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1432 if (ret
|| pnum
!= nb_sectors
) {
1433 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1435 ret
? sector_num
: sector_num
+ pnum
));
1443 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1444 filename1
, buf1
, quiet
);
1446 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1447 filename2
, buf1
, quiet
);
1451 error_report("Error while reading offset %" PRId64
": %s",
1452 sectors_to_bytes(sector_num
), strerror(-ret
));
1458 sector_num
+= nb_sectors
;
1459 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1462 if (total_sectors1
!= total_sectors2
) {
1463 BlockBackend
*blk_over
;
1464 int64_t total_sectors_over
;
1465 const char *filename_over
;
1467 qprintf(quiet
, "Warning: Image size mismatch!\n");
1468 if (total_sectors1
> total_sectors2
) {
1469 total_sectors_over
= total_sectors1
;
1471 filename_over
= filename1
;
1473 total_sectors_over
= total_sectors2
;
1475 filename_over
= filename2
;
1479 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1480 if (nb_sectors
<= 0) {
1483 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1487 error_report("Sector allocation test failed for %s",
1494 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1495 filename_over
, buf1
, quiet
);
1498 error_report("Error while reading offset %" PRId64
1499 " of %s: %s", sectors_to_bytes(sector_num
),
1500 filename_over
, strerror(-ret
));
1506 sector_num
+= nb_sectors
;
1507 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1511 qprintf(quiet
, "Images are identical.\n");
1521 qemu_progress_end();
1526 enum ImgConvertBlockStatus
{
1532 #define MAX_COROUTINES 16
1534 typedef struct ImgConvertState
{
1536 int64_t *src_sectors
;
1538 int64_t total_sectors
;
1539 int64_t allocated_sectors
;
1540 int64_t allocated_done
;
1543 enum ImgConvertBlockStatus status
;
1544 int64_t sector_next_status
;
1545 BlockBackend
*target
;
1548 bool target_has_backing
;
1551 size_t cluster_sectors
;
1553 long num_coroutines
;
1554 int running_coroutines
;
1555 Coroutine
*co
[MAX_COROUTINES
];
1556 int64_t wait_sector_num
[MAX_COROUTINES
];
1561 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1562 int *src_cur
, int64_t *src_cur_offset
)
1565 *src_cur_offset
= 0;
1566 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1567 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1569 assert(*src_cur
< s
->src_num
);
1573 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1575 int64_t ret
, src_cur_offset
;
1578 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1580 assert(s
->total_sectors
> sector_num
);
1581 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1583 if (s
->sector_next_status
<= sector_num
) {
1584 BlockDriverState
*file
;
1585 if (s
->target_has_backing
) {
1586 ret
= bdrv_get_block_status(blk_bs(s
->src
[src_cur
]),
1587 sector_num
- src_cur_offset
,
1590 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1591 sector_num
- src_cur_offset
,
1598 if (ret
& BDRV_BLOCK_ZERO
) {
1599 s
->status
= BLK_ZERO
;
1600 } else if (ret
& BDRV_BLOCK_DATA
) {
1601 s
->status
= BLK_DATA
;
1603 s
->status
= s
->target_has_backing
? BLK_BACKING_FILE
: BLK_DATA
;
1606 s
->sector_next_status
= sector_num
+ n
;
1609 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1610 if (s
->status
== BLK_DATA
) {
1611 n
= MIN(n
, s
->buf_sectors
);
1614 /* We need to write complete clusters for compressed images, so if an
1615 * unallocated area is shorter than that, we must consider the whole
1616 * cluster allocated. */
1617 if (s
->compressed
) {
1618 if (n
< s
->cluster_sectors
) {
1619 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1620 s
->status
= BLK_DATA
;
1622 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1629 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1630 int nb_sectors
, uint8_t *buf
)
1636 assert(nb_sectors
<= s
->buf_sectors
);
1637 while (nb_sectors
> 0) {
1640 int64_t bs_sectors
, src_cur_offset
;
1642 /* In the case of compression with multiple source files, we can get a
1643 * nb_sectors that spreads into the next part. So we must be able to
1644 * read across multiple BDSes for one convert_read() call. */
1645 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1646 blk
= s
->src
[src_cur
];
1647 bs_sectors
= s
->src_sectors
[src_cur
];
1649 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1651 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1652 qemu_iovec_init_external(&qiov
, &iov
, 1);
1654 ret
= blk_co_preadv(
1655 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1656 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1663 buf
+= n
* BDRV_SECTOR_SIZE
;
1670 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1671 int nb_sectors
, uint8_t *buf
,
1672 enum ImgConvertBlockStatus status
)
1678 while (nb_sectors
> 0) {
1680 BdrvRequestFlags flags
= s
->compressed
? BDRV_REQ_WRITE_COMPRESSED
: 0;
1683 case BLK_BACKING_FILE
:
1684 /* If we have a backing file, leave clusters unallocated that are
1685 * unallocated in the source image, so that the backing file is
1686 * visible at the respective offset. */
1687 assert(s
->target_has_backing
);
1691 /* If we're told to keep the target fully allocated (-S 0) or there
1692 * is real non-zero data, we must write it. Otherwise we can treat
1693 * it as zero sectors.
1694 * Compressed clusters need to be written as a whole, so in that
1695 * case we can only save the write if the buffer is completely
1697 if (!s
->min_sparse
||
1699 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
)) ||
1701 !buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
)))
1704 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1705 qemu_iovec_init_external(&qiov
, &iov
, 1);
1707 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1708 n
<< BDRV_SECTOR_BITS
, &qiov
, flags
);
1717 if (s
->has_zero_init
) {
1718 assert(!s
->target_has_backing
);
1721 ret
= blk_co_pwrite_zeroes(s
->target
,
1722 sector_num
<< BDRV_SECTOR_BITS
,
1723 n
<< BDRV_SECTOR_BITS
, 0);
1732 buf
+= n
* BDRV_SECTOR_SIZE
;
1738 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1740 ImgConvertState
*s
= opaque
;
1741 uint8_t *buf
= NULL
;
1745 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1746 if (s
->co
[i
] == qemu_coroutine_self()) {
1753 s
->running_coroutines
++;
1754 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1759 enum ImgConvertBlockStatus status
;
1761 qemu_co_mutex_lock(&s
->lock
);
1762 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1763 qemu_co_mutex_unlock(&s
->lock
);
1766 n
= convert_iteration_sectors(s
, s
->sector_num
);
1768 qemu_co_mutex_unlock(&s
->lock
);
1772 /* save current sector and allocation status to local variables */
1773 sector_num
= s
->sector_num
;
1775 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1776 n
= MIN(n
, s
->buf_sectors
);
1778 /* increment global sector counter so that other coroutines can
1779 * already continue reading beyond this request */
1781 qemu_co_mutex_unlock(&s
->lock
);
1783 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1784 s
->allocated_done
+= n
;
1785 qemu_progress_print(100.0 * s
->allocated_done
/
1786 s
->allocated_sectors
, 0);
1789 if (status
== BLK_DATA
) {
1790 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1792 error_report("error while reading sector %" PRId64
1793 ": %s", sector_num
, strerror(-ret
));
1796 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1798 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1801 if (s
->wr_in_order
) {
1802 /* keep writes in order */
1803 while (s
->wr_offs
!= sector_num
&& s
->ret
== -EINPROGRESS
) {
1804 s
->wait_sector_num
[index
] = sector_num
;
1805 qemu_coroutine_yield();
1807 s
->wait_sector_num
[index
] = -1;
1810 if (s
->ret
== -EINPROGRESS
) {
1811 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1813 error_report("error while writing sector %" PRId64
1814 ": %s", sector_num
, strerror(-ret
));
1819 if (s
->wr_in_order
) {
1820 /* reenter the coroutine that might have waited
1821 * for this write to complete */
1822 s
->wr_offs
= sector_num
+ n
;
1823 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1824 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1826 * A -> B -> A cannot occur because A has
1827 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1828 * B will never enter A during this time window.
1830 qemu_coroutine_enter(s
->co
[i
]);
1838 s
->co
[index
] = NULL
;
1839 s
->running_coroutines
--;
1840 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1841 /* the convert job finished successfully */
1846 static int convert_do_copy(ImgConvertState
*s
)
1849 int64_t sector_num
= 0;
1851 /* Check whether we have zero initialisation or can get it efficiently */
1852 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1853 ? bdrv_has_zero_init(blk_bs(s
->target
))
1856 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1857 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1859 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1861 s
->has_zero_init
= true;
1865 /* Allocate buffer for copied data. For compressed images, only one cluster
1866 * can be copied at a time. */
1867 if (s
->compressed
) {
1868 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1869 error_report("invalid cluster size");
1872 s
->buf_sectors
= s
->cluster_sectors
;
1875 while (sector_num
< s
->total_sectors
) {
1876 n
= convert_iteration_sectors(s
, sector_num
);
1880 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1882 s
->allocated_sectors
+= n
;
1888 s
->sector_next_status
= 0;
1889 s
->ret
= -EINPROGRESS
;
1891 qemu_co_mutex_init(&s
->lock
);
1892 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1893 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1894 s
->wait_sector_num
[i
] = -1;
1895 qemu_coroutine_enter(s
->co
[i
]);
1898 while (s
->running_coroutines
) {
1899 main_loop_wait(false);
1902 if (s
->compressed
&& !s
->ret
) {
1903 /* signal EOF to align */
1904 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1913 static int img_convert(int argc
, char **argv
)
1915 int c
, bs_i
, flags
, src_flags
= 0;
1916 const char *fmt
= NULL
, *out_fmt
= "raw", *cache
= "unsafe",
1917 *src_cache
= BDRV_DEFAULT_CACHE
, *out_baseimg
= NULL
,
1918 *out_filename
, *out_baseimg_param
, *snapshot_name
= NULL
;
1919 BlockDriver
*drv
, *proto_drv
;
1920 BlockDriverInfo bdi
;
1921 BlockDriverState
*out_bs
;
1922 QemuOpts
*opts
= NULL
, *sn_opts
= NULL
;
1923 QemuOptsList
*create_opts
= NULL
;
1924 char *options
= NULL
;
1925 Error
*local_err
= NULL
;
1926 bool writethrough
, src_writethrough
, quiet
= false, image_opts
= false,
1927 skip_create
= false, progress
= false;
1928 int64_t ret
= -EINVAL
;
1929 bool force_share
= false;
1931 ImgConvertState s
= (ImgConvertState
) {
1932 /* Need at least 4k of zeros for sparse detection */
1934 .buf_sectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
,
1935 .wr_in_order
= true,
1936 .num_coroutines
= 8,
1940 static const struct option long_options
[] = {
1941 {"help", no_argument
, 0, 'h'},
1942 {"object", required_argument
, 0, OPTION_OBJECT
},
1943 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1944 {"force-share", no_argument
, 0, 'U'},
1947 c
= getopt_long(argc
, argv
, ":hf:O:B:ce6o:s:l:S:pt:T:qnm:WU",
1948 long_options
, NULL
);
1954 missing_argument(argv
[optind
- 1]);
1957 unrecognized_option(argv
[optind
- 1]);
1969 out_baseimg
= optarg
;
1972 s
.compressed
= true;
1975 error_report("option -e is deprecated, please use \'-o "
1976 "encryption\' instead!");
1979 error_report("option -6 is deprecated, please use \'-o "
1980 "compat6\' instead!");
1983 if (!is_valid_option_list(optarg
)) {
1984 error_report("Invalid option list: %s", optarg
);
1988 options
= g_strdup(optarg
);
1990 char *old_options
= options
;
1991 options
= g_strdup_printf("%s,%s", options
, optarg
);
1992 g_free(old_options
);
1996 snapshot_name
= optarg
;
1999 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
2000 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
2003 error_report("Failed in parsing snapshot param '%s'",
2008 snapshot_name
= optarg
;
2015 sval
= cvtnum(optarg
);
2017 error_report("Invalid minimum zero buffer size for sparse output specified");
2021 s
.min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2040 if (qemu_strtol(optarg
, NULL
, 0, &s
.num_coroutines
) ||
2041 s
.num_coroutines
< 1 || s
.num_coroutines
> MAX_COROUTINES
) {
2042 error_report("Invalid number of coroutines. Allowed number of"
2043 " coroutines is between 1 and %d", MAX_COROUTINES
);
2048 s
.wr_in_order
= false;
2053 case OPTION_OBJECT
: {
2054 QemuOpts
*object_opts
;
2055 object_opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2062 case OPTION_IMAGE_OPTS
:
2068 if (qemu_opts_foreach(&qemu_object_opts
,
2069 user_creatable_add_opts_foreach
,
2074 if (!s
.wr_in_order
&& s
.compressed
) {
2075 error_report("Out of order write and compress are mutually exclusive");
2079 s
.src_num
= argc
- optind
- 1;
2080 out_filename
= s
.src_num
>= 1 ? argv
[argc
- 1] : NULL
;
2082 if (options
&& has_help_option(options
)) {
2083 ret
= print_block_option_help(out_filename
, out_fmt
);
2087 if (s
.src_num
< 1) {
2088 error_report("Must specify image file name");
2093 /* ret is still -EINVAL until here */
2094 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2096 error_report("Invalid source cache option: %s", src_cache
);
2100 /* Initialize before goto out */
2104 qemu_progress_init(progress
, 1.0);
2105 qemu_progress_print(0, 100);
2107 s
.src
= g_new0(BlockBackend
*, s
.src_num
);
2108 s
.src_sectors
= g_new(int64_t, s
.src_num
);
2110 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2111 s
.src
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2112 fmt
, src_flags
, src_writethrough
, quiet
,
2118 s
.src_sectors
[bs_i
] = blk_nb_sectors(s
.src
[bs_i
]);
2119 if (s
.src_sectors
[bs_i
] < 0) {
2120 error_report("Could not get size of %s: %s",
2121 argv
[optind
+ bs_i
], strerror(-s
.src_sectors
[bs_i
]));
2125 s
.total_sectors
+= s
.src_sectors
[bs_i
];
2129 bdrv_snapshot_load_tmp(blk_bs(s
.src
[0]),
2130 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2131 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2133 } else if (snapshot_name
!= NULL
) {
2134 if (s
.src_num
> 1) {
2135 error_report("No support for concatenating multiple snapshot");
2140 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s
.src
[0]), snapshot_name
,
2144 error_reportf_err(local_err
, "Failed to load snapshot: ");
2149 /* Find driver and parse its options */
2150 drv
= bdrv_find_format(out_fmt
);
2152 error_report("Unknown file format '%s'", out_fmt
);
2157 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2159 error_report_err(local_err
);
2165 if (!drv
->create_opts
) {
2166 error_report("Format driver '%s' does not support image creation",
2172 if (!proto_drv
->create_opts
) {
2173 error_report("Protocol driver '%s' does not support image creation",
2174 proto_drv
->format_name
);
2179 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2180 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2182 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2184 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2186 error_report_err(local_err
);
2192 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, s
.total_sectors
* 512,
2194 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2200 /* Get backing file name if -o backing_file was used */
2201 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2202 if (out_baseimg_param
) {
2203 out_baseimg
= out_baseimg_param
;
2205 s
.target_has_backing
= (bool) out_baseimg
;
2207 if (s
.src_num
> 1 && out_baseimg
) {
2208 error_report("Having a backing file for the target makes no sense when "
2209 "concatenating multiple input images");
2214 /* Check if compression is supported */
2217 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2218 const char *preallocation
=
2219 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2221 if (!drv
->bdrv_co_pwritev_compressed
) {
2222 error_report("Compression not supported for this file format");
2228 error_report("Compression and encryption not supported at "
2235 && strcmp(preallocation
, "off"))
2237 error_report("Compression and preallocation not supported at "
2245 /* Create the new image */
2246 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2248 error_reportf_err(local_err
, "%s: error while converting %s: ",
2249 out_filename
, out_fmt
);
2254 flags
= s
.min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2255 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2257 error_report("Invalid cache option: %s", cache
);
2261 /* XXX we should allow --image-opts to trigger use of
2262 * img_open() here, but then we have trouble with
2263 * the bdrv_create() call which takes different params.
2264 * Not critical right now, so fix can wait...
2266 s
.target
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
,
2272 out_bs
= blk_bs(s
.target
);
2274 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2275 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2277 s
.buf_sectors
= MIN(32768,
2279 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2280 out_bs
->bl
.pdiscard_alignment
>>
2281 BDRV_SECTOR_BITS
)));
2284 int64_t output_sectors
= blk_nb_sectors(s
.target
);
2285 if (output_sectors
< 0) {
2286 error_report("unable to get output image length: %s",
2287 strerror(-output_sectors
));
2290 } else if (output_sectors
< s
.total_sectors
) {
2291 error_report("output file is smaller than input file");
2297 ret
= bdrv_get_info(out_bs
, &bdi
);
2300 error_report("could not get block driver info");
2304 s
.compressed
= s
.compressed
|| bdi
.needs_compressed_writes
;
2305 s
.cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2308 ret
= convert_do_copy(&s
);
2311 qemu_progress_print(100, 0);
2313 qemu_progress_end();
2314 qemu_opts_del(opts
);
2315 qemu_opts_free(create_opts
);
2316 qemu_opts_del(sn_opts
);
2317 blk_unref(s
.target
);
2319 for (bs_i
= 0; bs_i
< s
.src_num
; bs_i
++) {
2320 blk_unref(s
.src
[bs_i
]);
2324 g_free(s
.src_sectors
);
2332 static void dump_snapshots(BlockDriverState
*bs
)
2334 QEMUSnapshotInfo
*sn_tab
, *sn
;
2337 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2340 printf("Snapshot list:\n");
2341 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2343 for(i
= 0; i
< nb_sns
; i
++) {
2345 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2351 static void dump_json_image_info_list(ImageInfoList
*list
)
2355 Visitor
*v
= qobject_output_visitor_new(&obj
);
2357 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2358 visit_complete(v
, &obj
);
2359 str
= qobject_to_json_pretty(obj
);
2360 assert(str
!= NULL
);
2361 printf("%s\n", qstring_get_str(str
));
2362 qobject_decref(obj
);
2367 static void dump_json_image_info(ImageInfo
*info
)
2371 Visitor
*v
= qobject_output_visitor_new(&obj
);
2373 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2374 visit_complete(v
, &obj
);
2375 str
= qobject_to_json_pretty(obj
);
2376 assert(str
!= NULL
);
2377 printf("%s\n", qstring_get_str(str
));
2378 qobject_decref(obj
);
2383 static void dump_human_image_info_list(ImageInfoList
*list
)
2385 ImageInfoList
*elem
;
2388 for (elem
= list
; elem
; elem
= elem
->next
) {
2394 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2398 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2400 return strcmp(a
, b
) == 0;
2404 * Open an image file chain and return an ImageInfoList
2406 * @filename: topmost image filename
2407 * @fmt: topmost image format (may be NULL to autodetect)
2408 * @chain: true - enumerate entire backing file chain
2409 * false - only topmost image file
2411 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2412 * image file. If there was an error a message will have been printed to
2415 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2416 const char *filename
,
2418 bool chain
, bool force_share
)
2420 ImageInfoList
*head
= NULL
;
2421 ImageInfoList
**last
= &head
;
2422 GHashTable
*filenames
;
2425 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2429 BlockDriverState
*bs
;
2431 ImageInfoList
*elem
;
2433 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2434 error_report("Backing file '%s' creates an infinite loop.",
2438 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2440 blk
= img_open(image_opts
, filename
, fmt
,
2441 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false,
2448 bdrv_query_image_info(bs
, &info
, &err
);
2450 error_report_err(err
);
2455 elem
= g_new0(ImageInfoList
, 1);
2462 filename
= fmt
= NULL
;
2464 if (info
->has_full_backing_filename
) {
2465 filename
= info
->full_backing_filename
;
2466 } else if (info
->has_backing_filename
) {
2467 error_report("Could not determine absolute backing filename,"
2468 " but backing filename '%s' present",
2469 info
->backing_filename
);
2472 if (info
->has_backing_filename_format
) {
2473 fmt
= info
->backing_filename_format
;
2477 g_hash_table_destroy(filenames
);
2481 qapi_free_ImageInfoList(head
);
2482 g_hash_table_destroy(filenames
);
2486 static int img_info(int argc
, char **argv
)
2489 OutputFormat output_format
= OFORMAT_HUMAN
;
2491 const char *filename
, *fmt
, *output
;
2492 ImageInfoList
*list
;
2493 bool image_opts
= false;
2494 bool force_share
= false;
2499 int option_index
= 0;
2500 static const struct option long_options
[] = {
2501 {"help", no_argument
, 0, 'h'},
2502 {"format", required_argument
, 0, 'f'},
2503 {"output", required_argument
, 0, OPTION_OUTPUT
},
2504 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2505 {"object", required_argument
, 0, OPTION_OBJECT
},
2506 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2507 {"force-share", no_argument
, 0, 'U'},
2510 c
= getopt_long(argc
, argv
, ":f:hU",
2511 long_options
, &option_index
);
2517 missing_argument(argv
[optind
- 1]);
2520 unrecognized_option(argv
[optind
- 1]);
2534 case OPTION_BACKING_CHAIN
:
2537 case OPTION_OBJECT
: {
2539 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2545 case OPTION_IMAGE_OPTS
:
2550 if (optind
!= argc
- 1) {
2551 error_exit("Expecting one image file name");
2553 filename
= argv
[optind
++];
2555 if (output
&& !strcmp(output
, "json")) {
2556 output_format
= OFORMAT_JSON
;
2557 } else if (output
&& !strcmp(output
, "human")) {
2558 output_format
= OFORMAT_HUMAN
;
2559 } else if (output
) {
2560 error_report("--output must be used with human or json as argument.");
2564 if (qemu_opts_foreach(&qemu_object_opts
,
2565 user_creatable_add_opts_foreach
,
2570 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
,
2576 switch (output_format
) {
2578 dump_human_image_info_list(list
);
2582 dump_json_image_info_list(list
);
2584 dump_json_image_info(list
->value
);
2589 qapi_free_ImageInfoList(list
);
2593 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2596 switch (output_format
) {
2598 if (e
->data
&& !e
->has_offset
) {
2599 error_report("File contains external, encrypted or compressed clusters.");
2602 if (e
->data
&& !e
->zero
) {
2603 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2604 e
->start
, e
->length
,
2605 e
->has_offset
? e
->offset
: 0,
2606 e
->has_filename
? e
->filename
: "");
2608 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2609 * Modify the flags here to allow more coalescing.
2611 if (next
&& (!next
->data
|| next
->zero
)) {
2617 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2618 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2619 (e
->start
== 0 ? "[" : ",\n"),
2620 e
->start
, e
->length
, e
->depth
,
2621 e
->zero
? "true" : "false",
2622 e
->data
? "true" : "false");
2623 if (e
->has_offset
) {
2624 printf(", \"offset\": %"PRId64
"", e
->offset
);
2635 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2636 int nb_sectors
, MapEntry
*e
)
2640 BlockDriverState
*file
;
2643 /* As an optimization, we could cache the current range of unallocated
2644 * clusters in each file of the chain, and avoid querying the same
2650 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2656 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2659 bs
= backing_bs(bs
);
2668 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2671 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2672 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2673 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2674 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2675 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2676 .has_offset
= has_offset
,
2678 .has_filename
= file
&& has_offset
,
2679 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2685 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2687 if (curr
->length
== 0) {
2690 if (curr
->zero
!= next
->zero
||
2691 curr
->data
!= next
->data
||
2692 curr
->depth
!= next
->depth
||
2693 curr
->has_filename
!= next
->has_filename
||
2694 curr
->has_offset
!= next
->has_offset
) {
2697 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2700 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2706 static int img_map(int argc
, char **argv
)
2709 OutputFormat output_format
= OFORMAT_HUMAN
;
2711 BlockDriverState
*bs
;
2712 const char *filename
, *fmt
, *output
;
2714 MapEntry curr
= { .length
= 0 }, next
;
2716 bool image_opts
= false;
2717 bool force_share
= false;
2722 int option_index
= 0;
2723 static const struct option long_options
[] = {
2724 {"help", no_argument
, 0, 'h'},
2725 {"format", required_argument
, 0, 'f'},
2726 {"output", required_argument
, 0, OPTION_OUTPUT
},
2727 {"object", required_argument
, 0, OPTION_OBJECT
},
2728 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2729 {"force-share", no_argument
, 0, 'U'},
2732 c
= getopt_long(argc
, argv
, ":f:hU",
2733 long_options
, &option_index
);
2739 missing_argument(argv
[optind
- 1]);
2742 unrecognized_option(argv
[optind
- 1]);
2756 case OPTION_OBJECT
: {
2758 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2764 case OPTION_IMAGE_OPTS
:
2769 if (optind
!= argc
- 1) {
2770 error_exit("Expecting one image file name");
2772 filename
= argv
[optind
];
2774 if (output
&& !strcmp(output
, "json")) {
2775 output_format
= OFORMAT_JSON
;
2776 } else if (output
&& !strcmp(output
, "human")) {
2777 output_format
= OFORMAT_HUMAN
;
2778 } else if (output
) {
2779 error_report("--output must be used with human or json as argument.");
2783 if (qemu_opts_foreach(&qemu_object_opts
,
2784 user_creatable_add_opts_foreach
,
2789 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false, force_share
);
2795 if (output_format
== OFORMAT_HUMAN
) {
2796 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2799 length
= blk_getlength(blk
);
2800 while (curr
.start
+ curr
.length
< length
) {
2801 int64_t nsectors_left
;
2805 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2807 /* Probe up to 1 GiB at a time. */
2808 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2809 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2810 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2813 error_report("Could not read file metadata: %s", strerror(-ret
));
2817 if (entry_mergeable(&curr
, &next
)) {
2818 curr
.length
+= next
.length
;
2822 if (curr
.length
> 0) {
2823 dump_map_entry(output_format
, &curr
, &next
);
2828 dump_map_entry(output_format
, &curr
, NULL
);
2835 #define SNAPSHOT_LIST 1
2836 #define SNAPSHOT_CREATE 2
2837 #define SNAPSHOT_APPLY 3
2838 #define SNAPSHOT_DELETE 4
2840 static int img_snapshot(int argc
, char **argv
)
2843 BlockDriverState
*bs
;
2844 QEMUSnapshotInfo sn
;
2845 char *filename
, *snapshot_name
= NULL
;
2846 int c
, ret
= 0, bdrv_oflags
;
2851 bool image_opts
= false;
2852 bool force_share
= false;
2854 bdrv_oflags
= BDRV_O_RDWR
;
2855 /* Parse commandline parameters */
2857 static const struct option long_options
[] = {
2858 {"help", no_argument
, 0, 'h'},
2859 {"object", required_argument
, 0, OPTION_OBJECT
},
2860 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2861 {"force-share", no_argument
, 0, 'U'},
2864 c
= getopt_long(argc
, argv
, ":la:c:d:hqU",
2865 long_options
, NULL
);
2871 missing_argument(argv
[optind
- 1]);
2874 unrecognized_option(argv
[optind
- 1]);
2881 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2884 action
= SNAPSHOT_LIST
;
2885 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2889 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2892 action
= SNAPSHOT_APPLY
;
2893 snapshot_name
= optarg
;
2897 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2900 action
= SNAPSHOT_CREATE
;
2901 snapshot_name
= optarg
;
2905 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2908 action
= SNAPSHOT_DELETE
;
2909 snapshot_name
= optarg
;
2917 case OPTION_OBJECT
: {
2919 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2925 case OPTION_IMAGE_OPTS
:
2931 if (optind
!= argc
- 1) {
2932 error_exit("Expecting one image file name");
2934 filename
= argv
[optind
++];
2936 if (qemu_opts_foreach(&qemu_object_opts
,
2937 user_creatable_add_opts_foreach
,
2942 /* Open the image */
2943 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
,
2950 /* Perform the requested action */
2956 case SNAPSHOT_CREATE
:
2957 memset(&sn
, 0, sizeof(sn
));
2958 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2960 qemu_gettimeofday(&tv
);
2961 sn
.date_sec
= tv
.tv_sec
;
2962 sn
.date_nsec
= tv
.tv_usec
* 1000;
2964 ret
= bdrv_snapshot_create(bs
, &sn
);
2966 error_report("Could not create snapshot '%s': %d (%s)",
2967 snapshot_name
, ret
, strerror(-ret
));
2971 case SNAPSHOT_APPLY
:
2972 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2974 error_report("Could not apply snapshot '%s': %d (%s)",
2975 snapshot_name
, ret
, strerror(-ret
));
2979 case SNAPSHOT_DELETE
:
2980 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2982 error_reportf_err(err
, "Could not delete snapshot '%s': ",
2997 static int img_rebase(int argc
, char **argv
)
2999 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
3000 uint8_t *buf_old
= NULL
;
3001 uint8_t *buf_new
= NULL
;
3002 BlockDriverState
*bs
= NULL
;
3004 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
3005 int c
, flags
, src_flags
, ret
;
3006 bool writethrough
, src_writethrough
;
3008 bool force_share
= false;
3011 Error
*local_err
= NULL
;
3012 bool image_opts
= false;
3014 /* Parse commandline parameters */
3016 cache
= BDRV_DEFAULT_CACHE
;
3017 src_cache
= BDRV_DEFAULT_CACHE
;
3021 static const struct option long_options
[] = {
3022 {"help", no_argument
, 0, 'h'},
3023 {"object", required_argument
, 0, OPTION_OBJECT
},
3024 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3025 {"force-share", no_argument
, 0, 'U'},
3028 c
= getopt_long(argc
, argv
, ":hf:F:b:upt:T:qU",
3029 long_options
, NULL
);
3035 missing_argument(argv
[optind
- 1]);
3038 unrecognized_option(argv
[optind
- 1]);
3047 out_basefmt
= optarg
;
3050 out_baseimg
= optarg
;
3067 case OPTION_OBJECT
: {
3069 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3075 case OPTION_IMAGE_OPTS
:
3088 if (optind
!= argc
- 1) {
3089 error_exit("Expecting one image file name");
3091 if (!unsafe
&& !out_baseimg
) {
3092 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3094 filename
= argv
[optind
++];
3096 if (qemu_opts_foreach(&qemu_object_opts
,
3097 user_creatable_add_opts_foreach
,
3102 qemu_progress_init(progress
, 2.0);
3103 qemu_progress_print(0, 100);
3105 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3106 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3108 error_report("Invalid cache option: %s", cache
);
3113 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3115 error_report("Invalid source cache option: %s", src_cache
);
3119 /* The source files are opened read-only, don't care about WCE */
3120 assert((src_flags
& BDRV_O_RDWR
) == 0);
3121 (void) src_writethrough
;
3126 * Ignore the old backing file for unsafe rebase in case we want to correct
3127 * the reference to a renamed or moved backing file.
3129 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3137 if (out_basefmt
!= NULL
) {
3138 if (bdrv_find_format(out_basefmt
) == NULL
) {
3139 error_report("Invalid format name: '%s'", out_basefmt
);
3145 /* For safe rebasing we need to compare old and new backing file */
3147 char backing_name
[PATH_MAX
];
3148 QDict
*options
= NULL
;
3150 if (bs
->backing_format
[0] != '\0') {
3151 options
= qdict_new();
3152 qdict_put_str(options
, "driver", bs
->backing_format
);
3157 options
= qdict_new();
3159 qdict_put(options
, BDRV_OPT_FORCE_SHARE
,
3160 qbool_from_bool(true));
3162 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3163 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3164 options
, src_flags
, &local_err
);
3165 if (!blk_old_backing
) {
3166 error_reportf_err(local_err
,
3167 "Could not open old backing file '%s': ",
3173 if (out_baseimg
[0]) {
3174 options
= qdict_new();
3176 qdict_put_str(options
, "driver", out_basefmt
);
3179 qdict_put_bool(options
, BDRV_OPT_FORCE_SHARE
, true);
3182 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
3183 options
, src_flags
, &local_err
);
3184 if (!blk_new_backing
) {
3185 error_reportf_err(local_err
,
3186 "Could not open new backing file '%s': ",
3195 * Check each unallocated cluster in the COW file. If it is unallocated,
3196 * accesses go to the backing file. We must therefore compare this cluster
3197 * in the old and new backing file, and if they differ we need to copy it
3198 * from the old backing file into the COW file.
3200 * If qemu-img crashes during this step, no harm is done. The content of
3201 * the image is the same as the original one at any time.
3204 int64_t num_sectors
;
3205 int64_t old_backing_num_sectors
;
3206 int64_t new_backing_num_sectors
= 0;
3209 float local_progress
= 0;
3211 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3212 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3214 num_sectors
= blk_nb_sectors(blk
);
3215 if (num_sectors
< 0) {
3216 error_report("Could not get size of '%s': %s",
3217 filename
, strerror(-num_sectors
));
3221 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3222 if (old_backing_num_sectors
< 0) {
3223 char backing_name
[PATH_MAX
];
3225 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3226 error_report("Could not get size of '%s': %s",
3227 backing_name
, strerror(-old_backing_num_sectors
));
3231 if (blk_new_backing
) {
3232 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3233 if (new_backing_num_sectors
< 0) {
3234 error_report("Could not get size of '%s': %s",
3235 out_baseimg
, strerror(-new_backing_num_sectors
));
3241 if (num_sectors
!= 0) {
3242 local_progress
= (float)100 /
3243 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3246 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3248 /* How many sectors can we handle with the next read? */
3249 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3250 n
= (IO_BUF_SIZE
/ 512);
3252 n
= num_sectors
- sector
;
3255 /* If the cluster is allocated, we don't need to take action */
3256 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3258 error_report("error while reading image metadata: %s",
3267 * Read old and new backing file and take into consideration that
3268 * backing files may be smaller than the COW image.
3270 if (sector
>= old_backing_num_sectors
) {
3271 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3273 if (sector
+ n
> old_backing_num_sectors
) {
3274 n
= old_backing_num_sectors
- sector
;
3277 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3278 buf_old
, n
<< BDRV_SECTOR_BITS
);
3280 error_report("error while reading from old backing file");
3285 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3286 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3288 if (sector
+ n
> new_backing_num_sectors
) {
3289 n
= new_backing_num_sectors
- sector
;
3292 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3293 buf_new
, n
<< BDRV_SECTOR_BITS
);
3295 error_report("error while reading from new backing file");
3300 /* If they differ, we need to write to the COW file */
3301 uint64_t written
= 0;
3303 while (written
< n
) {
3306 if (compare_sectors(buf_old
+ written
* 512,
3307 buf_new
+ written
* 512, n
- written
, &pnum
))
3309 ret
= blk_pwrite(blk
,
3310 (sector
+ written
) << BDRV_SECTOR_BITS
,
3311 buf_old
+ written
* 512,
3312 pnum
<< BDRV_SECTOR_BITS
, 0);
3314 error_report("Error while writing to COW image: %s",
3322 qemu_progress_print(local_progress
, 100);
3327 * Change the backing file. All clusters that are different from the old
3328 * backing file are overwritten in the COW file now, so the visible content
3329 * doesn't change when we switch the backing file.
3331 if (out_baseimg
&& *out_baseimg
) {
3332 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3334 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3337 if (ret
== -ENOSPC
) {
3338 error_report("Could not change the backing file to '%s': No "
3339 "space left in the file header", out_baseimg
);
3340 } else if (ret
< 0) {
3341 error_report("Could not change the backing file to '%s': %s",
3342 out_baseimg
, strerror(-ret
));
3345 qemu_progress_print(100, 0);
3347 * TODO At this point it is possible to check if any clusters that are
3348 * allocated in the COW file are the same in the backing file. If so, they
3349 * could be dropped from the COW file. Don't do this before switching the
3350 * backing file, in case of a crash this would lead to corruption.
3353 qemu_progress_end();
3356 blk_unref(blk_old_backing
);
3357 blk_unref(blk_new_backing
);
3359 qemu_vfree(buf_old
);
3360 qemu_vfree(buf_new
);
3369 static int img_resize(int argc
, char **argv
)
3372 int c
, ret
, relative
;
3373 const char *filename
, *fmt
, *size
;
3374 int64_t n
, total_size
;
3376 BlockBackend
*blk
= NULL
;
3379 static QemuOptsList resize_options
= {
3380 .name
= "resize_options",
3381 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3384 .name
= BLOCK_OPT_SIZE
,
3385 .type
= QEMU_OPT_SIZE
,
3386 .help
= "Virtual disk size"
3392 bool image_opts
= false;
3394 /* Remove size from argv manually so that negative numbers are not treated
3395 * as options by getopt. */
3397 error_exit("Not enough arguments");
3401 size
= argv
[--argc
];
3403 /* Parse getopt arguments */
3406 static const struct option long_options
[] = {
3407 {"help", no_argument
, 0, 'h'},
3408 {"object", required_argument
, 0, OPTION_OBJECT
},
3409 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3412 c
= getopt_long(argc
, argv
, ":f:hq",
3413 long_options
, NULL
);
3419 missing_argument(argv
[optind
- 1]);
3422 unrecognized_option(argv
[optind
- 1]);
3433 case OPTION_OBJECT
: {
3435 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3441 case OPTION_IMAGE_OPTS
:
3446 if (optind
!= argc
- 1) {
3447 error_exit("Expecting one image file name");
3449 filename
= argv
[optind
++];
3451 if (qemu_opts_foreach(&qemu_object_opts
,
3452 user_creatable_add_opts_foreach
,
3457 /* Choose grow, shrink, or absolute resize mode */
3473 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3474 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3476 error_report_err(err
);
3478 qemu_opts_del(param
);
3481 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3482 qemu_opts_del(param
);
3484 blk
= img_open(image_opts
, filename
, fmt
,
3485 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
,
3493 total_size
= blk_getlength(blk
) + n
* relative
;
3497 if (total_size
<= 0) {
3498 error_report("New image size must be positive");
3503 ret
= blk_truncate(blk
, total_size
, &err
);
3505 qprintf(quiet
, "Image resized.\n");
3507 error_report_err(err
);
3517 static void amend_status_cb(BlockDriverState
*bs
,
3518 int64_t offset
, int64_t total_work_size
,
3521 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3524 static int img_amend(int argc
, char **argv
)
3528 char *options
= NULL
;
3529 QemuOptsList
*create_opts
= NULL
;
3530 QemuOpts
*opts
= NULL
;
3531 const char *fmt
= NULL
, *filename
, *cache
;
3534 bool quiet
= false, progress
= false;
3535 BlockBackend
*blk
= NULL
;
3536 BlockDriverState
*bs
= NULL
;
3537 bool image_opts
= false;
3539 cache
= BDRV_DEFAULT_CACHE
;
3541 static const struct option long_options
[] = {
3542 {"help", no_argument
, 0, 'h'},
3543 {"object", required_argument
, 0, OPTION_OBJECT
},
3544 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3547 c
= getopt_long(argc
, argv
, ":ho:f:t:pq",
3548 long_options
, NULL
);
3555 missing_argument(argv
[optind
- 1]);
3558 unrecognized_option(argv
[optind
- 1]);
3564 if (!is_valid_option_list(optarg
)) {
3565 error_report("Invalid option list: %s", optarg
);
3567 goto out_no_progress
;
3570 options
= g_strdup(optarg
);
3572 char *old_options
= options
;
3573 options
= g_strdup_printf("%s,%s", options
, optarg
);
3574 g_free(old_options
);
3590 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3594 goto out_no_progress
;
3597 case OPTION_IMAGE_OPTS
:
3604 error_exit("Must specify options (-o)");
3607 if (qemu_opts_foreach(&qemu_object_opts
,
3608 user_creatable_add_opts_foreach
,
3611 goto out_no_progress
;
3617 qemu_progress_init(progress
, 1.0);
3619 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3620 if (fmt
&& has_help_option(options
)) {
3621 /* If a format is explicitly specified (and possibly no filename is
3622 * given), print option help here */
3623 ret
= print_block_option_help(filename
, fmt
);
3627 if (optind
!= argc
- 1) {
3628 error_report("Expecting one image file name");
3633 flags
= BDRV_O_RDWR
;
3634 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3636 error_report("Invalid cache option: %s", cache
);
3640 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3648 fmt
= bs
->drv
->format_name
;
3650 if (has_help_option(options
)) {
3651 /* If the format was auto-detected, print option help here */
3652 ret
= print_block_option_help(filename
, fmt
);
3656 if (!bs
->drv
->create_opts
) {
3657 error_report("Format driver '%s' does not support any options to amend",
3663 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3664 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3665 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3667 error_report_err(err
);
3672 /* In case the driver does not call amend_status_cb() */
3673 qemu_progress_print(0.f
, 0);
3674 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3675 qemu_progress_print(100.f
, 0);
3677 error_report("Error while amending options: %s", strerror(-ret
));
3682 qemu_progress_end();
3686 qemu_opts_del(opts
);
3687 qemu_opts_free(create_opts
);
3696 typedef struct BenchData
{
3698 uint64_t image_size
;
3705 bool drain_on_flush
;
3714 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3717 error_report("Failed flush request: %s", strerror(-ret
));
3722 static void bench_cb(void *opaque
, int ret
)
3724 BenchData
*b
= opaque
;
3728 error_report("Failed request: %s", strerror(-ret
));
3733 /* Just finished a flush with drained queue: Start next requests */
3734 assert(b
->in_flight
== 0);
3735 b
->in_flush
= false;
3736 } else if (b
->in_flight
> 0) {
3737 int remaining
= b
->n
- b
->in_flight
;
3742 /* Time for flush? Drain queue if requested, then flush */
3743 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3744 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3745 BlockCompletionFunc
*cb
;
3747 if (b
->drain_on_flush
) {
3751 cb
= bench_undrained_flush_cb
;
3754 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3756 error_report("Failed to issue flush request");
3760 if (b
->drain_on_flush
) {
3766 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3767 int64_t offset
= b
->offset
;
3768 /* blk_aio_* might look for completed I/Os and kick bench_cb
3769 * again, so make sure this operation is counted by in_flight
3770 * and b->offset is ready for the next submission.
3773 b
->offset
+= b
->step
;
3774 b
->offset
%= b
->image_size
;
3776 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3778 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3781 error_report("Failed to issue request");
3787 static int img_bench(int argc
, char **argv
)
3790 const char *fmt
= NULL
, *filename
;
3792 bool image_opts
= false;
3793 bool is_write
= false;
3797 size_t bufsize
= 4096;
3800 int flush_interval
= 0;
3801 bool drain_on_flush
= true;
3803 BlockBackend
*blk
= NULL
;
3804 BenchData data
= {};
3806 bool writethrough
= false;
3807 struct timeval t1
, t2
;
3809 bool force_share
= false;
3812 static const struct option long_options
[] = {
3813 {"help", no_argument
, 0, 'h'},
3814 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3815 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3816 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3817 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3818 {"force-share", no_argument
, 0, 'U'},
3821 c
= getopt_long(argc
, argv
, ":hc:d:f:no:qs:S:t:wU", long_options
, NULL
);
3828 missing_argument(argv
[optind
- 1]);
3831 unrecognized_option(argv
[optind
- 1]);
3840 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3841 error_report("Invalid request count specified");
3851 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3852 error_report("Invalid queue depth specified");
3862 flags
|= BDRV_O_NATIVE_AIO
;
3866 offset
= cvtnum(optarg
);
3868 error_report("Invalid offset specified");
3881 sval
= cvtnum(optarg
);
3882 if (sval
< 0 || sval
> INT_MAX
) {
3883 error_report("Invalid buffer size specified");
3894 sval
= cvtnum(optarg
);
3895 if (sval
< 0 || sval
> INT_MAX
) {
3896 error_report("Invalid step size specified");
3904 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3906 error_report("Invalid cache mode");
3912 flags
|= BDRV_O_RDWR
;
3918 case OPTION_PATTERN
:
3922 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
3923 error_report("Invalid pattern byte specified");
3929 case OPTION_FLUSH_INTERVAL
:
3933 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3934 error_report("Invalid flush interval specified");
3937 flush_interval
= res
;
3940 case OPTION_NO_DRAIN
:
3941 drain_on_flush
= false;
3943 case OPTION_IMAGE_OPTS
:
3949 if (optind
!= argc
- 1) {
3950 error_exit("Expecting one image file name");
3952 filename
= argv
[argc
- 1];
3954 if (!is_write
&& flush_interval
) {
3955 error_report("--flush-interval is only available in write tests");
3959 if (flush_interval
&& flush_interval
< depth
) {
3960 error_report("Flush interval can't be smaller than depth");
3965 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
,
3972 image_size
= blk_getlength(blk
);
3973 if (image_size
< 0) {
3978 data
= (BenchData
) {
3980 .image_size
= image_size
,
3982 .step
= step
?: bufsize
,
3987 .flush_interval
= flush_interval
,
3988 .drain_on_flush
= drain_on_flush
,
3990 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3991 "(starting at offset %" PRId64
", step size %d)\n",
3992 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
3993 data
.offset
, data
.step
);
3994 if (flush_interval
) {
3995 printf("Sending flush every %d requests\n", flush_interval
);
3998 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
3999 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
4001 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
4002 for (i
= 0; i
< data
.nrreq
; i
++) {
4003 qemu_iovec_init(&data
.qiov
[i
], 1);
4004 qemu_iovec_add(&data
.qiov
[i
],
4005 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
4008 gettimeofday(&t1
, NULL
);
4011 while (data
.n
> 0) {
4012 main_loop_wait(false);
4014 gettimeofday(&t2
, NULL
);
4016 printf("Run completed in %3.3f seconds.\n",
4017 (t2
.tv_sec
- t1
.tv_sec
)
4018 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
4021 qemu_vfree(data
.buf
);
4042 int bsz
; /* Block size */
4050 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
4054 static int img_dd_bs(const char *arg
,
4055 struct DdIo
*in
, struct DdIo
*out
,
4062 if (res
<= 0 || res
> INT_MAX
) {
4063 error_report("invalid number: '%s'", arg
);
4066 in
->bsz
= out
->bsz
= res
;
4071 static int img_dd_count(const char *arg
,
4072 struct DdIo
*in
, struct DdIo
*out
,
4075 dd
->count
= cvtnum(arg
);
4077 if (dd
->count
< 0) {
4078 error_report("invalid number: '%s'", arg
);
4085 static int img_dd_if(const char *arg
,
4086 struct DdIo
*in
, struct DdIo
*out
,
4089 in
->filename
= g_strdup(arg
);
4094 static int img_dd_of(const char *arg
,
4095 struct DdIo
*in
, struct DdIo
*out
,
4098 out
->filename
= g_strdup(arg
);
4103 static int img_dd_skip(const char *arg
,
4104 struct DdIo
*in
, struct DdIo
*out
,
4107 in
->offset
= cvtnum(arg
);
4109 if (in
->offset
< 0) {
4110 error_report("invalid number: '%s'", arg
);
4117 static int img_dd(int argc
, char **argv
)
4122 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4123 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4124 QemuOpts
*opts
= NULL
;
4125 QemuOptsList
*create_opts
= NULL
;
4126 Error
*local_err
= NULL
;
4127 bool image_opts
= false;
4129 const char *out_fmt
= "raw";
4130 const char *fmt
= NULL
;
4132 int64_t block_count
= 0, out_pos
, in_pos
;
4133 bool force_share
= false;
4134 struct DdInfo dd
= {
4139 .bsz
= 512, /* Block size is by default 512 bytes */
4151 const struct DdOpts options
[] = {
4152 { "bs", img_dd_bs
, C_BS
},
4153 { "count", img_dd_count
, C_COUNT
},
4154 { "if", img_dd_if
, C_IF
},
4155 { "of", img_dd_of
, C_OF
},
4156 { "skip", img_dd_skip
, C_SKIP
},
4159 const struct option long_options
[] = {
4160 { "help", no_argument
, 0, 'h'},
4161 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4162 { "force-share", no_argument
, 0, 'U'},
4166 while ((c
= getopt_long(argc
, argv
, ":hf:O:U", long_options
, NULL
))) {
4178 missing_argument(argv
[optind
- 1]);
4181 unrecognized_option(argv
[optind
- 1]);
4189 case OPTION_IMAGE_OPTS
:
4195 for (i
= optind
; i
< argc
; i
++) {
4197 arg
= g_strdup(argv
[i
]);
4199 tmp
= strchr(arg
, '=');
4201 error_report("unrecognized operand %s", arg
);
4208 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4209 if (!strcmp(arg
, options
[j
].name
)) {
4213 if (options
[j
].name
== NULL
) {
4214 error_report("unrecognized operand %s", arg
);
4219 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4223 dd
.flags
|= options
[j
].flag
;
4228 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4229 error_report("Must specify both input and output files");
4233 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false,
4241 drv
= bdrv_find_format(out_fmt
);
4243 error_report("Unknown file format");
4247 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4250 error_report_err(local_err
);
4254 if (!drv
->create_opts
) {
4255 error_report("Format driver '%s' does not support image creation",
4260 if (!proto_drv
->create_opts
) {
4261 error_report("Protocol driver '%s' does not support image creation",
4262 proto_drv
->format_name
);
4266 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4267 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4269 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4271 size
= blk_getlength(blk1
);
4273 error_report("Failed to get size for '%s'", in
.filename
);
4278 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4279 dd
.count
* in
.bsz
< size
) {
4280 size
= dd
.count
* in
.bsz
;
4283 /* Overflow means the specified offset is beyond input image's size */
4284 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4285 size
< in
.bsz
* in
.offset
)) {
4286 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4288 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4289 size
- in
.bsz
* in
.offset
, &error_abort
);
4292 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4294 error_reportf_err(local_err
,
4295 "%s: error while creating output image: ",
4301 blk2
= img_open(image_opts
, out
.filename
, out_fmt
, BDRV_O_RDWR
,
4302 false, false, false);
4309 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4310 size
< in
.offset
* in
.bsz
)) {
4311 /* We give a warning if the skip option is bigger than the input
4312 * size and create an empty output disk image (i.e. like dd(1)).
4314 error_report("%s: cannot skip to specified offset", in
.filename
);
4317 in_pos
= in
.offset
* in
.bsz
;
4320 in
.buf
= g_new(uint8_t, in
.bsz
);
4322 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4323 int in_ret
, out_ret
;
4325 if (in_pos
+ in
.bsz
> size
) {
4326 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4328 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4331 error_report("error while reading from input image file: %s",
4338 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4341 error_report("error while writing to output image file: %s",
4342 strerror(-out_ret
));
4351 qemu_opts_del(opts
);
4352 qemu_opts_free(create_opts
);
4355 g_free(in
.filename
);
4356 g_free(out
.filename
);
4367 static const img_cmd_t img_cmds
[] = {
4368 #define DEF(option, callback, arg_string) \
4369 { option, callback },
4370 #include "qemu-img-cmds.h"
4376 int main(int argc
, char **argv
)
4378 const img_cmd_t
*cmd
;
4379 const char *cmdname
;
4380 Error
*local_error
= NULL
;
4381 char *trace_file
= NULL
;
4383 static const struct option long_options
[] = {
4384 {"help", no_argument
, 0, 'h'},
4385 {"version", no_argument
, 0, 'V'},
4386 {"trace", required_argument
, NULL
, 'T'},
4391 signal(SIGPIPE
, SIG_IGN
);
4394 module_call_init(MODULE_INIT_TRACE
);
4395 error_set_progname(argv
[0]);
4396 qemu_init_exec_dir(argv
[0]);
4398 if (qemu_init_main_loop(&local_error
)) {
4399 error_report_err(local_error
);
4403 qcrypto_init(&error_fatal
);
4405 module_call_init(MODULE_INIT_QOM
);
4408 error_exit("Not enough arguments");
4411 qemu_add_opts(&qemu_object_opts
);
4412 qemu_add_opts(&qemu_source_opts
);
4413 qemu_add_opts(&qemu_trace_opts
);
4415 while ((c
= getopt_long(argc
, argv
, "+:hVT:", long_options
, NULL
)) != -1) {
4418 missing_argument(argv
[optind
- 1]);
4421 unrecognized_option(argv
[optind
- 1]);
4427 printf(QEMU_IMG_VERSION
);
4431 trace_file
= trace_opt_parse(optarg
);
4436 cmdname
= argv
[optind
];
4438 /* reset getopt_long scanning */
4446 if (!trace_init_backends()) {
4449 trace_init_file(trace_file
);
4450 qemu_set_log(LOG_TRACE
);
4452 /* find the command */
4453 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4454 if (!strcmp(cmdname
, cmd
->name
)) {
4455 return cmd
->handler(argc
, argv
);
4460 error_exit("Command not found: %s", cmdname
);