blob: ef8f5988f8550add8e2bbb2aaa13f4fd9f3027c3 [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>
16#include <linux/virtio_net.h>
17#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>
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000028
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000029#include "vhost.h"
30
31enum {
32 VHOST_MEMORY_MAX_NREGIONS = 64,
33 VHOST_MEMORY_F_LOG = 0x1,
34};
35
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +000036static unsigned vhost_zcopy_mask __read_mostly;
37
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +030038#define vhost_used_event(vq) ((u16 __user *)&vq->avail->ring[vq->num])
39#define vhost_avail_event(vq) ((u16 __user *)&vq->used->ring[vq->num])
40
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000041static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
42 poll_table *pt)
43{
44 struct vhost_poll *poll;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000045
Krishna Kumard47effe2011-03-01 17:06:37 +053046 poll = container_of(pt, struct vhost_poll, table);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000047 poll->wqh = wqh;
48 add_wait_queue(wqh, &poll->wait);
49}
50
51static int vhost_poll_wakeup(wait_queue_t *wait, unsigned mode, int sync,
52 void *key)
53{
Tejun Heoc23f34452010-06-02 20:40:00 +020054 struct vhost_poll *poll = container_of(wait, struct vhost_poll, wait);
55
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000056 if (!((unsigned long)key & poll->mask))
57 return 0;
58
Tejun Heoc23f34452010-06-02 20:40:00 +020059 vhost_poll_queue(poll);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000060 return 0;
61}
62
Stefan Hajnoczi163049a2012-07-21 06:55:37 +000063void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000064{
Tejun Heoc23f34452010-06-02 20:40:00 +020065 INIT_LIST_HEAD(&work->node);
66 work->fn = fn;
67 init_waitqueue_head(&work->done);
68 work->flushing = 0;
69 work->queue_seq = work->done_seq = 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000070}
71
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;
80
81 vhost_work_init(&poll->work, fn);
82}
83
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000084/* Start polling a file. We add ourselves to file's wait queue. The caller must
85 * keep a reference to a file until after vhost_poll_stop is called. */
86void vhost_poll_start(struct vhost_poll *poll, struct file *file)
87{
88 unsigned long mask;
Krishna Kumard47effe2011-03-01 17:06:37 +053089
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +000090 mask = file->f_op->poll(file, &poll->table);
91 if (mask)
92 vhost_poll_wakeup(&poll->wait, 0, 0, (void *)mask);
93}
94
95/* Stop polling a file. After this function returns, it becomes safe to drop the
96 * file reference. You must also flush afterwards. */
97void vhost_poll_stop(struct vhost_poll *poll)
98{
99 remove_wait_queue(poll->wqh, &poll->wait);
100}
101
Michael S. Tsirkin0174b0c2011-01-10 10:03:20 +0200102static bool vhost_work_seq_done(struct vhost_dev *dev, struct vhost_work *work,
103 unsigned seq)
104{
105 int left;
Krishna Kumard47effe2011-03-01 17:06:37 +0530106
Michael S. Tsirkin0174b0c2011-01-10 10:03:20 +0200107 spin_lock_irq(&dev->work_lock);
108 left = seq - work->done_seq;
109 spin_unlock_irq(&dev->work_lock);
110 return left <= 0;
111}
112
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300113static void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000114{
Tejun Heoc23f34452010-06-02 20:40:00 +0200115 unsigned seq;
Tejun Heoc23f34452010-06-02 20:40:00 +0200116 int flushing;
117
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300118 spin_lock_irq(&dev->work_lock);
Tejun Heoc23f34452010-06-02 20:40:00 +0200119 seq = work->queue_seq;
120 work->flushing++;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300121 spin_unlock_irq(&dev->work_lock);
Michael S. Tsirkin0174b0c2011-01-10 10:03:20 +0200122 wait_event(work->done, vhost_work_seq_done(dev, work, seq));
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300123 spin_lock_irq(&dev->work_lock);
Tejun Heoc23f34452010-06-02 20:40:00 +0200124 flushing = --work->flushing;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300125 spin_unlock_irq(&dev->work_lock);
Tejun Heoc23f34452010-06-02 20:40:00 +0200126 BUG_ON(flushing < 0);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000127}
128
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300129/* Flush any work that has been scheduled. When calling this, don't hold any
130 * locks that are also used by the callback. */
131void vhost_poll_flush(struct vhost_poll *poll)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000132{
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300133 vhost_work_flush(poll->dev, &poll->work);
134}
135
Stefan Hajnoczi163049a2012-07-21 06:55:37 +0000136void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300137{
Tejun Heoc23f34452010-06-02 20:40:00 +0200138 unsigned long flags;
139
140 spin_lock_irqsave(&dev->work_lock, flags);
141 if (list_empty(&work->node)) {
142 list_add_tail(&work->node, &dev->work_list);
143 work->queue_seq++;
144 wake_up_process(dev->worker);
145 }
146 spin_unlock_irqrestore(&dev->work_lock, flags);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000147}
148
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300149void vhost_poll_queue(struct vhost_poll *poll)
150{
151 vhost_work_queue(poll->dev, &poll->work);
152}
153
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000154static void vhost_vq_reset(struct vhost_dev *dev,
155 struct vhost_virtqueue *vq)
156{
157 vq->num = 1;
158 vq->desc = NULL;
159 vq->avail = NULL;
160 vq->used = NULL;
161 vq->last_avail_idx = 0;
162 vq->avail_idx = 0;
163 vq->last_used_idx = 0;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300164 vq->signalled_used = 0;
165 vq->signalled_used_valid = false;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000166 vq->used_flags = 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000167 vq->log_used = false;
168 vq->log_addr = -1ull;
David Stevens8dd014a2010-07-27 18:52:21 +0300169 vq->vhost_hlen = 0;
170 vq->sock_hlen = 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000171 vq->private_data = NULL;
172 vq->log_base = NULL;
173 vq->error_ctx = NULL;
174 vq->error = NULL;
175 vq->kick = NULL;
176 vq->call_ctx = NULL;
177 vq->call = NULL;
Michael S. Tsirkin73a99f02010-02-23 11:23:45 +0200178 vq->log_ctx = NULL;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000179 vq->upend_idx = 0;
180 vq->done_idx = 0;
181 vq->ubufs = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000182}
183
Tejun Heoc23f34452010-06-02 20:40:00 +0200184static int vhost_worker(void *data)
185{
186 struct vhost_dev *dev = data;
187 struct vhost_work *work = NULL;
188 unsigned uninitialized_var(seq);
Jens Freimannd7ffde32012-06-26 00:59:58 +0000189 mm_segment_t oldfs = get_fs();
Tejun Heoc23f34452010-06-02 20:40:00 +0200190
Jens Freimannd7ffde32012-06-26 00:59:58 +0000191 set_fs(USER_DS);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200192 use_mm(dev->mm);
193
Tejun Heoc23f34452010-06-02 20:40:00 +0200194 for (;;) {
195 /* mb paired w/ kthread_stop */
196 set_current_state(TASK_INTERRUPTIBLE);
197
198 spin_lock_irq(&dev->work_lock);
199 if (work) {
200 work->done_seq = seq;
201 if (work->flushing)
202 wake_up_all(&work->done);
203 }
204
205 if (kthread_should_stop()) {
206 spin_unlock_irq(&dev->work_lock);
207 __set_current_state(TASK_RUNNING);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200208 break;
Tejun Heoc23f34452010-06-02 20:40:00 +0200209 }
210 if (!list_empty(&dev->work_list)) {
211 work = list_first_entry(&dev->work_list,
212 struct vhost_work, node);
213 list_del_init(&work->node);
214 seq = work->queue_seq;
215 } else
216 work = NULL;
217 spin_unlock_irq(&dev->work_lock);
218
219 if (work) {
220 __set_current_state(TASK_RUNNING);
221 work->fn(work);
Nadav Har'Eld550dda2012-02-27 15:07:29 +0200222 if (need_resched())
223 schedule();
Tejun Heoc23f34452010-06-02 20:40:00 +0200224 } else
225 schedule();
226
227 }
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200228 unuse_mm(dev->mm);
Jens Freimannd7ffde32012-06-26 00:59:58 +0000229 set_fs(oldfs);
Michael S. Tsirkin64e1c802010-10-06 15:34:45 +0200230 return 0;
Tejun Heoc23f34452010-06-02 20:40:00 +0200231}
232
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000233static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
234{
235 kfree(vq->indirect);
236 vq->indirect = NULL;
237 kfree(vq->log);
238 vq->log = NULL;
239 kfree(vq->heads);
240 vq->heads = NULL;
241 kfree(vq->ubuf_info);
242 vq->ubuf_info = NULL;
243}
244
245void vhost_enable_zcopy(int vq)
246{
247 vhost_zcopy_mask |= 0x1 << vq;
248}
249
Jason Wange0e9b402010-09-14 23:53:05 +0800250/* Helper to allocate iovec buffers for all vqs. */
251static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
252{
253 int i;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000254 bool zcopy;
Krishna Kumard47effe2011-03-01 17:06:37 +0530255
Jason Wange0e9b402010-09-14 23:53:05 +0800256 for (i = 0; i < dev->nvqs; ++i) {
257 dev->vqs[i].indirect = kmalloc(sizeof *dev->vqs[i].indirect *
258 UIO_MAXIOV, GFP_KERNEL);
259 dev->vqs[i].log = kmalloc(sizeof *dev->vqs[i].log * UIO_MAXIOV,
260 GFP_KERNEL);
261 dev->vqs[i].heads = kmalloc(sizeof *dev->vqs[i].heads *
262 UIO_MAXIOV, GFP_KERNEL);
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000263 zcopy = vhost_zcopy_mask & (0x1 << i);
264 if (zcopy)
265 dev->vqs[i].ubuf_info =
266 kmalloc(sizeof *dev->vqs[i].ubuf_info *
267 UIO_MAXIOV, GFP_KERNEL);
Jason Wange0e9b402010-09-14 23:53:05 +0800268 if (!dev->vqs[i].indirect || !dev->vqs[i].log ||
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000269 !dev->vqs[i].heads ||
270 (zcopy && !dev->vqs[i].ubuf_info))
Jason Wange0e9b402010-09-14 23:53:05 +0800271 goto err_nomem;
272 }
273 return 0;
Krishna Kumard47effe2011-03-01 17:06:37 +0530274
Jason Wange0e9b402010-09-14 23:53:05 +0800275err_nomem:
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000276 for (; i >= 0; --i)
277 vhost_vq_free_iovecs(&dev->vqs[i]);
Jason Wange0e9b402010-09-14 23:53:05 +0800278 return -ENOMEM;
279}
280
281static void vhost_dev_free_iovecs(struct vhost_dev *dev)
282{
283 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530284
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000285 for (i = 0; i < dev->nvqs; ++i)
286 vhost_vq_free_iovecs(&dev->vqs[i]);
Jason Wange0e9b402010-09-14 23:53:05 +0800287}
288
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000289long vhost_dev_init(struct vhost_dev *dev,
290 struct vhost_virtqueue *vqs, int nvqs)
291{
292 int i;
Tejun Heoc23f34452010-06-02 20:40:00 +0200293
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000294 dev->vqs = vqs;
295 dev->nvqs = nvqs;
296 mutex_init(&dev->mutex);
297 dev->log_ctx = NULL;
298 dev->log_file = NULL;
299 dev->memory = NULL;
300 dev->mm = NULL;
Tejun Heoc23f34452010-06-02 20:40:00 +0200301 spin_lock_init(&dev->work_lock);
302 INIT_LIST_HEAD(&dev->work_list);
303 dev->worker = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000304
305 for (i = 0; i < dev->nvqs; ++i) {
Jason Wange0e9b402010-09-14 23:53:05 +0800306 dev->vqs[i].log = NULL;
307 dev->vqs[i].indirect = NULL;
308 dev->vqs[i].heads = NULL;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000309 dev->vqs[i].ubuf_info = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000310 dev->vqs[i].dev = dev;
311 mutex_init(&dev->vqs[i].mutex);
312 vhost_vq_reset(dev, dev->vqs + i);
313 if (dev->vqs[i].handle_kick)
314 vhost_poll_init(&dev->vqs[i].poll,
Tejun Heoc23f34452010-06-02 20:40:00 +0200315 dev->vqs[i].handle_kick, POLLIN, dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000316 }
Tejun Heoc23f34452010-06-02 20:40:00 +0200317
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000318 return 0;
319}
320
321/* Caller should have device mutex */
322long vhost_dev_check_owner(struct vhost_dev *dev)
323{
324 /* Are you the owner? If not, I don't think you mean to do that */
325 return dev->mm == current->mm ? 0 : -EPERM;
326}
327
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300328struct vhost_attach_cgroups_struct {
Krishna Kumard47effe2011-03-01 17:06:37 +0530329 struct vhost_work work;
330 struct task_struct *owner;
331 int ret;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300332};
333
334static void vhost_attach_cgroups_work(struct vhost_work *work)
335{
Krishna Kumard47effe2011-03-01 17:06:37 +0530336 struct vhost_attach_cgroups_struct *s;
337
338 s = container_of(work, struct vhost_attach_cgroups_struct, work);
339 s->ret = cgroup_attach_task_all(s->owner, current);
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300340}
341
342static int vhost_attach_cgroups(struct vhost_dev *dev)
343{
Krishna Kumard47effe2011-03-01 17:06:37 +0530344 struct vhost_attach_cgroups_struct attach;
345
346 attach.owner = current;
347 vhost_work_init(&attach.work, vhost_attach_cgroups_work);
348 vhost_work_queue(dev, &attach.work);
349 vhost_work_flush(dev, &attach.work);
350 return attach.ret;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300351}
352
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000353/* Caller should have device mutex */
354static long vhost_dev_set_owner(struct vhost_dev *dev)
355{
Tejun Heoc23f34452010-06-02 20:40:00 +0200356 struct task_struct *worker;
357 int err;
Krishna Kumard47effe2011-03-01 17:06:37 +0530358
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000359 /* Is there an owner already? */
Tejun Heoc23f34452010-06-02 20:40:00 +0200360 if (dev->mm) {
361 err = -EBUSY;
362 goto err_mm;
363 }
Krishna Kumard47effe2011-03-01 17:06:37 +0530364
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000365 /* No owner, become one */
366 dev->mm = get_task_mm(current);
Tejun Heoc23f34452010-06-02 20:40:00 +0200367 worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
368 if (IS_ERR(worker)) {
369 err = PTR_ERR(worker);
370 goto err_worker;
371 }
372
373 dev->worker = worker;
Michael S. Tsirkin87d6a412010-09-02 14:05:30 +0300374 wake_up_process(worker); /* avoid contributing to loadavg */
375
376 err = vhost_attach_cgroups(dev);
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +0300377 if (err)
378 goto err_cgroup;
Tejun Heoc23f34452010-06-02 20:40:00 +0200379
Jason Wange0e9b402010-09-14 23:53:05 +0800380 err = vhost_dev_alloc_iovecs(dev);
381 if (err)
382 goto err_cgroup;
383
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000384 return 0;
Michael S. Tsirkin9e3d1952010-07-27 22:56:50 +0300385err_cgroup:
386 kthread_stop(worker);
Michael S. Tsirkin615cc222010-09-02 14:16:36 +0300387 dev->worker = NULL;
Tejun Heoc23f34452010-06-02 20:40:00 +0200388err_worker:
389 if (dev->mm)
390 mmput(dev->mm);
391 dev->mm = NULL;
392err_mm:
393 return err;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000394}
395
396/* Caller should have device mutex */
397long vhost_dev_reset_owner(struct vhost_dev *dev)
398{
399 struct vhost_memory *memory;
400
401 /* Restore memory to default empty mapping. */
402 memory = kmalloc(offsetof(struct vhost_memory, regions), GFP_KERNEL);
403 if (!memory)
404 return -ENOMEM;
405
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200406 vhost_dev_cleanup(dev, true);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000407
408 memory->nregions = 0;
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100409 RCU_INIT_POINTER(dev->memory, memory);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000410 return 0;
411}
412
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000413void vhost_dev_stop(struct vhost_dev *dev)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000414{
415 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530416
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000417 for (i = 0; i < dev->nvqs; ++i) {
418 if (dev->vqs[i].kick && dev->vqs[i].handle_kick) {
419 vhost_poll_stop(&dev->vqs[i].poll);
420 vhost_poll_flush(&dev->vqs[i].poll);
421 }
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000422 }
423}
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000424
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000425/* Caller should have device mutex if and only if locked is set */
426void vhost_dev_cleanup(struct vhost_dev *dev, bool locked)
427{
428 int i;
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +0000429
Michael S. Tsirkinb2116162012-11-01 09:16:46 +0000430 for (i = 0; i < dev->nvqs; ++i) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000431 if (dev->vqs[i].error_ctx)
432 eventfd_ctx_put(dev->vqs[i].error_ctx);
433 if (dev->vqs[i].error)
434 fput(dev->vqs[i].error);
435 if (dev->vqs[i].kick)
436 fput(dev->vqs[i].kick);
437 if (dev->vqs[i].call_ctx)
438 eventfd_ctx_put(dev->vqs[i].call_ctx);
439 if (dev->vqs[i].call)
440 fput(dev->vqs[i].call);
441 vhost_vq_reset(dev, dev->vqs + i);
442 }
Jason Wange0e9b402010-09-14 23:53:05 +0800443 vhost_dev_free_iovecs(dev);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000444 if (dev->log_ctx)
445 eventfd_ctx_put(dev->log_ctx);
446 dev->log_ctx = NULL;
447 if (dev->log_file)
448 fput(dev->log_file);
449 dev->log_file = NULL;
450 /* No one will access memory at this point */
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100451 kfree(rcu_dereference_protected(dev->memory,
Michael S. Tsirkinea5d4042011-11-27 19:05:58 +0200452 locked ==
453 lockdep_is_held(&dev->mutex)));
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100454 RCU_INIT_POINTER(dev->memory, NULL);
Tejun Heoc23f34452010-06-02 20:40:00 +0200455 WARN_ON(!list_empty(&dev->work_list));
Eric Dumazet78b620c2010-08-31 02:05:57 +0000456 if (dev->worker) {
457 kthread_stop(dev->worker);
458 dev->worker = NULL;
459 }
Michael S. Tsirkin533a19b2010-10-06 15:34:38 +0200460 if (dev->mm)
461 mmput(dev->mm);
462 dev->mm = NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000463}
464
465static int log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
466{
467 u64 a = addr / VHOST_PAGE_SIZE / 8;
Krishna Kumard47effe2011-03-01 17:06:37 +0530468
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000469 /* Make sure 64 bit math will not overflow. */
470 if (a > ULONG_MAX - (unsigned long)log_base ||
471 a + (unsigned long)log_base > ULONG_MAX)
Dan Carpenter6d97e552010-10-11 19:24:19 +0200472 return 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000473
474 return access_ok(VERIFY_WRITE, log_base + a,
475 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
476}
477
478/* Caller should have vq mutex and device mutex. */
479static int vq_memory_access_ok(void __user *log_base, struct vhost_memory *mem,
480 int log_all)
481{
482 int i;
Jeff Dike179b2842010-04-07 09:59:10 -0400483
Michael S. Tsirkinf8322fb2010-05-27 12:28:03 +0300484 if (!mem)
485 return 0;
Jeff Dike179b2842010-04-07 09:59:10 -0400486
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000487 for (i = 0; i < mem->nregions; ++i) {
488 struct vhost_memory_region *m = mem->regions + i;
489 unsigned long a = m->userspace_addr;
490 if (m->memory_size > ULONG_MAX)
491 return 0;
492 else if (!access_ok(VERIFY_WRITE, (void __user *)a,
493 m->memory_size))
494 return 0;
495 else if (log_all && !log_access_ok(log_base,
496 m->guest_phys_addr,
497 m->memory_size))
498 return 0;
499 }
500 return 1;
501}
502
503/* Can we switch to this memory table? */
504/* Caller should have device mutex but not vq mutex */
505static int memory_access_ok(struct vhost_dev *d, struct vhost_memory *mem,
506 int log_all)
507{
508 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530509
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000510 for (i = 0; i < d->nvqs; ++i) {
511 int ok;
512 mutex_lock(&d->vqs[i].mutex);
513 /* If ring is inactive, will check when it's enabled. */
514 if (d->vqs[i].private_data)
515 ok = vq_memory_access_ok(d->vqs[i].log_base, mem,
516 log_all);
517 else
518 ok = 1;
519 mutex_unlock(&d->vqs[i].mutex);
520 if (!ok)
521 return 0;
522 }
523 return 1;
524}
525
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300526static int vq_access_ok(struct vhost_dev *d, unsigned int num,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000527 struct vring_desc __user *desc,
528 struct vring_avail __user *avail,
529 struct vring_used __user *used)
530{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300531 size_t s = vhost_has_feature(d, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000532 return access_ok(VERIFY_READ, desc, num * sizeof *desc) &&
533 access_ok(VERIFY_READ, avail,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300534 sizeof *avail + num * sizeof *avail->ring + s) &&
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000535 access_ok(VERIFY_WRITE, used,
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300536 sizeof *used + num * sizeof *used->ring + s);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000537}
538
539/* Can we log writes? */
540/* Caller should have device mutex but not vq mutex */
541int vhost_log_access_ok(struct vhost_dev *dev)
542{
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100543 struct vhost_memory *mp;
544
545 mp = rcu_dereference_protected(dev->memory,
546 lockdep_is_held(&dev->mutex));
547 return memory_access_ok(dev, mp, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000548}
549
550/* Verify access for write logging. */
551/* Caller should have vq mutex and device mutex */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300552static int vq_log_access_ok(struct vhost_dev *d, struct vhost_virtqueue *vq,
553 void __user *log_base)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000554{
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100555 struct vhost_memory *mp;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300556 size_t s = vhost_has_feature(d, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100557
558 mp = rcu_dereference_protected(vq->dev->memory,
559 lockdep_is_held(&vq->mutex));
560 return vq_memory_access_ok(log_base, mp,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000561 vhost_has_feature(vq->dev, VHOST_F_LOG_ALL)) &&
562 (!vq->log_used || log_access_ok(log_base, vq->log_addr,
563 sizeof *vq->used +
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300564 vq->num * sizeof *vq->used->ring + s));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000565}
566
567/* Can we start vq? */
568/* Caller should have vq mutex and device mutex */
569int vhost_vq_access_ok(struct vhost_virtqueue *vq)
570{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300571 return vq_access_ok(vq->dev, vq->num, vq->desc, vq->avail, vq->used) &&
572 vq_log_access_ok(vq->dev, vq, vq->log_base);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000573}
574
575static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
576{
577 struct vhost_memory mem, *newmem, *oldmem;
578 unsigned long size = offsetof(struct vhost_memory, regions);
Krishna Kumard47effe2011-03-01 17:06:37 +0530579
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900580 if (copy_from_user(&mem, m, size))
581 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000582 if (mem.padding)
583 return -EOPNOTSUPP;
584 if (mem.nregions > VHOST_MEMORY_MAX_NREGIONS)
585 return -E2BIG;
586 newmem = kmalloc(size + mem.nregions * sizeof *m->regions, GFP_KERNEL);
587 if (!newmem)
588 return -ENOMEM;
589
590 memcpy(newmem, &mem, size);
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900591 if (copy_from_user(newmem->regions, m->regions,
592 mem.nregions * sizeof *m->regions)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000593 kfree(newmem);
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900594 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000595 }
596
Krishna Kumard47effe2011-03-01 17:06:37 +0530597 if (!memory_access_ok(d, newmem,
598 vhost_has_feature(d, VHOST_F_LOG_ALL))) {
Takuya Yoshikawaa02c3782010-05-27 19:03:56 +0900599 kfree(newmem);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000600 return -EFAULT;
Takuya Yoshikawaa02c3782010-05-27 19:03:56 +0900601 }
Arnd Bergmann28457ee2010-03-09 19:24:45 +0100602 oldmem = rcu_dereference_protected(d->memory,
603 lockdep_is_held(&d->mutex));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000604 rcu_assign_pointer(d->memory, newmem);
605 synchronize_rcu();
606 kfree(oldmem);
607 return 0;
608}
609
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000610static long vhost_set_vring(struct vhost_dev *d, int ioctl, void __user *argp)
611{
Al Virocecb46f2012-08-27 14:21:39 -0400612 struct file *eventfp, *filep = NULL;
613 bool pollstart = false, pollstop = false;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000614 struct eventfd_ctx *ctx = NULL;
615 u32 __user *idxp = argp;
616 struct vhost_virtqueue *vq;
617 struct vhost_vring_state s;
618 struct vhost_vring_file f;
619 struct vhost_vring_addr a;
620 u32 idx;
621 long r;
622
623 r = get_user(idx, idxp);
624 if (r < 0)
625 return r;
Krishna Kumar0f3d9a12010-05-25 11:10:36 +0530626 if (idx >= d->nvqs)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000627 return -ENOBUFS;
628
629 vq = d->vqs + idx;
630
631 mutex_lock(&vq->mutex);
632
633 switch (ioctl) {
634 case VHOST_SET_VRING_NUM:
635 /* Resizing ring with an active backend?
636 * You don't want to do that. */
637 if (vq->private_data) {
638 r = -EBUSY;
639 break;
640 }
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900641 if (copy_from_user(&s, argp, sizeof s)) {
642 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000643 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900644 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000645 if (!s.num || s.num > 0xffff || (s.num & (s.num - 1))) {
646 r = -EINVAL;
647 break;
648 }
649 vq->num = s.num;
650 break;
651 case VHOST_SET_VRING_BASE:
652 /* Moving base 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 > 0xffff) {
663 r = -EINVAL;
664 break;
665 }
666 vq->last_avail_idx = s.num;
667 /* Forget the cached index value. */
668 vq->avail_idx = vq->last_avail_idx;
669 break;
670 case VHOST_GET_VRING_BASE:
671 s.index = idx;
672 s.num = vq->last_avail_idx;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900673 if (copy_to_user(argp, &s, sizeof s))
674 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000675 break;
676 case VHOST_SET_VRING_ADDR:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900677 if (copy_from_user(&a, argp, sizeof a)) {
678 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000679 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900680 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000681 if (a.flags & ~(0x1 << VHOST_VRING_F_LOG)) {
682 r = -EOPNOTSUPP;
683 break;
684 }
685 /* For 32bit, verify that the top 32bits of the user
686 data are set to zero. */
687 if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
688 (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
689 (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr) {
690 r = -EFAULT;
691 break;
692 }
693 if ((a.avail_user_addr & (sizeof *vq->avail->ring - 1)) ||
694 (a.used_user_addr & (sizeof *vq->used->ring - 1)) ||
695 (a.log_guest_addr & (sizeof *vq->used->ring - 1))) {
696 r = -EINVAL;
697 break;
698 }
699
700 /* We only verify access here if backend is configured.
701 * If it is not, we don't as size might not have been setup.
702 * We will verify when backend is configured. */
703 if (vq->private_data) {
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300704 if (!vq_access_ok(d, vq->num,
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000705 (void __user *)(unsigned long)a.desc_user_addr,
706 (void __user *)(unsigned long)a.avail_user_addr,
707 (void __user *)(unsigned long)a.used_user_addr)) {
708 r = -EINVAL;
709 break;
710 }
711
712 /* Also validate log access for used ring if enabled. */
713 if ((a.flags & (0x1 << VHOST_VRING_F_LOG)) &&
714 !log_access_ok(vq->log_base, a.log_guest_addr,
715 sizeof *vq->used +
716 vq->num * sizeof *vq->used->ring)) {
717 r = -EINVAL;
718 break;
719 }
720 }
721
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000722 vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
723 vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
724 vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
725 vq->log_addr = a.log_guest_addr;
726 vq->used = (void __user *)(unsigned long)a.used_user_addr;
727 break;
728 case VHOST_SET_VRING_KICK:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900729 if (copy_from_user(&f, argp, sizeof f)) {
730 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000731 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900732 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000733 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200734 if (IS_ERR(eventfp)) {
735 r = PTR_ERR(eventfp);
736 break;
737 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000738 if (eventfp != vq->kick) {
Al Virocecb46f2012-08-27 14:21:39 -0400739 pollstop = (filep = vq->kick) != NULL;
740 pollstart = (vq->kick = eventfp) != NULL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000741 } else
742 filep = eventfp;
743 break;
744 case VHOST_SET_VRING_CALL:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900745 if (copy_from_user(&f, argp, sizeof f)) {
746 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000747 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900748 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000749 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200750 if (IS_ERR(eventfp)) {
751 r = PTR_ERR(eventfp);
752 break;
753 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000754 if (eventfp != vq->call) {
755 filep = vq->call;
756 ctx = vq->call_ctx;
757 vq->call = eventfp;
758 vq->call_ctx = eventfp ?
759 eventfd_ctx_fileget(eventfp) : NULL;
760 } else
761 filep = eventfp;
762 break;
763 case VHOST_SET_VRING_ERR:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900764 if (copy_from_user(&f, argp, sizeof f)) {
765 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000766 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900767 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000768 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
Michael S. Tsirkin535297a2010-03-17 16:06:11 +0200769 if (IS_ERR(eventfp)) {
770 r = PTR_ERR(eventfp);
771 break;
772 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000773 if (eventfp != vq->error) {
774 filep = vq->error;
775 vq->error = eventfp;
776 ctx = vq->error_ctx;
777 vq->error_ctx = eventfp ?
778 eventfd_ctx_fileget(eventfp) : NULL;
779 } else
780 filep = eventfp;
781 break;
782 default:
783 r = -ENOIOCTLCMD;
784 }
785
786 if (pollstop && vq->handle_kick)
787 vhost_poll_stop(&vq->poll);
788
789 if (ctx)
790 eventfd_ctx_put(ctx);
791 if (filep)
792 fput(filep);
793
794 if (pollstart && vq->handle_kick)
795 vhost_poll_start(&vq->poll, vq->kick);
796
797 mutex_unlock(&vq->mutex);
798
799 if (pollstop && vq->handle_kick)
800 vhost_poll_flush(&vq->poll);
801 return r;
802}
803
804/* Caller must have device mutex */
805long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, unsigned long arg)
806{
807 void __user *argp = (void __user *)arg;
808 struct file *eventfp, *filep = NULL;
809 struct eventfd_ctx *ctx = NULL;
810 u64 p;
811 long r;
812 int i, fd;
813
814 /* If you are not the owner, you can become one */
815 if (ioctl == VHOST_SET_OWNER) {
816 r = vhost_dev_set_owner(d);
817 goto done;
818 }
819
820 /* You must be the owner to do anything else */
821 r = vhost_dev_check_owner(d);
822 if (r)
823 goto done;
824
825 switch (ioctl) {
826 case VHOST_SET_MEM_TABLE:
827 r = vhost_set_memory(d, argp);
828 break;
829 case VHOST_SET_LOG_BASE:
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900830 if (copy_from_user(&p, argp, sizeof p)) {
831 r = -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000832 break;
Takuya Yoshikawa7ad9c9d2010-05-27 18:58:03 +0900833 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000834 if ((u64)(unsigned long)p != p) {
835 r = -EFAULT;
836 break;
837 }
838 for (i = 0; i < d->nvqs; ++i) {
839 struct vhost_virtqueue *vq;
840 void __user *base = (void __user *)(unsigned long)p;
841 vq = d->vqs + i;
842 mutex_lock(&vq->mutex);
843 /* If ring is inactive, will check when it's enabled. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +0300844 if (vq->private_data && !vq_log_access_ok(d, vq, base))
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000845 r = -EFAULT;
846 else
847 vq->log_base = base;
848 mutex_unlock(&vq->mutex);
849 }
850 break;
851 case VHOST_SET_LOG_FD:
852 r = get_user(fd, (int __user *)argp);
853 if (r < 0)
854 break;
855 eventfp = fd == -1 ? NULL : eventfd_fget(fd);
856 if (IS_ERR(eventfp)) {
857 r = PTR_ERR(eventfp);
858 break;
859 }
860 if (eventfp != d->log_file) {
861 filep = d->log_file;
862 ctx = d->log_ctx;
863 d->log_ctx = eventfp ?
864 eventfd_ctx_fileget(eventfp) : NULL;
865 } else
866 filep = eventfp;
867 for (i = 0; i < d->nvqs; ++i) {
868 mutex_lock(&d->vqs[i].mutex);
869 d->vqs[i].log_ctx = d->log_ctx;
870 mutex_unlock(&d->vqs[i].mutex);
871 }
872 if (ctx)
873 eventfd_ctx_put(ctx);
874 if (filep)
875 fput(filep);
876 break;
877 default:
878 r = vhost_set_vring(d, ioctl, argp);
879 break;
880 }
881done:
882 return r;
883}
884
885static const struct vhost_memory_region *find_region(struct vhost_memory *mem,
886 __u64 addr, __u32 len)
887{
888 struct vhost_memory_region *reg;
889 int i;
Krishna Kumard47effe2011-03-01 17:06:37 +0530890
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000891 /* linear search is not brilliant, but we really have on the order of 6
892 * regions in practice */
893 for (i = 0; i < mem->nregions; ++i) {
894 reg = mem->regions + i;
895 if (reg->guest_phys_addr <= addr &&
896 reg->guest_phys_addr + reg->memory_size - 1 >= addr)
897 return reg;
898 }
899 return NULL;
900}
901
902/* TODO: This is really inefficient. We need something like get_user()
903 * (instruction directly accesses the data, with an exception table entry
904 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
905 */
906static int set_bit_to_user(int nr, void __user *addr)
907{
908 unsigned long log = (unsigned long)addr;
909 struct page *page;
910 void *base;
911 int bit = nr + (log % PAGE_SIZE) * 8;
912 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +0530913
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000914 r = get_user_pages_fast(log, 1, 1, &page);
Michael S. Tsirkind6db3f52010-02-23 11:25:23 +0200915 if (r < 0)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000916 return r;
Michael S. Tsirkind6db3f52010-02-23 11:25:23 +0200917 BUG_ON(r != 1);
Cong Wangc6daa7f2011-11-25 23:14:26 +0800918 base = kmap_atomic(page);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000919 set_bit(bit, base);
Cong Wangc6daa7f2011-11-25 23:14:26 +0800920 kunmap_atomic(base);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000921 set_page_dirty_lock(page);
922 put_page(page);
923 return 0;
924}
925
926static int log_write(void __user *log_base,
927 u64 write_address, u64 write_length)
928{
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200929 u64 write_page = write_address / VHOST_PAGE_SIZE;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000930 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +0530931
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000932 if (!write_length)
933 return 0;
Michael S. Tsirkin3bf9be42010-11-29 10:19:07 +0200934 write_length += write_address % VHOST_PAGE_SIZE;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000935 for (;;) {
936 u64 base = (u64)(unsigned long)log_base;
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200937 u64 log = base + write_page / 8;
938 int bit = write_page % 8;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000939 if ((u64)(unsigned long)log != log)
940 return -EFAULT;
941 r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
942 if (r < 0)
943 return r;
944 if (write_length <= VHOST_PAGE_SIZE)
945 break;
946 write_length -= VHOST_PAGE_SIZE;
Michael S. Tsirkin28831ee2010-11-29 10:22:10 +0200947 write_page += 1;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000948 }
949 return r;
950}
951
952int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
953 unsigned int log_num, u64 len)
954{
955 int i, r;
956
957 /* Make sure data written is seen before log. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +0000958 smp_wmb();
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000959 for (i = 0; i < log_num; ++i) {
960 u64 l = min(log[i].len, len);
961 r = log_write(vq->log_base, log[i].addr, l);
962 if (r < 0)
963 return r;
964 len -= l;
Michael S. Tsirkin5786aee2010-09-22 12:31:53 +0200965 if (!len) {
966 if (vq->log_ctx)
967 eventfd_signal(vq->log_ctx, 1);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000968 return 0;
Michael S. Tsirkin5786aee2010-09-22 12:31:53 +0200969 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000970 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +0000971 /* Length written exceeds what we have stored. This is a bug. */
972 BUG();
973 return 0;
974}
975
Jason Wang2723fea2011-06-21 18:04:38 +0800976static int vhost_update_used_flags(struct vhost_virtqueue *vq)
977{
978 void __user *used;
Michael S. Tsirkinb8342262011-07-19 17:15:43 +0300979 if (__put_user(vq->used_flags, &vq->used->flags) < 0)
Jason Wang2723fea2011-06-21 18:04:38 +0800980 return -EFAULT;
981 if (unlikely(vq->log_used)) {
982 /* Make sure the flag is seen before log. */
983 smp_wmb();
984 /* Log used flag write. */
985 used = &vq->used->flags;
986 log_write(vq->log_base, vq->log_addr +
987 (used - (void __user *)vq->used),
988 sizeof vq->used->flags);
989 if (vq->log_ctx)
990 eventfd_signal(vq->log_ctx, 1);
991 }
992 return 0;
993}
994
995static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
996{
Michael S. Tsirkinb8342262011-07-19 17:15:43 +0300997 if (__put_user(vq->avail_idx, vhost_avail_event(vq)))
Jason Wang2723fea2011-06-21 18:04:38 +0800998 return -EFAULT;
999 if (unlikely(vq->log_used)) {
1000 void __user *used;
1001 /* Make sure the event is seen before log. */
1002 smp_wmb();
1003 /* Log avail event write */
1004 used = vhost_avail_event(vq);
1005 log_write(vq->log_base, vq->log_addr +
1006 (used - (void __user *)vq->used),
1007 sizeof *vhost_avail_event(vq));
1008 if (vq->log_ctx)
1009 eventfd_signal(vq->log_ctx, 1);
1010 }
1011 return 0;
1012}
1013
1014int vhost_init_used(struct vhost_virtqueue *vq)
1015{
1016 int r;
1017 if (!vq->private_data)
1018 return 0;
1019
1020 r = vhost_update_used_flags(vq);
1021 if (r)
1022 return r;
1023 vq->signalled_used_valid = false;
1024 return get_user(vq->last_used_idx, &vq->used->idx);
1025}
1026
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001027static int translate_desc(struct vhost_dev *dev, u64 addr, u32 len,
1028 struct iovec iov[], int iov_size)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001029{
1030 const struct vhost_memory_region *reg;
1031 struct vhost_memory *mem;
1032 struct iovec *_iov;
1033 u64 s = 0;
1034 int ret = 0;
1035
1036 rcu_read_lock();
1037
1038 mem = rcu_dereference(dev->memory);
1039 while ((u64)len > s) {
1040 u64 size;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001041 if (unlikely(ret >= iov_size)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001042 ret = -ENOBUFS;
1043 break;
1044 }
1045 reg = find_region(mem, addr, len);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001046 if (unlikely(!reg)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001047 ret = -EFAULT;
1048 break;
1049 }
1050 _iov = iov + ret;
1051 size = reg->memory_size - addr + reg->guest_phys_addr;
1052 _iov->iov_len = min((u64)len, size);
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001053 _iov->iov_base = (void __user *)(unsigned long)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001054 (reg->userspace_addr + addr - reg->guest_phys_addr);
1055 s += size;
1056 addr += size;
1057 ++ret;
1058 }
1059
1060 rcu_read_unlock();
1061 return ret;
1062}
1063
1064/* Each buffer in the virtqueues is actually a chain of descriptors. This
1065 * function returns the next descriptor in the chain,
1066 * or -1U if we're at the end. */
1067static unsigned next_desc(struct vring_desc *desc)
1068{
1069 unsigned int next;
1070
1071 /* If this descriptor says it doesn't chain, we're done. */
1072 if (!(desc->flags & VRING_DESC_F_NEXT))
1073 return -1U;
1074
1075 /* Check they're not leading us off end of descriptors. */
1076 next = desc->next;
1077 /* Make sure compiler knows to grab that: we don't want it changing! */
1078 /* We will use the result as an index in an array, so most
1079 * architectures only need a compiler barrier here. */
1080 read_barrier_depends();
1081
1082 return next;
1083}
1084
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001085static int get_indirect(struct vhost_dev *dev, struct vhost_virtqueue *vq,
1086 struct iovec iov[], unsigned int iov_size,
1087 unsigned int *out_num, unsigned int *in_num,
1088 struct vhost_log *log, unsigned int *log_num,
1089 struct vring_desc *indirect)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001090{
1091 struct vring_desc desc;
1092 unsigned int i = 0, count, found = 0;
1093 int ret;
1094
1095 /* Sanity check */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001096 if (unlikely(indirect->len % sizeof desc)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001097 vq_err(vq, "Invalid length in indirect descriptor: "
1098 "len 0x%llx not multiple of 0x%zx\n",
1099 (unsigned long long)indirect->len,
1100 sizeof desc);
1101 return -EINVAL;
1102 }
1103
1104 ret = translate_desc(dev, indirect->addr, indirect->len, vq->indirect,
Jason Wange0e9b402010-09-14 23:53:05 +08001105 UIO_MAXIOV);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001106 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001107 vq_err(vq, "Translation failure %d in indirect.\n", ret);
1108 return ret;
1109 }
1110
1111 /* We will use the result as an address to read from, so most
1112 * architectures only need a compiler barrier here. */
1113 read_barrier_depends();
1114
1115 count = indirect->len / sizeof desc;
1116 /* Buffers are chained via a 16 bit next field, so
1117 * we can have at most 2^16 of these. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001118 if (unlikely(count > USHRT_MAX + 1)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001119 vq_err(vq, "Indirect buffer length too big: %d\n",
1120 indirect->len);
1121 return -E2BIG;
1122 }
1123
1124 do {
1125 unsigned iov_count = *in_num + *out_num;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001126 if (unlikely(++found > count)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001127 vq_err(vq, "Loop detected: last one at %u "
1128 "indirect size %u\n",
1129 i, count);
1130 return -EINVAL;
1131 }
Krishna Kumard47effe2011-03-01 17:06:37 +05301132 if (unlikely(memcpy_fromiovec((unsigned char *)&desc,
1133 vq->indirect, sizeof desc))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001134 vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
1135 i, (size_t)indirect->addr + i * sizeof desc);
1136 return -EINVAL;
1137 }
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001138 if (unlikely(desc.flags & VRING_DESC_F_INDIRECT)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001139 vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
1140 i, (size_t)indirect->addr + i * sizeof desc);
1141 return -EINVAL;
1142 }
1143
1144 ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
1145 iov_size - iov_count);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001146 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001147 vq_err(vq, "Translation failure %d indirect idx %d\n",
1148 ret, i);
1149 return ret;
1150 }
1151 /* If this is an input descriptor, increment that count. */
1152 if (desc.flags & VRING_DESC_F_WRITE) {
1153 *in_num += ret;
1154 if (unlikely(log)) {
1155 log[*log_num].addr = desc.addr;
1156 log[*log_num].len = desc.len;
1157 ++*log_num;
1158 }
1159 } else {
1160 /* If it's an output descriptor, they're all supposed
1161 * to come before any input descriptors. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001162 if (unlikely(*in_num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001163 vq_err(vq, "Indirect descriptor "
1164 "has out after in: idx %d\n", i);
1165 return -EINVAL;
1166 }
1167 *out_num += ret;
1168 }
1169 } while ((i = next_desc(&desc)) != -1);
1170 return 0;
1171}
1172
1173/* This looks in the virtqueue and for the first available buffer, and converts
1174 * it to an iovec for convenient access. Since descriptors consist of some
1175 * number of output then some number of input descriptors, it's actually two
1176 * iovecs, but we pack them into one and note how many of each there were.
1177 *
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001178 * This function returns the descriptor number found, or vq->num (which is
1179 * never a valid descriptor number) if none was found. A negative code is
1180 * returned on error. */
1181int vhost_get_vq_desc(struct vhost_dev *dev, struct vhost_virtqueue *vq,
1182 struct iovec iov[], unsigned int iov_size,
1183 unsigned int *out_num, unsigned int *in_num,
1184 struct vhost_log *log, unsigned int *log_num)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001185{
1186 struct vring_desc desc;
1187 unsigned int i, head, found = 0;
1188 u16 last_avail_idx;
1189 int ret;
1190
1191 /* Check it isn't doing very strange things with descriptor numbers. */
1192 last_avail_idx = vq->last_avail_idx;
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001193 if (unlikely(__get_user(vq->avail_idx, &vq->avail->idx))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001194 vq_err(vq, "Failed to access avail idx at %p\n",
1195 &vq->avail->idx);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001196 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001197 }
1198
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001199 if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001200 vq_err(vq, "Guest moved used index from %u to %u",
1201 last_avail_idx, vq->avail_idx);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001202 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001203 }
1204
1205 /* If there's nothing new since last we looked, return invalid. */
1206 if (vq->avail_idx == last_avail_idx)
1207 return vq->num;
1208
1209 /* Only get avail ring entries after they have been exposed by guest. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001210 smp_rmb();
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001211
1212 /* Grab the next descriptor number they're advertising, and increment
1213 * the index we've seen. */
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001214 if (unlikely(__get_user(head,
1215 &vq->avail->ring[last_avail_idx % vq->num]))) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001216 vq_err(vq, "Failed to read head: idx %d address %p\n",
1217 last_avail_idx,
1218 &vq->avail->ring[last_avail_idx % vq->num]);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001219 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001220 }
1221
1222 /* If their number is silly, that's an error. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001223 if (unlikely(head >= vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001224 vq_err(vq, "Guest says index %u > %u is available",
1225 head, vq->num);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001226 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001227 }
1228
1229 /* When we start there are none of either input nor output. */
1230 *out_num = *in_num = 0;
1231 if (unlikely(log))
1232 *log_num = 0;
1233
1234 i = head;
1235 do {
1236 unsigned iov_count = *in_num + *out_num;
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001237 if (unlikely(i >= vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001238 vq_err(vq, "Desc index is %u > %u, head = %u",
1239 i, vq->num, head);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001240 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001241 }
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001242 if (unlikely(++found > vq->num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001243 vq_err(vq, "Loop detected: last one at %u "
1244 "vq size %u head %u\n",
1245 i, vq->num, head);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001246 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001247 }
Michael S. Tsirkinfcc042a2011-03-06 13:33:49 +02001248 ret = __copy_from_user(&desc, vq->desc + i, sizeof desc);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001249 if (unlikely(ret)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001250 vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
1251 i, vq->desc + i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001252 return -EFAULT;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001253 }
1254 if (desc.flags & VRING_DESC_F_INDIRECT) {
1255 ret = get_indirect(dev, vq, iov, iov_size,
1256 out_num, in_num,
1257 log, log_num, &desc);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001258 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001259 vq_err(vq, "Failure detected "
1260 "in indirect descriptor at idx %d\n", i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001261 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001262 }
1263 continue;
1264 }
1265
1266 ret = translate_desc(dev, desc.addr, desc.len, iov + iov_count,
1267 iov_size - iov_count);
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001268 if (unlikely(ret < 0)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001269 vq_err(vq, "Translation failure %d descriptor idx %d\n",
1270 ret, i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001271 return ret;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001272 }
1273 if (desc.flags & VRING_DESC_F_WRITE) {
1274 /* If this is an input descriptor,
1275 * increment that count. */
1276 *in_num += ret;
1277 if (unlikely(log)) {
1278 log[*log_num].addr = desc.addr;
1279 log[*log_num].len = desc.len;
1280 ++*log_num;
1281 }
1282 } else {
1283 /* If it's an output descriptor, they're all supposed
1284 * to come before any input descriptors. */
Michael S. Tsirkin7b3384f2010-07-01 18:40:12 +03001285 if (unlikely(*in_num)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001286 vq_err(vq, "Descriptor has out after in: "
1287 "idx %d\n", i);
Michael S. Tsirkind5675bd2010-06-24 16:59:59 +03001288 return -EINVAL;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001289 }
1290 *out_num += ret;
1291 }
1292 } while ((i = next_desc(&desc)) != -1);
1293
1294 /* On success, increment avail index. */
1295 vq->last_avail_idx++;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001296
1297 /* Assume notifications from guest are disabled at this point,
1298 * if they aren't we would need to update avail_event index. */
1299 BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001300 return head;
1301}
1302
1303/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
David Stevens8dd014a2010-07-27 18:52:21 +03001304void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001305{
David Stevens8dd014a2010-07-27 18:52:21 +03001306 vq->last_avail_idx -= n;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001307}
1308
1309/* After we've used one of their buffers, we tell them about it. We'll then
1310 * want to notify the guest, using eventfd. */
1311int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
1312{
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001313 struct vring_used_elem __user *used;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001314
1315 /* The virtqueue contains a ring of used buffers. Get a pointer to the
1316 * next entry in that used ring. */
1317 used = &vq->used->ring[vq->last_used_idx % vq->num];
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001318 if (__put_user(head, &used->id)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001319 vq_err(vq, "Failed to write used id");
1320 return -EFAULT;
1321 }
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001322 if (__put_user(len, &used->len)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001323 vq_err(vq, "Failed to write used len");
1324 return -EFAULT;
1325 }
1326 /* Make sure buffer is written before we update index. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001327 smp_wmb();
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001328 if (__put_user(vq->last_used_idx + 1, &vq->used->idx)) {
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001329 vq_err(vq, "Failed to increment used idx");
1330 return -EFAULT;
1331 }
1332 if (unlikely(vq->log_used)) {
1333 /* Make sure data is seen before log. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001334 smp_wmb();
Michael S. Tsirkin86e94242010-02-17 19:11:33 +02001335 /* Log used ring entry write. */
1336 log_write(vq->log_base,
Christoph Hellwiga8d37822010-04-13 14:11:25 -04001337 vq->log_addr +
1338 ((void __user *)used - (void __user *)vq->used),
Michael S. Tsirkin86e94242010-02-17 19:11:33 +02001339 sizeof *used);
1340 /* Log used index update. */
1341 log_write(vq->log_base,
1342 vq->log_addr + offsetof(struct vring_used, idx),
1343 sizeof vq->used->idx);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001344 if (vq->log_ctx)
1345 eventfd_signal(vq->log_ctx, 1);
1346 }
1347 vq->last_used_idx++;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001348 /* If the driver never bothers to signal in a very long while,
1349 * used index might wrap around. If that happens, invalidate
1350 * signalled_used index we stored. TODO: make sure driver
1351 * signals at least once in 2^16 and remove this. */
1352 if (unlikely(vq->last_used_idx == vq->signalled_used))
1353 vq->signalled_used_valid = false;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001354 return 0;
1355}
1356
David Stevens8dd014a2010-07-27 18:52:21 +03001357static int __vhost_add_used_n(struct vhost_virtqueue *vq,
1358 struct vring_used_elem *heads,
1359 unsigned count)
1360{
1361 struct vring_used_elem __user *used;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001362 u16 old, new;
David Stevens8dd014a2010-07-27 18:52:21 +03001363 int start;
1364
1365 start = vq->last_used_idx % vq->num;
1366 used = vq->used->ring + start;
Michael S. Tsirkindfe5ac52010-09-21 14:18:01 +02001367 if (__copy_to_user(used, heads, count * sizeof *used)) {
David Stevens8dd014a2010-07-27 18:52:21 +03001368 vq_err(vq, "Failed to write used");
1369 return -EFAULT;
1370 }
1371 if (unlikely(vq->log_used)) {
1372 /* Make sure data is seen before log. */
1373 smp_wmb();
1374 /* Log used ring entry write. */
1375 log_write(vq->log_base,
1376 vq->log_addr +
1377 ((void __user *)used - (void __user *)vq->used),
1378 count * sizeof *used);
1379 }
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001380 old = vq->last_used_idx;
1381 new = (vq->last_used_idx += count);
1382 /* If the driver never bothers to signal in a very long while,
1383 * used index might wrap around. If that happens, invalidate
1384 * signalled_used index we stored. TODO: make sure driver
1385 * signals at least once in 2^16 and remove this. */
1386 if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
1387 vq->signalled_used_valid = false;
David Stevens8dd014a2010-07-27 18:52:21 +03001388 return 0;
1389}
1390
1391/* After we've used one of their buffers, we tell them about it. We'll then
1392 * want to notify the guest, using eventfd. */
1393int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
1394 unsigned count)
1395{
1396 int start, n, r;
1397
1398 start = vq->last_used_idx % vq->num;
1399 n = vq->num - start;
1400 if (n < count) {
1401 r = __vhost_add_used_n(vq, heads, n);
1402 if (r < 0)
1403 return r;
1404 heads += n;
1405 count -= n;
1406 }
1407 r = __vhost_add_used_n(vq, heads, count);
1408
1409 /* Make sure buffer is written before we update index. */
1410 smp_wmb();
1411 if (put_user(vq->last_used_idx, &vq->used->idx)) {
1412 vq_err(vq, "Failed to increment used idx");
1413 return -EFAULT;
1414 }
1415 if (unlikely(vq->log_used)) {
1416 /* Log used index update. */
1417 log_write(vq->log_base,
1418 vq->log_addr + offsetof(struct vring_used, idx),
1419 sizeof vq->used->idx);
1420 if (vq->log_ctx)
1421 eventfd_signal(vq->log_ctx, 1);
1422 }
1423 return r;
1424}
1425
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001426static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001427{
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001428 __u16 old, new, event;
1429 bool v;
Michael S. Tsirkin0d499352010-05-11 19:44:17 +03001430 /* Flush out used index updates. This is paired
1431 * with the barrier that the Guest executes when enabling
1432 * interrupts. */
1433 smp_mb();
1434
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001435 if (vhost_has_feature(dev, VIRTIO_F_NOTIFY_ON_EMPTY) &&
1436 unlikely(vq->avail_idx == vq->last_avail_idx))
1437 return true;
1438
1439 if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
1440 __u16 flags;
1441 if (__get_user(flags, &vq->avail->flags)) {
1442 vq_err(vq, "Failed to get flags");
1443 return true;
1444 }
1445 return !(flags & VRING_AVAIL_F_NO_INTERRUPT);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001446 }
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001447 old = vq->signalled_used;
1448 v = vq->signalled_used_valid;
1449 new = vq->signalled_used = vq->last_used_idx;
1450 vq->signalled_used_valid = true;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001451
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001452 if (unlikely(!v))
1453 return true;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001454
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001455 if (get_user(event, vhost_used_event(vq))) {
1456 vq_err(vq, "Failed to get used event idx");
1457 return true;
1458 }
1459 return vring_need_event(event, new, old);
1460}
1461
1462/* This actually signals the guest, using eventfd. */
1463void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
1464{
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001465 /* Signal the Guest tell them we used something up. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001466 if (vq->call_ctx && vhost_notify(dev, vq))
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001467 eventfd_signal(vq->call_ctx, 1);
1468}
1469
1470/* And here's the combo meal deal. Supersize me! */
1471void vhost_add_used_and_signal(struct vhost_dev *dev,
1472 struct vhost_virtqueue *vq,
1473 unsigned int head, int len)
1474{
1475 vhost_add_used(vq, head, len);
1476 vhost_signal(dev, vq);
1477}
1478
David Stevens8dd014a2010-07-27 18:52:21 +03001479/* multi-buffer version of vhost_add_used_and_signal */
1480void vhost_add_used_and_signal_n(struct vhost_dev *dev,
1481 struct vhost_virtqueue *vq,
1482 struct vring_used_elem *heads, unsigned count)
1483{
1484 vhost_add_used_n(vq, heads, count);
1485 vhost_signal(dev, vq);
1486}
1487
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001488/* OK, now we need to know about added descriptors. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001489bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001490{
1491 u16 avail_idx;
1492 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +05301493
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001494 if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
1495 return false;
1496 vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001497 if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
Jason Wang2723fea2011-06-21 18:04:38 +08001498 r = vhost_update_used_flags(vq);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001499 if (r) {
1500 vq_err(vq, "Failed to enable notification at %p: %d\n",
1501 &vq->used->flags, r);
1502 return false;
1503 }
1504 } else {
Jason Wang2723fea2011-06-21 18:04:38 +08001505 r = vhost_update_avail_event(vq, vq->avail_idx);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001506 if (r) {
1507 vq_err(vq, "Failed to update avail event index at %p: %d\n",
1508 vhost_avail_event(vq), r);
1509 return false;
1510 }
1511 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001512 /* They could have slipped one in as we were doing that: make
1513 * sure it's written, then check again. */
Michael S. Tsirkin56593382010-02-01 07:21:02 +00001514 smp_mb();
Michael S. Tsirkin8b7347a2010-09-19 15:56:30 +02001515 r = __get_user(avail_idx, &vq->avail->idx);
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001516 if (r) {
1517 vq_err(vq, "Failed to check avail idx at %p: %d\n",
1518 &vq->avail->idx, r);
1519 return false;
1520 }
1521
David Stevens8dd014a2010-07-27 18:52:21 +03001522 return avail_idx != vq->avail_idx;
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001523}
1524
1525/* We don't need to be notified again. */
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001526void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001527{
1528 int r;
Krishna Kumard47effe2011-03-01 17:06:37 +05301529
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001530 if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
1531 return;
1532 vq->used_flags |= VRING_USED_F_NO_NOTIFY;
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001533 if (!vhost_has_feature(dev, VIRTIO_RING_F_EVENT_IDX)) {
Jason Wang2723fea2011-06-21 18:04:38 +08001534 r = vhost_update_used_flags(vq);
Michael S. Tsirkin8ea8cf82011-05-20 02:10:54 +03001535 if (r)
1536 vq_err(vq, "Failed to enable notification at %p: %d\n",
1537 &vq->used->flags, r);
1538 }
Michael S. Tsirkin3a4d5c94e2010-01-14 06:17:27 +00001539}
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +00001540
1541static void vhost_zerocopy_done_signal(struct kref *kref)
1542{
1543 struct vhost_ubuf_ref *ubufs = container_of(kref, struct vhost_ubuf_ref,
1544 kref);
1545 wake_up(&ubufs->wait);
1546}
1547
1548struct vhost_ubuf_ref *vhost_ubuf_alloc(struct vhost_virtqueue *vq,
1549 bool zcopy)
1550{
1551 struct vhost_ubuf_ref *ubufs;
1552 /* No zero copy backend? Nothing to count. */
1553 if (!zcopy)
1554 return NULL;
1555 ubufs = kmalloc(sizeof *ubufs, GFP_KERNEL);
1556 if (!ubufs)
1557 return ERR_PTR(-ENOMEM);
1558 kref_init(&ubufs->kref);
Michael S. Tsirkinbab632d2011-07-18 03:48:46 +00001559 init_waitqueue_head(&ubufs->wait);
1560 ubufs->vq = vq;
1561 return ubufs;
1562}
1563
1564void vhost_ubuf_put(struct vhost_ubuf_ref *ubufs)
1565{
1566 kref_put(&ubufs->kref, vhost_zerocopy_done_signal);
1567}
1568
1569void vhost_ubuf_put_and_wait(struct vhost_ubuf_ref *ubufs)
1570{
1571 kref_put(&ubufs->kref, vhost_zerocopy_done_signal);
1572 wait_event(ubufs->wait, !atomic_read(&ubufs->kref.refcount));
1573 kfree(ubufs);
1574}