Merge remote-tracking branch 'remotes/armbru/tags/pull-backends-2016-04-15' into...
[qemu.git] / qemu-img.c
blob169776260650ec287770faab0681af4884e6054d
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 "qemu/osdep.h"
25 #include "qapi/error.h"
26 #include "qapi-visit.h"
27 #include "qapi/qmp-output-visitor.h"
28 #include "qapi/qmp/qerror.h"
29 #include "qapi/qmp/qjson.h"
30 #include "qemu/cutils.h"
31 #include "qemu/config-file.h"
32 #include "qemu/option.h"
33 #include "qemu/error-report.h"
34 #include "qom/object_interfaces.h"
35 #include "sysemu/sysemu.h"
36 #include "sysemu/block-backend.h"
37 #include "block/block_int.h"
38 #include "block/blockjob.h"
39 #include "block/qapi.h"
40 #include "crypto/init.h"
41 #include <getopt.h>
43 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
44 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
46 typedef struct img_cmd_t {
47 const char *name;
48 int (*handler)(int argc, char **argv);
49 } img_cmd_t;
51 enum {
52 OPTION_OUTPUT = 256,
53 OPTION_BACKING_CHAIN = 257,
54 OPTION_OBJECT = 258,
55 OPTION_IMAGE_OPTS = 259,
58 typedef enum OutputFormat {
59 OFORMAT_JSON,
60 OFORMAT_HUMAN,
61 } OutputFormat;
63 /* Default to cache=writeback as data integrity is not important for qemu-img */
64 #define BDRV_DEFAULT_CACHE "writeback"
66 static void format_print(void *opaque, const char *name)
68 printf(" %s", name);
71 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
73 va_list ap;
75 error_printf("qemu-img: ");
77 va_start(ap, fmt);
78 error_vprintf(fmt, ap);
79 va_end(ap);
81 error_printf("\nTry 'qemu-img --help' for more information\n");
82 exit(EXIT_FAILURE);
85 /* Please keep in synch with qemu-img.texi */
86 static void QEMU_NORETURN help(void)
88 const char *help_msg =
89 QEMU_IMG_VERSION
90 "usage: qemu-img command [command options]\n"
91 "QEMU disk image utility\n"
92 "\n"
93 "Command syntax:\n"
94 #define DEF(option, callback, arg_string) \
95 " " arg_string "\n"
96 #include "qemu-img-cmds.h"
97 #undef DEF
98 #undef GEN_DOCS
99 "\n"
100 "Command parameters:\n"
101 " 'filename' is a disk image filename\n"
102 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
103 " manual page for a description of the object properties. The most common\n"
104 " object type is a 'secret', which is used to supply passwords and/or\n"
105 " encryption keys.\n"
106 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
107 " 'cache' is the cache mode used to write the output disk image, the valid\n"
108 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
109 " 'directsync' and 'unsafe' (default for convert)\n"
110 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
111 " options are the same as for the 'cache' option\n"
112 " 'size' is the disk image size in bytes. Optional suffixes\n"
113 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
114 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
115 " supported. 'b' is ignored.\n"
116 " 'output_filename' is the destination disk image filename\n"
117 " 'output_fmt' is the destination format\n"
118 " 'options' is a comma separated list of format specific options in a\n"
119 " name=value format. Use -o ? for an overview of the options supported by the\n"
120 " used format\n"
121 " 'snapshot_param' is param used for internal snapshot, format\n"
122 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
123 " '[ID_OR_NAME]'\n"
124 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
125 " instead\n"
126 " '-c' indicates that target image must be compressed (qcow format only)\n"
127 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
128 " match exactly. The image doesn't need a working backing file before\n"
129 " rebasing in this case (useful for renaming the backing file)\n"
130 " '-h' with or without a command shows this help and lists the supported formats\n"
131 " '-p' show progress of command (only certain commands)\n"
132 " '-q' use Quiet mode - do not print any output (except errors)\n"
133 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
134 " contain only zeros for qemu-img to create a sparse image during\n"
135 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
136 " unallocated or zero sectors, and the destination image will always be\n"
137 " fully allocated\n"
138 " '--output' takes the format in which the output must be done (human or json)\n"
139 " '-n' skips the target volume creation (useful if the volume is created\n"
140 " prior to running qemu-img)\n"
141 "\n"
142 "Parameters to check subcommand:\n"
143 " '-r' tries to repair any inconsistencies that are found during the check.\n"
144 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
145 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
146 " hiding corruption that has already occurred.\n"
147 "\n"
148 "Parameters to snapshot subcommand:\n"
149 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
150 " '-a' applies a snapshot (revert disk to saved state)\n"
151 " '-c' creates a snapshot\n"
152 " '-d' deletes a snapshot\n"
153 " '-l' lists all snapshots in the given image\n"
154 "\n"
155 "Parameters to compare subcommand:\n"
156 " '-f' first image format\n"
157 " '-F' second image format\n"
158 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
160 printf("%s\nSupported formats:", help_msg);
161 bdrv_iterate_format(format_print, NULL);
162 printf("\n");
163 exit(EXIT_SUCCESS);
166 static QemuOptsList qemu_object_opts = {
167 .name = "object",
168 .implied_opt_name = "qom-type",
169 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
170 .desc = {
175 static QemuOptsList qemu_source_opts = {
176 .name = "source",
177 .implied_opt_name = "file",
178 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
179 .desc = {
184 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
186 int ret = 0;
187 if (!quiet) {
188 va_list args;
189 va_start(args, fmt);
190 ret = vprintf(fmt, args);
191 va_end(args);
193 return ret;
197 static int print_block_option_help(const char *filename, const char *fmt)
199 BlockDriver *drv, *proto_drv;
200 QemuOptsList *create_opts = NULL;
201 Error *local_err = NULL;
203 /* Find driver and parse its options */
204 drv = bdrv_find_format(fmt);
205 if (!drv) {
206 error_report("Unknown file format '%s'", fmt);
207 return 1;
210 create_opts = qemu_opts_append(create_opts, drv->create_opts);
211 if (filename) {
212 proto_drv = bdrv_find_protocol(filename, true, &local_err);
213 if (!proto_drv) {
214 error_report_err(local_err);
215 qemu_opts_free(create_opts);
216 return 1;
218 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
221 qemu_opts_print_help(create_opts);
222 qemu_opts_free(create_opts);
223 return 0;
227 static int img_open_password(BlockBackend *blk, const char *filename,
228 int flags, bool quiet)
230 BlockDriverState *bs;
231 char password[256];
233 bs = blk_bs(blk);
234 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
235 !(flags & BDRV_O_NO_IO)) {
236 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
237 if (qemu_read_password(password, sizeof(password)) < 0) {
238 error_report("No password given");
239 return -1;
241 if (bdrv_set_key(bs, password) < 0) {
242 error_report("invalid password");
243 return -1;
246 return 0;
250 static BlockBackend *img_open_opts(const char *optstr,
251 QemuOpts *opts, int flags, bool writethrough,
252 bool quiet)
254 QDict *options;
255 Error *local_err = NULL;
256 BlockBackend *blk;
257 options = qemu_opts_to_qdict(opts, NULL);
258 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
259 if (!blk) {
260 error_reportf_err(local_err, "Could not open '%s': ", optstr);
261 return NULL;
263 blk_set_enable_write_cache(blk, !writethrough);
265 if (img_open_password(blk, optstr, flags, quiet) < 0) {
266 blk_unref(blk);
267 return NULL;
269 return blk;
272 static BlockBackend *img_open_file(const char *filename,
273 const char *fmt, int flags,
274 bool writethrough, bool quiet)
276 BlockBackend *blk;
277 Error *local_err = NULL;
278 QDict *options = NULL;
280 if (fmt) {
281 options = qdict_new();
282 qdict_put(options, "driver", qstring_from_str(fmt));
285 blk = blk_new_open(filename, NULL, options, flags, &local_err);
286 if (!blk) {
287 error_reportf_err(local_err, "Could not open '%s': ", filename);
288 return NULL;
290 blk_set_enable_write_cache(blk, !writethrough);
292 if (img_open_password(blk, filename, flags, quiet) < 0) {
293 blk_unref(blk);
294 return NULL;
296 return blk;
300 static BlockBackend *img_open(bool image_opts,
301 const char *filename,
302 const char *fmt, int flags, bool writethrough,
303 bool quiet)
305 BlockBackend *blk;
306 if (image_opts) {
307 QemuOpts *opts;
308 if (fmt) {
309 error_report("--image-opts and --format are mutually exclusive");
310 return NULL;
312 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
313 filename, true);
314 if (!opts) {
315 return NULL;
317 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
318 } else {
319 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
321 return blk;
325 static int add_old_style_options(const char *fmt, QemuOpts *opts,
326 const char *base_filename,
327 const char *base_fmt)
329 Error *err = NULL;
331 if (base_filename) {
332 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
333 if (err) {
334 error_report("Backing file not supported for file format '%s'",
335 fmt);
336 error_free(err);
337 return -1;
340 if (base_fmt) {
341 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
342 if (err) {
343 error_report("Backing file format not supported for file "
344 "format '%s'", fmt);
345 error_free(err);
346 return -1;
349 return 0;
352 static int img_create(int argc, char **argv)
354 int c;
355 uint64_t img_size = -1;
356 const char *fmt = "raw";
357 const char *base_fmt = NULL;
358 const char *filename;
359 const char *base_filename = NULL;
360 char *options = NULL;
361 Error *local_err = NULL;
362 bool quiet = false;
364 for(;;) {
365 static const struct option long_options[] = {
366 {"help", no_argument, 0, 'h'},
367 {"object", required_argument, 0, OPTION_OBJECT},
368 {0, 0, 0, 0}
370 c = getopt_long(argc, argv, "F:b:f:he6o:q",
371 long_options, NULL);
372 if (c == -1) {
373 break;
375 switch(c) {
376 case '?':
377 case 'h':
378 help();
379 break;
380 case 'F':
381 base_fmt = optarg;
382 break;
383 case 'b':
384 base_filename = optarg;
385 break;
386 case 'f':
387 fmt = optarg;
388 break;
389 case 'e':
390 error_report("option -e is deprecated, please use \'-o "
391 "encryption\' instead!");
392 goto fail;
393 case '6':
394 error_report("option -6 is deprecated, please use \'-o "
395 "compat6\' instead!");
396 goto fail;
397 case 'o':
398 if (!is_valid_option_list(optarg)) {
399 error_report("Invalid option list: %s", optarg);
400 goto fail;
402 if (!options) {
403 options = g_strdup(optarg);
404 } else {
405 char *old_options = options;
406 options = g_strdup_printf("%s,%s", options, optarg);
407 g_free(old_options);
409 break;
410 case 'q':
411 quiet = true;
412 break;
413 case OPTION_OBJECT: {
414 QemuOpts *opts;
415 opts = qemu_opts_parse_noisily(&qemu_object_opts,
416 optarg, true);
417 if (!opts) {
418 goto fail;
420 } break;
424 /* Get the filename */
425 filename = (optind < argc) ? argv[optind] : NULL;
426 if (options && has_help_option(options)) {
427 g_free(options);
428 return print_block_option_help(filename, fmt);
431 if (optind >= argc) {
432 error_exit("Expecting image file name");
434 optind++;
436 if (qemu_opts_foreach(&qemu_object_opts,
437 user_creatable_add_opts_foreach,
438 NULL, &local_err)) {
439 error_report_err(local_err);
440 goto fail;
443 /* Get image size, if specified */
444 if (optind < argc) {
445 int64_t sval;
446 char *end;
447 sval = qemu_strtosz_suffix(argv[optind++], &end,
448 QEMU_STRTOSZ_DEFSUFFIX_B);
449 if (sval < 0 || *end) {
450 if (sval == -ERANGE) {
451 error_report("Image size must be less than 8 EiB!");
452 } else {
453 error_report("Invalid image size specified! You may use k, M, "
454 "G, T, P or E suffixes for ");
455 error_report("kilobytes, megabytes, gigabytes, terabytes, "
456 "petabytes and exabytes.");
458 goto fail;
460 img_size = (uint64_t)sval;
462 if (optind != argc) {
463 error_exit("Unexpected argument: %s", argv[optind]);
466 bdrv_img_create(filename, fmt, base_filename, base_fmt,
467 options, img_size, 0, &local_err, quiet);
468 if (local_err) {
469 error_reportf_err(local_err, "%s: ", filename);
470 goto fail;
473 g_free(options);
474 return 0;
476 fail:
477 g_free(options);
478 return 1;
481 static void dump_json_image_check(ImageCheck *check, bool quiet)
483 Error *local_err = NULL;
484 QString *str;
485 QmpOutputVisitor *ov = qmp_output_visitor_new();
486 QObject *obj;
487 visit_type_ImageCheck(qmp_output_get_visitor(ov), NULL, &check,
488 &local_err);
489 obj = qmp_output_get_qobject(ov);
490 str = qobject_to_json_pretty(obj);
491 assert(str != NULL);
492 qprintf(quiet, "%s\n", qstring_get_str(str));
493 qobject_decref(obj);
494 qmp_output_visitor_cleanup(ov);
495 QDECREF(str);
498 static void dump_human_image_check(ImageCheck *check, bool quiet)
500 if (!(check->corruptions || check->leaks || check->check_errors)) {
501 qprintf(quiet, "No errors were found on the image.\n");
502 } else {
503 if (check->corruptions) {
504 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
505 "Data may be corrupted, or further writes to the image "
506 "may corrupt it.\n",
507 check->corruptions);
510 if (check->leaks) {
511 qprintf(quiet,
512 "\n%" PRId64 " leaked clusters were found on the image.\n"
513 "This means waste of disk space, but no harm to data.\n",
514 check->leaks);
517 if (check->check_errors) {
518 qprintf(quiet,
519 "\n%" PRId64
520 " internal errors have occurred during the check.\n",
521 check->check_errors);
525 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
526 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
527 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
528 check->allocated_clusters, check->total_clusters,
529 check->allocated_clusters * 100.0 / check->total_clusters,
530 check->fragmented_clusters * 100.0 / check->allocated_clusters,
531 check->compressed_clusters * 100.0 /
532 check->allocated_clusters);
535 if (check->image_end_offset) {
536 qprintf(quiet,
537 "Image end offset: %" PRId64 "\n", check->image_end_offset);
541 static int collect_image_check(BlockDriverState *bs,
542 ImageCheck *check,
543 const char *filename,
544 const char *fmt,
545 int fix)
547 int ret;
548 BdrvCheckResult result;
550 ret = bdrv_check(bs, &result, fix);
551 if (ret < 0) {
552 return ret;
555 check->filename = g_strdup(filename);
556 check->format = g_strdup(bdrv_get_format_name(bs));
557 check->check_errors = result.check_errors;
558 check->corruptions = result.corruptions;
559 check->has_corruptions = result.corruptions != 0;
560 check->leaks = result.leaks;
561 check->has_leaks = result.leaks != 0;
562 check->corruptions_fixed = result.corruptions_fixed;
563 check->has_corruptions_fixed = result.corruptions != 0;
564 check->leaks_fixed = result.leaks_fixed;
565 check->has_leaks_fixed = result.leaks != 0;
566 check->image_end_offset = result.image_end_offset;
567 check->has_image_end_offset = result.image_end_offset != 0;
568 check->total_clusters = result.bfi.total_clusters;
569 check->has_total_clusters = result.bfi.total_clusters != 0;
570 check->allocated_clusters = result.bfi.allocated_clusters;
571 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
572 check->fragmented_clusters = result.bfi.fragmented_clusters;
573 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
574 check->compressed_clusters = result.bfi.compressed_clusters;
575 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
577 return 0;
581 * Checks an image for consistency. Exit codes:
583 * 0 - Check completed, image is good
584 * 1 - Check not completed because of internal errors
585 * 2 - Check completed, image is corrupted
586 * 3 - Check completed, image has leaked clusters, but is good otherwise
587 * 63 - Checks are not supported by the image format
589 static int img_check(int argc, char **argv)
591 int c, ret;
592 OutputFormat output_format = OFORMAT_HUMAN;
593 const char *filename, *fmt, *output, *cache;
594 BlockBackend *blk;
595 BlockDriverState *bs;
596 int fix = 0;
597 int flags = BDRV_O_CHECK;
598 bool writethrough;
599 ImageCheck *check;
600 bool quiet = false;
601 Error *local_err = NULL;
602 bool image_opts = false;
604 fmt = NULL;
605 output = NULL;
606 cache = BDRV_DEFAULT_CACHE;
608 for(;;) {
609 int option_index = 0;
610 static const struct option long_options[] = {
611 {"help", no_argument, 0, 'h'},
612 {"format", required_argument, 0, 'f'},
613 {"repair", required_argument, 0, 'r'},
614 {"output", required_argument, 0, OPTION_OUTPUT},
615 {"object", required_argument, 0, OPTION_OBJECT},
616 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
617 {0, 0, 0, 0}
619 c = getopt_long(argc, argv, "hf:r:T:q",
620 long_options, &option_index);
621 if (c == -1) {
622 break;
624 switch(c) {
625 case '?':
626 case 'h':
627 help();
628 break;
629 case 'f':
630 fmt = optarg;
631 break;
632 case 'r':
633 flags |= BDRV_O_RDWR;
635 if (!strcmp(optarg, "leaks")) {
636 fix = BDRV_FIX_LEAKS;
637 } else if (!strcmp(optarg, "all")) {
638 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
639 } else {
640 error_exit("Unknown option value for -r "
641 "(expecting 'leaks' or 'all'): %s", optarg);
643 break;
644 case OPTION_OUTPUT:
645 output = optarg;
646 break;
647 case 'T':
648 cache = optarg;
649 break;
650 case 'q':
651 quiet = true;
652 break;
653 case OPTION_OBJECT: {
654 QemuOpts *opts;
655 opts = qemu_opts_parse_noisily(&qemu_object_opts,
656 optarg, true);
657 if (!opts) {
658 return 1;
660 } break;
661 case OPTION_IMAGE_OPTS:
662 image_opts = true;
663 break;
666 if (optind != argc - 1) {
667 error_exit("Expecting one image file name");
669 filename = argv[optind++];
671 if (output && !strcmp(output, "json")) {
672 output_format = OFORMAT_JSON;
673 } else if (output && !strcmp(output, "human")) {
674 output_format = OFORMAT_HUMAN;
675 } else if (output) {
676 error_report("--output must be used with human or json as argument.");
677 return 1;
680 if (qemu_opts_foreach(&qemu_object_opts,
681 user_creatable_add_opts_foreach,
682 NULL, &local_err)) {
683 error_report_err(local_err);
684 return 1;
687 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
688 if (ret < 0) {
689 error_report("Invalid source cache option: %s", cache);
690 return 1;
693 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
694 if (!blk) {
695 return 1;
697 bs = blk_bs(blk);
699 check = g_new0(ImageCheck, 1);
700 ret = collect_image_check(bs, check, filename, fmt, fix);
702 if (ret == -ENOTSUP) {
703 error_report("This image format does not support checks");
704 ret = 63;
705 goto fail;
708 if (check->corruptions_fixed || check->leaks_fixed) {
709 int corruptions_fixed, leaks_fixed;
711 leaks_fixed = check->leaks_fixed;
712 corruptions_fixed = check->corruptions_fixed;
714 if (output_format == OFORMAT_HUMAN) {
715 qprintf(quiet,
716 "The following inconsistencies were found and repaired:\n\n"
717 " %" PRId64 " leaked clusters\n"
718 " %" PRId64 " corruptions\n\n"
719 "Double checking the fixed image now...\n",
720 check->leaks_fixed,
721 check->corruptions_fixed);
724 ret = collect_image_check(bs, check, filename, fmt, 0);
726 check->leaks_fixed = leaks_fixed;
727 check->corruptions_fixed = corruptions_fixed;
730 if (!ret) {
731 switch (output_format) {
732 case OFORMAT_HUMAN:
733 dump_human_image_check(check, quiet);
734 break;
735 case OFORMAT_JSON:
736 dump_json_image_check(check, quiet);
737 break;
741 if (ret || check->check_errors) {
742 if (ret) {
743 error_report("Check failed: %s", strerror(-ret));
744 } else {
745 error_report("Check failed");
747 ret = 1;
748 goto fail;
751 if (check->corruptions) {
752 ret = 2;
753 } else if (check->leaks) {
754 ret = 3;
755 } else {
756 ret = 0;
759 fail:
760 qapi_free_ImageCheck(check);
761 blk_unref(blk);
762 return ret;
765 typedef struct CommonBlockJobCBInfo {
766 BlockDriverState *bs;
767 Error **errp;
768 } CommonBlockJobCBInfo;
770 static void common_block_job_cb(void *opaque, int ret)
772 CommonBlockJobCBInfo *cbi = opaque;
774 if (ret < 0) {
775 error_setg_errno(cbi->errp, -ret, "Block job failed");
779 static void run_block_job(BlockJob *job, Error **errp)
781 AioContext *aio_context = bdrv_get_aio_context(job->bs);
783 do {
784 aio_poll(aio_context, true);
785 qemu_progress_print(job->len ?
786 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
787 } while (!job->ready);
789 block_job_complete_sync(job, errp);
791 /* A block job may finish instantaneously without publishing any progress,
792 * so just signal completion here */
793 qemu_progress_print(100.f, 0);
796 static int img_commit(int argc, char **argv)
798 int c, ret, flags;
799 const char *filename, *fmt, *cache, *base;
800 BlockBackend *blk;
801 BlockDriverState *bs, *base_bs;
802 bool progress = false, quiet = false, drop = false;
803 bool writethrough;
804 Error *local_err = NULL;
805 CommonBlockJobCBInfo cbi;
806 bool image_opts = false;
808 fmt = NULL;
809 cache = BDRV_DEFAULT_CACHE;
810 base = NULL;
811 for(;;) {
812 static const struct option long_options[] = {
813 {"help", no_argument, 0, 'h'},
814 {"object", required_argument, 0, OPTION_OBJECT},
815 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
816 {0, 0, 0, 0}
818 c = getopt_long(argc, argv, "f:ht:b:dpq",
819 long_options, NULL);
820 if (c == -1) {
821 break;
823 switch(c) {
824 case '?':
825 case 'h':
826 help();
827 break;
828 case 'f':
829 fmt = optarg;
830 break;
831 case 't':
832 cache = optarg;
833 break;
834 case 'b':
835 base = optarg;
836 /* -b implies -d */
837 drop = true;
838 break;
839 case 'd':
840 drop = true;
841 break;
842 case 'p':
843 progress = true;
844 break;
845 case 'q':
846 quiet = true;
847 break;
848 case OPTION_OBJECT: {
849 QemuOpts *opts;
850 opts = qemu_opts_parse_noisily(&qemu_object_opts,
851 optarg, true);
852 if (!opts) {
853 return 1;
855 } break;
856 case OPTION_IMAGE_OPTS:
857 image_opts = true;
858 break;
862 /* Progress is not shown in Quiet mode */
863 if (quiet) {
864 progress = false;
867 if (optind != argc - 1) {
868 error_exit("Expecting one image file name");
870 filename = argv[optind++];
872 if (qemu_opts_foreach(&qemu_object_opts,
873 user_creatable_add_opts_foreach,
874 NULL, &local_err)) {
875 error_report_err(local_err);
876 return 1;
879 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
880 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
881 if (ret < 0) {
882 error_report("Invalid cache option: %s", cache);
883 return 1;
886 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
887 if (!blk) {
888 return 1;
890 bs = blk_bs(blk);
892 qemu_progress_init(progress, 1.f);
893 qemu_progress_print(0.f, 100);
895 if (base) {
896 base_bs = bdrv_find_backing_image(bs, base);
897 if (!base_bs) {
898 error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
899 goto done;
901 } else {
902 /* This is different from QMP, which by default uses the deepest file in
903 * the backing chain (i.e., the very base); however, the traditional
904 * behavior of qemu-img commit is using the immediate backing file. */
905 base_bs = backing_bs(bs);
906 if (!base_bs) {
907 error_setg(&local_err, "Image does not have a backing file");
908 goto done;
912 cbi = (CommonBlockJobCBInfo){
913 .errp = &local_err,
914 .bs = bs,
917 commit_active_start(bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
918 common_block_job_cb, &cbi, &local_err);
919 if (local_err) {
920 goto done;
923 /* When the block job completes, the BlockBackend reference will point to
924 * the old backing file. In order to avoid that the top image is already
925 * deleted, so we can still empty it afterwards, increment the reference
926 * counter here preemptively. */
927 if (!drop) {
928 bdrv_ref(bs);
931 run_block_job(bs->job, &local_err);
932 if (local_err) {
933 goto unref_backing;
936 if (!drop && bs->drv->bdrv_make_empty) {
937 ret = bs->drv->bdrv_make_empty(bs);
938 if (ret) {
939 error_setg_errno(&local_err, -ret, "Could not empty %s",
940 filename);
941 goto unref_backing;
945 unref_backing:
946 if (!drop) {
947 bdrv_unref(bs);
950 done:
951 qemu_progress_end();
953 blk_unref(blk);
955 if (local_err) {
956 error_report_err(local_err);
957 return 1;
960 qprintf(quiet, "Image committed.\n");
961 return 0;
965 * Returns true iff the first sector pointed to by 'buf' contains at least
966 * a non-NUL byte.
968 * 'pnum' is set to the number of sectors (including and immediately following
969 * the first one) that are known to be in the same allocated/unallocated state.
971 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
973 bool is_zero;
974 int i;
976 if (n <= 0) {
977 *pnum = 0;
978 return 0;
980 is_zero = buffer_is_zero(buf, 512);
981 for(i = 1; i < n; i++) {
982 buf += 512;
983 if (is_zero != buffer_is_zero(buf, 512)) {
984 break;
987 *pnum = i;
988 return !is_zero;
992 * Like is_allocated_sectors, but if the buffer starts with a used sector,
993 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
994 * breaking up write requests for only small sparse areas.
996 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
997 int min)
999 int ret;
1000 int num_checked, num_used;
1002 if (n < min) {
1003 min = n;
1006 ret = is_allocated_sectors(buf, n, pnum);
1007 if (!ret) {
1008 return ret;
1011 num_used = *pnum;
1012 buf += BDRV_SECTOR_SIZE * *pnum;
1013 n -= *pnum;
1014 num_checked = num_used;
1016 while (n > 0) {
1017 ret = is_allocated_sectors(buf, n, pnum);
1019 buf += BDRV_SECTOR_SIZE * *pnum;
1020 n -= *pnum;
1021 num_checked += *pnum;
1022 if (ret) {
1023 num_used = num_checked;
1024 } else if (*pnum >= min) {
1025 break;
1029 *pnum = num_used;
1030 return 1;
1034 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1035 * buffers matches, non-zero otherwise.
1037 * pnum is set to the number of sectors (including and immediately following
1038 * the first one) that are known to have the same comparison result
1040 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1041 int *pnum)
1043 bool res;
1044 int i;
1046 if (n <= 0) {
1047 *pnum = 0;
1048 return 0;
1051 res = !!memcmp(buf1, buf2, 512);
1052 for(i = 1; i < n; i++) {
1053 buf1 += 512;
1054 buf2 += 512;
1056 if (!!memcmp(buf1, buf2, 512) != res) {
1057 break;
1061 *pnum = i;
1062 return res;
1065 #define IO_BUF_SIZE (2 * 1024 * 1024)
1067 static int64_t sectors_to_bytes(int64_t sectors)
1069 return sectors << BDRV_SECTOR_BITS;
1072 static int64_t sectors_to_process(int64_t total, int64_t from)
1074 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1078 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1080 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1081 * data and negative value on error.
1083 * @param blk: BlockBackend for the image
1084 * @param sect_num: Number of first sector to check
1085 * @param sect_count: Number of sectors to check
1086 * @param filename: Name of disk file we are checking (logging purpose)
1087 * @param buffer: Allocated buffer for storing read data
1088 * @param quiet: Flag for quiet mode
1090 static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1091 int sect_count, const char *filename,
1092 uint8_t *buffer, bool quiet)
1094 int pnum, ret = 0;
1095 ret = blk_read(blk, sect_num, buffer, sect_count);
1096 if (ret < 0) {
1097 error_report("Error while reading offset %" PRId64 " of %s: %s",
1098 sectors_to_bytes(sect_num), filename, strerror(-ret));
1099 return ret;
1101 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1102 if (ret || pnum != sect_count) {
1103 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1104 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1105 return 1;
1108 return 0;
1112 * Compares two images. Exit codes:
1114 * 0 - Images are identical
1115 * 1 - Images differ
1116 * >1 - Error occurred
1118 static int img_compare(int argc, char **argv)
1120 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1121 BlockBackend *blk1, *blk2;
1122 BlockDriverState *bs1, *bs2;
1123 int64_t total_sectors1, total_sectors2;
1124 uint8_t *buf1 = NULL, *buf2 = NULL;
1125 int pnum1, pnum2;
1126 int allocated1, allocated2;
1127 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1128 bool progress = false, quiet = false, strict = false;
1129 int flags;
1130 bool writethrough;
1131 int64_t total_sectors;
1132 int64_t sector_num = 0;
1133 int64_t nb_sectors;
1134 int c, pnum;
1135 uint64_t progress_base;
1136 Error *local_err = NULL;
1137 bool image_opts = false;
1139 cache = BDRV_DEFAULT_CACHE;
1140 for (;;) {
1141 static const struct option long_options[] = {
1142 {"help", no_argument, 0, 'h'},
1143 {"object", required_argument, 0, OPTION_OBJECT},
1144 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1145 {0, 0, 0, 0}
1147 c = getopt_long(argc, argv, "hf:F:T:pqs",
1148 long_options, NULL);
1149 if (c == -1) {
1150 break;
1152 switch (c) {
1153 case '?':
1154 case 'h':
1155 help();
1156 break;
1157 case 'f':
1158 fmt1 = optarg;
1159 break;
1160 case 'F':
1161 fmt2 = optarg;
1162 break;
1163 case 'T':
1164 cache = optarg;
1165 break;
1166 case 'p':
1167 progress = true;
1168 break;
1169 case 'q':
1170 quiet = true;
1171 break;
1172 case 's':
1173 strict = true;
1174 break;
1175 case OPTION_OBJECT: {
1176 QemuOpts *opts;
1177 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1178 optarg, true);
1179 if (!opts) {
1180 ret = 2;
1181 goto out4;
1183 } break;
1184 case OPTION_IMAGE_OPTS:
1185 image_opts = true;
1186 break;
1190 /* Progress is not shown in Quiet mode */
1191 if (quiet) {
1192 progress = false;
1196 if (optind != argc - 2) {
1197 error_exit("Expecting two image file names");
1199 filename1 = argv[optind++];
1200 filename2 = argv[optind++];
1202 if (qemu_opts_foreach(&qemu_object_opts,
1203 user_creatable_add_opts_foreach,
1204 NULL, &local_err)) {
1205 error_report_err(local_err);
1206 ret = 2;
1207 goto out4;
1210 /* Initialize before goto out */
1211 qemu_progress_init(progress, 2.0);
1213 flags = 0;
1214 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1215 if (ret < 0) {
1216 error_report("Invalid source cache option: %s", cache);
1217 ret = 2;
1218 goto out3;
1221 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1222 if (!blk1) {
1223 ret = 2;
1224 goto out3;
1227 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1228 if (!blk2) {
1229 ret = 2;
1230 goto out2;
1232 bs1 = blk_bs(blk1);
1233 bs2 = blk_bs(blk2);
1235 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1236 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1237 total_sectors1 = blk_nb_sectors(blk1);
1238 if (total_sectors1 < 0) {
1239 error_report("Can't get size of %s: %s",
1240 filename1, strerror(-total_sectors1));
1241 ret = 4;
1242 goto out;
1244 total_sectors2 = blk_nb_sectors(blk2);
1245 if (total_sectors2 < 0) {
1246 error_report("Can't get size of %s: %s",
1247 filename2, strerror(-total_sectors2));
1248 ret = 4;
1249 goto out;
1251 total_sectors = MIN(total_sectors1, total_sectors2);
1252 progress_base = MAX(total_sectors1, total_sectors2);
1254 qemu_progress_print(0, 100);
1256 if (strict && total_sectors1 != total_sectors2) {
1257 ret = 1;
1258 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1259 goto out;
1262 for (;;) {
1263 int64_t status1, status2;
1264 BlockDriverState *file;
1266 nb_sectors = sectors_to_process(total_sectors, sector_num);
1267 if (nb_sectors <= 0) {
1268 break;
1270 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1271 total_sectors1 - sector_num,
1272 &pnum1, &file);
1273 if (status1 < 0) {
1274 ret = 3;
1275 error_report("Sector allocation test failed for %s", filename1);
1276 goto out;
1278 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1280 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1281 total_sectors2 - sector_num,
1282 &pnum2, &file);
1283 if (status2 < 0) {
1284 ret = 3;
1285 error_report("Sector allocation test failed for %s", filename2);
1286 goto out;
1288 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1289 if (pnum1) {
1290 nb_sectors = MIN(nb_sectors, pnum1);
1292 if (pnum2) {
1293 nb_sectors = MIN(nb_sectors, pnum2);
1296 if (strict) {
1297 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1298 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1299 ret = 1;
1300 qprintf(quiet, "Strict mode: Offset %" PRId64
1301 " block status mismatch!\n",
1302 sectors_to_bytes(sector_num));
1303 goto out;
1306 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1307 nb_sectors = MIN(pnum1, pnum2);
1308 } else if (allocated1 == allocated2) {
1309 if (allocated1) {
1310 ret = blk_read(blk1, sector_num, buf1, nb_sectors);
1311 if (ret < 0) {
1312 error_report("Error while reading offset %" PRId64 " of %s:"
1313 " %s", sectors_to_bytes(sector_num), filename1,
1314 strerror(-ret));
1315 ret = 4;
1316 goto out;
1318 ret = blk_read(blk2, sector_num, buf2, nb_sectors);
1319 if (ret < 0) {
1320 error_report("Error while reading offset %" PRId64
1321 " of %s: %s", sectors_to_bytes(sector_num),
1322 filename2, strerror(-ret));
1323 ret = 4;
1324 goto out;
1326 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1327 if (ret || pnum != nb_sectors) {
1328 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1329 sectors_to_bytes(
1330 ret ? sector_num : sector_num + pnum));
1331 ret = 1;
1332 goto out;
1335 } else {
1337 if (allocated1) {
1338 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1339 filename1, buf1, quiet);
1340 } else {
1341 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1342 filename2, buf1, quiet);
1344 if (ret) {
1345 if (ret < 0) {
1346 error_report("Error while reading offset %" PRId64 ": %s",
1347 sectors_to_bytes(sector_num), strerror(-ret));
1348 ret = 4;
1350 goto out;
1353 sector_num += nb_sectors;
1354 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1357 if (total_sectors1 != total_sectors2) {
1358 BlockBackend *blk_over;
1359 int64_t total_sectors_over;
1360 const char *filename_over;
1362 qprintf(quiet, "Warning: Image size mismatch!\n");
1363 if (total_sectors1 > total_sectors2) {
1364 total_sectors_over = total_sectors1;
1365 blk_over = blk1;
1366 filename_over = filename1;
1367 } else {
1368 total_sectors_over = total_sectors2;
1369 blk_over = blk2;
1370 filename_over = filename2;
1373 for (;;) {
1374 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1375 if (nb_sectors <= 0) {
1376 break;
1378 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1379 nb_sectors, &pnum);
1380 if (ret < 0) {
1381 ret = 3;
1382 error_report("Sector allocation test failed for %s",
1383 filename_over);
1384 goto out;
1387 nb_sectors = pnum;
1388 if (ret) {
1389 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1390 filename_over, buf1, quiet);
1391 if (ret) {
1392 if (ret < 0) {
1393 error_report("Error while reading offset %" PRId64
1394 " of %s: %s", sectors_to_bytes(sector_num),
1395 filename_over, strerror(-ret));
1396 ret = 4;
1398 goto out;
1401 sector_num += nb_sectors;
1402 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1406 qprintf(quiet, "Images are identical.\n");
1407 ret = 0;
1409 out:
1410 qemu_vfree(buf1);
1411 qemu_vfree(buf2);
1412 blk_unref(blk2);
1413 out2:
1414 blk_unref(blk1);
1415 out3:
1416 qemu_progress_end();
1417 out4:
1418 return ret;
1421 enum ImgConvertBlockStatus {
1422 BLK_DATA,
1423 BLK_ZERO,
1424 BLK_BACKING_FILE,
1427 typedef struct ImgConvertState {
1428 BlockBackend **src;
1429 int64_t *src_sectors;
1430 int src_cur, src_num;
1431 int64_t src_cur_offset;
1432 int64_t total_sectors;
1433 int64_t allocated_sectors;
1434 enum ImgConvertBlockStatus status;
1435 int64_t sector_next_status;
1436 BlockBackend *target;
1437 bool has_zero_init;
1438 bool compressed;
1439 bool target_has_backing;
1440 int min_sparse;
1441 size_t cluster_sectors;
1442 size_t buf_sectors;
1443 } ImgConvertState;
1445 static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1447 assert(sector_num >= s->src_cur_offset);
1448 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1449 s->src_cur_offset += s->src_sectors[s->src_cur];
1450 s->src_cur++;
1451 assert(s->src_cur < s->src_num);
1455 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1457 int64_t ret;
1458 int n;
1460 convert_select_part(s, sector_num);
1462 assert(s->total_sectors > sector_num);
1463 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1465 if (s->sector_next_status <= sector_num) {
1466 BlockDriverState *file;
1467 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1468 sector_num - s->src_cur_offset,
1469 n, &n, &file);
1470 if (ret < 0) {
1471 return ret;
1474 if (ret & BDRV_BLOCK_ZERO) {
1475 s->status = BLK_ZERO;
1476 } else if (ret & BDRV_BLOCK_DATA) {
1477 s->status = BLK_DATA;
1478 } else if (!s->target_has_backing) {
1479 /* Without a target backing file we must copy over the contents of
1480 * the backing file as well. */
1481 /* TODO Check block status of the backing file chain to avoid
1482 * needlessly reading zeroes and limiting the iteration to the
1483 * buffer size */
1484 s->status = BLK_DATA;
1485 } else {
1486 s->status = BLK_BACKING_FILE;
1489 s->sector_next_status = sector_num + n;
1492 n = MIN(n, s->sector_next_status - sector_num);
1493 if (s->status == BLK_DATA) {
1494 n = MIN(n, s->buf_sectors);
1497 /* We need to write complete clusters for compressed images, so if an
1498 * unallocated area is shorter than that, we must consider the whole
1499 * cluster allocated. */
1500 if (s->compressed) {
1501 if (n < s->cluster_sectors) {
1502 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1503 s->status = BLK_DATA;
1504 } else {
1505 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1509 return n;
1512 static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1513 uint8_t *buf)
1515 int n;
1516 int ret;
1518 assert(nb_sectors <= s->buf_sectors);
1519 while (nb_sectors > 0) {
1520 BlockBackend *blk;
1521 int64_t bs_sectors;
1523 /* In the case of compression with multiple source files, we can get a
1524 * nb_sectors that spreads into the next part. So we must be able to
1525 * read across multiple BDSes for one convert_read() call. */
1526 convert_select_part(s, sector_num);
1527 blk = s->src[s->src_cur];
1528 bs_sectors = s->src_sectors[s->src_cur];
1530 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1531 ret = blk_read(blk, sector_num - s->src_cur_offset, buf, n);
1532 if (ret < 0) {
1533 return ret;
1536 sector_num += n;
1537 nb_sectors -= n;
1538 buf += n * BDRV_SECTOR_SIZE;
1541 return 0;
1544 static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1545 const uint8_t *buf)
1547 int ret;
1549 while (nb_sectors > 0) {
1550 int n = nb_sectors;
1552 switch (s->status) {
1553 case BLK_BACKING_FILE:
1554 /* If we have a backing file, leave clusters unallocated that are
1555 * unallocated in the source image, so that the backing file is
1556 * visible at the respective offset. */
1557 assert(s->target_has_backing);
1558 break;
1560 case BLK_DATA:
1561 /* We must always write compressed clusters as a whole, so don't
1562 * try to find zeroed parts in the buffer. We can only save the
1563 * write if the buffer is completely zeroed and we're allowed to
1564 * keep the target sparse. */
1565 if (s->compressed) {
1566 if (s->has_zero_init && s->min_sparse &&
1567 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1569 assert(!s->target_has_backing);
1570 break;
1573 ret = blk_write_compressed(s->target, sector_num, buf, n);
1574 if (ret < 0) {
1575 return ret;
1577 break;
1580 /* If there is real non-zero data or we're told to keep the target
1581 * fully allocated (-S 0), we must write it. Otherwise we can treat
1582 * it as zero sectors. */
1583 if (!s->min_sparse ||
1584 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1586 ret = blk_write(s->target, sector_num, buf, n);
1587 if (ret < 0) {
1588 return ret;
1590 break;
1592 /* fall-through */
1594 case BLK_ZERO:
1595 if (s->has_zero_init) {
1596 break;
1598 ret = blk_write_zeroes(s->target, sector_num, n, 0);
1599 if (ret < 0) {
1600 return ret;
1602 break;
1605 sector_num += n;
1606 nb_sectors -= n;
1607 buf += n * BDRV_SECTOR_SIZE;
1610 return 0;
1613 static int convert_do_copy(ImgConvertState *s)
1615 uint8_t *buf = NULL;
1616 int64_t sector_num, allocated_done;
1617 int ret;
1618 int n;
1620 /* Check whether we have zero initialisation or can get it efficiently */
1621 s->has_zero_init = s->min_sparse && !s->target_has_backing
1622 ? bdrv_has_zero_init(blk_bs(s->target))
1623 : false;
1625 if (!s->has_zero_init && !s->target_has_backing &&
1626 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1628 ret = bdrv_make_zero(blk_bs(s->target), BDRV_REQ_MAY_UNMAP);
1629 if (ret == 0) {
1630 s->has_zero_init = true;
1634 /* Allocate buffer for copied data. For compressed images, only one cluster
1635 * can be copied at a time. */
1636 if (s->compressed) {
1637 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1638 error_report("invalid cluster size");
1639 ret = -EINVAL;
1640 goto fail;
1642 s->buf_sectors = s->cluster_sectors;
1644 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1646 /* Calculate allocated sectors for progress */
1647 s->allocated_sectors = 0;
1648 sector_num = 0;
1649 while (sector_num < s->total_sectors) {
1650 n = convert_iteration_sectors(s, sector_num);
1651 if (n < 0) {
1652 ret = n;
1653 goto fail;
1655 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1657 s->allocated_sectors += n;
1659 sector_num += n;
1662 /* Do the copy */
1663 s->src_cur = 0;
1664 s->src_cur_offset = 0;
1665 s->sector_next_status = 0;
1667 sector_num = 0;
1668 allocated_done = 0;
1670 while (sector_num < s->total_sectors) {
1671 n = convert_iteration_sectors(s, sector_num);
1672 if (n < 0) {
1673 ret = n;
1674 goto fail;
1676 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1678 allocated_done += n;
1679 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1683 if (s->status == BLK_DATA) {
1684 ret = convert_read(s, sector_num, n, buf);
1685 if (ret < 0) {
1686 error_report("error while reading sector %" PRId64
1687 ": %s", sector_num, strerror(-ret));
1688 goto fail;
1690 } else if (!s->min_sparse && s->status == BLK_ZERO) {
1691 n = MIN(n, s->buf_sectors);
1692 memset(buf, 0, n * BDRV_SECTOR_SIZE);
1693 s->status = BLK_DATA;
1696 ret = convert_write(s, sector_num, n, buf);
1697 if (ret < 0) {
1698 error_report("error while writing sector %" PRId64
1699 ": %s", sector_num, strerror(-ret));
1700 goto fail;
1703 sector_num += n;
1706 if (s->compressed) {
1707 /* signal EOF to align */
1708 ret = blk_write_compressed(s->target, 0, NULL, 0);
1709 if (ret < 0) {
1710 goto fail;
1714 ret = 0;
1715 fail:
1716 qemu_vfree(buf);
1717 return ret;
1720 static int img_convert(int argc, char **argv)
1722 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1723 int64_t ret = 0;
1724 int progress = 0, flags, src_flags;
1725 bool writethrough, src_writethrough;
1726 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1727 BlockDriver *drv, *proto_drv;
1728 BlockBackend **blk = NULL, *out_blk = NULL;
1729 BlockDriverState **bs = NULL, *out_bs = NULL;
1730 int64_t total_sectors;
1731 int64_t *bs_sectors = NULL;
1732 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1733 BlockDriverInfo bdi;
1734 QemuOpts *opts = NULL;
1735 QemuOptsList *create_opts = NULL;
1736 const char *out_baseimg_param;
1737 char *options = NULL;
1738 const char *snapshot_name = NULL;
1739 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1740 bool quiet = false;
1741 Error *local_err = NULL;
1742 QemuOpts *sn_opts = NULL;
1743 ImgConvertState state;
1744 bool image_opts = false;
1746 fmt = NULL;
1747 out_fmt = "raw";
1748 cache = "unsafe";
1749 src_cache = BDRV_DEFAULT_CACHE;
1750 out_baseimg = NULL;
1751 compress = 0;
1752 skip_create = 0;
1753 for(;;) {
1754 static const struct option long_options[] = {
1755 {"help", no_argument, 0, 'h'},
1756 {"object", required_argument, 0, OPTION_OBJECT},
1757 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1758 {0, 0, 0, 0}
1760 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1761 long_options, NULL);
1762 if (c == -1) {
1763 break;
1765 switch(c) {
1766 case '?':
1767 case 'h':
1768 help();
1769 break;
1770 case 'f':
1771 fmt = optarg;
1772 break;
1773 case 'O':
1774 out_fmt = optarg;
1775 break;
1776 case 'B':
1777 out_baseimg = optarg;
1778 break;
1779 case 'c':
1780 compress = 1;
1781 break;
1782 case 'e':
1783 error_report("option -e is deprecated, please use \'-o "
1784 "encryption\' instead!");
1785 ret = -1;
1786 goto fail_getopt;
1787 case '6':
1788 error_report("option -6 is deprecated, please use \'-o "
1789 "compat6\' instead!");
1790 ret = -1;
1791 goto fail_getopt;
1792 case 'o':
1793 if (!is_valid_option_list(optarg)) {
1794 error_report("Invalid option list: %s", optarg);
1795 ret = -1;
1796 goto fail_getopt;
1798 if (!options) {
1799 options = g_strdup(optarg);
1800 } else {
1801 char *old_options = options;
1802 options = g_strdup_printf("%s,%s", options, optarg);
1803 g_free(old_options);
1805 break;
1806 case 's':
1807 snapshot_name = optarg;
1808 break;
1809 case 'l':
1810 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1811 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1812 optarg, false);
1813 if (!sn_opts) {
1814 error_report("Failed in parsing snapshot param '%s'",
1815 optarg);
1816 ret = -1;
1817 goto fail_getopt;
1819 } else {
1820 snapshot_name = optarg;
1822 break;
1823 case 'S':
1825 int64_t sval;
1826 char *end;
1827 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1828 if (sval < 0 || *end) {
1829 error_report("Invalid minimum zero buffer size for sparse output specified");
1830 ret = -1;
1831 goto fail_getopt;
1834 min_sparse = sval / BDRV_SECTOR_SIZE;
1835 break;
1837 case 'p':
1838 progress = 1;
1839 break;
1840 case 't':
1841 cache = optarg;
1842 break;
1843 case 'T':
1844 src_cache = optarg;
1845 break;
1846 case 'q':
1847 quiet = true;
1848 break;
1849 case 'n':
1850 skip_create = 1;
1851 break;
1852 case OPTION_OBJECT:
1853 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1854 optarg, true);
1855 if (!opts) {
1856 goto fail_getopt;
1858 break;
1859 case OPTION_IMAGE_OPTS:
1860 image_opts = true;
1861 break;
1865 if (qemu_opts_foreach(&qemu_object_opts,
1866 user_creatable_add_opts_foreach,
1867 NULL, &local_err)) {
1868 error_report_err(local_err);
1869 goto fail_getopt;
1872 /* Initialize before goto out */
1873 if (quiet) {
1874 progress = 0;
1876 qemu_progress_init(progress, 1.0);
1878 bs_n = argc - optind - 1;
1879 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1881 if (options && has_help_option(options)) {
1882 ret = print_block_option_help(out_filename, out_fmt);
1883 goto out;
1886 if (bs_n < 1) {
1887 error_exit("Must specify image file name");
1891 if (bs_n > 1 && out_baseimg) {
1892 error_report("-B makes no sense when concatenating multiple input "
1893 "images");
1894 ret = -1;
1895 goto out;
1898 src_flags = 0;
1899 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1900 if (ret < 0) {
1901 error_report("Invalid source cache option: %s", src_cache);
1902 goto out;
1905 qemu_progress_print(0, 100);
1907 blk = g_new0(BlockBackend *, bs_n);
1908 bs = g_new0(BlockDriverState *, bs_n);
1909 bs_sectors = g_new(int64_t, bs_n);
1911 total_sectors = 0;
1912 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1913 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1914 fmt, src_flags, src_writethrough, quiet);
1915 if (!blk[bs_i]) {
1916 ret = -1;
1917 goto out;
1919 bs[bs_i] = blk_bs(blk[bs_i]);
1920 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1921 if (bs_sectors[bs_i] < 0) {
1922 error_report("Could not get size of %s: %s",
1923 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1924 ret = -1;
1925 goto out;
1927 total_sectors += bs_sectors[bs_i];
1930 if (sn_opts) {
1931 ret = bdrv_snapshot_load_tmp(bs[0],
1932 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1933 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1934 &local_err);
1935 } else if (snapshot_name != NULL) {
1936 if (bs_n > 1) {
1937 error_report("No support for concatenating multiple snapshot");
1938 ret = -1;
1939 goto out;
1942 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1944 if (local_err) {
1945 error_reportf_err(local_err, "Failed to load snapshot: ");
1946 ret = -1;
1947 goto out;
1950 /* Find driver and parse its options */
1951 drv = bdrv_find_format(out_fmt);
1952 if (!drv) {
1953 error_report("Unknown file format '%s'", out_fmt);
1954 ret = -1;
1955 goto out;
1958 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1959 if (!proto_drv) {
1960 error_report_err(local_err);
1961 ret = -1;
1962 goto out;
1965 if (!skip_create) {
1966 if (!drv->create_opts) {
1967 error_report("Format driver '%s' does not support image creation",
1968 drv->format_name);
1969 ret = -1;
1970 goto out;
1973 if (!proto_drv->create_opts) {
1974 error_report("Protocol driver '%s' does not support image creation",
1975 proto_drv->format_name);
1976 ret = -1;
1977 goto out;
1980 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1981 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1983 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1984 if (options) {
1985 qemu_opts_do_parse(opts, options, NULL, &local_err);
1986 if (local_err) {
1987 error_report_err(local_err);
1988 ret = -1;
1989 goto out;
1993 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
1994 &error_abort);
1995 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
1996 if (ret < 0) {
1997 goto out;
2001 /* Get backing file name if -o backing_file was used */
2002 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2003 if (out_baseimg_param) {
2004 out_baseimg = out_baseimg_param;
2007 /* Check if compression is supported */
2008 if (compress) {
2009 bool encryption =
2010 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2011 const char *preallocation =
2012 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2014 if (!drv->bdrv_write_compressed) {
2015 error_report("Compression not supported for this file format");
2016 ret = -1;
2017 goto out;
2020 if (encryption) {
2021 error_report("Compression and encryption not supported at "
2022 "the same time");
2023 ret = -1;
2024 goto out;
2027 if (preallocation
2028 && strcmp(preallocation, "off"))
2030 error_report("Compression and preallocation not supported at "
2031 "the same time");
2032 ret = -1;
2033 goto out;
2037 if (!skip_create) {
2038 /* Create the new image */
2039 ret = bdrv_create(drv, out_filename, opts, &local_err);
2040 if (ret < 0) {
2041 error_reportf_err(local_err, "%s: error while converting %s: ",
2042 out_filename, out_fmt);
2043 goto out;
2047 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2048 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2049 if (ret < 0) {
2050 error_report("Invalid cache option: %s", cache);
2051 goto out;
2054 /* XXX we should allow --image-opts to trigger use of
2055 * img_open() here, but then we have trouble with
2056 * the bdrv_create() call which takes different params.
2057 * Not critical right now, so fix can wait...
2059 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2060 if (!out_blk) {
2061 ret = -1;
2062 goto out;
2064 out_bs = blk_bs(out_blk);
2066 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
2067 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2068 * as maximum. */
2069 bufsectors = MIN(32768,
2070 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
2071 out_bs->bl.discard_alignment))
2074 if (skip_create) {
2075 int64_t output_sectors = blk_nb_sectors(out_blk);
2076 if (output_sectors < 0) {
2077 error_report("unable to get output image length: %s",
2078 strerror(-output_sectors));
2079 ret = -1;
2080 goto out;
2081 } else if (output_sectors < total_sectors) {
2082 error_report("output file is smaller than input file");
2083 ret = -1;
2084 goto out;
2088 cluster_sectors = 0;
2089 ret = bdrv_get_info(out_bs, &bdi);
2090 if (ret < 0) {
2091 if (compress) {
2092 error_report("could not get block driver info");
2093 goto out;
2095 } else {
2096 compress = compress || bdi.needs_compressed_writes;
2097 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2100 state = (ImgConvertState) {
2101 .src = blk,
2102 .src_sectors = bs_sectors,
2103 .src_num = bs_n,
2104 .total_sectors = total_sectors,
2105 .target = out_blk,
2106 .compressed = compress,
2107 .target_has_backing = (bool) out_baseimg,
2108 .min_sparse = min_sparse,
2109 .cluster_sectors = cluster_sectors,
2110 .buf_sectors = bufsectors,
2112 ret = convert_do_copy(&state);
2114 out:
2115 if (!ret) {
2116 qemu_progress_print(100, 0);
2118 qemu_progress_end();
2119 qemu_opts_del(opts);
2120 qemu_opts_free(create_opts);
2121 qemu_opts_del(sn_opts);
2122 blk_unref(out_blk);
2123 g_free(bs);
2124 if (blk) {
2125 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2126 blk_unref(blk[bs_i]);
2128 g_free(blk);
2130 g_free(bs_sectors);
2131 fail_getopt:
2132 g_free(options);
2134 if (ret) {
2135 return 1;
2137 return 0;
2141 static void dump_snapshots(BlockDriverState *bs)
2143 QEMUSnapshotInfo *sn_tab, *sn;
2144 int nb_sns, i;
2146 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2147 if (nb_sns <= 0)
2148 return;
2149 printf("Snapshot list:\n");
2150 bdrv_snapshot_dump(fprintf, stdout, NULL);
2151 printf("\n");
2152 for(i = 0; i < nb_sns; i++) {
2153 sn = &sn_tab[i];
2154 bdrv_snapshot_dump(fprintf, stdout, sn);
2155 printf("\n");
2157 g_free(sn_tab);
2160 static void dump_json_image_info_list(ImageInfoList *list)
2162 Error *local_err = NULL;
2163 QString *str;
2164 QmpOutputVisitor *ov = qmp_output_visitor_new();
2165 QObject *obj;
2166 visit_type_ImageInfoList(qmp_output_get_visitor(ov), NULL, &list,
2167 &local_err);
2168 obj = qmp_output_get_qobject(ov);
2169 str = qobject_to_json_pretty(obj);
2170 assert(str != NULL);
2171 printf("%s\n", qstring_get_str(str));
2172 qobject_decref(obj);
2173 qmp_output_visitor_cleanup(ov);
2174 QDECREF(str);
2177 static void dump_json_image_info(ImageInfo *info)
2179 Error *local_err = NULL;
2180 QString *str;
2181 QmpOutputVisitor *ov = qmp_output_visitor_new();
2182 QObject *obj;
2183 visit_type_ImageInfo(qmp_output_get_visitor(ov), NULL, &info, &local_err);
2184 obj = qmp_output_get_qobject(ov);
2185 str = qobject_to_json_pretty(obj);
2186 assert(str != NULL);
2187 printf("%s\n", qstring_get_str(str));
2188 qobject_decref(obj);
2189 qmp_output_visitor_cleanup(ov);
2190 QDECREF(str);
2193 static void dump_human_image_info_list(ImageInfoList *list)
2195 ImageInfoList *elem;
2196 bool delim = false;
2198 for (elem = list; elem; elem = elem->next) {
2199 if (delim) {
2200 printf("\n");
2202 delim = true;
2204 bdrv_image_info_dump(fprintf, stdout, elem->value);
2208 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2210 return strcmp(a, b) == 0;
2214 * Open an image file chain and return an ImageInfoList
2216 * @filename: topmost image filename
2217 * @fmt: topmost image format (may be NULL to autodetect)
2218 * @chain: true - enumerate entire backing file chain
2219 * false - only topmost image file
2221 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2222 * image file. If there was an error a message will have been printed to
2223 * stderr.
2225 static ImageInfoList *collect_image_info_list(bool image_opts,
2226 const char *filename,
2227 const char *fmt,
2228 bool chain)
2230 ImageInfoList *head = NULL;
2231 ImageInfoList **last = &head;
2232 GHashTable *filenames;
2233 Error *err = NULL;
2235 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2237 while (filename) {
2238 BlockBackend *blk;
2239 BlockDriverState *bs;
2240 ImageInfo *info;
2241 ImageInfoList *elem;
2243 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2244 error_report("Backing file '%s' creates an infinite loop.",
2245 filename);
2246 goto err;
2248 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2250 blk = img_open(image_opts, filename, fmt,
2251 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2252 if (!blk) {
2253 goto err;
2255 bs = blk_bs(blk);
2257 bdrv_query_image_info(bs, &info, &err);
2258 if (err) {
2259 error_report_err(err);
2260 blk_unref(blk);
2261 goto err;
2264 elem = g_new0(ImageInfoList, 1);
2265 elem->value = info;
2266 *last = elem;
2267 last = &elem->next;
2269 blk_unref(blk);
2271 filename = fmt = NULL;
2272 if (chain) {
2273 if (info->has_full_backing_filename) {
2274 filename = info->full_backing_filename;
2275 } else if (info->has_backing_filename) {
2276 error_report("Could not determine absolute backing filename,"
2277 " but backing filename '%s' present",
2278 info->backing_filename);
2279 goto err;
2281 if (info->has_backing_filename_format) {
2282 fmt = info->backing_filename_format;
2286 g_hash_table_destroy(filenames);
2287 return head;
2289 err:
2290 qapi_free_ImageInfoList(head);
2291 g_hash_table_destroy(filenames);
2292 return NULL;
2295 static int img_info(int argc, char **argv)
2297 int c;
2298 OutputFormat output_format = OFORMAT_HUMAN;
2299 bool chain = false;
2300 const char *filename, *fmt, *output;
2301 ImageInfoList *list;
2302 Error *local_err = NULL;
2303 bool image_opts = false;
2305 fmt = NULL;
2306 output = NULL;
2307 for(;;) {
2308 int option_index = 0;
2309 static const struct option long_options[] = {
2310 {"help", no_argument, 0, 'h'},
2311 {"format", required_argument, 0, 'f'},
2312 {"output", required_argument, 0, OPTION_OUTPUT},
2313 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2314 {"object", required_argument, 0, OPTION_OBJECT},
2315 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2316 {0, 0, 0, 0}
2318 c = getopt_long(argc, argv, "f:h",
2319 long_options, &option_index);
2320 if (c == -1) {
2321 break;
2323 switch(c) {
2324 case '?':
2325 case 'h':
2326 help();
2327 break;
2328 case 'f':
2329 fmt = optarg;
2330 break;
2331 case OPTION_OUTPUT:
2332 output = optarg;
2333 break;
2334 case OPTION_BACKING_CHAIN:
2335 chain = true;
2336 break;
2337 case OPTION_OBJECT: {
2338 QemuOpts *opts;
2339 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2340 optarg, true);
2341 if (!opts) {
2342 return 1;
2344 } break;
2345 case OPTION_IMAGE_OPTS:
2346 image_opts = true;
2347 break;
2350 if (optind != argc - 1) {
2351 error_exit("Expecting one image file name");
2353 filename = argv[optind++];
2355 if (output && !strcmp(output, "json")) {
2356 output_format = OFORMAT_JSON;
2357 } else if (output && !strcmp(output, "human")) {
2358 output_format = OFORMAT_HUMAN;
2359 } else if (output) {
2360 error_report("--output must be used with human or json as argument.");
2361 return 1;
2364 if (qemu_opts_foreach(&qemu_object_opts,
2365 user_creatable_add_opts_foreach,
2366 NULL, &local_err)) {
2367 error_report_err(local_err);
2368 return 1;
2371 list = collect_image_info_list(image_opts, filename, fmt, chain);
2372 if (!list) {
2373 return 1;
2376 switch (output_format) {
2377 case OFORMAT_HUMAN:
2378 dump_human_image_info_list(list);
2379 break;
2380 case OFORMAT_JSON:
2381 if (chain) {
2382 dump_json_image_info_list(list);
2383 } else {
2384 dump_json_image_info(list->value);
2386 break;
2389 qapi_free_ImageInfoList(list);
2390 return 0;
2393 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2394 MapEntry *next)
2396 switch (output_format) {
2397 case OFORMAT_HUMAN:
2398 if (e->data && !e->has_offset) {
2399 error_report("File contains external, encrypted or compressed clusters.");
2400 exit(1);
2402 if (e->data && !e->zero) {
2403 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2404 e->start, e->length,
2405 e->has_offset ? e->offset : 0,
2406 e->has_filename ? e->filename : "");
2408 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2409 * Modify the flags here to allow more coalescing.
2411 if (next && (!next->data || next->zero)) {
2412 next->data = false;
2413 next->zero = true;
2415 break;
2416 case OFORMAT_JSON:
2417 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2418 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2419 (e->start == 0 ? "[" : ",\n"),
2420 e->start, e->length, e->depth,
2421 e->zero ? "true" : "false",
2422 e->data ? "true" : "false");
2423 if (e->has_offset) {
2424 printf(", \"offset\": %"PRId64"", e->offset);
2426 putchar('}');
2428 if (!next) {
2429 printf("]\n");
2431 break;
2435 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2436 int nb_sectors, MapEntry *e)
2438 int64_t ret;
2439 int depth;
2440 BlockDriverState *file;
2441 bool has_offset;
2443 /* As an optimization, we could cache the current range of unallocated
2444 * clusters in each file of the chain, and avoid querying the same
2445 * range repeatedly.
2448 depth = 0;
2449 for (;;) {
2450 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2451 &file);
2452 if (ret < 0) {
2453 return ret;
2455 assert(nb_sectors);
2456 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2457 break;
2459 bs = backing_bs(bs);
2460 if (bs == NULL) {
2461 ret = 0;
2462 break;
2465 depth++;
2468 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2470 *e = (MapEntry) {
2471 .start = sector_num * BDRV_SECTOR_SIZE,
2472 .length = nb_sectors * BDRV_SECTOR_SIZE,
2473 .data = !!(ret & BDRV_BLOCK_DATA),
2474 .zero = !!(ret & BDRV_BLOCK_ZERO),
2475 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2476 .has_offset = has_offset,
2477 .depth = depth,
2478 .has_filename = file && has_offset,
2479 .filename = file && has_offset ? file->filename : NULL,
2482 return 0;
2485 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2487 if (curr->length == 0) {
2488 return false;
2490 if (curr->zero != next->zero ||
2491 curr->data != next->data ||
2492 curr->depth != next->depth ||
2493 curr->has_filename != next->has_filename ||
2494 curr->has_offset != next->has_offset) {
2495 return false;
2497 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2498 return false;
2500 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2501 return false;
2503 return true;
2506 static int img_map(int argc, char **argv)
2508 int c;
2509 OutputFormat output_format = OFORMAT_HUMAN;
2510 BlockBackend *blk;
2511 BlockDriverState *bs;
2512 const char *filename, *fmt, *output;
2513 int64_t length;
2514 MapEntry curr = { .length = 0 }, next;
2515 int ret = 0;
2516 Error *local_err = NULL;
2517 bool image_opts = false;
2519 fmt = NULL;
2520 output = NULL;
2521 for (;;) {
2522 int option_index = 0;
2523 static const struct option long_options[] = {
2524 {"help", no_argument, 0, 'h'},
2525 {"format", required_argument, 0, 'f'},
2526 {"output", required_argument, 0, OPTION_OUTPUT},
2527 {"object", required_argument, 0, OPTION_OBJECT},
2528 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2529 {0, 0, 0, 0}
2531 c = getopt_long(argc, argv, "f:h",
2532 long_options, &option_index);
2533 if (c == -1) {
2534 break;
2536 switch (c) {
2537 case '?':
2538 case 'h':
2539 help();
2540 break;
2541 case 'f':
2542 fmt = optarg;
2543 break;
2544 case OPTION_OUTPUT:
2545 output = optarg;
2546 break;
2547 case OPTION_OBJECT: {
2548 QemuOpts *opts;
2549 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2550 optarg, true);
2551 if (!opts) {
2552 return 1;
2554 } break;
2555 case OPTION_IMAGE_OPTS:
2556 image_opts = true;
2557 break;
2560 if (optind != argc - 1) {
2561 error_exit("Expecting one image file name");
2563 filename = argv[optind];
2565 if (output && !strcmp(output, "json")) {
2566 output_format = OFORMAT_JSON;
2567 } else if (output && !strcmp(output, "human")) {
2568 output_format = OFORMAT_HUMAN;
2569 } else if (output) {
2570 error_report("--output must be used with human or json as argument.");
2571 return 1;
2574 if (qemu_opts_foreach(&qemu_object_opts,
2575 user_creatable_add_opts_foreach,
2576 NULL, &local_err)) {
2577 error_report_err(local_err);
2578 return 1;
2581 blk = img_open(image_opts, filename, fmt, 0, false, false);
2582 if (!blk) {
2583 return 1;
2585 bs = blk_bs(blk);
2587 if (output_format == OFORMAT_HUMAN) {
2588 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2591 length = blk_getlength(blk);
2592 while (curr.start + curr.length < length) {
2593 int64_t nsectors_left;
2594 int64_t sector_num;
2595 int n;
2597 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2599 /* Probe up to 1 GiB at a time. */
2600 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2601 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2602 ret = get_block_status(bs, sector_num, n, &next);
2604 if (ret < 0) {
2605 error_report("Could not read file metadata: %s", strerror(-ret));
2606 goto out;
2609 if (entry_mergeable(&curr, &next)) {
2610 curr.length += next.length;
2611 continue;
2614 if (curr.length > 0) {
2615 dump_map_entry(output_format, &curr, &next);
2617 curr = next;
2620 dump_map_entry(output_format, &curr, NULL);
2622 out:
2623 blk_unref(blk);
2624 return ret < 0;
2627 #define SNAPSHOT_LIST 1
2628 #define SNAPSHOT_CREATE 2
2629 #define SNAPSHOT_APPLY 3
2630 #define SNAPSHOT_DELETE 4
2632 static int img_snapshot(int argc, char **argv)
2634 BlockBackend *blk;
2635 BlockDriverState *bs;
2636 QEMUSnapshotInfo sn;
2637 char *filename, *snapshot_name = NULL;
2638 int c, ret = 0, bdrv_oflags;
2639 int action = 0;
2640 qemu_timeval tv;
2641 bool quiet = false;
2642 Error *err = NULL;
2643 bool image_opts = false;
2645 bdrv_oflags = BDRV_O_RDWR;
2646 /* Parse commandline parameters */
2647 for(;;) {
2648 static const struct option long_options[] = {
2649 {"help", no_argument, 0, 'h'},
2650 {"object", required_argument, 0, OPTION_OBJECT},
2651 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2652 {0, 0, 0, 0}
2654 c = getopt_long(argc, argv, "la:c:d:hq",
2655 long_options, NULL);
2656 if (c == -1) {
2657 break;
2659 switch(c) {
2660 case '?':
2661 case 'h':
2662 help();
2663 return 0;
2664 case 'l':
2665 if (action) {
2666 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2667 return 0;
2669 action = SNAPSHOT_LIST;
2670 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2671 break;
2672 case 'a':
2673 if (action) {
2674 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2675 return 0;
2677 action = SNAPSHOT_APPLY;
2678 snapshot_name = optarg;
2679 break;
2680 case 'c':
2681 if (action) {
2682 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2683 return 0;
2685 action = SNAPSHOT_CREATE;
2686 snapshot_name = optarg;
2687 break;
2688 case 'd':
2689 if (action) {
2690 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2691 return 0;
2693 action = SNAPSHOT_DELETE;
2694 snapshot_name = optarg;
2695 break;
2696 case 'q':
2697 quiet = true;
2698 break;
2699 case OPTION_OBJECT: {
2700 QemuOpts *opts;
2701 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2702 optarg, true);
2703 if (!opts) {
2704 return 1;
2706 } break;
2707 case OPTION_IMAGE_OPTS:
2708 image_opts = true;
2709 break;
2713 if (optind != argc - 1) {
2714 error_exit("Expecting one image file name");
2716 filename = argv[optind++];
2718 if (qemu_opts_foreach(&qemu_object_opts,
2719 user_creatable_add_opts_foreach,
2720 NULL, &err)) {
2721 error_report_err(err);
2722 return 1;
2725 /* Open the image */
2726 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2727 if (!blk) {
2728 return 1;
2730 bs = blk_bs(blk);
2732 /* Perform the requested action */
2733 switch(action) {
2734 case SNAPSHOT_LIST:
2735 dump_snapshots(bs);
2736 break;
2738 case SNAPSHOT_CREATE:
2739 memset(&sn, 0, sizeof(sn));
2740 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2742 qemu_gettimeofday(&tv);
2743 sn.date_sec = tv.tv_sec;
2744 sn.date_nsec = tv.tv_usec * 1000;
2746 ret = bdrv_snapshot_create(bs, &sn);
2747 if (ret) {
2748 error_report("Could not create snapshot '%s': %d (%s)",
2749 snapshot_name, ret, strerror(-ret));
2751 break;
2753 case SNAPSHOT_APPLY:
2754 ret = bdrv_snapshot_goto(bs, snapshot_name);
2755 if (ret) {
2756 error_report("Could not apply snapshot '%s': %d (%s)",
2757 snapshot_name, ret, strerror(-ret));
2759 break;
2761 case SNAPSHOT_DELETE:
2762 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2763 if (err) {
2764 error_reportf_err(err, "Could not delete snapshot '%s': ",
2765 snapshot_name);
2766 ret = 1;
2768 break;
2771 /* Cleanup */
2772 blk_unref(blk);
2773 if (ret) {
2774 return 1;
2776 return 0;
2779 static int img_rebase(int argc, char **argv)
2781 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2782 uint8_t *buf_old = NULL;
2783 uint8_t *buf_new = NULL;
2784 BlockDriverState *bs = NULL;
2785 char *filename;
2786 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2787 int c, flags, src_flags, ret;
2788 bool writethrough, src_writethrough;
2789 int unsafe = 0;
2790 int progress = 0;
2791 bool quiet = false;
2792 Error *local_err = NULL;
2793 bool image_opts = false;
2795 /* Parse commandline parameters */
2796 fmt = NULL;
2797 cache = BDRV_DEFAULT_CACHE;
2798 src_cache = BDRV_DEFAULT_CACHE;
2799 out_baseimg = NULL;
2800 out_basefmt = NULL;
2801 for(;;) {
2802 static const struct option long_options[] = {
2803 {"help", no_argument, 0, 'h'},
2804 {"object", required_argument, 0, OPTION_OBJECT},
2805 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2806 {0, 0, 0, 0}
2808 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2809 long_options, NULL);
2810 if (c == -1) {
2811 break;
2813 switch(c) {
2814 case '?':
2815 case 'h':
2816 help();
2817 return 0;
2818 case 'f':
2819 fmt = optarg;
2820 break;
2821 case 'F':
2822 out_basefmt = optarg;
2823 break;
2824 case 'b':
2825 out_baseimg = optarg;
2826 break;
2827 case 'u':
2828 unsafe = 1;
2829 break;
2830 case 'p':
2831 progress = 1;
2832 break;
2833 case 't':
2834 cache = optarg;
2835 break;
2836 case 'T':
2837 src_cache = optarg;
2838 break;
2839 case 'q':
2840 quiet = true;
2841 break;
2842 case OPTION_OBJECT: {
2843 QemuOpts *opts;
2844 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2845 optarg, true);
2846 if (!opts) {
2847 return 1;
2849 } break;
2850 case OPTION_IMAGE_OPTS:
2851 image_opts = true;
2852 break;
2856 if (quiet) {
2857 progress = 0;
2860 if (optind != argc - 1) {
2861 error_exit("Expecting one image file name");
2863 if (!unsafe && !out_baseimg) {
2864 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2866 filename = argv[optind++];
2868 if (qemu_opts_foreach(&qemu_object_opts,
2869 user_creatable_add_opts_foreach,
2870 NULL, &local_err)) {
2871 error_report_err(local_err);
2872 return 1;
2875 qemu_progress_init(progress, 2.0);
2876 qemu_progress_print(0, 100);
2878 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2879 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2880 if (ret < 0) {
2881 error_report("Invalid cache option: %s", cache);
2882 goto out;
2885 src_flags = 0;
2886 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2887 if (ret < 0) {
2888 error_report("Invalid source cache option: %s", src_cache);
2889 goto out;
2892 /* The source files are opened read-only, don't care about WCE */
2893 assert((src_flags & BDRV_O_RDWR) == 0);
2894 (void) src_writethrough;
2897 * Open the images.
2899 * Ignore the old backing file for unsafe rebase in case we want to correct
2900 * the reference to a renamed or moved backing file.
2902 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2903 if (!blk) {
2904 ret = -1;
2905 goto out;
2907 bs = blk_bs(blk);
2909 if (out_basefmt != NULL) {
2910 if (bdrv_find_format(out_basefmt) == NULL) {
2911 error_report("Invalid format name: '%s'", out_basefmt);
2912 ret = -1;
2913 goto out;
2917 /* For safe rebasing we need to compare old and new backing file */
2918 if (!unsafe) {
2919 char backing_name[PATH_MAX];
2920 QDict *options = NULL;
2922 if (bs->backing_format[0] != '\0') {
2923 options = qdict_new();
2924 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2927 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2928 blk_old_backing = blk_new_open(backing_name, NULL,
2929 options, src_flags, &local_err);
2930 if (!blk_old_backing) {
2931 error_reportf_err(local_err,
2932 "Could not open old backing file '%s': ",
2933 backing_name);
2934 goto out;
2937 if (out_baseimg[0]) {
2938 if (out_basefmt) {
2939 options = qdict_new();
2940 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2941 } else {
2942 options = NULL;
2945 blk_new_backing = blk_new_open(out_baseimg, NULL,
2946 options, src_flags, &local_err);
2947 if (!blk_new_backing) {
2948 error_reportf_err(local_err,
2949 "Could not open new backing file '%s': ",
2950 out_baseimg);
2951 goto out;
2957 * Check each unallocated cluster in the COW file. If it is unallocated,
2958 * accesses go to the backing file. We must therefore compare this cluster
2959 * in the old and new backing file, and if they differ we need to copy it
2960 * from the old backing file into the COW file.
2962 * If qemu-img crashes during this step, no harm is done. The content of
2963 * the image is the same as the original one at any time.
2965 if (!unsafe) {
2966 int64_t num_sectors;
2967 int64_t old_backing_num_sectors;
2968 int64_t new_backing_num_sectors = 0;
2969 uint64_t sector;
2970 int n;
2971 float local_progress = 0;
2973 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
2974 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
2976 num_sectors = blk_nb_sectors(blk);
2977 if (num_sectors < 0) {
2978 error_report("Could not get size of '%s': %s",
2979 filename, strerror(-num_sectors));
2980 ret = -1;
2981 goto out;
2983 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2984 if (old_backing_num_sectors < 0) {
2985 char backing_name[PATH_MAX];
2987 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2988 error_report("Could not get size of '%s': %s",
2989 backing_name, strerror(-old_backing_num_sectors));
2990 ret = -1;
2991 goto out;
2993 if (blk_new_backing) {
2994 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
2995 if (new_backing_num_sectors < 0) {
2996 error_report("Could not get size of '%s': %s",
2997 out_baseimg, strerror(-new_backing_num_sectors));
2998 ret = -1;
2999 goto out;
3003 if (num_sectors != 0) {
3004 local_progress = (float)100 /
3005 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3008 for (sector = 0; sector < num_sectors; sector += n) {
3010 /* How many sectors can we handle with the next read? */
3011 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3012 n = (IO_BUF_SIZE / 512);
3013 } else {
3014 n = num_sectors - sector;
3017 /* If the cluster is allocated, we don't need to take action */
3018 ret = bdrv_is_allocated(bs, sector, n, &n);
3019 if (ret < 0) {
3020 error_report("error while reading image metadata: %s",
3021 strerror(-ret));
3022 goto out;
3024 if (ret) {
3025 continue;
3029 * Read old and new backing file and take into consideration that
3030 * backing files may be smaller than the COW image.
3032 if (sector >= old_backing_num_sectors) {
3033 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3034 } else {
3035 if (sector + n > old_backing_num_sectors) {
3036 n = old_backing_num_sectors - sector;
3039 ret = blk_read(blk_old_backing, sector, buf_old, n);
3040 if (ret < 0) {
3041 error_report("error while reading from old backing file");
3042 goto out;
3046 if (sector >= new_backing_num_sectors || !blk_new_backing) {
3047 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3048 } else {
3049 if (sector + n > new_backing_num_sectors) {
3050 n = new_backing_num_sectors - sector;
3053 ret = blk_read(blk_new_backing, sector, buf_new, n);
3054 if (ret < 0) {
3055 error_report("error while reading from new backing file");
3056 goto out;
3060 /* If they differ, we need to write to the COW file */
3061 uint64_t written = 0;
3063 while (written < n) {
3064 int pnum;
3066 if (compare_sectors(buf_old + written * 512,
3067 buf_new + written * 512, n - written, &pnum))
3069 ret = blk_write(blk, sector + written,
3070 buf_old + written * 512, pnum);
3071 if (ret < 0) {
3072 error_report("Error while writing to COW image: %s",
3073 strerror(-ret));
3074 goto out;
3078 written += pnum;
3080 qemu_progress_print(local_progress, 100);
3085 * Change the backing file. All clusters that are different from the old
3086 * backing file are overwritten in the COW file now, so the visible content
3087 * doesn't change when we switch the backing file.
3089 if (out_baseimg && *out_baseimg) {
3090 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3091 } else {
3092 ret = bdrv_change_backing_file(bs, NULL, NULL);
3095 if (ret == -ENOSPC) {
3096 error_report("Could not change the backing file to '%s': No "
3097 "space left in the file header", out_baseimg);
3098 } else if (ret < 0) {
3099 error_report("Could not change the backing file to '%s': %s",
3100 out_baseimg, strerror(-ret));
3103 qemu_progress_print(100, 0);
3105 * TODO At this point it is possible to check if any clusters that are
3106 * allocated in the COW file are the same in the backing file. If so, they
3107 * could be dropped from the COW file. Don't do this before switching the
3108 * backing file, in case of a crash this would lead to corruption.
3110 out:
3111 qemu_progress_end();
3112 /* Cleanup */
3113 if (!unsafe) {
3114 blk_unref(blk_old_backing);
3115 blk_unref(blk_new_backing);
3117 qemu_vfree(buf_old);
3118 qemu_vfree(buf_new);
3120 blk_unref(blk);
3121 if (ret) {
3122 return 1;
3124 return 0;
3127 static int img_resize(int argc, char **argv)
3129 Error *err = NULL;
3130 int c, ret, relative;
3131 const char *filename, *fmt, *size;
3132 int64_t n, total_size;
3133 bool quiet = false;
3134 BlockBackend *blk = NULL;
3135 QemuOpts *param;
3136 Error *local_err = NULL;
3138 static QemuOptsList resize_options = {
3139 .name = "resize_options",
3140 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3141 .desc = {
3143 .name = BLOCK_OPT_SIZE,
3144 .type = QEMU_OPT_SIZE,
3145 .help = "Virtual disk size"
3146 }, {
3147 /* end of list */
3151 bool image_opts = false;
3153 /* Remove size from argv manually so that negative numbers are not treated
3154 * as options by getopt. */
3155 if (argc < 3) {
3156 error_exit("Not enough arguments");
3157 return 1;
3160 size = argv[--argc];
3162 /* Parse getopt arguments */
3163 fmt = NULL;
3164 for(;;) {
3165 static const struct option long_options[] = {
3166 {"help", no_argument, 0, 'h'},
3167 {"object", required_argument, 0, OPTION_OBJECT},
3168 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3169 {0, 0, 0, 0}
3171 c = getopt_long(argc, argv, "f:hq",
3172 long_options, NULL);
3173 if (c == -1) {
3174 break;
3176 switch(c) {
3177 case '?':
3178 case 'h':
3179 help();
3180 break;
3181 case 'f':
3182 fmt = optarg;
3183 break;
3184 case 'q':
3185 quiet = true;
3186 break;
3187 case OPTION_OBJECT: {
3188 QemuOpts *opts;
3189 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3190 optarg, true);
3191 if (!opts) {
3192 return 1;
3194 } break;
3195 case OPTION_IMAGE_OPTS:
3196 image_opts = true;
3197 break;
3200 if (optind != argc - 1) {
3201 error_exit("Expecting one image file name");
3203 filename = argv[optind++];
3205 if (qemu_opts_foreach(&qemu_object_opts,
3206 user_creatable_add_opts_foreach,
3207 NULL, &local_err)) {
3208 error_report_err(local_err);
3209 return 1;
3212 /* Choose grow, shrink, or absolute resize mode */
3213 switch (size[0]) {
3214 case '+':
3215 relative = 1;
3216 size++;
3217 break;
3218 case '-':
3219 relative = -1;
3220 size++;
3221 break;
3222 default:
3223 relative = 0;
3224 break;
3227 /* Parse size */
3228 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3229 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3230 if (err) {
3231 error_report_err(err);
3232 ret = -1;
3233 qemu_opts_del(param);
3234 goto out;
3236 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3237 qemu_opts_del(param);
3239 blk = img_open(image_opts, filename, fmt,
3240 BDRV_O_RDWR, false, quiet);
3241 if (!blk) {
3242 ret = -1;
3243 goto out;
3246 if (relative) {
3247 total_size = blk_getlength(blk) + n * relative;
3248 } else {
3249 total_size = n;
3251 if (total_size <= 0) {
3252 error_report("New image size must be positive");
3253 ret = -1;
3254 goto out;
3257 ret = blk_truncate(blk, total_size);
3258 switch (ret) {
3259 case 0:
3260 qprintf(quiet, "Image resized.\n");
3261 break;
3262 case -ENOTSUP:
3263 error_report("This image does not support resize");
3264 break;
3265 case -EACCES:
3266 error_report("Image is read-only");
3267 break;
3268 default:
3269 error_report("Error resizing image (%d)", -ret);
3270 break;
3272 out:
3273 blk_unref(blk);
3274 if (ret) {
3275 return 1;
3277 return 0;
3280 static void amend_status_cb(BlockDriverState *bs,
3281 int64_t offset, int64_t total_work_size,
3282 void *opaque)
3284 qemu_progress_print(100.f * offset / total_work_size, 0);
3287 static int img_amend(int argc, char **argv)
3289 Error *err = NULL;
3290 int c, ret = 0;
3291 char *options = NULL;
3292 QemuOptsList *create_opts = NULL;
3293 QemuOpts *opts = NULL;
3294 const char *fmt = NULL, *filename, *cache;
3295 int flags;
3296 bool writethrough;
3297 bool quiet = false, progress = false;
3298 BlockBackend *blk = NULL;
3299 BlockDriverState *bs = NULL;
3300 Error *local_err = NULL;
3301 bool image_opts = false;
3303 cache = BDRV_DEFAULT_CACHE;
3304 for (;;) {
3305 static const struct option long_options[] = {
3306 {"help", no_argument, 0, 'h'},
3307 {"object", required_argument, 0, OPTION_OBJECT},
3308 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3309 {0, 0, 0, 0}
3311 c = getopt_long(argc, argv, "ho:f:t:pq",
3312 long_options, NULL);
3313 if (c == -1) {
3314 break;
3317 switch (c) {
3318 case 'h':
3319 case '?':
3320 help();
3321 break;
3322 case 'o':
3323 if (!is_valid_option_list(optarg)) {
3324 error_report("Invalid option list: %s", optarg);
3325 ret = -1;
3326 goto out_no_progress;
3328 if (!options) {
3329 options = g_strdup(optarg);
3330 } else {
3331 char *old_options = options;
3332 options = g_strdup_printf("%s,%s", options, optarg);
3333 g_free(old_options);
3335 break;
3336 case 'f':
3337 fmt = optarg;
3338 break;
3339 case 't':
3340 cache = optarg;
3341 break;
3342 case 'p':
3343 progress = true;
3344 break;
3345 case 'q':
3346 quiet = true;
3347 break;
3348 case OPTION_OBJECT:
3349 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3350 optarg, true);
3351 if (!opts) {
3352 ret = -1;
3353 goto out_no_progress;
3355 break;
3356 case OPTION_IMAGE_OPTS:
3357 image_opts = true;
3358 break;
3362 if (!options) {
3363 error_exit("Must specify options (-o)");
3366 if (qemu_opts_foreach(&qemu_object_opts,
3367 user_creatable_add_opts_foreach,
3368 NULL, &local_err)) {
3369 error_report_err(local_err);
3370 ret = -1;
3371 goto out_no_progress;
3374 if (quiet) {
3375 progress = false;
3377 qemu_progress_init(progress, 1.0);
3379 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3380 if (fmt && has_help_option(options)) {
3381 /* If a format is explicitly specified (and possibly no filename is
3382 * given), print option help here */
3383 ret = print_block_option_help(filename, fmt);
3384 goto out;
3387 if (optind != argc - 1) {
3388 error_report("Expecting one image file name");
3389 ret = -1;
3390 goto out;
3393 flags = BDRV_O_RDWR;
3394 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3395 if (ret < 0) {
3396 error_report("Invalid cache option: %s", cache);
3397 goto out;
3400 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3401 if (!blk) {
3402 ret = -1;
3403 goto out;
3405 bs = blk_bs(blk);
3407 fmt = bs->drv->format_name;
3409 if (has_help_option(options)) {
3410 /* If the format was auto-detected, print option help here */
3411 ret = print_block_option_help(filename, fmt);
3412 goto out;
3415 if (!bs->drv->create_opts) {
3416 error_report("Format driver '%s' does not support any options to amend",
3417 fmt);
3418 ret = -1;
3419 goto out;
3422 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3423 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3424 if (options) {
3425 qemu_opts_do_parse(opts, options, NULL, &err);
3426 if (err) {
3427 error_report_err(err);
3428 ret = -1;
3429 goto out;
3433 /* In case the driver does not call amend_status_cb() */
3434 qemu_progress_print(0.f, 0);
3435 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3436 qemu_progress_print(100.f, 0);
3437 if (ret < 0) {
3438 error_report("Error while amending options: %s", strerror(-ret));
3439 goto out;
3442 out:
3443 qemu_progress_end();
3445 out_no_progress:
3446 blk_unref(blk);
3447 qemu_opts_del(opts);
3448 qemu_opts_free(create_opts);
3449 g_free(options);
3451 if (ret) {
3452 return 1;
3454 return 0;
3457 static const img_cmd_t img_cmds[] = {
3458 #define DEF(option, callback, arg_string) \
3459 { option, callback },
3460 #include "qemu-img-cmds.h"
3461 #undef DEF
3462 #undef GEN_DOCS
3463 { NULL, NULL, },
3466 int main(int argc, char **argv)
3468 const img_cmd_t *cmd;
3469 const char *cmdname;
3470 Error *local_error = NULL;
3471 int c;
3472 static const struct option long_options[] = {
3473 {"help", no_argument, 0, 'h'},
3474 {"version", no_argument, 0, 'v'},
3475 {0, 0, 0, 0}
3478 #ifdef CONFIG_POSIX
3479 signal(SIGPIPE, SIG_IGN);
3480 #endif
3482 error_set_progname(argv[0]);
3483 qemu_init_exec_dir(argv[0]);
3485 if (qemu_init_main_loop(&local_error)) {
3486 error_report_err(local_error);
3487 exit(EXIT_FAILURE);
3490 if (qcrypto_init(&local_error) < 0) {
3491 error_reportf_err(local_error, "cannot initialize crypto: ");
3492 exit(1);
3495 module_call_init(MODULE_INIT_QOM);
3496 bdrv_init();
3497 if (argc < 2) {
3498 error_exit("Not enough arguments");
3500 cmdname = argv[1];
3502 qemu_add_opts(&qemu_object_opts);
3503 qemu_add_opts(&qemu_source_opts);
3505 /* find the command */
3506 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
3507 if (!strcmp(cmdname, cmd->name)) {
3508 return cmd->handler(argc - 1, argv + 1);
3512 c = getopt_long(argc, argv, "h", long_options, NULL);
3514 if (c == 'h') {
3515 help();
3517 if (c == 'v') {
3518 printf(QEMU_IMG_VERSION);
3519 return 0;
3522 /* not found */
3523 error_exit("Command not found: %s", cmdname);