Misc vkernel work.
[dragonfly.git] / sys / sys / vkernel.h
1 /*
2  * Copyright (c) 2006 The DragonFly Project.  All rights reserved.
3  * 
4  * This code is derived from software contributed to The DragonFly Project
5  * by Matthew Dillon <dillon@backplane.com>
6  * 
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  * 
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  * 
34  * $DragonFly: src/sys/sys/vkernel.h,v 1.5 2006/12/04 18:04:05 dillon Exp $
35  */
36
37 #ifndef _SYS_VKERNEL_H_
38 #define _SYS_VKERNEL_H_
39
40 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
41 /*
42  * KERNEL ONLY DEFINITIONS
43  */
44
45 #ifndef _SYS_PARAM_H_
46 #include <sys/param.h>
47 #endif
48 #ifndef _SYS_QUEUE_H_
49 #include <sys/queue.h>
50 #endif
51 #ifndef _SYS_TREE_H_
52 #include <sys/tree.h>
53 #endif
54 #ifndef _SYS_SPINLOCK_H_
55 #include <sys/spinlock.h>
56 #endif
57 #ifndef _MACHINE_FRAME_H_
58 #include <machine/frame.h>
59 #endif
60
61 struct vmspace_rb_tree;
62 struct vmspace_entry;
63 RB_PROTOTYPE(vmspace_rb_tree, vmspace_entry, rb_entry, rb_vmspace_compare);
64
65 /*
66  * Process operating as virtual kernels manage multiple VM spaces.  The
67  * original VM space and trap context is saved in the process's vkernel
68  * structure.
69  */
70 struct vkernel {
71         struct vmspace *vk_save_vmspace;        /* saved VM space */
72         struct trapframe vk_save_frame;         /* saved trap frame */
73         struct trapframe *vk_user_frame;        /* copyback to user process */
74         struct vkernel_common *vk_common;       /* shared data */
75         struct vmspace_entry *vk_current;
76 };
77
78 struct vkernel_common {
79         RB_HEAD(vmspace_rb_tree, vmspace_entry) vc_root;
80         struct spinlock vc_spin;
81         int vc_refs;
82 };
83
84 struct vmspace_entry {
85         void *id;
86         struct vmspace *vmspace;
87         int flags;
88         int refs;                               /* when vk_current */
89         RB_ENTRY(vmspace_entry) rb_entry;
90 };
91
92 #ifdef _KERNEL
93
94 void vkernel_inherit(struct proc *p1, struct proc *p2);
95 void vkernel_exit(struct proc *p);
96 int vkernel_trap(struct proc *p, struct trapframe *frame);
97
98 #endif
99
100 #else
101 /*
102  * USER ONLY DEFINITIONS
103  */
104
105 #ifndef _MACHINE_PARAM_H_
106 #include <machine/param.h>
107 #endif
108
109 #endif
110
111 /*
112  * KERNEL AND USER DEFINITIONS
113  */
114
115 typedef u_int32_t       vpte_t;
116
117 #define VPTE_PAGE_ENTRIES       (PAGE_SIZE / sizeof(vpte_t))
118 #define VPTE_PAGE_BITS          10
119 #define VPTE_PAGE_MASK          ((1 << VPTE_PAGE_BITS) - 1)
120
121 #define VPTE_V          0x00000001
122 #define VPTE_PS         0x00000002
123 #define VPTE_R          0x00000004
124 #define VPTE_W          0x00000008
125 #define VPTE_X          0x00000010
126
127 #endif
128