WebSVN – HelenOS – Diff – /branches/dd/kernel/generic/include/mm/frame.h


/*
 * Copyright (c) 2005 Jakub Jermar
 * Copyright (c) 2005 Sergey Bondari
 * 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.
 */
 
/** @addtogroup genericmm
 * @{
 */
/** @file
 */
 
#ifndef KERN_FRAME_H_
#define KERN_FRAME_H_
 
#include <arch/types.h>
#include <adt/list.h>
#include <mm/buddy.h>
#include <synch/spinlock.h>
#include <arch/mm/page.h>
#include <arch/mm/frame.h>
 
#define ONE_FRAME    0
#define TWO_FRAMES   1
#define FOUR_FRAMES  2
 
 
#ifdef ARCH_STACK_FRAMES
    #define STACK_FRAMES  ARCH_STACK_FRAMES
#else
    #define STACK_FRAMES  ONE_FRAME
#endif
 
/** Maximum number of zones in the system. */
#define ZONES_MAX  32
 
typedef uint8_t frame_flags_t;
 
/** Convert the frame address to kernel VA. */
#define FRAME_KA          0x01
/** Do not panic and do not sleep on failure. */
#define FRAME_ATOMIC      0x02
/** Do not start reclaiming when no free memory. */
#define FRAME_NO_RECLAIM  0x04
 
typedef uint8_t zone_flags_t;
 
/** Available zone (free for allocation) */
#define ZONE_AVAILABLE  0x00
/** Zone is reserved (not available for allocation) */
#define ZONE_RESERVED   0x08
/** Zone is used by firmware (not available for allocation) */
#define ZONE_FIRMWARE   0x10
 
/** Currently there is no equivalent zone flags
    for frame flags */
#define FRAME_TO_ZONE_FLAGS(frame_flags)  0
 
typedef struct {
    size_t refcount;     /**< Tracking of shared frames */
    uint8_t buddy_order;  /**< Buddy system block order */
    link_t buddy_link;    /**< Link to the next free block inside
                               one order */
    void *parent;         /**< If allocated by slab, this points there */
} frame_t;
 
typedef struct {
    pfn_t base;                    /**< Frame_no of the first frame
                                        in the frames array */
    size_t count;                 /**< Size of zone */
    size_t free_count;            /**< Number of free frame_t
                                        structures */
    size_t busy_count;            /**< Number of busy frame_t
                                        structures */
    zone_flags_t flags;            /**< Type of the zone */
   
    frame_t *frames;               /**< Array of frame_t structures
                                        in this zone */
    buddy_system_t *buddy_system;  /**< Buddy system for the zone */
} zone_t;
 
/*
 * The zoneinfo.lock must be locked when accessing zoneinfo structure.
 * Some of the attributes in zone_t structures are 'read-only'
 */
typedef struct {
    SPINLOCK_DECLARE(lock);
    size_t count;
    zone_t info[ZONES_MAX];
} zones_t;
 
extern zones_t zones;
 
static inline uintptr_t PFN2ADDR(pfn_t frame)
{
    return (uintptr_t) (frame << FRAME_WIDTH);
}
 
static inline pfn_t ADDR2PFN(uintptr_t addr)
{
    return (pfn_t) (addr >> FRAME_WIDTH);
}
 
static inline size_t SIZE2FRAMES(size_t size)
{
    if (!size)
        return 0;
    return (size_t) ((size - 1) >> FRAME_WIDTH) + 1;
}
 
static inline size_t FRAMES2SIZE(size_t frames)
{
    return (size_t) (frames << FRAME_WIDTH);
}
 
static inline bool zone_flags_available(zone_flags_t flags)
{
    return ((flags & (ZONE_RESERVED | ZONE_FIRMWARE)) == 0);
}
 
#define IS_BUDDY_ORDER_OK(index, order) \
    ((~(((unative_t) -1) << (order)) & (index)) == 0)
#define IS_BUDDY_LEFT_BLOCK(zone, frame) \
    (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)
#define IS_BUDDY_RIGHT_BLOCK(zone, frame) \
    (((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)
#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) \
    (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)
#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) \
    (((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)
 
#define frame_alloc(order, flags) \
    frame_alloc_generic(order, flags, NULL)
 
extern void frame_init(void);
extern void *frame_alloc_generic(uint8_t, frame_flags_t, size_t *);
extern void frame_free(uintptr_t);
extern void frame_reference_add(pfn_t);
 
extern size_t find_zone(pfn_t frame, size_t count, size_t hint);
extern size_t zone_create(pfn_t, size_t, pfn_t, zone_flags_t);
extern void *frame_get_parent(pfn_t, size_t);
extern void frame_set_parent(pfn_t, void *, size_t);
extern void frame_mark_unavailable(pfn_t, size_t);
extern uintptr_t zone_conf_size(size_t);
extern bool zone_merge(size_t, size_t);
extern void zone_merge_all(void);
extern uint64_t zone_total_size(void);
 
/*
 * Console functions
 */
extern void zone_print_list(void);
extern void zone_print_one(size_t);
 
#endif
 
/** @}
 */
 

Rev 4055	Rev 4537
1	/*	1	/*
2	* Copyright (c) 2005 Jakub Jermar	2	* Copyright (c) 2005 Jakub Jermar
3	* Copyright (c) 2005 Sergey Bondari	3	* Copyright (c) 2005 Sergey Bondari
4	* All rights reserved.	4	* All rights reserved.
5	*	5	*
6	* Redistribution and use in source and binary forms, with or without	6	* Redistribution and use in source and binary forms, with or without
7	* modification, are permitted provided that the following conditions	7	* modification, are permitted provided that the following conditions
8	* are met:	8	* are met:
9	*	9	*
10	* - Redistributions of source code must retain the above copyright	10	* - Redistributions of source code must retain the above copyright
11	* notice, this list of conditions and the following disclaimer.	11	* notice, this list of conditions and the following disclaimer.
12	* - Redistributions in binary form must reproduce the above copyright	12	* - Redistributions in binary form must reproduce the above copyright
13	* notice, this list of conditions and the following disclaimer in the	13	* notice, this list of conditions and the following disclaimer in the
14	* documentation and/or other materials provided with the distribution.	14	* documentation and/or other materials provided with the distribution.
15	* - The name of the author may not be used to endorse or promote products	15	* - The name of the author may not be used to endorse or promote products
16	* derived from this software without specific prior written permission.	16	* derived from this software without specific prior written permission.
17	*	17	*
18	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	18	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	19	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	20	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	21	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	22	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	23	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	24	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	25	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	26	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	27	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28	*/	28	*/
29		29
30	/** @addtogroup genericmm	30	/** @addtogroup genericmm
31	* @{	31	* @{
32	*/	32	*/
33	/** @file	33	/** @file
34	*/	34	*/
35		35
36	#ifndef KERN_FRAME_H_	36	#ifndef KERN_FRAME_H_
37	#define KERN_FRAME_H_	37	#define KERN_FRAME_H_
38		38
39	#include <arch/types.h>	39	#include <arch/types.h>
40	#include <adt/list.h>	40	#include <adt/list.h>
41	#include <mm/buddy.h>	41	#include <mm/buddy.h>
42	#include <synch/spinlock.h>	42	#include <synch/spinlock.h>
43	#include <arch/mm/page.h>	43	#include <arch/mm/page.h>
44	#include <arch/mm/frame.h>	44	#include <arch/mm/frame.h>
45		45
46	#define ONE_FRAME 0	46	#define ONE_FRAME 0
47	#define TWO_FRAMES 1	47	#define TWO_FRAMES 1
48	#define FOUR_FRAMES 2	48	#define FOUR_FRAMES 2
49		49
50		50
51	#ifdef ARCH_STACK_FRAMES	51	#ifdef ARCH_STACK_FRAMES
52	#define STACK_FRAMES ARCH_STACK_FRAMES	52	#define STACK_FRAMES ARCH_STACK_FRAMES
53	#else	53	#else
54	#define STACK_FRAMES ONE_FRAME	54	#define STACK_FRAMES ONE_FRAME
55	#endif	55	#endif
56		56
57	/** Maximum number of zones in the system. */	57	/** Maximum number of zones in the system. */
58	#define ZONES_MAX 32	58	#define ZONES_MAX 32
59		59
60	typedef uint8_t frame_flags_t;	60	typedef uint8_t frame_flags_t;
61		61
62	/** Convert the frame address to kernel VA. */	62	/** Convert the frame address to kernel VA. */
63	#define FRAME_KA 0x01	63	#define FRAME_KA 0x01
64	/** Do not panic and do not sleep on failure. */	64	/** Do not panic and do not sleep on failure. */
65	#define FRAME_ATOMIC 0x02	65	#define FRAME_ATOMIC 0x02
66	/** Do not start reclaiming when no free memory. */	66	/** Do not start reclaiming when no free memory. */
67	#define FRAME_NO_RECLAIM 0x04	67	#define FRAME_NO_RECLAIM 0x04
68		68
69	typedef uint8_t zone_flags_t;	69	typedef uint8_t zone_flags_t;
70		70
71	/** Available zone (free for allocation) */	71	/** Available zone (free for allocation) */
72	#define ZONE_AVAILABLE 0x00	72	#define ZONE_AVAILABLE 0x00
73	/** Zone is reserved (not available for allocation) */	73	/** Zone is reserved (not available for allocation) */
74	#define ZONE_RESERVED 0x08	74	#define ZONE_RESERVED 0x08
75	/** Zone is used by firmware (not available for allocation) */	75	/** Zone is used by firmware (not available for allocation) */
76	#define ZONE_FIRMWARE 0x10	76	#define ZONE_FIRMWARE 0x10
77		77
78	/** Currently there is no equivalent zone flags	78	/** Currently there is no equivalent zone flags
79	for frame flags */	79	for frame flags */
80	#define FRAME_TO_ZONE_FLAGS(frame_flags) 0	80	#define FRAME_TO_ZONE_FLAGS(frame_flags) 0
81		81
82	typedef struct {	82	typedef struct {
83	count_t refcount; /*< Tracking of shared frames /	83	size_t refcount; /*< Tracking of shared frames /
84	uint8_t buddy_order; /*< Buddy system block order /	84	uint8_t buddy_order; /*< Buddy system block order /
85	link_t buddy_link; /**< Link to the next free block inside	85	link_t buddy_link; /**< Link to the next free block inside
86	one order */	86	one order */
87	void parent; /< If allocated by slab, this points there /	87	void parent; /< If allocated by slab, this points there /
88	} frame_t;	88	} frame_t;
89		89
90	typedef struct {	90	typedef struct {
91	pfn_t base; /**< Frame_no of the first frame	91	pfn_t base; /**< Frame_no of the first frame
92	in the frames array */	92	in the frames array */
93	count_t count; /*< Size of zone /	93	size_t count; /*< Size of zone /
94	count_t free_count; /**< Number of free frame_t	94	size_t free_count; /**< Number of free frame_t
95	structures */	95	structures */
96	count_t busy_count; /**< Number of busy frame_t	96	size_t busy_count; /**< Number of busy frame_t
97	structures */	97	structures */
98	zone_flags_t flags; /*< Type of the zone /	98	zone_flags_t flags; /*< Type of the zone /
99		99
100	frame_t frames; /*< Array of frame_t structures	100	frame_t frames; /*< Array of frame_t structures
101	in this zone */	101	in this zone */
102	buddy_system_t buddy_system; /< Buddy system for the zone /	102	buddy_system_t buddy_system; /< Buddy system for the zone /
103	} zone_t;	103	} zone_t;
104		104
105	/*	105	/*
106	* The zoneinfo.lock must be locked when accessing zoneinfo structure.	106	* The zoneinfo.lock must be locked when accessing zoneinfo structure.
107	* Some of the attributes in zone_t structures are 'read-only'	107	* Some of the attributes in zone_t structures are 'read-only'
108	*/	108	*/
109	typedef struct {	109	typedef struct {
110	SPINLOCK_DECLARE(lock);	110	SPINLOCK_DECLARE(lock);
111	count_t count;	111	size_t count;
112	zone_t info[ZONES_MAX];	112	zone_t info[ZONES_MAX];
113	} zones_t;	113	} zones_t;
114		114
115	extern zones_t zones;	115	extern zones_t zones;
116		116
117	static inline uintptr_t PFN2ADDR(pfn_t frame)	117	static inline uintptr_t PFN2ADDR(pfn_t frame)
118	{	118	{
119	return (uintptr_t) (frame << FRAME_WIDTH);	119	return (uintptr_t) (frame << FRAME_WIDTH);
120	}	120	}
121		121
122	static inline pfn_t ADDR2PFN(uintptr_t addr)	122	static inline pfn_t ADDR2PFN(uintptr_t addr)
123	{	123	{
124	return (pfn_t) (addr >> FRAME_WIDTH);	124	return (pfn_t) (addr >> FRAME_WIDTH);
125	}	125	}
126		126
127	static inline count_t SIZE2FRAMES(size_t size)	127	static inline size_t SIZE2FRAMES(size_t size)
128	{	128	{
129	if (!size)	129	if (!size)
130	return 0;	130	return 0;
131	return (count_t) ((size - 1) >> FRAME_WIDTH) + 1;	131	return (size_t) ((size - 1) >> FRAME_WIDTH) + 1;
132	}	132	}
133		133
134	static inline size_t FRAMES2SIZE(count_t frames)	134	static inline size_t FRAMES2SIZE(size_t frames)
135	{	135	{
136	return (size_t) (frames << FRAME_WIDTH);	136	return (size_t) (frames << FRAME_WIDTH);
137	}	137	}
138		138
139	static inline bool zone_flags_available(zone_flags_t flags)	139	static inline bool zone_flags_available(zone_flags_t flags)
140	{	140	{
141	return ((flags & (ZONE_RESERVED \| ZONE_FIRMWARE)) == 0);	141	return ((flags & (ZONE_RESERVED \| ZONE_FIRMWARE)) == 0);
142	}	142	}
143		143
144	#define IS_BUDDY_ORDER_OK(index, order) \	144	#define IS_BUDDY_ORDER_OK(index, order) \
145	((~(((unative_t) -1) << (order)) & (index)) == 0)	145	((~(((unative_t) -1) << (order)) & (index)) == 0)
146	#define IS_BUDDY_LEFT_BLOCK(zone, frame) \	146	#define IS_BUDDY_LEFT_BLOCK(zone, frame) \
147	(((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)	147	(((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)
148	#define IS_BUDDY_RIGHT_BLOCK(zone, frame) \	148	#define IS_BUDDY_RIGHT_BLOCK(zone, frame) \
149	(((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)	149	(((frame_index((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)
150	#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) \	150	#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) \
151	(((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)	151	(((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 0)
152	#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) \	152	#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) \
153	(((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)	153	(((frame_index_abs((zone), (frame)) >> (frame)->buddy_order) & 0x01) == 1)
154		154
155	#define frame_alloc(order, flags) \	155	#define frame_alloc(order, flags) \
156	frame_alloc_generic(order, flags, NULL)	156	frame_alloc_generic(order, flags, NULL)
157		157
158	extern void frame_init(void);	158	extern void frame_init(void);
159	extern void frame_alloc_generic(uint8_t, frame_flags_t, count_t );	159	extern void frame_alloc_generic(uint8_t, frame_flags_t, size_t );
160	extern void frame_free(uintptr_t);	160	extern void frame_free(uintptr_t);
161	extern void frame_reference_add(pfn_t);	161	extern void frame_reference_add(pfn_t);
162		162
163	extern count_t find_zone(pfn_t frame, count_t count, count_t hint);	163	extern size_t find_zone(pfn_t frame, size_t count, size_t hint);
164	extern count_t zone_create(pfn_t, count_t, pfn_t, zone_flags_t);	164	extern size_t zone_create(pfn_t, size_t, pfn_t, zone_flags_t);
165	extern void *frame_get_parent(pfn_t, count_t);	165	extern void *frame_get_parent(pfn_t, size_t);
166	extern void frame_set_parent(pfn_t, void *, count_t);	166	extern void frame_set_parent(pfn_t, void *, size_t);
167	extern void frame_mark_unavailable(pfn_t, count_t);	167	extern void frame_mark_unavailable(pfn_t, size_t);
168	extern uintptr_t zone_conf_size(count_t);	168	extern uintptr_t zone_conf_size(size_t);
169	extern bool zone_merge(count_t, count_t);	169	extern bool zone_merge(size_t, size_t);
170	extern void zone_merge_all(void);	170	extern void zone_merge_all(void);
171	extern uint64_t zone_total_size(void);	171	extern uint64_t zone_total_size(void);
172		172
173	/*	173	/*
174	* Console functions	174	* Console functions
175	*/	175	*/
176	extern void zone_print_list(void);	176	extern void zone_print_list(void);
177	extern void zone_print_one(count_t);	177	extern void zone_print_one(size_t);
178		178
179	#endif	179	#endif
180		180
181	/** @}	181	/** @}
182	*/	182	*/
183		183

Subversion Repositories HelenOS

(root)/branches/dd/kernel/generic/include/mm/frame.h – Rev 4055 → 4537