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