Subversion Repositories HelenOS-historic

Rev

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

Rev Author Line No. Line
1 jermar 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
 
703 jermar 29
#ifndef __AS_H__
30
#define __AS_H__
1 jermar 31
 
1329 palkovsky 32
/** Address space area flags. */
1424 jermar 33
#define AS_AREA_READ        1
34
#define AS_AREA_WRITE       2
35
#define AS_AREA_EXEC        4
36
#define AS_AREA_CACHEABLE   8
1329 palkovsky 37
 
38
#ifdef KERNEL
39
 
121 jermar 40
#include <arch/mm/page.h>
703 jermar 41
#include <arch/mm/as.h>
391 jermar 42
#include <arch/mm/asid.h>
1 jermar 43
#include <arch/types.h>
44
#include <typedefs.h>
45
#include <synch/spinlock.h>
1380 jermar 46
#include <synch/mutex.h>
788 jermar 47
#include <adt/list.h>
1147 jermar 48
#include <adt/btree.h>
1425 jermar 49
#include <elf.h>
1 jermar 50
 
1070 jermar 51
/** Defined to be true if user address space and kernel address space shadow each other. */
52
#define KERNEL_ADDRESS_SPACE_SHADOWED   KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
53
 
1 jermar 54
#define KERNEL_ADDRESS_SPACE_START  KERNEL_ADDRESS_SPACE_START_ARCH
55
#define KERNEL_ADDRESS_SPACE_END    KERNEL_ADDRESS_SPACE_END_ARCH
56
#define USER_ADDRESS_SPACE_START    USER_ADDRESS_SPACE_START_ARCH
57
#define USER_ADDRESS_SPACE_END      USER_ADDRESS_SPACE_END_ARCH
58
 
59
#define IS_KA(addr) ((addr)>=KERNEL_ADDRESS_SPACE_START && (addr)<=KERNEL_ADDRESS_SPACE_END)
60
 
61
#define USTACK_ADDRESS  USTACK_ADDRESS_ARCH
62
 
778 palkovsky 63
#define FLAG_AS_KERNEL      (1 << 0)    /**< Kernel address space. */
727 jermar 64
 
703 jermar 65
/** Address space structure.
66
 *
67
 * as_t contains the list of as_areas of userspace accessible
1 jermar 68
 * pages for one or more tasks. Ranges of kernel memory pages are not
69
 * supposed to figure in the list as they are shared by all tasks and
70
 * set up during system initialization.
71
 */
703 jermar 72
struct as {
1380 jermar 73
    /** Protected by asidlock. */
823 jermar 74
    link_t inactive_as_with_asid_link;
727 jermar 75
 
1380 jermar 76
    mutex_t lock;
823 jermar 77
 
1468 jermar 78
    /** Number of references (i.e tasks that reference this as). */
79
    count_t refcount;
80
 
823 jermar 81
    /** Number of processors on wich is this address space active. */
1415 jermar 82
    count_t cpu_refcount;
823 jermar 83
 
1149 jermar 84
    /** B+tree of address space areas. */
1147 jermar 85
    btree_t as_area_btree;
756 jermar 86
 
87
    /** Page table pointer. Constant on architectures that use global page hash table. */
88
    pte_t *page_table;
89
 
90
    /** Address space identifier. Constant on architectures that do not support ASIDs.*/
91
    asid_t asid;
1 jermar 92
};
93
 
756 jermar 94
struct as_operations {
95
    pte_t *(* page_table_create)(int flags);
1468 jermar 96
    void (* page_table_destroy)(pte_t *page_table);
1044 jermar 97
    void (* page_table_lock)(as_t *as, bool lock);
98
    void (* page_table_unlock)(as_t *as, bool unlock);
756 jermar 99
};
100
typedef struct as_operations as_operations_t;
101
 
1409 jermar 102
/** Address space area attributes. */
103
#define AS_AREA_ATTR_NONE   0
104
#define AS_AREA_ATTR_PARTIAL    1   /**< Not fully initialized area. */
105
 
106
#define AS_PF_FAULT     0   /**< The page fault was not resolved by as_page_fault(). */
107
#define AS_PF_OK        1   /**< The page fault was resolved by as_page_fault(). */
108
#define AS_PF_DEFER     2   /**< The page fault was caused by memcpy_from_uspace()
109
                         or memcpy_to_uspace(). */
110
 
1424 jermar 111
/** This structure contains information associated with the shared address space area. */
112
typedef struct {
113
    mutex_t lock;       /**< This lock must be acquired only when the as_area lock is held. */
114
    count_t refcount;   /**< This structure can be deallocated if refcount drops to 0. */
115
    btree_t pagemap;    /**< B+tree containing complete map of anonymous pages of the shared area. */
116
} share_info_t;
1409 jermar 117
 
1424 jermar 118
/** Address space area backend structure. */
119
typedef struct {
120
    int (* page_fault)(as_area_t *area, __address addr, pf_access_t access);
121
    void (* frame_free)(as_area_t *area, __address page, __address frame);
122
    void (* share)(as_area_t *area);
123
} mem_backend_t;
124
 
125
/** Backend data stored in address space area. */
1425 jermar 126
typedef union {
127
    struct {    /**< elf_backend members */
128
        elf_header_t *elf;
129
        elf_segment_header_t *segment;
130
    };
131
    struct {    /**< phys_backend members */
132
        __address base;
133
        count_t frames;
134
    };
1424 jermar 135
} mem_backend_data_t;
136
 
1409 jermar 137
/** Address space area structure.
138
 *
139
 * Each as_area_t structure describes one contiguous area of virtual memory.
140
 * In the future, it should not be difficult to support shared areas.
141
 */
142
struct as_area {
143
    mutex_t lock;
1424 jermar 144
    as_t *as;       /**< Containing address space. */
1409 jermar 145
    int flags;      /**< Flags related to the memory represented by the address space area. */
146
    int attributes;     /**< Attributes related to the address space area itself. */
147
    count_t pages;      /**< Size of this area in multiples of PAGE_SIZE. */
148
    __address base;     /**< Base address of this area. */
149
    btree_t used_space; /**< Map of used space. */
150
    share_info_t *sh_info;  /**< If the address space area has been shared, this pointer will
1424 jermar 151
                         reference the share info structure. */
1409 jermar 152
    mem_backend_t *backend; /**< Memory backend backing this address space area. */
153
 
1424 jermar 154
    /** Data to be used by the backend. */
155
    mem_backend_data_t backend_data;
1409 jermar 156
};
157
 
755 jermar 158
extern as_t *AS_KERNEL;
756 jermar 159
extern as_operations_t *as_operations;
755 jermar 160
 
1415 jermar 161
extern spinlock_t inactive_as_with_asid_lock;
823 jermar 162
extern link_t inactive_as_with_asid_head;
163
 
756 jermar 164
extern void as_init(void);
1468 jermar 165
 
756 jermar 166
extern as_t *as_create(int flags);
1468 jermar 167
extern void as_destroy(as_t *as);
168
extern void as_switch(as_t *old, as_t *new);
169
extern int as_page_fault(__address page, pf_access_t access, istate_t *istate);
170
 
1409 jermar 171
extern as_area_t *as_area_create(as_t *as, int flags, size_t size, __address base, int attrs,
1424 jermar 172
    mem_backend_t *backend, mem_backend_data_t *backend_data);
1468 jermar 173
extern int as_area_destroy(as_t *as, __address address);   
1306 jermar 174
extern int as_area_resize(as_t *as, __address address, size_t size, int flags);
1468 jermar 175
int as_area_share(as_t *src_as, __address src_base, size_t acc_size,
176
          as_t *dst_as, __address dst_base, int dst_flags_mask);
177
 
1409 jermar 178
extern int as_area_get_flags(as_area_t *area);
1423 jermar 179
extern bool as_area_check_access(as_area_t *area, pf_access_t access);
1329 palkovsky 180
extern size_t as_get_size(__address base);
1409 jermar 181
extern int used_space_insert(as_area_t *a, __address page, count_t count);
182
extern int used_space_remove(as_area_t *a, __address page, count_t count);
1 jermar 183
 
727 jermar 184
/* Interface to be implemented by architectures. */
703 jermar 185
#ifndef as_install_arch
186
extern void as_install_arch(as_t *as);
187
#endif /* !def as_install_arch */
1 jermar 188
 
1409 jermar 189
/* Backend declarations. */
190
extern mem_backend_t anon_backend;
191
extern mem_backend_t elf_backend;
1424 jermar 192
extern mem_backend_t phys_backend;
1409 jermar 193
 
1235 jermar 194
/* Address space area related syscalls. */
195
extern __native sys_as_area_create(__address address, size_t size, int flags);
196
extern __native sys_as_area_resize(__address address, size_t size, int flags);
1306 jermar 197
extern __native sys_as_area_destroy(__address address);
1235 jermar 198
 
1329 palkovsky 199
#endif /* KERNEL */
200
 
1 jermar 201
#endif