Lab3 initial merge
[akaros.git] / kern / pmap.c
1 /* See COPYRIGHT for copyright information. */
2
3 #include <inc/x86.h>
4 #include <inc/mmu.h>
5 #include <inc/error.h>
6 #include <inc/string.h>
7 #include <inc/assert.h>
8
9 #include <kern/pmap.h>
10 #include <kern/kclock.h>
11 #include <kern/env.h>
12
13 // These variables are set by i386_detect_memory()
14 static physaddr_t maxpa;        // Maximum physical address
15 size_t npage;                   // Amount of physical memory (in pages)
16 static size_t basemem;          // Amount of base memory (in bytes)
17 static size_t extmem;           // Amount of extended memory (in bytes)
18
19 // These variables are set in i386_vm_init()
20 pde_t* boot_pgdir;              // Virtual address of boot time page directory
21 physaddr_t boot_cr3;            // Physical address of boot time page directory
22 static char* boot_freemem;      // Pointer to next byte of free mem
23
24 struct Page* pages;             // Virtual address of physical page array
25 static struct Page_list page_free_list; // Free list of physical pages
26
27 // Global descriptor table.
28 //
29 // The kernel and user segments are identical (except for the DPL).
30 // To load the SS register, the CPL must equal the DPL.  Thus,
31 // we must duplicate the segments for the user and the kernel.
32 //
33 struct Segdesc gdt[] =
34 {
35         // 0x0 - unused (always faults -- for trapping NULL far pointers)
36         SEG_NULL,
37
38         // 0x8 - kernel code segment
39         [GD_KT >> 3] = SEG(STA_X | STA_R, 0x0, 0xffffffff, 0),
40
41         // 0x10 - kernel data segment
42         [GD_KD >> 3] = SEG(STA_W, 0x0, 0xffffffff, 0),
43
44         // 0x18 - user code segment
45         [GD_UT >> 3] = SEG(STA_X | STA_R, 0x0, 0xffffffff, 3),
46
47         // 0x20 - user data segment
48         [GD_UD >> 3] = SEG(STA_W, 0x0, 0xffffffff, 3),
49
50         // 0x28 - tss, initialized in idt_init()
51         [GD_TSS >> 3] = SEG_NULL
52 };
53
54 struct Pseudodesc gdt_pd = {
55         sizeof(gdt) - 1, (unsigned long) gdt
56 };
57
58 static int
59 nvram_read(int r)
60 {
61         return mc146818_read(r) | (mc146818_read(r + 1) << 8);
62 }
63
64 void
65 i386_detect_memory(void)
66 {
67         /* For shit BIOS reasons, this isn't seeing any more than 64MB,
68          * explained a little here: 
69          * http://exec.h1.ru/docs/os-devel-faq/os-faq-memory.html
70          */
71
72         // CMOS tells us how many kilobytes there are
73         basemem = ROUNDDOWN(nvram_read(NVRAM_BASELO)*1024, PGSIZE);
74         extmem = ROUNDDOWN(nvram_read(NVRAM_EXTLO)*1024, PGSIZE);
75
76         // Calculate the maximum physical address based on whether
77         // or not there is any extended memory.  See comment in <inc/memlayout.h>
78         if (extmem)
79                 maxpa = EXTPHYSMEM + extmem;
80         else
81                 maxpa = basemem;
82
83         npage = maxpa / PGSIZE;
84
85         cprintf("Physical memory: %dK available, ", (int)(maxpa/1024));
86         cprintf("base = %dK, extended = %dK\n", (int)(basemem/1024), (int)(extmem/1024));
87 }
88
89 // --------------------------------------------------------------
90 // Set up initial memory mappings and turn on MMU.
91 // --------------------------------------------------------------
92
93 static void check_boot_pgdir(bool pse);
94
95 //
96 // Allocate n bytes of physical memory aligned on an 
97 // align-byte boundary.  Align must be a power of two.
98 // Return kernel virtual address.  Returned memory is uninitialized.
99 //
100 // If we're out of memory, boot_alloc should panic.
101 // This function may ONLY be used during initialization,
102 // before the page_free_list has been set up.
103 // 
104 static void*
105 boot_alloc(uint32_t n, uint32_t align)
106 {
107         extern char end[];
108         void *v;
109
110         // Initialize boot_freemem if this is the first time.
111         // 'end' is a magic symbol automatically generated by the linker,
112         // which points to the end of the kernel's bss segment -
113         // i.e., the first virtual address that the linker
114         // did _not_ assign to any kernel code or global variables.
115         if (boot_freemem == 0)
116                 boot_freemem = end;
117
118         //      Step 1: round boot_freemem up to be aligned properly
119         boot_freemem = ROUNDUP(boot_freemem, align);
120
121         //      Step 2: save current value of boot_freemem as allocated chunk
122         v = boot_freemem;
123         //  Step 2.5: check if we can alloc
124         if (PADDR(boot_freemem + n) > maxpa)
125                 panic("Out of memory in boot alloc, you fool!\n");
126         //      Step 3: increase boot_freemem to record allocation
127         boot_freemem += n;      
128         //      Step 4: return allocated chunk
129         return v;
130 }
131
132 //
133 // Given pgdir, a pointer to a page directory,
134 // walk the 2-level page table structure to find
135 // the page table entry (PTE) for linear address la.
136 // Return a pointer to this PTE.
137 //
138 // If the relevant page table doesn't exist in the page directory:
139 //      - If create == 0, return 0.
140 //      - Otherwise allocate a new page table, install it into pgdir,
141 //        and return a pointer into it.
142 //        (Questions: What data should the new page table contain?
143 //        And what permissions should the new pgdir entry have?
144 //        Note that we use the 486-only "WP" feature of %cr0, which
145 //        affects the way supervisor-mode writes are checked.)
146 //
147 // This function abstracts away the 2-level nature of
148 // the page directory by allocating new page tables
149 // as needed.
150 // 
151 // boot_pgdir_walk may ONLY be used during initialization,
152 // before the page_free_list has been set up.
153 // It should panic on failure.  (Note that boot_alloc already panics
154 // on failure.)
155 //
156 // Supports returning jumbo (4MB PSE) PTEs.  To create with a jumbo, pass in 2.
157 // 
158 static pte_t*
159 boot_pgdir_walk(pde_t *pgdir, uintptr_t la, int create)
160 {
161         pde_t* the_pde = &pgdir[PDX(la)];
162         void* new_table;
163
164         if (*the_pde & PTE_P) {
165                 if (*the_pde & PTE_PS)
166                         return (pte_t*)the_pde;
167                 return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(la)];
168         }
169         if (!create)
170                 return NULL;
171         if (create == 2) {
172                 if (JPGOFF(la))
173                         panic("Attempting to find a Jumbo PTE at an unaligned VA!");
174                 *the_pde = PTE_PS | PTE_P;
175                 return (pte_t*)the_pde;
176         }
177         new_table = boot_alloc(PGSIZE, PGSIZE);
178         memset(new_table, 0, PGSIZE);
179         *the_pde = (pde_t)PADDR(new_table) | PTE_P | PTE_W;
180         return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(la)];
181 }
182
183 //
184 // Map [la, la+size) of linear address space to physical [pa, pa+size)
185 // in the page table rooted at pgdir.  Size is a multiple of PGSIZE.
186 // Use permission bits perm|PTE_P for the entries.
187 //
188 // This function may ONLY be used during initialization,
189 // before the page_free_list has been set up.
190 //
191 // To map with Jumbos, set PTE_PS in perm
192 static void
193 boot_map_segment(pde_t *pgdir, uintptr_t la, size_t size, physaddr_t pa, int perm)
194 {
195         uintptr_t i;
196         pte_t *pte;
197         // la can be page unaligned, but weird things will happen
198         // unless pa has the same offset.  pa always truncates any
199         // possible offset.  will warn.  size can be weird too. 
200         if (PGOFF(la)) {
201                 warn("la not page aligned in boot_map_segment!");
202                 size += PGOFF(la);
203         }
204         // even though our maxpa doesn't go above 64MB yet...
205         if (pa + size > maxpa)
206                 warn("Attempting to map to physical memory beyond maxpa!");
207         if (perm & PTE_PS) {
208                 if (JPGOFF(la) || JPGOFF(pa))
209                         panic("Tried to map a Jumbo page at an unaligned address!");
210                 // need to index with i instead of la + size, in case of wrap-around
211                 for (i = 0; i < size; i += JPGSIZE, la += JPGSIZE, pa += JPGSIZE) {
212                         pte = boot_pgdir_walk(pgdir, la, 2);
213                         *pte = PTE_ADDR(pa) | PTE_P | perm;
214                 }
215         } else {
216                 for (i = 0; i < size; i += PGSIZE, la += PGSIZE, pa += PGSIZE) {
217                         pte = boot_pgdir_walk(pgdir, la, 1);
218                         *pte = PTE_ADDR(pa) | PTE_P | perm;
219                 }
220         }
221 }
222
223 // Set up a two-level page table:
224 //    boot_pgdir is its linear (virtual) address of the root
225 //    boot_cr3 is the physical adresss of the root
226 // Then turn on paging.  Then effectively turn off segmentation.
227 // (i.e., the segment base addrs are set to zero).
228 // 
229 // This function only sets up the kernel part of the address space
230 // (ie. addresses >= UTOP).  The user part of the address space
231 // will be setup later.
232 //
233 // From UTOP to ULIM, the user is allowed to read but not write.
234 // Above ULIM the user cannot read (or write). 
235 void
236 i386_vm_init(void)
237 {
238         pde_t* pgdir;
239         uint32_t cr0;
240         size_t n;
241         bool pse;
242
243         // check for PSE support (TODO)
244         pse = 1;
245         // turn on PSE
246         if (pse) {
247                 uint32_t cr4;
248                 cr4 = rcr4();
249                 cr4 |= CR4_PSE;
250                 lcr4(cr4);
251         }
252
253         /*
254          * PSE status: 
255          * - can walk and set up boot_map_segments with jumbos but can't
256          *   insert yet.  
257          * - anything related to a single struct Page still can't handle 
258          *   jumbos.  will need to think about and adjust Page functions
259          * - do we want to store info like this in the struct Page?  or just check
260          *   by walking the PTE
261          * - when we alloc a page, and we want it to be 4MB, we'll need
262          *   to have contiguous memory, etc
263          * - there's a difference between having 4MB page table entries
264          *   and having 4MB Page tracking structs.  changing the latter will
265          *   break a lot of things
266          * - showmapping and friends work on a 4KB granularity, but map to the
267          *   correct entries
268          */
269
270         //////////////////////////////////////////////////////////////////////
271         // create initial page directory.
272         pgdir = boot_alloc(PGSIZE, PGSIZE);
273         memset(pgdir, 0, PGSIZE);
274         boot_pgdir = pgdir;
275         boot_cr3 = PADDR(pgdir);
276
277         //////////////////////////////////////////////////////////////////////
278         // Recursively insert PD in itself as a page table, to form
279         // a virtual page table at virtual address VPT.
280         // (For now, you don't have understand the greater purpose of the
281         // following two lines.  Unless you are eagle-eyed, in which case you
282         // should already know.)
283
284         // Permissions: kernel RW, user NONE
285         pgdir[PDX(VPT)] = PADDR(pgdir)|PTE_W|PTE_P;
286
287         // same for UVPT
288         // Permissions: kernel R, user R 
289         pgdir[PDX(UVPT)] = PADDR(pgdir)|PTE_U|PTE_P;
290
291         //////////////////////////////////////////////////////////////////////
292         // Map the kernel stack (symbol name "bootstack").  The complete VA
293         // range of the stack, [KSTACKTOP-PTSIZE, KSTACKTOP), breaks into two
294         // pieces:
295         //     * [KSTACKTOP-KSTKSIZE, KSTACKTOP) -- backed by physical memory
296         //     * [KSTACKTOP-PTSIZE, KSTACKTOP-KSTKSIZE) -- not backed => faults
297         //     Permissions: kernel RW, user NONE
298         // Your code goes here:
299
300         // remember that the space for the kernel stack is allocated in the binary.
301         // bootstack and bootstacktop point to symbols in the data section, which 
302         // at this point are like 0xc010b000.  KSTACKTOP is the desired loc in VM
303         boot_map_segment(pgdir, (uintptr_t)KSTACKTOP - KSTKSIZE, 
304                          KSTKSIZE, PADDR(bootstack), PTE_W);
305
306         //////////////////////////////////////////////////////////////////////
307         // Map all of physical memory at KERNBASE. 
308         // Ie.  the VA range [KERNBASE, 2^32) should map to
309         //      the PA range [0, 2^32 - KERNBASE)
310         // We might not have 2^32 - KERNBASE bytes of physical memory, but
311         // we just set up the mapping anyway.
312         // Permissions: kernel RW, user NONE
313         // Your code goes here: 
314         
315         // this maps all of the possible phys memory
316         // note the use of unsigned underflow to get size = 0x40000000
317         //boot_map_segment(pgdir, KERNBASE, -KERNBASE, 0, PTE_W);
318         // but this only maps what is available, and saves memory.  every 4MB of
319         // mapped memory requires a 2nd level page: 2^10 entries, each covering 2^12
320         // need to modify tests below to account for this
321         if (pse)
322                 boot_map_segment(pgdir, KERNBASE, maxpa, 0, PTE_W | PTE_PS);
323         else
324                 boot_map_segment(pgdir, KERNBASE, maxpa, 0, PTE_W );
325
326         //////////////////////////////////////////////////////////////////////
327         // Make 'pages' point to an array of size 'npage' of 'struct Page'.
328         // The kernel uses this structure to keep track of physical pages;
329         // 'npage' equals the number of physical pages in memory.  User-level
330         // programs get read-only access to the array as well.
331         // You must allocate the array yourself.
332         // Map this array read-only by the user at linear address UPAGES
333         // (ie. perm = PTE_U | PTE_P)
334         // Permissions:
335         //    - pages -- kernel RW, user NONE
336         //    - the read-only version mapped at UPAGES -- kernel R, user R
337         // Your code goes here: 
338         
339         // round up to the nearest page
340         size_t page_array_size = ROUNDUP(npage*sizeof(struct Page), PGSIZE);
341         pages = (struct Page*)boot_alloc(page_array_size, PGSIZE);
342         memset(pages, 0, page_array_size);
343         if (page_array_size > PTSIZE) {
344                 warn("page_array_size bigger than PTSIZE, userland will not see all pages");
345                 page_array_size = PTSIZE;
346         }
347         boot_map_segment(pgdir, UPAGES, page_array_size, PADDR(pages), PTE_U);
348
349         //////////////////////////////////////////////////////////////////////
350         // Make 'envs' point to an array of size 'NENV' of 'struct Env'.
351         // Map this array read-only by the user at linear address UENVS
352         // (ie. perm = PTE_U | PTE_P).
353         // Permissions:
354         //    - envs itself -- kernel RW, user NONE
355         //    - the image of envs mapped at UENVS  -- kernel R, user R
356         
357         // LAB 3: Your code here.
358
359         // Check that the initial page directory has been set up correctly.
360         check_boot_pgdir(pse);
361
362         //////////////////////////////////////////////////////////////////////
363         // On x86, segmentation maps a VA to a LA (linear addr) and
364         // paging maps the LA to a PA.  I.e. VA => LA => PA.  If paging is
365         // turned off the LA is used as the PA.  Note: there is no way to
366         // turn off segmentation.  The closest thing is to set the base
367         // address to 0, so the VA => LA mapping is the identity.
368
369         // Current mapping: VA KERNBASE+x => PA x.
370         //     (segmentation base=-KERNBASE and paging is off)
371
372         // From here on down we must maintain this VA KERNBASE + x => PA x
373         // mapping, even though we are turning on paging and reconfiguring
374         // segmentation.
375
376         // Map VA 0:4MB same as VA KERNBASE, i.e. to PA 0:4MB.
377         // (Limits our kernel to <4MB)
378         /* They mean linear address 0:4MB, and the kernel < 4MB is only until 
379          * segmentation is turned off.
380          * once we turn on paging, segmentation is still on, so references to
381          * KERNBASE+x will get mapped to linear address x, which we need to make 
382          * sure can map to phys addr x, until we can turn off segmentation and
383          * KERNBASE+x maps to LA KERNBASE+x, which maps to PA x, via paging
384          */
385         pgdir[0] = pgdir[PDX(KERNBASE)];
386
387         // Install page table.
388         lcr3(boot_cr3);
389
390         // Turn on paging.
391         cr0 = rcr0();
392         // not sure why they turned on TS and EM here.  or anything other 
393         // than PG and WP
394         cr0 |= CR0_PE|CR0_PG|CR0_AM|CR0_WP|CR0_NE|CR0_TS|CR0_EM|CR0_MP;
395         cr0 &= ~(CR0_TS|CR0_EM);
396         lcr0(cr0);
397
398         // Current mapping: KERNBASE+x => x => x.
399         // (x < 4MB so uses paging pgdir[0])
400
401         // Reload all segment registers.
402         asm volatile("lgdt gdt_pd");
403         asm volatile("movw %%ax,%%gs" :: "a" (GD_UD|3));
404         asm volatile("movw %%ax,%%fs" :: "a" (GD_UD|3));
405         asm volatile("movw %%ax,%%es" :: "a" (GD_KD));
406         asm volatile("movw %%ax,%%ds" :: "a" (GD_KD));
407         asm volatile("movw %%ax,%%ss" :: "a" (GD_KD));
408         asm volatile("ljmp %0,$1f\n 1:\n" :: "i" (GD_KT));  // reload cs
409         asm volatile("lldt %%ax" :: "a" (0));
410
411         // Final mapping: KERNBASE+x => KERNBASE+x => x.
412
413         // This mapping was only used after paging was turned on but
414         // before the segment registers were reloaded.
415         pgdir[0] = 0;
416
417         // Flush the TLB for good measure, to kill the pgdir[0] mapping.
418         lcr3(boot_cr3);
419 }
420
421 //
422 // Checks that the kernel part of virtual address space
423 // has been setup roughly correctly(by i386_vm_init()).
424 //
425 // This function doesn't test every corner case,
426 // in fact it doesn't test the permission bits at all,
427 // but it is a pretty good sanity check. 
428 //
429 static physaddr_t check_va2pa(pde_t *pgdir, uintptr_t va);
430
431 static void
432 check_boot_pgdir(bool pse)
433 {
434         uint32_t i, n;
435         pde_t *pgdir;
436
437         pgdir = boot_pgdir;
438
439         // check pages array
440         n = ROUNDUP(npage*sizeof(struct Page), PGSIZE);
441         for (i = 0; i < n; i += PGSIZE)
442                 assert(check_va2pa(pgdir, UPAGES + i) == PADDR(pages) + i);
443
444         /* // TODO - turn this on
445         // check envs array (new test for lab 3)
446         n = ROUNDUP(NENV*sizeof(struct Env), PGSIZE);
447         for (i = 0; i < n; i += PGSIZE)
448                 assert(check_va2pa(pgdir, UENVS + i) == PADDR(envs) + i);
449         */
450
451         // check phys mem
452         //for (i = 0; KERNBASE + i != 0; i += PGSIZE)
453         // adjusted check to account for only mapping avail mem
454         if (pse)
455                 for (i = 0; i < maxpa; i += JPGSIZE)
456                         assert(check_va2pa(pgdir, KERNBASE + i) == i);
457         else
458                 for (i = 0; i < maxpa; i += PGSIZE)
459                         assert(check_va2pa(pgdir, KERNBASE + i) == i);
460                 
461
462         // check kernel stack
463         for (i = 0; i < KSTKSIZE; i += PGSIZE)
464                 assert(check_va2pa(pgdir, KSTACKTOP - KSTKSIZE + i) == PADDR(bootstack) + i);
465
466         // check for zero/non-zero in PDEs
467         for (i = 0; i < NPDENTRIES; i++) {
468                 switch (i) {
469                 case PDX(VPT):
470                 case PDX(UVPT):
471                 case PDX(KSTACKTOP-1):
472                 case PDX(UPAGES):
473                 //case PDX(UENVS): // TODO - turn this on
474                         assert(pgdir[i]);
475                         break;
476                 default:
477                         //if (i >= PDX(KERNBASE))
478                         // adjusted check to account for only mapping avail mem
479                         // and you can't KADDR maxpa (just above legal range)
480                         if (i >= PDX(KERNBASE) && i <= PDX(KADDR(maxpa-1)))
481                                 assert(pgdir[i]);
482                         else
483                                 assert(pgdir[i] == 0);
484                         break;
485                 }
486         }
487         cprintf("check_boot_pgdir() succeeded!\n");
488 }
489
490 // This function returns the physical address of the page containing 'va',
491 // defined by the page directory 'pgdir'.  The hardware normally performs
492 // this functionality for us!  We define our own version to help check
493 // the check_boot_pgdir() function; it shouldn't be used elsewhere.
494
495 static physaddr_t
496 check_va2pa(pde_t *pgdir, uintptr_t va)
497 {
498         pte_t *p;
499
500         pgdir = &pgdir[PDX(va)];
501         if (!(*pgdir & PTE_P))
502                 return ~0;
503         if (*pgdir & PTE_PS)
504                 return PTE_ADDR(*pgdir);
505         p = (pte_t*) KADDR(PTE_ADDR(*pgdir));
506         if (!(p[PTX(va)] & PTE_P))
507                 return ~0;
508         return PTE_ADDR(p[PTX(va)]);
509 }
510                 
511 // --------------------------------------------------------------
512 // Tracking of physical pages.
513 // The 'pages' array has one 'struct Page' entry per physical page.
514 // Pages are reference counted, and free pages are kept on a linked list.
515 // --------------------------------------------------------------
516
517 //  
518 // Initialize page structure and memory free list.
519 // After this point, ONLY use the functions below
520 // to allocate and deallocate physical memory via the page_free_list,
521 // and NEVER use boot_alloc() or the related boot-time functions above.
522 //
523 void
524 page_init(void)
525 {
526         // The example code here marks all pages as free.
527         // However this is not truly the case.  What memory is free?
528         //  1) Mark page 0 as in use.
529         //     This way we preserve the real-mode IDT and BIOS structures
530         //     in case we ever need them.  (Currently we don't, but...)
531         //  2) Mark the rest of base memory as free.
532         //  3) Then comes the IO hole [IOPHYSMEM, EXTPHYSMEM).
533         //     Mark it as in use so that it can never be allocated.      
534         //  4) Then extended memory [EXTPHYSMEM, ...).
535         //     Some of it is in use, some is free. Where is the kernel?
536         //     Which pages are used for page tables and other data structures?
537         //
538         // Change the code to reflect this.
539         int i;
540         physaddr_t physaddr_after_kernel = PADDR(ROUNDUP(boot_freemem, PGSIZE));
541         LIST_INIT(&page_free_list);
542
543         pages[0].pp_ref = 1;
544         for (i = 1; i < PPN(IOPHYSMEM); i++) {
545                 pages[i].pp_ref = 0;
546                 LIST_INSERT_HEAD(&page_free_list, &pages[i], pp_link);
547         }
548         for (i = PPN(IOPHYSMEM); i < PPN(EXTPHYSMEM); i++) {
549                 pages[i].pp_ref = 1;
550         }
551         for (i = PPN(EXTPHYSMEM); i < PPN(physaddr_after_kernel); i++) {
552                 pages[i].pp_ref = 1;
553         }
554         for (i = PPN(physaddr_after_kernel); i < npage; i++) {
555                 pages[i].pp_ref = 0;
556                 LIST_INSERT_HEAD(&page_free_list, &pages[i], pp_link);
557         }
558 }
559
560 //
561 // Initialize a Page structure.
562 // The result has null links and 0 refcount.
563 // Note that the corresponding physical page is NOT initialized!
564 //
565 static void
566 page_initpp(struct Page *pp)
567 {
568         memset(pp, 0, sizeof(*pp));
569 }
570
571 //
572 // Allocates a physical page.
573 // Does NOT set the contents of the physical page to zero -
574 // the caller must do that if necessary.
575 //
576 // *pp_store -- is set to point to the Page struct of the newly allocated
577 // page
578 //
579 // RETURNS 
580 //   0 -- on success
581 //   -E_NO_MEM -- otherwise 
582 //
583 // Hint: use LIST_FIRST, LIST_REMOVE, and page_initpp
584 // Hint: pp_ref should not be incremented 
585 int
586 page_alloc(struct Page **pp_store)
587 {
588         if (LIST_EMPTY(&page_free_list))
589                 return -E_NO_MEM;
590         *pp_store = LIST_FIRST(&page_free_list);
591         LIST_REMOVE(*pp_store, pp_link);
592         page_initpp(*pp_store);
593         return 0;
594 }
595
596 //
597 // Return a page to the free list.
598 // (This function should only be called when pp->pp_ref reaches 0.)
599 //
600 void
601 page_free(struct Page *pp)
602 {
603         if (pp->pp_ref)
604                 panic("Attempting to free page with non-zero reference count!");
605         LIST_INSERT_HEAD(&page_free_list, pp, pp_link);
606 }
607
608 //
609 // Decrement the reference count on a page,
610 // freeing it if there are no more refs.
611 //
612 void
613 page_decref(struct Page* pp)
614 {
615         if (--pp->pp_ref == 0)
616                 page_free(pp);
617 }
618
619 // Given 'pgdir', a pointer to a page directory, pgdir_walk returns
620 // a pointer to the page table entry (PTE) for linear address 'va'.
621 // This requires walking the two-level page table structure.
622 //
623 // If the relevant page table doesn't exist in the page directory, then:
624 //    - If create == 0, pgdir_walk returns NULL.
625 //    - Otherwise, pgdir_walk tries to allocate a new page table
626 //      with page_alloc.  If this fails, pgdir_walk returns NULL.
627 //    - Otherwise, pgdir_walk returns a pointer into the new page table.
628 //
629 // This is boot_pgdir_walk, but using page_alloc() instead of boot_alloc().
630 // Unlike boot_pgdir_walk, pgdir_walk can fail.
631 //
632 // Hint: you can turn a Page * into the physical address of the
633 // page it refers to with page2pa() from kern/pmap.h.
634 //
635 // Supports returning jumbo (4MB PSE) PTEs.  To create with a jumbo, pass in 2.
636 pte_t*
637 pgdir_walk(pde_t *pgdir, const void *va, int create)
638 {
639         pde_t* the_pde = &pgdir[PDX(va)];
640         struct Page* new_table;
641
642         if (*the_pde & PTE_P) {
643                 if (*the_pde & PTE_PS)
644                         return (pte_t*)the_pde;
645                 return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(va)];
646         }
647         if (!create)
648                 return NULL;
649         if (create == 2) {
650                 if (JPGOFF(va))
651                         panic("Attempting to find a Jumbo PTE at an unaligned VA!");
652                 *the_pde = PTE_PS | PTE_P;
653                 return (pte_t*)the_pde;
654         }
655         if (page_alloc(&new_table))
656                 return NULL;
657         new_table->pp_ref = 1;
658         memset(page2kva(new_table), 0, PGSIZE);
659         *the_pde = (pde_t)page2pa(new_table) | PTE_P | PTE_W;
660         return &((pde_t*)KADDR(PTE_ADDR(*the_pde)))[PTX(va)];
661 }
662 //
663 // Map the physical page 'pp' at virtual address 'va'.
664 // The permissions (the low 12 bits) of the page table
665 //  entry should be set to 'perm|PTE_P'.
666 //
667 // Details
668 //   - If there is already a page mapped at 'va', it is page_remove()d.
669 //   - If necessary, on demand, allocates a page table and inserts it into
670 //     'pgdir'.
671 //   - pp->pp_ref should be incremented if the insertion succeeds.
672 //   - The TLB must be invalidated if a page was formerly present at 'va'.
673 //     (this is handled in page_remove)
674 //
675 // RETURNS: 
676 //   0 on success
677 //   -E_NO_MEM, if page table couldn't be allocated
678 //
679 // Hint: The TA solution is implemented using pgdir_walk, page_remove,
680 // and page2pa.
681 //
682 int
683 page_insert(pde_t *pgdir, struct Page *pp, void *va, int perm) 
684 {
685         pte_t* pte = pgdir_walk(pgdir, va, 1);
686         if (!pte)
687                 return -E_NO_MEM;
688         // need to up the ref count in case pp is already mapped at va
689         // and we don't want to page_remove (which could free pp) and then 
690         // continue as if pp wasn't freed.  moral = up the ref asap
691         pp->pp_ref++;
692         if (*pte & PTE_P) {
693                 page_remove(pgdir, va);
694         }
695         *pte = page2pa(pp) | PTE_P | perm;
696         return 0;
697 }
698
699 //
700 // Return the page mapped at virtual address 'va'.
701 // If pte_store is not zero, then we store in it the address
702 // of the pte for this page.  This is used by page_remove
703 // but should not be used by other callers.
704 //
705 // Return 0 if there is no page mapped at va.
706 //
707 // Hint: the TA solution uses pgdir_walk and pa2page.
708 //
709 // For jumbos, right now this returns the first Page* in the 4MB
710 struct Page *
711 page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
712 {
713         pte_t* pte = pgdir_walk(pgdir, va, 0);
714         if (!pte || !(*pte & PTE_P))
715                 return 0;
716         if (pte_store)
717                 *pte_store = pte;
718         return pa2page(PTE_ADDR(*pte));
719 }
720
721 //
722 // Unmaps the physical page at virtual address 'va'.
723 // If there is no physical page at that address, silently does nothing.
724 //
725 // Details:
726 //   - The ref count on the physical page should decrement.
727 //   - The physical page should be freed if the refcount reaches 0.
728 //   - The pg table entry corresponding to 'va' should be set to 0.
729 //     (if such a PTE exists)
730 //   - The TLB must be invalidated if you remove an entry from
731 //     the pg dir/pg table.
732 //
733 // Hint: The TA solution is implemented using page_lookup,
734 //      tlb_invalidate, and page_decref.
735 //
736 // This may be wonky wrt Jumbo pages and decref.  
737 void
738 page_remove(pde_t *pgdir, void *va)
739 {
740         pte_t* pte;
741         struct Page* page;
742         page = page_lookup(pgdir, va, &pte);
743         if (!page)
744                 return;
745         *pte = 0;
746         tlb_invalidate(pgdir, va);
747         page_decref(page);
748 }
749
750 //
751 // Invalidate a TLB entry, but only if the page tables being
752 // edited are the ones currently in use by the processor.
753 //
754 void
755 tlb_invalidate(pde_t *pgdir, void *va)
756 {
757         // Flush the entry only if we're modifying the current address space.
758         // For now, there is only one address space, so always invalidate.
759         invlpg(va);
760 }
761
762 static uintptr_t user_mem_check_addr;
763
764 //
765 // Check that an environment is allowed to access the range of memory
766 // [va, va+len) with permissions 'perm | PTE_P'.
767 // Normally 'perm' will contain PTE_U at least, but this is not required.
768 // 'va' and 'len' need not be page-aligned; you must test every page that
769 // contains any of that range.  You will test either 'len/PGSIZE',
770 // 'len/PGSIZE + 1', or 'len/PGSIZE + 2' pages.
771 //
772 // A user program can access a virtual address if (1) the address is below
773 // ULIM, and (2) the page table gives it permission.  These are exactly
774 // the tests you should implement here.
775 //
776 // If there is an error, set the 'user_mem_check_addr' variable to the first
777 // erroneous virtual address.
778 //
779 // Returns 0 if the user program can access this range of addresses,
780 // and -E_FAULT otherwise.
781 //
782 // Hint: The TA solution uses pgdir_walk.
783 //
784 int
785 user_mem_check(struct Env *env, const void *va, size_t len, int perm)
786 {
787         // LAB 3: Your code here. 
788
789         return 0;
790 }
791
792 //
793 // Checks that environment 'env' is allowed to access the range
794 // of memory [va, va+len) with permissions 'perm | PTE_U'.
795 // If it can, then the function simply returns.
796 // If it cannot, 'env' is destroyed.
797 //
798 void
799 user_mem_assert(struct Env *env, const void *va, size_t len, int perm)
800 {
801         if (user_mem_check(env, va, len, perm | PTE_U) < 0) {
802                 cprintf("[%08x] user_mem_check assertion failure for "
803                         "va %08x\n", curenv->env_id, user_mem_check_addr);
804                 env_destroy(env);       // may not return
805         }
806 }
807
808 void
809 page_check(void)
810 {
811         struct Page *pp, *pp0, *pp1, *pp2;
812         struct Page_list fl;
813         pte_t *ptep;
814
815         // should be able to allocate three pages
816         pp0 = pp1 = pp2 = 0;
817         assert(page_alloc(&pp0) == 0);
818         assert(page_alloc(&pp1) == 0);
819         assert(page_alloc(&pp2) == 0);
820
821         assert(pp0);
822         assert(pp1 && pp1 != pp0);
823         assert(pp2 && pp2 != pp1 && pp2 != pp0);
824
825         // temporarily steal the rest of the free pages
826         fl = page_free_list;
827         LIST_INIT(&page_free_list);
828
829         // should be no free memory
830         assert(page_alloc(&pp) == -E_NO_MEM);
831
832         // Fill pp1 with bogus data and check for invalid tlb entries
833         memset(page2kva(pp1), 0xFFFFFFFF, PGSIZE);
834
835         // there is no page allocated at address 0
836         assert(page_lookup(boot_pgdir, (void *) 0x0, &ptep) == NULL);
837
838         // there is no free memory, so we can't allocate a page table 
839         assert(page_insert(boot_pgdir, pp1, 0x0, 0) < 0);
840
841         // free pp0 and try again: pp0 should be used for page table
842         page_free(pp0);
843         assert(page_insert(boot_pgdir, pp1, 0x0, 0) == 0);
844         tlb_invalidate(boot_pgdir, 0x0);
845         // DEP Should have shot down invalid TLB entry - let's check
846         {
847           int *x = 0x0;
848           assert(*x == 0xFFFFFFFF);
849         }
850         assert(PTE_ADDR(boot_pgdir[0]) == page2pa(pp0));
851         assert(check_va2pa(boot_pgdir, 0x0) == page2pa(pp1));
852         assert(pp1->pp_ref == 1);
853         assert(pp0->pp_ref == 1);
854
855         // should be able to map pp2 at PGSIZE because pp0 is already allocated for page table
856         assert(page_insert(boot_pgdir, pp2, (void*) PGSIZE, 0) == 0);
857         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp2));
858         assert(pp2->pp_ref == 1);
859
860         // Make sure that pgdir_walk returns a pointer to the pte and
861         // not the table or some other garbage
862         {
863           pte_t *p = KADDR(PTE_ADDR(boot_pgdir[PDX(PGSIZE)]));
864           assert(pgdir_walk(boot_pgdir, (void *)PGSIZE, 0) == &p[PTX(PGSIZE)]);
865         }
866
867         // should be no free memory
868         assert(page_alloc(&pp) == -E_NO_MEM);
869
870         // should be able to map pp2 at PGSIZE because it's already there
871         assert(page_insert(boot_pgdir, pp2, (void*) PGSIZE, PTE_U) == 0);
872         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp2));
873         assert(pp2->pp_ref == 1);
874
875         // Make sure that we actually changed the permission on pp2 when we re-mapped it
876         {
877           pte_t *p = pgdir_walk(boot_pgdir, (void*)PGSIZE, 0);
878           assert(((*p) & PTE_U) == PTE_U);
879         }
880
881         // pp2 should NOT be on the free list
882         // could happen in ref counts are handled sloppily in page_insert
883         assert(page_alloc(&pp) == -E_NO_MEM);
884
885         // should not be able to map at PTSIZE because need free page for page table
886         assert(page_insert(boot_pgdir, pp0, (void*) PTSIZE, 0) < 0);
887
888         // insert pp1 at PGSIZE (replacing pp2)
889         assert(page_insert(boot_pgdir, pp1, (void*) PGSIZE, 0) == 0);
890
891         // should have pp1 at both 0 and PGSIZE, pp2 nowhere, ...
892         assert(check_va2pa(boot_pgdir, 0) == page2pa(pp1));
893         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp1));
894         // ... and ref counts should reflect this
895         assert(pp1->pp_ref == 2);
896         assert(pp2->pp_ref == 0);
897
898         // pp2 should be returned by page_alloc
899         assert(page_alloc(&pp) == 0 && pp == pp2);
900
901         // unmapping pp1 at 0 should keep pp1 at PGSIZE
902         page_remove(boot_pgdir, 0x0);
903         assert(check_va2pa(boot_pgdir, 0x0) == ~0);
904         assert(check_va2pa(boot_pgdir, PGSIZE) == page2pa(pp1));
905         assert(pp1->pp_ref == 1);
906         assert(pp2->pp_ref == 0);
907
908         // unmapping pp1 at PGSIZE should free it
909         page_remove(boot_pgdir, (void*) PGSIZE);
910         assert(check_va2pa(boot_pgdir, 0x0) == ~0);
911         assert(check_va2pa(boot_pgdir, PGSIZE) == ~0);
912         assert(pp1->pp_ref == 0);
913         assert(pp2->pp_ref == 0);
914
915         // so it should be returned by page_alloc
916         assert(page_alloc(&pp) == 0 && pp == pp1);
917
918         // should be no free memory
919         assert(page_alloc(&pp) == -E_NO_MEM);
920
921         // forcibly take pp0 back
922         assert(PTE_ADDR(boot_pgdir[0]) == page2pa(pp0));
923         boot_pgdir[0] = 0;
924         assert(pp0->pp_ref == 1);
925         pp0->pp_ref = 0;
926
927         // Catch invalid pointer addition in pgdir_walk - i.e. pgdir + PDX(va)
928         {
929           // Give back pp0 for a bit
930           page_free(pp0);
931
932           void * va = (void *)((PGSIZE * NPDENTRIES) + PGSIZE);
933           pte_t *p2 = pgdir_walk(boot_pgdir, va, 1);
934           pte_t *p = KADDR(PTE_ADDR(boot_pgdir[PDX(va)]));
935           assert(p2 == &p[PTX(va)]);
936
937           // Clean up again
938           boot_pgdir[PDX(va)] = 0;
939           pp0->pp_ref = 0;
940         }
941
942         // give free list back
943         page_free_list = fl;
944
945         // free the pages we took
946         page_free(pp0);
947         page_free(pp1);
948         page_free(pp2);
949
950         cprintf("page_check() succeeded!\n");
951 }
952
953
954 /* 
955         // helpful if you want to manually walk with kvm / bochs
956         //cprintf("pgdir va = %08p, pgdir pa = %08p\n\n", pgdir, PADDR(pgdir));
957
958     // testing code for boot_pgdir_walk 
959         pte_t* temp;
960         temp = boot_pgdir_walk(pgdir, VPT + (VPT >> 10), 1);
961         cprintf("pgdir = %p\n", pgdir);
962         cprintf("test recursive walking pte_t* = %p\n", temp);
963         cprintf("test recursive walking entry = %p\n", PTE_ADDR(temp));
964         temp = boot_pgdir_walk(pgdir, 0xc0400000, 1);
965         cprintf("LA = 0xc0400000 = %p\n", temp);
966         temp = boot_pgdir_walk(pgdir, 0xc0400070, 1);
967         cprintf("LA = 0xc0400070 = %p\n", temp);
968         temp = boot_pgdir_walk(pgdir, 0xc0800000, 0);
969         cprintf("LA = 0xc0800000, no create = %p\n", temp);
970         temp = boot_pgdir_walk(pgdir, 0xc0600070, 1);
971         cprintf("LA = 0xc0600070 = %p\n", temp);
972         temp = boot_pgdir_walk(pgdir, 0xc0600090, 0);
973         cprintf("LA = 0xc0600090, nc = %p\n", temp);
974         temp = boot_pgdir_walk(pgdir, 0xc0608070, 0);
975         cprintf("LA = 0xc0608070, nc = %p\n", temp);
976         temp = boot_pgdir_walk(pgdir, 0xc0800070, 1);
977         cprintf("LA = 0xc0800070 = %p\n", temp);
978         temp = boot_pgdir_walk(pgdir, 0xc0b00070, 0);
979         cprintf("LA = 0xc0b00070, nc = %p\n", temp);
980         temp = boot_pgdir_walk(pgdir, 0xc0c00000, 0);
981         cprintf("LA = 0xc0c00000, nc = %p\n", temp);
982
983         // testing for boot_map_seg
984         cprintf("\n");
985         cprintf("before mapping 1 page to 0x00350000\n");
986         cprintf("0xc4000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc4000000, 1));
987         cprintf("0xc4000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc4000000, 1)));
988         boot_map_segment(pgdir, 0xc4000000, 4096, 0x00350000, PTE_W);
989         cprintf("after mapping\n");
990         cprintf("0xc4000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc4000000, 1));
991         cprintf("0xc4000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc4000000, 1)));
992
993         cprintf("\n");
994         cprintf("before mapping 3 pages to 0x00700000\n");
995         cprintf("0xd0000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0000000, 1));
996         cprintf("0xd0000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0000000, 1)));
997         cprintf("0xd0001000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0001000, 1));
998         cprintf("0xd0001000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0001000, 1)));
999         cprintf("0xd0002000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0002000, 1));
1000         cprintf("0xd0002000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0002000, 1)));
1001         boot_map_segment(pgdir, 0xd0000000, 4096*3, 0x00700000, 0);
1002         cprintf("after mapping\n");
1003         cprintf("0xd0000000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0000000, 1));
1004         cprintf("0xd0000000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0000000, 1)));
1005         cprintf("0xd0001000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0001000, 1));
1006         cprintf("0xd0001000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0001000, 1)));
1007         cprintf("0xd0002000's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xd0002000, 1));
1008         cprintf("0xd0002000's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xd0002000, 1)));
1009
1010         cprintf("\n");
1011         cprintf("before mapping 1 unaligned to 0x00500010\n");
1012         cprintf("0xc8000010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8000010, 1));
1013         cprintf("0xc8000010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8000010, 1)));
1014         cprintf("0xc8001010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8001010, 1));
1015         cprintf("0xc8001010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8001010, 1)));
1016         boot_map_segment(pgdir, 0xc8000010, 4096, 0x00500010, PTE_W);
1017         cprintf("after mapping\n");
1018         cprintf("0xc8000010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8000010, 1));
1019         cprintf("0xc8000010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8000010, 1)));
1020         cprintf("0xc8001010's &pte: %08x\n",boot_pgdir_walk(pgdir, 0xc8001010, 1));
1021         cprintf("0xc8001010's pte: %08x\n",*(boot_pgdir_walk(pgdir, 0xc8001010, 1)));
1022
1023         cprintf("\n");
1024         boot_map_segment(pgdir, 0xe0000000, 4096, 0x10000000, PTE_W);
1025
1026 */