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>
44 #define SECTOR_SIZE (1 << SECTOR_BITS)
46 typedef struct BlockDriverAIOCBSync
{
47 BlockDriverAIOCB common
;
50 } BlockDriverAIOCBSync
;
52 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
53 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
54 BlockDriverCompletionFunc
*cb
, void *opaque
);
55 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
56 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
57 BlockDriverCompletionFunc
*cb
, void *opaque
);
58 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*acb
);
59 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
60 uint8_t *buf
, int nb_sectors
);
61 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
62 const uint8_t *buf
, int nb_sectors
);
64 BlockDriverState
*bdrv_first
;
66 static BlockDriver
*first_drv
;
68 int path_is_absolute(const char *path
)
72 /* specific case for names like: "\\.\d:" */
73 if (*path
== '/' || *path
== '\\')
76 p
= strchr(path
, ':');
82 return (*p
== '/' || *p
== '\\');
88 /* if filename is absolute, just copy it to dest. Otherwise, build a
89 path to it by considering it is relative to base_path. URL are
91 void path_combine(char *dest
, int dest_size
,
92 const char *base_path
,
100 if (path_is_absolute(filename
)) {
101 pstrcpy(dest
, dest_size
, filename
);
103 p
= strchr(base_path
, ':');
108 p1
= strrchr(base_path
, '/');
112 p2
= strrchr(base_path
, '\\');
124 if (len
> dest_size
- 1)
126 memcpy(dest
, base_path
, len
);
128 pstrcat(dest
, dest_size
, filename
);
133 static void bdrv_register(BlockDriver
*bdrv
)
135 if (!bdrv
->bdrv_aio_read
) {
136 /* add AIO emulation layer */
137 bdrv
->bdrv_aio_read
= bdrv_aio_read_em
;
138 bdrv
->bdrv_aio_write
= bdrv_aio_write_em
;
139 bdrv
->bdrv_aio_cancel
= bdrv_aio_cancel_em
;
140 bdrv
->aiocb_size
= sizeof(BlockDriverAIOCBSync
);
141 } else if (!bdrv
->bdrv_read
&& !bdrv
->bdrv_pread
) {
142 /* add synchronous IO emulation layer */
143 bdrv
->bdrv_read
= bdrv_read_em
;
144 bdrv
->bdrv_write
= bdrv_write_em
;
146 bdrv
->next
= first_drv
;
150 /* create a new block device (by default it is empty) */
151 BlockDriverState
*bdrv_new(const char *device_name
)
153 BlockDriverState
**pbs
, *bs
;
155 bs
= qemu_mallocz(sizeof(BlockDriverState
));
156 pstrcpy(bs
->device_name
, sizeof(bs
->device_name
), device_name
);
157 if (device_name
[0] != '\0') {
158 /* insert at the end */
167 BlockDriver
*bdrv_find_format(const char *format_name
)
170 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
171 if (!strcmp(drv1
->format_name
, format_name
))
177 int bdrv_create(BlockDriver
*drv
,
178 const char *filename
, int64_t size_in_sectors
,
179 const char *backing_file
, int flags
)
181 if (!drv
->bdrv_create
)
183 return drv
->bdrv_create(filename
, size_in_sectors
, backing_file
, flags
);
187 void get_tmp_filename(char *filename
, int size
)
189 char temp_dir
[MAX_PATH
];
191 GetTempPath(MAX_PATH
, temp_dir
);
192 GetTempFileName(temp_dir
, "qem", 0, filename
);
195 void get_tmp_filename(char *filename
, int size
)
199 /* XXX: race condition possible */
200 tmpdir
= getenv("TMPDIR");
203 snprintf(filename
, size
, "%s/vl.XXXXXX", tmpdir
);
204 fd
= mkstemp(filename
);
210 static int is_windows_drive_prefix(const char *filename
)
212 return (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
213 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
217 static int is_windows_drive(const char *filename
)
219 if (is_windows_drive_prefix(filename
) &&
222 if (strstart(filename
, "\\\\.\\", NULL
) ||
223 strstart(filename
, "//./", NULL
))
229 static BlockDriver
*find_protocol(const char *filename
)
237 if (is_windows_drive(filename
) ||
238 is_windows_drive_prefix(filename
))
241 p
= strchr(filename
, ':');
245 if (len
> sizeof(protocol
) - 1)
246 len
= sizeof(protocol
) - 1;
247 memcpy(protocol
, filename
, len
);
248 protocol
[len
] = '\0';
249 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
250 if (drv1
->protocol_name
&&
251 !strcmp(drv1
->protocol_name
, protocol
))
257 /* XXX: force raw format if block or character device ? It would
258 simplify the BSD case */
259 static BlockDriver
*find_image_format(const char *filename
)
261 int ret
, score
, score_max
;
262 BlockDriver
*drv1
, *drv
;
264 BlockDriverState
*bs
;
266 /* detect host devices. By convention, /dev/cdrom[N] is always
267 recognized as a host CDROM */
268 if (strstart(filename
, "/dev/cdrom", NULL
))
269 return &bdrv_host_device
;
271 if (is_windows_drive(filename
))
272 return &bdrv_host_device
;
276 if (stat(filename
, &st
) >= 0 &&
277 (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
278 return &bdrv_host_device
;
283 drv
= find_protocol(filename
);
284 /* no need to test disk image formats for vvfat */
285 if (drv
== &bdrv_vvfat
)
288 ret
= bdrv_file_open(&bs
, filename
, BDRV_O_RDONLY
);
291 ret
= bdrv_pread(bs
, 0, buf
, sizeof(buf
));
298 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
299 if (drv1
->bdrv_probe
) {
300 score
= drv1
->bdrv_probe(buf
, ret
, filename
);
301 if (score
> score_max
) {
310 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
)
312 BlockDriverState
*bs
;
316 ret
= bdrv_open2(bs
, filename
, flags
| BDRV_O_FILE
, NULL
);
326 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
)
328 return bdrv_open2(bs
, filename
, flags
, NULL
);
331 int bdrv_open2(BlockDriverState
*bs
, const char *filename
, int flags
,
335 char tmp_filename
[PATH_MAX
];
336 char backing_filename
[PATH_MAX
];
339 bs
->is_temporary
= 0;
343 if (flags
& BDRV_O_SNAPSHOT
) {
344 BlockDriverState
*bs1
;
348 /* if snapshot, we create a temporary backing file and open it
349 instead of opening 'filename' directly */
351 /* if there is a backing file, use it */
353 ret
= bdrv_open(bs1
, filename
, 0);
358 total_size
= bdrv_getlength(bs1
) >> SECTOR_BITS
;
360 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
365 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
367 /* Real path is meaningless for protocols */
369 snprintf(backing_filename
, sizeof(backing_filename
),
372 realpath(filename
, backing_filename
);
374 ret
= bdrv_create(&bdrv_qcow2
, tmp_filename
,
375 total_size
, backing_filename
, 0);
379 filename
= tmp_filename
;
380 bs
->is_temporary
= 1;
383 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
384 if (flags
& BDRV_O_FILE
) {
385 drv
= find_protocol(filename
);
387 drv
= find_image_format(filename
);
391 goto unlink_and_fail
;
394 bs
->opaque
= qemu_mallocz(drv
->instance_size
);
395 /* Note: for compatibility, we open disk image files as RDWR, and
396 RDONLY as fallback */
397 if (!(flags
& BDRV_O_FILE
))
398 open_flags
= BDRV_O_RDWR
| (flags
& BDRV_O_CACHE_MASK
);
400 open_flags
= flags
& ~(BDRV_O_FILE
| BDRV_O_SNAPSHOT
);
401 ret
= drv
->bdrv_open(bs
, filename
, open_flags
);
402 if ((ret
== -EACCES
|| ret
== -EPERM
) && !(flags
& BDRV_O_FILE
)) {
403 ret
= drv
->bdrv_open(bs
, filename
, open_flags
& ~BDRV_O_RDWR
);
407 qemu_free(bs
->opaque
);
411 if (bs
->is_temporary
)
415 if (drv
->bdrv_getlength
) {
416 bs
->total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
419 if (bs
->is_temporary
) {
423 if (bs
->backing_file
[0] != '\0') {
424 /* if there is a backing file, use it */
425 bs
->backing_hd
= bdrv_new("");
426 path_combine(backing_filename
, sizeof(backing_filename
),
427 filename
, bs
->backing_file
);
428 ret
= bdrv_open(bs
->backing_hd
, backing_filename
, open_flags
);
435 if (!bdrv_key_required(bs
)) {
436 /* call the change callback */
437 bs
->media_changed
= 1;
439 bs
->change_cb(bs
->change_opaque
);
444 void bdrv_close(BlockDriverState
*bs
)
448 bdrv_delete(bs
->backing_hd
);
449 bs
->drv
->bdrv_close(bs
);
450 qemu_free(bs
->opaque
);
452 if (bs
->is_temporary
) {
453 unlink(bs
->filename
);
459 /* call the change callback */
460 bs
->media_changed
= 1;
462 bs
->change_cb(bs
->change_opaque
);
466 void bdrv_delete(BlockDriverState
*bs
)
468 BlockDriverState
**pbs
;
471 while (*pbs
!= bs
&& *pbs
!= NULL
)
480 /* commit COW file into the raw image */
481 int bdrv_commit(BlockDriverState
*bs
)
483 BlockDriver
*drv
= bs
->drv
;
484 int64_t i
, total_sectors
;
486 unsigned char sector
[512];
495 if (!bs
->backing_hd
) {
499 total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
500 for (i
= 0; i
< total_sectors
;) {
501 if (drv
->bdrv_is_allocated(bs
, i
, 65536, &n
)) {
502 for(j
= 0; j
< n
; j
++) {
503 if (bdrv_read(bs
, i
, sector
, 1) != 0) {
507 if (bdrv_write(bs
->backing_hd
, i
, sector
, 1) != 0) {
517 if (drv
->bdrv_make_empty
)
518 return drv
->bdrv_make_empty(bs
);
523 static int bdrv_check_byte_request(BlockDriverState
*bs
, int64_t offset
,
528 if (!bdrv_is_inserted(bs
))
534 len
= bdrv_getlength(bs
);
536 if ((offset
+ size
) > len
)
542 static int bdrv_check_request(BlockDriverState
*bs
, int64_t sector_num
,
547 /* Deal with byte accesses */
549 offset
= -sector_num
;
551 offset
= sector_num
* 512;
553 return bdrv_check_byte_request(bs
, offset
, nb_sectors
* 512);
556 /* return < 0 if error. See bdrv_write() for the return codes */
557 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
558 uint8_t *buf
, int nb_sectors
)
560 BlockDriver
*drv
= bs
->drv
;
564 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
567 if (drv
->bdrv_pread
) {
569 len
= nb_sectors
* 512;
570 ret
= drv
->bdrv_pread(bs
, sector_num
* 512, buf
, len
);
576 bs
->rd_bytes
+= (unsigned) len
;
581 return drv
->bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
585 /* Return < 0 if error. Important errors are:
586 -EIO generic I/O error (may happen for all errors)
587 -ENOMEDIUM No media inserted.
588 -EINVAL Invalid sector number or nb_sectors
589 -EACCES Trying to write a read-only device
591 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
592 const uint8_t *buf
, int nb_sectors
)
594 BlockDriver
*drv
= bs
->drv
;
599 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
602 if (drv
->bdrv_pwrite
) {
603 int ret
, len
, count
= 0;
604 len
= nb_sectors
* 512;
606 ret
= drv
->bdrv_pwrite(bs
, sector_num
* 512, buf
, len
- count
);
608 printf("bdrv_write ret=%d\n", ret
);
613 } while (count
!= len
);
614 bs
->wr_bytes
+= (unsigned) len
;
618 return drv
->bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
621 static int bdrv_pread_em(BlockDriverState
*bs
, int64_t offset
,
622 uint8_t *buf
, int count1
)
624 uint8_t tmp_buf
[SECTOR_SIZE
];
625 int len
, nb_sectors
, count
;
629 /* first read to align to sector start */
630 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
633 sector_num
= offset
>> SECTOR_BITS
;
635 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
637 memcpy(buf
, tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), len
);
645 /* read the sectors "in place" */
646 nb_sectors
= count
>> SECTOR_BITS
;
647 if (nb_sectors
> 0) {
648 if (bdrv_read(bs
, sector_num
, buf
, nb_sectors
) < 0)
650 sector_num
+= nb_sectors
;
651 len
= nb_sectors
<< SECTOR_BITS
;
656 /* add data from the last sector */
658 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
660 memcpy(buf
, tmp_buf
, count
);
665 static int bdrv_pwrite_em(BlockDriverState
*bs
, int64_t offset
,
666 const uint8_t *buf
, int count1
)
668 uint8_t tmp_buf
[SECTOR_SIZE
];
669 int len
, nb_sectors
, count
;
673 /* first write to align to sector start */
674 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
677 sector_num
= offset
>> SECTOR_BITS
;
679 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
681 memcpy(tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), buf
, len
);
682 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
691 /* write the sectors "in place" */
692 nb_sectors
= count
>> SECTOR_BITS
;
693 if (nb_sectors
> 0) {
694 if (bdrv_write(bs
, sector_num
, buf
, nb_sectors
) < 0)
696 sector_num
+= nb_sectors
;
697 len
= nb_sectors
<< SECTOR_BITS
;
702 /* add data from the last sector */
704 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
706 memcpy(tmp_buf
, buf
, count
);
707 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
714 * Read with byte offsets (needed only for file protocols)
716 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
717 void *buf1
, int count1
)
719 BlockDriver
*drv
= bs
->drv
;
723 if (bdrv_check_byte_request(bs
, offset
, count1
))
726 if (!drv
->bdrv_pread
)
727 return bdrv_pread_em(bs
, offset
, buf1
, count1
);
728 return drv
->bdrv_pread(bs
, offset
, buf1
, count1
);
732 * Write with byte offsets (needed only for file protocols)
734 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
735 const void *buf1
, int count1
)
737 BlockDriver
*drv
= bs
->drv
;
741 if (bdrv_check_byte_request(bs
, offset
, count1
))
744 if (!drv
->bdrv_pwrite
)
745 return bdrv_pwrite_em(bs
, offset
, buf1
, count1
);
746 return drv
->bdrv_pwrite(bs
, offset
, buf1
, count1
);
750 * Truncate file to 'offset' bytes (needed only for file protocols)
752 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
754 BlockDriver
*drv
= bs
->drv
;
757 if (!drv
->bdrv_truncate
)
759 return drv
->bdrv_truncate(bs
, offset
);
763 * Length of a file in bytes. Return < 0 if error or unknown.
765 int64_t bdrv_getlength(BlockDriverState
*bs
)
767 BlockDriver
*drv
= bs
->drv
;
770 if (!drv
->bdrv_getlength
) {
772 return bs
->total_sectors
* SECTOR_SIZE
;
774 return drv
->bdrv_getlength(bs
);
777 /* return 0 as number of sectors if no device present or error */
778 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
781 length
= bdrv_getlength(bs
);
785 length
= length
>> SECTOR_BITS
;
786 *nb_sectors_ptr
= length
;
790 uint8_t boot_ind
; /* 0x80 - active */
791 uint8_t head
; /* starting head */
792 uint8_t sector
; /* starting sector */
793 uint8_t cyl
; /* starting cylinder */
794 uint8_t sys_ind
; /* What partition type */
795 uint8_t end_head
; /* end head */
796 uint8_t end_sector
; /* end sector */
797 uint8_t end_cyl
; /* end cylinder */
798 uint32_t start_sect
; /* starting sector counting from 0 */
799 uint32_t nr_sects
; /* nr of sectors in partition */
800 } __attribute__((packed
));
802 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
803 static int guess_disk_lchs(BlockDriverState
*bs
,
804 int *pcylinders
, int *pheads
, int *psectors
)
807 int ret
, i
, heads
, sectors
, cylinders
;
812 bdrv_get_geometry(bs
, &nb_sectors
);
814 ret
= bdrv_read(bs
, 0, buf
, 1);
817 /* test msdos magic */
818 if (buf
[510] != 0x55 || buf
[511] != 0xaa)
820 for(i
= 0; i
< 4; i
++) {
821 p
= ((struct partition
*)(buf
+ 0x1be)) + i
;
822 nr_sects
= le32_to_cpu(p
->nr_sects
);
823 if (nr_sects
&& p
->end_head
) {
824 /* We make the assumption that the partition terminates on
825 a cylinder boundary */
826 heads
= p
->end_head
+ 1;
827 sectors
= p
->end_sector
& 63;
830 cylinders
= nb_sectors
/ (heads
* sectors
);
831 if (cylinders
< 1 || cylinders
> 16383)
835 *pcylinders
= cylinders
;
837 printf("guessed geometry: LCHS=%d %d %d\n",
838 cylinders
, heads
, sectors
);
846 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
848 int translation
, lba_detected
= 0;
849 int cylinders
, heads
, secs
;
852 /* if a geometry hint is available, use it */
853 bdrv_get_geometry(bs
, &nb_sectors
);
854 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
855 translation
= bdrv_get_translation_hint(bs
);
856 if (cylinders
!= 0) {
861 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
863 /* if heads > 16, it means that a BIOS LBA
864 translation was active, so the default
865 hardware geometry is OK */
867 goto default_geometry
;
872 /* disable any translation to be in sync with
873 the logical geometry */
874 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
875 bdrv_set_translation_hint(bs
,
876 BIOS_ATA_TRANSLATION_NONE
);
881 /* if no geometry, use a standard physical disk geometry */
882 cylinders
= nb_sectors
/ (16 * 63);
884 if (cylinders
> 16383)
886 else if (cylinders
< 2)
891 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
892 if ((*pcyls
* *pheads
) <= 131072) {
893 bdrv_set_translation_hint(bs
,
894 BIOS_ATA_TRANSLATION_LARGE
);
896 bdrv_set_translation_hint(bs
,
897 BIOS_ATA_TRANSLATION_LBA
);
901 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
905 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
906 int cyls
, int heads
, int secs
)
913 void bdrv_set_type_hint(BlockDriverState
*bs
, int type
)
916 bs
->removable
= ((type
== BDRV_TYPE_CDROM
||
917 type
== BDRV_TYPE_FLOPPY
));
920 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
922 bs
->translation
= translation
;
925 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
926 int *pcyls
, int *pheads
, int *psecs
)
933 int bdrv_get_type_hint(BlockDriverState
*bs
)
938 int bdrv_get_translation_hint(BlockDriverState
*bs
)
940 return bs
->translation
;
943 int bdrv_is_removable(BlockDriverState
*bs
)
945 return bs
->removable
;
948 int bdrv_is_read_only(BlockDriverState
*bs
)
950 return bs
->read_only
;
953 int bdrv_is_sg(BlockDriverState
*bs
)
958 /* XXX: no longer used */
959 void bdrv_set_change_cb(BlockDriverState
*bs
,
960 void (*change_cb
)(void *opaque
), void *opaque
)
962 bs
->change_cb
= change_cb
;
963 bs
->change_opaque
= opaque
;
966 int bdrv_is_encrypted(BlockDriverState
*bs
)
968 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
970 return bs
->encrypted
;
973 int bdrv_key_required(BlockDriverState
*bs
)
975 BlockDriverState
*backing_hd
= bs
->backing_hd
;
977 if (backing_hd
&& backing_hd
->encrypted
&& !backing_hd
->valid_key
)
979 return (bs
->encrypted
&& !bs
->valid_key
);
982 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
985 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
986 ret
= bdrv_set_key(bs
->backing_hd
, key
);
992 if (!bs
->encrypted
|| !bs
->drv
|| !bs
->drv
->bdrv_set_key
)
994 ret
= bs
->drv
->bdrv_set_key(bs
, key
);
997 } else if (!bs
->valid_key
) {
999 /* call the change callback now, we skipped it on open */
1000 bs
->media_changed
= 1;
1002 bs
->change_cb(bs
->change_opaque
);
1007 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
1012 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
1016 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
1021 for (drv
= first_drv
; drv
!= NULL
; drv
= drv
->next
) {
1022 it(opaque
, drv
->format_name
);
1026 BlockDriverState
*bdrv_find(const char *name
)
1028 BlockDriverState
*bs
;
1030 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1031 if (!strcmp(name
, bs
->device_name
))
1037 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
), void *opaque
)
1039 BlockDriverState
*bs
;
1041 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1046 const char *bdrv_get_device_name(BlockDriverState
*bs
)
1048 return bs
->device_name
;
1051 void bdrv_flush(BlockDriverState
*bs
)
1053 if (bs
->drv
->bdrv_flush
)
1054 bs
->drv
->bdrv_flush(bs
);
1056 bdrv_flush(bs
->backing_hd
);
1059 void bdrv_flush_all(void)
1061 BlockDriverState
*bs
;
1063 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
)
1064 if (bs
->drv
&& !bdrv_is_read_only(bs
) &&
1065 (!bdrv_is_removable(bs
) || bdrv_is_inserted(bs
)))
1070 * Returns true iff the specified sector is present in the disk image. Drivers
1071 * not implementing the functionality are assumed to not support backing files,
1072 * hence all their sectors are reported as allocated.
1074 * 'pnum' is set to the number of sectors (including and immediately following
1075 * the specified sector) that are known to be in the same
1076 * allocated/unallocated state.
1078 * 'nb_sectors' is the max value 'pnum' should be set to.
1080 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
1084 if (!bs
->drv
->bdrv_is_allocated
) {
1085 if (sector_num
>= bs
->total_sectors
) {
1089 n
= bs
->total_sectors
- sector_num
;
1090 *pnum
= (n
< nb_sectors
) ? (n
) : (nb_sectors
);
1093 return bs
->drv
->bdrv_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
1096 void bdrv_info(Monitor
*mon
)
1098 BlockDriverState
*bs
;
1100 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1101 monitor_printf(mon
, "%s:", bs
->device_name
);
1102 monitor_printf(mon
, " type=");
1105 monitor_printf(mon
, "hd");
1107 case BDRV_TYPE_CDROM
:
1108 monitor_printf(mon
, "cdrom");
1110 case BDRV_TYPE_FLOPPY
:
1111 monitor_printf(mon
, "floppy");
1114 monitor_printf(mon
, " removable=%d", bs
->removable
);
1115 if (bs
->removable
) {
1116 monitor_printf(mon
, " locked=%d", bs
->locked
);
1119 monitor_printf(mon
, " file=");
1120 monitor_print_filename(mon
, bs
->filename
);
1121 if (bs
->backing_file
[0] != '\0') {
1122 monitor_printf(mon
, " backing_file=");
1123 monitor_print_filename(mon
, bs
->backing_file
);
1125 monitor_printf(mon
, " ro=%d", bs
->read_only
);
1126 monitor_printf(mon
, " drv=%s", bs
->drv
->format_name
);
1127 monitor_printf(mon
, " encrypted=%d", bdrv_is_encrypted(bs
));
1129 monitor_printf(mon
, " [not inserted]");
1131 monitor_printf(mon
, "\n");
1135 /* The "info blockstats" command. */
1136 void bdrv_info_stats(Monitor
*mon
)
1138 BlockDriverState
*bs
;
1139 BlockDriverInfo bdi
;
1141 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1142 monitor_printf(mon
, "%s:"
1143 " rd_bytes=%" PRIu64
1144 " wr_bytes=%" PRIu64
1145 " rd_operations=%" PRIu64
1146 " wr_operations=%" PRIu64
1149 bs
->rd_bytes
, bs
->wr_bytes
,
1150 bs
->rd_ops
, bs
->wr_ops
);
1151 if (bdrv_get_info(bs
, &bdi
) == 0)
1152 monitor_printf(mon
, " high=%" PRId64
1153 " bytes_free=%" PRId64
,
1154 bdi
.highest_alloc
, bdi
.num_free_bytes
);
1155 monitor_printf(mon
, "\n");
1159 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
)
1161 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
1162 return bs
->backing_file
;
1163 else if (bs
->encrypted
)
1164 return bs
->filename
;
1169 void bdrv_get_backing_filename(BlockDriverState
*bs
,
1170 char *filename
, int filename_size
)
1172 if (!bs
->backing_hd
) {
1173 pstrcpy(filename
, filename_size
, "");
1175 pstrcpy(filename
, filename_size
, bs
->backing_file
);
1179 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1180 const uint8_t *buf
, int nb_sectors
)
1182 BlockDriver
*drv
= bs
->drv
;
1185 if (!drv
->bdrv_write_compressed
)
1187 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
1190 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1192 BlockDriver
*drv
= bs
->drv
;
1195 if (!drv
->bdrv_get_info
)
1197 memset(bdi
, 0, sizeof(*bdi
));
1198 return drv
->bdrv_get_info(bs
, bdi
);
1201 /**************************************************************/
1202 /* handling of snapshots */
1204 int bdrv_snapshot_create(BlockDriverState
*bs
,
1205 QEMUSnapshotInfo
*sn_info
)
1207 BlockDriver
*drv
= bs
->drv
;
1210 if (!drv
->bdrv_snapshot_create
)
1212 return drv
->bdrv_snapshot_create(bs
, sn_info
);
1215 int bdrv_snapshot_goto(BlockDriverState
*bs
,
1216 const char *snapshot_id
)
1218 BlockDriver
*drv
= bs
->drv
;
1221 if (!drv
->bdrv_snapshot_goto
)
1223 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
1226 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
1228 BlockDriver
*drv
= bs
->drv
;
1231 if (!drv
->bdrv_snapshot_delete
)
1233 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
1236 int bdrv_snapshot_list(BlockDriverState
*bs
,
1237 QEMUSnapshotInfo
**psn_info
)
1239 BlockDriver
*drv
= bs
->drv
;
1242 if (!drv
->bdrv_snapshot_list
)
1244 return drv
->bdrv_snapshot_list(bs
, psn_info
);
1247 #define NB_SUFFIXES 4
1249 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
1251 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
1256 snprintf(buf
, buf_size
, "%" PRId64
, size
);
1259 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
1260 if (size
< (10 * base
)) {
1261 snprintf(buf
, buf_size
, "%0.1f%c",
1262 (double)size
/ base
,
1265 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
1266 snprintf(buf
, buf_size
, "%" PRId64
"%c",
1267 ((size
+ (base
>> 1)) / base
),
1277 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
1279 char buf1
[128], date_buf
[128], clock_buf
[128];
1289 snprintf(buf
, buf_size
,
1290 "%-10s%-20s%7s%20s%15s",
1291 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1295 ptm
= localtime(&ti
);
1296 strftime(date_buf
, sizeof(date_buf
),
1297 "%Y-%m-%d %H:%M:%S", ptm
);
1299 localtime_r(&ti
, &tm
);
1300 strftime(date_buf
, sizeof(date_buf
),
1301 "%Y-%m-%d %H:%M:%S", &tm
);
1303 secs
= sn
->vm_clock_nsec
/ 1000000000;
1304 snprintf(clock_buf
, sizeof(clock_buf
),
1305 "%02d:%02d:%02d.%03d",
1307 (int)((secs
/ 60) % 60),
1309 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
1310 snprintf(buf
, buf_size
,
1311 "%-10s%-20s%7s%20s%15s",
1312 sn
->id_str
, sn
->name
,
1313 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
1321 /**************************************************************/
1324 typedef struct VectorTranslationState
{
1328 BlockDriverAIOCB
*aiocb
;
1329 BlockDriverAIOCB
*this_aiocb
;
1330 } VectorTranslationState
;
1332 static void bdrv_aio_rw_vector_cb(void *opaque
, int ret
)
1334 VectorTranslationState
*s
= opaque
;
1337 qemu_iovec_from_buffer(s
->iov
, s
->bounce
, s
->iov
->size
);
1339 qemu_vfree(s
->bounce
);
1340 s
->this_aiocb
->cb(s
->this_aiocb
->opaque
, ret
);
1341 qemu_aio_release(s
->this_aiocb
);
1344 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
1348 BlockDriverCompletionFunc
*cb
,
1353 VectorTranslationState
*s
= qemu_mallocz(sizeof(*s
));
1354 BlockDriverAIOCB
*aiocb
= qemu_aio_get(bs
, cb
, opaque
);
1356 s
->this_aiocb
= aiocb
;
1358 s
->bounce
= qemu_memalign(512, nb_sectors
* 512);
1359 s
->is_write
= is_write
;
1361 qemu_iovec_to_buffer(s
->iov
, s
->bounce
);
1362 s
->aiocb
= bdrv_aio_write(bs
, sector_num
, s
->bounce
, nb_sectors
,
1363 bdrv_aio_rw_vector_cb
, s
);
1365 s
->aiocb
= bdrv_aio_read(bs
, sector_num
, s
->bounce
, nb_sectors
,
1366 bdrv_aio_rw_vector_cb
, s
);
1371 BlockDriverAIOCB
*bdrv_aio_readv(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_writev(BlockDriverState
*bs
, int64_t sector_num
,
1383 QEMUIOVector
*iov
, int nb_sectors
,
1384 BlockDriverCompletionFunc
*cb
, void *opaque
)
1386 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1389 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1393 BlockDriverAIOCB
*bdrv_aio_read(BlockDriverState
*bs
, int64_t sector_num
,
1394 uint8_t *buf
, int nb_sectors
,
1395 BlockDriverCompletionFunc
*cb
, void *opaque
)
1397 BlockDriver
*drv
= bs
->drv
;
1398 BlockDriverAIOCB
*ret
;
1402 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1405 ret
= drv
->bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1408 /* Update stats even though technically transfer has not happened. */
1409 bs
->rd_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1416 BlockDriverAIOCB
*bdrv_aio_write(BlockDriverState
*bs
, int64_t sector_num
,
1417 const uint8_t *buf
, int nb_sectors
,
1418 BlockDriverCompletionFunc
*cb
, void *opaque
)
1420 BlockDriver
*drv
= bs
->drv
;
1421 BlockDriverAIOCB
*ret
;
1427 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1430 ret
= drv
->bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1433 /* Update stats even though technically transfer has not happened. */
1434 bs
->wr_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1441 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
1443 BlockDriver
*drv
= acb
->bs
->drv
;
1445 if (acb
->cb
== bdrv_aio_rw_vector_cb
) {
1446 VectorTranslationState
*s
= acb
->opaque
;
1450 drv
->bdrv_aio_cancel(acb
);
1454 /**************************************************************/
1455 /* async block device emulation */
1457 static void bdrv_aio_bh_cb(void *opaque
)
1459 BlockDriverAIOCBSync
*acb
= opaque
;
1460 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
1461 qemu_aio_release(acb
);
1464 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
1465 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1466 BlockDriverCompletionFunc
*cb
, void *opaque
)
1468 BlockDriverAIOCBSync
*acb
;
1471 acb
= qemu_aio_get(bs
, cb
, opaque
);
1473 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1474 ret
= bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
1476 qemu_bh_schedule(acb
->bh
);
1477 return &acb
->common
;
1480 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
1481 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
1482 BlockDriverCompletionFunc
*cb
, void *opaque
)
1484 BlockDriverAIOCBSync
*acb
;
1487 acb
= qemu_aio_get(bs
, cb
, opaque
);
1489 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1490 ret
= bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
1492 qemu_bh_schedule(acb
->bh
);
1493 return &acb
->common
;
1496 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
1498 BlockDriverAIOCBSync
*acb
= (BlockDriverAIOCBSync
*)blockacb
;
1499 qemu_bh_cancel(acb
->bh
);
1500 qemu_aio_release(acb
);
1503 /**************************************************************/
1504 /* sync block device emulation */
1506 static void bdrv_rw_em_cb(void *opaque
, int ret
)
1508 *(int *)opaque
= ret
;
1511 #define NOT_DONE 0x7fffffff
1513 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
1514 uint8_t *buf
, int nb_sectors
)
1517 BlockDriverAIOCB
*acb
;
1519 async_ret
= NOT_DONE
;
1520 acb
= bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
,
1521 bdrv_rw_em_cb
, &async_ret
);
1525 while (async_ret
== NOT_DONE
) {
1532 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
1533 const uint8_t *buf
, int nb_sectors
)
1536 BlockDriverAIOCB
*acb
;
1538 async_ret
= NOT_DONE
;
1539 acb
= bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
,
1540 bdrv_rw_em_cb
, &async_ret
);
1543 while (async_ret
== NOT_DONE
) {
1549 void bdrv_init(void)
1551 bdrv_register(&bdrv_raw
);
1552 bdrv_register(&bdrv_host_device
);
1554 bdrv_register(&bdrv_cow
);
1556 bdrv_register(&bdrv_qcow
);
1557 bdrv_register(&bdrv_vmdk
);
1558 bdrv_register(&bdrv_cloop
);
1559 bdrv_register(&bdrv_dmg
);
1560 bdrv_register(&bdrv_bochs
);
1561 bdrv_register(&bdrv_vpc
);
1562 bdrv_register(&bdrv_vvfat
);
1563 bdrv_register(&bdrv_qcow2
);
1564 bdrv_register(&bdrv_parallels
);
1565 bdrv_register(&bdrv_nbd
);
1568 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
1572 BlockDriverAIOCB
*acb
;
1575 if (drv
->free_aiocb
) {
1576 acb
= drv
->free_aiocb
;
1577 drv
->free_aiocb
= acb
->next
;
1579 acb
= qemu_mallocz(drv
->aiocb_size
);
1583 acb
->opaque
= opaque
;
1587 void qemu_aio_release(void *p
)
1589 BlockDriverAIOCB
*acb
= p
;
1590 BlockDriver
*drv
= acb
->bs
->drv
;
1591 acb
->next
= drv
->free_aiocb
;
1592 drv
->free_aiocb
= acb
;
1595 /**************************************************************/
1596 /* removable device support */
1599 * Return TRUE if the media is present
1601 int bdrv_is_inserted(BlockDriverState
*bs
)
1603 BlockDriver
*drv
= bs
->drv
;
1607 if (!drv
->bdrv_is_inserted
)
1609 ret
= drv
->bdrv_is_inserted(bs
);
1614 * Return TRUE if the media changed since the last call to this
1615 * function. It is currently only used for floppy disks
1617 int bdrv_media_changed(BlockDriverState
*bs
)
1619 BlockDriver
*drv
= bs
->drv
;
1622 if (!drv
|| !drv
->bdrv_media_changed
)
1625 ret
= drv
->bdrv_media_changed(bs
);
1626 if (ret
== -ENOTSUP
)
1627 ret
= bs
->media_changed
;
1628 bs
->media_changed
= 0;
1633 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1635 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
)
1637 BlockDriver
*drv
= bs
->drv
;
1640 if (!drv
|| !drv
->bdrv_eject
) {
1643 ret
= drv
->bdrv_eject(bs
, eject_flag
);
1645 if (ret
== -ENOTSUP
) {
1651 int bdrv_is_locked(BlockDriverState
*bs
)
1657 * Lock or unlock the media (if it is locked, the user won't be able
1658 * to eject it manually).
1660 void bdrv_set_locked(BlockDriverState
*bs
, int locked
)
1662 BlockDriver
*drv
= bs
->drv
;
1664 bs
->locked
= locked
;
1665 if (drv
&& drv
->bdrv_set_locked
) {
1666 drv
->bdrv_set_locked(bs
, locked
);
1670 /* needed for generic scsi interface */
1672 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
1674 BlockDriver
*drv
= bs
->drv
;
1676 if (drv
&& drv
->bdrv_ioctl
)
1677 return drv
->bdrv_ioctl(bs
, req
, buf
);