VMRs that map page_maps are tracked
[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 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 void *do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
420               struct file *file, size_t offset)
421 {
422         /* read/write vmr lock (will change the tree) */
423         spin_lock(&p->vmr_lock);
424         void *ret = __do_mmap(p, addr, len, prot, flags, file, offset);
425         spin_unlock(&p->vmr_lock);
426         return ret;
427 }
428
429 /* Helper: returns TRUE if the VMR is allowed to access the file with prot.
430  * This is a bit ghetto still: messes with the file mode and assumes it can walk
431  * the dentry/inode paths without locking.  It also ignores the CoW stuff we'll
432  * need to do eventually. */
433 static bool check_file_perms(struct vm_region *vmr, struct file *file, int prot)
434 {
435         assert(file);
436         if (prot & PROT_READ) {
437                 if (check_perms(file->f_dentry->d_inode, S_IRUSR))
438                         goto out_error;
439         }
440         if (prot & PROT_WRITE) {
441                 /* if vmr maps a file as MAP_SHARED, then we need to make sure the
442                  * protection change is in compliance with the open mode of the
443                  * file. */
444                 if (vmr->vm_flags & MAP_SHARED) {
445                         if (!(file->f_mode & S_IWUSR)) {
446                                 /* at this point, we have a file opened in the wrong mode,
447                                  * but we may be allowed to access it still. */
448                                 if (check_perms(file->f_dentry->d_inode, S_IWUSR)) {
449                                         goto out_error;
450                                 } else {
451                                         /* it is okay, though we need to change the file mode. (note
452                                          * the lack of a lock/protection (TODO) */
453                                         file->f_mode |= S_IWUSR;
454                                 }
455                         }
456                 } else {        /* PRIVATE mapping */
457                         /* TODO: we want a CoW mapping (like we want in handle_page_fault()),
458                          * since there is a concern of a process having the page already
459                          * mapped in to a file it does not have permissions to, and then
460                          * mprotecting it so it can access it.  So we can't just change
461                          * the prot, and we don't know yet if a page is mapped in.  To
462                          * handle this, we ought to sort out the CoW bit, and then this
463                          * will be easy.  Til then, just do a permissions check.  If we
464                          * start having weird issues with libc overwriting itself (since
465                          * procs mprotect that W), then change this. */
466                         if (check_perms(file->f_dentry->d_inode, S_IWUSR))
467                                 goto out_error;
468                 }
469         }
470         return TRUE;
471 out_error:      /* for debugging */
472         printk("[kernel] mmap perm check failed for %s for access %d\n",
473                file_name(file), prot);
474         return FALSE;
475 }
476
477 void *__do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
478                 struct file *file, size_t offset)
479 {
480         len = ROUNDUP(len, PGSIZE);
481         int num_pages = len / PGSIZE;
482         int retval;
483
484         struct vm_region *vmr, *vmr_temp;
485
486         /* Sanity check, for callers that bypass mmap().  We want addr for anon
487          * memory to start above the break limit (BRK_END), but not 0.  Keep this in
488          * sync with BRK_END in mmap(). */
489         if (addr == 0)
490                 addr = BRK_END;
491         assert(!PGOFF(offset));
492
493 #ifndef CONFIG_DEMAND_PAGING
494         flags |= MAP_POPULATE;
495 #endif
496         /* Need to make sure nothing is in our way when we want a FIXED location.
497          * We just need to split on the end points (if they exist), and then remove
498          * everything in between.  __do_munmap() will do this.  Careful, this means
499          * an mmap can be an implied munmap() (not my call...). */
500         if (flags & MAP_FIXED)
501                 __do_munmap(p, addr, len);
502         vmr = create_vmr(p, addr, len);
503         if (!vmr) {
504                 printk("[kernel] do_mmap() aborted for %p + %d!\n", addr, len);
505                 set_errno(ENOMEM);
506                 return MAP_FAILED;              /* TODO: error propagation for mmap() */
507         }
508         vmr->vm_prot = prot;
509         vmr->vm_flags = flags;
510         if (file) {
511                 if (!check_file_perms(vmr, file, prot)) {
512                         assert(!vmr->vm_file);
513                         destroy_vmr(vmr);
514                         set_errno(EACCES);
515                         return MAP_FAILED;
516                 }
517                 /* TODO: consider locking the file while checking (not as manadatory as
518                  * in handle_page_fault() */
519                 if (nr_pages(offset + len) > nr_pages(file->f_dentry->d_inode->i_size)) {
520                         /* We're allowing them to set up the VMR, though if they attempt to
521                          * fault in any pages beyond the file's limit, they'll fail.  Since
522                          * they might not access the region, we need to make sure POPULATE
523                          * is off.  FYI, 64 bit glibc shared libs map in an extra 2MB of
524                          * unaligned space between their RO and RW sections, but then
525                          * immediately mprotect it to PROT_NONE. */
526                         flags &= ~MAP_POPULATE;
527                 }
528                 /* Prep the FS to make sure it can mmap the file.  Slightly weird
529                  * semantics: if we fail and had munmapped the space, they will have a
530                  * hole in their VM now. */
531                 if (file->f_op->mmap(file, vmr)) {
532                         assert(!vmr->vm_file);
533                         destroy_vmr(vmr);
534                         set_errno(EACCES);      /* not quite */
535                         return MAP_FAILED;
536                 }
537                 kref_get(&file->f_kref, 1);
538                 pm_add_vmr(file2pm(file), vmr);
539         }
540         vmr->vm_file = file;
541         vmr->vm_foff = offset;
542         addr = vmr->vm_base;            /* so we know which pages to populate later */
543         vmr = merge_me(vmr);            /* attempts to merge with neighbors */
544         /* Fault in pages now if MAP_POPULATE.  We want to populate the region
545          * requested, but we need to be careful and only populate the requested
546          * length and not any merged regions, which is why we set addr above and use
547          * it here.
548          *
549          * If HPF errors out, we'll warn and fail for now.  This could be due to
550          * some userspace error, but also occurs when we run out of memory.  If we
551          * are out of memory, the kernel can't really handle it. */
552         if (flags & MAP_POPULATE && vmr->vm_prot != PROT_NONE)
553                 for (int i = 0; i < num_pages; i++) {
554                         retval = __handle_page_fault(p, addr + i * PGSIZE, vmr->vm_prot);
555                         if (retval) {
556                                 warn("do_mmap() failing (%d) on addr %p with prot 0x%x",
557                                      retval, addr + i * PGSIZE,  vmr->vm_prot);
558                                 destroy_vmr(vmr);
559                                 set_errno(-retval);
560                                 if (retval == -ENOMEM) {
561                                         printk("[kernel] ENOMEM, killing %d\n", p->pid);
562                                         proc_destroy(p);
563                                 }
564                                 return MAP_FAILED;
565                         }
566                 }
567         return (void*SAFE)TC(addr);
568 }
569
570 int mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
571 {
572         printd("mprotect: (addr %p, len %p, prot 0x%x)\n", addr, len, prot);
573         if (!len)
574                 return 0;
575         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
576                 set_errno(EINVAL);
577                 return -1;
578         }
579         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
580         if (end > UMAPTOP || addr > end) {
581                 set_errno(ENOMEM);
582                 return -1;
583         }
584         /* read/write lock, will probably change the tree and settings */
585         spin_lock(&p->vmr_lock);
586         int ret = __do_mprotect(p, addr, len, prot);
587         spin_unlock(&p->vmr_lock);
588         return ret;
589 }
590
591 /* This does not care if the region is not mapped.  POSIX says you should return
592  * ENOMEM if any part of it is unmapped.  Can do this later if we care, based on
593  * the VMRs, not the actual page residency. */
594 int __do_mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
595 {
596         struct vm_region *vmr, *next_vmr;
597         pte_t *pte;
598         bool shootdown_needed = FALSE;
599         int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
600                        (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
601         /* TODO: this is aggressively splitting, when we might not need to if the
602          * prots are the same as the previous.  Plus, there are three excessive
603          * scans.  Finally, we might be able to merge when we are done. */
604         isolate_vmrs(p, addr, len);
605         vmr = find_first_vmr(p, addr);
606         while (vmr && vmr->vm_base < addr + len) {
607                 if (vmr->vm_prot == prot)
608                         continue;
609                 if (vmr->vm_file && !check_file_perms(vmr, vmr->vm_file, prot)) {
610                         set_errno(EACCES);
611                         return -1;
612                 }
613                 vmr->vm_prot = prot;
614                 spin_lock(&p->pte_lock);        /* walking and changing PTEs */
615                 /* TODO: use a memwalk */
616                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) { 
617                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
618                         if (pte && PAGE_PRESENT(*pte)) {
619                                 *pte = (*pte & ~PTE_PERM) | pte_prot;
620                                 shootdown_needed = TRUE;
621                         }
622                 }
623                 spin_unlock(&p->pte_lock);
624                 next_vmr = TAILQ_NEXT(vmr, vm_link);
625                 vmr = next_vmr;
626         }
627         if (shootdown_needed)
628                 proc_tlbshootdown(p, addr, addr + len);
629         return 0;
630 }
631
632 int munmap(struct proc *p, uintptr_t addr, size_t len)
633 {
634         printd("munmap(addr %x, len %x)\n", addr, len);
635         if (!len)
636                 return 0;
637         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
638                 set_errno(EINVAL);
639                 return -1;
640         }
641         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
642         if (end > UMAPTOP || addr > end) {
643                 set_errno(EINVAL);
644                 return -1;
645         }
646         /* read/write: changing the vmrs (trees, properties, and whatnot) */
647         spin_lock(&p->vmr_lock);
648         int ret = __do_munmap(p, addr, len);
649         spin_unlock(&p->vmr_lock);
650         return ret;
651 }
652
653 static int __munmap_mark_not_present(struct proc *p, pte_t *pte, void *va,
654                                      void *arg)
655 {
656         bool *shootdown_needed = (bool*)arg;
657         struct page *page;
658         /* could put in some checks here for !P and also !0 */
659         if (!PAGE_PRESENT(*pte))        /* unmapped (== 0) *ptes are also not PTE_P */
660                 return 0;
661         page = ppn2page(PTE2PPN(*pte));
662         *pte &= ~PTE_P;
663         *shootdown_needed = TRUE;
664         return 0;
665 }
666
667 /* If our page is actually in the PM, we don't do anything.  All a page map
668  * really needs is for our VMR to no longer track it (vmr being in the pm's
669  * list) and to not point at its pages (mark it 0, dude).
670  *
671  * But private mappings mess with that a bit.  Luckily, we can tell by looking
672  * at a page whether the specific page is in the PM or not.  If it isn't, we
673  * still need to free our "VMR local" copy.
674  *
675  * For pages in a PM, we're racing with PM removers.  Both of us sync with the
676  * mm lock, so once we hold the lock, it's a matter of whether or not the PTE is
677  * 0 or not.  If it isn't, then we're still okay to look at the page.  Consider
678  * the PTE a weak ref on the page.  So long as you hold the mm lock, you can
679  * look at the PTE and know the page isn't being freed. */
680 static int __vmr_free_pgs(struct proc *p, pte_t *pte, void *va, void *arg)
681 {
682         struct page *page;
683         if (!*pte)
684                 return 0;
685         page = ppn2page(PTE2PPN(*pte));
686         *pte = 0;
687         if (!(atomic_read(&page->pg_flags) & PG_PAGEMAP))
688                 page_decref(page);
689         return 0;
690 }
691
692 int __do_munmap(struct proc *p, uintptr_t addr, size_t len)
693 {
694         struct vm_region *vmr, *next_vmr, *first_vmr;
695         pte_t *pte;
696         bool shootdown_needed = FALSE;
697
698         /* TODO: this will be a bit slow, since we end up doing three linear
699          * searches (two in isolate, one in find_first). */
700         isolate_vmrs(p, addr, len);
701         first_vmr = find_first_vmr(p, addr);
702         vmr = first_vmr;
703         spin_lock(&p->pte_lock);        /* changing PTEs */
704         while (vmr && vmr->vm_base < addr + len) {
705                 env_user_mem_walk(p, (void*)vmr->vm_base, vmr->vm_end - vmr->vm_base,
706                                   __munmap_mark_not_present, &shootdown_needed);
707                 vmr = TAILQ_NEXT(vmr, vm_link);
708         }
709         spin_unlock(&p->pte_lock);
710         /* we haven't freed the pages yet; still using the PTEs to store the them.
711          * There should be no races with inserts/faults, since we still hold the mm
712          * lock since the previous CB. */
713         if (shootdown_needed)
714                 proc_tlbshootdown(p, addr, addr + len);
715         vmr = first_vmr;
716         while (vmr && vmr->vm_base < addr + len) {
717                 /* there is rarely more than one VMR in this loop.  o/w, we'll need to
718                  * gather up the vmrs and destroy outside the pte_lock. */
719                 spin_lock(&p->pte_lock);        /* changing PTEs */
720                 env_user_mem_walk(p, (void*)vmr->vm_base, vmr->vm_end - vmr->vm_base,
721                                       __vmr_free_pgs, 0);
722                 spin_unlock(&p->pte_lock);
723                 next_vmr = TAILQ_NEXT(vmr, vm_link);
724                 destroy_vmr(vmr);
725                 vmr = next_vmr;
726         }
727         return 0;
728 }
729
730 int handle_page_fault(struct proc* p, uintptr_t va, int prot)
731 {
732         va = ROUNDDOWN(va,PGSIZE);
733
734         if (prot != PROT_READ && prot != PROT_WRITE && prot != PROT_EXEC)
735                 panic("bad prot!");
736         /* read access to the VMRs TODO: RCU */
737         spin_lock(&p->vmr_lock);
738         int ret = __handle_page_fault(p, va, prot);
739         spin_unlock(&p->vmr_lock);
740         return ret;
741 }
742
743 /* Returns 0 on success, or an appropriate -error code.  Assumes you hold the
744  * vmr_lock.
745  *
746  * Notes: if your TLB caches negative results, you'll need to flush the
747  * appropriate tlb entry.  Also, you could have a weird race where a present PTE
748  * faulted for a different reason (was mprotected on another core), and the
749  * shootdown is on its way.  Userspace should have waited for the mprotect to
750  * return before trying to write (or whatever), so we don't care and will fault
751  * them. */
752 int __handle_page_fault(struct proc *p, uintptr_t va, int prot)
753 {
754         struct vm_region *vmr;
755         struct page *a_page;
756         unsigned int f_idx;     /* index of the missing page in the file */
757         int retval;
758         pte_t *pte;
759
760         /* Check the vmr's protection */
761         vmr = find_vmr(p, va);
762         if (!vmr)                                                       /* not mapped at all */
763                 return -EFAULT;
764         if (!(vmr->vm_prot & prot))                     /* wrong prots for this vmr */
765                 return -EPERM;
766         if (!vmr->vm_file) {
767                 /* No file - just want anonymous memory */
768                 if (upage_alloc(p, &a_page, TRUE))
769                         return -ENOMEM;
770         } else {
771                 /* If this fails, either something got screwed up with the VMR, or the
772                  * permissions changed after mmap/mprotect.  Either way, I want to know
773                  * (though it's not critical). */
774                 if (!check_file_perms(vmr, vmr->vm_file, prot))
775                         printk("[kernel] possible issue with VMR prots on file %s!\n",
776                                file_name(vmr->vm_file));
777                 /* Load the file's page in the page cache.
778                  * TODO: (BLK) Note, we are holding the mem lock!  We need to rewrite
779                  * this stuff so we aren't hold the lock as excessively as we are, and
780                  * such that we can block and resume later. */
781                 assert(!PGOFF(va - vmr->vm_base + vmr->vm_foff));
782                 f_idx = (va - vmr->vm_base + vmr->vm_foff) >> PGSHIFT;
783                 /* TODO: need some sort of lock on the file to deal with someone
784                  * concurrently shrinking it.  Adding 1 to f_idx, since it is
785                  * zero-indexed */
786                 if (f_idx + 1 > nr_pages(vmr->vm_file->f_dentry->d_inode->i_size)) {
787                         /* We're asking for pages that don't exist in the file */
788                         /* TODO: unlock the file */
789                         return -ESPIPE; /* linux sends a SIGBUS at access time */
790                 }
791                 retval = pm_load_page(vmr->vm_file->f_mapping, f_idx, &a_page);
792                 /* TODO: should be able to let go of that file shrink-lock now.  We have
793                  * a page refcnt, which might be enough (depending on how it works) */
794                 if (retval)
795                         return retval;
796                 /* If we want a private map, we'll preemptively give you a new page.  We
797                  * used to just care if it was private and writable, but were running
798                  * into issues with libc changing its mapping (map private, then
799                  * mprotect to writable...)  In the future, we want to CoW this anyway,
800                  * so it's not a big deal. */
801                 if ((vmr->vm_flags & MAP_PRIVATE)) {
802                         struct page *cache_page = a_page;
803                         if (upage_alloc(p, &a_page, FALSE)) {
804                                 page_decref(cache_page);        /* was the original a_page */
805                                 return -ENOMEM;
806                         }
807                         memcpy(page2kva(a_page), page2kva(cache_page), PGSIZE);
808                         page_decref(cache_page);                /* was the original a_page */
809                         /* Debugging */
810                         if (!(vmr->vm_prot & PROT_WRITE))
811                                 printd("[kernel] private, but unwritable file mapping of %s "
812                                        "at va %p\n", file_name(vmr->vm_file), va);
813                 }
814                 /* if this is an executable page, we might have to flush the instruction
815                  * cache if our HW requires it. */
816                 if (vmr->vm_prot & PROT_EXEC)
817                         icache_flush_page((void*)va, page2kva(a_page));
818         }
819         /* update the page table TODO: careful with MAP_PRIVATE etc.  might do this
820          * separately (file, no file) */
821         int pte_prot = (vmr->vm_prot & PROT_WRITE) ? PTE_USER_RW :
822                        (vmr->vm_prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
823         spin_lock(&p->pte_lock);        /* walking and changing PTEs */
824         /* find offending PTE (prob don't read this in).  This might alloc an
825          * intermediate page table page. */
826         pte = pgdir_walk(p->env_pgdir, (void*)va, 1);
827         if (!pte) {
828                 spin_unlock(&p->pte_lock);
829                 pm_put_page(a_page);
830                 return -ENOMEM;
831         }
832         /* a spurious, valid PF is possible due to a legit race: the page might have
833          * been faulted in by another core already (and raced on the memory lock),
834          * in which case we should just return. */
835         if (PAGE_PRESENT(*pte)) {
836                 spin_unlock(&p->pte_lock);
837                 pm_put_page(a_page);
838                 return 0;
839         } else if (PAGE_PAGED_OUT(*pte)) {
840                 /* TODO: (SWAP) bring in the paged out frame. (BLK) */
841                 panic("Swapping not supported!");
842                 spin_unlock(&p->pte_lock);
843                 pm_put_page(a_page);
844                 return -1;
845         }
846         /* We have a ref to a_page, which we are storing in the PTE */
847         *pte = PTE(page2ppn(a_page), PTE_P | pte_prot);
848         spin_unlock(&p->pte_lock);
849         return 0;
850 }
851
852 /* Kernel Dynamic Memory Mappings */
853 uintptr_t dyn_vmap_llim = KERN_DYN_TOP;
854 spinlock_t dyn_vmap_lock = SPINLOCK_INITIALIZER;
855
856 /* Reserve space in the kernel dynamic memory map area */
857 uintptr_t get_vmap_segment(unsigned long num_pages)
858 {
859         uintptr_t retval;
860         spin_lock(&dyn_vmap_lock);
861         retval = dyn_vmap_llim - num_pages * PGSIZE;
862         if ((retval > ULIM) && (retval < KERN_DYN_TOP)) {
863                 dyn_vmap_llim = retval;
864         } else {
865                 warn("[kernel] dynamic mapping failed!");
866                 retval = 0;
867         }
868         spin_unlock(&dyn_vmap_lock);
869         return retval;
870 }
871
872 /* Give up your space.  Note this isn't supported yet */
873 uintptr_t put_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
874 {
875         /* TODO: use vmem regions for adjustable vmap segments */
876         warn("Not implemented, leaking vmem space.\n");
877         return 0;
878 }
879
880 /* Map a virtual address chunk to physical addresses.  Make sure you got a vmap
881  * segment before actually trying to do the mapping.
882  *
883  * Careful with more than one 'page', since it will assume your physical pages
884  * are also contiguous.  Most callers will only use one page.
885  *
886  * Finally, note that this does not care whether or not there are real pages
887  * being mapped, and will not attempt to incref your page (if there is such a
888  * thing).  Handle your own refcnting for pages. */
889 int map_vmap_segment(uintptr_t vaddr, uintptr_t paddr, unsigned long num_pages,
890                      int perm)
891 {
892         /* For now, we only handle the root pgdir, and not any of the other ones
893          * (like for processes).  To do so, we'll need to insert into every pgdir,
894          * and send tlb shootdowns to those that are active (which we don't track
895          * yet). */
896         extern int booting;
897         assert(booting);
898
899         /* TODO: (MM) you should lock on boot pgdir modifications.  A vm region lock
900          * isn't enough, since there might be a race on outer levels of page tables.
901          * For now, we'll just use the dyn_vmap_lock (which technically works). */
902         spin_lock(&dyn_vmap_lock);
903         pte_t *pte;
904 #ifdef CONFIG_X86
905         perm |= PTE_G;
906 #endif
907         for (int i = 0; i < num_pages; i++) {
908                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
909                 if (!pte) {
910                         spin_unlock(&dyn_vmap_lock);
911                         return -ENOMEM;
912                 }
913                 /* You probably should have unmapped first */
914                 if (*pte)
915                         warn("Existing PTE value %p\n", *pte);
916                 *pte = PTE(pa2ppn(paddr + i * PGSIZE), perm);
917         }
918         spin_unlock(&dyn_vmap_lock);
919         return 0;
920 }
921
922 /* Unmaps / 0's the PTEs of a chunk of vaddr space */
923 int unmap_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
924 {
925         /* Not a big deal - won't need this til we do something with kthreads */
926         warn("Incomplete, don't call this yet.");
927         spin_lock(&dyn_vmap_lock);
928         /* TODO: For all pgdirs */
929         pte_t *pte;
930         for (int i = 0; i < num_pages; i++) {
931                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
932                 *pte = 0;
933         }
934         /* TODO: TLB shootdown.  Also note that the global flag is set on the PTE
935          * (for x86 for now), which requires a global shootdown.  bigger issue is
936          * the TLB shootdowns for multiple pgdirs.  We'll need to remove from every
937          * pgdir, and send tlb shootdowns to those that are active (which we don't
938          * track yet). */
939         spin_unlock(&dyn_vmap_lock);
940         return 0;
941 }
942
943 uintptr_t vmap_pmem(uintptr_t paddr, size_t nr_bytes)
944 {
945         uintptr_t vaddr;
946         unsigned long nr_pages = ROUNDUP(nr_bytes, PGSIZE) >> PGSHIFT;
947         assert(nr_bytes && paddr);
948         vaddr = get_vmap_segment(nr_pages);
949         if (!vaddr) {
950                 warn("Unable to get a vmap segment");   /* probably a bug */
951                 return 0;
952         }
953         if (map_vmap_segment(vaddr, paddr, nr_pages, PTE_P | PTE_KERN_RW)) {
954                 warn("Unable to map a vmap segment");   /* probably a bug */
955                 return 0;
956         }
957         return vaddr;
958 }
959
960 int vunmap_vmem(uintptr_t vaddr, size_t nr_bytes)
961 {
962         unsigned long nr_pages = ROUNDUP(nr_bytes, PGSIZE) >> PGSHIFT;
963         unmap_vmap_segment(vaddr, nr_pages);
964         put_vmap_segment(vaddr, nr_pages);
965         return 0;
966 }