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. Freestanding (AKA embedded)
11 * applications use drv/kdebug.c to output diagnostic messages to a serial terminal
15 * \author Bernardo Innocenti <bernie@develer.com>
20 *#* Revision 1.3 2004/09/20 03:31:27 bernie
23 *#* Revision 1.2 2004/09/14 21:01:46 bernie
24 *#* Mark assertions as LIKELY().
26 *#* Revision 1.1 2004/09/14 20:19:47 bernie
27 *#* Unified debug macros.
29 *#* Revision 1.3 2004/09/06 12:11:29 bernie
30 *#* Merge debug.h with DevLib.
32 *#* Revision 1.2 2004/08/13 03:22:07 bernie
33 *#* Resurrect some debug macros from old projects.
35 *#* Revision 1.1 2004/08/12 06:56:35 bernie
36 *#* Move debug.h from device/ to util/.
38 *#* Revision 1.1 2004/08/12 06:52:26 bernie
39 *#* Factor out a few simple debug macros.
42 #ifndef DEVLIB_DEBUG_H
43 #define DEVLIB_DEBUG_H
46 * Try to guess whether we're running in a hosted or embedded environment.
49 #if defined(__unix__) || defined(_WIN32)
54 #endif /* !OS_HOSTED */
58 * For now, avoid dependency on compiler.h
61 #define FORMAT(x,y,z) /* nothing */
64 #define INLINE static inline
67 #define UNUSED(type,name) type
69 #else /* !OS_HOSTED */
71 #endif /* !OS_HOSTED */
76 * This preprocessor symbol is defined only in debug builds.
78 * The build infrastructure must arrange for _DEBUG to
79 * be prepredefined for all source files being compiled.
81 * This is compatible with the Microsoft convention for
82 * the default Debug and Release targets.
86 // STLport specific: enable extra checks
89 // MSVC specific: Enable memory allocation debug
95 * On UNIX systems the extabilished practice is to define
96 * NDEBUG for release builds and nothing for debug builds.
103 * This macro duplicates the old MSVC trick of redefining
104 * THIS_FILE locally to avoid the overhead of many duplicate
105 * strings in ASSERT().
108 #define THIS_FILE __FILE__
112 * This macro can be used to conditionally exclude one or more
113 * statements conditioned on \c _DEBUG, avoiding the clutter
114 * of #ifdef/#endif pairs.
121 * DB(int ref_count;) // Track number of users
136 INLINE void kdbg_init(void) { /* nop */ }
137 INLINE void kputchar(char c)
141 INLINE void kputs(const char *str)
145 INLINE void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2)
149 vfprintf(stderr, fmt, ap);
152 void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */
156 #define ASSERT(x) assert(x)
160 * Check that the given pointer is not NULL or pointing to raw memory.
162 * The assumption here is that valid pointers never point to low
163 * memory regions. This helps catching pointers taken from
164 * struct/class memebers when the struct pointer was NULL.
166 #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200)
168 #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200)))
169 #else /* !OS_HOSTED */
171 /* These are implemented in drv/kdebug.c */
172 void kdbg_init(void);
173 void kputchar(char c);
174 void kdump(const void *buf, size_t len);
177 #include <avr/pgmspace.h>
178 void kputs_P(const char *PROGMEM str);
179 void kprintf_P(const char *PROGMEM fmt, ...) FORMAT(__printf__, 1, 2);
180 int __assert_P(const char *PROGMEM cond, const char *PROGMEM file, int line);
181 int __invalid_ptr_P(void *p, const char *PROGMEM name, const char *PROGMEM file, int line);
182 #define kputs(str) kputs_P(PSTR(str))
183 #define kprintf(fmt, ...) kprintf_P(PSTR(fmt) ,## __VA_ARGS__)
184 #define __assert(cond, file, line) __assert_P(PSTR(cond), PSTR(file), (line))
185 #define __invalid_ptr(p, name, file, line) __invalid_ptr_P((p), PSTR(name), PSTR(file), (line))
187 void kputs(const char *str);
188 void kprintf(const char * fmt, ...) FORMAT(__printf__, 1, 2);
189 int __assert(const char *cond, const char *file, int line);
190 int __invalid_ptr(void *p, const char *name, const char *file, int line);
191 #endif /* !__AVR__ */
193 void __init_wall(long *wall, int size);
194 int __check_wall(long *wall, int size, const char *name, const char *file, int line);
196 #ifndef CONFIG_KDEBUG_ASSERT_NO_TEXT
197 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert(#x, THIS_FILE, __LINE__)))
198 #define ASSERT2(x, help) ((void)(LIKELY(x) ? 0 : __assert(help " (" #x ")", THIS_FILE, __LINE__)))
200 #define ASSERT(x) ((void)(LIKELY(x) ? 0 : __assert("", THIS_FILE, __LINE__)))
201 #define ASSERT2(x, help) ((void)ASSERT(x))
204 #define ASSERT_VALID_PTR(p) ((void)(LIKELY((p) >= 0x200) ? 0 : __invalid_ptr(p, #p, THIS_FILE, __LINE__)))
205 #define ASSERT_VALID_PTR_OR_NULL(p) ((void)(LIKELY((p == NULL) || ((p) >= 0x200)) ? 0 : __invalid_ptr((p), #p, THIS_FILE, __LINE__)))
206 #define TRACE kprintf("%s()\n", __FUNCTION__)
207 #define TRACEMSG(msg,...) kprintf("%s(): " msg "\n", __FUNCTION__, ## __VA_ARGS__)
209 #endif /* !OS_HOSTED */
212 * \name Walls to detect data corruption
216 #define WALL_VALUE (long)0xABADCAFEL
217 #define DECLARE_WALL(name,size) long name[(size) / sizeof(long)];
218 #define FWD_DECLARE_WALL(name,size) extern long name[(size) / sizeof(long)];
219 #define INIT_WALL(name) __init_wall((name), countof(name))
220 #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__)
224 * Check that the given pointer actually points to an object
225 * of the specified type.
227 #define ASSERT_VALID_OBJ(_t, _o) do { \
228 ASSERT_VALID_PTR((_o)); \
229 ASSERT(dynamic_cast<_t>((_o)) != NULL); \
233 * \name Debug object creation and destruction.
235 * These macros help track some kinds of leaks in C++ programs.
236 * Usage is as follows:
241 * DECLARE_INSTANCE_TRACKING(Foo)
251 * DELETE_INSTANCE(Foo);
256 * // Put this in the implementation file of the class
257 * IMPLEMENT_INSTANCE_TRACKING(Foo)
262 * Foo *foo = new Foo;
263 * cout << GET_INSTANCE_COUNT(Foo) << endl; // prints "1"
265 * ASSERT_ZERO_INSTANCES(Foo); // OK
270 #define NEW_INSTANCE(CLASS) do { ++CLASS::__instances } while (0)
271 #define DELETE_INSTANCE(CLASS) do { --CLASS::__instances } while (0)
272 #define ASSERT_ZERO_INSTANCES(CLASS) ASSERT(CLASS::__instances == 0)
273 #define GET_INSTANCE_COUNT(CLASS) (CLASS::__instances)
274 #define DECLARE_INSTANCE_TRACKING(CLASS) static int __instances
275 #define IMPLEMENT_INSTANCE_TRACKING(CLASS) int CLASS::__instances = 0
280 * On UNIX systems the extabilished practice is to define
281 * NDEBUG for release builds and nothing for debug builds.
287 #define DB(x) /* nothing */
289 #define ASSERT(x) do {} while (0)
291 #define ASSERT2(x, help) do {} while (0)
292 #define ASSERT_VALID_PTR(p) do {} while (0)
293 #define ASSERT_VALID_PTR_OR_NULL(p) do {} while (0)
294 #define ASSERT_VALID_OBJ(_t, _o) do {} while (0)
295 #define TRACE do {} while (0)
296 #define TRACEMSG(x,...) do {} while (0)
298 #define DECLARE_WALL(name, size) /* nothing */
299 #define FWD_DECLARE_WALL(name, size) /* nothing */
300 #define INIT_WALL(name) do {} while (0)
301 #define CHECK_WALL(name) do {} while (0)
303 #define NEW_INSTANCE(CLASS) do {} while (0)
304 #define DELETE_INSTANCE(CLASS) do {} while (0)
305 #define ASSERT_ZERO_INSTANCES(CLASS) do {} while (0)
306 #define GET_INSTANCE_COUNT(CLASS) ERROR_ONLY_FOR_DEBUG
307 #define DECLARE_INSTANCE_TRACKING(CLASS)
308 #define IMPLEMENT_INSTANCE_TRACKING(CLASS)
310 INLINE void kdbg_init(void) { /* nop */ }
311 INLINE void kputchar(UNUSED(char, c)) { /* nop */ }
312 INLINE void kputs(UNUSED(const char*, str)) { /* nop */ }
314 /* G++ can't inline functions with variable arguments... */
315 #define kprintf(fmt,...) do { (void)(fmt); } while(0)
317 /* ...but GCC can. */
318 INLINE void kprintf(UNUSED(const char*, fmt), ...) { /* nop */ }
323 #endif /* DEVLIB_DEBUG_H */