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 <adt/list.h>
 
#define BUDDY_SYSTEM_INNER_BLOCK    0xff
 
struct buddy_system;
 
/** Buddy system operations to be implemented by each implementation. */
typedef struct {
    /** Return pointer to left-side or right-side buddy for block passed as
      * argument. */
    link_t *(* find_buddy)(struct buddy_system *, link_t *);
    /** Bisect the block passed as argument and return pointer to the new
      * right-side buddy. */
    link_t *(* bisect)(struct buddy_system *, link_t *);
    /** Coalesce two buddies into a bigger block. */
    link_t *(* coalesce)(struct buddy_system *, link_t *, link_t *);
    /** Set order of block passed as argument. */
    void (*set_order)(struct buddy_system *, link_t *, uint8_t);
    /** Return order of block passed as argument. */
    uint8_t (*get_order)(struct buddy_system *, link_t *);
    /** Mark block as busy. */
    void (*mark_busy)(struct buddy_system *, link_t *);
    /** Mark block as available. */
    void (*mark_available)(struct buddy_system *, link_t *);
    /** Find parent of block that has given order  */
    link_t *(* find_block)(struct buddy_system *, link_t *, uint8_t);
    void (* print_id)(struct buddy_system *, link_t *);
} buddy_system_operations_t;
 
typedef 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;
} buddy_system_t;
 
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 2083 → 2089

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