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 #include "errors.h"
  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  * \name Work-arounds for platforms that lack C99 math functions
 101  */
 102 /*@{*/
 103 #if (!defined(_XOPEN_SOURCE) || (_XOPEN_SOURCE < 600)) && !defined(_ISOC99_SOURCE) \
 104    && (!defined(__STDC_VERSION__) || (__STDC_VERSION__ < 199901L)) \
 105    && (!defined(_MSC_VER) || (_MSC_VER < 1400))
 106 #define acosf(f) ((float) acos(f))
 107 #define asinf(f) ((float) asin(f))
 108 #define atan2f(x,y) ((float) atan2(x,y))
 109 #define atanf(f) ((float) atan(f))
 110 #define ceilf(f) ((float) ceil(f))
 111 #define cosf(f) ((float) cos(f))
 112 #define coshf(f) ((float) cosh(f))
 113 #define expf(f) ((float) exp(f))
 114 #define exp2f(f) ((float) exp2(f))
 115 #define floorf(f) ((float) floor(f))
 116 #define logf(f) ((float) log(f))
 117
 118 #ifdef ANDROID
 119 #define log2f(f) (logf(f) * (float) (1.0 / M_LN2))
 120 #else
 121 #define log2f(f) ((float) log2(f))
 122 #endif
 123
 124 #define powf(x,y) ((float) pow(x,y))
 125 #define sinf(f) ((float) sin(f))
 126 #define sinhf(f) ((float) sinh(f))
 127 #define sqrtf(f) ((float) sqrt(f))
 128 #define tanf(f) ((float) tan(f))
 129 #define tanhf(f) ((float) tanh(f))
 130 #define acoshf(f) ((float) acosh(f))
 131 #define asinhf(f) ((float) asinh(f))
 132 #define atanhf(f) ((float) atanh(f))
 133 #endif
 134
 135 #if defined(_MSC_VER)
 136 static inline float truncf(float x) { return x < 0.0f ? ceilf(x) : floorf(x); }
 137 static inline float exp2f(float x) { return powf(2.0f, x); }
 138 static inline float log2f(float x) { return logf(x) * 1.442695041f; }
 139 static inline float asinhf(float x) { return logf(x + sqrtf(x * x + 1.0f)); }
 140 static inline float acoshf(float x) { return logf(x + sqrtf(x * x - 1.0f)); }
 141 static inline float atanhf(float x) { return (logf(1.0f + x) - logf(1.0f - x)) / 2.0f; }
 142 static inline int isblank(int ch) { return ch == ' ' || ch == '\t'; }
 143 #define strtoll(p, e, b) _strtoi64(p, e, b)
 144 #endif
 145 /*@}*/
 146
 147
 148 /*
 149  * signbit() is a macro on Linux.  Not available on Windows.
 150  */
 151 #ifndef signbit
 152 #define signbit(x) ((x) < 0.0f)
 153 #endif
 154
 155
 156 /** single-precision inverse square root */
 157 static inline float
 158 INV_SQRTF(float x)
 159 {
 160    /* XXX we could try Quake's fast inverse square root function here */
 161    return 1.0F / sqrtf(x);
 162 }
 163
 164
 165 /***
 166  *** LOG2: Log base 2 of float
 167  ***/
 168 static inline GLfloat LOG2(GLfloat x)
 169 {
 170 #ifdef USE_IEEE
 171 #if 0
 172    /* This is pretty fast, but not accurate enough (only 2 fractional bits).
 173     * Based on code from http://www.stereopsis.com/log2.html
 174     */
 175    const GLfloat y = x * x * x * x;
 176    const GLuint ix = *((GLuint *) &y);
 177    const GLuint exp = (ix >> 23) & 0xFF;
 178    const GLint log2 = ((GLint) exp) - 127;
 179    return (GLfloat) log2 * (1.0 / 4.0);  /* 4, because of x^4 above */
 180 #endif
 181    /* Pretty fast, and accurate.
 182     * Based on code from http://www.flipcode.com/totd/
 183     */
 184    fi_type num;
 185    GLint log_2;
 186    num.f = x;
 187    log_2 = ((num.i >> 23) & 255) - 128;
 188    num.i &= ~(255 << 23);
 189    num.i += 127 << 23;
 190    num.f = ((-1.0f/3) * num.f + 2) * num.f - 2.0f/3;
 191    return num.f + log_2;
 192 #else
 193    /*
 194     * NOTE: log_base_2(x) = log(x) / log(2)
 195     * NOTE: 1.442695 = 1/log(2).
 196     */
 197    return (GLfloat) (log(x) * 1.442695F);
 198 #endif
 199 }
 200
 201
 202
 203 /***
 204  *** IS_INF_OR_NAN: test if float is infinite or NaN
 205  ***/
 206 #ifdef USE_IEEE
 207 static inline int IS_INF_OR_NAN( float x )
 208 {
 209    fi_type tmp;
 210    tmp.f = x;
 211    return !(int)((unsigned int)((tmp.i & 0x7fffffff)-0x7f800000) >> 31);
 212 }
 213 #elif defined(isfinite)
 214 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 215 #elif defined(finite)
 216 #define IS_INF_OR_NAN(x)        (!finite(x))
 217 #elif defined(__VMS)
 218 #define IS_INF_OR_NAN(x)        (!finite(x))
 219 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
 220 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 221 #else
 222 #define IS_INF_OR_NAN(x)        (!finite(x))
 223 #endif
 224
 225
 226 /***
 227  *** CEILF: ceiling of float
 228  *** FLOORF: floor of float
 229  *** FABSF: absolute value of float
 230  *** LOGF: the natural logarithm (base e) of the value
 231  *** EXPF: raise e to the value
 232  *** LDEXPF: multiply value by an integral power of two
 233  *** FREXPF: extract mantissa and exponent from value
 234  ***/
 235 #if defined(__gnu_linux__)
 236 /* C99 functions */
 237 #define CEILF(x)   ceilf(x)
 238 #define FLOORF(x)  floorf(x)
 239 #define FABSF(x)   fabsf(x)
 240 #define LOGF(x)    logf(x)
 241 #define EXPF(x)    expf(x)
 242 #define LDEXPF(x,y)  ldexpf(x,y)
 243 #define FREXPF(x,y)  frexpf(x,y)
 244 #else
 245 #define CEILF(x)   ((GLfloat) ceil(x))
 246 #define FLOORF(x)  ((GLfloat) floor(x))
 247 #define FABSF(x)   ((GLfloat) fabs(x))
 248 #define LOGF(x)    ((GLfloat) log(x))
 249 #define EXPF(x)    ((GLfloat) exp(x))
 250 #define LDEXPF(x,y)  ((GLfloat) ldexp(x,y))
 251 #define FREXPF(x,y)  ((GLfloat) frexp(x,y))
 252 #endif
 253
 254
 255 /**
 256  * Convert float to int by rounding to nearest integer, away from zero.
 257  */
 258 static inline int IROUND(float f)
 259 {
 260    return (int) ((f >= 0.0F) ? (f + 0.5F) : (f - 0.5F));
 261 }
 262
 263
 264 /**
 265  * Convert float to int64 by rounding to nearest integer.
 266  */
 267 static inline GLint64 IROUND64(float f)
 268 {
 269    return (GLint64) ((f >= 0.0F) ? (f + 0.5F) : (f - 0.5F));
 270 }
 271
 272
 273 /**
 274  * Convert positive float to int by rounding to nearest integer.
 275  */
 276 static inline int IROUND_POS(float f)
 277 {
 278    assert(f >= 0.0F);
 279    return (int) (f + 0.5F);
 280 }
 281
 282
 283 /**
 284  * Convert float to int using a fast method.  The rounding mode may vary.
 285  * XXX We could use an x86-64/SSE2 version here.
 286  */
 287 static inline int F_TO_I(float f)
 288 {
 289 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 290    int r;
 291    __asm__ ("fistpl %0" : "=m" (r) : "t" (f) : "st");
 292    return r;
 293 #elif defined(USE_X86_ASM) && defined(_MSC_VER)
 294    int r;
 295    _asm {
 296          fld f
 297          fistp r
 298         }
 299    return r;
 300 #else
 301    return IROUND(f);
 302 #endif
 303 }
 304
 305
 306 /** Return (as an integer) floor of float */
 307 static inline int IFLOOR(float f)
 308 {
 309 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 310    /*
 311     * IEEE floor for computers that round to nearest or even.
 312     * 'f' must be between -4194304 and 4194303.
 313     * This floor operation is done by "(iround(f + .5) + iround(f - .5)) >> 1",
 314     * but uses some IEEE specific tricks for better speed.
 315     * Contributed by Josh Vanderhoof
 316     */
 317    int ai, bi;
 318    double af, bf;
 319    af = (3 << 22) + 0.5 + (double)f;
 320    bf = (3 << 22) + 0.5 - (double)f;
 321    /* GCC generates an extra fstp/fld without this. */
 322    __asm__ ("fstps %0" : "=m" (ai) : "t" (af) : "st");
 323    __asm__ ("fstps %0" : "=m" (bi) : "t" (bf) : "st");
 324    return (ai - bi) >> 1;
 325 #elif defined(USE_IEEE)
 326    int ai, bi;
 327    double af, bf;
 328    fi_type u;
 329    af = (3 << 22) + 0.5 + (double)f;
 330    bf = (3 << 22) + 0.5 - (double)f;
 331    u.f = (float) af;  ai = u.i;
 332    u.f = (float) bf;  bi = u.i;
 333    return (ai - bi) >> 1;
 334 #else
 335    int i = IROUND(f);
 336    return (i > f) ? i - 1 : i;
 337 #endif
 338 }
 339
 340
 341 /** Return (as an integer) ceiling of float */
 342 static inline int ICEIL(float f)
 343 {
 344 #if defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
 345    /*
 346     * IEEE ceil for computers that round to nearest or even.
 347     * 'f' must be between -4194304 and 4194303.
 348     * This ceil operation is done by "(iround(f + .5) + iround(f - .5) + 1) >> 1",
 349     * but uses some IEEE specific tricks for better speed.
 350     * Contributed by Josh Vanderhoof
 351     */
 352    int ai, bi;
 353    double af, bf;
 354    af = (3 << 22) + 0.5 + (double)f;
 355    bf = (3 << 22) + 0.5 - (double)f;
 356    /* GCC generates an extra fstp/fld without this. */
 357    __asm__ ("fstps %0" : "=m" (ai) : "t" (af) : "st");
 358    __asm__ ("fstps %0" : "=m" (bi) : "t" (bf) : "st");
 359    return (ai - bi + 1) >> 1;
 360 #elif defined(USE_IEEE)
 361    int ai, bi;
 362    double af, bf;
 363    fi_type u;
 364    af = (3 << 22) + 0.5 + (double)f;
 365    bf = (3 << 22) + 0.5 - (double)f;
 366    u.f = (float) af; ai = u.i;
 367    u.f = (float) bf; bi = u.i;
 368    return (ai - bi + 1) >> 1;
 369 #else
 370    int i = IROUND(f);
 371    return (i < f) ? i + 1 : i;
 372 #endif
 373 }
 374
 375
 376 /**
 377  * Is x a power of two?
 378  */
 379 static inline int
 380 _mesa_is_pow_two(int x)
 381 {
 382    return !(x & (x - 1));
 383 }
 384
 385 /**
 386  * Round given integer to next higer power of two
 387  * If X is zero result is undefined.
 388  *
 389  * Source for the fallback implementation is
 390  * Sean Eron Anderson's webpage "Bit Twiddling Hacks"
 391  * http://graphics.stanford.edu/~seander/bithacks.html
 392  *
 393  * When using builtin function have to do some work
 394  * for case when passed values 1 to prevent hiting
 395  * undefined result from __builtin_clz. Undefined
 396  * results would be different depending on optimization
 397  * level used for build.
 398  */
 399 static inline int32_t
 400 _mesa_next_pow_two_32(uint32_t x)
 401 {
 402 #if defined(__GNUC__) && \
 403         ((__GNUC__ * 100 + __GNUC_MINOR__) >= 304) /* gcc 3.4 or later */
 404         uint32_t y = (x != 1);
 405         return (1 + y) << ((__builtin_clz(x - y) ^ 31) );
 406 #else
 407         x--;
 408         x |= x >> 1;
 409         x |= x >> 2;
 410         x |= x >> 4;
 411         x |= x >> 8;
 412         x |= x >> 16;
 413         x++;
 414         return x;
 415 #endif
 416 }
 417
 418 static inline int64_t
 419 _mesa_next_pow_two_64(uint64_t x)
 420 {
 421 #if defined(__GNUC__) && \
 422         ((__GNUC__ * 100 + __GNUC_MINOR__) >= 304) /* gcc 3.4 or later */
 423         uint64_t y = (x != 1);
 424         if (sizeof(x) == sizeof(long))
 425                 return (1 + y) << ((__builtin_clzl(x - y) ^ 63));
 426         else
 427                 return (1 + y) << ((__builtin_clzll(x - y) ^ 63));
 428 #else
 429         x--;
 430         x |= x >> 1;
 431         x |= x >> 2;
 432         x |= x >> 4;
 433         x |= x >> 8;
 434         x |= x >> 16;
 435         x |= x >> 32;
 436         x++;
 437         return x;
 438 #endif
 439 }
 440
 441
 442 /*
 443  * Returns the floor form of binary logarithm for a 32-bit integer.
 444  */
 445 static inline GLuint
 446 _mesa_logbase2(GLuint n)
 447 {
 448 #if defined(__GNUC__) && \
 449    ((__GNUC__ * 100 + __GNUC_MINOR__) >= 304) /* gcc 3.4 or later */
 450    return (31 - __builtin_clz(n | 1));
 451 #else
 452    GLuint pos = 0;
 453    if (n >= 1<<16) { n >>= 16; pos += 16; }
 454    if (n >= 1<< 8) { n >>=  8; pos +=  8; }
 455    if (n >= 1<< 4) { n >>=  4; pos +=  4; }
 456    if (n >= 1<< 2) { n >>=  2; pos +=  2; }
 457    if (n >= 1<< 1) {           pos +=  1; }
 458    return pos;
 459 #endif
 460 }
 461
 462
 463 /**
 464  * Return 1 if this is a little endian machine, 0 if big endian.
 465  */
 466 static inline GLboolean
 467 _mesa_little_endian(void)
 468 {
 469    const GLuint ui = 1; /* intentionally not static */
 470    return *((const GLubyte *) &ui);
 471 }
 472
 473
 474
 475 /**********************************************************************
 476  * Functions
 477  */
 478
 479 extern void *
 480 _mesa_align_malloc( size_t bytes, unsigned long alignment );
 481
 482 extern void *
 483 _mesa_align_calloc( size_t bytes, unsigned long alignment );
 484
 485 extern void
 486 _mesa_align_free( void *ptr );
 487
 488 extern void *
 489 _mesa_align_realloc(void *oldBuffer, size_t oldSize, size_t newSize,
 490                     unsigned long alignment);
 491
 492 extern void *
 493 _mesa_exec_malloc( GLuint size );
 494
 495 extern void
 496 _mesa_exec_free( void *addr );
 497
 498 extern void *
 499 _mesa_realloc( void *oldBuffer, size_t oldSize, size_t newSize );
 500
 501
 502 #ifndef FFS_DEFINED
 503 #define FFS_DEFINED 1
 504 #ifdef __GNUC__
 505
 506 #if defined(__MINGW32__) || defined(__CYGWIN__) || defined(ANDROID) || defined(__APPLE__)
 507 #define ffs __builtin_ffs
 508 #define ffsll __builtin_ffsll
 509 #endif
 510
 511 #else
 512
 513 extern int ffs(int i);
 514 extern int ffsll(long long int i);
 515
 516 #endif /*__ GNUC__ */
 517 #endif /* FFS_DEFINED */
 518
 519
 520 #if defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 304) /* gcc 3.4 or later */
 521 #define _mesa_bitcount(i) __builtin_popcount(i)
 522 #define _mesa_bitcount_64(i) __builtin_popcountll(i)
 523 #else
 524 extern unsigned int
 525 _mesa_bitcount(unsigned int n);
 526 extern unsigned int
 527 _mesa_bitcount_64(uint64_t n);
 528 #endif
 529
 530 /**
 531  * Find the last (most significant) bit set in a word.
 532  *
 533  * Essentially ffs() in the reverse direction.
 534  */
 535 static inline unsigned int
 536 _mesa_fls(unsigned int n)
 537 {
 538 #if defined(__GNUC__) && ((__GNUC__ * 100 + __GNUC_MINOR__) >= 304)
 539    return n == 0 ? 0 : 32 - __builtin_clz(n);
 540 #else
 541    unsigned int v = 1;
 542
 543    if (n == 0)
 544       return 0;
 545
 546    while (n >>= 1)
 547        v++;
 548
 549    return v;
 550 #endif
 551 }
 552
 553 extern GLhalfARB
 554 _mesa_float_to_half(float f);
 555
 556 extern float
 557 _mesa_half_to_float(GLhalfARB h);
 558
 559
 560 extern void *
 561 _mesa_bsearch( const void *key, const void *base, size_t nmemb, size_t size,
 562                int (*compar)(const void *, const void *) );
 563
 564 extern char *
 565 _mesa_getenv( const char *var );
 566
 567 extern char *
 568 _mesa_strdup( const char *s );
 569
 570 extern float
 571 _mesa_strtof( const char *s, char **end );
 572
 573 extern unsigned int
 574 _mesa_str_checksum(const char *str);
 575
 576 extern int
 577 _mesa_snprintf( char *str, size_t size, const char *fmt, ... ) PRINTFLIKE(3, 4);
 578
 579 extern int
 580 _mesa_vsnprintf(char *str, size_t size, const char *fmt, va_list arg);
 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 */