blob: a23870cbbf919d4cfd299156ba6a1a37cc98c5b5 [file] [log] [blame]
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001/* Copyright (C) 2009 Red Hat, Inc.
2 * Copyright (C) 2006 Rusty Russell IBM Corporation
3 *
4 * Author: Michael S. Tsirkin <mst@redhat.com>
5 *
6 * Inspiration, some code, and most witty comments come from
Rob Landley61516582011-05-06 09:27:36 -07007 * Documentation/virtual/lguest/lguest.c, by Rusty Russell
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00008 *
9 * This work is licensed under the terms of the GNU GPL, version 2.
10 *
11 * Generic code for virtio server in host kernel.
12 */
13
14#include <linux/eventfd.h>
15#include <linux/vhost.h>
Asias He35596b22013-08-19 09:23:19 +080016#include <linux/uio.h>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000017#include <linux/mm.h>
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +020018#include <linux/mmu_context.h>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000019#include <linux/miscdevice.h>
20#include <linux/mutex.h>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000021#include <linux/rcupdate.h>
22#include <linux/poll.h>
23#include <linux/file.h>
24#include <linux/highmem.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Tejun Heoc23f34452010-06-02 20:40:00 +020026#include <linux/kthread.h>
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +030027#include <linux/cgroup.h>
Asias He6ac1afb2013-05-06 16:38:21 +080028#include <linux/module.h>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000029
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000030#include "vhost.h"
31
32enum {
33 VHOST_MEMORY_MAX_NREGIONS = 64,
34 VHOST_MEMORY_F_LOG = 0x1,
35};
36
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +030037#define vhost_used_event(vq) ((u16 __user *)&vq->avail->ring[vq->num])
38#define vhost_avail_event(vq) ((u16 __user *)&vq->used->ring[vq->num])
39
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000040static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
41 poll_table *pt)
42{
43 struct vhost_poll *poll;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000044
Krishna Kumard47effe2011-03-01 17:06:37 +053045 poll = container_of(pt, struct vhost_poll, table);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000046 poll->wqh = wqh;
47 add_wait_queue(wqh, &poll->wait);
48}
49
50static int vhost_poll_wakeup(wait_queue_t *wait, unsigned mode, int sync,
51 void *key)
52{
Tejun Heoc23f34452010-06-02 20:40:00 +020053 struct vhost_poll *poll = container_of(wait, struct vhost_poll, wait);
54
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000055 if (!((unsigned long)key & poll->mask))
56 return 0;
57
Tejun Heoc23f34452010-06-02 20:40:00 +020058 vhost_poll_queue(poll);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000059 return 0;
60}
61
Stefan Hajnoczi163049a2012-07-21 06:55:37 +000062void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000063{
Tejun Heoc23f34452010-06-02 20:40:00 +020064 INIT_LIST_HEAD(&work->node);
65 work->fn = fn;
66 init_waitqueue_head(&work->done);
67 work->flushing = 0;
68 work->queue_seq = work->done_seq = 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000069}
Asias He6ac1afb2013-05-06 16:38:21 +080070EXPORT_SYMBOL_GPL(vhost_work_init);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000071
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +030072/* Init poll structure */
73void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
74 unsigned long mask, struct vhost_dev *dev)
75{
76 init_waitqueue_func_entry(&poll->wait, vhost_poll_wakeup);
77 init_poll_funcptr(&poll->table, vhost_poll_func);
78 poll->mask = mask;
79 poll->dev = dev;
Jason Wang2b8b3282013-01-28 01:05:18 +000080 poll->wqh = NULL;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +030081
82 vhost_work_init(&poll->work, fn);
83}
Asias He6ac1afb2013-05-06 16:38:21 +080084EXPORT_SYMBOL_GPL(vhost_poll_init);
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +030085
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000086/* Start polling a file. We add ourselves to file's wait queue. The caller must
87 * keep a reference to a file until after vhost_poll_stop is called. */
Jason Wang2b8b3282013-01-28 01:05:18 +000088int vhost_poll_start(struct vhost_poll *poll, struct file *file)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000089{
90 unsigned long mask;
Jason Wang2b8b3282013-01-28 01:05:18 +000091 int ret = 0;
Krishna Kumard47effe2011-03-01 17:06:37 +053092
Jason Wang70181d512013-04-10 20:50:48 +000093 if (poll->wqh)
94 return 0;
95
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000096 mask = file->f_op->poll(file, &poll->table);
97 if (mask)
98 vhost_poll_wakeup(&poll->wait, 0, 0, (void *)mask);
Jason Wang2b8b3282013-01-28 01:05:18 +000099 if (mask & POLLERR) {
100 if (poll->wqh)
101 remove_wait_queue(poll->wqh, &poll->wait);
102 ret = -EINVAL;
103 }
104
105 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000106}
Asias He6ac1afb2013-05-06 16:38:21 +0800107EXPORT_SYMBOL_GPL(vhost_poll_start);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000108
109/* Stop polling a file. After this function returns, it becomes safe to drop the
110 * file reference. You must also flush afterwards. */
111void vhost_poll_stop(struct vhost_poll *poll)
112{
Jason Wang2b8b3282013-01-28 01:05:18 +0000113 if (poll->wqh) {
114 remove_wait_queue(poll->wqh, &poll->wait);
115 poll->wqh = NULL;
116 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000117}
Asias He6ac1afb2013-05-06 16:38:21 +0800118EXPORT_SYMBOL_GPL(vhost_poll_stop);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000119
Michael S. Tsirkin0174b0c2011-01-10 10:03:20 +0200120static bool vhost_work_seq_done(struct vhost_dev *dev, struct vhost_work *work,
121 unsigned seq)
122{
123 int left;
Krishna Kumard47effe2011-03-01 17:06:37 +0530124
Michael S. Tsirkin0174b0c2011-01-10 10:03:20 +0200125 spin_lock_irq(&dev->work_lock);
126 left = seq - work->done_seq;
127 spin_unlock_irq(&dev->work_lock);
128 return left <= 0;
129}
130
Asias He6ac1afb2013-05-06 16:38:21 +0800131void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000132{
Tejun Heoc23f34452010-06-02 20:40:00 +0200133 unsigned seq;
Tejun Heoc23f34452010-06-02 20:40:00 +0200134 int flushing;
135
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300136 spin_lock_irq(&dev->work_lock);
Tejun Heoc23f34452010-06-02 20:40:00 +0200137 seq = work->queue_seq;
138 work->flushing++;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300139 spin_unlock_irq(&dev->work_lock);
Michael S. Tsirkin0174b0c2011-01-10 10:03:20 +0200140 wait_event(work->done, vhost_work_seq_done(dev, work, seq));
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300141 spin_lock_irq(&dev->work_lock);
Tejun Heoc23f34452010-06-02 20:40:00 +0200142 flushing = --work->flushing;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300143 spin_unlock_irq(&dev->work_lock);
Tejun Heoc23f34452010-06-02 20:40:00 +0200144 BUG_ON(flushing < 0);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000145}
Asias He6ac1afb2013-05-06 16:38:21 +0800146EXPORT_SYMBOL_GPL(vhost_work_flush);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000147
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300148/* Flush any work that has been scheduled. When calling this, don't hold any
149 * locks that are also used by the callback. */
150void vhost_poll_flush(struct vhost_poll *poll)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000151{
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300152 vhost_work_flush(poll->dev, &poll->work);
153}
Asias He6ac1afb2013-05-06 16:38:21 +0800154EXPORT_SYMBOL_GPL(vhost_poll_flush);
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300155
Stefan Hajnoczi163049a2012-07-21 06:55:37 +0000156void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300157{
Tejun Heoc23f34452010-06-02 20:40:00 +0200158 unsigned long flags;
159
160 spin_lock_irqsave(&dev->work_lock, flags);
161 if (list_empty(&work->node)) {
162 list_add_tail(&work->node, &dev->work_list);
163 work->queue_seq++;
Qin Chuanyuac9fde22013-06-07 21:50:16 +0800164 spin_unlock_irqrestore(&dev->work_lock, flags);
Tejun Heoc23f34452010-06-02 20:40:00 +0200165 wake_up_process(dev->worker);
Qin Chuanyuac9fde22013-06-07 21:50:16 +0800166 } else {
167 spin_unlock_irqrestore(&dev->work_lock, flags);
Tejun Heoc23f34452010-06-02 20:40:00 +0200168 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000169}
Asias He6ac1afb2013-05-06 16:38:21 +0800170EXPORT_SYMBOL_GPL(vhost_work_queue);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000171
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300172void vhost_poll_queue(struct vhost_poll *poll)
173{
174 vhost_work_queue(poll->dev, &poll->work);
175}
Asias He6ac1afb2013-05-06 16:38:21 +0800176EXPORT_SYMBOL_GPL(vhost_poll_queue);
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300177
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000178static void vhost_vq_reset(struct vhost_dev *dev,
179 struct vhost_virtqueue *vq)
180{
181 vq->num = 1;
182 vq->desc = NULL;
183 vq->avail = NULL;
184 vq->used = NULL;
185 vq->last_avail_idx = 0;
186 vq->avail_idx = 0;
187 vq->last_used_idx = 0;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300188 vq->signalled_used = 0;
189 vq->signalled_used_valid = false;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000190 vq->used_flags = 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000191 vq->log_used = false;
192 vq->log_addr = -1ull;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000193 vq->private_data = NULL;
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300194 vq->acked_features = 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000195 vq->log_base = NULL;
196 vq->error_ctx = NULL;
197 vq->error = NULL;
198 vq->kick = NULL;
199 vq->call_ctx = NULL;
200 vq->call = NULL;
Michael S. Tsirkin73a99f02010-02-23 11:23:45 +0200201 vq->log_ctx = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000202}
203
Tejun Heoc23f34452010-06-02 20:40:00 +0200204static int vhost_worker(void *data)
205{
206 struct vhost_dev *dev = data;
207 struct vhost_work *work = NULL;
208 unsigned uninitialized_var(seq);
Jens Freimannd7ffde32012-06-26 00:59:58 +0000209 mm_segment_t oldfs = get_fs();
Tejun Heoc23f34452010-06-02 20:40:00 +0200210
Jens Freimannd7ffde32012-06-26 00:59:58 +0000211 set_fs(USER_DS);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200212 use_mm(dev->mm);
213
Tejun Heoc23f34452010-06-02 20:40:00 +0200214 for (;;) {
215 /* mb paired w/ kthread_stop */
216 set_current_state(TASK_INTERRUPTIBLE);
217
218 spin_lock_irq(&dev->work_lock);
219 if (work) {
220 work->done_seq = seq;
221 if (work->flushing)
222 wake_up_all(&work->done);
223 }
224
225 if (kthread_should_stop()) {
226 spin_unlock_irq(&dev->work_lock);
227 __set_current_state(TASK_RUNNING);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200228 break;
Tejun Heoc23f34452010-06-02 20:40:00 +0200229 }
230 if (!list_empty(&dev->work_list)) {
231 work = list_first_entry(&dev->work_list,
232 struct vhost_work, node);
233 list_del_init(&work->node);
234 seq = work->queue_seq;
235 } else
236 work = NULL;
237 spin_unlock_irq(&dev->work_lock);
238
239 if (work) {
240 __set_current_state(TASK_RUNNING);
241 work->fn(work);
Nadav Har'Eld550dda2012-02-27 15:07:29 +0200242 if (need_resched())
243 schedule();
Tejun Heoc23f34452010-06-02 20:40:00 +0200244 } else
245 schedule();
246
247 }
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200248 unuse_mm(dev->mm);
Jens Freimannd7ffde32012-06-26 00:59:58 +0000249 set_fs(oldfs);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200250 return 0;
Tejun Heoc23f34452010-06-02 20:40:00 +0200251}
252
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000253static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
254{
255 kfree(vq->indirect);
256 vq->indirect = NULL;
257 kfree(vq->log);
258 vq->log = NULL;
259 kfree(vq->heads);
260 vq->heads = NULL;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000261}
262
Jason Wange0e9b402010-09-14 23:53:05 +0800263/* Helper to allocate iovec buffers for all vqs. */
264static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
265{
Asias He6d5e6aa2013-05-06 16:38:23 +0800266 struct vhost_virtqueue *vq;
Jason Wange0e9b402010-09-14 23:53:05 +0800267 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530268
Jason Wange0e9b402010-09-14 23:53:05 +0800269 for (i = 0; i < dev->nvqs; ++i) {
Asias He6d5e6aa2013-05-06 16:38:23 +0800270 vq = dev->vqs[i];
271 vq->indirect = kmalloc(sizeof *vq->indirect * UIO_MAXIOV,
272 GFP_KERNEL);
273 vq->log = kmalloc(sizeof *vq->log * UIO_MAXIOV, GFP_KERNEL);
274 vq->heads = kmalloc(sizeof *vq->heads * UIO_MAXIOV, GFP_KERNEL);
275 if (!vq->indirect || !vq->log || !vq->heads)
Jason Wange0e9b402010-09-14 23:53:05 +0800276 goto err_nomem;
277 }
278 return 0;
Krishna Kumard47effe2011-03-01 17:06:37 +0530279
Jason Wange0e9b402010-09-14 23:53:05 +0800280err_nomem:
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000281 for (; i >= 0; --i)
Asias He3ab2e422013-04-27 11:16:48 +0800282 vhost_vq_free_iovecs(dev->vqs[i]);
Jason Wange0e9b402010-09-14 23:53:05 +0800283 return -ENOMEM;
284}
285
286static void vhost_dev_free_iovecs(struct vhost_dev *dev)
287{
288 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530289
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000290 for (i = 0; i < dev->nvqs; ++i)
Asias He3ab2e422013-04-27 11:16:48 +0800291 vhost_vq_free_iovecs(dev->vqs[i]);
Jason Wange0e9b402010-09-14 23:53:05 +0800292}
293
Zhi Yong Wu59566b6e2013-12-07 04:13:03 +0800294void vhost_dev_init(struct vhost_dev *dev,
Asias He3ab2e422013-04-27 11:16:48 +0800295 struct vhost_virtqueue **vqs, int nvqs)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000296{
Asias He6d5e6aa2013-05-06 16:38:23 +0800297 struct vhost_virtqueue *vq;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000298 int i;
Tejun Heoc23f34452010-06-02 20:40:00 +0200299
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000300 dev->vqs = vqs;
301 dev->nvqs = nvqs;
302 mutex_init(&dev->mutex);
303 dev->log_ctx = NULL;
304 dev->log_file = NULL;
305 dev->memory = NULL;
306 dev->mm = NULL;
Tejun Heoc23f34452010-06-02 20:40:00 +0200307 spin_lock_init(&dev->work_lock);
308 INIT_LIST_HEAD(&dev->work_list);
309 dev->worker = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000310
311 for (i = 0; i < dev->nvqs; ++i) {
Asias He6d5e6aa2013-05-06 16:38:23 +0800312 vq = dev->vqs[i];
313 vq->log = NULL;
314 vq->indirect = NULL;
315 vq->heads = NULL;
316 vq->dev = dev;
317 mutex_init(&vq->mutex);
318 vhost_vq_reset(dev, vq);
319 if (vq->handle_kick)
320 vhost_poll_init(&vq->poll, vq->handle_kick,
321 POLLIN, dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000322 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000323}
Asias He6ac1afb2013-05-06 16:38:21 +0800324EXPORT_SYMBOL_GPL(vhost_dev_init);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000325
326/* Caller should have device mutex */
327long vhost_dev_check_owner(struct vhost_dev *dev)
328{
329 /* Are you the owner? If not, I don't think you mean to do that */
330 return dev->mm == current->mm ? 0 : -EPERM;
331}
Asias He6ac1afb2013-05-06 16:38:21 +0800332EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000333
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300334struct vhost_attach_cgroups_struct {
Krishna Kumard47effe2011-03-01 17:06:37 +0530335 struct vhost_work work;
336 struct task_struct *owner;
337 int ret;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300338};
339
340static void vhost_attach_cgroups_work(struct vhost_work *work)
341{
Krishna Kumard47effe2011-03-01 17:06:37 +0530342 struct vhost_attach_cgroups_struct *s;
343
344 s = container_of(work, struct vhost_attach_cgroups_struct, work);
345 s->ret = cgroup_attach_task_all(s->owner, current);
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300346}
347
348static int vhost_attach_cgroups(struct vhost_dev *dev)
349{
Krishna Kumard47effe2011-03-01 17:06:37 +0530350 struct vhost_attach_cgroups_struct attach;
351
352 attach.owner = current;
353 vhost_work_init(&attach.work, vhost_attach_cgroups_work);
354 vhost_work_queue(dev, &attach.work);
355 vhost_work_flush(dev, &attach.work);
356 return attach.ret;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300357}
358
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000359/* Caller should have device mutex */
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300360bool vhost_dev_has_owner(struct vhost_dev *dev)
361{
362 return dev->mm;
363}
Asias He6ac1afb2013-05-06 16:38:21 +0800364EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300365
366/* Caller should have device mutex */
Asias He54db63c2013-05-06 11:15:59 +0800367long vhost_dev_set_owner(struct vhost_dev *dev)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000368{
Tejun Heoc23f34452010-06-02 20:40:00 +0200369 struct task_struct *worker;
370 int err;
Krishna Kumard47effe2011-03-01 17:06:37 +0530371
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000372 /* Is there an owner already? */
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300373 if (vhost_dev_has_owner(dev)) {
Tejun Heoc23f34452010-06-02 20:40:00 +0200374 err = -EBUSY;
375 goto err_mm;
376 }
Krishna Kumard47effe2011-03-01 17:06:37 +0530377
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000378 /* No owner, become one */
379 dev->mm = get_task_mm(current);
Tejun Heoc23f34452010-06-02 20:40:00 +0200380 worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
381 if (IS_ERR(worker)) {
382 err = PTR_ERR(worker);
383 goto err_worker;
384 }
385
386 dev->worker = worker;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300387 wake_up_process(worker); /* avoid contributing to loadavg */
388
389 err = vhost_attach_cgroups(dev);
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +0300390 if (err)
391 goto err_cgroup;
Tejun Heoc23f34452010-06-02 20:40:00 +0200392
Jason Wange0e9b402010-09-14 23:53:05 +0800393 err = vhost_dev_alloc_iovecs(dev);
394 if (err)
395 goto err_cgroup;
396
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000397 return 0;
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +0300398err_cgroup:
399 kthread_stop(worker);
Michael S. Tsirkin615cc222010-09-02 14:16:36 +0300400 dev->worker = NULL;
Tejun Heoc23f34452010-06-02 20:40:00 +0200401err_worker:
402 if (dev->mm)
403 mmput(dev->mm);
404 dev->mm = NULL;
405err_mm:
406 return err;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000407}
Asias He6ac1afb2013-05-06 16:38:21 +0800408EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000409
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300410struct vhost_memory *vhost_dev_reset_owner_prepare(void)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000411{
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300412 return kmalloc(offsetof(struct vhost_memory, regions), GFP_KERNEL);
413}
Asias He6ac1afb2013-05-06 16:38:21 +0800414EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000415
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300416/* Caller should have device mutex */
417void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_memory *memory)
418{
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200419 vhost_dev_cleanup(dev, true);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000420
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300421 /* Restore memory to default empty mapping. */
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000422 memory->nregions = 0;
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100423 RCU_INIT_POINTER(dev->memory, memory);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000424}
Asias He6ac1afb2013-05-06 16:38:21 +0800425EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000426
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000427void vhost_dev_stop(struct vhost_dev *dev)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000428{
429 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530430
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000431 for (i = 0; i < dev->nvqs; ++i) {
Asias He3ab2e422013-04-27 11:16:48 +0800432 if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
433 vhost_poll_stop(&dev->vqs[i]->poll);
434 vhost_poll_flush(&dev->vqs[i]->poll);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000435 }
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000436 }
437}
Asias He6ac1afb2013-05-06 16:38:21 +0800438EXPORT_SYMBOL_GPL(vhost_dev_stop);
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000439
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000440/* Caller should have device mutex if and only if locked is set */
441void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
442{
443 int i;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000444
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000445 for (i = 0; i < dev->nvqs; ++i) {
Asias He3ab2e422013-04-27 11:16:48 +0800446 if (dev->vqs[i]->error_ctx)
447 eventfd_ctx_put(dev->vqs[i]->error_ctx);
448 if (dev->vqs[i]->error)
449 fput(dev->vqs[i]->error);
450 if (dev->vqs[i]->kick)
451 fput(dev->vqs[i]->kick);
452 if (dev->vqs[i]->call_ctx)
453 eventfd_ctx_put(dev->vqs[i]->call_ctx);
454 if (dev->vqs[i]->call)
455 fput(dev->vqs[i]->call);
456 vhost_vq_reset(dev, dev->vqs[i]);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000457 }
Jason Wange0e9b402010-09-14 23:53:05 +0800458 vhost_dev_free_iovecs(dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000459 if (dev->log_ctx)
460 eventfd_ctx_put(dev->log_ctx);
461 dev->log_ctx = NULL;
462 if (dev->log_file)
463 fput(dev->log_file);
464 dev->log_file = NULL;
465 /* No one will access memory at this point */
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100466 kfree(rcu_dereference_protected(dev->memory,
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200467 locked ==
468 lockdep_is_held(&dev->mutex)));
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100469 RCU_INIT_POINTER(dev->memory, NULL);
Tejun Heoc23f34452010-06-02 20:40:00 +0200470 WARN_ON(!list_empty(&dev->work_list));
Eric Dumazet78b620c2010-08-31 02:05:57 +0000471 if (dev->worker) {
472 kthread_stop(dev->worker);
473 dev->worker = NULL;
474 }
Michael S. Tsirkin533a19b2010-10-06 15:34:38 +0200475 if (dev->mm)
476 mmput(dev->mm);
477 dev->mm = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000478}
Asias He6ac1afb2013-05-06 16:38:21 +0800479EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000480
481static int log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
482{
483 u64 a = addr / VHOST_PAGE_SIZE / 8;
Krishna Kumard47effe2011-03-01 17:06:37 +0530484
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000485 /* Make sure 64 bit math will not overflow. */
486 if (a > ULONG_MAX - (unsigned long)log_base ||
487 a + (unsigned long)log_base > ULONG_MAX)
Dan Carpenter6d97e552010-10-11 19:24:19 +0200488 return 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000489
490 return access_ok(VERIFY_WRITE, log_base + a,
491 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
492}
493
494/* Caller should have vq mutex and device mutex. */
495static int vq_memory_access_ok(void __user *log_base, struct vhost_memory *mem,
496 int log_all)
497{
498 int i;
Jeff Dike179b2842010-04-07 09:59:10 -0400499
Michael S. Tsirkinf8322fb2010-05-27 12:28:03 +0300500 if (!mem)
501 return 0;
Jeff Dike179b2842010-04-07 09:59:10 -0400502
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000503 for (i = 0; i < mem->nregions; ++i) {
504 struct vhost_memory_region *m = mem->regions + i;
505 unsigned long a = m->userspace_addr;
506 if (m->memory_size > ULONG_MAX)
507 return 0;
508 else if (!access_ok(VERIFY_WRITE, (void __user *)a,
509 m->memory_size))
510 return 0;
511 else if (log_all && !log_access_ok(log_base,
512 m->guest_phys_addr,
513 m->memory_size))
514 return 0;
515 }
516 return 1;
517}
518
519/* Can we switch to this memory table? */
520/* Caller should have device mutex but not vq mutex */
521static int memory_access_ok(struct vhost_dev *d, struct vhost_memory *mem,
522 int log_all)
523{
524 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530525
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000526 for (i = 0; i < d->nvqs; ++i) {
527 int ok;
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300528 bool log;
529
Asias He3ab2e422013-04-27 11:16:48 +0800530 mutex_lock(&d->vqs[i]->mutex);
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300531 log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000532 /* If ring is inactive, will check when it's enabled. */
Asias He3ab2e422013-04-27 11:16:48 +0800533 if (d->vqs[i]->private_data)
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300534 ok = vq_memory_access_ok(d->vqs[i]->log_base, mem, log);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000535 else
536 ok = 1;
Asias He3ab2e422013-04-27 11:16:48 +0800537 mutex_unlock(&d->vqs[i]->mutex);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000538 if (!ok)
539 return 0;
540 }
541 return 1;
542}
543
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300544static int vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000545 struct vring_desc __user *desc,
546 struct vring_avail __user *avail,
547 struct vring_used __user *used)
548{
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300549 size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000550 return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
551 access_ok(VERIFY_READ, avail,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300552 sizeof *avail + num * sizeof *avail->ring + s) &&
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000553 access_ok(VERIFY_WRITE, used,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300554 sizeof *used + num * sizeof *used->ring + s);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000555}
556
557/* Can we log writes? */
558/* Caller should have device mutex but not vq mutex */
559int vhost_log_access_ok(struct vhost_dev *dev)
560{
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100561 struct vhost_memory *mp;
562
563 mp = rcu_dereference_protected(dev->memory,
564 lockdep_is_held(&dev->mutex));
565 return memory_access_ok(dev, mp, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000566}
Asias He6ac1afb2013-05-06 16:38:21 +0800567EXPORT_SYMBOL_GPL(vhost_log_access_ok);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000568
569/* Verify access for write logging. */
570/* Caller should have vq mutex and device mutex */
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300571static int vq_log_access_ok(struct vhost_virtqueue *vq,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300572 void __user *log_base)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000573{
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100574 struct vhost_memory *mp;
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300575 size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100576
577 mp = rcu_dereference_protected(vq->dev->memory,
578 lockdep_is_held(&vq->mutex));
579 return vq_memory_access_ok(log_base, mp,
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300580 vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000581 (!vq->log_used || log_access_ok(log_base, vq->log_addr,
582 sizeof *vq->used +
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300583 vq->num * sizeof *vq->used->ring + s));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000584}
585
586/* Can we start vq? */
587/* Caller should have vq mutex and device mutex */
588int vhost_vq_access_ok(struct vhost_virtqueue *vq)
589{
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300590 return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used) &&
591 vq_log_access_ok(vq, vq->log_base);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000592}
Asias He6ac1afb2013-05-06 16:38:21 +0800593EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000594
595static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
596{
597 struct vhost_memory mem, *newmem, *oldmem;
598 unsigned long size = offsetof(struct vhost_memory, regions);
Michael S. Tsirkin98f9ca02014-05-28 17:07:02 +0300599 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530600
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900601 if (copy_from_user(&mem, m, size))
602 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000603 if (mem.padding)
604 return -EOPNOTSUPP;
605 if (mem.nregions > VHOST_MEMORY_MAX_NREGIONS)
606 return -E2BIG;
607 newmem = kmalloc(size + mem.nregions * sizeof *m->regions, GFP_KERNEL);
608 if (!newmem)
609 return -ENOMEM;
610
611 memcpy(newmem, &mem, size);
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900612 if (copy_from_user(newmem->regions, m->regions,
613 mem.nregions * sizeof *m->regions)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000614 kfree(newmem);
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900615 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000616 }
617
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300618 if (!memory_access_ok(d, newmem, 0)) {
Takuya Yoshikawaa02c3782010-05-27 19:03:56 +0900619 kfree(newmem);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000620 return -EFAULT;
Takuya Yoshikawaa02c3782010-05-27 19:03:56 +0900621 }
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100622 oldmem = rcu_dereference_protected(d->memory,
623 lockdep_is_held(&d->mutex));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000624 rcu_assign_pointer(d->memory, newmem);
Michael S. Tsirkin98f9ca02014-05-28 17:07:02 +0300625
626 /* All memory accesses are done under some VQ mutex.
627 * So below is a faster equivalent of synchronize_rcu()
628 */
629 for (i = 0; i < d->nvqs; ++i) {
630 mutex_lock(&d->vqs[i]->mutex);
631 mutex_unlock(&d->vqs[i]->mutex);
632 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000633 kfree(oldmem);
634 return 0;
635}
636
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200637long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000638{
Al Virocecb46f2012-08-27 14:21:39 -0400639 struct file *eventfp, *filep = NULL;
640 bool pollstart = false, pollstop = false;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000641 struct eventfd_ctx *ctx = NULL;
642 u32 __user *idxp = argp;
643 struct vhost_virtqueue *vq;
644 struct vhost_vring_state s;
645 struct vhost_vring_file f;
646 struct vhost_vring_addr a;
647 u32 idx;
648 long r;
649
650 r = get_user(idx, idxp);
651 if (r < 0)
652 return r;
Krishna Kumar0f3d9a12010-05-25 11:10:36 +0530653 if (idx >= d->nvqs)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000654 return -ENOBUFS;
655
Asias He3ab2e422013-04-27 11:16:48 +0800656 vq = d->vqs[idx];
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000657
658 mutex_lock(&vq->mutex);
659
660 switch (ioctl) {
661 case VHOST_SET_VRING_NUM:
662 /* Resizing ring with an active backend?
663 * You don't want to do that. */
664 if (vq->private_data) {
665 r = -EBUSY;
666 break;
667 }
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900668 if (copy_from_user(&s, argp, sizeof s)) {
669 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000670 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900671 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000672 if (!s.num || s.num > 0xffff || (s.num & (s.num - 1))) {
673 r = -EINVAL;
674 break;
675 }
676 vq->num = s.num;
677 break;
678 case VHOST_SET_VRING_BASE:
679 /* Moving base with an active backend?
680 * You don't want to do that. */
681 if (vq->private_data) {
682 r = -EBUSY;
683 break;
684 }
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900685 if (copy_from_user(&s, argp, sizeof s)) {
686 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000687 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900688 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000689 if (s.num > 0xffff) {
690 r = -EINVAL;
691 break;
692 }
693 vq->last_avail_idx = s.num;
694 /* Forget the cached index value. */
695 vq->avail_idx = vq->last_avail_idx;
696 break;
697 case VHOST_GET_VRING_BASE:
698 s.index = idx;
699 s.num = vq->last_avail_idx;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900700 if (copy_to_user(argp, &s, sizeof s))
701 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000702 break;
703 case VHOST_SET_VRING_ADDR:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900704 if (copy_from_user(&a, argp, sizeof a)) {
705 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000706 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900707 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000708 if (a.flags & ~(0x1 << VHOST_VRING_F_LOG)) {
709 r = -EOPNOTSUPP;
710 break;
711 }
712 /* For 32bit, verify that the top 32bits of the user
713 data are set to zero. */
714 if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
715 (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
716 (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr) {
717 r = -EFAULT;
718 break;
719 }
720 if ((a.avail_user_addr & (sizeof *vq->avail->ring - 1)) ||
721 (a.used_user_addr & (sizeof *vq->used->ring - 1)) ||
722 (a.log_guest_addr & (sizeof *vq->used->ring - 1))) {
723 r = -EINVAL;
724 break;
725 }
726
727 /* We only verify access here if backend is configured.
728 * If it is not, we don't as size might not have been setup.
729 * We will verify when backend is configured. */
730 if (vq->private_data) {
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300731 if (!vq_access_ok(vq, vq->num,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000732 (void __user *)(unsigned long)a.desc_user_addr,
733 (void __user *)(unsigned long)a.avail_user_addr,
734 (void __user *)(unsigned long)a.used_user_addr)) {
735 r = -EINVAL;
736 break;
737 }
738
739 /* Also validate log access for used ring if enabled. */
740 if ((a.flags & (0x1 << VHOST_VRING_F_LOG)) &&
741 !log_access_ok(vq->log_base, a.log_guest_addr,
742 sizeof *vq->used +
743 vq->num * sizeof *vq->used->ring)) {
744 r = -EINVAL;
745 break;
746 }
747 }
748
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000749 vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
750 vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
751 vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
752 vq->log_addr = a.log_guest_addr;
753 vq->used = (void __user *)(unsigned long)a.used_user_addr;
754 break;
755 case VHOST_SET_VRING_KICK:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900756 if (copy_from_user(&f, argp, sizeof f)) {
757 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000758 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900759 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000760 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200761 if (IS_ERR(eventfp)) {
762 r = PTR_ERR(eventfp);
763 break;
764 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000765 if (eventfp != vq->kick) {
Al Virocecb46f2012-08-27 14:21:39 -0400766 pollstop = (filep = vq->kick) != NULL;
767 pollstart = (vq->kick = eventfp) != NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000768 } else
769 filep = eventfp;
770 break;
771 case VHOST_SET_VRING_CALL:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900772 if (copy_from_user(&f, argp, sizeof f)) {
773 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000774 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900775 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000776 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200777 if (IS_ERR(eventfp)) {
778 r = PTR_ERR(eventfp);
779 break;
780 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000781 if (eventfp != vq->call) {
782 filep = vq->call;
783 ctx = vq->call_ctx;
784 vq->call = eventfp;
785 vq->call_ctx = eventfp ?
786 eventfd_ctx_fileget(eventfp) : NULL;
787 } else
788 filep = eventfp;
789 break;
790 case VHOST_SET_VRING_ERR:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900791 if (copy_from_user(&f, argp, sizeof f)) {
792 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000793 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900794 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000795 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200796 if (IS_ERR(eventfp)) {
797 r = PTR_ERR(eventfp);
798 break;
799 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000800 if (eventfp != vq->error) {
801 filep = vq->error;
802 vq->error = eventfp;
803 ctx = vq->error_ctx;
804 vq->error_ctx = eventfp ?
805 eventfd_ctx_fileget(eventfp) : NULL;
806 } else
807 filep = eventfp;
808 break;
809 default:
810 r = -ENOIOCTLCMD;
811 }
812
813 if (pollstop && vq->handle_kick)
814 vhost_poll_stop(&vq->poll);
815
816 if (ctx)
817 eventfd_ctx_put(ctx);
818 if (filep)
819 fput(filep);
820
821 if (pollstart && vq->handle_kick)
Jason Wang2b8b3282013-01-28 01:05:18 +0000822 r = vhost_poll_start(&vq->poll, vq->kick);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000823
824 mutex_unlock(&vq->mutex);
825
826 if (pollstop && vq->handle_kick)
827 vhost_poll_flush(&vq->poll);
828 return r;
829}
Asias He6ac1afb2013-05-06 16:38:21 +0800830EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000831
832/* Caller must have device mutex */
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200833long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000834{
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000835 struct file *eventfp, *filep = NULL;
836 struct eventfd_ctx *ctx = NULL;
837 u64 p;
838 long r;
839 int i, fd;
840
841 /* If you are not the owner, you can become one */
842 if (ioctl == VHOST_SET_OWNER) {
843 r = vhost_dev_set_owner(d);
844 goto done;
845 }
846
847 /* You must be the owner to do anything else */
848 r = vhost_dev_check_owner(d);
849 if (r)
850 goto done;
851
852 switch (ioctl) {
853 case VHOST_SET_MEM_TABLE:
854 r = vhost_set_memory(d, argp);
855 break;
856 case VHOST_SET_LOG_BASE:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900857 if (copy_from_user(&p, argp, sizeof p)) {
858 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000859 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900860 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000861 if ((u64)(unsigned long)p != p) {
862 r = -EFAULT;
863 break;
864 }
865 for (i = 0; i < d->nvqs; ++i) {
866 struct vhost_virtqueue *vq;
867 void __user *base = (void __user *)(unsigned long)p;
Asias He3ab2e422013-04-27 11:16:48 +0800868 vq = d->vqs[i];
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000869 mutex_lock(&vq->mutex);
870 /* If ring is inactive, will check when it's enabled. */
Michael S. Tsirkinea16c512014-06-05 15:20:23 +0300871 if (vq->private_data && !vq_log_access_ok(vq, base))
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000872 r = -EFAULT;
873 else
874 vq->log_base = base;
875 mutex_unlock(&vq->mutex);
876 }
877 break;
878 case VHOST_SET_LOG_FD:
879 r = get_user(fd, (int __user *)argp);
880 if (r < 0)
881 break;
882 eventfp = fd == -1 ? NULL : eventfd_fget(fd);
883 if (IS_ERR(eventfp)) {
884 r = PTR_ERR(eventfp);
885 break;
886 }
887 if (eventfp != d->log_file) {
888 filep = d->log_file;
889 ctx = d->log_ctx;
890 d->log_ctx = eventfp ?
891 eventfd_ctx_fileget(eventfp) : NULL;
892 } else
893 filep = eventfp;
894 for (i = 0; i < d->nvqs; ++i) {
Asias He3ab2e422013-04-27 11:16:48 +0800895 mutex_lock(&d->vqs[i]->mutex);
896 d->vqs[i]->log_ctx = d->log_ctx;
897 mutex_unlock(&d->vqs[i]->mutex);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000898 }
899 if (ctx)
900 eventfd_ctx_put(ctx);
901 if (filep)
902 fput(filep);
903 break;
904 default:
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200905 r = -ENOIOCTLCMD;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000906 break;
907 }
908done:
909 return r;
910}
Asias He6ac1afb2013-05-06 16:38:21 +0800911EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000912
913static const struct vhost_memory_region *find_region(struct vhost_memory *mem,
914 __u64 addr, __u32 len)
915{
916 struct vhost_memory_region *reg;
917 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530918
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000919 /* linear search is not brilliant, but we really have on the order of 6
920 * regions in practice */
921 for (i = 0; i < mem->nregions; ++i) {
922 reg = mem->regions + i;
923 if (reg->guest_phys_addr <= addr &&
924 reg->guest_phys_addr + reg->memory_size - 1 >= addr)
925 return reg;
926 }
927 return NULL;
928}
929
930/* TODO: This is really inefficient. We need something like get_user()
931 * (instruction directly accesses the data, with an exception table entry
932 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
933 */
934static int set_bit_to_user(int nr, void __user *addr)
935{
936 unsigned long log = (unsigned long)addr;
937 struct page *page;
938 void *base;
939 int bit = nr + (log % PAGE_SIZE) * 8;
940 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +0530941
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000942 r = get_user_pages_fast(log, 1, 1, &page);
Michael S. Tsirkind6db3f52010-02-23 11:25:23 +0200943 if (r < 0)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000944 return r;
Michael S. Tsirkind6db3f52010-02-23 11:25:23 +0200945 BUG_ON(r != 1);
Cong Wangc6daa7f2011-11-25 23:14:26 +0800946 base = kmap_atomic(page);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000947 set_bit(bit, base);
Cong Wangc6daa7f2011-11-25 23:14:26 +0800948 kunmap_atomic(base);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000949 set_page_dirty_lock(page);
950 put_page(page);
951 return 0;
952}
953
954static int log_write(void __user *log_base,
955 u64 write_address, u64 write_length)
956{
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200957 u64 write_page = write_address / VHOST_PAGE_SIZE;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000958 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +0530959
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000960 if (!write_length)
961 return 0;
Michael S. Tsirkin3bf9be42010-11-29 10:19:07 +0200962 write_length += write_address % VHOST_PAGE_SIZE;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000963 for (;;) {
964 u64 base = (u64)(unsigned long)log_base;
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200965 u64 log = base + write_page / 8;
966 int bit = write_page % 8;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000967 if ((u64)(unsigned long)log != log)
968 return -EFAULT;
969 r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
970 if (r < 0)
971 return r;
972 if (write_length <= VHOST_PAGE_SIZE)
973 break;
974 write_length -= VHOST_PAGE_SIZE;
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200975 write_page += 1;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000976 }
977 return r;
978}
979
980int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
981 unsigned int log_num, u64 len)
982{
983 int i, r;
984
985 /* Make sure data written is seen before log. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +0000986 smp_wmb();
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000987 for (i = 0; i < log_num; ++i) {
988 u64 l = min(log[i].len, len);
989 r = log_write(vq->log_base, log[i].addr, l);
990 if (r < 0)
991 return r;
992 len -= l;
Michael S. Tsirkin5786aee2010-09-22 12:31:53 +0200993 if (!len) {
994 if (vq->log_ctx)
995 eventfd_signal(vq->log_ctx, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000996 return 0;
Michael S. Tsirkin5786aee2010-09-22 12:31:53 +0200997 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000998 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000999 /* Length written exceeds what we have stored. This is a bug. */
1000 BUG();
1001 return 0;
1002}
Asias He6ac1afb2013-05-06 16:38:21 +08001003EXPORT_SYMBOL_GPL(vhost_log_write);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001004
Jason Wang2723fea2011-06-21 18:04:38 +08001005static int vhost_update_used_flags(struct vhost_virtqueue *vq)
1006{
1007 void __user *used;
Michael S. Tsirkinb8342262011-07-19 17:15:43 +03001008 if (__put_user(vq->used_flags, &vq->used->flags) < 0)
Jason Wang2723fea2011-06-21 18:04:38 +08001009 return -EFAULT;
1010 if (unlikely(vq->log_used)) {
1011 /* Make sure the flag is seen before log. */
1012 smp_wmb();
1013 /* Log used flag write. */
1014 used = &vq->used->flags;
1015 log_write(vq->log_base, vq->log_addr +
1016 (used - (void __user *)vq->used),
1017 sizeof vq->used->flags);
1018 if (vq->log_ctx)
1019 eventfd_signal(vq->log_ctx, 1);
1020 }
1021 return 0;
1022}
1023
1024static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
1025{
Michael S. Tsirkinb8342262011-07-19 17:15:43 +03001026 if (__put_user(vq->avail_idx, vhost_avail_event(vq)))
Jason Wang2723fea2011-06-21 18:04:38 +08001027 return -EFAULT;
1028 if (unlikely(vq->log_used)) {
1029 void __user *used;
1030 /* Make sure the event is seen before log. */
1031 smp_wmb();
1032 /* Log avail event write */
1033 used = vhost_avail_event(vq);
1034 log_write(vq->log_base, vq->log_addr +
1035 (used - (void __user *)vq->used),
1036 sizeof *vhost_avail_event(vq));
1037 if (vq->log_ctx)
1038 eventfd_signal(vq->log_ctx, 1);
1039 }
1040 return 0;
1041}
1042
1043int vhost_init_used(struct vhost_virtqueue *vq)
1044{
1045 int r;
1046 if (!vq->private_data)
1047 return 0;
1048
1049 r = vhost_update_used_flags(vq);
1050 if (r)
1051 return r;
1052 vq->signalled_used_valid = false;
1053 return get_user(vq->last_used_idx, &vq->used->idx);
1054}
Asias He6ac1afb2013-05-06 16:38:21 +08001055EXPORT_SYMBOL_GPL(vhost_init_used);
Jason Wang2723fea2011-06-21 18:04:38 +08001056
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001057static int translate_desc(struct vhost_dev *dev, u64 addr, u32 len,
1058 struct iovec iov[], int iov_size)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001059{
1060 const struct vhost_memory_region *reg;
1061 struct vhost_memory *mem;
1062 struct iovec *_iov;
1063 u64 s = 0;
1064 int ret = 0;
1065
1066 rcu_read_lock();
1067
1068 mem = rcu_dereference(dev->memory);
1069 while ((u64)len > s) {
1070 u64 size;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001071 if (unlikely(ret >= iov_size)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001072 ret = -ENOBUFS;
1073 break;
1074 }
1075 reg = find_region(mem, addr, len);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001076 if (unlikely(!reg)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001077 ret = -EFAULT;
1078 break;
1079 }
1080 _iov = iov + ret;
1081 size = reg->memory_size - addr + reg->guest_phys_addr;
Michael S. Tsirkinbd971202012-11-26 05:57:27 +00001082 _iov->iov_len = min((u64)len - s, size);
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001083 _iov->iov_base = (void __user *)(unsigned long)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001084 (reg->userspace_addr + addr - reg->guest_phys_addr);
1085 s += size;
1086 addr += size;
1087 ++ret;
1088 }
1089
1090 rcu_read_unlock();
1091 return ret;
1092}
1093
1094/* Each buffer in the virtqueues is actually a chain of descriptors. This
1095 * function returns the next descriptor in the chain,
1096 * or -1U if we're at the end. */
1097static unsigned next_desc(struct vring_desc *desc)
1098{
1099 unsigned int next;
1100
1101 /* If this descriptor says it doesn't chain, we're done. */
1102 if (!(desc->flags & VRING_DESC_F_NEXT))
1103 return -1U;
1104
1105 /* Check they're not leading us off end of descriptors. */
1106 next = desc->next;
1107 /* Make sure compiler knows to grab that: we don't want it changing! */
1108 /* We will use the result as an index in an array, so most
1109 * architectures only need a compiler barrier here. */
1110 read_barrier_depends();
1111
1112 return next;
1113}
1114
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001115static int get_indirect(struct vhost_dev *dev, struct vhost_virtqueue *vq,
1116 struct iovec iov[], unsigned int iov_size,
1117 unsigned int *out_num, unsigned int *in_num,
1118 struct vhost_log *log, unsigned int *log_num,
1119 struct vring_desc *indirect)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001120{
1121 struct vring_desc desc;
1122 unsigned int i = 0, count, found = 0;
1123 int ret;
1124
1125 /* Sanity check */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001126 if (unlikely(indirect->len % sizeof desc)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001127 vq_err(vq, "Invalid length in indirect descriptor: "
1128 "len 0x%llx not multiple of 0x%zx\n",
1129 (unsigned long long)indirect->len,
1130 sizeof desc);
1131 return -EINVAL;
1132 }
1133
1134 ret = translate_desc(dev, indirect->addr, indirect->len, vq->indirect,
Jason Wange0e9b402010-09-14 23:53:05 +08001135 UIO_MAXIOV);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001136 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001137 vq_err(vq, "Translation failure %d in indirect.\n", ret);
1138 return ret;
1139 }
1140
1141 /* We will use the result as an address to read from, so most
1142 * architectures only need a compiler barrier here. */
1143 read_barrier_depends();
1144
1145 count = indirect->len / sizeof desc;
1146 /* Buffers are chained via a 16 bit next field, so
1147 * we can have at most 2^16 of these. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001148 if (unlikely(count > USHRT_MAX + 1)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001149 vq_err(vq, "Indirect buffer length too big: %d\n",
1150 indirect->len);
1151 return -E2BIG;
1152 }
1153
1154 do {
1155 unsigned iov_count = *in_num + *out_num;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001156 if (unlikely(++found > count)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001157 vq_err(vq, "Loop detected: last one at %u "
1158 "indirect size %u\n",
1159 i, count);
1160 return -EINVAL;
1161 }
Krishna Kumard47effe2011-03-01 17:06:37 +05301162 if (unlikely(memcpy_fromiovec((unsigned char *)&desc,
1163 vq->indirect, sizeof desc))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001164 vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
1165 i, (size_t)indirect->addr + i * sizeof desc);
1166 return -EINVAL;
1167 }
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001168 if (unlikely(desc.flags & VRING_DESC_F_INDIRECT)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001169 vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
1170 i, (size_t)indirect->addr + i * sizeof desc);
1171 return -EINVAL;
1172 }
1173
1174 ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
1175 iov_size - iov_count);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001176 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001177 vq_err(vq, "Translation failure %d indirect idx %d\n",
1178 ret, i);
1179 return ret;
1180 }
1181 /* If this is an input descriptor, increment that count. */
1182 if (desc.flags & VRING_DESC_F_WRITE) {
1183 *in_num += ret;
1184 if (unlikely(log)) {
1185 log[*log_num].addr = desc.addr;
1186 log[*log_num].len = desc.len;
1187 ++*log_num;
1188 }
1189 } else {
1190 /* If it's an output descriptor, they're all supposed
1191 * to come before any input descriptors. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001192 if (unlikely(*in_num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001193 vq_err(vq, "Indirect descriptor "
1194 "has out after in: idx %d\n", i);
1195 return -EINVAL;
1196 }
1197 *out_num += ret;
1198 }
1199 } while ((i = next_desc(&desc)) != -1);
1200 return 0;
1201}
1202
1203/* This looks in the virtqueue and for the first available buffer, and converts
1204 * it to an iovec for convenient access. Since descriptors consist of some
1205 * number of output then some number of input descriptors, it's actually two
1206 * iovecs, but we pack them into one and note how many of each there were.
1207 *
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001208 * This function returns the descriptor number found, or vq->num (which is
1209 * never a valid descriptor number) if none was found. A negative code is
1210 * returned on error. */
1211int vhost_get_vq_desc(struct vhost_dev *dev, struct vhost_virtqueue *vq,
1212 struct iovec iov[], unsigned int iov_size,
1213 unsigned int *out_num, unsigned int *in_num,
1214 struct vhost_log *log, unsigned int *log_num)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001215{
1216 struct vring_desc desc;
1217 unsigned int i, head, found = 0;
1218 u16 last_avail_idx;
1219 int ret;
1220
1221 /* Check it isn't doing very strange things with descriptor numbers. */
1222 last_avail_idx = vq->last_avail_idx;
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001223 if (unlikely(__get_user(vq->avail_idx, &vq->avail->idx))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001224 vq_err(vq, "Failed to access avail idx at %p\n",
1225 &vq->avail->idx);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001226 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001227 }
1228
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001229 if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001230 vq_err(vq, "Guest moved used index from %u to %u",
1231 last_avail_idx, vq->avail_idx);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001232 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001233 }
1234
1235 /* If there's nothing new since last we looked, return invalid. */
1236 if (vq->avail_idx == last_avail_idx)
1237 return vq->num;
1238
1239 /* Only get avail ring entries after they have been exposed by guest. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001240 smp_rmb();
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001241
1242 /* Grab the next descriptor number they're advertising, and increment
1243 * the index we've seen. */
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001244 if (unlikely(__get_user(head,
1245 &vq->avail->ring[last_avail_idx % vq->num]))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001246 vq_err(vq, "Failed to read head: idx %d address %p\n",
1247 last_avail_idx,
1248 &vq->avail->ring[last_avail_idx % vq->num]);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001249 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001250 }
1251
1252 /* If their number is silly, that's an error. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001253 if (unlikely(head >= vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001254 vq_err(vq, "Guest says index %u > %u is available",
1255 head, vq->num);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001256 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001257 }
1258
1259 /* When we start there are none of either input nor output. */
1260 *out_num = *in_num = 0;
1261 if (unlikely(log))
1262 *log_num = 0;
1263
1264 i = head;
1265 do {
1266 unsigned iov_count = *in_num + *out_num;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001267 if (unlikely(i >= vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001268 vq_err(vq, "Desc index is %u > %u, head = %u",
1269 i, vq->num, head);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001270 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001271 }
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001272 if (unlikely(++found > vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001273 vq_err(vq, "Loop detected: last one at %u "
1274 "vq size %u head %u\n",
1275 i, vq->num, head);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001276 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001277 }
Michael S. Tsirkinfcc042a2011-03-06 13:33:49 +02001278 ret = __copy_from_user(&desc, vq->desc + i, sizeof desc);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001279 if (unlikely(ret)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001280 vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
1281 i, vq->desc + i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001282 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001283 }
1284 if (desc.flags & VRING_DESC_F_INDIRECT) {
1285 ret = get_indirect(dev, vq, iov, iov_size,
1286 out_num, in_num,
1287 log, log_num, &desc);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001288 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001289 vq_err(vq, "Failure detected "
1290 "in indirect descriptor at idx %d\n", i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001291 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001292 }
1293 continue;
1294 }
1295
1296 ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
1297 iov_size - iov_count);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001298 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001299 vq_err(vq, "Translation failure %d descriptor idx %d\n",
1300 ret, i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001301 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001302 }
1303 if (desc.flags & VRING_DESC_F_WRITE) {
1304 /* If this is an input descriptor,
1305 * increment that count. */
1306 *in_num += ret;
1307 if (unlikely(log)) {
1308 log[*log_num].addr = desc.addr;
1309 log[*log_num].len = desc.len;
1310 ++*log_num;
1311 }
1312 } else {
1313 /* If it's an output descriptor, they're all supposed
1314 * to come before any input descriptors. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001315 if (unlikely(*in_num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001316 vq_err(vq, "Descriptor has out after in: "
1317 "idx %d\n", i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001318 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001319 }
1320 *out_num += ret;
1321 }
1322 } while ((i = next_desc(&desc)) != -1);
1323
1324 /* On success, increment avail index. */
1325 vq->last_avail_idx++;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001326
1327 /* Assume notifications from guest are disabled at this point,
1328 * if they aren't we would need to update avail_event index. */
1329 BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001330 return head;
1331}
Asias He6ac1afb2013-05-06 16:38:21 +08001332EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001333
1334/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
David Stevens8dd014a2010-07-27 18:52:21 +03001335void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001336{
David Stevens8dd014a2010-07-27 18:52:21 +03001337 vq->last_avail_idx -= n;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001338}
Asias He6ac1afb2013-05-06 16:38:21 +08001339EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001340
1341/* After we've used one of their buffers, we tell them about it. We'll then
1342 * want to notify the guest, using eventfd. */
1343int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
1344{
Jason Wangc49e4e52013-09-02 16:40:58 +08001345 struct vring_used_elem heads = { head, len };
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001346
Jason Wangc49e4e52013-09-02 16:40:58 +08001347 return vhost_add_used_n(vq, &heads, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001348}
Asias He6ac1afb2013-05-06 16:38:21 +08001349EXPORT_SYMBOL_GPL(vhost_add_used);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001350
David Stevens8dd014a2010-07-27 18:52:21 +03001351static int __vhost_add_used_n(struct vhost_virtqueue *vq,
1352 struct vring_used_elem *heads,
1353 unsigned count)
1354{
1355 struct vring_used_elem __user *used;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001356 u16 old, new;
David Stevens8dd014a2010-07-27 18:52:21 +03001357 int start;
1358
1359 start = vq->last_used_idx % vq->num;
1360 used = vq->used->ring + start;
Jason Wangc49e4e52013-09-02 16:40:58 +08001361 if (count == 1) {
1362 if (__put_user(heads[0].id, &used->id)) {
1363 vq_err(vq, "Failed to write used id");
1364 return -EFAULT;
1365 }
1366 if (__put_user(heads[0].len, &used->len)) {
1367 vq_err(vq, "Failed to write used len");
1368 return -EFAULT;
1369 }
1370 } else if (__copy_to_user(used, heads, count * sizeof *used)) {
David Stevens8dd014a2010-07-27 18:52:21 +03001371 vq_err(vq, "Failed to write used");
1372 return -EFAULT;
1373 }
1374 if (unlikely(vq->log_used)) {
1375 /* Make sure data is seen before log. */
1376 smp_wmb();
1377 /* Log used ring entry write. */
1378 log_write(vq->log_base,
1379 vq->log_addr +
1380 ((void __user *)used - (void __user *)vq->used),
1381 count * sizeof *used);
1382 }
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001383 old = vq->last_used_idx;
1384 new = (vq->last_used_idx += count);
1385 /* If the driver never bothers to signal in a very long while,
1386 * used index might wrap around. If that happens, invalidate
1387 * signalled_used index we stored. TODO: make sure driver
1388 * signals at least once in 2^16 and remove this. */
1389 if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
1390 vq->signalled_used_valid = false;
David Stevens8dd014a2010-07-27 18:52:21 +03001391 return 0;
1392}
1393
1394/* After we've used one of their buffers, we tell them about it. We'll then
1395 * want to notify the guest, using eventfd. */
1396int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
1397 unsigned count)
1398{
1399 int start, n, r;
1400
1401 start = vq->last_used_idx % vq->num;
1402 n = vq->num - start;
1403 if (n < count) {
1404 r = __vhost_add_used_n(vq, heads, n);
1405 if (r < 0)
1406 return r;
1407 heads += n;
1408 count -= n;
1409 }
1410 r = __vhost_add_used_n(vq, heads, count);
1411
1412 /* Make sure buffer is written before we update index. */
1413 smp_wmb();
1414 if (put_user(vq->last_used_idx, &vq->used->idx)) {
1415 vq_err(vq, "Failed to increment used idx");
1416 return -EFAULT;
1417 }
1418 if (unlikely(vq->log_used)) {
1419 /* Log used index update. */
1420 log_write(vq->log_base,
1421 vq->log_addr + offsetof(struct vring_used, idx),
1422 sizeof vq->used->idx);
1423 if (vq->log_ctx)
1424 eventfd_signal(vq->log_ctx, 1);
1425 }
1426 return r;
1427}
Asias He6ac1afb2013-05-06 16:38:21 +08001428EXPORT_SYMBOL_GPL(vhost_add_used_n);
David Stevens8dd014a2010-07-27 18:52:21 +03001429
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001430static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001431{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001432 __u16 old, new, event;
1433 bool v;
Michael S. Tsirkin0d499352010-05-11 19:44:17 +03001434 /* Flush out used index updates. This is paired
1435 * with the barrier that the Guest executes when enabling
1436 * interrupts. */
1437 smp_mb();
1438
Michael S. Tsirkinea16c512014-06-05 15:20:23 +03001439 if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001440 unlikely(vq->avail_idx == vq->last_avail_idx))
1441 return true;
1442
Michael S. Tsirkinea16c512014-06-05 15:20:23 +03001443 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001444 __u16 flags;
1445 if (__get_user(flags, &vq->avail->flags)) {
1446 vq_err(vq, "Failed to get flags");
1447 return true;
1448 }
1449 return !(flags & VRING_AVAIL_F_NO_INTERRUPT);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001450 }
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001451 old = vq->signalled_used;
1452 v = vq->signalled_used_valid;
1453 new = vq->signalled_used = vq->last_used_idx;
1454 vq->signalled_used_valid = true;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001455
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001456 if (unlikely(!v))
1457 return true;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001458
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001459 if (get_user(event, vhost_used_event(vq))) {
1460 vq_err(vq, "Failed to get used event idx");
1461 return true;
1462 }
1463 return vring_need_event(event, new, old);
1464}
1465
1466/* This actually signals the guest, using eventfd. */
1467void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
1468{
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001469 /* Signal the Guest tell them we used something up. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001470 if (vq->call_ctx && vhost_notify(dev, vq))
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001471 eventfd_signal(vq->call_ctx, 1);
1472}
Asias He6ac1afb2013-05-06 16:38:21 +08001473EXPORT_SYMBOL_GPL(vhost_signal);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001474
1475/* And here's the combo meal deal. Supersize me! */
1476void vhost_add_used_and_signal(struct vhost_dev *dev,
1477 struct vhost_virtqueue *vq,
1478 unsigned int head, int len)
1479{
1480 vhost_add_used(vq, head, len);
1481 vhost_signal(dev, vq);
1482}
Asias He6ac1afb2013-05-06 16:38:21 +08001483EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001484
David Stevens8dd014a2010-07-27 18:52:21 +03001485/* multi-buffer version of vhost_add_used_and_signal */
1486void vhost_add_used_and_signal_n(struct vhost_dev *dev,
1487 struct vhost_virtqueue *vq,
1488 struct vring_used_elem *heads, unsigned count)
1489{
1490 vhost_add_used_n(vq, heads, count);
1491 vhost_signal(dev, vq);
1492}
Asias He6ac1afb2013-05-06 16:38:21 +08001493EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
David Stevens8dd014a2010-07-27 18:52:21 +03001494
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001495/* OK, now we need to know about added descriptors. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001496bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001497{
1498 u16 avail_idx;
1499 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +05301500
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001501 if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
1502 return false;
1503 vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
Michael S. Tsirkinea16c512014-06-05 15:20:23 +03001504 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
Jason Wang2723fea2011-06-21 18:04:38 +08001505 r = vhost_update_used_flags(vq);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001506 if (r) {
1507 vq_err(vq, "Failed to enable notification at %p: %d\n",
1508 &vq->used->flags, r);
1509 return false;
1510 }
1511 } else {
Jason Wang2723fea2011-06-21 18:04:38 +08001512 r = vhost_update_avail_event(vq, vq->avail_idx);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001513 if (r) {
1514 vq_err(vq, "Failed to update avail event index at %p: %d\n",
1515 vhost_avail_event(vq), r);
1516 return false;
1517 }
1518 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001519 /* They could have slipped one in as we were doing that: make
1520 * sure it's written, then check again. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001521 smp_mb();
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001522 r = __get_user(avail_idx, &vq->avail->idx);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001523 if (r) {
1524 vq_err(vq, "Failed to check avail idx at %p: %d\n",
1525 &vq->avail->idx, r);
1526 return false;
1527 }
1528
David Stevens8dd014a2010-07-27 18:52:21 +03001529 return avail_idx != vq->avail_idx;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001530}
Asias He6ac1afb2013-05-06 16:38:21 +08001531EXPORT_SYMBOL_GPL(vhost_enable_notify);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001532
1533/* We don't need to be notified again. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001534void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001535{
1536 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +05301537
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001538 if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
1539 return;
1540 vq->used_flags |= VRING_USED_F_NO_NOTIFY;
Michael S. Tsirkinea16c512014-06-05 15:20:23 +03001541 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
Jason Wang2723fea2011-06-21 18:04:38 +08001542 r = vhost_update_used_flags(vq);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001543 if (r)
1544 vq_err(vq, "Failed to enable notification at %p: %d\n",
1545 &vq->used->flags, r);
1546 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001547}
Asias He6ac1afb2013-05-06 16:38:21 +08001548EXPORT_SYMBOL_GPL(vhost_disable_notify);
1549
1550static int __init vhost_init(void)
1551{
1552 return 0;
1553}
1554
1555static void __exit vhost_exit(void)
1556{
1557}
1558
1559module_init(vhost_init);
1560module_exit(vhost_exit);
1561
1562MODULE_VERSION("0.0.1");
1563MODULE_LICENSE("GPL v2");
1564MODULE_AUTHOR("Michael S. Tsirkin");
1565MODULE_DESCRIPTION("Host kernel accelerator for virtio");