ead6c432cbbbcf23862e6d169e29a5227576aba0
[akaros.git] / kern / src / mm.c
1 /* Copyright (c) 2009, 2010 The Regents of the University of California
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Virtual memory management functions.  Creation, modification, etc, of virtual
6  * memory regions (VMRs) as well as mmap(), mprotect(), and munmap().
7  *
8  * In general, error checking / bounds checks are done in the main function
9  * (e.g. mmap()), and the work is done in a do_ function (e.g. do_mmap()).
10  * Versions of those functions that are called when the vmr lock is already held
11  * begin with __ (e.g. __do_munmap()).
12  *
13  * Note that if we were called from kern/src/syscall.c, we probably don't have
14  * an edible reference to p. */
15
16 #include <frontend.h>
17 #include <ros/common.h>
18 #include <pmap.h>
19 #include <mm.h>
20 #include <process.h>
21 #include <stdio.h>
22 #include <syscall.h>
23 #include <slab.h>
24 #include <kmalloc.h>
25 #include <vfs.h>
26 #include <smp.h>
27
28 struct kmem_cache *vmr_kcache;
29
30 static int __vmr_free_pgs(struct proc *p, pte_t *pte, void *va, void *arg);
31 /* minor helper, will ease the file->chan transition */
32 static struct page_map *file2pm(struct file *file)
33 {
34         return file->f_mapping;
35 }
36
37 void vmr_init(void)
38 {
39         vmr_kcache = kmem_cache_create("vm_regions", sizeof(struct vm_region),
40                                        __alignof__(struct dentry), 0, 0, 0);
41 }
42
43 /* For now, the caller will set the prot, flags, file, and offset.  In the
44  * future, we may put those in here, to do clever things with merging vm_regions
45  * that are the same.
46  *
47  * TODO: take a look at solari's vmem alloc.  And consider keeping these in a
48  * tree of some sort for easier lookups. */
49 struct vm_region *create_vmr(struct proc *p, uintptr_t va, size_t len)
50 {
51         struct vm_region *vmr = 0, *vm_i, *vm_next;
52         uintptr_t gap_end;
53
54         assert(!PGOFF(va));
55         assert(!PGOFF(len));
56         assert(va + len <= UMAPTOP);
57         /* Is there room before the first one: */
58         vm_i = TAILQ_FIRST(&p->vm_regions);
59         /* This works for now, but if all we have is BRK_END ones, we'll start
60          * growing backwards (TODO) */
61         if (!vm_i || (va + len < vm_i->vm_base)) {
62                 vmr = kmem_cache_alloc(vmr_kcache, 0);
63                 if (!vmr)
64                         panic("EOM!");
65                 memset(vmr, 0, sizeof(struct vm_region));
66                 vmr->vm_base = va;
67                 TAILQ_INSERT_HEAD(&p->vm_regions, vmr, vm_link);
68         } else {
69                 TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
70                         vm_next = TAILQ_NEXT(vm_i, vm_link);
71                         gap_end = vm_next ? vm_next->vm_base : UMAPTOP;
72                         /* skip til we get past the 'hint' va */
73                         if (va >= gap_end)
74                                 continue;
75                         /* Find a gap that is big enough */
76                         if (gap_end - vm_i->vm_end >= len) {
77                                 vmr = kmem_cache_alloc(vmr_kcache, 0);
78                                 if (!vmr)
79                                         panic("EOM!");
80                                 memset(vmr, 0, sizeof(struct vm_region));
81                                 /* if we can put it at va, let's do that.  o/w, put it so it
82                                  * fits */
83                                 if ((gap_end >= va + len) && (va >= vm_i->vm_end))
84                                         vmr->vm_base = va;
85                                 else
86                                         vmr->vm_base = vm_i->vm_end;
87                                 TAILQ_INSERT_AFTER(&p->vm_regions, vm_i, vmr, vm_link);
88                                 break;
89                         }
90                 }
91         }
92         /* Finalize the creation, if we got one */
93         if (vmr) {
94                 vmr->vm_proc = p;
95                 vmr->vm_end = vmr->vm_base + len;
96         }
97         if (!vmr)
98                 warn("Not making a VMR, wanted %p, + %p = %p", va, len, va + len);
99         return vmr;
100 }
101
102 /* Split a VMR at va, returning the new VMR.  It is set up the same way, with
103  * file offsets fixed accordingly.  'va' is the beginning of the new one, and
104  * must be page aligned. */
105 struct vm_region *split_vmr(struct vm_region *old_vmr, uintptr_t va)
106 {
107         struct vm_region *new_vmr;
108
109         assert(!PGOFF(va));
110         if ((old_vmr->vm_base >= va) || (old_vmr->vm_end <= va))
111                 return 0;
112         new_vmr = kmem_cache_alloc(vmr_kcache, 0);
113         TAILQ_INSERT_AFTER(&old_vmr->vm_proc->vm_regions, old_vmr, new_vmr,
114                            vm_link);
115         new_vmr->vm_proc = old_vmr->vm_proc;
116         new_vmr->vm_base = va;
117         new_vmr->vm_end = old_vmr->vm_end;
118         old_vmr->vm_end = va;
119         new_vmr->vm_prot = old_vmr->vm_prot;
120         new_vmr->vm_flags = old_vmr->vm_flags;
121         if (old_vmr->vm_file) {
122                 kref_get(&old_vmr->vm_file->f_kref, 1);
123                 new_vmr->vm_file = old_vmr->vm_file;
124                 new_vmr->vm_foff = old_vmr->vm_foff +
125                                       old_vmr->vm_end - old_vmr->vm_base;
126                 pm_add_vmr(file2pm(old_vmr->vm_file), new_vmr);
127         } else {
128                 new_vmr->vm_file = 0;
129                 new_vmr->vm_foff = 0;
130         }
131         return new_vmr;
132 }
133
134 /* Merges two vm regions.  For now, it will check to make sure they are the
135  * same.  The second one will be destroyed. */
136 int merge_vmr(struct vm_region *first, struct vm_region *second)
137 {
138         assert(first->vm_proc == second->vm_proc);
139         if ((first->vm_end != second->vm_base) ||
140             (first->vm_prot != second->vm_prot) ||
141             (first->vm_flags != second->vm_flags) ||
142             (first->vm_file != second->vm_file))
143                 return -1;
144         if ((first->vm_file) && (second->vm_foff != first->vm_foff +
145                                  first->vm_end - first->vm_base))
146                 return -1;
147         first->vm_end = second->vm_end;
148         destroy_vmr(second);
149         return 0;
150 }
151
152 /* Attempts to merge vmr with adjacent VMRs, returning a ptr to be used for vmr.
153  * It could be the same struct vmr, or possibly another one (usually lower in
154  * the address space. */
155 struct vm_region *merge_me(struct vm_region *vmr)
156 {
157         struct vm_region *vmr_temp;
158         /* Merge will fail if it cannot do it.  If it succeeds, the second VMR is
159          * destroyed, so we need to be a bit careful. */
160         vmr_temp = TAILQ_PREV(vmr, vmr_tailq, vm_link);
161         if (vmr_temp)
162                 if (!merge_vmr(vmr_temp, vmr))
163                         vmr = vmr_temp;
164         vmr_temp = TAILQ_NEXT(vmr, vm_link);
165         if (vmr_temp)
166                 merge_vmr(vmr, vmr_temp);
167         return vmr;
168 }
169
170 /* Grows the vm region up to (and not including) va.  Fails if another is in the
171  * way, etc. */
172 int grow_vmr(struct vm_region *vmr, uintptr_t va)
173 {
174         assert(!PGOFF(va));
175         struct vm_region *next = TAILQ_NEXT(vmr, vm_link);
176         if (next && next->vm_base < va)
177                 return -1;
178         if (va <= vmr->vm_end)
179                 return -1;
180         vmr->vm_end = va;
181         return 0;
182 }
183
184 /* Shrinks the vm region down to (and not including) va.  Whoever calls this
185  * will need to sort out the page table entries. */
186 int shrink_vmr(struct vm_region *vmr, uintptr_t va)
187 {
188         assert(!PGOFF(va));
189         if ((va < vmr->vm_base) || (va > vmr->vm_end))
190                 return -1;
191         vmr->vm_end = va;
192         return 0;
193 }
194
195 /* Called by the unmapper, just cleans up.  Whoever calls this will need to sort
196  * out the page table entries. */
197 void destroy_vmr(struct vm_region *vmr)
198 {
199         if (vmr->vm_file) {
200                 pm_remove_vmr(file2pm(vmr->vm_file), vmr);
201                 kref_put(&vmr->vm_file->f_kref);
202         }
203         TAILQ_REMOVE(&vmr->vm_proc->vm_regions, vmr, vm_link);
204         kmem_cache_free(vmr_kcache, vmr);
205 }
206
207 /* Given a va and a proc (later an mm, possibly), returns the owning vmr, or 0
208  * if there is none. */
209 struct vm_region *find_vmr(struct proc *p, uintptr_t va)
210 {
211         struct vm_region *vmr;
212         /* ugly linear seach */
213         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
214                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
215                         return vmr;
216         }
217         return 0;
218 }
219
220 /* Finds the first vmr after va (including the one holding va), or 0 if there is
221  * none. */
222 struct vm_region *find_first_vmr(struct proc *p, uintptr_t va)
223 {
224         struct vm_region *vmr;
225         /* ugly linear seach */
226         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
227                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
228                         return vmr;
229                 if (vmr->vm_base > va)
230                         return vmr;
231         }
232         return 0;
233 }
234
235 /* Makes sure that no VMRs cross either the start or end of the given region
236  * [va, va + len), splitting any VMRs that are on the endpoints. */
237 void isolate_vmrs(struct proc *p, uintptr_t va, size_t len)
238 {
239         struct vm_region *vmr;
240         if ((vmr = find_vmr(p, va)))
241                 split_vmr(vmr, va);
242         /* TODO: don't want to do another find (linear search) */
243         if ((vmr = find_vmr(p, va + len)))
244                 split_vmr(vmr, va + len);
245 }
246
247 void unmap_and_destroy_vmrs(struct proc *p)
248 {
249         struct vm_region *vmr_i, *vmr_temp;
250         /* this only gets called from __proc_free, so there should be no sync
251          * concerns.  still, better safe than sorry. */
252         spin_lock(&p->vmr_lock);
253         spin_lock(&p->pte_lock);
254         TAILQ_FOREACH(vmr_i, &p->vm_regions, vm_link) {
255                 /* note this CB sets the PTE = 0, regardless of if it was P or not */
256                 env_user_mem_walk(p, (void*)vmr_i->vm_base,
257                                   vmr_i->vm_end - vmr_i->vm_base, __vmr_free_pgs, 0);
258         }
259         spin_unlock(&p->pte_lock);
260         /* need the safe style, since destroy_vmr modifies the list.  also, we want
261          * to do this outside the pte lock, since it grabs the pm lock. */
262         TAILQ_FOREACH_SAFE(vmr_i, &p->vm_regions, vm_link, vmr_temp)
263                 destroy_vmr(vmr_i);
264         spin_unlock(&p->vmr_lock);
265 }
266
267 /* Helper: copies the contents of pages from p to new p.  For pages that aren't
268  * present, once we support swapping or CoW, we can do something more
269  * intelligent.  0 on success, -ERROR on failure. */
270 static int copy_pages(struct proc *p, struct proc *new_p, uintptr_t va_start,
271                       uintptr_t va_end)
272 {
273         /* Sanity checks.  If these fail, we had a screwed up VMR.
274          * Check for: alignment, wraparound, or userspace addresses */
275         if ((PGOFF(va_start)) ||
276             (PGOFF(va_end)) ||
277             (va_end < va_start) ||      /* now, start > UMAPTOP -> end > UMAPTOP */
278             (va_end > UMAPTOP)) {
279                 warn("VMR mapping is probably screwed up (%p - %p)", va_start,
280                      va_end);
281                 return -EINVAL;
282         }
283         int copy_page(struct proc *p, pte_t *pte, void *va, void *arg) {
284                 struct proc *new_p = (struct proc*)arg;
285                 struct page *pp;
286                 if (PAGE_UNMAPPED(*pte))
287                         return 0;
288                 /* pages could be !P, but right now that's only for file backed VMRs
289                  * undergoing page removal, which isn't the caller of copy_pages. */
290                 if (PAGE_PRESENT(*pte)) {
291                         /* TODO: check for jumbos */
292                         if (upage_alloc(new_p, &pp, 0))
293                                 return -ENOMEM;
294                         if (page_insert(new_p->env_pgdir, pp, va, *pte & PTE_PERM)) {
295                                 page_decref(pp);
296                                 return -ENOMEM;
297                         }
298                         memcpy(page2kva(pp), ppn2kva(PTE2PPN(*pte)), PGSIZE);
299                         page_decref(pp);
300                 } else if (PAGE_PAGED_OUT(*pte)) {
301                         /* TODO: (SWAP) will need to either make a copy or CoW/refcnt the
302                          * backend store.  For now, this PTE will be the same as the
303                          * original PTE */
304                         panic("Swapping not supported!");
305                 } else {
306                         panic("Weird PTE %p in %s!", *pte, __FUNCTION__);
307                 }
308                 return 0;
309         }
310         return env_user_mem_walk(p, (void*)va_start, va_end - va_start, &copy_page,
311                                  new_p);
312 }
313
314 /* This will make new_p have the same VMRs as p, and it will make sure all
315  * physical pages are copied over, with the exception of MAP_SHARED files.
316  * This is used by fork().
317  *
318  * Note that if you are working on a VMR that is a file, you'll want to be
319  * careful about how it is mapped (SHARED, PRIVATE, etc). */
320 int duplicate_vmrs(struct proc *p, struct proc *new_p)
321 {
322         int ret = 0;
323         struct vm_region *vmr, *vm_i;
324         TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
325                 vmr = kmem_cache_alloc(vmr_kcache, 0);
326                 if (!vmr)
327                         return -ENOMEM;
328                 vmr->vm_proc = new_p;
329                 vmr->vm_base = vm_i->vm_base;
330                 vmr->vm_end = vm_i->vm_end;
331                 vmr->vm_prot = vm_i->vm_prot;   
332                 vmr->vm_flags = vm_i->vm_flags; 
333                 vmr->vm_file = vm_i->vm_file;
334                 vmr->vm_foff = vm_i->vm_foff;
335                 if (vm_i->vm_file) {
336                         kref_get(&vm_i->vm_file->f_kref, 1);
337                         pm_add_vmr(file2pm(vm_i->vm_file), vmr);
338                 }
339                 if (!vmr->vm_file || vmr->vm_flags & MAP_PRIVATE) {
340                         assert(!(vmr->vm_flags & MAP_SHARED));
341                         /* Copy over the memory from one VMR to the other */
342                         if ((ret = copy_pages(p, new_p, vmr->vm_base, vmr->vm_end)))
343                                 return ret;
344                 }
345                 TAILQ_INSERT_TAIL(&new_p->vm_regions, vmr, vm_link);
346         }
347         return 0;
348 }
349
350 void print_vmrs(struct proc *p)
351 {
352         int count = 0;
353         struct vm_region *vmr;
354         printk("VM Regions for proc %d\n", p->pid);
355         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link)
356                 printk("%02d: (%p - %p): 0x%08x, 0x%08x, %p, %p\n", count++,
357                        vmr->vm_base, vmr->vm_end, vmr->vm_prot, vmr->vm_flags,
358                        vmr->vm_file, vmr->vm_foff);
359 }
360
361 /* Helper: returns the number of pages required to hold nr_bytes */
362 static unsigned long nr_pages(unsigned long nr_bytes)
363 {
364         return (nr_bytes >> PGSHIFT) + (PGOFF(nr_bytes) ? 1 : 0);
365 }
366
367 /* Error values aren't quite comprehensive - check man mmap() once we do better
368  * with the FS.
369  *
370  * The mmap call's offset is in units of PGSIZE (like Linux's mmap2()), but
371  * internally, the offset is tracked in bytes.  The reason for the PGSIZE is for
372  * 32bit apps to enumerate large files, but a full 64bit system won't need that.
373  * We track things internally in bytes since that is how file pointers work, vmr
374  * bases and ends, and similar math.  While it's not a hard change, there's no
375  * need for it, and ideally we'll be a fully 64bit system before we deal with
376  * files that large. */
377 void *mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
378            int fd, size_t offset)
379 {
380         struct file *file = NULL;
381         offset <<= PGSHIFT;
382         printd("mmap(addr %x, len %x, prot %x, flags %x, fd %x, off %x)\n", addr,
383                len, prot, flags, fd, offset);
384         if (fd >= 0 && (flags & MAP_ANON)) {
385                 set_errno(EBADF);
386                 return MAP_FAILED;
387         }
388         if (!len) {
389                 set_errno(EINVAL);
390                 return MAP_FAILED;
391         }
392         if (fd != -1) {
393                 file = get_file_from_fd(&p->open_files, fd);
394                 if (!file) {
395                         set_errno(EBADF);
396                         return MAP_FAILED;
397                 }
398         }
399         /* If they don't care where to put it, we'll start looking after the break.
400          * We could just have userspace handle this (in glibc's mmap), so we don't
401          * need to know about BRK_END, but this will work for now (and may avoid
402          * bugs).  Note that this limits mmap(0) a bit.  Keep this in sync with
403          * __do_mmap()'s check.  (Both are necessary).  */
404         if (addr == 0)
405                 addr = BRK_END;
406         /* Still need to enforce this: */
407         addr = MAX(addr, MMAP_LOWEST_VA);
408         /* Need to check addr + len, after we do our addr adjustments */
409         if ((addr + len > UMAPTOP) || (PGOFF(addr))) {
410                 set_errno(EINVAL);
411                 return MAP_FAILED;
412         }
413         void *result = do_mmap(p, addr, len, prot, flags, file, offset);
414         if (file)
415                 kref_put(&file->f_kref);
416         return result;
417 }
418
419 /* Helper: returns TRUE if the VMR is allowed to access the file with prot.
420  * This is a bit ghetto still: messes with the file mode and assumes it can walk
421  * the dentry/inode paths without locking.  It also ignores the CoW stuff we'll
422  * need to do eventually. */
423 static bool check_file_perms(struct vm_region *vmr, struct file *file, int prot)
424 {
425         assert(file);
426         if (prot & PROT_READ) {
427                 if (check_perms(file->f_dentry->d_inode, S_IRUSR))
428                         goto out_error;
429         }
430         if (prot & PROT_WRITE) {
431                 /* if vmr maps a file as MAP_SHARED, then we need to make sure the
432                  * protection change is in compliance with the open mode of the
433                  * file. */
434                 if (vmr->vm_flags & MAP_SHARED) {
435                         if (!(file->f_mode & S_IWUSR)) {
436                                 /* at this point, we have a file opened in the wrong mode,
437                                  * but we may be allowed to access it still. */
438                                 if (check_perms(file->f_dentry->d_inode, S_IWUSR)) {
439                                         goto out_error;
440                                 } else {
441                                         /* it is okay, though we need to change the file mode. (note
442                                          * the lack of a lock/protection (TODO) */
443                                         file->f_mode |= S_IWUSR;
444                                 }
445                         }
446                 } else {        /* PRIVATE mapping */
447                         /* TODO: we want a CoW mapping (like we want in handle_page_fault()),
448                          * since there is a concern of a process having the page already
449                          * mapped in to a file it does not have permissions to, and then
450                          * mprotecting it so it can access it.  So we can't just change
451                          * the prot, and we don't know yet if a page is mapped in.  To
452                          * handle this, we ought to sort out the CoW bit, and then this
453                          * will be easy.  Til then, just do a permissions check.  If we
454                          * start having weird issues with libc overwriting itself (since
455                          * procs mprotect that W), then change this. */
456                         if (check_perms(file->f_dentry->d_inode, S_IWUSR))
457                                 goto out_error;
458                 }
459         }
460         return TRUE;
461 out_error:      /* for debugging */
462         printk("[kernel] mmap perm check failed for %s for access %d\n",
463                file_name(file), prot);
464         return FALSE;
465 }
466
467 /* Helper, maps in page at addr, but only if nothing is present there.  Returns
468  * 0 on success.  If this is called by non-PM code, we'll store your ref in the
469  * PTE. */
470 static int map_page_at_addr(struct proc *p, struct page *page, uintptr_t addr,
471                             int prot)
472 {
473         pte_t *pte;
474         spin_lock(&p->pte_lock);        /* walking and changing PTEs */
475         /* find offending PTE (prob don't read this in).  This might alloc an
476          * intermediate page table page. */
477         pte = pgdir_walk(p->env_pgdir, (void*)addr, TRUE);
478         if (!pte) {
479                 spin_unlock(&p->pte_lock);
480                 return -ENOMEM;
481         }
482         /* a spurious, valid PF is possible due to a legit race: the page might have
483          * been faulted in by another core already (and raced on the memory lock),
484          * in which case we should just return. */
485         if (PAGE_PRESENT(*pte)) {
486                 spin_unlock(&p->pte_lock);
487                 return 0;
488         }
489         /* preserve the dirty bit - pm removal could be looking concurrently */
490         prot |= (*pte & PTE_D ? PTE_D : 0);
491         /* We have a ref to page, which we are storing in the PTE */
492         *pte = PTE(page2ppn(page), PTE_P | prot);
493         spin_unlock(&p->pte_lock);
494         return 0;
495 }
496
497 /* Helper: copies *pp's contents to a new page, replacing your page pointer.  If
498  * this succeeds, you'll have a non-PM page, which matters for how you put it.*/
499 static int __copy_and_swap_pmpg(struct proc *p, struct page **pp)
500 {
501         struct page *new_page, *old_page = *pp;
502         if (upage_alloc(p, &new_page, FALSE))
503                 return -ENOMEM;
504         memcpy(page2kva(new_page), page2kva(old_page), PGSIZE);
505         pm_put_page(old_page);
506         *pp = new_page;
507         return 0;
508 }
509
510 void *do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
511               struct file *file, size_t offset)
512 {
513         len = ROUNDUP(len, PGSIZE);
514         struct vm_region *vmr, *vmr_temp;
515
516         /* read/write vmr lock (will change the tree) */
517         spin_lock(&p->vmr_lock);
518         /* Sanity check, for callers that bypass mmap().  We want addr for anon
519          * memory to start above the break limit (BRK_END), but not 0.  Keep this in
520          * sync with BRK_END in mmap(). */
521         if (addr == 0)
522                 addr = BRK_END;
523         assert(!PGOFF(offset));
524
525 #ifndef CONFIG_DEMAND_PAGING
526         flags |= MAP_POPULATE;
527 #endif
528         /* Need to make sure nothing is in our way when we want a FIXED location.
529          * We just need to split on the end points (if they exist), and then remove
530          * everything in between.  __do_munmap() will do this.  Careful, this means
531          * an mmap can be an implied munmap() (not my call...). */
532         if (flags & MAP_FIXED)
533                 __do_munmap(p, addr, len);
534         vmr = create_vmr(p, addr, len);
535         if (!vmr) {
536                 printk("[kernel] do_mmap() aborted for %p + %d!\n", addr, len);
537                 set_errno(ENOMEM);
538                 spin_unlock(&p->vmr_lock);
539                 return MAP_FAILED;
540         }
541         addr = vmr->vm_base;
542         vmr->vm_prot = prot;
543         vmr->vm_flags = flags;
544         if (file) {
545                 if (!check_file_perms(vmr, file, prot)) {
546                         assert(!vmr->vm_file);
547                         destroy_vmr(vmr);
548                         set_errno(EACCES);
549                         spin_unlock(&p->vmr_lock);
550                         return MAP_FAILED;
551                 }
552                 /* TODO: consider locking the file while checking (not as manadatory as
553                  * in handle_page_fault() */
554                 if (nr_pages(offset + len) > nr_pages(file->f_dentry->d_inode->i_size)) {
555                         /* We're allowing them to set up the VMR, though if they attempt to
556                          * fault in any pages beyond the file's limit, they'll fail.  Since
557                          * they might not access the region, we need to make sure POPULATE
558                          * is off.  FYI, 64 bit glibc shared libs map in an extra 2MB of
559                          * unaligned space between their RO and RW sections, but then
560                          * immediately mprotect it to PROT_NONE. */
561                         flags &= ~MAP_POPULATE;
562                 }
563                 /* Prep the FS to make sure it can mmap the file.  Slightly weird
564                  * semantics: if we fail and had munmapped the space, they will have a
565                  * hole in their VM now. */
566                 if (file->f_op->mmap(file, vmr)) {
567                         assert(!vmr->vm_file);
568                         destroy_vmr(vmr);
569                         set_errno(EACCES);      /* not quite */
570                         spin_unlock(&p->vmr_lock);
571                         return MAP_FAILED;
572                 }
573                 kref_get(&file->f_kref, 1);
574                 pm_add_vmr(file2pm(file), vmr);
575         }
576         vmr->vm_file = file;
577         vmr->vm_foff = offset;
578         vmr = merge_me(vmr);            /* attempts to merge with neighbors */
579
580         if (flags & MAP_POPULATE && prot != PROT_NONE) {
581                 int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
582                            (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
583                 int num_pages = len / PGSIZE;
584                 int ret = 0;
585                 struct page *a_page;
586                 if (!file) {
587                         for (int i = 0; i < num_pages; i++) {
588                                 if (upage_alloc(p, &a_page, TRUE)) {
589                                         ret = -ENOMEM;
590                                         break;
591                                 }
592                                 a_page->pg_tree_slot = 0;
593                                 /* could imagine doing a memwalk instead of a for loop */
594                                 ret = map_page_at_addr(p, a_page, addr + i * PGSIZE, pte_prot);
595                                 if (ret) {
596                                         page_decref(a_page);
597                                         break;
598                                 }
599                         }
600                 } else {
601                         /* our refcnt on the file keeps the pm alive when we unlock */
602                         struct page_map *pm = file->f_mapping;
603                         unsigned long pm_idx0 = offset >> PGSHIFT;
604                         struct vm_region vmr_copy;
605                         memcpy(&vmr_copy, vmr, sizeof(struct vm_region));
606                         for (int i = 0; i < num_pages; i++) {
607                                 ret = pm_load_page_nowait(pm, pm_idx0 + i, &a_page);
608                                 if (ret) {
609                                         if (ret != -EAGAIN)
610                                                 break;
611                                         spin_unlock(&p->vmr_lock);
612                                         /* might block here, can't hold the spinlock */
613                                         ret = pm_load_page(pm, pm_idx0 + i, &a_page);
614                                         spin_lock(&p->vmr_lock);
615                                         if (ret)
616                                                 break;
617                                         /* ugly - while we were sleeping, our VMR could have changed
618                                          * on us.  should be okay with weird ABA races too. */
619                                         vmr = find_vmr(p, addr + i * PGSIZE);
620                                         if (memcmp(&vmr_copy, vmr, sizeof(struct vm_region))) {
621                                                 pm_put_page(a_page);
622                                                 printk("[kernel] FYI: VMR changed during populate\n");
623                                                 break;
624                                         }
625                                 }
626                                 if (flags & MAP_PRIVATE) {
627                                         ret = __copy_and_swap_pmpg(p, &a_page);
628                                         if (ret) {
629                                                 pm_put_page(a_page);
630                                                 break;
631                                         }
632                                 }
633                                 /* if this is an executable page, we might have to flush the
634                                  * instruction cache if our HW requires it.
635                                  * TODO: is this still needed?  andrew put this in a while ago*/
636                                 if (prot & PROT_EXEC)
637                                         icache_flush_page(0, page2kva(a_page));
638                                 ret = map_page_at_addr(p, a_page, addr + i * PGSIZE, pte_prot);
639                                 if (atomic_read(&a_page->pg_flags) & PG_PAGEMAP)
640                                         pm_put_page(a_page);
641                                 if (ret)
642                                         break;
643                         }
644                 }
645                 if (ret == -ENOMEM) {
646                         spin_unlock(&p->vmr_lock);
647                         printk("[kernel] ENOMEM, killing %d\n", p->pid);
648                         proc_destroy(p);
649                         return MAP_FAILED;      /* will never make it back to userspace */
650                 }
651         }
652         spin_unlock(&p->vmr_lock);
653         return (void*)addr;
654 }
655
656 int mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
657 {
658         printd("mprotect: (addr %p, len %p, prot 0x%x)\n", addr, len, prot);
659         if (!len)
660                 return 0;
661         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
662                 set_errno(EINVAL);
663                 return -1;
664         }
665         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
666         if (end > UMAPTOP || addr > end) {
667                 set_errno(ENOMEM);
668                 return -1;
669         }
670         /* read/write lock, will probably change the tree and settings */
671         spin_lock(&p->vmr_lock);
672         int ret = __do_mprotect(p, addr, len, prot);
673         spin_unlock(&p->vmr_lock);
674         return ret;
675 }
676
677 /* This does not care if the region is not mapped.  POSIX says you should return
678  * ENOMEM if any part of it is unmapped.  Can do this later if we care, based on
679  * the VMRs, not the actual page residency. */
680 int __do_mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
681 {
682         struct vm_region *vmr, *next_vmr;
683         pte_t *pte;
684         bool shootdown_needed = FALSE;
685         int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
686                        (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
687         /* TODO: this is aggressively splitting, when we might not need to if the
688          * prots are the same as the previous.  Plus, there are three excessive
689          * scans.  Finally, we might be able to merge when we are done. */
690         isolate_vmrs(p, addr, len);
691         vmr = find_first_vmr(p, addr);
692         while (vmr && vmr->vm_base < addr + len) {
693                 if (vmr->vm_prot == prot)
694                         continue;
695                 if (vmr->vm_file && !check_file_perms(vmr, vmr->vm_file, prot)) {
696                         set_errno(EACCES);
697                         return -1;
698                 }
699                 vmr->vm_prot = prot;
700                 spin_lock(&p->pte_lock);        /* walking and changing PTEs */
701                 /* TODO: use a memwalk */
702                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) { 
703                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
704                         if (pte && PAGE_PRESENT(*pte)) {
705                                 *pte = (*pte & ~PTE_PERM) | pte_prot;
706                                 shootdown_needed = TRUE;
707                         }
708                 }
709                 spin_unlock(&p->pte_lock);
710                 next_vmr = TAILQ_NEXT(vmr, vm_link);
711                 vmr = next_vmr;
712         }
713         if (shootdown_needed)
714                 proc_tlbshootdown(p, addr, addr + len);
715         return 0;
716 }
717
718 int munmap(struct proc *p, uintptr_t addr, size_t len)
719 {
720         printd("munmap(addr %x, len %x)\n", addr, len);
721         if (!len)
722                 return 0;
723         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
724                 set_errno(EINVAL);
725                 return -1;
726         }
727         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
728         if (end > UMAPTOP || addr > end) {
729                 set_errno(EINVAL);
730                 return -1;
731         }
732         /* read/write: changing the vmrs (trees, properties, and whatnot) */
733         spin_lock(&p->vmr_lock);
734         int ret = __do_munmap(p, addr, len);
735         spin_unlock(&p->vmr_lock);
736         return ret;
737 }
738
739 static int __munmap_mark_not_present(struct proc *p, pte_t *pte, void *va,
740                                      void *arg)
741 {
742         bool *shootdown_needed = (bool*)arg;
743         struct page *page;
744         /* could put in some checks here for !P and also !0 */
745         if (!PAGE_PRESENT(*pte))        /* unmapped (== 0) *ptes are also not PTE_P */
746                 return 0;
747         page = ppn2page(PTE2PPN(*pte));
748         *pte &= ~PTE_P;
749         *shootdown_needed = TRUE;
750         return 0;
751 }
752
753 /* If our page is actually in the PM, we don't do anything.  All a page map
754  * really needs is for our VMR to no longer track it (vmr being in the pm's
755  * list) and to not point at its pages (mark it 0, dude).
756  *
757  * But private mappings mess with that a bit.  Luckily, we can tell by looking
758  * at a page whether the specific page is in the PM or not.  If it isn't, we
759  * still need to free our "VMR local" copy.
760  *
761  * For pages in a PM, we're racing with PM removers.  Both of us sync with the
762  * mm lock, so once we hold the lock, it's a matter of whether or not the PTE is
763  * 0 or not.  If it isn't, then we're still okay to look at the page.  Consider
764  * the PTE a weak ref on the page.  So long as you hold the mm lock, you can
765  * look at the PTE and know the page isn't being freed. */
766 static int __vmr_free_pgs(struct proc *p, pte_t *pte, void *va, void *arg)
767 {
768         struct page *page;
769         if (!*pte)
770                 return 0;
771         page = ppn2page(PTE2PPN(*pte));
772         *pte = 0;
773         if (!(atomic_read(&page->pg_flags) & PG_PAGEMAP))
774                 page_decref(page);
775         return 0;
776 }
777
778 int __do_munmap(struct proc *p, uintptr_t addr, size_t len)
779 {
780         struct vm_region *vmr, *next_vmr, *first_vmr;
781         pte_t *pte;
782         bool shootdown_needed = FALSE;
783
784         /* TODO: this will be a bit slow, since we end up doing three linear
785          * searches (two in isolate, one in find_first). */
786         isolate_vmrs(p, addr, len);
787         first_vmr = find_first_vmr(p, addr);
788         vmr = first_vmr;
789         spin_lock(&p->pte_lock);        /* changing PTEs */
790         while (vmr && vmr->vm_base < addr + len) {
791                 env_user_mem_walk(p, (void*)vmr->vm_base, vmr->vm_end - vmr->vm_base,
792                                   __munmap_mark_not_present, &shootdown_needed);
793                 vmr = TAILQ_NEXT(vmr, vm_link);
794         }
795         spin_unlock(&p->pte_lock);
796         /* we haven't freed the pages yet; still using the PTEs to store the them.
797          * There should be no races with inserts/faults, since we still hold the mm
798          * lock since the previous CB. */
799         if (shootdown_needed)
800                 proc_tlbshootdown(p, addr, addr + len);
801         vmr = first_vmr;
802         while (vmr && vmr->vm_base < addr + len) {
803                 /* there is rarely more than one VMR in this loop.  o/w, we'll need to
804                  * gather up the vmrs and destroy outside the pte_lock. */
805                 spin_lock(&p->pte_lock);        /* changing PTEs */
806                 env_user_mem_walk(p, (void*)vmr->vm_base, vmr->vm_end - vmr->vm_base,
807                                       __vmr_free_pgs, 0);
808                 spin_unlock(&p->pte_lock);
809                 next_vmr = TAILQ_NEXT(vmr, vm_link);
810                 destroy_vmr(vmr);
811                 vmr = next_vmr;
812         }
813         return 0;
814 }
815
816 /* Helper - drop the page differently based on where it is from */
817 static void __put_page(struct page *page)
818 {
819         if (atomic_read(&page->pg_flags) & PG_PAGEMAP)
820                 pm_put_page(page);
821         else
822                 page_decref(page);
823 }
824
825 /* Returns 0 on success, or an appropriate -error code. 
826  *
827  * Notes: if your TLB caches negative results, you'll need to flush the
828  * appropriate tlb entry.  Also, you could have a weird race where a present PTE
829  * faulted for a different reason (was mprotected on another core), and the
830  * shootdown is on its way.  Userspace should have waited for the mprotect to
831  * return before trying to write (or whatever), so we don't care and will fault
832  * them. */
833 int handle_page_fault(struct proc *p, uintptr_t va, int prot)
834 {
835         struct vm_region *vmr;
836         struct page *a_page;
837         unsigned int f_idx;     /* index of the missing page in the file */
838         pte_t *pte;
839         int ret = 0;
840         va = ROUNDDOWN(va,PGSIZE);
841
842         if (prot != PROT_READ && prot != PROT_WRITE && prot != PROT_EXEC)
843                 panic("bad prot!");
844 refault:
845         /* read access to the VMRs TODO: RCU */
846         spin_lock(&p->vmr_lock);
847         /* Check the vmr's protection */
848         vmr = find_vmr(p, va);
849         if (!vmr) {                                                     /* not mapped at all */
850                 ret = -EFAULT;
851                 goto out;
852         }
853         if (!(vmr->vm_prot & prot)) {           /* wrong prots for this vmr */
854                 ret = -EPERM;
855                 goto out;
856         }
857         if (!vmr->vm_file) {
858                 /* No file - just want anonymous memory */
859                 if (upage_alloc(p, &a_page, TRUE)) {
860                         ret = -ENOMEM;
861                         goto out;
862                 }
863         } else {
864                 /* If this fails, either something got screwed up with the VMR, or the
865                  * permissions changed after mmap/mprotect.  Either way, I want to know
866                  * (though it's not critical). */
867                 if (!check_file_perms(vmr, vmr->vm_file, prot))
868                         printk("[kernel] possible issue with VMR prots on file %s!\n",
869                                file_name(vmr->vm_file));
870                 /* Load the file's page in the page cache.
871                  * TODO: (BLK) Note, we are holding the mem lock!  We need to rewrite
872                  * this stuff so we aren't hold the lock as excessively as we are, and
873                  * such that we can block and resume later. */
874                 assert(!PGOFF(va - vmr->vm_base + vmr->vm_foff));
875                 f_idx = (va - vmr->vm_base + vmr->vm_foff) >> PGSHIFT;
876                 /* TODO: need some sort of lock on the file to deal with someone
877                  * concurrently shrinking it.  Adding 1 to f_idx, since it is
878                  * zero-indexed */
879                 if (f_idx + 1 > nr_pages(vmr->vm_file->f_dentry->d_inode->i_size)) {
880                         /* We're asking for pages that don't exist in the file */
881                         /* TODO: unlock the file */
882                         ret = -ESPIPE; /* linux sends a SIGBUS at access time */
883                         goto out;
884                 }
885                 ret = pm_load_page_nowait(vmr->vm_file->f_mapping, f_idx, &a_page);
886                 if (ret) {
887                         if (ret != -EAGAIN)
888                                 goto out;
889                         /* keep the file alive after we unlock */
890                         kref_get(&vmr->vm_file->f_kref, 1);
891                         spin_unlock(&p->vmr_lock);
892
893                         /* TODO: here is where we handle SCP vs MCP vs whatever.
894                          * - do some prep
895                          * - prefetch it for userspace, optionally for MCPs
896                          * - this will break if we actually block, since smp_idle will
897                          *   restart the proc
898                          *   */
899                         ret = pm_load_page(vmr->vm_file->f_mapping, f_idx, &a_page);
900
901                         kref_put(&vmr->vm_file->f_kref);
902                         if (ret)
903                                 return ret;
904                         goto refault;
905                 }
906                 /* If we want a private map, we'll preemptively give you a new page.  We
907                  * used to just care if it was private and writable, but were running
908                  * into issues with libc changing its mapping (map private, then
909                  * mprotect to writable...)  In the future, we want to CoW this anyway,
910                  * so it's not a big deal. */
911                 if ((vmr->vm_flags & MAP_PRIVATE)) {
912                         ret = __copy_and_swap_pmpg(p, &a_page);
913                         if (ret)
914                                 goto out;
915                 }
916                 /* if this is an executable page, we might have to flush the instruction
917                  * cache if our HW requires it. */
918                 if (vmr->vm_prot & PROT_EXEC)
919                         icache_flush_page((void*)va, page2kva(a_page));
920         }
921         /* update the page table TODO: careful with MAP_PRIVATE etc.  might do this
922          * separately (file, no file) */
923         int pte_prot = (vmr->vm_prot & PROT_WRITE) ? PTE_USER_RW :
924                        (vmr->vm_prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
925         ret = map_page_at_addr(p, a_page, va, pte_prot);
926         if (ret)
927                 goto out;
928         /* the VMR's existence in the PM (via the mmap) allows us to have PTE point
929          * to a_page without it magically being reallocated.  For non-PM memory
930          * (anon memory or private pages) we transferred the ref to the PTE. */
931         if (atomic_read(&a_page->pg_flags) & PG_PAGEMAP)
932                 pm_put_page(a_page);
933         ret = 0;
934 out:
935         spin_unlock(&p->vmr_lock);
936         return ret;
937 }
938
939 /* Kernel Dynamic Memory Mappings */
940 uintptr_t dyn_vmap_llim = KERN_DYN_TOP;
941 spinlock_t dyn_vmap_lock = SPINLOCK_INITIALIZER;
942
943 /* Reserve space in the kernel dynamic memory map area */
944 uintptr_t get_vmap_segment(unsigned long num_pages)
945 {
946         uintptr_t retval;
947         spin_lock(&dyn_vmap_lock);
948         retval = dyn_vmap_llim - num_pages * PGSIZE;
949         if ((retval > ULIM) && (retval < KERN_DYN_TOP)) {
950                 dyn_vmap_llim = retval;
951         } else {
952                 warn("[kernel] dynamic mapping failed!");
953                 retval = 0;
954         }
955         spin_unlock(&dyn_vmap_lock);
956         return retval;
957 }
958
959 /* Give up your space.  Note this isn't supported yet */
960 uintptr_t put_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
961 {
962         /* TODO: use vmem regions for adjustable vmap segments */
963         warn("Not implemented, leaking vmem space.\n");
964         return 0;
965 }
966
967 /* Map a virtual address chunk to physical addresses.  Make sure you got a vmap
968  * segment before actually trying to do the mapping.
969  *
970  * Careful with more than one 'page', since it will assume your physical pages
971  * are also contiguous.  Most callers will only use one page.
972  *
973  * Finally, note that this does not care whether or not there are real pages
974  * being mapped, and will not attempt to incref your page (if there is such a
975  * thing).  Handle your own refcnting for pages. */
976 int map_vmap_segment(uintptr_t vaddr, uintptr_t paddr, unsigned long num_pages,
977                      int perm)
978 {
979         /* For now, we only handle the root pgdir, and not any of the other ones
980          * (like for processes).  To do so, we'll need to insert into every pgdir,
981          * and send tlb shootdowns to those that are active (which we don't track
982          * yet). */
983         extern int booting;
984         assert(booting);
985
986         /* TODO: (MM) you should lock on boot pgdir modifications.  A vm region lock
987          * isn't enough, since there might be a race on outer levels of page tables.
988          * For now, we'll just use the dyn_vmap_lock (which technically works). */
989         spin_lock(&dyn_vmap_lock);
990         pte_t *pte;
991 #ifdef CONFIG_X86
992         perm |= PTE_G;
993 #endif
994         for (int i = 0; i < num_pages; i++) {
995                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
996                 if (!pte) {
997                         spin_unlock(&dyn_vmap_lock);
998                         return -ENOMEM;
999                 }
1000                 /* You probably should have unmapped first */
1001                 if (*pte)
1002                         warn("Existing PTE value %p\n", *pte);
1003                 *pte = PTE(pa2ppn(paddr + i * PGSIZE), perm);
1004         }
1005         spin_unlock(&dyn_vmap_lock);
1006         return 0;
1007 }
1008
1009 /* Unmaps / 0's the PTEs of a chunk of vaddr space */
1010 int unmap_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
1011 {
1012         /* Not a big deal - won't need this til we do something with kthreads */
1013         warn("Incomplete, don't call this yet.");
1014         spin_lock(&dyn_vmap_lock);
1015         /* TODO: For all pgdirs */
1016         pte_t *pte;
1017         for (int i = 0; i < num_pages; i++) {
1018                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
1019                 *pte = 0;
1020         }
1021         /* TODO: TLB shootdown.  Also note that the global flag is set on the PTE
1022          * (for x86 for now), which requires a global shootdown.  bigger issue is
1023          * the TLB shootdowns for multiple pgdirs.  We'll need to remove from every
1024          * pgdir, and send tlb shootdowns to those that are active (which we don't
1025          * track yet). */
1026         spin_unlock(&dyn_vmap_lock);
1027         return 0;
1028 }
1029
1030 uintptr_t vmap_pmem(uintptr_t paddr, size_t nr_bytes)
1031 {
1032         uintptr_t vaddr;
1033         unsigned long nr_pages = ROUNDUP(nr_bytes, PGSIZE) >> PGSHIFT;
1034         assert(nr_bytes && paddr);
1035         vaddr = get_vmap_segment(nr_pages);
1036         if (!vaddr) {
1037                 warn("Unable to get a vmap segment");   /* probably a bug */
1038                 return 0;
1039         }
1040         if (map_vmap_segment(vaddr, paddr, nr_pages, PTE_P | PTE_KERN_RW)) {
1041                 warn("Unable to map a vmap segment");   /* probably a bug */
1042                 return 0;
1043         }
1044         return vaddr;
1045 }
1046
1047 int vunmap_vmem(uintptr_t vaddr, size_t nr_bytes)
1048 {
1049         unsigned long nr_pages = ROUNDUP(nr_bytes, PGSIZE) >> PGSHIFT;
1050         unmap_vmap_segment(vaddr, nr_pages);
1051         put_vmap_segment(vaddr, nr_pages);
1052         return 0;
1053 }