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