Release version 2.5.1.
[bertos.git] / 2.5 / bertos / struct / pool.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2004, 2008 Develer S.r.l. (http://www.develer.com/)
30  * -->
31  *
32  * \brief Pool macros.
33  *
34  * \version $Id$
35  * \author Giovanni Bajo <rasky@develer.com>
36  */
37
38 #ifndef STRUCT_POOL_H
39 #define STRUCT_POOL_H
40
41 #include <cfg/macros.h>
42 #include <struct/list.h>
43
44 #define EXTERN_POOL(name) \
45         extern List name
46
47 #define DECLARE_POOL_WITH_STORAGE(name, type, num, storage) \
48         static type name##_items[num]; \
49         storage name; \
50         INLINE void name##_init(void (*init_func)(type*)) \
51         { \
52                 int i; \
53                 LIST_INIT(&name); \
54                 for (i=0;i<countof(name##_items);++i) \
55                 { \
56                         if (init_func) init_func(&name##_items[i]); \
57                         ADDTAIL(&name, (Node*)&name##_items[i]); \
58                 } \
59         } \
60         INLINE void name##_init(void (*init_func)(type*)) \
61         /**/
62
63 #define DECLARE_POOL(name, type, num) \
64         DECLARE_POOL_WITH_STORAGE(name, type, num, List)
65
66 #define DECLARE_POOL_STATIC(name, type, num) \
67         DECLARE_POOL_WITH_STORAGE(name, type, num, static List)
68
69 #define pool_init(name, init_func)     (*(name##_init))(init_func)
70 #define pool_alloc(name)               REMHEAD(name)
71 #define pool_free(name, elem)          ADDHEAD(name, (Node*)elem)
72 #define pool_empty(name)               ISLISTEMPTY(name)
73
74 #endif /* STRUCT_POOL_H */