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.7 2004/12/31 17:43:09 bernie
21 *#* Use UNUSED_ARG instead of obsolete UNUSED macro.
23 *#* Revision 1.6 2004/12/08 08:52:00 bernie
24 *#* Save some more RAM on AVR.
26 *#* Revision 1.5 2004/12/08 08:04:13 bernie
29 *#* Revision 1.4 2004/12/08 07:29:27 bernie
32 *#* Revision 1.3 2004/09/20 03:31:27 bernie
35 *#* Revision 1.2 2004/09/14 21:01:46 bernie
36 *#* Mark assertions as LIKELY().
38 *#* Revision 1.1 2004/09/14 20:19:47 bernie
39 *#* Unified debug macros.
41 *#* Revision 1.3 2004/09/06 12:11:29 bernie
42 *#* Merge debug.h with DevLib.
44 *#* Revision 1.2 2004/08/13 03:22:07 bernie
45 *#* Resurrect some debug macros from old projects.
47 *#* Revision 1.1 2004/08/12 06:56:35 bernie
48 *#* Move debug.h from device/ to util/.
50 *#* Revision 1.1 2004/08/12 06:52:26 bernie
51 *#* Factor out a few simple debug macros.
54 #ifndef DEVLIB_DEBUG_H
55 #define DEVLIB_DEBUG_H
58 * Try to guess whether we're running in a hosted or embedded environment.
61 #if defined(__unix__) || defined(_WIN32)
66 #endif /* !OS_HOSTED */
70 * For now, avoid dependency on compiler.h
73 #define FORMAT(x,y,z) /* nothing */
76 #define INLINE static inline
80 #define UNUSED_ARG(type,name) type
82 #define UNUSED_ARG(type,name) type name
85 #else /* !OS_HOSTED */
88 #endif /* !OS_HOSTED */
91 * This preprocessor symbol is defined only in debug builds.
93 * The build infrastructure must arrange for _DEBUG to
94 * be prepredefined for all source files being compiled.
96 * This is compatible with the Microsoft convention for
97 * the default Debug and Release targets.
101 // STLport specific: enable extra checks
102 #define __STL_DEBUG 1
104 // MSVC specific: Enable memory allocation debug
105 #if defined(_MSC_VER)
110 * On UNIX systems the extabilished practice is to define
111 * NDEBUG for release builds and nothing for debug builds.
118 * This macro duplicates the old MSVC trick of redefining
119 * THIS_FILE locally to avoid the overhead of many duplicate
120 * strings in ASSERT().
123 #define THIS_FILE __FILE__
127 * This macro can be used to conditionally exclude one or more
128 * statements conditioned on \c _DEBUG, avoiding the clutter
129 * of #ifdef/#endif pairs.
136 * DB(int ref_count;) // Track number of users
150 INLINE void kdbg_init(void) { /* nop */ }
151 INLINE void kputchar(char c)
155 INLINE void kputs(const char *str)
159 INLINE void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2)
163 vfprintf(stderr, fmt, ap);
166 void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
170 #define ASSERT(x) assert(x)
174 * Check that the given pointer is not NULL or pointing to raw memory.
176 * The assumption here is that valid pointers never point to low
177 * memory regions. This helps catching pointers taken from
178 * struct/class memebers when the struct pointer was NULL.
180 #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200)
182 #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
183 #else /* !OS_HOSTED */
185 /* These are implemented in drv/kdebug.c */
186 void kdbg_init(void);
187 void kputchar(char c);
188 void kdump(const void *buf, size_t len);
189 void __init_wall(long *wall, int size);
192 #include <avr/pgmspace.h>
193 void kputs_P(const char *PROGMEM str);
194 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
195 int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
196 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
197 int __check_wall_P(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line);
198 #define kputs(str) kputs_P(PSTR(str))
199 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
200 #define __assert(cond, file, line) __assert_P(PSTR(cond), PSTR(file), (line))
201 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
202 #define __check_wall(wall, size, name, file, line) __check_wall_P(wall, size, PSTR(name), PSTR(file), (line))
204 void kputs(const char *str);
205 void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
206 int __assert(const char *cond, const char *file, int line);
207 int __invalid_ptr(void *p, const char *name, const char *file, int line);
208 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
209 #endif /* !__AVR__ */
211 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
212 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
213 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
215 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert("", THIS_FILE, __LINE__)))
216 #define ASSERT2(x, help) ((void)ASSERT(x))
219 #define ASSERT_VALID_PTR(p) ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
220 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
221 #define TRACE kprintf("%s()\n", __FUNCTION__)
222 #define TRACEMSG(msg,...) kprintf("%s(): " msg "\n", __FUNCTION__, ## __VA_ARGS__)
224 #endif /* !OS_HOSTED */
227 * \name Walls to detect data corruption
231 #define WALL_VALUE (long)0xABADCAFEL
232 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
233 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
234 #define INIT_WALL(name) __init_wall((name), countof(name))
235 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
239 * Check that the given pointer actually points to an object
240 * of the specified type.
242 #define ASSERT_VALID_OBJ(_t, _o) do { \
243 ASSERT_VALID_PTR((_o)); \
244 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
248 * \name Debug object creation and destruction.
250 * These macros help track some kinds of leaks in C++ programs.
251 * Usage is as follows:
256 * DECLARE_INSTANCE_TRACKING(Foo)
266 * DELETE_INSTANCE(Foo);
271 * // Put this in the implementation file of the class
272 * IMPLEMENT_INSTANCE_TRACKING(Foo)
277 * Foo *foo = new Foo;
278 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
280 * ASSERT_ZERO_INSTANCES(Foo); // OK
285 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
286 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
287 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
288 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
289 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
290 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
296 * On UNIX systems the extabilished practice is to define
297 * NDEBUG for release builds and nothing for debug builds.
303 #define DB(x) /* nothing */
305 #define ASSERT(x) do {} while (0)
307 #define ASSERT2(x, help) do {} while (0)
308 #define ASSERT_VALID_PTR(p) do {} while (0)
309 #define ASSERT_VALID_PTR_OR_NULL(p) do {} while (0)
310 #define ASSERT_VALID_OBJ(_t, _o) do {} while (0)
311 #define TRACE do {} while (0)
312 #define TRACEMSG(x,...) do {} while (0)
314 #define DECLARE_WALL(name, size) /* nothing */
315 #define FWD_DECLARE_WALL(name, size) /* nothing */
316 #define INIT_WALL(name) do {} while (0)
317 #define CHECK_WALL(name) do {} while (0)
319 #define NEW_INSTANCE(CLASS) do {} while (0)
320 #define DELETE_INSTANCE(CLASS) do {} while (0)
321 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
322 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
323 #define DECLARE_INSTANCE_TRACKING(CLASS)
324 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
326 INLINE void kdbg_init(void) { /* nop */ }
327 INLINE void kputchar(UNUSED_ARG(char, c)) { /* nop */ }
328 INLINE void kputs(UNUSED_ARG(const char *, str)) { /* nop */ }
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 #endif /* DEVLIB_DEBUG_H */