xref: /kvmtool/include/kvm/disk-image.h (revision 87ee33c8e924461317658a87d1cc3cd9b306c908)
1 #ifndef KVM__DISK_IMAGE_H
2 #define KVM__DISK_IMAGE_H
3 
4 #include "kvm/read-write.h"
5 #include "kvm/util.h"
6 
7 #include <linux/types.h>
8 #include <linux/fs.h>	/* for BLKGETSIZE64 */
9 #include <sys/ioctl.h>
10 #include <sys/types.h>
11 #include <sys/mman.h>
12 #include <sys/stat.h>
13 #include <stdbool.h>
14 #include <sys/uio.h>
15 #include <stdbool.h>
16 #include <stddef.h>
17 #include <stdlib.h>
18 #include <unistd.h>
19 #include <fcntl.h>
20 
21 #define SECTOR_SHIFT		9
22 #define SECTOR_SIZE		(1UL << SECTOR_SHIFT)
23 
24 #define DISK_IMAGE_MMAP		0
25 #define DISK_IMAGE_NOMMAP	1
26 
27 struct disk_image;
28 
29 struct disk_image_operations {
30 	/*
31 	 * The following two are used for reading or writing with a single buffer.
32 	 * The implentation can use readv/writev or memcpy.
33 	 */
34 	ssize_t (*read_sector)(struct disk_image *disk, u64 sector, void *dst, u32 dst_len);
35 	ssize_t (*write_sector)(struct disk_image *disk, u64 sector, void *src, u32 src_len);
36 	/*
37 	 * The following two are used for reading or writing with multiple buffers.
38 	 * The implentation can use readv/writev or memcpy.
39 	 */
40 	ssize_t (*read_sector_iov)(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
41 	ssize_t (*write_sector_iov)(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
42 	int (*flush)(struct disk_image *disk);
43 	int (*close)(struct disk_image *disk);
44 };
45 
46 struct disk_image {
47 	int				fd;
48 	u64				size;
49 	struct disk_image_operations	*ops;
50 	void				*priv;
51 };
52 
53 struct disk_image *disk_image__open(const char *filename, bool readonly);
54 struct disk_image *disk_image__new(int fd, u64 size, struct disk_image_operations *ops, int mmap);
55 int disk_image__close(struct disk_image *disk);
56 
57 ssize_t disk_image__read(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
58 ssize_t disk_image__write(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
59 
60 static inline int disk_image__flush(struct disk_image *disk)
61 {
62 	if (disk->ops->flush)
63 		return disk->ops->flush(disk);
64 	return fsync(disk->fd);
65 }
66 
67 struct disk_image *raw_image__probe(int fd, struct stat *st, bool readonly);
68 struct disk_image *blkdev__probe(const char *filename, struct stat *st);
69 
70 ssize_t raw_image__read_sector_iov(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
71 ssize_t raw_image__write_sector_iov(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
72 ssize_t raw_image__read_sector(struct disk_image *disk, u64 sector, void *dst, u32 dst_len);
73 ssize_t raw_image__write_sector(struct disk_image *disk, u64 sector, void *src, u32 src_len);
74 int raw_image__close(struct disk_image *disk);
75 
76 #endif /* KVM__DISK_IMAGE_H */
77