Subversion Repositories HelenOS

Rev

Rev 2126 | Rev 2183 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

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