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