blob: 78987e481bc6a3e578f1ea5789802ae9b1ae7045 [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;
194 vq->log_base = NULL;
195 vq->error_ctx = NULL;
196 vq->error = NULL;
197 vq->kick = NULL;
198 vq->call_ctx = NULL;
199 vq->call = NULL;
Michael S. Tsirkin73a99f02010-02-23 11:23:45 +0200200 vq->log_ctx = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000201}
202
Tejun Heoc23f34452010-06-02 20:40:00 +0200203static int vhost_worker(void *data)
204{
205 struct vhost_dev *dev = data;
206 struct vhost_work *work = NULL;
207 unsigned uninitialized_var(seq);
Jens Freimannd7ffde32012-06-26 00:59:58 +0000208 mm_segment_t oldfs = get_fs();
Tejun Heoc23f34452010-06-02 20:40:00 +0200209
Jens Freimannd7ffde32012-06-26 00:59:58 +0000210 set_fs(USER_DS);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200211 use_mm(dev->mm);
212
Tejun Heoc23f34452010-06-02 20:40:00 +0200213 for (;;) {
214 /* mb paired w/ kthread_stop */
215 set_current_state(TASK_INTERRUPTIBLE);
216
217 spin_lock_irq(&dev->work_lock);
218 if (work) {
219 work->done_seq = seq;
220 if (work->flushing)
221 wake_up_all(&work->done);
222 }
223
224 if (kthread_should_stop()) {
225 spin_unlock_irq(&dev->work_lock);
226 __set_current_state(TASK_RUNNING);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200227 break;
Tejun Heoc23f34452010-06-02 20:40:00 +0200228 }
229 if (!list_empty(&dev->work_list)) {
230 work = list_first_entry(&dev->work_list,
231 struct vhost_work, node);
232 list_del_init(&work->node);
233 seq = work->queue_seq;
234 } else
235 work = NULL;
236 spin_unlock_irq(&dev->work_lock);
237
238 if (work) {
239 __set_current_state(TASK_RUNNING);
240 work->fn(work);
Nadav Har'Eld550dda2012-02-27 15:07:29 +0200241 if (need_resched())
242 schedule();
Tejun Heoc23f34452010-06-02 20:40:00 +0200243 } else
244 schedule();
245
246 }
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200247 unuse_mm(dev->mm);
Jens Freimannd7ffde32012-06-26 00:59:58 +0000248 set_fs(oldfs);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200249 return 0;
Tejun Heoc23f34452010-06-02 20:40:00 +0200250}
251
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000252static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
253{
254 kfree(vq->indirect);
255 vq->indirect = NULL;
256 kfree(vq->log);
257 vq->log = NULL;
258 kfree(vq->heads);
259 vq->heads = NULL;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000260}
261
Jason Wange0e9b402010-09-14 23:53:05 +0800262/* Helper to allocate iovec buffers for all vqs. */
263static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
264{
Asias He6d5e6aa2013-05-06 16:38:23 +0800265 struct vhost_virtqueue *vq;
Jason Wange0e9b402010-09-14 23:53:05 +0800266 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530267
Jason Wange0e9b402010-09-14 23:53:05 +0800268 for (i = 0; i < dev->nvqs; ++i) {
Asias He6d5e6aa2013-05-06 16:38:23 +0800269 vq = dev->vqs[i];
270 vq->indirect = kmalloc(sizeof *vq->indirect * UIO_MAXIOV,
271 GFP_KERNEL);
272 vq->log = kmalloc(sizeof *vq->log * UIO_MAXIOV, GFP_KERNEL);
273 vq->heads = kmalloc(sizeof *vq->heads * UIO_MAXIOV, GFP_KERNEL);
274 if (!vq->indirect || !vq->log || !vq->heads)
Jason Wange0e9b402010-09-14 23:53:05 +0800275 goto err_nomem;
276 }
277 return 0;
Krishna Kumard47effe2011-03-01 17:06:37 +0530278
Jason Wange0e9b402010-09-14 23:53:05 +0800279err_nomem:
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000280 for (; i >= 0; --i)
Asias He3ab2e422013-04-27 11:16:48 +0800281 vhost_vq_free_iovecs(dev->vqs[i]);
Jason Wange0e9b402010-09-14 23:53:05 +0800282 return -ENOMEM;
283}
284
285static void vhost_dev_free_iovecs(struct vhost_dev *dev)
286{
287 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530288
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000289 for (i = 0; i < dev->nvqs; ++i)
Asias He3ab2e422013-04-27 11:16:48 +0800290 vhost_vq_free_iovecs(dev->vqs[i]);
Jason Wange0e9b402010-09-14 23:53:05 +0800291}
292
Zhi Yong Wu59566b6e2013-12-07 04:13:03 +0800293void vhost_dev_init(struct vhost_dev *dev,
Asias He3ab2e422013-04-27 11:16:48 +0800294 struct vhost_virtqueue **vqs, int nvqs)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000295{
Asias He6d5e6aa2013-05-06 16:38:23 +0800296 struct vhost_virtqueue *vq;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000297 int i;
Tejun Heoc23f34452010-06-02 20:40:00 +0200298
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000299 dev->vqs = vqs;
300 dev->nvqs = nvqs;
301 mutex_init(&dev->mutex);
302 dev->log_ctx = NULL;
303 dev->log_file = NULL;
304 dev->memory = NULL;
305 dev->mm = NULL;
Tejun Heoc23f34452010-06-02 20:40:00 +0200306 spin_lock_init(&dev->work_lock);
307 INIT_LIST_HEAD(&dev->work_list);
308 dev->worker = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000309
310 for (i = 0; i < dev->nvqs; ++i) {
Asias He6d5e6aa2013-05-06 16:38:23 +0800311 vq = dev->vqs[i];
312 vq->log = NULL;
313 vq->indirect = NULL;
314 vq->heads = NULL;
315 vq->dev = dev;
316 mutex_init(&vq->mutex);
317 vhost_vq_reset(dev, vq);
318 if (vq->handle_kick)
319 vhost_poll_init(&vq->poll, vq->handle_kick,
320 POLLIN, dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000321 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000322}
Asias He6ac1afb2013-05-06 16:38:21 +0800323EXPORT_SYMBOL_GPL(vhost_dev_init);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000324
325/* Caller should have device mutex */
326long vhost_dev_check_owner(struct vhost_dev *dev)
327{
328 /* Are you the owner? If not, I don't think you mean to do that */
329 return dev->mm == current->mm ? 0 : -EPERM;
330}
Asias He6ac1afb2013-05-06 16:38:21 +0800331EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000332
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300333struct vhost_attach_cgroups_struct {
Krishna Kumard47effe2011-03-01 17:06:37 +0530334 struct vhost_work work;
335 struct task_struct *owner;
336 int ret;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300337};
338
339static void vhost_attach_cgroups_work(struct vhost_work *work)
340{
Krishna Kumard47effe2011-03-01 17:06:37 +0530341 struct vhost_attach_cgroups_struct *s;
342
343 s = container_of(work, struct vhost_attach_cgroups_struct, work);
344 s->ret = cgroup_attach_task_all(s->owner, current);
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300345}
346
347static int vhost_attach_cgroups(struct vhost_dev *dev)
348{
Krishna Kumard47effe2011-03-01 17:06:37 +0530349 struct vhost_attach_cgroups_struct attach;
350
351 attach.owner = current;
352 vhost_work_init(&attach.work, vhost_attach_cgroups_work);
353 vhost_work_queue(dev, &attach.work);
354 vhost_work_flush(dev, &attach.work);
355 return attach.ret;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300356}
357
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000358/* Caller should have device mutex */
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300359bool vhost_dev_has_owner(struct vhost_dev *dev)
360{
361 return dev->mm;
362}
Asias He6ac1afb2013-05-06 16:38:21 +0800363EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300364
365/* Caller should have device mutex */
Asias He54db63c2013-05-06 11:15:59 +0800366long vhost_dev_set_owner(struct vhost_dev *dev)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000367{
Tejun Heoc23f34452010-06-02 20:40:00 +0200368 struct task_struct *worker;
369 int err;
Krishna Kumard47effe2011-03-01 17:06:37 +0530370
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000371 /* Is there an owner already? */
Michael S. Tsirkin05c05352013-06-06 15:20:39 +0300372 if (vhost_dev_has_owner(dev)) {
Tejun Heoc23f34452010-06-02 20:40:00 +0200373 err = -EBUSY;
374 goto err_mm;
375 }
Krishna Kumard47effe2011-03-01 17:06:37 +0530376
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000377 /* No owner, become one */
378 dev->mm = get_task_mm(current);
Tejun Heoc23f34452010-06-02 20:40:00 +0200379 worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
380 if (IS_ERR(worker)) {
381 err = PTR_ERR(worker);
382 goto err_worker;
383 }
384
385 dev->worker = worker;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300386 wake_up_process(worker); /* avoid contributing to loadavg */
387
388 err = vhost_attach_cgroups(dev);
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +0300389 if (err)
390 goto err_cgroup;
Tejun Heoc23f34452010-06-02 20:40:00 +0200391
Jason Wange0e9b402010-09-14 23:53:05 +0800392 err = vhost_dev_alloc_iovecs(dev);
393 if (err)
394 goto err_cgroup;
395
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000396 return 0;
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +0300397err_cgroup:
398 kthread_stop(worker);
Michael S. Tsirkin615cc222010-09-02 14:16:36 +0300399 dev->worker = NULL;
Tejun Heoc23f34452010-06-02 20:40:00 +0200400err_worker:
401 if (dev->mm)
402 mmput(dev->mm);
403 dev->mm = NULL;
404err_mm:
405 return err;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000406}
Asias He6ac1afb2013-05-06 16:38:21 +0800407EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000408
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300409struct vhost_memory *vhost_dev_reset_owner_prepare(void)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000410{
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300411 return kmalloc(offsetof(struct vhost_memory, regions), GFP_KERNEL);
412}
Asias He6ac1afb2013-05-06 16:38:21 +0800413EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000414
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300415/* Caller should have device mutex */
416void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_memory *memory)
417{
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200418 vhost_dev_cleanup(dev, true);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000419
Michael S. Tsirkin150b9e52013-04-28 17:12:08 +0300420 /* Restore memory to default empty mapping. */
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000421 memory->nregions = 0;
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100422 RCU_INIT_POINTER(dev->memory, memory);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000423}
Asias He6ac1afb2013-05-06 16:38:21 +0800424EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000425
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000426void vhost_dev_stop(struct vhost_dev *dev)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000427{
428 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530429
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000430 for (i = 0; i < dev->nvqs; ++i) {
Asias He3ab2e422013-04-27 11:16:48 +0800431 if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
432 vhost_poll_stop(&dev->vqs[i]->poll);
433 vhost_poll_flush(&dev->vqs[i]->poll);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000434 }
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000435 }
436}
Asias He6ac1afb2013-05-06 16:38:21 +0800437EXPORT_SYMBOL_GPL(vhost_dev_stop);
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000438
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000439/* Caller should have device mutex if and only if locked is set */
440void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
441{
442 int i;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000443
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000444 for (i = 0; i < dev->nvqs; ++i) {
Asias He3ab2e422013-04-27 11:16:48 +0800445 if (dev->vqs[i]->error_ctx)
446 eventfd_ctx_put(dev->vqs[i]->error_ctx);
447 if (dev->vqs[i]->error)
448 fput(dev->vqs[i]->error);
449 if (dev->vqs[i]->kick)
450 fput(dev->vqs[i]->kick);
451 if (dev->vqs[i]->call_ctx)
452 eventfd_ctx_put(dev->vqs[i]->call_ctx);
453 if (dev->vqs[i]->call)
454 fput(dev->vqs[i]->call);
455 vhost_vq_reset(dev, dev->vqs[i]);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000456 }
Jason Wange0e9b402010-09-14 23:53:05 +0800457 vhost_dev_free_iovecs(dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000458 if (dev->log_ctx)
459 eventfd_ctx_put(dev->log_ctx);
460 dev->log_ctx = NULL;
461 if (dev->log_file)
462 fput(dev->log_file);
463 dev->log_file = NULL;
464 /* No one will access memory at this point */
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100465 kfree(rcu_dereference_protected(dev->memory,
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200466 locked ==
467 lockdep_is_held(&dev->mutex)));
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100468 RCU_INIT_POINTER(dev->memory, NULL);
Tejun Heoc23f34452010-06-02 20:40:00 +0200469 WARN_ON(!list_empty(&dev->work_list));
Eric Dumazet78b620c2010-08-31 02:05:57 +0000470 if (dev->worker) {
471 kthread_stop(dev->worker);
472 dev->worker = NULL;
473 }
Michael S. Tsirkin533a19b2010-10-06 15:34:38 +0200474 if (dev->mm)
475 mmput(dev->mm);
476 dev->mm = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000477}
Asias He6ac1afb2013-05-06 16:38:21 +0800478EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000479
480static int log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
481{
482 u64 a = addr / VHOST_PAGE_SIZE / 8;
Krishna Kumard47effe2011-03-01 17:06:37 +0530483
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000484 /* Make sure 64 bit math will not overflow. */
485 if (a > ULONG_MAX - (unsigned long)log_base ||
486 a + (unsigned long)log_base > ULONG_MAX)
Dan Carpenter6d97e552010-10-11 19:24:19 +0200487 return 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000488
489 return access_ok(VERIFY_WRITE, log_base + a,
490 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
491}
492
493/* Caller should have vq mutex and device mutex. */
494static int vq_memory_access_ok(void __user *log_base, struct vhost_memory *mem,
495 int log_all)
496{
497 int i;
Jeff Dike179b2842010-04-07 09:59:10 -0400498
Michael S. Tsirkinf8322fb2010-05-27 12:28:03 +0300499 if (!mem)
500 return 0;
Jeff Dike179b2842010-04-07 09:59:10 -0400501
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000502 for (i = 0; i < mem->nregions; ++i) {
503 struct vhost_memory_region *m = mem->regions + i;
504 unsigned long a = m->userspace_addr;
505 if (m->memory_size > ULONG_MAX)
506 return 0;
507 else if (!access_ok(VERIFY_WRITE, (void __user *)a,
508 m->memory_size))
509 return 0;
510 else if (log_all && !log_access_ok(log_base,
511 m->guest_phys_addr,
512 m->memory_size))
513 return 0;
514 }
515 return 1;
516}
517
518/* Can we switch to this memory table? */
519/* Caller should have device mutex but not vq mutex */
520static int memory_access_ok(struct vhost_dev *d, struct vhost_memory *mem,
521 int log_all)
522{
523 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530524
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000525 for (i = 0; i < d->nvqs; ++i) {
526 int ok;
Asias He3ab2e422013-04-27 11:16:48 +0800527 mutex_lock(&d->vqs[i]->mutex);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000528 /* If ring is inactive, will check when it's enabled. */
Asias He3ab2e422013-04-27 11:16:48 +0800529 if (d->vqs[i]->private_data)
530 ok = vq_memory_access_ok(d->vqs[i]->log_base, mem,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000531 log_all);
532 else
533 ok = 1;
Asias He3ab2e422013-04-27 11:16:48 +0800534 mutex_unlock(&d->vqs[i]->mutex);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000535 if (!ok)
536 return 0;
537 }
538 return 1;
539}
540
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300541static int vq_access_ok(struct vhost_dev *d, unsigned int num,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000542 struct vring_desc __user *desc,
543 struct vring_avail __user *avail,
544 struct vring_used __user *used)
545{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300546 size_t s = vhost_has_feature(d, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000547 return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
548 access_ok(VERIFY_READ, avail,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300549 sizeof *avail + num * sizeof *avail->ring + s) &&
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000550 access_ok(VERIFY_WRITE, used,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300551 sizeof *used + num * sizeof *used->ring + s);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000552}
553
554/* Can we log writes? */
555/* Caller should have device mutex but not vq mutex */
556int vhost_log_access_ok(struct vhost_dev *dev)
557{
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100558 struct vhost_memory *mp;
559
560 mp = rcu_dereference_protected(dev->memory,
561 lockdep_is_held(&dev->mutex));
562 return memory_access_ok(dev, mp, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000563}
Asias He6ac1afb2013-05-06 16:38:21 +0800564EXPORT_SYMBOL_GPL(vhost_log_access_ok);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000565
566/* Verify access for write logging. */
567/* Caller should have vq mutex and device mutex */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300568static int vq_log_access_ok(struct vhost_dev *d, struct vhost_virtqueue *vq,
569 void __user *log_base)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000570{
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100571 struct vhost_memory *mp;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300572 size_t s = vhost_has_feature(d, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100573
574 mp = rcu_dereference_protected(vq->dev->memory,
575 lockdep_is_held(&vq->mutex));
576 return vq_memory_access_ok(log_base, mp,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000577 vhost_has_feature(vq->dev, VHOST_F_LOG_ALL)) &&
578 (!vq->log_used || log_access_ok(log_base, vq->log_addr,
579 sizeof *vq->used +
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300580 vq->num * sizeof *vq->used->ring + s));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000581}
582
583/* Can we start vq? */
584/* Caller should have vq mutex and device mutex */
585int vhost_vq_access_ok(struct vhost_virtqueue *vq)
586{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300587 return vq_access_ok(vq->dev, vq->num, vq->desc, vq->avail, vq->used) &&
588 vq_log_access_ok(vq->dev, vq, vq->log_base);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000589}
Asias He6ac1afb2013-05-06 16:38:21 +0800590EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000591
592static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
593{
594 struct vhost_memory mem, *newmem, *oldmem;
595 unsigned long size = offsetof(struct vhost_memory, regions);
Krishna Kumard47effe2011-03-01 17:06:37 +0530596
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900597 if (copy_from_user(&mem, m, size))
598 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000599 if (mem.padding)
600 return -EOPNOTSUPP;
601 if (mem.nregions > VHOST_MEMORY_MAX_NREGIONS)
602 return -E2BIG;
603 newmem = kmalloc(size + mem.nregions * sizeof *m->regions, GFP_KERNEL);
604 if (!newmem)
605 return -ENOMEM;
606
607 memcpy(newmem, &mem, size);
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900608 if (copy_from_user(newmem->regions, m->regions,
609 mem.nregions * sizeof *m->regions)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000610 kfree(newmem);
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900611 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000612 }
613
Krishna Kumard47effe2011-03-01 17:06:37 +0530614 if (!memory_access_ok(d, newmem,
615 vhost_has_feature(d, VHOST_F_LOG_ALL))) {
Takuya Yoshikawaa02c3782010-05-27 19:03:56 +0900616 kfree(newmem);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000617 return -EFAULT;
Takuya Yoshikawaa02c3782010-05-27 19:03:56 +0900618 }
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100619 oldmem = rcu_dereference_protected(d->memory,
620 lockdep_is_held(&d->mutex));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000621 rcu_assign_pointer(d->memory, newmem);
622 synchronize_rcu();
623 kfree(oldmem);
624 return 0;
625}
626
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200627long vhost_vring_ioctl(struct vhost_dev *d, int ioctl, void __user *argp)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000628{
Al Virocecb46f2012-08-27 14:21:39 -0400629 struct file *eventfp, *filep = NULL;
630 bool pollstart = false, pollstop = false;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000631 struct eventfd_ctx *ctx = NULL;
632 u32 __user *idxp = argp;
633 struct vhost_virtqueue *vq;
634 struct vhost_vring_state s;
635 struct vhost_vring_file f;
636 struct vhost_vring_addr a;
637 u32 idx;
638 long r;
639
640 r = get_user(idx, idxp);
641 if (r < 0)
642 return r;
Krishna Kumar0f3d9a12010-05-25 11:10:36 +0530643 if (idx >= d->nvqs)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000644 return -ENOBUFS;
645
Asias He3ab2e422013-04-27 11:16:48 +0800646 vq = d->vqs[idx];
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000647
648 mutex_lock(&vq->mutex);
649
650 switch (ioctl) {
651 case VHOST_SET_VRING_NUM:
652 /* Resizing ring with an active backend?
653 * You don't want to do that. */
654 if (vq->private_data) {
655 r = -EBUSY;
656 break;
657 }
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900658 if (copy_from_user(&s, argp, sizeof s)) {
659 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000660 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900661 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000662 if (!s.num || s.num > 0xffff || (s.num & (s.num - 1))) {
663 r = -EINVAL;
664 break;
665 }
666 vq->num = s.num;
667 break;
668 case VHOST_SET_VRING_BASE:
669 /* Moving base with an active backend?
670 * You don't want to do that. */
671 if (vq->private_data) {
672 r = -EBUSY;
673 break;
674 }
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900675 if (copy_from_user(&s, argp, sizeof s)) {
676 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000677 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900678 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000679 if (s.num > 0xffff) {
680 r = -EINVAL;
681 break;
682 }
683 vq->last_avail_idx = s.num;
684 /* Forget the cached index value. */
685 vq->avail_idx = vq->last_avail_idx;
686 break;
687 case VHOST_GET_VRING_BASE:
688 s.index = idx;
689 s.num = vq->last_avail_idx;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900690 if (copy_to_user(argp, &s, sizeof s))
691 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000692 break;
693 case VHOST_SET_VRING_ADDR:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900694 if (copy_from_user(&a, argp, sizeof a)) {
695 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000696 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900697 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000698 if (a.flags & ~(0x1 << VHOST_VRING_F_LOG)) {
699 r = -EOPNOTSUPP;
700 break;
701 }
702 /* For 32bit, verify that the top 32bits of the user
703 data are set to zero. */
704 if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
705 (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
706 (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr) {
707 r = -EFAULT;
708 break;
709 }
710 if ((a.avail_user_addr & (sizeof *vq->avail->ring - 1)) ||
711 (a.used_user_addr & (sizeof *vq->used->ring - 1)) ||
712 (a.log_guest_addr & (sizeof *vq->used->ring - 1))) {
713 r = -EINVAL;
714 break;
715 }
716
717 /* We only verify access here if backend is configured.
718 * If it is not, we don't as size might not have been setup.
719 * We will verify when backend is configured. */
720 if (vq->private_data) {
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300721 if (!vq_access_ok(d, vq->num,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000722 (void __user *)(unsigned long)a.desc_user_addr,
723 (void __user *)(unsigned long)a.avail_user_addr,
724 (void __user *)(unsigned long)a.used_user_addr)) {
725 r = -EINVAL;
726 break;
727 }
728
729 /* Also validate log access for used ring if enabled. */
730 if ((a.flags & (0x1 << VHOST_VRING_F_LOG)) &&
731 !log_access_ok(vq->log_base, a.log_guest_addr,
732 sizeof *vq->used +
733 vq->num * sizeof *vq->used->ring)) {
734 r = -EINVAL;
735 break;
736 }
737 }
738
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000739 vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
740 vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
741 vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
742 vq->log_addr = a.log_guest_addr;
743 vq->used = (void __user *)(unsigned long)a.used_user_addr;
744 break;
745 case VHOST_SET_VRING_KICK:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900746 if (copy_from_user(&f, argp, sizeof f)) {
747 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000748 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900749 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000750 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200751 if (IS_ERR(eventfp)) {
752 r = PTR_ERR(eventfp);
753 break;
754 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000755 if (eventfp != vq->kick) {
Al Virocecb46f2012-08-27 14:21:39 -0400756 pollstop = (filep = vq->kick) != NULL;
757 pollstart = (vq->kick = eventfp) != NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000758 } else
759 filep = eventfp;
760 break;
761 case VHOST_SET_VRING_CALL:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900762 if (copy_from_user(&f, argp, sizeof f)) {
763 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000764 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900765 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000766 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200767 if (IS_ERR(eventfp)) {
768 r = PTR_ERR(eventfp);
769 break;
770 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000771 if (eventfp != vq->call) {
772 filep = vq->call;
773 ctx = vq->call_ctx;
774 vq->call = eventfp;
775 vq->call_ctx = eventfp ?
776 eventfd_ctx_fileget(eventfp) : NULL;
777 } else
778 filep = eventfp;
779 break;
780 case VHOST_SET_VRING_ERR:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900781 if (copy_from_user(&f, argp, sizeof f)) {
782 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000783 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900784 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000785 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200786 if (IS_ERR(eventfp)) {
787 r = PTR_ERR(eventfp);
788 break;
789 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000790 if (eventfp != vq->error) {
791 filep = vq->error;
792 vq->error = eventfp;
793 ctx = vq->error_ctx;
794 vq->error_ctx = eventfp ?
795 eventfd_ctx_fileget(eventfp) : NULL;
796 } else
797 filep = eventfp;
798 break;
799 default:
800 r = -ENOIOCTLCMD;
801 }
802
803 if (pollstop && vq->handle_kick)
804 vhost_poll_stop(&vq->poll);
805
806 if (ctx)
807 eventfd_ctx_put(ctx);
808 if (filep)
809 fput(filep);
810
811 if (pollstart && vq->handle_kick)
Jason Wang2b8b3282013-01-28 01:05:18 +0000812 r = vhost_poll_start(&vq->poll, vq->kick);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000813
814 mutex_unlock(&vq->mutex);
815
816 if (pollstop && vq->handle_kick)
817 vhost_poll_flush(&vq->poll);
818 return r;
819}
Asias He6ac1afb2013-05-06 16:38:21 +0800820EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000821
822/* Caller must have device mutex */
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200823long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000824{
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000825 struct file *eventfp, *filep = NULL;
826 struct eventfd_ctx *ctx = NULL;
827 u64 p;
828 long r;
829 int i, fd;
830
831 /* If you are not the owner, you can become one */
832 if (ioctl == VHOST_SET_OWNER) {
833 r = vhost_dev_set_owner(d);
834 goto done;
835 }
836
837 /* You must be the owner to do anything else */
838 r = vhost_dev_check_owner(d);
839 if (r)
840 goto done;
841
842 switch (ioctl) {
843 case VHOST_SET_MEM_TABLE:
844 r = vhost_set_memory(d, argp);
845 break;
846 case VHOST_SET_LOG_BASE:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900847 if (copy_from_user(&p, argp, sizeof p)) {
848 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000849 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900850 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000851 if ((u64)(unsigned long)p != p) {
852 r = -EFAULT;
853 break;
854 }
855 for (i = 0; i < d->nvqs; ++i) {
856 struct vhost_virtqueue *vq;
857 void __user *base = (void __user *)(unsigned long)p;
Asias He3ab2e422013-04-27 11:16:48 +0800858 vq = d->vqs[i];
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000859 mutex_lock(&vq->mutex);
860 /* If ring is inactive, will check when it's enabled. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300861 if (vq->private_data && !vq_log_access_ok(d, vq, base))
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000862 r = -EFAULT;
863 else
864 vq->log_base = base;
865 mutex_unlock(&vq->mutex);
866 }
867 break;
868 case VHOST_SET_LOG_FD:
869 r = get_user(fd, (int __user *)argp);
870 if (r < 0)
871 break;
872 eventfp = fd == -1 ? NULL : eventfd_fget(fd);
873 if (IS_ERR(eventfp)) {
874 r = PTR_ERR(eventfp);
875 break;
876 }
877 if (eventfp != d->log_file) {
878 filep = d->log_file;
879 ctx = d->log_ctx;
880 d->log_ctx = eventfp ?
881 eventfd_ctx_fileget(eventfp) : NULL;
882 } else
883 filep = eventfp;
884 for (i = 0; i < d->nvqs; ++i) {
Asias He3ab2e422013-04-27 11:16:48 +0800885 mutex_lock(&d->vqs[i]->mutex);
886 d->vqs[i]->log_ctx = d->log_ctx;
887 mutex_unlock(&d->vqs[i]->mutex);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000888 }
889 if (ctx)
890 eventfd_ctx_put(ctx);
891 if (filep)
892 fput(filep);
893 break;
894 default:
Michael S. Tsirkin935cdee2012-12-06 14:03:34 +0200895 r = -ENOIOCTLCMD;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000896 break;
897 }
898done:
899 return r;
900}
Asias He6ac1afb2013-05-06 16:38:21 +0800901EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000902
903static const struct vhost_memory_region *find_region(struct vhost_memory *mem,
904 __u64 addr, __u32 len)
905{
906 struct vhost_memory_region *reg;
907 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530908
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000909 /* linear search is not brilliant, but we really have on the order of 6
910 * regions in practice */
911 for (i = 0; i < mem->nregions; ++i) {
912 reg = mem->regions + i;
913 if (reg->guest_phys_addr <= addr &&
914 reg->guest_phys_addr + reg->memory_size - 1 >= addr)
915 return reg;
916 }
917 return NULL;
918}
919
920/* TODO: This is really inefficient. We need something like get_user()
921 * (instruction directly accesses the data, with an exception table entry
922 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
923 */
924static int set_bit_to_user(int nr, void __user *addr)
925{
926 unsigned long log = (unsigned long)addr;
927 struct page *page;
928 void *base;
929 int bit = nr + (log % PAGE_SIZE) * 8;
930 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +0530931
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000932 r = get_user_pages_fast(log, 1, 1, &page);
Michael S. Tsirkind6db3f52010-02-23 11:25:23 +0200933 if (r < 0)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000934 return r;
Michael S. Tsirkind6db3f52010-02-23 11:25:23 +0200935 BUG_ON(r != 1);
Cong Wangc6daa7f2011-11-25 23:14:26 +0800936 base = kmap_atomic(page);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000937 set_bit(bit, base);
Cong Wangc6daa7f2011-11-25 23:14:26 +0800938 kunmap_atomic(base);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000939 set_page_dirty_lock(page);
940 put_page(page);
941 return 0;
942}
943
944static int log_write(void __user *log_base,
945 u64 write_address, u64 write_length)
946{
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200947 u64 write_page = write_address / VHOST_PAGE_SIZE;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000948 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +0530949
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000950 if (!write_length)
951 return 0;
Michael S. Tsirkin3bf9be42010-11-29 10:19:07 +0200952 write_length += write_address % VHOST_PAGE_SIZE;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000953 for (;;) {
954 u64 base = (u64)(unsigned long)log_base;
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200955 u64 log = base + write_page / 8;
956 int bit = write_page % 8;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000957 if ((u64)(unsigned long)log != log)
958 return -EFAULT;
959 r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
960 if (r < 0)
961 return r;
962 if (write_length <= VHOST_PAGE_SIZE)
963 break;
964 write_length -= VHOST_PAGE_SIZE;
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200965 write_page += 1;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000966 }
967 return r;
968}
969
970int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
971 unsigned int log_num, u64 len)
972{
973 int i, r;
974
975 /* Make sure data written is seen before log. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +0000976 smp_wmb();
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000977 for (i = 0; i < log_num; ++i) {
978 u64 l = min(log[i].len, len);
979 r = log_write(vq->log_base, log[i].addr, l);
980 if (r < 0)
981 return r;
982 len -= l;
Michael S. Tsirkin5786aee2010-09-22 12:31:53 +0200983 if (!len) {
984 if (vq->log_ctx)
985 eventfd_signal(vq->log_ctx, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000986 return 0;
Michael S. Tsirkin5786aee2010-09-22 12:31:53 +0200987 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000988 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000989 /* Length written exceeds what we have stored. This is a bug. */
990 BUG();
991 return 0;
992}
Asias He6ac1afb2013-05-06 16:38:21 +0800993EXPORT_SYMBOL_GPL(vhost_log_write);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000994
Jason Wang2723fea2011-06-21 18:04:38 +0800995static int vhost_update_used_flags(struct vhost_virtqueue *vq)
996{
997 void __user *used;
Michael S. Tsirkinb8342262011-07-19 17:15:43 +0300998 if (__put_user(vq->used_flags, &vq->used->flags) < 0)
Jason Wang2723fea2011-06-21 18:04:38 +0800999 return -EFAULT;
1000 if (unlikely(vq->log_used)) {
1001 /* Make sure the flag is seen before log. */
1002 smp_wmb();
1003 /* Log used flag write. */
1004 used = &vq->used->flags;
1005 log_write(vq->log_base, vq->log_addr +
1006 (used - (void __user *)vq->used),
1007 sizeof vq->used->flags);
1008 if (vq->log_ctx)
1009 eventfd_signal(vq->log_ctx, 1);
1010 }
1011 return 0;
1012}
1013
1014static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
1015{
Michael S. Tsirkinb8342262011-07-19 17:15:43 +03001016 if (__put_user(vq->avail_idx, vhost_avail_event(vq)))
Jason Wang2723fea2011-06-21 18:04:38 +08001017 return -EFAULT;
1018 if (unlikely(vq->log_used)) {
1019 void __user *used;
1020 /* Make sure the event is seen before log. */
1021 smp_wmb();
1022 /* Log avail event write */
1023 used = vhost_avail_event(vq);
1024 log_write(vq->log_base, vq->log_addr +
1025 (used - (void __user *)vq->used),
1026 sizeof *vhost_avail_event(vq));
1027 if (vq->log_ctx)
1028 eventfd_signal(vq->log_ctx, 1);
1029 }
1030 return 0;
1031}
1032
1033int vhost_init_used(struct vhost_virtqueue *vq)
1034{
1035 int r;
1036 if (!vq->private_data)
1037 return 0;
1038
1039 r = vhost_update_used_flags(vq);
1040 if (r)
1041 return r;
1042 vq->signalled_used_valid = false;
1043 return get_user(vq->last_used_idx, &vq->used->idx);
1044}
Asias He6ac1afb2013-05-06 16:38:21 +08001045EXPORT_SYMBOL_GPL(vhost_init_used);
Jason Wang2723fea2011-06-21 18:04:38 +08001046
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001047static int translate_desc(struct vhost_dev *dev, u64 addr, u32 len,
1048 struct iovec iov[], int iov_size)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001049{
1050 const struct vhost_memory_region *reg;
1051 struct vhost_memory *mem;
1052 struct iovec *_iov;
1053 u64 s = 0;
1054 int ret = 0;
1055
1056 rcu_read_lock();
1057
1058 mem = rcu_dereference(dev->memory);
1059 while ((u64)len > s) {
1060 u64 size;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001061 if (unlikely(ret >= iov_size)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001062 ret = -ENOBUFS;
1063 break;
1064 }
1065 reg = find_region(mem, addr, len);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001066 if (unlikely(!reg)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001067 ret = -EFAULT;
1068 break;
1069 }
1070 _iov = iov + ret;
1071 size = reg->memory_size - addr + reg->guest_phys_addr;
Michael S. Tsirkinbd971202012-11-26 05:57:27 +00001072 _iov->iov_len = min((u64)len - s, size);
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001073 _iov->iov_base = (void __user *)(unsigned long)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001074 (reg->userspace_addr + addr - reg->guest_phys_addr);
1075 s += size;
1076 addr += size;
1077 ++ret;
1078 }
1079
1080 rcu_read_unlock();
1081 return ret;
1082}
1083
1084/* Each buffer in the virtqueues is actually a chain of descriptors. This
1085 * function returns the next descriptor in the chain,
1086 * or -1U if we're at the end. */
1087static unsigned next_desc(struct vring_desc *desc)
1088{
1089 unsigned int next;
1090
1091 /* If this descriptor says it doesn't chain, we're done. */
1092 if (!(desc->flags & VRING_DESC_F_NEXT))
1093 return -1U;
1094
1095 /* Check they're not leading us off end of descriptors. */
1096 next = desc->next;
1097 /* Make sure compiler knows to grab that: we don't want it changing! */
1098 /* We will use the result as an index in an array, so most
1099 * architectures only need a compiler barrier here. */
1100 read_barrier_depends();
1101
1102 return next;
1103}
1104
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001105static int get_indirect(struct vhost_dev *dev, struct vhost_virtqueue *vq,
1106 struct iovec iov[], unsigned int iov_size,
1107 unsigned int *out_num, unsigned int *in_num,
1108 struct vhost_log *log, unsigned int *log_num,
1109 struct vring_desc *indirect)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001110{
1111 struct vring_desc desc;
1112 unsigned int i = 0, count, found = 0;
1113 int ret;
1114
1115 /* Sanity check */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001116 if (unlikely(indirect->len % sizeof desc)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001117 vq_err(vq, "Invalid length in indirect descriptor: "
1118 "len 0x%llx not multiple of 0x%zx\n",
1119 (unsigned long long)indirect->len,
1120 sizeof desc);
1121 return -EINVAL;
1122 }
1123
1124 ret = translate_desc(dev, indirect->addr, indirect->len, vq->indirect,
Jason Wange0e9b402010-09-14 23:53:05 +08001125 UIO_MAXIOV);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001126 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001127 vq_err(vq, "Translation failure %d in indirect.\n", ret);
1128 return ret;
1129 }
1130
1131 /* We will use the result as an address to read from, so most
1132 * architectures only need a compiler barrier here. */
1133 read_barrier_depends();
1134
1135 count = indirect->len / sizeof desc;
1136 /* Buffers are chained via a 16 bit next field, so
1137 * we can have at most 2^16 of these. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001138 if (unlikely(count > USHRT_MAX + 1)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001139 vq_err(vq, "Indirect buffer length too big: %d\n",
1140 indirect->len);
1141 return -E2BIG;
1142 }
1143
1144 do {
1145 unsigned iov_count = *in_num + *out_num;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001146 if (unlikely(++found > count)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001147 vq_err(vq, "Loop detected: last one at %u "
1148 "indirect size %u\n",
1149 i, count);
1150 return -EINVAL;
1151 }
Krishna Kumard47effe2011-03-01 17:06:37 +05301152 if (unlikely(memcpy_fromiovec((unsigned char *)&desc,
1153 vq->indirect, sizeof desc))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001154 vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
1155 i, (size_t)indirect->addr + i * sizeof desc);
1156 return -EINVAL;
1157 }
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001158 if (unlikely(desc.flags & VRING_DESC_F_INDIRECT)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001159 vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
1160 i, (size_t)indirect->addr + i * sizeof desc);
1161 return -EINVAL;
1162 }
1163
1164 ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
1165 iov_size - iov_count);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001166 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001167 vq_err(vq, "Translation failure %d indirect idx %d\n",
1168 ret, i);
1169 return ret;
1170 }
1171 /* If this is an input descriptor, increment that count. */
1172 if (desc.flags & VRING_DESC_F_WRITE) {
1173 *in_num += ret;
1174 if (unlikely(log)) {
1175 log[*log_num].addr = desc.addr;
1176 log[*log_num].len = desc.len;
1177 ++*log_num;
1178 }
1179 } else {
1180 /* If it's an output descriptor, they're all supposed
1181 * to come before any input descriptors. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001182 if (unlikely(*in_num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001183 vq_err(vq, "Indirect descriptor "
1184 "has out after in: idx %d\n", i);
1185 return -EINVAL;
1186 }
1187 *out_num += ret;
1188 }
1189 } while ((i = next_desc(&desc)) != -1);
1190 return 0;
1191}
1192
1193/* This looks in the virtqueue and for the first available buffer, and converts
1194 * it to an iovec for convenient access. Since descriptors consist of some
1195 * number of output then some number of input descriptors, it's actually two
1196 * iovecs, but we pack them into one and note how many of each there were.
1197 *
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001198 * This function returns the descriptor number found, or vq->num (which is
1199 * never a valid descriptor number) if none was found. A negative code is
1200 * returned on error. */
1201int vhost_get_vq_desc(struct vhost_dev *dev, struct vhost_virtqueue *vq,
1202 struct iovec iov[], unsigned int iov_size,
1203 unsigned int *out_num, unsigned int *in_num,
1204 struct vhost_log *log, unsigned int *log_num)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001205{
1206 struct vring_desc desc;
1207 unsigned int i, head, found = 0;
1208 u16 last_avail_idx;
1209 int ret;
1210
1211 /* Check it isn't doing very strange things with descriptor numbers. */
1212 last_avail_idx = vq->last_avail_idx;
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001213 if (unlikely(__get_user(vq->avail_idx, &vq->avail->idx))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001214 vq_err(vq, "Failed to access avail idx at %p\n",
1215 &vq->avail->idx);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001216 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001217 }
1218
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001219 if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001220 vq_err(vq, "Guest moved used index from %u to %u",
1221 last_avail_idx, vq->avail_idx);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001222 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001223 }
1224
1225 /* If there's nothing new since last we looked, return invalid. */
1226 if (vq->avail_idx == last_avail_idx)
1227 return vq->num;
1228
1229 /* Only get avail ring entries after they have been exposed by guest. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001230 smp_rmb();
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001231
1232 /* Grab the next descriptor number they're advertising, and increment
1233 * the index we've seen. */
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001234 if (unlikely(__get_user(head,
1235 &vq->avail->ring[last_avail_idx % vq->num]))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001236 vq_err(vq, "Failed to read head: idx %d address %p\n",
1237 last_avail_idx,
1238 &vq->avail->ring[last_avail_idx % vq->num]);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001239 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001240 }
1241
1242 /* If their number is silly, that's an error. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001243 if (unlikely(head >= vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001244 vq_err(vq, "Guest says index %u > %u is available",
1245 head, vq->num);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001246 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001247 }
1248
1249 /* When we start there are none of either input nor output. */
1250 *out_num = *in_num = 0;
1251 if (unlikely(log))
1252 *log_num = 0;
1253
1254 i = head;
1255 do {
1256 unsigned iov_count = *in_num + *out_num;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001257 if (unlikely(i >= vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001258 vq_err(vq, "Desc index is %u > %u, head = %u",
1259 i, vq->num, head);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001260 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001261 }
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001262 if (unlikely(++found > vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001263 vq_err(vq, "Loop detected: last one at %u "
1264 "vq size %u head %u\n",
1265 i, vq->num, head);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001266 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001267 }
Michael S. Tsirkinfcc042a2011-03-06 13:33:49 +02001268 ret = __copy_from_user(&desc, vq->desc + i, sizeof desc);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001269 if (unlikely(ret)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001270 vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
1271 i, vq->desc + i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001272 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001273 }
1274 if (desc.flags & VRING_DESC_F_INDIRECT) {
1275 ret = get_indirect(dev, vq, iov, iov_size,
1276 out_num, in_num,
1277 log, log_num, &desc);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001278 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001279 vq_err(vq, "Failure detected "
1280 "in indirect descriptor at idx %d\n", i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001281 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001282 }
1283 continue;
1284 }
1285
1286 ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
1287 iov_size - iov_count);
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, "Translation failure %d descriptor idx %d\n",
1290 ret, i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001291 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001292 }
1293 if (desc.flags & VRING_DESC_F_WRITE) {
1294 /* If this is an input descriptor,
1295 * increment that count. */
1296 *in_num += ret;
1297 if (unlikely(log)) {
1298 log[*log_num].addr = desc.addr;
1299 log[*log_num].len = desc.len;
1300 ++*log_num;
1301 }
1302 } else {
1303 /* If it's an output descriptor, they're all supposed
1304 * to come before any input descriptors. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001305 if (unlikely(*in_num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001306 vq_err(vq, "Descriptor has out after in: "
1307 "idx %d\n", i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001308 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001309 }
1310 *out_num += ret;
1311 }
1312 } while ((i = next_desc(&desc)) != -1);
1313
1314 /* On success, increment avail index. */
1315 vq->last_avail_idx++;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001316
1317 /* Assume notifications from guest are disabled at this point,
1318 * if they aren't we would need to update avail_event index. */
1319 BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001320 return head;
1321}
Asias He6ac1afb2013-05-06 16:38:21 +08001322EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001323
1324/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
David Stevens8dd014a2010-07-27 18:52:21 +03001325void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001326{
David Stevens8dd014a2010-07-27 18:52:21 +03001327 vq->last_avail_idx -= n;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001328}
Asias He6ac1afb2013-05-06 16:38:21 +08001329EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001330
1331/* After we've used one of their buffers, we tell them about it. We'll then
1332 * want to notify the guest, using eventfd. */
1333int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
1334{
Jason Wangc49e4e52013-09-02 16:40:58 +08001335 struct vring_used_elem heads = { head, len };
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001336
Jason Wangc49e4e52013-09-02 16:40:58 +08001337 return vhost_add_used_n(vq, &heads, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001338}
Asias He6ac1afb2013-05-06 16:38:21 +08001339EXPORT_SYMBOL_GPL(vhost_add_used);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001340
David Stevens8dd014a2010-07-27 18:52:21 +03001341static int __vhost_add_used_n(struct vhost_virtqueue *vq,
1342 struct vring_used_elem *heads,
1343 unsigned count)
1344{
1345 struct vring_used_elem __user *used;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001346 u16 old, new;
David Stevens8dd014a2010-07-27 18:52:21 +03001347 int start;
1348
1349 start = vq->last_used_idx % vq->num;
1350 used = vq->used->ring + start;
Jason Wangc49e4e52013-09-02 16:40:58 +08001351 if (count == 1) {
1352 if (__put_user(heads[0].id, &used->id)) {
1353 vq_err(vq, "Failed to write used id");
1354 return -EFAULT;
1355 }
1356 if (__put_user(heads[0].len, &used->len)) {
1357 vq_err(vq, "Failed to write used len");
1358 return -EFAULT;
1359 }
1360 } else if (__copy_to_user(used, heads, count * sizeof *used)) {
David Stevens8dd014a2010-07-27 18:52:21 +03001361 vq_err(vq, "Failed to write used");
1362 return -EFAULT;
1363 }
1364 if (unlikely(vq->log_used)) {
1365 /* Make sure data is seen before log. */
1366 smp_wmb();
1367 /* Log used ring entry write. */
1368 log_write(vq->log_base,
1369 vq->log_addr +
1370 ((void __user *)used - (void __user *)vq->used),
1371 count * sizeof *used);
1372 }
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001373 old = vq->last_used_idx;
1374 new = (vq->last_used_idx += count);
1375 /* If the driver never bothers to signal in a very long while,
1376 * used index might wrap around. If that happens, invalidate
1377 * signalled_used index we stored. TODO: make sure driver
1378 * signals at least once in 2^16 and remove this. */
1379 if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
1380 vq->signalled_used_valid = false;
David Stevens8dd014a2010-07-27 18:52:21 +03001381 return 0;
1382}
1383
1384/* After we've used one of their buffers, we tell them about it. We'll then
1385 * want to notify the guest, using eventfd. */
1386int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
1387 unsigned count)
1388{
1389 int start, n, r;
1390
1391 start = vq->last_used_idx % vq->num;
1392 n = vq->num - start;
1393 if (n < count) {
1394 r = __vhost_add_used_n(vq, heads, n);
1395 if (r < 0)
1396 return r;
1397 heads += n;
1398 count -= n;
1399 }
1400 r = __vhost_add_used_n(vq, heads, count);
1401
1402 /* Make sure buffer is written before we update index. */
1403 smp_wmb();
1404 if (put_user(vq->last_used_idx, &vq->used->idx)) {
1405 vq_err(vq, "Failed to increment used idx");
1406 return -EFAULT;
1407 }
1408 if (unlikely(vq->log_used)) {
1409 /* Log used index update. */
1410 log_write(vq->log_base,
1411 vq->log_addr + offsetof(struct vring_used, idx),
1412 sizeof vq->used->idx);
1413 if (vq->log_ctx)
1414 eventfd_signal(vq->log_ctx, 1);
1415 }
1416 return r;
1417}
Asias He6ac1afb2013-05-06 16:38:21 +08001418EXPORT_SYMBOL_GPL(vhost_add_used_n);
David Stevens8dd014a2010-07-27 18:52:21 +03001419
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001420static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001421{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001422 __u16 old, new, event;
1423 bool v;
Michael S. Tsirkin0d499352010-05-11 19:44:17 +03001424 /* Flush out used index updates. This is paired
1425 * with the barrier that the Guest executes when enabling
1426 * interrupts. */
1427 smp_mb();
1428
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001429 if (vhost_has_feature(dev, VIRTIO_F_NOTIFY_ON_EMPTY) &&
1430 unlikely(vq->avail_idx == vq->last_avail_idx))
1431 return true;
1432
1433 if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
1434 __u16 flags;
1435 if (__get_user(flags, &vq->avail->flags)) {
1436 vq_err(vq, "Failed to get flags");
1437 return true;
1438 }
1439 return !(flags & VRING_AVAIL_F_NO_INTERRUPT);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001440 }
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001441 old = vq->signalled_used;
1442 v = vq->signalled_used_valid;
1443 new = vq->signalled_used = vq->last_used_idx;
1444 vq->signalled_used_valid = true;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001445
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001446 if (unlikely(!v))
1447 return true;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001448
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001449 if (get_user(event, vhost_used_event(vq))) {
1450 vq_err(vq, "Failed to get used event idx");
1451 return true;
1452 }
1453 return vring_need_event(event, new, old);
1454}
1455
1456/* This actually signals the guest, using eventfd. */
1457void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
1458{
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001459 /* Signal the Guest tell them we used something up. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001460 if (vq->call_ctx && vhost_notify(dev, vq))
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001461 eventfd_signal(vq->call_ctx, 1);
1462}
Asias He6ac1afb2013-05-06 16:38:21 +08001463EXPORT_SYMBOL_GPL(vhost_signal);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001464
1465/* And here's the combo meal deal. Supersize me! */
1466void vhost_add_used_and_signal(struct vhost_dev *dev,
1467 struct vhost_virtqueue *vq,
1468 unsigned int head, int len)
1469{
1470 vhost_add_used(vq, head, len);
1471 vhost_signal(dev, vq);
1472}
Asias He6ac1afb2013-05-06 16:38:21 +08001473EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001474
David Stevens8dd014a2010-07-27 18:52:21 +03001475/* multi-buffer version of vhost_add_used_and_signal */
1476void vhost_add_used_and_signal_n(struct vhost_dev *dev,
1477 struct vhost_virtqueue *vq,
1478 struct vring_used_elem *heads, unsigned count)
1479{
1480 vhost_add_used_n(vq, heads, count);
1481 vhost_signal(dev, vq);
1482}
Asias He6ac1afb2013-05-06 16:38:21 +08001483EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
David Stevens8dd014a2010-07-27 18:52:21 +03001484
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001485/* OK, now we need to know about added descriptors. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001486bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001487{
1488 u16 avail_idx;
1489 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +05301490
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001491 if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
1492 return false;
1493 vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001494 if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
Jason Wang2723fea2011-06-21 18:04:38 +08001495 r = vhost_update_used_flags(vq);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001496 if (r) {
1497 vq_err(vq, "Failed to enable notification at %p: %d\n",
1498 &vq->used->flags, r);
1499 return false;
1500 }
1501 } else {
Jason Wang2723fea2011-06-21 18:04:38 +08001502 r = vhost_update_avail_event(vq, vq->avail_idx);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001503 if (r) {
1504 vq_err(vq, "Failed to update avail event index at %p: %d\n",
1505 vhost_avail_event(vq), r);
1506 return false;
1507 }
1508 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001509 /* They could have slipped one in as we were doing that: make
1510 * sure it's written, then check again. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001511 smp_mb();
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001512 r = __get_user(avail_idx, &vq->avail->idx);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001513 if (r) {
1514 vq_err(vq, "Failed to check avail idx at %p: %d\n",
1515 &vq->avail->idx, r);
1516 return false;
1517 }
1518
David Stevens8dd014a2010-07-27 18:52:21 +03001519 return avail_idx != vq->avail_idx;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001520}
Asias He6ac1afb2013-05-06 16:38:21 +08001521EXPORT_SYMBOL_GPL(vhost_enable_notify);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001522
1523/* We don't need to be notified again. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001524void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001525{
1526 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +05301527
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001528 if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
1529 return;
1530 vq->used_flags |= VRING_USED_F_NO_NOTIFY;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001531 if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
Jason Wang2723fea2011-06-21 18:04:38 +08001532 r = vhost_update_used_flags(vq);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001533 if (r)
1534 vq_err(vq, "Failed to enable notification at %p: %d\n",
1535 &vq->used->flags, r);
1536 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001537}
Asias He6ac1afb2013-05-06 16:38:21 +08001538EXPORT_SYMBOL_GPL(vhost_disable_notify);
1539
1540static int __init vhost_init(void)
1541{
1542 return 0;
1543}
1544
1545static void __exit vhost_exit(void)
1546{
1547}
1548
1549module_init(vhost_init);
1550module_exit(vhost_exit);
1551
1552MODULE_VERSION("0.0.1");
1553MODULE_LICENSE("GPL v2");
1554MODULE_AUTHOR("Michael S. Tsirkin");
1555MODULE_DESCRIPTION("Host kernel accelerator for virtio");