SMP boot cleanup
[akaros.git] / kern / src / pmap.c
1 /* See COPYRIGHT for copyright information. */
2 #ifdef __DEPUTY__
3 #pragma nodeputy
4 #endif
5
6 #include <arch/x86.h>
7 #include <arch/mmu.h>
8 #include <arch/apic.h>
9
10 #include <atomic.h>
11 #include <error.h>
12 #include <string.h>
13 #include <assert.h>
14 #include <pmap.h>
15 #include <kclock.h>
16 #include <env.h>
17
18 // These variables are set by i386_detect_memory()
19 static physaddr_t maxpa;        // Maximum physical address
20 static physaddr_t maxaddrpa;    // Maximum directly addressable physical address
21 size_t npage;                   // Amount of physical memory (in pages)
22 size_t naddrpage;                       // Amount of addressable physical memory (in pages)
23 static size_t basemem;          // Amount of base memory (in bytes)
24 static size_t extmem;           // Amount of extended memory (in bytes)
25
26 // These variables are set in i386_vm_init()
27 pde_t* boot_pgdir;              // Virtual address of boot time page directory
28 physaddr_t boot_cr3;            // Physical address of boot time page directory
29 static char* boot_freemem;      // Pointer to next byte of free mem
30
31 page_t *pages;          // Virtual address of physical page array
32 static page_list_t page_free_list;      // Free list of physical pages
33
34 extern env_t *envs;
35
36 // Global descriptor table.
37 //
38 // The kernel and user segments are identical (except for the DPL).
39 // To load the SS register, the CPL must equal the DPL.  Thus,
40 // we must duplicate the segments for the user and the kernel.
41 //
42 segdesc_t gdt[] =
43 {
44         // 0x0 - unused (always faults -- for trapping NULL far pointers)
45         SEG_NULL,
46
47         // 0x8 - kernel code segment
48         [GD_KT >> 3] = SEG(STA_X | STA_R, 0x0, 0xffffffff, 0),
49
50         // 0x10 - kernel data segment
51         [GD_KD >> 3] = SEG(STA_W, 0x0, 0xffffffff, 0),
52
53         // 0x18 - user code segment
54         [GD_UT >> 3] = SEG(STA_X | STA_R, 0x0, 0xffffffff, 3),
55
56         // 0x20 - user data segment
57         [GD_UD >> 3] = SEG(STA_W, 0x0, 0xffffffff, 3),
58
59         // 0x28 - tss, initialized in idt_init()
60         [GD_TSS >> 3] = SEG_NULL
61 };
62
63 pseudodesc_t gdt_pd = {
64         sizeof(gdt) - 1, (unsigned long) gdt
65 };
66
67 static int
68 nvram_read(int r)
69 {
70         return mc146818_read(r) | (mc146818_read(r + 1) << 8);
71 }
72
73 void i386_print_memory_map(multiboot_info_t *mbi) {
74         const char* memory_type[] = {"", "FREE", "RESERVED", "UNDEFINED", "UNDEFINED4"};
75
76
77         if(CHECK_FLAG(mbi->flags, 6)) {
78                 cprintf ("mmap_addr = 0x%x, mmap_length = 0x%x\n", (unsigned long)mbi->mmap_addr,
79                                                                    (unsigned long)mbi->mmap_length);
80                 
81                 memory_map_t* mmap = (memory_map_t*) ((uint32_t)mbi->mmap_addr + KERNBASE);
82                 while((uint32_t)mmap < ((uint32_t)mbi->mmap_addr + KERNBASE) + mbi->mmap_length) {                      
83                         cprintf ("base = 0x%08x%08x, length = 0x%08x%08x, type = %s\n",
84                                 (unsigned) mmap->base_addr_high,
85                                 (unsigned) mmap->base_addr_low,
86                                 (unsigned) mmap->length_high,
87                                 (unsigned) mmap->length_low,
88                                 (unsigned) memory_type[mmap->type]);
89                         mmap = (memory_map_t*) ((uint32_t) mmap + mmap->size + sizeof (mmap->size));
90                 }
91         }
92 }
93
94 void i386_detect_memory(multiboot_info_t *mbi)
95 {
96         // Tells us how many kilobytes there are
97         basemem = ROUNDDOWN(mbi->mem_lower*1024, PGSIZE);
98         extmem = ROUNDDOWN(mbi->mem_upper*1024, PGSIZE);
99
100         // Calculate the maximum physical address based on whether
101         // or not there is any extended memory.  See comment in <inc/memlayout.h>
102         if (extmem)
103                 maxpa = EXTPHYSMEM + extmem;
104         else
105                 maxpa = basemem;
106
107         npage = maxpa / PGSIZE;
108         // IOAPIC - KERNBASE is the max amount of virtual addresses we can use
109         // for the physical memory mapping (aka - the KERNBASE mapping)
110         maxaddrpa = MIN(maxpa, IOAPIC_BASE - KERNBASE);
111         naddrpage = maxaddrpa / PGSIZE;
112
113         cprintf("Physical memory: %dK available, ", (int)(maxpa/1024));
114         cprintf("base = %dK, extended = %dK\n", (int)(basemem/1024), (int)(extmem/1024));
115         printk("Maximum directly addressable physical memory: %dK\n", (int)(maxaddrpa/1024));
116 }
117
118 bool enable_pse(void)
119 {
120         uint32_t edx, cr4;
121         cpuid(1, 0, 0, 0, &edx);
122         if (edx & CPUID_PSE_SUPPORT) {
123                 cr4 = rcr4();
124                 cr4 |= CR4_PSE;
125                 lcr4(cr4);
126                 return 1;
127         } else
128                 return 0;
129 }
130
131 // --------------------------------------------------------------
132 // Set up initial memory mappings and turn on MMU.
133 // --------------------------------------------------------------
134
135 static void check_boot_pgdir(bool pse);
136
137 //
138 // Allocate n bytes of physical memory aligned on an 
139 // align-byte boundary.  Align must be a power of two.
140 // Return kernel virtual address.  Returned memory is uninitialized.
141 //
142 // If we're out of memory, boot_alloc should panic.
143 // This function may ONLY be used during initialization,
144 // before the page_free_list has been set up.
145 // 
146 static void*
147 boot_alloc(uint32_t n, uint32_t align)
148 {
149         extern char end[];
150         void *v;
151
152         // Initialize boot_freemem if this is the first time.
153         // 'end' is a magic symbol automatically generated by the linker,
154         // which points to the end of the kernel's bss segment -
155         // i.e., the first virtual address that the linker
156         // did _not_ assign to any kernel code or global variables.
157         if (boot_freemem == 0)
158                 boot_freemem = end;
159
160         //      Step 1: round boot_freemem up to be aligned properly
161         boot_freemem = ROUNDUP(boot_freemem, align);
162
163         //      Step 2: save current value of boot_freemem as allocated chunk
164         v = boot_freemem;
165         //  Step 2.5: check if we can alloc
166         if (PADDR(boot_freemem + n) > maxaddrpa)
167                 panic("Out of memory in boot alloc, you fool!\n");
168         //      Step 3: increase boot_freemem to record allocation
169         boot_freemem += n;      
170         //      Step 4: return allocated chunk
171         return v;
172 }
173
174 //
175 // Given pgdir, a pointer to a page directory,
176 // walk the 2-level page table structure to find
177 // the page table entry (PTE) for linear address la.
178 // Return a pointer to this PTE.
179 //
180 // If the relevant page table doesn't exist in the page directory:
181 //      - If create == 0, return 0.
182 //      - Otherwise allocate a new page table, install it into pgdir,
183 //        and return a pointer into it.
184 //        (Questions: What data should the new page table contain?
185 //        And what permissions should the new pgdir entry have?
186 //        Note that we use the 486-only "WP" feature of %cr0, which
187 //        affects the way supervisor-mode writes are checked.)
188 //
189 // This function abstracts away the 2-level nature of
190 // the page directory by allocating new page tables
191 // as needed.
192 // 
193 // boot_pgdir_walk may ONLY be used during initialization,
194 // before the page_free_list has been set up.
195 // It should panic on failure.  (Note that boot_alloc already panics
196 // on failure.)
197 //
198 // Supports returning jumbo (4MB PSE) PTEs.  To create with a jumbo, pass in 2.
199 // 
200 // Maps non-PSE PDEs as U/W.  W so the kernel can, U so the user can read via
201 // UVPT.  UVPT security comes from the UVPT mapping (U/R).  All other kernel pages
202 // protected at the second layer
203 static pte_t*
204 boot_pgdir_walk(pde_t *pgdir, uintptr_t la, int create)
205 {
206         pde_t* the_pde = &pgdir[PDX(la)];
207         void* new_table;
208
209         if (*the_pde & PTE_P) {
210                 if (*the_pde & PTE_PS)
211                         return (pte_t*)the_pde;
212                 return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(la)];
213         }
214         if (!create)
215                 return NULL;
216         if (create == 2) {
217                 if (JPGOFF(la))
218                         panic("Attempting to find a Jumbo PTE at an unaligned VA!");
219                 *the_pde = PTE_PS | PTE_P;
220                 return (pte_t*)the_pde;
221         }
222         new_table = boot_alloc(PGSIZE, PGSIZE);
223         memset(new_table, 0, PGSIZE);
224         *the_pde = (pde_t)PADDR(new_table) | PTE_P | PTE_W | PTE_U | PTE_G;
225         return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(la)];
226 }
227
228 //
229 // Map [la, la+size) of linear address space to physical [pa, pa+size)
230 // in the page table rooted at pgdir.  Size is a multiple of PGSIZE.
231 // Use permission bits perm|PTE_P for the entries.
232 //
233 // This function may ONLY be used during initialization,
234 // before the page_free_list has been set up.
235 //
236 // To map with Jumbos, set PTE_PS in perm
237 static void
238 boot_map_segment(pde_t *pgdir, uintptr_t la, size_t size, physaddr_t pa, int perm)
239 {
240         uintptr_t i;
241         pte_t *pte;
242         // la can be page unaligned, but weird things will happen
243         // unless pa has the same offset.  pa always truncates any
244         // possible offset.  will warn.  size can be weird too. 
245         if (PGOFF(la)) {
246                 warn("la not page aligned in boot_map_segment!");
247                 size += PGOFF(la);
248         }
249         if (perm & PTE_PS) {
250                 if (JPGOFF(la) || JPGOFF(pa))
251                         panic("Tried to map a Jumbo page at an unaligned address!");
252                 // need to index with i instead of la + size, in case of wrap-around
253                 for (i = 0; i < size; i += JPGSIZE, la += JPGSIZE, pa += JPGSIZE) {
254                         pte = boot_pgdir_walk(pgdir, la, 2);
255                         *pte = PTE_ADDR(pa) | PTE_P | perm;
256                 }
257         } else {
258                 for (i = 0; i < size; i += PGSIZE, la += PGSIZE, pa += PGSIZE) {
259                         pte = boot_pgdir_walk(pgdir, la, 1);
260                         if (*pte & PTE_PS)
261                                 // if we start using the extra flag for PAT, which we aren't,
262                                 // this will warn, since PTE_PS and PTE_PAT are the same....
263                                 warn("Possibly attempting to map a regular page into a Jumbo PDE");
264                         *pte = PTE_ADDR(pa) | PTE_P | perm;
265                 }
266         }
267 }
268
269 // could consider having an API to allow these to dynamically change
270 // MTRRs are for physical, static ranges.  PAT are linear, more granular, and 
271 // more dynamic
272 void setup_default_mtrrs(barrier_t* smp_barrier)
273 {
274         // disable interrupts
275         int8_t state = 0;
276         disable_irqsave(&state);
277         // barrier - if we're meant to do this for all cores, we'll be 
278         // passed a pointer to an initialized barrier
279         if (smp_barrier)
280                 waiton_barrier(smp_barrier);
281         
282         // disable caching      cr0: set CD and clear NW
283         lcr0((rcr0() | CR0_CD) & ~CR0_NW);
284         // flush caches
285         cache_flush();
286         // flush tlb
287         tlb_flush_global();
288         // disable MTRRs, and sets default type to WB (06)
289         write_msr(IA32_MTRR_DEF_TYPE, 0x00000006);
290
291         // Now we can actually safely adjust the MTRRs
292         // MTRR for IO Holes (note these are 64 bit values we are writing)
293         // 0x000a0000 - 0x000c0000 : VGA - WC 0x01
294         write_msr(IA32_MTRR_PHYSBASE0, PTE_ADDR(VGAPHYSMEM) | 0x01);
295         // if we need to have a full 64bit val, use the UINT64 macro
296         write_msr(IA32_MTRR_PHYSMASK0, 0x0000000ffffe0800);
297         // 0x000c0000 - 0x00100000 : IO devices (and ROM BIOS) - UC 0x00
298         write_msr(IA32_MTRR_PHYSBASE1, PTE_ADDR(DEVPHYSMEM) | 0x00);
299         write_msr(IA32_MTRR_PHYSMASK1, 0x0000000ffffc0800);
300         // APIC/IOAPIC holes
301         /* Going to skip them, since we set their mode using PAT when we 
302          * map them in 
303          */
304         // make sure all other MTRR ranges are disabled (should be unnecessary)
305         write_msr(IA32_MTRR_PHYSMASK2, 0);
306         write_msr(IA32_MTRR_PHYSMASK3, 0);
307         write_msr(IA32_MTRR_PHYSMASK4, 0);
308         write_msr(IA32_MTRR_PHYSMASK5, 0);
309         write_msr(IA32_MTRR_PHYSMASK6, 0);
310         write_msr(IA32_MTRR_PHYSMASK7, 0);
311
312         // keeps default type to WB (06), turns MTRRs on, and turns off fixed ranges
313         write_msr(IA32_MTRR_DEF_TYPE, 0x00000806);
314         // reflush caches and TLB
315         cache_flush();
316         tlb_flush_global();
317         // turn on caching
318         lcr0(rcr0() & ~(CR0_CD | CR0_NW));
319         // barrier
320         if (smp_barrier)
321                 waiton_barrier(smp_barrier);
322         // enable interrupts
323         enable_irqsave(&state);
324 }
325
326
327 // Set up a two-level page table:
328 //    boot_pgdir is its linear (virtual) address of the root
329 //    boot_cr3 is the physical adresss of the root
330 // Then turn on paging.  Then effectively turn off segmentation.
331 // (i.e., the segment base addrs are set to zero).
332 // 
333 // This function only sets up the kernel part of the address space
334 // (ie. addresses >= UTOP).  The user part of the address space
335 // will be setup later.
336 //
337 // From UTOP to ULIM, the user is allowed to read but not write.
338 // Above ULIM the user cannot read (or write). 
339 void
340 i386_vm_init(void)
341 {
342         pde_t* pgdir;
343         uint32_t cr0, edx;
344         size_t n;
345         bool pse;
346
347         pse = enable_pse();
348         if (pse)
349                 cprintf("PSE capability detected.\n");
350
351         // we paniced earlier if we don't support PGE.  turn it on now.
352         // it's used in boot_map_segment, which covers all of the mappings that are
353         // the same for all address spaces.  and also for the VPT mapping below.
354         lcr4(rcr4() | CR4_PGE);
355
356         // set up mtrr's for core0.  other cores will do the same later
357         setup_default_mtrrs(0);
358
359         /*
360          * PSE status: 
361          * - can walk and set up boot_map_segments with jumbos but can't
362          *   insert yet.  need to look at the page_dir and friends.
363          * - anything related to a single struct Page still can't handle 
364          *   jumbos.  will need to think about and adjust Page functions
365          * - do we want to store info like this in the struct Page?  or just check
366          *   by walking the PTE
367          * - when we alloc a page, and we want it to be 4MB, we'll need
368          *   to have contiguous memory, etc
369          * - there's a difference between having 4MB page table entries
370          *   and having 4MB Page tracking structs.  changing the latter will
371          *   break a lot of things
372          * - showmapping and friends work on a 4KB granularity, but map to the
373          *   correct entries
374          * - need to not insert / boot_map a single page into an area that is 
375          *   already holding a jumbo page.  will need to break the jumbo up so that
376          *   we can then insert the lone page.  currently warns.
377          * - some inherent issues with the pgdir_walks returning a PTE, and we
378          *   don't know whether it is a jumbo (PDE) or a regular PTE.
379          */
380
381         //////////////////////////////////////////////////////////////////////
382         // create initial page directory.
383         pgdir = boot_alloc(PGSIZE, PGSIZE);
384         memset(pgdir, 0, PGSIZE);
385         boot_pgdir = pgdir;
386         boot_cr3 = PADDR(pgdir);
387         // helpful if you want to manually walk with kvm / bochs
388         //printk("pgdir va = %08p, pgdir pa = %08p\n\n", pgdir, PADDR(pgdir));
389
390         //////////////////////////////////////////////////////////////////////
391         // Recursively insert PD in itself as a page table, to form
392         // a virtual page table at virtual address VPT.
393         // (For now, you don't have understand the greater purpose of the
394         // following two lines.  Unless you are eagle-eyed, in which case you
395         // should already know.)
396
397         // Permissions: kernel RW, user NONE, Global Page
398         pgdir[PDX(VPT)] = PADDR(pgdir) | PTE_W | PTE_P | PTE_G;
399
400         // same for UVPT
401         // Permissions: kernel R, user R, Global Page
402         pgdir[PDX(UVPT)] = PADDR(pgdir) | PTE_U | PTE_P | PTE_G;
403
404         //////////////////////////////////////////////////////////////////////
405         // Map the kernel stack (symbol name "bootstack").  The complete VA
406         // range of the stack, [KSTACKTOP-PTSIZE, KSTACKTOP), breaks into two
407         // pieces:
408         //     * [KSTACKTOP-KSTKSIZE, KSTACKTOP) -- backed by physical memory
409         //     * [KSTACKTOP-PTSIZE, KSTACKTOP-KSTKSIZE) -- not backed => faults
410         //     Permissions: kernel RW, user NONE
411         // Your code goes here:
412
413         // remember that the space for the kernel stack is allocated in the binary.
414         // bootstack and bootstacktop point to symbols in the data section, which 
415         // at this point are like 0xc010b000.  KSTACKTOP is the desired loc in VM
416         boot_map_segment(pgdir, (uintptr_t)KSTACKTOP - KSTKSIZE, 
417                          KSTKSIZE, PADDR(bootstack), PTE_W | PTE_G);
418
419         //////////////////////////////////////////////////////////////////////
420         // Map all of physical memory at KERNBASE. 
421         // Ie.  the VA range [KERNBASE, 2^32) should map to
422         //      the PA range [0, 2^32 - KERNBASE)
423         // We might not have 2^32 - KERNBASE bytes of physical memory, but
424         // we just set up the mapping anyway.
425         // Permissions: kernel RW, user NONE
426         // Your code goes here: 
427         
428         // this maps all of the possible phys memory
429         // note the use of unsigned underflow to get size = 0x40000000
430         //boot_map_segment(pgdir, KERNBASE, -KERNBASE, 0, PTE_W);
431         // but this only maps what is available, and saves memory.  every 4MB of
432         // mapped memory requires a 2nd level page: 2^10 entries, each covering 2^12
433         // need to modify tests below to account for this
434         if (pse) {
435                 // map the first 4MB as regular entries, to support different MTRRs
436                 boot_map_segment(pgdir, KERNBASE, JPGSIZE, 0, PTE_W | PTE_G);
437                 boot_map_segment(pgdir, KERNBASE + JPGSIZE, maxaddrpa - JPGSIZE, JPGSIZE,
438                                  PTE_W | PTE_G | PTE_PS);
439         } else
440                 boot_map_segment(pgdir, KERNBASE, maxaddrpa, 0, PTE_W | PTE_G);
441
442         // APIC mapping: using PAT (but not *the* PAT flag) to make these type UC
443         // IOAPIC
444         boot_map_segment(pgdir, (uintptr_t)IOAPIC_BASE, PGSIZE, IOAPIC_BASE, 
445                          PTE_PCD | PTE_PWT | PTE_W | PTE_G);
446         // Local APIC
447         boot_map_segment(pgdir, (uintptr_t)LAPIC_BASE, PGSIZE, LAPIC_BASE,
448                          PTE_PCD | PTE_PWT | PTE_W | PTE_G);
449
450         //////////////////////////////////////////////////////////////////////
451         // Make 'pages' point to an array of size 'npage' of 'struct Page'.
452         // The kernel uses this structure to keep track of physical pages;
453         // 'npage' equals the number of physical pages in memory.  User-level
454         // programs get read-only access to the array as well.
455         // You must allocate the array yourself.
456         // Map this array read-only by the user at linear address UPAGES
457         // (ie. perm = PTE_U | PTE_P)
458         // Permissions:
459         //    - pages -- kernel RW, user NONE
460         //    - the read-only version mapped at UPAGES -- kernel R, user R
461         // Your code goes here: 
462         
463         // round up to the nearest page
464         size_t page_array_size = ROUNDUP(npage*sizeof(page_t), PGSIZE);
465         pages = (page_t *)boot_alloc(page_array_size, PGSIZE);
466         memset(pages, 0, page_array_size);
467         if (page_array_size > PTSIZE) {
468                 warn("page_array_size bigger than PTSIZE, userland will not see all pages");
469                 page_array_size = PTSIZE;
470         }
471         boot_map_segment(pgdir, UPAGES, page_array_size, PADDR(pages), PTE_U | PTE_G);
472
473         //////////////////////////////////////////////////////////////////////
474         // Make 'envs' point to an array of size 'NENV' of 'env_t'.
475         // No longer mapping ENVS into the address space
476         
477         // round up to the nearest page
478         size_t env_array_size = ROUNDUP(NENV*sizeof(env_t), PGSIZE);
479         envs = (env_t *)boot_alloc(env_array_size, PGSIZE);
480         memset(envs, 0, env_array_size);
481
482         // Check that the initial page directory has been set up correctly.
483         check_boot_pgdir(pse);
484
485         //////////////////////////////////////////////////////////////////////
486         // On x86, segmentation maps a VA to a LA (linear addr) and
487         // paging maps the LA to a PA.  I.e. VA => LA => PA.  If paging is
488         // turned off the LA is used as the PA.  Note: there is no way to
489         // turn off segmentation.  The closest thing is to set the base
490         // address to 0, so the VA => LA mapping is the identity.
491
492         // Current mapping: VA KERNBASE+x => PA x.
493         //     (segmentation base=-KERNBASE and paging is off)
494
495         // From here on down we must maintain this VA KERNBASE + x => PA x
496         // mapping, even though we are turning on paging and reconfiguring
497         // segmentation.
498
499         // Map VA 0:4MB same as VA KERNBASE, i.e. to PA 0:4MB.
500         // (Limits our kernel to <4MB)
501         /* They mean linear address 0:4MB, and the kernel < 4MB is only until 
502          * segmentation is turned off.
503          * once we turn on paging, segmentation is still on, so references to
504          * KERNBASE+x will get mapped to linear address x, which we need to make 
505          * sure can map to phys addr x, until we can turn off segmentation and
506          * KERNBASE+x maps to LA KERNBASE+x, which maps to PA x, via paging
507          */
508         pgdir[0] = pgdir[PDX(KERNBASE)];
509
510         // Install page table.
511         lcr3(boot_cr3);
512
513         // Turn on paging.
514         cr0 = rcr0();
515         // CD and NW should already be on, but just in case these turn on caching
516         cr0 |= CR0_PE|CR0_PG|CR0_AM|CR0_WP|CR0_NE|CR0_MP;
517         cr0 &= ~(CR0_TS|CR0_EM|CR0_CD|CR0_NW);
518         lcr0(cr0);
519
520         // Current mapping: KERNBASE+x => x => x.
521         // (x < 4MB so uses paging pgdir[0])
522
523         // Reload all segment registers.
524         asm volatile("lgdt gdt_pd");
525         asm volatile("movw %%ax,%%gs" :: "a" (GD_UD|3));
526         asm volatile("movw %%ax,%%fs" :: "a" (GD_UD|3));
527         asm volatile("movw %%ax,%%es" :: "a" (GD_KD));
528         asm volatile("movw %%ax,%%ds" :: "a" (GD_KD));
529         asm volatile("movw %%ax,%%ss" :: "a" (GD_KD));
530         asm volatile("ljmp %0,$1f\n 1:\n" :: "i" (GD_KT));  // reload cs
531         asm volatile("lldt %%ax" :: "a" (0));
532
533         // Final mapping: KERNBASE+x => KERNBASE+x => x.
534
535         // This mapping was only used after paging was turned on but
536         // before the segment registers were reloaded.
537         pgdir[0] = 0;
538
539         // Flush the TLB for good measure, to kill the pgdir[0] mapping.
540         lcr3(boot_cr3);
541 }
542
543 //
544 // Checks that the kernel part of virtual address space
545 // has been setup roughly correctly(by i386_vm_init()).
546 //
547 // This function doesn't test every corner case,
548 // in fact it doesn't test the permission bits at all,
549 // but it is a pretty good sanity check. 
550 //
551 static physaddr_t check_va2pa(pde_t *pgdir, uintptr_t va);
552 static pte_t get_vaperms(pde_t *pgdir, uintptr_t va);
553
554 static void
555 check_boot_pgdir(bool pse)
556 {
557         uint32_t i, n;
558         pde_t *pgdir, pte;
559
560         pgdir = boot_pgdir;
561
562         // check pages array
563         n = ROUNDUP(naddrpage*sizeof(page_t), PGSIZE);
564         for (i = 0; i < n; i += PGSIZE)
565                 assert(check_va2pa(pgdir, UPAGES + i) == PADDR(pages) + i);
566
567         // check phys mem
568         //for (i = 0; KERNBASE + i != 0; i += PGSIZE)
569         // adjusted check to account for only mapping avail mem
570         if (pse)
571                 for (i = 0; i < maxaddrpa; i += JPGSIZE)
572                         assert(check_va2pa(pgdir, KERNBASE + i) == i);
573         else
574                 for (i = 0; i < maxaddrpa; i += PGSIZE)
575                         assert(check_va2pa(pgdir, KERNBASE + i) == i);
576
577         // check kernel stack
578         for (i = 0; i < KSTKSIZE; i += PGSIZE)
579                 assert(check_va2pa(pgdir, KSTACKTOP - KSTKSIZE + i) == PADDR(bootstack) + i);
580
581         // check for zero/non-zero in PDEs
582         for (i = 0; i < NPDENTRIES; i++) {
583                 switch (i) {
584                 case PDX(VPT):
585                 case PDX(UVPT):
586                 case PDX(KSTACKTOP-1):
587                 case PDX(UPAGES):
588                 case PDX(LAPIC_BASE): // LAPIC mapping.  TODO: remove when MTRRs are up
589                         assert(pgdir[i]);
590                         break;
591                 default:
592                         //if (i >= PDX(KERNBASE))
593                         // adjusted check to account for only mapping avail mem
594                         // and you can't KADDR maxpa (just above legal range)
595                         // maxaddrpa can be up to maxpa, so assume the worst
596                         if (i >= PDX(KERNBASE) && i <= PDX(KADDR(maxaddrpa-1)))
597                                 assert(pgdir[i]);
598                         else
599                                 assert(pgdir[i] == 0);
600                         break;
601                 }
602         }
603
604         // check permissions
605         // user read-only.  check for user and write, should be only user
606         // eagle-eyed viewers should be able to explain the extra cases
607         for (i = UTOP; i < ULIM; i+=PGSIZE) {
608                 pte = get_vaperms(pgdir, i);
609                 if ((pte & PTE_P) && (i != UVPT+(VPT>>10))) {
610                         if (pte & PTE_PS) {
611                                 assert((pte & PTE_U) != PTE_U);
612                                 assert((pte & PTE_W) != PTE_W);
613                         } else {
614                                 assert((pte & PTE_U) == PTE_U);
615                                 assert((pte & PTE_W) != PTE_W);
616                         }
617                 }
618         }
619         // kernel read-write.
620         for (i = ULIM; i <= KERNBASE + maxaddrpa - PGSIZE; i+=PGSIZE) {
621                 pte = get_vaperms(pgdir, i);
622                 if ((pte & PTE_P) && (i != VPT+(UVPT>>10))) {
623                         assert((pte & PTE_U) != PTE_U);
624                         assert((pte & PTE_W) == PTE_W);
625                 }
626         }
627         // special mappings
628         pte = get_vaperms(pgdir, UVPT+(VPT>>10));
629         assert((pte & PTE_U) != PTE_U);
630         assert((pte & PTE_W) != PTE_W);
631
632         // note this means the kernel cannot directly manipulate this virtual address
633         // convince yourself this isn't a big deal, eagle-eyes!
634         pte = get_vaperms(pgdir, VPT+(UVPT>>10));
635         assert((pte & PTE_U) != PTE_U);
636         assert((pte & PTE_W) != PTE_W);
637
638         cprintf("check_boot_pgdir() succeeded!\n");
639 }
640
641 // This function returns the physical address of the page containing 'va',
642 // defined by the page directory 'pgdir'.  The hardware normally performs
643 // this functionality for us!  We define our own version to help check
644 // the check_boot_pgdir() function; it shouldn't be used elsewhere.
645
646 static physaddr_t
647 check_va2pa(pde_t *pgdir, uintptr_t va)
648 {
649         pte_t *p;
650
651         pgdir = &pgdir[PDX(va)];
652         if (!(*pgdir & PTE_P))
653                 return ~0;
654         if (*pgdir & PTE_PS)
655                 return PTE_ADDR(*pgdir);
656         p = (pte_t*) KADDR(PTE_ADDR(*pgdir));
657         if (!(p[PTX(va)] & PTE_P))
658                 return ~0;
659         return PTE_ADDR(p[PTX(va)]);
660 }
661
662 /* 
663  * This function returns a PTE with the aggregate permissions equivalent
664  * to walking the two levels of paging.  PPN = 0.  Somewhat fragile, in that
665  * it returns PTE_PS if either entry has PTE_PS (which should only happen
666  * for some of the recusive walks)
667  */
668
669 static pte_t
670 get_vaperms(pde_t *pgdir, uintptr_t va)
671 {
672         pde_t* pde = &pgdir[PDX(va)];
673         pte_t* pte = pgdir_walk(pgdir, (void*)va, 0);
674         if (!pte || !(*pte & PTE_P))
675                 return 0;
676         return PGOFF(*pde & *pte) + PTE_PS & (*pde | *pte);
677 }
678                 
679 // --------------------------------------------------------------
680 // Tracking of physical pages.
681 // The 'pages' array has one 'page_t' entry per physical page.
682 // Pages are reference counted, and free pages are kept on a linked list.
683 // --------------------------------------------------------------
684
685 //  
686 // Initialize page structure and memory free list.
687 // After this point, ONLY use the functions below
688 // to allocate and deallocate physical memory via the page_free_list,
689 // and NEVER use boot_alloc() or the related boot-time functions above.
690 //
691 void
692 page_init(void)
693 {
694         // The example code here marks all pages as free.
695         // However this is not truly the case.  What memory is free?
696         //  1) Mark page 0 as in use.
697         //     This way we preserve the real-mode IDT and BIOS structures
698         //     in case we ever need them.  (Currently we don't, but...)
699         //  2) Mark the rest of base memory as free.
700         //  3) Then comes the IO hole [IOPHYSMEM, EXTPHYSMEM).
701         //     Mark it as in use so that it can never be allocated.      
702         //  4) Then extended memory [EXTPHYSMEM, ...).
703         //     Some of it is in use, some is free. Where is the kernel?
704         //     Which pages are used for page tables and other data structures?
705         //
706         // Change the code to reflect this.
707         int i;
708         physaddr_t physaddr_after_kernel = PADDR(ROUNDUP(boot_freemem, PGSIZE));
709         LIST_INIT(&page_free_list);
710
711         pages[0].pp_ref = 1;
712         // alloc the second page, since we will need it later to init the other cores
713         // probably need to be smarter about what page we use (make this dynamic) TODO
714         pages[1].pp_ref = 1;
715         for (i = 2; i < PPN(IOPHYSMEM); i++) {
716                 pages[i].pp_ref = 0;
717                 LIST_INSERT_HEAD(&page_free_list, &pages[i], pp_link);
718         }
719         for (i = PPN(IOPHYSMEM); i < PPN(EXTPHYSMEM); i++) {
720                 pages[i].pp_ref = 1;
721         }
722         for (i = PPN(EXTPHYSMEM); i < PPN(physaddr_after_kernel); i++) {
723                 pages[i].pp_ref = 1;
724         }
725         for (i = PPN(physaddr_after_kernel); i < PPN(maxaddrpa); i++) {
726                 pages[i].pp_ref = 0;
727                 LIST_INSERT_HEAD(&page_free_list, &pages[i], pp_link);
728         }
729         // this block out all memory above maxaddrpa.  will need another mechanism
730         // to allocate and map these into the kernel address space
731         for (i = PPN(maxaddrpa); i < npage; i++) {
732                 pages[i].pp_ref = 1;
733         }
734 }
735
736 //
737 // Initialize a Page structure.
738 // The result has null links and 0 refcount.
739 // Note that the corresponding physical page is NOT initialized!
740 //
741 static void
742 page_initpp(page_t *pp)
743 {
744         memset(pp, 0, sizeof(*pp));
745 }
746
747 //
748 // Allocates a physical page.
749 // Does NOT set the contents of the physical page to zero -
750 // the caller must do that if necessary.
751 //
752 // *pp_store -- is set to point to the Page struct of the newly allocated
753 // page
754 //
755 // RETURNS 
756 //   0 -- on success
757 //   -E_NO_MEM -- otherwise 
758 //
759 // Hint: use LIST_FIRST, LIST_REMOVE, and page_initpp
760 // Hint: pp_ref should not be incremented 
761 int
762 page_alloc(page_t **pp_store)
763 {
764         if (LIST_EMPTY(&page_free_list))
765                 return -E_NO_MEM;
766         *pp_store = LIST_FIRST(&page_free_list);
767         LIST_REMOVE(*pp_store, pp_link);
768         page_initpp(*pp_store);
769         return 0;
770 }
771
772 //
773 // Return a page to the free list.
774 // (This function should only be called when pp->pp_ref reaches 0.)
775 //
776 void
777 page_free(page_t *pp)
778 {
779         // this check allows us to call this on null ptrs, which helps when
780         // allocating and checking for errors on several pages at once
781         if (pp) {
782                 if (pp->pp_ref)
783                         panic("Attempting to free page with non-zero reference count!");
784                 LIST_INSERT_HEAD(&page_free_list, pp, pp_link);
785         }
786 }
787
788 /* 
789  * Remove the second level page table associated with virtual address va.
790  * Will 0 out the PDE for that page table.
791  * Panics if the page table has any present entries.
792  * This should be called rarely and with good cause.
793  * Currently errors if the PDE is jumbo or not present.
794  */
795 error_t pagetable_remove(pde_t *pgdir, void *va)
796 {
797         pde_t* the_pde = &pgdir[PDX(va)];
798
799         if (!(*the_pde & PTE_P) || (*the_pde & PTE_PS))
800                 return -E_FAULT;
801         pte_t* page_table = (pde_t*)KADDR(PTE_ADDR(*the_pde));
802         for (int i = 0; i < NPTENTRIES; i++) 
803                 if (page_table[i] & PTE_P)
804                         panic("Page table not empty during attempted removal!");
805         *the_pde = 0;
806         page_decref(pa2page(PADDR(page_table)));
807         return 0;
808 }
809
810 //
811 // Decrement the reference count on a page,
812 // freeing it if there are no more refs.
813 //
814 void
815 page_decref(page_t *pp)
816 {
817         if (--pp->pp_ref == 0)
818                 page_free(pp);
819 }
820
821 // Given 'pgdir', a pointer to a page directory, pgdir_walk returns
822 // a pointer to the page table entry (PTE) for linear address 'va'.
823 // This requires walking the two-level page table structure.
824 //
825 // If the relevant page table doesn't exist in the page directory, then:
826 //    - If create == 0, pgdir_walk returns NULL.
827 //    - Otherwise, pgdir_walk tries to allocate a new page table
828 //      with page_alloc.  If this fails, pgdir_walk returns NULL.
829 //    - Otherwise, pgdir_walk returns a pointer into the new page table.
830 //
831 // This is boot_pgdir_walk, but using page_alloc() instead of boot_alloc().
832 // Unlike boot_pgdir_walk, pgdir_walk can fail.
833 //
834 // Hint: you can turn a Page * into the physical address of the
835 // page it refers to with page2pa() from kern/pmap.h.
836 //
837 // Supports returning jumbo (4MB PSE) PTEs.  To create with a jumbo, pass in 2.
838 pte_t*
839 pgdir_walk(pde_t *pgdir, const void *SNT va, int create)
840 {
841         pde_t* the_pde = &pgdir[PDX(va)];
842         page_t *new_table;
843
844         if (*the_pde & PTE_P) {
845                 if (*the_pde & PTE_PS)
846                         return (pte_t*)the_pde;
847                 return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(va)];
848         }
849         if (!create)
850                 return NULL;
851         if (create == 2) {
852                 if (JPGOFF(va))
853                         panic("Attempting to find a Jumbo PTE at an unaligned VA!");
854                 *the_pde = PTE_PS | PTE_P;
855                 return (pte_t*)the_pde;
856         }
857         if (page_alloc(&new_table))
858                 return NULL;
859         new_table->pp_ref = 1;
860         memset(page2kva(new_table), 0, PGSIZE);
861         *the_pde = (pde_t)page2pa(new_table) | PTE_P | PTE_W | PTE_U;
862         return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(va)];
863 }
864 //
865 // Map the physical page 'pp' at virtual address 'va'.
866 // The permissions (the low 12 bits) of the page table
867 //  entry should be set to 'perm|PTE_P'.
868 //
869 // Details
870 //   - If there is already a page mapped at 'va', it is page_remove()d.
871 //   - If necessary, on demand, allocates a page table and inserts it into
872 //     'pgdir'.
873 //   - pp->pp_ref should be incremented if the insertion succeeds.
874 //   - The TLB must be invalidated if a page was formerly present at 'va'.
875 //     (this is handled in page_remove)
876 //
877 // RETURNS: 
878 //   0 on success
879 //   -E_NO_MEM, if page table couldn't be allocated
880 //
881 // Hint: The TA solution is implemented using pgdir_walk, page_remove,
882 // and page2pa.
883 //
884 // No support for jumbos here.  will need to be careful of trying to insert
885 // regular pages into something that was already jumbo, and the overloading
886 // of the PTE_PS and PTE_PAT flags...
887 int
888 page_insert(pde_t *pgdir, page_t *pp, void *va, int perm) 
889 {
890         pte_t* pte = pgdir_walk(pgdir, va, 1);
891         if (!pte)
892                 return -E_NO_MEM;
893         // need to up the ref count in case pp is already mapped at va
894         // and we don't want to page_remove (which could free pp) and then 
895         // continue as if pp wasn't freed.  moral = up the ref asap
896         pp->pp_ref++;
897         if (*pte & PTE_P) {
898                 page_remove(pgdir, va);
899         }
900         *pte = page2pa(pp) | PTE_P | perm;
901         return 0;
902 }
903
904 //
905 // Return the page mapped at virtual address 'va'.
906 // If pte_store is not zero, then we store in it the address
907 // of the pte for this page.  This is used by page_remove
908 // but should not be used by other callers.
909 //
910 // Return 0 if there is no page mapped at va.
911 //
912 // Hint: the TA solution uses pgdir_walk and pa2page.
913 //
914 // For jumbos, right now this returns the first Page* in the 4MB
915 page_t *page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
916 {
917         pte_t* pte = pgdir_walk(pgdir, va, 0);
918         if (!pte || !(*pte & PTE_P))
919                 return 0;
920         if (pte_store)
921                 *pte_store = pte;
922         return pa2page(PTE_ADDR(*pte));
923 }
924
925 //
926 // Unmaps the physical page at virtual address 'va'.
927 // If there is no physical page at that address, silently does nothing.
928 //
929 // Details:
930 //   - The ref count on the physical page should decrement.
931 //   - The physical page should be freed if the refcount reaches 0.
932 //   - The pg table entry corresponding to 'va' should be set to 0.
933 //     (if such a PTE exists)
934 //   - The TLB must be invalidated if you remove an entry from
935 //     the pg dir/pg table.
936 //
937 // Hint: The TA solution is implemented using page_lookup,
938 //      tlb_invalidate, and page_decref.
939 //
940 // This may be wonky wrt Jumbo pages and decref.  
941 void
942 page_remove(pde_t *pgdir, void *va)
943 {
944         pte_t* pte;
945         page_t *page;
946         page = page_lookup(pgdir, va, &pte);
947         if (!page)
948                 return;
949         *pte = 0;
950         tlb_invalidate(pgdir, va);
951         page_decref(page);
952 }
953
954 //
955 // Invalidate a TLB entry, but only if the page tables being
956 // edited are the ones currently in use by the processor.
957 //
958 // Need to sort this for cross core lovin'  TODO
959 void
960 tlb_invalidate(pde_t *pgdir, void *va)
961 {
962         // Flush the entry only if we're modifying the current address space.
963         // For now, there is only one address space, so always invalidate.
964         invlpg(va);
965 }
966
967 /* Flushes a TLB, including global pages.  We should always have the CR4_PGE
968  * flag set, but just in case, we'll check.  Toggling this bit flushes the TLB.
969  */
970 void tlb_flush_global(void)
971 {
972         uint32_t cr4 = rcr4();
973         if (cr4 & CR4_PGE) {
974                 lcr4(cr4 & ~CR4_PGE);
975                 lcr4(cr4);
976         } else 
977                 lcr3(rcr3());
978 }
979
980 static void *DANGEROUS user_mem_check_addr;
981
982 //
983 // Check that an environment is allowed to access the range of memory
984 // [va, va+len) with permissions 'perm | PTE_P'.
985 // Normally 'perm' will contain PTE_U at least, but this is not required.
986 // 'va' and 'len' need not be page-aligned; you must test every page that
987 // contains any of that range.  You will test either 'len/PGSIZE',
988 // 'len/PGSIZE + 1', or 'len/PGSIZE + 2' pages.
989 //
990 // A user program can access a virtual address if (1) the address is below
991 // ULIM, and (2) the page table gives it permission.  These are exactly
992 // the tests you should implement here.
993 //
994 // If there is an error, set the 'user_mem_check_addr' variable to the first
995 // erroneous virtual address.
996 //
997 // Returns 0 if the user program can access this range of addresses,
998 // and -E_FAULT otherwise.
999 //
1000 // Hint: The TA solution uses pgdir_walk.
1001 //
1002
1003 // zra: I've modified the interface to these two functions so that Ivy can
1004 // check that user pointers aren't dereferenced. User pointers get the
1005 // DANGEROUS qualifier. After validation, these functions return a
1006 // COUNT(len) pointer. user_mem_check now returns NULL on error instead of
1007 // -E_FAULT.
1008
1009 void *COUNT(len)
1010 user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
1011 {
1012         // TODO - will need to sort this out wrt page faulting / PTE_P
1013         // also could be issues with sleeping and waking up to find pages
1014         // are unmapped, though i think the lab ignores this since the 
1015         // kernel is uninterruptible
1016         void *DANGEROUS start, *DANGEROUS end;
1017         size_t num_pages, i;
1018         pte_t *pte;
1019
1020         perm |= PTE_P;
1021         start = ROUNDDOWN((void*)va, PGSIZE);
1022         end = ROUNDUP((void*)va + len, PGSIZE);
1023         if (start >= end) {
1024                 warn("Blimey!  Wrap around in VM range calculation!");  
1025                 return NULL;
1026         }
1027         num_pages = PPN(end - start);
1028         for (i = 0; i < num_pages; i++, start += PGSIZE) {
1029                 pte = pgdir_walk(env->env_pgdir, start, 0);
1030                 // ensures the bits we want on are turned on.  if not, error out
1031                 if ( !pte || ((*pte & perm) != perm) ) {
1032                         if (i = 0)
1033                                 user_mem_check_addr = (void*)va;
1034                         else
1035                                 user_mem_check_addr = start;
1036                         return NULL;
1037                 }
1038         }
1039         // this should never be needed, since the perms should catch it
1040         if ((uintptr_t)end > ULIM) {
1041                 warn ("I suck - Bug in user permission mappings!");
1042                 return NULL;
1043         }
1044         return (void *COUNT(len))TC(va);
1045 }
1046
1047 //
1048 // Checks that environment 'env' is allowed to access the range
1049 // of memory [va, va+len) with permissions 'perm | PTE_U'.
1050 // If it can, then the function simply returns.
1051 // If it cannot, 'env' is destroyed.
1052 //
1053 void *COUNT(len)
1054 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
1055 {
1056     void *COUNT(len) res = user_mem_check(env,va,len,perm | PTE_U);
1057         if (!res) {
1058                 cprintf("[%08x] user_mem_check assertion failure for "
1059                         "va %08x\n", env->env_id, user_mem_check_addr);
1060                 env_destroy(env);       // may not return
1061         return NULL;
1062         }
1063     return res;
1064 }
1065
1066 void
1067 page_check(void)
1068 {
1069         page_t *pp, *pp0, *pp1, *pp2;
1070         page_list_t fl;
1071         pte_t *ptep;
1072
1073         // should be able to allocate three pages
1074         pp0 = pp1 = pp2 = 0;
1075         assert(page_alloc(&pp0) == 0);
1076         assert(page_alloc(&pp1) == 0);
1077         assert(page_alloc(&pp2) == 0);
1078
1079         assert(pp0);
1080         assert(pp1 && pp1 != pp0);
1081         assert(pp2 && pp2 != pp1 && pp2 != pp0);
1082
1083         // temporarily steal the rest of the free pages
1084         fl = page_free_list;
1085         LIST_INIT(&page_free_list);
1086
1087         // should be no free memory
1088         assert(page_alloc(&pp) == -E_NO_MEM);
1089
1090         // Fill pp1 with bogus data and check for invalid tlb entries
1091         memset(page2kva(pp1), 0xFFFFFFFF, PGSIZE);
1092
1093         // there is no page allocated at address 0
1094         assert(page_lookup(boot_pgdir, (void *) 0x0, &ptep) == NULL);
1095
1096         // there is no free memory, so we can't allocate a page table 
1097         assert(page_insert(boot_pgdir, pp1, 0x0, 0) < 0);
1098
1099         // free pp0 and try again: pp0 should be used for page table
1100         page_free(pp0);
1101         assert(page_insert(boot_pgdir, pp1, 0x0, 0) == 0);
1102         tlb_invalidate(boot_pgdir, 0x0);
1103         // DEP Should have shot down invalid TLB entry - let's check
1104         {
1105           int *x = 0x0;
1106           assert(*x == 0xFFFFFFFF);
1107         }
1108         assert(PTE_ADDR(boot_pgdir[0]) == page2pa(pp0));
1109         assert(check_va2pa(boot_pgdir, 0x0) == page2pa(pp1));
1110         assert(pp1->pp_ref == 1);
1111         assert(pp0->pp_ref == 1);
1112
1113         // should be able to map pp2 at PGSIZE because pp0 is already allocated for page table
1114         assert(page_insert(boot_pgdir, pp2, (void*) PGSIZE, 0) == 0);
1115         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp2));
1116         assert(pp2->pp_ref == 1);
1117
1118         // Make sure that pgdir_walk returns a pointer to the pte and
1119         // not the table or some other garbage
1120         {
1121           pte_t *p = KADDR(PTE_ADDR(boot_pgdir[PDX(PGSIZE)]));
1122           assert(pgdir_walk(boot_pgdir, (void *)PGSIZE, 0) == &p[PTX(PGSIZE)]);
1123         }
1124
1125         // should be no free memory
1126         assert(page_alloc(&pp) == -E_NO_MEM);
1127
1128         // should be able to map pp2 at PGSIZE because it's already there
1129         assert(page_insert(boot_pgdir, pp2, (void*) PGSIZE, PTE_U) == 0);
1130         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp2));
1131         assert(pp2->pp_ref == 1);
1132
1133         // Make sure that we actually changed the permission on pp2 when we re-mapped it
1134         {
1135           pte_t *p = pgdir_walk(boot_pgdir, (void*)PGSIZE, 0);
1136           assert(((*p) & PTE_U) == PTE_U);
1137         }
1138
1139         // pp2 should NOT be on the free list
1140         // could happen in ref counts are handled sloppily in page_insert
1141         assert(page_alloc(&pp) == -E_NO_MEM);
1142
1143         // should not be able to map at PTSIZE because need free page for page table
1144         assert(page_insert(boot_pgdir, pp0, (void*) PTSIZE, 0) < 0);
1145
1146         // insert pp1 at PGSIZE (replacing pp2)
1147         assert(page_insert(boot_pgdir, pp1, (void*) PGSIZE, 0) == 0);
1148
1149         // should have pp1 at both 0 and PGSIZE, pp2 nowhere, ...
1150         assert(check_va2pa(boot_pgdir, 0) == page2pa(pp1));
1151         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp1));
1152         // ... and ref counts should reflect this
1153         assert(pp1->pp_ref == 2);
1154         assert(pp2->pp_ref == 0);
1155
1156         // pp2 should be returned by page_alloc
1157         assert(page_alloc(&pp) == 0 && pp == pp2);
1158
1159         // unmapping pp1 at 0 should keep pp1 at PGSIZE
1160         page_remove(boot_pgdir, 0x0);
1161         assert(check_va2pa(boot_pgdir, 0x0) == ~0);
1162         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp1));
1163         assert(pp1->pp_ref == 1);
1164         assert(pp2->pp_ref == 0);
1165
1166         // unmapping pp1 at PGSIZE should free it
1167         page_remove(boot_pgdir, (void*) PGSIZE);
1168         assert(check_va2pa(boot_pgdir, 0x0) == ~0);
1169         assert(check_va2pa(boot_pgdir, PGSIZE) == ~0);
1170         assert(pp1->pp_ref == 0);
1171         assert(pp2->pp_ref == 0);
1172
1173         // so it should be returned by page_alloc
1174         assert(page_alloc(&pp) == 0 && pp == pp1);
1175
1176         // should be no free memory
1177         assert(page_alloc(&pp) == -E_NO_MEM);
1178
1179         // forcibly take pp0 back
1180         assert(PTE_ADDR(boot_pgdir[0]) == page2pa(pp0));
1181         boot_pgdir[0] = 0;
1182         assert(pp0->pp_ref == 1);
1183         pp0->pp_ref = 0;
1184
1185         // Catch invalid pointer addition in pgdir_walk - i.e. pgdir + PDX(va)
1186         {
1187           // Give back pp0 for a bit
1188           page_free(pp0);
1189
1190           void * va = (void *)((PGSIZE * NPDENTRIES) + PGSIZE);
1191           pte_t *p2 = pgdir_walk(boot_pgdir, va, 1);
1192           pte_t *p = KADDR(PTE_ADDR(boot_pgdir[PDX(va)]));
1193           assert(p2 == &p[PTX(va)]);
1194
1195           // Clean up again
1196           boot_pgdir[PDX(va)] = 0;
1197           pp0->pp_ref = 0;
1198         }
1199
1200         // give free list back
1201         page_free_list = fl;
1202
1203         // free the pages we took
1204         page_free(pp0);
1205         page_free(pp1);
1206         page_free(pp2);
1207
1208         cprintf("page_check() succeeded!\n");
1209 }
1210
1211 /* 
1212
1213     // testing code for boot_pgdir_walk 
1214         pte_t* temp;
1215         temp = boot_pgdir_walk(pgdir, VPT + (VPT >> 10), 1);
1216         cprintf("pgdir = %p\n", pgdir);
1217         cprintf("test recursive walking pte_t* = %p\n", temp);
1218         cprintf("test recursive walking entry = %p\n", PTE_ADDR(temp));
1219         temp = boot_pgdir_walk(pgdir, 0xc0400000, 1);
1220         cprintf("LA = 0xc0400000 = %p\n", temp);
1221         temp = boot_pgdir_walk(pgdir, 0xc0400070, 1);
1222         cprintf("LA = 0xc0400070 = %p\n", temp);
1223         temp = boot_pgdir_walk(pgdir, 0xc0800000, 0);
1224         cprintf("LA = 0xc0800000, no create = %p\n", temp);
1225         temp = boot_pgdir_walk(pgdir, 0xc0600070, 1);
1226         cprintf("LA = 0xc0600070 = %p\n", temp);
1227         temp = boot_pgdir_walk(pgdir, 0xc0600090, 0);
1228         cprintf("LA = 0xc0600090, nc = %p\n", temp);
1229         temp = boot_pgdir_walk(pgdir, 0xc0608070, 0);
1230         cprintf("LA = 0xc0608070, nc = %p\n", temp);
1231         temp = boot_pgdir_walk(pgdir, 0xc0800070, 1);
1232         cprintf("LA = 0xc0800070 = %p\n", temp);
1233         temp = boot_pgdir_walk(pgdir, 0xc0b00070, 0);
1234         cprintf("LA = 0xc0b00070, nc = %p\n", temp);
1235         temp = boot_pgdir_walk(pgdir, 0xc0c00000, 0);
1236         cprintf("LA = 0xc0c00000, nc = %p\n", temp);
1237
1238         // testing for boot_map_seg
1239         cprintf("\n");
1240         cprintf("before mapping 1 page to 0x00350000\n");
1241         cprintf("0xc4000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc4000000, 1));
1242         cprintf("0xc4000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc4000000, 1)));
1243         boot_map_segment(pgdir, 0xc4000000, 4096, 0x00350000, PTE_W);
1244         cprintf("after mapping\n");
1245         cprintf("0xc4000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc4000000, 1));
1246         cprintf("0xc4000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc4000000, 1)));
1247
1248         cprintf("\n");
1249         cprintf("before mapping 3 pages to 0x00700000\n");
1250         cprintf("0xd0000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0000000, 1));
1251         cprintf("0xd0000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0000000, 1)));
1252         cprintf("0xd0001000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0001000, 1));
1253         cprintf("0xd0001000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0001000, 1)));
1254         cprintf("0xd0002000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0002000, 1));
1255         cprintf("0xd0002000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0002000, 1)));
1256         boot_map_segment(pgdir, 0xd0000000, 4096*3, 0x00700000, 0);
1257         cprintf("after mapping\n");
1258         cprintf("0xd0000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0000000, 1));
1259         cprintf("0xd0000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0000000, 1)));
1260         cprintf("0xd0001000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0001000, 1));
1261         cprintf("0xd0001000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0001000, 1)));
1262         cprintf("0xd0002000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0002000, 1));
1263         cprintf("0xd0002000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0002000, 1)));
1264
1265         cprintf("\n");
1266         cprintf("before mapping 1 unaligned to 0x00500010\n");
1267         cprintf("0xc8000010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8000010, 1));
1268         cprintf("0xc8000010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8000010, 1)));
1269         cprintf("0xc8001010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8001010, 1));
1270         cprintf("0xc8001010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8001010, 1)));
1271         boot_map_segment(pgdir, 0xc8000010, 4096, 0x00500010, PTE_W);
1272         cprintf("after mapping\n");
1273         cprintf("0xc8000010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8000010, 1));
1274         cprintf("0xc8000010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8000010, 1)));
1275         cprintf("0xc8001010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8001010, 1));
1276         cprintf("0xc8001010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8001010, 1)));
1277
1278         cprintf("\n");
1279         boot_map_segment(pgdir, 0xe0000000, 4096, 0x10000000, PTE_W);
1280
1281 */