X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=cfg%2Fdebug.h;h=91fefb72b17d6912fd0eb5b2dcc60ead1ba45760;hb=8bab11971bc4e89f1a0ab56101ed3babf93fcd1d;hp=38029081aa5ae942f1f5c918223b1a34fae5d3e0;hpb=126666459b99272b966ba70e946a27e547ec4600;p=bertos.git diff --git a/cfg/debug.h b/cfg/debug.h old mode 100755 new mode 100644 index 38029081..91fefb72 --- a/cfg/debug.h +++ b/cfg/debug.h @@ -1,8 +1,33 @@ -/*! +/** * \file * * * \brief Simple debug facilities for hosted and embedded C/C++ applications. @@ -15,78 +40,11 @@ * \author Bernardo Innocenti */ -/*#* - *#* $Log$ - *#* Revision 1.7 2006/02/20 02:01:56 bernie - *#* Depend on cfg/os.h. - *#* - *#* Revision 1.6 2006/02/17 22:28:37 bernie - *#* Support TRACE() and TRACEMSG() on hosted targets. - *#* - *#* Revision 1.5 2005/11/04 16:09:03 bernie - *#* Doxygen workaround. - *#* - *#* Revision 1.4 2005/07/03 15:18:52 bernie - *#* Typo. - *#* - *#* Revision 1.3 2005/06/27 21:23:55 bernie - *#* Rename cfg/config.h to appconfig.h. - *#* - *#* Revision 1.2 2005/04/11 19:10:27 bernie - *#* Include top-level headers from cfg/ subdir. - *#* - *#* Revision 1.1 2005/04/11 19:04:13 bernie - *#* Move top-level headers to cfg/ subdir. - *#* - *#* Revision 1.13 2005/03/01 23:23:58 bernie - *#* Provide defaults for CONFIG_KDEBUG_DISABLE_TRACE and CONFIG_KDEBUG_ASSERT_NO_TEXT. - *#* - *#* Revision 1.12 2005/02/18 11:18:33 bernie - *#* Fixes for Harvard processors from project_ks. - *#* - *#* Revision 1.11 2005/02/16 20:29:48 bernie - *#* TRACE(), TRACEMSG(): Reduce code and data footprint. - *#* - *#* Revision 1.10 2005/02/09 21:50:28 bernie - *#* Declare dummy ASSERT* macros as ((void)0) to work around a warning I can't remember any more. - *#* - *#* Revision 1.9 2005/01/25 08:36:40 bernie - *#* kputnum(): Export. - *#* - *#* Revision 1.8 2005/01/11 18:08:08 aleph - *#* Add empty kdump definition for debug off - *#* - *#* Revision 1.7 2004/12/31 17:43:09 bernie - *#* Use UNUSED_ARG instead of obsolete UNUSED macro. - *#* - *#* Revision 1.6 2004/12/08 08:52:00 bernie - *#* Save some more RAM on AVR. - *#*/ #ifndef DEVLIB_DEBUG_H #define DEVLIB_DEBUG_H #include - -#if OS_HOSTED - /* - * For now, avoid dependency on compiler.h - */ - #ifndef FORMAT - #define FORMAT(x,y,z) /* nothing */ - #endif - #ifndef INLINE - #define INLINE static inline - #endif - #ifndef UNUSED_ARG - #ifdef __cplusplus - #define UNUSED_ARG(type,name) type - #else - #define UNUSED_ARG(type,name) type name - #endif - #endif -#else /* !OS_HOSTED */ - #include -#endif /* !OS_HOSTED */ +#include /* @@ -100,18 +58,19 @@ #define CONFIG_KDEBUG_ASSERT_NO_TEXT 0 #endif +#if defined(__doxygen__) + /** + * Preprocessor symbol defined only for debug builds. + * + * The build infrastructure must arrange for _DEBUG to + * be predefined for all the source files being compiled. + * + * This is compatible with the MSVC convention for the + * default Debug and Release project targets. + */ + #define _DEBUG 1 +#endif -/*! - * \def _DEBUG - * - * This preprocessor symbol is defined only in debug builds. - * - * The build infrastructure must arrange for _DEBUG to - * be predefined for all source files being compiled. - * - * This is compatible with the Microsoft convention for - * the default Debug and Release targets. - */ #ifdef _DEBUG // STLport specific: enable extra checks @@ -130,7 +89,7 @@ #undef NDEBUG #endif - /*! + /** * This macro duplicates the old MSVC trick of redefining * THIS_FILE locally to avoid the overhead of many duplicate * strings in ASSERT(). @@ -139,7 +98,7 @@ #define THIS_FILE __FILE__ #endif - /*! + /** * This macro can be used to conditionally exclude one or more * statements conditioned on \c _DEBUG, avoiding the clutter * of ifdef/endif pairs. @@ -173,9 +132,23 @@ { fputs(str, stderr); } - /* G++ can't inline functions with variable arguments... */ - #define kprintf(fmt, ...) fprintf(stderr, fmt, ## __VA_ARGS__) - #define kvprintf(fmt, ap) vfprintf(stderr, fmt, ap) + #if COMPILER_VARIADIC_MACROS + /* G++ can't inline functions with variable arguments... */ + #define kprintf(fmt, ...) fprintf(stderr, fmt, ## __VA_ARGS__) + #else + #define kvprintf(fmt, ap) vfprintf(stderr, fmt, ap) + INLINE int kprintf(const char *fmt, ...) + { + va_list ap; + int result; + + va_start(ap, fmt); + result = kvprintf(fmt, ap); + va_end(ap); + + return result; + } + #endif void kdump(const void *buf, size_t len); /* UNIMPLEMENTED */ #ifndef ASSERT @@ -184,8 +157,8 @@ #endif /* ASSERT */ #define ASSERT2(x, help) ASSERT(help && x) - /*! - * Check that the given pointer is not NULL or pointing to raw memory. + /** + * Check that the given pointer is either NULL or pointing to valid memory. * * The assumption here is that valid pointers never point to low * memory regions. This helps catching pointers taken from @@ -193,11 +166,27 @@ */ #define ASSERT_VALID_PTR(p) ASSERT((unsigned long)(p) > 0x200) + /** + * Check that the given pointer is not pointing to invalid memory. + * + * \see ASSERT_VALID_PTR() + */ #define ASSERT_VALID_PTR_OR_NULL(p) ASSERT((((p) == NULL) || ((unsigned long)(p) >= 0x200))) #if !CONFIG_KDEBUG_DISABLE_TRACE - #define TRACE kporintf("%s()\n", __func__) - #define TRACEMSG(msg,...) kprintf("%s(): " msg, __func__, ## __VA_ARGS__) + #define TRACE kprintf("%s()\n", __func__) + #if COMPILER_VARIADIC_MACROS + #define TRACEMSG(msg,...) kprintf("%s(): " msg, __func__, ## __VA_ARGS__) + #else + INLINE void TRACEMSG(const char *fmt, ...) + { + va_list va; + va_start(va, fmt); + kprintf("%s(): ", __func__); + kvprintf(fmt, va); + va_end(va); + } + #endif #else #define TRACE do {} while(0) #define TRACEMSG(...) do {} while(0) @@ -206,7 +195,7 @@ #else /* !OS_HOSTED */ #include /* CONFIG_KDEBUG_ASSERT_NO_TEXT */ - #include /* CPU_HARVARD */ + #include /* CPU_HARVARD */ /* These are implemented in drv/kdebug.c */ void kdbg_init(void); @@ -262,7 +251,7 @@ #endif /* !OS_HOSTED */ - /*! + /** * \name Walls to detect data corruption * \{ */ @@ -274,7 +263,7 @@ #define CHECK_WALL(name) __check_wall((name), countof(name), #name, THIS_FILE, __LINE__) /*\}*/ - /*! + /** * Check that the given pointer actually points to an object * of the specified type. */ @@ -283,7 +272,7 @@ ASSERT(dynamic_cast<_t>((_o)) != NULL); \ } - /*! + /** * \name Debug object creation and destruction. * * These macros help track some kinds of leaks in C++ programs. @@ -348,7 +337,14 @@ #define ASSERT_VALID_PTR_OR_NULL(p) ((void)0) #define ASSERT_VALID_OBJ(_t, _o) ((void)0) #define TRACE do {} while (0) - #define TRACEMSG(x,...) do {} while (0) + #if COMPILER_VARIADIC_MACROS + #define TRACEMSG(x, ...) do {} while (0) + #else + INLINE void TRACEMSG(UNUSED_ARG(const char *, msg), ...) + { + /* NOP */ + } + #endif #define DECLARE_WALL(name, size) /* nothing */ #define FWD_DECLARE_WALL(name, size) /* nothing */ @@ -368,12 +364,12 @@ INLINE void kputs(UNUSED_ARG(const char *, str)) { /* nop */ } INLINE void kdump(UNUSED_ARG(const void *, buf), UNUSED_ARG(size_t, len)) { /* nop */ } - #ifdef __cplusplus + #if defined(__cplusplus) && COMPILER_VARIADIC_MACROS /* G++ can't inline functions with variable arguments... */ #define kprintf(fmt,...) do { (void)(fmt); } while(0) #else /* ...but GCC can. */ - INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ } + INLINE void kprintf(UNUSED_ARG(const char *, fmt), ...) { /* nop */ } #endif #endif /* _DEBUG */