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 #include "p_compiler.h"
  45
  46
  47 #ifdef  __cplusplus
  48 extern "C" {
  49 #endif
  50
  51
  52 #ifdef DBG
  53 #ifndef DEBUG
  54 #define DEBUG 1
  55 #endif
  56 #else
  57 #ifndef NDEBUG
  58 #define NDEBUG 1
  59 #endif
  60 #endif
  61
  62
  63 /**
  64  * Print debug messages.
  65  *
  66  * A debug message will be printed regardless of the DEBUG/NDEBUG macros.
  67  *
  68  * The actual channel used to output debug message is platform specific. To
  69  * avoid misformating or truncation, follow these rules of thumb:
  70  * - output whole lines
  71  * - avoid outputing large strings (512 bytes is the current maximum length
  72  * that is guaranteed to be printed in all platforms)
  73  */
  74 void debug_printf(const char *format, ...);
  75
  76 /**
  77  * @sa debug_printf
  78  */
  79 void debug_vprintf(const char *format, va_list ap);
  80
  81 void debug_assert_fail(const char *expr, const char *file, unsigned line);
  82
  83
  84 /** Assert macro */
  85 #ifdef DEBUG
  86 #define debug_assert(expr) ((expr) ? (void)0 : debug_assert_fail(#expr, __FILE__, __LINE__))
  87 #else
  88 #define debug_assert(expr) ((void)0)
  89 #endif
  90
  91
  92 #ifdef assert
  93 #undef assert
  94 #endif
  95 #define assert(expr) debug_assert(expr)
  96
  97
  98 /**
  99  * Set a channel's debug mask.
 100  *
 101  * uuid is just a random 32 bit integer that uniquely identifies the debugging
 102  * channel.
 103  *
 104  * @note Due to current implementation issues, make sure the lower 8 bits of
 105  * UUID are unique.
 106  */
 107 void debug_mask_set(uint32_t uuid, uint32_t mask);
 108
 109
 110 uint32_t debug_mask_get(uint32_t uuid);
 111
 112
 113 /**
 114  * Conditional debug output.
 115  *
 116  * This is just a generalization of the debug filtering mechanism used
 117  * throughout Gallium.
 118  *
 119  * You use this function as:
 120  *
 121  * @code
 122  * #define MYDRIVER_UUID 0x12345678 // random 32 bit identifier
 123  *
 124  * static void inline
 125  * mydriver_debug(uint32_t what, const char *format, ...)
 126  * {
 127  * #ifdef DEBUG
 128  *    va_list ap;
 129  *    va_start(ap, format);
 130  *    debug_mask_vprintf(MYDRIVER_UUID, what, format, ap);
 131  *    va_end(ap);
 132  * #endif
 133  * }
 134  *
 135  * ...
 136  *
 137  *    debug_mask_set(MYDRIVER_UUID,
 138  *                   MYDRIVER_DEBUG_THIS |
 139  *                   MYDRIVER_DEBUG_THAT |
 140  *                   ... );
 141  *
 142  * ...
 143  *
 144  *    mydriver_debug(MYDRIVER_DEBUG_THIS,
 145  *                   "this and this happened\n");
 146  *
 147  *    mydriver_debug(MYDRIVER_DEBUG_THAT,
 148  *                   "that = %f\n", that);
 149  * ...
 150  * @endcode
 151  *
 152  * You can also define several variants of mydriver_debug, with hardcoded what.
 153  * Note that although macros with variable number of arguments would accomplish
 154  * more in less code, they are not portable.
 155  */
 156 void debug_mask_vprintf(uint32_t uuid,
 157                         uint32_t what,
 158                         const char *format,
 159                         va_list ap);
 160
 161
 162 #ifdef DEBUG
 163 #define debug_warning(__msg) \
 164    debug_printf("%s:%i:warning: %s\n", __FILE__, __LINE__, (__msg))
 165 #else
 166 #define debug_warning(__msg) \
 167    ((void)0)
 168 #endif
 169
 170
 171 #ifdef  __cplusplus
 172 }
 173 #endif
 174
 175 #endif /* P_DEBUG_H_ */