blob: 3eda654b8f5a0d8191060f553f3687983505edbe [file] [log] [blame]
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001#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>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00008#include <linux/poll.h>
9#include <linux/file.h>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000010#include <linux/uio.h>
11#include <linux/virtio_config.h>
12#include <linux/virtio_ring.h>
Arun Sharma600634972011-07-26 16:09:06 -070013#include <linux/atomic.h>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000014
15struct vhost_device;
16
Tejun Heoc23f34452010-06-02 20:40:00 +020017struct vhost_work;
18typedef void (*vhost_work_fn_t)(struct vhost_work *work);
19
20struct vhost_work {
21 struct list_head node;
22 vhost_work_fn_t fn;
23 wait_queue_head_t done;
24 int flushing;
25 unsigned queue_seq;
26 unsigned done_seq;
27};
28
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000029/* 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;
34 wait_queue_t wait;
Tejun Heoc23f34452010-06-02 20:40:00 +020035 struct vhost_work work;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000036 unsigned long mask;
Tejun Heoc23f34452010-06-02 20:40:00 +020037 struct vhost_dev *dev;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000038};
39
Stefan Hajnoczi163049a2012-07-21 06:55:37 +000040void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn);
41void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work);
42
Tejun Heoc23f34452010-06-02 20:40:00 +020043void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
44 unsigned long mask, struct vhost_dev *dev);
Jason Wang2b8b3282013-01-28 01:05:18 +000045int vhost_poll_start(struct vhost_poll *poll, struct file *file);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000046void vhost_poll_stop(struct vhost_poll *poll);
47void vhost_poll_flush(struct vhost_poll *poll);
48void vhost_poll_queue(struct vhost_poll *poll);
Asias He6ac1afb2013-05-06 16:38:21 +080049void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work);
50long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000051
52struct vhost_log {
53 u64 addr;
54 u64 len;
55};
56
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +000057struct vhost_virtqueue;
58
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000059/* The virtqueue structure describes a queue attached to a device. */
60struct vhost_virtqueue {
61 struct vhost_dev *dev;
62
63 /* The actual ring of buffers. */
64 struct mutex mutex;
65 unsigned int num;
66 struct vring_desc __user *desc;
67 struct vring_avail __user *avail;
68 struct vring_used __user *used;
69 struct file *kick;
70 struct file *call;
71 struct file *error;
72 struct eventfd_ctx *call_ctx;
73 struct eventfd_ctx *error_ctx;
74 struct eventfd_ctx *log_ctx;
75
76 struct vhost_poll poll;
77
78 /* The routine to call when the Guest pings us, or timeout. */
Tejun Heoc23f34452010-06-02 20:40:00 +020079 vhost_work_fn_t handle_kick;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000080
81 /* Last available index we saw. */
82 u16 last_avail_idx;
83
84 /* Caches available index value from user. */
85 u16 avail_idx;
86
87 /* Last index we used. */
88 u16 last_used_idx;
89
90 /* Used flags */
91 u16 used_flags;
92
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +030093 /* Last used index value we have signalled on */
94 u16 signalled_used;
95
96 /* Last used index value we have signalled on */
97 bool signalled_used_valid;
98
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000099 /* Log writes to used structure. */
100 bool log_used;
101 u64 log_addr;
102
Jason Wange0e9b402010-09-14 23:53:05 +0800103 struct iovec iov[UIO_MAXIOV];
Jason Wange0e9b402010-09-14 23:53:05 +0800104 struct iovec *indirect;
Jason Wange0e9b402010-09-14 23:53:05 +0800105 struct vring_used_elem *heads;
Asias He22fa90c2013-05-07 14:54:36 +0800106 /* Protected by virtqueue mutex. */
Michael S. Tsirkin47283be2014-06-05 15:20:27 +0300107 struct vhost_memory *memory;
Asias He22fa90c2013-05-07 14:54:36 +0800108 void *private_data;
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300109 unsigned acked_features;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000110 /* Log write descriptors */
111 void __user *log_base;
Jason Wange0e9b402010-09-14 23:53:05 +0800112 struct vhost_log *log;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000113};
114
115struct vhost_dev {
Michael S. Tsirkin47283be2014-06-05 15:20:27 +0300116 struct vhost_memory *memory;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000117 struct mm_struct *mm;
118 struct mutex mutex;
Asias He3ab2e422013-04-27 11:16:48 +0800119 struct vhost_virtqueue **vqs;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000120 int nvqs;
121 struct file *log_file;
122 struct eventfd_ctx *log_ctx;
Tejun Heoc23f34452010-06-02 20:40:00 +0200123 spinlock_t work_lock;
124 struct list_head work_list;
125 struct task_struct *worker;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000126};
127
Zhi Yong Wu59566b6e2013-12-07 04:13:03 +0800128void vhost_dev_init(struct vhost_dev *, struct vhost_virtqueue **vqs, int nvqs);
Asias He54db63c2013-05-06 11:15:59 +0800129long vhost_dev_set_owner(struct vhost_dev *dev);
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300130bool vhost_dev_has_owner(struct vhost_dev *dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000131long vhost_dev_check_owner(struct vhost_dev *);
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300132struct vhost_memory *vhost_dev_reset_owner_prepare(void);
133void vhost_dev_reset_owner(struct vhost_dev *, struct vhost_memory *);
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200134void vhost_dev_cleanup(struct vhost_dev *, bool locked);
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000135void vhost_dev_stop(struct vhost_dev *);
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200136long vhost_dev_ioctl(struct vhost_dev *, unsigned int ioctl, void __user *argp);
137long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000138int vhost_vq_access_ok(struct vhost_virtqueue *vq);
139int vhost_log_access_ok(struct vhost_dev *);
140
Michael S. Tsirkin47283be2014-06-05 15:20:27 +0300141int vhost_get_vq_desc(struct vhost_virtqueue *,
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +0300142 struct iovec iov[], unsigned int iov_count,
143 unsigned int *out_num, unsigned int *in_num,
144 struct vhost_log *log, unsigned int *log_num);
David Stevens8dd014a2010-07-27 18:52:21 +0300145void vhost_discard_vq_desc(struct vhost_virtqueue *, int n);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000146
Jason Wangf59281d2011-06-21 18:04:27 +0800147int vhost_init_used(struct vhost_virtqueue *);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000148int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len);
David Stevens8dd014a2010-07-27 18:52:21 +0300149int vhost_add_used_n(struct vhost_virtqueue *, struct vring_used_elem *heads,
150 unsigned count);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000151void vhost_add_used_and_signal(struct vhost_dev *, struct vhost_virtqueue *,
David Stevens8dd014a2010-07-27 18:52:21 +0300152 unsigned int id, int len);
153void vhost_add_used_and_signal_n(struct vhost_dev *, struct vhost_virtqueue *,
154 struct vring_used_elem *heads, unsigned count);
155void vhost_signal(struct vhost_dev *, struct vhost_virtqueue *);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300156void vhost_disable_notify(struct vhost_dev *, struct vhost_virtqueue *);
157bool vhost_enable_notify(struct vhost_dev *, struct vhost_virtqueue *);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000158
159int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
160 unsigned int log_num, u64 len);
161
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000162#define vq_err(vq, fmt, ...) do { \
163 pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \
164 if ((vq)->error_ctx) \
165 eventfd_signal((vq)->error_ctx, 1);\
166 } while (0)
167
168enum {
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300169 VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) |
170 (1ULL << VIRTIO_RING_F_INDIRECT_DESC) |
171 (1ULL << VIRTIO_RING_F_EVENT_IDX) |
Stefan Hajnoczi0dd05a32012-07-21 06:55:36 +0000172 (1ULL << VHOST_F_LOG_ALL),
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000173};
174
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300175static inline int vhost_has_feature(struct vhost_virtqueue *vq, int bit)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000176{
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300177 return vq->acked_features & (1 << bit);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000178}
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000179#endif