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 " '-h' with or without a command shows this help and lists the supported formats\n"
86 "Parameters to snapshot subcommand:\n"
87 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
88 " '-a' applies a snapshot (revert disk to saved state)\n"
89 " '-c' creates a snapshot\n"
90 " '-d' deletes a snapshot\n"
91 " '-l' lists all snapshots in the given image\n"
93 printf("\nSupported formats:");
94 bdrv_iterate_format(format_print
, NULL
);
100 /* XXX: put correct support for win32 */
101 static int read_password(char *buf
, int buf_size
)
104 printf("Password: ");
111 if (i
< (buf_size
- 1))
122 static struct termios oldtty
;
124 static void term_exit(void)
126 tcsetattr (0, TCSANOW
, &oldtty
);
129 static void term_init(void)
136 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
137 |INLCR
|IGNCR
|ICRNL
|IXON
);
138 tty
.c_oflag
|= OPOST
;
139 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
140 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
145 tcsetattr (0, TCSANOW
, &tty
);
150 static int read_password(char *buf
, int buf_size
)
155 printf("password: ");
160 ret
= read(0, &ch
, 1);
162 if (errno
== EAGAIN
|| errno
== EINTR
) {
168 } else if (ret
== 0) {
176 if (i
< (buf_size
- 1))
187 static BlockDriverState
*bdrv_new_open(const char *filename
,
190 BlockDriverState
*bs
;
196 error("Not enough memory");
198 drv
= bdrv_find_format(fmt
);
200 error("Unknown file format '%s'", fmt
);
204 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
205 error("Could not open '%s'", filename
);
207 if (bdrv_is_encrypted(bs
)) {
208 printf("Disk image '%s' is encrypted.\n", filename
);
209 if (read_password(password
, sizeof(password
)) < 0)
210 error("No password given");
211 if (bdrv_set_key(bs
, password
) < 0)
212 error("invalid password");
217 static void add_old_style_options(const char *fmt
, QEMUOptionParameter
*list
,
218 int flags
, const char *base_filename
, const char *base_fmt
)
220 if (flags
& BLOCK_FLAG_ENCRYPT
) {
221 if (set_option_parameter(list
, BLOCK_OPT_ENCRYPT
, "on")) {
222 error("Encryption not supported for file format '%s'", fmt
);
225 if (flags
& BLOCK_FLAG_COMPAT6
) {
226 if (set_option_parameter(list
, BLOCK_OPT_COMPAT6
, "on")) {
227 error("VMDK version 6 not supported for file format '%s'", fmt
);
232 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FILE
, base_filename
)) {
233 error("Backing file not supported for file format '%s'", fmt
);
237 if (set_option_parameter(list
, BLOCK_OPT_BACKING_FMT
, base_fmt
)) {
238 error("Backing file format not supported for file format '%s'", fmt
);
243 static int img_create(int argc
, char **argv
)
246 const char *fmt
= "raw";
247 const char *base_fmt
= NULL
;
248 const char *filename
;
249 const char *base_filename
= NULL
;
251 QEMUOptionParameter
*param
= NULL
;
252 char *options
= NULL
;
256 c
= getopt(argc
, argv
, "F:b:f:he6o:");
267 base_filename
= optarg
;
273 flags
|= BLOCK_FLAG_ENCRYPT
;
276 flags
|= BLOCK_FLAG_COMPAT6
;
284 /* Find driver and parse its options */
285 drv
= bdrv_find_format(fmt
);
287 error("Unknown file format '%s'", fmt
);
289 if (options
&& !strcmp(options
, "?")) {
290 print_option_help(drv
->create_options
);
294 /* Create parameter list with default values */
295 param
= parse_option_parameters("", drv
->create_options
, param
);
296 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, -1);
298 /* Parse -o options */
300 param
= parse_option_parameters(options
, drv
->create_options
, param
);
302 error("Invalid options for file format '%s'.", fmt
);
306 /* Get the filename */
309 filename
= argv
[optind
++];
311 /* Add size to parameters */
313 set_option_parameter(param
, BLOCK_OPT_SIZE
, argv
[optind
++]);
316 /* Add old-style options to parameters */
317 add_old_style_options(fmt
, param
, flags
, base_filename
, base_fmt
);
319 // The size for the image must always be specified, with one exception:
320 // If we are using a backing file, we can obtain the size from there
321 if (get_option_parameter(param
, BLOCK_OPT_SIZE
)->value
.n
== -1) {
323 QEMUOptionParameter
*backing_file
=
324 get_option_parameter(param
, BLOCK_OPT_BACKING_FILE
);
325 QEMUOptionParameter
*backing_fmt
=
326 get_option_parameter(param
, BLOCK_OPT_BACKING_FMT
);
328 if (backing_file
&& backing_file
->value
.s
) {
329 BlockDriverState
*bs
;
331 const char *fmt
= NULL
;
334 if (backing_fmt
&& backing_fmt
->value
.s
) {
335 if (bdrv_find_format(backing_fmt
->value
.s
)) {
336 fmt
= backing_fmt
->value
.s
;
338 error("Unknown backing file format '%s'",
339 backing_fmt
->value
.s
);
343 bs
= bdrv_new_open(backing_file
->value
.s
, fmt
);
344 bdrv_get_geometry(bs
, &size
);
348 snprintf(buf
, sizeof(buf
), "%" PRId64
, size
);
349 set_option_parameter(param
, BLOCK_OPT_SIZE
, buf
);
351 error("Image creation needs a size parameter");
355 printf("Formatting '%s', fmt=%s ", filename
, fmt
);
356 print_option_parameters(param
);
359 ret
= bdrv_create(drv
, filename
, param
);
360 free_option_parameters(param
);
363 if (ret
== -ENOTSUP
) {
364 error("Formatting or formatting option not supported for file format '%s'", fmt
);
365 } else if (ret
== -EFBIG
) {
366 error("The image size is too large for file format '%s'", fmt
);
368 error("Error while formatting");
374 static int img_check(int argc
, char **argv
)
377 const char *filename
, *fmt
;
379 BlockDriverState
*bs
;
383 c
= getopt(argc
, argv
, "f:h");
397 filename
= argv
[optind
++];
401 error("Not enough memory");
403 drv
= bdrv_find_format(fmt
);
405 error("Unknown file format '%s'", fmt
);
409 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
410 error("Could not open '%s'", filename
);
412 ret
= bdrv_check(bs
);
415 printf("No errors were found on the image.\n");
418 error("This image format does not support checks");
422 error("An error occurred during the check");
424 printf("%d errors were found on the image.\n", ret
);
433 static int img_commit(int argc
, char **argv
)
436 const char *filename
, *fmt
;
438 BlockDriverState
*bs
;
442 c
= getopt(argc
, argv
, "f:h");
456 filename
= argv
[optind
++];
460 error("Not enough memory");
462 drv
= bdrv_find_format(fmt
);
464 error("Unknown file format '%s'", fmt
);
468 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
469 error("Could not open '%s'", filename
);
471 ret
= bdrv_commit(bs
);
474 printf("Image committed.\n");
477 error("No disk inserted");
480 error("Image is read-only");
483 error("Image is already committed");
486 error("Error while committing image");
494 static int is_not_zero(const uint8_t *sector
, int len
)
498 for(i
= 0;i
< len
; i
++) {
499 if (((uint32_t *)sector
)[i
] != 0)
506 * Returns true iff the first sector pointed to by 'buf' contains at least
509 * 'pnum' is set to the number of sectors (including and immediately following
510 * the first one) that are known to be in the same allocated/unallocated state.
512 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
520 v
= is_not_zero(buf
, 512);
521 for(i
= 1; i
< n
; i
++) {
523 if (v
!= is_not_zero(buf
, 512))
530 #define IO_BUF_SIZE (2 * 1024 * 1024)
532 static int img_convert(int argc
, char **argv
)
534 int c
, ret
, n
, n1
, bs_n
, bs_i
, flags
, cluster_size
, cluster_sectors
;
535 const char *fmt
, *out_fmt
, *out_baseimg
, *out_filename
;
537 BlockDriverState
**bs
, *out_bs
;
538 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
540 uint8_t buf
[IO_BUF_SIZE
];
543 QEMUOptionParameter
*param
= NULL
;
544 char *options
= NULL
;
551 c
= getopt(argc
, argv
, "f:O:B:hce6o:");
565 out_baseimg
= optarg
;
568 flags
|= BLOCK_FLAG_COMPRESS
;
571 flags
|= BLOCK_FLAG_ENCRYPT
;
574 flags
|= BLOCK_FLAG_COMPAT6
;
582 bs_n
= argc
- optind
- 1;
583 if (bs_n
< 1) help();
585 out_filename
= argv
[argc
- 1];
587 if (bs_n
> 1 && out_baseimg
)
588 error("-B makes no sense when concatenating multiple input images");
590 bs
= calloc(bs_n
, sizeof(BlockDriverState
*));
592 error("Out of memory");
595 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
596 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
);
598 error("Could not open '%s'", argv
[optind
+ bs_i
]);
599 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
600 total_sectors
+= bs_sectors
;
603 /* Find driver and parse its options */
604 drv
= bdrv_find_format(out_fmt
);
606 error("Unknown file format '%s'", out_fmt
);
608 if (options
&& !strcmp(options
, "?")) {
609 print_option_help(drv
->create_options
);
615 param
= parse_option_parameters(options
, drv
->create_options
, param
);
617 error("Invalid options for file format '%s'.", out_fmt
);
620 param
= parse_option_parameters("", drv
->create_options
, param
);
623 set_option_parameter_int(param
, BLOCK_OPT_SIZE
, total_sectors
* 512);
624 add_old_style_options(out_fmt
, param
, flags
, out_baseimg
, NULL
);
626 /* Check if compression is supported */
627 if (flags
& BLOCK_FLAG_COMPRESS
) {
628 QEMUOptionParameter
*encryption
=
629 get_option_parameter(param
, BLOCK_OPT_ENCRYPT
);
631 if (!drv
->bdrv_write_compressed
) {
632 error("Compression not supported for this file format");
635 if (encryption
&& encryption
->value
.n
) {
636 error("Compression and encryption not supported at the same time");
640 /* Create the new image */
641 ret
= bdrv_create(drv
, out_filename
, param
);
642 free_option_parameters(param
);
645 if (ret
== -ENOTSUP
) {
646 error("Formatting not supported for file format '%s'", out_fmt
);
647 } else if (ret
== -EFBIG
) {
648 error("The image size is too large for file format '%s'", out_fmt
);
650 error("Error while formatting '%s'", out_filename
);
654 out_bs
= bdrv_new_open(out_filename
, out_fmt
);
658 bdrv_get_geometry(bs
[0], &bs_sectors
);
660 if (flags
& BLOCK_FLAG_COMPRESS
) {
661 if (bdrv_get_info(out_bs
, &bdi
) < 0)
662 error("could not get block driver info");
663 cluster_size
= bdi
.cluster_size
;
664 if (cluster_size
<= 0 || cluster_size
> IO_BUF_SIZE
)
665 error("invalid cluster size");
666 cluster_sectors
= cluster_size
>> 9;
673 nb_sectors
= total_sectors
- sector_num
;
676 if (nb_sectors
>= cluster_sectors
)
681 bs_num
= sector_num
- bs_offset
;
682 assert (bs_num
>= 0);
685 while (remainder
> 0) {
687 while (bs_num
== bs_sectors
) {
689 assert (bs_i
< bs_n
);
690 bs_offset
+= bs_sectors
;
691 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
693 /* printf("changing part: sector_num=%lld, "
694 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
695 sector_num, bs_i, bs_offset, bs_sectors); */
697 assert (bs_num
< bs_sectors
);
699 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
701 if (bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
) < 0)
702 error("error while reading");
709 assert (remainder
== 0);
711 if (n
< cluster_sectors
)
712 memset(buf
+ n
* 512, 0, cluster_size
- n
* 512);
713 if (is_not_zero(buf
, cluster_size
)) {
714 if (bdrv_write_compressed(out_bs
, sector_num
, buf
,
715 cluster_sectors
) != 0)
716 error("error while compressing sector %" PRId64
,
721 /* signal EOF to align */
722 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
724 sector_num
= 0; // total number of sectors converted so far
726 nb_sectors
= total_sectors
- sector_num
;
729 if (nb_sectors
>= (IO_BUF_SIZE
/ 512))
730 n
= (IO_BUF_SIZE
/ 512);
734 while (sector_num
- bs_offset
>= bs_sectors
) {
736 assert (bs_i
< bs_n
);
737 bs_offset
+= bs_sectors
;
738 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
739 /* printf("changing part: sector_num=%lld, bs_i=%d, "
740 "bs_offset=%lld, bs_sectors=%lld\n",
741 sector_num, bs_i, bs_offset, bs_sectors); */
744 if (n
> bs_offset
+ bs_sectors
- sector_num
)
745 n
= bs_offset
+ bs_sectors
- sector_num
;
747 if (!drv
->no_zero_init
) {
748 /* If the output image is being created as a copy on write image,
749 assume that sectors which are unallocated in the input image
750 are present in both the output's and input's base images (no
751 need to copy them). */
753 if (!bdrv_is_allocated(bs
[bs_i
], sector_num
- bs_offset
,
758 /* The next 'n1' sectors are allocated in the input image. Copy
759 only those as they may be followed by unallocated sectors. */
766 if (bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
) < 0)
767 error("error while reading");
768 /* NOTE: at the same time we convert, we do not write zero
769 sectors to have a chance to compress the image. Ideally, we
770 should add a specific call to have the info to go faster */
773 /* If the output image is being created as a copy on write image,
774 copy all sectors even the ones containing only NUL bytes,
775 because they may differ from the sectors in the base image.
777 If the output is to a host device, we also write out
778 sectors that are entirely 0, since whatever data was
779 already there is garbage, not 0s. */
780 if (drv
->no_zero_init
|| out_baseimg
||
781 is_allocated_sectors(buf1
, n
, &n1
)) {
782 if (bdrv_write(out_bs
, sector_num
, buf1
, n1
) < 0)
783 error("error while writing");
792 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++)
793 bdrv_delete(bs
[bs_i
]);
799 static int64_t get_allocated_file_size(const char *filename
)
801 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
, DWORD
*high
);
802 get_compressed_t get_compressed
;
805 /* WinNT support GetCompressedFileSize to determine allocate size */
806 get_compressed
= (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
807 if (get_compressed
) {
809 low
= get_compressed(filename
, &high
);
810 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
)
811 return (((int64_t) high
) << 32) + low
;
814 if (_stati64(filename
, &st
) < 0)
819 static int64_t get_allocated_file_size(const char *filename
)
822 if (stat(filename
, &st
) < 0)
824 return (int64_t)st
.st_blocks
* 512;
828 static void dump_snapshots(BlockDriverState
*bs
)
830 QEMUSnapshotInfo
*sn_tab
, *sn
;
834 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
837 printf("Snapshot list:\n");
838 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
839 for(i
= 0; i
< nb_sns
; i
++) {
841 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
846 static int img_info(int argc
, char **argv
)
849 const char *filename
, *fmt
;
851 BlockDriverState
*bs
;
852 char fmt_name
[128], size_buf
[128], dsize_buf
[128];
853 uint64_t total_sectors
;
854 int64_t allocated_size
;
855 char backing_filename
[1024];
856 char backing_filename2
[1024];
861 c
= getopt(argc
, argv
, "f:h");
875 filename
= argv
[optind
++];
879 error("Not enough memory");
881 drv
= bdrv_find_format(fmt
);
883 error("Unknown file format '%s'", fmt
);
887 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
888 error("Could not open '%s'", filename
);
890 bdrv_get_format(bs
, fmt_name
, sizeof(fmt_name
));
891 bdrv_get_geometry(bs
, &total_sectors
);
892 get_human_readable_size(size_buf
, sizeof(size_buf
), total_sectors
* 512);
893 allocated_size
= get_allocated_file_size(filename
);
894 if (allocated_size
< 0)
895 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
897 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
901 "virtual size: %s (%" PRId64
" bytes)\n"
903 filename
, fmt_name
, size_buf
,
904 (total_sectors
* 512),
906 if (bdrv_is_encrypted(bs
))
907 printf("encrypted: yes\n");
908 if (bdrv_get_info(bs
, &bdi
) >= 0) {
909 if (bdi
.cluster_size
!= 0)
910 printf("cluster_size: %d\n", bdi
.cluster_size
);
912 bdrv_get_backing_filename(bs
, backing_filename
, sizeof(backing_filename
));
913 if (backing_filename
[0] != '\0') {
914 path_combine(backing_filename2
, sizeof(backing_filename2
),
915 filename
, backing_filename
);
916 printf("backing file: %s (actual path: %s)\n",
925 #define SNAPSHOT_LIST 1
926 #define SNAPSHOT_CREATE 2
927 #define SNAPSHOT_APPLY 3
928 #define SNAPSHOT_DELETE 4
930 static int img_snapshot(int argc
, char **argv
)
932 BlockDriverState
*bs
;
934 char *filename
, *snapshot_name
= NULL
;
939 /* Parse commandline parameters */
941 c
= getopt(argc
, argv
, "la:c:d:h");
953 action
= SNAPSHOT_LIST
;
960 action
= SNAPSHOT_APPLY
;
961 snapshot_name
= optarg
;
968 action
= SNAPSHOT_CREATE
;
969 snapshot_name
= optarg
;
976 action
= SNAPSHOT_DELETE
;
977 snapshot_name
= optarg
;
984 filename
= argv
[optind
++];
989 error("Not enough memory");
991 if (bdrv_open2(bs
, filename
, 0, NULL
) < 0) {
992 error("Could not open '%s'", filename
);
995 /* Perform the requested action */
1001 case SNAPSHOT_CREATE
:
1002 memset(&sn
, 0, sizeof(sn
));
1003 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
1005 qemu_gettimeofday(&tv
);
1006 sn
.date_sec
= tv
.tv_sec
;
1007 sn
.date_nsec
= tv
.tv_usec
* 1000;
1009 ret
= bdrv_snapshot_create(bs
, &sn
);
1011 error("Could not create snapshot '%s': %d (%s)",
1012 snapshot_name
, ret
, strerror(-ret
));
1015 case SNAPSHOT_APPLY
:
1016 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
1018 error("Could not apply snapshot '%s': %d (%s)",
1019 snapshot_name
, ret
, strerror(-ret
));
1022 case SNAPSHOT_DELETE
:
1023 ret
= bdrv_snapshot_delete(bs
, snapshot_name
);
1025 error("Could not delete snapshot '%s': %d (%s)",
1026 snapshot_name
, ret
, strerror(-ret
));
1036 static const img_cmd_t img_cmds
[] = {
1037 #define DEF(option, callback, arg_string) \
1038 { option, callback },
1039 #include "qemu-img-cmds.h"
1045 int main(int argc
, char **argv
)
1047 const img_cmd_t
*cmd
;
1048 const char *cmdname
;
1056 /* find the command */
1057 for(cmd
= img_cmds
; cmd
->name
!= NULL
; cmd
++) {
1058 if (!strcmp(cmdname
, cmd
->name
)) {
1059 return cmd
->handler(argc
, argv
);