u_debug.h revision 9f5640d10b3c29260418c0acd0b5466b112f6ecd
1a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca/************************************************************************** 2a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 3a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * Copyright 2008 Tungsten Graphics, Inc., Cedar Park, Texas. 4a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * All Rights Reserved. 5a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 6a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * Permission is hereby granted, free of charge, to any person obtaining a 7a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * copy of this software and associated documentation files (the 8a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * "Software"), to deal in the Software without restriction, including 9a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * without limitation the rights to use, copy, modify, merge, publish, 10a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * distribute, sub license, and/or sell copies of the Software, and to 11a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * permit persons to whom the Software is furnished to do so, subject to 12a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * the following conditions: 13a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 14a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * The above copyright notice and this permission notice (including the 15a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * next paragraph) shall be included in all copies or substantial portions 16a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * of the Software. 17a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 18a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 19a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 21a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR 22a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 23a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 24a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 26a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca **************************************************************************/ 27a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 28a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca/** 29a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * @file 30a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * Cross-platform debugging helpers. 31a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 32a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * For now it just has assert and printf replacements, but it might be extended 33a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * with stack trace reports and more advanced logging in the near future. 34a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * 35a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca * @author Jose Fonseca <jrfonseca@tungstengraphics.com> 36a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca */ 37a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 38ea4bf267e4b023b08043f91ac44592fed1736e7fJosé Fonseca#ifndef U_DEBUG_H_ 39ea4bf267e4b023b08043f91ac44592fed1736e7fJosé Fonseca#define U_DEBUG_H_ 40a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 41af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 426b424a0550a5196818641857974f4cb04d61b933José Fonseca#include "os/os_misc.h" 4345c59895113f997e5f2b7e346f95e46099fa3566José Fonseca 44af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 45a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef __cplusplus 46a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonsecaextern "C" { 47a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 48a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 49a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 50496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#if defined(__GNUC__) 51496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#define _util_printf_format(fmt, list) __attribute__ ((format (printf, fmt, list))) 52496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#else 53496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#define _util_printf_format(fmt, list) 54496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#endif 5555d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca 56dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_vprintf(const char *format, va_list ap); 57dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 58dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 594654803e2595ea041ea83baf5e13e6c68890e9a7Brianstatic INLINE void 60dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca_debug_printf(const char *format, ...) 61dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca{ 62dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_list ap; 63dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_start(ap, format); 64dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_vprintf(format, ap); 65dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_end(ap); 66dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca} 67dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 68dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 69fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca/** 70fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * Print debug messages. 71fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * 72496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle * The actual channel used to output debug message is platform specific. To 73496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle * avoid misformating or truncation, follow these rules of thumb: 74fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * - output whole lines 75496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle * - avoid outputing large strings (512 bytes is the current maximum length 76fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * that is guaranteed to be printed in all platforms) 77fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca */ 78c6c44bf48124dd5b4661014a8d58482c5a54557faljen#if !defined(PIPE_OS_HAIKU) 794654803e2595ea041ea83baf5e13e6c68890e9a7Brianstatic INLINE void 80496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnledebug_printf(const char *format, ...) _util_printf_format(1,2); 81496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle 82496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnlestatic INLINE void 83dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecadebug_printf(const char *format, ...) 84dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca{ 85dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 86dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_list ap; 87dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_start(ap, format); 88dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_vprintf(format, ap); 89dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_end(ap); 90d355eee5cacac30e2b4c8ac2f10964e2861a539eBrian#else 91d355eee5cacac30e2b4c8ac2f10964e2861a539eBrian (void) format; /* silence warning */ 92dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 93dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca} 94dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 95c6c44bf48124dd5b4661014a8d58482c5a54557faljen#endif /* !PIPE_OS_HAIKU */ 96dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 97b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty/* 98b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * ... isn't portable so we need to pass arguments in parentheses. 99b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * 100b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * usage: 101b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * debug_printf_once(("awnser: %i\n", 42)); 102b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty */ 103b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty#define debug_printf_once(args) \ 104b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty do { \ 105b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty static boolean once = TRUE; \ 106b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty if (once) { \ 107b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty once = FALSE; \ 108b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty debug_printf args; \ 109b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty } \ 110b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty } while (0) 111b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty 112b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty 113dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 114dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap) 115dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 116dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_vprintf(_format, _ap) ((void)0) 117dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 118af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 119a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell 1209bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell#ifdef DEBUG 121dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 122dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Dump a blob in hex to the same place that debug_printf sends its 123dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * messages. 124a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell */ 1259bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwellvoid debug_print_blob( const char *name, const void *blob, unsigned size ); 1269bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell 1279bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell/* Print a message along with a prettified format string 1289bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell */ 1290d80f407f128f1a324e9dc0db2d0910bf32ba736Zack Rusinvoid debug_print_format(const char *msg, unsigned fmt ); 130dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 131dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_print_blob(_name, _blob, _size) ((void)0) 1329bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell#define debug_print_format(_msg, _fmt) ((void)0) 133dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 134dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 135dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 136fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca/** 137dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Hard-coded breakpoint. 138fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca */ 139dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 1406b424a0550a5196818641857974f4cb04d61b933José Fonseca#define debug_break() os_break() 141dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else /* !DEBUG */ 142dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_break() ((void)0) 143dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif /* !DEBUG */ 144af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 145a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 1464654803e2595ea041ea83baf5e13e6c68890e9a7Brianlong 1474654803e2595ea041ea83baf5e13e6c68890e9a7Briandebug_get_num_option(const char *name, long dfault); 1484654803e2595ea041ea83baf5e13e6c68890e9a7Brian 149dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_assert_fail(const char *expr, 150dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca const char *file, 151dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca unsigned line, 152dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca const char *function); 153af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 154dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 155dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 156dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Assert macro 157dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * 158dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Do not expect that the assert call terminates -- errors must be handled 159dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * regardless of assert behavior. 1607a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca * 1617a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca * For non debug builds the assert macro will expand to a no-op, so do not 1627a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca * call functions with side effects in the assert expression. 163dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 164a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef DEBUG 165dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__)) 166a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#else 167f0ba7d897d1c22202531acb70f134f2edc30557dKeith Whitwell#define debug_assert(expr) do { } while (0 && (expr)) 168a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 169a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 170a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 171dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** Override standard assert macro */ 172a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef assert 173a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#undef assert 174a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 175a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#define assert(expr) debug_assert(expr) 176a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 177a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 178dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 179dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output the current function name. 180dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 181dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 182dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint() \ 183dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_printf("%s\n", __FUNCTION__) 184dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 185dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint() \ 186dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca ((void)0) 187dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 188dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 189dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 190dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 191dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output the full source code position. 192dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 193dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 194dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint_full() \ 1954654803e2595ea041ea83baf5e13e6c68890e9a7Brian _debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__) 196dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 197dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint_full() \ 198dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca ((void)0) 199dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 200dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 201dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 202dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 203dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output a warning message. Muted on release version. 204dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 205d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#ifdef DEBUG 206d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#define debug_warning(__msg) \ 207331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 208d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#else 209d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#define debug_warning(__msg) \ 210d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca ((void)0) 211d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#endif 212d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca 213d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca 214e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 215dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output an error message. Not muted on release version. 216dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 217dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 218dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_error(__msg) \ 219331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 220dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 221dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_error(__msg) \ 222331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("error: %s\n", __msg) 223dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 224dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 225dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 226dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 227e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Used by debug_dump_enum and debug_dump_flags to describe symbols. 228e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 229e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecastruct debug_named_value 230e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca{ 231e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca const char *name; 232e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value; 233e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca}; 234e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 235e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 236e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 237e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Some C pre-processor magic to simplify creating named values. 238e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * 239e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Example: 240e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * @code 241e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * static const debug_named_value my_names[] = { 242e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X), 243e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y), 244e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z), 245e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE_END 246e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * }; 247e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * 248e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * ... 249e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * debug_printf("%s = %s\n", 250e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * name, 251e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * debug_dump_enum(my_names, my_value)); 252e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * ... 253e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * @endcode 254e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 255e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca#define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol} 256e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca#define DEBUG_NAMED_VALUE_END {NULL, 0} 257e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 258e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 259e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 260e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Convert a enum value to a string. 261e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 262e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecaconst char * 263e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecadebug_dump_enum(const struct debug_named_value *names, 264e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value); 265e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 2668f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwellconst char * 2678f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwelldebug_dump_enum_noprefix(const struct debug_named_value *names, 2688f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell const char *prefix, 2698f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell unsigned long value); 2708f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell 271e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 272e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 273e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Convert binary flags value to a string. 274e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 275e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecaconst char * 276e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecadebug_dump_flags(const struct debug_named_value *names, 277e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value); 278e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 279e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 280e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca/** 281e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * Get option. 282e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 283e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * It is an alias for getenv on Linux. 284e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 285e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * On Windows it reads C:\gallium.cfg, which is a text file with CR+LF line 286e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * endings with one option per line as 287e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 288e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * NAME=value 289e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 290e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * This file must be terminated with an extra empty line. 291e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca */ 292e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaconst char * 293e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_option(const char *name, const char *dfault); 294e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 295e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaboolean 296e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_bool_option(const char *name, boolean dfault); 297e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 298e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecalong 29923422d603ae002a1f368e20cd0f158e057876cb8José Fonsecadebug_get_num_option(const char *name, long dfault); 300e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 301e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaunsigned long 302e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_flags_option(const char *name, 303e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca const struct debug_named_value *flags, 304e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca unsigned long dfault); 305e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 306e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 3074e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecaunsigned long 3084e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecadebug_memory_begin(void); 309732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 310732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid 3114e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecadebug_memory_end(unsigned long beginning); 312732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 313732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 314a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#ifdef DEBUG 31572a5e479789febb552ec783a1cba0ed628dfa427José Fonsecastruct pipe_surface; 316da96767c8971e792285e3190c708438d65802379Jakob Bornecrantzstruct pipe_transfer; 3174f5675e94b936d012b89937aac8a16c28143d5ecBrian Paulstruct pipe_texture; 3184f5675e94b936d012b89937aac8a16c28143d5ecBrian Paul 319a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonsecavoid debug_dump_image(const char *prefix, 320a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca unsigned format, unsigned cpp, 321a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca unsigned width, unsigned height, 32272a5e479789febb552ec783a1cba0ed628dfa427José Fonseca unsigned stride, 323a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca const void *data); 32472a5e479789febb552ec783a1cba0ed628dfa427José Fonsecavoid debug_dump_surface(const char *prefix, 32572a5e479789febb552ec783a1cba0ed628dfa427José Fonseca struct pipe_surface *surface); 3264f5675e94b936d012b89937aac8a16c28143d5ecBrian Paulvoid debug_dump_texture(const char *prefix, 3274f5675e94b936d012b89937aac8a16c28143d5ecBrian Paul struct pipe_texture *texture); 3281da0a13389ce9709586058a8807c0c4120e520a2José Fonsecavoid debug_dump_surface_bmp(const char *filename, 3291da0a13389ce9709586058a8807c0c4120e520a2José Fonseca struct pipe_surface *surface); 330da96767c8971e792285e3190c708438d65802379Jakob Bornecrantzvoid debug_dump_transfer_bmp(const char *filename, 331da96767c8971e792285e3190c708438d65802379Jakob Bornecrantz struct pipe_transfer *transfer); 332f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantzvoid debug_dump_float_rgba_bmp(const char *filename, 333f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz unsigned width, unsigned height, 334f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz float *rgba, unsigned stride); 335a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#else 33672a5e479789febb552ec783a1cba0ed628dfa427José Fonseca#define debug_dump_image(prefix, format, cpp, width, height, stride, data) ((void)0) 33772a5e479789febb552ec783a1cba0ed628dfa427José Fonseca#define debug_dump_surface(prefix, surface) ((void)0) 3381da0a13389ce9709586058a8807c0c4120e520a2José Fonseca#define debug_dump_surface_bmp(filename, surface) ((void)0) 339f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz#define debug_dump_transfer_bmp(filename, transfer) ((void)0) 3409f5640d10b3c29260418c0acd0b5466b112f6ecdVinson Lee#define debug_dump_float_rgba_bmp(filename, width, height, rgba, stride) ((void)0) 341a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#endif 342a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca 343a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca 344a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef __cplusplus 345a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca} 346a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 347a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 348ea4bf267e4b023b08043f91ac44592fed1736e7fJosé Fonseca#endif /* U_DEBUG_H_ */ 349