Postcopy: Add stats on page requests
[qemu.git] / qemu-img.c
1 /*
2 * QEMU disk image utility
3 *
4 * Copyright (c) 2003-2008 Fabrice Bellard
5 *
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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.
23 */
24 #include "qemu/osdep.h"
25 #include "qemu-version.h"
26 #include "qapi/error.h"
27 #include "qapi-visit.h"
28 #include "qapi/qmp-output-visitor.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qapi/qmp/qjson.h"
31 #include "qemu/cutils.h"
32 #include "qemu/config-file.h"
33 #include "qemu/option.h"
34 #include "qemu/error-report.h"
35 #include "qom/object_interfaces.h"
36 #include "sysemu/sysemu.h"
37 #include "sysemu/block-backend.h"
38 #include "block/block_int.h"
39 #include "block/blockjob.h"
40 #include "block/qapi.h"
41 #include "crypto/init.h"
42 #include <getopt.h>
43
44 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
45 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
46
47 typedef struct img_cmd_t {
48 const char *name;
49 int (*handler)(int argc, char **argv);
50 } img_cmd_t;
51
52 enum {
53 OPTION_OUTPUT = 256,
54 OPTION_BACKING_CHAIN = 257,
55 OPTION_OBJECT = 258,
56 OPTION_IMAGE_OPTS = 259,
57 OPTION_PATTERN = 260,
58 OPTION_FLUSH_INTERVAL = 261,
59 OPTION_NO_DRAIN = 262,
60 };
61
62 typedef enum OutputFormat {
63 OFORMAT_JSON,
64 OFORMAT_HUMAN,
65 } OutputFormat;
66
67 /* Default to cache=writeback as data integrity is not important for qemu-img */
68 #define BDRV_DEFAULT_CACHE "writeback"
69
70 static void format_print(void *opaque, const char *name)
71 {
72 printf(" %s", name);
73 }
74
75 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
76 {
77 va_list ap;
78
79 error_printf("qemu-img: ");
80
81 va_start(ap, fmt);
82 error_vprintf(fmt, ap);
83 va_end(ap);
84
85 error_printf("\nTry 'qemu-img --help' for more information\n");
86 exit(EXIT_FAILURE);
87 }
88
89 /* Please keep in synch with qemu-img.texi */
90 static void QEMU_NORETURN help(void)
91 {
92 const char *help_msg =
93 QEMU_IMG_VERSION
94 "usage: qemu-img command [command options]\n"
95 "QEMU disk image utility\n"
96 "\n"
97 "Command syntax:\n"
98 #define DEF(option, callback, arg_string) \
99 " " arg_string "\n"
100 #include "qemu-img-cmds.h"
101 #undef DEF
102 #undef GEN_DOCS
103 "\n"
104 "Command parameters:\n"
105 " 'filename' is a disk image filename\n"
106 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
107 " manual page for a description of the object properties. The most common\n"
108 " object type is a 'secret', which is used to supply passwords and/or\n"
109 " encryption keys.\n"
110 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
111 " 'cache' is the cache mode used to write the output disk image, the valid\n"
112 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
113 " 'directsync' and 'unsafe' (default for convert)\n"
114 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
115 " options are the same as for the 'cache' option\n"
116 " 'size' is the disk image size in bytes. Optional suffixes\n"
117 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
118 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
119 " supported. 'b' is ignored.\n"
120 " 'output_filename' is the destination disk image filename\n"
121 " 'output_fmt' is the destination format\n"
122 " 'options' is a comma separated list of format specific options in a\n"
123 " name=value format. Use -o ? for an overview of the options supported by the\n"
124 " used format\n"
125 " 'snapshot_param' is param used for internal snapshot, format\n"
126 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
127 " '[ID_OR_NAME]'\n"
128 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
129 " instead\n"
130 " '-c' indicates that target image must be compressed (qcow format only)\n"
131 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
132 " match exactly. The image doesn't need a working backing file before\n"
133 " rebasing in this case (useful for renaming the backing file)\n"
134 " '-h' with or without a command shows this help and lists the supported formats\n"
135 " '-p' show progress of command (only certain commands)\n"
136 " '-q' use Quiet mode - do not print any output (except errors)\n"
137 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
138 " contain only zeros for qemu-img to create a sparse image during\n"
139 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
140 " unallocated or zero sectors, and the destination image will always be\n"
141 " fully allocated\n"
142 " '--output' takes the format in which the output must be done (human or json)\n"
143 " '-n' skips the target volume creation (useful if the volume is created\n"
144 " prior to running qemu-img)\n"
145 "\n"
146 "Parameters to check subcommand:\n"
147 " '-r' tries to repair any inconsistencies that are found during the check.\n"
148 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
149 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
150 " hiding corruption that has already occurred.\n"
151 "\n"
152 "Parameters to snapshot subcommand:\n"
153 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
154 " '-a' applies a snapshot (revert disk to saved state)\n"
155 " '-c' creates a snapshot\n"
156 " '-d' deletes a snapshot\n"
157 " '-l' lists all snapshots in the given image\n"
158 "\n"
159 "Parameters to compare subcommand:\n"
160 " '-f' first image format\n"
161 " '-F' second image format\n"
162 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
163
164 printf("%s\nSupported formats:", help_msg);
165 bdrv_iterate_format(format_print, NULL);
166 printf("\n");
167 exit(EXIT_SUCCESS);
168 }
169
170 static QemuOptsList qemu_object_opts = {
171 .name = "object",
172 .implied_opt_name = "qom-type",
173 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
174 .desc = {
175 { }
176 },
177 };
178
179 static QemuOptsList qemu_source_opts = {
180 .name = "source",
181 .implied_opt_name = "file",
182 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
183 .desc = {
184 { }
185 },
186 };
187
188 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
189 {
190 int ret = 0;
191 if (!quiet) {
192 va_list args;
193 va_start(args, fmt);
194 ret = vprintf(fmt, args);
195 va_end(args);
196 }
197 return ret;
198 }
199
200
201 static int print_block_option_help(const char *filename, const char *fmt)
202 {
203 BlockDriver *drv, *proto_drv;
204 QemuOptsList *create_opts = NULL;
205 Error *local_err = NULL;
206
207 /* Find driver and parse its options */
208 drv = bdrv_find_format(fmt);
209 if (!drv) {
210 error_report("Unknown file format '%s'", fmt);
211 return 1;
212 }
213
214 create_opts = qemu_opts_append(create_opts, drv->create_opts);
215 if (filename) {
216 proto_drv = bdrv_find_protocol(filename, true, &local_err);
217 if (!proto_drv) {
218 error_report_err(local_err);
219 qemu_opts_free(create_opts);
220 return 1;
221 }
222 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
223 }
224
225 qemu_opts_print_help(create_opts);
226 qemu_opts_free(create_opts);
227 return 0;
228 }
229
230
231 static int img_open_password(BlockBackend *blk, const char *filename,
232 int flags, bool quiet)
233 {
234 BlockDriverState *bs;
235 char password[256];
236
237 bs = blk_bs(blk);
238 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
239 !(flags & BDRV_O_NO_IO)) {
240 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
241 if (qemu_read_password(password, sizeof(password)) < 0) {
242 error_report("No password given");
243 return -1;
244 }
245 if (bdrv_set_key(bs, password) < 0) {
246 error_report("invalid password");
247 return -1;
248 }
249 }
250 return 0;
251 }
252
253
254 static BlockBackend *img_open_opts(const char *optstr,
255 QemuOpts *opts, int flags, bool writethrough,
256 bool quiet)
257 {
258 QDict *options;
259 Error *local_err = NULL;
260 BlockBackend *blk;
261 options = qemu_opts_to_qdict(opts, NULL);
262 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
263 if (!blk) {
264 error_reportf_err(local_err, "Could not open '%s': ", optstr);
265 return NULL;
266 }
267 blk_set_enable_write_cache(blk, !writethrough);
268
269 if (img_open_password(blk, optstr, flags, quiet) < 0) {
270 blk_unref(blk);
271 return NULL;
272 }
273 return blk;
274 }
275
276 static BlockBackend *img_open_file(const char *filename,
277 const char *fmt, int flags,
278 bool writethrough, bool quiet)
279 {
280 BlockBackend *blk;
281 Error *local_err = NULL;
282 QDict *options = NULL;
283
284 if (fmt) {
285 options = qdict_new();
286 qdict_put(options, "driver", qstring_from_str(fmt));
287 }
288
289 blk = blk_new_open(filename, NULL, options, flags, &local_err);
290 if (!blk) {
291 error_reportf_err(local_err, "Could not open '%s': ", filename);
292 return NULL;
293 }
294 blk_set_enable_write_cache(blk, !writethrough);
295
296 if (img_open_password(blk, filename, flags, quiet) < 0) {
297 blk_unref(blk);
298 return NULL;
299 }
300 return blk;
301 }
302
303
304 static BlockBackend *img_open(bool image_opts,
305 const char *filename,
306 const char *fmt, int flags, bool writethrough,
307 bool quiet)
308 {
309 BlockBackend *blk;
310 if (image_opts) {
311 QemuOpts *opts;
312 if (fmt) {
313 error_report("--image-opts and --format are mutually exclusive");
314 return NULL;
315 }
316 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
317 filename, true);
318 if (!opts) {
319 return NULL;
320 }
321 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
322 } else {
323 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
324 }
325 return blk;
326 }
327
328
329 static int add_old_style_options(const char *fmt, QemuOpts *opts,
330 const char *base_filename,
331 const char *base_fmt)
332 {
333 Error *err = NULL;
334
335 if (base_filename) {
336 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
337 if (err) {
338 error_report("Backing file not supported for file format '%s'",
339 fmt);
340 error_free(err);
341 return -1;
342 }
343 }
344 if (base_fmt) {
345 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
346 if (err) {
347 error_report("Backing file format not supported for file "
348 "format '%s'", fmt);
349 error_free(err);
350 return -1;
351 }
352 }
353 return 0;
354 }
355
356 static int img_create(int argc, char **argv)
357 {
358 int c;
359 uint64_t img_size = -1;
360 const char *fmt = "raw";
361 const char *base_fmt = NULL;
362 const char *filename;
363 const char *base_filename = NULL;
364 char *options = NULL;
365 Error *local_err = NULL;
366 bool quiet = false;
367
368 for(;;) {
369 static const struct option long_options[] = {
370 {"help", no_argument, 0, 'h'},
371 {"object", required_argument, 0, OPTION_OBJECT},
372 {0, 0, 0, 0}
373 };
374 c = getopt_long(argc, argv, "F:b:f:he6o:q",
375 long_options, NULL);
376 if (c == -1) {
377 break;
378 }
379 switch(c) {
380 case '?':
381 case 'h':
382 help();
383 break;
384 case 'F':
385 base_fmt = optarg;
386 break;
387 case 'b':
388 base_filename = optarg;
389 break;
390 case 'f':
391 fmt = optarg;
392 break;
393 case 'e':
394 error_report("option -e is deprecated, please use \'-o "
395 "encryption\' instead!");
396 goto fail;
397 case '6':
398 error_report("option -6 is deprecated, please use \'-o "
399 "compat6\' instead!");
400 goto fail;
401 case 'o':
402 if (!is_valid_option_list(optarg)) {
403 error_report("Invalid option list: %s", optarg);
404 goto fail;
405 }
406 if (!options) {
407 options = g_strdup(optarg);
408 } else {
409 char *old_options = options;
410 options = g_strdup_printf("%s,%s", options, optarg);
411 g_free(old_options);
412 }
413 break;
414 case 'q':
415 quiet = true;
416 break;
417 case OPTION_OBJECT: {
418 QemuOpts *opts;
419 opts = qemu_opts_parse_noisily(&qemu_object_opts,
420 optarg, true);
421 if (!opts) {
422 goto fail;
423 }
424 } break;
425 }
426 }
427
428 /* Get the filename */
429 filename = (optind < argc) ? argv[optind] : NULL;
430 if (options && has_help_option(options)) {
431 g_free(options);
432 return print_block_option_help(filename, fmt);
433 }
434
435 if (optind >= argc) {
436 error_exit("Expecting image file name");
437 }
438 optind++;
439
440 if (qemu_opts_foreach(&qemu_object_opts,
441 user_creatable_add_opts_foreach,
442 NULL, NULL)) {
443 goto fail;
444 }
445
446 /* Get image size, if specified */
447 if (optind < argc) {
448 int64_t sval;
449 char *end;
450 sval = qemu_strtosz_suffix(argv[optind++], &end,
451 QEMU_STRTOSZ_DEFSUFFIX_B);
452 if (sval < 0 || *end) {
453 if (sval == -ERANGE) {
454 error_report("Image size must be less than 8 EiB!");
455 } else {
456 error_report("Invalid image size specified! You may use k, M, "
457 "G, T, P or E suffixes for ");
458 error_report("kilobytes, megabytes, gigabytes, terabytes, "
459 "petabytes and exabytes.");
460 }
461 goto fail;
462 }
463 img_size = (uint64_t)sval;
464 }
465 if (optind != argc) {
466 error_exit("Unexpected argument: %s", argv[optind]);
467 }
468
469 bdrv_img_create(filename, fmt, base_filename, base_fmt,
470 options, img_size, 0, &local_err, quiet);
471 if (local_err) {
472 error_reportf_err(local_err, "%s: ", filename);
473 goto fail;
474 }
475
476 g_free(options);
477 return 0;
478
479 fail:
480 g_free(options);
481 return 1;
482 }
483
484 static void dump_json_image_check(ImageCheck *check, bool quiet)
485 {
486 Error *local_err = NULL;
487 QString *str;
488 QmpOutputVisitor *ov = qmp_output_visitor_new();
489 QObject *obj;
490 visit_type_ImageCheck(qmp_output_get_visitor(ov), NULL, &check,
491 &local_err);
492 obj = qmp_output_get_qobject(ov);
493 str = qobject_to_json_pretty(obj);
494 assert(str != NULL);
495 qprintf(quiet, "%s\n", qstring_get_str(str));
496 qobject_decref(obj);
497 qmp_output_visitor_cleanup(ov);
498 QDECREF(str);
499 }
500
501 static void dump_human_image_check(ImageCheck *check, bool quiet)
502 {
503 if (!(check->corruptions || check->leaks || check->check_errors)) {
504 qprintf(quiet, "No errors were found on the image.\n");
505 } else {
506 if (check->corruptions) {
507 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
508 "Data may be corrupted, or further writes to the image "
509 "may corrupt it.\n",
510 check->corruptions);
511 }
512
513 if (check->leaks) {
514 qprintf(quiet,
515 "\n%" PRId64 " leaked clusters were found on the image.\n"
516 "This means waste of disk space, but no harm to data.\n",
517 check->leaks);
518 }
519
520 if (check->check_errors) {
521 qprintf(quiet,
522 "\n%" PRId64
523 " internal errors have occurred during the check.\n",
524 check->check_errors);
525 }
526 }
527
528 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
529 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
530 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
531 check->allocated_clusters, check->total_clusters,
532 check->allocated_clusters * 100.0 / check->total_clusters,
533 check->fragmented_clusters * 100.0 / check->allocated_clusters,
534 check->compressed_clusters * 100.0 /
535 check->allocated_clusters);
536 }
537
538 if (check->image_end_offset) {
539 qprintf(quiet,
540 "Image end offset: %" PRId64 "\n", check->image_end_offset);
541 }
542 }
543
544 static int collect_image_check(BlockDriverState *bs,
545 ImageCheck *check,
546 const char *filename,
547 const char *fmt,
548 int fix)
549 {
550 int ret;
551 BdrvCheckResult result;
552
553 ret = bdrv_check(bs, &result, fix);
554 if (ret < 0) {
555 return ret;
556 }
557
558 check->filename = g_strdup(filename);
559 check->format = g_strdup(bdrv_get_format_name(bs));
560 check->check_errors = result.check_errors;
561 check->corruptions = result.corruptions;
562 check->has_corruptions = result.corruptions != 0;
563 check->leaks = result.leaks;
564 check->has_leaks = result.leaks != 0;
565 check->corruptions_fixed = result.corruptions_fixed;
566 check->has_corruptions_fixed = result.corruptions != 0;
567 check->leaks_fixed = result.leaks_fixed;
568 check->has_leaks_fixed = result.leaks != 0;
569 check->image_end_offset = result.image_end_offset;
570 check->has_image_end_offset = result.image_end_offset != 0;
571 check->total_clusters = result.bfi.total_clusters;
572 check->has_total_clusters = result.bfi.total_clusters != 0;
573 check->allocated_clusters = result.bfi.allocated_clusters;
574 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
575 check->fragmented_clusters = result.bfi.fragmented_clusters;
576 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
577 check->compressed_clusters = result.bfi.compressed_clusters;
578 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
579
580 return 0;
581 }
582
583 /*
584 * Checks an image for consistency. Exit codes:
585 *
586 * 0 - Check completed, image is good
587 * 1 - Check not completed because of internal errors
588 * 2 - Check completed, image is corrupted
589 * 3 - Check completed, image has leaked clusters, but is good otherwise
590 * 63 - Checks are not supported by the image format
591 */
592 static int img_check(int argc, char **argv)
593 {
594 int c, ret;
595 OutputFormat output_format = OFORMAT_HUMAN;
596 const char *filename, *fmt, *output, *cache;
597 BlockBackend *blk;
598 BlockDriverState *bs;
599 int fix = 0;
600 int flags = BDRV_O_CHECK;
601 bool writethrough;
602 ImageCheck *check;
603 bool quiet = false;
604 bool image_opts = false;
605
606 fmt = NULL;
607 output = NULL;
608 cache = BDRV_DEFAULT_CACHE;
609
610 for(;;) {
611 int option_index = 0;
612 static const struct option long_options[] = {
613 {"help", no_argument, 0, 'h'},
614 {"format", required_argument, 0, 'f'},
615 {"repair", required_argument, 0, 'r'},
616 {"output", required_argument, 0, OPTION_OUTPUT},
617 {"object", required_argument, 0, OPTION_OBJECT},
618 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
619 {0, 0, 0, 0}
620 };
621 c = getopt_long(argc, argv, "hf:r:T:q",
622 long_options, &option_index);
623 if (c == -1) {
624 break;
625 }
626 switch(c) {
627 case '?':
628 case 'h':
629 help();
630 break;
631 case 'f':
632 fmt = optarg;
633 break;
634 case 'r':
635 flags |= BDRV_O_RDWR;
636
637 if (!strcmp(optarg, "leaks")) {
638 fix = BDRV_FIX_LEAKS;
639 } else if (!strcmp(optarg, "all")) {
640 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
641 } else {
642 error_exit("Unknown option value for -r "
643 "(expecting 'leaks' or 'all'): %s", optarg);
644 }
645 break;
646 case OPTION_OUTPUT:
647 output = optarg;
648 break;
649 case 'T':
650 cache = optarg;
651 break;
652 case 'q':
653 quiet = true;
654 break;
655 case OPTION_OBJECT: {
656 QemuOpts *opts;
657 opts = qemu_opts_parse_noisily(&qemu_object_opts,
658 optarg, true);
659 if (!opts) {
660 return 1;
661 }
662 } break;
663 case OPTION_IMAGE_OPTS:
664 image_opts = true;
665 break;
666 }
667 }
668 if (optind != argc - 1) {
669 error_exit("Expecting one image file name");
670 }
671 filename = argv[optind++];
672
673 if (output && !strcmp(output, "json")) {
674 output_format = OFORMAT_JSON;
675 } else if (output && !strcmp(output, "human")) {
676 output_format = OFORMAT_HUMAN;
677 } else if (output) {
678 error_report("--output must be used with human or json as argument.");
679 return 1;
680 }
681
682 if (qemu_opts_foreach(&qemu_object_opts,
683 user_creatable_add_opts_foreach,
684 NULL, NULL)) {
685 return 1;
686 }
687
688 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
689 if (ret < 0) {
690 error_report("Invalid source cache option: %s", cache);
691 return 1;
692 }
693
694 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
695 if (!blk) {
696 return 1;
697 }
698 bs = blk_bs(blk);
699
700 check = g_new0(ImageCheck, 1);
701 ret = collect_image_check(bs, check, filename, fmt, fix);
702
703 if (ret == -ENOTSUP) {
704 error_report("This image format does not support checks");
705 ret = 63;
706 goto fail;
707 }
708
709 if (check->corruptions_fixed || check->leaks_fixed) {
710 int corruptions_fixed, leaks_fixed;
711
712 leaks_fixed = check->leaks_fixed;
713 corruptions_fixed = check->corruptions_fixed;
714
715 if (output_format == OFORMAT_HUMAN) {
716 qprintf(quiet,
717 "The following inconsistencies were found and repaired:\n\n"
718 " %" PRId64 " leaked clusters\n"
719 " %" PRId64 " corruptions\n\n"
720 "Double checking the fixed image now...\n",
721 check->leaks_fixed,
722 check->corruptions_fixed);
723 }
724
725 ret = collect_image_check(bs, check, filename, fmt, 0);
726
727 check->leaks_fixed = leaks_fixed;
728 check->corruptions_fixed = corruptions_fixed;
729 }
730
731 if (!ret) {
732 switch (output_format) {
733 case OFORMAT_HUMAN:
734 dump_human_image_check(check, quiet);
735 break;
736 case OFORMAT_JSON:
737 dump_json_image_check(check, quiet);
738 break;
739 }
740 }
741
742 if (ret || check->check_errors) {
743 if (ret) {
744 error_report("Check failed: %s", strerror(-ret));
745 } else {
746 error_report("Check failed");
747 }
748 ret = 1;
749 goto fail;
750 }
751
752 if (check->corruptions) {
753 ret = 2;
754 } else if (check->leaks) {
755 ret = 3;
756 } else {
757 ret = 0;
758 }
759
760 fail:
761 qapi_free_ImageCheck(check);
762 blk_unref(blk);
763 return ret;
764 }
765
766 typedef struct CommonBlockJobCBInfo {
767 BlockDriverState *bs;
768 Error **errp;
769 } CommonBlockJobCBInfo;
770
771 static void common_block_job_cb(void *opaque, int ret)
772 {
773 CommonBlockJobCBInfo *cbi = opaque;
774
775 if (ret < 0) {
776 error_setg_errno(cbi->errp, -ret, "Block job failed");
777 }
778 }
779
780 static void run_block_job(BlockJob *job, Error **errp)
781 {
782 AioContext *aio_context = blk_get_aio_context(job->blk);
783
784 do {
785 aio_poll(aio_context, true);
786 qemu_progress_print(job->len ?
787 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
788 } while (!job->ready);
789
790 block_job_complete_sync(job, errp);
791
792 /* A block job may finish instantaneously without publishing any progress,
793 * so just signal completion here */
794 qemu_progress_print(100.f, 0);
795 }
796
797 static int img_commit(int argc, char **argv)
798 {
799 int c, ret, flags;
800 const char *filename, *fmt, *cache, *base;
801 BlockBackend *blk;
802 BlockDriverState *bs, *base_bs;
803 bool progress = false, quiet = false, drop = false;
804 bool writethrough;
805 Error *local_err = NULL;
806 CommonBlockJobCBInfo cbi;
807 bool image_opts = false;
808
809 fmt = NULL;
810 cache = BDRV_DEFAULT_CACHE;
811 base = NULL;
812 for(;;) {
813 static const struct option long_options[] = {
814 {"help", no_argument, 0, 'h'},
815 {"object", required_argument, 0, OPTION_OBJECT},
816 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
817 {0, 0, 0, 0}
818 };
819 c = getopt_long(argc, argv, "f:ht:b:dpq",
820 long_options, NULL);
821 if (c == -1) {
822 break;
823 }
824 switch(c) {
825 case '?':
826 case 'h':
827 help();
828 break;
829 case 'f':
830 fmt = optarg;
831 break;
832 case 't':
833 cache = optarg;
834 break;
835 case 'b':
836 base = optarg;
837 /* -b implies -d */
838 drop = true;
839 break;
840 case 'd':
841 drop = true;
842 break;
843 case 'p':
844 progress = true;
845 break;
846 case 'q':
847 quiet = true;
848 break;
849 case OPTION_OBJECT: {
850 QemuOpts *opts;
851 opts = qemu_opts_parse_noisily(&qemu_object_opts,
852 optarg, true);
853 if (!opts) {
854 return 1;
855 }
856 } break;
857 case OPTION_IMAGE_OPTS:
858 image_opts = true;
859 break;
860 }
861 }
862
863 /* Progress is not shown in Quiet mode */
864 if (quiet) {
865 progress = false;
866 }
867
868 if (optind != argc - 1) {
869 error_exit("Expecting one image file name");
870 }
871 filename = argv[optind++];
872
873 if (qemu_opts_foreach(&qemu_object_opts,
874 user_creatable_add_opts_foreach,
875 NULL, NULL)) {
876 return 1;
877 }
878
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;
884 }
885
886 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
887 if (!blk) {
888 return 1;
889 }
890 bs = blk_bs(blk);
891
892 qemu_progress_init(progress, 1.f);
893 qemu_progress_print(0.f, 100);
894
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;
900 }
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;
909 }
910 }
911
912 cbi = (CommonBlockJobCBInfo){
913 .errp = &local_err,
914 .bs = bs,
915 };
916
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;
921 }
922
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);
929 }
930
931 run_block_job(bs->job, &local_err);
932 if (local_err) {
933 goto unref_backing;
934 }
935
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;
942 }
943 }
944
945 unref_backing:
946 if (!drop) {
947 bdrv_unref(bs);
948 }
949
950 done:
951 qemu_progress_end();
952
953 blk_unref(blk);
954
955 if (local_err) {
956 error_report_err(local_err);
957 return 1;
958 }
959
960 qprintf(quiet, "Image committed.\n");
961 return 0;
962 }
963
964 /*
965 * Returns true iff the first sector pointed to by 'buf' contains at least
966 * a non-NUL byte.
967 *
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.
970 */
971 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
972 {
973 bool is_zero;
974 int i;
975
976 if (n <= 0) {
977 *pnum = 0;
978 return 0;
979 }
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;
985 }
986 }
987 *pnum = i;
988 return !is_zero;
989 }
990
991 /*
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.
995 */
996 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
997 int min)
998 {
999 int ret;
1000 int num_checked, num_used;
1001
1002 if (n < min) {
1003 min = n;
1004 }
1005
1006 ret = is_allocated_sectors(buf, n, pnum);
1007 if (!ret) {
1008 return ret;
1009 }
1010
1011 num_used = *pnum;
1012 buf += BDRV_SECTOR_SIZE * *pnum;
1013 n -= *pnum;
1014 num_checked = num_used;
1015
1016 while (n > 0) {
1017 ret = is_allocated_sectors(buf, n, pnum);
1018
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;
1026 }
1027 }
1028
1029 *pnum = num_used;
1030 return 1;
1031 }
1032
1033 /*
1034 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1035 * buffers matches, non-zero otherwise.
1036 *
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
1039 */
1040 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1041 int *pnum)
1042 {
1043 bool res;
1044 int i;
1045
1046 if (n <= 0) {
1047 *pnum = 0;
1048 return 0;
1049 }
1050
1051 res = !!memcmp(buf1, buf2, 512);
1052 for(i = 1; i < n; i++) {
1053 buf1 += 512;
1054 buf2 += 512;
1055
1056 if (!!memcmp(buf1, buf2, 512) != res) {
1057 break;
1058 }
1059 }
1060
1061 *pnum = i;
1062 return res;
1063 }
1064
1065 #define IO_BUF_SIZE (2 * 1024 * 1024)
1066
1067 static int64_t sectors_to_bytes(int64_t sectors)
1068 {
1069 return sectors << BDRV_SECTOR_BITS;
1070 }
1071
1072 static int64_t sectors_to_process(int64_t total, int64_t from)
1073 {
1074 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1075 }
1076
1077 /*
1078 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1079 *
1080 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1081 * data and negative value on error.
1082 *
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
1089 */
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)
1093 {
1094 int pnum, ret = 0;
1095 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1096 sect_count << BDRV_SECTOR_BITS);
1097 if (ret < 0) {
1098 error_report("Error while reading offset %" PRId64 " of %s: %s",
1099 sectors_to_bytes(sect_num), filename, strerror(-ret));
1100 return ret;
1101 }
1102 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1103 if (ret || pnum != sect_count) {
1104 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1105 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1106 return 1;
1107 }
1108
1109 return 0;
1110 }
1111
1112 /*
1113 * Compares two images. Exit codes:
1114 *
1115 * 0 - Images are identical
1116 * 1 - Images differ
1117 * >1 - Error occurred
1118 */
1119 static int img_compare(int argc, char **argv)
1120 {
1121 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1122 BlockBackend *blk1, *blk2;
1123 BlockDriverState *bs1, *bs2;
1124 int64_t total_sectors1, total_sectors2;
1125 uint8_t *buf1 = NULL, *buf2 = NULL;
1126 int pnum1, pnum2;
1127 int allocated1, allocated2;
1128 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1129 bool progress = false, quiet = false, strict = false;
1130 int flags;
1131 bool writethrough;
1132 int64_t total_sectors;
1133 int64_t sector_num = 0;
1134 int64_t nb_sectors;
1135 int c, pnum;
1136 uint64_t progress_base;
1137 bool image_opts = false;
1138
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}
1146 };
1147 c = getopt_long(argc, argv, "hf:F:T:pqs",
1148 long_options, NULL);
1149 if (c == -1) {
1150 break;
1151 }
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;
1182 }
1183 } break;
1184 case OPTION_IMAGE_OPTS:
1185 image_opts = true;
1186 break;
1187 }
1188 }
1189
1190 /* Progress is not shown in Quiet mode */
1191 if (quiet) {
1192 progress = false;
1193 }
1194
1195
1196 if (optind != argc - 2) {
1197 error_exit("Expecting two image file names");
1198 }
1199 filename1 = argv[optind++];
1200 filename2 = argv[optind++];
1201
1202 if (qemu_opts_foreach(&qemu_object_opts,
1203 user_creatable_add_opts_foreach,
1204 NULL, NULL)) {
1205 ret = 2;
1206 goto out4;
1207 }
1208
1209 /* Initialize before goto out */
1210 qemu_progress_init(progress, 2.0);
1211
1212 flags = 0;
1213 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1214 if (ret < 0) {
1215 error_report("Invalid source cache option: %s", cache);
1216 ret = 2;
1217 goto out3;
1218 }
1219
1220 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1221 if (!blk1) {
1222 ret = 2;
1223 goto out3;
1224 }
1225
1226 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1227 if (!blk2) {
1228 ret = 2;
1229 goto out2;
1230 }
1231 bs1 = blk_bs(blk1);
1232 bs2 = blk_bs(blk2);
1233
1234 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1235 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1236 total_sectors1 = blk_nb_sectors(blk1);
1237 if (total_sectors1 < 0) {
1238 error_report("Can't get size of %s: %s",
1239 filename1, strerror(-total_sectors1));
1240 ret = 4;
1241 goto out;
1242 }
1243 total_sectors2 = blk_nb_sectors(blk2);
1244 if (total_sectors2 < 0) {
1245 error_report("Can't get size of %s: %s",
1246 filename2, strerror(-total_sectors2));
1247 ret = 4;
1248 goto out;
1249 }
1250 total_sectors = MIN(total_sectors1, total_sectors2);
1251 progress_base = MAX(total_sectors1, total_sectors2);
1252
1253 qemu_progress_print(0, 100);
1254
1255 if (strict && total_sectors1 != total_sectors2) {
1256 ret = 1;
1257 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1258 goto out;
1259 }
1260
1261 for (;;) {
1262 int64_t status1, status2;
1263 BlockDriverState *file;
1264
1265 nb_sectors = sectors_to_process(total_sectors, sector_num);
1266 if (nb_sectors <= 0) {
1267 break;
1268 }
1269 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1270 total_sectors1 - sector_num,
1271 &pnum1, &file);
1272 if (status1 < 0) {
1273 ret = 3;
1274 error_report("Sector allocation test failed for %s", filename1);
1275 goto out;
1276 }
1277 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1278
1279 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1280 total_sectors2 - sector_num,
1281 &pnum2, &file);
1282 if (status2 < 0) {
1283 ret = 3;
1284 error_report("Sector allocation test failed for %s", filename2);
1285 goto out;
1286 }
1287 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1288 if (pnum1) {
1289 nb_sectors = MIN(nb_sectors, pnum1);
1290 }
1291 if (pnum2) {
1292 nb_sectors = MIN(nb_sectors, pnum2);
1293 }
1294
1295 if (strict) {
1296 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1297 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1298 ret = 1;
1299 qprintf(quiet, "Strict mode: Offset %" PRId64
1300 " block status mismatch!\n",
1301 sectors_to_bytes(sector_num));
1302 goto out;
1303 }
1304 }
1305 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1306 nb_sectors = MIN(pnum1, pnum2);
1307 } else if (allocated1 == allocated2) {
1308 if (allocated1) {
1309 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1310 nb_sectors << BDRV_SECTOR_BITS);
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;
1317 }
1318 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1319 nb_sectors << BDRV_SECTOR_BITS);
1320 if (ret < 0) {
1321 error_report("Error while reading offset %" PRId64
1322 " of %s: %s", sectors_to_bytes(sector_num),
1323 filename2, strerror(-ret));
1324 ret = 4;
1325 goto out;
1326 }
1327 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1328 if (ret || pnum != nb_sectors) {
1329 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1330 sectors_to_bytes(
1331 ret ? sector_num : sector_num + pnum));
1332 ret = 1;
1333 goto out;
1334 }
1335 }
1336 } else {
1337
1338 if (allocated1) {
1339 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1340 filename1, buf1, quiet);
1341 } else {
1342 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1343 filename2, buf1, quiet);
1344 }
1345 if (ret) {
1346 if (ret < 0) {
1347 error_report("Error while reading offset %" PRId64 ": %s",
1348 sectors_to_bytes(sector_num), strerror(-ret));
1349 ret = 4;
1350 }
1351 goto out;
1352 }
1353 }
1354 sector_num += nb_sectors;
1355 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1356 }
1357
1358 if (total_sectors1 != total_sectors2) {
1359 BlockBackend *blk_over;
1360 int64_t total_sectors_over;
1361 const char *filename_over;
1362
1363 qprintf(quiet, "Warning: Image size mismatch!\n");
1364 if (total_sectors1 > total_sectors2) {
1365 total_sectors_over = total_sectors1;
1366 blk_over = blk1;
1367 filename_over = filename1;
1368 } else {
1369 total_sectors_over = total_sectors2;
1370 blk_over = blk2;
1371 filename_over = filename2;
1372 }
1373
1374 for (;;) {
1375 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1376 if (nb_sectors <= 0) {
1377 break;
1378 }
1379 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1380 nb_sectors, &pnum);
1381 if (ret < 0) {
1382 ret = 3;
1383 error_report("Sector allocation test failed for %s",
1384 filename_over);
1385 goto out;
1386
1387 }
1388 nb_sectors = pnum;
1389 if (ret) {
1390 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1391 filename_over, buf1, quiet);
1392 if (ret) {
1393 if (ret < 0) {
1394 error_report("Error while reading offset %" PRId64
1395 " of %s: %s", sectors_to_bytes(sector_num),
1396 filename_over, strerror(-ret));
1397 ret = 4;
1398 }
1399 goto out;
1400 }
1401 }
1402 sector_num += nb_sectors;
1403 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1404 }
1405 }
1406
1407 qprintf(quiet, "Images are identical.\n");
1408 ret = 0;
1409
1410 out:
1411 qemu_vfree(buf1);
1412 qemu_vfree(buf2);
1413 blk_unref(blk2);
1414 out2:
1415 blk_unref(blk1);
1416 out3:
1417 qemu_progress_end();
1418 out4:
1419 return ret;
1420 }
1421
1422 enum ImgConvertBlockStatus {
1423 BLK_DATA,
1424 BLK_ZERO,
1425 BLK_BACKING_FILE,
1426 };
1427
1428 typedef struct ImgConvertState {
1429 BlockBackend **src;
1430 int64_t *src_sectors;
1431 int src_cur, src_num;
1432 int64_t src_cur_offset;
1433 int64_t total_sectors;
1434 int64_t allocated_sectors;
1435 enum ImgConvertBlockStatus status;
1436 int64_t sector_next_status;
1437 BlockBackend *target;
1438 bool has_zero_init;
1439 bool compressed;
1440 bool target_has_backing;
1441 int min_sparse;
1442 size_t cluster_sectors;
1443 size_t buf_sectors;
1444 } ImgConvertState;
1445
1446 static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1447 {
1448 assert(sector_num >= s->src_cur_offset);
1449 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1450 s->src_cur_offset += s->src_sectors[s->src_cur];
1451 s->src_cur++;
1452 assert(s->src_cur < s->src_num);
1453 }
1454 }
1455
1456 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1457 {
1458 int64_t ret;
1459 int n;
1460
1461 convert_select_part(s, sector_num);
1462
1463 assert(s->total_sectors > sector_num);
1464 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1465
1466 if (s->sector_next_status <= sector_num) {
1467 BlockDriverState *file;
1468 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1469 sector_num - s->src_cur_offset,
1470 n, &n, &file);
1471 if (ret < 0) {
1472 return ret;
1473 }
1474
1475 if (ret & BDRV_BLOCK_ZERO) {
1476 s->status = BLK_ZERO;
1477 } else if (ret & BDRV_BLOCK_DATA) {
1478 s->status = BLK_DATA;
1479 } else if (!s->target_has_backing) {
1480 /* Without a target backing file we must copy over the contents of
1481 * the backing file as well. */
1482 /* Check block status of the backing file chain to avoid
1483 * needlessly reading zeroes and limiting the iteration to the
1484 * buffer size */
1485 ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
1486 sector_num - s->src_cur_offset,
1487 n, &n, &file);
1488 if (ret < 0) {
1489 return ret;
1490 }
1491
1492 if (ret & BDRV_BLOCK_ZERO) {
1493 s->status = BLK_ZERO;
1494 } else {
1495 s->status = BLK_DATA;
1496 }
1497 } else {
1498 s->status = BLK_BACKING_FILE;
1499 }
1500
1501 s->sector_next_status = sector_num + n;
1502 }
1503
1504 n = MIN(n, s->sector_next_status - sector_num);
1505 if (s->status == BLK_DATA) {
1506 n = MIN(n, s->buf_sectors);
1507 }
1508
1509 /* We need to write complete clusters for compressed images, so if an
1510 * unallocated area is shorter than that, we must consider the whole
1511 * cluster allocated. */
1512 if (s->compressed) {
1513 if (n < s->cluster_sectors) {
1514 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1515 s->status = BLK_DATA;
1516 } else {
1517 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1518 }
1519 }
1520
1521 return n;
1522 }
1523
1524 static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1525 uint8_t *buf)
1526 {
1527 int n;
1528 int ret;
1529
1530 assert(nb_sectors <= s->buf_sectors);
1531 while (nb_sectors > 0) {
1532 BlockBackend *blk;
1533 int64_t bs_sectors;
1534
1535 /* In the case of compression with multiple source files, we can get a
1536 * nb_sectors that spreads into the next part. So we must be able to
1537 * read across multiple BDSes for one convert_read() call. */
1538 convert_select_part(s, sector_num);
1539 blk = s->src[s->src_cur];
1540 bs_sectors = s->src_sectors[s->src_cur];
1541
1542 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1543 ret = blk_pread(blk,
1544 (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
1545 buf, n << BDRV_SECTOR_BITS);
1546 if (ret < 0) {
1547 return ret;
1548 }
1549
1550 sector_num += n;
1551 nb_sectors -= n;
1552 buf += n * BDRV_SECTOR_SIZE;
1553 }
1554
1555 return 0;
1556 }
1557
1558 static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1559 const uint8_t *buf)
1560 {
1561 int ret;
1562
1563 while (nb_sectors > 0) {
1564 int n = nb_sectors;
1565
1566 switch (s->status) {
1567 case BLK_BACKING_FILE:
1568 /* If we have a backing file, leave clusters unallocated that are
1569 * unallocated in the source image, so that the backing file is
1570 * visible at the respective offset. */
1571 assert(s->target_has_backing);
1572 break;
1573
1574 case BLK_DATA:
1575 /* We must always write compressed clusters as a whole, so don't
1576 * try to find zeroed parts in the buffer. We can only save the
1577 * write if the buffer is completely zeroed and we're allowed to
1578 * keep the target sparse. */
1579 if (s->compressed) {
1580 if (s->has_zero_init && s->min_sparse &&
1581 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1582 {
1583 assert(!s->target_has_backing);
1584 break;
1585 }
1586
1587 ret = blk_write_compressed(s->target, sector_num, buf, n);
1588 if (ret < 0) {
1589 return ret;
1590 }
1591 break;
1592 }
1593
1594 /* If there is real non-zero data or we're told to keep the target
1595 * fully allocated (-S 0), we must write it. Otherwise we can treat
1596 * it as zero sectors. */
1597 if (!s->min_sparse ||
1598 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1599 {
1600 ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1601 buf, n << BDRV_SECTOR_BITS, 0);
1602 if (ret < 0) {
1603 return ret;
1604 }
1605 break;
1606 }
1607 /* fall-through */
1608
1609 case BLK_ZERO:
1610 if (s->has_zero_init) {
1611 break;
1612 }
1613 ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
1614 n << BDRV_SECTOR_BITS, 0);
1615 if (ret < 0) {
1616 return ret;
1617 }
1618 break;
1619 }
1620
1621 sector_num += n;
1622 nb_sectors -= n;
1623 buf += n * BDRV_SECTOR_SIZE;
1624 }
1625
1626 return 0;
1627 }
1628
1629 static int convert_do_copy(ImgConvertState *s)
1630 {
1631 uint8_t *buf = NULL;
1632 int64_t sector_num, allocated_done;
1633 int ret;
1634 int n;
1635
1636 /* Check whether we have zero initialisation or can get it efficiently */
1637 s->has_zero_init = s->min_sparse && !s->target_has_backing
1638 ? bdrv_has_zero_init(blk_bs(s->target))
1639 : false;
1640
1641 if (!s->has_zero_init && !s->target_has_backing &&
1642 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1643 {
1644 ret = bdrv_make_zero(blk_bs(s->target), BDRV_REQ_MAY_UNMAP);
1645 if (ret == 0) {
1646 s->has_zero_init = true;
1647 }
1648 }
1649
1650 /* Allocate buffer for copied data. For compressed images, only one cluster
1651 * can be copied at a time. */
1652 if (s->compressed) {
1653 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1654 error_report("invalid cluster size");
1655 ret = -EINVAL;
1656 goto fail;
1657 }
1658 s->buf_sectors = s->cluster_sectors;
1659 }
1660 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1661
1662 /* Calculate allocated sectors for progress */
1663 s->allocated_sectors = 0;
1664 sector_num = 0;
1665 while (sector_num < s->total_sectors) {
1666 n = convert_iteration_sectors(s, sector_num);
1667 if (n < 0) {
1668 ret = n;
1669 goto fail;
1670 }
1671 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1672 {
1673 s->allocated_sectors += n;
1674 }
1675 sector_num += n;
1676 }
1677
1678 /* Do the copy */
1679 s->src_cur = 0;
1680 s->src_cur_offset = 0;
1681 s->sector_next_status = 0;
1682
1683 sector_num = 0;
1684 allocated_done = 0;
1685
1686 while (sector_num < s->total_sectors) {
1687 n = convert_iteration_sectors(s, sector_num);
1688 if (n < 0) {
1689 ret = n;
1690 goto fail;
1691 }
1692 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1693 {
1694 allocated_done += n;
1695 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1696 0);
1697 }
1698
1699 if (s->status == BLK_DATA) {
1700 ret = convert_read(s, sector_num, n, buf);
1701 if (ret < 0) {
1702 error_report("error while reading sector %" PRId64
1703 ": %s", sector_num, strerror(-ret));
1704 goto fail;
1705 }
1706 } else if (!s->min_sparse && s->status == BLK_ZERO) {
1707 n = MIN(n, s->buf_sectors);
1708 memset(buf, 0, n * BDRV_SECTOR_SIZE);
1709 s->status = BLK_DATA;
1710 }
1711
1712 ret = convert_write(s, sector_num, n, buf);
1713 if (ret < 0) {
1714 error_report("error while writing sector %" PRId64
1715 ": %s", sector_num, strerror(-ret));
1716 goto fail;
1717 }
1718
1719 sector_num += n;
1720 }
1721
1722 if (s->compressed) {
1723 /* signal EOF to align */
1724 ret = blk_write_compressed(s->target, 0, NULL, 0);
1725 if (ret < 0) {
1726 goto fail;
1727 }
1728 }
1729
1730 ret = 0;
1731 fail:
1732 qemu_vfree(buf);
1733 return ret;
1734 }
1735
1736 static int img_convert(int argc, char **argv)
1737 {
1738 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1739 int64_t ret = 0;
1740 int progress = 0, flags, src_flags;
1741 bool writethrough, src_writethrough;
1742 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1743 BlockDriver *drv, *proto_drv;
1744 BlockBackend **blk = NULL, *out_blk = NULL;
1745 BlockDriverState **bs = NULL, *out_bs = NULL;
1746 int64_t total_sectors;
1747 int64_t *bs_sectors = NULL;
1748 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1749 BlockDriverInfo bdi;
1750 QemuOpts *opts = NULL;
1751 QemuOptsList *create_opts = NULL;
1752 const char *out_baseimg_param;
1753 char *options = NULL;
1754 const char *snapshot_name = NULL;
1755 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1756 bool quiet = false;
1757 Error *local_err = NULL;
1758 QemuOpts *sn_opts = NULL;
1759 ImgConvertState state;
1760 bool image_opts = false;
1761
1762 fmt = NULL;
1763 out_fmt = "raw";
1764 cache = "unsafe";
1765 src_cache = BDRV_DEFAULT_CACHE;
1766 out_baseimg = NULL;
1767 compress = 0;
1768 skip_create = 0;
1769 for(;;) {
1770 static const struct option long_options[] = {
1771 {"help", no_argument, 0, 'h'},
1772 {"object", required_argument, 0, OPTION_OBJECT},
1773 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1774 {0, 0, 0, 0}
1775 };
1776 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1777 long_options, NULL);
1778 if (c == -1) {
1779 break;
1780 }
1781 switch(c) {
1782 case '?':
1783 case 'h':
1784 help();
1785 break;
1786 case 'f':
1787 fmt = optarg;
1788 break;
1789 case 'O':
1790 out_fmt = optarg;
1791 break;
1792 case 'B':
1793 out_baseimg = optarg;
1794 break;
1795 case 'c':
1796 compress = 1;
1797 break;
1798 case 'e':
1799 error_report("option -e is deprecated, please use \'-o "
1800 "encryption\' instead!");
1801 ret = -1;
1802 goto fail_getopt;
1803 case '6':
1804 error_report("option -6 is deprecated, please use \'-o "
1805 "compat6\' instead!");
1806 ret = -1;
1807 goto fail_getopt;
1808 case 'o':
1809 if (!is_valid_option_list(optarg)) {
1810 error_report("Invalid option list: %s", optarg);
1811 ret = -1;
1812 goto fail_getopt;
1813 }
1814 if (!options) {
1815 options = g_strdup(optarg);
1816 } else {
1817 char *old_options = options;
1818 options = g_strdup_printf("%s,%s", options, optarg);
1819 g_free(old_options);
1820 }
1821 break;
1822 case 's':
1823 snapshot_name = optarg;
1824 break;
1825 case 'l':
1826 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1827 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1828 optarg, false);
1829 if (!sn_opts) {
1830 error_report("Failed in parsing snapshot param '%s'",
1831 optarg);
1832 ret = -1;
1833 goto fail_getopt;
1834 }
1835 } else {
1836 snapshot_name = optarg;
1837 }
1838 break;
1839 case 'S':
1840 {
1841 int64_t sval;
1842 char *end;
1843 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1844 if (sval < 0 || *end) {
1845 error_report("Invalid minimum zero buffer size for sparse output specified");
1846 ret = -1;
1847 goto fail_getopt;
1848 }
1849
1850 min_sparse = sval / BDRV_SECTOR_SIZE;
1851 break;
1852 }
1853 case 'p':
1854 progress = 1;
1855 break;
1856 case 't':
1857 cache = optarg;
1858 break;
1859 case 'T':
1860 src_cache = optarg;
1861 break;
1862 case 'q':
1863 quiet = true;
1864 break;
1865 case 'n':
1866 skip_create = 1;
1867 break;
1868 case OPTION_OBJECT:
1869 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1870 optarg, true);
1871 if (!opts) {
1872 goto fail_getopt;
1873 }
1874 break;
1875 case OPTION_IMAGE_OPTS:
1876 image_opts = true;
1877 break;
1878 }
1879 }
1880
1881 if (qemu_opts_foreach(&qemu_object_opts,
1882 user_creatable_add_opts_foreach,
1883 NULL, NULL)) {
1884 goto fail_getopt;
1885 }
1886
1887 /* Initialize before goto out */
1888 if (quiet) {
1889 progress = 0;
1890 }
1891 qemu_progress_init(progress, 1.0);
1892
1893 bs_n = argc - optind - 1;
1894 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1895
1896 if (options && has_help_option(options)) {
1897 ret = print_block_option_help(out_filename, out_fmt);
1898 goto out;
1899 }
1900
1901 if (bs_n < 1) {
1902 error_exit("Must specify image file name");
1903 }
1904
1905
1906 if (bs_n > 1 && out_baseimg) {
1907 error_report("-B makes no sense when concatenating multiple input "
1908 "images");
1909 ret = -1;
1910 goto out;
1911 }
1912
1913 src_flags = 0;
1914 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1915 if (ret < 0) {
1916 error_report("Invalid source cache option: %s", src_cache);
1917 goto out;
1918 }
1919
1920 qemu_progress_print(0, 100);
1921
1922 blk = g_new0(BlockBackend *, bs_n);
1923 bs = g_new0(BlockDriverState *, bs_n);
1924 bs_sectors = g_new(int64_t, bs_n);
1925
1926 total_sectors = 0;
1927 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1928 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1929 fmt, src_flags, src_writethrough, quiet);
1930 if (!blk[bs_i]) {
1931 ret = -1;
1932 goto out;
1933 }
1934 bs[bs_i] = blk_bs(blk[bs_i]);
1935 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1936 if (bs_sectors[bs_i] < 0) {
1937 error_report("Could not get size of %s: %s",
1938 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1939 ret = -1;
1940 goto out;
1941 }
1942 total_sectors += bs_sectors[bs_i];
1943 }
1944
1945 if (sn_opts) {
1946 ret = bdrv_snapshot_load_tmp(bs[0],
1947 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1948 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1949 &local_err);
1950 } else if (snapshot_name != NULL) {
1951 if (bs_n > 1) {
1952 error_report("No support for concatenating multiple snapshot");
1953 ret = -1;
1954 goto out;
1955 }
1956
1957 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1958 }
1959 if (local_err) {
1960 error_reportf_err(local_err, "Failed to load snapshot: ");
1961 ret = -1;
1962 goto out;
1963 }
1964
1965 /* Find driver and parse its options */
1966 drv = bdrv_find_format(out_fmt);
1967 if (!drv) {
1968 error_report("Unknown file format '%s'", out_fmt);
1969 ret = -1;
1970 goto out;
1971 }
1972
1973 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1974 if (!proto_drv) {
1975 error_report_err(local_err);
1976 ret = -1;
1977 goto out;
1978 }
1979
1980 if (!skip_create) {
1981 if (!drv->create_opts) {
1982 error_report("Format driver '%s' does not support image creation",
1983 drv->format_name);
1984 ret = -1;
1985 goto out;
1986 }
1987
1988 if (!proto_drv->create_opts) {
1989 error_report("Protocol driver '%s' does not support image creation",
1990 proto_drv->format_name);
1991 ret = -1;
1992 goto out;
1993 }
1994
1995 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1996 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1997
1998 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1999 if (options) {
2000 qemu_opts_do_parse(opts, options, NULL, &local_err);
2001 if (local_err) {
2002 error_report_err(local_err);
2003 ret = -1;
2004 goto out;
2005 }
2006 }
2007
2008 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
2009 &error_abort);
2010 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2011 if (ret < 0) {
2012 goto out;
2013 }
2014 }
2015
2016 /* Get backing file name if -o backing_file was used */
2017 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2018 if (out_baseimg_param) {
2019 out_baseimg = out_baseimg_param;
2020 }
2021
2022 /* Check if compression is supported */
2023 if (compress) {
2024 bool encryption =
2025 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2026 const char *preallocation =
2027 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2028
2029 if (!drv->bdrv_write_compressed) {
2030 error_report("Compression not supported for this file format");
2031 ret = -1;
2032 goto out;
2033 }
2034
2035 if (encryption) {
2036 error_report("Compression and encryption not supported at "
2037 "the same time");
2038 ret = -1;
2039 goto out;
2040 }
2041
2042 if (preallocation
2043 && strcmp(preallocation, "off"))
2044 {
2045 error_report("Compression and preallocation not supported at "
2046 "the same time");
2047 ret = -1;
2048 goto out;
2049 }
2050 }
2051
2052 if (!skip_create) {
2053 /* Create the new image */
2054 ret = bdrv_create(drv, out_filename, opts, &local_err);
2055 if (ret < 0) {
2056 error_reportf_err(local_err, "%s: error while converting %s: ",
2057 out_filename, out_fmt);
2058 goto out;
2059 }
2060 }
2061
2062 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2063 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2064 if (ret < 0) {
2065 error_report("Invalid cache option: %s", cache);
2066 goto out;
2067 }
2068
2069 /* XXX we should allow --image-opts to trigger use of
2070 * img_open() here, but then we have trouble with
2071 * the bdrv_create() call which takes different params.
2072 * Not critical right now, so fix can wait...
2073 */
2074 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2075 if (!out_blk) {
2076 ret = -1;
2077 goto out;
2078 }
2079 out_bs = blk_bs(out_blk);
2080
2081 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
2082 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2083 * as maximum. */
2084 bufsectors = MIN(32768,
2085 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
2086 out_bs->bl.discard_alignment))
2087 );
2088
2089 if (skip_create) {
2090 int64_t output_sectors = blk_nb_sectors(out_blk);
2091 if (output_sectors < 0) {
2092 error_report("unable to get output image length: %s",
2093 strerror(-output_sectors));
2094 ret = -1;
2095 goto out;
2096 } else if (output_sectors < total_sectors) {
2097 error_report("output file is smaller than input file");
2098 ret = -1;
2099 goto out;
2100 }
2101 }
2102
2103 cluster_sectors = 0;
2104 ret = bdrv_get_info(out_bs, &bdi);
2105 if (ret < 0) {
2106 if (compress) {
2107 error_report("could not get block driver info");
2108 goto out;
2109 }
2110 } else {
2111 compress = compress || bdi.needs_compressed_writes;
2112 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2113 }
2114
2115 state = (ImgConvertState) {
2116 .src = blk,
2117 .src_sectors = bs_sectors,
2118 .src_num = bs_n,
2119 .total_sectors = total_sectors,
2120 .target = out_blk,
2121 .compressed = compress,
2122 .target_has_backing = (bool) out_baseimg,
2123 .min_sparse = min_sparse,
2124 .cluster_sectors = cluster_sectors,
2125 .buf_sectors = bufsectors,
2126 };
2127 ret = convert_do_copy(&state);
2128
2129 out:
2130 if (!ret) {
2131 qemu_progress_print(100, 0);
2132 }
2133 qemu_progress_end();
2134 qemu_opts_del(opts);
2135 qemu_opts_free(create_opts);
2136 qemu_opts_del(sn_opts);
2137 blk_unref(out_blk);
2138 g_free(bs);
2139 if (blk) {
2140 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2141 blk_unref(blk[bs_i]);
2142 }
2143 g_free(blk);
2144 }
2145 g_free(bs_sectors);
2146 fail_getopt:
2147 g_free(options);
2148
2149 if (ret) {
2150 return 1;
2151 }
2152 return 0;
2153 }
2154
2155
2156 static void dump_snapshots(BlockDriverState *bs)
2157 {
2158 QEMUSnapshotInfo *sn_tab, *sn;
2159 int nb_sns, i;
2160
2161 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2162 if (nb_sns <= 0)
2163 return;
2164 printf("Snapshot list:\n");
2165 bdrv_snapshot_dump(fprintf, stdout, NULL);
2166 printf("\n");
2167 for(i = 0; i < nb_sns; i++) {
2168 sn = &sn_tab[i];
2169 bdrv_snapshot_dump(fprintf, stdout, sn);
2170 printf("\n");
2171 }
2172 g_free(sn_tab);
2173 }
2174
2175 static void dump_json_image_info_list(ImageInfoList *list)
2176 {
2177 Error *local_err = NULL;
2178 QString *str;
2179 QmpOutputVisitor *ov = qmp_output_visitor_new();
2180 QObject *obj;
2181 visit_type_ImageInfoList(qmp_output_get_visitor(ov), NULL, &list,
2182 &local_err);
2183 obj = qmp_output_get_qobject(ov);
2184 str = qobject_to_json_pretty(obj);
2185 assert(str != NULL);
2186 printf("%s\n", qstring_get_str(str));
2187 qobject_decref(obj);
2188 qmp_output_visitor_cleanup(ov);
2189 QDECREF(str);
2190 }
2191
2192 static void dump_json_image_info(ImageInfo *info)
2193 {
2194 Error *local_err = NULL;
2195 QString *str;
2196 QmpOutputVisitor *ov = qmp_output_visitor_new();
2197 QObject *obj;
2198 visit_type_ImageInfo(qmp_output_get_visitor(ov), NULL, &info, &local_err);
2199 obj = qmp_output_get_qobject(ov);
2200 str = qobject_to_json_pretty(obj);
2201 assert(str != NULL);
2202 printf("%s\n", qstring_get_str(str));
2203 qobject_decref(obj);
2204 qmp_output_visitor_cleanup(ov);
2205 QDECREF(str);
2206 }
2207
2208 static void dump_human_image_info_list(ImageInfoList *list)
2209 {
2210 ImageInfoList *elem;
2211 bool delim = false;
2212
2213 for (elem = list; elem; elem = elem->next) {
2214 if (delim) {
2215 printf("\n");
2216 }
2217 delim = true;
2218
2219 bdrv_image_info_dump(fprintf, stdout, elem->value);
2220 }
2221 }
2222
2223 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2224 {
2225 return strcmp(a, b) == 0;
2226 }
2227
2228 /**
2229 * Open an image file chain and return an ImageInfoList
2230 *
2231 * @filename: topmost image filename
2232 * @fmt: topmost image format (may be NULL to autodetect)
2233 * @chain: true - enumerate entire backing file chain
2234 * false - only topmost image file
2235 *
2236 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2237 * image file. If there was an error a message will have been printed to
2238 * stderr.
2239 */
2240 static ImageInfoList *collect_image_info_list(bool image_opts,
2241 const char *filename,
2242 const char *fmt,
2243 bool chain)
2244 {
2245 ImageInfoList *head = NULL;
2246 ImageInfoList **last = &head;
2247 GHashTable *filenames;
2248 Error *err = NULL;
2249
2250 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2251
2252 while (filename) {
2253 BlockBackend *blk;
2254 BlockDriverState *bs;
2255 ImageInfo *info;
2256 ImageInfoList *elem;
2257
2258 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2259 error_report("Backing file '%s' creates an infinite loop.",
2260 filename);
2261 goto err;
2262 }
2263 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2264
2265 blk = img_open(image_opts, filename, fmt,
2266 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2267 if (!blk) {
2268 goto err;
2269 }
2270 bs = blk_bs(blk);
2271
2272 bdrv_query_image_info(bs, &info, &err);
2273 if (err) {
2274 error_report_err(err);
2275 blk_unref(blk);
2276 goto err;
2277 }
2278
2279 elem = g_new0(ImageInfoList, 1);
2280 elem->value = info;
2281 *last = elem;
2282 last = &elem->next;
2283
2284 blk_unref(blk);
2285
2286 filename = fmt = NULL;
2287 if (chain) {
2288 if (info->has_full_backing_filename) {
2289 filename = info->full_backing_filename;
2290 } else if (info->has_backing_filename) {
2291 error_report("Could not determine absolute backing filename,"
2292 " but backing filename '%s' present",
2293 info->backing_filename);
2294 goto err;
2295 }
2296 if (info->has_backing_filename_format) {
2297 fmt = info->backing_filename_format;
2298 }
2299 }
2300 }
2301 g_hash_table_destroy(filenames);
2302 return head;
2303
2304 err:
2305 qapi_free_ImageInfoList(head);
2306 g_hash_table_destroy(filenames);
2307 return NULL;
2308 }
2309
2310 static int img_info(int argc, char **argv)
2311 {
2312 int c;
2313 OutputFormat output_format = OFORMAT_HUMAN;
2314 bool chain = false;
2315 const char *filename, *fmt, *output;
2316 ImageInfoList *list;
2317 bool image_opts = false;
2318
2319 fmt = NULL;
2320 output = NULL;
2321 for(;;) {
2322 int option_index = 0;
2323 static const struct option long_options[] = {
2324 {"help", no_argument, 0, 'h'},
2325 {"format", required_argument, 0, 'f'},
2326 {"output", required_argument, 0, OPTION_OUTPUT},
2327 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2328 {"object", required_argument, 0, OPTION_OBJECT},
2329 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2330 {0, 0, 0, 0}
2331 };
2332 c = getopt_long(argc, argv, "f:h",
2333 long_options, &option_index);
2334 if (c == -1) {
2335 break;
2336 }
2337 switch(c) {
2338 case '?':
2339 case 'h':
2340 help();
2341 break;
2342 case 'f':
2343 fmt = optarg;
2344 break;
2345 case OPTION_OUTPUT:
2346 output = optarg;
2347 break;
2348 case OPTION_BACKING_CHAIN:
2349 chain = true;
2350 break;
2351 case OPTION_OBJECT: {
2352 QemuOpts *opts;
2353 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2354 optarg, true);
2355 if (!opts) {
2356 return 1;
2357 }
2358 } break;
2359 case OPTION_IMAGE_OPTS:
2360 image_opts = true;
2361 break;
2362 }
2363 }
2364 if (optind != argc - 1) {
2365 error_exit("Expecting one image file name");
2366 }
2367 filename = argv[optind++];
2368
2369 if (output && !strcmp(output, "json")) {
2370 output_format = OFORMAT_JSON;
2371 } else if (output && !strcmp(output, "human")) {
2372 output_format = OFORMAT_HUMAN;
2373 } else if (output) {
2374 error_report("--output must be used with human or json as argument.");
2375 return 1;
2376 }
2377
2378 if (qemu_opts_foreach(&qemu_object_opts,
2379 user_creatable_add_opts_foreach,
2380 NULL, NULL)) {
2381 return 1;
2382 }
2383
2384 list = collect_image_info_list(image_opts, filename, fmt, chain);
2385 if (!list) {
2386 return 1;
2387 }
2388
2389 switch (output_format) {
2390 case OFORMAT_HUMAN:
2391 dump_human_image_info_list(list);
2392 break;
2393 case OFORMAT_JSON:
2394 if (chain) {
2395 dump_json_image_info_list(list);
2396 } else {
2397 dump_json_image_info(list->value);
2398 }
2399 break;
2400 }
2401
2402 qapi_free_ImageInfoList(list);
2403 return 0;
2404 }
2405
2406 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2407 MapEntry *next)
2408 {
2409 switch (output_format) {
2410 case OFORMAT_HUMAN:
2411 if (e->data && !e->has_offset) {
2412 error_report("File contains external, encrypted or compressed clusters.");
2413 exit(1);
2414 }
2415 if (e->data && !e->zero) {
2416 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2417 e->start, e->length,
2418 e->has_offset ? e->offset : 0,
2419 e->has_filename ? e->filename : "");
2420 }
2421 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2422 * Modify the flags here to allow more coalescing.
2423 */
2424 if (next && (!next->data || next->zero)) {
2425 next->data = false;
2426 next->zero = true;
2427 }
2428 break;
2429 case OFORMAT_JSON:
2430 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2431 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2432 (e->start == 0 ? "[" : ",\n"),
2433 e->start, e->length, e->depth,
2434 e->zero ? "true" : "false",
2435 e->data ? "true" : "false");
2436 if (e->has_offset) {
2437 printf(", \"offset\": %"PRId64"", e->offset);
2438 }
2439 putchar('}');
2440
2441 if (!next) {
2442 printf("]\n");
2443 }
2444 break;
2445 }
2446 }
2447
2448 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2449 int nb_sectors, MapEntry *e)
2450 {
2451 int64_t ret;
2452 int depth;
2453 BlockDriverState *file;
2454 bool has_offset;
2455
2456 /* As an optimization, we could cache the current range of unallocated
2457 * clusters in each file of the chain, and avoid querying the same
2458 * range repeatedly.
2459 */
2460
2461 depth = 0;
2462 for (;;) {
2463 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2464 &file);
2465 if (ret < 0) {
2466 return ret;
2467 }
2468 assert(nb_sectors);
2469 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2470 break;
2471 }
2472 bs = backing_bs(bs);
2473 if (bs == NULL) {
2474 ret = 0;
2475 break;
2476 }
2477
2478 depth++;
2479 }
2480
2481 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2482
2483 *e = (MapEntry) {
2484 .start = sector_num * BDRV_SECTOR_SIZE,
2485 .length = nb_sectors * BDRV_SECTOR_SIZE,
2486 .data = !!(ret & BDRV_BLOCK_DATA),
2487 .zero = !!(ret & BDRV_BLOCK_ZERO),
2488 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2489 .has_offset = has_offset,
2490 .depth = depth,
2491 .has_filename = file && has_offset,
2492 .filename = file && has_offset ? file->filename : NULL,
2493 };
2494
2495 return 0;
2496 }
2497
2498 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2499 {
2500 if (curr->length == 0) {
2501 return false;
2502 }
2503 if (curr->zero != next->zero ||
2504 curr->data != next->data ||
2505 curr->depth != next->depth ||
2506 curr->has_filename != next->has_filename ||
2507 curr->has_offset != next->has_offset) {
2508 return false;
2509 }
2510 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2511 return false;
2512 }
2513 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2514 return false;
2515 }
2516 return true;
2517 }
2518
2519 static int img_map(int argc, char **argv)
2520 {
2521 int c;
2522 OutputFormat output_format = OFORMAT_HUMAN;
2523 BlockBackend *blk;
2524 BlockDriverState *bs;
2525 const char *filename, *fmt, *output;
2526 int64_t length;
2527 MapEntry curr = { .length = 0 }, next;
2528 int ret = 0;
2529 bool image_opts = false;
2530
2531 fmt = NULL;
2532 output = NULL;
2533 for (;;) {
2534 int option_index = 0;
2535 static const struct option long_options[] = {
2536 {"help", no_argument, 0, 'h'},
2537 {"format", required_argument, 0, 'f'},
2538 {"output", required_argument, 0, OPTION_OUTPUT},
2539 {"object", required_argument, 0, OPTION_OBJECT},
2540 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2541 {0, 0, 0, 0}
2542 };
2543 c = getopt_long(argc, argv, "f:h",
2544 long_options, &option_index);
2545 if (c == -1) {
2546 break;
2547 }
2548 switch (c) {
2549 case '?':
2550 case 'h':
2551 help();
2552 break;
2553 case 'f':
2554 fmt = optarg;
2555 break;
2556 case OPTION_OUTPUT:
2557 output = optarg;
2558 break;
2559 case OPTION_OBJECT: {
2560 QemuOpts *opts;
2561 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2562 optarg, true);
2563 if (!opts) {
2564 return 1;
2565 }
2566 } break;
2567 case OPTION_IMAGE_OPTS:
2568 image_opts = true;
2569 break;
2570 }
2571 }
2572 if (optind != argc - 1) {
2573 error_exit("Expecting one image file name");
2574 }
2575 filename = argv[optind];
2576
2577 if (output && !strcmp(output, "json")) {
2578 output_format = OFORMAT_JSON;
2579 } else if (output && !strcmp(output, "human")) {
2580 output_format = OFORMAT_HUMAN;
2581 } else if (output) {
2582 error_report("--output must be used with human or json as argument.");
2583 return 1;
2584 }
2585
2586 if (qemu_opts_foreach(&qemu_object_opts,
2587 user_creatable_add_opts_foreach,
2588 NULL, NULL)) {
2589 return 1;
2590 }
2591
2592 blk = img_open(image_opts, filename, fmt, 0, false, false);
2593 if (!blk) {
2594 return 1;
2595 }
2596 bs = blk_bs(blk);
2597
2598 if (output_format == OFORMAT_HUMAN) {
2599 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2600 }
2601
2602 length = blk_getlength(blk);
2603 while (curr.start + curr.length < length) {
2604 int64_t nsectors_left;
2605 int64_t sector_num;
2606 int n;
2607
2608 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2609
2610 /* Probe up to 1 GiB at a time. */
2611 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2612 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2613 ret = get_block_status(bs, sector_num, n, &next);
2614
2615 if (ret < 0) {
2616 error_report("Could not read file metadata: %s", strerror(-ret));
2617 goto out;
2618 }
2619
2620 if (entry_mergeable(&curr, &next)) {
2621 curr.length += next.length;
2622 continue;
2623 }
2624
2625 if (curr.length > 0) {
2626 dump_map_entry(output_format, &curr, &next);
2627 }
2628 curr = next;
2629 }
2630
2631 dump_map_entry(output_format, &curr, NULL);
2632
2633 out:
2634 blk_unref(blk);
2635 return ret < 0;
2636 }
2637
2638 #define SNAPSHOT_LIST 1
2639 #define SNAPSHOT_CREATE 2
2640 #define SNAPSHOT_APPLY 3
2641 #define SNAPSHOT_DELETE 4
2642
2643 static int img_snapshot(int argc, char **argv)
2644 {
2645 BlockBackend *blk;
2646 BlockDriverState *bs;
2647 QEMUSnapshotInfo sn;
2648 char *filename, *snapshot_name = NULL;
2649 int c, ret = 0, bdrv_oflags;
2650 int action = 0;
2651 qemu_timeval tv;
2652 bool quiet = false;
2653 Error *err = NULL;
2654 bool image_opts = false;
2655
2656 bdrv_oflags = BDRV_O_RDWR;
2657 /* Parse commandline parameters */
2658 for(;;) {
2659 static const struct option long_options[] = {
2660 {"help", no_argument, 0, 'h'},
2661 {"object", required_argument, 0, OPTION_OBJECT},
2662 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2663 {0, 0, 0, 0}
2664 };
2665 c = getopt_long(argc, argv, "la:c:d:hq",
2666 long_options, NULL);
2667 if (c == -1) {
2668 break;
2669 }
2670 switch(c) {
2671 case '?':
2672 case 'h':
2673 help();
2674 return 0;
2675 case 'l':
2676 if (action) {
2677 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2678 return 0;
2679 }
2680 action = SNAPSHOT_LIST;
2681 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2682 break;
2683 case 'a':
2684 if (action) {
2685 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2686 return 0;
2687 }
2688 action = SNAPSHOT_APPLY;
2689 snapshot_name = optarg;
2690 break;
2691 case 'c':
2692 if (action) {
2693 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2694 return 0;
2695 }
2696 action = SNAPSHOT_CREATE;
2697 snapshot_name = optarg;
2698 break;
2699 case 'd':
2700 if (action) {
2701 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2702 return 0;
2703 }
2704 action = SNAPSHOT_DELETE;
2705 snapshot_name = optarg;
2706 break;
2707 case 'q':
2708 quiet = true;
2709 break;
2710 case OPTION_OBJECT: {
2711 QemuOpts *opts;
2712 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2713 optarg, true);
2714 if (!opts) {
2715 return 1;
2716 }
2717 } break;
2718 case OPTION_IMAGE_OPTS:
2719 image_opts = true;
2720 break;
2721 }
2722 }
2723
2724 if (optind != argc - 1) {
2725 error_exit("Expecting one image file name");
2726 }
2727 filename = argv[optind++];
2728
2729 if (qemu_opts_foreach(&qemu_object_opts,
2730 user_creatable_add_opts_foreach,
2731 NULL, NULL)) {
2732 return 1;
2733 }
2734
2735 /* Open the image */
2736 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2737 if (!blk) {
2738 return 1;
2739 }
2740 bs = blk_bs(blk);
2741
2742 /* Perform the requested action */
2743 switch(action) {
2744 case SNAPSHOT_LIST:
2745 dump_snapshots(bs);
2746 break;
2747
2748 case SNAPSHOT_CREATE:
2749 memset(&sn, 0, sizeof(sn));
2750 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2751
2752 qemu_gettimeofday(&tv);
2753 sn.date_sec = tv.tv_sec;
2754 sn.date_nsec = tv.tv_usec * 1000;
2755
2756 ret = bdrv_snapshot_create(bs, &sn);
2757 if (ret) {
2758 error_report("Could not create snapshot '%s': %d (%s)",
2759 snapshot_name, ret, strerror(-ret));
2760 }
2761 break;
2762
2763 case SNAPSHOT_APPLY:
2764 ret = bdrv_snapshot_goto(bs, snapshot_name);
2765 if (ret) {
2766 error_report("Could not apply snapshot '%s': %d (%s)",
2767 snapshot_name, ret, strerror(-ret));
2768 }
2769 break;
2770
2771 case SNAPSHOT_DELETE:
2772 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2773 if (err) {
2774 error_reportf_err(err, "Could not delete snapshot '%s': ",
2775 snapshot_name);
2776 ret = 1;
2777 }
2778 break;
2779 }
2780
2781 /* Cleanup */
2782 blk_unref(blk);
2783 if (ret) {
2784 return 1;
2785 }
2786 return 0;
2787 }
2788
2789 static int img_rebase(int argc, char **argv)
2790 {
2791 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2792 uint8_t *buf_old = NULL;
2793 uint8_t *buf_new = NULL;
2794 BlockDriverState *bs = NULL;
2795 char *filename;
2796 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2797 int c, flags, src_flags, ret;
2798 bool writethrough, src_writethrough;
2799 int unsafe = 0;
2800 int progress = 0;
2801 bool quiet = false;
2802 Error *local_err = NULL;
2803 bool image_opts = false;
2804
2805 /* Parse commandline parameters */
2806 fmt = NULL;
2807 cache = BDRV_DEFAULT_CACHE;
2808 src_cache = BDRV_DEFAULT_CACHE;
2809 out_baseimg = NULL;
2810 out_basefmt = NULL;
2811 for(;;) {
2812 static const struct option long_options[] = {
2813 {"help", no_argument, 0, 'h'},
2814 {"object", required_argument, 0, OPTION_OBJECT},
2815 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2816 {0, 0, 0, 0}
2817 };
2818 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2819 long_options, NULL);
2820 if (c == -1) {
2821 break;
2822 }
2823 switch(c) {
2824 case '?':
2825 case 'h':
2826 help();
2827 return 0;
2828 case 'f':
2829 fmt = optarg;
2830 break;
2831 case 'F':
2832 out_basefmt = optarg;
2833 break;
2834 case 'b':
2835 out_baseimg = optarg;
2836 break;
2837 case 'u':
2838 unsafe = 1;
2839 break;
2840 case 'p':
2841 progress = 1;
2842 break;
2843 case 't':
2844 cache = optarg;
2845 break;
2846 case 'T':
2847 src_cache = optarg;
2848 break;
2849 case 'q':
2850 quiet = true;
2851 break;
2852 case OPTION_OBJECT: {
2853 QemuOpts *opts;
2854 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2855 optarg, true);
2856 if (!opts) {
2857 return 1;
2858 }
2859 } break;
2860 case OPTION_IMAGE_OPTS:
2861 image_opts = true;
2862 break;
2863 }
2864 }
2865
2866 if (quiet) {
2867 progress = 0;
2868 }
2869
2870 if (optind != argc - 1) {
2871 error_exit("Expecting one image file name");
2872 }
2873 if (!unsafe && !out_baseimg) {
2874 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2875 }
2876 filename = argv[optind++];
2877
2878 if (qemu_opts_foreach(&qemu_object_opts,
2879 user_creatable_add_opts_foreach,
2880 NULL, NULL)) {
2881 return 1;
2882 }
2883
2884 qemu_progress_init(progress, 2.0);
2885 qemu_progress_print(0, 100);
2886
2887 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2888 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2889 if (ret < 0) {
2890 error_report("Invalid cache option: %s", cache);
2891 goto out;
2892 }
2893
2894 src_flags = 0;
2895 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2896 if (ret < 0) {
2897 error_report("Invalid source cache option: %s", src_cache);
2898 goto out;
2899 }
2900
2901 /* The source files are opened read-only, don't care about WCE */
2902 assert((src_flags & BDRV_O_RDWR) == 0);
2903 (void) src_writethrough;
2904
2905 /*
2906 * Open the images.
2907 *
2908 * Ignore the old backing file for unsafe rebase in case we want to correct
2909 * the reference to a renamed or moved backing file.
2910 */
2911 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2912 if (!blk) {
2913 ret = -1;
2914 goto out;
2915 }
2916 bs = blk_bs(blk);
2917
2918 if (out_basefmt != NULL) {
2919 if (bdrv_find_format(out_basefmt) == NULL) {
2920 error_report("Invalid format name: '%s'", out_basefmt);
2921 ret = -1;
2922 goto out;
2923 }
2924 }
2925
2926 /* For safe rebasing we need to compare old and new backing file */
2927 if (!unsafe) {
2928 char backing_name[PATH_MAX];
2929 QDict *options = NULL;
2930
2931 if (bs->backing_format[0] != '\0') {
2932 options = qdict_new();
2933 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2934 }
2935
2936 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2937 blk_old_backing = blk_new_open(backing_name, NULL,
2938 options, src_flags, &local_err);
2939 if (!blk_old_backing) {
2940 error_reportf_err(local_err,
2941 "Could not open old backing file '%s': ",
2942 backing_name);
2943 goto out;
2944 }
2945
2946 if (out_baseimg[0]) {
2947 if (out_basefmt) {
2948 options = qdict_new();
2949 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2950 } else {
2951 options = NULL;
2952 }
2953
2954 blk_new_backing = blk_new_open(out_baseimg, NULL,
2955 options, src_flags, &local_err);
2956 if (!blk_new_backing) {
2957 error_reportf_err(local_err,
2958 "Could not open new backing file '%s': ",
2959 out_baseimg);
2960 goto out;
2961 }
2962 }
2963 }
2964
2965 /*
2966 * Check each unallocated cluster in the COW file. If it is unallocated,
2967 * accesses go to the backing file. We must therefore compare this cluster
2968 * in the old and new backing file, and if they differ we need to copy it
2969 * from the old backing file into the COW file.
2970 *
2971 * If qemu-img crashes during this step, no harm is done. The content of
2972 * the image is the same as the original one at any time.
2973 */
2974 if (!unsafe) {
2975 int64_t num_sectors;
2976 int64_t old_backing_num_sectors;
2977 int64_t new_backing_num_sectors = 0;
2978 uint64_t sector;
2979 int n;
2980 float local_progress = 0;
2981
2982 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
2983 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
2984
2985 num_sectors = blk_nb_sectors(blk);
2986 if (num_sectors < 0) {
2987 error_report("Could not get size of '%s': %s",
2988 filename, strerror(-num_sectors));
2989 ret = -1;
2990 goto out;
2991 }
2992 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
2993 if (old_backing_num_sectors < 0) {
2994 char backing_name[PATH_MAX];
2995
2996 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2997 error_report("Could not get size of '%s': %s",
2998 backing_name, strerror(-old_backing_num_sectors));
2999 ret = -1;
3000 goto out;
3001 }
3002 if (blk_new_backing) {
3003 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3004 if (new_backing_num_sectors < 0) {
3005 error_report("Could not get size of '%s': %s",
3006 out_baseimg, strerror(-new_backing_num_sectors));
3007 ret = -1;
3008 goto out;
3009 }
3010 }
3011
3012 if (num_sectors != 0) {
3013 local_progress = (float)100 /
3014 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3015 }
3016
3017 for (sector = 0; sector < num_sectors; sector += n) {
3018
3019 /* How many sectors can we handle with the next read? */
3020 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3021 n = (IO_BUF_SIZE / 512);
3022 } else {
3023 n = num_sectors - sector;
3024 }
3025
3026 /* If the cluster is allocated, we don't need to take action */
3027 ret = bdrv_is_allocated(bs, sector, n, &n);
3028 if (ret < 0) {
3029 error_report("error while reading image metadata: %s",
3030 strerror(-ret));
3031 goto out;
3032 }
3033 if (ret) {
3034 continue;
3035 }
3036
3037 /*
3038 * Read old and new backing file and take into consideration that
3039 * backing files may be smaller than the COW image.
3040 */
3041 if (sector >= old_backing_num_sectors) {
3042 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3043 } else {
3044 if (sector + n > old_backing_num_sectors) {
3045 n = old_backing_num_sectors - sector;
3046 }
3047
3048 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3049 buf_old, n << BDRV_SECTOR_BITS);
3050 if (ret < 0) {
3051 error_report("error while reading from old backing file");
3052 goto out;
3053 }
3054 }
3055
3056 if (sector >= new_backing_num_sectors || !blk_new_backing) {
3057 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3058 } else {
3059 if (sector + n > new_backing_num_sectors) {
3060 n = new_backing_num_sectors - sector;
3061 }
3062
3063 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3064 buf_new, n << BDRV_SECTOR_BITS);
3065 if (ret < 0) {
3066 error_report("error while reading from new backing file");
3067 goto out;
3068 }
3069 }
3070
3071 /* If they differ, we need to write to the COW file */
3072 uint64_t written = 0;
3073
3074 while (written < n) {
3075 int pnum;
3076
3077 if (compare_sectors(buf_old + written * 512,
3078 buf_new + written * 512, n - written, &pnum))
3079 {
3080 ret = blk_pwrite(blk,
3081 (sector + written) << BDRV_SECTOR_BITS,
3082 buf_old + written * 512,
3083 pnum << BDRV_SECTOR_BITS, 0);
3084 if (ret < 0) {
3085 error_report("Error while writing to COW image: %s",
3086 strerror(-ret));
3087 goto out;
3088 }
3089 }
3090
3091 written += pnum;
3092 }
3093 qemu_progress_print(local_progress, 100);
3094 }
3095 }
3096
3097 /*
3098 * Change the backing file. All clusters that are different from the old
3099 * backing file are overwritten in the COW file now, so the visible content
3100 * doesn't change when we switch the backing file.
3101 */
3102 if (out_baseimg && *out_baseimg) {
3103 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3104 } else {
3105 ret = bdrv_change_backing_file(bs, NULL, NULL);
3106 }
3107
3108 if (ret == -ENOSPC) {
3109 error_report("Could not change the backing file to '%s': No "
3110 "space left in the file header", out_baseimg);
3111 } else if (ret < 0) {
3112 error_report("Could not change the backing file to '%s': %s",
3113 out_baseimg, strerror(-ret));
3114 }
3115
3116 qemu_progress_print(100, 0);
3117 /*
3118 * TODO At this point it is possible to check if any clusters that are
3119 * allocated in the COW file are the same in the backing file. If so, they
3120 * could be dropped from the COW file. Don't do this before switching the
3121 * backing file, in case of a crash this would lead to corruption.
3122 */
3123 out:
3124 qemu_progress_end();
3125 /* Cleanup */
3126 if (!unsafe) {
3127 blk_unref(blk_old_backing);
3128 blk_unref(blk_new_backing);
3129 }
3130 qemu_vfree(buf_old);
3131 qemu_vfree(buf_new);
3132
3133 blk_unref(blk);
3134 if (ret) {
3135 return 1;
3136 }
3137 return 0;
3138 }
3139
3140 static int img_resize(int argc, char **argv)
3141 {
3142 Error *err = NULL;
3143 int c, ret, relative;
3144 const char *filename, *fmt, *size;
3145 int64_t n, total_size;
3146 bool quiet = false;
3147 BlockBackend *blk = NULL;
3148 QemuOpts *param;
3149
3150 static QemuOptsList resize_options = {
3151 .name = "resize_options",
3152 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3153 .desc = {
3154 {
3155 .name = BLOCK_OPT_SIZE,
3156 .type = QEMU_OPT_SIZE,
3157 .help = "Virtual disk size"
3158 }, {
3159 /* end of list */
3160 }
3161 },
3162 };
3163 bool image_opts = false;
3164
3165 /* Remove size from argv manually so that negative numbers are not treated
3166 * as options by getopt. */
3167 if (argc < 3) {
3168 error_exit("Not enough arguments");
3169 return 1;
3170 }
3171
3172 size = argv[--argc];
3173
3174 /* Parse getopt arguments */
3175 fmt = NULL;
3176 for(;;) {
3177 static const struct option long_options[] = {
3178 {"help", no_argument, 0, 'h'},
3179 {"object", required_argument, 0, OPTION_OBJECT},
3180 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3181 {0, 0, 0, 0}
3182 };
3183 c = getopt_long(argc, argv, "f:hq",
3184 long_options, NULL);
3185 if (c == -1) {
3186 break;
3187 }
3188 switch(c) {
3189 case '?':
3190 case 'h':
3191 help();
3192 break;
3193 case 'f':
3194 fmt = optarg;
3195 break;
3196 case 'q':
3197 quiet = true;
3198 break;
3199 case OPTION_OBJECT: {
3200 QemuOpts *opts;
3201 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3202 optarg, true);
3203 if (!opts) {
3204 return 1;
3205 }
3206 } break;
3207 case OPTION_IMAGE_OPTS:
3208 image_opts = true;
3209 break;
3210 }
3211 }
3212 if (optind != argc - 1) {
3213 error_exit("Expecting one image file name");
3214 }
3215 filename = argv[optind++];
3216
3217 if (qemu_opts_foreach(&qemu_object_opts,
3218 user_creatable_add_opts_foreach,
3219 NULL, NULL)) {
3220 return 1;
3221 }
3222
3223 /* Choose grow, shrink, or absolute resize mode */
3224 switch (size[0]) {
3225 case '+':
3226 relative = 1;
3227 size++;
3228 break;
3229 case '-':
3230 relative = -1;
3231 size++;
3232 break;
3233 default:
3234 relative = 0;
3235 break;
3236 }
3237
3238 /* Parse size */
3239 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3240 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3241 if (err) {
3242 error_report_err(err);
3243 ret = -1;
3244 qemu_opts_del(param);
3245 goto out;
3246 }
3247 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3248 qemu_opts_del(param);
3249
3250 blk = img_open(image_opts, filename, fmt,
3251 BDRV_O_RDWR, false, quiet);
3252 if (!blk) {
3253 ret = -1;
3254 goto out;
3255 }
3256
3257 if (relative) {
3258 total_size = blk_getlength(blk) + n * relative;
3259 } else {
3260 total_size = n;
3261 }
3262 if (total_size <= 0) {
3263 error_report("New image size must be positive");
3264 ret = -1;
3265 goto out;
3266 }
3267
3268 ret = blk_truncate(blk, total_size);
3269 switch (ret) {
3270 case 0:
3271 qprintf(quiet, "Image resized.\n");
3272 break;
3273 case -ENOTSUP:
3274 error_report("This image does not support resize");
3275 break;
3276 case -EACCES:
3277 error_report("Image is read-only");
3278 break;
3279 default:
3280 error_report("Error resizing image (%d)", -ret);
3281 break;
3282 }
3283 out:
3284 blk_unref(blk);
3285 if (ret) {
3286 return 1;
3287 }
3288 return 0;
3289 }
3290
3291 static void amend_status_cb(BlockDriverState *bs,
3292 int64_t offset, int64_t total_work_size,
3293 void *opaque)
3294 {
3295 qemu_progress_print(100.f * offset / total_work_size, 0);
3296 }
3297
3298 static int img_amend(int argc, char **argv)
3299 {
3300 Error *err = NULL;
3301 int c, ret = 0;
3302 char *options = NULL;
3303 QemuOptsList *create_opts = NULL;
3304 QemuOpts *opts = NULL;
3305 const char *fmt = NULL, *filename, *cache;
3306 int flags;
3307 bool writethrough;
3308 bool quiet = false, progress = false;
3309 BlockBackend *blk = NULL;
3310 BlockDriverState *bs = NULL;
3311 bool image_opts = false;
3312
3313 cache = BDRV_DEFAULT_CACHE;
3314 for (;;) {
3315 static const struct option long_options[] = {
3316 {"help", no_argument, 0, 'h'},
3317 {"object", required_argument, 0, OPTION_OBJECT},
3318 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3319 {0, 0, 0, 0}
3320 };
3321 c = getopt_long(argc, argv, "ho:f:t:pq",
3322 long_options, NULL);
3323 if (c == -1) {
3324 break;
3325 }
3326
3327 switch (c) {
3328 case 'h':
3329 case '?':
3330 help();
3331 break;
3332 case 'o':
3333 if (!is_valid_option_list(optarg)) {
3334 error_report("Invalid option list: %s", optarg);
3335 ret = -1;
3336 goto out_no_progress;
3337 }
3338 if (!options) {
3339 options = g_strdup(optarg);
3340 } else {
3341 char *old_options = options;
3342 options = g_strdup_printf("%s,%s", options, optarg);
3343 g_free(old_options);
3344 }
3345 break;
3346 case 'f':
3347 fmt = optarg;
3348 break;
3349 case 't':
3350 cache = optarg;
3351 break;
3352 case 'p':
3353 progress = true;
3354 break;
3355 case 'q':
3356 quiet = true;
3357 break;
3358 case OPTION_OBJECT:
3359 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3360 optarg, true);
3361 if (!opts) {
3362 ret = -1;
3363 goto out_no_progress;
3364 }
3365 break;
3366 case OPTION_IMAGE_OPTS:
3367 image_opts = true;
3368 break;
3369 }
3370 }
3371
3372 if (!options) {
3373 error_exit("Must specify options (-o)");
3374 }
3375
3376 if (qemu_opts_foreach(&qemu_object_opts,
3377 user_creatable_add_opts_foreach,
3378 NULL, NULL)) {
3379 ret = -1;
3380 goto out_no_progress;
3381 }
3382
3383 if (quiet) {
3384 progress = false;
3385 }
3386 qemu_progress_init(progress, 1.0);
3387
3388 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3389 if (fmt && has_help_option(options)) {
3390 /* If a format is explicitly specified (and possibly no filename is
3391 * given), print option help here */
3392 ret = print_block_option_help(filename, fmt);
3393 goto out;
3394 }
3395
3396 if (optind != argc - 1) {
3397 error_report("Expecting one image file name");
3398 ret = -1;
3399 goto out;
3400 }
3401
3402 flags = BDRV_O_RDWR;
3403 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3404 if (ret < 0) {
3405 error_report("Invalid cache option: %s", cache);
3406 goto out;
3407 }
3408
3409 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3410 if (!blk) {
3411 ret = -1;
3412 goto out;
3413 }
3414 bs = blk_bs(blk);
3415
3416 fmt = bs->drv->format_name;
3417
3418 if (has_help_option(options)) {
3419 /* If the format was auto-detected, print option help here */
3420 ret = print_block_option_help(filename, fmt);
3421 goto out;
3422 }
3423
3424 if (!bs->drv->create_opts) {
3425 error_report("Format driver '%s' does not support any options to amend",
3426 fmt);
3427 ret = -1;
3428 goto out;
3429 }
3430
3431 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3432 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3433 if (options) {
3434 qemu_opts_do_parse(opts, options, NULL, &err);
3435 if