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 typedef int8_t deInt8;
180 typedef uint8_t deUint8;
181 typedef int16_t deInt16;
182 typedef uint16_t deUint16;
183 typedef int32_t deInt32;
184 typedef uint32_t deUint32;
185 typedef int64_t deInt64;
186 typedef uint64_t deUint64;
187 typedef intptr_t deIntptr;
188 typedef uintptr_t deUintptr;
189
190 /** Boolean type. */
191 typedef int deBool;
192 #define DE_TRUE 1 /*!< True value for deBool. */
193 #define DE_FALSE 0 /*!< False value for deBool. */
194
195 /* Null pointer. */
196 #if defined(__cplusplus)
197 # define DE_NULL 0
198 #else
199 # define DE_NULL ((void*)0) /*!< Null pointer. */
200 #endif
201
202 /* Function pointer type. */
203 typedef void (*deFunctionPtr) (void);
204
205 /* Use DE_PTR_TYPE(T) instead of T* in macros to avoid clang-tidy warning. */
206 #define DE_PTR_TYPE(T) T* /* NOLINT(T) */
207
208 /* Debug macro. */
209 #if defined(DE_DEBUG)
210 /* Already defined from outside. */
211 #else
212 # if (DE_COMPILER != DE_COMPILER_GCC)
213 # if defined(_DEBUG)
214 # define DE_DEBUG /*!< Debug build enabled? Usage: #if defined(DE_DEBUG). */
215 # endif
216 # elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
217 # if !defined(NDEBUG)
218 # define DE_DEBUG
219 # endif
220 # endif
221 #endif
222
223 /* Inline. */
224 #if (DE_COMPILER == DE_COMPILER_MSC)
225 # define DE_INLINE __forceinline
226 #elif (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
227 # define DE_INLINE static __inline__
228 #else
229 # define DE_INLINE inline /*!< Function inline. */
230 #endif
231
232 /* DE_DEV_BUILD -- only define when building on a development machine. */
233 #if !defined(DE_DEV_BUILD)
234 # if (DE_COMPILER == DE_COMPILER_MSC)
235 # define DE_DEV_BUILD
236 # endif
237 #endif
238
239 /* DE_VALGRIND_BUILD -- define this in makefile if support for Valgrind is wanted. */
240 /*#define DE_VALGRIND_BUILD*/
241
242 /** Length of array. C++ version does compile time check that passed value is an array reference. */
243 #if defined(__cplusplus)
244 // deArraySizeHelper is a function that receives a reference to an array of N elements of type T and returns a reference to an
245 // array of N chars. This forces the compiler to check the argument is an actual array and not some other type implementing
246 // operator[]. The actual function is never defined anywhere, but taking the sizeof() of the result is allowed and equal to N.
247 template <typename T, size_t N> char (&deArraySizeHelper(T (&array)[N]))[N];
248 # define DE_LENGTH_OF_ARRAY(ARRAY) ((int)(sizeof(deArraySizeHelper(ARRAY))))
249 #else
250 # define DE_LENGTH_OF_ARRAY(ARRAY) ((int)(sizeof(ARRAY) / sizeof((ARRAY)[0])))
251 #endif
252
253 #ifdef __cplusplus
254 extern "C" {
255 #endif
256
257 /* Assertion macro family. */
258 void deAssertFail(const char* reason, const char* file, int line);
259
260 /* Assertion failure callback. Requires DE_ASSERT_FAILURE_CALLBACK to be defined or otherwise has no effect. */
261 typedef void (*deAssertFailureCallbackFunc) (const char* reason, const char* file, int line);
262 void deSetAssertFailureCallback (deAssertFailureCallbackFunc callback);
263
deGetFalse(void)264 DE_INLINE deBool deGetFalse (void) { return DE_FALSE; }
deGetTrue(void)265 DE_INLINE deBool deGetTrue (void) { return DE_TRUE; }
266
267 /* Assertion macro. */
268 #if defined(DE_DEBUG) && !defined(DE_COVERAGE_BUILD)
269 # define DE_ASSERT(X) do { if (!(X)) deAssertFail(#X, __FILE__, __LINE__); } while(deGetFalse())
270 #else
271 # define DE_ASSERT(X) /*@ -noeffect*/ ((void)0) /*!< Assertion macro. */
272 #endif
273
274 /* Verify macro. Behaves like assert in debug build, but executes statement in release build. */
275 #if defined(DE_DEBUG)
276 # define DE_VERIFY(X) do { if (!(X)) deAssertFail(#X, __FILE__, __LINE__); } while(deGetFalse())
277 #else
278 # define DE_VERIFY(X) X
279 #endif
280
281 /* Fatal macro. */
282 #if defined(DE_DEBUG) && !defined(DE_COVERAGE_BUILD)
283 # define DE_FATAL(MSG) do { deAssertFail("" /* force to string literal */ MSG, __FILE__, __LINE__); } while(deGetFalse())
284 #else
285 # define DE_FATAL(MSG) /*@ -noeffect*/ ((void)0) /*!< Fatal macro. */
286 #endif
287
288 /** Test assert macro for use in testers (same as DE_ASSERT, but always enabled). */
289 #define DE_TEST_ASSERT(X) do { if (!(X)) deAssertFail(#X, __FILE__, __LINE__); } while(deGetFalse())
290
291 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
292 /* GCC 4.8 and newer warns about unused typedefs. */
293 # define DE_UNUSED_ATTR __attribute__((unused))
294 #else
295 # define DE_UNUSED_ATTR
296 #endif
297
298 /** Compile-time assertion macro. */
299 #define DE_STATIC_ASSERT(X) typedef char DE_UNIQUE_NAME[(X) ? 1 : -1] DE_UNUSED_ATTR
300
301 #define DE_UNIQUE_NAME DE_MAKE_NAME(__LINE__, hoax)
302 #define DE_MAKE_NAME(line, token) DE_MAKE_NAME2(line, token)
303 #define DE_MAKE_NAME2(line, token) _static_assert_##line##_##token
304
305 /** Software breakpoint. */
306 #if (DE_CPU == DE_CPU_X86) && (DE_COMPILER == DE_COMPILER_MSC)
307 # define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __asm { int 3 } } while (deGetFalse())
308 #elif (DE_CPU == DE_CPU_X86_64) && (DE_COMPILER == DE_COMPILER_MSC)
309 # define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __debugbreak(); } while (deGetFalse())
310 #elif (DE_CPU == DE_CPU_ARM) && (DE_COMPILER == DE_COMPILER_GCC)
311 # define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __asm__ __volatile__ ( "bkpt #3" ); } while (deGetFalse())
312 #elif (DE_CPU == DE_CPU_ARM_64) && (DE_COMPILER == DE_COMPILER_GCC)
313 # define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); __asm__ __volatile__ ( "brk #3" ); } while (deGetFalse())
314 #elif ((DE_CPU == DE_CPU_ARM) || (DE_CPU == DE_CPU_ARM_64)) && (DE_COMPILER == DE_COMPILER_MSC)
315 # define DE_BREAKPOINT() do { printf("Software breakpoint encountered in %s, line %d\n", __FILE__, __LINE__); DebugBreak(); } while (deGetFalse())
316 #else
317 # define DE_BREAKPOINT() DE_FATAL("Software breakpoint encountered!")
318 #endif
319
320 /** Swap two values. */
321 #define DE_SWAP(TYPE, A, B) do { TYPE _tmp_ = (A); (A) = (B); (B) = _tmp_; } while(deGetFalse())
322
323 /** Offset of a struct member. */
324 #define DE_OFFSET_OF(STRUCT, MEMBER) ((deUint32)(deUintptr)(deUint8*)&(((STRUCT*)0)->MEMBER))
325
326 /** Used in enum to easify declarations for struct serialization. Declares 'NAME'_OFFSET, 'NAME'_SIZE, and offsets counter for next enum value by SIZE. */
327 #define DE_SERIALIZED_FIELD(NAME, SIZE) NAME ## _OFFSET, NAME ## _SIZE = (SIZE), _DE_TMP_ ## NAME = NAME ## _OFFSET + (SIZE) - 1
328
329 /* Pointer size. */
330 #if defined(DE_PTR_SIZE)
331 /* nada */
332 #elif defined(_M_X64) || defined(__x86_64__) || defined(__amd64__) || defined(__aarch64__) || (defined(__mips) && ((__mips) == 64)) || defined(_LP64) || defined(__LP64__)
333 # define DE_PTR_SIZE 8
334 #else
335 # define DE_PTR_SIZE 4 /* default to 32-bit */
336 #endif
337
338 /* Floating-point environment flag. */
339 #if defined(DE_FENV_ACCESS_ON)
340 /* Already defined */
341 #elif (DE_COMPILER == DE_COMPILER_CLANG) && (DE_CPU == DE_CPU_ARM)
342 // FENV_ACCESS is not supported, disable all optimizations to avoid incorrect fp operation ordering
343 // Google Bug: b/298204279
344 # define DE_FENV_ACCESS_ON _Pragma("clang optimize off")
345 #elif (DE_COMPILER == DE_COMPILER_CLANG) && (DE_CPU != DE_CPU_ARM)
346 # define DE_FENV_ACCESS_ON _Pragma("STDC FENV_ACCESS ON")
347 #elif (DE_COMPILER == DE_COMPILER_MSC)
348 # define DE_FENV_ACCESS_ON __pragma(fenv_access (on))
349 #else
350 # define DE_FENV_ACCESS_ON /* not supported */
351 #endif
352
353 /** Unreferenced variable silencing. */
354 #define DE_UNREF(VAR) ((void)(VAR))
355
356 /** DE_BEGIN_EXTERN_C and DE_END_EXTERN_C. */
357 #if defined(__cplusplus)
358 # define DE_BEGIN_EXTERN_C extern "C" {
359 # define DE_END_EXTERN_C }
360 #else
361 # define DE_BEGIN_EXTERN_C
362 # define DE_END_EXTERN_C
363 #endif
364
365 /** DE_NULL_STATEMENT */
366 #if defined(DE_DEBUG)
367 # define DE_NULL_STATEMENT do {} while (deGetFalse())
368 #else
369 # define DE_NULL_STATEMENT (void)0
370 #endif
371
372 /** GCC format string attributes */
373 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
374 # define DE_PRINTF_FUNC_ATTR(FORMAT_STRING, FIRST_ARG) __attribute__ ((format(printf, FORMAT_STRING, FIRST_ARG)))
375 #else
376 # define DE_PRINTF_FUNC_ATTR(FORMAT_STRING, FIRST_ARG)
377 #endif
378
379 /** Potentially unused func attribute to silence warnings from C templates. */
380 #if (DE_COMPILER == DE_COMPILER_GCC) || (DE_COMPILER == DE_COMPILER_CLANG)
381 # define DE_UNUSED_FUNCTION __attribute__((unused))
382 #else
383 # define DE_UNUSED_FUNCTION
384 #endif
385
deFatalStr(const char * reason)386 DE_INLINE const char* deFatalStr (const char* reason) { DE_ASSERT(0); return reason; }
387
388 #ifdef __cplusplus
389 }
390 #endif
391
392 #endif /* _DEDEFS_H */
393