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
));
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
;
318 ret
= bdrv_open2(bs
, filename
, flags
| BDRV_O_FILE
, NULL
);
327 int bdrv_open(BlockDriverState
*bs
, const char *filename
, int flags
)
329 return bdrv_open2(bs
, filename
, flags
, NULL
);
332 int bdrv_open2(BlockDriverState
*bs
, const char *filename
, int flags
,
336 char tmp_filename
[PATH_MAX
];
337 char backing_filename
[PATH_MAX
];
340 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 */
356 if (bdrv_open(bs1
, filename
, 0) < 0) {
360 total_size
= bdrv_getlength(bs1
) >> SECTOR_BITS
;
362 if (bs1
->drv
&& bs1
->drv
->protocol_name
)
367 get_tmp_filename(tmp_filename
, sizeof(tmp_filename
));
369 /* Real path is meaningless for protocols */
371 snprintf(backing_filename
, sizeof(backing_filename
),
374 realpath(filename
, backing_filename
);
376 if (bdrv_create(&bdrv_qcow2
, tmp_filename
,
377 total_size
, backing_filename
, 0) < 0) {
380 filename
= tmp_filename
;
381 bs
->is_temporary
= 1;
384 pstrcpy(bs
->filename
, sizeof(bs
->filename
), filename
);
385 if (flags
& BDRV_O_FILE
) {
386 drv
= find_protocol(filename
);
391 drv
= find_image_format(filename
);
397 bs
->opaque
= qemu_mallocz(drv
->instance_size
);
398 if (bs
->opaque
== NULL
&& drv
->instance_size
> 0)
400 /* Note: for compatibility, we open disk image files as RDWR, and
401 RDONLY as fallback */
402 if (!(flags
& BDRV_O_FILE
))
403 open_flags
= BDRV_O_RDWR
| (flags
& BDRV_O_CACHE_MASK
);
405 open_flags
= flags
& ~(BDRV_O_FILE
| BDRV_O_SNAPSHOT
);
406 ret
= drv
->bdrv_open(bs
, filename
, open_flags
);
407 if ((ret
== -EACCES
|| ret
== -EPERM
) && !(flags
& BDRV_O_FILE
)) {
408 ret
= drv
->bdrv_open(bs
, filename
, open_flags
& ~BDRV_O_RDWR
);
412 qemu_free(bs
->opaque
);
417 if (drv
->bdrv_getlength
) {
418 bs
->total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
421 if (bs
->is_temporary
) {
425 if (bs
->backing_file
[0] != '\0') {
426 /* if there is a backing file, use it */
427 bs
->backing_hd
= bdrv_new("");
428 if (!bs
->backing_hd
) {
433 path_combine(backing_filename
, sizeof(backing_filename
),
434 filename
, bs
->backing_file
);
435 if (bdrv_open(bs
->backing_hd
, backing_filename
, open_flags
) < 0)
439 /* call the change callback */
440 bs
->media_changed
= 1;
442 bs
->change_cb(bs
->change_opaque
);
447 void bdrv_close(BlockDriverState
*bs
)
451 bdrv_delete(bs
->backing_hd
);
452 bs
->drv
->bdrv_close(bs
);
453 qemu_free(bs
->opaque
);
455 if (bs
->is_temporary
) {
456 unlink(bs
->filename
);
462 /* call the change callback */
463 bs
->media_changed
= 1;
465 bs
->change_cb(bs
->change_opaque
);
469 void bdrv_delete(BlockDriverState
*bs
)
471 BlockDriverState
**pbs
;
474 while (*pbs
!= bs
&& *pbs
!= NULL
)
483 /* commit COW file into the raw image */
484 int bdrv_commit(BlockDriverState
*bs
)
486 BlockDriver
*drv
= bs
->drv
;
487 int64_t i
, total_sectors
;
489 unsigned char sector
[512];
498 if (!bs
->backing_hd
) {
502 total_sectors
= bdrv_getlength(bs
) >> SECTOR_BITS
;
503 for (i
= 0; i
< total_sectors
;) {
504 if (drv
->bdrv_is_allocated(bs
, i
, 65536, &n
)) {
505 for(j
= 0; j
< n
; j
++) {
506 if (bdrv_read(bs
, i
, sector
, 1) != 0) {
510 if (bdrv_write(bs
->backing_hd
, i
, sector
, 1) != 0) {
520 if (drv
->bdrv_make_empty
)
521 return drv
->bdrv_make_empty(bs
);
526 /* return < 0 if error. See bdrv_write() for the return codes */
527 int bdrv_read(BlockDriverState
*bs
, int64_t sector_num
,
528 uint8_t *buf
, int nb_sectors
)
530 BlockDriver
*drv
= bs
->drv
;
535 if (drv
->bdrv_pread
) {
537 len
= nb_sectors
* 512;
538 ret
= drv
->bdrv_pread(bs
, sector_num
* 512, buf
, len
);
544 bs
->rd_bytes
+= (unsigned) len
;
549 return drv
->bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
553 /* Return < 0 if error. Important errors are:
554 -EIO generic I/O error (may happen for all errors)
555 -ENOMEDIUM No media inserted.
556 -EINVAL Invalid sector number or nb_sectors
557 -EACCES Trying to write a read-only device
559 int bdrv_write(BlockDriverState
*bs
, int64_t sector_num
,
560 const uint8_t *buf
, int nb_sectors
)
562 BlockDriver
*drv
= bs
->drv
;
567 if (drv
->bdrv_pwrite
) {
568 int ret
, len
, count
= 0;
569 len
= nb_sectors
* 512;
571 ret
= drv
->bdrv_pwrite(bs
, sector_num
* 512, buf
, len
- count
);
573 printf("bdrv_write ret=%d\n", ret
);
578 } while (count
!= len
);
579 bs
->wr_bytes
+= (unsigned) len
;
583 return drv
->bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
586 static int bdrv_pread_em(BlockDriverState
*bs
, int64_t offset
,
587 uint8_t *buf
, int count1
)
589 uint8_t tmp_buf
[SECTOR_SIZE
];
590 int len
, nb_sectors
, count
;
594 /* first read to align to sector start */
595 len
= (SECTOR_SIZE
- offset
) & (SECTOR_SIZE
- 1);
598 sector_num
= offset
>> SECTOR_BITS
;
600 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
602 memcpy(buf
, tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), len
);
610 /* read the sectors "in place" */
611 nb_sectors
= count
>> SECTOR_BITS
;
612 if (nb_sectors
> 0) {
613 if (bdrv_read(bs
, sector_num
, buf
, nb_sectors
) < 0)
615 sector_num
+= nb_sectors
;
616 len
= nb_sectors
<< SECTOR_BITS
;
621 /* add data from the last sector */
623 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
625 memcpy(buf
, tmp_buf
, count
);
630 static int bdrv_pwrite_em(BlockDriverState
*bs
, int64_t offset
,
631 const uint8_t *buf
, int count1
)
633 uint8_t tmp_buf
[SECTOR_SIZE
];
634 int len
, nb_sectors
, count
;
638 /* first write 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(tmp_buf
+ (offset
& (SECTOR_SIZE
- 1)), buf
, len
);
647 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
656 /* write the sectors "in place" */
657 nb_sectors
= count
>> SECTOR_BITS
;
658 if (nb_sectors
> 0) {
659 if (bdrv_write(bs
, sector_num
, buf
, nb_sectors
) < 0)
661 sector_num
+= nb_sectors
;
662 len
= nb_sectors
<< SECTOR_BITS
;
667 /* add data from the last sector */
669 if (bdrv_read(bs
, sector_num
, tmp_buf
, 1) < 0)
671 memcpy(tmp_buf
, buf
, count
);
672 if (bdrv_write(bs
, sector_num
, tmp_buf
, 1) < 0)
679 * Read with byte offsets (needed only for file protocols)
681 int bdrv_pread(BlockDriverState
*bs
, int64_t offset
,
682 void *buf1
, int count1
)
684 BlockDriver
*drv
= bs
->drv
;
688 if (!drv
->bdrv_pread
)
689 return bdrv_pread_em(bs
, offset
, buf1
, count1
);
690 return drv
->bdrv_pread(bs
, offset
, buf1
, count1
);
694 * Write with byte offsets (needed only for file protocols)
696 int bdrv_pwrite(BlockDriverState
*bs
, int64_t offset
,
697 const void *buf1
, int count1
)
699 BlockDriver
*drv
= bs
->drv
;
703 if (!drv
->bdrv_pwrite
)
704 return bdrv_pwrite_em(bs
, offset
, buf1
, count1
);
705 return drv
->bdrv_pwrite(bs
, offset
, buf1
, count1
);
709 * Truncate file to 'offset' bytes (needed only for file protocols)
711 int bdrv_truncate(BlockDriverState
*bs
, int64_t offset
)
713 BlockDriver
*drv
= bs
->drv
;
716 if (!drv
->bdrv_truncate
)
718 return drv
->bdrv_truncate(bs
, offset
);
722 * Length of a file in bytes. Return < 0 if error or unknown.
724 int64_t bdrv_getlength(BlockDriverState
*bs
)
726 BlockDriver
*drv
= bs
->drv
;
729 if (!drv
->bdrv_getlength
) {
731 return bs
->total_sectors
* SECTOR_SIZE
;
733 return drv
->bdrv_getlength(bs
);
736 /* return 0 as number of sectors if no device present or error */
737 void bdrv_get_geometry(BlockDriverState
*bs
, uint64_t *nb_sectors_ptr
)
740 length
= bdrv_getlength(bs
);
744 length
= length
>> SECTOR_BITS
;
745 *nb_sectors_ptr
= length
;
749 uint8_t boot_ind
; /* 0x80 - active */
750 uint8_t head
; /* starting head */
751 uint8_t sector
; /* starting sector */
752 uint8_t cyl
; /* starting cylinder */
753 uint8_t sys_ind
; /* What partition type */
754 uint8_t end_head
; /* end head */
755 uint8_t end_sector
; /* end sector */
756 uint8_t end_cyl
; /* end cylinder */
757 uint32_t start_sect
; /* starting sector counting from 0 */
758 uint32_t nr_sects
; /* nr of sectors in partition */
759 } __attribute__((packed
));
761 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
762 static int guess_disk_lchs(BlockDriverState
*bs
,
763 int *pcylinders
, int *pheads
, int *psectors
)
766 int ret
, i
, heads
, sectors
, cylinders
;
771 bdrv_get_geometry(bs
, &nb_sectors
);
773 ret
= bdrv_read(bs
, 0, buf
, 1);
776 /* test msdos magic */
777 if (buf
[510] != 0x55 || buf
[511] != 0xaa)
779 for(i
= 0; i
< 4; i
++) {
780 p
= ((struct partition
*)(buf
+ 0x1be)) + i
;
781 nr_sects
= le32_to_cpu(p
->nr_sects
);
782 if (nr_sects
&& p
->end_head
) {
783 /* We make the assumption that the partition terminates on
784 a cylinder boundary */
785 heads
= p
->end_head
+ 1;
786 sectors
= p
->end_sector
& 63;
789 cylinders
= nb_sectors
/ (heads
* sectors
);
790 if (cylinders
< 1 || cylinders
> 16383)
794 *pcylinders
= cylinders
;
796 printf("guessed geometry: LCHS=%d %d %d\n",
797 cylinders
, heads
, sectors
);
805 void bdrv_guess_geometry(BlockDriverState
*bs
, int *pcyls
, int *pheads
, int *psecs
)
807 int translation
, lba_detected
= 0;
808 int cylinders
, heads
, secs
;
811 /* if a geometry hint is available, use it */
812 bdrv_get_geometry(bs
, &nb_sectors
);
813 bdrv_get_geometry_hint(bs
, &cylinders
, &heads
, &secs
);
814 translation
= bdrv_get_translation_hint(bs
);
815 if (cylinders
!= 0) {
820 if (guess_disk_lchs(bs
, &cylinders
, &heads
, &secs
) == 0) {
822 /* if heads > 16, it means that a BIOS LBA
823 translation was active, so the default
824 hardware geometry is OK */
826 goto default_geometry
;
831 /* disable any translation to be in sync with
832 the logical geometry */
833 if (translation
== BIOS_ATA_TRANSLATION_AUTO
) {
834 bdrv_set_translation_hint(bs
,
835 BIOS_ATA_TRANSLATION_NONE
);
840 /* if no geometry, use a standard physical disk geometry */
841 cylinders
= nb_sectors
/ (16 * 63);
843 if (cylinders
> 16383)
845 else if (cylinders
< 2)
850 if ((lba_detected
== 1) && (translation
== BIOS_ATA_TRANSLATION_AUTO
)) {
851 if ((*pcyls
* *pheads
) <= 131072) {
852 bdrv_set_translation_hint(bs
,
853 BIOS_ATA_TRANSLATION_LARGE
);
855 bdrv_set_translation_hint(bs
,
856 BIOS_ATA_TRANSLATION_LBA
);
860 bdrv_set_geometry_hint(bs
, *pcyls
, *pheads
, *psecs
);
864 void bdrv_set_geometry_hint(BlockDriverState
*bs
,
865 int cyls
, int heads
, int secs
)
872 void bdrv_set_type_hint(BlockDriverState
*bs
, int type
)
875 bs
->removable
= ((type
== BDRV_TYPE_CDROM
||
876 type
== BDRV_TYPE_FLOPPY
));
879 void bdrv_set_translation_hint(BlockDriverState
*bs
, int translation
)
881 bs
->translation
= translation
;
884 void bdrv_get_geometry_hint(BlockDriverState
*bs
,
885 int *pcyls
, int *pheads
, int *psecs
)
892 int bdrv_get_type_hint(BlockDriverState
*bs
)
897 int bdrv_get_translation_hint(BlockDriverState
*bs
)
899 return bs
->translation
;
902 int bdrv_is_removable(BlockDriverState
*bs
)
904 return bs
->removable
;
907 int bdrv_is_read_only(BlockDriverState
*bs
)
909 return bs
->read_only
;
912 int bdrv_is_sg(BlockDriverState
*bs
)
917 /* XXX: no longer used */
918 void bdrv_set_change_cb(BlockDriverState
*bs
,
919 void (*change_cb
)(void *opaque
), void *opaque
)
921 bs
->change_cb
= change_cb
;
922 bs
->change_opaque
= opaque
;
925 int bdrv_is_encrypted(BlockDriverState
*bs
)
927 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
)
929 return bs
->encrypted
;
932 int bdrv_set_key(BlockDriverState
*bs
, const char *key
)
935 if (bs
->backing_hd
&& bs
->backing_hd
->encrypted
) {
936 ret
= bdrv_set_key(bs
->backing_hd
, key
);
942 if (!bs
->encrypted
|| !bs
->drv
|| !bs
->drv
->bdrv_set_key
)
944 return bs
->drv
->bdrv_set_key(bs
, key
);
947 void bdrv_get_format(BlockDriverState
*bs
, char *buf
, int buf_size
)
952 pstrcpy(buf
, buf_size
, bs
->drv
->format_name
);
956 void bdrv_iterate_format(void (*it
)(void *opaque
, const char *name
),
961 for (drv
= first_drv
; drv
!= NULL
; drv
= drv
->next
) {
962 it(opaque
, drv
->format_name
);
966 BlockDriverState
*bdrv_find(const char *name
)
968 BlockDriverState
*bs
;
970 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
971 if (!strcmp(name
, bs
->device_name
))
977 void bdrv_iterate(void (*it
)(void *opaque
, const char *name
), void *opaque
)
979 BlockDriverState
*bs
;
981 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
982 it(opaque
, bs
->device_name
);
986 const char *bdrv_get_device_name(BlockDriverState
*bs
)
988 return bs
->device_name
;
991 void bdrv_flush(BlockDriverState
*bs
)
993 if (bs
->drv
->bdrv_flush
)
994 bs
->drv
->bdrv_flush(bs
);
996 bdrv_flush(bs
->backing_hd
);
999 void bdrv_flush_all(void)
1001 BlockDriverState
*bs
;
1003 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
)
1004 if (bs
->drv
&& !bdrv_is_read_only(bs
) &&
1005 (!bdrv_is_removable(bs
) || bdrv_is_inserted(bs
)))
1010 * Returns true iff the specified sector is present in the disk image. Drivers
1011 * not implementing the functionality are assumed to not support backing files,
1012 * hence all their sectors are reported as allocated.
1014 * 'pnum' is set to the number of sectors (including and immediately following
1015 * the specified sector) that are known to be in the same
1016 * allocated/unallocated state.
1018 * 'nb_sectors' is the max value 'pnum' should be set to.
1020 int bdrv_is_allocated(BlockDriverState
*bs
, int64_t sector_num
, int nb_sectors
,
1024 if (!bs
->drv
->bdrv_is_allocated
) {
1025 if (sector_num
>= bs
->total_sectors
) {
1029 n
= bs
->total_sectors
- sector_num
;
1030 *pnum
= (n
< nb_sectors
) ? (n
) : (nb_sectors
);
1033 return bs
->drv
->bdrv_is_allocated(bs
, sector_num
, nb_sectors
, pnum
);
1036 void bdrv_info(void)
1038 BlockDriverState
*bs
;
1040 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1041 term_printf("%s:", bs
->device_name
);
1042 term_printf(" type=");
1047 case BDRV_TYPE_CDROM
:
1048 term_printf("cdrom");
1050 case BDRV_TYPE_FLOPPY
:
1051 term_printf("floppy");
1054 term_printf(" removable=%d", bs
->removable
);
1055 if (bs
->removable
) {
1056 term_printf(" locked=%d", bs
->locked
);
1059 term_printf(" file=");
1060 term_print_filename(bs
->filename
);
1061 if (bs
->backing_file
[0] != '\0') {
1062 term_printf(" backing_file=");
1063 term_print_filename(bs
->backing_file
);
1065 term_printf(" ro=%d", bs
->read_only
);
1066 term_printf(" drv=%s", bs
->drv
->format_name
);
1068 term_printf(" encrypted");
1070 term_printf(" [not inserted]");
1076 /* The "info blockstats" command. */
1077 void bdrv_info_stats (void)
1079 BlockDriverState
*bs
;
1080 BlockDriverInfo bdi
;
1082 for (bs
= bdrv_first
; bs
!= NULL
; bs
= bs
->next
) {
1084 " rd_bytes=%" PRIu64
1085 " wr_bytes=%" PRIu64
1086 " rd_operations=%" PRIu64
1087 " wr_operations=%" PRIu64
1090 bs
->rd_bytes
, bs
->wr_bytes
,
1091 bs
->rd_ops
, bs
->wr_ops
);
1092 if (bdrv_get_info(bs
, &bdi
) == 0)
1093 term_printf(" high=%" PRId64
1094 " bytes_free=%" PRId64
,
1095 bdi
.highest_alloc
, bdi
.num_free_bytes
);
1100 void bdrv_get_backing_filename(BlockDriverState
*bs
,
1101 char *filename
, int filename_size
)
1103 if (!bs
->backing_hd
) {
1104 pstrcpy(filename
, filename_size
, "");
1106 pstrcpy(filename
, filename_size
, bs
->backing_file
);
1110 int bdrv_write_compressed(BlockDriverState
*bs
, int64_t sector_num
,
1111 const uint8_t *buf
, int nb_sectors
)
1113 BlockDriver
*drv
= bs
->drv
;
1116 if (!drv
->bdrv_write_compressed
)
1118 return drv
->bdrv_write_compressed(bs
, sector_num
, buf
, nb_sectors
);
1121 int bdrv_get_info(BlockDriverState
*bs
, BlockDriverInfo
*bdi
)
1123 BlockDriver
*drv
= bs
->drv
;
1126 if (!drv
->bdrv_get_info
)
1128 memset(bdi
, 0, sizeof(*bdi
));
1129 return drv
->bdrv_get_info(bs
, bdi
);
1132 /**************************************************************/
1133 /* handling of snapshots */
1135 int bdrv_snapshot_create(BlockDriverState
*bs
,
1136 QEMUSnapshotInfo
*sn_info
)
1138 BlockDriver
*drv
= bs
->drv
;
1141 if (!drv
->bdrv_snapshot_create
)
1143 return drv
->bdrv_snapshot_create(bs
, sn_info
);
1146 int bdrv_snapshot_goto(BlockDriverState
*bs
,
1147 const char *snapshot_id
)
1149 BlockDriver
*drv
= bs
->drv
;
1152 if (!drv
->bdrv_snapshot_goto
)
1154 return drv
->bdrv_snapshot_goto(bs
, snapshot_id
);
1157 int bdrv_snapshot_delete(BlockDriverState
*bs
, const char *snapshot_id
)
1159 BlockDriver
*drv
= bs
->drv
;
1162 if (!drv
->bdrv_snapshot_delete
)
1164 return drv
->bdrv_snapshot_delete(bs
, snapshot_id
);
1167 int bdrv_snapshot_list(BlockDriverState
*bs
,
1168 QEMUSnapshotInfo
**psn_info
)
1170 BlockDriver
*drv
= bs
->drv
;
1173 if (!drv
->bdrv_snapshot_list
)
1175 return drv
->bdrv_snapshot_list(bs
, psn_info
);
1178 #define NB_SUFFIXES 4
1180 char *get_human_readable_size(char *buf
, int buf_size
, int64_t size
)
1182 static const char suffixes
[NB_SUFFIXES
] = "KMGT";
1187 snprintf(buf
, buf_size
, "%" PRId64
, size
);
1190 for(i
= 0; i
< NB_SUFFIXES
; i
++) {
1191 if (size
< (10 * base
)) {
1192 snprintf(buf
, buf_size
, "%0.1f%c",
1193 (double)size
/ base
,
1196 } else if (size
< (1000 * base
) || i
== (NB_SUFFIXES
- 1)) {
1197 snprintf(buf
, buf_size
, "%" PRId64
"%c",
1198 ((size
+ (base
>> 1)) / base
),
1208 char *bdrv_snapshot_dump(char *buf
, int buf_size
, QEMUSnapshotInfo
*sn
)
1210 char buf1
[128], date_buf
[128], clock_buf
[128];
1220 snprintf(buf
, buf_size
,
1221 "%-10s%-20s%7s%20s%15s",
1222 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1226 ptm
= localtime(&ti
);
1227 strftime(date_buf
, sizeof(date_buf
),
1228 "%Y-%m-%d %H:%M:%S", ptm
);
1230 localtime_r(&ti
, &tm
);
1231 strftime(date_buf
, sizeof(date_buf
),
1232 "%Y-%m-%d %H:%M:%S", &tm
);
1234 secs
= sn
->vm_clock_nsec
/ 1000000000;
1235 snprintf(clock_buf
, sizeof(clock_buf
),
1236 "%02d:%02d:%02d.%03d",
1238 (int)((secs
/ 60) % 60),
1240 (int)((sn
->vm_clock_nsec
/ 1000000) % 1000));
1241 snprintf(buf
, buf_size
,
1242 "%-10s%-20s%7s%20s%15s",
1243 sn
->id_str
, sn
->name
,
1244 get_human_readable_size(buf1
, sizeof(buf1
), sn
->vm_state_size
),
1252 /**************************************************************/
1255 typedef struct VectorTranslationState
{
1259 BlockDriverAIOCB
*aiocb
;
1260 BlockDriverAIOCB
*this_aiocb
;
1261 } VectorTranslationState
;
1263 static void bdrv_aio_rw_vector_cb(void *opaque
, int ret
)
1265 VectorTranslationState
*s
= opaque
;
1268 qemu_iovec_from_buffer(s
->iov
, s
->bounce
, s
->iov
->size
);
1270 qemu_free(s
->bounce
);
1271 s
->this_aiocb
->cb(s
->this_aiocb
->opaque
, ret
);
1272 qemu_aio_release(s
->this_aiocb
);
1275 static BlockDriverAIOCB
*bdrv_aio_rw_vector(BlockDriverState
*bs
,
1279 BlockDriverCompletionFunc
*cb
,
1284 VectorTranslationState
*s
= qemu_mallocz(sizeof(*s
));
1285 BlockDriverAIOCB
*aiocb
= qemu_aio_get(bs
, cb
, opaque
);
1287 s
->this_aiocb
= aiocb
;
1289 s
->bounce
= qemu_memalign(512, nb_sectors
* 512);
1290 s
->is_write
= is_write
;
1292 qemu_iovec_to_buffer(s
->iov
, s
->bounce
);
1293 s
->aiocb
= bdrv_aio_write(bs
, sector_num
, s
->bounce
, nb_sectors
,
1294 bdrv_aio_rw_vector_cb
, s
);
1296 s
->aiocb
= bdrv_aio_read(bs
, sector_num
, s
->bounce
, nb_sectors
,
1297 bdrv_aio_rw_vector_cb
, s
);
1302 BlockDriverAIOCB
*bdrv_aio_readv(BlockDriverState
*bs
, int64_t sector_num
,
1303 QEMUIOVector
*iov
, int nb_sectors
,
1304 BlockDriverCompletionFunc
*cb
, void *opaque
)
1306 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1310 BlockDriverAIOCB
*bdrv_aio_writev(BlockDriverState
*bs
, int64_t sector_num
,
1311 QEMUIOVector
*iov
, int nb_sectors
,
1312 BlockDriverCompletionFunc
*cb
, void *opaque
)
1314 return bdrv_aio_rw_vector(bs
, sector_num
, iov
, nb_sectors
,
1318 BlockDriverAIOCB
*bdrv_aio_read(BlockDriverState
*bs
, int64_t sector_num
,
1319 uint8_t *buf
, int nb_sectors
,
1320 BlockDriverCompletionFunc
*cb
, void *opaque
)
1322 BlockDriver
*drv
= bs
->drv
;
1323 BlockDriverAIOCB
*ret
;
1328 ret
= drv
->bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1331 /* Update stats even though technically transfer has not happened. */
1332 bs
->rd_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1339 BlockDriverAIOCB
*bdrv_aio_write(BlockDriverState
*bs
, int64_t sector_num
,
1340 const uint8_t *buf
, int nb_sectors
,
1341 BlockDriverCompletionFunc
*cb
, void *opaque
)
1343 BlockDriver
*drv
= bs
->drv
;
1344 BlockDriverAIOCB
*ret
;
1351 ret
= drv
->bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
, cb
, opaque
);
1354 /* Update stats even though technically transfer has not happened. */
1355 bs
->wr_bytes
+= (unsigned) nb_sectors
* SECTOR_SIZE
;
1362 void bdrv_aio_cancel(BlockDriverAIOCB
*acb
)
1364 BlockDriver
*drv
= acb
->bs
->drv
;
1366 if (acb
->cb
== bdrv_aio_rw_vector_cb
) {
1367 VectorTranslationState
*s
= acb
->opaque
;
1371 drv
->bdrv_aio_cancel(acb
);
1375 /**************************************************************/
1376 /* async block device emulation */
1378 static void bdrv_aio_bh_cb(void *opaque
)
1380 BlockDriverAIOCBSync
*acb
= opaque
;
1381 acb
->common
.cb(acb
->common
.opaque
, acb
->ret
);
1382 qemu_aio_release(acb
);
1385 static BlockDriverAIOCB
*bdrv_aio_read_em(BlockDriverState
*bs
,
1386 int64_t sector_num
, uint8_t *buf
, int nb_sectors
,
1387 BlockDriverCompletionFunc
*cb
, void *opaque
)
1389 BlockDriverAIOCBSync
*acb
;
1392 acb
= qemu_aio_get(bs
, cb
, opaque
);
1394 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1395 ret
= bdrv_read(bs
, sector_num
, buf
, nb_sectors
);
1397 qemu_bh_schedule(acb
->bh
);
1398 return &acb
->common
;
1401 static BlockDriverAIOCB
*bdrv_aio_write_em(BlockDriverState
*bs
,
1402 int64_t sector_num
, const uint8_t *buf
, int nb_sectors
,
1403 BlockDriverCompletionFunc
*cb
, void *opaque
)
1405 BlockDriverAIOCBSync
*acb
;
1408 acb
= qemu_aio_get(bs
, cb
, opaque
);
1410 acb
->bh
= qemu_bh_new(bdrv_aio_bh_cb
, acb
);
1411 ret
= bdrv_write(bs
, sector_num
, buf
, nb_sectors
);
1413 qemu_bh_schedule(acb
->bh
);
1414 return &acb
->common
;
1417 static void bdrv_aio_cancel_em(BlockDriverAIOCB
*blockacb
)
1419 BlockDriverAIOCBSync
*acb
= (BlockDriverAIOCBSync
*)blockacb
;
1420 qemu_bh_cancel(acb
->bh
);
1421 qemu_aio_release(acb
);
1424 /**************************************************************/
1425 /* sync block device emulation */
1427 static void bdrv_rw_em_cb(void *opaque
, int ret
)
1429 *(int *)opaque
= ret
;
1432 #define NOT_DONE 0x7fffffff
1434 static int bdrv_read_em(BlockDriverState
*bs
, int64_t sector_num
,
1435 uint8_t *buf
, int nb_sectors
)
1438 BlockDriverAIOCB
*acb
;
1440 async_ret
= NOT_DONE
;
1441 acb
= bdrv_aio_read(bs
, sector_num
, buf
, nb_sectors
,
1442 bdrv_rw_em_cb
, &async_ret
);
1446 while (async_ret
== NOT_DONE
) {
1453 static int bdrv_write_em(BlockDriverState
*bs
, int64_t sector_num
,
1454 const uint8_t *buf
, int nb_sectors
)
1457 BlockDriverAIOCB
*acb
;
1459 async_ret
= NOT_DONE
;
1460 acb
= bdrv_aio_write(bs
, sector_num
, buf
, nb_sectors
,
1461 bdrv_rw_em_cb
, &async_ret
);
1464 while (async_ret
== NOT_DONE
) {
1470 void bdrv_init(void)
1472 bdrv_register(&bdrv_raw
);
1473 bdrv_register(&bdrv_host_device
);
1475 bdrv_register(&bdrv_cow
);
1477 bdrv_register(&bdrv_qcow
);
1478 bdrv_register(&bdrv_vmdk
);
1479 bdrv_register(&bdrv_cloop
);
1480 bdrv_register(&bdrv_dmg
);
1481 bdrv_register(&bdrv_bochs
);
1482 bdrv_register(&bdrv_vpc
);
1483 bdrv_register(&bdrv_vvfat
);
1484 bdrv_register(&bdrv_qcow2
);
1485 bdrv_register(&bdrv_parallels
);
1486 bdrv_register(&bdrv_nbd
);
1489 void *qemu_aio_get(BlockDriverState
*bs
, BlockDriverCompletionFunc
*cb
,
1493 BlockDriverAIOCB
*acb
;
1496 if (drv
->free_aiocb
) {
1497 acb
= drv
->free_aiocb
;
1498 drv
->free_aiocb
= acb
->next
;
1500 acb
= qemu_mallocz(drv
->aiocb_size
);
1506 acb
->opaque
= opaque
;
1510 void qemu_aio_release(void *p
)
1512 BlockDriverAIOCB
*acb
= p
;
1513 BlockDriver
*drv
= acb
->bs
->drv
;
1514 acb
->next
= drv
->free_aiocb
;
1515 drv
->free_aiocb
= acb
;
1518 /**************************************************************/
1519 /* removable device support */
1522 * Return TRUE if the media is present
1524 int bdrv_is_inserted(BlockDriverState
*bs
)
1526 BlockDriver
*drv
= bs
->drv
;
1530 if (!drv
->bdrv_is_inserted
)
1532 ret
= drv
->bdrv_is_inserted(bs
);
1537 * Return TRUE if the media changed since the last call to this
1538 * function. It is currently only used for floppy disks
1540 int bdrv_media_changed(BlockDriverState
*bs
)
1542 BlockDriver
*drv
= bs
->drv
;
1545 if (!drv
|| !drv
->bdrv_media_changed
)
1548 ret
= drv
->bdrv_media_changed(bs
);
1549 if (ret
== -ENOTSUP
)
1550 ret
= bs
->media_changed
;
1551 bs
->media_changed
= 0;
1556 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1558 void bdrv_eject(BlockDriverState
*bs
, int eject_flag
)
1560 BlockDriver
*drv
= bs
->drv
;
1563 if (!drv
|| !drv
->bdrv_eject
) {
1566 ret
= drv
->bdrv_eject(bs
, eject_flag
);
1568 if (ret
== -ENOTSUP
) {
1574 int bdrv_is_locked(BlockDriverState
*bs
)
1580 * Lock or unlock the media (if it is locked, the user won't be able
1581 * to eject it manually).
1583 void bdrv_set_locked(BlockDriverState
*bs
, int locked
)
1585 BlockDriver
*drv
= bs
->drv
;
1587 bs
->locked
= locked
;
1588 if (drv
&& drv
->bdrv_set_locked
) {
1589 drv
->bdrv_set_locked(bs
, locked
);
1593 /* needed for generic scsi interface */
1595 int bdrv_ioctl(BlockDriverState
*bs
, unsigned long int req
, void *buf
)
1597 BlockDriver
*drv
= bs
->drv
;
1599 if (drv
&& drv
->bdrv_ioctl
)
1600 return drv
->bdrv_ioctl(bs
, req
, buf
);