xref: /xv6-public/mmu.h (revision 4638cabf)
1 // This file contains definitions for the
2 // x86 memory management unit (MMU).
3 
4 // Eflags register
5 #define FL_CF           0x00000001      // Carry Flag
6 #define FL_PF           0x00000004      // Parity Flag
7 #define FL_AF           0x00000010      // Auxiliary carry Flag
8 #define FL_ZF           0x00000040      // Zero Flag
9 #define FL_SF           0x00000080      // Sign Flag
10 #define FL_TF           0x00000100      // Trap Flag
11 #define FL_IF           0x00000200      // Interrupt Enable
12 #define FL_DF           0x00000400      // Direction Flag
13 #define FL_OF           0x00000800      // Overflow Flag
14 #define FL_IOPL_MASK    0x00003000      // I/O Privilege Level bitmask
15 #define FL_IOPL_0       0x00000000      //   IOPL == 0
16 #define FL_IOPL_1       0x00001000      //   IOPL == 1
17 #define FL_IOPL_2       0x00002000      //   IOPL == 2
18 #define FL_IOPL_3       0x00003000      //   IOPL == 3
19 #define FL_NT           0x00004000      // Nested Task
20 #define FL_RF           0x00010000      // Resume Flag
21 #define FL_VM           0x00020000      // Virtual 8086 mode
22 #define FL_AC           0x00040000      // Alignment Check
23 #define FL_VIF          0x00080000      // Virtual Interrupt Flag
24 #define FL_VIP          0x00100000      // Virtual Interrupt Pending
25 #define FL_ID           0x00200000      // ID flag
26 
27 // Control Register flags
28 #define CR0_PE          0x00000001      // Protection Enable
29 #define CR0_MP          0x00000002      // Monitor coProcessor
30 #define CR0_EM          0x00000004      // Emulation
31 #define CR0_TS          0x00000008      // Task Switched
32 #define CR0_ET          0x00000010      // Extension Type
33 #define CR0_NE          0x00000020      // Numeric Errror
34 #define CR0_WP          0x00010000      // Write Protect
35 #define CR0_AM          0x00040000      // Alignment Mask
36 #define CR0_NW          0x20000000      // Not Writethrough
37 #define CR0_CD          0x40000000      // Cache Disable
38 #define CR0_PG          0x80000000      // Paging
39 
40 #define CR4_PSE         0x00000010      // Page size extension
41 
42 // various segment selectors.
43 #define SEG_KCODE 1  // kernel code
44 #define SEG_KDATA 2  // kernel data+stack
45 #define SEG_UCODE 3  // user code
46 #define SEG_UDATA 4  // user data+stack
47 #define SEG_TSS   5  // this process's task state
48 
49 // cpu->gdt[NSEGS] holds the above segments.
50 #define NSEGS     6
51 
52 #ifndef __ASSEMBLER__
53 // Segment Descriptor
54 struct segdesc {
55   uint lim_15_0 : 16;  // Low bits of segment limit
56   uint base_15_0 : 16; // Low bits of segment base address
57   uint base_23_16 : 8; // Middle bits of segment base address
58   uint type : 4;       // Segment type (see STS_ constants)
59   uint s : 1;          // 0 = system, 1 = application
60   uint dpl : 2;        // Descriptor Privilege Level
61   uint p : 1;          // Present
62   uint lim_19_16 : 4;  // High bits of segment limit
63   uint avl : 1;        // Unused (available for software use)
64   uint rsv1 : 1;       // Reserved
65   uint db : 1;         // 0 = 16-bit segment, 1 = 32-bit segment
66   uint g : 1;          // Granularity: limit scaled by 4K when set
67   uint base_31_24 : 8; // High bits of segment base address
68 };
69 
70 // Normal segment
71 #define SEG(type, base, lim, dpl) (struct segdesc)    \
72 { ((lim) >> 12) & 0xffff, (uint)(base) & 0xffff,      \
73   ((uint)(base) >> 16) & 0xff, type, 1, dpl, 1,       \
74   (uint)(lim) >> 28, 0, 0, 1, 1, (uint)(base) >> 24 }
75 #define SEG16(type, base, lim, dpl) (struct segdesc)  \
76 { (lim) & 0xffff, (uint)(base) & 0xffff,              \
77   ((uint)(base) >> 16) & 0xff, type, 1, dpl, 1,       \
78   (uint)(lim) >> 16, 0, 0, 1, 0, (uint)(base) >> 24 }
79 #endif
80 
81 #define DPL_USER    0x3     // User DPL
82 
83 // Application segment type bits
84 #define STA_X       0x8     // Executable segment
85 #define STA_E       0x4     // Expand down (non-executable segments)
86 #define STA_C       0x4     // Conforming code segment (executable only)
87 #define STA_W       0x2     // Writeable (non-executable segments)
88 #define STA_R       0x2     // Readable (executable segments)
89 #define STA_A       0x1     // Accessed
90 
91 // System segment type bits
92 #define STS_T16A    0x1     // Available 16-bit TSS
93 #define STS_LDT     0x2     // Local Descriptor Table
94 #define STS_T16B    0x3     // Busy 16-bit TSS
95 #define STS_CG16    0x4     // 16-bit Call Gate
96 #define STS_TG      0x5     // Task Gate / Coum Transmitions
97 #define STS_IG16    0x6     // 16-bit Interrupt Gate
98 #define STS_TG16    0x7     // 16-bit Trap Gate
99 #define STS_T32A    0x9     // Available 32-bit TSS
100 #define STS_T32B    0xB     // Busy 32-bit TSS
101 #define STS_CG32    0xC     // 32-bit Call Gate
102 #define STS_IG32    0xE     // 32-bit Interrupt Gate
103 #define STS_TG32    0xF     // 32-bit Trap Gate
104 
105 // A virtual address 'la' has a three-part structure as follows:
106 //
107 // +--------10------+-------10-------+---------12----------+
108 // | Page Directory |   Page Table   | Offset within Page  |
109 // |      Index     |      Index     |                     |
110 // +----------------+----------------+---------------------+
111 //  \--- PDX(va) --/ \--- PTX(va) --/
112 
113 // page directory index
114 #define PDX(va)         (((uint)(va) >> PDXSHIFT) & 0x3FF)
115 
116 // page table index
117 #define PTX(va)         (((uint)(va) >> PTXSHIFT) & 0x3FF)
118 
119 // construct virtual address from indexes and offset
120 #define PGADDR(d, t, o) ((uint)((d) << PDXSHIFT | (t) << PTXSHIFT | (o)))
121 
122 // Page directory and page table constants.
123 #define NPDENTRIES      1024    // # directory entries per page directory
124 #define NPTENTRIES      1024    // # PTEs per page table
125 #define PGSIZE          4096    // bytes mapped by a page
126 
127 #define PGSHIFT         12      // log2(PGSIZE)
128 #define PTXSHIFT        12      // offset of PTX in a linear address
129 #define PDXSHIFT        22      // offset of PDX in a linear address
130 
131 #define PGROUNDUP(sz)  (((sz)+PGSIZE-1) & ~(PGSIZE-1))
132 #define PGROUNDDOWN(a) (((a)) & ~(PGSIZE-1))
133 
134 // Page table/directory entry flags.
135 #define PTE_P           0x001   // Present
136 #define PTE_W           0x002   // Writeable
137 #define PTE_U           0x004   // User
138 #define PTE_PWT         0x008   // Write-Through
139 #define PTE_PCD         0x010   // Cache-Disable
140 #define PTE_A           0x020   // Accessed
141 #define PTE_D           0x040   // Dirty
142 #define PTE_PS          0x080   // Page Size
143 #define PTE_MBZ         0x180   // Bits must be zero
144 
145 // Address in page table or page directory entry
146 #define PTE_ADDR(pte)   ((uint)(pte) & ~0xFFF)
147 #define PTE_FLAGS(pte)  ((uint)(pte) &  0xFFF)
148 
149 #ifndef __ASSEMBLER__
150 typedef uint pte_t;
151 
152 // Task state segment format
153 struct taskstate {
154   uint link;         // Old ts selector
155   uint esp0;         // Stack pointers and segment selectors
156   ushort ss0;        //   after an increase in privilege level
157   ushort padding1;
158   uint *esp1;
159   ushort ss1;
160   ushort padding2;
161   uint *esp2;
162   ushort ss2;
163   ushort padding3;
164   void *cr3;         // Page directory base
165   uint *eip;         // Saved state from last task switch
166   uint eflags;
167   uint eax;          // More saved state (registers)
168   uint ecx;
169   uint edx;
170   uint ebx;
171   uint *esp;
172   uint *ebp;
173   uint esi;
174   uint edi;
175   ushort es;         // Even more saved state (segment selectors)
176   ushort padding4;
177   ushort cs;
178   ushort padding5;
179   ushort ss;
180   ushort padding6;
181   ushort ds;
182   ushort padding7;
183   ushort fs;
184   ushort padding8;
185   ushort gs;
186   ushort padding9;
187   ushort ldt;
188   ushort padding10;
189   ushort t;          // Trap on task switch
190   ushort iomb;       // I/O map base address
191 };
192 
193 // PAGEBREAK: 12
194 // Gate descriptors for interrupts and traps
195 struct gatedesc {
196   uint off_15_0 : 16;   // low 16 bits of offset in segment
197   uint cs : 16;         // code segment selector
198   uint args : 5;        // # args, 0 for interrupt/trap gates
199   uint rsv1 : 3;        // reserved(should be zero I guess)
200   uint type : 4;        // type(STS_{TG,IG32,TG32})
201   uint s : 1;           // must be 0 (system)
202   uint dpl : 2;         // descriptor(meaning new) privilege level
203   uint p : 1;           // Present
204   uint off_31_16 : 16;  // high bits of offset in segment
205 };
206 
207 // Set up a normal interrupt/trap gate descriptor.
208 // - istrap: 1 for a trap (= exception) gate, 0 for an interrupt gate.
209 //   interrupt gate clears FL_IF, trap gate leaves FL_IF alone
210 // - sel: Code segment selector for interrupt/trap handler
211 // - off: Offset in code segment for interrupt/trap handler
212 // - dpl: Descriptor Privilege Level -
213 //        the privilege level required for software to invoke
214 //        this interrupt/trap gate explicitly using an int instruction.
215 #define SETGATE(gate, istrap, sel, off, d)                \
216 {                                                         \
217   (gate).off_15_0 = (uint)(off) & 0xffff;                \
218   (gate).cs = (sel);                                      \
219   (gate).args = 0;                                        \
220   (gate).rsv1 = 0;                                        \
221   (gate).type = (istrap) ? STS_TG32 : STS_IG32;           \
222   (gate).s = 0;                                           \
223   (gate).dpl = (d);                                       \
224   (gate).p = 1;                                           \
225   (gate).off_31_16 = (uint)(off) >> 16;                  \
226 }
227 
228 #endif
229