4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2006 Develer S.r.l. (http://www.develer.com/)
33 * \brief Debug macros for inter-module dependency checking.
35 * These macros expand to nothing in release builds. In debug
36 * builds, they perform run-time dependency checks for modules.
38 * The usage pattern looks like this:
43 * void phaser_init(void)
45 * MOD_CHECK(computer);
46 * MOD_CHECK(warp_core);
48 * [...charge weapons...]
53 * void phaser_cleanup(void)
55 * MOD_CLEANUP(phaser);
57 * [...disarm phaser...]
61 * \author Bernie Innocenti <bernie@codewiz.org>
66 #include <cfg/debug.h>
69 * Declare a global variable for module dependency check.
71 * \see MOD_INIT(), MOD_CHECK()
73 #define MOD_DEFINE(module) DB(extern bool module ## _initialized; bool module ## _initialized;)
76 * Check that \a module was already initialized.
78 * Put this check just before accessing any facility
79 * provided by a module that requires prior initialization.
84 #define MOD_CHECK(module) \
86 DB(extern bool module ## _initialized;) \
87 ASSERT(module ## _initialized); \
91 * Mark module as initialized.
93 * Marking initialization requires the global data
94 * previously defined by MOD_DEFINE().
96 * To prevent double initialization bugs, an initialized
97 * module must first be cleaned up with MOD_CLEANUP() before
98 * calling MOD_INIT() another time.
100 * \see MOD_CLEANUP(), MOD_CHECK(), MOD_DEFINE()
102 #define MOD_INIT(module) \
104 ASSERT(!module ## _initialized); \
105 DB(module ## _initialized = true;) \
109 * Mark module as being no longer initialized.
111 * Marking initialization requires the global data
112 * previously defined by MOD_DEFINE().
114 * \see MOD_INIT(), MOD_CHECK(), MOD_DEFINE()
116 #define MOD_CLEANUP(module) \
118 ASSERT(module ## _initialized); \
119 DB(module ## _initialized = false;) \
122 #endif /* CFG_MODULE_H */