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