pinctrl: ocelot: fix pinmuxing for pins after 31
[linux-2.6-block.git] / drivers / vhost / vhost.c
CommitLineData
3a4d5c94
MT
1/* 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
61516587 7 * Documentation/virtual/lguest/lguest.c, by Rusty Russell
3a4d5c94
MT
8 *
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>
35596b27 16#include <linux/uio.h>
3a4d5c94 17#include <linux/mm.h>
64e1c807 18#include <linux/mmu_context.h>
3a4d5c94
MT
19#include <linux/miscdevice.h>
20#include <linux/mutex.h>
3a4d5c94
MT
21#include <linux/poll.h>
22#include <linux/file.h>
23#include <linux/highmem.h>
5a0e3ad6 24#include <linux/slab.h>
4de7255f 25#include <linux/vmalloc.h>
c23f3445 26#include <linux/kthread.h>
9e3d1957 27#include <linux/cgroup.h>
6ac1afbf 28#include <linux/module.h>
bcfeacab 29#include <linux/sort.h>
6e84f315 30#include <linux/sched/mm.h>
174cd4b1 31#include <linux/sched/signal.h>
a9709d68 32#include <linux/interval_tree_generic.h>
ff002269 33#include <linux/nospec.h>
3a4d5c94 34
3a4d5c94
MT
35#include "vhost.h"
36
c9ce42f7
IM
37static ushort max_mem_regions = 64;
38module_param(max_mem_regions, ushort, 0444);
39MODULE_PARM_DESC(max_mem_regions,
40 "Maximum number of memory regions in memory map. (default: 64)");
6b1e6cc7
JW
41static int max_iotlb_entries = 2048;
42module_param(max_iotlb_entries, int, 0444);
43MODULE_PARM_DESC(max_iotlb_entries,
44 "Maximum number of iotlb entries. (default: 2048)");
c9ce42f7 45
3a4d5c94 46enum {
3a4d5c94
MT
47 VHOST_MEMORY_F_LOG = 0x1,
48};
49
3b1bbe89
MT
50#define vhost_used_event(vq) ((__virtio16 __user *)&vq->avail->ring[vq->num])
51#define vhost_avail_event(vq) ((__virtio16 __user *)&vq->used->ring[vq->num])
8ea8cf89 52
a9709d68
JW
53INTERVAL_TREE_DEFINE(struct vhost_umem_node,
54 rb, __u64, __subtree_last,
2f952c01 55 START, LAST, static inline, vhost_umem_interval_tree);
a9709d68 56
2751c988 57#ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
c5072037 58static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
2751c988
GK
59{
60 vq->user_be = !virtio_legacy_is_little_endian();
61}
62
c5072037
GK
63static void vhost_enable_cross_endian_big(struct vhost_virtqueue *vq)
64{
65 vq->user_be = true;
66}
67
68static void vhost_enable_cross_endian_little(struct vhost_virtqueue *vq)
69{
70 vq->user_be = false;
71}
72
2751c988
GK
73static long vhost_set_vring_endian(struct vhost_virtqueue *vq, int __user *argp)
74{
75 struct vhost_vring_state s;
76
77 if (vq->private_data)
78 return -EBUSY;
79
80 if (copy_from_user(&s, argp, sizeof(s)))
81 return -EFAULT;
82
83 if (s.num != VHOST_VRING_LITTLE_ENDIAN &&
84 s.num != VHOST_VRING_BIG_ENDIAN)
85 return -EINVAL;
86
c5072037
GK
87 if (s.num == VHOST_VRING_BIG_ENDIAN)
88 vhost_enable_cross_endian_big(vq);
89 else
90 vhost_enable_cross_endian_little(vq);
2751c988
GK
91
92 return 0;
93}
94
95static long vhost_get_vring_endian(struct vhost_virtqueue *vq, u32 idx,
96 int __user *argp)
97{
98 struct vhost_vring_state s = {
99 .index = idx,
100 .num = vq->user_be
101 };
102
103 if (copy_to_user(argp, &s, sizeof(s)))
104 return -EFAULT;
105
106 return 0;
107}
108
109static void vhost_init_is_le(struct vhost_virtqueue *vq)
110{
111 /* Note for legacy virtio: user_be is initialized at reset time
112 * according to the host endianness. If userspace does not set an
113 * explicit endianness, the default behavior is native endian, as
114 * expected by legacy virtio.
115 */
116 vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1) || !vq->user_be;
117}
118#else
c5072037 119static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
2751c988
GK
120{
121}
122
123static long vhost_set_vring_endian(struct vhost_virtqueue *vq, int __user *argp)
124{
125 return -ENOIOCTLCMD;
126}
127
128static long vhost_get_vring_endian(struct vhost_virtqueue *vq, u32 idx,
129 int __user *argp)
130{
131 return -ENOIOCTLCMD;
132}
133
134static void vhost_init_is_le(struct vhost_virtqueue *vq)
135{
cda8bba0
HP
136 vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1)
137 || virtio_legacy_is_little_endian();
2751c988
GK
138}
139#endif /* CONFIG_VHOST_CROSS_ENDIAN_LEGACY */
140
c5072037
GK
141static void vhost_reset_is_le(struct vhost_virtqueue *vq)
142{
cda8bba0 143 vhost_init_is_le(vq);
c5072037
GK
144}
145
7235acdb
JW
146struct vhost_flush_struct {
147 struct vhost_work work;
148 struct completion wait_event;
149};
150
151static void vhost_flush_work(struct vhost_work *work)
152{
153 struct vhost_flush_struct *s;
154
155 s = container_of(work, struct vhost_flush_struct, work);
156 complete(&s->wait_event);
157}
158
3a4d5c94
MT
159static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
160 poll_table *pt)
161{
162 struct vhost_poll *poll;
3a4d5c94 163
d47effe1 164 poll = container_of(pt, struct vhost_poll, table);
3a4d5c94
MT
165 poll->wqh = wqh;
166 add_wait_queue(wqh, &poll->wait);
167}
168
ac6424b9 169static int vhost_poll_wakeup(wait_queue_entry_t *wait, unsigned mode, int sync,
3a4d5c94
MT
170 void *key)
171{
c23f3445
TH
172 struct vhost_poll *poll = container_of(wait, struct vhost_poll, wait);
173
3ad6f93e 174 if (!(key_to_poll(key) & poll->mask))
3a4d5c94
MT
175 return 0;
176
c23f3445 177 vhost_poll_queue(poll);
3a4d5c94
MT
178 return 0;
179}
180
163049ae 181void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
87d6a412 182{
04b96e55 183 clear_bit(VHOST_WORK_QUEUED, &work->flags);
87d6a412 184 work->fn = fn;
87d6a412 185}
6ac1afbf 186EXPORT_SYMBOL_GPL(vhost_work_init);
87d6a412 187
3a4d5c94 188/* Init poll structure */
c23f3445 189void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
58e3b602 190 __poll_t mask, struct vhost_dev *dev)
3a4d5c94 191{
3a4d5c94
MT
192 init_waitqueue_func_entry(&poll->wait, vhost_poll_wakeup);
193 init_poll_funcptr(&poll->table, vhost_poll_func);
194 poll->mask = mask;
c23f3445 195 poll->dev = dev;
2b8b328b 196 poll->wqh = NULL;
c23f3445 197
87d6a412 198 vhost_work_init(&poll->work, fn);
3a4d5c94 199}
6ac1afbf 200EXPORT_SYMBOL_GPL(vhost_poll_init);
3a4d5c94
MT
201
202/* Start polling a file. We add ourselves to file's wait queue. The caller must
203 * keep a reference to a file until after vhost_poll_stop is called. */
2b8b328b 204int vhost_poll_start(struct vhost_poll *poll, struct file *file)
3a4d5c94 205{
e6c8adca 206 __poll_t mask;
2b8b328b 207 int ret = 0;
d47effe1 208
70181d51
JW
209 if (poll->wqh)
210 return 0;
211
9965ed17 212 mask = vfs_poll(file, &poll->table);
3a4d5c94 213 if (mask)
3ad6f93e 214 vhost_poll_wakeup(&poll->wait, 0, 0, poll_to_key(mask));
a9a08845 215 if (mask & EPOLLERR) {
dc6455a7 216 vhost_poll_stop(poll);
2b8b328b
JW
217 ret = -EINVAL;
218 }
219
220 return ret;
3a4d5c94 221}
6ac1afbf 222EXPORT_SYMBOL_GPL(vhost_poll_start);
3a4d5c94
MT
223
224/* Stop polling a file. After this function returns, it becomes safe to drop the
225 * file reference. You must also flush afterwards. */
226void vhost_poll_stop(struct vhost_poll *poll)
227{
2b8b328b
JW
228 if (poll->wqh) {
229 remove_wait_queue(poll->wqh, &poll->wait);
230 poll->wqh = NULL;
231 }
3a4d5c94 232}
6ac1afbf 233EXPORT_SYMBOL_GPL(vhost_poll_stop);
3a4d5c94 234
7235acdb 235void vhost_work_flush(struct vhost_dev *dev, struct vhost_work *work)
0174b0c3 236{
7235acdb 237 struct vhost_flush_struct flush;
d47effe1 238
7235acdb
JW
239 if (dev->worker) {
240 init_completion(&flush.wait_event);
241 vhost_work_init(&flush.work, vhost_flush_work);
0174b0c3 242
7235acdb
JW
243 vhost_work_queue(dev, &flush.work);
244 wait_for_completion(&flush.wait_event);
245 }
3a4d5c94 246}
6ac1afbf 247EXPORT_SYMBOL_GPL(vhost_work_flush);
3a4d5c94 248
87d6a412
MT
249/* Flush any work that has been scheduled. When calling this, don't hold any
250 * locks that are also used by the callback. */
251void vhost_poll_flush(struct vhost_poll *poll)
252{
253 vhost_work_flush(poll->dev, &poll->work);
254}
6ac1afbf 255EXPORT_SYMBOL_GPL(vhost_poll_flush);
87d6a412 256
163049ae 257void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
3a4d5c94 258{
04b96e55
JW
259 if (!dev->worker)
260 return;
c23f3445 261
04b96e55
JW
262 if (!test_and_set_bit(VHOST_WORK_QUEUED, &work->flags)) {
263 /* We can only add the work to the list after we're
264 * sure it was not in the list.
635abf01 265 * test_and_set_bit() implies a memory barrier.
04b96e55 266 */
04b96e55 267 llist_add(&work->node, &dev->work_list);
c23f3445
TH
268 wake_up_process(dev->worker);
269 }
3a4d5c94 270}
6ac1afbf 271EXPORT_SYMBOL_GPL(vhost_work_queue);
3a4d5c94 272
526d3e7f
JW
273/* A lockless hint for busy polling code to exit the loop */
274bool vhost_has_work(struct vhost_dev *dev)
275{
04b96e55 276 return !llist_empty(&dev->work_list);
526d3e7f
JW
277}
278EXPORT_SYMBOL_GPL(vhost_has_work);
279
87d6a412
MT
280void vhost_poll_queue(struct vhost_poll *poll)
281{
282 vhost_work_queue(poll->dev, &poll->work);
283}
6ac1afbf 284EXPORT_SYMBOL_GPL(vhost_poll_queue);
87d6a412 285
f8894913
JW
286static void __vhost_vq_meta_reset(struct vhost_virtqueue *vq)
287{
288 int j;
289
290 for (j = 0; j < VHOST_NUM_ADDRS; j++)
291 vq->meta_iotlb[j] = NULL;
292}
293
294static void vhost_vq_meta_reset(struct vhost_dev *d)
295{
296 int i;
297
86a07da3 298 for (i = 0; i < d->nvqs; ++i)
f8894913
JW
299 __vhost_vq_meta_reset(d->vqs[i]);
300}
301
3a4d5c94
MT
302static void vhost_vq_reset(struct vhost_dev *dev,
303 struct vhost_virtqueue *vq)
304{
305 vq->num = 1;
306 vq->desc = NULL;
307 vq->avail = NULL;
308 vq->used = NULL;
309 vq->last_avail_idx = 0;
310 vq->avail_idx = 0;
311 vq->last_used_idx = 0;
8ea8cf89
MT
312 vq->signalled_used = 0;
313 vq->signalled_used_valid = false;
3a4d5c94 314 vq->used_flags = 0;
3a4d5c94
MT
315 vq->log_used = false;
316 vq->log_addr = -1ull;
3a4d5c94 317 vq->private_data = NULL;
ea16c514 318 vq->acked_features = 0;
429711ae 319 vq->acked_backend_features = 0;
3a4d5c94
MT
320 vq->log_base = NULL;
321 vq->error_ctx = NULL;
3a4d5c94
MT
322 vq->kick = NULL;
323 vq->call_ctx = NULL;
73a99f08 324 vq->log_ctx = NULL;
c5072037
GK
325 vhost_reset_is_le(vq);
326 vhost_disable_cross_endian(vq);
03088137 327 vq->busyloop_timeout = 0;
a9709d68 328 vq->umem = NULL;
6b1e6cc7 329 vq->iotlb = NULL;
f8894913 330 __vhost_vq_meta_reset(vq);
3a4d5c94
MT
331}
332
c23f3445
TH
333static int vhost_worker(void *data)
334{
335 struct vhost_dev *dev = data;
04b96e55
JW
336 struct vhost_work *work, *work_next;
337 struct llist_node *node;
d7ffde35 338 mm_segment_t oldfs = get_fs();
c23f3445 339
d7ffde35 340 set_fs(USER_DS);
64e1c807
MT
341 use_mm(dev->mm);
342
c23f3445
TH
343 for (;;) {
344 /* mb paired w/ kthread_stop */
345 set_current_state(TASK_INTERRUPTIBLE);
346
c23f3445 347 if (kthread_should_stop()) {
c23f3445 348 __set_current_state(TASK_RUNNING);
64e1c807 349 break;
c23f3445 350 }
04b96e55
JW
351
352 node = llist_del_all(&dev->work_list);
353 if (!node)
354 schedule();
355
356 node = llist_reverse_order(node);
357 /* make sure flag is seen after deletion */
358 smp_wmb();
359 llist_for_each_entry_safe(work, work_next, node, node) {
360 clear_bit(VHOST_WORK_QUEUED, &work->flags);
c23f3445
TH
361 __set_current_state(TASK_RUNNING);
362 work->fn(work);
d550dda1
NHE
363 if (need_resched())
364 schedule();
04b96e55 365 }
c23f3445 366 }
64e1c807 367 unuse_mm(dev->mm);
d7ffde35 368 set_fs(oldfs);
64e1c807 369 return 0;
c23f3445
TH
370}
371
bab632d6
MT
372static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
373{
374 kfree(vq->indirect);
375 vq->indirect = NULL;
376 kfree(vq->log);
377 vq->log = NULL;
378 kfree(vq->heads);
379 vq->heads = NULL;
bab632d6
MT
380}
381
e0e9b406
JW
382/* Helper to allocate iovec buffers for all vqs. */
383static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
384{
6d5e6aa8 385 struct vhost_virtqueue *vq;
e0e9b406 386 int i;
d47effe1 387
e0e9b406 388 for (i = 0; i < dev->nvqs; ++i) {
6d5e6aa8 389 vq = dev->vqs[i];
6da2ec56
KC
390 vq->indirect = kmalloc_array(UIO_MAXIOV,
391 sizeof(*vq->indirect),
392 GFP_KERNEL);
b46a0bf7 393 vq->log = kmalloc_array(dev->iov_limit, sizeof(*vq->log),
6da2ec56 394 GFP_KERNEL);
b46a0bf7 395 vq->heads = kmalloc_array(dev->iov_limit, sizeof(*vq->heads),
6da2ec56 396 GFP_KERNEL);
6d5e6aa8 397 if (!vq->indirect || !vq->log || !vq->heads)
e0e9b406
JW
398 goto err_nomem;
399 }
400 return 0;
d47effe1 401
e0e9b406 402err_nomem:
bab632d6 403 for (; i >= 0; --i)
3ab2e420 404 vhost_vq_free_iovecs(dev->vqs[i]);
e0e9b406
JW
405 return -ENOMEM;
406}
407
408static void vhost_dev_free_iovecs(struct vhost_dev *dev)
409{
410 int i;
d47effe1 411
bab632d6 412 for (i = 0; i < dev->nvqs; ++i)
3ab2e420 413 vhost_vq_free_iovecs(dev->vqs[i]);
e0e9b406
JW
414}
415
59566b6e 416void vhost_dev_init(struct vhost_dev *dev,
b46a0bf7 417 struct vhost_virtqueue **vqs, int nvqs, int iov_limit)
3a4d5c94 418{
6d5e6aa8 419 struct vhost_virtqueue *vq;
3a4d5c94 420 int i;
c23f3445 421
3a4d5c94
MT
422 dev->vqs = vqs;
423 dev->nvqs = nvqs;
424 mutex_init(&dev->mutex);
425 dev->log_ctx = NULL;
a9709d68 426 dev->umem = NULL;
6b1e6cc7 427 dev->iotlb = NULL;
3a4d5c94 428 dev->mm = NULL;
c23f3445 429 dev->worker = NULL;
b46a0bf7 430 dev->iov_limit = iov_limit;
04b96e55 431 init_llist_head(&dev->work_list);
6b1e6cc7
JW
432 init_waitqueue_head(&dev->wait);
433 INIT_LIST_HEAD(&dev->read_list);
434 INIT_LIST_HEAD(&dev->pending_list);
435 spin_lock_init(&dev->iotlb_lock);
04b96e55 436
3a4d5c94
MT
437
438 for (i = 0; i < dev->nvqs; ++i) {
6d5e6aa8
AH
439 vq = dev->vqs[i];
440 vq->log = NULL;
441 vq->indirect = NULL;
442 vq->heads = NULL;
443 vq->dev = dev;
444 mutex_init(&vq->mutex);
445 vhost_vq_reset(dev, vq);
446 if (vq->handle_kick)
447 vhost_poll_init(&vq->poll, vq->handle_kick,
a9a08845 448 EPOLLIN, dev);
3a4d5c94 449 }
3a4d5c94 450}
6ac1afbf 451EXPORT_SYMBOL_GPL(vhost_dev_init);
3a4d5c94
MT
452
453/* Caller should have device mutex */
454long vhost_dev_check_owner(struct vhost_dev *dev)
455{
456 /* Are you the owner? If not, I don't think you mean to do that */
457 return dev->mm == current->mm ? 0 : -EPERM;
458}
6ac1afbf 459EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
3a4d5c94 460
87d6a412 461struct vhost_attach_cgroups_struct {
d47effe1
KK
462 struct vhost_work work;
463 struct task_struct *owner;
464 int ret;
87d6a412
MT
465};
466
467static void vhost_attach_cgroups_work(struct vhost_work *work)
468{
d47effe1
KK
469 struct vhost_attach_cgroups_struct *s;
470
471 s = container_of(work, struct vhost_attach_cgroups_struct, work);
472 s->ret = cgroup_attach_task_all(s->owner, current);
87d6a412
MT
473}
474
475static int vhost_attach_cgroups(struct vhost_dev *dev)
476{
d47effe1
KK
477 struct vhost_attach_cgroups_struct attach;
478
479 attach.owner = current;
480 vhost_work_init(&attach.work, vhost_attach_cgroups_work);
481 vhost_work_queue(dev, &attach.work);
482 vhost_work_flush(dev, &attach.work);
483 return attach.ret;
87d6a412
MT
484}
485
05c05351
MT
486/* Caller should have device mutex */
487bool vhost_dev_has_owner(struct vhost_dev *dev)
488{
489 return dev->mm;
490}
6ac1afbf 491EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
05c05351 492
3a4d5c94 493/* Caller should have device mutex */
54db63c2 494long vhost_dev_set_owner(struct vhost_dev *dev)
3a4d5c94 495{
c23f3445
TH
496 struct task_struct *worker;
497 int err;
d47effe1 498
3a4d5c94 499 /* Is there an owner already? */
05c05351 500 if (vhost_dev_has_owner(dev)) {
c23f3445
TH
501 err = -EBUSY;
502 goto err_mm;
503 }
d47effe1 504
3a4d5c94
MT
505 /* No owner, become one */
506 dev->mm = get_task_mm(current);
c23f3445
TH
507 worker = kthread_create(vhost_worker, dev, "vhost-%d", current->pid);
508 if (IS_ERR(worker)) {
509 err = PTR_ERR(worker);
510 goto err_worker;
511 }
512
513 dev->worker = worker;
87d6a412
MT
514 wake_up_process(worker); /* avoid contributing to loadavg */
515
516 err = vhost_attach_cgroups(dev);
9e3d1957
MT
517 if (err)
518 goto err_cgroup;
c23f3445 519
e0e9b406
JW
520 err = vhost_dev_alloc_iovecs(dev);
521 if (err)
522 goto err_cgroup;
523
3a4d5c94 524 return 0;
9e3d1957
MT
525err_cgroup:
526 kthread_stop(worker);
615cc221 527 dev->worker = NULL;
c23f3445
TH
528err_worker:
529 if (dev->mm)
530 mmput(dev->mm);
531 dev->mm = NULL;
532err_mm:
533 return err;
3a4d5c94 534}
6ac1afbf 535EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
3a4d5c94 536
a9709d68
JW
537struct vhost_umem *vhost_dev_reset_owner_prepare(void)
538{
6c5ab651 539 return kvzalloc(sizeof(struct vhost_umem), GFP_KERNEL);
150b9e51 540}
6ac1afbf 541EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
3a4d5c94 542
150b9e51 543/* Caller should have device mutex */
a9709d68 544void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_umem *umem)
150b9e51 545{
47283bef
MT
546 int i;
547
f6f93f75 548 vhost_dev_cleanup(dev);
3a4d5c94 549
150b9e51 550 /* Restore memory to default empty mapping. */
a9709d68
JW
551 INIT_LIST_HEAD(&umem->umem_list);
552 dev->umem = umem;
47283bef
MT
553 /* We don't need VQ locks below since vhost_dev_cleanup makes sure
554 * VQs aren't running.
555 */
556 for (i = 0; i < dev->nvqs; ++i)
a9709d68 557 dev->vqs[i]->umem = umem;
3a4d5c94 558}
6ac1afbf 559EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
3a4d5c94 560
b211616d 561void vhost_dev_stop(struct vhost_dev *dev)
bab632d6
MT
562{
563 int i;
b211616d
MT
564
565 for (i = 0; i < dev->nvqs; ++i) {
3ab2e420
AH
566 if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
567 vhost_poll_stop(&dev->vqs[i]->poll);
568 vhost_poll_flush(&dev->vqs[i]->poll);
b211616d 569 }
bab632d6 570 }
bab632d6 571}
6ac1afbf 572EXPORT_SYMBOL_GPL(vhost_dev_stop);
bab632d6 573
6b1e6cc7
JW
574static void vhost_umem_free(struct vhost_umem *umem,
575 struct vhost_umem_node *node)
576{
577 vhost_umem_interval_tree_remove(node, &umem->umem_tree);
578 list_del(&node->link);
579 kfree(node);
580 umem->numem--;
581}
582
a9709d68
JW
583static void vhost_umem_clean(struct vhost_umem *umem)
584{
585 struct vhost_umem_node *node, *tmp;
586
587 if (!umem)
588 return;
589
6b1e6cc7
JW
590 list_for_each_entry_safe(node, tmp, &umem->umem_list, link)
591 vhost_umem_free(umem, node);
592
a9709d68
JW
593 kvfree(umem);
594}
595
6b1e6cc7
JW
596static void vhost_clear_msg(struct vhost_dev *dev)
597{
598 struct vhost_msg_node *node, *n;
599
600 spin_lock(&dev->iotlb_lock);
601
602 list_for_each_entry_safe(node, n, &dev->read_list, node) {
603 list_del(&node->node);
604 kfree(node);
605 }
606
607 list_for_each_entry_safe(node, n, &dev->pending_list, node) {
608 list_del(&node->node);
609 kfree(node);
610 }
611
612 spin_unlock(&dev->iotlb_lock);
613}
614
f6f93f75 615void vhost_dev_cleanup(struct vhost_dev *dev)
3a4d5c94
MT
616{
617 int i;
d47effe1 618
3a4d5c94 619 for (i = 0; i < dev->nvqs; ++i) {
3ab2e420
AH
620 if (dev->vqs[i]->error_ctx)
621 eventfd_ctx_put(dev->vqs[i]->error_ctx);
3ab2e420
AH
622 if (dev->vqs[i]->kick)
623 fput(dev->vqs[i]->kick);
624 if (dev->vqs[i]->call_ctx)
625 eventfd_ctx_put(dev->vqs[i]->call_ctx);
3ab2e420 626 vhost_vq_reset(dev, dev->vqs[i]);
3a4d5c94 627 }
e0e9b406 628 vhost_dev_free_iovecs(dev);
3a4d5c94
MT
629 if (dev->log_ctx)
630 eventfd_ctx_put(dev->log_ctx);
631 dev->log_ctx = NULL;
3a4d5c94 632 /* No one will access memory at this point */
a9709d68
JW
633 vhost_umem_clean(dev->umem);
634 dev->umem = NULL;
6b1e6cc7
JW
635 vhost_umem_clean(dev->iotlb);
636 dev->iotlb = NULL;
637 vhost_clear_msg(dev);
a9a08845 638 wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
04b96e55 639 WARN_ON(!llist_empty(&dev->work_list));
78b620ce
ED
640 if (dev->worker) {
641 kthread_stop(dev->worker);
642 dev->worker = NULL;
643 }
533a19b4
MT
644 if (dev->mm)
645 mmput(dev->mm);
646 dev->mm = NULL;
3a4d5c94 647}
6ac1afbf 648EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
3a4d5c94 649
ddd3d408 650static bool log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
3a4d5c94
MT
651{
652 u64 a = addr / VHOST_PAGE_SIZE / 8;
d47effe1 653
3a4d5c94
MT
654 /* Make sure 64 bit math will not overflow. */
655 if (a > ULONG_MAX - (unsigned long)log_base ||
656 a + (unsigned long)log_base > ULONG_MAX)
ddd3d408 657 return false;
3a4d5c94 658
96d4f267 659 return access_ok(log_base + a,
3a4d5c94
MT
660 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
661}
662
ec33d031
MT
663static bool vhost_overflow(u64 uaddr, u64 size)
664{
665 /* Make sure 64 bit math will not overflow. */
666 return uaddr > ULONG_MAX || size > ULONG_MAX || uaddr > ULONG_MAX - size;
667}
668
3a4d5c94 669/* Caller should have vq mutex and device mutex. */
ddd3d408
SH
670static bool vq_memory_access_ok(void __user *log_base, struct vhost_umem *umem,
671 int log_all)
3a4d5c94 672{
a9709d68 673 struct vhost_umem_node *node;
179b284e 674
a9709d68 675 if (!umem)
ddd3d408 676 return false;
179b284e 677
a9709d68
JW
678 list_for_each_entry(node, &umem->umem_list, link) {
679 unsigned long a = node->userspace_addr;
680
ec33d031 681 if (vhost_overflow(node->userspace_addr, node->size))
ddd3d408 682 return false;
ec33d031
MT
683
684
96d4f267 685 if (!access_ok((void __user *)a,
a9709d68 686 node->size))
ddd3d408 687 return false;
3a4d5c94 688 else if (log_all && !log_access_ok(log_base,
a9709d68
JW
689 node->start,
690 node->size))
ddd3d408 691 return false;
3a4d5c94 692 }
ddd3d408 693 return true;
3a4d5c94
MT
694}
695
f8894913
JW
696static inline void __user *vhost_vq_meta_fetch(struct vhost_virtqueue *vq,
697 u64 addr, unsigned int size,
698 int type)
699{
700 const struct vhost_umem_node *node = vq->meta_iotlb[type];
701
702 if (!node)
703 return NULL;
704
705 return (void *)(uintptr_t)(node->userspace_addr + addr - node->start);
706}
707
3a4d5c94
MT
708/* Can we switch to this memory table? */
709/* Caller should have device mutex but not vq mutex */
ddd3d408
SH
710static bool memory_access_ok(struct vhost_dev *d, struct vhost_umem *umem,
711 int log_all)
3a4d5c94
MT
712{
713 int i;
d47effe1 714
3a4d5c94 715 for (i = 0; i < d->nvqs; ++i) {
ddd3d408 716 bool ok;
ea16c514
MT
717 bool log;
718
3ab2e420 719 mutex_lock(&d->vqs[i]->mutex);
ea16c514 720 log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
3a4d5c94 721 /* If ring is inactive, will check when it's enabled. */
3ab2e420 722 if (d->vqs[i]->private_data)
a9709d68
JW
723 ok = vq_memory_access_ok(d->vqs[i]->log_base,
724 umem, log);
3a4d5c94 725 else
ddd3d408 726 ok = true;
3ab2e420 727 mutex_unlock(&d->vqs[i]->mutex);
3a4d5c94 728 if (!ok)
ddd3d408 729 return false;
3a4d5c94 730 }
ddd3d408 731 return true;
3a4d5c94
MT
732}
733
6b1e6cc7
JW
734static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
735 struct iovec iov[], int iov_size, int access);
bfe2bc51 736
72952cc0 737static int vhost_copy_to_user(struct vhost_virtqueue *vq, void __user *to,
bfe2bc51
JW
738 const void *from, unsigned size)
739{
6b1e6cc7 740 int ret;
bfe2bc51 741
6b1e6cc7
JW
742 if (!vq->iotlb)
743 return __copy_to_user(to, from, size);
744 else {
745 /* This function should be called after iotlb
746 * prefetch, which means we're sure that all vq
747 * could be access through iotlb. So -EAGAIN should
748 * not happen in this case.
749 */
6b1e6cc7 750 struct iov_iter t;
f8894913
JW
751 void __user *uaddr = vhost_vq_meta_fetch(vq,
752 (u64)(uintptr_t)to, size,
7ced6c98 753 VHOST_ADDR_USED);
f8894913
JW
754
755 if (uaddr)
756 return __copy_to_user(uaddr, from, size);
757
6b1e6cc7
JW
758 ret = translate_desc(vq, (u64)(uintptr_t)to, size, vq->iotlb_iov,
759 ARRAY_SIZE(vq->iotlb_iov),
760 VHOST_ACCESS_WO);
761 if (ret < 0)
762 goto out;
763 iov_iter_init(&t, WRITE, vq->iotlb_iov, ret, size);
764 ret = copy_to_iter(from, size, &t);
765 if (ret == size)
766 ret = 0;
767 }
768out:
769 return ret;
770}
bfe2bc51
JW
771
772static int vhost_copy_from_user(struct vhost_virtqueue *vq, void *to,
72952cc0 773 void __user *from, unsigned size)
bfe2bc51 774{
6b1e6cc7
JW
775 int ret;
776
777 if (!vq->iotlb)
778 return __copy_from_user(to, from, size);
779 else {
780 /* This function should be called after iotlb
781 * prefetch, which means we're sure that vq
782 * could be access through iotlb. So -EAGAIN should
783 * not happen in this case.
784 */
f8894913
JW
785 void __user *uaddr = vhost_vq_meta_fetch(vq,
786 (u64)(uintptr_t)from, size,
787 VHOST_ADDR_DESC);
6b1e6cc7 788 struct iov_iter f;
f8894913
JW
789
790 if (uaddr)
791 return __copy_from_user(to, uaddr, size);
792
6b1e6cc7
JW
793 ret = translate_desc(vq, (u64)(uintptr_t)from, size, vq->iotlb_iov,
794 ARRAY_SIZE(vq->iotlb_iov),
795 VHOST_ACCESS_RO);
796 if (ret < 0) {
797 vq_err(vq, "IOTLB translation failure: uaddr "
798 "%p size 0x%llx\n", from,
799 (unsigned long long) size);
800 goto out;
801 }
802 iov_iter_init(&f, READ, vq->iotlb_iov, ret, size);
803 ret = copy_from_iter(to, size, &f);
804 if (ret == size)
805 ret = 0;
806 }
807
808out:
809 return ret;
810}
811
f8894913
JW
812static void __user *__vhost_get_user_slow(struct vhost_virtqueue *vq,
813 void __user *addr, unsigned int size,
814 int type)
6b1e6cc7
JW
815{
816 int ret;
817
6b1e6cc7
JW
818 ret = translate_desc(vq, (u64)(uintptr_t)addr, size, vq->iotlb_iov,
819 ARRAY_SIZE(vq->iotlb_iov),
820 VHOST_ACCESS_RO);
821 if (ret < 0) {
822 vq_err(vq, "IOTLB translation failure: uaddr "
823 "%p size 0x%llx\n", addr,
824 (unsigned long long) size);
825 return NULL;
826 }
827
828 if (ret != 1 || vq->iotlb_iov[0].iov_len != size) {
829 vq_err(vq, "Non atomic userspace memory access: uaddr "
830 "%p size 0x%llx\n", addr,
831 (unsigned long long) size);
832 return NULL;
833 }
834
835 return vq->iotlb_iov[0].iov_base;
836}
837
f8894913
JW
838/* This function should be called after iotlb
839 * prefetch, which means we're sure that vq
840 * could be access through iotlb. So -EAGAIN should
841 * not happen in this case.
842 */
843static inline void __user *__vhost_get_user(struct vhost_virtqueue *vq,
844 void *addr, unsigned int size,
845 int type)
846{
847 void __user *uaddr = vhost_vq_meta_fetch(vq,
848 (u64)(uintptr_t)addr, size, type);
849 if (uaddr)
850 return uaddr;
851
852 return __vhost_get_user_slow(vq, addr, size, type);
853}
854
855#define vhost_put_user(vq, x, ptr) \
6b1e6cc7
JW
856({ \
857 int ret = -EFAULT; \
858 if (!vq->iotlb) { \
859 ret = __put_user(x, ptr); \
860 } else { \
861 __typeof__(ptr) to = \
f8894913
JW
862 (__typeof__(ptr)) __vhost_get_user(vq, ptr, \
863 sizeof(*ptr), VHOST_ADDR_USED); \
6b1e6cc7
JW
864 if (to != NULL) \
865 ret = __put_user(x, to); \
866 else \
867 ret = -EFAULT; \
868 } \
869 ret; \
870})
871
f8894913 872#define vhost_get_user(vq, x, ptr, type) \
6b1e6cc7
JW
873({ \
874 int ret; \
875 if (!vq->iotlb) { \
876 ret = __get_user(x, ptr); \
877 } else { \
878 __typeof__(ptr) from = \
f8894913
JW
879 (__typeof__(ptr)) __vhost_get_user(vq, ptr, \
880 sizeof(*ptr), \
881 type); \
6b1e6cc7
JW
882 if (from != NULL) \
883 ret = __get_user(x, from); \
884 else \
885 ret = -EFAULT; \
886 } \
887 ret; \
888})
889
f8894913
JW
890#define vhost_get_avail(vq, x, ptr) \
891 vhost_get_user(vq, x, ptr, VHOST_ADDR_AVAIL)
892
893#define vhost_get_used(vq, x, ptr) \
894 vhost_get_user(vq, x, ptr, VHOST_ADDR_USED)
895
86a07da3
JW
896static void vhost_dev_lock_vqs(struct vhost_dev *d)
897{
898 int i = 0;
899 for (i = 0; i < d->nvqs; ++i)
900 mutex_lock_nested(&d->vqs[i]->mutex, i);
901}
902
903static void vhost_dev_unlock_vqs(struct vhost_dev *d)
904{
905 int i = 0;
906 for (i = 0; i < d->nvqs; ++i)
907 mutex_unlock(&d->vqs[i]->mutex);
908}
909
6b1e6cc7
JW
910static int vhost_new_umem_range(struct vhost_umem *umem,
911 u64 start, u64 size, u64 end,
912 u64 userspace_addr, int perm)
913{
813dbeb6 914 struct vhost_umem_node *tmp, *node;
6b1e6cc7 915
813dbeb6
JW
916 if (!size)
917 return -EFAULT;
918
919 node = kmalloc(sizeof(*node), GFP_ATOMIC);
6b1e6cc7
JW
920 if (!node)
921 return -ENOMEM;
922
923 if (umem->numem == max_iotlb_entries) {
924 tmp = list_first_entry(&umem->umem_list, typeof(*tmp), link);
925 vhost_umem_free(umem, tmp);
926 }
927
928 node->start = start;
929 node->size = size;
930 node->last = end;
931 node->userspace_addr = userspace_addr;
932 node->perm = perm;
933 INIT_LIST_HEAD(&node->link);
934 list_add_tail(&node->link, &umem->umem_list);
935 vhost_umem_interval_tree_insert(node, &umem->umem_tree);
936 umem->numem++;
937
938 return 0;
939}
940
941static void vhost_del_umem_range(struct vhost_umem *umem,
942 u64 start, u64 end)
943{
944 struct vhost_umem_node *node;
945
946 while ((node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
947 start, end)))
948 vhost_umem_free(umem, node);
949}
950
951static void vhost_iotlb_notify_vq(struct vhost_dev *d,
952 struct vhost_iotlb_msg *msg)
953{
954 struct vhost_msg_node *node, *n;
955
956 spin_lock(&d->iotlb_lock);
957
958 list_for_each_entry_safe(node, n, &d->pending_list, node) {
959 struct vhost_iotlb_msg *vq_msg = &node->msg.iotlb;
960 if (msg->iova <= vq_msg->iova &&
2d66f997 961 msg->iova + msg->size - 1 >= vq_msg->iova &&
6b1e6cc7
JW
962 vq_msg->type == VHOST_IOTLB_MISS) {
963 vhost_poll_queue(&node->vq->poll);
964 list_del(&node->node);
965 kfree(node);
966 }
967 }
968
969 spin_unlock(&d->iotlb_lock);
970}
971
ddd3d408 972static bool umem_access_ok(u64 uaddr, u64 size, int access)
6b1e6cc7
JW
973{
974 unsigned long a = uaddr;
975
ec33d031
MT
976 /* Make sure 64 bit math will not overflow. */
977 if (vhost_overflow(uaddr, size))
ddd3d408 978 return false;
ec33d031 979
6b1e6cc7 980 if ((access & VHOST_ACCESS_RO) &&
96d4f267 981 !access_ok((void __user *)a, size))
ddd3d408 982 return false;
6b1e6cc7 983 if ((access & VHOST_ACCESS_WO) &&
96d4f267 984 !access_ok((void __user *)a, size))
ddd3d408
SH
985 return false;
986 return true;
6b1e6cc7
JW
987}
988
72952cc0
MT
989static int vhost_process_iotlb_msg(struct vhost_dev *dev,
990 struct vhost_iotlb_msg *msg)
6b1e6cc7
JW
991{
992 int ret = 0;
993
1b15ad68 994 mutex_lock(&dev->mutex);
86a07da3 995 vhost_dev_lock_vqs(dev);
6b1e6cc7
JW
996 switch (msg->type) {
997 case VHOST_IOTLB_UPDATE:
998 if (!dev->iotlb) {
999 ret = -EFAULT;
1000 break;
1001 }
ddd3d408 1002 if (!umem_access_ok(msg->uaddr, msg->size, msg->perm)) {
6b1e6cc7
JW
1003 ret = -EFAULT;
1004 break;
1005 }
f8894913 1006 vhost_vq_meta_reset(dev);
6b1e6cc7
JW
1007 if (vhost_new_umem_range(dev->iotlb, msg->iova, msg->size,
1008 msg->iova + msg->size - 1,
1009 msg->uaddr, msg->perm)) {
1010 ret = -ENOMEM;
1011 break;
1012 }
1013 vhost_iotlb_notify_vq(dev, msg);
1014 break;
1015 case VHOST_IOTLB_INVALIDATE:
6f3180af
JW
1016 if (!dev->iotlb) {
1017 ret = -EFAULT;
1018 break;
1019 }
f8894913 1020 vhost_vq_meta_reset(dev);
6b1e6cc7
JW
1021 vhost_del_umem_range(dev->iotlb, msg->iova,
1022 msg->iova + msg->size - 1);
1023 break;
1024 default:
1025 ret = -EINVAL;
1026 break;
1027 }
1028
86a07da3 1029 vhost_dev_unlock_vqs(dev);
1b15ad68
JW
1030 mutex_unlock(&dev->mutex);
1031
6b1e6cc7
JW
1032 return ret;
1033}
1034ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
1035 struct iov_iter *from)
1036{
429711ae
JW
1037 struct vhost_iotlb_msg msg;
1038 size_t offset;
1039 int type, ret;
6b1e6cc7 1040
429711ae 1041 ret = copy_from_iter(&type, sizeof(type), from);
74ad7419
PT
1042 if (ret != sizeof(type)) {
1043 ret = -EINVAL;
6b1e6cc7 1044 goto done;
74ad7419 1045 }
6b1e6cc7 1046
429711ae 1047 switch (type) {
6b1e6cc7 1048 case VHOST_IOTLB_MSG:
429711ae
JW
1049 /* There maybe a hole after type for V1 message type,
1050 * so skip it here.
1051 */
1052 offset = offsetof(struct vhost_msg, iotlb) - sizeof(int);
1053 break;
1054 case VHOST_IOTLB_MSG_V2:
1055 offset = sizeof(__u32);
6b1e6cc7
JW
1056 break;
1057 default:
1058 ret = -EINVAL;
429711ae 1059 goto done;
6b1e6cc7
JW
1060 }
1061
429711ae
JW
1062 iov_iter_advance(from, offset);
1063 ret = copy_from_iter(&msg, sizeof(msg), from);
74ad7419
PT
1064 if (ret != sizeof(msg)) {
1065 ret = -EINVAL;
429711ae 1066 goto done;
74ad7419 1067 }
429711ae
JW
1068 if (vhost_process_iotlb_msg(dev, &msg)) {
1069 ret = -EFAULT;
1070 goto done;
1071 }
1072
1073 ret = (type == VHOST_IOTLB_MSG) ? sizeof(struct vhost_msg) :
1074 sizeof(struct vhost_msg_v2);
6b1e6cc7
JW
1075done:
1076 return ret;
1077}
1078EXPORT_SYMBOL(vhost_chr_write_iter);
1079
afc9a42b 1080__poll_t vhost_chr_poll(struct file *file, struct vhost_dev *dev,
6b1e6cc7
JW
1081 poll_table *wait)
1082{
afc9a42b 1083 __poll_t mask = 0;
6b1e6cc7
JW
1084
1085 poll_wait(file, &dev->wait, wait);
1086
1087 if (!list_empty(&dev->read_list))
a9a08845 1088 mask |= EPOLLIN | EPOLLRDNORM;
6b1e6cc7
JW
1089
1090 return mask;
1091}
1092EXPORT_SYMBOL(vhost_chr_poll);
1093
1094ssize_t vhost_chr_read_iter(struct vhost_dev *dev, struct iov_iter *to,
1095 int noblock)
1096{
1097 DEFINE_WAIT(wait);
1098 struct vhost_msg_node *node;
1099 ssize_t ret = 0;
1100 unsigned size = sizeof(struct vhost_msg);
1101
1102 if (iov_iter_count(to) < size)
1103 return 0;
1104
1105 while (1) {
1106 if (!noblock)
1107 prepare_to_wait(&dev->wait, &wait,
1108 TASK_INTERRUPTIBLE);
1109
1110 node = vhost_dequeue_msg(dev, &dev->read_list);
1111 if (node)
1112 break;
1113 if (noblock) {
1114 ret = -EAGAIN;
1115 break;
1116 }
1117 if (signal_pending(current)) {
1118 ret = -ERESTARTSYS;
1119 break;
1120 }
1121 if (!dev->iotlb) {
1122 ret = -EBADFD;
1123 break;
1124 }
1125
1126 schedule();
1127 }
1128
1129 if (!noblock)
1130 finish_wait(&dev->wait, &wait);
1131
1132 if (node) {
429711ae
JW
1133 struct vhost_iotlb_msg *msg;
1134 void *start = &node->msg;
6b1e6cc7 1135
429711ae
JW
1136 switch (node->msg.type) {
1137 case VHOST_IOTLB_MSG:
1138 size = sizeof(node->msg);
1139 msg = &node->msg.iotlb;
1140 break;
1141 case VHOST_IOTLB_MSG_V2:
1142 size = sizeof(node->msg_v2);
1143 msg = &node->msg_v2.iotlb;
1144 break;
1145 default:
1146 BUG();
1147 break;
1148 }
1149
1150 ret = copy_to_iter(start, size, to);
1151 if (ret != size || msg->type != VHOST_IOTLB_MISS) {
6b1e6cc7
JW
1152 kfree(node);
1153 return ret;
1154 }
6b1e6cc7
JW
1155 vhost_enqueue_msg(dev, &dev->pending_list, node);
1156 }
1157
1158 return ret;
1159}
1160EXPORT_SYMBOL_GPL(vhost_chr_read_iter);
1161
1162static int vhost_iotlb_miss(struct vhost_virtqueue *vq, u64 iova, int access)
1163{
1164 struct vhost_dev *dev = vq->dev;
1165 struct vhost_msg_node *node;
1166 struct vhost_iotlb_msg *msg;
429711ae 1167 bool v2 = vhost_backend_has_feature(vq, VHOST_BACKEND_F_IOTLB_MSG_V2);
6b1e6cc7 1168
429711ae 1169 node = vhost_new_msg(vq, v2 ? VHOST_IOTLB_MSG_V2 : VHOST_IOTLB_MSG);
6b1e6cc7
JW
1170 if (!node)
1171 return -ENOMEM;
1172
429711ae
JW
1173 if (v2) {
1174 node->msg_v2.type = VHOST_IOTLB_MSG_V2;
1175 msg = &node->msg_v2.iotlb;
1176 } else {
1177 msg = &node->msg.iotlb;
1178 }
1179
6b1e6cc7
JW
1180 msg->type = VHOST_IOTLB_MISS;
1181 msg->iova = iova;
1182 msg->perm = access;
1183
1184 vhost_enqueue_msg(dev, &dev->read_list, node);
1185
1186 return 0;
bfe2bc51
JW
1187}
1188
ddd3d408
SH
1189static bool vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
1190 struct vring_desc __user *desc,
1191 struct vring_avail __user *avail,
1192 struct vring_used __user *used)
6b1e6cc7 1193
3a4d5c94 1194{
cfdbb4ed 1195 size_t s __maybe_unused = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
6b1e6cc7 1196
96d4f267
LT
1197 return access_ok(desc, num * sizeof *desc) &&
1198 access_ok(avail,
8ea8cf89 1199 sizeof *avail + num * sizeof *avail->ring + s) &&
96d4f267 1200 access_ok(used,
8ea8cf89 1201 sizeof *used + num * sizeof *used->ring + s);
3a4d5c94
MT
1202}
1203
f8894913
JW
1204static void vhost_vq_meta_update(struct vhost_virtqueue *vq,
1205 const struct vhost_umem_node *node,
1206 int type)
1207{
1208 int access = (type == VHOST_ADDR_USED) ?
1209 VHOST_ACCESS_WO : VHOST_ACCESS_RO;
1210
1211 if (likely(node->perm & access))
1212 vq->meta_iotlb[type] = node;
1213}
1214
ddd3d408
SH
1215static bool iotlb_access_ok(struct vhost_virtqueue *vq,
1216 int access, u64 addr, u64 len, int type)
6b1e6cc7
JW
1217{
1218 const struct vhost_umem_node *node;
1219 struct vhost_umem *umem = vq->iotlb;
ca2c5b33 1220 u64 s = 0, size, orig_addr = addr, last = addr + len - 1;
f8894913
JW
1221
1222 if (vhost_vq_meta_fetch(vq, addr, len, type))
1223 return true;
6b1e6cc7
JW
1224
1225 while (len > s) {
1226 node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
1227 addr,
ca2c5b33 1228 last);
6b1e6cc7
JW
1229 if (node == NULL || node->start > addr) {
1230 vhost_iotlb_miss(vq, addr, access);
1231 return false;
1232 } else if (!(node->perm & access)) {
1233 /* Report the possible access violation by
1234 * request another translation from userspace.
1235 */
1236 return false;
1237 }
1238
1239 size = node->size - addr + node->start;
f8894913
JW
1240
1241 if (orig_addr == addr && size >= len)
1242 vhost_vq_meta_update(vq, node, type);
1243
6b1e6cc7
JW
1244 s += size;
1245 addr += size;
1246 }
1247
1248 return true;
1249}
1250
1251int vq_iotlb_prefetch(struct vhost_virtqueue *vq)
1252{
1253 size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
1254 unsigned int num = vq->num;
1255
1256 if (!vq->iotlb)
1257 return 1;
1258
1259 return iotlb_access_ok(vq, VHOST_ACCESS_RO, (u64)(uintptr_t)vq->desc,
f8894913 1260 num * sizeof(*vq->desc), VHOST_ADDR_DESC) &&
6b1e6cc7
JW
1261 iotlb_access_ok(vq, VHOST_ACCESS_RO, (u64)(uintptr_t)vq->avail,
1262 sizeof *vq->avail +
f8894913
JW
1263 num * sizeof(*vq->avail->ring) + s,
1264 VHOST_ADDR_AVAIL) &&
6b1e6cc7
JW
1265 iotlb_access_ok(vq, VHOST_ACCESS_WO, (u64)(uintptr_t)vq->used,
1266 sizeof *vq->used +
f8894913
JW
1267 num * sizeof(*vq->used->ring) + s,
1268 VHOST_ADDR_USED);
6b1e6cc7
JW
1269}
1270EXPORT_SYMBOL_GPL(vq_iotlb_prefetch);
1271
3a4d5c94
MT
1272/* Can we log writes? */
1273/* Caller should have device mutex but not vq mutex */
ddd3d408 1274bool vhost_log_access_ok(struct vhost_dev *dev)
3a4d5c94 1275{
a9709d68 1276 return memory_access_ok(dev, dev->umem, 1);
3a4d5c94 1277}
6ac1afbf 1278EXPORT_SYMBOL_GPL(vhost_log_access_ok);
3a4d5c94
MT
1279
1280/* Verify access for write logging. */
1281/* Caller should have vq mutex and device mutex */
ddd3d408
SH
1282static bool vq_log_access_ok(struct vhost_virtqueue *vq,
1283 void __user *log_base)
3a4d5c94 1284{
ea16c514 1285 size_t s = vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
28457ee6 1286
a9709d68 1287 return vq_memory_access_ok(log_base, vq->umem,
ea16c514 1288 vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
3a4d5c94
MT
1289 (!vq->log_used || log_access_ok(log_base, vq->log_addr,
1290 sizeof *vq->used +
8ea8cf89 1291 vq->num * sizeof *vq->used->ring + s));
3a4d5c94
MT
1292}
1293
1294/* Can we start vq? */
1295/* Caller should have vq mutex and device mutex */
ddd3d408 1296bool vhost_vq_access_ok(struct vhost_virtqueue *vq)
3a4d5c94 1297{
d14d2b78 1298 if (!vq_log_access_ok(vq, vq->log_base))
ddd3d408 1299 return false;
d65026c6 1300
d14d2b78
SH
1301 /* Access validation occurs at prefetch time with IOTLB */
1302 if (vq->iotlb)
ddd3d408 1303 return true;
d65026c6
JW
1304
1305 return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used);
3a4d5c94 1306}
6ac1afbf 1307EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
3a4d5c94 1308
6b1e6cc7
JW
1309static struct vhost_umem *vhost_umem_alloc(void)
1310{
6c5ab651 1311 struct vhost_umem *umem = kvzalloc(sizeof(*umem), GFP_KERNEL);
6b1e6cc7
JW
1312
1313 if (!umem)
1314 return NULL;
1315
f808c13f 1316 umem->umem_tree = RB_ROOT_CACHED;
6b1e6cc7
JW
1317 umem->numem = 0;
1318 INIT_LIST_HEAD(&umem->umem_list);
1319
1320 return umem;
1321}
1322
3a4d5c94
MT
1323static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
1324{
a9709d68
JW
1325 struct vhost_memory mem, *newmem;
1326 struct vhost_memory_region *region;
a9709d68 1327 struct vhost_umem *newumem, *oldumem;
3a4d5c94 1328 unsigned long size = offsetof(struct vhost_memory, regions);
98f9ca0a 1329 int i;
d47effe1 1330
7ad9c9d2
TY
1331 if (copy_from_user(&mem, m, size))
1332 return -EFAULT;
3a4d5c94
MT
1333 if (mem.padding)
1334 return -EOPNOTSUPP;
c9ce42f7 1335 if (mem.nregions > max_mem_regions)
3a4d5c94 1336 return -E2BIG;
b2303d7b
MW
1337 newmem = kvzalloc(struct_size(newmem, regions, mem.nregions),
1338 GFP_KERNEL);
3a4d5c94
MT
1339 if (!newmem)
1340 return -ENOMEM;
1341
1342 memcpy(newmem, &mem, size);
7ad9c9d2
TY
1343 if (copy_from_user(newmem->regions, m->regions,
1344 mem.nregions * sizeof *m->regions)) {
bcfeacab 1345 kvfree(newmem);
7ad9c9d2 1346 return -EFAULT;
3a4d5c94
MT
1347 }
1348
6b1e6cc7 1349 newumem = vhost_umem_alloc();
a9709d68 1350 if (!newumem) {
4de7255f 1351 kvfree(newmem);
a9709d68
JW
1352 return -ENOMEM;
1353 }
1354
a9709d68
JW
1355 for (region = newmem->regions;
1356 region < newmem->regions + mem.nregions;
1357 region++) {
6b1e6cc7
JW
1358 if (vhost_new_umem_range(newumem,
1359 region->guest_phys_addr,
1360 region->memory_size,
1361 region->guest_phys_addr +
1362 region->memory_size - 1,
1363 region->userspace_addr,
1364 VHOST_ACCESS_RW))
a9709d68 1365 goto err;
a02c3789 1366 }
a9709d68
JW
1367
1368 if (!memory_access_ok(d, newumem, 0))
1369 goto err;
1370
1371 oldumem = d->umem;
1372 d->umem = newumem;
98f9ca0a 1373
47283bef 1374 /* All memory accesses are done under some VQ mutex. */
98f9ca0a
MT
1375 for (i = 0; i < d->nvqs; ++i) {
1376 mutex_lock(&d->vqs[i]->mutex);
a9709d68 1377 d->vqs[i]->umem = newumem;
98f9ca0a
MT
1378 mutex_unlock(&d->vqs[i]->mutex);
1379 }
a9709d68
JW
1380
1381 kvfree(newmem);
1382 vhost_umem_clean(oldumem);
3a4d5c94 1383 return 0;
a9709d68
JW
1384
1385err:
1386 vhost_umem_clean(newumem);
1387 kvfree(newmem);
1388 return -EFAULT;
3a4d5c94
MT
1389}
1390
26b36604 1391long vhost_vring_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
3a4d5c94 1392{
cecb46f1
AV
1393 struct file *eventfp, *filep = NULL;
1394 bool pollstart = false, pollstop = false;
3a4d5c94
MT
1395 struct eventfd_ctx *ctx = NULL;
1396 u32 __user *idxp = argp;
1397 struct vhost_virtqueue *vq;
1398 struct vhost_vring_state s;
1399 struct vhost_vring_file f;
1400 struct vhost_vring_addr a;
1401 u32 idx;
1402 long r;
1403
1404 r = get_user(idx, idxp);
1405 if (r < 0)
1406 return r;
0f3d9a17 1407 if (idx >= d->nvqs)
3a4d5c94
MT
1408 return -ENOBUFS;
1409
ff002269 1410 idx = array_index_nospec(idx, d->nvqs);
3ab2e420 1411 vq = d->vqs[idx];
3a4d5c94
MT
1412
1413 mutex_lock(&vq->mutex);
1414
1415 switch (ioctl) {
1416 case VHOST_SET_VRING_NUM:
1417 /* Resizing ring with an active backend?
1418 * You don't want to do that. */
1419 if (vq->private_data) {
1420 r = -EBUSY;
1421 break;
1422 }
7ad9c9d2
TY
1423 if (copy_from_user(&s, argp, sizeof s)) {
1424 r = -EFAULT;
3a4d5c94 1425 break;
7ad9c9d2 1426 }
3a4d5c94
MT
1427 if (!s.num || s.num > 0xffff || (s.num & (s.num - 1))) {
1428 r = -EINVAL;
1429 break;
1430 }
1431 vq->num = s.num;
1432 break;
1433 case VHOST_SET_VRING_BASE:
1434 /* Moving base with an active backend?
1435 * You don't want to do that. */
1436 if (vq->private_data) {
1437 r = -EBUSY;
1438 break;
1439 }
7ad9c9d2
TY
1440 if (copy_from_user(&s, argp, sizeof s)) {
1441 r = -EFAULT;
3a4d5c94 1442 break;
7ad9c9d2 1443 }
3a4d5c94
MT
1444 if (s.num > 0xffff) {
1445 r = -EINVAL;
1446 break;
1447 }
8d65843c 1448 vq->last_avail_idx = s.num;
3a4d5c94
MT
1449 /* Forget the cached index value. */
1450 vq->avail_idx = vq->last_avail_idx;
1451 break;
1452 case VHOST_GET_VRING_BASE:
1453 s.index = idx;
1454 s.num = vq->last_avail_idx;
7ad9c9d2
TY
1455 if (copy_to_user(argp, &s, sizeof s))
1456 r = -EFAULT;
3a4d5c94
MT
1457 break;
1458 case VHOST_SET_VRING_ADDR:
7ad9c9d2
TY
1459 if (copy_from_user(&a, argp, sizeof a)) {
1460 r = -EFAULT;
3a4d5c94 1461 break;
7ad9c9d2 1462 }
3a4d5c94
MT
1463 if (a.flags & ~(0x1 << VHOST_VRING_F_LOG)) {
1464 r = -EOPNOTSUPP;
1465 break;
1466 }
1467 /* For 32bit, verify that the top 32bits of the user
1468 data are set to zero. */
1469 if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
1470 (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
1471 (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr) {
1472 r = -EFAULT;
1473 break;
1474 }
5d9a07b0
MT
1475
1476 /* Make sure it's safe to cast pointers to vring types. */
1477 BUILD_BUG_ON(__alignof__ *vq->avail > VRING_AVAIL_ALIGN_SIZE);
1478 BUILD_BUG_ON(__alignof__ *vq->used > VRING_USED_ALIGN_SIZE);
1479 if ((a.avail_user_addr & (VRING_AVAIL_ALIGN_SIZE - 1)) ||
1480 (a.used_user_addr & (VRING_USED_ALIGN_SIZE - 1)) ||
d5424838 1481 (a.log_guest_addr & (VRING_USED_ALIGN_SIZE - 1))) {
3a4d5c94
MT
1482 r = -EINVAL;
1483 break;
1484 }
1485
1486 /* We only verify access here if backend is configured.
1487 * If it is not, we don't as size might not have been setup.
1488 * We will verify when backend is configured. */
1489 if (vq->private_data) {
ea16c514 1490 if (!vq_access_ok(vq, vq->num,
3a4d5c94
MT
1491 (void __user *)(unsigned long)a.desc_user_addr,
1492 (void __user *)(unsigned long)a.avail_user_addr,
1493 (void __user *)(unsigned long)a.used_user_addr)) {
1494 r = -EINVAL;
1495 break;
1496 }
1497
1498 /* Also validate log access for used ring if enabled. */
1499 if ((a.flags & (0x1 << VHOST_VRING_F_LOG)) &&
1500 !log_access_ok(vq->log_base, a.log_guest_addr,
1501 sizeof *vq->used +
1502 vq->num * sizeof *vq->used->ring)) {
1503 r = -EINVAL;
1504 break;
1505 }
1506 }
1507
3a4d5c94
MT
1508 vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
1509 vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
1510 vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
1511 vq->log_addr = a.log_guest_addr;
1512 vq->used = (void __user *)(unsigned long)a.used_user_addr;
1513 break;
1514 case VHOST_SET_VRING_KICK:
7ad9c9d2
TY
1515 if (copy_from_user(&f, argp, sizeof f)) {
1516 r = -EFAULT;
3a4d5c94 1517 break;
7ad9c9d2 1518 }
3a4d5c94 1519 eventfp = f.fd == -1 ? NULL : eventfd_fget(f.fd);
535297a6
MT
1520 if (IS_ERR(eventfp)) {
1521 r = PTR_ERR(eventfp);
1522 break;
1523 }
3a4d5c94 1524 if (eventfp != vq->kick) {
cecb46f1
AV
1525 pollstop = (filep = vq->kick) != NULL;
1526 pollstart = (vq->kick = eventfp) != NULL;
3a4d5c94
MT
1527 } else
1528 filep = eventfp;
1529 break;
1530 case VHOST_SET_VRING_CALL:
7ad9c9d2
TY
1531 if (copy_from_user(&f, argp, sizeof f)) {
1532 r = -EFAULT;
3a4d5c94 1533 break;
7ad9c9d2 1534 }
e050c7d9
EB
1535 ctx = f.fd == -1 ? NULL : eventfd_ctx_fdget(f.fd);
1536 if (IS_ERR(ctx)) {
1537 r = PTR_ERR(ctx);
535297a6
MT
1538 break;
1539 }
e050c7d9 1540 swap(ctx, vq->call_ctx);
3a4d5c94
MT
1541 break;
1542 case VHOST_SET_VRING_ERR:
7ad9c9d2
TY
1543 if (copy_from_user(&f, argp, sizeof f)) {
1544 r = -EFAULT;
3a4d5c94 1545 break;
7ad9c9d2 1546 }
09f332a5
EB
1547 ctx = f.fd == -1 ? NULL : eventfd_ctx_fdget(f.fd);
1548 if (IS_ERR(ctx)) {
1549 r = PTR_ERR(ctx);
535297a6
MT
1550 break;
1551 }
09f332a5 1552 swap(ctx, vq->error_ctx);
3a4d5c94 1553 break;
2751c988
GK
1554 case VHOST_SET_VRING_ENDIAN:
1555 r = vhost_set_vring_endian(vq, argp);
1556 break;
1557 case VHOST_GET_VRING_ENDIAN:
1558 r = vhost_get_vring_endian(vq, idx, argp);
1559 break;
03088137
JW
1560 case VHOST_SET_VRING_BUSYLOOP_TIMEOUT:
1561 if (copy_from_user(&s, argp, sizeof(s))) {
1562 r = -EFAULT;
1563 break;
1564 }
1565 vq->busyloop_timeout = s.num;
1566 break;
1567 case VHOST_GET_VRING_BUSYLOOP_TIMEOUT:
1568 s.index = idx;
1569 s.num = vq->busyloop_timeout;
1570 if (copy_to_user(argp, &s, sizeof(s)))
1571 r = -EFAULT;
1572 break;
3a4d5c94
MT
1573 default:
1574 r = -ENOIOCTLCMD;
1575 }
1576
1577 if (pollstop && vq->handle_kick)
1578 vhost_poll_stop(&vq->poll);
1579
e050c7d9 1580 if (!IS_ERR_OR_NULL(ctx))
3a4d5c94
MT
1581 eventfd_ctx_put(ctx);
1582 if (filep)
1583 fput(filep);
1584
1585 if (pollstart && vq->handle_kick)
2b8b328b 1586 r = vhost_poll_start(&vq->poll, vq->kick);
3a4d5c94
MT
1587
1588 mutex_unlock(&vq->mutex);
1589
1590 if (pollstop && vq->handle_kick)
1591 vhost_poll_flush(&vq->poll);
1592 return r;
1593}
6ac1afbf 1594EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
3a4d5c94 1595
6b1e6cc7
JW
1596int vhost_init_device_iotlb(struct vhost_dev *d, bool enabled)
1597{
1598 struct vhost_umem *niotlb, *oiotlb;
1599 int i;
1600
1601 niotlb = vhost_umem_alloc();
1602 if (!niotlb)
1603 return -ENOMEM;
1604
1605 oiotlb = d->iotlb;
1606 d->iotlb = niotlb;
1607
1608 for (i = 0; i < d->nvqs; ++i) {
b13f9c63
JW
1609 struct vhost_virtqueue *vq = d->vqs[i];
1610
1611 mutex_lock(&vq->mutex);
1612 vq->iotlb = niotlb;
1613 __vhost_vq_meta_reset(vq);
1614 mutex_unlock(&vq->mutex);
6b1e6cc7
JW
1615 }
1616
1617 vhost_umem_clean(oiotlb);
1618
1619 return 0;
1620}
1621EXPORT_SYMBOL_GPL(vhost_init_device_iotlb);
1622
3a4d5c94 1623/* Caller must have device mutex */
935cdee7 1624long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
3a4d5c94 1625{
d25cc43c 1626 struct eventfd_ctx *ctx;
3a4d5c94
MT
1627 u64 p;
1628 long r;
1629 int i, fd;
1630
1631 /* If you are not the owner, you can become one */
1632 if (ioctl == VHOST_SET_OWNER) {
1633 r = vhost_dev_set_owner(d);
1634 goto done;
1635 }
1636
1637 /* You must be the owner to do anything else */
1638 r = vhost_dev_check_owner(d);
1639 if (r)
1640 goto done;
1641
1642 switch (ioctl) {
1643 case VHOST_SET_MEM_TABLE:
1644 r = vhost_set_memory(d, argp);
1645 break;
1646 case VHOST_SET_LOG_BASE:
7ad9c9d2
TY
1647 if (copy_from_user(&p, argp, sizeof p)) {
1648 r = -EFAULT;
3a4d5c94 1649 break;
7ad9c9d2 1650 }
3a4d5c94
MT
1651 if ((u64)(unsigned long)p != p) {
1652 r = -EFAULT;
1653 break;
1654 }
1655 for (i = 0; i < d->nvqs; ++i) {
1656 struct vhost_virtqueue *vq;
1657 void __user *base = (void __user *)(unsigned long)p;
3ab2e420 1658 vq = d->vqs[i];
3a4d5c94
MT
1659 mutex_lock(&vq->mutex);
1660 /* If ring is inactive, will check when it's enabled. */
ea16c514 1661 if (vq->private_data && !vq_log_access_ok(vq, base))
3a4d5c94
MT
1662 r = -EFAULT;
1663 else
1664 vq->log_base = base;
1665 mutex_unlock(&vq->mutex);
1666 }
1667 break;
1668 case VHOST_SET_LOG_FD:
1669 r = get_user(fd, (int __user *)argp);
1670 if (r < 0)
1671 break;
d25cc43c
EB
1672 ctx = fd == -1 ? NULL : eventfd_ctx_fdget(fd);
1673 if (IS_ERR(ctx)) {
1674 r = PTR_ERR(ctx);
3a4d5c94
MT
1675 break;
1676 }
d25cc43c 1677 swap(ctx, d->log_ctx);
3a4d5c94 1678 for (i = 0; i < d->nvqs; ++i) {
3ab2e420
AH
1679 mutex_lock(&d->vqs[i]->mutex);
1680 d->vqs[i]->log_ctx = d->log_ctx;
1681 mutex_unlock(&d->vqs[i]->mutex);
3a4d5c94
MT
1682 }
1683 if (ctx)
1684 eventfd_ctx_put(ctx);
3a4d5c94
MT
1685 break;
1686 default:
935cdee7 1687 r = -ENOIOCTLCMD;
3a4d5c94
MT
1688 break;
1689 }
1690done:
1691 return r;
1692}
6ac1afbf 1693EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
3a4d5c94 1694
3a4d5c94
MT
1695/* TODO: This is really inefficient. We need something like get_user()
1696 * (instruction directly accesses the data, with an exception table entry
1697 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
1698 */
1699static int set_bit_to_user(int nr, void __user *addr)
1700{
1701 unsigned long log = (unsigned long)addr;
1702 struct page *page;
1703 void *base;
1704 int bit = nr + (log % PAGE_SIZE) * 8;
1705 int r;
d47effe1 1706
73b0140b 1707 r = get_user_pages_fast(log, 1, FOLL_WRITE, &page);
d6db3f5c 1708 if (r < 0)
3a4d5c94 1709 return r;
d6db3f5c 1710 BUG_ON(r != 1);
c6daa7ff 1711 base = kmap_atomic(page);
3a4d5c94 1712 set_bit(bit, base);
c6daa7ff 1713 kunmap_atomic(base);
3a4d5c94
MT
1714 set_page_dirty_lock(page);
1715 put_page(page);
1716 return 0;
1717}
1718
1719static int log_write(void __user *log_base,
1720 u64 write_address, u64 write_length)
1721{
28831ee6 1722 u64 write_page = write_address / VHOST_PAGE_SIZE;
3a4d5c94 1723 int r;
d47effe1 1724
3a4d5c94
MT
1725 if (!write_length)
1726 return 0;
3bf9be40 1727 write_length += write_address % VHOST_PAGE_SIZE;
3a4d5c94
MT
1728 for (;;) {
1729 u64 base = (u64)(unsigned long)log_base;
28831ee6
MT
1730 u64 log = base + write_page / 8;
1731 int bit = write_page % 8;
3a4d5c94
MT
1732 if ((u64)(unsigned long)log != log)
1733 return -EFAULT;
1734 r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
1735 if (r < 0)
1736 return r;
1737 if (write_length <= VHOST_PAGE_SIZE)
1738 break;
1739 write_length -= VHOST_PAGE_SIZE;
28831ee6 1740 write_page += 1;
3a4d5c94
MT
1741 }
1742 return r;
1743}
1744
cc5e7107
JW
1745static int log_write_hva(struct vhost_virtqueue *vq, u64 hva, u64 len)
1746{
1747 struct vhost_umem *umem = vq->umem;
1748 struct vhost_umem_node *u;
1749 u64 start, end, l, min;
1750 int r;
1751 bool hit = false;
1752
1753 while (len) {
1754 min = len;
1755 /* More than one GPAs can be mapped into a single HVA. So
1756 * iterate all possible umems here to be safe.
1757 */
1758 list_for_each_entry(u, &umem->umem_list, link) {
1759 if (u->userspace_addr > hva - 1 + len ||
1760 u->userspace_addr - 1 + u->size < hva)
1761 continue;
1762 start = max(u->userspace_addr, hva);
1763 end = min(u->userspace_addr - 1 + u->size,
1764 hva - 1 + len);
1765 l = end - start + 1;
1766 r = log_write(vq->log_base,
1767 u->start + start - u->userspace_addr,
1768 l);
1769 if (r < 0)
1770 return r;
1771 hit = true;
1772 min = min(l, min);
1773 }
1774
1775 if (!hit)
1776 return -EFAULT;
1777
1778 len -= min;
1779 hva += min;
1780 }
1781
1782 return 0;
1783}
1784
1785static int log_used(struct vhost_virtqueue *vq, u64 used_offset, u64 len)
1786{
1787 struct iovec iov[64];
1788 int i, ret;
1789
1790 if (!vq->iotlb)
1791 return log_write(vq->log_base, vq->log_addr + used_offset, len);
1792
1793 ret = translate_desc(vq, (uintptr_t)vq->used + used_offset,
1794 len, iov, 64, VHOST_ACCESS_WO);
816db766 1795 if (ret < 0)
cc5e7107
JW
1796 return ret;
1797
1798 for (i = 0; i < ret; i++) {
1799 ret = log_write_hva(vq, (uintptr_t)iov[i].iov_base,
1800 iov[i].iov_len);
1801 if (ret)
1802 return ret;
1803 }
1804
1805 return 0;
1806}
1807
3a4d5c94 1808int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
cc5e7107 1809 unsigned int log_num, u64 len, struct iovec *iov, int count)
3a4d5c94
MT
1810{
1811 int i, r;
1812
1813 /* Make sure data written is seen before log. */
5659338c 1814 smp_wmb();
cc5e7107
JW
1815
1816 if (vq->iotlb) {
1817 for (i = 0; i < count; i++) {
1818 r = log_write_hva(vq, (uintptr_t)iov[i].iov_base,
1819 iov[i].iov_len);
1820 if (r < 0)
1821 return r;
1822 }
1823 return 0;
1824 }
1825
3a4d5c94
MT
1826 for (i = 0; i < log_num; ++i) {
1827 u64 l = min(log[i].len, len);
1828 r = log_write(vq->log_base, log[i].addr, l);
1829 if (r < 0)
1830 return r;
1831 len -= l;
5786aee8
MT
1832 if (!len) {
1833 if (vq->log_ctx)
1834 eventfd_signal(vq->log_ctx, 1);
3a4d5c94 1835 return 0;
5786aee8 1836 }
3a4d5c94 1837 }
3a4d5c94
MT
1838 /* Length written exceeds what we have stored. This is a bug. */
1839 BUG();
1840 return 0;
1841}
6ac1afbf 1842EXPORT_SYMBOL_GPL(vhost_log_write);
3a4d5c94 1843
2723feaa
JW
1844static int vhost_update_used_flags(struct vhost_virtqueue *vq)
1845{
1846 void __user *used;
bfe2bc51
JW
1847 if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->used_flags),
1848 &vq->used->flags) < 0)
2723feaa
JW
1849 return -EFAULT;
1850 if (unlikely(vq->log_used)) {
1851 /* Make sure the flag is seen before log. */
1852 smp_wmb();
1853 /* Log used flag write. */
1854 used = &vq->used->flags;
cc5e7107
JW
1855 log_used(vq, (used - (void __user *)vq->used),
1856 sizeof vq->used->flags);
2723feaa
JW
1857 if (vq->log_ctx)
1858 eventfd_signal(vq->log_ctx, 1);
1859 }
1860 return 0;
1861}
1862
1863static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
1864{
bfe2bc51
JW
1865 if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->avail_idx),
1866 vhost_avail_event(vq)))
2723feaa
JW
1867 return -EFAULT;
1868 if (unlikely(vq->log_used)) {
1869 void __user *used;
1870 /* Make sure the event is seen before log. */
1871 smp_wmb();
1872 /* Log avail event write */
1873 used = vhost_avail_event(vq);
cc5e7107
JW
1874 log_used(vq, (used - (void __user *)vq->used),
1875 sizeof *vhost_avail_event(vq));
2723feaa
JW
1876 if (vq->log_ctx)
1877 eventfd_signal(vq->log_ctx, 1);
1878 }
1879 return 0;
1880}
1881
80f7d030 1882int vhost_vq_init_access(struct vhost_virtqueue *vq)
2723feaa 1883{
3b1bbe89 1884 __virtio16 last_used_idx;
2723feaa 1885 int r;
e1f33be9
GK
1886 bool is_le = vq->is_le;
1887
cda8bba0 1888 if (!vq->private_data)
2723feaa 1889 return 0;
2751c988
GK
1890
1891 vhost_init_is_le(vq);
2723feaa
JW
1892
1893 r = vhost_update_used_flags(vq);
1894 if (r)
e1f33be9 1895 goto err;
2723feaa 1896 vq->signalled_used_valid = false;
6b1e6cc7 1897 if (!vq->iotlb &&
96d4f267 1898 !access_ok(&vq->used->idx, sizeof vq->used->idx)) {
e1f33be9
GK
1899 r = -EFAULT;
1900 goto err;
1901 }
f8894913 1902 r = vhost_get_used(vq, last_used_idx, &vq->used->idx);
6b1e6cc7
JW
1903 if (r) {
1904 vq_err(vq, "Can't access used idx at %p\n",
1905 &vq->used->idx);
e1f33be9 1906 goto err;
6b1e6cc7 1907 }
3b1bbe89 1908 vq->last_used_idx = vhost16_to_cpu(vq, last_used_idx);
64f7f051 1909 return 0;
6b1e6cc7 1910
e1f33be9
GK
1911err:
1912 vq->is_le = is_le;
1913 return r;
2723feaa 1914}
80f7d030 1915EXPORT_SYMBOL_GPL(vhost_vq_init_access);
2723feaa 1916
47283bef 1917static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
6b1e6cc7 1918 struct iovec iov[], int iov_size, int access)
3a4d5c94 1919{
a9709d68 1920 const struct vhost_umem_node *node;
6b1e6cc7
JW
1921 struct vhost_dev *dev = vq->dev;
1922 struct vhost_umem *umem = dev->iotlb ? dev->iotlb : dev->umem;
3a4d5c94
MT
1923 struct iovec *_iov;
1924 u64 s = 0;
1925 int ret = 0;
1926
3a4d5c94
MT
1927 while ((u64)len > s) {
1928 u64 size;
7b3384fc 1929 if (unlikely(ret >= iov_size)) {
3a4d5c94
MT
1930 ret = -ENOBUFS;
1931 break;
1932 }
6b1e6cc7 1933
a9709d68
JW
1934 node = vhost_umem_interval_tree_iter_first(&umem->umem_tree,
1935 addr, addr + len - 1);
1936 if (node == NULL || node->start > addr) {
6b1e6cc7
JW
1937 if (umem != dev->iotlb) {
1938 ret = -EFAULT;
1939 break;
1940 }
1941 ret = -EAGAIN;
1942 break;
1943 } else if (!(node->perm & access)) {
1944 ret = -EPERM;
3a4d5c94
MT
1945 break;
1946 }
6b1e6cc7 1947
3a4d5c94 1948 _iov = iov + ret;
a9709d68 1949 size = node->size - addr + node->start;
bd97120f 1950 _iov->iov_len = min((u64)len - s, size);
a8d3782f 1951 _iov->iov_base = (void __user *)(unsigned long)
a9709d68 1952 (node->userspace_addr + addr - node->start);
3a4d5c94
MT
1953 s += size;
1954 addr += size;
1955 ++ret;
1956 }
1957
6b1e6cc7
JW
1958 if (ret == -EAGAIN)
1959 vhost_iotlb_miss(vq, addr, access);
3a4d5c94
MT
1960 return ret;
1961}
1962
1963/* Each buffer in the virtqueues is actually a chain of descriptors. This
1964 * function returns the next descriptor in the chain,
1965 * or -1U if we're at the end. */
3b1bbe89 1966static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
3a4d5c94
MT
1967{
1968 unsigned int next;
1969
1970 /* If this descriptor says it doesn't chain, we're done. */
3b1bbe89 1971 if (!(desc->flags & cpu_to_vhost16(vq, VRING_DESC_F_NEXT)))
3a4d5c94
MT
1972 return -1U;
1973
1974 /* Check they're not leading us off end of descriptors. */
3a5db0b1 1975 next = vhost16_to_cpu(vq, READ_ONCE(desc->next));
3a4d5c94
MT
1976 return next;
1977}
1978
47283bef 1979static int get_indirect(struct vhost_virtqueue *vq,
7b3384fc
MT
1980 struct iovec iov[], unsigned int iov_size,
1981 unsigned int *out_num, unsigned int *in_num,
1982 struct vhost_log *log, unsigned int *log_num,
1983 struct vring_desc *indirect)
3a4d5c94
MT
1984{
1985 struct vring_desc desc;
1986 unsigned int i = 0, count, found = 0;
3b1bbe89 1987 u32 len = vhost32_to_cpu(vq, indirect->len);
aad9a1ce 1988 struct iov_iter from;
6b1e6cc7 1989 int ret, access;
3a4d5c94
MT
1990
1991 /* Sanity check */
3b1bbe89 1992 if (unlikely(len % sizeof desc)) {
3a4d5c94
MT
1993 vq_err(vq, "Invalid length in indirect descriptor: "
1994 "len 0x%llx not multiple of 0x%zx\n",
3b1bbe89 1995 (unsigned long long)len,
3a4d5c94
MT
1996 sizeof desc);
1997 return -EINVAL;
1998 }
1999
3b1bbe89 2000 ret = translate_desc(vq, vhost64_to_cpu(vq, indirect->addr), len, vq->indirect,
6b1e6cc7 2001 UIO_MAXIOV, VHOST_ACCESS_RO);
7b3384fc 2002 if (unlikely(ret < 0)) {
6b1e6cc7
JW
2003 if (ret != -EAGAIN)
2004 vq_err(vq, "Translation failure %d in indirect.\n", ret);
3a4d5c94
MT
2005 return ret;
2006 }
aad9a1ce 2007 iov_iter_init(&from, READ, vq->indirect, ret, len);
3a4d5c94
MT
2008
2009 /* We will use the result as an address to read from, so most
2010 * architectures only need a compiler barrier here. */
2011 read_barrier_depends();
2012
3b1bbe89 2013 count = len / sizeof desc;
3a4d5c94
MT
2014 /* Buffers are chained via a 16 bit next field, so
2015 * we can have at most 2^16 of these. */
7b3384fc 2016 if (unlikely(count > USHRT_MAX + 1)) {
3a4d5c94
MT
2017 vq_err(vq, "Indirect buffer length too big: %d\n",
2018 indirect->len);
2019 return -E2BIG;
2020 }
2021
2022 do {
2023 unsigned iov_count = *in_num + *out_num;
7b3384fc 2024 if (unlikely(++found > count)) {
3a4d5c94
MT
2025 vq_err(vq, "Loop detected: last one at %u "
2026 "indirect size %u\n",
2027 i, count);
2028 return -EINVAL;
2029 }
cbbd26b8 2030 if (unlikely(!copy_from_iter_full(&desc, sizeof(desc), &from))) {
3a4d5c94 2031 vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
3b1bbe89 2032 i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
3a4d5c94
MT
2033 return -EINVAL;
2034 }
3b1bbe89 2035 if (unlikely(desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT))) {
3a4d5c94 2036 vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
3b1bbe89 2037 i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
3a4d5c94
MT
2038 return -EINVAL;
2039 }
2040
6b1e6cc7
JW
2041 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
2042 access = VHOST_ACCESS_WO;
2043 else
2044 access = VHOST_ACCESS_RO;
2045
3b1bbe89
MT
2046 ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
2047 vhost32_to_cpu(vq, desc.len), iov + iov_count,
6b1e6cc7 2048 iov_size - iov_count, access);
7b3384fc 2049 if (unlikely(ret < 0)) {
6b1e6cc7
JW
2050 if (ret != -EAGAIN)
2051 vq_err(vq, "Translation failure %d indirect idx %d\n",
2052 ret, i);
3a4d5c94
MT
2053 return ret;
2054 }
2055 /* If this is an input descriptor, increment that count. */
6b1e6cc7 2056 if (access == VHOST_ACCESS_WO) {
3a4d5c94
MT
2057 *in_num += ret;
2058 if (unlikely(log)) {
3b1bbe89
MT
2059 log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
2060 log[*log_num].len = vhost32_to_cpu(vq, desc.len);
3a4d5c94
MT
2061 ++*log_num;
2062 }
2063 } else {
2064 /* If it's an output descriptor, they're all supposed
2065 * to come before any input descriptors. */
7b3384fc 2066 if (unlikely(*in_num)) {
3a4d5c94
MT
2067 vq_err(vq, "Indirect descriptor "
2068 "has out after in: idx %d\n", i);
2069 return -EINVAL;
2070 }
2071 *out_num += ret;
2072 }
3b1bbe89 2073 } while ((i = next_desc(vq, &desc)) != -1);
3a4d5c94
MT
2074 return 0;
2075}
2076
2077/* This looks in the virtqueue and for the first available buffer, and converts
2078 * it to an iovec for convenient access. Since descriptors consist of some
2079 * number of output then some number of input descriptors, it's actually two
2080 * iovecs, but we pack them into one and note how many of each there were.
2081 *
d5675bd2
MT
2082 * This function returns the descriptor number found, or vq->num (which is
2083 * never a valid descriptor number) if none was found. A negative code is
2084 * returned on error. */
47283bef 2085int vhost_get_vq_desc(struct vhost_virtqueue *vq,
d5675bd2
MT
2086 struct iovec iov[], unsigned int iov_size,
2087 unsigned int *out_num, unsigned int *in_num,
2088 struct vhost_log *log, unsigned int *log_num)
3a4d5c94
MT
2089{
2090 struct vring_desc desc;
2091 unsigned int i, head, found = 0;
2092 u16 last_avail_idx;
3b1bbe89
MT
2093 __virtio16 avail_idx;
2094 __virtio16 ring_head;
6b1e6cc7 2095 int ret, access;
3a4d5c94
MT
2096
2097 /* Check it isn't doing very strange things with descriptor numbers. */
2098 last_avail_idx = vq->last_avail_idx;
3a4d5c94 2099
e3b56cdd 2100 if (vq->avail_idx == vq->last_avail_idx) {
f8894913 2101 if (unlikely(vhost_get_avail(vq, avail_idx, &vq->avail->idx))) {
e3b56cdd
JW
2102 vq_err(vq, "Failed to access avail idx at %p\n",
2103 &vq->avail->idx);
2104 return -EFAULT;
2105 }
2106 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
3a4d5c94 2107
e3b56cdd
JW
2108 if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
2109 vq_err(vq, "Guest moved used index from %u to %u",
2110 last_avail_idx, vq->avail_idx);
2111 return -EFAULT;
2112 }
2113
2114 /* If there's nothing new since last we looked, return
2115 * invalid.
2116 */
2117 if (vq->avail_idx == last_avail_idx)
2118 return vq->num;
3a4d5c94 2119
e3b56cdd
JW
2120 /* Only get avail ring entries after they have been
2121 * exposed by guest.
2122 */
2123 smp_rmb();
2124 }
3a4d5c94
MT
2125
2126 /* Grab the next descriptor number they're advertising, and increment
2127 * the index we've seen. */
f8894913 2128 if (unlikely(vhost_get_avail(vq, ring_head,
bfe2bc51 2129 &vq->avail->ring[last_avail_idx & (vq->num - 1)]))) {
3a4d5c94
MT
2130 vq_err(vq, "Failed to read head: idx %d address %p\n",
2131 last_avail_idx,
2132 &vq->avail->ring[last_avail_idx % vq->num]);
d5675bd2 2133 return -EFAULT;
3a4d5c94
MT
2134 }
2135
3b1bbe89
MT
2136 head = vhost16_to_cpu(vq, ring_head);
2137
3a4d5c94 2138 /* If their number is silly, that's an error. */
7b3384fc 2139 if (unlikely(head >= vq->num)) {
3a4d5c94
MT
2140 vq_err(vq, "Guest says index %u > %u is available",
2141 head, vq->num);
d5675bd2 2142 return -EINVAL;
3a4d5c94
MT
2143 }
2144
2145 /* When we start there are none of either input nor output. */
2146 *out_num = *in_num = 0;
2147 if (unlikely(log))
2148 *log_num = 0;
2149
2150 i = head;
2151 do {
2152 unsigned iov_count = *in_num + *out_num;
7b3384fc 2153 if (unlikely(i >= vq->num)) {
3a4d5c94
MT
2154 vq_err(vq, "Desc index is %u > %u, head = %u",
2155 i, vq->num, head);
d5675bd2 2156 return -EINVAL;
3a4d5c94 2157 }
7b3384fc 2158 if (unlikely(++found > vq->num)) {
3a4d5c94
MT
2159 vq_err(vq, "Loop detected: last one at %u "
2160 "vq size %u head %u\n",
2161 i, vq->num, head);
d5675bd2 2162 return -EINVAL;
3a4d5c94 2163 }
bfe2bc51
JW
2164 ret = vhost_copy_from_user(vq, &desc, vq->desc + i,
2165 sizeof desc);
7b3384fc 2166 if (unlikely(ret)) {
3a4d5c94
MT
2167 vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
2168 i, vq->desc + i);
d5675bd2 2169 return -EFAULT;
3a4d5c94 2170 }
3b1bbe89 2171 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT)) {
47283bef 2172 ret = get_indirect(vq, iov, iov_size,
3a4d5c94
MT
2173 out_num, in_num,
2174 log, log_num, &desc);
7b3384fc 2175 if (unlikely(ret < 0)) {
6b1e6cc7
JW
2176 if (ret != -EAGAIN)
2177 vq_err(vq, "Failure detected "
2178 "in indirect descriptor at idx %d\n", i);
d5675bd2 2179 return ret;
3a4d5c94
MT
2180 }
2181 continue;
2182 }
2183
6b1e6cc7
JW
2184 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
2185 access = VHOST_ACCESS_WO;
2186 else
2187 access = VHOST_ACCESS_RO;
3b1bbe89
MT
2188 ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
2189 vhost32_to_cpu(vq, desc.len), iov + iov_count,
6b1e6cc7 2190 iov_size - iov_count, access);
7b3384fc 2191 if (unlikely(ret < 0)) {
6b1e6cc7
JW
2192 if (ret != -EAGAIN)
2193 vq_err(vq, "Translation failure %d descriptor idx %d\n",
2194 ret, i);
d5675bd2 2195 return ret;
3a4d5c94 2196 }
6b1e6cc7 2197 if (access == VHOST_ACCESS_WO) {
3a4d5c94
MT
2198 /* If this is an input descriptor,
2199 * increment that count. */
2200 *in_num += ret;
2201 if (unlikely(log)) {
3b1bbe89
MT
2202 log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
2203 log[*log_num].len = vhost32_to_cpu(vq, desc.len);
3a4d5c94
MT
2204 ++*log_num;
2205 }
2206 } else {
2207 /* If it's an output descriptor, they're all supposed
2208 * to come before any input descriptors. */
7b3384fc 2209 if (unlikely(*in_num)) {
3a4d5c94
MT
2210 vq_err(vq, "Descriptor has out after in: "
2211 "idx %d\n", i);
d5675bd2 2212 return -EINVAL;
3a4d5c94
MT
2213 }
2214 *out_num += ret;
2215 }
3b1bbe89 2216 } while ((i = next_desc(vq, &desc)) != -1);
3a4d5c94
MT
2217
2218 /* On success, increment avail index. */
2219 vq->last_avail_idx++;
8ea8cf89
MT
2220
2221 /* Assume notifications from guest are disabled at this point,
2222 * if they aren't we would need to update avail_event index. */
2223 BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
3a4d5c94
MT
2224 return head;
2225}
6ac1afbf 2226EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
3a4d5c94
MT
2227
2228/* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
8dd014ad 2229void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
3a4d5c94 2230{
8dd014ad 2231 vq->last_avail_idx -= n;
3a4d5c94 2232}
6ac1afbf 2233EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
3a4d5c94
MT
2234
2235/* After we've used one of their buffers, we tell them about it. We'll then
2236 * want to notify the guest, using eventfd. */
2237int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
2238{
3b1bbe89
MT
2239 struct vring_used_elem heads = {
2240 cpu_to_vhost32(vq, head),
2241 cpu_to_vhost32(vq, len)
2242 };
3a4d5c94 2243
c49e4e57 2244 return vhost_add_used_n(vq, &heads, 1);
3a4d5c94 2245}
6ac1afbf 2246EXPORT_SYMBOL_GPL(vhost_add_used);
3a4d5c94 2247
8dd014ad
DS
2248static int __vhost_add_used_n(struct vhost_virtqueue *vq,
2249 struct vring_used_elem *heads,
2250 unsigned count)
2251{
2252 struct vring_used_elem __user *used;
8ea8cf89 2253 u16 old, new;
8dd014ad
DS
2254 int start;
2255
5fba13b5 2256 start = vq->last_used_idx & (vq->num - 1);
8dd014ad 2257 used = vq->used->ring + start;
c49e4e57 2258 if (count == 1) {
bfe2bc51 2259 if (vhost_put_user(vq, heads[0].id, &used->id)) {
c49e4e57
JW
2260 vq_err(vq, "Failed to write used id");
2261 return -EFAULT;
2262 }
bfe2bc51 2263 if (vhost_put_user(vq, heads[0].len, &used->len)) {
c49e4e57
JW
2264 vq_err(vq, "Failed to write used len");
2265 return -EFAULT;
2266 }
bfe2bc51 2267 } else if (vhost_copy_to_user(vq, used, heads, count * sizeof *used)) {
8dd014ad
DS
2268 vq_err(vq, "Failed to write used");
2269 return -EFAULT;
2270 }
2271 if (unlikely(vq->log_used)) {
2272 /* Make sure data is seen before log. */
2273 smp_wmb();
2274 /* Log used ring entry write. */
cc5e7107
JW
2275 log_used(vq, ((void __user *)used - (void __user *)vq->used),
2276 count * sizeof *used);
8dd014ad 2277 }
8ea8cf89
MT
2278 old = vq->last_used_idx;
2279 new = (vq->last_used_idx += count);
2280 /* If the driver never bothers to signal in a very long while,
2281 * used index might wrap around. If that happens, invalidate
2282 * signalled_used index we stored. TODO: make sure driver
2283 * signals at least once in 2^16 and remove this. */
2284 if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
2285 vq->signalled_used_valid = false;
8dd014ad
DS
2286 return 0;
2287}
2288
2289/* After we've used one of their buffers, we tell them about it. We'll then
2290 * want to notify the guest, using eventfd. */
2291int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
2292 unsigned count)
2293{
2294 int start, n, r;
2295
5fba13b5 2296 start = vq->last_used_idx & (vq->num - 1);
8dd014ad
DS
2297 n = vq->num - start;
2298 if (n < count) {
2299 r = __vhost_add_used_n(vq, heads, n);
2300 if (r < 0)
2301 return r;
2302 heads += n;
2303 count -= n;
2304 }
2305 r = __vhost_add_used_n(vq, heads, count);
2306
2307 /* Make sure buffer is written before we update index. */
2308 smp_wmb();
bfe2bc51
JW
2309 if (vhost_put_user(vq, cpu_to_vhost16(vq, vq->last_used_idx),
2310 &vq->used->idx)) {
8dd014ad
DS
2311 vq_err(vq, "Failed to increment used idx");
2312 return -EFAULT;
2313 }
2314 if (unlikely(vq->log_used)) {
841df922
JW
2315 /* Make sure used idx is seen before log. */
2316 smp_wmb();
8dd014ad 2317 /* Log used index update. */
cc5e7107
JW
2318 log_used(vq, offsetof(struct vring_used, idx),
2319 sizeof vq->used->idx);
8dd014ad
DS
2320 if (vq->log_ctx)
2321 eventfd_signal(vq->log_ctx, 1);
2322 }
2323 return r;
2324}
6ac1afbf 2325EXPORT_SYMBOL_GPL(vhost_add_used_n);
8dd014ad 2326
8ea8cf89 2327static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
3a4d5c94 2328{
3b1bbe89
MT
2329 __u16 old, new;
2330 __virtio16 event;
8ea8cf89 2331 bool v;
8d65843c
JW
2332 /* Flush out used index updates. This is paired
2333 * with the barrier that the Guest executes when enabling
2334 * interrupts. */
2335 smp_mb();
0d499356 2336
ea16c514 2337 if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
8ea8cf89
MT
2338 unlikely(vq->avail_idx == vq->last_avail_idx))
2339 return true;
2340
ea16c514 2341 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
3b1bbe89 2342 __virtio16 flags;
f8894913 2343 if (vhost_get_avail(vq, flags, &vq->avail->flags)) {
8ea8cf89
MT
2344 vq_err(vq, "Failed to get flags");
2345 return true;
2346 }
3b1bbe89 2347 return !(flags & cpu_to_vhost16(vq, VRING_AVAIL_F_NO_INTERRUPT));
3a4d5c94 2348 }
8ea8cf89
MT
2349 old = vq->signalled_used;
2350 v = vq->signalled_used_valid;
2351 new = vq->signalled_used = vq->last_used_idx;
2352 vq->signalled_used_valid = true;
3a4d5c94 2353
8ea8cf89
MT
2354 if (unlikely(!v))
2355 return true;
3a4d5c94 2356
f8894913 2357 if (vhost_get_avail(vq, event, vhost_used_event(vq))) {
8ea8cf89
MT
2358 vq_err(vq, "Failed to get used event idx");
2359 return true;
2360 }
8d65843c 2361 return vring_need_event(vhost16_to_cpu(vq, event), new, old);
8ea8cf89
MT
2362}
2363
2364/* This actually signals the guest, using eventfd. */
2365void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2366{
3a4d5c94 2367 /* Signal the Guest tell them we used something up. */
8ea8cf89 2368 if (vq->call_ctx && vhost_notify(dev, vq))
3a4d5c94
MT
2369 eventfd_signal(vq->call_ctx, 1);
2370}
6ac1afbf 2371EXPORT_SYMBOL_GPL(vhost_signal);
3a4d5c94
MT
2372
2373/* And here's the combo meal deal. Supersize me! */
2374void vhost_add_used_and_signal(struct vhost_dev *dev,
2375 struct vhost_virtqueue *vq,
2376 unsigned int head, int len)
2377{
2378 vhost_add_used(vq, head, len);
2379 vhost_signal(dev, vq);
2380}
6ac1afbf 2381EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
3a4d5c94 2382
8dd014ad
DS
2383/* multi-buffer version of vhost_add_used_and_signal */
2384void vhost_add_used_and_signal_n(struct vhost_dev *dev,
2385 struct vhost_virtqueue *vq,
2386 struct vring_used_elem *heads, unsigned count)
2387{
2388 vhost_add_used_n(vq, heads, count);
2389 vhost_signal(dev, vq);
2390}
6ac1afbf 2391EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
8dd014ad 2392
d4a60603
JW
2393/* return true if we're sure that avaiable ring is empty */
2394bool vhost_vq_avail_empty(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2395{
2396 __virtio16 avail_idx;
2397 int r;
2398
275bf960
JW
2399 if (vq->avail_idx != vq->last_avail_idx)
2400 return false;
2401
f8894913 2402 r = vhost_get_avail(vq, avail_idx, &vq->avail->idx);
275bf960 2403 if (unlikely(r))
d4a60603 2404 return false;
275bf960 2405 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
d4a60603 2406
275bf960 2407 return vq->avail_idx == vq->last_avail_idx;
d4a60603
JW
2408}
2409EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);
2410
3a4d5c94 2411/* OK, now we need to know about added descriptors. */
8ea8cf89 2412bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
3a4d5c94 2413{
3b1bbe89 2414 __virtio16 avail_idx;
3a4d5c94 2415 int r;
d47effe1 2416
3a4d5c94
MT
2417 if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
2418 return false;
2419 vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
ea16c514 2420 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2723feaa 2421 r = vhost_update_used_flags(vq);
8ea8cf89
MT
2422 if (r) {
2423 vq_err(vq, "Failed to enable notification at %p: %d\n",
2424 &vq->used->flags, r);
2425 return false;
2426 }
2427 } else {
2723feaa 2428 r = vhost_update_avail_event(vq, vq->avail_idx);
8ea8cf89
MT
2429 if (r) {
2430 vq_err(vq, "Failed to update avail event index at %p: %d\n",
2431 vhost_avail_event(vq), r);
2432 return false;
2433 }
2434 }
3a4d5c94
MT
2435 /* They could have slipped one in as we were doing that: make
2436 * sure it's written, then check again. */
5659338c 2437 smp_mb();
f8894913 2438 r = vhost_get_avail(vq, avail_idx, &vq->avail->idx);
3a4d5c94
MT
2439 if (r) {
2440 vq_err(vq, "Failed to check avail idx at %p: %d\n",
2441 &vq->avail->idx, r);
2442 return false;
2443 }
2444
3b1bbe89 2445 return vhost16_to_cpu(vq, avail_idx) != vq->avail_idx;
3a4d5c94 2446}
6ac1afbf 2447EXPORT_SYMBOL_GPL(vhost_enable_notify);
3a4d5c94
MT
2448
2449/* We don't need to be notified again. */
8ea8cf89 2450void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
3a4d5c94
MT
2451{
2452 int r;
d47effe1 2453
3a4d5c94
MT
2454 if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
2455 return;
2456 vq->used_flags |= VRING_USED_F_NO_NOTIFY;
ea16c514 2457 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2723feaa 2458 r = vhost_update_used_flags(vq);
8ea8cf89
MT
2459 if (r)
2460 vq_err(vq, "Failed to enable notification at %p: %d\n",
2461 &vq->used->flags, r);
2462 }
3a4d5c94 2463}
6ac1afbf
AH
2464EXPORT_SYMBOL_GPL(vhost_disable_notify);
2465
6b1e6cc7
JW
2466/* Create a new message. */
2467struct vhost_msg_node *vhost_new_msg(struct vhost_virtqueue *vq, int type)
2468{
2469 struct vhost_msg_node *node = kmalloc(sizeof *node, GFP_KERNEL);
2470 if (!node)
2471 return NULL;
670ae9ca
MT
2472
2473 /* Make sure all padding within the structure is initialized. */
2474 memset(&node->msg, 0, sizeof node->msg);
6b1e6cc7
JW
2475 node->vq = vq;
2476 node->msg.type = type;
2477 return node;
2478}
2479EXPORT_SYMBOL_GPL(vhost_new_msg);
2480
2481void vhost_enqueue_msg(struct vhost_dev *dev, struct list_head *head,
2482 struct vhost_msg_node *node)
2483{
2484 spin_lock(&dev->iotlb_lock);
2485 list_add_tail(&node->node, head);
2486 spin_unlock(&dev->iotlb_lock);
2487
a9a08845 2488 wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
6b1e6cc7
JW
2489}
2490EXPORT_SYMBOL_GPL(vhost_enqueue_msg);
2491
2492struct vhost_msg_node *vhost_dequeue_msg(struct vhost_dev *dev,
2493 struct list_head *head)
2494{
2495 struct vhost_msg_node *node = NULL;
2496
2497 spin_lock(&dev->iotlb_lock);
2498 if (!list_empty(head)) {
2499 node = list_first_entry(head, struct vhost_msg_node,
2500 node);
2501 list_del(&node->node);
2502 }
2503 spin_unlock(&dev->iotlb_lock);
2504
2505 return node;
2506}
2507EXPORT_SYMBOL_GPL(vhost_dequeue_msg);
2508
2509
6ac1afbf
AH
2510static int __init vhost_init(void)
2511{
2512 return 0;
2513}
2514
2515static void __exit vhost_exit(void)
2516{
2517}
2518
2519module_init(vhost_init);
2520module_exit(vhost_exit);
2521
2522MODULE_VERSION("0.0.1");
2523MODULE_LICENSE("GPL v2");
2524MODULE_AUTHOR("Michael S. Tsirkin");
2525MODULE_DESCRIPTION("Host kernel accelerator for virtio");