]> git.proxmox.com Git - mirror_qemu.git/blob - qemu-img.c
block: Mark bdrv_co_block_status() and callers GRAPH_RDLOCK
[mirror_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
25 #include "qemu/osdep.h"
26 #include <getopt.h>
27
28 #include "qemu/help-texts.h"
29 #include "qemu/qemu-progress.h"
30 #include "qemu-version.h"
31 #include "qapi/error.h"
32 #include "qapi/qapi-commands-block-core.h"
33 #include "qapi/qapi-visit-block-core.h"
34 #include "qapi/qobject-output-visitor.h"
35 #include "qapi/qmp/qjson.h"
36 #include "qapi/qmp/qdict.h"
37 #include "qemu/cutils.h"
38 #include "qemu/config-file.h"
39 #include "qemu/option.h"
40 #include "qemu/error-report.h"
41 #include "qemu/log.h"
42 #include "qemu/main-loop.h"
43 #include "qemu/module.h"
44 #include "qemu/sockets.h"
45 #include "qemu/units.h"
46 #include "qemu/memalign.h"
47 #include "qom/object_interfaces.h"
48 #include "sysemu/block-backend.h"
49 #include "block/block_int.h"
50 #include "block/blockjob.h"
51 #include "block/dirty-bitmap.h"
52 #include "block/qapi.h"
53 #include "crypto/init.h"
54 #include "trace/control.h"
55 #include "qemu/throttle.h"
56 #include "block/throttle-groups.h"
57
58 #define QEMU_IMG_VERSION "qemu-img version " QEMU_FULL_VERSION \
59 "\n" QEMU_COPYRIGHT "\n"
60
61 typedef struct img_cmd_t {
62 const char *name;
63 int (*handler)(int argc, char **argv);
64 } img_cmd_t;
65
66 enum {
67 OPTION_OUTPUT = 256,
68 OPTION_BACKING_CHAIN = 257,
69 OPTION_OBJECT = 258,
70 OPTION_IMAGE_OPTS = 259,
71 OPTION_PATTERN = 260,
72 OPTION_FLUSH_INTERVAL = 261,
73 OPTION_NO_DRAIN = 262,
74 OPTION_TARGET_IMAGE_OPTS = 263,
75 OPTION_SIZE = 264,
76 OPTION_PREALLOCATION = 265,
77 OPTION_SHRINK = 266,
78 OPTION_SALVAGE = 267,
79 OPTION_TARGET_IS_ZERO = 268,
80 OPTION_ADD = 269,
81 OPTION_REMOVE = 270,
82 OPTION_CLEAR = 271,
83 OPTION_ENABLE = 272,
84 OPTION_DISABLE = 273,
85 OPTION_MERGE = 274,
86 OPTION_BITMAPS = 275,
87 OPTION_FORCE = 276,
88 OPTION_SKIP_BROKEN = 277,
89 };
90
91 typedef enum OutputFormat {
92 OFORMAT_JSON,
93 OFORMAT_HUMAN,
94 } OutputFormat;
95
96 /* Default to cache=writeback as data integrity is not important for qemu-img */
97 #define BDRV_DEFAULT_CACHE "writeback"
98
99 static void format_print(void *opaque, const char *name)
100 {
101 printf(" %s", name);
102 }
103
104 static G_NORETURN G_GNUC_PRINTF(1, 2)
105 void error_exit(const char *fmt, ...)
106 {
107 va_list ap;
108
109 va_start(ap, fmt);
110 error_vreport(fmt, ap);
111 va_end(ap);
112
113 error_printf("Try 'qemu-img --help' for more information\n");
114 exit(EXIT_FAILURE);
115 }
116
117 static G_NORETURN
118 void missing_argument(const char *option)
119 {
120 error_exit("missing argument for option '%s'", option);
121 }
122
123 static G_NORETURN
124 void unrecognized_option(const char *option)
125 {
126 error_exit("unrecognized option '%s'", option);
127 }
128
129 /* Please keep in synch with docs/tools/qemu-img.rst */
130 static G_NORETURN
131 void help(void)
132 {
133 const char *help_msg =
134 QEMU_IMG_VERSION
135 "usage: qemu-img [standard options] command [command options]\n"
136 "QEMU disk image utility\n"
137 "\n"
138 " '-h', '--help' display this help and exit\n"
139 " '-V', '--version' output version information and exit\n"
140 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
141 " specify tracing options\n"
142 "\n"
143 "Command syntax:\n"
144 #define DEF(option, callback, arg_string) \
145 " " arg_string "\n"
146 #include "qemu-img-cmds.h"
147 #undef DEF
148 "\n"
149 "Command parameters:\n"
150 " 'filename' is a disk image filename\n"
151 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
152 " manual page for a description of the object properties. The most common\n"
153 " object type is a 'secret', which is used to supply passwords and/or\n"
154 " encryption keys.\n"
155 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
156 " 'cache' is the cache mode used to write the output disk image, the valid\n"
157 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
158 " 'directsync' and 'unsafe' (default for convert)\n"
159 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
160 " options are the same as for the 'cache' option\n"
161 " 'size' is the disk image size in bytes. Optional suffixes\n"
162 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
163 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
164 " supported. 'b' is ignored.\n"
165 " 'output_filename' is the destination disk image filename\n"
166 " 'output_fmt' is the destination format\n"
167 " 'options' is a comma separated list of format specific options in a\n"
168 " name=value format. Use -o help for an overview of the options supported by\n"
169 " the used format\n"
170 " 'snapshot_param' is param used for internal snapshot, format\n"
171 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
172 " '[ID_OR_NAME]'\n"
173 " '-c' indicates that target image must be compressed (qcow format only)\n"
174 " '-u' allows unsafe backing chains. For rebasing, it is assumed that old and\n"
175 " new backing file match exactly. The image doesn't need a working\n"
176 " backing file before rebasing in this case (useful for renaming the\n"
177 " backing file). For image creation, allow creating without attempting\n"
178 " to open the backing file.\n"
179 " '-h' with or without a command shows this help and lists the supported formats\n"
180 " '-p' show progress of command (only certain commands)\n"
181 " '-q' use Quiet mode - do not print any output (except errors)\n"
182 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
183 " contain only zeros for qemu-img to create a sparse image during\n"
184 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
185 " unallocated or zero sectors, and the destination image will always be\n"
186 " fully allocated\n"
187 " '--output' takes the format in which the output must be done (human or json)\n"
188 " '-n' skips the target volume creation (useful if the volume is created\n"
189 " prior to running qemu-img)\n"
190 "\n"
191 "Parameters to bitmap subcommand:\n"
192 " 'bitmap' is the name of the bitmap to manipulate, through one or more\n"
193 " actions from '--add', '--remove', '--clear', '--enable', '--disable',\n"
194 " or '--merge source'\n"
195 " '-g granularity' sets the granularity for '--add' actions\n"
196 " '-b source' and '-F src_fmt' tell '--merge' actions to find the source\n"
197 " bitmaps from an alternative file\n"
198 "\n"
199 "Parameters to check subcommand:\n"
200 " '-r' tries to repair any inconsistencies that are found during the check.\n"
201 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
202 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
203 " hiding corruption that has already occurred.\n"
204 "\n"
205 "Parameters to convert subcommand:\n"
206 " '--bitmaps' copies all top-level persistent bitmaps to destination\n"
207 " '-m' specifies how many coroutines work in parallel during the convert\n"
208 " process (defaults to 8)\n"
209 " '-W' allow to write to the target out of order rather than sequential\n"
210 "\n"
211 "Parameters to snapshot subcommand:\n"
212 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
213 " '-a' applies a snapshot (revert disk to saved state)\n"
214 " '-c' creates a snapshot\n"
215 " '-d' deletes a snapshot\n"
216 " '-l' lists all snapshots in the given image\n"
217 "\n"
218 "Parameters to compare subcommand:\n"
219 " '-f' first image format\n"
220 " '-F' second image format\n"
221 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
222 "\n"
223 "Parameters to dd subcommand:\n"
224 " 'bs=BYTES' read and write up to BYTES bytes at a time "
225 "(default: 512)\n"
226 " 'count=N' copy only N input blocks\n"
227 " 'if=FILE' read from FILE\n"
228 " 'of=FILE' write to FILE\n"
229 " 'skip=N' skip N bs-sized blocks at the start of input\n";
230
231 printf("%s\nSupported formats:", help_msg);
232 bdrv_iterate_format(format_print, NULL, false);
233 printf("\n\n" QEMU_HELP_BOTTOM "\n");
234 exit(EXIT_SUCCESS);
235 }
236
237 /*
238 * Is @optarg safe for accumulate_options()?
239 * It is when multiple of them can be joined together separated by ','.
240 * To make that work, @optarg must not start with ',' (or else a
241 * separating ',' preceding it gets escaped), and it must not end with
242 * an odd number of ',' (or else a separating ',' following it gets
243 * escaped), or be empty (or else a separating ',' preceding it can
244 * escape a separating ',' following it).
245 *
246 */
247 static bool is_valid_option_list(const char *optarg)
248 {
249 size_t len = strlen(optarg);
250 size_t i;
251
252 if (!optarg[0] || optarg[0] == ',') {
253 return false;
254 }
255
256 for (i = len; i > 0 && optarg[i - 1] == ','; i--) {
257 }
258 if ((len - i) % 2) {
259 return false;
260 }
261
262 return true;
263 }
264
265 static int accumulate_options(char **options, char *optarg)
266 {
267 char *new_options;
268
269 if (!is_valid_option_list(optarg)) {
270 error_report("Invalid option list: %s", optarg);
271 return -1;
272 }
273
274 if (!*options) {
275 *options = g_strdup(optarg);
276 } else {
277 new_options = g_strdup_printf("%s,%s", *options, optarg);
278 g_free(*options);
279 *options = new_options;
280 }
281 return 0;
282 }
283
284 static QemuOptsList qemu_source_opts = {
285 .name = "source",
286 .implied_opt_name = "file",
287 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
288 .desc = {
289 { }
290 },
291 };
292
293 static int G_GNUC_PRINTF(2, 3) qprintf(bool quiet, const char *fmt, ...)
294 {
295 int ret = 0;
296 if (!quiet) {
297 va_list args;
298 va_start(args, fmt);
299 ret = vprintf(fmt, args);
300 va_end(args);
301 }
302 return ret;
303 }
304
305
306 static int print_block_option_help(const char *filename, const char *fmt)
307 {
308 BlockDriver *drv, *proto_drv;
309 QemuOptsList *create_opts = NULL;
310 Error *local_err = NULL;
311
312 /* Find driver and parse its options */
313 drv = bdrv_find_format(fmt);
314 if (!drv) {
315 error_report("Unknown file format '%s'", fmt);
316 return 1;
317 }
318
319 if (!drv->create_opts) {
320 error_report("Format driver '%s' does not support image creation", fmt);
321 return 1;
322 }
323
324 create_opts = qemu_opts_append(create_opts, drv->create_opts);
325 if (filename) {
326 proto_drv = bdrv_find_protocol(filename, true, &local_err);
327 if (!proto_drv) {
328 error_report_err(local_err);
329 qemu_opts_free(create_opts);
330 return 1;
331 }
332 if (!proto_drv->create_opts) {
333 error_report("Protocol driver '%s' does not support image creation",
334 proto_drv->format_name);
335 qemu_opts_free(create_opts);
336 return 1;
337 }
338 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
339 }
340
341 if (filename) {
342 printf("Supported options:\n");
343 } else {
344 printf("Supported %s options:\n", fmt);
345 }
346 qemu_opts_print_help(create_opts, false);
347 qemu_opts_free(create_opts);
348
349 if (!filename) {
350 printf("\n"
351 "The protocol level may support further options.\n"
352 "Specify the target filename to include those options.\n");
353 }
354
355 return 0;
356 }
357
358
359 static BlockBackend *img_open_opts(const char *optstr,
360 QemuOpts *opts, int flags, bool writethrough,
361 bool quiet, bool force_share)
362 {
363 QDict *options;
364 Error *local_err = NULL;
365 BlockBackend *blk;
366 options = qemu_opts_to_qdict(opts, NULL);
367 if (force_share) {
368 if (qdict_haskey(options, BDRV_OPT_FORCE_SHARE)
369 && strcmp(qdict_get_str(options, BDRV_OPT_FORCE_SHARE), "on")) {
370 error_report("--force-share/-U conflicts with image options");
371 qobject_unref(options);
372 return NULL;
373 }
374 qdict_put_str(options, BDRV_OPT_FORCE_SHARE, "on");
375 }
376 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
377 if (!blk) {
378 error_reportf_err(local_err, "Could not open '%s': ", optstr);
379 return NULL;
380 }
381 blk_set_enable_write_cache(blk, !writethrough);
382
383 return blk;
384 }
385
386 static BlockBackend *img_open_file(const char *filename,
387 QDict *options,
388 const char *fmt, int flags,
389 bool writethrough, bool quiet,
390 bool force_share)
391 {
392 BlockBackend *blk;
393 Error *local_err = NULL;
394
395 if (!options) {
396 options = qdict_new();
397 }
398 if (fmt) {
399 qdict_put_str(options, "driver", fmt);
400 }
401
402 if (force_share) {
403 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
404 }
405 blk = blk_new_open(filename, NULL, options, flags, &local_err);
406 if (!blk) {
407 error_reportf_err(local_err, "Could not open '%s': ", filename);
408 return NULL;
409 }
410 blk_set_enable_write_cache(blk, !writethrough);
411
412 return blk;
413 }
414
415
416 static int img_add_key_secrets(void *opaque,
417 const char *name, const char *value,
418 Error **errp)
419 {
420 QDict *options = opaque;
421
422 if (g_str_has_suffix(name, "key-secret")) {
423 qdict_put_str(options, name, value);
424 }
425
426 return 0;
427 }
428
429
430 static BlockBackend *img_open(bool image_opts,
431 const char *filename,
432 const char *fmt, int flags, bool writethrough,
433 bool quiet, bool force_share)
434 {
435 BlockBackend *blk;
436 if (image_opts) {
437 QemuOpts *opts;
438 if (fmt) {
439 error_report("--image-opts and --format are mutually exclusive");
440 return NULL;
441 }
442 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
443 filename, true);
444 if (!opts) {
445 return NULL;
446 }
447 blk = img_open_opts(filename, opts, flags, writethrough, quiet,
448 force_share);
449 } else {
450 blk = img_open_file(filename, NULL, fmt, flags, writethrough, quiet,
451 force_share);
452 }
453
454 if (blk) {
455 blk_set_force_allow_inactivate(blk);
456 }
457
458 return blk;
459 }
460
461
462 static int add_old_style_options(const char *fmt, QemuOpts *opts,
463 const char *base_filename,
464 const char *base_fmt)
465 {
466 if (base_filename) {
467 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename,
468 NULL)) {
469 error_report("Backing file not supported for file format '%s'",
470 fmt);
471 return -1;
472 }
473 }
474 if (base_fmt) {
475 if (!qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, NULL)) {
476 error_report("Backing file format not supported for file "
477 "format '%s'", fmt);
478 return -1;
479 }
480 }
481 return 0;
482 }
483
484 static int64_t cvtnum_full(const char *name, const char *value, int64_t min,
485 int64_t max)
486 {
487 int err;
488 uint64_t res;
489
490 err = qemu_strtosz(value, NULL, &res);
491 if (err < 0 && err != -ERANGE) {
492 error_report("Invalid %s specified. You may use "
493 "k, M, G, T, P or E suffixes for", name);
494 error_report("kilobytes, megabytes, gigabytes, terabytes, "
495 "petabytes and exabytes.");
496 return err;
497 }
498 if (err == -ERANGE || res > max || res < min) {
499 error_report("Invalid %s specified. Must be between %" PRId64
500 " and %" PRId64 ".", name, min, max);
501 return -ERANGE;
502 }
503 return res;
504 }
505
506 static int64_t cvtnum(const char *name, const char *value)
507 {
508 return cvtnum_full(name, value, 0, INT64_MAX);
509 }
510
511 static int img_create(int argc, char **argv)
512 {
513 int c;
514 uint64_t img_size = -1;
515 const char *fmt = "raw";
516 const char *base_fmt = NULL;
517 const char *filename;
518 const char *base_filename = NULL;
519 char *options = NULL;
520 Error *local_err = NULL;
521 bool quiet = false;
522 int flags = 0;
523
524 for(;;) {
525 static const struct option long_options[] = {
526 {"help", no_argument, 0, 'h'},
527 {"object", required_argument, 0, OPTION_OBJECT},
528 {0, 0, 0, 0}
529 };
530 c = getopt_long(argc, argv, ":F:b:f:ho:qu",
531 long_options, NULL);
532 if (c == -1) {
533 break;
534 }
535 switch(c) {
536 case ':':
537 missing_argument(argv[optind - 1]);
538 break;
539 case '?':
540 unrecognized_option(argv[optind - 1]);
541 break;
542 case 'h':
543 help();
544 break;
545 case 'F':
546 base_fmt = optarg;
547 break;
548 case 'b':
549 base_filename = optarg;
550 break;
551 case 'f':
552 fmt = optarg;
553 break;
554 case 'o':
555 if (accumulate_options(&options, optarg) < 0) {
556 goto fail;
557 }
558 break;
559 case 'q':
560 quiet = true;
561 break;
562 case 'u':
563 flags |= BDRV_O_NO_BACKING;
564 break;
565 case OPTION_OBJECT:
566 user_creatable_process_cmdline(optarg);
567 break;
568 }
569 }
570
571 /* Get the filename */
572 filename = (optind < argc) ? argv[optind] : NULL;
573 if (options && has_help_option(options)) {
574 g_free(options);
575 return print_block_option_help(filename, fmt);
576 }
577
578 if (optind >= argc) {
579 error_exit("Expecting image file name");
580 }
581 optind++;
582
583 /* Get image size, if specified */
584 if (optind < argc) {
585 int64_t sval;
586
587 sval = cvtnum("image size", argv[optind++]);
588 if (sval < 0) {
589 goto fail;
590 }
591 img_size = (uint64_t)sval;
592 }
593 if (optind != argc) {
594 error_exit("Unexpected argument: %s", argv[optind]);
595 }
596
597 bdrv_img_create(filename, fmt, base_filename, base_fmt,
598 options, img_size, flags, quiet, &local_err);
599 if (local_err) {
600 error_reportf_err(local_err, "%s: ", filename);
601 goto fail;
602 }
603
604 g_free(options);
605 return 0;
606
607 fail:
608 g_free(options);
609 return 1;
610 }
611
612 static void dump_json_image_check(ImageCheck *check, bool quiet)
613 {
614 GString *str;
615 QObject *obj;
616 Visitor *v = qobject_output_visitor_new(&obj);
617
618 visit_type_ImageCheck(v, NULL, &check, &error_abort);
619 visit_complete(v, &obj);
620 str = qobject_to_json_pretty(obj, true);
621 assert(str != NULL);
622 qprintf(quiet, "%s\n", str->str);
623 qobject_unref(obj);
624 visit_free(v);
625 g_string_free(str, true);
626 }
627
628 static void dump_human_image_check(ImageCheck *check, bool quiet)
629 {
630 if (!(check->corruptions || check->leaks || check->check_errors)) {
631 qprintf(quiet, "No errors were found on the image.\n");
632 } else {
633 if (check->corruptions) {
634 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
635 "Data may be corrupted, or further writes to the image "
636 "may corrupt it.\n",
637 check->corruptions);
638 }
639
640 if (check->leaks) {
641 qprintf(quiet,
642 "\n%" PRId64 " leaked clusters were found on the image.\n"
643 "This means waste of disk space, but no harm to data.\n",
644 check->leaks);
645 }
646
647 if (check->check_errors) {
648 qprintf(quiet,
649 "\n%" PRId64
650 " internal errors have occurred during the check.\n",
651 check->check_errors);
652 }
653 }
654
655 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
656 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
657 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
658 check->allocated_clusters, check->total_clusters,
659 check->allocated_clusters * 100.0 / check->total_clusters,
660 check->fragmented_clusters * 100.0 / check->allocated_clusters,
661 check->compressed_clusters * 100.0 /
662 check->allocated_clusters);
663 }
664
665 if (check->image_end_offset) {
666 qprintf(quiet,
667 "Image end offset: %" PRId64 "\n", check->image_end_offset);
668 }
669 }
670
671 static int collect_image_check(BlockDriverState *bs,
672 ImageCheck *check,
673 const char *filename,
674 const char *fmt,
675 int fix)
676 {
677 int ret;
678 BdrvCheckResult result;
679
680 ret = bdrv_check(bs, &result, fix);
681 if (ret < 0) {
682 return ret;
683 }
684
685 check->filename = g_strdup(filename);
686 check->format = g_strdup(bdrv_get_format_name(bs));
687 check->check_errors = result.check_errors;
688 check->corruptions = result.corruptions;
689 check->has_corruptions = result.corruptions != 0;
690 check->leaks = result.leaks;
691 check->has_leaks = result.leaks != 0;
692 check->corruptions_fixed = result.corruptions_fixed;
693 check->has_corruptions_fixed = result.corruptions_fixed != 0;
694 check->leaks_fixed = result.leaks_fixed;
695 check->has_leaks_fixed = result.leaks_fixed != 0;
696 check->image_end_offset = result.image_end_offset;
697 check->has_image_end_offset = result.image_end_offset != 0;
698 check->total_clusters = result.bfi.total_clusters;
699 check->has_total_clusters = result.bfi.total_clusters != 0;
700 check->allocated_clusters = result.bfi.allocated_clusters;
701 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
702 check->fragmented_clusters = result.bfi.fragmented_clusters;
703 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
704 check->compressed_clusters = result.bfi.compressed_clusters;
705 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
706
707 return 0;
708 }
709
710 /*
711 * Checks an image for consistency. Exit codes:
712 *
713 * 0 - Check completed, image is good
714 * 1 - Check not completed because of internal errors
715 * 2 - Check completed, image is corrupted
716 * 3 - Check completed, image has leaked clusters, but is good otherwise
717 * 63 - Checks are not supported by the image format
718 */
719 static int img_check(int argc, char **argv)
720 {
721 int c, ret;
722 OutputFormat output_format = OFORMAT_HUMAN;
723 const char *filename, *fmt, *output, *cache;
724 BlockBackend *blk;
725 BlockDriverState *bs;
726 int fix = 0;
727 int flags = BDRV_O_CHECK;
728 bool writethrough;
729 ImageCheck *check;
730 bool quiet = false;
731 bool image_opts = false;
732 bool force_share = false;
733
734 fmt = NULL;
735 output = NULL;
736 cache = BDRV_DEFAULT_CACHE;
737
738 for(;;) {
739 int option_index = 0;
740 static const struct option long_options[] = {
741 {"help", no_argument, 0, 'h'},
742 {"format", required_argument, 0, 'f'},
743 {"repair", required_argument, 0, 'r'},
744 {"output", required_argument, 0, OPTION_OUTPUT},
745 {"object", required_argument, 0, OPTION_OBJECT},
746 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
747 {"force-share", no_argument, 0, 'U'},
748 {0, 0, 0, 0}
749 };
750 c = getopt_long(argc, argv, ":hf:r:T:qU",
751 long_options, &option_index);
752 if (c == -1) {
753 break;
754 }
755 switch(c) {
756 case ':':
757 missing_argument(argv[optind - 1]);
758 break;
759 case '?':
760 unrecognized_option(argv[optind - 1]);
761 break;
762 case 'h':
763 help();
764 break;
765 case 'f':
766 fmt = optarg;
767 break;
768 case 'r':
769 flags |= BDRV_O_RDWR;
770
771 if (!strcmp(optarg, "leaks")) {
772 fix = BDRV_FIX_LEAKS;
773 } else if (!strcmp(optarg, "all")) {
774 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
775 } else {
776 error_exit("Unknown option value for -r "
777 "(expecting 'leaks' or 'all'): %s", optarg);
778 }
779 break;
780 case OPTION_OUTPUT:
781 output = optarg;
782 break;
783 case 'T':
784 cache = optarg;
785 break;
786 case 'q':
787 quiet = true;
788 break;
789 case 'U':
790 force_share = true;
791 break;
792 case OPTION_OBJECT:
793 user_creatable_process_cmdline(optarg);
794 break;
795 case OPTION_IMAGE_OPTS:
796 image_opts = true;
797 break;
798 }
799 }
800 if (optind != argc - 1) {
801 error_exit("Expecting one image file name");
802 }
803 filename = argv[optind++];
804
805 if (output && !strcmp(output, "json")) {
806 output_format = OFORMAT_JSON;
807 } else if (output && !strcmp(output, "human")) {
808 output_format = OFORMAT_HUMAN;
809 } else if (output) {
810 error_report("--output must be used with human or json as argument.");
811 return 1;
812 }
813
814 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
815 if (ret < 0) {
816 error_report("Invalid source cache option: %s", cache);
817 return 1;
818 }
819
820 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
821 force_share);
822 if (!blk) {
823 return 1;
824 }
825 bs = blk_bs(blk);
826
827 check = g_new0(ImageCheck, 1);
828 ret = collect_image_check(bs, check, filename, fmt, fix);
829
830 if (ret == -ENOTSUP) {
831 error_report("This image format does not support checks");
832 ret = 63;
833 goto fail;
834 }
835
836 if (check->corruptions_fixed || check->leaks_fixed) {
837 int corruptions_fixed, leaks_fixed;
838 bool has_leaks_fixed, has_corruptions_fixed;
839
840 leaks_fixed = check->leaks_fixed;
841 has_leaks_fixed = check->has_leaks_fixed;
842 corruptions_fixed = check->corruptions_fixed;
843 has_corruptions_fixed = check->has_corruptions_fixed;
844
845 if (output_format == OFORMAT_HUMAN) {
846 qprintf(quiet,
847 "The following inconsistencies were found and repaired:\n\n"
848 " %" PRId64 " leaked clusters\n"
849 " %" PRId64 " corruptions\n\n"
850 "Double checking the fixed image now...\n",
851 check->leaks_fixed,
852 check->corruptions_fixed);
853 }
854
855 qapi_free_ImageCheck(check);
856 check = g_new0(ImageCheck, 1);
857 ret = collect_image_check(bs, check, filename, fmt, 0);
858
859 check->leaks_fixed = leaks_fixed;
860 check->has_leaks_fixed = has_leaks_fixed;
861 check->corruptions_fixed = corruptions_fixed;
862 check->has_corruptions_fixed = has_corruptions_fixed;
863 }
864
865 if (!ret) {
866 switch (output_format) {
867 case OFORMAT_HUMAN:
868 dump_human_image_check(check, quiet);
869 break;
870 case OFORMAT_JSON:
871 dump_json_image_check(check, quiet);
872 break;
873 }
874 }
875
876 if (ret || check->check_errors) {
877 if (ret) {
878 error_report("Check failed: %s", strerror(-ret));
879 } else {
880 error_report("Check failed");
881 }
882 ret = 1;
883 goto fail;
884 }
885
886 if (check->corruptions) {
887 ret = 2;
888 } else if (check->leaks) {
889 ret = 3;
890 } else {
891 ret = 0;
892 }
893
894 fail:
895 qapi_free_ImageCheck(check);
896 blk_unref(blk);
897 return ret;
898 }
899
900 typedef struct CommonBlockJobCBInfo {
901 BlockDriverState *bs;
902 Error **errp;
903 } CommonBlockJobCBInfo;
904
905 static void common_block_job_cb(void *opaque, int ret)
906 {
907 CommonBlockJobCBInfo *cbi = opaque;
908
909 if (ret < 0) {
910 error_setg_errno(cbi->errp, -ret, "Block job failed");
911 }
912 }
913
914 static void run_block_job(BlockJob *job, Error **errp)
915 {
916 uint64_t progress_current, progress_total;
917 AioContext *aio_context = block_job_get_aio_context(job);
918 int ret = 0;
919
920 job_lock();
921 job_ref_locked(&job->job);
922 do {
923 float progress = 0.0f;
924 job_unlock();
925 aio_poll(aio_context, true);
926
927 progress_get_snapshot(&job->job.progress, &progress_current,
928 &progress_total);
929 if (progress_total) {
930 progress = (float)progress_current / progress_total * 100.f;
931 }
932 qemu_progress_print(progress, 0);
933 job_lock();
934 } while (!job_is_ready_locked(&job->job) &&
935 !job_is_completed_locked(&job->job));
936
937 if (!job_is_completed_locked(&job->job)) {
938 ret = job_complete_sync_locked(&job->job, errp);
939 } else {
940 ret = job->job.ret;
941 }
942 job_unref_locked(&job->job);
943 job_unlock();
944
945 /* publish completion progress only when success */
946 if (!ret) {
947 qemu_progress_print(100.f, 0);
948 }
949 }
950
951 static int img_commit(int argc, char **argv)
952 {
953 int c, ret, flags;
954 const char *filename, *fmt, *cache, *base;
955 BlockBackend *blk;
956 BlockDriverState *bs, *base_bs;
957 BlockJob *job;
958 bool progress = false, quiet = false, drop = false;
959 bool writethrough;
960 Error *local_err = NULL;
961 CommonBlockJobCBInfo cbi;
962 bool image_opts = false;
963 AioContext *aio_context;
964 int64_t rate_limit = 0;
965
966 fmt = NULL;
967 cache = BDRV_DEFAULT_CACHE;
968 base = NULL;
969 for(;;) {
970 static const struct option long_options[] = {
971 {"help", no_argument, 0, 'h'},
972 {"object", required_argument, 0, OPTION_OBJECT},
973 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
974 {0, 0, 0, 0}
975 };
976 c = getopt_long(argc, argv, ":f:ht:b:dpqr:",
977 long_options, NULL);
978 if (c == -1) {
979 break;
980 }
981 switch(c) {
982 case ':':
983 missing_argument(argv[optind - 1]);
984 break;
985 case '?':
986 unrecognized_option(argv[optind - 1]);
987 break;
988 case 'h':
989 help();
990 break;
991 case 'f':
992 fmt = optarg;
993 break;
994 case 't':
995 cache = optarg;
996 break;
997 case 'b':
998 base = optarg;
999 /* -b implies -d */
1000 drop = true;
1001 break;
1002 case 'd':
1003 drop = true;
1004 break;
1005 case 'p':
1006 progress = true;
1007 break;
1008 case 'q':
1009 quiet = true;
1010 break;
1011 case 'r':
1012 rate_limit = cvtnum("rate limit", optarg);
1013 if (rate_limit < 0) {
1014 return 1;
1015 }
1016 break;
1017 case OPTION_OBJECT:
1018 user_creatable_process_cmdline(optarg);
1019 break;
1020 case OPTION_IMAGE_OPTS:
1021 image_opts = true;
1022 break;
1023 }
1024 }
1025
1026 /* Progress is not shown in Quiet mode */
1027 if (quiet) {
1028 progress = false;
1029 }
1030
1031 if (optind != argc - 1) {
1032 error_exit("Expecting one image file name");
1033 }
1034 filename = argv[optind++];
1035
1036 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
1037 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1038 if (ret < 0) {
1039 error_report("Invalid cache option: %s", cache);
1040 return 1;
1041 }
1042
1043 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
1044 false);
1045 if (!blk) {
1046 return 1;
1047 }
1048 bs = blk_bs(blk);
1049
1050 qemu_progress_init(progress, 1.f);
1051 qemu_progress_print(0.f, 100);
1052
1053 if (base) {
1054 base_bs = bdrv_find_backing_image(bs, base);
1055 if (!base_bs) {
1056 error_setg(&local_err,
1057 "Did not find '%s' in the backing chain of '%s'",
1058 base, filename);
1059 goto done;
1060 }
1061 } else {
1062 /* This is different from QMP, which by default uses the deepest file in
1063 * the backing chain (i.e., the very base); however, the traditional
1064 * behavior of qemu-img commit is using the immediate backing file. */
1065 base_bs = bdrv_backing_chain_next(bs);
1066 if (!base_bs) {
1067 error_setg(&local_err, "Image does not have a backing file");
1068 goto done;
1069 }
1070 }
1071
1072 cbi = (CommonBlockJobCBInfo){
1073 .errp = &local_err,
1074 .bs = bs,
1075 };
1076
1077 aio_context = bdrv_get_aio_context(bs);
1078 aio_context_acquire(aio_context);
1079 commit_active_start("commit", bs, base_bs, JOB_DEFAULT, rate_limit,
1080 BLOCKDEV_ON_ERROR_REPORT, NULL, common_block_job_cb,
1081 &cbi, false, &local_err);
1082 aio_context_release(aio_context);
1083 if (local_err) {
1084 goto done;
1085 }
1086
1087 /* When the block job completes, the BlockBackend reference will point to
1088 * the old backing file. In order to avoid that the top image is already
1089 * deleted, so we can still empty it afterwards, increment the reference
1090 * counter here preemptively. */
1091 if (!drop) {
1092 bdrv_ref(bs);
1093 }
1094
1095 job = block_job_get("commit");
1096 assert(job);
1097 run_block_job(job, &local_err);
1098 if (local_err) {
1099 goto unref_backing;
1100 }
1101
1102 if (!drop) {
1103 BlockBackend *old_backing_blk;
1104
1105 old_backing_blk = blk_new_with_bs(bs, BLK_PERM_WRITE, BLK_PERM_ALL,
1106 &local_err);
1107 if (!old_backing_blk) {
1108 goto unref_backing;
1109 }
1110 ret = blk_make_empty(old_backing_blk, &local_err);
1111 blk_unref(old_backing_blk);
1112 if (ret == -ENOTSUP) {
1113 error_free(local_err);
1114 local_err = NULL;
1115 } else if (ret < 0) {
1116 goto unref_backing;
1117 }
1118 }
1119
1120 unref_backing:
1121 if (!drop) {
1122 bdrv_unref(bs);
1123 }
1124
1125 done:
1126 qemu_progress_end();
1127
1128 /*
1129 * Manually inactivate the image first because this way we can know whether
1130 * an error occurred. blk_unref() doesn't tell us about failures.
1131 */
1132 ret = bdrv_inactivate_all();
1133 if (ret < 0 && !local_err) {
1134 error_setg_errno(&local_err, -ret, "Error while closing the image");
1135 }
1136 blk_unref(blk);
1137
1138 if (local_err) {
1139 error_report_err(local_err);
1140 return 1;
1141 }
1142
1143 qprintf(quiet, "Image committed.\n");
1144 return 0;
1145 }
1146
1147 /*
1148 * Returns -1 if 'buf' contains only zeroes, otherwise the byte index
1149 * of the first sector boundary within buf where the sector contains a
1150 * non-zero byte. This function is robust to a buffer that is not
1151 * sector-aligned.
1152 */
1153 static int64_t find_nonzero(const uint8_t *buf, int64_t n)
1154 {
1155 int64_t i;
1156 int64_t end = QEMU_ALIGN_DOWN(n, BDRV_SECTOR_SIZE);
1157
1158 for (i = 0; i < end; i += BDRV_SECTOR_SIZE) {
1159 if (!buffer_is_zero(buf + i, BDRV_SECTOR_SIZE)) {
1160 return i;
1161 }
1162 }
1163 if (i < n && !buffer_is_zero(buf + i, n - end)) {
1164 return i;
1165 }
1166 return -1;
1167 }
1168
1169 /*
1170 * Returns true iff the first sector pointed to by 'buf' contains at least
1171 * a non-NUL byte.
1172 *
1173 * 'pnum' is set to the number of sectors (including and immediately following
1174 * the first one) that are known to be in the same allocated/unallocated state.
1175 * The function will try to align the end offset to alignment boundaries so
1176 * that the request will at least end aligned and consecutive requests will
1177 * also start at an aligned offset.
1178 */
1179 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum,
1180 int64_t sector_num, int alignment)
1181 {
1182 bool is_zero;
1183 int i, tail;
1184
1185 if (n <= 0) {
1186 *pnum = 0;
1187 return 0;
1188 }
1189 is_zero = buffer_is_zero(buf, BDRV_SECTOR_SIZE);
1190 for(i = 1; i < n; i++) {
1191 buf += BDRV_SECTOR_SIZE;
1192 if (is_zero != buffer_is_zero(buf, BDRV_SECTOR_SIZE)) {
1193 break;
1194 }
1195 }
1196
1197 if (i == n) {
1198 /*
1199 * The whole buf is the same.
1200 * No reason to split it into chunks, so return now.
1201 */
1202 *pnum = i;
1203 return !is_zero;
1204 }
1205
1206 tail = (sector_num + i) & (alignment - 1);
1207 if (tail) {
1208 if (is_zero && i <= tail) {
1209 /*
1210 * For sure next sector after i is data, and it will rewrite this
1211 * tail anyway due to RMW. So, let's just write data now.
1212 */
1213 is_zero = false;
1214 }
1215 if (!is_zero) {
1216 /* If possible, align up end offset of allocated areas. */
1217 i += alignment - tail;
1218 i = MIN(i, n);
1219 } else {
1220 /*
1221 * For sure next sector after i is data, and it will rewrite this
1222 * tail anyway due to RMW. Better is avoid RMW and write zeroes up
1223 * to aligned bound.
1224 */
1225 i -= tail;
1226 }
1227 }
1228 *pnum = i;
1229 return !is_zero;
1230 }
1231
1232 /*
1233 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1234 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1235 * breaking up write requests for only small sparse areas.
1236 */
1237 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1238 int min, int64_t sector_num, int alignment)
1239 {
1240 int ret;
1241 int num_checked, num_used;
1242
1243 if (n < min) {
1244 min = n;
1245 }
1246
1247 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1248 if (!ret) {
1249 return ret;
1250 }
1251
1252 num_used = *pnum;
1253 buf += BDRV_SECTOR_SIZE * *pnum;
1254 n -= *pnum;
1255 sector_num += *pnum;
1256 num_checked = num_used;
1257
1258 while (n > 0) {
1259 ret = is_allocated_sectors(buf, n, pnum, sector_num, alignment);
1260
1261 buf += BDRV_SECTOR_SIZE * *pnum;
1262 n -= *pnum;
1263 sector_num += *pnum;
1264 num_checked += *pnum;
1265 if (ret) {
1266 num_used = num_checked;
1267 } else if (*pnum >= min) {
1268 break;
1269 }
1270 }
1271
1272 *pnum = num_used;
1273 return 1;
1274 }
1275
1276 /*
1277 * Compares two buffers sector by sector. Returns 0 if the first
1278 * sector of each buffer matches, non-zero otherwise.
1279 *
1280 * pnum is set to the sector-aligned size of the buffer prefix that
1281 * has the same matching status as the first sector.
1282 */
1283 static int compare_buffers(const uint8_t *buf1, const uint8_t *buf2,
1284 int64_t bytes, int64_t *pnum)
1285 {
1286 bool res;
1287 int64_t i = MIN(bytes, BDRV_SECTOR_SIZE);
1288
1289 assert(bytes > 0);
1290
1291 res = !!memcmp(buf1, buf2, i);
1292 while (i < bytes) {
1293 int64_t len = MIN(bytes - i, BDRV_SECTOR_SIZE);
1294
1295 if (!!memcmp(buf1 + i, buf2 + i, len) != res) {
1296 break;
1297 }
1298 i += len;
1299 }
1300
1301 *pnum = i;
1302 return res;
1303 }
1304
1305 #define IO_BUF_SIZE (2 * MiB)
1306
1307 /*
1308 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1309 *
1310 * Intended for use by 'qemu-img compare': Returns 0 in case sectors are
1311 * filled with 0, 1 if sectors contain non-zero data (this is a comparison
1312 * failure), and 4 on error (the exit status for read errors), after emitting
1313 * an error message.
1314 *
1315 * @param blk: BlockBackend for the image
1316 * @param offset: Starting offset to check
1317 * @param bytes: Number of bytes to check
1318 * @param filename: Name of disk file we are checking (logging purpose)
1319 * @param buffer: Allocated buffer for storing read data
1320 * @param quiet: Flag for quiet mode
1321 */
1322 static int check_empty_sectors(BlockBackend *blk, int64_t offset,
1323 int64_t bytes, const char *filename,
1324 uint8_t *buffer, bool quiet)
1325 {
1326 int ret = 0;
1327 int64_t idx;
1328
1329 ret = blk_pread(blk, offset, bytes, buffer, 0);
1330 if (ret < 0) {
1331 error_report("Error while reading offset %" PRId64 " of %s: %s",
1332 offset, filename, strerror(-ret));
1333 return 4;
1334 }
1335 idx = find_nonzero(buffer, bytes);
1336 if (idx >= 0) {
1337 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1338 offset + idx);
1339 return 1;
1340 }
1341
1342 return 0;
1343 }
1344
1345 /*
1346 * Compares two images. Exit codes:
1347 *
1348 * 0 - Images are identical or the requested help was printed
1349 * 1 - Images differ
1350 * >1 - Error occurred
1351 */
1352 static int img_compare(int argc, char **argv)
1353 {
1354 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1355 BlockBackend *blk1, *blk2;
1356 BlockDriverState *bs1, *bs2;
1357 int64_t total_size1, total_size2;
1358 uint8_t *buf1 = NULL, *buf2 = NULL;
1359 int64_t pnum1, pnum2;
1360 int allocated1, allocated2;
1361 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1362 bool progress = false, quiet = false, strict = false;
1363 int flags;
1364 bool writethrough;
1365 int64_t total_size;
1366 int64_t offset = 0;
1367 int64_t chunk;
1368 int c;
1369 uint64_t progress_base;
1370 bool image_opts = false;
1371 bool force_share = false;
1372
1373 cache = BDRV_DEFAULT_CACHE;
1374 for (;;) {
1375 static const struct option long_options[] = {
1376 {"help", no_argument, 0, 'h'},
1377 {"object", required_argument, 0, OPTION_OBJECT},
1378 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1379 {"force-share", no_argument, 0, 'U'},
1380 {0, 0, 0, 0}
1381 };
1382 c = getopt_long(argc, argv, ":hf:F:T:pqsU",
1383 long_options, NULL);
1384 if (c == -1) {
1385 break;
1386 }
1387 switch (c) {
1388 case ':':
1389 missing_argument(argv[optind - 1]);
1390 break;
1391 case '?':
1392 unrecognized_option(argv[optind - 1]);
1393 break;
1394 case 'h':
1395 help();
1396 break;
1397 case 'f':
1398 fmt1 = optarg;
1399 break;
1400 case 'F':
1401 fmt2 = optarg;
1402 break;
1403 case 'T':
1404 cache = optarg;
1405 break;
1406 case 'p':
1407 progress = true;
1408 break;
1409 case 'q':
1410 quiet = true;
1411 break;
1412 case 's':
1413 strict = true;
1414 break;
1415 case 'U':
1416 force_share = true;
1417 break;
1418 case OPTION_OBJECT:
1419 {
1420 Error *local_err = NULL;
1421
1422 if (!user_creatable_add_from_str(optarg, &local_err)) {
1423 if (local_err) {
1424 error_report_err(local_err);
1425 exit(2);
1426 } else {
1427 /* Help was printed */
1428 exit(EXIT_SUCCESS);
1429 }
1430 }
1431 break;
1432 }
1433 case OPTION_IMAGE_OPTS:
1434 image_opts = true;
1435 break;
1436 }
1437 }
1438
1439 /* Progress is not shown in Quiet mode */
1440 if (quiet) {
1441 progress = false;
1442 }
1443
1444
1445 if (optind != argc - 2) {
1446 error_exit("Expecting two image file names");
1447 }
1448 filename1 = argv[optind++];
1449 filename2 = argv[optind++];
1450
1451 /* Initialize before goto out */
1452 qemu_progress_init(progress, 2.0);
1453
1454 flags = 0;
1455 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1456 if (ret < 0) {
1457 error_report("Invalid source cache option: %s", cache);
1458 ret = 2;
1459 goto out3;
1460 }
1461
1462 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet,
1463 force_share);
1464 if (!blk1) {
1465 ret = 2;
1466 goto out3;
1467 }
1468
1469 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet,
1470 force_share);
1471 if (!blk2) {
1472 ret = 2;
1473 goto out2;
1474 }
1475 bs1 = blk_bs(blk1);
1476 bs2 = blk_bs(blk2);
1477
1478 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1479 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1480 total_size1 = blk_getlength(blk1);
1481 if (total_size1 < 0) {
1482 error_report("Can't get size of %s: %s",
1483 filename1, strerror(-total_size1));
1484 ret = 4;
1485 goto out;
1486 }
1487 total_size2 = blk_getlength(blk2);
1488 if (total_size2 < 0) {
1489 error_report("Can't get size of %s: %s",
1490 filename2, strerror(-total_size2));
1491 ret = 4;
1492 goto out;
1493 }
1494 total_size = MIN(total_size1, total_size2);
1495 progress_base = MAX(total_size1, total_size2);
1496
1497 qemu_progress_print(0, 100);
1498
1499 if (strict && total_size1 != total_size2) {
1500 ret = 1;
1501 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1502 goto out;
1503 }
1504
1505 while (offset < total_size) {
1506 int status1, status2;
1507
1508 status1 = bdrv_block_status_above(bs1, NULL, offset,
1509 total_size1 - offset, &pnum1, NULL,
1510 NULL);
1511 if (status1 < 0) {
1512 ret = 3;
1513 error_report("Sector allocation test failed for %s", filename1);
1514 goto out;
1515 }
1516 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1517
1518 status2 = bdrv_block_status_above(bs2, NULL, offset,
1519 total_size2 - offset, &pnum2, NULL,
1520 NULL);
1521 if (status2 < 0) {
1522 ret = 3;
1523 error_report("Sector allocation test failed for %s", filename2);
1524 goto out;
1525 }
1526 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1527
1528 assert(pnum1 && pnum2);
1529 chunk = MIN(pnum1, pnum2);
1530
1531 if (strict) {
1532 if (status1 != status2) {
1533 ret = 1;
1534 qprintf(quiet, "Strict mode: Offset %" PRId64
1535 " block status mismatch!\n", offset);
1536 goto out;
1537 }
1538 }
1539 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1540 /* nothing to do */
1541 } else if (allocated1 == allocated2) {
1542 if (allocated1) {
1543 int64_t pnum;
1544
1545 chunk = MIN(chunk, IO_BUF_SIZE);
1546 ret = blk_pread(blk1, offset, chunk, buf1, 0);
1547 if (ret < 0) {
1548 error_report("Error while reading offset %" PRId64
1549 " of %s: %s",
1550 offset, filename1, strerror(-ret));
1551 ret = 4;
1552 goto out;
1553 }
1554 ret = blk_pread(blk2, offset, chunk, buf2, 0);
1555 if (ret < 0) {
1556 error_report("Error while reading offset %" PRId64
1557 " of %s: %s",
1558 offset, filename2, strerror(-ret));
1559 ret = 4;
1560 goto out;
1561 }
1562 ret = compare_buffers(buf1, buf2, chunk, &pnum);
1563 if (ret || pnum != chunk) {
1564 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1565 offset + (ret ? 0 : pnum));
1566 ret = 1;
1567 goto out;
1568 }
1569 }
1570 } else {
1571 chunk = MIN(chunk, IO_BUF_SIZE);
1572 if (allocated1) {
1573 ret = check_empty_sectors(blk1, offset, chunk,
1574 filename1, buf1, quiet);
1575 } else {
1576 ret = check_empty_sectors(blk2, offset, chunk,
1577 filename2, buf1, quiet);
1578 }
1579 if (ret) {
1580 goto out;
1581 }
1582 }
1583 offset += chunk;
1584 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1585 }
1586
1587 if (total_size1 != total_size2) {
1588 BlockBackend *blk_over;
1589 const char *filename_over;
1590
1591 qprintf(quiet, "Warning: Image size mismatch!\n");
1592 if (total_size1 > total_size2) {
1593 blk_over = blk1;
1594 filename_over = filename1;
1595 } else {
1596 blk_over = blk2;
1597 filename_over = filename2;
1598 }
1599
1600 while (offset < progress_base) {
1601 ret = bdrv_block_status_above(blk_bs(blk_over), NULL, offset,
1602 progress_base - offset, &chunk,
1603 NULL, NULL);
1604 if (ret < 0) {
1605 ret = 3;
1606 error_report("Sector allocation test failed for %s",
1607 filename_over);
1608 goto out;
1609
1610 }
1611 if (ret & BDRV_BLOCK_ALLOCATED && !(ret & BDRV_BLOCK_ZERO)) {
1612 chunk = MIN(chunk, IO_BUF_SIZE);
1613 ret = check_empty_sectors(blk_over, offset, chunk,
1614 filename_over, buf1, quiet);
1615 if (ret) {
1616 goto out;
1617 }
1618 }
1619 offset += chunk;
1620 qemu_progress_print(((float) chunk / progress_base) * 100, 100);
1621 }
1622 }
1623
1624 qprintf(quiet, "Images are identical.\n");
1625 ret = 0;
1626
1627 out:
1628 qemu_vfree(buf1);
1629 qemu_vfree(buf2);
1630 blk_unref(blk2);
1631 out2:
1632 blk_unref(blk1);
1633 out3:
1634 qemu_progress_end();
1635 return ret;
1636 }
1637
1638 /* Convenience wrapper around qmp_block_dirty_bitmap_merge */
1639 static void do_dirty_bitmap_merge(const char *dst_node, const char *dst_name,
1640 const char *src_node, const char *src_name,
1641 Error **errp)
1642 {
1643 BlockDirtyBitmapOrStr *merge_src;
1644 BlockDirtyBitmapOrStrList *list = NULL;
1645
1646 merge_src = g_new0(BlockDirtyBitmapOrStr, 1);
1647 merge_src->type = QTYPE_QDICT;
1648 merge_src->u.external.node = g_strdup(src_node);
1649 merge_src->u.external.name = g_strdup(src_name);
1650 QAPI_LIST_PREPEND(list, merge_src);
1651 qmp_block_dirty_bitmap_merge(dst_node, dst_name, list, errp);
1652 qapi_free_BlockDirtyBitmapOrStrList(list);
1653 }
1654
1655 enum ImgConvertBlockStatus {
1656 BLK_DATA,
1657 BLK_ZERO,
1658 BLK_BACKING_FILE,
1659 };
1660
1661 #define MAX_COROUTINES 16
1662 #define CONVERT_THROTTLE_GROUP "img_convert"
1663
1664 typedef struct ImgConvertState {
1665 BlockBackend **src;
1666 int64_t *src_sectors;
1667 int *src_alignment;
1668 int src_num;
1669 int64_t total_sectors;
1670 int64_t allocated_sectors;
1671 int64_t allocated_done;
1672 int64_t sector_num;
1673 int64_t wr_offs;
1674 enum ImgConvertBlockStatus status;
1675 int64_t sector_next_status;
1676 BlockBackend *target;
1677 bool has_zero_init;
1678 bool compressed;
1679 bool target_is_new;
1680 bool target_has_backing;
1681 int64_t target_backing_sectors; /* negative if unknown */
1682 bool wr_in_order;
1683 bool copy_range;
1684 bool salvage;
1685 bool quiet;
1686 int min_sparse;
1687 int alignment;
1688 size_t cluster_sectors;
1689 size_t buf_sectors;
1690 long num_coroutines;
1691 int running_coroutines;
1692 Coroutine *co[MAX_COROUTINES];
1693 int64_t wait_sector_num[MAX_COROUTINES];
1694 CoMutex lock;
1695 int ret;
1696 } ImgConvertState;
1697
1698 static void convert_select_part(ImgConvertState *s, int64_t sector_num,
1699 int *src_cur, int64_t *src_cur_offset)
1700 {
1701 *src_cur = 0;
1702 *src_cur_offset = 0;
1703 while (sector_num - *src_cur_offset >= s->src_sectors[*src_cur]) {
1704 *src_cur_offset += s->src_sectors[*src_cur];
1705 (*src_cur)++;
1706 assert(*src_cur < s->src_num);
1707 }
1708 }
1709
1710 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1711 {
1712 int64_t src_cur_offset;
1713 int ret, n, src_cur;
1714 bool post_backing_zero = false;
1715
1716 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1717
1718 assert(s->total_sectors > sector_num);
1719 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1720
1721 if (s->target_backing_sectors >= 0) {
1722 if (sector_num >= s->target_backing_sectors) {
1723 post_backing_zero = true;
1724 } else if (sector_num + n > s->target_backing_sectors) {
1725 /* Split requests around target_backing_sectors (because
1726 * starting from there, zeros are handled differently) */
1727 n = s->target_backing_sectors - sector_num;
1728 }
1729 }
1730
1731 if (s->sector_next_status <= sector_num) {
1732 uint64_t offset = (sector_num - src_cur_offset) * BDRV_SECTOR_SIZE;
1733 int64_t count;
1734 int tail;
1735 BlockDriverState *src_bs = blk_bs(s->src[src_cur]);
1736 BlockDriverState *base;
1737
1738 if (s->target_has_backing) {
1739 base = bdrv_cow_bs(bdrv_skip_filters(src_bs));
1740 } else {
1741 base = NULL;
1742 }
1743
1744 do {
1745 count = n * BDRV_SECTOR_SIZE;
1746
1747 ret = bdrv_block_status_above(src_bs, base, offset, count, &count,
1748 NULL, NULL);
1749
1750 if (ret < 0) {
1751 if (s->salvage) {
1752 if (n == 1) {
1753 if (!s->quiet) {
1754 warn_report("error while reading block status at "
1755 "offset %" PRIu64 ": %s", offset,
1756 strerror(-ret));
1757 }
1758 /* Just try to read the data, then */
1759 ret = BDRV_BLOCK_DATA;
1760 count = BDRV_SECTOR_SIZE;
1761 } else {
1762 /* Retry on a shorter range */
1763 n = DIV_ROUND_UP(n, 4);
1764 }
1765 } else {
1766 error_report("error while reading block status at offset "
1767 "%" PRIu64 ": %s", offset, strerror(-ret));
1768 return ret;
1769 }
1770 }
1771 } while (ret < 0);
1772
1773 n = DIV_ROUND_UP(count, BDRV_SECTOR_SIZE);
1774
1775 /*
1776 * Avoid that s->sector_next_status becomes unaligned to the source
1777 * request alignment and/or cluster size to avoid unnecessary read
1778 * cycles.
1779 */
1780 tail = (sector_num - src_cur_offset + n) % s->src_alignment[src_cur];
1781 if (n > tail) {
1782 n -= tail;
1783 }
1784
1785 if (ret & BDRV_BLOCK_ZERO) {
1786 s->status = post_backing_zero ? BLK_BACKING_FILE : BLK_ZERO;
1787 } else if (ret & BDRV_BLOCK_DATA) {
1788 s->status = BLK_DATA;
1789 } else {
1790 s->status = s->target_has_backing ? BLK_BACKING_FILE : BLK_DATA;
1791 }
1792
1793 s->sector_next_status = sector_num + n;
1794 }
1795
1796 n = MIN(n, s->sector_next_status - sector_num);
1797 if (s->status == BLK_DATA) {
1798 n = MIN(n, s->buf_sectors);
1799 }
1800
1801 /* We need to write complete clusters for compressed images, so if an
1802 * unallocated area is shorter than that, we must consider the whole
1803 * cluster allocated. */
1804 if (s->compressed) {
1805 if (n < s->cluster_sectors) {
1806 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1807 s->status = BLK_DATA;
1808 } else {
1809 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1810 }
1811 }
1812
1813 return n;
1814 }
1815
1816 static int coroutine_fn convert_co_read(ImgConvertState *s, int64_t sector_num,
1817 int nb_sectors, uint8_t *buf)
1818 {
1819 uint64_t single_read_until = 0;
1820 int n, ret;
1821
1822 assert(nb_sectors <= s->buf_sectors);
1823 while (nb_sectors > 0) {
1824 BlockBackend *blk;
1825 int src_cur;
1826 int64_t bs_sectors, src_cur_offset;
1827 uint64_t offset;
1828
1829 /* In the case of compression with multiple source files, we can get a
1830 * nb_sectors that spreads into the next part. So we must be able to
1831 * read across multiple BDSes for one convert_read() call. */
1832 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1833 blk = s->src[src_cur];
1834 bs_sectors = s->src_sectors[src_cur];
1835
1836 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1837
1838 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1839 if (single_read_until > offset) {
1840 n = 1;
1841 }
1842
1843 ret = blk_co_pread(blk, offset, n << BDRV_SECTOR_BITS, buf, 0);
1844 if (ret < 0) {
1845 if (s->salvage) {
1846 if (n > 1) {
1847 single_read_until = offset + (n << BDRV_SECTOR_BITS);
1848 continue;
1849 } else {
1850 if (!s->quiet) {
1851 warn_report("error while reading offset %" PRIu64
1852 ": %s", offset, strerror(-ret));
1853 }
1854 memset(buf, 0, BDRV_SECTOR_SIZE);
1855 }
1856 } else {
1857 return ret;
1858 }
1859 }
1860
1861 sector_num += n;
1862 nb_sectors -= n;
1863 buf += n * BDRV_SECTOR_SIZE;
1864 }
1865
1866 return 0;
1867 }
1868
1869
1870 static int coroutine_fn convert_co_write(ImgConvertState *s, int64_t sector_num,
1871 int nb_sectors, uint8_t *buf,
1872 enum ImgConvertBlockStatus status)
1873 {
1874 int ret;
1875
1876 while (nb_sectors > 0) {
1877 int n = nb_sectors;
1878 BdrvRequestFlags flags = s->compressed ? BDRV_REQ_WRITE_COMPRESSED : 0;
1879
1880 switch (status) {
1881 case BLK_BACKING_FILE:
1882 /* If we have a backing file, leave clusters unallocated that are
1883 * unallocated in the source image, so that the backing file is
1884 * visible at the respective offset. */
1885 assert(s->target_has_backing);
1886 break;
1887
1888 case BLK_DATA:
1889 /* If we're told to keep the target fully allocated (-S 0) or there
1890 * is real non-zero data, we must write it. Otherwise we can treat
1891 * it as zero sectors.
1892 * Compressed clusters need to be written as a whole, so in that
1893 * case we can only save the write if the buffer is completely
1894 * zeroed. */
1895 if (!s->min_sparse ||
1896 (!s->compressed &&
1897 is_allocated_sectors_min(buf, n, &n, s->min_sparse,
1898 sector_num, s->alignment)) ||
1899 (s->compressed &&
1900 !buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)))
1901 {
1902 ret = blk_co_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1903 n << BDRV_SECTOR_BITS, buf, flags);
1904 if (ret < 0) {
1905 return ret;
1906 }
1907 break;
1908 }
1909 /* fall-through */
1910
1911 case BLK_ZERO:
1912 if (s->has_zero_init) {
1913 assert(!s->target_has_backing);
1914 break;
1915 }
1916 ret = blk_co_pwrite_zeroes(s->target,
1917 sector_num << BDRV_SECTOR_BITS,
1918 n << BDRV_SECTOR_BITS,
1919 BDRV_REQ_MAY_UNMAP);
1920 if (ret < 0) {
1921 return ret;
1922 }
1923 break;
1924 }
1925
1926 sector_num += n;
1927 nb_sectors -= n;
1928 buf += n * BDRV_SECTOR_SIZE;
1929 }
1930
1931 return 0;
1932 }
1933
1934 static int coroutine_fn convert_co_copy_range(ImgConvertState *s, int64_t sector_num,
1935 int nb_sectors)
1936 {
1937 int n, ret;
1938
1939 while (nb_sectors > 0) {
1940 BlockBackend *blk;
1941 int src_cur;
1942 int64_t bs_sectors, src_cur_offset;
1943 int64_t offset;
1944
1945 convert_select_part(s, sector_num, &src_cur, &src_cur_offset);
1946 offset = (sector_num - src_cur_offset) << BDRV_SECTOR_BITS;
1947 blk = s->src[src_cur];
1948 bs_sectors = s->src_sectors[src_cur];
1949
1950 n = MIN(nb_sectors, bs_sectors - (sector_num - src_cur_offset));
1951
1952 ret = blk_co_copy_range(blk, offset, s->target,
1953 sector_num << BDRV_SECTOR_BITS,
1954 n << BDRV_SECTOR_BITS, 0, 0);
1955 if (ret < 0) {
1956 return ret;
1957 }
1958
1959 sector_num += n;
1960 nb_sectors -= n;
1961 }
1962 return 0;
1963 }
1964
1965 static void coroutine_fn convert_co_do_copy(void *opaque)
1966 {
1967 ImgConvertState *s = opaque;
1968 uint8_t *buf = NULL;
1969 int ret, i;
1970 int index = -1;
1971
1972 for (i = 0; i < s->num_coroutines; i++) {
1973 if (s->co[i] == qemu_coroutine_self()) {
1974 index = i;
1975 break;
1976 }
1977 }
1978 assert(index >= 0);
1979
1980 s->running_coroutines++;
1981 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1982
1983 while (1) {
1984 int n;
1985 int64_t sector_num;
1986 enum ImgConvertBlockStatus status;
1987 bool copy_range;
1988
1989 qemu_co_mutex_lock(&s->lock);
1990 if (s->ret != -EINPROGRESS || s->sector_num >= s->total_sectors) {
1991 qemu_co_mutex_unlock(&s->lock);
1992 break;
1993 }
1994 WITH_GRAPH_RDLOCK_GUARD() {
1995 n = convert_iteration_sectors(s, s->sector_num);
1996 }
1997 if (n < 0) {
1998 qemu_co_mutex_unlock(&s->lock);
1999 s->ret = n;
2000 break;
2001 }
2002 /* save current sector and allocation status to local variables */
2003 sector_num = s->sector_num;
2004 status = s->status;
2005 if (!s->min_sparse && s->status == BLK_ZERO) {
2006 n = MIN(n, s->buf_sectors);
2007 }
2008 /* increment global sector counter so that other coroutines can
2009 * already continue reading beyond this request */
2010 s->sector_num += n;
2011 qemu_co_mutex_unlock(&s->lock);
2012
2013 if (status == BLK_DATA || (!s->min_sparse && status == BLK_ZERO)) {
2014 s->allocated_done += n;
2015 qemu_progress_print(100.0 * s->allocated_done /
2016 s->allocated_sectors, 0);
2017 }
2018
2019 retry:
2020 copy_range = s->copy_range && s->status == BLK_DATA;
2021 if (status == BLK_DATA && !copy_range) {
2022 ret = convert_co_read(s, sector_num, n, buf);
2023 if (ret < 0) {
2024 error_report("error while reading at byte %lld: %s",
2025 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2026 s->ret = ret;
2027 }
2028 } else if (!s->min_sparse && status == BLK_ZERO) {
2029 status = BLK_DATA;
2030 memset(buf, 0x00, n * BDRV_SECTOR_SIZE);
2031 }
2032
2033 if (s->wr_in_order) {
2034 /* keep writes in order */
2035 while (s->wr_offs != sector_num && s->ret == -EINPROGRESS) {
2036 s->wait_sector_num[index] = sector_num;
2037 qemu_coroutine_yield();
2038 }
2039 s->wait_sector_num[index] = -1;
2040 }
2041
2042 if (s->ret == -EINPROGRESS) {
2043 if (copy_range) {
2044 ret = convert_co_copy_range(s, sector_num, n);
2045 if (ret) {
2046 s->copy_range = false;
2047 goto retry;
2048 }
2049 } else {
2050 ret = convert_co_write(s, sector_num, n, buf, status);
2051 }
2052 if (ret < 0) {
2053 error_report("error while writing at byte %lld: %s",
2054 sector_num * BDRV_SECTOR_SIZE, strerror(-ret));
2055 s->ret = ret;
2056 }
2057 }
2058
2059 if (s->wr_in_order) {
2060 /* reenter the coroutine that might have waited
2061 * for this write to complete */
2062 s->wr_offs = sector_num + n;
2063 for (i = 0; i < s->num_coroutines; i++) {
2064 if (s->co[i] && s->wait_sector_num[i] == s->wr_offs) {
2065 /*
2066 * A -> B -> A cannot occur because A has
2067 * s->wait_sector_num[i] == -1 during A -> B. Therefore
2068 * B will never enter A during this time window.
2069 */
2070 qemu_coroutine_enter(s->co[i]);
2071 break;
2072 }
2073 }
2074 }
2075 }
2076
2077 qemu_vfree(buf);
2078 s->co[index] = NULL;
2079 s->running_coroutines--;
2080 if (!s->running_coroutines && s->ret == -EINPROGRESS) {
2081 /* the convert job finished successfully */
2082 s->ret = 0;
2083 }
2084 }
2085
2086 static int convert_do_copy(ImgConvertState *s)
2087 {
2088 int ret, i, n;
2089 int64_t sector_num = 0;
2090
2091 /* Check whether we have zero initialisation or can get it efficiently */
2092 if (!s->has_zero_init && s->target_is_new && s->min_sparse &&
2093 !s->target_has_backing) {
2094 s->has_zero_init = bdrv_has_zero_init(blk_bs(s->target));
2095 }
2096
2097 /* Allocate buffer for copied data. For compressed images, only one cluster
2098 * can be copied at a time. */
2099 if (s->compressed) {
2100 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
2101 error_report("invalid cluster size");
2102 return -EINVAL;
2103 }
2104 s->buf_sectors = s->cluster_sectors;
2105 }
2106
2107 while (sector_num < s->total_sectors) {
2108 n = convert_iteration_sectors(s, sector_num);
2109 if (n < 0) {
2110 return n;
2111 }
2112 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
2113 {
2114 s->allocated_sectors += n;
2115 }
2116 sector_num += n;
2117 }
2118
2119 /* Do the copy */
2120 s->sector_next_status = 0;
2121 s->ret = -EINPROGRESS;
2122
2123 qemu_co_mutex_init(&s->lock);
2124 for (i = 0; i < s->num_coroutines; i++) {
2125 s->co[i] = qemu_coroutine_create(convert_co_do_copy, s);
2126 s->wait_sector_num[i] = -1;
2127 qemu_coroutine_enter(s->co[i]);
2128 }
2129
2130 while (s->running_coroutines) {
2131 main_loop_wait(false);
2132 }
2133
2134 if (s->compressed && !s->ret) {
2135 /* signal EOF to align */
2136 ret = blk_pwrite_compressed(s->target, 0, 0, NULL);
2137 if (ret < 0) {
2138 return ret;
2139 }
2140 }
2141
2142 return s->ret;
2143 }
2144
2145 /* Check that bitmaps can be copied, or output an error */
2146 static int convert_check_bitmaps(BlockDriverState *src, bool skip_broken)
2147 {
2148 BdrvDirtyBitmap *bm;
2149
2150 if (!bdrv_supports_persistent_dirty_bitmap(src)) {
2151 error_report("Source lacks bitmap support");
2152 return -1;
2153 }
2154 FOR_EACH_DIRTY_BITMAP(src, bm) {
2155 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2156 continue;
2157 }
2158 if (!skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2159 error_report("Cannot copy inconsistent bitmap '%s'",
2160 bdrv_dirty_bitmap_name(bm));
2161 error_printf("Try --skip-broken-bitmaps, or "
2162 "use 'qemu-img bitmap --remove' to delete it\n");
2163 return -1;
2164 }
2165 }
2166 return 0;
2167 }
2168
2169 static int convert_copy_bitmaps(BlockDriverState *src, BlockDriverState *dst,
2170 bool skip_broken)
2171 {
2172 BdrvDirtyBitmap *bm;
2173 Error *err = NULL;
2174
2175 FOR_EACH_DIRTY_BITMAP(src, bm) {
2176 const char *name;
2177
2178 if (!bdrv_dirty_bitmap_get_persistence(bm)) {
2179 continue;
2180 }
2181 name = bdrv_dirty_bitmap_name(bm);
2182 if (skip_broken && bdrv_dirty_bitmap_inconsistent(bm)) {
2183 warn_report("Skipping inconsistent bitmap '%s'", name);
2184 continue;
2185 }
2186 qmp_block_dirty_bitmap_add(dst->node_name, name,
2187 true, bdrv_dirty_bitmap_granularity(bm),
2188 true, true,
2189 true, !bdrv_dirty_bitmap_enabled(bm),
2190 &err);
2191 if (err) {
2192 error_reportf_err(err, "Failed to create bitmap %s: ", name);
2193 return -1;
2194 }
2195
2196 do_dirty_bitmap_merge(dst->node_name, name, src->node_name, name,
2197 &err);
2198 if (err) {
2199 error_reportf_err(err, "Failed to populate bitmap %s: ", name);
2200 qmp_block_dirty_bitmap_remove(dst->node_name, name, NULL);
2201 return -1;
2202 }
2203 }
2204
2205 return 0;
2206 }
2207
2208 #define MAX_BUF_SECTORS 32768
2209
2210 static void set_rate_limit(BlockBackend *blk, int64_t rate_limit)
2211 {
2212 ThrottleConfig cfg;
2213
2214 throttle_config_init(&cfg);
2215 cfg.buckets[THROTTLE_BPS_WRITE].avg = rate_limit;
2216
2217 blk_io_limits_enable(blk, CONVERT_THROTTLE_GROUP);
2218 blk_set_io_limits(blk, &cfg);
2219 }
2220
2221 static int img_convert(int argc, char **argv)
2222 {
2223 int c, bs_i, flags, src_flags = BDRV_O_NO_SHARE;
2224 const char *fmt = NULL, *out_fmt = NULL, *cache = "unsafe",
2225 *src_cache = BDRV_DEFAULT_CACHE, *out_baseimg = NULL,
2226 *out_filename, *out_baseimg_param, *snapshot_name = NULL,
2227 *backing_fmt = NULL;
2228 BlockDriver *drv = NULL, *proto_drv = NULL;
2229 BlockDriverInfo bdi;
2230 BlockDriverState *out_bs;
2231 QemuOpts *opts = NULL, *sn_opts = NULL;
2232 QemuOptsList *create_opts = NULL;
2233 QDict *open_opts = NULL;
2234 char *options = NULL;
2235 Error *local_err = NULL;
2236 bool writethrough, src_writethrough, image_opts = false,
2237 skip_create = false, progress = false, tgt_image_opts = false;
2238 int64_t ret = -EINVAL;
2239 bool force_share = false;
2240 bool explict_min_sparse = false;
2241 bool bitmaps = false;
2242 bool skip_broken = false;
2243 int64_t rate_limit = 0;
2244
2245 ImgConvertState s = (ImgConvertState) {
2246 /* Need at least 4k of zeros for sparse detection */
2247 .min_sparse = 8,
2248 .copy_range = false,
2249 .buf_sectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE,
2250 .wr_in_order = true,
2251 .num_coroutines = 8,
2252 };
2253
2254 for(;;) {
2255 static const struct option long_options[] = {
2256 {"help", no_argument, 0, 'h'},
2257 {"object", required_argument, 0, OPTION_OBJECT},
2258 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2259 {"force-share", no_argument, 0, 'U'},
2260 {"target-image-opts", no_argument, 0, OPTION_TARGET_IMAGE_OPTS},
2261 {"salvage", no_argument, 0, OPTION_SALVAGE},
2262 {"target-is-zero", no_argument, 0, OPTION_TARGET_IS_ZERO},
2263 {"bitmaps", no_argument, 0, OPTION_BITMAPS},
2264 {"skip-broken-bitmaps", no_argument, 0, OPTION_SKIP_BROKEN},
2265 {0, 0, 0, 0}
2266 };
2267 c = getopt_long(argc, argv, ":hf:O:B:CcF:o:l:S:pt:T:qnm:WUr:",
2268 long_options, NULL);
2269 if (c == -1) {
2270 break;
2271 }
2272 switch(c) {
2273 case ':':
2274 missing_argument(argv[optind - 1]);
2275 break;
2276 case '?':
2277 unrecognized_option(argv[optind - 1]);
2278 break;
2279 case 'h':
2280 help();
2281 break;
2282 case 'f':
2283 fmt = optarg;
2284 break;
2285 case 'O':
2286 out_fmt = optarg;
2287 break;
2288 case 'B':
2289 out_baseimg = optarg;
2290 break;
2291 case 'C':
2292 s.copy_range = true;
2293 break;
2294 case 'c':
2295 s.compressed = true;
2296 break;
2297 case 'F':
2298 backing_fmt = optarg;
2299 break;
2300 case 'o':
2301 if (accumulate_options(&options, optarg) < 0) {
2302 goto fail_getopt;
2303 }
2304 break;
2305 case 'l':
2306 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
2307 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
2308 optarg, false);
2309 if (!sn_opts) {
2310 error_report("Failed in parsing snapshot param '%s'",
2311 optarg);
2312 goto fail_getopt;
2313 }
2314 } else {
2315 snapshot_name = optarg;
2316 }
2317 break;
2318 case 'S':
2319 {
2320 int64_t sval;
2321
2322 sval = cvtnum("buffer size for sparse output", optarg);
2323 if (sval < 0) {
2324 goto fail_getopt;
2325 } else if (!QEMU_IS_ALIGNED(sval, BDRV_SECTOR_SIZE) ||
2326 sval / BDRV_SECTOR_SIZE > MAX_BUF_SECTORS) {
2327 error_report("Invalid buffer size for sparse output specified. "
2328 "Valid sizes are multiples of %llu up to %llu. Select "
2329 "0 to disable sparse detection (fully allocates output).",
2330 BDRV_SECTOR_SIZE, MAX_BUF_SECTORS * BDRV_SECTOR_SIZE);
2331 goto fail_getopt;
2332 }
2333
2334 s.min_sparse = sval / BDRV_SECTOR_SIZE;
2335 explict_min_sparse = true;
2336 break;
2337 }
2338 case 'p':
2339 progress = true;
2340 break;
2341 case 't':
2342 cache = optarg;
2343 break;
2344 case 'T':
2345 src_cache = optarg;
2346 break;
2347 case 'q':
2348 s.quiet = true;
2349 break;
2350 case 'n':
2351 skip_create = true;
2352 break;
2353 case 'm':
2354 if (qemu_strtol(optarg, NULL, 0, &s.num_coroutines) ||
2355 s.num_coroutines < 1 || s.num_coroutines > MAX_COROUTINES) {
2356 error_report("Invalid number of coroutines. Allowed number of"
2357 " coroutines is between 1 and %d", MAX_COROUTINES);
2358 goto fail_getopt;
2359 }
2360 break;
2361 case 'W':
2362 s.wr_in_order = false;
2363 break;
2364 case 'U':
2365 force_share = true;
2366 break;
2367 case 'r':
2368 rate_limit = cvtnum("rate limit", optarg);
2369 if (rate_limit < 0) {
2370 goto fail_getopt;
2371 }
2372 break;
2373 case OPTION_OBJECT:
2374 user_creatable_process_cmdline(optarg);
2375 break;
2376 case OPTION_IMAGE_OPTS:
2377 image_opts = true;
2378 break;
2379 case OPTION_SALVAGE:
2380 s.salvage = true;
2381 break;
2382 case OPTION_TARGET_IMAGE_OPTS:
2383 tgt_image_opts = true;
2384 break;
2385 case OPTION_TARGET_IS_ZERO:
2386 /*
2387 * The user asserting that the target is blank has the
2388 * same effect as the target driver supporting zero
2389 * initialisation.
2390 */
2391 s.has_zero_init = true;
2392 break;
2393 case OPTION_BITMAPS:
2394 bitmaps = true;
2395 break;
2396 case OPTION_SKIP_BROKEN:
2397 skip_broken = true;
2398 break;
2399 }
2400 }
2401
2402 if (!out_fmt && !tgt_image_opts) {
2403 out_fmt = "raw";
2404 }
2405
2406 if (skip_broken && !bitmaps) {
2407 error_report("Use of --skip-broken-bitmaps requires --bitmaps");
2408 goto fail_getopt;
2409 }
2410
2411 if (s.compressed && s.copy_range) {
2412 error_report("Cannot enable copy offloading when -c is used");
2413 goto fail_getopt;
2414 }
2415
2416 if (explict_min_sparse && s.copy_range) {
2417 error_report("Cannot enable copy offloading when -S is used");
2418 goto fail_getopt;
2419 }
2420
2421 if (s.copy_range && s.salvage) {
2422 error_report("Cannot use copy offloading in salvaging mode");
2423 goto fail_getopt;
2424 }
2425
2426 if (tgt_image_opts && !skip_create) {
2427 error_report("--target-image-opts requires use of -n flag");
2428 goto fail_getopt;
2429 }
2430
2431 if (skip_create && options) {
2432 error_report("-o has no effect when skipping image creation");
2433 goto fail_getopt;
2434 }
2435
2436 if (s.has_zero_init && !skip_create) {
2437 error_report("--target-is-zero requires use of -n flag");
2438 goto fail_getopt;
2439 }
2440
2441 s.src_num = argc - optind - 1;
2442 out_filename = s.src_num >= 1 ? argv[argc - 1] : NULL;
2443
2444 if (options && has_help_option(options)) {
2445 if (out_fmt) {
2446 ret = print_block_option_help(out_filename, out_fmt);
2447 goto fail_getopt;
2448 } else {
2449 error_report("Option help requires a format be specified");
2450 goto fail_getopt;
2451 }
2452 }
2453
2454 if (s.src_num < 1) {
2455 error_report("Must specify image file name");
2456 goto fail_getopt;
2457 }
2458
2459 /* ret is still -EINVAL until here */
2460 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2461 if (ret < 0) {
2462 error_report("Invalid source cache option: %s", src_cache);
2463 goto fail_getopt;
2464 }
2465
2466 /* Initialize before goto out */
2467 if (s.quiet) {
2468 progress = false;
2469 }
2470 qemu_progress_init(progress, 1.0);
2471 qemu_progress_print(0, 100);
2472
2473 s.src = g_new0(BlockBackend *, s.src_num);
2474 s.src_sectors = g_new(int64_t, s.src_num);
2475 s.src_alignment = g_new(int, s.src_num);
2476
2477 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2478 BlockDriverState *src_bs;
2479 s.src[bs_i] = img_open(image_opts, argv[optind + bs_i],
2480 fmt, src_flags, src_writethrough, s.quiet,
2481 force_share);
2482 if (!s.src[bs_i]) {
2483 ret = -1;
2484 goto out;
2485 }
2486 s.src_sectors[bs_i] = blk_nb_sectors(s.src[bs_i]);
2487 if (s.src_sectors[bs_i] < 0) {
2488 error_report("Could not get size of %s: %s",
2489 argv[optind + bs_i], strerror(-s.src_sectors[bs_i]));
2490 ret = -1;
2491 goto out;
2492 }
2493 src_bs = blk_bs(s.src[bs_i]);
2494 s.src_alignment[bs_i] = DIV_ROUND_UP(src_bs->bl.request_alignment,
2495 BDRV_SECTOR_SIZE);
2496 if (!bdrv_get_info(src_bs, &bdi)) {
2497 s.src_alignment[bs_i] = MAX(s.src_alignment[bs_i],
2498 bdi.cluster_size / BDRV_SECTOR_SIZE);
2499 }
2500 s.total_sectors += s.src_sectors[bs_i];
2501 }
2502
2503 if (sn_opts) {
2504 bdrv_snapshot_load_tmp(blk_bs(s.src[0]),
2505 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
2506 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
2507 &local_err);
2508 } else if (snapshot_name != NULL) {
2509 if (s.src_num > 1) {
2510 error_report("No support for concatenating multiple snapshot");
2511 ret = -1;
2512 goto out;
2513 }
2514
2515 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(s.src[0]), snapshot_name,
2516 &local_err);
2517 }
2518 if (local_err) {
2519 error_reportf_err(local_err, "Failed to load snapshot: ");
2520 ret = -1;
2521 goto out;
2522 }
2523
2524 if (!skip_create) {
2525 /* Find driver and parse its options */
2526 drv = bdrv_find_format(out_fmt);
2527 if (!drv) {
2528 error_report("Unknown file format '%s'", out_fmt);
2529 ret = -1;
2530 goto out;
2531 }
2532
2533 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
2534 if (!proto_drv) {
2535 error_report_err(local_err);
2536 ret = -1;
2537 goto out;
2538 }
2539
2540 if (!drv->create_opts) {
2541 error_report("Format driver '%s' does not support image creation",
2542 drv->format_name);
2543 ret = -1;
2544 goto out;
2545 }
2546
2547 if (!proto_drv->create_opts) {
2548 error_report("Protocol driver '%s' does not support image creation",
2549 proto_drv->format_name);
2550 ret = -1;
2551 goto out;
2552 }
2553
2554 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2555 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2556
2557 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2558 if (options) {
2559 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
2560 error_report_err(local_err);
2561 ret = -1;
2562 goto out;
2563 }
2564 }
2565
2566 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
2567 s.total_sectors * BDRV_SECTOR_SIZE, &error_abort);
2568 ret = add_old_style_options(out_fmt, opts, out_baseimg, backing_fmt);
2569 if (ret < 0) {
2570 goto out;
2571 }
2572 }
2573
2574 /* Get backing file name if -o backing_file was used */
2575 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2576 if (out_baseimg_param) {
2577 out_baseimg = out_baseimg_param;
2578 }
2579 s.target_has_backing = (bool) out_baseimg;
2580
2581 if (s.has_zero_init && s.target_has_backing) {
2582 error_report("Cannot use --target-is-zero when the destination "
2583 "image has a backing file");
2584 goto out;
2585 }
2586
2587 if (s.src_num > 1 && out_baseimg) {
2588 error_report("Having a backing file for the target makes no sense when "
2589 "concatenating multiple input images");
2590 ret = -1;
2591 goto out;
2592 }
2593
2594 if (out_baseimg_param) {
2595 if (!qemu_opt_get(opts, BLOCK_OPT_BACKING_FMT)) {
2596 error_report("Use of backing file requires explicit "
2597 "backing format");
2598 ret = -1;
2599 goto out;
2600 }
2601 }
2602
2603 /* Check if compression is supported */
2604 if (s.compressed) {
2605 bool encryption =
2606 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2607 const char *encryptfmt =
2608 qemu_opt_get(opts, BLOCK_OPT_ENCRYPT_FORMAT);
2609 const char *preallocation =
2610 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2611
2612 if (drv && !block_driver_can_compress(drv)) {
2613 error_report("Compression not supported for this file format");
2614 ret = -1;
2615 goto out;
2616 }
2617
2618 if (encryption || encryptfmt) {
2619 error_report("Compression and encryption not supported at "
2620 "the same time");
2621 ret = -1;
2622 goto out;
2623 }
2624
2625 if (preallocation
2626 && strcmp(preallocation, "off"))
2627 {
2628 error_report("Compression and preallocation not supported at "
2629 "the same time");
2630 ret = -1;
2631 goto out;
2632 }
2633 }
2634
2635 /* Determine if bitmaps need copying */
2636 if (bitmaps) {
2637 if (s.src_num > 1) {
2638 error_report("Copying bitmaps only possible with single source");
2639 ret = -1;
2640 goto out;
2641 }
2642 ret = convert_check_bitmaps(blk_bs(s.src[0]), skip_broken);
2643 if (ret < 0) {
2644 goto out;
2645 }
2646 }
2647
2648 /*
2649 * The later open call will need any decryption secrets, and
2650 * bdrv_create() will purge "opts", so extract them now before
2651 * they are lost.
2652 */
2653 if (!skip_create) {
2654 open_opts = qdict_new();
2655 qemu_opt_foreach(opts, img_add_key_secrets, open_opts, &error_abort);
2656
2657 /* Create the new image */
2658 ret = bdrv_create(drv, out_filename, opts, &local_err);
2659 if (ret < 0) {
2660 error_reportf_err(local_err, "%s: error while converting %s: ",
2661 out_filename, out_fmt);
2662 goto out;
2663 }
2664 }
2665
2666 s.target_is_new = !skip_create;
2667
2668 flags = s.min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2669 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2670 if (ret < 0) {
2671 error_report("Invalid cache option: %s", cache);
2672 goto out;
2673 }
2674
2675 if (flags & BDRV_O_NOCACHE) {
2676 /*
2677 * If we open the target with O_DIRECT, it may be necessary to
2678 * extend its size to align to the physical sector size.
2679 */
2680 flags |= BDRV_O_RESIZE;
2681 }
2682
2683 if (skip_create) {
2684 s.target = img_open(tgt_image_opts, out_filename, out_fmt,
2685 flags, writethrough, s.quiet, false);
2686 } else {
2687 /* TODO ultimately we should allow --target-image-opts
2688 * to be used even when -n is not given.
2689 * That has to wait for bdrv_create to be improved
2690 * to allow filenames in option syntax
2691 */
2692 s.target = img_open_file(out_filename, open_opts, out_fmt,
2693 flags, writethrough, s.quiet, false);
2694 open_opts = NULL; /* blk_new_open will have freed it */
2695 }
2696 if (!s.target) {
2697 ret = -1;
2698 goto out;
2699 }
2700 out_bs = blk_bs(s.target);
2701
2702 if (bitmaps && !bdrv_supports_persistent_dirty_bitmap(out_bs)) {
2703 error_report("Format driver '%s' does not support bitmaps",
2704 out_bs->drv->format_name);
2705 ret = -1;
2706 goto out;
2707 }
2708
2709 if (s.compressed && !block_driver_can_compress(out_bs->drv)) {
2710 error_report("Compression not supported for this file format");
2711 ret = -1;
2712 goto out;
2713 }
2714
2715 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2716 * or discard_alignment of the out_bs is greater. Limit to
2717 * MAX_BUF_SECTORS as maximum which is currently 32768 (16MB). */
2718 s.buf_sectors = MIN(MAX_BUF_SECTORS,
2719 MAX(s.buf_sectors,
2720 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2721 out_bs->bl.pdiscard_alignment >>
2722 BDRV_SECTOR_BITS)));
2723
2724 /* try to align the write requests to the destination to avoid unnecessary
2725 * RMW cycles. */
2726 s.alignment = MAX(pow2floor(s.min_sparse),
2727 DIV_ROUND_UP(out_bs->bl.request_alignment,
2728 BDRV_SECTOR_SIZE));
2729 assert(is_power_of_2(s.alignment));
2730
2731 if (skip_create) {
2732 int64_t output_sectors = blk_nb_sectors(s.target);
2733 if (output_sectors < 0) {
2734 error_report("unable to get output image length: %s",
2735 strerror(-output_sectors));
2736 ret = -1;
2737 goto out;
2738 } else if (output_sectors < s.total_sectors) {
2739 error_report("output file is smaller than input file");
2740 ret = -1;
2741 goto out;
2742 }
2743 }
2744
2745 if (s.target_has_backing && s.target_is_new) {
2746 /* Errors are treated as "backing length unknown" (which means
2747 * s.target_backing_sectors has to be negative, which it will
2748 * be automatically). The backing file length is used only
2749 * for optimizations, so such a case is not fatal. */
2750 s.target_backing_sectors =
2751 bdrv_nb_sectors(bdrv_backing_chain_next(out_bs));
2752 } else {
2753 s.target_backing_sectors = -1;
2754 }
2755
2756 ret = bdrv_get_info(out_bs, &bdi);
2757 if (ret < 0) {
2758 if (s.compressed) {
2759 error_report("could not get block driver info");
2760 goto out;
2761 }
2762 } else {
2763 s.compressed = s.compressed || bdi.needs_compressed_writes;
2764 s.cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2765 }
2766
2767 if (rate_limit) {
2768 set_rate_limit(s.target, rate_limit);
2769 }
2770
2771 ret = convert_do_copy(&s);
2772
2773 /* Now copy the bitmaps */
2774 if (bitmaps && ret == 0) {
2775 ret = convert_copy_bitmaps(blk_bs(s.src[0]), out_bs, skip_broken);
2776 }
2777
2778 out:
2779 if (!ret) {
2780 qemu_progress_print(100, 0);
2781 }
2782 qemu_progress_end();
2783 qemu_opts_del(opts);
2784 qemu_opts_free(create_opts);
2785 qobject_unref(open_opts);
2786 blk_unref(s.target);
2787 if (s.src) {
2788 for (bs_i = 0; bs_i < s.src_num; bs_i++) {
2789 blk_unref(s.src[bs_i]);
2790 }
2791 g_free(s.src);
2792 }
2793 g_free(s.src_sectors);
2794 g_free(s.src_alignment);
2795 fail_getopt:
2796 qemu_opts_del(sn_opts);
2797 g_free(options);
2798
2799 return !!ret;
2800 }
2801
2802
2803 static void dump_snapshots(BlockDriverState *bs)
2804 {
2805 QEMUSnapshotInfo *sn_tab, *sn;
2806 int nb_sns, i;
2807
2808 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2809 if (nb_sns <= 0)
2810 return;
2811 printf("Snapshot list:\n");
2812 bdrv_snapshot_dump(NULL);
2813 printf("\n");
2814 for(i = 0; i < nb_sns; i++) {
2815 sn = &sn_tab[i];
2816 bdrv_snapshot_dump(sn);
2817 printf("\n");
2818 }
2819 g_free(sn_tab);
2820 }
2821
2822 static void dump_json_block_graph_info_list(BlockGraphInfoList *list)
2823 {
2824 GString *str;
2825 QObject *obj;
2826 Visitor *v = qobject_output_visitor_new(&obj);
2827
2828 visit_type_BlockGraphInfoList(v, NULL, &list, &error_abort);
2829 visit_complete(v, &obj);
2830 str = qobject_to_json_pretty(obj, true);
2831 assert(str != NULL);
2832 printf("%s\n", str->str);
2833 qobject_unref(obj);
2834 visit_free(v);
2835 g_string_free(str, true);
2836 }
2837
2838 static void dump_json_block_graph_info(BlockGraphInfo *info)
2839 {
2840 GString *str;
2841 QObject *obj;
2842 Visitor *v = qobject_output_visitor_new(&obj);
2843
2844 visit_type_BlockGraphInfo(v, NULL, &info, &error_abort);
2845 visit_complete(v, &obj);
2846 str = qobject_to_json_pretty(obj, true);
2847 assert(str != NULL);
2848 printf("%s\n", str->str);
2849 qobject_unref(obj);
2850 visit_free(v);
2851 g_string_free(str, true);
2852 }
2853
2854 static void dump_human_image_info(BlockGraphInfo *info, int indentation,
2855 const char *path)
2856 {
2857 BlockChildInfoList *children_list;
2858
2859 bdrv_node_info_dump(qapi_BlockGraphInfo_base(info), indentation,
2860 info->children == NULL);
2861
2862 for (children_list = info->children; children_list;
2863 children_list = children_list->next)
2864 {
2865 BlockChildInfo *child = children_list->value;
2866 g_autofree char *child_path = NULL;
2867
2868 printf("%*sChild node '%s%s':\n",
2869 indentation * 4, "", path, child->name);
2870 child_path = g_strdup_printf("%s%s/", path, child->name);
2871 dump_human_image_info(child->info, indentation + 1, child_path);
2872 }
2873 }
2874
2875 static void dump_human_image_info_list(BlockGraphInfoList *list)
2876 {
2877 BlockGraphInfoList *elem;
2878 bool delim = false;
2879
2880 for (elem = list; elem; elem = elem->next) {
2881 if (delim) {
2882 printf("\n");
2883 }
2884 delim = true;
2885
2886 dump_human_image_info(elem->value, 0, "/");
2887 }
2888 }
2889
2890 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2891 {
2892 return strcmp(a, b) == 0;
2893 }
2894
2895 /**
2896 * Open an image file chain and return an BlockGraphInfoList
2897 *
2898 * @filename: topmost image filename
2899 * @fmt: topmost image format (may be NULL to autodetect)
2900 * @chain: true - enumerate entire backing file chain
2901 * false - only topmost image file
2902 *
2903 * Returns a list of BlockNodeInfo objects or NULL if there was an error
2904 * opening an image file. If there was an error a message will have been
2905 * printed to stderr.
2906 */
2907 static BlockGraphInfoList *collect_image_info_list(bool image_opts,
2908 const char *filename,
2909 const char *fmt,
2910 bool chain, bool force_share)
2911 {
2912 BlockGraphInfoList *head = NULL;
2913 BlockGraphInfoList **tail = &head;
2914 GHashTable *filenames;
2915 Error *err = NULL;
2916
2917 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2918
2919 while (filename) {
2920 BlockBackend *blk;
2921 BlockDriverState *bs;
2922 BlockGraphInfo *info;
2923
2924 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2925 error_report("Backing file '%s' creates an infinite loop.",
2926 filename);
2927 goto err;
2928 }
2929 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2930
2931 blk = img_open(image_opts, filename, fmt,
2932 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false,
2933 force_share);
2934 if (!blk) {
2935 goto err;
2936 }
2937 bs = blk_bs(blk);
2938
2939 /*
2940 * Note that the returned BlockGraphInfo object will not have
2941 * information about this image's backing node, because we have opened
2942 * it with BDRV_O_NO_BACKING. Printing this object will therefore not
2943 * duplicate the backing chain information that we obtain by walking
2944 * the chain manually here.
2945 */
2946 bdrv_query_block_graph_info(bs, &info, &err);
2947 if (err) {
2948 error_report_err(err);
2949 blk_unref(blk);
2950 goto err;
2951 }
2952
2953 QAPI_LIST_APPEND(tail, info);
2954
2955 blk_unref(blk);
2956
2957 /* Clear parameters that only apply to the topmost image */
2958 filename = fmt = NULL;
2959 image_opts = false;
2960
2961 if (chain) {
2962 if (info->full_backing_filename) {
2963 filename = info->full_backing_filename;
2964 } else if (info->backing_filename) {
2965 error_report("Could not determine absolute backing filename,"
2966 " but backing filename '%s' present",
2967 info->backing_filename);
2968 goto err;
2969 }
2970 if (info->backing_filename_format) {
2971 fmt = info->backing_filename_format;
2972 }
2973 }
2974 }
2975 g_hash_table_destroy(filenames);
2976 return head;
2977
2978 err:
2979 qapi_free_BlockGraphInfoList(head);
2980 g_hash_table_destroy(filenames);
2981 return NULL;
2982 }
2983
2984 static int img_info(int argc, char **argv)
2985 {
2986 int c;
2987 OutputFormat output_format = OFORMAT_HUMAN;
2988 bool chain = false;
2989 const char *filename, *fmt, *output;
2990 BlockGraphInfoList *list;
2991 bool image_opts = false;
2992 bool force_share = false;
2993
2994 fmt = NULL;
2995 output = NULL;
2996 for(;;) {
2997 int option_index = 0;
2998 static const struct option long_options[] = {
2999 {"help", no_argument, 0, 'h'},
3000 {"format", required_argument, 0, 'f'},
3001 {"output", required_argument, 0, OPTION_OUTPUT},
3002 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
3003 {"object", required_argument, 0, OPTION_OBJECT},
3004 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3005 {"force-share", no_argument, 0, 'U'},
3006 {0, 0, 0, 0}
3007 };
3008 c = getopt_long(argc, argv, ":f:hU",
3009 long_options, &option_index);
3010 if (c == -1) {
3011 break;
3012 }
3013 switch(c) {
3014 case ':':
3015 missing_argument(argv[optind - 1]);
3016 break;
3017 case '?':
3018 unrecognized_option(argv[optind - 1]);
3019 break;
3020 case 'h':
3021 help();
3022 break;
3023 case 'f':
3024 fmt = optarg;
3025 break;
3026 case 'U':
3027 force_share = true;
3028 break;
3029 case OPTION_OUTPUT:
3030 output = optarg;
3031 break;
3032 case OPTION_BACKING_CHAIN:
3033 chain = true;
3034 break;
3035 case OPTION_OBJECT:
3036 user_creatable_process_cmdline(optarg);
3037 break;
3038 case OPTION_IMAGE_OPTS:
3039 image_opts = true;
3040 break;
3041 }
3042 }
3043 if (optind != argc - 1) {
3044 error_exit("Expecting one image file name");
3045 }
3046 filename = argv[optind++];
3047
3048 if (output && !strcmp(output, "json")) {
3049 output_format = OFORMAT_JSON;
3050 } else if (output && !strcmp(output, "human")) {
3051 output_format = OFORMAT_HUMAN;
3052 } else if (output) {
3053 error_report("--output must be used with human or json as argument.");
3054 return 1;
3055 }
3056
3057 list = collect_image_info_list(image_opts, filename, fmt, chain,
3058 force_share);
3059 if (!list) {
3060 return 1;
3061 }
3062
3063 switch (output_format) {
3064 case OFORMAT_HUMAN:
3065 dump_human_image_info_list(list);
3066 break;
3067 case OFORMAT_JSON:
3068 if (chain) {
3069 dump_json_block_graph_info_list(list);
3070 } else {
3071 dump_json_block_graph_info(list->value);
3072 }
3073 break;
3074 }
3075
3076 qapi_free_BlockGraphInfoList(list);
3077 return 0;
3078 }
3079
3080 static int dump_map_entry(OutputFormat output_format, MapEntry *e,
3081 MapEntry *next)
3082 {
3083 switch (output_format) {
3084 case OFORMAT_HUMAN:
3085 if (e->data && !e->has_offset) {
3086 error_report("File contains external, encrypted or compressed clusters.");
3087 return -1;
3088 }
3089 if (e->data && !e->zero) {
3090 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
3091 e->start, e->length,
3092 e->has_offset ? e->offset : 0,
3093 e->filename ?: "");
3094 }
3095 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
3096 * Modify the flags here to allow more coalescing.
3097 */
3098 if (next && (!next->data || next->zero)) {
3099 next->data = false;
3100 next->zero = true;
3101 }
3102 break;
3103 case OFORMAT_JSON:
3104 printf("{ \"start\": %"PRId64", \"length\": %"PRId64","
3105 " \"depth\": %"PRId64", \"present\": %s, \"zero\": %s,"
3106 " \"data\": %s", e->start, e->length, e->depth,
3107 e->present ? "true" : "false",
3108 e->zero ? "true" : "false",
3109 e->data ? "true" : "false");
3110 if (e->has_offset) {
3111 printf(", \"offset\": %"PRId64"", e->offset);
3112 }
3113 putchar('}');
3114
3115 if (next) {
3116 puts(",");
3117 }
3118 break;
3119 }
3120 return 0;
3121 }
3122
3123 static int get_block_status(BlockDriverState *bs, int64_t offset,
3124 int64_t bytes, MapEntry *e)
3125 {
3126 int ret;
3127 int depth;
3128 BlockDriverState *file;
3129 bool has_offset;
3130 int64_t map;
3131 char *filename = NULL;
3132
3133 /* As an optimization, we could cache the current range of unallocated
3134 * clusters in each file of the chain, and avoid querying the same
3135 * range repeatedly.
3136 */
3137
3138 depth = 0;
3139 for (;;) {
3140 bs = bdrv_skip_filters(bs);
3141 ret = bdrv_block_status(bs, offset, bytes, &bytes, &map, &file);
3142 if (ret < 0) {
3143 return ret;
3144 }
3145 assert(bytes);
3146 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
3147 break;
3148 }
3149 bs = bdrv_cow_bs(bs);
3150 if (bs == NULL) {
3151 ret = 0;
3152 break;
3153 }
3154
3155 depth++;
3156 }
3157
3158 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
3159
3160 if (file && has_offset) {
3161 bdrv_refresh_filename(file);
3162 filename = file->filename;
3163 }
3164
3165 *e = (MapEntry) {
3166 .start = offset,
3167 .length = bytes,
3168 .data = !!(ret & BDRV_BLOCK_DATA),
3169 .zero = !!(ret & BDRV_BLOCK_ZERO),
3170 .offset = map,
3171 .has_offset = has_offset,
3172 .depth = depth,
3173 .present = !!(ret & BDRV_BLOCK_ALLOCATED),
3174 .filename = filename,
3175 };
3176
3177 return 0;
3178 }
3179
3180 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
3181 {
3182 if (curr->length == 0) {
3183 return false;
3184 }
3185 if (curr->zero != next->zero ||
3186 curr->data != next->data ||
3187 curr->depth != next->depth ||
3188 curr->present != next->present ||
3189 !curr->filename != !next->filename ||
3190 curr->has_offset != next->has_offset) {
3191 return false;
3192 }
3193 if (curr->filename && strcmp(curr->filename, next->filename)) {
3194 return false;
3195 }
3196 if (curr->has_offset && curr->offset + curr->length != next->offset) {
3197 return false;
3198 }
3199 return true;
3200 }
3201
3202 static int img_map(int argc, char **argv)
3203 {
3204 int c;
3205 OutputFormat output_format = OFORMAT_HUMAN;
3206 BlockBackend *blk;
3207 BlockDriverState *bs;
3208 const char *filename, *fmt, *output;
3209 int64_t length;
3210 MapEntry curr = { .length = 0 }, next;
3211 int ret = 0;
3212 bool image_opts = false;
3213 bool force_share = false;
3214 int64_t start_offset = 0;
3215 int64_t max_length = -1;
3216
3217 fmt = NULL;
3218 output = NULL;
3219 for (;;) {
3220 int option_index = 0;
3221 static const struct option long_options[] = {
3222 {"help", no_argument, 0, 'h'},
3223 {"format", required_argument, 0, 'f'},
3224 {"output", required_argument, 0, OPTION_OUTPUT},
3225 {"object", required_argument, 0, OPTION_OBJECT},
3226 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3227 {"force-share", no_argument, 0, 'U'},
3228 {"start-offset", required_argument, 0, 's'},
3229 {"max-length", required_argument, 0, 'l'},
3230 {0, 0, 0, 0}
3231 };
3232 c = getopt_long(argc, argv, ":f:s:l:hU",
3233 long_options, &option_index);
3234 if (c == -1) {
3235 break;
3236 }
3237 switch (c) {
3238 case ':':
3239 missing_argument(argv[optind - 1]);
3240 break;
3241 case '?':
3242 unrecognized_option(argv[optind - 1]);
3243 break;
3244 case 'h':
3245 help();
3246 break;
3247 case 'f':
3248 fmt = optarg;
3249 break;
3250 case 'U':
3251 force_share = true;
3252 break;
3253 case OPTION_OUTPUT:
3254 output = optarg;
3255 break;
3256 case 's':
3257 start_offset = cvtnum("start offset", optarg);
3258 if (start_offset < 0) {
3259 return 1;
3260 }
3261 break;
3262 case 'l':
3263 max_length = cvtnum("max length", optarg);
3264 if (max_length < 0) {
3265 return 1;
3266 }
3267 break;
3268 case OPTION_OBJECT:
3269 user_creatable_process_cmdline(optarg);
3270 break;
3271 case OPTION_IMAGE_OPTS:
3272 image_opts = true;
3273 break;
3274 }
3275 }
3276 if (optind != argc - 1) {
3277 error_exit("Expecting one image file name");
3278 }
3279 filename = argv[optind];
3280
3281 if (output && !strcmp(output, "json")) {
3282 output_format = OFORMAT_JSON;
3283 } else if (output && !strcmp(output, "human")) {
3284 output_format = OFORMAT_HUMAN;
3285 } else if (output) {
3286 error_report("--output must be used with human or json as argument.");
3287 return 1;
3288 }
3289
3290 blk = img_open(image_opts, filename, fmt, 0, false, false, force_share);
3291 if (!blk) {
3292 return 1;
3293 }
3294 bs = blk_bs(blk);
3295
3296 if (output_format == OFORMAT_HUMAN) {
3297 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
3298 } else if (output_format == OFORMAT_JSON) {
3299 putchar('[');
3300 }
3301
3302 length = blk_getlength(blk);
3303 if (length < 0) {
3304 error_report("Failed to get size for '%s'", filename);
3305 return 1;
3306 }
3307 if (max_length != -1) {
3308 length = MIN(start_offset + max_length, length);
3309 }
3310
3311 curr.start = start_offset;
3312 while (curr.start + curr.length < length) {
3313 int64_t offset = curr.start + curr.length;
3314 int64_t n = length - offset;
3315
3316 ret = get_block_status(bs, offset, n, &next);
3317 if (ret < 0) {
3318 error_report("Could not read file metadata: %s", strerror(-ret));
3319 goto out;
3320 }
3321
3322 if (entry_mergeable(&curr, &next)) {
3323 curr.length += next.length;
3324 continue;
3325 }
3326
3327 if (curr.length > 0) {
3328 ret = dump_map_entry(output_format, &curr, &next);
3329 if (ret < 0) {
3330 goto out;
3331 }
3332 }
3333 curr = next;
3334 }
3335
3336 ret = dump_map_entry(output_format, &curr, NULL);
3337 if (output_format == OFORMAT_JSON) {
3338 puts("]");
3339 }
3340
3341 out:
3342 blk_unref(blk);
3343 return ret < 0;
3344 }
3345
3346 #define SNAPSHOT_LIST 1
3347 #define SNAPSHOT_CREATE 2
3348 #define SNAPSHOT_APPLY 3
3349 #define SNAPSHOT_DELETE 4
3350
3351 static int img_snapshot(int argc, char **argv)
3352 {
3353 BlockBackend *blk;
3354 BlockDriverState *bs;
3355 QEMUSnapshotInfo sn;
3356 char *filename, *snapshot_name = NULL;
3357 int c, ret = 0, bdrv_oflags;
3358 int action = 0;
3359 bool quiet = false;
3360 Error *err = NULL;
3361 bool image_opts = false;
3362 bool force_share = false;
3363 int64_t rt;
3364
3365 bdrv_oflags = BDRV_O_RDWR;
3366 /* Parse commandline parameters */
3367 for(;;) {
3368 static const struct option long_options[] = {
3369 {"help", no_argument, 0, 'h'},
3370 {"object", required_argument, 0, OPTION_OBJECT},
3371 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3372 {"force-share", no_argument, 0, 'U'},
3373 {0, 0, 0, 0}
3374 };
3375 c = getopt_long(argc, argv, ":la:c:d:hqU",
3376 long_options, NULL);
3377 if (c == -1) {
3378 break;
3379 }
3380 switch(c) {
3381 case ':':
3382 missing_argument(argv[optind - 1]);
3383 break;
3384 case '?':
3385 unrecognized_option(argv[optind - 1]);
3386 break;
3387 case 'h':
3388 help();
3389 return 0;
3390 case 'l':
3391 if (action) {
3392 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3393 return 0;
3394 }
3395 action = SNAPSHOT_LIST;
3396 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
3397 break;
3398 case 'a':
3399 if (action) {
3400 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3401 return 0;
3402 }
3403 action = SNAPSHOT_APPLY;
3404 snapshot_name = optarg;
3405 break;
3406 case 'c':
3407 if (action) {
3408 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3409 return 0;
3410 }
3411 action = SNAPSHOT_CREATE;
3412 snapshot_name = optarg;
3413 break;
3414 case 'd':
3415 if (action) {
3416 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
3417 return 0;
3418 }
3419 action = SNAPSHOT_DELETE;
3420 snapshot_name = optarg;
3421 break;
3422 case 'q':
3423 quiet = true;
3424 break;
3425 case 'U':
3426 force_share = true;
3427 break;
3428 case OPTION_OBJECT:
3429 user_creatable_process_cmdline(optarg);
3430 break;
3431 case OPTION_IMAGE_OPTS:
3432 image_opts = true;
3433 break;
3434 }
3435 }
3436
3437 if (optind != argc - 1) {
3438 error_exit("Expecting one image file name");
3439 }
3440 filename = argv[optind++];
3441
3442 /* Open the image */
3443 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet,
3444 force_share);
3445 if (!blk) {
3446 return 1;
3447 }
3448 bs = blk_bs(blk);
3449
3450 /* Perform the requested action */
3451 switch(action) {
3452 case SNAPSHOT_LIST:
3453 dump_snapshots(bs);
3454 break;
3455
3456 case SNAPSHOT_CREATE:
3457 memset(&sn, 0, sizeof(sn));
3458 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
3459
3460 rt = g_get_real_time();
3461 sn.date_sec = rt / G_USEC_PER_SEC;
3462 sn.date_nsec = (rt % G_USEC_PER_SEC) * 1000;
3463
3464 ret = bdrv_snapshot_create(bs, &sn);
3465 if (ret) {
3466 error_report("Could not create snapshot '%s': %d (%s)",
3467 snapshot_name, ret, strerror(-ret));
3468 }
3469 break;
3470
3471 case SNAPSHOT_APPLY:
3472 ret = bdrv_snapshot_goto(bs, snapshot_name, &err);
3473 if (ret) {
3474 error_reportf_err(err, "Could not apply snapshot '%s': ",
3475 snapshot_name);
3476 }
3477 break;
3478
3479 case SNAPSHOT_DELETE:
3480 ret = bdrv_snapshot_find(bs, &sn, snapshot_name);
3481 if (ret < 0) {
3482 error_report("Could not delete snapshot '%s': snapshot not "
3483 "found", snapshot_name);
3484 ret = 1;
3485 } else {
3486 ret = bdrv_snapshot_delete(bs, sn.id_str, sn.name, &err);
3487 if (ret < 0) {
3488 error_reportf_err(err, "Could not delete snapshot '%s': ",
3489 snapshot_name);
3490 ret = 1;
3491 }
3492 }
3493 break;
3494 }
3495
3496 /* Cleanup */
3497 blk_unref(blk);
3498 if (ret) {
3499 return 1;
3500 }
3501 return 0;
3502 }
3503
3504 static int img_rebase(int argc, char **argv)
3505 {
3506 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
3507 uint8_t *buf_old = NULL;
3508 uint8_t *buf_new = NULL;
3509 BlockDriverState *bs = NULL, *prefix_chain_bs = NULL;
3510 BlockDriverState *unfiltered_bs;
3511 char *filename;
3512 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
3513 int c, flags, src_flags, ret;
3514 bool writethrough, src_writethrough;
3515 int unsafe = 0;
3516 bool force_share = false;
3517 int progress = 0;
3518 bool quiet = false;
3519 Error *local_err = NULL;
3520 bool image_opts = false;
3521
3522 /* Parse commandline parameters */
3523 fmt = NULL;
3524 cache = BDRV_DEFAULT_CACHE;
3525 src_cache = BDRV_DEFAULT_CACHE;
3526 out_baseimg = NULL;
3527 out_basefmt = NULL;
3528 for(;;) {
3529 static const struct option long_options[] = {
3530 {"help", no_argument, 0, 'h'},
3531 {"object", required_argument, 0, OPTION_OBJECT},
3532 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3533 {"force-share", no_argument, 0, 'U'},
3534 {0, 0, 0, 0}
3535 };
3536 c = getopt_long(argc, argv, ":hf:F:b:upt:T:qU",
3537 long_options, NULL);
3538 if (c == -1) {
3539 break;
3540 }
3541 switch(c) {
3542 case ':':
3543 missing_argument(argv[optind - 1]);
3544 break;
3545 case '?':
3546 unrecognized_option(argv[optind - 1]);
3547 break;
3548 case 'h':
3549 help();
3550 return 0;
3551 case 'f':
3552 fmt = optarg;
3553 break;
3554 case 'F':
3555 out_basefmt = optarg;
3556 break;
3557 case 'b':
3558 out_baseimg = optarg;
3559 break;
3560 case 'u':
3561 unsafe = 1;
3562 break;
3563 case 'p':
3564 progress = 1;
3565 break;
3566 case 't':
3567 cache = optarg;
3568 break;
3569 case 'T':
3570 src_cache = optarg;
3571 break;
3572 case 'q':
3573 quiet = true;
3574 break;
3575 case OPTION_OBJECT:
3576 user_creatable_process_cmdline(optarg);
3577 break;
3578 case OPTION_IMAGE_OPTS:
3579 image_opts = true;
3580 break;
3581 case 'U':
3582 force_share = true;
3583 break;
3584 }
3585 }
3586
3587 if (quiet) {
3588 progress = 0;
3589 }
3590
3591 if (optind != argc - 1) {
3592 error_exit("Expecting one image file name");
3593 }
3594 if (!unsafe && !out_baseimg) {
3595 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
3596 }
3597 filename = argv[optind++];
3598
3599 qemu_progress_init(progress, 2.0);
3600 qemu_progress_print(0, 100);
3601
3602 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
3603 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3604 if (ret < 0) {
3605 error_report("Invalid cache option: %s", cache);
3606 goto out;
3607 }
3608
3609 src_flags = 0;
3610 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
3611 if (ret < 0) {
3612 error_report("Invalid source cache option: %s", src_cache);
3613 goto out;
3614 }
3615
3616 /* The source files are opened read-only, don't care about WCE */
3617 assert((src_flags & BDRV_O_RDWR) == 0);
3618 (void) src_writethrough;
3619
3620 /*
3621 * Open the images.
3622 *
3623 * Ignore the old backing file for unsafe rebase in case we want to correct
3624 * the reference to a renamed or moved backing file.
3625 */
3626 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
3627 false);
3628 if (!blk) {
3629 ret = -1;
3630 goto out;
3631 }
3632 bs = blk_bs(blk);
3633
3634 unfiltered_bs = bdrv_skip_filters(bs);
3635
3636 if (out_basefmt != NULL) {
3637 if (bdrv_find_format(out_basefmt) == NULL) {
3638 error_report("Invalid format name: '%s'", out_basefmt);
3639 ret = -1;
3640 goto out;
3641 }
3642 }
3643
3644 /* For safe rebasing we need to compare old and new backing file */
3645 if (!unsafe) {
3646 QDict *options = NULL;
3647 BlockDriverState *base_bs = bdrv_cow_bs(unfiltered_bs);
3648
3649 if (base_bs) {
3650 blk_old_backing = blk_new(qemu_get_aio_context(),
3651 BLK_PERM_CONSISTENT_READ,
3652 BLK_PERM_ALL);
3653 ret = blk_insert_bs(blk_old_backing, base_bs,
3654 &local_err);
3655 if (ret < 0) {
3656 error_reportf_err(local_err,
3657 "Could not reuse old backing file '%s': ",
3658 base_bs->filename);
3659 goto out;
3660 }
3661 } else {
3662 blk_old_backing = NULL;
3663 }
3664
3665 if (out_baseimg[0]) {
3666 const char *overlay_filename;
3667 char *out_real_path;
3668
3669 options = qdict_new();
3670 if (out_basefmt) {
3671 qdict_put_str(options, "driver", out_basefmt);
3672 }
3673 if (force_share) {
3674 qdict_put_bool(options, BDRV_OPT_FORCE_SHARE, true);
3675 }
3676
3677 bdrv_refresh_filename(bs);
3678 overlay_filename = bs->exact_filename[0] ? bs->exact_filename
3679 : bs->filename;
3680 out_real_path =
3681 bdrv_get_full_backing_filename_from_filename(overlay_filename,
3682 out_baseimg,
3683 &local_err);
3684 if (local_err) {
3685 qobject_unref(options);
3686 error_reportf_err(local_err,
3687 "Could not resolve backing filename: ");
3688 ret = -1;
3689 goto out;
3690 }
3691
3692 /*
3693 * Find out whether we rebase an image on top of a previous image
3694 * in its chain.
3695 */
3696 prefix_chain_bs = bdrv_find_backing_image(bs, out_real_path);
3697 if (prefix_chain_bs) {
3698 qobject_unref(options);
3699 g_free(out_real_path);
3700
3701 blk_new_backing = blk_new(qemu_get_aio_context(),
3702 BLK_PERM_CONSISTENT_READ,
3703 BLK_PERM_ALL);
3704 ret = blk_insert_bs(blk_new_backing, prefix_chain_bs,
3705 &local_err);
3706 if (ret < 0) {
3707 error_reportf_err(local_err,
3708 "Could not reuse backing file '%s': ",
3709 out_baseimg);
3710 goto out;
3711 }
3712 } else {
3713 blk_new_backing = blk_new_open(out_real_path, NULL,
3714 options, src_flags, &local_err);
3715 g_free(out_real_path);
3716 if (!blk_new_backing) {
3717 error_reportf_err(local_err,
3718 "Could not open new backing file '%s': ",
3719 out_baseimg);
3720 ret = -1;
3721 goto out;
3722 }
3723 }
3724 }
3725 }
3726
3727 /*
3728 * Check each unallocated cluster in the COW file. If it is unallocated,
3729 * accesses go to the backing file. We must therefore compare this cluster
3730 * in the old and new backing file, and if they differ we need to copy it
3731 * from the old backing file into the COW file.
3732 *
3733 * If qemu-img crashes during this step, no harm is done. The content of
3734 * the image is the same as the original one at any time.
3735 */
3736 if (!unsafe) {
3737 int64_t size;
3738 int64_t old_backing_size = 0;
3739 int64_t new_backing_size = 0;
3740 uint64_t offset;
3741 int64_t n;
3742 float local_progress = 0;
3743
3744 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3745 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3746
3747 size = blk_getlength(blk);
3748 if (size < 0) {
3749 error_report("Could not get size of '%s': %s",
3750 filename, strerror(-size));
3751 ret = -1;
3752 goto out;
3753 }
3754 if (blk_old_backing) {
3755 old_backing_size = blk_getlength(blk_old_backing);
3756 if (old_backing_size < 0) {
3757 char backing_name[PATH_MAX];
3758
3759 bdrv_get_backing_filename(bs, backing_name,
3760 sizeof(backing_name));
3761 error_report("Could not get size of '%s': %s",
3762 backing_name, strerror(-old_backing_size));
3763 ret = -1;
3764 goto out;
3765 }
3766 }
3767 if (blk_new_backing) {
3768 new_backing_size = blk_getlength(blk_new_backing);
3769 if (new_backing_size < 0) {
3770 error_report("Could not get size of '%s': %s",
3771 out_baseimg, strerror(-new_backing_size));
3772 ret = -1;
3773 goto out;
3774 }
3775 }
3776
3777 if (size != 0) {
3778 local_progress = (float)100 / (size / MIN(size, IO_BUF_SIZE));
3779 }
3780
3781 for (offset = 0; offset < size; offset += n) {
3782 bool buf_old_is_zero = false;
3783
3784 /* How many bytes can we handle with the next read? */
3785 n = MIN(IO_BUF_SIZE, size - offset);
3786
3787 /* If the cluster is allocated, we don't need to take action */
3788 ret = bdrv_is_allocated(unfiltered_bs, offset, n, &n);
3789 if (ret < 0) {
3790 error_report("error while reading image metadata: %s",
3791 strerror(-ret));
3792 goto out;
3793 }
3794 if (ret) {
3795 continue;
3796 }
3797
3798 if (prefix_chain_bs) {
3799 /*
3800 * If cluster wasn't changed since prefix_chain, we don't need
3801 * to take action
3802 */
3803 ret = bdrv_is_allocated_above(bdrv_cow_bs(unfiltered_bs),
3804 prefix_chain_bs, false,
3805 offset, n, &n);
3806 if (ret < 0) {
3807 error_report("error while reading image metadata: %s",
3808 strerror(-ret));
3809 goto out;
3810 }
3811 if (!ret) {
3812 continue;
3813 }
3814 }
3815
3816 /*
3817 * Read old and new backing file and take into consideration that
3818 * backing files may be smaller than the COW image.
3819 */
3820 if (offset >= old_backing_size) {
3821 memset(buf_old, 0, n);
3822 buf_old_is_zero = true;
3823 } else {
3824 if (offset + n > old_backing_size) {
3825 n = old_backing_size - offset;
3826 }
3827
3828 ret = blk_pread(blk_old_backing, offset, n, buf_old, 0);
3829 if (ret < 0) {
3830 error_report("error while reading from old backing file");
3831 goto out;
3832 }
3833 }
3834
3835 if (offset >= new_backing_size || !blk_new_backing) {
3836 memset(buf_new, 0, n);
3837 } else {
3838 if (offset + n > new_backing_size) {
3839 n = new_backing_size - offset;
3840 }
3841
3842 ret = blk_pread(blk_new_backing, offset, n, buf_new, 0);
3843 if (ret < 0) {
3844 error_report("error while reading from new backing file");
3845 goto out;
3846 }
3847 }
3848
3849 /* If they differ, we need to write to the COW file */
3850 uint64_t written = 0;
3851
3852 while (written < n) {
3853 int64_t pnum;
3854
3855 if (compare_buffers(buf_old + written, buf_new + written,
3856 n - written, &pnum))
3857 {
3858 if (buf_old_is_zero) {
3859 ret = blk_pwrite_zeroes(blk, offset + written, pnum, 0);
3860 } else {
3861 ret = blk_pwrite(blk, offset + written, pnum,
3862 buf_old + written, 0);
3863 }
3864 if (ret < 0) {
3865 error_report("Error while writing to COW image: %s",
3866 strerror(-ret));
3867 goto out;
3868 }
3869 }
3870
3871 written += pnum;
3872 }
3873 qemu_progress_print(local_progress, 100);
3874 }
3875 }
3876
3877 /*
3878 * Change the backing file. All clusters that are different from the old
3879 * backing file are overwritten in the COW file now, so the visible content
3880 * doesn't change when we switch the backing file.
3881 */
3882 if (out_baseimg && *out_baseimg) {
3883 ret = bdrv_change_backing_file(unfiltered_bs, out_baseimg, out_basefmt,
3884 true);
3885 } else {
3886 ret = bdrv_change_backing_file(unfiltered_bs, NULL, NULL, false);
3887 }
3888
3889 if (ret == -ENOSPC) {
3890 error_report("Could not change the backing file to '%s': No "
3891 "space left in the file header", out_baseimg);
3892 } else if (ret == -EINVAL && out_baseimg && !out_basefmt) {
3893 error_report("Could not change the backing file to '%s': backing "
3894 "format must be specified", out_baseimg);
3895 } else if (ret < 0) {
3896 error_report("Could not change the backing file to '%s': %s",
3897 out_baseimg, strerror(-ret));
3898 }
3899
3900 qemu_progress_print(100, 0);
3901 /*
3902 * TODO At this point it is possible to check if any clusters that are
3903 * allocated in the COW file are the same in the backing file. If so, they
3904 * could be dropped from the COW file. Don't do this before switching the
3905 * backing file, in case of a crash this would lead to corruption.
3906 */
3907 out:
3908 qemu_progress_end();
3909 /* Cleanup */
3910 if (!unsafe) {
3911 blk_unref(blk_old_backing);
3912 blk_unref(blk_new_backing);
3913 }
3914 qemu_vfree(buf_old);
3915 qemu_vfree(buf_new);
3916
3917 blk_unref(blk);
3918 if (ret) {
3919 return 1;
3920 }
3921 return 0;
3922 }
3923
3924 static int img_resize(int argc, char **argv)
3925 {
3926 Error *err = NULL;
3927 int c, ret, relative;
3928 const char *filename, *fmt, *size;
3929 int64_t n, total_size, current_size;
3930 bool quiet = false;
3931 BlockBackend *blk = NULL;
3932 PreallocMode prealloc = PREALLOC_MODE_OFF;
3933 QemuOpts *param;
3934
3935 static QemuOptsList resize_options = {
3936 .name = "resize_options",
3937 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3938 .desc = {
3939 {
3940 .name = BLOCK_OPT_SIZE,
3941 .type = QEMU_OPT_SIZE,
3942 .help = "Virtual disk size"
3943 }, {
3944 /* end of list */
3945 }
3946 },
3947 };
3948 bool image_opts = false;
3949 bool shrink = false;
3950
3951 /* Remove size from argv manually so that negative numbers are not treated
3952 * as options by getopt. */
3953 if (argc < 3) {
3954 error_exit("Not enough arguments");
3955 return 1;
3956 }
3957
3958 size = argv[--argc];
3959
3960 /* Parse getopt arguments */
3961 fmt = NULL;
3962 for(;;) {
3963 static const struct option long_options[] = {
3964 {"help", no_argument, 0, 'h'},
3965 {"object", required_argument, 0, OPTION_OBJECT},
3966 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3967 {"preallocation", required_argument, 0, OPTION_PREALLOCATION},
3968 {"shrink", no_argument, 0, OPTION_SHRINK},
3969 {0, 0, 0, 0}
3970 };
3971 c = getopt_long(argc, argv, ":f:hq",
3972 long_options, NULL);
3973 if (c == -1) {
3974 break;
3975 }
3976 switch(c) {
3977 case ':':
3978 missing_argument(argv[optind - 1]);
3979 break;
3980 case '?':
3981 unrecognized_option(argv[optind - 1]);
3982 break;
3983 case 'h':
3984 help();
3985 break;
3986 case 'f':
3987 fmt = optarg;
3988 break;
3989 case 'q':
3990 quiet = true;
3991 break;
3992 case OPTION_OBJECT:
3993 user_creatable_process_cmdline(optarg);
3994 break;
3995 case OPTION_IMAGE_OPTS:
3996 image_opts = true;
3997 break;
3998 case OPTION_PREALLOCATION:
3999 prealloc = qapi_enum_parse(&PreallocMode_lookup, optarg,
4000 PREALLOC_MODE__MAX, NULL);
4001 if (prealloc == PREALLOC_MODE__MAX) {
4002 error_report("Invalid preallocation mode '%s'", optarg);
4003 return 1;
4004 }
4005 break;
4006 case OPTION_SHRINK:
4007 shrink = true;
4008 break;
4009 }
4010 }
4011 if (optind != argc - 1) {
4012 error_exit("Expecting image file name and size");
4013 }
4014 filename = argv[optind++];
4015
4016 /* Choose grow, shrink, or absolute resize mode */
4017 switch (size[0]) {
4018 case '+':
4019 relative = 1;
4020 size++;
4021 break;
4022 case '-':
4023 relative = -1;
4024 size++;
4025 break;
4026 default:
4027 relative = 0;
4028 break;
4029 }
4030
4031 /* Parse size */
4032 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
4033 if (!qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err)) {
4034 error_report_err(err);
4035 ret = -1;
4036 qemu_opts_del(param);
4037 goto out;
4038 }
4039 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
4040 qemu_opts_del(param);
4041
4042 blk = img_open(image_opts, filename, fmt,
4043 BDRV_O_RDWR | BDRV_O_RESIZE, false, quiet,
4044 false);
4045 if (!blk) {
4046 ret = -1;
4047 goto out;
4048 }
4049
4050 current_size = blk_getlength(blk);
4051 if (current_size < 0) {
4052 error_report("Failed to inquire current image length: %s",
4053 strerror(-current_size));
4054 ret = -1;
4055 goto out;
4056 }
4057
4058 if (relative) {
4059 total_size = current_size + n * relative;
4060 } else {
4061 total_size = n;
4062 }
4063 if (total_size <= 0) {
4064 error_report("New image size must be positive");
4065 ret = -1;
4066 goto out;
4067 }
4068
4069 if (total_size <= current_size && prealloc != PREALLOC_MODE_OFF) {
4070 error_report("Preallocation can only be used for growing images");
4071 ret = -1;
4072 goto out;
4073 }
4074
4075 if (total_size < current_size && !shrink) {
4076 error_report("Use the --shrink option to perform a shrink operation.");
4077 warn_report("Shrinking an image will delete all data beyond the "
4078 "shrunken image's end. Before performing such an "
4079 "operation, make sure there is no important data there.");
4080 ret = -1;
4081 goto out;
4082 }
4083
4084 /*
4085 * The user expects the image to have the desired size after
4086 * resizing, so pass @exact=true. It is of no use to report
4087 * success when the image has not actually been resized.
4088 */
4089 ret = blk_truncate(blk, total_size, true, prealloc, 0, &err);
4090 if (!ret) {
4091 qprintf(quiet, "Image resized.\n");
4092 } else {
4093 error_report_err(err);
4094 }
4095 out:
4096 blk_unref(blk);
4097 if (ret) {
4098 return 1;
4099 }
4100 return 0;
4101 }
4102
4103 static void amend_status_cb(BlockDriverState *bs,
4104 int64_t offset, int64_t total_work_size,
4105 void *opaque)
4106 {
4107 qemu_progress_print(100.f * offset / total_work_size, 0);
4108 }
4109
4110 static int print_amend_option_help(const char *format)
4111 {
4112 BlockDriver *drv;
4113
4114 /* Find driver and parse its options */
4115 drv = bdrv_find_format(format);
4116 if (!drv) {
4117 error_report("Unknown file format '%s'", format);
4118 return 1;
4119 }
4120
4121 if (!drv->bdrv_amend_options) {
4122 error_report("Format driver '%s' does not support option amendment",
4123 format);
4124 return 1;
4125 }
4126
4127 /* Every driver supporting amendment must have amend_opts */
4128 assert(drv->amend_opts);
4129
4130 printf("Amend options for '%s':\n", format);
4131 qemu_opts_print_help(drv->amend_opts, false);
4132 return 0;
4133 }
4134
4135 static int img_amend(int argc, char **argv)
4136 {
4137 Error *err = NULL;
4138 int c, ret = 0;
4139 char *options = NULL;
4140 QemuOptsList *amend_opts = NULL;
4141 QemuOpts *opts = NULL;
4142 const char *fmt = NULL, *filename, *cache;
4143 int flags;
4144 bool writethrough;
4145 bool quiet = false, progress = false;
4146 BlockBackend *blk = NULL;
4147 BlockDriverState *bs = NULL;
4148 bool image_opts = false;
4149 bool force = false;
4150
4151 cache = BDRV_DEFAULT_CACHE;
4152 for (;;) {
4153 static const struct option long_options[] = {
4154 {"help", no_argument, 0, 'h'},
4155 {"object", required_argument, 0, OPTION_OBJECT},
4156 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4157 {"force", no_argument, 0, OPTION_FORCE},
4158 {0, 0, 0, 0}
4159 };
4160 c = getopt_long(argc, argv, ":ho:f:t:pq",
4161 long_options, NULL);
4162 if (c == -1) {
4163 break;
4164 }
4165
4166 switch (c) {
4167 case ':':
4168 missing_argument(argv[optind - 1]);
4169 break;
4170 case '?':
4171 unrecognized_option(argv[optind - 1]);
4172 break;
4173 case 'h':
4174 help();
4175 break;
4176 case 'o':
4177 if (accumulate_options(&options, optarg) < 0) {
4178 ret = -1;
4179 goto out_no_progress;
4180 }
4181 break;
4182 case 'f':
4183 fmt = optarg;
4184 break;
4185 case 't':
4186 cache = optarg;
4187 break;
4188 case 'p':
4189 progress = true;
4190 break;
4191 case 'q':
4192 quiet = true;
4193 break;
4194 case OPTION_OBJECT:
4195 user_creatable_process_cmdline(optarg);
4196 break;
4197 case OPTION_IMAGE_OPTS:
4198 image_opts = true;
4199 break;
4200 case OPTION_FORCE:
4201 force = true;
4202 break;
4203 }
4204 }
4205
4206 if (!options) {
4207 error_exit("Must specify options (-o)");
4208 }
4209
4210 if (quiet) {
4211 progress = false;
4212 }
4213 qemu_progress_init(progress, 1.0);
4214
4215 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
4216 if (fmt && has_help_option(options)) {
4217 /* If a format is explicitly specified (and possibly no filename is
4218 * given), print option help here */
4219 ret = print_amend_option_help(fmt);
4220 goto out;
4221 }
4222
4223 if (optind != argc - 1) {
4224 error_report("Expecting one image file name");
4225 ret = -1;
4226 goto out;
4227 }
4228
4229 flags = BDRV_O_RDWR;
4230 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
4231 if (ret < 0) {
4232 error_report("Invalid cache option: %s", cache);
4233 goto out;
4234 }
4235
4236 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4237 false);
4238 if (!blk) {
4239 ret = -1;
4240 goto out;
4241 }
4242 bs = blk_bs(blk);
4243
4244 fmt = bs->drv->format_name;
4245
4246 if (has_help_option(options)) {
4247 /* If the format was auto-detected, print option help here */
4248 ret = print_amend_option_help(fmt);
4249 goto out;
4250 }
4251
4252 if (!bs->drv->bdrv_amend_options) {
4253 error_report("Format driver '%s' does not support option amendment",
4254 fmt);
4255 ret = -1;
4256 goto out;
4257 }
4258
4259 /* Every driver supporting amendment must have amend_opts */
4260 assert(bs->drv->amend_opts);
4261
4262 amend_opts = qemu_opts_append(amend_opts, bs->drv->amend_opts);
4263 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
4264 if (!qemu_opts_do_parse(opts, options, NULL, &err)) {
4265 /* Try to parse options using the create options */
4266 amend_opts = qemu_opts_append(amend_opts, bs->drv->create_opts);
4267 qemu_opts_del(opts);
4268 opts = qemu_opts_create(amend_opts, NULL, 0, &error_abort);
4269 if (qemu_opts_do_parse(opts, options, NULL, NULL)) {
4270 error_append_hint(&err,
4271 "This option is only supported for image creation\n");
4272 }
4273
4274 error_report_err(err);
4275 ret = -1;
4276 goto out;
4277 }
4278
4279 /* In case the driver does not call amend_status_cb() */
4280 qemu_progress_print(0.f, 0);
4281 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL, force, &err);
4282 qemu_progress_print(100.f, 0);
4283 if (ret < 0) {
4284 error_report_err(err);
4285 goto out;
4286 }
4287
4288 out:
4289 qemu_progress_end();
4290
4291 out_no_progress:
4292 blk_unref(blk);
4293 qemu_opts_del(opts);
4294 qemu_opts_free(amend_opts);
4295 g_free(options);
4296
4297 if (ret) {
4298 return 1;
4299 }
4300 return 0;
4301 }
4302
4303 typedef struct BenchData {
4304 BlockBackend *blk;
4305 uint64_t image_size;
4306 bool write;
4307 int bufsize;
4308 int step;
4309 int nrreq;
4310 int n;
4311 int flush_interval;
4312 bool drain_on_flush;
4313 uint8_t *buf;
4314 QEMUIOVector *qiov;
4315
4316 int in_flight;
4317 bool in_flush;
4318 uint64_t offset;
4319 } BenchData;
4320
4321 static void bench_undrained_flush_cb(void *opaque, int ret)
4322 {
4323 if (ret < 0) {
4324 error_report("Failed flush request: %s", strerror(-ret));
4325 exit(EXIT_FAILURE);
4326 }
4327 }
4328
4329 static void bench_cb(void *opaque, int ret)
4330 {
4331 BenchData *b = opaque;
4332 BlockAIOCB *acb;
4333
4334 if (ret < 0) {
4335 error_report("Failed request: %s", strerror(-ret));
4336 exit(EXIT_FAILURE);
4337 }
4338
4339 if (b->in_flush) {
4340 /* Just finished a flush with drained queue: Start next requests */
4341 assert(b->in_flight == 0);
4342 b->in_flush = false;
4343 } else if (b->in_flight > 0) {
4344 int remaining = b->n - b->in_flight;
4345
4346 b->n--;
4347 b->in_flight--;
4348
4349 /* Time for flush? Drain queue if requested, then flush */
4350 if (b->flush_interval && remaining % b->flush_interval == 0) {
4351 if (!b->in_flight || !b->drain_on_flush) {
4352 BlockCompletionFunc *cb;
4353
4354 if (b->drain_on_flush) {
4355 b->in_flush = true;
4356 cb = bench_cb;
4357 } else {
4358 cb = bench_undrained_flush_cb;
4359 }
4360
4361 acb = blk_aio_flush(b->blk, cb, b);
4362 if (!acb) {
4363 error_report("Failed to issue flush request");
4364 exit(EXIT_FAILURE);
4365 }
4366 }
4367 if (b->drain_on_flush) {
4368 return;
4369 }
4370 }
4371 }
4372
4373 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
4374 int64_t offset = b->offset;
4375 /* blk_aio_* might look for completed I/Os and kick bench_cb
4376 * again, so make sure this operation is counted by in_flight
4377 * and b->offset is ready for the next submission.
4378 */
4379 b->in_flight++;
4380 b->offset += b->step;
4381 b->offset %= b->image_size;
4382 if (b->write) {
4383 acb = blk_aio_pwritev(b->blk, offset, b->qiov, 0, bench_cb, b);
4384 } else {
4385 acb = blk_aio_preadv(b->blk, offset, b->qiov, 0, bench_cb, b);
4386 }
4387 if (!acb) {
4388 error_report("Failed to issue request");
4389 exit(EXIT_FAILURE);
4390 }
4391 }
4392 }
4393
4394 static int img_bench(int argc, char **argv)
4395 {
4396 int c, ret = 0;
4397 const char *fmt = NULL, *filename;
4398 bool quiet = false;
4399 bool image_opts = false;
4400 bool is_write = false;
4401 int count = 75000;
4402 int depth = 64;
4403 int64_t offset = 0;
4404 size_t bufsize = 4096;
4405 int pattern = 0;
4406 size_t step = 0;
4407 int flush_interval = 0;
4408 bool drain_on_flush = true;
4409 int64_t image_size;
4410 BlockBackend *blk = NULL;
4411 BenchData data = {};
4412 int flags = 0;
4413 bool writethrough = false;
4414 struct timeval t1, t2;
4415 int i;
4416 bool force_share = false;
4417 size_t buf_size = 0;
4418
4419 for (;;) {
4420 static const struct option long_options[] = {
4421 {"help", no_argument, 0, 'h'},
4422 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
4423 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4424 {"pattern", required_argument, 0, OPTION_PATTERN},
4425 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
4426 {"force-share", no_argument, 0, 'U'},
4427 {0, 0, 0, 0}
4428 };
4429 c = getopt_long(argc, argv, ":hc:d:f:ni:o:qs:S:t:wU", long_options,
4430 NULL);
4431 if (c == -1) {
4432 break;
4433 }
4434
4435 switch (c) {
4436 case ':':
4437 missing_argument(argv[optind - 1]);
4438 break;
4439 case '?':
4440 unrecognized_option(argv[optind - 1]);
4441 break;
4442 case 'h':
4443 help();
4444 break;
4445 case 'c':
4446 {
4447 unsigned long res;
4448
4449 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4450 error_report("Invalid request count specified");
4451 return 1;
4452 }
4453 count = res;
4454 break;
4455 }
4456 case 'd':
4457 {
4458 unsigned long res;
4459
4460 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4461 error_report("Invalid queue depth specified");
4462 return 1;
4463 }
4464 depth = res;
4465 break;
4466 }
4467 case 'f':
4468 fmt = optarg;
4469 break;
4470 case 'n':
4471 flags |= BDRV_O_NATIVE_AIO;
4472 break;
4473 case 'i':
4474 ret = bdrv_parse_aio(optarg, &flags);
4475 if (ret < 0) {
4476 error_report("Invalid aio option: %s", optarg);
4477 ret = -1;
4478 goto out;
4479 }
4480 break;
4481 case 'o':
4482 {
4483 offset = cvtnum("offset", optarg);
4484 if (offset < 0) {
4485 return 1;
4486 }
4487 break;
4488 }
4489 break;
4490 case 'q':
4491 quiet = true;
4492 break;
4493 case 's':
4494 {
4495 int64_t sval;
4496
4497 sval = cvtnum_full("buffer size", optarg, 0, INT_MAX);
4498 if (sval < 0) {
4499 return 1;
4500 }
4501
4502 bufsize = sval;
4503 break;
4504 }
4505 case 'S':
4506 {
4507 int64_t sval;
4508
4509 sval = cvtnum_full("step_size", optarg, 0, INT_MAX);
4510 if (sval < 0) {
4511 return 1;
4512 }
4513
4514 step = sval;
4515 break;
4516 }
4517 case 't':
4518 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
4519 if (ret < 0) {
4520 error_report("Invalid cache mode");
4521 ret = -1;
4522 goto out;
4523 }
4524 break;
4525 case 'w':
4526 flags |= BDRV_O_RDWR;
4527 is_write = true;
4528 break;
4529 case 'U':
4530 force_share = true;
4531 break;
4532 case OPTION_PATTERN:
4533 {
4534 unsigned long res;
4535
4536 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > 0xff) {
4537 error_report("Invalid pattern byte specified");
4538 return 1;
4539 }
4540 pattern = res;
4541 break;
4542 }
4543 case OPTION_FLUSH_INTERVAL:
4544 {
4545 unsigned long res;
4546
4547 if (qemu_strtoul(optarg, NULL, 0, &res) < 0 || res > INT_MAX) {
4548 error_report("Invalid flush interval specified");
4549 return 1;
4550 }
4551 flush_interval = res;
4552 break;
4553 }
4554 case OPTION_NO_DRAIN:
4555 drain_on_flush = false;
4556 break;
4557 case OPTION_IMAGE_OPTS:
4558 image_opts = true;
4559 break;
4560 }
4561 }
4562
4563 if (optind != argc - 1) {
4564 error_exit("Expecting one image file name");
4565 }
4566 filename = argv[argc - 1];
4567
4568 if (!is_write && flush_interval) {
4569 error_report("--flush-interval is only available in write tests");
4570 ret = -1;
4571 goto out;
4572 }
4573 if (flush_interval && flush_interval < depth) {
4574 error_report("Flush interval can't be smaller than depth");
4575 ret = -1;
4576 goto out;
4577 }
4578
4579 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet,
4580 force_share);
4581 if (!blk) {
4582 ret = -1;
4583 goto out;
4584 }
4585
4586 image_size = blk_getlength(blk);
4587 if (image_size < 0) {
4588 ret = image_size;
4589 goto out;
4590 }
4591
4592 data = (BenchData) {
4593 .blk = blk,
4594 .image_size = image_size,
4595 .bufsize = bufsize,
4596 .step = step ?: bufsize,
4597 .nrreq = depth,
4598 .n = count,
4599 .offset = offset,
4600 .write = is_write,
4601 .flush_interval = flush_interval,
4602 .drain_on_flush = drain_on_flush,
4603 };
4604 printf("Sending %d %s requests, %d bytes each, %d in parallel "
4605 "(starting at offset %" PRId64 ", step size %d)\n",
4606 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
4607 data.offset, data.step);
4608 if (flush_interval) {
4609 printf("Sending flush every %d requests\n", flush_interval);
4610 }
4611
4612 buf_size = data.nrreq * data.bufsize;
4613 data.buf = blk_blockalign(blk, buf_size);
4614 memset(data.buf, pattern, data.nrreq * data.bufsize);
4615
4616 blk_register_buf(blk, data.buf, buf_size, &error_fatal);
4617
4618 data.qiov = g_new(QEMUIOVector, data.nrreq);
4619 for (i = 0; i < data.nrreq; i++) {
4620 qemu_iovec_init(&data.qiov[i], 1);
4621 qemu_iovec_add(&data.qiov[i],
4622 data.buf + i * data.bufsize, data.bufsize);
4623 }
4624
4625 gettimeofday(&t1, NULL);
4626 bench_cb(&data, 0);
4627
4628 while (data.n > 0) {
4629 main_loop_wait(false);
4630 }
4631 gettimeofday(&t2, NULL);
4632
4633 printf("Run completed in %3.3f seconds.\n",
4634 (t2.tv_sec - t1.tv_sec)
4635 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
4636
4637 out:
4638 if (data.buf) {
4639 blk_unregister_buf(blk, data.buf, buf_size);
4640 }
4641 qemu_vfree(data.buf);
4642 blk_unref(blk);
4643
4644 if (ret) {
4645 return 1;
4646 }
4647 return 0;
4648 }
4649
4650 enum ImgBitmapAct {
4651 BITMAP_ADD,
4652 BITMAP_REMOVE,
4653 BITMAP_CLEAR,
4654 BITMAP_ENABLE,
4655 BITMAP_DISABLE,
4656 BITMAP_MERGE,
4657 };
4658 typedef struct ImgBitmapAction {
4659 enum ImgBitmapAct act;
4660 const char *src; /* only used for merge */
4661 QSIMPLEQ_ENTRY(ImgBitmapAction) next;
4662 } ImgBitmapAction;
4663
4664 static int img_bitmap(int argc, char **argv)
4665 {
4666 Error *err = NULL;
4667 int c, ret = 1;
4668 QemuOpts *opts = NULL;
4669 const char *fmt = NULL, *src_fmt = NULL, *src_filename = NULL;
4670 const char *filename, *bitmap;
4671 BlockBackend *blk = NULL, *src = NULL;
4672 BlockDriverState *bs = NULL, *src_bs = NULL;
4673 bool image_opts = false;
4674 int64_t granularity = 0;
4675 bool add = false, merge = false;
4676 QSIMPLEQ_HEAD(, ImgBitmapAction) actions;
4677 ImgBitmapAction *act, *act_next;
4678 const char *op;
4679 int inactivate_ret;
4680
4681 QSIMPLEQ_INIT(&actions);
4682
4683 for (;;) {
4684 static const struct option long_options[] = {
4685 {"help", no_argument, 0, 'h'},
4686 {"object", required_argument, 0, OPTION_OBJECT},
4687 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
4688 {"add", no_argument, 0, OPTION_ADD},
4689 {"remove", no_argument, 0, OPTION_REMOVE},
4690 {"clear", no_argument, 0, OPTION_CLEAR},
4691 {"enable", no_argument, 0, OPTION_ENABLE},
4692 {"disable", no_argument, 0, OPTION_DISABLE},
4693 {"merge", required_argument, 0, OPTION_MERGE},
4694 {"granularity", required_argument, 0, 'g'},
4695 {"source-file", required_argument, 0, 'b'},
4696 {"source-format", required_argument, 0, 'F'},
4697 {0, 0, 0, 0}
4698 };
4699 c = getopt_long(argc, argv, ":b:f:F:g:h", long_options, NULL);
4700 if (c == -1) {
4701 break;
4702 }
4703
4704 switch (c) {
4705 case ':':
4706 missing_argument(argv[optind - 1]);
4707 break;
4708 case '?':
4709 unrecognized_option(argv[optind - 1]);
4710 break;
4711 case 'h':
4712 help();
4713 break;
4714 case 'b':
4715 src_filename = optarg;
4716 break;
4717 case 'f':
4718 fmt = optarg;
4719 break;
4720 case 'F':
4721 src_fmt = optarg;
4722 break;
4723 case 'g':
4724 granularity = cvtnum("granularity", optarg);
4725 if (granularity < 0) {
4726 return 1;
4727 }
4728 break;
4729 case OPTION_ADD:
4730 act = g_new0(ImgBitmapAction, 1);
4731 act->act = BITMAP_ADD;
4732 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4733 add = true;
4734 break;
4735 case OPTION_REMOVE:
4736 act = g_new0(ImgBitmapAction, 1);
4737 act->act = BITMAP_REMOVE;
4738 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4739 break;
4740 case OPTION_CLEAR:
4741 act = g_new0(ImgBitmapAction, 1);
4742 act->act = BITMAP_CLEAR;
4743 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4744 break;
4745 case OPTION_ENABLE:
4746 act = g_new0(ImgBitmapAction, 1);
4747 act->act = BITMAP_ENABLE;
4748 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4749 break;
4750 case OPTION_DISABLE:
4751 act = g_new0(ImgBitmapAction, 1);
4752 act->act = BITMAP_DISABLE;
4753 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4754 break;
4755 case OPTION_MERGE:
4756 act = g_new0(ImgBitmapAction, 1);
4757 act->act = BITMAP_MERGE;
4758 act->src = optarg;
4759 QSIMPLEQ_INSERT_TAIL(&actions, act, next);
4760 merge = true;
4761 break;
4762 case OPTION_OBJECT:
4763 user_creatable_process_cmdline(optarg);
4764 break;
4765 case OPTION_IMAGE_OPTS:
4766 image_opts = true;
4767 break;
4768 }
4769 }
4770
4771 if (QSIMPLEQ_EMPTY(&actions)) {
4772 error_report("Need at least one of --add, --remove, --clear, "
4773 "--enable, --disable, or --merge");
4774 goto out;
4775 }
4776
4777 if (granularity && !add) {
4778 error_report("granularity only supported with --add");
4779 goto out;
4780 }
4781 if (src_fmt && !src_filename) {
4782 error_report("-F only supported with -b");
4783 goto out;
4784 }
4785 if (src_filename && !merge) {
4786 error_report("Merge bitmap source file only supported with "
4787 "--merge");
4788 goto out;
4789 }
4790
4791 if (optind != argc - 2) {
4792 error_report("Expecting filename and bitmap name");
4793 goto out;
4794 }
4795
4796 filename = argv[optind];
4797 bitmap = argv[optind + 1];
4798
4799 /*
4800 * No need to open backing chains; we will be manipulating bitmaps
4801 * directly in this image without reference to image contents.
4802 */
4803 blk = img_open(image_opts, filename, fmt, BDRV_O_RDWR | BDRV_O_NO_BACKING,
4804 false, false, false);
4805 if (!blk) {
4806 goto out;
4807 }
4808 bs = blk_bs(blk);
4809 if (src_filename) {
4810 src = img_open(false, src_filename, src_fmt, BDRV_O_NO_BACKING,
4811 false, false, false);
4812 if (!src) {
4813 goto out;
4814 }
4815 src_bs = blk_bs(src);
4816 } else {
4817 src_bs = bs;
4818 }
4819
4820 QSIMPLEQ_FOREACH_SAFE(act, &actions, next, act_next) {
4821 switch (act->act) {
4822 case BITMAP_ADD:
4823 qmp_block_dirty_bitmap_add(bs->node_name, bitmap,
4824 !!granularity, granularity, true, true,
4825 false, false, &err);
4826 op = "add";
4827 break;
4828 case BITMAP_REMOVE:
4829 qmp_block_dirty_bitmap_remove(bs->node_name, bitmap, &err);
4830 op = "remove";
4831 break;
4832 case BITMAP_CLEAR:
4833 qmp_block_dirty_bitmap_clear(bs->node_name, bitmap, &err);
4834 op = "clear";
4835 break;
4836 case BITMAP_ENABLE:
4837 qmp_block_dirty_bitmap_enable(bs->node_name, bitmap, &err);
4838 op = "enable";
4839 break;
4840 case BITMAP_DISABLE:
4841 qmp_block_dirty_bitmap_disable(bs->node_name, bitmap, &err);
4842 op = "disable";
4843 break;
4844 case BITMAP_MERGE:
4845 do_dirty_bitmap_merge(bs->node_name, bitmap, src_bs->node_name,
4846 act->src, &err);
4847 op = "merge";
4848 break;
4849 default:
4850 g_assert_not_reached();
4851 }
4852
4853 if (err) {
4854 error_reportf_err(err, "Operation %s on bitmap %s failed: ",
4855 op, bitmap);
4856 goto out;
4857 }
4858 g_free(act);
4859 }
4860
4861 ret = 0;
4862
4863 out:
4864 /*
4865 * Manually inactivate the images first because this way we can know whether
4866 * an error occurred. blk_unref() doesn't tell us about failures.
4867 */
4868 inactivate_ret = bdrv_inactivate_all();
4869 if (inactivate_ret < 0) {
4870 error_report("Error while closing the image: %s", strerror(-inactivate_ret));
4871 ret = 1;
4872 }
4873
4874 blk_unref(src);
4875 blk_unref(blk);
4876 qemu_opts_del(opts);
4877 return ret;
4878 }
4879
4880 #define C_BS 01
4881 #define C_COUNT 02
4882 #define C_IF 04
4883 #define C_OF 010
4884 #define C_SKIP 020
4885
4886 struct DdInfo {
4887 unsigned int flags;
4888 int64_t count;
4889 };
4890
4891 struct DdIo {
4892 int bsz; /* Block size */
4893 char *filename;
4894 uint8_t *buf;
4895 int64_t offset;
4896 };
4897
4898 struct DdOpts {
4899 const char *name;
4900 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
4901 unsigned int flag;
4902 };
4903
4904 static int img_dd_bs(const char *arg,
4905 struct DdIo *in, struct DdIo *out,
4906 struct DdInfo *dd)
4907 {
4908 int64_t res;
4909
4910 res = cvtnum_full("bs", arg, 1, INT_MAX);
4911
4912 if (res < 0) {
4913 return 1;
4914 }
4915 in->bsz = out->bsz = res;
4916
4917 return 0;
4918 }
4919
4920 static int img_dd_count(const char *arg,
4921 struct DdIo *in, struct DdIo *out,
4922 struct DdInfo *dd)
4923 {
4924 dd->count = cvtnum("count", arg);
4925
4926 if (dd->count < 0) {
4927 return 1;
4928 }
4929
4930 return 0;
4931 }
4932
4933 static int img_dd_if(const char *arg,
4934 struct DdIo *in, struct DdIo *out,
4935 struct DdInfo *dd)
4936 {
4937 in->filename = g_strdup(arg);
4938
4939 return 0;
4940 }
4941
4942 static int img_dd_of(const char *arg,
4943 struct DdIo *in, struct DdIo *out,
4944 struct DdInfo *dd)
4945 {
4946 out->filename = g_strdup(arg);
4947
4948 return 0;
4949 }
4950
4951 static int img_dd_skip(const char *arg,
4952 struct DdIo *in, struct DdIo *out,
4953 struct DdInfo *dd)
4954 {
4955 in->offset = cvtnum("skip", arg);
4956
4957 if (in->offset < 0) {
4958 return 1;
4959 }
4960
4961 return 0;
4962 }
4963
4964 static int img_dd(int argc, char **argv)
4965 {
4966 int ret = 0;
4967 char *arg = NULL;
4968 char *tmp;
4969 BlockDriver *drv = NULL, *proto_drv = NULL;
4970 BlockBackend *blk1 = NULL, *blk2 = NULL;
4971 QemuOpts *opts = NULL;
4972 QemuOptsList *create_opts = NULL;
4973 Error *local_err = NULL;
4974 bool image_opts = false;
4975 int c, i;
4976 const char *out_fmt = "raw";
4977 const char *fmt = NULL;
4978 int64_t size = 0;
4979 int64_t out_pos, in_pos;
4980 bool force_share = false;
4981 struct DdInfo dd = {
4982 .flags = 0,
4983 .count = 0,
4984 };
4985 struct DdIo in = {
4986 .bsz = 512, /* Block size is by default 512 bytes */
4987 .filename = NULL,
4988 .buf = NULL,
4989 .offset = 0
4990 };
4991 struct DdIo out = {
4992 .bsz = 512,
4993 .filename = NULL,
4994 .buf = NULL,
4995 .offset = 0
4996 };
4997
4998 const struct DdOpts options[] = {
4999 { "bs", img_dd_bs, C_BS },
5000 { "count", img_dd_count, C_COUNT },
5001 { "if", img_dd_if, C_IF },
5002 { "of", img_dd_of, C_OF },
5003 { "skip", img_dd_skip, C_SKIP },
5004 { NULL, NULL, 0 }
5005 };
5006 const struct option long_options[] = {
5007 { "help", no_argument, 0, 'h'},
5008 { "object", required_argument, 0, OPTION_OBJECT},
5009 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5010 { "force-share", no_argument, 0, 'U'},
5011 { 0, 0, 0, 0 }
5012 };
5013
5014 while ((c = getopt_long(argc, argv, ":hf:O:U", long_options, NULL))) {
5015 if (c == EOF) {
5016 break;
5017 }
5018 switch (c) {
5019 case 'O':
5020 out_fmt = optarg;
5021 break;
5022 case 'f':
5023 fmt = optarg;
5024 break;
5025 case ':':
5026 missing_argument(argv[optind - 1]);
5027 break;
5028 case '?':
5029 unrecognized_option(argv[optind - 1]);
5030 break;
5031 case 'h':
5032 help();
5033 break;
5034 case 'U':
5035 force_share = true;
5036 break;
5037 case OPTION_OBJECT:
5038 user_creatable_process_cmdline(optarg);
5039 break;
5040 case OPTION_IMAGE_OPTS:
5041 image_opts = true;
5042 break;
5043 }
5044 }
5045
5046 for (i = optind; i < argc; i++) {
5047 int j;
5048 arg = g_strdup(argv[i]);
5049
5050 tmp = strchr(arg, '=');
5051 if (tmp == NULL) {
5052 error_report("unrecognized operand %s", arg);
5053 ret = -1;
5054 goto out;
5055 }
5056
5057 *tmp++ = '\0';
5058
5059 for (j = 0; options[j].name != NULL; j++) {
5060 if (!strcmp(arg, options[j].name)) {
5061 break;
5062 }
5063 }
5064 if (options[j].name == NULL) {
5065 error_report("unrecognized operand %s", arg);
5066 ret = -1;
5067 goto out;
5068 }
5069
5070 if (options[j].f(tmp, &in, &out, &dd) != 0) {
5071 ret = -1;
5072 goto out;
5073 }
5074 dd.flags |= options[j].flag;
5075 g_free(arg);
5076 arg = NULL;
5077 }
5078
5079 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
5080 error_report("Must specify both input and output files");
5081 ret = -1;
5082 goto out;
5083 }
5084
5085 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false,
5086 force_share);
5087
5088 if (!blk1) {
5089 ret = -1;
5090 goto out;
5091 }
5092
5093 drv = bdrv_find_format(out_fmt);
5094 if (!drv) {
5095 error_report("Unknown file format");
5096 ret = -1;
5097 goto out;
5098 }
5099 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
5100
5101 if (!proto_drv) {
5102 error_report_err(local_err);
5103 ret = -1;
5104 goto out;
5105 }
5106 if (!drv->create_opts) {
5107 error_report("Format driver '%s' does not support image creation",
5108 drv->format_name);
5109 ret = -1;
5110 goto out;
5111 }
5112 if (!proto_drv->create_opts) {
5113 error_report("Protocol driver '%s' does not support image creation",
5114 proto_drv->format_name);
5115 ret = -1;
5116 goto out;
5117 }
5118 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5119 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
5120
5121 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5122
5123 size = blk_getlength(blk1);
5124 if (size < 0) {
5125 error_report("Failed to get size for '%s'", in.filename);
5126 ret = -1;
5127 goto out;
5128 }
5129
5130 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
5131 dd.count * in.bsz < size) {
5132 size = dd.count * in.bsz;
5133 }
5134
5135 /* Overflow means the specified offset is beyond input image's size */
5136 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5137 size < in.bsz * in.offset)) {
5138 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
5139 } else {
5140 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
5141 size - in.bsz * in.offset, &error_abort);
5142 }
5143
5144 ret = bdrv_create(drv, out.filename, opts, &local_err);
5145 if (ret < 0) {
5146 error_reportf_err(local_err,
5147 "%s: error while creating output image: ",
5148 out.filename);
5149 ret = -1;
5150 goto out;
5151 }
5152
5153 /* TODO, we can't honour --image-opts for the target,
5154 * since it needs to be given in a format compatible
5155 * with the bdrv_create() call above which does not
5156 * support image-opts style.
5157 */
5158 blk2 = img_open_file(out.filename, NULL, out_fmt, BDRV_O_RDWR,
5159 false, false, false);
5160
5161 if (!blk2) {
5162 ret = -1;
5163 goto out;
5164 }
5165
5166 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
5167 size < in.offset * in.bsz)) {
5168 /* We give a warning if the skip option is bigger than the input
5169 * size and create an empty output disk image (i.e. like dd(1)).
5170 */
5171 error_report("%s: cannot skip to specified offset", in.filename);
5172 in_pos = size;
5173 } else {
5174 in_pos = in.offset * in.bsz;
5175 }
5176
5177 in.buf = g_new(uint8_t, in.bsz);
5178
5179 for (out_pos = 0; in_pos < size; ) {
5180 int bytes = (in_pos + in.bsz > size) ? size - in_pos : in.bsz;
5181
5182 ret = blk_pread(blk1, in_pos, bytes, in.buf, 0);
5183 if (ret < 0) {
5184 error_report("error while reading from input image file: %s",
5185 strerror(-ret));
5186 goto out;
5187 }
5188 in_pos += bytes;
5189
5190 ret = blk_pwrite(blk2, out_pos, bytes, in.buf, 0);
5191 if (ret < 0) {
5192 error_report("error while writing to output image file: %s",
5193 strerror(-ret));
5194 goto out;
5195 }
5196 out_pos += bytes;
5197 }
5198
5199 out:
5200 g_free(arg);
5201 qemu_opts_del(opts);
5202 qemu_opts_free(create_opts);
5203 blk_unref(blk1);
5204 blk_unref(blk2);
5205 g_free(in.filename);
5206 g_free(out.filename);
5207 g_free(in.buf);
5208 g_free(out.buf);
5209
5210 if (ret) {
5211 return 1;
5212 }
5213 return 0;
5214 }
5215
5216 static void dump_json_block_measure_info(BlockMeasureInfo *info)
5217 {
5218 GString *str;
5219 QObject *obj;
5220 Visitor *v = qobject_output_visitor_new(&obj);
5221
5222 visit_type_BlockMeasureInfo(v, NULL, &info, &error_abort);
5223 visit_complete(v, &obj);
5224 str = qobject_to_json_pretty(obj, true);
5225 assert(str != NULL);
5226 printf("%s\n", str->str);
5227 qobject_unref(obj);
5228 visit_free(v);
5229 g_string_free(str, true);
5230 }
5231
5232 static int img_measure(int argc, char **argv)
5233 {
5234 static const struct option long_options[] = {
5235 {"help", no_argument, 0, 'h'},
5236 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
5237 {"object", required_argument, 0, OPTION_OBJECT},
5238 {"output", required_argument, 0, OPTION_OUTPUT},
5239 {"size", required_argument, 0, OPTION_SIZE},
5240 {"force-share", no_argument, 0, 'U'},
5241 {0, 0, 0, 0}
5242 };
5243 OutputFormat output_format = OFORMAT_HUMAN;
5244 BlockBackend *in_blk = NULL;
5245 BlockDriver *drv;
5246 const char *filename = NULL;
5247 const char *fmt = NULL;
5248 const char *out_fmt = "raw";
5249 char *options = NULL;
5250 char *snapshot_name = NULL;
5251 bool force_share = false;
5252 QemuOpts *opts = NULL;
5253 QemuOpts *object_opts = NULL;
5254 QemuOpts *sn_opts = NULL;
5255 QemuOptsList *create_opts = NULL;
5256 bool image_opts = false;
5257 uint64_t img_size = UINT64_MAX;
5258 BlockMeasureInfo *info = NULL;
5259 Error *local_err = NULL;
5260 int ret = 1;
5261 int c;
5262
5263 while ((c = getopt_long(argc, argv, "hf:O:o:l:U",
5264 long_options, NULL)) != -1) {
5265 switch (c) {
5266 case '?':
5267 case 'h':
5268 help();
5269 break;
5270 case 'f':
5271 fmt = optarg;
5272 break;
5273 case 'O':
5274 out_fmt = optarg;
5275 break;
5276 case 'o':
5277 if (accumulate_options(&options, optarg) < 0) {
5278 goto out;
5279 }
5280 break;
5281 case 'l':
5282 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
5283 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
5284 optarg, false);
5285 if (!sn_opts) {
5286 error_report("Failed in parsing snapshot param '%s'",
5287 optarg);
5288 goto out;
5289 }
5290 } else {
5291 snapshot_name = optarg;
5292 }
5293 break;
5294 case 'U':
5295 force_share = true;
5296 break;
5297 case OPTION_OBJECT:
5298 user_creatable_process_cmdline(optarg);
5299 break;
5300 case OPTION_IMAGE_OPTS:
5301 image_opts = true;
5302 break;
5303 case OPTION_OUTPUT:
5304 if (!strcmp(optarg, "json")) {
5305 output_format = OFORMAT_JSON;
5306 } else if (!strcmp(optarg, "human")) {
5307 output_format = OFORMAT_HUMAN;
5308 } else {
5309 error_report("--output must be used with human or json "
5310 "as argument.");
5311 goto out;
5312 }
5313 break;
5314 case OPTION_SIZE:
5315 {
5316 int64_t sval;
5317
5318 sval = cvtnum("image size", optarg);
5319 if (sval < 0) {
5320 goto out;
5321 }
5322 img_size = (uint64_t)sval;
5323 }
5324 break;
5325 }
5326 }
5327
5328 if (argc - optind > 1) {
5329 error_report("At most one filename argument is allowed.");
5330 goto out;
5331 } else if (argc - optind == 1) {
5332 filename = argv[optind];
5333 }
5334
5335 if (!filename && (image_opts || fmt || snapshot_name || sn_opts)) {
5336 error_report("--image-opts, -f, and -l require a filename argument.");
5337 goto out;
5338 }
5339 if (filename && img_size != UINT64_MAX) {
5340 error_report("--size N cannot be used together with a filename.");
5341 goto out;
5342 }
5343 if (!filename && img_size == UINT64_MAX) {
5344 error_report("Either --size N or one filename must be specified.");
5345 goto out;
5346 }
5347
5348 if (filename) {
5349 in_blk = img_open(image_opts, filename, fmt, 0,
5350 false, false, force_share);
5351 if (!in_blk) {
5352 goto out;
5353 }
5354
5355 if (sn_opts) {
5356 bdrv_snapshot_load_tmp(blk_bs(in_blk),
5357 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
5358 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
5359 &local_err);
5360 } else if (snapshot_name != NULL) {
5361 bdrv_snapshot_load_tmp_by_id_or_name(blk_bs(in_blk),
5362 snapshot_name, &local_err);
5363 }
5364 if (local_err) {
5365 error_reportf_err(local_err, "Failed to load snapshot: ");
5366 goto out;
5367 }
5368 }
5369
5370 drv = bdrv_find_format(out_fmt);
5371 if (!drv) {
5372 error_report("Unknown file format '%s'", out_fmt);
5373 goto out;
5374 }
5375 if (!drv->create_opts) {
5376 error_report("Format driver '%s' does not support image creation",
5377 drv->format_name);
5378 goto out;
5379 }
5380
5381 create_opts = qemu_opts_append(create_opts, drv->create_opts);
5382 create_opts = qemu_opts_append(create_opts, bdrv_file.create_opts);
5383 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
5384 if (options) {
5385 if (!qemu_opts_do_parse(opts, options, NULL, &local_err)) {
5386 error_report_err(local_err);
5387 error_report("Invalid options for file format '%s'", out_fmt);
5388 goto out;
5389 }
5390 }
5391 if (img_size != UINT64_MAX) {
5392 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, img_size, &error_abort);
5393 }
5394
5395 info = bdrv_measure(drv, opts, in_blk ? blk_bs(in_blk) : NULL, &local_err);
5396 if (local_err) {
5397 error_report_err(local_err);
5398 goto out;
5399 }
5400
5401 if (output_format == OFORMAT_HUMAN) {
5402 printf("required size: %" PRIu64 "\n", info->required);
5403 printf("fully allocated size: %" PRIu64 "\n", info->fully_allocated);
5404 if (info->has_bitmaps) {
5405 printf("bitmaps size: %" PRIu64 "\n", info->bitmaps);
5406 }
5407 } else {
5408 dump_json_block_measure_info(info);
5409 }
5410
5411 ret = 0;
5412
5413 out:
5414 qapi_free_BlockMeasureInfo(info);
5415 qemu_opts_del(object_opts);
5416 qemu_opts_del(opts);
5417 qemu_opts_del(sn_opts);
5418 qemu_opts_free(create_opts);
5419 g_free(options);
5420 blk_unref(in_blk);
5421 return ret;
5422 }
5423
5424 static const img_cmd_t img_cmds[] = {
5425 #define DEF(option, callback, arg_string) \
5426 { option, callback },
5427 #include "qemu-img-cmds.h"
5428 #undef DEF
5429 { NULL, NULL, },
5430 };
5431
5432 int main(int argc, char **argv)
5433 {
5434 const img_cmd_t *cmd;
5435 const char *cmdname;
5436 int c;
5437 static const struct option long_options[] = {
5438 {"help", no_argument, 0, 'h'},
5439 {"version", no_argument, 0, 'V'},
5440 {"trace", required_argument, NULL, 'T'},
5441 {0, 0, 0, 0}
5442 };
5443
5444 #ifdef CONFIG_POSIX
5445 signal(SIGPIPE, SIG_IGN);
5446 #endif
5447
5448 socket_init();
5449 error_init(argv[0]);
5450 module_call_init(MODULE_INIT_TRACE);
5451 qemu_init_exec_dir(argv[0]);
5452
5453 qemu_init_main_loop(&error_fatal);
5454
5455 qcrypto_init(&error_fatal);
5456
5457 module_call_init(MODULE_INIT_QOM);
5458 bdrv_init();
5459 if (argc < 2) {
5460 error_exit("Not enough arguments");
5461 }
5462
5463 qemu_add_opts(&qemu_source_opts);
5464 qemu_add_opts(&qemu_trace_opts);
5465
5466 while ((c = getopt_long(argc, argv, "+:hVT:", long_options, NULL)) != -1) {
5467 switch (c) {
5468 case ':':
5469 missing_argument(argv[optind - 1]);
5470 return 0;
5471 case '?':
5472 unrecognized_option(argv[optind - 1]);
5473 return 0;
5474 case 'h':
5475 help();
5476 return 0;
5477 case 'V':
5478 printf(QEMU_IMG_VERSION);
5479 return 0;
5480 case 'T':
5481 trace_opt_parse(optarg);
5482 break;
5483 }
5484 }
5485
5486 cmdname = argv[optind];
5487
5488 /* reset getopt_long scanning */
5489 argc -= optind;
5490 if (argc < 1) {
5491 return 0;
5492 }
5493 argv += optind;
5494 qemu_reset_optind();
5495
5496 if (!trace_init_backends()) {
5497 exit(1);
5498 }
5499 trace_init_file();
5500 qemu_set_log(LOG_TRACE, &error_fatal);
5501
5502 /* find the command */
5503 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
5504 if (!strcmp(cmdname, cmd->name)) {
5505 return cmd->handler(argc, argv);
5506 }
5507 }
5508
5509 /* not found */
5510 error_exit("Command not found: %s", cmdname);
5511 }