bf1840f77e21937eb4a447a1f2fc05a3e96eebad
[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 #include <profiler.h>
28 #include <umem.h>
29
30 struct kmem_cache *vmr_kcache;
31
32 static int __vmr_free_pgs(struct proc *p, pte_t pte, void *va, void *arg);
33 static int populate_pm_va(struct proc *p, uintptr_t va, unsigned long nr_pgs,
34                           int pte_prot, struct page_map *pm, size_t offset,
35                           int flags, bool exec);
36
37 /* minor helper, will ease the file->chan transition */
38 static struct page_map *file2pm(struct file *file)
39 {
40         return file->f_mapping;
41 }
42
43 void vmr_init(void)
44 {
45         vmr_kcache = kmem_cache_create("vm_regions", sizeof(struct vm_region),
46                                        __alignof__(struct dentry), 0, 0, 0);
47 }
48
49 /* For now, the caller will set the prot, flags, file, and offset.  In the
50  * future, we may put those in here, to do clever things with merging vm_regions
51  * that are the same.
52  *
53  * TODO: take a look at solari's vmem alloc.  And consider keeping these in a
54  * tree of some sort for easier lookups. */
55 struct vm_region *create_vmr(struct proc *p, uintptr_t va, size_t len)
56 {
57         struct vm_region *vmr = 0, *vm_i, *vm_next;
58         uintptr_t gap_end;
59
60         assert(!PGOFF(va));
61         assert(!PGOFF(len));
62         assert(__is_user_addr((void*)va, len, UMAPTOP));
63         /* Is there room before the first one: */
64         vm_i = TAILQ_FIRST(&p->vm_regions);
65         /* This works for now, but if all we have is BRK_END ones, we'll start
66          * growing backwards (TODO) */
67         if (!vm_i || (va + len <= vm_i->vm_base)) {
68                 vmr = kmem_cache_alloc(vmr_kcache, 0);
69                 if (!vmr)
70                         panic("EOM!");
71                 memset(vmr, 0, sizeof(struct vm_region));
72                 vmr->vm_base = va;
73                 TAILQ_INSERT_HEAD(&p->vm_regions, vmr, vm_link);
74         } else {
75                 TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
76                         vm_next = TAILQ_NEXT(vm_i, vm_link);
77                         gap_end = vm_next ? vm_next->vm_base : UMAPTOP;
78                         /* skip til we get past the 'hint' va */
79                         if (va >= gap_end)
80                                 continue;
81                         /* Find a gap that is big enough */
82                         if (gap_end - vm_i->vm_end >= len) {
83                                 vmr = kmem_cache_alloc(vmr_kcache, 0);
84                                 if (!vmr)
85                                         panic("EOM!");
86                                 memset(vmr, 0, sizeof(struct vm_region));
87                                 /* if we can put it at va, let's do that.  o/w, put it so it
88                                  * fits */
89                                 if ((gap_end >= va + len) && (va >= vm_i->vm_end))
90                                         vmr->vm_base = va;
91                                 else
92                                         vmr->vm_base = vm_i->vm_end;
93                                 TAILQ_INSERT_AFTER(&p->vm_regions, vm_i, vmr, vm_link);
94                                 break;
95                         }
96                 }
97         }
98         /* Finalize the creation, if we got one */
99         if (vmr) {
100                 vmr->vm_proc = p;
101                 vmr->vm_end = vmr->vm_base + len;
102         }
103         if (!vmr)
104                 warn("Not making a VMR, wanted %p, + %p = %p", va, len, va + len);
105         return vmr;
106 }
107
108 /* Split a VMR at va, returning the new VMR.  It is set up the same way, with
109  * file offsets fixed accordingly.  'va' is the beginning of the new one, and
110  * must be page aligned. */
111 struct vm_region *split_vmr(struct vm_region *old_vmr, uintptr_t va)
112 {
113         struct vm_region *new_vmr;
114
115         assert(!PGOFF(va));
116         if ((old_vmr->vm_base >= va) || (old_vmr->vm_end <= va))
117                 return 0;
118         new_vmr = kmem_cache_alloc(vmr_kcache, 0);
119         TAILQ_INSERT_AFTER(&old_vmr->vm_proc->vm_regions, old_vmr, new_vmr,
120                            vm_link);
121         new_vmr->vm_proc = old_vmr->vm_proc;
122         new_vmr->vm_base = va;
123         new_vmr->vm_end = old_vmr->vm_end;
124         old_vmr->vm_end = va;
125         new_vmr->vm_prot = old_vmr->vm_prot;
126         new_vmr->vm_flags = old_vmr->vm_flags;
127         if (old_vmr->vm_file) {
128                 kref_get(&old_vmr->vm_file->f_kref, 1);
129                 new_vmr->vm_file = old_vmr->vm_file;
130                 new_vmr->vm_foff = old_vmr->vm_foff +
131                                       old_vmr->vm_end - old_vmr->vm_base;
132                 pm_add_vmr(file2pm(old_vmr->vm_file), new_vmr);
133         } else {
134                 new_vmr->vm_file = 0;
135                 new_vmr->vm_foff = 0;
136         }
137         return new_vmr;
138 }
139
140 /* Merges two vm regions.  For now, it will check to make sure they are the
141  * same.  The second one will be destroyed. */
142 int merge_vmr(struct vm_region *first, struct vm_region *second)
143 {
144         assert(first->vm_proc == second->vm_proc);
145         if ((first->vm_end != second->vm_base) ||
146             (first->vm_prot != second->vm_prot) ||
147             (first->vm_flags != second->vm_flags) ||
148             (first->vm_file != second->vm_file))
149                 return -1;
150         if ((first->vm_file) && (second->vm_foff != first->vm_foff +
151                                  first->vm_end - first->vm_base))
152                 return -1;
153         first->vm_end = second->vm_end;
154         destroy_vmr(second);
155         return 0;
156 }
157
158 /* Attempts to merge vmr with adjacent VMRs, returning a ptr to be used for vmr.
159  * It could be the same struct vmr, or possibly another one (usually lower in
160  * the address space. */
161 struct vm_region *merge_me(struct vm_region *vmr)
162 {
163         struct vm_region *vmr_temp;
164         /* Merge will fail if it cannot do it.  If it succeeds, the second VMR is
165          * destroyed, so we need to be a bit careful. */
166         vmr_temp = TAILQ_PREV(vmr, vmr_tailq, vm_link);
167         if (vmr_temp)
168                 if (!merge_vmr(vmr_temp, vmr))
169                         vmr = vmr_temp;
170         vmr_temp = TAILQ_NEXT(vmr, vm_link);
171         if (vmr_temp)
172                 merge_vmr(vmr, vmr_temp);
173         return vmr;
174 }
175
176 /* Grows the vm region up to (and not including) va.  Fails if another is in the
177  * way, etc. */
178 int grow_vmr(struct vm_region *vmr, uintptr_t va)
179 {
180         assert(!PGOFF(va));
181         struct vm_region *next = TAILQ_NEXT(vmr, vm_link);
182         if (next && next->vm_base < va)
183                 return -1;
184         if (va <= vmr->vm_end)
185                 return -1;
186         vmr->vm_end = va;
187         return 0;
188 }
189
190 /* Shrinks the vm region down to (and not including) va.  Whoever calls this
191  * will need to sort out the page table entries. */
192 int shrink_vmr(struct vm_region *vmr, uintptr_t va)
193 {
194         assert(!PGOFF(va));
195         if ((va < vmr->vm_base) || (va > vmr->vm_end))
196                 return -1;
197         vmr->vm_end = va;
198         return 0;
199 }
200
201 /* Called by the unmapper, just cleans up.  Whoever calls this will need to sort
202  * out the page table entries. */
203 void destroy_vmr(struct vm_region *vmr)
204 {
205         if (vmr->vm_file) {
206                 pm_remove_vmr(file2pm(vmr->vm_file), vmr);
207                 kref_put(&vmr->vm_file->f_kref);
208         }
209         TAILQ_REMOVE(&vmr->vm_proc->vm_regions, vmr, vm_link);
210         kmem_cache_free(vmr_kcache, vmr);
211 }
212
213 /* Given a va and a proc (later an mm, possibly), returns the owning vmr, or 0
214  * if there is none. */
215 struct vm_region *find_vmr(struct proc *p, uintptr_t va)
216 {
217         struct vm_region *vmr;
218         /* ugly linear seach */
219         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
220                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
221                         return vmr;
222         }
223         return 0;
224 }
225
226 /* Finds the first vmr after va (including the one holding va), or 0 if there is
227  * none. */
228 struct vm_region *find_first_vmr(struct proc *p, uintptr_t va)
229 {
230         struct vm_region *vmr;
231         /* ugly linear seach */
232         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
233                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
234                         return vmr;
235                 if (vmr->vm_base > va)
236                         return vmr;
237         }
238         return 0;
239 }
240
241 /* Makes sure that no VMRs cross either the start or end of the given region
242  * [va, va + len), splitting any VMRs that are on the endpoints. */
243 void isolate_vmrs(struct proc *p, uintptr_t va, size_t len)
244 {
245         struct vm_region *vmr;
246         if ((vmr = find_vmr(p, va)))
247                 split_vmr(vmr, va);
248         /* TODO: don't want to do another find (linear search) */
249         if ((vmr = find_vmr(p, va + len)))
250                 split_vmr(vmr, va + len);
251 }
252
253 void unmap_and_destroy_vmrs(struct proc *p)
254 {
255         struct vm_region *vmr_i, *vmr_temp;
256         /* this only gets called from __proc_free, so there should be no sync
257          * concerns.  still, better safe than sorry. */
258         spin_lock(&p->vmr_lock);
259         p->vmr_history++;
260         spin_lock(&p->pte_lock);
261         TAILQ_FOREACH(vmr_i, &p->vm_regions, vm_link) {
262                 /* note this CB sets the PTE = 0, regardless of if it was P or not */
263                 env_user_mem_walk(p, (void*)vmr_i->vm_base,
264                                   vmr_i->vm_end - vmr_i->vm_base, __vmr_free_pgs, 0);
265         }
266         spin_unlock(&p->pte_lock);
267         /* need the safe style, since destroy_vmr modifies the list.  also, we want
268          * to do this outside the pte lock, since it grabs the pm lock. */
269         TAILQ_FOREACH_SAFE(vmr_i, &p->vm_regions, vm_link, vmr_temp)
270                 destroy_vmr(vmr_i);
271         spin_unlock(&p->vmr_lock);
272 }
273
274 /* Helper: copies the contents of pages from p to new p.  For pages that aren't
275  * present, once we support swapping or CoW, we can do something more
276  * intelligent.  0 on success, -ERROR on failure.  Can't handle jumbos. */
277 static int copy_pages(struct proc *p, struct proc *new_p, uintptr_t va_start,
278                       uintptr_t va_end)
279 {
280         /* Sanity checks.  If these fail, we had a screwed up VMR.
281          * Check for: alignment, wraparound, or userspace addresses */
282         if ((PGOFF(va_start)) ||
283             (PGOFF(va_end)) ||
284             (va_end < va_start) ||      /* now, start > UMAPTOP -> end > UMAPTOP */
285             (va_end > UMAPTOP)) {
286                 warn("VMR mapping is probably screwed up (%p - %p)", va_start,
287                      va_end);
288                 return -EINVAL;
289         }
290         int copy_page(struct proc *p, pte_t pte, void *va, void *arg) {
291                 struct proc *new_p = (struct proc*)arg;
292                 struct page *pp;
293                 if (pte_is_unmapped(pte))
294                         return 0;
295                 /* pages could be !P, but right now that's only for file backed VMRs
296                  * undergoing page removal, which isn't the caller of copy_pages. */
297                 if (pte_is_mapped(pte)) {
298                         /* TODO: check for jumbos */
299                         if (upage_alloc(new_p, &pp, 0))
300                                 return -ENOMEM;
301                         memcpy(page2kva(pp), KADDR(pte_get_paddr(pte)), PGSIZE);
302                         if (page_insert(new_p->env_pgdir, pp, va, pte_get_settings(pte))) {
303                                 page_decref(pp);
304                                 return -ENOMEM;
305                         }
306                 } else if (pte_is_paged_out(pte)) {
307                         /* TODO: (SWAP) will need to either make a copy or CoW/refcnt the
308                          * backend store.  For now, this PTE will be the same as the
309                          * original PTE */
310                         panic("Swapping not supported!");
311                 } else {
312                         panic("Weird PTE %p in %s!", pte_print(pte), __FUNCTION__);
313                 }
314                 return 0;
315         }
316         return env_user_mem_walk(p, (void*)va_start, va_end - va_start, &copy_page,
317                                  new_p);
318 }
319
320 static int fill_vmr(struct proc *p, struct proc *new_p, struct vm_region *vmr)
321 {
322         int ret = 0;
323
324         if ((!vmr->vm_file) || (vmr->vm_flags & MAP_PRIVATE)) {
325                 assert(!(vmr->vm_flags & MAP_SHARED));
326                 ret = copy_pages(p, new_p, vmr->vm_base, vmr->vm_end);
327         } else {
328                 /* non-private file, i.e. page cacheable.  we have to honor MAP_LOCKED,
329                  * (but we might be able to ignore MAP_POPULATE). */
330                 if (vmr->vm_flags & MAP_LOCKED) {
331                         /* need to keep the file alive in case we unlock/block */
332                         kref_get(&vmr->vm_file->f_kref, 1);
333                         /* math is a bit nasty if vm_base isn't page aligned */
334                         assert(!PGOFF(vmr->vm_base));
335                         ret = populate_pm_va(new_p, vmr->vm_base,
336                                              (vmr->vm_end - vmr->vm_base) >> PGSHIFT,
337                                              vmr->vm_prot, vmr->vm_file->f_mapping,
338                                              vmr->vm_foff, vmr->vm_flags,
339                                              vmr->vm_prot & PROT_EXEC);
340                         kref_put(&vmr->vm_file->f_kref);
341                 }
342         }
343         return ret;
344 }
345
346 /* This will make new_p have the same VMRs as p, and it will make sure all
347  * physical pages are copied over, with the exception of MAP_SHARED files.
348  * MAP_SHARED files that are also MAP_LOCKED will be attached to the process -
349  * presumably they are in the page cache since the parent locked them.  This is
350  * all pretty nasty.
351  *
352  * This is used by fork().
353  *
354  * Note that if you are working on a VMR that is a file, you'll want to be
355  * careful about how it is mapped (SHARED, PRIVATE, etc). */
356 int duplicate_vmrs(struct proc *p, struct proc *new_p)
357 {
358         int ret = 0;
359         struct vm_region *vmr, *vm_i;
360
361         TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
362                 vmr = kmem_cache_alloc(vmr_kcache, 0);
363                 if (!vmr)
364                         return -ENOMEM;
365                 vmr->vm_proc = new_p;
366                 vmr->vm_base = vm_i->vm_base;
367                 vmr->vm_end = vm_i->vm_end;
368                 vmr->vm_prot = vm_i->vm_prot;
369                 vmr->vm_flags = vm_i->vm_flags;
370                 vmr->vm_file = vm_i->vm_file;
371                 vmr->vm_foff = vm_i->vm_foff;
372                 if (vm_i->vm_file) {
373                         kref_get(&vm_i->vm_file->f_kref, 1);
374                         pm_add_vmr(file2pm(vm_i->vm_file), vmr);
375                 }
376                 ret = fill_vmr(p, new_p, vmr);
377                 if (ret) {
378                         if (vm_i->vm_file) {
379                                 pm_remove_vmr(file2pm(vm_i->vm_file), vmr);
380                                 kref_put(&vm_i->vm_file->f_kref);
381                         }
382                         kmem_cache_free(vmr_kcache, vm_i);
383                         return ret;
384                 }
385                 TAILQ_INSERT_TAIL(&new_p->vm_regions, vmr, vm_link);
386         }
387         return 0;
388 }
389
390 void print_vmrs(struct proc *p)
391 {
392         int count = 0;
393         struct vm_region *vmr;
394         printk("VM Regions for proc %d\n", p->pid);
395         printk("NR:"
396                "                                     Range:"
397                "       Prot,"
398                "      Flags,"
399                "               File,"
400                "                Off\n");
401         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link)
402                 printk("%02d: (%p - %p): 0x%08x, 0x%08x, %p, %p\n", count++,
403                        vmr->vm_base, vmr->vm_end, vmr->vm_prot, vmr->vm_flags,
404                        vmr->vm_file, vmr->vm_foff);
405 }
406
407 void enumerate_vmrs(struct proc *p,
408                                         void (*func)(struct vm_region *vmr, void *opaque),
409                                         void *opaque)
410 {
411         struct vm_region *vmr;
412
413         spin_lock(&p->vmr_lock);
414         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link)
415                 func(vmr, opaque);
416         spin_unlock(&p->vmr_lock);
417 }
418
419 /* Error values aren't quite comprehensive - check man mmap() once we do better
420  * with the FS.
421  *
422  * The mmap call's offset is in units of PGSIZE (like Linux's mmap2()), but
423  * internally, the offset is tracked in bytes.  The reason for the PGSIZE is for
424  * 32bit apps to enumerate large files, but a full 64bit system won't need that.
425  * We track things internally in bytes since that is how file pointers work, vmr
426  * bases and ends, and similar math.  While it's not a hard change, there's no
427  * need for it, and ideally we'll be a fully 64bit system before we deal with
428  * files that large. */
429 void *mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
430            int fd, size_t offset)
431 {
432         struct file *file = NULL;
433         offset <<= PGSHIFT;
434         printd("mmap(addr %x, len %x, prot %x, flags %x, fd %x, off %x)\n", addr,
435                len, prot, flags, fd, offset);
436         if (fd >= 0 && (flags & MAP_ANON)) {
437                 set_errno(EBADF);
438                 return MAP_FAILED;
439         }
440         if (!len) {
441                 set_errno(EINVAL);
442                 return MAP_FAILED;
443         }
444         if (fd != -1) {
445                 file = get_file_from_fd(&p->open_files, fd);
446                 if (!file) {
447                         set_errno(EBADF);
448                         return MAP_FAILED;
449                 }
450         }
451         /* Check for overflow.  This helps do_mmap and populate_va, among others. */
452         if (offset + len < offset) {
453                 set_errno(EINVAL);
454                 return MAP_FAILED;
455         }
456         /* If they don't care where to put it, we'll start looking after the break.
457          * We could just have userspace handle this (in glibc's mmap), so we don't
458          * need to know about BRK_END, but this will work for now (and may avoid
459          * bugs).  Note that this limits mmap(0) a bit.  Keep this in sync with
460          * __do_mmap()'s check.  (Both are necessary).  */
461         if (addr == 0)
462                 addr = BRK_END;
463         /* Still need to enforce this: */
464         addr = MAX(addr, MMAP_LOWEST_VA);
465         /* Need to check addr + len, after we do our addr adjustments */
466         if (!__is_user_addr((void*)addr, len, UMAPTOP)) {
467                 set_errno(EINVAL);
468                 return MAP_FAILED;
469         }
470         if (PGOFF(addr)) {
471                 set_errno(EINVAL);
472                 return MAP_FAILED;
473         }
474         void *result = do_mmap(p, addr, len, prot, flags, file, offset);
475         if (file)
476                 kref_put(&file->f_kref);
477         return result;
478 }
479
480 /* Helper: returns TRUE if the VMR is allowed to access the file with prot.
481  * This is a bit ghetto still: messes with the file mode and assumes it can walk
482  * the dentry/inode paths without locking.  It also ignores the CoW stuff we'll
483  * need to do eventually. */
484 static bool check_file_perms(struct vm_region *vmr, struct file *file, int prot)
485 {
486         assert(file);
487         if (prot & PROT_READ) {
488                 if (check_perms(file->f_dentry->d_inode, S_IRUSR))
489                         goto out_error;
490         }
491         if (prot & PROT_WRITE) {
492                 /* if vmr maps a file as MAP_SHARED, then we need to make sure the
493                  * protection change is in compliance with the open mode of the
494                  * file. */
495                 if (vmr->vm_flags & MAP_SHARED) {
496                         if (!(file->f_mode & S_IWUSR)) {
497                                 /* at this point, we have a file opened in the wrong mode,
498                                  * but we may be allowed to access it still. */
499                                 if (check_perms(file->f_dentry->d_inode, S_IWUSR)) {
500                                         goto out_error;
501                                 } else {
502                                         /* it is okay, though we need to change the file mode. (note
503                                          * the lack of a lock/protection (TODO) */
504                                         file->f_mode |= S_IWUSR;
505                                 }
506                         }
507                 } else {        /* PRIVATE mapping */
508                         /* TODO: we want a CoW mapping (like we want in handle_page_fault()),
509                          * since there is a concern of a process having the page already
510                          * mapped in to a file it does not have permissions to, and then
511                          * mprotecting it so it can access it.  So we can't just change
512                          * the prot, and we don't know yet if a page is mapped in.  To
513                          * handle this, we ought to sort out the CoW bit, and then this
514                          * will be easy.  Til then, just do a permissions check.  If we
515                          * start having weird issues with libc overwriting itself (since
516                          * procs mprotect that W), then change this. */
517                         if (check_perms(file->f_dentry->d_inode, S_IWUSR))
518                                 goto out_error;
519                 }
520         }
521         return TRUE;
522 out_error:      /* for debugging */
523         printk("[kernel] mmap perm check failed for %s for access %d\n",
524                file_name(file), prot);
525         return FALSE;
526 }
527
528 /* Helper, maps in page at addr, but only if nothing is mapped there.  Returns
529  * 0 on success.  If this is called by non-PM code, we'll store your ref in the
530  * PTE. */
531 static int map_page_at_addr(struct proc *p, struct page *page, uintptr_t addr,
532                             int prot)
533 {
534         pte_t pte;
535         spin_lock(&p->pte_lock);        /* walking and changing PTEs */
536         /* find offending PTE (prob don't read this in).  This might alloc an
537          * intermediate page table page. */
538         pte = pgdir_walk(p->env_pgdir, (void*)addr, TRUE);
539         if (!pte_walk_okay(pte)) {
540                 spin_unlock(&p->pte_lock);
541                 return -ENOMEM;
542         }
543         /* a spurious, valid PF is possible due to a legit race: the page might have
544          * been faulted in by another core already (and raced on the memory lock),
545          * in which case we should just return. */
546         if (pte_is_present(pte)) {
547                 spin_unlock(&p->pte_lock);
548                 /* non-PM callers expect us to eat the ref if we succeed. */
549                 if (!page_is_pagemap(page))
550                         page_decref(page);
551                 return 0;
552         }
553         if (pte_is_mapped(pte)) {
554                 /* we're clobbering an old entry.  if we're just updating the prot, then
555                  * it's no big deal.  o/w, there might be an issue. */
556                 if (page2pa(page) != pte_get_paddr(pte)) {
557                         warn_once("Clobbered a PTE mapping (%p -> %p)\n", pte_print(pte),
558                                   page2pa(page) | prot);
559                 }
560                 if (!page_is_pagemap(pa2page(pte_get_paddr(pte))))
561                         page_decref(pa2page(pte_get_paddr(pte)));
562         }
563         /* preserve the dirty bit - pm removal could be looking concurrently */
564         prot |= (pte_is_dirty(pte) ? PTE_D : 0);
565         /* We have a ref to page, which we are storing in the PTE */
566         pte_write(pte, page2pa(page), prot);
567         spin_unlock(&p->pte_lock);
568         return 0;
569 }
570
571 /* Helper: copies *pp's contents to a new page, replacing your page pointer.  If
572  * this succeeds, you'll have a non-PM page, which matters for how you put it.*/
573 static int __copy_and_swap_pmpg(struct proc *p, struct page **pp)
574 {
575         struct page *new_page, *old_page = *pp;
576         if (upage_alloc(p, &new_page, FALSE))
577                 return -ENOMEM;
578         memcpy(page2kva(new_page), page2kva(old_page), PGSIZE);
579         pm_put_page(old_page);
580         *pp = new_page;
581         return 0;
582 }
583
584 /* Hold the VMR lock when you call this - it'll assume the entire VA range is
585  * mappable, which isn't true if there are concurrent changes to the VMRs. */
586 static int populate_anon_va(struct proc *p, uintptr_t va, unsigned long nr_pgs,
587                             int pte_prot)
588 {
589         struct page *page;
590         int ret;
591         for (long i = 0; i < nr_pgs; i++) {
592                 if (upage_alloc(p, &page, TRUE))
593                         return -ENOMEM;
594                 /* could imagine doing a memwalk instead of a for loop */
595                 ret = map_page_at_addr(p, page, va + i * PGSIZE, pte_prot);
596                 if (ret) {
597                         page_decref(page);
598                         return ret;
599                 }
600         }
601         return 0;
602 }
603
604 /* This will periodically unlock the vmr lock. */
605 static int populate_pm_va(struct proc *p, uintptr_t va, unsigned long nr_pgs,
606                           int pte_prot, struct page_map *pm, size_t offset,
607                           int flags, bool exec)
608 {
609         int ret = 0;
610         unsigned long pm_idx0 = offset >> PGSHIFT;
611         int vmr_history = ACCESS_ONCE(p->vmr_history);
612         struct page *page;
613
614         /* locking rules: start the loop holding the vmr lock, enter and exit the
615          * entire func holding the lock. */
616         for (long i = 0; i < nr_pgs; i++) {
617                 ret = pm_load_page_nowait(pm, pm_idx0 + i, &page);
618                 if (ret) {
619                         if (ret != -EAGAIN)
620                                 break;
621                         spin_unlock(&p->vmr_lock);
622                         /* might block here, can't hold the spinlock */
623                         ret = pm_load_page(pm, pm_idx0 + i, &page);
624                         spin_lock(&p->vmr_lock);
625                         if (ret)
626                                 break;
627                         /* while we were sleeping, the VMRs could have changed on us. */
628                         if (vmr_history != ACCESS_ONCE(p->vmr_history)) {
629                                 pm_put_page(page);
630                                 printk("[kernel] FYI: VMR changed during populate\n");
631                                 break;
632                         }
633                 }
634                 if (flags & MAP_PRIVATE) {
635                         ret = __copy_and_swap_pmpg(p, &page);
636                         if (ret) {
637                                 pm_put_page(page);
638                                 break;
639                         }
640                 }
641                 /* if this is an executable page, we might have to flush the
642                  * instruction cache if our HW requires it.
643                  * TODO: is this still needed?  andrew put this in a while ago*/
644                 if (exec)
645                         icache_flush_page(0, page2kva(page));
646                 ret = map_page_at_addr(p, page, va + i * PGSIZE, pte_prot);
647                 if (page_is_pagemap(page))
648                         pm_put_page(page);
649                 if (ret)
650                         break;
651         }
652         return ret;
653 }
654
655 void *do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
656               struct file *file, size_t offset)
657 {
658         len = ROUNDUP(len, PGSIZE);
659         struct vm_region *vmr, *vmr_temp;
660
661         /* read/write vmr lock (will change the tree) */
662         spin_lock(&p->vmr_lock);
663         p->vmr_history++;
664         /* Sanity check, for callers that bypass mmap().  We want addr for anon
665          * memory to start above the break limit (BRK_END), but not 0.  Keep this in
666          * sync with BRK_END in mmap(). */
667         if (addr == 0)
668                 addr = BRK_END;
669         assert(!PGOFF(offset));
670
671         /* MCPs will need their code and data pinned.  This check will start to fail
672          * after uthread_slim_init(), at which point userspace should have enough
673          * control over its mmaps (i.e. no longer done by LD or load_elf) that it
674          * can ask for pinned and populated pages.  Except for dl_opens(). */
675         struct preempt_data *vcpd = &p->procdata->vcore_preempt_data[0];
676         if (file && (atomic_read(&vcpd->flags) & VC_SCP_NOVCCTX))
677                 flags |= MAP_POPULATE | MAP_LOCKED;
678         /* Need to make sure nothing is in our way when we want a FIXED location.
679          * We just need to split on the end points (if they exist), and then remove
680          * everything in between.  __do_munmap() will do this.  Careful, this means
681          * an mmap can be an implied munmap() (not my call...). */
682         if (flags & MAP_FIXED)
683                 __do_munmap(p, addr, len);
684         vmr = create_vmr(p, addr, len);
685         if (!vmr) {
686                 printk("[kernel] do_mmap() aborted for %p + %p!\n", addr, len);
687                 set_errno(ENOMEM);
688                 spin_unlock(&p->vmr_lock);
689                 return MAP_FAILED;
690         }
691         addr = vmr->vm_base;
692         vmr->vm_prot = prot;
693         vmr->vm_flags = flags;
694         vmr->vm_foff = offset;
695         if (file) {
696                 if (!check_file_perms(vmr, file, prot)) {
697                         assert(!vmr->vm_file);
698                         destroy_vmr(vmr);
699                         set_errno(EACCES);
700                         spin_unlock(&p->vmr_lock);
701                         return MAP_FAILED;
702                 }
703                 /* TODO: consider locking the file while checking (not as manadatory as
704                  * in handle_page_fault() */
705                 if (nr_pages(offset + len) > nr_pages(file->f_dentry->d_inode->i_size)) {
706                         /* We're allowing them to set up the VMR, though if they attempt to
707                          * fault in any pages beyond the file's limit, they'll fail.  Since
708                          * they might not access the region, we need to make sure POPULATE
709                          * is off.  FYI, 64 bit glibc shared libs map in an extra 2MB of
710                          * unaligned space between their RO and RW sections, but then
711                          * immediately mprotect it to PROT_NONE. */
712                         flags &= ~MAP_POPULATE;
713                 }
714                 /* Prep the FS to make sure it can mmap the file.  Slightly weird
715                  * semantics: if we fail and had munmapped the space, they will have a
716                  * hole in their VM now. */
717                 if (file->f_op->mmap(file, vmr)) {
718                         assert(!vmr->vm_file);
719                         destroy_vmr(vmr);
720                         set_errno(EACCES);      /* not quite */
721                         spin_unlock(&p->vmr_lock);
722                         return MAP_FAILED;
723                 }
724                 kref_get(&file->f_kref, 1);
725                 pm_add_vmr(file2pm(file), vmr);
726         }
727         vmr->vm_file = file;
728         vmr = merge_me(vmr);            /* attempts to merge with neighbors */
729
730         if (flags & MAP_POPULATE && prot != PROT_NONE) {
731                 int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
732                            (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
733                 unsigned long nr_pgs = len >> PGSHIFT;
734                 int ret = 0;
735                 if (!file) {
736                         ret = populate_anon_va(p, addr, nr_pgs, pte_prot);
737                 } else {
738                         /* Note: this will unlock if it blocks.  our refcnt on the file
739                          * keeps the pm alive when we unlock */
740                         ret = populate_pm_va(p, addr, nr_pgs, pte_prot, file->f_mapping,
741                                              offset, flags, prot & PROT_EXEC);
742                 }
743                 if (ret == -ENOMEM) {
744                         spin_unlock(&p->vmr_lock);
745                         printk("[kernel] ENOMEM, killing %d\n", p->pid);
746                         proc_destroy(p);
747                         return MAP_FAILED;      /* will never make it back to userspace */
748                 }
749         }
750         spin_unlock(&p->vmr_lock);
751
752         profiler_notify_mmap(p, addr, len, prot, flags, file, offset);
753
754         return (void*)addr;
755 }
756
757 int mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
758 {
759         int ret;
760
761         printd("mprotect: (addr %p, len %p, prot 0x%x)\n", addr, len, prot);
762         if (!len)
763                 return 0;
764         len = ROUNDUP(len, PGSIZE);
765         if (PGOFF(addr)) {
766                 set_errno(EINVAL);
767                 return -1;
768         }
769         if (!__is_user_addr((void*)addr, len, UMAPTOP)) {
770                 set_errno(ENOMEM);
771                 return -1;
772         }
773         /* read/write lock, will probably change the tree and settings */
774         spin_lock(&p->vmr_lock);
775         p->vmr_history++;
776         ret = __do_mprotect(p, addr, len, prot);
777         spin_unlock(&p->vmr_lock);
778         return ret;
779 }
780
781 /* This does not care if the region is not mapped.  POSIX says you should return
782  * ENOMEM if any part of it is unmapped.  Can do this later if we care, based on
783  * the VMRs, not the actual page residency. */
784 int __do_mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
785 {
786         struct vm_region *vmr, *next_vmr;
787         pte_t pte;
788         bool shootdown_needed = FALSE;
789         int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
790                        (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : PTE_NONE;
791         /* TODO: this is aggressively splitting, when we might not need to if the
792          * prots are the same as the previous.  Plus, there are three excessive
793          * scans.  Finally, we might be able to merge when we are done. */
794         isolate_vmrs(p, addr, len);
795         vmr = find_first_vmr(p, addr);
796         while (vmr && vmr->vm_base < addr + len) {
797                 if (vmr->vm_prot == prot)
798                         continue;
799                 if (vmr->vm_file && !check_file_perms(vmr, vmr->vm_file, prot)) {
800                         set_errno(EACCES);
801                         return -1;
802                 }
803                 vmr->vm_prot = prot;
804                 spin_lock(&p->pte_lock);        /* walking and changing PTEs */
805                 /* TODO: use a memwalk.  At a minimum, we need to change every existing
806                  * PTE that won't trigger a PF (meaning, present PTEs) to have the new
807                  * prot.  The others will fault on access, and we'll change the PTE
808                  * then.  In the off chance we have a mapped but not present PTE, we
809                  * might as well change it too, since we're already here. */
810                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) {
811                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
812                         if (pte_walk_okay(pte) && pte_is_mapped(pte)) {
813                                 pte_replace_perm(pte, pte_prot);
814                                 shootdown_needed = TRUE;
815                         }
816                 }
817                 spin_unlock(&p->pte_lock);
818                 vmr = merge_me(vmr);
819                 next_vmr = TAILQ_NEXT(vmr, vm_link);
820                 vmr = next_vmr;
821         }
822         if (shootdown_needed)
823                 proc_tlbshootdown(p, addr, addr + len);
824         return 0;
825 }
826
827 int munmap(struct proc *p, uintptr_t addr, size_t len)
828 {
829         int ret;
830
831         printd("munmap(addr %x, len %x)\n", addr, len);
832         if (!len)
833                 return 0;
834         len = ROUNDUP(len, PGSIZE);
835         if (PGOFF(addr)) {
836                 set_errno(EINVAL);
837                 return -1;
838         }
839         if (!__is_user_addr((void*)addr, len, UMAPTOP)) {
840                 set_errno(EINVAL);
841                 return -1;
842         }
843         /* read/write: changing the vmrs (trees, properties, and whatnot) */
844         spin_lock(&p->vmr_lock);
845         p->vmr_history++;
846         ret = __do_munmap(p, addr, len);
847         spin_unlock(&p->vmr_lock);
848         return ret;
849 }
850
851 static int __munmap_mark_not_present(struct proc *p, pte_t pte, void *va,
852                                      void *arg)
853 {
854         bool *shootdown_needed = (bool*)arg;
855         /* could put in some checks here for !P and also !0 */
856         if (!pte_is_present(pte))       /* unmapped (== 0) *ptes are also not PTE_P */
857                 return 0;
858         pte_clear_present(pte);
859         *shootdown_needed = TRUE;
860         return 0;
861 }
862
863 /* If our page is actually in the PM, we don't do anything.  All a page map
864  * really needs is for our VMR to no longer track it (vmr being in the pm's
865  * list) and to not point at its pages (mark it 0, dude).
866  *
867  * But private mappings mess with that a bit.  Luckily, we can tell by looking
868  * at a page whether the specific page is in the PM or not.  If it isn't, we
869  * still need to free our "VMR local" copy.
870  *
871  * For pages in a PM, we're racing with PM removers.  Both of us sync with the
872  * mm lock, so once we hold the lock, it's a matter of whether or not the PTE is
873  * 0 or not.  If it isn't, then we're still okay to look at the page.  Consider
874  * the PTE a weak ref on the page.  So long as you hold the mm lock, you can
875  * look at the PTE and know the page isn't being freed. */
876 static int __vmr_free_pgs(struct proc *p, pte_t pte, void *va, void *arg)
877 {
878         struct page *page;
879         if (pte_is_unmapped(pte))
880                 return 0;
881         page = pa2page(pte_get_paddr(pte));
882         pte_clear(pte);
883         if (!page_is_pagemap(page))
884                 page_decref(page);
885         return 0;
886 }
887
888 int __do_munmap(struct proc *p, uintptr_t addr, size_t len)
889 {
890         struct vm_region *vmr, *next_vmr, *first_vmr;
891         bool shootdown_needed = FALSE;
892
893         /* TODO: this will be a bit slow, since we end up doing three linear
894          * searches (two in isolate, one in find_first). */
895         isolate_vmrs(p, addr, len);
896         first_vmr = find_first_vmr(p, addr);
897         vmr = first_vmr;
898         spin_lock(&p->pte_lock);        /* changing PTEs */
899         while (vmr && vmr->vm_base < addr + len) {
900                 env_user_mem_walk(p, (void*)vmr->vm_base, vmr->vm_end - vmr->vm_base,
901                                   __munmap_mark_not_present, &shootdown_needed);
902                 vmr = TAILQ_NEXT(vmr, vm_link);
903         }
904         spin_unlock(&p->pte_lock);
905         /* we haven't freed the pages yet; still using the PTEs to store the them.
906          * There should be no races with inserts/faults, since we still hold the mm
907          * lock since the previous CB. */
908         if (shootdown_needed)
909                 proc_tlbshootdown(p, addr, addr + len);
910         vmr = first_vmr;
911         while (vmr && vmr->vm_base < addr + len) {
912                 /* there is rarely more than one VMR in this loop.  o/w, we'll need to
913                  * gather up the vmrs and destroy outside the pte_lock. */
914                 spin_lock(&p->pte_lock);        /* changing PTEs */
915                 env_user_mem_walk(p, (void*)vmr->vm_base, vmr->vm_end - vmr->vm_base,
916                                       __vmr_free_pgs, 0);
917                 spin_unlock(&p->pte_lock);
918                 next_vmr = TAILQ_NEXT(vmr, vm_link);
919                 destroy_vmr(vmr);
920                 vmr = next_vmr;
921         }
922         return 0;
923 }
924
925 /* Helper - drop the page differently based on where it is from */
926 static void __put_page(struct page *page)
927 {
928         if (page_is_pagemap(page))
929                 pm_put_page(page);
930         else
931                 page_decref(page);
932 }
933
934 static int __hpf_load_page(struct proc *p, struct page_map *pm,
935                            unsigned long idx, struct page **page, bool first)
936 {
937         int ret = 0;
938         int coreid = core_id();
939         struct per_cpu_info *pcpui = &per_cpu_info[coreid];
940         bool wake_scp = FALSE;
941         spin_lock(&p->proc_lock);
942         switch (p->state) {
943                 case (PROC_RUNNING_S):
944                         wake_scp = TRUE;
945                         __proc_set_state(p, PROC_WAITING);
946                         /* it's possible for HPF to loop a few times; we can only save the
947                          * first time, o/w we could clobber. */
948                         if (first) {
949                                 __proc_save_context_s(p);
950                                 __proc_save_fpu_s(p);
951                                 /* We clear the owner, since userspace doesn't run here
952                                  * anymore, but we won't abandon since the fault handler
953                                  * still runs in our process. */
954                                 clear_owning_proc(coreid);
955                         }
956                         /* other notes: we don't currently need to tell the ksched
957                          * we switched from running to waiting, though we probably
958                          * will later for more generic scheds. */
959                         break;
960                 case (PROC_RUNNABLE_M):
961                 case (PROC_RUNNING_M):
962                         spin_unlock(&p->proc_lock);
963                         return -EAGAIN; /* will get reflected back to userspace */
964                 case (PROC_DYING):
965                 case (PROC_DYING_ABORT):
966                         spin_unlock(&p->proc_lock);
967                         return -EINVAL;
968                 default:
969                         /* shouldn't have any waitings, under the current yield style.  if
970                          * this becomes an issue, we can branch on is_mcp(). */
971                         printk("HPF unexpectecd state(%s)", procstate2str(p->state));
972                         spin_unlock(&p->proc_lock);
973                         return -EINVAL;
974         }
975         spin_unlock(&p->proc_lock);
976         ret = pm_load_page(pm, idx, page);
977         if (wake_scp)
978                 proc_wakeup(p);
979         if (ret) {
980                 printk("load failed with ret %d\n", ret);
981                 return ret;
982         }
983         /* need to put our old ref, next time around HPF will get another. */
984         pm_put_page(*page);
985         return 0;
986 }
987
988 /* Returns 0 on success, or an appropriate -error code.
989  *
990  * Notes: if your TLB caches negative results, you'll need to flush the
991  * appropriate tlb entry.  Also, you could have a weird race where a present PTE
992  * faulted for a different reason (was mprotected on another core), and the
993  * shootdown is on its way.  Userspace should have waited for the mprotect to
994  * return before trying to write (or whatever), so we don't care and will fault
995  * them. */
996 static int __hpf(struct proc *p, uintptr_t va, int prot, bool file_ok)
997 {
998         struct vm_region *vmr;
999         struct page *a_page;
1000         unsigned int f_idx;     /* index of the missing page in the file */
1001         int ret = 0;
1002         bool first = TRUE;
1003         va = ROUNDDOWN(va,PGSIZE);
1004
1005 refault:
1006         /* read access to the VMRs TODO: RCU */
1007         spin_lock(&p->vmr_lock);
1008         /* Check the vmr's protection */
1009         vmr = find_vmr(p, va);
1010         if (!vmr) {                                                     /* not mapped at all */
1011                 printd("fault: %p not mapped\n", va);
1012                 ret = -EFAULT;
1013                 goto out;
1014         }
1015         if (!(vmr->vm_prot & prot)) {           /* wrong prots for this vmr */
1016                 ret = -EPERM;
1017                 goto out;
1018         }
1019         if (!vmr->vm_file) {
1020                 /* No file - just want anonymous memory */
1021                 if (upage_alloc(p, &a_page, TRUE)) {
1022                         ret = -ENOMEM;
1023                         goto out;
1024                 }
1025         } else {
1026                 if (!file_ok)
1027                         return -EACCES;
1028                 /* If this fails, either something got screwed up with the VMR, or the
1029                  * permissions changed after mmap/mprotect.  Either way, I want to know
1030                  * (though it's not critical). */
1031                 if (!check_file_perms(vmr, vmr->vm_file, prot))
1032                         printk("[kernel] possible issue with VMR prots on file %s!\n",
1033                                file_name(vmr->vm_file));
1034                 /* Load the file's page in the page cache.
1035                  * TODO: (BLK) Note, we are holding the mem lock!  We need to rewrite
1036                  * this stuff so we aren't hold the lock as excessively as we are, and
1037                  * such that we can block and resume later. */
1038                 assert(!PGOFF(va - vmr->vm_base + vmr->vm_foff));
1039                 f_idx = (va - vmr->vm_base + vmr->vm_foff) >> PGSHIFT;
1040                 /* TODO: need some sort of lock on the file to deal with someone
1041                  * concurrently shrinking it.  Adding 1 to f_idx, since it is
1042                  * zero-indexed */
1043                 if (f_idx + 1 > nr_pages(vmr->vm_file->f_dentry->d_inode->i_size)) {
1044                         /* We're asking for pages that don't exist in the file */
1045                         /* TODO: unlock the file */
1046                         ret = -ESPIPE; /* linux sends a SIGBUS at access time */
1047                         goto out;
1048                 }
1049                 ret = pm_load_page_nowait(vmr->vm_file->f_mapping, f_idx, &a_page);
1050                 if (ret) {
1051                         if (ret != -EAGAIN)
1052                                 goto out;
1053                         /* keep the file alive after we unlock */
1054                         kref_get(&vmr->vm_file->f_kref, 1);
1055                         spin_unlock(&p->vmr_lock);
1056                         ret = __hpf_load_page(p, vmr->vm_file->f_mapping, f_idx, &a_page,
1057                                               first);
1058                         first = FALSE;
1059                         kref_put(&vmr->vm_file->f_kref);
1060                         if (ret)
1061                                 return ret;
1062                         goto refault;
1063                 }
1064                 /* If we want a private map, we'll preemptively give you a new page.  We
1065                  * used to just care if it was private and writable, but were running
1066                  * into issues with libc changing its mapping (map private, then
1067                  * mprotect to writable...)  In the future, we want to CoW this anyway,
1068                  * so it's not a big deal. */
1069                 if ((vmr->vm_flags & MAP_PRIVATE)) {
1070                         ret = __copy_and_swap_pmpg(p, &a_page);
1071                         if (ret)
1072                                 goto out_put_pg;
1073                 }
1074                 /* if this is an executable page, we might have to flush the instruction
1075                  * cache if our HW requires it. */
1076                 if (vmr->vm_prot & PROT_EXEC)
1077                         icache_flush_page((void*)va, page2kva(a_page));
1078         }
1079         /* update the page table TODO: careful with MAP_PRIVATE etc.  might do this
1080          * separately (file, no file) */
1081         int pte_prot = (vmr->vm_prot & PROT_WRITE) ? PTE_USER_RW :
1082                        (vmr->vm_prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
1083         ret = map_page_at_addr(p, a_page, va, pte_prot);
1084         if (ret) {
1085                 printd("map_page_at for %p fails with %d\n", va, ret);
1086         }
1087         /* fall through, even for errors */
1088 out_put_pg:
1089         /* the VMR's existence in the PM (via the mmap) allows us to have PTE point
1090          * to a_page without it magically being reallocated.  For non-PM memory
1091          * (anon memory or private pages) we transferred the ref to the PTE. */
1092         if (page_is_pagemap(a_page))
1093                 pm_put_page(a_page);
1094 out:
1095         spin_unlock(&p->vmr_lock);
1096         return ret;
1097 }
1098
1099 int handle_page_fault(struct proc *p, uintptr_t va, int prot)
1100 {
1101         return __hpf(p, va, prot, TRUE);
1102 }
1103
1104 int handle_page_fault_nofile(struct proc *p, uintptr_t va, int prot)
1105 {
1106         return __hpf(p, va, prot, FALSE);
1107 }
1108
1109 /* Attempts to populate the pages, as if there was a page faults.  Bails on
1110  * errors, and returns the number of pages populated.  */
1111 unsigned long populate_va(struct proc *p, uintptr_t va, unsigned long nr_pgs)
1112 {
1113         struct vm_region *vmr, vmr_copy;
1114         unsigned long nr_pgs_this_vmr;
1115         unsigned long nr_filled = 0;
1116         struct page *page;
1117         int pte_prot;
1118         int ret;
1119
1120         /* we can screw around with ways to limit the find_vmr calls (can do the
1121          * next in line if we didn't unlock, etc., but i don't expect us to do this
1122          * for more than a single VMR in most cases. */
1123         spin_lock(&p->vmr_lock);
1124         while (nr_pgs) {
1125                 vmr = find_vmr(p, va);
1126                 if (!vmr)
1127                         break;
1128                 if (vmr->vm_prot == PROT_NONE)
1129                         break;
1130                 pte_prot = (vmr->vm_prot & PROT_WRITE) ? PTE_USER_RW :
1131                            (vmr->vm_prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
1132                 nr_pgs_this_vmr = MIN(nr_pgs, (vmr->vm_end - va) >> PGSHIFT);
1133                 if (!vmr->vm_file) {
1134                         if (populate_anon_va(p, va, nr_pgs_this_vmr, pte_prot)) {
1135                                 /* on any error, we can just bail.  we might be underestimating
1136                                  * nr_filled. */
1137                                 break;
1138                         }
1139                 } else {
1140                         /* need to keep the file alive in case we unlock/block */
1141                         kref_get(&vmr->vm_file->f_kref, 1);
1142                         /* Regarding foff + (va - base): va - base < len, and foff + len
1143                          * does not over flow */
1144                         ret = populate_pm_va(p, va, nr_pgs_this_vmr, pte_prot,
1145                                              vmr->vm_file->f_mapping,
1146                                              vmr->vm_foff + (va - vmr->vm_base),
1147                                              vmr->vm_flags, vmr->vm_prot & PROT_EXEC);
1148                         kref_put(&vmr->vm_file->f_kref);
1149                         if (ret) {
1150                                 /* we might have failed if the underlying file doesn't cover the
1151                                  * mmap window, depending on how we'll deal with truncation. */
1152                                 break;
1153                         }
1154                 }
1155                 nr_filled += nr_pgs_this_vmr;
1156                 va += nr_pgs_this_vmr << PGSHIFT;
1157                 nr_pgs -= nr_pgs_this_vmr;
1158         }
1159         spin_unlock(&p->vmr_lock);
1160         return nr_filled;
1161 }
1162
1163 /* Kernel Dynamic Memory Mappings */
1164 uintptr_t dyn_vmap_llim = KERN_DYN_TOP;
1165 spinlock_t dyn_vmap_lock = SPINLOCK_INITIALIZER;
1166
1167 /* Reserve space in the kernel dynamic memory map area */
1168 uintptr_t get_vmap_segment(unsigned long num_pages)
1169 {
1170         uintptr_t retval;
1171         spin_lock(&dyn_vmap_lock);
1172         retval = dyn_vmap_llim - num_pages * PGSIZE;
1173         if ((retval > ULIM) && (retval < KERN_DYN_TOP)) {
1174                 dyn_vmap_llim = retval;
1175         } else {
1176                 warn("[kernel] dynamic mapping failed!");
1177                 retval = 0;
1178         }
1179         spin_unlock(&dyn_vmap_lock);
1180         return retval;
1181 }
1182
1183 /* Give up your space.  Note this isn't supported yet */
1184 uintptr_t put_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
1185 {
1186         /* TODO: use vmem regions for adjustable vmap segments */
1187         warn("Not implemented, leaking vmem space.\n");
1188         return 0;
1189 }
1190
1191 /* Map a virtual address chunk to physical addresses.  Make sure you got a vmap
1192  * segment before actually trying to do the mapping.
1193  *
1194  * Careful with more than one 'page', since it will assume your physical pages
1195  * are also contiguous.  Most callers will only use one page.
1196  *
1197  * Finally, note that this does not care whether or not there are real pages
1198  * being mapped, and will not attempt to incref your page (if there is such a
1199  * thing).  Handle your own refcnting for pages. */
1200 int map_vmap_segment(uintptr_t vaddr, uintptr_t paddr, unsigned long num_pages,
1201                      int perm)
1202 {
1203         /* For now, we only handle the root pgdir, and not any of the other ones
1204          * (like for processes).  To do so, we'll need to insert into every pgdir,
1205          * and send tlb shootdowns to those that are active (which we don't track
1206          * yet). */
1207         extern int booting;
1208         assert(booting);
1209
1210         /* TODO: (MM) you should lock on boot pgdir modifications.  A vm region lock
1211          * isn't enough, since there might be a race on outer levels of page tables.
1212          * For now, we'll just use the dyn_vmap_lock (which technically works). */
1213         spin_lock(&dyn_vmap_lock);
1214         pte_t pte;
1215 #ifdef CONFIG_X86
1216         perm |= PTE_G;
1217 #endif
1218         for (int i = 0; i < num_pages; i++) {
1219                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
1220                 if (!pte_walk_okay(pte)) {
1221                         spin_unlock(&dyn_vmap_lock);
1222                         return -ENOMEM;
1223                 }
1224                 /* You probably should have unmapped first */
1225                 if (pte_is_mapped(pte))
1226                         warn("Existing PTE value %p\n", pte_print(pte));
1227                 pte_write(pte, paddr + i * PGSIZE, perm);
1228         }
1229         spin_unlock(&dyn_vmap_lock);
1230         return 0;
1231 }
1232
1233 /* Unmaps / 0's the PTEs of a chunk of vaddr space */
1234 int unmap_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
1235 {
1236         /* Not a big deal - won't need this til we do something with kthreads */
1237         warn("Incomplete, don't call this yet.");
1238         spin_lock(&dyn_vmap_lock);
1239         /* TODO: For all pgdirs */
1240         pte_t pte;
1241         for (int i = 0; i < num_pages; i++) {
1242                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
1243                 if (pte_walk_okay(pte))
1244                         pte_clear(pte);
1245         }
1246         /* TODO: TLB shootdown.  Also note that the global flag is set on the PTE
1247          * (for x86 for now), which requires a global shootdown.  bigger issue is
1248          * the TLB shootdowns for multiple pgdirs.  We'll need to remove from every
1249          * pgdir, and send tlb shootdowns to those that are active (which we don't
1250          * track yet). */
1251         spin_unlock(&dyn_vmap_lock);
1252         return 0;
1253 }
1254
1255 /* This can handle unaligned paddrs */
1256 static uintptr_t vmap_pmem_flags(uintptr_t paddr, size_t nr_bytes, int flags)
1257 {
1258         uintptr_t vaddr;
1259         unsigned long nr_pages;
1260         assert(nr_bytes && paddr);
1261         nr_bytes += PGOFF(paddr);
1262         nr_pages = ROUNDUP(nr_bytes, PGSIZE) >> PGSHIFT;
1263         vaddr = get_vmap_segment(nr_pages);
1264         if (!vaddr) {
1265                 warn("Unable to get a vmap segment");   /* probably a bug */
1266                 return 0;
1267         }
1268         /* it's not strictly necessary to drop paddr's pgoff, but it might save some
1269          * vmap heartache in the future. */
1270         if (map_vmap_segment(vaddr, PG_ADDR(paddr), nr_pages,
1271                              PTE_KERN_RW | flags)) {
1272                 warn("Unable to map a vmap segment");   /* probably a bug */
1273                 return 0;
1274         }
1275         return vaddr + PGOFF(paddr);
1276 }
1277
1278 uintptr_t vmap_pmem(uintptr_t paddr, size_t nr_bytes)
1279 {
1280         return vmap_pmem_flags(paddr, nr_bytes, 0);
1281 }
1282
1283 uintptr_t vmap_pmem_nocache(uintptr_t paddr, size_t nr_bytes)
1284 {
1285         return vmap_pmem_flags(paddr, nr_bytes, PTE_NOCACHE);
1286 }
1287
1288 uintptr_t vmap_pmem_writecomb(uintptr_t paddr, size_t nr_bytes)
1289 {
1290         return vmap_pmem_flags(paddr, nr_bytes, PTE_WRITECOMB);
1291 }
1292
1293 int vunmap_vmem(uintptr_t vaddr, size_t nr_bytes)
1294 {
1295         unsigned long nr_pages = ROUNDUP(nr_bytes, PGSIZE) >> PGSHIFT;
1296         unmap_vmap_segment(vaddr, nr_pages);
1297         put_vmap_segment(vaddr, nr_pages);
1298         return 0;
1299 }