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