src/mesa/main/imports.h

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