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
24 #include "qemu-common.h"
25 #include "qemu-option.h"
27 #include "block_int.h"
34 typedef struct img_cmd_t
{
36 int (*handler
)(int argc
, char **argv
);
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
, ...)
46 fprintf(stderr
, "qemu-img: ");
47 vfprintf(stderr
, fmt
, ap
);
48 fprintf(stderr
, "\n");
53 static void format_print(void *opaque
, const char *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"
67 #define DEF(option, callback, arg_string) \
69 #include "qemu-img-cmds.h"
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"
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"
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
);
104 /* XXX: put correct support for win32 */
105 static int read_password(char *buf
, int buf_size
)
108 printf("Password: ");
115 if (i
< (buf_size
- 1))
126 static struct termios oldtty
;
128 static void term_exit(void)
130 tcsetattr (0, TCSANOW
, &oldtty
);
133 static void term_init(void)
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
);
149 tcsetattr (0, TCSANOW
, &tty
);
154 static int read_password(char *buf
, int buf_size
)
159 printf("password: ");
164 ret
= read(0, &ch
, 1);
166 if (errno
== EAGAIN
|| errno
== EINTR
) {
172 } else if (ret
== 0) {
180 if (i
< (buf_size
- 1))
191 static BlockDriverState
*bdrv_new_open(const char *filename
,
195 BlockDriverState
*bs
;
198 int flags
= BRDV_O_FLAGS
;
202 error("Not enough memory");
204 drv
= bdrv_find_format(fmt
);
206 error("Unknown file format '%s'", fmt
);
211 flags
|= BDRV_O_RDWR
;
213 if (bdrv_open2(bs
, filename
, flags
, drv
) < 0) {
214 error("Could not open '%s'", filename
);
216 if (bdrv_is_encrypted(bs
)) {
217 printf("Disk image '%s' is encrypted.\n", filename
);
218 if (read_password(password
, sizeof(password
)) < 0)
219 error("No password given");
220 if (bdrv_set_key(bs
, password
) < 0)
221 error("invalid password");
226 static void add_old_style_options(const char *fmt
, QEMUOptionParameter
*list
,
227 int flags
, const char *base_filename
, const char *base_fmt
)
229 if (flags
& BLOCK_FLAG_ENCRYPT
) {
230 if (set_option_parameter(list
, BLOCK_OPT_ENCRYPT
, "on")) {
231 error("Encryption not supported for file format '%s'", fmt
);
234 if (flags
& BLOCK_FLAG_COMPAT6
) {
235 if (set_option_parameter(list
, BLOCK_OPT_COMPAT6
, "on")) {
236 error("VMDK version 6 not supported for file format '%s'", fmt
);
241 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FILE
, base_filename
)) {
242 error("Backing file not supported for file format '%s'", fmt
);
246 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
247 error("Backing file format not supported for file format '%s'", fmt
);
252 static int img_create(int argc
, char **argv
)
255 const char *fmt
= "raw";
256 const char *base_fmt
= NULL
;
257 const char *filename
;
258 const char *base_filename
= NULL
;
260 QEMUOptionParameter
*param
= NULL
;
261 char *options
= NULL
;
265 c
= getopt(argc
, argv
, "F:b:f:he6o:");
276 base_filename
= optarg
;
282 flags
|= BLOCK_FLAG_ENCRYPT
;
285 flags
|= BLOCK_FLAG_COMPAT6
;
293 /* Find driver and parse its options */
294 drv
= bdrv_find_format(fmt
);
296 error("Unknown file format '%s'", fmt
);
298 if (options
&& !strcmp(options
, "?")) {
299 print_option_help(drv
->create_options
);
303 /* Create parameter list with default values */
304 param
= parse_option_parameters("", drv
->create_options
, param
);
305 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, -1);
307 /* Parse -o options */
309 param
= parse_option_parameters(options
, drv
->create_options
, param
);
311 error("Invalid options for file format '%s'.", fmt
);
315 /* Get the filename */
318 filename
= argv
[optind
++];
320 /* Add size to parameters */
322 set_option_parameter(param
, BLOCK_OPT_SIZE
, argv
[optind
++]);
325 /* Add old-style options to parameters */
326 add_old_style_options(fmt
, param
, flags
, base_filename
, base_fmt
);
328 // The size for the image must always be specified, with one exception:
329 // If we are using a backing file, we can obtain the size from there
330 if (get_option_parameter(param
, BLOCK_OPT_SIZE
)->value
.n
== -1) {
332 QEMUOptionParameter
*backing_file
=
333 get_option_parameter(param
, BLOCK_OPT_BACKING_FILE
);
334 QEMUOptionParameter
*backing_fmt
=
335 get_option_parameter(param
, BLOCK_OPT_BACKING_FMT
);
337 if (backing_file
&& backing_file
->value
.s
) {
338 BlockDriverState
*bs
;
340 const char *fmt
= NULL
;
343 if (backing_fmt
&& backing_fmt
->value
.s
) {
344 if (bdrv_find_format(backing_fmt
->value
.s
)) {
345 fmt
= backing_fmt
->value
.s
;
347 error("Unknown backing file format '%s'",
348 backing_fmt
->value
.s
);
352 bs
= bdrv_new_open(backing_file
->value
.s
, fmt
, 1);
353 bdrv_get_geometry(bs
, &size
);
357 snprintf(buf
, sizeof(buf
), "%" PRId64
, size
);
358 set_option_parameter(param
, BLOCK_OPT_SIZE
, buf
);
360 error("Image creation needs a size parameter");
364 printf("Formatting '%s', fmt=%s ", filename
, fmt
);
365 print_option_parameters(param
);
368 ret
= bdrv_create(drv
, filename
, param
);
369 free_option_parameters(param
);
372 if (ret
== -ENOTSUP
) {
373 error("Formatting or formatting option not supported for file format '%s'", fmt
);
374 } else if (ret
== -EFBIG
) {
375 error("The image size is too large for file format '%s'", fmt
);
377 error("Error while formatting");
383 static int img_check(int argc
, char **argv
)
386 const char *filename
, *fmt
;
388 BlockDriverState
*bs
;
392 c
= getopt(argc
, argv
, "f:h");
406 filename
= argv
[optind
++];
410 error("Not enough memory");
412 drv
= bdrv_find_format(fmt
);
414 error("Unknown file format '%s'", fmt
);
418 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
419 error("Could not open '%s'", filename
);
421 ret
= bdrv_check(bs
);
424 printf("No errors were found on the image.\n");
427 error("This image format does not support checks");
431 error("An error occurred during the check");
433 printf("%d errors were found on the image.\n", ret
);
442 static int img_commit(int argc
, char **argv
)
445 const char *filename
, *fmt
;
447 BlockDriverState
*bs
;
451 c
= getopt(argc
, argv
, "f:h");
465 filename
= argv
[optind
++];
469 error("Not enough memory");
471 drv
= bdrv_find_format(fmt
);
473 error("Unknown file format '%s'", fmt
);
477 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
| BDRV_O_RDWR
, drv
) < 0) {
478 error("Could not open '%s'", filename
);
480 ret
= bdrv_commit(bs
);
483 printf("Image committed.\n");
486 error("No disk inserted");
489 error("Image is read-only");
492 error("Image is already committed");
495 error("Error while committing image");
503 static int is_not_zero(const uint8_t *sector
, int len
)
507 for(i
= 0;i
< len
; i
++) {
508 if (((uint32_t *)sector
)[i
] != 0)
515 * Returns true iff the first sector pointed to by 'buf' contains at least
518 * 'pnum' is set to the number of sectors (including and immediately following
519 * the first one) that are known to be in the same allocated/unallocated state.
521 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
529 v
= is_not_zero(buf
, 512);
530 for(i
= 1; i
< n
; i
++) {
532 if (v
!= is_not_zero(buf
, 512))
540 * Compares two buffers sector by sector. Returns 0 if the first sector of both
541 * buffers matches, non-zero otherwise.
543 * pnum is set to the number of sectors (including and immediately following
544 * the first one) that are known to have the same comparison result
546 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
556 res
= !!memcmp(buf1
, buf2
, 512);
557 for(i
= 1; i
< n
; i
++) {
561 if (!!memcmp(buf1
, buf2
, 512) != res
) {
570 #define IO_BUF_SIZE (2 * 1024 * 1024)
572 static int img_convert(int argc
, char **argv
)
574 int c
, ret
, n
, n1
, bs_n
, bs_i
, flags
, cluster_size
, cluster_sectors
;
575 const char *fmt
, *out_fmt
, *out_baseimg
, *out_filename
;
577 BlockDriverState
**bs
, *out_bs
;
578 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
580 uint8_t buf
[IO_BUF_SIZE
];
583 QEMUOptionParameter
*param
= NULL
;
584 char *options
= NULL
;
591 c
= getopt(argc
, argv
, "f:O:B:hce6o:");
605 out_baseimg
= optarg
;
608 flags
|= BLOCK_FLAG_COMPRESS
;
611 flags
|= BLOCK_FLAG_ENCRYPT
;
614 flags
|= BLOCK_FLAG_COMPAT6
;
622 bs_n
= argc
- optind
- 1;
623 if (bs_n
< 1) help();
625 out_filename
= argv
[argc
- 1];
627 if (bs_n
> 1 && out_baseimg
)
628 error("-B makes no sense when concatenating multiple input images");
630 bs
= calloc(bs_n
, sizeof(BlockDriverState
*));
632 error("Out of memory");
635 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
636 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
, 1);
638 error("Could not open '%s'", argv
[optind
+ bs_i
]);
639 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
640 total_sectors
+= bs_sectors
;
643 /* Find driver and parse its options */
644 drv
= bdrv_find_format(out_fmt
);
646 error("Unknown file format '%s'", out_fmt
);
648 if (options
&& !strcmp(options
, "?")) {
649 print_option_help(drv
->create_options
);
655 param
= parse_option_parameters(options
, drv
->create_options
, param
);
657 error("Invalid options for file format '%s'.", out_fmt
);
660 param
= parse_option_parameters("", drv
->create_options
, param
);
663 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, total_sectors
* 512);
664 add_old_style_options(out_fmt
, param
, flags
, out_baseimg
, NULL
);
666 /* Check if compression is supported */
667 if (flags
& BLOCK_FLAG_COMPRESS
) {
668 QEMUOptionParameter
*encryption
=
669 get_option_parameter(param
, BLOCK_OPT_ENCRYPT
);
671 if (!drv
->bdrv_write_compressed
) {
672 error("Compression not supported for this file format");
675 if (encryption
&& encryption
->value
.n
) {
676 error("Compression and encryption not supported at the same time");
680 /* Create the new image */
681 ret
= bdrv_create(drv
, out_filename
, param
);
682 free_option_parameters(param
);
685 if (ret
== -ENOTSUP
) {
686 error("Formatting not supported for file format '%s'", out_fmt
);
687 } else if (ret
== -EFBIG
) {
688 error("The image size is too large for file format '%s'", out_fmt
);
690 error("Error while formatting '%s'", out_filename
);
694 out_bs
= bdrv_new_open(out_filename
, out_fmt
, 0);
698 bdrv_get_geometry(bs
[0], &bs_sectors
);
700 if (flags
& BLOCK_FLAG_COMPRESS
) {
701 if (bdrv_get_info(out_bs
, &bdi
) < 0)
702 error("could not get block driver info");
703 cluster_size
= bdi
.cluster_size
;
704 if (cluster_size
<= 0 || cluster_size
> IO_BUF_SIZE
)
705 error("invalid cluster size");
706 cluster_sectors
= cluster_size
>> 9;
713 nb_sectors
= total_sectors
- sector_num
;
716 if (nb_sectors
>= cluster_sectors
)
721 bs_num
= sector_num
- bs_offset
;
722 assert (bs_num
>= 0);
725 while (remainder
> 0) {
727 while (bs_num
== bs_sectors
) {
729 assert (bs_i
< bs_n
);
730 bs_offset
+= bs_sectors
;
731 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
733 /* printf("changing part: sector_num=%lld, "
734 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
735 sector_num, bs_i, bs_offset, bs_sectors); */
737 assert (bs_num
< bs_sectors
);
739 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
741 if (bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
) < 0)
742 error("error while reading");
749 assert (remainder
== 0);
751 if (n
< cluster_sectors
)
752 memset(buf
+ n
* 512, 0, cluster_size
- n
* 512);
753 if (is_not_zero(buf
, cluster_size
)) {
754 if (bdrv_write_compressed(out_bs
, sector_num
, buf
,
755 cluster_sectors
) != 0)
756 error("error while compressing sector %" PRId64
,
761 /* signal EOF to align */
762 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
764 sector_num
= 0; // total number of sectors converted so far
766 nb_sectors
= total_sectors
- sector_num
;
769 if (nb_sectors
>= (IO_BUF_SIZE
/ 512))
770 n
= (IO_BUF_SIZE
/ 512);
774 while (sector_num
- bs_offset
>= bs_sectors
) {
776 assert (bs_i
< bs_n
);
777 bs_offset
+= bs_sectors
;
778 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
779 /* printf("changing part: sector_num=%lld, bs_i=%d, "
780 "bs_offset=%lld, bs_sectors=%lld\n",
781 sector_num, bs_i, bs_offset, bs_sectors); */
784 if (n
> bs_offset
+ bs_sectors
- sector_num
)
785 n
= bs_offset
+ bs_sectors
- sector_num
;
787 if (!drv
->no_zero_init
) {
788 /* If the output image is being created as a copy on write image,
789 assume that sectors which are unallocated in the input image
790 are present in both the output's and input's base images (no
791 need to copy them). */
793 if (!bdrv_is_allocated(bs
[bs_i
], sector_num
- bs_offset
,
798 /* The next 'n1' sectors are allocated in the input image. Copy
799 only those as they may be followed by unallocated sectors. */
806 if (bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
) < 0)
807 error("error while reading");
808 /* NOTE: at the same time we convert, we do not write zero
809 sectors to have a chance to compress the image. Ideally, we
810 should add a specific call to have the info to go faster */
813 /* If the output image is being created as a copy on write image,
814 copy all sectors even the ones containing only NUL bytes,
815 because they may differ from the sectors in the base image.
817 If the output is to a host device, we also write out
818 sectors that are entirely 0, since whatever data was
819 already there is garbage, not 0s. */
820 if (drv
->no_zero_init
|| out_baseimg
||
821 is_allocated_sectors(buf1
, n
, &n1
)) {
822 if (bdrv_write(out_bs
, sector_num
, buf1
, n1
) < 0)
823 error("error while writing");
832 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++)
833 bdrv_delete(bs
[bs_i
]);
839 static int64_t get_allocated_file_size(const char *filename
)
841 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
, DWORD
*high
);
842 get_compressed_t get_compressed
;
845 /* WinNT support GetCompressedFileSize to determine allocate size */
846 get_compressed
= (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
847 if (get_compressed
) {
849 low
= get_compressed(filename
, &high
);
850 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
)
851 return (((int64_t) high
) << 32) + low
;
854 if (_stati64(filename
, &st
) < 0)
859 static int64_t get_allocated_file_size(const char *filename
)
862 if (stat(filename
, &st
) < 0)
864 return (int64_t)st
.st_blocks
* 512;
868 static void dump_snapshots(BlockDriverState
*bs
)
870 QEMUSnapshotInfo
*sn_tab
, *sn
;
874 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
877 printf("Snapshot list:\n");
878 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
879 for(i
= 0; i
< nb_sns
; i
++) {
881 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
886 static int img_info(int argc
, char **argv
)
889 const char *filename
, *fmt
;
891 BlockDriverState
*bs
;
892 char fmt_name
[128], size_buf
[128], dsize_buf
[128];
893 uint64_t total_sectors
;
894 int64_t allocated_size
;
895 char backing_filename
[1024];
896 char backing_filename2
[1024];
901 c
= getopt(argc
, argv
, "f:h");
915 filename
= argv
[optind
++];
919 error("Not enough memory");
921 drv
= bdrv_find_format(fmt
);
923 error("Unknown file format '%s'", fmt
);
927 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
| BDRV_O_NO_BACKING
, drv
) < 0) {
928 error("Could not open '%s'", filename
);
930 bdrv_get_format(bs
, fmt_name
, sizeof(fmt_name
));
931 bdrv_get_geometry(bs
, &total_sectors
);
932 get_human_readable_size(size_buf
, sizeof(size_buf
), total_sectors
* 512);
933 allocated_size
= get_allocated_file_size(filename
);
934 if (allocated_size
< 0)
935 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
937 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
941 "virtual size: %s (%" PRId64
" bytes)\n"
943 filename
, fmt_name
, size_buf
,
944 (total_sectors
* 512),
946 if (bdrv_is_encrypted(bs
))
947 printf("encrypted: yes\n");
948 if (bdrv_get_info(bs
, &bdi
) >= 0) {
949 if (bdi
.cluster_size
!= 0)
950 printf("cluster_size: %d\n", bdi
.cluster_size
);
952 bdrv_get_backing_filename(bs
, backing_filename
, sizeof(backing_filename
));
953 if (backing_filename
[0] != '\0') {
954 path_combine(backing_filename2
, sizeof(backing_filename2
),
955 filename
, backing_filename
);
956 printf("backing file: %s (actual path: %s)\n",
965 #define SNAPSHOT_LIST 1
966 #define SNAPSHOT_CREATE 2
967 #define SNAPSHOT_APPLY 3
968 #define SNAPSHOT_DELETE 4
970 static int img_snapshot(int argc
, char **argv
)
972 BlockDriverState
*bs
;
974 char *filename
, *snapshot_name
= NULL
;
975 int c
, ret
, bdrv_oflags
;
979 bdrv_oflags
= BDRV_O_RDWR
;
980 /* Parse commandline parameters */
982 c
= getopt(argc
, argv
, "la:c:d:h");
994 action
= SNAPSHOT_LIST
;
995 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
1002 action
= SNAPSHOT_APPLY
;
1003 snapshot_name
= optarg
;
1010 action
= SNAPSHOT_CREATE
;
1011 snapshot_name
= optarg
;
1018 action
= SNAPSHOT_DELETE
;
1019 snapshot_name
= optarg
;
1026 filename
= argv
[optind
++];
1028 /* Open the image */
1031 error("Not enough memory");
1033 if (bdrv_open2(bs
, filename
, bdrv_oflags
, NULL
) < 0) {
1034 error("Could not open '%s'", filename
);
1037 /* Perform the requested action */
1043 case SNAPSHOT_CREATE
:
1044 memset(&sn
, 0, sizeof(sn
));
1045 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
1047 qemu_gettimeofday(&tv
);
1048 sn
.date_sec
= tv
.tv_sec
;
1049 sn
.date_nsec
= tv
.tv_usec
* 1000;
1051 ret
= bdrv_snapshot_create(bs
, &sn
);
1053 error("Could not create snapshot '%s': %d (%s)",
1054 snapshot_name
, ret
, strerror(-ret
));
1057 case SNAPSHOT_APPLY
:
1058 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
1060 error("Could not apply snapshot '%s': %d (%s)",
1061 snapshot_name
, ret
, strerror(-ret
));
1064 case SNAPSHOT_DELETE
:
1065 ret
= bdrv_snapshot_delete(bs
, snapshot_name
);
1067 error("Could not delete snapshot '%s': %d (%s)",
1068 snapshot_name
, ret
, strerror(-ret
));
1078 static int img_rebase(int argc
, char **argv
)
1080 BlockDriverState
*bs
, *bs_old_backing
, *bs_new_backing
;
1081 BlockDriver
*old_backing_drv
, *new_backing_drv
;
1083 const char *out_basefmt
, *out_baseimg
;
1087 /* Parse commandline parameters */
1092 c
= getopt(argc
, argv
, "uhF:b:");
1100 out_basefmt
= optarg
;
1103 out_baseimg
= optarg
;
1111 if ((optind
>= argc
) || !out_baseimg
)
1113 filename
= argv
[optind
++];
1118 * Ignore the old backing file for unsafe rebase in case we want to correct
1119 * the reference to a renamed or moved backing file.
1123 error("Not enough memory");
1125 flags
= BRDV_O_FLAGS
| BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
1126 if (bdrv_open2(bs
, filename
, flags
, NULL
) < 0) {
1127 error("Could not open '%s'", filename
);
1130 /* Find the right drivers for the backing files */
1131 old_backing_drv
= NULL
;
1132 new_backing_drv
= NULL
;
1134 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
1135 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
1136 if (old_backing_drv
== NULL
) {
1137 error("Invalid format name: '%s'", bs
->backing_format
);
1141 if (out_basefmt
!= NULL
) {
1142 new_backing_drv
= bdrv_find_format(out_basefmt
);
1143 if (new_backing_drv
== NULL
) {
1144 error("Invalid format name: '%s'", out_basefmt
);
1148 /* For safe rebasing we need to compare old and new backing file */
1150 /* Make the compiler happy */
1151 bs_old_backing
= NULL
;
1152 bs_new_backing
= NULL
;
1154 char backing_name
[1024];
1156 bs_old_backing
= bdrv_new("old_backing");
1157 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
1158 if (bdrv_open2(bs_old_backing
, backing_name
, BRDV_O_FLAGS
,
1161 error("Could not open old backing file '%s'", backing_name
);
1165 bs_new_backing
= bdrv_new("new_backing");
1166 if (bdrv_open2(bs_new_backing
, out_baseimg
, BRDV_O_FLAGS
| BDRV_O_RDWR
,
1169 error("Could not open new backing file '%s'", backing_name
);
1175 * Check each unallocated cluster in the COW file. If it is unallocated,
1176 * accesses go to the backing file. We must therefore compare this cluster
1177 * in the old and new backing file, and if they differ we need to copy it
1178 * from the old backing file into the COW file.
1180 * If qemu-img crashes during this step, no harm is done. The content of
1181 * the image is the same as the original one at any time.
1184 uint64_t num_sectors
;
1187 uint8_t buf_old
[IO_BUF_SIZE
];
1188 uint8_t buf_new
[IO_BUF_SIZE
];
1190 bdrv_get_geometry(bs
, &num_sectors
);
1192 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
1194 /* How many sectors can we handle with the next read? */
1195 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
1196 n
= (IO_BUF_SIZE
/ 512);
1198 n
= num_sectors
- sector
;
1201 /* If the cluster is allocated, we don't need to take action */
1202 if (bdrv_is_allocated(bs
, sector
, n
, &n1
)) {
1207 /* Read old and new backing file */
1208 if (bdrv_read(bs_old_backing
, sector
, buf_old
, n
) < 0) {
1209 error("error while reading from old backing file");
1211 if (bdrv_read(bs_new_backing
, sector
, buf_new
, n
) < 0) {
1212 error("error while reading from new backing file");
1215 /* If they differ, we need to write to the COW file */
1216 uint64_t written
= 0;
1218 while (written
< n
) {
1221 if (compare_sectors(buf_old
+ written
* 512,
1222 buf_new
+ written
* 512, n
, &pnum
))
1224 ret
= bdrv_write(bs
, sector
+ written
,
1225 buf_old
+ written
* 512, pnum
);
1227 error("Error while writing to COW image: %s",
1238 * Change the backing file. All clusters that are different from the old
1239 * backing file are overwritten in the COW file now, so the visible content
1240 * doesn't change when we switch the backing file.
1242 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
1243 if (ret
== -ENOSPC
) {
1244 error("Could not change the backing file to '%s': No space left in "
1245 "the file header", out_baseimg
);
1246 } else if (ret
< 0) {
1247 error("Could not change the backing file to '%s': %s",
1248 out_baseimg
, strerror(-ret
));
1252 * TODO At this point it is possible to check if any clusters that are
1253 * allocated in the COW file are the same in the backing file. If so, they
1254 * could be dropped from the COW file. Don't do this before switching the
1255 * backing file, in case of a crash this would lead to corruption.
1260 bdrv_delete(bs_old_backing
);
1261 bdrv_delete(bs_new_backing
);
1269 static const img_cmd_t img_cmds
[] = {
1270 #define DEF(option, callback, arg_string) \
1271 { option, callback },
1272 #include "qemu-img-cmds.h"
1278 int main(int argc
, char **argv
)
1280 const img_cmd_t
*cmd
;
1281 const char *cmdname
;
1289 /* find the command */
1290 for(cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
1291 if (!strcmp(cmdname
, cmd
->name
)) {
1292 return cmd
->handler(argc
, argv
);