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