]> git.proxmox.com Git - mirror_qemu.git/blob - qemu-img.c
Merge remote-tracking branch 'remotes/mjt/tags/trivial-patches-fetch' into staging
[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 #include "qemu/osdep.h"
25 #include "qemu-version.h"
26 #include "qapi/error.h"
27 #include "qapi-visit.h"
28 #include "qapi/qobject-output-visitor.h"
29 #include "qapi/qmp/qerror.h"
30 #include "qapi/qmp/qjson.h"
31 #include "qemu/cutils.h"
32 #include "qemu/config-file.h"
33 #include "qemu/option.h"
34 #include "qemu/error-report.h"
35 #include "qemu/log.h"
36 #include "qom/object_interfaces.h"
37 #include "sysemu/sysemu.h"
38 #include "sysemu/block-backend.h"
39 #include "block/block_int.h"
40 #include "block/blockjob.h"
41 #include "block/qapi.h"
42 #include "crypto/init.h"
43 #include "trace/control.h"
44 #include <getopt.h>
45
46 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION QEMU_PKGVERSION \
47 "\n" QEMU_COPYRIGHT "\n"
48
49 typedef struct img_cmd_t {
50 const char *name;
51 int (*handler)(int argc, char **argv);
52 } img_cmd_t;
53
54 enum {
55 OPTION_OUTPUT = 256,
56 OPTION_BACKING_CHAIN = 257,
57 OPTION_OBJECT = 258,
58 OPTION_IMAGE_OPTS = 259,
59 OPTION_PATTERN = 260,
60 OPTION_FLUSH_INTERVAL = 261,
61 OPTION_NO_DRAIN = 262,
62 };
63
64 typedef enum OutputFormat {
65 OFORMAT_JSON,
66 OFORMAT_HUMAN,
67 } OutputFormat;
68
69 /* Default to cache=writeback as data integrity is not important for qemu-img */
70 #define BDRV_DEFAULT_CACHE "writeback"
71
72 static void format_print(void *opaque, const char *name)
73 {
74 printf(" %s", name);
75 }
76
77 static void QEMU_NORETURN GCC_FMT_ATTR(1, 2) error_exit(const char *fmt, ...)
78 {
79 va_list ap;
80
81 error_printf("qemu-img: ");
82
83 va_start(ap, fmt);
84 error_vprintf(fmt, ap);
85 va_end(ap);
86
87 error_printf("\nTry 'qemu-img --help' for more information\n");
88 exit(EXIT_FAILURE);
89 }
90
91 /* Please keep in synch with qemu-img.texi */
92 static void QEMU_NORETURN help(void)
93 {
94 const char *help_msg =
95 QEMU_IMG_VERSION
96 "usage: qemu-img [standard options] command [command options]\n"
97 "QEMU disk image utility\n"
98 "\n"
99 " '-h', '--help' display this help and exit\n"
100 " '-V', '--version' output version information and exit\n"
101 " '-T', '--trace' [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
102 " specify tracing options\n"
103 "\n"
104 "Command syntax:\n"
105 #define DEF(option, callback, arg_string) \
106 " " arg_string "\n"
107 #include "qemu-img-cmds.h"
108 #undef DEF
109 #undef GEN_DOCS
110 "\n"
111 "Command parameters:\n"
112 " 'filename' is a disk image filename\n"
113 " 'objectdef' is a QEMU user creatable object definition. See the qemu(1)\n"
114 " manual page for a description of the object properties. The most common\n"
115 " object type is a 'secret', which is used to supply passwords and/or\n"
116 " encryption keys.\n"
117 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
118 " 'cache' is the cache mode used to write the output disk image, the valid\n"
119 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
120 " 'directsync' and 'unsafe' (default for convert)\n"
121 " 'src_cache' is the cache mode used to read input disk images, the valid\n"
122 " options are the same as for the 'cache' option\n"
123 " 'size' is the disk image size in bytes. Optional suffixes\n"
124 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
125 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
126 " supported. 'b' is ignored.\n"
127 " 'output_filename' is the destination disk image filename\n"
128 " 'output_fmt' is the destination format\n"
129 " 'options' is a comma separated list of format specific options in a\n"
130 " name=value format. Use -o ? for an overview of the options supported by the\n"
131 " used format\n"
132 " 'snapshot_param' is param used for internal snapshot, format\n"
133 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
134 " '[ID_OR_NAME]'\n"
135 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
136 " instead\n"
137 " '-c' indicates that target image must be compressed (qcow format only)\n"
138 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
139 " match exactly. The image doesn't need a working backing file before\n"
140 " rebasing in this case (useful for renaming the backing file)\n"
141 " '-h' with or without a command shows this help and lists the supported formats\n"
142 " '-p' show progress of command (only certain commands)\n"
143 " '-q' use Quiet mode - do not print any output (except errors)\n"
144 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
145 " contain only zeros for qemu-img to create a sparse image during\n"
146 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
147 " unallocated or zero sectors, and the destination image will always be\n"
148 " fully allocated\n"
149 " '--output' takes the format in which the output must be done (human or json)\n"
150 " '-n' skips the target volume creation (useful if the volume is created\n"
151 " prior to running qemu-img)\n"
152 "\n"
153 "Parameters to check subcommand:\n"
154 " '-r' tries to repair any inconsistencies that are found during the check.\n"
155 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
156 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
157 " hiding corruption that has already occurred.\n"
158 "\n"
159 "Parameters to snapshot subcommand:\n"
160 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
161 " '-a' applies a snapshot (revert disk to saved state)\n"
162 " '-c' creates a snapshot\n"
163 " '-d' deletes a snapshot\n"
164 " '-l' lists all snapshots in the given image\n"
165 "\n"
166 "Parameters to compare subcommand:\n"
167 " '-f' first image format\n"
168 " '-F' second image format\n"
169 " '-s' run in Strict mode - fail on different image size or sector allocation\n"
170 "\n"
171 "Parameters to dd subcommand:\n"
172 " 'bs=BYTES' read and write up to BYTES bytes at a time "
173 "(default: 512)\n"
174 " 'count=N' copy only N input blocks\n"
175 " 'if=FILE' read from FILE\n"
176 " 'of=FILE' write to FILE\n"
177 " 'skip=N' skip N bs-sized blocks at the start of input\n";
178
179 printf("%s\nSupported formats:", help_msg);
180 bdrv_iterate_format(format_print, NULL);
181 printf("\n");
182 exit(EXIT_SUCCESS);
183 }
184
185 static QemuOptsList qemu_object_opts = {
186 .name = "object",
187 .implied_opt_name = "qom-type",
188 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
189 .desc = {
190 { }
191 },
192 };
193
194 static QemuOptsList qemu_source_opts = {
195 .name = "source",
196 .implied_opt_name = "file",
197 .head = QTAILQ_HEAD_INITIALIZER(qemu_source_opts.head),
198 .desc = {
199 { }
200 },
201 };
202
203 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
204 {
205 int ret = 0;
206 if (!quiet) {
207 va_list args;
208 va_start(args, fmt);
209 ret = vprintf(fmt, args);
210 va_end(args);
211 }
212 return ret;
213 }
214
215
216 static int print_block_option_help(const char *filename, const char *fmt)
217 {
218 BlockDriver *drv, *proto_drv;
219 QemuOptsList *create_opts = NULL;
220 Error *local_err = NULL;
221
222 /* Find driver and parse its options */
223 drv = bdrv_find_format(fmt);
224 if (!drv) {
225 error_report("Unknown file format '%s'", fmt);
226 return 1;
227 }
228
229 create_opts = qemu_opts_append(create_opts, drv->create_opts);
230 if (filename) {
231 proto_drv = bdrv_find_protocol(filename, true, &local_err);
232 if (!proto_drv) {
233 error_report_err(local_err);
234 qemu_opts_free(create_opts);
235 return 1;
236 }
237 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
238 }
239
240 qemu_opts_print_help(create_opts);
241 qemu_opts_free(create_opts);
242 return 0;
243 }
244
245
246 static int img_open_password(BlockBackend *blk, const char *filename,
247 int flags, bool quiet)
248 {
249 BlockDriverState *bs;
250 char password[256];
251
252 bs = blk_bs(blk);
253 if (bdrv_is_encrypted(bs) && bdrv_key_required(bs) &&
254 !(flags & BDRV_O_NO_IO)) {
255 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
256 if (qemu_read_password(password, sizeof(password)) < 0) {
257 error_report("No password given");
258 return -1;
259 }
260 if (bdrv_set_key(bs, password) < 0) {
261 error_report("invalid password");
262 return -1;
263 }
264 }
265 return 0;
266 }
267
268
269 static BlockBackend *img_open_opts(const char *optstr,
270 QemuOpts *opts, int flags, bool writethrough,
271 bool quiet)
272 {
273 QDict *options;
274 Error *local_err = NULL;
275 BlockBackend *blk;
276 options = qemu_opts_to_qdict(opts, NULL);
277 blk = blk_new_open(NULL, NULL, options, flags, &local_err);
278 if (!blk) {
279 error_reportf_err(local_err, "Could not open '%s': ", optstr);
280 return NULL;
281 }
282 blk_set_enable_write_cache(blk, !writethrough);
283
284 if (img_open_password(blk, optstr, flags, quiet) < 0) {
285 blk_unref(blk);
286 return NULL;
287 }
288 return blk;
289 }
290
291 static BlockBackend *img_open_file(const char *filename,
292 const char *fmt, int flags,
293 bool writethrough, bool quiet)
294 {
295 BlockBackend *blk;
296 Error *local_err = NULL;
297 QDict *options = NULL;
298
299 if (fmt) {
300 options = qdict_new();
301 qdict_put(options, "driver", qstring_from_str(fmt));
302 }
303
304 blk = blk_new_open(filename, NULL, options, flags, &local_err);
305 if (!blk) {
306 error_reportf_err(local_err, "Could not open '%s': ", filename);
307 return NULL;
308 }
309 blk_set_enable_write_cache(blk, !writethrough);
310
311 if (img_open_password(blk, filename, flags, quiet) < 0) {
312 blk_unref(blk);
313 return NULL;
314 }
315 return blk;
316 }
317
318
319 static BlockBackend *img_open(bool image_opts,
320 const char *filename,
321 const char *fmt, int flags, bool writethrough,
322 bool quiet)
323 {
324 BlockBackend *blk;
325 if (image_opts) {
326 QemuOpts *opts;
327 if (fmt) {
328 error_report("--image-opts and --format are mutually exclusive");
329 return NULL;
330 }
331 opts = qemu_opts_parse_noisily(qemu_find_opts("source"),
332 filename, true);
333 if (!opts) {
334 return NULL;
335 }
336 blk = img_open_opts(filename, opts, flags, writethrough, quiet);
337 } else {
338 blk = img_open_file(filename, fmt, flags, writethrough, quiet);
339 }
340 return blk;
341 }
342
343
344 static int add_old_style_options(const char *fmt, QemuOpts *opts,
345 const char *base_filename,
346 const char *base_fmt)
347 {
348 Error *err = NULL;
349
350 if (base_filename) {
351 qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename, &err);
352 if (err) {
353 error_report("Backing file not supported for file format '%s'",
354 fmt);
355 error_free(err);
356 return -1;
357 }
358 }
359 if (base_fmt) {
360 qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt, &err);
361 if (err) {
362 error_report("Backing file format not supported for file "
363 "format '%s'", fmt);
364 error_free(err);
365 return -1;
366 }
367 }
368 return 0;
369 }
370
371 static int img_create(int argc, char **argv)
372 {
373 int c;
374 uint64_t img_size = -1;
375 const char *fmt = "raw";
376 const char *base_fmt = NULL;
377 const char *filename;
378 const char *base_filename = NULL;
379 char *options = NULL;
380 Error *local_err = NULL;
381 bool quiet = false;
382
383 for(;;) {
384 static const struct option long_options[] = {
385 {"help", no_argument, 0, 'h'},
386 {"object", required_argument, 0, OPTION_OBJECT},
387 {0, 0, 0, 0}
388 };
389 c = getopt_long(argc, argv, "F:b:f:he6o:q",
390 long_options, NULL);
391 if (c == -1) {
392 break;
393 }
394 switch(c) {
395 case '?':
396 case 'h':
397 help();
398 break;
399 case 'F':
400 base_fmt = optarg;
401 break;
402 case 'b':
403 base_filename = optarg;
404 break;
405 case 'f':
406 fmt = optarg;
407 break;
408 case 'e':
409 error_report("option -e is deprecated, please use \'-o "
410 "encryption\' instead!");
411 goto fail;
412 case '6':
413 error_report("option -6 is deprecated, please use \'-o "
414 "compat6\' instead!");
415 goto fail;
416 case 'o':
417 if (!is_valid_option_list(optarg)) {
418 error_report("Invalid option list: %s", optarg);
419 goto fail;
420 }
421 if (!options) {
422 options = g_strdup(optarg);
423 } else {
424 char *old_options = options;
425 options = g_strdup_printf("%s,%s", options, optarg);
426 g_free(old_options);
427 }
428 break;
429 case 'q':
430 quiet = true;
431 break;
432 case OPTION_OBJECT: {
433 QemuOpts *opts;
434 opts = qemu_opts_parse_noisily(&qemu_object_opts,
435 optarg, true);
436 if (!opts) {
437 goto fail;
438 }
439 } break;
440 }
441 }
442
443 /* Get the filename */
444 filename = (optind < argc) ? argv[optind] : NULL;
445 if (options && has_help_option(options)) {
446 g_free(options);
447 return print_block_option_help(filename, fmt);
448 }
449
450 if (optind >= argc) {
451 error_exit("Expecting image file name");
452 }
453 optind++;
454
455 if (qemu_opts_foreach(&qemu_object_opts,
456 user_creatable_add_opts_foreach,
457 NULL, NULL)) {
458 goto fail;
459 }
460
461 /* Get image size, if specified */
462 if (optind < argc) {
463 int64_t sval;
464 char *end;
465 sval = qemu_strtosz_suffix(argv[optind++], &end,
466 QEMU_STRTOSZ_DEFSUFFIX_B);
467 if (sval < 0 || *end) {
468 if (sval == -ERANGE) {
469 error_report("Image size must be less than 8 EiB!");
470 } else {
471 error_report("Invalid image size specified! You may use k, M, "
472 "G, T, P or E suffixes for ");
473 error_report("kilobytes, megabytes, gigabytes, terabytes, "
474 "petabytes and exabytes.");
475 }
476 goto fail;
477 }
478 img_size = (uint64_t)sval;
479 }
480 if (optind != argc) {
481 error_exit("Unexpected argument: %s", argv[optind]);
482 }
483
484 bdrv_img_create(filename, fmt, base_filename, base_fmt,
485 options, img_size, 0, &local_err, quiet);
486 if (local_err) {
487 error_reportf_err(local_err, "%s: ", filename);
488 goto fail;
489 }
490
491 g_free(options);
492 return 0;
493
494 fail:
495 g_free(options);
496 return 1;
497 }
498
499 static void dump_json_image_check(ImageCheck *check, bool quiet)
500 {
501 QString *str;
502 QObject *obj;
503 Visitor *v = qobject_output_visitor_new(&obj);
504
505 visit_type_ImageCheck(v, NULL, &check, &error_abort);
506 visit_complete(v, &obj);
507 str = qobject_to_json_pretty(obj);
508 assert(str != NULL);
509 qprintf(quiet, "%s\n", qstring_get_str(str));
510 qobject_decref(obj);
511 visit_free(v);
512 QDECREF(str);
513 }
514
515 static void dump_human_image_check(ImageCheck *check, bool quiet)
516 {
517 if (!(check->corruptions || check->leaks || check->check_errors)) {
518 qprintf(quiet, "No errors were found on the image.\n");
519 } else {
520 if (check->corruptions) {
521 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
522 "Data may be corrupted, or further writes to the image "
523 "may corrupt it.\n",
524 check->corruptions);
525 }
526
527 if (check->leaks) {
528 qprintf(quiet,
529 "\n%" PRId64 " leaked clusters were found on the image.\n"
530 "This means waste of disk space, but no harm to data.\n",
531 check->leaks);
532 }
533
534 if (check->check_errors) {
535 qprintf(quiet,
536 "\n%" PRId64
537 " internal errors have occurred during the check.\n",
538 check->check_errors);
539 }
540 }
541
542 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
543 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
544 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
545 check->allocated_clusters, check->total_clusters,
546 check->allocated_clusters * 100.0 / check->total_clusters,
547 check->fragmented_clusters * 100.0 / check->allocated_clusters,
548 check->compressed_clusters * 100.0 /
549 check->allocated_clusters);
550 }
551
552 if (check->image_end_offset) {
553 qprintf(quiet,
554 "Image end offset: %" PRId64 "\n", check->image_end_offset);
555 }
556 }
557
558 static int collect_image_check(BlockDriverState *bs,
559 ImageCheck *check,
560 const char *filename,
561 const char *fmt,
562 int fix)
563 {
564 int ret;
565 BdrvCheckResult result;
566
567 ret = bdrv_check(bs, &result, fix);
568 if (ret < 0) {
569 return ret;
570 }
571
572 check->filename = g_strdup(filename);
573 check->format = g_strdup(bdrv_get_format_name(bs));
574 check->check_errors = result.check_errors;
575 check->corruptions = result.corruptions;
576 check->has_corruptions = result.corruptions != 0;
577 check->leaks = result.leaks;
578 check->has_leaks = result.leaks != 0;
579 check->corruptions_fixed = result.corruptions_fixed;
580 check->has_corruptions_fixed = result.corruptions != 0;
581 check->leaks_fixed = result.leaks_fixed;
582 check->has_leaks_fixed = result.leaks != 0;
583 check->image_end_offset = result.image_end_offset;
584 check->has_image_end_offset = result.image_end_offset != 0;
585 check->total_clusters = result.bfi.total_clusters;
586 check->has_total_clusters = result.bfi.total_clusters != 0;
587 check->allocated_clusters = result.bfi.allocated_clusters;
588 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
589 check->fragmented_clusters = result.bfi.fragmented_clusters;
590 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
591 check->compressed_clusters = result.bfi.compressed_clusters;
592 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
593
594 return 0;
595 }
596
597 /*
598 * Checks an image for consistency. Exit codes:
599 *
600 * 0 - Check completed, image is good
601 * 1 - Check not completed because of internal errors
602 * 2 - Check completed, image is corrupted
603 * 3 - Check completed, image has leaked clusters, but is good otherwise
604 * 63 - Checks are not supported by the image format
605 */
606 static int img_check(int argc, char **argv)
607 {
608 int c, ret;
609 OutputFormat output_format = OFORMAT_HUMAN;
610 const char *filename, *fmt, *output, *cache;
611 BlockBackend *blk;
612 BlockDriverState *bs;
613 int fix = 0;
614 int flags = BDRV_O_CHECK;
615 bool writethrough;
616 ImageCheck *check;
617 bool quiet = false;
618 bool image_opts = false;
619
620 fmt = NULL;
621 output = NULL;
622 cache = BDRV_DEFAULT_CACHE;
623
624 for(;;) {
625 int option_index = 0;
626 static const struct option long_options[] = {
627 {"help", no_argument, 0, 'h'},
628 {"format", required_argument, 0, 'f'},
629 {"repair", required_argument, 0, 'r'},
630 {"output", required_argument, 0, OPTION_OUTPUT},
631 {"object", required_argument, 0, OPTION_OBJECT},
632 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
633 {0, 0, 0, 0}
634 };
635 c = getopt_long(argc, argv, "hf:r:T:q",
636 long_options, &option_index);
637 if (c == -1) {
638 break;
639 }
640 switch(c) {
641 case '?':
642 case 'h':
643 help();
644 break;
645 case 'f':
646 fmt = optarg;
647 break;
648 case 'r':
649 flags |= BDRV_O_RDWR;
650
651 if (!strcmp(optarg, "leaks")) {
652 fix = BDRV_FIX_LEAKS;
653 } else if (!strcmp(optarg, "all")) {
654 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
655 } else {
656 error_exit("Unknown option value for -r "
657 "(expecting 'leaks' or 'all'): %s", optarg);
658 }
659 break;
660 case OPTION_OUTPUT:
661 output = optarg;
662 break;
663 case 'T':
664 cache = optarg;
665 break;
666 case 'q':
667 quiet = true;
668 break;
669 case OPTION_OBJECT: {
670 QemuOpts *opts;
671 opts = qemu_opts_parse_noisily(&qemu_object_opts,
672 optarg, true);
673 if (!opts) {
674 return 1;
675 }
676 } break;
677 case OPTION_IMAGE_OPTS:
678 image_opts = true;
679 break;
680 }
681 }
682 if (optind != argc - 1) {
683 error_exit("Expecting one image file name");
684 }
685 filename = argv[optind++];
686
687 if (output && !strcmp(output, "json")) {
688 output_format = OFORMAT_JSON;
689 } else if (output && !strcmp(output, "human")) {
690 output_format = OFORMAT_HUMAN;
691 } else if (output) {
692 error_report("--output must be used with human or json as argument.");
693 return 1;
694 }
695
696 if (qemu_opts_foreach(&qemu_object_opts,
697 user_creatable_add_opts_foreach,
698 NULL, NULL)) {
699 return 1;
700 }
701
702 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
703 if (ret < 0) {
704 error_report("Invalid source cache option: %s", cache);
705 return 1;
706 }
707
708 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
709 if (!blk) {
710 return 1;
711 }
712 bs = blk_bs(blk);
713
714 check = g_new0(ImageCheck, 1);
715 ret = collect_image_check(bs, check, filename, fmt, fix);
716
717 if (ret == -ENOTSUP) {
718 error_report("This image format does not support checks");
719 ret = 63;
720 goto fail;
721 }
722
723 if (check->corruptions_fixed || check->leaks_fixed) {
724 int corruptions_fixed, leaks_fixed;
725
726 leaks_fixed = check->leaks_fixed;
727 corruptions_fixed = check->corruptions_fixed;
728
729 if (output_format == OFORMAT_HUMAN) {
730 qprintf(quiet,
731 "The following inconsistencies were found and repaired:\n\n"
732 " %" PRId64 " leaked clusters\n"
733 " %" PRId64 " corruptions\n\n"
734 "Double checking the fixed image now...\n",
735 check->leaks_fixed,
736 check->corruptions_fixed);
737 }
738
739 ret = collect_image_check(bs, check, filename, fmt, 0);
740
741 check->leaks_fixed = leaks_fixed;
742 check->corruptions_fixed = corruptions_fixed;
743 }
744
745 if (!ret) {
746 switch (output_format) {
747 case OFORMAT_HUMAN:
748 dump_human_image_check(check, quiet);
749 break;
750 case OFORMAT_JSON:
751 dump_json_image_check(check, quiet);
752 break;
753 }
754 }
755
756 if (ret || check->check_errors) {
757 if (ret) {
758 error_report("Check failed: %s", strerror(-ret));
759 } else {
760 error_report("Check failed");
761 }
762 ret = 1;
763 goto fail;
764 }
765
766 if (check->corruptions) {
767 ret = 2;
768 } else if (check->leaks) {
769 ret = 3;
770 } else {
771 ret = 0;
772 }
773
774 fail:
775 qapi_free_ImageCheck(check);
776 blk_unref(blk);
777 return ret;
778 }
779
780 typedef struct CommonBlockJobCBInfo {
781 BlockDriverState *bs;
782 Error **errp;
783 } CommonBlockJobCBInfo;
784
785 static void common_block_job_cb(void *opaque, int ret)
786 {
787 CommonBlockJobCBInfo *cbi = opaque;
788
789 if (ret < 0) {
790 error_setg_errno(cbi->errp, -ret, "Block job failed");
791 }
792 }
793
794 static void run_block_job(BlockJob *job, Error **errp)
795 {
796 AioContext *aio_context = blk_get_aio_context(job->blk);
797
798 aio_context_acquire(aio_context);
799 do {
800 aio_poll(aio_context, true);
801 qemu_progress_print(job->len ?
802 ((float)job->offset / job->len * 100.f) : 0.0f, 0);
803 } while (!job->ready);
804
805 block_job_complete_sync(job, errp);
806 aio_context_release(aio_context);
807
808 /* A block job may finish instantaneously without publishing any progress,
809 * so just signal completion here */
810 qemu_progress_print(100.f, 0);
811 }
812
813 static int img_commit(int argc, char **argv)
814 {
815 int c, ret, flags;
816 const char *filename, *fmt, *cache, *base;
817 BlockBackend *blk;
818 BlockDriverState *bs, *base_bs;
819 bool progress = false, quiet = false, drop = false;
820 bool writethrough;
821 Error *local_err = NULL;
822 CommonBlockJobCBInfo cbi;
823 bool image_opts = false;
824 AioContext *aio_context;
825
826 fmt = NULL;
827 cache = BDRV_DEFAULT_CACHE;
828 base = NULL;
829 for(;;) {
830 static const struct option long_options[] = {
831 {"help", no_argument, 0, 'h'},
832 {"object", required_argument, 0, OPTION_OBJECT},
833 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
834 {0, 0, 0, 0}
835 };
836 c = getopt_long(argc, argv, "f:ht:b:dpq",
837 long_options, NULL);
838 if (c == -1) {
839 break;
840 }
841 switch(c) {
842 case '?':
843 case 'h':
844 help();
845 break;
846 case 'f':
847 fmt = optarg;
848 break;
849 case 't':
850 cache = optarg;
851 break;
852 case 'b':
853 base = optarg;
854 /* -b implies -d */
855 drop = true;
856 break;
857 case 'd':
858 drop = true;
859 break;
860 case 'p':
861 progress = true;
862 break;
863 case 'q':
864 quiet = true;
865 break;
866 case OPTION_OBJECT: {
867 QemuOpts *opts;
868 opts = qemu_opts_parse_noisily(&qemu_object_opts,
869 optarg, true);
870 if (!opts) {
871 return 1;
872 }
873 } break;
874 case OPTION_IMAGE_OPTS:
875 image_opts = true;
876 break;
877 }
878 }
879
880 /* Progress is not shown in Quiet mode */
881 if (quiet) {
882 progress = false;
883 }
884
885 if (optind != argc - 1) {
886 error_exit("Expecting one image file name");
887 }
888 filename = argv[optind++];
889
890 if (qemu_opts_foreach(&qemu_object_opts,
891 user_creatable_add_opts_foreach,
892 NULL, NULL)) {
893 return 1;
894 }
895
896 flags = BDRV_O_RDWR | BDRV_O_UNMAP;
897 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
898 if (ret < 0) {
899 error_report("Invalid cache option: %s", cache);
900 return 1;
901 }
902
903 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
904 if (!blk) {
905 return 1;
906 }
907 bs = blk_bs(blk);
908
909 qemu_progress_init(progress, 1.f);
910 qemu_progress_print(0.f, 100);
911
912 if (base) {
913 base_bs = bdrv_find_backing_image(bs, base);
914 if (!base_bs) {
915 error_setg(&local_err, QERR_BASE_NOT_FOUND, base);
916 goto done;
917 }
918 } else {
919 /* This is different from QMP, which by default uses the deepest file in
920 * the backing chain (i.e., the very base); however, the traditional
921 * behavior of qemu-img commit is using the immediate backing file. */
922 base_bs = backing_bs(bs);
923 if (!base_bs) {
924 error_setg(&local_err, "Image does not have a backing file");
925 goto done;
926 }
927 }
928
929 cbi = (CommonBlockJobCBInfo){
930 .errp = &local_err,
931 .bs = bs,
932 };
933
934 aio_context = bdrv_get_aio_context(bs);
935 aio_context_acquire(aio_context);
936 commit_active_start("commit", bs, base_bs, 0, BLOCKDEV_ON_ERROR_REPORT,
937 common_block_job_cb, &cbi, &local_err, false);
938 aio_context_release(aio_context);
939 if (local_err) {
940 goto done;
941 }
942
943 /* When the block job completes, the BlockBackend reference will point to
944 * the old backing file. In order to avoid that the top image is already
945 * deleted, so we can still empty it afterwards, increment the reference
946 * counter here preemptively. */
947 if (!drop) {
948 bdrv_ref(bs);
949 }
950
951 run_block_job(bs->job, &local_err);
952 if (local_err) {
953 goto unref_backing;
954 }
955
956 if (!drop && bs->drv->bdrv_make_empty) {
957 ret = bs->drv->bdrv_make_empty(bs);
958 if (ret) {
959 error_setg_errno(&local_err, -ret, "Could not empty %s",
960 filename);
961 goto unref_backing;
962 }
963 }
964
965 unref_backing:
966 if (!drop) {
967 bdrv_unref(bs);
968 }
969
970 done:
971 qemu_progress_end();
972
973 blk_unref(blk);
974
975 if (local_err) {
976 error_report_err(local_err);
977 return 1;
978 }
979
980 qprintf(quiet, "Image committed.\n");
981 return 0;
982 }
983
984 /*
985 * Returns true iff the first sector pointed to by 'buf' contains at least
986 * a non-NUL byte.
987 *
988 * 'pnum' is set to the number of sectors (including and immediately following
989 * the first one) that are known to be in the same allocated/unallocated state.
990 */
991 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
992 {
993 bool is_zero;
994 int i;
995
996 if (n <= 0) {
997 *pnum = 0;
998 return 0;
999 }
1000 is_zero = buffer_is_zero(buf, 512);
1001 for(i = 1; i < n; i++) {
1002 buf += 512;
1003 if (is_zero != buffer_is_zero(buf, 512)) {
1004 break;
1005 }
1006 }
1007 *pnum = i;
1008 return !is_zero;
1009 }
1010
1011 /*
1012 * Like is_allocated_sectors, but if the buffer starts with a used sector,
1013 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
1014 * breaking up write requests for only small sparse areas.
1015 */
1016 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
1017 int min)
1018 {
1019 int ret;
1020 int num_checked, num_used;
1021
1022 if (n < min) {
1023 min = n;
1024 }
1025
1026 ret = is_allocated_sectors(buf, n, pnum);
1027 if (!ret) {
1028 return ret;
1029 }
1030
1031 num_used = *pnum;
1032 buf += BDRV_SECTOR_SIZE * *pnum;
1033 n -= *pnum;
1034 num_checked = num_used;
1035
1036 while (n > 0) {
1037 ret = is_allocated_sectors(buf, n, pnum);
1038
1039 buf += BDRV_SECTOR_SIZE * *pnum;
1040 n -= *pnum;
1041 num_checked += *pnum;
1042 if (ret) {
1043 num_used = num_checked;
1044 } else if (*pnum >= min) {
1045 break;
1046 }
1047 }
1048
1049 *pnum = num_used;
1050 return 1;
1051 }
1052
1053 /*
1054 * Compares two buffers sector by sector. Returns 0 if the first sector of both
1055 * buffers matches, non-zero otherwise.
1056 *
1057 * pnum is set to the number of sectors (including and immediately following
1058 * the first one) that are known to have the same comparison result
1059 */
1060 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
1061 int *pnum)
1062 {
1063 bool res;
1064 int i;
1065
1066 if (n <= 0) {
1067 *pnum = 0;
1068 return 0;
1069 }
1070
1071 res = !!memcmp(buf1, buf2, 512);
1072 for(i = 1; i < n; i++) {
1073 buf1 += 512;
1074 buf2 += 512;
1075
1076 if (!!memcmp(buf1, buf2, 512) != res) {
1077 break;
1078 }
1079 }
1080
1081 *pnum = i;
1082 return res;
1083 }
1084
1085 #define IO_BUF_SIZE (2 * 1024 * 1024)
1086
1087 static int64_t sectors_to_bytes(int64_t sectors)
1088 {
1089 return sectors << BDRV_SECTOR_BITS;
1090 }
1091
1092 static int64_t sectors_to_process(int64_t total, int64_t from)
1093 {
1094 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
1095 }
1096
1097 /*
1098 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
1099 *
1100 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
1101 * data and negative value on error.
1102 *
1103 * @param blk: BlockBackend for the image
1104 * @param sect_num: Number of first sector to check
1105 * @param sect_count: Number of sectors to check
1106 * @param filename: Name of disk file we are checking (logging purpose)
1107 * @param buffer: Allocated buffer for storing read data
1108 * @param quiet: Flag for quiet mode
1109 */
1110 static int check_empty_sectors(BlockBackend *blk, int64_t sect_num,
1111 int sect_count, const char *filename,
1112 uint8_t *buffer, bool quiet)
1113 {
1114 int pnum, ret = 0;
1115 ret = blk_pread(blk, sect_num << BDRV_SECTOR_BITS, buffer,
1116 sect_count << BDRV_SECTOR_BITS);
1117 if (ret < 0) {
1118 error_report("Error while reading offset %" PRId64 " of %s: %s",
1119 sectors_to_bytes(sect_num), filename, strerror(-ret));
1120 return ret;
1121 }
1122 ret = is_allocated_sectors(buffer, sect_count, &pnum);
1123 if (ret || pnum != sect_count) {
1124 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1125 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
1126 return 1;
1127 }
1128
1129 return 0;
1130 }
1131
1132 /*
1133 * Compares two images. Exit codes:
1134 *
1135 * 0 - Images are identical
1136 * 1 - Images differ
1137 * >1 - Error occurred
1138 */
1139 static int img_compare(int argc, char **argv)
1140 {
1141 const char *fmt1 = NULL, *fmt2 = NULL, *cache, *filename1, *filename2;
1142 BlockBackend *blk1, *blk2;
1143 BlockDriverState *bs1, *bs2;
1144 int64_t total_sectors1, total_sectors2;
1145 uint8_t *buf1 = NULL, *buf2 = NULL;
1146 int pnum1, pnum2;
1147 int allocated1, allocated2;
1148 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
1149 bool progress = false, quiet = false, strict = false;
1150 int flags;
1151 bool writethrough;
1152 int64_t total_sectors;
1153 int64_t sector_num = 0;
1154 int64_t nb_sectors;
1155 int c, pnum;
1156 uint64_t progress_base;
1157 bool image_opts = false;
1158
1159 cache = BDRV_DEFAULT_CACHE;
1160 for (;;) {
1161 static const struct option long_options[] = {
1162 {"help", no_argument, 0, 'h'},
1163 {"object", required_argument, 0, OPTION_OBJECT},
1164 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1165 {0, 0, 0, 0}
1166 };
1167 c = getopt_long(argc, argv, "hf:F:T:pqs",
1168 long_options, NULL);
1169 if (c == -1) {
1170 break;
1171 }
1172 switch (c) {
1173 case '?':
1174 case 'h':
1175 help();
1176 break;
1177 case 'f':
1178 fmt1 = optarg;
1179 break;
1180 case 'F':
1181 fmt2 = optarg;
1182 break;
1183 case 'T':
1184 cache = optarg;
1185 break;
1186 case 'p':
1187 progress = true;
1188 break;
1189 case 'q':
1190 quiet = true;
1191 break;
1192 case 's':
1193 strict = true;
1194 break;
1195 case OPTION_OBJECT: {
1196 QemuOpts *opts;
1197 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1198 optarg, true);
1199 if (!opts) {
1200 ret = 2;
1201 goto out4;
1202 }
1203 } break;
1204 case OPTION_IMAGE_OPTS:
1205 image_opts = true;
1206 break;
1207 }
1208 }
1209
1210 /* Progress is not shown in Quiet mode */
1211 if (quiet) {
1212 progress = false;
1213 }
1214
1215
1216 if (optind != argc - 2) {
1217 error_exit("Expecting two image file names");
1218 }
1219 filename1 = argv[optind++];
1220 filename2 = argv[optind++];
1221
1222 if (qemu_opts_foreach(&qemu_object_opts,
1223 user_creatable_add_opts_foreach,
1224 NULL, NULL)) {
1225 ret = 2;
1226 goto out4;
1227 }
1228
1229 /* Initialize before goto out */
1230 qemu_progress_init(progress, 2.0);
1231
1232 flags = 0;
1233 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
1234 if (ret < 0) {
1235 error_report("Invalid source cache option: %s", cache);
1236 ret = 2;
1237 goto out3;
1238 }
1239
1240 blk1 = img_open(image_opts, filename1, fmt1, flags, writethrough, quiet);
1241 if (!blk1) {
1242 ret = 2;
1243 goto out3;
1244 }
1245
1246 blk2 = img_open(image_opts, filename2, fmt2, flags, writethrough, quiet);
1247 if (!blk2) {
1248 ret = 2;
1249 goto out2;
1250 }
1251 bs1 = blk_bs(blk1);
1252 bs2 = blk_bs(blk2);
1253
1254 buf1 = blk_blockalign(blk1, IO_BUF_SIZE);
1255 buf2 = blk_blockalign(blk2, IO_BUF_SIZE);
1256 total_sectors1 = blk_nb_sectors(blk1);
1257 if (total_sectors1 < 0) {
1258 error_report("Can't get size of %s: %s",
1259 filename1, strerror(-total_sectors1));
1260 ret = 4;
1261 goto out;
1262 }
1263 total_sectors2 = blk_nb_sectors(blk2);
1264 if (total_sectors2 < 0) {
1265 error_report("Can't get size of %s: %s",
1266 filename2, strerror(-total_sectors2));
1267 ret = 4;
1268 goto out;
1269 }
1270 total_sectors = MIN(total_sectors1, total_sectors2);
1271 progress_base = MAX(total_sectors1, total_sectors2);
1272
1273 qemu_progress_print(0, 100);
1274
1275 if (strict && total_sectors1 != total_sectors2) {
1276 ret = 1;
1277 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1278 goto out;
1279 }
1280
1281 for (;;) {
1282 int64_t status1, status2;
1283 BlockDriverState *file;
1284
1285 nb_sectors = sectors_to_process(total_sectors, sector_num);
1286 if (nb_sectors <= 0) {
1287 break;
1288 }
1289 status1 = bdrv_get_block_status_above(bs1, NULL, sector_num,
1290 total_sectors1 - sector_num,
1291 &pnum1, &file);
1292 if (status1 < 0) {
1293 ret = 3;
1294 error_report("Sector allocation test failed for %s", filename1);
1295 goto out;
1296 }
1297 allocated1 = status1 & BDRV_BLOCK_ALLOCATED;
1298
1299 status2 = bdrv_get_block_status_above(bs2, NULL, sector_num,
1300 total_sectors2 - sector_num,
1301 &pnum2, &file);
1302 if (status2 < 0) {
1303 ret = 3;
1304 error_report("Sector allocation test failed for %s", filename2);
1305 goto out;
1306 }
1307 allocated2 = status2 & BDRV_BLOCK_ALLOCATED;
1308 if (pnum1) {
1309 nb_sectors = MIN(nb_sectors, pnum1);
1310 }
1311 if (pnum2) {
1312 nb_sectors = MIN(nb_sectors, pnum2);
1313 }
1314
1315 if (strict) {
1316 if ((status1 & ~BDRV_BLOCK_OFFSET_MASK) !=
1317 (status2 & ~BDRV_BLOCK_OFFSET_MASK)) {
1318 ret = 1;
1319 qprintf(quiet, "Strict mode: Offset %" PRId64
1320 " block status mismatch!\n",
1321 sectors_to_bytes(sector_num));
1322 goto out;
1323 }
1324 }
1325 if ((status1 & BDRV_BLOCK_ZERO) && (status2 & BDRV_BLOCK_ZERO)) {
1326 nb_sectors = MIN(pnum1, pnum2);
1327 } else if (allocated1 == allocated2) {
1328 if (allocated1) {
1329 ret = blk_pread(blk1, sector_num << BDRV_SECTOR_BITS, buf1,
1330 nb_sectors << BDRV_SECTOR_BITS);
1331 if (ret < 0) {
1332 error_report("Error while reading offset %" PRId64 " of %s:"
1333 " %s", sectors_to_bytes(sector_num), filename1,
1334 strerror(-ret));
1335 ret = 4;
1336 goto out;
1337 }
1338 ret = blk_pread(blk2, sector_num << BDRV_SECTOR_BITS, buf2,
1339 nb_sectors << BDRV_SECTOR_BITS);
1340 if (ret < 0) {
1341 error_report("Error while reading offset %" PRId64
1342 " of %s: %s", sectors_to_bytes(sector_num),
1343 filename2, strerror(-ret));
1344 ret = 4;
1345 goto out;
1346 }
1347 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1348 if (ret || pnum != nb_sectors) {
1349 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1350 sectors_to_bytes(
1351 ret ? sector_num : sector_num + pnum));
1352 ret = 1;
1353 goto out;
1354 }
1355 }
1356 } else {
1357
1358 if (allocated1) {
1359 ret = check_empty_sectors(blk1, sector_num, nb_sectors,
1360 filename1, buf1, quiet);
1361 } else {
1362 ret = check_empty_sectors(blk2, sector_num, nb_sectors,
1363 filename2, buf1, quiet);
1364 }
1365 if (ret) {
1366 if (ret < 0) {
1367 error_report("Error while reading offset %" PRId64 ": %s",
1368 sectors_to_bytes(sector_num), strerror(-ret));
1369 ret = 4;
1370 }
1371 goto out;
1372 }
1373 }
1374 sector_num += nb_sectors;
1375 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1376 }
1377
1378 if (total_sectors1 != total_sectors2) {
1379 BlockBackend *blk_over;
1380 int64_t total_sectors_over;
1381 const char *filename_over;
1382
1383 qprintf(quiet, "Warning: Image size mismatch!\n");
1384 if (total_sectors1 > total_sectors2) {
1385 total_sectors_over = total_sectors1;
1386 blk_over = blk1;
1387 filename_over = filename1;
1388 } else {
1389 total_sectors_over = total_sectors2;
1390 blk_over = blk2;
1391 filename_over = filename2;
1392 }
1393
1394 for (;;) {
1395 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1396 if (nb_sectors <= 0) {
1397 break;
1398 }
1399 ret = bdrv_is_allocated_above(blk_bs(blk_over), NULL, sector_num,
1400 nb_sectors, &pnum);
1401 if (ret < 0) {
1402 ret = 3;
1403 error_report("Sector allocation test failed for %s",
1404 filename_over);
1405 goto out;
1406
1407 }
1408 nb_sectors = pnum;
1409 if (ret) {
1410 ret = check_empty_sectors(blk_over, sector_num, nb_sectors,
1411 filename_over, buf1, quiet);
1412 if (ret) {
1413 if (ret < 0) {
1414 error_report("Error while reading offset %" PRId64
1415 " of %s: %s", sectors_to_bytes(sector_num),
1416 filename_over, strerror(-ret));
1417 ret = 4;
1418 }
1419 goto out;
1420 }
1421 }
1422 sector_num += nb_sectors;
1423 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1424 }
1425 }
1426
1427 qprintf(quiet, "Images are identical.\n");
1428 ret = 0;
1429
1430 out:
1431 qemu_vfree(buf1);
1432 qemu_vfree(buf2);
1433 blk_unref(blk2);
1434 out2:
1435 blk_unref(blk1);
1436 out3:
1437 qemu_progress_end();
1438 out4:
1439 return ret;
1440 }
1441
1442 enum ImgConvertBlockStatus {
1443 BLK_DATA,
1444 BLK_ZERO,
1445 BLK_BACKING_FILE,
1446 };
1447
1448 typedef struct ImgConvertState {
1449 BlockBackend **src;
1450 int64_t *src_sectors;
1451 int src_cur, src_num;
1452 int64_t src_cur_offset;
1453 int64_t total_sectors;
1454 int64_t allocated_sectors;
1455 enum ImgConvertBlockStatus status;
1456 int64_t sector_next_status;
1457 BlockBackend *target;
1458 bool has_zero_init;
1459 bool compressed;
1460 bool target_has_backing;
1461 int min_sparse;
1462 size_t cluster_sectors;
1463 size_t buf_sectors;
1464 } ImgConvertState;
1465
1466 static void convert_select_part(ImgConvertState *s, int64_t sector_num)
1467 {
1468 assert(sector_num >= s->src_cur_offset);
1469 while (sector_num - s->src_cur_offset >= s->src_sectors[s->src_cur]) {
1470 s->src_cur_offset += s->src_sectors[s->src_cur];
1471 s->src_cur++;
1472 assert(s->src_cur < s->src_num);
1473 }
1474 }
1475
1476 static int convert_iteration_sectors(ImgConvertState *s, int64_t sector_num)
1477 {
1478 int64_t ret;
1479 int n;
1480
1481 convert_select_part(s, sector_num);
1482
1483 assert(s->total_sectors > sector_num);
1484 n = MIN(s->total_sectors - sector_num, BDRV_REQUEST_MAX_SECTORS);
1485
1486 if (s->sector_next_status <= sector_num) {
1487 BlockDriverState *file;
1488 ret = bdrv_get_block_status(blk_bs(s->src[s->src_cur]),
1489 sector_num - s->src_cur_offset,
1490 n, &n, &file);
1491 if (ret < 0) {
1492 return ret;
1493 }
1494
1495 if (ret & BDRV_BLOCK_ZERO) {
1496 s->status = BLK_ZERO;
1497 } else if (ret & BDRV_BLOCK_DATA) {
1498 s->status = BLK_DATA;
1499 } else if (!s->target_has_backing) {
1500 /* Without a target backing file we must copy over the contents of
1501 * the backing file as well. */
1502 /* Check block status of the backing file chain to avoid
1503 * needlessly reading zeroes and limiting the iteration to the
1504 * buffer size */
1505 ret = bdrv_get_block_status_above(blk_bs(s->src[s->src_cur]), NULL,
1506 sector_num - s->src_cur_offset,
1507 n, &n, &file);
1508 if (ret < 0) {
1509 return ret;
1510 }
1511
1512 if (ret & BDRV_BLOCK_ZERO) {
1513 s->status = BLK_ZERO;
1514 } else {
1515 s->status = BLK_DATA;
1516 }
1517 } else {
1518 s->status = BLK_BACKING_FILE;
1519 }
1520
1521 s->sector_next_status = sector_num + n;
1522 }
1523
1524 n = MIN(n, s->sector_next_status - sector_num);
1525 if (s->status == BLK_DATA) {
1526 n = MIN(n, s->buf_sectors);
1527 }
1528
1529 /* We need to write complete clusters for compressed images, so if an
1530 * unallocated area is shorter than that, we must consider the whole
1531 * cluster allocated. */
1532 if (s->compressed) {
1533 if (n < s->cluster_sectors) {
1534 n = MIN(s->cluster_sectors, s->total_sectors - sector_num);
1535 s->status = BLK_DATA;
1536 } else {
1537 n = QEMU_ALIGN_DOWN(n, s->cluster_sectors);
1538 }
1539 }
1540
1541 return n;
1542 }
1543
1544 static int convert_read(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1545 uint8_t *buf)
1546 {
1547 int n;
1548 int ret;
1549
1550 assert(nb_sectors <= s->buf_sectors);
1551 while (nb_sectors > 0) {
1552 BlockBackend *blk;
1553 int64_t bs_sectors;
1554
1555 /* In the case of compression with multiple source files, we can get a
1556 * nb_sectors that spreads into the next part. So we must be able to
1557 * read across multiple BDSes for one convert_read() call. */
1558 convert_select_part(s, sector_num);
1559 blk = s->src[s->src_cur];
1560 bs_sectors = s->src_sectors[s->src_cur];
1561
1562 n = MIN(nb_sectors, bs_sectors - (sector_num - s->src_cur_offset));
1563 ret = blk_pread(blk,
1564 (sector_num - s->src_cur_offset) << BDRV_SECTOR_BITS,
1565 buf, n << BDRV_SECTOR_BITS);
1566 if (ret < 0) {
1567 return ret;
1568 }
1569
1570 sector_num += n;
1571 nb_sectors -= n;
1572 buf += n * BDRV_SECTOR_SIZE;
1573 }
1574
1575 return 0;
1576 }
1577
1578 static int convert_write(ImgConvertState *s, int64_t sector_num, int nb_sectors,
1579 const uint8_t *buf)
1580 {
1581 int ret;
1582
1583 while (nb_sectors > 0) {
1584 int n = nb_sectors;
1585
1586 switch (s->status) {
1587 case BLK_BACKING_FILE:
1588 /* If we have a backing file, leave clusters unallocated that are
1589 * unallocated in the source image, so that the backing file is
1590 * visible at the respective offset. */
1591 assert(s->target_has_backing);
1592 break;
1593
1594 case BLK_DATA:
1595 /* We must always write compressed clusters as a whole, so don't
1596 * try to find zeroed parts in the buffer. We can only save the
1597 * write if the buffer is completely zeroed and we're allowed to
1598 * keep the target sparse. */
1599 if (s->compressed) {
1600 if (s->has_zero_init && s->min_sparse &&
1601 buffer_is_zero(buf, n * BDRV_SECTOR_SIZE))
1602 {
1603 assert(!s->target_has_backing);
1604 break;
1605 }
1606
1607 ret = blk_pwrite_compressed(s->target,
1608 sector_num << BDRV_SECTOR_BITS,
1609 buf, n << BDRV_SECTOR_BITS);
1610 if (ret < 0) {
1611 return ret;
1612 }
1613 break;
1614 }
1615
1616 /* If there is real non-zero data or we're told to keep the target
1617 * fully allocated (-S 0), we must write it. Otherwise we can treat
1618 * it as zero sectors. */
1619 if (!s->min_sparse ||
1620 is_allocated_sectors_min(buf, n, &n, s->min_sparse))
1621 {
1622 ret = blk_pwrite(s->target, sector_num << BDRV_SECTOR_BITS,
1623 buf, n << BDRV_SECTOR_BITS, 0);
1624 if (ret < 0) {
1625 return ret;
1626 }
1627 break;
1628 }
1629 /* fall-through */
1630
1631 case BLK_ZERO:
1632 if (s->has_zero_init) {
1633 break;
1634 }
1635 ret = blk_pwrite_zeroes(s->target, sector_num << BDRV_SECTOR_BITS,
1636 n << BDRV_SECTOR_BITS, 0);
1637 if (ret < 0) {
1638 return ret;
1639 }
1640 break;
1641 }
1642
1643 sector_num += n;
1644 nb_sectors -= n;
1645 buf += n * BDRV_SECTOR_SIZE;
1646 }
1647
1648 return 0;
1649 }
1650
1651 static int convert_do_copy(ImgConvertState *s)
1652 {
1653 uint8_t *buf = NULL;
1654 int64_t sector_num, allocated_done;
1655 int ret;
1656 int n;
1657
1658 /* Check whether we have zero initialisation or can get it efficiently */
1659 s->has_zero_init = s->min_sparse && !s->target_has_backing
1660 ? bdrv_has_zero_init(blk_bs(s->target))
1661 : false;
1662
1663 if (!s->has_zero_init && !s->target_has_backing &&
1664 bdrv_can_write_zeroes_with_unmap(blk_bs(s->target)))
1665 {
1666 ret = blk_make_zero(s->target, BDRV_REQ_MAY_UNMAP);
1667 if (ret == 0) {
1668 s->has_zero_init = true;
1669 }
1670 }
1671
1672 /* Allocate buffer for copied data. For compressed images, only one cluster
1673 * can be copied at a time. */
1674 if (s->compressed) {
1675 if (s->cluster_sectors <= 0 || s->cluster_sectors > s->buf_sectors) {
1676 error_report("invalid cluster size");
1677 ret = -EINVAL;
1678 goto fail;
1679 }
1680 s->buf_sectors = s->cluster_sectors;
1681 }
1682 buf = blk_blockalign(s->target, s->buf_sectors * BDRV_SECTOR_SIZE);
1683
1684 /* Calculate allocated sectors for progress */
1685 s->allocated_sectors = 0;
1686 sector_num = 0;
1687 while (sector_num < s->total_sectors) {
1688 n = convert_iteration_sectors(s, sector_num);
1689 if (n < 0) {
1690 ret = n;
1691 goto fail;
1692 }
1693 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1694 {
1695 s->allocated_sectors += n;
1696 }
1697 sector_num += n;
1698 }
1699
1700 /* Do the copy */
1701 s->src_cur = 0;
1702 s->src_cur_offset = 0;
1703 s->sector_next_status = 0;
1704
1705 sector_num = 0;
1706 allocated_done = 0;
1707
1708 while (sector_num < s->total_sectors) {
1709 n = convert_iteration_sectors(s, sector_num);
1710 if (n < 0) {
1711 ret = n;
1712 goto fail;
1713 }
1714 if (s->status == BLK_DATA || (!s->min_sparse && s->status == BLK_ZERO))
1715 {
1716 allocated_done += n;
1717 qemu_progress_print(100.0 * allocated_done / s->allocated_sectors,
1718 0);
1719 }
1720
1721 if (s->status == BLK_DATA) {
1722 ret = convert_read(s, sector_num, n, buf);
1723 if (ret < 0) {
1724 error_report("error while reading sector %" PRId64
1725 ": %s", sector_num, strerror(-ret));
1726 goto fail;
1727 }
1728 } else if (!s->min_sparse && s->status == BLK_ZERO) {
1729 n = MIN(n, s->buf_sectors);
1730 memset(buf, 0, n * BDRV_SECTOR_SIZE);
1731 s->status = BLK_DATA;
1732 }
1733
1734 ret = convert_write(s, sector_num, n, buf);
1735 if (ret < 0) {
1736 error_report("error while writing sector %" PRId64
1737 ": %s", sector_num, strerror(-ret));
1738 goto fail;
1739 }
1740
1741 sector_num += n;
1742 }
1743
1744 if (s->compressed) {
1745 /* signal EOF to align */
1746 ret = blk_pwrite_compressed(s->target, 0, NULL, 0);
1747 if (ret < 0) {
1748 goto fail;
1749 }
1750 }
1751
1752 ret = 0;
1753 fail:
1754 qemu_vfree(buf);
1755 return ret;
1756 }
1757
1758 static int img_convert(int argc, char **argv)
1759 {
1760 int c, bs_n, bs_i, compress, cluster_sectors, skip_create;
1761 int64_t ret = 0;
1762 int progress = 0, flags, src_flags;
1763 bool writethrough, src_writethrough;
1764 const char *fmt, *out_fmt, *cache, *src_cache, *out_baseimg, *out_filename;
1765 BlockDriver *drv, *proto_drv;
1766 BlockBackend **blk = NULL, *out_blk = NULL;
1767 BlockDriverState **bs = NULL, *out_bs = NULL;
1768 int64_t total_sectors;
1769 int64_t *bs_sectors = NULL;
1770 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1771 BlockDriverInfo bdi;
1772 QemuOpts *opts = NULL;
1773 QemuOptsList *create_opts = NULL;
1774 const char *out_baseimg_param;
1775 char *options = NULL;
1776 const char *snapshot_name = NULL;
1777 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1778 bool quiet = false;
1779 Error *local_err = NULL;
1780 QemuOpts *sn_opts = NULL;
1781 ImgConvertState state;
1782 bool image_opts = false;
1783
1784 fmt = NULL;
1785 out_fmt = "raw";
1786 cache = "unsafe";
1787 src_cache = BDRV_DEFAULT_CACHE;
1788 out_baseimg = NULL;
1789 compress = 0;
1790 skip_create = 0;
1791 for(;;) {
1792 static const struct option long_options[] = {
1793 {"help", no_argument, 0, 'h'},
1794 {"object", required_argument, 0, OPTION_OBJECT},
1795 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
1796 {0, 0, 0, 0}
1797 };
1798 c = getopt_long(argc, argv, "hf:O:B:ce6o:s:l:S:pt:T:qn",
1799 long_options, NULL);
1800 if (c == -1) {
1801 break;
1802 }
1803 switch(c) {
1804 case '?':
1805 case 'h':
1806 help();
1807 break;
1808 case 'f':
1809 fmt = optarg;
1810 break;
1811 case 'O':
1812 out_fmt = optarg;
1813 break;
1814 case 'B':
1815 out_baseimg = optarg;
1816 break;
1817 case 'c':
1818 compress = 1;
1819 break;
1820 case 'e':
1821 error_report("option -e is deprecated, please use \'-o "
1822 "encryption\' instead!");
1823 ret = -1;
1824 goto fail_getopt;
1825 case '6':
1826 error_report("option -6 is deprecated, please use \'-o "
1827 "compat6\' instead!");
1828 ret = -1;
1829 goto fail_getopt;
1830 case 'o':
1831 if (!is_valid_option_list(optarg)) {
1832 error_report("Invalid option list: %s", optarg);
1833 ret = -1;
1834 goto fail_getopt;
1835 }
1836 if (!options) {
1837 options = g_strdup(optarg);
1838 } else {
1839 char *old_options = options;
1840 options = g_strdup_printf("%s,%s", options, optarg);
1841 g_free(old_options);
1842 }
1843 break;
1844 case 's':
1845 snapshot_name = optarg;
1846 break;
1847 case 'l':
1848 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1849 sn_opts = qemu_opts_parse_noisily(&internal_snapshot_opts,
1850 optarg, false);
1851 if (!sn_opts) {
1852 error_report("Failed in parsing snapshot param '%s'",
1853 optarg);
1854 ret = -1;
1855 goto fail_getopt;
1856 }
1857 } else {
1858 snapshot_name = optarg;
1859 }
1860 break;
1861 case 'S':
1862 {
1863 int64_t sval;
1864 char *end;
1865 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
1866 if (sval < 0 || *end) {
1867 error_report("Invalid minimum zero buffer size for sparse output specified");
1868 ret = -1;
1869 goto fail_getopt;
1870 }
1871
1872 min_sparse = sval / BDRV_SECTOR_SIZE;
1873 break;
1874 }
1875 case 'p':
1876 progress = 1;
1877 break;
1878 case 't':
1879 cache = optarg;
1880 break;
1881 case 'T':
1882 src_cache = optarg;
1883 break;
1884 case 'q':
1885 quiet = true;
1886 break;
1887 case 'n':
1888 skip_create = 1;
1889 break;
1890 case OPTION_OBJECT:
1891 opts = qemu_opts_parse_noisily(&qemu_object_opts,
1892 optarg, true);
1893 if (!opts) {
1894 goto fail_getopt;
1895 }
1896 break;
1897 case OPTION_IMAGE_OPTS:
1898 image_opts = true;
1899 break;
1900 }
1901 }
1902
1903 if (qemu_opts_foreach(&qemu_object_opts,
1904 user_creatable_add_opts_foreach,
1905 NULL, NULL)) {
1906 goto fail_getopt;
1907 }
1908
1909 /* Initialize before goto out */
1910 if (quiet) {
1911 progress = 0;
1912 }
1913 qemu_progress_init(progress, 1.0);
1914
1915 bs_n = argc - optind - 1;
1916 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1917
1918 if (options && has_help_option(options)) {
1919 ret = print_block_option_help(out_filename, out_fmt);
1920 goto out;
1921 }
1922
1923 if (bs_n < 1) {
1924 error_exit("Must specify image file name");
1925 }
1926
1927
1928 if (bs_n > 1 && out_baseimg) {
1929 error_report("-B makes no sense when concatenating multiple input "
1930 "images");
1931 ret = -1;
1932 goto out;
1933 }
1934
1935 src_flags = 0;
1936 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
1937 if (ret < 0) {
1938 error_report("Invalid source cache option: %s", src_cache);
1939 goto out;
1940 }
1941
1942 qemu_progress_print(0, 100);
1943
1944 blk = g_new0(BlockBackend *, bs_n);
1945 bs = g_new0(BlockDriverState *, bs_n);
1946 bs_sectors = g_new(int64_t, bs_n);
1947
1948 total_sectors = 0;
1949 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1950 blk[bs_i] = img_open(image_opts, argv[optind + bs_i],
1951 fmt, src_flags, src_writethrough, quiet);
1952 if (!blk[bs_i]) {
1953 ret = -1;
1954 goto out;
1955 }
1956 bs[bs_i] = blk_bs(blk[bs_i]);
1957 bs_sectors[bs_i] = blk_nb_sectors(blk[bs_i]);
1958 if (bs_sectors[bs_i] < 0) {
1959 error_report("Could not get size of %s: %s",
1960 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1961 ret = -1;
1962 goto out;
1963 }
1964 total_sectors += bs_sectors[bs_i];
1965 }
1966
1967 if (sn_opts) {
1968 ret = bdrv_snapshot_load_tmp(bs[0],
1969 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1970 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1971 &local_err);
1972 } else if (snapshot_name != NULL) {
1973 if (bs_n > 1) {
1974 error_report("No support for concatenating multiple snapshot");
1975 ret = -1;
1976 goto out;
1977 }
1978
1979 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1980 }
1981 if (local_err) {
1982 error_reportf_err(local_err, "Failed to load snapshot: ");
1983 ret = -1;
1984 goto out;
1985 }
1986
1987 /* Find driver and parse its options */
1988 drv = bdrv_find_format(out_fmt);
1989 if (!drv) {
1990 error_report("Unknown file format '%s'", out_fmt);
1991 ret = -1;
1992 goto out;
1993 }
1994
1995 proto_drv = bdrv_find_protocol(out_filename, true, &local_err);
1996 if (!proto_drv) {
1997 error_report_err(local_err);
1998 ret = -1;
1999 goto out;
2000 }
2001
2002 if (!skip_create) {
2003 if (!drv->create_opts) {
2004 error_report("Format driver '%s' does not support image creation",
2005 drv->format_name);
2006 ret = -1;
2007 goto out;
2008 }
2009
2010 if (!proto_drv->create_opts) {
2011 error_report("Protocol driver '%s' does not support image creation",
2012 proto_drv->format_name);
2013 ret = -1;
2014 goto out;
2015 }
2016
2017 create_opts = qemu_opts_append(create_opts, drv->create_opts);
2018 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
2019
2020 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2021 if (options) {
2022 qemu_opts_do_parse(opts, options, NULL, &local_err);
2023 if (local_err) {
2024 error_report_err(local_err);
2025 ret = -1;
2026 goto out;
2027 }
2028 }
2029
2030 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512,
2031 &error_abort);
2032 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
2033 if (ret < 0) {
2034 goto out;
2035 }
2036 }
2037
2038 /* Get backing file name if -o backing_file was used */
2039 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
2040 if (out_baseimg_param) {
2041 out_baseimg = out_baseimg_param;
2042 }
2043
2044 /* Check if compression is supported */
2045 if (compress) {
2046 bool encryption =
2047 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
2048 const char *preallocation =
2049 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
2050
2051 if (!drv->bdrv_co_pwritev_compressed) {
2052 error_report("Compression not supported for this file format");
2053 ret = -1;
2054 goto out;
2055 }
2056
2057 if (encryption) {
2058 error_report("Compression and encryption not supported at "
2059 "the same time");
2060 ret = -1;
2061 goto out;
2062 }
2063
2064 if (preallocation
2065 && strcmp(preallocation, "off"))
2066 {
2067 error_report("Compression and preallocation not supported at "
2068 "the same time");
2069 ret = -1;
2070 goto out;
2071 }
2072 }
2073
2074 if (!skip_create) {
2075 /* Create the new image */
2076 ret = bdrv_create(drv, out_filename, opts, &local_err);
2077 if (ret < 0) {
2078 error_reportf_err(local_err, "%s: error while converting %s: ",
2079 out_filename, out_fmt);
2080 goto out;
2081 }
2082 }
2083
2084 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
2085 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2086 if (ret < 0) {
2087 error_report("Invalid cache option: %s", cache);
2088 goto out;
2089 }
2090
2091 /* XXX we should allow --image-opts to trigger use of
2092 * img_open() here, but then we have trouble with
2093 * the bdrv_create() call which takes different params.
2094 * Not critical right now, so fix can wait...
2095 */
2096 out_blk = img_open_file(out_filename, out_fmt, flags, writethrough, quiet);
2097 if (!out_blk) {
2098 ret = -1;
2099 goto out;
2100 }
2101 out_bs = blk_bs(out_blk);
2102
2103 /* increase bufsectors from the default 4096 (2M) if opt_transfer
2104 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
2105 * as maximum. */
2106 bufsectors = MIN(32768,
2107 MAX(bufsectors,
2108 MAX(out_bs->bl.opt_transfer >> BDRV_SECTOR_BITS,
2109 out_bs->bl.pdiscard_alignment >>
2110 BDRV_SECTOR_BITS)));
2111
2112 if (skip_create) {
2113 int64_t output_sectors = blk_nb_sectors(out_blk);
2114 if (output_sectors < 0) {
2115 error_report("unable to get output image length: %s",
2116 strerror(-output_sectors));
2117 ret = -1;
2118 goto out;
2119 } else if (output_sectors < total_sectors) {
2120 error_report("output file is smaller than input file");
2121 ret = -1;
2122 goto out;
2123 }
2124 }
2125
2126 cluster_sectors = 0;
2127 ret = bdrv_get_info(out_bs, &bdi);
2128 if (ret < 0) {
2129 if (compress) {
2130 error_report("could not get block driver info");
2131 goto out;
2132 }
2133 } else {
2134 compress = compress || bdi.needs_compressed_writes;
2135 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
2136 }
2137
2138 state = (ImgConvertState) {
2139 .src = blk,
2140 .src_sectors = bs_sectors,
2141 .src_num = bs_n,
2142 .total_sectors = total_sectors,
2143 .target = out_blk,
2144 .compressed = compress,
2145 .target_has_backing = (bool) out_baseimg,
2146 .min_sparse = min_sparse,
2147 .cluster_sectors = cluster_sectors,
2148 .buf_sectors = bufsectors,
2149 };
2150 ret = convert_do_copy(&state);
2151
2152 out:
2153 if (!ret) {
2154 qemu_progress_print(100, 0);
2155 }
2156 qemu_progress_end();
2157 qemu_opts_del(opts);
2158 qemu_opts_free(create_opts);
2159 qemu_opts_del(sn_opts);
2160 blk_unref(out_blk);
2161 g_free(bs);
2162 if (blk) {
2163 for (bs_i = 0; bs_i < bs_n; bs_i++) {
2164 blk_unref(blk[bs_i]);
2165 }
2166 g_free(blk);
2167 }
2168 g_free(bs_sectors);
2169 fail_getopt:
2170 g_free(options);
2171
2172 if (ret) {
2173 return 1;
2174 }
2175 return 0;
2176 }
2177
2178
2179 static void dump_snapshots(BlockDriverState *bs)
2180 {
2181 QEMUSnapshotInfo *sn_tab, *sn;
2182 int nb_sns, i;
2183
2184 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
2185 if (nb_sns <= 0)
2186 return;
2187 printf("Snapshot list:\n");
2188 bdrv_snapshot_dump(fprintf, stdout, NULL);
2189 printf("\n");
2190 for(i = 0; i < nb_sns; i++) {
2191 sn = &sn_tab[i];
2192 bdrv_snapshot_dump(fprintf, stdout, sn);
2193 printf("\n");
2194 }
2195 g_free(sn_tab);
2196 }
2197
2198 static void dump_json_image_info_list(ImageInfoList *list)
2199 {
2200 QString *str;
2201 QObject *obj;
2202 Visitor *v = qobject_output_visitor_new(&obj);
2203
2204 visit_type_ImageInfoList(v, NULL, &list, &error_abort);
2205 visit_complete(v, &obj);
2206 str = qobject_to_json_pretty(obj);
2207 assert(str != NULL);
2208 printf("%s\n", qstring_get_str(str));
2209 qobject_decref(obj);
2210 visit_free(v);
2211 QDECREF(str);
2212 }
2213
2214 static void dump_json_image_info(ImageInfo *info)
2215 {
2216 QString *str;
2217 QObject *obj;
2218 Visitor *v = qobject_output_visitor_new(&obj);
2219
2220 visit_type_ImageInfo(v, NULL, &info, &error_abort);
2221 visit_complete(v, &obj);
2222 str = qobject_to_json_pretty(obj);
2223 assert(str != NULL);
2224 printf("%s\n", qstring_get_str(str));
2225 qobject_decref(obj);
2226 visit_free(v);
2227 QDECREF(str);
2228 }
2229
2230 static void dump_human_image_info_list(ImageInfoList *list)
2231 {
2232 ImageInfoList *elem;
2233 bool delim = false;
2234
2235 for (elem = list; elem; elem = elem->next) {
2236 if (delim) {
2237 printf("\n");
2238 }
2239 delim = true;
2240
2241 bdrv_image_info_dump(fprintf, stdout, elem->value);
2242 }
2243 }
2244
2245 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
2246 {
2247 return strcmp(a, b) == 0;
2248 }
2249
2250 /**
2251 * Open an image file chain and return an ImageInfoList
2252 *
2253 * @filename: topmost image filename
2254 * @fmt: topmost image format (may be NULL to autodetect)
2255 * @chain: true - enumerate entire backing file chain
2256 * false - only topmost image file
2257 *
2258 * Returns a list of ImageInfo objects or NULL if there was an error opening an
2259 * image file. If there was an error a message will have been printed to
2260 * stderr.
2261 */
2262 static ImageInfoList *collect_image_info_list(bool image_opts,
2263 const char *filename,
2264 const char *fmt,
2265 bool chain)
2266 {
2267 ImageInfoList *head = NULL;
2268 ImageInfoList **last = &head;
2269 GHashTable *filenames;
2270 Error *err = NULL;
2271
2272 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
2273
2274 while (filename) {
2275 BlockBackend *blk;
2276 BlockDriverState *bs;
2277 ImageInfo *info;
2278 ImageInfoList *elem;
2279
2280 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
2281 error_report("Backing file '%s' creates an infinite loop.",
2282 filename);
2283 goto err;
2284 }
2285 g_hash_table_insert(filenames, (gpointer)filename, NULL);
2286
2287 blk = img_open(image_opts, filename, fmt,
2288 BDRV_O_NO_BACKING | BDRV_O_NO_IO, false, false);
2289 if (!blk) {
2290 goto err;
2291 }
2292 bs = blk_bs(blk);
2293
2294 bdrv_query_image_info(bs, &info, &err);
2295 if (err) {
2296 error_report_err(err);
2297 blk_unref(blk);
2298 goto err;
2299 }
2300
2301 elem = g_new0(ImageInfoList, 1);
2302 elem->value = info;
2303 *last = elem;
2304 last = &elem->next;
2305
2306 blk_unref(blk);
2307
2308 filename = fmt = NULL;
2309 if (chain) {
2310 if (info->has_full_backing_filename) {
2311 filename = info->full_backing_filename;
2312 } else if (info->has_backing_filename) {
2313 error_report("Could not determine absolute backing filename,"
2314 " but backing filename '%s' present",
2315 info->backing_filename);
2316 goto err;
2317 }
2318 if (info->has_backing_filename_format) {
2319 fmt = info->backing_filename_format;
2320 }
2321 }
2322 }
2323 g_hash_table_destroy(filenames);
2324 return head;
2325
2326 err:
2327 qapi_free_ImageInfoList(head);
2328 g_hash_table_destroy(filenames);
2329 return NULL;
2330 }
2331
2332 static int img_info(int argc, char **argv)
2333 {
2334 int c;
2335 OutputFormat output_format = OFORMAT_HUMAN;
2336 bool chain = false;
2337 const char *filename, *fmt, *output;
2338 ImageInfoList *list;
2339 bool image_opts = false;
2340
2341 fmt = NULL;
2342 output = NULL;
2343 for(;;) {
2344 int option_index = 0;
2345 static const struct option long_options[] = {
2346 {"help", no_argument, 0, 'h'},
2347 {"format", required_argument, 0, 'f'},
2348 {"output", required_argument, 0, OPTION_OUTPUT},
2349 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
2350 {"object", required_argument, 0, OPTION_OBJECT},
2351 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2352 {0, 0, 0, 0}
2353 };
2354 c = getopt_long(argc, argv, "f:h",
2355 long_options, &option_index);
2356 if (c == -1) {
2357 break;
2358 }
2359 switch(c) {
2360 case '?':
2361 case 'h':
2362 help();
2363 break;
2364 case 'f':
2365 fmt = optarg;
2366 break;
2367 case OPTION_OUTPUT:
2368 output = optarg;
2369 break;
2370 case OPTION_BACKING_CHAIN:
2371 chain = true;
2372 break;
2373 case OPTION_OBJECT: {
2374 QemuOpts *opts;
2375 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2376 optarg, true);
2377 if (!opts) {
2378 return 1;
2379 }
2380 } break;
2381 case OPTION_IMAGE_OPTS:
2382 image_opts = true;
2383 break;
2384 }
2385 }
2386 if (optind != argc - 1) {
2387 error_exit("Expecting one image file name");
2388 }
2389 filename = argv[optind++];
2390
2391 if (output && !strcmp(output, "json")) {
2392 output_format = OFORMAT_JSON;
2393 } else if (output && !strcmp(output, "human")) {
2394 output_format = OFORMAT_HUMAN;
2395 } else if (output) {
2396 error_report("--output must be used with human or json as argument.");
2397 return 1;
2398 }
2399
2400 if (qemu_opts_foreach(&qemu_object_opts,
2401 user_creatable_add_opts_foreach,
2402 NULL, NULL)) {
2403 return 1;
2404 }
2405
2406 list = collect_image_info_list(image_opts, filename, fmt, chain);
2407 if (!list) {
2408 return 1;
2409 }
2410
2411 switch (output_format) {
2412 case OFORMAT_HUMAN:
2413 dump_human_image_info_list(list);
2414 break;
2415 case OFORMAT_JSON:
2416 if (chain) {
2417 dump_json_image_info_list(list);
2418 } else {
2419 dump_json_image_info(list->value);
2420 }
2421 break;
2422 }
2423
2424 qapi_free_ImageInfoList(list);
2425 return 0;
2426 }
2427
2428 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
2429 MapEntry *next)
2430 {
2431 switch (output_format) {
2432 case OFORMAT_HUMAN:
2433 if (e->data && !e->has_offset) {
2434 error_report("File contains external, encrypted or compressed clusters.");
2435 exit(1);
2436 }
2437 if (e->data && !e->zero) {
2438 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
2439 e->start, e->length,
2440 e->has_offset ? e->offset : 0,
2441 e->has_filename ? e->filename : "");
2442 }
2443 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
2444 * Modify the flags here to allow more coalescing.
2445 */
2446 if (next && (!next->data || next->zero)) {
2447 next->data = false;
2448 next->zero = true;
2449 }
2450 break;
2451 case OFORMAT_JSON:
2452 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64","
2453 " \"depth\": %"PRId64", \"zero\": %s, \"data\": %s",
2454 (e->start == 0 ? "[" : ",\n"),
2455 e->start, e->length, e->depth,
2456 e->zero ? "true" : "false",
2457 e->data ? "true" : "false");
2458 if (e->has_offset) {
2459 printf(", \"offset\": %"PRId64"", e->offset);
2460 }
2461 putchar('}');
2462
2463 if (!next) {
2464 printf("]\n");
2465 }
2466 break;
2467 }
2468 }
2469
2470 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2471 int nb_sectors, MapEntry *e)
2472 {
2473 int64_t ret;
2474 int depth;
2475 BlockDriverState *file;
2476 bool has_offset;
2477
2478 /* As an optimization, we could cache the current range of unallocated
2479 * clusters in each file of the chain, and avoid querying the same
2480 * range repeatedly.
2481 */
2482
2483 depth = 0;
2484 for (;;) {
2485 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors,
2486 &file);
2487 if (ret < 0) {
2488 return ret;
2489 }
2490 assert(nb_sectors);
2491 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2492 break;
2493 }
2494 bs = backing_bs(bs);
2495 if (bs == NULL) {
2496 ret = 0;
2497 break;
2498 }
2499
2500 depth++;
2501 }
2502
2503 has_offset = !!(ret & BDRV_BLOCK_OFFSET_VALID);
2504
2505 *e = (MapEntry) {
2506 .start = sector_num * BDRV_SECTOR_SIZE,
2507 .length = nb_sectors * BDRV_SECTOR_SIZE,
2508 .data = !!(ret & BDRV_BLOCK_DATA),
2509 .zero = !!(ret & BDRV_BLOCK_ZERO),
2510 .offset = ret & BDRV_BLOCK_OFFSET_MASK,
2511 .has_offset = has_offset,
2512 .depth = depth,
2513 .has_filename = file && has_offset,
2514 .filename = file && has_offset ? file->filename : NULL,
2515 };
2516
2517 return 0;
2518 }
2519
2520 static inline bool entry_mergeable(const MapEntry *curr, const MapEntry *next)
2521 {
2522 if (curr->length == 0) {
2523 return false;
2524 }
2525 if (curr->zero != next->zero ||
2526 curr->data != next->data ||
2527 curr->depth != next->depth ||
2528 curr->has_filename != next->has_filename ||
2529 curr->has_offset != next->has_offset) {
2530 return false;
2531 }
2532 if (curr->has_filename && strcmp(curr->filename, next->filename)) {
2533 return false;
2534 }
2535 if (curr->has_offset && curr->offset + curr->length != next->offset) {
2536 return false;
2537 }
2538 return true;
2539 }
2540
2541 static int img_map(int argc, char **argv)
2542 {
2543 int c;
2544 OutputFormat output_format = OFORMAT_HUMAN;
2545 BlockBackend *blk;
2546 BlockDriverState *bs;
2547 const char *filename, *fmt, *output;
2548 int64_t length;
2549 MapEntry curr = { .length = 0 }, next;
2550 int ret = 0;
2551 bool image_opts = false;
2552
2553 fmt = NULL;
2554 output = NULL;
2555 for (;;) {
2556 int option_index = 0;
2557 static const struct option long_options[] = {
2558 {"help", no_argument, 0, 'h'},
2559 {"format", required_argument, 0, 'f'},
2560 {"output", required_argument, 0, OPTION_OUTPUT},
2561 {"object", required_argument, 0, OPTION_OBJECT},
2562 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2563 {0, 0, 0, 0}
2564 };
2565 c = getopt_long(argc, argv, "f:h",
2566 long_options, &option_index);
2567 if (c == -1) {
2568 break;
2569 }
2570 switch (c) {
2571 case '?':
2572 case 'h':
2573 help();
2574 break;
2575 case 'f':
2576 fmt = optarg;
2577 break;
2578 case OPTION_OUTPUT:
2579 output = optarg;
2580 break;
2581 case OPTION_OBJECT: {
2582 QemuOpts *opts;
2583 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2584 optarg, true);
2585 if (!opts) {
2586 return 1;
2587 }
2588 } break;
2589 case OPTION_IMAGE_OPTS:
2590 image_opts = true;
2591 break;
2592 }
2593 }
2594 if (optind != argc - 1) {
2595 error_exit("Expecting one image file name");
2596 }
2597 filename = argv[optind];
2598
2599 if (output && !strcmp(output, "json")) {
2600 output_format = OFORMAT_JSON;
2601 } else if (output && !strcmp(output, "human")) {
2602 output_format = OFORMAT_HUMAN;
2603 } else if (output) {
2604 error_report("--output must be used with human or json as argument.");
2605 return 1;
2606 }
2607
2608 if (qemu_opts_foreach(&qemu_object_opts,
2609 user_creatable_add_opts_foreach,
2610 NULL, NULL)) {
2611 return 1;
2612 }
2613
2614 blk = img_open(image_opts, filename, fmt, 0, false, false);
2615 if (!blk) {
2616 return 1;
2617 }
2618 bs = blk_bs(blk);
2619
2620 if (output_format == OFORMAT_HUMAN) {
2621 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2622 }
2623
2624 length = blk_getlength(blk);
2625 while (curr.start + curr.length < length) {
2626 int64_t nsectors_left;
2627 int64_t sector_num;
2628 int n;
2629
2630 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2631
2632 /* Probe up to 1 GiB at a time. */
2633 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2634 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2635 ret = get_block_status(bs, sector_num, n, &next);
2636
2637 if (ret < 0) {
2638 error_report("Could not read file metadata: %s", strerror(-ret));
2639 goto out;
2640 }
2641
2642 if (entry_mergeable(&curr, &next)) {
2643 curr.length += next.length;
2644 continue;
2645 }
2646
2647 if (curr.length > 0) {
2648 dump_map_entry(output_format, &curr, &next);
2649 }
2650 curr = next;
2651 }
2652
2653 dump_map_entry(output_format, &curr, NULL);
2654
2655 out:
2656 blk_unref(blk);
2657 return ret < 0;
2658 }
2659
2660 #define SNAPSHOT_LIST 1
2661 #define SNAPSHOT_CREATE 2
2662 #define SNAPSHOT_APPLY 3
2663 #define SNAPSHOT_DELETE 4
2664
2665 static int img_snapshot(int argc, char **argv)
2666 {
2667 BlockBackend *blk;
2668 BlockDriverState *bs;
2669 QEMUSnapshotInfo sn;
2670 char *filename, *snapshot_name = NULL;
2671 int c, ret = 0, bdrv_oflags;
2672 int action = 0;
2673 qemu_timeval tv;
2674 bool quiet = false;
2675 Error *err = NULL;
2676 bool image_opts = false;
2677
2678 bdrv_oflags = BDRV_O_RDWR;
2679 /* Parse commandline parameters */
2680 for(;;) {
2681 static const struct option long_options[] = {
2682 {"help", no_argument, 0, 'h'},
2683 {"object", required_argument, 0, OPTION_OBJECT},
2684 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2685 {0, 0, 0, 0}
2686 };
2687 c = getopt_long(argc, argv, "la:c:d:hq",
2688 long_options, NULL);
2689 if (c == -1) {
2690 break;
2691 }
2692 switch(c) {
2693 case '?':
2694 case 'h':
2695 help();
2696 return 0;
2697 case 'l':
2698 if (action) {
2699 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2700 return 0;
2701 }
2702 action = SNAPSHOT_LIST;
2703 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2704 break;
2705 case 'a':
2706 if (action) {
2707 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2708 return 0;
2709 }
2710 action = SNAPSHOT_APPLY;
2711 snapshot_name = optarg;
2712 break;
2713 case 'c':
2714 if (action) {
2715 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2716 return 0;
2717 }
2718 action = SNAPSHOT_CREATE;
2719 snapshot_name = optarg;
2720 break;
2721 case 'd':
2722 if (action) {
2723 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2724 return 0;
2725 }
2726 action = SNAPSHOT_DELETE;
2727 snapshot_name = optarg;
2728 break;
2729 case 'q':
2730 quiet = true;
2731 break;
2732 case OPTION_OBJECT: {
2733 QemuOpts *opts;
2734 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2735 optarg, true);
2736 if (!opts) {
2737 return 1;
2738 }
2739 } break;
2740 case OPTION_IMAGE_OPTS:
2741 image_opts = true;
2742 break;
2743 }
2744 }
2745
2746 if (optind != argc - 1) {
2747 error_exit("Expecting one image file name");
2748 }
2749 filename = argv[optind++];
2750
2751 if (qemu_opts_foreach(&qemu_object_opts,
2752 user_creatable_add_opts_foreach,
2753 NULL, NULL)) {
2754 return 1;
2755 }
2756
2757 /* Open the image */
2758 blk = img_open(image_opts, filename, NULL, bdrv_oflags, false, quiet);
2759 if (!blk) {
2760 return 1;
2761 }
2762 bs = blk_bs(blk);
2763
2764 /* Perform the requested action */
2765 switch(action) {
2766 case SNAPSHOT_LIST:
2767 dump_snapshots(bs);
2768 break;
2769
2770 case SNAPSHOT_CREATE:
2771 memset(&sn, 0, sizeof(sn));
2772 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2773
2774 qemu_gettimeofday(&tv);
2775 sn.date_sec = tv.tv_sec;
2776 sn.date_nsec = tv.tv_usec * 1000;
2777
2778 ret = bdrv_snapshot_create(bs, &sn);
2779 if (ret) {
2780 error_report("Could not create snapshot '%s': %d (%s)",
2781 snapshot_name, ret, strerror(-ret));
2782 }
2783 break;
2784
2785 case SNAPSHOT_APPLY:
2786 ret = bdrv_snapshot_goto(bs, snapshot_name);
2787 if (ret) {
2788 error_report("Could not apply snapshot '%s': %d (%s)",
2789 snapshot_name, ret, strerror(-ret));
2790 }
2791 break;
2792
2793 case SNAPSHOT_DELETE:
2794 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2795 if (err) {
2796 error_reportf_err(err, "Could not delete snapshot '%s': ",
2797 snapshot_name);
2798 ret = 1;
2799 }
2800 break;
2801 }
2802
2803 /* Cleanup */
2804 blk_unref(blk);
2805 if (ret) {
2806 return 1;
2807 }
2808 return 0;
2809 }
2810
2811 static int img_rebase(int argc, char **argv)
2812 {
2813 BlockBackend *blk = NULL, *blk_old_backing = NULL, *blk_new_backing = NULL;
2814 uint8_t *buf_old = NULL;
2815 uint8_t *buf_new = NULL;
2816 BlockDriverState *bs = NULL;
2817 char *filename;
2818 const char *fmt, *cache, *src_cache, *out_basefmt, *out_baseimg;
2819 int c, flags, src_flags, ret;
2820 bool writethrough, src_writethrough;
2821 int unsafe = 0;
2822 int progress = 0;
2823 bool quiet = false;
2824 Error *local_err = NULL;
2825 bool image_opts = false;
2826
2827 /* Parse commandline parameters */
2828 fmt = NULL;
2829 cache = BDRV_DEFAULT_CACHE;
2830 src_cache = BDRV_DEFAULT_CACHE;
2831 out_baseimg = NULL;
2832 out_basefmt = NULL;
2833 for(;;) {
2834 static const struct option long_options[] = {
2835 {"help", no_argument, 0, 'h'},
2836 {"object", required_argument, 0, OPTION_OBJECT},
2837 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
2838 {0, 0, 0, 0}
2839 };
2840 c = getopt_long(argc, argv, "hf:F:b:upt:T:q",
2841 long_options, NULL);
2842 if (c == -1) {
2843 break;
2844 }
2845 switch(c) {
2846 case '?':
2847 case 'h':
2848 help();
2849 return 0;
2850 case 'f':
2851 fmt = optarg;
2852 break;
2853 case 'F':
2854 out_basefmt = optarg;
2855 break;
2856 case 'b':
2857 out_baseimg = optarg;
2858 break;
2859 case 'u':
2860 unsafe = 1;
2861 break;
2862 case 'p':
2863 progress = 1;
2864 break;
2865 case 't':
2866 cache = optarg;
2867 break;
2868 case 'T':
2869 src_cache = optarg;
2870 break;
2871 case 'q':
2872 quiet = true;
2873 break;
2874 case OPTION_OBJECT: {
2875 QemuOpts *opts;
2876 opts = qemu_opts_parse_noisily(&qemu_object_opts,
2877 optarg, true);
2878 if (!opts) {
2879 return 1;
2880 }
2881 } break;
2882 case OPTION_IMAGE_OPTS:
2883 image_opts = true;
2884 break;
2885 }
2886 }
2887
2888 if (quiet) {
2889 progress = 0;
2890 }
2891
2892 if (optind != argc - 1) {
2893 error_exit("Expecting one image file name");
2894 }
2895 if (!unsafe && !out_baseimg) {
2896 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2897 }
2898 filename = argv[optind++];
2899
2900 if (qemu_opts_foreach(&qemu_object_opts,
2901 user_creatable_add_opts_foreach,
2902 NULL, NULL)) {
2903 return 1;
2904 }
2905
2906 qemu_progress_init(progress, 2.0);
2907 qemu_progress_print(0, 100);
2908
2909 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2910 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
2911 if (ret < 0) {
2912 error_report("Invalid cache option: %s", cache);
2913 goto out;
2914 }
2915
2916 src_flags = 0;
2917 ret = bdrv_parse_cache_mode(src_cache, &src_flags, &src_writethrough);
2918 if (ret < 0) {
2919 error_report("Invalid source cache option: %s", src_cache);
2920 goto out;
2921 }
2922
2923 /* The source files are opened read-only, don't care about WCE */
2924 assert((src_flags & BDRV_O_RDWR) == 0);
2925 (void) src_writethrough;
2926
2927 /*
2928 * Open the images.
2929 *
2930 * Ignore the old backing file for unsafe rebase in case we want to correct
2931 * the reference to a renamed or moved backing file.
2932 */
2933 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
2934 if (!blk) {
2935 ret = -1;
2936 goto out;
2937 }
2938 bs = blk_bs(blk);
2939
2940 if (out_basefmt != NULL) {
2941 if (bdrv_find_format(out_basefmt) == NULL) {
2942 error_report("Invalid format name: '%s'", out_basefmt);
2943 ret = -1;
2944 goto out;
2945 }
2946 }
2947
2948 /* For safe rebasing we need to compare old and new backing file */
2949 if (!unsafe) {
2950 char backing_name[PATH_MAX];
2951 QDict *options = NULL;
2952
2953 if (bs->backing_format[0] != '\0') {
2954 options = qdict_new();
2955 qdict_put(options, "driver", qstring_from_str(bs->backing_format));
2956 }
2957
2958 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2959 blk_old_backing = blk_new_open(backing_name, NULL,
2960 options, src_flags, &local_err);
2961 if (!blk_old_backing) {
2962 error_reportf_err(local_err,
2963 "Could not open old backing file '%s': ",
2964 backing_name);
2965 ret = -1;
2966 goto out;
2967 }
2968
2969 if (out_baseimg[0]) {
2970 if (out_basefmt) {
2971 options = qdict_new();
2972 qdict_put(options, "driver", qstring_from_str(out_basefmt));
2973 } else {
2974 options = NULL;
2975 }
2976
2977 blk_new_backing = blk_new_open(out_baseimg, NULL,
2978 options, src_flags, &local_err);
2979 if (!blk_new_backing) {
2980 error_reportf_err(local_err,
2981 "Could not open new backing file '%s': ",
2982 out_baseimg);
2983 ret = -1;
2984 goto out;
2985 }
2986 }
2987 }
2988
2989 /*
2990 * Check each unallocated cluster in the COW file. If it is unallocated,
2991 * accesses go to the backing file. We must therefore compare this cluster
2992 * in the old and new backing file, and if they differ we need to copy it
2993 * from the old backing file into the COW file.
2994 *
2995 * If qemu-img crashes during this step, no harm is done. The content of
2996 * the image is the same as the original one at any time.
2997 */
2998 if (!unsafe) {
2999 int64_t num_sectors;
3000 int64_t old_backing_num_sectors;
3001 int64_t new_backing_num_sectors = 0;
3002 uint64_t sector;
3003 int n;
3004 float local_progress = 0;
3005
3006 buf_old = blk_blockalign(blk, IO_BUF_SIZE);
3007 buf_new = blk_blockalign(blk, IO_BUF_SIZE);
3008
3009 num_sectors = blk_nb_sectors(blk);
3010 if (num_sectors < 0) {
3011 error_report("Could not get size of '%s': %s",
3012 filename, strerror(-num_sectors));
3013 ret = -1;
3014 goto out;
3015 }
3016 old_backing_num_sectors = blk_nb_sectors(blk_old_backing);
3017 if (old_backing_num_sectors < 0) {
3018 char backing_name[PATH_MAX];
3019
3020 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
3021 error_report("Could not get size of '%s': %s",
3022 backing_name, strerror(-old_backing_num_sectors));
3023 ret = -1;
3024 goto out;
3025 }
3026 if (blk_new_backing) {
3027 new_backing_num_sectors = blk_nb_sectors(blk_new_backing);
3028 if (new_backing_num_sectors < 0) {
3029 error_report("Could not get size of '%s': %s",
3030 out_baseimg, strerror(-new_backing_num_sectors));
3031 ret = -1;
3032 goto out;
3033 }
3034 }
3035
3036 if (num_sectors != 0) {
3037 local_progress = (float)100 /
3038 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
3039 }
3040
3041 for (sector = 0; sector < num_sectors; sector += n) {
3042
3043 /* How many sectors can we handle with the next read? */
3044 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
3045 n = (IO_BUF_SIZE / 512);
3046 } else {
3047 n = num_sectors - sector;
3048 }
3049
3050 /* If the cluster is allocated, we don't need to take action */
3051 ret = bdrv_is_allocated(bs, sector, n, &n);
3052 if (ret < 0) {
3053 error_report("error while reading image metadata: %s",
3054 strerror(-ret));
3055 goto out;
3056 }
3057 if (ret) {
3058 continue;
3059 }
3060
3061 /*
3062 * Read old and new backing file and take into consideration that
3063 * backing files may be smaller than the COW image.
3064 */
3065 if (sector >= old_backing_num_sectors) {
3066 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
3067 } else {
3068 if (sector + n > old_backing_num_sectors) {
3069 n = old_backing_num_sectors - sector;
3070 }
3071
3072 ret = blk_pread(blk_old_backing, sector << BDRV_SECTOR_BITS,
3073 buf_old, n << BDRV_SECTOR_BITS);
3074 if (ret < 0) {
3075 error_report("error while reading from old backing file");
3076 goto out;
3077 }
3078 }
3079
3080 if (sector >= new_backing_num_sectors || !blk_new_backing) {
3081 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
3082 } else {
3083 if (sector + n > new_backing_num_sectors) {
3084 n = new_backing_num_sectors - sector;
3085 }
3086
3087 ret = blk_pread(blk_new_backing, sector << BDRV_SECTOR_BITS,
3088 buf_new, n << BDRV_SECTOR_BITS);
3089 if (ret < 0) {
3090 error_report("error while reading from new backing file");
3091 goto out;
3092 }
3093 }
3094
3095 /* If they differ, we need to write to the COW file */
3096 uint64_t written = 0;
3097
3098 while (written < n) {
3099 int pnum;
3100
3101 if (compare_sectors(buf_old + written * 512,
3102 buf_new + written * 512, n - written, &pnum))
3103 {
3104 ret = blk_pwrite(blk,
3105 (sector + written) << BDRV_SECTOR_BITS,
3106 buf_old + written * 512,
3107 pnum << BDRV_SECTOR_BITS, 0);
3108 if (ret < 0) {
3109 error_report("Error while writing to COW image: %s",
3110 strerror(-ret));
3111 goto out;
3112 }
3113 }
3114
3115 written += pnum;
3116 }
3117 qemu_progress_print(local_progress, 100);
3118 }
3119 }
3120
3121 /*
3122 * Change the backing file. All clusters that are different from the old
3123 * backing file are overwritten in the COW file now, so the visible content
3124 * doesn't change when we switch the backing file.
3125 */
3126 if (out_baseimg && *out_baseimg) {
3127 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
3128 } else {
3129 ret = bdrv_change_backing_file(bs, NULL, NULL);
3130 }
3131
3132 if (ret == -ENOSPC) {
3133 error_report("Could not change the backing file to '%s': No "
3134 "space left in the file header", out_baseimg);
3135 } else if (ret < 0) {
3136 error_report("Could not change the backing file to '%s': %s",
3137 out_baseimg, strerror(-ret));
3138 }
3139
3140 qemu_progress_print(100, 0);
3141 /*
3142 * TODO At this point it is possible to check if any clusters that are
3143 * allocated in the COW file are the same in the backing file. If so, they
3144 * could be dropped from the COW file. Don't do this before switching the
3145 * backing file, in case of a crash this would lead to corruption.
3146 */
3147 out:
3148 qemu_progress_end();
3149 /* Cleanup */
3150 if (!unsafe) {
3151 blk_unref(blk_old_backing);
3152 blk_unref(blk_new_backing);
3153 }
3154 qemu_vfree(buf_old);
3155 qemu_vfree(buf_new);
3156
3157 blk_unref(blk);
3158 if (ret) {
3159 return 1;
3160 }
3161 return 0;
3162 }
3163
3164 static int img_resize(int argc, char **argv)
3165 {
3166 Error *err = NULL;
3167 int c, ret, relative;
3168 const char *filename, *fmt, *size;
3169 int64_t n, total_size;
3170 bool quiet = false;
3171 BlockBackend *blk = NULL;
3172 QemuOpts *param;
3173
3174 static QemuOptsList resize_options = {
3175 .name = "resize_options",
3176 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
3177 .desc = {
3178 {
3179 .name = BLOCK_OPT_SIZE,
3180 .type = QEMU_OPT_SIZE,
3181 .help = "Virtual disk size"
3182 }, {
3183 /* end of list */
3184 }
3185 },
3186 };
3187 bool image_opts = false;
3188
3189 /* Remove size from argv manually so that negative numbers are not treated
3190 * as options by getopt. */
3191 if (argc < 3) {
3192 error_exit("Not enough arguments");
3193 return 1;
3194 }
3195
3196 size = argv[--argc];
3197
3198 /* Parse getopt arguments */
3199 fmt = NULL;
3200 for(;;) {
3201 static const struct option long_options[] = {
3202 {"help", no_argument, 0, 'h'},
3203 {"object", required_argument, 0, OPTION_OBJECT},
3204 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3205 {0, 0, 0, 0}
3206 };
3207 c = getopt_long(argc, argv, "f:hq",
3208 long_options, NULL);
3209 if (c == -1) {
3210 break;
3211 }
3212 switch(c) {
3213 case '?':
3214 case 'h':
3215 help();
3216 break;
3217 case 'f':
3218 fmt = optarg;
3219 break;
3220 case 'q':
3221 quiet = true;
3222 break;
3223 case OPTION_OBJECT: {
3224 QemuOpts *opts;
3225 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3226 optarg, true);
3227 if (!opts) {
3228 return 1;
3229 }
3230 } break;
3231 case OPTION_IMAGE_OPTS:
3232 image_opts = true;
3233 break;
3234 }
3235 }
3236 if (optind != argc - 1) {
3237 error_exit("Expecting one image file name");
3238 }
3239 filename = argv[optind++];
3240
3241 if (qemu_opts_foreach(&qemu_object_opts,
3242 user_creatable_add_opts_foreach,
3243 NULL, NULL)) {
3244 return 1;
3245 }
3246
3247 /* Choose grow, shrink, or absolute resize mode */
3248 switch (size[0]) {
3249 case '+':
3250 relative = 1;
3251 size++;
3252 break;
3253 case '-':
3254 relative = -1;
3255 size++;
3256 break;
3257 default:
3258 relative = 0;
3259 break;
3260 }
3261
3262 /* Parse size */
3263 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
3264 qemu_opt_set(param, BLOCK_OPT_SIZE, size, &err);
3265 if (err) {
3266 error_report_err(err);
3267 ret = -1;
3268 qemu_opts_del(param);
3269 goto out;
3270 }
3271 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
3272 qemu_opts_del(param);
3273
3274 blk = img_open(image_opts, filename, fmt,
3275 BDRV_O_RDWR, false, quiet);
3276 if (!blk) {
3277 ret = -1;
3278 goto out;
3279 }
3280
3281 if (relative) {
3282 total_size = blk_getlength(blk) + n * relative;
3283 } else {
3284 total_size = n;
3285 }
3286 if (total_size <= 0) {
3287 error_report("New image size must be positive");
3288 ret = -1;
3289 goto out;
3290 }
3291
3292 ret = blk_truncate(blk, total_size);
3293 switch (ret) {
3294 case 0:
3295 qprintf(quiet, "Image resized.\n");
3296 break;
3297 case -ENOTSUP:
3298 error_report("This image does not support resize");
3299 break;
3300 case -EACCES:
3301 error_report("Image is read-only");
3302 break;
3303 default:
3304 error_report("Error resizing image: %s", strerror(-ret));
3305 break;
3306 }
3307 out:
3308 blk_unref(blk);
3309 if (ret) {
3310 return 1;
3311 }
3312 return 0;
3313 }
3314
3315 static void amend_status_cb(BlockDriverState *bs,
3316 int64_t offset, int64_t total_work_size,
3317 void *opaque)
3318 {
3319 qemu_progress_print(100.f * offset / total_work_size, 0);
3320 }
3321
3322 static int img_amend(int argc, char **argv)
3323 {
3324 Error *err = NULL;
3325 int c, ret = 0;
3326 char *options = NULL;
3327 QemuOptsList *create_opts = NULL;
3328 QemuOpts *opts = NULL;
3329 const char *fmt = NULL, *filename, *cache;
3330 int flags;
3331 bool writethrough;
3332 bool quiet = false, progress = false;
3333 BlockBackend *blk = NULL;
3334 BlockDriverState *bs = NULL;
3335 bool image_opts = false;
3336
3337 cache = BDRV_DEFAULT_CACHE;
3338 for (;;) {
3339 static const struct option long_options[] = {
3340 {"help", no_argument, 0, 'h'},
3341 {"object", required_argument, 0, OPTION_OBJECT},
3342 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3343 {0, 0, 0, 0}
3344 };
3345 c = getopt_long(argc, argv, "ho:f:t:pq",
3346 long_options, NULL);
3347 if (c == -1) {
3348 break;
3349 }
3350
3351 switch (c) {
3352 case 'h':
3353 case '?':
3354 help();
3355 break;
3356 case 'o':
3357 if (!is_valid_option_list(optarg)) {
3358 error_report("Invalid option list: %s", optarg);
3359 ret = -1;
3360 goto out_no_progress;
3361 }
3362 if (!options) {
3363 options = g_strdup(optarg);
3364 } else {
3365 char *old_options = options;
3366 options = g_strdup_printf("%s,%s", options, optarg);
3367 g_free(old_options);
3368 }
3369 break;
3370 case 'f':
3371 fmt = optarg;
3372 break;
3373 case 't':
3374 cache = optarg;
3375 break;
3376 case 'p':
3377 progress = true;
3378 break;
3379 case 'q':
3380 quiet = true;
3381 break;
3382 case OPTION_OBJECT:
3383 opts = qemu_opts_parse_noisily(&qemu_object_opts,
3384 optarg, true);
3385 if (!opts) {
3386 ret = -1;
3387 goto out_no_progress;
3388 }
3389 break;
3390 case OPTION_IMAGE_OPTS:
3391 image_opts = true;
3392 break;
3393 }
3394 }
3395
3396 if (!options) {
3397 error_exit("Must specify options (-o)");
3398 }
3399
3400 if (qemu_opts_foreach(&qemu_object_opts,
3401 user_creatable_add_opts_foreach,
3402 NULL, NULL)) {
3403 ret = -1;
3404 goto out_no_progress;
3405 }
3406
3407 if (quiet) {
3408 progress = false;
3409 }
3410 qemu_progress_init(progress, 1.0);
3411
3412 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
3413 if (fmt && has_help_option(options)) {
3414 /* If a format is explicitly specified (and possibly no filename is
3415 * given), print option help here */
3416 ret = print_block_option_help(filename, fmt);
3417 goto out;
3418 }
3419
3420 if (optind != argc - 1) {
3421 error_report("Expecting one image file name");
3422 ret = -1;
3423 goto out;
3424 }
3425
3426 flags = BDRV_O_RDWR;
3427 ret = bdrv_parse_cache_mode(cache, &flags, &writethrough);
3428 if (ret < 0) {
3429 error_report("Invalid cache option: %s", cache);
3430 goto out;
3431 }
3432
3433 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3434 if (!blk) {
3435 ret = -1;
3436 goto out;
3437 }
3438 bs = blk_bs(blk);
3439
3440 fmt = bs->drv->format_name;
3441
3442 if (has_help_option(options)) {
3443 /* If the format was auto-detected, print option help here */
3444 ret = print_block_option_help(filename, fmt);
3445 goto out;
3446 }
3447
3448 if (!bs->drv->create_opts) {
3449 error_report("Format driver '%s' does not support any options to amend",
3450 fmt);
3451 ret = -1;
3452 goto out;
3453 }
3454
3455 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
3456 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
3457 if (options) {
3458 qemu_opts_do_parse(opts, options, NULL, &err);
3459 if (err) {
3460 error_report_err(err);
3461 ret = -1;
3462 goto out;
3463 }
3464 }
3465
3466 /* In case the driver does not call amend_status_cb() */
3467 qemu_progress_print(0.f, 0);
3468 ret = bdrv_amend_options(bs, opts, &amend_status_cb, NULL);
3469 qemu_progress_print(100.f, 0);
3470 if (ret < 0) {
3471 error_report("Error while amending options: %s", strerror(-ret));
3472 goto out;
3473 }
3474
3475 out:
3476 qemu_progress_end();
3477
3478 out_no_progress:
3479 blk_unref(blk);
3480 qemu_opts_del(opts);
3481 qemu_opts_free(create_opts);
3482 g_free(options);
3483
3484 if (ret) {
3485 return 1;
3486 }
3487 return 0;
3488 }
3489
3490 typedef struct BenchData {
3491 BlockBackend *blk;
3492 uint64_t image_size;
3493 bool write;
3494 int bufsize;
3495 int step;
3496 int nrreq;
3497 int n;
3498 int flush_interval;
3499 bool drain_on_flush;
3500 uint8_t *buf;
3501 QEMUIOVector *qiov;
3502
3503 int in_flight;
3504 bool in_flush;
3505 uint64_t offset;
3506 } BenchData;
3507
3508 static void bench_undrained_flush_cb(void *opaque, int ret)
3509 {
3510 if (ret < 0) {
3511 error_report("Failed flush request: %s", strerror(-ret));
3512 exit(EXIT_FAILURE);
3513 }
3514 }
3515
3516 static void bench_cb(void *opaque, int ret)
3517 {
3518 BenchData *b = opaque;
3519 BlockAIOCB *acb;
3520
3521 if (ret < 0) {
3522 error_report("Failed request: %s", strerror(-ret));
3523 exit(EXIT_FAILURE);
3524 }
3525
3526 if (b->in_flush) {
3527 /* Just finished a flush with drained queue: Start next requests */
3528 assert(b->in_flight == 0);
3529 b->in_flush = false;
3530 } else if (b->in_flight > 0) {
3531 int remaining = b->n - b->in_flight;
3532
3533 b->n--;
3534 b->in_flight--;
3535
3536 /* Time for flush? Drain queue if requested, then flush */
3537 if (b->flush_interval && remaining % b->flush_interval == 0) {
3538 if (!b->in_flight || !b->drain_on_flush) {
3539 BlockCompletionFunc *cb;
3540
3541 if (b->drain_on_flush) {
3542 b->in_flush = true;
3543 cb = bench_cb;
3544 } else {
3545 cb = bench_undrained_flush_cb;
3546 }
3547
3548 acb = blk_aio_flush(b->blk, cb, b);
3549 if (!acb) {
3550 error_report("Failed to issue flush request");
3551 exit(EXIT_FAILURE);
3552 }
3553 }
3554 if (b->drain_on_flush) {
3555 return;
3556 }
3557 }
3558 }
3559
3560 while (b->n > b->in_flight && b->in_flight < b->nrreq) {
3561 if (b->write) {
3562 acb = blk_aio_pwritev(b->blk, b->offset, b->qiov, 0,
3563 bench_cb, b);
3564 } else {
3565 acb = blk_aio_preadv(b->blk, b->offset, b->qiov, 0,
3566 bench_cb, b);
3567 }
3568 if (!acb) {
3569 error_report("Failed to issue request");
3570 exit(EXIT_FAILURE);
3571 }
3572 b->in_flight++;
3573 b->offset += b->step;
3574 b->offset %= b->image_size;
3575 }
3576 }
3577
3578 static int img_bench(int argc, char **argv)
3579 {
3580 int c, ret = 0;
3581 const char *fmt = NULL, *filename;
3582 bool quiet = false;
3583 bool image_opts = false;
3584 bool is_write = false;
3585 int count = 75000;
3586 int depth = 64;
3587 int64_t offset = 0;
3588 size_t bufsize = 4096;
3589 int pattern = 0;
3590 size_t step = 0;
3591 int flush_interval = 0;
3592 bool drain_on_flush = true;
3593 int64_t image_size;
3594 BlockBackend *blk = NULL;
3595 BenchData data = {};
3596 int flags = 0;
3597 bool writethrough = false;
3598 struct timeval t1, t2;
3599 int i;
3600
3601 for (;;) {
3602 static const struct option long_options[] = {
3603 {"help", no_argument, 0, 'h'},
3604 {"flush-interval", required_argument, 0, OPTION_FLUSH_INTERVAL},
3605 {"image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3606 {"pattern", required_argument, 0, OPTION_PATTERN},
3607 {"no-drain", no_argument, 0, OPTION_NO_DRAIN},
3608 {0, 0, 0, 0}
3609 };
3610 c = getopt_long(argc, argv, "hc:d:f:no:qs:S:t:w", long_options, NULL);
3611 if (c == -1) {
3612 break;
3613 }
3614
3615 switch (c) {
3616 case 'h':
3617 case '?':
3618 help();
3619 break;
3620 case 'c':
3621 {
3622 char *end;
3623 errno = 0;
3624 count = strtoul(optarg, &end, 0);
3625 if (errno || *end || count > INT_MAX) {
3626 error_report("Invalid request count specified");
3627 return 1;
3628 }
3629 break;
3630 }
3631 case 'd':
3632 {
3633 char *end;
3634 errno = 0;
3635 depth = strtoul(optarg, &end, 0);
3636 if (errno || *end || depth > INT_MAX) {
3637 error_report("Invalid queue depth specified");
3638 return 1;
3639 }
3640 break;
3641 }
3642 case 'f':
3643 fmt = optarg;
3644 break;
3645 case 'n':
3646 flags |= BDRV_O_NATIVE_AIO;
3647 break;
3648 case 'o':
3649 {
3650 char *end;
3651 errno = 0;
3652 offset = qemu_strtosz_suffix(optarg, &end,
3653 QEMU_STRTOSZ_DEFSUFFIX_B);
3654 if (offset < 0|| *end) {
3655 error_report("Invalid offset specified");
3656 return 1;
3657 }
3658 break;
3659 }
3660 break;
3661 case 'q':
3662 quiet = true;
3663 break;
3664 case 's':
3665 {
3666 int64_t sval;
3667 char *end;
3668
3669 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3670 if (sval < 0 || sval > INT_MAX || *end) {
3671 error_report("Invalid buffer size specified");
3672 return 1;
3673 }
3674
3675 bufsize = sval;
3676 break;
3677 }
3678 case 'S':
3679 {
3680 int64_t sval;
3681 char *end;
3682
3683 sval = qemu_strtosz_suffix(optarg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3684 if (sval < 0 || sval > INT_MAX || *end) {
3685 error_report("Invalid step size specified");
3686 return 1;
3687 }
3688
3689 step = sval;
3690 break;
3691 }
3692 case 't':
3693 ret = bdrv_parse_cache_mode(optarg, &flags, &writethrough);
3694 if (ret < 0) {
3695 error_report("Invalid cache mode");
3696 ret = -1;
3697 goto out;
3698 }
3699 break;
3700 case 'w':
3701 flags |= BDRV_O_RDWR;
3702 is_write = true;
3703 break;
3704 case OPTION_PATTERN:
3705 {
3706 char *end;
3707 errno = 0;
3708 pattern = strtoul(optarg, &end, 0);
3709 if (errno || *end || pattern > 0xff) {
3710 error_report("Invalid pattern byte specified");
3711 return 1;
3712 }
3713 break;
3714 }
3715 case OPTION_FLUSH_INTERVAL:
3716 {
3717 char *end;
3718 errno = 0;
3719 flush_interval = strtoul(optarg, &end, 0);
3720 if (errno || *end || flush_interval > INT_MAX) {
3721 error_report("Invalid flush interval specified");
3722 return 1;
3723 }
3724 break;
3725 }
3726 case OPTION_NO_DRAIN:
3727 drain_on_flush = false;
3728 break;
3729 case OPTION_IMAGE_OPTS:
3730 image_opts = true;
3731 break;
3732 }
3733 }
3734
3735 if (optind != argc - 1) {
3736 error_exit("Expecting one image file name");
3737 }
3738 filename = argv[argc - 1];
3739
3740 if (!is_write && flush_interval) {
3741 error_report("--flush-interval is only available in write tests");
3742 ret = -1;
3743 goto out;
3744 }
3745 if (flush_interval && flush_interval < depth) {
3746 error_report("Flush interval can't be smaller than depth");
3747 ret = -1;
3748 goto out;
3749 }
3750
3751 blk = img_open(image_opts, filename, fmt, flags, writethrough, quiet);
3752 if (!blk) {
3753 ret = -1;
3754 goto out;
3755 }
3756
3757 image_size = blk_getlength(blk);
3758 if (image_size < 0) {
3759 ret = image_size;
3760 goto out;
3761 }
3762
3763 data = (BenchData) {
3764 .blk = blk,
3765 .image_size = image_size,
3766 .bufsize = bufsize,
3767 .step = step ?: bufsize,
3768 .nrreq = depth,
3769 .n = count,
3770 .offset = offset,
3771 .write = is_write,
3772 .flush_interval = flush_interval,
3773 .drain_on_flush = drain_on_flush,
3774 };
3775 printf("Sending %d %s requests, %d bytes each, %d in parallel "
3776 "(starting at offset %" PRId64 ", step size %d)\n",
3777 data.n, data.write ? "write" : "read", data.bufsize, data.nrreq,
3778 data.offset, data.step);
3779 if (flush_interval) {
3780 printf("Sending flush every %d requests\n", flush_interval);
3781 }
3782
3783 data.buf = blk_blockalign(blk, data.nrreq * data.bufsize);
3784 memset(data.buf, pattern, data.nrreq * data.bufsize);
3785
3786 data.qiov = g_new(QEMUIOVector, data.nrreq);
3787 for (i = 0; i < data.nrreq; i++) {
3788 qemu_iovec_init(&data.qiov[i], 1);
3789 qemu_iovec_add(&data.qiov[i],
3790 data.buf + i * data.bufsize, data.bufsize);
3791 }
3792
3793 gettimeofday(&t1, NULL);
3794 bench_cb(&data, 0);
3795
3796 while (data.n > 0) {
3797 main_loop_wait(false);
3798 }
3799 gettimeofday(&t2, NULL);
3800
3801 printf("Run completed in %3.3f seconds.\n",
3802 (t2.tv_sec - t1.tv_sec)
3803 + ((double)(t2.tv_usec - t1.tv_usec) / 1000000));
3804
3805 out:
3806 qemu_vfree(data.buf);
3807 blk_unref(blk);
3808
3809 if (ret) {
3810 return 1;
3811 }
3812 return 0;
3813 }
3814
3815 #define C_BS 01
3816 #define C_COUNT 02
3817 #define C_IF 04
3818 #define C_OF 010
3819 #define C_SKIP 020
3820
3821 struct DdInfo {
3822 unsigned int flags;
3823 int64_t count;
3824 };
3825
3826 struct DdIo {
3827 int bsz; /* Block size */
3828 char *filename;
3829 uint8_t *buf;
3830 int64_t offset;
3831 };
3832
3833 struct DdOpts {
3834 const char *name;
3835 int (*f)(const char *, struct DdIo *, struct DdIo *, struct DdInfo *);
3836 unsigned int flag;
3837 };
3838
3839 static int img_dd_bs(const char *arg,
3840 struct DdIo *in, struct DdIo *out,
3841 struct DdInfo *dd)
3842 {
3843 char *end;
3844 int64_t res;
3845
3846 res = qemu_strtosz_suffix(arg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3847
3848 if (res <= 0 || res > INT_MAX || *end) {
3849 error_report("invalid number: '%s'", arg);
3850 return 1;
3851 }
3852 in->bsz = out->bsz = res;
3853
3854 return 0;
3855 }
3856
3857 static int img_dd_count(const char *arg,
3858 struct DdIo *in, struct DdIo *out,
3859 struct DdInfo *dd)
3860 {
3861 char *end;
3862
3863 dd->count = qemu_strtosz_suffix(arg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3864
3865 if (dd->count < 0 || *end) {
3866 error_report("invalid number: '%s'", arg);
3867 return 1;
3868 }
3869
3870 return 0;
3871 }
3872
3873 static int img_dd_if(const char *arg,
3874 struct DdIo *in, struct DdIo *out,
3875 struct DdInfo *dd)
3876 {
3877 in->filename = g_strdup(arg);
3878
3879 return 0;
3880 }
3881
3882 static int img_dd_of(const char *arg,
3883 struct DdIo *in, struct DdIo *out,
3884 struct DdInfo *dd)
3885 {
3886 out->filename = g_strdup(arg);
3887
3888 return 0;
3889 }
3890
3891 static int img_dd_skip(const char *arg,
3892 struct DdIo *in, struct DdIo *out,
3893 struct DdInfo *dd)
3894 {
3895 char *end;
3896
3897 in->offset = qemu_strtosz_suffix(arg, &end, QEMU_STRTOSZ_DEFSUFFIX_B);
3898
3899 if (in->offset < 0 || *end) {
3900 error_report("invalid number: '%s'", arg);
3901 return 1;
3902 }
3903
3904 return 0;
3905 }
3906
3907 static int img_dd(int argc, char **argv)
3908 {
3909 int ret = 0;
3910 char *arg = NULL;
3911 char *tmp;
3912 BlockDriver *drv = NULL, *proto_drv = NULL;
3913 BlockBackend *blk1 = NULL, *blk2 = NULL;
3914 QemuOpts *opts = NULL;
3915 QemuOptsList *create_opts = NULL;
3916 Error *local_err = NULL;
3917 bool image_opts = false;
3918 int c, i;
3919 const char *out_fmt = "raw";
3920 const char *fmt = NULL;
3921 int64_t size = 0;
3922 int64_t block_count = 0, out_pos, in_pos;
3923 struct DdInfo dd = {
3924 .flags = 0,
3925 .count = 0,
3926 };
3927 struct DdIo in = {
3928 .bsz = 512, /* Block size is by default 512 bytes */
3929 .filename = NULL,
3930 .buf = NULL,
3931 .offset = 0
3932 };
3933 struct DdIo out = {
3934 .bsz = 512,
3935 .filename = NULL,
3936 .buf = NULL,
3937 .offset = 0
3938 };
3939
3940 const struct DdOpts options[] = {
3941 { "bs", img_dd_bs, C_BS },
3942 { "count", img_dd_count, C_COUNT },
3943 { "if", img_dd_if, C_IF },
3944 { "of", img_dd_of, C_OF },
3945 { "skip", img_dd_skip, C_SKIP },
3946 { NULL, NULL, 0 }
3947 };
3948 const struct option long_options[] = {
3949 { "help", no_argument, 0, 'h'},
3950 { "image-opts", no_argument, 0, OPTION_IMAGE_OPTS},
3951 { 0, 0, 0, 0 }
3952 };
3953
3954 while ((c = getopt_long(argc, argv, "hf:O:", long_options, NULL))) {
3955 if (c == EOF) {
3956 break;
3957 }
3958 switch (c) {
3959 case 'O':
3960 out_fmt = optarg;
3961 break;
3962 case 'f':
3963 fmt = optarg;
3964 break;
3965 case '?':
3966 error_report("Try 'qemu-img --help' for more information.");
3967 ret = -1;
3968 goto out;
3969 case 'h':
3970 help();
3971 break;
3972 case OPTION_IMAGE_OPTS:
3973 image_opts = true;
3974 break;
3975 }
3976 }
3977
3978 for (i = optind; i < argc; i++) {
3979 int j;
3980 arg = g_strdup(argv[i]);
3981
3982 tmp = strchr(arg, '=');
3983 if (tmp == NULL) {
3984 error_report("unrecognized operand %s", arg);
3985 ret = -1;
3986 goto out;
3987 }
3988
3989 *tmp++ = '\0';
3990
3991 for (j = 0; options[j].name != NULL; j++) {
3992 if (!strcmp(arg, options[j].name)) {
3993 break;
3994 }
3995 }
3996 if (options[j].name == NULL) {
3997 error_report("unrecognized operand %s", arg);
3998 ret = -1;
3999 goto out;
4000 }
4001
4002 if (options[j].f(tmp, &in, &out, &dd) != 0) {
4003 ret = -1;
4004 goto out;
4005 }
4006 dd.flags |= options[j].flag;
4007 g_free(arg);
4008 arg = NULL;
4009 }
4010
4011 if (!(dd.flags & C_IF && dd.flags & C_OF)) {
4012 error_report("Must specify both input and output files");
4013 ret = -1;
4014 goto out;
4015 }
4016 blk1 = img_open(image_opts, in.filename, fmt, 0, false, false);
4017
4018 if (!blk1) {
4019 ret = -1;
4020 goto out;
4021 }
4022
4023 drv = bdrv_find_format(out_fmt);
4024 if (!drv) {
4025 error_report("Unknown file format");
4026 ret = -1;
4027 goto out;
4028 }
4029 proto_drv = bdrv_find_protocol(out.filename, true, &local_err);
4030
4031 if (!proto_drv) {
4032 error_report_err(local_err);
4033 ret = -1;
4034 goto out;
4035 }
4036 if (!drv->create_opts) {
4037 error_report("Format driver '%s' does not support image creation",
4038 drv->format_name);
4039 ret = -1;
4040 goto out;
4041 }
4042 if (!proto_drv->create_opts) {
4043 error_report("Protocol driver '%s' does not support image creation",
4044 proto_drv->format_name);
4045 ret = -1;
4046 goto out;
4047 }
4048 create_opts = qemu_opts_append(create_opts, drv->create_opts);
4049 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
4050
4051 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
4052
4053 size = blk_getlength(blk1);
4054 if (size < 0) {
4055 error_report("Failed to get size for '%s'", in.filename);
4056 ret = -1;
4057 goto out;
4058 }
4059
4060 if (dd.flags & C_COUNT && dd.count <= INT64_MAX / in.bsz &&
4061 dd.count * in.bsz < size) {
4062 size = dd.count * in.bsz;
4063 }
4064
4065 /* Overflow means the specified offset is beyond input image's size */
4066 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4067 size < in.bsz * in.offset)) {
4068 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, 0, &error_abort);
4069 } else {
4070 qemu_opt_set_number(opts, BLOCK_OPT_SIZE,
4071 size - in.bsz * in.offset, &error_abort);
4072 }
4073
4074 ret = bdrv_create(drv, out.filename, opts, &local_err);
4075 if (ret < 0) {
4076 error_reportf_err(local_err,
4077 "%s: error while creating output image: ",
4078 out.filename);
4079 ret = -1;
4080 goto out;
4081 }
4082
4083 blk2 = img_open(image_opts, out.filename, out_fmt, BDRV_O_RDWR,
4084 false, false);
4085
4086 if (!blk2) {
4087 ret = -1;
4088 goto out;
4089 }
4090
4091 if (dd.flags & C_SKIP && (in.offset > INT64_MAX / in.bsz ||
4092 size < in.offset * in.bsz)) {
4093 /* We give a warning if the skip option is bigger than the input
4094 * size and create an empty output disk image (i.e. like dd(1)).
4095 */
4096 error_report("%s: cannot skip to specified offset", in.filename);
4097 in_pos = size;
4098 } else {
4099 in_pos = in.offset * in.bsz;
4100 }
4101
4102 in.buf = g_new(uint8_t, in.bsz);
4103
4104 for (out_pos = 0; in_pos < size; block_count++) {
4105 int in_ret, out_ret;
4106
4107 if (in_pos + in.bsz > size) {
4108 in_ret = blk_pread(blk1, in_pos, in.buf, size - in_pos);
4109 } else {
4110 in_ret = blk_pread(blk1, in_pos, in.buf, in.bsz);
4111 }
4112 if (in_ret < 0) {
4113 error_report("error while reading from input image file: %s",
4114 strerror(-in_ret));
4115 ret = -1;
4116 goto out;
4117 }
4118 in_pos += in_ret;
4119
4120 out_ret = blk_pwrite(blk2, out_pos, in.buf, in_ret, 0);
4121
4122 if (out_ret < 0) {
4123 error_report("error while writing to output image file: %s",
4124 strerror(-out_ret));
4125 ret = -1;
4126 goto out;
4127 }
4128 out_pos += out_ret;
4129 }
4130
4131 out:
4132 g_free(arg);
4133 qemu_opts_del(opts);
4134 qemu_opts_free(create_opts);
4135 blk_unref(blk1);
4136 blk_unref(blk2);
4137 g_free(in.filename);
4138 g_free(out.filename);
4139 g_free(in.buf);
4140 g_free(out.buf);
4141
4142 if (ret) {
4143 return 1;
4144 }
4145 return 0;
4146 }
4147
4148
4149 static const img_cmd_t img_cmds[] = {
4150 #define DEF(option, callback, arg_string) \
4151 { option, callback },
4152 #include "qemu-img-cmds.h"
4153 #undef DEF
4154 #undef GEN_DOCS
4155 { NULL, NULL, },
4156 };
4157
4158 int main(int argc, char **argv)
4159 {
4160 const img_cmd_t *cmd;
4161 const char *cmdname;
4162 Error *local_error = NULL;
4163 char *trace_file = NULL;
4164 int c;
4165 static const struct option long_options[] = {
4166 {"help", no_argument, 0, 'h'},
4167 {"version", no_argument, 0, 'V'},
4168 {"trace", required_argument, NULL, 'T'},
4169 {0, 0, 0, 0}
4170 };
4171
4172 #ifdef CONFIG_POSIX
4173 signal(SIGPIPE, SIG_IGN);
4174 #endif
4175
4176 module_call_init(MODULE_INIT_TRACE);
4177 error_set_progname(argv[0]);
4178 qemu_init_exec_dir(argv[0]);
4179
4180 if (qemu_init_main_loop(&local_error)) {
4181 error_report_err(local_error);
4182 exit(EXIT_FAILURE);
4183 }
4184
4185 qcrypto_init(&error_fatal);
4186
4187 module_call_init(MODULE_INIT_QOM);
4188 bdrv_init();
4189 if (argc < 2) {
4190 error_exit("Not enough arguments");
4191 }
4192
4193 qemu_add_opts(&qemu_object_opts);
4194 qemu_add_opts(&qemu_source_opts);
4195 qemu_add_opts(&qemu_trace_opts);
4196
4197 while ((c = getopt_long(argc, argv, "+hVT:", long_options, NULL)) != -1) {
4198 switch (c) {
4199 case 'h':
4200 help();
4201 return 0;
4202 case 'V':
4203 printf(QEMU_IMG_VERSION);
4204 return 0;
4205 case 'T':
4206 g_free(trace_file);
4207 trace_file = trace_opt_parse(optarg);
4208 break;
4209 }
4210 }
4211
4212 cmdname = argv[optind];
4213
4214 /* reset getopt_long scanning */
4215 argc -= optind;
4216 if (argc < 1) {
4217 return 0;
4218 }
4219 argv += optind;
4220 optind = 0;
4221
4222 if (!trace_init_backends()) {
4223 exit(1);
4224 }
4225 trace_init_file(trace_file);
4226 qemu_set_log(LOG_TRACE);
4227
4228 /* find the command */
4229 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
4230 if (!strcmp(cmdname, cmd->name)) {
4231 return cmd->handler(argc, argv);
4232 }
4233 }
4234
4235 /* not found */
4236 error_exit("Command not found: %s", cmdname);
4237 }