Home | History | Annotate | Download | only in debase
      1 #ifndef _DEDEFS_H
      2 #define _DEDEFS_H
      3 /*-------------------------------------------------------------------------
      4  * drawElements Base Portability Library
      5  * -------------------------------------
      6  *
      7  * Copyright 2014 The Android Open Source Project
      8  *
      9  * Licensed under the Apache License, Version 2.0 (the "License");
     10  * you may not use this file except in compliance with the License.
     11  * You may obtain a copy of the License at
     12  *
     13  *      http://www.apache.org/licenses/LICENSE-2.0
     14  *
     15  * Unless required by applicable law or agreed to in writing, software
     16  * distributed under the License is distributed on an "AS IS" BASIS,
     17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     18  * See the License for the specific language governing permissions and
     19  * limitations under the License.
     20  *
     21  *//*!
     22  * \file
     23  * \brief Basic portability.
     24  *//*--------------------------------------------------------------------*/
     25 
     26 /* Compilers. */
     27 #define DE_COMPILER_VANILLA	0		/*!< Vanilla compiler. Used for disabling all platform-specific optimizations.	*/
     28 #define DE_COMPILER_MSC		1		/*!< Microsoft Visual Studio.													*/
     29 #define DE_COMPILER_GCC     2		/*!< Gnu C Compiler.															*/
     30 #define DE_COMPILER_CLANG   3		/*!< LLVM Clang Compiler.														*/
     31 
     32 /* Compiler detection. */
     33 #if defined(_MSC_VER)
     34 #	define DE_DETAIL_DETECTED_COMPILER DE_COMPILER_MSC
     35 #elif defined(__clang__)
     36 #	define DE_DETAIL_DETECTED_COMPILER DE_COMPILER_CLANG
     37 #elif defined(__GNUC__)
     38 #   define DE_DETAIL_DETECTED_COMPILER DE_COMPILER_GCC
     39 #else
     40 	/* DE_DETAIL_DETECTED_COMPILER not set */
     41 #endif
     42 
     43 /* Compiler setting. */
     44 #if defined(DE_COMPILER)
     45 	/* Allow definitions from outside, but fail early if it conflicts with our detection */
     46 #	if defined(DE_DETAIL_DETECTED_COMPILER) && (DE_COMPILER != DE_DETAIL_DETECTED_COMPILER)
     47 		/* conflict, print a nice error messages for the most common misconfigs,
     48 		 * GCC and Clang, and a generic for other conflicts.
     49 		 */
     50 #		if (DE_DETAIL_DETECTED_COMPILER == DE_COMPILER_CLANG) && (DE_COMPILER == DE_COMPILER_GCC)
     51 #			error Detected compiler is Clang, but got DE_COMPILER == DE_COMPILER_GCC
     52 #		elif (DE_DETAIL_DETECTED_COMPILER == DE_COMPILER_GCC) && (DE_COMPILER == DE_COMPILER_CLANG)
     53 #			error Detected compiler is GCC, but got DE_COMPILER == DE_COMPILER_CLANG
     54 #		else
     55 #			error Detected compiler does not match the supplied compiler.
     56 #		endif
     57 #	endif
     58 	/* Clear autodetect vars. */
     59 #	if defined(DE_DETAIL_DETECTED_COMPILER)
     60 #		undef DE_DETAIL_DETECTED_COMPILER
     61 #	endif
     62 #else
     63 	/* No definition given from outside, try to autodetect */
     64 #	if defined(DE_DETAIL_DETECTED_COMPILER)
     65 #		define DE_COMPILER DE_DETAIL_DETECTED_COMPILER /*!< Compiler identification (set to one of DE_COMPILER_*). */
     66 #	else
     67 #		error Unknown compiler.
     68 #	endif
     69 #endif
     70 
     71 /* Operating systems. */
     72 #define DE_OS_VANILLA	0			/*!< Vanilla OS.								*/
     73 #define DE_OS_WIN32		1			/*!< Microsoft Windows desktop					*/
     74 #define DE_OS_UNIX      2			/*!< Unix (or compatible)						*/
     75 #define DE_OS_WINCE		3			/*!< Windows CE, Windows Mobile or Pocket PC	*/
     76 #define DE_OS_OSX		4			/*!< Mac OS X									*/
     77 #define DE_OS_ANDROID	5			/*!< Android									*/
     78 #define DE_OS_SYMBIAN	6			/*!< Symbian OS									*/
     79 #define DE_OS_IOS		7			/*!< iOS										*/
     80 
     81 /* OS detection (set to one of DE_OS_*). */
     82 #if defined(DE_OS)
     83 	/* Allow definitions from outside. */
     84 #elif defined(__ANDROID__)
     85 #	define DE_OS DE_OS_ANDROID
     86 #elif defined(_WIN32_WCE) || defined(UNDER_CE)
     87 #	define DE_OS DE_OS_WINCE
     88 #elif defined(_WIN32)
     89 #	define DE_OS DE_OS_WIN32
     90 #elif defined(__unix__) || defined(__linux) || defined(__linux__)
     91 #   define DE_OS DE_OS_UNIX
     92 #elif defined(__APPLE__)
     93 #	define DE_OS DE_OS_OSX
     94 #elif defined(__EPOC32__)
     95 #	define DE_OS DE_OS_SYMBIAN
     96 #else
     97 #	error Unknown operating system.
     98 #endif
     99 
    100 /* CPUs */
    101 #define DE_CPU_VANILLA	0
    102 #define DE_CPU_X86		1
    103 #define DE_CPU_ARM		2
    104 #define DE_CPU_X86_64	3
    105 #define DE_CPU_ARM_64	4
    106 #define DE_CPU_MIPS		5
    107 #define DE_CPU_MIPS_64	6
    108 
    109 /* CPU detection. */
    110 #if defined(DE_CPU)
    111 	/* Allow definitions from outside. */
    112 #elif defined(__aarch64__)
    113 #	define DE_CPU DE_CPU_ARM_64
    114 #elif defined(__arm__) || defined(__ARM__) || defined(__ARM_NEON__) || defined(ARM_BUILD)
    115 #	define DE_CPU DE_CPU_ARM
    116 #elif defined(_M_X64) || defined(__x86_64__) || defined(__amd64__)
    117 #	define DE_CPU DE_CPU_X86_64
    118 #elif defined(__i386__) || defined(_M_X86) || defined(_M_IX86) || defined(X86_BUILD)
    119 #	define DE_CPU DE_CPU_X86
    120 #elif defined(__mips__) && ((__mips) == 32)
    121 #	define DE_CPU DE_CPU_MIPS
    122 #elif defined(__mips__) && ((__mips) == 64)
    123 #	define DE_CPU DE_CPU_MIPS_64
    124 #else
    125 #	error Unknown CPU.
    126 #endif
    127 
    128 /* Endianness */
    129 #define DE_BIG_ENDIAN 		0
    130 #define DE_LITTLE_ENDIAN	1
    131 
    132 #if defined(DE_ENDIANNESS)
    133 	/* Allow definitions from outside. */
    134 #elif (DE_CPU == DE_CPU_X86) || (DE_CPU == DE_CPU_X86_64)
    135 	/* "detect" x86(_64) endianness */
    136 #	define DE_ENDIANNESS DE_LITTLE_ENDIAN
    137 #elif ((DE_CPU == DE_CPU_MIPS) || (DE_CPU == DE_CPU_MIPS_64))
    138 	/* detect mips endianness using platform specific macros */
    139 #	if defined(__MIPSEB__) && !defined(__MIPSEL__)
    140 #		define DE_ENDIANNESS DE_BIG_ENDIAN
    141 #	elif !defined(__MIPSEB__) && defined(__MIPSEL__)
    142 #		define DE_ENDIANNESS DE_LITTLE_ENDIAN
    143 #	else
    144 #		error Invalid MIPS endianness.
    145 #	endif
    146 #elif defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__)
    147 #	define DE_ENDIANNESS DE_LITTLE_ENDIAN
    148 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)
    149 #	define DE_ENDIANNESS DE_BIG_ENDIAN
    150 #else
    151 #	error Unknown endianness.
    152 #endif
    153 
    154 /* Sanity */
    155 #if ((DE_CPU == DE_CPU_X86) || (DE_CPU == DE_CPU_X86_64)) && (DE_ENDIANNESS == DE_BIG_ENDIAN)
    156 #	error Invalid x86(_64) endianness.
    157 #endif
    158 
    159 /* Sized data types. */
    160 typedef signed char			deInt8;
    161 typedef signed short		deInt16;
    162 typedef signed int			deInt32;
    163 typedef unsigned char		deUint8;
    164 typedef unsigned short		deUint16;
    165 typedef unsigned int		deUint32;
    166 
    167 #if (DE_COMPILER == DE_COMPILER_MSC)
    168 	typedef signed __int64		deInt64;
    169 	typedef unsigned __int64	deUint64;
    170 
    171 #	if (DE_OS == DE_OS_WINCE)
    172 #		include <basetsd.h>
    173 		typedef INT_PTR			deIntptr;
    174 		typedef UINT_PTR		deUintptr;
    175 #	elif (DE_OS == DE_OS_WIN32)
    176 #		include <crtdefs.h>
    177 		typedef intptr_t		deIntptr;
    178 		typedef uintptr_t		deUintptr;
    179 #	else
    180 #		error Define intptr types.
    181 #	endif
    182 
    183 #elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
    184 	/* \note stddef.h is needed for size_t definition. */
    185 #	include <stddef.h>
    186 #	include <stdint.h>
    187 	typedef int64_t				deInt64;
    188 	typedef uint64_t			deUint64;
    189 	typedef intptr_t			deIntptr;
    190 	typedef uintptr_t			deUintptr;
    191 #else
    192 #	error Define 64-bit and intptr types.
    193 #endif
    194 
    195 /** Boolean type. */
    196 typedef int deBool;
    197 #define DE_TRUE		1		/*!< True value for deBool.		*/
    198 #define DE_FALSE	0		/*!< False value for deBool.	*/
    199 
    200 /* Null pointer. */
    201 #if defined(__cplusplus)
    202 #	define DE_NULL 0
    203 #else
    204 #	define DE_NULL ((void*)0)		/*!< Null pointer.				*/
    205 #endif
    206 
    207 /* Function pointer type. */
    208 typedef void (*deFunctionPtr) (void);
    209 
    210 /* Debug macro. */
    211 #if defined(DE_DEBUG)
    212 	/* Already defined from outside. */
    213 #else
    214 #	if (DE_COMPILER != DE_COMPILER_GCC)
    215 #		if defined(_DEBUG)
    216 #			define DE_DEBUG					/*!< Debug build enabled? Usage: #if defined(DE_DEBUG).	*/
    217 #		endif
    218 #	elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
    219 #		if !defined(NDEBUG)
    220 #			define DE_DEBUG
    221 #		endif
    222 #	endif
    223 #endif
    224 
    225 /* Debug code macro. */
    226 #if defined(DE_DEBUG)
    227 #	define DE_DEBUG_CODE(X) X
    228 #else
    229 #	define DE_DEBUG_CODE(X)
    230 #endif
    231 
    232 /* Inline. */
    233 #if (DE_COMPILER == DE_COMPILER_MSC)
    234 #	define DE_INLINE __forceinline
    235 #elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
    236 #   define DE_INLINE static __inline__
    237 #else
    238 #	define DE_INLINE inline			/*!< Function inline.		*/
    239 #endif
    240 
    241 /* DE_DEV_BUILD -- only define when building on a development machine. */
    242 #if !defined(DE_DEV_BUILD)
    243 #	if (DE_COMPILER == DE_COMPILER_MSC)
    244 #		define DE_DEV_BUILD
    245 #	endif
    246 #endif
    247 
    248 /* DE_VALGRIND_BUILD -- define this in makefile if support for Valgrind is wanted. */
    249 /*#define DE_VALGRIND_BUILD*/
    250 
    251 /** Length of array. C++ version does compile time check that passed value is an array reference. */
    252 #if defined(__cplusplus) && (DE_COMPILER == DE_COMPILER_MSC)
    253 	template <typename T, size_t N> char (&deArraySizeHelper(T (&array)[N]))[N];
    254 #	define DE_LENGTH_OF_ARRAY(ARRAY) ((int)(sizeof(deArraySizeHelper(ARRAY))))
    255 #else
    256 #	define DE_LENGTH_OF_ARRAY(ARRAY) ((int)(sizeof(ARRAY) / sizeof((ARRAY)[0])))
    257 #endif
    258 
    259 #ifdef __cplusplus
    260 extern "C" {
    261 #endif
    262 
    263 /* Assertion macro family. */
    264 void deAssertFail(const char* reason, const char* file, int line);
    265 
    266 /* Assertion failure callback. Requires DE_ASSERT_FAILURE_CALLBACK to be defined or otherwise has no effect. */
    267 typedef void (*deAssertFailureCallbackFunc) (const char* reason, const char* file, int line);
    268 void deSetAssertFailureCallback (deAssertFailureCallbackFunc callback);
    269 
    270 DE_INLINE deBool deGetFalse (void) { return DE_FALSE; }
    271 DE_INLINE deBool deGetTrue (void) { return DE_TRUE; }
    272 
    273 /* Assertion macro. */
    274 #if defined(DE_DEBUG) && !defined(DE_COVERAGE_BUILD)
    275 #	define DE_ASSERT(X) do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) deAssertFail(#X, __FILE__, __LINE__); } while(deGetFalse())
    276 #else
    277 #	define DE_ASSERT(X) /*@ -noeffect*/ ((void)0)	/*!< Assertion macro. */
    278 #endif
    279 
    280 /* Verify macro. Behaves like assert in debug build, but executes statement in release build. */
    281 #if defined(DE_DEBUG)
    282 #	define DE_VERIFY(X) do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) deAssertFail(#X, __FILE__, __LINE__); } while(deGetFalse())
    283 #else
    284 #	define DE_VERIFY(X) X
    285 #endif
    286 
    287 /* Fatal macro. */
    288 #if defined(DE_DEBUG) && !defined(DE_COVERAGE_BUILD)
    289 #	define DE_FATAL(MSG) do { deAssertFail("" /* force to string literal */ MSG, __FILE__, __LINE__); } while(deGetFalse())
    290 #else
    291 #	define DE_FATAL(MSG) /*@ -noeffect*/ ((void)0)	/*!< Fatal macro. */
    292 #endif
    293 
    294 /** Test assert macro for use in testers (same as DE_ASSERT, but always enabled). */
    295 #define DE_TEST_ASSERT(X) do { if ((!deGetFalse() && (X)) ? DE_FALSE : DE_TRUE) deAssertFail(#X, __FILE__, __LINE__); } while(deGetFalse())
    296 
    297 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
    298 	/* GCC 4.8 and newer warns about unused typedefs. */
    299 #	define DE_UNUSED_TYPEDEF_ATTR __attribute__((unused))
    300 #else
    301 #	define DE_UNUSED_TYPEDEF_ATTR
    302 #endif
    303 
    304 /** Compile-time assertion macro. */
    305 #define DE_STATIC_ASSERT(X)						typedef char DE_UNIQUE_NAME[(X) ? 1 : -1] DE_UNUSED_TYPEDEF_ATTR
    306 #define DE_HEADER_STATIC_ASSERT(HEADERTOKEN, X)	typedef char DE_HEADER_UNIQUE_NAME(HEADERTOKEN)[(X) ? 1 : -1] DE_UNUSED_TYPEDEF_ATTR
    307 
    308 #define DE_UNIQUE_NAME						DE_MAKE_NAME(__LINE__, hoax)
    309 #define DE_HEADER_UNIQUE_NAME(HEADERTOKEN)	DE_MAKE_NAME(__LINE__, HEADERTOKEN)
    310 #define DE_MAKE_NAME(line, token) DE_MAKE_NAME2(line, token)
    311 #define DE_MAKE_NAME2(line, token) _static_assert_##line##_##token
    312 
    313 /** Software breakpoint. */
    314 #if (DE_CPU == DE_CPU_X86) && (DE_COMPILER == DE_COMPILER_MSC)
    315 #	define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __asm { int 3 } } while (deGetFalse())
    316 #elif (DE_CPU == DE_CPU_X86_64) && (DE_COMPILER == DE_COMPILER_MSC)
    317 #	define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __debugbreak(); } while (deGetFalse())
    318 #elif (DE_CPU == DE_CPU_ARM) && (DE_COMPILER == DE_COMPILER_GCC)
    319 #	define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __asm__ __volatile__ ( "bkpt #3" ); } while (deGetFalse())
    320 #elif (DE_CPU == DE_CPU_ARM) && (DE_COMPILER == DE_COMPILER_MSC)
    321 #	define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); DebugBreak(); } while (deGetFalse())
    322 #else
    323 #	define DE_BREAKPOINT() DE_FATAL("Software breakpoint encountered!")
    324 #endif
    325 
    326 /** Swap two values. */
    327 #define DE_SWAP(TYPE, A, B) do { TYPE _tmp_ = A; A = B; B = _tmp_; } while(deGetFalse())
    328 
    329 /** Offset of a struct member. */
    330 #define DE_OFFSET_OF(STRUCT, MEMBER) ((int)(deUintptr)(deUint8*)&(((STRUCT*)0)->MEMBER))
    331 
    332 /* Pointer size. */
    333 #if defined(DE_PTR_SIZE)
    334 	/* nada */
    335 #elif defined(_M_X64) || defined(__x86_64__) || defined(__amd64__) || defined(__aarch64__) || (defined(__mips) && ((__mips) == 64)) || defined(_LP64) || defined(__LP64__)
    336 #	define DE_PTR_SIZE 8
    337 #else
    338 #	define DE_PTR_SIZE 4	/* default to 32-bit */
    339 #endif
    340 
    341 /** Unreferenced variable silencing. */
    342 #define DE_UNREF(VAR) ((void)(VAR))
    343 
    344 /** DE_BEGIN_EXTERN_C and DE_END_EXTERN_C. */
    345 #if defined(__cplusplus)
    346 #	define DE_BEGIN_EXTERN_C extern "C" {
    347 #	define DE_END_EXTERN_C }
    348 #else
    349 #	define DE_BEGIN_EXTERN_C
    350 #	define DE_END_EXTERN_C
    351 #endif
    352 
    353 /** DE_NULL_STATEMENT */
    354 #if defined(DE_DEBUG)
    355 #	define DE_NULL_STATEMENT do {} while (deGetFalse())
    356 #else
    357 #	define DE_NULL_STATEMENT (void)0
    358 #endif
    359 
    360 /** GCC format string attributes */
    361 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
    362 #	define DE_PRINTF_FUNC_ATTR(FORMAT_STRING, FIRST_ARG) __attribute__ ((format(printf, FORMAT_STRING, FIRST_ARG)))
    363 #else
    364 #	define DE_PRINTF_FUNC_ATTR(FORMAT_STRING, FIRST_ARG)
    365 #endif
    366 
    367 /** Potentially unused func attribute to silence warnings from C templates. */
    368 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
    369 #	define DE_UNUSED_FUNCTION __attribute__((unused))
    370 #else
    371 #	define DE_UNUSED_FUNCTION
    372 #endif
    373 
    374 #ifdef __cplusplus
    375 }
    376 #endif
    377 
    378 #endif /* _DEDEFS_H */
    379