src/mesa/main/compiler.h

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