?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
pc: reserve more memory for ACPI for new machine types
[qemu.git] / qemu-img.c
blob18caa4b450886b3bde6e980921f7640b078d686f
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 "qapi-visit.h"
25 #include "qapi/qmp-output-visitor.h"
26 #include "qapi/qmp/qjson.h"
27 #include "qemu-common.h"
28 #include "qemu/option.h"
29 #include "qemu/error-report.h"
30 #include "qemu/osdep.h"
31 #include "sysemu/sysemu.h"
32 #include "block/block_int.h"
33 #include "block/qapi.h"
34 #include <getopt.h>
35 #include <glib.h>
36
37 #define QEMU_IMG_VERSION "qemu-img version " QEMU_VERSION \
38 ", Copyright (c) 2004-2008 Fabrice Bellard\n"
39
40 typedef struct img_cmd_t {
41 const char *name;
42 int (*handler)(int argc, char **argv);
43 } img_cmd_t;
44
45 enum {
46 OPTION_OUTPUT = 256,
47 OPTION_BACKING_CHAIN = 257,
48 };
49
50 typedef enum OutputFormat {
51 OFORMAT_JSON,
52 OFORMAT_HUMAN,
53 } OutputFormat;
54
55 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
56 #define BDRV_O_FLAGS BDRV_O_CACHE_WB
57 #define BDRV_DEFAULT_CACHE "writeback"
58
59 static gint compare_data(gconstpointer a, gconstpointer b, gpointer user)
60 {
61 return g_strcmp0(a, b);
62 }
63
64 static void print_format(gpointer data, gpointer user)
65 {
66 printf(" %s", (char *)data);
67 }
68
69 static void add_format_to_seq(void *opaque, const char *fmt_name)
70 {
71 GSequence *seq = opaque;
72
73 g_sequence_insert_sorted(seq, (gpointer)fmt_name,
74 compare_data, NULL);
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 command [command options]\n"
97 "QEMU disk image utility\n"
98 "\n"
99 "Command syntax:\n"
100 #define DEF(option, callback, arg_string) \
101 " " arg_string "\n"
102 #include "qemu-img-cmds.h"
103 #undef DEF
104 #undef GEN_DOCS
105 "\n"
106 "Command parameters:\n"
107 " 'filename' is a disk image filename\n"
108 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
109 " 'cache' is the cache mode used to write the output disk image, the valid\n"
110 " options are: 'none', 'writeback' (default, except for convert), 'writethrough',\n"
111 " 'directsync' and 'unsafe' (default for convert)\n"
112 " 'size' is the disk image size in bytes. Optional suffixes\n"
113 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M),\n"
114 " 'T' (terabyte, 1024G), 'P' (petabyte, 1024T) and 'E' (exabyte, 1024P) are\n"
115 " supported. 'b' is ignored.\n"
116 " 'output_filename' is the destination disk image filename\n"
117 " 'output_fmt' is the destination format\n"
118 " 'options' is a comma separated list of format specific options in a\n"
119 " name=value format. Use -o ? for an overview of the options supported by the\n"
120 " used format\n"
121 " 'snapshot_param' is param used for internal snapshot, format\n"
122 " is 'snapshot.id=[ID],snapshot.name=[NAME]', or\n"
123 " '[ID_OR_NAME]'\n"
124 " 'snapshot_id_or_name' is deprecated, use 'snapshot_param'\n"
125 " instead\n"
126 " '-c' indicates that target image must be compressed (qcow format only)\n"
127 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
128 " match exactly. The image doesn't need a working backing file before\n"
129 " rebasing in this case (useful for renaming the backing file)\n"
130 " '-h' with or without a command shows this help and lists the supported formats\n"
131 " '-p' show progress of command (only certain commands)\n"
132 " '-q' use Quiet mode - do not print any output (except errors)\n"
133 " '-S' indicates the consecutive number of bytes (defaults to 4k) that must\n"
134 " contain only zeros for qemu-img to create a sparse image during\n"
135 " conversion. If the number of bytes is 0, the source will not be scanned for\n"
136 " unallocated or zero sectors, and the destination image will always be\n"
137 " fully allocated\n"
138 " '--output' takes the format in which the output must be done (human or json)\n"
139 " '-n' skips the target volume creation (useful if the volume is created\n"
140 " prior to running qemu-img)\n"
141 "\n"
142 "Parameters to check subcommand:\n"
143 " '-r' tries to repair any inconsistencies that are found during the check.\n"
144 " '-r leaks' repairs only cluster leaks, whereas '-r all' fixes all\n"
145 " kinds of errors, with a higher risk of choosing the wrong fix or\n"
146 " hiding corruption that has already occurred.\n"
147 "\n"
148 "Parameters to snapshot subcommand:\n"
149 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
150 " '-a' applies a snapshot (revert disk to saved state)\n"
151 " '-c' creates a snapshot\n"
152 " '-d' deletes a snapshot\n"
153 " '-l' lists all snapshots in the given image\n"
154 "\n"
155 "Parameters to compare subcommand:\n"
156 " '-f' first image format\n"
157 " '-F' second image format\n"
158 " '-s' run in Strict mode - fail on different image size or sector allocation\n";
159 GSequence *seq;
160
161 printf("%s\nSupported formats:", help_msg);
162 seq = g_sequence_new(NULL);
163 bdrv_iterate_format(add_format_to_seq, seq);
164 g_sequence_foreach(seq, print_format, NULL);
165 printf("\n");
166 g_sequence_free(seq);
167
168 exit(EXIT_SUCCESS);
169 }
170
171 static int GCC_FMT_ATTR(2, 3) qprintf(bool quiet, const char *fmt, ...)
172 {
173 int ret = 0;
174 if (!quiet) {
175 va_list args;
176 va_start(args, fmt);
177 ret = vprintf(fmt, args);
178 va_end(args);
179 }
180 return ret;
181 }
182
183 #if defined(WIN32)
184 /* XXX: put correct support for win32 */
185 static int read_password(char *buf, int buf_size)
186 {
187 int c, i;
188
189 printf("Password: ");
190 fflush(stdout);
191 i = 0;
192 for(;;) {
193 c = getchar();
194 if (c < 0) {
195 buf[i] = '\0';
196 return -1;
197 } else if (c == '\n') {
198 break;
199 } else if (i < (buf_size - 1)) {
200 buf[i++] = c;
201 }
202 }
203 buf[i] = '\0';
204 return 0;
205 }
206
207 #else
208
209 #include <termios.h>
210
211 static struct termios oldtty;
212
213 static void term_exit(void)
214 {
215 tcsetattr (0, TCSANOW, &oldtty);
216 }
217
218 static void term_init(void)
219 {
220 struct termios tty;
221
222 tcgetattr (0, &tty);
223 oldtty = tty;
224
225 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
226 |INLCR|IGNCR|ICRNL|IXON);
227 tty.c_oflag |= OPOST;
228 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
229 tty.c_cflag &= ~(CSIZE|PARENB);
230 tty.c_cflag |= CS8;
231 tty.c_cc[VMIN] = 1;
232 tty.c_cc[VTIME] = 0;
233
234 tcsetattr (0, TCSANOW, &tty);
235
236 atexit(term_exit);
237 }
238
239 static int read_password(char *buf, int buf_size)
240 {
241 uint8_t ch;
242 int i, ret;
243
244 printf("password: ");
245 fflush(stdout);
246 term_init();
247 i = 0;
248 for(;;) {
249 ret = read(0, &ch, 1);
250 if (ret == -1) {
251 if (errno == EAGAIN || errno == EINTR) {
252 continue;
253 } else {
254 break;
255 }
256 } else if (ret == 0) {
257 ret = -1;
258 break;
259 } else {
260 if (ch == '\r') {
261 ret = 0;
262 break;
263 }
264 if (i < (buf_size - 1))
265 buf[i++] = ch;
266 }
267 }
268 term_exit();
269 buf[i] = '\0';
270 printf("\n");
271 return ret;
272 }
273 #endif
274
275 static int print_block_option_help(const char *filename, const char *fmt)
276 {
277 BlockDriver *drv, *proto_drv;
278 QemuOptsList *create_opts = NULL;
279
280 /* Find driver and parse its options */
281 drv = bdrv_find_format(fmt);
282 if (!drv) {
283 error_report("Unknown file format '%s'", fmt);
284 return 1;
285 }
286
287 create_opts = qemu_opts_append(create_opts, drv->create_opts);
288 if (filename) {
289 proto_drv = bdrv_find_protocol(filename, true);
290 if (!proto_drv) {
291 error_report("Unknown protocol '%s'", filename);
292 qemu_opts_free(create_opts);
293 return 1;
294 }
295 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
296 }
297
298 qemu_opts_print_help(create_opts);
299 qemu_opts_free(create_opts);
300 return 0;
301 }
302
303 static BlockDriverState *bdrv_new_open(const char *id,
304 const char *filename,
305 const char *fmt,
306 int flags,
307 bool require_io,
308 bool quiet)
309 {
310 BlockDriverState *bs;
311 BlockDriver *drv;
312 char password[256];
313 Error *local_err = NULL;
314 int ret;
315
316 bs = bdrv_new(id, &error_abort);
317
318 if (fmt) {
319 drv = bdrv_find_format(fmt);
320 if (!drv) {
321 error_report("Unknown file format '%s'", fmt);
322 goto fail;
323 }
324 } else {
325 drv = NULL;
326 }
327
328 ret = bdrv_open(&bs, filename, NULL, NULL, flags, drv, &local_err);
329 if (ret < 0) {
330 error_report("Could not open '%s': %s", filename,
331 error_get_pretty(local_err));
332 error_free(local_err);
333 goto fail;
334 }
335
336 if (bdrv_is_encrypted(bs) && require_io) {
337 qprintf(quiet, "Disk image '%s' is encrypted.\n", filename);
338 if (read_password(password, sizeof(password)) < 0) {
339 error_report("No password given");
340 goto fail;
341 }
342 if (bdrv_set_key(bs, password) < 0) {
343 error_report("invalid password");
344 goto fail;
345 }
346 }
347 return bs;
348 fail:
349 bdrv_unref(bs);
350 return NULL;
351 }
352
353 static int add_old_style_options(const char *fmt, QemuOpts *opts,
354 const char *base_filename,
355 const char *base_fmt)
356 {
357 if (base_filename) {
358 if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FILE, base_filename)) {
359 error_report("Backing file not supported for file format '%s'",
360 fmt);
361 return -1;
362 }
363 }
364 if (base_fmt) {
365 if (qemu_opt_set(opts, BLOCK_OPT_BACKING_FMT, base_fmt)) {
366 error_report("Backing file format not supported for file "
367 "format '%s'", fmt);
368 return -1;
369 }
370 }
371 return 0;
372 }
373
374 static int img_create(int argc, char **argv)
375 {
376 int c;
377 uint64_t img_size = -1;
378 const char *fmt = "raw";
379 const char *base_fmt = NULL;
380 const char *filename;
381 const char *base_filename = NULL;
382 char *options = NULL;
383 Error *local_err = NULL;
384 bool quiet = false;
385
386 for(;;) {
387 c = getopt(argc, argv, "F:b:f:he6o:q");
388 if (c == -1) {
389 break;
390 }
391 switch(c) {
392 case '?':
393 case 'h':
394 help();
395 break;
396 case 'F':
397 base_fmt = optarg;
398 break;
399 case 'b':
400 base_filename = optarg;
401 break;
402 case 'f':
403 fmt = optarg;
404 break;
405 case 'e':
406 error_report("option -e is deprecated, please use \'-o "
407 "encryption\' instead!");
408 goto fail;
409 case '6':
410 error_report("option -6 is deprecated, please use \'-o "
411 "compat6\' instead!");
412 goto fail;
413 case 'o':
414 if (!is_valid_option_list(optarg)) {
415 error_report("Invalid option list: %s", optarg);
416 goto fail;
417 }
418 if (!options) {
419 options = g_strdup(optarg);
420 } else {
421 char *old_options = options;
422 options = g_strdup_printf("%s,%s", options, optarg);
423 g_free(old_options);
424 }
425 break;
426 case 'q':
427 quiet = true;
428 break;
429 }
430 }
431
432 /* Get the filename */
433 filename = (optind < argc) ? argv[optind] : NULL;
434 if (options && has_help_option(options)) {
435 g_free(options);
436 return print_block_option_help(filename, fmt);
437 }
438
439 if (optind >= argc) {
440 error_exit("Expecting image file name");
441 }
442 optind++;
443
444 /* Get image size, if specified */
445 if (optind < argc) {
446 int64_t sval;
447 char *end;
448 sval = strtosz_suffix(argv[optind++], &end, STRTOSZ_DEFSUFFIX_B);
449 if (sval < 0 || *end) {
450 if (sval == -ERANGE) {
451 error_report("Image size must be less than 8 EiB!");
452 } else {
453 error_report("Invalid image size specified! You may use k, M, "
454 "G, T, P or E suffixes for ");
455 error_report("kilobytes, megabytes, gigabytes, terabytes, "
456 "petabytes and exabytes.");
457 }
458 goto fail;
459 }
460 img_size = (uint64_t)sval;
461 }
462 if (optind != argc) {
463 error_exit("Unexpected argument: %s", argv[optind]);
464 }
465
466 bdrv_img_create(filename, fmt, base_filename, base_fmt,
467 options, img_size, BDRV_O_FLAGS, &local_err, quiet);
468 if (local_err) {
469 error_report("%s: %s", filename, error_get_pretty(local_err));
470 error_free(local_err);
471 goto fail;
472 }
473
474 g_free(options);
475 return 0;
476
477 fail:
478 g_free(options);
479 return 1;
480 }
481
482 static void dump_json_image_check(ImageCheck *check, bool quiet)
483 {
484 Error *local_err = NULL;
485 QString *str;
486 QmpOutputVisitor *ov = qmp_output_visitor_new();
487 QObject *obj;
488 visit_type_ImageCheck(qmp_output_get_visitor(ov),
489 &check, NULL, &local_err);
490 obj = qmp_output_get_qobject(ov);
491 str = qobject_to_json_pretty(obj);
492 assert(str != NULL);
493 qprintf(quiet, "%s\n", qstring_get_str(str));
494 qobject_decref(obj);
495 qmp_output_visitor_cleanup(ov);
496 QDECREF(str);
497 }
498
499 static void dump_human_image_check(ImageCheck *check, bool quiet)
500 {
501 if (!(check->corruptions || check->leaks || check->check_errors)) {
502 qprintf(quiet, "No errors were found on the image.\n");
503 } else {
504 if (check->corruptions) {
505 qprintf(quiet, "\n%" PRId64 " errors were found on the image.\n"
506 "Data may be corrupted, or further writes to the image "
507 "may corrupt it.\n",
508 check->corruptions);
509 }
510
511 if (check->leaks) {
512 qprintf(quiet,
513 "\n%" PRId64 " leaked clusters were found on the image.\n"
514 "This means waste of disk space, but no harm to data.\n",
515 check->leaks);
516 }
517
518 if (check->check_errors) {
519 qprintf(quiet,
520 "\n%" PRId64
521 " internal errors have occurred during the check.\n",
522 check->check_errors);
523 }
524 }
525
526 if (check->total_clusters != 0 && check->allocated_clusters != 0) {
527 qprintf(quiet, "%" PRId64 "/%" PRId64 " = %0.2f%% allocated, "
528 "%0.2f%% fragmented, %0.2f%% compressed clusters\n",
529 check->allocated_clusters, check->total_clusters,
530 check->allocated_clusters * 100.0 / check->total_clusters,
531 check->fragmented_clusters * 100.0 / check->allocated_clusters,
532 check->compressed_clusters * 100.0 /
533 check->allocated_clusters);
534 }
535
536 if (check->image_end_offset) {
537 qprintf(quiet,
538 "Image end offset: %" PRId64 "\n", check->image_end_offset);
539 }
540 }
541
542 static int collect_image_check(BlockDriverState *bs,
543 ImageCheck *check,
544 const char *filename,
545 const char *fmt,
546 int fix)
547 {
548 int ret;
549 BdrvCheckResult result;
550
551 ret = bdrv_check(bs, &result, fix);
552 if (ret < 0) {
553 return ret;
554 }
555
556 check->filename = g_strdup(filename);
557 check->format = g_strdup(bdrv_get_format_name(bs));
558 check->check_errors = result.check_errors;
559 check->corruptions = result.corruptions;
560 check->has_corruptions = result.corruptions != 0;
561 check->leaks = result.leaks;
562 check->has_leaks = result.leaks != 0;
563 check->corruptions_fixed = result.corruptions_fixed;
564 check->has_corruptions_fixed = result.corruptions != 0;
565 check->leaks_fixed = result.leaks_fixed;
566 check->has_leaks_fixed = result.leaks != 0;
567 check->image_end_offset = result.image_end_offset;
568 check->has_image_end_offset = result.image_end_offset != 0;
569 check->total_clusters = result.bfi.total_clusters;
570 check->has_total_clusters = result.bfi.total_clusters != 0;
571 check->allocated_clusters = result.bfi.allocated_clusters;
572 check->has_allocated_clusters = result.bfi.allocated_clusters != 0;
573 check->fragmented_clusters = result.bfi.fragmented_clusters;
574 check->has_fragmented_clusters = result.bfi.fragmented_clusters != 0;
575 check->compressed_clusters = result.bfi.compressed_clusters;
576 check->has_compressed_clusters = result.bfi.compressed_clusters != 0;
577
578 return 0;
579 }
580
581 /*
582 * Checks an image for consistency. Exit codes:
583 *
584 * 0 - Check completed, image is good
585 * 1 - Check not completed because of internal errors
586 * 2 - Check completed, image is corrupted
587 * 3 - Check completed, image has leaked clusters, but is good otherwise
588 * 63 - Checks are not supported by the image format
589 */
590 static int img_check(int argc, char **argv)
591 {
592 int c, ret;
593 OutputFormat output_format = OFORMAT_HUMAN;
594 const char *filename, *fmt, *output;
595 BlockDriverState *bs;
596 int fix = 0;
597 int flags = BDRV_O_FLAGS | BDRV_O_CHECK;
598 ImageCheck *check;
599 bool quiet = false;
600
601 fmt = NULL;
602 output = NULL;
603 for(;;) {
604 int option_index = 0;
605 static const struct option long_options[] = {
606 {"help", no_argument, 0, 'h'},
607 {"format", required_argument, 0, 'f'},
608 {"repair", required_argument, 0, 'r'},
609 {"output", required_argument, 0, OPTION_OUTPUT},
610 {0, 0, 0, 0}
611 };
612 c = getopt_long(argc, argv, "f:hr:q",
613 long_options, &option_index);
614 if (c == -1) {
615 break;
616 }
617 switch(c) {
618 case '?':
619 case 'h':
620 help();
621 break;
622 case 'f':
623 fmt = optarg;
624 break;
625 case 'r':
626 flags |= BDRV_O_RDWR;
627
628 if (!strcmp(optarg, "leaks")) {
629 fix = BDRV_FIX_LEAKS;
630 } else if (!strcmp(optarg, "all")) {
631 fix = BDRV_FIX_LEAKS | BDRV_FIX_ERRORS;
632 } else {
633 error_exit("Unknown option value for -r "
634 "(expecting 'leaks' or 'all'): %s", optarg);
635 }
636 break;
637 case OPTION_OUTPUT:
638 output = optarg;
639 break;
640 case 'q':
641 quiet = true;
642 break;
643 }
644 }
645 if (optind != argc - 1) {
646 error_exit("Expecting one image file name");
647 }
648 filename = argv[optind++];
649
650 if (output && !strcmp(output, "json")) {
651 output_format = OFORMAT_JSON;
652 } else if (output && !strcmp(output, "human")) {
653 output_format = OFORMAT_HUMAN;
654 } else if (output) {
655 error_report("--output must be used with human or json as argument.");
656 return 1;
657 }
658
659 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
660 if (!bs) {
661 return 1;
662 }
663
664 check = g_new0(ImageCheck, 1);
665 ret = collect_image_check(bs, check, filename, fmt, fix);
666
667 if (ret == -ENOTSUP) {
668 error_report("This image format does not support checks");
669 ret = 63;
670 goto fail;
671 }
672
673 if (check->corruptions_fixed || check->leaks_fixed) {
674 int corruptions_fixed, leaks_fixed;
675
676 leaks_fixed = check->leaks_fixed;
677 corruptions_fixed = check->corruptions_fixed;
678
679 if (output_format == OFORMAT_HUMAN) {
680 qprintf(quiet,
681 "The following inconsistencies were found and repaired:\n\n"
682 " %" PRId64 " leaked clusters\n"
683 " %" PRId64 " corruptions\n\n"
684 "Double checking the fixed image now...\n",
685 check->leaks_fixed,
686 check->corruptions_fixed);
687 }
688
689 ret = collect_image_check(bs, check, filename, fmt, 0);
690
691 check->leaks_fixed = leaks_fixed;
692 check->corruptions_fixed = corruptions_fixed;
693 }
694
695 switch (output_format) {
696 case OFORMAT_HUMAN:
697 dump_human_image_check(check, quiet);
698 break;
699 case OFORMAT_JSON:
700 dump_json_image_check(check, quiet);
701 break;
702 }
703
704 if (ret || check->check_errors) {
705 ret = 1;
706 goto fail;
707 }
708
709 if (check->corruptions) {
710 ret = 2;
711 } else if (check->leaks) {
712 ret = 3;
713 } else {
714 ret = 0;
715 }
716
717 fail:
718 qapi_free_ImageCheck(check);
719 bdrv_unref(bs);
720
721 return ret;
722 }
723
724 static int img_commit(int argc, char **argv)
725 {
726 int c, ret, flags;
727 const char *filename, *fmt, *cache;
728 BlockDriverState *bs;
729 bool quiet = false;
730
731 fmt = NULL;
732 cache = BDRV_DEFAULT_CACHE;
733 for(;;) {
734 c = getopt(argc, argv, "f:ht:q");
735 if (c == -1) {
736 break;
737 }
738 switch(c) {
739 case '?':
740 case 'h':
741 help();
742 break;
743 case 'f':
744 fmt = optarg;
745 break;
746 case 't':
747 cache = optarg;
748 break;
749 case 'q':
750 quiet = true;
751 break;
752 }
753 }
754 if (optind != argc - 1) {
755 error_exit("Expecting one image file name");
756 }
757 filename = argv[optind++];
758
759 flags = BDRV_O_RDWR;
760 ret = bdrv_parse_cache_flags(cache, &flags);
761 if (ret < 0) {
762 error_report("Invalid cache option: %s", cache);
763 return -1;
764 }
765
766 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
767 if (!bs) {
768 return 1;
769 }
770 ret = bdrv_commit(bs);
771 switch(ret) {
772 case 0:
773 qprintf(quiet, "Image committed.\n");
774 break;
775 case -ENOENT:
776 error_report("No disk inserted");
777 break;
778 case -EACCES:
779 error_report("Image is read-only");
780 break;
781 case -ENOTSUP:
782 error_report("Image is already committed");
783 break;
784 default:
785 error_report("Error while committing image");
786 break;
787 }
788
789 bdrv_unref(bs);
790 if (ret) {
791 return 1;
792 }
793 return 0;
794 }
795
796 /*
797 * Returns true iff the first sector pointed to by 'buf' contains at least
798 * a non-NUL byte.
799 *
800 * 'pnum' is set to the number of sectors (including and immediately following
801 * the first one) that are known to be in the same allocated/unallocated state.
802 */
803 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
804 {
805 bool is_zero;
806 int i;
807
808 if (n <= 0) {
809 *pnum = 0;
810 return 0;
811 }
812 is_zero = buffer_is_zero(buf, 512);
813 for(i = 1; i < n; i++) {
814 buf += 512;
815 if (is_zero != buffer_is_zero(buf, 512)) {
816 break;
817 }
818 }
819 *pnum = i;
820 return !is_zero;
821 }
822
823 /*
824 * Like is_allocated_sectors, but if the buffer starts with a used sector,
825 * up to 'min' consecutive sectors containing zeros are ignored. This avoids
826 * breaking up write requests for only small sparse areas.
827 */
828 static int is_allocated_sectors_min(const uint8_t *buf, int n, int *pnum,
829 int min)
830 {
831 int ret;
832 int num_checked, num_used;
833
834 if (n < min) {
835 min = n;
836 }
837
838 ret = is_allocated_sectors(buf, n, pnum);
839 if (!ret) {
840 return ret;
841 }
842
843 num_used = *pnum;
844 buf += BDRV_SECTOR_SIZE * *pnum;
845 n -= *pnum;
846 num_checked = num_used;
847
848 while (n > 0) {
849 ret = is_allocated_sectors(buf, n, pnum);
850
851 buf += BDRV_SECTOR_SIZE * *pnum;
852 n -= *pnum;
853 num_checked += *pnum;
854 if (ret) {
855 num_used = num_checked;
856 } else if (*pnum >= min) {
857 break;
858 }
859 }
860
861 *pnum = num_used;
862 return 1;
863 }
864
865 /*
866 * Compares two buffers sector by sector. Returns 0 if the first sector of both
867 * buffers matches, non-zero otherwise.
868 *
869 * pnum is set to the number of sectors (including and immediately following
870 * the first one) that are known to have the same comparison result
871 */
872 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
873 int *pnum)
874 {
875 int res, i;
876
877 if (n <= 0) {
878 *pnum = 0;
879 return 0;
880 }
881
882 res = !!memcmp(buf1, buf2, 512);
883 for(i = 1; i < n; i++) {
884 buf1 += 512;
885 buf2 += 512;
886
887 if (!!memcmp(buf1, buf2, 512) != res) {
888 break;
889 }
890 }
891
892 *pnum = i;
893 return res;
894 }
895
896 #define IO_BUF_SIZE (2 * 1024 * 1024)
897
898 static int64_t sectors_to_bytes(int64_t sectors)
899 {
900 return sectors << BDRV_SECTOR_BITS;
901 }
902
903 static int64_t sectors_to_process(int64_t total, int64_t from)
904 {
905 return MIN(total - from, IO_BUF_SIZE >> BDRV_SECTOR_BITS);
906 }
907
908 /*
909 * Check if passed sectors are empty (not allocated or contain only 0 bytes)
910 *
911 * Returns 0 in case sectors are filled with 0, 1 if sectors contain non-zero
912 * data and negative value on error.
913 *
914 * @param bs: Driver used for accessing file
915 * @param sect_num: Number of first sector to check
916 * @param sect_count: Number of sectors to check
917 * @param filename: Name of disk file we are checking (logging purpose)
918 * @param buffer: Allocated buffer for storing read data
919 * @param quiet: Flag for quiet mode
920 */
921 static int check_empty_sectors(BlockDriverState *bs, int64_t sect_num,
922 int sect_count, const char *filename,
923 uint8_t *buffer, bool quiet)
924 {
925 int pnum, ret = 0;
926 ret = bdrv_read(bs, sect_num, buffer, sect_count);
927 if (ret < 0) {
928 error_report("Error while reading offset %" PRId64 " of %s: %s",
929 sectors_to_bytes(sect_num), filename, strerror(-ret));
930 return ret;
931 }
932 ret = is_allocated_sectors(buffer, sect_count, &pnum);
933 if (ret || pnum != sect_count) {
934 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
935 sectors_to_bytes(ret ? sect_num : sect_num + pnum));
936 return 1;
937 }
938
939 return 0;
940 }
941
942 /*
943 * Compares two images. Exit codes:
944 *
945 * 0 - Images are identical
946 * 1 - Images differ
947 * >1 - Error occurred
948 */
949 static int img_compare(int argc, char **argv)
950 {
951 const char *fmt1 = NULL, *fmt2 = NULL, *filename1, *filename2;
952 BlockDriverState *bs1, *bs2;
953 int64_t total_sectors1, total_sectors2;
954 uint8_t *buf1 = NULL, *buf2 = NULL;
955 int pnum1, pnum2;
956 int allocated1, allocated2;
957 int ret = 0; /* return value - 0 Ident, 1 Different, >1 Error */
958 bool progress = false, quiet = false, strict = false;
959 int64_t total_sectors;
960 int64_t sector_num = 0;
961 int64_t nb_sectors;
962 int c, pnum;
963 uint64_t progress_base;
964
965 for (;;) {
966 c = getopt(argc, argv, "hpf:F:sq");
967 if (c == -1) {
968 break;
969 }
970 switch (c) {
971 case '?':
972 case 'h':
973 help();
974 break;
975 case 'f':
976 fmt1 = optarg;
977 break;
978 case 'F':
979 fmt2 = optarg;
980 break;
981 case 'p':
982 progress = true;
983 break;
984 case 'q':
985 quiet = true;
986 break;
987 case 's':
988 strict = true;
989 break;
990 }
991 }
992
993 /* Progress is not shown in Quiet mode */
994 if (quiet) {
995 progress = false;
996 }
997
998
999 if (optind != argc - 2) {
1000 error_exit("Expecting two image file names");
1001 }
1002 filename1 = argv[optind++];
1003 filename2 = argv[optind++];
1004
1005 /* Initialize before goto out */
1006 qemu_progress_init(progress, 2.0);
1007
1008 bs1 = bdrv_new_open("image 1", filename1, fmt1, BDRV_O_FLAGS, true, quiet);
1009 if (!bs1) {
1010 error_report("Can't open file %s", filename1);
1011 ret = 2;
1012 goto out3;
1013 }
1014
1015 bs2 = bdrv_new_open("image 2", filename2, fmt2, BDRV_O_FLAGS, true, quiet);
1016 if (!bs2) {
1017 error_report("Can't open file %s", filename2);
1018 ret = 2;
1019 goto out2;
1020 }
1021
1022 buf1 = qemu_blockalign(bs1, IO_BUF_SIZE);
1023 buf2 = qemu_blockalign(bs2, IO_BUF_SIZE);
1024 total_sectors1 = bdrv_nb_sectors(bs1);
1025 if (total_sectors1 < 0) {
1026 error_report("Can't get size of %s: %s",
1027 filename1, strerror(-total_sectors1));
1028 ret = 4;
1029 goto out;
1030 }
1031 total_sectors2 = bdrv_nb_sectors(bs2);
1032 if (total_sectors2 < 0) {
1033 error_report("Can't get size of %s: %s",
1034 filename2, strerror(-total_sectors2));
1035 ret = 4;
1036 goto out;
1037 }
1038 total_sectors = MIN(total_sectors1, total_sectors2);
1039 progress_base = MAX(total_sectors1, total_sectors2);
1040
1041 qemu_progress_print(0, 100);
1042
1043 if (strict && total_sectors1 != total_sectors2) {
1044 ret = 1;
1045 qprintf(quiet, "Strict mode: Image size mismatch!\n");
1046 goto out;
1047 }
1048
1049 for (;;) {
1050 nb_sectors = sectors_to_process(total_sectors, sector_num);
1051 if (nb_sectors <= 0) {
1052 break;
1053 }
1054 allocated1 = bdrv_is_allocated_above(bs1, NULL, sector_num, nb_sectors,
1055 &pnum1);
1056 if (allocated1 < 0) {
1057 ret = 3;
1058 error_report("Sector allocation test failed for %s", filename1);
1059 goto out;
1060 }
1061
1062 allocated2 = bdrv_is_allocated_above(bs2, NULL, sector_num, nb_sectors,
1063 &pnum2);
1064 if (allocated2 < 0) {
1065 ret = 3;
1066 error_report("Sector allocation test failed for %s", filename2);
1067 goto out;
1068 }
1069 nb_sectors = MIN(pnum1, pnum2);
1070
1071 if (allocated1 == allocated2) {
1072 if (allocated1) {
1073 ret = bdrv_read(bs1, sector_num, buf1, nb_sectors);
1074 if (ret < 0) {
1075 error_report("Error while reading offset %" PRId64 " of %s:"
1076 " %s", sectors_to_bytes(sector_num), filename1,
1077 strerror(-ret));
1078 ret = 4;
1079 goto out;
1080 }
1081 ret = bdrv_read(bs2, sector_num, buf2, nb_sectors);
1082 if (ret < 0) {
1083 error_report("Error while reading offset %" PRId64
1084 " of %s: %s", sectors_to_bytes(sector_num),
1085 filename2, strerror(-ret));
1086 ret = 4;
1087 goto out;
1088 }
1089 ret = compare_sectors(buf1, buf2, nb_sectors, &pnum);
1090 if (ret || pnum != nb_sectors) {
1091 qprintf(quiet, "Content mismatch at offset %" PRId64 "!\n",
1092 sectors_to_bytes(
1093 ret ? sector_num : sector_num + pnum));
1094 ret = 1;
1095 goto out;
1096 }
1097 }
1098 } else {
1099 if (strict) {
1100 ret = 1;
1101 qprintf(quiet, "Strict mode: Offset %" PRId64
1102 " allocation mismatch!\n",
1103 sectors_to_bytes(sector_num));
1104 goto out;
1105 }
1106
1107 if (allocated1) {
1108 ret = check_empty_sectors(bs1, sector_num, nb_sectors,
1109 filename1, buf1, quiet);
1110 } else {
1111 ret = check_empty_sectors(bs2, sector_num, nb_sectors,
1112 filename2, buf1, quiet);
1113 }
1114 if (ret) {
1115 if (ret < 0) {
1116 error_report("Error while reading offset %" PRId64 ": %s",
1117 sectors_to_bytes(sector_num), strerror(-ret));
1118 ret = 4;
1119 }
1120 goto out;
1121 }
1122 }
1123 sector_num += nb_sectors;
1124 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1125 }
1126
1127 if (total_sectors1 != total_sectors2) {
1128 BlockDriverState *bs_over;
1129 int64_t total_sectors_over;
1130 const char *filename_over;
1131
1132 qprintf(quiet, "Warning: Image size mismatch!\n");
1133 if (total_sectors1 > total_sectors2) {
1134 total_sectors_over = total_sectors1;
1135 bs_over = bs1;
1136 filename_over = filename1;
1137 } else {
1138 total_sectors_over = total_sectors2;
1139 bs_over = bs2;
1140 filename_over = filename2;
1141 }
1142
1143 for (;;) {
1144 nb_sectors = sectors_to_process(total_sectors_over, sector_num);
1145 if (nb_sectors <= 0) {
1146 break;
1147 }
1148 ret = bdrv_is_allocated_above(bs_over, NULL, sector_num,
1149 nb_sectors, &pnum);
1150 if (ret < 0) {
1151 ret = 3;
1152 error_report("Sector allocation test failed for %s",
1153 filename_over);
1154 goto out;
1155
1156 }
1157 nb_sectors = pnum;
1158 if (ret) {
1159 ret = check_empty_sectors(bs_over, sector_num, nb_sectors,
1160 filename_over, buf1, quiet);
1161 if (ret) {
1162 if (ret < 0) {
1163 error_report("Error while reading offset %" PRId64
1164 " of %s: %s", sectors_to_bytes(sector_num),
1165 filename_over, strerror(-ret));
1166 ret = 4;
1167 }
1168 goto out;
1169 }
1170 }
1171 sector_num += nb_sectors;
1172 qemu_progress_print(((float) nb_sectors / progress_base)*100, 100);
1173 }
1174 }
1175
1176 qprintf(quiet, "Images are identical.\n");
1177 ret = 0;
1178
1179 out:
1180 bdrv_unref(bs2);
1181 qemu_vfree(buf1);
1182 qemu_vfree(buf2);
1183 out2:
1184 bdrv_unref(bs1);
1185 out3:
1186 qemu_progress_end();
1187 return ret;
1188 }
1189
1190 static int img_convert(int argc, char **argv)
1191 {
1192 int c, n, n1, bs_n, bs_i, compress, cluster_sectors, skip_create;
1193 int64_t ret = 0;
1194 int progress = 0, flags;
1195 const char *fmt, *out_fmt, *cache, *out_baseimg, *out_filename;
1196 BlockDriver *drv, *proto_drv;
1197 BlockDriverState **bs = NULL, *out_bs = NULL;
1198 int64_t total_sectors, nb_sectors, sector_num, bs_offset;
1199 int64_t *bs_sectors = NULL;
1200 uint8_t * buf = NULL;
1201 size_t bufsectors = IO_BUF_SIZE / BDRV_SECTOR_SIZE;
1202 const uint8_t *buf1;
1203 BlockDriverInfo bdi;
1204 QemuOpts *opts = NULL;
1205 QemuOptsList *create_opts = NULL;
1206 const char *out_baseimg_param;
1207 char *options = NULL;
1208 const char *snapshot_name = NULL;
1209 int min_sparse = 8; /* Need at least 4k of zeros for sparse detection */
1210 bool quiet = false;
1211 Error *local_err = NULL;
1212 QemuOpts *sn_opts = NULL;
1213
1214 fmt = NULL;
1215 out_fmt = "raw";
1216 cache = "unsafe";
1217 out_baseimg = NULL;
1218 compress = 0;
1219 skip_create = 0;
1220 for(;;) {
1221 c = getopt(argc, argv, "f:O:B:s:hce6o:pS:t:qnl:");
1222 if (c == -1) {
1223 break;
1224 }
1225 switch(c) {
1226 case '?':
1227 case 'h':
1228 help();
1229 break;
1230 case 'f':
1231 fmt = optarg;
1232 break;
1233 case 'O':
1234 out_fmt = optarg;
1235 break;
1236 case 'B':
1237 out_baseimg = optarg;
1238 break;
1239 case 'c':
1240 compress = 1;
1241 break;
1242 case 'e':
1243 error_report("option -e is deprecated, please use \'-o "
1244 "encryption\' instead!");
1245 ret = -1;
1246 goto fail_getopt;
1247 case '6':
1248 error_report("option -6 is deprecated, please use \'-o "
1249 "compat6\' instead!");
1250 ret = -1;
1251 goto fail_getopt;
1252 case 'o':
1253 if (!is_valid_option_list(optarg)) {
1254 error_report("Invalid option list: %s", optarg);
1255 ret = -1;
1256 goto fail_getopt;
1257 }
1258 if (!options) {
1259 options = g_strdup(optarg);
1260 } else {
1261 char *old_options = options;
1262 options = g_strdup_printf("%s,%s", options, optarg);
1263 g_free(old_options);
1264 }
1265 break;
1266 case 's':
1267 snapshot_name = optarg;
1268 break;
1269 case 'l':
1270 if (strstart(optarg, SNAPSHOT_OPT_BASE, NULL)) {
1271 sn_opts = qemu_opts_parse(&internal_snapshot_opts, optarg, 0);
1272 if (!sn_opts) {
1273 error_report("Failed in parsing snapshot param '%s'",
1274 optarg);
1275 ret = -1;
1276 goto fail_getopt;
1277 }
1278 } else {
1279 snapshot_name = optarg;
1280 }
1281 break;
1282 case 'S':
1283 {
1284 int64_t sval;
1285 char *end;
1286 sval = strtosz_suffix(optarg, &end, STRTOSZ_DEFSUFFIX_B);
1287 if (sval < 0 || *end) {
1288 error_report("Invalid minimum zero buffer size for sparse output specified");
1289 ret = -1;
1290 goto fail_getopt;
1291 }
1292
1293 min_sparse = sval / BDRV_SECTOR_SIZE;
1294 break;
1295 }
1296 case 'p':
1297 progress = 1;
1298 break;
1299 case 't':
1300 cache = optarg;
1301 break;
1302 case 'q':
1303 quiet = true;
1304 break;
1305 case 'n':
1306 skip_create = 1;
1307 break;
1308 }
1309 }
1310
1311 /* Initialize before goto out */
1312 if (quiet) {
1313 progress = 0;
1314 }
1315 qemu_progress_init(progress, 1.0);
1316
1317
1318 bs_n = argc - optind - 1;
1319 out_filename = bs_n >= 1 ? argv[argc - 1] : NULL;
1320
1321 if (options && has_help_option(options)) {
1322 ret = print_block_option_help(out_filename, out_fmt);
1323 goto out;
1324 }
1325
1326 if (bs_n < 1) {
1327 error_exit("Must specify image file name");
1328 }
1329
1330
1331 if (bs_n > 1 && out_baseimg) {
1332 error_report("-B makes no sense when concatenating multiple input "
1333 "images");
1334 ret = -1;
1335 goto out;
1336 }
1337
1338 qemu_progress_print(0, 100);
1339
1340 bs = g_new0(BlockDriverState *, bs_n);
1341 bs_sectors = g_new(int64_t, bs_n);
1342
1343 total_sectors = 0;
1344 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1345 char *id = bs_n > 1 ? g_strdup_printf("source %d", bs_i)
1346 : g_strdup("source");
1347 bs[bs_i] = bdrv_new_open(id, argv[optind + bs_i], fmt, BDRV_O_FLAGS,
1348 true, quiet);
1349 g_free(id);
1350 if (!bs[bs_i]) {
1351 error_report("Could not open '%s'", argv[optind + bs_i]);
1352 ret = -1;
1353 goto out;
1354 }
1355 bs_sectors[bs_i] = bdrv_nb_sectors(bs[bs_i]);
1356 if (bs_sectors[bs_i] < 0) {
1357 error_report("Could not get size of %s: %s",
1358 argv[optind + bs_i], strerror(-bs_sectors[bs_i]));
1359 ret = -1;
1360 goto out;
1361 }
1362 total_sectors += bs_sectors[bs_i];
1363 }
1364
1365 if (sn_opts) {
1366 ret = bdrv_snapshot_load_tmp(bs[0],
1367 qemu_opt_get(sn_opts, SNAPSHOT_OPT_ID),
1368 qemu_opt_get(sn_opts, SNAPSHOT_OPT_NAME),
1369 &local_err);
1370 } else if (snapshot_name != NULL) {
1371 if (bs_n > 1) {
1372 error_report("No support for concatenating multiple snapshot");
1373 ret = -1;
1374 goto out;
1375 }
1376
1377 bdrv_snapshot_load_tmp_by_id_or_name(bs[0], snapshot_name, &local_err);
1378 }
1379 if (local_err) {
1380 error_report("Failed to load snapshot: %s",
1381 error_get_pretty(local_err));
1382 error_free(local_err);
1383 ret = -1;
1384 goto out;
1385 }
1386
1387 /* Find driver and parse its options */
1388 drv = bdrv_find_format(out_fmt);
1389 if (!drv) {
1390 error_report("Unknown file format '%s'", out_fmt);
1391 ret = -1;
1392 goto out;
1393 }
1394
1395 proto_drv = bdrv_find_protocol(out_filename, true);
1396 if (!proto_drv) {
1397 error_report("Unknown protocol '%s'", out_filename);
1398 ret = -1;
1399 goto out;
1400 }
1401
1402 create_opts = qemu_opts_append(create_opts, drv->create_opts);
1403 create_opts = qemu_opts_append(create_opts, proto_drv->create_opts);
1404
1405 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
1406 if (options && qemu_opts_do_parse(opts, options, NULL)) {
1407 error_report("Invalid options for file format '%s'", out_fmt);
1408 ret = -1;
1409 goto out;
1410 }
1411
1412 qemu_opt_set_number(opts, BLOCK_OPT_SIZE, total_sectors * 512);
1413 ret = add_old_style_options(out_fmt, opts, out_baseimg, NULL);
1414 if (ret < 0) {
1415 goto out;
1416 }
1417
1418 /* Get backing file name if -o backing_file was used */
1419 out_baseimg_param = qemu_opt_get(opts, BLOCK_OPT_BACKING_FILE);
1420 if (out_baseimg_param) {
1421 out_baseimg = out_baseimg_param;
1422 }
1423
1424 /* Check if compression is supported */
1425 if (compress) {
1426 bool encryption =
1427 qemu_opt_get_bool(opts, BLOCK_OPT_ENCRYPT, false);
1428 const char *preallocation =
1429 qemu_opt_get(opts, BLOCK_OPT_PREALLOC);
1430
1431 if (!drv->bdrv_write_compressed) {
1432 error_report("Compression not supported for this file format");
1433 ret = -1;
1434 goto out;
1435 }
1436
1437 if (encryption) {
1438 error_report("Compression and encryption not supported at "
1439 "the same time");
1440 ret = -1;
1441 goto out;
1442 }
1443
1444 if (preallocation
1445 && strcmp(preallocation, "off"))
1446 {
1447 error_report("Compression and preallocation not supported at "
1448 "the same time");
1449 ret = -1;
1450 goto out;
1451 }
1452 }
1453
1454 if (!skip_create) {
1455 /* Create the new image */
1456 ret = bdrv_create(drv, out_filename, opts, &local_err);
1457 if (ret < 0) {
1458 error_report("%s: error while converting %s: %s",
1459 out_filename, out_fmt, error_get_pretty(local_err));
1460 error_free(local_err);
1461 goto out;
1462 }
1463 }
1464
1465 flags = min_sparse ? (BDRV_O_RDWR | BDRV_O_UNMAP) : BDRV_O_RDWR;
1466 ret = bdrv_parse_cache_flags(cache, &flags);
1467 if (ret < 0) {
1468 error_report("Invalid cache option: %s", cache);
1469 goto out;
1470 }
1471
1472 out_bs = bdrv_new_open("target", out_filename, out_fmt, flags, true, quiet);
1473 if (!out_bs) {
1474 ret = -1;
1475 goto out;
1476 }
1477
1478 bs_i = 0;
1479 bs_offset = 0;
1480
1481 /* increase bufsectors from the default 4096 (2M) if opt_transfer_length
1482 * or discard_alignment of the out_bs is greater. Limit to 32768 (16MB)
1483 * as maximum. */
1484 bufsectors = MIN(32768,
1485 MAX(bufsectors, MAX(out_bs->bl.opt_transfer_length,
1486 out_bs->bl.discard_alignment))
1487 );
1488
1489 buf = qemu_blockalign(out_bs, bufsectors * BDRV_SECTOR_SIZE);
1490
1491 if (skip_create) {
1492 int64_t output_sectors = bdrv_nb_sectors(out_bs);
1493 if (output_sectors < 0) {
1494 error_report("unable to get output image length: %s\n",
1495 strerror(-output_sectors));
1496 ret = -1;
1497 goto out;
1498 } else if (output_sectors < total_sectors) {
1499 error_report("output file is smaller than input file");
1500 ret = -1;
1501 goto out;
1502 }
1503 }
1504
1505 cluster_sectors = 0;
1506 ret = bdrv_get_info(out_bs, &bdi);
1507 if (ret < 0) {
1508 if (compress) {
1509 error_report("could not get block driver info");
1510 goto out;
1511 }
1512 } else {
1513 compress = compress || bdi.needs_compressed_writes;
1514 cluster_sectors = bdi.cluster_size / BDRV_SECTOR_SIZE;
1515 }
1516
1517 if (compress) {
1518 if (cluster_sectors <= 0 || cluster_sectors > bufsectors) {
1519 error_report("invalid cluster size");
1520 ret = -1;
1521 goto out;
1522 }
1523 sector_num = 0;
1524
1525 nb_sectors = total_sectors;
1526
1527 for(;;) {
1528 int64_t bs_num;
1529 int remainder;
1530 uint8_t *buf2;
1531
1532 nb_sectors = total_sectors - sector_num;
1533 if (nb_sectors <= 0)
1534 break;
1535 if (nb_sectors >= cluster_sectors)
1536 n = cluster_sectors;
1537 else
1538 n = nb_sectors;
1539
1540 bs_num = sector_num - bs_offset;
1541 assert (bs_num >= 0);
1542 remainder = n;
1543 buf2 = buf;
1544 while (remainder > 0) {
1545 int nlow;
1546 while (bs_num == bs_sectors[bs_i]) {
1547 bs_offset += bs_sectors[bs_i];
1548 bs_i++;
1549 assert (bs_i < bs_n);
1550 bs_num = 0;
1551 /* printf("changing part: sector_num=%" PRId64 ", "
1552 "bs_i=%d, bs_offset=%" PRId64 ", bs_sectors=%" PRId64
1553 "\n", sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1554 }
1555 assert (bs_num < bs_sectors[bs_i]);
1556
1557 nlow = remainder > bs_sectors[bs_i] - bs_num
1558 ? bs_sectors[bs_i] - bs_num : remainder;
1559
1560 ret = bdrv_read(bs[bs_i], bs_num, buf2, nlow);
1561 if (ret < 0) {
1562 error_report("error while reading sector %" PRId64 ": %s",
1563 bs_num, strerror(-ret));
1564 goto out;
1565 }
1566
1567 buf2 += nlow * 512;
1568 bs_num += nlow;
1569
1570 remainder -= nlow;
1571 }
1572 assert (remainder == 0);
1573
1574 if (!buffer_is_zero(buf, n * BDRV_SECTOR_SIZE)) {
1575 ret = bdrv_write_compressed(out_bs, sector_num, buf, n);
1576 if (ret != 0) {
1577 error_report("error while compressing sector %" PRId64
1578 ": %s", sector_num, strerror(-ret));
1579 goto out;
1580 }
1581 }
1582 sector_num += n;
1583 qemu_progress_print(100.0 * sector_num / total_sectors, 0);
1584 }
1585 /* signal EOF to align */
1586 bdrv_write_compressed(out_bs, 0, NULL, 0);
1587 } else {
1588 int64_t sectors_to_read, sectors_read, sector_num_next_status;
1589 bool count_allocated_sectors;
1590 int has_zero_init = min_sparse ? bdrv_has_zero_init(out_bs) : 0;
1591
1592 if (!has_zero_init && bdrv_can_write_zeroes_with_unmap(out_bs)) {
1593 ret = bdrv_make_zero(out_bs, BDRV_REQ_MAY_UNMAP);
1594 if (ret < 0) {
1595 goto out;
1596 }
1597 has_zero_init = 1;
1598 }
1599
1600 sectors_to_read = total_sectors;
1601 count_allocated_sectors = progress && (out_baseimg || has_zero_init);
1602 restart:
1603 sector_num = 0; // total number of sectors converted so far
1604 sectors_read = 0;
1605 sector_num_next_status = 0;
1606
1607 for(;;) {
1608 nb_sectors = total_sectors - sector_num;
1609 if (nb_sectors <= 0) {
1610 if (count_allocated_sectors) {
1611 sectors_to_read = sectors_read;
1612 count_allocated_sectors = false;
1613 goto restart;
1614 }
1615 ret = 0;
1616 break;
1617 }
1618
1619 while (sector_num - bs_offset >= bs_sectors[bs_i]) {
1620 bs_offset += bs_sectors[bs_i];
1621 bs_i ++;
1622 assert (bs_i < bs_n);
1623 /* printf("changing part: sector_num=%" PRId64 ", bs_i=%d, "
1624 "bs_offset=%" PRId64 ", bs_sectors=%" PRId64 "\n",
1625 sector_num, bs_i, bs_offset, bs_sectors[bs_i]); */
1626 }
1627
1628 if ((out_baseimg || has_zero_init) &&
1629 sector_num >= sector_num_next_status) {
1630 n = nb_sectors > INT_MAX ? INT_MAX : nb_sectors;
1631 ret = bdrv_get_block_status(bs[bs_i], sector_num - bs_offset,
1632 n, &n1);
1633 if (ret < 0) {
1634 error_report("error while reading block status of sector %"
1635 PRId64 ": %s", sector_num - bs_offset,
1636 strerror(-ret));
1637 goto out;
1638 }
1639 /* If the output image is zero initialized, we are not working
1640 * on a shared base and the input is zero we can skip the next
1641 * n1 sectors */
1642 if (has_zero_init && !out_baseimg && (ret & BDRV_BLOCK_ZERO)) {
1643 sector_num += n1;
1644 continue;
1645 }
1646 /* If the output image is being created as a copy on write
1647 * image, assume that sectors which are unallocated in the
1648 * input image are present in both the output's and input's
1649 * base images (no need to copy them). */
1650 if (out_baseimg) {
1651 if (!(ret & BDRV_BLOCK_DATA)) {
1652 sector_num += n1;
1653 continue;
1654 }
1655 /* The next 'n1' sectors are allocated in the input image.
1656 * Copy only those as they may be followed by unallocated
1657 * sectors. */
1658 nb_sectors = n1;
1659 }
1660 /* avoid redundant callouts to get_block_status */
1661 sector_num_next_status = sector_num + n1;
1662 }
1663
1664 n = MIN(nb_sectors, bufsectors);
1665
1666 /* round down request length to an aligned sector, but
1667 * do not bother doing this on short requests. They happen
1668 * when we found an all-zero area, and the next sector to
1669 * write will not be sector_num + n. */
1670 if (cluster_sectors > 0 && n >= cluster_sectors) {
1671 int64_t next_aligned_sector = (sector_num + n);
1672 next_aligned_sector -= next_aligned_sector % cluster_sectors;
1673 if (sector_num + n > next_aligned_sector) {
1674 n = next_aligned_sector - sector_num;
1675 }
1676 }
1677
1678 n = MIN(n, bs_sectors[bs_i] - (sector_num - bs_offset));
1679
1680 sectors_read += n;
1681 if (count_allocated_sectors) {
1682 sector_num += n;
1683 continue;
1684 }
1685
1686 n1 = n;
1687 ret = bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n);
1688 if (ret < 0) {
1689 error_report("error while reading sector %" PRId64 ": %s",
1690 sector_num - bs_offset, strerror(-ret));
1691 goto out;
1692 }
1693 /* NOTE: at the same time we convert, we do not write zero
1694 sectors to have a chance to compress the image. Ideally, we
1695 should add a specific call to have the info to go faster */
1696 buf1 = buf;
1697 while (n > 0) {
1698 if (!has_zero_init ||
1699 is_allocated_sectors_min(buf1, n, &n1, min_sparse)) {
1700 ret = bdrv_write(out_bs, sector_num, buf1, n1);
1701 if (ret < 0) {
1702 error_report("error while writing sector %" PRId64
1703 ": %s", sector_num, strerror(-ret));
1704 goto out;
1705 }
1706 }
1707 sector_num += n1;
1708 n -= n1;
1709 buf1 += n1 * 512;
1710 }
1711 qemu_progress_print(100.0 * sectors_read / sectors_to_read, 0);
1712 }
1713 }
1714 out:
1715 if (!ret) {
1716 qemu_progress_print(100, 0);
1717 }
1718 qemu_progress_end();
1719 qemu_opts_del(opts);
1720 qemu_opts_free(create_opts);
1721 qemu_vfree(buf);
1722 if (sn_opts) {
1723 qemu_opts_del(sn_opts);
1724 }
1725 if (out_bs) {
1726 bdrv_unref(out_bs);
1727 }
1728 if (bs) {
1729 for (bs_i = 0; bs_i < bs_n; bs_i++) {
1730 if (bs[bs_i]) {
1731 bdrv_unref(bs[bs_i]);
1732 }
1733 }
1734 g_free(bs);
1735 }
1736 g_free(bs_sectors);
1737 fail_getopt:
1738 g_free(options);
1739
1740 if (ret) {
1741 return 1;
1742 }
1743 return 0;
1744 }
1745
1746
1747 static void dump_snapshots(BlockDriverState *bs)
1748 {
1749 QEMUSnapshotInfo *sn_tab, *sn;
1750 int nb_sns, i;
1751
1752 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
1753 if (nb_sns <= 0)
1754 return;
1755 printf("Snapshot list:\n");
1756 bdrv_snapshot_dump(fprintf, stdout, NULL);
1757 printf("\n");
1758 for(i = 0; i < nb_sns; i++) {
1759 sn = &sn_tab[i];
1760 bdrv_snapshot_dump(fprintf, stdout, sn);
1761 printf("\n");
1762 }
1763 g_free(sn_tab);
1764 }
1765
1766 static void dump_json_image_info_list(ImageInfoList *list)
1767 {
1768 Error *local_err = NULL;
1769 QString *str;
1770 QmpOutputVisitor *ov = qmp_output_visitor_new();
1771 QObject *obj;
1772 visit_type_ImageInfoList(qmp_output_get_visitor(ov),
1773 &list, NULL, &local_err);
1774 obj = qmp_output_get_qobject(ov);
1775 str = qobject_to_json_pretty(obj);
1776 assert(str != NULL);
1777 printf("%s\n", qstring_get_str(str));
1778 qobject_decref(obj);
1779 qmp_output_visitor_cleanup(ov);
1780 QDECREF(str);
1781 }
1782
1783 static void dump_json_image_info(ImageInfo *info)
1784 {
1785 Error *local_err = NULL;
1786 QString *str;
1787 QmpOutputVisitor *ov = qmp_output_visitor_new();
1788 QObject *obj;
1789 visit_type_ImageInfo(qmp_output_get_visitor(ov),
1790 &info, NULL, &local_err);
1791 obj = qmp_output_get_qobject(ov);
1792 str = qobject_to_json_pretty(obj);
1793 assert(str != NULL);
1794 printf("%s\n", qstring_get_str(str));
1795 qobject_decref(obj);
1796 qmp_output_visitor_cleanup(ov);
1797 QDECREF(str);
1798 }
1799
1800 static void dump_human_image_info_list(ImageInfoList *list)
1801 {
1802 ImageInfoList *elem;
1803 bool delim = false;
1804
1805 for (elem = list; elem; elem = elem->next) {
1806 if (delim) {
1807 printf("\n");
1808 }
1809 delim = true;
1810
1811 bdrv_image_info_dump(fprintf, stdout, elem->value);
1812 }
1813 }
1814
1815 static gboolean str_equal_func(gconstpointer a, gconstpointer b)
1816 {
1817 return strcmp(a, b) == 0;
1818 }
1819
1820 /**
1821 * Open an image file chain and return an ImageInfoList
1822 *
1823 * @filename: topmost image filename
1824 * @fmt: topmost image format (may be NULL to autodetect)
1825 * @chain: true - enumerate entire backing file chain
1826 * false - only topmost image file
1827 *
1828 * Returns a list of ImageInfo objects or NULL if there was an error opening an
1829 * image file. If there was an error a message will have been printed to
1830 * stderr.
1831 */
1832 static ImageInfoList *collect_image_info_list(const char *filename,
1833 const char *fmt,
1834 bool chain)
1835 {
1836 ImageInfoList *head = NULL;
1837 ImageInfoList **last = &head;
1838 GHashTable *filenames;
1839 Error *err = NULL;
1840
1841 filenames = g_hash_table_new_full(g_str_hash, str_equal_func, NULL, NULL);
1842
1843 while (filename) {
1844 BlockDriverState *bs;
1845 ImageInfo *info;
1846 ImageInfoList *elem;
1847
1848 if (g_hash_table_lookup_extended(filenames, filename, NULL, NULL)) {
1849 error_report("Backing file '%s' creates an infinite loop.",
1850 filename);
1851 goto err;
1852 }
1853 g_hash_table_insert(filenames, (gpointer)filename, NULL);
1854
1855 bs = bdrv_new_open("image", filename, fmt,
1856 BDRV_O_FLAGS | BDRV_O_NO_BACKING, false, false);
1857 if (!bs) {
1858 goto err;
1859 }
1860
1861 bdrv_query_image_info(bs, &info, &err);
1862 if (err) {
1863 error_report("%s", error_get_pretty(err));
1864 error_free(err);
1865 bdrv_unref(bs);
1866 goto err;
1867 }
1868
1869 elem = g_new0(ImageInfoList, 1);
1870 elem->value = info;
1871 *last = elem;
1872 last = &elem->next;
1873
1874 bdrv_unref(bs);
1875
1876 filename = fmt = NULL;
1877 if (chain) {
1878 if (info->has_full_backing_filename) {
1879 filename = info->full_backing_filename;
1880 } else if (info->has_backing_filename) {
1881 filename = info->backing_filename;
1882 }
1883 if (info->has_backing_filename_format) {
1884 fmt = info->backing_filename_format;
1885 }
1886 }
1887 }
1888 g_hash_table_destroy(filenames);
1889 return head;
1890
1891 err:
1892 qapi_free_ImageInfoList(head);
1893 g_hash_table_destroy(filenames);
1894 return NULL;
1895 }
1896
1897 static int img_info(int argc, char **argv)
1898 {
1899 int c;
1900 OutputFormat output_format = OFORMAT_HUMAN;
1901 bool chain = false;
1902 const char *filename, *fmt, *output;
1903 ImageInfoList *list;
1904
1905 fmt = NULL;
1906 output = NULL;
1907 for(;;) {
1908 int option_index = 0;
1909 static const struct option long_options[] = {
1910 {"help", no_argument, 0, 'h'},
1911 {"format", required_argument, 0, 'f'},
1912 {"output", required_argument, 0, OPTION_OUTPUT},
1913 {"backing-chain", no_argument, 0, OPTION_BACKING_CHAIN},
1914 {0, 0, 0, 0}
1915 };
1916 c = getopt_long(argc, argv, "f:h",
1917 long_options, &option_index);
1918 if (c == -1) {
1919 break;
1920 }
1921 switch(c) {
1922 case '?':
1923 case 'h':
1924 help();
1925 break;
1926 case 'f':
1927 fmt = optarg;
1928 break;
1929 case OPTION_OUTPUT:
1930 output = optarg;
1931 break;
1932 case OPTION_BACKING_CHAIN:
1933 chain = true;
1934 break;
1935 }
1936 }
1937 if (optind != argc - 1) {
1938 error_exit("Expecting one image file name");
1939 }
1940 filename = argv[optind++];
1941
1942 if (output && !strcmp(output, "json")) {
1943 output_format = OFORMAT_JSON;
1944 } else if (output && !strcmp(output, "human")) {
1945 output_format = OFORMAT_HUMAN;
1946 } else if (output) {
1947 error_report("--output must be used with human or json as argument.");
1948 return 1;
1949 }
1950
1951 list = collect_image_info_list(filename, fmt, chain);
1952 if (!list) {
1953 return 1;
1954 }
1955
1956 switch (output_format) {
1957 case OFORMAT_HUMAN:
1958 dump_human_image_info_list(list);
1959 break;
1960 case OFORMAT_JSON:
1961 if (chain) {
1962 dump_json_image_info_list(list);
1963 } else {
1964 dump_json_image_info(list->value);
1965 }
1966 break;
1967 }
1968
1969 qapi_free_ImageInfoList(list);
1970 return 0;
1971 }
1972
1973
1974 typedef struct MapEntry {
1975 int flags;
1976 int depth;
1977 int64_t start;
1978 int64_t length;
1979 int64_t offset;
1980 BlockDriverState *bs;
1981 } MapEntry;
1982
1983 static void dump_map_entry(OutputFormat output_format, MapEntry *e,
1984 MapEntry *next)
1985 {
1986 switch (output_format) {
1987 case OFORMAT_HUMAN:
1988 if ((e->flags & BDRV_BLOCK_DATA) &&
1989 !(e->flags & BDRV_BLOCK_OFFSET_VALID)) {
1990 error_report("File contains external, encrypted or compressed clusters.");
1991 exit(1);
1992 }
1993 if ((e->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) == BDRV_BLOCK_DATA) {
1994 printf("%#-16"PRIx64"%#-16"PRIx64"%#-16"PRIx64"%s\n",
1995 e->start, e->length, e->offset, e->bs->filename);
1996 }
1997 /* This format ignores the distinction between 0, ZERO and ZERO|DATA.
1998 * Modify the flags here to allow more coalescing.
1999 */
2000 if (next &&
2001 (next->flags & (BDRV_BLOCK_DATA|BDRV_BLOCK_ZERO)) != BDRV_BLOCK_DATA) {
2002 next->flags &= ~BDRV_BLOCK_DATA;
2003 next->flags |= BDRV_BLOCK_ZERO;
2004 }
2005 break;
2006 case OFORMAT_JSON:
2007 printf("%s{ \"start\": %"PRId64", \"length\": %"PRId64", \"depth\": %d,"
2008 " \"zero\": %s, \"data\": %s",
2009 (e->start == 0 ? "[" : ",\n"),
2010 e->start, e->length, e->depth,
2011 (e->flags & BDRV_BLOCK_ZERO) ? "true" : "false",
2012 (e->flags & BDRV_BLOCK_DATA) ? "true" : "false");
2013 if (e->flags & BDRV_BLOCK_OFFSET_VALID) {
2014 printf(", \"offset\": %"PRId64"", e->offset);
2015 }
2016 putchar('}');
2017
2018 if (!next) {
2019 printf("]\n");
2020 }
2021 break;
2022 }
2023 }
2024
2025 static int get_block_status(BlockDriverState *bs, int64_t sector_num,
2026 int nb_sectors, MapEntry *e)
2027 {
2028 int64_t ret;
2029 int depth;
2030
2031 /* As an optimization, we could cache the current range of unallocated
2032 * clusters in each file of the chain, and avoid querying the same
2033 * range repeatedly.
2034 */
2035
2036 depth = 0;
2037 for (;;) {
2038 ret = bdrv_get_block_status(bs, sector_num, nb_sectors, &nb_sectors);
2039 if (ret < 0) {
2040 return ret;
2041 }
2042 assert(nb_sectors);
2043 if (ret & (BDRV_BLOCK_ZERO|BDRV_BLOCK_DATA)) {
2044 break;
2045 }
2046 bs = bs->backing_hd;
2047 if (bs == NULL) {
2048 ret = 0;
2049 break;
2050 }
2051
2052 depth++;
2053 }
2054
2055 e->start = sector_num * BDRV_SECTOR_SIZE;
2056 e->length = nb_sectors * BDRV_SECTOR_SIZE;
2057 e->flags = ret & ~BDRV_BLOCK_OFFSET_MASK;
2058 e->offset = ret & BDRV_BLOCK_OFFSET_MASK;
2059 e->depth = depth;
2060 e->bs = bs;
2061 return 0;
2062 }
2063
2064 static int img_map(int argc, char **argv)
2065 {
2066 int c;
2067 OutputFormat output_format = OFORMAT_HUMAN;
2068 BlockDriverState *bs;
2069 const char *filename, *fmt, *output;
2070 int64_t length;
2071 MapEntry curr = { .length = 0 }, next;
2072 int ret = 0;
2073
2074 fmt = NULL;
2075 output = NULL;
2076 for (;;) {
2077 int option_index = 0;
2078 static const struct option long_options[] = {
2079 {"help", no_argument, 0, 'h'},
2080 {"format", required_argument, 0, 'f'},
2081 {"output", required_argument, 0, OPTION_OUTPUT},
2082 {0, 0, 0, 0}
2083 };
2084 c = getopt_long(argc, argv, "f:h",
2085 long_options, &option_index);
2086 if (c == -1) {
2087 break;
2088 }
2089 switch (c) {
2090 case '?':
2091 case 'h':
2092 help();
2093 break;
2094 case 'f':
2095 fmt = optarg;
2096 break;
2097 case OPTION_OUTPUT:
2098 output = optarg;
2099 break;
2100 }
2101 }
2102 if (optind != argc - 1) {
2103 error_exit("Expecting one image file name");
2104 }
2105 filename = argv[optind];
2106
2107 if (output && !strcmp(output, "json")) {
2108 output_format = OFORMAT_JSON;
2109 } else if (output && !strcmp(output, "human")) {
2110 output_format = OFORMAT_HUMAN;
2111 } else if (output) {
2112 error_report("--output must be used with human or json as argument.");
2113 return 1;
2114 }
2115
2116 bs = bdrv_new_open("image", filename, fmt, BDRV_O_FLAGS, true, false);
2117 if (!bs) {
2118 return 1;
2119 }
2120
2121 if (output_format == OFORMAT_HUMAN) {
2122 printf("%-16s%-16s%-16s%s\n", "Offset", "Length", "Mapped to", "File");
2123 }
2124
2125 length = bdrv_getlength(bs);
2126 while (curr.start + curr.length < length) {
2127 int64_t nsectors_left;
2128 int64_t sector_num;
2129 int n;
2130
2131 sector_num = (curr.start + curr.length) >> BDRV_SECTOR_BITS;
2132
2133 /* Probe up to 1 GiB at a time. */
2134 nsectors_left = DIV_ROUND_UP(length, BDRV_SECTOR_SIZE) - sector_num;
2135 n = MIN(1 << (30 - BDRV_SECTOR_BITS), nsectors_left);
2136 ret = get_block_status(bs, sector_num, n, &next);
2137
2138 if (ret < 0) {
2139 error_report("Could not read file metadata: %s", strerror(-ret));
2140 goto out;
2141 }
2142
2143 if (curr.length != 0 && curr.flags == next.flags &&
2144 curr.depth == next.depth &&
2145 ((curr.flags & BDRV_BLOCK_OFFSET_VALID) == 0 ||
2146 curr.offset + curr.length == next.offset)) {
2147 curr.length += next.length;
2148 continue;
2149 }
2150
2151 if (curr.length > 0) {
2152 dump_map_entry(output_format, &curr, &next);
2153 }
2154 curr = next;
2155 }
2156
2157 dump_map_entry(output_format, &curr, NULL);
2158
2159 out:
2160 bdrv_unref(bs);
2161 return ret < 0;
2162 }
2163
2164 #define SNAPSHOT_LIST 1
2165 #define SNAPSHOT_CREATE 2
2166 #define SNAPSHOT_APPLY 3
2167 #define SNAPSHOT_DELETE 4
2168
2169 static int img_snapshot(int argc, char **argv)
2170 {
2171 BlockDriverState *bs;
2172 QEMUSnapshotInfo sn;
2173 char *filename, *snapshot_name = NULL;
2174 int c, ret = 0, bdrv_oflags;
2175 int action = 0;
2176 qemu_timeval tv;
2177 bool quiet = false;
2178 Error *err = NULL;
2179
2180 bdrv_oflags = BDRV_O_FLAGS | BDRV_O_RDWR;
2181 /* Parse commandline parameters */
2182 for(;;) {
2183 c = getopt(argc, argv, "la:c:d:hq");
2184 if (c == -1) {
2185 break;
2186 }
2187 switch(c) {
2188 case '?':
2189 case 'h':
2190 help();
2191 return 0;
2192 case 'l':
2193 if (action) {
2194 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2195 return 0;
2196 }
2197 action = SNAPSHOT_LIST;
2198 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
2199 break;
2200 case 'a':
2201 if (action) {
2202 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2203 return 0;
2204 }
2205 action = SNAPSHOT_APPLY;
2206 snapshot_name = optarg;
2207 break;
2208 case 'c':
2209 if (action) {
2210 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2211 return 0;
2212 }
2213 action = SNAPSHOT_CREATE;
2214 snapshot_name = optarg;
2215 break;
2216 case 'd':
2217 if (action) {
2218 error_exit("Cannot mix '-l', '-a', '-c', '-d'");
2219 return 0;
2220 }
2221 action = SNAPSHOT_DELETE;
2222 snapshot_name = optarg;
2223 break;
2224 case 'q':
2225 quiet = true;
2226 break;
2227 }
2228 }
2229
2230 if (optind != argc - 1) {
2231 error_exit("Expecting one image file name");
2232 }
2233 filename = argv[optind++];
2234
2235 /* Open the image */
2236 bs = bdrv_new_open("image", filename, NULL, bdrv_oflags, true, quiet);
2237 if (!bs) {
2238 return 1;
2239 }
2240
2241 /* Perform the requested action */
2242 switch(action) {
2243 case SNAPSHOT_LIST:
2244 dump_snapshots(bs);
2245 break;
2246
2247 case SNAPSHOT_CREATE:
2248 memset(&sn, 0, sizeof(sn));
2249 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
2250
2251 qemu_gettimeofday(&tv);
2252 sn.date_sec = tv.tv_sec;
2253 sn.date_nsec = tv.tv_usec * 1000;
2254
2255 ret = bdrv_snapshot_create(bs, &sn);
2256 if (ret) {
2257 error_report("Could not create snapshot '%s': %d (%s)",
2258 snapshot_name, ret, strerror(-ret));
2259 }
2260 break;
2261
2262 case SNAPSHOT_APPLY:
2263 ret = bdrv_snapshot_goto(bs, snapshot_name);
2264 if (ret) {
2265 error_report("Could not apply snapshot '%s': %d (%s)",
2266 snapshot_name, ret, strerror(-ret));
2267 }
2268 break;
2269
2270 case SNAPSHOT_DELETE:
2271 bdrv_snapshot_delete_by_id_or_name(bs, snapshot_name, &err);
2272 if (err) {
2273 error_report("Could not delete snapshot '%s': (%s)",
2274 snapshot_name, error_get_pretty(err));
2275 error_free(err);
2276 ret = 1;
2277 }
2278 break;
2279 }
2280
2281 /* Cleanup */
2282 bdrv_unref(bs);
2283 if (ret) {
2284 return 1;
2285 }
2286 return 0;
2287 }
2288
2289 static int img_rebase(int argc, char **argv)
2290 {
2291 BlockDriverState *bs, *bs_old_backing = NULL, *bs_new_backing = NULL;
2292 BlockDriver *old_backing_drv, *new_backing_drv;
2293 char *filename;
2294 const char *fmt, *cache, *out_basefmt, *out_baseimg;
2295 int c, flags, ret;
2296 int unsafe = 0;
2297 int progress = 0;
2298 bool quiet = false;
2299 Error *local_err = NULL;
2300
2301 /* Parse commandline parameters */
2302 fmt = NULL;
2303 cache = BDRV_DEFAULT_CACHE;
2304 out_baseimg = NULL;
2305 out_basefmt = NULL;
2306 for(;;) {
2307 c = getopt(argc, argv, "uhf:F:b:pt:q");
2308 if (c == -1) {
2309 break;
2310 }
2311 switch(c) {
2312 case '?':
2313 case 'h':
2314 help();
2315 return 0;
2316 case 'f':
2317 fmt = optarg;
2318 break;
2319 case 'F':
2320 out_basefmt = optarg;
2321 break;
2322 case 'b':
2323 out_baseimg = optarg;
2324 break;
2325 case 'u':
2326 unsafe = 1;
2327 break;
2328 case 'p':
2329 progress = 1;
2330 break;
2331 case 't':
2332 cache = optarg;
2333 break;
2334 case 'q':
2335 quiet = true;
2336 break;
2337 }
2338 }
2339
2340 if (quiet) {
2341 progress = 0;
2342 }
2343
2344 if (optind != argc - 1) {
2345 error_exit("Expecting one image file name");
2346 }
2347 if (!unsafe && !out_baseimg) {
2348 error_exit("Must specify backing file (-b) or use unsafe mode (-u)");
2349 }
2350 filename = argv[optind++];
2351
2352 qemu_progress_init(progress, 2.0);
2353 qemu_progress_print(0, 100);
2354
2355 flags = BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
2356 ret = bdrv_parse_cache_flags(cache, &flags);
2357 if (ret < 0) {
2358 error_report("Invalid cache option: %s", cache);
2359 return -1;
2360 }
2361
2362 /*
2363 * Open the images.
2364 *
2365 * Ignore the old backing file for unsafe rebase in case we want to correct
2366 * the reference to a renamed or moved backing file.
2367 */
2368 bs = bdrv_new_open("image", filename, fmt, flags, true, quiet);
2369 if (!bs) {
2370 return 1;
2371 }
2372
2373 /* Find the right drivers for the backing files */
2374 old_backing_drv = NULL;
2375 new_backing_drv = NULL;
2376
2377 if (!unsafe && bs->backing_format[0] != '\0') {
2378 old_backing_drv = bdrv_find_format(bs->backing_format);
2379 if (old_backing_drv == NULL) {
2380 error_report("Invalid format name: '%s'", bs->backing_format);
2381 ret = -1;
2382 goto out;
2383 }
2384 }
2385
2386 if (out_basefmt != NULL) {
2387 new_backing_drv = bdrv_find_format(out_basefmt);
2388 if (new_backing_drv == NULL) {
2389 error_report("Invalid format name: '%s'", out_basefmt);
2390 ret = -1;
2391 goto out;
2392 }
2393 }
2394
2395 /* For safe rebasing we need to compare old and new backing file */
2396 if (unsafe) {
2397 /* Make the compiler happy */
2398 bs_old_backing = NULL;
2399 bs_new_backing = NULL;
2400 } else {
2401 char backing_name[1024];
2402
2403 bs_old_backing = bdrv_new("old_backing", &error_abort);
2404 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2405 ret = bdrv_open(&bs_old_backing, backing_name, NULL, NULL, BDRV_O_FLAGS,
2406 old_backing_drv, &local_err);
2407 if (ret) {
2408 error_report("Could not open old backing file '%s': %s",
2409 backing_name, error_get_pretty(local_err));
2410 error_free(local_err);
2411 goto out;
2412 }
2413 if (out_baseimg[0]) {
2414 bs_new_backing = bdrv_new("new_backing", &error_abort);
2415 ret = bdrv_open(&bs_new_backing, out_baseimg, NULL, NULL,
2416 BDRV_O_FLAGS, new_backing_drv, &local_err);
2417 if (ret) {
2418 error_report("Could not open new backing file '%s': %s",
2419 out_baseimg, error_get_pretty(local_err));
2420 error_free(local_err);
2421 goto out;
2422 }
2423 }
2424 }
2425
2426 /*
2427 * Check each unallocated cluster in the COW file. If it is unallocated,
2428 * accesses go to the backing file. We must therefore compare this cluster
2429 * in the old and new backing file, and if they differ we need to copy it
2430 * from the old backing file into the COW file.
2431 *
2432 * If qemu-img crashes during this step, no harm is done. The content of
2433 * the image is the same as the original one at any time.
2434 */
2435 if (!unsafe) {
2436 int64_t num_sectors;
2437 int64_t old_backing_num_sectors;
2438 int64_t new_backing_num_sectors = 0;
2439 uint64_t sector;
2440 int n;
2441 uint8_t * buf_old;
2442 uint8_t * buf_new;
2443 float local_progress = 0;
2444
2445 buf_old = qemu_blockalign(bs, IO_BUF_SIZE);
2446 buf_new = qemu_blockalign(bs, IO_BUF_SIZE);
2447
2448 num_sectors = bdrv_nb_sectors(bs);
2449 if (num_sectors < 0) {
2450 error_report("Could not get size of '%s': %s",
2451 filename, strerror(-num_sectors));
2452 ret = -1;
2453 goto out;
2454 }
2455 old_backing_num_sectors = bdrv_nb_sectors(bs_old_backing);
2456 if (old_backing_num_sectors < 0) {
2457 char backing_name[1024];
2458
2459 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
2460 error_report("Could not get size of '%s': %s",
2461 backing_name, strerror(-old_backing_num_sectors));
2462 ret = -1;
2463 goto out;
2464 }
2465 if (bs_new_backing) {
2466 new_backing_num_sectors = bdrv_nb_sectors(bs_new_backing);
2467 if (new_backing_num_sectors < 0) {
2468 error_report("Could not get size of '%s': %s",
2469 out_baseimg, strerror(-new_backing_num_sectors));
2470 ret = -1;
2471 goto out;
2472 }
2473 }
2474
2475 if (num_sectors != 0) {
2476 local_progress = (float)100 /
2477 (num_sectors / MIN(num_sectors, IO_BUF_SIZE / 512));
2478 }
2479
2480 for (sector = 0; sector < num_sectors; sector += n) {
2481
2482 /* How many sectors can we handle with the next read? */
2483 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
2484 n = (IO_BUF_SIZE / 512);
2485 } else {
2486 n = num_sectors - sector;
2487 }
2488
2489 /* If the cluster is allocated, we don't need to take action */
2490 ret = bdrv_is_allocated(bs, sector, n, &n);
2491 if (ret < 0) {
2492 error_report("error while reading image metadata: %s",
2493 strerror(-ret));
2494 goto out;
2495 }
2496 if (ret) {
2497 continue;
2498 }
2499
2500 /*
2501 * Read old and new backing file and take into consideration that
2502 * backing files may be smaller than the COW image.
2503 */
2504 if (sector >= old_backing_num_sectors) {
2505 memset(buf_old, 0, n * BDRV_SECTOR_SIZE);
2506 } else {
2507 if (sector + n > old_backing_num_sectors) {
2508 n = old_backing_num_sectors - sector;
2509 }
2510
2511 ret = bdrv_read(bs_old_backing, sector, buf_old, n);
2512 if (ret < 0) {
2513 error_report("error while reading from old backing file");
2514 goto out;
2515 }
2516 }
2517
2518 if (sector >= new_backing_num_sectors || !bs_new_backing) {
2519 memset(buf_new, 0, n * BDRV_SECTOR_SIZE);
2520 } else {
2521 if (sector + n > new_backing_num_sectors) {
2522 n = new_backing_num_sectors - sector;
2523 }
2524
2525 ret = bdrv_read(bs_new_backing, sector, buf_new, n);
2526 if (ret < 0) {
2527 error_report("error while reading from new backing file");
2528 goto out;
2529 }
2530 }
2531
2532 /* If they differ, we need to write to the COW file */
2533 uint64_t written = 0;
2534
2535 while (written < n) {
2536 int pnum;
2537
2538 if (compare_sectors(buf_old + written * 512,
2539 buf_new + written * 512, n - written, &pnum))
2540 {
2541 ret = bdrv_write(bs, sector + written,
2542 buf_old + written * 512, pnum);
2543 if (ret < 0) {
2544 error_report("Error while writing to COW image: %s",
2545 strerror(-ret));
2546 goto out;
2547 }
2548 }
2549
2550 written += pnum;
2551 }
2552 qemu_progress_print(local_progress, 100);
2553 }
2554
2555 qemu_vfree(buf_old);
2556 qemu_vfree(buf_new);
2557 }
2558
2559 /*
2560 * Change the backing file. All clusters that are different from the old
2561 * backing file are overwritten in the COW file now, so the visible content
2562 * doesn't change when we switch the backing file.
2563 */
2564 if (out_baseimg && *out_baseimg) {
2565 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
2566 } else {
2567 ret = bdrv_change_backing_file(bs, NULL, NULL);
2568 }
2569
2570 if (ret == -ENOSPC) {
2571 error_report("Could not change the backing file to '%s': No "
2572 "space left in the file header", out_baseimg);
2573 } else if (ret < 0) {
2574 error_report("Could not change the backing file to '%s': %s",
2575 out_baseimg, strerror(-ret));
2576 }
2577
2578 qemu_progress_print(100, 0);
2579 /*
2580 * TODO At this point it is possible to check if any clusters that are
2581 * allocated in the COW file are the same in the backing file. If so, they
2582 * could be dropped from the COW file. Don't do this before switching the
2583 * backing file, in case of a crash this would lead to corruption.
2584 */
2585 out:
2586 qemu_progress_end();
2587 /* Cleanup */
2588 if (!unsafe) {
2589 if (bs_old_backing != NULL) {
2590 bdrv_unref(bs_old_backing);
2591 }
2592 if (bs_new_backing != NULL) {
2593 bdrv_unref(bs_new_backing);
2594 }
2595 }
2596
2597 bdrv_unref(bs);
2598 if (ret) {
2599 return 1;
2600 }
2601 return 0;
2602 }
2603
2604 static int img_resize(int argc, char **argv)
2605 {
2606 int c, ret, relative;
2607 const char *filename, *fmt, *size;
2608 int64_t n, total_size;
2609 bool quiet = false;
2610 BlockDriverState *bs = NULL;
2611 QemuOpts *param;
2612 static QemuOptsList resize_options = {
2613 .name = "resize_options",
2614 .head = QTAILQ_HEAD_INITIALIZER(resize_options.head),
2615 .desc = {
2616 {
2617 .name = BLOCK_OPT_SIZE,
2618 .type = QEMU_OPT_SIZE,
2619 .help = "Virtual disk size"
2620 }, {
2621 /* end of list */
2622 }
2623 },
2624 };
2625
2626 /* Remove size from argv manually so that negative numbers are not treated
2627 * as options by getopt. */
2628 if (argc < 3) {
2629 error_exit("Not enough arguments");
2630 return 1;
2631 }
2632
2633 size = argv[--argc];
2634
2635 /* Parse getopt arguments */
2636 fmt = NULL;
2637 for(;;) {
2638 c = getopt(argc, argv, "f:hq");
2639 if (c == -1) {
2640 break;
2641 }
2642 switch(c) {
2643 case '?':
2644 case 'h':
2645 help();
2646 break;
2647 case 'f':
2648 fmt = optarg;
2649 break;
2650 case 'q':
2651 quiet = true;
2652 break;
2653 }
2654 }
2655 if (optind != argc - 1) {
2656 error_exit("Expecting one image file name");
2657 }
2658 filename = argv[optind++];
2659
2660 /* Choose grow, shrink, or absolute resize mode */
2661 switch (size[0]) {
2662 case '+':
2663 relative = 1;
2664 size++;
2665 break;
2666 case '-':
2667 relative = -1;
2668 size++;
2669 break;
2670 default:
2671 relative = 0;
2672 break;
2673 }
2674
2675 /* Parse size */
2676 param = qemu_opts_create(&resize_options, NULL, 0, &error_abort);
2677 if (qemu_opt_set(param, BLOCK_OPT_SIZE, size)) {
2678 /* Error message already printed when size parsing fails */
2679 ret = -1;
2680 qemu_opts_del(param);
2681 goto out;
2682 }
2683 n = qemu_opt_get_size(param, BLOCK_OPT_SIZE, 0);
2684 qemu_opts_del(param);
2685
2686 bs = bdrv_new_open("image", filename, fmt, BDRV_O_FLAGS | BDRV_O_RDWR,
2687 true, quiet);
2688 if (!bs) {
2689 ret = -1;
2690 goto out;
2691 }
2692
2693 if (relative) {
2694 total_size = bdrv_getlength(bs) + n * relative;
2695 } else {
2696 total_size = n;
2697 }
2698 if (total_size <= 0) {
2699 error_report("New image size must be positive");
2700 ret = -1;
2701 goto out;
2702 }
2703
2704 ret = bdrv_truncate(bs, total_size);
2705 switch (ret) {
2706 case 0:
2707 qprintf(quiet, "Image resized.\n");
2708 break;
2709 case -ENOTSUP:
2710 error_report("This image does not support resize");
2711 break;
2712 case -EACCES:
2713 error_report("Image is read-only");
2714 break;
2715 default:
2716 error_report("Error resizing image (%d)", -ret);
2717 break;
2718 }
2719 out:
2720 if (bs) {
2721 bdrv_unref(bs);
2722 }
2723 if (ret) {
2724 return 1;
2725 }
2726 return 0;
2727 }
2728
2729 static int img_amend(int argc, char **argv)
2730 {
2731 int c, ret = 0;
2732 char *options = NULL;
2733 QemuOptsList *create_opts = NULL;
2734 QemuOpts *opts = NULL;
2735 const char *fmt = NULL, *filename;
2736 bool quiet = false;
2737 BlockDriverState *bs = NULL;
2738
2739 for (;;) {
2740 c = getopt(argc, argv, "hqf:o:");
2741 if (c == -1) {
2742 break;
2743 }
2744
2745 switch (c) {
2746 case 'h':
2747 case '?':
2748 help();
2749 break;
2750 case 'o':
2751 if (!is_valid_option_list(optarg)) {
2752 error_report("Invalid option list: %s", optarg);
2753 ret = -1;
2754 goto out;
2755 }
2756 if (!options) {
2757 options = g_strdup(optarg);
2758 } else {
2759 char *old_options = options;
2760 options = g_strdup_printf("%s,%s", options, optarg);
2761 g_free(old_options);
2762 }
2763 break;
2764 case 'f':
2765 fmt = optarg;
2766 break;
2767 case 'q':
2768 quiet = true;
2769 break;
2770 }
2771 }
2772
2773 if (!options) {
2774 error_exit("Must specify options (-o)");
2775 }
2776
2777 filename = (optind == argc - 1) ? argv[argc - 1] : NULL;
2778 if (fmt && has_help_option(options)) {
2779 /* If a format is explicitly specified (and possibly no filename is
2780 * given), print option help here */
2781 ret = print_block_option_help(filename, fmt);
2782 goto out;
2783 }
2784
2785 if (optind != argc - 1) {
2786 error_exit("Expecting one image file name");
2787 }
2788
2789 bs = bdrv_new_open("image", filename, fmt,
2790 BDRV_O_FLAGS | BDRV_O_RDWR, true, quiet);
2791 if (!bs) {
2792 error_report("Could not open image '%s'", filename);
2793 ret = -1;
2794 goto out;
2795 }
2796
2797 fmt = bs->drv->format_name;
2798
2799 if (has_help_option(options)) {
2800 /* If the format was auto-detected, print option help here */
2801 ret = print_block_option_help(filename, fmt);
2802 goto out;
2803 }
2804
2805 create_opts = qemu_opts_append(create_opts, bs->drv->create_opts);
2806 opts = qemu_opts_create(create_opts, NULL, 0, &error_abort);
2807 if (options && qemu_opts_do_parse(opts, options, NULL)) {
2808 error_report("Invalid options for file format '%s'", fmt);
2809 ret = -1;
2810 goto out;
2811 }
2812
2813 ret = bdrv_amend_options(bs, opts);
2814 if (ret < 0) {
2815 error_report("Error while amending options: %s", strerror(-ret));
2816 goto out;
2817 }
2818
2819 out:
2820 if (bs) {
2821 bdrv_unref(bs);
2822 }
2823 qemu_opts_del(opts);
2824 qemu_opts_free(create_opts);
2825 g_free(options);
2826
2827 if (ret) {
2828 return 1;
2829 }
2830 return 0;
2831 }
2832
2833 static const img_cmd_t img_cmds[] = {
2834 #define DEF(option, callback, arg_string) \
2835 { option, callback },
2836 #include "qemu-img-cmds.h"
2837 #undef DEF
2838 #undef GEN_DOCS
2839 { NULL, NULL, },
2840 };
2841
2842 int main(int argc, char **argv)
2843 {
2844 const img_cmd_t *cmd;
2845 const char *cmdname;
2846 int c;
2847 static const struct option long_options[] = {
2848 {"help", no_argument, 0, 'h'},
2849 {"version", no_argument, 0, 'v'},
2850 {0, 0, 0, 0}
2851 };
2852
2853 #ifdef CONFIG_POSIX
2854 signal(SIGPIPE, SIG_IGN);
2855 #endif
2856
2857 error_set_progname(argv[0]);
2858 qemu_init_exec_dir(argv[0]);
2859
2860 qemu_init_main_loop();
2861 bdrv_init();
2862 if (argc < 2) {
2863 error_exit("Not enough arguments");
2864 }
2865 cmdname = argv[1];
2866
2867 /* find the command */
2868 for (cmd = img_cmds; cmd->name != NULL; cmd++) {
2869 if (!strcmp(cmdname, cmd->name)) {
2870 return cmd->handler(argc - 1, argv + 1);
2871 }
2872 }
2873
2874 c = getopt_long(argc, argv, "h", long_options, NULL);
2875
2876 if (c == 'h') {
2877 help();
2878 }
2879 if (c == 'v') {
2880 printf(QEMU_IMG_VERSION);
2881 return 0;
2882 }
2883
2884 /* not found */
2885 error_exit("Command not found: %s", cmdname);
2886 }
QEmu