WebSVN – HelenOS-historic – Diff – /kernel/trunk/generic/include/mm/as.h


/*
 * Copyright (C) 2001-2004 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __AS_H__
#define __AS_H__
 
/** Address space area flags. */
#define AS_AREA_READ    1
#define AS_AREA_WRITE   2
#define AS_AREA_EXEC    4
#define AS_AREA_DEVICE  8
#define AS_AREA_ANON    16
 
#ifdef KERNEL
 
#include <arch/mm/page.h>
#include <arch/mm/as.h>
#include <arch/mm/asid.h>
#include <arch/types.h>
#include <typedefs.h>
#include <synch/spinlock.h>
#include <synch/mutex.h>
#include <adt/list.h>
#include <adt/btree.h>
 
/** Defined to be true if user address space and kernel address space shadow each other. */
#define KERNEL_ADDRESS_SPACE_SHADOWED   KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
 
#define KERNEL_ADDRESS_SPACE_START  KERNEL_ADDRESS_SPACE_START_ARCH
#define KERNEL_ADDRESS_SPACE_END    KERNEL_ADDRESS_SPACE_END_ARCH
#define USER_ADDRESS_SPACE_START    USER_ADDRESS_SPACE_START_ARCH
#define USER_ADDRESS_SPACE_END      USER_ADDRESS_SPACE_END_ARCH
 
#define IS_KA(addr) ((addr)>=KERNEL_ADDRESS_SPACE_START && (addr)<=KERNEL_ADDRESS_SPACE_END)
 
#define USTACK_ADDRESS  USTACK_ADDRESS_ARCH
 
#define FLAG_AS_KERNEL      (1 << 0)    /**< Kernel address space. */
 
/** Address space structure.
 *
 * as_t contains the list of as_areas of userspace accessible
 * pages for one or more tasks. Ranges of kernel memory pages are not
 * supposed to figure in the list as they are shared by all tasks and
 * set up during system initialization.
 */
struct as {
    /** Protected by asidlock. */
    link_t inactive_as_with_asid_link;
 
    mutex_t lock;
 
    /** Number of processors on wich is this address space active. */
    count_t cpu_refcount;
 
    /** B+tree of address space areas. */
    btree_t as_area_btree;
 
    /** Page table pointer. Constant on architectures that use global page hash table. */
    pte_t *page_table;
 
    /** Address space identifier. Constant on architectures that do not support ASIDs.*/
    asid_t asid;
};
 
struct as_operations {
    pte_t *(* page_table_create)(int flags);
    void (* page_table_lock)(as_t *as, bool lock);
    void (* page_table_unlock)(as_t *as, bool unlock);
};
typedef struct as_operations as_operations_t;
 
/** Address space area attributes. */
#define AS_AREA_ATTR_NONE   0
#define AS_AREA_ATTR_PARTIAL    1   /**< Not fully initialized area. */
 
#define AS_PF_FAULT     0   /**< The page fault was not resolved by as_page_fault(). */
#define AS_PF_OK        1   /**< The page fault was resolved by as_page_fault(). */
#define AS_PF_DEFER     2   /**< The page fault was caused by memcpy_from_uspace()
                         or memcpy_to_uspace(). */
 
typedef struct share_info share_info_t;
typedef struct mem_backend mem_backend_t;
 
/** Address space area structure.
 *
 * Each as_area_t structure describes one contiguous area of virtual memory.
 * In the future, it should not be difficult to support shared areas.
 */
struct as_area {
    mutex_t lock;
    int flags;      /**< Flags related to the memory represented by the address space area. */
    int attributes;     /**< Attributes related to the address space area itself. */
    count_t pages;      /**< Size of this area in multiples of PAGE_SIZE. */
    __address base;     /**< Base address of this area. */
    btree_t used_space; /**< Map of used space. */
    share_info_t *sh_info;  /**< If the address space area has been shared, this pointer will
                     reference the share info structure. */
    mem_backend_t *backend; /**< Memory backend backing this address space area. */
    void *backend_data[2];  /**< Data to be used by the backend. */
};
 
/** Address space area backend structure. */
struct mem_backend {
    int (* backend_page_fault)(as_area_t *area, __address addr, pf_access_t access);
    void (* backend_frame_free)(as_area_t *area, __address page, __address frame);
};
 
extern as_t *AS_KERNEL;
extern as_operations_t *as_operations;
 
extern spinlock_t inactive_as_with_asid_lock;
extern link_t inactive_as_with_asid_head;
 
extern void as_init(void);
extern as_t *as_create(int flags);
extern as_area_t *as_area_create(as_t *as, int flags, size_t size, __address base, int attrs,
    mem_backend_t *backend, void **backend_data);
extern int as_area_resize(as_t *as, __address address, size_t size, int flags);
extern int as_area_destroy(as_t *as, __address address);
extern int as_area_get_flags(as_area_t *area);
extern void as_set_mapping(as_t *as, __address page, __address frame);
extern bool as_area_check_access(as_area_t *area, pf_access_t access);
extern int as_page_fault(__address page, pf_access_t access, istate_t *istate);
extern void as_switch(as_t *old, as_t *new);
extern void as_free(as_t *as);
extern int as_area_share(as_t *src_as, __address src_base, size_t acc_size,
    __address dst_base, int dst_flags_mask);
extern size_t as_get_size(__address base);
extern int used_space_insert(as_area_t *a, __address page, count_t count);
extern int used_space_remove(as_area_t *a, __address page, count_t count);
 
/* Interface to be implemented by architectures. */
#ifndef as_install_arch
extern void as_install_arch(as_t *as);
#endif /* !def as_install_arch */
 
/* Backend declarations. */
extern mem_backend_t anon_backend;
extern mem_backend_t elf_backend;
 
/* Address space area related syscalls. */
extern __native sys_as_area_create(__address address, size_t size, int flags);
extern __native sys_as_area_resize(__address address, size_t size, int flags);
extern __native sys_as_area_destroy(__address address);
 
#endif /* KERNEL */
 
#endif
 

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/mm/as.h – Rev 1417 → 1423

Rev 1417		Rev 1423
1	/*	1	/*
2	* Copyright (C) 2001-2004 Jakub Jermar	2	* Copyright (C) 2001-2004 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	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	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.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	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	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	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	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	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	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.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	#ifndef __AS_H__	29	#ifndef __AS_H__
30	#define __AS_H__	30	#define __AS_H__
31		31
32	/** Address space area flags. */	32	/** Address space area flags. */
33	#define AS_AREA_READ 1	33	#define AS_AREA_READ 1
34	#define AS_AREA_WRITE 2	34	#define AS_AREA_WRITE 2
35	#define AS_AREA_EXEC 4	35	#define AS_AREA_EXEC 4
36	#define AS_AREA_DEVICE 8	36	#define AS_AREA_DEVICE 8
37	#define AS_AREA_ANON 16	37	#define AS_AREA_ANON 16
38		38
39	#ifdef KERNEL	39	#ifdef KERNEL
40		40
41	#include <arch/mm/page.h>	41	#include <arch/mm/page.h>
42	#include <arch/mm/as.h>	42	#include <arch/mm/as.h>
43	#include <arch/mm/asid.h>	43	#include <arch/mm/asid.h>
44	#include <arch/types.h>	44	#include <arch/types.h>
45	#include <typedefs.h>	45	#include <typedefs.h>
46	#include <synch/spinlock.h>	46	#include <synch/spinlock.h>
47	#include <synch/mutex.h>	47	#include <synch/mutex.h>
48	#include <adt/list.h>	48	#include <adt/list.h>
49	#include <adt/btree.h>	49	#include <adt/btree.h>
50		50
51	/** Defined to be true if user address space and kernel address space shadow each other. */	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	52	#define KERNEL_ADDRESS_SPACE_SHADOWED KERNEL_ADDRESS_SPACE_SHADOWED_ARCH
53		53
54	#define KERNEL_ADDRESS_SPACE_START KERNEL_ADDRESS_SPACE_START_ARCH	54	#define KERNEL_ADDRESS_SPACE_START KERNEL_ADDRESS_SPACE_START_ARCH
55	#define KERNEL_ADDRESS_SPACE_END KERNEL_ADDRESS_SPACE_END_ARCH	55	#define KERNEL_ADDRESS_SPACE_END KERNEL_ADDRESS_SPACE_END_ARCH
56	#define USER_ADDRESS_SPACE_START USER_ADDRESS_SPACE_START_ARCH	56	#define USER_ADDRESS_SPACE_START USER_ADDRESS_SPACE_START_ARCH
57	#define USER_ADDRESS_SPACE_END USER_ADDRESS_SPACE_END_ARCH	57	#define USER_ADDRESS_SPACE_END USER_ADDRESS_SPACE_END_ARCH
58		58
59	#define IS_KA(addr) ((addr)>=KERNEL_ADDRESS_SPACE_START && (addr)<=KERNEL_ADDRESS_SPACE_END)	59	#define IS_KA(addr) ((addr)>=KERNEL_ADDRESS_SPACE_START && (addr)<=KERNEL_ADDRESS_SPACE_END)
60		60
61	#define USTACK_ADDRESS USTACK_ADDRESS_ARCH	61	#define USTACK_ADDRESS USTACK_ADDRESS_ARCH
62		62
63	#define FLAG_AS_KERNEL (1 << 0) /*< Kernel address space. /	63	#define FLAG_AS_KERNEL (1 << 0) /*< Kernel address space. /
64		64
65	/** Address space structure.	65	/** Address space structure.
66	*	66	*
67	* as_t contains the list of as_areas of userspace accessible	67	* as_t contains the list of as_areas of userspace accessible
68	* pages for one or more tasks. Ranges of kernel memory pages are not	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	69	* supposed to figure in the list as they are shared by all tasks and
70	* set up during system initialization.	70	* set up during system initialization.
71	*/	71	*/
72	struct as {	72	struct as {
73	/** Protected by asidlock. */	73	/** Protected by asidlock. */
74	link_t inactive_as_with_asid_link;	74	link_t inactive_as_with_asid_link;
75		75
76	mutex_t lock;	76	mutex_t lock;
77		77
78	/** Number of processors on wich is this address space active. */	78	/** Number of processors on wich is this address space active. */
79	count_t cpu_refcount;	79	count_t cpu_refcount;
80		80
81	/** B+tree of address space areas. */	81	/** B+tree of address space areas. */
82	btree_t as_area_btree;	82	btree_t as_area_btree;
83		83
84	/** Page table pointer. Constant on architectures that use global page hash table. */	84	/** Page table pointer. Constant on architectures that use global page hash table. */
85	pte_t *page_table;	85	pte_t *page_table;
86		86
87	/** Address space identifier. Constant on architectures that do not support ASIDs.*/	87	/** Address space identifier. Constant on architectures that do not support ASIDs.*/
88	asid_t asid;	88	asid_t asid;
89	};	89	};
90		90
91	struct as_operations {	91	struct as_operations {
92	pte_t ( page_table_create)(int flags);	92	pte_t ( page_table_create)(int flags);
93	void (* page_table_lock)(as_t *as, bool lock);	93	void (* page_table_lock)(as_t *as, bool lock);
94	void (* page_table_unlock)(as_t *as, bool unlock);	94	void (* page_table_unlock)(as_t *as, bool unlock);
95	};	95	};
96	typedef struct as_operations as_operations_t;	96	typedef struct as_operations as_operations_t;
97		97
98	/** Address space area attributes. */	98	/** Address space area attributes. */
99	#define AS_AREA_ATTR_NONE 0	99	#define AS_AREA_ATTR_NONE 0
100	#define AS_AREA_ATTR_PARTIAL 1 /*< Not fully initialized area. /	100	#define AS_AREA_ATTR_PARTIAL 1 /*< Not fully initialized area. /
101		101
102	#define AS_PF_FAULT 0 /*< The page fault was not resolved by as_page_fault(). /	102	#define AS_PF_FAULT 0 /*< The page fault was not resolved by as_page_fault(). /
103	#define AS_PF_OK 1 /*< The page fault was resolved by as_page_fault(). /	103	#define AS_PF_OK 1 /*< The page fault was resolved by as_page_fault(). /
104	#define AS_PF_DEFER 2 /**< The page fault was caused by memcpy_from_uspace()	104	#define AS_PF_DEFER 2 /**< The page fault was caused by memcpy_from_uspace()
105	or memcpy_to_uspace(). */	105	or memcpy_to_uspace(). */
106		106
107	typedef struct share_info share_info_t;	107	typedef struct share_info share_info_t;
108	typedef struct mem_backend mem_backend_t;	108	typedef struct mem_backend mem_backend_t;
109		109
110	/** Address space area structure.	110	/** Address space area structure.
111	*	111	*
112	* Each as_area_t structure describes one contiguous area of virtual memory.	112	* Each as_area_t structure describes one contiguous area of virtual memory.
113	* In the future, it should not be difficult to support shared areas.	113	* In the future, it should not be difficult to support shared areas.
114	*/	114	*/
115	struct as_area {	115	struct as_area {
116	mutex_t lock;	116	mutex_t lock;
117	int flags; /*< Flags related to the memory represented by the address space area. /	117	int flags; /*< Flags related to the memory represented by the address space area. /
118	int attributes; /*< Attributes related to the address space area itself. /	118	int attributes; /*< Attributes related to the address space area itself. /
119	count_t pages; /*< Size of this area in multiples of PAGE_SIZE. /	119	count_t pages; /*< Size of this area in multiples of PAGE_SIZE. /
120	__address base; /*< Base address of this area. /	120	__address base; /*< Base address of this area. /
121	btree_t used_space; /*< Map of used space. /	121	btree_t used_space; /*< Map of used space. /
122	share_info_t sh_info; /*< If the address space area has been shared, this pointer will	122	share_info_t sh_info; /*< If the address space area has been shared, this pointer will
123	reference the share info structure. */	123	reference the share info structure. */
124	mem_backend_t backend; /< Memory backend backing this address space area. /	124	mem_backend_t backend; /< Memory backend backing this address space area. /
125	void backend_data[2]; /< Data to be used by the backend. /	125	void backend_data[2]; /< Data to be used by the backend. /
126	};	126	};
127		127
128	/** Address space area backend structure. */	128	/** Address space area backend structure. */
129	struct mem_backend {	129	struct mem_backend {
130	int (* backend_page_fault)(as_area_t *area, __address addr, pf_access_t access);	130	int (* backend_page_fault)(as_area_t *area, __address addr, pf_access_t access);
131	void (* backend_frame_free)(as_area_t *area, __address page, __address frame);	131	void (* backend_frame_free)(as_area_t *area, __address page, __address frame);
132	};	132	};
133		133
134	extern as_t *AS_KERNEL;	134	extern as_t *AS_KERNEL;
135	extern as_operations_t *as_operations;	135	extern as_operations_t *as_operations;
136		136
137	extern spinlock_t inactive_as_with_asid_lock;	137	extern spinlock_t inactive_as_with_asid_lock;
138	extern link_t inactive_as_with_asid_head;	138	extern link_t inactive_as_with_asid_head;
139		139
140	extern void as_init(void);	140	extern void as_init(void);
141	extern as_t *as_create(int flags);	141	extern as_t *as_create(int flags);
142	extern as_area_t as_area_create(as_t as, int flags, size_t size, __address base, int attrs,	142	extern as_area_t as_area_create(as_t as, int flags, size_t size, __address base, int attrs,
143	mem_backend_t backend, void *backend_data);	143	mem_backend_t backend, void *backend_data);
144	extern int as_area_resize(as_t *as, __address address, size_t size, int flags);	144	extern int as_area_resize(as_t *as, __address address, size_t size, int flags);
145	extern int as_area_destroy(as_t *as, __address address);	145	extern int as_area_destroy(as_t *as, __address address);
146	extern int as_area_get_flags(as_area_t *area);	146	extern int as_area_get_flags(as_area_t *area);
147	extern void as_set_mapping(as_t *as, __address page, __address frame);	147	extern void as_set_mapping(as_t *as, __address page, __address frame);
-		148	extern bool as_area_check_access(as_area_t *area, pf_access_t access);
148	extern int as_page_fault(__address page, pf_access_t access, istate_t *istate);	149	extern int as_page_fault(__address page, pf_access_t access, istate_t *istate);
149	extern void as_switch(as_t old, as_t new);	150	extern void as_switch(as_t old, as_t new);
150	extern void as_free(as_t *as);	151	extern void as_free(as_t *as);
151	extern int as_area_share(as_t *src_as, __address src_base, size_t acc_size,	152	extern int as_area_share(as_t *src_as, __address src_base, size_t acc_size,
152	__address dst_base, int dst_flags_mask);	153	__address dst_base, int dst_flags_mask);
153	extern size_t as_get_size(__address base);	154	extern size_t as_get_size(__address base);
154	extern int used_space_insert(as_area_t *a, __address page, count_t count);	155	extern int used_space_insert(as_area_t *a, __address page, count_t count);
155	extern int used_space_remove(as_area_t *a, __address page, count_t count);	156	extern int used_space_remove(as_area_t *a, __address page, count_t count);
156		157
157	/* Interface to be implemented by architectures. */	158	/* Interface to be implemented by architectures. */
158	#ifndef as_install_arch	159	#ifndef as_install_arch
159	extern void as_install_arch(as_t *as);	160	extern void as_install_arch(as_t *as);
160	#endif /* !def as_install_arch */	161	#endif /* !def as_install_arch */
161		162
162	/* Backend declarations. */	163	/* Backend declarations. */
163	extern mem_backend_t anon_backend;	164	extern mem_backend_t anon_backend;
164	extern mem_backend_t elf_backend;	165	extern mem_backend_t elf_backend;
165		166
166	/* Address space area related syscalls. */	167	/* Address space area related syscalls. */
167	extern __native sys_as_area_create(__address address, size_t size, int flags);	168	extern __native sys_as_area_create(__address address, size_t size, int flags);
168	extern __native sys_as_area_resize(__address address, size_t size, int flags);	169	extern __native sys_as_area_resize(__address address, size_t size, int flags);
169	extern __native sys_as_area_destroy(__address address);	170	extern __native sys_as_area_destroy(__address address);
170		171
171	#endif /* KERNEL */	172	#endif /* KERNEL */
172		173
173	#endif	174	#endif
174		175