x86: Update the check for BRK_END
[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 <env.h>
29 #include <stdio.h>
30 #include <kmalloc.h>
31 #include <page_alloc.h>
32 #include <umem.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 typedef int (*kpte_cb_t)(kpte_t *kpte, uintptr_t kva, int pml_shift,
45                         bool visited_subs, void *arg);
46 int pml_for_each(kpte_t *pml, uintptr_t start, size_t len, kpte_cb_t callback,
47                  void *arg);
48 /* Helpers for PML for-each walks */
49 static inline bool pte_is_final(pte_t pte, int pml_shift)
50 {
51         return (pml_shift == PML1_SHIFT) || pte_is_jumbo(pte);
52 }
53
54 static inline bool pte_is_intermediate(pte_t pte, int pml_shift)
55 {
56         return !pte_is_final(pte, pml_shift);
57 }
58
59 /* Helper: gets the kpte_t pointer which is the base of the PML4 from pgdir */
60 static kpte_t *pgdir_get_kpt(pgdir_t pgdir)
61 {
62         return pgdir.kpte;
63 }
64
65 /* Helper: returns true if we do not need to walk the page table any further.
66  *
67  * The caller may or may not know if a jumbo is desired.  pml_shift determines
68  * which layer we are at in the page walk, and flags contains the target level
69  * we're looking for, like a jumbo or a default.
70  *
71  * Regardless of the desired target, if we find a jumbo page, we're also done.
72  */
73 static bool walk_is_complete(kpte_t *kpte, int pml_shift, int flags)
74 {
75         if ((pml_shift == (flags & PG_WALK_SHIFT_MASK)) || (*kpte & PTE_PS))
76                 return TRUE;
77         return FALSE;
78 }
79
80 /* PTE_ADDR should only be used on a PTE that has a physical address of the next
81  * PML inside.  i.e., not a final PTE in the page table walk. */
82 static kpte_t *kpte2pml(kpte_t kpte)
83 {
84         return (kpte_t*)KADDR(PTE_ADDR(kpte));
85 }
86
87 static kpte_t *__pml_walk(kpte_t *pml, uintptr_t va, int flags, int pml_shift)
88 {
89         kpte_t *kpte;
90         epte_t *epte;
91         void *new_pml_kva;
92
93         kpte = &pml[PMLx(va, pml_shift)];
94         epte = kpte_to_epte(kpte);
95         if (walk_is_complete(kpte, pml_shift, flags))
96                 return kpte;
97         if (!kpte_is_present(kpte)) {
98                 if (!(flags & PG_WALK_CREATE))
99                         return NULL;
100                 new_pml_kva = kpages_alloc(2 * PGSIZE, MEM_WAIT);
101                 memset(new_pml_kva, 0, PGSIZE * 2);
102                 /* Might want better error handling (we're probably out of memory) */
103                 if (!new_pml_kva)
104                         return NULL;
105                 /* We insert the new PT into the PML with U and W perms.  Permissions on
106                  * page table walks are anded together (if any of them are !User, the
107                  * translation is !User).  We put the perms on the last entry, not the
108                  * intermediates. */
109                 *kpte = PADDR(new_pml_kva) | PTE_P | PTE_U | PTE_W;
110                 /* For a dose of paranoia, we'll avoid mapping intermediate eptes when
111                  * we know we're using an address that should never be ept-accesible. */
112                 if (va < ULIM) {
113                         /* The physaddr of the new_pml is one page higher than the KPT page.
114                          * A few other things:
115                          * - for the same reason that we have U and X set on all
116                          *   intermediate PTEs, we now set R, X, and W for the EPTE.
117                          * - All EPTEs have U perms
118                          * - We can't use epte_write since we're workin on intermediate
119                          *   PTEs, and they don't have the memory type set. */
120                         *epte = (PADDR(new_pml_kva) + PGSIZE) | EPTE_R | EPTE_X | EPTE_W;
121                 }
122         }
123         return __pml_walk(kpte2pml(*kpte), va, flags, pml_shift - BITS_PER_PML);
124 }
125
126 /* Returns a pointer to the page table entry corresponding to va.  Flags has
127  * some options and selects which level of the page table we're happy with
128  * stopping at.  Normally, this is PML1 for a normal page (e.g. flags =
129  * PML1_SHIFT), but could be for a jumbo page (PML3 or PML2 entry).
130  *
131  * Flags also controls whether or not intermediate page tables are created or
132  * not.  This is useful for when we are checking whether or not a mapping
133  * exists, but aren't interested in creating intermediate tables that will not
134  * get filled.  When we want to create intermediate pages (i.e. we're looking
135  * for the PTE to insert a page), pass in PG_WALK_CREATE with flags.
136  *
137  * Returns 0 on error or absence of a PTE for va. */
138 kpte_t *pml_walk(kpte_t *pml, uintptr_t va, int flags)
139 {
140         return __pml_walk(pml, va, flags, PML4_SHIFT);
141 }
142
143 /* Helper: determines how much va needs to be advanced until it is aligned to
144  * pml_shift. */
145 static uintptr_t amt_til_aligned(uintptr_t va, int pml_shift)
146 {
147         /* find the lower bits of va, subtract them from the shift to see what we
148          * would need to add to get to the shift.  va might be aligned already, and
149          * we subtracted 0, so we mask off the top part again. */
150         return ((1UL << pml_shift) - (va & ((1UL << pml_shift) - 1))) &
151                ((1UL << pml_shift) - 1);
152 }
153
154 /* Helper: determines how much of size we can take, in chunks of pml_shift */
155 static uintptr_t amt_of_aligned_bytes(uintptr_t size, int pml_shift)
156 {
157         /* creates a mask all 1s from MSB down to (including) shift */
158         return (~((1UL << pml_shift) - 1)) & size;
159 }
160
161 /* Helper: Advance kpte, given old_pte.  Will do pml walks when necessary. */
162 static kpte_t *get_next_pte(kpte_t *old_pte, kpte_t *pgdir, uintptr_t va,
163                             int flags)
164 {
165         /* PTEs (undereferenced) are addresses within page tables.  so long as we
166          * stay inside the PML, we can just advance via pointer arithmetic.  if we
167          * advance old_pte and it points to the beginning of a page (offset == 0),
168          * we've looped outside of our original PML, and need to get a new one. */
169         old_pte++;
170         if (!PGOFF(old_pte))
171                 return pml_walk(pgdir, va, flags);
172         return old_pte;
173 }
174
175 /* Helper: maps pages from va to pa for size bytes, all for a given page size */
176 static void map_my_pages(kpte_t *pgdir, uintptr_t va, size_t size,
177                          physaddr_t pa, int perm, int pml_shift)
178 {
179         /* set to trigger a pml walk on the first get_next */
180         kpte_t *kpte = (kpte_t*)PGSIZE - 1;
181         size_t pgsize = 1UL << pml_shift;
182
183         for (size_t i = 0; i < size; i += pgsize, va += pgsize,
184              pa += pgsize) {
185                 kpte = get_next_pte(kpte, pgdir, va, PG_WALK_CREATE | pml_shift);
186                 assert(kpte);
187                 pte_write(kpte, pa, perm | (pml_shift != PML1_SHIFT ? PTE_PS : 0));
188                 printd("Wrote *kpte %p, for va %p to pa %p tried to cover %p\n",
189                        *kpte, va, pa, amt_mapped);
190         }
191 }
192
193 /* Maps all pages possible from va->pa, up to size, preferring to use pages of
194  * type pml_shift (size == (1 << shift)).  Assumes that it is possible to map va
195  * to pa at the given shift. */
196 static uintptr_t __map_segment(kpte_t *pgdir, uintptr_t va, size_t size,
197                                physaddr_t pa, int perm, int pml_shift)
198 {
199         printd("__map_segment, va %p, size %p, pa %p, shift %d\n", va, size,
200                pa, pml_shift);
201         uintptr_t amt_to_submap, amt_to_map, amt_mapped = 0;
202
203         amt_to_submap = amt_til_aligned(va, pml_shift);
204         amt_to_submap = MIN(amt_to_submap, size);
205         if (amt_to_submap) {
206                 amt_mapped = __map_segment(pgdir, va, amt_to_submap, pa, perm,
207                                            pml_shift - BITS_PER_PML);
208                 va += amt_mapped;
209                 pa += amt_mapped;
210                 size -= amt_mapped;
211         }
212         /* Now we're either aligned and ready to map, or size == 0 */
213         amt_to_map = amt_of_aligned_bytes(size, pml_shift);
214         if (amt_to_map) {
215                 map_my_pages(pgdir, va, amt_to_map, pa, perm, pml_shift);
216                 va += amt_to_map;
217                 pa += amt_to_map;
218                 size -= amt_to_map;
219                 amt_mapped += amt_to_map;
220         }
221         /* Map whatever is left over */
222         if (size)
223                 amt_mapped += __map_segment(pgdir, va, size, pa, perm,
224                                             pml_shift - BITS_PER_PML);
225         return amt_mapped;
226 }
227
228 /* Returns the maximum pml shift possible between a va->pa mapping.  It is the
229  * number of least-significant bits the two addresses have in common.  For
230  * instance, if the two pages are 0x456000 and 0x156000, this returns 20.  For
231  * regular pages, it will be at least 12 (every page ends in 0x000).
232  *
233  * The max pml shift possible for an va->pa mapping is determined by the
234  * least bit that differs between va and pa.
235  *
236  * We can optimize this a bit, since we know the first 12 bits are the same, and
237  * we won't go higher than max_pml_shift. */
238 static int max_possible_shift(uintptr_t va, uintptr_t pa)
239 {
240         int shift = 0;
241         if (va == pa)
242                 return sizeof(uintptr_t) * 8;
243         while ((va & 1) == (pa & 1)) {
244                 va >>= 1;
245                 pa >>= 1;
246                 shift++;
247         }
248         return shift;
249 }
250
251 /* Map [va, va+size) of virtual (linear) address space to physical [pa, pa+size)
252  * in the page table rooted at pgdir.  Size is a multiple of PGSIZE.  Use
253  * permission bits perm for the entries.  Set pml_shift to the shift of the
254  * largest page size you're willing to use.
255  *
256  * Doesn't handle having pages currently mapped yet, and while supporting that
257  * is relatively easy, doing an insertion of small pages into an existing jumbo
258  * would be trickier.  Might have the vmem region code deal with this.
259  *
260  * Don't use this to set the PAT flag on jumbo pages in perm, unless you are
261  * absolultely sure you won't map regular pages.  */
262 void map_segment(pgdir_t pgdir, uintptr_t va, size_t size, physaddr_t pa,
263                  int perm, int pml_shift)
264 {
265         int max_shift_possible;
266         if (PGOFF(va) || PGOFF(pa) || PGOFF(size))
267                 panic("Asked to map with bad alignment.  va %p, pa %p, size %p\n", va,
268                       pa, size);
269         /* Given the max_page_size, try and use larger pages.  We'll figure out the
270          * largest possible jumbo page, up to whatever we were asked for. */
271         if (pml_shift != PGSHIFT) {
272                 max_shift_possible = max_possible_shift(va, pa);
273                 max_shift_possible = MIN(max_shift_possible,
274                                          arch_max_jumbo_page_shift());
275                 /* Assumes we were given a proper PML shift 12, 21, 30, etc */
276                 while (pml_shift > max_shift_possible)
277                         pml_shift -= BITS_PER_PML;
278         }
279         assert((pml_shift == PML1_SHIFT) ||
280                (pml_shift == PML2_SHIFT) ||
281                (pml_shift == PML3_SHIFT));
282         __map_segment(pgdir_get_kpt(pgdir), va, size, pa, perm, pml_shift);
283 }
284
285 /* For every PTE in [start, start + len), call callback(kpte, shift,
286  * etc), including the not present PTEs.  pml_shift is the shift/size of pml.
287  *
288  * This will recurse down into sub PMLs, and perform the CB in a
289  * depth-first-search.  The CB will be told which level of the paging it is at,
290  * via 'shift'.
291  *
292  * The CB will also run on intermediate PTEs: meaning, PTEs that point to page
293  * tables (and not (jumbo) pages) will be executed.  If the CB returns anything
294  * other than 0, we'll abort and propagate that back out from for_each. */
295 static int __pml_for_each(kpte_t *pml,  uintptr_t start, size_t len,
296                           kpte_cb_t callback, void *arg, int pml_shift)
297 {
298         int ret;
299         bool visited_all_subs;
300         kpte_t *kpte_s, *kpte_e, *kpte_i;
301         uintptr_t kva, pgsize = 1UL << pml_shift;
302
303         if (!len)
304                 return 0;
305         kpte_s = &pml[PMLx(start, pml_shift)];
306         /* Later, we'll loop up to and including kpte_e.  Since start + len might
307          * not be page aligned, we'll need to include the final kpte.  If it is
308          * aligned, we don't want to visit, so we subtract one so that the aligned
309          * case maps to the index below its normal kpte. */
310         kpte_e = &pml[PMLx(start + len - 1, pml_shift)];
311         /* tracks the virt addr kpte_i works on, rounded for this PML */
312         kva = ROUNDDOWN(start, pgsize);
313         printd("PFE, start %p PMLx(S) %d, end-inc %p PMLx(E) %d shift %d, kva %p\n",
314                start, PMLx(start, pml_shift), start + len - 1,
315                PMLx(start + len - 1, pml_shift), pml_shift, kva);
316         for (kpte_i = kpte_s; kpte_i <= kpte_e; kpte_i++, kva += pgsize) {
317                 visited_all_subs = FALSE;
318                 /* Complete only on the last level (PML1_SHIFT) or on a jumbo */
319                 if (kpte_is_present(kpte_i) &&
320                     (!walk_is_complete(kpte_i, pml_shift, PML1_SHIFT))) {
321                         /* only pass truncated end points (e.g. start may not be page
322                          * aligned) when we're on the first (or last) item.  For the middle
323                          * entries, we want the subpmls to process the full range they are
324                          * responsible for: [kva, kva + pgsize). */
325                         uintptr_t sub_start = MAX(kva, start);
326                         size_t sub_len = MIN(start + len - sub_start,
327                                              kva + pgsize - sub_start);
328
329                         ret = __pml_for_each(kpte2pml(*kpte_i), sub_start, sub_len,
330                                              callback, arg, pml_shift - BITS_PER_PML);
331                         if (ret)
332                                 return ret;
333                         /* based on sub_{start,end}, we can tell if our sub visited all of
334                          * its PTES. */
335                         if ((sub_start == kva) && (sub_len == pgsize))
336                                 visited_all_subs = TRUE;
337                 }
338                 if ((ret = callback(kpte_i, kva, pml_shift, visited_all_subs, arg)))
339                         return ret;
340         }
341         return 0;
342 }
343
344 int pml_for_each(kpte_t *pml, uintptr_t start, size_t len, kpte_cb_t callback,
345                  void *arg)
346 {
347         return __pml_for_each(pml, start, len, callback, arg, PML4_SHIFT);
348 }
349
350 /* Unmaps [va, va + size) from pgdir, freeing any intermediate page tables for
351  * non-kernel mappings.  This does not free the actual memory pointed to by the
352  * page tables, nor does it flush the TLB. */
353 int unmap_segment(pgdir_t pgdir, uintptr_t va, size_t size)
354 {
355         int pt_free_cb(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
356                        void *data)
357         {
358                 if (!kpte_is_present(kpte))
359                         return 0;
360                 if (pte_is_final(kpte, shift)) {
361                         pte_clear(kpte);
362                         return 0;
363                 }
364                 /* Never remove intermediate pages for any kernel mappings.  This is
365                  * also important for x86 so that we don't accidentally free any of the
366                  * boot PMLs, which aren't two-page alloc'd from kpages_arena. */
367                 if (kva >= ULIM)
368                         return 0;
369                 /* If we haven't visited all of our subs, we might still have some
370                  * mappings hanging off this page table. */
371                 if (!visited_subs) {
372                         kpte_t *kpte_i = kpte2pml(*kpte);       /* first kpte == pml */
373                         /* make sure we have no PTEs in use */
374                         for (int i = 0; i < NPTENTRIES; i++, kpte_i++) {
375                                 if (*kpte_i)
376                                         return 0;
377                         }
378                 }
379                 kpages_free(KADDR(PTE_ADDR(*kpte)), 2 * PGSIZE);
380                 pte_clear(kpte);
381                 return 0;
382         }
383         return pml_for_each(pgdir_get_kpt(pgdir), va, size, pt_free_cb, 0);
384 }
385
386 /* Older interface for page table walks - will return the PTE corresponding to
387  * VA.  If create is 1, it'll create intermediate tables.  This can return jumbo
388  * PTEs, but only if they already exist.  Otherwise, (with create), it'll walk
389  * to the lowest PML.  If the walk fails due to a lack of intermediate tables or
390  * memory, this returns 0 (subject to change based on pte_t). */
391 pte_t pgdir_walk(pgdir_t pgdir, const void *va, int create)
392 {
393         pte_t ret;
394         int flags = PML1_SHIFT;
395         if (create == 1)
396                 flags |= PG_WALK_CREATE;
397         return pml_walk(pgdir_get_kpt(pgdir), (uintptr_t)va, flags);
398 }
399
400 static int pml_perm_walk(kpte_t *pml, const void *va, int pml_shift)
401 {
402         kpte_t *kpte;
403         int perms_here;
404
405         kpte = &pml[PMLx(va, pml_shift)];
406         if (!kpte_is_present(kpte))
407                 return 0;
408         perms_here = *kpte & PTE_PERM;
409         if (walk_is_complete(kpte, pml_shift, PML1_SHIFT))
410                 return perms_here;
411         return pml_perm_walk(kpte2pml(*kpte), va, pml_shift - BITS_PER_PML) &
412                perms_here;
413 }
414
415 /* Returns the effective permissions for PTE_U, PTE_W, and PTE_P on a given
416  * virtual address.  Note we need to consider the composition of every PTE in
417  * the page table walk (we bit-and all of them together) */
418 int get_va_perms(pgdir_t pgdir, const void *va)
419 {
420         return pml_perm_walk(pgdir_get_kpt(pgdir), va, PML4_SHIFT);
421 }
422
423 #define check_sym_va(sym, addr)                                                \
424 ({                                                                             \
425         if ((sym) != (addr))                                                       \
426                 panic("Error: " #sym " is %p, should be " #addr, sym);                 \
427 })
428
429 static void check_syms_va(void)
430 {
431         /* Make sure our symbols are up to date (see arch/ros/mmu64.h) */
432         check_sym_va(KERN_LOAD_ADDR, 0xffffffffc0000000);
433         check_sym_va(IOAPIC_BASE,    0xffffffffbff00000);
434         check_sym_va(VPT_TOP,        0xffffff0000000000);
435         check_sym_va(VPT,            0xfffffe8000000000);
436         check_sym_va(KERN_VMAP_TOP,  0xfffffe8000000000);
437         check_sym_va(KERNBASE,       0xffff800000000000);
438         check_sym_va(ULIM,           0x0000800000000000);
439         check_sym_va(UVPT,           0x00007f8000000000);
440         check_sym_va(UGINFO,         0x00007f7fffe00000);
441         check_sym_va(UINFO,          0x00007f7fffc00000);
442         check_sym_va(UWLIM,          0x00007f7fffc00000);
443         check_sym_va(UDATA,          0x00007f7fffa00000);
444         check_sym_va(UGDATA,         0x00007f7fff9ff000);
445         check_sym_va(UMAPTOP,        0x00007f7fff9ff000);
446         check_sym_va(USTACKTOP,      0x00007f7fff9ff000);
447         check_sym_va(BRK_END,        0x0000300000000000);
448 }
449
450 /* Initializes anything related to virtual memory.  Paging is already on, but we
451  * have a slimmed down page table. */
452 void vm_init(void)
453 {
454         int max_jumbo_shift;
455         kpte_t *boot_kpt = KADDR(get_boot_pml4());
456
457         boot_cr3 = get_boot_pml4();
458         boot_pgdir.kpte = boot_kpt;
459         boot_pgdir.eptp = 0;
460         gdt = KADDR(get_gdt64());
461
462         /* We need to limit our mappings on machines that don't support 1GB pages */
463         max_jumbo_shift = arch_max_jumbo_page_shift();
464         check_syms_va();
465         /* KERNBASE mapping: we already have 512 GB complete (one full PML3_REACH).
466          * It's okay if we have extra, just need to make sure we reach max_paddr. */
467         if (KERNBASE + PML3_REACH < (uintptr_t)KADDR(max_paddr)) {
468                 map_segment(boot_pgdir, KERNBASE + PML3_REACH,
469                             max_paddr - PML3_REACH, 0x0 + PML3_REACH,
470                             PTE_KERN_RW | PTE_G, max_jumbo_shift);
471         }
472         /* For the LAPIC and IOAPIC, we use PAT (but not *the* PAT flag) to make
473          * these type UC */
474         map_segment(boot_pgdir, IOAPIC_BASE, APIC_SIZE, IOAPIC_PBASE,
475                     PTE_NOCACHE | PTE_KERN_RW | PTE_G, max_jumbo_shift);
476         /* VPT mapping: recursive PTE inserted at the VPT spot */
477         boot_kpt[PML4(VPT)] = PADDR(boot_kpt) | PTE_KERN_RW;
478         /* same for UVPT, accessible by userspace (RO). */
479         boot_kpt[PML4(UVPT)] = PADDR(boot_kpt) | PTE_USER_RO;
480         /* set up core0s now (mostly for debugging) */
481         setup_default_mtrrs(0);
482         /* Our current gdt_pd (gdt64desc) is pointing to a physical address for the
483          * GDT.  We need to switch over to pointing to one with a virtual address,
484          * so we can later unmap the low memory */
485         gdt_pd = (pseudodesc_t) {sizeof(segdesc_t) * SEG_COUNT - 1,
486                                  (uintptr_t)gdt};
487         asm volatile("lgdt %0" : : "m"(gdt_pd));
488 }
489
490 void x86_cleanup_bootmem(void)
491 {
492         /* the boot page tables weren't alloc'd the same as other pages, so we'll
493          * need to do some hackery to 'free' them.  This doesn't actually free
494          * anything - it just unmaps but leave 2 KPTs (4 pages) sitting around. */
495         //unmap_segment(boot_pgdir, 0, PML3_PTE_REACH); // want to do this
496         boot_pgdir.kpte[0] = 0;
497         tlb_flush_global();
498 }
499
500 /* Walks len bytes from start, executing 'callback' on every PTE, passing it a
501  * specific VA and whatever arg is passed in.  Note, this cannot handle jumbo
502  * pages.
503  *
504  * This is just a clumsy wrapper around the more powerful pml_for_each, which
505  * can handle jumbo and intermediate pages. */
506 int env_user_mem_walk(struct proc *p, void *start, size_t len,
507                       mem_walk_callback_t callback, void *arg)
508 {
509         struct tramp_package {
510                 struct proc *p;
511                 mem_walk_callback_t cb;
512                 void *cb_arg;
513         };
514         int trampoline_cb(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
515                           void *data)
516         {
517                 struct tramp_package *tp = (struct tramp_package*)data;
518                 assert(tp->cb);
519                 /* memwalk CBs don't know how to handle intermediates or jumbos */
520                 if (shift != PML1_SHIFT)
521                         return 0;
522                 return tp->cb(tp->p, kpte, (void*)kva, tp->cb_arg);
523         }
524
525         struct tramp_package local_tp;
526         local_tp.p = p;
527         local_tp.cb = callback;
528         local_tp.cb_arg = arg;
529         return pml_for_each(pgdir_get_kpt(p->env_pgdir), (uintptr_t)start, len,
530                            trampoline_cb, &local_tp);
531 }
532
533 /* Frees (decrefs) all pages of the process's page table, including the page
534  * directory.  Does not free the memory that is actually mapped. */
535 void env_pagetable_free(struct proc *p)
536 {
537         unmap_segment(p->env_pgdir, 0, UVPT - 0);
538         /* the page directory is not a PTE, so it never was freed */
539         kpages_free(pgdir_get_kpt(p->env_pgdir), 2 * PGSIZE);
540         tlbflush();
541 }
542
543 /* Remove the inner page tables along va's walk.  The internals are more
544  * powerful.  We'll eventually want better arch-indep VM functions. */
545 error_t pagetable_remove(pgdir_t pgdir, void *va)
546 {
547         return unmap_segment(pgdir, (uintptr_t)va, PGSIZE);
548 }
549
550 void page_check(void)
551 {
552 }
553
554 /* Similar to the kernels page table walk, but walks the guest page tables for a
555  * guest_va.  Takes a proc and user virtual (guest physical) address for the
556  * PML, returning the actual PTE (copied out of userspace). */
557 static kpte_t __guest_pml_walk(struct proc *p, kpte_t *u_pml, uintptr_t gva,
558                                int flags, int pml_shift)
559 {
560         kpte_t pte;
561
562         if (memcpy_from_user(p, &pte, &u_pml[PMLx(gva, pml_shift)],
563                              sizeof(kpte_t))) {
564                 printk("Buggy pml %p, tried %p\n", u_pml, &u_pml[PMLx(gva, pml_shift)]);
565                 return 0;
566         }
567         if (walk_is_complete(&pte, pml_shift, flags))
568                 return pte;
569         if (!kpte_is_present(&pte))
570                 return 0;
571         return __guest_pml_walk(p, (kpte_t*)PTE_ADDR(pte), gva, flags,
572                                 pml_shift - BITS_PER_PML);
573 }
574
575 uintptr_t gva2gpa(struct proc *p, uintptr_t cr3, uintptr_t gva)
576 {
577         kpte_t pte;
578         int shift = PML1_SHIFT;
579
580         pte = __guest_pml_walk(p, (kpte_t*)cr3, gva, shift, PML4_SHIFT);
581         if (!pte)
582                 return 0;
583         /* TODO: Jumbos mess with us.  We need to know the shift the walk did.  This
584          * is a little nasty, but will work til we make Akaros more jumbo-aware. */
585         while (pte & PTE_PS) {
586                 shift += BITS_PER_PML;
587                 pte = __guest_pml_walk(p, (kpte_t*)cr3, gva, shift, PML4_SHIFT);
588                 if (!pte)
589                         return 0;
590         }
591         return (pte & ~((1 << shift) - 1)) | (gva & ((1 << shift) - 1));
592 }
593
594 /* Sets up the page directory, based on boot_copy.
595  *
596  * For x86, to support VMs, all processes will have an EPT and a KPT.  Ideally,
597  * we'd use the same actual PT for both, but we can't thanks to the EPT design.
598  * Although they are not the same actual PT, they have the same contents.
599  *
600  * The KPT-EPT invariant is that the KPT and EPT hold the same mappings from
601  * [0,UVPT), so long as some lock is held.  Right now, the lock is the pte_lock,
602  * but it could be a finer-grained lock (e.g. on lower level PTs) in the future.
603  *
604  * Part of the reason for the invariant is so that a pgdir walk on the process's
605  * address space will get the 'same' PTE for both the KPT and the EPT.  For
606  * instance, if a page is present in the KPT, a pte is present and points to the
607  * same physical page in the EPT.  Likewise, both the KPT and EPT agree on jumbo
608  * mappings.
609  *
610  * I went with UVPT for the upper limit of equality btw the KPT and EPT for a
611  * couple reasons: I wanted something static (technically the physaddr width is
612  * runtime dependent), and we'll never actually PF high enough for it to make a
613  * difference.  Plus, the UVPT is something that would need to be changed for
614  * the EPT too, if we supported it at all.
615  *
616  * Each page table page is actually two contiguous pages.  The lower is the KPT.
617  * The upper is the EPT.  Order-1 page allocs are a little harder, but the
618  * tradeoff is simplicity in all of the pm code.  Given a KPTE, we can find an
619  * EPTE with no hassle.  Note that this two-page business is a tax on *all*
620  * processes, which is less than awesome.
621  *
622  * Another note is that the boot page tables are *not* double-pages.  The EPT
623  * won't cover those spaces (e.g. kernbase mapping), so it's not necessary, and
624  * it's a pain in the ass to get it to work (can't align to 2*PGSIZE without
625  * grub complaining, and we might run into issues with freeing memory in the
626  * data segment). */
627 int arch_pgdir_setup(pgdir_t boot_copy, pgdir_t *new_pd)
628 {
629         kpte_t *kpt;
630         epte_t *ept;
631
632         kpt = kpages_alloc(2 * PGSIZE, MEM_WAIT);
633         memcpy(kpt, boot_copy.kpte, PGSIZE);
634         ept = kpte_to_epte(kpt);
635         memset(ept, 0, PGSIZE);
636
637         /* This bit of paranoia slows process creation a little, but makes sure that
638          * there is nothing below ULIM in boot_pgdir.  Any PML4 entries copied from
639          * boot_pgdir (e.g. the kernel's memory) will be *shared* among all
640          * processes, including *everything* under the PML4 entries reach (e.g.
641          * PML4_PTE_REACH = 512 GB) and any activity would need to be synchronized.
642          *
643          * We could do this once at boot time, but that would miss out on potential
644          * changes to the boot_pgdir at runtime.
645          *
646          * We could also just memset that region to 0.  For now, I want to catch
647          * whatever mappings exist, since they are probably bugs. */
648         for (int i = 0; i < PML4(ULIM - 1); i++)
649                 assert(kpt[i] == 0);
650
651         /* VPT and UVPT map the proc's page table, with different permissions. */
652         kpt[PML4(VPT)]  = build_kpte(PADDR(kpt), PTE_KERN_RW);
653         kpt[PML4(UVPT)] = build_kpte(PADDR(kpt), PTE_USER_RO);
654
655         new_pd->kpte = kpt;
656         new_pd->eptp = construct_eptp(PADDR(ept));
657         return 0;
658 }
659
660 physaddr_t arch_pgdir_get_cr3(pgdir_t pd)
661 {
662         return PADDR(pd.kpte);
663 }
664
665 void arch_pgdir_clear(pgdir_t *pd)
666 {
667         pd->kpte = 0;
668         pd->eptp = 0;
669 }
670
671 /* Returns the page shift of the largest jumbo supported */
672 int arch_max_jumbo_page_shift(void)
673 {
674         uint32_t edx;
675         cpuid(0x80000001, 0x0, 0, 0, 0, &edx);
676         return edx & (1 << 26) ? PML3_SHIFT : PML2_SHIFT;
677 }
678
679 /* Adds empty intermediate PTs to the top-most PML in pgdir for the given range.
680  * On a 4-PML system, this will add entries to PML4, consisting of a bunch of
681  * empty PML3s, such that [va, va+len) has intermediate tables in pgdir.
682  *
683  * A few related notes:
684  *
685  * The boot_pgdir is where we do the original kernel mappings.  All of the PML4
686  * entries are filled in, pointing to intermediate PML3s.  All other pgdirs copy
687  * the kernel mapping, which means they have the same content.  That content
688  * never changes at runtime.  What changes is the contents of the PML3s and
689  * below, which are pointed to by all pgdirs.
690  *
691  * The proc pgdirs do not have KPT or EPT mappings above ULIM, so if the
692  * intermediate PTs have EPT entries, it's just a waste of memory, but not a
693  * mapping the user could exploit.
694  *
695  * On occasion, there might be code that maps things into boot_pgdir below ULIM,
696  * though right now this is just an out-of-branch "mmap a page at 0" debugging
697  * hack. */
698 void arch_add_intermediate_pts(pgdir_t pgdir, uintptr_t va, size_t len)
699 {
700         kpte_t *pml4 = pgdir_get_kpt(pgdir);
701         kpte_t *kpte;
702         epte_t *epte;
703         void *new_pml_kva;
704
705         for (size_t i = 0; i < len; i += PML4_PTE_REACH, va += PML4_PTE_REACH) {
706                 kpte = &pml4[PML4(va)];
707                 epte = kpte_to_epte(kpte);
708                 if (kpte_is_present(kpte))
709                         continue;
710                 new_pml_kva = kpages_zalloc(2 * PGSIZE, MEM_WAIT);
711                 /* We insert the same as for __pml_walk. */
712                 *kpte = PADDR(new_pml_kva) | PTE_P | PTE_U | PTE_W;
713                 if (va < ULIM)
714                         *epte = (PADDR(new_pml_kva) + PGSIZE) | EPTE_R | EPTE_X | EPTE_W;
715         }
716 }
717
718 /* Debugging */
719 static int print_pte(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
720                      void *data)
721 {
722         if (kpte_is_unmapped(kpte))
723                 return 0;
724         switch (shift) {
725                 case (PML1_SHIFT):
726                         printk("\t");
727                         /* fall-through */
728                 case (PML2_SHIFT):
729                         printk("\t");
730                         /* fall-through */
731                 case (PML3_SHIFT):
732                         printk("\t");
733         }
734         printk("KVA: %p, PTE val %p, shift %d, visit %d%s\n", kva, *kpte, shift,
735                visited_subs, (*kpte & PTE_PS ? " (jumbo)" : ""));
736         return 0;
737 }
738
739 void debug_print_pgdir(kpte_t *pgdir)
740 {
741         if (! pgdir)
742                 pgdir = KADDR(rcr3());
743         printk("Printing the entire page table set for %p, DFS\n", pgdir);
744         /* Need to be careful we avoid VPT/UVPT, o/w we'll recurse */
745         pml_for_each(pgdir, 0, UVPT, print_pte, 0);
746         if (arch_max_jumbo_page_shift() < PML3_SHIFT)
747                 printk("(skipping kernbase mapping - too many entries)\n");
748         else
749                 pml_for_each(pgdir, KERNBASE, VPT - KERNBASE, print_pte, 0);
750         pml_for_each(pgdir, VPT_TOP, MAX_VADDR - VPT_TOP, print_pte, 0);
751 }
752
753 /* Debug helper - makes sure the KPT == EPT for [0, UVPT) */
754 int debug_check_kpt_ept(void)
755 {
756         int db_cb(kpte_t *kpte, uintptr_t kva, int shift, bool visited_subs,
757                   void *data)
758         {
759                 epte_t *epte = kpte_to_epte(kpte);
760                 char *reason;
761                 int pa_offset = 0;
762
763                 if (kpte_is_present(kpte) != epte_is_present(epte)) {
764                         reason = "present bit";
765                         goto fail;
766                 }
767                 if (kpte_is_mapped(kpte) != epte_is_mapped(epte)) {
768                         reason = "mapped or not";
769                         goto fail;
770                 }
771                 if (kpte_is_jumbo(kpte) != epte_is_jumbo(epte)) {
772                         reason = "jumbo";
773                         goto fail;
774                 }
775                 /* Intermediate PTEs have the EPTE pointing to PADDR + PGSIZE */
776                 if (pte_is_present(kpte) && pte_is_intermediate(kpte, shift))
777                         pa_offset = PGSIZE;
778                 if (kpte_get_paddr(kpte) + pa_offset != epte_get_paddr(epte)) {
779                         reason = "paddr";
780                         goto fail;
781                 }
782                 if ((kpte_get_settings(kpte) & PTE_PERM) !=
783                     (epte_get_settings(epte) & PTE_PERM)) {
784                         reason = "permissions";
785                         goto fail;
786                 }
787                 return 0;
788
789 fail:
790                 panic("kpte %p (%p) epte %p (%p) kva %p shift %d: %s",
791                        kpte, *kpte, epte, *epte, kva, shift, reason);
792                 return -1;
793         }
794         return pml_for_each(current->env_pgdir.kpte, 0, UVPT - 0, db_cb, 0);
795 }