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

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 9043309c was d1e8440, checked in by Jakub Jermar <jakub@…>, 13 years ago

Get rid of USTACK_ADDRESS.

  • Let the kernel find a suitable address itself.
  • Limit it to only one possibility using the bound argument of as_area_create().
  • Property mode set to 100644
File size: 8.1 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/** Kernel address space. */
64#define FLAG_AS_KERNEL (1 << 0)
65
66/* Address space area attributes. */
67#define AS_AREA_ATTR_NONE 0
68#define AS_AREA_ATTR_PARTIAL 1 /**< Not fully initialized area. */
69
70/** The page fault was not resolved by as_page_fault(). */
71#define AS_PF_FAULT 0
72
73/** The page fault was resolved by as_page_fault(). */
74#define AS_PF_OK 1
75
76/** The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */
77#define AS_PF_DEFER 2
78
79/** Address space structure.
80 *
81 * as_t contains the list of as_areas of userspace accessible
82 * pages for one or more tasks. Ranges of kernel memory pages are not
83 * supposed to figure in the list as they are shared by all tasks and
84 * set up during system initialization.
85 *
86 */
87typedef struct as {
88 /** Protected by asidlock. */
89 link_t inactive_as_with_asid_link;
90
91 /**
92 * Number of processors on which this
93 * address space is active. Protected by
94 * asidlock.
95 */
96 size_t cpu_refcount;
97
98 /** Address space identifier.
99 *
100 * Constant on architectures that do not
101 * support ASIDs. Protected by asidlock.
102 *
103 */
104 asid_t asid;
105
106 /** Number of references (i.e. tasks that reference this as). */
107 atomic_t refcount;
108
109 mutex_t lock;
110
111 /** B+tree of address space areas. */
112 btree_t as_area_btree;
113
114 /** Non-generic content. */
115 as_genarch_t genarch;
116
117 /** Architecture specific content. */
118 as_arch_t arch;
119} as_t;
120
121typedef struct {
122 pte_t *(* page_table_create)(unsigned int);
123 void (* page_table_destroy)(pte_t *);
124 void (* page_table_lock)(as_t *, bool);
125 void (* page_table_unlock)(as_t *, bool);
126 bool (* page_table_locked)(as_t *);
127} as_operations_t;
128
129/**
130 * This structure contains information associated with the shared address space
131 * area.
132 *
133 */
134typedef struct {
135 /** This lock must be acquired only when the as_area lock is held. */
136 mutex_t lock;
137 /** This structure can be deallocated if refcount drops to 0. */
138 size_t refcount;
139
140 /**
141 * B+tree containing complete map of anonymous pages of the shared area.
142 */
143 btree_t pagemap;
144} share_info_t;
145
146/** Page fault access type. */
147typedef enum {
148 PF_ACCESS_READ,
149 PF_ACCESS_WRITE,
150 PF_ACCESS_EXEC,
151 PF_ACCESS_UNKNOWN
152} pf_access_t;
153
154struct mem_backend;
155
156/** Backend data stored in address space area. */
157typedef union mem_backend_data {
158 /** elf_backend members */
159 struct {
160 elf_header_t *elf;
161 elf_segment_header_t *segment;
162 };
163
164 /** phys_backend members */
165 struct {
166 uintptr_t base;
167 size_t frames;
168 };
169} mem_backend_data_t;
170
171/** Address space area structure.
172 *
173 * Each as_area_t structure describes one contiguous area of virtual memory.
174 *
175 */
176typedef struct {
177 mutex_t lock;
178
179 /** Containing address space. */
180 as_t *as;
181
182 /** Memory flags. */
183 unsigned int flags;
184
185 /** Address space area attributes. */
186 unsigned int attributes;
187
188 /** Number of pages in the area. */
189 size_t pages;
190
191 /** Number of resident pages in the area. */
192 size_t resident;
193
194 /** Base address of this area. */
195 uintptr_t base;
196
197 /** Map of used space. */
198 btree_t used_space;
199
200 /**
201 * If the address space area is shared. this is
202 * a reference to the share info structure.
203 */
204 share_info_t *sh_info;
205
206 /** Memory backend backing this address space area. */
207 struct mem_backend *backend;
208
209 /** Data to be used by the backend. */
210 mem_backend_data_t backend_data;
211} as_area_t;
212
213/** Address space area backend structure. */
214typedef struct mem_backend {
215 bool (* create)(as_area_t *);
216 bool (* resize)(as_area_t *, size_t);
217 void (* share)(as_area_t *);
218 void (* destroy)(as_area_t *);
219
220 bool (* is_resizable)(as_area_t *);
221 bool (* is_shareable)(as_area_t *);
222
223 int (* page_fault)(as_area_t *, uintptr_t, pf_access_t);
224 void (* frame_free)(as_area_t *, uintptr_t, uintptr_t);
225} mem_backend_t;
226
227extern as_t *AS_KERNEL;
228
229extern as_operations_t *as_operations;
230extern list_t inactive_as_with_asid_list;
231
232extern void as_init(void);
233
234extern as_t *as_create(unsigned int);
235extern void as_destroy(as_t *);
236extern void as_hold(as_t *);
237extern void as_release(as_t *);
238extern void as_switch(as_t *, as_t *);
239extern int as_page_fault(uintptr_t, pf_access_t, istate_t *);
240
241extern as_area_t *as_area_create(as_t *, unsigned int, size_t, unsigned int,
242 mem_backend_t *, mem_backend_data_t *, uintptr_t *, uintptr_t);
243extern int as_area_destroy(as_t *, uintptr_t);
244extern int as_area_resize(as_t *, uintptr_t, size_t, unsigned int);
245extern int as_area_share(as_t *, uintptr_t, size_t, as_t *, unsigned int,
246 uintptr_t *, uintptr_t);
247extern int as_area_change_flags(as_t *, unsigned int, uintptr_t);
248
249extern unsigned int as_area_get_flags(as_area_t *);
250extern bool as_area_check_access(as_area_t *, pf_access_t);
251extern size_t as_area_get_size(uintptr_t);
252extern bool used_space_insert(as_area_t *, uintptr_t, size_t);
253extern bool used_space_remove(as_area_t *, uintptr_t, size_t);
254
255/* Interface to be implemented by architectures. */
256
257#ifndef as_constructor_arch
258extern int as_constructor_arch(as_t *, unsigned int);
259#endif /* !def as_constructor_arch */
260
261#ifndef as_destructor_arch
262extern int as_destructor_arch(as_t *);
263#endif /* !def as_destructor_arch */
264
265#ifndef as_create_arch
266extern int as_create_arch(as_t *, unsigned int);
267#endif /* !def as_create_arch */
268
269#ifndef as_install_arch
270extern void as_install_arch(as_t *);
271#endif /* !def as_install_arch */
272
273#ifndef as_deinstall_arch
274extern void as_deinstall_arch(as_t *);
275#endif /* !def as_deinstall_arch */
276
277/* Backend declarations and functions. */
278extern mem_backend_t anon_backend;
279extern mem_backend_t elf_backend;
280extern mem_backend_t phys_backend;
281
282/* Address space area related syscalls. */
283extern sysarg_t sys_as_area_create(uintptr_t, size_t, unsigned int, uintptr_t);
284extern sysarg_t sys_as_area_resize(uintptr_t, size_t, unsigned int);
285extern sysarg_t sys_as_area_change_flags(uintptr_t, unsigned int);
286extern sysarg_t sys_as_area_destroy(uintptr_t);
287
288/* Introspection functions. */
289extern void as_get_area_info(as_t *, as_area_info_t **, size_t *);
290extern void as_print(as_t *);
291
292#endif
293
294/** @}
295 */
Note: See TracBrowser for help on using the repository browser.