source: mainline/kernel/generic/include/mm/as.h@ c0699467

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since c0699467 was c0699467, checked in by Martin Decky <martin@…>, 14 years ago

do not provide general access to kernel headers from uspace, only allow specific headers to be accessed or shared
externalize headers which serve as kernel/uspace API/ABI into a special tree
  • Property mode set to 100644
File size: 8.2 KB
Line 
1/*
2 * Copyright (c) 2010 Jakub Jermar
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
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
15 * derived from this software without specific prior written permission.
16 *
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
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup genericmm
30 * @{
31 */
32/** @file
33 */
34
35#ifndef KERN_AS_H_
36#define KERN_AS_H_
37
38#include <typedefs.h>
39#include <abi/mm/as.h>
40#include <arch/mm/page.h>
41#include <arch/mm/as.h>
42#include <arch/mm/asid.h>
43#include <arch/istate.h>
44#include <typedefs.h>
45#include <synch/spinlock.h>
46#include <synch/mutex.h>
47#include <adt/list.h>
48#include <adt/btree.h>
49#include <lib/elf.h>
50
51/**
52 * Defined to be true if user address space and kernel address space shadow each
53 * other.
54 *
55 */
56#define KERNEL_ADDRESS_SPACE_SHADOWED KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
57
58#define KERNEL_ADDRESS_SPACE_START KERNEL_ADDRESS_SPACE_START_ARCH
59#define KERNEL_ADDRESS_SPACE_END KERNEL_ADDRESS_SPACE_END_ARCH
60#define USER_ADDRESS_SPACE_START USER_ADDRESS_SPACE_START_ARCH
61#define USER_ADDRESS_SPACE_END USER_ADDRESS_SPACE_END_ARCH
62
63#ifdef USTACK_ADDRESS_ARCH
64 #define USTACK_ADDRESS USTACK_ADDRESS_ARCH
65#else
66 #define USTACK_ADDRESS (USER_ADDRESS_SPACE_END - (STACK_SIZE - 1))
67#endif
68
69/** Kernel address space. */
70#define FLAG_AS_KERNEL (1 << 0)
71
72/* Address space area attributes. */
73#define AS_AREA_ATTR_NONE 0
74#define AS_AREA_ATTR_PARTIAL 1 /**< Not fully initialized area. */
75
76/** The page fault was not resolved by as_page_fault(). */
77#define AS_PF_FAULT 0
78
79/** The page fault was resolved by as_page_fault(). */
80#define AS_PF_OK 1
81
82/** The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */
83#define AS_PF_DEFER 2
84
85/** Address space structure.
86 *
87 * as_t contains the list of as_areas of userspace accessible
88 * pages for one or more tasks. Ranges of kernel memory pages are not
89 * supposed to figure in the list as they are shared by all tasks and
90 * set up during system initialization.
91 *
92 */
93typedef struct as {
94 /** Protected by asidlock. */
95 link_t inactive_as_with_asid_link;
96
97 /**
98 * Number of processors on which this
99 * address space is active. Protected by
100 * asidlock.
101 */
102 size_t cpu_refcount;
103
104 /** Address space identifier.
105 *
106 * Constant on architectures that do not
107 * support ASIDs. Protected by asidlock.
108 *
109 */
110 asid_t asid;
111
112 /** Number of references (i.e. tasks that reference this as). */
113 atomic_t refcount;
114
115 mutex_t lock;
116
117 /** B+tree of address space areas. */
118 btree_t as_area_btree;
119
120 /** Non-generic content. */
121 as_genarch_t genarch;
122
123 /** Architecture specific content. */
124 as_arch_t arch;
125} as_t;
126
127typedef struct {
128 pte_t *(* page_table_create)(unsigned int);
129 void (* page_table_destroy)(pte_t *);
130 void (* page_table_lock)(as_t *, bool);
131 void (* page_table_unlock)(as_t *, bool);
132 bool (* page_table_locked)(as_t *);
133} as_operations_t;
134
135/**
136 * This structure contains information associated with the shared address space
137 * area.
138 *
139 */
140typedef struct {
141 /** This lock must be acquired only when the as_area lock is held. */
142 mutex_t lock;
143 /** This structure can be deallocated if refcount drops to 0. */
144 size_t refcount;
145
146 /**
147 * B+tree containing complete map of anonymous pages of the shared area.
148 */
149 btree_t pagemap;
150} share_info_t;
151
152/** Page fault access type. */
153typedef enum {
154 PF_ACCESS_READ,
155 PF_ACCESS_WRITE,
156 PF_ACCESS_EXEC,
157 PF_ACCESS_UNKNOWN
158} pf_access_t;
159
160struct mem_backend;
161
162/** Backend data stored in address space area. */
163typedef union mem_backend_data {
164 /** elf_backend members */
165 struct {
166 elf_header_t *elf;
167 elf_segment_header_t *segment;
168 };
169
170 /** phys_backend members */
171 struct {
172 uintptr_t base;
173 size_t frames;
174 };
175} mem_backend_data_t;
176
177/** Address space area structure.
178 *
179 * Each as_area_t structure describes one contiguous area of virtual memory.
180 *
181 */
182typedef struct {
183 mutex_t lock;
184
185 /** Containing address space. */
186 as_t *as;
187
188 /** Memory flags. */
189 unsigned int flags;
190
191 /** Address space area attributes. */
192 unsigned int attributes;
193
194 /** Number of pages in the area. */
195 size_t pages;
196
197 /** Number of resident pages in the area. */
198 size_t resident;
199
200 /** Base address of this area. */
201 uintptr_t base;
202
203 /** Map of used space. */
204 btree_t used_space;
205
206 /**
207 * If the address space area is shared. this is
208 * a reference to the share info structure.
209 */
210 share_info_t *sh_info;
211
212 /** Memory backend backing this address space area. */
213 struct mem_backend *backend;
214
215 /** Data to be used by the backend. */
216 mem_backend_data_t backend_data;
217} as_area_t;
218
219/** Address space area backend structure. */
220typedef struct mem_backend {
221 bool (* create)(as_area_t *);
222 bool (* resize)(as_area_t *, size_t);
223 void (* share)(as_area_t *);
224 void (* destroy)(as_area_t *);
225
226 int (* page_fault)(as_area_t *, uintptr_t, pf_access_t);
227 void (* frame_free)(as_area_t *, uintptr_t, uintptr_t);
228} mem_backend_t;
229
230extern as_t *AS_KERNEL;
231
232extern as_operations_t *as_operations;
233extern list_t inactive_as_with_asid_list;
234
235extern void as_init(void);
236
237extern as_t *as_create(unsigned int);
238extern void as_destroy(as_t *);
239extern void as_hold(as_t *);
240extern void as_release(as_t *);
241extern void as_switch(as_t *, as_t *);
242extern int as_page_fault(uintptr_t, pf_access_t, istate_t *);
243
244extern as_area_t *as_area_create(as_t *, unsigned int, size_t, uintptr_t,
245 unsigned int, mem_backend_t *, mem_backend_data_t *);
246extern int as_area_destroy(as_t *, uintptr_t);
247extern int as_area_resize(as_t *, uintptr_t, size_t, unsigned int);
248extern int as_area_share(as_t *, uintptr_t, size_t, as_t *, uintptr_t,
249 unsigned int);
250extern int as_area_change_flags(as_t *, unsigned int, uintptr_t);
251
252extern unsigned int as_area_get_flags(as_area_t *);
253extern bool as_area_check_access(as_area_t *, pf_access_t);
254extern size_t as_area_get_size(uintptr_t);
255extern bool used_space_insert(as_area_t *, uintptr_t, size_t);
256extern bool used_space_remove(as_area_t *, uintptr_t, size_t);
257
258/* Interface to be implemented by architectures. */
259
260#ifndef as_constructor_arch
261extern int as_constructor_arch(as_t *, unsigned int);
262#endif /* !def as_constructor_arch */
263
264#ifndef as_destructor_arch
265extern int as_destructor_arch(as_t *);
266#endif /* !def as_destructor_arch */
267
268#ifndef as_create_arch
269extern int as_create_arch(as_t *, unsigned int);
270#endif /* !def as_create_arch */
271
272#ifndef as_install_arch
273extern void as_install_arch(as_t *);
274#endif /* !def as_install_arch */
275
276#ifndef as_deinstall_arch
277extern void as_deinstall_arch(as_t *);
278#endif /* !def as_deinstall_arch */
279
280/* Backend declarations and functions. */
281extern mem_backend_t anon_backend;
282extern mem_backend_t elf_backend;
283extern mem_backend_t phys_backend;
284
285/* Address space area related syscalls. */
286extern sysarg_t sys_as_area_create(uintptr_t, size_t, unsigned int);
287extern sysarg_t sys_as_area_resize(uintptr_t, size_t, unsigned int);
288extern sysarg_t sys_as_area_change_flags(uintptr_t, unsigned int);
289extern sysarg_t sys_as_area_destroy(uintptr_t);
290extern sysarg_t sys_as_get_unmapped_area(uintptr_t, size_t);
291
292/* Introspection functions. */
293extern void as_get_area_info(as_t *, as_area_info_t **, size_t *);
294extern void as_print(as_t *);
295
296#endif
297
298/** @}
299 */
Note: See TracBrowser for help on using the repository browser.