virtio-pci: fix 1.0 virtqueue migration
[qemu/ar7.git] / qemu-img.c
blob9831db75ef1b5ea3d8a7f554c60cb2c879f898f4
1 /*
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
22 * THE SOFTWARE.
24 #include "qapi-visit.h"
25 #include "qapi/qmp-output-visitor.h"
26 #include "qapi/qmp/qerror.h"
27 #include "qapi/qmp/qjson.h"
28 #include "qemu-common.h"
29 #include "qemu/option.h"
30 #include "qemu/error-report.h"
31 #include "qemu/osdep.h"
32 #include "sysemu/sysemu.h"
33 #include "sysemu/block-backend.h"
34 #include "block/block_int.h"
35 #include "block/blockjob.h"
36 #include "block/qapi.h"
37 #include <getopt.h>
39 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
40 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
42 typedef struct img_cmd_t {
43 const char *name;
44 int (*handler)(int argc, char **argv);
45 } img_cmd_t;
47 enum {
48 OPTION_OUTPUT = 256,
49 OPTION_BACKING_CHAIN = 257,
52 typedef enum OutputFormat {
53 OFORMAT_JSON,
54 OFORMAT_HUMAN,
55 } OutputFormat;
57 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
58 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
59 #define BDRV_DEFAULT_CACHE "writeback"
61 static void format_print(void *opaque, const char *name)
63 printf(" %s", name);
66 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
68 va_list ap;
70 error_printf("qemu-img: ");
72 va_start(ap, fmt);
73 error_vprintf(fmt, ap);
74 va_end(ap);
76 error_printf("\nTry 'qemu-img --help' for more information\n");
77 exit(EXIT_FAILURE);
80 /* Please keep in synch with qemu-img.texi */
81 static void QEMU_NORETURN help(void)
83 const char *help_msg =
84 QEMU_IMG_VERSION
85 "usage: qemu-img command [command options]\n"
86 "QEMU disk image utility\n"
87 "\n"
88 "Command syntax:\n"
89 #define DEF(option, callback, arg_string) \
90 " " arg_string "\n"
91 #include "qemu-img-cmds.h"
92 #undef DEF
93 #undef GEN_DOCS
94 "\n"
95 "Command parameters:\n"
96 " 'filename' is a disk image filename\n"
97 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
98 " 'cache' is the cache mode used to write the output disk image, the valid\n"
99 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
100 " 'directsync' and 'unsafe' (default for convert)\n"
101 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
102 " options are the same as for the 'cache' option\n"
103 " 'size' is the disk image size in bytes. Optional suffixes\n"
104 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
105 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
106 " supported. 'b' is ignored.\n"
107 " 'output_filename' is the destination disk image filename\n"
108 " 'output_fmt' is the destination format\n"
109 " 'options' is a comma separated list of format specific options in a\n"
110 " name=value format. Use -o ? for an overview of the options supported by the\n"
111 " used format\n"
112 " 'snapshot_param' is param used for internal snapshot, format\n"
113 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
114 " '[ID_OR_NAME]'\n"
115 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
116 " instead\n"
117 " '-c' indicates that target image must be compressed (qcow format only)\n"
118 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
119 " match exactly. The image doesn't need a working backing file before\n"
120 " rebasing in this case (useful for renaming the backing file)\n"
121 " '-h' with or without a command shows this help and lists the supported formats\n"
122 " '-p' show progress of command (only certain commands)\n"
123 " '-q' use Quiet mode - do not print any output (except errors)\n"
124 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
125 " contain only zeros for qemu-img to create a sparse image during\n"
126 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
127 " unallocated or zero sectors, and the destination image will always be\n"
128 " fully allocated\n"
129 " '--output' takes the format in which the output must be done (human or json)\n"
130 " '-n' skips the target volume creation (useful if the volume is created\n"
131 " prior to running qemu-img)\n"
132 "\n"
133 "Parameters to check subcommand:\n"
134 " '-r' tries to repair any inconsistencies that are found during the check.\n"
135 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
136 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
137 " hiding corruption that has already occurred.\n"
138 "\n"
139 "Parameters to snapshot subcommand:\n"
140 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
141 " '-a' applies a snapshot (revert disk to saved state)\n"
142 " '-c' creates a snapshot\n"
143 " '-d' deletes a snapshot\n"
144 " '-l' lists all snapshots in the given image\n"
145 "\n"
146 "Parameters to compare subcommand:\n"
147 " '-f' first image format\n"
148 " '-F' second image format\n"
149 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
151 printf("%s\nSupported formats:", help_msg);
152 bdrv_iterate_format(format_print, NULL);
153 printf("\n");
154 exit(EXIT_SUCCESS);
157 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
159 int ret = 0;
160 if (!quiet) {
161 va_list args;
162 va_start(args, fmt);
163 ret = vprintf(fmt, args);
164 va_end(args);
166 return ret;
170 static int print_block_option_help(const char *filename, const char *fmt)
172 BlockDriver *drv, *proto_drv;
173 QemuOptsList *create_opts = NULL;
174 Error *local_err = NULL;
176 /* Find driver and parse its options */
177 drv = bdrv_find_format(fmt);
178 if (!drv) {
179 error_report("Unknown file format '%s'", fmt);
180 return 1;
183 create_opts = qemu_opts_append(create_opts, drv->create_opts);
184 if (filename) {
185 proto_drv = bdrv_find_protocol(filename, true, &local_err);
186 if (!proto_drv) {
187 error_report_err(local_err);
188 qemu_opts_free(create_opts);
189 return 1;
191 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
194 qemu_opts_print_help(create_opts);
195 qemu_opts_free(create_opts);
196 return 0;
199 static BlockBackend *img_open(const char *id, const char *filename,
200 const char *fmt, int flags,
201 bool require_io, bool quiet)
203 BlockBackend *blk;
204 BlockDriverState *bs;
205 char password[256];
206 Error *local_err = NULL;
207 QDict *options = NULL;
209 if (fmt) {
210 options = qdict_new();
211 qdict_put(options, "driver", qstring_from_str(fmt));
214 blk = blk_new_open(id, filename, NULL, options, flags, &local_err);
215 if (!blk) {
216 error_report("Could not open '%s': %s", filename,
217 error_get_pretty(local_err));
218 error_free(local_err);
219 goto fail;
222 bs = blk_bs(blk);
223 if (bdrv_is_encrypted(bs) && require_io) {
224 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
225 if (qemu_read_password(password, sizeof(password)) < 0) {
226 error_report("No password given");
227 goto fail;
229 if (bdrv_set_key(bs, password) < 0) {
230 error_report("invalid password");
231 goto fail;
234 return blk;
235 fail:
236 blk_unref(blk);
237 return NULL;
240 static int add_old_style_options(const char *fmt, QemuOpts *opts,
241 const char *base_filename,
242 const char *base_fmt)
244 Error *err = NULL;
246 if (base_filename) {
247 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
248 if (err) {
249 error_report("Backing file not supported for file format '%s'",
250 fmt);
251 error_free(err);
252 return -1;
255 if (base_fmt) {
256 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
257 if (err) {
258 error_report("Backing file format not supported for file "
259 "format '%s'", fmt);
260 error_free(err);
261 return -1;
264 return 0;
267 static int img_create(int argc, char **argv)
269 int c;
270 uint64_t img_size = -1;
271 const char *fmt = "raw";
272 const char *base_fmt = NULL;
273 const char *filename;
274 const char *base_filename = NULL;
275 char *options = NULL;
276 Error *local_err = NULL;
277 bool quiet = false;
279 for(;;) {
280 c = getopt(argc, argv, "F:b:f:he6o:q");
281 if (c == -1) {
282 break;
284 switch(c) {
285 case '?':
286 case 'h':
287 help();
288 break;
289 case 'F':
290 base_fmt = optarg;
291 break;
292 case 'b':
293 base_filename = optarg;
294 break;
295 case 'f':
296 fmt = optarg;
297 break;
298 case 'e':
299 error_report("option -e is deprecated, please use \'-o "
300 "encryption\' instead!");
301 goto fail;
302 case '6':
303 error_report("option -6 is deprecated, please use \'-o "
304 "compat6\' instead!");
305 goto fail;
306 case 'o':
307 if (!is_valid_option_list(optarg)) {
308 error_report("Invalid option list: %s", optarg);
309 goto fail;
311 if (!options) {
312 options = g_strdup(optarg);
313 } else {
314 char *old_options = options;
315 options = g_strdup_printf("%s,%s", options, optarg);
316 g_free(old_options);
318 break;
319 case 'q':
320 quiet = true;
321 break;
325 /* Get the filename */
326 filename = (optind < argc) ? argv[optind] : NULL;
327 if (options && has_help_option(options)) {
328 g_free(options);
329 return print_block_option_help(filename, fmt);
332 if (optind >= argc) {
333 error_exit("Expecting image file name");
335 optind++;
337 /* Get image size, if specified */
338 if (optind < argc) {
339 int64_t sval;
340 char *end;
341 sval = qemu_strtosz_suffix(argv[optind++], &end,
342 QEMU_STRTOSZ_DEFSUFFIX_B);
343 if (sval < 0 || *end) {
344 if (sval == -ERANGE) {
345 error_report("Image size must be less than 8 EiB!");
346 } else {
347 error_report("Invalid image size specified! You may use k, M, "
348 "G, T, P or E suffixes for ");
349 error_report("kilobytes, megabytes, gigabytes, terabytes, "
350 "petabytes and exabytes.");
352 goto fail;
354 img_size = (uint64_t)sval;
356 if (optind != argc) {
357 error_exit("Unexpected argument: %s", argv[optind]);
360 bdrv_img_create(filename, fmt, base_filename, base_fmt,
361 options, img_size, BDRV_O_FLAGS, &local_err, quiet);
362 if (local_err) {
363 error_report("%s: %s", filename, error_get_pretty(local_err));
364 error_free(local_err);
365 goto fail;
368 g_free(options);
369 return 0;
371 fail:
372 g_free(options);
373 return 1;
376 static void dump_json_image_check(ImageCheck *check, bool quiet)
378 Error *local_err = NULL;
379 QString *str;
380 QmpOutputVisitor *ov = qmp_output_visitor_new();
381 QObject *obj;
382 visit_type_ImageCheck(qmp_output_get_visitor(ov),
383 &check, NULL, &local_err);
384 obj = qmp_output_get_qobject(ov);
385 str = qobject_to_json_pretty(obj);
386 assert(str != NULL);
387 qprintf(quiet, "%s\n", qstring_get_str(str));
388 qobject_decref(obj);
389 qmp_output_visitor_cleanup(ov);
390 QDECREF(str);
393 static void dump_human_image_check(ImageCheck *check, bool quiet)
395 if (!(check->corruptions || check->leaks || check->check_errors)) {
396 qprintf(quiet, "No errors were found on the image.\n");
397 } else {
398 if (check->corruptions) {
399 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
400 "Data may be corrupted, or further writes to the image "
401 "may corrupt it.\n",
402 check->corruptions);
405 if (check->leaks) {
406 qprintf(quiet,
407 "\n%" PRId64 " leaked clusters were found on the image.\n"
408 "This means waste of disk space, but no harm to data.\n",
409 check->leaks);
412 if (check->check_errors) {
413 qprintf(quiet,
414 "\n%" PRId64
415 " internal errors have occurred during the check.\n",
416 check->check_errors);
420 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
421 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
422 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
423 check->allocated_clusters, check->total_clusters,
424 check->allocated_clusters * 100.0 / check->total_clusters,
425 check->fragmented_clusters * 100.0 / check->allocated_clusters,
426 check->compressed_clusters * 100.0 /
427 check->allocated_clusters);
430 if (check->image_end_offset) {
431 qprintf(quiet,
432 "Image end offset: %" PRId64 "\n", check->image_end_offset);
436 static int collect_image_check(BlockDriverState *bs,
437 ImageCheck *check,
438 const char *filename,
439 const char *fmt,
440 int fix)
442 int ret;
443 BdrvCheckResult result;
445 ret = bdrv_check(bs, &result, fix);
446 if (ret < 0) {
447 return ret;
450 check->filename = g_strdup(filename);
451 check->format = g_strdup(bdrv_get_format_name(bs));
452 check->check_errors = result.check_errors;
453 check->corruptions = result.corruptions;
454 check->has_corruptions = result.corruptions != 0;
455 check->leaks = result.leaks;
456 check->has_leaks = result.leaks != 0;
457 check->corruptions_fixed = result.corruptions_fixed;
458 check->has_corruptions_fixed = result.corruptions != 0;
459 check->leaks_fixed = result.leaks_fixed;
460 check->has_leaks_fixed = result.leaks != 0;
461 check->image_end_offset = result.image_end_offset;
462 check->has_image_end_offset = result.image_end_offset != 0;
463 check->total_clusters = result.bfi.total_clusters;
464 check->has_total_clusters = result.bfi.total_clusters != 0;
465 check->allocated_clusters = result.bfi.allocated_clusters;
466 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
467 check->fragmented_clusters = result.bfi.fragmented_clusters;
468 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
469 check->compressed_clusters = result.bfi.compressed_clusters;
470 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
472 return 0;
476 * Checks an image for consistency. Exit codes:
478 * 0 - Check completed, image is good
479 * 1 - Check not completed because of internal errors
480 * 2 - Check completed, image is corrupted
481 * 3 - Check completed, image has leaked clusters, but is good otherwise
482 * 63 - Checks are not supported by the image format
484 static int img_check(int argc, char **argv)
486 int c, ret;
487 OutputFormat output_format = OFORMAT_HUMAN;
488 const char *filename, *fmt, *output, *cache;
489 BlockBackend *blk;
490 BlockDriverState *bs;
491 int fix = 0;
492 int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
493 ImageCheck *check;
494 bool quiet = false;
496 fmt = NULL;
497 output = NULL;
498 cache = BDRV_DEFAULT_CACHE;
499 for(;;) {
500 int option_index = 0;
501 static const struct option long_options[] = {
502 {"help", no_argument, 0, 'h'},
503 {"format", required_argument, 0, 'f'},
504 {"repair", required_argument, 0, 'r'},
505 {"output", required_argument, 0, OPTION_OUTPUT},
506 {0, 0, 0, 0}
508 c = getopt_long(argc, argv, "hf:r:T:q",
509 long_options, &option_index);
510 if (c == -1) {
511 break;
513 switch(c) {
514 case '?':
515 case 'h':
516 help();
517 break;
518 case 'f':
519 fmt = optarg;
520 break;
521 case 'r':
522 flags |= BDRV_O_RDWR;
524 if (!strcmp(optarg, "leaks")) {
525 fix = BDRV_FIX_LEAKS;
526 } else if (!strcmp(optarg, "all")) {
527 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
528 } else {
529 error_exit("Unknown option value for -r "
530 "(expecting 'leaks' or 'all'): %s", optarg);
532 break;
533 case OPTION_OUTPUT:
534 output = optarg;
535 break;
536 case 'T':
537 cache = optarg;
538 break;
539 case 'q':
540 quiet = true;
541 break;
544 if (optind != argc - 1) {
545 error_exit("Expecting one image file name");
547 filename = argv[optind++];
549 if (output && !strcmp(output, "json")) {
550 output_format = OFORMAT_JSON;
551 } else if (output && !strcmp(output, "human")) {
552 output_format = OFORMAT_HUMAN;
553 } else if (output) {
554 error_report("--output must be used with human or json as argument.");
555 return 1;
558 ret = bdrv_parse_cache_flags(cache, &flags);
559 if (ret < 0) {
560 error_report("Invalid source cache option: %s", cache);
561 return 1;
564 blk = img_open("image", filename, fmt, flags, true, quiet);
565 if (!blk) {
566 return 1;
568 bs = blk_bs(blk);
570 check = g_new0(ImageCheck, 1);
571 ret = collect_image_check(bs, check, filename, fmt, fix);
573 if (ret == -ENOTSUP) {
574 error_report("This image format does not support checks");
575 ret = 63;
576 goto fail;
579 if (check->corruptions_fixed || check->leaks_fixed) {
580 int corruptions_fixed, leaks_fixed;
582 leaks_fixed = check->leaks_fixed;
583 corruptions_fixed = check->corruptions_fixed;
585 if (output_format == OFORMAT_HUMAN) {
586 qprintf(quiet,
587 "The following inconsistencies were found and repaired:\n\n"
588 " %" PRId64 " leaked clusters\n"
589 " %" PRId64 " corruptions\n\n"
590 "Double checking the fixed image now...\n",
591 check->leaks_fixed,
592 check->corruptions_fixed);
595 ret = collect_image_check(bs, check, filename, fmt, 0);
597 check->leaks_fixed = leaks_fixed;
598 check->corruptions_fixed = corruptions_fixed;
601 if (!ret) {
602 switch (output_format) {
603 case OFORMAT_HUMAN:
604 dump_human_image_check(check, quiet);
605 break;
606 case OFORMAT_JSON:
607 dump_json_image_check(check, quiet);
608 break;
612 if (ret || check->check_errors) {
613 if (ret) {
614 error_report("Check failed: %s", strerror(-ret));
615 } else {
616 error_report("Check failed");
618 ret = 1;
619 goto fail;
622 if (check->corruptions) {
623 ret = 2;
624 } else if (check->leaks) {
625 ret = 3;
626 } else {
627 ret = 0;
630 fail:
631 qapi_free_ImageCheck(check);
632 blk_unref(blk);
633 return ret;
636 typedef struct CommonBlockJobCBInfo {
637 BlockDriverState *bs;
638 Error **errp;
639 } CommonBlockJobCBInfo;
641 static void common_block_job_cb(void *opaque, int ret)
643 CommonBlockJobCBInfo *cbi = opaque;
645 if (ret < 0) {
646 error_setg_errno(cbi->errp, -ret, "Block job failed");
649 /* Drop this block job's reference */
650 bdrv_unref(cbi->bs);
653 static void run_block_job(BlockJob *job, Error **errp)
655 AioContext *aio_context = bdrv_get_aio_context(job->bs);
657 do {
658 aio_poll(aio_context, true);
659 qemu_progress_print(job->len ?
660 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
661 } while (!job->ready);
663 block_job_complete_sync(job, errp);
665 /* A block job may finish instantaneously without publishing any progress,
666 * so just signal completion here */
667 qemu_progress_print(100.f, 0);
670 static int img_commit(int argc, char **argv)
672 int c, ret, flags;
673 const char *filename, *fmt, *cache, *base;
674 BlockBackend *blk;
675 BlockDriverState *bs, *base_bs;
676 bool progress = false, quiet = false, drop = false;
677 Error *local_err = NULL;
678 CommonBlockJobCBInfo cbi;
680 fmt = NULL;
681 cache = BDRV_DEFAULT_CACHE;
682 base = NULL;
683 for(;;) {
684 c = getopt(argc, argv, "f:ht:b:dpq");
685 if (c == -1) {
686 break;
688 switch(c) {
689 case '?':
690 case 'h':
691 help();
692 break;
693 case 'f':
694 fmt = optarg;
695 break;
696 case 't':
697 cache = optarg;
698 break;
699 case 'b':
700 base = optarg;
701 /* -b implies -d */
702 drop = true;
703 break;
704 case 'd':
705 drop = true;
706 break;
707 case 'p':
708 progress = true;
709 break;
710 case 'q':
711 quiet = true;
712 break;
716 /* Progress is not shown in Quiet mode */
717 if (quiet) {
718 progress = false;
721 if (optind != argc - 1) {
722 error_exit("Expecting one image file name");
724 filename = argv[optind++];
726 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
727 ret = bdrv_parse_cache_flags(cache, &flags);
728 if (ret < 0) {
729 error_report("Invalid cache option: %s", cache);
730 return 1;
733 blk = img_open("image", filename, fmt, flags, true, quiet);
734 if (!blk) {
735 return 1;
737 bs = blk_bs(blk);
739 qemu_progress_init(progress, 1.f);
740 qemu_progress_print(0.f, 100);
742 if (base) {
743 base_bs = bdrv_find_backing_image(bs, base);
744 if (!base_bs) {
745 error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
746 goto done;
748 } else {
749 /* This is different from QMP, which by default uses the deepest file in
750 * the backing chain (i.e., the very base); however, the traditional
751 * behavior of qemu-img commit is using the immediate backing file. */
752 base_bs = backing_bs(bs);
753 if (!base_bs) {
754 error_setg(&local_err, "Image does not have a backing file");
755 goto done;
759 cbi = (CommonBlockJobCBInfo){
760 .errp = &local_err,
761 .bs = bs,
764 commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
765 common_block_job_cb, &cbi, &local_err);
766 if (local_err) {
767 goto done;
770 /* When the block job completes, the BlockBackend reference will point to
771 * the old backing file. In order to avoid that the top image is already
772 * deleted, so we can still empty it afterwards, increment the reference
773 * counter here preemptively. */
774 if (!drop) {
775 bdrv_ref(bs);
778 run_block_job(bs->job, &local_err);
779 if (local_err) {
780 goto unref_backing;
783 if (!drop && bs->drv->bdrv_make_empty) {
784 ret = bs->drv->bdrv_make_empty(bs);
785 if (ret) {
786 error_setg_errno(&local_err, -ret, "Could not empty %s",
787 filename);
788 goto unref_backing;
792 unref_backing:
793 if (!drop) {
794 bdrv_unref(bs);
797 done:
798 qemu_progress_end();
800 blk_unref(blk);
802 if (local_err) {
803 error_report_err(local_err);
804 return 1;
807 qprintf(quiet, "Image committed.\n");
808 return 0;
812 * Returns true iff the first sector pointed to by 'buf' contains at least
813 * a non-NUL byte.
815 * 'pnum' is set to the number of sectors (including and immediately following
816 * the first one) that are known to be in the same allocated/unallocated state.
818 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
820 bool is_zero;
821 int i;
823 if (n <= 0) {
824 *pnum = 0;
825 return 0;
827 is_zero = buffer_is_zero(buf, 512);
828 for(i = 1; i < n; i++) {
829 buf += 512;
830 if (is_zero != buffer_is_zero(buf, 512)) {
831 break;
834 *pnum = i;
835 return !is_zero;
839 * Like is_allocated_sectors, but if the buffer starts with a used sector,
840 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
841 * breaking up write requests for only small sparse areas.
843 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
844 int min)
846 int ret;
847 int num_checked, num_used;
849 if (n < min) {
850 min = n;
853 ret = is_allocated_sectors(buf, n, pnum);
854 if (!ret) {
855 return ret;
858 num_used = *pnum;
859 buf += BDRV_SECTOR_SIZE * *pnum;
860 n -= *pnum;
861 num_checked = num_used;
863 while (n > 0) {
864 ret = is_allocated_sectors(buf, n, pnum);
866 buf += BDRV_SECTOR_SIZE * *pnum;
867 n -= *pnum;
868 num_checked += *pnum;
869 if (ret) {
870 num_used = num_checked;
871 } else if (*pnum >= min) {
872 break;
876 *pnum = num_used;
877 return 1;
881 * Compares two buffers sector by sector. Returns 0 if the first sector of both
882 * buffers matches, non-zero otherwise.
884 * pnum is set to the number of sectors (including and immediately following
885 * the first one) that are known to have the same comparison result
887 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
888 int *pnum)
890 bool res;
891 int i;
893 if (n <= 0) {
894 *pnum = 0;
895 return 0;
898 res = !!memcmp(buf1, buf2, 512);
899 for(i = 1; i < n; i++) {
900 buf1 += 512;
901 buf2 += 512;
903 if (!!memcmp(buf1, buf2, 512) != res) {
904 break;
908 *pnum = i;
909 return res;
912 #define IO_BUF_SIZE (2 * 1024 * 1024)
914 static int64_t sectors_to_bytes(int64_t sectors)
916 return sectors << BDRV_SECTOR_BITS;
919 static int64_t sectors_to_process(int64_t total, int64_t from)
921 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
925 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
927 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
928 * data and negative value on error.
930 * @param blk: BlockBackend for the image
931 * @param sect_num: Number of first sector to check
932 * @param sect_count: Number of sectors to check
933 * @param filename: Name of disk file we are checking (logging purpose)
934 * @param buffer: Allocated buffer for storing read data
935 * @param quiet: Flag for quiet mode
937 static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
938 int sect_count, const char *filename,
939 uint8_t *buffer, bool quiet)
941 int pnum, ret = 0;
942 ret = blk_read(blk, sect_num, buffer, sect_count);
943 if (ret < 0) {
944 error_report("Error while reading offset %" PRId64 " of %s: %s",
945 sectors_to_bytes(sect_num), filename, strerror(-ret));
946 return ret;
948 ret = is_allocated_sectors(buffer, sect_count, &pnum);
949 if (ret || pnum != sect_count) {
950 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
951 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
952 return 1;
955 return 0;
959 * Compares two images. Exit codes:
961 * 0 - Images are identical
962 * 1 - Images differ
963 * >1 - Error occurred
965 static int img_compare(int argc, char **argv)
967 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
968 BlockBackend *blk1, *blk2;
969 BlockDriverState *bs1, *bs2;
970 int64_t total_sectors1, total_sectors2;
971 uint8_t *buf1 = NULL, *buf2 = NULL;
972 int pnum1, pnum2;
973 int allocated1, allocated2;
974 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
975 bool progress = false, quiet = false, strict = false;
976 int flags;
977 int64_t total_sectors;
978 int64_t sector_num = 0;
979 int64_t nb_sectors;
980 int c, pnum;
981 uint64_t progress_base;
983 cache = BDRV_DEFAULT_CACHE;
984 for (;;) {
985 c = getopt(argc, argv, "hf:F:T:pqs");
986 if (c == -1) {
987 break;
989 switch (c) {
990 case '?':
991 case 'h':
992 help();
993 break;
994 case 'f':
995 fmt1 = optarg;
996 break;
997 case 'F':
998 fmt2 = optarg;
999 break;
1000 case 'T':
1001 cache = optarg;
1002 break;
1003 case 'p':
1004 progress = true;
1005 break;
1006 case 'q':
1007 quiet = true;
1008 break;
1009 case 's':
1010 strict = true;
1011 break;
1015 /* Progress is not shown in Quiet mode */
1016 if (quiet) {
1017 progress = false;
1021 if (optind != argc - 2) {
1022 error_exit("Expecting two image file names");
1024 filename1 = argv[optind++];
1025 filename2 = argv[optind++];
1027 /* Initialize before goto out */
1028 qemu_progress_init(progress, 2.0);
1030 flags = BDRV_O_FLAGS;
1031 ret = bdrv_parse_cache_flags(cache, &flags);
1032 if (ret < 0) {
1033 error_report("Invalid source cache option: %s", cache);
1034 ret = 2;
1035 goto out3;
1038 blk1 = img_open("image_1", filename1, fmt1, flags, true, quiet);
1039 if (!blk1) {
1040 ret = 2;
1041 goto out3;
1043 bs1 = blk_bs(blk1);
1045 blk2 = img_open("image_2", filename2, fmt2, flags, true, quiet);
1046 if (!blk2) {
1047 ret = 2;
1048 goto out2;
1050 bs2 = blk_bs(blk2);
1052 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1053 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1054 total_sectors1 = blk_nb_sectors(blk1);
1055 if (total_sectors1 < 0) {
1056 error_report("Can't get size of %s: %s",
1057 filename1, strerror(-total_sectors1));
1058 ret = 4;
1059 goto out;
1061 total_sectors2 = blk_nb_sectors(blk2);
1062 if (total_sectors2 < 0) {
1063 error_report("Can't get size of %s: %s",
1064 filename2, strerror(-total_sectors2));
1065 ret = 4;
1066 goto out;
1068 total_sectors = MIN(total_sectors1, total_sectors2);
1069 progress_base = MAX(total_sectors1, total_sectors2);
1071 qemu_progress_print(0, 100);
1073 if (strict && total_sectors1 != total_sectors2) {
1074 ret = 1;
1075 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1076 goto out;
1079 for (;;) {
1080 nb_sectors = sectors_to_process(total_sectors, sector_num);
1081 if (nb_sectors <= 0) {
1082 break;
1084 allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1085 &pnum1);
1086 if (allocated1 < 0) {
1087 ret = 3;
1088 error_report("Sector allocation test failed for %s", filename1);
1089 goto out;
1092 allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1093 &pnum2);
1094 if (allocated2 < 0) {
1095 ret = 3;
1096 error_report("Sector allocation test failed for %s", filename2);
1097 goto out;
1099 nb_sectors = MIN(pnum1, pnum2);
1101 if (allocated1 == allocated2) {
1102 if (allocated1) {
1103 ret = blk_read(blk1, sector_num, buf1, nb_sectors);
1104 if (ret < 0) {
1105 error_report("Error while reading offset %" PRId64 " of %s:"
1106 " %s", sectors_to_bytes(sector_num), filename1,
1107 strerror(-ret));
1108 ret = 4;
1109 goto out;
1111 ret = blk_read(blk2, sector_num, buf2, nb_sectors);
1112 if (ret < 0) {
1113 error_report("Error while reading offset %" PRId64
1114 " of %s: %s", sectors_to_bytes(sector_num),
1115 filename2, strerror(-ret));
1116 ret = 4;
1117 goto out;
1119 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1120 if (ret || pnum != nb_sectors) {
1121 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1122 sectors_to_bytes(
1123 ret ? sector_num : sector_num + pnum));
1124 ret = 1;
1125 goto out;
1128 } else {
1129 if (strict) {
1130 ret = 1;
1131 qprintf(quiet, "Strict mode: Offset %" PRId64
1132 " allocation mismatch!\n",
1133 sectors_to_bytes(sector_num));
1134 goto out;
1137 if (allocated1) {
1138 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1139 filename1, buf1, quiet);
1140 } else {
1141 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1142 filename2, buf1, quiet);
1144 if (ret) {
1145 if (ret < 0) {
1146 error_report("Error while reading offset %" PRId64 ": %s",
1147 sectors_to_bytes(sector_num), strerror(-ret));
1148 ret = 4;
1150 goto out;
1153 sector_num += nb_sectors;
1154 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1157 if (total_sectors1 != total_sectors2) {
1158 BlockBackend *blk_over;
1159 int64_t total_sectors_over;
1160 const char *filename_over;
1162 qprintf(quiet, "Warning: Image size mismatch!\n");
1163 if (total_sectors1 > total_sectors2) {
1164 total_sectors_over = total_sectors1;
1165 blk_over = blk1;
1166 filename_over = filename1;
1167 } else {
1168 total_sectors_over = total_sectors2;
1169 blk_over = blk2;
1170 filename_over = filename2;
1173 for (;;) {
1174 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1175 if (nb_sectors <= 0) {
1176 break;
1178 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1179 nb_sectors, &pnum);
1180 if (ret < 0) {
1181 ret = 3;
1182 error_report("Sector allocation test failed for %s",
1183 filename_over);
1184 goto out;
1187 nb_sectors = pnum;
1188 if (ret) {
1189 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1190 filename_over, buf1, quiet);
1191 if (ret) {
1192 if (ret < 0) {
1193 error_report("Error while reading offset %" PRId64
1194 " of %s: %s", sectors_to_bytes(sector_num),
1195 filename_over, strerror(-ret));
1196 ret = 4;
1198 goto out;
1201 sector_num += nb_sectors;
1202 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1206 qprintf(quiet, "Images are identical.\n");
1207 ret = 0;
1209 out:
1210 qemu_vfree(buf1);
1211 qemu_vfree(buf2);
1212 blk_unref(blk2);
1213 out2:
1214 blk_unref(blk1);
1215 out3:
1216 qemu_progress_end();
1217 return ret;
1220 enum ImgConvertBlockStatus {
1221 BLK_DATA,
1222 BLK_ZERO,
1223 BLK_BACKING_FILE,
1226 typedef struct ImgConvertState {
1227 BlockBackend **src;
1228 int64_t *src_sectors;
1229 int src_cur, src_num;
1230 int64_t src_cur_offset;
1231 int64_t total_sectors;
1232 int64_t allocated_sectors;
1233 enum ImgConvertBlockStatus status;
1234 int64_t sector_next_status;
1235 BlockBackend *target;
1236 bool has_zero_init;
1237 bool compressed;
1238 bool target_has_backing;
1239 int min_sparse;
1240 size_t cluster_sectors;
1241 size_t buf_sectors;
1242 } ImgConvertState;
1244 static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1246 assert(sector_num >= s->src_cur_offset);
1247 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1248 s->src_cur_offset += s->src_sectors[s->src_cur];
1249 s->src_cur++;
1250 assert(s->src_cur < s->src_num);
1254 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1256 int64_t ret;
1257 int n;
1259 convert_select_part(s, sector_num);
1261 assert(s->total_sectors > sector_num);
1262 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1264 if (s->sector_next_status <= sector_num) {
1265 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1266 sector_num - s->src_cur_offset,
1267 n, &n);
1268 if (ret < 0) {
1269 return ret;
1272 if (ret & BDRV_BLOCK_ZERO) {
1273 s->status = BLK_ZERO;
1274 } else if (ret & BDRV_BLOCK_DATA) {
1275 s->status = BLK_DATA;
1276 } else if (!s->target_has_backing) {
1277 /* Without a target backing file we must copy over the contents of
1278 * the backing file as well. */
1279 /* TODO Check block status of the backing file chain to avoid
1280 * needlessly reading zeroes and limiting the iteration to the
1281 * buffer size */
1282 s->status = BLK_DATA;
1283 } else {
1284 s->status = BLK_BACKING_FILE;
1287 s->sector_next_status = sector_num + n;
1290 n = MIN(n, s->sector_next_status - sector_num);
1291 if (s->status == BLK_DATA) {
1292 n = MIN(n, s->buf_sectors);
1295 /* We need to write complete clusters for compressed images, so if an
1296 * unallocated area is shorter than that, we must consider the whole
1297 * cluster allocated. */
1298 if (s->compressed) {
1299 if (n < s->cluster_sectors) {
1300 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1301 s->status = BLK_DATA;
1302 } else {
1303 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1307 return n;
1310 static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1311 uint8_t *buf)
1313 int n;
1314 int ret;
1316 if (s->status == BLK_ZERO || s->status == BLK_BACKING_FILE) {
1317 return 0;
1320 assert(nb_sectors <= s->buf_sectors);
1321 while (nb_sectors > 0) {
1322 BlockBackend *blk;
1323 int64_t bs_sectors;
1325 /* In the case of compression with multiple source files, we can get a
1326 * nb_sectors that spreads into the next part. So we must be able to
1327 * read across multiple BDSes for one convert_read() call. */
1328 convert_select_part(s, sector_num);
1329 blk = s->src[s->src_cur];
1330 bs_sectors = s->src_sectors[s->src_cur];
1332 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1333 ret = blk_read(blk, sector_num - s->src_cur_offset, buf, n);
1334 if (ret < 0) {
1335 return ret;
1338 sector_num += n;
1339 nb_sectors -= n;
1340 buf += n * BDRV_SECTOR_SIZE;
1343 return 0;
1346 static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1347 const uint8_t *buf)
1349 int ret;
1351 while (nb_sectors > 0) {
1352 int n = nb_sectors;
1354 switch (s->status) {
1355 case BLK_BACKING_FILE:
1356 /* If we have a backing file, leave clusters unallocated that are
1357 * unallocated in the source image, so that the backing file is
1358 * visible at the respective offset. */
1359 assert(s->target_has_backing);
1360 break;
1362 case BLK_DATA:
1363 /* We must always write compressed clusters as a whole, so don't
1364 * try to find zeroed parts in the buffer. We can only save the
1365 * write if the buffer is completely zeroed and we're allowed to
1366 * keep the target sparse. */
1367 if (s->compressed) {
1368 if (s->has_zero_init && s->min_sparse &&
1369 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1371 assert(!s->target_has_backing);
1372 break;
1375 ret = blk_write_compressed(s->target, sector_num, buf, n);
1376 if (ret < 0) {
1377 return ret;
1379 break;
1382 /* If there is real non-zero data or we're told to keep the target
1383 * fully allocated (-S 0), we must write it. Otherwise we can treat
1384 * it as zero sectors. */
1385 if (!s->min_sparse ||
1386 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1388 ret = blk_write(s->target, sector_num, buf, n);
1389 if (ret < 0) {
1390 return ret;
1392 break;
1394 /* fall-through */
1396 case BLK_ZERO:
1397 if (s->has_zero_init) {
1398 break;
1400 ret = blk_write_zeroes(s->target, sector_num, n, 0);
1401 if (ret < 0) {
1402 return ret;
1404 break;
1407 sector_num += n;
1408 nb_sectors -= n;
1409 buf += n * BDRV_SECTOR_SIZE;
1412 return 0;
1415 static int convert_do_copy(ImgConvertState *s)
1417 uint8_t *buf = NULL;
1418 int64_t sector_num, allocated_done;
1419 int ret;
1420 int n;
1422 /* Check whether we have zero initialisation or can get it efficiently */
1423 s->has_zero_init = s->min_sparse && !s->target_has_backing
1424 ? bdrv_has_zero_init(blk_bs(s->target))
1425 : false;
1427 if (!s->has_zero_init && !s->target_has_backing &&
1428 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1430 ret = bdrv_make_zero(blk_bs(s->target), BDRV_REQ_MAY_UNMAP);
1431 if (ret == 0) {
1432 s->has_zero_init = true;
1436 /* Allocate buffer for copied data. For compressed images, only one cluster
1437 * can be copied at a time. */
1438 if (s->compressed) {
1439 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1440 error_report("invalid cluster size");
1441 ret = -EINVAL;
1442 goto fail;
1444 s->buf_sectors = s->cluster_sectors;
1446 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1448 /* Calculate allocated sectors for progress */
1449 s->allocated_sectors = 0;
1450 sector_num = 0;
1451 while (sector_num < s->total_sectors) {
1452 n = convert_iteration_sectors(s, sector_num);
1453 if (n < 0) {
1454 ret = n;
1455 goto fail;
1457 if (s->status == BLK_DATA) {
1458 s->allocated_sectors += n;
1460 sector_num += n;
1463 /* Do the copy */
1464 s->src_cur = 0;
1465 s->src_cur_offset = 0;
1466 s->sector_next_status = 0;
1468 sector_num = 0;
1469 allocated_done = 0;
1471 while (sector_num < s->total_sectors) {
1472 n = convert_iteration_sectors(s, sector_num);
1473 if (n < 0) {
1474 ret = n;
1475 goto fail;
1477 if (s->status == BLK_DATA) {
1478 allocated_done += n;
1479 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1483 ret = convert_read(s, sector_num, n, buf);
1484 if (ret < 0) {
1485 error_report("error while reading sector %" PRId64
1486 ": %s", sector_num, strerror(-ret));
1487 goto fail;
1490 ret = convert_write(s, sector_num, n, buf);
1491 if (ret < 0) {
1492 error_report("error while writing sector %" PRId64
1493 ": %s", sector_num, strerror(-ret));
1494 goto fail;
1497 sector_num += n;
1500 if (s->compressed) {
1501 /* signal EOF to align */
1502 ret = blk_write_compressed(s->target, 0, NULL, 0);
1503 if (ret < 0) {
1504 goto fail;
1508 ret = 0;
1509 fail:
1510 qemu_vfree(buf);
1511 return ret;
1514 static int img_convert(int argc, char **argv)
1516 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1517 int64_t ret = 0;
1518 int progress = 0, flags, src_flags;
1519 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1520 BlockDriver *drv, *proto_drv;
1521 BlockBackend **blk = NULL, *out_blk = NULL;
1522 BlockDriverState **bs = NULL, *out_bs = NULL;
1523 int64_t total_sectors;
1524 int64_t *bs_sectors = NULL;
1525 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1526 BlockDriverInfo bdi;
1527 QemuOpts *opts = NULL;
1528 QemuOptsList *create_opts = NULL;
1529 const char *out_baseimg_param;
1530 char *options = NULL;
1531 const char *snapshot_name = NULL;
1532 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1533 bool quiet = false;
1534 Error *local_err = NULL;
1535 QemuOpts *sn_opts = NULL;
1536 ImgConvertState state;
1538 fmt = NULL;
1539 out_fmt = "raw";
1540 cache = "unsafe";
1541 src_cache = BDRV_DEFAULT_CACHE;
1542 out_baseimg = NULL;
1543 compress = 0;
1544 skip_create = 0;
1545 for(;;) {
1546 c = getopt(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn");
1547 if (c == -1) {
1548 break;
1550 switch(c) {
1551 case '?':
1552 case 'h':
1553 help();
1554 break;
1555 case 'f':
1556 fmt = optarg;
1557 break;
1558 case 'O':
1559 out_fmt = optarg;
1560 break;
1561 case 'B':
1562 out_baseimg = optarg;
1563 break;
1564 case 'c':
1565 compress = 1;
1566 break;
1567 case 'e':
1568 error_report("option -e is deprecated, please use \'-o "
1569 "encryption\' instead!");
1570 ret = -1;
1571 goto fail_getopt;
1572 case '6':
1573 error_report("option -6 is deprecated, please use \'-o "
1574 "compat6\' instead!");
1575 ret = -1;
1576 goto fail_getopt;
1577 case 'o':
1578 if (!is_valid_option_list(optarg)) {
1579 error_report("Invalid option list: %s", optarg);
1580 ret = -1;
1581 goto fail_getopt;
1583 if (!options) {
1584 options = g_strdup(optarg);
1585 } else {
1586 char *old_options = options;
1587 options = g_strdup_printf("%s,%s", options, optarg);
1588 g_free(old_options);
1590 break;
1591 case 's':
1592 snapshot_name = optarg;
1593 break;
1594 case 'l':
1595 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1596 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1597 optarg, false);
1598 if (!sn_opts) {
1599 error_report("Failed in parsing snapshot param '%s'",
1600 optarg);
1601 ret = -1;
1602 goto fail_getopt;
1604 } else {
1605 snapshot_name = optarg;
1607 break;
1608 case 'S':
1610 int64_t sval;
1611 char *end;
1612 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1613 if (sval < 0 || *end) {
1614 error_report("Invalid minimum zero buffer size for sparse output specified");
1615 ret = -1;
1616 goto fail_getopt;
1619 min_sparse = sval / BDRV_SECTOR_SIZE;
1620 break;
1622 case 'p':
1623 progress = 1;
1624 break;
1625 case 't':
1626 cache = optarg;
1627 break;
1628 case 'T':
1629 src_cache = optarg;
1630 break;
1631 case 'q':
1632 quiet = true;
1633 break;
1634 case 'n':
1635 skip_create = 1;
1636 break;
1640 /* Initialize before goto out */
1641 if (quiet) {
1642 progress = 0;
1644 qemu_progress_init(progress, 1.0);
1647 bs_n = argc - optind - 1;
1648 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1650 if (options && has_help_option(options)) {
1651 ret = print_block_option_help(out_filename, out_fmt);
1652 goto out;
1655 if (bs_n < 1) {
1656 error_exit("Must specify image file name");
1660 if (bs_n > 1 && out_baseimg) {
1661 error_report("-B makes no sense when concatenating multiple input "
1662 "images");
1663 ret = -1;
1664 goto out;
1667 src_flags = BDRV_O_FLAGS;
1668 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
1669 if (ret < 0) {
1670 error_report("Invalid source cache option: %s", src_cache);
1671 goto out;
1674 qemu_progress_print(0, 100);
1676 blk = g_new0(BlockBackend *, bs_n);
1677 bs = g_new0(BlockDriverState *, bs_n);
1678 bs_sectors = g_new(int64_t, bs_n);
1680 total_sectors = 0;
1681 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1682 char *id = bs_n > 1 ? g_strdup_printf("source_%d", bs_i)
1683 : g_strdup("source");
1684 blk[bs_i] = img_open(id, argv[optind + bs_i], fmt, src_flags,
1685 true, quiet);
1686 g_free(id);
1687 if (!blk[bs_i]) {
1688 ret = -1;
1689 goto out;
1691 bs[bs_i] = blk_bs(blk[bs_i]);
1692 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1693 if (bs_sectors[bs_i] < 0) {
1694 error_report("Could not get size of %s: %s",
1695 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1696 ret = -1;
1697 goto out;
1699 total_sectors += bs_sectors[bs_i];
1702 if (sn_opts) {
1703 ret = bdrv_snapshot_load_tmp(bs[0],
1704 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1705 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1706 &local_err);
1707 } else if (snapshot_name != NULL) {
1708 if (bs_n > 1) {
1709 error_report("No support for concatenating multiple snapshot");
1710 ret = -1;
1711 goto out;
1714 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1716 if (local_err) {
1717 error_report("Failed to load snapshot: %s",
1718 error_get_pretty(local_err));
1719 error_free(local_err);
1720 ret = -1;
1721 goto out;
1724 /* Find driver and parse its options */
1725 drv = bdrv_find_format(out_fmt);
1726 if (!drv) {
1727 error_report("Unknown file format '%s'", out_fmt);
1728 ret = -1;
1729 goto out;
1732 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1733 if (!proto_drv) {
1734 error_report_err(local_err);
1735 ret = -1;
1736 goto out;
1739 if (!skip_create) {
1740 if (!drv->create_opts) {
1741 error_report("Format driver '%s' does not support image creation",
1742 drv->format_name);
1743 ret = -1;
1744 goto out;
1747 if (!proto_drv->create_opts) {
1748 error_report("Protocol driver '%s' does not support image creation",
1749 proto_drv->format_name);
1750 ret = -1;
1751 goto out;
1754 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1755 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1757 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1758 if (options) {
1759 qemu_opts_do_parse(opts, options, NULL, &local_err);
1760 if (local_err) {
1761 error_report_err(local_err);
1762 ret = -1;
1763 goto out;
1767 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
1768 &error_abort);
1769 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
1770 if (ret < 0) {
1771 goto out;
1775 /* Get backing file name if -o backing_file was used */
1776 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1777 if (out_baseimg_param) {
1778 out_baseimg = out_baseimg_param;
1781 /* Check if compression is supported */
1782 if (compress) {
1783 bool encryption =
1784 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
1785 const char *preallocation =
1786 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
1788 if (!drv->bdrv_write_compressed) {
1789 error_report("Compression not supported for this file format");
1790 ret = -1;
1791 goto out;
1794 if (encryption) {
1795 error_report("Compression and encryption not supported at "
1796 "the same time");
1797 ret = -1;
1798 goto out;
1801 if (preallocation
1802 && strcmp(preallocation, "off"))
1804 error_report("Compression and preallocation not supported at "
1805 "the same time");
1806 ret = -1;
1807 goto out;
1811 if (!skip_create) {
1812 /* Create the new image */
1813 ret = bdrv_create(drv, out_filename, opts, &local_err);
1814 if (ret < 0) {
1815 error_report("%s: error while converting %s: %s",
1816 out_filename, out_fmt, error_get_pretty(local_err));
1817 error_free(local_err);
1818 goto out;
1822 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1823 ret = bdrv_parse_cache_flags(cache, &flags);
1824 if (ret < 0) {
1825 error_report("Invalid cache option: %s", cache);
1826 goto out;
1829 out_blk = img_open("target", out_filename, out_fmt, flags, true, quiet);
1830 if (!out_blk) {
1831 ret = -1;
1832 goto out;
1834 out_bs = blk_bs(out_blk);
1836 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1837 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1838 * as maximum. */
1839 bufsectors = MIN(32768,
1840 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
1841 out_bs->bl.discard_alignment))
1844 if (skip_create) {
1845 int64_t output_sectors = blk_nb_sectors(out_blk);
1846 if (output_sectors < 0) {
1847 error_report("unable to get output image length: %s",
1848 strerror(-output_sectors));
1849 ret = -1;
1850 goto out;
1851 } else if (output_sectors < total_sectors) {
1852 error_report("output file is smaller than input file");
1853 ret = -1;
1854 goto out;
1858 cluster_sectors = 0;
1859 ret = bdrv_get_info(out_bs, &bdi);
1860 if (ret < 0) {
1861 if (compress) {
1862 error_report("could not get block driver info");
1863 goto out;
1865 } else {
1866 compress = compress || bdi.needs_compressed_writes;
1867 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1870 state = (ImgConvertState) {
1871 .src = blk,
1872 .src_sectors = bs_sectors,
1873 .src_num = bs_n,
1874 .total_sectors = total_sectors,
1875 .target = out_blk,
1876 .compressed = compress,
1877 .target_has_backing = (bool) out_baseimg,
1878 .min_sparse = min_sparse,
1879 .cluster_sectors = cluster_sectors,
1880 .buf_sectors = bufsectors,
1882 ret = convert_do_copy(&state);
1884 out:
1885 if (!ret) {
1886 qemu_progress_print(100, 0);
1888 qemu_progress_end();
1889 qemu_opts_del(opts);
1890 qemu_opts_free(create_opts);
1891 qemu_opts_del(sn_opts);
1892 blk_unref(out_blk);
1893 g_free(bs);
1894 if (blk) {
1895 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1896 blk_unref(blk[bs_i]);
1898 g_free(blk);
1900 g_free(bs_sectors);
1901 fail_getopt:
1902 g_free(options);
1904 if (ret) {
1905 return 1;
1907 return 0;
1911 static void dump_snapshots(BlockDriverState *bs)
1913 QEMUSnapshotInfo *sn_tab, *sn;
1914 int nb_sns, i;
1916 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1917 if (nb_sns <= 0)
1918 return;
1919 printf("Snapshot list:\n");
1920 bdrv_snapshot_dump(fprintf, stdout, NULL);
1921 printf("\n");
1922 for(i = 0; i < nb_sns; i++) {
1923 sn = &sn_tab[i];
1924 bdrv_snapshot_dump(fprintf, stdout, sn);
1925 printf("\n");
1927 g_free(sn_tab);
1930 static void dump_json_image_info_list(ImageInfoList *list)
1932 Error *local_err = NULL;
1933 QString *str;
1934 QmpOutputVisitor *ov = qmp_output_visitor_new();
1935 QObject *obj;
1936 visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1937 &list, NULL, &local_err);
1938 obj = qmp_output_get_qobject(ov);
1939 str = qobject_to_json_pretty(obj);
1940 assert(str != NULL);
1941 printf("%s\n", qstring_get_str(str));
1942 qobject_decref(obj);
1943 qmp_output_visitor_cleanup(ov);
1944 QDECREF(str);
1947 static void dump_json_image_info(ImageInfo *info)
1949 Error *local_err = NULL;
1950 QString *str;
1951 QmpOutputVisitor *ov = qmp_output_visitor_new();
1952 QObject *obj;
1953 visit_type_ImageInfo(qmp_output_get_visitor(ov),
1954 &info, NULL, &local_err);
1955 obj = qmp_output_get_qobject(ov);
1956 str = qobject_to_json_pretty(obj);
1957 assert(str != NULL);
1958 printf("%s\n", qstring_get_str(str));
1959 qobject_decref(obj);
1960 qmp_output_visitor_cleanup(ov);
1961 QDECREF(str);
1964 static void dump_human_image_info_list(ImageInfoList *list)
1966 ImageInfoList *elem;
1967 bool delim = false;
1969 for (elem = list; elem; elem = elem->next) {
1970 if (delim) {
1971 printf("\n");
1973 delim = true;
1975 bdrv_image_info_dump(fprintf, stdout, elem->value);
1979 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1981 return strcmp(a, b) == 0;
1985 * Open an image file chain and return an ImageInfoList
1987 * @filename: topmost image filename
1988 * @fmt: topmost image format (may be NULL to autodetect)
1989 * @chain: true - enumerate entire backing file chain
1990 * false - only topmost image file
1992 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1993 * image file. If there was an error a message will have been printed to
1994 * stderr.
1996 static ImageInfoList *collect_image_info_list(const char *filename,
1997 const char *fmt,
1998 bool chain)
2000 ImageInfoList *head = NULL;
2001 ImageInfoList **last = &head;
2002 GHashTable *filenames;
2003 Error *err = NULL;
2005 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2007 while (filename) {
2008 BlockBackend *blk;
2009 BlockDriverState *bs;
2010 ImageInfo *info;
2011 ImageInfoList *elem;
2013 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2014 error_report("Backing file '%s' creates an infinite loop.",
2015 filename);
2016 goto err;
2018 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2020 blk = img_open("image", filename, fmt,
2021 BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
2022 if (!blk) {
2023 goto err;
2025 bs = blk_bs(blk);
2027 bdrv_query_image_info(bs, &info, &err);
2028 if (err) {
2029 error_report_err(err);
2030 blk_unref(blk);
2031 goto err;
2034 elem = g_new0(ImageInfoList, 1);
2035 elem->value = info;
2036 *last = elem;
2037 last = &elem->next;
2039 blk_unref(blk);
2041 filename = fmt = NULL;
2042 if (chain) {
2043 if (info->has_full_backing_filename) {
2044 filename = info->full_backing_filename;
2045 } else if (info->has_backing_filename) {
2046 filename = info->backing_filename;
2048 if (info->has_backing_filename_format) {
2049 fmt = info->backing_filename_format;
2053 g_hash_table_destroy(filenames);
2054 return head;
2056 err:
2057 qapi_free_ImageInfoList(head);
2058 g_hash_table_destroy(filenames);
2059 return NULL;
2062 static int img_info(int argc, char **argv)
2064 int c;
2065 OutputFormat output_format = OFORMAT_HUMAN;
2066 bool chain = false;
2067 const char *filename, *fmt, *output;
2068 ImageInfoList *list;
2070 fmt = NULL;
2071 output = NULL;
2072 for(;;) {
2073 int option_index = 0;
2074 static const struct option long_options[] = {
2075 {"help", no_argument, 0, 'h'},
2076 {"format", required_argument, 0, 'f'},
2077 {"output", required_argument, 0, OPTION_OUTPUT},
2078 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2079 {0, 0, 0, 0}
2081 c = getopt_long(argc, argv, "f:h",
2082 long_options, &option_index);
2083 if (c == -1) {
2084 break;
2086 switch(c) {
2087 case '?':
2088 case 'h':
2089 help();
2090 break;
2091 case 'f':
2092 fmt = optarg;
2093 break;
2094 case OPTION_OUTPUT:
2095 output = optarg;
2096 break;
2097 case OPTION_BACKING_CHAIN:
2098 chain = true;
2099 break;
2102 if (optind != argc - 1) {
2103 error_exit("Expecting one image file name");
2105 filename = argv[optind++];
2107 if (output && !strcmp(output, "json")) {
2108 output_format = OFORMAT_JSON;
2109 } else if (output && !strcmp(output, "human")) {
2110 output_format = OFORMAT_HUMAN;
2111 } else if (output) {
2112 error_report("--output must be used with human or json as argument.");
2113 return 1;
2116 list = collect_image_info_list(filename, fmt, chain);
2117 if (!list) {
2118 return 1;
2121 switch (output_format) {
2122 case OFORMAT_HUMAN:
2123 dump_human_image_info_list(list);
2124 break;
2125 case OFORMAT_JSON:
2126 if (chain) {
2127 dump_json_image_info_list(list);
2128 } else {
2129 dump_json_image_info(list->value);
2131 break;
2134 qapi_free_ImageInfoList(list);
2135 return 0;
2139 typedef struct MapEntry {
2140 int flags;
2141 int depth;
2142 int64_t start;
2143 int64_t length;
2144 int64_t offset;
2145 BlockDriverState *bs;
2146 } MapEntry;
2148 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2149 MapEntry *next)
2151 switch (output_format) {
2152 case OFORMAT_HUMAN:
2153 if ((e->flags & BDRV_BLOCK_DATA) &&
2154 !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
2155 error_report("File contains external, encrypted or compressed clusters.");
2156 exit(1);
2158 if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
2159 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2160 e->start, e->length, e->offset, e->bs->filename);
2162 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2163 * Modify the flags here to allow more coalescing.
2165 if (next &&
2166 (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
2167 next->flags &= ~BDRV_BLOCK_DATA;
2168 next->flags |= BDRV_BLOCK_ZERO;
2170 break;
2171 case OFORMAT_JSON:
2172 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
2173 " \"zero\": %s, \"data\": %s",
2174 (e->start == 0 ? "[" : ",\n"),
2175 e->start, e->length, e->depth,
2176 (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
2177 (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
2178 if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
2179 printf(", \"offset\": %"PRId64"", e->offset);
2181 putchar('}');
2183 if (!next) {
2184 printf("]\n");
2186 break;
2190 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2191 int nb_sectors, MapEntry *e)
2193 int64_t ret;
2194 int depth;
2196 /* As an optimization, we could cache the current range of unallocated
2197 * clusters in each file of the chain, and avoid querying the same
2198 * range repeatedly.
2201 depth = 0;
2202 for (;;) {
2203 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
2204 if (ret < 0) {
2205 return ret;
2207 assert(nb_sectors);
2208 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2209 break;
2211 bs = backing_bs(bs);
2212 if (bs == NULL) {
2213 ret = 0;
2214 break;
2217 depth++;
2220 e->start = sector_num * BDRV_SECTOR_SIZE;
2221 e->length = nb_sectors * BDRV_SECTOR_SIZE;
2222 e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2223 e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2224 e->depth = depth;
2225 e->bs = bs;
2226 return 0;
2229 static int img_map(int argc, char **argv)
2231 int c;
2232 OutputFormat output_format = OFORMAT_HUMAN;
2233 BlockBackend *blk;
2234 BlockDriverState *bs;
2235 const char *filename, *fmt, *output;
2236 int64_t length;
2237 MapEntry curr = { .length = 0 }, next;
2238 int ret = 0;
2240 fmt = NULL;
2241 output = NULL;
2242 for (;;) {
2243 int option_index = 0;
2244 static const struct option long_options[] = {
2245 {"help", no_argument, 0, 'h'},
2246 {"format", required_argument, 0, 'f'},
2247 {"output", required_argument, 0, OPTION_OUTPUT},
2248 {0, 0, 0, 0}
2250 c = getopt_long(argc, argv, "f:h",
2251 long_options, &option_index);
2252 if (c == -1) {
2253 break;
2255 switch (c) {
2256 case '?':
2257 case 'h':
2258 help();
2259 break;
2260 case 'f':
2261 fmt = optarg;
2262 break;
2263 case OPTION_OUTPUT:
2264 output = optarg;
2265 break;
2268 if (optind != argc - 1) {
2269 error_exit("Expecting one image file name");
2271 filename = argv[optind];
2273 if (output && !strcmp(output, "json")) {
2274 output_format = OFORMAT_JSON;
2275 } else if (output && !strcmp(output, "human")) {
2276 output_format = OFORMAT_HUMAN;
2277 } else if (output) {
2278 error_report("--output must be used with human or json as argument.");
2279 return 1;
2282 blk = img_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
2283 if (!blk) {
2284 return 1;
2286 bs = blk_bs(blk);
2288 if (output_format == OFORMAT_HUMAN) {
2289 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2292 length = blk_getlength(blk);
2293 while (curr.start + curr.length < length) {
2294 int64_t nsectors_left;
2295 int64_t sector_num;
2296 int n;
2298 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2300 /* Probe up to 1 GiB at a time. */
2301 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2302 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2303 ret = get_block_status(bs, sector_num, n, &next);
2305 if (ret < 0) {
2306 error_report("Could not read file metadata: %s", strerror(-ret));
2307 goto out;
2310 if (curr.length != 0 && curr.flags == next.flags &&
2311 curr.depth == next.depth &&
2312 ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2313 curr.offset + curr.length == next.offset)) {
2314 curr.length += next.length;
2315 continue;
2318 if (curr.length > 0) {
2319 dump_map_entry(output_format, &curr, &next);
2321 curr = next;
2324 dump_map_entry(output_format, &curr, NULL);
2326 out:
2327 blk_unref(blk);
2328 return ret < 0;
2331 #define SNAPSHOT_LIST 1
2332 #define SNAPSHOT_CREATE 2
2333 #define SNAPSHOT_APPLY 3
2334 #define SNAPSHOT_DELETE 4
2336 static int img_snapshot(int argc, char **argv)
2338 BlockBackend *blk;
2339 BlockDriverState *bs;
2340 QEMUSnapshotInfo sn;
2341 char *filename, *snapshot_name = NULL;
2342 int c, ret = 0, bdrv_oflags;
2343 int action = 0;
2344 qemu_timeval tv;
2345 bool quiet = false;
2346 Error *err = NULL;
2348 bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2349 /* Parse commandline parameters */
2350 for(;;) {
2351 c = getopt(argc, argv, "la:c:d:hq");
2352 if (c == -1) {
2353 break;
2355 switch(c) {
2356 case '?':
2357 case 'h':
2358 help();
2359 return 0;
2360 case 'l':
2361 if (action) {
2362 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2363 return 0;
2365 action = SNAPSHOT_LIST;
2366 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2367 break;
2368 case 'a':
2369 if (action) {
2370 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2371 return 0;
2373 action = SNAPSHOT_APPLY;
2374 snapshot_name = optarg;
2375 break;
2376 case 'c':
2377 if (action) {
2378 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2379 return 0;
2381 action = SNAPSHOT_CREATE;
2382 snapshot_name = optarg;
2383 break;
2384 case 'd':
2385 if (action) {
2386 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2387 return 0;
2389 action = SNAPSHOT_DELETE;
2390 snapshot_name = optarg;
2391 break;
2392 case 'q':
2393 quiet = true;
2394 break;
2398 if (optind != argc - 1) {
2399 error_exit("Expecting one image file name");
2401 filename = argv[optind++];
2403 /* Open the image */
2404 blk = img_open("image", filename, NULL, bdrv_oflags, true, quiet);
2405 if (!blk) {
2406 return 1;
2408 bs = blk_bs(blk);
2410 /* Perform the requested action */
2411 switch(action) {
2412 case SNAPSHOT_LIST:
2413 dump_snapshots(bs);
2414 break;
2416 case SNAPSHOT_CREATE:
2417 memset(&sn, 0, sizeof(sn));
2418 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2420 qemu_gettimeofday(&tv);
2421 sn.date_sec = tv.tv_sec;
2422 sn.date_nsec = tv.tv_usec * 1000;
2424 ret = bdrv_snapshot_create(bs, &sn);
2425 if (ret) {
2426 error_report("Could not create snapshot '%s': %d (%s)",
2427 snapshot_name, ret, strerror(-ret));
2429 break;
2431 case SNAPSHOT_APPLY:
2432 ret = bdrv_snapshot_goto(bs, snapshot_name);
2433 if (ret) {
2434 error_report("Could not apply snapshot '%s': %d (%s)",
2435 snapshot_name, ret, strerror(-ret));
2437 break;
2439 case SNAPSHOT_DELETE:
2440 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2441 if (err) {
2442 error_report("Could not delete snapshot '%s': (%s)",
2443 snapshot_name, error_get_pretty(err));
2444 error_free(err);
2445 ret = 1;
2447 break;
2450 /* Cleanup */
2451 blk_unref(blk);
2452 if (ret) {
2453 return 1;
2455 return 0;
2458 static int img_rebase(int argc, char **argv)
2460 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2461 BlockDriverState *bs = NULL;
2462 char *filename;
2463 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2464 int c, flags, src_flags, ret;
2465 int unsafe = 0;
2466 int progress = 0;
2467 bool quiet = false;
2468 Error *local_err = NULL;
2470 /* Parse commandline parameters */
2471 fmt = NULL;
2472 cache = BDRV_DEFAULT_CACHE;
2473 src_cache = BDRV_DEFAULT_CACHE;
2474 out_baseimg = NULL;
2475 out_basefmt = NULL;
2476 for(;;) {
2477 c = getopt(argc, argv, "hf:F:b:upt:T:q");
2478 if (c == -1) {
2479 break;
2481 switch(c) {
2482 case '?':
2483 case 'h':
2484 help();
2485 return 0;
2486 case 'f':
2487 fmt = optarg;
2488 break;
2489 case 'F':
2490 out_basefmt = optarg;
2491 break;
2492 case 'b':
2493 out_baseimg = optarg;
2494 break;
2495 case 'u':
2496 unsafe = 1;
2497 break;
2498 case 'p':
2499 progress = 1;
2500 break;
2501 case 't':
2502 cache = optarg;
2503 break;
2504 case 'T':
2505 src_cache = optarg;
2506 break;
2507 case 'q':
2508 quiet = true;
2509 break;
2513 if (quiet) {
2514 progress = 0;
2517 if (optind != argc - 1) {
2518 error_exit("Expecting one image file name");
2520 if (!unsafe && !out_baseimg) {
2521 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2523 filename = argv[optind++];
2525 qemu_progress_init(progress, 2.0);
2526 qemu_progress_print(0, 100);
2528 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2529 ret = bdrv_parse_cache_flags(cache, &flags);
2530 if (ret < 0) {
2531 error_report("Invalid cache option: %s", cache);
2532 goto out;
2535 src_flags = BDRV_O_FLAGS;
2536 ret = bdrv_parse_cache_flags(src_cache, &src_flags);
2537 if (ret < 0) {
2538 error_report("Invalid source cache option: %s", src_cache);
2539 goto out;
2543 * Open the images.
2545 * Ignore the old backing file for unsafe rebase in case we want to correct
2546 * the reference to a renamed or moved backing file.
2548 blk = img_open("image", filename, fmt, flags, true, quiet);
2549 if (!blk) {
2550 ret = -1;
2551 goto out;
2553 bs = blk_bs(blk);
2555 if (out_basefmt != NULL) {
2556 if (bdrv_find_format(out_basefmt) == NULL) {
2557 error_report("Invalid format name: '%s'", out_basefmt);
2558 ret = -1;
2559 goto out;
2563 /* For safe rebasing we need to compare old and new backing file */
2564 if (!unsafe) {
2565 char backing_name[PATH_MAX];
2566 QDict *options = NULL;
2568 if (bs->backing_format[0] != '\0') {
2569 options = qdict_new();
2570 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2573 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2574 blk_old_backing = blk_new_open("old_backing", backing_name, NULL,
2575 options, src_flags, &local_err);
2576 if (!blk_old_backing) {
2577 error_report("Could not open old backing file '%s': %s",
2578 backing_name, error_get_pretty(local_err));
2579 error_free(local_err);
2580 goto out;
2583 if (out_baseimg[0]) {
2584 if (out_basefmt) {
2585 options = qdict_new();
2586 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2587 } else {
2588 options = NULL;
2591 blk_new_backing = blk_new_open("new_backing", out_baseimg, NULL,
2592 options, src_flags, &local_err);
2593 if (!blk_new_backing) {
2594 error_report("Could not open new backing file '%s': %s",
2595 out_baseimg, error_get_pretty(local_err));
2596 error_free(local_err);
2597 goto out;
2603 * Check each unallocated cluster in the COW file. If it is unallocated,
2604 * accesses go to the backing file. We must therefore compare this cluster
2605 * in the old and new backing file, and if they differ we need to copy it
2606 * from the old backing file into the COW file.
2608 * If qemu-img crashes during this step, no harm is done. The content of
2609 * the image is the same as the original one at any time.
2611 if (!unsafe) {
2612 int64_t num_sectors;
2613 int64_t old_backing_num_sectors;
2614 int64_t new_backing_num_sectors = 0;
2615 uint64_t sector;
2616 int n;
2617 uint8_t * buf_old;
2618 uint8_t * buf_new;
2619 float local_progress = 0;
2621 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
2622 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
2624 num_sectors = blk_nb_sectors(blk);
2625 if (num_sectors < 0) {
2626 error_report("Could not get size of '%s': %s",
2627 filename, strerror(-num_sectors));
2628 ret = -1;
2629 goto out;
2631 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2632 if (old_backing_num_sectors < 0) {
2633 char backing_name[PATH_MAX];
2635 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2636 error_report("Could not get size of '%s': %s",
2637 backing_name, strerror(-old_backing_num_sectors));
2638 ret = -1;
2639 goto out;
2641 if (blk_new_backing) {
2642 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
2643 if (new_backing_num_sectors < 0) {
2644 error_report("Could not get size of '%s': %s",
2645 out_baseimg, strerror(-new_backing_num_sectors));
2646 ret = -1;
2647 goto out;
2651 if (num_sectors != 0) {
2652 local_progress = (float)100 /
2653 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2656 for (sector = 0; sector < num_sectors; sector += n) {
2658 /* How many sectors can we handle with the next read? */
2659 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2660 n = (IO_BUF_SIZE / 512);
2661 } else {
2662 n = num_sectors - sector;
2665 /* If the cluster is allocated, we don't need to take action */
2666 ret = bdrv_is_allocated(bs, sector, n, &n);
2667 if (ret < 0) {
2668 error_report("error while reading image metadata: %s",
2669 strerror(-ret));
2670 goto out;
2672 if (ret) {
2673 continue;
2677 * Read old and new backing file and take into consideration that
2678 * backing files may be smaller than the COW image.
2680 if (sector >= old_backing_num_sectors) {
2681 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2682 } else {
2683 if (sector + n > old_backing_num_sectors) {
2684 n = old_backing_num_sectors - sector;
2687 ret = blk_read(blk_old_backing, sector, buf_old, n);
2688 if (ret < 0) {
2689 error_report("error while reading from old backing file");
2690 goto out;
2694 if (sector >= new_backing_num_sectors || !blk_new_backing) {
2695 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2696 } else {
2697 if (sector + n > new_backing_num_sectors) {
2698 n = new_backing_num_sectors - sector;
2701 ret = blk_read(blk_new_backing, sector, buf_new, n);
2702 if (ret < 0) {
2703 error_report("error while reading from new backing file");
2704 goto out;
2708 /* If they differ, we need to write to the COW file */
2709 uint64_t written = 0;
2711 while (written < n) {
2712 int pnum;
2714 if (compare_sectors(buf_old + written * 512,
2715 buf_new + written * 512, n - written, &pnum))
2717 ret = blk_write(blk, sector + written,
2718 buf_old + written * 512, pnum);
2719 if (ret < 0) {
2720 error_report("Error while writing to COW image: %s",
2721 strerror(-ret));
2722 goto out;
2726 written += pnum;
2728 qemu_progress_print(local_progress, 100);
2731 qemu_vfree(buf_old);
2732 qemu_vfree(buf_new);
2736 * Change the backing file. All clusters that are different from the old
2737 * backing file are overwritten in the COW file now, so the visible content
2738 * doesn't change when we switch the backing file.
2740 if (out_baseimg && *out_baseimg) {
2741 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2742 } else {
2743 ret = bdrv_change_backing_file(bs, NULL, NULL);
2746 if (ret == -ENOSPC) {
2747 error_report("Could not change the backing file to '%s': No "
2748 "space left in the file header", out_baseimg);
2749 } else if (ret < 0) {
2750 error_report("Could not change the backing file to '%s': %s",
2751 out_baseimg, strerror(-ret));
2754 qemu_progress_print(100, 0);
2756 * TODO At this point it is possible to check if any clusters that are
2757 * allocated in the COW file are the same in the backing file. If so, they
2758 * could be dropped from the COW file. Don't do this before switching the
2759 * backing file, in case of a crash this would lead to corruption.
2761 out:
2762 qemu_progress_end();
2763 /* Cleanup */
2764 if (!unsafe) {
2765 blk_unref(blk_old_backing);
2766 blk_unref(blk_new_backing);
2769 blk_unref(blk);
2770 if (ret) {
2771 return 1;
2773 return 0;
2776 static int img_resize(int argc, char **argv)
2778 Error *err = NULL;
2779 int c, ret, relative;
2780 const char *filename, *fmt, *size;
2781 int64_t n, total_size;
2782 bool quiet = false;
2783 BlockBackend *blk = NULL;
2784 QemuOpts *param;
2785 static QemuOptsList resize_options = {
2786 .name = "resize_options",
2787 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2788 .desc = {
2790 .name = BLOCK_OPT_SIZE,
2791 .type = QEMU_OPT_SIZE,
2792 .help = "Virtual disk size"
2793 }, {
2794 /* end of list */
2799 /* Remove size from argv manually so that negative numbers are not treated
2800 * as options by getopt. */
2801 if (argc < 3) {
2802 error_exit("Not enough arguments");
2803 return 1;
2806 size = argv[--argc];
2808 /* Parse getopt arguments */
2809 fmt = NULL;
2810 for(;;) {
2811 c = getopt(argc, argv, "f:hq");
2812 if (c == -1) {
2813 break;
2815 switch(c) {
2816 case '?':
2817 case 'h':
2818 help();
2819 break;
2820 case 'f':
2821 fmt = optarg;
2822 break;
2823 case 'q':
2824 quiet = true;
2825 break;
2828 if (optind != argc - 1) {
2829 error_exit("Expecting one image file name");
2831 filename = argv[optind++];
2833 /* Choose grow, shrink, or absolute resize mode */
2834 switch (size[0]) {
2835 case '+':
2836 relative = 1;
2837 size++;
2838 break;
2839 case '-':
2840 relative = -1;
2841 size++;
2842 break;
2843 default:
2844 relative = 0;
2845 break;
2848 /* Parse size */
2849 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2850 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
2851 if (err) {
2852 error_report_err(err);
2853 ret = -1;
2854 qemu_opts_del(param);
2855 goto out;
2857 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2858 qemu_opts_del(param);
2860 blk = img_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
2861 true, quiet);
2862 if (!blk) {
2863 ret = -1;
2864 goto out;
2867 if (relative) {
2868 total_size = blk_getlength(blk) + n * relative;
2869 } else {
2870 total_size = n;
2872 if (total_size <= 0) {
2873 error_report("New image size must be positive");
2874 ret = -1;
2875 goto out;
2878 ret = blk_truncate(blk, total_size);
2879 switch (ret) {
2880 case 0:
2881 qprintf(quiet, "Image resized.\n");
2882 break;
2883 case -ENOTSUP:
2884 error_report("This image does not support resize");
2885 break;
2886 case -EACCES:
2887 error_report("Image is read-only");
2888 break;
2889 default:
2890 error_report("Error resizing image (%d)", -ret);
2891 break;
2893 out:
2894 blk_unref(blk);
2895 if (ret) {
2896 return 1;
2898 return 0;
2901 static void amend_status_cb(BlockDriverState *bs,
2902 int64_t offset, int64_t total_work_size)
2904 qemu_progress_print(100.f * offset / total_work_size, 0);
2907 static int img_amend(int argc, char **argv)
2909 Error *err = NULL;
2910 int c, ret = 0;
2911 char *options = NULL;
2912 QemuOptsList *create_opts = NULL;
2913 QemuOpts *opts = NULL;
2914 const char *fmt = NULL, *filename, *cache;
2915 int flags;
2916 bool quiet = false, progress = false;
2917 BlockBackend *blk = NULL;
2918 BlockDriverState *bs = NULL;
2920 cache = BDRV_DEFAULT_CACHE;
2921 for (;;) {
2922 c = getopt(argc, argv, "ho:f:t:pq");
2923 if (c == -1) {
2924 break;
2927 switch (c) {
2928 case 'h':
2929 case '?':
2930 help();
2931 break;
2932 case 'o':
2933 if (!is_valid_option_list(optarg)) {
2934 error_report("Invalid option list: %s", optarg);
2935 ret = -1;
2936 goto out_no_progress;
2938 if (!options) {
2939 options = g_strdup(optarg);
2940 } else {
2941 char *old_options = options;
2942 options = g_strdup_printf("%s,%s", options, optarg);
2943 g_free(old_options);
2945 break;
2946 case 'f':
2947 fmt = optarg;
2948 break;
2949 case 't':
2950 cache = optarg;
2951 break;
2952 case 'p':
2953 progress = true;
2954 break;
2955 case 'q':
2956 quiet = true;
2957 break;
2961 if (!options) {
2962 error_exit("Must specify options (-o)");
2965 if (quiet) {
2966 progress = false;
2968 qemu_progress_init(progress, 1.0);
2970 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2971 if (fmt && has_help_option(options)) {
2972 /* If a format is explicitly specified (and possibly no filename is
2973 * given), print option help here */
2974 ret = print_block_option_help(filename, fmt);
2975 goto out;
2978 if (optind != argc - 1) {
2979 error_report("Expecting one image file name");
2980 ret = -1;
2981 goto out;
2984 flags = BDRV_O_FLAGS | BDRV_O_RDWR;
2985 ret = bdrv_parse_cache_flags(cache, &flags);
2986 if (ret < 0) {
2987 error_report("Invalid cache option: %s", cache);
2988 goto out;
2991 blk = img_open("image", filename, fmt, flags, true, quiet);
2992 if (!blk) {
2993 ret = -1;
2994 goto out;
2996 bs = blk_bs(blk);
2998 fmt = bs->drv->format_name;
3000 if (has_help_option(options)) {
3001 /* If the format was auto-detected, print option help here */
3002 ret = print_block_option_help(filename, fmt);
3003 goto out;
3006 if (!bs->drv->create_opts) {
3007 error_report("Format driver '%s' does not support any options to amend",
3008 fmt);
3009 ret = -1;
3010 goto out;
3013 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3014 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3015 if (options) {
3016 qemu_opts_do_parse(opts, options, NULL, &err);
3017 if (err) {
3018 error_report_err(err);
3019 ret = -1;
3020 goto out;
3024 /* In case the driver does not call amend_status_cb() */
3025 qemu_progress_print(0.f, 0);
3026 ret = bdrv_amend_options(bs, opts, &amend_status_cb);
3027 qemu_progress_print(100.f, 0);
3028 if (ret < 0) {
3029 error_report("Error while amending options: %s", strerror(-ret));
3030 goto out;
3033 out:
3034 qemu_progress_end();
3036 out_no_progress:
3037 blk_unref(blk);
3038 qemu_opts_del(opts);
3039 qemu_opts_free(create_opts);
3040 g_free(options);
3042 if (ret) {
3043 return 1;
3045 return 0;
3048 static const img_cmd_t img_cmds[] = {
3049 #define DEF(option, callback, arg_string) \
3050 { option, callback },
3051 #include "qemu-img-cmds.h"
3052 #undef DEF
3053 #undef GEN_DOCS
3054 { NULL, NULL, },
3057 int main(int argc, char **argv)
3059 const img_cmd_t *cmd;
3060 const char *cmdname;
3061 Error *local_error = NULL;
3062 int c;
3063 static const struct option long_options[] = {
3064 {"help", no_argument, 0, 'h'},
3065 {"version", no_argument, 0, 'v'},
3066 {0, 0, 0, 0}
3069 #ifdef CONFIG_POSIX
3070 signal(SIGPIPE, SIG_IGN);
3071 #endif
3073 error_set_progname(argv[0]);
3074 qemu_init_exec_dir(argv[0]);
3076 if (qemu_init_main_loop(&local_error)) {
3077 error_report_err(local_error);
3078 exit(EXIT_FAILURE);
3081 bdrv_init();
3082 if (argc < 2) {
3083 error_exit("Not enough arguments");
3085 cmdname = argv[1];
3087 /* find the command */
3088 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
3089 if (!strcmp(cmdname, cmd->name)) {
3090 return cmd->handler(argc - 1, argv + 1);
3094 c = getopt_long(argc, argv, "h", long_options, NULL);
3096 if (c == 'h') {
3097 help();
3099 if (c == 'v') {
3100 printf(QEMU_IMG_VERSION);
3101 return 0;
3104 /* not found */
3105 error_exit("Command not found: %s", cmdname);