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