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 "qemu/cutils.h"
32 #include "qemu/config-file.h"
33 #include "qemu/option.h"
34 #include "qemu/error-report.h"
36 #include "qom/object_interfaces.h"
37 #include "sysemu/sysemu.h"
38 #include "sysemu/block-backend.h"
39 #include "block/block_int.h"
40 #include "block/blockjob.h"
41 #include "block/qapi.h"
42 #include "crypto/init.h"
43 #include "trace/control.h"
46 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
47 "\n" QEMU_COPYRIGHT "\n"
49 typedef struct img_cmd_t
{
51 int (*handler
)(int argc
, char **argv
);
56 OPTION_BACKING_CHAIN
= 257,
58 OPTION_IMAGE_OPTS
= 259,
60 OPTION_FLUSH_INTERVAL
= 261,
61 OPTION_NO_DRAIN
= 262,
64 typedef enum OutputFormat
{
69 /* Default to cache=writeback as data integrity is not important for qemu-img */
70 #define BDRV_DEFAULT_CACHE "writeback"
72 static void format_print(void *opaque
, const char *name
)
77 static void QEMU_NORETURN
GCC_FMT_ATTR(1, 2) error_exit(const char *fmt
, ...)
81 error_printf("qemu-img: ");
84 error_vprintf(fmt
, ap
);
87 error_printf("\nTry 'qemu-img --help' for more information\n");
91 /* Please keep in synch with qemu-img.texi */
92 static void QEMU_NORETURN
help(void)
94 const char *help_msg
=
96 "usage: qemu-img [standard options] command [command options]\n"
97 "QEMU disk image utility\n"
99 " '-h', '--help' display this help and exit\n"
100 " '-V', '--version' output version information and exit\n"
101 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
102 " specify tracing options\n"
105 #define DEF(option, callback, arg_string) \
107 #include "qemu-img-cmds.h"
111 "Command parameters:\n"
112 " 'filename' is a disk image filename\n"
113 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
114 " manual page for a description of the object properties. The most common\n"
115 " object type is a 'secret', which is used to supply passwords and/or\n"
116 " encryption keys.\n"
117 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
118 " 'cache' is the cache mode used to write the output disk image, the valid\n"
119 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
120 " 'directsync' and 'unsafe' (default for convert)\n"
121 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
122 " options are the same as for the 'cache' option\n"
123 " 'size' is the disk image size in bytes. Optional suffixes\n"
124 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
125 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
126 " supported. 'b' is ignored.\n"
127 " 'output_filename' is the destination disk image filename\n"
128 " 'output_fmt' is the destination format\n"
129 " 'options' is a comma separated list of format specific options in a\n"
130 " name=value format. Use -o ? for an overview of the options supported by the\n"
132 " 'snapshot_param' is param used for internal snapshot, format\n"
133 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
135 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
137 " '-c' indicates that target image must be compressed (qcow format only)\n"
138 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
139 " match exactly. The image doesn't need a working backing file before\n"
140 " rebasing in this case (useful for renaming the backing file)\n"
141 " '-h' with or without a command shows this help and lists the supported formats\n"
142 " '-p' show progress of command (only certain commands)\n"
143 " '-q' use Quiet mode - do not print any output (except errors)\n"
144 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
145 " contain only zeros for qemu-img to create a sparse image during\n"
146 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
147 " unallocated or zero sectors, and the destination image will always be\n"
149 " '--output' takes the format in which the output must be done (human or json)\n"
150 " '-n' skips the target volume creation (useful if the volume is created\n"
151 " prior to running qemu-img)\n"
153 "Parameters to check subcommand:\n"
154 " '-r' tries to repair any inconsistencies that are found during the check.\n"
155 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
156 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
157 " hiding corruption that has already occurred.\n"
159 "Parameters to convert subcommand:\n"
160 " '-m' specifies how many coroutines work in parallel during the convert\n"
161 " process (defaults to 8)\n"
162 " '-W' allow to write to the target out of order rather than sequential\n"
164 "Parameters to snapshot subcommand:\n"
165 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
166 " '-a' applies a snapshot (revert disk to saved state)\n"
167 " '-c' creates a snapshot\n"
168 " '-d' deletes a snapshot\n"
169 " '-l' lists all snapshots in the given image\n"
171 "Parameters to compare subcommand:\n"
172 " '-f' first image format\n"
173 " '-F' second image format\n"
174 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
176 "Parameters to dd subcommand:\n"
177 " 'bs=BYTES' read and write up to BYTES bytes at a time "
179 " 'count=N' copy only N input blocks\n"
180 " 'if=FILE' read from FILE\n"
181 " 'of=FILE' write to FILE\n"
182 " 'skip=N' skip N bs-sized blocks at the start of input\n";
184 printf("%s\nSupported formats:", help_msg
);
185 bdrv_iterate_format(format_print
, NULL
);
190 static QemuOptsList qemu_object_opts
= {
192 .implied_opt_name
= "qom-type",
193 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
199 static QemuOptsList qemu_source_opts
= {
201 .implied_opt_name
= "file",
202 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
208 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
214 ret
= vprintf(fmt
, args
);
221 static int print_block_option_help(const char *filename
, const char *fmt
)
223 BlockDriver
*drv
, *proto_drv
;
224 QemuOptsList
*create_opts
= NULL
;
225 Error
*local_err
= NULL
;
227 /* Find driver and parse its options */
228 drv
= bdrv_find_format(fmt
);
230 error_report("Unknown file format '%s'", fmt
);
234 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
236 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
238 error_report_err(local_err
);
239 qemu_opts_free(create_opts
);
242 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
245 qemu_opts_print_help(create_opts
);
246 qemu_opts_free(create_opts
);
251 static int img_open_password(BlockBackend
*blk
, const char *filename
,
252 int flags
, bool quiet
)
254 BlockDriverState
*bs
;
258 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
259 !(flags
& BDRV_O_NO_IO
)) {
260 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
261 if (qemu_read_password(password
, sizeof(password
)) < 0) {
262 error_report("No password given");
265 if (bdrv_set_key(bs
, password
) < 0) {
266 error_report("invalid password");
274 static BlockBackend
*img_open_opts(const char *optstr
,
275 QemuOpts
*opts
, int flags
, bool writethrough
,
279 Error
*local_err
= NULL
;
281 options
= qemu_opts_to_qdict(opts
, NULL
);
282 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
284 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
287 blk_set_enable_write_cache(blk
, !writethrough
);
289 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
296 static BlockBackend
*img_open_file(const char *filename
,
297 const char *fmt
, int flags
,
298 bool writethrough
, bool quiet
)
301 Error
*local_err
= NULL
;
302 QDict
*options
= NULL
;
305 options
= qdict_new();
306 qdict_put(options
, "driver", qstring_from_str(fmt
));
309 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
311 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
314 blk_set_enable_write_cache(blk
, !writethrough
);
316 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
324 static BlockBackend
*img_open(bool image_opts
,
325 const char *filename
,
326 const char *fmt
, int flags
, bool writethrough
,
333 error_report("--image-opts and --format are mutually exclusive");
336 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
341 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
);
343 blk
= img_open_file(filename
, fmt
, flags
, writethrough
, quiet
);
349 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
350 const char *base_filename
,
351 const char *base_fmt
)
356 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
358 error_report("Backing file not supported for file format '%s'",
365 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
367 error_report("Backing file format not supported for file "
376 static int64_t cvtnum(const char *s
)
381 err
= qemu_strtosz(s
, NULL
, &value
);
385 if (value
> INT64_MAX
) {
391 static int img_create(int argc
, char **argv
)
394 uint64_t img_size
= -1;
395 const char *fmt
= "raw";
396 const char *base_fmt
= NULL
;
397 const char *filename
;
398 const char *base_filename
= NULL
;
399 char *options
= NULL
;
400 Error
*local_err
= NULL
;
404 static const struct option long_options
[] = {
405 {"help", no_argument
, 0, 'h'},
406 {"object", required_argument
, 0, OPTION_OBJECT
},
409 c
= getopt_long(argc
, argv
, "F:b:f:he6o:q",
423 base_filename
= optarg
;
429 error_report("option -e is deprecated, please use \'-o "
430 "encryption\' instead!");
433 error_report("option -6 is deprecated, please use \'-o "
434 "compat6\' instead!");
437 if (!is_valid_option_list(optarg
)) {
438 error_report("Invalid option list: %s", optarg
);
442 options
= g_strdup(optarg
);
444 char *old_options
= options
;
445 options
= g_strdup_printf("%s,%s", options
, optarg
);
452 case OPTION_OBJECT
: {
454 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
463 /* Get the filename */
464 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
465 if (options
&& has_help_option(options
)) {
467 return print_block_option_help(filename
, fmt
);
470 if (optind
>= argc
) {
471 error_exit("Expecting image file name");
475 if (qemu_opts_foreach(&qemu_object_opts
,
476 user_creatable_add_opts_foreach
,
481 /* Get image size, if specified */
485 sval
= cvtnum(argv
[optind
++]);
487 if (sval
== -ERANGE
) {
488 error_report("Image size must be less than 8 EiB!");
490 error_report("Invalid image size specified! You may use k, M, "
491 "G, T, P or E suffixes for ");
492 error_report("kilobytes, megabytes, gigabytes, terabytes, "
493 "petabytes and exabytes.");
497 img_size
= (uint64_t)sval
;
499 if (optind
!= argc
) {
500 error_exit("Unexpected argument: %s", argv
[optind
]);
503 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
504 options
, img_size
, 0, &local_err
, quiet
);
506 error_reportf_err(local_err
, "%s: ", filename
);
518 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
522 Visitor
*v
= qobject_output_visitor_new(&obj
);
524 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
525 visit_complete(v
, &obj
);
526 str
= qobject_to_json_pretty(obj
);
528 qprintf(quiet
, "%s\n", qstring_get_str(str
));
534 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
536 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
537 qprintf(quiet
, "No errors were found on the image.\n");
539 if (check
->corruptions
) {
540 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
541 "Data may be corrupted, or further writes to the image "
548 "\n%" PRId64
" leaked clusters were found on the image.\n"
549 "This means waste of disk space, but no harm to data.\n",
553 if (check
->check_errors
) {
556 " internal errors have occurred during the check.\n",
557 check
->check_errors
);
561 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
562 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
563 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
564 check
->allocated_clusters
, check
->total_clusters
,
565 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
566 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
567 check
->compressed_clusters
* 100.0 /
568 check
->allocated_clusters
);
571 if (check
->image_end_offset
) {
573 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
577 static int collect_image_check(BlockDriverState
*bs
,
579 const char *filename
,
584 BdrvCheckResult result
;
586 ret
= bdrv_check(bs
, &result
, fix
);
591 check
->filename
= g_strdup(filename
);
592 check
->format
= g_strdup(bdrv_get_format_name(bs
));
593 check
->check_errors
= result
.check_errors
;
594 check
->corruptions
= result
.corruptions
;
595 check
->has_corruptions
= result
.corruptions
!= 0;
596 check
->leaks
= result
.leaks
;
597 check
->has_leaks
= result
.leaks
!= 0;
598 check
->corruptions_fixed
= result
.corruptions_fixed
;
599 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
600 check
->leaks_fixed
= result
.leaks_fixed
;
601 check
->has_leaks_fixed
= result
.leaks
!= 0;
602 check
->image_end_offset
= result
.image_end_offset
;
603 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
604 check
->total_clusters
= result
.bfi
.total_clusters
;
605 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
606 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
607 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
608 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
609 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
610 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
611 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
617 * Checks an image for consistency. Exit codes:
619 * 0 - Check completed, image is good
620 * 1 - Check not completed because of internal errors
621 * 2 - Check completed, image is corrupted
622 * 3 - Check completed, image has leaked clusters, but is good otherwise
623 * 63 - Checks are not supported by the image format
625 static int img_check(int argc
, char **argv
)
628 OutputFormat output_format
= OFORMAT_HUMAN
;
629 const char *filename
, *fmt
, *output
, *cache
;
631 BlockDriverState
*bs
;
633 int flags
= BDRV_O_CHECK
;
637 bool image_opts
= false;
641 cache
= BDRV_DEFAULT_CACHE
;
644 int option_index
= 0;
645 static const struct option long_options
[] = {
646 {"help", no_argument
, 0, 'h'},
647 {"format", required_argument
, 0, 'f'},
648 {"repair", required_argument
, 0, 'r'},
649 {"output", required_argument
, 0, OPTION_OUTPUT
},
650 {"object", required_argument
, 0, OPTION_OBJECT
},
651 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
654 c
= getopt_long(argc
, argv
, "hf:r:T:q",
655 long_options
, &option_index
);
668 flags
|= BDRV_O_RDWR
;
670 if (!strcmp(optarg
, "leaks")) {
671 fix
= BDRV_FIX_LEAKS
;
672 } else if (!strcmp(optarg
, "all")) {
673 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
675 error_exit("Unknown option value for -r "
676 "(expecting 'leaks' or 'all'): %s", optarg
);
688 case OPTION_OBJECT
: {
690 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
696 case OPTION_IMAGE_OPTS
:
701 if (optind
!= argc
- 1) {
702 error_exit("Expecting one image file name");
704 filename
= argv
[optind
++];
706 if (output
&& !strcmp(output
, "json")) {
707 output_format
= OFORMAT_JSON
;
708 } else if (output
&& !strcmp(output
, "human")) {
709 output_format
= OFORMAT_HUMAN
;
711 error_report("--output must be used with human or json as argument.");
715 if (qemu_opts_foreach(&qemu_object_opts
,
716 user_creatable_add_opts_foreach
,
721 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
723 error_report("Invalid source cache option: %s", cache
);
727 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
733 check
= g_new0(ImageCheck
, 1);
734 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
736 if (ret
== -ENOTSUP
) {
737 error_report("This image format does not support checks");
742 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
743 int corruptions_fixed
, leaks_fixed
;
745 leaks_fixed
= check
->leaks_fixed
;
746 corruptions_fixed
= check
->corruptions_fixed
;
748 if (output_format
== OFORMAT_HUMAN
) {
750 "The following inconsistencies were found and repaired:\n\n"
751 " %" PRId64
" leaked clusters\n"
752 " %" PRId64
" corruptions\n\n"
753 "Double checking the fixed image now...\n",
755 check
->corruptions_fixed
);
758 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
760 check
->leaks_fixed
= leaks_fixed
;
761 check
->corruptions_fixed
= corruptions_fixed
;
765 switch (output_format
) {
767 dump_human_image_check(check
, quiet
);
770 dump_json_image_check(check
, quiet
);
775 if (ret
|| check
->check_errors
) {
777 error_report("Check failed: %s", strerror(-ret
));
779 error_report("Check failed");
785 if (check
->corruptions
) {
787 } else if (check
->leaks
) {
794 qapi_free_ImageCheck(check
);
799 typedef struct CommonBlockJobCBInfo
{
800 BlockDriverState
*bs
;
802 } CommonBlockJobCBInfo
;
804 static void common_block_job_cb(void *opaque
, int ret
)
806 CommonBlockJobCBInfo
*cbi
= opaque
;
809 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
813 static void run_block_job(BlockJob
*job
, Error
**errp
)
815 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
817 aio_context_acquire(aio_context
);
819 aio_poll(aio_context
, true);
820 qemu_progress_print(job
->len
?
821 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
822 } while (!job
->ready
);
824 block_job_complete_sync(job
, errp
);
825 aio_context_release(aio_context
);
827 /* A block job may finish instantaneously without publishing any progress,
828 * so just signal completion here */
829 qemu_progress_print(100.f
, 0);
832 static int img_commit(int argc
, char **argv
)
835 const char *filename
, *fmt
, *cache
, *base
;
837 BlockDriverState
*bs
, *base_bs
;
838 bool progress
= false, quiet
= false, drop
= false;
840 Error
*local_err
= NULL
;
841 CommonBlockJobCBInfo cbi
;
842 bool image_opts
= false;
843 AioContext
*aio_context
;
846 cache
= BDRV_DEFAULT_CACHE
;
849 static const struct option long_options
[] = {
850 {"help", no_argument
, 0, 'h'},
851 {"object", required_argument
, 0, OPTION_OBJECT
},
852 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
855 c
= getopt_long(argc
, argv
, "f:ht:b:dpq",
885 case OPTION_OBJECT
: {
887 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
893 case OPTION_IMAGE_OPTS
:
899 /* Progress is not shown in Quiet mode */
904 if (optind
!= argc
- 1) {
905 error_exit("Expecting one image file name");
907 filename
= argv
[optind
++];
909 if (qemu_opts_foreach(&qemu_object_opts
,
910 user_creatable_add_opts_foreach
,
915 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
916 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
918 error_report("Invalid cache option: %s", cache
);
922 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
928 qemu_progress_init(progress
, 1.f
);
929 qemu_progress_print(0.f
, 100);
932 base_bs
= bdrv_find_backing_image(bs
, base
);
934 error_setg(&local_err
,
935 "Did not find '%s' in the backing chain of '%s'",
940 /* This is different from QMP, which by default uses the deepest file in
941 * the backing chain (i.e., the very base); however, the traditional
942 * behavior of qemu-img commit is using the immediate backing file. */
943 base_bs
= backing_bs(bs
);
945 error_setg(&local_err
, "Image does not have a backing file");
950 cbi
= (CommonBlockJobCBInfo
){
955 aio_context
= bdrv_get_aio_context(bs
);
956 aio_context_acquire(aio_context
);
957 commit_active_start("commit", bs
, base_bs
, BLOCK_JOB_DEFAULT
, 0,
958 BLOCKDEV_ON_ERROR_REPORT
, common_block_job_cb
, &cbi
,
960 aio_context_release(aio_context
);
965 /* When the block job completes, the BlockBackend reference will point to
966 * the old backing file. In order to avoid that the top image is already
967 * deleted, so we can still empty it afterwards, increment the reference
968 * counter here preemptively. */
973 run_block_job(bs
->job
, &local_err
);
978 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
979 ret
= bs
->drv
->bdrv_make_empty(bs
);
981 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
998 error_report_err(local_err
);
1002 qprintf(quiet
, "Image committed.\n");
1007 * Returns true iff the first sector pointed to by 'buf' contains at least
1010 * 'pnum' is set to the number of sectors (including and immediately following
1011 * the first one) that are known to be in the same allocated/unallocated state.
1013 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
1022 is_zero
= buffer_is_zero(buf
, 512);
1023 for(i
= 1; i
< n
; i
++) {
1025 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1034 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1035 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1036 * breaking up write requests for only small sparse areas.
1038 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1042 int num_checked
, num_used
;
1048 ret
= is_allocated_sectors(buf
, n
, pnum
);
1054 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1056 num_checked
= num_used
;
1059 ret
= is_allocated_sectors(buf
, n
, pnum
);
1061 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1063 num_checked
+= *pnum
;
1065 num_used
= num_checked
;
1066 } else if (*pnum
>= min
) {
1076 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1077 * buffers matches, non-zero otherwise.
1079 * pnum is set to the number of sectors (including and immediately following
1080 * the first one) that are known to have the same comparison result
1082 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1093 res
= !!memcmp(buf1
, buf2
, 512);
1094 for(i
= 1; i
< n
; i
++) {
1098 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1107 #define IO_BUF_SIZE (2 * 1024 * 1024)
1109 static int64_t sectors_to_bytes(int64_t sectors
)
1111 return sectors
<< BDRV_SECTOR_BITS
;
1114 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1116 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1120 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1122 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1123 * data and negative value on error.
1125 * @param blk: BlockBackend for the image
1126 * @param sect_num: Number of first sector to check
1127 * @param sect_count: Number of sectors to check
1128 * @param filename: Name of disk file we are checking (logging purpose)
1129 * @param buffer: Allocated buffer for storing read data
1130 * @param quiet: Flag for quiet mode
1132 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1133 int sect_count
, const char *filename
,
1134 uint8_t *buffer
, bool quiet
)
1137 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1138 sect_count
<< BDRV_SECTOR_BITS
);
1140 error_report("Error while reading offset %" PRId64
" of %s: %s",
1141 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1144 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1145 if (ret
|| pnum
!= sect_count
) {
1146 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1147 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1155 * Compares two images. Exit codes:
1157 * 0 - Images are identical
1159 * >1 - Error occurred
1161 static int img_compare(int argc
, char **argv
)
1163 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1164 BlockBackend
*blk1
, *blk2
;
1165 BlockDriverState
*bs1
, *bs2
;
1166 int64_t total_sectors1
, total_sectors2
;
1167 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1169 int allocated1
, allocated2
;
1170 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1171 bool progress
= false, quiet
= false, strict
= false;
1174 int64_t total_sectors
;
1175 int64_t sector_num
= 0;
1178 uint64_t progress_base
;
1179 bool image_opts
= false;
1181 cache
= BDRV_DEFAULT_CACHE
;
1183 static const struct option long_options
[] = {
1184 {"help", no_argument
, 0, 'h'},
1185 {"object", required_argument
, 0, OPTION_OBJECT
},
1186 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1189 c
= getopt_long(argc
, argv
, "hf:F:T:pqs",
1190 long_options
, NULL
);
1217 case OPTION_OBJECT
: {
1219 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1226 case OPTION_IMAGE_OPTS
:
1232 /* Progress is not shown in Quiet mode */
1238 if (optind
!= argc
- 2) {
1239 error_exit("Expecting two image file names");
1241 filename1
= argv
[optind
++];
1242 filename2
= argv
[optind
++];
1244 if (qemu_opts_foreach(&qemu_object_opts
,
1245 user_creatable_add_opts_foreach
,
1251 /* Initialize before goto out */
1252 qemu_progress_init(progress
, 2.0);
1255 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1257 error_report("Invalid source cache option: %s", cache
);
1262 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
);
1268 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
);
1276 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1277 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1278 total_sectors1
= blk_nb_sectors(blk1
);
1279 if (total_sectors1
< 0) {
1280 error_report("Can't get size of %s: %s",
1281 filename1
, strerror(-total_sectors1
));
1285 total_sectors2
= blk_nb_sectors(blk2
);
1286 if (total_sectors2
< 0) {
1287 error_report("Can't get size of %s: %s",
1288 filename2
, strerror(-total_sectors2
));
1292 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1293 progress_base
= MAX(total_sectors1
, total_sectors2
);
1295 qemu_progress_print(0, 100);
1297 if (strict
&& total_sectors1
!= total_sectors2
) {
1299 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1304 int64_t status1
, status2
;
1305 BlockDriverState
*file
;
1307 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1308 if (nb_sectors
<= 0) {
1311 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1312 total_sectors1
- sector_num
,
1316 error_report("Sector allocation test failed for %s", filename1
);
1319 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1321 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1322 total_sectors2
- sector_num
,
1326 error_report("Sector allocation test failed for %s", filename2
);
1329 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1331 nb_sectors
= MIN(nb_sectors
, pnum1
);
1334 nb_sectors
= MIN(nb_sectors
, pnum2
);
1338 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1339 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1341 qprintf(quiet
, "Strict mode: Offset %" PRId64
1342 " block status mismatch!\n",
1343 sectors_to_bytes(sector_num
));
1347 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1348 nb_sectors
= MIN(pnum1
, pnum2
);
1349 } else if (allocated1
== allocated2
) {
1351 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1352 nb_sectors
<< BDRV_SECTOR_BITS
);
1354 error_report("Error while reading offset %" PRId64
" of %s:"
1355 " %s", sectors_to_bytes(sector_num
), filename1
,
1360 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1361 nb_sectors
<< BDRV_SECTOR_BITS
);
1363 error_report("Error while reading offset %" PRId64
1364 " of %s: %s", sectors_to_bytes(sector_num
),
1365 filename2
, strerror(-ret
));
1369 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1370 if (ret
|| pnum
!= nb_sectors
) {
1371 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1373 ret
? sector_num
: sector_num
+ pnum
));
1381 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1382 filename1
, buf1
, quiet
);
1384 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1385 filename2
, buf1
, quiet
);
1389 error_report("Error while reading offset %" PRId64
": %s",
1390 sectors_to_bytes(sector_num
), strerror(-ret
));
1396 sector_num
+= nb_sectors
;
1397 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1400 if (total_sectors1
!= total_sectors2
) {
1401 BlockBackend
*blk_over
;
1402 int64_t total_sectors_over
;
1403 const char *filename_over
;
1405 qprintf(quiet
, "Warning: Image size mismatch!\n");
1406 if (total_sectors1
> total_sectors2
) {
1407 total_sectors_over
= total_sectors1
;
1409 filename_over
= filename1
;
1411 total_sectors_over
= total_sectors2
;
1413 filename_over
= filename2
;
1417 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1418 if (nb_sectors
<= 0) {
1421 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1425 error_report("Sector allocation test failed for %s",
1432 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1433 filename_over
, buf1
, quiet
);
1436 error_report("Error while reading offset %" PRId64
1437 " of %s: %s", sectors_to_bytes(sector_num
),
1438 filename_over
, strerror(-ret
));
1444 sector_num
+= nb_sectors
;
1445 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1449 qprintf(quiet
, "Images are identical.\n");
1459 qemu_progress_end();
1464 enum ImgConvertBlockStatus
{
1470 #define MAX_COROUTINES 16
1472 typedef struct ImgConvertState
{
1474 int64_t *src_sectors
;
1476 int64_t total_sectors
;
1477 int64_t allocated_sectors
;
1478 int64_t allocated_done
;
1481 enum ImgConvertBlockStatus status
;
1482 int64_t sector_next_status
;
1483 BlockBackend
*target
;
1486 bool target_has_backing
;
1489 size_t cluster_sectors
;
1492 int running_coroutines
;
1493 Coroutine
*co
[MAX_COROUTINES
];
1494 int64_t wait_sector_num
[MAX_COROUTINES
];
1499 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
,
1500 int *src_cur
, int64_t *src_cur_offset
)
1503 *src_cur_offset
= 0;
1504 while (sector_num
- *src_cur_offset
>= s
->src_sectors
[*src_cur
]) {
1505 *src_cur_offset
+= s
->src_sectors
[*src_cur
];
1507 assert(*src_cur
< s
->src_num
);
1511 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1513 int64_t ret
, src_cur_offset
;
1516 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1518 assert(s
->total_sectors
> sector_num
);
1519 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1521 if (s
->sector_next_status
<= sector_num
) {
1522 BlockDriverState
*file
;
1523 ret
= bdrv_get_block_status(blk_bs(s
->src
[src_cur
]),
1524 sector_num
- src_cur_offset
,
1530 if (ret
& BDRV_BLOCK_ZERO
) {
1531 s
->status
= BLK_ZERO
;
1532 } else if (ret
& BDRV_BLOCK_DATA
) {
1533 s
->status
= BLK_DATA
;
1534 } else if (!s
->target_has_backing
) {
1535 /* Without a target backing file we must copy over the contents of
1536 * the backing file as well. */
1537 /* Check block status of the backing file chain to avoid
1538 * needlessly reading zeroes and limiting the iteration to the
1540 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[src_cur
]), NULL
,
1541 sector_num
- src_cur_offset
,
1547 if (ret
& BDRV_BLOCK_ZERO
) {
1548 s
->status
= BLK_ZERO
;
1550 s
->status
= BLK_DATA
;
1553 s
->status
= BLK_BACKING_FILE
;
1556 s
->sector_next_status
= sector_num
+ n
;
1559 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1560 if (s
->status
== BLK_DATA
) {
1561 n
= MIN(n
, s
->buf_sectors
);
1564 /* We need to write complete clusters for compressed images, so if an
1565 * unallocated area is shorter than that, we must consider the whole
1566 * cluster allocated. */
1567 if (s
->compressed
) {
1568 if (n
< s
->cluster_sectors
) {
1569 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1570 s
->status
= BLK_DATA
;
1572 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1579 static int coroutine_fn
convert_co_read(ImgConvertState
*s
, int64_t sector_num
,
1580 int nb_sectors
, uint8_t *buf
)
1586 assert(nb_sectors
<= s
->buf_sectors
);
1587 while (nb_sectors
> 0) {
1590 int64_t bs_sectors
, src_cur_offset
;
1592 /* In the case of compression with multiple source files, we can get a
1593 * nb_sectors that spreads into the next part. So we must be able to
1594 * read across multiple BDSes for one convert_read() call. */
1595 convert_select_part(s
, sector_num
, &src_cur
, &src_cur_offset
);
1596 blk
= s
->src
[src_cur
];
1597 bs_sectors
= s
->src_sectors
[src_cur
];
1599 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- src_cur_offset
));
1601 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1602 qemu_iovec_init_external(&qiov
, &iov
, 1);
1604 ret
= blk_co_preadv(
1605 blk
, (sector_num
- src_cur_offset
) << BDRV_SECTOR_BITS
,
1606 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1613 buf
+= n
* BDRV_SECTOR_SIZE
;
1620 static int coroutine_fn
convert_co_write(ImgConvertState
*s
, int64_t sector_num
,
1621 int nb_sectors
, uint8_t *buf
,
1622 enum ImgConvertBlockStatus status
)
1628 while (nb_sectors
> 0) {
1631 case BLK_BACKING_FILE
:
1632 /* If we have a backing file, leave clusters unallocated that are
1633 * unallocated in the source image, so that the backing file is
1634 * visible at the respective offset. */
1635 assert(s
->target_has_backing
);
1639 /* We must always write compressed clusters as a whole, so don't
1640 * try to find zeroed parts in the buffer. We can only save the
1641 * write if the buffer is completely zeroed and we're allowed to
1642 * keep the target sparse. */
1643 if (s
->compressed
) {
1644 if (s
->has_zero_init
&& s
->min_sparse
&&
1645 buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
))
1647 assert(!s
->target_has_backing
);
1652 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1653 qemu_iovec_init_external(&qiov
, &iov
, 1);
1655 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1656 n
<< BDRV_SECTOR_BITS
, &qiov
,
1657 BDRV_REQ_WRITE_COMPRESSED
);
1664 /* If there is real non-zero data or we're told to keep the target
1665 * fully allocated (-S 0), we must write it. Otherwise we can treat
1666 * it as zero sectors. */
1667 if (!s
->min_sparse
||
1668 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
))
1671 iov
.iov_len
= n
<< BDRV_SECTOR_BITS
;
1672 qemu_iovec_init_external(&qiov
, &iov
, 1);
1674 ret
= blk_co_pwritev(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1675 n
<< BDRV_SECTOR_BITS
, &qiov
, 0);
1684 if (s
->has_zero_init
) {
1687 ret
= blk_co_pwrite_zeroes(s
->target
,
1688 sector_num
<< BDRV_SECTOR_BITS
,
1689 n
<< BDRV_SECTOR_BITS
, 0);
1698 buf
+= n
* BDRV_SECTOR_SIZE
;
1704 static void coroutine_fn
convert_co_do_copy(void *opaque
)
1706 ImgConvertState
*s
= opaque
;
1707 uint8_t *buf
= NULL
;
1711 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1712 if (s
->co
[i
] == qemu_coroutine_self()) {
1719 s
->running_coroutines
++;
1720 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1725 enum ImgConvertBlockStatus status
;
1727 qemu_co_mutex_lock(&s
->lock
);
1728 if (s
->ret
!= -EINPROGRESS
|| s
->sector_num
>= s
->total_sectors
) {
1729 qemu_co_mutex_unlock(&s
->lock
);
1732 n
= convert_iteration_sectors(s
, s
->sector_num
);
1734 qemu_co_mutex_unlock(&s
->lock
);
1738 /* save current sector and allocation status to local variables */
1739 sector_num
= s
->sector_num
;
1741 if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1742 n
= MIN(n
, s
->buf_sectors
);
1744 /* increment global sector counter so that other coroutines can
1745 * already continue reading beyond this request */
1747 qemu_co_mutex_unlock(&s
->lock
);
1749 if (status
== BLK_DATA
|| (!s
->min_sparse
&& status
== BLK_ZERO
)) {
1750 s
->allocated_done
+= n
;
1751 qemu_progress_print(100.0 * s
->allocated_done
/
1752 s
->allocated_sectors
, 0);
1755 if (status
== BLK_DATA
) {
1756 ret
= convert_co_read(s
, sector_num
, n
, buf
);
1758 error_report("error while reading sector %" PRId64
1759 ": %s", sector_num
, strerror(-ret
));
1763 } else if (!s
->min_sparse
&& status
== BLK_ZERO
) {
1765 memset(buf
, 0x00, n
* BDRV_SECTOR_SIZE
);
1768 if (s
->wr_in_order
) {
1769 /* keep writes in order */
1770 while (s
->wr_offs
!= sector_num
) {
1771 if (s
->ret
!= -EINPROGRESS
) {
1774 s
->wait_sector_num
[index
] = sector_num
;
1775 qemu_coroutine_yield();
1777 s
->wait_sector_num
[index
] = -1;
1780 ret
= convert_co_write(s
, sector_num
, n
, buf
, status
);
1782 error_report("error while writing sector %" PRId64
1783 ": %s", sector_num
, strerror(-ret
));
1788 if (s
->wr_in_order
) {
1789 /* reenter the coroutine that might have waited
1790 * for this write to complete */
1791 s
->wr_offs
= sector_num
+ n
;
1792 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1793 if (s
->co
[i
] && s
->wait_sector_num
[i
] == s
->wr_offs
) {
1795 * A -> B -> A cannot occur because A has
1796 * s->wait_sector_num[i] == -1 during A -> B. Therefore
1797 * B will never enter A during this time window.
1799 qemu_coroutine_enter(s
->co
[i
]);
1808 s
->co
[index
] = NULL
;
1809 s
->running_coroutines
--;
1810 if (!s
->running_coroutines
&& s
->ret
== -EINPROGRESS
) {
1811 /* the convert job finished successfully */
1816 static int convert_do_copy(ImgConvertState
*s
)
1819 int64_t sector_num
= 0;
1821 /* Check whether we have zero initialisation or can get it efficiently */
1822 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1823 ? bdrv_has_zero_init(blk_bs(s
->target
))
1826 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1827 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1829 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1831 s
->has_zero_init
= true;
1835 /* Allocate buffer for copied data. For compressed images, only one cluster
1836 * can be copied at a time. */
1837 if (s
->compressed
) {
1838 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1839 error_report("invalid cluster size");
1842 s
->buf_sectors
= s
->cluster_sectors
;
1845 while (sector_num
< s
->total_sectors
) {
1846 n
= convert_iteration_sectors(s
, sector_num
);
1850 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1852 s
->allocated_sectors
+= n
;
1858 s
->sector_next_status
= 0;
1859 s
->ret
= -EINPROGRESS
;
1861 qemu_co_mutex_init(&s
->lock
);
1862 for (i
= 0; i
< s
->num_coroutines
; i
++) {
1863 s
->co
[i
] = qemu_coroutine_create(convert_co_do_copy
, s
);
1864 s
->wait_sector_num
[i
] = -1;
1865 qemu_coroutine_enter(s
->co
[i
]);
1868 while (s
->ret
== -EINPROGRESS
) {
1869 main_loop_wait(false);
1872 if (s
->compressed
&& !s
->ret
) {
1873 /* signal EOF to align */
1874 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1883 static int img_convert(int argc
, char **argv
)
1885 int c
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1887 int progress
= 0, flags
, src_flags
;
1888 bool writethrough
, src_writethrough
;
1889 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1890 BlockDriver
*drv
, *proto_drv
;
1891 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1892 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1893 int64_t total_sectors
;
1894 int64_t *bs_sectors
= NULL
;
1895 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1896 BlockDriverInfo bdi
;
1897 QemuOpts
*opts
= NULL
;
1898 QemuOptsList
*create_opts
= NULL
;
1899 const char *out_baseimg_param
;
1900 char *options
= NULL
;
1901 const char *snapshot_name
= NULL
;
1902 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1904 Error
*local_err
= NULL
;
1905 QemuOpts
*sn_opts
= NULL
;
1906 ImgConvertState state
;
1907 bool image_opts
= false;
1908 bool wr_in_order
= true;
1909 long num_coroutines
= 8;
1914 src_cache
= BDRV_DEFAULT_CACHE
;
1919 static const struct option long_options
[] = {
1920 {"help", no_argument
, 0, 'h'},
1921 {"object", required_argument
, 0, OPTION_OBJECT
},
1922 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1925 c
= getopt_long(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qnm:W",
1926 long_options
, NULL
);
1942 out_baseimg
= optarg
;
1948 error_report("option -e is deprecated, please use \'-o "
1949 "encryption\' instead!");
1953 error_report("option -6 is deprecated, please use \'-o "
1954 "compat6\' instead!");
1958 if (!is_valid_option_list(optarg
)) {
1959 error_report("Invalid option list: %s", optarg
);
1964 options
= g_strdup(optarg
);
1966 char *old_options
= options
;
1967 options
= g_strdup_printf("%s,%s", options
, optarg
);
1968 g_free(old_options
);
1972 snapshot_name
= optarg
;
1975 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1976 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
1979 error_report("Failed in parsing snapshot param '%s'",
1985 snapshot_name
= optarg
;
1992 sval
= cvtnum(optarg
);
1994 error_report("Invalid minimum zero buffer size for sparse output specified");
1999 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
2018 if (qemu_strtol(optarg
, NULL
, 0, &num_coroutines
) ||
2019 num_coroutines
< 1 || num_coroutines
> MAX_COROUTINES
) {
2020 error_report("Invalid number of coroutines. Allowed number of"
2021 " coroutines is between 1 and %d", MAX_COROUTINES
);
2027 wr_in_order
= false;
2030 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2036 case OPTION_IMAGE_OPTS
:
2042 if (qemu_opts_foreach(&qemu_object_opts
,
2043 user_creatable_add_opts_foreach
,
2048 if (!wr_in_order
&& compress
) {
2049 error_report("Out of order write and compress are mutually exclusive");
2054 /* Initialize before goto out */
2058 qemu_progress_init(progress
, 1.0);
2060 bs_n
= argc
- optind
- 1;
2061 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
2063 if (options
&& has_help_option(options
)) {
2064 ret
= print_block_option_help(out_filename
, out_fmt
);
2069 error_exit("Must specify image file name");
2073 if (bs_n
> 1 && out_baseimg
) {
2074 error_report("-B makes no sense when concatenating multiple input "
2081 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2083 error_report("Invalid source cache option: %s", src_cache
);
2087 qemu_progress_print(0, 100);
2089 blk
= g_new0(BlockBackend
*, bs_n
);
2090 bs
= g_new0(BlockDriverState
*, bs_n
);
2091 bs_sectors
= g_new(int64_t, bs_n
);
2094 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2095 blk
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
2096 fmt
, src_flags
, src_writethrough
, quiet
);
2101 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
2102 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
2103 if (bs_sectors
[bs_i
] < 0) {
2104 error_report("Could not get size of %s: %s",
2105 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
2109 total_sectors
+= bs_sectors
[bs_i
];
2113 bdrv_snapshot_load_tmp(bs
[0],
2114 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
2115 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
2117 } else if (snapshot_name
!= NULL
) {
2119 error_report("No support for concatenating multiple snapshot");
2124 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
2127 error_reportf_err(local_err
, "Failed to load snapshot: ");
2132 /* Find driver and parse its options */
2133 drv
= bdrv_find_format(out_fmt
);
2135 error_report("Unknown file format '%s'", out_fmt
);
2140 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
2142 error_report_err(local_err
);
2148 if (!drv
->create_opts
) {
2149 error_report("Format driver '%s' does not support image creation",
2155 if (!proto_drv
->create_opts
) {
2156 error_report("Protocol driver '%s' does not support image creation",
2157 proto_drv
->format_name
);
2162 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2163 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2165 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2167 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2169 error_report_err(local_err
);
2175 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
2177 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2183 /* Get backing file name if -o backing_file was used */
2184 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2185 if (out_baseimg_param
) {
2186 out_baseimg
= out_baseimg_param
;
2189 /* Check if compression is supported */
2192 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2193 const char *preallocation
=
2194 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2196 if (!drv
->bdrv_co_pwritev_compressed
) {
2197 error_report("Compression not supported for this file format");
2203 error_report("Compression and encryption not supported at "
2210 && strcmp(preallocation
, "off"))
2212 error_report("Compression and preallocation not supported at "
2220 /* Create the new image */
2221 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2223 error_reportf_err(local_err
, "%s: error while converting %s: ",
2224 out_filename
, out_fmt
);
2229 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2230 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2232 error_report("Invalid cache option: %s", cache
);
2236 /* XXX we should allow --image-opts to trigger use of
2237 * img_open() here, but then we have trouble with
2238 * the bdrv_create() call which takes different params.
2239 * Not critical right now, so fix can wait...
2241 out_blk
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
);
2246 out_bs
= blk_bs(out_blk
);
2248 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2249 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2251 bufsectors
= MIN(32768,
2253 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2254 out_bs
->bl
.pdiscard_alignment
>>
2255 BDRV_SECTOR_BITS
)));
2258 int64_t output_sectors
= blk_nb_sectors(out_blk
);
2259 if (output_sectors
< 0) {
2260 error_report("unable to get output image length: %s",
2261 strerror(-output_sectors
));
2264 } else if (output_sectors
< total_sectors
) {
2265 error_report("output file is smaller than input file");
2271 cluster_sectors
= 0;
2272 ret
= bdrv_get_info(out_bs
, &bdi
);
2275 error_report("could not get block driver info");
2279 compress
= compress
|| bdi
.needs_compressed_writes
;
2280 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2283 state
= (ImgConvertState
) {
2285 .src_sectors
= bs_sectors
,
2287 .total_sectors
= total_sectors
,
2289 .compressed
= compress
,
2290 .target_has_backing
= (bool) out_baseimg
,
2291 .min_sparse
= min_sparse
,
2292 .cluster_sectors
= cluster_sectors
,
2293 .buf_sectors
= bufsectors
,
2294 .wr_in_order
= wr_in_order
,
2295 .num_coroutines
= num_coroutines
,
2297 ret
= convert_do_copy(&state
);
2301 qemu_progress_print(100, 0);
2303 qemu_progress_end();
2304 qemu_opts_del(opts
);
2305 qemu_opts_free(create_opts
);
2306 qemu_opts_del(sn_opts
);
2310 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2311 blk_unref(blk
[bs_i
]);
2326 static void dump_snapshots(BlockDriverState
*bs
)
2328 QEMUSnapshotInfo
*sn_tab
, *sn
;
2331 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2334 printf("Snapshot list:\n");
2335 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2337 for(i
= 0; i
< nb_sns
; i
++) {
2339 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2345 static void dump_json_image_info_list(ImageInfoList
*list
)
2349 Visitor
*v
= qobject_output_visitor_new(&obj
);
2351 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2352 visit_complete(v
, &obj
);
2353 str
= qobject_to_json_pretty(obj
);
2354 assert(str
!= NULL
);
2355 printf("%s\n", qstring_get_str(str
));
2356 qobject_decref(obj
);
2361 static void dump_json_image_info(ImageInfo
*info
)
2365 Visitor
*v
= qobject_output_visitor_new(&obj
);
2367 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2368 visit_complete(v
, &obj
);
2369 str
= qobject_to_json_pretty(obj
);
2370 assert(str
!= NULL
);
2371 printf("%s\n", qstring_get_str(str
));
2372 qobject_decref(obj
);
2377 static void dump_human_image_info_list(ImageInfoList
*list
)
2379 ImageInfoList
*elem
;
2382 for (elem
= list
; elem
; elem
= elem
->next
) {
2388 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2392 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2394 return strcmp(a
, b
) == 0;
2398 * Open an image file chain and return an ImageInfoList
2400 * @filename: topmost image filename
2401 * @fmt: topmost image format (may be NULL to autodetect)
2402 * @chain: true - enumerate entire backing file chain
2403 * false - only topmost image file
2405 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2406 * image file. If there was an error a message will have been printed to
2409 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2410 const char *filename
,
2414 ImageInfoList
*head
= NULL
;
2415 ImageInfoList
**last
= &head
;
2416 GHashTable
*filenames
;
2419 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2423 BlockDriverState
*bs
;
2425 ImageInfoList
*elem
;
2427 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2428 error_report("Backing file '%s' creates an infinite loop.",
2432 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2434 blk
= img_open(image_opts
, filename
, fmt
,
2435 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false);
2441 bdrv_query_image_info(bs
, &info
, &err
);
2443 error_report_err(err
);
2448 elem
= g_new0(ImageInfoList
, 1);
2455 filename
= fmt
= NULL
;
2457 if (info
->has_full_backing_filename
) {
2458 filename
= info
->full_backing_filename
;
2459 } else if (info
->has_backing_filename
) {
2460 error_report("Could not determine absolute backing filename,"
2461 " but backing filename '%s' present",
2462 info
->backing_filename
);
2465 if (info
->has_backing_filename_format
) {
2466 fmt
= info
->backing_filename_format
;
2470 g_hash_table_destroy(filenames
);
2474 qapi_free_ImageInfoList(head
);
2475 g_hash_table_destroy(filenames
);
2479 static int img_info(int argc
, char **argv
)
2482 OutputFormat output_format
= OFORMAT_HUMAN
;
2484 const char *filename
, *fmt
, *output
;
2485 ImageInfoList
*list
;
2486 bool image_opts
= false;
2491 int option_index
= 0;
2492 static const struct option long_options
[] = {
2493 {"help", no_argument
, 0, 'h'},
2494 {"format", required_argument
, 0, 'f'},
2495 {"output", required_argument
, 0, OPTION_OUTPUT
},
2496 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2497 {"object", required_argument
, 0, OPTION_OBJECT
},
2498 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2501 c
= getopt_long(argc
, argv
, "f:h",
2502 long_options
, &option_index
);
2517 case OPTION_BACKING_CHAIN
:
2520 case OPTION_OBJECT
: {
2522 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2528 case OPTION_IMAGE_OPTS
:
2533 if (optind
!= argc
- 1) {
2534 error_exit("Expecting one image file name");
2536 filename
= argv
[optind
++];
2538 if (output
&& !strcmp(output
, "json")) {
2539 output_format
= OFORMAT_JSON
;
2540 } else if (output
&& !strcmp(output
, "human")) {
2541 output_format
= OFORMAT_HUMAN
;
2542 } else if (output
) {
2543 error_report("--output must be used with human or json as argument.");
2547 if (qemu_opts_foreach(&qemu_object_opts
,
2548 user_creatable_add_opts_foreach
,
2553 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
);
2558 switch (output_format
) {
2560 dump_human_image_info_list(list
);
2564 dump_json_image_info_list(list
);
2566 dump_json_image_info(list
->value
);
2571 qapi_free_ImageInfoList(list
);
2575 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2578 switch (output_format
) {
2580 if (e
->data
&& !e
->has_offset
) {
2581 error_report("File contains external, encrypted or compressed clusters.");
2584 if (e
->data
&& !e
->zero
) {
2585 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2586 e
->start
, e
->length
,
2587 e
->has_offset
? e
->offset
: 0,
2588 e
->has_filename
? e
->filename
: "");
2590 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2591 * Modify the flags here to allow more coalescing.
2593 if (next
&& (!next
->data
|| next
->zero
)) {
2599 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2600 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2601 (e
->start
== 0 ? "[" : ",\n"),
2602 e
->start
, e
->length
, e
->depth
,
2603 e
->zero
? "true" : "false",
2604 e
->data
? "true" : "false");
2605 if (e
->has_offset
) {
2606 printf(", \"offset\": %"PRId64
"", e
->offset
);
2617 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2618 int nb_sectors
, MapEntry
*e
)
2622 BlockDriverState
*file
;
2625 /* As an optimization, we could cache the current range of unallocated
2626 * clusters in each file of the chain, and avoid querying the same
2632 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2638 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2641 bs
= backing_bs(bs
);
2650 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2653 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2654 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2655 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2656 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2657 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2658 .has_offset
= has_offset
,
2660 .has_filename
= file
&& has_offset
,
2661 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2667 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2669 if (curr
->length
== 0) {
2672 if (curr
->zero
!= next
->zero
||
2673 curr
->data
!= next
->data
||
2674 curr
->depth
!= next
->depth
||
2675 curr
->has_filename
!= next
->has_filename
||
2676 curr
->has_offset
!= next
->has_offset
) {
2679 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2682 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2688 static int img_map(int argc
, char **argv
)
2691 OutputFormat output_format
= OFORMAT_HUMAN
;
2693 BlockDriverState
*bs
;
2694 const char *filename
, *fmt
, *output
;
2696 MapEntry curr
= { .length
= 0 }, next
;
2698 bool image_opts
= false;
2703 int option_index
= 0;
2704 static const struct option long_options
[] = {
2705 {"help", no_argument
, 0, 'h'},
2706 {"format", required_argument
, 0, 'f'},
2707 {"output", required_argument
, 0, OPTION_OUTPUT
},
2708 {"object", required_argument
, 0, OPTION_OBJECT
},
2709 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2712 c
= getopt_long(argc
, argv
, "f:h",
2713 long_options
, &option_index
);
2728 case OPTION_OBJECT
: {
2730 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2736 case OPTION_IMAGE_OPTS
:
2741 if (optind
!= argc
- 1) {
2742 error_exit("Expecting one image file name");
2744 filename
= argv
[optind
];
2746 if (output
&& !strcmp(output
, "json")) {
2747 output_format
= OFORMAT_JSON
;
2748 } else if (output
&& !strcmp(output
, "human")) {
2749 output_format
= OFORMAT_HUMAN
;
2750 } else if (output
) {
2751 error_report("--output must be used with human or json as argument.");
2755 if (qemu_opts_foreach(&qemu_object_opts
,
2756 user_creatable_add_opts_foreach
,
2761 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false);
2767 if (output_format
== OFORMAT_HUMAN
) {
2768 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2771 length
= blk_getlength(blk
);
2772 while (curr
.start
+ curr
.length
< length
) {
2773 int64_t nsectors_left
;
2777 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2779 /* Probe up to 1 GiB at a time. */
2780 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2781 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2782 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2785 error_report("Could not read file metadata: %s", strerror(-ret
));
2789 if (entry_mergeable(&curr
, &next
)) {
2790 curr
.length
+= next
.length
;
2794 if (curr
.length
> 0) {
2795 dump_map_entry(output_format
, &curr
, &next
);
2800 dump_map_entry(output_format
, &curr
, NULL
);
2807 #define SNAPSHOT_LIST 1
2808 #define SNAPSHOT_CREATE 2
2809 #define SNAPSHOT_APPLY 3
2810 #define SNAPSHOT_DELETE 4
2812 static int img_snapshot(int argc
, char **argv
)
2815 BlockDriverState
*bs
;
2816 QEMUSnapshotInfo sn
;
2817 char *filename
, *snapshot_name
= NULL
;
2818 int c
, ret
= 0, bdrv_oflags
;
2823 bool image_opts
= false;
2825 bdrv_oflags
= BDRV_O_RDWR
;
2826 /* Parse commandline parameters */
2828 static const struct option long_options
[] = {
2829 {"help", no_argument
, 0, 'h'},
2830 {"object", required_argument
, 0, OPTION_OBJECT
},
2831 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2834 c
= getopt_long(argc
, argv
, "la:c:d:hq",
2835 long_options
, NULL
);
2846 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2849 action
= SNAPSHOT_LIST
;
2850 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2854 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2857 action
= SNAPSHOT_APPLY
;
2858 snapshot_name
= optarg
;
2862 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2865 action
= SNAPSHOT_CREATE
;
2866 snapshot_name
= optarg
;
2870 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2873 action
= SNAPSHOT_DELETE
;
2874 snapshot_name
= optarg
;
2879 case OPTION_OBJECT
: {
2881 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2887 case OPTION_IMAGE_OPTS
:
2893 if (optind
!= argc
- 1) {
2894 error_exit("Expecting one image file name");
2896 filename
= argv
[optind
++];
2898 if (qemu_opts_foreach(&qemu_object_opts
,
2899 user_creatable_add_opts_foreach
,
2904 /* Open the image */
2905 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
);
2911 /* Perform the requested action */
2917 case SNAPSHOT_CREATE
:
2918 memset(&sn
, 0, sizeof(sn
));
2919 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2921 qemu_gettimeofday(&tv
);
2922 sn
.date_sec
= tv
.tv_sec
;
2923 sn
.date_nsec
= tv
.tv_usec
* 1000;
2925 ret
= bdrv_snapshot_create(bs
, &sn
);
2927 error_report("Could not create snapshot '%s': %d (%s)",
2928 snapshot_name
, ret
, strerror(-ret
));
2932 case SNAPSHOT_APPLY
:
2933 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2935 error_report("Could not apply snapshot '%s': %d (%s)",
2936 snapshot_name
, ret
, strerror(-ret
));
2940 case SNAPSHOT_DELETE
:
2941 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2943 error_reportf_err(err
, "Could not delete snapshot '%s': ",
2958 static int img_rebase(int argc
, char **argv
)
2960 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2961 uint8_t *buf_old
= NULL
;
2962 uint8_t *buf_new
= NULL
;
2963 BlockDriverState
*bs
= NULL
;
2965 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2966 int c
, flags
, src_flags
, ret
;
2967 bool writethrough
, src_writethrough
;
2971 Error
*local_err
= NULL
;
2972 bool image_opts
= false;
2974 /* Parse commandline parameters */
2976 cache
= BDRV_DEFAULT_CACHE
;
2977 src_cache
= BDRV_DEFAULT_CACHE
;
2981 static const struct option long_options
[] = {
2982 {"help", no_argument
, 0, 'h'},
2983 {"object", required_argument
, 0, OPTION_OBJECT
},
2984 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2987 c
= getopt_long(argc
, argv
, "hf:F:b:upt:T:q",
2988 long_options
, NULL
);
3001 out_basefmt
= optarg
;
3004 out_baseimg
= optarg
;
3021 case OPTION_OBJECT
: {
3023 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3029 case OPTION_IMAGE_OPTS
:
3039 if (optind
!= argc
- 1) {
3040 error_exit("Expecting one image file name");
3042 if (!unsafe
&& !out_baseimg
) {
3043 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3045 filename
= argv
[optind
++];
3047 if (qemu_opts_foreach(&qemu_object_opts
,
3048 user_creatable_add_opts_foreach
,
3053 qemu_progress_init(progress
, 2.0);
3054 qemu_progress_print(0, 100);
3056 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
3057 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3059 error_report("Invalid cache option: %s", cache
);
3064 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
3066 error_report("Invalid source cache option: %s", src_cache
);
3070 /* The source files are opened read-only, don't care about WCE */
3071 assert((src_flags
& BDRV_O_RDWR
) == 0);
3072 (void) src_writethrough
;
3077 * Ignore the old backing file for unsafe rebase in case we want to correct
3078 * the reference to a renamed or moved backing file.
3080 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3087 if (out_basefmt
!= NULL
) {
3088 if (bdrv_find_format(out_basefmt
) == NULL
) {
3089 error_report("Invalid format name: '%s'", out_basefmt
);
3095 /* For safe rebasing we need to compare old and new backing file */
3097 char backing_name
[PATH_MAX
];
3098 QDict
*options
= NULL
;
3100 if (bs
->backing_format
[0] != '\0') {
3101 options
= qdict_new();
3102 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
3105 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3106 blk_old_backing
= blk_new_open(backing_name
, NULL
,
3107 options
, src_flags
, &local_err
);
3108 if (!blk_old_backing
) {
3109 error_reportf_err(local_err
,
3110 "Could not open old backing file '%s': ",
3116 if (out_baseimg
[0]) {
3118 options
= qdict_new();
3119 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
3124 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
3125 options
, src_flags
, &local_err
);
3126 if (!blk_new_backing
) {
3127 error_reportf_err(local_err
,
3128 "Could not open new backing file '%s': ",
3137 * Check each unallocated cluster in the COW file. If it is unallocated,
3138 * accesses go to the backing file. We must therefore compare this cluster
3139 * in the old and new backing file, and if they differ we need to copy it
3140 * from the old backing file into the COW file.
3142 * If qemu-img crashes during this step, no harm is done. The content of
3143 * the image is the same as the original one at any time.
3146 int64_t num_sectors
;
3147 int64_t old_backing_num_sectors
;
3148 int64_t new_backing_num_sectors
= 0;
3151 float local_progress
= 0;
3153 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
3154 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3156 num_sectors
= blk_nb_sectors(blk
);
3157 if (num_sectors
< 0) {
3158 error_report("Could not get size of '%s': %s",
3159 filename
, strerror(-num_sectors
));
3163 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3164 if (old_backing_num_sectors
< 0) {
3165 char backing_name
[PATH_MAX
];
3167 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3168 error_report("Could not get size of '%s': %s",
3169 backing_name
, strerror(-old_backing_num_sectors
));
3173 if (blk_new_backing
) {
3174 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3175 if (new_backing_num_sectors
< 0) {
3176 error_report("Could not get size of '%s': %s",
3177 out_baseimg
, strerror(-new_backing_num_sectors
));
3183 if (num_sectors
!= 0) {
3184 local_progress
= (float)100 /
3185 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3188 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3190 /* How many sectors can we handle with the next read? */
3191 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3192 n
= (IO_BUF_SIZE
/ 512);
3194 n
= num_sectors
- sector
;
3197 /* If the cluster is allocated, we don't need to take action */
3198 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3200 error_report("error while reading image metadata: %s",
3209 * Read old and new backing file and take into consideration that
3210 * backing files may be smaller than the COW image.
3212 if (sector
>= old_backing_num_sectors
) {
3213 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3215 if (sector
+ n
> old_backing_num_sectors
) {
3216 n
= old_backing_num_sectors
- sector
;
3219 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3220 buf_old
, n
<< BDRV_SECTOR_BITS
);
3222 error_report("error while reading from old backing file");
3227 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3228 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3230 if (sector
+ n
> new_backing_num_sectors
) {
3231 n
= new_backing_num_sectors
- sector
;
3234 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3235 buf_new
, n
<< BDRV_SECTOR_BITS
);
3237 error_report("error while reading from new backing file");
3242 /* If they differ, we need to write to the COW file */
3243 uint64_t written
= 0;
3245 while (written
< n
) {
3248 if (compare_sectors(buf_old
+ written
* 512,
3249 buf_new
+ written
* 512, n
- written
, &pnum
))
3251 ret
= blk_pwrite(blk
,
3252 (sector
+ written
) << BDRV_SECTOR_BITS
,
3253 buf_old
+ written
* 512,
3254 pnum
<< BDRV_SECTOR_BITS
, 0);
3256 error_report("Error while writing to COW image: %s",
3264 qemu_progress_print(local_progress
, 100);
3269 * Change the backing file. All clusters that are different from the old
3270 * backing file are overwritten in the COW file now, so the visible content
3271 * doesn't change when we switch the backing file.
3273 if (out_baseimg
&& *out_baseimg
) {
3274 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3276 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3279 if (ret
== -ENOSPC
) {
3280 error_report("Could not change the backing file to '%s': No "
3281 "space left in the file header", out_baseimg
);
3282 } else if (ret
< 0) {
3283 error_report("Could not change the backing file to '%s': %s",
3284 out_baseimg
, strerror(-ret
));
3287 qemu_progress_print(100, 0);
3289 * TODO At this point it is possible to check if any clusters that are
3290 * allocated in the COW file are the same in the backing file. If so, they
3291 * could be dropped from the COW file. Don't do this before switching the
3292 * backing file, in case of a crash this would lead to corruption.
3295 qemu_progress_end();
3298 blk_unref(blk_old_backing
);
3299 blk_unref(blk_new_backing
);
3301 qemu_vfree(buf_old
);
3302 qemu_vfree(buf_new
);
3311 static int img_resize(int argc
, char **argv
)
3314 int c
, ret
, relative
;
3315 const char *filename
, *fmt
, *size
;
3316 int64_t n
, total_size
;
3318 BlockBackend
*blk
= NULL
;
3321 static QemuOptsList resize_options
= {
3322 .name
= "resize_options",
3323 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3326 .name
= BLOCK_OPT_SIZE
,
3327 .type
= QEMU_OPT_SIZE
,
3328 .help
= "Virtual disk size"
3334 bool image_opts
= false;
3336 /* Remove size from argv manually so that negative numbers are not treated
3337 * as options by getopt. */
3339 error_exit("Not enough arguments");
3343 size
= argv
[--argc
];
3345 /* Parse getopt arguments */
3348 static const struct option long_options
[] = {
3349 {"help", no_argument
, 0, 'h'},
3350 {"object", required_argument
, 0, OPTION_OBJECT
},
3351 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3354 c
= getopt_long(argc
, argv
, "f:hq",
3355 long_options
, NULL
);
3370 case OPTION_OBJECT
: {
3372 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3378 case OPTION_IMAGE_OPTS
:
3383 if (optind
!= argc
- 1) {
3384 error_exit("Expecting one image file name");
3386 filename
= argv
[optind
++];
3388 if (qemu_opts_foreach(&qemu_object_opts
,
3389 user_creatable_add_opts_foreach
,
3394 /* Choose grow, shrink, or absolute resize mode */
3410 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3411 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3413 error_report_err(err
);
3415 qemu_opts_del(param
);
3418 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3419 qemu_opts_del(param
);
3421 blk
= img_open(image_opts
, filename
, fmt
,
3422 BDRV_O_RDWR
| BDRV_O_RESIZE
, false, quiet
);
3429 total_size
= blk_getlength(blk
) + n
* relative
;
3433 if (total_size
<= 0) {
3434 error_report("New image size must be positive");
3439 ret
= blk_truncate(blk
, total_size
);
3442 qprintf(quiet
, "Image resized.\n");
3445 error_report("This image does not support resize");
3448 error_report("Image is read-only");
3451 error_report("Error resizing image: %s", strerror(-ret
));
3462 static void amend_status_cb(BlockDriverState
*bs
,
3463 int64_t offset
, int64_t total_work_size
,
3466 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3469 static int img_amend(int argc
, char **argv
)
3473 char *options
= NULL
;
3474 QemuOptsList
*create_opts
= NULL
;
3475 QemuOpts
*opts
= NULL
;
3476 const char *fmt
= NULL
, *filename
, *cache
;
3479 bool quiet
= false, progress
= false;
3480 BlockBackend
*blk
= NULL
;
3481 BlockDriverState
*bs
= NULL
;
3482 bool image_opts
= false;
3484 cache
= BDRV_DEFAULT_CACHE
;
3486 static const struct option long_options
[] = {
3487 {"help", no_argument
, 0, 'h'},
3488 {"object", required_argument
, 0, OPTION_OBJECT
},
3489 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3492 c
= getopt_long(argc
, argv
, "ho:f:t:pq",
3493 long_options
, NULL
);
3504 if (!is_valid_option_list(optarg
)) {
3505 error_report("Invalid option list: %s", optarg
);
3507 goto out_no_progress
;
3510 options
= g_strdup(optarg
);
3512 char *old_options
= options
;
3513 options
= g_strdup_printf("%s,%s", options
, optarg
);
3514 g_free(old_options
);
3530 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3534 goto out_no_progress
;
3537 case OPTION_IMAGE_OPTS
:
3544 error_exit("Must specify options (-o)");
3547 if (qemu_opts_foreach(&qemu_object_opts
,
3548 user_creatable_add_opts_foreach
,
3551 goto out_no_progress
;
3557 qemu_progress_init(progress
, 1.0);
3559 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3560 if (fmt
&& has_help_option(options
)) {
3561 /* If a format is explicitly specified (and possibly no filename is
3562 * given), print option help here */
3563 ret
= print_block_option_help(filename
, fmt
);
3567 if (optind
!= argc
- 1) {
3568 error_report("Expecting one image file name");
3573 flags
= BDRV_O_RDWR
;
3574 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3576 error_report("Invalid cache option: %s", cache
);
3580 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3587 fmt
= bs
->drv
->format_name
;
3589 if (has_help_option(options
)) {
3590 /* If the format was auto-detected, print option help here */
3591 ret
= print_block_option_help(filename
, fmt
);
3595 if (!bs
->drv
->create_opts
) {
3596 error_report("Format driver '%s' does not support any options to amend",
3602 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3603 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3604 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3606 error_report_err(err
);
3611 /* In case the driver does not call amend_status_cb() */
3612 qemu_progress_print(0.f
, 0);
3613 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3614 qemu_progress_print(100.f
, 0);
3616 error_report("Error while amending options: %s", strerror(-ret
));
3621 qemu_progress_end();
3625 qemu_opts_del(opts
);
3626 qemu_opts_free(create_opts
);
3635 typedef struct BenchData
{
3637 uint64_t image_size
;
3644 bool drain_on_flush
;
3653 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3656 error_report("Failed flush request: %s", strerror(-ret
));
3661 static void bench_cb(void *opaque
, int ret
)
3663 BenchData
*b
= opaque
;
3667 error_report("Failed request: %s", strerror(-ret
));
3672 /* Just finished a flush with drained queue: Start next requests */
3673 assert(b
->in_flight
== 0);
3674 b
->in_flush
= false;
3675 } else if (b
->in_flight
> 0) {
3676 int remaining
= b
->n
- b
->in_flight
;
3681 /* Time for flush? Drain queue if requested, then flush */
3682 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3683 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3684 BlockCompletionFunc
*cb
;
3686 if (b
->drain_on_flush
) {
3690 cb
= bench_undrained_flush_cb
;
3693 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3695 error_report("Failed to issue flush request");
3699 if (b
->drain_on_flush
) {
3705 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3706 int64_t offset
= b
->offset
;
3707 /* blk_aio_* might look for completed I/Os and kick bench_cb
3708 * again, so make sure this operation is counted by in_flight
3709 * and b->offset is ready for the next submission.
3712 b
->offset
+= b
->step
;
3713 b
->offset
%= b
->image_size
;
3715 acb
= blk_aio_pwritev(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3717 acb
= blk_aio_preadv(b
->blk
, offset
, b
->qiov
, 0, bench_cb
, b
);
3720 error_report("Failed to issue request");
3726 static int img_bench(int argc
, char **argv
)
3729 const char *fmt
= NULL
, *filename
;
3731 bool image_opts
= false;
3732 bool is_write
= false;
3736 size_t bufsize
= 4096;
3739 int flush_interval
= 0;
3740 bool drain_on_flush
= true;
3742 BlockBackend
*blk
= NULL
;
3743 BenchData data
= {};
3745 bool writethrough
= false;
3746 struct timeval t1
, t2
;
3750 static const struct option long_options
[] = {
3751 {"help", no_argument
, 0, 'h'},
3752 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3753 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3754 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3755 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3758 c
= getopt_long(argc
, argv
, "hc:d:f:no:qs:S:t:w", long_options
, NULL
);
3772 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3773 error_report("Invalid request count specified");
3783 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3784 error_report("Invalid queue depth specified");
3794 flags
|= BDRV_O_NATIVE_AIO
;
3798 offset
= cvtnum(optarg
);
3800 error_report("Invalid offset specified");
3813 sval
= cvtnum(optarg
);
3814 if (sval
< 0 || sval
> INT_MAX
) {
3815 error_report("Invalid buffer size specified");
3826 sval
= cvtnum(optarg
);
3827 if (sval
< 0 || sval
> INT_MAX
) {
3828 error_report("Invalid step size specified");
3836 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3838 error_report("Invalid cache mode");
3844 flags
|= BDRV_O_RDWR
;
3847 case OPTION_PATTERN
:
3851 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> 0xff) {
3852 error_report("Invalid pattern byte specified");
3858 case OPTION_FLUSH_INTERVAL
:
3862 if (qemu_strtoul(optarg
, NULL
, 0, &res
) < 0 || res
> INT_MAX
) {
3863 error_report("Invalid flush interval specified");
3866 flush_interval
= res
;
3869 case OPTION_NO_DRAIN
:
3870 drain_on_flush
= false;
3872 case OPTION_IMAGE_OPTS
:
3878 if (optind
!= argc
- 1) {
3879 error_exit("Expecting one image file name");
3881 filename
= argv
[argc
- 1];
3883 if (!is_write
&& flush_interval
) {
3884 error_report("--flush-interval is only available in write tests");
3888 if (flush_interval
&& flush_interval
< depth
) {
3889 error_report("Flush interval can't be smaller than depth");
3894 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3900 image_size
= blk_getlength(blk
);
3901 if (image_size
< 0) {
3906 data
= (BenchData
) {
3908 .image_size
= image_size
,
3910 .step
= step
?: bufsize
,
3915 .flush_interval
= flush_interval
,
3916 .drain_on_flush
= drain_on_flush
,
3918 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3919 "(starting at offset %" PRId64
", step size %d)\n",
3920 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
3921 data
.offset
, data
.step
);
3922 if (flush_interval
) {
3923 printf("Sending flush every %d requests\n", flush_interval
);
3926 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
3927 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
3929 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
3930 for (i
= 0; i
< data
.nrreq
; i
++) {
3931 qemu_iovec_init(&data
.qiov
[i
], 1);
3932 qemu_iovec_add(&data
.qiov
[i
],
3933 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
3936 gettimeofday(&t1
, NULL
);
3939 while (data
.n
> 0) {
3940 main_loop_wait(false);
3942 gettimeofday(&t2
, NULL
);
3944 printf("Run completed in %3.3f seconds.\n",
3945 (t2
.tv_sec
- t1
.tv_sec
)
3946 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
3949 qemu_vfree(data
.buf
);
3970 int bsz
; /* Block size */
3978 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
3982 static int img_dd_bs(const char *arg
,
3983 struct DdIo
*in
, struct DdIo
*out
,
3990 if (res
<= 0 || res
> INT_MAX
) {
3991 error_report("invalid number: '%s'", arg
);
3994 in
->bsz
= out
->bsz
= res
;
3999 static int img_dd_count(const char *arg
,
4000 struct DdIo
*in
, struct DdIo
*out
,
4003 dd
->count
= cvtnum(arg
);
4005 if (dd
->count
< 0) {
4006 error_report("invalid number: '%s'", arg
);
4013 static int img_dd_if(const char *arg
,
4014 struct DdIo
*in
, struct DdIo
*out
,
4017 in
->filename
= g_strdup(arg
);
4022 static int img_dd_of(const char *arg
,
4023 struct DdIo
*in
, struct DdIo
*out
,
4026 out
->filename
= g_strdup(arg
);
4031 static int img_dd_skip(const char *arg
,
4032 struct DdIo
*in
, struct DdIo
*out
,
4035 in
->offset
= cvtnum(arg
);
4037 if (in
->offset
< 0) {
4038 error_report("invalid number: '%s'", arg
);
4045 static int img_dd(int argc
, char **argv
)
4050 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
4051 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
4052 QemuOpts
*opts
= NULL
;
4053 QemuOptsList
*create_opts
= NULL
;
4054 Error
*local_err
= NULL
;
4055 bool image_opts
= false;
4057 const char *out_fmt
= "raw";
4058 const char *fmt
= NULL
;
4060 int64_t block_count
= 0, out_pos
, in_pos
;
4061 struct DdInfo dd
= {
4066 .bsz
= 512, /* Block size is by default 512 bytes */
4078 const struct DdOpts options
[] = {
4079 { "bs", img_dd_bs
, C_BS
},
4080 { "count", img_dd_count
, C_COUNT
},
4081 { "if", img_dd_if
, C_IF
},
4082 { "of", img_dd_of
, C_OF
},
4083 { "skip", img_dd_skip
, C_SKIP
},
4086 const struct option long_options
[] = {
4087 { "help", no_argument
, 0, 'h'},
4088 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
4092 while ((c
= getopt_long(argc
, argv
, "hf:O:", long_options
, NULL
))) {
4104 error_report("Try 'qemu-img --help' for more information.");
4110 case OPTION_IMAGE_OPTS
:
4116 for (i
= optind
; i
< argc
; i
++) {
4118 arg
= g_strdup(argv
[i
]);
4120 tmp
= strchr(arg
, '=');
4122 error_report("unrecognized operand %s", arg
);
4129 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
4130 if (!strcmp(arg
, options
[j
].name
)) {
4134 if (options
[j
].name
== NULL
) {
4135 error_report("unrecognized operand %s", arg
);
4140 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
4144 dd
.flags
|= options
[j
].flag
;
4149 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
4150 error_report("Must specify both input and output files");
4154 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false);
4161 drv
= bdrv_find_format(out_fmt
);
4163 error_report("Unknown file format");
4167 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4170 error_report_err(local_err
);
4174 if (!drv
->create_opts
) {
4175 error_report("Format driver '%s' does not support image creation",
4180 if (!proto_drv
->create_opts
) {
4181 error_report("Protocol driver '%s' does not support image creation",
4182 proto_drv
->format_name
);
4186 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4187 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4189 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4191 size
= blk_getlength(blk1
);
4193 error_report("Failed to get size for '%s'", in
.filename
);
4198 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4199 dd
.count
* in
.bsz
< size
) {
4200 size
= dd
.count
* in
.bsz
;
4203 /* Overflow means the specified offset is beyond input image's size */
4204 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4205 size
< in
.bsz
* in
.offset
)) {
4206 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, 0, &error_abort
);
4208 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
,
4209 size
- in
.bsz
* in
.offset
, &error_abort
);
4212 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4214 error_reportf_err(local_err
,
4215 "%s: error while creating output image: ",
4221 blk2
= img_open(image_opts
, out
.filename
, out_fmt
, BDRV_O_RDWR
,
4229 if (dd
.flags
& C_SKIP
&& (in
.offset
> INT64_MAX
/ in
.bsz
||
4230 size
< in
.offset
* in
.bsz
)) {
4231 /* We give a warning if the skip option is bigger than the input
4232 * size and create an empty output disk image (i.e. like dd(1)).
4234 error_report("%s: cannot skip to specified offset", in
.filename
);
4237 in_pos
= in
.offset
* in
.bsz
;
4240 in
.buf
= g_new(uint8_t, in
.bsz
);
4242 for (out_pos
= 0; in_pos
< size
; block_count
++) {
4243 int in_ret
, out_ret
;
4245 if (in_pos
+ in
.bsz
> size
) {
4246 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4248 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4251 error_report("error while reading from input image file: %s",
4258 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4261 error_report("error while writing to output image file: %s",
4262 strerror(-out_ret
));
4271 qemu_opts_del(opts
);
4272 qemu_opts_free(create_opts
);
4275 g_free(in
.filename
);
4276 g_free(out
.filename
);
4287 static const img_cmd_t img_cmds
[] = {
4288 #define DEF(option, callback, arg_string) \
4289 { option, callback },
4290 #include "qemu-img-cmds.h"
4296 int main(int argc
, char **argv
)
4298 const img_cmd_t
*cmd
;
4299 const char *cmdname
;
4300 Error
*local_error
= NULL
;
4301 char *trace_file
= NULL
;
4303 static const struct option long_options
[] = {
4304 {"help", no_argument
, 0, 'h'},
4305 {"version", no_argument
, 0, 'V'},
4306 {"trace", required_argument
, NULL
, 'T'},
4311 signal(SIGPIPE
, SIG_IGN
);
4314 module_call_init(MODULE_INIT_TRACE
);
4315 error_set_progname(argv
[0]);
4316 qemu_init_exec_dir(argv
[0]);
4318 if (qemu_init_main_loop(&local_error
)) {
4319 error_report_err(local_error
);
4323 qcrypto_init(&error_fatal
);
4325 module_call_init(MODULE_INIT_QOM
);
4328 error_exit("Not enough arguments");
4331 qemu_add_opts(&qemu_object_opts
);
4332 qemu_add_opts(&qemu_source_opts
);
4333 qemu_add_opts(&qemu_trace_opts
);
4335 while ((c
= getopt_long(argc
, argv
, "+hVT:", long_options
, NULL
)) != -1) {
4341 printf(QEMU_IMG_VERSION
);
4345 trace_file
= trace_opt_parse(optarg
);
4350 cmdname
= argv
[optind
];
4352 /* reset getopt_long scanning */
4360 if (!trace_init_backends()) {
4363 trace_init_file(trace_file
);
4364 qemu_set_log(LOG_TRACE
);
4366 /* find the command */
4367 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4368 if (!strcmp(cmdname
, cmd
->name
)) {
4369 return cmd
->handler(argc
, argv
);
4374 error_exit("Command not found: %s", cmdname
);