98c26d664156b38bd4299b2926943c4b0c0d10af
[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.10 2007/07/01 01:11:37 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 #ifndef _MACHINE_VFRAME_H_
61 #include <machine/vframe.h>
62 #endif
63 #ifndef _MACHINE_LIMITS_H_
64 #include <machine/limits.h>
65 #endif
66
67 struct vmspace_rb_tree;
68 struct vmspace_entry;
69 RB_PROTOTYPE(vmspace_rb_tree, vmspace_entry, rb_entry, rb_vmspace_compare);
70
71 /*
72  * Process operating as virtual kernels manage multiple VM spaces.  The
73  * original VM space and trap context is saved in the process's vkernel
74  * structure.
75  */
76 struct vkernel_lwp {
77         struct trapframe save_trapframe;        /* swapped context */
78         struct vextframe save_vextframe;
79         struct trapframe *user_trapframe;       /* copyback to vkernel */
80         struct vextframe *user_vextframe;
81         struct vmspace_entry *ve;
82 };
83
84 struct vkernel_proc {
85         RB_HEAD(vmspace_rb_tree, vmspace_entry) root;
86         struct spinlock spin;
87         int refs;
88 };
89
90 struct vmspace_entry {
91         void *id;
92         struct vmspace *vmspace;
93         int flags;
94         int refs;                               /* current LWP assignments */
95         RB_ENTRY(vmspace_entry) rb_entry;
96 };
97
98 #ifdef _KERNEL
99
100 void vkernel_inherit(struct proc *p1, struct proc *p2);
101 void vkernel_exit(struct proc *p);
102 void vkernel_lwp_exit(struct lwp *lp);
103 void vkernel_trap(struct lwp *lp, struct trapframe *frame);
104
105 #endif
106
107 #else
108 /*
109  * USER ONLY DEFINITIONS
110  */
111
112 #ifndef _MACHINE_PARAM_H_
113 #include <machine/param.h>
114 #endif
115
116 #endif
117
118 /*
119  * KERNEL AND USER DEFINITIONS
120  *
121  * WARNING: vpte_t is 64 bits on a 64-bit box and 32 bits on a 32 bit box.
122  *          A 2-layer page table is used on 32 bit boxes and a 4-layer
123  *          page table is used on 64 bit boxes.
124  */
125 typedef u_long  vpte_t;
126
127 #if LONG_BIT == 32
128 #define VPTE_FRAME_END          32
129 #define VPTE_PAGE_BITS          10
130 #define VPTE_FRAME              0xFFFFF000L
131 #elif LONG_BIT == 64
132 #define VPTE_FRAME_END          48
133 #define VPTE_PAGE_BITS          9
134 #define VPTE_FRAME              0x000FFFFFFFFFF000L
135 #else
136 #error "LONG_BIT not defined"
137 #endif
138
139 #define VPTE_PAGE_ENTRIES       (PAGE_SIZE / sizeof(vpte_t))
140 #define VPTE_PAGE_MASK          ((1 << VPTE_PAGE_BITS) - 1)
141 #define VPTE_PAGETABLE_SIZE     PAGE_SIZE
142
143 #define VPTE_V          0x00000001      /* valid */
144 #define VPTE_PS         0x00000002      /* page directory direct mapping */
145 #define VPTE_R          0x00000004      /* readable */
146 #define VPTE_W          0x00000008      /* writable */
147 #define VPTE_X          0x00000010      /* executable */
148 #define VPTE_A          0x00000020      /* page accessed bit */
149 #define VPTE_M          0x00000040      /* page modified bit */
150 #define VPTE_U          0x00000080      /* user access bit if managed vmspace */
151 #define VPTE_MANAGED    0x00000100      /* managed bit ?? */
152 #define VPTE_G          0x00000200      /* global bit ?? */
153 #define VPTE_WIRED      0x00000400      /* wired */
154
155 #endif
156