Cleanup JOS references and add typedefs
[akaros.git] / inc / mmu.h
1 #ifndef ROS_INC_MMU_H
2 #define ROS_INC_MMU_H
3
4 /*
5  * This file contains definitions for the x86 memory management unit (MMU),
6  * including paging- and segmentation-related data structures and constants,
7  * the %cr0, %cr4, and %eflags registers, and traps.
8  */
9
10 /*
11  *
12  *      Part 1.  Paging data structures and constants.
13  *
14  */
15
16 // A linear address 'la' has a three-part structure as follows:
17 //
18 // +--------10------+-------10-------+---------12----------+
19 // | Page Directory |   Page Table   | Offset within Page  |
20 // |      Index     |      Index     |                     |
21 // +----------------+----------------+---------------------+
22 //  \--- PDX(la) --/ \--- PTX(la) --/ \---- PGOFF(la) ----/
23 //  \----------- PPN(la) -----------/
24 //
25 // The PDX, PTX, PGOFF, and PPN macros decompose linear addresses as shown.
26 // To construct a linear address la from PDX(la), PTX(la), and PGOFF(la),
27 // use PGADDR(PDX(la), PTX(la), PGOFF(la)).
28
29 // page number field of address
30 #define PPN(la)         (((uintptr_t) (la)) >> PTXSHIFT)
31 #define VPN(la)         PPN(la)         // used to index into vpt[]
32
33 // page directory index
34 #define PDX(la)         ((((uintptr_t) (la)) >> PDXSHIFT) & 0x3FF)
35 #define VPD(la)         PDX(la)         // used to index into vpd[]
36
37 // page table index
38 #define PTX(la)         ((((uintptr_t) (la)) >> PTXSHIFT) & 0x3FF)
39
40 // offset in page
41 #define PGOFF(la)       (((uintptr_t) (la)) & 0xFFF)
42
43 // offset in jumbo page
44 #define JPGOFF(la)      (((uintptr_t) (la)) & 0x003FFFFF)
45
46 // construct linear address from indexes and offset
47 #define PGADDR(d, t, o) ((void*) ((d) << PDXSHIFT | (t) << PTXSHIFT | (o)))
48
49 // Page directory and page table constants.
50 #define NPDENTRIES      1024            // page directory entries per page directory
51 #define NPTENTRIES      1024            // page table entries per page table
52
53 #define PGSIZE          4096            // bytes mapped by a page
54 #define JPGSIZE         4096*1024       // bytes mapped by a jumbo page (4MB)
55 #define PGSHIFT         12              // log2(PGSIZE)
56
57 #define PTSIZE          (PGSIZE*NPTENTRIES) // bytes mapped by a page directory entry
58 #define PTSHIFT         22              // log2(PTSIZE)
59
60 #define PTXSHIFT        12              // offset of PTX in a linear address
61 #define PDXSHIFT        22              // offset of PDX in a linear address
62
63 // Page table/directory entry flags.
64 #define PTE_P           0x001   // Present
65 #define PTE_W           0x002   // Writeable
66 #define PTE_U           0x004   // User
67 #define PTE_PWT         0x008   // Write-Through
68 #define PTE_PCD         0x010   // Cache-Disable
69 #define PTE_A           0x020   // Accessed
70 #define PTE_D           0x040   // Dirty
71 #define PTE_PS          0x080   // Page Size (only applies to PDEs)
72 #define PTE_PAT         0x080   // PAT (only applies to second layer PTEs)
73 #define PTE_G           0x100   // Global Page
74
75 // The PTE_AVAIL bits aren't used by the kernel or interpreted by the
76 // hardware, so user processes are allowed to set them arbitrarily.
77 #define PTE_AVAIL       0xE00   // Available for software use
78
79 // Only flags in PTE_USER may be used in system calls.
80 #define PTE_USER        (PTE_AVAIL | PTE_P | PTE_W | PTE_U)
81
82 // address in page table entry
83 #define PTE_ADDR(pte)   ((physaddr_t) (pte) & ~0xFFF)
84
85 // Control Register flags
86 #define CR0_PE          0x00000001      // Protection Enable
87 #define CR0_MP          0x00000002      // Monitor coProcessor
88 #define CR0_EM          0x00000004      // Emulation
89 #define CR0_TS          0x00000008      // Task Switched
90 #define CR0_ET          0x00000010      // Extension Type
91 #define CR0_NE          0x00000020      // Numeric Error
92 #define CR0_WP          0x00010000      // Write Protect
93 #define CR0_AM          0x00040000      // Alignment Mask
94 #define CR0_NW          0x20000000      // Not Writethrough - more tricky than it sounds
95 #define CR0_CD          0x40000000      // Cache Disable
96 #define CR0_PG          0x80000000      // Paging
97
98 // These two relate to the cacheability (L1, etc) of the page directory
99 #define CR3_PWT         0x00000008      // Page directory caching write through
100 #define CR3_PCD         0x00000010      // Page directory caching disabled
101
102 #define CR4_VME         0x00000001      // V86 Mode Extensions
103 #define CR4_PVI         0x00000002      // Protected-Mode Virtual Interrupts
104 #define CR4_TSD         0x00000004      // Time Stamp Disable
105 #define CR4_DE          0x00000008      // Debugging Extensions
106 #define CR4_PSE         0x00000010      // Page Size Extensions
107 #define CR4_PAE         0x00000020      // Physical Address Extensions
108 #define CR4_MCE         0x00000040      // Machine Check Enable
109 #define CR4_PGE         0x00000080      // Global Pages Enabled
110 #define CR4_PCE         0x00000100      // Performance counter enable
111 #define CR4_OSFXSR      0x00000200      // OS support for FXSAVE/FXRSTOR
112 #define CR4_OSXMME      0x00000400      // OS support for unmasked SIMD FP exceptions
113 #define CR4_VMXE        0x00002000      // VMX enable
114 #define CR4_SMXE        0x00004000      // SMX enable
115 #define CR4_OSXSAVE     0x00040000      // XSAVE and processor extended states-enabled
116
117 // Eflags register
118 #define FL_CF           0x00000001      // Carry Flag
119 #define FL_PF           0x00000004      // Parity Flag
120 #define FL_AF           0x00000010      // Auxiliary carry Flag
121 #define FL_ZF           0x00000040      // Zero Flag
122 #define FL_SF           0x00000080      // Sign Flag
123 #define FL_TF           0x00000100      // Trap Flag
124 #define FL_IF           0x00000200      // Interrupt Flag
125 #define FL_DF           0x00000400      // Direction Flag
126 #define FL_OF           0x00000800      // Overflow Flag
127 #define FL_IOPL_MASK    0x00003000      // I/O Privilege Level bitmask
128 #define FL_IOPL_0       0x00000000      //   IOPL == 0
129 #define FL_IOPL_1       0x00001000      //   IOPL == 1
130 #define FL_IOPL_2       0x00002000      //   IOPL == 2
131 #define FL_IOPL_3       0x00003000      //   IOPL == 3
132 #define FL_NT           0x00004000      // Nested Task
133 #define FL_RF           0x00010000      // Resume Flag
134 #define FL_VM           0x00020000      // Virtual 8086 mode
135 #define FL_AC           0x00040000      // Alignment Check
136 #define FL_VIF          0x00080000      // Virtual Interrupt Flag
137 #define FL_VIP          0x00100000      // Virtual Interrupt Pending
138 #define FL_ID           0x00200000      // ID flag
139
140 // Page fault error codes
141 #define FEC_PR          0x1     // Page fault caused by protection violation
142 #define FEC_WR          0x2     // Page fault caused by a write
143 #define FEC_U           0x4     // Page fault occured while in user mode
144
145
146 /*
147  *
148  *      Part 2.  Segmentation data structures and constants.
149  *
150  */
151
152 #ifdef __ASSEMBLER__
153
154 /*
155  * Macros to build GDT entries in assembly.
156  */
157 #define SEG_NULL                                                \
158         .word 0, 0;                                             \
159         .byte 0, 0, 0, 0
160 #define SEG(type,base,lim)                                      \
161         .word (((lim) >> 12) & 0xffff), ((base) & 0xffff);      \
162         .byte (((base) >> 16) & 0xff), (0x90 | (type)),         \
163                 (0xC0 | (((lim) >> 28) & 0xf)), (((base) >> 24) & 0xff)
164
165 #else   // not __ASSEMBLER__
166
167 #include <inc/types.h>
168
169 // Segment Descriptors
170 typedef struct Segdesc {
171         unsigned sd_lim_15_0 : 16;  // Low bits of segment limit
172         unsigned sd_base_15_0 : 16; // Low bits of segment base address
173         unsigned sd_base_23_16 : 8; // Middle bits of segment base address
174         unsigned sd_type : 4;       // Segment type (see STS_ constants)
175         unsigned sd_s : 1;          // 0 = system, 1 = application
176         unsigned sd_dpl : 2;        // Descriptor Privilege Level
177         unsigned sd_p : 1;          // Present
178         unsigned sd_lim_19_16 : 4;  // High bits of segment limit
179         unsigned sd_avl : 1;        // Unused (available for software use)
180         unsigned sd_rsv1 : 1;       // Reserved
181         unsigned sd_db : 1;         // 0 = 16-bit segment, 1 = 32-bit segment
182         unsigned sd_g : 1;          // Granularity: limit scaled by 4K when set
183         unsigned sd_base_31_24 : 8; // High bits of segment base address
184 } segdesc_t;
185 // Null segment
186 #define SEG_NULL        (segdesc_t){ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
187 // Segment that is loadable but faults when used
188 #define SEG_FAULT       (segdesc_t){ 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 1, 0, 0 }
189 // Normal segment
190 #define SEG(type, base, lim, dpl) (segdesc_t)                                           \
191 { ((lim) >> 12) & 0xffff, (base) & 0xffff, ((base) >> 16) & 0xff,       \
192     type, 1, dpl, 1, (unsigned) (lim) >> 28, 0, 0, 1, 1,                        \
193     (unsigned) (base) >> 24 }
194 #define SEG16(type, base, lim, dpl) (segdesc_t)                                         \
195 { (lim) & 0xffff, (base) & 0xffff, ((base) >> 16) & 0xff,                       \
196     type, 1, dpl, 1, (unsigned) (lim) >> 16, 0, 0, 1, 0,                        \
197     (unsigned) (base) >> 24 }
198
199 #endif /* !__ASSEMBLER__ */
200
201 // Application segment type bits
202 #define STA_X           0x8         // Executable segment
203 #define STA_E           0x4         // Expand down (non-executable segments)
204 #define STA_C           0x4         // Conforming code segment (executable only)
205 #define STA_W           0x2         // Writeable (non-executable segments)
206 #define STA_R           0x2         // Readable (executable segments)
207 #define STA_A           0x1         // Accessed
208
209 // System segment type bits
210 #define STS_T16A        0x1         // Available 16-bit TSS
211 #define STS_LDT         0x2         // Local Descriptor Table
212 #define STS_T16B        0x3         // Busy 16-bit TSS
213 #define STS_CG16        0x4         // 16-bit Call Gate
214 #define STS_TG          0x5         // Task Gate / Coum Transmitions
215 #define STS_IG16        0x6         // 16-bit Interrupt Gate
216 #define STS_TG16        0x7         // 16-bit Trap Gate
217 #define STS_T32A        0x9         // Available 32-bit TSS
218 #define STS_T32B        0xB         // Busy 32-bit TSS
219 #define STS_CG32        0xC         // 32-bit Call Gate
220 #define STS_IG32        0xE         // 32-bit Interrupt Gate
221 #define STS_TG32        0xF         // 32-bit Trap Gate
222
223 #define SEG_COUNT       6               // Number of segments in the steady state
224
225 /*
226  *
227  *      Part 3.  Traps.
228  *
229  */
230
231 #ifndef __ASSEMBLER__
232
233 // Task state segment format (as described by the Pentium architecture book)
234 typedef struct Taskstate {
235         uint32_t ts_link;       // Old ts selector
236         uintptr_t ts_esp0;      // Stack pointers and segment selectors
237         uint16_t ts_ss0;        //   after an increase in privilege level
238         uint16_t ts_padding1;
239         uintptr_t ts_esp1;
240         uint16_t ts_ss1;
241         uint16_t ts_padding2;
242         uintptr_t ts_esp2;
243         uint16_t ts_ss2;
244         uint16_t ts_padding3;
245         physaddr_t ts_cr3;      // Page directory base
246         uintptr_t ts_eip;       // Saved state from last task switch
247         uint32_t ts_eflags;
248         uint32_t ts_eax;        // More saved state (registers)
249         uint32_t ts_ecx;
250         uint32_t ts_edx;
251         uint32_t ts_ebx;
252         uintptr_t ts_esp;
253         uintptr_t ts_ebp;
254         uint32_t ts_esi;
255         uint32_t ts_edi;
256         uint16_t ts_es;         // Even more saved state (segment selectors)
257         uint16_t ts_padding4;
258         uint16_t ts_cs;
259         uint16_t ts_padding5;
260         uint16_t ts_ss;
261         uint16_t ts_padding6;
262         uint16_t ts_ds;
263         uint16_t ts_padding7;
264         uint16_t ts_fs;
265         uint16_t ts_padding8;
266         uint16_t ts_gs;
267         uint16_t ts_padding9;
268         uint16_t ts_ldt;
269         uint16_t ts_padding10;
270         uint16_t ts_t;          // Trap on task switch
271         uint16_t ts_iomb;       // I/O map base address
272 } taskstate_t;
273
274 // Gate descriptors for interrupts and traps
275 typedef struct Gatedesc {
276         unsigned gd_off_15_0 : 16;   // low 16 bits of offset in segment
277         unsigned gd_ss : 16;         // segment selector
278         unsigned gd_args : 5;        // # args, 0 for interrupt/trap gates
279         unsigned gd_rsv1 : 3;        // reserved(should be zero I guess)
280         unsigned gd_type : 4;        // type(STS_{TG,IG32,TG32})
281         unsigned gd_s : 1;           // must be 0 (system)
282         unsigned gd_dpl : 2;         // DPL - highest ring allowed to use this
283         unsigned gd_p : 1;           // Present
284         unsigned gd_off_31_16 : 16;  // high bits of offset in segment
285 } gatedesc_t;
286
287 // Set up a normal interrupt/trap gate descriptor.
288 // - istrap: 1 for a trap (= exception) gate, 0 for an interrupt gate.
289 // - sel: Code segment selector for interrupt/trap handler
290 // - off: Offset in code segment for interrupt/trap handler
291 // - dpl: Descriptor Privilege Level -
292 //        the privilege level required for software to invoke
293 //        this interrupt/trap gate explicitly using an int instruction.
294 #define SETGATE(gate, istrap, sel, off, dpl)                    \
295 {                                                               \
296         (gate).gd_off_15_0 = (uint32_t) (off) & 0xffff;         \
297         (gate).gd_ss = (sel);                                   \
298         (gate).gd_args = 0;                                     \
299         (gate).gd_rsv1 = 0;                                     \
300         (gate).gd_type = (istrap) ? STS_TG32 : STS_IG32;        \
301         (gate).gd_s = 0;                                        \
302         (gate).gd_dpl = (dpl);                                  \
303         (gate).gd_p = 1;                                        \
304         (gate).gd_off_31_16 = (uint32_t) (off) >> 16;           \
305 }
306
307 // Set up a call gate descriptor.
308 #define SETCALLGATE(gate, ss, off, dpl)                         \
309 {                                                               \
310         (gate).gd_off_15_0 = (uint32_t) (off) & 0xffff;         \
311         (gate).gd_ss = (ss);                                    \
312         (gate).gd_args = 0;                                     \
313         (gate).gd_rsv1 = 0;                                     \
314         (gate).gd_type = STS_CG32;                              \
315         (gate).gd_s = 0;                                        \
316         (gate).gd_dpl = (dpl);                                  \
317         (gate).gd_p = 1;                                        \
318         (gate).gd_off_31_16 = (uint32_t) (off) >> 16;           \
319 }
320
321 // Pseudo-descriptors used for LGDT, LLDT and LIDT instructions.
322 typedef struct Pseudodesc {
323         uint16_t pd_lim;                // Limit
324         uint32_t pd_base;               // Base address
325 } __attribute__ ((packed)) pseudodesc_t;
326
327 #endif /* !__ASSEMBLER__ */
328
329 #endif /* !ROS_INC_MMU_H */