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/rcupdate.h>
22 #include <linux/poll.h>
23 #include <linux/file.h>
24 #include <linux/highmem.h>
25 #include <linux/slab.h>
26 #include <linux/kthread.h>
27 #include <linux/cgroup.h>
28 #include <linux/module.h>
33 VHOST_MEMORY_MAX_NREGIONS
= 64,
34 VHOST_MEMORY_F_LOG
= 0x1,
37 #define vhost_used_event(vq) ((u16 __user *)&vq->avail->ring[vq->num])
38 #define vhost_avail_event(vq) ((u16 __user *)&vq->used->ring[vq->num])
40 static void vhost_poll_func(struct file
*file
, wait_queue_head_t
*wqh
,
43 struct vhost_poll
*poll
;
45 poll
= container_of(pt
, struct vhost_poll
, table
);
47 add_wait_queue(wqh
, &poll
->wait
);
50 static int vhost_poll_wakeup(wait_queue_t
*wait
, unsigned mode
, int sync
,
53 struct vhost_poll
*poll
= container_of(wait
, struct vhost_poll
, wait
);
55 if (!((unsigned long)key
& poll
->mask
))
58 vhost_poll_queue(poll
);
62 void vhost_work_init(struct vhost_work
*work
, vhost_work_fn_t fn
)
64 INIT_LIST_HEAD(&work
->node
);
66 init_waitqueue_head(&work
->done
);
68 work
->queue_seq
= work
->done_seq
= 0;
70 EXPORT_SYMBOL_GPL(vhost_work_init
);
72 /* Init poll structure */
73 void vhost_poll_init(struct vhost_poll
*poll
, vhost_work_fn_t fn
,
74 unsigned long mask
, struct vhost_dev
*dev
)
76 init_waitqueue_func_entry(&poll
->wait
, vhost_poll_wakeup
);
77 init_poll_funcptr(&poll
->table
, vhost_poll_func
);
82 vhost_work_init(&poll
->work
, fn
);
84 EXPORT_SYMBOL_GPL(vhost_poll_init
);
86 /* Start polling a file. We add ourselves to file's wait queue. The caller must
87 * keep a reference to a file until after vhost_poll_stop is called. */
88 int vhost_poll_start(struct vhost_poll
*poll
, struct file
*file
)
96 mask
= file
->f_op
->poll(file
, &poll
->table
);
98 vhost_poll_wakeup(&poll
->wait
, 0, 0, (void *)mask
);
101 remove_wait_queue(poll
->wqh
, &poll
->wait
);
107 EXPORT_SYMBOL_GPL(vhost_poll_start
);
109 /* Stop polling a file. After this function returns, it becomes safe to drop the
110 * file reference. You must also flush afterwards. */
111 void vhost_poll_stop(struct vhost_poll
*poll
)
114 remove_wait_queue(poll
->wqh
, &poll
->wait
);
118 EXPORT_SYMBOL_GPL(vhost_poll_stop
);
120 static bool vhost_work_seq_done(struct vhost_dev
*dev
, struct vhost_work
*work
,
125 spin_lock_irq(&dev
->work_lock
);
126 left
= seq
- work
->done_seq
;
127 spin_unlock_irq(&dev
->work_lock
);
131 void vhost_work_flush(struct vhost_dev
*dev
, struct vhost_work
*work
)
136 spin_lock_irq(&dev
->work_lock
);
137 seq
= work
->queue_seq
;
139 spin_unlock_irq(&dev
->work_lock
);
140 wait_event(work
->done
, vhost_work_seq_done(dev
, work
, seq
));
141 spin_lock_irq(&dev
->work_lock
);
142 flushing
= --work
->flushing
;
143 spin_unlock_irq(&dev
->work_lock
);
144 BUG_ON(flushing
< 0);
146 EXPORT_SYMBOL_GPL(vhost_work_flush
);
148 /* Flush any work that has been scheduled. When calling this, don't hold any
149 * locks that are also used by the callback. */
150 void vhost_poll_flush(struct vhost_poll
*poll
)
152 vhost_work_flush(poll
->dev
, &poll
->work
);
154 EXPORT_SYMBOL_GPL(vhost_poll_flush
);
156 void vhost_work_queue(struct vhost_dev
*dev
, struct vhost_work
*work
)
160 spin_lock_irqsave(&dev
->work_lock
, flags
);
161 if (list_empty(&work
->node
)) {
162 list_add_tail(&work
->node
, &dev
->work_list
);
164 spin_unlock_irqrestore(&dev
->work_lock
, flags
);
165 wake_up_process(dev
->worker
);
167 spin_unlock_irqrestore(&dev
->work_lock
, flags
);
170 EXPORT_SYMBOL_GPL(vhost_work_queue
);
172 void vhost_poll_queue(struct vhost_poll
*poll
)
174 vhost_work_queue(poll
->dev
, &poll
->work
);
176 EXPORT_SYMBOL_GPL(vhost_poll_queue
);
178 static void vhost_vq_reset(struct vhost_dev
*dev
,
179 struct vhost_virtqueue
*vq
)
185 vq
->last_avail_idx
= 0;
187 vq
->last_used_idx
= 0;
188 vq
->signalled_used
= 0;
189 vq
->signalled_used_valid
= false;
191 vq
->log_used
= false;
192 vq
->log_addr
= -1ull;
193 vq
->private_data
= NULL
;
195 vq
->error_ctx
= NULL
;
203 static int vhost_worker(void *data
)
205 struct vhost_dev
*dev
= data
;
206 struct vhost_work
*work
= NULL
;
207 unsigned uninitialized_var(seq
);
208 mm_segment_t oldfs
= get_fs();
214 /* mb paired w/ kthread_stop */
215 set_current_state(TASK_INTERRUPTIBLE
);
217 spin_lock_irq(&dev
->work_lock
);
219 work
->done_seq
= seq
;
221 wake_up_all(&work
->done
);
224 if (kthread_should_stop()) {
225 spin_unlock_irq(&dev
->work_lock
);
226 __set_current_state(TASK_RUNNING
);
229 if (!list_empty(&dev
->work_list
)) {
230 work
= list_first_entry(&dev
->work_list
,
231 struct vhost_work
, node
);
232 list_del_init(&work
->node
);
233 seq
= work
->queue_seq
;
236 spin_unlock_irq(&dev
->work_lock
);
239 __set_current_state(TASK_RUNNING
);
252 static void vhost_vq_free_iovecs(struct vhost_virtqueue
*vq
)
262 /* Helper to allocate iovec buffers for all vqs. */
263 static long vhost_dev_alloc_iovecs(struct vhost_dev
*dev
)
265 struct vhost_virtqueue
*vq
;
268 for (i
= 0; i
< dev
->nvqs
; ++i
) {
270 vq
->indirect
= kmalloc(sizeof *vq
->indirect
* UIO_MAXIOV
,
272 vq
->log
= kmalloc(sizeof *vq
->log
* UIO_MAXIOV
, GFP_KERNEL
);
273 vq
->heads
= kmalloc(sizeof *vq
->heads
* UIO_MAXIOV
, GFP_KERNEL
);
274 if (!vq
->indirect
|| !vq
->log
|| !vq
->heads
)
281 vhost_vq_free_iovecs(dev
->vqs
[i
]);
285 static void vhost_dev_free_iovecs(struct vhost_dev
*dev
)
289 for (i
= 0; i
< dev
->nvqs
; ++i
)
290 vhost_vq_free_iovecs(dev
->vqs
[i
]);
293 long vhost_dev_init(struct vhost_dev
*dev
,
294 struct vhost_virtqueue
**vqs
, int nvqs
)
296 struct vhost_virtqueue
*vq
;
301 mutex_init(&dev
->mutex
);
303 dev
->log_file
= NULL
;
306 spin_lock_init(&dev
->work_lock
);
307 INIT_LIST_HEAD(&dev
->work_list
);
310 for (i
= 0; i
< dev
->nvqs
; ++i
) {
316 mutex_init(&vq
->mutex
);
317 vhost_vq_reset(dev
, vq
);
319 vhost_poll_init(&vq
->poll
, vq
->handle_kick
,
325 EXPORT_SYMBOL_GPL(vhost_dev_init
);
327 /* Caller should have device mutex */
328 long vhost_dev_check_owner(struct vhost_dev
*dev
)
330 /* Are you the owner? If not, I don't think you mean to do that */
331 return dev
->mm
== current
->mm
? 0 : -EPERM
;
333 EXPORT_SYMBOL_GPL(vhost_dev_check_owner
);
335 struct vhost_attach_cgroups_struct
{
336 struct vhost_work work
;
337 struct task_struct
*owner
;
341 static void vhost_attach_cgroups_work(struct vhost_work
*work
)
343 struct vhost_attach_cgroups_struct
*s
;
345 s
= container_of(work
, struct vhost_attach_cgroups_struct
, work
);
346 s
->ret
= cgroup_attach_task_all(s
->owner
, current
);
349 static int vhost_attach_cgroups(struct vhost_dev
*dev
)
351 struct vhost_attach_cgroups_struct attach
;
353 attach
.owner
= current
;
354 vhost_work_init(&attach
.work
, vhost_attach_cgroups_work
);
355 vhost_work_queue(dev
, &attach
.work
);
356 vhost_work_flush(dev
, &attach
.work
);
360 /* Caller should have device mutex */
361 bool vhost_dev_has_owner(struct vhost_dev
*dev
)
365 EXPORT_SYMBOL_GPL(vhost_dev_has_owner
);
367 /* Caller should have device mutex */
368 long vhost_dev_set_owner(struct vhost_dev
*dev
)
370 struct task_struct
*worker
;
373 /* Is there an owner already? */
374 if (vhost_dev_has_owner(dev
)) {
379 /* No owner, become one */
380 dev
->mm
= get_task_mm(current
);
381 worker
= kthread_create(vhost_worker
, dev
, "vhost-%d", current
->pid
);
382 if (IS_ERR(worker
)) {
383 err
= PTR_ERR(worker
);
387 dev
->worker
= worker
;
388 wake_up_process(worker
); /* avoid contributing to loadavg */
390 err
= vhost_attach_cgroups(dev
);
394 err
= vhost_dev_alloc_iovecs(dev
);
400 kthread_stop(worker
);
409 EXPORT_SYMBOL_GPL(vhost_dev_set_owner
);
411 struct vhost_memory
*vhost_dev_reset_owner_prepare(void)
413 return kmalloc(offsetof(struct vhost_memory
, regions
), GFP_KERNEL
);
415 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner_prepare
);
417 /* Caller should have device mutex */
418 void vhost_dev_reset_owner(struct vhost_dev
*dev
, struct vhost_memory
*memory
)
420 vhost_dev_cleanup(dev
, true);
422 /* Restore memory to default empty mapping. */
423 memory
->nregions
= 0;
424 RCU_INIT_POINTER(dev
->memory
, memory
);
426 EXPORT_SYMBOL_GPL(vhost_dev_reset_owner
);
428 void vhost_dev_stop(struct vhost_dev
*dev
)
432 for (i
= 0; i
< dev
->nvqs
; ++i
) {
433 if (dev
->vqs
[i
]->kick
&& dev
->vqs
[i
]->handle_kick
) {
434 vhost_poll_stop(&dev
->vqs
[i
]->poll
);
435 vhost_poll_flush(&dev
->vqs
[i
]->poll
);
439 EXPORT_SYMBOL_GPL(vhost_dev_stop
);
441 /* Caller should have device mutex if and only if locked is set */
442 void vhost_dev_cleanup(struct vhost_dev
*dev
, bool locked
)
446 for (i
= 0; i
< dev
->nvqs
; ++i
) {
447 if (dev
->vqs
[i
]->error_ctx
)
448 eventfd_ctx_put(dev
->vqs
[i
]->error_ctx
);
449 if (dev
->vqs
[i
]->error
)
450 fput(dev
->vqs
[i
]->error
);
451 if (dev
->vqs
[i
]->kick
)
452 fput(dev
->vqs
[i
]->kick
);
453 if (dev
->vqs
[i
]->call_ctx
)
454 eventfd_ctx_put(dev
->vqs
[i
]->call_ctx
);
455 if (dev
->vqs
[i
]->call
)
456 fput(dev
->vqs
[i
]->call
);
457 vhost_vq_reset(dev
, dev
->vqs
[i
]);
459 vhost_dev_free_iovecs(dev
);
461 eventfd_ctx_put(dev
->log_ctx
);
465 dev
->log_file
= NULL
;
466 /* No one will access memory at this point */
467 kfree(rcu_dereference_protected(dev
->memory
,
469 lockdep_is_held(&dev
->mutex
)));
470 RCU_INIT_POINTER(dev
->memory
, NULL
);
471 WARN_ON(!list_empty(&dev
->work_list
));
473 kthread_stop(dev
->worker
);
480 EXPORT_SYMBOL_GPL(vhost_dev_cleanup
);
482 static int log_access_ok(void __user
*log_base
, u64 addr
, unsigned long sz
)
484 u64 a
= addr
/ VHOST_PAGE_SIZE
/ 8;
486 /* Make sure 64 bit math will not overflow. */
487 if (a
> ULONG_MAX
- (unsigned long)log_base
||
488 a
+ (unsigned long)log_base
> ULONG_MAX
)
491 return access_ok(VERIFY_WRITE
, log_base
+ a
,
492 (sz
+ VHOST_PAGE_SIZE
* 8 - 1) / VHOST_PAGE_SIZE
/ 8);
495 /* Caller should have vq mutex and device mutex. */
496 static int vq_memory_access_ok(void __user
*log_base
, struct vhost_memory
*mem
,
504 for (i
= 0; i
< mem
->nregions
; ++i
) {
505 struct vhost_memory_region
*m
= mem
->regions
+ i
;
506 unsigned long a
= m
->userspace_addr
;
507 if (m
->memory_size
> ULONG_MAX
)
509 else if (!access_ok(VERIFY_WRITE
, (void __user
*)a
,
512 else if (log_all
&& !log_access_ok(log_base
,
520 /* Can we switch to this memory table? */
521 /* Caller should have device mutex but not vq mutex */
522 static int memory_access_ok(struct vhost_dev
*d
, struct vhost_memory
*mem
,
527 for (i
= 0; i
< d
->nvqs
; ++i
) {
529 mutex_lock(&d
->vqs
[i
]->mutex
);
530 /* If ring is inactive, will check when it's enabled. */
531 if (d
->vqs
[i
]->private_data
)
532 ok
= vq_memory_access_ok(d
->vqs
[i
]->log_base
, mem
,
536 mutex_unlock(&d
->vqs
[i
]->mutex
);
543 static int vq_access_ok(struct vhost_dev
*d
, unsigned int num
,
544 struct vring_desc __user
*desc
,
545 struct vring_avail __user
*avail
,
546 struct vring_used __user
*used
)
548 size_t s
= vhost_has_feature(d
, VIRTIO_RING_F_EVENT_IDX
) ? 2 : 0;
549 return access_ok(VERIFY_READ
, desc
, num
* sizeof *desc
) &&
550 access_ok(VERIFY_READ
, avail
,
551 sizeof *avail
+ num
* sizeof *avail
->ring
+ s
) &&
552 access_ok(VERIFY_WRITE
, used
,
553 sizeof *used
+ num
* sizeof *used
->ring
+ s
);
556 /* Can we log writes? */
557 /* Caller should have device mutex but not vq mutex */
558 int vhost_log_access_ok(struct vhost_dev
*dev
)
560 struct vhost_memory
*mp
;
562 mp
= rcu_dereference_protected(dev
->memory
,
563 lockdep_is_held(&dev
->mutex
));
564 return memory_access_ok(dev
, mp
, 1);
566 EXPORT_SYMBOL_GPL(vhost_log_access_ok
);
568 /* Verify access for write logging. */
569 /* Caller should have vq mutex and device mutex */
570 static int vq_log_access_ok(struct vhost_dev
*d
, struct vhost_virtqueue
*vq
,
571 void __user
*log_base
)
573 struct vhost_memory
*mp
;
574 size_t s
= vhost_has_feature(d
, VIRTIO_RING_F_EVENT_IDX
) ? 2 : 0;
576 mp
= rcu_dereference_protected(vq
->dev
->memory
,
577 lockdep_is_held(&vq
->mutex
));
578 return vq_memory_access_ok(log_base
, mp
,
579 vhost_has_feature(vq
->dev
, VHOST_F_LOG_ALL
)) &&
580 (!vq
->log_used
|| log_access_ok(log_base
, vq
->log_addr
,
582 vq
->num
* sizeof *vq
->used
->ring
+ s
));
585 /* Can we start vq? */
586 /* Caller should have vq mutex and device mutex */
587 int vhost_vq_access_ok(struct vhost_virtqueue
*vq
)
589 return vq_access_ok(vq
->dev
, vq
->num
, vq
->desc
, vq
->avail
, vq
->used
) &&
590 vq_log_access_ok(vq
->dev
, vq
, vq
->log_base
);
592 EXPORT_SYMBOL_GPL(vhost_vq_access_ok
);
594 static long vhost_set_memory(struct vhost_dev
*d
, struct vhost_memory __user
*m
)
596 struct vhost_memory mem
, *newmem
, *oldmem
;
597 unsigned long size
= offsetof(struct vhost_memory
, regions
);
599 if (copy_from_user(&mem
, m
, size
))
603 if (mem
.nregions
> VHOST_MEMORY_MAX_NREGIONS
)
605 newmem
= kmalloc(size
+ mem
.nregions
* sizeof *m
->regions
, GFP_KERNEL
);
609 memcpy(newmem
, &mem
, size
);
610 if (copy_from_user(newmem
->regions
, m
->regions
,
611 mem
.nregions
* sizeof *m
->regions
)) {
616 if (!memory_access_ok(d
, newmem
,
617 vhost_has_feature(d
, VHOST_F_LOG_ALL
))) {
621 oldmem
= rcu_dereference_protected(d
->memory
,
622 lockdep_is_held(&d
->mutex
));
623 rcu_assign_pointer(d
->memory
, newmem
);
629 long vhost_vring_ioctl(struct vhost_dev
*d
, int ioctl
, void __user
*argp
)
631 struct file
*eventfp
, *filep
= NULL
;
632 bool pollstart
= false, pollstop
= false;
633 struct eventfd_ctx
*ctx
= NULL
;
634 u32 __user
*idxp
= argp
;
635 struct vhost_virtqueue
*vq
;
636 struct vhost_vring_state s
;
637 struct vhost_vring_file f
;
638 struct vhost_vring_addr a
;
642 r
= get_user(idx
, idxp
);
650 mutex_lock(&vq
->mutex
);
653 case VHOST_SET_VRING_NUM
:
654 /* Resizing ring with an active backend?
655 * You don't want to do that. */
656 if (vq
->private_data
) {
660 if (copy_from_user(&s
, argp
, sizeof s
)) {
664 if (!s
.num
|| s
.num
> 0xffff || (s
.num
& (s
.num
- 1))) {
670 case VHOST_SET_VRING_BASE
:
671 /* Moving base with an active backend?
672 * You don't want to do that. */
673 if (vq
->private_data
) {
677 if (copy_from_user(&s
, argp
, sizeof s
)) {
681 if (s
.num
> 0xffff) {
685 vq
->last_avail_idx
= s
.num
;
686 /* Forget the cached index value. */
687 vq
->avail_idx
= vq
->last_avail_idx
;
689 case VHOST_GET_VRING_BASE
:
691 s
.num
= vq
->last_avail_idx
;
692 if (copy_to_user(argp
, &s
, sizeof s
))
695 case VHOST_SET_VRING_ADDR
:
696 if (copy_from_user(&a
, argp
, sizeof a
)) {
700 if (a
.flags
& ~(0x1 << VHOST_VRING_F_LOG
)) {
704 /* For 32bit, verify that the top 32bits of the user
705 data are set to zero. */
706 if ((u64
)(unsigned long)a
.desc_user_addr
!= a
.desc_user_addr
||
707 (u64
)(unsigned long)a
.used_user_addr
!= a
.used_user_addr
||
708 (u64
)(unsigned long)a
.avail_user_addr
!= a
.avail_user_addr
) {
712 if ((a
.avail_user_addr
& (sizeof *vq
->avail
->ring
- 1)) ||
713 (a
.used_user_addr
& (sizeof *vq
->used
->ring
- 1)) ||
714 (a
.log_guest_addr
& (sizeof *vq
->used
->ring
- 1))) {
719 /* We only verify access here if backend is configured.
720 * If it is not, we don't as size might not have been setup.
721 * We will verify when backend is configured. */
722 if (vq
->private_data
) {
723 if (!vq_access_ok(d
, vq
->num
,
724 (void __user
*)(unsigned long)a
.desc_user_addr
,
725 (void __user
*)(unsigned long)a
.avail_user_addr
,
726 (void __user
*)(unsigned long)a
.used_user_addr
)) {
731 /* Also validate log access for used ring if enabled. */
732 if ((a
.flags
& (0x1 << VHOST_VRING_F_LOG
)) &&
733 !log_access_ok(vq
->log_base
, a
.log_guest_addr
,
735 vq
->num
* sizeof *vq
->used
->ring
)) {
741 vq
->log_used
= !!(a
.flags
& (0x1 << VHOST_VRING_F_LOG
));
742 vq
->desc
= (void __user
*)(unsigned long)a
.desc_user_addr
;
743 vq
->avail
= (void __user
*)(unsigned long)a
.avail_user_addr
;
744 vq
->log_addr
= a
.log_guest_addr
;
745 vq
->used
= (void __user
*)(unsigned long)a
.used_user_addr
;
747 case VHOST_SET_VRING_KICK
:
748 if (copy_from_user(&f
, argp
, sizeof f
)) {
752 eventfp
= f
.fd
== -1 ? NULL
: eventfd_fget(f
.fd
);
753 if (IS_ERR(eventfp
)) {
754 r
= PTR_ERR(eventfp
);
757 if (eventfp
!= vq
->kick
) {
758 pollstop
= (filep
= vq
->kick
) != NULL
;
759 pollstart
= (vq
->kick
= eventfp
) != NULL
;
763 case VHOST_SET_VRING_CALL
:
764 if (copy_from_user(&f
, argp
, sizeof f
)) {
768 eventfp
= f
.fd
== -1 ? NULL
: eventfd_fget(f
.fd
);
769 if (IS_ERR(eventfp
)) {
770 r
= PTR_ERR(eventfp
);
773 if (eventfp
!= vq
->call
) {
777 vq
->call_ctx
= eventfp
?
778 eventfd_ctx_fileget(eventfp
) : NULL
;
782 case VHOST_SET_VRING_ERR
:
783 if (copy_from_user(&f
, argp
, sizeof f
)) {
787 eventfp
= f
.fd
== -1 ? NULL
: eventfd_fget(f
.fd
);
788 if (IS_ERR(eventfp
)) {
789 r
= PTR_ERR(eventfp
);
792 if (eventfp
!= vq
->error
) {
796 vq
->error_ctx
= eventfp
?
797 eventfd_ctx_fileget(eventfp
) : NULL
;
805 if (pollstop
&& vq
->handle_kick
)
806 vhost_poll_stop(&vq
->poll
);
809 eventfd_ctx_put(ctx
);
813 if (pollstart
&& vq
->handle_kick
)
814 r
= vhost_poll_start(&vq
->poll
, vq
->kick
);
816 mutex_unlock(&vq
->mutex
);
818 if (pollstop
&& vq
->handle_kick
)
819 vhost_poll_flush(&vq
->poll
);
822 EXPORT_SYMBOL_GPL(vhost_vring_ioctl
);
824 /* Caller must have device mutex */
825 long vhost_dev_ioctl(struct vhost_dev
*d
, unsigned int ioctl
, void __user
*argp
)
827 struct file
*eventfp
, *filep
= NULL
;
828 struct eventfd_ctx
*ctx
= NULL
;
833 /* If you are not the owner, you can become one */
834 if (ioctl
== VHOST_SET_OWNER
) {
835 r
= vhost_dev_set_owner(d
);
839 /* You must be the owner to do anything else */
840 r
= vhost_dev_check_owner(d
);
845 case VHOST_SET_MEM_TABLE
:
846 r
= vhost_set_memory(d
, argp
);
848 case VHOST_SET_LOG_BASE
:
849 if (copy_from_user(&p
, argp
, sizeof p
)) {
853 if ((u64
)(unsigned long)p
!= p
) {
857 for (i
= 0; i
< d
->nvqs
; ++i
) {
858 struct vhost_virtqueue
*vq
;
859 void __user
*base
= (void __user
*)(unsigned long)p
;
861 mutex_lock(&vq
->mutex
);
862 /* If ring is inactive, will check when it's enabled. */
863 if (vq
->private_data
&& !vq_log_access_ok(d
, vq
, base
))
867 mutex_unlock(&vq
->mutex
);
870 case VHOST_SET_LOG_FD
:
871 r
= get_user(fd
, (int __user
*)argp
);
874 eventfp
= fd
== -1 ? NULL
: eventfd_fget(fd
);
875 if (IS_ERR(eventfp
)) {
876 r
= PTR_ERR(eventfp
);
879 if (eventfp
!= d
->log_file
) {
881 d
->log_file
= eventfp
;
883 d
->log_ctx
= eventfp
?
884 eventfd_ctx_fileget(eventfp
) : NULL
;
887 for (i
= 0; i
< d
->nvqs
; ++i
) {
888 mutex_lock(&d
->vqs
[i
]->mutex
);
889 d
->vqs
[i
]->log_ctx
= d
->log_ctx
;
890 mutex_unlock(&d
->vqs
[i
]->mutex
);
893 eventfd_ctx_put(ctx
);
904 EXPORT_SYMBOL_GPL(vhost_dev_ioctl
);
906 static const struct vhost_memory_region
*find_region(struct vhost_memory
*mem
,
907 __u64 addr
, __u32 len
)
909 struct vhost_memory_region
*reg
;
912 /* linear search is not brilliant, but we really have on the order of 6
913 * regions in practice */
914 for (i
= 0; i
< mem
->nregions
; ++i
) {
915 reg
= mem
->regions
+ i
;
916 if (reg
->guest_phys_addr
<= addr
&&
917 reg
->guest_phys_addr
+ reg
->memory_size
- 1 >= addr
)
923 /* TODO: This is really inefficient. We need something like get_user()
924 * (instruction directly accesses the data, with an exception table entry
925 * returning -EFAULT). See Documentation/x86/exception-tables.txt.
927 static int set_bit_to_user(int nr
, void __user
*addr
)
929 unsigned long log
= (unsigned long)addr
;
932 int bit
= nr
+ (log
% PAGE_SIZE
) * 8;
935 r
= get_user_pages_fast(log
, 1, 1, &page
);
939 base
= kmap_atomic(page
);
942 set_page_dirty_lock(page
);
947 static int log_write(void __user
*log_base
,
948 u64 write_address
, u64 write_length
)
950 u64 write_page
= write_address
/ VHOST_PAGE_SIZE
;
955 write_length
+= write_address
% VHOST_PAGE_SIZE
;
957 u64 base
= (u64
)(unsigned long)log_base
;
958 u64 log
= base
+ write_page
/ 8;
959 int bit
= write_page
% 8;
960 if ((u64
)(unsigned long)log
!= log
)
962 r
= set_bit_to_user(bit
, (void __user
*)(unsigned long)log
);
965 if (write_length
<= VHOST_PAGE_SIZE
)
967 write_length
-= VHOST_PAGE_SIZE
;
973 int vhost_log_write(struct vhost_virtqueue
*vq
, struct vhost_log
*log
,
974 unsigned int log_num
, u64 len
)
978 /* Make sure data written is seen before log. */
980 for (i
= 0; i
< log_num
; ++i
) {
981 u64 l
= min(log
[i
].len
, len
);
982 r
= log_write(vq
->log_base
, log
[i
].addr
, l
);
988 eventfd_signal(vq
->log_ctx
, 1);
992 /* Length written exceeds what we have stored. This is a bug. */
996 EXPORT_SYMBOL_GPL(vhost_log_write
);
998 static int vhost_update_used_flags(struct vhost_virtqueue
*vq
)
1001 if (__put_user(vq
->used_flags
, &vq
->used
->flags
) < 0)
1003 if (unlikely(vq
->log_used
)) {
1004 /* Make sure the flag is seen before log. */
1006 /* Log used flag write. */
1007 used
= &vq
->used
->flags
;
1008 log_write(vq
->log_base
, vq
->log_addr
+
1009 (used
- (void __user
*)vq
->used
),
1010 sizeof vq
->used
->flags
);
1012 eventfd_signal(vq
->log_ctx
, 1);
1017 static int vhost_update_avail_event(struct vhost_virtqueue
*vq
, u16 avail_event
)
1019 if (__put_user(vq
->avail_idx
, vhost_avail_event(vq
)))
1021 if (unlikely(vq
->log_used
)) {
1023 /* Make sure the event is seen before log. */
1025 /* Log avail event write */
1026 used
= vhost_avail_event(vq
);
1027 log_write(vq
->log_base
, vq
->log_addr
+
1028 (used
- (void __user
*)vq
->used
),
1029 sizeof *vhost_avail_event(vq
));
1031 eventfd_signal(vq
->log_ctx
, 1);
1036 int vhost_init_used(struct vhost_virtqueue
*vq
)
1039 if (!vq
->private_data
)
1042 r
= vhost_update_used_flags(vq
);
1045 vq
->signalled_used_valid
= false;
1046 return get_user(vq
->last_used_idx
, &vq
->used
->idx
);
1048 EXPORT_SYMBOL_GPL(vhost_init_used
);
1050 static int translate_desc(struct vhost_dev
*dev
, u64 addr
, u32 len
,
1051 struct iovec iov
[], int iov_size
)
1053 const struct vhost_memory_region
*reg
;
1054 struct vhost_memory
*mem
;
1061 mem
= rcu_dereference(dev
->memory
);
1062 while ((u64
)len
> s
) {
1064 if (unlikely(ret
>= iov_size
)) {
1068 reg
= find_region(mem
, addr
, len
);
1069 if (unlikely(!reg
)) {
1074 size
= reg
->memory_size
- addr
+ reg
->guest_phys_addr
;
1075 _iov
->iov_len
= min((u64
)len
- s
, size
);
1076 _iov
->iov_base
= (void __user
*)(unsigned long)
1077 (reg
->userspace_addr
+ addr
- reg
->guest_phys_addr
);
1087 /* Each buffer in the virtqueues is actually a chain of descriptors. This
1088 * function returns the next descriptor in the chain,
1089 * or -1U if we're at the end. */
1090 static unsigned next_desc(struct vring_desc
*desc
)
1094 /* If this descriptor says it doesn't chain, we're done. */
1095 if (!(desc
->flags
& VRING_DESC_F_NEXT
))
1098 /* Check they're not leading us off end of descriptors. */
1100 /* Make sure compiler knows to grab that: we don't want it changing! */
1101 /* We will use the result as an index in an array, so most
1102 * architectures only need a compiler barrier here. */
1103 read_barrier_depends();
1108 static int get_indirect(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
,
1109 struct iovec iov
[], unsigned int iov_size
,
1110 unsigned int *out_num
, unsigned int *in_num
,
1111 struct vhost_log
*log
, unsigned int *log_num
,
1112 struct vring_desc
*indirect
)
1114 struct vring_desc desc
;
1115 unsigned int i
= 0, count
, found
= 0;
1119 if (unlikely(indirect
->len
% sizeof desc
)) {
1120 vq_err(vq
, "Invalid length in indirect descriptor: "
1121 "len 0x%llx not multiple of 0x%zx\n",
1122 (unsigned long long)indirect
->len
,
1127 ret
= translate_desc(dev
, indirect
->addr
, indirect
->len
, vq
->indirect
,
1129 if (unlikely(ret
< 0)) {
1130 vq_err(vq
, "Translation failure %d in indirect.\n", ret
);
1134 /* We will use the result as an address to read from, so most
1135 * architectures only need a compiler barrier here. */
1136 read_barrier_depends();
1138 count
= indirect
->len
/ sizeof desc
;
1139 /* Buffers are chained via a 16 bit next field, so
1140 * we can have at most 2^16 of these. */
1141 if (unlikely(count
> USHRT_MAX
+ 1)) {
1142 vq_err(vq
, "Indirect buffer length too big: %d\n",
1148 unsigned iov_count
= *in_num
+ *out_num
;
1149 if (unlikely(++found
> count
)) {
1150 vq_err(vq
, "Loop detected: last one at %u "
1151 "indirect size %u\n",
1155 if (unlikely(memcpy_fromiovec((unsigned char *)&desc
,
1156 vq
->indirect
, sizeof desc
))) {
1157 vq_err(vq
, "Failed indirect descriptor: idx %d, %zx\n",
1158 i
, (size_t)indirect
->addr
+ i
* sizeof desc
);
1161 if (unlikely(desc
.flags
& VRING_DESC_F_INDIRECT
)) {
1162 vq_err(vq
, "Nested indirect descriptor: idx %d, %zx\n",
1163 i
, (size_t)indirect
->addr
+ i
* sizeof desc
);
1167 ret
= translate_desc(dev
, desc
.addr
, desc
.len
, iov
+ iov_count
,
1168 iov_size
- iov_count
);
1169 if (unlikely(ret
< 0)) {
1170 vq_err(vq
, "Translation failure %d indirect idx %d\n",
1174 /* If this is an input descriptor, increment that count. */
1175 if (desc
.flags
& VRING_DESC_F_WRITE
) {
1177 if (unlikely(log
)) {
1178 log
[*log_num
].addr
= desc
.addr
;
1179 log
[*log_num
].len
= desc
.len
;
1183 /* If it's an output descriptor, they're all supposed
1184 * to come before any input descriptors. */
1185 if (unlikely(*in_num
)) {
1186 vq_err(vq
, "Indirect descriptor "
1187 "has out after in: idx %d\n", i
);
1192 } while ((i
= next_desc(&desc
)) != -1);
1196 /* This looks in the virtqueue and for the first available buffer, and converts
1197 * it to an iovec for convenient access. Since descriptors consist of some
1198 * number of output then some number of input descriptors, it's actually two
1199 * iovecs, but we pack them into one and note how many of each there were.
1201 * This function returns the descriptor number found, or vq->num (which is
1202 * never a valid descriptor number) if none was found. A negative code is
1203 * returned on error. */
1204 int vhost_get_vq_desc(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
,
1205 struct iovec iov
[], unsigned int iov_size
,
1206 unsigned int *out_num
, unsigned int *in_num
,
1207 struct vhost_log
*log
, unsigned int *log_num
)
1209 struct vring_desc desc
;
1210 unsigned int i
, head
, found
= 0;
1214 /* Check it isn't doing very strange things with descriptor numbers. */
1215 last_avail_idx
= vq
->last_avail_idx
;
1216 if (unlikely(__get_user(vq
->avail_idx
, &vq
->avail
->idx
))) {
1217 vq_err(vq
, "Failed to access avail idx at %p\n",
1222 if (unlikely((u16
)(vq
->avail_idx
- last_avail_idx
) > vq
->num
)) {
1223 vq_err(vq
, "Guest moved used index from %u to %u",
1224 last_avail_idx
, vq
->avail_idx
);
1228 /* If there's nothing new since last we looked, return invalid. */
1229 if (vq
->avail_idx
== last_avail_idx
)
1232 /* Only get avail ring entries after they have been exposed by guest. */
1235 /* Grab the next descriptor number they're advertising, and increment
1236 * the index we've seen. */
1237 if (unlikely(__get_user(head
,
1238 &vq
->avail
->ring
[last_avail_idx
% vq
->num
]))) {
1239 vq_err(vq
, "Failed to read head: idx %d address %p\n",
1241 &vq
->avail
->ring
[last_avail_idx
% vq
->num
]);
1245 /* If their number is silly, that's an error. */
1246 if (unlikely(head
>= vq
->num
)) {
1247 vq_err(vq
, "Guest says index %u > %u is available",
1252 /* When we start there are none of either input nor output. */
1253 *out_num
= *in_num
= 0;
1259 unsigned iov_count
= *in_num
+ *out_num
;
1260 if (unlikely(i
>= vq
->num
)) {
1261 vq_err(vq
, "Desc index is %u > %u, head = %u",
1265 if (unlikely(++found
> vq
->num
)) {
1266 vq_err(vq
, "Loop detected: last one at %u "
1267 "vq size %u head %u\n",
1271 ret
= __copy_from_user(&desc
, vq
->desc
+ i
, sizeof desc
);
1272 if (unlikely(ret
)) {
1273 vq_err(vq
, "Failed to get descriptor: idx %d addr %p\n",
1277 if (desc
.flags
& VRING_DESC_F_INDIRECT
) {
1278 ret
= get_indirect(dev
, vq
, iov
, iov_size
,
1280 log
, log_num
, &desc
);
1281 if (unlikely(ret
< 0)) {
1282 vq_err(vq
, "Failure detected "
1283 "in indirect descriptor at idx %d\n", i
);
1289 ret
= translate_desc(dev
, desc
.addr
, desc
.len
, iov
+ iov_count
,
1290 iov_size
- iov_count
);
1291 if (unlikely(ret
< 0)) {
1292 vq_err(vq
, "Translation failure %d descriptor idx %d\n",
1296 if (desc
.flags
& VRING_DESC_F_WRITE
) {
1297 /* If this is an input descriptor,
1298 * increment that count. */
1300 if (unlikely(log
)) {
1301 log
[*log_num
].addr
= desc
.addr
;
1302 log
[*log_num
].len
= desc
.len
;
1306 /* If it's an output descriptor, they're all supposed
1307 * to come before any input descriptors. */
1308 if (unlikely(*in_num
)) {
1309 vq_err(vq
, "Descriptor has out after in: "
1315 } while ((i
= next_desc(&desc
)) != -1);
1317 /* On success, increment avail index. */
1318 vq
->last_avail_idx
++;
1320 /* Assume notifications from guest are disabled at this point,
1321 * if they aren't we would need to update avail_event index. */
1322 BUG_ON(!(vq
->used_flags
& VRING_USED_F_NO_NOTIFY
));
1325 EXPORT_SYMBOL_GPL(vhost_get_vq_desc
);
1327 /* Reverse the effect of vhost_get_vq_desc. Useful for error handling. */
1328 void vhost_discard_vq_desc(struct vhost_virtqueue
*vq
, int n
)
1330 vq
->last_avail_idx
-= n
;
1332 EXPORT_SYMBOL_GPL(vhost_discard_vq_desc
);
1334 /* After we've used one of their buffers, we tell them about it. We'll then
1335 * want to notify the guest, using eventfd. */
1336 int vhost_add_used(struct vhost_virtqueue
*vq
, unsigned int head
, int len
)
1338 struct vring_used_elem heads
= { head
, len
};
1340 return vhost_add_used_n(vq
, &heads
, 1);
1342 EXPORT_SYMBOL_GPL(vhost_add_used
);
1344 static int __vhost_add_used_n(struct vhost_virtqueue
*vq
,
1345 struct vring_used_elem
*heads
,
1348 struct vring_used_elem __user
*used
;
1352 start
= vq
->last_used_idx
% vq
->num
;
1353 used
= vq
->used
->ring
+ start
;
1355 if (__put_user(heads
[0].id
, &used
->id
)) {
1356 vq_err(vq
, "Failed to write used id");
1359 if (__put_user(heads
[0].len
, &used
->len
)) {
1360 vq_err(vq
, "Failed to write used len");
1363 } else if (__copy_to_user(used
, heads
, count
* sizeof *used
)) {
1364 vq_err(vq
, "Failed to write used");
1367 if (unlikely(vq
->log_used
)) {
1368 /* Make sure data is seen before log. */
1370 /* Log used ring entry write. */
1371 log_write(vq
->log_base
,
1373 ((void __user
*)used
- (void __user
*)vq
->used
),
1374 count
* sizeof *used
);
1376 old
= vq
->last_used_idx
;
1377 new = (vq
->last_used_idx
+= count
);
1378 /* If the driver never bothers to signal in a very long while,
1379 * used index might wrap around. If that happens, invalidate
1380 * signalled_used index we stored. TODO: make sure driver
1381 * signals at least once in 2^16 and remove this. */
1382 if (unlikely((u16
)(new - vq
->signalled_used
) < (u16
)(new - old
)))
1383 vq
->signalled_used_valid
= false;
1387 /* After we've used one of their buffers, we tell them about it. We'll then
1388 * want to notify the guest, using eventfd. */
1389 int vhost_add_used_n(struct vhost_virtqueue
*vq
, struct vring_used_elem
*heads
,
1394 start
= vq
->last_used_idx
% vq
->num
;
1395 n
= vq
->num
- start
;
1397 r
= __vhost_add_used_n(vq
, heads
, n
);
1403 r
= __vhost_add_used_n(vq
, heads
, count
);
1405 /* Make sure buffer is written before we update index. */
1407 if (put_user(vq
->last_used_idx
, &vq
->used
->idx
)) {
1408 vq_err(vq
, "Failed to increment used idx");
1411 if (unlikely(vq
->log_used
)) {
1412 /* Log used index update. */
1413 log_write(vq
->log_base
,
1414 vq
->log_addr
+ offsetof(struct vring_used
, idx
),
1415 sizeof vq
->used
->idx
);
1417 eventfd_signal(vq
->log_ctx
, 1);
1421 EXPORT_SYMBOL_GPL(vhost_add_used_n
);
1423 static bool vhost_notify(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
1425 __u16 old
, new, event
;
1427 /* Flush out used index updates. This is paired
1428 * with the barrier that the Guest executes when enabling
1432 if (vhost_has_feature(dev
, VIRTIO_F_NOTIFY_ON_EMPTY
) &&
1433 unlikely(vq
->avail_idx
== vq
->last_avail_idx
))
1436 if (!vhost_has_feature(dev
, VIRTIO_RING_F_EVENT_IDX
)) {
1438 if (__get_user(flags
, &vq
->avail
->flags
)) {
1439 vq_err(vq
, "Failed to get flags");
1442 return !(flags
& VRING_AVAIL_F_NO_INTERRUPT
);
1444 old
= vq
->signalled_used
;
1445 v
= vq
->signalled_used_valid
;
1446 new = vq
->signalled_used
= vq
->last_used_idx
;
1447 vq
->signalled_used_valid
= true;
1452 if (get_user(event
, vhost_used_event(vq
))) {
1453 vq_err(vq
, "Failed to get used event idx");
1456 return vring_need_event(event
, new, old
);
1459 /* This actually signals the guest, using eventfd. */
1460 void vhost_signal(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
1462 /* Signal the Guest tell them we used something up. */
1463 if (vq
->call_ctx
&& vhost_notify(dev
, vq
))
1464 eventfd_signal(vq
->call_ctx
, 1);
1466 EXPORT_SYMBOL_GPL(vhost_signal
);
1468 /* And here's the combo meal deal. Supersize me! */
1469 void vhost_add_used_and_signal(struct vhost_dev
*dev
,
1470 struct vhost_virtqueue
*vq
,
1471 unsigned int head
, int len
)
1473 vhost_add_used(vq
, head
, len
);
1474 vhost_signal(dev
, vq
);
1476 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal
);
1478 /* multi-buffer version of vhost_add_used_and_signal */
1479 void vhost_add_used_and_signal_n(struct vhost_dev
*dev
,
1480 struct vhost_virtqueue
*vq
,
1481 struct vring_used_elem
*heads
, unsigned count
)
1483 vhost_add_used_n(vq
, heads
, count
);
1484 vhost_signal(dev
, vq
);
1486 EXPORT_SYMBOL_GPL(vhost_add_used_and_signal_n
);
1488 /* OK, now we need to know about added descriptors. */
1489 bool vhost_enable_notify(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
1494 if (!(vq
->used_flags
& VRING_USED_F_NO_NOTIFY
))
1496 vq
->used_flags
&= ~VRING_USED_F_NO_NOTIFY
;
1497 if (!vhost_has_feature(dev
, VIRTIO_RING_F_EVENT_IDX
)) {
1498 r
= vhost_update_used_flags(vq
);
1500 vq_err(vq
, "Failed to enable notification at %p: %d\n",
1501 &vq
->used
->flags
, r
);
1505 r
= vhost_update_avail_event(vq
, vq
->avail_idx
);
1507 vq_err(vq
, "Failed to update avail event index at %p: %d\n",
1508 vhost_avail_event(vq
), r
);
1512 /* They could have slipped one in as we were doing that: make
1513 * sure it's written, then check again. */
1515 r
= __get_user(avail_idx
, &vq
->avail
->idx
);
1517 vq_err(vq
, "Failed to check avail idx at %p: %d\n",
1518 &vq
->avail
->idx
, r
);
1522 return avail_idx
!= vq
->avail_idx
;
1524 EXPORT_SYMBOL_GPL(vhost_enable_notify
);
1526 /* We don't need to be notified again. */
1527 void vhost_disable_notify(struct vhost_dev
*dev
, struct vhost_virtqueue
*vq
)
1531 if (vq
->used_flags
& VRING_USED_F_NO_NOTIFY
)
1533 vq
->used_flags
|= VRING_USED_F_NO_NOTIFY
;
1534 if (!vhost_has_feature(dev
, VIRTIO_RING_F_EVENT_IDX
)) {
1535 r
= vhost_update_used_flags(vq
);
1537 vq_err(vq
, "Failed to enable notification at %p: %d\n",
1538 &vq
->used
->flags
, r
);
1541 EXPORT_SYMBOL_GPL(vhost_disable_notify
);
1543 static int __init
vhost_init(void)
1548 static void __exit
vhost_exit(void)
1552 module_init(vhost_init
);
1553 module_exit(vhost_exit
);
1555 MODULE_VERSION("0.0.1");
1556 MODULE_LICENSE("GPL v2");
1557 MODULE_AUTHOR("Michael S. Tsirkin");
1558 MODULE_DESCRIPTION("Host kernel accelerator for virtio");