1 /**************************************************************************
3 * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
30 * Cross-platform debugging helpers.
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.
35 * @author Jose Fonseca <jrfonseca@tungstengraphics.com>
44 #include "p_compiler.h"
64 * Print debug messages.
66 * A debug message will be printed regardless of the DEBUG/NDEBUG macros.
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)
74 void debug_printf(const char *format
, ...);
79 void debug_vprintf(const char *format
, va_list ap
);
81 void debug_assert_fail(const char *expr
, const char *file
, unsigned line
);
86 #define debug_assert(expr) ((expr) ? (void)0 : debug_assert_fail(#expr, __FILE__, __LINE__))
88 #define debug_assert(expr) ((void)0)
95 #define assert(expr) debug_assert(expr)
99 * Set a channel's debug mask.
101 * uuid is just a random 32 bit integer that uniquely identifies the debugging
104 * @note Due to current implementation issues, make sure the lower 8 bits of
107 void debug_mask_set(uint32_t uuid
, uint32_t mask
);
110 uint32_t debug_mask_get(uint32_t uuid
);
114 * Conditional debug output.
116 * This is just a generalization of the debug filtering mechanism used
117 * throughout Gallium.
119 * You use this function as:
122 * #define MYDRIVER_UUID 0x12345678 // random 32 bit identifier
125 * mydriver_debug(uint32_t what, const char *format, ...)
129 * va_start(ap, format);
130 * debug_mask_vprintf(MYDRIVER_UUID, what, format, ap);
137 * debug_mask_set(MYDRIVER_UUID,
138 * MYDRIVER_DEBUG_THIS |
139 * MYDRIVER_DEBUG_THAT |
144 * mydriver_debug(MYDRIVER_DEBUG_THIS,
145 * "this and this happened\n");
147 * mydriver_debug(MYDRIVER_DEBUG_THAT,
148 * "that = %f\n", that);
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.
156 void debug_mask_vprintf(uint32_t uuid
,
163 #define debug_warning(__msg) \
164 debug_printf("%s:%i:warning: %s\n", __FILE__, __LINE__, (__msg))
166 #define debug_warning(__msg) \
172 * Used by debug_dump_enum and debug_dump_flags to describe symbols.
174 struct debug_named_value
182 * Some C pre-processor magic to simplify creating named values.
186 * static const debug_named_value my_names[] = {
187 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X),
188 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y),
189 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z),
190 * DEBUG_NAMED_VALUE_END
194 * debug_printf("%s = %s\n",
196 * debug_dump_enum(my_names, my_value));
200 #define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol}
201 #define DEBUG_NAMED_VALUE_END {NULL, 0}
205 * Convert a enum value to a string.
208 debug_dump_enum(const struct debug_named_value
*names
,
209 unsigned long value
);
213 * Convert binary flags value to a string.
216 debug_dump_flags(const struct debug_named_value
*names
,
217 unsigned long value
);
224 #endif /* P_DEBUG_H_ */