u_debug.h revision 6b424a0550a5196818641857974f4cb04d61b933
1d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org/************************************************************************** 2d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * 3d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas. 4d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * All Rights Reserved. 5d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * 6d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * Permission is hereby granted, free of charge, to any person obtaining a 7d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * copy of this software and associated documentation files (the 8d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * "Software"), to deal in the Software without restriction, including 9d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * without limitation the rights to use, copy, modify, merge, publish, 10d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * distribute, sub license, and/or sell copies of the Software, and to 11d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * permit persons to whom the Software is furnished to do so, subject to 12d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * the following conditions: 13d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * 14d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * The above copyright notice and this permission notice (including the 15d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * next paragraph) shall be included in all copies or substantial portions 16d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * of the Software. 17d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * 18d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR 22d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org * 26d3a78a9cab563bf52c69a382ac65dda2c1c8b5cffischman@chromium.org **************************************************************************/ 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 U_DEBUG_H_ 39#define U_DEBUG_H_ 40 41 42#include "os/os_misc.h" 43 44 45#ifdef __cplusplus 46extern "C" { 47#endif 48 49 50#if defined(__GNUC__) 51#define _util_printf_format(fmt, list) __attribute__ ((format (printf, fmt, list))) 52#else 53#define _util_printf_format(fmt, list) 54#endif 55 56void _debug_vprintf(const char *format, va_list ap); 57 58 59static INLINE void 60_debug_printf(const char *format, ...) 61{ 62 va_list ap; 63 va_start(ap, format); 64 _debug_vprintf(format, ap); 65 va_end(ap); 66} 67 68 69/** 70 * Print debug messages. 71 * 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) 77 */ 78#if !defined(PIPE_OS_HAIKU) 79static INLINE void 80debug_printf(const char *format, ...) _util_printf_format(1,2); 81 82static INLINE void 83debug_printf(const char *format, ...) 84{ 85#ifdef DEBUG 86 va_list ap; 87 va_start(ap, format); 88 _debug_vprintf(format, ap); 89 va_end(ap); 90#else 91 (void) format; /* silence warning */ 92#endif 93} 94 95#endif /* !PIPE_OS_HAIKU */ 96 97/* 98 * ... isn't portable so we need to pass arguments in parentheses. 99 * 100 * usage: 101 * debug_printf_once(("awnser: %i\n", 42)); 102 */ 103#define debug_printf_once(args) \ 104 do { \ 105 static boolean once = TRUE; \ 106 if (once) { \ 107 once = FALSE; \ 108 debug_printf args; \ 109 } \ 110 } while (0) 111 112 113#ifdef DEBUG 114#define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap) 115#else 116#define debug_vprintf(_format, _ap) ((void)0) 117#endif 118 119 120#ifdef DEBUG 121/** 122 * Dump a blob in hex to the same place that debug_printf sends its 123 * messages. 124 */ 125void debug_print_blob( const char *name, const void *blob, unsigned size ); 126 127/* Print a message along with a prettified format string 128 */ 129void debug_print_format(const char *msg, unsigned fmt ); 130#else 131#define debug_print_blob(_name, _blob, _size) ((void)0) 132#define debug_print_format(_msg, _fmt) ((void)0) 133#endif 134 135 136/** 137 * Hard-coded breakpoint. 138 */ 139#ifdef DEBUG 140#define debug_break() os_break() 141#else /* !DEBUG */ 142#define debug_break() ((void)0) 143#endif /* !DEBUG */ 144 145 146long 147debug_get_num_option(const char *name, long dfault); 148 149void _debug_assert_fail(const char *expr, 150 const char *file, 151 unsigned line, 152 const char *function); 153 154 155/** 156 * Assert macro 157 * 158 * Do not expect that the assert call terminates -- errors must be handled 159 * regardless of assert behavior. 160 * 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. 163 */ 164#ifdef DEBUG 165#define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__)) 166#else 167#define debug_assert(expr) do { } while (0 && (expr)) 168#endif 169 170 171/** Override standard assert macro */ 172#ifdef assert 173#undef assert 174#endif 175#define assert(expr) debug_assert(expr) 176 177 178/** 179 * Output the current function name. 180 */ 181#ifdef DEBUG 182#define debug_checkpoint() \ 183 _debug_printf("%s\n", __FUNCTION__) 184#else 185#define debug_checkpoint() \ 186 ((void)0) 187#endif 188 189 190/** 191 * Output the full source code position. 192 */ 193#ifdef DEBUG 194#define debug_checkpoint_full() \ 195 _debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__) 196#else 197#define debug_checkpoint_full() \ 198 ((void)0) 199#endif 200 201 202/** 203 * Output a warning message. Muted on release version. 204 */ 205#ifdef DEBUG 206#define debug_warning(__msg) \ 207 _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 208#else 209#define debug_warning(__msg) \ 210 ((void)0) 211#endif 212 213 214/** 215 * Output an error message. Not muted on release version. 216 */ 217#ifdef DEBUG 218#define debug_error(__msg) \ 219 _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 220#else 221#define debug_error(__msg) \ 222 _debug_printf("error: %s\n", __msg) 223#endif 224 225 226/** 227 * Used by debug_dump_enum and debug_dump_flags to describe symbols. 228 */ 229struct debug_named_value 230{ 231 const char *name; 232 unsigned long value; 233}; 234 235 236/** 237 * Some C pre-processor magic to simplify creating named values. 238 * 239 * Example: 240 * @code 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 246 * }; 247 * 248 * ... 249 * debug_printf("%s = %s\n", 250 * name, 251 * debug_dump_enum(my_names, my_value)); 252 * ... 253 * @endcode 254 */ 255#define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol} 256#define DEBUG_NAMED_VALUE_END {NULL, 0} 257 258 259/** 260 * Convert a enum value to a string. 261 */ 262const char * 263debug_dump_enum(const struct debug_named_value *names, 264 unsigned long value); 265 266const char * 267debug_dump_enum_noprefix(const struct debug_named_value *names, 268 const char *prefix, 269 unsigned long value); 270 271 272/** 273 * Convert binary flags value to a string. 274 */ 275const char * 276debug_dump_flags(const struct debug_named_value *names, 277 unsigned long value); 278 279 280/** 281 * Get option. 282 * 283 * It is an alias for getenv on Linux. 284 * 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 287 * 288 * NAME=value 289 * 290 * This file must be terminated with an extra empty line. 291 */ 292const char * 293debug_get_option(const char *name, const char *dfault); 294 295boolean 296debug_get_bool_option(const char *name, boolean dfault); 297 298long 299debug_get_num_option(const char *name, long dfault); 300 301unsigned long 302debug_get_flags_option(const char *name, 303 const struct debug_named_value *flags, 304 unsigned long dfault); 305 306 307unsigned long 308debug_memory_begin(void); 309 310void 311debug_memory_end(unsigned long beginning); 312 313 314#ifdef DEBUG 315struct pipe_surface; 316struct pipe_transfer; 317void debug_dump_image(const char *prefix, 318 unsigned format, unsigned cpp, 319 unsigned width, unsigned height, 320 unsigned stride, 321 const void *data); 322void debug_dump_surface(const char *prefix, 323 struct pipe_surface *surface); 324void debug_dump_surface_bmp(const char *filename, 325 struct pipe_surface *surface); 326void debug_dump_transfer_bmp(const char *filename, 327 struct pipe_transfer *transfer); 328void debug_dump_float_rgba_bmp(const char *filename, 329 unsigned width, unsigned height, 330 float *rgba, unsigned stride); 331#else 332#define debug_dump_image(prefix, format, cpp, width, height, stride, data) ((void)0) 333#define debug_dump_surface(prefix, surface) ((void)0) 334#define debug_dump_surface_bmp(filename, surface) ((void)0) 335#define debug_dump_transfer_bmp(filename, transfer) ((void)0) 336#define debug_dump_rgba_float_bmp(filename, width, height, rgba, stride) ((void)0) 337#endif 338 339 340#ifdef __cplusplus 341} 342#endif 343 344#endif /* U_DEBUG_H_ */ 345