xref: /kvmtool/include/kvm/disk-image.h (revision a67da3beff7afdf98679be09b0d8ce501bd71ac1)
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 enum {
25 	DISK_IMAGE_REGULAR,
26 	DISK_IMAGE_MMAP,
27 };
28 
29 #define MAX_DISK_IMAGES         4
30 
31 struct disk_image;
32 
33 struct disk_image_operations {
34 	ssize_t (*read)(struct disk_image *disk, u64 sector, const struct iovec *iov,
35 			int iovcount, void *param);
36 	ssize_t (*write)(struct disk_image *disk, u64 sector, const struct iovec *iov,
37 			int iovcount, void *param);
38 	int (*flush)(struct disk_image *disk);
39 	int (*close)(struct disk_image *disk);
40 };
41 
42 struct disk_image_params {
43 	const char *filename;
44 	/*
45 	 * wwpn == World Wide Port Number
46 	 * tpgt == Target Portal Group Tag
47 	 */
48 	const char *wwpn;
49 	const char *tpgt;
50 	bool readonly;
51 	bool direct;
52 };
53 
54 struct disk_image {
55 	int				fd;
56 	u64				size;
57 	struct disk_image_operations	*ops;
58 	void				*priv;
59 	void				*disk_req_cb_param;
60 	void				(*disk_req_cb)(void *param, long len);
61 	bool				async;
62 	int				evt;
63 #ifdef CONFIG_HAS_AIO
64 	io_context_t			ctx;
65 #endif
66 	const char			*wwpn;
67 	const char			*tpgt;
68 };
69 
70 struct disk_image *disk_image__open(const char *filename, bool readonly, bool direct);
71 struct disk_image **disk_image__open_all(struct disk_image_params *params, int count);
72 struct disk_image *disk_image__new(int fd, u64 size, struct disk_image_operations *ops, int mmap);
73 int disk_image__close(struct disk_image *disk);
74 int disk_image__close_all(struct disk_image **disks, int count);
75 int disk_image__flush(struct disk_image *disk);
76 ssize_t disk_image__read(struct disk_image *disk, u64 sector, const struct iovec *iov,
77 				int iovcount, void *param);
78 ssize_t disk_image__write(struct disk_image *disk, u64 sector, const struct iovec *iov,
79 				int iovcount, void *param);
80 ssize_t disk_image__get_serial(struct disk_image *disk, void *buffer, ssize_t *len);
81 
82 struct disk_image *raw_image__probe(int fd, struct stat *st, bool readonly);
83 struct disk_image *blkdev__probe(const char *filename, int flags, struct stat *st);
84 
85 ssize_t raw_image__read(struct disk_image *disk, u64 sector,
86 				const struct iovec *iov, int iovcount, void *param);
87 ssize_t raw_image__write(struct disk_image *disk, u64 sector,
88 				const struct iovec *iov, int iovcount, void *param);
89 ssize_t raw_image__read_mmap(struct disk_image *disk, u64 sector,
90 				const struct iovec *iov, int iovcount, void *param);
91 ssize_t raw_image__write_mmap(struct disk_image *disk, u64 sector,
92 				const struct iovec *iov, int iovcount, void *param);
93 int raw_image__close(struct disk_image *disk);
94 void disk_image__set_callback(struct disk_image *disk, void (*disk_req_cb)(void *param, long len));
95 #endif /* KVM__DISK_IMAGE_H */
96