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"
62 void _debug_vprintf(const char *format
, va_list ap
);
66 _debug_printf(const char *format
, ...)
70 _debug_vprintf(format
, ap
);
76 * Print debug messages.
78 * The actual channel used to output debug message is platform specific. To
79 * avoid misformating or truncation, follow these rules of thumb:
80 * - output whole lines
81 * - avoid outputing large strings (512 bytes is the current maximum length
82 * that is guaranteed to be printed in all platforms)
85 debug_printf(const char *format
, ...)
90 _debug_vprintf(format
, ap
);
93 (void) format
; /* silence warning */
99 #define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap)
101 #define debug_vprintf(_format, _ap) ((void)0)
107 * Dump a blob in hex to the same place that debug_printf sends its
110 void debug_print_blob( const char *name
, const void *blob
, unsigned size
);
112 /* Print a message along with a prettified format string
114 void debug_print_format(const char *msg
, unsigned fmt
);
116 #define debug_print_blob(_name, _blob, _size) ((void)0)
117 #define debug_print_format(_msg, _fmt) ((void)0)
121 void _debug_break(void);
125 * Hard-coded breakpoint.
128 #if (defined(__i386__) || defined(__386__)) && defined(__GNUC__)
129 #define debug_break() __asm("int3")
130 #elif (defined(__i386__) || defined(__386__)) && defined(__MSC__)
131 #define debug_break() _asm {int 3}
133 #define debug_break() _debug_break()
136 #define debug_break() ((void)0)
141 debug_get_num_option(const char *name
, long dfault
);
143 void _debug_assert_fail(const char *expr
,
146 const char *function
);
152 * Do not expect that the assert call terminates -- errors must be handled
153 * regardless of assert behavior.
156 #define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__))
158 #define debug_assert(expr) ((void)0)
162 /** Override standard assert macro */
166 #define assert(expr) debug_assert(expr)
170 * Output the current function name.
173 #define debug_checkpoint() \
174 _debug_printf("%s\n", __FUNCTION__)
176 #define debug_checkpoint() \
182 * Output the full source code position.
185 #define debug_checkpoint_full() \
186 _debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__)
188 #define debug_checkpoint_full() \
194 * Output a warning message. Muted on release version.
197 #define debug_warning(__msg) \
198 _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg)
200 #define debug_warning(__msg) \
206 * Output an error message. Not muted on release version.
209 #define debug_error(__msg) \
210 _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg)
212 #define debug_error(__msg) \
213 _debug_printf("error: %s\n", __msg)
218 * Used by debug_dump_enum and debug_dump_flags to describe symbols.
220 struct debug_named_value
228 * Some C pre-processor magic to simplify creating named values.
232 * static const debug_named_value my_names[] = {
233 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X),
234 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y),
235 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z),
236 * DEBUG_NAMED_VALUE_END
240 * debug_printf("%s = %s\n",
242 * debug_dump_enum(my_names, my_value));
246 #define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol}
247 #define DEBUG_NAMED_VALUE_END {NULL, 0}
251 * Convert a enum value to a string.
254 debug_dump_enum(const struct debug_named_value
*names
,
255 unsigned long value
);
259 * Convert binary flags value to a string.
262 debug_dump_flags(const struct debug_named_value
*names
,
263 unsigned long value
);
269 * It is an alias for getenv on Linux.
271 * On Windows it reads C:\gallium.cfg, which is a text file with CR+LF line
272 * endings with one option per line as
276 * This file must be terminated with an extra empty line.
279 debug_get_option(const char *name
, const char *dfault
);
282 debug_get_bool_option(const char *name
, boolean dfault
);
285 debug_get_unsigned_option(const char *name
, long dfault
);
288 debug_get_flags_option(const char *name
,
289 const struct debug_named_value
*flags
,
290 unsigned long dfault
);
294 debug_malloc(const char *file
, unsigned line
, const char *function
,
298 debug_free(const char *file
, unsigned line
, const char *function
,
302 debug_calloc(const char *file
, unsigned line
, const char *function
,
303 size_t count
, size_t size
);
306 debug_realloc(const char *file
, unsigned line
, const char *function
,
307 void *old_ptr
, size_t old_size
, size_t new_size
);
310 debug_memory_begin(void);
313 debug_memory_end(unsigned long beginning
);
316 #if defined(PROFILE) && defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY)
319 debug_profile_start(void);
322 debug_profile_stop(void);
328 void debug_dump_image(const char *prefix
,
329 unsigned format
, unsigned cpp
,
330 unsigned width
, unsigned height
,
334 #define debug_dump_image(prefix, format, cpp, width, height, pitch, data) ((void)0)
342 #endif /* P_DEBUG_H_ */