WebSVN – HelenOS-historic – Diff – /kernel/trunk/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.
 */
 
#ifndef __FRAME_H__
#define __FRAME_H__
 
#include <arch/types.h>
#include <typedefs.h>
#include <list.h>
#include <synch/spinlock.h>
#include <mm/buddy.h>
#include <mm/slab.h>
 
#define ONE_FRAME   0
 
#define FRAME_KA        0x1 /* skip frames conflicting with user address space */
#define FRAME_PANIC     0x2 /* panic on failure */
#define FRAME_ATOMIC            0x4 /* do not panic and do not sleep on failure */
#define FRAME_NO_RECLAIM        0x8     /* Do not start reclaiming when no free memory */
 
#define FRAME_OK        0   /* frame_alloc return status */
#define FRAME_NO_MEMORY     1   /* frame_alloc return status */
#define FRAME_ERROR     2   /* frame_alloc return status */
 
#define FRAME2ADDR(zone, frame)         ((zone)->base + ((frame) - (zone)->frames) * FRAME_SIZE)
#define ADDR2FRAME(zone, addr)          (&((zone)->frames[((addr) - (zone)->base) / FRAME_SIZE]))
#define FRAME_INDEX(zone, frame)        ((index_t)((frame) - (zone)->frames))
#define FRAME_INDEX_ABS(zone, frame)        (((index_t)((frame) - (zone)->frames)) + (zone)->base_index)
#define FRAME_INDEX_VALID(zone, index)      (((index) >= 0) && ((index) < ((zone)->free_count + (zone)->busy_count)))
#define IS_BUDDY_ORDER_OK(index, order)     ((~(((__native) -1) << (order)) & (index)) == 0)
#define IS_BUDDY_LEFT_BLOCK(zone, frame)    (((FRAME_INDEX((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
#define IS_BUDDY_RIGHT_BLOCK(zone, frame)   (((FRAME_INDEX((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame)    (((FRAME_INDEX_ABS((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame)   (((FRAME_INDEX_ABS((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
 
#define ZONE_BLACKLIST_SIZE 4
 
struct zone {
    link_t link;        /**< link to previous and next zone */
 
    SPINLOCK_DECLARE(lock); /**< this lock protects everything below */
    __address base;     /**< physical address of the first frame in the frames array */
    index_t base_index; /**< frame index offset of the zone base */
    frame_t *frames;    /**< array of frame_t structures in this zone */
    count_t free_count; /**< number of free frame_t structures */
    count_t busy_count; /**< number of busy frame_t structures */
   
    buddy_system_t * buddy_system; /**< buddy system for the zone */
    int flags;
};
 
struct frame {
    count_t refcount;   /**< tracking of shared frames  */
    __u8 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 */
};
 
struct region {
    __address base;
    size_t size;
};
 
extern region_t zone_blacklist[];
extern count_t zone_blacklist_count;
extern void frame_region_not_free(__address base, size_t size);
extern void zone_create_in_region(__address base, size_t size);
 
extern spinlock_t zone_head_lock;   /**< this lock protects zone_head list */
extern link_t zone_head;        /**< list of all zones in the system */
 
extern zone_t *zone_create(__address start, size_t size, int flags);
extern void zone_attach(zone_t *zone);
 
extern void frame_init(void);
extern void frame_initialize(frame_t *frame, zone_t *zone);
 
__address frame_alloc(int flags, __u8 order, int * status, zone_t **pzone);
extern void frame_free(__address addr);
 
zone_t * get_zone_by_frame(frame_t * frame);
 
/*
 * Buddy system operations
 */
link_t * zone_buddy_find_buddy(buddy_system_t *b, link_t * buddy);
link_t * zone_buddy_bisect(buddy_system_t *b, link_t * block);
link_t * zone_buddy_coalesce(buddy_system_t *b, link_t * buddy_l, link_t * buddy_r);
void zone_buddy_set_order(buddy_system_t *b, link_t * block, __u8 order);
__u8 zone_buddy_get_order(buddy_system_t *b, link_t * block);
void zone_buddy_mark_busy(buddy_system_t *b, link_t * block);
extern frame_t * frame_addr2frame(__address addr);
 
/*
 * TODO: Implement the following functions.
 */
extern frame_t *frame_reference(frame_t *frame);
extern void frame_release(frame_t *frame);
 
 
/*
 * Console functions
 */
extern void zone_print_list(void);
extern void zone_print_one(__address base);
 
#endif
 

Subversion Repositories HelenOS-historic

(root)/kernel/trunk/generic/include/mm/frame.h – Rev 759 → 762

Rev 759		Rev 762
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	#ifndef __FRAME_H__	30	#ifndef __FRAME_H__
31	#define __FRAME_H__	31	#define __FRAME_H__
32		32
33	#include <arch/types.h>	33	#include <arch/types.h>
34	#include <typedefs.h>	34	#include <typedefs.h>
35	#include <list.h>	35	#include <list.h>
36	#include <synch/spinlock.h>	36	#include <synch/spinlock.h>
37	#include <mm/buddy.h>	37	#include <mm/buddy.h>
38	#include <mm/slab.h>	38	#include <mm/slab.h>
39		39
40	#define ONE_FRAME 0	40	#define ONE_FRAME 0
41		41
42	#define FRAME_KA 1 /* skip frames conflicting with user address space */	42	#define FRAME_KA 0x1 /* skip frames conflicting with user address space */
43	#define FRAME_PANIC 2 /* panic on failure */	43	#define FRAME_PANIC 0x2 /* panic on failure */
44	#define FRAME_ATOMIC 4 /* do not panic and do not sleep on failure */	44	#define FRAME_ATOMIC 0x4 /* do not panic and do not sleep on failure */
-		45	#define FRAME_NO_RECLAIM 0x8 /* Do not start reclaiming when no free memory */
45		46
46	#define FRAME_OK 0 /* frame_alloc return status */	47	#define FRAME_OK 0 /* frame_alloc return status */
47	#define FRAME_NO_MEMORY 1 /* frame_alloc return status */	48	#define FRAME_NO_MEMORY 1 /* frame_alloc return status */
48	#define FRAME_ERROR 2 /* frame_alloc return status */	49	#define FRAME_ERROR 2 /* frame_alloc return status */
49		50
50	#define FRAME2ADDR(zone, frame) ((zone)->base + ((frame) - (zone)->frames) * FRAME_SIZE)	51	#define FRAME2ADDR(zone, frame) ((zone)->base + ((frame) - (zone)->frames) * FRAME_SIZE)
51	#define ADDR2FRAME(zone, addr) (&((zone)->frames[((addr) - (zone)->base) / FRAME_SIZE]))	52	#define ADDR2FRAME(zone, addr) (&((zone)->frames[((addr) - (zone)->base) / FRAME_SIZE]))
52	#define FRAME_INDEX(zone, frame) ((index_t)((frame) - (zone)->frames))	53	#define FRAME_INDEX(zone, frame) ((index_t)((frame) - (zone)->frames))
53	#define FRAME_INDEX_ABS(zone, frame) (((index_t)((frame) - (zone)->frames)) + (zone)->base_index)	54	#define FRAME_INDEX_ABS(zone, frame) (((index_t)((frame) - (zone)->frames)) + (zone)->base_index)
54	#define FRAME_INDEX_VALID(zone, index) (((index) >= 0) && ((index) < ((zone)->free_count + (zone)->busy_count)))	55	#define FRAME_INDEX_VALID(zone, index) (((index) >= 0) && ((index) < ((zone)->free_count + (zone)->busy_count)))
55	#define IS_BUDDY_ORDER_OK(index, order) ((~(((__native) -1) << (order)) & (index)) == 0)	56	#define IS_BUDDY_ORDER_OK(index, order) ((~(((__native) -1) << (order)) & (index)) == 0)
56	#define IS_BUDDY_LEFT_BLOCK(zone, frame) (((FRAME_INDEX((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)	57	#define IS_BUDDY_LEFT_BLOCK(zone, frame) (((FRAME_INDEX((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
57	#define IS_BUDDY_RIGHT_BLOCK(zone, frame) (((FRAME_INDEX((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)	58	#define IS_BUDDY_RIGHT_BLOCK(zone, frame) (((FRAME_INDEX((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
58	#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) (((FRAME_INDEX_ABS((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)	59	#define IS_BUDDY_LEFT_BLOCK_ABS(zone, frame) (((FRAME_INDEX_ABS((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 0)
59	#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) (((FRAME_INDEX_ABS((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)	60	#define IS_BUDDY_RIGHT_BLOCK_ABS(zone, frame) (((FRAME_INDEX_ABS((zone), (frame)) >> (frame)->buddy_order) & 0x1) == 1)
60		61
61	#define ZONE_BLACKLIST_SIZE 4	62	#define ZONE_BLACKLIST_SIZE 4
62		63
63	struct zone {	64	struct zone {
64	link_t link; /*< link to previous and next zone /	65	link_t link; /*< link to previous and next zone /
65		66
66	SPINLOCK_DECLARE(lock); /*< this lock protects everything below /	67	SPINLOCK_DECLARE(lock); /*< this lock protects everything below /
67	__address base; /*< physical address of the first frame in the frames array /	68	__address base; /*< physical address of the first frame in the frames array /
68	index_t base_index; /*< frame index offset of the zone base /	69	index_t base_index; /*< frame index offset of the zone base /
69	frame_t frames; /< array of frame_t structures in this zone /	70	frame_t frames; /< array of frame_t structures in this zone /
70	count_t free_count; /*< number of free frame_t structures /	71	count_t free_count; /*< number of free frame_t structures /
71	count_t busy_count; /*< number of busy frame_t structures /	72	count_t busy_count; /*< number of busy frame_t structures /
72		73
73	buddy_system_t * buddy_system; /*< buddy system for the zone /	74	buddy_system_t * buddy_system; /*< buddy system for the zone /
74	int flags;	75	int flags;
75	};	76	};
76		77
77	struct frame {	78	struct frame {
78	count_t refcount; /*< tracking of shared frames /	79	count_t refcount; /*< tracking of shared frames /
79	__u8 buddy_order; /*< buddy system block order /	80	__u8 buddy_order; /*< buddy system block order /
80	link_t buddy_link; /*< link to the next free block inside one order /	81	link_t buddy_link; /*< link to the next free block inside one order /
81	slab_slab_t slab; /< If allocated by slab, this points there /	82	void parent; /< If allocated by slab, this points there /
82	};	83	};
83		84
84	struct region {	85	struct region {
85	__address base;	86	__address base;
86	size_t size;	87	size_t size;
87	};	88	};
88		89
89	extern region_t zone_blacklist[];	90	extern region_t zone_blacklist[];
90	extern count_t zone_blacklist_count;	91	extern count_t zone_blacklist_count;
91	extern void frame_region_not_free(__address base, size_t size);	92	extern void frame_region_not_free(__address base, size_t size);
92	extern void zone_create_in_region(__address base, size_t size);	93	extern void zone_create_in_region(__address base, size_t size);
93		94
94	extern spinlock_t zone_head_lock; /*< this lock protects zone_head list /	95	extern spinlock_t zone_head_lock; /*< this lock protects zone_head list /
95	extern link_t zone_head; /*< list of all zones in the system /	96	extern link_t zone_head; /*< list of all zones in the system /
96		97
97	extern zone_t *zone_create(__address start, size_t size, int flags);	98	extern zone_t *zone_create(__address start, size_t size, int flags);
98	extern void zone_attach(zone_t *zone);	99	extern void zone_attach(zone_t *zone);
99		100
100	extern void frame_init(void);	101	extern void frame_init(void);
101	extern void frame_initialize(frame_t frame, zone_t zone);	102	extern void frame_initialize(frame_t frame, zone_t zone);
102		103
103	__address frame_alloc(int flags, __u8 order, int * status);	104	__address frame_alloc(int flags, __u8 order, int * status, zone_t **pzone);
104	extern void frame_free(__address addr);	105	extern void frame_free(__address addr);
105		106
106	zone_t * get_zone_by_frame(frame_t * frame);	107	zone_t * get_zone_by_frame(frame_t * frame);
107		108
108	/*	109	/*
109	* Buddy system operations	110	* Buddy system operations
110	*/	111	*/
111	link_t * zone_buddy_find_buddy(buddy_system_t b, link_t buddy);	112	link_t * zone_buddy_find_buddy(buddy_system_t b, link_t buddy);
112	link_t * zone_buddy_bisect(buddy_system_t b, link_t block);	113	link_t * zone_buddy_bisect(buddy_system_t b, link_t block);
113	link_t * zone_buddy_coalesce(buddy_system_t b, link_t buddy_l, link_t * buddy_r);	114	link_t * zone_buddy_coalesce(buddy_system_t b, link_t buddy_l, link_t * buddy_r);
114	void zone_buddy_set_order(buddy_system_t b, link_t block, __u8 order);	115	void zone_buddy_set_order(buddy_system_t b, link_t block, __u8 order);
115	__u8 zone_buddy_get_order(buddy_system_t b, link_t block);	116	__u8 zone_buddy_get_order(buddy_system_t b, link_t block);
116	void zone_buddy_mark_busy(buddy_system_t b, link_t block);	117	void zone_buddy_mark_busy(buddy_system_t b, link_t block);
-		118	extern frame_t * frame_addr2frame(__address addr);
117		119
118	/*	120	/*
119	* TODO: Implement the following functions.	121	* TODO: Implement the following functions.
120	*/	122	*/
121	extern frame_t frame_reference(frame_t frame);	123	extern frame_t frame_reference(frame_t frame);
122	extern void frame_release(frame_t *frame);	124	extern void frame_release(frame_t *frame);
123		125
124		126
125	/*	127	/*
126	* Console functions	128	* Console functions
127	*/	129	*/
128	extern void zone_print_list(void);	130	extern void zone_print_list(void);
129	extern void zone_print_one(__address base);	131	extern void zone_print_one(__address base);
130		132
131	#endif	133	#endif
132		134