1 /**************************************************************************
2 *
3 * Copyright 2008 VMware, Inc.
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 VMWARE 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 <jfonseca@vmware.com>
36 */
37
38 #ifndef U_DEBUG_H_
39 #define U_DEBUG_H_
40
41
42 #include "os/os_misc.h"
43
44 #include "pipe/p_format.h"
45
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51
52 #if defined(__GNUC__)
53 #define _util_printf_format(fmt, list) __attribute__ ((format (printf, fmt, list)))
54 #else
55 #define _util_printf_format(fmt, list)
56 #endif
57
58 void _debug_vprintf(const char *format, va_list ap);
59
60
61 static inline void
_debug_printf(const char * format,...)62 _debug_printf(const char *format, ...)
63 {
64 va_list ap;
65 va_start(ap, format);
66 _debug_vprintf(format, ap);
67 va_end(ap);
68 }
69
70
71 /**
72 * Print debug messages.
73 *
74 * The actual channel used to output debug message is platform specific. To
75 * avoid misformating or truncation, follow these rules of thumb:
76 * - output whole lines
77 * - avoid outputing large strings (512 bytes is the current maximum length
78 * that is guaranteed to be printed in all platforms)
79 */
80 #if !defined(PIPE_OS_HAIKU)
81 static inline void
82 debug_printf(const char *format, ...) _util_printf_format(1,2);
83
84 static inline void
debug_printf(const char * format,...)85 debug_printf(const char *format, ...)
86 {
87 #ifdef DEBUG
88 va_list ap;
89 va_start(ap, format);
90 _debug_vprintf(format, ap);
91 va_end(ap);
92 #else
93 (void) format; /* silence warning */
94 #endif
95 }
96 #else /* is Haiku */
97 /* Haiku provides debug_printf in libroot with OS.h */
98 #include <OS.h>
99 #endif
100
101
102 /*
103 * ... isn't portable so we need to pass arguments in parentheses.
104 *
105 * usage:
106 * debug_printf_once(("answer: %i\n", 42));
107 */
108 #define debug_printf_once(args) \
109 do { \
110 static boolean once = TRUE; \
111 if (once) { \
112 once = FALSE; \
113 debug_printf args; \
114 } \
115 } while (0)
116
117
118 #ifdef DEBUG
119 #define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap)
120 #else
121 #define debug_vprintf(_format, _ap) ((void)0)
122 #endif
123
124
125 #ifdef DEBUG
126 /**
127 * Dump a blob in hex to the same place that debug_printf sends its
128 * messages.
129 */
130 void debug_print_blob( const char *name, const void *blob, unsigned size );
131
132 /* Print a message along with a prettified format string
133 */
134 void debug_print_format(const char *msg, unsigned fmt );
135 #else
136 #define debug_print_blob(_name, _blob, _size) ((void)0)
137 #define debug_print_format(_msg, _fmt) ((void)0)
138 #endif
139
140
141 /**
142 * Disable interactive error message boxes.
143 *
144 * Should be called as soon as possible for effectiveness.
145 */
146 void
147 debug_disable_error_message_boxes(void);
148
149
150 /**
151 * Hard-coded breakpoint.
152 */
153 #ifdef DEBUG
154 #define debug_break() os_break()
155 #else /* !DEBUG */
156 #define debug_break() ((void)0)
157 #endif /* !DEBUG */
158
159
160 #ifdef _MSC_VER
161 __declspec(noreturn)
162 #endif
163 void _debug_assert_fail(const char *expr,
164 const char *file,
165 unsigned line,
166 const char *function)
167 #if defined(__GNUC__) && !defined(DEBUG)
168 __attribute__((noreturn))
169 #endif
170 ;
171
172
173 /**
174 * Assert macro
175 *
176 * Do not expect that the assert call terminates -- errors must be handled
177 * regardless of assert behavior.
178 *
179 * For non debug builds the assert macro will expand to a no-op, so do not
180 * call functions with side effects in the assert expression.
181 */
182 #ifdef DEBUG
183 #define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__))
184 #else
185 #define debug_assert(expr) (void)(0 && (expr))
186 #endif
187
188
189 /** Override standard assert macro */
190 #ifdef assert
191 #undef assert
192 #endif
193 #define assert(expr) debug_assert(expr)
194
195
196 /**
197 * Output the current function name.
198 */
199 #ifdef DEBUG
200 #define debug_checkpoint() \
201 _debug_printf("%s\n", __FUNCTION__)
202 #else
203 #define debug_checkpoint() \
204 ((void)0)
205 #endif
206
207
208 /**
209 * Output the full source code position.
210 */
211 #ifdef DEBUG
212 #define debug_checkpoint_full() \
213 _debug_printf("%s:%u:%s\n", __FILE__, __LINE__, __FUNCTION__)
214 #else
215 #define debug_checkpoint_full() \
216 ((void)0)
217 #endif
218
219
220 /**
221 * Output a warning message. Muted on release version.
222 */
223 #ifdef DEBUG
224 #define debug_warning(__msg) \
225 _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg)
226 #else
227 #define debug_warning(__msg) \
228 ((void)0)
229 #endif
230
231
232 /**
233 * Emit a warning message, but only once.
234 */
235 #ifdef DEBUG
236 #define debug_warn_once(__msg) \
237 do { \
238 static bool warned = FALSE; \
239 if (!warned) { \
240 _debug_printf("%s:%u:%s: one time warning: %s\n", \
241 __FILE__, __LINE__, __FUNCTION__, __msg); \
242 warned = TRUE; \
243 } \
244 } while (0)
245 #else
246 #define debug_warn_once(__msg) \
247 ((void)0)
248 #endif
249
250
251 /**
252 * Output an error message. Not muted on release version.
253 */
254 #ifdef DEBUG
255 #define debug_error(__msg) \
256 _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg)
257 #else
258 #define debug_error(__msg) \
259 _debug_printf("error: %s\n", __msg)
260 #endif
261
262
263 /**
264 * Used by debug_dump_enum and debug_dump_flags to describe symbols.
265 */
266 struct debug_named_value
267 {
268 const char *name;
269 unsigned long value;
270 const char *desc;
271 };
272
273
274 /**
275 * Some C pre-processor magic to simplify creating named values.
276 *
277 * Example:
278 * @code
279 * static const debug_named_value my_names[] = {
280 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X),
281 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y),
282 * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z),
283 * DEBUG_NAMED_VALUE_END
284 * };
285 *
286 * ...
287 * debug_printf("%s = %s\n",
288 * name,
289 * debug_dump_enum(my_names, my_value));
290 * ...
291 * @endcode
292 */
293 #define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol, NULL}
294 #define DEBUG_NAMED_VALUE_WITH_DESCRIPTION(__symbol, __desc) {#__symbol, (unsigned long)__symbol, __desc}
295 #define DEBUG_NAMED_VALUE_END {NULL, 0, NULL}
296
297
298 /**
299 * Convert a enum value to a string.
300 */
301 const char *
302 debug_dump_enum(const struct debug_named_value *names,
303 unsigned long value);
304
305 const char *
306 debug_dump_enum_noprefix(const struct debug_named_value *names,
307 const char *prefix,
308 unsigned long value);
309
310
311 /**
312 * Convert binary flags value to a string.
313 */
314 const char *
315 debug_dump_flags(const struct debug_named_value *names,
316 unsigned long value);
317
318
319 /**
320 * Function enter exit loggers
321 */
322 #ifdef DEBUG
323 int debug_funclog_enter(const char* f, const int line, const char* file);
324 void debug_funclog_exit(const char* f, const int line, const char* file);
325 void debug_funclog_enter_exit(const char* f, const int line, const char* file);
326
327 #define DEBUG_FUNCLOG_ENTER() \
328 int __debug_decleration_work_around = \
329 debug_funclog_enter(__FUNCTION__, __LINE__, __FILE__)
330 #define DEBUG_FUNCLOG_EXIT() \
331 do { \
332 (void)__debug_decleration_work_around; \
333 debug_funclog_exit(__FUNCTION__, __LINE__, __FILE__); \
334 return; \
335 } while(0)
336 #define DEBUG_FUNCLOG_EXIT_RET(ret) \
337 do { \
338 (void)__debug_decleration_work_around; \
339 debug_funclog_exit(__FUNCTION__, __LINE__, __FILE__); \
340 return ret; \
341 } while(0)
342 #define DEBUG_FUNCLOG_ENTER_EXIT() \
343 debug_funclog_enter_exit(__FUNCTION__, __LINE__, __FILE__)
344
345 #else
346 #define DEBUG_FUNCLOG_ENTER() \
347 int __debug_decleration_work_around
348 #define DEBUG_FUNCLOG_EXIT() \
349 do { (void)__debug_decleration_work_around; return; } while(0)
350 #define DEBUG_FUNCLOG_EXIT_RET(ret) \
351 do { (void)__debug_decleration_work_around; return ret; } while(0)
352 #define DEBUG_FUNCLOG_ENTER_EXIT()
353 #endif
354
355
356 /**
357 * Get option.
358 *
359 * It is an alias for getenv on Linux.
360 *
361 * On Windows it reads C:\gallium.cfg, which is a text file with CR+LF line
362 * endings with one option per line as
363 *
364 * NAME=value
365 *
366 * This file must be terminated with an extra empty line.
367 */
368 const char *
369 debug_get_option(const char *name, const char *dfault);
370
371 boolean
372 debug_get_bool_option(const char *name, boolean dfault);
373
374 long
375 debug_get_num_option(const char *name, long dfault);
376
377 unsigned long
378 debug_get_flags_option(const char *name,
379 const struct debug_named_value *flags,
380 unsigned long dfault);
381
382 #define DEBUG_GET_ONCE_BOOL_OPTION(sufix, name, dfault) \
383 static boolean \
384 debug_get_option_ ## sufix (void) \
385 { \
386 static boolean first = TRUE; \
387 static boolean value; \
388 if (first) { \
389 first = FALSE; \
390 value = debug_get_bool_option(name, dfault); \
391 } \
392 return value; \
393 }
394
395 #define DEBUG_GET_ONCE_NUM_OPTION(sufix, name, dfault) \
396 static long \
397 debug_get_option_ ## sufix (void) \
398 { \
399 static boolean first = TRUE; \
400 static long value; \
401 if (first) { \
402 first = FALSE; \
403 value = debug_get_num_option(name, dfault); \
404 } \
405 return value; \
406 }
407
408 #define DEBUG_GET_ONCE_FLAGS_OPTION(sufix, name, flags, dfault) \
409 static unsigned long \
410 debug_get_option_ ## sufix (void) \
411 { \
412 static boolean first = TRUE; \
413 static unsigned long value; \
414 if (first) { \
415 first = FALSE; \
416 value = debug_get_flags_option(name, flags, dfault); \
417 } \
418 return value; \
419 }
420
421
422 unsigned long
423 debug_memory_begin(void);
424
425 void
426 debug_memory_end(unsigned long beginning);
427
428
429 #ifdef DEBUG
430 struct pipe_context;
431 struct pipe_surface;
432 struct pipe_transfer;
433 struct pipe_resource;
434
435 void debug_dump_image(const char *prefix,
436 enum pipe_format format, unsigned cpp,
437 unsigned width, unsigned height,
438 unsigned stride,
439 const void *data);
440 void debug_dump_surface(struct pipe_context *pipe,
441 const char *prefix,
442 struct pipe_surface *surface);
443 void debug_dump_texture(struct pipe_context *pipe,
444 const char *prefix,
445 struct pipe_resource *texture);
446 #else
447 #define debug_dump_image(prefix, format, cpp, width, height, stride, data) ((void)0)
448 #define debug_dump_surface(pipe, prefix, surface) ((void)0)
449 #endif
450
451
452 void
453 debug_print_transfer_flags(const char *msg, unsigned usage);
454
455
456 #ifdef __cplusplus
457 }
458 #endif
459
460 #endif /* U_DEBUG_H_ */
461