vfs: Remove the last references to struct file *
[akaros.git] / kern / include / mm.h
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  * Memory management for processes: syscall related functions, virtual memory
6  * regions, etc. */
7
8 #pragma once
9
10 #include <ros/common.h>
11 #include <ros/mman.h>
12 #include <atomic.h>
13 #include <sys/queue.h>
14 #include <slab.h>
15 #include <kref.h>
16
17 struct chan;
18 struct fd_table;
19 struct proc;                                                            /* preprocessor games */
20
21 #define F_OR_C_CHAN 2
22
23 struct file_or_chan {
24         int type;
25         struct chan *chan;
26         struct fs_file *fsf;    /* weak ref, set during mmap. */
27         struct kref kref;
28 };
29
30 char *foc_to_name(struct file_or_chan *foc);
31 char *foc_abs_path(struct file_or_chan *foc, char *path, size_t max_size);
32 ssize_t foc_read(struct file_or_chan *foc, void *buf, size_t amt, off64_t off);
33 struct file_or_chan *foc_open(char *path, int omode, int perm);
34 struct file_or_chan *fd_to_foc(struct fd_table *fdt, int fd);
35 void foc_incref(struct file_or_chan *foc);
36 void foc_decref(struct file_or_chan *foc);
37 void *foc_pointer(struct file_or_chan *foc);
38 size_t foc_get_len(struct file_or_chan *foc);
39
40 /* Basic structure defining a region of a process's virtual memory.  Note we
41  * don't refcnt these.  Either they are in the TAILQ/tree, or they should be
42  * freed.  There should be no other references floating around.  We still need
43  * to sort out how we share memory and how we'll do private memory with these
44  * VMRs. */
45 struct vm_region {
46         TAILQ_ENTRY(vm_region)          vm_link;
47         TAILQ_ENTRY(vm_region)          vm_pm_link;
48         struct proc                                     *vm_proc;       /* owning process, for now */
49         uintptr_t                                       vm_base;
50         uintptr_t                                       vm_end;
51         int                                                     vm_prot;
52         int                                                     vm_flags;
53         struct file_or_chan                     *__vm_foc;
54         size_t                                          vm_foff;
55         bool                                            vm_ready;       /* racy, for the PM checks */
56 };
57 TAILQ_HEAD(vmr_tailq, vm_region);                       /* Declares 'struct vmr_tailq' */
58
59 static inline bool vmr_has_file(struct vm_region *vmr)
60 {
61         return vmr->__vm_foc ? true : false;
62 }
63
64 static inline char *vmr_to_filename(struct vm_region *vmr)
65 {
66         assert(vmr_has_file(vmr));
67         return foc_to_name(vmr->__vm_foc);
68 }
69
70 void vmr_init(void);
71 void unmap_and_destroy_vmrs(struct proc *p);
72 int duplicate_vmrs(struct proc *p, struct proc *new_p);
73 void print_vmrs(struct proc *p);
74 void enumerate_vmrs(struct proc *p,
75                                         void (*func)(struct vm_region *vmr, void *opaque),
76                                         void *opaque);
77
78 /* mmap() related functions.  These manipulate VMRs and change the hardware page
79  * tables.  Any requests below the LOWEST_VA will silently be upped.  This may
80  * be a dynamic proc-specific variable later. */
81 #define MMAP_LOWEST_VA PAGE_SIZE
82 #define MMAP_LD_FIXED_VA 0x100000
83 void *mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
84            int fd, size_t offset);
85 void *do_mmap(struct proc *p, uintptr_t addr, size_t len, int prot, int flags,
86               struct file_or_chan *foc, size_t offset);
87 int mprotect(struct proc *p, uintptr_t addr, size_t len, int prot);
88 int munmap(struct proc *p, uintptr_t addr, size_t len);
89 int handle_page_fault(struct proc *p, uintptr_t va, int prot);
90 int handle_page_fault_nofile(struct proc *p, uintptr_t va, int prot);
91 unsigned long populate_va(struct proc *p, uintptr_t va, unsigned long nr_pgs);
92
93 /* These assume the mm_lock is held already */
94 int __do_mprotect(struct proc *p, uintptr_t addr, size_t len, int prot);
95 int __do_munmap(struct proc *p, uintptr_t addr, size_t len);
96
97 /* Kernel Dynamic Memory Mappings */
98 struct arena *vmap_arena;
99 void vmap_init(void);
100 /* Gets PML1 page-aligned virtual addresses for the kernel's dynamic vmap.
101  * You'll need to map it to something.  When you're done, 'put-' will also unmap
102  * the vaddr for you. */
103 uintptr_t get_vmap_segment(size_t nr_bytes);
104 void put_vmap_segment(uintptr_t vaddr, size_t nr_bytes);
105 int map_vmap_segment(uintptr_t vaddr, uintptr_t paddr, unsigned long num_pages,
106                      int perm);
107 /* Helper wrappers for getting and mapping a specific paddr. */
108 uintptr_t vmap_pmem(uintptr_t paddr, size_t nr_bytes);
109 uintptr_t vmap_pmem_nocache(uintptr_t paddr, size_t nr_bytes);
110 uintptr_t vmap_pmem_writecomb(uintptr_t paddr, size_t nr_bytes);
111 int vunmap_vmem(uintptr_t vaddr, size_t nr_bytes);