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