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