xref: /netbsd-src/sys/arch/i386/include/segments.h (revision bdc22b2e01993381dcefeff2bc9b56ca75a4235c)
1 /*	$NetBSD: segments.h,v 1.64 2017/12/31 08:29:38 maxv Exp $	*/
2 
3 /*-
4  * Copyright (c) 1990 The Regents of the University of California.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * William Jolitz.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)segments.h	7.1 (Berkeley) 5/9/91
35  */
36 
37 /*-
38  * Copyright (c) 1995, 1997
39  *	Charles M. Hannum.  All rights reserved.
40  * Copyright (c) 1989, 1990 William F. Jolitz
41  *
42  * This code is derived from software contributed to Berkeley by
43  * William Jolitz.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  * 1. Redistributions of source code must retain the above copyright
49  *    notice, this list of conditions and the following disclaimer.
50  * 2. Redistributions in binary form must reproduce the above copyright
51  *    notice, this list of conditions and the following disclaimer in the
52  *    documentation and/or other materials provided with the distribution.
53  * 3. All advertising materials mentioning features or use of this software
54  *    must display the following acknowledgement:
55  *	This product includes software developed by the University of
56  *	California, Berkeley and its contributors.
57  * 4. Neither the name of the University nor the names of its contributors
58  *    may be used to endorse or promote products derived from this software
59  *    without specific prior written permission.
60  *
61  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
62  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
63  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
64  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
65  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
66  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
67  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
68  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
69  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
70  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
71  * SUCH DAMAGE.
72  *
73  *	@(#)segments.h	7.1 (Berkeley) 5/9/91
74  */
75 
76 /*
77  * 386 Segmentation Data Structures and definitions
78  *	William F. Jolitz (william@ernie.berkeley.edu) 6/20/1989
79  */
80 
81 #ifndef _I386_SEGMENTS_H_
82 #define _I386_SEGMENTS_H_
83 #ifdef _KERNEL_OPT
84 #include "opt_xen.h"
85 #endif
86 
87 /*
88  * Selectors
89  */
90 
91 #define ISPL(s)		((s) & SEL_RPL)	/* what is the priority level of a selector */
92 #ifndef XEN
93 #define SEL_KPL		0		/* kernel privilege level */
94 #else
95 #define SEL_XEN		0		/* Xen privilege level */
96 #define SEL_KPL		1		/* kernel privilege level */
97 #endif /* XEN */
98 #define SEL_UPL		3		/* user privilege level */
99 #define SEL_RPL		3		/* requester's privilege level mask */
100 #ifdef XEN
101 #define CHK_UPL		2		/* user privilege level mask */
102 #else
103 #define CHK_UPL		SEL_RPL
104 #endif /* XEN */
105 #define ISLDT(s)	((s) & SEL_LDT)	/* is it local or global */
106 #define SEL_LDT		4		/* local descriptor table */
107 
108 #define IOPL_KPL	SEL_KPL
109 
110 /* Dynamically allocated TSSs and LDTs start (byte offset) */
111 #define DYNSEL_START	(NGDT << 3)
112 
113 #define IDXSEL(s)	(((s) >> 3) & 0x1fff)		/* index of selector */
114 #define IDXSELN(s)	(((s) >> 3))			/* index of selector */
115 #define IDXDYNSEL(s)	((((s) & ~SEL_RPL) - DYNSEL_START) >> 3)
116 
117 #define GSEL(s,r)	(((s) << 3) | r)		/* a global selector */
118 #define GSYSSEL(s,r)	GSEL(s,r)			/* compat with amd64 */
119 #define GDYNSEL(s,r)	((((s) << 3) + DYNSEL_START) | r | SEL_KPL)
120 
121 #define LSEL(s,r)	(((s) << 3) | r | SEL_LDT)	/* a local selector */
122 
123 #define USERMODE(c)		(ISPL(c) == SEL_UPL)
124 #define KERNELMODE(c)		(ISPL(c) == SEL_KPL)
125 
126 #ifndef _LOCORE
127 
128 #if __GNUC__ == 2 && __GNUC_MINOR__ < 7
129 #pragma pack(1)
130 #endif
131 
132 /*
133  * Memory and System segment descriptors (both 8 bytes).
134  */
135 struct segment_descriptor {
136 	unsigned sd_lolimit:16;		/* segment extent (lsb) */
137 	unsigned sd_lobase:24;		/* segment base address (lsb) */
138 	unsigned sd_type:5;		/* segment type */
139 	unsigned sd_dpl:2;		/* segment descriptor priority level */
140 	unsigned sd_p:1;		/* segment descriptor present */
141 	unsigned sd_hilimit:4;		/* segment extent (msb) */
142 	unsigned sd_xx:2;		/* unused */
143 	unsigned sd_def32:1;		/* default 32 vs 16 bit size */
144 	unsigned sd_gran:1;		/* limit granularity (byte/page) */
145 	unsigned sd_hibase:8;		/* segment base address (msb) */
146 } __packed;
147 
148 /*
149  * Gate descriptors (8 bytes).
150  */
151 struct gate_descriptor {
152 	unsigned gd_looffset:16;	/* gate offset (lsb) */
153 	unsigned gd_selector:16;	/* gate segment selector */
154 	unsigned gd_stkcpy:5;		/* number of stack wds to cpy */
155 	unsigned gd_xx:3;		/* unused */
156 	unsigned gd_type:5;		/* segment type */
157 	unsigned gd_dpl:2;		/* segment descriptor priority level */
158 	unsigned gd_p:1;		/* segment descriptor present */
159 	unsigned gd_hioffset:16;	/* gate offset (msb) */
160 } __packed;
161 
162 /*
163  * Xen-specific?
164  */
165 struct ldt_descriptor {
166 	__vaddr_t ld_base;
167 	uint32_t ld_entries;
168 } __packed;
169 
170 /*
171  * Generic descriptor (8 bytes).
172  */
173 union descriptor {
174 	struct segment_descriptor sd;
175 	struct gate_descriptor gd;
176 	struct ldt_descriptor ld;
177 	uint32_t raw[2];
178 	uint64_t raw64;
179 } __packed;
180 
181 /*
182  * Region descriptors, used to load gdt/idt tables before segments yet exist.
183  */
184 struct region_descriptor {
185 	unsigned rd_limit:16;		/* segment extent */
186 	unsigned rd_base:32;		/* base address  */
187 } __packed;
188 
189 #if __GNUC__ == 2 && __GNUC_MINOR__ < 7
190 #pragma pack(4)
191 #endif
192 
193 #ifdef _KERNEL
194 extern union descriptor *gdtstore, *ldtstore;
195 extern struct gate_descriptor *idt;
196 
197 void setgate(struct gate_descriptor *, void *, int, int, int, int);
198 void setregion(struct region_descriptor *, void *, size_t);
199 void setsegment(struct segment_descriptor *, const void *, size_t, int, int,
200     int, int);
201 void unsetgate(struct gate_descriptor *);
202 void cpu_init_idt(void);
203 void update_descriptor(union descriptor *, union descriptor *);
204 
205 
206 void idt_vec_reserve(int);
207 int idt_vec_alloc(int, int);
208 void idt_vec_set(int, void (*)(void));
209 void idt_vec_free(int);
210 
211 
212 #endif /* _KERNEL */
213 
214 #endif /* !_LOCORE */
215 
216 /* system segments and gate types */
217 #define SDT_SYSNULL	 0	/* system null */
218 #define SDT_SYS286TSS	 1	/* system 286 TSS available */
219 #define SDT_SYSLDT	 2	/* system local descriptor table */
220 #define SDT_SYS286BSY	 3	/* system 286 TSS busy */
221 #define SDT_SYS286CGT	 4	/* system 286 call gate */
222 #define SDT_SYSTASKGT	 5	/* system task gate */
223 #define SDT_SYS286IGT	 6	/* system 286 interrupt gate */
224 #define SDT_SYS286TGT	 7	/* system 286 trap gate */
225 #define SDT_SYSNULL2	 8	/* system null again */
226 #define SDT_SYS386TSS	 9	/* system 386 TSS available */
227 #define SDT_SYSNULL3	10	/* system null again */
228 #define SDT_SYS386BSY	11	/* system 386 TSS busy */
229 #define SDT_SYS386CGT	12	/* system 386 call gate */
230 #define SDT_SYSNULL4	13	/* system null again */
231 #define SDT_SYS386IGT	14	/* system 386 interrupt gate */
232 #define SDT_SYS386TGT	15	/* system 386 trap gate */
233 
234 /* memory segment types */
235 #define SDT_MEMRO	16	/* memory read only */
236 #define SDT_MEMROA	17	/* memory read only accessed */
237 #define SDT_MEMRW	18	/* memory read write */
238 #define SDT_MEMRWA	19	/* memory read write accessed */
239 #define SDT_MEMROD	20	/* memory read only expand dwn limit */
240 #define SDT_MEMRODA	21	/* memory read only expand dwn limit accessed */
241 #define SDT_MEMRWD	22	/* memory read write expand dwn limit */
242 #define SDT_MEMRWDA	23	/* memory read write expand dwn limit acessed */
243 #define SDT_MEME	24	/* memory execute only */
244 #define SDT_MEMEA	25	/* memory execute only accessed */
245 #define SDT_MEMER	26	/* memory execute read */
246 #define SDT_MEMERA	27	/* memory execute read accessed */
247 #define SDT_MEMEC	28	/* memory execute only conforming */
248 #define SDT_MEMEAC	29	/* memory execute only accessed conforming */
249 #define SDT_MEMERC	30	/* memory execute read conforming */
250 #define SDT_MEMERAC	31	/* memory execute read accessed conforming */
251 
252 #define SDTYPE(p)	(((const struct segment_descriptor *)(p))->sd_type)
253 /* is memory segment descriptor pointer ? */
254 #define ISMEMSDP(s)	(SDTYPE(s) >= SDT_MEMRO && \
255 			 SDTYPE(s) <= SDT_MEMERAC)
256 
257 /* is 286 gate descriptor pointer ? */
258 #define IS286GDP(s)	(SDTYPE(s) >= SDT_SYS286CGT && \
259 			 SDTYPE(s) < SDT_SYS286TGT)
260 
261 /* is 386 gate descriptor pointer ? */
262 #define IS386GDP(s)	(SDTYPE(s) >= SDT_SYS386CGT && \
263 			 SDTYPE(s) < SDT_SYS386TGT)
264 
265 /* is gate descriptor pointer ? */
266 #define ISGDP(s)	(IS286GDP(s) || IS386GDP(s))
267 
268 /* is segment descriptor pointer ? */
269 #define ISSDP(s)	(ISMEMSDP(s) || !ISGDP(s))
270 
271 /* is system segment descriptor pointer ? */
272 #define ISSYSSDP(s)	(!ISMEMSDP(s) && !ISGDP(s))
273 
274 /*
275  * Segment Protection Exception code bits
276  */
277 #define SEGEX_EXT	0x01	/* recursive or externally induced */
278 #define SEGEX_IDT	0x02	/* interrupt descriptor table */
279 #define SEGEX_TI	0x04	/* local descriptor table */
280 
281 /*
282  * Entries in the Interrupt Descriptor Table (IDT)
283  */
284 #define NIDT	256
285 #define NRSVIDT	32		/* reserved entries for CPU exceptions */
286 
287 /*
288  * Entries in the Global Descriptor Table (GDT).
289  *
290  * NB: If you change GBIOSCODE/GBIOSDATA, you *must* rebuild arch/i386/
291  * bioscall/biostramp.inc, as that relies on GBIOSCODE/GBIOSDATA and a
292  * normal kernel build does not rebuild it (it's merely included whole-
293  * sale from i386/bioscall.s)
294  *
295  * Also, note that the GEXTBIOSDATA_SEL selector is special, as it maps
296  * to the value 0x0040 (when created as a KPL global selector).  Some
297  * BIOSes reference the extended BIOS data area at segment 0040 in a non
298  * relocatable fashion (even when in protected mode); mapping the zero page
299  * via the GEXTBIOSDATA_SEL allows these buggy BIOSes to continue to work
300  * under NetBSD.
301  *
302  * The order if the first 5 descriptors is special; the sysenter/sysexit
303  * instructions depend on them.
304  */
305 #define GNULL_SEL	0	/* Null descriptor */
306 #define GCODE_SEL	1	/* Kernel code descriptor */
307 #define GDATA_SEL	2	/* Kernel data descriptor */
308 #define GUCODE_SEL	3	/* User code descriptor */
309 #define GUDATA_SEL	4	/* User data descriptor */
310 #define GLDT_SEL	5	/* Default LDT descriptor */
311 #define GCPU_SEL	6	/* per-CPU segment */
312 #define GEXTBIOSDATA_SEL 8	/* magic to catch BIOS refs to EBDA */
313 #define GAPM32CODE_SEL	9	/* 3 APM segments must be consecutive */
314 #define GAPM16CODE_SEL	10	/* and in the specified order: code32 */
315 #define GAPMDATA_SEL	11	/* code16 and then data per APM spec */
316 #define GBIOSCODE_SEL	12
317 #define GBIOSDATA_SEL	13
318 #define GPNPBIOSCODE_SEL 14
319 #define GPNPBIOSDATA_SEL 15
320 #define GPNPBIOSSCRATCH_SEL 16
321 #define GPNPBIOSTRAMP_SEL 17
322 #define GTRAPTSS_SEL	18
323 #define GIPITSS_SEL	19
324 #define GUCODEBIG_SEL	20	/* User code with executable stack */
325 #define GUFS_SEL	21	/* Per-thread %fs */
326 #define GUGS_SEL	22	/* Per-thread %gs */
327 #define NGDT		23
328 
329 /*
330  * Entries in the Local Descriptor Table (LDT).
331  * DO NOT ADD KERNEL DATA/CODE SEGMENTS TO THIS TABLE.
332  */
333 #define LSYS5CALLS_SEL	0	/* iBCS system call gate */
334 #define LSYS5SIGR_SEL	1	/* iBCS sigreturn gate */
335 #define LUCODE_SEL	2	/* User code descriptor */
336 #define LUDATA_SEL	3	/* User data descriptor */
337 #define LSOL26CALLS_SEL	4	/* Solaris 2.6 system call gate */
338 #define LUCODEBIG_SEL	5	/* User code with executable stack */
339 #define LBSDICALLS_SEL	16	/* BSDI system call gate */
340 #define NLDT		17
341 
342 #endif /* _I386_SEGMENTS_H_ */
343