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