2 * QEMU System Emulator block driver
4 * Copyright (c) 2003 Fabrice Bellard
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 #include "config-host.h"
26 /* include native header before sys-queue.h */
27 #include <sys/queue.h>
30 #include "qemu-common.h"
32 #include "block_int.h"
35 #include <sys/types.h>
37 #include <sys/ioctl.h>
42 #define SECTOR_SIZE (1 << SECTOR_BITS)
44 typedef struct BlockDriverAIOCBSync {
45 BlockDriverAIOCB common;
48 } BlockDriverAIOCBSync;
50 static BlockDriverAIOCB *bdrv_aio_read_em(BlockDriverState *bs,
51 int64_t sector_num, uint8_t *buf, int nb_sectors,
52 BlockDriverCompletionFunc *cb, void *opaque);
53 static BlockDriverAIOCB *bdrv_aio_write_em(BlockDriverState *bs,
54 int64_t sector_num, const uint8_t *buf, int nb_sectors,
55 BlockDriverCompletionFunc *cb, void *opaque);
56 static void bdrv_aio_cancel_em(BlockDriverAIOCB *acb);
57 static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
58 uint8_t *buf, int nb_sectors);
59 static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
60 const uint8_t *buf, int nb_sectors);
62 BlockDriverState *bdrv_first;
64 static BlockDriver *first_drv;
66 int path_is_absolute(const char *path)
70 /* specific case for names like: "\\.\d:" */
71 if (*path == '/' || *path == '\\')
74 p = strchr(path, ':');
80 return (*p == '/' || *p == '\\');
86 /* if filename is absolute, just copy it to dest. Otherwise, build a
87 path to it by considering it is relative to base_path. URL are
89 void path_combine(char *dest, int dest_size,
90 const char *base_path,
98 if (path_is_absolute(filename)) {
99 pstrcpy(dest, dest_size, filename);
101 p = strchr(base_path, ':');
106 p1 = strrchr(base_path, '/');
110 p2 = strrchr(base_path, '\\');
122 if (len > dest_size - 1)
124 memcpy(dest, base_path, len);
126 pstrcat(dest, dest_size, filename);
131 static void bdrv_register(BlockDriver *bdrv)
133 if (!bdrv->bdrv_aio_read) {
134 /* add AIO emulation layer */
135 bdrv->bdrv_aio_read = bdrv_aio_read_em;
136 bdrv->bdrv_aio_write = bdrv_aio_write_em;
137 bdrv->bdrv_aio_cancel = bdrv_aio_cancel_em;
138 bdrv->aiocb_size = sizeof(BlockDriverAIOCBSync);
139 } else if (!bdrv->bdrv_read && !bdrv->bdrv_pread) {
140 /* add synchronous IO emulation layer */
141 bdrv->bdrv_read = bdrv_read_em;
142 bdrv->bdrv_write = bdrv_write_em;
144 bdrv->next = first_drv;
148 /* create a new block device (by default it is empty) */
149 BlockDriverState *bdrv_new(const char *device_name)
151 BlockDriverState **pbs, *bs;
153 bs = qemu_mallocz(sizeof(BlockDriverState));
154 pstrcpy(bs->device_name, sizeof(bs->device_name), device_name);
155 if (device_name[0] != '\0') {
156 /* insert at the end */
165 BlockDriver *bdrv_find_format(const char *format_name)
168 for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
169 if (!strcmp(drv1->format_name, format_name))
175 int bdrv_create(BlockDriver *drv,
176 const char *filename, int64_t size_in_sectors,
177 const char *backing_file, int flags)
179 if (!drv->bdrv_create)
181 return drv->bdrv_create(filename, size_in_sectors, backing_file, flags);
185 void get_tmp_filename(char *filename, int size)
187 char temp_dir[MAX_PATH];
189 GetTempPath(MAX_PATH, temp_dir);
190 GetTempFileName(temp_dir, "qem", 0, filename);
193 void get_tmp_filename(char *filename, int size)
197 /* XXX: race condition possible */
198 tmpdir = getenv("TMPDIR");
201 snprintf(filename, size, "%s/vl.XXXXXX", tmpdir);
202 fd = mkstemp(filename);
208 static int is_windows_drive_prefix(const char *filename)
210 return (((filename[0] >= 'a' && filename[0] <= 'z') ||
211 (filename[0] >= 'A' && filename[0] <= 'Z')) &&
215 static int is_windows_drive(const char *filename)
217 if (is_windows_drive_prefix(filename) &&
220 if (strstart(filename, "\\\\.\\", NULL) ||
221 strstart(filename, "//./", NULL))
227 static BlockDriver *find_protocol(const char *filename)
235 if (is_windows_drive(filename) ||
236 is_windows_drive_prefix(filename))
239 p = strchr(filename, ':');
243 if (len > sizeof(protocol) - 1)
244 len = sizeof(protocol) - 1;
245 memcpy(protocol, filename, len);
246 protocol[len] = '\0';
247 for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
248 if (drv1->protocol_name &&
249 !strcmp(drv1->protocol_name, protocol))
255 /* XXX: force raw format if block or character device ? It would
256 simplify the BSD case */
257 static BlockDriver *find_image_format(const char *filename)
259 int ret, score, score_max;
260 BlockDriver *drv1, *drv;
262 BlockDriverState *bs;
264 /* detect host devices. By convention, /dev/cdrom[N] is always
265 recognized as a host CDROM */
266 if (strstart(filename, "/dev/cdrom", NULL))
267 return &bdrv_host_device;
269 if (is_windows_drive(filename))
270 return &bdrv_host_device;
274 if (stat(filename, &st) >= 0 &&
275 (S_ISCHR(st.st_mode) || S_ISBLK(st.st_mode))) {
276 return &bdrv_host_device;
281 drv = find_protocol(filename);
282 /* no need to test disk image formats for vvfat */
283 if (drv == &bdrv_vvfat)
286 ret = bdrv_file_open(&bs, filename, BDRV_O_RDONLY);
289 ret = bdrv_pread(bs, 0, buf, sizeof(buf));
296 for(drv1 = first_drv; drv1 != NULL; drv1 = drv1->next) {
297 if (drv1->bdrv_probe) {
298 score = drv1->bdrv_probe(buf, ret, filename);
299 if (score > score_max) {
308 int bdrv_file_open(BlockDriverState **pbs, const char *filename, int flags)
310 BlockDriverState *bs;
314 ret = bdrv_open2(bs, filename, flags | BDRV_O_FILE, NULL);
324 int bdrv_open(BlockDriverState *bs, const char *filename, int flags)
326 return bdrv_open2(bs, filename, flags, NULL);
329 int bdrv_open2(BlockDriverState *bs, const char *filename, int flags,
333 char tmp_filename[PATH_MAX];
334 char backing_filename[PATH_MAX];
337 bs->is_temporary = 0;
341 if (flags & BDRV_O_SNAPSHOT) {
342 BlockDriverState *bs1;
346 /* if snapshot, we create a temporary backing file and open it
347 instead of opening 'filename' directly */
349 /* if there is a backing file, use it */
351 ret = bdrv_open(bs1, filename, 0);
356 total_size = bdrv_getlength(bs1) >> SECTOR_BITS;
358 if (bs1->drv && bs1->drv->protocol_name)
363 get_tmp_filename(tmp_filename, sizeof(tmp_filename));
365 /* Real path is meaningless for protocols */
367 snprintf(backing_filename, sizeof(backing_filename),
370 realpath(filename, backing_filename);
372 ret = bdrv_create(&bdrv_qcow2, tmp_filename,
373 total_size, backing_filename, 0);
377 filename = tmp_filename;
378 bs->is_temporary = 1;
381 pstrcpy(bs->filename, sizeof(bs->filename), filename);
382 if (flags & BDRV_O_FILE) {
383 drv = find_protocol(filename);
385 drv = find_image_format(filename);
389 goto unlink_and_fail;
392 bs->opaque = qemu_mallocz(drv->instance_size);
393 /* Note: for compatibility, we open disk image files as RDWR, and
394 RDONLY as fallback */
395 if (!(flags & BDRV_O_FILE))
396 open_flags = BDRV_O_RDWR | (flags & BDRV_O_CACHE_MASK);
398 open_flags = flags & ~(BDRV_O_FILE | BDRV_O_SNAPSHOT);
399 ret = drv->bdrv_open(bs, filename, open_flags);
400 if ((ret == -EACCES || ret == -EPERM) && !(flags & BDRV_O_FILE)) {
401 ret = drv->bdrv_open(bs, filename, open_flags & ~BDRV_O_RDWR);
405 qemu_free(bs->opaque);
409 if (bs->is_temporary)
413 if (drv->bdrv_getlength) {
414 bs->total_sectors = bdrv_getlength(bs) >> SECTOR_BITS;
417 if (bs->is_temporary) {
421 if (bs->backing_file[0] != '\0') {
422 /* if there is a backing file, use it */
423 bs->backing_hd = bdrv_new("");
424 path_combine(backing_filename, sizeof(backing_filename),
425 filename, bs->backing_file);
426 ret = bdrv_open(bs->backing_hd, backing_filename, open_flags);
433 if (!bdrv_key_required(bs)) {
434 /* call the change callback */
435 bs->media_changed = 1;
437 bs->change_cb(bs->change_opaque);
442 void bdrv_close(BlockDriverState *bs)
446 bdrv_delete(bs->backing_hd);
447 bs->drv->bdrv_close(bs);
448 qemu_free(bs->opaque);
450 if (bs->is_temporary) {
451 unlink(bs->filename);
457 /* call the change callback */
458 bs->media_changed = 1;
460 bs->change_cb(bs->change_opaque);
464 void bdrv_delete(BlockDriverState *bs)
466 BlockDriverState **pbs;
469 while (*pbs != bs && *pbs != NULL)
478 /* commit COW file into the raw image */
479 int bdrv_commit(BlockDriverState *bs)
481 BlockDriver *drv = bs->drv;
482 int64_t i, total_sectors;
484 unsigned char sector[512];
493 if (!bs->backing_hd) {
497 total_sectors = bdrv_getlength(bs) >> SECTOR_BITS;
498 for (i = 0; i < total_sectors;) {
499 if (drv->bdrv_is_allocated(bs, i, 65536, &n)) {
500 for(j = 0; j < n; j++) {
501 if (bdrv_read(bs, i, sector, 1) != 0) {
505 if (bdrv_write(bs->backing_hd, i, sector, 1) != 0) {
515 if (drv->bdrv_make_empty)
516 return drv->bdrv_make_empty(bs);
521 static int bdrv_check_byte_request(BlockDriverState *bs, int64_t offset,
526 if (!bdrv_is_inserted(bs))
532 len = bdrv_getlength(bs);
534 if ((offset + size) > len)
540 static int bdrv_check_request(BlockDriverState *bs, int64_t sector_num,
545 /* Deal with byte accesses */
547 offset = -sector_num;
549 offset = sector_num * 512;
551 return bdrv_check_byte_request(bs, offset, nb_sectors * 512);
554 /* return < 0 if error. See bdrv_write() for the return codes */
555 int bdrv_read(BlockDriverState *bs, int64_t sector_num,
556 uint8_t *buf, int nb_sectors)
558 BlockDriver *drv = bs->drv;
562 if (bdrv_check_request(bs, sector_num, nb_sectors))
565 if (drv->bdrv_pread) {
567 len = nb_sectors * 512;
568 ret = drv->bdrv_pread(bs, sector_num * 512, buf, len);
574 bs->rd_bytes += (unsigned) len;
579 return drv->bdrv_read(bs, sector_num, buf, nb_sectors);
583 /* Return < 0 if error. Important errors are:
584 -EIO generic I/O error (may happen for all errors)
585 -ENOMEDIUM No media inserted.
586 -EINVAL Invalid sector number or nb_sectors
587 -EACCES Trying to write a read-only device
589 int bdrv_write(BlockDriverState *bs, int64_t sector_num,
590 const uint8_t *buf, int nb_sectors)
592 BlockDriver *drv = bs->drv;
597 if (bdrv_check_request(bs, sector_num, nb_sectors))
600 if (drv->bdrv_pwrite) {
601 int ret, len, count = 0;
602 len = nb_sectors * 512;
604 ret = drv->bdrv_pwrite(bs, sector_num * 512, buf, len - count);
606 printf("bdrv_write ret=%d\n", ret);
611 } while (count != len);
612 bs->wr_bytes += (unsigned) len;
616 return drv->bdrv_write(bs, sector_num, buf, nb_sectors);
619 static int bdrv_pread_em(BlockDriverState *bs, int64_t offset,
620 uint8_t *buf, int count1)
622 uint8_t tmp_buf[SECTOR_SIZE];
623 int len, nb_sectors, count;
627 /* first read to align to sector start */
628 len = (SECTOR_SIZE - offset) & (SECTOR_SIZE - 1);
631 sector_num = offset >> SECTOR_BITS;
633 if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
635 memcpy(buf, tmp_buf + (offset & (SECTOR_SIZE - 1)), len);
643 /* read the sectors "in place" */
644 nb_sectors = count >> SECTOR_BITS;
645 if (nb_sectors > 0) {
646 if (bdrv_read(bs, sector_num, buf, nb_sectors) < 0)
648 sector_num += nb_sectors;
649 len = nb_sectors << SECTOR_BITS;
654 /* add data from the last sector */
656 if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
658 memcpy(buf, tmp_buf, count);
663 static int bdrv_pwrite_em(BlockDriverState *bs, int64_t offset,
664 const uint8_t *buf, int count1)
666 uint8_t tmp_buf[SECTOR_SIZE];
667 int len, nb_sectors, count;
671 /* first write to align to sector start */
672 len = (SECTOR_SIZE - offset) & (SECTOR_SIZE - 1);
675 sector_num = offset >> SECTOR_BITS;
677 if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
679 memcpy(tmp_buf + (offset & (SECTOR_SIZE - 1)), buf, len);
680 if (bdrv_write(bs, sector_num, tmp_buf, 1) < 0)
689 /* write the sectors "in place" */
690 nb_sectors = count >> SECTOR_BITS;
691 if (nb_sectors > 0) {
692 if (bdrv_write(bs, sector_num, buf, nb_sectors) < 0)
694 sector_num += nb_sectors;
695 len = nb_sectors << SECTOR_BITS;
700 /* add data from the last sector */
702 if (bdrv_read(bs, sector_num, tmp_buf, 1) < 0)
704 memcpy(tmp_buf, buf, count);
705 if (bdrv_write(bs, sector_num, tmp_buf, 1) < 0)
712 * Read with byte offsets (needed only for file protocols)
714 int bdrv_pread(BlockDriverState *bs, int64_t offset,
715 void *buf1, int count1)
717 BlockDriver *drv = bs->drv;
721 if (bdrv_check_byte_request(bs, offset, count1))
724 if (!drv->bdrv_pread)
725 return bdrv_pread_em(bs, offset, buf1, count1);
726 return drv->bdrv_pread(bs, offset, buf1, count1);
730 * Write with byte offsets (needed only for file protocols)
732 int bdrv_pwrite(BlockDriverState *bs, int64_t offset,
733 const void *buf1, int count1)
735 BlockDriver *drv = bs->drv;
739 if (bdrv_check_byte_request(bs, offset, count1))
742 if (!drv->bdrv_pwrite)
743 return bdrv_pwrite_em(bs, offset, buf1, count1);
744 return drv->bdrv_pwrite(bs, offset, buf1, count1);
748 * Truncate file to 'offset' bytes (needed only for file protocols)
750 int bdrv_truncate(BlockDriverState *bs, int64_t offset)
752 BlockDriver *drv = bs->drv;
755 if (!drv->bdrv_truncate)
757 return drv->bdrv_truncate(bs, offset);
761 * Length of a file in bytes. Return < 0 if error or unknown.
763 int64_t bdrv_getlength(BlockDriverState *bs)
765 BlockDriver *drv = bs->drv;
768 if (!drv->bdrv_getlength) {
770 return bs->total_sectors * SECTOR_SIZE;
772 return drv->bdrv_getlength(bs);
775 /* return 0 as number of sectors if no device present or error */
776 void bdrv_get_geometry(BlockDriverState *bs, uint64_t *nb_sectors_ptr)
779 length = bdrv_getlength(bs);
783 length = length >> SECTOR_BITS;
784 *nb_sectors_ptr = length;
788 uint8_t boot_ind; /* 0x80 - active */
789 uint8_t head; /* starting head */
790 uint8_t sector; /* starting sector */
791 uint8_t cyl; /* starting cylinder */
792 uint8_t sys_ind; /* What partition type */
793 uint8_t end_head; /* end head */
794 uint8_t end_sector; /* end sector */
795 uint8_t end_cyl; /* end cylinder */
796 uint32_t start_sect; /* starting sector counting from 0 */
797 uint32_t nr_sects; /* nr of sectors in partition */
798 } __attribute__((packed));
800 /* try to guess the disk logical geometry from the MSDOS partition table. Return 0 if OK, -1 if could not guess */
801 static int guess_disk_lchs(BlockDriverState *bs,
802 int *pcylinders, int *pheads, int *psectors)
805 int ret, i, heads, sectors, cylinders;
810 bdrv_get_geometry(bs, &nb_sectors);
812 ret = bdrv_read(bs, 0, buf, 1);
815 /* test msdos magic */
816 if (buf[510] != 0x55 || buf[511] != 0xaa)
818 for(i = 0; i < 4; i++) {
819 p = ((struct partition *)(buf + 0x1be)) + i;
820 nr_sects = le32_to_cpu(p->nr_sects);
821 if (nr_sects && p->end_head) {
822 /* We make the assumption that the partition terminates on
823 a cylinder boundary */
824 heads = p->end_head + 1;
825 sectors = p->end_sector & 63;
828 cylinders = nb_sectors / (heads * sectors);
829 if (cylinders < 1 || cylinders > 16383)
833 *pcylinders = cylinders;
835 printf("guessed geometry: LCHS=%d %d %d\n",
836 cylinders, heads, sectors);
844 void bdrv_guess_geometry(BlockDriverState *bs, int *pcyls, int *pheads, int *psecs)
846 int translation, lba_detected = 0;
847 int cylinders, heads, secs;
850 /* if a geometry hint is available, use it */
851 bdrv_get_geometry(bs, &nb_sectors);
852 bdrv_get_geometry_hint(bs, &cylinders, &heads, &secs);
853 translation = bdrv_get_translation_hint(bs);
854 if (cylinders != 0) {
859 if (guess_disk_lchs(bs, &cylinders, &heads, &secs) == 0) {
861 /* if heads > 16, it means that a BIOS LBA
862 translation was active, so the default
863 hardware geometry is OK */
865 goto default_geometry;
870 /* disable any translation to be in sync with
871 the logical geometry */
872 if (translation == BIOS_ATA_TRANSLATION_AUTO) {
873 bdrv_set_translation_hint(bs,
874 BIOS_ATA_TRANSLATION_NONE);
879 /* if no geometry, use a standard physical disk geometry */
880 cylinders = nb_sectors / (16 * 63);
882 if (cylinders > 16383)
884 else if (cylinders < 2)
889 if ((lba_detected == 1) && (translation == BIOS_ATA_TRANSLATION_AUTO)) {
890 if ((*pcyls * *pheads) <= 131072) {
891 bdrv_set_translation_hint(bs,
892 BIOS_ATA_TRANSLATION_LARGE);
894 bdrv_set_translation_hint(bs,
895 BIOS_ATA_TRANSLATION_LBA);
899 bdrv_set_geometry_hint(bs, *pcyls, *pheads, *psecs);
903 void bdrv_set_geometry_hint(BlockDriverState *bs,
904 int cyls, int heads, int secs)
911 void bdrv_set_type_hint(BlockDriverState *bs, int type)
914 bs->removable = ((type == BDRV_TYPE_CDROM ||
915 type == BDRV_TYPE_FLOPPY));
918 void bdrv_set_translation_hint(BlockDriverState *bs, int translation)
920 bs->translation = translation;
923 void bdrv_get_geometry_hint(BlockDriverState *bs,
924 int *pcyls, int *pheads, int *psecs)
931 int bdrv_get_type_hint(BlockDriverState *bs)
936 int bdrv_get_translation_hint(BlockDriverState *bs)
938 return bs->translation;
941 int bdrv_is_removable(BlockDriverState *bs)
943 return bs->removable;
946 int bdrv_is_read_only(BlockDriverState *bs)
948 return bs->read_only;
951 int bdrv_is_sg(BlockDriverState *bs)
956 /* XXX: no longer used */
957 void bdrv_set_change_cb(BlockDriverState *bs,
958 void (*change_cb)(void *opaque), void *opaque)
960 bs->change_cb = change_cb;
961 bs->change_opaque = opaque;
964 int bdrv_is_encrypted(BlockDriverState *bs)
966 if (bs->backing_hd && bs->backing_hd->encrypted)
968 return bs->encrypted;
971 int bdrv_key_required(BlockDriverState *bs)
973 BlockDriverState *backing_hd = bs->backing_hd;
975 if (backing_hd && backing_hd->encrypted && !backing_hd->valid_key)
977 return (bs->encrypted && !bs->valid_key);
980 int bdrv_set_key(BlockDriverState *bs, const char *key)
983 if (bs->backing_hd && bs->backing_hd->encrypted) {
984 ret = bdrv_set_key(bs->backing_hd, key);
990 if (!bs->encrypted || !bs->drv || !bs->drv->bdrv_set_key)
992 ret = bs->drv->bdrv_set_key(bs, key);
995 } else if (!bs->valid_key) {
997 /* call the change callback now, we skipped it on open */
998 bs->media_changed = 1;
1000 bs->change_cb(bs->change_opaque);
1005 void bdrv_get_format(BlockDriverState *bs, char *buf, int buf_size)
1010 pstrcpy(buf, buf_size, bs->drv->format_name);
1014 void bdrv_iterate_format(void (*it)(void *opaque, const char *name),
1019 for (drv = first_drv; drv != NULL; drv = drv->next) {
1020 it(opaque, drv->format_name);
1024 BlockDriverState *bdrv_find(const char *name)
1026 BlockDriverState *bs;
1028 for (bs = bdrv_first; bs != NULL; bs = bs->next) {
1029 if (!strcmp(name, bs->device_name))
1035 void bdrv_iterate(void (*it)(void *opaque, BlockDriverState *bs), void *opaque)
1037 BlockDriverState *bs;
1039 for (bs = bdrv_first; bs != NULL; bs = bs->next) {
1044 const char *bdrv_get_device_name(BlockDriverState *bs)
1046 return bs->device_name;
1049 void bdrv_flush(BlockDriverState *bs)
1051 if (bs->drv->bdrv_flush)
1052 bs->drv->bdrv_flush(bs);
1054 bdrv_flush(bs->backing_hd);
1057 void bdrv_flush_all(void)
1059 BlockDriverState *bs;
1061 for (bs = bdrv_first; bs != NULL; bs = bs->next)
1062 if (bs->drv && !bdrv_is_read_only(bs) &&
1063 (!bdrv_is_removable(bs) || bdrv_is_inserted(bs)))
1068 * Returns true iff the specified sector is present in the disk image. Drivers
1069 * not implementing the functionality are assumed to not support backing files,
1070 * hence all their sectors are reported as allocated.
1072 * 'pnum' is set to the number of sectors (including and immediately following
1073 * the specified sector) that are known to be in the same
1074 * allocated/unallocated state.
1076 * 'nb_sectors' is the max value 'pnum' should be set to.
1078 int bdrv_is_allocated(BlockDriverState *bs, int64_t sector_num, int nb_sectors,
1082 if (!bs->drv->bdrv_is_allocated) {
1083 if (sector_num >= bs->total_sectors) {
1087 n = bs->total_sectors - sector_num;
1088 *pnum = (n < nb_sectors) ? (n) : (nb_sectors);
1091 return bs->drv->bdrv_is_allocated(bs, sector_num, nb_sectors, pnum);
1094 void bdrv_info(void)
1096 BlockDriverState *bs;
1098 for (bs = bdrv_first; bs != NULL; bs = bs->next) {
1099 term_printf("%s:", bs->device_name);
1100 term_printf(" type=");
1105 case BDRV_TYPE_CDROM:
1106 term_printf("cdrom");
1108 case BDRV_TYPE_FLOPPY:
1109 term_printf("floppy");
1112 term_printf(" removable=%d", bs->removable);
1113 if (bs->removable) {
1114 term_printf(" locked=%d", bs->locked);
1117 term_printf(" file=");
1118 term_print_filename(bs->filename);
1119 if (bs->backing_file[0] != '\0') {
1120 term_printf(" backing_file=");
1121 term_print_filename(bs->backing_file);
1123 term_printf(" ro=%d", bs->read_only);
1124 term_printf(" drv=%s", bs->drv->format_name);
1125 term_printf(" encrypted=%d", bdrv_is_encrypted(bs));
1127 term_printf(" [not inserted]");
1133 /* The "info blockstats" command. */
1134 void bdrv_info_stats (void)
1136 BlockDriverState *bs;
1137 BlockDriverInfo bdi;
1139 for (bs = bdrv_first; bs != NULL; bs = bs->next) {
1141 " rd_bytes=%" PRIu64
1142 " wr_bytes=%" PRIu64
1143 " rd_operations=%" PRIu64
1144 " wr_operations=%" PRIu64
1147 bs->rd_bytes, bs->wr_bytes,
1148 bs->rd_ops, bs->wr_ops);
1149 if (bdrv_get_info(bs, &bdi) == 0)
1150 term_printf(" high=%" PRId64
1151 " bytes_free=%" PRId64,
1152 bdi.highest_alloc, bdi.num_free_bytes);
1157 const char *bdrv_get_encrypted_filename(BlockDriverState *bs)
1159 if (bs->backing_hd && bs->backing_hd->encrypted)
1160 return bs->backing_file;
1161 else if (bs->encrypted)
1162 return bs->filename;
1167 void bdrv_get_backing_filename(BlockDriverState *bs,
1168 char *filename, int filename_size)
1170 if (!bs->backing_hd) {
1171 pstrcpy(filename, filename_size, "");
1173 pstrcpy(filename, filename_size, bs->backing_file);
1177 int bdrv_write_compressed(BlockDriverState *bs, int64_t sector_num,
1178 const uint8_t *buf, int nb_sectors)
1180 BlockDriver *drv = bs->drv;
1183 if (!drv->bdrv_write_compressed)
1185 return drv->bdrv_write_compressed(bs, sector_num, buf, nb_sectors);
1188 int bdrv_get_info(BlockDriverState *bs, BlockDriverInfo *bdi)
1190 BlockDriver *drv = bs->drv;
1193 if (!drv->bdrv_get_info)
1195 memset(bdi, 0, sizeof(*bdi));
1196 return drv->bdrv_get_info(bs, bdi);
1199 /**************************************************************/
1200 /* handling of snapshots */
1202 int bdrv_snapshot_create(BlockDriverState *bs,
1203 QEMUSnapshotInfo *sn_info)
1205 BlockDriver *drv = bs->drv;
1208 if (!drv->bdrv_snapshot_create)
1210 return drv->bdrv_snapshot_create(bs, sn_info);
1213 int bdrv_snapshot_goto(BlockDriverState *bs,
1214 const char *snapshot_id)
1216 BlockDriver *drv = bs->drv;
1219 if (!drv->bdrv_snapshot_goto)
1221 return drv->bdrv_snapshot_goto(bs, snapshot_id);
1224 int bdrv_snapshot_delete(BlockDriverState *bs, const char *snapshot_id)
1226 BlockDriver *drv = bs->drv;
1229 if (!drv->bdrv_snapshot_delete)
1231 return drv->bdrv_snapshot_delete(bs, snapshot_id);
1234 int bdrv_snapshot_list(BlockDriverState *bs,
1235 QEMUSnapshotInfo **psn_info)
1237 BlockDriver *drv = bs->drv;
1240 if (!drv->bdrv_snapshot_list)
1242 return drv->bdrv_snapshot_list(bs, psn_info);
1245 #define NB_SUFFIXES 4
1247 char *get_human_readable_size(char *buf, int buf_size, int64_t size)
1249 static const char suffixes[NB_SUFFIXES] = "KMGT";
1254 snprintf(buf, buf_size, "%" PRId64, size);
1257 for(i = 0; i < NB_SUFFIXES; i++) {
1258 if (size < (10 * base)) {
1259 snprintf(buf, buf_size, "%0.1f%c",
1260 (double)size / base,
1263 } else if (size < (1000 * base) || i == (NB_SUFFIXES - 1)) {
1264 snprintf(buf, buf_size, "%" PRId64 "%c",
1265 ((size + (base >> 1)) / base),
1275 char *bdrv_snapshot_dump(char *buf, int buf_size, QEMUSnapshotInfo *sn)
1277 char buf1[128], date_buf[128], clock_buf[128];
1287 snprintf(buf, buf_size,
1288 "%-10s%-20s%7s%20s%15s",
1289 "ID", "TAG", "VM SIZE", "DATE", "VM CLOCK");
1293 ptm = localtime(&ti);
1294 strftime(date_buf, sizeof(date_buf),
1295 "%Y-%m-%d %H:%M:%S", ptm);
1297 localtime_r(&ti, &tm);
1298 strftime(date_buf, sizeof(date_buf),
1299 "%Y-%m-%d %H:%M:%S", &tm);
1301 secs = sn->vm_clock_nsec / 1000000000;
1302 snprintf(clock_buf, sizeof(clock_buf),
1303 "%02d:%02d:%02d.%03d",
1305 (int)((secs / 60) % 60),
1307 (int)((sn->vm_clock_nsec / 1000000) % 1000));
1308 snprintf(buf, buf_size,
1309 "%-10s%-20s%7s%20s%15s",
1310 sn->id_str, sn->name,
1311 get_human_readable_size(buf1, sizeof(buf1), sn->vm_state_size),
1319 /**************************************************************/
1322 typedef struct VectorTranslationState {
1326 BlockDriverAIOCB *aiocb;
1327 BlockDriverAIOCB *this_aiocb;
1328 } VectorTranslationState;
1330 static void bdrv_aio_rw_vector_cb(void *opaque, int ret)
1332 VectorTranslationState *s = opaque;
1335 qemu_iovec_from_buffer(s->iov, s->bounce, s->iov->size);
1337 qemu_vfree(s->bounce);
1338 s->this_aiocb->cb(s->this_aiocb->opaque, ret);
1339 qemu_aio_release(s->this_aiocb);
1342 static BlockDriverAIOCB *bdrv_aio_rw_vector(BlockDriverState *bs,
1346 BlockDriverCompletionFunc *cb,
1351 VectorTranslationState *s = qemu_mallocz(sizeof(*s));
1352 BlockDriverAIOCB *aiocb = qemu_aio_get(bs, cb, opaque);
1354 s->this_aiocb = aiocb;
1356 s->bounce = qemu_memalign(512, nb_sectors * 512);
1357 s->is_write = is_write;
1359 qemu_iovec_to_buffer(s->iov, s->bounce);
1360 s->aiocb = bdrv_aio_write(bs, sector_num, s->bounce, nb_sectors,
1361 bdrv_aio_rw_vector_cb, s);
1363 s->aiocb = bdrv_aio_read(bs, sector_num, s->bounce, nb_sectors,
1364 bdrv_aio_rw_vector_cb, s);
1369 BlockDriverAIOCB *bdrv_aio_readv(BlockDriverState *bs, int64_t sector_num,
1370 QEMUIOVector *iov, int nb_sectors,
1371 BlockDriverCompletionFunc *cb, void *opaque)
1373 if (bdrv_check_request(bs, sector_num, nb_sectors))
1376 return bdrv_aio_rw_vector(bs, sector_num, iov, nb_sectors,
1380 BlockDriverAIOCB *bdrv_aio_writev(BlockDriverState *bs, int64_t sector_num,
1381 QEMUIOVector *iov, int nb_sectors,
1382 BlockDriverCompletionFunc *cb, void *opaque)
1384 if (bdrv_check_request(bs, sector_num, nb_sectors))
1387 return bdrv_aio_rw_vector(bs, sector_num, iov, nb_sectors,
1391 BlockDriverAIOCB *bdrv_aio_read(BlockDriverState *bs, int64_t sector_num,
1392 uint8_t *buf, int nb_sectors,
1393 BlockDriverCompletionFunc *cb, void *opaque)
1395 BlockDriver *drv = bs->drv;
1396 BlockDriverAIOCB *ret;
1400 if (bdrv_check_request(bs, sector_num, nb_sectors))
1403 ret = drv->bdrv_aio_read(bs, sector_num, buf, nb_sectors, cb, opaque);
1406 /* Update stats even though technically transfer has not happened. */
1407 bs->rd_bytes += (unsigned) nb_sectors * SECTOR_SIZE;
1414 BlockDriverAIOCB *bdrv_aio_write(BlockDriverState *bs, int64_t sector_num,
1415 const uint8_t *buf, int nb_sectors,
1416 BlockDriverCompletionFunc *cb, void *opaque)
1418 BlockDriver *drv = bs->drv;
1419 BlockDriverAIOCB *ret;
1425 if (bdrv_check_request(bs, sector_num, nb_sectors))
1428 ret = drv->bdrv_aio_write(bs, sector_num, buf, nb_sectors, cb, opaque);
1431 /* Update stats even though technically transfer has not happened. */
1432 bs->wr_bytes += (unsigned) nb_sectors * SECTOR_SIZE;
1439 void bdrv_aio_cancel(BlockDriverAIOCB *acb)
1441 BlockDriver *drv = acb->bs->drv;
1443 if (acb->cb == bdrv_aio_rw_vector_cb) {
1444 VectorTranslationState *s = acb->opaque;
1448 drv->bdrv_aio_cancel(acb);
1452 /**************************************************************/
1453 /* async block device emulation */
1455 static void bdrv_aio_bh_cb(void *opaque)
1457 BlockDriverAIOCBSync *acb = opaque;
1458 acb->common.cb(acb->common.opaque, acb->ret);
1459 qemu_aio_release(acb);
1462 static BlockDriverAIOCB *bdrv_aio_read_em(BlockDriverState *bs,
1463 int64_t sector_num, uint8_t *buf, int nb_sectors,
1464 BlockDriverCompletionFunc *cb, void *opaque)
1466 BlockDriverAIOCBSync *acb;
1469 acb = qemu_aio_get(bs, cb, opaque);
1471 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
1472 ret = bdrv_read(bs, sector_num, buf, nb_sectors);
1474 qemu_bh_schedule(acb->bh);
1475 return &acb->common;
1478 static BlockDriverAIOCB *bdrv_aio_write_em(BlockDriverState *bs,
1479 int64_t sector_num, const uint8_t *buf, int nb_sectors,
1480 BlockDriverCompletionFunc *cb, void *opaque)
1482 BlockDriverAIOCBSync *acb;
1485 acb = qemu_aio_get(bs, cb, opaque);
1487 acb->bh = qemu_bh_new(bdrv_aio_bh_cb, acb);
1488 ret = bdrv_write(bs, sector_num, buf, nb_sectors);
1490 qemu_bh_schedule(acb->bh);
1491 return &acb->common;
1494 static void bdrv_aio_cancel_em(BlockDriverAIOCB *blockacb)
1496 BlockDriverAIOCBSync *acb = (BlockDriverAIOCBSync *)blockacb;
1497 qemu_bh_cancel(acb->bh);
1498 qemu_aio_release(acb);
1501 /**************************************************************/
1502 /* sync block device emulation */
1504 static void bdrv_rw_em_cb(void *opaque, int ret)
1506 *(int *)opaque = ret;
1509 #define NOT_DONE 0x7fffffff
1511 static int bdrv_read_em(BlockDriverState *bs, int64_t sector_num,
1512 uint8_t *buf, int nb_sectors)
1515 BlockDriverAIOCB *acb;
1517 async_ret = NOT_DONE;
1518 acb = bdrv_aio_read(bs, sector_num, buf, nb_sectors,
1519 bdrv_rw_em_cb, &async_ret);
1523 while (async_ret == NOT_DONE) {
1530 static int bdrv_write_em(BlockDriverState *bs, int64_t sector_num,
1531 const uint8_t *buf, int nb_sectors)
1534 BlockDriverAIOCB *acb;
1536 async_ret = NOT_DONE;
1537 acb = bdrv_aio_write(bs, sector_num, buf, nb_sectors,
1538 bdrv_rw_em_cb, &async_ret);
1541 while (async_ret == NOT_DONE) {
1547 void bdrv_init(void)
1549 bdrv_register(&bdrv_raw);
1550 bdrv_register(&bdrv_host_device);
1552 bdrv_register(&bdrv_cow);
1554 bdrv_register(&bdrv_qcow);
1555 bdrv_register(&bdrv_vmdk);
1556 bdrv_register(&bdrv_cloop);
1557 bdrv_register(&bdrv_dmg);
1558 bdrv_register(&bdrv_bochs);
1559 bdrv_register(&bdrv_vpc);
1560 bdrv_register(&bdrv_vvfat);
1561 bdrv_register(&bdrv_qcow2);
1562 bdrv_register(&bdrv_parallels);
1563 bdrv_register(&bdrv_nbd);
1566 void *qemu_aio_get(BlockDriverState *bs, BlockDriverCompletionFunc *cb,
1570 BlockDriverAIOCB *acb;
1573 if (drv->free_aiocb) {
1574 acb = drv->free_aiocb;
1575 drv->free_aiocb = acb->next;
1577 acb = qemu_mallocz(drv->aiocb_size);
1581 acb->opaque = opaque;
1585 void qemu_aio_release(void *p)
1587 BlockDriverAIOCB *acb = p;
1588 BlockDriver *drv = acb->bs->drv;
1589 acb->next = drv->free_aiocb;
1590 drv->free_aiocb = acb;
1593 /**************************************************************/
1594 /* removable device support */
1597 * Return TRUE if the media is present
1599 int bdrv_is_inserted(BlockDriverState *bs)
1601 BlockDriver *drv = bs->drv;
1605 if (!drv->bdrv_is_inserted)
1607 ret = drv->bdrv_is_inserted(bs);
1612 * Return TRUE if the media changed since the last call to this
1613 * function. It is currently only used for floppy disks
1615 int bdrv_media_changed(BlockDriverState *bs)
1617 BlockDriver *drv = bs->drv;
1620 if (!drv || !drv->bdrv_media_changed)
1623 ret = drv->bdrv_media_changed(bs);
1624 if (ret == -ENOTSUP)
1625 ret = bs->media_changed;
1626 bs->media_changed = 0;
1631 * If eject_flag is TRUE, eject the media. Otherwise, close the tray
1633 void bdrv_eject(BlockDriverState *bs, int eject_flag)
1635 BlockDriver *drv = bs->drv;
1638 if (!drv || !drv->bdrv_eject) {
1641 ret = drv->bdrv_eject(bs, eject_flag);
1643 if (ret == -ENOTSUP) {
1649 int bdrv_is_locked(BlockDriverState *bs)
1655 * Lock or unlock the media (if it is locked, the user won't be able
1656 * to eject it manually).
1658 void bdrv_set_locked(BlockDriverState *bs, int locked)
1660 BlockDriver *drv = bs->drv;
1662 bs->locked = locked;
1663 if (drv && drv->bdrv_set_locked) {
1664 drv->bdrv_set_locked(bs, locked);
1668 /* needed for generic scsi interface */
1670 int bdrv_ioctl(BlockDriverState *bs, unsigned long int req, void *buf)
1672 BlockDriver *drv = bs->drv;
1674 if (drv && drv->bdrv_ioctl)
1675 return drv->bdrv_ioctl(bs, req, buf);