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_work_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_work_dev_flush);
248 /* Flush any work that has been scheduled. When calling this, don't hold any
249 * locks that are also used by the callback. */
250 void vhost_poll_flush(struct vhost_poll *poll)
252 vhost_work_dev_flush(poll->dev);
254 EXPORT_SYMBOL_GPL(vhost_poll_flush);
256 void vhost_work_queue(struct vhost_dev *dev, struct vhost_work *work)
261 if (!test_and_set_bit(VHOST_WORK_QUEUED, &work->flags)) {
262 /* We can only add the work to the list after we're
263 * sure it was not in the list.
264 * test_and_set_bit() implies a memory barrier.
266 llist_add(&work->node, &dev->work_list);
267 wake_up_process(dev->worker);
270 EXPORT_SYMBOL_GPL(vhost_work_queue);
272 /* A lockless hint for busy polling code to exit the loop */
273 bool vhost_has_work(struct vhost_dev *dev)
275 return !llist_empty(&dev->work_list);
277 EXPORT_SYMBOL_GPL(vhost_has_work);
279 void vhost_poll_queue(struct vhost_poll *poll)
281 vhost_work_queue(poll->dev, &poll->work);
283 EXPORT_SYMBOL_GPL(vhost_poll_queue);
285 static void __vhost_vq_meta_reset(struct vhost_virtqueue *vq)
289 for (j = 0; j < VHOST_NUM_ADDRS; j++)
290 vq->meta_iotlb[j] = NULL;
293 static void vhost_vq_meta_reset(struct vhost_dev *d)
297 for (i = 0; i < d->nvqs; ++i)
298 __vhost_vq_meta_reset(d->vqs[i]);
301 static void vhost_vring_call_reset(struct vhost_vring_call *call_ctx)
303 call_ctx->ctx = NULL;
304 memset(&call_ctx->producer, 0x0, sizeof(struct irq_bypass_producer));
307 bool vhost_vq_is_setup(struct vhost_virtqueue *vq)
309 return vq->avail && vq->desc && vq->used && vhost_vq_access_ok(vq);
311 EXPORT_SYMBOL_GPL(vhost_vq_is_setup);
313 static void vhost_vq_reset(struct vhost_dev *dev,
314 struct vhost_virtqueue *vq)
320 vq->last_avail_idx = 0;
322 vq->last_used_idx = 0;
323 vq->signalled_used = 0;
324 vq->signalled_used_valid = false;
326 vq->log_used = false;
327 vq->log_addr = -1ull;
328 vq->private_data = NULL;
329 vq->acked_features = 0;
330 vq->acked_backend_features = 0;
332 vq->error_ctx = NULL;
335 vhost_disable_cross_endian(vq);
336 vhost_reset_is_le(vq);
337 vq->busyloop_timeout = 0;
340 vhost_vring_call_reset(&vq->call_ctx);
341 __vhost_vq_meta_reset(vq);
344 static int vhost_worker(void *data)
346 struct vhost_dev *dev = data;
347 struct vhost_work *work, *work_next;
348 struct llist_node *node;
350 kthread_use_mm(dev->mm);
353 /* mb paired w/ kthread_stop */
354 set_current_state(TASK_INTERRUPTIBLE);
356 if (kthread_should_stop()) {
357 __set_current_state(TASK_RUNNING);
361 node = llist_del_all(&dev->work_list);
365 node = llist_reverse_order(node);
366 /* make sure flag is seen after deletion */
368 llist_for_each_entry_safe(work, work_next, node, node) {
369 clear_bit(VHOST_WORK_QUEUED, &work->flags);
370 __set_current_state(TASK_RUNNING);
371 kcov_remote_start_common(dev->kcov_handle);
378 kthread_unuse_mm(dev->mm);
382 static void vhost_vq_free_iovecs(struct vhost_virtqueue *vq)
392 /* Helper to allocate iovec buffers for all vqs. */
393 static long vhost_dev_alloc_iovecs(struct vhost_dev *dev)
395 struct vhost_virtqueue *vq;
398 for (i = 0; i < dev->nvqs; ++i) {
400 vq->indirect = kmalloc_array(UIO_MAXIOV,
401 sizeof(*vq->indirect),
403 vq->log = kmalloc_array(dev->iov_limit, sizeof(*vq->log),
405 vq->heads = kmalloc_array(dev->iov_limit, sizeof(*vq->heads),
407 if (!vq->indirect || !vq->log || !vq->heads)
414 vhost_vq_free_iovecs(dev->vqs[i]);
418 static void vhost_dev_free_iovecs(struct vhost_dev *dev)
422 for (i = 0; i < dev->nvqs; ++i)
423 vhost_vq_free_iovecs(dev->vqs[i]);
426 bool vhost_exceeds_weight(struct vhost_virtqueue *vq,
427 int pkts, int total_len)
429 struct vhost_dev *dev = vq->dev;
431 if ((dev->byte_weight && total_len >= dev->byte_weight) ||
432 pkts >= dev->weight) {
433 vhost_poll_queue(&vq->poll);
439 EXPORT_SYMBOL_GPL(vhost_exceeds_weight);
441 static size_t vhost_get_avail_size(struct vhost_virtqueue *vq,
444 size_t event __maybe_unused =
445 vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
447 return sizeof(*vq->avail) +
448 sizeof(*vq->avail->ring) * num + event;
451 static size_t vhost_get_used_size(struct vhost_virtqueue *vq,
454 size_t event __maybe_unused =
455 vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX) ? 2 : 0;
457 return sizeof(*vq->used) +
458 sizeof(*vq->used->ring) * num + event;
461 static size_t vhost_get_desc_size(struct vhost_virtqueue *vq,
464 return sizeof(*vq->desc) * num;
467 void vhost_dev_init(struct vhost_dev *dev,
468 struct vhost_virtqueue **vqs, int nvqs,
469 int iov_limit, int weight, int byte_weight,
471 int (*msg_handler)(struct vhost_dev *dev,
472 struct vhost_iotlb_msg *msg))
474 struct vhost_virtqueue *vq;
479 mutex_init(&dev->mutex);
485 dev->iov_limit = iov_limit;
486 dev->weight = weight;
487 dev->byte_weight = byte_weight;
488 dev->use_worker = use_worker;
489 dev->msg_handler = msg_handler;
490 init_llist_head(&dev->work_list);
491 init_waitqueue_head(&dev->wait);
492 INIT_LIST_HEAD(&dev->read_list);
493 INIT_LIST_HEAD(&dev->pending_list);
494 spin_lock_init(&dev->iotlb_lock);
497 for (i = 0; i < dev->nvqs; ++i) {
503 mutex_init(&vq->mutex);
504 vhost_vq_reset(dev, vq);
506 vhost_poll_init(&vq->poll, vq->handle_kick,
510 EXPORT_SYMBOL_GPL(vhost_dev_init);
512 /* Caller should have device mutex */
513 long vhost_dev_check_owner(struct vhost_dev *dev)
515 /* Are you the owner? If not, I don't think you mean to do that */
516 return dev->mm == current->mm ? 0 : -EPERM;
518 EXPORT_SYMBOL_GPL(vhost_dev_check_owner);
520 struct vhost_attach_cgroups_struct {
521 struct vhost_work work;
522 struct task_struct *owner;
526 static void vhost_attach_cgroups_work(struct vhost_work *work)
528 struct vhost_attach_cgroups_struct *s;
530 s = container_of(work, struct vhost_attach_cgroups_struct, work);
531 s->ret = cgroup_attach_task_all(s->owner, current);
534 static int vhost_attach_cgroups(struct vhost_dev *dev)
536 struct vhost_attach_cgroups_struct attach;
538 attach.owner = current;
539 vhost_work_init(&attach.work, vhost_attach_cgroups_work);
540 vhost_work_queue(dev, &attach.work);
541 vhost_work_dev_flush(dev);
545 /* Caller should have device mutex */
546 bool vhost_dev_has_owner(struct vhost_dev *dev)
550 EXPORT_SYMBOL_GPL(vhost_dev_has_owner);
552 static void vhost_attach_mm(struct vhost_dev *dev)
554 /* No owner, become one */
555 if (dev->use_worker) {
556 dev->mm = get_task_mm(current);
558 /* vDPA device does not use worker thead, so there's
559 * no need to hold the address space for mm. This help
560 * to avoid deadlock in the case of mmap() which may
561 * held the refcnt of the file and depends on release
562 * method to remove vma.
564 dev->mm = current->mm;
569 static void vhost_detach_mm(struct vhost_dev *dev)
582 /* Caller should have device mutex */
583 long vhost_dev_set_owner(struct vhost_dev *dev)
585 struct task_struct *worker;
588 /* Is there an owner already? */
589 if (vhost_dev_has_owner(dev)) {
594 vhost_attach_mm(dev);
596 dev->kcov_handle = kcov_common_handle();
597 if (dev->use_worker) {
598 worker = kthread_create(vhost_worker, dev,
599 "vhost-%d", current->pid);
600 if (IS_ERR(worker)) {
601 err = PTR_ERR(worker);
605 dev->worker = worker;
606 wake_up_process(worker); /* avoid contributing to loadavg */
608 err = vhost_attach_cgroups(dev);
613 err = vhost_dev_alloc_iovecs(dev);
620 kthread_stop(dev->worker);
624 vhost_detach_mm(dev);
625 dev->kcov_handle = 0;
629 EXPORT_SYMBOL_GPL(vhost_dev_set_owner);
631 static struct vhost_iotlb *iotlb_alloc(void)
633 return vhost_iotlb_alloc(max_iotlb_entries,
634 VHOST_IOTLB_FLAG_RETIRE);
637 struct vhost_iotlb *vhost_dev_reset_owner_prepare(void)
639 return iotlb_alloc();
641 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare);
643 /* Caller should have device mutex */
644 void vhost_dev_reset_owner(struct vhost_dev *dev, struct vhost_iotlb *umem)
648 vhost_dev_cleanup(dev);
651 /* We don't need VQ locks below since vhost_dev_cleanup makes sure
652 * VQs aren't running.
654 for (i = 0; i < dev->nvqs; ++i)
655 dev->vqs[i]->umem = umem;
657 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner);
659 void vhost_dev_stop(struct vhost_dev *dev)
663 for (i = 0; i < dev->nvqs; ++i) {
664 if (dev->vqs[i]->kick && dev->vqs[i]->handle_kick) {
665 vhost_poll_stop(&dev->vqs[i]->poll);
666 vhost_poll_flush(&dev->vqs[i]->poll);
670 EXPORT_SYMBOL_GPL(vhost_dev_stop);
672 static void vhost_clear_msg(struct vhost_dev *dev)
674 struct vhost_msg_node *node, *n;
676 spin_lock(&dev->iotlb_lock);
678 list_for_each_entry_safe(node, n, &dev->read_list, node) {
679 list_del(&node->node);
683 list_for_each_entry_safe(node, n, &dev->pending_list, node) {
684 list_del(&node->node);
688 spin_unlock(&dev->iotlb_lock);
691 void vhost_dev_cleanup(struct vhost_dev *dev)
695 for (i = 0; i < dev->nvqs; ++i) {
696 if (dev->vqs[i]->error_ctx)
697 eventfd_ctx_put(dev->vqs[i]->error_ctx);
698 if (dev->vqs[i]->kick)
699 fput(dev->vqs[i]->kick);
700 if (dev->vqs[i]->call_ctx.ctx)
701 eventfd_ctx_put(dev->vqs[i]->call_ctx.ctx);
702 vhost_vq_reset(dev, dev->vqs[i]);
704 vhost_dev_free_iovecs(dev);
706 eventfd_ctx_put(dev->log_ctx);
708 /* No one will access memory at this point */
709 vhost_iotlb_free(dev->umem);
711 vhost_iotlb_free(dev->iotlb);
713 vhost_clear_msg(dev);
714 wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
715 WARN_ON(!llist_empty(&dev->work_list));
717 kthread_stop(dev->worker);
719 dev->kcov_handle = 0;
721 vhost_detach_mm(dev);
723 EXPORT_SYMBOL_GPL(vhost_dev_cleanup);
725 static bool log_access_ok(void __user *log_base, u64 addr, unsigned long sz)
727 u64 a = addr / VHOST_PAGE_SIZE / 8;
729 /* Make sure 64 bit math will not overflow. */
730 if (a > ULONG_MAX - (unsigned long)log_base ||
731 a + (unsigned long)log_base > ULONG_MAX)
734 return access_ok(log_base + a,
735 (sz + VHOST_PAGE_SIZE * 8 - 1) / VHOST_PAGE_SIZE / 8);
738 /* Make sure 64 bit math will not overflow. */
739 static bool vhost_overflow(u64 uaddr, u64 size)
741 if (uaddr > ULONG_MAX || size > ULONG_MAX)
747 return uaddr > ULONG_MAX - size + 1;
750 /* Caller should have vq mutex and device mutex. */
751 static bool vq_memory_access_ok(void __user *log_base, struct vhost_iotlb *umem,
754 struct vhost_iotlb_map *map;
759 list_for_each_entry(map, &umem->list, link) {
760 unsigned long a = map->addr;
762 if (vhost_overflow(map->addr, map->size))
766 if (!access_ok((void __user *)a, map->size))
768 else if (log_all && !log_access_ok(log_base,
776 static inline void __user *vhost_vq_meta_fetch(struct vhost_virtqueue *vq,
777 u64 addr, unsigned int size,
780 const struct vhost_iotlb_map *map = vq->meta_iotlb[type];
785 return (void __user *)(uintptr_t)(map->addr + addr - map->start);
788 /* Can we switch to this memory table? */
789 /* Caller should have device mutex but not vq mutex */
790 static bool memory_access_ok(struct vhost_dev *d, struct vhost_iotlb *umem,
795 for (i = 0; i < d->nvqs; ++i) {
799 mutex_lock(&d->vqs[i]->mutex);
800 log = log_all || vhost_has_feature(d->vqs[i], VHOST_F_LOG_ALL);
801 /* If ring is inactive, will check when it's enabled. */
802 if (d->vqs[i]->private_data)
803 ok = vq_memory_access_ok(d->vqs[i]->log_base,
807 mutex_unlock(&d->vqs[i]->mutex);
814 static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
815 struct iovec iov[], int iov_size, int access);
817 static int vhost_copy_to_user(struct vhost_virtqueue *vq, void __user *to,
818 const void *from, unsigned size)
823 return __copy_to_user(to, from, size);
825 /* This function should be called after iotlb
826 * prefetch, which means we're sure that all vq
827 * could be access through iotlb. So -EAGAIN should
828 * not happen in this case.
831 void __user *uaddr = vhost_vq_meta_fetch(vq,
832 (u64)(uintptr_t)to, size,
836 return __copy_to_user(uaddr, from, size);
838 ret = translate_desc(vq, (u64)(uintptr_t)to, size, vq->iotlb_iov,
839 ARRAY_SIZE(vq->iotlb_iov),
843 iov_iter_init(&t, WRITE, vq->iotlb_iov, ret, size);
844 ret = copy_to_iter(from, size, &t);
852 static int vhost_copy_from_user(struct vhost_virtqueue *vq, void *to,
853 void __user *from, unsigned size)
858 return __copy_from_user(to, from, size);
860 /* This function should be called after iotlb
861 * prefetch, which means we're sure that vq
862 * could be access through iotlb. So -EAGAIN should
863 * not happen in this case.
865 void __user *uaddr = vhost_vq_meta_fetch(vq,
866 (u64)(uintptr_t)from, size,
871 return __copy_from_user(to, uaddr, size);
873 ret = translate_desc(vq, (u64)(uintptr_t)from, size, vq->iotlb_iov,
874 ARRAY_SIZE(vq->iotlb_iov),
877 vq_err(vq, "IOTLB translation failure: uaddr "
878 "%p size 0x%llx\n", from,
879 (unsigned long long) size);
882 iov_iter_init(&f, READ, vq->iotlb_iov, ret, size);
883 ret = copy_from_iter(to, size, &f);
892 static void __user *__vhost_get_user_slow(struct vhost_virtqueue *vq,
893 void __user *addr, unsigned int size,
898 ret = translate_desc(vq, (u64)(uintptr_t)addr, size, vq->iotlb_iov,
899 ARRAY_SIZE(vq->iotlb_iov),
902 vq_err(vq, "IOTLB translation failure: uaddr "
903 "%p size 0x%llx\n", addr,
904 (unsigned long long) size);
908 if (ret != 1 || vq->iotlb_iov[0].iov_len != size) {
909 vq_err(vq, "Non atomic userspace memory access: uaddr "
910 "%p size 0x%llx\n", addr,
911 (unsigned long long) size);
915 return vq->iotlb_iov[0].iov_base;
918 /* This function should be called after iotlb
919 * prefetch, which means we're sure that vq
920 * could be access through iotlb. So -EAGAIN should
921 * not happen in this case.
923 static inline void __user *__vhost_get_user(struct vhost_virtqueue *vq,
924 void __user *addr, unsigned int size,
927 void __user *uaddr = vhost_vq_meta_fetch(vq,
928 (u64)(uintptr_t)addr, size, type);
932 return __vhost_get_user_slow(vq, addr, size, type);
935 #define vhost_put_user(vq, x, ptr) \
939 ret = __put_user(x, ptr); \
941 __typeof__(ptr) to = \
942 (__typeof__(ptr)) __vhost_get_user(vq, ptr, \
943 sizeof(*ptr), VHOST_ADDR_USED); \
945 ret = __put_user(x, to); \
952 static inline int vhost_put_avail_event(struct vhost_virtqueue *vq)
954 return vhost_put_user(vq, cpu_to_vhost16(vq, vq->avail_idx),
955 vhost_avail_event(vq));
958 static inline int vhost_put_used(struct vhost_virtqueue *vq,
959 struct vring_used_elem *head, int idx,
962 return vhost_copy_to_user(vq, vq->used->ring + idx, head,
963 count * sizeof(*head));
966 static inline int vhost_put_used_flags(struct vhost_virtqueue *vq)
969 return vhost_put_user(vq, cpu_to_vhost16(vq, vq->used_flags),
973 static inline int vhost_put_used_idx(struct vhost_virtqueue *vq)
976 return vhost_put_user(vq, cpu_to_vhost16(vq, vq->last_used_idx),
980 #define vhost_get_user(vq, x, ptr, type) \
984 ret = __get_user(x, ptr); \
986 __typeof__(ptr) from = \
987 (__typeof__(ptr)) __vhost_get_user(vq, ptr, \
991 ret = __get_user(x, from); \
998 #define vhost_get_avail(vq, x, ptr) \
999 vhost_get_user(vq, x, ptr, VHOST_ADDR_AVAIL)
1001 #define vhost_get_used(vq, x, ptr) \
1002 vhost_get_user(vq, x, ptr, VHOST_ADDR_USED)
1004 static void vhost_dev_lock_vqs(struct vhost_dev *d)
1007 for (i = 0; i < d->nvqs; ++i)
1008 mutex_lock_nested(&d->vqs[i]->mutex, i);
1011 static void vhost_dev_unlock_vqs(struct vhost_dev *d)
1014 for (i = 0; i < d->nvqs; ++i)
1015 mutex_unlock(&d->vqs[i]->mutex);
1018 static inline int vhost_get_avail_idx(struct vhost_virtqueue *vq,
1021 return vhost_get_avail(vq, *idx, &vq->avail->idx);
1024 static inline int vhost_get_avail_head(struct vhost_virtqueue *vq,
1025 __virtio16 *head, int idx)
1027 return vhost_get_avail(vq, *head,
1028 &vq->avail->ring[idx & (vq->num - 1)]);
1031 static inline int vhost_get_avail_flags(struct vhost_virtqueue *vq,
1034 return vhost_get_avail(vq, *flags, &vq->avail->flags);
1037 static inline int vhost_get_used_event(struct vhost_virtqueue *vq,
1040 return vhost_get_avail(vq, *event, vhost_used_event(vq));
1043 static inline int vhost_get_used_idx(struct vhost_virtqueue *vq,
1046 return vhost_get_used(vq, *idx, &vq->used->idx);
1049 static inline int vhost_get_desc(struct vhost_virtqueue *vq,
1050 struct vring_desc *desc, int idx)
1052 return vhost_copy_from_user(vq, desc, vq->desc + idx, sizeof(*desc));
1055 static void vhost_iotlb_notify_vq(struct vhost_dev *d,
1056 struct vhost_iotlb_msg *msg)
1058 struct vhost_msg_node *node, *n;
1060 spin_lock(&d->iotlb_lock);
1062 list_for_each_entry_safe(node, n, &d->pending_list, node) {
1063 struct vhost_iotlb_msg *vq_msg = &node->msg.iotlb;
1064 if (msg->iova <= vq_msg->iova &&
1065 msg->iova + msg->size - 1 >= vq_msg->iova &&
1066 vq_msg->type == VHOST_IOTLB_MISS) {
1067 vhost_poll_queue(&node->vq->poll);
1068 list_del(&node->node);
1073 spin_unlock(&d->iotlb_lock);
1076 static bool umem_access_ok(u64 uaddr, u64 size, int access)
1078 unsigned long a = uaddr;
1080 /* Make sure 64 bit math will not overflow. */
1081 if (vhost_overflow(uaddr, size))
1084 if ((access & VHOST_ACCESS_RO) &&
1085 !access_ok((void __user *)a, size))
1087 if ((access & VHOST_ACCESS_WO) &&
1088 !access_ok((void __user *)a, size))
1093 static int vhost_process_iotlb_msg(struct vhost_dev *dev,
1094 struct vhost_iotlb_msg *msg)
1098 mutex_lock(&dev->mutex);
1099 vhost_dev_lock_vqs(dev);
1100 switch (msg->type) {
1101 case VHOST_IOTLB_UPDATE:
1106 if (!umem_access_ok(msg->uaddr, msg->size, msg->perm)) {
1110 vhost_vq_meta_reset(dev);
1111 if (vhost_iotlb_add_range(dev->iotlb, msg->iova,
1112 msg->iova + msg->size - 1,
1113 msg->uaddr, msg->perm)) {
1117 vhost_iotlb_notify_vq(dev, msg);
1119 case VHOST_IOTLB_INVALIDATE:
1124 vhost_vq_meta_reset(dev);
1125 vhost_iotlb_del_range(dev->iotlb, msg->iova,
1126 msg->iova + msg->size - 1);
1133 vhost_dev_unlock_vqs(dev);
1134 mutex_unlock(&dev->mutex);
1138 ssize_t vhost_chr_write_iter(struct vhost_dev *dev,
1139 struct iov_iter *from)
1141 struct vhost_iotlb_msg msg;
1145 ret = copy_from_iter(&type, sizeof(type), from);
1146 if (ret != sizeof(type)) {
1152 case VHOST_IOTLB_MSG:
1153 /* There maybe a hole after type for V1 message type,
1156 offset = offsetof(struct vhost_msg, iotlb) - sizeof(int);
1158 case VHOST_IOTLB_MSG_V2:
1159 offset = sizeof(__u32);
1166 iov_iter_advance(from, offset);
1167 ret = copy_from_iter(&msg, sizeof(msg), from);
1168 if (ret != sizeof(msg)) {
1173 if (dev->msg_handler)
1174 ret = dev->msg_handler(dev, &msg);
1176 ret = vhost_process_iotlb_msg(dev, &msg);
1182 ret = (type == VHOST_IOTLB_MSG) ? sizeof(struct vhost_msg) :
1183 sizeof(struct vhost_msg_v2);
1187 EXPORT_SYMBOL(vhost_chr_write_iter);
1189 __poll_t vhost_chr_poll(struct file *file, struct vhost_dev *dev,
1194 poll_wait(file, &dev->wait, wait);
1196 if (!list_empty(&dev->read_list))
1197 mask |= EPOLLIN | EPOLLRDNORM;
1201 EXPORT_SYMBOL(vhost_chr_poll);
1203 ssize_t vhost_chr_read_iter(struct vhost_dev *dev, struct iov_iter *to,
1207 struct vhost_msg_node *node;
1209 unsigned size = sizeof(struct vhost_msg);
1211 if (iov_iter_count(to) < size)
1216 prepare_to_wait(&dev->wait, &wait,
1217 TASK_INTERRUPTIBLE);
1219 node = vhost_dequeue_msg(dev, &dev->read_list);
1226 if (signal_pending(current)) {
1239 finish_wait(&dev->wait, &wait);
1242 struct vhost_iotlb_msg *msg;
1243 void *start = &node->msg;
1245 switch (node->msg.type) {
1246 case VHOST_IOTLB_MSG:
1247 size = sizeof(node->msg);
1248 msg = &node->msg.iotlb;
1250 case VHOST_IOTLB_MSG_V2:
1251 size = sizeof(node->msg_v2);
1252 msg = &node->msg_v2.iotlb;
1259 ret = copy_to_iter(start, size, to);
1260 if (ret != size || msg->type != VHOST_IOTLB_MISS) {
1264 vhost_enqueue_msg(dev, &dev->pending_list, node);
1269 EXPORT_SYMBOL_GPL(vhost_chr_read_iter);
1271 static int vhost_iotlb_miss(struct vhost_virtqueue *vq, u64 iova, int access)
1273 struct vhost_dev *dev = vq->dev;
1274 struct vhost_msg_node *node;
1275 struct vhost_iotlb_msg *msg;
1276 bool v2 = vhost_backend_has_feature(vq, VHOST_BACKEND_F_IOTLB_MSG_V2);
1278 node = vhost_new_msg(vq, v2 ? VHOST_IOTLB_MSG_V2 : VHOST_IOTLB_MSG);
1283 node->msg_v2.type = VHOST_IOTLB_MSG_V2;
1284 msg = &node->msg_v2.iotlb;
1286 msg = &node->msg.iotlb;
1289 msg->type = VHOST_IOTLB_MISS;
1293 vhost_enqueue_msg(dev, &dev->read_list, node);
1298 static bool vq_access_ok(struct vhost_virtqueue *vq, unsigned int num,
1299 vring_desc_t __user *desc,
1300 vring_avail_t __user *avail,
1301 vring_used_t __user *used)
1304 /* If an IOTLB device is present, the vring addresses are
1305 * GIOVAs. Access validation occurs at prefetch time. */
1309 return access_ok(desc, vhost_get_desc_size(vq, num)) &&
1310 access_ok(avail, vhost_get_avail_size(vq, num)) &&
1311 access_ok(used, vhost_get_used_size(vq, num));
1314 static void vhost_vq_meta_update(struct vhost_virtqueue *vq,
1315 const struct vhost_iotlb_map *map,
1318 int access = (type == VHOST_ADDR_USED) ?
1319 VHOST_ACCESS_WO : VHOST_ACCESS_RO;
1321 if (likely(map->perm & access))
1322 vq->meta_iotlb[type] = map;
1325 static bool iotlb_access_ok(struct vhost_virtqueue *vq,
1326 int access, u64 addr, u64 len, int type)
1328 const struct vhost_iotlb_map *map;
1329 struct vhost_iotlb *umem = vq->iotlb;
1330 u64 s = 0, size, orig_addr = addr, last = addr + len - 1;
1332 if (vhost_vq_meta_fetch(vq, addr, len, type))
1336 map = vhost_iotlb_itree_first(umem, addr, last);
1337 if (map == NULL || map->start > addr) {
1338 vhost_iotlb_miss(vq, addr, access);
1340 } else if (!(map->perm & access)) {
1341 /* Report the possible access violation by
1342 * request another translation from userspace.
1347 size = map->size - addr + map->start;
1349 if (orig_addr == addr && size >= len)
1350 vhost_vq_meta_update(vq, map, type);
1359 int vq_meta_prefetch(struct vhost_virtqueue *vq)
1361 unsigned int num = vq->num;
1366 return iotlb_access_ok(vq, VHOST_MAP_RO, (u64)(uintptr_t)vq->desc,
1367 vhost_get_desc_size(vq, num), VHOST_ADDR_DESC) &&
1368 iotlb_access_ok(vq, VHOST_MAP_RO, (u64)(uintptr_t)vq->avail,
1369 vhost_get_avail_size(vq, num),
1370 VHOST_ADDR_AVAIL) &&
1371 iotlb_access_ok(vq, VHOST_MAP_WO, (u64)(uintptr_t)vq->used,
1372 vhost_get_used_size(vq, num), VHOST_ADDR_USED);
1374 EXPORT_SYMBOL_GPL(vq_meta_prefetch);
1376 /* Can we log writes? */
1377 /* Caller should have device mutex but not vq mutex */
1378 bool vhost_log_access_ok(struct vhost_dev *dev)
1380 return memory_access_ok(dev, dev->umem, 1);
1382 EXPORT_SYMBOL_GPL(vhost_log_access_ok);
1384 static bool vq_log_used_access_ok(struct vhost_virtqueue *vq,
1385 void __user *log_base,
1389 /* If an IOTLB device is present, log_addr is a GIOVA that
1390 * will never be logged by log_used(). */
1394 return !log_used || log_access_ok(log_base, log_addr,
1395 vhost_get_used_size(vq, vq->num));
1398 /* Verify access for write logging. */
1399 /* Caller should have vq mutex and device mutex */
1400 static bool vq_log_access_ok(struct vhost_virtqueue *vq,
1401 void __user *log_base)
1403 return vq_memory_access_ok(log_base, vq->umem,
1404 vhost_has_feature(vq, VHOST_F_LOG_ALL)) &&
1405 vq_log_used_access_ok(vq, log_base, vq->log_used, vq->log_addr);
1408 /* Can we start vq? */
1409 /* Caller should have vq mutex and device mutex */
1410 bool vhost_vq_access_ok(struct vhost_virtqueue *vq)
1412 if (!vq_log_access_ok(vq, vq->log_base))
1415 return vq_access_ok(vq, vq->num, vq->desc, vq->avail, vq->used);
1417 EXPORT_SYMBOL_GPL(vhost_vq_access_ok);
1419 static long vhost_set_memory(struct vhost_dev *d, struct vhost_memory __user *m)
1421 struct vhost_memory mem, *newmem;
1422 struct vhost_memory_region *region;
1423 struct vhost_iotlb *newumem, *oldumem;
1424 unsigned long size = offsetof(struct vhost_memory, regions);
1427 if (copy_from_user(&mem, m, size))
1431 if (mem.nregions > max_mem_regions)
1433 newmem = kvzalloc(struct_size(newmem, regions, mem.nregions),
1438 memcpy(newmem, &mem, size);
1439 if (copy_from_user(newmem->regions, m->regions,
1440 flex_array_size(newmem, regions, mem.nregions))) {
1445 newumem = iotlb_alloc();
1451 for (region = newmem->regions;
1452 region < newmem->regions + mem.nregions;
1454 if (vhost_iotlb_add_range(newumem,
1455 region->guest_phys_addr,
1456 region->guest_phys_addr +
1457 region->memory_size - 1,
1458 region->userspace_addr,
1463 if (!memory_access_ok(d, newumem, 0))
1469 /* All memory accesses are done under some VQ mutex. */
1470 for (i = 0; i < d->nvqs; ++i) {
1471 mutex_lock(&d->vqs[i]->mutex);
1472 d->vqs[i]->umem = newumem;
1473 mutex_unlock(&d->vqs[i]->mutex);
1477 vhost_iotlb_free(oldumem);
1481 vhost_iotlb_free(newumem);
1486 static long vhost_vring_set_num(struct vhost_dev *d,
1487 struct vhost_virtqueue *vq,
1490 struct vhost_vring_state s;
1492 /* Resizing ring with an active backend?
1493 * You don't want to do that. */
1494 if (vq->private_data)
1497 if (copy_from_user(&s, argp, sizeof s))
1500 if (!s.num || s.num > 0xffff || (s.num & (s.num - 1)))
1507 static long vhost_vring_set_addr(struct vhost_dev *d,
1508 struct vhost_virtqueue *vq,
1511 struct vhost_vring_addr a;
1513 if (copy_from_user(&a, argp, sizeof a))
1515 if (a.flags & ~(0x1 << VHOST_VRING_F_LOG))
1518 /* For 32bit, verify that the top 32bits of the user
1519 data are set to zero. */
1520 if ((u64)(unsigned long)a.desc_user_addr != a.desc_user_addr ||
1521 (u64)(unsigned long)a.used_user_addr != a.used_user_addr ||
1522 (u64)(unsigned long)a.avail_user_addr != a.avail_user_addr)
1525 /* Make sure it's safe to cast pointers to vring types. */
1526 BUILD_BUG_ON(__alignof__ *vq->avail > VRING_AVAIL_ALIGN_SIZE);
1527 BUILD_BUG_ON(__alignof__ *vq->used > VRING_USED_ALIGN_SIZE);
1528 if ((a.avail_user_addr & (VRING_AVAIL_ALIGN_SIZE - 1)) ||
1529 (a.used_user_addr & (VRING_USED_ALIGN_SIZE - 1)) ||
1530 (a.log_guest_addr & (VRING_USED_ALIGN_SIZE - 1)))
1533 /* We only verify access here if backend is configured.
1534 * If it is not, we don't as size might not have been setup.
1535 * We will verify when backend is configured. */
1536 if (vq->private_data) {
1537 if (!vq_access_ok(vq, vq->num,
1538 (void __user *)(unsigned long)a.desc_user_addr,
1539 (void __user *)(unsigned long)a.avail_user_addr,
1540 (void __user *)(unsigned long)a.used_user_addr))
1543 /* Also validate log access for used ring if enabled. */
1544 if (!vq_log_used_access_ok(vq, vq->log_base,
1545 a.flags & (0x1 << VHOST_VRING_F_LOG),
1550 vq->log_used = !!(a.flags & (0x1 << VHOST_VRING_F_LOG));
1551 vq->desc = (void __user *)(unsigned long)a.desc_user_addr;
1552 vq->avail = (void __user *)(unsigned long)a.avail_user_addr;
1553 vq->log_addr = a.log_guest_addr;
1554 vq->used = (void __user *)(unsigned long)a.used_user_addr;
1559 static long vhost_vring_set_num_addr(struct vhost_dev *d,
1560 struct vhost_virtqueue *vq,
1566 mutex_lock(&vq->mutex);
1569 case VHOST_SET_VRING_NUM:
1570 r = vhost_vring_set_num(d, vq, argp);
1572 case VHOST_SET_VRING_ADDR:
1573 r = vhost_vring_set_addr(d, vq, argp);
1579 mutex_unlock(&vq->mutex);
1583 long vhost_vring_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1585 struct file *eventfp, *filep = NULL;
1586 bool pollstart = false, pollstop = false;
1587 struct eventfd_ctx *ctx = NULL;
1588 u32 __user *idxp = argp;
1589 struct vhost_virtqueue *vq;
1590 struct vhost_vring_state s;
1591 struct vhost_vring_file f;
1595 r = get_user(idx, idxp);
1601 idx = array_index_nospec(idx, d->nvqs);
1604 if (ioctl == VHOST_SET_VRING_NUM ||
1605 ioctl == VHOST_SET_VRING_ADDR) {
1606 return vhost_vring_set_num_addr(d, vq, ioctl, argp);
1609 mutex_lock(&vq->mutex);
1612 case VHOST_SET_VRING_BASE:
1613 /* Moving base with an active backend?
1614 * You don't want to do that. */
1615 if (vq->private_data) {
1619 if (copy_from_user(&s, argp, sizeof s)) {
1623 if (s.num > 0xffff) {
1627 vq->last_avail_idx = s.num;
1628 /* Forget the cached index value. */
1629 vq->avail_idx = vq->last_avail_idx;
1631 case VHOST_GET_VRING_BASE:
1633 s.num = vq->last_avail_idx;
1634 if (copy_to_user(argp, &s, sizeof s))
1637 case VHOST_SET_VRING_KICK:
1638 if (copy_from_user(&f, argp, sizeof f)) {
1642 eventfp = f.fd == VHOST_FILE_UNBIND ? NULL : eventfd_fget(f.fd);
1643 if (IS_ERR(eventfp)) {
1644 r = PTR_ERR(eventfp);
1647 if (eventfp != vq->kick) {
1648 pollstop = (filep = vq->kick) != NULL;
1649 pollstart = (vq->kick = eventfp) != NULL;
1653 case VHOST_SET_VRING_CALL:
1654 if (copy_from_user(&f, argp, sizeof f)) {
1658 ctx = f.fd == VHOST_FILE_UNBIND ? NULL : eventfd_ctx_fdget(f.fd);
1664 swap(ctx, vq->call_ctx.ctx);
1666 case VHOST_SET_VRING_ERR:
1667 if (copy_from_user(&f, argp, sizeof f)) {
1671 ctx = f.fd == VHOST_FILE_UNBIND ? NULL : eventfd_ctx_fdget(f.fd);
1676 swap(ctx, vq->error_ctx);
1678 case VHOST_SET_VRING_ENDIAN:
1679 r = vhost_set_vring_endian(vq, argp);
1681 case VHOST_GET_VRING_ENDIAN:
1682 r = vhost_get_vring_endian(vq, idx, argp);
1684 case VHOST_SET_VRING_BUSYLOOP_TIMEOUT:
1685 if (copy_from_user(&s, argp, sizeof(s))) {
1689 vq->busyloop_timeout = s.num;
1691 case VHOST_GET_VRING_BUSYLOOP_TIMEOUT:
1693 s.num = vq->busyloop_timeout;
1694 if (copy_to_user(argp, &s, sizeof(s)))
1701 if (pollstop && vq->handle_kick)
1702 vhost_poll_stop(&vq->poll);
1704 if (!IS_ERR_OR_NULL(ctx))
1705 eventfd_ctx_put(ctx);
1709 if (pollstart && vq->handle_kick)
1710 r = vhost_poll_start(&vq->poll, vq->kick);
1712 mutex_unlock(&vq->mutex);
1714 if (pollstop && vq->handle_kick)
1715 vhost_poll_flush(&vq->poll);
1718 EXPORT_SYMBOL_GPL(vhost_vring_ioctl);
1720 int vhost_init_device_iotlb(struct vhost_dev *d, bool enabled)
1722 struct vhost_iotlb *niotlb, *oiotlb;
1725 niotlb = iotlb_alloc();
1732 for (i = 0; i < d->nvqs; ++i) {
1733 struct vhost_virtqueue *vq = d->vqs[i];
1735 mutex_lock(&vq->mutex);
1737 __vhost_vq_meta_reset(vq);
1738 mutex_unlock(&vq->mutex);
1741 vhost_iotlb_free(oiotlb);
1745 EXPORT_SYMBOL_GPL(vhost_init_device_iotlb);
1747 /* Caller must have device mutex */
1748 long vhost_dev_ioctl(struct vhost_dev *d, unsigned int ioctl, void __user *argp)
1750 struct eventfd_ctx *ctx;
1755 /* If you are not the owner, you can become one */
1756 if (ioctl == VHOST_SET_OWNER) {
1757 r = vhost_dev_set_owner(d);
1761 /* You must be the owner to do anything else */
1762 r = vhost_dev_check_owner(d);
1767 case VHOST_SET_MEM_TABLE:
1768 r = vhost_set_memory(d, argp);
1770 case VHOST_SET_LOG_BASE:
1771 if (copy_from_user(&p, argp, sizeof p)) {
1775 if ((u64)(unsigned long)p != p) {
1779 for (i = 0; i < d->nvqs; ++i) {
1780 struct vhost_virtqueue *vq;
1781 void __user *base = (void __user *)(unsigned long)p;
1783 mutex_lock(&vq->mutex);
1784 /* If ring is inactive, will check when it's enabled. */
1785 if (vq->private_data && !vq_log_access_ok(vq, base))
1788 vq->log_base = base;
1789 mutex_unlock(&vq->mutex);
1792 case VHOST_SET_LOG_FD:
1793 r = get_user(fd, (int __user *)argp);
1796 ctx = fd == VHOST_FILE_UNBIND ? NULL : eventfd_ctx_fdget(fd);
1801 swap(ctx, d->log_ctx);
1802 for (i = 0; i < d->nvqs; ++i) {
1803 mutex_lock(&d->vqs[i]->mutex);
1804 d->vqs[i]->log_ctx = d->log_ctx;
1805 mutex_unlock(&d->vqs[i]->mutex);
1808 eventfd_ctx_put(ctx);
1817 EXPORT_SYMBOL_GPL(vhost_dev_ioctl);
1819 /* TODO: This is really inefficient. We need something like get_user()
1820 * (instruction directly accesses the data, with an exception table entry
1821 * returning -EFAULT). See Documentation/x86/exception-tables.rst.
1823 static int set_bit_to_user(int nr, void __user *addr)
1825 unsigned long log = (unsigned long)addr;
1828 int bit = nr + (log % PAGE_SIZE) * 8;
1831 r = pin_user_pages_fast(log, 1, FOLL_WRITE, &page);
1835 base = kmap_atomic(page);
1837 kunmap_atomic(base);
1838 unpin_user_pages_dirty_lock(&page, 1, true);
1842 static int log_write(void __user *log_base,
1843 u64 write_address, u64 write_length)
1845 u64 write_page = write_address / VHOST_PAGE_SIZE;
1850 write_length += write_address % VHOST_PAGE_SIZE;
1852 u64 base = (u64)(unsigned long)log_base;
1853 u64 log = base + write_page / 8;
1854 int bit = write_page % 8;
1855 if ((u64)(unsigned long)log != log)
1857 r = set_bit_to_user(bit, (void __user *)(unsigned long)log);
1860 if (write_length <= VHOST_PAGE_SIZE)
1862 write_length -= VHOST_PAGE_SIZE;
1868 static int log_write_hva(struct vhost_virtqueue *vq, u64 hva, u64 len)
1870 struct vhost_iotlb *umem = vq->umem;
1871 struct vhost_iotlb_map *u;
1872 u64 start, end, l, min;
1878 /* More than one GPAs can be mapped into a single HVA. So
1879 * iterate all possible umems here to be safe.
1881 list_for_each_entry(u, &umem->list, link) {
1882 if (u->addr > hva - 1 + len ||
1883 u->addr - 1 + u->size < hva)
1885 start = max(u->addr, hva);
1886 end = min(u->addr - 1 + u->size, hva - 1 + len);
1887 l = end - start + 1;
1888 r = log_write(vq->log_base,
1889 u->start + start - u->addr,
1907 static int log_used(struct vhost_virtqueue *vq, u64 used_offset, u64 len)
1909 struct iovec *iov = vq->log_iov;
1913 return log_write(vq->log_base, vq->log_addr + used_offset, len);
1915 ret = translate_desc(vq, (uintptr_t)vq->used + used_offset,
1916 len, iov, 64, VHOST_ACCESS_WO);
1920 for (i = 0; i < ret; i++) {
1921 ret = log_write_hva(vq, (uintptr_t)iov[i].iov_base,
1930 int vhost_log_write(struct vhost_virtqueue *vq, struct vhost_log *log,
1931 unsigned int log_num, u64 len, struct iovec *iov, int count)
1935 /* Make sure data written is seen before log. */
1939 for (i = 0; i < count; i++) {
1940 r = log_write_hva(vq, (uintptr_t)iov[i].iov_base,
1948 for (i = 0; i < log_num; ++i) {
1949 u64 l = min(log[i].len, len);
1950 r = log_write(vq->log_base, log[i].addr, l);
1956 eventfd_signal(vq->log_ctx, 1);
1960 /* Length written exceeds what we have stored. This is a bug. */
1964 EXPORT_SYMBOL_GPL(vhost_log_write);
1966 static int vhost_update_used_flags(struct vhost_virtqueue *vq)
1969 if (vhost_put_used_flags(vq))
1971 if (unlikely(vq->log_used)) {
1972 /* Make sure the flag is seen before log. */
1974 /* Log used flag write. */
1975 used = &vq->used->flags;
1976 log_used(vq, (used - (void __user *)vq->used),
1977 sizeof vq->used->flags);
1979 eventfd_signal(vq->log_ctx, 1);
1984 static int vhost_update_avail_event(struct vhost_virtqueue *vq, u16 avail_event)
1986 if (vhost_put_avail_event(vq))
1988 if (unlikely(vq->log_used)) {
1990 /* Make sure the event is seen before log. */
1992 /* Log avail event write */
1993 used = vhost_avail_event(vq);
1994 log_used(vq, (used - (void __user *)vq->used),
1995 sizeof *vhost_avail_event(vq));
1997 eventfd_signal(vq->log_ctx, 1);
2002 int vhost_vq_init_access(struct vhost_virtqueue *vq)
2004 __virtio16 last_used_idx;
2006 bool is_le = vq->is_le;
2008 if (!vq->private_data)
2011 vhost_init_is_le(vq);
2013 r = vhost_update_used_flags(vq);
2016 vq->signalled_used_valid = false;
2018 !access_ok(&vq->used->idx, sizeof vq->used->idx)) {
2022 r = vhost_get_used_idx(vq, &last_used_idx);
2024 vq_err(vq, "Can't access used idx at %p\n",
2028 vq->last_used_idx = vhost16_to_cpu(vq, last_used_idx);
2035 EXPORT_SYMBOL_GPL(vhost_vq_init_access);
2037 static int translate_desc(struct vhost_virtqueue *vq, u64 addr, u32 len,
2038 struct iovec iov[], int iov_size, int access)
2040 const struct vhost_iotlb_map *map;
2041 struct vhost_dev *dev = vq->dev;
2042 struct vhost_iotlb *umem = dev->iotlb ? dev->iotlb : dev->umem;
2047 while ((u64)len > s) {
2049 if (unlikely(ret >= iov_size)) {
2054 map = vhost_iotlb_itree_first(umem, addr, addr + len - 1);
2055 if (map == NULL || map->start > addr) {
2056 if (umem != dev->iotlb) {
2062 } else if (!(map->perm & access)) {
2068 size = map->size - addr + map->start;
2069 _iov->iov_len = min((u64)len - s, size);
2070 _iov->iov_base = (void __user *)(unsigned long)
2071 (map->addr + addr - map->start);
2078 vhost_iotlb_miss(vq, addr, access);
2082 /* Each buffer in the virtqueues is actually a chain of descriptors. This
2083 * function returns the next descriptor in the chain,
2084 * or -1U if we're at the end. */
2085 static unsigned next_desc(struct vhost_virtqueue *vq, struct vring_desc *desc)
2089 /* If this descriptor says it doesn't chain, we're done. */
2090 if (!(desc->flags & cpu_to_vhost16(vq, VRING_DESC_F_NEXT)))
2093 /* Check they're not leading us off end of descriptors. */
2094 next = vhost16_to_cpu(vq, READ_ONCE(desc->next));
2098 static int get_indirect(struct vhost_virtqueue *vq,
2099 struct iovec iov[], unsigned int iov_size,
2100 unsigned int *out_num, unsigned int *in_num,
2101 struct vhost_log *log, unsigned int *log_num,
2102 struct vring_desc *indirect)
2104 struct vring_desc desc;
2105 unsigned int i = 0, count, found = 0;
2106 u32 len = vhost32_to_cpu(vq, indirect->len);
2107 struct iov_iter from;
2111 if (unlikely(len % sizeof desc)) {
2112 vq_err(vq, "Invalid length in indirect descriptor: "
2113 "len 0x%llx not multiple of 0x%zx\n",
2114 (unsigned long long)len,
2119 ret = translate_desc(vq, vhost64_to_cpu(vq, indirect->addr), len, vq->indirect,
2120 UIO_MAXIOV, VHOST_ACCESS_RO);
2121 if (unlikely(ret < 0)) {
2123 vq_err(vq, "Translation failure %d in indirect.\n", ret);
2126 iov_iter_init(&from, READ, vq->indirect, ret, len);
2127 count = len / sizeof desc;
2128 /* Buffers are chained via a 16 bit next field, so
2129 * we can have at most 2^16 of these. */
2130 if (unlikely(count > USHRT_MAX + 1)) {
2131 vq_err(vq, "Indirect buffer length too big: %d\n",
2137 unsigned iov_count = *in_num + *out_num;
2138 if (unlikely(++found > count)) {
2139 vq_err(vq, "Loop detected: last one at %u "
2140 "indirect size %u\n",
2144 if (unlikely(!copy_from_iter_full(&desc, sizeof(desc), &from))) {
2145 vq_err(vq, "Failed indirect descriptor: idx %d, %zx\n",
2146 i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
2149 if (unlikely(desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT))) {
2150 vq_err(vq, "Nested indirect descriptor: idx %d, %zx\n",
2151 i, (size_t)vhost64_to_cpu(vq, indirect->addr) + i * sizeof desc);
2155 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
2156 access = VHOST_ACCESS_WO;
2158 access = VHOST_ACCESS_RO;
2160 ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
2161 vhost32_to_cpu(vq, desc.len), iov + iov_count,
2162 iov_size - iov_count, access);
2163 if (unlikely(ret < 0)) {
2165 vq_err(vq, "Translation failure %d indirect idx %d\n",
2169 /* If this is an input descriptor, increment that count. */
2170 if (access == VHOST_ACCESS_WO) {
2172 if (unlikely(log && ret)) {
2173 log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
2174 log[*log_num].len = vhost32_to_cpu(vq, desc.len);
2178 /* If it's an output descriptor, they're all supposed
2179 * to come before any input descriptors. */
2180 if (unlikely(*in_num)) {
2181 vq_err(vq, "Indirect descriptor "
2182 "has out after in: idx %d\n", i);
2187 } while ((i = next_desc(vq, &desc)) != -1);
2191 /* This looks in the virtqueue and for the first available buffer, and converts
2192 * it to an iovec for convenient access. Since descriptors consist of some
2193 * number of output then some number of input descriptors, it's actually two
2194 * iovecs, but we pack them into one and note how many of each there were.
2196 * This function returns the descriptor number found, or vq->num (which is
2197 * never a valid descriptor number) if none was found. A negative code is
2198 * returned on error. */
2199 int vhost_get_vq_desc(struct vhost_virtqueue *vq,
2200 struct iovec iov[], unsigned int iov_size,
2201 unsigned int *out_num, unsigned int *in_num,
2202 struct vhost_log *log, unsigned int *log_num)
2204 struct vring_desc desc;
2205 unsigned int i, head, found = 0;
2207 __virtio16 avail_idx;
2208 __virtio16 ring_head;
2211 /* Check it isn't doing very strange things with descriptor numbers. */
2212 last_avail_idx = vq->last_avail_idx;
2214 if (vq->avail_idx == vq->last_avail_idx) {
2215 if (unlikely(vhost_get_avail_idx(vq, &avail_idx))) {
2216 vq_err(vq, "Failed to access avail idx at %p\n",
2220 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2222 if (unlikely((u16)(vq->avail_idx - last_avail_idx) > vq->num)) {
2223 vq_err(vq, "Guest moved used index from %u to %u",
2224 last_avail_idx, vq->avail_idx);
2228 /* If there's nothing new since last we looked, return
2231 if (vq->avail_idx == last_avail_idx)
2234 /* Only get avail ring entries after they have been
2240 /* Grab the next descriptor number they're advertising, and increment
2241 * the index we've seen. */
2242 if (unlikely(vhost_get_avail_head(vq, &ring_head, last_avail_idx))) {
2243 vq_err(vq, "Failed to read head: idx %d address %p\n",
2245 &vq->avail->ring[last_avail_idx % vq->num]);
2249 head = vhost16_to_cpu(vq, ring_head);
2251 /* If their number is silly, that's an error. */
2252 if (unlikely(head >= vq->num)) {
2253 vq_err(vq, "Guest says index %u > %u is available",
2258 /* When we start there are none of either input nor output. */
2259 *out_num = *in_num = 0;
2265 unsigned iov_count = *in_num + *out_num;
2266 if (unlikely(i >= vq->num)) {
2267 vq_err(vq, "Desc index is %u > %u, head = %u",
2271 if (unlikely(++found > vq->num)) {
2272 vq_err(vq, "Loop detected: last one at %u "
2273 "vq size %u head %u\n",
2277 ret = vhost_get_desc(vq, &desc, i);
2278 if (unlikely(ret)) {
2279 vq_err(vq, "Failed to get descriptor: idx %d addr %p\n",
2283 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_INDIRECT)) {
2284 ret = get_indirect(vq, iov, iov_size,
2286 log, log_num, &desc);
2287 if (unlikely(ret < 0)) {
2289 vq_err(vq, "Failure detected "
2290 "in indirect descriptor at idx %d\n", i);
2296 if (desc.flags & cpu_to_vhost16(vq, VRING_DESC_F_WRITE))
2297 access = VHOST_ACCESS_WO;
2299 access = VHOST_ACCESS_RO;
2300 ret = translate_desc(vq, vhost64_to_cpu(vq, desc.addr),
2301 vhost32_to_cpu(vq, desc.len), iov + iov_count,
2302 iov_size - iov_count, access);
2303 if (unlikely(ret < 0)) {
2305 vq_err(vq, "Translation failure %d descriptor idx %d\n",
2309 if (access == VHOST_ACCESS_WO) {
2310 /* If this is an input descriptor,
2311 * increment that count. */
2313 if (unlikely(log && ret)) {
2314 log[*log_num].addr = vhost64_to_cpu(vq, desc.addr);
2315 log[*log_num].len = vhost32_to_cpu(vq, desc.len);
2319 /* If it's an output descriptor, they're all supposed
2320 * to come before any input descriptors. */
2321 if (unlikely(*in_num)) {
2322 vq_err(vq, "Descriptor has out after in: "
2328 } while ((i = next_desc(vq, &desc)) != -1);
2330 /* On success, increment avail index. */
2331 vq->last_avail_idx++;
2333 /* Assume notifications from guest are disabled at this point,
2334 * if they aren't we would need to update avail_event index. */
2335 BUG_ON(!(vq->used_flags & VRING_USED_F_NO_NOTIFY));
2338 EXPORT_SYMBOL_GPL(vhost_get_vq_desc);
2340 /* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
2341 void vhost_discard_vq_desc(struct vhost_virtqueue *vq, int n)
2343 vq->last_avail_idx -= n;
2345 EXPORT_SYMBOL_GPL(vhost_discard_vq_desc);
2347 /* After we've used one of their buffers, we tell them about it. We'll then
2348 * want to notify the guest, using eventfd. */
2349 int vhost_add_used(struct vhost_virtqueue *vq, unsigned int head, int len)
2351 struct vring_used_elem heads = {
2352 cpu_to_vhost32(vq, head),
2353 cpu_to_vhost32(vq, len)
2356 return vhost_add_used_n(vq, &heads, 1);
2358 EXPORT_SYMBOL_GPL(vhost_add_used);
2360 static int __vhost_add_used_n(struct vhost_virtqueue *vq,
2361 struct vring_used_elem *heads,
2364 vring_used_elem_t __user *used;
2368 start = vq->last_used_idx & (vq->num - 1);
2369 used = vq->used->ring + start;
2370 if (vhost_put_used(vq, heads, start, count)) {
2371 vq_err(vq, "Failed to write used");
2374 if (unlikely(vq->log_used)) {
2375 /* Make sure data is seen before log. */
2377 /* Log used ring entry write. */
2378 log_used(vq, ((void __user *)used - (void __user *)vq->used),
2379 count * sizeof *used);
2381 old = vq->last_used_idx;
2382 new = (vq->last_used_idx += count);
2383 /* If the driver never bothers to signal in a very long while,
2384 * used index might wrap around. If that happens, invalidate
2385 * signalled_used index we stored. TODO: make sure driver
2386 * signals at least once in 2^16 and remove this. */
2387 if (unlikely((u16)(new - vq->signalled_used) < (u16)(new - old)))
2388 vq->signalled_used_valid = false;
2392 /* After we've used one of their buffers, we tell them about it. We'll then
2393 * want to notify the guest, using eventfd. */
2394 int vhost_add_used_n(struct vhost_virtqueue *vq, struct vring_used_elem *heads,
2399 start = vq->last_used_idx & (vq->num - 1);
2400 n = vq->num - start;
2402 r = __vhost_add_used_n(vq, heads, n);
2408 r = __vhost_add_used_n(vq, heads, count);
2410 /* Make sure buffer is written before we update index. */
2412 if (vhost_put_used_idx(vq)) {
2413 vq_err(vq, "Failed to increment used idx");
2416 if (unlikely(vq->log_used)) {
2417 /* Make sure used idx is seen before log. */
2419 /* Log used index update. */
2420 log_used(vq, offsetof(struct vring_used, idx),
2421 sizeof vq->used->idx);
2423 eventfd_signal(vq->log_ctx, 1);
2427 EXPORT_SYMBOL_GPL(vhost_add_used_n);
2429 static bool vhost_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2434 /* Flush out used index updates. This is paired
2435 * with the barrier that the Guest executes when enabling
2439 if (vhost_has_feature(vq, VIRTIO_F_NOTIFY_ON_EMPTY) &&
2440 unlikely(vq->avail_idx == vq->last_avail_idx))
2443 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2445 if (vhost_get_avail_flags(vq, &flags)) {
2446 vq_err(vq, "Failed to get flags");
2449 return !(flags & cpu_to_vhost16(vq, VRING_AVAIL_F_NO_INTERRUPT));
2451 old = vq->signalled_used;
2452 v = vq->signalled_used_valid;
2453 new = vq->signalled_used = vq->last_used_idx;
2454 vq->signalled_used_valid = true;
2459 if (vhost_get_used_event(vq, &event)) {
2460 vq_err(vq, "Failed to get used event idx");
2463 return vring_need_event(vhost16_to_cpu(vq, event), new, old);
2466 /* This actually signals the guest, using eventfd. */
2467 void vhost_signal(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2469 /* Signal the Guest tell them we used something up. */
2470 if (vq->call_ctx.ctx && vhost_notify(dev, vq))
2471 eventfd_signal(vq->call_ctx.ctx, 1);
2473 EXPORT_SYMBOL_GPL(vhost_signal);
2475 /* And here's the combo meal deal. Supersize me! */
2476 void vhost_add_used_and_signal(struct vhost_dev *dev,
2477 struct vhost_virtqueue *vq,
2478 unsigned int head, int len)
2480 vhost_add_used(vq, head, len);
2481 vhost_signal(dev, vq);
2483 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal);
2485 /* multi-buffer version of vhost_add_used_and_signal */
2486 void vhost_add_used_and_signal_n(struct vhost_dev *dev,
2487 struct vhost_virtqueue *vq,
2488 struct vring_used_elem *heads, unsigned count)
2490 vhost_add_used_n(vq, heads, count);
2491 vhost_signal(dev, vq);
2493 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n);
2495 /* return true if we're sure that avaiable ring is empty */
2496 bool vhost_vq_avail_empty(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2498 __virtio16 avail_idx;
2501 if (vq->avail_idx != vq->last_avail_idx)
2504 r = vhost_get_avail_idx(vq, &avail_idx);
2507 vq->avail_idx = vhost16_to_cpu(vq, avail_idx);
2509 return vq->avail_idx == vq->last_avail_idx;
2511 EXPORT_SYMBOL_GPL(vhost_vq_avail_empty);
2513 /* OK, now we need to know about added descriptors. */
2514 bool vhost_enable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2516 __virtio16 avail_idx;
2519 if (!(vq->used_flags & VRING_USED_F_NO_NOTIFY))
2521 vq->used_flags &= ~VRING_USED_F_NO_NOTIFY;
2522 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2523 r = vhost_update_used_flags(vq);
2525 vq_err(vq, "Failed to enable notification at %p: %d\n",
2526 &vq->used->flags, r);
2530 r = vhost_update_avail_event(vq, vq->avail_idx);
2532 vq_err(vq, "Failed to update avail event index at %p: %d\n",
2533 vhost_avail_event(vq), r);
2537 /* They could have slipped one in as we were doing that: make
2538 * sure it's written, then check again. */
2540 r = vhost_get_avail_idx(vq, &avail_idx);
2542 vq_err(vq, "Failed to check avail idx at %p: %d\n",
2543 &vq->avail->idx, r);
2547 return vhost16_to_cpu(vq, avail_idx) != vq->avail_idx;
2549 EXPORT_SYMBOL_GPL(vhost_enable_notify);
2551 /* We don't need to be notified again. */
2552 void vhost_disable_notify(struct vhost_dev *dev, struct vhost_virtqueue *vq)
2556 if (vq->used_flags & VRING_USED_F_NO_NOTIFY)
2558 vq->used_flags |= VRING_USED_F_NO_NOTIFY;
2559 if (!vhost_has_feature(vq, VIRTIO_RING_F_EVENT_IDX)) {
2560 r = vhost_update_used_flags(vq);
2562 vq_err(vq, "Failed to disable notification at %p: %d\n",
2563 &vq->used->flags, r);
2566 EXPORT_SYMBOL_GPL(vhost_disable_notify);
2568 /* Create a new message. */
2569 struct vhost_msg_node *vhost_new_msg(struct vhost_virtqueue *vq, int type)
2571 struct vhost_msg_node *node = kmalloc(sizeof *node, GFP_KERNEL);
2575 /* Make sure all padding within the structure is initialized. */
2576 memset(&node->msg, 0, sizeof node->msg);
2578 node->msg.type = type;
2581 EXPORT_SYMBOL_GPL(vhost_new_msg);
2583 void vhost_enqueue_msg(struct vhost_dev *dev, struct list_head *head,
2584 struct vhost_msg_node *node)
2586 spin_lock(&dev->iotlb_lock);
2587 list_add_tail(&node->node, head);
2588 spin_unlock(&dev->iotlb_lock);
2590 wake_up_interruptible_poll(&dev->wait, EPOLLIN | EPOLLRDNORM);
2592 EXPORT_SYMBOL_GPL(vhost_enqueue_msg);
2594 struct vhost_msg_node *vhost_dequeue_msg(struct vhost_dev *dev,
2595 struct list_head *head)
2597 struct vhost_msg_node *node = NULL;
2599 spin_lock(&dev->iotlb_lock);
2600 if (!list_empty(head)) {
2601 node = list_first_entry(head, struct vhost_msg_node,
2603 list_del(&node->node);
2605 spin_unlock(&dev->iotlb_lock);
2609 EXPORT_SYMBOL_GPL(vhost_dequeue_msg);
2611 void vhost_set_backend_features(struct vhost_dev *dev, u64 features)
2613 struct vhost_virtqueue *vq;
2616 mutex_lock(&dev->mutex);
2617 for (i = 0; i < dev->nvqs; ++i) {
2619 mutex_lock(&vq->mutex);
2620 vq->acked_backend_features = features;
2621 mutex_unlock(&vq->mutex);
2623 mutex_unlock(&dev->mutex);
2625 EXPORT_SYMBOL_GPL(vhost_set_backend_features);
2627 static int __init vhost_init(void)
2632 static void __exit vhost_exit(void)
2636 module_init(vhost_init);
2637 module_exit(vhost_exit);
2639 MODULE_VERSION("0.0.1");
2640 MODULE_LICENSE("GPL v2");
2641 MODULE_AUTHOR("Michael S. Tsirkin");
2642 MODULE_DESCRIPTION("Host kernel accelerator for virtio");