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.5 2004/12/08 08:04:13 bernie
23 *#* Revision 1.4 2004/12/08 07:29:27 bernie
26 *#* Revision 1.3 2004/09/20 03:31:27 bernie
29 *#* Revision 1.2 2004/09/14 21:01:46 bernie
30 *#* Mark assertions as LIKELY().
32 *#* Revision 1.1 2004/09/14 20:19:47 bernie
33 *#* Unified debug macros.
35 *#* Revision 1.3 2004/09/06 12:11:29 bernie
36 *#* Merge debug.h with DevLib.
38 *#* Revision 1.2 2004/08/13 03:22:07 bernie
39 *#* Resurrect some debug macros from old projects.
41 *#* Revision 1.1 2004/08/12 06:56:35 bernie
42 *#* Move debug.h from device/ to util/.
44 *#* Revision 1.1 2004/08/12 06:52:26 bernie
45 *#* Factor out a few simple debug macros.
48 #ifndef DEVLIB_DEBUG_H
49 #define DEVLIB_DEBUG_H
52 * Try to guess whether we're running in a hosted or embedded environment.
55 #if defined(__unix__) || defined(_WIN32)
60 #endif /* !OS_HOSTED */
64 * For now, avoid dependency on compiler.h
67 #define FORMAT(x,y,z) /* nothing */
70 #define INLINE static inline
73 #define UNUSED(type,name) type
75 #else /* !OS_HOSTED */
77 #endif /* !OS_HOSTED */
80 * This preprocessor symbol is defined only in debug builds.
82 * The build infrastructure must arrange for _DEBUG to
83 * be prepredefined for all source files being compiled.
85 * This is compatible with the Microsoft convention for
86 * the default Debug and Release targets.
90 // STLport specific: enable extra checks
93 // MSVC specific: Enable memory allocation debug
99 * On UNIX systems the extabilished practice is to define
100 * NDEBUG for release builds and nothing for debug builds.
107 * This macro duplicates the old MSVC trick of redefining
108 * THIS_FILE locally to avoid the overhead of many duplicate
109 * strings in ASSERT().
112 #define THIS_FILE __FILE__
116 * This macro can be used to conditionally exclude one or more
117 * statements conditioned on \c _DEBUG, avoiding the clutter
118 * of #ifdef/#endif pairs.
125 * DB(int ref_count;) // Track number of users
139 INLINE void kdbg_init(void) { /* nop */ }
140 INLINE void kputchar(char c)
144 INLINE void kputs(const char *str)
148 INLINE void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2)
152 vfprintf(stderr, fmt, ap);
155 void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
159 #define ASSERT(x) assert(x)
163 * Check that the given pointer is not NULL or pointing to raw memory.
165 * The assumption here is that valid pointers never point to low
166 * memory regions. This helps catching pointers taken from
167 * struct/class memebers when the struct pointer was NULL.
169 #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200)
171 #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
172 #else /* !OS_HOSTED */
174 /* These are implemented in drv/kdebug.c */
175 void kdbg_init(void);
176 void kputchar(char c);
177 void kdump(const void *buf, size_t len);
180 #include <avr/pgmspace.h>
181 void kputs_P(const char *PROGMEM str);
182 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
183 int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
184 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
185 #define kputs(str) kputs_P(PSTR(str))
186 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
187 #define __assert(cond, file, line) __assert_P(PSTR(cond), PSTR(file), (line))
188 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
190 void kputs(const char *str);
191 void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
192 int __assert(const char *cond, const char *file, int line);
193 int __invalid_ptr(void *p, const char *name, const char *file, int line);
194 #endif /* !__AVR__ */
196 void __init_wall(long *wall, int size);
197 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
199 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
200 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
201 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
203 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert("", THIS_FILE, __LINE__)))
204 #define ASSERT2(x, help) ((void)ASSERT(x))
207 #define ASSERT_VALID_PTR(p) ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
208 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
209 #define TRACE kprintf("%s()\n", __FUNCTION__)
210 #define TRACEMSG(msg,...) kprintf("%s(): " msg "\n", __FUNCTION__, ## __VA_ARGS__)
212 #endif /* !OS_HOSTED */
215 * \name Walls to detect data corruption
219 #define WALL_VALUE (long)0xABADCAFEL
220 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
221 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
222 #define INIT_WALL(name) __init_wall((name), countof(name))
223 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
227 * Check that the given pointer actually points to an object
228 * of the specified type.
230 #define ASSERT_VALID_OBJ(_t, _o) do { \
231 ASSERT_VALID_PTR((_o)); \
232 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
236 * \name Debug object creation and destruction.
238 * These macros help track some kinds of leaks in C++ programs.
239 * Usage is as follows:
244 * DECLARE_INSTANCE_TRACKING(Foo)
254 * DELETE_INSTANCE(Foo);
259 * // Put this in the implementation file of the class
260 * IMPLEMENT_INSTANCE_TRACKING(Foo)
265 * Foo *foo = new Foo;
266 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
268 * ASSERT_ZERO_INSTANCES(Foo); // OK
273 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
274 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
275 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
276 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
277 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
278 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
284 * On UNIX systems the extabilished practice is to define
285 * NDEBUG for release builds and nothing for debug builds.
291 #define DB(x) /* nothing */
293 #define ASSERT(x) do {} while (0)
295 #define ASSERT2(x, help) do {} while (0)
296 #define ASSERT_VALID_PTR(p) do {} while (0)
297 #define ASSERT_VALID_PTR_OR_NULL(p) do {} while (0)
298 #define ASSERT_VALID_OBJ(_t, _o) do {} while (0)
299 #define TRACE do {} while (0)
300 #define TRACEMSG(x,...) do {} while (0)
302 #define DECLARE_WALL(name, size) /* nothing */
303 #define FWD_DECLARE_WALL(name, size) /* nothing */
304 #define INIT_WALL(name) do {} while (0)
305 #define CHECK_WALL(name) do {} while (0)
307 #define NEW_INSTANCE(CLASS) do {} while (0)
308 #define DELETE_INSTANCE(CLASS) do {} while (0)
309 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
310 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
311 #define DECLARE_INSTANCE_TRACKING(CLASS)
312 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
314 INLINE void kdbg_init(void) { /* nop */ }
315 INLINE void kputchar(UNUSED(char, c)) { /* nop */ }
316 INLINE void kputs(UNUSED(const char*, str)) { /* nop */ }
318 /* G++ can't inline functions with variable arguments... */
319 #define kprintf(fmt,...) do { (void)(fmt); } while(0)
321 /* ...but GCC can. */
322 INLINE void kprintf(UNUSED(const char*, fmt), ...) { /* nop */ }
327 #endif /* DEVLIB_DEBUG_H */