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/qmp-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 ", " 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 snapshot subcommand:\n"
160 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
161 " '-a' applies a snapshot (revert disk to saved state)\n"
162 " '-c' creates a snapshot\n"
163 " '-d' deletes a snapshot\n"
164 " '-l' lists all snapshots in the given image\n"
166 "Parameters to compare subcommand:\n"
167 " '-f' first image format\n"
168 " '-F' second image format\n"
169 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
171 "Parameters to dd subcommand:\n"
172 " 'bs=BYTES' read and write up to BYTES bytes at a time "
174 " 'count=N' copy only N input blocks\n"
175 " 'if=FILE' read from FILE\n"
176 " 'of=FILE' write to FILE\n";
178 printf("%s\nSupported formats:", help_msg
);
179 bdrv_iterate_format(format_print
, NULL
);
184 static QemuOptsList qemu_object_opts
= {
186 .implied_opt_name
= "qom-type",
187 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
193 static QemuOptsList qemu_source_opts
= {
195 .implied_opt_name
= "file",
196 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
202 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
208 ret
= vprintf(fmt
, args
);
215 static int print_block_option_help(const char *filename
, const char *fmt
)
217 BlockDriver
*drv
, *proto_drv
;
218 QemuOptsList
*create_opts
= NULL
;
219 Error
*local_err
= NULL
;
221 /* Find driver and parse its options */
222 drv
= bdrv_find_format(fmt
);
224 error_report("Unknown file format '%s'", fmt
);
228 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
230 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
232 error_report_err(local_err
);
233 qemu_opts_free(create_opts
);
236 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
239 qemu_opts_print_help(create_opts
);
240 qemu_opts_free(create_opts
);
245 static int img_open_password(BlockBackend
*blk
, const char *filename
,
246 int flags
, bool quiet
)
248 BlockDriverState
*bs
;
252 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
253 !(flags
& BDRV_O_NO_IO
)) {
254 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
255 if (qemu_read_password(password
, sizeof(password
)) < 0) {
256 error_report("No password given");
259 if (bdrv_set_key(bs
, password
) < 0) {
260 error_report("invalid password");
268 static BlockBackend
*img_open_opts(const char *optstr
,
269 QemuOpts
*opts
, int flags
, bool writethrough
,
273 Error
*local_err
= NULL
;
275 options
= qemu_opts_to_qdict(opts
, NULL
);
276 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
278 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
281 blk_set_enable_write_cache(blk
, !writethrough
);
283 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
290 static BlockBackend
*img_open_file(const char *filename
,
291 const char *fmt
, int flags
,
292 bool writethrough
, bool quiet
)
295 Error
*local_err
= NULL
;
296 QDict
*options
= NULL
;
299 options
= qdict_new();
300 qdict_put(options
, "driver", qstring_from_str(fmt
));
303 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
305 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
308 blk_set_enable_write_cache(blk
, !writethrough
);
310 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
318 static BlockBackend
*img_open(bool image_opts
,
319 const char *filename
,
320 const char *fmt
, int flags
, bool writethrough
,
327 error_report("--image-opts and --format are mutually exclusive");
330 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
335 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
);
337 blk
= img_open_file(filename
, fmt
, flags
, writethrough
, quiet
);
343 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
344 const char *base_filename
,
345 const char *base_fmt
)
350 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
352 error_report("Backing file not supported for file format '%s'",
359 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
361 error_report("Backing file format not supported for file "
370 static int img_create(int argc
, char **argv
)
373 uint64_t img_size
= -1;
374 const char *fmt
= "raw";
375 const char *base_fmt
= NULL
;
376 const char *filename
;
377 const char *base_filename
= NULL
;
378 char *options
= NULL
;
379 Error
*local_err
= NULL
;
383 static const struct option long_options
[] = {
384 {"help", no_argument
, 0, 'h'},
385 {"object", required_argument
, 0, OPTION_OBJECT
},
388 c
= getopt_long(argc
, argv
, "F:b:f:he6o:q",
402 base_filename
= optarg
;
408 error_report("option -e is deprecated, please use \'-o "
409 "encryption\' instead!");
412 error_report("option -6 is deprecated, please use \'-o "
413 "compat6\' instead!");
416 if (!is_valid_option_list(optarg
)) {
417 error_report("Invalid option list: %s", optarg
);
421 options
= g_strdup(optarg
);
423 char *old_options
= options
;
424 options
= g_strdup_printf("%s,%s", options
, optarg
);
431 case OPTION_OBJECT
: {
433 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
442 /* Get the filename */
443 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
444 if (options
&& has_help_option(options
)) {
446 return print_block_option_help(filename
, fmt
);
449 if (optind
>= argc
) {
450 error_exit("Expecting image file name");
454 if (qemu_opts_foreach(&qemu_object_opts
,
455 user_creatable_add_opts_foreach
,
460 /* Get image size, if specified */
464 sval
= qemu_strtosz_suffix(argv
[optind
++], &end
,
465 QEMU_STRTOSZ_DEFSUFFIX_B
);
466 if (sval
< 0 || *end
) {
467 if (sval
== -ERANGE
) {
468 error_report("Image size must be less than 8 EiB!");
470 error_report("Invalid image size specified! You may use k, M, "
471 "G, T, P or E suffixes for ");
472 error_report("kilobytes, megabytes, gigabytes, terabytes, "
473 "petabytes and exabytes.");
477 img_size
= (uint64_t)sval
;
479 if (optind
!= argc
) {
480 error_exit("Unexpected argument: %s", argv
[optind
]);
483 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
484 options
, img_size
, 0, &local_err
, quiet
);
486 error_reportf_err(local_err
, "%s: ", filename
);
498 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
502 Visitor
*v
= qmp_output_visitor_new(&obj
);
504 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
505 visit_complete(v
, &obj
);
506 str
= qobject_to_json_pretty(obj
);
508 qprintf(quiet
, "%s\n", qstring_get_str(str
));
514 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
516 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
517 qprintf(quiet
, "No errors were found on the image.\n");
519 if (check
->corruptions
) {
520 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
521 "Data may be corrupted, or further writes to the image "
528 "\n%" PRId64
" leaked clusters were found on the image.\n"
529 "This means waste of disk space, but no harm to data.\n",
533 if (check
->check_errors
) {
536 " internal errors have occurred during the check.\n",
537 check
->check_errors
);
541 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
542 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
543 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
544 check
->allocated_clusters
, check
->total_clusters
,
545 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
546 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
547 check
->compressed_clusters
* 100.0 /
548 check
->allocated_clusters
);
551 if (check
->image_end_offset
) {
553 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
557 static int collect_image_check(BlockDriverState
*bs
,
559 const char *filename
,
564 BdrvCheckResult result
;
566 ret
= bdrv_check(bs
, &result
, fix
);
571 check
->filename
= g_strdup(filename
);
572 check
->format
= g_strdup(bdrv_get_format_name(bs
));
573 check
->check_errors
= result
.check_errors
;
574 check
->corruptions
= result
.corruptions
;
575 check
->has_corruptions
= result
.corruptions
!= 0;
576 check
->leaks
= result
.leaks
;
577 check
->has_leaks
= result
.leaks
!= 0;
578 check
->corruptions_fixed
= result
.corruptions_fixed
;
579 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
580 check
->leaks_fixed
= result
.leaks_fixed
;
581 check
->has_leaks_fixed
= result
.leaks
!= 0;
582 check
->image_end_offset
= result
.image_end_offset
;
583 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
584 check
->total_clusters
= result
.bfi
.total_clusters
;
585 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
586 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
587 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
588 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
589 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
590 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
591 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
597 * Checks an image for consistency. Exit codes:
599 * 0 - Check completed, image is good
600 * 1 - Check not completed because of internal errors
601 * 2 - Check completed, image is corrupted
602 * 3 - Check completed, image has leaked clusters, but is good otherwise
603 * 63 - Checks are not supported by the image format
605 static int img_check(int argc
, char **argv
)
608 OutputFormat output_format
= OFORMAT_HUMAN
;
609 const char *filename
, *fmt
, *output
, *cache
;
611 BlockDriverState
*bs
;
613 int flags
= BDRV_O_CHECK
;
617 bool image_opts
= false;
621 cache
= BDRV_DEFAULT_CACHE
;
624 int option_index
= 0;
625 static const struct option long_options
[] = {
626 {"help", no_argument
, 0, 'h'},
627 {"format", required_argument
, 0, 'f'},
628 {"repair", required_argument
, 0, 'r'},
629 {"output", required_argument
, 0, OPTION_OUTPUT
},
630 {"object", required_argument
, 0, OPTION_OBJECT
},
631 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
634 c
= getopt_long(argc
, argv
, "hf:r:T:q",
635 long_options
, &option_index
);
648 flags
|= BDRV_O_RDWR
;
650 if (!strcmp(optarg
, "leaks")) {
651 fix
= BDRV_FIX_LEAKS
;
652 } else if (!strcmp(optarg
, "all")) {
653 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
655 error_exit("Unknown option value for -r "
656 "(expecting 'leaks' or 'all'): %s", optarg
);
668 case OPTION_OBJECT
: {
670 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
676 case OPTION_IMAGE_OPTS
:
681 if (optind
!= argc
- 1) {
682 error_exit("Expecting one image file name");
684 filename
= argv
[optind
++];
686 if (output
&& !strcmp(output
, "json")) {
687 output_format
= OFORMAT_JSON
;
688 } else if (output
&& !strcmp(output
, "human")) {
689 output_format
= OFORMAT_HUMAN
;
691 error_report("--output must be used with human or json as argument.");
695 if (qemu_opts_foreach(&qemu_object_opts
,
696 user_creatable_add_opts_foreach
,
701 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
703 error_report("Invalid source cache option: %s", cache
);
707 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
713 check
= g_new0(ImageCheck
, 1);
714 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
716 if (ret
== -ENOTSUP
) {
717 error_report("This image format does not support checks");
722 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
723 int corruptions_fixed
, leaks_fixed
;
725 leaks_fixed
= check
->leaks_fixed
;
726 corruptions_fixed
= check
->corruptions_fixed
;
728 if (output_format
== OFORMAT_HUMAN
) {
730 "The following inconsistencies were found and repaired:\n\n"
731 " %" PRId64
" leaked clusters\n"
732 " %" PRId64
" corruptions\n\n"
733 "Double checking the fixed image now...\n",
735 check
->corruptions_fixed
);
738 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
740 check
->leaks_fixed
= leaks_fixed
;
741 check
->corruptions_fixed
= corruptions_fixed
;
745 switch (output_format
) {
747 dump_human_image_check(check
, quiet
);
750 dump_json_image_check(check
, quiet
);
755 if (ret
|| check
->check_errors
) {
757 error_report("Check failed: %s", strerror(-ret
));
759 error_report("Check failed");
765 if (check
->corruptions
) {
767 } else if (check
->leaks
) {
774 qapi_free_ImageCheck(check
);
779 typedef struct CommonBlockJobCBInfo
{
780 BlockDriverState
*bs
;
782 } CommonBlockJobCBInfo
;
784 static void common_block_job_cb(void *opaque
, int ret
)
786 CommonBlockJobCBInfo
*cbi
= opaque
;
789 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
793 static void run_block_job(BlockJob
*job
, Error
**errp
)
795 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
798 aio_poll(aio_context
, true);
799 qemu_progress_print(job
->len
?
800 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
801 } while (!job
->ready
);
803 block_job_complete_sync(job
, errp
);
805 /* A block job may finish instantaneously without publishing any progress,
806 * so just signal completion here */
807 qemu_progress_print(100.f
, 0);
810 static int img_commit(int argc
, char **argv
)
813 const char *filename
, *fmt
, *cache
, *base
;
815 BlockDriverState
*bs
, *base_bs
;
816 bool progress
= false, quiet
= false, drop
= false;
818 Error
*local_err
= NULL
;
819 CommonBlockJobCBInfo cbi
;
820 bool image_opts
= false;
823 cache
= BDRV_DEFAULT_CACHE
;
826 static const struct option long_options
[] = {
827 {"help", no_argument
, 0, 'h'},
828 {"object", required_argument
, 0, OPTION_OBJECT
},
829 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
832 c
= getopt_long(argc
, argv
, "f:ht:b:dpq",
862 case OPTION_OBJECT
: {
864 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
870 case OPTION_IMAGE_OPTS
:
876 /* Progress is not shown in Quiet mode */
881 if (optind
!= argc
- 1) {
882 error_exit("Expecting one image file name");
884 filename
= argv
[optind
++];
886 if (qemu_opts_foreach(&qemu_object_opts
,
887 user_creatable_add_opts_foreach
,
892 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
893 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
895 error_report("Invalid cache option: %s", cache
);
899 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
905 qemu_progress_init(progress
, 1.f
);
906 qemu_progress_print(0.f
, 100);
909 base_bs
= bdrv_find_backing_image(bs
, base
);
911 error_setg(&local_err
, QERR_BASE_NOT_FOUND
, base
);
915 /* This is different from QMP, which by default uses the deepest file in
916 * the backing chain (i.e., the very base); however, the traditional
917 * behavior of qemu-img commit is using the immediate backing file. */
918 base_bs
= backing_bs(bs
);
920 error_setg(&local_err
, "Image does not have a backing file");
925 cbi
= (CommonBlockJobCBInfo
){
930 commit_active_start("commit", bs
, base_bs
, 0, BLOCKDEV_ON_ERROR_REPORT
,
931 common_block_job_cb
, &cbi
, &local_err
, false);
936 /* When the block job completes, the BlockBackend reference will point to
937 * the old backing file. In order to avoid that the top image is already
938 * deleted, so we can still empty it afterwards, increment the reference
939 * counter here preemptively. */
944 run_block_job(bs
->job
, &local_err
);
949 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
950 ret
= bs
->drv
->bdrv_make_empty(bs
);
952 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
969 error_report_err(local_err
);
973 qprintf(quiet
, "Image committed.\n");
978 * Returns true iff the first sector pointed to by 'buf' contains at least
981 * 'pnum' is set to the number of sectors (including and immediately following
982 * the first one) that are known to be in the same allocated/unallocated state.
984 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
993 is_zero
= buffer_is_zero(buf
, 512);
994 for(i
= 1; i
< n
; i
++) {
996 if (is_zero
!= buffer_is_zero(buf
, 512)) {
1005 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1006 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1007 * breaking up write requests for only small sparse areas.
1009 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1013 int num_checked
, num_used
;
1019 ret
= is_allocated_sectors(buf
, n
, pnum
);
1025 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1027 num_checked
= num_used
;
1030 ret
= is_allocated_sectors(buf
, n
, pnum
);
1032 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1034 num_checked
+= *pnum
;
1036 num_used
= num_checked
;
1037 } else if (*pnum
>= min
) {
1047 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1048 * buffers matches, non-zero otherwise.
1050 * pnum is set to the number of sectors (including and immediately following
1051 * the first one) that are known to have the same comparison result
1053 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1064 res
= !!memcmp(buf1
, buf2
, 512);
1065 for(i
= 1; i
< n
; i
++) {
1069 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1078 #define IO_BUF_SIZE (2 * 1024 * 1024)
1080 static int64_t sectors_to_bytes(int64_t sectors
)
1082 return sectors
<< BDRV_SECTOR_BITS
;
1085 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1087 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1091 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1093 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1094 * data and negative value on error.
1096 * @param blk: BlockBackend for the image
1097 * @param sect_num: Number of first sector to check
1098 * @param sect_count: Number of sectors to check
1099 * @param filename: Name of disk file we are checking (logging purpose)
1100 * @param buffer: Allocated buffer for storing read data
1101 * @param quiet: Flag for quiet mode
1103 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1104 int sect_count
, const char *filename
,
1105 uint8_t *buffer
, bool quiet
)
1108 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1109 sect_count
<< BDRV_SECTOR_BITS
);
1111 error_report("Error while reading offset %" PRId64
" of %s: %s",
1112 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1115 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1116 if (ret
|| pnum
!= sect_count
) {
1117 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1118 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1126 * Compares two images. Exit codes:
1128 * 0 - Images are identical
1130 * >1 - Error occurred
1132 static int img_compare(int argc
, char **argv
)
1134 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1135 BlockBackend
*blk1
, *blk2
;
1136 BlockDriverState
*bs1
, *bs2
;
1137 int64_t total_sectors1
, total_sectors2
;
1138 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1140 int allocated1
, allocated2
;
1141 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1142 bool progress
= false, quiet
= false, strict
= false;
1145 int64_t total_sectors
;
1146 int64_t sector_num
= 0;
1149 uint64_t progress_base
;
1150 bool image_opts
= false;
1152 cache
= BDRV_DEFAULT_CACHE
;
1154 static const struct option long_options
[] = {
1155 {"help", no_argument
, 0, 'h'},
1156 {"object", required_argument
, 0, OPTION_OBJECT
},
1157 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1160 c
= getopt_long(argc
, argv
, "hf:F:T:pqs",
1161 long_options
, NULL
);
1188 case OPTION_OBJECT
: {
1190 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1197 case OPTION_IMAGE_OPTS
:
1203 /* Progress is not shown in Quiet mode */
1209 if (optind
!= argc
- 2) {
1210 error_exit("Expecting two image file names");
1212 filename1
= argv
[optind
++];
1213 filename2
= argv
[optind
++];
1215 if (qemu_opts_foreach(&qemu_object_opts
,
1216 user_creatable_add_opts_foreach
,
1222 /* Initialize before goto out */
1223 qemu_progress_init(progress
, 2.0);
1226 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1228 error_report("Invalid source cache option: %s", cache
);
1233 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
);
1239 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
);
1247 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1248 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1249 total_sectors1
= blk_nb_sectors(blk1
);
1250 if (total_sectors1
< 0) {
1251 error_report("Can't get size of %s: %s",
1252 filename1
, strerror(-total_sectors1
));
1256 total_sectors2
= blk_nb_sectors(blk2
);
1257 if (total_sectors2
< 0) {
1258 error_report("Can't get size of %s: %s",
1259 filename2
, strerror(-total_sectors2
));
1263 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1264 progress_base
= MAX(total_sectors1
, total_sectors2
);
1266 qemu_progress_print(0, 100);
1268 if (strict
&& total_sectors1
!= total_sectors2
) {
1270 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1275 int64_t status1
, status2
;
1276 BlockDriverState
*file
;
1278 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1279 if (nb_sectors
<= 0) {
1282 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1283 total_sectors1
- sector_num
,
1287 error_report("Sector allocation test failed for %s", filename1
);
1290 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1292 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1293 total_sectors2
- sector_num
,
1297 error_report("Sector allocation test failed for %s", filename2
);
1300 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1302 nb_sectors
= MIN(nb_sectors
, pnum1
);
1305 nb_sectors
= MIN(nb_sectors
, pnum2
);
1309 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1310 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1312 qprintf(quiet
, "Strict mode: Offset %" PRId64
1313 " block status mismatch!\n",
1314 sectors_to_bytes(sector_num
));
1318 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1319 nb_sectors
= MIN(pnum1
, pnum2
);
1320 } else if (allocated1
== allocated2
) {
1322 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1323 nb_sectors
<< BDRV_SECTOR_BITS
);
1325 error_report("Error while reading offset %" PRId64
" of %s:"
1326 " %s", sectors_to_bytes(sector_num
), filename1
,
1331 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1332 nb_sectors
<< BDRV_SECTOR_BITS
);
1334 error_report("Error while reading offset %" PRId64
1335 " of %s: %s", sectors_to_bytes(sector_num
),
1336 filename2
, strerror(-ret
));
1340 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1341 if (ret
|| pnum
!= nb_sectors
) {
1342 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1344 ret
? sector_num
: sector_num
+ pnum
));
1352 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1353 filename1
, buf1
, quiet
);
1355 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1356 filename2
, buf1
, quiet
);
1360 error_report("Error while reading offset %" PRId64
": %s",
1361 sectors_to_bytes(sector_num
), strerror(-ret
));
1367 sector_num
+= nb_sectors
;
1368 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1371 if (total_sectors1
!= total_sectors2
) {
1372 BlockBackend
*blk_over
;
1373 int64_t total_sectors_over
;
1374 const char *filename_over
;
1376 qprintf(quiet
, "Warning: Image size mismatch!\n");
1377 if (total_sectors1
> total_sectors2
) {
1378 total_sectors_over
= total_sectors1
;
1380 filename_over
= filename1
;
1382 total_sectors_over
= total_sectors2
;
1384 filename_over
= filename2
;
1388 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1389 if (nb_sectors
<= 0) {
1392 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1396 error_report("Sector allocation test failed for %s",
1403 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1404 filename_over
, buf1
, quiet
);
1407 error_report("Error while reading offset %" PRId64
1408 " of %s: %s", sectors_to_bytes(sector_num
),
1409 filename_over
, strerror(-ret
));
1415 sector_num
+= nb_sectors
;
1416 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1420 qprintf(quiet
, "Images are identical.\n");
1430 qemu_progress_end();
1435 enum ImgConvertBlockStatus
{
1441 typedef struct ImgConvertState
{
1443 int64_t *src_sectors
;
1444 int src_cur
, src_num
;
1445 int64_t src_cur_offset
;
1446 int64_t total_sectors
;
1447 int64_t allocated_sectors
;
1448 enum ImgConvertBlockStatus status
;
1449 int64_t sector_next_status
;
1450 BlockBackend
*target
;
1453 bool target_has_backing
;
1455 size_t cluster_sectors
;
1459 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
)
1461 assert(sector_num
>= s
->src_cur_offset
);
1462 while (sector_num
- s
->src_cur_offset
>= s
->src_sectors
[s
->src_cur
]) {
1463 s
->src_cur_offset
+= s
->src_sectors
[s
->src_cur
];
1465 assert(s
->src_cur
< s
->src_num
);
1469 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1474 convert_select_part(s
, sector_num
);
1476 assert(s
->total_sectors
> sector_num
);
1477 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1479 if (s
->sector_next_status
<= sector_num
) {
1480 BlockDriverState
*file
;
1481 ret
= bdrv_get_block_status(blk_bs(s
->src
[s
->src_cur
]),
1482 sector_num
- s
->src_cur_offset
,
1488 if (ret
& BDRV_BLOCK_ZERO
) {
1489 s
->status
= BLK_ZERO
;
1490 } else if (ret
& BDRV_BLOCK_DATA
) {
1491 s
->status
= BLK_DATA
;
1492 } else if (!s
->target_has_backing
) {
1493 /* Without a target backing file we must copy over the contents of
1494 * the backing file as well. */
1495 /* Check block status of the backing file chain to avoid
1496 * needlessly reading zeroes and limiting the iteration to the
1498 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[s
->src_cur
]), NULL
,
1499 sector_num
- s
->src_cur_offset
,
1505 if (ret
& BDRV_BLOCK_ZERO
) {
1506 s
->status
= BLK_ZERO
;
1508 s
->status
= BLK_DATA
;
1511 s
->status
= BLK_BACKING_FILE
;
1514 s
->sector_next_status
= sector_num
+ n
;
1517 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1518 if (s
->status
== BLK_DATA
) {
1519 n
= MIN(n
, s
->buf_sectors
);
1522 /* We need to write complete clusters for compressed images, so if an
1523 * unallocated area is shorter than that, we must consider the whole
1524 * cluster allocated. */
1525 if (s
->compressed
) {
1526 if (n
< s
->cluster_sectors
) {
1527 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1528 s
->status
= BLK_DATA
;
1530 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1537 static int convert_read(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1543 assert(nb_sectors
<= s
->buf_sectors
);
1544 while (nb_sectors
> 0) {
1548 /* In the case of compression with multiple source files, we can get a
1549 * nb_sectors that spreads into the next part. So we must be able to
1550 * read across multiple BDSes for one convert_read() call. */
1551 convert_select_part(s
, sector_num
);
1552 blk
= s
->src
[s
->src_cur
];
1553 bs_sectors
= s
->src_sectors
[s
->src_cur
];
1555 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- s
->src_cur_offset
));
1556 ret
= blk_pread(blk
,
1557 (sector_num
- s
->src_cur_offset
) << BDRV_SECTOR_BITS
,
1558 buf
, n
<< BDRV_SECTOR_BITS
);
1565 buf
+= n
* BDRV_SECTOR_SIZE
;
1571 static int convert_write(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1576 while (nb_sectors
> 0) {
1579 switch (s
->status
) {
1580 case BLK_BACKING_FILE
:
1581 /* If we have a backing file, leave clusters unallocated that are
1582 * unallocated in the source image, so that the backing file is
1583 * visible at the respective offset. */
1584 assert(s
->target_has_backing
);
1588 /* We must always write compressed clusters as a whole, so don't
1589 * try to find zeroed parts in the buffer. We can only save the
1590 * write if the buffer is completely zeroed and we're allowed to
1591 * keep the target sparse. */
1592 if (s
->compressed
) {
1593 if (s
->has_zero_init
&& s
->min_sparse
&&
1594 buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
))
1596 assert(!s
->target_has_backing
);
1600 ret
= blk_pwrite_compressed(s
->target
,
1601 sector_num
<< BDRV_SECTOR_BITS
,
1602 buf
, n
<< BDRV_SECTOR_BITS
);
1609 /* If there is real non-zero data or we're told to keep the target
1610 * fully allocated (-S 0), we must write it. Otherwise we can treat
1611 * it as zero sectors. */
1612 if (!s
->min_sparse
||
1613 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
))
1615 ret
= blk_pwrite(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1616 buf
, n
<< BDRV_SECTOR_BITS
, 0);
1625 if (s
->has_zero_init
) {
1628 ret
= blk_pwrite_zeroes(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1629 n
<< BDRV_SECTOR_BITS
, 0);
1638 buf
+= n
* BDRV_SECTOR_SIZE
;
1644 static int convert_do_copy(ImgConvertState
*s
)
1646 uint8_t *buf
= NULL
;
1647 int64_t sector_num
, allocated_done
;
1651 /* Check whether we have zero initialisation or can get it efficiently */
1652 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1653 ? bdrv_has_zero_init(blk_bs(s
->target
))
1656 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1657 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1659 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1661 s
->has_zero_init
= true;
1665 /* Allocate buffer for copied data. For compressed images, only one cluster
1666 * can be copied at a time. */
1667 if (s
->compressed
) {
1668 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1669 error_report("invalid cluster size");
1673 s
->buf_sectors
= s
->cluster_sectors
;
1675 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1677 /* Calculate allocated sectors for progress */
1678 s
->allocated_sectors
= 0;
1680 while (sector_num
< s
->total_sectors
) {
1681 n
= convert_iteration_sectors(s
, sector_num
);
1686 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1688 s
->allocated_sectors
+= n
;
1695 s
->src_cur_offset
= 0;
1696 s
->sector_next_status
= 0;
1701 while (sector_num
< s
->total_sectors
) {
1702 n
= convert_iteration_sectors(s
, sector_num
);
1707 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1709 allocated_done
+= n
;
1710 qemu_progress_print(100.0 * allocated_done
/ s
->allocated_sectors
,
1714 if (s
->status
== BLK_DATA
) {
1715 ret
= convert_read(s
, sector_num
, n
, buf
);
1717 error_report("error while reading sector %" PRId64
1718 ": %s", sector_num
, strerror(-ret
));
1721 } else if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1722 n
= MIN(n
, s
->buf_sectors
);
1723 memset(buf
, 0, n
* BDRV_SECTOR_SIZE
);
1724 s
->status
= BLK_DATA
;
1727 ret
= convert_write(s
, sector_num
, n
, buf
);
1729 error_report("error while writing sector %" PRId64
1730 ": %s", sector_num
, strerror(-ret
));
1737 if (s
->compressed
) {
1738 /* signal EOF to align */
1739 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1751 static int img_convert(int argc
, char **argv
)
1753 int c
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1755 int progress
= 0, flags
, src_flags
;
1756 bool writethrough
, src_writethrough
;
1757 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1758 BlockDriver
*drv
, *proto_drv
;
1759 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1760 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1761 int64_t total_sectors
;
1762 int64_t *bs_sectors
= NULL
;
1763 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1764 BlockDriverInfo bdi
;
1765 QemuOpts
*opts
= NULL
;
1766 QemuOptsList
*create_opts
= NULL
;
1767 const char *out_baseimg_param
;
1768 char *options
= NULL
;
1769 const char *snapshot_name
= NULL
;
1770 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1772 Error
*local_err
= NULL
;
1773 QemuOpts
*sn_opts
= NULL
;
1774 ImgConvertState state
;
1775 bool image_opts
= false;
1780 src_cache
= BDRV_DEFAULT_CACHE
;
1785 static const struct option long_options
[] = {
1786 {"help", no_argument
, 0, 'h'},
1787 {"object", required_argument
, 0, OPTION_OBJECT
},
1788 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1791 c
= getopt_long(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1792 long_options
, NULL
);
1808 out_baseimg
= optarg
;
1814 error_report("option -e is deprecated, please use \'-o "
1815 "encryption\' instead!");
1819 error_report("option -6 is deprecated, please use \'-o "
1820 "compat6\' instead!");
1824 if (!is_valid_option_list(optarg
)) {
1825 error_report("Invalid option list: %s", optarg
);
1830 options
= g_strdup(optarg
);
1832 char *old_options
= options
;
1833 options
= g_strdup_printf("%s,%s", options
, optarg
);
1834 g_free(old_options
);
1838 snapshot_name
= optarg
;
1841 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1842 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
1845 error_report("Failed in parsing snapshot param '%s'",
1851 snapshot_name
= optarg
;
1858 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
1859 if (sval
< 0 || *end
) {
1860 error_report("Invalid minimum zero buffer size for sparse output specified");
1865 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1884 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1890 case OPTION_IMAGE_OPTS
:
1896 if (qemu_opts_foreach(&qemu_object_opts
,
1897 user_creatable_add_opts_foreach
,
1902 /* Initialize before goto out */
1906 qemu_progress_init(progress
, 1.0);
1908 bs_n
= argc
- optind
- 1;
1909 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1911 if (options
&& has_help_option(options
)) {
1912 ret
= print_block_option_help(out_filename
, out_fmt
);
1917 error_exit("Must specify image file name");
1921 if (bs_n
> 1 && out_baseimg
) {
1922 error_report("-B makes no sense when concatenating multiple input "
1929 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
1931 error_report("Invalid source cache option: %s", src_cache
);
1935 qemu_progress_print(0, 100);
1937 blk
= g_new0(BlockBackend
*, bs_n
);
1938 bs
= g_new0(BlockDriverState
*, bs_n
);
1939 bs_sectors
= g_new(int64_t, bs_n
);
1942 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1943 blk
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
1944 fmt
, src_flags
, src_writethrough
, quiet
);
1949 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1950 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
1951 if (bs_sectors
[bs_i
] < 0) {
1952 error_report("Could not get size of %s: %s",
1953 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1957 total_sectors
+= bs_sectors
[bs_i
];
1961 ret
= bdrv_snapshot_load_tmp(bs
[0],
1962 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1963 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1965 } else if (snapshot_name
!= NULL
) {
1967 error_report("No support for concatenating multiple snapshot");
1972 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1975 error_reportf_err(local_err
, "Failed to load snapshot: ");
1980 /* Find driver and parse its options */
1981 drv
= bdrv_find_format(out_fmt
);
1983 error_report("Unknown file format '%s'", out_fmt
);
1988 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
1990 error_report_err(local_err
);
1996 if (!drv
->create_opts
) {
1997 error_report("Format driver '%s' does not support image creation",
2003 if (!proto_drv
->create_opts
) {
2004 error_report("Protocol driver '%s' does not support image creation",
2005 proto_drv
->format_name
);
2010 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2011 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2013 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2015 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2017 error_report_err(local_err
);
2023 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
2025 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2031 /* Get backing file name if -o backing_file was used */
2032 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2033 if (out_baseimg_param
) {
2034 out_baseimg
= out_baseimg_param
;
2037 /* Check if compression is supported */
2040 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2041 const char *preallocation
=
2042 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2044 if (!drv
->bdrv_co_pwritev_compressed
) {
2045 error_report("Compression not supported for this file format");
2051 error_report("Compression and encryption not supported at "
2058 && strcmp(preallocation
, "off"))
2060 error_report("Compression and preallocation not supported at "
2068 /* Create the new image */
2069 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2071 error_reportf_err(local_err
, "%s: error while converting %s: ",
2072 out_filename
, out_fmt
);
2077 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2078 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2080 error_report("Invalid cache option: %s", cache
);
2084 /* XXX we should allow --image-opts to trigger use of
2085 * img_open() here, but then we have trouble with
2086 * the bdrv_create() call which takes different params.
2087 * Not critical right now, so fix can wait...
2089 out_blk
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
);
2094 out_bs
= blk_bs(out_blk
);
2096 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2097 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2099 bufsectors
= MIN(32768,
2101 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2102 out_bs
->bl
.pdiscard_alignment
>>
2103 BDRV_SECTOR_BITS
)));
2106 int64_t output_sectors
= blk_nb_sectors(out_blk
);
2107 if (output_sectors
< 0) {
2108 error_report("unable to get output image length: %s",
2109 strerror(-output_sectors
));
2112 } else if (output_sectors
< total_sectors
) {
2113 error_report("output file is smaller than input file");
2119 cluster_sectors
= 0;
2120 ret
= bdrv_get_info(out_bs
, &bdi
);
2123 error_report("could not get block driver info");
2127 compress
= compress
|| bdi
.needs_compressed_writes
;
2128 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2131 state
= (ImgConvertState
) {
2133 .src_sectors
= bs_sectors
,
2135 .total_sectors
= total_sectors
,
2137 .compressed
= compress
,
2138 .target_has_backing
= (bool) out_baseimg
,
2139 .min_sparse
= min_sparse
,
2140 .cluster_sectors
= cluster_sectors
,
2141 .buf_sectors
= bufsectors
,
2143 ret
= convert_do_copy(&state
);
2147 qemu_progress_print(100, 0);
2149 qemu_progress_end();
2150 qemu_opts_del(opts
);
2151 qemu_opts_free(create_opts
);
2152 qemu_opts_del(sn_opts
);
2156 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2157 blk_unref(blk
[bs_i
]);
2172 static void dump_snapshots(BlockDriverState
*bs
)
2174 QEMUSnapshotInfo
*sn_tab
, *sn
;
2177 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2180 printf("Snapshot list:\n");
2181 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2183 for(i
= 0; i
< nb_sns
; i
++) {
2185 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2191 static void dump_json_image_info_list(ImageInfoList
*list
)
2195 Visitor
*v
= qmp_output_visitor_new(&obj
);
2197 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2198 visit_complete(v
, &obj
);
2199 str
= qobject_to_json_pretty(obj
);
2200 assert(str
!= NULL
);
2201 printf("%s\n", qstring_get_str(str
));
2202 qobject_decref(obj
);
2207 static void dump_json_image_info(ImageInfo
*info
)
2211 Visitor
*v
= qmp_output_visitor_new(&obj
);
2213 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2214 visit_complete(v
, &obj
);
2215 str
= qobject_to_json_pretty(obj
);
2216 assert(str
!= NULL
);
2217 printf("%s\n", qstring_get_str(str
));
2218 qobject_decref(obj
);
2223 static void dump_human_image_info_list(ImageInfoList
*list
)
2225 ImageInfoList
*elem
;
2228 for (elem
= list
; elem
; elem
= elem
->next
) {
2234 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2238 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2240 return strcmp(a
, b
) == 0;
2244 * Open an image file chain and return an ImageInfoList
2246 * @filename: topmost image filename
2247 * @fmt: topmost image format (may be NULL to autodetect)
2248 * @chain: true - enumerate entire backing file chain
2249 * false - only topmost image file
2251 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2252 * image file. If there was an error a message will have been printed to
2255 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2256 const char *filename
,
2260 ImageInfoList
*head
= NULL
;
2261 ImageInfoList
**last
= &head
;
2262 GHashTable
*filenames
;
2265 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2269 BlockDriverState
*bs
;
2271 ImageInfoList
*elem
;
2273 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2274 error_report("Backing file '%s' creates an infinite loop.",
2278 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2280 blk
= img_open(image_opts
, filename
, fmt
,
2281 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false);
2287 bdrv_query_image_info(bs
, &info
, &err
);
2289 error_report_err(err
);
2294 elem
= g_new0(ImageInfoList
, 1);
2301 filename
= fmt
= NULL
;
2303 if (info
->has_full_backing_filename
) {
2304 filename
= info
->full_backing_filename
;
2305 } else if (info
->has_backing_filename
) {
2306 error_report("Could not determine absolute backing filename,"
2307 " but backing filename '%s' present",
2308 info
->backing_filename
);
2311 if (info
->has_backing_filename_format
) {
2312 fmt
= info
->backing_filename_format
;
2316 g_hash_table_destroy(filenames
);
2320 qapi_free_ImageInfoList(head
);
2321 g_hash_table_destroy(filenames
);
2325 static int img_info(int argc
, char **argv
)
2328 OutputFormat output_format
= OFORMAT_HUMAN
;
2330 const char *filename
, *fmt
, *output
;
2331 ImageInfoList
*list
;
2332 bool image_opts
= false;
2337 int option_index
= 0;
2338 static const struct option long_options
[] = {
2339 {"help", no_argument
, 0, 'h'},
2340 {"format", required_argument
, 0, 'f'},
2341 {"output", required_argument
, 0, OPTION_OUTPUT
},
2342 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2343 {"object", required_argument
, 0, OPTION_OBJECT
},
2344 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2347 c
= getopt_long(argc
, argv
, "f:h",
2348 long_options
, &option_index
);
2363 case OPTION_BACKING_CHAIN
:
2366 case OPTION_OBJECT
: {
2368 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2374 case OPTION_IMAGE_OPTS
:
2379 if (optind
!= argc
- 1) {
2380 error_exit("Expecting one image file name");
2382 filename
= argv
[optind
++];
2384 if (output
&& !strcmp(output
, "json")) {
2385 output_format
= OFORMAT_JSON
;
2386 } else if (output
&& !strcmp(output
, "human")) {
2387 output_format
= OFORMAT_HUMAN
;
2388 } else if (output
) {
2389 error_report("--output must be used with human or json as argument.");
2393 if (qemu_opts_foreach(&qemu_object_opts
,
2394 user_creatable_add_opts_foreach
,
2399 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
);
2404 switch (output_format
) {
2406 dump_human_image_info_list(list
);
2410 dump_json_image_info_list(list
);
2412 dump_json_image_info(list
->value
);
2417 qapi_free_ImageInfoList(list
);
2421 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2424 switch (output_format
) {
2426 if (e
->data
&& !e
->has_offset
) {
2427 error_report("File contains external, encrypted or compressed clusters.");
2430 if (e
->data
&& !e
->zero
) {
2431 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2432 e
->start
, e
->length
,
2433 e
->has_offset
? e
->offset
: 0,
2434 e
->has_filename
? e
->filename
: "");
2436 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2437 * Modify the flags here to allow more coalescing.
2439 if (next
&& (!next
->data
|| next
->zero
)) {
2445 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2446 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2447 (e
->start
== 0 ? "[" : ",\n"),
2448 e
->start
, e
->length
, e
->depth
,
2449 e
->zero
? "true" : "false",
2450 e
->data
? "true" : "false");
2451 if (e
->has_offset
) {
2452 printf(", \"offset\": %"PRId64
"", e
->offset
);
2463 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2464 int nb_sectors
, MapEntry
*e
)
2468 BlockDriverState
*file
;
2471 /* As an optimization, we could cache the current range of unallocated
2472 * clusters in each file of the chain, and avoid querying the same
2478 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2484 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2487 bs
= backing_bs(bs
);
2496 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2499 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2500 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2501 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2502 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2503 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2504 .has_offset
= has_offset
,
2506 .has_filename
= file
&& has_offset
,
2507 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2513 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2515 if (curr
->length
== 0) {
2518 if (curr
->zero
!= next
->zero
||
2519 curr
->data
!= next
->data
||
2520 curr
->depth
!= next
->depth
||
2521 curr
->has_filename
!= next
->has_filename
||
2522 curr
->has_offset
!= next
->has_offset
) {
2525 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2528 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2534 static int img_map(int argc
, char **argv
)
2537 OutputFormat output_format
= OFORMAT_HUMAN
;
2539 BlockDriverState
*bs
;
2540 const char *filename
, *fmt
, *output
;
2542 MapEntry curr
= { .length
= 0 }, next
;
2544 bool image_opts
= false;
2549 int option_index
= 0;
2550 static const struct option long_options
[] = {
2551 {"help", no_argument
, 0, 'h'},
2552 {"format", required_argument
, 0, 'f'},
2553 {"output", required_argument
, 0, OPTION_OUTPUT
},
2554 {"object", required_argument
, 0, OPTION_OBJECT
},
2555 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2558 c
= getopt_long(argc
, argv
, "f:h",
2559 long_options
, &option_index
);
2574 case OPTION_OBJECT
: {
2576 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2582 case OPTION_IMAGE_OPTS
:
2587 if (optind
!= argc
- 1) {
2588 error_exit("Expecting one image file name");
2590 filename
= argv
[optind
];
2592 if (output
&& !strcmp(output
, "json")) {
2593 output_format
= OFORMAT_JSON
;
2594 } else if (output
&& !strcmp(output
, "human")) {
2595 output_format
= OFORMAT_HUMAN
;
2596 } else if (output
) {
2597 error_report("--output must be used with human or json as argument.");
2601 if (qemu_opts_foreach(&qemu_object_opts
,
2602 user_creatable_add_opts_foreach
,
2607 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false);
2613 if (output_format
== OFORMAT_HUMAN
) {
2614 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2617 length
= blk_getlength(blk
);
2618 while (curr
.start
+ curr
.length
< length
) {
2619 int64_t nsectors_left
;
2623 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2625 /* Probe up to 1 GiB at a time. */
2626 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2627 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2628 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2631 error_report("Could not read file metadata: %s", strerror(-ret
));
2635 if (entry_mergeable(&curr
, &next
)) {
2636 curr
.length
+= next
.length
;
2640 if (curr
.length
> 0) {
2641 dump_map_entry(output_format
, &curr
, &next
);
2646 dump_map_entry(output_format
, &curr
, NULL
);
2653 #define SNAPSHOT_LIST 1
2654 #define SNAPSHOT_CREATE 2
2655 #define SNAPSHOT_APPLY 3
2656 #define SNAPSHOT_DELETE 4
2658 static int img_snapshot(int argc
, char **argv
)
2661 BlockDriverState
*bs
;
2662 QEMUSnapshotInfo sn
;
2663 char *filename
, *snapshot_name
= NULL
;
2664 int c
, ret
= 0, bdrv_oflags
;
2669 bool image_opts
= false;
2671 bdrv_oflags
= BDRV_O_RDWR
;
2672 /* Parse commandline parameters */
2674 static const struct option long_options
[] = {
2675 {"help", no_argument
, 0, 'h'},
2676 {"object", required_argument
, 0, OPTION_OBJECT
},
2677 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2680 c
= getopt_long(argc
, argv
, "la:c:d:hq",
2681 long_options
, NULL
);
2692 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2695 action
= SNAPSHOT_LIST
;
2696 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2700 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2703 action
= SNAPSHOT_APPLY
;
2704 snapshot_name
= optarg
;
2708 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2711 action
= SNAPSHOT_CREATE
;
2712 snapshot_name
= optarg
;
2716 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2719 action
= SNAPSHOT_DELETE
;
2720 snapshot_name
= optarg
;
2725 case OPTION_OBJECT
: {
2727 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2733 case OPTION_IMAGE_OPTS
:
2739 if (optind
!= argc
- 1) {
2740 error_exit("Expecting one image file name");
2742 filename
= argv
[optind
++];
2744 if (qemu_opts_foreach(&qemu_object_opts
,
2745 user_creatable_add_opts_foreach
,
2750 /* Open the image */
2751 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
);
2757 /* Perform the requested action */
2763 case SNAPSHOT_CREATE
:
2764 memset(&sn
, 0, sizeof(sn
));
2765 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2767 qemu_gettimeofday(&tv
);
2768 sn
.date_sec
= tv
.tv_sec
;
2769 sn
.date_nsec
= tv
.tv_usec
* 1000;
2771 ret
= bdrv_snapshot_create(bs
, &sn
);
2773 error_report("Could not create snapshot '%s': %d (%s)",
2774 snapshot_name
, ret
, strerror(-ret
));
2778 case SNAPSHOT_APPLY
:
2779 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2781 error_report("Could not apply snapshot '%s': %d (%s)",
2782 snapshot_name
, ret
, strerror(-ret
));
2786 case SNAPSHOT_DELETE
:
2787 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2789 error_reportf_err(err
, "Could not delete snapshot '%s': ",
2804 static int img_rebase(int argc
, char **argv
)
2806 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2807 uint8_t *buf_old
= NULL
;
2808 uint8_t *buf_new
= NULL
;
2809 BlockDriverState
*bs
= NULL
;
2811 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2812 int c
, flags
, src_flags
, ret
;
2813 bool writethrough
, src_writethrough
;
2817 Error
*local_err
= NULL
;
2818 bool image_opts
= false;
2820 /* Parse commandline parameters */
2822 cache
= BDRV_DEFAULT_CACHE
;
2823 src_cache
= BDRV_DEFAULT_CACHE
;
2827 static const struct option long_options
[] = {
2828 {"help", no_argument
, 0, 'h'},
2829 {"object", required_argument
, 0, OPTION_OBJECT
},
2830 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2833 c
= getopt_long(argc
, argv
, "hf:F:b:upt:T:q",
2834 long_options
, NULL
);
2847 out_basefmt
= optarg
;
2850 out_baseimg
= optarg
;
2867 case OPTION_OBJECT
: {
2869 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2875 case OPTION_IMAGE_OPTS
:
2885 if (optind
!= argc
- 1) {
2886 error_exit("Expecting one image file name");
2888 if (!unsafe
&& !out_baseimg
) {
2889 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2891 filename
= argv
[optind
++];
2893 if (qemu_opts_foreach(&qemu_object_opts
,
2894 user_creatable_add_opts_foreach
,
2899 qemu_progress_init(progress
, 2.0);
2900 qemu_progress_print(0, 100);
2902 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2903 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2905 error_report("Invalid cache option: %s", cache
);
2910 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2912 error_report("Invalid source cache option: %s", src_cache
);
2916 /* The source files are opened read-only, don't care about WCE */
2917 assert((src_flags
& BDRV_O_RDWR
) == 0);
2918 (void) src_writethrough
;
2923 * Ignore the old backing file for unsafe rebase in case we want to correct
2924 * the reference to a renamed or moved backing file.
2926 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
2933 if (out_basefmt
!= NULL
) {
2934 if (bdrv_find_format(out_basefmt
) == NULL
) {
2935 error_report("Invalid format name: '%s'", out_basefmt
);
2941 /* For safe rebasing we need to compare old and new backing file */
2943 char backing_name
[PATH_MAX
];
2944 QDict
*options
= NULL
;
2946 if (bs
->backing_format
[0] != '\0') {
2947 options
= qdict_new();
2948 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
2951 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2952 blk_old_backing
= blk_new_open(backing_name
, NULL
,
2953 options
, src_flags
, &local_err
);
2954 if (!blk_old_backing
) {
2955 error_reportf_err(local_err
,
2956 "Could not open old backing file '%s': ",
2961 if (out_baseimg
[0]) {
2963 options
= qdict_new();
2964 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
2969 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
2970 options
, src_flags
, &local_err
);
2971 if (!blk_new_backing
) {
2972 error_reportf_err(local_err
,
2973 "Could not open new backing file '%s': ",
2981 * Check each unallocated cluster in the COW file. If it is unallocated,
2982 * accesses go to the backing file. We must therefore compare this cluster
2983 * in the old and new backing file, and if they differ we need to copy it
2984 * from the old backing file into the COW file.
2986 * If qemu-img crashes during this step, no harm is done. The content of
2987 * the image is the same as the original one at any time.
2990 int64_t num_sectors
;
2991 int64_t old_backing_num_sectors
;
2992 int64_t new_backing_num_sectors
= 0;
2995 float local_progress
= 0;
2997 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
2998 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
3000 num_sectors
= blk_nb_sectors(blk
);
3001 if (num_sectors
< 0) {
3002 error_report("Could not get size of '%s': %s",
3003 filename
, strerror(-num_sectors
));
3007 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3008 if (old_backing_num_sectors
< 0) {
3009 char backing_name
[PATH_MAX
];
3011 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3012 error_report("Could not get size of '%s': %s",
3013 backing_name
, strerror(-old_backing_num_sectors
));
3017 if (blk_new_backing
) {
3018 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3019 if (new_backing_num_sectors
< 0) {
3020 error_report("Could not get size of '%s': %s",
3021 out_baseimg
, strerror(-new_backing_num_sectors
));
3027 if (num_sectors
!= 0) {
3028 local_progress
= (float)100 /
3029 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3032 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3034 /* How many sectors can we handle with the next read? */
3035 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3036 n
= (IO_BUF_SIZE
/ 512);
3038 n
= num_sectors
- sector
;
3041 /* If the cluster is allocated, we don't need to take action */
3042 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3044 error_report("error while reading image metadata: %s",
3053 * Read old and new backing file and take into consideration that
3054 * backing files may be smaller than the COW image.
3056 if (sector
>= old_backing_num_sectors
) {
3057 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3059 if (sector
+ n
> old_backing_num_sectors
) {
3060 n
= old_backing_num_sectors
- sector
;
3063 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3064 buf_old
, n
<< BDRV_SECTOR_BITS
);
3066 error_report("error while reading from old backing file");
3071 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3072 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3074 if (sector
+ n
> new_backing_num_sectors
) {
3075 n
= new_backing_num_sectors
- sector
;
3078 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3079 buf_new
, n
<< BDRV_SECTOR_BITS
);
3081 error_report("error while reading from new backing file");
3086 /* If they differ, we need to write to the COW file */
3087 uint64_t written
= 0;
3089 while (written
< n
) {
3092 if (compare_sectors(buf_old
+ written
* 512,
3093 buf_new
+ written
* 512, n
- written
, &pnum
))
3095 ret
= blk_pwrite(blk
,
3096 (sector
+ written
) << BDRV_SECTOR_BITS
,
3097 buf_old
+ written
* 512,
3098 pnum
<< BDRV_SECTOR_BITS
, 0);
3100 error_report("Error while writing to COW image: %s",
3108 qemu_progress_print(local_progress
, 100);
3113 * Change the backing file. All clusters that are different from the old
3114 * backing file are overwritten in the COW file now, so the visible content
3115 * doesn't change when we switch the backing file.
3117 if (out_baseimg
&& *out_baseimg
) {
3118 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3120 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3123 if (ret
== -ENOSPC
) {
3124 error_report("Could not change the backing file to '%s': No "
3125 "space left in the file header", out_baseimg
);
3126 } else if (ret
< 0) {
3127 error_report("Could not change the backing file to '%s': %s",
3128 out_baseimg
, strerror(-ret
));
3131 qemu_progress_print(100, 0);
3133 * TODO At this point it is possible to check if any clusters that are
3134 * allocated in the COW file are the same in the backing file. If so, they
3135 * could be dropped from the COW file. Don't do this before switching the
3136 * backing file, in case of a crash this would lead to corruption.
3139 qemu_progress_end();
3142 blk_unref(blk_old_backing
);
3143 blk_unref(blk_new_backing
);
3145 qemu_vfree(buf_old
);
3146 qemu_vfree(buf_new
);
3155 static int img_resize(int argc
, char **argv
)
3158 int c
, ret
, relative
;
3159 const char *filename
, *fmt
, *size
;
3160 int64_t n
, total_size
;
3162 BlockBackend
*blk
= NULL
;
3165 static QemuOptsList resize_options
= {
3166 .name
= "resize_options",
3167 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3170 .name
= BLOCK_OPT_SIZE
,
3171 .type
= QEMU_OPT_SIZE
,
3172 .help
= "Virtual disk size"
3178 bool image_opts
= false;
3180 /* Remove size from argv manually so that negative numbers are not treated
3181 * as options by getopt. */
3183 error_exit("Not enough arguments");
3187 size
= argv
[--argc
];
3189 /* Parse getopt arguments */
3192 static const struct option long_options
[] = {
3193 {"help", no_argument
, 0, 'h'},
3194 {"object", required_argument
, 0, OPTION_OBJECT
},
3195 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3198 c
= getopt_long(argc
, argv
, "f:hq",
3199 long_options
, NULL
);
3214 case OPTION_OBJECT
: {
3216 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3222 case OPTION_IMAGE_OPTS
:
3227 if (optind
!= argc
- 1) {
3228 error_exit("Expecting one image file name");
3230 filename
= argv
[optind
++];
3232 if (qemu_opts_foreach(&qemu_object_opts
,
3233 user_creatable_add_opts_foreach
,
3238 /* Choose grow, shrink, or absolute resize mode */
3254 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3255 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3257 error_report_err(err
);
3259 qemu_opts_del(param
);
3262 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3263 qemu_opts_del(param
);
3265 blk
= img_open(image_opts
, filename
, fmt
,
3266 BDRV_O_RDWR
, false, quiet
);
3273 total_size
= blk_getlength(blk
) + n
* relative
;
3277 if (total_size
<= 0) {
3278 error_report("New image size must be positive");
3283 ret
= blk_truncate(blk
, total_size
);
3286 qprintf(quiet
, "Image resized.\n");
3289 error_report("This image does not support resize");
3292 error_report("Image is read-only");
3295 error_report("Error resizing image: %s", strerror(-ret
));
3306 static void amend_status_cb(BlockDriverState
*bs
,
3307 int64_t offset
, int64_t total_work_size
,
3310 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3313 static int img_amend(int argc
, char **argv
)
3317 char *options
= NULL
;
3318 QemuOptsList
*create_opts
= NULL
;
3319 QemuOpts
*opts
= NULL
;
3320 const char *fmt
= NULL
, *filename
, *cache
;
3323 bool quiet
= false, progress
= false;
3324 BlockBackend
*blk
= NULL
;
3325 BlockDriverState
*bs
= NULL
;
3326 bool image_opts
= false;
3328 cache
= BDRV_DEFAULT_CACHE
;
3330 static const struct option long_options
[] = {
3331 {"help", no_argument
, 0, 'h'},
3332 {"object", required_argument
, 0, OPTION_OBJECT
},
3333 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3336 c
= getopt_long(argc
, argv
, "ho:f:t:pq",
3337 long_options
, NULL
);
3348 if (!is_valid_option_list(optarg
)) {
3349 error_report("Invalid option list: %s", optarg
);
3351 goto out_no_progress
;
3354 options
= g_strdup(optarg
);
3356 char *old_options
= options
;
3357 options
= g_strdup_printf("%s,%s", options
, optarg
);
3358 g_free(old_options
);
3374 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3378 goto out_no_progress
;
3381 case OPTION_IMAGE_OPTS
:
3388 error_exit("Must specify options (-o)");
3391 if (qemu_opts_foreach(&qemu_object_opts
,
3392 user_creatable_add_opts_foreach
,
3395 goto out_no_progress
;
3401 qemu_progress_init(progress
, 1.0);
3403 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3404 if (fmt
&& has_help_option(options
)) {
3405 /* If a format is explicitly specified (and possibly no filename is
3406 * given), print option help here */
3407 ret
= print_block_option_help(filename
, fmt
);
3411 if (optind
!= argc
- 1) {
3412 error_report("Expecting one image file name");
3417 flags
= BDRV_O_RDWR
;
3418 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3420 error_report("Invalid cache option: %s", cache
);
3424 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3431 fmt
= bs
->drv
->format_name
;
3433 if (has_help_option(options
)) {
3434 /* If the format was auto-detected, print option help here */
3435 ret
= print_block_option_help(filename
, fmt
);
3439 if (!bs
->drv
->create_opts
) {
3440 error_report("Format driver '%s' does not support any options to amend",
3446 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3447 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3449 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3451 error_report_err(err
);
3457 /* In case the driver does not call amend_status_cb() */
3458 qemu_progress_print(0.f
, 0);
3459 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3460 qemu_progress_print(100.f
, 0);
3462 error_report("Error while amending options: %s", strerror(-ret
));
3467 qemu_progress_end();
3471 qemu_opts_del(opts
);
3472 qemu_opts_free(create_opts
);
3481 typedef struct BenchData
{
3483 uint64_t image_size
;
3490 bool drain_on_flush
;
3499 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3502 error_report("Failed flush request: %s", strerror(-ret
));
3507 static void bench_cb(void *opaque
, int ret
)
3509 BenchData
*b
= opaque
;
3513 error_report("Failed request: %s", strerror(-ret
));
3518 /* Just finished a flush with drained queue: Start next requests */
3519 assert(b
->in_flight
== 0);
3520 b
->in_flush
= false;
3521 } else if (b
->in_flight
> 0) {
3522 int remaining
= b
->n
- b
->in_flight
;
3527 /* Time for flush? Drain queue if requested, then flush */
3528 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3529 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3530 BlockCompletionFunc
*cb
;
3532 if (b
->drain_on_flush
) {
3536 cb
= bench_undrained_flush_cb
;
3539 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3541 error_report("Failed to issue flush request");
3545 if (b
->drain_on_flush
) {
3551 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3553 acb
= blk_aio_pwritev(b
->blk
, b
->offset
, b
->qiov
, 0,
3556 acb
= blk_aio_preadv(b
->blk
, b
->offset
, b
->qiov
, 0,
3560 error_report("Failed to issue request");
3564 b
->offset
+= b
->step
;
3565 b
->offset
%= b
->image_size
;
3569 static int img_bench(int argc
, char **argv
)
3572 const char *fmt
= NULL
, *filename
;
3574 bool image_opts
= false;
3575 bool is_write
= false;
3579 size_t bufsize
= 4096;
3582 int flush_interval
= 0;
3583 bool drain_on_flush
= true;
3585 BlockBackend
*blk
= NULL
;
3586 BenchData data
= {};
3588 bool writethrough
= false;
3589 struct timeval t1
, t2
;
3593 static const struct option long_options
[] = {
3594 {"help", no_argument
, 0, 'h'},
3595 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3596 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3597 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3598 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3601 c
= getopt_long(argc
, argv
, "hc:d:f:no:qs:S:t:w", long_options
, NULL
);
3615 count
= strtoul(optarg
, &end
, 0);
3616 if (errno
|| *end
|| count
> INT_MAX
) {
3617 error_report("Invalid request count specified");
3626 depth
= strtoul(optarg
, &end
, 0);
3627 if (errno
|| *end
|| depth
> INT_MAX
) {
3628 error_report("Invalid queue depth specified");
3637 flags
|= BDRV_O_NATIVE_AIO
;
3643 offset
= qemu_strtosz_suffix(optarg
, &end
,
3644 QEMU_STRTOSZ_DEFSUFFIX_B
);
3645 if (offset
< 0|| *end
) {
3646 error_report("Invalid offset specified");
3660 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
3661 if (sval
< 0 || sval
> INT_MAX
|| *end
) {
3662 error_report("Invalid buffer size specified");
3674 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
3675 if (sval
< 0 || sval
> INT_MAX
|| *end
) {
3676 error_report("Invalid step size specified");
3684 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3686 error_report("Invalid cache mode");
3692 flags
|= BDRV_O_RDWR
;
3695 case OPTION_PATTERN
:
3699 pattern
= strtoul(optarg
, &end
, 0);
3700 if (errno
|| *end
|| pattern
> 0xff) {
3701 error_report("Invalid pattern byte specified");
3706 case OPTION_FLUSH_INTERVAL
:
3710 flush_interval
= strtoul(optarg
, &end
, 0);
3711 if (errno
|| *end
|| flush_interval
> INT_MAX
) {
3712 error_report("Invalid flush interval specified");
3717 case OPTION_NO_DRAIN
:
3718 drain_on_flush
= false;
3720 case OPTION_IMAGE_OPTS
:
3726 if (optind
!= argc
- 1) {
3727 error_exit("Expecting one image file name");
3729 filename
= argv
[argc
- 1];
3731 if (!is_write
&& flush_interval
) {
3732 error_report("--flush-interval is only available in write tests");
3736 if (flush_interval
&& flush_interval
< depth
) {
3737 error_report("Flush interval can't be smaller than depth");
3742 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3748 image_size
= blk_getlength(blk
);
3749 if (image_size
< 0) {
3754 data
= (BenchData
) {
3756 .image_size
= image_size
,
3758 .step
= step
?: bufsize
,
3763 .flush_interval
= flush_interval
,
3764 .drain_on_flush
= drain_on_flush
,
3766 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3767 "(starting at offset %" PRId64
", step size %d)\n",
3768 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
3769 data
.offset
, data
.step
);
3770 if (flush_interval
) {
3771 printf("Sending flush every %d requests\n", flush_interval
);
3774 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
3775 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
3777 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
3778 for (i
= 0; i
< data
.nrreq
; i
++) {
3779 qemu_iovec_init(&data
.qiov
[i
], 1);
3780 qemu_iovec_add(&data
.qiov
[i
],
3781 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
3784 gettimeofday(&t1
, NULL
);
3787 while (data
.n
> 0) {
3788 main_loop_wait(false);
3790 gettimeofday(&t2
, NULL
);
3792 printf("Run completed in %3.3f seconds.\n",
3793 (t2
.tv_sec
- t1
.tv_sec
)
3794 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
3797 qemu_vfree(data
.buf
);
3817 int bsz
; /* Block size */
3824 int (*f
)(const char *, struct DdIo
*, struct DdIo
*, struct DdInfo
*);
3828 static int img_dd_bs(const char *arg
,
3829 struct DdIo
*in
, struct DdIo
*out
,
3835 res
= qemu_strtosz_suffix(arg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
3837 if (res
<= 0 || res
> INT_MAX
|| *end
) {
3838 error_report("invalid number: '%s'", arg
);
3841 in
->bsz
= out
->bsz
= res
;
3846 static int img_dd_count(const char *arg
,
3847 struct DdIo
*in
, struct DdIo
*out
,
3852 dd
->count
= qemu_strtosz_suffix(arg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
3854 if (dd
->count
< 0 || *end
) {
3855 error_report("invalid number: '%s'", arg
);
3862 static int img_dd_if(const char *arg
,
3863 struct DdIo
*in
, struct DdIo
*out
,
3866 in
->filename
= g_strdup(arg
);
3871 static int img_dd_of(const char *arg
,
3872 struct DdIo
*in
, struct DdIo
*out
,
3875 out
->filename
= g_strdup(arg
);
3880 static int img_dd(int argc
, char **argv
)
3885 BlockDriver
*drv
= NULL
, *proto_drv
= NULL
;
3886 BlockBackend
*blk1
= NULL
, *blk2
= NULL
;
3887 QemuOpts
*opts
= NULL
;
3888 QemuOptsList
*create_opts
= NULL
;
3889 Error
*local_err
= NULL
;
3890 bool image_opts
= false;
3892 const char *out_fmt
= "raw";
3893 const char *fmt
= NULL
;
3895 int64_t block_count
= 0, out_pos
, in_pos
;
3896 struct DdInfo dd
= {
3901 .bsz
= 512, /* Block size is by default 512 bytes */
3911 const struct DdOpts options
[] = {
3912 { "bs", img_dd_bs
, C_BS
},
3913 { "count", img_dd_count
, C_COUNT
},
3914 { "if", img_dd_if
, C_IF
},
3915 { "of", img_dd_of
, C_OF
},
3918 const struct option long_options
[] = {
3919 { "help", no_argument
, 0, 'h'},
3920 { "image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3924 while ((c
= getopt_long(argc
, argv
, "hf:O:", long_options
, NULL
))) {
3936 error_report("Try 'qemu-img --help' for more information.");
3942 case OPTION_IMAGE_OPTS
:
3948 for (i
= optind
; i
< argc
; i
++) {
3950 arg
= g_strdup(argv
[i
]);
3952 tmp
= strchr(arg
, '=');
3954 error_report("unrecognized operand %s", arg
);
3961 for (j
= 0; options
[j
].name
!= NULL
; j
++) {
3962 if (!strcmp(arg
, options
[j
].name
)) {
3966 if (options
[j
].name
== NULL
) {
3967 error_report("unrecognized operand %s", arg
);
3972 if (options
[j
].f(tmp
, &in
, &out
, &dd
) != 0) {
3976 dd
.flags
|= options
[j
].flag
;
3981 if (!(dd
.flags
& C_IF
&& dd
.flags
& C_OF
)) {
3982 error_report("Must specify both input and output files");
3986 blk1
= img_open(image_opts
, in
.filename
, fmt
, 0, false, false);
3993 drv
= bdrv_find_format(out_fmt
);
3995 error_report("Unknown file format");
3999 proto_drv
= bdrv_find_protocol(out
.filename
, true, &local_err
);
4002 error_report_err(local_err
);
4006 if (!drv
->create_opts
) {
4007 error_report("Format driver '%s' does not support image creation",
4012 if (!proto_drv
->create_opts
) {
4013 error_report("Protocol driver '%s' does not support image creation",
4014 proto_drv
->format_name
);
4018 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
4019 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
4021 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
4023 size
= blk_getlength(blk1
);
4025 error_report("Failed to get size for '%s'", in
.filename
);
4030 if (dd
.flags
& C_COUNT
&& dd
.count
<= INT64_MAX
/ in
.bsz
&&
4031 dd
.count
* in
.bsz
< size
) {
4032 size
= dd
.count
* in
.bsz
;
4035 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, size
, &error_abort
);
4037 ret
= bdrv_create(drv
, out
.filename
, opts
, &local_err
);
4039 error_reportf_err(local_err
,
4040 "%s: error while creating output image: ",
4046 blk2
= img_open(image_opts
, out
.filename
, out_fmt
, BDRV_O_RDWR
,
4054 in
.buf
= g_new(uint8_t, in
.bsz
);
4056 for (in_pos
= 0, out_pos
= 0; in_pos
< size
; block_count
++) {
4057 int in_ret
, out_ret
;
4059 if (in_pos
+ in
.bsz
> size
) {
4060 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, size
- in_pos
);
4062 in_ret
= blk_pread(blk1
, in_pos
, in
.buf
, in
.bsz
);
4065 error_report("error while reading from input image file: %s",
4072 out_ret
= blk_pwrite(blk2
, out_pos
, in
.buf
, in_ret
, 0);
4075 error_report("error while writing to output image file: %s",
4076 strerror(-out_ret
));
4085 qemu_opts_del(opts
);
4086 qemu_opts_free(create_opts
);
4089 g_free(in
.filename
);
4090 g_free(out
.filename
);
4101 static const img_cmd_t img_cmds
[] = {
4102 #define DEF(option, callback, arg_string) \
4103 { option, callback },
4104 #include "qemu-img-cmds.h"
4110 int main(int argc
, char **argv
)
4112 const img_cmd_t
*cmd
;
4113 const char *cmdname
;
4114 Error
*local_error
= NULL
;
4115 char *trace_file
= NULL
;
4117 static const struct option long_options
[] = {
4118 {"help", no_argument
, 0, 'h'},
4119 {"version", no_argument
, 0, 'V'},
4120 {"trace", required_argument
, NULL
, 'T'},
4125 signal(SIGPIPE
, SIG_IGN
);
4128 error_set_progname(argv
[0]);
4129 qemu_init_exec_dir(argv
[0]);
4131 if (qemu_init_main_loop(&local_error
)) {
4132 error_report_err(local_error
);
4136 qcrypto_init(&error_fatal
);
4138 module_call_init(MODULE_INIT_QOM
);
4141 error_exit("Not enough arguments");
4144 qemu_add_opts(&qemu_object_opts
);
4145 qemu_add_opts(&qemu_source_opts
);
4146 qemu_add_opts(&qemu_trace_opts
);
4148 while ((c
= getopt_long(argc
, argv
, "+hVT:", long_options
, NULL
)) != -1) {
4154 printf(QEMU_IMG_VERSION
);
4158 trace_file
= trace_opt_parse(optarg
);
4163 cmdname
= argv
[optind
];
4165 /* reset getopt_long scanning */
4173 if (!trace_init_backends()) {
4176 trace_init_file(trace_file
);
4177 qemu_set_log(LOG_TRACE
);
4179 /* find the command */
4180 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
4181 if (!strcmp(cmdname
, cmd
->name
)) {
4182 return cmd
->handler(argc
, argv
);
4187 error_exit("Command not found: %s", cmdname
);