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