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