u_debug.h revision 7a2271c65963c86ec1e5d9523b2eecf9ee59fe9d
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 68496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#if defined(__GNUC__) 69496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#define _util_printf_format(fmt, list) __attribute__ ((format (printf, fmt, list))) 70496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#else 71496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#define _util_printf_format(fmt, list) 72496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle#endif 7355d29a8d48663982a1aeea414f69a5896b97d1eaJosé Fonseca 74dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_vprintf(const char *format, va_list ap); 75dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 76dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 774654803e2595ea041ea83baf5e13e6c68890e9a7Brianstatic INLINE void 78dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca_debug_printf(const char *format, ...) 79dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca{ 80dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_list ap; 81dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_start(ap, format); 82dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_vprintf(format, ap); 83dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_end(ap); 84dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca} 85dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 86dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 87fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca/** 88fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * Print debug messages. 89fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * 90496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle * The actual channel used to output debug message is platform specific. To 91496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle * avoid misformating or truncation, follow these rules of thumb: 92fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * - output whole lines 93496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle * - avoid outputing large strings (512 bytes is the current maximum length 94fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca * that is guaranteed to be printed in all platforms) 95fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca */ 96c6c44bf48124dd5b4661014a8d58482c5a54557faljen#if !defined(PIPE_OS_HAIKU) 974654803e2595ea041ea83baf5e13e6c68890e9a7Brianstatic INLINE void 98496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnledebug_printf(const char *format, ...) _util_printf_format(1,2); 99496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnle 100496137d8eb85e78fab748f184b392f99b17059eaNicolai Hähnlestatic INLINE void 101dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecadebug_printf(const char *format, ...) 102dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca{ 103dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 104dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_list ap; 105dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_start(ap, format); 106dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_vprintf(format, ap); 107dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca va_end(ap); 108d355eee5cacac30e2b4c8ac2f10964e2861a539eBrian#else 109d355eee5cacac30e2b4c8ac2f10964e2861a539eBrian (void) format; /* silence warning */ 110dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 111dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca} 112dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 113c6c44bf48124dd5b4661014a8d58482c5a54557faljen#endif /* !PIPE_OS_HAIKU */ 114dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 115b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty/* 116b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * ... isn't portable so we need to pass arguments in parentheses. 117b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * 118b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * usage: 119b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty * debug_printf_once(("awnser: %i\n", 42)); 120b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty */ 121b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty#define debug_printf_once(args) \ 122b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty do { \ 123b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty static boolean once = TRUE; \ 124b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty if (once) { \ 125b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty once = FALSE; \ 126b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty debug_printf args; \ 127b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty } \ 128b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty } while (0) 129b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty 130b618827fac84ca12a354da5808f30e96bedbc92aMicah Dowty 131dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 132dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_vprintf(_format, _ap) _debug_vprintf(_format, _ap) 133dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 134dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_vprintf(_format, _ap) ((void)0) 135dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 136af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 137a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell 1389bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell#ifdef DEBUG 139dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 140dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Dump a blob in hex to the same place that debug_printf sends its 141dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * messages. 142a88202d3b02a24a3bfff95c5e375ead44dae4c5eKeith Whitwell */ 1439bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwellvoid debug_print_blob( const char *name, const void *blob, unsigned size ); 1449bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell 1459bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell/* Print a message along with a prettified format string 1469bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell */ 1470d80f407f128f1a324e9dc0db2d0910bf32ba736Zack Rusinvoid debug_print_format(const char *msg, unsigned fmt ); 148dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 149dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_print_blob(_name, _blob, _size) ((void)0) 1509bfe1a3d505733489f7583fe603b7d192f38fa8cKeith Whitwell#define debug_print_format(_msg, _fmt) ((void)0) 151dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 152dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 153dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 154fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca/** 155dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Hard-coded breakpoint. 156fc96aec9b7aceb4a0e7471e797abe8a00fc40cf2José Fonseca */ 157dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 158fcc2598fffe0f0e0412d2a30777f1b4a4ed22249José Fonseca#if (defined(PIPE_ARCH_X86) || defined(PIPE_ARCH_X86_64)) && defined(PIPE_CC_GCC) 159dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_break() __asm("int3") 1608c4bd92b68cf79ff94dc431f78a970bbab7e0d00José Fonseca#elif defined(PIPE_CC_MSVC) 1618c4bd92b68cf79ff94dc431f78a970bbab7e0d00José Fonseca#define debug_break() __debugbreak() 162dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 1638c4bd92b68cf79ff94dc431f78a970bbab7e0d00José Fonsecavoid debug_break(void); 164dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 165dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else /* !DEBUG */ 166dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_break() ((void)0) 167dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif /* !DEBUG */ 168af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 169a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 1704654803e2595ea041ea83baf5e13e6c68890e9a7Brianlong 1714654803e2595ea041ea83baf5e13e6c68890e9a7Briandebug_get_num_option(const char *name, long dfault); 1724654803e2595ea041ea83baf5e13e6c68890e9a7Brian 173dd51365acdd515577ee76850ceda01347ceb27c0José Fonsecavoid _debug_assert_fail(const char *expr, 174dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca const char *file, 175dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca unsigned line, 176dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca const char *function); 177af6b12cc76b40c86f3b144a7f5cd3ef1278863d0José Fonseca 178dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 179dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 180dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Assert macro 181dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * 182dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Do not expect that the assert call terminates -- errors must be handled 183dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * regardless of assert behavior. 1847a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca * 1857a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca * For non debug builds the assert macro will expand to a no-op, so do not 1867a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca * call functions with side effects in the assert expression. 187dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 188a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef DEBUG 189dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_assert(expr) ((expr) ? (void)0 : _debug_assert_fail(#expr, __FILE__, __LINE__, __FUNCTION__)) 190a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#else 1917a2271c65963c86ec1e5d9523b2eecf9ee59fe9dJosé Fonseca#define debug_assert(expr) ((void)0) 192a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 193a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 194a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 195dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** Override standard assert macro */ 196a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef assert 197a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#undef assert 198a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 199a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#define assert(expr) debug_assert(expr) 200a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 201a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 202dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 203dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output the current function name. 204dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 205dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 206dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint() \ 207dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca _debug_printf("%s\n", __FUNCTION__) 208dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 209dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint() \ 210dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca ((void)0) 211dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 212dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 213dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 214dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 215dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output the full source code position. 216dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 217dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 218dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint_full() \ 2194654803e2595ea041ea83baf5e13e6c68890e9a7Brian _debug_printf("%s:%u:%s", __FILE__, __LINE__, __FUNCTION__) 220dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 221dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_checkpoint_full() \ 222dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca ((void)0) 223dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 224dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 225dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 226dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 227dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output a warning message. Muted on release version. 228dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 229d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#ifdef DEBUG 230d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#define debug_warning(__msg) \ 231331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("%s:%u:%s: warning: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 232d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#else 233d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#define debug_warning(__msg) \ 234d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca ((void)0) 235d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca#endif 236d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca 237d1ca951cc4f3392aeec2817e97fb9ade2c1b7881José Fonseca 238e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 239dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca * Output an error message. Not muted on release version. 240dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca */ 241dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#ifdef DEBUG 242dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_error(__msg) \ 243331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("%s:%u:%s: error: %s\n", __FILE__, __LINE__, __FUNCTION__, __msg) 244dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#else 245dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#define debug_error(__msg) \ 246331a56136e96717704788b633c1b2e474b88d8baJosé Fonseca _debug_printf("error: %s\n", __msg) 247dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca#endif 248dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 249dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca 250dd51365acdd515577ee76850ceda01347ceb27c0José Fonseca/** 251e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Used by debug_dump_enum and debug_dump_flags to describe symbols. 252e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 253e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecastruct debug_named_value 254e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca{ 255e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca const char *name; 256e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value; 257e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca}; 258e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 259e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 260e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 261e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Some C pre-processor magic to simplify creating named values. 262e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * 263e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Example: 264e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * @code 265e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * static const debug_named_value my_names[] = { 266e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_X), 267e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Y), 268e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE(MY_ENUM_VALUE_Z), 269e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * DEBUG_NAMED_VALUE_END 270e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * }; 271e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * 272e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * ... 273e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * debug_printf("%s = %s\n", 274e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * name, 275e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * debug_dump_enum(my_names, my_value)); 276e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * ... 277e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * @endcode 278e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 279e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca#define DEBUG_NAMED_VALUE(__symbol) {#__symbol, (unsigned long)__symbol} 280e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca#define DEBUG_NAMED_VALUE_END {NULL, 0} 281e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 282e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 283e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 284e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Convert a enum value to a string. 285e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 286e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecaconst char * 287e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecadebug_dump_enum(const struct debug_named_value *names, 288e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value); 289e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 2908f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwellconst char * 2918f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwelldebug_dump_enum_noprefix(const struct debug_named_value *names, 2928f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell const char *prefix, 2938f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell unsigned long value); 2948f3fac6107460b6d9b011b5c76246468bb16004bKeith Whitwell 295e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 296e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca/** 297e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca * Convert binary flags value to a string. 298e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca */ 299e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecaconst char * 300e08501b45763cf177f03fb34b737050d23ba4bc0José Fonsecadebug_dump_flags(const struct debug_named_value *names, 301e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca unsigned long value); 302e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 303e08501b45763cf177f03fb34b737050d23ba4bc0José Fonseca 304e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca/** 305e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * Get option. 306e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 307e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * It is an alias for getenv on Linux. 308e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 309e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * On Windows it reads C:\gallium.cfg, which is a text file with CR+LF line 310e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * endings with one option per line as 311e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 312e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * NAME=value 313e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * 314e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca * This file must be terminated with an extra empty line. 315e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca */ 316e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaconst char * 317e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_option(const char *name, const char *dfault); 318e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 319e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaboolean 320e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_bool_option(const char *name, boolean dfault); 321e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 322e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecalong 32323422d603ae002a1f368e20cd0f158e057876cb8José Fonsecadebug_get_num_option(const char *name, long dfault); 324e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 325e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecaunsigned long 326e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonsecadebug_get_flags_option(const char *name, 327e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca const struct debug_named_value *flags, 328e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca unsigned long dfault); 329e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 330e8c6ea4f608296ed976f1597ffd46ac0b42fc84aJosé Fonseca 331732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid * 332732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_malloc(const char *file, unsigned line, const char *function, 333732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca size_t size); 334732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 335732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid 336732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_free(const char *file, unsigned line, const char *function, 337732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca void *ptr); 338732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 339732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid * 340732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_calloc(const char *file, unsigned line, const char *function, 341732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca size_t count, size_t size ); 342732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 343732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid * 344732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecadebug_realloc(const char *file, unsigned line, const char *function, 345732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca void *old_ptr, size_t old_size, size_t new_size ); 346732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 3474e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecaunsigned long 3484e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecadebug_memory_begin(void); 349732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 350732422f6708199d6655185b1a5daec86efe2f1b7José Fonsecavoid 3514e2127b0e5cb6411123e16dd562626cd70814a9aJosé Fonsecadebug_memory_end(unsigned long beginning); 352732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 353732422f6708199d6655185b1a5daec86efe2f1b7José Fonseca 354345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca#if defined(PROFILE) && defined(PIPE_SUBSYSTEM_WINDOWS_DISPLAY) 355345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 356345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecavoid 357345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecadebug_profile_start(void); 358345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 359345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecavoid 360345eb7fb70840829571cbacdb3980181df8e018aJosé Fonsecadebug_profile_stop(void); 361345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 362345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca#endif 363345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 364345eb7fb70840829571cbacdb3980181df8e018aJosé Fonseca 365a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#ifdef DEBUG 36672a5e479789febb552ec783a1cba0ed628dfa427José Fonsecastruct pipe_surface; 367da96767c8971e792285e3190c708438d65802379Jakob Bornecrantzstruct pipe_transfer; 368a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonsecavoid debug_dump_image(const char *prefix, 369a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca unsigned format, unsigned cpp, 370a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca unsigned width, unsigned height, 37172a5e479789febb552ec783a1cba0ed628dfa427José Fonseca unsigned stride, 372a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca const void *data); 37372a5e479789febb552ec783a1cba0ed628dfa427José Fonsecavoid debug_dump_surface(const char *prefix, 37472a5e479789febb552ec783a1cba0ed628dfa427José Fonseca struct pipe_surface *surface); 3751da0a13389ce9709586058a8807c0c4120e520a2José Fonsecavoid debug_dump_surface_bmp(const char *filename, 3761da0a13389ce9709586058a8807c0c4120e520a2José Fonseca struct pipe_surface *surface); 377da96767c8971e792285e3190c708438d65802379Jakob Bornecrantzvoid debug_dump_transfer_bmp(const char *filename, 378da96767c8971e792285e3190c708438d65802379Jakob Bornecrantz struct pipe_transfer *transfer); 379f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantzvoid debug_dump_float_rgba_bmp(const char *filename, 380f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz unsigned width, unsigned height, 381f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz float *rgba, unsigned stride); 382a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#else 38372a5e479789febb552ec783a1cba0ed628dfa427José Fonseca#define debug_dump_image(prefix, format, cpp, width, height, stride, data) ((void)0) 38472a5e479789febb552ec783a1cba0ed628dfa427José Fonseca#define debug_dump_surface(prefix, surface) ((void)0) 3851da0a13389ce9709586058a8807c0c4120e520a2José Fonseca#define debug_dump_surface_bmp(filename, surface) ((void)0) 386f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz#define debug_dump_transfer_bmp(filename, transfer) ((void)0) 387f4a286e5f5ac11b2e5266ef39db5d1d1cb5f77ceJakob Bornecrantz#define debug_dump_rgba_float_bmp(filename, width, height, rgba, stride) ((void)0) 388a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca#endif 389a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca 390a6ad4927740e5699f1a047f4c78f069f6a91c6eaJosé Fonseca 391a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#ifdef __cplusplus 392a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca} 393a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca#endif 394a31d289de6091987e6b9da6af1b2e56eb79a96fbJosé Fonseca 395ea4bf267e4b023b08043f91ac44592fed1736e7fJosé Fonseca#endif /* U_DEBUG_H_ */ 396