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 #define strtoll(p, e, b) _strtoi64(p, e, b)
 152 #endif
 153 /*@}*/
 154
 155 /***
 156  *** LOG2: Log base 2 of float
 157  ***/
 158 #ifdef USE_IEEE
 159 #if 0
 160 /* This is pretty fast, but not accurate enough (only 2 fractional bits).
 161  * Based on code from http://www.stereopsis.com/log2.html
 162  */
 163 static INLINE GLfloat LOG2(GLfloat x)
 164 {
 165    const GLfloat y = x * x * x * x;
 166    const GLuint ix = *((GLuint *) &y);
 167    const GLuint exp = (ix >> 23) & 0xFF;
 168    const GLint log2 = ((GLint) exp) - 127;
 169    return (GLfloat) log2 * (1.0 / 4.0);  /* 4, because of x^4 above */
 170 }
 171 #endif
 172 /* Pretty fast, and accurate.
 173  * Based on code from http://www.flipcode.com/totd/
 174  */
 175 static INLINE GLfloat LOG2(GLfloat val)
 176 {
 177    fi_type num;
 178    GLint log_2;
 179    num.f = val;
 180    log_2 = ((num.i >> 23) & 255) - 128;
 181    num.i &= ~(255 << 23);
 182    num.i += 127 << 23;
 183    num.f = ((-1.0f/3) * num.f + 2) * num.f - 2.0f/3;
 184    return num.f + log_2;
 185 }
 186 #else
 187 /*
 188  * NOTE: log_base_2(x) = log(x) / log(2)
 189  * NOTE: 1.442695 = 1/log(2).
 190  */
 191 #define LOG2(x)  ((GLfloat) (log(x) * 1.442695F))
 192 #endif
 193
 194
 195 /***
 196  *** IS_INF_OR_NAN: test if float is infinite or NaN
 197  ***/
 198 #ifdef USE_IEEE
 199 static INLINE int IS_INF_OR_NAN( float x )
 200 {
 201    fi_type tmp;
 202    tmp.f = x;
 203    return !(int)((unsigned int)((tmp.i & 0x7fffffff)-0x7f800000) >> 31);
 204 }
 205 #elif defined(isfinite)
 206 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 207 #elif defined(finite)
 208 #define IS_INF_OR_NAN(x)        (!finite(x))
 209 #elif defined(__VMS)
 210 #define IS_INF_OR_NAN(x)        (!finite(x))
 211 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
 212 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 213 #else
 214 #define IS_INF_OR_NAN(x)        (!finite(x))
 215 #endif
 216
 217
 218 /***
 219  *** IS_NEGATIVE: test if float is negative
 220  ***/
 221 #if defined(USE_IEEE)
 222 static INLINE int GET_FLOAT_BITS( float x )
 223 {
 224    fi_type fi;
 225    fi.f = x;
 226    return fi.i;
 227 }
 228 #define IS_NEGATIVE(x) (GET_FLOAT_BITS(x) < 0)
 229 #else
 230 #define IS_NEGATIVE(x) (x < 0.0F)
 231 #endif
 232
 233
 234 /***
 235  *** DIFFERENT_SIGNS: test if two floats have opposite signs
 236  ***/
 237 #if defined(USE_IEEE)
 238 #define DIFFERENT_SIGNS(x,y) ((GET_FLOAT_BITS(x) ^ GET_FLOAT_BITS(y)) & (1<<31))
 239 #else
 240 /* Could just use (x*y<0) except for the flatshading requirements.
 241  * Maybe there's a better way?
 242  */
 243 #define DIFFERENT_SIGNS(x,y) ((x) * (y) <= 0.0F && (x) - (y) != 0.0F)
 244 #endif
 245
 246
 247 /***
 248  *** CEILF: ceiling of float
 249  *** FLOORF: floor of float
 250  *** FABSF: absolute value of float
 251  *** LOGF: the natural logarithm (base e) of the value
 252  *** EXPF: raise e to the value
 253  *** LDEXPF: multiply value by an integral power of two
 254  *** FREXPF: extract mantissa and exponent from value
 255  ***/
 256 #if defined(__gnu_linux__)
 257 /* C99 functions */
 258 #define CEILF(x)   ceilf(x)
 259 #define FLOORF(x)  floorf(x)
 260 #define FABSF(x)   fabsf(x)
 261 #define LOGF(x)    logf(x)
 262 #define EXPF(x)    expf(x)
 263 #define LDEXPF(x,y)  ldexpf(x,y)
 264 #define FREXPF(x,y)  frexpf(x,y)
 265 #else
 266 #define CEILF(x)   ((GLfloat) ceil(x))
 267 #define FLOORF(x)  ((GLfloat) floor(x))
 268 #define FABSF(x)   ((GLfloat) fabs(x))
 269 #define LOGF(x)    ((GLfloat) log(x))
 270 #define EXPF(x)    ((GLfloat) exp(x))
 271 #define LDEXPF(x,y)  ((GLfloat) ldexp(x,y))
 272 #define FREXPF(x,y)  ((GLfloat) frexp(x,y))
 273 #endif
 274
 275
 276 /***
 277  *** IROUND: return (as an integer) float rounded to nearest integer
 278  ***/
 279 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 280 static INLINE int iround(float f)
 281 {
 282    int r;
 283    __asm__ ("fistpl %0" : "=m" (r) : "t" (f) : "st");
 284    return r;
 285 }
 286 #define IROUND(x)  iround(x)
 287 #elif defined(USE_X86_ASM) && defined(_MSC_VER)
 288 static INLINE int iround(float f)
 289 {
 290    int r;
 291    _asm {
 292          fld f
 293          fistp r
 294         }
 295    return r;
 296 }
 297 #define IROUND(x)  iround(x)
 298 #elif defined(__WATCOMC__) && defined(__386__)
 299 long iround(float f);
 300 #pragma aux iround =                    \
 301         "push   eax"                        \
 302         "fistp  dword ptr [esp]"            \
 303         "pop    eax"                        \
 304         parm [8087]                         \
 305         value [eax]                         \
 306         modify exact [eax];
 307 #define IROUND(x)  iround(x)
 308 #else
 309 #define IROUND(f)  ((int) (((f) >= 0.0F) ? ((f) + 0.5F) : ((f) - 0.5F)))
 310 #endif
 311
 312 #define IROUND64(f)  ((GLint64) (((f) >= 0.0F) ? ((f) + 0.5F) : ((f) - 0.5F)))
 313
 314 /***
 315  *** IROUND_POS: return (as an integer) positive float rounded to nearest int
 316  ***/
 317 #ifdef DEBUG
 318 #define IROUND_POS(f) (assert((f) >= 0.0F), IROUND(f))
 319 #else
 320 #define IROUND_POS(f) (IROUND(f))
 321 #endif
 322
 323
 324 /***
 325  *** IFLOOR: return (as an integer) floor of float
 326  ***/
 327 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 328 /*
 329  * IEEE floor for computers that round to nearest or even.
 330  * 'f' must be between -4194304 and 4194303.
 331  * This floor operation is done by "(iround(f + .5) + iround(f - .5)) >> 1",
 332  * but uses some IEEE specific tricks for better speed.
 333  * Contributed by Josh Vanderhoof
 334  */
 335 static INLINE int ifloor(float f)
 336 {
 337    int ai, bi;
 338    double af, bf;
 339    af = (3 << 22) + 0.5 + (double)f;
 340    bf = (3 << 22) + 0.5 - (double)f;
 341    /* GCC generates an extra fstp/fld without this. */
 342    __asm__ ("fstps %0" : "=m" (ai) : "t" (af) : "st");
 343    __asm__ ("fstps %0" : "=m" (bi) : "t" (bf) : "st");
 344    return (ai - bi) >> 1;
 345 }
 346 #define IFLOOR(x)  ifloor(x)
 347 #elif defined(USE_IEEE)
 348 static INLINE int ifloor(float f)
 349 {
 350    int ai, bi;
 351    double af, bf;
 352    fi_type u;
 353
 354    af = (3 << 22) + 0.5 + (double)f;
 355    bf = (3 << 22) + 0.5 - (double)f;
 356    u.f = (float) af;  ai = u.i;
 357    u.f = (float) bf;  bi = u.i;
 358    return (ai - bi) >> 1;
 359 }
 360 #define IFLOOR(x)  ifloor(x)
 361 #else
 362 static INLINE int ifloor(float f)
 363 {
 364    int i = IROUND(f);
 365    return (i > f) ? i - 1 : i;
 366 }
 367 #define IFLOOR(x)  ifloor(x)
 368 #endif
 369
 370
 371 /***
 372  *** ICEIL: return (as an integer) ceiling of float
 373  ***/
 374 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 375 /*
 376  * IEEE ceil for computers that round to nearest or even.
 377  * 'f' must be between -4194304 and 4194303.
 378  * This ceil operation is done by "(iround(f + .5) + iround(f - .5) + 1) >> 1",
 379  * but uses some IEEE specific tricks for better speed.
 380  * Contributed by Josh Vanderhoof
 381  */
 382 static INLINE int iceil(float f)
 383 {
 384    int ai, bi;
 385    double af, bf;
 386    af = (3 << 22) + 0.5 + (double)f;
 387    bf = (3 << 22) + 0.5 - (double)f;
 388    /* GCC generates an extra fstp/fld without this. */
 389    __asm__ ("fstps %0" : "=m" (ai) : "t" (af) : "st");
 390    __asm__ ("fstps %0" : "=m" (bi) : "t" (bf) : "st");
 391    return (ai - bi + 1) >> 1;
 392 }
 393 #define ICEIL(x)  iceil(x)
 394 #elif defined(USE_IEEE)
 395 static INLINE int iceil(float f)
 396 {
 397    int ai, bi;
 398    double af, bf;
 399    fi_type u;
 400    af = (3 << 22) + 0.5 + (double)f;
 401    bf = (3 << 22) + 0.5 - (double)f;
 402    u.f = (float) af; ai = u.i;
 403    u.f = (float) bf; bi = u.i;
 404    return (ai - bi + 1) >> 1;
 405 }
 406 #define ICEIL(x)  iceil(x)
 407 #else
 408 static INLINE int iceil(float f)
 409 {
 410    int i = IROUND(f);
 411    return (i < f) ? i + 1 : i;
 412 }
 413 #define ICEIL(x)  iceil(x)
 414 #endif
 415
 416
 417 /**
 418  * Is x a power of two?
 419  */
 420 static INLINE int
 421 _mesa_is_pow_two(int x)
 422 {
 423    return !(x & (x - 1));
 424 }
 425
 426 /**
 427  * Round given integer to next higer power of two
 428  * If X is zero result is undefined.
 429  *
 430  * Source for the fallback implementation is
 431  * Sean Eron Anderson's webpage "Bit Twiddling Hacks"
 432  * http://graphics.stanford.edu/~seander/bithacks.html
 433  *
 434  * When using builtin function have to do some work
 435  * for case when passed values 1 to prevent hiting
 436  * undefined result from __builtin_clz. Undefined
 437  * results would be different depending on optimization
 438  * level used for build.
 439  */
 440 static INLINE int32_t
 441 _mesa_next_pow_two_32(uint32_t x)
 442 {
 443 #if defined(__GNUC__) && \
 444         ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
 445         uint32_t y = (x != 1);
 446         return (1 + y) << ((__builtin_clz(x - y) ^ 31) );
 447 #else
 448         x--;
 449         x |= x >> 1;
 450         x |= x >> 2;
 451         x |= x >> 4;
 452         x |= x >> 8;
 453         x |= x >> 16;
 454         x++;
 455         return x;
 456 #endif
 457 }
 458
 459 static INLINE int64_t
 460 _mesa_next_pow_two_64(uint64_t x)
 461 {
 462 #if defined(__GNUC__) && \
 463         ((__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
 464         uint64_t y = (x != 1);
 465         if (sizeof(x) == sizeof(long))
 466                 return (1 + y) << ((__builtin_clzl(x - y) ^ 63));
 467         else
 468                 return (1 + y) << ((__builtin_clzll(x - y) ^ 63));
 469 #else
 470         x--;
 471         x |= x >> 1;
 472         x |= x >> 2;
 473         x |= x >> 4;
 474         x |= x >> 8;
 475         x |= x >> 16;
 476         x |= x >> 32;
 477         x++;
 478         return x;
 479 #endif
 480 }
 481
 482
 483 /**
 484  * Return 1 if this is a little endian machine, 0 if big endian.
 485  */
 486 static INLINE GLboolean
 487 _mesa_little_endian(void)
 488 {
 489    const GLuint ui = 1; /* intentionally not static */
 490    return *((const GLubyte *) &ui);
 491 }
 492
 493
 494
 495 /**********************************************************************
 496  * Functions
 497  */
 498
 499 extern void *
 500 _mesa_align_malloc( size_t bytes, unsigned long alignment );
 501
 502 extern void *
 503 _mesa_align_calloc( size_t bytes, unsigned long alignment );
 504
 505 extern void
 506 _mesa_align_free( void *ptr );
 507
 508 extern void *
 509 _mesa_align_realloc(void *oldBuffer, size_t oldSize, size_t newSize,
 510                     unsigned long alignment);
 511
 512 extern void *
 513 _mesa_exec_malloc( GLuint size );
 514
 515 extern void
 516 _mesa_exec_free( void *addr );
 517
 518 extern void *
 519 _mesa_realloc( void *oldBuffer, size_t oldSize, size_t newSize );
 520
 521 extern void
 522 _mesa_memset16( unsigned short *dst, unsigned short val, size_t n );
 523
 524 extern double
 525 _mesa_sqrtd(double x);
 526
 527 extern float
 528 _mesa_sqrtf(float x);
 529
 530 extern float
 531 _mesa_inv_sqrtf(float x);
 532
 533 extern void
 534 _mesa_init_sqrt_table(void);
 535
 536 extern int
 537 _mesa_ffs(int32_t i);
 538
 539 extern int
 540 _mesa_ffsll(int64_t i);
 541
 542 extern unsigned int
 543 _mesa_bitcount(unsigned int n);
 544
 545 extern GLhalfARB
 546 _mesa_float_to_half(float f);
 547
 548 extern float
 549 _mesa_half_to_float(GLhalfARB h);
 550
 551
 552 extern void *
 553 _mesa_bsearch( const void *key, const void *base, size_t nmemb, size_t size,
 554                int (*compar)(const void *, const void *) );
 555
 556 extern char *
 557 _mesa_getenv( const char *var );
 558
 559 extern char *
 560 _mesa_strdup( const char *s );
 561
 562 extern float
 563 _mesa_strtof( const char *s, char **end );
 564
 565 extern unsigned int
 566 _mesa_str_checksum(const char *str);
 567
 568 extern int
 569 _mesa_snprintf( char *str, size_t size, const char *fmt, ... ) PRINTFLIKE(3, 4);
 570
 571 struct __GLcontextRec;
 572
 573 extern void
 574 _mesa_warning( struct __GLcontextRec *gc, const char *fmtString, ... ) PRINTFLIKE(2, 3);
 575
 576 extern void
 577 _mesa_problem( const struct __GLcontextRec *ctx, const char *fmtString, ... ) PRINTFLIKE(2, 3);
 578
 579 extern void
 580 _mesa_error( struct __GLcontextRec *ctx, GLenum error, const char *fmtString, ... ) PRINTFLIKE(3, 4);
 581
 582 extern void
 583 _mesa_debug( const struct __GLcontextRec *ctx, const char *fmtString, ... ) PRINTFLIKE(2, 3);
 584
 585
 586 #if defined(_MSC_VER) && !defined(snprintf)
 587 #define snprintf _snprintf
 588 #endif
 589
 590
 591 #ifdef __cplusplus
 592 }
 593 #endif
 594
 595
 596 #endif /* IMPORTS_H */