Removed the old pfault, fork() uses VMRs
[akaros.git] / kern / src / pmap.c
1 /* See COPYRIGHT for copyright information. */
2
3 /** @file 
4  * This file is responsible for managing physical pages as they 
5  * are mapped into the page tables of a particular virtual address
6  * space.  The functions defined in this file operate on these
7  * page tables to insert and remove physical pages from them at 
8  * particular virtual addresses.
9  *
10  * @author Kevin Klues <klueska@cs.berkeley.edu>
11  * @author Barret Rhoden <brho@cs.berkeley.edu>
12  */
13
14 #ifdef __SHARC__
15 #pragma nosharc
16 #endif
17
18 #ifdef __DEPUTY__
19 #pragma nodeputy
20 #endif
21
22 #include <arch/arch.h>
23 #include <arch/mmu.h>
24
25 #include <error.h>
26
27 #include <kmalloc.h>
28 #include <atomic.h>
29 #include <string.h>
30 #include <assert.h>
31 #include <pmap.h>
32 #include <kclock.h>
33 #include <process.h>
34 #include <stdio.h>
35 #include <mm.h>
36
37 /**
38  * @brief Global variable used to store erroneous virtual addresses as the
39  *        result of a failed user_mem_check().
40  *
41  * zra: What if two checks fail at the same time? Maybe this should be per-cpu?
42  *
43  */
44 static void *DANGEROUS RACY user_mem_check_addr;
45
46 volatile uint32_t vpt_lock = 0;
47 volatile uint32_t vpd_lock = 0;
48
49 /**
50  * @brief Initialize the array of physical pages and memory free list.
51  *
52  * The 'pages' array has one 'page_t' entry per physical page.
53  * Pages are reference counted, and free pages are kept on a linked list.
54  */
55 void page_init(void)
56 {
57         /*
58      * First, make 'pages' point to an array of size 'npages' of
59          * type 'page_t'.
60          * The kernel uses this structure to keep track of physical pages;
61          * 'npages' equals the number of physical pages in memory.
62          * round up to the nearest page
63          */
64         pages = (page_t*)boot_alloc(npages*sizeof(page_t), PGSIZE);
65         memset(pages, 0, npages*sizeof(page_t));
66
67         /*
68      * Then initilaize everything so pages can start to be alloced and freed
69          * from the memory free list
70          */
71         page_alloc_init();
72
73         static_assert(PROCINFO_NUM_PAGES <= PTSIZE);
74         static_assert(PROCDATA_NUM_PAGES <= PTSIZE);
75 }
76
77 /** 
78  * @brief Map the physical page 'pp' into the virtual address 'va' in page
79  *        directory 'pgdir'
80  *
81  * Map the physical page 'pp' at virtual address 'va'.
82  * The permissions (the low 12 bits) of the page table
83  * entry should be set to 'perm|PTE_P'.
84  * 
85  * Details:
86  *   - If there is already a page mapped at 'va', it is page_remove()d.
87  *   - If necessary, on demand, allocates a page table and inserts it into 
88  *     'pgdir'.
89  *   - page_incref() should be called if the insertion succeeds. 
90  *   - The TLB must be invalidated if a page was formerly present at 'va'.
91  *     (this is handled in page_remove)
92  *
93  * No support for jumbos here.  We will need to be careful when trying to
94  * insert regular pages into something that was already jumbo.  We will
95  * also need to be careful with our overloading of the PTE_PS and 
96  * PTE_PAT flags...
97  *
98  * @param[in] pgdir the page directory to insert the page into
99  * @param[in] pp    a pointr to the page struct representing the
100  *                  physical page that should be inserted.
101  * @param[in] va    the virtual address where the page should be
102  *                  inserted.
103  * @param[in] perm  the permition bits with which to set up the 
104  *                  virtual mapping.
105  *
106  * @return ESUCCESS  on success
107  * @return -ENOMEM   if a page table could not be allocated
108  *                   into which the page should be inserted
109  *
110  */
111 int page_insert(pde_t *pgdir, page_t *pp, void *va, int perm) 
112 {
113         pte_t* pte = pgdir_walk(pgdir, va, 1);
114         if (!pte)
115                 return -ENOMEM;
116         // need to up the ref count in case pp is already mapped at va
117         // and we don't want to page_remove (which could free pp) and then 
118         // continue as if pp wasn't freed.  moral = up the ref asap
119         page_incref(pp);
120         if (!PAGE_UNMAPPED(*pte))
121                 page_remove(pgdir, va);
122         *pte = PTE(page2ppn(pp), PTE_P | perm);
123         return 0;
124 }
125
126 /**
127  * @brief Map the physical page 'pp' at the first virtual address that is free 
128  * in the range 'vab' to 'vae' in page directory 'pgdir'.
129  *
130  * The permissions (the low 12 bits) of the page table entry get set to 
131  * 'perm|PTE_P'.
132  *
133  * Details:
134  *   - If there is no free entry in the range 'vab' to 'vae' this 
135  *     function returns NULL.
136  *   - If necessary, on demand, this function will allocate a page table 
137  *     and inserts it into 'pgdir'.
138  *   - page_incref() will be called if the insertion succeeds.
139  * 
140  * @param[in] pgdir the page directory to insert the page into
141  * @param[in] pp    a pointr to the page struct representing the
142  *                  physical page that should be inserted.
143  * @param[in] vab   the first virtual address in the range in which the 
144  *                  page can be inserted.
145  * @param[in] vae   the last virtual address in the range in which the 
146  *                  page can be inserted.
147  * @param[in] perm  the permition bits with which to set up the 
148  *                  virtual mapping.
149  *
150  * @return VA   the virtual address where pp has been mapped in the 
151  *              range (vab, vae)
152  * @return NULL no free va in the range (vab, vae) could be found
153  */
154 void* page_insert_in_range(pde_t *pgdir, page_t *pp, 
155                            void *vab, void *vae, int perm) 
156 {
157         pte_t* pte = NULL;
158         void*SNT new_va;
159         
160         for(new_va = vab; new_va <= vae; new_va+= PGSIZE) {
161                 pte = pgdir_walk(pgdir, new_va, 1);
162                 if(pte != NULL && PAGE_UNMAPPED(*pte)) break;
163                 else pte = NULL;
164         }
165         if (!pte) return NULL;
166         *pte = page2pa(pp) | PTE_P | perm;
167         return TC(new_va); // trusted because mapping a page is like allocation
168 }
169
170 /**
171  * @brief Return the page mapped at virtual address 'va' in 
172  * page directory 'pgdir'.
173  *
174  * If pte_store is not NULL, then we store in it the address
175  * of the pte for this page.  This is used by page_remove
176  * but should not be used by other callers.
177  *
178  * For jumbos, right now this returns the first Page* in the 4MB range
179  *
180  * @param[in]  pgdir     the page directory from which we should do the lookup
181  * @param[in]  va        the virtual address of the page we are looking up
182  * @param[out] pte_store the address of the page table entry for the returned page
183  *
184  * @return PAGE the page mapped at virtual address 'va'
185  * @return NULL No mapping exists at virtual address 'va', or it's paged out
186  */
187 page_t *page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
188 {
189         pte_t* pte = pgdir_walk(pgdir, va, 0);
190         if (!pte || !PAGE_PRESENT(*pte))
191                 return 0;
192         if (pte_store)
193                 *pte_store = pte;
194         return pa2page(PTE_ADDR(*pte));
195 }
196
197 /**
198  * @brief Unmaps the physical page at virtual address 'va' in page directory
199  * 'pgdir'.
200  *
201  * If there is no physical page at that address, this function silently 
202  * does nothing.
203  *
204  * Details:
205  *   - The ref count on the physical page is decrement when the page is removed
206  *   - The physical page is freed if the refcount reaches 0.
207  *   - The pg table entry corresponding to 'va' is set to 0.
208  *     (if such a PTE exists)
209  *   - The TLB is invalidated if an entry is removes from the pg dir/pg table.
210  *
211  * This may be wonky wrt Jumbo pages and decref.  
212  *
213  * @param pgdir the page directory from with the page sholuld be removed
214  * @param va    the virtual address at which the page we are trying to 
215  *              remove is mapped
216  * TODO: consider deprecating this, esp given issues with TLB management.  might
217  * want to have the caller need to manage the TLB.  Also note it is used in
218  * env_user_mem_free, minus the walk.
219  */
220 void page_remove(pde_t *pgdir, void *va)
221 {
222         pte_t *pte;
223         page_t *page;
224
225         pte = pgdir_walk(pgdir,va,0);
226         if (!pte || PAGE_UNMAPPED(*pte))
227                 return;
228
229         if (PAGE_PRESENT(*pte)) {
230                 /* TODO: (TLB) race here, where the page can be given out before
231                  * the shootdown happened.  Need to put it on a temp list. */
232                 page = ppn2page(PTE2PPN(*pte));
233                 *pte = 0;
234                 page_decref(page);
235                 tlb_invalidate(pgdir, va);
236         } else if (PAGE_PAGED_OUT(*pte)) {
237                 /* TODO: (SWAP) need to free this from the swap */
238                 *pte = 0;
239         }
240 }
241
242 /**
243  * @brief Invalidate a TLB entry, but only if the page tables being
244  * edited are the ones currently in use by the processor.
245  *
246  * TODO: Need to sort this for cross core lovin'
247  *
248  * @param pgdir the page directory assocaited with the tlb entry 
249  *              we are trying to invalidate
250  * @param va    the virtual address associated with the tlb entry
251  *              we are trying to invalidate
252  */
253 void tlb_invalidate(pde_t *pgdir, void *va)
254 {
255         // Flush the entry only if we're modifying the current address space.
256         // For now, there is only one address space, so always invalidate.
257         invlpg(va);
258 }
259
260 /**
261  * @brief Check that an environment is allowed to access the range of memory
262  * [va, va+len) with permissions 'perm | PTE_P'.
263  *
264  * Normally 'perm' will contain PTE_U at least, but this is not required.  The
265  * function get_va_perms only checks for PTE_U, PTE_W, and PTE_P.  It won't
266  * check for things like PTE_PS, PTE_A, etc.
267  * 'va' and 'len' need not be page-aligned;
268  *
269  * A user program can access a virtual address if:
270  *     -# the address is below ULIM
271  *     -# the page table gives it permission.  
272  *
273  * If there is an error, 'user_mem_check_addr' is set to the first
274  * erroneous virtual address.
275  *
276  * @param env  the environment associated with the user program trying to access
277  *             the virtual address range
278  * @param va   the first virtual address in the range
279  * @param len  the length of the virtual address range
280  * @param perm the permissions the user is trying to access the virtual address 
281  *             range with
282  *
283  * @return VA a pointer of type COUNT(len) to the address range
284  * @return NULL trying to access this range of virtual addresses is not allowed
285  */
286 void* user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
287 {
288         if (len == 0) {
289                 warn("Called user_mem_check with a len of 0. Don't do that. Returning NULL");
290                 return NULL;
291         }
292         
293         // TODO - will need to sort this out wrt page faulting / PTE_P
294         // also could be issues with sleeping and waking up to find pages
295         // are unmapped, though i think the lab ignores this since the 
296         // kernel is uninterruptible
297         void *DANGEROUS start, *DANGEROUS end;
298         size_t num_pages, i;
299         int page_perms = 0;
300
301         perm |= PTE_P;
302         start = ROUNDDOWN((void*DANGEROUS)va, PGSIZE);
303         end = ROUNDUP((void*DANGEROUS)va + len, PGSIZE);
304         if (start >= end) {
305                 warn("Blimey!  Wrap around in VM range calculation!");  
306                 return NULL;
307         }
308         num_pages = LA2PPN(end - start);
309         for (i = 0; i < num_pages; i++, start += PGSIZE) {
310                 page_perms = get_va_perms(env->env_pgdir, start);
311                 // ensures the bits we want on are turned on.  if not, error out
312                 if ((page_perms & perm) != perm) {
313                         if (i == 0)
314                                 user_mem_check_addr = (void*DANGEROUS)va;
315                         else
316                                 user_mem_check_addr = start;
317                         return NULL;
318                 }
319         }
320         // this should never be needed, since the perms should catch it
321         if ((uintptr_t)end > ULIM) {
322                 warn ("I suck - Bug in user permission mappings!");
323                 return NULL;
324         }
325         return (void *COUNT(len))TC(va);
326 }
327
328 /**
329  * @brief Use the kernel to copy a string from a buffer stored in userspace
330  *        to a buffer stored elsewhere in the address space (potentially in 
331  *        memory only accessible by the kernel)
332  *
333  * @param env  the environment associated with the user program from which
334  *             the string is being copied
335  * @param dst  the destination of the buffer into which the string 
336  *             is being copied
337  * @param va   the start address of the buffer where the string resides
338  * @param len  the length of the buffer 
339  * @param perm the permissions with which the user is trying to access 
340  *             elements of the original buffer 
341  *
342  * @return LEN the length of the new buffer copied into 'dst'
343  */
344 size_t
345 user_mem_strlcpy(env_t *env, char *_dst, const char *DANGEROUS va,
346                  size_t _len, int perm)
347 {
348         const char *DANGEROUS src = va;
349         size_t len = _len;
350         char *NT COUNT(_len-1) dst_in = _dst;
351         char *NT BND(_dst,_dst + _len - 1) dst = _dst;
352
353         if (len > 0) {
354                 while (1) {
355                         char *c;
356                         // what if len was 1?
357                         if (--len <= 0) break;
358                         c = user_mem_check(env, src, 1, perm);
359                         if (!c) break;
360                         if (*c == '\0') break;
361                         // TODO: ivy bitches about this
362                         *dst++ = *c;
363                         src++;
364                 }
365                 *dst = '\0';
366         }
367
368         return dst - dst_in;
369 }
370
371 /**
372  * @brief Checks that environment 'env' is allowed to access the range
373  * of memory [va, va+len) with permissions 'perm | PTE_U'. Destroy 
374  * environment 'env' if the assertion fails.
375  *
376  * This function is identical to user_mem_assert() except that it has a side
377  * affect of destroying the environment 'env' if the memory check fails.
378  *
379  * @param env  the environment associated with the user program trying to access
380  *             the virtual address range
381  * @param va   the first virtual address in the range
382  * @param len  the length of the virtual address range
383  * @param perm the permissions the user is trying to access the virtual address 
384  *             range with
385  *
386  * @return VA a pointer of type COUNT(len) to the address range
387  * @return NULL trying to access this range of virtual addresses is not allowed
388  *              environment 'env' is destroyed
389  */
390 void *
391 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
392 {
393         if (len == 0) {
394                 warn("Called user_mem_assert with a len of 0. Don't do that. Returning NULL");
395                 return NULL;
396         }
397         
398         void *COUNT(len) res = user_mem_check(env,va,len,perm | PTE_USER_RO);
399         if (!res) {
400                 cprintf("[%08x] user_mem_check assertion failure for "
401                         "va %08x\n", env->pid, user_mem_check_addr);
402                 proc_destroy(env);      // may not return
403         return NULL;
404         }
405     return res;
406 }
407
408 /**
409  * @brief Copies data from a user buffer to a kernel buffer.
410  * 
411  * @param env  the environment associated with the user program
412  *             from which the buffer is being copied
413  * @param dest the destination address of the kernel buffer
414  * @param va   the address of the userspace buffer from which we are copying
415  * @param len  the length of the userspace buffer
416  *
417  * @return ESUCCESS on success
418  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
419  *                  lacks the proper permissions, or there was an invalid 'va'
420  */
421 error_t memcpy_from_user(env_t* env, void* COUNT(len) dest,
422                  const void *DANGEROUS va, size_t len)
423 {
424         const void *DANGEROUS start, *DANGEROUS end;
425         size_t num_pages, i;
426         pte_t *pte;
427         uintptr_t perm = PTE_P | PTE_USER_RO;
428         size_t bytes_copied = 0;
429
430         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
431
432         start = ROUNDDOWN(va, PGSIZE);
433         end = ROUNDUP(va + len, PGSIZE);
434
435         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
436                 return -EFAULT;
437
438         num_pages = LA2PPN(end - start);
439         for(i = 0; i < num_pages; i++)
440         {
441                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
442                 if(!pte)
443                         return -EFAULT;
444                 if((*pte & PTE_P) && (*pte & PTE_USER_RO) != PTE_USER_RO)
445                         return -EFAULT;
446                 if(!(*pte & PTE_P))
447                         if(handle_page_fault(env,(uintptr_t)start+i*PGSIZE,PROT_READ))
448                                 return -EFAULT;
449
450                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
451                 const void* src_start = i > 0 ? kpage : kpage+(va-start);
452                 void* dst_start = dest+bytes_copied;
453                 size_t copy_len = PGSIZE;
454                 if(i == 0)
455                         copy_len -= va-start;
456                 if(i == num_pages-1)
457                         copy_len -= end-(va+len);
458
459                 memcpy(dst_start,src_start,copy_len);
460                 bytes_copied += copy_len;
461         }
462
463         assert(bytes_copied == len);
464
465         return ESUCCESS;
466 }
467
468 /**
469  * @brief Copies data to a user buffer from a kernel buffer.
470  * 
471  * @param env  the environment associated with the user program
472  *             to which the buffer is being copied
473  * @param dest the destination address of the user buffer
474  * @param va   the address of the kernel buffer from which we are copying
475  * @param len  the length of the user buffer
476  *
477  * @return ESUCCESS on success
478  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
479  *                  lacks the proper permissions, or there was an invalid 'va'
480  */
481 error_t memcpy_to_user(env_t* env, void*DANGEROUS va,
482                  const void *COUNT(len) src, size_t len)
483 {
484         const void *DANGEROUS start, *DANGEROUS end;
485         size_t num_pages, i;
486         pte_t *pte;
487         uintptr_t perm = PTE_P | PTE_USER_RW;
488         size_t bytes_copied = 0;
489
490         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
491
492         start = ROUNDDOWN(va, PGSIZE);
493         end = ROUNDUP(va + len, PGSIZE);
494
495         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
496                 return -EFAULT;
497
498         num_pages = LA2PPN(end - start);
499         for(i = 0; i < num_pages; i++)
500         {
501                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
502                 if(!pte)
503                         return -EFAULT;
504                 if((*pte & PTE_P) && (*pte & PTE_USER_RW) != PTE_USER_RW)
505                         return -EFAULT;
506                 if(!(*pte & PTE_P))
507                         if(handle_page_fault(env,(uintptr_t)start+i*PGSIZE,PROT_WRITE))
508                                 return -EFAULT;
509
510                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
511                 void* dst_start = i > 0 ? kpage : kpage+(va-start);
512                 const void* src_start = src+bytes_copied;
513                 size_t copy_len = PGSIZE;
514                 if(i == 0)
515                         copy_len -= va-start;
516                 if(i == num_pages-1)
517                         copy_len -= end-(va+len);
518
519                 memcpy(dst_start,src_start,copy_len);
520                 bytes_copied += copy_len;
521         }
522
523         assert(bytes_copied == len);
524
525         return ESUCCESS;
526 }