compiler.h revision 650e02003fbb5511ec758d993b7ec0a302ee2235
1/*
2 * Mesa 3-D graphics library
3 * Version:  7.5
4 *
5 * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
6 * Copyright (C) 2009  VMware, Inc.  All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the "Software"),
10 * to deal in the Software without restriction, including without limitation
11 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
12 * and/or sell copies of the Software, and to permit persons to whom the
13 * Software is furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included
16 * in all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
21 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
22 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 */
25
26
27/**
28 * \file compiler.h
29 * Compiler-related stuff.
30 */
31
32
33#ifndef COMPILER_H
34#define COMPILER_H
35
36
37#include <assert.h>
38#include <ctype.h>
39#if defined(__alpha__) && defined(CCPML)
40#include <cpml.h> /* use Compaq's Fast Math Library on Alpha */
41#else
42#include <math.h>
43#endif
44#include <limits.h>
45#include <stdlib.h>
46#include <stdio.h>
47#include <string.h>
48#if defined(__linux__) && defined(__i386__)
49#include <fpu_control.h>
50#endif
51#include <float.h>
52#include <stdarg.h>
53
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
59
60/**
61 * Get standard integer types
62 */
63#if defined(_MSC_VER)
64   typedef __int8             int8_t;
65   typedef unsigned __int8    uint8_t;
66   typedef __int16            int16_t;
67   typedef unsigned __int16   uint16_t;
68#  ifndef __eglplatform_h_
69     typedef __int32            int32_t;
70#  endif
71   typedef unsigned __int32   uint32_t;
72   typedef __int64            int64_t;
73   typedef unsigned __int64   uint64_t;
74
75#  if defined(_WIN64)
76     typedef __int64            intptr_t;
77     typedef unsigned __int64   uintptr_t;
78#  else
79     typedef __int32            intptr_t;
80     typedef unsigned __int32   uintptr_t;
81#  endif
82
83#  define INT64_C(__val) __val##i64
84#  define UINT64_C(__val) __val##ui64
85#else
86#  include <stdint.h>
87#endif
88
89
90/**
91  * Sun compilers define __i386 instead of the gcc-style __i386__
92 */
93#ifdef __SUNPRO_C
94# if !defined(__i386__) && defined(__i386)
95#  define __i386__
96# elif !defined(__amd64__) && defined(__amd64)
97#  define __amd64__
98# elif !defined(__sparc__) && defined(__sparc)
99#  define __sparc__
100# endif
101# if !defined(__volatile)
102#  define __volatile volatile
103# endif
104#endif
105
106
107/**
108 * finite macro.
109 */
110#if defined(_MSC_VER)
111#  define finite _finite
112#elif defined(__WATCOMC__)
113#  define finite _finite
114#endif
115
116
117/**
118 * Disable assorted warnings
119 */
120#if !defined(OPENSTEP) && (defined(__WIN32__) && !defined(__CYGWIN__)) && !defined(BUILD_FOR_SNAP)
121#  if !defined(__GNUC__) /* mingw environment */
122#    pragma warning( disable : 4068 ) /* unknown pragma */
123#    pragma warning( disable : 4710 ) /* function 'foo' not inlined */
124#    pragma warning( disable : 4711 ) /* function 'foo' selected for automatic inline expansion */
125#    pragma warning( disable : 4127 ) /* conditional expression is constant */
126#    if defined(MESA_MINWARN)
127#      pragma warning( disable : 4244 ) /* '=' : conversion from 'const double ' to 'float ', possible loss of data */
128#      pragma warning( disable : 4018 ) /* '<' : signed/unsigned mismatch */
129#      pragma warning( disable : 4305 ) /* '=' : truncation from 'const double ' to 'float ' */
130#      pragma warning( disable : 4550 ) /* 'function' undefined; assuming extern returning int */
131#      pragma warning( disable : 4761 ) /* integral size mismatch in argument; conversion supplied */
132#    endif
133#  endif
134#endif
135#if defined(__WATCOMC__)
136#  pragma disable_message(201) /* Disable unreachable code warnings */
137#endif
138
139
140
141/**
142 * Function inlining
143 */
144#if defined(__GNUC__)
145#  define INLINE __inline__
146#elif defined(__MSC__)
147#  define INLINE __inline
148#elif defined(_MSC_VER)
149#  define INLINE __inline
150#elif defined(__ICL)
151#  define INLINE __inline
152#elif defined(__INTEL_COMPILER)
153#  define INLINE inline
154#elif defined(__WATCOMC__) && (__WATCOMC__ >= 1100)
155#  define INLINE __inline
156#elif defined(__SUNPRO_C) && defined(__C99FEATURES__)
157#  define INLINE inline
158#  define __inline inline
159#  define __inline__ inline
160#elif (__STDC_VERSION__ >= 199901L) /* C99 */
161#  define INLINE inline
162#else
163#  define INLINE
164#endif
165
166
167/**
168 * PUBLIC/USED macros
169 *
170 * If we build the library with gcc's -fvisibility=hidden flag, we'll
171 * use the PUBLIC macro to mark functions that are to be exported.
172 *
173 * We also need to define a USED attribute, so the optimizer doesn't
174 * inline a static function that we later use in an alias. - ajax
175 */
176#if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
177#  define PUBLIC __attribute__((visibility("default")))
178#  define USED __attribute__((used))
179#else
180#  define PUBLIC
181#  define USED
182#endif
183
184
185/**
186 * Some compilers don't like some of Mesa's const usage.  In those places use
187 * CONST instead of const.  Pass -DNO_CONST to compilers where this matters.
188 */
189#ifdef NO_CONST
190#  define CONST
191#else
192#  define CONST const
193#endif
194
195
196/**
197 * __builtin_expect macros
198 */
199#if (!defined(__GNUC__) || __GNUC__ < 3) && (!defined(__IBMC__) || __IBMC__ < 900)
200#  define __builtin_expect(x, y) x
201#endif
202
203
204/**
205 * The __FUNCTION__ gcc variable is generally only used for debugging.
206 * If we're not using gcc, define __FUNCTION__ as a cpp symbol here.
207 * Don't define it if using a newer Windows compiler.
208 */
209#ifndef __FUNCTION__
210# if defined(__VMS)
211#  define __FUNCTION__ "VMS$NL:"
212# elif ((!defined __GNUC__) || (__GNUC__ < 2)) && (!defined __xlC__) && \
213      (!defined(_MSC_VER) || _MSC_VER < 1300)
214#  if (__STDC_VERSION__ >= 199901L) /* C99 */ || \
215    (defined(__SUNPRO_C) && defined(__C99FEATURES__))
216#   define __FUNCTION__ __func__
217#  else
218#   define __FUNCTION__ "<unknown>"
219#  endif
220# endif
221#endif
222
223
224/**
225 * Either define MESA_BIG_ENDIAN or MESA_LITTLE_ENDIAN.
226 * Do not use them unless absolutely necessary!
227 * Try to use a runtime test instead.
228 * For now, only used by some DRI hardware drivers for color/texel packing.
229 */
230#if defined(BYTE_ORDER) && defined(BIG_ENDIAN) && BYTE_ORDER == BIG_ENDIAN
231#if defined(__linux__)
232#include <byteswap.h>
233#define CPU_TO_LE32( x )	bswap_32( x )
234#elif defined(__APPLE__)
235#include <CoreFoundation/CFByteOrder.h>
236#define CPU_TO_LE32( x )	CFSwapInt32HostToLittle( x )
237#elif defined(_AIX)
238#define CPU_TO_LE32( x )        x = ((x & 0x000000ff) << 24) | \
239                                    ((x & 0x0000ff00) <<  8) | \
240                                    ((x & 0x00ff0000) >>  8) | \
241                                    ((x & 0xff000000) >> 24);
242#else /*__linux__ */
243#include <sys/endian.h>
244#define CPU_TO_LE32( x )	bswap32( x )
245#endif /*__linux__*/
246#define MESA_BIG_ENDIAN 1
247#else
248#define CPU_TO_LE32( x )	( x )
249#define MESA_LITTLE_ENDIAN 1
250#endif
251#define LE32_TO_CPU( x )	CPU_TO_LE32( x )
252
253
254
255#if !defined(CAPI) && defined(WIN32) && !defined(BUILD_FOR_SNAP)
256#define CAPI _cdecl
257#endif
258
259
260/**
261 * Create a macro so that asm functions can be linked into compilers other
262 * than GNU C
263 */
264#ifndef _ASMAPI
265#if defined(WIN32) && !defined(BUILD_FOR_SNAP)/* was: !defined( __GNUC__ ) && !defined( VMS ) && !defined( __INTEL_COMPILER )*/
266#define _ASMAPI __cdecl
267#else
268#define _ASMAPI
269#endif
270#ifdef	PTR_DECL_IN_FRONT
271#define	_ASMAPIP * _ASMAPI
272#else
273#define	_ASMAPIP _ASMAPI *
274#endif
275#endif
276
277#ifdef USE_X86_ASM
278#define _NORMAPI _ASMAPI
279#define _NORMAPIP _ASMAPIP
280#else
281#define _NORMAPI
282#define _NORMAPIP *
283#endif
284
285
286/* This is a macro on IRIX */
287#ifdef _P
288#undef _P
289#endif
290
291
292/* Turn off macro checking systems used by other libraries */
293#ifdef CHECK
294#undef CHECK
295#endif
296
297
298/**
299 * ASSERT macro
300 */
301#if !defined(_WIN32_WCE)
302#if defined(BUILD_FOR_SNAP) && defined(CHECKED)
303#  define ASSERT(X)   _CHECK(X)
304#elif defined(DEBUG)
305#  define ASSERT(X)   assert(X)
306#else
307#  define ASSERT(X)
308#endif
309#endif
310
311
312#ifndef NULL
313#define NULL 0
314#endif
315
316
317/**
318 * LONGSTRING macro
319 * gcc -pedantic warns about long string literals, LONGSTRING silences that.
320 */
321#if !defined(__GNUC__) || (__GNUC__ < 2) || \
322    ((__GNUC__ == 2) && (__GNUC_MINOR__ <= 7))
323# define LONGSTRING
324#else
325# define LONGSTRING __extension__
326#endif
327
328
329#ifndef M_PI
330#define M_PI (3.1415926536)
331#endif
332
333#ifndef M_E
334#define M_E (2.7182818284590452354)
335#endif
336
337#ifndef ONE_DIV_LN2
338#define ONE_DIV_LN2 (1.442695040888963456)
339#endif
340
341#ifndef ONE_DIV_SQRT_LN2
342#define ONE_DIV_SQRT_LN2 (1.201122408786449815)
343#endif
344
345#ifndef FLT_MAX_EXP
346#define FLT_MAX_EXP 128
347#endif
348
349
350/**
351 * USE_IEEE: Determine if we're using IEEE floating point
352 */
353#if defined(__i386__) || defined(__386__) || defined(__sparc__) || \
354    defined(__s390x__) || defined(__powerpc__) || \
355    defined(__x86_64__) || \
356    defined(ia64) || defined(__ia64__) || \
357    defined(__hppa__) || defined(hpux) || \
358    defined(__mips) || defined(_MIPS_ARCH) || \
359    defined(__arm__) || \
360    defined(__sh__) || defined(__m32r__) || \
361    (defined(__sun) && defined(_IEEE_754)) || \
362    (defined(__alpha__) && (defined(__IEEE_FLOAT) || !defined(VMS)))
363#define USE_IEEE
364#define IEEE_ONE 0x3f800000
365#endif
366
367
368/**
369 * START/END_FAST_MATH macros:
370 *
371 * START_FAST_MATH: Set x86 FPU to faster, 32-bit precision mode (and save
372 *                  original mode to a temporary).
373 * END_FAST_MATH: Restore x86 FPU to original mode.
374 */
375#if defined(__GNUC__) && defined(__i386__)
376/*
377 * Set the x86 FPU control word to guarentee only 32 bits of precision
378 * are stored in registers.  Allowing the FPU to store more introduces
379 * differences between situations where numbers are pulled out of memory
380 * vs. situations where the compiler is able to optimize register usage.
381 *
382 * In the worst case, we force the compiler to use a memory access to
383 * truncate the float, by specifying the 'volatile' keyword.
384 */
385/* Hardware default: All exceptions masked, extended double precision,
386 * round to nearest (IEEE compliant):
387 */
388#define DEFAULT_X86_FPU		0x037f
389/* All exceptions masked, single precision, round to nearest:
390 */
391#define FAST_X86_FPU		0x003f
392/* The fldcw instruction will cause any pending FP exceptions to be
393 * raised prior to entering the block, and we clear any pending
394 * exceptions before exiting the block.  Hence, asm code has free
395 * reign over the FPU while in the fast math block.
396 */
397#if defined(NO_FAST_MATH)
398#define START_FAST_MATH(x)						\
399do {									\
400   static GLuint mask = DEFAULT_X86_FPU;				\
401   __asm__ ( "fnstcw %0" : "=m" (*&(x)) );				\
402   __asm__ ( "fldcw %0" : : "m" (mask) );				\
403} while (0)
404#else
405#define START_FAST_MATH(x)						\
406do {									\
407   static GLuint mask = FAST_X86_FPU;					\
408   __asm__ ( "fnstcw %0" : "=m" (*&(x)) );				\
409   __asm__ ( "fldcw %0" : : "m" (mask) );				\
410} while (0)
411#endif
412/* Restore original FPU mode, and clear any exceptions that may have
413 * occurred in the FAST_MATH block.
414 */
415#define END_FAST_MATH(x)						\
416do {									\
417   __asm__ ( "fnclex ; fldcw %0" : : "m" (*&(x)) );			\
418} while (0)
419
420#elif defined(__WATCOMC__) && defined(__386__)
421#define DEFAULT_X86_FPU		0x037f /* See GCC comments above */
422#define FAST_X86_FPU		0x003f /* See GCC comments above */
423void _watcom_start_fast_math(unsigned short *x,unsigned short *mask);
424#pragma aux _watcom_start_fast_math =                                   \
425   "fnstcw  word ptr [eax]"                                             \
426   "fldcw   word ptr [ecx]"                                             \
427   parm [eax] [ecx]                                                     \
428   modify exact [];
429void _watcom_end_fast_math(unsigned short *x);
430#pragma aux _watcom_end_fast_math =                                     \
431   "fnclex"                                                             \
432   "fldcw   word ptr [eax]"                                             \
433   parm [eax]                                                           \
434   modify exact [];
435#if defined(NO_FAST_MATH)
436#define START_FAST_MATH(x)                                              \
437do {                                                                    \
438   static GLushort mask = DEFAULT_X86_FPU;	                        \
439   _watcom_start_fast_math(&x,&mask);                                   \
440} while (0)
441#else
442#define START_FAST_MATH(x)                                              \
443do {                                                                    \
444   static GLushort mask = FAST_X86_FPU;                                 \
445   _watcom_start_fast_math(&x,&mask);                                   \
446} while (0)
447#endif
448#define END_FAST_MATH(x)  _watcom_end_fast_math(&x)
449
450#elif defined(_MSC_VER) && defined(_M_IX86)
451#define DEFAULT_X86_FPU		0x037f /* See GCC comments above */
452#define FAST_X86_FPU		0x003f /* See GCC comments above */
453#if defined(NO_FAST_MATH)
454#define START_FAST_MATH(x) do {\
455	static GLuint mask = DEFAULT_X86_FPU;\
456	__asm fnstcw word ptr [x]\
457	__asm fldcw word ptr [mask]\
458} while(0)
459#else
460#define START_FAST_MATH(x) do {\
461	static GLuint mask = FAST_X86_FPU;\
462	__asm fnstcw word ptr [x]\
463	__asm fldcw word ptr [mask]\
464} while(0)
465#endif
466#define END_FAST_MATH(x) do {\
467	__asm fnclex\
468	__asm fldcw word ptr [x]\
469} while(0)
470
471#else
472#define START_FAST_MATH(x)  x = 0
473#define END_FAST_MATH(x)  (void)(x)
474#endif
475
476
477#ifndef Elements
478#define Elements(x) (sizeof(x)/sizeof(*(x)))
479#endif
480
481
482
483#ifdef __cplusplus
484}
485#endif
486
487
488#endif /* COMPILER_H */
489