7d59b50b22d62dca7b5443767fcb9c343ca6240c
[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 memory lock (mm_lock) is
11  * already held 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
28 struct kmem_cache *vmr_kcache;
29
30 void vmr_init(void)
31 {
32         vmr_kcache = kmem_cache_create("vm_regions", sizeof(struct vm_region),
33                                        __alignof__(struct dentry), 0, 0, 0);
34 }
35
36 /* For now, the caller will set the prot, flags, file, and offset.  In the
37  * future, we may put those in here, to do clever things with merging vm_regions
38  * that are the same.
39  *
40  * TODO: take a look at solari's vmem alloc.  And consider keeping these in a
41  * tree of some sort for easier lookups. */
42 struct vm_region *create_vmr(struct proc *p, uintptr_t va, size_t len)
43 {
44         struct vm_region *vmr = 0, *vm_i, *vm_next;
45         uintptr_t gap_end;
46
47         assert(!PGOFF(va));
48         assert(!PGOFF(len));
49         assert(va + len <= UMAPTOP);
50         /* Is there room before the first one: */
51         vm_i = TAILQ_FIRST(&p->vm_regions);
52         /* This works for now, but if all we have is BRK_END ones, we'll start
53          * growing backwards (TODO) */
54         if (!vm_i || (va + len < vm_i->vm_base)) {
55                 vmr = kmem_cache_alloc(vmr_kcache, 0);
56                 if (!vmr)
57                         panic("EOM!");
58                 memset(vmr, 0, sizeof(struct vm_region));
59                 vmr->vm_base = va;
60                 TAILQ_INSERT_HEAD(&p->vm_regions, vmr, vm_link);
61         } else {
62                 TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
63                         vm_next = TAILQ_NEXT(vm_i, vm_link);
64                         gap_end = vm_next ? vm_next->vm_base : UMAPTOP;
65                         /* skip til we get past the 'hint' va */
66                         if (va >= gap_end)
67                                 continue;
68                         /* Find a gap that is big enough */
69                         if (gap_end - vm_i->vm_end >= len) {
70                                 vmr = kmem_cache_alloc(vmr_kcache, 0);
71                                 if (!vmr)
72                                         panic("EOM!");
73                                 memset(vmr, 0, sizeof(struct vm_region));
74                                 /* if we can put it at va, let's do that.  o/w, put it so it
75                                  * fits */
76                                 if ((gap_end >= va + len) && (va >= vm_i->vm_end))
77                                         vmr->vm_base = va;
78                                 else
79                                         vmr->vm_base = vm_i->vm_end;
80                                 TAILQ_INSERT_AFTER(&p->vm_regions, vm_i, vmr, vm_link);
81                                 break;
82                         }
83                 }
84         }
85         /* Finalize the creation, if we got one */
86         if (vmr) {
87                 vmr->vm_proc = p;
88                 vmr->vm_end = vmr->vm_base + len;
89         }
90         if (!vmr)
91                 warn("Not making a VMR, wanted %08p, + %p = %p", va, len, va + len);
92         return vmr;
93 }
94
95 /* Split a VMR at va, returning the new VMR.  It is set up the same way, with
96  * file offsets fixed accordingly.  'va' is the beginning of the new one, and
97  * must be page aligned. */
98 struct vm_region *split_vmr(struct vm_region *old_vmr, uintptr_t va)
99 {
100         struct vm_region *new_vmr;
101
102         assert(!PGOFF(va));
103         if ((old_vmr->vm_base >= va) || (old_vmr->vm_end <= va))
104                 return 0;
105         new_vmr = kmem_cache_alloc(vmr_kcache, 0);
106         TAILQ_INSERT_AFTER(&old_vmr->vm_proc->vm_regions, old_vmr, new_vmr,
107                            vm_link);
108         new_vmr->vm_proc = old_vmr->vm_proc;
109         new_vmr->vm_base = va;
110         new_vmr->vm_end = old_vmr->vm_end;
111         old_vmr->vm_end = va;
112         new_vmr->vm_prot = old_vmr->vm_prot;
113         new_vmr->vm_flags = old_vmr->vm_flags;
114         if (old_vmr->vm_file) {
115                 kref_get(&old_vmr->vm_file->f_kref, 1);
116                 new_vmr->vm_file = old_vmr->vm_file;
117                 new_vmr->vm_foff = old_vmr->vm_foff +
118                                       old_vmr->vm_end - old_vmr->vm_base;
119         } else {
120                 new_vmr->vm_file = 0;
121                 new_vmr->vm_foff = 0;
122         }
123         return new_vmr;
124 }
125
126 /* Merges two vm regions.  For now, it will check to make sure they are the
127  * same.  The second one will be destroyed. */
128 int merge_vmr(struct vm_region *first, struct vm_region *second)
129 {
130         assert(first->vm_proc == second->vm_proc);
131         if ((first->vm_end != second->vm_base) ||
132             (first->vm_prot != second->vm_prot) ||
133             (first->vm_flags != second->vm_flags) ||
134             (first->vm_file != second->vm_file))
135                 return -1;
136         if ((first->vm_file) && (second->vm_foff != first->vm_foff +
137                                  first->vm_end - first->vm_base))
138                 return -1;
139         first->vm_end = second->vm_end;
140         destroy_vmr(second);
141         return 0;
142 }
143
144 /* Attempts to merge vmr with adjacent VMRs, returning a ptr to be used for vmr.
145  * It could be the same struct vmr, or possibly another one (usually lower in
146  * the address space. */
147 struct vm_region *merge_me(struct vm_region *vmr)
148 {
149         struct vm_region *vmr_temp;
150         /* Merge will fail if it cannot do it.  If it succeeds, the second VMR is
151          * destroyed, so we need to be a bit careful. */
152         vmr_temp = TAILQ_PREV(vmr, vmr_tailq, vm_link);
153         if (vmr_temp)
154                 if (!merge_vmr(vmr_temp, vmr))
155                         vmr = vmr_temp;
156         vmr_temp = TAILQ_NEXT(vmr, vm_link);
157         if (vmr_temp)
158                 merge_vmr(vmr, vmr_temp);
159         return vmr;
160 }
161
162 /* Grows the vm region up to (and not including) va.  Fails if another is in the
163  * way, etc. */
164 int grow_vmr(struct vm_region *vmr, uintptr_t va)
165 {
166         assert(!PGOFF(va));
167         struct vm_region *next = TAILQ_NEXT(vmr, vm_link);
168         if (next && next->vm_base < va)
169                 return -1;
170         if (va <= vmr->vm_end)
171                 return -1;
172         vmr->vm_end = va;
173         return 0;
174 }
175
176 /* Shrinks the vm region down to (and not including) va.  Whoever calls this
177  * will need to sort out the page table entries. */
178 int shrink_vmr(struct vm_region *vmr, uintptr_t va)
179 {
180         assert(!PGOFF(va));
181         if ((va < vmr->vm_base) || (va > vmr->vm_end))
182                 return -1;
183         vmr->vm_end = va;
184         return 0;
185 }
186
187 /* Called by the unmapper, just cleans up.  Whoever calls this will need to sort
188  * out the page table entries. */
189 void destroy_vmr(struct vm_region *vmr)
190 {
191         if (vmr->vm_file)
192                 kref_put(&vmr->vm_file->f_kref);
193         TAILQ_REMOVE(&vmr->vm_proc->vm_regions, vmr, vm_link);
194         kmem_cache_free(vmr_kcache, vmr);
195 }
196
197 /* Given a va and a proc (later an mm, possibly), returns the owning vmr, or 0
198  * if there is none. */
199 struct vm_region *find_vmr(struct proc *p, uintptr_t va)
200 {
201         struct vm_region *vmr;
202         /* ugly linear seach */
203         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
204                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
205                         return vmr;
206         }
207         return 0;
208 }
209
210 /* Finds the first vmr after va (including the one holding va), or 0 if there is
211  * none. */
212 struct vm_region *find_first_vmr(struct proc *p, uintptr_t va)
213 {
214         struct vm_region *vmr;
215         /* ugly linear seach */
216         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
217                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
218                         return vmr;
219                 if (vmr->vm_base > va)
220                         return vmr;
221         }
222         return 0;
223 }
224
225 /* Makes sure that no VMRs cross either the start or end of the given region
226  * [va, va + len), splitting any VMRs that are on the endpoints. */
227 void isolate_vmrs(struct proc *p, uintptr_t va, size_t len)
228 {
229         struct vm_region *vmr;
230         if ((vmr = find_vmr(p, va)))
231                 split_vmr(vmr, va);
232         /* TODO: don't want to do another find (linear search) */
233         if ((vmr = find_vmr(p, va + len)))
234                 split_vmr(vmr, va + len);
235 }
236
237 /* Destroys all vmrs of a process - important for when files are mmap()d and
238  * probably later when we share memory regions */
239 void destroy_vmrs(struct proc *p)
240 {
241         struct vm_region *vm_i;
242         TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link)
243                 destroy_vmr(vm_i);
244 }
245
246 /* This will make new_p have the same VMRs as p, though it does nothing to
247  * ensure the physical pages or whatever are shared/mapped/copied/whatever.
248  * This is used by fork().
249  *
250  * Note that if you are working on a VMR that is a file, you'll want to be
251  * careful about how it is mapped (SHARED, PRIVATE, etc). */
252 void duplicate_vmrs(struct proc *p, struct proc *new_p)
253 {
254         struct vm_region *vmr, *vm_i;
255         TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
256                 vmr = kmem_cache_alloc(vmr_kcache, 0);
257                 if (!vmr)
258                         panic("EOM!");
259                 vmr->vm_proc = new_p;
260                 vmr->vm_base = vm_i->vm_base;
261                 vmr->vm_end = vm_i->vm_end;
262                 vmr->vm_prot = vm_i->vm_prot;   
263                 vmr->vm_flags = vm_i->vm_flags; 
264                 if (vm_i->vm_file)
265                         kref_get(&vm_i->vm_file->f_kref, 1);
266                 vmr->vm_file = vm_i->vm_file;
267                 vmr->vm_foff = vm_i->vm_foff;
268                 TAILQ_INSERT_TAIL(&new_p->vm_regions, vmr, vm_link);
269         }
270 }
271
272 void print_vmrs(struct proc *p)
273 {
274         int count = 0;
275         struct vm_region *vmr;
276         printk("VM Regions for proc %d\n", p->pid);
277         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link)
278                 printk("%02d: (0x%08x - 0x%08x): %08p, %08p, %08p, %08p\n", count++,
279                        vmr->vm_base, vmr->vm_end, vmr->vm_prot, vmr->vm_flags,
280                        vmr->vm_file, vmr->vm_foff);
281 }
282
283 /* Helper: returns the number of pages required to hold nr_bytes */
284 unsigned long nr_pages(unsigned long nr_bytes)
285 {
286         return (nr_bytes >> PGSHIFT) + (PGOFF(nr_bytes) ? 1 : 0);
287 }
288
289 /* Error values aren't quite comprehensive - check man mmap() once we do better
290  * with the FS.
291  *
292  * The mmap call's offset is in units of PGSIZE (like Linux's mmap2()), but
293  * internally, the offset is tracked in bytes.  The reason for the PGSIZE is for
294  * 32bit apps to enumerate large files, but a full 64bit system won't need that.
295  * We track things internally in bytes since that is how file pointers work, vmr
296  * bases and ends, and similar math.  While it's not a hard change, there's no
297  * need for it, and ideally we'll be a fully 64bit system before we deal with
298  * files that large. */
299 void *mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
300            int fd, size_t offset)
301 {
302         struct file *file = NULL;
303         offset <<= PGSHIFT;
304         printd("mmap(addr %x, len %x, prot %x, flags %x, fd %x, off %x)\n", addr,
305                len, prot, flags, fd, offset);
306         if (fd >= 0 && (flags & MAP_ANON)) {
307                 set_errno(EBADF);
308                 return MAP_FAILED;
309         }
310         if ((addr + len > UMAPTOP) || (PGOFF(addr))) {
311                 set_errno(EINVAL);
312                 return MAP_FAILED;
313         }
314         if (!len) {
315                 set_errno(EINVAL);
316                 return MAP_FAILED;
317         }
318         if (fd != -1) {
319                 file = get_file_from_fd(&p->open_files, fd);
320                 if (!file) {
321                         set_errno(EBADF);
322                         return MAP_FAILED;
323                 }
324         }
325         /* If they don't care where to put it, we'll start looking after the break.
326          * We could just have userspace handle this (in glibc's mmap), so we don't
327          * need to know about BRK_END, but this will work for now (and may avoid
328          * bugs).  Note that this limits mmap(0) a bit.  Keep this in sync with
329          * __do_mmap()'s check.  (Both are necessary).  */
330         if (addr == 0)
331                 addr = BRK_END;
332         /* Still need to enforce this: */
333         addr = MAX(addr, MMAP_LOWEST_VA);
334         void *result = do_mmap(p, addr, len, prot, flags, file, offset);
335         if (file)
336                 kref_put(&file->f_kref);
337         return result;
338 }
339
340 void *do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
341               struct file *file, size_t offset)
342 {
343         spin_lock(&p->mm_lock);
344         void *ret = __do_mmap(p, addr, len, prot, flags, file, offset);
345         spin_unlock(&p->mm_lock);
346         return ret;
347 }
348
349 /* Helper: returns TRUE if the VMR is allowed to access the file with prot.
350  * This is a bit ghetto still: messes with the file mode and assumes it can walk
351  * the dentry/inode paths without locking.  It also ignores the CoW stuff we'll
352  * need to do eventually. */
353 static bool check_file_perms(struct vm_region *vmr, struct file *file, int prot)
354 {
355         assert(file);
356         if (prot & PROT_READ) {
357                 if (check_perms(file->f_dentry->d_inode, S_IRUSR))
358                         goto out_error;
359         }
360         if (prot & PROT_WRITE) {
361                 /* if vmr maps a file as MAP_SHARED, then we need to make sure the
362                  * protection change is in compliance with the open mode of the
363                  * file. */
364                 if (vmr->vm_flags & MAP_SHARED) {
365                         if (!(file->f_mode & S_IWUSR)) {
366                                 /* at this point, we have a file opened in the wrong mode,
367                                  * but we may be allowed to access it still. */
368                                 if (check_perms(file->f_dentry->d_inode, S_IWUSR)) {
369                                         goto out_error;
370                                 } else {
371                                         /* it is okay, though we need to change the file mode. (note
372                                          * the lack of a lock/protection (TODO) */
373                                         file->f_mode |= S_IWUSR;
374                                 }
375                         }
376                 } else {        /* PRIVATE mapping */
377                         /* TODO: we want a CoW mapping (like we want in handle_page_fault()),
378                          * since there is a concern of a process having the page already
379                          * mapped in to a file it does not have permissions to, and then
380                          * mprotecting it so it can access it.  So we can't just change
381                          * the prot, and we don't know yet if a page is mapped in.  To
382                          * handle this, we ought to sort out the CoW bit, and then this
383                          * will be easy.  Til then, just do a permissions check.  If we
384                          * start having weird issues with libc overwriting itself (since
385                          * procs mprotect that W), then change this. */
386                         if (check_perms(file->f_dentry->d_inode, S_IWUSR))
387                                 goto out_error;
388                 }
389         }
390         return TRUE;
391 out_error:      /* for debugging */
392         printk("[kernel] mmap perm check failed for %s for access %d\n",
393                file_name(file), prot);
394         return FALSE;
395 }
396
397 void *__do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
398                 struct file *file, size_t offset)
399 {
400         len = ROUNDUP(len, PGSIZE);
401         int num_pages = len / PGSIZE;
402         int retval;
403
404         struct vm_region *vmr, *vmr_temp;
405
406         /* Sanity check, for callers that bypass mmap().  We want addr for anon
407          * memory to start above the break limit (BRK_END), but not 0.  Keep this in
408          * sync with BRK_END in mmap(). */
409         if (addr == 0)
410                 addr = BRK_END;
411         assert(!PGOFF(offset));
412
413 #ifndef __CONFIG_DEMAND_PAGING__
414         flags |= MAP_POPULATE;
415 #endif
416         /* Need to make sure nothing is in our way when we want a FIXED location.
417          * We just need to split on the end points (if they exist), and then remove
418          * everything in between.  __do_munmap() will do this.  Careful, this means
419          * an mmap can be an implied munmap() (not my call...). */
420         if (flags & MAP_FIXED)
421                 __do_munmap(p, addr, len);
422         vmr = create_vmr(p, addr, len);
423         if (!vmr) {
424                 printk("[kernel] do_mmap() aborted for %08p + %d!\n", addr, len);
425                 set_errno(ENOMEM);
426                 return MAP_FAILED;              /* TODO: error propagation for mmap() */
427         }
428         vmr->vm_prot = prot;
429         vmr->vm_flags = flags;
430         if (file) {
431                 if (!check_file_perms(vmr, file, prot)) {
432                         destroy_vmr(vmr);
433                         set_errno(EACCES);
434                         return MAP_FAILED;
435                 }
436                 /* TODO: consider locking the file while checking (not as manadatory as
437                  * in handle_page_fault() */
438                 if (nr_pages(offset + len) > nr_pages(file->f_dentry->d_inode->i_size)) {
439                         destroy_vmr(vmr);
440                         set_errno(ESPIPE); /* linux sends a SIGBUS at access time */
441                         return MAP_FAILED;
442                 }
443                 kref_get(&file->f_kref, 1);
444         }
445         vmr->vm_file = file;
446         vmr->vm_foff = offset;
447         /* Prep the FS to make sure it can mmap the file.  Slightly weird semantics:
448          * they will have a hole in their VM now. */
449         if (file && file->f_op->mmap(file, vmr)) {
450                 destroy_vmr(vmr);
451                 set_errno(EACCES);      /* not quite */
452                 return MAP_FAILED;
453         }
454         addr = vmr->vm_base;            /* so we know which pages to populate later */
455         vmr = merge_me(vmr);            /* attempts to merge with neighbors */
456         /* Fault in pages now if MAP_POPULATE.  We want to populate the region
457          * requested, but we need to be careful and only populate the requested
458          * length and not any merged regions, which is why we set addr above and use
459          * it here.
460          *
461          * If HPF errors out, we'll warn for now, since it is likely a bug in
462          * userspace, though since POPULATE is an opportunistic thing, we don't need
463          * to actually kill the process. */
464         if (flags & MAP_POPULATE)
465                 for (int i = 0; i < num_pages; i++) {
466                         retval = __handle_page_fault(p, addr + i * PGSIZE, vmr->vm_prot);
467                         if (retval) {
468                                 warn("do_mmap() failing (%d) on addr %08p with prot %p\n",
469                                      retval, addr + i * PGSIZE,  vmr->vm_prot);
470                                 break;
471                         }
472                 }
473         return (void*SAFE)TC(addr);
474 }
475
476 int mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
477 {
478         printd("mprotect: (addr %08p, len %08p, prot %08p)\n", addr, len, prot);
479         if (!len)
480                 return 0;
481         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
482                 set_errno(EINVAL);
483                 return -1;
484         }
485         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
486         if (end > UMAPTOP || addr > end) {
487                 set_errno(ENOMEM);
488                 return -1;
489         }
490         spin_lock(&p->mm_lock);
491         int ret = __do_mprotect(p, addr, len, prot);
492         spin_unlock(&p->mm_lock);
493         return ret;
494 }
495
496 /* This does not care if the region is not mapped.  POSIX says you should return
497  * ENOMEM if any part of it is unmapped.  Can do this later if we care, based on
498  * the VMRs, not the actual page residency. */
499 int __do_mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
500 {
501         struct vm_region *vmr, *next_vmr;
502         pte_t *pte;
503         bool shootdown_needed = FALSE;
504         int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
505                        (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
506         /* TODO: this is aggressively splitting, when we might not need to if the
507          * prots are the same as the previous.  Plus, there are three excessive
508          * scans.  Finally, we might be able to merge when we are done. */
509         isolate_vmrs(p, addr, len);
510         vmr = find_first_vmr(p, addr);
511         while (vmr && vmr->vm_base < addr + len) {
512                 if (vmr->vm_prot == prot)
513                         continue;
514                 if (vmr->vm_file && !check_file_perms(vmr, vmr->vm_file, prot)) {
515                         set_errno(EACCES);
516                         return -1;
517                 }
518                 vmr->vm_prot = prot;
519                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) { 
520                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
521                         if (pte && PAGE_PRESENT(*pte)) {
522                                 *pte = (*pte & ~PTE_PERM) | pte_prot;
523                                 shootdown_needed = TRUE;
524                         }
525                 }
526                 next_vmr = TAILQ_NEXT(vmr, vm_link);
527                 vmr = next_vmr;
528         }
529         if (shootdown_needed)
530                 proc_tlbshootdown(p, addr, addr + len);
531         return 0;
532 }
533
534 int munmap(struct proc *p, uintptr_t addr, size_t len)
535 {
536         printd("munmap(addr %x, len %x)\n", addr, len);
537         if (!len)
538                 return 0;
539         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
540                 set_errno(EINVAL);
541                 return -1;
542         }
543         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
544         if (end > UMAPTOP || addr > end) {
545                 set_errno(EINVAL);
546                 return -1;
547         }
548         spin_lock(&p->mm_lock);
549         int ret = __do_munmap(p, addr, len);
550         spin_unlock(&p->mm_lock);
551         return ret;
552 }
553
554 int __do_munmap(struct proc *p, uintptr_t addr, size_t len)
555 {
556         struct vm_region *vmr, *next_vmr;
557         pte_t *pte;
558         bool shootdown_needed = FALSE;
559
560         /* TODO: this will be a bit slow, since we end up doing three linear
561          * searches (two in isolate, one in find_first). */
562         isolate_vmrs(p, addr, len);
563         vmr = find_first_vmr(p, addr);
564         while (vmr && vmr->vm_base < addr + len) {
565                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) { 
566                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
567                         if (!pte)
568                                 continue;
569                         if (PAGE_PRESENT(*pte)) {
570                                 /* TODO: (TLB) race here, where the page can be given out before
571                                  * the shootdown happened.  Need to put it on a temp list. */
572                                 page_t *page = ppn2page(PTE2PPN(*pte));
573                                 *pte = 0;
574                                 page_decref(page);
575                                 shootdown_needed = TRUE;
576                         } else if (PAGE_PAGED_OUT(*pte)) {
577                                 /* TODO: (SWAP) mark free in the swapfile or whatever.  For now,
578                                  * PAGED_OUT is also being used to mean "hasn't been mapped
579                                  * yet".  Note we now allow PAGE_UNMAPPED, unlike older
580                                  * versions of mmap(). */
581                                 panic("Swapping not supported!");
582                                 *pte = 0;
583                         }
584                 }
585                 next_vmr = TAILQ_NEXT(vmr, vm_link);
586                 destroy_vmr(vmr);
587                 vmr = next_vmr;
588         }
589         if (shootdown_needed)
590                 proc_tlbshootdown(p, addr, addr + len);
591         return 0;
592 }
593
594 int handle_page_fault(struct proc* p, uintptr_t va, int prot)
595 {
596         va = ROUNDDOWN(va,PGSIZE);
597
598         if (prot != PROT_READ && prot != PROT_WRITE && prot != PROT_EXEC)
599                 panic("bad prot!");
600         spin_lock(&p->mm_lock);
601         int ret = __handle_page_fault(p, va, prot);
602         spin_unlock(&p->mm_lock);
603         return ret;
604 }
605
606 /* Returns 0 on success, or an appropriate -error code.  Assumes you hold the
607  * mm_lock.
608  *
609  * Notes: if your TLB caches negative results, you'll need to flush the
610  * appropriate tlb entry.  Also, you could have a weird race where a present PTE
611  * faulted for a different reason (was mprotected on another core), and the
612  * shootdown is on its way.  Userspace should have waited for the mprotect to
613  * return before trying to write (or whatever), so we don't care and will fault
614  * them. */
615 int __handle_page_fault(struct proc *p, uintptr_t va, int prot)
616 {
617         struct vm_region *vmr;
618         struct page *a_page;
619         unsigned int f_idx;     /* index of the missing page in the file */
620         int retval;
621
622         /* Check the vmr's protection */
623         vmr = find_vmr(p, va);
624         if (!vmr)                                                       /* not mapped at all */
625                 return -EFAULT;
626         if (!(vmr->vm_prot & prot))                     /* wrong prots for this vmr */
627                 return -EPERM;
628         /* find offending PTE (prob don't read this in).  This might alloc an
629          * intermediate page table page. */
630         pte_t *pte = pgdir_walk(p->env_pgdir, (void*)va, 1);
631         if (!pte)
632                 return -ENOMEM;
633         /* a spurious, valid PF is possible due to a legit race: the page might have
634          * been faulted in by another core already (and raced on the memory lock),
635          * in which case we should just return. */
636         if (PAGE_PRESENT(*pte)) {
637                 return 0;
638         } else if (PAGE_PAGED_OUT(*pte)) {
639                 /* TODO: (SWAP) bring in the paged out frame. (BLK) */
640                 panic("Swapping not supported!");
641                 return -1;
642         }
643         if (!vmr->vm_file) {
644                 /* No file - just want anonymous memory */
645                 if (upage_alloc(p, &a_page, TRUE))
646                         return -ENOMEM;
647         } else {
648                 /* If this fails, either something got screwed up with the VMR, or the
649                  * permissions changed after mmap/mprotect.  Either way, I want to know
650                  * (though it's not critical). */
651                 if (!check_file_perms(vmr, vmr->vm_file, prot))
652                         printk("[kernel] possible issue with VMR prots on file %s!\n",
653                                file_name(vmr->vm_file));
654                 /* Load the file's page in the page cache.
655                  * TODO: (BLK) Note, we are holding the mem lock!  We need to rewrite
656                  * this stuff so we aren't hold the lock as excessively as we are, and
657                  * such that we can block and resume later. */
658                 assert(!PGOFF(va - vmr->vm_base + vmr->vm_foff));
659                 f_idx = (va - vmr->vm_base + vmr->vm_foff) >> PGSHIFT;
660                 /* TODO: need some sort of lock on the file to deal with someone
661                  * concurrently shrinking it.  Adding 1 to f_idx, since it is
662                  * zero-indexed */
663                 if (f_idx + 1 > nr_pages(vmr->vm_file->f_dentry->d_inode->i_size)) {
664                         /* We're asking for pages that don't exist in the file */
665                         /* TODO: unlock the file */
666                         return -ESPIPE; /* linux sends a SIGBUS at access time */
667                 }
668                 retval = pm_load_page(vmr->vm_file->f_mapping, f_idx, &a_page);
669                 /* TODO: should be able to let go of that file shrink-lock now.  We have
670                  * a page refcnt, which might be enough (depending on how it works) */
671                 if (retval)
672                         return retval;
673                 /* If we want a private map, we'll preemptively give you a new page.  We
674                  * used to just care if it was private and writable, but were running
675                  * into issues with libc changing its mapping (map private, then
676                  * mprotect to writable...)  In the future, we want to CoW this anyway,
677                  * so it's not a big deal. */
678                 if ((vmr->vm_flags & MAP_PRIVATE)) {
679                         struct page *cache_page = a_page;
680                         if (upage_alloc(p, &a_page, FALSE)) {
681                                 page_decref(cache_page);        /* was the original a_page */
682                                 return -ENOMEM;
683                         }
684                         memcpy(page2kva(a_page), page2kva(cache_page), PGSIZE);
685                         page_decref(cache_page);                /* was the original a_page */
686                         /* Debugging */
687                         if (!(vmr->vm_prot & PROT_WRITE))
688                                 printd("[kernel] private, but unwritable file mapping of %s "
689                                        "at va %08p\n", file_name(vmr->vm_file), va);
690                 }
691                 /* if this is an executable page, we might have to flush the instruction
692                  * cache if our HW requires it. */
693                 if (vmr->vm_prot & PROT_EXEC)
694                         icache_flush_page((void*)va, page2kva(a_page));
695         }
696         /* update the page table TODO: careful with MAP_PRIVATE etc.  might do this
697          * separately (file, no file) */
698         int pte_prot = (vmr->vm_prot & PROT_WRITE) ? PTE_USER_RW :
699                        (vmr->vm_prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
700         /* We have a ref to a_page, which we are storing in the PTE */
701         *pte = PTE(page2ppn(a_page), PTE_P | pte_prot);
702         return 0;
703 }
704
705 /* Kernel Dynamic Memory Mappings */
706 uintptr_t dyn_vmap_llim = KERN_DYN_TOP;
707 spinlock_t dyn_vmap_lock = SPINLOCK_INITIALIZER;
708
709 /* Reserve space in the kernel dynamic memory map area */
710 uintptr_t get_vmap_segment(unsigned long num_pages)
711 {
712         uintptr_t retval;
713         spin_lock(&dyn_vmap_lock);
714         retval = dyn_vmap_llim - num_pages * PGSIZE;
715         if ((retval > ULIM) && (retval < KERN_DYN_TOP)) {
716                 dyn_vmap_llim = retval;
717         } else {
718                 warn("[kernel] dynamic mapping failed!");
719                 retval = 0;
720         }
721         spin_unlock(&dyn_vmap_lock);
722         return retval;
723 }
724
725 /* Give up your space.  Note this isn't supported yet */
726 uintptr_t put_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
727 {
728         /* TODO: use vmem regions for adjustable vmap segments */
729         panic("Unsupported.\n");
730 }
731
732 /* Map a virtual address chunk to physical addresses.  Make sure you got a vmap
733  * segment before actually trying to do the mapping.
734  *
735  * Careful with more than one 'page', since it will assume your physical pages
736  * are also contiguous.  Most callers will only use one page.
737  *
738  * Finally, note that this does not care whether or not there are real pages
739  * being mapped, and will not attempt to incref your page (if there is such a
740  * thing).  Handle your own refcnting for pages. */
741 int map_vmap_segment(uintptr_t vaddr, uintptr_t paddr, unsigned long num_pages,
742                      int perm)
743 {
744         /* For now, we only handle the root pgdir, and not any of the other ones
745          * (like for processes).  To do so, we'll need to insert into every pgdir,
746          * and send tlb shootdowns to those that are active (which we don't track
747          * yet). */
748         extern int booting;
749         assert(booting);
750
751         /* TODO: (MM) you should lock on boot pgdir modifications.  A vm region lock
752          * isn't enough, since there might be a race on outer levels of page tables.
753          * For now, we'll just use the dyn_vmap_lock (which technically works). */
754         spin_lock(&dyn_vmap_lock);
755         pte_t *pte;
756 #ifdef __i386__
757         perm |= PTE_G;
758 #endif
759         for (int i = 0; i < num_pages; i++) {
760                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
761                 if (!pte) {
762                         spin_unlock(&dyn_vmap_lock);
763                         return -ENOMEM;
764                 }
765                 /* You probably should have unmapped first */
766                 if (*pte)
767                         warn("Existing PTE value %08p\n", *pte);
768                 *pte = PTE(pa2ppn(paddr + i * PGSIZE), perm);
769         }
770         spin_unlock(&dyn_vmap_lock);
771         return 0;
772 }
773
774 /* Unmaps / 0's the PTEs of a chunk of vaddr space */
775 int unmap_vmap_segment(uintptr_t vaddr, unsigned long num_pages)
776 {
777         /* Not a big deal - won't need this til we do something with kthreads */
778         panic("Incomplete, don't call this yet.");
779         spin_lock(&dyn_vmap_lock);
780         /* TODO: For all pgdirs */
781         pte_t *pte;
782         for (int i = 0; i < num_pages; i++) {
783                 pte = pgdir_walk(boot_pgdir, (void*)(vaddr + i * PGSIZE), 1);
784                 *pte = 0;
785         }
786         /* TODO: TLB shootdown.  Also note that the global flag is set on the PTE
787          * (for x86 for now), which requires a global shootdown.  bigger issue is
788          * the TLB shootdowns for multiple pgdirs.  We'll need to remove from every
789          * pgdir, and send tlb shootdowns to those that are active (which we don't
790          * track yet). */
791         spin_unlock(&dyn_vmap_lock);
792         return 0;
793 }