gallium: cleanup p_debug
authorJosé Fonseca <jrfonseca@tungstengraphics.com>
Mon, 24 Mar 2008 20:18:59 +0000 (20:18 +0000)
committerJosé Fonseca <jrfonseca@tungstengraphics.com>
Mon, 24 Mar 2008 22:31:36 +0000 (22:31 +0000)
Now debug_printf is disabled on release builds. Use debug_error or
_debug_printf to output messages on release versions.

src/gallium/auxiliary/util/p_debug.c
src/gallium/include/pipe/p_debug.h

index 19ad3f4..bd58e0e 100644 (file)
@@ -58,7 +58,7 @@ int rpl_snprintf(char *str, size_t size, const char *format, ...);
 #endif
 
 
-void debug_vprintf(const char *format, va_list ap)
+void _debug_vprintf(const char *format, va_list ap)
 {
 #ifdef WIN32
 #ifndef WINCE
@@ -76,15 +76,7 @@ void debug_vprintf(const char *format, va_list ap)
 }
 
 
-void debug_printf(const char *format, ...)
-{
-   va_list ap;
-   va_start(ap, format);
-   debug_vprintf(format, ap);
-   va_end(ap);
-}
-
-
+#ifdef DEBUG
 void debug_print_blob( const char *name,
                        const void *blob,
                        unsigned size )
@@ -99,12 +91,10 @@ void debug_print_blob( const char *name,
       debug_printf("%d:\t%08x\n", i, ublob[i]);
    }
 }
+#endif
 
 
-/* TODO: implement a debug_abort that calls EngBugCheckEx on WIN32 */
-
-
-static INLINE void debug_break(void) 
+void _debug_break(void) 
 {
 #if (defined(__i386__) || defined(__386__)) && defined(__GNUC__)
    __asm("int3");
@@ -155,15 +145,18 @@ static unsigned abort_en()
 }
 #endif
 
-void debug_assert_fail(const char *expr, const char *file, unsigned line) 
+void _debug_assert_fail(const char *expr, 
+                        const char *file, 
+                        unsigned line, 
+                        const char *function) 
 {
-   debug_printf("%s:%i: Assertion `%s' failed.\n", file, line, expr);
+   _debug_printf("%s:%u:%s: Assertion `%s' failed.\n", file, line, function, expr);
    if (abort_en())
    {
       debug_break();
    } else
    {
-      debug_printf("continuing...\n");
+      _debug_printf("continuing...\n");
    }
 }
 
@@ -180,7 +173,7 @@ debug_dump_enum(const struct debug_named_value *names,
       ++names;
    }
 
-   snprintf(rest, sizeof(rest), "0x%08x", value);
+   snprintf(rest, sizeof(rest), "0x%08lx", value);
    return rest;
 }
 
@@ -213,7 +206,7 @@ debug_dump_flags(const struct debug_named_value *names,
       else
         first = 0;
       
-      snprintf(rest, sizeof(rest), "0x%08x", value);
+      snprintf(rest, sizeof(rest), "0x%08lx", value);
       strncat(output, rest, sizeof(output));
    }
    
index 15fc200..494cc3b 100644 (file)
@@ -60,52 +60,135 @@ extern "C" {
 #endif
 
 
+void _debug_vprintf(const char *format, va_list ap);
+   
+
+static void INLINE 
+_debug_printf(const char *format, ...)
+{
+   va_list ap;
+   va_start(ap, format);
+   _debug_vprintf(format, ap);
+   va_end(ap);
+}
+
+
 /**
  * Print debug messages.
  *
- * A debug message will be printed regardless of the DEBUG/NDEBUG macros.
- *
  * The actual channel used to output debug message is platform specific. To 
  * avoid misformating or truncation, follow these rules of thumb:   
  * - output whole lines
  * - avoid outputing large strings (512 bytes is the current maximum length 
  * that is guaranteed to be printed in all platforms)
  */
-void debug_printf(const char *format, ...);
+static void INLINE 
+debug_printf(const char *format, ...)
+{
+#ifdef DEBUG
+   va_list ap;
+   va_start(ap, format);
+   _debug_vprintf(format, ap);
+   va_end(ap);
+#endif
+}
+
 
+#ifdef DEBUG
+#define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap)
+#else
+#define debug_vprintf(_format, _ap) ((void)0)
+#endif
 
-/* Dump a blob in hex to the same place that debug_printf sends its
- * messages:
+
+/**
+ * Dump a blob in hex to the same place that debug_printf sends its
+ * messages.
  */
+#ifdef DEBUG
 void debug_print_blob( const char *name,
                        const void *blob,
                        unsigned size );
+#else
+#define debug_print_blob(_name, _blob, _size) ((void)0)
+#endif
+
+
+void _debug_break(void);
+
 
 /**
- * @sa debug_printf 
+ * Hard-coded breakpoint.
  */
-void debug_vprintf(const char *format, va_list ap);
+#ifdef DEBUG
+#if (defined(__i386__) || defined(__386__)) && defined(__GNUC__)
+#define debug_break() __asm("int3")
+#elif (defined(__i386__) || defined(__386__)) && defined(__MSC__)
+#define debug_break()  _asm {int 3}
+#else
+#define debug_break() _debug_break()
+#endif
+#else /* !DEBUG */
+#define debug_break() ((void)0)
+#endif /* !DEBUG */
+
 
-void debug_assert_fail(const char *expr, const char *file, unsigned line);
+void _debug_assert_fail(const char *expr, 
+                        const char *file, 
+                        unsigned line, 
+                        const char *function);
 
 
-/** Assert macro */
+/** 
+ * Assert macro
+ * 
+ * Do not expect that the assert call terminates -- errors must be handled 
+ * regardless of assert behavior.
+ */
 #ifdef DEBUG
-#define debug_assert(expr) ((expr) ? (void)0 : debug_assert_fail(#expr, __FILE__, __LINE__))
+#define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__))
 #else
 #define debug_assert(expr) ((void)0)
 #endif
 
 
+/** Override standard assert macro */
 #ifdef assert
 #undef assert
 #endif
 #define assert(expr) debug_assert(expr)
 
 
+/**
+ * Output the current function name.
+ */
+#ifdef DEBUG
+#define debug_checkpoint() \
+   _debug_printf("%s\n", __FUNCTION__)
+#else
+#define debug_checkpoint() \
+   ((void)0) 
+#endif
+
+
+/**
+ * Output the full source code position.
+ */
+#ifdef DEBUG
+#define debug_checkpoint_full() \
+   debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__) 
+#else
+#define debug_checkpoint_full() \
+   ((void)0) 
+#endif
+
+
+/**
+ * Output a warning message. Muted on release version.
+ */
 #ifdef DEBUG
 #define debug_warning(__msg) \
-   debug_printf("%s:%i:warning: %s\n", __FILE__, __LINE__, (__msg)) 
+   _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, (__msg))
 #else
 #define debug_warning(__msg) \
    ((void)0) 
@@ -113,6 +196,18 @@ void debug_assert_fail(const char *expr, const char *file, unsigned line);
 
 
 /**
+ * Output an error message. Not muted on release version.
+ */
+#ifdef DEBUG
+#define debug_error(__msg) \
+   _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, (__msg)) 
+#else
+#define debug_error(__msg) \
+   _debug_printf("error: %s\n", __msg))
+#endif
+
+
+/**
  * Used by debug_dump_enum and debug_dump_flags to describe symbols.
  */
 struct debug_named_value