2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 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 "config-host.h"
26 /* include native header before sys-queue.h */
27 #include <sys/queue.h>
30 #include "qemu-common.h"
32 #include "block_int.h"
36 #include <sys/types.h>
38 #include <sys/ioctl.h>
43 #define SECTOR_SIZE (1 << SECTOR_BITS)
45 typedef struct BlockDriverAIOCBSync
{
46 BlockDriverAIOCB common
;
49 } BlockDriverAIOCBSync
;
51 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
52 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
53 BlockDriverCompletionFunc
*cb
, void *opaque
);
54 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
55 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
56 BlockDriverCompletionFunc
*cb
, void *opaque
);
57 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*acb
);
58 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
59 uint8_t *buf
, int nb_sectors
);
60 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
61 const uint8_t *buf
, int nb_sectors
);
63 BlockDriverState
*bdrv_first
;
65 static BlockDriver
*first_drv
;
67 int path_is_absolute(const char *path
)
71 /* specific case for names like: "\\.\d:" */
72 if (*path
== '/' || *path
== '\\')
75 p
= strchr(path
, ':');
81 return (*p
== '/' || *p
== '\\');
87 /* if filename is absolute, just copy it to dest. Otherwise, build a
88 path to it by considering it is relative to base_path. URL are
90 void path_combine(char *dest
, int dest_size
,
91 const char *base_path
,
99 if (path_is_absolute(filename
)) {
100 pstrcpy(dest
, dest_size
, filename
);
102 p
= strchr(base_path
, ':');
107 p1
= strrchr(base_path
, '/');
111 p2
= strrchr(base_path
, '\\');
123 if (len
> dest_size
- 1)
125 memcpy(dest
, base_path
, len
);
127 pstrcat(dest
, dest_size
, filename
);
132 static void bdrv_register(BlockDriver
*bdrv
)
134 if (!bdrv
->bdrv_aio_read
) {
135 /* add AIO emulation layer */
136 bdrv
->bdrv_aio_read
= bdrv_aio_read_em
;
137 bdrv
->bdrv_aio_write
= bdrv_aio_write_em
;
138 bdrv
->bdrv_aio_cancel
= bdrv_aio_cancel_em
;
139 bdrv
->aiocb_size
= sizeof(BlockDriverAIOCBSync
);
140 } else if (!bdrv
->bdrv_read
&& !bdrv
->bdrv_pread
) {
141 /* add synchronous IO emulation layer */
142 bdrv
->bdrv_read
= bdrv_read_em
;
143 bdrv
->bdrv_write
= bdrv_write_em
;
145 bdrv
->next
= first_drv
;
149 /* create a new block device (by default it is empty) */
150 BlockDriverState
*bdrv_new(const char *device_name
)
152 BlockDriverState
**pbs
, *bs
;
154 bs
= qemu_mallocz(sizeof(BlockDriverState
));
155 pstrcpy(bs
->device_name
, sizeof(bs
->device_name
), device_name
);
156 if (device_name
[0] != '\0') {
157 /* insert at the end */
166 BlockDriver
*bdrv_find_format(const char *format_name
)
169 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
170 if (!strcmp(drv1
->format_name
, format_name
))
176 int bdrv_create(BlockDriver
*drv
,
177 const char *filename
, int64_t size_in_sectors
,
178 const char *backing_file
, int flags
)
180 if (!drv
->bdrv_create
)
182 return drv
->bdrv_create(filename
, size_in_sectors
, backing_file
, flags
);
186 void get_tmp_filename(char *filename
, int size
)
188 char temp_dir
[MAX_PATH
];
190 GetTempPath(MAX_PATH
, temp_dir
);
191 GetTempFileName(temp_dir
, "qem", 0, filename
);
194 void get_tmp_filename(char *filename
, int size
)
198 /* XXX: race condition possible */
199 tmpdir
= getenv("TMPDIR");
202 snprintf(filename
, size
, "%s/vl.XXXXXX", tmpdir
);
203 fd
= mkstemp(filename
);
209 static int is_windows_drive_prefix(const char *filename
)
211 return (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
212 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
216 static int is_windows_drive(const char *filename
)
218 if (is_windows_drive_prefix(filename
) &&
221 if (strstart(filename
, "\\\\.\\", NULL
) ||
222 strstart(filename
, "//./", NULL
))
228 static BlockDriver
*find_protocol(const char *filename
)
236 if (is_windows_drive(filename
) ||
237 is_windows_drive_prefix(filename
))
240 p
= strchr(filename
, ':');
244 if (len
> sizeof(protocol
) - 1)
245 len
= sizeof(protocol
) - 1;
246 memcpy(protocol
, filename
, len
);
247 protocol
[len
] = '\0';
248 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
249 if (drv1
->protocol_name
&&
250 !strcmp(drv1
->protocol_name
, protocol
))
256 /* XXX: force raw format if block or character device ? It would
257 simplify the BSD case */
258 static BlockDriver
*find_image_format(const char *filename
)
260 int ret
, score
, score_max
;
261 BlockDriver
*drv1
, *drv
;
263 BlockDriverState
*bs
;
265 /* detect host devices. By convention, /dev/cdrom[N] is always
266 recognized as a host CDROM */
267 if (strstart(filename
, "/dev/cdrom", NULL
))
268 return &bdrv_host_device
;
270 if (is_windows_drive(filename
))
271 return &bdrv_host_device
;
275 if (stat(filename
, &st
) >= 0 &&
276 (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
277 return &bdrv_host_device
;
282 drv
= find_protocol(filename
);
283 /* no need to test disk image formats for vvfat */
284 if (drv
== &bdrv_vvfat
)
287 ret
= bdrv_file_open(&bs
, filename
, BDRV_O_RDONLY
);
290 ret
= bdrv_pread(bs
, 0, buf
, sizeof(buf
));
297 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
298 if (drv1
->bdrv_probe
) {
299 score
= drv1
->bdrv_probe(buf
, ret
, filename
);
300 if (score
> score_max
) {
309 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
)
311 BlockDriverState
*bs
;
315 ret
= bdrv_open2(bs
, filename
, flags
| BDRV_O_FILE
, NULL
);
325 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
)
327 return bdrv_open2(bs
, filename
, flags
, NULL
);
330 int bdrv_open2(BlockDriverState
*bs
, const char *filename
, int flags
,
334 char tmp_filename
[PATH_MAX
];
335 char backing_filename
[PATH_MAX
];
338 bs
->is_temporary
= 0;
342 if (flags
& BDRV_O_SNAPSHOT
) {
343 BlockDriverState
*bs1
;
347 /* if snapshot, we create a temporary backing file and open it
348 instead of opening 'filename' directly */
350 /* if there is a backing file, use it */
352 ret
= bdrv_open(bs1
, filename
, 0);
357 total_size
= bdrv_getlength(bs1
) >> SECTOR_BITS
;
359 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
364 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
366 /* Real path is meaningless for protocols */
368 snprintf(backing_filename
, sizeof(backing_filename
),
371 realpath(filename
, backing_filename
);
373 ret
= bdrv_create(&bdrv_qcow2
, tmp_filename
,
374 total_size
, backing_filename
, 0);
378 filename
= tmp_filename
;
379 bs
->is_temporary
= 1;
382 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
383 if (flags
& BDRV_O_FILE
) {
384 drv
= find_protocol(filename
);
386 drv
= find_image_format(filename
);
390 goto unlink_and_fail
;
393 bs
->opaque
= qemu_mallocz(drv
->instance_size
);
394 /* Note: for compatibility, we open disk image files as RDWR, and
395 RDONLY as fallback */
396 if (!(flags
& BDRV_O_FILE
))
397 open_flags
= BDRV_O_RDWR
| (flags
& BDRV_O_CACHE_MASK
);
399 open_flags
= flags
& ~(BDRV_O_FILE
| BDRV_O_SNAPSHOT
);
400 ret
= drv
->bdrv_open(bs
, filename
, open_flags
);
401 if ((ret
== -EACCES
|| ret
== -EPERM
) && !(flags
& BDRV_O_FILE
)) {
402 ret
= drv
->bdrv_open(bs
, filename
, open_flags
& ~BDRV_O_RDWR
);
406 qemu_free(bs
->opaque
);
410 if (bs
->is_temporary
)
414 if (drv
->bdrv_getlength
) {
415 bs
->total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
418 if (bs
->is_temporary
) {
422 if (bs
->backing_file
[0] != '\0') {
423 /* if there is a backing file, use it */
424 bs
->backing_hd
= bdrv_new("");
425 path_combine(backing_filename
, sizeof(backing_filename
),
426 filename
, bs
->backing_file
);
427 ret
= bdrv_open(bs
->backing_hd
, backing_filename
, open_flags
);
434 /* call the change callback */
435 bs
->media_changed
= 1;
437 bs
->change_cb(bs
->change_opaque
);
442 void bdrv_close(BlockDriverState
*bs
)
446 bdrv_delete(bs
->backing_hd
);
447 bs
->drv
->bdrv_close(bs
);
448 qemu_free(bs
->opaque
);
450 if (bs
->is_temporary
) {
451 unlink(bs
->filename
);
457 /* call the change callback */
458 bs
->media_changed
= 1;
460 bs
->change_cb(bs
->change_opaque
);
464 void bdrv_delete(BlockDriverState
*bs
)
466 BlockDriverState
**pbs
;
469 while (*pbs
!= bs
&& *pbs
!= NULL
)
478 /* commit COW file into the raw image */
479 int bdrv_commit(BlockDriverState
*bs
)
481 BlockDriver
*drv
= bs
->drv
;
482 int64_t i
, total_sectors
;
484 unsigned char sector
[512];
493 if (!bs
->backing_hd
) {
497 total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
498 for (i
= 0; i
< total_sectors
;) {
499 if (drv
->bdrv_is_allocated(bs
, i
, 65536, &n
)) {
500 for(j
= 0; j
< n
; j
++) {
501 if (bdrv_read(bs
, i
, sector
, 1) != 0) {
505 if (bdrv_write(bs
->backing_hd
, i
, sector
, 1) != 0) {
515 if (drv
->bdrv_make_empty
)
516 return drv
->bdrv_make_empty(bs
);
521 static int bdrv_check_byte_request(BlockDriverState
*bs
, int64_t offset
,
526 if (!bdrv_is_inserted(bs
))
532 len
= bdrv_getlength(bs
);
534 if ((offset
+ size
) > len
)
540 static int bdrv_check_request(BlockDriverState
*bs
, int64_t sector_num
,
545 /* Deal with byte accesses */
547 offset
= -sector_num
;
549 offset
= sector_num
* 512;
551 return bdrv_check_byte_request(bs
, offset
, nb_sectors
* 512);
554 /* return < 0 if error. See bdrv_write() for the return codes */
555 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
556 uint8_t *buf
, int nb_sectors
)
558 BlockDriver
*drv
= bs
->drv
;
562 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
565 if (drv
->bdrv_pread
) {
567 len
= nb_sectors
* 512;
568 ret
= drv
->bdrv_pread(bs
, sector_num
* 512, buf
, len
);
574 bs
->rd_bytes
+= (unsigned) len
;
579 return drv
->bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
583 /* Return < 0 if error. Important errors are:
584 -EIO generic I/O error (may happen for all errors)
585 -ENOMEDIUM No media inserted.
586 -EINVAL Invalid sector number or nb_sectors
587 -EACCES Trying to write a read-only device
589 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
590 const uint8_t *buf
, int nb_sectors
)
592 BlockDriver
*drv
= bs
->drv
;
597 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
600 if (drv
->bdrv_pwrite
) {
601 int ret
, len
, count
= 0;
602 len
= nb_sectors
* 512;
604 ret
= drv
->bdrv_pwrite(bs
, sector_num
* 512, buf
, len
- count
);
606 printf("bdrv_write ret=%d\n", ret
);
611 } while (count
!= len
);
612 bs
->wr_bytes
+= (unsigned) len
;
616 return drv
->bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
619 static int bdrv_pread_em(BlockDriverState
*bs
, int64_t offset
,
620 uint8_t *buf
, int count1
)
622 uint8_t tmp_buf
[SECTOR_SIZE
];
623 int len
, nb_sectors
, count
;
627 /* first read to align to sector start */
628 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
631 sector_num
= offset
>> SECTOR_BITS
;
633 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
635 memcpy(buf
, tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), len
);
643 /* read the sectors "in place" */
644 nb_sectors
= count
>> SECTOR_BITS
;
645 if (nb_sectors
> 0) {
646 if (bdrv_read(bs
, sector_num
, buf
, nb_sectors
) < 0)
648 sector_num
+= nb_sectors
;
649 len
= nb_sectors
<< SECTOR_BITS
;
654 /* add data from the last sector */
656 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
658 memcpy(buf
, tmp_buf
, count
);
663 static int bdrv_pwrite_em(BlockDriverState
*bs
, int64_t offset
,
664 const uint8_t *buf
, int count1
)
666 uint8_t tmp_buf
[SECTOR_SIZE
];
667 int len
, nb_sectors
, count
;
671 /* first write to align to sector start */
672 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
675 sector_num
= offset
>> SECTOR_BITS
;
677 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
679 memcpy(tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), buf
, len
);
680 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
689 /* write the sectors "in place" */
690 nb_sectors
= count
>> SECTOR_BITS
;
691 if (nb_sectors
> 0) {
692 if (bdrv_write(bs
, sector_num
, buf
, nb_sectors
) < 0)
694 sector_num
+= nb_sectors
;
695 len
= nb_sectors
<< SECTOR_BITS
;
700 /* add data from the last sector */
702 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
704 memcpy(tmp_buf
, buf
, count
);
705 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
712 * Read with byte offsets (needed only for file protocols)
714 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
715 void *buf1
, int count1
)
717 BlockDriver
*drv
= bs
->drv
;
721 if (bdrv_check_byte_request(bs
, offset
, count1
))
724 if (!drv
->bdrv_pread
)
725 return bdrv_pread_em(bs
, offset
, buf1
, count1
);
726 return drv
->bdrv_pread(bs
, offset
, buf1
, count1
);
730 * Write with byte offsets (needed only for file protocols)
732 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
733 const void *buf1
, int count1
)
735 BlockDriver
*drv
= bs
->drv
;
739 if (bdrv_check_byte_request(bs
, offset
, count1
))
742 if (!drv
->bdrv_pwrite
)
743 return bdrv_pwrite_em(bs
, offset
, buf1
, count1
);
744 return drv
->bdrv_pwrite(bs
, offset
, buf1
, count1
);
748 * Truncate file to 'offset' bytes (needed only for file protocols)
750 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
752 BlockDriver
*drv
= bs
->drv
;
755 if (!drv
->bdrv_truncate
)
757 return drv
->bdrv_truncate(bs
, offset
);
761 * Length of a file in bytes. Return < 0 if error or unknown.
763 int64_t bdrv_getlength(BlockDriverState
*bs
)
765 BlockDriver
*drv
= bs
->drv
;
768 if (!drv
->bdrv_getlength
) {
770 return bs
->total_sectors
* SECTOR_SIZE
;
772 return drv
->bdrv_getlength(bs
);
775 /* return 0 as number of sectors if no device present or error */
776 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
779 length
= bdrv_getlength(bs
);
783 length
= length
>> SECTOR_BITS
;
784 *nb_sectors_ptr
= length
;
788 uint8_t boot_ind
; /* 0x80 - active */
789 uint8_t head
; /* starting head */
790 uint8_t sector
; /* starting sector */
791 uint8_t cyl
; /* starting cylinder */
792 uint8_t sys_ind
; /* What partition type */
793 uint8_t end_head
; /* end head */
794 uint8_t end_sector
; /* end sector */
795 uint8_t end_cyl
; /* end cylinder */
796 uint32_t start_sect
; /* starting sector counting from 0 */
797 uint32_t nr_sects
; /* nr of sectors in partition */
798 } __attribute__((packed
));
800 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
801 static int guess_disk_lchs(BlockDriverState
*bs
,
802 int *pcylinders
, int *pheads
, int *psectors
)
805 int ret
, i
, heads
, sectors
, cylinders
;
810 buf
= qemu_memalign(512, 512);
814 bdrv_get_geometry(bs
, &nb_sectors
);
816 ret
= bdrv_read(bs
, 0, buf
, 1);
819 /* test msdos magic */
820 if (buf
[510] != 0x55 || buf
[511] != 0xaa) {
824 for(i
= 0; i
< 4; i
++) {
825 p
= ((struct partition
*)(buf
+ 0x1be)) + i
;
826 nr_sects
= le32_to_cpu(p
->nr_sects
);
827 if (nr_sects
&& p
->end_head
) {
828 /* We make the assumption that the partition terminates on
829 a cylinder boundary */
830 heads
= p
->end_head
+ 1;
831 sectors
= p
->end_sector
& 63;
834 cylinders
= nb_sectors
/ (heads
* sectors
);
835 if (cylinders
< 1 || cylinders
> 16383)
839 *pcylinders
= cylinders
;
841 printf("guessed geometry: LCHS=%d %d %d\n",
842 cylinders
, heads
, sectors
);
852 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
854 int translation
, lba_detected
= 0;
855 int cylinders
, heads
, secs
;
858 /* if a geometry hint is available, use it */
859 bdrv_get_geometry(bs
, &nb_sectors
);
860 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
861 translation
= bdrv_get_translation_hint(bs
);
862 if (cylinders
!= 0) {
867 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
869 /* if heads > 16, it means that a BIOS LBA
870 translation was active, so the default
871 hardware geometry is OK */
873 goto default_geometry
;
878 /* disable any translation to be in sync with
879 the logical geometry */
880 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
881 bdrv_set_translation_hint(bs
,
882 BIOS_ATA_TRANSLATION_NONE
);
887 /* if no geometry, use a standard physical disk geometry */
888 cylinders
= nb_sectors
/ (16 * 63);
890 if (cylinders
> 16383)
892 else if (cylinders
< 2)
897 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
898 if ((*pcyls
* *pheads
) <= 131072) {
899 bdrv_set_translation_hint(bs
,
900 BIOS_ATA_TRANSLATION_LARGE
);
902 bdrv_set_translation_hint(bs
,
903 BIOS_ATA_TRANSLATION_LBA
);
907 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
911 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
912 int cyls
, int heads
, int secs
)
919 void bdrv_set_type_hint(BlockDriverState
*bs
, int type
)
922 bs
->removable
= ((type
== BDRV_TYPE_CDROM
||
923 type
== BDRV_TYPE_FLOPPY
));
926 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
928 bs
->translation
= translation
;
931 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
932 int *pcyls
, int *pheads
, int *psecs
)
939 int bdrv_get_type_hint(BlockDriverState
*bs
)
944 int bdrv_get_translation_hint(BlockDriverState
*bs
)
946 return bs
->translation
;
949 int bdrv_is_removable(BlockDriverState
*bs
)
951 return bs
->removable
;
954 int bdrv_is_read_only(BlockDriverState
*bs
)
956 return bs
->read_only
;
959 int bdrv_is_sg(BlockDriverState
*bs
)
964 /* XXX: no longer used */
965 void bdrv_set_change_cb(BlockDriverState
*bs
,
966 void (*change_cb
)(void *opaque
), void *opaque
)
968 bs
->change_cb
= change_cb
;
969 bs
->change_opaque
= opaque
;
972 int bdrv_is_encrypted(BlockDriverState
*bs
)
974 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
976 return bs
->encrypted
;
979 int bdrv_key_required(BlockDriverState
*bs
)
981 BlockDriverState
*backing_hd
= bs
->backing_hd
;
983 if (backing_hd
&& backing_hd
->encrypted
&& !backing_hd
->valid_key
)
985 return (bs
->encrypted
&& !bs
->valid_key
);
988 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
991 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
992 ret
= bdrv_set_key(bs
->backing_hd
, key
);
998 if (!bs
->encrypted
|| !bs
->drv
|| !bs
->drv
->bdrv_set_key
)
1000 ret
= bs
->drv
->bdrv_set_key(bs
, key
);
1001 bs
->valid_key
= (ret
== 0);
1005 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
1010 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
1014 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
1019 for (drv
= first_drv
; drv
!= NULL
; drv
= drv
->next
) {
1020 it(opaque
, drv
->format_name
);
1024 BlockDriverState
*bdrv_find(const char *name
)
1026 BlockDriverState
*bs
;
1028 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1029 if (!strcmp(name
, bs
->device_name
))
1035 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
), void *opaque
)
1037 BlockDriverState
*bs
;
1039 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1044 const char *bdrv_get_device_name(BlockDriverState
*bs
)
1046 return bs
->device_name
;
1049 void bdrv_flush(BlockDriverState
*bs
)
1051 if (bs
->drv
->bdrv_flush
)
1052 bs
->drv
->bdrv_flush(bs
);
1054 bdrv_flush(bs
->backing_hd
);
1057 void bdrv_flush_all(void)
1059 BlockDriverState
*bs
;
1061 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
)
1062 if (bs
->drv
&& !bdrv_is_read_only(bs
) &&
1063 (!bdrv_is_removable(bs
) || bdrv_is_inserted(bs
)))
1068 * Returns true iff the specified sector is present in the disk image. Drivers
1069 * not implementing the functionality are assumed to not support backing files,
1070 * hence all their sectors are reported as allocated.
1072 * 'pnum' is set to the number of sectors (including and immediately following
1073 * the specified sector) that are known to be in the same
1074 * allocated/unallocated state.
1076 * 'nb_sectors' is the max value 'pnum' should be set to.
1078 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
1082 if (!bs
->drv
->bdrv_is_allocated
) {
1083 if (sector_num
>= bs
->total_sectors
) {
1087 n
= bs
->total_sectors
- sector_num
;
1088 *pnum
= (n
< nb_sectors
) ? (n
) : (nb_sectors
);
1091 return bs
->drv
->bdrv_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
1094 void bdrv_info(void)
1096 BlockDriverState
*bs
;
1098 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1099 term_printf("%s:", bs
->device_name
);
1100 term_printf(" type=");
1105 case BDRV_TYPE_CDROM
:
1106 term_printf("cdrom");
1108 case BDRV_TYPE_FLOPPY
:
1109 term_printf("floppy");
1112 term_printf(" removable=%d", bs
->removable
);
1113 if (bs
->removable
) {
1114 term_printf(" locked=%d", bs
->locked
);
1117 term_printf(" file=");
1118 term_print_filename(bs
->filename
);
1119 if (bs
->backing_file
[0] != '\0') {
1120 term_printf(" backing_file=");
1121 term_print_filename(bs
->backing_file
);
1123 term_printf(" ro=%d", bs
->read_only
);
1124 term_printf(" drv=%s", bs
->drv
->format_name
);
1125 term_printf(" encrypted=%d", bdrv_is_encrypted(bs
));
1127 term_printf(" [not inserted]");
1133 /* The "info blockstats" command. */
1134 void bdrv_info_stats (void)
1136 BlockDriverState
*bs
;
1138 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1140 " rd_bytes=%" PRIu64
1141 " wr_bytes=%" PRIu64
1142 " rd_operations=%" PRIu64
1143 " wr_operations=%" PRIu64
1146 bs
->rd_bytes
, bs
->wr_bytes
,
1147 bs
->rd_ops
, bs
->wr_ops
);
1151 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
)
1153 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
1154 return bs
->backing_file
;
1155 else if (bs
->encrypted
)
1156 return bs
->filename
;
1161 void bdrv_get_backing_filename(BlockDriverState
*bs
,
1162 char *filename
, int filename_size
)
1164 if (!bs
->backing_hd
) {
1165 pstrcpy(filename
, filename_size
, "");
1167 pstrcpy(filename
, filename_size
, bs
->backing_file
);
1171 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1172 const uint8_t *buf
, int nb_sectors
)
1174 BlockDriver
*drv
= bs
->drv
;
1177 if (!drv
->bdrv_write_compressed
)
1179 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
1182 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1184 BlockDriver
*drv
= bs
->drv
;
1187 if (!drv
->bdrv_get_info
)
1189 memset(bdi
, 0, sizeof(*bdi
));
1190 return drv
->bdrv_get_info(bs
, bdi
);
1193 int bdrv_put_buffer(BlockDriverState
*bs
, const uint8_t *buf
, int64_t pos
, int size
)
1195 BlockDriver
*drv
= bs
->drv
;
1198 if (!drv
->bdrv_put_buffer
)
1200 return drv
->bdrv_put_buffer(bs
, buf
, pos
, size
);
1203 int bdrv_get_buffer(BlockDriverState
*bs
, uint8_t *buf
, int64_t pos
, int size
)
1205 BlockDriver
*drv
= bs
->drv
;
1208 if (!drv
->bdrv_get_buffer
)
1210 return drv
->bdrv_get_buffer(bs
, buf
, pos
, size
);
1213 /**************************************************************/
1214 /* handling of snapshots */
1216 int bdrv_snapshot_create(BlockDriverState
*bs
,
1217 QEMUSnapshotInfo
*sn_info
)
1219 BlockDriver
*drv
= bs
->drv
;
1222 if (!drv
->bdrv_snapshot_create
)
1224 return drv
->bdrv_snapshot_create(bs
, sn_info
);
1227 int bdrv_snapshot_goto(BlockDriverState
*bs
,
1228 const char *snapshot_id
)
1230 BlockDriver
*drv
= bs
->drv
;
1233 if (!drv
->bdrv_snapshot_goto
)
1235 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
1238 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
1240 BlockDriver
*drv
= bs
->drv
;
1243 if (!drv
->bdrv_snapshot_delete
)
1245 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
1248 int bdrv_snapshot_list(BlockDriverState
*bs
,
1249 QEMUSnapshotInfo
**psn_info
)
1251 BlockDriver
*drv
= bs
->drv
;
1254 if (!drv
->bdrv_snapshot_list
)
1256 return drv
->bdrv_snapshot_list(bs
, psn_info
);
1259 #define NB_SUFFIXES 4
1261 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
1263 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
1268 snprintf(buf
, buf_size
, "%" PRId64
, size
);
1271 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
1272 if (size
< (10 * base
)) {
1273 snprintf(buf
, buf_size
, "%0.1f%c",
1274 (double)size
/ base
,
1277 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
1278 snprintf(buf
, buf_size
, "%" PRId64
"%c",
1279 ((size
+ (base
>> 1)) / base
),
1289 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
1291 char buf1
[128], date_buf
[128], clock_buf
[128];
1301 snprintf(buf
, buf_size
,
1302 "%-10s%-20s%7s%20s%15s",
1303 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1307 ptm
= localtime(&ti
);
1308 strftime(date_buf
, sizeof(date_buf
),
1309 "%Y-%m-%d %H:%M:%S", ptm
);
1311 localtime_r(&ti
, &tm
);
1312 strftime(date_buf
, sizeof(date_buf
),
1313 "%Y-%m-%d %H:%M:%S", &tm
);
1315 secs
= sn
->vm_clock_nsec
/ 1000000000;
1316 snprintf(clock_buf
, sizeof(clock_buf
),
1317 "%02d:%02d:%02d.%03d",
1319 (int)((secs
/ 60) % 60),
1321 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
1322 snprintf(buf
, buf_size
,
1323 "%-10s%-20s%7s%20s%15s",
1324 sn
->id_str
, sn
->name
,
1325 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
1333 /**************************************************************/
1336 typedef struct VectorTranslationState
{
1340 BlockDriverAIOCB
*aiocb
;
1341 BlockDriverAIOCB
*this_aiocb
;
1342 } VectorTranslationState
;
1344 static void bdrv_aio_rw_vector_cb(void *opaque
, int ret
)
1346 VectorTranslationState
*s
= opaque
;
1349 qemu_iovec_from_buffer(s
->iov
, s
->bounce
, s
->iov
->size
);
1351 qemu_vfree(s
->bounce
);
1352 s
->this_aiocb
->cb(s
->this_aiocb
->opaque
, ret
);
1353 qemu_aio_release(s
->this_aiocb
);
1356 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
1360 BlockDriverCompletionFunc
*cb
,
1365 VectorTranslationState
*s
= qemu_mallocz(sizeof(*s
));
1366 BlockDriverAIOCB
*aiocb
= qemu_aio_get(bs
, cb
, opaque
);
1368 s
->this_aiocb
= aiocb
;
1370 s
->bounce
= qemu_memalign(512, nb_sectors
* 512);
1371 s
->is_write
= is_write
;
1373 qemu_iovec_to_buffer(s
->iov
, s
->bounce
);
1374 s
->aiocb
= bdrv_aio_write(bs
, sector_num
, s
->bounce
, nb_sectors
,
1375 bdrv_aio_rw_vector_cb
, s
);
1377 s
->aiocb
= bdrv_aio_read(bs
, sector_num
, s
->bounce
, nb_sectors
,
1378 bdrv_aio_rw_vector_cb
, s
);
1383 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
1384 QEMUIOVector
*iov
, int nb_sectors
,
1385 BlockDriverCompletionFunc
*cb
, void *opaque
)
1387 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1390 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1394 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
1395 QEMUIOVector
*iov
, int nb_sectors
,
1396 BlockDriverCompletionFunc
*cb
, void *opaque
)
1398 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1401 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1405 BlockDriverAIOCB
*bdrv_aio_read(BlockDriverState
*bs
, int64_t sector_num
,
1406 uint8_t *buf
, int nb_sectors
,
1407 BlockDriverCompletionFunc
*cb
, void *opaque
)
1409 BlockDriver
*drv
= bs
->drv
;
1410 BlockDriverAIOCB
*ret
;
1414 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1417 ret
= drv
->bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1420 /* Update stats even though technically transfer has not happened. */
1421 bs
->rd_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1428 BlockDriverAIOCB
*bdrv_aio_write(BlockDriverState
*bs
, int64_t sector_num
,
1429 const uint8_t *buf
, int nb_sectors
,
1430 BlockDriverCompletionFunc
*cb
, void *opaque
)
1432 BlockDriver
*drv
= bs
->drv
;
1433 BlockDriverAIOCB
*ret
;
1439 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1442 ret
= drv
->bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1445 /* Update stats even though technically transfer has not happened. */
1446 bs
->wr_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1453 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
1455 BlockDriver
*drv
= acb
->bs
->drv
;
1457 if (acb
->cb
== bdrv_aio_rw_vector_cb
) {
1458 VectorTranslationState
*s
= acb
->opaque
;
1462 drv
->bdrv_aio_cancel(acb
);
1466 /**************************************************************/
1467 /* async block device emulation */
1469 static void bdrv_aio_bh_cb(void *opaque
)
1471 BlockDriverAIOCBSync
*acb
= opaque
;
1472 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
1473 qemu_aio_release(acb
);
1476 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
1477 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1478 BlockDriverCompletionFunc
*cb
, void *opaque
)
1480 BlockDriverAIOCBSync
*acb
;
1483 acb
= qemu_aio_get(bs
, cb
, opaque
);
1485 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1486 ret
= bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
1488 qemu_bh_schedule(acb
->bh
);
1489 return &acb
->common
;
1492 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
1493 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
1494 BlockDriverCompletionFunc
*cb
, void *opaque
)
1496 BlockDriverAIOCBSync
*acb
;
1499 acb
= qemu_aio_get(bs
, cb
, opaque
);
1501 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1502 ret
= bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
1504 qemu_bh_schedule(acb
->bh
);
1505 return &acb
->common
;
1508 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
1510 BlockDriverAIOCBSync
*acb
= (BlockDriverAIOCBSync
*)blockacb
;
1511 qemu_bh_cancel(acb
->bh
);
1512 qemu_aio_release(acb
);
1515 /**************************************************************/
1516 /* sync block device emulation */
1518 static void bdrv_rw_em_cb(void *opaque
, int ret
)
1520 *(int *)opaque
= ret
;
1523 #define NOT_DONE 0x7fffffff
1525 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
1526 uint8_t *buf
, int nb_sectors
)
1529 BlockDriverAIOCB
*acb
;
1531 async_ret
= NOT_DONE
;
1532 acb
= bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
,
1533 bdrv_rw_em_cb
, &async_ret
);
1537 while (async_ret
== NOT_DONE
) {
1544 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
1545 const uint8_t *buf
, int nb_sectors
)
1548 BlockDriverAIOCB
*acb
;
1550 async_ret
= NOT_DONE
;
1551 acb
= bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
,
1552 bdrv_rw_em_cb
, &async_ret
);
1555 while (async_ret
== NOT_DONE
) {
1561 void bdrv_init(void)
1563 bdrv_register(&bdrv_raw
);
1564 bdrv_register(&bdrv_host_device
);
1566 bdrv_register(&bdrv_cow
);
1568 bdrv_register(&bdrv_qcow
);
1569 bdrv_register(&bdrv_vmdk
);
1570 bdrv_register(&bdrv_cloop
);
1571 bdrv_register(&bdrv_dmg
);
1572 bdrv_register(&bdrv_bochs
);
1573 bdrv_register(&bdrv_vpc
);
1574 bdrv_register(&bdrv_vvfat
);
1575 bdrv_register(&bdrv_qcow2
);
1576 bdrv_register(&bdrv_parallels
);
1577 bdrv_register(&bdrv_nbd
);
1580 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
1584 BlockDriverAIOCB
*acb
;
1587 if (drv
->free_aiocb
) {
1588 acb
= drv
->free_aiocb
;
1589 drv
->free_aiocb
= acb
->next
;
1591 acb
= qemu_mallocz(drv
->aiocb_size
);
1595 acb
->opaque
= opaque
;
1599 void qemu_aio_release(void *p
)
1601 BlockDriverAIOCB
*acb
= p
;
1602 BlockDriver
*drv
= acb
->bs
->drv
;
1603 acb
->next
= drv
->free_aiocb
;
1604 drv
->free_aiocb
= acb
;
1607 /**************************************************************/
1608 /* removable device support */
1611 * Return TRUE if the media is present
1613 int bdrv_is_inserted(BlockDriverState
*bs
)
1615 BlockDriver
*drv
= bs
->drv
;
1619 if (!drv
->bdrv_is_inserted
)
1621 ret
= drv
->bdrv_is_inserted(bs
);
1626 * Return TRUE if the media changed since the last call to this
1627 * function. It is currently only used for floppy disks
1629 int bdrv_media_changed(BlockDriverState
*bs
)
1631 BlockDriver
*drv
= bs
->drv
;
1634 if (!drv
|| !drv
->bdrv_media_changed
)
1637 ret
= drv
->bdrv_media_changed(bs
);
1638 if (ret
== -ENOTSUP
)
1639 ret
= bs
->media_changed
;
1640 bs
->media_changed
= 0;
1645 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1647 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
)
1649 BlockDriver
*drv
= bs
->drv
;
1652 if (!drv
|| !drv
->bdrv_eject
) {
1655 ret
= drv
->bdrv_eject(bs
, eject_flag
);
1657 if (ret
== -ENOTSUP
) {
1663 int bdrv_is_locked(BlockDriverState
*bs
)
1669 * Lock or unlock the media (if it is locked, the user won't be able
1670 * to eject it manually).
1672 void bdrv_set_locked(BlockDriverState
*bs
, int locked
)
1674 BlockDriver
*drv
= bs
->drv
;
1676 bs
->locked
= locked
;
1677 if (drv
&& drv
->bdrv_set_locked
) {
1678 drv
->bdrv_set_locked(bs
, locked
);
1682 /* needed for generic scsi interface */
1684 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
1686 BlockDriver
*drv
= bs
->drv
;
1688 if (drv
&& drv
->bdrv_ioctl
)
1689 return drv
->bdrv_ioctl(bs
, req
, buf
);