1 /* Copyright (C) 2009 Red Hat, Inc.
2 * Copyright (C) 2006 Rusty Russell IBM Corporation
4 * Author: Michael S. Tsirkin <mst@redhat.com>
6 * Inspiration, some code, and most witty comments come from
7 * Documentation/virtual/lguest/lguest.c, by Rusty Russell
9 * This work is licensed under the terms of the GNU GPL, version 2.
11 * Generic code for virtio server in host kernel.
14 #include <linux/eventfd.h>
15 #include <linux/vhost.h>
16 #include <linux/uio.h>
18 #include <linux/mmu_context.h>
19 #include <linux/miscdevice.h>
20 #include <linux/mutex.h>
21 #include <linux/poll.h>
22 #include <linux/file.h>
23 #include <linux/highmem.h>
24 #include <linux/slab.h>
25 #include <linux/vmalloc.h>
26 #include <linux/kthread.h>
27 #include <linux/cgroup.h>
28 #include <linux/module.h>
29 #include <linux/sort.h>
30 #include <linux/interval_tree_generic.h>
34 static ushort max_mem_regions
= 64;
35 module_param(max_mem_regions
, ushort
, 0444);
36 MODULE_PARM_DESC(max_mem_regions
,
37 "Maximum number of memory regions in memory map. (default: 64)");
38 static int max_iotlb_entries
= 2048;
39 module_param(max_iotlb_entries
, int, 0444);
40 MODULE_PARM_DESC(max_iotlb_entries
,
41 "Maximum number of iotlb entries. (default: 2048)");
44 VHOST_MEMORY_F_LOG
= 0x1,
47 #define vhost_used_event(vq) ((__virtio16 __user *)&vq->avail->ring[vq->num])
48 #define vhost_avail_event(vq) ((__virtio16 __user *)&vq->used->ring[vq->num])
50 INTERVAL_TREE_DEFINE(struct vhost_umem_node
,
51 rb
, __u64
, __subtree_last
,
52 START
, LAST
, , vhost_umem_interval_tree
);
54 #ifdef CONFIG_VHOST_CROSS_ENDIAN_LEGACY
55 static void vhost_disable_cross_endian(struct vhost_virtqueue
*vq
)
57 vq
->user_be
= !virtio_legacy_is_little_endian();
60 static void vhost_enable_cross_endian_big(struct vhost_virtqueue
*vq
)
65 static void vhost_enable_cross_endian_little(struct vhost_virtqueue
*vq
)
70 static long vhost_set_vring_endian(struct vhost_virtqueue
*vq
, int __user
*argp
)
72 struct vhost_vring_state s
;
77 if (copy_from_user(&s
, argp
, sizeof(s
)))
80 if (s
.num
!= VHOST_VRING_LITTLE_ENDIAN
&&
81 s
.num
!= VHOST_VRING_BIG_ENDIAN
)
84 if (s
.num
== VHOST_VRING_BIG_ENDIAN
)
85 vhost_enable_cross_endian_big(vq
);
87 vhost_enable_cross_endian_little(vq
);
92 static long vhost_get_vring_endian(struct vhost_virtqueue
*vq
, u32 idx
,
95 struct vhost_vring_state s
= {
100 if (copy_to_user(argp
, &s
, sizeof(s
)))
106 static void vhost_init_is_le(struct vhost_virtqueue
*vq
)
108 /* Note for legacy virtio: user_be is initialized at reset time
109 * according to the host endianness. If userspace does not set an
110 * explicit endianness, the default behavior is native endian, as
111 * expected by legacy virtio.
113 vq
->is_le
= vhost_has_feature(vq
, VIRTIO_F_VERSION_1
) || !vq
->user_be
;
116 static void vhost_disable_cross_endian(struct vhost_virtqueue
*vq
)
120 static long vhost_set_vring_endian(struct vhost_virtqueue
*vq
, int __user
*argp
)
125 static long vhost_get_vring_endian(struct vhost_virtqueue
*vq
, u32 idx
,
131 static void vhost_init_is_le(struct vhost_virtqueue
*vq
)
133 vq
->is_le
= vhost_has_feature(vq
, VIRTIO_F_VERSION_1
)
134 || virtio_legacy_is_little_endian();
136 #endif /* CONFIG_VHOST_CROSS_ENDIAN_LEGACY */
138 static void vhost_reset_is_le(struct vhost_virtqueue
*vq
)
140 vhost_init_is_le(vq
);
143 struct vhost_flush_struct
{
144 struct vhost_work work
;
145 struct completion wait_event
;
148 static void vhost_flush_work(struct vhost_work
*work
)
150 struct vhost_flush_struct
*s
;
152 s
= container_of(work
, struct vhost_flush_struct
, work
);
153 complete(&s
->wait_event
);
156 static void vhost_poll_func(struct file
*file
, wait_queue_head_t
*wqh
,
159 struct vhost_poll
*poll
;
161 poll
= container_of(pt
, struct vhost_poll
, table
);
163 add_wait_queue(wqh
, &poll
->wait
);
166 static int vhost_poll_wakeup(wait_queue_t
*wait
, unsigned mode
, int sync
,
169 struct vhost_poll
*poll
= container_of(wait
, struct vhost_poll
, wait
);
171 if (!((unsigned long)key
& poll
->mask
))
174 vhost_poll_queue(poll
);
178 void vhost_work_init(struct vhost_work
*work
, vhost_work_fn_t fn
)
180 clear_bit(VHOST_WORK_QUEUED
, &work
->flags
);
182 init_waitqueue_head(&work
->done
);
184 EXPORT_SYMBOL_GPL(vhost_work_init
);
186 /* Init poll structure */
187 void vhost_poll_init(struct vhost_poll
*poll
, vhost_work_fn_t fn
,
188 unsigned long mask
, struct vhost_dev
*dev
)
190 init_waitqueue_func_entry(&poll
->wait
, vhost_poll_wakeup
);
191 init_poll_funcptr(&poll
->table
, vhost_poll_func
);
196 vhost_work_init(&poll
->work
, fn
);
198 EXPORT_SYMBOL_GPL(vhost_poll_init
);
200 /* Start polling a file. We add ourselves to file's wait queue. The caller must
201 * keep a reference to a file until after vhost_poll_stop is called. */
202 int vhost_poll_start(struct vhost_poll
*poll
, struct file
*file
)
210 mask
= file
->f_op
->poll(file
, &poll
->table
);
212 vhost_poll_wakeup(&poll
->wait
, 0, 0, (void *)mask
);
213 if (mask
& POLLERR
) {
215 remove_wait_queue(poll
->wqh
, &poll
->wait
);
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_flush(struct vhost_dev
*dev
, struct vhost_work
*work
)
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_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_flush(poll
->dev
, &poll
->work
);
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.
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_reset(struct vhost_dev
*dev
,
286 struct vhost_virtqueue
*vq
)
292 vq
->last_avail_idx
= 0;
294 vq
->last_used_idx
= 0;
295 vq
->signalled_used
= 0;
296 vq
->signalled_used_valid
= false;
298 vq
->log_used
= false;
299 vq
->log_addr
= -1ull;
300 vq
->private_data
= NULL
;
301 vq
->acked_features
= 0;
303 vq
->error_ctx
= NULL
;
309 vhost_reset_is_le(vq
);
310 vhost_disable_cross_endian(vq
);
311 vq
->busyloop_timeout
= 0;
316 static int vhost_worker(void *data
)
318 struct vhost_dev
*dev
= data
;
319 struct vhost_work
*work
, *work_next
;
320 struct llist_node
*node
;
321 mm_segment_t oldfs
= get_fs();
327 /* mb paired w/ kthread_stop */
328 set_current_state(TASK_INTERRUPTIBLE
);
330 if (kthread_should_stop()) {
331 __set_current_state(TASK_RUNNING
);
335 node
= llist_del_all(&dev
->work_list
);
339 node
= llist_reverse_order(node
);
340 /* make sure flag is seen after deletion */
342 llist_for_each_entry_safe(work
, work_next
, node
, node
) {
343 clear_bit(VHOST_WORK_QUEUED
, &work
->flags
);
344 __set_current_state(TASK_RUNNING
);
355 static void vhost_vq_free_iovecs(struct vhost_virtqueue
*vq
)
365 /* Helper to allocate iovec buffers for all vqs. */
366 static long vhost_dev_alloc_iovecs(struct vhost_dev
*dev
)
368 struct vhost_virtqueue
*vq
;
371 for (i
= 0; i
< dev
->nvqs
; ++i
) {
373 vq
->indirect
= kmalloc(sizeof *vq
->indirect
* UIO_MAXIOV
,
375 vq
->log
= kmalloc(sizeof *vq
->log
* UIO_MAXIOV
, GFP_KERNEL
);
376 vq
->heads
= kmalloc(sizeof *vq
->heads
* UIO_MAXIOV
, GFP_KERNEL
);
377 if (!vq
->indirect
|| !vq
->log
|| !vq
->heads
)
384 vhost_vq_free_iovecs(dev
->vqs
[i
]);
388 static void vhost_dev_free_iovecs(struct vhost_dev
*dev
)
392 for (i
= 0; i
< dev
->nvqs
; ++i
)
393 vhost_vq_free_iovecs(dev
->vqs
[i
]);
396 void vhost_dev_init(struct vhost_dev
*dev
,
397 struct vhost_virtqueue
**vqs
, int nvqs
)
399 struct vhost_virtqueue
*vq
;
404 mutex_init(&dev
->mutex
);
406 dev
->log_file
= NULL
;
411 init_llist_head(&dev
->work_list
);
412 init_waitqueue_head(&dev
->wait
);
413 INIT_LIST_HEAD(&dev
->read_list
);
414 INIT_LIST_HEAD(&dev
->pending_list
);
415 spin_lock_init(&dev
->iotlb_lock
);
418 for (i
= 0; i
< dev
->nvqs
; ++i
) {
424 mutex_init(&vq
->mutex
);
425 vhost_vq_reset(dev
, vq
);
427 vhost_poll_init(&vq
->poll
, vq
->handle_kick
,
431 EXPORT_SYMBOL_GPL(vhost_dev_init
);
433 /* Caller should have device mutex */
434 long vhost_dev_check_owner(struct vhost_dev
*dev
)
436 /* Are you the owner? If not, I don't think you mean to do that */
437 return dev
->mm
== current
->mm
? 0 : -EPERM
;
439 EXPORT_SYMBOL_GPL(vhost_dev_check_owner
);
441 struct vhost_attach_cgroups_struct
{
442 struct vhost_work work
;
443 struct task_struct
*owner
;
447 static void vhost_attach_cgroups_work(struct vhost_work
*work
)
449 struct vhost_attach_cgroups_struct
*s
;
451 s
= container_of(work
, struct vhost_attach_cgroups_struct
, work
);
452 s
->ret
= cgroup_attach_task_all(s
->owner
, current
);
455 static int vhost_attach_cgroups(struct vhost_dev
*dev
)
457 struct vhost_attach_cgroups_struct attach
;
459 attach
.owner
= current
;
460 vhost_work_init(&attach
.work
, vhost_attach_cgroups_work
);
461 vhost_work_queue(dev
, &attach
.work
);
462 vhost_work_flush(dev
, &attach
.work
);
466 /* Caller should have device mutex */
467 bool vhost_dev_has_owner(struct vhost_dev
*dev
)
471 EXPORT_SYMBOL_GPL(vhost_dev_has_owner
);
473 /* Caller should have device mutex */
474 long vhost_dev_set_owner(struct vhost_dev
*dev
)
476 struct task_struct
*worker
;
479 /* Is there an owner already? */
480 if (vhost_dev_has_owner(dev
)) {
485 /* No owner, become one */
486 dev
->mm
= get_task_mm(current
);
487 worker
= kthread_create(vhost_worker
, dev
, "vhost-%d", current
->pid
);
488 if (IS_ERR(worker
)) {
489 err
= PTR_ERR(worker
);
493 dev
->worker
= worker
;
494 wake_up_process(worker
); /* avoid contributing to loadavg */
496 err
= vhost_attach_cgroups(dev
);
500 err
= vhost_dev_alloc_iovecs(dev
);
506 kthread_stop(worker
);
515 EXPORT_SYMBOL_GPL(vhost_dev_set_owner
);
517 static void *vhost_kvzalloc(unsigned long size
)
519 void *n
= kzalloc(size
, GFP_KERNEL
| __GFP_NOWARN
| __GFP_REPEAT
);
526 struct vhost_umem
*vhost_dev_reset_owner_prepare(void)
528 return vhost_kvzalloc(sizeof(struct vhost_umem
));
530 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare
);
532 /* Caller should have device mutex */
533 void vhost_dev_reset_owner(struct vhost_dev
*dev
, struct vhost_umem
*umem
)
537 vhost_dev_cleanup(dev
, true);
539 /* Restore memory to default empty mapping. */
540 INIT_LIST_HEAD(&umem
->umem_list
);
542 /* We don't need VQ locks below since vhost_dev_cleanup makes sure
543 * VQs aren't running.
545 for (i
= 0; i
< dev
->nvqs
; ++i
)
546 dev
->vqs
[i
]->umem
= umem
;
548 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner
);
550 void vhost_dev_stop(struct vhost_dev
*dev
)
554 for (i
= 0; i
< dev
->nvqs
; ++i
) {
555 if (dev
->vqs
[i
]->kick
&& dev
->vqs
[i
]->handle_kick
) {
556 vhost_poll_stop(&dev
->vqs
[i
]->poll
);
557 vhost_poll_flush(&dev
->vqs
[i
]->poll
);
561 EXPORT_SYMBOL_GPL(vhost_dev_stop
);
563 static void vhost_umem_free(struct vhost_umem
*umem
,
564 struct vhost_umem_node
*node
)
566 vhost_umem_interval_tree_remove(node
, &umem
->umem_tree
);
567 list_del(&node
->link
);
572 static void vhost_umem_clean(struct vhost_umem
*umem
)
574 struct vhost_umem_node
*node
, *tmp
;
579 list_for_each_entry_safe(node
, tmp
, &umem
->umem_list
, link
)
580 vhost_umem_free(umem
, node
);
585 static void vhost_clear_msg(struct vhost_dev
*dev
)
587 struct vhost_msg_node
*node
, *n
;
589 spin_lock(&dev
->iotlb_lock
);
591 list_for_each_entry_safe(node
, n
, &dev
->read_list
, node
) {
592 list_del(&node
->node
);
596 list_for_each_entry_safe(node
, n
, &dev
->pending_list
, node
) {
597 list_del(&node
->node
);
601 spin_unlock(&dev
->iotlb_lock
);
604 /* Caller should have device mutex if and only if locked is set */
605 void vhost_dev_cleanup(struct vhost_dev
*dev
, bool locked
)
609 for (i
= 0; i
< dev
->nvqs
; ++i
) {
610 if (dev
->vqs
[i
]->error_ctx
)
611 eventfd_ctx_put(dev
->vqs
[i
]->error_ctx
);
612 if (dev
->vqs
[i
]->error
)
613 fput(dev
->vqs
[i
]->error
);
614 if (dev
->vqs
[i
]->kick
)
615 fput(dev
->vqs
[i
]->kick
);
616 if (dev
->vqs
[i
]->call_ctx
)
617 eventfd_ctx_put(dev
->vqs
[i
]->call_ctx
);
618 if (dev
->vqs
[i
]->call
)
619 fput(dev
->vqs
[i
]->call
);
620 vhost_vq_reset(dev
, dev
->vqs
[i
]);
622 vhost_dev_free_iovecs(dev
);
624 eventfd_ctx_put(dev
->log_ctx
);
628 dev
->log_file
= NULL
;
629 /* No one will access memory at this point */
630 vhost_umem_clean(dev
->umem
);
632 vhost_umem_clean(dev
->iotlb
);
634 vhost_clear_msg(dev
);
635 wake_up_interruptible_poll(&dev
->wait
, POLLIN
| POLLRDNORM
);
636 WARN_ON(!llist_empty(&dev
->work_list
));
638 kthread_stop(dev
->worker
);
645 EXPORT_SYMBOL_GPL(vhost_dev_cleanup
);
647 static int log_access_ok(void __user
*log_base
, u64 addr
, unsigned long sz
)
649 u64 a
= addr
/ VHOST_PAGE_SIZE
/ 8;
651 /* Make sure 64 bit math will not overflow. */
652 if (a
> ULONG_MAX
- (unsigned long)log_base
||
653 a
+ (unsigned long)log_base
> ULONG_MAX
)
656 return access_ok(VERIFY_WRITE
, log_base
+ a
,
657 (sz
+ VHOST_PAGE_SIZE
* 8 - 1) / VHOST_PAGE_SIZE
/ 8);
660 static bool vhost_overflow(u64 uaddr
, u64 size
)
662 /* Make sure 64 bit math will not overflow. */
663 return uaddr
> ULONG_MAX
|| size
> ULONG_MAX
|| uaddr
> ULONG_MAX
- size
;
666 /* Caller should have vq mutex and device mutex. */
667 static int vq_memory_access_ok(void __user
*log_base
, struct vhost_umem
*umem
,
670 struct vhost_umem_node
*node
;
675 list_for_each_entry(node
, &umem
->umem_list
, link
) {
676 unsigned long a
= node
->userspace_addr
;
678 if (vhost_overflow(node
->userspace_addr
, node
->size
))
682 if (!access_ok(VERIFY_WRITE
, (void __user
*)a
,
685 else if (log_all
&& !log_access_ok(log_base
,
693 /* Can we switch to this memory table? */
694 /* Caller should have device mutex but not vq mutex */
695 static int memory_access_ok(struct vhost_dev
*d
, struct vhost_umem
*umem
,
700 for (i
= 0; i
< d
->nvqs
; ++i
) {
704 mutex_lock(&d
->vqs
[i
]->mutex
);
705 log
= log_all
|| vhost_has_feature(d
->vqs
[i
], VHOST_F_LOG_ALL
);
706 /* If ring is inactive, will check when it's enabled. */
707 if (d
->vqs
[i
]->private_data
)
708 ok
= vq_memory_access_ok(d
->vqs
[i
]->log_base
,
712 mutex_unlock(&d
->vqs
[i
]->mutex
);
719 static int translate_desc(struct vhost_virtqueue
*vq
, u64 addr
, u32 len
,
720 struct iovec iov
[], int iov_size
, int access
);
722 static int vhost_copy_to_user(struct vhost_virtqueue
*vq
, void *to
,
723 const void *from
, unsigned size
)
728 return __copy_to_user(to
, from
, size
);
730 /* This function should be called after iotlb
731 * prefetch, which means we're sure that all vq
732 * could be access through iotlb. So -EAGAIN should
733 * not happen in this case.
735 /* TODO: more fast path */
737 ret
= translate_desc(vq
, (u64
)(uintptr_t)to
, size
, vq
->iotlb_iov
,
738 ARRAY_SIZE(vq
->iotlb_iov
),
742 iov_iter_init(&t
, WRITE
, vq
->iotlb_iov
, ret
, size
);
743 ret
= copy_to_iter(from
, size
, &t
);
751 static int vhost_copy_from_user(struct vhost_virtqueue
*vq
, void *to
,
752 void *from
, unsigned size
)
757 return __copy_from_user(to
, from
, size
);
759 /* This function should be called after iotlb
760 * prefetch, which means we're sure that vq
761 * could be access through iotlb. So -EAGAIN should
762 * not happen in this case.
764 /* TODO: more fast path */
766 ret
= translate_desc(vq
, (u64
)(uintptr_t)from
, size
, vq
->iotlb_iov
,
767 ARRAY_SIZE(vq
->iotlb_iov
),
770 vq_err(vq
, "IOTLB translation failure: uaddr "
771 "%p size 0x%llx\n", from
,
772 (unsigned long long) size
);
775 iov_iter_init(&f
, READ
, vq
->iotlb_iov
, ret
, size
);
776 ret
= copy_from_iter(to
, size
, &f
);
785 static void __user
*__vhost_get_user(struct vhost_virtqueue
*vq
,
786 void *addr
, unsigned size
)
790 /* This function should be called after iotlb
791 * prefetch, which means we're sure that vq
792 * could be access through iotlb. So -EAGAIN should
793 * not happen in this case.
795 /* TODO: more fast path */
796 ret
= translate_desc(vq
, (u64
)(uintptr_t)addr
, size
, vq
->iotlb_iov
,
797 ARRAY_SIZE(vq
->iotlb_iov
),
800 vq_err(vq
, "IOTLB translation failure: uaddr "
801 "%p size 0x%llx\n", addr
,
802 (unsigned long long) size
);
806 if (ret
!= 1 || vq
->iotlb_iov
[0].iov_len
!= size
) {
807 vq_err(vq
, "Non atomic userspace memory access: uaddr "
808 "%p size 0x%llx\n", addr
,
809 (unsigned long long) size
);
813 return vq
->iotlb_iov
[0].iov_base
;
816 #define vhost_put_user(vq, x, ptr) \
820 ret = __put_user(x, ptr); \
822 __typeof__(ptr) to = \
823 (__typeof__(ptr)) __vhost_get_user(vq, ptr, sizeof(*ptr)); \
825 ret = __put_user(x, to); \
832 #define vhost_get_user(vq, x, ptr) \
836 ret = __get_user(x, ptr); \
838 __typeof__(ptr) from = \
839 (__typeof__(ptr)) __vhost_get_user(vq, ptr, sizeof(*ptr)); \
841 ret = __get_user(x, from); \
848 static void vhost_dev_lock_vqs(struct vhost_dev
*d
)
851 for (i
= 0; i
< d
->nvqs
; ++i
)
852 mutex_lock(&d
->vqs
[i
]->mutex
);
855 static void vhost_dev_unlock_vqs(struct vhost_dev
*d
)
858 for (i
= 0; i
< d
->nvqs
; ++i
)
859 mutex_unlock(&d
->vqs
[i
]->mutex
);
862 static int vhost_new_umem_range(struct vhost_umem
*umem
,
863 u64 start
, u64 size
, u64 end
,
864 u64 userspace_addr
, int perm
)
866 struct vhost_umem_node
*tmp
, *node
= kmalloc(sizeof(*node
), GFP_ATOMIC
);
871 if (umem
->numem
== max_iotlb_entries
) {
872 tmp
= list_first_entry(&umem
->umem_list
, typeof(*tmp
), link
);
873 vhost_umem_free(umem
, tmp
);
879 node
->userspace_addr
= userspace_addr
;
881 INIT_LIST_HEAD(&node
->link
);
882 list_add_tail(&node
->link
, &umem
->umem_list
);
883 vhost_umem_interval_tree_insert(node
, &umem
->umem_tree
);
889 static void vhost_del_umem_range(struct vhost_umem
*umem
,
892 struct vhost_umem_node
*node
;
894 while ((node
= vhost_umem_interval_tree_iter_first(&umem
->umem_tree
,
896 vhost_umem_free(umem
, node
);
899 static void vhost_iotlb_notify_vq(struct vhost_dev
*d
,
900 struct vhost_iotlb_msg
*msg
)
902 struct vhost_msg_node
*node
, *n
;
904 spin_lock(&d
->iotlb_lock
);
906 list_for_each_entry_safe(node
, n
, &d
->pending_list
, node
) {
907 struct vhost_iotlb_msg
*vq_msg
= &node
->msg
.iotlb
;
908 if (msg
->iova
<= vq_msg
->iova
&&
909 msg
->iova
+ msg
->size
- 1 > vq_msg
->iova
&&
910 vq_msg
->type
== VHOST_IOTLB_MISS
) {
911 vhost_poll_queue(&node
->vq
->poll
);
912 list_del(&node
->node
);
917 spin_unlock(&d
->iotlb_lock
);
920 static int umem_access_ok(u64 uaddr
, u64 size
, int access
)
922 unsigned long a
= uaddr
;
924 /* Make sure 64 bit math will not overflow. */
925 if (vhost_overflow(uaddr
, size
))
928 if ((access
& VHOST_ACCESS_RO
) &&
929 !access_ok(VERIFY_READ
, (void __user
*)a
, size
))
931 if ((access
& VHOST_ACCESS_WO
) &&
932 !access_ok(VERIFY_WRITE
, (void __user
*)a
, size
))
937 int vhost_process_iotlb_msg(struct vhost_dev
*dev
,
938 struct vhost_iotlb_msg
*msg
)
942 vhost_dev_lock_vqs(dev
);
944 case VHOST_IOTLB_UPDATE
:
949 if (umem_access_ok(msg
->uaddr
, msg
->size
, msg
->perm
)) {
953 if (vhost_new_umem_range(dev
->iotlb
, msg
->iova
, msg
->size
,
954 msg
->iova
+ msg
->size
- 1,
955 msg
->uaddr
, msg
->perm
)) {
959 vhost_iotlb_notify_vq(dev
, msg
);
961 case VHOST_IOTLB_INVALIDATE
:
962 vhost_del_umem_range(dev
->iotlb
, msg
->iova
,
963 msg
->iova
+ msg
->size
- 1);
970 vhost_dev_unlock_vqs(dev
);
973 ssize_t
vhost_chr_write_iter(struct vhost_dev
*dev
,
974 struct iov_iter
*from
)
976 struct vhost_msg_node node
;
977 unsigned size
= sizeof(struct vhost_msg
);
981 if (iov_iter_count(from
) < size
)
983 ret
= copy_from_iter(&node
.msg
, size
, from
);
987 switch (node
.msg
.type
) {
988 case VHOST_IOTLB_MSG
:
989 err
= vhost_process_iotlb_msg(dev
, &node
.msg
.iotlb
);
1001 EXPORT_SYMBOL(vhost_chr_write_iter
);
1003 unsigned int vhost_chr_poll(struct file
*file
, struct vhost_dev
*dev
,
1006 unsigned int mask
= 0;
1008 poll_wait(file
, &dev
->wait
, wait
);
1010 if (!list_empty(&dev
->read_list
))
1011 mask
|= POLLIN
| POLLRDNORM
;
1015 EXPORT_SYMBOL(vhost_chr_poll
);
1017 ssize_t
vhost_chr_read_iter(struct vhost_dev
*dev
, struct iov_iter
*to
,
1021 struct vhost_msg_node
*node
;
1023 unsigned size
= sizeof(struct vhost_msg
);
1025 if (iov_iter_count(to
) < size
)
1030 prepare_to_wait(&dev
->wait
, &wait
,
1031 TASK_INTERRUPTIBLE
);
1033 node
= vhost_dequeue_msg(dev
, &dev
->read_list
);
1040 if (signal_pending(current
)) {
1053 finish_wait(&dev
->wait
, &wait
);
1056 ret
= copy_to_iter(&node
->msg
, size
, to
);
1058 if (ret
!= size
|| node
->msg
.type
!= VHOST_IOTLB_MISS
) {
1063 vhost_enqueue_msg(dev
, &dev
->pending_list
, node
);
1068 EXPORT_SYMBOL_GPL(vhost_chr_read_iter
);
1070 static int vhost_iotlb_miss(struct vhost_virtqueue
*vq
, u64 iova
, int access
)
1072 struct vhost_dev
*dev
= vq
->dev
;
1073 struct vhost_msg_node
*node
;
1074 struct vhost_iotlb_msg
*msg
;
1076 node
= vhost_new_msg(vq
, VHOST_IOTLB_MISS
);
1080 msg
= &node
->msg
.iotlb
;
1081 msg
->type
= VHOST_IOTLB_MISS
;
1085 vhost_enqueue_msg(dev
, &dev
->read_list
, node
);
1090 static int vq_access_ok(struct vhost_virtqueue
*vq
, unsigned int num
,
1091 struct vring_desc __user
*desc
,
1092 struct vring_avail __user
*avail
,
1093 struct vring_used __user
*used
)
1096 size_t s
= vhost_has_feature(vq
, VIRTIO_RING_F_EVENT_IDX
) ? 2 : 0;
1098 return access_ok(VERIFY_READ
, desc
, num
* sizeof *desc
) &&
1099 access_ok(VERIFY_READ
, avail
,
1100 sizeof *avail
+ num
* sizeof *avail
->ring
+ s
) &&
1101 access_ok(VERIFY_WRITE
, used
,
1102 sizeof *used
+ num
* sizeof *used
->ring
+ s
);
1105 static int iotlb_access_ok(struct vhost_virtqueue
*vq
,
1106 int access
, u64 addr
, u64 len
)
1108 const struct vhost_umem_node
*node
;
1109 struct vhost_umem
*umem
= vq
->iotlb
;
1113 node
= vhost_umem_interval_tree_iter_first(&umem
->umem_tree
,
1116 if (node
== NULL
|| node
->start
> addr
) {
1117 vhost_iotlb_miss(vq
, addr
, access
);
1119 } else if (!(node
->perm
& access
)) {
1120 /* Report the possible access violation by
1121 * request another translation from userspace.
1126 size
= node
->size
- addr
+ node
->start
;
1134 int vq_iotlb_prefetch(struct vhost_virtqueue
*vq
)
1136 size_t s
= vhost_has_feature(vq
, VIRTIO_RING_F_EVENT_IDX
) ? 2 : 0;
1137 unsigned int num
= vq
->num
;
1142 return iotlb_access_ok(vq
, VHOST_ACCESS_RO
, (u64
)(uintptr_t)vq
->desc
,
1143 num
* sizeof *vq
->desc
) &&
1144 iotlb_access_ok(vq
, VHOST_ACCESS_RO
, (u64
)(uintptr_t)vq
->avail
,
1146 num
* sizeof *vq
->avail
->ring
+ s
) &&
1147 iotlb_access_ok(vq
, VHOST_ACCESS_WO
, (u64
)(uintptr_t)vq
->used
,
1149 num
* sizeof *vq
->used
->ring
+ s
);
1151 EXPORT_SYMBOL_GPL(vq_iotlb_prefetch
);
1153 /* Can we log writes? */
1154 /* Caller should have device mutex but not vq mutex */
1155 int vhost_log_access_ok(struct vhost_dev
*dev
)
1157 return memory_access_ok(dev
, dev
->umem
, 1);
1159 EXPORT_SYMBOL_GPL(vhost_log_access_ok
);
1161 /* Verify access for write logging. */
1162 /* Caller should have vq mutex and device mutex */
1163 static int vq_log_access_ok(struct vhost_virtqueue
*vq
,
1164 void __user
*log_base
)
1166 size_t s
= vhost_has_feature(vq
, VIRTIO_RING_F_EVENT_IDX
) ? 2 : 0;
1168 return vq_memory_access_ok(log_base
, vq
->umem
,
1169 vhost_has_feature(vq
, VHOST_F_LOG_ALL
)) &&
1170 (!vq
->log_used
|| log_access_ok(log_base
, vq
->log_addr
,
1172 vq
->num
* sizeof *vq
->used
->ring
+ s
));
1175 /* Can we start vq? */
1176 /* Caller should have vq mutex and device mutex */
1177 int vhost_vq_access_ok(struct vhost_virtqueue
*vq
)
1180 /* When device IOTLB was used, the access validation
1181 * will be validated during prefetching.
1185 return vq_access_ok(vq
, vq
->num
, vq
->desc
, vq
->avail
, vq
->used
) &&
1186 vq_log_access_ok(vq
, vq
->log_base
);
1188 EXPORT_SYMBOL_GPL(vhost_vq_access_ok
);
1190 static struct vhost_umem
*vhost_umem_alloc(void)
1192 struct vhost_umem
*umem
= vhost_kvzalloc(sizeof(*umem
));
1197 umem
->umem_tree
= RB_ROOT
;
1199 INIT_LIST_HEAD(&umem
->umem_list
);
1204 static long vhost_set_memory(struct vhost_dev
*d
, struct vhost_memory __user
*m
)
1206 struct vhost_memory mem
, *newmem
;
1207 struct vhost_memory_region
*region
;
1208 struct vhost_umem
*newumem
, *oldumem
;
1209 unsigned long size
= offsetof(struct vhost_memory
, regions
);
1212 if (copy_from_user(&mem
, m
, size
))
1216 if (mem
.nregions
> max_mem_regions
)
1218 newmem
= vhost_kvzalloc(size
+ mem
.nregions
* sizeof(*m
->regions
));
1222 memcpy(newmem
, &mem
, size
);
1223 if (copy_from_user(newmem
->regions
, m
->regions
,
1224 mem
.nregions
* sizeof *m
->regions
)) {
1229 newumem
= vhost_umem_alloc();
1235 for (region
= newmem
->regions
;
1236 region
< newmem
->regions
+ mem
.nregions
;
1238 if (vhost_new_umem_range(newumem
,
1239 region
->guest_phys_addr
,
1240 region
->memory_size
,
1241 region
->guest_phys_addr
+
1242 region
->memory_size
- 1,
1243 region
->userspace_addr
,
1248 if (!memory_access_ok(d
, newumem
, 0))
1254 /* All memory accesses are done under some VQ mutex. */
1255 for (i
= 0; i
< d
->nvqs
; ++i
) {
1256 mutex_lock(&d
->vqs
[i
]->mutex
);
1257 d
->vqs
[i
]->umem
= newumem
;
1258 mutex_unlock(&d
->vqs
[i
]->mutex
);
1262 vhost_umem_clean(oldumem
);
1266 vhost_umem_clean(newumem
);
1271 long vhost_vring_ioctl(struct vhost_dev
*d
, int ioctl
, void __user
*argp
)
1273 struct file
*eventfp
, *filep
= NULL
;
1274 bool pollstart
= false, pollstop
= false;
1275 struct eventfd_ctx
*ctx
= NULL
;
1276 u32 __user
*idxp
= argp
;
1277 struct vhost_virtqueue
*vq
;
1278 struct vhost_vring_state s
;
1279 struct vhost_vring_file f
;
1280 struct vhost_vring_addr a
;
1284 r
= get_user(idx
, idxp
);
1292 mutex_lock(&vq
->mutex
);
1295 case VHOST_SET_VRING_NUM
:
1296 /* Resizing ring with an active backend?
1297 * You don't want to do that. */
1298 if (vq
->private_data
) {
1302 if (copy_from_user(&s
, argp
, sizeof s
)) {
1306 if (!s
.num
|| s
.num
> 0xffff || (s
.num
& (s
.num
- 1))) {
1312 case VHOST_SET_VRING_BASE
:
1313 /* Moving base with an active backend?
1314 * You don't want to do that. */
1315 if (vq
->private_data
) {
1319 if (copy_from_user(&s
, argp
, sizeof s
)) {
1323 if (s
.num
> 0xffff) {
1327 vq
->last_avail_idx
= s
.num
;
1328 /* Forget the cached index value. */
1329 vq
->avail_idx
= vq
->last_avail_idx
;
1331 case VHOST_GET_VRING_BASE
:
1333 s
.num
= vq
->last_avail_idx
;
1334 if (copy_to_user(argp
, &s
, sizeof s
))
1337 case VHOST_SET_VRING_ADDR
:
1338 if (copy_from_user(&a
, argp
, sizeof a
)) {
1342 if (a
.flags
& ~(0x1 << VHOST_VRING_F_LOG
)) {
1346 /* For 32bit, verify that the top 32bits of the user
1347 data are set to zero. */
1348 if ((u64
)(unsigned long)a
.desc_user_addr
!= a
.desc_user_addr
||
1349 (u64
)(unsigned long)a
.used_user_addr
!= a
.used_user_addr
||
1350 (u64
)(unsigned long)a
.avail_user_addr
!= a
.avail_user_addr
) {
1355 /* Make sure it's safe to cast pointers to vring types. */
1356 BUILD_BUG_ON(__alignof__
*vq
->avail
> VRING_AVAIL_ALIGN_SIZE
);
1357 BUILD_BUG_ON(__alignof__
*vq
->used
> VRING_USED_ALIGN_SIZE
);
1358 if ((a
.avail_user_addr
& (VRING_AVAIL_ALIGN_SIZE
- 1)) ||
1359 (a
.used_user_addr
& (VRING_USED_ALIGN_SIZE
- 1)) ||
1360 (a
.log_guest_addr
& (VRING_USED_ALIGN_SIZE
- 1))) {
1365 /* We only verify access here if backend is configured.
1366 * If it is not, we don't as size might not have been setup.
1367 * We will verify when backend is configured. */
1368 if (vq
->private_data
) {
1369 if (!vq_access_ok(vq
, vq
->num
,
1370 (void __user
*)(unsigned long)a
.desc_user_addr
,
1371 (void __user
*)(unsigned long)a
.avail_user_addr
,
1372 (void __user
*)(unsigned long)a
.used_user_addr
)) {
1377 /* Also validate log access for used ring if enabled. */
1378 if ((a
.flags
& (0x1 << VHOST_VRING_F_LOG
)) &&
1379 !log_access_ok(vq
->log_base
, a
.log_guest_addr
,
1381 vq
->num
* sizeof *vq
->used
->ring
)) {
1387 vq
->log_used
= !!(a
.flags
& (0x1 << VHOST_VRING_F_LOG
));
1388 vq
->desc
= (void __user
*)(unsigned long)a
.desc_user_addr
;
1389 vq
->avail
= (void __user
*)(unsigned long)a
.avail_user_addr
;
1390 vq
->log_addr
= a
.log_guest_addr
;
1391 vq
->used
= (void __user
*)(unsigned long)a
.used_user_addr
;
1393 case VHOST_SET_VRING_KICK
:
1394 if (copy_from_user(&f
, argp
, sizeof f
)) {
1398 eventfp
= f
.fd
== -1 ? NULL
: eventfd_fget(f
.fd
);
1399 if (IS_ERR(eventfp
)) {
1400 r
= PTR_ERR(eventfp
);
1403 if (eventfp
!= vq
->kick
) {
1404 pollstop
= (filep
= vq
->kick
) != NULL
;
1405 pollstart
= (vq
->kick
= eventfp
) != NULL
;
1409 case VHOST_SET_VRING_CALL
:
1410 if (copy_from_user(&f
, argp
, sizeof f
)) {
1414 eventfp
= f
.fd
== -1 ? NULL
: eventfd_fget(f
.fd
);
1415 if (IS_ERR(eventfp
)) {
1416 r
= PTR_ERR(eventfp
);
1419 if (eventfp
!= vq
->call
) {
1423 vq
->call_ctx
= eventfp
?
1424 eventfd_ctx_fileget(eventfp
) : NULL
;
1428 case VHOST_SET_VRING_ERR
:
1429 if (copy_from_user(&f
, argp
, sizeof f
)) {
1433 eventfp
= f
.fd
== -1 ? NULL
: eventfd_fget(f
.fd
);
1434 if (IS_ERR(eventfp
)) {
1435 r
= PTR_ERR(eventfp
);
1438 if (eventfp
!= vq
->error
) {
1440 vq
->error
= eventfp
;
1441 ctx
= vq
->error_ctx
;
1442 vq
->error_ctx
= eventfp
?
1443 eventfd_ctx_fileget(eventfp
) : NULL
;
1447 case VHOST_SET_VRING_ENDIAN
:
1448 r
= vhost_set_vring_endian(vq
, argp
);
1450 case VHOST_GET_VRING_ENDIAN
:
1451 r
= vhost_get_vring_endian(vq
, idx
, argp
);
1453 case VHOST_SET_VRING_BUSYLOOP_TIMEOUT
:
1454 if (copy_from_user(&s
, argp
, sizeof(s
))) {
1458 vq
->busyloop_timeout
= s
.num
;
1460 case VHOST_GET_VRING_BUSYLOOP_TIMEOUT
:
1462 s
.num
= vq
->busyloop_timeout
;
1463 if (copy_to_user(argp
, &s
, sizeof(s
)))
1470 if (pollstop
&& vq
->handle_kick
)
1471 vhost_poll_stop(&vq
->poll
);
1474 eventfd_ctx_put(ctx
);
1478 if (pollstart
&& vq
->handle_kick
)
1479 r
= vhost_poll_start(&vq
->poll
, vq
->kick
);
1481 mutex_unlock(&vq
->mutex
);
1483 if (pollstop
&& vq
->handle_kick
)
1484 vhost_poll_flush(&vq
->poll
);
1487 EXPORT_SYMBOL_GPL(vhost_vring_ioctl
);
1489 int vhost_init_device_iotlb(struct vhost_dev
*d
, bool enabled
)
1491 struct vhost_umem
*niotlb
, *oiotlb
;
1494 niotlb
= vhost_umem_alloc();
1501 for (i
= 0; i
< d
->nvqs
; ++i
) {
1502 mutex_lock(&d
->vqs
[i
]->mutex
);
1503 d
->vqs
[i
]->iotlb
= niotlb
;
1504 mutex_unlock(&d
->vqs
[i
]->mutex
);
1507 vhost_umem_clean(oiotlb
);
1511 EXPORT_SYMBOL_GPL(vhost_init_device_iotlb
);
1513 /* Caller must have device mutex */
1514 long vhost_dev_ioctl(struct vhost_dev
*d
, unsigned int ioctl
, void __user
*argp
)
1516 struct file
*eventfp
, *filep
= NULL
;
1517 struct eventfd_ctx
*ctx
= NULL
;
1522 /* If you are not the owner, you can become one */
1523 if (ioctl
== VHOST_SET_OWNER
) {
1524 r
= vhost_dev_set_owner(d
);
1528 /* You must be the owner to do anything else */
1529 r
= vhost_dev_check_owner(d
);
1534 case VHOST_SET_MEM_TABLE
:
1535 r
= vhost_set_memory(d
, argp
);
1537 case VHOST_SET_LOG_BASE
:
1538 if (copy_from_user(&p
, argp
, sizeof p
)) {
1542 if ((u64
)(unsigned long)p
!= p
) {
1546 for (i
= 0; i
< d
->nvqs
; ++i
) {
1547 struct vhost_virtqueue
*vq
;
1548 void __user
*base
= (void __user
*)(unsigned long)p
;
1550 mutex_lock(&vq
->mutex
);
1551 /* If ring is inactive, will check when it's enabled. */
1552 if (vq
->private_data
&& !vq_log_access_ok(vq
, base
))
1555 vq
->log_base
= base
;
1556 mutex_unlock(&vq
->mutex
);
1559 case VHOST_SET_LOG_FD
:
1560 r
= get_user(fd
, (int __user
*)argp
);
1563 eventfp
= fd
== -1 ? NULL
: eventfd_fget(fd
);
1564 if (IS_ERR(eventfp
)) {
1565 r
= PTR_ERR(eventfp
);
1568 if (eventfp
!= d
->log_file
) {
1569 filep
= d
->log_file
;
1570 d
->log_file
= eventfp
;
1572 d
->log_ctx
= eventfp
?
1573 eventfd_ctx_fileget(eventfp
) : NULL
;
1576 for (i
= 0; i
< d
->nvqs
; ++i
) {
1577 mutex_lock(&d
->vqs
[i
]->mutex
);
1578 d
->vqs
[i
]->log_ctx
= d
->log_ctx
;
1579 mutex_unlock(&d
->vqs
[i
]->mutex
);
1582 eventfd_ctx_put(ctx
);
1593 EXPORT_SYMBOL_GPL(vhost_dev_ioctl
);
1595 /* TODO: This is really inefficient. We need something like get_user()
1596 * (instruction directly accesses the data, with an exception table entry
1597 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
1599 static int set_bit_to_user(int nr
, void __user
*addr
)
1601 unsigned long log
= (unsigned long)addr
;
1604 int bit
= nr
+ (log
% PAGE_SIZE
) * 8;
1607 r
= get_user_pages_fast(log
, 1, 1, &page
);
1611 base
= kmap_atomic(page
);
1613 kunmap_atomic(base
);
1614 set_page_dirty_lock(page
);
1619 static int log_write(void __user
*log_base
,
1620 u64 write_address
, u64 write_length
)
1622 u64 write_page
= write_address
/ VHOST_PAGE_SIZE
;
1627 write_length
+= write_address
% VHOST_PAGE_SIZE
;
1629 u64 base
= (u64
)(unsigned long)log_base
;
1630 u64 log
= base
+ write_page
/ 8;
1631 int bit
= write_page
% 8;
1632 if ((u64
)(unsigned long)log
!= log
)
1634 r
= set_bit_to_user(bit
, (void __user
*)(unsigned long)log
);
1637 if (write_length
<= VHOST_PAGE_SIZE
)
1639 write_length
-= VHOST_PAGE_SIZE
;
1645 int vhost_log_write(struct vhost_virtqueue
*vq
, struct vhost_log
*log
,
1646 unsigned int log_num
, u64 len
)
1650 /* Make sure data written is seen before log. */
1652 for (i
= 0; i
< log_num
; ++i
) {
1653 u64 l
= min(log
[i
].len
, len
);
1654 r
= log_write(vq
->log_base
, log
[i
].addr
, l
);
1660 eventfd_signal(vq
->log_ctx
, 1);
1664 /* Length written exceeds what we have stored. This is a bug. */
1668 EXPORT_SYMBOL_GPL(vhost_log_write
);
1670 static int vhost_update_used_flags(struct vhost_virtqueue
*vq
)
1673 if (vhost_put_user(vq
, cpu_to_vhost16(vq
, vq
->used_flags
),
1674 &vq
->used
->flags
) < 0)
1676 if (unlikely(vq
->log_used
)) {
1677 /* Make sure the flag is seen before log. */
1679 /* Log used flag write. */
1680 used
= &vq
->used
->flags
;
1681 log_write(vq
->log_base
, vq
->log_addr
+
1682 (used
- (void __user
*)vq
->used
),
1683 sizeof vq
->used
->flags
);
1685 eventfd_signal(vq
->log_ctx
, 1);
1690 static int vhost_update_avail_event(struct vhost_virtqueue
*vq
, u16 avail_event
)
1692 if (vhost_put_user(vq
, cpu_to_vhost16(vq
, vq
->avail_idx
),
1693 vhost_avail_event(vq
)))
1695 if (unlikely(vq
->log_used
)) {
1697 /* Make sure the event is seen before log. */
1699 /* Log avail event write */
1700 used
= vhost_avail_event(vq
);
1701 log_write(vq
->log_base
, vq
->log_addr
+
1702 (used
- (void __user
*)vq
->used
),
1703 sizeof *vhost_avail_event(vq
));
1705 eventfd_signal(vq
->log_ctx
, 1);
1710 int vhost_vq_init_access(struct vhost_virtqueue
*vq
)
1712 __virtio16 last_used_idx
;
1714 bool is_le
= vq
->is_le
;
1716 if (!vq
->private_data
)
1719 vhost_init_is_le(vq
);
1721 r
= vhost_update_used_flags(vq
);
1724 vq
->signalled_used_valid
= false;
1726 !access_ok(VERIFY_READ
, &vq
->used
->idx
, sizeof vq
->used
->idx
)) {
1730 r
= vhost_get_user(vq
, last_used_idx
, &vq
->used
->idx
);
1732 vq_err(vq
, "Can't access used idx at %p\n",
1736 vq
->last_used_idx
= vhost16_to_cpu(vq
, last_used_idx
);
1743 EXPORT_SYMBOL_GPL(vhost_vq_init_access
);
1745 static int translate_desc(struct vhost_virtqueue
*vq
, u64 addr
, u32 len
,
1746 struct iovec iov
[], int iov_size
, int access
)
1748 const struct vhost_umem_node
*node
;
1749 struct vhost_dev
*dev
= vq
->dev
;
1750 struct vhost_umem
*umem
= dev
->iotlb
? dev
->iotlb
: dev
->umem
;
1755 while ((u64
)len
> s
) {
1757 if (unlikely(ret
>= iov_size
)) {
1762 node
= vhost_umem_interval_tree_iter_first(&umem
->umem_tree
,
1763 addr
, addr
+ len
- 1);
1764 if (node
== NULL
|| node
->start
> addr
) {
1765 if (umem
!= dev
->iotlb
) {
1771 } else if (!(node
->perm
& access
)) {
1777 size
= node
->size
- addr
+ node
->start
;
1778 _iov
->iov_len
= min((u64
)len
- s
, size
);
1779 _iov
->iov_base
= (void __user
*)(unsigned long)
1780 (node
->userspace_addr
+ addr
- node
->start
);
1787 vhost_iotlb_miss(vq
, addr
, access
);
1791 /* Each buffer in the virtqueues is actually a chain of descriptors. This
1792 * function returns the next descriptor in the chain,
1793 * or -1U if we're at the end. */
1794 static unsigned next_desc(struct vhost_virtqueue
*vq
, struct vring_desc
*desc
)
1798 /* If this descriptor says it doesn't chain, we're done. */
1799 if (!(desc
->flags
& cpu_to_vhost16(vq
, VRING_DESC_F_NEXT
)))
1802 /* Check they're not leading us off end of descriptors. */
1803 next
= vhost16_to_cpu(vq
, desc
->next
);
1804 /* Make sure compiler knows to grab that: we don't want it changing! */
1805 /* We will use the result as an index in an array, so most
1806 * architectures only need a compiler barrier here. */
1807 read_barrier_depends();
1812 static int get_indirect(struct vhost_virtqueue
*vq
,
1813 struct iovec iov
[], unsigned int iov_size
,
1814 unsigned int *out_num
, unsigned int *in_num
,
1815 struct vhost_log
*log
, unsigned int *log_num
,
1816 struct vring_desc
*indirect
)
1818 struct vring_desc desc
;
1819 unsigned int i
= 0, count
, found
= 0;
1820 u32 len
= vhost32_to_cpu(vq
, indirect
->len
);
1821 struct iov_iter from
;
1825 if (unlikely(len
% sizeof desc
)) {
1826 vq_err(vq
, "Invalid length in indirect descriptor: "
1827 "len 0x%llx not multiple of 0x%zx\n",
1828 (unsigned long long)len
,
1833 ret
= translate_desc(vq
, vhost64_to_cpu(vq
, indirect
->addr
), len
, vq
->indirect
,
1834 UIO_MAXIOV
, VHOST_ACCESS_RO
);
1835 if (unlikely(ret
< 0)) {
1837 vq_err(vq
, "Translation failure %d in indirect.\n", ret
);
1840 iov_iter_init(&from
, READ
, vq
->indirect
, ret
, len
);
1842 /* We will use the result as an address to read from, so most
1843 * architectures only need a compiler barrier here. */
1844 read_barrier_depends();
1846 count
= len
/ sizeof desc
;
1847 /* Buffers are chained via a 16 bit next field, so
1848 * we can have at most 2^16 of these. */
1849 if (unlikely(count
> USHRT_MAX
+ 1)) {
1850 vq_err(vq
, "Indirect buffer length too big: %d\n",
1856 unsigned iov_count
= *in_num
+ *out_num
;
1857 if (unlikely(++found
> count
)) {
1858 vq_err(vq
, "Loop detected: last one at %u "
1859 "indirect size %u\n",
1863 if (unlikely(copy_from_iter(&desc
, sizeof(desc
), &from
) !=
1865 vq_err(vq
, "Failed indirect descriptor: idx %d, %zx\n",
1866 i
, (size_t)vhost64_to_cpu(vq
, indirect
->addr
) + i
* sizeof desc
);
1869 if (unlikely(desc
.flags
& cpu_to_vhost16(vq
, VRING_DESC_F_INDIRECT
))) {
1870 vq_err(vq
, "Nested indirect descriptor: idx %d, %zx\n",
1871 i
, (size_t)vhost64_to_cpu(vq
, indirect
->addr
) + i
* sizeof desc
);
1875 if (desc
.flags
& cpu_to_vhost16(vq
, VRING_DESC_F_WRITE
))
1876 access
= VHOST_ACCESS_WO
;
1878 access
= VHOST_ACCESS_RO
;
1880 ret
= translate_desc(vq
, vhost64_to_cpu(vq
, desc
.addr
),
1881 vhost32_to_cpu(vq
, desc
.len
), iov
+ iov_count
,
1882 iov_size
- iov_count
, access
);
1883 if (unlikely(ret
< 0)) {
1885 vq_err(vq
, "Translation failure %d indirect idx %d\n",
1889 /* If this is an input descriptor, increment that count. */
1890 if (access
== VHOST_ACCESS_WO
) {
1892 if (unlikely(log
)) {
1893 log
[*log_num
].addr
= vhost64_to_cpu(vq
, desc
.addr
);
1894 log
[*log_num
].len
= vhost32_to_cpu(vq
, desc
.len
);
1898 /* If it's an output descriptor, they're all supposed
1899 * to come before any input descriptors. */
1900 if (unlikely(*in_num
)) {
1901 vq_err(vq
, "Indirect descriptor "
1902 "has out after in: idx %d\n", i
);
1907 } while ((i
= next_desc(vq
, &desc
)) != -1);
1911 /* This looks in the virtqueue and for the first available buffer, and converts
1912 * it to an iovec for convenient access. Since descriptors consist of some
1913 * number of output then some number of input descriptors, it's actually two
1914 * iovecs, but we pack them into one and note how many of each there were.
1916 * This function returns the descriptor number found, or vq->num (which is
1917 * never a valid descriptor number) if none was found. A negative code is
1918 * returned on error. */
1919 int vhost_get_vq_desc(struct vhost_virtqueue
*vq
,
1920 struct iovec iov
[], unsigned int iov_size
,
1921 unsigned int *out_num
, unsigned int *in_num
,
1922 struct vhost_log
*log
, unsigned int *log_num
)
1924 struct vring_desc desc
;
1925 unsigned int i
, head
, found
= 0;
1927 __virtio16 avail_idx
;
1928 __virtio16 ring_head
;
1931 /* Check it isn't doing very strange things with descriptor numbers. */
1932 last_avail_idx
= vq
->last_avail_idx
;
1933 if (unlikely(vhost_get_user(vq
, avail_idx
, &vq
->avail
->idx
))) {
1934 vq_err(vq
, "Failed to access avail idx at %p\n",
1938 vq
->avail_idx
= vhost16_to_cpu(vq
, avail_idx
);
1940 if (unlikely((u16
)(vq
->avail_idx
- last_avail_idx
) > vq
->num
)) {
1941 vq_err(vq
, "Guest moved used index from %u to %u",
1942 last_avail_idx
, vq
->avail_idx
);
1946 /* If there's nothing new since last we looked, return invalid. */
1947 if (vq
->avail_idx
== last_avail_idx
)
1950 /* Only get avail ring entries after they have been exposed by guest. */
1953 /* Grab the next descriptor number they're advertising, and increment
1954 * the index we've seen. */
1955 if (unlikely(vhost_get_user(vq
, ring_head
,
1956 &vq
->avail
->ring
[last_avail_idx
& (vq
->num
- 1)]))) {
1957 vq_err(vq
, "Failed to read head: idx %d address %p\n",
1959 &vq
->avail
->ring
[last_avail_idx
% vq
->num
]);
1963 head
= vhost16_to_cpu(vq
, ring_head
);
1965 /* If their number is silly, that's an error. */
1966 if (unlikely(head
>= vq
->num
)) {
1967 vq_err(vq
, "Guest says index %u > %u is available",
1972 /* When we start there are none of either input nor output. */
1973 *out_num
= *in_num
= 0;
1979 unsigned iov_count
= *in_num
+ *out_num
;
1980 if (unlikely(i
>= vq
->num
)) {
1981 vq_err(vq
, "Desc index is %u > %u, head = %u",
1985 if (unlikely(++found
> vq
->num
)) {
1986 vq_err(vq
, "Loop detected: last one at %u "
1987 "vq size %u head %u\n",
1991 ret
= vhost_copy_from_user(vq
, &desc
, vq
->desc
+ i
,
1993 if (unlikely(ret
)) {
1994 vq_err(vq
, "Failed to get descriptor: idx %d addr %p\n",
1998 if (desc
.flags
& cpu_to_vhost16(vq
, VRING_DESC_F_INDIRECT
)) {
1999 ret
= get_indirect(vq
, iov
, iov_size
,
2001 log
, log_num
, &desc
);
2002 if (unlikely(ret
< 0)) {
2004 vq_err(vq
, "Failure detected "
2005 "in indirect descriptor at idx %d\n", i
);
2011 if (desc
.flags
& cpu_to_vhost16(vq
, VRING_DESC_F_WRITE
))
2012 access
= VHOST_ACCESS_WO
;
2014 access
= VHOST_ACCESS_RO
;
2015 ret
= translate_desc(vq
, vhost64_to_cpu(vq
, desc
.addr
),
2016 vhost32_to_cpu(vq
, desc
.len
), iov
+ iov_count
,
2017 iov_size
- iov_count
, access
);
2018 if (unlikely(ret
< 0)) {
2020 vq_err(vq
, "Translation failure %d descriptor idx %d\n",
2024 if (access
== VHOST_ACCESS_WO
) {
2025 /* If this is an input descriptor,
2026 * increment that count. */
2028 if (unlikely(log
)) {
2029 log
[*log_num
].addr
= vhost64_to_cpu(vq
, desc
.addr
);
2030 log
[*log_num
].len
= vhost32_to_cpu(vq
, desc
.len
);
2034 /* If it's an output descriptor, they're all supposed
2035 * to come before any input descriptors. */
2036 if (unlikely(*in_num
)) {
2037 vq_err(vq
, "Descriptor has out after in: "
2043 } while ((i
= next_desc(vq
, &desc
)) != -1);
2045 /* On success, increment avail index. */
2046 vq
->last_avail_idx
++;
2048 /* Assume notifications from guest are disabled at this point,
2049 * if they aren't we would need to update avail_event index. */
2050 BUG_ON(!(vq
->used_flags
& VRING_USED_F_NO_NOTIFY
));
2053 EXPORT_SYMBOL_GPL(vhost_get_vq_desc
);
2055 /* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
2056 void vhost_discard_vq_desc(struct vhost_virtqueue
*vq
, int n
)
2058 vq
->last_avail_idx
-= n
;
2060 EXPORT_SYMBOL_GPL(vhost_discard_vq_desc
);
2062 /* After we've used one of their buffers, we tell them about it. We'll then
2063 * want to notify the guest, using eventfd. */
2064 int vhost_add_used(struct vhost_virtqueue
*vq
, unsigned int head
, int len
)
2066 struct vring_used_elem heads
= {
2067 cpu_to_vhost32(vq
, head
),
2068 cpu_to_vhost32(vq
, len
)
2071 return vhost_add_used_n(vq
, &heads
, 1);
2073 EXPORT_SYMBOL_GPL(vhost_add_used
);
2075 static int __vhost_add_used_n(struct vhost_virtqueue
*vq
,
2076 struct vring_used_elem
*heads
,
2079 struct vring_used_elem __user
*used
;
2083 start
= vq
->last_used_idx
& (vq
->num
- 1);
2084 used
= vq
->used
->ring
+ start
;
2086 if (vhost_put_user(vq
, heads
[0].id
, &used
->id
)) {
2087 vq_err(vq
, "Failed to write used id");
2090 if (vhost_put_user(vq
, heads
[0].len
, &used
->len
)) {
2091 vq_err(vq
, "Failed to write used len");
2094 } else if (vhost_copy_to_user(vq
, used
, heads
, count
* sizeof *used
)) {
2095 vq_err(vq
, "Failed to write used");
2098 if (unlikely(vq
->log_used
)) {
2099 /* Make sure data is seen before log. */
2101 /* Log used ring entry write. */
2102 log_write(vq
->log_base
,
2104 ((void __user
*)used
- (void __user
*)vq
->used
),
2105 count
* sizeof *used
);
2107 old
= vq
->last_used_idx
;
2108 new = (vq
->last_used_idx
+= count
);
2109 /* If the driver never bothers to signal in a very long while,
2110 * used index might wrap around. If that happens, invalidate
2111 * signalled_used index we stored. TODO: make sure driver
2112 * signals at least once in 2^16 and remove this. */
2113 if (unlikely((u16
)(new - vq
->signalled_used
) < (u16
)(new - old
)))
2114 vq
->signalled_used_valid
= false;
2118 /* After we've used one of their buffers, we tell them about it. We'll then
2119 * want to notify the guest, using eventfd. */
2120 int vhost_add_used_n(struct vhost_virtqueue
*vq
, struct vring_used_elem
*heads
,
2125 start
= vq
->last_used_idx
& (vq
->num
- 1);
2126 n
= vq
->num
- start
;
2128 r
= __vhost_add_used_n(vq
, heads
, n
);
2134 r
= __vhost_add_used_n(vq
, heads
, count
);
2136 /* Make sure buffer is written before we update index. */
2138 if (vhost_put_user(vq
, cpu_to_vhost16(vq
, vq
->last_used_idx
),
2140 vq_err(vq
, "Failed to increment used idx");
2143 if (unlikely(vq
->log_used
)) {
2144 /* Log used index update. */
2145 log_write(vq
->log_base
,
2146 vq
->log_addr
+ offsetof(struct vring_used
, idx
),
2147 sizeof vq
->used
->idx
);
2149 eventfd_signal(vq
->log_ctx
, 1);
2153 EXPORT_SYMBOL_GPL(vhost_add_used_n
);
2155 static bool vhost_notify(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
2160 /* Flush out used index updates. This is paired
2161 * with the barrier that the Guest executes when enabling
2165 if (vhost_has_feature(vq
, VIRTIO_F_NOTIFY_ON_EMPTY
) &&
2166 unlikely(vq
->avail_idx
== vq
->last_avail_idx
))
2169 if (!vhost_has_feature(vq
, VIRTIO_RING_F_EVENT_IDX
)) {
2171 if (vhost_get_user(vq
, flags
, &vq
->avail
->flags
)) {
2172 vq_err(vq
, "Failed to get flags");
2175 return !(flags
& cpu_to_vhost16(vq
, VRING_AVAIL_F_NO_INTERRUPT
));
2177 old
= vq
->signalled_used
;
2178 v
= vq
->signalled_used_valid
;
2179 new = vq
->signalled_used
= vq
->last_used_idx
;
2180 vq
->signalled_used_valid
= true;
2185 if (vhost_get_user(vq
, event
, vhost_used_event(vq
))) {
2186 vq_err(vq
, "Failed to get used event idx");
2189 return vring_need_event(vhost16_to_cpu(vq
, event
), new, old
);
2192 /* This actually signals the guest, using eventfd. */
2193 void vhost_signal(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
2195 /* Signal the Guest tell them we used something up. */
2196 if (vq
->call_ctx
&& vhost_notify(dev
, vq
))
2197 eventfd_signal(vq
->call_ctx
, 1);
2199 EXPORT_SYMBOL_GPL(vhost_signal
);
2201 /* And here's the combo meal deal. Supersize me! */
2202 void vhost_add_used_and_signal(struct vhost_dev
*dev
,
2203 struct vhost_virtqueue
*vq
,
2204 unsigned int head
, int len
)
2206 vhost_add_used(vq
, head
, len
);
2207 vhost_signal(dev
, vq
);
2209 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal
);
2211 /* multi-buffer version of vhost_add_used_and_signal */
2212 void vhost_add_used_and_signal_n(struct vhost_dev
*dev
,
2213 struct vhost_virtqueue
*vq
,
2214 struct vring_used_elem
*heads
, unsigned count
)
2216 vhost_add_used_n(vq
, heads
, count
);
2217 vhost_signal(dev
, vq
);
2219 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n
);
2221 /* return true if we're sure that avaiable ring is empty */
2222 bool vhost_vq_avail_empty(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
2224 __virtio16 avail_idx
;
2227 r
= vhost_get_user(vq
, avail_idx
, &vq
->avail
->idx
);
2231 return vhost16_to_cpu(vq
, avail_idx
) == vq
->avail_idx
;
2233 EXPORT_SYMBOL_GPL(vhost_vq_avail_empty
);
2235 /* OK, now we need to know about added descriptors. */
2236 bool vhost_enable_notify(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
2238 __virtio16 avail_idx
;
2241 if (!(vq
->used_flags
& VRING_USED_F_NO_NOTIFY
))
2243 vq
->used_flags
&= ~VRING_USED_F_NO_NOTIFY
;
2244 if (!vhost_has_feature(vq
, VIRTIO_RING_F_EVENT_IDX
)) {
2245 r
= vhost_update_used_flags(vq
);
2247 vq_err(vq
, "Failed to enable notification at %p: %d\n",
2248 &vq
->used
->flags
, r
);
2252 r
= vhost_update_avail_event(vq
, vq
->avail_idx
);
2254 vq_err(vq
, "Failed to update avail event index at %p: %d\n",
2255 vhost_avail_event(vq
), r
);
2259 /* They could have slipped one in as we were doing that: make
2260 * sure it's written, then check again. */
2262 r
= vhost_get_user(vq
, avail_idx
, &vq
->avail
->idx
);
2264 vq_err(vq
, "Failed to check avail idx at %p: %d\n",
2265 &vq
->avail
->idx
, r
);
2269 return vhost16_to_cpu(vq
, avail_idx
) != vq
->avail_idx
;
2271 EXPORT_SYMBOL_GPL(vhost_enable_notify
);
2273 /* We don't need to be notified again. */
2274 void vhost_disable_notify(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
2278 if (vq
->used_flags
& VRING_USED_F_NO_NOTIFY
)
2280 vq
->used_flags
|= VRING_USED_F_NO_NOTIFY
;
2281 if (!vhost_has_feature(vq
, VIRTIO_RING_F_EVENT_IDX
)) {
2282 r
= vhost_update_used_flags(vq
);
2284 vq_err(vq
, "Failed to enable notification at %p: %d\n",
2285 &vq
->used
->flags
, r
);
2288 EXPORT_SYMBOL_GPL(vhost_disable_notify
);
2290 /* Create a new message. */
2291 struct vhost_msg_node
*vhost_new_msg(struct vhost_virtqueue
*vq
, int type
)
2293 struct vhost_msg_node
*node
= kmalloc(sizeof *node
, GFP_KERNEL
);
2297 node
->msg
.type
= type
;
2300 EXPORT_SYMBOL_GPL(vhost_new_msg
);
2302 void vhost_enqueue_msg(struct vhost_dev
*dev
, struct list_head
*head
,
2303 struct vhost_msg_node
*node
)
2305 spin_lock(&dev
->iotlb_lock
);
2306 list_add_tail(&node
->node
, head
);
2307 spin_unlock(&dev
->iotlb_lock
);
2309 wake_up_interruptible_poll(&dev
->wait
, POLLIN
| POLLRDNORM
);
2311 EXPORT_SYMBOL_GPL(vhost_enqueue_msg
);
2313 struct vhost_msg_node
*vhost_dequeue_msg(struct vhost_dev
*dev
,
2314 struct list_head
*head
)
2316 struct vhost_msg_node
*node
= NULL
;
2318 spin_lock(&dev
->iotlb_lock
);
2319 if (!list_empty(head
)) {
2320 node
= list_first_entry(head
, struct vhost_msg_node
,
2322 list_del(&node
->node
);
2324 spin_unlock(&dev
->iotlb_lock
);
2328 EXPORT_SYMBOL_GPL(vhost_dequeue_msg
);
2331 static int __init
vhost_init(void)
2336 static void __exit
vhost_exit(void)
2340 module_init(vhost_init
);
2341 module_exit(vhost_exit
);
2343 MODULE_VERSION("0.0.1");
2344 MODULE_LICENSE("GPL v2");
2345 MODULE_AUTHOR("Michael S. Tsirkin");
2346 MODULE_DESCRIPTION("Host kernel accelerator for virtio");