Added demand paging support
[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 <ros/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 (*pte & PTE_P) {
121                 page_remove(pgdir, va);
122         }
123         *pte = PTE(page2ppn(pp), PTE_P | perm);
124         return 0;
125 }
126
127 /**
128  * @brief Map the physical page 'pp' at the first virtual address that is free 
129  * in the range 'vab' to 'vae' in page directory 'pgdir'.
130  *
131  * The permissions (the low 12 bits) of the page table entry get set to 
132  * 'perm|PTE_P'.
133  *
134  * Details:
135  *   - If there is no free entry in the range 'vab' to 'vae' this 
136  *     function returns NULL.
137  *   - If necessary, on demand, this function will allocate a page table 
138  *     and inserts it into 'pgdir'.
139  *   - page_incref() will be called if the insertion succeeds.
140  * 
141  * @param[in] pgdir the page directory to insert the page into
142  * @param[in] pp    a pointr to the page struct representing the
143  *                  physical page that should be inserted.
144  * @param[in] vab   the first virtual address in the range in which the 
145  *                  page can be inserted.
146  * @param[in] vae   the last virtual address in the range in which the 
147  *                  page can be inserted.
148  * @param[in] perm  the permition bits with which to set up the 
149  *                  virtual mapping.
150  *
151  * @return VA   the virtual address where pp has been mapped in the 
152  *              range (vab, vae)
153  * @return NULL no free va in the range (vab, vae) could be found
154  */
155 void* page_insert_in_range(pde_t *pgdir, page_t *pp, 
156                            void *vab, void *vae, int perm) 
157 {
158         pte_t* pte = NULL;
159         void*SNT new_va;
160         
161         for(new_va = vab; new_va <= vae; new_va+= PGSIZE) {
162                 pte = pgdir_walk(pgdir, new_va, 1);
163                 if(pte != NULL && !(*pte & PTE_P)) break;
164                 else pte = NULL;
165         }
166         if (!pte) return NULL;
167         *pte = page2pa(pp) | PTE_P | perm;
168         return TC(new_va); // trusted because mapping a page is like allocation
169 }
170
171 /**
172  * @brief Return the page mapped at virtual address 'va' in 
173  * page directory 'pgdir'.
174  *
175  * If pte_store is not NULL, then we store in it the address
176  * of the pte for this page.  This is used by page_remove
177  * but should not be used by other callers.
178  *
179  * For jumbos, right now this returns the first Page* in the 4MB range
180  *
181  * @param[in]  pgdir     the page directory from which we should do the lookup
182  * @param[in]  va        the virtual address of the page we are looking up
183  * @param[out] pte_store the address of the page table entry for the returned page
184  *
185  * @return PAGE the page mapped at virtual address 'va'
186  * @return NULL No mapping exists at virtual address 'va'   
187  */
188 page_t *page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
189 {
190         pte_t* pte = pgdir_walk(pgdir, va, 0);
191         if (!pte || !(*pte & PTE_P))
192                 return 0;
193         if (pte_store)
194                 *pte_store = pte;
195         return pa2page(PTE_ADDR(*pte));
196 }
197
198 /**
199  * @brief Unmaps the physical page at virtual address 'va' in page directory
200  * 'pgdir'.
201  *
202  * If there is no physical page at that address, this function silently 
203  * does nothing.
204  *
205  * Details:
206  *   - The ref count on the physical page is decrement when the page is removed
207  *   - The physical page is freed if the refcount reaches 0.
208  *   - The pg table entry corresponding to 'va' is set to 0.
209  *     (if such a PTE exists)
210  *   - The TLB is invalidated if an entry is removes from the pg dir/pg table.
211  *
212  * This may be wonky wrt Jumbo pages and decref.  
213  *
214  * @param pgdir the page directory from with the page sholuld be removed
215  * @param va    the virtual address at which the page we are trying to 
216  *              remove is mapped
217  */
218 void page_remove(pde_t *pgdir, void *va)
219 {
220         pte_t* pte;
221         page_t *page;
222         page = page_lookup(pgdir, va, &pte);
223         if (!page)
224                 return;
225         *pte = 0;
226         tlb_invalidate(pgdir, va);
227         page_decref(page);
228 }
229
230 /**
231  * @brief Invalidate a TLB entry, but only if the page tables being
232  * edited are the ones currently in use by the processor.
233  *
234  * TODO: Need to sort this for cross core lovin'
235  *
236  * @param pgdir the page directory assocaited with the tlb entry 
237  *              we are trying to invalidate
238  * @param va    the virtual address associated with the tlb entry
239  *              we are trying to invalidate
240  */
241 void tlb_invalidate(pde_t *pgdir, void *va)
242 {
243         // Flush the entry only if we're modifying the current address space.
244         // For now, there is only one address space, so always invalidate.
245         invlpg(va);
246 }
247
248 /**
249  * @brief Check that an environment is allowed to access the range of memory
250  * [va, va+len) with permissions 'perm | PTE_P'.
251  *
252  * Normally 'perm' will contain PTE_U at least, but this is not required.  The
253  * function get_va_perms only checks for PTE_U, PTE_W, and PTE_P.  It won't
254  * check for things like PTE_PS, PTE_A, etc.
255  * 'va' and 'len' need not be page-aligned;
256  *
257  * A user program can access a virtual address if:
258  *     -# the address is below ULIM
259  *     -# the page table gives it permission.  
260  *
261  * If there is an error, 'user_mem_check_addr' is set to the first
262  * erroneous virtual address.
263  *
264  * @param env  the environment associated with the user program trying to access
265  *             the virtual address range
266  * @param va   the first virtual address in the range
267  * @param len  the length of the virtual address range
268  * @param perm the permissions the user is trying to access the virtual address 
269  *             range with
270  *
271  * @return VA a pointer of type COUNT(len) to the address range
272  * @return NULL trying to access this range of virtual addresses is not allowed
273  */
274 void* user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
275 {
276         if (len == 0) {
277                 warn("Called user_mem_check with a len of 0. Don't do that. Returning NULL");
278                 return NULL;
279         }
280         
281         // TODO - will need to sort this out wrt page faulting / PTE_P
282         // also could be issues with sleeping and waking up to find pages
283         // are unmapped, though i think the lab ignores this since the 
284         // kernel is uninterruptible
285         void *DANGEROUS start, *DANGEROUS end;
286         size_t num_pages, i;
287         int page_perms = 0;
288
289         perm |= PTE_P;
290         start = ROUNDDOWN((void*DANGEROUS)va, PGSIZE);
291         end = ROUNDUP((void*DANGEROUS)va + len, PGSIZE);
292         if (start >= end) {
293                 warn("Blimey!  Wrap around in VM range calculation!");  
294                 return NULL;
295         }
296         num_pages = LA2PPN(end - start);
297         for (i = 0; i < num_pages; i++, start += PGSIZE) {
298                 page_perms = get_va_perms(env->env_pgdir, start);
299                 // ensures the bits we want on are turned on.  if not, error out
300                 if ((page_perms & perm) != perm) {
301                         if (i == 0)
302                                 user_mem_check_addr = (void*DANGEROUS)va;
303                         else
304                                 user_mem_check_addr = start;
305                         return NULL;
306                 }
307         }
308         // this should never be needed, since the perms should catch it
309         if ((uintptr_t)end > ULIM) {
310                 warn ("I suck - Bug in user permission mappings!");
311                 return NULL;
312         }
313         return (void *COUNT(len))TC(va);
314 }
315
316 /**
317  * @brief Use the kernel to copy a string from a buffer stored in userspace
318  *        to a buffer stored elsewhere in the address space (potentially in 
319  *        memory only accessible by the kernel)
320  *
321  * @param env  the environment associated with the user program from which
322  *             the string is being copied
323  * @param dst  the destination of the buffer into which the string 
324  *             is being copied
325  * @param va   the start address of the buffer where the string resides
326  * @param len  the length of the buffer 
327  * @param perm the permissions with which the user is trying to access 
328  *             elements of the original buffer 
329  *
330  * @return LEN the length of the new buffer copied into 'dst'
331  */
332 size_t
333 user_mem_strlcpy(env_t *env, char *_dst, const char *DANGEROUS va,
334                  size_t _len, int perm)
335 {
336         const char *DANGEROUS src = va;
337         size_t len = _len;
338         char *NT COUNT(_len-1) dst_in = _dst;
339         char *NT BND(_dst,_dst + _len - 1) dst = _dst;
340
341         if (len > 0) {
342                 while (1) {
343                         char *c;
344                         // what if len was 1?
345                         if (--len <= 0) break;
346                         c = user_mem_check(env, src, 1, perm);
347                         if (!c) break;
348                         if (*c == '\0') break;
349                         // TODO: ivy bitches about this
350                         *dst++ = *c;
351                         src++;
352                 }
353                 *dst = '\0';
354         }
355
356         return dst - dst_in;
357 }
358
359 /**
360  * @brief Checks that environment 'env' is allowed to access the range
361  * of memory [va, va+len) with permissions 'perm | PTE_U'. Destroy 
362  * environment 'env' if the assertion fails.
363  *
364  * This function is identical to user_mem_assert() except that it has a side
365  * affect of destroying the environment 'env' if the memory check fails.
366  *
367  * @param env  the environment associated with the user program trying to access
368  *             the virtual address range
369  * @param va   the first virtual address in the range
370  * @param len  the length of the virtual address range
371  * @param perm the permissions the user is trying to access the virtual address 
372  *             range with
373  *
374  * @return VA a pointer of type COUNT(len) to the address range
375  * @return NULL trying to access this range of virtual addresses is not allowed
376  *              environment 'env' is destroyed
377  */
378 void *
379 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
380 {
381         if (len == 0) {
382                 warn("Called user_mem_assert with a len of 0. Don't do that. Returning NULL");
383                 return NULL;
384         }
385         
386         void *COUNT(len) res = user_mem_check(env,va,len,perm | PTE_USER_RO);
387         if (!res) {
388                 cprintf("[%08x] user_mem_check assertion failure for "
389                         "va %08x\n", env->pid, user_mem_check_addr);
390                 proc_destroy(env);      // may not return
391         return NULL;
392         }
393     return res;
394 }
395
396 /**
397  * @brief Copies data from a user buffer to a kernel buffer.
398  * 
399  * @param env  the environment associated with the user program
400  *             from which the buffer is being copied
401  * @param dest the destination address of the kernel buffer
402  * @param va   the address of the userspace buffer from which we are copying
403  * @param len  the length of the userspace buffer
404  *
405  * @return ESUCCESS on success
406  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
407  *                  lacks the proper permissions, or there was an invalid 'va'
408  */
409 error_t memcpy_from_user(env_t* env, void* COUNT(len) dest,
410                  const void *DANGEROUS va, size_t len)
411 {
412         const void *DANGEROUS start, *DANGEROUS end;
413         size_t num_pages, i;
414         pte_t *pte;
415         uintptr_t perm = PTE_P | PTE_USER_RO;
416         size_t bytes_copied = 0;
417
418         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
419
420         start = ROUNDDOWN(va, PGSIZE);
421         end = ROUNDUP(va + len, PGSIZE);
422
423         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
424                 return -EFAULT;
425
426         num_pages = LA2PPN(end - start);
427         for(i = 0; i < num_pages; i++)
428         {
429                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
430                 if(!pte)
431                         return -EFAULT;
432                 if((*pte & PTE_P) && (*pte & PTE_USER_RO) != PTE_USER_RO)
433                         return -EFAULT;
434                 if(!(*pte & PTE_P))
435                         if(handle_page_fault(env,(uintptr_t)start+i*PGSIZE,PROT_READ))
436                                 return -EFAULT;
437
438                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
439                 const void* src_start = i > 0 ? kpage : kpage+(va-start);
440                 void* dst_start = dest+bytes_copied;
441                 size_t copy_len = PGSIZE;
442                 if(i == 0)
443                         copy_len -= va-start;
444                 if(i == num_pages-1)
445                         copy_len -= end-(va+len);
446
447                 memcpy(dst_start,src_start,copy_len);
448                 bytes_copied += copy_len;
449         }
450
451         assert(bytes_copied == len);
452
453         return ESUCCESS;
454 }
455
456 /**
457  * @brief Copies data to a user buffer from a kernel buffer.
458  * 
459  * @param env  the environment associated with the user program
460  *             to which the buffer is being copied
461  * @param dest the destination address of the user buffer
462  * @param va   the address of the kernel buffer from which we are copying
463  * @param len  the length of the user buffer
464  *
465  * @return ESUCCESS on success
466  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
467  *                  lacks the proper permissions, or there was an invalid 'va'
468  */
469 error_t memcpy_to_user(env_t* env, void*DANGEROUS va,
470                  const void *COUNT(len) src, size_t len)
471 {
472         const void *DANGEROUS start, *DANGEROUS end;
473         size_t num_pages, i;
474         pte_t *pte;
475         uintptr_t perm = PTE_P | PTE_USER_RW;
476         size_t bytes_copied = 0;
477
478         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
479
480         start = ROUNDDOWN(va, PGSIZE);
481         end = ROUNDUP(va + len, PGSIZE);
482
483         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
484                 return -EFAULT;
485
486         num_pages = LA2PPN(end - start);
487         for(i = 0; i < num_pages; i++)
488         {
489                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
490                 if(!pte)
491                         return -EFAULT;
492                 if((*pte & PTE_P) && (*pte & PTE_USER_RW) != PTE_USER_RW)
493                         return -EFAULT;
494                 if(!(*pte & PTE_P))
495                         if(handle_page_fault(env,(uintptr_t)start+i*PGSIZE,PROT_WRITE))
496                                 return -EFAULT;
497
498                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
499                 void* dst_start = i > 0 ? kpage : kpage+(va-start);
500                 const void* src_start = src+bytes_copied;
501                 size_t copy_len = PGSIZE;
502                 if(i == 0)
503                         copy_len -= va-start;
504                 if(i == num_pages-1)
505                         copy_len -= end-(va+len);
506
507                 memcpy(dst_start,src_start,copy_len);
508                 bytes_copied += copy_len;
509         }
510
511         assert(bytes_copied == len);
512
513         return ESUCCESS;
514 }