14f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// 24f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// Copyright (c) 2002-2010 The ANGLE Project Authors. All rights reserved. 34f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// Use of this source code is governed by a BSD-style license that can be 44f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// found in the LICENSE file. 54f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// 64f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 74f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// debug.h: Debugging utilities. 84f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 94f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#ifndef COMMON_DEBUG_H_ 104f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#define COMMON_DEBUG_H_ 114f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 124f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#include <stdio.h> 134f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#include <assert.h> 144f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 150f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#include "common/angleutils.h" 160f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org 170f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(TRACE_OUTPUT_FILE) 180f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define TRACE_OUTPUT_FILE "debug.txt" 190f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 200f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org 214f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.comnamespace gl 224f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com{ 234f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com // Outputs text to the debugging log 240f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org void trace(bool traceFileDebugOnly, const char *format, ...); 250f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org 260f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org // Returns whether D3DPERF is active. 270f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org bool perfActive(); 280f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org 290f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org // Pairs a D3D begin event with an end event. 300f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org class ScopedPerfEventHelper 310f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org { 320f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org public: 330f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org ScopedPerfEventHelper(const char* format, ...); 340f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org ~ScopedPerfEventHelper(); 350f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org 360f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org private: 370f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org DISALLOW_COPY_AND_ASSIGN(ScopedPerfEventHelper); 380f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org }; 394f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com} 404f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 414f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro to output a trace of a function call and its arguments to the debugging log 420f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 430f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define TRACE(message, ...) (void(0)) 440f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#else 451825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define TRACE(message, ...) gl::trace(true, "trace: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 460f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 470f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org 480f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org// A macro to output a function call and its arguments to the debugging log, to denote an item in need of fixing. 490f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 500f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define FIXME(message, ...) (void(0)) 514f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#else 521825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define FIXME(message, ...) gl::trace(false, "fixme: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 534f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif 544f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 550f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org// A macro to output a function call and its arguments to the debugging log, in case of error. 560f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 570f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define ERR(message, ...) (void(0)) 580f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#else 591825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define ERR(message, ...) gl::trace(false, "err: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 600f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 614f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 620f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org// A macro to log a performance event around a scope. 630f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if defined(ANGLE_DISABLE_TRACE) && defined(ANGLE_DISABLE_PERF) 640f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define EVENT(message, ...) (void(0)) 651825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#elif defined(_MSC_VER) 663d8115ff1dc3c62717f159703e396ee851fe39dadaniel@transgaming.com#define EVENT(message, ...) gl::ScopedPerfEventHelper scopedPerfEventHelper ## __LINE__(__FUNCTION__ message "\n", __VA_ARGS__); 671825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#else 681825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define EVENT(message, ...) gl::ScopedPerfEventHelper scopedPerfEventHelper(message "\n", ##__VA_ARGS__); 690f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 704f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 714f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro asserting a condition and outputting failures to the debug log 720f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(NDEBUG) 734f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#define ASSERT(expression) do { \ 744f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com if(!(expression)) \ 754f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com ERR("\t! Assert failed in %s(%d): "#expression"\n", __FUNCTION__, __LINE__); \ 760f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org assert(expression); \ 774f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com } while(0) 780f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#else 790f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define ASSERT(expression) (void(0)) 800f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 814f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 824f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro to indicate unimplemented functionality 830f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(NDEBUG) 840f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define UNIMPLEMENTED() do { \ 850f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org FIXME("\t! Unimplemented: %s(%d)\n", __FUNCTION__, __LINE__); \ 860f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org assert(false); \ 870f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org } while(0) 884f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#else 894f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com #define UNIMPLEMENTED() FIXME("\t! Unimplemented: %s(%d)\n", __FUNCTION__, __LINE__) 904f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif 914f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 924f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro for code which is not expected to be reached under valid assumptions 930f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(NDEBUG) 940f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define UNREACHABLE() do { \ 950f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org ERR("\t! Unreachable reached: %s(%d)\n", __FUNCTION__, __LINE__); \ 960f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org assert(false); \ 970f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org } while(0) 984f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#else 994f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com #define UNREACHABLE() ERR("\t! Unreachable reached: %s(%d)\n", __FUNCTION__, __LINE__) 1004f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif 1014f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 102e6dcc9815a8a20ab0ff0f5e6c40116a014338757Shannon Woods// A macro that determines whether an object has a given runtime type. MSVC uses _CPPRTTI. 103e6dcc9815a8a20ab0ff0f5e6c40116a014338757Shannon Woods// GCC uses __GXX_RTTI, but the macro was introduced in version 4.3, so we assume that all older 104e6dcc9815a8a20ab0ff0f5e6c40116a014338757Shannon Woods// versions support RTTI. 10549cbc5768c15d930d5d8751f5263e9546a07d037Jamie Madill#if !defined(NDEBUG) && (!defined(_MSC_VER) || defined(_CPPRTTI)) && (!defined(__GNUC__) || __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 3) || defined(__GXX_RTTI)) 1068b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#define HAS_DYNAMIC_TYPE(type, obj) (dynamic_cast<type >(obj) != NULL) 1078b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#else 1088b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#define HAS_DYNAMIC_TYPE(type, obj) true 1098b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#endif 1108b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org 1114f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro functioning as a compile-time assert to validate constant conditions 1124f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#define META_ASSERT(condition) typedef int COMPILE_TIME_ASSERT_##__LINE__[static_cast<bool>(condition)?1:-1] 1134f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 1144f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif // COMMON_DEBUG_H_ 115