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