u_debug.h revision da96767c8971e792285e3190c708438d65802379
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 42af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca#include <stdarg.h> 43af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 44ea4bf267e4b023b08043f91ac44592fed1736e7fJosé Fonseca#include "pipe/p_compiler.h" 4545c59895113f997e5f2b7e346f95e46099fa3566José Fonseca 46af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 47a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef __cplusplus 48a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonsecaextern "C" { 49a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 50a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 51a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 5252e6fbb655f138f70670abdd365258873a78dabfKeith Whitwell#if defined(DBG) || defined(DEBUG) 53a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifndef DEBUG 54a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#define DEBUG 1 55a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 56a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#else 57a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifndef NDEBUG 58a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#define NDEBUG 1 59a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 60a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 61a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 6255d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca 6355d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca/* MSVC bebore VC7 does not have the __FUNCTION__ macro */ 6455d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca#if defined(_MSC_VER) && _MSC_VER < 1300 6555d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca#define __FUNCTION__ "???" 6655d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca#endif 6755d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca 6855d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca 69dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_vprintf(const char *format, va_list ap); 70dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 71dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 724654803e2595ea041ea83baf5e13e6c68890e9a7Brianstatic INLINE void 73dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca_debug_printf(const char *format, ...) 74dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca{ 75dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_list ap; 76dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_start(ap, format); 77dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_vprintf(format, ap); 78dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_end(ap); 79dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca} 80dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 81dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 82fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca/** 83fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * Print debug messages. 84fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * 85fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * The actual channel used to output debug message is platform specific. To 86fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * avoid misformating or truncation, follow these rules of thumb: 87fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * - output whole lines 88fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * - avoid outputing large strings (512 bytes is the current maximum length 89fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * that is guaranteed to be printed in all platforms) 90fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca */ 914654803e2595ea041ea83baf5e13e6c68890e9a7Brianstatic INLINE void 92dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecadebug_printf(const char *format, ...) 93dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca{ 94dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 95dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_list ap; 96dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_start(ap, format); 97dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_vprintf(format, ap); 98dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_end(ap); 99d355eee5cacac30e2b4c8ac2f10964e2861a539eBrian#else 100d355eee5cacac30e2b4c8ac2f10964e2861a539eBrian (void) format; /* silence warning */ 101dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 102dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca} 103dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 104dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 105dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 106dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap) 107dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 108dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_vprintf(_format, _ap) ((void)0) 109dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 110af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 111a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell 1129bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell#ifdef DEBUG 113dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 114dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Dump a blob in hex to the same place that debug_printf sends its 115dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * messages. 116a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell */ 1179bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwellvoid debug_print_blob( const char *name, const void *blob, unsigned size ); 1189bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell 1199bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell/* Print a message along with a prettified format string 1209bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell */ 1210d80f407f128f1a324e9dc0db2d0910bf32ba736Zack Rusinvoid debug_print_format(const char *msg, unsigned fmt ); 122dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 123dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_print_blob(_name, _blob, _size) ((void)0) 1249bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell#define debug_print_format(_msg, _fmt) ((void)0) 125dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 126dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 127dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 128dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_break(void); 129dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 130a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell 131fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca/** 132dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Hard-coded breakpoint. 133fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca */ 134dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 135e8b52b3f5682c969e58077d42f5aebdad5d32e89José Fonseca#if defined(PIPE_ARCH_X86) && defined(PIPE_CC_GCC) 136dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_break() __asm("int3") 137e8b52b3f5682c969e58077d42f5aebdad5d32e89José Fonseca#elif defined(PIPE_ARCH_X86) && defined(PIPE_CC_MSVC) 13855d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca#define debug_break() do { _asm {int 3} } while(0) 139dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 140dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_break() _debug_break() 141dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 142dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else /* !DEBUG */ 143dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_break() ((void)0) 144dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif /* !DEBUG */ 145af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 146a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 1474654803e2595ea041ea83baf5e13e6c68890e9a7Brianlong 1484654803e2595ea041ea83baf5e13e6c68890e9a7Briandebug_get_num_option(const char *name, long dfault); 1494654803e2595ea041ea83baf5e13e6c68890e9a7Brian 150dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_assert_fail(const char *expr, 151dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca const char *file, 152dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca unsigned line, 153dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca const char *function); 154af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 155dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 156dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 157dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Assert macro 158dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * 159dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Do not expect that the assert call terminates -- errors must be handled 160dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * regardless of assert behavior. 161dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 162a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef DEBUG 163dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__)) 164a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#else 165d885c9dad15b64fd40c4c4d5cda6713a3e06a9aeKeith Whitwell#define debug_assert(expr) ((void)(expr)) 166a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 167a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 168a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 169dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** Override standard assert macro */ 170a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef assert 171a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#undef assert 172a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 173a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#define assert(expr) debug_assert(expr) 174a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 175a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 176dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 177dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output the current function name. 178dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 179dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 180dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint() \ 181dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_printf("%s\n", __FUNCTION__) 182dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 183dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint() \ 184dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca ((void)0) 185dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 186dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 187dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 188dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 189dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output the full source code position. 190dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 191dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 192dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint_full() \ 1934654803e2595ea041ea83baf5e13e6c68890e9a7Brian _debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__) 194dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 195dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint_full() \ 196dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca ((void)0) 197dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 198dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 199dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 200dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 201dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output a warning message. Muted on release version. 202dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 203d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#ifdef DEBUG 204d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#define debug_warning(__msg) \ 205331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 206d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#else 207d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#define debug_warning(__msg) \ 208d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca ((void)0) 209d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#endif 210d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca 211d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca 212e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 213dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output an error message. Not muted on release version. 214dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 215dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 216dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_error(__msg) \ 217331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 218dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 219dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_error(__msg) \ 220331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("error: %s\n", __msg) 221dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 222dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 223dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 224dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 225e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Used by debug_dump_enum and debug_dump_flags to describe symbols. 226e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 227e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecastruct debug_named_value 228e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca{ 229e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca const char *name; 230e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value; 231e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca}; 232e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 233e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 234e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 235e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Some C pre-processor magic to simplify creating named values. 236e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * 237e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Example: 238e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * @code 239e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * static const debug_named_value my_names[] = { 240e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X), 241e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y), 242e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z), 243e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE_END 244e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * }; 245e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * 246e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * ... 247e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * debug_printf("%s = %s\n", 248e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * name, 249e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * debug_dump_enum(my_names, my_value)); 250e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * ... 251e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * @endcode 252e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 253e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca#define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol} 254e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca#define DEBUG_NAMED_VALUE_END {NULL, 0} 255e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 256e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 257e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 258e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Convert a enum value to a string. 259e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 260e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecaconst char * 261e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecadebug_dump_enum(const struct debug_named_value *names, 262e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value); 263e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 2648f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwellconst char * 2658f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwelldebug_dump_enum_noprefix(const struct debug_named_value *names, 2668f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell const char *prefix, 2678f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell unsigned long value); 2688f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell 269e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 270e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 271e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Convert binary flags value to a string. 272e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 273e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecaconst char * 274e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecadebug_dump_flags(const struct debug_named_value *names, 275e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value); 276e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 277e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 278e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca/** 279e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * Get option. 280e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 281e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * It is an alias for getenv on Linux. 282e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 283e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * On Windows it reads C:\gallium.cfg, which is a text file with CR+LF line 284e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * endings with one option per line as 285e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 286e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * NAME=value 287e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 288e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * This file must be terminated with an extra empty line. 289e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca */ 290e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaconst char * 291e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_option(const char *name, const char *dfault); 292e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 293e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaboolean 294e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_bool_option(const char *name, boolean dfault); 295e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 296e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecalong 29723422d603ae002a1f368e20cd0f158e057876cb8José Fonsecadebug_get_num_option(const char *name, long dfault); 298e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 299e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaunsigned long 300e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_flags_option(const char *name, 301e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca const struct debug_named_value *flags, 302e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca unsigned long dfault); 303e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 304e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 305732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid * 306732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_malloc(const char *file, unsigned line, const char *function, 307732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca size_t size); 308732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 309732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid 310732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_free(const char *file, unsigned line, const char *function, 311732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca void *ptr); 312732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 313732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid * 314732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_calloc(const char *file, unsigned line, const char *function, 315732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca size_t count, size_t size ); 316732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 317732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid * 318732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_realloc(const char *file, unsigned line, const char *function, 319732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca void *old_ptr, size_t old_size, size_t new_size ); 320732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 3214e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecaunsigned long 3224e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecadebug_memory_begin(void); 323732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 324732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid 3254e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecadebug_memory_end(unsigned long beginning); 326732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 327732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 328345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca#if defined(PROFILE) && defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY) 329345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 330345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecavoid 331345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecadebug_profile_start(void); 332345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 333345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecavoid 334345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecadebug_profile_stop(void); 335345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 336345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca#endif 337345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 338345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 339a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#ifdef DEBUG 34072a5e479789febb552ec783a1cba0ed628dfa427José Fonsecastruct pipe_surface; 341da96767c8971e792285e3190c708438d65802379Jakob Bornecrantzstruct pipe_transfer; 342a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonsecavoid debug_dump_image(const char *prefix, 343a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca unsigned format, unsigned cpp, 344a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca unsigned width, unsigned height, 34572a5e479789febb552ec783a1cba0ed628dfa427José Fonseca unsigned stride, 346a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca const void *data); 34772a5e479789febb552ec783a1cba0ed628dfa427José Fonsecavoid debug_dump_surface(const char *prefix, 34872a5e479789febb552ec783a1cba0ed628dfa427José Fonseca struct pipe_surface *surface); 3491da0a13389ce9709586058a8807c0c4120e520a2José Fonsecavoid debug_dump_surface_bmp(const char *filename, 3501da0a13389ce9709586058a8807c0c4120e520a2José Fonseca struct pipe_surface *surface); 351da96767c8971e792285e3190c708438d65802379Jakob Bornecrantzvoid debug_dump_transfer_bmp(const char *filename, 352da96767c8971e792285e3190c708438d65802379Jakob Bornecrantz struct pipe_transfer *transfer); 353a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#else 35472a5e479789febb552ec783a1cba0ed628dfa427José Fonseca#define debug_dump_image(prefix, format, cpp, width, height, stride, data) ((void)0) 35572a5e479789febb552ec783a1cba0ed628dfa427José Fonseca#define debug_dump_surface(prefix, surface) ((void)0) 3561da0a13389ce9709586058a8807c0c4120e520a2José Fonseca#define debug_dump_surface_bmp(filename, surface) ((void)0) 357a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#endif 358a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca 359a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca 360a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef __cplusplus 361a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca} 362a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 363a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 364ea4bf267e4b023b08043f91ac44592fed1736e7fJosé Fonseca#endif /* U_DEBUG_H_ */ 365