| 1 | /*
|
|---|
| 2 | * Copyright (c) 2001-2004 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 | /** Address space area flags. */
|
|---|
| 39 | #define AS_AREA_READ 1
|
|---|
| 40 | #define AS_AREA_WRITE 2
|
|---|
| 41 | #define AS_AREA_EXEC 4
|
|---|
| 42 | #define AS_AREA_CACHEABLE 8
|
|---|
| 43 |
|
|---|
| 44 | #ifdef KERNEL
|
|---|
| 45 |
|
|---|
| 46 | #include <arch/mm/page.h>
|
|---|
| 47 | #include <arch/mm/as.h>
|
|---|
| 48 | #include <arch/mm/asid.h>
|
|---|
| 49 | #include <arch/types.h>
|
|---|
| 50 | #include <synch/spinlock.h>
|
|---|
| 51 | #include <synch/mutex.h>
|
|---|
| 52 | #include <adt/list.h>
|
|---|
| 53 | #include <adt/btree.h>
|
|---|
| 54 | #include <lib/elf.h>
|
|---|
| 55 |
|
|---|
| 56 | /**
|
|---|
| 57 | * Defined to be true if user address space and kernel address space shadow each
|
|---|
| 58 | * other.
|
|---|
| 59 | */
|
|---|
| 60 | #define KERNEL_ADDRESS_SPACE_SHADOWED KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
|
|---|
| 61 |
|
|---|
| 62 | #define KERNEL_ADDRESS_SPACE_START KERNEL_ADDRESS_SPACE_START_ARCH
|
|---|
| 63 | #define KERNEL_ADDRESS_SPACE_END KERNEL_ADDRESS_SPACE_END_ARCH
|
|---|
| 64 | #define USER_ADDRESS_SPACE_START USER_ADDRESS_SPACE_START_ARCH
|
|---|
| 65 | #define USER_ADDRESS_SPACE_END USER_ADDRESS_SPACE_END_ARCH
|
|---|
| 66 |
|
|---|
| 67 | #define USTACK_ADDRESS USTACK_ADDRESS_ARCH
|
|---|
| 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 | /** The page fault was resolved by as_page_fault(). */
|
|---|
| 79 | #define AS_PF_OK 1
|
|---|
| 80 | /** The page fault was caused by memcpy_from_uspace() or memcpy_to_uspace(). */
|
|---|
| 81 | #define AS_PF_DEFER 2
|
|---|
| 82 |
|
|---|
| 83 | #ifdef __OBJC__
|
|---|
| 84 | @interface as_t {
|
|---|
| 85 | @public
|
|---|
| 86 | /** Protected by asidlock. */
|
|---|
| 87 | link_t inactive_as_with_asid_link;
|
|---|
| 88 |
|
|---|
| 89 | mutex_t lock;
|
|---|
| 90 |
|
|---|
| 91 | /** Number of references (i.e tasks that reference this as). */
|
|---|
| 92 | count_t refcount;
|
|---|
| 93 |
|
|---|
| 94 | /** Number of processors on wich is this address space active. */
|
|---|
| 95 | count_t cpu_refcount;
|
|---|
| 96 |
|
|---|
| 97 | /** B+tree of address space areas. */
|
|---|
| 98 | btree_t as_area_btree;
|
|---|
| 99 |
|
|---|
| 100 | /**
|
|---|
| 101 | * Address space identifier.
|
|---|
| 102 | * Constant on architectures that do not support ASIDs.
|
|---|
| 103 | */
|
|---|
| 104 | asid_t asid;
|
|---|
| 105 |
|
|---|
| 106 | /** Non-generic content. */
|
|---|
| 107 | as_genarch_t genarch;
|
|---|
| 108 |
|
|---|
| 109 | /** Architecture specific content. */
|
|---|
| 110 | as_arch_t arch;
|
|---|
| 111 | }
|
|---|
| 112 | + (pte_t *) page_table_create: (int) flags;
|
|---|
| 113 | + (void) page_table_destroy: (pte_t *) page_table;
|
|---|
| 114 | - (void) page_table_lock: (bool) _lock;
|
|---|
| 115 | - (void) page_table_unlock: (bool) unlock;
|
|---|
| 116 | @end
|
|---|
| 117 |
|
|---|
| 118 | #else
|
|---|
| 119 |
|
|---|
| 120 | /** Address space structure.
|
|---|
| 121 | *
|
|---|
| 122 | * as_t contains the list of as_areas of userspace accessible
|
|---|
| 123 | * pages for one or more tasks. Ranges of kernel memory pages are not
|
|---|
| 124 | * supposed to figure in the list as they are shared by all tasks and
|
|---|
| 125 | * set up during system initialization.
|
|---|
| 126 | */
|
|---|
| 127 | typedef struct as {
|
|---|
| 128 | /** Protected by asidlock. */
|
|---|
| 129 | link_t inactive_as_with_asid_link;
|
|---|
| 130 |
|
|---|
| 131 | mutex_t lock;
|
|---|
| 132 |
|
|---|
| 133 | /** Number of references (i.e tasks that reference this as). */
|
|---|
| 134 | count_t refcount;
|
|---|
| 135 |
|
|---|
| 136 | /** Number of processors on wich is this address space active. */
|
|---|
| 137 | count_t cpu_refcount;
|
|---|
| 138 |
|
|---|
| 139 | /** B+tree of address space areas. */
|
|---|
| 140 | btree_t as_area_btree;
|
|---|
| 141 |
|
|---|
| 142 | /**
|
|---|
| 143 | * Address space identifier.
|
|---|
| 144 | * Constant on architectures that do not support ASIDs.
|
|---|
| 145 | */
|
|---|
| 146 | asid_t asid;
|
|---|
| 147 |
|
|---|
| 148 | /** Non-generic content. */
|
|---|
| 149 | as_genarch_t genarch;
|
|---|
| 150 |
|
|---|
| 151 | /** Architecture specific content. */
|
|---|
| 152 | as_arch_t arch;
|
|---|
| 153 | } as_t;
|
|---|
| 154 |
|
|---|
| 155 | typedef struct {
|
|---|
| 156 | pte_t *(* page_table_create)(int flags);
|
|---|
| 157 | void (* page_table_destroy)(pte_t *page_table);
|
|---|
| 158 | void (* page_table_lock)(as_t *as, bool lock);
|
|---|
| 159 | void (* page_table_unlock)(as_t *as, bool unlock);
|
|---|
| 160 | } as_operations_t;
|
|---|
| 161 | #endif
|
|---|
| 162 |
|
|---|
| 163 | /**
|
|---|
| 164 | * This structure contains information associated with the shared address space
|
|---|
| 165 | * area.
|
|---|
| 166 | */
|
|---|
| 167 | typedef struct {
|
|---|
| 168 | /** This lock must be acquired only when the as_area lock is held. */
|
|---|
| 169 | mutex_t lock;
|
|---|
| 170 | /** This structure can be deallocated if refcount drops to 0. */
|
|---|
| 171 | count_t refcount;
|
|---|
| 172 | /**
|
|---|
| 173 | * B+tree containing complete map of anonymous pages of the shared area.
|
|---|
| 174 | */
|
|---|
| 175 | btree_t pagemap;
|
|---|
| 176 | } share_info_t;
|
|---|
| 177 |
|
|---|
| 178 | /** Page fault access type. */
|
|---|
| 179 | typedef enum {
|
|---|
| 180 | PF_ACCESS_READ,
|
|---|
| 181 | PF_ACCESS_WRITE,
|
|---|
| 182 | PF_ACCESS_EXEC
|
|---|
| 183 | } pf_access_t;
|
|---|
| 184 |
|
|---|
| 185 | struct mem_backend;
|
|---|
| 186 |
|
|---|
| 187 | /** Backend data stored in address space area. */
|
|---|
| 188 | typedef union mem_backend_data {
|
|---|
| 189 | struct { /**< elf_backend members */
|
|---|
| 190 | elf_header_t *elf;
|
|---|
| 191 | elf_segment_header_t *segment;
|
|---|
| 192 | };
|
|---|
| 193 | struct { /**< phys_backend members */
|
|---|
| 194 | uintptr_t base;
|
|---|
| 195 | count_t frames;
|
|---|
| 196 | };
|
|---|
| 197 | } mem_backend_data_t;
|
|---|
| 198 |
|
|---|
| 199 | /** Address space area structure.
|
|---|
| 200 | *
|
|---|
| 201 | * Each as_area_t structure describes one contiguous area of virtual memory.
|
|---|
| 202 | * In the future, it should not be difficult to support shared areas.
|
|---|
| 203 | */
|
|---|
| 204 | typedef struct {
|
|---|
| 205 | mutex_t lock;
|
|---|
| 206 | /** Containing address space. */
|
|---|
| 207 | as_t *as;
|
|---|
| 208 | /**
|
|---|
| 209 | * Flags related to the memory represented by the address space area.
|
|---|
| 210 | */
|
|---|
| 211 | int flags;
|
|---|
| 212 | /** Attributes related to the address space area itself. */
|
|---|
| 213 | int attributes;
|
|---|
| 214 | /** Size of this area in multiples of PAGE_SIZE. */
|
|---|
| 215 | count_t pages;
|
|---|
| 216 | /** Base address of this area. */
|
|---|
| 217 | uintptr_t base;
|
|---|
| 218 | /** Map of used space. */
|
|---|
| 219 | btree_t used_space;
|
|---|
| 220 |
|
|---|
| 221 | /**
|
|---|
| 222 | * If the address space area has been shared, this pointer will
|
|---|
| 223 | * reference the share info structure.
|
|---|
| 224 | */
|
|---|
| 225 | share_info_t *sh_info;
|
|---|
| 226 |
|
|---|
| 227 | /** Memory backend backing this address space area. */
|
|---|
| 228 | struct mem_backend *backend;
|
|---|
| 229 |
|
|---|
| 230 | /** Data to be used by the backend. */
|
|---|
| 231 | mem_backend_data_t backend_data;
|
|---|
| 232 | } as_area_t;
|
|---|
| 233 |
|
|---|
| 234 | /** Address space area backend structure. */
|
|---|
| 235 | typedef struct mem_backend {
|
|---|
| 236 | int (* page_fault)(as_area_t *area, uintptr_t addr, pf_access_t access);
|
|---|
| 237 | void (* frame_free)(as_area_t *area, uintptr_t page, uintptr_t frame);
|
|---|
| 238 | void (* share)(as_area_t *area);
|
|---|
| 239 | } mem_backend_t;
|
|---|
| 240 |
|
|---|
| 241 | extern as_t *AS_KERNEL;
|
|---|
| 242 |
|
|---|
| 243 | #ifndef __OBJC__
|
|---|
| 244 | extern as_operations_t *as_operations;
|
|---|
| 245 | #endif
|
|---|
| 246 |
|
|---|
| 247 | SPINLOCK_EXTERN(inactive_as_with_asid_lock);
|
|---|
| 248 | extern link_t inactive_as_with_asid_head;
|
|---|
| 249 |
|
|---|
| 250 | extern void as_init(void);
|
|---|
| 251 |
|
|---|
| 252 | extern as_t *as_create(int flags);
|
|---|
| 253 | extern void as_destroy(as_t *as);
|
|---|
| 254 | extern void as_switch(as_t *old_as, as_t *new_as);
|
|---|
| 255 | extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate);
|
|---|
| 256 |
|
|---|
| 257 | extern as_area_t *as_area_create(as_t *as, int flags, size_t size,
|
|---|
| 258 | uintptr_t base, int attrs, mem_backend_t *backend,
|
|---|
| 259 | mem_backend_data_t *backend_data);
|
|---|
| 260 | extern int as_area_destroy(as_t *as, uintptr_t address);
|
|---|
| 261 | extern int as_area_resize(as_t *as, uintptr_t address, size_t size, int flags);
|
|---|
| 262 | int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size,
|
|---|
| 263 | as_t *dst_as, uintptr_t dst_base, int dst_flags_mask);
|
|---|
| 264 |
|
|---|
| 265 | extern int as_area_get_flags(as_area_t *area);
|
|---|
| 266 | extern bool as_area_check_access(as_area_t *area, pf_access_t access);
|
|---|
| 267 | extern size_t as_get_size(uintptr_t base);
|
|---|
| 268 | extern int used_space_insert(as_area_t *a, uintptr_t page, count_t count);
|
|---|
| 269 | extern int used_space_remove(as_area_t *a, uintptr_t page, count_t count);
|
|---|
| 270 |
|
|---|
| 271 |
|
|---|
| 272 | /* Interface to be implemented by architectures. */
|
|---|
| 273 | #ifndef as_constructor_arch
|
|---|
| 274 | extern int as_constructor_arch(as_t *as, int flags);
|
|---|
| 275 | #endif /* !def as_constructor_arch */
|
|---|
| 276 | #ifndef as_destructor_arch
|
|---|
| 277 | extern int as_destructor_arch(as_t *as);
|
|---|
| 278 | #endif /* !def as_destructor_arch */
|
|---|
| 279 | #ifndef as_create_arch
|
|---|
| 280 | extern int as_create_arch(as_t *as, int flags);
|
|---|
| 281 | #endif /* !def as_create_arch */
|
|---|
| 282 | #ifndef as_install_arch
|
|---|
| 283 | extern void as_install_arch(as_t *as);
|
|---|
| 284 | #endif /* !def as_install_arch */
|
|---|
| 285 | #ifndef as_deinstall_arch
|
|---|
| 286 | extern void as_deinstall_arch(as_t *as);
|
|---|
| 287 | #endif /* !def as_deinstall_arch */
|
|---|
| 288 |
|
|---|
| 289 | /* Backend declarations and functions. */
|
|---|
| 290 | extern mem_backend_t anon_backend;
|
|---|
| 291 | extern mem_backend_t elf_backend;
|
|---|
| 292 | extern mem_backend_t phys_backend;
|
|---|
| 293 |
|
|---|
| 294 | extern int elf_load(elf_header_t *header, as_t *as);
|
|---|
| 295 |
|
|---|
| 296 | /* Address space area related syscalls. */
|
|---|
| 297 | extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags);
|
|---|
| 298 | extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags);
|
|---|
| 299 | extern unative_t sys_as_area_destroy(uintptr_t address);
|
|---|
| 300 |
|
|---|
| 301 | /* Introspection functions. */
|
|---|
| 302 | extern void as_print(as_t *as);
|
|---|
| 303 |
|
|---|
| 304 | #endif /* KERNEL */
|
|---|
| 305 |
|
|---|
| 306 | #endif
|
|---|
| 307 |
|
|---|
| 308 | /** @}
|
|---|
| 309 | */
|
|---|
