Rev 3386 | Go to most recent revision | Only display areas with differences | Regard whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 3386 | Rev 4581 | ||
---|---|---|---|
1 | /* |
1 | /* |
2 | * Copyright (c) 2001-2004 Jakub Jermar |
2 | * Copyright (c) 2001-2004 Jakub Jermar |
3 | * All rights reserved. |
3 | * All rights reserved. |
4 | * |
4 | * |
5 | * Redistribution and use in source and binary forms, with or without |
5 | * Redistribution and use in source and binary forms, with or without |
6 | * modification, are permitted provided that the following conditions |
6 | * modification, are permitted provided that the following conditions |
7 | * are met: |
7 | * are met: |
8 | * |
8 | * |
9 | * - Redistributions of source code must retain the above copyright |
9 | * - Redistributions of source code must retain the above copyright |
10 | * notice, this list of conditions and the following disclaimer. |
10 | * notice, this list of conditions and the following disclaimer. |
11 | * - Redistributions in binary form must reproduce the above copyright |
11 | * - Redistributions in binary form must reproduce the above copyright |
12 | * notice, this list of conditions and the following disclaimer in the |
12 | * notice, this list of conditions and the following disclaimer in the |
13 | * documentation and/or other materials provided with the distribution. |
13 | * documentation and/or other materials provided with the distribution. |
14 | * - The name of the author may not be used to endorse or promote products |
14 | * - The name of the author may not be used to endorse or promote products |
15 | * derived from this software without specific prior written permission. |
15 | * derived from this software without specific prior written permission. |
16 | * |
16 | * |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
27 | */ |
27 | */ |
28 | 28 | ||
29 | /** @addtogroup genericmm |
29 | /** @addtogroup genericmm |
30 | * @{ |
30 | * @{ |
31 | */ |
31 | */ |
32 | /** @file |
32 | /** @file |
33 | */ |
33 | */ |
34 | 34 | ||
35 | #ifndef KERN_AS_H_ |
35 | #ifndef KERN_AS_H_ |
36 | #define KERN_AS_H_ |
36 | #define KERN_AS_H_ |
37 | 37 | ||
38 | /** Address space area flags. */ |
38 | /** Address space area flags. */ |
39 | #define AS_AREA_READ 1 |
39 | #define AS_AREA_READ 1 |
40 | #define AS_AREA_WRITE 2 |
40 | #define AS_AREA_WRITE 2 |
41 | #define AS_AREA_EXEC 4 |
41 | #define AS_AREA_EXEC 4 |
42 | #define AS_AREA_CACHEABLE 8 |
42 | #define AS_AREA_CACHEABLE 8 |
43 | 43 | ||
44 | #ifdef KERNEL |
44 | #ifdef KERNEL |
45 | 45 | ||
46 | #include <arch/mm/page.h> |
46 | #include <arch/mm/page.h> |
47 | #include <arch/mm/as.h> |
47 | #include <arch/mm/as.h> |
48 | #include <arch/mm/asid.h> |
48 | #include <arch/mm/asid.h> |
49 | #include <arch/types.h> |
49 | #include <arch/types.h> |
50 | #include <synch/spinlock.h> |
50 | #include <synch/spinlock.h> |
51 | #include <synch/mutex.h> |
51 | #include <synch/mutex.h> |
52 | #include <adt/list.h> |
52 | #include <adt/list.h> |
53 | #include <adt/btree.h> |
53 | #include <adt/btree.h> |
54 | #include <lib/elf.h> |
54 | #include <lib/elf.h> |
55 | 55 | ||
56 | /** |
56 | /** |
57 | * Defined to be true if user address space and kernel address space shadow each |
57 | * Defined to be true if user address space and kernel address space shadow each |
58 | * other. |
58 | * other. |
59 | */ |
59 | */ |
60 | #define KERNEL_ADDRESS_SPACE_SHADOWED KERNEL_ADDRESS_SPACE_SHADOWED_ARCH |
60 | #define KERNEL_ADDRESS_SPACE_SHADOWED KERNEL_ADDRESS_SPACE_SHADOWED_ARCH |
61 | 61 | ||
62 | #define KERNEL_ADDRESS_SPACE_START KERNEL_ADDRESS_SPACE_START_ARCH |
62 | #define KERNEL_ADDRESS_SPACE_START KERNEL_ADDRESS_SPACE_START_ARCH |
63 | #define KERNEL_ADDRESS_SPACE_END KERNEL_ADDRESS_SPACE_END_ARCH |
63 | #define KERNEL_ADDRESS_SPACE_END KERNEL_ADDRESS_SPACE_END_ARCH |
64 | #define USER_ADDRESS_SPACE_START USER_ADDRESS_SPACE_START_ARCH |
64 | #define USER_ADDRESS_SPACE_START USER_ADDRESS_SPACE_START_ARCH |
65 | #define USER_ADDRESS_SPACE_END USER_ADDRESS_SPACE_END_ARCH |
65 | #define USER_ADDRESS_SPACE_END USER_ADDRESS_SPACE_END_ARCH |
66 | 66 | ||
67 | #define USTACK_ADDRESS USTACK_ADDRESS_ARCH |
67 | #define USTACK_ADDRESS USTACK_ADDRESS_ARCH |
68 | 68 | ||
69 | /** Kernel address space. */ |
69 | /** Kernel address space. */ |
70 | #define FLAG_AS_KERNEL (1 << 0) |
70 | #define FLAG_AS_KERNEL (1 << 0) |
71 | 71 | ||
72 | /* Address space area attributes. */ |
72 | /* Address space area attributes. */ |
73 | #define AS_AREA_ATTR_NONE 0 |
73 | #define AS_AREA_ATTR_NONE 0 |
74 | #define AS_AREA_ATTR_PARTIAL 1 /**< Not fully initialized area. */ |
74 | #define AS_AREA_ATTR_PARTIAL 1 /**< Not fully initialized area. */ |
75 | 75 | ||
76 | /** The page fault was not resolved by as_page_fault(). */ |
76 | /** The page fault was not resolved by as_page_fault(). */ |
77 | #define AS_PF_FAULT 0 |
77 | #define AS_PF_FAULT 0 |
78 | /** The page fault was resolved by as_page_fault(). */ |
78 | /** The page fault was resolved by as_page_fault(). */ |
79 | #define AS_PF_OK 1 |
79 | #define AS_PF_OK 1 |
80 | /** The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */ |
80 | /** The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */ |
81 | #define AS_PF_DEFER 2 |
81 | #define AS_PF_DEFER 2 |
82 | 82 | ||
83 | /** Address space structure. |
83 | /** Address space structure. |
84 | * |
84 | * |
85 | * as_t contains the list of as_areas of userspace accessible |
85 | * as_t contains the list of as_areas of userspace accessible |
86 | * pages for one or more tasks. Ranges of kernel memory pages are not |
86 | * pages for one or more tasks. Ranges of kernel memory pages are not |
87 | * supposed to figure in the list as they are shared by all tasks and |
87 | * supposed to figure in the list as they are shared by all tasks and |
88 | * set up during system initialization. |
88 | * set up during system initialization. |
89 | */ |
89 | */ |
90 | typedef struct as { |
90 | typedef struct as { |
91 | /** Protected by asidlock. */ |
91 | /** Protected by asidlock. */ |
92 | link_t inactive_as_with_asid_link; |
92 | link_t inactive_as_with_asid_link; |
93 | /** |
93 | /** |
94 | * Number of processors on wich is this address space active. |
94 | * Number of processors on wich is this address space active. |
95 | * Protected by asidlock. |
95 | * Protected by asidlock. |
96 | */ |
96 | */ |
97 | count_t cpu_refcount; |
97 | size_t cpu_refcount; |
98 | /** |
98 | /** |
99 | * Address space identifier. |
99 | * Address space identifier. |
100 | * Constant on architectures that do not support ASIDs. |
100 | * Constant on architectures that do not support ASIDs. |
101 | * Protected by asidlock. |
101 | * Protected by asidlock. |
102 | */ |
102 | */ |
103 | asid_t asid; |
103 | asid_t asid; |
104 | 104 | ||
105 | /** Number of references (i.e tasks that reference this as). */ |
105 | /** Number of references (i.e tasks that reference this as). */ |
106 | atomic_t refcount; |
106 | atomic_t refcount; |
107 | 107 | ||
108 | mutex_t lock; |
108 | mutex_t lock; |
109 | 109 | ||
110 | /** B+tree of address space areas. */ |
110 | /** B+tree of address space areas. */ |
111 | btree_t as_area_btree; |
111 | btree_t as_area_btree; |
112 | 112 | ||
113 | /** Non-generic content. */ |
113 | /** Non-generic content. */ |
114 | as_genarch_t genarch; |
114 | as_genarch_t genarch; |
115 | 115 | ||
116 | /** Architecture specific content. */ |
116 | /** Architecture specific content. */ |
117 | as_arch_t arch; |
117 | as_arch_t arch; |
118 | } as_t; |
118 | } as_t; |
119 | 119 | ||
120 | typedef struct { |
120 | typedef struct { |
121 | pte_t *(* page_table_create)(int flags); |
121 | pte_t *(* page_table_create)(int flags); |
122 | void (* page_table_destroy)(pte_t *page_table); |
122 | void (* page_table_destroy)(pte_t *page_table); |
123 | void (* page_table_lock)(as_t *as, bool lock); |
123 | void (* page_table_lock)(as_t *as, bool lock); |
124 | void (* page_table_unlock)(as_t *as, bool unlock); |
124 | void (* page_table_unlock)(as_t *as, bool unlock); |
125 | } as_operations_t; |
125 | } as_operations_t; |
126 | 126 | ||
127 | /** |
127 | /** |
128 | * This structure contains information associated with the shared address space |
128 | * This structure contains information associated with the shared address space |
129 | * area. |
129 | * area. |
130 | */ |
130 | */ |
131 | typedef struct { |
131 | typedef struct { |
132 | /** This lock must be acquired only when the as_area lock is held. */ |
132 | /** This lock must be acquired only when the as_area lock is held. */ |
133 | mutex_t lock; |
133 | mutex_t lock; |
134 | /** This structure can be deallocated if refcount drops to 0. */ |
134 | /** This structure can be deallocated if refcount drops to 0. */ |
135 | count_t refcount; |
135 | size_t refcount; |
136 | /** |
136 | /** |
137 | * B+tree containing complete map of anonymous pages of the shared area. |
137 | * B+tree containing complete map of anonymous pages of the shared area. |
138 | */ |
138 | */ |
139 | btree_t pagemap; |
139 | btree_t pagemap; |
140 | } share_info_t; |
140 | } share_info_t; |
141 | 141 | ||
142 | /** Page fault access type. */ |
142 | /** Page fault access type. */ |
143 | typedef enum { |
143 | typedef enum { |
144 | PF_ACCESS_READ, |
144 | PF_ACCESS_READ, |
145 | PF_ACCESS_WRITE, |
145 | PF_ACCESS_WRITE, |
146 | PF_ACCESS_EXEC |
146 | PF_ACCESS_EXEC |
147 | } pf_access_t; |
147 | } pf_access_t; |
148 | 148 | ||
149 | struct mem_backend; |
149 | struct mem_backend; |
150 | 150 | ||
151 | /** Backend data stored in address space area. */ |
151 | /** Backend data stored in address space area. */ |
152 | typedef union mem_backend_data { |
152 | typedef union mem_backend_data { |
153 | struct { /**< elf_backend members */ |
153 | struct { /**< elf_backend members */ |
154 | elf_header_t *elf; |
154 | elf_header_t *elf; |
155 | elf_segment_header_t *segment; |
155 | elf_segment_header_t *segment; |
156 | }; |
156 | }; |
157 | struct { /**< phys_backend members */ |
157 | struct { /**< phys_backend members */ |
158 | uintptr_t base; |
158 | uintptr_t base; |
159 | count_t frames; |
159 | size_t frames; |
160 | }; |
160 | }; |
161 | } mem_backend_data_t; |
161 | } mem_backend_data_t; |
162 | 162 | ||
163 | /** Address space area structure. |
163 | /** Address space area structure. |
164 | * |
164 | * |
165 | * Each as_area_t structure describes one contiguous area of virtual memory. |
165 | * Each as_area_t structure describes one contiguous area of virtual memory. |
166 | */ |
166 | */ |
167 | typedef struct { |
167 | typedef struct { |
168 | mutex_t lock; |
168 | mutex_t lock; |
169 | /** Containing address space. */ |
169 | /** Containing address space. */ |
170 | as_t *as; |
170 | as_t *as; |
171 | /** |
171 | /** |
172 | * Flags related to the memory represented by the address space area. |
172 | * Flags related to the memory represented by the address space area. |
173 | */ |
173 | */ |
174 | int flags; |
174 | int flags; |
175 | /** Attributes related to the address space area itself. */ |
175 | /** Attributes related to the address space area itself. */ |
176 | int attributes; |
176 | int attributes; |
177 | /** Size of this area in multiples of PAGE_SIZE. */ |
177 | /** Size of this area in multiples of PAGE_SIZE. */ |
178 | count_t pages; |
178 | size_t pages; |
179 | /** Base address of this area. */ |
179 | /** Base address of this area. */ |
180 | uintptr_t base; |
180 | uintptr_t base; |
181 | /** Map of used space. */ |
181 | /** Map of used space. */ |
182 | btree_t used_space; |
182 | btree_t used_space; |
183 | 183 | ||
184 | /** |
184 | /** |
185 | * If the address space area has been shared, this pointer will |
185 | * If the address space area has been shared, this pointer will |
186 | * reference the share info structure. |
186 | * reference the share info structure. |
187 | */ |
187 | */ |
188 | share_info_t *sh_info; |
188 | share_info_t *sh_info; |
189 | 189 | ||
190 | /** Memory backend backing this address space area. */ |
190 | /** Memory backend backing this address space area. */ |
191 | struct mem_backend *backend; |
191 | struct mem_backend *backend; |
192 | 192 | ||
193 | /** Data to be used by the backend. */ |
193 | /** Data to be used by the backend. */ |
194 | mem_backend_data_t backend_data; |
194 | mem_backend_data_t backend_data; |
195 | } as_area_t; |
195 | } as_area_t; |
196 | 196 | ||
197 | /** Address space area backend structure. */ |
197 | /** Address space area backend structure. */ |
198 | typedef struct mem_backend { |
198 | typedef struct mem_backend { |
199 | int (* page_fault)(as_area_t *area, uintptr_t addr, pf_access_t access); |
199 | int (* page_fault)(as_area_t *area, uintptr_t addr, pf_access_t access); |
200 | void (* frame_free)(as_area_t *area, uintptr_t page, uintptr_t frame); |
200 | void (* frame_free)(as_area_t *area, uintptr_t page, uintptr_t frame); |
201 | void (* share)(as_area_t *area); |
201 | void (* share)(as_area_t *area); |
202 | } mem_backend_t; |
202 | } mem_backend_t; |
203 | 203 | ||
204 | extern as_t *AS_KERNEL; |
204 | extern as_t *AS_KERNEL; |
205 | 205 | ||
206 | extern as_operations_t *as_operations; |
206 | extern as_operations_t *as_operations; |
207 | extern link_t inactive_as_with_asid_head; |
207 | extern link_t inactive_as_with_asid_head; |
208 | 208 | ||
209 | extern void as_init(void); |
209 | extern void as_init(void); |
210 | 210 | ||
211 | extern as_t *as_create(int flags); |
211 | extern as_t *as_create(int flags); |
212 | extern void as_destroy(as_t *as); |
212 | extern void as_destroy(as_t *as); |
213 | extern void as_switch(as_t *old_as, as_t *new_as); |
213 | extern void as_switch(as_t *old_as, as_t *new_as); |
214 | extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate); |
214 | extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate); |
215 | 215 | ||
216 | extern as_area_t *as_area_create(as_t *as, int flags, size_t size, |
216 | extern as_area_t *as_area_create(as_t *as, int flags, size_t size, |
217 | uintptr_t base, int attrs, mem_backend_t *backend, |
217 | uintptr_t base, int attrs, mem_backend_t *backend, |
218 | mem_backend_data_t *backend_data); |
218 | mem_backend_data_t *backend_data); |
219 | extern int as_area_destroy(as_t *as, uintptr_t address); |
219 | extern int as_area_destroy(as_t *as, uintptr_t address); |
220 | extern int as_area_resize(as_t *as, uintptr_t address, size_t size, int flags); |
220 | extern int as_area_resize(as_t *as, uintptr_t address, size_t size, int flags); |
221 | int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size, |
221 | int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size, |
222 | as_t *dst_as, uintptr_t dst_base, int dst_flags_mask); |
222 | as_t *dst_as, uintptr_t dst_base, int dst_flags_mask); |
223 | extern int as_area_change_flags(as_t *as, int flags, uintptr_t address); |
223 | extern int as_area_change_flags(as_t *as, int flags, uintptr_t address); |
224 | 224 | ||
225 | extern int as_area_get_flags(as_area_t *area); |
225 | extern int as_area_get_flags(as_area_t *area); |
226 | extern bool as_area_check_access(as_area_t *area, pf_access_t access); |
226 | extern bool as_area_check_access(as_area_t *area, pf_access_t access); |
227 | extern size_t as_area_get_size(uintptr_t base); |
227 | extern size_t as_area_get_size(uintptr_t base); |
228 | extern int used_space_insert(as_area_t *a, uintptr_t page, count_t count); |
228 | extern int used_space_insert(as_area_t *a, uintptr_t page, size_t count); |
229 | extern int used_space_remove(as_area_t *a, uintptr_t page, count_t count); |
229 | extern int used_space_remove(as_area_t *a, uintptr_t page, size_t count); |
230 | 230 | ||
231 | 231 | ||
232 | /* Interface to be implemented by architectures. */ |
232 | /* Interface to be implemented by architectures. */ |
233 | #ifndef as_constructor_arch |
233 | #ifndef as_constructor_arch |
234 | extern int as_constructor_arch(as_t *as, int flags); |
234 | extern int as_constructor_arch(as_t *as, int flags); |
235 | #endif /* !def as_constructor_arch */ |
235 | #endif /* !def as_constructor_arch */ |
236 | #ifndef as_destructor_arch |
236 | #ifndef as_destructor_arch |
237 | extern int as_destructor_arch(as_t *as); |
237 | extern int as_destructor_arch(as_t *as); |
238 | #endif /* !def as_destructor_arch */ |
238 | #endif /* !def as_destructor_arch */ |
239 | #ifndef as_create_arch |
239 | #ifndef as_create_arch |
240 | extern int as_create_arch(as_t *as, int flags); |
240 | extern int as_create_arch(as_t *as, int flags); |
241 | #endif /* !def as_create_arch */ |
241 | #endif /* !def as_create_arch */ |
242 | #ifndef as_install_arch |
242 | #ifndef as_install_arch |
243 | extern void as_install_arch(as_t *as); |
243 | extern void as_install_arch(as_t *as); |
244 | #endif /* !def as_install_arch */ |
244 | #endif /* !def as_install_arch */ |
245 | #ifndef as_deinstall_arch |
245 | #ifndef as_deinstall_arch |
246 | extern void as_deinstall_arch(as_t *as); |
246 | extern void as_deinstall_arch(as_t *as); |
247 | #endif /* !def as_deinstall_arch */ |
247 | #endif /* !def as_deinstall_arch */ |
248 | 248 | ||
249 | /* Backend declarations and functions. */ |
249 | /* Backend declarations and functions. */ |
250 | extern mem_backend_t anon_backend; |
250 | extern mem_backend_t anon_backend; |
251 | extern mem_backend_t elf_backend; |
251 | extern mem_backend_t elf_backend; |
252 | extern mem_backend_t phys_backend; |
252 | extern mem_backend_t phys_backend; |
253 | 253 | ||
254 | /** |
254 | /** |
255 | * This flags is passed when running the loader, otherwise elf_load() |
255 | * This flags is passed when running the loader, otherwise elf_load() |
256 | * would return with a EE_LOADER error code. |
256 | * would return with a EE_LOADER error code. |
257 | */ |
257 | */ |
258 | #define ELD_F_NONE 0 |
258 | #define ELD_F_NONE 0 |
259 | #define ELD_F_LOADER 1 |
259 | #define ELD_F_LOADER 1 |
260 | 260 | ||
261 | extern unsigned int elf_load(elf_header_t *header, as_t *as, int flags); |
261 | extern unsigned int elf_load(elf_header_t *header, as_t *as, int flags); |
262 | 262 | ||
263 | /* Address space area related syscalls. */ |
263 | /* Address space area related syscalls. */ |
264 | extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags); |
264 | extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags); |
265 | extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags); |
265 | extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags); |
266 | extern unative_t sys_as_area_change_flags(uintptr_t address, int flags); |
266 | extern unative_t sys_as_area_change_flags(uintptr_t address, int flags); |
267 | extern unative_t sys_as_area_destroy(uintptr_t address); |
267 | extern unative_t sys_as_area_destroy(uintptr_t address); |
268 | 268 | ||
269 | /* Introspection functions. */ |
269 | /* Introspection functions. */ |
270 | extern void as_print(as_t *as); |
270 | extern void as_print(as_t *as); |
271 | 271 | ||
272 | #endif /* KERNEL */ |
272 | #endif /* KERNEL */ |
273 | 273 | ||
274 | #endif |
274 | #endif |
275 | 275 | ||
276 | /** @} |
276 | /** @} |
277 | */ |
277 | */ |
278 | 278 |