src/mesa/main/imports.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.5
   4  *
   5  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \file imports.h
  28  * Standard C library function wrappers.
  29  *
  30  * This file provides wrappers for all the standard C library functions
  31  * like malloc(), free(), printf(), getenv(), etc.
  32  */
  33
  34
  35 #ifndef IMPORTS_H
  36 #define IMPORTS_H
  37
  38
  39 #include "compiler.h"
  40 #include "glheader.h"
  41
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 /**********************************************************************/
  49 /** Memory macros */
  50 /*@{*/
  51
  52 /** Allocate \p BYTES bytes */
  53 #define MALLOC(BYTES)      malloc(BYTES)
  54 /** Allocate and zero \p BYTES bytes */
  55 #define CALLOC(BYTES)      calloc(1, BYTES)
  56 /** Allocate a structure of type \p T */
  57 #define MALLOC_STRUCT(T)   (struct T *) malloc(sizeof(struct T))
  58 /** Allocate and zero a structure of type \p T */
  59 #define CALLOC_STRUCT(T)   (struct T *) calloc(1, sizeof(struct T))
  60 /** Free memory */
  61 #define FREE(PTR)          free(PTR)
  62
  63 /*@}*/
  64
  65
  66 /*
  67  * For GL_ARB_vertex_buffer_object we need to treat vertex array pointers
  68  * as offsets into buffer stores.  Since the vertex array pointer and
  69  * buffer store pointer are both pointers and we need to add them, we use
  70  * this macro.
  71  * Both pointers/offsets are expressed in bytes.
  72  */
  73 #define ADD_POINTERS(A, B)  ( (GLubyte *) (A) + (uintptr_t) (B) )
  74
  75
  76 /**
  77  * Sometimes we treat GLfloats as GLints.  On x86 systems, moving a float
  78  * as a int (thereby using integer registers instead of FP registers) is
  79  * a performance win.  Typically, this can be done with ordinary casts.
  80  * But with gcc's -fstrict-aliasing flag (which defaults to on in gcc 3.0)
  81  * these casts generate warnings.
  82  * The following union typedef is used to solve that.
  83  */
  84 typedef union { GLfloat f; GLint i; } fi_type;
  85
  86
  87
  88 /**********************************************************************
  89  * Math macros
  90  */
  91
  92 #define MAX_GLUSHORT    0xffff
  93 #define MAX_GLUINT      0xffffffff
  94
  95 /* Degrees to radians conversion: */
  96 #define DEG2RAD (M_PI/180.0)
  97
  98
  99 /***
 100  *** SQRTF: single-precision square root
 101  ***/
 102 #if 0 /* _mesa_sqrtf() not accurate enough - temporarily disabled */
 103 #  define SQRTF(X)  _mesa_sqrtf(X)
 104 #else
 105 #  define SQRTF(X)  (float) sqrt((float) (X))
 106 #endif
 107
 108
 109 /***
 110  *** INV_SQRTF: single-precision inverse square root
 111  ***/
 112 #if 0
 113 #define INV_SQRTF(X) _mesa_inv_sqrt(X)
 114 #else
 115 #define INV_SQRTF(X) (1.0F / SQRTF(X))  /* this is faster on a P4 */
 116 #endif
 117
 118
 119 /**
 120  * \name Work-arounds for platforms that lack C99 math functions
 121  */
 122 /*@{*/
 123 #if (!defined(_XOPEN_SOURCE) || (_XOPEN_SOURCE < 600)) && !defined(_ISOC99_SOURCE) \
 124    && (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L)) \
 125    && (!defined(_MSC_VER) || (_MSC_VER < 1400))
 126 #define acosf(f) ((float) acos(f))
 127 #define asinf(f) ((float) asin(f))
 128 #define atan2f(x,y) ((float) atan2(x,y))
 129 #define atanf(f) ((float) atan(f))
 130 #define cielf(f) ((float) ciel(f))
 131 #define cosf(f) ((float) cos(f))
 132 #define coshf(f) ((float) cosh(f))
 133 #define expf(f) ((float) exp(f))
 134 #define exp2f(f) ((float) exp2(f))
 135 #define floorf(f) ((float) floor(f))
 136 #define logf(f) ((float) log(f))
 137 #define log2f(f) ((float) log2(f))
 138 #define powf(x,y) ((float) pow(x,y))
 139 #define sinf(f) ((float) sin(f))
 140 #define sinhf(f) ((float) sinh(f))
 141 #define sqrtf(f) ((float) sqrt(f))
 142 #define tanf(f) ((float) tan(f))
 143 #define tanhf(f) ((float) tanh(f))
 144 #endif
 145
 146 #if defined(_MSC_VER)
 147 static INLINE float truncf(float x) { return x < 0.0f ? ceilf(x) : floorf(x); }
 148 static INLINE float exp2f(float x) { return powf(2.0f, x); }
 149 static INLINE float log2f(float x) { return logf(x) * 1.442695041f; }
 150 static INLINE int isblank(int ch) { return ch == ' ' || ch == '\t'; }
 151 #endif
 152 /*@}*/
 153
 154 /***
 155  *** LOG2: Log base 2 of float
 156  ***/
 157 #ifdef USE_IEEE
 158 #if 0
 159 /* This is pretty fast, but not accurate enough (only 2 fractional bits).
 160  * Based on code from http://www.stereopsis.com/log2.html
 161  */
 162 static INLINE GLfloat LOG2(GLfloat x)
 163 {
 164    const GLfloat y = x * x * x * x;
 165    const GLuint ix = *((GLuint *) &y);
 166    const GLuint exp = (ix >> 23) & 0xFF;
 167    const GLint log2 = ((GLint) exp) - 127;
 168    return (GLfloat) log2 * (1.0 / 4.0);  /* 4, because of x^4 above */
 169 }
 170 #endif
 171 /* Pretty fast, and accurate.
 172  * Based on code from http://www.flipcode.com/totd/
 173  */
 174 static INLINE GLfloat LOG2(GLfloat val)
 175 {
 176    fi_type num;
 177    GLint log_2;
 178    num.f = val;
 179    log_2 = ((num.i >> 23) & 255) - 128;
 180    num.i &= ~(255 << 23);
 181    num.i += 127 << 23;
 182    num.f = ((-1.0f/3) * num.f + 2) * num.f - 2.0f/3;
 183    return num.f + log_2;
 184 }
 185 #else
 186 /*
 187  * NOTE: log_base_2(x) = log(x) / log(2)
 188  * NOTE: 1.442695 = 1/log(2).
 189  */
 190 #define LOG2(x)  ((GLfloat) (log(x) * 1.442695F))
 191 #endif
 192
 193
 194 /***
 195  *** IS_INF_OR_NAN: test if float is infinite or NaN
 196  ***/
 197 #ifdef USE_IEEE
 198 static INLINE int IS_INF_OR_NAN( float x )
 199 {
 200    fi_type tmp;
 201    tmp.f = x;
 202    return !(int)((unsigned int)((tmp.i & 0x7fffffff)-0x7f800000) >> 31);
 203 }
 204 #elif defined(isfinite)
 205 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 206 #elif defined(finite)
 207 #define IS_INF_OR_NAN(x)        (!finite(x))
 208 #elif defined(__VMS)
 209 #define IS_INF_OR_NAN(x)        (!finite(x))
 210 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
 211 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 212 #else
 213 #define IS_INF_OR_NAN(x)        (!finite(x))
 214 #endif
 215
 216
 217 /***
 218  *** IS_NEGATIVE: test if float is negative
 219  ***/
 220 #if defined(USE_IEEE)
 221 static INLINE int GET_FLOAT_BITS( float x )
 222 {
 223    fi_type fi;
 224    fi.f = x;
 225    return fi.i;
 226 }
 227 #define IS_NEGATIVE(x) (GET_FLOAT_BITS(x) < 0)
 228 #else
 229 #define IS_NEGATIVE(x) (x < 0.0F)
 230 #endif
 231
 232
 233 /***
 234  *** DIFFERENT_SIGNS: test if two floats have opposite signs
 235  ***/
 236 #if defined(USE_IEEE)
 237 #define DIFFERENT_SIGNS(x,y) ((GET_FLOAT_BITS(x) ^ GET_FLOAT_BITS(y)) & (1<<31))
 238 #else
 239 /* Could just use (x*y<0) except for the flatshading requirements.
 240  * Maybe there's a better way?
 241  */
 242 #define DIFFERENT_SIGNS(x,y) ((x) * (y) <= 0.0F && (x) - (y) != 0.0F)
 243 #endif
 244
 245
 246 /***
 247  *** CEILF: ceiling of float
 248  *** FLOORF: floor of float
 249  *** FABSF: absolute value of float
 250  *** LOGF: the natural logarithm (base e) of the value
 251  *** EXPF: raise e to the value
 252  *** LDEXPF: multiply value by an integral power of two
 253  *** FREXPF: extract mantissa and exponent from value
 254  ***/
 255 #if defined(__gnu_linux__)
 256 /* C99 functions */
 257 #define CEILF(x)   ceilf(x)
 258 #define FLOORF(x)  floorf(x)
 259 #define FABSF(x)   fabsf(x)
 260 #define LOGF(x)    logf(x)
 261 #define EXPF(x)    expf(x)
 262 #define LDEXPF(x,y)  ldexpf(x,y)
 263 #define FREXPF(x,y)  frexpf(x,y)
 264 #else
 265 #define CEILF(x)   ((GLfloat) ceil(x))
 266 #define FLOORF(x)  ((GLfloat) floor(x))
 267 #define FABSF(x)   ((GLfloat) fabs(x))
 268 #define LOGF(x)    ((GLfloat) log(x))
 269 #define EXPF(x)    ((GLfloat) exp(x))
 270 #define LDEXPF(x,y)  ((GLfloat) ldexp(x,y))
 271 #define FREXPF(x,y)  ((GLfloat) frexp(x,y))
 272 #endif
 273
 274
 275 /***
 276  *** IROUND: return (as an integer) float rounded to nearest integer
 277  ***/
 278 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 279 static INLINE int iround(float f)
 280 {
 281    int r;
 282    __asm__ ("fistpl %0" : "=m" (r) : "t" (f) : "st");
 283    return r;
 284 }
 285 #define IROUND(x)  iround(x)
 286 #elif defined(USE_X86_ASM) && defined(_MSC_VER)
 287 static INLINE int iround(float f)
 288 {
 289    int r;
 290    _asm {
 291          fld f
 292          fistp r
 293         }
 294    return r;
 295 }
 296 #define IROUND(x)  iround(x)
 297 #elif defined(__WATCOMC__) && defined(__386__)
 298 long iround(float f);
 299 #pragma aux iround =                    \
 300         "push   eax"                        \
 301         "fistp  dword ptr [esp]"            \
 302         "pop    eax"                        \
 303         parm [8087]                         \
 304         value [eax]                         \
 305         modify exact [eax];
 306 #define IROUND(x)  iround(x)
 307 #else
 308 #define IROUND(f)  ((int) (((f) >= 0.0F) ? ((f) + 0.5F) : ((f) - 0.5F)))
 309 #endif
 310
 311 #define IROUND64(f)  ((GLint64) (((f) >= 0.0F) ? ((f) + 0.5F) : ((f) - 0.5F)))
 312
 313 /***
 314  *** IROUND_POS: return (as an integer) positive float rounded to nearest int
 315  ***/
 316 #ifdef DEBUG
 317 #define IROUND_POS(f) (assert((f) >= 0.0F), IROUND(f))
 318 #else
 319 #define IROUND_POS(f) (IROUND(f))
 320 #endif
 321
 322
 323 /***
 324  *** IFLOOR: return (as an integer) floor of float
 325  ***/
 326 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 327 /*
 328  * IEEE floor for computers that round to nearest or even.
 329  * 'f' must be between -4194304 and 4194303.
 330  * This floor operation is done by "(iround(f + .5) + iround(f - .5)) >> 1",
 331  * but uses some IEEE specific tricks for better speed.
 332  * Contributed by Josh Vanderhoof
 333  */
 334 static INLINE int ifloor(float f)
 335 {
 336    int ai, bi;
 337    double af, bf;
 338    af = (3 << 22) + 0.5 + (double)f;
 339    bf = (3 << 22) + 0.5 - (double)f;
 340    /* GCC generates an extra fstp/fld without this. */
 341    __asm__ ("fstps %0" : "=m" (ai) : "t" (af) : "st");
 342    __asm__ ("fstps %0" : "=m" (bi) : "t" (bf) : "st");
 343    return (ai - bi) >> 1;
 344 }
 345 #define IFLOOR(x)  ifloor(x)
 346 #elif defined(USE_IEEE)
 347 static INLINE int ifloor(float f)
 348 {
 349    int ai, bi;
 350    double af, bf;
 351    fi_type u;
 352
 353    af = (3 << 22) + 0.5 + (double)f;
 354    bf = (3 << 22) + 0.5 - (double)f;
 355    u.f = (float) af;  ai = u.i;
 356    u.f = (float) bf;  bi = u.i;
 357    return (ai - bi) >> 1;
 358 }
 359 #define IFLOOR(x)  ifloor(x)
 360 #else
 361 static INLINE int ifloor(float f)
 362 {
 363    int i = IROUND(f);
 364    return (i > f) ? i - 1 : i;
 365 }
 366 #define IFLOOR(x)  ifloor(x)
 367 #endif
 368
 369
 370 /***
 371  *** ICEIL: return (as an integer) ceiling of float
 372  ***/
 373 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 374 /*
 375  * IEEE ceil for computers that round to nearest or even.
 376  * 'f' must be between -4194304 and 4194303.
 377  * This ceil operation is done by "(iround(f + .5) + iround(f - .5) + 1) >> 1",
 378  * but uses some IEEE specific tricks for better speed.
 379  * Contributed by Josh Vanderhoof
 380  */
 381 static INLINE int iceil(float f)
 382 {
 383    int ai, bi;
 384    double af, bf;
 385    af = (3 << 22) + 0.5 + (double)f;
 386    bf = (3 << 22) + 0.5 - (double)f;
 387    /* GCC generates an extra fstp/fld without this. */
 388    __asm__ ("fstps %0" : "=m" (ai) : "t" (af) : "st");
 389    __asm__ ("fstps %0" : "=m" (bi) : "t" (bf) : "st");
 390    return (ai - bi + 1) >> 1;
 391 }
 392 #define ICEIL(x)  iceil(x)
 393 #elif defined(USE_IEEE)
 394 static INLINE int iceil(float f)
 395 {
 396    int ai, bi;
 397    double af, bf;
 398    fi_type u;
 399    af = (3 << 22) + 0.5 + (double)f;
 400    bf = (3 << 22) + 0.5 - (double)f;
 401    u.f = (float) af; ai = u.i;
 402    u.f = (float) bf; bi = u.i;
 403    return (ai - bi + 1) >> 1;
 404 }
 405 #define ICEIL(x)  iceil(x)
 406 #else
 407 static INLINE int iceil(float f)
 408 {
 409    int i = IROUND(f);
 410    return (i < f) ? i + 1 : i;
 411 }
 412 #define ICEIL(x)  iceil(x)
 413 #endif
 414
 415
 416 /**
 417  * Is x a power of two?
 418  */
 419 static INLINE int
 420 _mesa_is_pow_two(int x)
 421 {
 422    return !(x & (x - 1));
 423 }
 424
 425 /**
 426  * Round given integer to next higer power of two
 427  * If X is zero result is undefined.
 428  *
 429  * Source for the fallback implementation is
 430  * Sean Eron Anderson's webpage "Bit Twiddling Hacks"
 431  * http://graphics.stanford.edu/~seander/bithacks.html
 432  *
 433  * When using builtin function have to do some work
 434  * for case when passed values 1 to prevent hiting
 435  * undefined result from __builtin_clz. Undefined
 436  * results would be different depending on optimization
 437  * level used for build.
 438  */
 439 static INLINE int32_t
 440 _mesa_next_pow_two_32(uint32_t x)
 441 {
 442 #if defined(__GNUC__) && \
 443         ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
 444         uint32_t y = (x != 1);
 445         return (1 + y) << ((__builtin_clz(x - y) ^ 31) );
 446 #else
 447         x--;
 448         x |= x >> 1;
 449         x |= x >> 2;
 450         x |= x >> 4;
 451         x |= x >> 8;
 452         x |= x >> 16;
 453         x++;
 454         return x;
 455 #endif
 456 }
 457
 458 static INLINE int64_t
 459 _mesa_next_pow_two_64(uint64_t x)
 460 {
 461 #if defined(__GNUC__) && \
 462         ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
 463         uint64_t y = (x != 1);
 464         if (sizeof(x) == sizeof(long))
 465                 return (1 + y) << ((__builtin_clzl(x - y) ^ 63));
 466         else
 467                 return (1 + y) << ((__builtin_clzll(x - y) ^ 63));
 468 #else
 469         x--;
 470         x |= x >> 1;
 471         x |= x >> 2;
 472         x |= x >> 4;
 473         x |= x >> 8;
 474         x |= x >> 16;
 475         x |= x >> 32;
 476         x++;
 477         return x;
 478 #endif
 479 }
 480
 481
 482 /**
 483  * Return 1 if this is a little endian machine, 0 if big endian.
 484  */
 485 static INLINE GLboolean
 486 _mesa_little_endian(void)
 487 {
 488    const GLuint ui = 1; /* intentionally not static */
 489    return *((const GLubyte *) &ui);
 490 }
 491
 492
 493
 494 /**********************************************************************
 495  * Functions
 496  */
 497
 498 extern void *
 499 _mesa_align_malloc( size_t bytes, unsigned long alignment );
 500
 501 extern void *
 502 _mesa_align_calloc( size_t bytes, unsigned long alignment );
 503
 504 extern void
 505 _mesa_align_free( void *ptr );
 506
 507 extern void *
 508 _mesa_align_realloc(void *oldBuffer, size_t oldSize, size_t newSize,
 509                     unsigned long alignment);
 510
 511 extern void *
 512 _mesa_exec_malloc( GLuint size );
 513
 514 extern void
 515 _mesa_exec_free( void *addr );
 516
 517 extern void *
 518 _mesa_realloc( void *oldBuffer, size_t oldSize, size_t newSize );
 519
 520 extern void
 521 _mesa_memset16( unsigned short *dst, unsigned short val, size_t n );
 522
 523 extern double
 524 _mesa_sqrtd(double x);
 525
 526 extern float
 527 _mesa_sqrtf(float x);
 528
 529 extern float
 530 _mesa_inv_sqrtf(float x);
 531
 532 extern void
 533 _mesa_init_sqrt_table(void);
 534
 535 extern int
 536 _mesa_ffs(int32_t i);
 537
 538 extern int
 539 _mesa_ffsll(int64_t i);
 540
 541 extern unsigned int
 542 _mesa_bitcount(unsigned int n);
 543
 544 extern GLhalfARB
 545 _mesa_float_to_half(float f);
 546
 547 extern float
 548 _mesa_half_to_float(GLhalfARB h);
 549
 550
 551 extern void *
 552 _mesa_bsearch( const void *key, const void *base, size_t nmemb, size_t size,
 553                int (*compar)(const void *, const void *) );
 554
 555 extern char *
 556 _mesa_getenv( const char *var );
 557
 558 extern char *
 559 _mesa_strdup( const char *s );
 560
 561 extern float
 562 _mesa_strtof( const char *s, char **end );
 563
 564 extern unsigned int
 565 _mesa_str_checksum(const char *str);
 566
 567 extern int
 568 _mesa_snprintf( char *str, size_t size, const char *fmt, ... );
 569
 570 extern void
 571 _mesa_warning( __GLcontext *gc, const char *fmtString, ... );
 572
 573 extern void
 574 _mesa_problem( const __GLcontext *ctx, const char *fmtString, ... );
 575
 576 extern void
 577 _mesa_error( __GLcontext *ctx, GLenum error, const char *fmtString, ... );
 578
 579 extern void
 580 _mesa_debug( const __GLcontext *ctx, const char *fmtString, ... );
 581
 582
 583 #if defined(_MSC_VER) && !defined(snprintf)
 584 #define snprintf _snprintf
 585 #endif
 586
 587
 588 #ifdef __cplusplus
 589 }
 590 #endif
 591
 592
 593 #endif /* IMPORTS_H */