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