4 * Copyright (c) 2006 The DragonFly Project. All rights reserved.
6 * This code is derived from software contributed to The DragonFly Project
7 * by Matthew Dillon <dillon@backplane.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
19 * 3. Neither the name of The DragonFly Project nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific, prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
33 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #include <sys/param.h>
38 #include <sys/kernel.h>
39 #include <sys/systm.h>
40 #include <sys/sysproto.h>
41 #include <sys/kern_syscall.h>
43 #include <sys/thread.h>
45 #include <sys/malloc.h>
46 #include <sys/sysctl.h>
47 #include <sys/vkernel.h>
48 #include <sys/vmspace.h>
50 #include <vm/vm_extern.h>
53 #include <machine/vmparam.h>
54 #include <machine/vmm.h>
56 #include <sys/sysref2.h>
58 static struct vmspace_entry
*vkernel_find_vmspace(struct vkernel_proc
*vkp
,
60 static void vmspace_entry_delete(struct vmspace_entry
*ve
,
61 struct vkernel_proc
*vkp
);
63 static MALLOC_DEFINE(M_VKERNEL
, "vkernel", "VKernel structures");
66 * vmspace_create (void *id, int type, void *data)
68 * Create a VMSPACE under the control of the caller with the specified id.
69 * An id of NULL cannot be used. The type and data fields must currently
72 * The vmspace starts out completely empty. Memory may be mapped into the
73 * VMSPACE with vmspace_mmap() and MAP_VPAGETABLE section(s) controlled
74 * with vmspace_mcontrol().
79 sys_vmspace_create(struct vmspace_create_args
*uap
)
81 struct vmspace_entry
*ve
;
82 struct vkernel_proc
*vkp
;
83 struct proc
*p
= curproc
;
86 if (vkernel_enable
== 0)
90 * Create a virtual kernel side-structure for the process if one
93 * Implement a simple resolution for SMP races.
95 if ((vkp
= p
->p_vkernel
) == NULL
) {
96 vkp
= kmalloc(sizeof(*vkp
), M_VKERNEL
, M_WAITOK
|M_ZERO
);
97 lwkt_gettoken(&p
->p_token
);
98 if (p
->p_vkernel
== NULL
) {
100 lwkt_token_init(&vkp
->token
, "vkernel");
104 kfree(vkp
, M_VKERNEL
);
107 lwkt_reltoken(&p
->p_token
);
110 if (curthread
->td_vmm
)
114 * Create a new VMSPACE, disallow conflicting ids
116 ve
= kmalloc(sizeof(struct vmspace_entry
), M_VKERNEL
, M_WAITOK
|M_ZERO
);
117 ve
->vmspace
= vmspace_alloc(VM_MIN_USER_ADDRESS
, VM_MAX_USER_ADDRESS
);
119 pmap_pinit2(vmspace_pmap(ve
->vmspace
));
121 lwkt_gettoken(&vkp
->token
);
122 if (RB_INSERT(vmspace_rb_tree
, &vkp
->root
, ve
)) {
123 vmspace_rel(ve
->vmspace
);
124 ve
->vmspace
= NULL
; /* safety */
125 kfree(ve
, M_VKERNEL
);
130 lwkt_reltoken(&vkp
->token
);
136 * Destroy a VMSPACE given its identifier.
141 sys_vmspace_destroy(struct vmspace_destroy_args
*uap
)
143 struct vkernel_proc
*vkp
;
144 struct vmspace_entry
*ve
;
147 if ((vkp
= curproc
->p_vkernel
) == NULL
) {
151 lwkt_gettoken(&vkp
->token
);
152 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) == NULL
) {
160 vmspace_entry_delete(ve
, vkp
);
163 lwkt_reltoken(&vkp
->token
);
169 * vmspace_ctl (void *id, int cmd, struct trapframe *tframe,
170 * struct vextframe *vframe);
172 * Transfer control to a VMSPACE. Control is returned after the specified
173 * number of microseconds or if a page fault, signal, trap, or system call
174 * occurs. The context is updated as appropriate.
179 sys_vmspace_ctl(struct vmspace_ctl_args
*uap
)
181 struct vkernel_proc
*vkp
;
182 struct vkernel_lwp
*vklp
;
183 struct vmspace_entry
*ve
= NULL
;
189 lp
= curthread
->td_lwp
;
192 if ((vkp
= p
->p_vkernel
) == NULL
)
196 * ve only matters when VMM is not used.
198 if (curthread
->td_vmm
== NULL
) {
199 lwkt_gettoken(&vkp
->token
);
200 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) == NULL
) {
207 case VMSPACE_CTL_RUN
:
209 * Save the caller's register context, swap VM spaces, and
210 * install the passed register context. Return with
211 * EJUSTRETURN so the syscall code doesn't adjust the context.
213 if (curthread
->td_vmm
== NULL
)
214 atomic_add_int(&ve
->refs
, 1);
216 framesz
= sizeof(struct trapframe
);
217 if ((vklp
= lp
->lwp_vkernel
) == NULL
) {
218 vklp
= kmalloc(sizeof(*vklp
), M_VKERNEL
,
220 lp
->lwp_vkernel
= vklp
;
222 vklp
->user_trapframe
= uap
->tframe
;
223 vklp
->user_vextframe
= uap
->vframe
;
224 bcopy(uap
->sysmsg_frame
, &vklp
->save_trapframe
, framesz
);
225 bcopy(&curthread
->td_tls
, &vklp
->save_vextframe
.vx_tls
,
226 sizeof(vklp
->save_vextframe
.vx_tls
));
227 error
= copyin(uap
->tframe
, uap
->sysmsg_frame
, framesz
);
229 error
= copyin(&uap
->vframe
->vx_tls
,
231 sizeof(struct savetls
));
234 error
= cpu_sanitize_frame(uap
->sysmsg_frame
);
236 error
= cpu_sanitize_tls(&curthread
->td_tls
);
238 bcopy(&vklp
->save_trapframe
, uap
->sysmsg_frame
,
240 bcopy(&vklp
->save_vextframe
.vx_tls
, &curthread
->td_tls
,
241 sizeof(vklp
->save_vextframe
.vx_tls
));
243 if (curthread
->td_vmm
== NULL
)
244 atomic_subtract_int(&ve
->refs
, 1);
246 /* If it's a VMM thread just set the CR3. We also set the
247 * vklp->ve to a key to be able to distinguish when a
248 * vkernel user process runs and when not (when it's NULL)
250 if (curthread
->td_vmm
== NULL
) {
252 pmap_setlwpvm(lp
, ve
->vmspace
);
255 vmm_vm_set_guest_cr3((register_t
)uap
->id
);
258 set_vkernel_fp(uap
->sysmsg_frame
);
267 if (curthread
->td_vmm
== NULL
)
268 lwkt_reltoken(&vkp
->token
);
273 * vmspace_mmap(id, addr, len, prot, flags, fd, offset)
275 * map memory within a VMSPACE. This function is just like a normal mmap()
276 * but operates on the vmspace's memory map. Most callers use this to create
277 * a MAP_VPAGETABLE mapping.
282 sys_vmspace_mmap(struct vmspace_mmap_args
*uap
)
284 struct vkernel_proc
*vkp
;
285 struct vmspace_entry
*ve
;
289 * We hold the vmspace token to serialize calls to vkernel_find_vmspace.
291 lwkt_gettoken(&vmspace_token
);
292 if ((vkp
= curproc
->p_vkernel
) == NULL
) {
298 * NOTE: kern_mmap() can block so we need to temporarily ref ve->refs.
300 lwkt_gettoken(&vkp
->token
);
301 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) != NULL
) {
302 atomic_add_int(&ve
->refs
, 1);
303 error
= kern_mmap(ve
->vmspace
, uap
->addr
, uap
->len
,
304 uap
->prot
, uap
->flags
,
305 uap
->fd
, uap
->offset
, &uap
->sysmsg_resultp
);
306 atomic_subtract_int(&ve
->refs
, 1);
310 lwkt_reltoken(&vkp
->token
);
312 lwkt_reltoken(&vmspace_token
);
317 * vmspace_munmap(id, addr, len)
319 * unmap memory within a VMSPACE.
324 sys_vmspace_munmap(struct vmspace_munmap_args
*uap
)
326 struct vkernel_proc
*vkp
;
327 struct vmspace_entry
*ve
;
330 vm_size_t size
, pageoff
;
334 if ((vkp
= curproc
->p_vkernel
) == NULL
) {
338 lwkt_gettoken(&vkp
->token
);
339 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) == NULL
) {
345 * NOTE: kern_munmap() can block so we need to temporarily
348 atomic_add_int(&ve
->refs
, 1);
351 * Copied from sys_munmap()
353 addr
= (vm_offset_t
)uap
->addr
;
356 pageoff
= (addr
& PAGE_MASK
);
359 size
= (vm_size_t
)round_page(size
);
360 if (size
< uap
->len
) { /* wrap */
364 tmpaddr
= addr
+ size
; /* workaround gcc4 opt */
365 if (tmpaddr
< addr
) { /* wrap */
374 if (VM_MAX_USER_ADDRESS
> 0 && tmpaddr
> VM_MAX_USER_ADDRESS
) {
378 if (VM_MIN_USER_ADDRESS
> 0 && addr
< VM_MIN_USER_ADDRESS
) {
382 map
= &ve
->vmspace
->vm_map
;
383 if (!vm_map_check_protection(map
, addr
, tmpaddr
, VM_PROT_NONE
, FALSE
)) {
387 vm_map_remove(map
, addr
, addr
+ size
);
390 atomic_subtract_int(&ve
->refs
, 1);
392 lwkt_reltoken(&vkp
->token
);
398 * vmspace_pread(id, buf, nbyte, flags, offset)
400 * Read data from a vmspace. The number of bytes read is returned or
401 * -1 if an unrecoverable error occured. If the number of bytes read is
402 * less then the request size, a page fault occured in the VMSPACE which
403 * the caller must resolve in order to proceed.
405 * (not implemented yet)
409 sys_vmspace_pread(struct vmspace_pread_args
*uap
)
411 struct vkernel_proc
*vkp
;
412 struct vmspace_entry
*ve
;
415 if ((vkp
= curproc
->p_vkernel
) == NULL
) {
419 lwkt_gettoken(&vkp
->token
);
420 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) == NULL
) {
426 lwkt_reltoken(&vkp
->token
);
432 * vmspace_pwrite(id, buf, nbyte, flags, offset)
434 * Write data to a vmspace. The number of bytes written is returned or
435 * -1 if an unrecoverable error occured. If the number of bytes written is
436 * less then the request size, a page fault occured in the VMSPACE which
437 * the caller must resolve in order to proceed.
439 * (not implemented yet)
443 sys_vmspace_pwrite(struct vmspace_pwrite_args
*uap
)
445 struct vkernel_proc
*vkp
;
446 struct vmspace_entry
*ve
;
449 if ((vkp
= curproc
->p_vkernel
) == NULL
) {
453 lwkt_gettoken(&vkp
->token
);
454 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) == NULL
) {
460 lwkt_reltoken(&vkp
->token
);
466 * vmspace_mcontrol(id, addr, len, behav, value)
468 * madvise/mcontrol support for a vmspace.
473 sys_vmspace_mcontrol(struct vmspace_mcontrol_args
*uap
)
475 struct vkernel_proc
*vkp
;
476 struct vmspace_entry
*ve
;
477 vm_offset_t start
, end
;
478 vm_offset_t tmpaddr
= (vm_offset_t
)uap
->addr
+ uap
->len
;
481 if ((vkp
= curproc
->p_vkernel
) == NULL
) {
485 lwkt_gettoken(&vkp
->token
);
486 if ((ve
= vkernel_find_vmspace(vkp
, uap
->id
)) == NULL
) {
492 * NOTE: kern_madvise() can block so we need to temporarily
495 atomic_add_int(&ve
->refs
, 1);
498 * This code is basically copied from sys_mcontrol()
500 if (uap
->behav
< 0 || uap
->behav
> MADV_CONTROL_END
) {
505 if (tmpaddr
< (vm_offset_t
)uap
->addr
) {
509 if (VM_MAX_USER_ADDRESS
> 0 && tmpaddr
> VM_MAX_USER_ADDRESS
) {
513 if (VM_MIN_USER_ADDRESS
> 0 && uap
->addr
< VM_MIN_USER_ADDRESS
) {
518 start
= trunc_page((vm_offset_t
) uap
->addr
);
519 end
= round_page(tmpaddr
);
521 error
= vm_map_madvise(&ve
->vmspace
->vm_map
, start
, end
,
522 uap
->behav
, uap
->value
);
524 atomic_subtract_int(&ve
->refs
, 1);
526 lwkt_reltoken(&vkp
->token
);
532 * Red black tree functions
534 static int rb_vmspace_compare(struct vmspace_entry
*, struct vmspace_entry
*);
535 RB_GENERATE(vmspace_rb_tree
, vmspace_entry
, rb_entry
, rb_vmspace_compare
);
538 * a->start is address, and the only field has to be initialized.
539 * The caller must hold vkp->token.
541 * The caller must hold vkp->token.
544 rb_vmspace_compare(struct vmspace_entry
*a
, struct vmspace_entry
*b
)
546 if ((char *)a
->id
< (char *)b
->id
)
548 else if ((char *)a
->id
> (char *)b
->id
)
554 * The caller must hold vkp->token.
558 rb_vmspace_delete(struct vmspace_entry
*ve
, void *data
)
560 struct vkernel_proc
*vkp
= data
;
562 KKASSERT(ve
->refs
== 0);
563 vmspace_entry_delete(ve
, vkp
);
568 * Remove a vmspace_entry from the RB tree and destroy it. We have to clean
569 * up the pmap, the vm_map, then destroy the vmspace.
571 * This function must remove the ve immediately before it might potentially
574 * The caller must hold vkp->token.
578 vmspace_entry_delete(struct vmspace_entry
*ve
, struct vkernel_proc
*vkp
)
580 RB_REMOVE(vmspace_rb_tree
, &vkp
->root
, ve
);
582 pmap_remove_pages(vmspace_pmap(ve
->vmspace
),
583 VM_MIN_USER_ADDRESS
, VM_MAX_USER_ADDRESS
);
584 vm_map_remove(&ve
->vmspace
->vm_map
,
585 VM_MIN_USER_ADDRESS
, VM_MAX_USER_ADDRESS
);
586 vmspace_rel(ve
->vmspace
);
587 ve
->vmspace
= NULL
; /* safety */
588 kfree(ve
, M_VKERNEL
);
592 * Locate the ve for (id), return the ve or NULL. If found this function
593 * will bump ve->refs which prevents the ve from being immediately destroyed
594 * (but it can still be removed).
596 * The caller must hold vkp->token.
599 struct vmspace_entry
*
600 vkernel_find_vmspace(struct vkernel_proc
*vkp
, void *id
)
602 struct vmspace_entry
*ve
;
603 struct vmspace_entry key
;
606 ve
= RB_FIND(vmspace_rb_tree
, &vkp
->root
, &key
);
611 * Manage vkernel refs, used by the kernel when fork()ing or exit()ing
617 vkernel_inherit(struct proc
*p1
, struct proc
*p2
)
619 struct vkernel_proc
*vkp
;
622 KKASSERT(vkp
->refs
> 0);
623 atomic_add_int(&vkp
->refs
, 1);
631 vkernel_exit(struct proc
*p
)
633 struct vkernel_proc
*vkp
;
639 * Restore the original VM context if we are killed while running
642 * This isn't supposed to happen. What is supposed to happen is
643 * that the process should enter vkernel_trap() before the handling
646 RB_FOREACH(lp
, lwp_rb_tree
, &p
->p_lwp_tree
) {
647 vkernel_lwp_exit(lp
);
651 * Dereference the common area
654 KKASSERT(vkp
->refs
> 0);
656 if (atomic_fetchadd_int(&vkp
->refs
, -1) == 1) {
657 lwkt_gettoken(&vkp
->token
);
658 RB_SCAN(vmspace_rb_tree
, &vkp
->root
, NULL
,
659 rb_vmspace_delete
, vkp
);
660 lwkt_reltoken(&vkp
->token
);
661 kfree(vkp
, M_VKERNEL
);
669 vkernel_lwp_exit(struct lwp
*lp
)
671 struct vkernel_lwp
*vklp
;
672 struct vmspace_entry
*ve
;
674 if ((vklp
= lp
->lwp_vkernel
) != NULL
) {
675 if ((ve
= vklp
->ve
) != NULL
) {
676 kprintf("Warning, pid %d killed with "
677 "active VC!\n", lp
->lwp_proc
->p_pid
);
678 pmap_setlwpvm(lp
, lp
->lwp_proc
->p_vmspace
);
680 KKASSERT(ve
->refs
> 0);
681 atomic_subtract_int(&ve
->refs
, 1);
683 lp
->lwp_vkernel
= NULL
;
684 kfree(vklp
, M_VKERNEL
);
689 * A VM space under virtual kernel control trapped out or made a system call
690 * or otherwise needs to return control to the virtual kernel context.
695 vkernel_trap(struct lwp
*lp
, struct trapframe
*frame
)
697 struct proc
*p
= lp
->lwp_proc
;
698 struct vmspace_entry
*ve
;
699 struct vkernel_lwp
*vklp
;
703 * Which vmspace entry was running?
705 vklp
= lp
->lwp_vkernel
;
708 /* If it's a VMM thread just set the vkernel CR3 back */
709 if (curthread
->td_vmm
== NULL
) {
711 KKASSERT(ve
!= NULL
);
714 * Switch the LWP vmspace back to the virtual kernel's VM space.
717 pmap_setlwpvm(lp
, p
->p_vmspace
);
718 KKASSERT(ve
->refs
> 0);
719 atomic_subtract_int(&ve
->refs
, 1);
720 /* ve is invalid once we kill our ref */
723 vmm_vm_set_guest_cr3(p
->p_vkernel
->vkernel_cr3
);
726 * Copy the emulated process frame to the virtual kernel process.
727 * The emulated process cannot change TLS descriptors so don't
728 * bother saving them, we already have a copy.
730 * Restore the virtual kernel's saved context so the virtual kernel
731 * process can resume.
733 error
= copyout(frame
, vklp
->user_trapframe
, sizeof(*frame
));
734 bcopy(&vklp
->save_trapframe
, frame
, sizeof(*frame
));
735 bcopy(&vklp
->save_vextframe
.vx_tls
, &curthread
->td_tls
,
736 sizeof(vklp
->save_vextframe
.vx_tls
));
738 cpu_vkernel_trap(frame
, error
);