xref: /illumos-gate/usr/src/contrib/bhyve/x86/segments.h (revision 6446bd46ed1b4e9f69da153665f82181ccaedad5)
1 /*-
2  * Copyright (c) 1989, 1990 William F. Jolitz
3  * Copyright (c) 1990 The Regents of the University of California.
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * William Jolitz.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *	from: @(#)segments.h	7.1 (Berkeley) 5/9/91
34  * $FreeBSD$
35  */
36 
37 #ifndef _X86_SEGMENTS_H_
38 #define	_X86_SEGMENTS_H_
39 
40 /*
41  * X86 Segmentation Data Structures and definitions
42  */
43 
44 /*
45  * Selectors
46  */
47 #define	SEL_RPL_MASK	3		/* requester priv level */
48 #define	ISPL(s)		((s)&3)		/* priority level of a selector */
49 #define	SEL_KPL		0		/* kernel priority level */
50 #define	SEL_UPL		3		/* user priority level */
51 #define	ISLDT(s)	((s)&SEL_LDT)	/* is it local or global */
52 #define	SEL_LDT		4		/* local descriptor table */
53 #define	IDXSEL(s)	(((s)>>3) & 0x1fff) /* index of selector */
54 #define	LSEL(s,r)	(((s)<<3) | SEL_LDT | r) /* a local selector */
55 #define	GSEL(s,r)	(((s)<<3) | r)	/* a global selector */
56 
57 /*
58  * User segment descriptors (%cs, %ds etc for i386 apps. 64 bit wide)
59  * For long-mode apps, %cs only has the conforming bit in sd_type, the sd_dpl,
60  * sd_p, sd_l and sd_def32 which must be zero).  %ds only has sd_p.
61  */
62 struct segment_descriptor {
63 	unsigned sd_lolimit:16;		/* segment extent (lsb) */
64 	unsigned sd_lobase:24;		/* segment base address (lsb) */
65 	unsigned sd_type:5;		/* segment type */
66 	unsigned sd_dpl:2;		/* segment descriptor priority level */
67 	unsigned sd_p:1;		/* segment descriptor present */
68 	unsigned sd_hilimit:4;		/* segment extent (msb) */
69 	unsigned sd_xx:2;		/* unused */
70 	unsigned sd_def32:1;		/* default 32 vs 16 bit size */
71 	unsigned sd_gran:1;		/* limit granularity (byte/page units)*/
72 	unsigned sd_hibase:8;		/* segment base address  (msb) */
73 } __packed;
74 
75 struct user_segment_descriptor {
76 	unsigned sd_lolimit:16;		/* segment extent (lsb) */
77 	unsigned sd_lobase:24;		/* segment base address (lsb) */
78 	unsigned sd_type:5;		/* segment type */
79 	unsigned sd_dpl:2;		/* segment descriptor priority level */
80 	unsigned sd_p:1;		/* segment descriptor present */
81 	unsigned sd_hilimit:4;		/* segment extent (msb) */
82 	unsigned sd_xx:1;		/* unused */
83 	unsigned sd_long:1;		/* long mode (cs only) */
84 	unsigned sd_def32:1;		/* default 32 vs 16 bit size */
85 	unsigned sd_gran:1;		/* limit granularity (byte/page units)*/
86 	unsigned sd_hibase:8;		/* segment base address  (msb) */
87 } __packed;
88 
89 #define	USD_GETBASE(sd)		(((sd)->sd_lobase) | (sd)->sd_hibase << 24)
90 #define	USD_SETBASE(sd, b)	(sd)->sd_lobase = (b);	\
91 				(sd)->sd_hibase = ((b) >> 24);
92 #define	USD_GETLIMIT(sd)	(((sd)->sd_lolimit) | (sd)->sd_hilimit << 16)
93 #define	USD_SETLIMIT(sd, l)	(sd)->sd_lolimit = (l);	\
94 				(sd)->sd_hilimit = ((l) >> 16);
95 
96 #ifdef __i386__
97 /*
98  * Gate descriptors (e.g. indirect descriptors)
99  */
100 struct gate_descriptor {
101 	unsigned gd_looffset:16;	/* gate offset (lsb) */
102 	unsigned gd_selector:16;	/* gate segment selector */
103 	unsigned gd_stkcpy:5;		/* number of stack wds to cpy */
104 	unsigned gd_xx:3;		/* unused */
105 	unsigned gd_type:5;		/* segment type */
106 	unsigned gd_dpl:2;		/* segment descriptor priority level */
107 	unsigned gd_p:1;		/* segment descriptor present */
108 	unsigned gd_hioffset:16;	/* gate offset (msb) */
109 } __packed;
110 
111 /*
112  * Generic descriptor
113  */
114 union descriptor {
115 	struct segment_descriptor sd;
116 	struct gate_descriptor gd;
117 };
118 #else
119 /*
120  * Gate descriptors (e.g. indirect descriptors, trap, interrupt etc. 128 bit)
121  * Only interrupt and trap gates have gd_ist.
122  */
123 struct gate_descriptor {
124 	uint64_t gd_looffset:16;	/* gate offset (lsb) */
125 	uint64_t gd_selector:16;	/* gate segment selector */
126 	uint64_t gd_ist:3;		/* IST table index */
127 	uint64_t gd_xx:5;		/* unused */
128 	uint64_t gd_type:5;		/* segment type */
129 	uint64_t gd_dpl:2;		/* segment descriptor priority level */
130 	uint64_t gd_p:1;		/* segment descriptor present */
131 	uint64_t gd_hioffset:48;	/* gate offset (msb) */
132 	uint64_t sd_xx1:32;
133 } __packed;
134 
135 /*
136  * Generic descriptor
137  */
138 union descriptor {
139 	struct user_segment_descriptor sd;
140 	struct gate_descriptor gd;
141 };
142 #endif
143 
144 	/* system segments and gate types */
145 #define	SDT_SYSNULL	 0	/* system null */
146 #define	SDT_SYS286TSS	 1	/* system 286 TSS available */
147 #define	SDT_SYSLDT	 2	/* system local descriptor table */
148 #define	SDT_SYS286BSY	 3	/* system 286 TSS busy */
149 #define	SDT_SYS286CGT	 4	/* system 286 call gate */
150 #define	SDT_SYSTASKGT	 5	/* system task gate */
151 #define	SDT_SYS286IGT	 6	/* system 286 interrupt gate */
152 #define	SDT_SYS286TGT	 7	/* system 286 trap gate */
153 #define	SDT_SYSNULL2	 8	/* system null again */
154 #define	SDT_SYS386TSS	 9	/* system 386 TSS available */
155 #define	SDT_SYSTSS	 9	/* system available 64 bit TSS */
156 #define	SDT_SYSNULL3	10	/* system null again */
157 #define	SDT_SYS386BSY	11	/* system 386 TSS busy */
158 #define	SDT_SYSBSY	11	/* system busy 64 bit TSS */
159 #define	SDT_SYS386CGT	12	/* system 386 call gate */
160 #define	SDT_SYSCGT	12	/* system 64 bit call gate */
161 #define	SDT_SYSNULL4	13	/* system null again */
162 #define	SDT_SYS386IGT	14	/* system 386 interrupt gate */
163 #define	SDT_SYSIGT	14	/* system 64 bit interrupt gate */
164 #define	SDT_SYS386TGT	15	/* system 386 trap gate */
165 #define	SDT_SYSTGT	15	/* system 64 bit trap gate */
166 
167 	/* memory segment types */
168 #define	SDT_MEMRO	16	/* memory read only */
169 #define	SDT_MEMROA	17	/* memory read only accessed */
170 #define	SDT_MEMRW	18	/* memory read write */
171 #define	SDT_MEMRWA	19	/* memory read write accessed */
172 #define	SDT_MEMROD	20	/* memory read only expand dwn limit */
173 #define	SDT_MEMRODA	21	/* memory read only expand dwn limit accessed */
174 #define	SDT_MEMRWD	22	/* memory read write expand dwn limit */
175 #define	SDT_MEMRWDA	23	/* memory read write expand dwn limit accessed*/
176 #define	SDT_MEME	24	/* memory execute only */
177 #define	SDT_MEMEA	25	/* memory execute only accessed */
178 #define	SDT_MEMER	26	/* memory execute read */
179 #define	SDT_MEMERA	27	/* memory execute read accessed */
180 #define	SDT_MEMEC	28	/* memory execute only conforming */
181 #define	SDT_MEMEAC	29	/* memory execute only accessed conforming */
182 #define	SDT_MEMERC	30	/* memory execute read conforming */
183 #define	SDT_MEMERAC	31	/* memory execute read accessed conforming */
184 
185 /*
186  * Size of IDT table
187  */
188 #define	NIDT		256	/* 32 reserved, 0x80 syscall, most are h/w */
189 #define	NRSVIDT		32	/* reserved entries for cpu exceptions */
190 
191 /*
192  * Entries in the Interrupt Descriptor Table (IDT)
193  */
194 #define	IDT_DE		0	/* #DE: Divide Error */
195 #define	IDT_DB		1	/* #DB: Debug */
196 #define	IDT_NMI		2	/* Nonmaskable External Interrupt */
197 #define	IDT_BP		3	/* #BP: Breakpoint */
198 #define	IDT_OF		4	/* #OF: Overflow */
199 #define	IDT_BR		5	/* #BR: Bound Range Exceeded */
200 #define	IDT_UD		6	/* #UD: Undefined/Invalid Opcode */
201 #define	IDT_NM		7	/* #NM: No Math Coprocessor */
202 #define	IDT_DF		8	/* #DF: Double Fault */
203 #define	IDT_FPUGP	9	/* Coprocessor Segment Overrun */
204 #define	IDT_TS		10	/* #TS: Invalid TSS */
205 #define	IDT_NP		11	/* #NP: Segment Not Present */
206 #define	IDT_SS		12	/* #SS: Stack Segment Fault */
207 #define	IDT_GP		13	/* #GP: General Protection Fault */
208 #define	IDT_PF		14	/* #PF: Page Fault */
209 #define	IDT_MF		16	/* #MF: FPU Floating-Point Error */
210 #define	IDT_AC		17	/* #AC: Alignment Check */
211 #define	IDT_MC		18	/* #MC: Machine Check */
212 #define	IDT_XF		19	/* #XF: SIMD Floating-Point Exception */
213 #define	IDT_IO_INTS	NRSVIDT	/* Base of IDT entries for I/O interrupts. */
214 #define	IDT_SYSCALL	0x80	/* System Call Interrupt Vector */
215 #define	IDT_DTRACE_RET	0x92	/* DTrace pid provider Interrupt Vector */
216 #define	IDT_EVTCHN	0x93	/* Xen HVM Event Channel Interrupt Vector */
217 
218 #if defined(__i386__)
219 /*
220  * Entries in the Global Descriptor Table (GDT)
221  * Note that each 4 entries share a single 32 byte L1 cache line.
222  * Some of the fast syscall instructions require a specific order here.
223  */
224 #define	GNULL_SEL	0	/* Null Descriptor */
225 #define	GPRIV_SEL	1	/* SMP Per-Processor Private Data */
226 #define	GUFS_SEL	2	/* User %fs Descriptor (order critical: 1) */
227 #define	GUGS_SEL	3	/* User %gs Descriptor (order critical: 2) */
228 #define	GCODE_SEL	4	/* Kernel Code Descriptor (order critical: 1) */
229 #define	GDATA_SEL	5	/* Kernel Data Descriptor (order critical: 2) */
230 #define	GUCODE_SEL	6	/* User Code Descriptor (order critical: 3) */
231 #define	GUDATA_SEL	7	/* User Data Descriptor (order critical: 4) */
232 #define	GBIOSLOWMEM_SEL	8	/* BIOS low memory access (must be entry 8) */
233 #define	GPROC0_SEL	9	/* Task state process slot zero and up */
234 #define	GLDT_SEL	10	/* Default User LDT */
235 #define	GUSERLDT_SEL	11	/* User LDT */
236 #define	GPANIC_SEL	12	/* Task state to consider panic from */
237 #define	GBIOSCODE32_SEL	13	/* BIOS interface (32bit Code) */
238 #define	GBIOSCODE16_SEL	14	/* BIOS interface (16bit Code) */
239 #define	GBIOSDATA_SEL	15	/* BIOS interface (Data) */
240 #define	GBIOSUTIL_SEL	16	/* BIOS interface (Utility) */
241 #define	GBIOSARGS_SEL	17	/* BIOS interface (Arguments) */
242 #define	GNDIS_SEL	18	/* For the NDIS layer */
243 #define	NGDT		19
244 
245 /*
246  * Entries in the Local Descriptor Table (LDT)
247  */
248 #define	LSYS5CALLS_SEL	0	/* forced by intel BCS */
249 #define	LSYS5SIGR_SEL	1
250 #define	LUCODE_SEL	3
251 #define	LUDATA_SEL	5
252 #define	NLDT		(LUDATA_SEL + 1)
253 
254 #else /* !__i386__ */
255 /*
256  * Entries in the Global Descriptor Table (GDT)
257  */
258 #define	GNULL_SEL	0	/* Null Descriptor */
259 #define	GNULL2_SEL	1	/* Null Descriptor */
260 #define	GUFS32_SEL	2	/* User 32 bit %fs Descriptor */
261 #define	GUGS32_SEL	3	/* User 32 bit %gs Descriptor */
262 #define	GCODE_SEL	4	/* Kernel Code Descriptor */
263 #define	GDATA_SEL	5	/* Kernel Data Descriptor */
264 #define	GUCODE32_SEL	6	/* User 32 bit code Descriptor */
265 #define	GUDATA_SEL	7	/* User 32/64 bit Data Descriptor */
266 #define	GUCODE_SEL	8	/* User 64 bit Code Descriptor */
267 #define	GPROC0_SEL	9	/* TSS for entering kernel etc */
268 /* slot 10 is second half of GPROC0_SEL */
269 #define	GUSERLDT_SEL	11	/* LDT */
270 /* slot 12 is second half of GUSERLDT_SEL */
271 #define	NGDT 		13
272 #endif /* __i386__ */
273 
274 #endif /* !_X86_SEGMENTS_H_ */
275