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 #define DE_OS_QNX 8 /*!< QNX */ 81 #define DE_OS_FUCHSIA 9 /*!< Fuchsia */ 82 83 /* OS detection (set to one of DE_OS_*). */ 84 #if defined(DE_OS) 85 /* Allow definitions from outside. */ 86 #elif defined(__ANDROID__) 87 #define DE_OS DE_OS_ANDROID 88 #elif defined(_WIN32_WCE) || defined(UNDER_CE) 89 #define DE_OS DE_OS_WINCE 90 #elif defined(_WIN32) 91 #define DE_OS DE_OS_WIN32 92 #elif defined(__unix__) || defined(__linux) || defined(__linux__) 93 #define DE_OS DE_OS_UNIX 94 #elif defined(__APPLE__) 95 #define DE_OS DE_OS_OSX 96 #elif defined(__EPOC32__) 97 #define DE_OS DE_OS_SYMBIAN 98 #elif defined(__QNX__) 99 #define DE_OS DE_OS_QNX 100 #else 101 #error Unknown operating system. 102 #endif 103 104 #if ((DE_OS == DE_OS_WIN32) || (DE_OS == DE_OS_UNIX)) && !defined(DEQP_SURFACELESS) && !defined(NULLWS) 105 #define DE_PLATFORM_USE_LIBRARY_TYPE 1 106 #else 107 #undef DE_PLATFORM_USE_LIBRARY_TYPE 108 #endif 109 110 /* CPUs */ 111 #define DE_CPU_VANILLA 0 112 #define DE_CPU_X86 1 113 #define DE_CPU_ARM 2 114 #define DE_CPU_X86_64 3 115 #define DE_CPU_ARM_64 4 116 #define DE_CPU_MIPS 5 117 #define DE_CPU_MIPS_64 6 118 #define DE_CPU_RISCV_32 7 119 #define DE_CPU_RISCV_64 8 120 121 /* CPU detection. */ 122 #if defined(DE_CPU) 123 /* Allow definitions from outside. */ 124 #elif defined(__aarch64__) 125 #define DE_CPU DE_CPU_ARM_64 126 #elif defined(__arm__) || defined(__ARM__) || defined(__ARM_NEON__) || defined(ARM_BUILD) 127 #define DE_CPU DE_CPU_ARM 128 #elif defined(_M_X64) || defined(__x86_64__) || defined(__amd64__) 129 #define DE_CPU DE_CPU_X86_64 130 #elif defined(__i386__) || defined(_M_X86) || defined(_M_IX86) || defined(X86_BUILD) 131 #define DE_CPU DE_CPU_X86 132 #elif defined(__mips__) && ((__mips) == 32) 133 #define DE_CPU DE_CPU_MIPS 134 #elif defined(__mips__) && ((__mips) == 64) 135 #define DE_CPU DE_CPU_MIPS_64 136 #elif defined(__riscv) && ((__riscv_xlen) == 32) 137 #define DE_CPU DE_CPU_RISCV_32 138 #elif defined(__riscv) && ((__riscv_xlen) == 64) 139 #define DE_CPU DE_CPU_RISCV_64 140 #else 141 #error Unknown CPU. 142 #endif 143 144 /* Endianness */ 145 #define DE_BIG_ENDIAN 0 146 #define DE_LITTLE_ENDIAN 1 147 148 #if defined(DE_ENDIANNESS) 149 /* Allow definitions from outside. */ 150 #elif (DE_CPU == DE_CPU_X86) || (DE_CPU == DE_CPU_X86_64) 151 /* "detect" x86(_64) endianness */ 152 #define DE_ENDIANNESS DE_LITTLE_ENDIAN 153 #elif ((DE_CPU == DE_CPU_MIPS) || (DE_CPU == DE_CPU_MIPS_64)) 154 /* detect mips endianness using platform specific macros */ 155 #if defined(__MIPSEB__) && !defined(__MIPSEL__) 156 #define DE_ENDIANNESS DE_BIG_ENDIAN 157 #elif !defined(__MIPSEB__) && defined(__MIPSEL__) 158 #define DE_ENDIANNESS DE_LITTLE_ENDIAN 159 #else 160 #error Invalid MIPS endianness. 161 #endif 162 #elif defined(__BYTE_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__) 163 #define DE_ENDIANNESS DE_LITTLE_ENDIAN 164 #elif defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__) 165 #define DE_ENDIANNESS DE_BIG_ENDIAN 166 #else 167 #error Unknown endianness. 168 #endif 169 170 /* Sanity */ 171 #if ((DE_CPU == DE_CPU_X86) || (DE_CPU == DE_CPU_X86_64)) && (DE_ENDIANNESS == DE_BIG_ENDIAN) 172 #error Invalid x86(_64) endianness. 173 #endif 174 175 /* Sized data types. */ 176 /* \note stddef.h is needed for size_t definition. */ 177 #include <stddef.h> 178 #include <stdint.h> 179 #include <stdbool.h> 180 181 #include "deDefs_kc_cts.h" 182 183 /* Function pointer type. */ 184 typedef void (*deFunctionPtr)(void); 185 186 /* Use DE_PTR_TYPE(T) instead of T* in macros to avoid clang-tidy warning. */ 187 #define DE_PTR_TYPE(T) T * /* NOLINT(T) */ 188 189 /* Debug macro. */ 190 #if defined(DE_DEBUG) 191 /* Already defined from outside. */ 192 #else 193 #if (DE_COMPILER != DE_COMPILER_GCC) 194 #if defined(_DEBUG) 195 #define DE_DEBUG /*!< Debug build enabled? Usage: #if defined(DE_DEBUG). */ 196 #endif 197 #elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG) 198 #if !defined(NDEBUG) 199 #define DE_DEBUG 200 #endif 201 #endif 202 #endif 203 204 /* DE_DEV_BUILD -- only define when building on a development machine. */ 205 #if !defined(DE_DEV_BUILD) 206 #if (DE_COMPILER == DE_COMPILER_MSC) 207 #define DE_DEV_BUILD 208 #endif 209 #endif 210 211 /* DE_VALGRIND_BUILD -- define this in makefile if support for Valgrind is wanted. */ 212 /*#define DE_VALGRIND_BUILD*/ 213 214 /** Length of array. C++ version does compile time check that passed value is an array reference. */ 215 #if defined(__cplusplus) 216 // deArraySizeHelper is a function that receives a reference to an array of N elements of type T and returns a reference to an 217 // array of N chars. This forces the compiler to check the argument is an actual array and not some other type implementing 218 // operator[]. The actual function is never defined anywhere, but taking the sizeof() of the result is allowed and equal to N. 219 template <typename T, size_t N> 220 char (&deArraySizeHelper(T (&array)[N]))[N]; 221 #define DE_LENGTH_OF_ARRAY(ARRAY) ((int)(sizeof(deArraySizeHelper(ARRAY)))) 222 #else 223 #define DE_LENGTH_OF_ARRAY(ARRAY) ((int)(sizeof(ARRAY) / sizeof((ARRAY)[0]))) 224 #endif 225 226 #ifdef __cplusplus 227 extern "C" 228 { 229 #endif 230 231 /* Assertion macro family. */ 232 void deAssertFail(const char *reason, const char *file, int line); 233 234 /* Assertion failure callback. Requires DE_ASSERT_FAILURE_CALLBACK to be defined or otherwise has no effect. */ 235 typedef void (*deAssertFailureCallbackFunc)(const char *reason, const char *file, int line); 236 void deSetAssertFailureCallback(deAssertFailureCallbackFunc callback); 237 238 /* Assertion macro. */ 239 #if defined(DE_DEBUG) && !defined(DE_COVERAGE_BUILD) 240 #define DE_ASSERT(X) \ 241 do \ 242 { \ 243 if (!(X)) \ 244 deAssertFail(#X, __FILE__, __LINE__); \ 245 } while (false) 246 #else 247 #define DE_ASSERT(X) /*@ -noeffect*/ ((void)0) /*!< Assertion macro. */ 248 #endif 249 250 /* Verify macro. Behaves like assert in debug build, but executes statement in release build. */ 251 #if defined(DE_DEBUG) 252 #define DE_VERIFY(X) \ 253 do \ 254 { \ 255 if (!(X)) \ 256 deAssertFail(#X, __FILE__, __LINE__); \ 257 } while (false) 258 #else 259 #define DE_VERIFY(X) X 260 #endif 261 262 /* Fatal macro. */ 263 #if defined(DE_DEBUG) && !defined(DE_COVERAGE_BUILD) 264 #define DE_FATAL(MSG) \ 265 do \ 266 { \ 267 deAssertFail("" /* force to string literal */ MSG, __FILE__, __LINE__); \ 268 } while (false) 269 #else 270 #define DE_FATAL(MSG) /*@ -noeffect*/ ((void)0) /*!< Fatal macro. */ 271 #endif 272 273 /** Test assert macro for use in testers (same as DE_ASSERT, but always enabled). */ 274 #define DE_TEST_ASSERT(X) \ 275 do \ 276 { \ 277 if (!(X)) \ 278 deAssertFail(#X, __FILE__, __LINE__); \ 279 } while (false) 280 281 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG) 282 /* GCC 4.8 and newer warns about unused typedefs. */ 283 #define DE_UNUSED_ATTR __attribute__((unused)) 284 #else 285 #define DE_UNUSED_ATTR 286 #endif 287 288 /** Compile-time assertion macro. */ 289 #define DE_STATIC_ASSERT(X) typedef char DE_UNIQUE_NAME[(X) ? 1 : -1] DE_UNUSED_ATTR 290 291 #define DE_UNIQUE_NAME DE_MAKE_NAME(__LINE__, hoax) 292 #define DE_MAKE_NAME(line, token) DE_MAKE_NAME2(line, token) 293 #define DE_MAKE_NAME2(line, token) _static_assert_##line##_##token 294 295 /** Software breakpoint. */ 296 #if (DE_CPU == DE_CPU_X86) && (DE_COMPILER == DE_COMPILER_MSC) 297 #define DE_BREAKPOINT() \ 298 do \ 299 { \ 300 printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); \ 301 __asm { int 3 } \ 302 } while (false) 303 #elif (DE_CPU == DE_CPU_X86_64) && (DE_COMPILER == DE_COMPILER_MSC) 304 #define DE_BREAKPOINT() \ 305 do \ 306 { \ 307 printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); \ 308 __debugbreak(); \ 309 } while (false) 310 #elif (DE_CPU == DE_CPU_ARM) && (DE_COMPILER == DE_COMPILER_GCC) 311 #define DE_BREAKPOINT() \ 312 do \ 313 { \ 314 printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); \ 315 __asm__ __volatile__("bkpt #3"); \ 316 } while (false) 317 #elif (DE_CPU == DE_CPU_ARM_64) && (DE_COMPILER == DE_COMPILER_GCC) 318 #define DE_BREAKPOINT() \ 319 do \ 320 { \ 321 printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); \ 322 __asm__ __volatile__("brk #3"); \ 323 } while (false) 324 #elif ((DE_CPU == DE_CPU_ARM) || (DE_CPU == DE_CPU_ARM_64)) && (DE_COMPILER == DE_COMPILER_MSC) 325 #define DE_BREAKPOINT() \ 326 do \ 327 { \ 328 printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); \ 329 DebugBreak(); \ 330 } while (false) 331 #else 332 #define DE_BREAKPOINT() DE_FATAL("Software breakpoint encountered!") 333 #endif 334 335 /** Used in enum to easify declarations for struct serialization. Declares 'NAME'_OFFSET, 'NAME'_SIZE, and offsets counter for next enum value by SIZE. */ 336 #define DE_SERIALIZED_FIELD(NAME, SIZE) NAME##_OFFSET, NAME##_SIZE = (SIZE), _DE_TMP_##NAME = NAME##_OFFSET + (SIZE)-1 337 338 /* Pointer size. */ 339 #if defined(DE_PTR_SIZE) 340 /* nada */ 341 #elif defined(_M_X64) || defined(__x86_64__) || defined(__amd64__) || defined(__aarch64__) || \ 342 (defined(__mips) && ((__mips) == 64)) || defined(_LP64) || defined(__LP64__) 343 #define DE_PTR_SIZE 8 344 #else 345 #define DE_PTR_SIZE 4 /* default to 32-bit */ 346 #endif 347 348 /* Floating-point environment flag. */ 349 #if defined(DE_FENV_ACCESS_ON) 350 /* Already defined */ 351 #elif (DE_COMPILER == DE_COMPILER_CLANG) && (DE_CPU == DE_CPU_ARM) 352 // FENV_ACCESS is not supported, disable all optimizations to avoid incorrect fp operation ordering 353 // Google Bug: b/298204279 354 #define DE_FENV_ACCESS_ON _Pragma("clang optimize off") 355 #elif (DE_COMPILER == DE_COMPILER_CLANG) && (DE_CPU != DE_CPU_ARM) 356 #define DE_FENV_ACCESS_ON _Pragma("STDC FENV_ACCESS ON") 357 #elif (DE_COMPILER == DE_COMPILER_MSC) 358 #define DE_FENV_ACCESS_ON __pragma(fenv_access(on)) 359 #else 360 #define DE_FENV_ACCESS_ON /* not supported */ 361 #endif 362 363 /** Unreferenced variable silencing. */ 364 #define DE_UNREF(VAR) ((void)(VAR)) 365 366 /** DE_BEGIN_EXTERN_C and DE_END_EXTERN_C. */ 367 #if defined(__cplusplus) 368 #define DE_BEGIN_EXTERN_C \ 369 extern "C" \ 370 { 371 #define DE_END_EXTERN_C } 372 #else 373 #define DE_BEGIN_EXTERN_C 374 #define DE_END_EXTERN_C 375 #endif 376 377 /** GCC format string attributes */ 378 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG) 379 #define DE_PRINTF_FUNC_ATTR(FORMAT_STRING, FIRST_ARG) __attribute__((format(printf, FORMAT_STRING, FIRST_ARG))) 380 #else 381 #define DE_PRINTF_FUNC_ATTR(FORMAT_STRING, FIRST_ARG) 382 #endif 383 384 /** Potentially unused func attribute to silence warnings from C templates. */ 385 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG) 386 #define DE_UNUSED_FUNCTION __attribute__((unused)) 387 #else 388 #define DE_UNUSED_FUNCTION 389 #endif 390 391 #if (DE_COMPILER == DE_COMPILER_MSC) 392 #define DE_PACKED(...) __pragma(pack(push, 1)) typedef struct __VA_ARGS__ __pragma(pack(pop)) 393 #elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG) 394 #define DE_PACKED(...) typedef struct __attribute__((__packed__)) __VA_ARGS__ 395 #else 396 #define DE_PACKED 397 #endif 398 deFatalStr(const char * reason)399 static inline const char *deFatalStr(const char *reason) 400 { 401 DE_ASSERT(0); 402 return reason; 403 } 404 405 #ifdef __cplusplus 406 } 407 #endif 408 409 #endif /* _DEDEFS_H */ 410