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