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