compiler.h revision 138d639ec9d4454c646d94701365e25630d9f3da
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(_WIN32) && !defined(__WIN32__) && !defined(__CYGWIN__) && !defined(BUILD_FOR_SNAP)
111#  define __WIN32__
112#  define finite _finite
113#elif defined(__WATCOMC__)
114#  define finite _finite
115#endif
116
117
118/**
119 * Disable assorted warnings
120 */
121#if !defined(OPENSTEP) && (defined(__WIN32__) && !defined(__CYGWIN__)) && !defined(BUILD_FOR_SNAP)
122#  if !defined(__GNUC__) /* mingw environment */
123#    pragma warning( disable : 4068 ) /* unknown pragma */
124#    pragma warning( disable : 4710 ) /* function 'foo' not inlined */
125#    pragma warning( disable : 4711 ) /* function 'foo' selected for automatic inline expansion */
126#    pragma warning( disable : 4127 ) /* conditional expression is constant */
127#    if defined(MESA_MINWARN)
128#      pragma warning( disable : 4244 ) /* '=' : conversion from 'const double ' to 'float ', possible loss of data */
129#      pragma warning( disable : 4018 ) /* '<' : signed/unsigned mismatch */
130#      pragma warning( disable : 4305 ) /* '=' : truncation from 'const double ' to 'float ' */
131#      pragma warning( disable : 4550 ) /* 'function' undefined; assuming extern returning int */
132#      pragma warning( disable : 4761 ) /* integral size mismatch in argument; conversion supplied */
133#    endif
134#  endif
135#endif
136#if defined(__WATCOMC__)
137#  pragma disable_message(201) /* Disable unreachable code warnings */
138#endif
139
140
141
142/**
143 * Function inlining
144 */
145#if defined(__GNUC__)
146#  define INLINE __inline__
147#elif defined(__MSC__)
148#  define INLINE __inline
149#elif defined(_MSC_VER)
150#  define INLINE __inline
151#elif defined(__ICL)
152#  define INLINE __inline
153#elif defined(__INTEL_COMPILER)
154#  define INLINE inline
155#elif defined(__WATCOMC__) && (__WATCOMC__ >= 1100)
156#  define INLINE __inline
157#elif defined(__SUNPRO_C) && defined(__C99FEATURES__)
158#  define INLINE inline
159#  define __inline inline
160#  define __inline__ inline
161#elif (__STDC_VERSION__ >= 199901L) /* C99 */
162#  define INLINE inline
163#else
164#  define INLINE
165#endif
166
167
168/**
169 * PUBLIC/USED macros
170 *
171 * If we build the library with gcc's -fvisibility=hidden flag, we'll
172 * use the PUBLIC macro to mark functions that are to be exported.
173 *
174 * We also need to define a USED attribute, so the optimizer doesn't
175 * inline a static function that we later use in an alias. - ajax
176 */
177#if defined(__GNUC__) && (__GNUC__ * 100 + __GNUC_MINOR__) >= 303
178#  define PUBLIC __attribute__((visibility("default")))
179#  define USED __attribute__((used))
180#else
181#  define PUBLIC
182#  define USED
183#endif
184
185
186/**
187 * Some compilers don't like some of Mesa's const usage.  In those places use
188 * CONST instead of const.  Pass -DNO_CONST to compilers where this matters.
189 */
190#ifdef NO_CONST
191#  define CONST
192#else
193#  define CONST const
194#endif
195
196
197/**
198 * __builtin_expect macros
199 */
200#if (!defined(__GNUC__) || __GNUC__ < 3) && (!defined(__IBMC__) || __IBMC__ < 900)
201#  define __builtin_expect(x, y) x
202#endif
203
204
205/**
206 * The __FUNCTION__ gcc variable is generally only used for debugging.
207 * If we're not using gcc, define __FUNCTION__ as a cpp symbol here.
208 * Don't define it if using a newer Windows compiler.
209 */
210#ifndef __FUNCTION__
211# if defined(__VMS)
212#  define __FUNCTION__ "VMS$NL:"
213# elif ((!defined __GNUC__) || (__GNUC__ < 2)) && (!defined __xlC__) && \
214      (!defined(_MSC_VER) || _MSC_VER < 1300)
215#  if (__STDC_VERSION__ >= 199901L) /* C99 */ || \
216    (defined(__SUNPRO_C) && defined(__C99FEATURES__))
217#   define __FUNCTION__ __func__
218#  else
219#   define __FUNCTION__ "<unknown>"
220#  endif
221# endif
222#endif
223
224
225/**
226 * Either define MESA_BIG_ENDIAN or MESA_LITTLE_ENDIAN.
227 * Do not use them unless absolutely necessary!
228 * Try to use a runtime test instead.
229 * For now, only used by some DRI hardware drivers for color/texel packing.
230 */
231#if defined(BYTE_ORDER) && defined(BIG_ENDIAN) && BYTE_ORDER == BIG_ENDIAN
232#if defined(__linux__)
233#include <byteswap.h>
234#define CPU_TO_LE32( x )	bswap_32( x )
235#elif defined(__APPLE__)
236#include <CoreFoundation/CFByteOrder.h>
237#define CPU_TO_LE32( x )	CFSwapInt32HostToLittle( x )
238#elif (defined(_AIX) || defined(__blrts))
239#define CPU_TO_LE32( x )        x = ((x & 0x000000ff) << 24) | \
240                                    ((x & 0x0000ff00) <<  8) | \
241                                    ((x & 0x00ff0000) >>  8) | \
242                                    ((x & 0xff000000) >> 24);
243#else /*__linux__ */
244#include <sys/endian.h>
245#define CPU_TO_LE32( x )	bswap32( x )
246#endif /*__linux__*/
247#define MESA_BIG_ENDIAN 1
248#else
249#define CPU_TO_LE32( x )	( x )
250#define MESA_LITTLE_ENDIAN 1
251#endif
252#define LE32_TO_CPU( x )	CPU_TO_LE32( x )
253
254
255
256#if !defined(CAPI) && defined(WIN32) && !defined(BUILD_FOR_SNAP)
257#define CAPI _cdecl
258#endif
259
260
261/**
262 * Create a macro so that asm functions can be linked into compilers other
263 * than GNU C
264 */
265#ifndef _ASMAPI
266#if defined(WIN32) && !defined(BUILD_FOR_SNAP)/* was: !defined( __GNUC__ ) && !defined( VMS ) && !defined( __INTEL_COMPILER )*/
267#define _ASMAPI __cdecl
268#else
269#define _ASMAPI
270#endif
271#ifdef	PTR_DECL_IN_FRONT
272#define	_ASMAPIP * _ASMAPI
273#else
274#define	_ASMAPIP _ASMAPI *
275#endif
276#endif
277
278#ifdef USE_X86_ASM
279#define _NORMAPI _ASMAPI
280#define _NORMAPIP _ASMAPIP
281#else
282#define _NORMAPI
283#define _NORMAPIP *
284#endif
285
286
287/* This is a macro on IRIX */
288#ifdef _P
289#undef _P
290#endif
291
292
293/* Turn off macro checking systems used by other libraries */
294#ifdef CHECK
295#undef CHECK
296#endif
297
298
299/**
300 * ASSERT macro
301 */
302#if !defined(_WIN32_WCE)
303#if defined(BUILD_FOR_SNAP) && defined(CHECKED)
304#  define ASSERT(X)   _CHECK(X)
305#elif defined(DEBUG)
306#  define ASSERT(X)   assert(X)
307#else
308#  define ASSERT(X)
309#endif
310#endif
311
312
313#ifndef NULL
314#define NULL 0
315#endif
316
317
318/**
319 * LONGSTRING macro
320 * gcc -pedantic warns about long string literals, LONGSTRING silences that.
321 */
322#if !defined(__GNUC__) || (__GNUC__ < 2) || \
323    ((__GNUC__ == 2) && (__GNUC_MINOR__ <= 7))
324# define LONGSTRING
325#else
326# define LONGSTRING __extension__
327#endif
328
329
330#ifndef M_PI
331#define M_PI (3.1415926536)
332#endif
333
334#ifndef M_E
335#define M_E (2.7182818284590452354)
336#endif
337
338#ifndef ONE_DIV_LN2
339#define ONE_DIV_LN2 (1.442695040888963456)
340#endif
341
342#ifndef ONE_DIV_SQRT_LN2
343#define ONE_DIV_SQRT_LN2 (1.201122408786449815)
344#endif
345
346#ifndef FLT_MAX_EXP
347#define FLT_MAX_EXP 128
348#endif
349
350
351/**
352 * USE_IEEE: Determine if we're using IEEE floating point
353 */
354#if defined(__i386__) || defined(__386__) || defined(__sparc__) || \
355    defined(__s390x__) || defined(__powerpc__) || \
356    defined(__x86_64__) || \
357    defined(ia64) || defined(__ia64__) || \
358    defined(__hppa__) || defined(hpux) || \
359    defined(__mips) || defined(_MIPS_ARCH) || \
360    defined(__arm__) || \
361    defined(__sh__) || defined(__m32r__) || \
362    (defined(__sun) && defined(_IEEE_754)) || \
363    (defined(__alpha__) && (defined(__IEEE_FLOAT) || !defined(VMS)))
364#define USE_IEEE
365#define IEEE_ONE 0x3f800000
366#endif
367
368
369/**
370 * START/END_FAST_MATH macros:
371 *
372 * START_FAST_MATH: Set x86 FPU to faster, 32-bit precision mode (and save
373 *                  original mode to a temporary).
374 * END_FAST_MATH: Restore x86 FPU to original mode.
375 */
376#if defined(__GNUC__) && defined(__i386__)
377/*
378 * Set the x86 FPU control word to guarentee only 32 bits of precision
379 * are stored in registers.  Allowing the FPU to store more introduces
380 * differences between situations where numbers are pulled out of memory
381 * vs. situations where the compiler is able to optimize register usage.
382 *
383 * In the worst case, we force the compiler to use a memory access to
384 * truncate the float, by specifying the 'volatile' keyword.
385 */
386/* Hardware default: All exceptions masked, extended double precision,
387 * round to nearest (IEEE compliant):
388 */
389#define DEFAULT_X86_FPU		0x037f
390/* All exceptions masked, single precision, round to nearest:
391 */
392#define FAST_X86_FPU		0x003f
393/* The fldcw instruction will cause any pending FP exceptions to be
394 * raised prior to entering the block, and we clear any pending
395 * exceptions before exiting the block.  Hence, asm code has free
396 * reign over the FPU while in the fast math block.
397 */
398#if defined(NO_FAST_MATH)
399#define START_FAST_MATH(x)						\
400do {									\
401   static GLuint mask = DEFAULT_X86_FPU;				\
402   __asm__ ( "fnstcw %0" : "=m" (*&(x)) );				\
403   __asm__ ( "fldcw %0" : : "m" (mask) );				\
404} while (0)
405#else
406#define START_FAST_MATH(x)						\
407do {									\
408   static GLuint mask = FAST_X86_FPU;					\
409   __asm__ ( "fnstcw %0" : "=m" (*&(x)) );				\
410   __asm__ ( "fldcw %0" : : "m" (mask) );				\
411} while (0)
412#endif
413/* Restore original FPU mode, and clear any exceptions that may have
414 * occurred in the FAST_MATH block.
415 */
416#define END_FAST_MATH(x)						\
417do {									\
418   __asm__ ( "fnclex ; fldcw %0" : : "m" (*&(x)) );			\
419} while (0)
420
421#elif defined(__WATCOMC__) && defined(__386__)
422#define DEFAULT_X86_FPU		0x037f /* See GCC comments above */
423#define FAST_X86_FPU		0x003f /* See GCC comments above */
424void _watcom_start_fast_math(unsigned short *x,unsigned short *mask);
425#pragma aux _watcom_start_fast_math =                                   \
426   "fnstcw  word ptr [eax]"                                             \
427   "fldcw   word ptr [ecx]"                                             \
428   parm [eax] [ecx]                                                     \
429   modify exact [];
430void _watcom_end_fast_math(unsigned short *x);
431#pragma aux _watcom_end_fast_math =                                     \
432   "fnclex"                                                             \
433   "fldcw   word ptr [eax]"                                             \
434   parm [eax]                                                           \
435   modify exact [];
436#if defined(NO_FAST_MATH)
437#define START_FAST_MATH(x)                                              \
438do {                                                                    \
439   static GLushort mask = DEFAULT_X86_FPU;	                        \
440   _watcom_start_fast_math(&x,&mask);                                   \
441} while (0)
442#else
443#define START_FAST_MATH(x)                                              \
444do {                                                                    \
445   static GLushort mask = FAST_X86_FPU;                                 \
446   _watcom_start_fast_math(&x,&mask);                                   \
447} while (0)
448#endif
449#define END_FAST_MATH(x)  _watcom_end_fast_math(&x)
450
451#elif defined(_MSC_VER) && defined(_M_IX86)
452#define DEFAULT_X86_FPU		0x037f /* See GCC comments above */
453#define FAST_X86_FPU		0x003f /* See GCC comments above */
454#if defined(NO_FAST_MATH)
455#define START_FAST_MATH(x) do {\
456	static GLuint mask = DEFAULT_X86_FPU;\
457	__asm fnstcw word ptr [x]\
458	__asm fldcw word ptr [mask]\
459} while(0)
460#else
461#define START_FAST_MATH(x) do {\
462	static GLuint mask = FAST_X86_FPU;\
463	__asm fnstcw word ptr [x]\
464	__asm fldcw word ptr [mask]\
465} while(0)
466#endif
467#define END_FAST_MATH(x) do {\
468	__asm fnclex\
469	__asm fldcw word ptr [x]\
470} while(0)
471
472#else
473#define START_FAST_MATH(x)  x = 0
474#define END_FAST_MATH(x)  (void)(x)
475#endif
476
477
478#ifndef Elements
479#define Elements(x) (sizeof(x)/sizeof(*(x)))
480#endif
481
482
483
484#ifdef __cplusplus
485}
486#endif
487
488
489#endif /* COMPILER_H */
490