4 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5 * This file is part of DevLib - See README.devlib 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.11 2005/02/16 20:29:48 bernie
21 *#* TRACE(), TRACEMSG(): Reduce code and data footprint.
23 *#* Revision 1.10 2005/02/09 21:50:28 bernie
24 *#* Declare dummy ASSERT* macros as ((void)0) to work around a warning I can't remember any more.
26 *#* Revision 1.9 2005/01/25 08:36:40 bernie
27 *#* kputnum(): Export.
29 *#* Revision 1.8 2005/01/11 18:08:08 aleph
30 *#* Add empty kdump definition for debug off
32 *#* Revision 1.7 2004/12/31 17:43:09 bernie
33 *#* Use UNUSED_ARG instead of obsolete UNUSED macro.
35 *#* Revision 1.6 2004/12/08 08:52:00 bernie
36 *#* Save some more RAM on AVR.
38 *#* Revision 1.5 2004/12/08 08:04:13 bernie
41 *#* Revision 1.4 2004/12/08 07:29:27 bernie
44 *#* Revision 1.3 2004/09/20 03:31:27 bernie
47 *#* Revision 1.2 2004/09/14 21:01:46 bernie
48 *#* Mark assertions as LIKELY().
50 *#* Revision 1.1 2004/09/14 20:19:47 bernie
51 *#* Unified debug macros.
53 *#* Revision 1.3 2004/09/06 12:11:29 bernie
54 *#* Merge debug.h with DevLib.
56 *#* Revision 1.2 2004/08/13 03:22:07 bernie
57 *#* Resurrect some debug macros from old projects.
59 *#* Revision 1.1 2004/08/12 06:56:35 bernie
60 *#* Move debug.h from device/ to util/.
62 *#* Revision 1.1 2004/08/12 06:52:26 bernie
63 *#* Factor out a few simple debug macros.
66 #ifndef DEVLIB_DEBUG_H
67 #define DEVLIB_DEBUG_H
70 * Try to guess whether we're running in a hosted or embedded environment.
73 #if defined(__unix__) || defined(_WIN32)
78 #endif /* !OS_HOSTED */
82 * For now, avoid dependency on compiler.h
85 #define FORMAT(x,y,z) /* nothing */
88 #define INLINE static inline
92 #define UNUSED_ARG(type,name) type
94 #define UNUSED_ARG(type,name) type name
97 #else /* !OS_HOSTED */
100 #endif /* !OS_HOSTED */
103 * This preprocessor symbol is defined only in debug builds.
105 * The build infrastructure must arrange for _DEBUG to
106 * be prepredefined for all source files being compiled.
108 * This is compatible with the Microsoft convention for
109 * the default Debug and Release targets.
113 // STLport specific: enable extra checks
114 #define __STL_DEBUG 1
116 // MSVC specific: Enable memory allocation debug
117 #if defined(_MSC_VER)
122 * On UNIX systems the extabilished practice is to define
123 * NDEBUG for release builds and nothing for debug builds.
130 * This macro duplicates the old MSVC trick of redefining
131 * THIS_FILE locally to avoid the overhead of many duplicate
132 * strings in ASSERT().
135 #define THIS_FILE __FILE__
139 * This macro can be used to conditionally exclude one or more
140 * statements conditioned on \c _DEBUG, avoiding the clutter
141 * of #ifdef/#endif pairs.
148 * DB(int ref_count;) // Track number of users
162 INLINE void kdbg_init(void) { /* nop */ }
163 INLINE void kputchar(char c)
167 INLINE void kputs(const char *str)
171 INLINE void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2)
175 vfprintf(stderr, fmt, ap);
178 void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
182 #define ASSERT(x) assert(x)
186 * Check that the given pointer is not NULL or pointing to raw memory.
188 * The assumption here is that valid pointers never point to low
189 * memory regions. This helps catching pointers taken from
190 * struct/class memebers when the struct pointer was NULL.
192 #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200)
194 #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
195 #else /* !OS_HOSTED */
197 /* These are implemented in drv/kdebug.c */
198 void kdbg_init(void);
199 void kputchar(char c);
200 int kputnum(int num);
201 void kdump(const void *buf, size_t len);
202 void __init_wall(long *wall, int size);
205 #include <mware/pgm.h>
206 void kputs_P(const char *PROGMEM str);
207 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
208 int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
209 void __trace_P(const char *PROGMEM name);
210 void __tracemsg_P(const char *PROGMEM name, const char *PROGMEM fmt, ...);
211 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
212 int __check_wall_P(long *wall, int size, const char * PGM_ATTR name, const char * PGM_ATTR file, int line);
213 #define kputs(str) kputs_P(PSTR(str))
214 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
215 #define __assert(cond, file, line) __assert_P(PSTR(cond), PSTR(file), (line))
216 #define __trace(name) __trace_P(PSTR(name))
217 #define __tracemsg(name, fmt, ...) __trace_P(PSTR(name), PSTR(fmt), ## __VA_ARGS__)
218 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
219 #define __check_wall(wall, size, name, file, line) __check_wall_P(wall, size, PSTR(name), PSTR(file), (line))
220 #else /* !CPU_HARVARD */
221 void kputs(const char *str);
222 void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
223 int __assert(const char *cond, const char *file, int line);
224 void __trace(const char *name);
225 void __tracemsg(const char *name, const char *fmt, ...);
226 int __invalid_ptr(void *p, const char *name, const char *file, int line);
227 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
229 #define TRACE __trace(__FUNCTION__)
230 #define TRACEMSG(msg,...) __tracemsg(__FUNCTION__, msg, ## __VA_ARGS__)
231 #endif /* !CPU_HARVARD */
233 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
234 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
235 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
237 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert("", THIS_FILE, __LINE__)))
238 #define ASSERT2(x, help) ((void)ASSERT(x))
241 #define ASSERT_VALID_PTR(p) ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
242 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
244 #endif /* !OS_HOSTED */
247 * \name Walls to detect data corruption
251 #define WALL_VALUE (long)0xABADCAFEL
252 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
253 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
254 #define INIT_WALL(name) __init_wall((name), countof(name))
255 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
259 * Check that the given pointer actually points to an object
260 * of the specified type.
262 #define ASSERT_VALID_OBJ(_t, _o) do { \
263 ASSERT_VALID_PTR((_o)); \
264 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
268 * \name Debug object creation and destruction.
270 * These macros help track some kinds of leaks in C++ programs.
271 * Usage is as follows:
276 * DECLARE_INSTANCE_TRACKING(Foo)
286 * DELETE_INSTANCE(Foo);
291 * // Put this in the implementation file of the class
292 * IMPLEMENT_INSTANCE_TRACKING(Foo)
297 * Foo *foo = new Foo;
298 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
300 * ASSERT_ZERO_INSTANCES(Foo); // OK
305 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
306 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
307 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
308 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
309 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
310 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
316 * On UNIX systems the extabilished practice is to define
317 * NDEBUG for release builds and nothing for debug builds.
323 #define DB(x) /* nothing */
325 #define ASSERT(x) ((void)0)
327 #define ASSERT2(x, help) ((void)0)
328 #define ASSERT_VALID_PTR(p) ((void)0)
329 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)0)
330 #define ASSERT_VALID_OBJ(_t, _o) ((void)0)
331 #define TRACE do {} while (0)
332 #define TRACEMSG(x,...) do {} while (0)
334 #define DECLARE_WALL(name, size) /* nothing */
335 #define FWD_DECLARE_WALL(name, size) /* nothing */
336 #define INIT_WALL(name) do {} while (0)
337 #define CHECK_WALL(name) do {} while (0)
339 #define NEW_INSTANCE(CLASS) do {} while (0)
340 #define DELETE_INSTANCE(CLASS) do {} while (0)
341 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
342 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
343 #define DECLARE_INSTANCE_TRACKING(CLASS)
344 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
346 INLINE void kdbg_init(void) { /* nop */ }
347 INLINE void kputchar(UNUSED_ARG(char, c)) { /* nop */ }
348 INLINE int kputnum(UNUSED_ARG(int, num)) { return 0; }
349 INLINE void kputs(UNUSED_ARG(const char *, str)) { /* nop */ }
350 INLINE void kdump(UNUSED_ARG(const void *, buf), UNUSED_ARG(size_t, len)) { /* nop */ }
353 /* G++ can't inline functions with variable arguments... */
354 #define kprintf(fmt,...) do { (void)(fmt); } while(0)
356 /* ...but GCC can. */
357 INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
362 #endif /* DEVLIB_DEBUG_H */