1 // SPDX-License-Identifier: GPL-2.0-only
2 /* Copyright (C) 2009 Red Hat, Inc.
3 * Copyright (C) 2006 Rusty Russell IBM Corporation
5 * Author: Michael S. Tsirkin <mst@redhat.com>
7 * Inspiration, some code, and most witty comments come from
8 * Documentation/virtual/lguest/lguest.c, by Rusty Russell
10 * Generic code for virtio server in host kernel.
13 #include <linux/eventfd.h>
14 #include <linux/vhost.h>
15 #include <linux/uio.h>
17 #include <linux/miscdevice.h>
18 #include <linux/mutex.h>
19 #include <linux/poll.h>
20 #include <linux/file.h>
21 #include <linux/highmem.h>
22 #include <linux/slab.h>
23 #include <linux/vmalloc.h>
24 #include <linux/kthread.h>
25 #include <linux/cgroup.h>
26 #include <linux/module.h>
27 #include <linux/sort.h>
28 #include <linux/sched/mm.h>
29 #include <linux/sched/signal.h>
30 #include <linux/interval_tree_generic.h>
31 #include <linux/nospec.h>
32 #include <linux/kcov.h>
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)");
46 VHOST_MEMORY_F_LOG = 0x1,
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])
52 #ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
53 static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
55 vq->user_be = !virtio_legacy_is_little_endian();
58 static void vhost_enable_cross_endian_big(struct vhost_virtqueue *vq)
63 static void vhost_enable_cross_endian_little(struct vhost_virtqueue *vq)
68 static long vhost_set_vring_endian(struct vhost_virtqueue *vq, int __user *argp)
70 struct vhost_vring_state s;
75 if (copy_from_user(&s, argp, sizeof(s)))
78 if (s.num != VHOST_VRING_LITTLE_ENDIAN &&
79 s.num != VHOST_VRING_BIG_ENDIAN)
82 if (s.num == VHOST_VRING_BIG_ENDIAN)
83 vhost_enable_cross_endian_big(vq);
85 vhost_enable_cross_endian_little(vq);
90 static long vhost_get_vring_endian(struct vhost_virtqueue *vq, u32 idx,
93 struct vhost_vring_state s = {
98 if (copy_to_user(argp, &s, sizeof(s)))
104 static void vhost_init_is_le(struct vhost_virtqueue *vq)
106 /* Note for legacy virtio: user_be is initialized at reset time
107 * according to the host endianness. If userspace does not set an
108 * explicit endianness, the default behavior is native endian, as
109 * expected by legacy virtio.
111 vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1) || !vq->user_be;
114 static void vhost_disable_cross_endian(struct vhost_virtqueue *vq)
118 static long vhost_set_vring_endian(struct vhost_virtqueue *vq, int __user *argp)
123 static long vhost_get_vring_endian(struct vhost_virtqueue *vq, u32 idx,
129 static void vhost_init_is_le(struct vhost_virtqueue *vq)
131 vq->is_le = vhost_has_feature(vq, VIRTIO_F_VERSION_1)
132 || virtio_legacy_is_little_endian();
134 #endif /* CONFIG_VHOST_CROSS_ENDIAN_LEGACY */
136 static void vhost_reset_is_le(struct vhost_virtqueue *vq)
138 vhost_init_is_le(vq);
141 struct vhost_flush_struct {
142 struct vhost_work work;
143 struct completion wait_event;
146 static void vhost_flush_work(struct vhost_work *work)
148 struct vhost_flush_struct *s;
150 s = container_of(work, struct vhost_flush_struct, work);
151 complete(&s->wait_event);
154 static void vhost_poll_func(struct file *file, wait_queue_head_t *wqh,
157 struct vhost_poll *poll;
159 poll = container_of(pt, struct vhost_poll, table);
161 add_wait_queue(wqh, &poll->wait);
164 static int vhost_poll_wakeup(wait_queue_entry_t *wait, unsigned mode, int sync,
167 struct vhost_poll *poll = container_of(wait, struct vhost_poll, wait);
168 struct vhost_work *work = &poll->work;
170 if (!(key_to_poll(key) & poll->mask))
173 if (!poll->dev->use_worker)
176 vhost_poll_queue(poll);
181 void vhost_work_init(struct vhost_work *work, vhost_work_fn_t fn)
183 clear_bit(VHOST_WORK_QUEUED, &work->flags);
186 EXPORT_SYMBOL_GPL(vhost_work_init);
188 /* Init poll structure */
189 void vhost_poll_init(struct vhost_poll *poll, vhost_work_fn_t fn,
190 __poll_t mask, struct vhost_dev *dev)
192 init_waitqueue_func_entry(&poll->wait, vhost_poll_wakeup);
193 init_poll_funcptr(&poll->table, vhost_poll_func);
198 vhost_work_init(&poll->work, fn);
200 EXPORT_SYMBOL_GPL(vhost_poll_init);
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)
211 mask = vfs_poll(file, &poll->table);
213 vhost_poll_wakeup(&poll->wait, 0, 0, poll_to_key(mask));
214 if (mask & EPOLLERR) {
215 vhost_poll_stop(poll);
221 EXPORT_SYMBOL_GPL(vhost_poll_start);
223 /* Stop polling a file. After this function returns, it becomes safe to drop the
224 * file reference. You must also flush afterwards. */
225 void vhost_poll_stop(struct vhost_poll *poll)
228 remove_wait_queue(poll->wqh, &poll->wait);
232 EXPORT_SYMBOL_GPL(vhost_poll_stop);
234 void vhost_dev_flush(struct vhost_dev *dev)
236 struct vhost_flush_struct flush;
239 init_completion(&flush.wait_event);
240 vhost_work_init(&flush.work, vhost_flush_work);
242 vhost_work_queue(dev, &flush.work);
243 wait_for_completion(&flush.wait_event);
246 EXPORT_SYMBOL_GPL(vhost_dev_flush);
248 void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
253 if (!test_and_set_bit(VHOST_WORK_QUEUED, &work->flags)) {
254 /* We can only add the work to the list after we're
255 * sure it was not in the list.
256 * test_and_set_bit() implies a memory barrier.
258 llist_add(&work->node, &dev->work_list);
259 wake_up_process(dev->worker);
262 EXPORT_SYMBOL_GPL(vhost_work_queue);
264 /* A lockless hint for busy polling code to exit the loop */
265 bool vhost_has_work(struct vhost_dev *dev)
267 return !llist_empty(&dev->work_list);
269 EXPORT_SYMBOL_GPL(vhost_has_work);
271 void vhost_poll_queue(struct vhost_poll *poll)
273 vhost_work_queue(poll->dev, &poll->work);
275 EXPORT_SYMBOL_GPL(vhost_poll_queue);
277 static void __vhost_vq_meta_reset(struct vhost_virtqueue *vq)
281 for (j = 0; j < VHOST_NUM_ADDRS; j++)
282 vq->meta_iotlb[j] = NULL;
285 static void vhost_vq_meta_reset(struct vhost_dev *d)
289 for (i = 0; i < d->nvqs; ++i)
290 __vhost_vq_meta_reset(d->vqs[i]);
293 static void vhost_vring_call_reset(struct vhost_vring_call *call_ctx)
295 call_ctx->ctx = NULL;
296 memset(&call_ctx->producer, 0x0, sizeof(struct irq_bypass_producer));
299 bool vhost_vq_is_setup(struct vhost_virtqueue *vq)
301 return vq->avail && vq->desc && vq->used && vhost_vq_access_ok(vq);
303 EXPORT_SYMBOL_GPL(vhost_vq_is_setup);
305 static void vhost_vq_reset(struct vhost_dev *dev,
306 struct vhost_virtqueue *vq)
312 vq->last_avail_idx = 0;
314 vq->last_used_idx = 0;
315 vq->signalled_used = 0;
316 vq->signalled_used_valid = false;
318 vq->log_used = false;
319 vq->log_addr = -1ull;
320 vq->private_data = NULL;
321 vq->acked_features = 0;
322 vq->acked_backend_features = 0;
324 vq->error_ctx = NULL;
327 vhost_disable_cross_endian(vq);
328 vhost_reset_is_le(vq);
329 vq->busyloop_timeout = 0;
332 vhost_vring_call_reset(&vq->call_ctx);
333 __vhost_vq_meta_reset(vq);
336 static int vhost_worker(void *data)
338 struct vhost_dev *dev = data;
339 struct vhost_work *work, *work_next;
340 struct llist_node *node;
342 kthread_use_mm(dev->mm);
345 /* mb paired w/ kthread_stop */
346 set_current_state(TASK_INTERRUPTIBLE);
348 if (kthread_should_stop()) {
349 __set_current_state(TASK_RUNNING);
353 node = llist_del_all(&dev->work_list);
357 node = llist_reverse_order(node);
358 /* make sure flag is seen after deletion */
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 kcov_remote_start_common(dev->kcov_handle);
370 kthread_unuse_mm(dev->mm);
374 static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
384 /* Helper to allocate iovec buffers for all vqs. */
385 static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
387 struct vhost_virtqueue *vq;
390 for (i = 0; i < dev->nvqs; ++i) {
392 vq->indirect = kmalloc_array(UIO_MAXIOV,
393 sizeof(*vq->indirect),
395 vq->log = kmalloc_array(dev->iov_limit, sizeof(*vq->log),
397 vq->heads = kmalloc_array(dev->iov_limit, sizeof(*vq->heads),
399 if (!vq->indirect || !vq->log || !vq->heads)
406 vhost_vq_free_iovecs(dev->vqs[i]);
410 static void vhost_dev_free_iovecs(struct vhost_dev *dev)
414 for (i = 0; i < dev->nvqs; ++i)
415 vhost_vq_free_iovecs(dev->vqs[i]);
418 bool vhost_exceeds_weight(struct vhost_virtqueue *vq,
419 int pkts, int total_len)
421 struct vhost_dev *dev = vq->dev;
423 if ((dev->byte_weight && total_len >= dev->byte_weight) ||
424 pkts >= dev->weight) {
425 vhost_poll_queue(&vq->poll);
431 EXPORT_SYMBOL_GPL(vhost_exceeds_weight);
433 static size_t vhost_get_avail_size(struct vhost_virtqueue *vq,
436 size_t event __maybe_unused =
437 vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
439 return sizeof(*vq->avail) +
440 sizeof(*vq->avail->ring) * num + event;
443 static size_t vhost_get_used_size(struct vhost_virtqueue *vq,
446 size_t event __maybe_unused =
447 vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
449 return sizeof(*vq->used) +
450 sizeof(*vq->used->ring) * num + event;
453 static size_t vhost_get_desc_size(struct vhost_virtqueue *vq,
456 return sizeof(*vq->desc) * num;
459 void vhost_dev_init(struct vhost_dev *dev,
460 struct vhost_virtqueue **vqs, int nvqs,
461 int iov_limit, int weight, int byte_weight,
463 int (*msg_handler)(struct vhost_dev *dev, u32 asid,
464 struct vhost_iotlb_msg *msg))
466 struct vhost_virtqueue *vq;
471 mutex_init(&dev->mutex);
477 dev->iov_limit = iov_limit;
478 dev->weight = weight;
479 dev->byte_weight = byte_weight;
480 dev->use_worker = use_worker;
481 dev->msg_handler = msg_handler;
482 init_llist_head(&dev->work_list);
483 init_waitqueue_head(&dev->wait);
484 INIT_LIST_HEAD(&dev->read_list);
485 INIT_LIST_HEAD(&dev->pending_list);
486 spin_lock_init(&dev->iotlb_lock);
489 for (i = 0; i < dev->nvqs; ++i) {
495 mutex_init(&vq->mutex);
496 vhost_vq_reset(dev, vq);
498 vhost_poll_init(&vq->poll, vq->handle_kick,
502 EXPORT_SYMBOL_GPL(vhost_dev_init);
504 /* Caller should have device mutex */
505 long vhost_dev_check_owner(struct vhost_dev *dev)
507 /* Are you the owner? If not, I don't think you mean to do that */
508 return dev->mm == current->mm ? 0 : -EPERM;
510 EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
512 struct vhost_attach_cgroups_struct {
513 struct vhost_work work;
514 struct task_struct *owner;
518 static void vhost_attach_cgroups_work(struct vhost_work *work)
520 struct vhost_attach_cgroups_struct *s;
522 s = container_of(work, struct vhost_attach_cgroups_struct, work);
523 s->ret = cgroup_attach_task_all(s->owner, current);
526 static int vhost_attach_cgroups(struct vhost_dev *dev)
528 struct vhost_attach_cgroups_struct attach;
530 attach.owner = current;
531 vhost_work_init(&attach.work, vhost_attach_cgroups_work);
532 vhost_work_queue(dev, &attach.work);
533 vhost_dev_flush(dev);
537 /* Caller should have device mutex */
538 bool vhost_dev_has_owner(struct vhost_dev *dev)
542 EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
544 static void vhost_attach_mm(struct vhost_dev *dev)
546 /* No owner, become one */
547 if (dev->use_worker) {
548 dev->mm = get_task_mm(current);
550 /* vDPA device does not use worker thead, so there's
551 * no need to hold the address space for mm. This help
552 * to avoid deadlock in the case of mmap() which may
553 * held the refcnt of the file and depends on release
554 * method to remove vma.
556 dev->mm = current->mm;
561 static void vhost_detach_mm(struct vhost_dev *dev)
574 /* Caller should have device mutex */
575 long vhost_dev_set_owner(struct vhost_dev *dev)
577 struct task_struct *worker;
580 /* Is there an owner already? */
581 if (vhost_dev_has_owner(dev)) {
586 vhost_attach_mm(dev);
588 dev->kcov_handle = kcov_common_handle();
589 if (dev->use_worker) {
590 worker = kthread_create(vhost_worker, dev,
591 "vhost-%d", current->pid);
592 if (IS_ERR(worker)) {
593 err = PTR_ERR(worker);
597 dev->worker = worker;
598 wake_up_process(worker); /* avoid contributing to loadavg */
600 err = vhost_attach_cgroups(dev);
605 err = vhost_dev_alloc_iovecs(dev);
612 kthread_stop(dev->worker);
616 vhost_detach_mm(dev);
617 dev->kcov_handle = 0;
621 EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
623 static struct vhost_iotlb *iotlb_alloc(void)
625 return vhost_iotlb_alloc(max_iotlb_entries,
626 VHOST_IOTLB_FLAG_RETIRE);
629 struct vhost_iotlb *vhost_dev_reset_owner_prepare(void)
631 return iotlb_alloc();
633 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
635 /* Caller should have device mutex */
636 void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_iotlb *umem)
640 vhost_dev_cleanup(dev);
643 /* We don't need VQ locks below since vhost_dev_cleanup makes sure
644 * VQs aren't running.
646 for (i = 0; i < dev->nvqs; ++i)
647 dev->vqs[i]->umem = umem;
649 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
651 void vhost_dev_stop(struct vhost_dev *dev)
655 for (i = 0; i < dev->nvqs; ++i) {
656 if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick)
657 vhost_poll_stop(&dev->vqs[i]->poll);
660 vhost_dev_flush(dev);
662 EXPORT_SYMBOL_GPL(vhost_dev_stop);
664 static void vhost_clear_msg(struct vhost_dev *dev)
666 struct vhost_msg_node *node, *n;
668 spin_lock(&dev->iotlb_lock);
670 list_for_each_entry_safe(node, n, &dev->read_list, node) {
671 list_del(&node->node);
675 list_for_each_entry_safe(node, n, &dev->pending_list, node) {
676 list_del(&node->node);
680 spin_unlock(&dev->iotlb_lock);
683 void vhost_dev_cleanup(struct vhost_dev *dev)
687 for (i = 0; i < dev->nvqs; ++i) {
688 if (dev->vqs[i]->error_ctx)
689 eventfd_ctx_put(dev->vqs[i]->error_ctx);
690 if (dev->vqs[i]->kick)
691 fput(dev->vqs[i]->kick);
692 if (dev->vqs[i]->call_ctx.ctx)
693 eventfd_ctx_put(dev->vqs[i]->call_ctx.ctx);
694 vhost_vq_reset(dev, dev->vqs[i]);
696 vhost_dev_free_iovecs(dev);
698 eventfd_ctx_put(dev->log_ctx);
700 /* No one will access memory at this point */
701 vhost_iotlb_free(dev->umem);
703 vhost_iotlb_free(dev->iotlb);
705 vhost_clear_msg(dev);
706 wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
707 WARN_ON(!llist_empty(&dev->work_list));
709 kthread_stop(dev->worker);
711 dev->kcov_handle = 0;
713 vhost_detach_mm(dev);
715 EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
717 static bool log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
719 u64 a = addr / VHOST_PAGE_SIZE / 8;
721 /* Make sure 64 bit math will not overflow. */
722 if (a > ULONG_MAX - (unsigned long)log_base ||
723 a + (unsigned long)log_base > ULONG_MAX)
726 return access_ok(log_base + a,
727 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
730 /* Make sure 64 bit math will not overflow. */
731 static bool vhost_overflow(u64 uaddr, u64 size)
733 if (uaddr > ULONG_MAX || size > ULONG_MAX)
739 return uaddr > ULONG_MAX - size + 1;
742 /* Caller should have vq mutex and device mutex. */
743 static bool vq_memory_access_ok(void __user *log_base, struct vhost_iotlb *umem,
746 struct vhost_iotlb_map *map;
751 list_for_each_entry(map, &umem->list, link) {
752 unsigned long a = map->addr;
754 if (vhost_overflow(map->addr, map->size))
758 if (!access_ok((void __user *)a, map->size))
760 else if (log_all && !log_access_ok(log_base,
768 static inline void __user *vhost_vq_meta_fetch(struct vhost_virtqueue *vq,
769 u64 addr, unsigned int size,
772 const struct vhost_iotlb_map *map = vq->meta_iotlb[type];
777 return (void __user *)(uintptr_t)(map->addr + addr - map->start);
780 /* Can we switch to this memory table? */
781 /* Caller should have device mutex but not vq mutex */
782 static bool memory_access_ok(struct vhost_dev *d, struct vhost_iotlb *umem,
787 for (i = 0; i < d->nvqs; ++i) {
791 mutex_lock(&d->vqs[i]->mutex);
792 log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
793 /* If ring is inactive, will check when it's enabled. */
794 if (d->vqs[i]->private_data)
795 ok = vq_memory_access_ok(d->vqs[i]->log_base,
799 mutex_unlock(&d->vqs[i]->mutex);
806 static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
807 struct iovec iov[], int iov_size, int access);
809 static int vhost_copy_to_user(struct vhost_virtqueue *vq, void __user *to,
810 const void *from, unsigned size)
815 return __copy_to_user(to, from, size);
817 /* This function should be called after iotlb
818 * prefetch, which means we're sure that all vq
819 * could be access through iotlb. So -EAGAIN should
820 * not happen in this case.
823 void __user *uaddr = vhost_vq_meta_fetch(vq,
824 (u64)(uintptr_t)to, size,
828 return __copy_to_user(uaddr, from, size);
830 ret = translate_desc(vq, (u64)(uintptr_t)to, size, vq->iotlb_iov,
831 ARRAY_SIZE(vq->iotlb_iov),
835 iov_iter_init(&t, WRITE, vq->iotlb_iov, ret, size);
836 ret = copy_to_iter(from, size, &t);
844 static int vhost_copy_from_user(struct vhost_virtqueue *vq, void *to,
845 void __user *from, unsigned size)
850 return __copy_from_user(to, from, size);
852 /* This function should be called after iotlb
853 * prefetch, which means we're sure that vq
854 * could be access through iotlb. So -EAGAIN should
855 * not happen in this case.
857 void __user *uaddr = vhost_vq_meta_fetch(vq,
858 (u64)(uintptr_t)from, size,
863 return __copy_from_user(to, uaddr, size);
865 ret = translate_desc(vq, (u64)(uintptr_t)from, size, vq->iotlb_iov,
866 ARRAY_SIZE(vq->iotlb_iov),
869 vq_err(vq, "IOTLB translation failure: uaddr "
870 "%p size 0x%llx\n", from,
871 (unsigned long long) size);
874 iov_iter_init(&f, READ, vq->iotlb_iov, ret, size);
875 ret = copy_from_iter(to, size, &f);
884 static void __user *__vhost_get_user_slow(struct vhost_virtqueue *vq,
885 void __user *addr, unsigned int size,
890 ret = translate_desc(vq, (u64)(uintptr_t)addr, size, vq->iotlb_iov,
891 ARRAY_SIZE(vq->iotlb_iov),
894 vq_err(vq, "IOTLB translation failure: uaddr "
895 "%p size 0x%llx\n", addr,
896 (unsigned long long) size);
900 if (ret != 1 || vq->iotlb_iov[0].iov_len != size) {
901 vq_err(vq, "Non atomic userspace memory access: uaddr "
902 "%p size 0x%llx\n", addr,
903 (unsigned long long) size);
907 return vq->iotlb_iov[0].iov_base;
910 /* This function should be called after iotlb
911 * prefetch, which means we're sure that vq
912 * could be access through iotlb. So -EAGAIN should
913 * not happen in this case.
915 static inline void __user *__vhost_get_user(struct vhost_virtqueue *vq,
916 void __user *addr, unsigned int size,
919 void __user *uaddr = vhost_vq_meta_fetch(vq,
920 (u64)(uintptr_t)addr, size, type);
924 return __vhost_get_user_slow(vq, addr, size, type);
927 #define vhost_put_user(vq, x, ptr) \
931 ret = __put_user(x, ptr); \
933 __typeof__(ptr) to = \
934 (__typeof__(ptr)) __vhost_get_user(vq, ptr, \
935 sizeof(*ptr), VHOST_ADDR_USED); \
937 ret = __put_user(x, to); \
944 static inline int vhost_put_avail_event(struct vhost_virtqueue *vq)
946 return vhost_put_user(vq, cpu_to_vhost16(vq, vq->avail_idx),
947 vhost_avail_event(vq));
950 static inline int vhost_put_used(struct vhost_virtqueue *vq,
951 struct vring_used_elem *head, int idx,
954 return vhost_copy_to_user(vq, vq->used->ring + idx, head,
955 count * sizeof(*head));
958 static inline int vhost_put_used_flags(struct vhost_virtqueue *vq)
961 return vhost_put_user(vq, cpu_to_vhost16(vq, vq->used_flags),
965 static inline int vhost_put_used_idx(struct vhost_virtqueue *vq)
968 return vhost_put_user(vq, cpu_to_vhost16(vq, vq->last_used_idx),
972 #define vhost_get_user(vq, x, ptr, type) \
976 ret = __get_user(x, ptr); \
978 __typeof__(ptr) from = \
979 (__typeof__(ptr)) __vhost_get_user(vq, ptr, \
983 ret = __get_user(x, from); \
990 #define vhost_get_avail(vq, x, ptr) \
991 vhost_get_user(vq, x, ptr, VHOST_ADDR_AVAIL)
993 #define vhost_get_used(vq, x, ptr) \
994 vhost_get_user(vq, x, ptr, VHOST_ADDR_USED)
996 static void vhost_dev_lock_vqs(struct vhost_dev *d)
999 for (i = 0; i < d->nvqs; ++i)
1000 mutex_lock_nested(&d->vqs[i]->mutex, i);
1003 static void vhost_dev_unlock_vqs(struct vhost_dev *d)
1006 for (i = 0; i < d->nvqs; ++i)
1007 mutex_unlock(&d->vqs[i]->mutex);
1010 static inline int vhost_get_avail_idx(struct vhost_virtqueue *vq,
1013 return vhost_get_avail(vq, *idx, &vq->avail->idx);
1016 static inline int vhost_get_avail_head(struct vhost_virtqueue *vq,
1017 __virtio16 *head, int idx)
1019 return vhost_get_avail(vq, *head,
1020 &vq->avail->ring[idx & (vq->num - 1)]);
1023 static inline int vhost_get_avail_flags(struct vhost_virtqueue *vq,
1026 return vhost_get_avail(vq, *flags, &vq->avail->flags);
1029 static inline int vhost_get_used_event(struct vhost_virtqueue *vq,
1032 return vhost_get_avail(vq, *event, vhost_used_event(vq));
1035 static inline int vhost_get_used_idx(struct vhost_virtqueue *vq,
1038 return vhost_get_used(vq, *idx, &vq->used->idx);
1041 static inline int vhost_get_desc(struct vhost_virtqueue *vq,
1042 struct vring_desc *desc, int idx)
1044 return vhost_copy_from_user(vq, desc, vq->desc + idx, sizeof(*desc));
1047 static void vhost_iotlb_notify_vq(struct vhost_dev *d,
1048 struct vhost_iotlb_msg *msg)
1050 struct vhost_msg_node *node, *n;
1052 spin_lock(&d->iotlb_lock);
1054 list_for_each_entry_safe(node, n, &d->pending_list, node) {
1055 struct vhost_iotlb_msg *vq_msg = &node->msg.iotlb;
1056 if (msg->iova <= vq_msg->iova &&
1057 msg->iova + msg->size - 1 >= vq_msg->iova &&
1058 vq_msg->type == VHOST_IOTLB_MISS) {
1059 vhost_poll_queue(&node->vq->poll);
1060 list_del(&node->node);
1065 spin_unlock(&d->iotlb_lock);
1068 static bool umem_access_ok(u64 uaddr, u64 size, int access)
1070 unsigned long a = uaddr;
1072 /* Make sure 64 bit math will not overflow. */
1073 if (vhost_overflow(uaddr, size))
1076 if ((access & VHOST_ACCESS_RO) &&
1077 !access_ok((void __user *)a, size))
1079 if ((access & VHOST_ACCESS_WO) &&
1080 !access_ok((void __user *)a, size))
1085 static int vhost_process_iotlb_msg(struct vhost_dev *dev, u32 asid,
1086 struct vhost_iotlb_msg *msg)
1093 mutex_lock(&dev->mutex);
1094 vhost_dev_lock_vqs(dev);
1095 switch (msg->type) {
1096 case VHOST_IOTLB_UPDATE:
1101 if (!umem_access_ok(msg->uaddr, msg->size, msg->perm)) {
1105 vhost_vq_meta_reset(dev);
1106 if (vhost_iotlb_add_range(dev->iotlb, msg->iova,
1107 msg->iova + msg->size - 1,
1108 msg->uaddr, msg->perm)) {
1112 vhost_iotlb_notify_vq(dev, msg);
1114 case VHOST_IOTLB_INVALIDATE:
1119 vhost_vq_meta_reset(dev);
1120 vhost_iotlb_del_range(dev->iotlb, msg->iova,
1121 msg->iova + msg->size - 1);
1128 vhost_dev_unlock_vqs(dev);
1129 mutex_unlock(&dev->mutex);
1133 ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
1134 struct iov_iter *from)
1136 struct vhost_iotlb_msg msg;
1141 ret = copy_from_iter(&type, sizeof(type), from);
1142 if (ret != sizeof(type)) {
1148 case VHOST_IOTLB_MSG:
1149 /* There maybe a hole after type for V1 message type,
1152 offset = offsetof(struct vhost_msg, iotlb) - sizeof(int);
1154 case VHOST_IOTLB_MSG_V2:
1155 if (vhost_backend_has_feature(dev->vqs[0],
1156 VHOST_BACKEND_F_IOTLB_ASID)) {
1157 ret = copy_from_iter(&asid, sizeof(asid), from);
1158 if (ret != sizeof(asid)) {
1164 offset = sizeof(__u32);
1171 iov_iter_advance(from, offset);
1172 ret = copy_from_iter(&msg, sizeof(msg), from);
1173 if (ret != sizeof(msg)) {
1178 if ((msg.type == VHOST_IOTLB_UPDATE ||
1179 msg.type == VHOST_IOTLB_INVALIDATE) &&
1185 if (dev->msg_handler)
1186 ret = dev->msg_handler(dev, asid, &msg);
1188 ret = vhost_process_iotlb_msg(dev, asid, &msg);
1194 ret = (type == VHOST_IOTLB_MSG) ? sizeof(struct vhost_msg) :
1195 sizeof(struct vhost_msg_v2);
1199 EXPORT_SYMBOL(vhost_chr_write_iter);
1201 __poll_t vhost_chr_poll(struct file *file, struct vhost_dev *dev,
1206 poll_wait(file, &dev->wait, wait);
1208 if (!list_empty(&dev->read_list))
1209 mask |= EPOLLIN | EPOLLRDNORM;
1213 EXPORT_SYMBOL(vhost_chr_poll);
1215 ssize_t vhost_chr_read_iter(struct vhost_dev *dev, struct iov_iter *to,
1219 struct vhost_msg_node *node;
1221 unsigned size = sizeof(struct vhost_msg);
1223 if (iov_iter_count(to) < size)
1228 prepare_to_wait(&dev->wait, &wait,
1229 TASK_INTERRUPTIBLE);
1231 node = vhost_dequeue_msg(dev, &dev->read_list);
1238 if (signal_pending(current)) {
1251 finish_wait(&dev->wait, &wait);
1254 struct vhost_iotlb_msg *msg;
1255 void *start = &node->msg;
1257 switch (node->msg.type) {
1258 case VHOST_IOTLB_MSG:
1259 size = sizeof(node->msg);
1260 msg = &node->msg.iotlb;
1262 case VHOST_IOTLB_MSG_V2:
1263 size = sizeof(node->msg_v2);
1264 msg = &node->msg_v2.iotlb;
1271 ret = copy_to_iter(start, size, to);
1272 if (ret != size || msg->type != VHOST_IOTLB_MISS) {
1276 vhost_enqueue_msg(dev, &dev->pending_list, node);
1281 EXPORT_SYMBOL_GPL(vhost_chr_read_iter);
1283 static int vhost_iotlb_miss(struct vhost_virtqueue *vq, u64 iova, int access)
1285 struct vhost_dev *dev = vq->dev;
1286 struct vhost_msg_node *node;
1287 struct vhost_iotlb_msg *msg;
1288 bool v2 = vhost_backend_has_feature(vq, VHOST_BACKEND_F_IOTLB_MSG_V2);
1290 node = vhost_new_msg(vq, v2 ? VHOST_IOTLB_MSG_V2 : VHOST_IOTLB_MSG);
1295 node->msg_v2.type = VHOST_IOTLB_MSG_V2;
1296 msg = &node->msg_v2.iotlb;
1298 msg = &node->msg.iotlb;
1301 msg->type = VHOST_IOTLB_MISS;
1305 vhost_enqueue_msg(dev, &dev->read_list, node);
1310 static bool vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
1311 vring_desc_t __user *desc,
1312 vring_avail_t __user *avail,
1313 vring_used_t __user *used)
1316 /* If an IOTLB device is present, the vring addresses are
1317 * GIOVAs. Access validation occurs at prefetch time. */
1321 return access_ok(desc, vhost_get_desc_size(vq, num)) &&
1322 access_ok(avail, vhost_get_avail_size(vq, num)) &&
1323 access_ok(used, vhost_get_used_size(vq, num));
1326 static void vhost_vq_meta_update(struct vhost_virtqueue *vq,
1327 const struct vhost_iotlb_map *map,
1330 int access = (type == VHOST_ADDR_USED) ?
1331 VHOST_ACCESS_WO : VHOST_ACCESS_RO;
1333 if (likely(map->perm & access))
1334 vq->meta_iotlb[type] = map;
1337 static bool iotlb_access_ok(struct vhost_virtqueue *vq,
1338 int access, u64 addr, u64 len, int type)
1340 const struct vhost_iotlb_map *map;
1341 struct vhost_iotlb *umem = vq->iotlb;
1342 u64 s = 0, size, orig_addr = addr, last = addr + len - 1;
1344 if (vhost_vq_meta_fetch(vq, addr, len, type))
1348 map = vhost_iotlb_itree_first(umem, addr, last);
1349 if (map == NULL || map->start > addr) {
1350 vhost_iotlb_miss(vq, addr, access);
1352 } else if (!(map->perm & access)) {
1353 /* Report the possible access violation by
1354 * request another translation from userspace.
1359 size = map->size - addr + map->start;
1361 if (orig_addr == addr && size >= len)
1362 vhost_vq_meta_update(vq, map, type);
1371 int vq_meta_prefetch(struct vhost_virtqueue *vq)
1373 unsigned int num = vq->num;
1378 return iotlb_access_ok(vq, VHOST_MAP_RO, (u64)(uintptr_t)vq->desc,
1379 vhost_get_desc_size(vq, num), VHOST_ADDR_DESC) &&
1380 iotlb_access_ok(vq, VHOST_MAP_RO, (u64)(uintptr_t)vq->avail,
1381 vhost_get_avail_size(vq, num),
1382 VHOST_ADDR_AVAIL) &&
1383 iotlb_access_ok(vq, VHOST_MAP_WO, (u64)(uintptr_t)vq->used,
1384 vhost_get_used_size(vq, num), VHOST_ADDR_USED);
1386 EXPORT_SYMBOL_GPL(vq_meta_prefetch);
1388 /* Can we log writes? */
1389 /* Caller should have device mutex but not vq mutex */
1390 bool vhost_log_access_ok(struct vhost_dev *dev)
1392 return memory_access_ok(dev, dev->umem, 1);
1394 EXPORT_SYMBOL_GPL(vhost_log_access_ok);
1396 static bool vq_log_used_access_ok(struct vhost_virtqueue *vq,
1397 void __user *log_base,
1401 /* If an IOTLB device is present, log_addr is a GIOVA that
1402 * will never be logged by log_used(). */
1406 return !log_used || log_access_ok(log_base, log_addr,
1407 vhost_get_used_size(vq, vq->num));
1410 /* Verify access for write logging. */
1411 /* Caller should have vq mutex and device mutex */
1412 static bool vq_log_access_ok(struct vhost_virtqueue *vq,
1413 void __user *log_base)
1415 return vq_memory_access_ok(log_base, vq->umem,
1416 vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
1417 vq_log_used_access_ok(vq, log_base, vq->log_used, vq->log_addr);
1420 /* Can we start vq? */
1421 /* Caller should have vq mutex and device mutex */
1422 bool vhost_vq_access_ok(struct vhost_virtqueue *vq)
1424 if (!vq_log_access_ok(vq, vq->log_base))
1427 return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used);
1429 EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
1431 static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
1433 struct vhost_memory mem, *newmem;
1434 struct vhost_memory_region *region;
1435 struct vhost_iotlb *newumem, *oldumem;
1436 unsigned long size = offsetof(struct vhost_memory, regions);
1439 if (copy_from_user(&mem, m, size))
1443 if (mem.nregions > max_mem_regions)
1445 newmem = kvzalloc(struct_size(newmem, regions, mem.nregions),
1450 memcpy(newmem, &mem, size);
1451 if (copy_from_user(newmem->regions, m->regions,
1452 flex_array_size(newmem, regions, mem.nregions))) {
1457 newumem = iotlb_alloc();
1463 for (region = newmem->regions;
1464 region < newmem->regions + mem.nregions;
1466 if (vhost_iotlb_add_range(newumem,
1467 region->guest_phys_addr,
1468 region->guest_phys_addr +
1469 region->memory_size - 1,
1470 region->userspace_addr,
1475 if (!memory_access_ok(d, newumem, 0))
1481 /* All memory accesses are done under some VQ mutex. */
1482 for (i = 0; i < d->nvqs; ++i) {
1483 mutex_lock(&d->vqs[i]->mutex);
1484 d->vqs[i]->umem = newumem;
1485 mutex_unlock(&d->vqs[i]->mutex);
1489 vhost_iotlb_free(oldumem);
1493 vhost_iotlb_free(newumem);
1498 static long vhost_vring_set_num(struct vhost_dev *d,
1499 struct vhost_virtqueue *vq,
1502 struct vhost_vring_state s;
1504 /* Resizing ring with an active backend?
1505 * You don't want to do that. */
1506 if (vq->private_data)
1509 if (copy_from_user(&s, argp, sizeof s))
1512 if (!s.num || s.num > 0xffff || (s.num & (s.num - 1)))
1519 static long vhost_vring_set_addr(struct vhost_dev *d,
1520 struct vhost_virtqueue *vq,
1523 struct vhost_vring_addr a;
1525 if (copy_from_user(&a, argp, sizeof a))
1527 if (a.flags & ~(0x1 << VHOST_VRING_F_LOG))
1530 /* For 32bit, verify that the top 32bits of the user
1531 data are set to zero. */
1532 if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
1533 (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
1534 (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr)
1537 /* Make sure it's safe to cast pointers to vring types. */
1538 BUILD_BUG_ON(__alignof__ *vq->avail > VRING_AVAIL_ALIGN_SIZE);
1539 BUILD_BUG_ON(__alignof__ *vq->used > VRING_USED_ALIGN_SIZE);
1540 if ((a.avail_user_addr & (VRING_AVAIL_ALIGN_SIZE - 1)) ||
1541 (a.used_user_addr & (VRING_USED_ALIGN_SIZE - 1)) ||
1542 (a.log_guest_addr & (VRING_USED_ALIGN_SIZE - 1)))
1545 /* We only verify access here if backend is configured.
1546 * If it is not, we don't as size might not have been setup.
1547 * We will verify when backend is configured. */
1548 if (vq->private_data) {
1549 if (!vq_access_ok(vq, vq->num,
1550 (void __user *)(unsigned long)a.desc_user_addr,
1551 (void __user *)(unsigned long)a.avail_user_addr,
1552 (void __user *)(unsigned long)a.used_user_addr))
1555 /* Also validate log access for used ring if enabled. */
1556 if (!vq_log_used_access_ok(vq, vq->log_base,
1557 a.flags & (0x1 << VHOST_VRING_F_LOG),
1562 vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
1563 vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
1564 vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
1565 vq->log_addr = a.log_guest_addr;
1566 vq->used = (void __user *)(unsigned long)a.used_user_addr;
1571 static long vhost_vring_set_num_addr(struct vhost_dev *d,
1572 struct vhost_virtqueue *vq,
1578 mutex_lock(&vq->mutex);
1581 case VHOST_SET_VRING_NUM:
1582 r = vhost_vring_set_num(d, vq, argp);
1584 case VHOST_SET_VRING_ADDR:
1585 r = vhost_vring_set_addr(d, vq, argp);
1591 mutex_unlock(&vq->mutex);
1595 long vhost_vring_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1597 struct file *eventfp, *filep = NULL;
1598 bool pollstart = false, pollstop = false;
1599 struct eventfd_ctx *ctx = NULL;
1600 u32 __user *idxp = argp;
1601 struct vhost_virtqueue *vq;
1602 struct vhost_vring_state s;
1603 struct vhost_vring_file f;
1607 r = get_user(idx, idxp);
1613 idx = array_index_nospec(idx, d->nvqs);
1616 if (ioctl == VHOST_SET_VRING_NUM ||
1617 ioctl == VHOST_SET_VRING_ADDR) {
1618 return vhost_vring_set_num_addr(d, vq, ioctl, argp);
1621 mutex_lock(&vq->mutex);
1624 case VHOST_SET_VRING_BASE:
1625 /* Moving base with an active backend?
1626 * You don't want to do that. */
1627 if (vq->private_data) {
1631 if (copy_from_user(&s, argp, sizeof s)) {
1635 if (s.num > 0xffff) {
1639 vq->last_avail_idx = s.num;
1640 /* Forget the cached index value. */
1641 vq->avail_idx = vq->last_avail_idx;
1643 case VHOST_GET_VRING_BASE:
1645 s.num = vq->last_avail_idx;
1646 if (copy_to_user(argp, &s, sizeof s))
1649 case VHOST_SET_VRING_KICK:
1650 if (copy_from_user(&f, argp, sizeof f)) {
1654 eventfp = f.fd == VHOST_FILE_UNBIND ? NULL : eventfd_fget(f.fd);
1655 if (IS_ERR(eventfp)) {
1656 r = PTR_ERR(eventfp);
1659 if (eventfp != vq->kick) {
1660 pollstop = (filep = vq->kick) != NULL;
1661 pollstart = (vq->kick = eventfp) != NULL;
1665 case VHOST_SET_VRING_CALL:
1666 if (copy_from_user(&f, argp, sizeof f)) {
1670 ctx = f.fd == VHOST_FILE_UNBIND ? NULL : eventfd_ctx_fdget(f.fd);
1676 swap(ctx, vq->call_ctx.ctx);
1678 case VHOST_SET_VRING_ERR:
1679 if (copy_from_user(&f, argp, sizeof f)) {
1683 ctx = f.fd == VHOST_FILE_UNBIND ? NULL : eventfd_ctx_fdget(f.fd);
1688 swap(ctx, vq->error_ctx);
1690 case VHOST_SET_VRING_ENDIAN:
1691 r = vhost_set_vring_endian(vq, argp);
1693 case VHOST_GET_VRING_ENDIAN:
1694 r = vhost_get_vring_endian(vq, idx, argp);
1696 case VHOST_SET_VRING_BUSYLOOP_TIMEOUT:
1697 if (copy_from_user(&s, argp, sizeof(s))) {
1701 vq->busyloop_timeout = s.num;
1703 case VHOST_GET_VRING_BUSYLOOP_TIMEOUT:
1705 s.num = vq->busyloop_timeout;
1706 if (copy_to_user(argp, &s, sizeof(s)))
1713 if (pollstop && vq->handle_kick)
1714 vhost_poll_stop(&vq->poll);
1716 if (!IS_ERR_OR_NULL(ctx))
1717 eventfd_ctx_put(ctx);
1721 if (pollstart && vq->handle_kick)
1722 r = vhost_poll_start(&vq->poll, vq->kick);
1724 mutex_unlock(&vq->mutex);
1726 if (pollstop && vq->handle_kick)
1727 vhost_dev_flush(vq->poll.dev);
1730 EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
1732 int vhost_init_device_iotlb(struct vhost_dev *d, bool enabled)
1734 struct vhost_iotlb *niotlb, *oiotlb;
1737 niotlb = iotlb_alloc();
1744 for (i = 0; i < d->nvqs; ++i) {
1745 struct vhost_virtqueue *vq = d->vqs[i];
1747 mutex_lock(&vq->mutex);
1749 __vhost_vq_meta_reset(vq);
1750 mutex_unlock(&vq->mutex);
1753 vhost_iotlb_free(oiotlb);
1757 EXPORT_SYMBOL_GPL(vhost_init_device_iotlb);
1759 /* Caller must have device mutex */
1760 long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1762 struct eventfd_ctx *ctx;
1767 /* If you are not the owner, you can become one */
1768 if (ioctl == VHOST_SET_OWNER) {
1769 r = vhost_dev_set_owner(d);
1773 /* You must be the owner to do anything else */
1774 r = vhost_dev_check_owner(d);
1779 case VHOST_SET_MEM_TABLE:
1780 r = vhost_set_memory(d, argp);
1782 case VHOST_SET_LOG_BASE:
1783 if (copy_from_user(&p, argp, sizeof p)) {
1787 if ((u64)(unsigned long)p != p) {
1791 for (i = 0; i < d->nvqs; ++i) {
1792 struct vhost_virtqueue *vq;
1793 void __user *base = (void __user *)(unsigned long)p;
1795 mutex_lock(&vq->mutex);
1796 /* If ring is inactive, will check when it's enabled. */
1797 if (vq->private_data && !vq_log_access_ok(vq, base))
1800 vq->log_base = base;
1801 mutex_unlock(&vq->mutex);
1804 case VHOST_SET_LOG_FD:
1805 r = get_user(fd, (int __user *)argp);
1808 ctx = fd == VHOST_FILE_UNBIND ? NULL : eventfd_ctx_fdget(fd);
1813 swap(ctx, d->log_ctx);
1814 for (i = 0; i < d->nvqs; ++i) {
1815 mutex_lock(&d->vqs[i]->mutex);
1816 d->vqs[i]->log_ctx = d->log_ctx;
1817 mutex_unlock(&d->vqs[i]->mutex);
1820 eventfd_ctx_put(ctx);
1829 EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
1831 /* TODO: This is really inefficient. We need something like get_user()
1832 * (instruction directly accesses the data, with an exception table entry
1833 * returning -EFAULT). See Documentation/x86/exception-tables.rst.
1835 static int set_bit_to_user(int nr, void __user *addr)
1837 unsigned long log = (unsigned long)addr;
1840 int bit = nr + (log % PAGE_SIZE) * 8;
1843 r = pin_user_pages_fast(log, 1, FOLL_WRITE, &page);
1847 base = kmap_atomic(page);
1849 kunmap_atomic(base);
1850 unpin_user_pages_dirty_lock(&page, 1, true);
1854 static int log_write(void __user *log_base,
1855 u64 write_address, u64 write_length)
1857 u64 write_page = write_address / VHOST_PAGE_SIZE;
1862 write_length += write_address % VHOST_PAGE_SIZE;
1864 u64 base = (u64)(unsigned long)log_base;
1865 u64 log = base + write_page / 8;
1866 int bit = write_page % 8;
1867 if ((u64)(unsigned long)log != log)
1869 r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
1872 if (write_length <= VHOST_PAGE_SIZE)
1874 write_length -= VHOST_PAGE_SIZE;
1880 static int log_write_hva(struct vhost_virtqueue *vq, u64 hva, u64 len)
1882 struct vhost_iotlb *umem = vq->umem;
1883 struct vhost_iotlb_map *u;
1884 u64 start, end, l, min;
1890 /* More than one GPAs can be mapped into a single HVA. So
1891 * iterate all possible umems here to be safe.
1893 list_for_each_entry(u, &umem->list, link) {
1894 if (u->addr > hva - 1 + len ||
1895 u->addr - 1 + u->size < hva)
1897 start = max(u->addr, hva);
1898 end = min(u->addr - 1 + u->size, hva - 1 + len);
1899 l = end - start + 1;
1900 r = log_write(vq->log_base,
1901 u->start + start - u->addr,
1919 static int log_used(struct vhost_virtqueue *vq, u64 used_offset, u64 len)
1921 struct iovec *iov = vq->log_iov;
1925 return log_write(vq->log_base, vq->log_addr + used_offset, len);
1927 ret = translate_desc(vq, (uintptr_t)vq->used + used_offset,
1928 len, iov, 64, VHOST_ACCESS_WO);
1932 for (i = 0; i < ret; i++) {
1933 ret = log_write_hva(vq, (uintptr_t)iov[i].iov_base,
1942 int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
1943 unsigned int log_num, u64 len, struct iovec *iov, int count)
1947 /* Make sure data written is seen before log. */
1951 for (i = 0; i < count; i++) {
1952 r = log_write_hva(vq, (uintptr_t)iov[i].iov_base,
1960 for (i = 0; i < log_num; ++i) {
1961 u64 l = min(log[i].len, len);
1962 r = log_write(vq->log_base, log[i].addr, l);
1968 eventfd_signal(vq->log_ctx, 1);
1972 /* Length written exceeds what we have stored. This is a bug. */
1976 EXPORT_SYMBOL_GPL(vhost_log_write);
1978 static int vhost_update_used_flags(struct vhost_virtqueue *vq)
1981 if (vhost_put_used_flags(vq))
1983 if (unlikely(vq->log_used)) {
1984 /* Make sure the flag is seen before log. */
1986 /* Log used flag write. */
1987 used = &vq->used->flags;
1988 log_used(vq, (used - (void __user *)vq->used),
1989 sizeof vq->used->flags);
1991 eventfd_signal(vq->log_ctx, 1);
1996 static int vhost_update_avail_event(struct vhost_virtqueue *vq)
1998 if (vhost_put_avail_event(vq))
2000 if (unlikely(vq->log_used)) {
2002 /* Make sure the event is seen before log. */
2004 /* Log avail event write */
2005 used = vhost_avail_event(vq);
2006 log_used(vq, (used - (void __user *)vq->used),
2007 sizeof *vhost_avail_event(vq));
2009 eventfd_signal(vq->log_ctx, 1);
2014 int vhost_vq_init_access(struct vhost_virtqueue *vq)
2016 __virtio16 last_used_idx;
2018 bool is_le = vq->is_le;
2020 if (!vq->private_data)
2023 vhost_init_is_le(vq);
2025 r = vhost_update_used_flags(vq);
2028 vq->signalled_used_valid = false;
2030 !access_ok(&vq->used->idx, sizeof vq->used->idx)) {
2034 r = vhost_get_used_idx(vq, &last_used_idx);
2036 vq_err(vq, "Can't access used idx at %p\n",
2040 vq->last_used_idx = vhost16_to_cpu(vq, last_used_idx);
2047 EXPORT_SYMBOL_GPL(vhost_vq_init_access);
2049 static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
2050 struct iovec iov[], int iov_size, int access)
2052 const struct vhost_iotlb_map *map;
2053 struct vhost_dev *dev = vq->dev;
2054 struct vhost_iotlb *umem = dev->iotlb ? dev->iotlb : dev->umem;
2059 while ((u64)len > s) {
2061 if (unlikely(ret >= iov_size)) {
2066 map = vhost_iotlb_itree_first(umem, addr, addr + len - 1);
2067 if (map == NULL || map->start > addr) {
2068 if (umem != dev->iotlb) {
2074 } else if (!(map->perm & access)) {
2080 size = map->size - addr + map->start;
2081 _iov->iov_len = min((u64)len - s, size);
2082 _iov->iov_base = (void __user *)(unsigned long)
2083 (map->addr + addr - map->start);
2090 vhost_iotlb_miss(vq, addr, access);
2094 /* Each buffer in the virtqueues is actually a chain of descriptors. This
2095 * function returns the next descriptor in the chain,
2096 * or -1U if we're at the end. */
2097 static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
2101 /* If this descriptor says it doesn't chain, we're done. */
2102 if (!(desc->flags & cpu_to_vhost16(vq, VRING_DESC_F_NEXT)))
2105 /* Check they're not leading us off end of descriptors. */
2106 next = vhost16_to_cpu(vq, READ_ONCE(desc->next));
2110 static int get_indirect(struct vhost_virtqueue *vq,
2111 struct iovec iov[], unsigned int iov_size,
2112 unsigned int *out_num, unsigned int *in_num,
2113 struct vhost_log *log, unsigned int *log_num,
2114 struct vring_desc *indirect)
2116 struct vring_desc desc;
2117 unsigned int i = 0, count, found = 0;
2118 u32 len = vhost32_to_cpu(vq, indirect->len);
2119 struct iov_iter from;
2123 if (unlikely(len % sizeof desc)) {
2124 vq_err(vq, "Invalid length in indirect descriptor: "
2125 "len 0x%llx not multiple of 0x%zx\n",
2126 (unsigned long long)len,
2131 ret = translate_desc(vq, vhost64_to_cpu(vq, indirect->addr), len, vq->indirect,
2132 UIO_MAXIOV, VHOST_ACCESS_RO);
2133 if (unlikely(ret < 0)) {
2135 vq_err(vq, "Translation failure %d in indirect.\n", ret);
2138 iov_iter_init(&from, READ, vq->indirect, ret, len);
2139 count = len / sizeof desc;
2140 /* Buffers are chained via a 16 bit next field, so
2141 * we can have at most 2^16 of these. */
2142 if (unlikely(count > USHRT_MAX + 1)) {
2143 vq_err(vq, "Indirect buffer length too big: %d\n",
2149 unsigned iov_count = *in_num + *out_num;
2150 if (unlikely(++found > count)) {
2151 vq_err(vq, "Loop detected: last one at %u "
2152 "indirect size %u\n",
2156 if (unlikely(!copy_from_iter_full(&desc, sizeof(desc), &from))) {
2157 vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
2158 i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
2161 if (unlikely(desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT))) {
2162 vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
2163 i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
2167 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
2168 access = VHOST_ACCESS_WO;
2170 access = VHOST_ACCESS_RO;
2172 ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
2173 vhost32_to_cpu(vq, desc.len), iov + iov_count,
2174 iov_size - iov_count, access);
2175 if (unlikely(ret < 0)) {
2177 vq_err(vq, "Translation failure %d indirect idx %d\n",
2181 /* If this is an input descriptor, increment that count. */
2182 if (access == VHOST_ACCESS_WO) {
2184 if (unlikely(log && ret)) {
2185 log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
2186 log[*log_num].len = vhost32_to_cpu(vq, desc.len);
2190 /* If it's an output descriptor, they're all supposed
2191 * to come before any input descriptors. */
2192 if (unlikely(*in_num)) {
2193 vq_err(vq, "Indirect descriptor "
2194 "has out after in: idx %d\n", i);
2199 } while ((i = next_desc(vq, &desc)) != -1);
2203 /* This looks in the virtqueue and for the first available buffer, and converts
2204 * it to an iovec for convenient access. Since descriptors consist of some
2205 * number of output then some number of input descriptors, it's actually two
2206 * iovecs, but we pack them into one and note how many of each there were.
2208 * This function returns the descriptor number found, or vq->num (which is
2209 * never a valid descriptor number) if none was found. A negative code is
2210 * returned on error. */
2211 int vhost_get_vq_desc(struct vhost_virtqueue *vq,
2212 struct iovec iov[], unsigned int iov_size,
2213 unsigned int *out_num, unsigned int *in_num,
2214 struct vhost_log *log, unsigned int *log_num)
2216 struct vring_desc desc;
2217 unsigned int i, head, found = 0;
2219 __virtio16 avail_idx;
2220 __virtio16 ring_head;
2223 /* Check it isn't doing very strange things with descriptor numbers. */
2224 last_avail_idx = vq->last_avail_idx;
2226 if (vq->avail_idx == vq->last_avail_idx) {
2227 if (unlikely(vhost_get_avail_idx(vq, &avail_idx))) {
2228 vq_err(vq, "Failed to access avail idx at %p\n",
2232 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2234 if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
2235 vq_err(vq, "Guest moved used index from %u to %u",
2236 last_avail_idx, vq->avail_idx);
2240 /* If there's nothing new since last we looked, return
2243 if (vq->avail_idx == last_avail_idx)
2246 /* Only get avail ring entries after they have been
2252 /* Grab the next descriptor number they're advertising, and increment
2253 * the index we've seen. */
2254 if (unlikely(vhost_get_avail_head(vq, &ring_head, last_avail_idx))) {
2255 vq_err(vq, "Failed to read head: idx %d address %p\n",
2257 &vq->avail->ring[last_avail_idx % vq->num]);
2261 head = vhost16_to_cpu(vq, ring_head);
2263 /* If their number is silly, that's an error. */
2264 if (unlikely(head >= vq->num)) {
2265 vq_err(vq, "Guest says index %u > %u is available",
2270 /* When we start there are none of either input nor output. */
2271 *out_num = *in_num = 0;
2277 unsigned iov_count = *in_num + *out_num;
2278 if (unlikely(i >= vq->num)) {
2279 vq_err(vq, "Desc index is %u > %u, head = %u",
2283 if (unlikely(++found > vq->num)) {
2284 vq_err(vq, "Loop detected: last one at %u "
2285 "vq size %u head %u\n",
2289 ret = vhost_get_desc(vq, &desc, i);
2290 if (unlikely(ret)) {
2291 vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
2295 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT)) {
2296 ret = get_indirect(vq, iov, iov_size,
2298 log, log_num, &desc);
2299 if (unlikely(ret < 0)) {
2301 vq_err(vq, "Failure detected "
2302 "in indirect descriptor at idx %d\n", i);
2308 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
2309 access = VHOST_ACCESS_WO;
2311 access = VHOST_ACCESS_RO;
2312 ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
2313 vhost32_to_cpu(vq, desc.len), iov + iov_count,
2314 iov_size - iov_count, access);
2315 if (unlikely(ret < 0)) {
2317 vq_err(vq, "Translation failure %d descriptor idx %d\n",
2321 if (access == VHOST_ACCESS_WO) {
2322 /* If this is an input descriptor,
2323 * increment that count. */
2325 if (unlikely(log && ret)) {
2326 log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
2327 log[*log_num].len = vhost32_to_cpu(vq, desc.len);
2331 /* If it's an output descriptor, they're all supposed
2332 * to come before any input descriptors. */
2333 if (unlikely(*in_num)) {
2334 vq_err(vq, "Descriptor has out after in: "
2340 } while ((i = next_desc(vq, &desc)) != -1);
2342 /* On success, increment avail index. */
2343 vq->last_avail_idx++;
2345 /* Assume notifications from guest are disabled at this point,
2346 * if they aren't we would need to update avail_event index. */
2347 BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
2350 EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
2352 /* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
2353 void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
2355 vq->last_avail_idx -= n;
2357 EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
2359 /* After we've used one of their buffers, we tell them about it. We'll then
2360 * want to notify the guest, using eventfd. */
2361 int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
2363 struct vring_used_elem heads = {
2364 cpu_to_vhost32(vq, head),
2365 cpu_to_vhost32(vq, len)
2368 return vhost_add_used_n(vq, &heads, 1);
2370 EXPORT_SYMBOL_GPL(vhost_add_used);
2372 static int __vhost_add_used_n(struct vhost_virtqueue *vq,
2373 struct vring_used_elem *heads,
2376 vring_used_elem_t __user *used;
2380 start = vq->last_used_idx & (vq->num - 1);
2381 used = vq->used->ring + start;
2382 if (vhost_put_used(vq, heads, start, count)) {
2383 vq_err(vq, "Failed to write used");
2386 if (unlikely(vq->log_used)) {
2387 /* Make sure data is seen before log. */
2389 /* Log used ring entry write. */
2390 log_used(vq, ((void __user *)used - (void __user *)vq->used),
2391 count * sizeof *used);
2393 old = vq->last_used_idx;
2394 new = (vq->last_used_idx += count);
2395 /* If the driver never bothers to signal in a very long while,
2396 * used index might wrap around. If that happens, invalidate
2397 * signalled_used index we stored. TODO: make sure driver
2398 * signals at least once in 2^16 and remove this. */
2399 if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
2400 vq->signalled_used_valid = false;
2404 /* After we've used one of their buffers, we tell them about it. We'll then
2405 * want to notify the guest, using eventfd. */
2406 int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
2411 start = vq->last_used_idx & (vq->num - 1);
2412 n = vq->num - start;
2414 r = __vhost_add_used_n(vq, heads, n);
2420 r = __vhost_add_used_n(vq, heads, count);
2422 /* Make sure buffer is written before we update index. */
2424 if (vhost_put_used_idx(vq)) {
2425 vq_err(vq, "Failed to increment used idx");
2428 if (unlikely(vq->log_used)) {
2429 /* Make sure used idx is seen before log. */
2431 /* Log used index update. */
2432 log_used(vq, offsetof(struct vring_used, idx),
2433 sizeof vq->used->idx);
2435 eventfd_signal(vq->log_ctx, 1);
2439 EXPORT_SYMBOL_GPL(vhost_add_used_n);
2441 static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2446 /* Flush out used index updates. This is paired
2447 * with the barrier that the Guest executes when enabling
2451 if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
2452 unlikely(vq->avail_idx == vq->last_avail_idx))
2455 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2457 if (vhost_get_avail_flags(vq, &flags)) {
2458 vq_err(vq, "Failed to get flags");
2461 return !(flags & cpu_to_vhost16(vq, VRING_AVAIL_F_NO_INTERRUPT));
2463 old = vq->signalled_used;
2464 v = vq->signalled_used_valid;
2465 new = vq->signalled_used = vq->last_used_idx;
2466 vq->signalled_used_valid = true;
2471 if (vhost_get_used_event(vq, &event)) {
2472 vq_err(vq, "Failed to get used event idx");
2475 return vring_need_event(vhost16_to_cpu(vq, event), new, old);
2478 /* This actually signals the guest, using eventfd. */
2479 void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2481 /* Signal the Guest tell them we used something up. */
2482 if (vq->call_ctx.ctx && vhost_notify(dev, vq))
2483 eventfd_signal(vq->call_ctx.ctx, 1);
2485 EXPORT_SYMBOL_GPL(vhost_signal);
2487 /* And here's the combo meal deal. Supersize me! */
2488 void vhost_add_used_and_signal(struct vhost_dev *dev,
2489 struct vhost_virtqueue *vq,
2490 unsigned int head, int len)
2492 vhost_add_used(vq, head, len);
2493 vhost_signal(dev, vq);
2495 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
2497 /* multi-buffer version of vhost_add_used_and_signal */
2498 void vhost_add_used_and_signal_n(struct vhost_dev *dev,
2499 struct vhost_virtqueue *vq,
2500 struct vring_used_elem *heads, unsigned count)
2502 vhost_add_used_n(vq, heads, count);
2503 vhost_signal(dev, vq);
2505 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
2507 /* return true if we're sure that avaiable ring is empty */
2508 bool vhost_vq_avail_empty(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2510 __virtio16 avail_idx;
2513 if (vq->avail_idx != vq->last_avail_idx)
2516 r = vhost_get_avail_idx(vq, &avail_idx);
2519 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2521 return vq->avail_idx == vq->last_avail_idx;
2523 EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);
2525 /* OK, now we need to know about added descriptors. */
2526 bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2528 __virtio16 avail_idx;
2531 if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
2533 vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
2534 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2535 r = vhost_update_used_flags(vq);
2537 vq_err(vq, "Failed to enable notification at %p: %d\n",
2538 &vq->used->flags, r);
2542 r = vhost_update_avail_event(vq);
2544 vq_err(vq, "Failed to update avail event index at %p: %d\n",
2545 vhost_avail_event(vq), r);
2549 /* They could have slipped one in as we were doing that: make
2550 * sure it's written, then check again. */
2552 r = vhost_get_avail_idx(vq, &avail_idx);
2554 vq_err(vq, "Failed to check avail idx at %p: %d\n",
2555 &vq->avail->idx, r);
2558 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2560 return vq->avail_idx != vq->last_avail_idx;
2562 EXPORT_SYMBOL_GPL(vhost_enable_notify);
2564 /* We don't need to be notified again. */
2565 void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2569 if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
2571 vq->used_flags |= VRING_USED_F_NO_NOTIFY;
2572 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2573 r = vhost_update_used_flags(vq);
2575 vq_err(vq, "Failed to disable notification at %p: %d\n",
2576 &vq->used->flags, r);
2579 EXPORT_SYMBOL_GPL(vhost_disable_notify);
2581 /* Create a new message. */
2582 struct vhost_msg_node *vhost_new_msg(struct vhost_virtqueue *vq, int type)
2584 struct vhost_msg_node *node = kmalloc(sizeof *node, GFP_KERNEL);
2588 /* Make sure all padding within the structure is initialized. */
2589 memset(&node->msg, 0, sizeof node->msg);
2591 node->msg.type = type;
2594 EXPORT_SYMBOL_GPL(vhost_new_msg);
2596 void vhost_enqueue_msg(struct vhost_dev *dev, struct list_head *head,
2597 struct vhost_msg_node *node)
2599 spin_lock(&dev->iotlb_lock);
2600 list_add_tail(&node->node, head);
2601 spin_unlock(&dev->iotlb_lock);
2603 wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
2605 EXPORT_SYMBOL_GPL(vhost_enqueue_msg);
2607 struct vhost_msg_node *vhost_dequeue_msg(struct vhost_dev *dev,
2608 struct list_head *head)
2610 struct vhost_msg_node *node = NULL;
2612 spin_lock(&dev->iotlb_lock);
2613 if (!list_empty(head)) {
2614 node = list_first_entry(head, struct vhost_msg_node,
2616 list_del(&node->node);
2618 spin_unlock(&dev->iotlb_lock);
2622 EXPORT_SYMBOL_GPL(vhost_dequeue_msg);
2624 void vhost_set_backend_features(struct vhost_dev *dev, u64 features)
2626 struct vhost_virtqueue *vq;
2629 mutex_lock(&dev->mutex);
2630 for (i = 0; i < dev->nvqs; ++i) {
2632 mutex_lock(&vq->mutex);
2633 vq->acked_backend_features = features;
2634 mutex_unlock(&vq->mutex);
2636 mutex_unlock(&dev->mutex);
2638 EXPORT_SYMBOL_GPL(vhost_set_backend_features);
2640 static int __init vhost_init(void)
2645 static void __exit vhost_exit(void)
2649 module_init(vhost_init);
2650 module_exit(vhost_exit);
2652 MODULE_VERSION("0.0.1");
2653 MODULE_LICENSE("GPL v2");
2654 MODULE_AUTHOR("Michael S. Tsirkin");
2655 MODULE_DESCRIPTION("Host kernel accelerator for virtio");