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"
26 #include "block_int.h"
30 #define WIN32_LEAN_AND_MEAN
34 /* Default to cache=writeback as data integrity is not important for qemu-tcg. */
35 #define BRDV_O_FLAGS BDRV_O_CACHE_WB
37 static void noreturn
error(const char *fmt
, ...)
41 fprintf(stderr
, "qemu-img: ");
42 vfprintf(stderr
, fmt
, ap
);
43 fprintf(stderr
, "\n");
48 static void format_print(void *opaque
, const char *name
)
53 static void help(void)
55 printf("qemu-img version " QEMU_VERSION
", Copyright (c) 2004-2008 Fabrice Bellard\n"
56 "usage: qemu-img command [command options]\n"
57 "QEMU disk image utility\n"
60 " create [-e] [-6] [-b base_image] [-f fmt] filename [size]\n"
61 " commit [-f fmt] filename\n"
62 " convert [-c] [-e] [-6] [-f fmt] [-O output_fmt] [-B output_base_image] filename [filename2 [...]] output_filename\n"
63 " info [-f fmt] filename\n"
64 " snapshot [-l|-a snapshot|-c snapshot|-d snapshot] filename\n"
66 "Command parameters:\n"
67 " 'filename' is a disk image filename\n"
68 " 'base_image' is the read-only disk image which is used as base for a copy on\n"
69 " write image; the copy on write image only stores the modified data\n"
70 " 'output_base_image' forces the output image to be created as a copy on write\n"
71 " image of the specified base image; 'output_base_image' should have the same\n"
72 " content as the input's base image, however the path, image format, etc may\n"
74 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
75 " 'size' is the disk image size in kilobytes. Optional suffixes 'M' (megabyte)\n"
76 " and 'G' (gigabyte) are supported\n"
77 " 'output_filename' is the destination disk image filename\n"
78 " 'output_fmt' is the destination format\n"
79 " '-c' indicates that target image must be compressed (qcow format only)\n"
80 " '-e' indicates that the target image must be encrypted (qcow format only)\n"
81 " '-6' indicates that the target image must use compatibility level 6 (vmdk format only)\n"
83 " Parameters to snapshot subcommand:\n"
84 " 'snapshot' is the name of the snapshot to create, apply or delete\n"
85 " '-a' applies a snapshot (revert disk to saved state)\n"
86 " '-c' creates a snapshot\n"
87 " '-d' deletes a snapshot\n"
88 " '-l' lists all snapshots in the given image\n"
90 printf("\nSupported format:");
91 bdrv_iterate_format(format_print
, NULL
);
97 /* XXX: put correct support for win32 */
98 static int read_password(char *buf
, int buf_size
)
101 printf("Password: ");
108 if (i
< (buf_size
- 1))
119 static struct termios oldtty
;
121 static void term_exit(void)
123 tcsetattr (0, TCSANOW
, &oldtty
);
126 static void term_init(void)
133 tty
.c_iflag
&= ~(IGNBRK
|BRKINT
|PARMRK
|ISTRIP
134 |INLCR
|IGNCR
|ICRNL
|IXON
);
135 tty
.c_oflag
|= OPOST
;
136 tty
.c_lflag
&= ~(ECHO
|ECHONL
|ICANON
|IEXTEN
);
137 tty
.c_cflag
&= ~(CSIZE
|PARENB
);
142 tcsetattr (0, TCSANOW
, &tty
);
147 static int read_password(char *buf
, int buf_size
)
152 printf("password: ");
157 ret
= read(0, &ch
, 1);
159 if (errno
== EAGAIN
|| errno
== EINTR
) {
165 } else if (ret
== 0) {
173 if (i
< (buf_size
- 1))
184 static BlockDriverState
*bdrv_new_open(const char *filename
,
187 BlockDriverState
*bs
;
193 error("Not enough memory");
195 drv
= bdrv_find_format(fmt
);
197 error("Unknown file format '%s'", fmt
);
201 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
202 error("Could not open '%s'", filename
);
204 if (bdrv_is_encrypted(bs
)) {
205 printf("Disk image '%s' is encrypted.\n", filename
);
206 if (read_password(password
, sizeof(password
)) < 0)
207 error("No password given");
208 if (bdrv_set_key(bs
, password
) < 0)
209 error("invalid password");
214 static int img_create(int argc
, char **argv
)
217 const char *fmt
= "raw";
218 const char *filename
;
219 const char *base_filename
= NULL
;
226 c
= getopt(argc
, argv
, "b:f:he6");
234 base_filename
= optarg
;
240 flags
|= BLOCK_FLAG_ENCRYPT
;
243 flags
|= BLOCK_FLAG_COMPAT6
;
249 filename
= argv
[optind
++];
252 BlockDriverState
*bs
;
253 bs
= bdrv_new_open(base_filename
, NULL
);
254 bdrv_get_geometry(bs
, &size
);
261 size
= strtoul(p
, (char **)&p
, 0);
264 } else if (*p
== 'G') {
265 size
*= 1024 * 1024 * 1024;
266 } else if (*p
== 'k' || *p
== 'K' || *p
== '\0') {
272 drv
= bdrv_find_format(fmt
);
274 error("Unknown file format '%s'", fmt
);
275 printf("Formatting '%s', fmt=%s",
277 if (flags
& BLOCK_FLAG_ENCRYPT
)
278 printf(", encrypted");
279 if (flags
& BLOCK_FLAG_COMPAT6
)
280 printf(", compatibility level=6");
282 printf(", backing_file=%s",
285 printf(", size=%" PRIu64
" kB\n", size
/ 1024);
286 ret
= bdrv_create(drv
, filename
, size
/ 512, base_filename
, flags
);
288 if (ret
== -ENOTSUP
) {
289 error("Formatting or formatting option not supported for file format '%s'", fmt
);
291 error("Error while formatting");
297 static int img_commit(int argc
, char **argv
)
300 const char *filename
, *fmt
;
302 BlockDriverState
*bs
;
306 c
= getopt(argc
, argv
, "f:h");
320 filename
= argv
[optind
++];
324 error("Not enough memory");
326 drv
= bdrv_find_format(fmt
);
328 error("Unknown file format '%s'", fmt
);
332 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
333 error("Could not open '%s'", filename
);
335 ret
= bdrv_commit(bs
);
338 printf("Image committed.\n");
341 error("No disk inserted");
344 error("Image is read-only");
347 error("Image is already committed");
350 error("Error while committing image");
358 static int is_not_zero(const uint8_t *sector
, int len
)
362 for(i
= 0;i
< len
; i
++) {
363 if (((uint32_t *)sector
)[i
] != 0)
370 * Returns true iff the first sector pointed to by 'buf' contains at least
373 * 'pnum' is set to the number of sectors (including and immediately following
374 * the first one) that are known to be in the same allocated/unallocated state.
376 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
384 v
= is_not_zero(buf
, 512);
385 for(i
= 1; i
< n
; i
++) {
387 if (v
!= is_not_zero(buf
, 512))
394 #define IO_BUF_SIZE 65536
396 static int img_convert(int argc
, char **argv
)
398 int c
, ret
, n
, n1
, bs_n
, bs_i
, flags
, cluster_size
, cluster_sectors
;
399 const char *fmt
, *out_fmt
, *out_baseimg
, *out_filename
;
401 BlockDriverState
**bs
, *out_bs
;
402 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
404 uint8_t buf
[IO_BUF_SIZE
];
413 c
= getopt(argc
, argv
, "f:O:B:hce6");
427 out_baseimg
= optarg
;
430 flags
|= BLOCK_FLAG_COMPRESS
;
433 flags
|= BLOCK_FLAG_ENCRYPT
;
436 flags
|= BLOCK_FLAG_COMPAT6
;
441 bs_n
= argc
- optind
- 1;
442 if (bs_n
< 1) help();
444 out_filename
= argv
[argc
- 1];
446 if (bs_n
> 1 && out_baseimg
)
447 error("-B makes no sense when concatenating multiple input images");
449 bs
= calloc(bs_n
, sizeof(BlockDriverState
*));
451 error("Out of memory");
454 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
455 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
);
457 error("Could not open '%s'", argv
[optind
+ bs_i
]);
458 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
459 total_sectors
+= bs_sectors
;
462 drv
= bdrv_find_format(out_fmt
);
464 error("Unknown file format '%s'", out_fmt
);
465 if (flags
& BLOCK_FLAG_COMPRESS
&& drv
!= &bdrv_qcow
&& drv
!= &bdrv_qcow2
)
466 error("Compression not supported for this file format");
467 if (flags
& BLOCK_FLAG_ENCRYPT
&& drv
!= &bdrv_qcow
&& drv
!= &bdrv_qcow2
)
468 error("Encryption not supported for this file format");
469 if (flags
& BLOCK_FLAG_COMPAT6
&& drv
!= &bdrv_vmdk
)
470 error("Alternative compatibility level not supported for this file format");
471 if (flags
& BLOCK_FLAG_ENCRYPT
&& flags
& BLOCK_FLAG_COMPRESS
)
472 error("Compression and encryption not supported at the same time");
474 ret
= bdrv_create(drv
, out_filename
, total_sectors
, out_baseimg
, flags
);
476 if (ret
== -ENOTSUP
) {
477 error("Formatting not supported for file format '%s'", fmt
);
479 error("Error while formatting '%s'", out_filename
);
483 out_bs
= bdrv_new_open(out_filename
, out_fmt
);
487 bdrv_get_geometry(bs
[0], &bs_sectors
);
489 if (flags
& BLOCK_FLAG_COMPRESS
) {
490 if (bdrv_get_info(out_bs
, &bdi
) < 0)
491 error("could not get block driver info");
492 cluster_size
= bdi
.cluster_size
;
493 if (cluster_size
<= 0 || cluster_size
> IO_BUF_SIZE
)
494 error("invalid cluster size");
495 cluster_sectors
= cluster_size
>> 9;
502 nb_sectors
= total_sectors
- sector_num
;
505 if (nb_sectors
>= cluster_sectors
)
510 bs_num
= sector_num
- bs_offset
;
511 assert (bs_num
>= 0);
514 while (remainder
> 0) {
516 while (bs_num
== bs_sectors
) {
518 assert (bs_i
< bs_n
);
519 bs_offset
+= bs_sectors
;
520 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
522 /* printf("changing part: sector_num=%lld, "
523 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
524 sector_num, bs_i, bs_offset, bs_sectors); */
526 assert (bs_num
< bs_sectors
);
528 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
530 if (bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
) < 0)
531 error("error while reading");
538 assert (remainder
== 0);
540 if (n
< cluster_sectors
)
541 memset(buf
+ n
* 512, 0, cluster_size
- n
* 512);
542 if (is_not_zero(buf
, cluster_size
)) {
543 if (bdrv_write_compressed(out_bs
, sector_num
, buf
,
544 cluster_sectors
) != 0)
545 error("error while compressing sector %" PRId64
,
550 /* signal EOF to align */
551 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
553 sector_num
= 0; // total number of sectors converted so far
555 nb_sectors
= total_sectors
- sector_num
;
558 if (nb_sectors
>= (IO_BUF_SIZE
/ 512))
559 n
= (IO_BUF_SIZE
/ 512);
563 while (sector_num
- bs_offset
>= bs_sectors
) {
565 assert (bs_i
< bs_n
);
566 bs_offset
+= bs_sectors
;
567 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
568 /* printf("changing part: sector_num=%lld, bs_i=%d, "
569 "bs_offset=%lld, bs_sectors=%lld\n",
570 sector_num, bs_i, bs_offset, bs_sectors); */
573 if (n
> bs_offset
+ bs_sectors
- sector_num
)
574 n
= bs_offset
+ bs_sectors
- sector_num
;
576 /* If the output image is being created as a copy on write image,
577 assume that sectors which are unallocated in the input image
578 are present in both the output's and input's base images (no
579 need to copy them). */
581 if (!bdrv_is_allocated(bs
[bs_i
], sector_num
- bs_offset
, n
, &n1
)) {
585 /* The next 'n1' sectors are allocated in the input image. Copy
586 only those as they may be followed by unallocated sectors. */
590 if (bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
) < 0)
591 error("error while reading");
592 /* NOTE: at the same time we convert, we do not write zero
593 sectors to have a chance to compress the image. Ideally, we
594 should add a specific call to have the info to go faster */
597 /* If the output image is being created as a copy on write image,
598 copy all sectors even the ones containing only NUL bytes,
599 because they may differ from the sectors in the base image. */
600 if (out_baseimg
|| is_allocated_sectors(buf1
, n
, &n1
)) {
601 if (bdrv_write(out_bs
, sector_num
, buf1
, n1
) < 0)
602 error("error while writing");
611 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++)
612 bdrv_delete(bs
[bs_i
]);
618 static int64_t get_allocated_file_size(const char *filename
)
620 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
, DWORD
*high
);
621 get_compressed_t get_compressed
;
624 /* WinNT support GetCompressedFileSize to determine allocate size */
625 get_compressed
= (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
626 if (get_compressed
) {
628 low
= get_compressed(filename
, &high
);
629 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
)
630 return (((int64_t) high
) << 32) + low
;
633 if (_stati64(filename
, &st
) < 0)
638 static int64_t get_allocated_file_size(const char *filename
)
641 if (stat(filename
, &st
) < 0)
643 return (int64_t)st
.st_blocks
* 512;
647 static void dump_snapshots(BlockDriverState
*bs
)
649 QEMUSnapshotInfo
*sn_tab
, *sn
;
653 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
656 printf("Snapshot list:\n");
657 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
658 for(i
= 0; i
< nb_sns
; i
++) {
660 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
665 static int img_info(int argc
, char **argv
)
668 const char *filename
, *fmt
;
670 BlockDriverState
*bs
;
671 char fmt_name
[128], size_buf
[128], dsize_buf
[128];
672 uint64_t total_sectors
;
673 int64_t allocated_size
;
674 char backing_filename
[1024];
675 char backing_filename2
[1024];
680 c
= getopt(argc
, argv
, "f:h");
694 filename
= argv
[optind
++];
698 error("Not enough memory");
700 drv
= bdrv_find_format(fmt
);
702 error("Unknown file format '%s'", fmt
);
706 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
707 error("Could not open '%s'", filename
);
709 bdrv_get_format(bs
, fmt_name
, sizeof(fmt_name
));
710 bdrv_get_geometry(bs
, &total_sectors
);
711 get_human_readable_size(size_buf
, sizeof(size_buf
), total_sectors
* 512);
712 allocated_size
= get_allocated_file_size(filename
);
713 if (allocated_size
< 0)
714 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
716 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
720 "virtual size: %s (%" PRId64
" bytes)\n"
722 filename
, fmt_name
, size_buf
,
723 (total_sectors
* 512),
725 if (bdrv_is_encrypted(bs
))
726 printf("encrypted: yes\n");
727 if (bdrv_get_info(bs
, &bdi
) >= 0) {
728 if (bdi
.cluster_size
!= 0)
729 printf("cluster_size: %d\n", bdi
.cluster_size
);
730 if (bdi
.highest_alloc
)
731 printf("highest_alloc: %" PRId64
"\n", bdi
.highest_alloc
);
732 if (bdi
.num_free_bytes
)
733 printf("num_free_bytes: %" PRId64
"\n", bdi
.num_free_bytes
);
735 bdrv_get_backing_filename(bs
, backing_filename
, sizeof(backing_filename
));
736 if (backing_filename
[0] != '\0') {
737 path_combine(backing_filename2
, sizeof(backing_filename2
),
738 filename
, backing_filename
);
739 printf("backing file: %s (actual path: %s)\n",
748 #define SNAPSHOT_LIST 1
749 #define SNAPSHOT_CREATE 2
750 #define SNAPSHOT_APPLY 3
751 #define SNAPSHOT_DELETE 4
753 static void img_snapshot(int argc
, char **argv
)
755 BlockDriverState
*bs
;
757 char *filename
, *snapshot_name
= NULL
;
762 /* Parse commandline parameters */
764 c
= getopt(argc
, argv
, "la:c:d:h");
776 action
= SNAPSHOT_LIST
;
783 action
= SNAPSHOT_APPLY
;
784 snapshot_name
= optarg
;
791 action
= SNAPSHOT_CREATE
;
792 snapshot_name
= optarg
;
799 action
= SNAPSHOT_DELETE
;
800 snapshot_name
= optarg
;
807 filename
= argv
[optind
++];
812 error("Not enough memory");
814 if (bdrv_open2(bs
, filename
, 0, NULL
) < 0) {
815 error("Could not open '%s'", filename
);
818 /* Perform the requested action */
824 case SNAPSHOT_CREATE
:
825 memset(&sn
, 0, sizeof(sn
));
826 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
828 qemu_gettimeofday(&tv
);
829 sn
.date_sec
= tv
.tv_sec
;
830 sn
.date_nsec
= tv
.tv_usec
* 1000;
832 ret
= bdrv_snapshot_create(bs
, &sn
);
834 error("Could not create snapshot '%s': %d (%s)",
835 snapshot_name
, ret
, strerror(-ret
));
839 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
841 error("Could not apply snapshot '%s': %d (%s)",
842 snapshot_name
, ret
, strerror(-ret
));
845 case SNAPSHOT_DELETE
:
846 ret
= bdrv_snapshot_delete(bs
, snapshot_name
);
848 error("Could not delete snapshot '%s': %d (%s)",
849 snapshot_name
, ret
, strerror(-ret
));
857 int main(int argc
, char **argv
)
866 if (!strcmp(cmd
, "create")) {
867 img_create(argc
, argv
);
868 } else if (!strcmp(cmd
, "commit")) {
869 img_commit(argc
, argv
);
870 } else if (!strcmp(cmd
, "convert")) {
871 img_convert(argc
, argv
);
872 } else if (!strcmp(cmd
, "info")) {
873 img_info(argc
, argv
);
874 } else if (!strcmp(cmd
, "snapshot")) {
875 img_snapshot(argc
, argv
);