mmap() merges, fixed 0-page allocation bug
[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 (proc_lock
11  * for now) is already held begin with __ (e.g. __do_munmap()).  */
12
13 #include <frontend.h>
14 #include <ros/common.h>
15 #include <ros/mman.h>
16 #include <pmap.h>
17 #include <mm.h>
18 #include <process.h>
19 #include <stdio.h>
20 #include <syscall.h>
21 #include <slab.h>
22 #include <kmalloc.h>
23 #include <vfs.h>
24
25 struct kmem_cache *vmr_kcache;
26
27 void vmr_init(void)
28 {
29         vmr_kcache = kmem_cache_create("vm_regions", sizeof(struct vm_region),
30                                        __alignof__(struct dentry), 0, 0, 0);
31 }
32
33 /* For now, the caller will set the prot, flags, file, and offset.  In the
34  * future, we may put those in here, to do clever things with merging vm_regions
35  * that are the same.
36  *
37  * TODO: take a look at solari's vmem alloc.  And consider keeping these in a
38  * tree of some sort for easier lookups. */
39 struct vm_region *create_vmr(struct proc *p, uintptr_t va, size_t len)
40 {
41         struct vm_region *vmr = 0, *vm_i, *vm_next;
42         uintptr_t gap_end;
43
44         assert(!PGOFF(va));
45         assert(!PGOFF(len));
46         assert(va + len <= UMAPTOP);
47
48         /* Is there room before the first one: */
49         vm_i = TAILQ_FIRST(&p->vm_regions);
50         if (!vm_i || (va + len < vm_i->vm_base)) {
51                 vmr = kmem_cache_alloc(vmr_kcache, 0);
52                 if (!vmr)
53                         panic("EOM!");
54                 vmr->vm_base = va;
55                 TAILQ_INSERT_HEAD(&p->vm_regions, vmr, vm_link);
56         } else {
57                 TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
58                         vm_next = TAILQ_NEXT(vm_i, vm_link);
59                         gap_end = vm_next ? vm_next->vm_base : UMAPTOP;
60                         /* skip til we get past the 'hint' va */
61                         if (va >= gap_end)
62                                 continue;
63                         /* Find a gap that is big enough */
64                         if (gap_end - vm_i->vm_end >= len) {
65                                 vmr = kmem_cache_alloc(vmr_kcache, 0);
66                                 /* if we can put it at va, let's do that.  o/w, put it so it
67                                  * fits */
68                                 if ((gap_end >= va + len) && (va >= vm_i->vm_end))
69                                         vmr->vm_base = va;
70                                 else
71                                         vmr->vm_base = vm_i->vm_end;
72                                 TAILQ_INSERT_AFTER(&p->vm_regions, vm_i, vmr, vm_link);
73                                 break;
74                         }
75                 }
76         }
77         /* Finalize the creation, if we got one */
78         if (vmr) {
79                 vmr->vm_proc = p;
80                 vmr->vm_end = vmr->vm_base + len;
81         }
82         if (!vmr)
83                 warn("Not making a VMR, wanted %08p, + %p = %p", va, len, va + len);
84         return vmr;
85 }
86
87 /* Split a VMR at va, returning the new VMR.  It is set up the same way, with
88  * file offsets fixed accordingly.  'va' is the beginning of the new one, and
89  * must be page aligned. */
90 struct vm_region *split_vmr(struct vm_region *old_vmr, uintptr_t va)
91 {
92         struct vm_region *new_vmr;
93
94         assert(!PGOFF(va));
95         if ((old_vmr->vm_base >= va) || (old_vmr->vm_end <= va))
96                 return 0;
97         new_vmr = kmem_cache_alloc(vmr_kcache, 0);
98         TAILQ_INSERT_AFTER(&old_vmr->vm_proc->vm_regions, old_vmr, new_vmr,
99                            vm_link);
100         new_vmr->vm_proc = old_vmr->vm_proc;
101         new_vmr->vm_base = va;
102         new_vmr->vm_end = old_vmr->vm_end;
103         old_vmr->vm_end = va;
104         new_vmr->vm_prot = old_vmr->vm_prot;
105         new_vmr->vm_flags = old_vmr->vm_flags;
106         if (old_vmr->vm_file) {
107                 new_vmr->vm_file = old_vmr->vm_file;
108                 atomic_inc(&new_vmr->vm_file->f_refcnt);
109                 new_vmr->vm_foff = old_vmr->vm_foff +
110                                       old_vmr->vm_end - old_vmr->vm_base;
111         } else {
112                 new_vmr->vm_file = 0;
113                 new_vmr->vm_foff = 0;
114         }
115         return new_vmr;
116 }
117
118 /* Merges two vm regions.  For now, it will check to make sure they are the
119  * same.  The second one will be destroyed. */
120 int merge_vmr(struct vm_region *first, struct vm_region *second)
121 {
122         assert(first->vm_proc == second->vm_proc);
123         if ((first->vm_end != second->vm_base) ||
124             (first->vm_prot != second->vm_prot) ||
125             (first->vm_flags != second->vm_flags) ||
126             (first->vm_file != second->vm_file))
127                 return -1;
128         if ((first->vm_file) && (second->vm_foff != first->vm_foff +
129                                  first->vm_end - first->vm_base))
130                 return -1;
131         first->vm_end = second->vm_end;
132         destroy_vmr(second);
133         return 0;
134 }
135
136 /* Attempts to merge vmr with adjacent VMRs, returning a ptr to be used for vmr.
137  * It could be the same struct vmr, or possibly another one (usually lower in
138  * the address space. */
139 struct vm_region *merge_me(struct vm_region *vmr)
140 {
141         struct vm_region *vmr_temp;
142         /* Merge will fail if it cannot do it.  If it succeeds, the second VMR is
143          * destroyed, so we need to be a bit careful. */
144         vmr_temp = TAILQ_PREV(vmr, vmr_tailq, vm_link);
145         if (vmr_temp)
146                 if (!merge_vmr(vmr_temp, vmr))
147                         vmr = vmr_temp;
148         vmr_temp = TAILQ_NEXT(vmr, vm_link);
149         if (vmr_temp)
150                 merge_vmr(vmr, vmr_temp);
151         return vmr;
152 }
153
154 /* Grows the vm region up to (and not including) va.  Fails if another is in the
155  * way, etc. */
156 int grow_vmr(struct vm_region *vmr, uintptr_t va)
157 {
158         assert(!PGOFF(va));
159         struct vm_region *next = TAILQ_NEXT(vmr, vm_link);
160         if (next && next->vm_base < va)
161                 return -1;
162         if (va <= vmr->vm_end)
163                 return -1;
164         vmr->vm_end = va;
165         return 0;
166 }
167
168 /* Shrinks the vm region down to (and not including) va.  Whoever calls this
169  * will need to sort out the page table entries. */
170 int shrink_vmr(struct vm_region *vmr, uintptr_t va)
171 {
172         assert(!PGOFF(va));
173         if ((va < vmr->vm_base) || (va > vmr->vm_end))
174                 return -1;
175         vmr->vm_end = va;
176         return 0;
177 }
178
179 /* Called by the unmapper, just cleans up.  Whoever calls this will need to sort
180  * out the page table entries. */
181 void destroy_vmr(struct vm_region *vmr)
182 {
183         if (vmr->vm_file)
184                 atomic_dec(&vmr->vm_file->f_refcnt);
185         TAILQ_REMOVE(&vmr->vm_proc->vm_regions, vmr, vm_link);
186         kmem_cache_free(vmr_kcache, vmr);
187 }
188
189 /* Given a va and a proc (later an mm, possibly), returns the owning vmr, or 0
190  * if there is none. */
191 struct vm_region *find_vmr(struct proc *p, uintptr_t va)
192 {
193         struct vm_region *vmr;
194         /* ugly linear seach */
195         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
196                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
197                         return vmr;
198         }
199         return 0;
200 }
201
202 /* Finds the first vmr after va (including the one holding va), or 0 if there is
203  * none. */
204 struct vm_region *find_first_vmr(struct proc *p, uintptr_t va)
205 {
206         struct vm_region *vmr;
207         /* ugly linear seach */
208         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link) {
209                 if ((vmr->vm_base <= va) && (vmr->vm_end > va))
210                         return vmr;
211                 if (vmr->vm_base > va)
212                         return vmr;
213         }
214         return 0;
215 }
216
217 /* Makes sure that no VMRs cross either the start or end of the given region
218  * [va, va + len), splitting any VMRs that are on the endpoints. */
219 void isolate_vmrs(struct proc *p, uintptr_t va, size_t len)
220 {
221         struct vm_region *vmr;
222         if ((vmr = find_vmr(p, va)))
223                 split_vmr(vmr, va);
224         /* TODO: don't want to do another find (linear search) */
225         if ((vmr = find_vmr(p, va + len)))
226                 split_vmr(vmr, va + len);
227 }
228
229 /* This will make new_p have the same VMRs as p, though it does nothing to
230  * ensure the physical pages or whatever are shared/mapped/copied/whatever.
231  * This is used by fork().
232  *
233  * Note that if you are working on a VMR that is a file, you'll want to be
234  * careful about how it is mapped (SHARED, PRIVATE, etc). */
235 void duplicate_vmrs(struct proc *p, struct proc *new_p)
236 {
237         struct vm_region *vmr, *vm_i;
238         TAILQ_FOREACH(vm_i, &p->vm_regions, vm_link) {
239                 vmr = kmem_cache_alloc(vmr_kcache, 0);
240                 if (!vmr)
241                         panic("EOM!");
242                 vmr->vm_proc = new_p;
243                 vmr->vm_base = vm_i->vm_base;
244                 vmr->vm_end = vm_i->vm_end;
245                 vmr->vm_prot = vm_i->vm_prot;   
246                 vmr->vm_flags = vm_i->vm_flags; 
247                 vmr->vm_file = vm_i->vm_file;
248                 if (vmr->vm_file)
249                         atomic_inc(&vmr->vm_file->f_refcnt);
250                 vmr->vm_foff = vm_i->vm_foff;
251                 TAILQ_INSERT_TAIL(&new_p->vm_regions, vmr, vm_link);
252         }
253 }
254
255 void print_vmrs(struct proc *p)
256 {
257         int count = 0;
258         struct vm_region *vmr;
259         printk("VM Regions for proc %d\n", p->pid);
260         TAILQ_FOREACH(vmr, &p->vm_regions, vm_link)
261                 printk("%02d: (0x%08x - 0x%08x): %08p, %08p, %08p\n", count++,
262                        vmr->vm_base, vmr->vm_end, vmr->vm_prot, vmr->vm_flags,
263                        vmr->vm_file);
264 }
265
266
267 void *mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
268            int fd, size_t offset)
269 {
270         struct file *file = NULL;
271         printd("mmap(addr %x, len %x, prot %x, flags %x, fd %x, off %x)\n", addr,
272                len, prot, flags, fd, offset);
273         if (fd >= 0 && (flags & MAP_SHARED)) {
274                 printk("[kernel] mmap() for files requires !MAP_SHARED.\n");
275                 return MAP_FAILED;
276         }
277         if (fd >= 0 && (flags & MAP_ANON)) {
278                 printk("[kernel] mmap() with MAP_ANONYMOUS requires fd == -1.\n");
279                 return MAP_FAILED;
280         }
281         if ((flags & MAP_FIXED) && PGOFF(addr)) {
282                 printk("[kernel] mmap() page align your addr.\n");
283                 return MAP_FAILED;
284         }
285         if (!len)
286                 return 0;
287         if (addr + len > UMAPTOP) {
288                 printk("[kernel] mmap() tried to map above UMAPTOP.\n");
289                 return MAP_FAILED;
290         }
291         if (fd != -1) {
292                 file = file_open_from_fd(p, fd);
293                 if (!file)
294                         return MAP_FAILED;
295         }
296         addr = MAX(addr, MMAP_LOWEST_VA);
297         void *result = do_mmap(p, addr, len, prot, flags, file, offset);
298         if (file)
299                 file_decref(file);
300         return result;
301 }
302
303 void *do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
304               struct file *file, size_t offset)
305 {
306         // TODO: grab the appropriate mm_lock
307         spin_lock(&p->proc_lock);
308         void *ret = __do_mmap(p, addr, len, prot, flags, file, offset);
309         spin_unlock(&p->proc_lock);
310         return ret;
311 }
312
313 void *__do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
314                 struct file *file, size_t offset)
315 {
316         len = ROUNDUP(len, PGSIZE);
317         int num_pages = len / PGSIZE;
318
319         struct vm_region *vmr, *vmr_temp;
320
321 #ifndef __CONFIG_DEMAND_PAGING__
322         flags |= MAP_POPULATE;
323 #endif
324         /* Need to make sure nothing is in our way when we want a FIXED location.
325          * We just need to split on the end points (if they exist), and then remove
326          * everything in between.  __do_munmap() will do this. */
327         if (flags & MAP_FIXED)
328                 __do_munmap(p, addr, len);
329         vmr = create_vmr(p, addr, len);
330         if (!vmr) {
331                 printk("[kernel] do_mmap() aborted for %08p + %d!\n", addr, len);
332                 return MAP_FAILED;              /* TODO: error propagation for mmap() */
333         }
334         vmr->vm_prot = prot;
335         vmr->vm_flags = flags;
336         vmr->vm_file = file;
337         vmr->vm_foff = offset;
338         addr = vmr->vm_base;            /* so we know which pages to populate later */
339         vmr = merge_me(vmr);            /* attempts to merge with neighbors */
340         /* Fault in pages now if MAP_POPULATE - die on failure.  We want to populate
341          * the region requested, but we need to be careful and only populate the
342          * requested length and not any merged regions, which is why we set addr
343          * above and use it here. */
344         if (flags & MAP_POPULATE)
345                 for (int i = 0; i < num_pages; i++)
346                         if (__handle_page_fault(p, addr + i*PGSIZE, vmr->vm_prot)) {
347                                 spin_unlock(&p->proc_lock);
348                                 proc_destroy(p);
349                         }
350         return (void*SAFE)TC(addr);
351 }
352
353 int mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
354 {
355         printd("mprotect(addr %x, len %x, prot %x)\n", addr, len, prot);
356         if (!len)
357                 return 0;
358         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
359                 set_errno(current_tf, EINVAL);
360                 return -1;
361         }
362         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
363         if (end > UMAPTOP || addr > end) {
364                 set_errno(current_tf, ENOMEM);
365                 return -1;
366         }
367         spin_lock(&p->proc_lock);
368         int ret = __do_mprotect(p, addr, len, prot);
369         spin_unlock(&p->proc_lock);
370         return ret;
371 }
372
373 /* This does not care if the region is not mapped.  POSIX says you should return
374  * ENOMEM if any part of it is unmapped.  Can do this later if we care, based on
375  * the VMRs, not the actual page residency. */
376 int __do_mprotect(struct proc *p, uintptr_t addr, size_t len, int prot)
377 {
378         struct vm_region *vmr, *next_vmr;
379         pte_t *pte;
380         bool shootdown_needed = FALSE;
381         int pte_prot = (prot & PROT_WRITE) ? PTE_USER_RW :
382                        (prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
383         /* TODO: this is aggressively splitting, when we might not need to if the
384          * prots are the same as the previous.  Plus, there are three excessive
385          * scans.  Finally, we might be able to merge when we are done. */
386         isolate_vmrs(p, addr, addr + len);
387         vmr = find_first_vmr(p, addr);
388         while (vmr && vmr->vm_base < addr + len) {
389                 if (vmr->vm_prot == prot)
390                         continue;
391                 /* if vmr maps a file, then we need to make sure the protection change
392                  * is in compliance with the open mode of the file.  At least for any
393                  * mapping that is write-backed to a file.  For now, we just do it for
394                  * all file mappings.  And this hasn't been tested */
395                 if (vmr->vm_file && (prot & PROT_WRITE)) {
396                         if (!(vmr->vm_file->f_mode & PROT_WRITE)) {
397                                 set_errno(current_tf, EACCES);
398                                 return -1;
399                         }
400                 }
401                 vmr->vm_prot = prot;
402                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) { 
403                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
404                         if (pte && PAGE_PRESENT(*pte)) {
405                                 *pte = (*pte & ~PTE_PERM) | pte_prot;
406                                 shootdown_needed = TRUE;
407                         }
408                 }
409                 next_vmr = TAILQ_NEXT(vmr, vm_link);
410                 vmr = next_vmr;
411         }
412         if (shootdown_needed)
413                 __proc_tlbshootdown(p, addr, addr + len);
414         return 0;
415 }
416
417 int munmap(struct proc *p, uintptr_t addr, size_t len)
418 {
419         printd("munmap(addr %x, len %x, prot %x)\n", addr, len, prot);
420         if (!len)
421                 return 0;
422         if ((addr % PGSIZE) || (addr < MMAP_LOWEST_VA)) {
423                 set_errno(current_tf, EINVAL);
424                 return -1;
425         }
426         uintptr_t end = ROUNDUP(addr + len, PGSIZE);
427         if (end > UMAPTOP || addr > end) {
428                 set_errno(current_tf, EINVAL);
429                 return -1;
430         }
431         spin_lock(&p->proc_lock);
432         int ret = __do_munmap(p, addr, len);
433         spin_unlock(&p->proc_lock);
434         return ret;
435 }
436
437 int __do_munmap(struct proc *p, uintptr_t addr, size_t len)
438 {
439         struct vm_region *vmr, *next_vmr;
440         pte_t *pte;
441         bool shootdown_needed = FALSE;
442
443         /* TODO: this will be a bit slow, since we end up doing three linear
444          * searches (two in isolate, one in find_first). */
445         isolate_vmrs(p, addr, addr + len);
446         vmr = find_first_vmr(p, addr);
447         while (vmr && vmr->vm_base < addr + len) {
448                 for (uintptr_t va = vmr->vm_base; va < vmr->vm_end; va += PGSIZE) { 
449                         pte = pgdir_walk(p->env_pgdir, (void*)va, 0);
450                         if (!pte)
451                                 continue;
452                         if (PAGE_PRESENT(*pte)) {
453                                 /* TODO: (TLB) race here, where the page can be given out before
454                                  * the shootdown happened.  Need to put it on a temp list. */
455                                 page_t *page = ppn2page(PTE2PPN(*pte));
456                                 *pte = 0;
457                                 page_decref(page);
458                                 shootdown_needed = TRUE;
459                         } else if (PAGE_PAGED_OUT(*pte)) {
460                                 /* TODO: (SWAP) mark free in the swapfile or whatever.  For now,
461                                  * PAGED_OUT is also being used to mean "hasn't been mapped
462                                  * yet".  Note we now allow PAGE_UNMAPPED, unlike older
463                                  * versions of mmap(). */
464                                 panic("Swapping not supported!");
465                                 *pte = 0;
466                         }
467                 }
468                 next_vmr = TAILQ_NEXT(vmr, vm_link);
469                 destroy_vmr(vmr);
470                 vmr = next_vmr;
471         }
472         if (shootdown_needed)
473                 __proc_tlbshootdown(p, addr, addr + len);
474         return 0;
475 }
476
477 int handle_page_fault(struct proc* p, uintptr_t va, int prot)
478 {
479         va = ROUNDDOWN(va,PGSIZE);
480
481         if (prot != PROT_READ && prot != PROT_WRITE && prot != PROT_EXEC)
482                 panic("bad prot!");
483
484         spin_lock(&p->proc_lock);
485         int ret = __handle_page_fault(p, va, prot);
486         spin_unlock(&p->proc_lock);
487         return ret;
488 }
489
490 /* Returns 0 on success, or an appropriate -error code.  Assumes you hold the
491  * appropriate lock.
492  *
493  * Notes: if your TLB caches negative results, you'll need to flush the
494  * appropriate tlb entry.  Also, you could have a weird race where a present PTE
495  * faulted for a different reason (was mprotected on another core), and the
496  * shootdown is on its way.  Userspace should have waited for the mprotect to
497  * return before trying to write (or whatever), so we don't care and will fault
498  * them.
499  *
500  * We did away with mmapping too much of a file, and will map an entire page, if
501  * that file is big enough.  The alternative is to zerofill the last bit if the
502  * vmr had a lesser length.  This makes shared mappings and mappings backed by
503  * the FS problematic. */
504 int __handle_page_fault(struct proc* p, uintptr_t va, int prot)
505 {
506         struct vm_region *vmr;
507         /* Check the vmr's protection */
508         vmr = find_vmr(p, va);
509         if (!vmr)                                                       /* not mapped at all */
510                 return -EFAULT;
511         if (!(vmr->vm_prot & prot))                     /* wrong prots for this vmr */
512                 return -EFAULT;
513         /* find offending PTE (prob don't read this in).  This might alloc an
514          * intermediate page table page. */
515         pte_t *pte = pgdir_walk(p->env_pgdir, (void*)va, 1);
516         if (!pte)
517                 return -ENOMEM;
518         /* a spurious, valid PF is possible due to a legit race: the page might have
519          * been faulted in by another core already (and raced on the memory lock),
520          * in which case we should just return. */
521         if (PAGE_PRESENT(*pte)) {
522                 return 0;
523         } else if (PAGE_PAGED_OUT(*pte)) {
524                 /* TODO: (SWAP) bring in the paged out frame. (BLK) */
525                 panic("Swapping not supported!");
526                 return 0;
527         }
528         /* allocate a page; maybe zero-fill it */
529         bool zerofill = (vmr->vm_file == NULL);
530         page_t *a_page;
531         if (upage_alloc(p, &a_page, zerofill))
532                 return -ENOMEM;
533         /* if this isn't a zero-filled page, read it in from file.  it is the FS's
534          * responsibility to zero out the end of the last page if the EOF is not at
535          * the end of the page.
536          *
537          * TODO: (BLK) doing this while holding the mem lock!  prob want to block
538          * and return to userspace if it's not in the buffer cache.  will want to
539          * set a flag in the vmr so that subsequent faults will know the work is in
540          * progress. */
541         if (!zerofill) {
542                 int foffset = ROUNDDOWN(va, PGSIZE) - vmr->vm_base + vmr->vm_foff;
543                 int read_len = file_read_page(vmr->vm_file, page2pa(a_page), foffset);
544                 if (read_len < 0) {
545                         page_free(a_page);
546                         return read_len;                        /* pass out the error code, for now */
547                 }
548                 /* if this is an executable page, we might have to flush the instruction
549                  * cache if our HW requires it. */
550                 if (vmr->vm_prot & PROT_EXEC)
551                         icache_flush_page((void*)va, page2kva(a_page));
552         }
553         /* update the page table */
554         int pte_prot = (vmr->vm_prot & PROT_WRITE) ? PTE_USER_RW :
555                        (vmr->vm_prot & (PROT_READ|PROT_EXEC)) ? PTE_USER_RO : 0;
556         page_incref(a_page);
557         *pte = PTE(page2ppn(a_page), PTE_P | pte_prot);
558         return 0;
559 }