segments.h revision 1.7
1/*	$OpenBSD: segments.h,v 1.7 2010/10/26 05:49:10 guenther Exp $	*/
2/*	$NetBSD: segments.h,v 1.1 2003/04/26 18:39:47 fvdl Exp $	*/
3
4/*-
5 * Copyright (c) 1995, 1997
6 *	Charles M. Hannum.  All rights reserved.
7 * Copyright (c) 1989, 1990 William F. Jolitz
8 * Copyright (c) 1990 The Regents of the University of California.
9 * All rights reserved.
10 *
11 * This code is derived from software contributed to Berkeley by
12 * William Jolitz.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 * 1. Redistributions of source code must retain the above copyright
18 *    notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 *    notice, this list of conditions and the following disclaimer in the
21 *    documentation and/or other materials provided with the distribution.
22 * 3. Neither the name of the University nor the names of its contributors
23 *    may be used to endorse or promote products derived from this software
24 *    without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * SUCH DAMAGE.
37 *
38 *	@(#)segments.h	7.1 (Berkeley) 5/9/91
39 */
40
41/*
42 * Adapted for NetBSD/amd64 by fvdl@wasabisystems.com.
43 */
44
45/*
46 * 386 Segmentation Data Structures and definitions
47 *	William F. Jolitz (william@ernie.berkeley.edu) 6/20/1989
48 */
49
50#ifndef _AMD64_SEGMENTS_H_
51#define _AMD64_SEGMENTS_H_
52
53/*
54 * Selectors
55 */
56
57#define	ISPL(s)		((s) & SEL_RPL)	/* what is the priority level of a selector */
58#define	SEL_KPL		0		/* kernel privilege level */
59#define	SEL_UPL		3		/* user privilege level */
60#define	SEL_RPL		3		/* requester's privilege level mask */
61#define	ISLDT(s)	((s) & SEL_LDT)	/* is it local or global */
62#define	SEL_LDT		4		/* local descriptor table */
63
64/* Dynamically allocated TSSs start (byte offset) */
65#define SYSSEL_START	(NGDT_MEM << 3)
66#define DYNSEL_START	(SYSSEL_START + (NGDT_SYS << 4))
67
68/*
69 * These define the index not from the start of the GDT, but from
70 * the part of the GDT that they're allocated from.
71 * First NGDT_MEM entries are 8-byte descriptors for CS and DS.
72 *
73 * The rest is 16-byte descriptors for TSSs
74 */
75
76#define	IDXSEL(s)	(((s) >> 3) & 0x1fff)
77#define IDXDYNSEL(s)	((((s) & ~SEL_RPL) - DYNSEL_START) >> 4)
78
79#define	GSEL(s,r)	(((s) << 3) | r)
80#define	GSYSSEL(s,r)	((((s) << 4) + SYSSEL_START) | r)
81#define GDYNSEL(s,r)	((((s) << 4) + DYNSEL_START) | r | SEL_KPL)
82
83#define LSEL(s,r)	((s) | r | SEL_LDT)
84
85#define	USERMODE(c, f)		(ISPL(c) == SEL_UPL)
86#define	KERNELMODE(c, f)	(ISPL(c) == SEL_KPL)
87
88#ifndef _LOCORE
89
90/*
91 * Memory and System segment descriptors
92 */
93
94/*
95 * Below is used for TSS and LDT.
96 */
97struct sys_segment_descriptor {
98/*BITFIELDTYPE*/ u_int64_t sd_lolimit:16;/* segment extent (lsb) */
99/*BITFIELDTYPE*/ u_int64_t sd_lobase:24;/* segment base address (lsb) */
100/*BITFIELDTYPE*/ u_int64_t sd_type:5;	/* segment type */
101/*BITFIELDTYPE*/ u_int64_t sd_dpl:2;	/* segment descriptor priority level */
102/*BITFIELDTYPE*/ u_int64_t sd_p:1;	/* segment descriptor present */
103/*BITFIELDTYPE*/ u_int64_t sd_hilimit:4;/* segment extent (msb) */
104/*BITFIELDTYPE*/ u_int64_t sd_xx1:3;	/* avl, long and def32 (not used) */
105/*BITFIELDTYPE*/ u_int64_t sd_gran:1;	/* limit granularity (byte/page) */
106/*BITFIELDTYPE*/ u_int64_t sd_hibase:40;/* segment base address (msb) */
107/*BITFIELDTYPE*/ u_int64_t sd_xx2:8;	/* reserved */
108/*BITFIELDTYPE*/ u_int64_t sd_zero:5;	/* must be zero */
109/*BITFIELDTYPE*/ u_int64_t sd_xx3:19;	/* reserved */
110} __attribute__((packed));
111
112/*
113 * Below is used for cs, ds, etc.
114 */
115struct mem_segment_descriptor {
116	unsigned int sd_lolimit:16;         /* segment extent (lsb) */
117	unsigned int sd_lobase:24;          /* segment base address (lsb) */
118	unsigned int sd_type:5;             /* segment type */
119	unsigned int sd_dpl:2;              /* segment descriptor priority level */
120	unsigned int sd_p:1;                /* segment descriptor present */
121	unsigned int sd_hilimit:4;          /* segment extent (msb) */
122	unsigned int sd_avl:1;		/* available */
123	unsigned int sd_long:1;		/* long mode */
124	unsigned int sd_def32:1;            /* default 32 vs 16 bit size */
125	unsigned int sd_gran:1;             /* limit granularity (byte/page) */
126	unsigned int sd_hibase:8;           /* segment base address (msb) */
127} __attribute__((packed));
128
129/*
130 * Gate descriptors (e.g. indirect descriptors)
131 */
132struct gate_descriptor {
133/*BITFIELDTYPE*/ u_int64_t gd_looffset:16;/* gate offset (lsb) */
134/*BITFIELDTYPE*/ u_int64_t gd_selector:16;/* gate segment selector */
135/*BITFIELDTYPE*/ u_int64_t gd_ist:3;	/* IST select */
136/*BITFIELDTYPE*/ u_int64_t gd_xx1:5;	/* reserved */
137/*BITFIELDTYPE*/ u_int64_t gd_type:5;	/* segment type */
138/*BITFIELDTYPE*/ u_int64_t gd_dpl:2;	/* segment descriptor priority level */
139/*BITFIELDTYPE*/ u_int64_t gd_p:1;	/* segment descriptor present */
140/*BITFIELDTYPE*/ u_int64_t gd_hioffset:48;/* gate offset (msb) */
141/*BITFIELDTYPE*/ u_int64_t gd_xx2:8;	/* reserved */
142/*BITFIELDTYPE*/ u_int64_t gd_zero:5;	/* must be zero */
143/*BITFIELDTYPE*/ u_int64_t gd_xx3:19;	/* reserved */
144} __attribute__((packed));
145
146/*
147 * region descriptors, used to load gdt/idt tables before segments yet exist.
148 */
149struct region_descriptor {
150	u_int16_t rd_limit;		/* segment extent */
151	u_int64_t rd_base;		/* base address  */
152} __attribute__((packed));
153
154#ifdef _KERNEL
155#if 0
156extern struct sys_segment_descriptor *ldt;
157#endif
158extern struct gate_descriptor *idt;
159extern char *gdtstore;
160
161void setgate(struct gate_descriptor *, void *, int, int, int, int);
162void unsetgate(struct gate_descriptor *);
163void setregion(struct region_descriptor *, void *, u_int16_t);
164void set_sys_segment(struct sys_segment_descriptor *, void *, size_t,
165			  int, int, int);
166void set_mem_segment(struct mem_segment_descriptor *, void *, size_t,
167			  int, int, int, int, int);
168int idt_vec_alloc(int, int);
169void idt_vec_set(int, void (*)(void));
170void idt_vec_free(int);
171void cpu_init_idt(void);
172
173#endif /* _KERNEL */
174
175#endif /* !_LOCORE */
176
177/* system segments and gate types */
178#define	SDT_SYSNULL	 0	/* system null */
179#define	SDT_SYS286TSS	 1	/* system 286 TSS available */
180#define	SDT_SYSLDT	 2	/* system local descriptor table */
181#define	SDT_SYS286BSY	 3	/* system 286 TSS busy */
182#define	SDT_SYS286CGT	 4	/* system 286 call gate */
183#define	SDT_SYSTASKGT	 5	/* system task gate */
184#define	SDT_SYS286IGT	 6	/* system 286 interrupt gate */
185#define	SDT_SYS286TGT	 7	/* system 286 trap gate */
186#define	SDT_SYSNULL2	 8	/* system null again */
187#define	SDT_SYS386TSS	 9	/* system 386 TSS available */
188#define	SDT_SYSNULL3	10	/* system null again */
189#define	SDT_SYS386BSY	11	/* system 386 TSS busy */
190#define	SDT_SYS386CGT	12	/* system 386 call gate */
191#define	SDT_SYSNULL4	13	/* system null again */
192#define	SDT_SYS386IGT	14	/* system 386 interrupt gate */
193#define	SDT_SYS386TGT	15	/* system 386 trap gate */
194
195/* memory segment types */
196#define	SDT_MEMRO	16	/* memory read only */
197#define	SDT_MEMROA	17	/* memory read only accessed */
198#define	SDT_MEMRW	18	/* memory read write */
199#define	SDT_MEMRWA	19	/* memory read write accessed */
200#define	SDT_MEMROD	20	/* memory read only expand dwn limit */
201#define	SDT_MEMRODA	21	/* memory read only expand dwn limit accessed */
202#define	SDT_MEMRWD	22	/* memory read write expand dwn limit */
203#define	SDT_MEMRWDA	23	/* memory read write expand dwn limit acessed */
204#define	SDT_MEME	24	/* memory execute only */
205#define	SDT_MEMEA	25	/* memory execute only accessed */
206#define	SDT_MEMER	26	/* memory execute read */
207#define	SDT_MEMERA	27	/* memory execute read accessed */
208#define	SDT_MEMEC	28	/* memory execute only conforming */
209#define	SDT_MEMEAC	29	/* memory execute only accessed conforming */
210#define	SDT_MEMERC	30	/* memory execute read conforming */
211#define	SDT_MEMERAC	31	/* memory execute read accessed conforming */
212
213/* is memory segment descriptor pointer ? */
214#define ISMEMSDP(s)	((s->d_type) >= SDT_MEMRO && \
215			 (s->d_type) <= SDT_MEMERAC)
216
217/* is 286 gate descriptor pointer ? */
218#define IS286GDP(s)	((s->d_type) >= SDT_SYS286CGT && \
219			 (s->d_type) < SDT_SYS286TGT)
220
221/* is 386 gate descriptor pointer ? */
222#define IS386GDP(s)	((s->d_type) >= SDT_SYS386CGT && \
223			 (s->d_type) < SDT_SYS386TGT)
224
225/* is gate descriptor pointer ? */
226#define ISGDP(s)	(IS286GDP(s) || IS386GDP(s))
227
228/* is segment descriptor pointer ? */
229#define ISSDP(s)	(ISMEMSDP(s) || !ISGDP(s))
230
231/* is system segment descriptor pointer ? */
232#define ISSYSSDP(s)	(!ISMEMSDP(s) && !ISGDP(s))
233
234/*
235 * Segment Protection Exception code bits
236 */
237#define	SEGEX_EXT	0x01	/* recursive or externally induced */
238#define	SEGEX_IDT	0x02	/* interrupt descriptor table */
239#define	SEGEX_TI	0x04	/* local descriptor table */
240
241/*
242 * Entries in the Interrupt Descriptor Table (IDT)
243 */
244#define	NIDT	256
245#define	NRSVIDT	32		/* reserved entries for cpu exceptions */
246
247/*
248 * Entries in the Global Descriptor Table (GDT)
249 * The code and data descriptors must come first. There
250 * are NGDT_MEM of them.
251 *
252 * Then come the predefined LDT (and possibly TSS) descriptors.
253 * There are NGDT_SYS of them.
254 *
255 * The particular order of the UCODE32, UDATA, and UCODE descriptors is
256 * required by the syscall/sysret instructions.
257 */
258#define	GNULL_SEL	0	/* Null descriptor */
259#define	GCODE_SEL	1	/* Kernel code descriptor */
260#define	GDATA_SEL	2	/* Kernel data descriptor */
261#define	GUCODE32_SEL	3	/* User 32bit code descriptor (unused) */
262#define	GUDATA_SEL	4	/* User data descriptor */
263#define	GUCODE_SEL	5	/* User code descriptor */
264#define NGDT_MEM 6
265
266#define NGDT_SYS	0
267
268#define GDT_SYS_OFFSET	(NGDT_MEM << 3)
269
270#define GDT_ADDR_MEM(s,i)	\
271    ((struct mem_segment_descriptor *)((s) + ((i) << 3)))
272#define GDT_ADDR_SYS(s,i)	\
273   ((struct sys_segment_descriptor *)((s) + (((i) << 4) + SYSSEL_START)))
274
275/*
276 * Checks for valid user selectors.
277 */
278#define VALID_USER_CSEL(s) \
279    ((s) == GSEL(GUCODE_SEL, SEL_UPL))
280#define VALID_USER_DSEL(s) \
281    ((s) == GSEL(GUDATA_SEL, SEL_UPL))
282
283#endif /* _AMD64_SEGMENTS_H_ */
284