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 printf("%s\nSupported formats:", help_msg
);
172 bdrv_iterate_format(format_print
, NULL
);
177 static QemuOptsList qemu_object_opts
= {
179 .implied_opt_name
= "qom-type",
180 .head
= QTAILQ_HEAD_INITIALIZER(qemu_object_opts
.head
),
186 static QemuOptsList qemu_source_opts
= {
188 .implied_opt_name
= "file",
189 .head
= QTAILQ_HEAD_INITIALIZER(qemu_source_opts
.head
),
195 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet
, const char *fmt
, ...)
201 ret
= vprintf(fmt
, args
);
208 static int print_block_option_help(const char *filename
, const char *fmt
)
210 BlockDriver
*drv
, *proto_drv
;
211 QemuOptsList
*create_opts
= NULL
;
212 Error
*local_err
= NULL
;
214 /* Find driver and parse its options */
215 drv
= bdrv_find_format(fmt
);
217 error_report("Unknown file format '%s'", fmt
);
221 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
223 proto_drv
= bdrv_find_protocol(filename
, true, &local_err
);
225 error_report_err(local_err
);
226 qemu_opts_free(create_opts
);
229 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
232 qemu_opts_print_help(create_opts
);
233 qemu_opts_free(create_opts
);
238 static int img_open_password(BlockBackend
*blk
, const char *filename
,
239 int flags
, bool quiet
)
241 BlockDriverState
*bs
;
245 if (bdrv_is_encrypted(bs
) && bdrv_key_required(bs
) &&
246 !(flags
& BDRV_O_NO_IO
)) {
247 qprintf(quiet
, "Disk image '%s' is encrypted.\n", filename
);
248 if (qemu_read_password(password
, sizeof(password
)) < 0) {
249 error_report("No password given");
252 if (bdrv_set_key(bs
, password
) < 0) {
253 error_report("invalid password");
261 static BlockBackend
*img_open_opts(const char *optstr
,
262 QemuOpts
*opts
, int flags
, bool writethrough
,
266 Error
*local_err
= NULL
;
268 options
= qemu_opts_to_qdict(opts
, NULL
);
269 blk
= blk_new_open(NULL
, NULL
, options
, flags
, &local_err
);
271 error_reportf_err(local_err
, "Could not open '%s': ", optstr
);
274 blk_set_enable_write_cache(blk
, !writethrough
);
276 if (img_open_password(blk
, optstr
, flags
, quiet
) < 0) {
283 static BlockBackend
*img_open_file(const char *filename
,
284 const char *fmt
, int flags
,
285 bool writethrough
, bool quiet
)
288 Error
*local_err
= NULL
;
289 QDict
*options
= NULL
;
292 options
= qdict_new();
293 qdict_put(options
, "driver", qstring_from_str(fmt
));
296 blk
= blk_new_open(filename
, NULL
, options
, flags
, &local_err
);
298 error_reportf_err(local_err
, "Could not open '%s': ", filename
);
301 blk_set_enable_write_cache(blk
, !writethrough
);
303 if (img_open_password(blk
, filename
, flags
, quiet
) < 0) {
311 static BlockBackend
*img_open(bool image_opts
,
312 const char *filename
,
313 const char *fmt
, int flags
, bool writethrough
,
320 error_report("--image-opts and --format are mutually exclusive");
323 opts
= qemu_opts_parse_noisily(qemu_find_opts("source"),
328 blk
= img_open_opts(filename
, opts
, flags
, writethrough
, quiet
);
330 blk
= img_open_file(filename
, fmt
, flags
, writethrough
, quiet
);
336 static int add_old_style_options(const char *fmt
, QemuOpts
*opts
,
337 const char *base_filename
,
338 const char *base_fmt
)
343 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FILE
, base_filename
, &err
);
345 error_report("Backing file not supported for file format '%s'",
352 qemu_opt_set(opts
, BLOCK_OPT_BACKING_FMT
, base_fmt
, &err
);
354 error_report("Backing file format not supported for file "
363 static int img_create(int argc
, char **argv
)
366 uint64_t img_size
= -1;
367 const char *fmt
= "raw";
368 const char *base_fmt
= NULL
;
369 const char *filename
;
370 const char *base_filename
= NULL
;
371 char *options
= NULL
;
372 Error
*local_err
= NULL
;
376 static const struct option long_options
[] = {
377 {"help", no_argument
, 0, 'h'},
378 {"object", required_argument
, 0, OPTION_OBJECT
},
381 c
= getopt_long(argc
, argv
, "F:b:f:he6o:q",
395 base_filename
= optarg
;
401 error_report("option -e is deprecated, please use \'-o "
402 "encryption\' instead!");
405 error_report("option -6 is deprecated, please use \'-o "
406 "compat6\' instead!");
409 if (!is_valid_option_list(optarg
)) {
410 error_report("Invalid option list: %s", optarg
);
414 options
= g_strdup(optarg
);
416 char *old_options
= options
;
417 options
= g_strdup_printf("%s,%s", options
, optarg
);
424 case OPTION_OBJECT
: {
426 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
435 /* Get the filename */
436 filename
= (optind
< argc
) ? argv
[optind
] : NULL
;
437 if (options
&& has_help_option(options
)) {
439 return print_block_option_help(filename
, fmt
);
442 if (optind
>= argc
) {
443 error_exit("Expecting image file name");
447 if (qemu_opts_foreach(&qemu_object_opts
,
448 user_creatable_add_opts_foreach
,
453 /* Get image size, if specified */
457 sval
= qemu_strtosz_suffix(argv
[optind
++], &end
,
458 QEMU_STRTOSZ_DEFSUFFIX_B
);
459 if (sval
< 0 || *end
) {
460 if (sval
== -ERANGE
) {
461 error_report("Image size must be less than 8 EiB!");
463 error_report("Invalid image size specified! You may use k, M, "
464 "G, T, P or E suffixes for ");
465 error_report("kilobytes, megabytes, gigabytes, terabytes, "
466 "petabytes and exabytes.");
470 img_size
= (uint64_t)sval
;
472 if (optind
!= argc
) {
473 error_exit("Unexpected argument: %s", argv
[optind
]);
476 bdrv_img_create(filename
, fmt
, base_filename
, base_fmt
,
477 options
, img_size
, 0, &local_err
, quiet
);
479 error_reportf_err(local_err
, "%s: ", filename
);
491 static void dump_json_image_check(ImageCheck
*check
, bool quiet
)
495 Visitor
*v
= qmp_output_visitor_new(&obj
);
497 visit_type_ImageCheck(v
, NULL
, &check
, &error_abort
);
498 visit_complete(v
, &obj
);
499 str
= qobject_to_json_pretty(obj
);
501 qprintf(quiet
, "%s\n", qstring_get_str(str
));
507 static void dump_human_image_check(ImageCheck
*check
, bool quiet
)
509 if (!(check
->corruptions
|| check
->leaks
|| check
->check_errors
)) {
510 qprintf(quiet
, "No errors were found on the image.\n");
512 if (check
->corruptions
) {
513 qprintf(quiet
, "\n%" PRId64
" errors were found on the image.\n"
514 "Data may be corrupted, or further writes to the image "
521 "\n%" PRId64
" leaked clusters were found on the image.\n"
522 "This means waste of disk space, but no harm to data.\n",
526 if (check
->check_errors
) {
529 " internal errors have occurred during the check.\n",
530 check
->check_errors
);
534 if (check
->total_clusters
!= 0 && check
->allocated_clusters
!= 0) {
535 qprintf(quiet
, "%" PRId64
"/%" PRId64
" = %0.2f%% allocated, "
536 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
537 check
->allocated_clusters
, check
->total_clusters
,
538 check
->allocated_clusters
* 100.0 / check
->total_clusters
,
539 check
->fragmented_clusters
* 100.0 / check
->allocated_clusters
,
540 check
->compressed_clusters
* 100.0 /
541 check
->allocated_clusters
);
544 if (check
->image_end_offset
) {
546 "Image end offset: %" PRId64
"\n", check
->image_end_offset
);
550 static int collect_image_check(BlockDriverState
*bs
,
552 const char *filename
,
557 BdrvCheckResult result
;
559 ret
= bdrv_check(bs
, &result
, fix
);
564 check
->filename
= g_strdup(filename
);
565 check
->format
= g_strdup(bdrv_get_format_name(bs
));
566 check
->check_errors
= result
.check_errors
;
567 check
->corruptions
= result
.corruptions
;
568 check
->has_corruptions
= result
.corruptions
!= 0;
569 check
->leaks
= result
.leaks
;
570 check
->has_leaks
= result
.leaks
!= 0;
571 check
->corruptions_fixed
= result
.corruptions_fixed
;
572 check
->has_corruptions_fixed
= result
.corruptions
!= 0;
573 check
->leaks_fixed
= result
.leaks_fixed
;
574 check
->has_leaks_fixed
= result
.leaks
!= 0;
575 check
->image_end_offset
= result
.image_end_offset
;
576 check
->has_image_end_offset
= result
.image_end_offset
!= 0;
577 check
->total_clusters
= result
.bfi
.total_clusters
;
578 check
->has_total_clusters
= result
.bfi
.total_clusters
!= 0;
579 check
->allocated_clusters
= result
.bfi
.allocated_clusters
;
580 check
->has_allocated_clusters
= result
.bfi
.allocated_clusters
!= 0;
581 check
->fragmented_clusters
= result
.bfi
.fragmented_clusters
;
582 check
->has_fragmented_clusters
= result
.bfi
.fragmented_clusters
!= 0;
583 check
->compressed_clusters
= result
.bfi
.compressed_clusters
;
584 check
->has_compressed_clusters
= result
.bfi
.compressed_clusters
!= 0;
590 * Checks an image for consistency. Exit codes:
592 * 0 - Check completed, image is good
593 * 1 - Check not completed because of internal errors
594 * 2 - Check completed, image is corrupted
595 * 3 - Check completed, image has leaked clusters, but is good otherwise
596 * 63 - Checks are not supported by the image format
598 static int img_check(int argc
, char **argv
)
601 OutputFormat output_format
= OFORMAT_HUMAN
;
602 const char *filename
, *fmt
, *output
, *cache
;
604 BlockDriverState
*bs
;
606 int flags
= BDRV_O_CHECK
;
610 bool image_opts
= false;
614 cache
= BDRV_DEFAULT_CACHE
;
617 int option_index
= 0;
618 static const struct option long_options
[] = {
619 {"help", no_argument
, 0, 'h'},
620 {"format", required_argument
, 0, 'f'},
621 {"repair", required_argument
, 0, 'r'},
622 {"output", required_argument
, 0, OPTION_OUTPUT
},
623 {"object", required_argument
, 0, OPTION_OBJECT
},
624 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
627 c
= getopt_long(argc
, argv
, "hf:r:T:q",
628 long_options
, &option_index
);
641 flags
|= BDRV_O_RDWR
;
643 if (!strcmp(optarg
, "leaks")) {
644 fix
= BDRV_FIX_LEAKS
;
645 } else if (!strcmp(optarg
, "all")) {
646 fix
= BDRV_FIX_LEAKS
| BDRV_FIX_ERRORS
;
648 error_exit("Unknown option value for -r "
649 "(expecting 'leaks' or 'all'): %s", optarg
);
661 case OPTION_OBJECT
: {
663 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
669 case OPTION_IMAGE_OPTS
:
674 if (optind
!= argc
- 1) {
675 error_exit("Expecting one image file name");
677 filename
= argv
[optind
++];
679 if (output
&& !strcmp(output
, "json")) {
680 output_format
= OFORMAT_JSON
;
681 } else if (output
&& !strcmp(output
, "human")) {
682 output_format
= OFORMAT_HUMAN
;
684 error_report("--output must be used with human or json as argument.");
688 if (qemu_opts_foreach(&qemu_object_opts
,
689 user_creatable_add_opts_foreach
,
694 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
696 error_report("Invalid source cache option: %s", cache
);
700 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
706 check
= g_new0(ImageCheck
, 1);
707 ret
= collect_image_check(bs
, check
, filename
, fmt
, fix
);
709 if (ret
== -ENOTSUP
) {
710 error_report("This image format does not support checks");
715 if (check
->corruptions_fixed
|| check
->leaks_fixed
) {
716 int corruptions_fixed
, leaks_fixed
;
718 leaks_fixed
= check
->leaks_fixed
;
719 corruptions_fixed
= check
->corruptions_fixed
;
721 if (output_format
== OFORMAT_HUMAN
) {
723 "The following inconsistencies were found and repaired:\n\n"
724 " %" PRId64
" leaked clusters\n"
725 " %" PRId64
" corruptions\n\n"
726 "Double checking the fixed image now...\n",
728 check
->corruptions_fixed
);
731 ret
= collect_image_check(bs
, check
, filename
, fmt
, 0);
733 check
->leaks_fixed
= leaks_fixed
;
734 check
->corruptions_fixed
= corruptions_fixed
;
738 switch (output_format
) {
740 dump_human_image_check(check
, quiet
);
743 dump_json_image_check(check
, quiet
);
748 if (ret
|| check
->check_errors
) {
750 error_report("Check failed: %s", strerror(-ret
));
752 error_report("Check failed");
758 if (check
->corruptions
) {
760 } else if (check
->leaks
) {
767 qapi_free_ImageCheck(check
);
772 typedef struct CommonBlockJobCBInfo
{
773 BlockDriverState
*bs
;
775 } CommonBlockJobCBInfo
;
777 static void common_block_job_cb(void *opaque
, int ret
)
779 CommonBlockJobCBInfo
*cbi
= opaque
;
782 error_setg_errno(cbi
->errp
, -ret
, "Block job failed");
786 static void run_block_job(BlockJob
*job
, Error
**errp
)
788 AioContext
*aio_context
= blk_get_aio_context(job
->blk
);
791 aio_poll(aio_context
, true);
792 qemu_progress_print(job
->len
?
793 ((float)job
->offset
/ job
->len
* 100.f
) : 0.0f
, 0);
794 } while (!job
->ready
);
796 block_job_complete_sync(job
, errp
);
798 /* A block job may finish instantaneously without publishing any progress,
799 * so just signal completion here */
800 qemu_progress_print(100.f
, 0);
803 static int img_commit(int argc
, char **argv
)
806 const char *filename
, *fmt
, *cache
, *base
;
808 BlockDriverState
*bs
, *base_bs
;
809 bool progress
= false, quiet
= false, drop
= false;
811 Error
*local_err
= NULL
;
812 CommonBlockJobCBInfo cbi
;
813 bool image_opts
= false;
816 cache
= BDRV_DEFAULT_CACHE
;
819 static const struct option long_options
[] = {
820 {"help", no_argument
, 0, 'h'},
821 {"object", required_argument
, 0, OPTION_OBJECT
},
822 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
825 c
= getopt_long(argc
, argv
, "f:ht:b:dpq",
855 case OPTION_OBJECT
: {
857 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
863 case OPTION_IMAGE_OPTS
:
869 /* Progress is not shown in Quiet mode */
874 if (optind
!= argc
- 1) {
875 error_exit("Expecting one image file name");
877 filename
= argv
[optind
++];
879 if (qemu_opts_foreach(&qemu_object_opts
,
880 user_creatable_add_opts_foreach
,
885 flags
= BDRV_O_RDWR
| BDRV_O_UNMAP
;
886 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
888 error_report("Invalid cache option: %s", cache
);
892 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
898 qemu_progress_init(progress
, 1.f
);
899 qemu_progress_print(0.f
, 100);
902 base_bs
= bdrv_find_backing_image(bs
, base
);
904 error_setg(&local_err
, QERR_BASE_NOT_FOUND
, base
);
908 /* This is different from QMP, which by default uses the deepest file in
909 * the backing chain (i.e., the very base); however, the traditional
910 * behavior of qemu-img commit is using the immediate backing file. */
911 base_bs
= backing_bs(bs
);
913 error_setg(&local_err
, "Image does not have a backing file");
918 cbi
= (CommonBlockJobCBInfo
){
923 commit_active_start("commit", bs
, base_bs
, 0, BLOCKDEV_ON_ERROR_REPORT
,
924 common_block_job_cb
, &cbi
, &local_err
);
929 /* When the block job completes, the BlockBackend reference will point to
930 * the old backing file. In order to avoid that the top image is already
931 * deleted, so we can still empty it afterwards, increment the reference
932 * counter here preemptively. */
937 run_block_job(bs
->job
, &local_err
);
942 if (!drop
&& bs
->drv
->bdrv_make_empty
) {
943 ret
= bs
->drv
->bdrv_make_empty(bs
);
945 error_setg_errno(&local_err
, -ret
, "Could not empty %s",
962 error_report_err(local_err
);
966 qprintf(quiet
, "Image committed.\n");
971 * Returns true iff the first sector pointed to by 'buf' contains at least
974 * 'pnum' is set to the number of sectors (including and immediately following
975 * the first one) that are known to be in the same allocated/unallocated state.
977 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
986 is_zero
= buffer_is_zero(buf
, 512);
987 for(i
= 1; i
< n
; i
++) {
989 if (is_zero
!= buffer_is_zero(buf
, 512)) {
998 * Like is_allocated_sectors, but if the buffer starts with a used sector,
999 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1000 * breaking up write requests for only small sparse areas.
1002 static int is_allocated_sectors_min(const uint8_t *buf
, int n
, int *pnum
,
1006 int num_checked
, num_used
;
1012 ret
= is_allocated_sectors(buf
, n
, pnum
);
1018 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1020 num_checked
= num_used
;
1023 ret
= is_allocated_sectors(buf
, n
, pnum
);
1025 buf
+= BDRV_SECTOR_SIZE
* *pnum
;
1027 num_checked
+= *pnum
;
1029 num_used
= num_checked
;
1030 } else if (*pnum
>= min
) {
1040 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1041 * buffers matches, non-zero otherwise.
1043 * pnum is set to the number of sectors (including and immediately following
1044 * the first one) that are known to have the same comparison result
1046 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
1057 res
= !!memcmp(buf1
, buf2
, 512);
1058 for(i
= 1; i
< n
; i
++) {
1062 if (!!memcmp(buf1
, buf2
, 512) != res
) {
1071 #define IO_BUF_SIZE (2 * 1024 * 1024)
1073 static int64_t sectors_to_bytes(int64_t sectors
)
1075 return sectors
<< BDRV_SECTOR_BITS
;
1078 static int64_t sectors_to_process(int64_t total
, int64_t from
)
1080 return MIN(total
- from
, IO_BUF_SIZE
>> BDRV_SECTOR_BITS
);
1084 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1086 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1087 * data and negative value on error.
1089 * @param blk: BlockBackend for the image
1090 * @param sect_num: Number of first sector to check
1091 * @param sect_count: Number of sectors to check
1092 * @param filename: Name of disk file we are checking (logging purpose)
1093 * @param buffer: Allocated buffer for storing read data
1094 * @param quiet: Flag for quiet mode
1096 static int check_empty_sectors(BlockBackend
*blk
, int64_t sect_num
,
1097 int sect_count
, const char *filename
,
1098 uint8_t *buffer
, bool quiet
)
1101 ret
= blk_pread(blk
, sect_num
<< BDRV_SECTOR_BITS
, buffer
,
1102 sect_count
<< BDRV_SECTOR_BITS
);
1104 error_report("Error while reading offset %" PRId64
" of %s: %s",
1105 sectors_to_bytes(sect_num
), filename
, strerror(-ret
));
1108 ret
= is_allocated_sectors(buffer
, sect_count
, &pnum
);
1109 if (ret
|| pnum
!= sect_count
) {
1110 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1111 sectors_to_bytes(ret
? sect_num
: sect_num
+ pnum
));
1119 * Compares two images. Exit codes:
1121 * 0 - Images are identical
1123 * >1 - Error occurred
1125 static int img_compare(int argc
, char **argv
)
1127 const char *fmt1
= NULL
, *fmt2
= NULL
, *cache
, *filename1
, *filename2
;
1128 BlockBackend
*blk1
, *blk2
;
1129 BlockDriverState
*bs1
, *bs2
;
1130 int64_t total_sectors1
, total_sectors2
;
1131 uint8_t *buf1
= NULL
, *buf2
= NULL
;
1133 int allocated1
, allocated2
;
1134 int ret
= 0; /* return value - 0 Ident, 1 Different, >1 Error */
1135 bool progress
= false, quiet
= false, strict
= false;
1138 int64_t total_sectors
;
1139 int64_t sector_num
= 0;
1142 uint64_t progress_base
;
1143 bool image_opts
= false;
1145 cache
= BDRV_DEFAULT_CACHE
;
1147 static const struct option long_options
[] = {
1148 {"help", no_argument
, 0, 'h'},
1149 {"object", required_argument
, 0, OPTION_OBJECT
},
1150 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1153 c
= getopt_long(argc
, argv
, "hf:F:T:pqs",
1154 long_options
, NULL
);
1181 case OPTION_OBJECT
: {
1183 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1190 case OPTION_IMAGE_OPTS
:
1196 /* Progress is not shown in Quiet mode */
1202 if (optind
!= argc
- 2) {
1203 error_exit("Expecting two image file names");
1205 filename1
= argv
[optind
++];
1206 filename2
= argv
[optind
++];
1208 if (qemu_opts_foreach(&qemu_object_opts
,
1209 user_creatable_add_opts_foreach
,
1215 /* Initialize before goto out */
1216 qemu_progress_init(progress
, 2.0);
1219 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
1221 error_report("Invalid source cache option: %s", cache
);
1226 blk1
= img_open(image_opts
, filename1
, fmt1
, flags
, writethrough
, quiet
);
1232 blk2
= img_open(image_opts
, filename2
, fmt2
, flags
, writethrough
, quiet
);
1240 buf1
= blk_blockalign(blk1
, IO_BUF_SIZE
);
1241 buf2
= blk_blockalign(blk2
, IO_BUF_SIZE
);
1242 total_sectors1
= blk_nb_sectors(blk1
);
1243 if (total_sectors1
< 0) {
1244 error_report("Can't get size of %s: %s",
1245 filename1
, strerror(-total_sectors1
));
1249 total_sectors2
= blk_nb_sectors(blk2
);
1250 if (total_sectors2
< 0) {
1251 error_report("Can't get size of %s: %s",
1252 filename2
, strerror(-total_sectors2
));
1256 total_sectors
= MIN(total_sectors1
, total_sectors2
);
1257 progress_base
= MAX(total_sectors1
, total_sectors2
);
1259 qemu_progress_print(0, 100);
1261 if (strict
&& total_sectors1
!= total_sectors2
) {
1263 qprintf(quiet
, "Strict mode: Image size mismatch!\n");
1268 int64_t status1
, status2
;
1269 BlockDriverState
*file
;
1271 nb_sectors
= sectors_to_process(total_sectors
, sector_num
);
1272 if (nb_sectors
<= 0) {
1275 status1
= bdrv_get_block_status_above(bs1
, NULL
, sector_num
,
1276 total_sectors1
- sector_num
,
1280 error_report("Sector allocation test failed for %s", filename1
);
1283 allocated1
= status1
& BDRV_BLOCK_ALLOCATED
;
1285 status2
= bdrv_get_block_status_above(bs2
, NULL
, sector_num
,
1286 total_sectors2
- sector_num
,
1290 error_report("Sector allocation test failed for %s", filename2
);
1293 allocated2
= status2
& BDRV_BLOCK_ALLOCATED
;
1295 nb_sectors
= MIN(nb_sectors
, pnum1
);
1298 nb_sectors
= MIN(nb_sectors
, pnum2
);
1302 if ((status1
& ~BDRV_BLOCK_OFFSET_MASK
) !=
1303 (status2
& ~BDRV_BLOCK_OFFSET_MASK
)) {
1305 qprintf(quiet
, "Strict mode: Offset %" PRId64
1306 " block status mismatch!\n",
1307 sectors_to_bytes(sector_num
));
1311 if ((status1
& BDRV_BLOCK_ZERO
) && (status2
& BDRV_BLOCK_ZERO
)) {
1312 nb_sectors
= MIN(pnum1
, pnum2
);
1313 } else if (allocated1
== allocated2
) {
1315 ret
= blk_pread(blk1
, sector_num
<< BDRV_SECTOR_BITS
, buf1
,
1316 nb_sectors
<< BDRV_SECTOR_BITS
);
1318 error_report("Error while reading offset %" PRId64
" of %s:"
1319 " %s", sectors_to_bytes(sector_num
), filename1
,
1324 ret
= blk_pread(blk2
, sector_num
<< BDRV_SECTOR_BITS
, buf2
,
1325 nb_sectors
<< BDRV_SECTOR_BITS
);
1327 error_report("Error while reading offset %" PRId64
1328 " of %s: %s", sectors_to_bytes(sector_num
),
1329 filename2
, strerror(-ret
));
1333 ret
= compare_sectors(buf1
, buf2
, nb_sectors
, &pnum
);
1334 if (ret
|| pnum
!= nb_sectors
) {
1335 qprintf(quiet
, "Content mismatch at offset %" PRId64
"!\n",
1337 ret
? sector_num
: sector_num
+ pnum
));
1345 ret
= check_empty_sectors(blk1
, sector_num
, nb_sectors
,
1346 filename1
, buf1
, quiet
);
1348 ret
= check_empty_sectors(blk2
, sector_num
, nb_sectors
,
1349 filename2
, buf1
, quiet
);
1353 error_report("Error while reading offset %" PRId64
": %s",
1354 sectors_to_bytes(sector_num
), strerror(-ret
));
1360 sector_num
+= nb_sectors
;
1361 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1364 if (total_sectors1
!= total_sectors2
) {
1365 BlockBackend
*blk_over
;
1366 int64_t total_sectors_over
;
1367 const char *filename_over
;
1369 qprintf(quiet
, "Warning: Image size mismatch!\n");
1370 if (total_sectors1
> total_sectors2
) {
1371 total_sectors_over
= total_sectors1
;
1373 filename_over
= filename1
;
1375 total_sectors_over
= total_sectors2
;
1377 filename_over
= filename2
;
1381 nb_sectors
= sectors_to_process(total_sectors_over
, sector_num
);
1382 if (nb_sectors
<= 0) {
1385 ret
= bdrv_is_allocated_above(blk_bs(blk_over
), NULL
, sector_num
,
1389 error_report("Sector allocation test failed for %s",
1396 ret
= check_empty_sectors(blk_over
, sector_num
, nb_sectors
,
1397 filename_over
, buf1
, quiet
);
1400 error_report("Error while reading offset %" PRId64
1401 " of %s: %s", sectors_to_bytes(sector_num
),
1402 filename_over
, strerror(-ret
));
1408 sector_num
+= nb_sectors
;
1409 qemu_progress_print(((float) nb_sectors
/ progress_base
)*100, 100);
1413 qprintf(quiet
, "Images are identical.\n");
1423 qemu_progress_end();
1428 enum ImgConvertBlockStatus
{
1434 typedef struct ImgConvertState
{
1436 int64_t *src_sectors
;
1437 int src_cur
, src_num
;
1438 int64_t src_cur_offset
;
1439 int64_t total_sectors
;
1440 int64_t allocated_sectors
;
1441 enum ImgConvertBlockStatus status
;
1442 int64_t sector_next_status
;
1443 BlockBackend
*target
;
1446 bool target_has_backing
;
1448 size_t cluster_sectors
;
1452 static void convert_select_part(ImgConvertState
*s
, int64_t sector_num
)
1454 assert(sector_num
>= s
->src_cur_offset
);
1455 while (sector_num
- s
->src_cur_offset
>= s
->src_sectors
[s
->src_cur
]) {
1456 s
->src_cur_offset
+= s
->src_sectors
[s
->src_cur
];
1458 assert(s
->src_cur
< s
->src_num
);
1462 static int convert_iteration_sectors(ImgConvertState
*s
, int64_t sector_num
)
1467 convert_select_part(s
, sector_num
);
1469 assert(s
->total_sectors
> sector_num
);
1470 n
= MIN(s
->total_sectors
- sector_num
, BDRV_REQUEST_MAX_SECTORS
);
1472 if (s
->sector_next_status
<= sector_num
) {
1473 BlockDriverState
*file
;
1474 ret
= bdrv_get_block_status(blk_bs(s
->src
[s
->src_cur
]),
1475 sector_num
- s
->src_cur_offset
,
1481 if (ret
& BDRV_BLOCK_ZERO
) {
1482 s
->status
= BLK_ZERO
;
1483 } else if (ret
& BDRV_BLOCK_DATA
) {
1484 s
->status
= BLK_DATA
;
1485 } else if (!s
->target_has_backing
) {
1486 /* Without a target backing file we must copy over the contents of
1487 * the backing file as well. */
1488 /* Check block status of the backing file chain to avoid
1489 * needlessly reading zeroes and limiting the iteration to the
1491 ret
= bdrv_get_block_status_above(blk_bs(s
->src
[s
->src_cur
]), NULL
,
1492 sector_num
- s
->src_cur_offset
,
1498 if (ret
& BDRV_BLOCK_ZERO
) {
1499 s
->status
= BLK_ZERO
;
1501 s
->status
= BLK_DATA
;
1504 s
->status
= BLK_BACKING_FILE
;
1507 s
->sector_next_status
= sector_num
+ n
;
1510 n
= MIN(n
, s
->sector_next_status
- sector_num
);
1511 if (s
->status
== BLK_DATA
) {
1512 n
= MIN(n
, s
->buf_sectors
);
1515 /* We need to write complete clusters for compressed images, so if an
1516 * unallocated area is shorter than that, we must consider the whole
1517 * cluster allocated. */
1518 if (s
->compressed
) {
1519 if (n
< s
->cluster_sectors
) {
1520 n
= MIN(s
->cluster_sectors
, s
->total_sectors
- sector_num
);
1521 s
->status
= BLK_DATA
;
1523 n
= QEMU_ALIGN_DOWN(n
, s
->cluster_sectors
);
1530 static int convert_read(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1536 assert(nb_sectors
<= s
->buf_sectors
);
1537 while (nb_sectors
> 0) {
1541 /* In the case of compression with multiple source files, we can get a
1542 * nb_sectors that spreads into the next part. So we must be able to
1543 * read across multiple BDSes for one convert_read() call. */
1544 convert_select_part(s
, sector_num
);
1545 blk
= s
->src
[s
->src_cur
];
1546 bs_sectors
= s
->src_sectors
[s
->src_cur
];
1548 n
= MIN(nb_sectors
, bs_sectors
- (sector_num
- s
->src_cur_offset
));
1549 ret
= blk_pread(blk
,
1550 (sector_num
- s
->src_cur_offset
) << BDRV_SECTOR_BITS
,
1551 buf
, n
<< BDRV_SECTOR_BITS
);
1558 buf
+= n
* BDRV_SECTOR_SIZE
;
1564 static int convert_write(ImgConvertState
*s
, int64_t sector_num
, int nb_sectors
,
1569 while (nb_sectors
> 0) {
1572 switch (s
->status
) {
1573 case BLK_BACKING_FILE
:
1574 /* If we have a backing file, leave clusters unallocated that are
1575 * unallocated in the source image, so that the backing file is
1576 * visible at the respective offset. */
1577 assert(s
->target_has_backing
);
1581 /* We must always write compressed clusters as a whole, so don't
1582 * try to find zeroed parts in the buffer. We can only save the
1583 * write if the buffer is completely zeroed and we're allowed to
1584 * keep the target sparse. */
1585 if (s
->compressed
) {
1586 if (s
->has_zero_init
&& s
->min_sparse
&&
1587 buffer_is_zero(buf
, n
* BDRV_SECTOR_SIZE
))
1589 assert(!s
->target_has_backing
);
1593 ret
= blk_pwrite_compressed(s
->target
,
1594 sector_num
<< BDRV_SECTOR_BITS
,
1595 buf
, n
<< BDRV_SECTOR_BITS
);
1602 /* If there is real non-zero data or we're told to keep the target
1603 * fully allocated (-S 0), we must write it. Otherwise we can treat
1604 * it as zero sectors. */
1605 if (!s
->min_sparse
||
1606 is_allocated_sectors_min(buf
, n
, &n
, s
->min_sparse
))
1608 ret
= blk_pwrite(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1609 buf
, n
<< BDRV_SECTOR_BITS
, 0);
1618 if (s
->has_zero_init
) {
1621 ret
= blk_pwrite_zeroes(s
->target
, sector_num
<< BDRV_SECTOR_BITS
,
1622 n
<< BDRV_SECTOR_BITS
, 0);
1631 buf
+= n
* BDRV_SECTOR_SIZE
;
1637 static int convert_do_copy(ImgConvertState
*s
)
1639 uint8_t *buf
= NULL
;
1640 int64_t sector_num
, allocated_done
;
1644 /* Check whether we have zero initialisation or can get it efficiently */
1645 s
->has_zero_init
= s
->min_sparse
&& !s
->target_has_backing
1646 ? bdrv_has_zero_init(blk_bs(s
->target
))
1649 if (!s
->has_zero_init
&& !s
->target_has_backing
&&
1650 bdrv_can_write_zeroes_with_unmap(blk_bs(s
->target
)))
1652 ret
= blk_make_zero(s
->target
, BDRV_REQ_MAY_UNMAP
);
1654 s
->has_zero_init
= true;
1658 /* Allocate buffer for copied data. For compressed images, only one cluster
1659 * can be copied at a time. */
1660 if (s
->compressed
) {
1661 if (s
->cluster_sectors
<= 0 || s
->cluster_sectors
> s
->buf_sectors
) {
1662 error_report("invalid cluster size");
1666 s
->buf_sectors
= s
->cluster_sectors
;
1668 buf
= blk_blockalign(s
->target
, s
->buf_sectors
* BDRV_SECTOR_SIZE
);
1670 /* Calculate allocated sectors for progress */
1671 s
->allocated_sectors
= 0;
1673 while (sector_num
< s
->total_sectors
) {
1674 n
= convert_iteration_sectors(s
, sector_num
);
1679 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1681 s
->allocated_sectors
+= n
;
1688 s
->src_cur_offset
= 0;
1689 s
->sector_next_status
= 0;
1694 while (sector_num
< s
->total_sectors
) {
1695 n
= convert_iteration_sectors(s
, sector_num
);
1700 if (s
->status
== BLK_DATA
|| (!s
->min_sparse
&& s
->status
== BLK_ZERO
))
1702 allocated_done
+= n
;
1703 qemu_progress_print(100.0 * allocated_done
/ s
->allocated_sectors
,
1707 if (s
->status
== BLK_DATA
) {
1708 ret
= convert_read(s
, sector_num
, n
, buf
);
1710 error_report("error while reading sector %" PRId64
1711 ": %s", sector_num
, strerror(-ret
));
1714 } else if (!s
->min_sparse
&& s
->status
== BLK_ZERO
) {
1715 n
= MIN(n
, s
->buf_sectors
);
1716 memset(buf
, 0, n
* BDRV_SECTOR_SIZE
);
1717 s
->status
= BLK_DATA
;
1720 ret
= convert_write(s
, sector_num
, n
, buf
);
1722 error_report("error while writing sector %" PRId64
1723 ": %s", sector_num
, strerror(-ret
));
1730 if (s
->compressed
) {
1731 /* signal EOF to align */
1732 ret
= blk_pwrite_compressed(s
->target
, 0, NULL
, 0);
1744 static int img_convert(int argc
, char **argv
)
1746 int c
, bs_n
, bs_i
, compress
, cluster_sectors
, skip_create
;
1748 int progress
= 0, flags
, src_flags
;
1749 bool writethrough
, src_writethrough
;
1750 const char *fmt
, *out_fmt
, *cache
, *src_cache
, *out_baseimg
, *out_filename
;
1751 BlockDriver
*drv
, *proto_drv
;
1752 BlockBackend
**blk
= NULL
, *out_blk
= NULL
;
1753 BlockDriverState
**bs
= NULL
, *out_bs
= NULL
;
1754 int64_t total_sectors
;
1755 int64_t *bs_sectors
= NULL
;
1756 size_t bufsectors
= IO_BUF_SIZE
/ BDRV_SECTOR_SIZE
;
1757 BlockDriverInfo bdi
;
1758 QemuOpts
*opts
= NULL
;
1759 QemuOptsList
*create_opts
= NULL
;
1760 const char *out_baseimg_param
;
1761 char *options
= NULL
;
1762 const char *snapshot_name
= NULL
;
1763 int min_sparse
= 8; /* Need at least 4k of zeros for sparse detection */
1765 Error
*local_err
= NULL
;
1766 QemuOpts
*sn_opts
= NULL
;
1767 ImgConvertState state
;
1768 bool image_opts
= false;
1773 src_cache
= BDRV_DEFAULT_CACHE
;
1778 static const struct option long_options
[] = {
1779 {"help", no_argument
, 0, 'h'},
1780 {"object", required_argument
, 0, OPTION_OBJECT
},
1781 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
1784 c
= getopt_long(argc
, argv
, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1785 long_options
, NULL
);
1801 out_baseimg
= optarg
;
1807 error_report("option -e is deprecated, please use \'-o "
1808 "encryption\' instead!");
1812 error_report("option -6 is deprecated, please use \'-o "
1813 "compat6\' instead!");
1817 if (!is_valid_option_list(optarg
)) {
1818 error_report("Invalid option list: %s", optarg
);
1823 options
= g_strdup(optarg
);
1825 char *old_options
= options
;
1826 options
= g_strdup_printf("%s,%s", options
, optarg
);
1827 g_free(old_options
);
1831 snapshot_name
= optarg
;
1834 if (strstart(optarg
, SNAPSHOT_OPT_BASE
, NULL
)) {
1835 sn_opts
= qemu_opts_parse_noisily(&internal_snapshot_opts
,
1838 error_report("Failed in parsing snapshot param '%s'",
1844 snapshot_name
= optarg
;
1851 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
1852 if (sval
< 0 || *end
) {
1853 error_report("Invalid minimum zero buffer size for sparse output specified");
1858 min_sparse
= sval
/ BDRV_SECTOR_SIZE
;
1877 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
1883 case OPTION_IMAGE_OPTS
:
1889 if (qemu_opts_foreach(&qemu_object_opts
,
1890 user_creatable_add_opts_foreach
,
1895 /* Initialize before goto out */
1899 qemu_progress_init(progress
, 1.0);
1901 bs_n
= argc
- optind
- 1;
1902 out_filename
= bs_n
>= 1 ? argv
[argc
- 1] : NULL
;
1904 if (options
&& has_help_option(options
)) {
1905 ret
= print_block_option_help(out_filename
, out_fmt
);
1910 error_exit("Must specify image file name");
1914 if (bs_n
> 1 && out_baseimg
) {
1915 error_report("-B makes no sense when concatenating multiple input "
1922 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
1924 error_report("Invalid source cache option: %s", src_cache
);
1928 qemu_progress_print(0, 100);
1930 blk
= g_new0(BlockBackend
*, bs_n
);
1931 bs
= g_new0(BlockDriverState
*, bs_n
);
1932 bs_sectors
= g_new(int64_t, bs_n
);
1935 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
1936 blk
[bs_i
] = img_open(image_opts
, argv
[optind
+ bs_i
],
1937 fmt
, src_flags
, src_writethrough
, quiet
);
1942 bs
[bs_i
] = blk_bs(blk
[bs_i
]);
1943 bs_sectors
[bs_i
] = blk_nb_sectors(blk
[bs_i
]);
1944 if (bs_sectors
[bs_i
] < 0) {
1945 error_report("Could not get size of %s: %s",
1946 argv
[optind
+ bs_i
], strerror(-bs_sectors
[bs_i
]));
1950 total_sectors
+= bs_sectors
[bs_i
];
1954 ret
= bdrv_snapshot_load_tmp(bs
[0],
1955 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_ID
),
1956 qemu_opt_get(sn_opts
, SNAPSHOT_OPT_NAME
),
1958 } else if (snapshot_name
!= NULL
) {
1960 error_report("No support for concatenating multiple snapshot");
1965 bdrv_snapshot_load_tmp_by_id_or_name(bs
[0], snapshot_name
, &local_err
);
1968 error_reportf_err(local_err
, "Failed to load snapshot: ");
1973 /* Find driver and parse its options */
1974 drv
= bdrv_find_format(out_fmt
);
1976 error_report("Unknown file format '%s'", out_fmt
);
1981 proto_drv
= bdrv_find_protocol(out_filename
, true, &local_err
);
1983 error_report_err(local_err
);
1989 if (!drv
->create_opts
) {
1990 error_report("Format driver '%s' does not support image creation",
1996 if (!proto_drv
->create_opts
) {
1997 error_report("Protocol driver '%s' does not support image creation",
1998 proto_drv
->format_name
);
2003 create_opts
= qemu_opts_append(create_opts
, drv
->create_opts
);
2004 create_opts
= qemu_opts_append(create_opts
, proto_drv
->create_opts
);
2006 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
2008 qemu_opts_do_parse(opts
, options
, NULL
, &local_err
);
2010 error_report_err(local_err
);
2016 qemu_opt_set_number(opts
, BLOCK_OPT_SIZE
, total_sectors
* 512,
2018 ret
= add_old_style_options(out_fmt
, opts
, out_baseimg
, NULL
);
2024 /* Get backing file name if -o backing_file was used */
2025 out_baseimg_param
= qemu_opt_get(opts
, BLOCK_OPT_BACKING_FILE
);
2026 if (out_baseimg_param
) {
2027 out_baseimg
= out_baseimg_param
;
2030 /* Check if compression is supported */
2033 qemu_opt_get_bool(opts
, BLOCK_OPT_ENCRYPT
, false);
2034 const char *preallocation
=
2035 qemu_opt_get(opts
, BLOCK_OPT_PREALLOC
);
2037 if (!drv
->bdrv_co_pwritev_compressed
) {
2038 error_report("Compression not supported for this file format");
2044 error_report("Compression and encryption not supported at "
2051 && strcmp(preallocation
, "off"))
2053 error_report("Compression and preallocation not supported at "
2061 /* Create the new image */
2062 ret
= bdrv_create(drv
, out_filename
, opts
, &local_err
);
2064 error_reportf_err(local_err
, "%s: error while converting %s: ",
2065 out_filename
, out_fmt
);
2070 flags
= min_sparse
? (BDRV_O_RDWR
| BDRV_O_UNMAP
) : BDRV_O_RDWR
;
2071 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2073 error_report("Invalid cache option: %s", cache
);
2077 /* XXX we should allow --image-opts to trigger use of
2078 * img_open() here, but then we have trouble with
2079 * the bdrv_create() call which takes different params.
2080 * Not critical right now, so fix can wait...
2082 out_blk
= img_open_file(out_filename
, out_fmt
, flags
, writethrough
, quiet
);
2087 out_bs
= blk_bs(out_blk
);
2089 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2090 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2092 bufsectors
= MIN(32768,
2094 MAX(out_bs
->bl
.opt_transfer
>> BDRV_SECTOR_BITS
,
2095 out_bs
->bl
.pdiscard_alignment
>>
2096 BDRV_SECTOR_BITS
)));
2099 int64_t output_sectors
= blk_nb_sectors(out_blk
);
2100 if (output_sectors
< 0) {
2101 error_report("unable to get output image length: %s",
2102 strerror(-output_sectors
));
2105 } else if (output_sectors
< total_sectors
) {
2106 error_report("output file is smaller than input file");
2112 cluster_sectors
= 0;
2113 ret
= bdrv_get_info(out_bs
, &bdi
);
2116 error_report("could not get block driver info");
2120 compress
= compress
|| bdi
.needs_compressed_writes
;
2121 cluster_sectors
= bdi
.cluster_size
/ BDRV_SECTOR_SIZE
;
2124 state
= (ImgConvertState
) {
2126 .src_sectors
= bs_sectors
,
2128 .total_sectors
= total_sectors
,
2130 .compressed
= compress
,
2131 .target_has_backing
= (bool) out_baseimg
,
2132 .min_sparse
= min_sparse
,
2133 .cluster_sectors
= cluster_sectors
,
2134 .buf_sectors
= bufsectors
,
2136 ret
= convert_do_copy(&state
);
2140 qemu_progress_print(100, 0);
2142 qemu_progress_end();
2143 qemu_opts_del(opts
);
2144 qemu_opts_free(create_opts
);
2145 qemu_opts_del(sn_opts
);
2149 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
2150 blk_unref(blk
[bs_i
]);
2165 static void dump_snapshots(BlockDriverState
*bs
)
2167 QEMUSnapshotInfo
*sn_tab
, *sn
;
2170 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
2173 printf("Snapshot list:\n");
2174 bdrv_snapshot_dump(fprintf
, stdout
, NULL
);
2176 for(i
= 0; i
< nb_sns
; i
++) {
2178 bdrv_snapshot_dump(fprintf
, stdout
, sn
);
2184 static void dump_json_image_info_list(ImageInfoList
*list
)
2188 Visitor
*v
= qmp_output_visitor_new(&obj
);
2190 visit_type_ImageInfoList(v
, NULL
, &list
, &error_abort
);
2191 visit_complete(v
, &obj
);
2192 str
= qobject_to_json_pretty(obj
);
2193 assert(str
!= NULL
);
2194 printf("%s\n", qstring_get_str(str
));
2195 qobject_decref(obj
);
2200 static void dump_json_image_info(ImageInfo
*info
)
2204 Visitor
*v
= qmp_output_visitor_new(&obj
);
2206 visit_type_ImageInfo(v
, NULL
, &info
, &error_abort
);
2207 visit_complete(v
, &obj
);
2208 str
= qobject_to_json_pretty(obj
);
2209 assert(str
!= NULL
);
2210 printf("%s\n", qstring_get_str(str
));
2211 qobject_decref(obj
);
2216 static void dump_human_image_info_list(ImageInfoList
*list
)
2218 ImageInfoList
*elem
;
2221 for (elem
= list
; elem
; elem
= elem
->next
) {
2227 bdrv_image_info_dump(fprintf
, stdout
, elem
->value
);
2231 static gboolean
str_equal_func(gconstpointer a
, gconstpointer b
)
2233 return strcmp(a
, b
) == 0;
2237 * Open an image file chain and return an ImageInfoList
2239 * @filename: topmost image filename
2240 * @fmt: topmost image format (may be NULL to autodetect)
2241 * @chain: true - enumerate entire backing file chain
2242 * false - only topmost image file
2244 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2245 * image file. If there was an error a message will have been printed to
2248 static ImageInfoList
*collect_image_info_list(bool image_opts
,
2249 const char *filename
,
2253 ImageInfoList
*head
= NULL
;
2254 ImageInfoList
**last
= &head
;
2255 GHashTable
*filenames
;
2258 filenames
= g_hash_table_new_full(g_str_hash
, str_equal_func
, NULL
, NULL
);
2262 BlockDriverState
*bs
;
2264 ImageInfoList
*elem
;
2266 if (g_hash_table_lookup_extended(filenames
, filename
, NULL
, NULL
)) {
2267 error_report("Backing file '%s' creates an infinite loop.",
2271 g_hash_table_insert(filenames
, (gpointer
)filename
, NULL
);
2273 blk
= img_open(image_opts
, filename
, fmt
,
2274 BDRV_O_NO_BACKING
| BDRV_O_NO_IO
, false, false);
2280 bdrv_query_image_info(bs
, &info
, &err
);
2282 error_report_err(err
);
2287 elem
= g_new0(ImageInfoList
, 1);
2294 filename
= fmt
= NULL
;
2296 if (info
->has_full_backing_filename
) {
2297 filename
= info
->full_backing_filename
;
2298 } else if (info
->has_backing_filename
) {
2299 error_report("Could not determine absolute backing filename,"
2300 " but backing filename '%s' present",
2301 info
->backing_filename
);
2304 if (info
->has_backing_filename_format
) {
2305 fmt
= info
->backing_filename_format
;
2309 g_hash_table_destroy(filenames
);
2313 qapi_free_ImageInfoList(head
);
2314 g_hash_table_destroy(filenames
);
2318 static int img_info(int argc
, char **argv
)
2321 OutputFormat output_format
= OFORMAT_HUMAN
;
2323 const char *filename
, *fmt
, *output
;
2324 ImageInfoList
*list
;
2325 bool image_opts
= false;
2330 int option_index
= 0;
2331 static const struct option long_options
[] = {
2332 {"help", no_argument
, 0, 'h'},
2333 {"format", required_argument
, 0, 'f'},
2334 {"output", required_argument
, 0, OPTION_OUTPUT
},
2335 {"backing-chain", no_argument
, 0, OPTION_BACKING_CHAIN
},
2336 {"object", required_argument
, 0, OPTION_OBJECT
},
2337 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2340 c
= getopt_long(argc
, argv
, "f:h",
2341 long_options
, &option_index
);
2356 case OPTION_BACKING_CHAIN
:
2359 case OPTION_OBJECT
: {
2361 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2367 case OPTION_IMAGE_OPTS
:
2372 if (optind
!= argc
- 1) {
2373 error_exit("Expecting one image file name");
2375 filename
= argv
[optind
++];
2377 if (output
&& !strcmp(output
, "json")) {
2378 output_format
= OFORMAT_JSON
;
2379 } else if (output
&& !strcmp(output
, "human")) {
2380 output_format
= OFORMAT_HUMAN
;
2381 } else if (output
) {
2382 error_report("--output must be used with human or json as argument.");
2386 if (qemu_opts_foreach(&qemu_object_opts
,
2387 user_creatable_add_opts_foreach
,
2392 list
= collect_image_info_list(image_opts
, filename
, fmt
, chain
);
2397 switch (output_format
) {
2399 dump_human_image_info_list(list
);
2403 dump_json_image_info_list(list
);
2405 dump_json_image_info(list
->value
);
2410 qapi_free_ImageInfoList(list
);
2414 static void dump_map_entry(OutputFormat output_format
, MapEntry
*e
,
2417 switch (output_format
) {
2419 if (e
->data
&& !e
->has_offset
) {
2420 error_report("File contains external, encrypted or compressed clusters.");
2423 if (e
->data
&& !e
->zero
) {
2424 printf("%#-16"PRIx64
"%#-16"PRIx64
"%#-16"PRIx64
"%s\n",
2425 e
->start
, e
->length
,
2426 e
->has_offset
? e
->offset
: 0,
2427 e
->has_filename
? e
->filename
: "");
2429 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2430 * Modify the flags here to allow more coalescing.
2432 if (next
&& (!next
->data
|| next
->zero
)) {
2438 printf("%s{ \"start\": %"PRId64
", \"length\": %"PRId64
","
2439 " \"depth\": %"PRId64
", \"zero\": %s, \"data\": %s",
2440 (e
->start
== 0 ? "[" : ",\n"),
2441 e
->start
, e
->length
, e
->depth
,
2442 e
->zero
? "true" : "false",
2443 e
->data
? "true" : "false");
2444 if (e
->has_offset
) {
2445 printf(", \"offset\": %"PRId64
"", e
->offset
);
2456 static int get_block_status(BlockDriverState
*bs
, int64_t sector_num
,
2457 int nb_sectors
, MapEntry
*e
)
2461 BlockDriverState
*file
;
2464 /* As an optimization, we could cache the current range of unallocated
2465 * clusters in each file of the chain, and avoid querying the same
2471 ret
= bdrv_get_block_status(bs
, sector_num
, nb_sectors
, &nb_sectors
,
2477 if (ret
& (BDRV_BLOCK_ZERO
|BDRV_BLOCK_DATA
)) {
2480 bs
= backing_bs(bs
);
2489 has_offset
= !!(ret
& BDRV_BLOCK_OFFSET_VALID
);
2492 .start
= sector_num
* BDRV_SECTOR_SIZE
,
2493 .length
= nb_sectors
* BDRV_SECTOR_SIZE
,
2494 .data
= !!(ret
& BDRV_BLOCK_DATA
),
2495 .zero
= !!(ret
& BDRV_BLOCK_ZERO
),
2496 .offset
= ret
& BDRV_BLOCK_OFFSET_MASK
,
2497 .has_offset
= has_offset
,
2499 .has_filename
= file
&& has_offset
,
2500 .filename
= file
&& has_offset
? file
->filename
: NULL
,
2506 static inline bool entry_mergeable(const MapEntry
*curr
, const MapEntry
*next
)
2508 if (curr
->length
== 0) {
2511 if (curr
->zero
!= next
->zero
||
2512 curr
->data
!= next
->data
||
2513 curr
->depth
!= next
->depth
||
2514 curr
->has_filename
!= next
->has_filename
||
2515 curr
->has_offset
!= next
->has_offset
) {
2518 if (curr
->has_filename
&& strcmp(curr
->filename
, next
->filename
)) {
2521 if (curr
->has_offset
&& curr
->offset
+ curr
->length
!= next
->offset
) {
2527 static int img_map(int argc
, char **argv
)
2530 OutputFormat output_format
= OFORMAT_HUMAN
;
2532 BlockDriverState
*bs
;
2533 const char *filename
, *fmt
, *output
;
2535 MapEntry curr
= { .length
= 0 }, next
;
2537 bool image_opts
= false;
2542 int option_index
= 0;
2543 static const struct option long_options
[] = {
2544 {"help", no_argument
, 0, 'h'},
2545 {"format", required_argument
, 0, 'f'},
2546 {"output", required_argument
, 0, OPTION_OUTPUT
},
2547 {"object", required_argument
, 0, OPTION_OBJECT
},
2548 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2551 c
= getopt_long(argc
, argv
, "f:h",
2552 long_options
, &option_index
);
2567 case OPTION_OBJECT
: {
2569 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2575 case OPTION_IMAGE_OPTS
:
2580 if (optind
!= argc
- 1) {
2581 error_exit("Expecting one image file name");
2583 filename
= argv
[optind
];
2585 if (output
&& !strcmp(output
, "json")) {
2586 output_format
= OFORMAT_JSON
;
2587 } else if (output
&& !strcmp(output
, "human")) {
2588 output_format
= OFORMAT_HUMAN
;
2589 } else if (output
) {
2590 error_report("--output must be used with human or json as argument.");
2594 if (qemu_opts_foreach(&qemu_object_opts
,
2595 user_creatable_add_opts_foreach
,
2600 blk
= img_open(image_opts
, filename
, fmt
, 0, false, false);
2606 if (output_format
== OFORMAT_HUMAN
) {
2607 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2610 length
= blk_getlength(blk
);
2611 while (curr
.start
+ curr
.length
< length
) {
2612 int64_t nsectors_left
;
2616 sector_num
= (curr
.start
+ curr
.length
) >> BDRV_SECTOR_BITS
;
2618 /* Probe up to 1 GiB at a time. */
2619 nsectors_left
= DIV_ROUND_UP(length
, BDRV_SECTOR_SIZE
) - sector_num
;
2620 n
= MIN(1 << (30 - BDRV_SECTOR_BITS
), nsectors_left
);
2621 ret
= get_block_status(bs
, sector_num
, n
, &next
);
2624 error_report("Could not read file metadata: %s", strerror(-ret
));
2628 if (entry_mergeable(&curr
, &next
)) {
2629 curr
.length
+= next
.length
;
2633 if (curr
.length
> 0) {
2634 dump_map_entry(output_format
, &curr
, &next
);
2639 dump_map_entry(output_format
, &curr
, NULL
);
2646 #define SNAPSHOT_LIST 1
2647 #define SNAPSHOT_CREATE 2
2648 #define SNAPSHOT_APPLY 3
2649 #define SNAPSHOT_DELETE 4
2651 static int img_snapshot(int argc
, char **argv
)
2654 BlockDriverState
*bs
;
2655 QEMUSnapshotInfo sn
;
2656 char *filename
, *snapshot_name
= NULL
;
2657 int c
, ret
= 0, bdrv_oflags
;
2662 bool image_opts
= false;
2664 bdrv_oflags
= BDRV_O_RDWR
;
2665 /* Parse commandline parameters */
2667 static const struct option long_options
[] = {
2668 {"help", no_argument
, 0, 'h'},
2669 {"object", required_argument
, 0, OPTION_OBJECT
},
2670 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2673 c
= getopt_long(argc
, argv
, "la:c:d:hq",
2674 long_options
, NULL
);
2685 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2688 action
= SNAPSHOT_LIST
;
2689 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
2693 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2696 action
= SNAPSHOT_APPLY
;
2697 snapshot_name
= optarg
;
2701 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2704 action
= SNAPSHOT_CREATE
;
2705 snapshot_name
= optarg
;
2709 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2712 action
= SNAPSHOT_DELETE
;
2713 snapshot_name
= optarg
;
2718 case OPTION_OBJECT
: {
2720 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2726 case OPTION_IMAGE_OPTS
:
2732 if (optind
!= argc
- 1) {
2733 error_exit("Expecting one image file name");
2735 filename
= argv
[optind
++];
2737 if (qemu_opts_foreach(&qemu_object_opts
,
2738 user_creatable_add_opts_foreach
,
2743 /* Open the image */
2744 blk
= img_open(image_opts
, filename
, NULL
, bdrv_oflags
, false, quiet
);
2750 /* Perform the requested action */
2756 case SNAPSHOT_CREATE
:
2757 memset(&sn
, 0, sizeof(sn
));
2758 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
2760 qemu_gettimeofday(&tv
);
2761 sn
.date_sec
= tv
.tv_sec
;
2762 sn
.date_nsec
= tv
.tv_usec
* 1000;
2764 ret
= bdrv_snapshot_create(bs
, &sn
);
2766 error_report("Could not create snapshot '%s': %d (%s)",
2767 snapshot_name
, ret
, strerror(-ret
));
2771 case SNAPSHOT_APPLY
:
2772 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
2774 error_report("Could not apply snapshot '%s': %d (%s)",
2775 snapshot_name
, ret
, strerror(-ret
));
2779 case SNAPSHOT_DELETE
:
2780 bdrv_snapshot_delete_by_id_or_name(bs
, snapshot_name
, &err
);
2782 error_reportf_err(err
, "Could not delete snapshot '%s': ",
2797 static int img_rebase(int argc
, char **argv
)
2799 BlockBackend
*blk
= NULL
, *blk_old_backing
= NULL
, *blk_new_backing
= NULL
;
2800 uint8_t *buf_old
= NULL
;
2801 uint8_t *buf_new
= NULL
;
2802 BlockDriverState
*bs
= NULL
;
2804 const char *fmt
, *cache
, *src_cache
, *out_basefmt
, *out_baseimg
;
2805 int c
, flags
, src_flags
, ret
;
2806 bool writethrough
, src_writethrough
;
2810 Error
*local_err
= NULL
;
2811 bool image_opts
= false;
2813 /* Parse commandline parameters */
2815 cache
= BDRV_DEFAULT_CACHE
;
2816 src_cache
= BDRV_DEFAULT_CACHE
;
2820 static const struct option long_options
[] = {
2821 {"help", no_argument
, 0, 'h'},
2822 {"object", required_argument
, 0, OPTION_OBJECT
},
2823 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
2826 c
= getopt_long(argc
, argv
, "hf:F:b:upt:T:q",
2827 long_options
, NULL
);
2840 out_basefmt
= optarg
;
2843 out_baseimg
= optarg
;
2860 case OPTION_OBJECT
: {
2862 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
2868 case OPTION_IMAGE_OPTS
:
2878 if (optind
!= argc
- 1) {
2879 error_exit("Expecting one image file name");
2881 if (!unsafe
&& !out_baseimg
) {
2882 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2884 filename
= argv
[optind
++];
2886 if (qemu_opts_foreach(&qemu_object_opts
,
2887 user_creatable_add_opts_foreach
,
2892 qemu_progress_init(progress
, 2.0);
2893 qemu_progress_print(0, 100);
2895 flags
= BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
2896 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
2898 error_report("Invalid cache option: %s", cache
);
2903 ret
= bdrv_parse_cache_mode(src_cache
, &src_flags
, &src_writethrough
);
2905 error_report("Invalid source cache option: %s", src_cache
);
2909 /* The source files are opened read-only, don't care about WCE */
2910 assert((src_flags
& BDRV_O_RDWR
) == 0);
2911 (void) src_writethrough
;
2916 * Ignore the old backing file for unsafe rebase in case we want to correct
2917 * the reference to a renamed or moved backing file.
2919 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
2926 if (out_basefmt
!= NULL
) {
2927 if (bdrv_find_format(out_basefmt
) == NULL
) {
2928 error_report("Invalid format name: '%s'", out_basefmt
);
2934 /* For safe rebasing we need to compare old and new backing file */
2936 char backing_name
[PATH_MAX
];
2937 QDict
*options
= NULL
;
2939 if (bs
->backing_format
[0] != '\0') {
2940 options
= qdict_new();
2941 qdict_put(options
, "driver", qstring_from_str(bs
->backing_format
));
2944 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
2945 blk_old_backing
= blk_new_open(backing_name
, NULL
,
2946 options
, src_flags
, &local_err
);
2947 if (!blk_old_backing
) {
2948 error_reportf_err(local_err
,
2949 "Could not open old backing file '%s': ",
2954 if (out_baseimg
[0]) {
2956 options
= qdict_new();
2957 qdict_put(options
, "driver", qstring_from_str(out_basefmt
));
2962 blk_new_backing
= blk_new_open(out_baseimg
, NULL
,
2963 options
, src_flags
, &local_err
);
2964 if (!blk_new_backing
) {
2965 error_reportf_err(local_err
,
2966 "Could not open new backing file '%s': ",
2974 * Check each unallocated cluster in the COW file. If it is unallocated,
2975 * accesses go to the backing file. We must therefore compare this cluster
2976 * in the old and new backing file, and if they differ we need to copy it
2977 * from the old backing file into the COW file.
2979 * If qemu-img crashes during this step, no harm is done. The content of
2980 * the image is the same as the original one at any time.
2983 int64_t num_sectors
;
2984 int64_t old_backing_num_sectors
;
2985 int64_t new_backing_num_sectors
= 0;
2988 float local_progress
= 0;
2990 buf_old
= blk_blockalign(blk
, IO_BUF_SIZE
);
2991 buf_new
= blk_blockalign(blk
, IO_BUF_SIZE
);
2993 num_sectors
= blk_nb_sectors(blk
);
2994 if (num_sectors
< 0) {
2995 error_report("Could not get size of '%s': %s",
2996 filename
, strerror(-num_sectors
));
3000 old_backing_num_sectors
= blk_nb_sectors(blk_old_backing
);
3001 if (old_backing_num_sectors
< 0) {
3002 char backing_name
[PATH_MAX
];
3004 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
3005 error_report("Could not get size of '%s': %s",
3006 backing_name
, strerror(-old_backing_num_sectors
));
3010 if (blk_new_backing
) {
3011 new_backing_num_sectors
= blk_nb_sectors(blk_new_backing
);
3012 if (new_backing_num_sectors
< 0) {
3013 error_report("Could not get size of '%s': %s",
3014 out_baseimg
, strerror(-new_backing_num_sectors
));
3020 if (num_sectors
!= 0) {
3021 local_progress
= (float)100 /
3022 (num_sectors
/ MIN(num_sectors
, IO_BUF_SIZE
/ 512));
3025 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
3027 /* How many sectors can we handle with the next read? */
3028 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
3029 n
= (IO_BUF_SIZE
/ 512);
3031 n
= num_sectors
- sector
;
3034 /* If the cluster is allocated, we don't need to take action */
3035 ret
= bdrv_is_allocated(bs
, sector
, n
, &n
);
3037 error_report("error while reading image metadata: %s",
3046 * Read old and new backing file and take into consideration that
3047 * backing files may be smaller than the COW image.
3049 if (sector
>= old_backing_num_sectors
) {
3050 memset(buf_old
, 0, n
* BDRV_SECTOR_SIZE
);
3052 if (sector
+ n
> old_backing_num_sectors
) {
3053 n
= old_backing_num_sectors
- sector
;
3056 ret
= blk_pread(blk_old_backing
, sector
<< BDRV_SECTOR_BITS
,
3057 buf_old
, n
<< BDRV_SECTOR_BITS
);
3059 error_report("error while reading from old backing file");
3064 if (sector
>= new_backing_num_sectors
|| !blk_new_backing
) {
3065 memset(buf_new
, 0, n
* BDRV_SECTOR_SIZE
);
3067 if (sector
+ n
> new_backing_num_sectors
) {
3068 n
= new_backing_num_sectors
- sector
;
3071 ret
= blk_pread(blk_new_backing
, sector
<< BDRV_SECTOR_BITS
,
3072 buf_new
, n
<< BDRV_SECTOR_BITS
);
3074 error_report("error while reading from new backing file");
3079 /* If they differ, we need to write to the COW file */
3080 uint64_t written
= 0;
3082 while (written
< n
) {
3085 if (compare_sectors(buf_old
+ written
* 512,
3086 buf_new
+ written
* 512, n
- written
, &pnum
))
3088 ret
= blk_pwrite(blk
,
3089 (sector
+ written
) << BDRV_SECTOR_BITS
,
3090 buf_old
+ written
* 512,
3091 pnum
<< BDRV_SECTOR_BITS
, 0);
3093 error_report("Error while writing to COW image: %s",
3101 qemu_progress_print(local_progress
, 100);
3106 * Change the backing file. All clusters that are different from the old
3107 * backing file are overwritten in the COW file now, so the visible content
3108 * doesn't change when we switch the backing file.
3110 if (out_baseimg
&& *out_baseimg
) {
3111 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
3113 ret
= bdrv_change_backing_file(bs
, NULL
, NULL
);
3116 if (ret
== -ENOSPC
) {
3117 error_report("Could not change the backing file to '%s': No "
3118 "space left in the file header", out_baseimg
);
3119 } else if (ret
< 0) {
3120 error_report("Could not change the backing file to '%s': %s",
3121 out_baseimg
, strerror(-ret
));
3124 qemu_progress_print(100, 0);
3126 * TODO At this point it is possible to check if any clusters that are
3127 * allocated in the COW file are the same in the backing file. If so, they
3128 * could be dropped from the COW file. Don't do this before switching the
3129 * backing file, in case of a crash this would lead to corruption.
3132 qemu_progress_end();
3135 blk_unref(blk_old_backing
);
3136 blk_unref(blk_new_backing
);
3138 qemu_vfree(buf_old
);
3139 qemu_vfree(buf_new
);
3148 static int img_resize(int argc
, char **argv
)
3151 int c
, ret
, relative
;
3152 const char *filename
, *fmt
, *size
;
3153 int64_t n
, total_size
;
3155 BlockBackend
*blk
= NULL
;
3158 static QemuOptsList resize_options
= {
3159 .name
= "resize_options",
3160 .head
= QTAILQ_HEAD_INITIALIZER(resize_options
.head
),
3163 .name
= BLOCK_OPT_SIZE
,
3164 .type
= QEMU_OPT_SIZE
,
3165 .help
= "Virtual disk size"
3171 bool image_opts
= false;
3173 /* Remove size from argv manually so that negative numbers are not treated
3174 * as options by getopt. */
3176 error_exit("Not enough arguments");
3180 size
= argv
[--argc
];
3182 /* Parse getopt arguments */
3185 static const struct option long_options
[] = {
3186 {"help", no_argument
, 0, 'h'},
3187 {"object", required_argument
, 0, OPTION_OBJECT
},
3188 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3191 c
= getopt_long(argc
, argv
, "f:hq",
3192 long_options
, NULL
);
3207 case OPTION_OBJECT
: {
3209 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3215 case OPTION_IMAGE_OPTS
:
3220 if (optind
!= argc
- 1) {
3221 error_exit("Expecting one image file name");
3223 filename
= argv
[optind
++];
3225 if (qemu_opts_foreach(&qemu_object_opts
,
3226 user_creatable_add_opts_foreach
,
3231 /* Choose grow, shrink, or absolute resize mode */
3247 param
= qemu_opts_create(&resize_options
, NULL
, 0, &error_abort
);
3248 qemu_opt_set(param
, BLOCK_OPT_SIZE
, size
, &err
);
3250 error_report_err(err
);
3252 qemu_opts_del(param
);
3255 n
= qemu_opt_get_size(param
, BLOCK_OPT_SIZE
, 0);
3256 qemu_opts_del(param
);
3258 blk
= img_open(image_opts
, filename
, fmt
,
3259 BDRV_O_RDWR
, false, quiet
);
3266 total_size
= blk_getlength(blk
) + n
* relative
;
3270 if (total_size
<= 0) {
3271 error_report("New image size must be positive");
3276 ret
= blk_truncate(blk
, total_size
);
3279 qprintf(quiet
, "Image resized.\n");
3282 error_report("This image does not support resize");
3285 error_report("Image is read-only");
3288 error_report("Error resizing image: %s", strerror(-ret
));
3299 static void amend_status_cb(BlockDriverState
*bs
,
3300 int64_t offset
, int64_t total_work_size
,
3303 qemu_progress_print(100.f
* offset
/ total_work_size
, 0);
3306 static int img_amend(int argc
, char **argv
)
3310 char *options
= NULL
;
3311 QemuOptsList
*create_opts
= NULL
;
3312 QemuOpts
*opts
= NULL
;
3313 const char *fmt
= NULL
, *filename
, *cache
;
3316 bool quiet
= false, progress
= false;
3317 BlockBackend
*blk
= NULL
;
3318 BlockDriverState
*bs
= NULL
;
3319 bool image_opts
= false;
3321 cache
= BDRV_DEFAULT_CACHE
;
3323 static const struct option long_options
[] = {
3324 {"help", no_argument
, 0, 'h'},
3325 {"object", required_argument
, 0, OPTION_OBJECT
},
3326 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3329 c
= getopt_long(argc
, argv
, "ho:f:t:pq",
3330 long_options
, NULL
);
3341 if (!is_valid_option_list(optarg
)) {
3342 error_report("Invalid option list: %s", optarg
);
3344 goto out_no_progress
;
3347 options
= g_strdup(optarg
);
3349 char *old_options
= options
;
3350 options
= g_strdup_printf("%s,%s", options
, optarg
);
3351 g_free(old_options
);
3367 opts
= qemu_opts_parse_noisily(&qemu_object_opts
,
3371 goto out_no_progress
;
3374 case OPTION_IMAGE_OPTS
:
3381 error_exit("Must specify options (-o)");
3384 if (qemu_opts_foreach(&qemu_object_opts
,
3385 user_creatable_add_opts_foreach
,
3388 goto out_no_progress
;
3394 qemu_progress_init(progress
, 1.0);
3396 filename
= (optind
== argc
- 1) ? argv
[argc
- 1] : NULL
;
3397 if (fmt
&& has_help_option(options
)) {
3398 /* If a format is explicitly specified (and possibly no filename is
3399 * given), print option help here */
3400 ret
= print_block_option_help(filename
, fmt
);
3404 if (optind
!= argc
- 1) {
3405 error_report("Expecting one image file name");
3410 flags
= BDRV_O_RDWR
;
3411 ret
= bdrv_parse_cache_mode(cache
, &flags
, &writethrough
);
3413 error_report("Invalid cache option: %s", cache
);
3417 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3424 fmt
= bs
->drv
->format_name
;
3426 if (has_help_option(options
)) {
3427 /* If the format was auto-detected, print option help here */
3428 ret
= print_block_option_help(filename
, fmt
);
3432 if (!bs
->drv
->create_opts
) {
3433 error_report("Format driver '%s' does not support any options to amend",
3439 create_opts
= qemu_opts_append(create_opts
, bs
->drv
->create_opts
);
3440 opts
= qemu_opts_create(create_opts
, NULL
, 0, &error_abort
);
3442 qemu_opts_do_parse(opts
, options
, NULL
, &err
);
3444 error_report_err(err
);
3450 /* In case the driver does not call amend_status_cb() */
3451 qemu_progress_print(0.f
, 0);
3452 ret
= bdrv_amend_options(bs
, opts
, &amend_status_cb
, NULL
);
3453 qemu_progress_print(100.f
, 0);
3455 error_report("Error while amending options: %s", strerror(-ret
));
3460 qemu_progress_end();
3464 qemu_opts_del(opts
);
3465 qemu_opts_free(create_opts
);
3474 typedef struct BenchData
{
3476 uint64_t image_size
;
3483 bool drain_on_flush
;
3492 static void bench_undrained_flush_cb(void *opaque
, int ret
)
3495 error_report("Failed flush request: %s", strerror(-ret
));
3500 static void bench_cb(void *opaque
, int ret
)
3502 BenchData
*b
= opaque
;
3506 error_report("Failed request: %s", strerror(-ret
));
3511 /* Just finished a flush with drained queue: Start next requests */
3512 assert(b
->in_flight
== 0);
3513 b
->in_flush
= false;
3514 } else if (b
->in_flight
> 0) {
3515 int remaining
= b
->n
- b
->in_flight
;
3520 /* Time for flush? Drain queue if requested, then flush */
3521 if (b
->flush_interval
&& remaining
% b
->flush_interval
== 0) {
3522 if (!b
->in_flight
|| !b
->drain_on_flush
) {
3523 BlockCompletionFunc
*cb
;
3525 if (b
->drain_on_flush
) {
3529 cb
= bench_undrained_flush_cb
;
3532 acb
= blk_aio_flush(b
->blk
, cb
, b
);
3534 error_report("Failed to issue flush request");
3538 if (b
->drain_on_flush
) {
3544 while (b
->n
> b
->in_flight
&& b
->in_flight
< b
->nrreq
) {
3546 acb
= blk_aio_pwritev(b
->blk
, b
->offset
, b
->qiov
, 0,
3549 acb
= blk_aio_preadv(b
->blk
, b
->offset
, b
->qiov
, 0,
3553 error_report("Failed to issue request");
3557 b
->offset
+= b
->step
;
3558 b
->offset
%= b
->image_size
;
3562 static int img_bench(int argc
, char **argv
)
3565 const char *fmt
= NULL
, *filename
;
3567 bool image_opts
= false;
3568 bool is_write
= false;
3572 size_t bufsize
= 4096;
3575 int flush_interval
= 0;
3576 bool drain_on_flush
= true;
3578 BlockBackend
*blk
= NULL
;
3579 BenchData data
= {};
3581 bool writethrough
= false;
3582 struct timeval t1
, t2
;
3586 static const struct option long_options
[] = {
3587 {"help", no_argument
, 0, 'h'},
3588 {"flush-interval", required_argument
, 0, OPTION_FLUSH_INTERVAL
},
3589 {"image-opts", no_argument
, 0, OPTION_IMAGE_OPTS
},
3590 {"pattern", required_argument
, 0, OPTION_PATTERN
},
3591 {"no-drain", no_argument
, 0, OPTION_NO_DRAIN
},
3594 c
= getopt_long(argc
, argv
, "hc:d:f:no:qs:S:t:w", long_options
, NULL
);
3608 count
= strtoul(optarg
, &end
, 0);
3609 if (errno
|| *end
|| count
> INT_MAX
) {
3610 error_report("Invalid request count specified");
3619 depth
= strtoul(optarg
, &end
, 0);
3620 if (errno
|| *end
|| depth
> INT_MAX
) {
3621 error_report("Invalid queue depth specified");
3630 flags
|= BDRV_O_NATIVE_AIO
;
3636 offset
= qemu_strtosz_suffix(optarg
, &end
,
3637 QEMU_STRTOSZ_DEFSUFFIX_B
);
3638 if (offset
< 0|| *end
) {
3639 error_report("Invalid offset specified");
3653 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
3654 if (sval
< 0 || sval
> INT_MAX
|| *end
) {
3655 error_report("Invalid buffer size specified");
3667 sval
= qemu_strtosz_suffix(optarg
, &end
, QEMU_STRTOSZ_DEFSUFFIX_B
);
3668 if (sval
< 0 || sval
> INT_MAX
|| *end
) {
3669 error_report("Invalid step size specified");
3677 ret
= bdrv_parse_cache_mode(optarg
, &flags
, &writethrough
);
3679 error_report("Invalid cache mode");
3685 flags
|= BDRV_O_RDWR
;
3688 case OPTION_PATTERN
:
3692 pattern
= strtoul(optarg
, &end
, 0);
3693 if (errno
|| *end
|| pattern
> 0xff) {
3694 error_report("Invalid pattern byte specified");
3699 case OPTION_FLUSH_INTERVAL
:
3703 flush_interval
= strtoul(optarg
, &end
, 0);
3704 if (errno
|| *end
|| flush_interval
> INT_MAX
) {
3705 error_report("Invalid flush interval specified");
3710 case OPTION_NO_DRAIN
:
3711 drain_on_flush
= false;
3713 case OPTION_IMAGE_OPTS
:
3719 if (optind
!= argc
- 1) {
3720 error_exit("Expecting one image file name");
3722 filename
= argv
[argc
- 1];
3724 if (!is_write
&& flush_interval
) {
3725 error_report("--flush-interval is only available in write tests");
3729 if (flush_interval
&& flush_interval
< depth
) {
3730 error_report("Flush interval can't be smaller than depth");
3735 blk
= img_open(image_opts
, filename
, fmt
, flags
, writethrough
, quiet
);
3741 image_size
= blk_getlength(blk
);
3742 if (image_size
< 0) {
3747 data
= (BenchData
) {
3749 .image_size
= image_size
,
3751 .step
= step
?: bufsize
,
3756 .flush_interval
= flush_interval
,
3757 .drain_on_flush
= drain_on_flush
,
3759 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3760 "(starting at offset %" PRId64
", step size %d)\n",
3761 data
.n
, data
.write
? "write" : "read", data
.bufsize
, data
.nrreq
,
3762 data
.offset
, data
.step
);
3763 if (flush_interval
) {
3764 printf("Sending flush every %d requests\n", flush_interval
);
3767 data
.buf
= blk_blockalign(blk
, data
.nrreq
* data
.bufsize
);
3768 memset(data
.buf
, pattern
, data
.nrreq
* data
.bufsize
);
3770 data
.qiov
= g_new(QEMUIOVector
, data
.nrreq
);
3771 for (i
= 0; i
< data
.nrreq
; i
++) {
3772 qemu_iovec_init(&data
.qiov
[i
], 1);
3773 qemu_iovec_add(&data
.qiov
[i
],
3774 data
.buf
+ i
* data
.bufsize
, data
.bufsize
);
3777 gettimeofday(&t1
, NULL
);
3780 while (data
.n
> 0) {
3781 main_loop_wait(false);
3783 gettimeofday(&t2
, NULL
);
3785 printf("Run completed in %3.3f seconds.\n",
3786 (t2
.tv_sec
- t1
.tv_sec
)
3787 + ((double)(t2
.tv_usec
- t1
.tv_usec
) / 1000000));
3790 qemu_vfree(data
.buf
);
3800 static const img_cmd_t img_cmds
[] = {
3801 #define DEF(option, callback, arg_string) \
3802 { option, callback },
3803 #include "qemu-img-cmds.h"
3809 int main(int argc
, char **argv
)
3811 const img_cmd_t
*cmd
;
3812 const char *cmdname
;
3813 Error
*local_error
= NULL
;
3814 char *trace_file
= NULL
;
3816 static const struct option long_options
[] = {
3817 {"help", no_argument
, 0, 'h'},
3818 {"version", no_argument
, 0, 'V'},
3819 {"trace", required_argument
, NULL
, 'T'},
3824 signal(SIGPIPE
, SIG_IGN
);
3827 error_set_progname(argv
[0]);
3828 qemu_init_exec_dir(argv
[0]);
3830 if (qemu_init_main_loop(&local_error
)) {
3831 error_report_err(local_error
);
3835 qcrypto_init(&error_fatal
);
3837 module_call_init(MODULE_INIT_QOM
);
3840 error_exit("Not enough arguments");
3843 qemu_add_opts(&qemu_object_opts
);
3844 qemu_add_opts(&qemu_source_opts
);
3845 qemu_add_opts(&qemu_trace_opts
);
3847 while ((c
= getopt_long(argc
, argv
, "+hVT:", long_options
, NULL
)) != -1) {
3853 printf(QEMU_IMG_VERSION
);
3857 trace_file
= trace_opt_parse(optarg
);
3862 cmdname
= argv
[optind
];
3864 /* reset getopt_long scanning */
3872 if (!trace_init_backends()) {
3875 trace_init_file(trace_file
);
3876 qemu_set_log(LOG_TRACE
);
3878 /* find the command */
3879 for (cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
3880 if (!strcmp(cmdname
, cmd
->name
)) {
3881 return cmd
->handler(argc
, argv
);
3886 error_exit("Command not found: %s", cmdname
);