Subversion Repositories HelenOS

Rev

Rev 3624 | 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
 
2106 jermar 56
/**
57
 * Defined to be true if user address space and kernel address space shadow each
58
 * other.
59
 */
1070 jermar 60
#define KERNEL_ADDRESS_SPACE_SHADOWED   KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
61
 
1 jermar 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
 
2106 jermar 67
#define USTACK_ADDRESS          USTACK_ADDRESS_ARCH
1 jermar 68
 
2106 jermar 69
/** Kernel address space. */
70
#define FLAG_AS_KERNEL          (1 << 0)    
727 jermar 71
 
2106 jermar 72
/* Address space area attributes. */
2089 decky 73
#define AS_AREA_ATTR_NONE   0
74
#define AS_AREA_ATTR_PARTIAL    1   /**< Not fully initialized area. */
727 jermar 75
 
2106 jermar 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
823 jermar 82
 
2106 jermar 83
/** Address space structure.
84
 *
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
87
 * supposed to figure in the list as they are shared by all tasks and
88
 * set up during system initialization.
89
 */
90
typedef struct as {
91
    /** Protected by asidlock. */
92
    link_t inactive_as_with_asid_link;
2170 jermar 93
    /**
94
     * Number of processors on wich is this address space active.
95
     * Protected by asidlock.
96
     */
4692 svoboda 97
    size_t cpu_refcount;
2170 jermar 98
    /**
99
     * Address space identifier.
100
     * Constant on architectures that do not support ASIDs.
101
     * Protected by asidlock.
102
     */
103
    asid_t asid;
2106 jermar 104
 
2183 jermar 105
    /** Number of references (i.e tasks that reference this as). */
106
    atomic_t refcount;
107
 
2106 jermar 108
    mutex_t lock;
109
 
110
    /** B+tree of address space areas. */
111
    btree_t as_area_btree;
112
 
113
    /** Non-generic content. */
114
    as_genarch_t genarch;
115
 
116
    /** Architecture specific content. */
117
    as_arch_t arch;
118
} as_t;
119
 
2089 decky 120
typedef struct {
756 jermar 121
    pte_t *(* page_table_create)(int flags);
1468 jermar 122
    void (* page_table_destroy)(pte_t *page_table);
1044 jermar 123
    void (* page_table_lock)(as_t *as, bool lock);
124
    void (* page_table_unlock)(as_t *as, bool unlock);
2089 decky 125
} as_operations_t;
756 jermar 126
 
2106 jermar 127
/**
128
 * This structure contains information associated with the shared address space
129
 * area.
130
 */
1424 jermar 131
typedef struct {
2106 jermar 132
    /** This lock must be acquired only when the as_area lock is held. */
133
    mutex_t lock;      
134
    /** This structure can be deallocated if refcount drops to 0. */
4692 svoboda 135
    size_t refcount;
2106 jermar 136
    /**
137
     * B+tree containing complete map of anonymous pages of the shared area.
138
     */
139
    btree_t pagemap;
1424 jermar 140
} share_info_t;
1409 jermar 141
 
2089 decky 142
/** Page fault access type. */
143
typedef enum {
144
    PF_ACCESS_READ,
145
    PF_ACCESS_WRITE,
146
    PF_ACCESS_EXEC
147
} pf_access_t;
1424 jermar 148
 
2089 decky 149
struct mem_backend;
150
 
1424 jermar 151
/** Backend data stored in address space area. */
2089 decky 152
typedef union mem_backend_data {
1425 jermar 153
    struct {    /**< elf_backend members */
154
        elf_header_t *elf;
155
        elf_segment_header_t *segment;
156
    };
157
    struct {    /**< phys_backend members */
1780 jermar 158
        uintptr_t base;
4692 svoboda 159
        size_t frames;
1425 jermar 160
    };
1424 jermar 161
} mem_backend_data_t;
162
 
1409 jermar 163
/** Address space area structure.
164
 *
165
 * Each as_area_t structure describes one contiguous area of virtual memory.
166
 */
2089 decky 167
typedef struct {
1409 jermar 168
    mutex_t lock;
2106 jermar 169
    /** Containing address space. */
170
    as_t *as;      
2107 jermar 171
    /**
172
     * Flags related to the memory represented by the address space area.
173
     */
2106 jermar 174
    int flags;
175
    /** Attributes related to the address space area itself. */
176
    int attributes;
177
    /** Size of this area in multiples of PAGE_SIZE. */
4692 svoboda 178
    size_t pages;
2106 jermar 179
    /** Base address of this area. */
180
    uintptr_t base;
181
    /** Map of used space. */
182
    btree_t used_space;
1409 jermar 183
 
2106 jermar 184
    /**
2107 jermar 185
     * If the address space area has been shared, this pointer will
186
     * reference the share info structure.
2106 jermar 187
     */
188
    share_info_t *sh_info;
189
 
190
    /** Memory backend backing this address space area. */
191
    struct mem_backend *backend;
192
 
1424 jermar 193
    /** Data to be used by the backend. */
194
    mem_backend_data_t backend_data;
2089 decky 195
} as_area_t;
1409 jermar 196
 
2089 decky 197
/** Address space area backend structure. */
198
typedef struct mem_backend {
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);
201
    void (* share)(as_area_t *area);
202
} mem_backend_t;
203
 
755 jermar 204
extern as_t *AS_KERNEL;
2125 decky 205
 
756 jermar 206
extern as_operations_t *as_operations;
823 jermar 207
extern link_t inactive_as_with_asid_head;
208
 
756 jermar 209
extern void as_init(void);
1468 jermar 210
 
756 jermar 211
extern as_t *as_create(int flags);
1468 jermar 212
extern void as_destroy(as_t *as);
2106 jermar 213
extern void as_switch(as_t *old_as, as_t *new_as);
1780 jermar 214
extern int as_page_fault(uintptr_t page, pf_access_t access, istate_t *istate);
1468 jermar 215
 
2106 jermar 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,
218
    mem_backend_data_t *backend_data);
1780 jermar 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);
221
int as_area_share(as_t *src_as, uintptr_t src_base, size_t acc_size,
2106 jermar 222
    as_t *dst_as, uintptr_t dst_base, int dst_flags_mask);
3425 svoboda 223
extern int as_area_change_flags(as_t *as, int flags, uintptr_t address);
3624 svoboda 224
extern as_area_t *find_area_and_lock(as_t *, uintptr_t);
1468 jermar 225
 
3624 svoboda 226
 
1409 jermar 227
extern int as_area_get_flags(as_area_t *area);
1423 jermar 228
extern bool as_area_check_access(as_area_t *area, pf_access_t access);
2556 jermar 229
extern size_t as_area_get_size(uintptr_t base);
3431 svoboda 230
 
231
#ifdef CONFIG_UDEBUG
3036 svoboda 232
extern int as_area_make_writeable(uintptr_t address);
3013 svoboda 233
extern int as_debug_write(uintptr_t va, void *data, size_t n);
3431 svoboda 234
#endif
235
 
4692 svoboda 236
extern int used_space_insert(as_area_t *a, uintptr_t page, size_t count);
237
extern int used_space_remove(as_area_t *a, uintptr_t page, size_t count);
1 jermar 238
 
1891 jermar 239
 
727 jermar 240
/* Interface to be implemented by architectures. */
1891 jermar 241
#ifndef as_constructor_arch
242
extern int as_constructor_arch(as_t *as, int flags);
243
#endif /* !def as_constructor_arch */
244
#ifndef as_destructor_arch
245
extern int as_destructor_arch(as_t *as);
246
#endif /* !def as_destructor_arch */
247
#ifndef as_create_arch
248
extern int as_create_arch(as_t *as, int flags);
249
#endif /* !def as_create_arch */
703 jermar 250
#ifndef as_install_arch
251
extern void as_install_arch(as_t *as);
252
#endif /* !def as_install_arch */
1890 jermar 253
#ifndef as_deinstall_arch
254
extern void as_deinstall_arch(as_t *as);
255
#endif /* !def as_deinstall_arch */
1 jermar 256
 
2089 decky 257
/* Backend declarations and functions. */
1409 jermar 258
extern mem_backend_t anon_backend;
259
extern mem_backend_t elf_backend;
1424 jermar 260
extern mem_backend_t phys_backend;
1409 jermar 261
 
3425 svoboda 262
/**
263
 * This flags is passed when running the loader, otherwise elf_load()
264
 * would return with a EE_LOADER error code.
265
 */
266
#define ELD_F_NONE  0
267
#define ELD_F_LOADER    1
2089 decky 268
 
3425 svoboda 269
extern unsigned int elf_load(elf_header_t *header, as_t *as, int flags);
270
 
1235 jermar 271
/* Address space area related syscalls. */
1780 jermar 272
extern unative_t sys_as_area_create(uintptr_t address, size_t size, int flags);
273
extern unative_t sys_as_area_resize(uintptr_t address, size_t size, int flags);
3425 svoboda 274
extern unative_t sys_as_area_change_flags(uintptr_t address, int flags);
1780 jermar 275
extern unative_t sys_as_area_destroy(uintptr_t address);
1235 jermar 276
 
1914 jermar 277
/* Introspection functions. */
278
extern void as_print(as_t *as);
279
 
1329 palkovsky 280
#endif /* KERNEL */
281
 
1 jermar 282
#endif
1702 cejka 283
 
1851 jermar 284
/** @}
1702 cejka 285
 */