Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[muen/linux.git] / drivers / vhost / vhost.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _VHOST_H
3 #define _VHOST_H
4
5 #include <linux/eventfd.h>
6 #include <linux/vhost.h>
7 #include <linux/mm.h>
8 #include <linux/mutex.h>
9 #include <linux/poll.h>
10 #include <linux/file.h>
11 #include <linux/uio.h>
12 #include <linux/virtio_config.h>
13 #include <linux/virtio_ring.h>
14 #include <linux/atomic.h>
15
16 struct vhost_work;
17 typedef void (*vhost_work_fn_t)(struct vhost_work *work);
18
19 #define VHOST_WORK_QUEUED 1
20 struct vhost_work {
21         struct llist_node         node;
22         vhost_work_fn_t           fn;
23         unsigned long             flags;
24 };
25
26 /* Poll a file (eventfd or socket) */
27 /* Note: there's nothing vhost specific about this structure. */
28 struct vhost_poll {
29         poll_table                table;
30         wait_queue_head_t        *wqh;
31         wait_queue_entry_t              wait;
32         struct vhost_work         work;
33         __poll_t                  mask;
34         struct vhost_dev         *dev;
35 };
36
37 void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn);
38 void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work);
39 bool vhost_has_work(struct vhost_dev *dev);
40
41 void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
42                      __poll_t mask, struct vhost_dev *dev);
43 int vhost_poll_start(struct vhost_poll *poll, struct file *file);
44 void vhost_poll_stop(struct vhost_poll *poll);
45 void vhost_poll_flush(struct vhost_poll *poll);
46 void vhost_poll_queue(struct vhost_poll *poll);
47 void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work);
48 long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp);
49
50 struct vhost_log {
51         u64 addr;
52         u64 len;
53 };
54
55 #define START(node) ((node)->start)
56 #define LAST(node) ((node)->last)
57
58 struct vhost_umem_node {
59         struct rb_node rb;
60         struct list_head link;
61         __u64 start;
62         __u64 last;
63         __u64 size;
64         __u64 userspace_addr;
65         __u32 perm;
66         __u32 flags_padding;
67         __u64 __subtree_last;
68 };
69
70 struct vhost_umem {
71         struct rb_root_cached umem_tree;
72         struct list_head umem_list;
73         int numem;
74 };
75
76 enum vhost_uaddr_type {
77         VHOST_ADDR_DESC = 0,
78         VHOST_ADDR_AVAIL = 1,
79         VHOST_ADDR_USED = 2,
80         VHOST_NUM_ADDRS = 3,
81 };
82
83 /* The virtqueue structure describes a queue attached to a device. */
84 struct vhost_virtqueue {
85         struct vhost_dev *dev;
86
87         /* The actual ring of buffers. */
88         struct mutex mutex;
89         unsigned int num;
90         struct vring_desc __user *desc;
91         struct vring_avail __user *avail;
92         struct vring_used __user *used;
93         const struct vhost_umem_node *meta_iotlb[VHOST_NUM_ADDRS];
94         struct file *kick;
95         struct eventfd_ctx *call_ctx;
96         struct eventfd_ctx *error_ctx;
97         struct eventfd_ctx *log_ctx;
98
99         struct vhost_poll poll;
100
101         /* The routine to call when the Guest pings us, or timeout. */
102         vhost_work_fn_t handle_kick;
103
104         /* Last available index we saw. */
105         u16 last_avail_idx;
106
107         /* Caches available index value from user. */
108         u16 avail_idx;
109
110         /* Last index we used. */
111         u16 last_used_idx;
112
113         /* Used flags */
114         u16 used_flags;
115
116         /* Last used index value we have signalled on */
117         u16 signalled_used;
118
119         /* Last used index value we have signalled on */
120         bool signalled_used_valid;
121
122         /* Log writes to used structure. */
123         bool log_used;
124         u64 log_addr;
125
126         struct iovec iov[UIO_MAXIOV];
127         struct iovec iotlb_iov[64];
128         struct iovec *indirect;
129         struct vring_used_elem *heads;
130         /* Protected by virtqueue mutex. */
131         struct vhost_umem *umem;
132         struct vhost_umem *iotlb;
133         void *private_data;
134         u64 acked_features;
135         /* Log write descriptors */
136         void __user *log_base;
137         struct vhost_log *log;
138
139         /* Ring endianness. Defaults to legacy native endianness.
140          * Set to true when starting a modern virtio device. */
141         bool is_le;
142 #ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
143         /* Ring endianness requested by userspace for cross-endian support. */
144         bool user_be;
145 #endif
146         u32 busyloop_timeout;
147 };
148
149 struct vhost_msg_node {
150   struct vhost_msg msg;
151   struct vhost_virtqueue *vq;
152   struct list_head node;
153 };
154
155 struct vhost_dev {
156         struct mm_struct *mm;
157         struct mutex mutex;
158         struct vhost_virtqueue **vqs;
159         int nvqs;
160         struct eventfd_ctx *log_ctx;
161         struct llist_head work_list;
162         struct task_struct *worker;
163         struct vhost_umem *umem;
164         struct vhost_umem *iotlb;
165         spinlock_t iotlb_lock;
166         struct list_head read_list;
167         struct list_head pending_list;
168         wait_queue_head_t wait;
169 };
170
171 void vhost_dev_init(struct vhost_dev *, struct vhost_virtqueue **vqs, int nvqs);
172 long vhost_dev_set_owner(struct vhost_dev *dev);
173 bool vhost_dev_has_owner(struct vhost_dev *dev);
174 long vhost_dev_check_owner(struct vhost_dev *);
175 struct vhost_umem *vhost_dev_reset_owner_prepare(void);
176 void vhost_dev_reset_owner(struct vhost_dev *, struct vhost_umem *);
177 void vhost_dev_cleanup(struct vhost_dev *);
178 void vhost_dev_stop(struct vhost_dev *);
179 long vhost_dev_ioctl(struct vhost_dev *, unsigned int ioctl, void __user *argp);
180 long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp);
181 int vhost_vq_access_ok(struct vhost_virtqueue *vq);
182 int vhost_log_access_ok(struct vhost_dev *);
183
184 int vhost_get_vq_desc(struct vhost_virtqueue *,
185                       struct iovec iov[], unsigned int iov_count,
186                       unsigned int *out_num, unsigned int *in_num,
187                       struct vhost_log *log, unsigned int *log_num);
188 void vhost_discard_vq_desc(struct vhost_virtqueue *, int n);
189
190 int vhost_vq_init_access(struct vhost_virtqueue *);
191 int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len);
192 int vhost_add_used_n(struct vhost_virtqueue *, struct vring_used_elem *heads,
193                      unsigned count);
194 void vhost_add_used_and_signal(struct vhost_dev *, struct vhost_virtqueue *,
195                                unsigned int id, int len);
196 void vhost_add_used_and_signal_n(struct vhost_dev *, struct vhost_virtqueue *,
197                                struct vring_used_elem *heads, unsigned count);
198 void vhost_signal(struct vhost_dev *, struct vhost_virtqueue *);
199 void vhost_disable_notify(struct vhost_dev *, struct vhost_virtqueue *);
200 bool vhost_vq_avail_empty(struct vhost_dev *, struct vhost_virtqueue *);
201 bool vhost_enable_notify(struct vhost_dev *, struct vhost_virtqueue *);
202
203 int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
204                     unsigned int log_num, u64 len);
205 int vq_iotlb_prefetch(struct vhost_virtqueue *vq);
206
207 struct vhost_msg_node *vhost_new_msg(struct vhost_virtqueue *vq, int type);
208 void vhost_enqueue_msg(struct vhost_dev *dev,
209                        struct list_head *head,
210                        struct vhost_msg_node *node);
211 struct vhost_msg_node *vhost_dequeue_msg(struct vhost_dev *dev,
212                                          struct list_head *head);
213 __poll_t vhost_chr_poll(struct file *file, struct vhost_dev *dev,
214                             poll_table *wait);
215 ssize_t vhost_chr_read_iter(struct vhost_dev *dev, struct iov_iter *to,
216                             int noblock);
217 ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
218                              struct iov_iter *from);
219 int vhost_init_device_iotlb(struct vhost_dev *d, bool enabled);
220
221 #define vq_err(vq, fmt, ...) do {                                  \
222                 pr_debug(pr_fmt(fmt), ##__VA_ARGS__);       \
223                 if ((vq)->error_ctx)                               \
224                                 eventfd_signal((vq)->error_ctx, 1);\
225         } while (0)
226
227 enum {
228         VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) |
229                          (1ULL << VIRTIO_RING_F_INDIRECT_DESC) |
230                          (1ULL << VIRTIO_RING_F_EVENT_IDX) |
231                          (1ULL << VHOST_F_LOG_ALL) |
232                          (1ULL << VIRTIO_F_ANY_LAYOUT) |
233                          (1ULL << VIRTIO_F_VERSION_1)
234 };
235
236 static inline bool vhost_has_feature(struct vhost_virtqueue *vq, int bit)
237 {
238         return vq->acked_features & (1ULL << bit);
239 }
240
241 #ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
242 static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq)
243 {
244         return vq->is_le;
245 }
246 #else
247 static inline bool vhost_is_little_endian(struct vhost_virtqueue *vq)
248 {
249         return virtio_legacy_is_little_endian() || vq->is_le;
250 }
251 #endif
252
253 /* Memory accessors */
254 static inline u16 vhost16_to_cpu(struct vhost_virtqueue *vq, __virtio16 val)
255 {
256         return __virtio16_to_cpu(vhost_is_little_endian(vq), val);
257 }
258
259 static inline __virtio16 cpu_to_vhost16(struct vhost_virtqueue *vq, u16 val)
260 {
261         return __cpu_to_virtio16(vhost_is_little_endian(vq), val);
262 }
263
264 static inline u32 vhost32_to_cpu(struct vhost_virtqueue *vq, __virtio32 val)
265 {
266         return __virtio32_to_cpu(vhost_is_little_endian(vq), val);
267 }
268
269 static inline __virtio32 cpu_to_vhost32(struct vhost_virtqueue *vq, u32 val)
270 {
271         return __cpu_to_virtio32(vhost_is_little_endian(vq), val);
272 }
273
274 static inline u64 vhost64_to_cpu(struct vhost_virtqueue *vq, __virtio64 val)
275 {
276         return __virtio64_to_cpu(vhost_is_little_endian(vq), val);
277 }
278
279 static inline __virtio64 cpu_to_vhost64(struct vhost_virtqueue *vq, u64 val)
280 {
281         return __cpu_to_virtio64(vhost_is_little_endian(vq), val);
282 }
283 #endif