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 printf("qemu-img version " QEMU_VERSION
", Copyright (c) 2004-2008 Fabrice Bellard\n"
62 "usage: qemu-img command [command options]\n"
63 "QEMU disk image utility\n"
66 #define DEF(option, callback, arg_string) \
68 #include "qemu-img-cmds.h"
72 "Command parameters:\n"
73 " 'filename' is a disk image filename\n"
74 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
75 " 'size' is the disk image size in bytes. Optional suffixes\n"
76 " 'k' or 'K' (kilobyte, 1024), 'M' (megabyte, 1024k), 'G' (gigabyte, 1024M)\n"
77 " and T (terabyte, 1024G) are supported. 'b' is ignored.\n"
78 " 'output_filename' is the destination disk image filename\n"
79 " 'output_fmt' is the destination format\n"
80 " 'options' is a comma separated list of format specific options in a\n"
81 " name=value format. Use -o ? for an overview of the options supported by the\n"
83 " '-c' indicates that target image must be compressed (qcow format only)\n"
84 " '-u' enables unsafe rebasing. It is assumed that old and new backing file\n"
85 " match exactly. The image doesn't need a working backing file before\n"
86 " rebasing in this case (useful for renaming the backing file)\n"
87 " '-h' with or without a command shows this help and lists the supported formats\n"
89 "Parameters to snapshot subcommand:\n"
90 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
91 " '-a' applies a snapshot (revert disk to saved state)\n"
92 " '-c' creates a snapshot\n"
93 " '-d' deletes a snapshot\n"
94 " '-l' lists all snapshots in the given image\n"
96 printf("\nSupported formats:");
97 bdrv_iterate_format(format_print
, NULL
);
103 /* XXX: put correct support for win32 */
104 static int read_password(char *buf
, int buf_size
)
107 printf("Password: ");
114 if (i
< (buf_size
- 1))
125 static struct termios oldtty
;
127 static void term_exit(void)
129 tcsetattr (0, TCSANOW
, &oldtty
);
132 static void term_init(void)
139 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
140 |INLCR
|IGNCR
|ICRNL
|IXON
);
141 tty
.c_oflag
|= OPOST
;
142 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
143 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
148 tcsetattr (0, TCSANOW
, &tty
);
153 static int read_password(char *buf
, int buf_size
)
158 printf("password: ");
163 ret
= read(0, &ch
, 1);
165 if (errno
== EAGAIN
|| errno
== EINTR
) {
171 } else if (ret
== 0) {
179 if (i
< (buf_size
- 1))
190 static BlockDriverState
*bdrv_new_open(const char *filename
,
193 BlockDriverState
*bs
;
199 error("Not enough memory");
201 drv
= bdrv_find_format(fmt
);
203 error("Unknown file format '%s'", fmt
);
207 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
| BDRV_O_RDWR
, drv
) < 0) {
208 error("Could not open '%s'", filename
);
210 if (bdrv_is_encrypted(bs
)) {
211 printf("Disk image '%s' is encrypted.\n", filename
);
212 if (read_password(password
, sizeof(password
)) < 0)
213 error("No password given");
214 if (bdrv_set_key(bs
, password
) < 0)
215 error("invalid password");
220 static void add_old_style_options(const char *fmt
, QEMUOptionParameter
*list
,
221 int flags
, const char *base_filename
, const char *base_fmt
)
223 if (flags
& BLOCK_FLAG_ENCRYPT
) {
224 if (set_option_parameter(list
, BLOCK_OPT_ENCRYPT
, "on")) {
225 error("Encryption not supported for file format '%s'", fmt
);
228 if (flags
& BLOCK_FLAG_COMPAT6
) {
229 if (set_option_parameter(list
, BLOCK_OPT_COMPAT6
, "on")) {
230 error("VMDK version 6 not supported for file format '%s'", fmt
);
235 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FILE
, base_filename
)) {
236 error("Backing file not supported for file format '%s'", fmt
);
240 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
241 error("Backing file format not supported for file format '%s'", fmt
);
246 static int img_create(int argc
, char **argv
)
249 const char *fmt
= "raw";
250 const char *base_fmt
= NULL
;
251 const char *filename
;
252 const char *base_filename
= NULL
;
254 QEMUOptionParameter
*param
= NULL
;
255 char *options
= NULL
;
259 c
= getopt(argc
, argv
, "F:b:f:he6o:");
270 base_filename
= optarg
;
276 flags
|= BLOCK_FLAG_ENCRYPT
;
279 flags
|= BLOCK_FLAG_COMPAT6
;
287 /* Find driver and parse its options */
288 drv
= bdrv_find_format(fmt
);
290 error("Unknown file format '%s'", fmt
);
292 if (options
&& !strcmp(options
, "?")) {
293 print_option_help(drv
->create_options
);
297 /* Create parameter list with default values */
298 param
= parse_option_parameters("", drv
->create_options
, param
);
299 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, -1);
301 /* Parse -o options */
303 param
= parse_option_parameters(options
, drv
->create_options
, param
);
305 error("Invalid options for file format '%s'.", fmt
);
309 /* Get the filename */
312 filename
= argv
[optind
++];
314 /* Add size to parameters */
316 set_option_parameter(param
, BLOCK_OPT_SIZE
, argv
[optind
++]);
319 /* Add old-style options to parameters */
320 add_old_style_options(fmt
, param
, flags
, base_filename
, base_fmt
);
322 // The size for the image must always be specified, with one exception:
323 // If we are using a backing file, we can obtain the size from there
324 if (get_option_parameter(param
, BLOCK_OPT_SIZE
)->value
.n
== -1) {
326 QEMUOptionParameter
*backing_file
=
327 get_option_parameter(param
, BLOCK_OPT_BACKING_FILE
);
328 QEMUOptionParameter
*backing_fmt
=
329 get_option_parameter(param
, BLOCK_OPT_BACKING_FMT
);
331 if (backing_file
&& backing_file
->value
.s
) {
332 BlockDriverState
*bs
;
334 const char *fmt
= NULL
;
337 if (backing_fmt
&& backing_fmt
->value
.s
) {
338 if (bdrv_find_format(backing_fmt
->value
.s
)) {
339 fmt
= backing_fmt
->value
.s
;
341 error("Unknown backing file format '%s'",
342 backing_fmt
->value
.s
);
346 bs
= bdrv_new_open(backing_file
->value
.s
, fmt
);
347 bdrv_get_geometry(bs
, &size
);
351 snprintf(buf
, sizeof(buf
), "%" PRId64
, size
);
352 set_option_parameter(param
, BLOCK_OPT_SIZE
, buf
);
354 error("Image creation needs a size parameter");
358 printf("Formatting '%s', fmt=%s ", filename
, fmt
);
359 print_option_parameters(param
);
362 ret
= bdrv_create(drv
, filename
, param
);
363 free_option_parameters(param
);
366 if (ret
== -ENOTSUP
) {
367 error("Formatting or formatting option not supported for file format '%s'", fmt
);
368 } else if (ret
== -EFBIG
) {
369 error("The image size is too large for file format '%s'", fmt
);
371 error("Error while formatting");
377 static int img_check(int argc
, char **argv
)
380 const char *filename
, *fmt
;
382 BlockDriverState
*bs
;
386 c
= getopt(argc
, argv
, "f:h");
400 filename
= argv
[optind
++];
404 error("Not enough memory");
406 drv
= bdrv_find_format(fmt
);
408 error("Unknown file format '%s'", fmt
);
412 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
413 error("Could not open '%s'", filename
);
415 ret
= bdrv_check(bs
);
418 printf("No errors were found on the image.\n");
421 error("This image format does not support checks");
425 error("An error occurred during the check");
427 printf("%d errors were found on the image.\n", ret
);
436 static int img_commit(int argc
, char **argv
)
439 const char *filename
, *fmt
;
441 BlockDriverState
*bs
;
445 c
= getopt(argc
, argv
, "f:h");
459 filename
= argv
[optind
++];
463 error("Not enough memory");
465 drv
= bdrv_find_format(fmt
);
467 error("Unknown file format '%s'", fmt
);
471 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
| BDRV_O_RDWR
, drv
) < 0) {
472 error("Could not open '%s'", filename
);
474 ret
= bdrv_commit(bs
);
477 printf("Image committed.\n");
480 error("No disk inserted");
483 error("Image is read-only");
486 error("Image is already committed");
489 error("Error while committing image");
497 static int is_not_zero(const uint8_t *sector
, int len
)
501 for(i
= 0;i
< len
; i
++) {
502 if (((uint32_t *)sector
)[i
] != 0)
509 * Returns true iff the first sector pointed to by 'buf' contains at least
512 * 'pnum' is set to the number of sectors (including and immediately following
513 * the first one) that are known to be in the same allocated/unallocated state.
515 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
523 v
= is_not_zero(buf
, 512);
524 for(i
= 1; i
< n
; i
++) {
526 if (v
!= is_not_zero(buf
, 512))
534 * Compares two buffers sector by sector. Returns 0 if the first sector of both
535 * buffers matches, non-zero otherwise.
537 * pnum is set to the number of sectors (including and immediately following
538 * the first one) that are known to have the same comparison result
540 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
550 res
= !!memcmp(buf1
, buf2
, 512);
551 for(i
= 1; i
< n
; i
++) {
555 if (!!memcmp(buf1
, buf2
, 512) != res
) {
564 #define IO_BUF_SIZE (2 * 1024 * 1024)
566 static int img_convert(int argc
, char **argv
)
568 int c
, ret
, n
, n1
, bs_n
, bs_i
, flags
, cluster_size
, cluster_sectors
;
569 const char *fmt
, *out_fmt
, *out_baseimg
, *out_filename
;
571 BlockDriverState
**bs
, *out_bs
;
572 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
574 uint8_t buf
[IO_BUF_SIZE
];
577 QEMUOptionParameter
*param
= NULL
;
578 char *options
= NULL
;
585 c
= getopt(argc
, argv
, "f:O:B:hce6o:");
599 out_baseimg
= optarg
;
602 flags
|= BLOCK_FLAG_COMPRESS
;
605 flags
|= BLOCK_FLAG_ENCRYPT
;
608 flags
|= BLOCK_FLAG_COMPAT6
;
616 bs_n
= argc
- optind
- 1;
617 if (bs_n
< 1) help();
619 out_filename
= argv
[argc
- 1];
621 if (bs_n
> 1 && out_baseimg
)
622 error("-B makes no sense when concatenating multiple input images");
624 bs
= calloc(bs_n
, sizeof(BlockDriverState
*));
626 error("Out of memory");
629 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
630 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
);
632 error("Could not open '%s'", argv
[optind
+ bs_i
]);
633 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
634 total_sectors
+= bs_sectors
;
637 /* Find driver and parse its options */
638 drv
= bdrv_find_format(out_fmt
);
640 error("Unknown file format '%s'", out_fmt
);
642 if (options
&& !strcmp(options
, "?")) {
643 print_option_help(drv
->create_options
);
649 param
= parse_option_parameters(options
, drv
->create_options
, param
);
651 error("Invalid options for file format '%s'.", out_fmt
);
654 param
= parse_option_parameters("", drv
->create_options
, param
);
657 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, total_sectors
* 512);
658 add_old_style_options(out_fmt
, param
, flags
, out_baseimg
, NULL
);
660 /* Check if compression is supported */
661 if (flags
& BLOCK_FLAG_COMPRESS
) {
662 QEMUOptionParameter
*encryption
=
663 get_option_parameter(param
, BLOCK_OPT_ENCRYPT
);
665 if (!drv
->bdrv_write_compressed
) {
666 error("Compression not supported for this file format");
669 if (encryption
&& encryption
->value
.n
) {
670 error("Compression and encryption not supported at the same time");
674 /* Create the new image */
675 ret
= bdrv_create(drv
, out_filename
, param
);
676 free_option_parameters(param
);
679 if (ret
== -ENOTSUP
) {
680 error("Formatting not supported for file format '%s'", out_fmt
);
681 } else if (ret
== -EFBIG
) {
682 error("The image size is too large for file format '%s'", out_fmt
);
684 error("Error while formatting '%s'", out_filename
);
688 out_bs
= bdrv_new_open(out_filename
, out_fmt
);
692 bdrv_get_geometry(bs
[0], &bs_sectors
);
694 if (flags
& BLOCK_FLAG_COMPRESS
) {
695 if (bdrv_get_info(out_bs
, &bdi
) < 0)
696 error("could not get block driver info");
697 cluster_size
= bdi
.cluster_size
;
698 if (cluster_size
<= 0 || cluster_size
> IO_BUF_SIZE
)
699 error("invalid cluster size");
700 cluster_sectors
= cluster_size
>> 9;
707 nb_sectors
= total_sectors
- sector_num
;
710 if (nb_sectors
>= cluster_sectors
)
715 bs_num
= sector_num
- bs_offset
;
716 assert (bs_num
>= 0);
719 while (remainder
> 0) {
721 while (bs_num
== bs_sectors
) {
723 assert (bs_i
< bs_n
);
724 bs_offset
+= bs_sectors
;
725 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
727 /* printf("changing part: sector_num=%lld, "
728 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
729 sector_num, bs_i, bs_offset, bs_sectors); */
731 assert (bs_num
< bs_sectors
);
733 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
735 if (bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
) < 0)
736 error("error while reading");
743 assert (remainder
== 0);
745 if (n
< cluster_sectors
)
746 memset(buf
+ n
* 512, 0, cluster_size
- n
* 512);
747 if (is_not_zero(buf
, cluster_size
)) {
748 if (bdrv_write_compressed(out_bs
, sector_num
, buf
,
749 cluster_sectors
) != 0)
750 error("error while compressing sector %" PRId64
,
755 /* signal EOF to align */
756 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
758 sector_num
= 0; // total number of sectors converted so far
760 nb_sectors
= total_sectors
- sector_num
;
763 if (nb_sectors
>= (IO_BUF_SIZE
/ 512))
764 n
= (IO_BUF_SIZE
/ 512);
768 while (sector_num
- bs_offset
>= bs_sectors
) {
770 assert (bs_i
< bs_n
);
771 bs_offset
+= bs_sectors
;
772 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
773 /* printf("changing part: sector_num=%lld, bs_i=%d, "
774 "bs_offset=%lld, bs_sectors=%lld\n",
775 sector_num, bs_i, bs_offset, bs_sectors); */
778 if (n
> bs_offset
+ bs_sectors
- sector_num
)
779 n
= bs_offset
+ bs_sectors
- sector_num
;
781 if (!drv
->no_zero_init
) {
782 /* If the output image is being created as a copy on write image,
783 assume that sectors which are unallocated in the input image
784 are present in both the output's and input's base images (no
785 need to copy them). */
787 if (!bdrv_is_allocated(bs
[bs_i
], sector_num
- bs_offset
,
792 /* The next 'n1' sectors are allocated in the input image. Copy
793 only those as they may be followed by unallocated sectors. */
800 if (bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
) < 0)
801 error("error while reading");
802 /* NOTE: at the same time we convert, we do not write zero
803 sectors to have a chance to compress the image. Ideally, we
804 should add a specific call to have the info to go faster */
807 /* If the output image is being created as a copy on write image,
808 copy all sectors even the ones containing only NUL bytes,
809 because they may differ from the sectors in the base image.
811 If the output is to a host device, we also write out
812 sectors that are entirely 0, since whatever data was
813 already there is garbage, not 0s. */
814 if (drv
->no_zero_init
|| out_baseimg
||
815 is_allocated_sectors(buf1
, n
, &n1
)) {
816 if (bdrv_write(out_bs
, sector_num
, buf1
, n1
) < 0)
817 error("error while writing");
826 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++)
827 bdrv_delete(bs
[bs_i
]);
833 static int64_t get_allocated_file_size(const char *filename
)
835 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
, DWORD
*high
);
836 get_compressed_t get_compressed
;
839 /* WinNT support GetCompressedFileSize to determine allocate size */
840 get_compressed
= (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
841 if (get_compressed
) {
843 low
= get_compressed(filename
, &high
);
844 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
)
845 return (((int64_t) high
) << 32) + low
;
848 if (_stati64(filename
, &st
) < 0)
853 static int64_t get_allocated_file_size(const char *filename
)
856 if (stat(filename
, &st
) < 0)
858 return (int64_t)st
.st_blocks
* 512;
862 static void dump_snapshots(BlockDriverState
*bs
)
864 QEMUSnapshotInfo
*sn_tab
, *sn
;
868 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
871 printf("Snapshot list:\n");
872 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
873 for(i
= 0; i
< nb_sns
; i
++) {
875 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
880 static int img_info(int argc
, char **argv
)
883 const char *filename
, *fmt
;
885 BlockDriverState
*bs
;
886 char fmt_name
[128], size_buf
[128], dsize_buf
[128];
887 uint64_t total_sectors
;
888 int64_t allocated_size
;
889 char backing_filename
[1024];
890 char backing_filename2
[1024];
895 c
= getopt(argc
, argv
, "f:h");
909 filename
= argv
[optind
++];
913 error("Not enough memory");
915 drv
= bdrv_find_format(fmt
);
917 error("Unknown file format '%s'", fmt
);
921 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
| BDRV_O_NO_BACKING
, drv
) < 0) {
922 error("Could not open '%s'", filename
);
924 bdrv_get_format(bs
, fmt_name
, sizeof(fmt_name
));
925 bdrv_get_geometry(bs
, &total_sectors
);
926 get_human_readable_size(size_buf
, sizeof(size_buf
), total_sectors
* 512);
927 allocated_size
= get_allocated_file_size(filename
);
928 if (allocated_size
< 0)
929 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
931 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
935 "virtual size: %s (%" PRId64
" bytes)\n"
937 filename
, fmt_name
, size_buf
,
938 (total_sectors
* 512),
940 if (bdrv_is_encrypted(bs
))
941 printf("encrypted: yes\n");
942 if (bdrv_get_info(bs
, &bdi
) >= 0) {
943 if (bdi
.cluster_size
!= 0)
944 printf("cluster_size: %d\n", bdi
.cluster_size
);
946 bdrv_get_backing_filename(bs
, backing_filename
, sizeof(backing_filename
));
947 if (backing_filename
[0] != '\0') {
948 path_combine(backing_filename2
, sizeof(backing_filename2
),
949 filename
, backing_filename
);
950 printf("backing file: %s (actual path: %s)\n",
959 #define SNAPSHOT_LIST 1
960 #define SNAPSHOT_CREATE 2
961 #define SNAPSHOT_APPLY 3
962 #define SNAPSHOT_DELETE 4
964 static int img_snapshot(int argc
, char **argv
)
966 BlockDriverState
*bs
;
968 char *filename
, *snapshot_name
= NULL
;
969 int c
, ret
, bdrv_oflags
;
973 bdrv_oflags
= BDRV_O_RDWR
;
974 /* Parse commandline parameters */
976 c
= getopt(argc
, argv
, "la:c:d:h");
988 action
= SNAPSHOT_LIST
;
989 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
996 action
= SNAPSHOT_APPLY
;
997 snapshot_name
= optarg
;
1004 action
= SNAPSHOT_CREATE
;
1005 snapshot_name
= optarg
;
1012 action
= SNAPSHOT_DELETE
;
1013 snapshot_name
= optarg
;
1020 filename
= argv
[optind
++];
1022 /* Open the image */
1025 error("Not enough memory");
1027 if (bdrv_open2(bs
, filename
, bdrv_oflags
, NULL
) < 0) {
1028 error("Could not open '%s'", filename
);
1031 /* Perform the requested action */
1037 case SNAPSHOT_CREATE
:
1038 memset(&sn
, 0, sizeof(sn
));
1039 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
1041 qemu_gettimeofday(&tv
);
1042 sn
.date_sec
= tv
.tv_sec
;
1043 sn
.date_nsec
= tv
.tv_usec
* 1000;
1045 ret
= bdrv_snapshot_create(bs
, &sn
);
1047 error("Could not create snapshot '%s': %d (%s)",
1048 snapshot_name
, ret
, strerror(-ret
));
1051 case SNAPSHOT_APPLY
:
1052 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
1054 error("Could not apply snapshot '%s': %d (%s)",
1055 snapshot_name
, ret
, strerror(-ret
));
1058 case SNAPSHOT_DELETE
:
1059 ret
= bdrv_snapshot_delete(bs
, snapshot_name
);
1061 error("Could not delete snapshot '%s': %d (%s)",
1062 snapshot_name
, ret
, strerror(-ret
));
1072 static int img_rebase(int argc
, char **argv
)
1074 BlockDriverState
*bs
, *bs_old_backing
, *bs_new_backing
;
1075 BlockDriver
*old_backing_drv
, *new_backing_drv
;
1077 const char *out_basefmt
, *out_baseimg
;
1081 /* Parse commandline parameters */
1086 c
= getopt(argc
, argv
, "uhF:b:");
1094 out_basefmt
= optarg
;
1097 out_baseimg
= optarg
;
1105 if ((optind
>= argc
) || !out_baseimg
)
1107 filename
= argv
[optind
++];
1112 * Ignore the old backing file for unsafe rebase in case we want to correct
1113 * the reference to a renamed or moved backing file.
1117 error("Not enough memory");
1119 flags
= BRDV_O_FLAGS
| BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
1120 if (bdrv_open2(bs
, filename
, flags
, NULL
) < 0) {
1121 error("Could not open '%s'", filename
);
1124 /* Find the right drivers for the backing files */
1125 old_backing_drv
= NULL
;
1126 new_backing_drv
= NULL
;
1128 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
1129 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
1130 if (old_backing_drv
== NULL
) {
1131 error("Invalid format name: '%s'", bs
->backing_format
);
1135 if (out_basefmt
!= NULL
) {
1136 new_backing_drv
= bdrv_find_format(out_basefmt
);
1137 if (new_backing_drv
== NULL
) {
1138 error("Invalid format name: '%s'", out_basefmt
);
1142 /* For safe rebasing we need to compare old and new backing file */
1144 /* Make the compiler happy */
1145 bs_old_backing
= NULL
;
1146 bs_new_backing
= NULL
;
1148 char backing_name
[1024];
1150 bs_old_backing
= bdrv_new("old_backing");
1151 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
1152 if (bdrv_open2(bs_old_backing
, backing_name
, BRDV_O_FLAGS
,
1155 error("Could not open old backing file '%s'", backing_name
);
1159 bs_new_backing
= bdrv_new("new_backing");
1160 if (bdrv_open2(bs_new_backing
, out_baseimg
, BRDV_O_FLAGS
| BDRV_O_RDWR
,
1163 error("Could not open new backing file '%s'", backing_name
);
1169 * Check each unallocated cluster in the COW file. If it is unallocated,
1170 * accesses go to the backing file. We must therefore compare this cluster
1171 * in the old and new backing file, and if they differ we need to copy it
1172 * from the old backing file into the COW file.
1174 * If qemu-img crashes during this step, no harm is done. The content of
1175 * the image is the same as the original one at any time.
1178 uint64_t num_sectors
;
1181 uint8_t buf_old
[IO_BUF_SIZE
];
1182 uint8_t buf_new
[IO_BUF_SIZE
];
1184 bdrv_get_geometry(bs
, &num_sectors
);
1186 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
1188 /* How many sectors can we handle with the next read? */
1189 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
1190 n
= (IO_BUF_SIZE
/ 512);
1192 n
= num_sectors
- sector
;
1195 /* If the cluster is allocated, we don't need to take action */
1196 if (bdrv_is_allocated(bs
, sector
, n
, &n1
)) {
1201 /* Read old and new backing file */
1202 if (bdrv_read(bs_old_backing
, sector
, buf_old
, n
) < 0) {
1203 error("error while reading from old backing file");
1205 if (bdrv_read(bs_new_backing
, sector
, buf_new
, n
) < 0) {
1206 error("error while reading from new backing file");
1209 /* If they differ, we need to write to the COW file */
1210 uint64_t written
= 0;
1212 while (written
< n
) {
1215 if (compare_sectors(buf_old
+ written
* 512,
1216 buf_new
+ written
* 512, n
, &pnum
))
1218 ret
= bdrv_write(bs
, sector
+ written
,
1219 buf_old
+ written
* 512, pnum
);
1221 error("Error while writing to COW image: %s",
1232 * Change the backing file. All clusters that are different from the old
1233 * backing file are overwritten in the COW file now, so the visible content
1234 * doesn't change when we switch the backing file.
1236 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
1237 if (ret
== -ENOSPC
) {
1238 error("Could not change the backing file to '%s': No space left in "
1239 "the file header", out_baseimg
);
1240 } else if (ret
< 0) {
1241 error("Could not change the backing file to '%s': %s",
1242 out_baseimg
, strerror(-ret
));
1246 * TODO At this point it is possible to check if any clusters that are
1247 * allocated in the COW file are the same in the backing file. If so, they
1248 * could be dropped from the COW file. Don't do this before switching the
1249 * backing file, in case of a crash this would lead to corruption.
1254 bdrv_delete(bs_old_backing
);
1255 bdrv_delete(bs_new_backing
);
1263 static const img_cmd_t img_cmds
[] = {
1264 #define DEF(option, callback, arg_string) \
1265 { option, callback },
1266 #include "qemu-img-cmds.h"
1272 int main(int argc
, char **argv
)
1274 const img_cmd_t
*cmd
;
1275 const char *cmdname
;
1283 /* find the command */
1284 for(cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
1285 if (!strcmp(cmdname
, cmd
->name
)) {
1286 return cmd
->handler(argc
, argv
);