Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 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> |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 8 | #include <linux/poll.h> |
| 9 | #include <linux/file.h> |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 10 | #include <linux/uio.h> |
| 11 | #include <linux/virtio_config.h> |
| 12 | #include <linux/virtio_ring.h> |
Arun Sharma | 60063497 | 2011-07-26 16:09:06 -0700 | [diff] [blame] | 13 | #include <linux/atomic.h> |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 14 | |
| 15 | struct vhost_device; |
| 16 | |
Tejun Heo | c23f3445 | 2010-06-02 20:40:00 +0200 | [diff] [blame] | 17 | struct vhost_work; |
| 18 | typedef void (*vhost_work_fn_t)(struct vhost_work *work); |
| 19 | |
| 20 | struct 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. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 29 | /* Poll a file (eventfd or socket) */ |
| 30 | /* Note: there's nothing vhost specific about this structure. */ |
| 31 | struct vhost_poll { |
| 32 | poll_table table; |
| 33 | wait_queue_head_t *wqh; |
| 34 | wait_queue_t wait; |
Tejun Heo | c23f3445 | 2010-06-02 20:40:00 +0200 | [diff] [blame] | 35 | struct vhost_work work; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 36 | unsigned long mask; |
Tejun Heo | c23f3445 | 2010-06-02 20:40:00 +0200 | [diff] [blame] | 37 | struct vhost_dev *dev; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 38 | }; |
| 39 | |
Stefan Hajnoczi | 163049a | 2012-07-21 06:55:37 +0000 | [diff] [blame] | 40 | void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn); |
| 41 | void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work); |
| 42 | |
Tejun Heo | c23f3445 | 2010-06-02 20:40:00 +0200 | [diff] [blame] | 43 | void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn, |
| 44 | unsigned long mask, struct vhost_dev *dev); |
Jason Wang | 2b8b328 | 2013-01-28 01:05:18 +0000 | [diff] [blame] | 45 | int vhost_poll_start(struct vhost_poll *poll, struct file *file); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 46 | void vhost_poll_stop(struct vhost_poll *poll); |
| 47 | void vhost_poll_flush(struct vhost_poll *poll); |
| 48 | void vhost_poll_queue(struct vhost_poll *poll); |
Asias He | 6ac1afb | 2013-05-06 16:38:21 +0800 | [diff] [blame] | 49 | void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work); |
| 50 | long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 51 | |
| 52 | struct vhost_log { |
| 53 | u64 addr; |
| 54 | u64 len; |
| 55 | }; |
| 56 | |
Michael S. Tsirkin | bab632d | 2011-07-18 03:48:46 +0000 | [diff] [blame] | 57 | struct vhost_virtqueue; |
| 58 | |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 59 | /* The virtqueue structure describes a queue attached to a device. */ |
| 60 | struct 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 Heo | c23f3445 | 2010-06-02 20:40:00 +0200 | [diff] [blame] | 79 | vhost_work_fn_t handle_kick; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 80 | |
| 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. Tsirkin | 8ea8cf8 | 2011-05-20 02:10:54 +0300 | [diff] [blame] | 93 | /* 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. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 99 | /* Log writes to used structure. */ |
| 100 | bool log_used; |
| 101 | u64 log_addr; |
| 102 | |
Jason Wang | e0e9b40 | 2010-09-14 23:53:05 +0800 | [diff] [blame] | 103 | struct iovec iov[UIO_MAXIOV]; |
Jason Wang | e0e9b40 | 2010-09-14 23:53:05 +0800 | [diff] [blame] | 104 | struct iovec *indirect; |
Jason Wang | e0e9b40 | 2010-09-14 23:53:05 +0800 | [diff] [blame] | 105 | struct vring_used_elem *heads; |
Asias He | 22fa90c | 2013-05-07 14:54:36 +0800 | [diff] [blame] | 106 | /* Protected by virtqueue mutex. */ |
| 107 | void *private_data; |
Michael S. Tsirkin | ea16c51 | 2014-06-05 15:20:23 +0300 | [diff] [blame^] | 108 | unsigned acked_features; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 109 | /* Log write descriptors */ |
| 110 | void __user *log_base; |
Jason Wang | e0e9b40 | 2010-09-14 23:53:05 +0800 | [diff] [blame] | 111 | struct vhost_log *log; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 112 | }; |
| 113 | |
| 114 | struct vhost_dev { |
| 115 | /* Readers use RCU to access memory table pointer |
| 116 | * log base pointer and features. |
| 117 | * Writers use mutex below.*/ |
Arnd Bergmann | 28457ee | 2010-03-09 19:24:45 +0100 | [diff] [blame] | 118 | struct vhost_memory __rcu *memory; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 119 | struct mm_struct *mm; |
| 120 | struct mutex mutex; |
Asias He | 3ab2e42 | 2013-04-27 11:16:48 +0800 | [diff] [blame] | 121 | struct vhost_virtqueue **vqs; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 122 | int nvqs; |
| 123 | struct file *log_file; |
| 124 | struct eventfd_ctx *log_ctx; |
Tejun Heo | c23f3445 | 2010-06-02 20:40:00 +0200 | [diff] [blame] | 125 | spinlock_t work_lock; |
| 126 | struct list_head work_list; |
| 127 | struct task_struct *worker; |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 128 | }; |
| 129 | |
Zhi Yong Wu | 59566b6e | 2013-12-07 04:13:03 +0800 | [diff] [blame] | 130 | void vhost_dev_init(struct vhost_dev *, struct vhost_virtqueue **vqs, int nvqs); |
Asias He | 54db63c | 2013-05-06 11:15:59 +0800 | [diff] [blame] | 131 | long vhost_dev_set_owner(struct vhost_dev *dev); |
Michael S. Tsirkin | 05c0535 | 2013-06-06 15:20:39 +0300 | [diff] [blame] | 132 | bool vhost_dev_has_owner(struct vhost_dev *dev); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 133 | long vhost_dev_check_owner(struct vhost_dev *); |
Michael S. Tsirkin | 150b9e5 | 2013-04-28 17:12:08 +0300 | [diff] [blame] | 134 | struct vhost_memory *vhost_dev_reset_owner_prepare(void); |
| 135 | void vhost_dev_reset_owner(struct vhost_dev *, struct vhost_memory *); |
Michael S. Tsirkin | ea5d404 | 2011-11-27 19:05:58 +0200 | [diff] [blame] | 136 | void vhost_dev_cleanup(struct vhost_dev *, bool locked); |
Michael S. Tsirkin | b211616 | 2012-11-01 09:16:46 +0000 | [diff] [blame] | 137 | void vhost_dev_stop(struct vhost_dev *); |
Michael S. Tsirkin | 935cdee | 2012-12-06 14:03:34 +0200 | [diff] [blame] | 138 | long vhost_dev_ioctl(struct vhost_dev *, unsigned int ioctl, void __user *argp); |
| 139 | long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 140 | int vhost_vq_access_ok(struct vhost_virtqueue *vq); |
| 141 | int vhost_log_access_ok(struct vhost_dev *); |
| 142 | |
Michael S. Tsirkin | d5675bd | 2010-06-24 16:59:59 +0300 | [diff] [blame] | 143 | int vhost_get_vq_desc(struct vhost_dev *, struct vhost_virtqueue *, |
| 144 | struct iovec iov[], unsigned int iov_count, |
| 145 | unsigned int *out_num, unsigned int *in_num, |
| 146 | struct vhost_log *log, unsigned int *log_num); |
David Stevens | 8dd014a | 2010-07-27 18:52:21 +0300 | [diff] [blame] | 147 | void vhost_discard_vq_desc(struct vhost_virtqueue *, int n); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 148 | |
Jason Wang | f59281d | 2011-06-21 18:04:27 +0800 | [diff] [blame] | 149 | int vhost_init_used(struct vhost_virtqueue *); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 150 | int vhost_add_used(struct vhost_virtqueue *, unsigned int head, int len); |
David Stevens | 8dd014a | 2010-07-27 18:52:21 +0300 | [diff] [blame] | 151 | int vhost_add_used_n(struct vhost_virtqueue *, struct vring_used_elem *heads, |
| 152 | unsigned count); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 153 | void vhost_add_used_and_signal(struct vhost_dev *, struct vhost_virtqueue *, |
David Stevens | 8dd014a | 2010-07-27 18:52:21 +0300 | [diff] [blame] | 154 | unsigned int id, int len); |
| 155 | void vhost_add_used_and_signal_n(struct vhost_dev *, struct vhost_virtqueue *, |
| 156 | struct vring_used_elem *heads, unsigned count); |
| 157 | void vhost_signal(struct vhost_dev *, struct vhost_virtqueue *); |
Michael S. Tsirkin | 8ea8cf8 | 2011-05-20 02:10:54 +0300 | [diff] [blame] | 158 | void vhost_disable_notify(struct vhost_dev *, struct vhost_virtqueue *); |
| 159 | bool vhost_enable_notify(struct vhost_dev *, struct vhost_virtqueue *); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 160 | |
| 161 | int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log, |
| 162 | unsigned int log_num, u64 len); |
| 163 | |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 164 | #define vq_err(vq, fmt, ...) do { \ |
| 165 | pr_debug(pr_fmt(fmt), ##__VA_ARGS__); \ |
| 166 | if ((vq)->error_ctx) \ |
| 167 | eventfd_signal((vq)->error_ctx, 1);\ |
| 168 | } while (0) |
| 169 | |
| 170 | enum { |
Michael S. Tsirkin | 8ea8cf8 | 2011-05-20 02:10:54 +0300 | [diff] [blame] | 171 | VHOST_FEATURES = (1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | |
| 172 | (1ULL << VIRTIO_RING_F_INDIRECT_DESC) | |
| 173 | (1ULL << VIRTIO_RING_F_EVENT_IDX) | |
Stefan Hajnoczi | 0dd05a3 | 2012-07-21 06:55:36 +0000 | [diff] [blame] | 174 | (1ULL << VHOST_F_LOG_ALL), |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 175 | }; |
| 176 | |
Michael S. Tsirkin | ea16c51 | 2014-06-05 15:20:23 +0300 | [diff] [blame^] | 177 | static inline int vhost_has_feature(struct vhost_virtqueue *vq, int bit) |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 178 | { |
Michael S. Tsirkin | ea16c51 | 2014-06-05 15:20:23 +0300 | [diff] [blame^] | 179 | return vq->acked_features & (1 << bit); |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 180 | } |
Michael S. Tsirkin | 3a4d5c94e | 2010-01-14 06:17:27 +0000 | [diff] [blame] | 181 | #endif |