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