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