VMM: EPT checks, init, and basic usage
[akaros.git] / kern / arch / x86 / ros / mmu64.h
1 #ifndef ROS_INC_ARCH_MMU64_H
2 #define ROS_INC_ARCH_MMU64_H
3
4 #ifndef ROS_INC_ARCH_MMU_H
5 #error "Do not include include ros/arch/mmu64.h directly"
6 #endif
7
8 #ifndef __ASSEMBLER__
9 #include <ros/common.h>
10 typedef unsigned long kpte_t;
11 typedef unsigned long epte_t;
12
13 typedef struct x86_pte {
14         kpte_t  *kpte;
15         epte_t  *epte;
16 } pte_t;
17
18 typedef struct x86_pgdir {
19         kpte_t  *kpte;
20         epte_t  *epte;
21         uint64_t eptp;
22 } pgdir_t;
23 #endif
24
25 /* Virtual memory map:                                  Virt Addresses
26  *                                                      perms: kernel/user
27  *
28  *                     +------------------------------+ 0xffffffffffffffff -+
29  *                     |                              |                     |
30  *                     |   Mapped to lowmem, unused   | RW/--               |
31  *                     |                              |                     |
32  *  "end" symbol  -->  +------------------------------+        PML3_PTE_REACH
33  *                     |                              |                     |
34  *                     |  Kernel link/load location   |                     |
35  *                     |    (mapped to 0, physical)   |                     |
36  *                     |                              |                     |
37  * KERN_LOAD_ADDR -->  +------------------------------+ 0xffffffffc0000000 -+
38  *                     |                              |
39  *                     |          Local APIC          | RW/--  APIC_SIZE (1MB)
40  *                     |                              |
41  *    LAPIC_BASE  -->  +------------------------------+ 0xffffffffbff00000
42  *                     |                              |
43  *                     |            IOAPIC            | RW/--  APIC_SIZE (1MB)
44  *                     |                              |
45  *  IOAPIC_BASE,  -->  +------------------------------+ 0xffffffffbfe00000
46  *  KERN_DYN_TOP       |   Kernel Dynamic Mappings    |
47  *                     |              .               |
48  *                     :              .               :
49  *                     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ RW/--
50  *                     :                              :
51  *                     |          Unmapped            | --/--
52  *                     |                              |
53  *                     |  Kernel static linking limit |
54  *                     +------------------------------+ 0xffffffff80000000
55  *                     |                              |
56  *                     |                              |
57  *                     |                              |
58  *  VPT_TOP    ----->  +------------------------------+ 0xffffff0000000000 -+
59  *                     |                              |                     |
60  *                     |                              |                     |
61  *                     |  Cur. Page Table (Kern. RW)  | RW/--  P4ML_PTE_REACH
62  *                     |                              |                     |
63  *                     |                              |                     |
64  *    VPT,     ----->  +------------------------------+ 0xfffffe8000000000 -+
65  *  KERN_VMAP_TOP      |                              |
66  *                     :              .               :
67  *                     :              .               :
68  *                     :              .               :
69  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~| RW/--
70  *                     |                              | RW/--
71  *                     |                              | RW/--
72  *                     |                              | RW/--
73  *                     |   Remapped Physical Memory   | RW/--
74  *                     |                              | RW/--
75  *                     |                              | RW/--
76  *                     |                              | RW/--
77  *    KERNBASE  ---->  +------------------------------+ 0xffff800000000000
78  *                     |                              |
79  *                     |                              |
80  *                     |                              |
81  *                     |   Non-canonical addresses    |
82  *                     |         (unusable)           |
83  *                     |                              |
84  *                     |                              |
85  * ULIM (not canon) -> +------------------------------+ 0x0000800000000000 -+
86  *                     +     Highest user address     + 0x00007fffffffffff  |
87  *                     |                              |                     |
88  *                     |  Cur. Page Table (User R-)   | R-/R-  PML4_PTE_REACH
89  *                     |                              |                     |
90  *    UVPT      ---->  +------------------------------+ 0x00007f8000000000 -+
91  *                     | Unmapped (expandable region) |                     |
92  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|                     |
93  *                     |     Per-Process R/O Info     | R-/R-  PML2_PTE_REACH
94  *                     |         (procinfo)           |                     |
95  * UWLIM, UINFO ---->  +------------------------------+ 0x00007f7fffe00000 -+
96  *                     | Unmapped (expandable region) |                     |
97  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|                     |
98  *                     |     Per-Process R/W Data     | RW/RW  PML2_PTE_REACH
99  *                     |         (procdata)           |                     |
100  *    UDATA     ---->  +------------------------------+ 0x00007f7fffc00000 -+
101  *                     |                              |
102  *                     |    Global Shared R/W Data    | RW/RW  PGSIZE
103  *                     |                              |
104  * UMAPTOP, UGDATA ->  +------------------------------+ 0x00007f7fffbff000
105  *    USTACKTOP        |                              |
106  *                     |      Normal User Stack       | RW/RW 256 * PGSIZE
107  *                     |                              |
108  *                     +------------------------------+ 0x00007f7fffaff000
109  *                     |                              |
110  *                     |        Empty Memory          |
111  *                     |                              |
112  *                     .                              .
113  *                     .                              .
114  *    BRK_END   ---->  +------------------------------+ 0x0000400000000000
115  *                     .                              .
116  *                     .                              .
117  *                     |                              |
118  *                     |        Empty Memory          |
119  *                     |                              |
120  *                     |~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~|
121  *                     |                              |
122  *                     |     Program Data & Heap      |
123  *                     |                              |
124  *                     +------------------------------+ 0x0000000000400000
125  *                     |                              |
126  *                     |       Empty Memory (*)       |
127  *                     |                              |
128  *                     +------------------------------+ 0x0000000000000000
129  */
130
131 /* Physical Mapping symbols:
132  * At IOPHYSMEM (640K) there is a 384K hole for I/O.  From the kernel,
133  * IOPHYSMEM can be addressed at KERNBASE + IOPHYSMEM.  The hole ends
134  * at physical address EXTPHYSMEM. */
135 #define IOPHYSMEM               0x0A0000
136 #define VGAPHYSMEM              0x0A0000
137 #define DEVPHYSMEM              0x0C0000
138 #define BIOSPHYSMEM             0x0F0000
139 #define EXTPHYSMEM              0x100000
140
141 /* Kernel Virtual Memory Mapping */
142
143 /* The kernel needs to be loaded in the top 2 GB of memory, since we compile it
144  * with -mcmodel=kernel (helps with relocations).  We're actually loading it in
145  * the top 1 GB. */
146 #define KERN_LOAD_ADDR  0xffffffffc0000000
147 /* Static kernel mappings */
148 #define APIC_SIZE               0x100000
149 #define LAPIC_BASE              (KERN_LOAD_ADDR - APIC_SIZE)
150 #define IOAPIC_BASE             (LAPIC_BASE - APIC_SIZE)
151 /* All arches must define this, which is the lower limit of their static
152  * mappings, and where the dynamic mappings will start. */
153 #define KERN_DYN_TOP    IOAPIC_BASE
154
155 /* Virtual page table.  Every PML4 has a PTE at the slot (PML4(VPT))
156  * corresponding to VPT that points to that PML4's base.  In essence, the 512
157  * GB chunk of the VA space from VPT..VPT_TOP is a window into the paging
158  * structure.
159  *
160  * The VPT needs to be aligned on 39 bits.
161  *
162  * Ex: Say the VPT's entry in 9 bits is "9v".  If you construct a VA from:
163  * 9v9v9v9v000, the paging hardware will recurse 4 times, with the end result
164  * being the PML4.  That virtual address will map to the PML4 itself.
165  *
166  * If you want to see a specific PML3, figure out which entry it is in the
167  * PML4 (using PML3(va)), say 9 bits = "9X".  The VA 9v9v9v9X000 will map to
168  * that PML3. */
169 #define VPT_TOP                 0xffffff0000000000
170 #define VPT                             (VPT_TOP - PML4_PTE_REACH)
171 /* Helper to return the current outer pgdir via the VPT mapping. */
172 #define VPD (VPT + ((VPT & 0x0000ffffffffffff) >> 9) +                         \
173                    ((VPT & 0x0000ffffffffffff) >> 18) +                        \
174                    ((VPT & 0x0000ffffffffffff) >> 27))
175 #define vpd VPD
176
177 /* Top of the kernel virtual mapping area (KERNBASE) */
178 #define KERN_VMAP_TOP   (VPT)
179 /* Base of the physical memory map. This maps from 0 physical to max_paddr */
180 #define KERNBASE        0xffff800000000000
181
182 /* Highest user address: 0x00007fffffffffff: 1 zero, 47 ones, sign extended.
183  * From here down to UWLIM is User Read-only */
184 #define ULIM            0x0000800000000000
185 /* Same as VPT but read-only for users */
186 #define UVPT                    (ULIM - PML4_PTE_REACH)
187 /* Arbitrary boundary between the break and the start of
188  * memory returned by calls to mmap with addr = 0 */
189 #define BRK_END                 0x0000400000000000
190
191 /* **************************************** */
192 /* Page table constants, macros, etc */
193
194 /* A linear address 'la' has a five-part structure as follows:
195  *
196  * +-----9------+-----9------+-----9------+-----9------+---------12----------+
197  * | PML4 bits  | PML3 bits  | PML2 bits  | PML1 bits  |     Page offset     |
198  * |   offset   |   offset   |   offset   |   offset   |                     |
199  * +------------+------------+------------+------------+---------------------+
200  *  \ PML4(la) / \ PML3(la) / \ PML2(la) / \ PML1(la) / \---- PGOFF(la) ----/
201  *  \------------------ LA2PPN(la) -------------------/
202  *
203  * The PMLx, PGOFF, and LA2PPN macros decompose linear addresses as shown.
204  * To construct a linear address la from these, use:
205  * PGADDR(PML4(la), PML3(la), PML2(la), PML1(la), PGOFF(la)).
206  * Careful, that's arch- and bit-specific.
207  *
208  * I'd somewhat like it if we started counting from the outer-most PT, though
209  * amd coined the term PML4 for the outermost, instead of PML1.  Incidentally,
210  * they also don't use numbers other than PML4, sticking with names like PDP. */
211
212 #define PML4_SHIFT              39
213 #define PML3_SHIFT              30
214 #define PML2_SHIFT              21
215 #define PML1_SHIFT              12
216 #define BITS_PER_PML    9
217
218 /* PTE reach is the amount of VM an entry can map, either as a jumbo or as
219  * further page tables.  I'd like to write these as shifts, but I can't please
220  * both the compiler and the assembler. */
221 #define PML4_PTE_REACH  (0x0000008000000000)    /* No jumbos available */
222 #define PML3_PTE_REACH  (0x0000000040000000)    /* 1 GB jumbos available */
223 #define PML2_PTE_REACH  (0x0000000000200000)    /* 2 MB jumbos available */
224 #define PML1_PTE_REACH  (0x0000000000001000)    /* aka, PGSIZE */
225
226 /* Reach is the amount of VM a table can map, counting all of its entries.
227  * Note that a PML(n)_PTE is a PML(n-1) table. */
228 #define PML3_REACH              (PML4_PTE_REACH)
229 #define PML2_REACH              (PML3_PTE_REACH)
230 #define PML1_REACH              (PML2_PTE_REACH)
231
232 /* PMLx(la, shift) gives the 9 bits specifying the la's entry in the PML
233  * corresponding to shift.  PMLn(la) gives the 9 bits for PML4, etc. */
234 #define PMLx(la, shift) (((uintptr_t)(la) >> (shift)) & 0x1ff)
235 #define PML4(la)                PMLx(la, PML4_SHIFT)
236 #define PML3(la)                PMLx(la, PML3_SHIFT)
237 #define PML2(la)                PMLx(la, PML2_SHIFT)
238 #define PML1(la)                PMLx(la, PML1_SHIFT)
239
240 /* Common kernel helpers */
241 #define PGSHIFT                 PML1_SHIFT
242 #define PGSIZE                  PML1_PTE_REACH
243 #define LA2PPN(la)              ((uintptr_t)(la) >> PGSHIFT)
244 #define PTE2PPN(pte)    LA2PPN(pte)
245 #define PGOFF(la)               ((uintptr_t)(la) & (PGSIZE - 1))
246
247 /* construct PTE from PPN and flags */
248 #define PTE(ppn, flags) ((ppn) << PGSHIFT | PGOFF(flags))
249
250 /* construct linear address from indexes and offset */
251 #define PGADDR(p4, p3, p2, p1, o) ((void*)(((p4) << PML4_SHIFT) |              \
252                                            ((p3) << PML3_SHIFT) |              \
253                                            ((p2) << PML2_SHIFT) |              \
254                                            ((p1) << PML1_SHIFT) |(o)))
255
256 /* This is used in places (procinfo) meaning "size of smallest jumbo page" */
257 #define PTSIZE PML2_PTE_REACH
258
259
260 /* TODO: not sure if we'll need these - limited to 64bit code */
261 /* this only gives us the L1 PML */
262 #define PTX(la)         ((((uintptr_t) (la)) >> 12) & 0x1ff)
263 #define JPGOFF(la)      (((uintptr_t) (la)) & 0x001FFFFF)
264 #define NPTENTRIES              512
265 #define JPGSIZE PTSIZE
266
267 /* Page table/directory entry flags. */
268
269 /* Some things to be careful of:  Global and PAT only apply to the last PTE in
270  * a chain: so either a PTE in PML1, or a Jumbo PTE in PML2 or 3.  When PAT
271  * applies, which bit we use depends on whether we are jumbo or not.  For PML1,
272  * PAT is bit 8.  For jumbo PTEs (and only when they are for a jumbo page), we
273  * use bit 12. */
274 #define PTE_P                   0x001   /* Present */
275 #define PTE_W                   0x002   /* Writeable */
276 #define PTE_U                   0x004   /* User */
277 #define PTE_PWT                 0x008   /* Write-Through */
278 #define PTE_PCD                 0x010   /* Cache-Disable */
279 #define PTE_A                   0x020   /* Accessed */
280 #define PTE_D                   0x040   /* Dirty */
281 #define PTE_PS                  0x080   /* Page Size */
282 #define PTE_PAT                 0x080   /* Page attribute table */
283 #define PTE_G                   0x100   /* Global Page */
284 #define PTE_JPAT                0x800   /* Jumbo PAT */
285 #define PTE_NOCACHE             (PTE_PWT | PTE_PCD)
286
287 /* Permissions fields and common access modes.  These should be read as 'just
288  * kernel or user too' and 'RO or RW'.  USER_RO means read-only for everyone. */
289 #define PTE_PERM                (PTE_W | PTE_U)
290 #define PTE_KERN_RW             PTE_W           // Kernel Read/Write
291 #define PTE_KERN_RO             0               // Kernel Read-Only
292 #define PTE_USER_RW             (PTE_W | PTE_U) // Kernel/User Read/Write
293 #define PTE_USER_RO             PTE_U           // Kernel/User Read-Only
294
295 /* The PTE/translation part of a PTE/virtual(linear) address.  It's used
296  * frequently to be the page address of a virtual address.  Note this doesn't
297  * work on jumbo PTEs due to the reserved bits.  Jumbo's don't have a PTE_ADDR
298  * in them - just a base address of wherever they point. */
299 #define PTE_ADDR(pte)   ((physaddr_t) (pte) & ~(PGSIZE - 1))
300 /* More meaningful macro, same as PTE_ADDR */
301 #define PG_ADDR(la)     ((uintptr_t)(la) & ~(PGSIZE - 1))
302
303 /* we must guarantee that for any PTE, exactly one of the following is true */
304 #define PAGE_PRESENT(pte) ((pte) & PTE_P)
305 #define PAGE_UNMAPPED(pte) ((pte) == 0)
306 #define PAGE_PAGED_OUT(pte) (!PAGE_PRESENT(pte) && !PAGE_UNMAPPED(pte))
307
308
309 /* **************************************** */
310 /* Segmentation */
311
312 /* Global descriptor numbers */
313 #define GD_NULL                 0x00    /* NULL descriptor */
314 #define GD_KT                   0x08    /* kernel text */
315 #define GD_KD                   0x10    /* kernel data */
316 /* syscall/sysret wants UD before UT, but KT before KD.  it really wants UT32,
317  * UD, UT64.  anyways... */
318 #define GD_UD                   0x18    /* user data */
319 #define GD_UT                   0x20    /* user text */
320 #define GD_TSS                  0x28    /* Task segment selector */
321 #define GD_TSS2                 0x30    /* Placeholder, TSS is 2-descriptors wide */
322 /* These two aren't in the GDT yet (might never be) */
323 #define GD_LDT                  0x38    /* Local descriptor table */
324 #define GD_LDT2                 0x40    /* Placeholder */
325
326 #ifdef __ASSEMBLER__
327
328 /* Macros to build GDT entries in assembly. */
329 #define SEG_NULL                                                \
330         .word 0, 0;                                             \
331         .byte 0, 0, 0, 0
332
333 /* 64 bit code segment.  This is for long mode, no compatibility.  If we want
334  * to support 32 bit apps later, we'll want to adjust this. */
335 #define SEG_CODE_64(dpl)                                                    \
336         .word 0, 0;                                                             \
337         .byte 0;                                                                \
338         .byte (((1/*p*/) << 7) | ((dpl) << 5) | 0x18 | ((0/*c*/) << 2));        \
339         .byte (((0/*d*/) << 6) | ((1/*l*/) << 5));                              \
340         .byte 0;
341
342 /* 64 bit data segment.  These are pretty much completely ignored (except if we
343  * use them for fs/gs, or compatibility mode */
344 #define SEG_DATA_64(dpl)                                                    \
345         .word 0xffff, 0;                                                        \
346         .byte 0;                                                                \
347         .byte (0x92 | ((dpl) << 5));                                            \
348         .byte 0x8f;                                                             \
349         .byte 0;
350
351 /* System segments (TSS/LDT) are twice as long as usual (16 bytes). */
352 #define SEG_SYS_64(type, base, lim, dpl)                                       \
353         .word ((lim) & 0xffff);                                                    \
354         .word ((base) & 0xffff);                                                   \
355         .byte (((base) >> 16) & 0xff);                                             \
356         .byte ((1 << 7) | ((dpl) << 5) | (type));                                  \
357         .byte (((1/*g*/) << 7) | (((lim) >> 16) & 0xf));                           \
358         .byte (((base) >> 24) & 0xff);                                             \
359         .quad ((base) >> 32);                                                      \
360         .quad 0;
361
362 /* Default segment (32 bit style).  Would work for fs/gs, if needed */
363 #define SEG(type, base, lim)                                                \
364         .word (((lim) >> 12) & 0xffff);                                         \
365         .word ((base) & 0xffff);                                                \
366         .byte (((base) >> 16) & 0xff);                                          \
367         .byte (0x90 | (type));                                                  \
368         .byte (0xC0 | (((lim) >> 28) & 0xf));                                   \
369         .byte (((base) >> 24) & 0xff)
370
371 #else   // not __ASSEMBLER__
372
373 /* Legacy Segment Descriptor (used for 64 bit data and code) */
374 typedef struct Segdesc {
375         unsigned sd_lim_15_0 : 16;  // Low bits of segment limit
376         unsigned sd_base_15_0 : 16; // Low bits of segment base address
377         unsigned sd_base_23_16 : 8; // Middle bits of segment base address
378         unsigned sd_type : 4;       // Segment type (see STS_ constants)
379         unsigned sd_s : 1;          // 0 = system, 1 = application
380         unsigned sd_dpl : 2;        // Descriptor Privilege Level
381         unsigned sd_p : 1;          // Present
382         unsigned sd_lim_19_16 : 4;  // High bits of segment limit
383         unsigned sd_avl : 1;        // Unused (available for software use)
384         unsigned sd_rsv1 : 1;       // Reserved
385         unsigned sd_db : 1;         // 0 = 16-bit segment, 1 = 32-bit segment
386         unsigned sd_g : 1;          // Granularity: limit scaled by 4K when set
387         unsigned sd_base_31_24 : 8; // High bits of segment base address
388 } segdesc_t;
389
390 /* Lower half is similar (more ignored, etc)  to a legacy system descriptor */
391 struct x86_sysseg64 {
392         unsigned sd_lim_15_0 : 16;      /* Low bits of segment limit */
393         unsigned sd_base_15_0 : 16;     /* Low bits of segment base address */
394         unsigned sd_base_23_16 : 8;     /* Middle bits of segment base address */
395         unsigned sd_type : 4;           /* Segment type (see STS_ constants) */
396         unsigned sd_s : 1;                      /* 0 = system, 1 = application */
397         unsigned sd_dpl : 2;            /* Descriptor Privilege Level */
398         unsigned sd_p : 1;                      /* Present */
399         unsigned sd_lim_19_16 : 4;      /* High bits of segment limit */
400         unsigned sd_avl : 1;            /* Unused (available for software use) */
401         unsigned sd_rsv2 : 2;           /* Reserved */
402         unsigned sd_g : 1;                      /* Granularity: limit scaled by 4K when set */
403         unsigned sd_base_31_24 : 8;     /* 24-31 bits of segment base address */
404         unsigned sd_base_63_32;         /* top 32 bits of the base */
405         unsigned sd_reserved;           /* some parts must be zero, just zero it all */
406 };
407 typedef struct x86_sysseg64 syssegdesc_t;
408
409 /* G(ranularity) determines if the limit is shifted */
410 #define __SEG_SYS64(type, base, lim, dpl, g)                                   \
411 { ((lim) >> ((g) * 12)) & 0xffff, (base) & 0xffff, ((base) >> 16) & 0xff,      \
412     type, 0, dpl, 1, (unsigned) (lim) >> 28, 0, 0, (g),                        \
413     ((unsigned) (base) >> 24) & 0xff,                                          \
414     ((unsigned long) (base) >> 32), 0 }
415
416 /* Normal system segment descriptor (LDT or TSS). (limit is scaled by 4k) */
417 #define SEG_SYS64(type, base, lim, dpl)                                        \
418         __SEG_SYS64(type, base, lim, dpl, 1)
419
420 /* Smaller system segment descriptor (LDT or TSS). */
421 #define SEG_SYS64_SMALL(type, base, lim, dpl)                                  \
422         __SEG_SYS64(type, base, lim, dpl, 0)
423
424 #define SEG_SYS_SMALL(type, base, lim, dpl) \
425         SEG_SYS64_SMALL(type, base, lim, dpl)
426
427 /* 64 bit task state segment (AMD 2:12.2.5) */
428 typedef struct taskstate {
429         uint32_t                                        ts_rsv1;        /* reserved / ignored */
430         uint64_t                                        ts_rsp0;        /* stack ptr in ring 0 */
431         uint64_t                                        ts_rsp1;        /* stack ptr in ring 1 */
432         uint64_t                                        ts_rsp2;        /* stack ptr in ring 2 */
433         uint64_t                                        ts_rsv2;        /* reserved / ignored */
434         uint64_t                                        ts_ist1;        /* IST stacks: unconditional rsp */
435         uint64_t                                        ts_ist2;        /* check AMD 2:8.9.4 for info */
436         uint64_t                                        ts_ist3;
437         uint64_t                                        ts_ist4;
438         uint64_t                                        ts_ist5;
439         uint64_t                                        ts_ist6;
440         uint64_t                                        ts_ist7;
441         uint64_t                                        ts_rsv3;        /* reserved / ignored */
442         uint16_t                                        ts_rsv4;        /* reserved / ignored */
443         uint16_t                                        ts_iobm;        /* IO base map (offset) */
444 } __attribute__((packed)) taskstate_t;
445
446 /* 64 bit gate descriptors for interrupts and traps */
447 typedef struct Gatedesc {
448         unsigned gd_off_15_0 : 16;      /* low 16 bits of offset in segment */
449         unsigned gd_ss : 16;            /* segment selector */
450         unsigned gd_ist : 3;            /* interrupt stack table selector (0 = none) */
451         unsigned gd_rsv1 : 5;           /* ignored */
452         unsigned gd_type : 4;           /* type(STS_{TG,IG32,TG32}) */
453         unsigned gd_s : 1;                      /* must be 0 (system) */
454         unsigned gd_dpl : 2;            /* DPL - highest ring allowed to use this */
455         unsigned gd_p : 1;                      /* Present */
456         unsigned gd_off_31_16 : 16;     /* 16-31 bits of offset in segment */
457         unsigned gd_off_63_32;          /* top 32 bits of offset */
458         unsigned gd_rsv2;                       /* reserved / unsused */
459 } gatedesc_t;
460
461 /* Set up an IST-capable 64 bit interrupt/trap gate descriptor.  IST selects a
462  * stack pointer from the interrupt-stack table (in TSS) that will be loaded
463  * unconditionally when we hit this gate  - regardless of privelege change. */
464 #define SETGATE64(gate, istrap, sel, off, dpl, ist)                            \
465 {                                                                              \
466         (gate).gd_off_15_0 = (uintptr_t) (off) & 0xffff;                           \
467         (gate).gd_ss = (sel);                                                      \
468         (gate).gd_ist = (ist);                                                     \
469         (gate).gd_rsv1 = 0;                                                        \
470         (gate).gd_type = (istrap) ? STS_TG32 : STS_IG32;                           \
471         (gate).gd_s = 0;                                                           \
472         (gate).gd_dpl = (dpl);                                                     \
473         (gate).gd_p = 1;                                                           \
474         (gate).gd_off_31_16 = (uintptr_t) (off) >> 16;                             \
475         (gate).gd_off_63_32 = (uintptr_t) (off) >> 32;                             \
476         (gate).gd_rsv2 = 0;                                                        \
477 }
478
479 /* Set up a normal, 64 bit interrupt/trap gate descriptor.
480  * - istrap: 1 for a trap (= exception) gate, 0 for an interrupt gate.
481  *   - interrupt gates automatically disable interrupts (cli)
482  * - sel: Code segment selector for interrupt/trap handler
483  * - off: Offset in code segment for interrupt/trap handler (address)
484  * - dpl: Descriptor Privilege Level -
485  *        the privilege level required for software to invoke
486  *        this interrupt/trap gate explicitly using an int instruction. */
487 #define SETGATE(gate, istrap, sel, off, dpl)                                   \
488         SETGATE64(gate, istrap, sel, off, dpl, 0)
489
490 // Pseudo-descriptors used for LGDT, LLDT and LIDT instructions.
491 typedef struct Pseudodesc {
492         uint16_t pd_lim;                // Limit
493         uintptr_t pd_base;              // Base address
494 } __attribute__ ((packed)) pseudodesc_t;
495
496 #endif /* !__ASSEMBLER__ */
497
498 // Application segment type bits
499 #define STA_X           0x8         // Executable segment
500 #define STA_E           0x4         // Expand down (non-executable segments)
501 #define STA_C           0x4         // Conforming code segment (executable only)
502 #define STA_W           0x2         // Writeable (non-executable segments)
503 #define STA_R           0x2         // Readable (executable segments)
504 #define STA_A           0x1         // Accessed
505
506 /* System segment type bits.  All other types are reserved/illegal.  The '32' is
507  * mostly a legacy naming - the bits work for both 64 and 32. */
508 #define STS_LDT         0x2             /* 64-bit Local Descriptor Table  */
509 #define STS_T32A        0x9             /* Available 64-bit TSS */
510 #define STS_T32B        0xB             /* Busy 64-bit TSS */
511 #define STS_CG32        0xC             /* 64-bit Call Gate */
512 #define STS_IG32        0xE             /* 64-bit Interrupt Gate */
513 #define STS_TG32        0xF             /* 64-bit Trap Gate */
514
515 #define SEG_COUNT       7               /* Number of GDT segments */
516 /* TODO: Probably won't use this */
517 #define LDT_SIZE        (8192 * sizeof(segdesc_t))
518
519 /* TLS 'syscall', coupled to trapentry64.S.  Needed a non-canon 'addr' */
520 #define FASTCALL_SETFSBASE 0xf0f0000000000001
521
522 #endif /* ROS_INC_ARCH_MMU64_H */