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 BDRV_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
;
201 error("Not enough memory");
203 drv
= bdrv_find_format(fmt
);
205 error("Unknown file format '%s'", fmt
);
209 if (bdrv_open(bs
, filename
, flags
, drv
) < 0) {
210 error("Could not open '%s'", filename
);
212 if (bdrv_is_encrypted(bs
)) {
213 printf("Disk image '%s' is encrypted.\n", filename
);
214 if (read_password(password
, sizeof(password
)) < 0)
215 error("No password given");
216 if (bdrv_set_key(bs
, password
) < 0)
217 error("invalid password");
222 static void add_old_style_options(const char *fmt
, QEMUOptionParameter
*list
,
223 int flags
, const char *base_filename
, const char *base_fmt
)
225 if (flags
& BLOCK_FLAG_ENCRYPT
) {
226 if (set_option_parameter(list
, BLOCK_OPT_ENCRYPT
, "on")) {
227 error("Encryption not supported for file format '%s'", fmt
);
230 if (flags
& BLOCK_FLAG_COMPAT6
) {
231 if (set_option_parameter(list
, BLOCK_OPT_COMPAT6
, "on")) {
232 error("VMDK version 6 not supported for file format '%s'", fmt
);
237 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FILE
, base_filename
)) {
238 error("Backing file not supported for file format '%s'", fmt
);
242 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
243 error("Backing file format not supported for file format '%s'", fmt
);
248 static int img_create(int argc
, char **argv
)
251 const char *fmt
= "raw";
252 const char *base_fmt
= NULL
;
253 const char *filename
;
254 const char *base_filename
= NULL
;
256 QEMUOptionParameter
*param
= NULL
;
257 char *options
= NULL
;
261 c
= getopt(argc
, argv
, "F:b:f:he6o:");
272 base_filename
= optarg
;
278 flags
|= BLOCK_FLAG_ENCRYPT
;
281 flags
|= BLOCK_FLAG_COMPAT6
;
289 /* Find driver and parse its options */
290 drv
= bdrv_find_format(fmt
);
292 error("Unknown file format '%s'", fmt
);
294 if (options
&& !strcmp(options
, "?")) {
295 print_option_help(drv
->create_options
);
299 /* Create parameter list with default values */
300 param
= parse_option_parameters("", drv
->create_options
, param
);
301 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, -1);
303 /* Parse -o options */
305 param
= parse_option_parameters(options
, drv
->create_options
, param
);
307 error("Invalid options for file format '%s'.", fmt
);
311 /* Get the filename */
314 filename
= argv
[optind
++];
316 /* Add size to parameters */
318 set_option_parameter(param
, BLOCK_OPT_SIZE
, argv
[optind
++]);
321 /* Add old-style options to parameters */
322 add_old_style_options(fmt
, param
, flags
, base_filename
, base_fmt
);
324 // The size for the image must always be specified, with one exception:
325 // If we are using a backing file, we can obtain the size from there
326 if (get_option_parameter(param
, BLOCK_OPT_SIZE
)->value
.n
== -1) {
328 QEMUOptionParameter
*backing_file
=
329 get_option_parameter(param
, BLOCK_OPT_BACKING_FILE
);
330 QEMUOptionParameter
*backing_fmt
=
331 get_option_parameter(param
, BLOCK_OPT_BACKING_FMT
);
333 if (backing_file
&& backing_file
->value
.s
) {
334 BlockDriverState
*bs
;
336 const char *fmt
= NULL
;
339 if (backing_fmt
&& backing_fmt
->value
.s
) {
340 if (bdrv_find_format(backing_fmt
->value
.s
)) {
341 fmt
= backing_fmt
->value
.s
;
343 error("Unknown backing file format '%s'",
344 backing_fmt
->value
.s
);
348 bs
= bdrv_new_open(backing_file
->value
.s
, fmt
, BDRV_O_FLAGS
);
349 bdrv_get_geometry(bs
, &size
);
353 snprintf(buf
, sizeof(buf
), "%" PRId64
, size
);
354 set_option_parameter(param
, BLOCK_OPT_SIZE
, buf
);
356 error("Image creation needs a size parameter");
360 printf("Formatting '%s', fmt=%s ", filename
, fmt
);
361 print_option_parameters(param
);
364 ret
= bdrv_create(drv
, filename
, param
);
365 free_option_parameters(param
);
368 if (ret
== -ENOTSUP
) {
369 error("Formatting or formatting option not supported for file format '%s'", fmt
);
370 } else if (ret
== -EFBIG
) {
371 error("The image size is too large for file format '%s'", fmt
);
373 error("%s: error while creating %s: %s", filename
, fmt
, strerror(-ret
));
379 static int img_check(int argc
, char **argv
)
382 const char *filename
, *fmt
;
383 BlockDriverState
*bs
;
387 c
= getopt(argc
, argv
, "f:h");
401 filename
= argv
[optind
++];
403 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
);
404 ret
= bdrv_check(bs
);
407 printf("No errors were found on the image.\n");
410 error("This image format does not support checks");
414 error("An error occurred during the check");
416 printf("%d errors were found on the image.\n", ret
);
425 static int img_commit(int argc
, char **argv
)
428 const char *filename
, *fmt
;
429 BlockDriverState
*bs
;
433 c
= getopt(argc
, argv
, "f:h");
447 filename
= argv
[optind
++];
449 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
);
450 ret
= bdrv_commit(bs
);
453 printf("Image committed.\n");
456 error("No disk inserted");
459 error("Image is read-only");
462 error("Image is already committed");
465 error("Error while committing image");
473 static int is_not_zero(const uint8_t *sector
, int len
)
477 for(i
= 0;i
< len
; i
++) {
478 if (((uint32_t *)sector
)[i
] != 0)
485 * Returns true iff the first sector pointed to by 'buf' contains at least
488 * 'pnum' is set to the number of sectors (including and immediately following
489 * the first one) that are known to be in the same allocated/unallocated state.
491 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
499 v
= is_not_zero(buf
, 512);
500 for(i
= 1; i
< n
; i
++) {
502 if (v
!= is_not_zero(buf
, 512))
510 * Compares two buffers sector by sector. Returns 0 if the first sector of both
511 * buffers matches, non-zero otherwise.
513 * pnum is set to the number of sectors (including and immediately following
514 * the first one) that are known to have the same comparison result
516 static int compare_sectors(const uint8_t *buf1
, const uint8_t *buf2
, int n
,
526 res
= !!memcmp(buf1
, buf2
, 512);
527 for(i
= 1; i
< n
; i
++) {
531 if (!!memcmp(buf1
, buf2
, 512) != res
) {
540 #define IO_BUF_SIZE (2 * 1024 * 1024)
542 static int img_convert(int argc
, char **argv
)
544 int c
, ret
, n
, n1
, bs_n
, bs_i
, flags
, cluster_size
, cluster_sectors
;
545 const char *fmt
, *out_fmt
, *out_baseimg
, *out_filename
;
547 BlockDriverState
**bs
, *out_bs
;
548 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
553 QEMUOptionParameter
*param
= NULL
;
554 char *options
= NULL
;
561 c
= getopt(argc
, argv
, "f:O:B:hce6o:");
575 out_baseimg
= optarg
;
578 flags
|= BLOCK_FLAG_COMPRESS
;
581 flags
|= BLOCK_FLAG_ENCRYPT
;
584 flags
|= BLOCK_FLAG_COMPAT6
;
592 bs_n
= argc
- optind
- 1;
593 if (bs_n
< 1) help();
595 out_filename
= argv
[argc
- 1];
597 if (bs_n
> 1 && out_baseimg
)
598 error("-B makes no sense when concatenating multiple input images");
600 bs
= calloc(bs_n
, sizeof(BlockDriverState
*));
602 error("Out of memory");
605 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
606 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
, BDRV_O_FLAGS
);
608 error("Could not open '%s'", argv
[optind
+ bs_i
]);
609 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
610 total_sectors
+= bs_sectors
;
613 /* Find driver and parse its options */
614 drv
= bdrv_find_format(out_fmt
);
616 error("Unknown file format '%s'", out_fmt
);
618 if (options
&& !strcmp(options
, "?")) {
619 print_option_help(drv
->create_options
);
625 param
= parse_option_parameters(options
, drv
->create_options
, param
);
627 error("Invalid options for file format '%s'.", out_fmt
);
630 param
= parse_option_parameters("", drv
->create_options
, param
);
633 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, total_sectors
* 512);
634 add_old_style_options(out_fmt
, param
, flags
, out_baseimg
, NULL
);
636 /* Check if compression is supported */
637 if (flags
& BLOCK_FLAG_COMPRESS
) {
638 QEMUOptionParameter
*encryption
=
639 get_option_parameter(param
, BLOCK_OPT_ENCRYPT
);
641 if (!drv
->bdrv_write_compressed
) {
642 error("Compression not supported for this file format");
645 if (encryption
&& encryption
->value
.n
) {
646 error("Compression and encryption not supported at the same time");
650 /* Create the new image */
651 ret
= bdrv_create(drv
, out_filename
, param
);
652 free_option_parameters(param
);
655 if (ret
== -ENOTSUP
) {
656 error("Formatting not supported for file format '%s'", out_fmt
);
657 } else if (ret
== -EFBIG
) {
658 error("The image size is too large for file format '%s'", out_fmt
);
660 error("%s: error while converting %s: %s", out_filename
, out_fmt
, strerror(-ret
));
664 out_bs
= bdrv_new_open(out_filename
, out_fmt
, BDRV_O_FLAGS
| BDRV_O_RDWR
);
668 bdrv_get_geometry(bs
[0], &bs_sectors
);
669 buf
= qemu_malloc(IO_BUF_SIZE
);
671 if (flags
& BLOCK_FLAG_COMPRESS
) {
672 if (bdrv_get_info(out_bs
, &bdi
) < 0)
673 error("could not get block driver info");
674 cluster_size
= bdi
.cluster_size
;
675 if (cluster_size
<= 0 || cluster_size
> IO_BUF_SIZE
)
676 error("invalid cluster size");
677 cluster_sectors
= cluster_size
>> 9;
684 nb_sectors
= total_sectors
- sector_num
;
687 if (nb_sectors
>= cluster_sectors
)
692 bs_num
= sector_num
- bs_offset
;
693 assert (bs_num
>= 0);
696 while (remainder
> 0) {
698 while (bs_num
== bs_sectors
) {
700 assert (bs_i
< bs_n
);
701 bs_offset
+= bs_sectors
;
702 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
704 /* printf("changing part: sector_num=%lld, "
705 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
706 sector_num, bs_i, bs_offset, bs_sectors); */
708 assert (bs_num
< bs_sectors
);
710 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
712 if (bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
) < 0)
713 error("error while reading");
720 assert (remainder
== 0);
722 if (n
< cluster_sectors
)
723 memset(buf
+ n
* 512, 0, cluster_size
- n
* 512);
724 if (is_not_zero(buf
, cluster_size
)) {
725 if (bdrv_write_compressed(out_bs
, sector_num
, buf
,
726 cluster_sectors
) != 0)
727 error("error while compressing sector %" PRId64
,
732 /* signal EOF to align */
733 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
735 sector_num
= 0; // total number of sectors converted so far
737 nb_sectors
= total_sectors
- sector_num
;
740 if (nb_sectors
>= (IO_BUF_SIZE
/ 512))
741 n
= (IO_BUF_SIZE
/ 512);
745 while (sector_num
- bs_offset
>= bs_sectors
) {
747 assert (bs_i
< bs_n
);
748 bs_offset
+= bs_sectors
;
749 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
750 /* printf("changing part: sector_num=%lld, bs_i=%d, "
751 "bs_offset=%lld, bs_sectors=%lld\n",
752 sector_num, bs_i, bs_offset, bs_sectors); */
755 if (n
> bs_offset
+ bs_sectors
- sector_num
)
756 n
= bs_offset
+ bs_sectors
- sector_num
;
758 if (!drv
->no_zero_init
) {
759 /* If the output image is being created as a copy on write image,
760 assume that sectors which are unallocated in the input image
761 are present in both the output's and input's base images (no
762 need to copy them). */
764 if (!bdrv_is_allocated(bs
[bs_i
], sector_num
- bs_offset
,
769 /* The next 'n1' sectors are allocated in the input image. Copy
770 only those as they may be followed by unallocated sectors. */
777 if (bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
) < 0)
778 error("error while reading");
779 /* NOTE: at the same time we convert, we do not write zero
780 sectors to have a chance to compress the image. Ideally, we
781 should add a specific call to have the info to go faster */
784 /* If the output image is being created as a copy on write image,
785 copy all sectors even the ones containing only NUL bytes,
786 because they may differ from the sectors in the base image.
788 If the output is to a host device, we also write out
789 sectors that are entirely 0, since whatever data was
790 already there is garbage, not 0s. */
791 if (drv
->no_zero_init
|| out_baseimg
||
792 is_allocated_sectors(buf1
, n
, &n1
)) {
793 if (bdrv_write(out_bs
, sector_num
, buf1
, n1
) < 0)
794 error("error while writing");
804 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++)
805 bdrv_delete(bs
[bs_i
]);
811 static int64_t get_allocated_file_size(const char *filename
)
813 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
, DWORD
*high
);
814 get_compressed_t get_compressed
;
817 /* WinNT support GetCompressedFileSize to determine allocate size */
818 get_compressed
= (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
819 if (get_compressed
) {
821 low
= get_compressed(filename
, &high
);
822 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
)
823 return (((int64_t) high
) << 32) + low
;
826 if (_stati64(filename
, &st
) < 0)
831 static int64_t get_allocated_file_size(const char *filename
)
834 if (stat(filename
, &st
) < 0)
836 return (int64_t)st
.st_blocks
* 512;
840 static void dump_snapshots(BlockDriverState
*bs
)
842 QEMUSnapshotInfo
*sn_tab
, *sn
;
846 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
849 printf("Snapshot list:\n");
850 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
851 for(i
= 0; i
< nb_sns
; i
++) {
853 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
858 static int img_info(int argc
, char **argv
)
861 const char *filename
, *fmt
;
862 BlockDriverState
*bs
;
863 char fmt_name
[128], size_buf
[128], dsize_buf
[128];
864 uint64_t total_sectors
;
865 int64_t allocated_size
;
866 char backing_filename
[1024];
867 char backing_filename2
[1024];
872 c
= getopt(argc
, argv
, "f:h");
886 filename
= argv
[optind
++];
888 bs
= bdrv_new_open(filename
, fmt
, BDRV_O_FLAGS
| BDRV_O_NO_BACKING
);
889 bdrv_get_format(bs
, fmt_name
, sizeof(fmt_name
));
890 bdrv_get_geometry(bs
, &total_sectors
);
891 get_human_readable_size(size_buf
, sizeof(size_buf
), total_sectors
* 512);
892 allocated_size
= get_allocated_file_size(filename
);
893 if (allocated_size
< 0)
894 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
896 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
900 "virtual size: %s (%" PRId64
" bytes)\n"
902 filename
, fmt_name
, size_buf
,
903 (total_sectors
* 512),
905 if (bdrv_is_encrypted(bs
))
906 printf("encrypted: yes\n");
907 if (bdrv_get_info(bs
, &bdi
) >= 0) {
908 if (bdi
.cluster_size
!= 0)
909 printf("cluster_size: %d\n", bdi
.cluster_size
);
911 bdrv_get_backing_filename(bs
, backing_filename
, sizeof(backing_filename
));
912 if (backing_filename
[0] != '\0') {
913 path_combine(backing_filename2
, sizeof(backing_filename2
),
914 filename
, backing_filename
);
915 printf("backing file: %s (actual path: %s)\n",
924 #define SNAPSHOT_LIST 1
925 #define SNAPSHOT_CREATE 2
926 #define SNAPSHOT_APPLY 3
927 #define SNAPSHOT_DELETE 4
929 static int img_snapshot(int argc
, char **argv
)
931 BlockDriverState
*bs
;
933 char *filename
, *snapshot_name
= NULL
;
934 int c
, ret
, bdrv_oflags
;
938 bdrv_oflags
= BDRV_O_RDWR
;
939 /* Parse commandline parameters */
941 c
= getopt(argc
, argv
, "la:c:d:h");
953 action
= SNAPSHOT_LIST
;
954 bdrv_oflags
&= ~BDRV_O_RDWR
; /* no need for RW */
961 action
= SNAPSHOT_APPLY
;
962 snapshot_name
= optarg
;
969 action
= SNAPSHOT_CREATE
;
970 snapshot_name
= optarg
;
977 action
= SNAPSHOT_DELETE
;
978 snapshot_name
= optarg
;
985 filename
= argv
[optind
++];
988 bs
= bdrv_new_open(filename
, NULL
, bdrv_oflags
);
990 /* Perform the requested action */
996 case SNAPSHOT_CREATE
:
997 memset(&sn
, 0, sizeof(sn
));
998 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
1000 qemu_gettimeofday(&tv
);
1001 sn
.date_sec
= tv
.tv_sec
;
1002 sn
.date_nsec
= tv
.tv_usec
* 1000;
1004 ret
= bdrv_snapshot_create(bs
, &sn
);
1006 error("Could not create snapshot '%s': %d (%s)",
1007 snapshot_name
, ret
, strerror(-ret
));
1010 case SNAPSHOT_APPLY
:
1011 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
1013 error("Could not apply snapshot '%s': %d (%s)",
1014 snapshot_name
, ret
, strerror(-ret
));
1017 case SNAPSHOT_DELETE
:
1018 ret
= bdrv_snapshot_delete(bs
, snapshot_name
);
1020 error("Could not delete snapshot '%s': %d (%s)",
1021 snapshot_name
, ret
, strerror(-ret
));
1031 static int img_rebase(int argc
, char **argv
)
1033 BlockDriverState
*bs
, *bs_old_backing
, *bs_new_backing
;
1034 BlockDriver
*old_backing_drv
, *new_backing_drv
;
1036 const char *fmt
, *out_basefmt
, *out_baseimg
;
1040 /* Parse commandline parameters */
1046 c
= getopt(argc
, argv
, "uhf:F:b:");
1057 out_basefmt
= optarg
;
1060 out_baseimg
= optarg
;
1068 if ((optind
>= argc
) || !out_baseimg
)
1070 filename
= argv
[optind
++];
1075 * Ignore the old backing file for unsafe rebase in case we want to correct
1076 * the reference to a renamed or moved backing file.
1078 flags
= BDRV_O_FLAGS
| BDRV_O_RDWR
| (unsafe
? BDRV_O_NO_BACKING
: 0);
1079 bs
= bdrv_new_open(filename
, fmt
, flags
);
1081 /* Find the right drivers for the backing files */
1082 old_backing_drv
= NULL
;
1083 new_backing_drv
= NULL
;
1085 if (!unsafe
&& bs
->backing_format
[0] != '\0') {
1086 old_backing_drv
= bdrv_find_format(bs
->backing_format
);
1087 if (old_backing_drv
== NULL
) {
1088 error("Invalid format name: '%s'", bs
->backing_format
);
1092 if (out_basefmt
!= NULL
) {
1093 new_backing_drv
= bdrv_find_format(out_basefmt
);
1094 if (new_backing_drv
== NULL
) {
1095 error("Invalid format name: '%s'", out_basefmt
);
1099 /* For safe rebasing we need to compare old and new backing file */
1101 /* Make the compiler happy */
1102 bs_old_backing
= NULL
;
1103 bs_new_backing
= NULL
;
1105 char backing_name
[1024];
1107 bs_old_backing
= bdrv_new("old_backing");
1108 bdrv_get_backing_filename(bs
, backing_name
, sizeof(backing_name
));
1109 if (bdrv_open(bs_old_backing
, backing_name
, BDRV_O_FLAGS
,
1112 error("Could not open old backing file '%s'", backing_name
);
1116 bs_new_backing
= bdrv_new("new_backing");
1117 if (bdrv_open(bs_new_backing
, out_baseimg
, BDRV_O_FLAGS
| BDRV_O_RDWR
,
1120 error("Could not open new backing file '%s'", out_baseimg
);
1126 * Check each unallocated cluster in the COW file. If it is unallocated,
1127 * accesses go to the backing file. We must therefore compare this cluster
1128 * in the old and new backing file, and if they differ we need to copy it
1129 * from the old backing file into the COW file.
1131 * If qemu-img crashes during this step, no harm is done. The content of
1132 * the image is the same as the original one at any time.
1135 uint64_t num_sectors
;
1141 buf_old
= qemu_malloc(IO_BUF_SIZE
);
1142 buf_new
= qemu_malloc(IO_BUF_SIZE
);
1144 bdrv_get_geometry(bs
, &num_sectors
);
1146 for (sector
= 0; sector
< num_sectors
; sector
+= n
) {
1148 /* How many sectors can we handle with the next read? */
1149 if (sector
+ (IO_BUF_SIZE
/ 512) <= num_sectors
) {
1150 n
= (IO_BUF_SIZE
/ 512);
1152 n
= num_sectors
- sector
;
1155 /* If the cluster is allocated, we don't need to take action */
1156 if (bdrv_is_allocated(bs
, sector
, n
, &n1
)) {
1161 /* Read old and new backing file */
1162 if (bdrv_read(bs_old_backing
, sector
, buf_old
, n
) < 0) {
1163 error("error while reading from old backing file");
1165 if (bdrv_read(bs_new_backing
, sector
, buf_new
, n
) < 0) {
1166 error("error while reading from new backing file");
1169 /* If they differ, we need to write to the COW file */
1170 uint64_t written
= 0;
1172 while (written
< n
) {
1175 if (compare_sectors(buf_old
+ written
* 512,
1176 buf_new
+ written
* 512, n
- written
, &pnum
))
1178 ret
= bdrv_write(bs
, sector
+ written
,
1179 buf_old
+ written
* 512, pnum
);
1181 error("Error while writing to COW image: %s",
1195 * Change the backing file. All clusters that are different from the old
1196 * backing file are overwritten in the COW file now, so the visible content
1197 * doesn't change when we switch the backing file.
1199 ret
= bdrv_change_backing_file(bs
, out_baseimg
, out_basefmt
);
1200 if (ret
== -ENOSPC
) {
1201 error("Could not change the backing file to '%s': No space left in "
1202 "the file header", out_baseimg
);
1203 } else if (ret
< 0) {
1204 error("Could not change the backing file to '%s': %s",
1205 out_baseimg
, strerror(-ret
));
1209 * TODO At this point it is possible to check if any clusters that are
1210 * allocated in the COW file are the same in the backing file. If so, they
1211 * could be dropped from the COW file. Don't do this before switching the
1212 * backing file, in case of a crash this would lead to corruption.
1217 bdrv_delete(bs_old_backing
);
1218 bdrv_delete(bs_new_backing
);
1226 static const img_cmd_t img_cmds
[] = {
1227 #define DEF(option, callback, arg_string) \
1228 { option, callback },
1229 #include "qemu-img-cmds.h"
1235 int main(int argc
, char **argv
)
1237 const img_cmd_t
*cmd
;
1238 const char *cmdname
;
1246 /* find the command */
1247 for(cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
1248 if (!strcmp(cmdname
, cmd
->name
)) {
1249 return cmd
->handler(argc
, argv
);