xref: /dragonfly/sys/sys/vkernel.h (revision 23265324)
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.8 2007/01/08 19:45:39 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 
64 struct vmspace_rb_tree;
65 struct vmspace_entry;
66 RB_PROTOTYPE(vmspace_rb_tree, vmspace_entry, rb_entry, rb_vmspace_compare);
67 
68 /*
69  * Process operating as virtual kernels manage multiple VM spaces.  The
70  * original VM space and trap context is saved in the process's vkernel
71  * structure.
72  */
73 struct vkernel {
74 	struct vmspace *vk_save_vmspace;	/* saved VM space */
75 	struct trapframe vk_save_trapframe;	/* swapped context */
76 	struct vextframe vk_save_vextframe;
77 	struct trapframe *vk_user_trapframe;	/* copyback to vkernel */
78 	struct vextframe *vk_user_vextframe;
79 	struct vkernel_common *vk_common;	/* shared data */
80 	struct vmspace_entry *vk_current;
81 };
82 
83 struct vkernel_common {
84 	RB_HEAD(vmspace_rb_tree, vmspace_entry) vc_root;
85 	struct spinlock vc_spin;
86 	int vc_refs;
87 };
88 
89 struct vmspace_entry {
90 	void *id;
91 	struct vmspace *vmspace;
92 	int flags;
93 	int refs;				/* when vk_current */
94 	RB_ENTRY(vmspace_entry) rb_entry;
95 };
96 
97 #ifdef _KERNEL
98 
99 void vkernel_inherit(struct proc *p1, struct proc *p2);
100 void vkernel_exit(struct proc *p);
101 int vkernel_trap(struct proc *p, 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 
120 typedef u_int32_t	vpte_t;
121 
122 #define VPTE_PAGE_ENTRIES	(PAGE_SIZE / sizeof(vpte_t))
123 #define VPTE_PAGE_BITS		10
124 #define VPTE_PAGE_MASK		((1 << VPTE_PAGE_BITS) - 1)
125 #define VPTE_PAGETABLE_SIZE	PAGE_SIZE
126 
127 #define VPTE_V		0x00000001	/* valid */
128 #define VPTE_PS		0x00000002	/* page directory direct mapping */
129 #define VPTE_R		0x00000004	/* readable */
130 #define VPTE_W		0x00000008	/* writable */
131 #define VPTE_X		0x00000010	/* executable */
132 #define VPTE_A		0x00000020	/* page accessed bit */
133 #define VPTE_M		0x00000040	/* page modified bit */
134 #define VPTE_U		0x00000080	/* user access bit if managed vmspace */
135 #define VPTE_MANAGED	0x00000100	/* managed bit ?? */
136 #define VPTE_G		0x00000200	/* global bit ?? */
137 #define VPTE_WIRED	0x00000400	/* wired */
138 
139 #define VPTE_FRAME	0xFFFFF000
140 
141 #endif
142 
143