Corrected runtime errors with multiboot_detect_memory() and page_init()
[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 #include <arch/arch.h>
19 #include <arch/mmu.h>
20
21 #include <ros/error.h>
22
23 #include <kmalloc.h>
24 #include <atomic.h>
25 #include <string.h>
26 #include <assert.h>
27 #include <pmap.h>
28 #include <kclock.h>
29 #include <process.h>
30 #include <stdio.h>
31
32 /**
33  * @brief Global variable used to store erroneous virtual addresses as the
34  *        result of a failed user_mem_check().
35  */
36 static void *DANGEROUS user_mem_check_addr;
37
38 volatile uint32_t vpt_lock = 0;
39 volatile uint32_t vpd_lock = 0;
40
41 /**
42  * @brief Initialize the array of physical pages and memory free list.
43  *
44  * The 'pages' array has one 'page_t' entry per physical page.
45  * Pages are reference counted, and free pages are kept on a linked list.
46  */
47 void page_init(void)
48 {
49         /*
50      * First, make 'pages' point to an array of size 'npages' of
51          * type 'page_t'.
52          * The kernel uses this structure to keep track of physical pages;
53          * 'npages' equals the number of physical pages in memory.
54          * round up to the nearest page
55          */
56         pages = (page_t*)boot_alloc(npages*sizeof(page_t), PGSIZE);
57         memset(pages, 0, npages*sizeof(page_t));
58
59         /*
60      * Then initilaize everything so pages can start to be alloced and freed
61          * from the memory free list
62          */
63         page_alloc_init();
64 }
65
66 /** 
67  * @brief Map the physical page 'pp' into the virtual address 'va' in page
68  *        directory 'pgdir'
69  *
70  * Map the physical page 'pp' at virtual address 'va'.
71  * The permissions (the low 12 bits) of the page table
72  * entry should be set to 'perm|PTE_P'.
73  * 
74  * Details:
75  *   - If there is already a page mapped at 'va', it is page_remove()d.
76  *   - If necessary, on demand, allocates a page table and inserts it into 
77  *     'pgdir'.
78  *   - page_incref() should be called if the insertion succeeds. 
79  *   - The TLB must be invalidated if a page was formerly present at 'va'.
80  *     (this is handled in page_remove)
81  *
82  * No support for jumbos here.  We will need to be careful when trying to
83  * insert regular pages into something that was already jumbo.  We will
84  * also need to be careful with our overloading of the PTE_PS and 
85  * PTE_PAT flags...
86  *
87  * @param[in] pgdir the page directory to insert the page into
88  * @param[in] pp    a pointr to the page struct representing the
89  *                  physical page that should be inserted.
90  * @param[in] va    the virtual address where the page should be
91  *                  inserted.
92  * @param[in] perm  the permition bits with which to set up the 
93  *                  virtual mapping.
94  *
95  * @return ESUCCESS  on success
96  * @return -ENOMEM   if a page table could not be allocated
97  *                   into which the page should be inserted
98  *
99  */
100 int page_insert(pde_t *pgdir, page_t *pp, void *va, int perm) 
101 {
102         pte_t* pte = pgdir_walk(pgdir, va, 1);
103         if (!pte)
104                 return -ENOMEM;
105         // need to up the ref count in case pp is already mapped at va
106         // and we don't want to page_remove (which could free pp) and then 
107         // continue as if pp wasn't freed.  moral = up the ref asap
108         page_incref(pp);
109         if (*pte & PTE_P) {
110                 page_remove(pgdir, va);
111         }
112         *pte = PTE(page2ppn(pp), PTE_P | perm);
113         return 0;
114 }
115
116 /**
117  * @brief Map the physical page 'pp' at the first virtual address that is free 
118  * in the range 'vab' to 'vae' in page directory 'pgdir'.
119  *
120  * The permissions (the low 12 bits) of the page table entry get set to 
121  * 'perm|PTE_P'.
122  *
123  * Details:
124  *   - If there is no free entry in the range 'vab' to 'vae' this 
125  *     function returns NULL.
126  *   - If necessary, on demand, this function will allocate a page table 
127  *     and inserts it into 'pgdir'.
128  *   - page_incref() will be called if the insertion succeeds.
129  * 
130  * @param[in] pgdir the page directory to insert the page into
131  * @param[in] pp    a pointr to the page struct representing the
132  *                  physical page that should be inserted.
133  * @param[in] vab   the first virtual address in the range in which the 
134  *                  page can be inserted.
135  * @param[in] vae   the last virtual address in the range in which the 
136  *                  page can be inserted.
137  * @param[in] perm  the permition bits with which to set up the 
138  *                  virtual mapping.
139  *
140  * @return VA   the virtual address where pp has been mapped in the 
141  *              range (vab, vae)
142  * @return NULL no free va in the range (vab, vae) could be found
143  */
144 void* page_insert_in_range(pde_t *pgdir, page_t *pp, 
145                            void *vab, void *vae, int perm) 
146 {
147         pte_t* pte = NULL;
148         void*SNT new_va;
149         
150         for(new_va = vab; new_va <= vae; new_va+= PGSIZE) {
151                 pte = pgdir_walk(pgdir, new_va, 1);
152                 if(pte != NULL && !(*pte & PTE_P)) break;
153                 else pte = NULL;
154         }
155         if (!pte) return NULL;
156         *pte = page2pa(pp) | PTE_P | perm;
157         return TC(new_va); // trusted because mapping a page is like allocation
158 }
159
160 /**
161  * @brief Return the page mapped at virtual address 'va' in 
162  * page directory 'pgdir'.
163  *
164  * If pte_store is not NULL, then we store in it the address
165  * of the pte for this page.  This is used by page_remove
166  * but should not be used by other callers.
167  *
168  * For jumbos, right now this returns the first Page* in the 4MB range
169  *
170  * @param[in]  pgdir     the page directory from which we should do the lookup
171  * @param[in]  va        the virtual address of the page we are looking up
172  * @param[out] pte_store the address of the page table entry for the returned page
173  *
174  * @return PAGE the page mapped at virtual address 'va'
175  * @return NULL No mapping exists at virtual address 'va'   
176  */
177 page_t *page_lookup(pde_t *pgdir, void *va, pte_t **pte_store)
178 {
179         pte_t* pte = pgdir_walk(pgdir, va, 0);
180         if (!pte || !(*pte & PTE_P))
181                 return 0;
182         if (pte_store)
183                 *pte_store = pte;
184         return pa2page(PTE_ADDR(*pte));
185 }
186
187 /**
188  * @brief Unmaps the physical page at virtual address 'va' in page directory
189  * 'pgdir'.
190  *
191  * If there is no physical page at that address, this function silently 
192  * does nothing.
193  *
194  * Details:
195  *   - The ref count on the physical page is decrement when the page is removed
196  *   - The physical page is freed if the refcount reaches 0.
197  *   - The pg table entry corresponding to 'va' is set to 0.
198  *     (if such a PTE exists)
199  *   - The TLB is invalidated if an entry is removes from the pg dir/pg table.
200  *
201  * This may be wonky wrt Jumbo pages and decref.  
202  *
203  * @param pgdir the page directory from with the page sholuld be removed
204  * @param va    the virtual address at which the page we are trying to 
205  *              remove is mapped
206  */
207 void page_remove(pde_t *pgdir, void *va)
208 {
209         pte_t* pte;
210         page_t *page;
211         page = page_lookup(pgdir, va, &pte);
212         if (!page)
213                 return;
214         *pte = 0;
215         tlb_invalidate(pgdir, va);
216         page_decref(page);
217 }
218
219 /**
220  * @brief Invalidate a TLB entry, but only if the page tables being
221  * edited are the ones currently in use by the processor.
222  *
223  * TODO: Need to sort this for cross core lovin'
224  *
225  * @param pgdir the page directory assocaited with the tlb entry 
226  *              we are trying to invalidate
227  * @param va    the virtual address associated with the tlb entry
228  *              we are trying to invalidate
229  */
230 void tlb_invalidate(pde_t *pgdir, void *va)
231 {
232         // Flush the entry only if we're modifying the current address space.
233         // For now, there is only one address space, so always invalidate.
234         invlpg(va);
235 }
236
237 /**
238  * @brief Check that an environment is allowed to access the range of memory
239  * [va, va+len) with permissions 'perm | PTE_P'.
240  *
241  * Normally 'perm' will contain PTE_U at least, but this is not required.
242  * 'va' and 'len' need not be page-aligned;
243  *
244  * A user program can access a virtual address if:
245  *     -# the address is below ULIM
246  *     -# the page table gives it permission.  
247  *
248  * If there is an error, 'user_mem_check_addr' is set to the first
249  * erroneous virtual address.
250  *
251  * @param env  the environment associated with the user program trying to access
252  *             the virtual address range
253  * @param va   the first virtual address in the range
254  * @param len  the length of the virtual address range
255  * @param perm the permissions the user is trying to access the virtual address 
256  *             range with
257  *
258  * @return VA a pointer of type COUNT(len) to the address range
259  * @return NULL trying to access this range of virtual addresses is not allowed
260  */
261 void* user_mem_check(env_t *env, const void *DANGEROUS va, size_t len, int perm)
262 {
263         // TODO - will need to sort this out wrt page faulting / PTE_P
264         // also could be issues with sleeping and waking up to find pages
265         // are unmapped, though i think the lab ignores this since the 
266         // kernel is uninterruptible
267         void *DANGEROUS start, *DANGEROUS end;
268         size_t num_pages, i;
269         pte_t *pte;
270
271         perm |= PTE_P;
272         start = ROUNDDOWN((void*DANGEROUS)va, PGSIZE);
273         end = ROUNDUP((void*DANGEROUS)va + len, PGSIZE);
274         if (start >= end) {
275                 warn("Blimey!  Wrap around in VM range calculation!");  
276                 return NULL;
277         }
278         num_pages = PPN(end - start);
279         for (i = 0; i < num_pages; i++, start += PGSIZE) {
280                 pte = pgdir_walk(env->env_pgdir, start, 0);
281                 // ensures the bits we want on are turned on.  if not, error out
282                 if ( !pte || ((*pte & perm) != perm) ) {
283                         if (i == 0)
284                                 user_mem_check_addr = (void*DANGEROUS)va;
285                         else
286                                 user_mem_check_addr = start;
287                         return NULL;
288                 }
289         }
290         // this should never be needed, since the perms should catch it
291         if ((uintptr_t)end > ULIM) {
292                 warn ("I suck - Bug in user permission mappings!");
293                 return NULL;
294         }
295         return (void *COUNT(len))TC(va);
296 }
297
298 /**
299  * @brief Use the kernel to copy a string from a buffer stored in userspace
300  *        to a buffer stored elsewhere in the address space (potentially in 
301  *        memory only accessible by the kernel)
302  *
303  * @param env  the environment associated with the user program from which
304  *             the string is being copied
305  * @param dst  the destination of the buffer into which the string 
306  *             is being copied
307  * @param va   the start address of the buffer where the string resides
308  * @param len  the length of the buffer 
309  * @param perm the permissions with which the user is trying to access 
310  *             elements of the original buffer 
311  *
312  * @return LEN the length of the new buffer copied into 'dst'
313  */
314 size_t
315 user_mem_strlcpy(env_t *env, char *dst, const char *DANGEROUS va,
316                  size_t _len, int perm)
317 {
318         const char *DANGEROUS src = va;
319         size_t len = _len;
320         char *NT COUNT(_len-1) dst_in = dst;
321
322         if (len > 0) {
323                 while (1) {
324                         char *c;
325                         if (--len <= 0) break;
326                         c = user_mem_check(env, src, 1, perm);
327                         if (!c) break;
328                         if (*c == '\0') break;
329                         *dst++ = *c;
330                         src++;
331                 }
332                 *dst = '\0';
333         }
334
335         return dst - dst_in;
336 }
337
338 /**
339  * @brief Checks that environment 'env' is allowed to access the range
340  * of memory [va, va+len) with permissions 'perm | PTE_U'. Destroy 
341  * environment 'env' if the assertion fails.
342  *
343  * This function is identical to user_mem_assert() except that it has a side
344  * affect of destroying the environment 'env' if the memory check fails.
345  *
346  * @param env  the environment associated with the user program trying to access
347  *             the virtual address range
348  * @param va   the first virtual address in the range
349  * @param len  the length of the virtual address range
350  * @param perm the permissions the user is trying to access the virtual address 
351  *             range with
352  *
353  * @return VA a pointer of type COUNT(len) to the address range
354  * @return NULL trying to access this range of virtual addresses is not allowed
355  *              environment 'env' is destroyed
356  */
357 void *
358 user_mem_assert(env_t *env, const void *DANGEROUS va, size_t len, int perm)
359 {
360     void *COUNT(len) res = user_mem_check(env,va,len,perm | PTE_USER_RO);
361         if (!res) {
362                 cprintf("[%08x] user_mem_check assertion failure for "
363                         "va %08x\n", env->env_id, user_mem_check_addr);
364                 proc_destroy(env);      // may not return
365         return NULL;
366         }
367     return res;
368 }
369
370 /**
371  * @brief Copies data from a user buffer to a kernel buffer.
372  * 
373  * @param env  the environment associated with the user program
374  *             from which the buffer is being copied
375  * @param dest the destination address of the kernel buffer
376  * @param va   the address of the userspace buffer from which we are copying
377  * @param len  the length of the userspace buffer
378  *
379  * @return ESUCCESS on success
380  * @return -EFAULT  the page assocaited with 'va' is not present, the user 
381  *                  lacks the proper permissions, or there was an invalid 'va'
382  */
383 error_t memcpy_from_user(env_t* env, void* COUNT(len) dest,
384                  const void *DANGEROUS va, size_t len)
385 {
386         const void *DANGEROUS start, *DANGEROUS end;
387         size_t num_pages, i;
388         pte_t *pte;
389         uintptr_t perm = PTE_P | PTE_USER_RO;
390         size_t bytes_copied = 0;
391
392         static_assert(ULIM % PGSIZE == 0 && ULIM != 0); // prevent wrap-around
393
394         start = ROUNDDOWN(va, PGSIZE);
395         end = ROUNDUP(va + len, PGSIZE);
396
397         if(start >= (void*SNT)ULIM || end >= (void*SNT)ULIM)
398                 return -EFAULT;
399
400         num_pages = PPN(end - start);
401         for(i = 0; i < num_pages; i++)
402         {
403                 pte = pgdir_walk(env->env_pgdir, start+i*PGSIZE, 0);
404                 if(!pte || (*pte & perm) != perm)
405                         return -EFAULT;
406
407                 void*COUNT(PGSIZE) kpage = KADDR(PTE_ADDR(pte));
408                 void* src_start = i > 0 ? kpage : kpage+(va-start);
409                 void* dst_start = dest+bytes_copied;
410                 size_t copy_len = PGSIZE;
411                 if(i == 0)
412                         copy_len -= va-start;
413                 if(i == num_pages-1)
414                         copy_len -= end-(start+len);
415
416                 memcpy(dst_start,src_start,copy_len);
417                 bytes_copied += copy_len;
418         }
419
420         assert(bytes_copied == len);
421
422         return ESUCCESS;
423 }
424