WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/mm/buddy.h


/*
 * Copyright (c) 2005 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.
 */
 
/** @addtogroup genericmm
 * @{
 */
/** @file
 */
 
#ifndef KERN_BUDDY_H_
#define KERN_BUDDY_H_
 
#include <arch/types.h>
#include <typedefs.h>
 
#define BUDDY_SYSTEM_INNER_BLOCK    0xff
 
/** Buddy system operations to be implemented by each implementation. */
struct buddy_system_operations {
    /** Return pointer to left-side or right-side buddy for block passed as
      * argument. */
    link_t *(* find_buddy)(buddy_system_t *, link_t *);
    /** Bisect the block passed as argument and return pointer to the new
      * right-side buddy. */
    link_t *(* bisect)(buddy_system_t *, link_t *);
    /** Coalesce two buddies into a bigger block. */
    link_t *(* coalesce)(buddy_system_t *, link_t *, link_t *);
    /** Set order of block passed as argument. */
    void (*set_order)(buddy_system_t *, link_t *, uint8_t);
    /** Return order of block passed as argument. */
    uint8_t (*get_order)(buddy_system_t *, link_t *);
    /** Mark block as busy. */
    void (*mark_busy)(buddy_system_t *, link_t *);
    /** Mark block as available. */
    void (*mark_available)(buddy_system_t *, link_t *);
    /** Find parent of block that has given order  */
    link_t *(* find_block)(buddy_system_t *, link_t *, uint8_t);
    void (* print_id)(buddy_system_t *, link_t *);
};
 
struct buddy_system {
    /** Maximal order of block which can be stored by buddy system. */
    uint8_t max_order;
    link_t *order;
    buddy_system_operations_t *op;
    /** Pointer to be used by the implementation. */
    void *data;
};
 
extern void buddy_system_create(buddy_system_t *b, uint8_t max_order,
    buddy_system_operations_t *op, void *data);
extern link_t *buddy_system_alloc(buddy_system_t *b, uint8_t i);
extern bool buddy_system_can_alloc(buddy_system_t *b, uint8_t order);
extern void buddy_system_free(buddy_system_t *b, link_t *block);
extern void buddy_system_structure_print(buddy_system_t *b, size_t elem_size);
extern size_t buddy_conf_size(int max_order);
extern link_t *buddy_system_alloc_block(buddy_system_t *b, link_t *block);
 
#endif
 
/** @}
 */
 

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/mm/buddy.h – Rev 2059 → 2071

Rev 2059		Rev 2071
1	/*	1	/*
2	* Copyright (C) 2005 Jakub Jermar	2	* Copyright (c) 2005 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	/** @addtogroup genericmm	29	/** @addtogroup genericmm
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_BUDDY_H_	35	#ifndef KERN_BUDDY_H_
36	#define KERN_BUDDY_H_	36	#define KERN_BUDDY_H_
37		37
38	#include <arch/types.h>	38	#include <arch/types.h>
39	#include <typedefs.h>	39	#include <typedefs.h>
40		40
41	#define BUDDY_SYSTEM_INNER_BLOCK 0xff	41	#define BUDDY_SYSTEM_INNER_BLOCK 0xff
42		42
43	/** Buddy system operations to be implemented by each implementation. */	43	/** Buddy system operations to be implemented by each implementation. */
44	struct buddy_system_operations {	44	struct buddy_system_operations {
45	/** Return pointer to left-side or right-side buddy for block passed as	45	/** Return pointer to left-side or right-side buddy for block passed as
46	* argument. */	46	* argument. */
47	link_t ( find_buddy)(buddy_system_t , link_t );	47	link_t ( find_buddy)(buddy_system_t , link_t );
48	/** Bisect the block passed as argument and return pointer to the new	48	/** Bisect the block passed as argument and return pointer to the new
49	* right-side buddy. */	49	* right-side buddy. */
50	link_t ( bisect)(buddy_system_t , link_t );	50	link_t ( bisect)(buddy_system_t , link_t );
51	/** Coalesce two buddies into a bigger block. */	51	/** Coalesce two buddies into a bigger block. */
52	link_t ( coalesce)(buddy_system_t , link_t , link_t *);	52	link_t ( coalesce)(buddy_system_t , link_t , link_t *);
53	/** Set order of block passed as argument. */	53	/** Set order of block passed as argument. */
54	void (set_order)(buddy_system_t , link_t *, uint8_t);	54	void (set_order)(buddy_system_t , link_t *, uint8_t);
55	/** Return order of block passed as argument. */	55	/** Return order of block passed as argument. */
56	uint8_t (get_order)(buddy_system_t , link_t *);	56	uint8_t (get_order)(buddy_system_t , link_t *);
57	/** Mark block as busy. */	57	/** Mark block as busy. */
58	void (mark_busy)(buddy_system_t , link_t *);	58	void (mark_busy)(buddy_system_t , link_t *);
59	/** Mark block as available. */	59	/** Mark block as available. */
60	void (mark_available)(buddy_system_t , link_t *);	60	void (mark_available)(buddy_system_t , link_t *);
61	/** Find parent of block that has given order */	61	/** Find parent of block that has given order */
62	link_t ( find_block)(buddy_system_t , link_t , uint8_t);	62	link_t ( find_block)(buddy_system_t , link_t , uint8_t);
63	void (* print_id)(buddy_system_t , link_t );	63	void (* print_id)(buddy_system_t , link_t );
64	};	64	};
65		65
66	struct buddy_system {	66	struct buddy_system {
67	/** Maximal order of block which can be stored by buddy system. */	67	/** Maximal order of block which can be stored by buddy system. */
68	uint8_t max_order;	68	uint8_t max_order;
69	link_t *order;	69	link_t *order;
70	buddy_system_operations_t *op;	70	buddy_system_operations_t *op;
71	/** Pointer to be used by the implementation. */	71	/** Pointer to be used by the implementation. */
72	void *data;	72	void *data;
73	};	73	};
74		74
75	extern void buddy_system_create(buddy_system_t *b, uint8_t max_order,	75	extern void buddy_system_create(buddy_system_t *b, uint8_t max_order,
76	buddy_system_operations_t op, void data);	76	buddy_system_operations_t op, void data);
77	extern link_t buddy_system_alloc(buddy_system_t b, uint8_t i);	77	extern link_t buddy_system_alloc(buddy_system_t b, uint8_t i);
78	extern bool buddy_system_can_alloc(buddy_system_t *b, uint8_t order);	78	extern bool buddy_system_can_alloc(buddy_system_t *b, uint8_t order);
79	extern void buddy_system_free(buddy_system_t b, link_t block);	79	extern void buddy_system_free(buddy_system_t b, link_t block);
80	extern void buddy_system_structure_print(buddy_system_t *b, size_t elem_size);	80	extern void buddy_system_structure_print(buddy_system_t *b, size_t elem_size);
81	extern size_t buddy_conf_size(int max_order);	81	extern size_t buddy_conf_size(int max_order);
82	extern link_t buddy_system_alloc_block(buddy_system_t b, link_t *block);	82	extern link_t buddy_system_alloc_block(buddy_system_t b, link_t *block);
83		83
84	#endif	84	#endif
85		85
86	/** @}	86	/** @}
87	*/	87	*/
88		88