Fixed logical bug in memcpy_from/to_user
[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
36 /**
37  * @brief Global variable used to store erroneous virtual addresses as the
38  *        result of a failed user_mem_check().
39  *
40  * zra: What if two checks fail at the same time? Maybe this should be per-cpu?
41  *
42  */
43 static void *DANGEROUS RACY user_mem_check_addr;
44
45 volatile uint32_t vpt_lock = 0;
46 volatile uint32_t vpd_lock = 0;
47
48 /**
49  * @brief Initialize the array of physical pages and memory free list.
50  *
51  * The 'pages' array has one 'page_t' entry per physical page.
52  * Pages are reference counted, and free pages are kept on a linked list.
53  */
54 void page_init(void)
55 {
56         /*
57      * First, make 'pages' point to an array of size 'npages' of
58          * type 'page_t'.
59          * The kernel uses this structure to keep track of physical pages;
60          * 'npages' equals the number of physical pages in memory.
61          * round up to the nearest page
62          */
63         pages = (page_t*)boot_alloc(npages*sizeof(page_t), PGSIZE);
64         memset(pages, 0, npages*sizeof(page_t));
65
66         /*
67      * Then initilaize everything so pages can start to be alloced and freed
68          * from the memory free list
69          */
70         page_alloc_init();
71
72         static_assert(PROCINFO_NUM_PAGES <= PTSIZE);
73         static_assert(PROCDATA_NUM_PAGES <= PTSIZE);
74 }
75
76 /** 
77  * @brief Map the physical page 'pp' into the virtual address 'va' in page
78  *        directory 'pgdir'
79  *
80  * Map the physical page 'pp' at virtual address 'va'.
81  * The permissions (the low 12 bits) of the page table
82  * entry should be set to 'perm|PTE_P'.
83  * 
84  * Details:
85  *   - If there is already a page mapped at 'va', it is page_remove()d.
86  *   - If necessary, on demand, allocates a page table and inserts it into 
87  *     'pgdir'.
88  *   - page_incref() should be called if the insertion succeeds. 
89  *   - The TLB must be invalidated if a page was formerly present at 'va'.
90  *     (this is handled in page_remove)
91  *
92  * No support for jumbos here.  We will need to be careful when trying to
93  * insert regular pages into something that was already jumbo.  We will
94  * also need to be careful with our overloading of the PTE_PS and 
95  * PTE_PAT flags...
96  *
97  * @param[in] pgdir the page directory to insert the page into
98  * @param[in] pp    a pointr to the page struct representing the
99  *                  physical page that should be inserted.
100  * @param[in] va    the virtual address where the page should be
101  *                  inserted.
102  * @param[in] perm  the permition bits with which to set up the 
103  *                  virtual mapping.
104  *
105  * @return ESUCCESS  on success
106  * @return -ENOMEM   if a page table could not be allocated
107  *                   into which the page should be inserted
108  *
109  */
110 int page_insert(pde_t *pgdir, page_t *pp, void *va, int perm) 
111 {
112         pte_t* pte = pgdir_walk(pgdir, va, 1);
113         if (!pte)
114                 return -ENOMEM;
115         // need to up the ref count in case pp is already mapped at va
116         // and we don't want to page_remove (which could free pp) and then 
117         // continue as if pp wasn't freed.  moral = up the ref asap
118         page_incref(pp);
119         if (*pte & PTE_P) {
120                 page_remove(pgdir, va);
121         }
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 && !(*pte & PTE_P)) 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'   
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 || !(*pte & PTE_P))
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         page = page_lookup(pgdir, va, &pte);
222         if (!page)
223                 return;
224         *pte = 0;
225         tlb_invalidate(pgdir, va);
226         page_decref(page);
227 }
228
229 /**
230  * @brief Invalidate a TLB entry, but only if the page tables being
231  * edited are the ones currently in use by the processor.
232  *
233  * TODO: Need to sort this for cross core lovin'
234  *
235  * @param pgdir the page directory assocaited with the tlb entry 
236  *              we are trying to invalidate
237  * @param va    the virtual address associated with the tlb entry
238  *              we are trying to invalidate
239  */
240 void tlb_invalidate(pde_t *pgdir, void *va)
241 {
242         // Flush the entry only if we're modifying the current address space.
243         // For now, there is only one address space, so always invalidate.
244         invlpg(va);
245 }
246
247 /**
248  * @brief Check that an environment is allowed to access the range of memory
249  * [va, va+len) with permissions 'perm | PTE_P'.
250  *
251  * Normally 'perm' will contain PTE_U at least, but this is not required.  The
252  * function get_va_perms only checks for PTE_U, PTE_W, and PTE_P.  It won't
253  * check for things like PTE_PS, PTE_A, etc.
254  * 'va' and 'len' need not be page-aligned;
255  *
256  * A user program can access a virtual address if:
257  *     -# the address is below ULIM
258  *     -# the page table gives it permission.  
259  *
260  * If there is an error, 'user_mem_check_addr' is set to the first
261  * erroneous virtual address.
262  *
263  * @param env  the environment associated with the user program trying to access
264  *             the virtual address range
265  * @param va   the first virtual address in the range
266  * @param len  the length of the virtual address range
267  * @param perm the permissions the user is trying to access the virtual address 
268  *             range with
269  *
270  * @return VA a pointer of type COUNT(len) to the address range
271  * @return NULL trying to access this range of virtual addresses is not allowed
272  */
273 void* user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
274 {
275         if (len == 0) {
276                 warn("Called user_mem_check with a len of 0. Don't do that. Returning NULL");
277                 return NULL;
278         }
279         
280         // TODO - will need to sort this out wrt page faulting / PTE_P
281         // also could be issues with sleeping and waking up to find pages
282         // are unmapped, though i think the lab ignores this since the 
283         // kernel is uninterruptible
284         void *DANGEROUS start, *DANGEROUS end;
285         size_t num_pages, i;
286         int page_perms = 0;
287
288         perm |= PTE_P;
289         start = ROUNDDOWN((void*DANGEROUS)va, PGSIZE);
290         end = ROUNDUP((void*DANGEROUS)va + len, PGSIZE);
291         if (start >= end) {
292                 warn("Blimey!  Wrap around in VM range calculation!");  
293                 return NULL;
294         }
295         num_pages = LA2PPN(end - start);
296         for (i = 0; i < num_pages; i++, start += PGSIZE) {
297                 page_perms = get_va_perms(env->env_pgdir, start);
298                 // ensures the bits we want on are turned on.  if not, error out
299                 if ((page_perms & perm) != perm) {
300                         if (i == 0)
301                                 user_mem_check_addr = (void*DANGEROUS)va;
302                         else
303                                 user_mem_check_addr = start;
304                         return NULL;
305                 }
306         }
307         // this should never be needed, since the perms should catch it
308         if ((uintptr_t)end > ULIM) {
309                 warn ("I suck - Bug in user permission mappings!");
310                 return NULL;
311         }
312         return (void *COUNT(len))TC(va);
313 }
314
315 /**
316  * @brief Use the kernel to copy a string from a buffer stored in userspace
317  *        to a buffer stored elsewhere in the address space (potentially in 
318  *        memory only accessible by the kernel)
319  *
320  * @param env  the environment associated with the user program from which
321  *             the string is being copied
322  * @param dst  the destination of the buffer into which the string 
323  *             is being copied
324  * @param va   the start address of the buffer where the string resides
325  * @param len  the length of the buffer 
326  * @param perm the permissions with which the user is trying to access 
327  *             elements of the original buffer 
328  *
329  * @return LEN the length of the new buffer copied into 'dst'
330  */
331 size_t
332 user_mem_strlcpy(env_t *env, char *_dst, const char *DANGEROUS va,
333                  size_t _len, int perm)
334 {
335         const char *DANGEROUS src = va;
336         size_t len = _len;
337         char *NT COUNT(_len-1) dst_in = _dst;
338         char *NT BND(_dst,_dst + _len - 1) dst = _dst;
339
340         if (len > 0) {
341                 while (1) {
342                         char *c;
343                         // what if len was 1?
344                         if (--len <= 0) break;
345                         c = user_mem_check(env, src, 1, perm);
346                         if (!c) break;
347                         if (*c == '\0') break;
348                         // TODO: ivy bitches about this
349                         *dst++ = *c;
350                         src++;
351                 }
352                 *dst = '\0';
353         }
354
355         return dst - dst_in;
356 }
357
358 /**
359  * @brief Checks that environment 'env' is allowed to access the range
360  * of memory [va, va+len) with permissions 'perm | PTE_U'. Destroy 
361  * environment 'env' if the assertion fails.
362  *
363  * This function is identical to user_mem_assert() except that it has a side
364  * affect of destroying the environment 'env' if the memory check fails.
365  *
366  * @param env  the environment associated with the user program trying to access
367  *             the virtual address range
368  * @param va   the first virtual address in the range
369  * @param len  the length of the virtual address range
370  * @param perm the permissions the user is trying to access the virtual address 
371  *             range with
372  *
373  * @return VA a pointer of type COUNT(len) to the address range
374  * @return NULL trying to access this range of virtual addresses is not allowed
375  *              environment 'env' is destroyed
376  */
377 void *
378 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
379 {
380         if (len == 0) {
381                 warn("Called user_mem_assert with a len of 0. Don't do that. Returning NULL");
382                 return NULL;
383         }
384         
385         void *COUNT(len) res = user_mem_check(env,va,len,perm | PTE_USER_RO);
386         if (!res) {
387                 cprintf("[%08x] user_mem_check assertion failure for "
388                         "va %08x\n", env->pid, user_mem_check_addr);
389                 proc_destroy(env);      // may not return
390         return NULL;
391         }
392     return res;
393 }
394
395 /**
396  * @brief Copies data from a user buffer to a kernel buffer.
397  * 
398  * @param env  the environment associated with the user program
399  *             from which the buffer is being copied
400  * @param dest the destination address of the kernel buffer
401  * @param va   the address of the userspace buffer from which we are copying
402  * @param len  the length of the userspace buffer
403  *
404  * @return ESUCCESS on success
405  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
406  *                  lacks the proper permissions, or there was an invalid 'va'
407  */
408 error_t memcpy_from_user(env_t* env, void* COUNT(len) dest,
409                  const void *DANGEROUS va, size_t len)
410 {
411         const void *DANGEROUS start, *DANGEROUS end;
412         size_t num_pages, i;
413         pte_t *pte;
414         uintptr_t perm = PTE_P | PTE_USER_RO;
415         size_t bytes_copied = 0;
416
417         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
418
419         start = ROUNDDOWN(va, PGSIZE);
420         end = ROUNDUP(va + len, PGSIZE);
421
422         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
423                 return -EFAULT;
424
425         num_pages = LA2PPN(end - start);
426         for(i = 0; i < num_pages; i++)
427         {
428                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
429                 if(!pte || (*pte & perm) != perm)
430                         return -EFAULT;
431
432                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
433                 const void* src_start = i > 0 ? kpage : kpage+(va-start);
434                 void* dst_start = dest+bytes_copied;
435                 size_t copy_len = PGSIZE;
436                 if(i == 0)
437                         copy_len -= va-start;
438                 if(i == num_pages-1)
439                         copy_len -= end-(va+len);
440
441                 memcpy(dst_start,src_start,copy_len);
442                 bytes_copied += copy_len;
443         }
444
445         assert(bytes_copied == len);
446
447         return ESUCCESS;
448 }
449
450 /**
451  * @brief Copies data to a user buffer from a kernel buffer.
452  * 
453  * @param env  the environment associated with the user program
454  *             to which the buffer is being copied
455  * @param dest the destination address of the user buffer
456  * @param va   the address of the kernel buffer from which we are copying
457  * @param len  the length of the user buffer
458  *
459  * @return ESUCCESS on success
460  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
461  *                  lacks the proper permissions, or there was an invalid 'va'
462  */
463 error_t memcpy_to_user(env_t* env, void*DANGEROUS va,
464                  const void *COUNT(len) src, size_t len)
465 {
466         const void *DANGEROUS start, *DANGEROUS end;
467         size_t num_pages, i;
468         pte_t *pte;
469         uintptr_t perm = PTE_P | PTE_USER_RW;
470         size_t bytes_copied = 0;
471
472         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
473
474         start = ROUNDDOWN(va, PGSIZE);
475         end = ROUNDUP(va + len, PGSIZE);
476
477         if(start >= (void*SNT)ULIM || end > (void*SNT)ULIM)
478                 return -EFAULT;
479
480         num_pages = LA2PPN(end - start);
481         for(i = 0; i < num_pages; i++)
482         {
483                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
484                 if(!pte || (*pte & perm) != perm)
485                         return -EFAULT;
486
487                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(*pte));
488                 void* dst_start = i > 0 ? kpage : kpage+(va-start);
489                 const void* src_start = src+bytes_copied;
490                 size_t copy_len = PGSIZE;
491                 if(i == 0)
492                         copy_len -= va-start;
493                 if(i == num_pages-1)
494                         copy_len -= end-(va+len);
495
496                 memcpy(dst_start,src_start,copy_len);
497                 bytes_copied += copy_len;
498         }
499
500         assert(bytes_copied == len);
501
502         return ESUCCESS;
503 }