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"
35 #include <sys/types.h>
37 #include <sys/ioctl.h>
48 #define SECTOR_SIZE (1 << SECTOR_BITS)
50 typedef struct BlockDriverAIOCBSync
{
51 BlockDriverAIOCB common
;
54 } BlockDriverAIOCBSync
;
56 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
57 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
58 BlockDriverCompletionFunc
*cb
, void *opaque
);
59 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
60 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
61 BlockDriverCompletionFunc
*cb
, void *opaque
);
62 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*acb
);
63 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
64 uint8_t *buf
, int nb_sectors
);
65 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
66 const uint8_t *buf
, int nb_sectors
);
68 BlockDriverState
*bdrv_first
;
70 static BlockDriver
*first_drv
;
72 int path_is_absolute(const char *path
)
76 /* specific case for names like: "\\.\d:" */
77 if (*path
== '/' || *path
== '\\')
80 p
= strchr(path
, ':');
86 return (*p
== '/' || *p
== '\\');
92 /* if filename is absolute, just copy it to dest. Otherwise, build a
93 path to it by considering it is relative to base_path. URL are
95 void path_combine(char *dest
, int dest_size
,
96 const char *base_path
,
104 if (path_is_absolute(filename
)) {
105 pstrcpy(dest
, dest_size
, filename
);
107 p
= strchr(base_path
, ':');
112 p1
= strrchr(base_path
, '/');
116 p2
= strrchr(base_path
, '\\');
128 if (len
> dest_size
- 1)
130 memcpy(dest
, base_path
, len
);
132 pstrcat(dest
, dest_size
, filename
);
137 static void bdrv_register(BlockDriver
*bdrv
)
139 if (!bdrv
->bdrv_aio_read
) {
140 /* add AIO emulation layer */
141 bdrv
->bdrv_aio_read
= bdrv_aio_read_em
;
142 bdrv
->bdrv_aio_write
= bdrv_aio_write_em
;
143 bdrv
->bdrv_aio_cancel
= bdrv_aio_cancel_em
;
144 bdrv
->aiocb_size
= sizeof(BlockDriverAIOCBSync
);
145 } else if (!bdrv
->bdrv_read
&& !bdrv
->bdrv_pread
) {
146 /* add synchronous IO emulation layer */
147 bdrv
->bdrv_read
= bdrv_read_em
;
148 bdrv
->bdrv_write
= bdrv_write_em
;
150 bdrv
->next
= first_drv
;
154 /* create a new block device (by default it is empty) */
155 BlockDriverState
*bdrv_new(const char *device_name
)
157 BlockDriverState
**pbs
, *bs
;
159 bs
= qemu_mallocz(sizeof(BlockDriverState
));
160 pstrcpy(bs
->device_name
, sizeof(bs
->device_name
), device_name
);
161 if (device_name
[0] != '\0') {
162 /* insert at the end */
171 BlockDriver
*bdrv_find_format(const char *format_name
)
174 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
175 if (!strcmp(drv1
->format_name
, format_name
))
181 int bdrv_create(BlockDriver
*drv
,
182 const char *filename
, int64_t size_in_sectors
,
183 const char *backing_file
, int flags
)
185 if (!drv
->bdrv_create
)
187 return drv
->bdrv_create(filename
, size_in_sectors
, backing_file
, flags
);
191 void get_tmp_filename(char *filename
, int size
)
193 char temp_dir
[MAX_PATH
];
195 GetTempPath(MAX_PATH
, temp_dir
);
196 GetTempFileName(temp_dir
, "qem", 0, filename
);
199 void get_tmp_filename(char *filename
, int size
)
203 /* XXX: race condition possible */
204 tmpdir
= getenv("TMPDIR");
207 snprintf(filename
, size
, "%s/vl.XXXXXX", tmpdir
);
208 fd
= mkstemp(filename
);
214 static int is_windows_drive_prefix(const char *filename
)
216 return (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
217 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
221 static int is_windows_drive(const char *filename
)
223 if (is_windows_drive_prefix(filename
) &&
226 if (strstart(filename
, "\\\\.\\", NULL
) ||
227 strstart(filename
, "//./", NULL
))
233 static BlockDriver
*find_protocol(const char *filename
)
241 if (is_windows_drive(filename
) ||
242 is_windows_drive_prefix(filename
))
245 p
= strchr(filename
, ':');
249 if (len
> sizeof(protocol
) - 1)
250 len
= sizeof(protocol
) - 1;
251 memcpy(protocol
, filename
, len
);
252 protocol
[len
] = '\0';
253 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
254 if (drv1
->protocol_name
&&
255 !strcmp(drv1
->protocol_name
, protocol
))
261 /* XXX: force raw format if block or character device ? It would
262 simplify the BSD case */
263 static BlockDriver
*find_image_format(const char *filename
)
265 int ret
, score
, score_max
;
266 BlockDriver
*drv1
, *drv
;
268 BlockDriverState
*bs
;
270 /* detect host devices. By convention, /dev/cdrom[N] is always
271 recognized as a host CDROM */
272 if (strstart(filename
, "/dev/cdrom", NULL
))
273 return &bdrv_host_device
;
275 if (is_windows_drive(filename
))
276 return &bdrv_host_device
;
280 if (stat(filename
, &st
) >= 0 &&
281 (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
282 return &bdrv_host_device
;
287 drv
= find_protocol(filename
);
288 /* no need to test disk image formats for vvfat */
289 if (drv
== &bdrv_vvfat
)
292 ret
= bdrv_file_open(&bs
, filename
, BDRV_O_RDONLY
);
295 ret
= bdrv_pread(bs
, 0, buf
, sizeof(buf
));
302 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
303 if (drv1
->bdrv_probe
) {
304 score
= drv1
->bdrv_probe(buf
, ret
, filename
);
305 if (score
> score_max
) {
314 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
)
316 BlockDriverState
*bs
;
320 ret
= bdrv_open2(bs
, filename
, flags
| BDRV_O_FILE
, NULL
);
330 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
)
332 return bdrv_open2(bs
, filename
, flags
, NULL
);
335 int bdrv_open2(BlockDriverState
*bs
, const char *filename
, int flags
,
339 char tmp_filename
[PATH_MAX
];
340 char backing_filename
[PATH_MAX
];
343 bs
->is_temporary
= 0;
347 if (flags
& BDRV_O_SNAPSHOT
) {
348 BlockDriverState
*bs1
;
352 /* if snapshot, we create a temporary backing file and open it
353 instead of opening 'filename' directly */
355 /* if there is a backing file, use it */
357 ret
= bdrv_open(bs1
, filename
, 0);
362 total_size
= bdrv_getlength(bs1
) >> SECTOR_BITS
;
364 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
369 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
371 /* Real path is meaningless for protocols */
373 snprintf(backing_filename
, sizeof(backing_filename
),
376 realpath(filename
, backing_filename
);
378 ret
= bdrv_create(&bdrv_qcow2
, tmp_filename
,
379 total_size
, backing_filename
, 0);
383 filename
= tmp_filename
;
384 bs
->is_temporary
= 1;
387 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
388 if (flags
& BDRV_O_FILE
) {
389 drv
= find_protocol(filename
);
391 drv
= find_image_format(filename
);
395 goto unlink_and_fail
;
398 bs
->opaque
= qemu_mallocz(drv
->instance_size
);
399 /* Note: for compatibility, we open disk image files as RDWR, and
400 RDONLY as fallback */
401 if (!(flags
& BDRV_O_FILE
))
402 open_flags
= BDRV_O_RDWR
| (flags
& BDRV_O_CACHE_MASK
);
404 open_flags
= flags
& ~(BDRV_O_FILE
| BDRV_O_SNAPSHOT
);
405 ret
= drv
->bdrv_open(bs
, filename
, open_flags
);
406 if ((ret
== -EACCES
|| ret
== -EPERM
) && !(flags
& BDRV_O_FILE
)) {
407 ret
= drv
->bdrv_open(bs
, filename
, open_flags
& ~BDRV_O_RDWR
);
411 qemu_free(bs
->opaque
);
415 if (bs
->is_temporary
)
419 if (drv
->bdrv_getlength
) {
420 bs
->total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
423 if (bs
->is_temporary
) {
427 if (bs
->backing_file
[0] != '\0') {
428 /* if there is a backing file, use it */
429 bs
->backing_hd
= bdrv_new("");
430 path_combine(backing_filename
, sizeof(backing_filename
),
431 filename
, bs
->backing_file
);
432 ret
= bdrv_open(bs
->backing_hd
, backing_filename
, open_flags
);
439 if (!bdrv_key_required(bs
)) {
440 /* call the change callback */
441 bs
->media_changed
= 1;
443 bs
->change_cb(bs
->change_opaque
);
448 void bdrv_close(BlockDriverState
*bs
)
452 bdrv_delete(bs
->backing_hd
);
453 bs
->drv
->bdrv_close(bs
);
454 qemu_free(bs
->opaque
);
456 if (bs
->is_temporary
) {
457 unlink(bs
->filename
);
463 /* call the change callback */
464 bs
->media_changed
= 1;
466 bs
->change_cb(bs
->change_opaque
);
470 void bdrv_delete(BlockDriverState
*bs
)
472 BlockDriverState
**pbs
;
475 while (*pbs
!= bs
&& *pbs
!= NULL
)
484 /* commit COW file into the raw image */
485 int bdrv_commit(BlockDriverState
*bs
)
487 BlockDriver
*drv
= bs
->drv
;
488 int64_t i
, total_sectors
;
490 unsigned char sector
[512];
499 if (!bs
->backing_hd
) {
503 total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
504 for (i
= 0; i
< total_sectors
;) {
505 if (drv
->bdrv_is_allocated(bs
, i
, 65536, &n
)) {
506 for(j
= 0; j
< n
; j
++) {
507 if (bdrv_read(bs
, i
, sector
, 1) != 0) {
511 if (bdrv_write(bs
->backing_hd
, i
, sector
, 1) != 0) {
521 if (drv
->bdrv_make_empty
)
522 return drv
->bdrv_make_empty(bs
);
527 static int bdrv_check_byte_request(BlockDriverState
*bs
, int64_t offset
,
532 if (!bdrv_is_inserted(bs
))
538 len
= bdrv_getlength(bs
);
540 if ((offset
+ size
) > len
)
546 static int bdrv_check_request(BlockDriverState
*bs
, int64_t sector_num
,
551 /* Deal with byte accesses */
553 offset
= -sector_num
;
555 offset
= sector_num
* 512;
557 return bdrv_check_byte_request(bs
, offset
, nb_sectors
* 512);
560 /* return < 0 if error. See bdrv_write() for the return codes */
561 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
562 uint8_t *buf
, int nb_sectors
)
564 BlockDriver
*drv
= bs
->drv
;
568 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
571 if (drv
->bdrv_pread
) {
573 len
= nb_sectors
* 512;
574 ret
= drv
->bdrv_pread(bs
, sector_num
* 512, buf
, len
);
580 bs
->rd_bytes
+= (unsigned) len
;
585 return drv
->bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
589 /* Return < 0 if error. Important errors are:
590 -EIO generic I/O error (may happen for all errors)
591 -ENOMEDIUM No media inserted.
592 -EINVAL Invalid sector number or nb_sectors
593 -EACCES Trying to write a read-only device
595 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
596 const uint8_t *buf
, int nb_sectors
)
598 BlockDriver
*drv
= bs
->drv
;
603 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
606 if (drv
->bdrv_pwrite
) {
607 int ret
, len
, count
= 0;
608 len
= nb_sectors
* 512;
610 ret
= drv
->bdrv_pwrite(bs
, sector_num
* 512, buf
, len
- count
);
612 printf("bdrv_write ret=%d\n", ret
);
617 } while (count
!= len
);
618 bs
->wr_bytes
+= (unsigned) len
;
622 return drv
->bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
625 static int bdrv_pread_em(BlockDriverState
*bs
, int64_t offset
,
626 uint8_t *buf
, int count1
)
628 uint8_t tmp_buf
[SECTOR_SIZE
];
629 int len
, nb_sectors
, count
;
633 /* first read to align to sector start */
634 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
637 sector_num
= offset
>> SECTOR_BITS
;
639 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
641 memcpy(buf
, tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), len
);
649 /* read the sectors "in place" */
650 nb_sectors
= count
>> SECTOR_BITS
;
651 if (nb_sectors
> 0) {
652 if (bdrv_read(bs
, sector_num
, buf
, nb_sectors
) < 0)
654 sector_num
+= nb_sectors
;
655 len
= nb_sectors
<< SECTOR_BITS
;
660 /* add data from the last sector */
662 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
664 memcpy(buf
, tmp_buf
, count
);
669 static int bdrv_pwrite_em(BlockDriverState
*bs
, int64_t offset
,
670 const uint8_t *buf
, int count1
)
672 uint8_t tmp_buf
[SECTOR_SIZE
];
673 int len
, nb_sectors
, count
;
677 /* first write to align to sector start */
678 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
681 sector_num
= offset
>> SECTOR_BITS
;
683 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
685 memcpy(tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), buf
, len
);
686 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
695 /* write the sectors "in place" */
696 nb_sectors
= count
>> SECTOR_BITS
;
697 if (nb_sectors
> 0) {
698 if (bdrv_write(bs
, sector_num
, buf
, nb_sectors
) < 0)
700 sector_num
+= nb_sectors
;
701 len
= nb_sectors
<< SECTOR_BITS
;
706 /* add data from the last sector */
708 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
710 memcpy(tmp_buf
, buf
, count
);
711 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
718 * Read with byte offsets (needed only for file protocols)
720 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
721 void *buf1
, int count1
)
723 BlockDriver
*drv
= bs
->drv
;
727 if (bdrv_check_byte_request(bs
, offset
, count1
))
730 if (!drv
->bdrv_pread
)
731 return bdrv_pread_em(bs
, offset
, buf1
, count1
);
732 return drv
->bdrv_pread(bs
, offset
, buf1
, count1
);
736 * Write with byte offsets (needed only for file protocols)
738 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
739 const void *buf1
, int count1
)
741 BlockDriver
*drv
= bs
->drv
;
745 if (bdrv_check_byte_request(bs
, offset
, count1
))
748 if (!drv
->bdrv_pwrite
)
749 return bdrv_pwrite_em(bs
, offset
, buf1
, count1
);
750 return drv
->bdrv_pwrite(bs
, offset
, buf1
, count1
);
754 * Truncate file to 'offset' bytes (needed only for file protocols)
756 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
758 BlockDriver
*drv
= bs
->drv
;
761 if (!drv
->bdrv_truncate
)
763 return drv
->bdrv_truncate(bs
, offset
);
767 * Length of a file in bytes. Return < 0 if error or unknown.
769 int64_t bdrv_getlength(BlockDriverState
*bs
)
771 BlockDriver
*drv
= bs
->drv
;
774 if (!drv
->bdrv_getlength
) {
776 return bs
->total_sectors
* SECTOR_SIZE
;
778 return drv
->bdrv_getlength(bs
);
781 /* return 0 as number of sectors if no device present or error */
782 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
785 length
= bdrv_getlength(bs
);
789 length
= length
>> SECTOR_BITS
;
790 *nb_sectors_ptr
= length
;
794 uint8_t boot_ind
; /* 0x80 - active */
795 uint8_t head
; /* starting head */
796 uint8_t sector
; /* starting sector */
797 uint8_t cyl
; /* starting cylinder */
798 uint8_t sys_ind
; /* What partition type */
799 uint8_t end_head
; /* end head */
800 uint8_t end_sector
; /* end sector */
801 uint8_t end_cyl
; /* end cylinder */
802 uint32_t start_sect
; /* starting sector counting from 0 */
803 uint32_t nr_sects
; /* nr of sectors in partition */
804 } __attribute__((packed
));
806 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
807 static int guess_disk_lchs(BlockDriverState
*bs
,
808 int *pcylinders
, int *pheads
, int *psectors
)
811 int ret
, i
, heads
, sectors
, cylinders
;
816 bdrv_get_geometry(bs
, &nb_sectors
);
818 ret
= bdrv_read(bs
, 0, buf
, 1);
821 /* test msdos magic */
822 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
);
850 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
852 int translation
, lba_detected
= 0;
853 int cylinders
, heads
, secs
;
856 /* if a geometry hint is available, use it */
857 bdrv_get_geometry(bs
, &nb_sectors
);
858 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
859 translation
= bdrv_get_translation_hint(bs
);
860 if (cylinders
!= 0) {
865 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
867 /* if heads > 16, it means that a BIOS LBA
868 translation was active, so the default
869 hardware geometry is OK */
871 goto default_geometry
;
876 /* disable any translation to be in sync with
877 the logical geometry */
878 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
879 bdrv_set_translation_hint(bs
,
880 BIOS_ATA_TRANSLATION_NONE
);
885 /* if no geometry, use a standard physical disk geometry */
886 cylinders
= nb_sectors
/ (16 * 63);
888 if (cylinders
> 16383)
890 else if (cylinders
< 2)
895 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
896 if ((*pcyls
* *pheads
) <= 131072) {
897 bdrv_set_translation_hint(bs
,
898 BIOS_ATA_TRANSLATION_LARGE
);
900 bdrv_set_translation_hint(bs
,
901 BIOS_ATA_TRANSLATION_LBA
);
905 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
909 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
910 int cyls
, int heads
, int secs
)
917 void bdrv_set_type_hint(BlockDriverState
*bs
, int type
)
920 bs
->removable
= ((type
== BDRV_TYPE_CDROM
||
921 type
== BDRV_TYPE_FLOPPY
));
924 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
926 bs
->translation
= translation
;
929 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
930 int *pcyls
, int *pheads
, int *psecs
)
937 int bdrv_get_type_hint(BlockDriverState
*bs
)
942 int bdrv_get_translation_hint(BlockDriverState
*bs
)
944 return bs
->translation
;
947 int bdrv_is_removable(BlockDriverState
*bs
)
949 return bs
->removable
;
952 int bdrv_is_read_only(BlockDriverState
*bs
)
954 return bs
->read_only
;
957 int bdrv_is_sg(BlockDriverState
*bs
)
962 /* XXX: no longer used */
963 void bdrv_set_change_cb(BlockDriverState
*bs
,
964 void (*change_cb
)(void *opaque
), void *opaque
)
966 bs
->change_cb
= change_cb
;
967 bs
->change_opaque
= opaque
;
970 int bdrv_is_encrypted(BlockDriverState
*bs
)
972 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
974 return bs
->encrypted
;
977 int bdrv_key_required(BlockDriverState
*bs
)
979 BlockDriverState
*backing_hd
= bs
->backing_hd
;
981 if (backing_hd
&& backing_hd
->encrypted
&& !backing_hd
->valid_key
)
983 return (bs
->encrypted
&& !bs
->valid_key
);
986 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
989 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
990 ret
= bdrv_set_key(bs
->backing_hd
, key
);
996 if (!bs
->encrypted
|| !bs
->drv
|| !bs
->drv
->bdrv_set_key
)
998 ret
= bs
->drv
->bdrv_set_key(bs
, key
);
1001 } else if (!bs
->valid_key
) {
1003 /* call the change callback now, we skipped it on open */
1004 bs
->media_changed
= 1;
1006 bs
->change_cb(bs
->change_opaque
);
1011 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
1016 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
1020 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
1025 for (drv
= first_drv
; drv
!= NULL
; drv
= drv
->next
) {
1026 it(opaque
, drv
->format_name
);
1030 BlockDriverState
*bdrv_find(const char *name
)
1032 BlockDriverState
*bs
;
1034 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1035 if (!strcmp(name
, bs
->device_name
))
1041 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
), void *opaque
)
1043 BlockDriverState
*bs
;
1045 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1050 const char *bdrv_get_device_name(BlockDriverState
*bs
)
1052 return bs
->device_name
;
1055 void bdrv_flush(BlockDriverState
*bs
)
1057 if (bs
->drv
->bdrv_flush
)
1058 bs
->drv
->bdrv_flush(bs
);
1060 bdrv_flush(bs
->backing_hd
);
1063 void bdrv_flush_all(void)
1065 BlockDriverState
*bs
;
1067 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
)
1068 if (bs
->drv
&& !bdrv_is_read_only(bs
) &&
1069 (!bdrv_is_removable(bs
) || bdrv_is_inserted(bs
)))
1074 * Returns true iff the specified sector is present in the disk image. Drivers
1075 * not implementing the functionality are assumed to not support backing files,
1076 * hence all their sectors are reported as allocated.
1078 * 'pnum' is set to the number of sectors (including and immediately following
1079 * the specified sector) that are known to be in the same
1080 * allocated/unallocated state.
1082 * 'nb_sectors' is the max value 'pnum' should be set to.
1084 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
1088 if (!bs
->drv
->bdrv_is_allocated
) {
1089 if (sector_num
>= bs
->total_sectors
) {
1093 n
= bs
->total_sectors
- sector_num
;
1094 *pnum
= (n
< nb_sectors
) ? (n
) : (nb_sectors
);
1097 return bs
->drv
->bdrv_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
1100 void bdrv_info(Monitor
*mon
)
1102 BlockDriverState
*bs
;
1104 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1105 monitor_printf(mon
, "%s:", bs
->device_name
);
1106 monitor_printf(mon
, " type=");
1109 monitor_printf(mon
, "hd");
1111 case BDRV_TYPE_CDROM
:
1112 monitor_printf(mon
, "cdrom");
1114 case BDRV_TYPE_FLOPPY
:
1115 monitor_printf(mon
, "floppy");
1118 monitor_printf(mon
, " removable=%d", bs
->removable
);
1119 if (bs
->removable
) {
1120 monitor_printf(mon
, " locked=%d", bs
->locked
);
1123 monitor_printf(mon
, " file=");
1124 monitor_print_filename(mon
, bs
->filename
);
1125 if (bs
->backing_file
[0] != '\0') {
1126 monitor_printf(mon
, " backing_file=");
1127 monitor_print_filename(mon
, bs
->backing_file
);
1129 monitor_printf(mon
, " ro=%d", bs
->read_only
);
1130 monitor_printf(mon
, " drv=%s", bs
->drv
->format_name
);
1131 monitor_printf(mon
, " encrypted=%d", bdrv_is_encrypted(bs
));
1133 monitor_printf(mon
, " [not inserted]");
1135 monitor_printf(mon
, "\n");
1139 /* The "info blockstats" command. */
1140 void bdrv_info_stats(Monitor
*mon
)
1142 BlockDriverState
*bs
;
1144 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1145 monitor_printf(mon
, "%s:"
1146 " rd_bytes=%" PRIu64
1147 " wr_bytes=%" PRIu64
1148 " rd_operations=%" PRIu64
1149 " wr_operations=%" PRIu64
1152 bs
->rd_bytes
, bs
->wr_bytes
,
1153 bs
->rd_ops
, bs
->wr_ops
);
1157 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
)
1159 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
1160 return bs
->backing_file
;
1161 else if (bs
->encrypted
)
1162 return bs
->filename
;
1167 void bdrv_get_backing_filename(BlockDriverState
*bs
,
1168 char *filename
, int filename_size
)
1170 if (!bs
->backing_hd
) {
1171 pstrcpy(filename
, filename_size
, "");
1173 pstrcpy(filename
, filename_size
, bs
->backing_file
);
1177 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1178 const uint8_t *buf
, int nb_sectors
)
1180 BlockDriver
*drv
= bs
->drv
;
1183 if (!drv
->bdrv_write_compressed
)
1185 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
1188 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1190 BlockDriver
*drv
= bs
->drv
;
1193 if (!drv
->bdrv_get_info
)
1195 memset(bdi
, 0, sizeof(*bdi
));
1196 return drv
->bdrv_get_info(bs
, bdi
);
1199 /**************************************************************/
1200 /* handling of snapshots */
1202 int bdrv_snapshot_create(BlockDriverState
*bs
,
1203 QEMUSnapshotInfo
*sn_info
)
1205 BlockDriver
*drv
= bs
->drv
;
1208 if (!drv
->bdrv_snapshot_create
)
1210 return drv
->bdrv_snapshot_create(bs
, sn_info
);
1213 int bdrv_snapshot_goto(BlockDriverState
*bs
,
1214 const char *snapshot_id
)
1216 BlockDriver
*drv
= bs
->drv
;
1219 if (!drv
->bdrv_snapshot_goto
)
1221 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
1224 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
1226 BlockDriver
*drv
= bs
->drv
;
1229 if (!drv
->bdrv_snapshot_delete
)
1231 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
1234 int bdrv_snapshot_list(BlockDriverState
*bs
,
1235 QEMUSnapshotInfo
**psn_info
)
1237 BlockDriver
*drv
= bs
->drv
;
1240 if (!drv
->bdrv_snapshot_list
)
1242 return drv
->bdrv_snapshot_list(bs
, psn_info
);
1245 #define NB_SUFFIXES 4
1247 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
1249 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
1254 snprintf(buf
, buf_size
, "%" PRId64
, size
);
1257 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
1258 if (size
< (10 * base
)) {
1259 snprintf(buf
, buf_size
, "%0.1f%c",
1260 (double)size
/ base
,
1263 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
1264 snprintf(buf
, buf_size
, "%" PRId64
"%c",
1265 ((size
+ (base
>> 1)) / base
),
1275 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
1277 char buf1
[128], date_buf
[128], clock_buf
[128];
1287 snprintf(buf
, buf_size
,
1288 "%-10s%-20s%7s%20s%15s",
1289 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1293 ptm
= localtime(&ti
);
1294 strftime(date_buf
, sizeof(date_buf
),
1295 "%Y-%m-%d %H:%M:%S", ptm
);
1297 localtime_r(&ti
, &tm
);
1298 strftime(date_buf
, sizeof(date_buf
),
1299 "%Y-%m-%d %H:%M:%S", &tm
);
1301 secs
= sn
->vm_clock_nsec
/ 1000000000;
1302 snprintf(clock_buf
, sizeof(clock_buf
),
1303 "%02d:%02d:%02d.%03d",
1305 (int)((secs
/ 60) % 60),
1307 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
1308 snprintf(buf
, buf_size
,
1309 "%-10s%-20s%7s%20s%15s",
1310 sn
->id_str
, sn
->name
,
1311 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
1319 /**************************************************************/
1322 typedef struct VectorTranslationState
{
1326 BlockDriverAIOCB
*aiocb
;
1327 BlockDriverAIOCB
*this_aiocb
;
1328 } VectorTranslationState
;
1330 static void bdrv_aio_rw_vector_cb(void *opaque
, int ret
)
1332 VectorTranslationState
*s
= opaque
;
1335 qemu_iovec_from_buffer(s
->iov
, s
->bounce
, s
->iov
->size
);
1337 qemu_vfree(s
->bounce
);
1338 s
->this_aiocb
->cb(s
->this_aiocb
->opaque
, ret
);
1339 qemu_aio_release(s
->this_aiocb
);
1342 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
1346 BlockDriverCompletionFunc
*cb
,
1351 VectorTranslationState
*s
= qemu_mallocz(sizeof(*s
));
1352 BlockDriverAIOCB
*aiocb
= qemu_aio_get(bs
, cb
, opaque
);
1354 s
->this_aiocb
= aiocb
;
1356 s
->bounce
= qemu_memalign(512, nb_sectors
* 512);
1357 s
->is_write
= is_write
;
1359 qemu_iovec_to_buffer(s
->iov
, s
->bounce
);
1360 s
->aiocb
= bdrv_aio_write(bs
, sector_num
, s
->bounce
, nb_sectors
,
1361 bdrv_aio_rw_vector_cb
, s
);
1363 s
->aiocb
= bdrv_aio_read(bs
, sector_num
, s
->bounce
, nb_sectors
,
1364 bdrv_aio_rw_vector_cb
, s
);
1369 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
1370 QEMUIOVector
*iov
, int nb_sectors
,
1371 BlockDriverCompletionFunc
*cb
, void *opaque
)
1373 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1376 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1380 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
1381 QEMUIOVector
*iov
, int nb_sectors
,
1382 BlockDriverCompletionFunc
*cb
, void *opaque
)
1384 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1387 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1391 BlockDriverAIOCB
*bdrv_aio_read(BlockDriverState
*bs
, int64_t sector_num
,
1392 uint8_t *buf
, int nb_sectors
,
1393 BlockDriverCompletionFunc
*cb
, void *opaque
)
1395 BlockDriver
*drv
= bs
->drv
;
1396 BlockDriverAIOCB
*ret
;
1400 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1403 ret
= drv
->bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1406 /* Update stats even though technically transfer has not happened. */
1407 bs
->rd_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1414 BlockDriverAIOCB
*bdrv_aio_write(BlockDriverState
*bs
, int64_t sector_num
,
1415 const uint8_t *buf
, int nb_sectors
,
1416 BlockDriverCompletionFunc
*cb
, void *opaque
)
1418 BlockDriver
*drv
= bs
->drv
;
1419 BlockDriverAIOCB
*ret
;
1425 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1428 ret
= drv
->bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1431 /* Update stats even though technically transfer has not happened. */
1432 bs
->wr_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1439 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
1441 BlockDriver
*drv
= acb
->bs
->drv
;
1443 if (acb
->cb
== bdrv_aio_rw_vector_cb
) {
1444 VectorTranslationState
*s
= acb
->opaque
;
1448 drv
->bdrv_aio_cancel(acb
);
1452 /**************************************************************/
1453 /* async block device emulation */
1455 static void bdrv_aio_bh_cb(void *opaque
)
1457 BlockDriverAIOCBSync
*acb
= opaque
;
1458 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
1459 qemu_aio_release(acb
);
1462 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
1463 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1464 BlockDriverCompletionFunc
*cb
, void *opaque
)
1466 BlockDriverAIOCBSync
*acb
;
1469 acb
= qemu_aio_get(bs
, cb
, opaque
);
1471 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1472 ret
= bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
1474 qemu_bh_schedule(acb
->bh
);
1475 return &acb
->common
;
1478 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
1479 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
1480 BlockDriverCompletionFunc
*cb
, void *opaque
)
1482 BlockDriverAIOCBSync
*acb
;
1485 acb
= qemu_aio_get(bs
, cb
, opaque
);
1487 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1488 ret
= bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
1490 qemu_bh_schedule(acb
->bh
);
1491 return &acb
->common
;
1494 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
1496 BlockDriverAIOCBSync
*acb
= (BlockDriverAIOCBSync
*)blockacb
;
1497 qemu_bh_cancel(acb
->bh
);
1498 qemu_aio_release(acb
);
1501 /**************************************************************/
1502 /* sync block device emulation */
1504 static void bdrv_rw_em_cb(void *opaque
, int ret
)
1506 *(int *)opaque
= ret
;
1509 #define NOT_DONE 0x7fffffff
1511 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
1512 uint8_t *buf
, int nb_sectors
)
1515 BlockDriverAIOCB
*acb
;
1517 async_ret
= NOT_DONE
;
1518 acb
= bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
,
1519 bdrv_rw_em_cb
, &async_ret
);
1523 while (async_ret
== NOT_DONE
) {
1530 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
1531 const uint8_t *buf
, int nb_sectors
)
1534 BlockDriverAIOCB
*acb
;
1536 async_ret
= NOT_DONE
;
1537 acb
= bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
,
1538 bdrv_rw_em_cb
, &async_ret
);
1541 while (async_ret
== NOT_DONE
) {
1547 void bdrv_init(void)
1549 bdrv_register(&bdrv_raw
);
1550 bdrv_register(&bdrv_host_device
);
1552 bdrv_register(&bdrv_cow
);
1554 bdrv_register(&bdrv_qcow
);
1555 bdrv_register(&bdrv_vmdk
);
1556 bdrv_register(&bdrv_cloop
);
1557 bdrv_register(&bdrv_dmg
);
1558 bdrv_register(&bdrv_bochs
);
1559 bdrv_register(&bdrv_vpc
);
1560 bdrv_register(&bdrv_vvfat
);
1561 bdrv_register(&bdrv_qcow2
);
1562 bdrv_register(&bdrv_parallels
);
1563 bdrv_register(&bdrv_nbd
);
1566 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
1570 BlockDriverAIOCB
*acb
;
1573 if (drv
->free_aiocb
) {
1574 acb
= drv
->free_aiocb
;
1575 drv
->free_aiocb
= acb
->next
;
1577 acb
= qemu_mallocz(drv
->aiocb_size
);
1581 acb
->opaque
= opaque
;
1585 void qemu_aio_release(void *p
)
1587 BlockDriverAIOCB
*acb
= p
;
1588 BlockDriver
*drv
= acb
->bs
->drv
;
1589 acb
->next
= drv
->free_aiocb
;
1590 drv
->free_aiocb
= acb
;
1593 /**************************************************************/
1594 /* removable device support */
1597 * Return TRUE if the media is present
1599 int bdrv_is_inserted(BlockDriverState
*bs
)
1601 BlockDriver
*drv
= bs
->drv
;
1605 if (!drv
->bdrv_is_inserted
)
1607 ret
= drv
->bdrv_is_inserted(bs
);
1612 * Return TRUE if the media changed since the last call to this
1613 * function. It is currently only used for floppy disks
1615 int bdrv_media_changed(BlockDriverState
*bs
)
1617 BlockDriver
*drv
= bs
->drv
;
1620 if (!drv
|| !drv
->bdrv_media_changed
)
1623 ret
= drv
->bdrv_media_changed(bs
);
1624 if (ret
== -ENOTSUP
)
1625 ret
= bs
->media_changed
;
1626 bs
->media_changed
= 0;
1631 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1633 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
)
1635 BlockDriver
*drv
= bs
->drv
;
1638 if (!drv
|| !drv
->bdrv_eject
) {
1641 ret
= drv
->bdrv_eject(bs
, eject_flag
);
1643 if (ret
== -ENOTSUP
) {
1649 int bdrv_is_locked(BlockDriverState
*bs
)
1655 * Lock or unlock the media (if it is locked, the user won't be able
1656 * to eject it manually).
1658 void bdrv_set_locked(BlockDriverState
*bs
, int locked
)
1660 BlockDriver
*drv
= bs
->drv
;
1662 bs
->locked
= locked
;
1663 if (drv
&& drv
->bdrv_set_locked
) {
1664 drv
->bdrv_set_locked(bs
, locked
);
1668 /* needed for generic scsi interface */
1670 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
1672 BlockDriver
*drv
= bs
->drv
;
1674 if (drv
&& drv
->bdrv_ioctl
)
1675 return drv
->bdrv_ioctl(bs
, req
, buf
);
1679 int bdrv_sg_send_command(BlockDriverState
*bs
, void *buf
, int count
)
1681 return bdrv_pwrite(bs
, -1, buf
, count
);
1684 int bdrv_sg_recv_response(BlockDriverState
*bs
, void *buf
, int count
)
1686 return bdrv_pread(bs
, -1, buf
, count
);
1689 BlockDriverAIOCB
*bdrv_sg_aio_read(BlockDriverState
*bs
, void *buf
, int count
,
1690 BlockDriverCompletionFunc
*cb
, void *opaque
)
1692 return bdrv_aio_read(bs
, 0, buf
, -(int64_t)count
, cb
, opaque
);
1695 BlockDriverAIOCB
*bdrv_sg_aio_write(BlockDriverState
*bs
, void *buf
, int count
,
1696 BlockDriverCompletionFunc
*cb
, void *opaque
)
1698 return bdrv_aio_write(bs
, 0, buf
, -(int64_t)count
, cb
, opaque
);