src/gallium/include/pipe/p_debug.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * @file
  30  * Cross-platform debugging helpers.
  31  *
  32  * For now it just has assert and printf replacements, but it might be extended
  33  * with stack trace reports and more advanced logging in the near future.
  34  *
  35  * @author Jose Fonseca <jrfonseca@tungstengraphics.com>
  36  */
  37
  38 #ifndef P_DEBUG_H_
  39 #define P_DEBUG_H_
  40
  41
  42 #include <stdarg.h>
  43
  44
  45 #ifdef  __cplusplus
  46 extern "C" {
  47 #endif
  48
  49
  50 #ifdef DBG
  51 #ifndef DEBUG
  52 #define DEBUG 1
  53 #endif
  54 #else
  55 #ifndef NDEBUG
  56 #define NDEBUG 1
  57 #endif
  58 #endif
  59
  60
  61 /**
  62  * Print debug messages.
  63  *
  64  * A debug message will be printed regardless of the DEBUG/NDEBUG macros.
  65  *
  66  * The actual channel used to output debug message is platform specific. To
  67  * avoid misformating or truncation, follow these rules of thumb:
  68  * - output whole lines
  69  * - avoid outputing large strings (512 bytes is the current maximum length
  70  * that is guaranteed to be printed in all platforms)
  71  */
  72 void debug_printf(const char *format, ...);
  73
  74 /**
  75  * @sa debug_printf
  76  */
  77 void debug_vprintf(const char *format, va_list ap);
  78
  79 void debug_assert_fail(const char *expr, const char *file, unsigned line);
  80
  81
  82 /** Assert macro */
  83 #ifdef DEBUG
  84 #define debug_assert(expr) ((expr) ? (void)0 : debug_assert_fail(#expr, __FILE__, __LINE__))
  85 #else
  86 #define debug_assert(expr) ((void)0)
  87 #endif
  88
  89
  90 #ifdef assert
  91 #undef assert
  92 #endif
  93 #define assert(expr) debug_assert(expr)
  94
  95
  96 #ifdef  __cplusplus
  97 }
  98 #endif
  99
 100 #endif /* P_DEBUG_H_ */