VMM: Removes the epte_t from pte_t
[akaros.git] / kern / arch / x86 / pmap64.c
1 /* Copyright (c) 2013 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * 64 bit virtual memory / address space management (and a touch of pmem).
6  *
7  * TODO:
8  * - better testing: check my helper funcs, a variety of inserts/segments remove
9  * it all, etc (esp with jumbos).  check permissions and the existence of
10  * mappings.
11  * - mapping segments doesn't support having a PTE already present
12  * - mtrrs break big machines
13  * - jumbo pages are only supported at the VM layer, not PM (a jumbo is 2^9
14  * little pages, for example)
15  * - usermemwalk and freeing might need some help (in higher layers of the
16  * kernel). */
17
18 #include <arch/x86.h>
19 #include <arch/arch.h>
20 #include <arch/mmu.h>
21 #include <arch/apic.h>
22 #include <error.h>
23 #include <sys/queue.h>
24 #include <atomic.h>
25 #include <string.h>
26 #include <assert.h>
27 #include <pmap.h>
28 #include <kclock.h>
29 #include <env.h>
30 #include <stdio.h>
31 #include <kmalloc.h>
32 #include <page_alloc.h>
33
34 extern char boot_pml4[], gdt64[], gdt64desc[];
35 pgdir_t boot_pgdir;
36 physaddr_t boot_cr3;
37 segdesc_t *gdt;
38 pseudodesc_t gdt_pd;
39
40 #define PG_WALK_SHIFT_MASK              0x00ff          /* first byte = target shift */
41 #define PG_WALK_CREATE                  0x0100
42
43 kpte_t *pml_walk(kpte_t *pml, uintptr_t va, int flags);
44 void map_segment(pgdir_t pgdir, uintptr_t va, size_t size, physaddr_t pa,
45                  int perm, int pml_shift);
46 typedef int (*kpte_cb_t)(kpte_t *kpte, uintptr_t kva, int pml_shift,
47                         bool visited_subs, void *arg);
48 int pml_for_each(kpte_t *pml, uintptr_t start, size_t len, kpte_cb_t callback,
49                  void *arg);
50 int unmap_segment(pgdir_t pgdir, uintptr_t va, size_t size);
51
52 /* Helper: gets the kpte_t pointer which is the base of the PML4 from pgdir */
53 static kpte_t *pgdir_get_kpt(pgdir_t pgdir)
54 {
55         return pgdir.kpte;
56 }
57
58 /* Helper: returns true if we do not need to walk the page table any further.
59  *
60  * The caller may or may not know if a jumbo is desired.  pml_shift determines
61  * which layer we are at in the page walk, and flags contains the target level
62  * we're looking for, like a jumbo or a default.
63  *
64  * Regardless of the desired target, if we find a jumbo page, we're also done.
65  */
66 static bool walk_is_complete(kpte_t *kpte, int pml_shift, int flags)
67 {
68         if ((pml_shift == (flags & PG_WALK_SHIFT_MASK)) || (*kpte & PTE_PS))
69                 return TRUE;
70         return FALSE;
71 }
72
73 /* PTE_ADDR should only be used on a PTE that has a physical address of the next
74  * PML inside.  i.e., not a final PTE in the page table walk. */
75 static kpte_t *kpte2pml(kpte_t kpte)
76 {
77         return (kpte_t*)KADDR(PTE_ADDR(kpte));
78 }
79
80 static kpte_t *__pml_walk(kpte_t *pml, uintptr_t va, int flags, int pml_shift)
81 {
82         kpte_t *kpte;
83         epte_t *epte;
84         void *new_pml_kva;
85
86         kpte = &pml[PMLx(va, pml_shift)];
87         epte = kpte_to_epte(kpte);
88         if (walk_is_complete(kpte, pml_shift, flags))
89                 return kpte;
90         if (!(*kpte & PTE_P)) {
91                 if (!(flags & PG_WALK_CREATE))
92                         return NULL;
93                 new_pml_kva = get_cont_pages(1, KMALLOC_WAIT);
94                 memset(new_pml_kva, 0, PGSIZE * 2);
95                 /* Might want better error handling (we're probably out of memory) */
96                 if (!new_pml_kva)
97                         return NULL;
98                 /* We insert the new PT into the PML with U and W perms.  Permissions on
99                  * page table walks are anded together (if any of them are !User, the
100                  * translation is !User).  We put the perms on the last entry, not the
101                  * intermediates. */
102                 *kpte = PADDR(new_pml_kva) | PTE_P | PTE_U | PTE_W;
103                 /* The physaddr of the new_pml is one page higher than the KPT page.  A
104                  * few other things:
105                  * - for the same reason that we have U and X set on all intermediate
106                  * PTEs, we now set R, X, and W for the EPTE.
107                  * - All EPTEs have U perms
108                  * - We can't use epte_write since we're workin on intermediate PTEs,
109                  * and they don't have the memory type set. */
110                 *epte = (PADDR(new_pml_kva) + PGSIZE) | EPTE_R | EPTE_X | EPTE_W;
111         }
112         return __pml_walk(kpte2pml(*kpte), va, flags, pml_shift - BITS_PER_PML);
113 }
114
115 /* Returns a pointer to the page table entry corresponding to va.  Flags has
116  * some options and selects which level of the page table we're happy with
117  * stopping at.  Normally, this is PML1 for a normal page (e.g. flags =
118  * PML1_SHIFT), but could be for a jumbo page (PML3 or PML2 entry).
119  *
120  * Flags also controls whether or not intermediate page tables are created or
121  * not.  This is useful for when we are checking whether or not a mapping
122  * exists, but aren't interested in creating intermediate tables that will not
123  * get filled.  When we want to create intermediate pages (i.e. we're looking
124  * for the PTE to insert a page), pass in PG_WALK_CREATE with flags.
125  *
126  * Returns 0 on error or absence of a PTE for va. */
127 kpte_t *pml_walk(kpte_t *pml, uintptr_t va, int flags)
128 {
129         return __pml_walk(pml, va, flags, PML4_SHIFT);
130 }
131
132 /* Helper: determines how much va needs to be advanced until it is aligned to
133  * pml_shift. */
134 static uintptr_t amt_til_aligned(uintptr_t va, int pml_shift)
135 {
136         /* find the lower bits of va, subtract them from the shift to see what we
137          * would need to add to get to the shift.  va might be aligned already, and
138          * we subtracted 0, so we mask off the top part again. */
139         return ((1UL << pml_shift) - (va & ((1UL << pml_shift) - 1))) &
140                ((1UL << pml_shift) - 1);
141 }
142
143 /* Helper: determines how much of size we can take, in chunks of pml_shift */
144 static uintptr_t amt_of_aligned_bytes(uintptr_t size, int pml_shift)
145 {
146         /* creates a mask all 1s from MSB down to (including) shift */
147         return (~((1UL << pml_shift) - 1)) & size;
148 }
149
150 /* Helper: Advance kpte, given old_pte.  Will do pml walks when necessary. */
151 static kpte_t *get_next_pte(kpte_t *old_pte, kpte_t *pgdir, uintptr_t va,
152                             int flags)
153 {
154         /* PTEs (undereferenced) are addresses within page tables.  so long as we
155          * stay inside the PML, we can just advance via pointer arithmetic.  if we
156          * advance old_pte and it points to the beginning of a page (offset == 0),
157          * we've looped outside of our original PML, and need to get a new one. */
158         old_pte++;
159         if (!PGOFF(old_pte))
160                 return pml_walk(pgdir, va, flags);
161         return old_pte;
162 }
163
164 /* Helper: maps pages from va to pa for size bytes, all for a given page size */
165 static void map_my_pages(kpte_t *pgdir, uintptr_t va, size_t size,
166                          physaddr_t pa, int perm, int pml_shift)
167 {
168         /* set to trigger a pml walk on the first get_next */
169         kpte_t *kpte = (kpte_t*)PGSIZE - 1;
170         size_t pgsize = 1UL << pml_shift;
171
172         for (size_t i = 0; i < size; i += pgsize, va += pgsize,
173              pa += pgsize) {
174                 kpte = get_next_pte(kpte, pgdir, va, PG_WALK_CREATE | pml_shift);
175                 assert(kpte);
176                 *kpte = PTE_ADDR(pa) | perm |
177                         (pml_shift != PML1_SHIFT ? PTE_PS : 0);
178                 printd("Wrote *kpte %p, for va %p to pa %p tried to cover %p\n",
179                        *kpte, va, pa, amt_mapped);
180         }
181 }
182
183 /* Maps all pages possible from va->pa, up to size, preferring to use pages of
184  * type pml_shift (size == (1 << shift)).  Assumes that it is possible to map va
185  * to pa at the given shift. */
186 static uintptr_t __map_segment(kpte_t *pgdir, uintptr_t va, size_t size,
187                                physaddr_t pa, int perm, int pml_shift)
188 {
189         printd("__map_segment, va %p, size %p, pa %p, shift %d\n", va, size,
190                pa, pml_shift);
191         uintptr_t amt_to_submap, amt_to_map, amt_mapped = 0;
192
193         amt_to_submap = amt_til_aligned(va, pml_shift);
194         amt_to_submap = MIN(amt_to_submap, size);
195         if (amt_to_submap) {
196                 amt_mapped = __map_segment(pgdir, va, amt_to_submap, pa, perm,
197                                            pml_shift - BITS_PER_PML);
198                 va += amt_mapped;
199                 pa += amt_mapped;
200                 size -= amt_mapped;
201         }
202         /* Now we're either aligned and ready to map, or size == 0 */
203         amt_to_map = amt_of_aligned_bytes(size, pml_shift);
204         if (amt_to_map) {
205                 map_my_pages(pgdir, va, amt_to_map, pa, perm, pml_shift);
206                 va += amt_to_map;
207                 pa += amt_to_map;
208                 size -= amt_to_map;
209                 amt_mapped += amt_to_map;
210         }
211         /* Map whatever is left over */
212         if (size)
213                 amt_mapped += __map_segment(pgdir, va, size, pa, perm,
214                                             pml_shift - BITS_PER_PML);
215         return amt_mapped;
216 }
217
218 /* Returns the maximum pml shift possible between a va->pa mapping.  It is the
219  * number of least-significant bits the two addresses have in common.  For
220  * instance, if the two pages are 0x456000 and 0x156000, this returns 20.  For
221  * regular pages, it will be at least 12 (every page ends in 0x000).
222  *
223  * The max pml shift possible for an va->pa mapping is determined by the
224  * least bit that differs between va and pa.
225  *
226  * We can optimize this a bit, since we know the first 12 bits are the same, and
227  * we won't go higher than max_pml_shift. */
228 static int max_possible_shift(uintptr_t va, uintptr_t pa)
229 {
230         int shift = 0;
231         if (va == pa)
232                 return sizeof(uintptr_t) * 8;
233         while ((va & 1) == (pa & 1)) {
234                 va >>= 1;
235                 pa >>= 1;
236                 shift++;
237         }
238         return shift;
239 }
240
241 /* Map [va, va+size) of virtual (linear) address space to physical [pa, pa+size)
242  * in the page table rooted at pgdir.  Size is a multiple of PGSIZE.  Use
243  * permission bits perm for the entries.  Set pml_shift to the shift of the
244  * largest page size you're willing to use.
245  *
246  * Doesn't handle having pages currently mapped yet, and while supporting that
247  * is relatively easy, doing an insertion of small pages into an existing jumbo
248  * would be trickier.  Might have the vmem region code deal with this.
249  *
250  * Don't use this to set the PAT flag on jumbo pages in perm, unless you are
251  * absolultely sure you won't map regular pages.  */
252 void map_segment(pgdir_t pgdir, uintptr_t va, size_t size, physaddr_t pa,
253                  int perm, int pml_shift)
254 {
255         int max_shift_possible;
256         if (PGOFF(va) || PGOFF(pa) || PGOFF(size))
257                 panic("Asked to map with bad alignment.  va %p, pa %p, size %p\n", va,
258                       pa, size);
259         /* Given the max_page_size, try and use larger pages.  We'll figure out the
260          * largest possible jumbo page, up to whatever we were asked for. */
261         if (pml_shift != PGSHIFT) {
262                 max_shift_possible = max_possible_shift(va, pa);
263                 /* arch-specific limitation (can't have jumbos beyond PML3) */
264                 max_shift_possible = MIN(max_shift_possible, PML3_SHIFT);
265                 /* Assumes we were given a proper PML shift 12, 21, 30, etc */
266                 while (pml_shift > max_shift_possible)
267                         pml_shift -= BITS_PER_PML;
268         }
269         assert((pml_shift == PML1_SHIFT) ||
270                (pml_shift == PML2_SHIFT) ||
271                (pml_shift == PML3_SHIFT));
272         __map_segment(pgdir_get_kpt(pgdir), va, size, pa, perm, pml_shift);
273 }
274
275 /* For every PTE in [start, start + len), call callback(kpte, shift,
276  * etc), including the not present PTEs.  pml_shift is the shift/size of pml.
277  *
278  * This will recurse down into sub PMLs, and perform the CB in a
279  * depth-first-search.  The CB will be told which level of the paging it is at,
280  * via 'shift'.
281  *
282  * The CB will also run on intermediate PTEs: meaning, PTEs that point to page
283  * tables (and not (jumbo) pages) will be executed.  If the CB returns anything
284  * other than 0, we'll abort and propagate that back out from for_each. */
285 static int __pml_for_each(kpte_t *pml,  uintptr_t start, size_t len,
286                           kpte_cb_t callback, void *arg, int pml_shift)
287 {
288         int ret;
289         bool visited_all_subs;
290         kpte_t *kpte_s, *kpte_e, *kpte_i;
291         uintptr_t kva, pgsize = 1UL << pml_shift;
292
293         if (!len)
294                 return 0;
295         kpte_s = &pml[PMLx(start, pml_shift)];
296         /* Later, we'll loop up to and including kpte_e.  Since start + len might
297          * not be page aligned, we'll need to include the final kpte.  If it is
298          * aligned, we don't want to visit, so we subtract one so that the aligned
299          * case maps to the index below its normal kpte. */
300         kpte_e = &pml[PMLx(start + len - 1, pml_shift)];
301         /* tracks the virt addr kpte_i works on, rounded for this PML */
302         kva = ROUNDDOWN(start, pgsize);
303         printd("PFE, start %p PMLx(S) %d, end-inc %p PMLx(E) %d shift %d, kva %p\n",
304                start, PMLx(start, pml_shift), start + len - 1,
305                PMLx(start + len - 1, pml_shift), pml_shift, kva);
306         for (kpte_i = kpte_s; kpte_i <= kpte_e; kpte_i++, kva += pgsize) {
307                 visited_all_subs = FALSE;
308                 /* Complete only on the last level (PML1_SHIFT) or on a jumbo */
309                 if ((*kpte_i & PTE_P) &&
310                     (!walk_is_complete(kpte_i, pml_shift, PML1_SHIFT))) {
311                         /* only pass truncated end points (e.g. start may not be page
312                          * aligned) when we're on the first (or last) item.  For the middle
313                          * entries, we want the subpmls to process the full range they are
314                          * responsible for: [kva, kva + pgsize). */
315                         uintptr_t sub_start = MAX(kva, start);
316                         size_t sub_len = MIN(start + len, kva + pgsize) - sub_start;
317                         ret = __pml_for_each(kpte2pml(*kpte_i), sub_start, sub_len,
318                                              callback, arg, pml_shift - BITS_PER_PML);
319                         if (ret)
320                                 return ret;
321                         /* based on sub_{start,end}, we can tell if our sub visited all of
322                          * its PTES. */
323                         if ((sub_start == kva) && (sub_len == pgsize))
324                                 visited_all_subs = TRUE;
325                 }
326                 if ((ret = callback(kpte_i, kva, pml_shift, visited_all_subs, arg)))
327                         return ret;
328         }
329         return 0;
330 }
331
332 int pml_for_each(kpte_t *pml, uintptr_t start, size_t len, kpte_cb_t callback,
333                  void *arg)
334 {
335         return __pml_for_each(pml, start, len, callback, arg, PML4_SHIFT);
336 }
337
338 /* Unmaps [va, va + size) from pgdir, freeing any intermediate page tables.
339  * This does not free the actual memory pointed to by the page tables, nor does
340  * it flush the TLB. */
341 int unmap_segment(pgdir_t pgdir, uintptr_t va, size_t size)
342 {
343         int pt_free_cb(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
344                        void *data)
345         {
346                 if (!(*kpte & PTE_P))
347                         return 0;
348                 if ((shift == PML1_SHIFT) || (*kpte & PTE_PS)) {
349                         *kpte = 0;
350                         return 0;
351                 }
352                 /* If we haven't visited all of our subs, we might still have some
353                  * mappings hanging off this page table. */
354                 if (!visited_subs) {
355                         kpte_t *kpte_i = kpte2pml(*kpte);       /* first kpte == pml */
356                         /* make sure we have no PTEs in use */
357                         for (int i = 0; i < NPTENTRIES; i++, kpte_i++) {
358                                 if (*kpte_i)
359                                         return 0;
360                         }
361                 }
362                 free_cont_pages(KADDR(PTE_ADDR(*kpte)), 1);
363                 *kpte = 0;
364                 return 0;
365         }
366         /* Don't accidentally unmap the boot mappings */
367         assert((va < KERNBASE) && (va + size < KERNBASE));
368         return pml_for_each(pgdir_get_kpt(pgdir), va, size, pt_free_cb, 0);
369 }
370
371 /* Older interface for page table walks - will return the PTE corresponding to
372  * VA.  If create is 1, it'll create intermediate tables.  This can return jumbo
373  * PTEs, but only if they already exist.  Otherwise, (with create), it'll walk
374  * to the lowest PML.  If the walk fails due to a lack of intermediate tables or
375  * memory, this returns 0 (subject to change based on pte_t). */
376 pte_t pgdir_walk(pgdir_t pgdir, const void *va, int create)
377 {
378         pte_t ret;
379         int flags = PML1_SHIFT;
380         if (create == 1)
381                 flags |= PG_WALK_CREATE;
382         return pml_walk(pgdir_get_kpt(pgdir), (uintptr_t)va, flags);
383 }
384
385 static int pml_perm_walk(kpte_t *pml, const void *va, int pml_shift)
386 {
387         kpte_t *kpte;
388         int perms_here;
389
390         kpte = &pml[PMLx(va, pml_shift)];
391         if (!(*kpte & PTE_P))
392                 return 0;
393         perms_here = *kpte & PTE_PERM;
394         if (walk_is_complete(kpte, pml_shift, PML1_SHIFT))
395                 return perms_here;
396         return pml_perm_walk(kpte2pml(*kpte), va, pml_shift - BITS_PER_PML) &
397                perms_here;
398 }
399
400 /* Returns the effective permissions for PTE_U, PTE_W, and PTE_P on a given
401  * virtual address.  Note we need to consider the composition of every PTE in
402  * the page table walk (we bit-and all of them together) */
403 int get_va_perms(pgdir_t pgdir, const void *va)
404 {
405         return pml_perm_walk(pgdir_get_kpt(pgdir), va, PML4_SHIFT);
406 }
407
408 #define check_sym_va(sym, addr)                                                \
409 ({                                                                             \
410         if ((sym) != (addr))                                                       \
411                 printk("Error: " #sym " is %p, should be " #addr "\n", sym);           \
412 })
413
414 static void check_syms_va(void)
415 {
416         /* Make sure our symbols are up to date (see arch/ros/mmu64.h) */
417         check_sym_va(KERN_LOAD_ADDR, 0xffffffffc0000000);
418         check_sym_va(LAPIC_BASE,     0xffffffffbff00000);
419         check_sym_va(IOAPIC_BASE,    0xffffffffbfe00000);
420         check_sym_va(VPT_TOP,        0xffffff0000000000);
421         check_sym_va(VPT,            0xfffffe8000000000);
422         check_sym_va(KERN_VMAP_TOP,  0xfffffe8000000000);
423         check_sym_va(KERNBASE,       0xffff800000000000);
424         check_sym_va(ULIM,           0x0000800000000000);
425         check_sym_va(UVPT,           0x00007f8000000000);
426         check_sym_va(UINFO,          0x00007f7fffe00000);
427         check_sym_va(UWLIM,          0x00007f7fffe00000);
428         check_sym_va(UDATA,          0x00007f7fffc00000);
429         check_sym_va(UGDATA,         0x00007f7fffbff000);
430         check_sym_va(UMAPTOP,        0x00007f7fffbff000);
431         check_sym_va(USTACKTOP,      0x00007f7fffbff000);
432         check_sym_va(BRK_END,        0x0000400000000000);
433 }
434
435 /* Initializes anything related to virtual memory.  Paging is already on, but we
436  * have a slimmed down page table. */
437 void vm_init(void)
438 {
439         int max_jumbo_shift;
440         kpte_t *boot_kpt = KADDR(get_boot_pml4());
441
442         boot_cr3 = get_boot_pml4();
443         boot_pgdir.kpte = boot_kpt;
444         boot_pgdir.eptp = 0;
445         gdt = KADDR(get_gdt64());
446
447         /* We need to limit our mappings on machines that don't support 1GB pages */
448         max_jumbo_shift = arch_max_jumbo_page_shift();
449         check_syms_va();
450         /* KERNBASE mapping: we already have 512 GB complete (one full PML3_REACH).
451          * It's okay if we have extra, just need to make sure we reach max_paddr. */
452         if (KERNBASE + PML3_REACH < (uintptr_t)KADDR(max_paddr)) {
453                 map_segment(boot_pgdir, KERNBASE + PML3_REACH,
454                             max_paddr - PML3_REACH, 0x0 + PML3_REACH,
455                             PTE_W | PTE_G, max_jumbo_shift);
456         }
457         /* For the LAPIC and IOAPIC, we use PAT (but not *the* PAT flag) to make
458          * these type UC */
459         map_segment(boot_pgdir, LAPIC_BASE, APIC_SIZE, LAPIC_PBASE,
460                     PTE_PCD | PTE_PWT | PTE_KERN_RW | PTE_G, max_jumbo_shift);
461         map_segment(boot_pgdir, IOAPIC_BASE, APIC_SIZE, IOAPIC_PBASE,
462                     PTE_PCD | PTE_PWT | PTE_KERN_RW | PTE_G, max_jumbo_shift);
463         /* VPT mapping: recursive PTE inserted at the VPT spot */
464         boot_kpt[PML4(VPT)] = PADDR(boot_kpt) | PTE_W | PTE_P;
465         /* same for UVPT, accessible by userspace (RO). */
466         boot_kpt[PML4(UVPT)] = PADDR(boot_kpt) | PTE_U | PTE_P;
467         /* set up core0s now (mostly for debugging) */
468         setup_default_mtrrs(0);
469         /* Our current gdt_pd (gdt64desc) is pointing to a physical address for the
470          * GDT.  We need to switch over to pointing to one with a virtual address,
471          * so we can later unmap the low memory */
472         gdt_pd = (pseudodesc_t) {sizeof(segdesc_t) * SEG_COUNT - 1,
473                                  (uintptr_t)gdt};
474         asm volatile("lgdt %0" : : "m"(gdt_pd));
475 }
476
477 void x86_cleanup_bootmem(void)
478 {
479         /* the boot page tables weren't alloc'd the same as other pages, so we'll
480          * need to do some hackery to 'free' them.  This doesn't actually free
481          * anything - it just unmaps but leave 2 KPTs (4 pages) sitting around. */
482         //unmap_segment(boot_pgdir, 0, PML3_PTE_REACH); // want to do this
483         boot_pgdir.kpte[0] = 0;
484         tlbflush();
485 }
486
487 /* Walks len bytes from start, executing 'callback' on every PTE, passing it a
488  * specific VA and whatever arg is passed in.  Note, this cannot handle jumbo
489  * pages.
490  *
491  * This is just a clumsy wrapper around the more powerful pml_for_each, which
492  * can handle jumbo and intermediate pages. */
493 int env_user_mem_walk(struct proc *p, void *start, size_t len,
494                       mem_walk_callback_t callback, void *arg)
495 {
496         struct tramp_package {
497                 struct proc *p;
498                 mem_walk_callback_t cb;
499                 void *cb_arg;
500         };
501         int trampoline_cb(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
502                           void *data)
503         {
504                 struct tramp_package *tp = (struct tramp_package*)data;
505                 assert(tp->cb);
506                 /* memwalk CBs don't know how to handle intermediates or jumbos */
507                 if (shift != PML1_SHIFT)
508                         return 0;
509                 return tp->cb(tp->p, kpte, (void*)kva, tp->cb_arg);
510         }
511
512         int ret;
513         struct tramp_package local_tp;
514         local_tp.p = p;
515         local_tp.cb = callback;
516         local_tp.cb_arg = arg;
517         /* Walking both in parallel and making a joint PTE is a pain.  instead, we
518          * walk one at a time, each with only a half_pte.  Most all of the pmap_ops
519          * need to deal with a getting half PTE.  Ideally, we'd combine the two
520          * walks and then know that we always have a kpte. */
521         ret = pml_for_each(pgdir_get_kpt(p->env_pgdir), (uintptr_t)start, len,
522                            trampoline_cb, &local_tp);
523         /* TODO: walk the EPT, combine with ret */
524         return ret;
525 }
526
527 /* Frees (decrefs) all pages of the process's page table, including the page
528  * directory.  Does not free the memory that is actually mapped. */
529 void env_pagetable_free(struct proc *p)
530 {
531         /* callback: given an intermediate kpte (not a final one), removes the page
532          * table the PTE points to */
533         int pt_free_cb(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
534                        void *data)
535         {
536                 if (!(*kpte & PTE_P))
537                         return 0;
538                 if ((shift == PML1_SHIFT) || (*kpte & PTE_PS))
539                         return 0;
540                 free_cont_pages(KADDR(PTE_ADDR(*kpte)), 1);
541                 return 0;
542         }
543                 
544         assert(p->env_cr3 != rcr3());
545         pml_for_each(pgdir_get_kpt(p->env_pgdir), 0, UVPT, pt_free_cb, 0);
546         /* the page directory is not a PTE, so it never was freed */
547         free_cont_pages(pgdir_get_kpt(p->env_pgdir), 1);
548         tlbflush();
549 }
550
551 /* Remove the inner page tables along va's walk.  The internals are more
552  * powerful.  We'll eventually want better arch-indep VM functions. */
553 error_t pagetable_remove(pgdir_t pgdir, void *va)
554 {
555         return unmap_segment(pgdir, (uintptr_t)va, PGSIZE);
556 }
557
558 void page_check(void)
559 {
560 }
561
562 /* Sets up the page directory, based on boot_copy.
563  *
564  * For x86, to support VMs, all processes will have an EPT and a KPT.  Ideally,
565  * we'd use the same actual PT for both, but we can't thanks to the EPT design.
566  * Although they are not the same actual PT, they have the same contents.
567  *
568  * The KPT-EPT invariant is that the KPT and EPT hold the same mappings from
569  * [0,UVPT), so long as some lock is held.  Right now, the lock is the pte_lock,
570  * but it could be a finer-grained lock (e.g. on lower level PTs) in the future.
571  *
572  * Part of the reason for the invariant is so that a pgdir walk on the process's
573  * address space will get the 'same' PTE for both the KPT and the EPT.  For
574  * instance, if a page is present in the KPT, a pte is present and points to the
575  * same physical page in the EPT.  Likewise, both the KPT and EPT agree on jumbo
576  * mappings.
577  *
578  * I went with UVPT for the upper limit of equality btw the KPT and EPT for a
579  * couple reasons: I wanted something static (technically the physaddr width is
580  * runtime dependent), and we'll never actually PF high enough for it to make a
581  * difference.  Plus, the UVPT is something that would need to be changed for
582  * the EPT too, if we supported it at all.
583  *
584  * Each page table page is actually two contiguous pages.  The lower is the KPT.
585  * The upper is the EPT.  Order-1 page allocs are a little harder, but the
586  * tradeoff is simplicity in all of the pm code.  Given a KPTE, we can find an
587  * EPTE with no hassle.  Note that this two-page business is a tax on *all*
588  * processes, which is less than awesome.
589  *
590  * Another note is that the boot page tables are *not* double-pages.  The EPT
591  * won't cover those spaces (e.g. kernbase mapping), so it's not necessary, and
592  * it's a pain in the ass to get it to work (can't align to 2*PGSIZE without
593  * grub complaining, and we might run into issues with freeing memory in the
594  * data segment). */
595 int arch_pgdir_setup(pgdir_t boot_copy, pgdir_t *new_pd)
596 {
597         kpte_t *kpt = get_cont_pages(1, KMALLOC_WAIT);
598         memcpy(kpt, boot_copy.kpte, PGSIZE);
599         epte_t *ept = kpte_to_epte(kpt);
600         memset(ept, 0, PGSIZE);
601
602         /* VPT and UVPT map the proc's page table, with different permissions. */
603         kpt[PML4(VPT)]  = PTE(LA2PPN(PADDR(kpt)), PTE_KERN_RW);
604         kpt[PML4(UVPT)] = PTE(LA2PPN(PADDR(kpt)), PTE_USER_RO);
605
606         new_pd->kpte = kpt;
607         new_pd->eptp = construct_eptp(PADDR(ept));
608         return 0;
609 }
610
611 physaddr_t arch_pgdir_get_cr3(pgdir_t pd)
612 {
613         return PADDR(pd.kpte);
614 }
615
616 void arch_pgdir_clear(pgdir_t *pd)
617 {
618         pd->kpte = 0;
619         pd->eptp = 0;
620 }
621
622 /* Returns the page shift of the largest jumbo supported */
623 int arch_max_jumbo_page_shift(void)
624 {
625         uint32_t edx;
626         cpuid(0x80000001, 0x0, 0, 0, 0, &edx);
627         return edx & (1 << 26) ? PML3_SHIFT : PML2_SHIFT;
628 }
629
630 /* Debugging */
631 static int print_pte(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
632                      void *data)
633 {
634         if (kpte_is_unmapped(kpte))
635                 return 0;
636         switch (shift) {
637                 case (PML1_SHIFT):
638                         printk("\t");
639                         /* fall-through */
640                 case (PML2_SHIFT):
641                         printk("\t");
642                         /* fall-through */
643                 case (PML3_SHIFT):
644                         printk("\t");
645         }
646         printk("KVA: %p, PTE val %p, shift %d, visit %d%s\n", kva, *kpte, shift,
647                visited_subs, (*kpte & PTE_PS ? " (jumbo)" : ""));
648         return 0;
649 }
650
651 void debug_print_pgdir(kpte_t *pgdir)
652 {
653         if (! pgdir)
654                 pgdir = KADDR(rcr3());
655         printk("Printing the entire page table set for %p, DFS\n", pgdir);
656         /* Need to be careful we avoid VPT/UVPT, o/w we'll recurse */
657         pml_for_each(pgdir, 0, UVPT, print_pte, 0);
658         if (arch_max_jumbo_page_shift() < PML3_SHIFT)
659                 printk("(skipping kernbase mapping - too many entries)\n");
660         else
661                 pml_for_each(pgdir, KERNBASE, VPT - KERNBASE, print_pte, 0);
662         pml_for_each(pgdir, VPT_TOP, MAX_VADDR - VPT_TOP, print_pte, 0);
663 }