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