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>
42 #include "os/os_misc.h"
51 #define _util_printf_format(fmt, list) __attribute__ ((format (printf, fmt, list)))
53 #define _util_printf_format(fmt, list)
56 void _debug_vprintf(const char *format, va_list ap);
60 _debug_printf(const char *format, ...)
64 _debug_vprintf(format, ap);
70 * Print debug messages.
72 * The actual channel used to output debug message is platform specific. To
73 * avoid misformating or truncation, follow these rules of thumb:
74 * - output whole lines
75 * - avoid outputing large strings (512 bytes is the current maximum length
76 * that is guaranteed to be printed in all platforms)
78 #if !defined(PIPE_OS_HAIKU)
80 debug_printf(const char *format, ...) _util_printf_format(1,2);
83 debug_printf(const char *format, ...)
88 _debug_vprintf(format, ap);
91 (void) format; /* silence warning */
95 #endif /* !PIPE_OS_HAIKU */
98 * ... isn't portable so we need to pass arguments in parentheses.
101 * debug_printf_once(("awnser: %i\n", 42));
103 #define debug_printf_once(args) \
105 static boolean once = TRUE; \
114 #define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap)
116 #define debug_vprintf(_format, _ap) ((void)0)
122 * Dump a blob in hex to the same place that debug_printf sends its
125 void debug_print_blob( const char *name, const void *blob, unsigned size );
127 /* Print a message along with a prettified format string
129 void debug_print_format(const char *msg, unsigned fmt );
131 #define debug_print_blob(_name, _blob, _size) ((void)0)
132 #define debug_print_format(_msg, _fmt) ((void)0)
137 * Hard-coded breakpoint.
140 #define debug_break() os_break()
142 #define debug_break() ((void)0)
147 debug_get_num_option(const char *name, long dfault);
149 void _debug_assert_fail(const char *expr,
152 const char *function);
158 * Do not expect that the assert call terminates -- errors must be handled
159 * regardless of assert behavior.
161 * For non debug builds the assert macro will expand to a no-op, so do not
162 * call functions with side effects in the assert expression.
165 #define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__))
167 #define debug_assert(expr) do { } while (0 && (expr))
171 /** Override standard assert macro */
175 #define assert(expr) debug_assert(expr)
179 * Output the current function name.
182 #define debug_checkpoint() \
183 _debug_printf("%s\n", __FUNCTION__)
185 #define debug_checkpoint() \
191 * Output the full source code position.
194 #define debug_checkpoint_full() \
195 _debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__)
197 #define debug_checkpoint_full() \
203 * Output a warning message. Muted on release version.
206 #define debug_warning(__msg) \
207 _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg)
209 #define debug_warning(__msg) \
215 * Output an error message. Not muted on release version.
218 #define debug_error(__msg) \
219 _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg)
221 #define debug_error(__msg) \
222 _debug_printf("error: %s\n", __msg)
227 * Used by debug_dump_enum and debug_dump_flags to describe symbols.
229 struct debug_named_value
237 * Some C pre-processor magic to simplify creating named values.
241 * static const debug_named_value my_names[] = {
242 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X),
243 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y),
244 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z),
245 * DEBUG_NAMED_VALUE_END
249 * debug_printf("%s = %s\n",
251 * debug_dump_enum(my_names, my_value));
255 #define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol}
256 #define DEBUG_NAMED_VALUE_END {NULL, 0}
260 * Convert a enum value to a string.
263 debug_dump_enum(const struct debug_named_value *names,
264 unsigned long value);
267 debug_dump_enum_noprefix(const struct debug_named_value *names,
269 unsigned long value);
273 * Convert binary flags value to a string.
276 debug_dump_flags(const struct debug_named_value *names,
277 unsigned long value);
283 * It is an alias for getenv on Linux.
285 * On Windows it reads C:\gallium.cfg, which is a text file with CR+LF line
286 * endings with one option per line as
290 * This file must be terminated with an extra empty line.
293 debug_get_option(const char *name, const char *dfault);
296 debug_get_bool_option(const char *name, boolean dfault);
299 debug_get_num_option(const char *name, long dfault);
302 debug_get_flags_option(const char *name,
303 const struct debug_named_value *flags,
304 unsigned long dfault);
308 debug_memory_begin(void);
311 debug_memory_end(unsigned long beginning);
317 struct pipe_transfer;
320 void debug_dump_image(const char *prefix,
321 unsigned format, unsigned cpp,
322 unsigned width, unsigned height,
325 void debug_dump_surface(struct pipe_context *pipe,
327 struct pipe_surface *surface);
328 void debug_dump_texture(struct pipe_context *pipe,
330 struct pipe_texture *texture);
331 void debug_dump_surface_bmp(struct pipe_context *pipe,
332 const char *filename,
333 struct pipe_surface *surface);
334 void debug_dump_transfer_bmp(struct pipe_context *pipe,
335 const char *filename,
336 struct pipe_transfer *transfer);
337 void debug_dump_float_rgba_bmp(const char *filename,
338 unsigned width, unsigned height,
339 float *rgba, unsigned stride);
341 #define debug_dump_image(prefix, format, cpp, width, height, stride, data) ((void)0)
342 #define debug_dump_surface(pipe, prefix, surface) ((void)0)
343 #define debug_dump_surface_bmp(pipe, filename, surface) ((void)0)
344 #define debug_dump_transfer_bmp(filename, transfer) ((void)0)
345 #define debug_dump_float_rgba_bmp(filename, width, height, rgba, stride) ((void)0)
353 #endif /* U_DEBUG_H_ */