_M procs start up at _start/hart_entry for vcore0
[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  */
217 void page_remove(pde_t *pgdir, void *va)
218 {
219         pte_t* pte;
220         page_t *page;
221
222         pte = pgdir_walk(pgdir,va,0);
223         if(!pte || PAGE_UNMAPPED(*pte))
224                 return;
225
226         if(PAGE_PAGED_OUT(*pte))
227                 pfault_info_free(PTE2PFAULT_INFO(*pte));
228         else // PAGE_PRESENT
229         {
230                 tlb_invalidate(pgdir, va);
231                 page_decref(ppn2page(PTE2PPN(*pte)));
232         }
233
234         *pte = 0;
235 }
236
237 /**
238  * @brief Invalidate a TLB entry, but only if the page tables being
239  * edited are the ones currently in use by the processor.
240  *
241  * TODO: Need to sort this for cross core lovin'
242  *
243  * @param pgdir the page directory assocaited with the tlb entry 
244  *              we are trying to invalidate
245  * @param va    the virtual address associated with the tlb entry
246  *              we are trying to invalidate
247  */
248 void tlb_invalidate(pde_t *pgdir, void *va)
249 {
250         // Flush the entry only if we're modifying the current address space.
251         // For now, there is only one address space, so always invalidate.
252         invlpg(va);
253 }
254
255 /**
256  * @brief Check that an environment is allowed to access the range of memory
257  * [va, va+len) with permissions 'perm | PTE_P'.
258  *
259  * Normally 'perm' will contain PTE_U at least, but this is not required.  The
260  * function get_va_perms only checks for PTE_U, PTE_W, and PTE_P.  It won't
261  * check for things like PTE_PS, PTE_A, etc.
262  * 'va' and 'len' need not be page-aligned;
263  *
264  * A user program can access a virtual address if:
265  *     -# the address is below ULIM
266  *     -# the page table gives it permission.  
267  *
268  * If there is an error, 'user_mem_check_addr' is set to the first
269  * erroneous virtual address.
270  *
271  * @param env  the environment associated with the user program trying to access
272  *             the virtual address range
273  * @param va   the first virtual address in the range
274  * @param len  the length of the virtual address range
275  * @param perm the permissions the user is trying to access the virtual address 
276  *             range with
277  *
278  * @return VA a pointer of type COUNT(len) to the address range
279  * @return NULL trying to access this range of virtual addresses is not allowed
280  */
281 void* user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
282 {
283         if (len == 0) {
284                 warn("Called user_mem_check with a len of 0. Don't do that. Returning NULL");
285                 return NULL;
286         }
287         
288         // TODO - will need to sort this out wrt page faulting / PTE_P
289         // also could be issues with sleeping and waking up to find pages
290         // are unmapped, though i think the lab ignores this since the 
291         // kernel is uninterruptible
292         void *DANGEROUS start, *DANGEROUS end;
293         size_t num_pages, i;
294         int page_perms = 0;
295
296         perm |= PTE_P;
297         start = ROUNDDOWN((void*DANGEROUS)va, PGSIZE);
298         end = ROUNDUP((void*DANGEROUS)va + len, PGSIZE);
299         if (start >= end) {
300                 warn("Blimey!  Wrap around in VM range calculation!");  
301                 return NULL;
302         }
303         num_pages = LA2PPN(end - start);
304         for (i = 0; i < num_pages; i++, start += PGSIZE) {
305                 page_perms = get_va_perms(env->env_pgdir, start);
306                 // ensures the bits we want on are turned on.  if not, error out
307                 if ((page_perms & perm) != perm) {
308                         if (i == 0)
309                                 user_mem_check_addr = (void*DANGEROUS)va;
310                         else
311                                 user_mem_check_addr = start;
312                         return NULL;
313                 }
314         }
315         // this should never be needed, since the perms should catch it
316         if ((uintptr_t)end > ULIM) {
317                 warn ("I suck - Bug in user permission mappings!");
318                 return NULL;
319         }
320         return (void *COUNT(len))TC(va);
321 }
322
323 /**
324  * @brief Use the kernel to copy a string from a buffer stored in userspace
325  *        to a buffer stored elsewhere in the address space (potentially in 
326  *        memory only accessible by the kernel)
327  *
328  * @param env  the environment associated with the user program from which
329  *             the string is being copied
330  * @param dst  the destination of the buffer into which the string 
331  *             is being copied
332  * @param va   the start address of the buffer where the string resides
333  * @param len  the length of the buffer 
334  * @param perm the permissions with which the user is trying to access 
335  *             elements of the original buffer 
336  *
337  * @return LEN the length of the new buffer copied into 'dst'
338  */
339 size_t
340 user_mem_strlcpy(env_t *env, char *_dst, const char *DANGEROUS va,
341                  size_t _len, int perm)
342 {
343         const char *DANGEROUS src = va;
344         size_t len = _len;
345         char *NT COUNT(_len-1) dst_in = _dst;
346         char *NT BND(_dst,_dst + _len - 1) dst = _dst;
347
348         if (len > 0) {
349                 while (1) {
350                         char *c;
351                         // what if len was 1?
352                         if (--len <= 0) break;
353                         c = user_mem_check(env, src, 1, perm);
354                         if (!c) break;
355                         if (*c == '\0') break;
356                         // TODO: ivy bitches about this
357                         *dst++ = *c;
358                         src++;
359                 }
360                 *dst = '\0';
361         }
362
363         return dst - dst_in;
364 }
365
366 /**
367  * @brief Checks that environment 'env' is allowed to access the range
368  * of memory [va, va+len) with permissions 'perm | PTE_U'. Destroy 
369  * environment 'env' if the assertion fails.
370  *
371  * This function is identical to user_mem_assert() except that it has a side
372  * affect of destroying the environment 'env' if the memory check fails.
373  *
374  * @param env  the environment associated with the user program trying to access
375  *             the virtual address range
376  * @param va   the first virtual address in the range
377  * @param len  the length of the virtual address range
378  * @param perm the permissions the user is trying to access the virtual address 
379  *             range with
380  *
381  * @return VA a pointer of type COUNT(len) to the address range
382  * @return NULL trying to access this range of virtual addresses is not allowed
383  *              environment 'env' is destroyed
384  */
385 void *
386 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
387 {
388         if (len == 0) {
389                 warn("Called user_mem_assert with a len of 0. Don't do that. Returning NULL");
390                 return NULL;
391         }
392         
393         void *COUNT(len) res = user_mem_check(env,va,len,perm | PTE_USER_RO);
394         if (!res) {
395                 cprintf("[%08x] user_mem_check assertion failure for "
396                         "va %08x\n", env->pid, user_mem_check_addr);
397                 proc_destroy(env);      // may not return
398         return NULL;
399         }
400     return res;
401 }
402
403 /**
404  * @brief Copies data from a user buffer to a kernel buffer.
405  * 
406  * @param env  the environment associated with the user program
407  *             from which the buffer is being copied
408  * @param dest the destination address of the kernel buffer
409  * @param va   the address of the userspace buffer from which we are copying
410  * @param len  the length of the userspace buffer
411  *
412  * @return ESUCCESS on success
413  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
414  *                  lacks the proper permissions, or there was an invalid 'va'
415  */
416 error_t memcpy_from_user(env_t* env, void* COUNT(len) dest,
417                  const void *DANGEROUS va, size_t len)
418 {
419         const void *DANGEROUS start, *DANGEROUS end;
420         size_t num_pages, i;
421         pte_t *pte;
422         uintptr_t perm = PTE_P | PTE_USER_RO;
423         size_t bytes_copied = 0;
424
425         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
426
427         start = ROUNDDOWN(va, PGSIZE);
428         end = ROUNDUP(va + len, PGSIZE);
429
430         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
431                 return -EFAULT;
432
433         num_pages = LA2PPN(end - start);
434         for(i = 0; i < num_pages; i++)
435         {
436                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
437                 if(!pte)
438                         return -EFAULT;
439                 if((*pte & PTE_P) && (*pte & PTE_USER_RO) != PTE_USER_RO)
440                         return -EFAULT;
441                 if(!(*pte & PTE_P))
442                         if(handle_page_fault(env,(uintptr_t)start+i*PGSIZE,PROT_READ))
443                                 return -EFAULT;
444
445                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
446                 const void* src_start = i > 0 ? kpage : kpage+(va-start);
447                 void* dst_start = dest+bytes_copied;
448                 size_t copy_len = PGSIZE;
449                 if(i == 0)
450                         copy_len -= va-start;
451                 if(i == num_pages-1)
452                         copy_len -= end-(va+len);
453
454                 memcpy(dst_start,src_start,copy_len);
455                 bytes_copied += copy_len;
456         }
457
458         assert(bytes_copied == len);
459
460         return ESUCCESS;
461 }
462
463 /**
464  * @brief Copies data to a user buffer from a kernel buffer.
465  * 
466  * @param env  the environment associated with the user program
467  *             to which the buffer is being copied
468  * @param dest the destination address of the user buffer
469  * @param va   the address of the kernel buffer from which we are copying
470  * @param len  the length of the user buffer
471  *
472  * @return ESUCCESS on success
473  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
474  *                  lacks the proper permissions, or there was an invalid 'va'
475  */
476 error_t memcpy_to_user(env_t* env, void*DANGEROUS va,
477                  const void *COUNT(len) src, size_t len)
478 {
479         const void *DANGEROUS start, *DANGEROUS end;
480         size_t num_pages, i;
481         pte_t *pte;
482         uintptr_t perm = PTE_P | PTE_USER_RW;
483         size_t bytes_copied = 0;
484
485         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
486
487         start = ROUNDDOWN(va, PGSIZE);
488         end = ROUNDUP(va + len, PGSIZE);
489
490         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
491                 return -EFAULT;
492
493         num_pages = LA2PPN(end - start);
494         for(i = 0; i < num_pages; i++)
495         {
496                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
497                 if(!pte)
498                         return -EFAULT;
499                 if((*pte & PTE_P) && (*pte & PTE_USER_RW) != PTE_USER_RW)
500                         return -EFAULT;
501                 if(!(*pte & PTE_P))
502                         if(handle_page_fault(env,(uintptr_t)start+i*PGSIZE,PROT_WRITE))
503                                 return -EFAULT;
504
505                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
506                 void* dst_start = i > 0 ? kpage : kpage+(va-start);
507                 const void* src_start = src+bytes_copied;
508                 size_t copy_len = PGSIZE;
509                 if(i == 0)
510                         copy_len -= va-start;
511                 if(i == num_pages-1)
512                         copy_len -= end-(va+len);
513
514                 memcpy(dst_start,src_start,copy_len);
515                 bytes_copied += copy_len;
516         }
517
518         assert(bytes_copied == len);
519
520         return ESUCCESS;
521 }