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 42f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#if defined(ANGLE_ENABLE_TRACE) || defined(ANGLE_ENABLE_PERF) 431825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define TRACE(message, ...) gl::trace(true, "trace: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 44f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#else 45f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#define TRACE(message, ...) (void(0)) 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. 49f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#if defined(ANGLE_ENABLE_TRACE) || defined(ANGLE_ENABLE_PERF) 501825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define FIXME(message, ...) gl::trace(false, "fixme: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 51f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#else 52f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#define FIXME(message, ...) (void(0)) 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. 56f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#if defined(ANGLE_ENABLE_TRACE) || defined(ANGLE_ENABLE_PERF) 571825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define ERR(message, ...) gl::trace(false, "err: %s(%d): " message "\n", __FUNCTION__, __LINE__, ##__VA_ARGS__) 58f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#else 59f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#define ERR(message, ...) (void(0)) 600f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 614f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 620f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org// A macro to log a performance event around a scope. 63f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#if defined(ANGLE_ENABLE_TRACE) || defined(ANGLE_ENABLE_PERF) 64f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#if defined(_MSC_VER) 65c1cc4c46406f2dbd182cf98b63efdef06952aa32Ehsan Akhgari#define EVENT(message, ...) gl::ScopedPerfEventHelper scopedPerfEventHelper ## __LINE__("%s" message "\n", __FUNCTION__, __VA_ARGS__); 661825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#else 671825d8e59d0209597ac4383d21d981d926f54afcdaniel@transgaming.com#define EVENT(message, ...) gl::ScopedPerfEventHelper scopedPerfEventHelper(message "\n", ##__VA_ARGS__); 68f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#endif // _MSC_VER 69f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#else 70f571312409c7895c23ecbf01f9f5f042f0966d35Geoff Lang#define EVENT(message, ...) (void(0)) 710f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 724f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 734f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro asserting a condition and outputting failures to the debug log 740f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(NDEBUG) 754f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#define ASSERT(expression) do { \ 764f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com if(!(expression)) \ 774f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com ERR("\t! Assert failed in %s(%d): "#expression"\n", __FUNCTION__, __LINE__); \ 780f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org assert(expression); \ 794f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com } while(0) 809cd1915c96800fc998ec25b88b0e3081f0aa6109Geoff Lang#define UNUSED_ASSERTION_VARIABLE(variable) 810f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#else 820f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define ASSERT(expression) (void(0)) 839cd1915c96800fc998ec25b88b0e3081f0aa6109Geoff Lang#define UNUSED_ASSERTION_VARIABLE(variable) ((void)variable) 840f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#endif 854f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 86bae30a0011345e10d067af280ecd6130ed89ecb8Jamie Madill#ifndef ANGLE_ENABLE_TRACE 87bae30a0011345e10d067af280ecd6130ed89ecb8Jamie Madill#define UNUSED_TRACE_VARIABLE(variable) ((void)variable) 88bae30a0011345e10d067af280ecd6130ed89ecb8Jamie Madill#else 89bae30a0011345e10d067af280ecd6130ed89ecb8Jamie Madill#define UNUSED_TRACE_VARIABLE(variable) 90bae30a0011345e10d067af280ecd6130ed89ecb8Jamie Madill#endif 91bae30a0011345e10d067af280ecd6130ed89ecb8Jamie Madill 924f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro to indicate unimplemented functionality 93eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org 94eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org// Define NOASSERT_UNIMPLEMENTED to non zero to skip the assert fail in the unimplemented checks 95eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org// This will allow us to test with some automated test suites (eg dEQP) without crashing 96eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org#ifndef NOASSERT_UNIMPLEMENTED 97eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org#define NOASSERT_UNIMPLEMENTED 0 98eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org#endif 99eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org 1000f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(NDEBUG) 1010f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define UNIMPLEMENTED() do { \ 1020f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org FIXME("\t! Unimplemented: %s(%d)\n", __FUNCTION__, __LINE__); \ 103eafb069c1a16d2d26c26f723ecc52c501f76c354shannonwoods@chromium.org assert(NOASSERT_UNIMPLEMENTED); \ 1040f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org } while(0) 1054f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#else 1064f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com #define UNIMPLEMENTED() FIXME("\t! Unimplemented: %s(%d)\n", __FUNCTION__, __LINE__) 1074f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif 1084f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 1094f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro for code which is not expected to be reached under valid assumptions 1100f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#if !defined(NDEBUG) 1110f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org#define UNREACHABLE() do { \ 1120f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org ERR("\t! Unreachable reached: %s(%d)\n", __FUNCTION__, __LINE__); \ 1130f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org assert(false); \ 1140f4cefe9462e53627f02f10b34d76f8665c72521apatrick@chromium.org } while(0) 1154f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#else 1164f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com #define UNREACHABLE() ERR("\t! Unreachable reached: %s(%d)\n", __FUNCTION__, __LINE__) 1174f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif 1184f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 1198b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org// A macro that determines whether an object has a given runtime type. 1208690da8b0a8f605f464346b2c3caafecb92632bcGeoff Lang#if !defined(NDEBUG) && (!defined(_MSC_VER) || defined(_CPPRTTI)) && (!defined(__GNUC__) || __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 3) || defined(__GXX_RTTI)) 1218b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#define HAS_DYNAMIC_TYPE(type, obj) (dynamic_cast<type >(obj) != NULL) 1228b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#else 1238b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#define HAS_DYNAMIC_TYPE(type, obj) true 1248b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org#endif 1258b400b1e8d84c5b93dd151807504a3e4b90d1b21apatrick@chromium.org 1264f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com// A macro functioning as a compile-time assert to validate constant conditions 127d0f8e82bb4da17777acad17283593733781a16fcGeoff Lang#if defined(_MSC_VER) && _MSC_VER >= 1600 128d0f8e82bb4da17777acad17283593733781a16fcGeoff Lang#define META_ASSERT_MSG(condition, msg) static_assert(condition, msg) 129d0f8e82bb4da17777acad17283593733781a16fcGeoff Lang#else 1304f26786863c81244acdd5b36738ae25e2c56b312Jamie Madill#define META_ASSERT_CONCAT(a, b) a ## b 1314f26786863c81244acdd5b36738ae25e2c56b312Jamie Madill#define META_ASSERT_CONCAT2(a, b) META_ASSERT_CONCAT(a, b) 1324f26786863c81244acdd5b36738ae25e2c56b312Jamie Madill#define META_ASSERT_MSG(condition, msg) typedef int META_ASSERT_CONCAT2(COMPILE_TIME_ASSERT_, __LINE__)[static_cast<bool>(condition)?1:-1] 133d0f8e82bb4da17777acad17283593733781a16fcGeoff Lang#endif 134d0f8e82bb4da17777acad17283593733781a16fcGeoff Lang#define META_ASSERT(condition) META_ASSERT_MSG(condition, "compile time assertion failed.") 1354f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com 1364f39fd99568ce175f04b5ed72062bfed0fa41803daniel@transgaming.com#endif // COMMON_DEBUG_H_ 137