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