Fix the VKERNEL/VKERNEL64 build.
[dragonfly.git] / sys / cpu / x86_64 / include / segments.h
CommitLineData
fc3f9779
SS
1/*-
2 * Copyright (c) 1989, 1990 William F. Jolitz
3 * Copyright (c) 1990 The Regents of the University of California.
c8fe38ae 4 * Copyright (c) 2008 The DragonFly Project.
fc3f9779
SS
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. 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 * from: @(#)segments.h 7.1 (Berkeley) 5/9/91
39 * $FreeBSD: src/sys/i386/include/segments.h,v 1.24 1999/12/29 04:33:07 peter Exp $
fc3f9779
SS
40 */
41
42#ifndef _CPU_SEGMENTS_H_
43#define _CPU_SEGMENTS_H_
44
45/*
b2b3ffcd 46 * x86_64 Segmentation Data Structures and definitions
fc3f9779
SS
47 */
48
49/*
50 * Selectors
51 */
52
c8fe38ae
MD
53#define SEL_RPL_MASK 3 /* requester priv level */
54#define ISPL(s) ((s)&3) /* what is the privilege level of a selector */
55#define SEL_KPL 0 /* kernel privilege level */
56#define SEL_UPL 3 /* user privilege level */
fc3f9779
SS
57#define ISLDT(s) ((s)&SEL_LDT) /* is it local or global */
58#define SEL_LDT 4 /* local descriptor table */
59#define IDXSEL(s) (((s)>>3) & 0x1fff) /* index of selector */
60#define LSEL(s,r) (((s)<<3) | SEL_LDT | r) /* a local selector */
61#define GSEL(s,r) (((s)<<3) | r) /* a global selector */
62
d7f50089
YY
63#ifndef LOCORE
64
fc3f9779 65/*
c8fe38ae
MD
66 * User segment descriptors (%cs, %ds etc for compatability apps. 64 bit wide)
67 * For long-mode apps, %cs only has the conforming bit in sd_type, the sd_dpl,
68 * sd_p, sd_l and sd_def32 which must be zero). %ds only has sd_p.
fc3f9779 69 */
c8fe38ae
MD
70struct user_segment_descriptor {
71 u_int64_t sd_lolimit:16; /* segment extent (lsb) */
72 u_int64_t sd_lobase:24; /* segment base address (lsb) */
73 u_int64_t sd_type:5; /* segment type */
74 u_int64_t sd_dpl:2; /* segment descriptor priority level */
75 u_int64_t sd_p:1; /* segment descriptor present */
76 u_int64_t sd_hilimit:4; /* segment extent (msb) */
77 u_int64_t sd_xx:1; /* unused */
78 u_int64_t sd_long:1; /* long mode (cs only) */
79 u_int64_t sd_def32:1; /* default 32 vs 16 bit size */
80 u_int64_t sd_gran:1; /* limit granularity (byte/page units)*/
81 u_int64_t sd_hibase:8; /* segment base address (msb) */
82} __packed;
fc3f9779
SS
83
84/*
c8fe38ae 85 * System segment descriptors (128 bit wide)
fc3f9779 86 */
c8fe38ae
MD
87struct system_segment_descriptor {
88 u_int64_t sd_lolimit:16; /* segment extent (lsb) */
89 u_int64_t sd_lobase:24; /* segment base address (lsb) */
90 u_int64_t sd_type:5; /* segment type */
91 u_int64_t sd_dpl:2; /* segment descriptor priority level */
92 u_int64_t sd_p:1; /* segment descriptor present */
93 u_int64_t sd_hilimit:4; /* segment extent (msb) */
94 u_int64_t sd_xx0:3; /* unused */
95 u_int64_t sd_gran:1; /* limit granularity (byte/page units)*/
96 u_int64_t sd_hibase:40 __packed;/* segment base address (msb) */
97 u_int64_t sd_xx1:8;
98 u_int64_t sd_mbz:5; /* MUST be zero */
99 u_int64_t sd_xx2:19;
100} __packed;
fc3f9779
SS
101
102/*
c8fe38ae
MD
103 * Gate descriptors (e.g. indirect descriptors, trap, interrupt etc. 128 bit)
104 * Only interrupt and trap gates have gd_ist.
fc3f9779 105 */
c8fe38ae
MD
106struct gate_descriptor {
107 u_int64_t gd_looffset:16; /* gate offset (lsb) */
108 u_int64_t gd_selector:16; /* gate segment selector */
109 u_int64_t gd_ist:3; /* IST table index */
110 u_int64_t gd_xx:5; /* unused */
111 u_int64_t gd_type:5; /* segment type */
112 u_int64_t gd_dpl:2; /* segment descriptor priority level */
113 u_int64_t gd_p:1; /* segment descriptor present */
114 u_int64_t gd_hioffset:48 __packed; /* gate offset (msb) */
115 u_int64_t sd_xx1:32;
116} __packed;
fc3f9779 117
d7f50089
YY
118#endif /* LOCORE */
119
120/* system segments and gate types */
fc3f9779 121#define SDT_SYSNULL 0 /* system null */
c8fe38ae
MD
122#define SDT_SYSLDT 2 /* system 64-bit local descriptor table */
123#define SDT_SYSTSS 9 /* system available 64-bit TSS */
124#define SDT_SYSBSY 11 /* system busy 64-bit TSS */
125#define SDT_SYSCGT 12 /* system 64-bit call gate */
126#define SDT_SYSIGT 14 /* system 64-bit interrupt gate */
127#define SDT_SYSTGT 15 /* system 64-bit trap gate */
fc3f9779
SS
128
129 /* memory segment types */
130#define SDT_MEMRO 16 /* memory read only */
131#define SDT_MEMROA 17 /* memory read only accessed */
132#define SDT_MEMRW 18 /* memory read write */
133#define SDT_MEMRWA 19 /* memory read write accessed */
134#define SDT_MEMROD 20 /* memory read only expand dwn limit */
135#define SDT_MEMRODA 21 /* memory read only expand dwn limit accessed */
136#define SDT_MEMRWD 22 /* memory read write expand dwn limit */
137#define SDT_MEMRWDA 23 /* memory read write expand dwn limit accessed */
138#define SDT_MEME 24 /* memory execute only */
139#define SDT_MEMEA 25 /* memory execute only accessed */
140#define SDT_MEMER 26 /* memory execute read */
141#define SDT_MEMERA 27 /* memory execute read accessed */
142#define SDT_MEMEC 28 /* memory execute only conforming */
143#define SDT_MEMEAC 29 /* memory execute only accessed conforming */
144#define SDT_MEMERC 30 /* memory execute read conforming */
145#define SDT_MEMERAC 31 /* memory execute read accessed conforming */
146
d7f50089
YY
147
148#ifndef LOCORE
149
c8fe38ae
MD
150#ifndef _SYS_TLS_H_
151#include <sys/tls.h>
152#endif
153
154struct savetls {
155 struct tls_info info[2];
156};
157
fc3f9779
SS
158/* is memory segment descriptor pointer ? */
159#define ISMEMSDP(s) ((s->d_type) >= SDT_MEMRO && (s->d_type) <= SDT_MEMERAC)
160
161/* is 286 gate descriptor pointer ? */
162#define IS286GDP(s) (((s->d_type) >= SDT_SYS286CGT \
163 && (s->d_type) < SDT_SYS286TGT))
164
165/* is 386 gate descriptor pointer ? */
166#define IS386GDP(s) (((s->d_type) >= SDT_SYS386CGT \
167 && (s->d_type) < SDT_SYS386TGT))
168
169/* is gate descriptor pointer ? */
170#define ISGDP(s) (IS286GDP(s) || IS386GDP(s))
171
172/* is segment descriptor pointer ? */
173#define ISSDP(s) (ISMEMSDP(s) || !ISGDP(s))
174
175/* is system segment descriptor pointer ? */
176#define ISSYSSDP(s) (!ISMEMSDP(s) && !ISGDP(s))
177
178/*
179 * Software definitions are in this convenient format,
180 * which are translated into inconvenient segment descriptors
181 * when needed to be used by the 386 hardware
182 */
183
c8fe38ae
MD
184struct soft_segment_descriptor {
185 uint64_t ssd_base; /* segment base address */
186 uint64_t ssd_limit; /* segment extent */
187 uint64_t ssd_type:5; /* segment type */
188 uint64_t ssd_dpl:2; /* segment descriptor priority level */
189 uint64_t ssd_p:1; /* segment descriptor present */
190 uint64_t ssd_long:1; /* long mode (for %cs) */
191 uint64_t ssd_def32:1; /* default 32 vs 16 bit size */
192 uint64_t ssd_gran:1; /* limit granularity (byte/page units)*/
193} __packed;
fc3f9779
SS
194
195/*
196 * region descriptors, used to load gdt/idt tables before segments yet exist.
197 */
198struct region_descriptor {
c8fe38ae
MD
199 uint64_t rd_limit:16; /* segment extent */
200 uint64_t rd_base:64 __packed; /* base address */
201} __packed;
fc3f9779 202
d7f50089 203#endif /* LOCORE */
fc3f9779
SS
204
205/*
206 * Segment Protection Exception code bits
207 */
208
209#define SEGEX_EXT 0x01 /* recursive or externally induced */
210#define SEGEX_IDT 0x02 /* interrupt descriptor table */
211#define SEGEX_TI 0x04 /* local descriptor table */
212 /* other bits are affected descriptor index */
81c02e76 213#define SEGEX_IDX(s) (((s)>>3)&0x1fff)
fc3f9779
SS
214
215/*
216 * Size of the IDT table. Theoretically we only need to cover past 0x81
217 * (NIDT=130) if not running APIC_IO or SMP, but at this point we might
218 * as well just use all of them.
219 */
220#define NIDT 256 /* we use them all */
c8fe38ae
MD
221/*
222 * Entries in the Interrupt Descriptor Table (IDT)
223 */
224#define IDT_DE 0 /* #DE: Divide Error */
225#define IDT_DB 1 /* #DB: Debug */
226#define IDT_NMI 2 /* Nonmaskable External Interrupt */
227#define IDT_BP 3 /* #BP: Breakpoint */
228#define IDT_OF 4 /* #OF: Overflow */
229#define IDT_BR 5 /* #BR: Bound Range Exceeded */
230#define IDT_UD 6 /* #UD: Undefined/Invalid Opcode */
231#define IDT_NM 7 /* #NM: No Math Coprocessor */
232#define IDT_DF 8 /* #DF: Double Fault */
233#define IDT_FPUGP 9 /* Coprocessor Segment Overrun */
234#define IDT_TS 10 /* #TS: Invalid TSS */
235#define IDT_NP 11 /* #NP: Segment Not Present */
236#define IDT_SS 12 /* #SS: Stack Segment Fault */
237#define IDT_GP 13 /* #GP: General Protection Fault */
238#define IDT_PF 14 /* #PF: Page Fault */
239#define IDT_MF 16 /* #MF: FPU Floating-Point Error */
240#define IDT_AC 17 /* #AC: Alignment Check */
241#define IDT_MC 18 /* #MC: Machine Check */
242#define IDT_XF 19 /* #XF: SIMD Floating-Point Exception */
243#define IDT_IO_INTS NRSVIDT /* Base of IDT entries for I/O interrupts. */
244#define IDT_SYSCALL 0x80 /* System Call Interrupt Vector */
fc3f9779
SS
245
246/*
247 * Entries in the Global Descriptor Table (GDT)
248 */
249#define GNULL_SEL 0 /* Null Descriptor */
250#define GCODE_SEL 1 /* Kernel Code Descriptor */
251#define GDATA_SEL 2 /* Kernel Data Descriptor */
c8fe38ae
MD
252#define GUCODE32_SEL 3 /* User 32 bit code Descriptor */
253#define GUDATA_SEL 4 /* User 32/64 bit Data Descriptor */
254#define GUCODE_SEL 5 /* User 64 bit Code Descriptor */
255#define GPROC0_SEL 6 /* TSS for entering kernel etc */
256/* slot 7 is second half of GPROC0_SEL */
257#define GUGS32_SEL 8 /* User 32 bit GS Descriptor */
258#define NGDT 9
fc3f9779 259
d7f50089 260#ifndef LOCORE
d7f50089 261
fc3f9779 262#ifdef _KERNEL
c8fe38ae 263extern struct user_segment_descriptor gdt[];
fc3f9779
SS
264extern struct soft_segment_descriptor gdt_segs[];
265extern struct gate_descriptor *idt;
7773e565 266extern struct mtx dt_lock;
fc3f9779 267
c8fe38ae
MD
268void lgdt(struct region_descriptor *rdp);
269void sdtossd(struct user_segment_descriptor *sdp,
270 struct soft_segment_descriptor *ssdp);
271void ssdtosd(struct soft_segment_descriptor *ssdp,
272 struct user_segment_descriptor *sdp);
273void ssdtosyssd(struct soft_segment_descriptor *ssdp,
274 struct system_segment_descriptor *sdp);
fc3f9779 275#endif /* _KERNEL */
d7f50089 276#endif /* LOCORE */
fc3f9779
SS
277
278#endif /* !_CPU_SEGMENTS_H_ */