Commit | Line | Data |
---|---|---|
3a4d5c94 MT |
1 | #ifndef _VHOST_H |
2 | #define _VHOST_H | |
3 | ||
4 | #include <linux/eventfd.h> | |
5 | #include <linux/vhost.h> | |
6 | #include <linux/mm.h> | |
7 | #include <linux/mutex.h> | |
3a4d5c94 MT |
8 | #include <linux/poll.h> |
9 | #include <linux/file.h> | |
3a4d5c94 MT |
10 | #include <linux/uio.h> |
11 | #include <linux/virtio_config.h> | |
12 | #include <linux/virtio_ring.h> | |
60063497 | 13 | #include <linux/atomic.h> |
3a4d5c94 | 14 | |
c23f3445 TH |
15 | struct vhost_work; |
16 | typedef void (*vhost_work_fn_t)(struct vhost_work *work); | |
17 | ||
18 | struct vhost_work { | |
19 | struct list_head node; | |
20 | vhost_work_fn_t fn; | |
21 | wait_queue_head_t done; | |
22 | int flushing; | |
23 | unsigned queue_seq; | |
24 | unsigned done_seq; | |
25 | }; | |
26 | ||
3a4d5c94 MT |
27 | /* Poll a file (eventfd or socket) */ |
28 | /* Note: there's nothing vhost specific about this structure. */ | |
29 | struct vhost_poll { | |
30 | poll_table table; | |
31 | wait_queue_head_t *wqh; | |
32 | wait_queue_t wait; | |
c23f3445 | 33 | struct vhost_work work; |
3a4d5c94 | 34 | unsigned long mask; |
c23f3445 | 35 | struct vhost_dev *dev; |
3a4d5c94 MT |
36 | }; |
37 | ||
163049ae SH |
38 | void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn); |
39 | void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work); | |
526d3e7f | 40 | bool vhost_has_work(struct vhost_dev *dev); |
163049ae | 41 | |
c23f3445 TH |
42 | void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn, |
43 | unsigned long mask, struct vhost_dev *dev); | |
2b8b328b | 44 | int vhost_poll_start(struct vhost_poll *poll, struct file *file); |
3a4d5c94 MT |
45 | void vhost_poll_stop(struct vhost_poll *poll); |
46 | void vhost_poll_flush(struct vhost_poll *poll); | |
47 | void vhost_poll_queue(struct vhost_poll *poll); | |
6ac1afbf AH |
48 | void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work); |
49 | long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp); | |
3a4d5c94 MT |
50 | |
51 | struct vhost_log { | |
52 | u64 addr; | |
53 | u64 len; | |
54 | }; | |
55 | ||
56 | /* The virtqueue structure describes a queue attached to a device. */ | |
57 | struct vhost_virtqueue { | |
58 | struct vhost_dev *dev; | |
59 | ||
60 | /* The actual ring of buffers. */ | |
61 | struct mutex mutex; | |
62 | unsigned int num; | |
63 | struct vring_desc __user *desc; | |
64 | struct vring_avail __user *avail; | |
65 | struct vring_used __user *used; | |
66 | struct file *kick; | |
67 | struct file *call; | |
68 | struct file *error; | |
69 | struct eventfd_ctx *call_ctx; | |
70 | struct eventfd_ctx *error_ctx; | |
71 | struct eventfd_ctx *log_ctx; | |
72 | ||
73 | struct vhost_poll poll; | |
74 | ||
75 | /* The routine to call when the Guest pings us, or timeout. */ | |
c23f3445 | 76 | vhost_work_fn_t handle_kick; |
3a4d5c94 MT |
77 | |
78 | /* Last available index we saw. */ | |
79 | u16 last_avail_idx; | |
80 | ||
81 | /* Caches available index value from user. */ | |
82 | u16 avail_idx; | |
83 | ||
84 | /* Last index we used. */ | |
85 | u16 last_used_idx; | |
86 | ||
87 | /* Used flags */ | |
88 | u16 used_flags; | |
89 | ||
8ea8cf89 MT |
90 | /* Last used index value we have signalled on */ |
91 | u16 signalled_used; | |
92 | ||
93 | /* Last used index value we have signalled on */ | |
94 | bool signalled_used_valid; | |
95 | ||
3a4d5c94 MT |
96 | /* Log writes to used structure. */ |
97 | bool log_used; | |
98 | u64 log_addr; | |
99 | ||
e0e9b406 | 100 | struct iovec iov[UIO_MAXIOV]; |
e0e9b406 | 101 | struct iovec *indirect; |
e0e9b406 | 102 | struct vring_used_elem *heads; |
22fa90c7 | 103 | /* Protected by virtqueue mutex. */ |
47283bef | 104 | struct vhost_memory *memory; |
22fa90c7 | 105 | void *private_data; |
bd82752a | 106 | u64 acked_features; |
3a4d5c94 MT |
107 | /* Log write descriptors */ |
108 | void __user *log_base; | |
e0e9b406 | 109 | struct vhost_log *log; |
2751c988 GK |
110 | |
111 | /* Ring endianness. Defaults to legacy native endianness. | |
112 | * Set to true when starting a modern virtio device. */ | |
113 | bool is_le; | |
114 | #ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY | |
115 | /* Ring endianness requested by userspace for cross-endian support. */ | |
116 | bool user_be; | |
117 | #endif | |
3a4d5c94 MT |
118 | }; |
119 | ||
120 | struct vhost_dev { | |
47283bef | 121 | struct vhost_memory *memory; |
3a4d5c94 MT |
122 | struct mm_struct *mm; |
123 | struct mutex mutex; | |
3ab2e420 | 124 | struct vhost_virtqueue **vqs; |
3a4d5c94 MT |
125 | int nvqs; |
126 | struct file *log_file; | |
127 | struct eventfd_ctx *log_ctx; | |
c23f3445 TH |
128 | spinlock_t work_lock; |
129 | struct list_head work_list; | |
130 | struct task_struct *worker; | |
3a4d5c94 MT |
131 | }; |
132 | ||
59566b6e | 133 | void vhost_dev_init(struct vhost_dev *, struct vhost_virtqueue **vqs, int nvqs); |
54db63c2 | 134 | long vhost_dev_set_owner(struct vhost_dev *dev); |
05c05351 | 135 | bool vhost_dev_has_owner(struct vhost_dev *dev); |
3a4d5c94 | 136 | long vhost_dev_check_owner(struct vhost_dev *); |
150b9e51 MT |
137 | struct vhost_memory *vhost_dev_reset_owner_prepare(void); |
138 | void vhost_dev_reset_owner(struct vhost_dev *, struct vhost_memory *); | |
ea5d4046 | 139 | void vhost_dev_cleanup(struct vhost_dev *, bool locked); |
b211616d | 140 | void vhost_dev_stop(struct vhost_dev *); |
935cdee7 MT |
141 | long vhost_dev_ioctl(struct vhost_dev *, unsigned int ioctl, void __user *argp); |
142 | long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp); | |
3a4d5c94 MT |
143 | int vhost_vq_access_ok(struct vhost_virtqueue *vq); |
144 | int vhost_log_access_ok(struct vhost_dev *); | |
145 | ||
47283bef | 146 | int vhost_get_vq_desc(struct vhost_virtqueue *, |
d5675bd2 MT |
147 | struct iovec iov[], unsigned int iov_count, |
148 | unsigned int *out_num, unsigned int *in_num, | |
149 | struct vhost_log *log, unsigned int *log_num); | |
8dd014ad | 150 | void vhost_discard_vq_desc(struct vhost_virtqueue *, int n); |
3a4d5c94 | 151 | |
80f7d030 | 152 | int vhost_vq_init_access(struct vhost_virtqueue *); |
3a4d5c94 | 153 | int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len); |
8dd014ad DS |
154 | int vhost_add_used_n(struct vhost_virtqueue *, struct vring_used_elem *heads, |
155 | unsigned count); | |
3a4d5c94 | 156 | void vhost_add_used_and_signal(struct vhost_dev *, struct vhost_virtqueue *, |
8dd014ad DS |
157 | unsigned int id, int len); |
158 | void vhost_add_used_and_signal_n(struct vhost_dev *, struct vhost_virtqueue *, | |
159 | struct vring_used_elem *heads, unsigned count); | |
160 | void vhost_signal(struct vhost_dev *, struct vhost_virtqueue *); | |
8ea8cf89 | 161 | void vhost_disable_notify(struct vhost_dev *, struct vhost_virtqueue *); |
d4a60603 | 162 | bool vhost_vq_avail_empty(struct vhost_dev *, struct vhost_virtqueue *); |
8ea8cf89 | 163 | bool vhost_enable_notify(struct vhost_dev *, struct vhost_virtqueue *); |
3a4d5c94 MT |
164 | |
165 | int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log, | |
166 | unsigned int log_num, u64 len); | |
167 | ||
3a4d5c94 MT |
168 | #define vq_err(vq, fmt, ...) do { \ |
169 | pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \ | |
170 | if ((vq)->error_ctx) \ | |
171 | eventfd_signal((vq)->error_ctx, 1);\ | |
172 | } while (0) | |
173 | ||
174 | enum { | |
8ea8cf89 MT |
175 | VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | |
176 | (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | | |
177 | (1ULL << VIRTIO_RING_F_EVENT_IDX) | | |
4e9fa50c MT |
178 | (1ULL << VHOST_F_LOG_ALL) | |
179 | (1ULL << VIRTIO_F_ANY_LAYOUT) | | |
180 | (1ULL << VIRTIO_F_VERSION_1) | |
3a4d5c94 MT |
181 | }; |
182 | ||
bd82752a | 183 | static inline bool vhost_has_feature(struct vhost_virtqueue *vq, int bit) |
3a4d5c94 | 184 | { |
bd82752a | 185 | return vq->acked_features & (1ULL << bit); |
3a4d5c94 | 186 | } |
e05fd12b | 187 | |
e407f39a | 188 | #ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY |
ab27c07f GK |
189 | static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq) |
190 | { | |
2751c988 | 191 | return vq->is_le; |
ab27c07f | 192 | } |
e407f39a MT |
193 | #else |
194 | static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq) | |
195 | { | |
196 | return virtio_legacy_is_little_endian() || vq->is_le; | |
197 | } | |
198 | #endif | |
ab27c07f | 199 | |
e05fd12b MT |
200 | /* Memory accessors */ |
201 | static inline u16 vhost16_to_cpu(struct vhost_virtqueue *vq, __virtio16 val) | |
202 | { | |
ab27c07f | 203 | return __virtio16_to_cpu(vhost_is_little_endian(vq), val); |
e05fd12b MT |
204 | } |
205 | ||
206 | static inline __virtio16 cpu_to_vhost16(struct vhost_virtqueue *vq, u16 val) | |
207 | { | |
ab27c07f | 208 | return __cpu_to_virtio16(vhost_is_little_endian(vq), val); |
e05fd12b MT |
209 | } |
210 | ||
211 | static inline u32 vhost32_to_cpu(struct vhost_virtqueue *vq, __virtio32 val) | |
212 | { | |
ab27c07f | 213 | return __virtio32_to_cpu(vhost_is_little_endian(vq), val); |
e05fd12b MT |
214 | } |
215 | ||
216 | static inline __virtio32 cpu_to_vhost32(struct vhost_virtqueue *vq, u32 val) | |
217 | { | |
ab27c07f | 218 | return __cpu_to_virtio32(vhost_is_little_endian(vq), val); |
e05fd12b MT |
219 | } |
220 | ||
221 | static inline u64 vhost64_to_cpu(struct vhost_virtqueue *vq, __virtio64 val) | |
222 | { | |
ab27c07f | 223 | return __virtio64_to_cpu(vhost_is_little_endian(vq), val); |
e05fd12b MT |
224 | } |
225 | ||
226 | static inline __virtio64 cpu_to_vhost64(struct vhost_virtqueue *vq, u64 val) | |
227 | { | |
ab27c07f | 228 | return __cpu_to_virtio64(vhost_is_little_endian(vq), val); |
e05fd12b | 229 | } |
3a4d5c94 | 230 | #endif |