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>
42 #define SECTOR_SIZE (1 << SECTOR_BITS)
44 typedef struct BlockDriverAIOCBSync
{
45 BlockDriverAIOCB common
;
48 } BlockDriverAIOCBSync
;
50 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
51 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
52 BlockDriverCompletionFunc
*cb
, void *opaque
);
53 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
54 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
55 BlockDriverCompletionFunc
*cb
, void *opaque
);
56 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*acb
);
57 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
58 uint8_t *buf
, int nb_sectors
);
59 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
60 const uint8_t *buf
, int nb_sectors
);
62 BlockDriverState
*bdrv_first
;
64 static BlockDriver
*first_drv
;
66 int path_is_absolute(const char *path
)
70 /* specific case for names like: "\\.\d:" */
71 if (*path
== '/' || *path
== '\\')
74 p
= strchr(path
, ':');
80 return (*p
== '/' || *p
== '\\');
86 /* if filename is absolute, just copy it to dest. Otherwise, build a
87 path to it by considering it is relative to base_path. URL are
89 void path_combine(char *dest
, int dest_size
,
90 const char *base_path
,
98 if (path_is_absolute(filename
)) {
99 pstrcpy(dest
, dest_size
, filename
);
101 p
= strchr(base_path
, ':');
106 p1
= strrchr(base_path
, '/');
110 p2
= strrchr(base_path
, '\\');
122 if (len
> dest_size
- 1)
124 memcpy(dest
, base_path
, len
);
126 pstrcat(dest
, dest_size
, filename
);
131 static void bdrv_register(BlockDriver
*bdrv
)
133 if (!bdrv
->bdrv_aio_read
) {
134 /* add AIO emulation layer */
135 bdrv
->bdrv_aio_read
= bdrv_aio_read_em
;
136 bdrv
->bdrv_aio_write
= bdrv_aio_write_em
;
137 bdrv
->bdrv_aio_cancel
= bdrv_aio_cancel_em
;
138 bdrv
->aiocb_size
= sizeof(BlockDriverAIOCBSync
);
139 } else if (!bdrv
->bdrv_read
&& !bdrv
->bdrv_pread
) {
140 /* add synchronous IO emulation layer */
141 bdrv
->bdrv_read
= bdrv_read_em
;
142 bdrv
->bdrv_write
= bdrv_write_em
;
144 bdrv
->next
= first_drv
;
148 /* create a new block device (by default it is empty) */
149 BlockDriverState
*bdrv_new(const char *device_name
)
151 BlockDriverState
**pbs
, *bs
;
153 bs
= qemu_mallocz(sizeof(BlockDriverState
));
154 pstrcpy(bs
->device_name
, sizeof(bs
->device_name
), device_name
);
155 if (device_name
[0] != '\0') {
156 /* insert at the end */
165 BlockDriver
*bdrv_find_format(const char *format_name
)
168 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
169 if (!strcmp(drv1
->format_name
, format_name
))
175 int bdrv_create(BlockDriver
*drv
,
176 const char *filename
, int64_t size_in_sectors
,
177 const char *backing_file
, int flags
)
179 if (!drv
->bdrv_create
)
181 return drv
->bdrv_create(filename
, size_in_sectors
, backing_file
, flags
);
185 void get_tmp_filename(char *filename
, int size
)
187 char temp_dir
[MAX_PATH
];
189 GetTempPath(MAX_PATH
, temp_dir
);
190 GetTempFileName(temp_dir
, "qem", 0, filename
);
193 void get_tmp_filename(char *filename
, int size
)
197 /* XXX: race condition possible */
198 tmpdir
= getenv("TMPDIR");
201 snprintf(filename
, size
, "%s/vl.XXXXXX", tmpdir
);
202 fd
= mkstemp(filename
);
208 static int is_windows_drive_prefix(const char *filename
)
210 return (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
211 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
215 static int is_windows_drive(const char *filename
)
217 if (is_windows_drive_prefix(filename
) &&
220 if (strstart(filename
, "\\\\.\\", NULL
) ||
221 strstart(filename
, "//./", NULL
))
227 static BlockDriver
*find_protocol(const char *filename
)
235 if (is_windows_drive(filename
) ||
236 is_windows_drive_prefix(filename
))
239 p
= strchr(filename
, ':');
243 if (len
> sizeof(protocol
) - 1)
244 len
= sizeof(protocol
) - 1;
245 memcpy(protocol
, filename
, len
);
246 protocol
[len
] = '\0';
247 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
248 if (drv1
->protocol_name
&&
249 !strcmp(drv1
->protocol_name
, protocol
))
255 /* XXX: force raw format if block or character device ? It would
256 simplify the BSD case */
257 static BlockDriver
*find_image_format(const char *filename
)
259 int ret
, score
, score_max
;
260 BlockDriver
*drv1
, *drv
;
262 BlockDriverState
*bs
;
264 /* detect host devices. By convention, /dev/cdrom[N] is always
265 recognized as a host CDROM */
266 if (strstart(filename
, "/dev/cdrom", NULL
))
267 return &bdrv_host_device
;
269 if (is_windows_drive(filename
))
270 return &bdrv_host_device
;
274 if (stat(filename
, &st
) >= 0 &&
275 (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
276 return &bdrv_host_device
;
281 drv
= find_protocol(filename
);
282 /* no need to test disk image formats for vvfat */
283 if (drv
== &bdrv_vvfat
)
286 ret
= bdrv_file_open(&bs
, filename
, BDRV_O_RDONLY
);
289 ret
= bdrv_pread(bs
, 0, buf
, sizeof(buf
));
296 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
297 if (drv1
->bdrv_probe
) {
298 score
= drv1
->bdrv_probe(buf
, ret
, filename
);
299 if (score
> score_max
) {
308 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
)
310 BlockDriverState
*bs
;
314 ret
= bdrv_open2(bs
, filename
, flags
| BDRV_O_FILE
, NULL
);
324 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
)
326 return bdrv_open2(bs
, filename
, flags
, NULL
);
329 int bdrv_open2(BlockDriverState
*bs
, const char *filename
, int flags
,
333 char tmp_filename
[PATH_MAX
];
334 char backing_filename
[PATH_MAX
];
337 bs
->is_temporary
= 0;
341 if (flags
& BDRV_O_SNAPSHOT
) {
342 BlockDriverState
*bs1
;
346 /* if snapshot, we create a temporary backing file and open it
347 instead of opening 'filename' directly */
349 /* if there is a backing file, use it */
351 ret
= bdrv_open(bs1
, filename
, 0);
356 total_size
= bdrv_getlength(bs1
) >> SECTOR_BITS
;
358 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
363 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
365 /* Real path is meaningless for protocols */
367 snprintf(backing_filename
, sizeof(backing_filename
),
370 realpath(filename
, backing_filename
);
372 ret
= bdrv_create(&bdrv_qcow2
, tmp_filename
,
373 total_size
, backing_filename
, 0);
377 filename
= tmp_filename
;
378 bs
->is_temporary
= 1;
381 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
382 if (flags
& BDRV_O_FILE
) {
383 drv
= find_protocol(filename
);
385 drv
= find_image_format(filename
);
389 goto unlink_and_fail
;
392 bs
->opaque
= qemu_mallocz(drv
->instance_size
);
393 /* Note: for compatibility, we open disk image files as RDWR, and
394 RDONLY as fallback */
395 if (!(flags
& BDRV_O_FILE
))
396 open_flags
= BDRV_O_RDWR
| (flags
& BDRV_O_CACHE_MASK
);
398 open_flags
= flags
& ~(BDRV_O_FILE
| BDRV_O_SNAPSHOT
);
399 ret
= drv
->bdrv_open(bs
, filename
, open_flags
);
400 if ((ret
== -EACCES
|| ret
== -EPERM
) && !(flags
& BDRV_O_FILE
)) {
401 ret
= drv
->bdrv_open(bs
, filename
, open_flags
& ~BDRV_O_RDWR
);
405 qemu_free(bs
->opaque
);
409 if (bs
->is_temporary
)
413 if (drv
->bdrv_getlength
) {
414 bs
->total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
417 if (bs
->is_temporary
) {
421 if (bs
->backing_file
[0] != '\0') {
422 /* if there is a backing file, use it */
423 bs
->backing_hd
= bdrv_new("");
424 path_combine(backing_filename
, sizeof(backing_filename
),
425 filename
, bs
->backing_file
);
426 ret
= bdrv_open(bs
->backing_hd
, backing_filename
, open_flags
);
433 /* call the change callback */
434 bs
->media_changed
= 1;
436 bs
->change_cb(bs
->change_opaque
);
441 void bdrv_close(BlockDriverState
*bs
)
445 bdrv_delete(bs
->backing_hd
);
446 bs
->drv
->bdrv_close(bs
);
447 qemu_free(bs
->opaque
);
449 if (bs
->is_temporary
) {
450 unlink(bs
->filename
);
456 /* call the change callback */
457 bs
->media_changed
= 1;
459 bs
->change_cb(bs
->change_opaque
);
463 void bdrv_delete(BlockDriverState
*bs
)
465 BlockDriverState
**pbs
;
468 while (*pbs
!= bs
&& *pbs
!= NULL
)
477 /* commit COW file into the raw image */
478 int bdrv_commit(BlockDriverState
*bs
)
480 BlockDriver
*drv
= bs
->drv
;
481 int64_t i
, total_sectors
;
483 unsigned char sector
[512];
492 if (!bs
->backing_hd
) {
496 total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
497 for (i
= 0; i
< total_sectors
;) {
498 if (drv
->bdrv_is_allocated(bs
, i
, 65536, &n
)) {
499 for(j
= 0; j
< n
; j
++) {
500 if (bdrv_read(bs
, i
, sector
, 1) != 0) {
504 if (bdrv_write(bs
->backing_hd
, i
, sector
, 1) != 0) {
514 if (drv
->bdrv_make_empty
)
515 return drv
->bdrv_make_empty(bs
);
520 static int bdrv_check_byte_request(BlockDriverState
*bs
, int64_t offset
,
525 if (!bdrv_is_inserted(bs
))
531 len
= bdrv_getlength(bs
);
533 if ((offset
+ size
) > len
)
539 static int bdrv_check_request(BlockDriverState
*bs
, int64_t sector_num
,
544 /* Deal with byte accesses */
546 offset
= -sector_num
;
548 offset
= sector_num
* 512;
550 return bdrv_check_byte_request(bs
, offset
, nb_sectors
* 512);
553 /* return < 0 if error. See bdrv_write() for the return codes */
554 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
555 uint8_t *buf
, int nb_sectors
)
557 BlockDriver
*drv
= bs
->drv
;
561 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
564 if (drv
->bdrv_pread
) {
566 len
= nb_sectors
* 512;
567 ret
= drv
->bdrv_pread(bs
, sector_num
* 512, buf
, len
);
573 bs
->rd_bytes
+= (unsigned) len
;
578 return drv
->bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
582 /* Return < 0 if error. Important errors are:
583 -EIO generic I/O error (may happen for all errors)
584 -ENOMEDIUM No media inserted.
585 -EINVAL Invalid sector number or nb_sectors
586 -EACCES Trying to write a read-only device
588 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
589 const uint8_t *buf
, int nb_sectors
)
591 BlockDriver
*drv
= bs
->drv
;
596 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
599 if (drv
->bdrv_pwrite
) {
600 int ret
, len
, count
= 0;
601 len
= nb_sectors
* 512;
603 ret
= drv
->bdrv_pwrite(bs
, sector_num
* 512, buf
, len
- count
);
605 printf("bdrv_write ret=%d\n", ret
);
610 } while (count
!= len
);
611 bs
->wr_bytes
+= (unsigned) len
;
615 return drv
->bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
618 static int bdrv_pread_em(BlockDriverState
*bs
, int64_t offset
,
619 uint8_t *buf
, int count1
)
621 uint8_t tmp_buf
[SECTOR_SIZE
];
622 int len
, nb_sectors
, count
;
626 /* first read to align to sector start */
627 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
630 sector_num
= offset
>> SECTOR_BITS
;
632 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
634 memcpy(buf
, tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), len
);
642 /* read the sectors "in place" */
643 nb_sectors
= count
>> SECTOR_BITS
;
644 if (nb_sectors
> 0) {
645 if (bdrv_read(bs
, sector_num
, buf
, nb_sectors
) < 0)
647 sector_num
+= nb_sectors
;
648 len
= nb_sectors
<< SECTOR_BITS
;
653 /* add data from the last sector */
655 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
657 memcpy(buf
, tmp_buf
, count
);
662 static int bdrv_pwrite_em(BlockDriverState
*bs
, int64_t offset
,
663 const uint8_t *buf
, int count1
)
665 uint8_t tmp_buf
[SECTOR_SIZE
];
666 int len
, nb_sectors
, count
;
670 /* first write to align to sector start */
671 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
674 sector_num
= offset
>> SECTOR_BITS
;
676 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
678 memcpy(tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), buf
, len
);
679 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
688 /* write the sectors "in place" */
689 nb_sectors
= count
>> SECTOR_BITS
;
690 if (nb_sectors
> 0) {
691 if (bdrv_write(bs
, sector_num
, buf
, nb_sectors
) < 0)
693 sector_num
+= nb_sectors
;
694 len
= nb_sectors
<< SECTOR_BITS
;
699 /* add data from the last sector */
701 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
703 memcpy(tmp_buf
, buf
, count
);
704 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
711 * Read with byte offsets (needed only for file protocols)
713 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
714 void *buf1
, int count1
)
716 BlockDriver
*drv
= bs
->drv
;
720 if (bdrv_check_byte_request(bs
, offset
, count1
))
723 if (!drv
->bdrv_pread
)
724 return bdrv_pread_em(bs
, offset
, buf1
, count1
);
725 return drv
->bdrv_pread(bs
, offset
, buf1
, count1
);
729 * Write with byte offsets (needed only for file protocols)
731 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
732 const void *buf1
, int count1
)
734 BlockDriver
*drv
= bs
->drv
;
738 if (bdrv_check_byte_request(bs
, offset
, count1
))
741 if (!drv
->bdrv_pwrite
)
742 return bdrv_pwrite_em(bs
, offset
, buf1
, count1
);
743 return drv
->bdrv_pwrite(bs
, offset
, buf1
, count1
);
747 * Truncate file to 'offset' bytes (needed only for file protocols)
749 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
751 BlockDriver
*drv
= bs
->drv
;
754 if (!drv
->bdrv_truncate
)
756 return drv
->bdrv_truncate(bs
, offset
);
760 * Length of a file in bytes. Return < 0 if error or unknown.
762 int64_t bdrv_getlength(BlockDriverState
*bs
)
764 BlockDriver
*drv
= bs
->drv
;
767 if (!drv
->bdrv_getlength
) {
769 return bs
->total_sectors
* SECTOR_SIZE
;
771 return drv
->bdrv_getlength(bs
);
774 /* return 0 as number of sectors if no device present or error */
775 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
778 length
= bdrv_getlength(bs
);
782 length
= length
>> SECTOR_BITS
;
783 *nb_sectors_ptr
= length
;
787 uint8_t boot_ind
; /* 0x80 - active */
788 uint8_t head
; /* starting head */
789 uint8_t sector
; /* starting sector */
790 uint8_t cyl
; /* starting cylinder */
791 uint8_t sys_ind
; /* What partition type */
792 uint8_t end_head
; /* end head */
793 uint8_t end_sector
; /* end sector */
794 uint8_t end_cyl
; /* end cylinder */
795 uint32_t start_sect
; /* starting sector counting from 0 */
796 uint32_t nr_sects
; /* nr of sectors in partition */
797 } __attribute__((packed
));
799 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
800 static int guess_disk_lchs(BlockDriverState
*bs
,
801 int *pcylinders
, int *pheads
, int *psectors
)
804 int ret
, i
, heads
, sectors
, cylinders
;
809 bdrv_get_geometry(bs
, &nb_sectors
);
811 ret
= bdrv_read(bs
, 0, buf
, 1);
814 /* test msdos magic */
815 if (buf
[510] != 0x55 || buf
[511] != 0xaa)
817 for(i
= 0; i
< 4; i
++) {
818 p
= ((struct partition
*)(buf
+ 0x1be)) + i
;
819 nr_sects
= le32_to_cpu(p
->nr_sects
);
820 if (nr_sects
&& p
->end_head
) {
821 /* We make the assumption that the partition terminates on
822 a cylinder boundary */
823 heads
= p
->end_head
+ 1;
824 sectors
= p
->end_sector
& 63;
827 cylinders
= nb_sectors
/ (heads
* sectors
);
828 if (cylinders
< 1 || cylinders
> 16383)
832 *pcylinders
= cylinders
;
834 printf("guessed geometry: LCHS=%d %d %d\n",
835 cylinders
, heads
, sectors
);
843 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
845 int translation
, lba_detected
= 0;
846 int cylinders
, heads
, secs
;
849 /* if a geometry hint is available, use it */
850 bdrv_get_geometry(bs
, &nb_sectors
);
851 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
852 translation
= bdrv_get_translation_hint(bs
);
853 if (cylinders
!= 0) {
858 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
860 /* if heads > 16, it means that a BIOS LBA
861 translation was active, so the default
862 hardware geometry is OK */
864 goto default_geometry
;
869 /* disable any translation to be in sync with
870 the logical geometry */
871 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
872 bdrv_set_translation_hint(bs
,
873 BIOS_ATA_TRANSLATION_NONE
);
878 /* if no geometry, use a standard physical disk geometry */
879 cylinders
= nb_sectors
/ (16 * 63);
881 if (cylinders
> 16383)
883 else if (cylinders
< 2)
888 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
889 if ((*pcyls
* *pheads
) <= 131072) {
890 bdrv_set_translation_hint(bs
,
891 BIOS_ATA_TRANSLATION_LARGE
);
893 bdrv_set_translation_hint(bs
,
894 BIOS_ATA_TRANSLATION_LBA
);
898 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
902 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
903 int cyls
, int heads
, int secs
)
910 void bdrv_set_type_hint(BlockDriverState
*bs
, int type
)
913 bs
->removable
= ((type
== BDRV_TYPE_CDROM
||
914 type
== BDRV_TYPE_FLOPPY
));
917 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
919 bs
->translation
= translation
;
922 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
923 int *pcyls
, int *pheads
, int *psecs
)
930 int bdrv_get_type_hint(BlockDriverState
*bs
)
935 int bdrv_get_translation_hint(BlockDriverState
*bs
)
937 return bs
->translation
;
940 int bdrv_is_removable(BlockDriverState
*bs
)
942 return bs
->removable
;
945 int bdrv_is_read_only(BlockDriverState
*bs
)
947 return bs
->read_only
;
950 int bdrv_is_sg(BlockDriverState
*bs
)
955 /* XXX: no longer used */
956 void bdrv_set_change_cb(BlockDriverState
*bs
,
957 void (*change_cb
)(void *opaque
), void *opaque
)
959 bs
->change_cb
= change_cb
;
960 bs
->change_opaque
= opaque
;
963 int bdrv_is_encrypted(BlockDriverState
*bs
)
965 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
967 return bs
->encrypted
;
970 int bdrv_key_required(BlockDriverState
*bs
)
972 BlockDriverState
*backing_hd
= bs
->backing_hd
;
974 if (backing_hd
&& backing_hd
->encrypted
&& !backing_hd
->valid_key
)
976 return (bs
->encrypted
&& !bs
->valid_key
);
979 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
982 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
983 ret
= bdrv_set_key(bs
->backing_hd
, key
);
989 if (!bs
->encrypted
|| !bs
->drv
|| !bs
->drv
->bdrv_set_key
)
991 ret
= bs
->drv
->bdrv_set_key(bs
, key
);
992 bs
->valid_key
= (ret
== 0);
996 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
1001 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
1005 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
1010 for (drv
= first_drv
; drv
!= NULL
; drv
= drv
->next
) {
1011 it(opaque
, drv
->format_name
);
1015 BlockDriverState
*bdrv_find(const char *name
)
1017 BlockDriverState
*bs
;
1019 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1020 if (!strcmp(name
, bs
->device_name
))
1026 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
), void *opaque
)
1028 BlockDriverState
*bs
;
1030 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1035 const char *bdrv_get_device_name(BlockDriverState
*bs
)
1037 return bs
->device_name
;
1040 void bdrv_flush(BlockDriverState
*bs
)
1042 if (bs
->drv
->bdrv_flush
)
1043 bs
->drv
->bdrv_flush(bs
);
1045 bdrv_flush(bs
->backing_hd
);
1048 void bdrv_flush_all(void)
1050 BlockDriverState
*bs
;
1052 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
)
1053 if (bs
->drv
&& !bdrv_is_read_only(bs
) &&
1054 (!bdrv_is_removable(bs
) || bdrv_is_inserted(bs
)))
1059 * Returns true iff the specified sector is present in the disk image. Drivers
1060 * not implementing the functionality are assumed to not support backing files,
1061 * hence all their sectors are reported as allocated.
1063 * 'pnum' is set to the number of sectors (including and immediately following
1064 * the specified sector) that are known to be in the same
1065 * allocated/unallocated state.
1067 * 'nb_sectors' is the max value 'pnum' should be set to.
1069 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
1073 if (!bs
->drv
->bdrv_is_allocated
) {
1074 if (sector_num
>= bs
->total_sectors
) {
1078 n
= bs
->total_sectors
- sector_num
;
1079 *pnum
= (n
< nb_sectors
) ? (n
) : (nb_sectors
);
1082 return bs
->drv
->bdrv_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
1085 void bdrv_info(void)
1087 BlockDriverState
*bs
;
1089 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1090 term_printf("%s:", bs
->device_name
);
1091 term_printf(" type=");
1096 case BDRV_TYPE_CDROM
:
1097 term_printf("cdrom");
1099 case BDRV_TYPE_FLOPPY
:
1100 term_printf("floppy");
1103 term_printf(" removable=%d", bs
->removable
);
1104 if (bs
->removable
) {
1105 term_printf(" locked=%d", bs
->locked
);
1108 term_printf(" file=");
1109 term_print_filename(bs
->filename
);
1110 if (bs
->backing_file
[0] != '\0') {
1111 term_printf(" backing_file=");
1112 term_print_filename(bs
->backing_file
);
1114 term_printf(" ro=%d", bs
->read_only
);
1115 term_printf(" drv=%s", bs
->drv
->format_name
);
1116 term_printf(" encrypted=%d", bdrv_is_encrypted(bs
));
1118 term_printf(" [not inserted]");
1124 /* The "info blockstats" command. */
1125 void bdrv_info_stats (void)
1127 BlockDriverState
*bs
;
1128 BlockDriverInfo bdi
;
1130 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1132 " rd_bytes=%" PRIu64
1133 " wr_bytes=%" PRIu64
1134 " rd_operations=%" PRIu64
1135 " wr_operations=%" PRIu64
1138 bs
->rd_bytes
, bs
->wr_bytes
,
1139 bs
->rd_ops
, bs
->wr_ops
);
1140 if (bdrv_get_info(bs
, &bdi
) == 0)
1141 term_printf(" high=%" PRId64
1142 " bytes_free=%" PRId64
,
1143 bdi
.highest_alloc
, bdi
.num_free_bytes
);
1148 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
)
1150 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
1151 return bs
->backing_file
;
1152 else if (bs
->encrypted
)
1153 return bs
->filename
;
1158 void bdrv_get_backing_filename(BlockDriverState
*bs
,
1159 char *filename
, int filename_size
)
1161 if (!bs
->backing_hd
) {
1162 pstrcpy(filename
, filename_size
, "");
1164 pstrcpy(filename
, filename_size
, bs
->backing_file
);
1168 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1169 const uint8_t *buf
, int nb_sectors
)
1171 BlockDriver
*drv
= bs
->drv
;
1174 if (!drv
->bdrv_write_compressed
)
1176 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
1179 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1181 BlockDriver
*drv
= bs
->drv
;
1184 if (!drv
->bdrv_get_info
)
1186 memset(bdi
, 0, sizeof(*bdi
));
1187 return drv
->bdrv_get_info(bs
, bdi
);
1190 /**************************************************************/
1191 /* handling of snapshots */
1193 int bdrv_snapshot_create(BlockDriverState
*bs
,
1194 QEMUSnapshotInfo
*sn_info
)
1196 BlockDriver
*drv
= bs
->drv
;
1199 if (!drv
->bdrv_snapshot_create
)
1201 return drv
->bdrv_snapshot_create(bs
, sn_info
);
1204 int bdrv_snapshot_goto(BlockDriverState
*bs
,
1205 const char *snapshot_id
)
1207 BlockDriver
*drv
= bs
->drv
;
1210 if (!drv
->bdrv_snapshot_goto
)
1212 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
1215 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
1217 BlockDriver
*drv
= bs
->drv
;
1220 if (!drv
->bdrv_snapshot_delete
)
1222 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
1225 int bdrv_snapshot_list(BlockDriverState
*bs
,
1226 QEMUSnapshotInfo
**psn_info
)
1228 BlockDriver
*drv
= bs
->drv
;
1231 if (!drv
->bdrv_snapshot_list
)
1233 return drv
->bdrv_snapshot_list(bs
, psn_info
);
1236 #define NB_SUFFIXES 4
1238 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
1240 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
1245 snprintf(buf
, buf_size
, "%" PRId64
, size
);
1248 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
1249 if (size
< (10 * base
)) {
1250 snprintf(buf
, buf_size
, "%0.1f%c",
1251 (double)size
/ base
,
1254 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
1255 snprintf(buf
, buf_size
, "%" PRId64
"%c",
1256 ((size
+ (base
>> 1)) / base
),
1266 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
1268 char buf1
[128], date_buf
[128], clock_buf
[128];
1278 snprintf(buf
, buf_size
,
1279 "%-10s%-20s%7s%20s%15s",
1280 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1284 ptm
= localtime(&ti
);
1285 strftime(date_buf
, sizeof(date_buf
),
1286 "%Y-%m-%d %H:%M:%S", ptm
);
1288 localtime_r(&ti
, &tm
);
1289 strftime(date_buf
, sizeof(date_buf
),
1290 "%Y-%m-%d %H:%M:%S", &tm
);
1292 secs
= sn
->vm_clock_nsec
/ 1000000000;
1293 snprintf(clock_buf
, sizeof(clock_buf
),
1294 "%02d:%02d:%02d.%03d",
1296 (int)((secs
/ 60) % 60),
1298 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
1299 snprintf(buf
, buf_size
,
1300 "%-10s%-20s%7s%20s%15s",
1301 sn
->id_str
, sn
->name
,
1302 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
1310 /**************************************************************/
1313 typedef struct VectorTranslationState
{
1317 BlockDriverAIOCB
*aiocb
;
1318 BlockDriverAIOCB
*this_aiocb
;
1319 } VectorTranslationState
;
1321 static void bdrv_aio_rw_vector_cb(void *opaque
, int ret
)
1323 VectorTranslationState
*s
= opaque
;
1326 qemu_iovec_from_buffer(s
->iov
, s
->bounce
, s
->iov
->size
);
1328 qemu_vfree(s
->bounce
);
1329 s
->this_aiocb
->cb(s
->this_aiocb
->opaque
, ret
);
1330 qemu_aio_release(s
->this_aiocb
);
1333 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
1337 BlockDriverCompletionFunc
*cb
,
1342 VectorTranslationState
*s
= qemu_mallocz(sizeof(*s
));
1343 BlockDriverAIOCB
*aiocb
= qemu_aio_get(bs
, cb
, opaque
);
1345 s
->this_aiocb
= aiocb
;
1347 s
->bounce
= qemu_memalign(512, nb_sectors
* 512);
1348 s
->is_write
= is_write
;
1350 qemu_iovec_to_buffer(s
->iov
, s
->bounce
);
1351 s
->aiocb
= bdrv_aio_write(bs
, sector_num
, s
->bounce
, nb_sectors
,
1352 bdrv_aio_rw_vector_cb
, s
);
1354 s
->aiocb
= bdrv_aio_read(bs
, sector_num
, s
->bounce
, nb_sectors
,
1355 bdrv_aio_rw_vector_cb
, s
);
1360 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
1361 QEMUIOVector
*iov
, int nb_sectors
,
1362 BlockDriverCompletionFunc
*cb
, void *opaque
)
1364 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1367 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1371 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
1372 QEMUIOVector
*iov
, int nb_sectors
,
1373 BlockDriverCompletionFunc
*cb
, void *opaque
)
1375 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1378 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1382 BlockDriverAIOCB
*bdrv_aio_read(BlockDriverState
*bs
, int64_t sector_num
,
1383 uint8_t *buf
, int nb_sectors
,
1384 BlockDriverCompletionFunc
*cb
, void *opaque
)
1386 BlockDriver
*drv
= bs
->drv
;
1387 BlockDriverAIOCB
*ret
;
1391 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1394 ret
= drv
->bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1397 /* Update stats even though technically transfer has not happened. */
1398 bs
->rd_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1405 BlockDriverAIOCB
*bdrv_aio_write(BlockDriverState
*bs
, int64_t sector_num
,
1406 const uint8_t *buf
, int nb_sectors
,
1407 BlockDriverCompletionFunc
*cb
, void *opaque
)
1409 BlockDriver
*drv
= bs
->drv
;
1410 BlockDriverAIOCB
*ret
;
1416 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1419 ret
= drv
->bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1422 /* Update stats even though technically transfer has not happened. */
1423 bs
->wr_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1430 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
1432 BlockDriver
*drv
= acb
->bs
->drv
;
1434 if (acb
->cb
== bdrv_aio_rw_vector_cb
) {
1435 VectorTranslationState
*s
= acb
->opaque
;
1439 drv
->bdrv_aio_cancel(acb
);
1443 /**************************************************************/
1444 /* async block device emulation */
1446 static void bdrv_aio_bh_cb(void *opaque
)
1448 BlockDriverAIOCBSync
*acb
= opaque
;
1449 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
1450 qemu_aio_release(acb
);
1453 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
1454 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1455 BlockDriverCompletionFunc
*cb
, void *opaque
)
1457 BlockDriverAIOCBSync
*acb
;
1460 acb
= qemu_aio_get(bs
, cb
, opaque
);
1462 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1463 ret
= bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
1465 qemu_bh_schedule(acb
->bh
);
1466 return &acb
->common
;
1469 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
1470 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
1471 BlockDriverCompletionFunc
*cb
, void *opaque
)
1473 BlockDriverAIOCBSync
*acb
;
1476 acb
= qemu_aio_get(bs
, cb
, opaque
);
1478 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1479 ret
= bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
1481 qemu_bh_schedule(acb
->bh
);
1482 return &acb
->common
;
1485 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
1487 BlockDriverAIOCBSync
*acb
= (BlockDriverAIOCBSync
*)blockacb
;
1488 qemu_bh_cancel(acb
->bh
);
1489 qemu_aio_release(acb
);
1492 /**************************************************************/
1493 /* sync block device emulation */
1495 static void bdrv_rw_em_cb(void *opaque
, int ret
)
1497 *(int *)opaque
= ret
;
1500 #define NOT_DONE 0x7fffffff
1502 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
1503 uint8_t *buf
, int nb_sectors
)
1506 BlockDriverAIOCB
*acb
;
1508 async_ret
= NOT_DONE
;
1509 acb
= bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
,
1510 bdrv_rw_em_cb
, &async_ret
);
1514 while (async_ret
== NOT_DONE
) {
1521 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
1522 const uint8_t *buf
, int nb_sectors
)
1525 BlockDriverAIOCB
*acb
;
1527 async_ret
= NOT_DONE
;
1528 acb
= bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
,
1529 bdrv_rw_em_cb
, &async_ret
);
1532 while (async_ret
== NOT_DONE
) {
1538 void bdrv_init(void)
1540 bdrv_register(&bdrv_raw
);
1541 bdrv_register(&bdrv_host_device
);
1543 bdrv_register(&bdrv_cow
);
1545 bdrv_register(&bdrv_qcow
);
1546 bdrv_register(&bdrv_vmdk
);
1547 bdrv_register(&bdrv_cloop
);
1548 bdrv_register(&bdrv_dmg
);
1549 bdrv_register(&bdrv_bochs
);
1550 bdrv_register(&bdrv_vpc
);
1551 bdrv_register(&bdrv_vvfat
);
1552 bdrv_register(&bdrv_qcow2
);
1553 bdrv_register(&bdrv_parallels
);
1554 bdrv_register(&bdrv_nbd
);
1557 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
1561 BlockDriverAIOCB
*acb
;
1564 if (drv
->free_aiocb
) {
1565 acb
= drv
->free_aiocb
;
1566 drv
->free_aiocb
= acb
->next
;
1568 acb
= qemu_mallocz(drv
->aiocb_size
);
1572 acb
->opaque
= opaque
;
1576 void qemu_aio_release(void *p
)
1578 BlockDriverAIOCB
*acb
= p
;
1579 BlockDriver
*drv
= acb
->bs
->drv
;
1580 acb
->next
= drv
->free_aiocb
;
1581 drv
->free_aiocb
= acb
;
1584 /**************************************************************/
1585 /* removable device support */
1588 * Return TRUE if the media is present
1590 int bdrv_is_inserted(BlockDriverState
*bs
)
1592 BlockDriver
*drv
= bs
->drv
;
1596 if (!drv
->bdrv_is_inserted
)
1598 ret
= drv
->bdrv_is_inserted(bs
);
1603 * Return TRUE if the media changed since the last call to this
1604 * function. It is currently only used for floppy disks
1606 int bdrv_media_changed(BlockDriverState
*bs
)
1608 BlockDriver
*drv
= bs
->drv
;
1611 if (!drv
|| !drv
->bdrv_media_changed
)
1614 ret
= drv
->bdrv_media_changed(bs
);
1615 if (ret
== -ENOTSUP
)
1616 ret
= bs
->media_changed
;
1617 bs
->media_changed
= 0;
1622 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1624 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
)
1626 BlockDriver
*drv
= bs
->drv
;
1629 if (!drv
|| !drv
->bdrv_eject
) {
1632 ret
= drv
->bdrv_eject(bs
, eject_flag
);
1634 if (ret
== -ENOTSUP
) {
1640 int bdrv_is_locked(BlockDriverState
*bs
)
1646 * Lock or unlock the media (if it is locked, the user won't be able
1647 * to eject it manually).
1649 void bdrv_set_locked(BlockDriverState
*bs
, int locked
)
1651 BlockDriver
*drv
= bs
->drv
;
1653 bs
->locked
= locked
;
1654 if (drv
&& drv
->bdrv_set_locked
) {
1655 drv
->bdrv_set_locked(bs
, locked
);
1659 /* needed for generic scsi interface */
1661 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
1663 BlockDriver
*drv
= bs
->drv
;
1665 if (drv
&& drv
->bdrv_ioctl
)
1666 return drv
->bdrv_ioctl(bs
, req
, buf
);