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