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