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 /* vector translation state */
58 } BlockDriverAIOCBSync
;
60 static BlockDriverAIOCB
*bdrv_aio_readv_em(BlockDriverState
*bs
,
61 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
62 BlockDriverCompletionFunc
*cb
, void *opaque
);
63 static BlockDriverAIOCB
*bdrv_aio_writev_em(BlockDriverState
*bs
,
64 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
65 BlockDriverCompletionFunc
*cb
, void *opaque
);
66 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*acb
);
67 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
68 uint8_t *buf
, int nb_sectors
);
69 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
70 const uint8_t *buf
, int nb_sectors
);
72 BlockDriverState
*bdrv_first
;
74 static BlockDriver
*first_drv
;
76 int path_is_absolute(const char *path
)
80 /* specific case for names like: "\\.\d:" */
81 if (*path
== '/' || *path
== '\\')
84 p
= strchr(path
, ':');
90 return (*p
== '/' || *p
== '\\');
96 /* if filename is absolute, just copy it to dest. Otherwise, build a
97 path to it by considering it is relative to base_path. URL are
99 void path_combine(char *dest
, int dest_size
,
100 const char *base_path
,
101 const char *filename
)
108 if (path_is_absolute(filename
)) {
109 pstrcpy(dest
, dest_size
, filename
);
111 p
= strchr(base_path
, ':');
116 p1
= strrchr(base_path
, '/');
120 p2
= strrchr(base_path
, '\\');
132 if (len
> dest_size
- 1)
134 memcpy(dest
, base_path
, len
);
136 pstrcat(dest
, dest_size
, filename
);
141 static void bdrv_register(BlockDriver
*bdrv
)
143 if (!bdrv
->bdrv_aio_readv
) {
144 /* add AIO emulation layer */
145 bdrv
->bdrv_aio_readv
= bdrv_aio_readv_em
;
146 bdrv
->bdrv_aio_writev
= bdrv_aio_writev_em
;
147 bdrv
->bdrv_aio_cancel
= bdrv_aio_cancel_em
;
148 bdrv
->aiocb_size
= sizeof(BlockDriverAIOCBSync
);
149 } else if (!bdrv
->bdrv_read
) {
150 /* add synchronous IO emulation layer */
151 bdrv
->bdrv_read
= bdrv_read_em
;
152 bdrv
->bdrv_write
= bdrv_write_em
;
154 aio_pool_init(&bdrv
->aio_pool
, bdrv
->aiocb_size
, bdrv
->bdrv_aio_cancel
);
155 bdrv
->next
= first_drv
;
159 /* create a new block device (by default it is empty) */
160 BlockDriverState
*bdrv_new(const char *device_name
)
162 BlockDriverState
**pbs
, *bs
;
164 bs
= qemu_mallocz(sizeof(BlockDriverState
));
165 pstrcpy(bs
->device_name
, sizeof(bs
->device_name
), device_name
);
166 if (device_name
[0] != '\0') {
167 /* insert at the end */
176 BlockDriver
*bdrv_find_format(const char *format_name
)
179 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
180 if (!strcmp(drv1
->format_name
, format_name
))
186 int bdrv_create2(BlockDriver
*drv
,
187 const char *filename
, int64_t size_in_sectors
,
188 const char *backing_file
, const char *backing_format
,
191 if (drv
->bdrv_create2
)
192 return drv
->bdrv_create2(filename
, size_in_sectors
, backing_file
,
193 backing_format
, flags
);
194 if (drv
->bdrv_create
)
195 return drv
->bdrv_create(filename
, size_in_sectors
, backing_file
,
200 int bdrv_create(BlockDriver
*drv
,
201 const char *filename
, int64_t size_in_sectors
,
202 const char *backing_file
, int flags
)
204 if (!drv
->bdrv_create
)
206 return drv
->bdrv_create(filename
, size_in_sectors
, backing_file
, flags
);
210 void get_tmp_filename(char *filename
, int size
)
212 char temp_dir
[MAX_PATH
];
214 GetTempPath(MAX_PATH
, temp_dir
);
215 GetTempFileName(temp_dir
, "qem", 0, filename
);
218 void get_tmp_filename(char *filename
, int size
)
222 /* XXX: race condition possible */
223 tmpdir
= getenv("TMPDIR");
226 snprintf(filename
, size
, "%s/vl.XXXXXX", tmpdir
);
227 fd
= mkstemp(filename
);
233 static int is_windows_drive_prefix(const char *filename
)
235 return (((filename
[0] >= 'a' && filename
[0] <= 'z') ||
236 (filename
[0] >= 'A' && filename
[0] <= 'Z')) &&
240 static int is_windows_drive(const char *filename
)
242 if (is_windows_drive_prefix(filename
) &&
245 if (strstart(filename
, "\\\\.\\", NULL
) ||
246 strstart(filename
, "//./", NULL
))
252 static BlockDriver
*find_protocol(const char *filename
)
260 if (is_windows_drive(filename
) ||
261 is_windows_drive_prefix(filename
))
264 p
= strchr(filename
, ':');
268 if (len
> sizeof(protocol
) - 1)
269 len
= sizeof(protocol
) - 1;
270 memcpy(protocol
, filename
, len
);
271 protocol
[len
] = '\0';
272 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
273 if (drv1
->protocol_name
&&
274 !strcmp(drv1
->protocol_name
, protocol
))
280 /* XXX: force raw format if block or character device ? It would
281 simplify the BSD case */
282 static BlockDriver
*find_image_format(const char *filename
)
284 int ret
, score
, score_max
;
285 BlockDriver
*drv1
, *drv
;
287 BlockDriverState
*bs
;
289 /* detect host devices. By convention, /dev/cdrom[N] is always
290 recognized as a host CDROM */
291 if (strstart(filename
, "/dev/cdrom", NULL
))
292 return &bdrv_host_device
;
294 if (is_windows_drive(filename
))
295 return &bdrv_host_device
;
299 if (stat(filename
, &st
) >= 0 &&
300 (S_ISCHR(st
.st_mode
) || S_ISBLK(st
.st_mode
))) {
301 return &bdrv_host_device
;
306 drv
= find_protocol(filename
);
307 /* no need to test disk image formats for vvfat */
308 if (drv
== &bdrv_vvfat
)
311 ret
= bdrv_file_open(&bs
, filename
, BDRV_O_RDONLY
);
314 ret
= bdrv_pread(bs
, 0, buf
, sizeof(buf
));
321 for(drv1
= first_drv
; drv1
!= NULL
; drv1
= drv1
->next
) {
322 if (drv1
->bdrv_probe
) {
323 score
= drv1
->bdrv_probe(buf
, ret
, filename
);
324 if (score
> score_max
) {
333 int bdrv_file_open(BlockDriverState
**pbs
, const char *filename
, int flags
)
335 BlockDriverState
*bs
;
339 ret
= bdrv_open2(bs
, filename
, flags
| BDRV_O_FILE
, NULL
);
349 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
)
351 return bdrv_open2(bs
, filename
, flags
, NULL
);
354 int bdrv_open2(BlockDriverState
*bs
, const char *filename
, int flags
,
358 char tmp_filename
[PATH_MAX
];
359 char backing_filename
[PATH_MAX
];
362 bs
->is_temporary
= 0;
365 /* buffer_alignment defaulted to 512, drivers can change this value */
366 bs
->buffer_alignment
= 512;
368 if (flags
& BDRV_O_SNAPSHOT
) {
369 BlockDriverState
*bs1
;
373 /* if snapshot, we create a temporary backing file and open it
374 instead of opening 'filename' directly */
376 /* if there is a backing file, use it */
378 ret
= bdrv_open2(bs1
, filename
, 0, drv
);
383 total_size
= bdrv_getlength(bs1
) >> SECTOR_BITS
;
385 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
390 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
392 /* Real path is meaningless for protocols */
394 snprintf(backing_filename
, sizeof(backing_filename
),
397 realpath(filename
, backing_filename
);
399 ret
= bdrv_create2(&bdrv_qcow2
, tmp_filename
,
400 total_size
, backing_filename
,
401 (drv
? drv
->format_name
: NULL
), 0);
405 filename
= tmp_filename
;
407 bs
->is_temporary
= 1;
410 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
411 if (flags
& BDRV_O_FILE
) {
412 drv
= find_protocol(filename
);
414 drv
= find_image_format(filename
);
418 goto unlink_and_fail
;
421 bs
->opaque
= qemu_mallocz(drv
->instance_size
);
422 /* Note: for compatibility, we open disk image files as RDWR, and
423 RDONLY as fallback */
424 if (!(flags
& BDRV_O_FILE
))
425 open_flags
= BDRV_O_RDWR
| (flags
& BDRV_O_CACHE_MASK
);
427 open_flags
= flags
& ~(BDRV_O_FILE
| BDRV_O_SNAPSHOT
);
428 ret
= drv
->bdrv_open(bs
, filename
, open_flags
);
429 if ((ret
== -EACCES
|| ret
== -EPERM
) && !(flags
& BDRV_O_FILE
)) {
430 ret
= drv
->bdrv_open(bs
, filename
, open_flags
& ~BDRV_O_RDWR
);
434 qemu_free(bs
->opaque
);
438 if (bs
->is_temporary
)
442 if (drv
->bdrv_getlength
) {
443 bs
->total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
446 if (bs
->is_temporary
) {
450 if (bs
->backing_file
[0] != '\0') {
451 /* if there is a backing file, use it */
452 BlockDriver
*back_drv
= NULL
;
453 bs
->backing_hd
= bdrv_new("");
454 path_combine(backing_filename
, sizeof(backing_filename
),
455 filename
, bs
->backing_file
);
456 if (bs
->backing_format
[0] != '\0')
457 back_drv
= bdrv_find_format(bs
->backing_format
);
458 ret
= bdrv_open2(bs
->backing_hd
, backing_filename
, open_flags
,
466 if (!bdrv_key_required(bs
)) {
467 /* call the change callback */
468 bs
->media_changed
= 1;
470 bs
->change_cb(bs
->change_opaque
);
475 void bdrv_close(BlockDriverState
*bs
)
479 bdrv_delete(bs
->backing_hd
);
480 bs
->drv
->bdrv_close(bs
);
481 qemu_free(bs
->opaque
);
483 if (bs
->is_temporary
) {
484 unlink(bs
->filename
);
490 /* call the change callback */
491 bs
->media_changed
= 1;
493 bs
->change_cb(bs
->change_opaque
);
497 void bdrv_delete(BlockDriverState
*bs
)
499 BlockDriverState
**pbs
;
502 while (*pbs
!= bs
&& *pbs
!= NULL
)
512 * Run consistency checks on an image
514 * Returns the number of errors or -errno when an internal error occurs
516 int bdrv_check(BlockDriverState
*bs
)
518 if (bs
->drv
->bdrv_check
== NULL
) {
522 return bs
->drv
->bdrv_check(bs
);
525 /* commit COW file into the raw image */
526 int bdrv_commit(BlockDriverState
*bs
)
528 BlockDriver
*drv
= bs
->drv
;
529 int64_t i
, total_sectors
;
531 unsigned char sector
[512];
540 if (!bs
->backing_hd
) {
544 total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
545 for (i
= 0; i
< total_sectors
;) {
546 if (drv
->bdrv_is_allocated(bs
, i
, 65536, &n
)) {
547 for(j
= 0; j
< n
; j
++) {
548 if (bdrv_read(bs
, i
, sector
, 1) != 0) {
552 if (bdrv_write(bs
->backing_hd
, i
, sector
, 1) != 0) {
562 if (drv
->bdrv_make_empty
)
563 return drv
->bdrv_make_empty(bs
);
568 static int bdrv_check_byte_request(BlockDriverState
*bs
, int64_t offset
,
573 if (!bdrv_is_inserted(bs
))
579 len
= bdrv_getlength(bs
);
584 if ((offset
> len
) || (len
- offset
< size
))
590 static int bdrv_check_request(BlockDriverState
*bs
, int64_t sector_num
,
593 return bdrv_check_byte_request(bs
, sector_num
* 512, nb_sectors
* 512);
596 /* return < 0 if error. See bdrv_write() for the return codes */
597 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
598 uint8_t *buf
, int nb_sectors
)
600 BlockDriver
*drv
= bs
->drv
;
604 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
607 return drv
->bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
610 /* Return < 0 if error. Important errors are:
611 -EIO generic I/O error (may happen for all errors)
612 -ENOMEDIUM No media inserted.
613 -EINVAL Invalid sector number or nb_sectors
614 -EACCES Trying to write a read-only device
616 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
617 const uint8_t *buf
, int nb_sectors
)
619 BlockDriver
*drv
= bs
->drv
;
624 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
627 return drv
->bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
630 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
631 void *buf
, int count1
)
633 uint8_t tmp_buf
[SECTOR_SIZE
];
634 int len
, nb_sectors
, count
;
638 /* first read to align to sector start */
639 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
642 sector_num
= offset
>> SECTOR_BITS
;
644 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
646 memcpy(buf
, tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), len
);
654 /* read the sectors "in place" */
655 nb_sectors
= count
>> SECTOR_BITS
;
656 if (nb_sectors
> 0) {
657 if (bdrv_read(bs
, sector_num
, buf
, nb_sectors
) < 0)
659 sector_num
+= nb_sectors
;
660 len
= nb_sectors
<< SECTOR_BITS
;
665 /* add data from the last sector */
667 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
669 memcpy(buf
, tmp_buf
, count
);
674 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
675 const void *buf
, int count1
)
677 uint8_t tmp_buf
[SECTOR_SIZE
];
678 int len
, nb_sectors
, count
;
682 /* first write to align to sector start */
683 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
686 sector_num
= offset
>> SECTOR_BITS
;
688 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
690 memcpy(tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), buf
, len
);
691 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
700 /* write the sectors "in place" */
701 nb_sectors
= count
>> SECTOR_BITS
;
702 if (nb_sectors
> 0) {
703 if (bdrv_write(bs
, sector_num
, buf
, nb_sectors
) < 0)
705 sector_num
+= nb_sectors
;
706 len
= nb_sectors
<< SECTOR_BITS
;
711 /* add data from the last sector */
713 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
715 memcpy(tmp_buf
, buf
, count
);
716 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
723 * Truncate file to 'offset' bytes (needed only for file protocols)
725 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
727 BlockDriver
*drv
= bs
->drv
;
730 if (!drv
->bdrv_truncate
)
732 return drv
->bdrv_truncate(bs
, offset
);
736 * Length of a file in bytes. Return < 0 if error or unknown.
738 int64_t bdrv_getlength(BlockDriverState
*bs
)
740 BlockDriver
*drv
= bs
->drv
;
743 if (!drv
->bdrv_getlength
) {
745 return bs
->total_sectors
* SECTOR_SIZE
;
747 return drv
->bdrv_getlength(bs
);
750 /* return 0 as number of sectors if no device present or error */
751 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
754 length
= bdrv_getlength(bs
);
758 length
= length
>> SECTOR_BITS
;
759 *nb_sectors_ptr
= length
;
763 uint8_t boot_ind
; /* 0x80 - active */
764 uint8_t head
; /* starting head */
765 uint8_t sector
; /* starting sector */
766 uint8_t cyl
; /* starting cylinder */
767 uint8_t sys_ind
; /* What partition type */
768 uint8_t end_head
; /* end head */
769 uint8_t end_sector
; /* end sector */
770 uint8_t end_cyl
; /* end cylinder */
771 uint32_t start_sect
; /* starting sector counting from 0 */
772 uint32_t nr_sects
; /* nr of sectors in partition */
773 } __attribute__((packed
));
775 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
776 static int guess_disk_lchs(BlockDriverState
*bs
,
777 int *pcylinders
, int *pheads
, int *psectors
)
780 int ret
, i
, heads
, sectors
, cylinders
;
785 bdrv_get_geometry(bs
, &nb_sectors
);
787 ret
= bdrv_read(bs
, 0, buf
, 1);
790 /* test msdos magic */
791 if (buf
[510] != 0x55 || buf
[511] != 0xaa)
793 for(i
= 0; i
< 4; i
++) {
794 p
= ((struct partition
*)(buf
+ 0x1be)) + i
;
795 nr_sects
= le32_to_cpu(p
->nr_sects
);
796 if (nr_sects
&& p
->end_head
) {
797 /* We make the assumption that the partition terminates on
798 a cylinder boundary */
799 heads
= p
->end_head
+ 1;
800 sectors
= p
->end_sector
& 63;
803 cylinders
= nb_sectors
/ (heads
* sectors
);
804 if (cylinders
< 1 || cylinders
> 16383)
808 *pcylinders
= cylinders
;
810 printf("guessed geometry: LCHS=%d %d %d\n",
811 cylinders
, heads
, sectors
);
819 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
821 int translation
, lba_detected
= 0;
822 int cylinders
, heads
, secs
;
825 /* if a geometry hint is available, use it */
826 bdrv_get_geometry(bs
, &nb_sectors
);
827 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
828 translation
= bdrv_get_translation_hint(bs
);
829 if (cylinders
!= 0) {
834 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
836 /* if heads > 16, it means that a BIOS LBA
837 translation was active, so the default
838 hardware geometry is OK */
840 goto default_geometry
;
845 /* disable any translation to be in sync with
846 the logical geometry */
847 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
848 bdrv_set_translation_hint(bs
,
849 BIOS_ATA_TRANSLATION_NONE
);
854 /* if no geometry, use a standard physical disk geometry */
855 cylinders
= nb_sectors
/ (16 * 63);
857 if (cylinders
> 16383)
859 else if (cylinders
< 2)
864 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
865 if ((*pcyls
* *pheads
) <= 131072) {
866 bdrv_set_translation_hint(bs
,
867 BIOS_ATA_TRANSLATION_LARGE
);
869 bdrv_set_translation_hint(bs
,
870 BIOS_ATA_TRANSLATION_LBA
);
874 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
878 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
879 int cyls
, int heads
, int secs
)
886 void bdrv_set_type_hint(BlockDriverState
*bs
, int type
)
889 bs
->removable
= ((type
== BDRV_TYPE_CDROM
||
890 type
== BDRV_TYPE_FLOPPY
));
893 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
895 bs
->translation
= translation
;
898 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
899 int *pcyls
, int *pheads
, int *psecs
)
906 int bdrv_get_type_hint(BlockDriverState
*bs
)
911 int bdrv_get_translation_hint(BlockDriverState
*bs
)
913 return bs
->translation
;
916 int bdrv_is_removable(BlockDriverState
*bs
)
918 return bs
->removable
;
921 int bdrv_is_read_only(BlockDriverState
*bs
)
923 return bs
->read_only
;
926 int bdrv_is_sg(BlockDriverState
*bs
)
931 /* XXX: no longer used */
932 void bdrv_set_change_cb(BlockDriverState
*bs
,
933 void (*change_cb
)(void *opaque
), void *opaque
)
935 bs
->change_cb
= change_cb
;
936 bs
->change_opaque
= opaque
;
939 int bdrv_is_encrypted(BlockDriverState
*bs
)
941 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
943 return bs
->encrypted
;
946 int bdrv_key_required(BlockDriverState
*bs
)
948 BlockDriverState
*backing_hd
= bs
->backing_hd
;
950 if (backing_hd
&& backing_hd
->encrypted
&& !backing_hd
->valid_key
)
952 return (bs
->encrypted
&& !bs
->valid_key
);
955 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
958 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
959 ret
= bdrv_set_key(bs
->backing_hd
, key
);
965 if (!bs
->encrypted
|| !bs
->drv
|| !bs
->drv
->bdrv_set_key
)
967 ret
= bs
->drv
->bdrv_set_key(bs
, key
);
970 } else if (!bs
->valid_key
) {
972 /* call the change callback now, we skipped it on open */
973 bs
->media_changed
= 1;
975 bs
->change_cb(bs
->change_opaque
);
980 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
985 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
989 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
994 for (drv
= first_drv
; drv
!= NULL
; drv
= drv
->next
) {
995 it(opaque
, drv
->format_name
);
999 BlockDriverState
*bdrv_find(const char *name
)
1001 BlockDriverState
*bs
;
1003 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1004 if (!strcmp(name
, bs
->device_name
))
1010 void bdrv_iterate(void (*it
)(void *opaque
, BlockDriverState
*bs
), void *opaque
)
1012 BlockDriverState
*bs
;
1014 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1019 const char *bdrv_get_device_name(BlockDriverState
*bs
)
1021 return bs
->device_name
;
1024 void bdrv_flush(BlockDriverState
*bs
)
1028 if (bs
->drv
->bdrv_flush
)
1029 bs
->drv
->bdrv_flush(bs
);
1031 bdrv_flush(bs
->backing_hd
);
1034 void bdrv_flush_all(void)
1036 BlockDriverState
*bs
;
1038 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
)
1039 if (bs
->drv
&& !bdrv_is_read_only(bs
) &&
1040 (!bdrv_is_removable(bs
) || bdrv_is_inserted(bs
)))
1045 * Returns true iff the specified sector is present in the disk image. Drivers
1046 * not implementing the functionality are assumed to not support backing files,
1047 * hence all their sectors are reported as allocated.
1049 * 'pnum' is set to the number of sectors (including and immediately following
1050 * the specified sector) that are known to be in the same
1051 * allocated/unallocated state.
1053 * 'nb_sectors' is the max value 'pnum' should be set to.
1055 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
1059 if (!bs
->drv
->bdrv_is_allocated
) {
1060 if (sector_num
>= bs
->total_sectors
) {
1064 n
= bs
->total_sectors
- sector_num
;
1065 *pnum
= (n
< nb_sectors
) ? (n
) : (nb_sectors
);
1068 return bs
->drv
->bdrv_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
1071 void bdrv_info(Monitor
*mon
)
1073 BlockDriverState
*bs
;
1075 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1076 monitor_printf(mon
, "%s:", bs
->device_name
);
1077 monitor_printf(mon
, " type=");
1080 monitor_printf(mon
, "hd");
1082 case BDRV_TYPE_CDROM
:
1083 monitor_printf(mon
, "cdrom");
1085 case BDRV_TYPE_FLOPPY
:
1086 monitor_printf(mon
, "floppy");
1089 monitor_printf(mon
, " removable=%d", bs
->removable
);
1090 if (bs
->removable
) {
1091 monitor_printf(mon
, " locked=%d", bs
->locked
);
1094 monitor_printf(mon
, " file=");
1095 monitor_print_filename(mon
, bs
->filename
);
1096 if (bs
->backing_file
[0] != '\0') {
1097 monitor_printf(mon
, " backing_file=");
1098 monitor_print_filename(mon
, bs
->backing_file
);
1100 monitor_printf(mon
, " ro=%d", bs
->read_only
);
1101 monitor_printf(mon
, " drv=%s", bs
->drv
->format_name
);
1102 monitor_printf(mon
, " encrypted=%d", bdrv_is_encrypted(bs
));
1104 monitor_printf(mon
, " [not inserted]");
1106 monitor_printf(mon
, "\n");
1110 /* The "info blockstats" command. */
1111 void bdrv_info_stats(Monitor
*mon
)
1113 BlockDriverState
*bs
;
1115 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1116 monitor_printf(mon
, "%s:"
1117 " rd_bytes=%" PRIu64
1118 " wr_bytes=%" PRIu64
1119 " rd_operations=%" PRIu64
1120 " wr_operations=%" PRIu64
1123 bs
->rd_bytes
, bs
->wr_bytes
,
1124 bs
->rd_ops
, bs
->wr_ops
);
1128 const char *bdrv_get_encrypted_filename(BlockDriverState
*bs
)
1130 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
1131 return bs
->backing_file
;
1132 else if (bs
->encrypted
)
1133 return bs
->filename
;
1138 void bdrv_get_backing_filename(BlockDriverState
*bs
,
1139 char *filename
, int filename_size
)
1141 if (!bs
->backing_hd
) {
1142 pstrcpy(filename
, filename_size
, "");
1144 pstrcpy(filename
, filename_size
, bs
->backing_file
);
1148 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1149 const uint8_t *buf
, int nb_sectors
)
1151 BlockDriver
*drv
= bs
->drv
;
1154 if (!drv
->bdrv_write_compressed
)
1156 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1158 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
1161 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1163 BlockDriver
*drv
= bs
->drv
;
1166 if (!drv
->bdrv_get_info
)
1168 memset(bdi
, 0, sizeof(*bdi
));
1169 return drv
->bdrv_get_info(bs
, bdi
);
1172 int bdrv_put_buffer(BlockDriverState
*bs
, const uint8_t *buf
, int64_t pos
, int size
)
1174 BlockDriver
*drv
= bs
->drv
;
1177 if (!drv
->bdrv_put_buffer
)
1179 return drv
->bdrv_put_buffer(bs
, buf
, pos
, size
);
1182 int bdrv_get_buffer(BlockDriverState
*bs
, uint8_t *buf
, int64_t pos
, int size
)
1184 BlockDriver
*drv
= bs
->drv
;
1187 if (!drv
->bdrv_get_buffer
)
1189 return drv
->bdrv_get_buffer(bs
, buf
, pos
, size
);
1192 /**************************************************************/
1193 /* handling of snapshots */
1195 int bdrv_snapshot_create(BlockDriverState
*bs
,
1196 QEMUSnapshotInfo
*sn_info
)
1198 BlockDriver
*drv
= bs
->drv
;
1201 if (!drv
->bdrv_snapshot_create
)
1203 return drv
->bdrv_snapshot_create(bs
, sn_info
);
1206 int bdrv_snapshot_goto(BlockDriverState
*bs
,
1207 const char *snapshot_id
)
1209 BlockDriver
*drv
= bs
->drv
;
1212 if (!drv
->bdrv_snapshot_goto
)
1214 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
1217 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
1219 BlockDriver
*drv
= bs
->drv
;
1222 if (!drv
->bdrv_snapshot_delete
)
1224 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
1227 int bdrv_snapshot_list(BlockDriverState
*bs
,
1228 QEMUSnapshotInfo
**psn_info
)
1230 BlockDriver
*drv
= bs
->drv
;
1233 if (!drv
->bdrv_snapshot_list
)
1235 return drv
->bdrv_snapshot_list(bs
, psn_info
);
1238 #define NB_SUFFIXES 4
1240 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
1242 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
1247 snprintf(buf
, buf_size
, "%" PRId64
, size
);
1250 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
1251 if (size
< (10 * base
)) {
1252 snprintf(buf
, buf_size
, "%0.1f%c",
1253 (double)size
/ base
,
1256 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
1257 snprintf(buf
, buf_size
, "%" PRId64
"%c",
1258 ((size
+ (base
>> 1)) / base
),
1268 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
1270 char buf1
[128], date_buf
[128], clock_buf
[128];
1280 snprintf(buf
, buf_size
,
1281 "%-10s%-20s%7s%20s%15s",
1282 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1286 ptm
= localtime(&ti
);
1287 strftime(date_buf
, sizeof(date_buf
),
1288 "%Y-%m-%d %H:%M:%S", ptm
);
1290 localtime_r(&ti
, &tm
);
1291 strftime(date_buf
, sizeof(date_buf
),
1292 "%Y-%m-%d %H:%M:%S", &tm
);
1294 secs
= sn
->vm_clock_nsec
/ 1000000000;
1295 snprintf(clock_buf
, sizeof(clock_buf
),
1296 "%02d:%02d:%02d.%03d",
1298 (int)((secs
/ 60) % 60),
1300 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
1301 snprintf(buf
, buf_size
,
1302 "%-10s%-20s%7s%20s%15s",
1303 sn
->id_str
, sn
->name
,
1304 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
1312 /**************************************************************/
1315 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
1316 QEMUIOVector
*qiov
, int nb_sectors
,
1317 BlockDriverCompletionFunc
*cb
, void *opaque
)
1319 BlockDriver
*drv
= bs
->drv
;
1320 BlockDriverAIOCB
*ret
;
1324 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1327 ret
= drv
->bdrv_aio_readv(bs
, sector_num
, qiov
, nb_sectors
,
1331 /* Update stats even though technically transfer has not happened. */
1332 bs
->rd_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1339 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
1340 QEMUIOVector
*qiov
, int nb_sectors
,
1341 BlockDriverCompletionFunc
*cb
, void *opaque
)
1343 BlockDriver
*drv
= bs
->drv
;
1344 BlockDriverAIOCB
*ret
;
1350 if (bdrv_check_request(bs
, sector_num
, nb_sectors
))
1353 ret
= drv
->bdrv_aio_writev(bs
, sector_num
, qiov
, nb_sectors
,
1357 /* Update stats even though technically transfer has not happened. */
1358 bs
->wr_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1365 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
1367 acb
->pool
->cancel(acb
);
1371 /**************************************************************/
1372 /* async block device emulation */
1374 static void bdrv_aio_bh_cb(void *opaque
)
1376 BlockDriverAIOCBSync
*acb
= opaque
;
1379 qemu_iovec_from_buffer(acb
->qiov
, acb
->bounce
, acb
->qiov
->size
);
1380 qemu_vfree(acb
->bounce
);
1381 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
1383 qemu_aio_release(acb
);
1386 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
1390 BlockDriverCompletionFunc
*cb
,
1395 BlockDriverAIOCBSync
*acb
;
1397 acb
= qemu_aio_get(bs
, cb
, opaque
);
1398 acb
->is_write
= is_write
;
1400 acb
->bounce
= qemu_blockalign(bs
, qiov
->size
);
1403 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1406 qemu_iovec_to_buffer(acb
->qiov
, acb
->bounce
);
1407 acb
->ret
= bdrv_write(bs
, sector_num
, acb
->bounce
, nb_sectors
);
1409 acb
->ret
= bdrv_read(bs
, sector_num
, acb
->bounce
, nb_sectors
);
1412 qemu_bh_schedule(acb
->bh
);
1414 return &acb
->common
;
1417 static BlockDriverAIOCB
*bdrv_aio_readv_em(BlockDriverState
*bs
,
1418 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
1419 BlockDriverCompletionFunc
*cb
, void *opaque
)
1421 return bdrv_aio_rw_vector(bs
, sector_num
, qiov
, nb_sectors
, cb
, opaque
, 0);
1424 static BlockDriverAIOCB
*bdrv_aio_writev_em(BlockDriverState
*bs
,
1425 int64_t sector_num
, QEMUIOVector
*qiov
, int nb_sectors
,
1426 BlockDriverCompletionFunc
*cb
, void *opaque
)
1428 return bdrv_aio_rw_vector(bs
, sector_num
, qiov
, nb_sectors
, cb
, opaque
, 1);
1432 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
1434 BlockDriverAIOCBSync
*acb
= (BlockDriverAIOCBSync
*)blockacb
;
1435 qemu_bh_cancel(acb
->bh
);
1436 qemu_aio_release(acb
);
1439 /**************************************************************/
1440 /* sync block device emulation */
1442 static void bdrv_rw_em_cb(void *opaque
, int ret
)
1444 *(int *)opaque
= ret
;
1447 #define NOT_DONE 0x7fffffff
1449 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
1450 uint8_t *buf
, int nb_sectors
)
1453 BlockDriverAIOCB
*acb
;
1457 async_ret
= NOT_DONE
;
1458 iov
.iov_base
= (void *)buf
;
1459 iov
.iov_len
= nb_sectors
* 512;
1460 qemu_iovec_init_external(&qiov
, &iov
, 1);
1461 acb
= bdrv_aio_readv(bs
, sector_num
, &qiov
, nb_sectors
,
1462 bdrv_rw_em_cb
, &async_ret
);
1466 while (async_ret
== NOT_DONE
) {
1473 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
1474 const uint8_t *buf
, int nb_sectors
)
1477 BlockDriverAIOCB
*acb
;
1481 async_ret
= NOT_DONE
;
1482 iov
.iov_base
= (void *)buf
;
1483 iov
.iov_len
= nb_sectors
* 512;
1484 qemu_iovec_init_external(&qiov
, &iov
, 1);
1485 acb
= bdrv_aio_writev(bs
, sector_num
, &qiov
, nb_sectors
,
1486 bdrv_rw_em_cb
, &async_ret
);
1489 while (async_ret
== NOT_DONE
) {
1495 void bdrv_init(void)
1497 bdrv_register(&bdrv_raw
);
1498 bdrv_register(&bdrv_host_device
);
1500 bdrv_register(&bdrv_cow
);
1502 bdrv_register(&bdrv_qcow
);
1503 bdrv_register(&bdrv_vmdk
);
1504 bdrv_register(&bdrv_cloop
);
1505 bdrv_register(&bdrv_dmg
);
1506 bdrv_register(&bdrv_bochs
);
1507 bdrv_register(&bdrv_vpc
);
1508 bdrv_register(&bdrv_vvfat
);
1509 bdrv_register(&bdrv_qcow2
);
1510 bdrv_register(&bdrv_parallels
);
1511 bdrv_register(&bdrv_nbd
);
1514 void aio_pool_init(AIOPool
*pool
, int aiocb_size
,
1515 void (*cancel
)(BlockDriverAIOCB
*acb
))
1517 pool
->aiocb_size
= aiocb_size
;
1518 pool
->cancel
= cancel
;
1519 pool
->free_aiocb
= NULL
;
1522 void *qemu_aio_get_pool(AIOPool
*pool
, BlockDriverState
*bs
,
1523 BlockDriverCompletionFunc
*cb
, void *opaque
)
1525 BlockDriverAIOCB
*acb
;
1527 if (pool
->free_aiocb
) {
1528 acb
= pool
->free_aiocb
;
1529 pool
->free_aiocb
= acb
->next
;
1531 acb
= qemu_mallocz(pool
->aiocb_size
);
1536 acb
->opaque
= opaque
;
1540 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
1543 return qemu_aio_get_pool(&bs
->drv
->aio_pool
, bs
, cb
, opaque
);
1546 void qemu_aio_release(void *p
)
1548 BlockDriverAIOCB
*acb
= (BlockDriverAIOCB
*)p
;
1549 AIOPool
*pool
= acb
->pool
;
1550 acb
->next
= pool
->free_aiocb
;
1551 pool
->free_aiocb
= acb
;
1554 /**************************************************************/
1555 /* removable device support */
1558 * Return TRUE if the media is present
1560 int bdrv_is_inserted(BlockDriverState
*bs
)
1562 BlockDriver
*drv
= bs
->drv
;
1566 if (!drv
->bdrv_is_inserted
)
1568 ret
= drv
->bdrv_is_inserted(bs
);
1573 * Return TRUE if the media changed since the last call to this
1574 * function. It is currently only used for floppy disks
1576 int bdrv_media_changed(BlockDriverState
*bs
)
1578 BlockDriver
*drv
= bs
->drv
;
1581 if (!drv
|| !drv
->bdrv_media_changed
)
1584 ret
= drv
->bdrv_media_changed(bs
);
1585 if (ret
== -ENOTSUP
)
1586 ret
= bs
->media_changed
;
1587 bs
->media_changed
= 0;
1592 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1594 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
)
1596 BlockDriver
*drv
= bs
->drv
;
1599 if (!drv
|| !drv
->bdrv_eject
) {
1602 ret
= drv
->bdrv_eject(bs
, eject_flag
);
1604 if (ret
== -ENOTSUP
) {
1610 int bdrv_is_locked(BlockDriverState
*bs
)
1616 * Lock or unlock the media (if it is locked, the user won't be able
1617 * to eject it manually).
1619 void bdrv_set_locked(BlockDriverState
*bs
, int locked
)
1621 BlockDriver
*drv
= bs
->drv
;
1623 bs
->locked
= locked
;
1624 if (drv
&& drv
->bdrv_set_locked
) {
1625 drv
->bdrv_set_locked(bs
, locked
);
1629 /* needed for generic scsi interface */
1631 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
1633 BlockDriver
*drv
= bs
->drv
;
1635 if (drv
&& drv
->bdrv_ioctl
)
1636 return drv
->bdrv_ioctl(bs
, req
, buf
);
1640 BlockDriverAIOCB
*bdrv_aio_ioctl(BlockDriverState
*bs
,
1641 unsigned long int req
, void *buf
,
1642 BlockDriverCompletionFunc
*cb
, void *opaque
)
1644 BlockDriver
*drv
= bs
->drv
;
1646 if (drv
&& drv
->bdrv_aio_ioctl
)
1647 return drv
->bdrv_aio_ioctl(bs
, req
, buf
, cb
, opaque
);
1651 void *qemu_blockalign(BlockDriverState
*bs
, size_t size
)
1653 return qemu_memalign((bs
&& bs
->buffer_alignment
) ? bs
->buffer_alignment
: 512, size
);