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(__VMS)
 187 #  define __FUNCTION__ "VMS$NL:"
 188 # elif !defined(__GNUC__) && !defined(__xlC__) &&       \
 189       (!defined(_MSC_VER) || _MSC_VER < 1300)
 190 #  if (__STDC_VERSION__ >= 199901L) /* C99 */ || \
 191     (defined(__SUNPRO_C) && defined(__C99FEATURES__))
 192 #   define __FUNCTION__ __func__
 193 #  else
 194 #   define __FUNCTION__ "<unknown>"
 195 #  endif
 196 # endif
 197 #endif
 198 #ifndef __func__
 199 #  if (__STDC_VERSION__ >= 199901L) || \
 200       (defined(__SUNPRO_C) && defined(__C99FEATURES__))
 201        /* __func__ is part of C99 */
 202 #  elif defined(_MSC_VER)
 203 #    if _MSC_VER >= 1300
 204 #      define __func__ __FUNCTION__
 205 #    else
 206 #      define __func__ "<unknown>"
 207 #    endif
 208 #  endif
 209 #endif
 210
 211
 212 /**
 213  * Either define MESA_BIG_ENDIAN or MESA_LITTLE_ENDIAN, and CPU_TO_LE32.
 214  * Do not use these unless absolutely necessary!
 215  * Try to use a runtime test instead.
 216  * For now, only used by some DRI hardware drivers for color/texel packing.
 217  */
 218 #if defined(BYTE_ORDER) && defined(BIG_ENDIAN) && BYTE_ORDER == BIG_ENDIAN
 219 #if defined(__linux__)
 220 #include <byteswap.h>
 221 #define CPU_TO_LE32( x )        bswap_32( x )
 222 #elif defined(__APPLE__)
 223 #include <CoreFoundation/CFByteOrder.h>
 224 #define CPU_TO_LE32( x )        CFSwapInt32HostToLittle( x )
 225 #elif (defined(_AIX) || defined(__blrts))
 226 static INLINE GLuint CPU_TO_LE32(GLuint x)
 227 {
 228    return (((x & 0x000000ff) << 24) |
 229            ((x & 0x0000ff00) <<  8) |
 230            ((x & 0x00ff0000) >>  8) |
 231            ((x & 0xff000000) >> 24));
 232 }
 233 #elif defined(__OpenBSD__)
 234 #include <sys/types.h>
 235 #define CPU_TO_LE32( x )        htole32( x )
 236 #else /*__linux__ */
 237 #include <sys/endian.h>
 238 #define CPU_TO_LE32( x )        bswap32( x )
 239 #endif /*__linux__*/
 240 #define MESA_BIG_ENDIAN 1
 241 #else
 242 #define CPU_TO_LE32( x )        ( x )
 243 #define MESA_LITTLE_ENDIAN 1
 244 #endif
 245 #define LE32_TO_CPU( x )        CPU_TO_LE32( x )
 246
 247
 248
 249 #if !defined(CAPI) && defined(_WIN32) && !defined(BUILD_FOR_SNAP)
 250 #define CAPI _cdecl
 251 #endif
 252
 253
 254 /**
 255  * Create a macro so that asm functions can be linked into compilers other
 256  * than GNU C
 257  */
 258 #ifndef _ASMAPI
 259 #if defined(_WIN32) && !defined(BUILD_FOR_SNAP)/* was: !defined( __GNUC__ ) && !defined( VMS ) && !defined( __INTEL_COMPILER )*/
 260 #define _ASMAPI __cdecl
 261 #else
 262 #define _ASMAPI
 263 #endif
 264 #ifdef  PTR_DECL_IN_FRONT
 265 #define _ASMAPIP * _ASMAPI
 266 #else
 267 #define _ASMAPIP _ASMAPI *
 268 #endif
 269 #endif
 270
 271 #ifdef USE_X86_ASM
 272 #define _NORMAPI _ASMAPI
 273 #define _NORMAPIP _ASMAPIP
 274 #else
 275 #define _NORMAPI
 276 #define _NORMAPIP *
 277 #endif
 278
 279
 280 /* Turn off macro checking systems used by other libraries */
 281 #ifdef CHECK
 282 #undef CHECK
 283 #endif
 284
 285
 286 /**
 287  * ASSERT macro
 288  */
 289 #if !defined(_WIN32_WCE)
 290 #if defined(BUILD_FOR_SNAP) && defined(CHECKED)
 291 #  define ASSERT(X)   _CHECK(X)
 292 #elif defined(DEBUG)
 293 #  define ASSERT(X)   assert(X)
 294 #else
 295 #  define ASSERT(X)
 296 #endif
 297 #endif
 298
 299
 300 /**
 301  * Static (compile-time) assertion.
 302  * Basically, use COND to dimension an array.  If COND is false/zero the
 303  * array size will be -1 and we'll get a compilation error.
 304  */
 305 #define STATIC_ASSERT(COND) \
 306    do { \
 307       typedef int static_assertion_failed[(!!(COND))*2-1]; \
 308    } while (0)
 309
 310
 311 #if (__GNUC__ >= 3)
 312 #define PRINTFLIKE(f, a) __attribute__ ((format(__printf__, f, a)))
 313 #else
 314 #define PRINTFLIKE(f, a)
 315 #endif
 316
 317 #ifndef NULL
 318 #define NULL 0
 319 #endif
 320
 321
 322 /**
 323  * LONGSTRING macro
 324  * gcc -pedantic warns about long string literals, LONGSTRING silences that.
 325  */
 326 #if !defined(__GNUC__)
 327 # define LONGSTRING
 328 #else
 329 # define LONGSTRING __extension__
 330 #endif
 331
 332
 333 #ifndef M_PI
 334 #define M_PI (3.14159265358979323846)
 335 #endif
 336
 337 #ifndef M_E
 338 #define M_E (2.7182818284590452354)
 339 #endif
 340
 341 #ifndef M_LOG2E
 342 #define M_LOG2E     (1.4426950408889634074)
 343 #endif
 344
 345 #ifndef ONE_DIV_SQRT_LN2
 346 #define ONE_DIV_SQRT_LN2 (1.201122408786449815)
 347 #endif
 348
 349 #ifndef FLT_MAX_EXP
 350 #define FLT_MAX_EXP 128
 351 #endif
 352
 353
 354 /**
 355  * USE_IEEE: Determine if we're using IEEE floating point
 356  */
 357 #if defined(__i386__) || defined(__386__) || defined(__sparc__) || \
 358     defined(__s390x__) || defined(__powerpc__) || \
 359     defined(__x86_64__) || \
 360     defined(ia64) || defined(__ia64__) || \
 361     defined(__hppa__) || defined(hpux) || \
 362     defined(__mips) || defined(_MIPS_ARCH) || \
 363     defined(__arm__) || \
 364     defined(__sh__) || defined(__m32r__) || \
 365     (defined(__sun) && defined(_IEEE_754)) || \
 366     (defined(__alpha__) && (defined(__IEEE_FLOAT) || !defined(VMS)))
 367 #define USE_IEEE
 368 #define IEEE_ONE 0x3f800000
 369 #endif
 370
 371
 372 /**
 373  * START/END_FAST_MATH macros:
 374  *
 375  * START_FAST_MATH: Set x86 FPU to faster, 32-bit precision mode (and save
 376  *                  original mode to a temporary).
 377  * END_FAST_MATH: Restore x86 FPU to original mode.
 378  */
 379 #if defined(__GNUC__) && defined(__i386__)
 380 /*
 381  * Set the x86 FPU control word to guarentee only 32 bits of precision
 382  * are stored in registers.  Allowing the FPU to store more introduces
 383  * differences between situations where numbers are pulled out of memory
 384  * vs. situations where the compiler is able to optimize register usage.
 385  *
 386  * In the worst case, we force the compiler to use a memory access to
 387  * truncate the float, by specifying the 'volatile' keyword.
 388  */
 389 /* Hardware default: All exceptions masked, extended double precision,
 390  * round to nearest (IEEE compliant):
 391  */
 392 #define DEFAULT_X86_FPU         0x037f
 393 /* All exceptions masked, single precision, round to nearest:
 394  */
 395 #define FAST_X86_FPU            0x003f
 396 /* The fldcw instruction will cause any pending FP exceptions to be
 397  * raised prior to entering the block, and we clear any pending
 398  * exceptions before exiting the block.  Hence, asm code has free
 399  * reign over the FPU while in the fast math block.
 400  */
 401 #if defined(NO_FAST_MATH)
 402 #define START_FAST_MATH(x)                                              \
 403 do {                                                                    \
 404    static GLuint mask = DEFAULT_X86_FPU;                                \
 405    __asm__ ( "fnstcw %0" : "=m" (*&(x)) );                              \
 406    __asm__ ( "fldcw %0" : : "m" (mask) );                               \
 407 } while (0)
 408 #else
 409 #define START_FAST_MATH(x)                                              \
 410 do {                                                                    \
 411    static GLuint mask = FAST_X86_FPU;                                   \
 412    __asm__ ( "fnstcw %0" : "=m" (*&(x)) );                              \
 413    __asm__ ( "fldcw %0" : : "m" (mask) );                               \
 414 } while (0)
 415 #endif
 416 /* Restore original FPU mode, and clear any exceptions that may have
 417  * occurred in the FAST_MATH block.
 418  */
 419 #define END_FAST_MATH(x)                                                \
 420 do {                                                                    \
 421    __asm__ ( "fnclex ; fldcw %0" : : "m" (*&(x)) );                     \
 422 } while (0)
 423
 424 #elif defined(__WATCOMC__) && defined(__386__)
 425 #define DEFAULT_X86_FPU         0x037f /* See GCC comments above */
 426 #define FAST_X86_FPU            0x003f /* See GCC comments above */
 427 void _watcom_start_fast_math(unsigned short *x,unsigned short *mask);
 428 #pragma aux _watcom_start_fast_math =                                   \
 429    "fnstcw  word ptr [eax]"                                             \
 430    "fldcw   word ptr [ecx]"                                             \
 431    parm [eax] [ecx]                                                     \
 432    modify exact [];
 433 void _watcom_end_fast_math(unsigned short *x);
 434 #pragma aux _watcom_end_fast_math =                                     \
 435    "fnclex"                                                             \
 436    "fldcw   word ptr [eax]"                                             \
 437    parm [eax]                                                           \
 438    modify exact [];
 439 #if defined(NO_FAST_MATH)
 440 #define START_FAST_MATH(x)                                              \
 441 do {                                                                    \
 442    static GLushort mask = DEFAULT_X86_FPU;                              \
 443    _watcom_start_fast_math(&x,&mask);                                   \
 444 } while (0)
 445 #else
 446 #define START_FAST_MATH(x)                                              \
 447 do {                                                                    \
 448    static GLushort mask = FAST_X86_FPU;                                 \
 449    _watcom_start_fast_math(&x,&mask);                                   \
 450 } while (0)
 451 #endif
 452 #define END_FAST_MATH(x)  _watcom_end_fast_math(&x)
 453
 454 #elif defined(_MSC_VER) && defined(_M_IX86)
 455 #define DEFAULT_X86_FPU         0x037f /* See GCC comments above */
 456 #define FAST_X86_FPU            0x003f /* See GCC comments above */
 457 #if defined(NO_FAST_MATH)
 458 #define START_FAST_MATH(x) do {\
 459         static GLuint mask = DEFAULT_X86_FPU;\
 460         __asm fnstcw word ptr [x]\
 461         __asm fldcw word ptr [mask]\
 462 } while(0)
 463 #else
 464 #define START_FAST_MATH(x) do {\
 465         static GLuint mask = FAST_X86_FPU;\
 466         __asm fnstcw word ptr [x]\
 467         __asm fldcw word ptr [mask]\
 468 } while(0)
 469 #endif
 470 #define END_FAST_MATH(x) do {\
 471         __asm fnclex\
 472         __asm fldcw word ptr [x]\
 473 } while(0)
 474
 475 #else
 476 #define START_FAST_MATH(x)  x = 0
 477 #define END_FAST_MATH(x)  (void)(x)
 478 #endif
 479
 480
 481 #ifndef Elements
 482 #define Elements(x) (sizeof(x)/sizeof(*(x)))
 483 #endif
 484
 485
 486
 487 #ifdef __cplusplus
 488 }
 489 #endif
 490
 491
 492 #endif /* COMPILER_H */