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 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
33 * \defgroup debug Debugging facilities and macros
37 * \brief Simple debug facilities for hosted and embedded C/C++ applications.
39 * Debug output goes to stderr in hosted applications.
40 * Freestanding (AKA embedded) applications use \c drv/kdebug.c to output
41 * diagnostic messages to a serial terminal or a JTAG debugger.
43 * \author Bernie Innocenti <bernie@codewiz.org>
45 * $WIZ$ module_name = "debug"
46 * $WIZ$ module_configuration = "bertos/cfg/cfg_debug.h"
48 * $WIZ$ module_depends = "formatwr"
49 * $WIZ$ module_supports = "not atmega103"
52 #ifndef BERTOS_DEBUG_H
53 #define BERTOS_DEBUG_H
56 #include <cfg/compiler.h>
60 * Defaults for rarely used config stuff.
62 #ifndef CONFIG_KDEBUG_DISABLE_TRACE
63 #define CONFIG_KDEBUG_DISABLE_TRACE 0
66 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
67 #define CONFIG_KDEBUG_ASSERT_NO_TEXT 0
70 #if defined(__doxygen__)
72 * Preprocessor symbol defined only for debug builds.
74 * The build infrastructure must arrange for _DEBUG to
75 * be predefined for all the source files being compiled.
77 * This is compatible with the MSVC convention for the
78 * default Debug and Release project targets.
84 // STLport specific: enable extra checks
87 // MSVC specific: Enable memory allocation debug
93 * On UNIX systems the extabilished practice is to define
94 * NDEBUG for release builds and nothing for debug builds.
101 * This macro duplicates the old MSVC trick of redefining
102 * THIS_FILE locally to avoid the overhead of many duplicate
103 * strings in ASSERT().
106 #define THIS_FILE __FILE__
110 * This macro can be used to conditionally exclude one or more
111 * statements conditioned on \c _DEBUG, avoiding the clutter
112 * of ifdef/endif pairs.
119 * DB(int ref_count;) // Track number of users
130 #include "cfg/cfg_debug.h" /* CONFIG_KDEBUG_ASSERT_NO_TEXT */
131 #include <cpu/attr.h> /* CPU_HARVARD */
133 /* These are implemented in drv/kdebug.c */
134 void kdbg_init(void);
135 void kputchar(char c);
136 int kputnum(int num);
137 void kdump(const void *buf, size_t len);
138 void __init_wall(long *wall, int size);
142 void kputs_P(const char *PROGMEM str);
143 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
144 int __bassert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
145 void __trace_P(const char *func);
146 void __tracemsg_P(const char *func, const char *PROGMEM fmt, ...);
147 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
148 int __check_wall_P(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line);
149 #define kputs(str) kputs_P(PSTR(str))
150 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
151 #define __bassert(cond, file, line) __bassert_P(PSTR(cond), PSTR(file), (line))
152 #define __trace(func) __trace_P(func)
153 #define __tracemsg(func, fmt, ...) __tracemsg_P(func, PSTR(fmt), ## __VA_ARGS__)
154 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
155 #define __check_wall(wall, size, name, file, line) __check_wall_P(wall, size, PSTR(name), PSTR(file), (line))
156 #else /* !CPU_HARVARD */
157 void kputs(const char *str);
158 void kprintf(const char *fmt, ...) FORMAT(__printf__, 1, 2);
159 int __bassert(const char *cond, const char *file, int line);
160 void __trace(const char *func);
161 void __tracemsg(const char *func, const char *fmt, ...) FORMAT(__printf__, 2, 3);
162 int __invalid_ptr(void *p, const char *name, const char *file, int line);
163 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
164 #endif /* !CPU_HARVARD */
166 #if !CONFIG_KDEBUG_ASSERT_NO_TEXT
168 * Assert a pre-condition on code.
170 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __bassert(#x, THIS_FILE, __LINE__)))
172 * Assert a pre-condition and give explanation message when assert fails
174 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __bassert(help " (" #x ")", THIS_FILE, __LINE__)))
176 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __bassert("", THIS_FILE, __LINE__)))
177 #define ASSERT2(x, help) ((void)ASSERT(x))
180 #define IS_VALID_PTR(p) (LIKELY((void *)(p) >= (void *)CPU_RAM_START))
182 * Check that the given pointer is either NULL or pointing to valid memory.
184 * The assumption here is that valid pointers never point to low
185 * memory regions. This helps catching pointers taken from
186 * struct/class memebers when the struct pointer was NULL.
188 * \see ASSERT_VALID_PTR_OR_NULL()
190 #define ASSERT_VALID_PTR(p) (IS_VALID_PTR(p) \
191 ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__))
194 * Check that the given pointer is not pointing to invalid memory.
196 * \note The check for invalid memory is architecture specific and
197 * conservative. The current implementation only checks against
200 * \see ASSERT_VALID_PTR()
202 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) \
203 || ((void *)(p) >= (void *)CPU_RAM_START)) \
204 ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
206 #if !CONFIG_KDEBUG_DISABLE_TRACE
207 #define TRACE __trace(__func__)
208 #define TRACEMSG(msg,...) __tracemsg(__func__, msg, ## __VA_ARGS__)
210 #define TRACE do {} while(0)
211 #define TRACEMSG(...) do {} while(0)
216 * \name Walls to detect data corruption
220 #define WALL_VALUE (long)0xABADCAFEL
221 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
222 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
223 #define INIT_WALL(name) __init_wall((name), countof(name))
224 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
228 * Check that the given pointer actually points to an object
229 * of the specified type.
231 #define ASSERT_VALID_OBJ(_t, _o) do { \
232 ASSERT_VALID_PTR((_o)); \
233 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
237 * \name Debug object creation and destruction.
239 * These macros help track some kinds of leaks in C++ programs.
240 * Usage is as follows:
245 * DECLARE_INSTANCE_TRACKING(Foo)
255 * DELETE_INSTANCE(Foo);
260 * // Put this in the implementation file of the class
261 * IMPLEMENT_INSTANCE_TRACKING(Foo)
266 * Foo *foo = new Foo;
267 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
269 * ASSERT_ZERO_INSTANCES(Foo); // OK
274 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
275 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
276 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
277 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
278 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
279 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
285 * On UNIX systems the extabilished practice is to define
286 * NDEBUG for release builds and nothing for debug builds.
292 #define DB(x) /* nothing */
294 #define ASSERT(x) ((void)0)
296 #define ASSERT2(x, help) ((void)0)
297 #define IS_VALID_PTR(p) (1)
298 #define ASSERT_VALID_PTR(p) ((void)0)
299 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)0)
300 #define ASSERT_VALID_OBJ(_t, _o) ((void)0)
301 #define TRACE do {} while (0)
302 #if COMPILER_VARIADIC_MACROS
303 #define TRACEMSG(x, ...) do {} while (0)
305 INLINE void TRACEMSG(UNUSED_ARG(const char *, msg), ...)
311 #define DECLARE_WALL(name, size) /* nothing */
312 #define FWD_DECLARE_WALL(name, size) /* nothing */
313 #define INIT_WALL(name) do {} while (0)
314 #define CHECK_WALL(name) do {} while (0)
316 #define NEW_INSTANCE(CLASS) do {} while (0)
317 #define DELETE_INSTANCE(CLASS) do {} while (0)
318 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
319 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
320 #define DECLARE_INSTANCE_TRACKING(CLASS)
321 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
323 INLINE void kdbg_init(void) { /* nop */ }
324 INLINE void kputchar(UNUSED_ARG(char, c)) { /* nop */ }
325 INLINE int kputnum(UNUSED_ARG(int, num)) { return 0; }
326 INLINE void kputs(UNUSED_ARG(const char *, str)) { /* nop */ }
327 INLINE void kdump(UNUSED_ARG(const void *, buf), UNUSED_ARG(size_t, len)) { /* nop */ }
329 #if defined(__cplusplus) && COMPILER_VARIADIC_MACROS
330 /* G++ can't inline functions with variable arguments... */
331 #define kprintf(fmt,...) do { (void)(fmt); } while(0)
333 /* ...but GCC can. */
334 INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
339 /** \} */ // defgroup debug
341 #endif /* BERTOS_DEBUG_H */