xref: /kvmtool/include/kvm/disk-image.h (revision 38c396e4859780cb97bf8bf2dd189b20c657a6f4)
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 	/*
35 	 * The following two are used for reading or writing with a single buffer.
36 	 * The implentation can use readv/writev or memcpy.
37 	 */
38 	ssize_t (*read_sector)(struct disk_image *disk, u64 sector, void *dst, u32 dst_len);
39 	ssize_t (*write_sector)(struct disk_image *disk, u64 sector, void *src, u32 src_len);
40 	/*
41 	 * The following two are used for reading or writing with multiple buffers.
42 	 * The implentation can use readv/writev or memcpy.
43 	 */
44 	ssize_t (*read_sector_iov)(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
45 	ssize_t (*write_sector_iov)(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
46 	int (*flush)(struct disk_image *disk);
47 	int (*close)(struct disk_image *disk);
48 };
49 
50 struct disk_image {
51 	int				fd;
52 	u64				size;
53 	struct disk_image_operations	*ops;
54 	void				*priv;
55 };
56 
57 struct disk_image *disk_image__open(const char *filename, bool readonly);
58 struct disk_image **disk_image__open_all(const char **filenames, bool *readonly, int count);
59 struct disk_image *disk_image__new(int fd, u64 size, struct disk_image_operations *ops, int mmap);
60 int disk_image__close(struct disk_image *disk);
61 void disk_image__close_all(struct disk_image **disks, int count);
62 int disk_image__flush(struct disk_image *disk);
63 ssize_t disk_image__read(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
64 ssize_t disk_image__write(struct disk_image *disk, u64 sector, const struct iovec *iov, int iovcount);
65 ssize_t disk_image__get_serial(struct disk_image *disk, void *buffer, ssize_t *len);
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