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