]> git.saurik.com Git - apple/xnu.git/blame - osfmk/i386/seg.h
xnu-2050.7.9.tar.gz
[apple/xnu.git] / osfmk / i386 / seg.h
CommitLineData
1c79356b 1/*
b0d623f7 2 * Copyright (c) 2000-2009 Apple Inc. All rights reserved.
1c79356b 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/*
29 * @OSF_COPYRIGHT@
30 */
31/*
32 * Mach Operating System
33 * Copyright (c) 1991,1990 Carnegie Mellon University
34 * All Rights Reserved.
35 *
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
41 *
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
45 *
46 * Carnegie Mellon requests users of this software to return to
47 *
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
52 *
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
55 */
1c79356b
A
56#ifndef _I386_SEG_H_
57#define _I386_SEG_H_
b0d623f7 58#ifndef __ASSEMBLER__
91447636 59#include <stdint.h>
0c530ab8 60#include <mach/vm_types.h>
91447636 61#include <architecture/i386/sel.h>
1c79356b
A
62
63/*
64 * i386 segmentation.
65 */
66
91447636
A
67static inline uint16_t
68sel_to_selector(sel_t sel)
69{
70 union {
71 sel_t sel;
72 uint16_t selector;
73 } tconv;
74
75 tconv.sel = sel;
76
77 return (tconv.selector);
78}
79
80static inline sel_t
81selector_to_sel(uint16_t selector)
82{
83 union {
84 uint16_t selector;
85 sel_t sel;
86 } tconv;
87
88 tconv.selector = selector;
89
90 return (tconv.sel);
91}
92
0c530ab8 93#define LDTSZ 8192 /* size of the kernel ldt in entries */
2d21ac55
A
94#define LDTSZ_MIN SEL_TO_INDEX(USER_SETTABLE)
95 /* kernel ldt entries */
91447636 96
b0d623f7 97#define GDTSZ 19
91447636
A
98
99/*
100 * Interrupt table is always 256 entries long.
101 */
102#define IDTSZ 256
103
91447636
A
104#include <sys/cdefs.h>
105
1c79356b
A
106/*
107 * Real segment descriptor.
108 */
109struct real_descriptor {
0c530ab8 110 uint32_t limit_low:16, /* limit 0..15 */
1c79356b
A
111 base_low:16, /* base 0..15 */
112 base_med:8, /* base 16..23 */
113 access:8, /* access byte */
114 limit_high:4, /* limit 16..19 */
115 granularity:4, /* granularity */
116 base_high:8; /* base 24..31 */
117};
0c530ab8
A
118struct real_descriptor64 {
119 uint32_t limit_low16:16, /* limit 0..15 */
120 base_low16:16, /* base 0..15 */
121 base_med8:8, /* base 16..23 */
122 access8:8, /* access byte */
123 limit_high4:4, /* limit 16..19 */
124 granularity4:4, /* granularity */
125 base_high8:8, /* base 24..31 */
126 base_top32:32, /* base 32..63 */
127 reserved32:32; /* reserved/zero */
128};
1c79356b 129struct real_gate {
0c530ab8 130 uint32_t offset_low:16, /* offset 0..15 */
1c79356b
A
131 selector:16,
132 word_count:8,
133 access:8,
134 offset_high:16; /* offset 16..31 */
135};
0c530ab8
A
136struct real_gate64 {
137 uint32_t offset_low16:16, /* offset 0..15 */
138 selector16:16,
139 IST:3,
140 zeroes5:5,
141 access8:8,
142 offset_high16:16, /* offset 16..31 */
143 offset_top32:32, /* offset 32..63 */
144 reserved32:32; /* reserved/zero */
145};
1c79356b 146
b0d623f7
A
147#define MAKE_REAL_DESCRIPTOR(base,lim,gran,acc) { \
148 .limit_low = lim & 0xffff, \
149 .limit_high = (lim >> 16) & 0xf, \
150 .base_low = base & 0xffff, \
151 .base_med = (base >> 16) & 0xff, \
152 .base_high = (base >> 24) & 0xff, \
153 .access = acc, \
154 .granularity = gran \
155}
156
1c79356b
A
157/*
158 * We build descriptors and gates in a 'fake' format to let the
159 * fields be contiguous. We shuffle them into the real format
160 * at runtime.
161 */
162struct fake_descriptor {
0c530ab8
A
163 uint32_t offset:32; /* offset */
164 uint32_t lim_or_seg:20; /* limit */
1c79356b 165 /* or segment, for gate */
0c530ab8 166 uint32_t size_or_wdct:4; /* size/granularity */
1c79356b 167 /* word count, for gate */
0c530ab8 168 uint32_t access:8; /* access */
4452a7af 169};
0c530ab8 170struct fake_descriptor64 {
b0d623f7 171 uint64_t offset64; /* offset [0..31,32..63] */
0c530ab8
A
172 uint32_t lim_or_seg:20; /* limit */
173 /* or segment, for gate */
174 uint32_t size_or_IST:4; /* size/granularity */
175 /* IST for gates */
176 uint32_t access:8; /* access */
177 uint32_t reserved:32; /* reserved/zero */
178};
b0d623f7 179#ifdef __i386__
0c530ab8
A
180#define FAKE_UBER64(addr32) { (uint32_t) (addr32), KERNEL_UBER_BASE_HI32 }
181#define FAKE_COMPAT(addr32) { (uint32_t) (addr32), 0x0 }
cf7d32b8 182#define UBER64(addr32) ((addr64_t) (uintptr_t)addr32 + KERNEL_UBER_BASE)
b0d623f7 183#endif
91447636
A
184
185/*
186 * Boot-time data for master (or only) CPU
187 */
0c530ab8 188extern struct fake_descriptor master_idt[IDTSZ];
b0d623f7
A
189extern struct real_descriptor master_gdt[GDTSZ];
190extern struct real_descriptor master_ldt[LDTSZ];
0c530ab8
A
191extern struct i386_tss master_ktss;
192extern struct sysenter_stack master_sstk;
193
194extern struct fake_descriptor64 master_idt64[IDTSZ];
0c530ab8 195extern struct x86_64_tss master_ktss64;
91447636
A
196
197__BEGIN_DECLS
198
0c530ab8
A
199extern char df_task_stack[];
200extern char df_task_stack_end[];
201extern struct i386_tss master_dftss;
202extern void df_task_start(void);
203
204extern char mc_task_stack[];
205extern char mc_task_stack_end[];
206extern struct i386_tss master_mctss;
207extern void mc_task_start(void);
208
91447636
A
209__END_DECLS
210
1c79356b
A
211#endif /*__ASSEMBLER__*/
212
0c530ab8 213#define SZ_64 0x2 /* 64-bit segment */
1c79356b
A
214#define SZ_32 0x4 /* 32-bit segment */
215#define SZ_G 0x8 /* 4K limit field */
216
217#define ACC_A 0x01 /* accessed */
218#define ACC_TYPE 0x1e /* type field: */
219
220#define ACC_TYPE_SYSTEM 0x00 /* system descriptors: */
221
222#define ACC_LDT 0x02 /* LDT */
223#define ACC_CALL_GATE_16 0x04 /* 16-bit call gate */
224#define ACC_TASK_GATE 0x05 /* task gate */
225#define ACC_TSS 0x09 /* task segment */
226#define ACC_CALL_GATE 0x0c /* call gate */
227#define ACC_INTR_GATE 0x0e /* interrupt gate */
228#define ACC_TRAP_GATE 0x0f /* trap gate */
229
230#define ACC_TSS_BUSY 0x02 /* task busy */
231
232#define ACC_TYPE_USER 0x10 /* user descriptors */
233
234#define ACC_DATA 0x10 /* data */
235#define ACC_DATA_W 0x12 /* data, writable */
236#define ACC_DATA_E 0x14 /* data, expand-down */
237#define ACC_DATA_EW 0x16 /* data, expand-down,
238 writable */
239#define ACC_CODE 0x18 /* code */
240#define ACC_CODE_R 0x1a /* code, readable */
241#define ACC_CODE_C 0x1c /* code, conforming */
242#define ACC_CODE_CR 0x1e /* code, conforming,
243 readable */
244#define ACC_PL 0x60 /* access rights: */
245#define ACC_PL_K 0x00 /* kernel access only */
246#define ACC_PL_U 0x60 /* user access */
247#define ACC_P 0x80 /* segment present */
248
249/*
250 * Components of a selector
251 */
252#define SEL_LDTS 0x04 /* local selector */
253#define SEL_PL 0x03 /* privilege level: */
254#define SEL_PL_K 0x00 /* kernel selector */
255#define SEL_PL_U 0x03 /* user selector */
256
257/*
258 * Convert selector to descriptor table index.
259 */
91447636 260#define sel_idx(sel) (selector_to_sel(sel).index)
0c530ab8 261#define SEL_TO_INDEX(s) ((s)>>3)
91447636
A
262
263#define NULL_SEG 0
1c79356b 264
b0d623f7 265#ifdef __i386__
1c79356b
A
266/*
267 * User descriptors for MACH - 32-bit flat address space
268 */
0c530ab8
A
269#define SYSENTER_CS 0x07 /* sysenter kernel code segment */
270#define SYSENTER_DS 0x0f /* sysenter kernel data segment */
271#define USER_CS 0x17 /* user code segment
272 Must be SYSENTER_CS+16 for sysexit */
273/* Special case: sysenter with EFL_TF (trace bit) set - use iret not sysexit */
274#define SYSENTER_TF_CS (USER_CS|0x10000)
275#define USER_DS 0x1f /* user data segment
276 Must be SYSENTER_CS+24 for sysexit */
277#define USER64_CS 0x27 /* 64-bit user code segment
278 Must be USER_CS+16 for sysret */
279#define USER64_DS USER_DS /* 64-bit user data segment == 32-bit */
280#define SYSCALL_CS 0x2f /* 64-bit syscall pseudo-segment */
281#define USER_CTHREAD 0x37 /* user cthread area */
282#define USER_SETTABLE 0x3f /* start of user settable ldt entries */
1c79356b
A
283
284/*
285 * Kernel descriptors for MACH - 32-bit flat address space.
286 */
b0d623f7 287#define KERNEL32_CS 0x08 /* kernel code */
1c79356b
A
288#define KERNEL_DS 0x10 /* kernel data */
289#define KERNEL_LDT 0x18 /* master LDT */
0c530ab8
A
290#define KERNEL_LDT_2 0x20 /* master LDT expanded for 64-bit */
291#define KERNEL_TSS 0x28 /* master TSS */
292#define KERNEL_TSS_2 0x30 /* master TSS expanded for 64-bit */
293
294#define MC_TSS 0x38 /* machine-check handler TSS */
295
91447636 296#define CPU_DATA_GS 0x48 /* per-cpu data */
1c79356b 297
0c530ab8
A
298#define DF_TSS 0x50 /* double-fault handler TSS */
299
1c79356b
A
300#define USER_LDT 0x58
301#define USER_TSS 0x60
302#define FPE_CS 0x68
0c530ab8 303
b0d623f7 304#else // __x86_64__
0c530ab8 305
b0d623f7
A
306/*
307 * Kernel descriptors for MACH - 64-bit flat address space.
308 */
060df5ea
A
309#define KERNEL64_CS 0x08 /* 1: K64 code */
310#define SYSENTER_CS 0x0b /* U32 sysenter pseudo-segment */
311#define KERNEL64_SS 0x10 /* 2: KERNEL64_CS+8 for syscall */
312#define USER_CS 0x1b /* 3: U32 code */
313#define USER_DS 0x23 /* 4: USER_CS+8 for sysret */
314#define USER64_CS 0x2b /* 5: USER_CS+16 for sysret */
315#define USER64_DS USER_DS /* U64 data pseudo-segment */
b0d623f7
A
316#define KERNEL_LDT 0x30 /* 6: */
317 /* 7: other 8 bytes of KERNEL_LDT */
318#define KERNEL_TSS 0x40 /* 8: */
319 /* 9: other 8 bytes of KERNEL_TSS */
320#define KERNEL32_CS 0x50 /* 10: */
321#define USER_LDT 0x58 /* 11: */
322 /* 12: other 8 bytes of USER_LDT */
060df5ea 323#define KERNEL_DS 0x68 /* 13: 32-bit kernel data */
b0d623f7
A
324
325#endif
326
327#ifdef __i386__
6d2010ae 328#if !defined(USER_WINDOW_SEL)
b0d623f7
A
329#define USER_WINDOW_SEL 0x70 /* 14: window for copyin/copyout */
330#define PHYS_WINDOW_SEL 0x78 /* 15: window for copyin/copyout */
6d2010ae 331#endif
b0d623f7
A
332#define KERNEL64_CS 0x80 /* 16: kernel 64-bit code */
333#define KERNEL64_SS 0x88 /* 17: kernel 64-bit (syscall) stack */
334#else // __x86_64__
335#define SYSENTER_TF_CS (USER_CS|0x10000)
336#define SYSENTER_DS KERNEL64_SS /* sysenter kernel data segment */
337#endif
1c79356b 338
b0d623f7
A
339#ifdef __x86_64__
340/*
341 * 64-bit kernel LDT descriptors
342 */
060df5ea 343#define SYSCALL_CS 0x07 /* syscall pseudo-segment */
b0d623f7
A
344#define USER_CTHREAD 0x0f /* user cthread area */
345#define USER_SETTABLE 0x1f /* start of user settable ldt entries */
b0d623f7 346#endif
0c530ab8 347
1c79356b 348#endif /* _I386_SEG_H_ */