4 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5 * This file is part of DevLib - See devlib/README for information.
8 * \brief Simple debug facilities for hosted and embedded C/C++ applications.
10 * Debug output goes to stderr in hosted applications.
11 * Freestanding (AKA embedded) applications use \c drv/kdebug.c to output
12 * diagnostic messages to a serial terminal or a JTAG debugger.
15 * \author Bernardo Innocenti <bernie@develer.com>
20 *#* Revision 1.6 2004/12/08 08:52:00 bernie
21 *#* Save some more RAM on AVR.
23 *#* Revision 1.5 2004/12/08 08:04:13 bernie
26 *#* Revision 1.4 2004/12/08 07:29:27 bernie
29 *#* Revision 1.3 2004/09/20 03:31:27 bernie
32 *#* Revision 1.2 2004/09/14 21:01:46 bernie
33 *#* Mark assertions as LIKELY().
35 *#* Revision 1.1 2004/09/14 20:19:47 bernie
36 *#* Unified debug macros.
38 *#* Revision 1.3 2004/09/06 12:11:29 bernie
39 *#* Merge debug.h with DevLib.
41 *#* Revision 1.2 2004/08/13 03:22:07 bernie
42 *#* Resurrect some debug macros from old projects.
44 *#* Revision 1.1 2004/08/12 06:56:35 bernie
45 *#* Move debug.h from device/ to util/.
47 *#* Revision 1.1 2004/08/12 06:52:26 bernie
48 *#* Factor out a few simple debug macros.
51 #ifndef DEVLIB_DEBUG_H
52 #define DEVLIB_DEBUG_H
55 * Try to guess whether we're running in a hosted or embedded environment.
58 #if defined(__unix__) || defined(_WIN32)
63 #endif /* !OS_HOSTED */
67 * For now, avoid dependency on compiler.h
70 #define FORMAT(x,y,z) /* nothing */
73 #define INLINE static inline
76 #define UNUSED(type,name) type
78 #else /* !OS_HOSTED */
81 #endif /* !OS_HOSTED */
84 * This preprocessor symbol is defined only in debug builds.
86 * The build infrastructure must arrange for _DEBUG to
87 * be prepredefined for all source files being compiled.
89 * This is compatible with the Microsoft convention for
90 * the default Debug and Release targets.
94 // STLport specific: enable extra checks
97 // MSVC specific: Enable memory allocation debug
103 * On UNIX systems the extabilished practice is to define
104 * NDEBUG for release builds and nothing for debug builds.
111 * This macro duplicates the old MSVC trick of redefining
112 * THIS_FILE locally to avoid the overhead of many duplicate
113 * strings in ASSERT().
116 #define THIS_FILE __FILE__
120 * This macro can be used to conditionally exclude one or more
121 * statements conditioned on \c _DEBUG, avoiding the clutter
122 * of #ifdef/#endif pairs.
129 * DB(int ref_count;) // Track number of users
143 INLINE void kdbg_init(void) { /* nop */ }
144 INLINE void kputchar(char c)
148 INLINE void kputs(const char *str)
152 INLINE void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2)
156 vfprintf(stderr, fmt, ap);
159 void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
163 #define ASSERT(x) assert(x)
167 * Check that the given pointer is not NULL or pointing to raw memory.
169 * The assumption here is that valid pointers never point to low
170 * memory regions. This helps catching pointers taken from
171 * struct/class memebers when the struct pointer was NULL.
173 #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200)
175 #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
176 #else /* !OS_HOSTED */
178 /* These are implemented in drv/kdebug.c */
179 void kdbg_init(void);
180 void kputchar(char c);
181 void kdump(const void *buf, size_t len);
182 void __init_wall(long *wall, int size);
185 #include <avr/pgmspace.h>
186 void kputs_P(const char *PROGMEM str);
187 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
188 int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
189 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
190 int __check_wall_P(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line);
191 #define kputs(str) kputs_P(PSTR(str))
192 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
193 #define __assert(cond, file, line) __assert_P(PSTR(cond), PSTR(file), (line))
194 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
195 #define __check_wall(wall, size, name, file, line) __check_wall_P(wall, size, PSTR(name), PSTR(file), (line))
197 void kputs(const char *str);
198 void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
199 int __assert(const char *cond, const char *file, int line);
200 int __invalid_ptr(void *p, const char *name, const char *file, int line);
201 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
202 #endif /* !__AVR__ */
204 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
205 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
206 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
208 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert("", THIS_FILE, __LINE__)))
209 #define ASSERT2(x, help) ((void)ASSERT(x))
212 #define ASSERT_VALID_PTR(p) ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
213 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
214 #define TRACE kprintf("%s()\n", __FUNCTION__)
215 #define TRACEMSG(msg,...) kprintf("%s(): " msg "\n", __FUNCTION__, ## __VA_ARGS__)
217 #endif /* !OS_HOSTED */
220 * \name Walls to detect data corruption
224 #define WALL_VALUE (long)0xABADCAFEL
225 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
226 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
227 #define INIT_WALL(name) __init_wall((name), countof(name))
228 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
232 * Check that the given pointer actually points to an object
233 * of the specified type.
235 #define ASSERT_VALID_OBJ(_t, _o) do { \
236 ASSERT_VALID_PTR((_o)); \
237 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
241 * \name Debug object creation and destruction.
243 * These macros help track some kinds of leaks in C++ programs.
244 * Usage is as follows:
249 * DECLARE_INSTANCE_TRACKING(Foo)
259 * DELETE_INSTANCE(Foo);
264 * // Put this in the implementation file of the class
265 * IMPLEMENT_INSTANCE_TRACKING(Foo)
270 * Foo *foo = new Foo;
271 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
273 * ASSERT_ZERO_INSTANCES(Foo); // OK
278 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
279 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
280 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
281 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
282 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
283 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
289 * On UNIX systems the extabilished practice is to define
290 * NDEBUG for release builds and nothing for debug builds.
296 #define DB(x) /* nothing */
298 #define ASSERT(x) do {} while (0)
300 #define ASSERT2(x, help) do {} while (0)
301 #define ASSERT_VALID_PTR(p) do {} while (0)
302 #define ASSERT_VALID_PTR_OR_NULL(p) do {} while (0)
303 #define ASSERT_VALID_OBJ(_t, _o) do {} while (0)
304 #define TRACE do {} while (0)
305 #define TRACEMSG(x,...) do {} while (0)
307 #define DECLARE_WALL(name, size) /* nothing */
308 #define FWD_DECLARE_WALL(name, size) /* nothing */
309 #define INIT_WALL(name) do {} while (0)
310 #define CHECK_WALL(name) do {} while (0)
312 #define NEW_INSTANCE(CLASS) do {} while (0)
313 #define DELETE_INSTANCE(CLASS) do {} while (0)
314 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
315 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
316 #define DECLARE_INSTANCE_TRACKING(CLASS)
317 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
319 INLINE void kdbg_init(void) { /* nop */ }
320 INLINE void kputchar(UNUSED(char, c)) { /* nop */ }
321 INLINE void kputs(UNUSED(const char*, str)) { /* nop */ }
323 /* G++ can't inline functions with variable arguments... */
324 #define kprintf(fmt,...) do { (void)(fmt); } while(0)
326 /* ...but GCC can. */
327 INLINE void kprintf(UNUSED(const char*, fmt), ...) { /* nop */ }
332 #endif /* DEVLIB_DEBUG_H */