1 // 2 // Copyright (c) 2002-2010 The ANGLE Project Authors. All rights reserved. 3 // Use of this source code is governed by a BSD-style license that can be 4 // found in the LICENSE file. 5 // 6 7 // debug.h: Debugging utilities. 8 9 #ifndef COMMON_DEBUG_H_ 10 #define COMMON_DEBUG_H_ 11 12 #include <stdio.h> 13 #include <assert.h> 14 15 #include "common/angleutils.h" 16 17 #if !defined(TRACE_OUTPUT_FILE) 18 #define TRACE_OUTPUT_FILE "debug.txt" 19 #endif 20 21 namespace gl 22 { 23 // Outputs text to the debugging log 24 void trace(bool traceFileDebugOnly, const char *format, ...); 25 26 // Returns whether D3DPERF is active. 27 bool perfActive(); 28 29 // Pairs a D3D begin event with an end event. 30 class ScopedPerfEventHelper 31 { 32 public: 33 ScopedPerfEventHelper(const char* format, ...); 34 ~ScopedPerfEventHelper(); 35 36 private: 37 DISALLOW_COPY_AND_ASSIGN(ScopedPerfEventHelper); 38 }; 39 } 40 41 // A macro to output a trace of a function call and its arguments to the debugging log 42 #if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 43 #define TRACE(message, ...) (void(0)) 44 #else 45 #define TRACE(message, ...) gl::trace(true, "trace: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 46 #endif 47 48 // A macro to output a function call and its arguments to the debugging log, to denote an item in need of fixing. 49 #if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 50 #define FIXME(message, ...) (void(0)) 51 #else 52 #define FIXME(message, ...) gl::trace(false, "fixme: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 53 #endif 54 55 // A macro to output a function call and its arguments to the debugging log, in case of error. 56 #if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 57 #define ERR(message, ...) (void(0)) 58 #else 59 #define ERR(message, ...) gl::trace(false, "err: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 60 #endif 61 62 // A macro to log a performance event around a scope. 63 #if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 64 #define EVENT(message, ...) (void(0)) 65 #elif defined(_MSC_VER) 66 #define EVENT(message, ...) gl::ScopedPerfEventHelper scopedPerfEventHelper ## __LINE__(__FUNCTION__ message "\n", __VA_ARGS__); 67 #else 68 #define EVENT(message, ...) gl::ScopedPerfEventHelper scopedPerfEventHelper(message "\n", ##__VA_ARGS__); 69 #endif 70 71 // A macro asserting a condition and outputting failures to the debug log 72 #if !defined(NDEBUG) 73 #define ASSERT(expression) do { \ 74 if(!(expression)) \ 75 ERR("\t! Assert failed in %s(%d): "#expression"\n", __FUNCTION__, __LINE__); \ 76 assert(expression); \ 77 } while(0) 78 #else 79 #define ASSERT(expression) (void(0)) 80 #endif 81 82 // A macro to indicate unimplemented functionality 83 #if !defined(NDEBUG) 84 #define UNIMPLEMENTED() do { \ 85 FIXME("\t! Unimplemented: %s(%d)\n", __FUNCTION__, __LINE__); \ 86 assert(false); \ 87 } while(0) 88 #else 89 #define UNIMPLEMENTED() FIXME("\t! Unimplemented: %s(%d)\n", __FUNCTION__, __LINE__) 90 #endif 91 92 // A macro for code which is not expected to be reached under valid assumptions 93 #if !defined(NDEBUG) 94 #define UNREACHABLE() do { \ 95 ERR("\t! Unreachable reached: %s(%d)\n", __FUNCTION__, __LINE__); \ 96 assert(false); \ 97 } while(0) 98 #else 99 #define UNREACHABLE() ERR("\t! Unreachable reached: %s(%d)\n", __FUNCTION__, __LINE__) 100 #endif 101 102 // A macro that determines whether an object has a given runtime type. MSVC uses _CPPRTTI. 103 // GCC uses __GXX_RTTI, but the macro was introduced in version 4.3, so we assume that all older 104 // versions support RTTI. 105 #if !defined(NDEBUG) && (!defined(_MSC_VER) || defined(_CPPRTTI)) && (!defined(__GNUC__) || __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 3) || defined(__GXX_RTTI)) 106 #define HAS_DYNAMIC_TYPE(type, obj) (dynamic_cast<type >(obj) != NULL) 107 #else 108 #define HAS_DYNAMIC_TYPE(type, obj) true 109 #endif 110 111 // A macro functioning as a compile-time assert to validate constant conditions 112 #define META_ASSERT(condition) typedef int COMPILE_TIME_ASSERT_##__LINE__[static_cast<bool>(condition)?1:-1] 113 114 #endif // COMMON_DEBUG_H_ 115