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.10 2005/02/09 21:50:28 bernie
21 *#* Declare dummy ASSERT* macros as ((void)0) to work around a warning I can't remember any more.
23 *#* Revision 1.9 2005/01/25 08:36:40 bernie
24 *#* kputnum(): Export.
26 *#* Revision 1.8 2005/01/11 18:08:08 aleph
27 *#* Add empty kdump definition for debug off
29 *#* Revision 1.7 2004/12/31 17:43:09 bernie
30 *#* Use UNUSED_ARG instead of obsolete UNUSED macro.
32 *#* Revision 1.6 2004/12/08 08:52:00 bernie
33 *#* Save some more RAM on AVR.
35 *#* Revision 1.5 2004/12/08 08:04:13 bernie
38 *#* Revision 1.4 2004/12/08 07:29:27 bernie
41 *#* Revision 1.3 2004/09/20 03:31:27 bernie
44 *#* Revision 1.2 2004/09/14 21:01:46 bernie
45 *#* Mark assertions as LIKELY().
47 *#* Revision 1.1 2004/09/14 20:19:47 bernie
48 *#* Unified debug macros.
50 *#* Revision 1.3 2004/09/06 12:11:29 bernie
51 *#* Merge debug.h with DevLib.
53 *#* Revision 1.2 2004/08/13 03:22:07 bernie
54 *#* Resurrect some debug macros from old projects.
56 *#* Revision 1.1 2004/08/12 06:56:35 bernie
57 *#* Move debug.h from device/ to util/.
59 *#* Revision 1.1 2004/08/12 06:52:26 bernie
60 *#* Factor out a few simple debug macros.
63 #ifndef DEVLIB_DEBUG_H
64 #define DEVLIB_DEBUG_H
67 * Try to guess whether we're running in a hosted or embedded environment.
70 #if defined(__unix__) || defined(_WIN32)
75 #endif /* !OS_HOSTED */
79 * For now, avoid dependency on compiler.h
82 #define FORMAT(x,y,z) /* nothing */
85 #define INLINE static inline
89 #define UNUSED_ARG(type,name) type
91 #define UNUSED_ARG(type,name) type name
94 #else /* !OS_HOSTED */
97 #endif /* !OS_HOSTED */
100 * This preprocessor symbol is defined only in debug builds.
102 * The build infrastructure must arrange for _DEBUG to
103 * be prepredefined for all source files being compiled.
105 * This is compatible with the Microsoft convention for
106 * the default Debug and Release targets.
110 // STLport specific: enable extra checks
111 #define __STL_DEBUG 1
113 // MSVC specific: Enable memory allocation debug
114 #if defined(_MSC_VER)
119 * On UNIX systems the extabilished practice is to define
120 * NDEBUG for release builds and nothing for debug builds.
127 * This macro duplicates the old MSVC trick of redefining
128 * THIS_FILE locally to avoid the overhead of many duplicate
129 * strings in ASSERT().
132 #define THIS_FILE __FILE__
136 * This macro can be used to conditionally exclude one or more
137 * statements conditioned on \c _DEBUG, avoiding the clutter
138 * of #ifdef/#endif pairs.
145 * DB(int ref_count;) // Track number of users
159 INLINE void kdbg_init(void) { /* nop */ }
160 INLINE void kputchar(char c)
164 INLINE void kputs(const char *str)
168 INLINE void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2)
172 vfprintf(stderr, fmt, ap);
175 void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
179 #define ASSERT(x) assert(x)
183 * Check that the given pointer is not NULL or pointing to raw memory.
185 * The assumption here is that valid pointers never point to low
186 * memory regions. This helps catching pointers taken from
187 * struct/class memebers when the struct pointer was NULL.
189 #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200)
191 #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
192 #else /* !OS_HOSTED */
194 /* These are implemented in drv/kdebug.c */
195 void kdbg_init(void);
196 void kputchar(char c);
197 int kputnum(int num);
198 void kdump(const void *buf, size_t len);
199 void __init_wall(long *wall, int size);
202 #include <avr/pgmspace.h>
203 void kputs_P(const char *PROGMEM str);
204 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
205 int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
206 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
207 int __check_wall_P(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line);
208 #define kputs(str) kputs_P(PSTR(str))
209 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
210 #define __assert(cond, file, line) __assert_P(PSTR(cond), PSTR(file), (line))
211 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
212 #define __check_wall(wall, size, name, file, line) __check_wall_P(wall, size, PSTR(name), PSTR(file), (line))
214 void kputs(const char *str);
215 void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
216 int __assert(const char *cond, const char *file, int line);
217 int __invalid_ptr(void *p, const char *name, const char *file, int line);
218 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
219 #endif /* !__AVR__ */
221 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
222 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
223 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
225 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert("", THIS_FILE, __LINE__)))
226 #define ASSERT2(x, help) ((void)ASSERT(x))
229 #define ASSERT_VALID_PTR(p) ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
230 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
231 #define TRACE kprintf("%s()\n", __FUNCTION__)
232 #define TRACEMSG(msg,...) kprintf("%s(): " msg "\n", __FUNCTION__, ## __VA_ARGS__)
234 #endif /* !OS_HOSTED */
237 * \name Walls to detect data corruption
241 #define WALL_VALUE (long)0xABADCAFEL
242 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
243 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
244 #define INIT_WALL(name) __init_wall((name), countof(name))
245 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
249 * Check that the given pointer actually points to an object
250 * of the specified type.
252 #define ASSERT_VALID_OBJ(_t, _o) do { \
253 ASSERT_VALID_PTR((_o)); \
254 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
258 * \name Debug object creation and destruction.
260 * These macros help track some kinds of leaks in C++ programs.
261 * Usage is as follows:
266 * DECLARE_INSTANCE_TRACKING(Foo)
276 * DELETE_INSTANCE(Foo);
281 * // Put this in the implementation file of the class
282 * IMPLEMENT_INSTANCE_TRACKING(Foo)
287 * Foo *foo = new Foo;
288 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
290 * ASSERT_ZERO_INSTANCES(Foo); // OK
295 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
296 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
297 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
298 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
299 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
300 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
306 * On UNIX systems the extabilished practice is to define
307 * NDEBUG for release builds and nothing for debug builds.
313 #define DB(x) /* nothing */
315 #define ASSERT(x) ((void)0)
317 #define ASSERT2(x, help) ((void)0)
318 #define ASSERT_VALID_PTR(p) ((void)0)
319 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)0)
320 #define ASSERT_VALID_OBJ(_t, _o) ((void)0)
321 #define TRACE do {} while (0)
322 #define TRACEMSG(x,...) do {} while (0)
324 #define DECLARE_WALL(name, size) /* nothing */
325 #define FWD_DECLARE_WALL(name, size) /* nothing */
326 #define INIT_WALL(name) do {} while (0)
327 #define CHECK_WALL(name) do {} while (0)
329 #define NEW_INSTANCE(CLASS) do {} while (0)
330 #define DELETE_INSTANCE(CLASS) do {} while (0)
331 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
332 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
333 #define DECLARE_INSTANCE_TRACKING(CLASS)
334 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
336 INLINE void kdbg_init(void) { /* nop */ }
337 INLINE void kputchar(UNUSED_ARG(char, c)) { /* nop */ }
338 INLINE int kputnum(UNUSED_ARG(int, num)) { return 0; }
339 INLINE void kputs(UNUSED_ARG(const char *, str)) { /* nop */ }
340 INLINE void kdump(UNUSED_ARG(const void *, buf), UNUSED_ARG(size_t, len)) { /* nop */ }
343 /* G++ can't inline functions with variable arguments... */
344 #define kprintf(fmt,...) do { (void)(fmt); } while(0)
346 /* ...but GCC can. */
347 INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
352 #endif /* DEVLIB_DEBUG_H */