Merge remote branch 'linux-user/linux-user-for-upstream' into staging-tmp
[qemu.git] / qemu-img.c
blobeb5c0f020713f538e33ce07564e4989844638b62
1 /*
2 * QEMU disk image utility
4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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.
24 #include "qemu-common.h"
25 #include "qemu-option.h"
26 #include "osdep.h"
27 #include "block_int.h"
28 #include <stdio.h>
30 #ifdef _WIN32
31 #include <windows.h>
32 #endif
34 typedef struct img_cmd_t {
35 const char *name;
36 int (*handler)(int argc, char **argv);
37 } img_cmd_t;
39 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
40 #define BRDV_O_FLAGS BDRV_O_CACHE_WB
42 static void QEMU_NORETURN error(const char *fmt, ...)
44 va_list ap;
45 va_start(ap, fmt);
46 fprintf(stderr, "qemu-img: ");
47 vfprintf(stderr, fmt, ap);
48 fprintf(stderr, "\n");
49 exit(1);
50 va_end(ap);
53 static void format_print(void *opaque, const char *name)
55 printf(" %s", name);
58 /* Please keep in synch with qemu-img.texi */
59 static void help(void)
61 const char *help_msg =
62 "qemu-img version " QEMU_VERSION ", Copyright (c) 2004-2008 Fabrice Bellard\n"
63 "usage: qemu-img command [command options]\n"
64 "QEMU disk image utility\n"
65 "\n"
66 "Command syntax:\n"
67 #define DEF(option, callback, arg_string) \
68 " " arg_string "\n"
69 #include "qemu-img-cmds.h"
70 #undef DEF
71 #undef GEN_DOCS
72 "\n"
73 "Command parameters:\n"
74 " 'filename' is a disk image filename\n"
75 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
76 " 'size' is the disk image size in bytes. Optional suffixes\n"
77 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M)\n"
78 " and T (terabyte, 1024G) are supported. 'b' is ignored.\n"
79 " 'output_filename' is the destination disk image filename\n"
80 " 'output_fmt' is the destination format\n"
81 " 'options' is a comma separated list of format specific options in a\n"
82 " name=value format. Use -o ? for an overview of the options supported by the\n"
83 " used format\n"
84 " '-c' indicates that target image must be compressed (qcow format only)\n"
85 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
86 " match exactly. The image doesn't need a working backing file before\n"
87 " rebasing in this case (useful for renaming the backing file)\n"
88 " '-h' with or without a command shows this help and lists the supported formats\n"
89 "\n"
90 "Parameters to snapshot subcommand:\n"
91 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
92 " '-a' applies a snapshot (revert disk to saved state)\n"
93 " '-c' creates a snapshot\n"
94 " '-d' deletes a snapshot\n"
95 " '-l' lists all snapshots in the given image\n";
97 printf("%s\nSupported formats:", help_msg);
98 bdrv_iterate_format(format_print, NULL);
99 printf("\n");
100 exit(1);
103 #if defined(WIN32)
104 /* XXX: put correct support for win32 */
105 static int read_password(char *buf, int buf_size)
107 int c, i;
108 printf("Password: ");
109 fflush(stdout);
110 i = 0;
111 for(;;) {
112 c = getchar();
113 if (c == '\n')
114 break;
115 if (i < (buf_size - 1))
116 buf[i++] = c;
118 buf[i] = '\0';
119 return 0;
122 #else
124 #include <termios.h>
126 static struct termios oldtty;
128 static void term_exit(void)
130 tcsetattr (0, TCSANOW, &oldtty);
133 static void term_init(void)
135 struct termios tty;
137 tcgetattr (0, &tty);
138 oldtty = tty;
140 tty.c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP
141 |INLCR|IGNCR|ICRNL|IXON);
142 tty.c_oflag |= OPOST;
143 tty.c_lflag &= ~(ECHO|ECHONL|ICANON|IEXTEN);
144 tty.c_cflag &= ~(CSIZE|PARENB);
145 tty.c_cflag |= CS8;
146 tty.c_cc[VMIN] = 1;
147 tty.c_cc[VTIME] = 0;
149 tcsetattr (0, TCSANOW, &tty);
151 atexit(term_exit);
154 static int read_password(char *buf, int buf_size)
156 uint8_t ch;
157 int i, ret;
159 printf("password: ");
160 fflush(stdout);
161 term_init();
162 i = 0;
163 for(;;) {
164 ret = read(0, &ch, 1);
165 if (ret == -1) {
166 if (errno == EAGAIN || errno == EINTR) {
167 continue;
168 } else {
169 ret = -1;
170 break;
172 } else if (ret == 0) {
173 ret = -1;
174 break;
175 } else {
176 if (ch == '\r') {
177 ret = 0;
178 break;
180 if (i < (buf_size - 1))
181 buf[i++] = ch;
184 term_exit();
185 buf[i] = '\0';
186 printf("\n");
187 return ret;
189 #endif
191 static BlockDriverState *bdrv_new_open(const char *filename,
192 const char *fmt)
194 BlockDriverState *bs;
195 BlockDriver *drv;
196 char password[256];
198 bs = bdrv_new("");
199 if (!bs)
200 error("Not enough memory");
201 if (fmt) {
202 drv = bdrv_find_format(fmt);
203 if (!drv)
204 error("Unknown file format '%s'", fmt);
205 } else {
206 drv = NULL;
208 if (bdrv_open2(bs, filename, BRDV_O_FLAGS | BDRV_O_RDWR, drv) < 0) {
209 error("Could not open '%s'", filename);
211 if (bdrv_is_encrypted(bs)) {
212 printf("Disk image '%s' is encrypted.\n", filename);
213 if (read_password(password, sizeof(password)) < 0)
214 error("No password given");
215 if (bdrv_set_key(bs, password) < 0)
216 error("invalid password");
218 return bs;
221 static void add_old_style_options(const char *fmt, QEMUOptionParameter *list,
222 int flags, const char *base_filename, const char *base_fmt)
224 if (flags & BLOCK_FLAG_ENCRYPT) {
225 if (set_option_parameter(list, BLOCK_OPT_ENCRYPT, "on")) {
226 error("Encryption not supported for file format '%s'", fmt);
229 if (flags & BLOCK_FLAG_COMPAT6) {
230 if (set_option_parameter(list, BLOCK_OPT_COMPAT6, "on")) {
231 error("VMDK version 6 not supported for file format '%s'", fmt);
235 if (base_filename) {
236 if (set_option_parameter(list, BLOCK_OPT_BACKING_FILE, base_filename)) {
237 error("Backing file not supported for file format '%s'", fmt);
240 if (base_fmt) {
241 if (set_option_parameter(list, BLOCK_OPT_BACKING_FMT, base_fmt)) {
242 error("Backing file format not supported for file format '%s'", fmt);
247 static int img_create(int argc, char **argv)
249 int c, ret, flags;
250 const char *fmt = "raw";
251 const char *base_fmt = NULL;
252 const char *filename;
253 const char *base_filename = NULL;
254 BlockDriver *drv;
255 QEMUOptionParameter *param = NULL;
256 char *options = NULL;
258 flags = 0;
259 for(;;) {
260 c = getopt(argc, argv, "F:b:f:he6o:");
261 if (c == -1)
262 break;
263 switch(c) {
264 case 'h':
265 help();
266 break;
267 case 'F':
268 base_fmt = optarg;
269 break;
270 case 'b':
271 base_filename = optarg;
272 break;
273 case 'f':
274 fmt = optarg;
275 break;
276 case 'e':
277 flags |= BLOCK_FLAG_ENCRYPT;
278 break;
279 case '6':
280 flags |= BLOCK_FLAG_COMPAT6;
281 break;
282 case 'o':
283 options = optarg;
284 break;
288 /* Find driver and parse its options */
289 drv = bdrv_find_format(fmt);
290 if (!drv)
291 error("Unknown file format '%s'", fmt);
293 if (options && !strcmp(options, "?")) {
294 print_option_help(drv->create_options);
295 return 0;
298 /* Create parameter list with default values */
299 param = parse_option_parameters("", drv->create_options, param);
300 set_option_parameter_int(param, BLOCK_OPT_SIZE, -1);
302 /* Parse -o options */
303 if (options) {
304 param = parse_option_parameters(options, drv->create_options, param);
305 if (param == NULL) {
306 error("Invalid options for file format '%s'.", fmt);
310 /* Get the filename */
311 if (optind >= argc)
312 help();
313 filename = argv[optind++];
315 /* Add size to parameters */
316 if (optind < argc) {
317 set_option_parameter(param, BLOCK_OPT_SIZE, argv[optind++]);
320 /* Add old-style options to parameters */
321 add_old_style_options(fmt, param, flags, base_filename, base_fmt);
323 // The size for the image must always be specified, with one exception:
324 // If we are using a backing file, we can obtain the size from there
325 if (get_option_parameter(param, BLOCK_OPT_SIZE)->value.n == -1) {
327 QEMUOptionParameter *backing_file =
328 get_option_parameter(param, BLOCK_OPT_BACKING_FILE);
329 QEMUOptionParameter *backing_fmt =
330 get_option_parameter(param, BLOCK_OPT_BACKING_FMT);
332 if (backing_file && backing_file->value.s) {
333 BlockDriverState *bs;
334 uint64_t size;
335 const char *fmt = NULL;
336 char buf[32];
338 if (backing_fmt && backing_fmt->value.s) {
339 if (bdrv_find_format(backing_fmt->value.s)) {
340 fmt = backing_fmt->value.s;
341 } else {
342 error("Unknown backing file format '%s'",
343 backing_fmt->value.s);
347 bs = bdrv_new_open(backing_file->value.s, fmt);
348 bdrv_get_geometry(bs, &size);
349 size *= 512;
350 bdrv_delete(bs);
352 snprintf(buf, sizeof(buf), "%" PRId64, size);
353 set_option_parameter(param, BLOCK_OPT_SIZE, buf);
354 } else {
355 error("Image creation needs a size parameter");
359 printf("Formatting '%s', fmt=%s ", filename, fmt);
360 print_option_parameters(param);
361 puts("");
363 ret = bdrv_create(drv, filename, param);
364 free_option_parameters(param);
366 if (ret < 0) {
367 if (ret == -ENOTSUP) {
368 error("Formatting or formatting option not supported for file format '%s'", fmt);
369 } else if (ret == -EFBIG) {
370 error("The image size is too large for file format '%s'", fmt);
371 } else {
372 error("Error while formatting");
375 return 0;
378 static int img_check(int argc, char **argv)
380 int c, ret;
381 const char *filename, *fmt;
382 BlockDriver *drv;
383 BlockDriverState *bs;
385 fmt = NULL;
386 for(;;) {
387 c = getopt(argc, argv, "f:h");
388 if (c == -1)
389 break;
390 switch(c) {
391 case 'h':
392 help();
393 break;
394 case 'f':
395 fmt = optarg;
396 break;
399 if (optind >= argc)
400 help();
401 filename = argv[optind++];
403 bs = bdrv_new("");
404 if (!bs)
405 error("Not enough memory");
406 if (fmt) {
407 drv = bdrv_find_format(fmt);
408 if (!drv)
409 error("Unknown file format '%s'", fmt);
410 } else {
411 drv = NULL;
413 if (bdrv_open2(bs, filename, BRDV_O_FLAGS, drv) < 0) {
414 error("Could not open '%s'", filename);
416 ret = bdrv_check(bs);
417 switch(ret) {
418 case 0:
419 printf("No errors were found on the image.\n");
420 break;
421 case -ENOTSUP:
422 error("This image format does not support checks");
423 break;
424 default:
425 if (ret < 0) {
426 error("An error occurred during the check");
427 } else {
428 printf("%d errors were found on the image.\n", ret);
430 break;
433 bdrv_delete(bs);
434 return 0;
437 static int img_commit(int argc, char **argv)
439 int c, ret;
440 const char *filename, *fmt;
441 BlockDriver *drv;
442 BlockDriverState *bs;
444 fmt = NULL;
445 for(;;) {
446 c = getopt(argc, argv, "f:h");
447 if (c == -1)
448 break;
449 switch(c) {
450 case 'h':
451 help();
452 break;
453 case 'f':
454 fmt = optarg;
455 break;
458 if (optind >= argc)
459 help();
460 filename = argv[optind++];
462 bs = bdrv_new("");
463 if (!bs)
464 error("Not enough memory");
465 if (fmt) {
466 drv = bdrv_find_format(fmt);
467 if (!drv)
468 error("Unknown file format '%s'", fmt);
469 } else {
470 drv = NULL;
472 if (bdrv_open2(bs, filename, BRDV_O_FLAGS | BDRV_O_RDWR, drv) < 0) {
473 error("Could not open '%s'", filename);
475 ret = bdrv_commit(bs);
476 switch(ret) {
477 case 0:
478 printf("Image committed.\n");
479 break;
480 case -ENOENT:
481 error("No disk inserted");
482 break;
483 case -EACCES:
484 error("Image is read-only");
485 break;
486 case -ENOTSUP:
487 error("Image is already committed");
488 break;
489 default:
490 error("Error while committing image");
491 break;
494 bdrv_delete(bs);
495 return 0;
498 static int is_not_zero(const uint8_t *sector, int len)
500 int i;
501 len >>= 2;
502 for(i = 0;i < len; i++) {
503 if (((uint32_t *)sector)[i] != 0)
504 return 1;
506 return 0;
510 * Returns true iff the first sector pointed to by 'buf' contains at least
511 * a non-NUL byte.
513 * 'pnum' is set to the number of sectors (including and immediately following
514 * the first one) that are known to be in the same allocated/unallocated state.
516 static int is_allocated_sectors(const uint8_t *buf, int n, int *pnum)
518 int v, i;
520 if (n <= 0) {
521 *pnum = 0;
522 return 0;
524 v = is_not_zero(buf, 512);
525 for(i = 1; i < n; i++) {
526 buf += 512;
527 if (v != is_not_zero(buf, 512))
528 break;
530 *pnum = i;
531 return v;
535 * Compares two buffers sector by sector. Returns 0 if the first sector of both
536 * buffers matches, non-zero otherwise.
538 * pnum is set to the number of sectors (including and immediately following
539 * the first one) that are known to have the same comparison result
541 static int compare_sectors(const uint8_t *buf1, const uint8_t *buf2, int n,
542 int *pnum)
544 int res, i;
546 if (n <= 0) {
547 *pnum = 0;
548 return 0;
551 res = !!memcmp(buf1, buf2, 512);
552 for(i = 1; i < n; i++) {
553 buf1 += 512;
554 buf2 += 512;
556 if (!!memcmp(buf1, buf2, 512) != res) {
557 break;
561 *pnum = i;
562 return res;
565 #define IO_BUF_SIZE (2 * 1024 * 1024)
567 static int img_convert(int argc, char **argv)
569 int c, ret, n, n1, bs_n, bs_i, flags, cluster_size, cluster_sectors;
570 const char *fmt, *out_fmt, *out_baseimg, *out_filename;
571 BlockDriver *drv;
572 BlockDriverState **bs, *out_bs;
573 int64_t total_sectors, nb_sectors, sector_num, bs_offset;
574 uint64_t bs_sectors;
575 uint8_t buf[IO_BUF_SIZE];
576 const uint8_t *buf1;
577 BlockDriverInfo bdi;
578 QEMUOptionParameter *param = NULL;
579 char *options = NULL;
581 fmt = NULL;
582 out_fmt = "raw";
583 out_baseimg = NULL;
584 flags = 0;
585 for(;;) {
586 c = getopt(argc, argv, "f:O:B:hce6o:");
587 if (c == -1)
588 break;
589 switch(c) {
590 case 'h':
591 help();
592 break;
593 case 'f':
594 fmt = optarg;
595 break;
596 case 'O':
597 out_fmt = optarg;
598 break;
599 case 'B':
600 out_baseimg = optarg;
601 break;
602 case 'c':
603 flags |= BLOCK_FLAG_COMPRESS;
604 break;
605 case 'e':
606 flags |= BLOCK_FLAG_ENCRYPT;
607 break;
608 case '6':
609 flags |= BLOCK_FLAG_COMPAT6;
610 break;
611 case 'o':
612 options = optarg;
613 break;
617 bs_n = argc - optind - 1;
618 if (bs_n < 1) help();
620 out_filename = argv[argc - 1];
622 if (bs_n > 1 && out_baseimg)
623 error("-B makes no sense when concatenating multiple input images");
625 bs = calloc(bs_n, sizeof(BlockDriverState *));
626 if (!bs)
627 error("Out of memory");
629 total_sectors = 0;
630 for (bs_i = 0; bs_i < bs_n; bs_i++) {
631 bs[bs_i] = bdrv_new_open(argv[optind + bs_i], fmt);
632 if (!bs[bs_i])
633 error("Could not open '%s'", argv[optind + bs_i]);
634 bdrv_get_geometry(bs[bs_i], &bs_sectors);
635 total_sectors += bs_sectors;
638 /* Find driver and parse its options */
639 drv = bdrv_find_format(out_fmt);
640 if (!drv)
641 error("Unknown file format '%s'", out_fmt);
643 if (options && !strcmp(options, "?")) {
644 print_option_help(drv->create_options);
645 free(bs);
646 return 0;
649 if (options) {
650 param = parse_option_parameters(options, drv->create_options, param);
651 if (param == NULL) {
652 error("Invalid options for file format '%s'.", out_fmt);
654 } else {
655 param = parse_option_parameters("", drv->create_options, param);
658 set_option_parameter_int(param, BLOCK_OPT_SIZE, total_sectors * 512);
659 add_old_style_options(out_fmt, param, flags, out_baseimg, NULL);
661 /* Check if compression is supported */
662 if (flags & BLOCK_FLAG_COMPRESS) {
663 QEMUOptionParameter *encryption =
664 get_option_parameter(param, BLOCK_OPT_ENCRYPT);
666 if (!drv->bdrv_write_compressed) {
667 error("Compression not supported for this file format");
670 if (encryption && encryption->value.n) {
671 error("Compression and encryption not supported at the same time");
675 /* Create the new image */
676 ret = bdrv_create(drv, out_filename, param);
677 free_option_parameters(param);
679 if (ret < 0) {
680 if (ret == -ENOTSUP) {
681 error("Formatting not supported for file format '%s'", out_fmt);
682 } else if (ret == -EFBIG) {
683 error("The image size is too large for file format '%s'", out_fmt);
684 } else {
685 error("Error while formatting '%s'", out_filename);
689 out_bs = bdrv_new_open(out_filename, out_fmt);
691 bs_i = 0;
692 bs_offset = 0;
693 bdrv_get_geometry(bs[0], &bs_sectors);
695 if (flags & BLOCK_FLAG_COMPRESS) {
696 if (bdrv_get_info(out_bs, &bdi) < 0)
697 error("could not get block driver info");
698 cluster_size = bdi.cluster_size;
699 if (cluster_size <= 0 || cluster_size > IO_BUF_SIZE)
700 error("invalid cluster size");
701 cluster_sectors = cluster_size >> 9;
702 sector_num = 0;
703 for(;;) {
704 int64_t bs_num;
705 int remainder;
706 uint8_t *buf2;
708 nb_sectors = total_sectors - sector_num;
709 if (nb_sectors <= 0)
710 break;
711 if (nb_sectors >= cluster_sectors)
712 n = cluster_sectors;
713 else
714 n = nb_sectors;
716 bs_num = sector_num - bs_offset;
717 assert (bs_num >= 0);
718 remainder = n;
719 buf2 = buf;
720 while (remainder > 0) {
721 int nlow;
722 while (bs_num == bs_sectors) {
723 bs_i++;
724 assert (bs_i < bs_n);
725 bs_offset += bs_sectors;
726 bdrv_get_geometry(bs[bs_i], &bs_sectors);
727 bs_num = 0;
728 /* printf("changing part: sector_num=%lld, "
729 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
730 sector_num, bs_i, bs_offset, bs_sectors); */
732 assert (bs_num < bs_sectors);
734 nlow = (remainder > bs_sectors - bs_num) ? bs_sectors - bs_num : remainder;
736 if (bdrv_read(bs[bs_i], bs_num, buf2, nlow) < 0)
737 error("error while reading");
739 buf2 += nlow * 512;
740 bs_num += nlow;
742 remainder -= nlow;
744 assert (remainder == 0);
746 if (n < cluster_sectors)
747 memset(buf + n * 512, 0, cluster_size - n * 512);
748 if (is_not_zero(buf, cluster_size)) {
749 if (bdrv_write_compressed(out_bs, sector_num, buf,
750 cluster_sectors) != 0)
751 error("error while compressing sector %" PRId64,
752 sector_num);
754 sector_num += n;
756 /* signal EOF to align */
757 bdrv_write_compressed(out_bs, 0, NULL, 0);
758 } else {
759 sector_num = 0; // total number of sectors converted so far
760 for(;;) {
761 nb_sectors = total_sectors - sector_num;
762 if (nb_sectors <= 0)
763 break;
764 if (nb_sectors >= (IO_BUF_SIZE / 512))
765 n = (IO_BUF_SIZE / 512);
766 else
767 n = nb_sectors;
769 while (sector_num - bs_offset >= bs_sectors) {
770 bs_i ++;
771 assert (bs_i < bs_n);
772 bs_offset += bs_sectors;
773 bdrv_get_geometry(bs[bs_i], &bs_sectors);
774 /* printf("changing part: sector_num=%lld, bs_i=%d, "
775 "bs_offset=%lld, bs_sectors=%lld\n",
776 sector_num, bs_i, bs_offset, bs_sectors); */
779 if (n > bs_offset + bs_sectors - sector_num)
780 n = bs_offset + bs_sectors - sector_num;
782 if (!drv->no_zero_init) {
783 /* If the output image is being created as a copy on write image,
784 assume that sectors which are unallocated in the input image
785 are present in both the output's and input's base images (no
786 need to copy them). */
787 if (out_baseimg) {
788 if (!bdrv_is_allocated(bs[bs_i], sector_num - bs_offset,
789 n, &n1)) {
790 sector_num += n1;
791 continue;
793 /* The next 'n1' sectors are allocated in the input image. Copy
794 only those as they may be followed by unallocated sectors. */
795 n = n1;
797 } else {
798 n1 = n;
801 if (bdrv_read(bs[bs_i], sector_num - bs_offset, buf, n) < 0)
802 error("error while reading");
803 /* NOTE: at the same time we convert, we do not write zero
804 sectors to have a chance to compress the image. Ideally, we
805 should add a specific call to have the info to go faster */
806 buf1 = buf;
807 while (n > 0) {
808 /* If the output image is being created as a copy on write image,
809 copy all sectors even the ones containing only NUL bytes,
810 because they may differ from the sectors in the base image.
812 If the output is to a host device, we also write out
813 sectors that are entirely 0, since whatever data was
814 already there is garbage, not 0s. */
815 if (drv->no_zero_init || out_baseimg ||
816 is_allocated_sectors(buf1, n, &n1)) {
817 if (bdrv_write(out_bs, sector_num, buf1, n1) < 0)
818 error("error while writing");
820 sector_num += n1;
821 n -= n1;
822 buf1 += n1 * 512;
826 bdrv_delete(out_bs);
827 for (bs_i = 0; bs_i < bs_n; bs_i++)
828 bdrv_delete(bs[bs_i]);
829 free(bs);
830 return 0;
833 #ifdef _WIN32
834 static int64_t get_allocated_file_size(const char *filename)
836 typedef DWORD (WINAPI * get_compressed_t)(const char *filename, DWORD *high);
837 get_compressed_t get_compressed;
838 struct _stati64 st;
840 /* WinNT support GetCompressedFileSize to determine allocate size */
841 get_compressed = (get_compressed_t) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
842 if (get_compressed) {
843 DWORD high, low;
844 low = get_compressed(filename, &high);
845 if (low != 0xFFFFFFFFlu || GetLastError() == NO_ERROR)
846 return (((int64_t) high) << 32) + low;
849 if (_stati64(filename, &st) < 0)
850 return -1;
851 return st.st_size;
853 #else
854 static int64_t get_allocated_file_size(const char *filename)
856 struct stat st;
857 if (stat(filename, &st) < 0)
858 return -1;
859 return (int64_t)st.st_blocks * 512;
861 #endif
863 static void dump_snapshots(BlockDriverState *bs)
865 QEMUSnapshotInfo *sn_tab, *sn;
866 int nb_sns, i;
867 char buf[256];
869 nb_sns = bdrv_snapshot_list(bs, &sn_tab);
870 if (nb_sns <= 0)
871 return;
872 printf("Snapshot list:\n");
873 printf("%s\n", bdrv_snapshot_dump(buf, sizeof(buf), NULL));
874 for(i = 0; i < nb_sns; i++) {
875 sn = &sn_tab[i];
876 printf("%s\n", bdrv_snapshot_dump(buf, sizeof(buf), sn));
878 qemu_free(sn_tab);
881 static int img_info(int argc, char **argv)
883 int c;
884 const char *filename, *fmt;
885 BlockDriver *drv;
886 BlockDriverState *bs;
887 char fmt_name[128], size_buf[128], dsize_buf[128];
888 uint64_t total_sectors;
889 int64_t allocated_size;
890 char backing_filename[1024];
891 char backing_filename2[1024];
892 BlockDriverInfo bdi;
894 fmt = NULL;
895 for(;;) {
896 c = getopt(argc, argv, "f:h");
897 if (c == -1)
898 break;
899 switch(c) {
900 case 'h':
901 help();
902 break;
903 case 'f':
904 fmt = optarg;
905 break;
908 if (optind >= argc)
909 help();
910 filename = argv[optind++];
912 bs = bdrv_new("");
913 if (!bs)
914 error("Not enough memory");
915 if (fmt) {
916 drv = bdrv_find_format(fmt);
917 if (!drv)
918 error("Unknown file format '%s'", fmt);
919 } else {
920 drv = NULL;
922 if (bdrv_open2(bs, filename, BRDV_O_FLAGS | BDRV_O_NO_BACKING, drv) < 0) {
923 error("Could not open '%s'", filename);
925 bdrv_get_format(bs, fmt_name, sizeof(fmt_name));
926 bdrv_get_geometry(bs, &total_sectors);
927 get_human_readable_size(size_buf, sizeof(size_buf), total_sectors * 512);
928 allocated_size = get_allocated_file_size(filename);
929 if (allocated_size < 0)
930 snprintf(dsize_buf, sizeof(dsize_buf), "unavailable");
931 else
932 get_human_readable_size(dsize_buf, sizeof(dsize_buf),
933 allocated_size);
934 printf("image: %s\n"
935 "file format: %s\n"
936 "virtual size: %s (%" PRId64 " bytes)\n"
937 "disk size: %s\n",
938 filename, fmt_name, size_buf,
939 (total_sectors * 512),
940 dsize_buf);
941 if (bdrv_is_encrypted(bs))
942 printf("encrypted: yes\n");
943 if (bdrv_get_info(bs, &bdi) >= 0) {
944 if (bdi.cluster_size != 0)
945 printf("cluster_size: %d\n", bdi.cluster_size);
947 bdrv_get_backing_filename(bs, backing_filename, sizeof(backing_filename));
948 if (backing_filename[0] != '\0') {
949 path_combine(backing_filename2, sizeof(backing_filename2),
950 filename, backing_filename);
951 printf("backing file: %s (actual path: %s)\n",
952 backing_filename,
953 backing_filename2);
955 dump_snapshots(bs);
956 bdrv_delete(bs);
957 return 0;
960 #define SNAPSHOT_LIST 1
961 #define SNAPSHOT_CREATE 2
962 #define SNAPSHOT_APPLY 3
963 #define SNAPSHOT_DELETE 4
965 static int img_snapshot(int argc, char **argv)
967 BlockDriverState *bs;
968 QEMUSnapshotInfo sn;
969 char *filename, *snapshot_name = NULL;
970 int c, ret, bdrv_oflags;
971 int action = 0;
972 qemu_timeval tv;
974 bdrv_oflags = BDRV_O_RDWR;
975 /* Parse commandline parameters */
976 for(;;) {
977 c = getopt(argc, argv, "la:c:d:h");
978 if (c == -1)
979 break;
980 switch(c) {
981 case 'h':
982 help();
983 return 0;
984 case 'l':
985 if (action) {
986 help();
987 return 0;
989 action = SNAPSHOT_LIST;
990 bdrv_oflags &= ~BDRV_O_RDWR; /* no need for RW */
991 break;
992 case 'a':
993 if (action) {
994 help();
995 return 0;
997 action = SNAPSHOT_APPLY;
998 snapshot_name = optarg;
999 break;
1000 case 'c':
1001 if (action) {
1002 help();
1003 return 0;
1005 action = SNAPSHOT_CREATE;
1006 snapshot_name = optarg;
1007 break;
1008 case 'd':
1009 if (action) {
1010 help();
1011 return 0;
1013 action = SNAPSHOT_DELETE;
1014 snapshot_name = optarg;
1015 break;
1019 if (optind >= argc)
1020 help();
1021 filename = argv[optind++];
1023 /* Open the image */
1024 bs = bdrv_new("");
1025 if (!bs)
1026 error("Not enough memory");
1028 if (bdrv_open2(bs, filename, bdrv_oflags, NULL) < 0) {
1029 error("Could not open '%s'", filename);
1032 /* Perform the requested action */
1033 switch(action) {
1034 case SNAPSHOT_LIST:
1035 dump_snapshots(bs);
1036 break;
1038 case SNAPSHOT_CREATE:
1039 memset(&sn, 0, sizeof(sn));
1040 pstrcpy(sn.name, sizeof(sn.name), snapshot_name);
1042 qemu_gettimeofday(&tv);
1043 sn.date_sec = tv.tv_sec;
1044 sn.date_nsec = tv.tv_usec * 1000;
1046 ret = bdrv_snapshot_create(bs, &sn);
1047 if (ret)
1048 error("Could not create snapshot '%s': %d (%s)",
1049 snapshot_name, ret, strerror(-ret));
1050 break;
1052 case SNAPSHOT_APPLY:
1053 ret = bdrv_snapshot_goto(bs, snapshot_name);
1054 if (ret)
1055 error("Could not apply snapshot '%s': %d (%s)",
1056 snapshot_name, ret, strerror(-ret));
1057 break;
1059 case SNAPSHOT_DELETE:
1060 ret = bdrv_snapshot_delete(bs, snapshot_name);
1061 if (ret)
1062 error("Could not delete snapshot '%s': %d (%s)",
1063 snapshot_name, ret, strerror(-ret));
1064 break;
1067 /* Cleanup */
1068 bdrv_delete(bs);
1070 return 0;
1073 static int img_rebase(int argc, char **argv)
1075 BlockDriverState *bs, *bs_old_backing, *bs_new_backing;
1076 BlockDriver *old_backing_drv, *new_backing_drv;
1077 char *filename;
1078 const char *out_basefmt, *out_baseimg;
1079 int c, flags, ret;
1080 int unsafe = 0;
1082 /* Parse commandline parameters */
1083 out_baseimg = NULL;
1084 out_basefmt = NULL;
1086 for(;;) {
1087 c = getopt(argc, argv, "uhF:b:");
1088 if (c == -1)
1089 break;
1090 switch(c) {
1091 case 'h':
1092 help();
1093 return 0;
1094 case 'F':
1095 out_basefmt = optarg;
1096 break;
1097 case 'b':
1098 out_baseimg = optarg;
1099 break;
1100 case 'u':
1101 unsafe = 1;
1102 break;
1106 if ((optind >= argc) || !out_baseimg)
1107 help();
1108 filename = argv[optind++];
1111 * Open the images.
1113 * Ignore the old backing file for unsafe rebase in case we want to correct
1114 * the reference to a renamed or moved backing file.
1116 bs = bdrv_new("");
1117 if (!bs)
1118 error("Not enough memory");
1120 flags = BRDV_O_FLAGS | BDRV_O_RDWR | (unsafe ? BDRV_O_NO_BACKING : 0);
1121 if (bdrv_open2(bs, filename, flags, NULL) < 0) {
1122 error("Could not open '%s'", filename);
1125 /* Find the right drivers for the backing files */
1126 old_backing_drv = NULL;
1127 new_backing_drv = NULL;
1129 if (!unsafe && bs->backing_format[0] != '\0') {
1130 old_backing_drv = bdrv_find_format(bs->backing_format);
1131 if (old_backing_drv == NULL) {
1132 error("Invalid format name: '%s'", bs->backing_format);
1136 if (out_basefmt != NULL) {
1137 new_backing_drv = bdrv_find_format(out_basefmt);
1138 if (new_backing_drv == NULL) {
1139 error("Invalid format name: '%s'", out_basefmt);
1143 /* For safe rebasing we need to compare old and new backing file */
1144 if (unsafe) {
1145 /* Make the compiler happy */
1146 bs_old_backing = NULL;
1147 bs_new_backing = NULL;
1148 } else {
1149 char backing_name[1024];
1151 bs_old_backing = bdrv_new("old_backing");
1152 bdrv_get_backing_filename(bs, backing_name, sizeof(backing_name));
1153 if (bdrv_open2(bs_old_backing, backing_name, BRDV_O_FLAGS,
1154 old_backing_drv))
1156 error("Could not open old backing file '%s'", backing_name);
1157 return -1;
1160 bs_new_backing = bdrv_new("new_backing");
1161 if (bdrv_open2(bs_new_backing, out_baseimg, BRDV_O_FLAGS | BDRV_O_RDWR,
1162 new_backing_drv))
1164 error("Could not open new backing file '%s'", backing_name);
1165 return -1;
1170 * Check each unallocated cluster in the COW file. If it is unallocated,
1171 * accesses go to the backing file. We must therefore compare this cluster
1172 * in the old and new backing file, and if they differ we need to copy it
1173 * from the old backing file into the COW file.
1175 * If qemu-img crashes during this step, no harm is done. The content of
1176 * the image is the same as the original one at any time.
1178 if (!unsafe) {
1179 uint64_t num_sectors;
1180 uint64_t sector;
1181 int n, n1;
1182 uint8_t buf_old[IO_BUF_SIZE];
1183 uint8_t buf_new[IO_BUF_SIZE];
1185 bdrv_get_geometry(bs, &num_sectors);
1187 for (sector = 0; sector < num_sectors; sector += n) {
1189 /* How many sectors can we handle with the next read? */
1190 if (sector + (IO_BUF_SIZE / 512) <= num_sectors) {
1191 n = (IO_BUF_SIZE / 512);
1192 } else {
1193 n = num_sectors - sector;
1196 /* If the cluster is allocated, we don't need to take action */
1197 if (bdrv_is_allocated(bs, sector, n, &n1)) {
1198 n = n1;
1199 continue;
1202 /* Read old and new backing file */
1203 if (bdrv_read(bs_old_backing, sector, buf_old, n) < 0) {
1204 error("error while reading from old backing file");
1206 if (bdrv_read(bs_new_backing, sector, buf_new, n) < 0) {
1207 error("error while reading from new backing file");
1210 /* If they differ, we need to write to the COW file */
1211 uint64_t written = 0;
1213 while (written < n) {
1214 int pnum;
1216 if (compare_sectors(buf_old + written * 512,
1217 buf_new + written * 512, n, &pnum))
1219 ret = bdrv_write(bs, sector + written,
1220 buf_old + written * 512, pnum);
1221 if (ret < 0) {
1222 error("Error while writing to COW image: %s",
1223 strerror(-ret));
1227 written += pnum;
1233 * Change the backing file. All clusters that are different from the old
1234 * backing file are overwritten in the COW file now, so the visible content
1235 * doesn't change when we switch the backing file.
1237 ret = bdrv_change_backing_file(bs, out_baseimg, out_basefmt);
1238 if (ret == -ENOSPC) {
1239 error("Could not change the backing file to '%s': No space left in "
1240 "the file header", out_baseimg);
1241 } else if (ret < 0) {
1242 error("Could not change the backing file to '%s': %s",
1243 out_baseimg, strerror(-ret));
1247 * TODO At this point it is possible to check if any clusters that are
1248 * allocated in the COW file are the same in the backing file. If so, they
1249 * could be dropped from the COW file. Don't do this before switching the
1250 * backing file, in case of a crash this would lead to corruption.
1253 /* Cleanup */
1254 if (!unsafe) {
1255 bdrv_delete(bs_old_backing);
1256 bdrv_delete(bs_new_backing);
1259 bdrv_delete(bs);
1261 return 0;
1264 static const img_cmd_t img_cmds[] = {
1265 #define DEF(option, callback, arg_string) \
1266 { option, callback },
1267 #include "qemu-img-cmds.h"
1268 #undef DEF
1269 #undef GEN_DOCS
1270 { NULL, NULL, },
1273 int main(int argc, char **argv)
1275 const img_cmd_t *cmd;
1276 const char *cmdname;
1278 bdrv_init();
1279 if (argc < 2)
1280 help();
1281 cmdname = argv[1];
1282 argc--; argv++;
1284 /* find the command */
1285 for(cmd = img_cmds; cmd->name != NULL; cmd++) {
1286 if (!strcmp(cmdname, cmd->name)) {
1287 return cmd->handler(argc, argv);
1291 /* not found */
1292 help();
1293 return 0;