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 QEMU_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 /* Please keep in synch with qemu-img.texi */
54 static void help(void)
56 printf("qemu-img version " QEMU_VERSION
", Copyright (c) 2004-2008 Fabrice Bellard\n"
57 "usage: qemu-img command [command options]\n"
58 "QEMU disk image utility\n"
61 " create [-e] [-6] [-b base_image] [-f fmt] filename [size]\n"
62 " commit [-f fmt] filename\n"
63 " convert [-c] [-e] [-6] [-f fmt] [-O output_fmt] [-B output_base_image] filename [filename2 [...]] output_filename\n"
64 " info [-f fmt] filename\n"
65 " snapshot [-l | -a snapshot | -c snapshot | -d snapshot] filename\n"
67 "Command parameters:\n"
68 " 'filename' is a disk image filename\n"
69 " 'base_image' is the read-only disk image which is used as base for a copy on\n"
70 " write image; the copy on write image only stores the modified data\n"
71 " 'output_base_image' forces the output image to be created as a copy on write\n"
72 " image of the specified base image; 'output_base_image' should have the same\n"
73 " content as the input's base image, however the path, image format, etc may\n"
75 " 'fmt' is the disk image format. It is guessed automatically in most cases\n"
76 " 'size' is the disk image size in kilobytes. Optional suffixes\n"
77 " 'M' (megabyte, 1024 * 1024) and 'G' (gigabyte, 1024 * 1024 * 1024) are\n"
78 " supported any 'k' or 'K' is ignored\n"
79 " 'output_filename' is the destination disk image filename\n"
80 " 'output_fmt' is the destination format\n"
81 " '-c' indicates that target image must be compressed (qcow format only)\n"
82 " '-e' indicates that the target image must be encrypted (qcow format only)\n"
83 " '-6' indicates that the target image must use compatibility level 6 (vmdk 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 int img_create(int argc
, char **argv
)
220 const char *fmt
= "raw";
221 const char *filename
;
222 const char *base_filename
= NULL
;
229 c
= getopt(argc
, argv
, "b:f:he6");
237 base_filename
= optarg
;
243 flags
|= BLOCK_FLAG_ENCRYPT
;
246 flags
|= BLOCK_FLAG_COMPAT6
;
252 filename
= argv
[optind
++];
255 BlockDriverState
*bs
;
256 bs
= bdrv_new_open(base_filename
, NULL
);
257 bdrv_get_geometry(bs
, &size
);
264 size
= strtoul(p
, (char **)&p
, 0);
267 } else if (*p
== 'G') {
268 size
*= 1024 * 1024 * 1024;
269 } else if (*p
== 'k' || *p
== 'K' || *p
== '\0') {
275 drv
= bdrv_find_format(fmt
);
277 error("Unknown file format '%s'", fmt
);
278 printf("Formatting '%s', fmt=%s",
280 if (flags
& BLOCK_FLAG_ENCRYPT
)
281 printf(", encrypted");
282 if (flags
& BLOCK_FLAG_COMPAT6
)
283 printf(", compatibility level=6");
285 printf(", backing_file=%s",
288 printf(", size=%" PRIu64
" kB\n", size
/ 1024);
289 ret
= bdrv_create(drv
, filename
, size
/ 512, base_filename
, flags
);
291 if (ret
== -ENOTSUP
) {
292 error("Formatting or formatting option not supported for file format '%s'", fmt
);
293 } else if (ret
== -EFBIG
) {
294 error("The image size is too large for file format '%s'", fmt
);
296 error("Error while formatting");
302 static int img_commit(int argc
, char **argv
)
305 const char *filename
, *fmt
;
307 BlockDriverState
*bs
;
311 c
= getopt(argc
, argv
, "f:h");
325 filename
= argv
[optind
++];
329 error("Not enough memory");
331 drv
= bdrv_find_format(fmt
);
333 error("Unknown file format '%s'", fmt
);
337 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
338 error("Could not open '%s'", filename
);
340 ret
= bdrv_commit(bs
);
343 printf("Image committed.\n");
346 error("No disk inserted");
349 error("Image is read-only");
352 error("Image is already committed");
355 error("Error while committing image");
363 static int is_not_zero(const uint8_t *sector
, int len
)
367 for(i
= 0;i
< len
; i
++) {
368 if (((uint32_t *)sector
)[i
] != 0)
375 * Returns true iff the first sector pointed to by 'buf' contains at least
378 * 'pnum' is set to the number of sectors (including and immediately following
379 * the first one) that are known to be in the same allocated/unallocated state.
381 static int is_allocated_sectors(const uint8_t *buf
, int n
, int *pnum
)
389 v
= is_not_zero(buf
, 512);
390 for(i
= 1; i
< n
; i
++) {
392 if (v
!= is_not_zero(buf
, 512))
399 #define IO_BUF_SIZE 65536
401 static int img_convert(int argc
, char **argv
)
403 int c
, ret
, n
, n1
, bs_n
, bs_i
, flags
, cluster_size
, cluster_sectors
;
404 const char *fmt
, *out_fmt
, *out_baseimg
, *out_filename
;
406 BlockDriverState
**bs
, *out_bs
;
407 int64_t total_sectors
, nb_sectors
, sector_num
, bs_offset
;
409 uint8_t buf
[IO_BUF_SIZE
];
418 c
= getopt(argc
, argv
, "f:O:B:hce6");
432 out_baseimg
= optarg
;
435 flags
|= BLOCK_FLAG_COMPRESS
;
438 flags
|= BLOCK_FLAG_ENCRYPT
;
441 flags
|= BLOCK_FLAG_COMPAT6
;
446 bs_n
= argc
- optind
- 1;
447 if (bs_n
< 1) help();
449 out_filename
= argv
[argc
- 1];
451 if (bs_n
> 1 && out_baseimg
)
452 error("-B makes no sense when concatenating multiple input images");
454 bs
= calloc(bs_n
, sizeof(BlockDriverState
*));
456 error("Out of memory");
459 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++) {
460 bs
[bs_i
] = bdrv_new_open(argv
[optind
+ bs_i
], fmt
);
462 error("Could not open '%s'", argv
[optind
+ bs_i
]);
463 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
464 total_sectors
+= bs_sectors
;
467 drv
= bdrv_find_format(out_fmt
);
469 error("Unknown file format '%s'", out_fmt
);
470 if (flags
& BLOCK_FLAG_COMPRESS
&& drv
!= &bdrv_qcow
&& drv
!= &bdrv_qcow2
)
471 error("Compression not supported for this file format");
472 if (flags
& BLOCK_FLAG_ENCRYPT
&& drv
!= &bdrv_qcow
&& drv
!= &bdrv_qcow2
)
473 error("Encryption not supported for this file format");
474 if (flags
& BLOCK_FLAG_COMPAT6
&& drv
!= &bdrv_vmdk
)
475 error("Alternative compatibility level not supported for this file format");
476 if (flags
& BLOCK_FLAG_ENCRYPT
&& flags
& BLOCK_FLAG_COMPRESS
)
477 error("Compression and encryption not supported at the same time");
479 ret
= bdrv_create(drv
, out_filename
, total_sectors
, out_baseimg
, flags
);
481 if (ret
== -ENOTSUP
) {
482 error("Formatting not supported for file format '%s'", out_fmt
);
483 } else if (ret
== -EFBIG
) {
484 error("The image size is too large for file format '%s'", out_fmt
);
486 error("Error while formatting '%s'", out_filename
);
490 out_bs
= bdrv_new_open(out_filename
, out_fmt
);
494 bdrv_get_geometry(bs
[0], &bs_sectors
);
496 if (flags
& BLOCK_FLAG_COMPRESS
) {
497 if (bdrv_get_info(out_bs
, &bdi
) < 0)
498 error("could not get block driver info");
499 cluster_size
= bdi
.cluster_size
;
500 if (cluster_size
<= 0 || cluster_size
> IO_BUF_SIZE
)
501 error("invalid cluster size");
502 cluster_sectors
= cluster_size
>> 9;
509 nb_sectors
= total_sectors
- sector_num
;
512 if (nb_sectors
>= cluster_sectors
)
517 bs_num
= sector_num
- bs_offset
;
518 assert (bs_num
>= 0);
521 while (remainder
> 0) {
523 while (bs_num
== bs_sectors
) {
525 assert (bs_i
< bs_n
);
526 bs_offset
+= bs_sectors
;
527 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
529 /* printf("changing part: sector_num=%lld, "
530 "bs_i=%d, bs_offset=%lld, bs_sectors=%lld\n",
531 sector_num, bs_i, bs_offset, bs_sectors); */
533 assert (bs_num
< bs_sectors
);
535 nlow
= (remainder
> bs_sectors
- bs_num
) ? bs_sectors
- bs_num
: remainder
;
537 if (bdrv_read(bs
[bs_i
], bs_num
, buf2
, nlow
) < 0)
538 error("error while reading");
545 assert (remainder
== 0);
547 if (n
< cluster_sectors
)
548 memset(buf
+ n
* 512, 0, cluster_size
- n
* 512);
549 if (is_not_zero(buf
, cluster_size
)) {
550 if (bdrv_write_compressed(out_bs
, sector_num
, buf
,
551 cluster_sectors
) != 0)
552 error("error while compressing sector %" PRId64
,
557 /* signal EOF to align */
558 bdrv_write_compressed(out_bs
, 0, NULL
, 0);
560 sector_num
= 0; // total number of sectors converted so far
562 nb_sectors
= total_sectors
- sector_num
;
565 if (nb_sectors
>= (IO_BUF_SIZE
/ 512))
566 n
= (IO_BUF_SIZE
/ 512);
570 while (sector_num
- bs_offset
>= bs_sectors
) {
572 assert (bs_i
< bs_n
);
573 bs_offset
+= bs_sectors
;
574 bdrv_get_geometry(bs
[bs_i
], &bs_sectors
);
575 /* printf("changing part: sector_num=%lld, bs_i=%d, "
576 "bs_offset=%lld, bs_sectors=%lld\n",
577 sector_num, bs_i, bs_offset, bs_sectors); */
580 if (n
> bs_offset
+ bs_sectors
- sector_num
)
581 n
= bs_offset
+ bs_sectors
- sector_num
;
583 /* If the output image is being created as a copy on write image,
584 assume that sectors which are unallocated in the input image
585 are present in both the output's and input's base images (no
586 need to copy them). */
588 if (!bdrv_is_allocated(bs
[bs_i
], sector_num
- bs_offset
, n
, &n1
)) {
592 /* The next 'n1' sectors are allocated in the input image. Copy
593 only those as they may be followed by unallocated sectors. */
597 if (bdrv_read(bs
[bs_i
], sector_num
- bs_offset
, buf
, n
) < 0)
598 error("error while reading");
599 /* NOTE: at the same time we convert, we do not write zero
600 sectors to have a chance to compress the image. Ideally, we
601 should add a specific call to have the info to go faster */
604 /* If the output image is being created as a copy on write image,
605 copy all sectors even the ones containing only NUL bytes,
606 because they may differ from the sectors in the base image. */
607 if (out_baseimg
|| is_allocated_sectors(buf1
, n
, &n1
)) {
608 if (bdrv_write(out_bs
, sector_num
, buf1
, n1
) < 0)
609 error("error while writing");
618 for (bs_i
= 0; bs_i
< bs_n
; bs_i
++)
619 bdrv_delete(bs
[bs_i
]);
625 static int64_t get_allocated_file_size(const char *filename
)
627 typedef DWORD (WINAPI
* get_compressed_t
)(const char *filename
, DWORD
*high
);
628 get_compressed_t get_compressed
;
631 /* WinNT support GetCompressedFileSize to determine allocate size */
632 get_compressed
= (get_compressed_t
) GetProcAddress(GetModuleHandle("kernel32"), "GetCompressedFileSizeA");
633 if (get_compressed
) {
635 low
= get_compressed(filename
, &high
);
636 if (low
!= 0xFFFFFFFFlu
|| GetLastError() == NO_ERROR
)
637 return (((int64_t) high
) << 32) + low
;
640 if (_stati64(filename
, &st
) < 0)
645 static int64_t get_allocated_file_size(const char *filename
)
648 if (stat(filename
, &st
) < 0)
650 return (int64_t)st
.st_blocks
* 512;
654 static void dump_snapshots(BlockDriverState
*bs
)
656 QEMUSnapshotInfo
*sn_tab
, *sn
;
660 nb_sns
= bdrv_snapshot_list(bs
, &sn_tab
);
663 printf("Snapshot list:\n");
664 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), NULL
));
665 for(i
= 0; i
< nb_sns
; i
++) {
667 printf("%s\n", bdrv_snapshot_dump(buf
, sizeof(buf
), sn
));
672 static int img_info(int argc
, char **argv
)
675 const char *filename
, *fmt
;
677 BlockDriverState
*bs
;
678 char fmt_name
[128], size_buf
[128], dsize_buf
[128];
679 uint64_t total_sectors
;
680 int64_t allocated_size
;
681 char backing_filename
[1024];
682 char backing_filename2
[1024];
687 c
= getopt(argc
, argv
, "f:h");
701 filename
= argv
[optind
++];
705 error("Not enough memory");
707 drv
= bdrv_find_format(fmt
);
709 error("Unknown file format '%s'", fmt
);
713 if (bdrv_open2(bs
, filename
, BRDV_O_FLAGS
, drv
) < 0) {
714 error("Could not open '%s'", filename
);
716 bdrv_get_format(bs
, fmt_name
, sizeof(fmt_name
));
717 bdrv_get_geometry(bs
, &total_sectors
);
718 get_human_readable_size(size_buf
, sizeof(size_buf
), total_sectors
* 512);
719 allocated_size
= get_allocated_file_size(filename
);
720 if (allocated_size
< 0)
721 snprintf(dsize_buf
, sizeof(dsize_buf
), "unavailable");
723 get_human_readable_size(dsize_buf
, sizeof(dsize_buf
),
727 "virtual size: %s (%" PRId64
" bytes)\n"
729 filename
, fmt_name
, size_buf
,
730 (total_sectors
* 512),
732 if (bdrv_is_encrypted(bs
))
733 printf("encrypted: yes\n");
734 if (bdrv_get_info(bs
, &bdi
) >= 0) {
735 if (bdi
.cluster_size
!= 0)
736 printf("cluster_size: %d\n", bdi
.cluster_size
);
738 bdrv_get_backing_filename(bs
, backing_filename
, sizeof(backing_filename
));
739 if (backing_filename
[0] != '\0') {
740 path_combine(backing_filename2
, sizeof(backing_filename2
),
741 filename
, backing_filename
);
742 printf("backing file: %s (actual path: %s)\n",
751 #define SNAPSHOT_LIST 1
752 #define SNAPSHOT_CREATE 2
753 #define SNAPSHOT_APPLY 3
754 #define SNAPSHOT_DELETE 4
756 static void img_snapshot(int argc
, char **argv
)
758 BlockDriverState
*bs
;
760 char *filename
, *snapshot_name
= NULL
;
765 /* Parse commandline parameters */
767 c
= getopt(argc
, argv
, "la:c:d:h");
779 action
= SNAPSHOT_LIST
;
786 action
= SNAPSHOT_APPLY
;
787 snapshot_name
= optarg
;
794 action
= SNAPSHOT_CREATE
;
795 snapshot_name
= optarg
;
802 action
= SNAPSHOT_DELETE
;
803 snapshot_name
= optarg
;
810 filename
= argv
[optind
++];
815 error("Not enough memory");
817 if (bdrv_open2(bs
, filename
, 0, NULL
) < 0) {
818 error("Could not open '%s'", filename
);
821 /* Perform the requested action */
827 case SNAPSHOT_CREATE
:
828 memset(&sn
, 0, sizeof(sn
));
829 pstrcpy(sn
.name
, sizeof(sn
.name
), snapshot_name
);
831 qemu_gettimeofday(&tv
);
832 sn
.date_sec
= tv
.tv_sec
;
833 sn
.date_nsec
= tv
.tv_usec
* 1000;
835 ret
= bdrv_snapshot_create(bs
, &sn
);
837 error("Could not create snapshot '%s': %d (%s)",
838 snapshot_name
, ret
, strerror(-ret
));
842 ret
= bdrv_snapshot_goto(bs
, snapshot_name
);
844 error("Could not apply snapshot '%s': %d (%s)",
845 snapshot_name
, ret
, strerror(-ret
));
848 case SNAPSHOT_DELETE
:
849 ret
= bdrv_snapshot_delete(bs
, snapshot_name
);
851 error("Could not delete snapshot '%s': %d (%s)",
852 snapshot_name
, ret
, strerror(-ret
));
860 int main(int argc
, char **argv
)
869 if (!strcmp(cmd
, "create")) {
870 img_create(argc
, argv
);
871 } else if (!strcmp(cmd
, "commit")) {
872 img_commit(argc
, argv
);
873 } else if (!strcmp(cmd
, "convert")) {
874 img_convert(argc
, argv
);
875 } else if (!strcmp(cmd
, "info")) {
876 img_info(argc
, argv
);
877 } else if (!strcmp(cmd
, "snapshot")) {
878 img_snapshot(argc
, argv
);