src/mesa/main/imports.c

   1 /**
   2  * \file imports.c
   3  * Standard C library function wrappers.
   4  *
   5  * Imports are services which the device driver or window system or
   6  * operating system provides to the core renderer.  The core renderer (Mesa)
   7  * will call these functions in order to do memory allocation, simple I/O,
   8  * etc.
   9  *
  10  * Some drivers will want to override/replace this file with something
  11  * specialized, but that'll be rare.
  12  *
  13  * Eventually, I want to move roll the glheader.h file into this.
  14  *
  15  * \todo Functions still needed:
  16  * - scanf
  17  * - qsort
  18  * - rand and RAND_MAX
  19  */
  20
  21 /*
  22  * Mesa 3-D graphics library
  23  *
  24  * Copyright (C) 1999-2007  Brian Paul   All Rights Reserved.
  25  *
  26  * Permission is hereby granted, free of charge, to any person obtaining a
  27  * copy of this software and associated documentation files (the "Software"),
  28  * to deal in the Software without restriction, including without limitation
  29  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  30  * and/or sell copies of the Software, and to permit persons to whom the
  31  * Software is furnished to do so, subject to the following conditions:
  32  *
  33  * The above copyright notice and this permission notice shall be included
  34  * in all copies or substantial portions of the Software.
  35  *
  36  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  37  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  38  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  39  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  40  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  41  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  42  * OTHER DEALINGS IN THE SOFTWARE.
  43  */
  44
  45
  46
  47 #include "imports.h"
  48 #include "context.h"
  49 #include "mtypes.h"
  50 #include "version.h"
  51
  52 #ifdef _GNU_SOURCE
  53 #include <locale.h>
  54 #ifdef __APPLE__
  55 #include <xlocale.h>
  56 #endif
  57 #endif
  58
  59
  60 #ifdef _WIN32
  61 #define vsnprintf _vsnprintf
  62 #elif defined(__IBMC__) || defined(__IBMCPP__)
  63 extern int vsnprintf(char *str, size_t count, const char *fmt, va_list arg);
  64 #endif
  65
  66 /**********************************************************************/
  67 /** \name Memory */
  68 /*@{*/
  69
  70 /**
  71  * Allocate aligned memory.
  72  *
  73  * \param bytes number of bytes to allocate.
  74  * \param alignment alignment (must be greater than zero).
  75  *
  76  * Allocates extra memory to accommodate rounding up the address for
  77  * alignment and to record the real malloc address.
  78  *
  79  * \sa _mesa_align_free().
  80  */
  81 void *
  82 _mesa_align_malloc(size_t bytes, unsigned long alignment)
  83 {
  84 #if defined(HAVE_POSIX_MEMALIGN)
  85    void *mem;
  86    int err = posix_memalign(& mem, alignment, bytes);
  87    if (err)
  88       return NULL;
  89    return mem;
  90 #elif defined(_WIN32) && defined(_MSC_VER)
  91    return _aligned_malloc(bytes, alignment);
  92 #else
  93    uintptr_t ptr, buf;
  94
  95    ASSERT( alignment > 0 );
  96
  97    ptr = (uintptr_t)malloc(bytes + alignment + sizeof(void *));
  98    if (!ptr)
  99       return NULL;
 100
 101    buf = (ptr + alignment + sizeof(void *)) & ~(uintptr_t)(alignment - 1);
 102    *(uintptr_t *)(buf - sizeof(void *)) = ptr;
 103
 104 #ifdef DEBUG
 105    /* mark the non-aligned area */
 106    while ( ptr < buf - sizeof(void *) ) {
 107       *(unsigned long *)ptr = 0xcdcdcdcd;
 108       ptr += sizeof(unsigned long);
 109    }
 110 #endif
 111
 112    return (void *) buf;
 113 #endif /* defined(HAVE_POSIX_MEMALIGN) */
 114 }
 115
 116 /**
 117  * Same as _mesa_align_malloc(), but using calloc(1, ) instead of
 118  * malloc()
 119  */
 120 void *
 121 _mesa_align_calloc(size_t bytes, unsigned long alignment)
 122 {
 123 #if defined(HAVE_POSIX_MEMALIGN)
 124    void *mem;
 125
 126    mem = _mesa_align_malloc(bytes, alignment);
 127    if (mem != NULL) {
 128       (void) memset(mem, 0, bytes);
 129    }
 130
 131    return mem;
 132 #elif defined(_WIN32) && defined(_MSC_VER)
 133    void *mem;
 134
 135    mem = _aligned_malloc(bytes, alignment);
 136    if (mem != NULL) {
 137       (void) memset(mem, 0, bytes);
 138    }
 139
 140    return mem;
 141 #else
 142    uintptr_t ptr, buf;
 143
 144    ASSERT( alignment > 0 );
 145
 146    ptr = (uintptr_t)calloc(1, bytes + alignment + sizeof(void *));
 147    if (!ptr)
 148       return NULL;
 149
 150    buf = (ptr + alignment + sizeof(void *)) & ~(uintptr_t)(alignment - 1);
 151    *(uintptr_t *)(buf - sizeof(void *)) = ptr;
 152
 153 #ifdef DEBUG
 154    /* mark the non-aligned area */
 155    while ( ptr < buf - sizeof(void *) ) {
 156       *(unsigned long *)ptr = 0xcdcdcdcd;
 157       ptr += sizeof(unsigned long);
 158    }
 159 #endif
 160
 161    return (void *)buf;
 162 #endif /* defined(HAVE_POSIX_MEMALIGN) */
 163 }
 164
 165 /**
 166  * Free memory which was allocated with either _mesa_align_malloc()
 167  * or _mesa_align_calloc().
 168  * \param ptr pointer to the memory to be freed.
 169  * The actual address to free is stored in the word immediately before the
 170  * address the client sees.
 171  * Note that it is legal to pass NULL pointer to this function and will be
 172  * handled accordingly.
 173  */
 174 void
 175 _mesa_align_free(void *ptr)
 176 {
 177 #if defined(HAVE_POSIX_MEMALIGN)
 178    free(ptr);
 179 #elif defined(_WIN32) && defined(_MSC_VER)
 180    _aligned_free(ptr);
 181 #else
 182    if (ptr) {
 183       void **cubbyHole = (void **) ((char *) ptr - sizeof(void *));
 184       void *realAddr = *cubbyHole;
 185       free(realAddr);
 186    }
 187 #endif /* defined(HAVE_POSIX_MEMALIGN) */
 188 }
 189
 190 /**
 191  * Reallocate memory, with alignment.
 192  */
 193 void *
 194 _mesa_align_realloc(void *oldBuffer, size_t oldSize, size_t newSize,
 195                     unsigned long alignment)
 196 {
 197 #if defined(_WIN32) && defined(_MSC_VER)
 198    (void) oldSize;
 199    return _aligned_realloc(oldBuffer, newSize, alignment);
 200 #else
 201    const size_t copySize = (oldSize < newSize) ? oldSize : newSize;
 202    void *newBuf = _mesa_align_malloc(newSize, alignment);
 203    if (newBuf && oldBuffer && copySize > 0) {
 204       memcpy(newBuf, oldBuffer, copySize);
 205    }
 206
 207    _mesa_align_free(oldBuffer);
 208    return newBuf;
 209 #endif
 210 }
 211
 212 /*@}*/
 213
 214
 215 /**********************************************************************/
 216 /** \name Math */
 217 /*@{*/
 218
 219
 220 #ifndef __GNUC__
 221 /**
 222  * Find the first bit set in a word.
 223  */
 224 int
 225 ffs(int i)
 226 {
 227    register int bit = 0;
 228    if (i != 0) {
 229       if ((i & 0xffff) == 0) {
 230          bit += 16;
 231          i >>= 16;
 232       }
 233       if ((i & 0xff) == 0) {
 234          bit += 8;
 235          i >>= 8;
 236       }
 237       if ((i & 0xf) == 0) {
 238          bit += 4;
 239          i >>= 4;
 240       }
 241       while ((i & 1) == 0) {
 242          bit++;
 243          i >>= 1;
 244       }
 245       bit++;
 246    }
 247    return bit;
 248 }
 249
 250
 251 /**
 252  * Find position of first bit set in given value.
 253  * XXX Warning: this function can only be used on 64-bit systems!
 254  * \return  position of least-significant bit set, starting at 1, return zero
 255  *          if no bits set.
 256  */
 257 int
 258 ffsll(long long int val)
 259 {
 260    int bit;
 261
 262    assert(sizeof(val) == 8);
 263
 264    bit = ffs((int) val);
 265    if (bit != 0)
 266       return bit;
 267
 268    bit = ffs((int) (val >> 32));
 269    if (bit != 0)
 270       return 32 + bit;
 271
 272    return 0;
 273 }
 274 #endif /* __GNUC__ */
 275
 276
 277 #if !defined(__GNUC__) ||\
 278    ((__GNUC__ * 100 + __GNUC_MINOR__) < 304) /* Not gcc 3.4 or later */
 279 /**
 280  * Return number of bits set in given GLuint.
 281  */
 282 unsigned int
 283 _mesa_bitcount(unsigned int n)
 284 {
 285    unsigned int bits;
 286    for (bits = 0; n > 0; n = n >> 1) {
 287       bits += (n & 1);
 288    }
 289    return bits;
 290 }
 291
 292 /**
 293  * Return number of bits set in given 64-bit uint.
 294  */
 295 unsigned int
 296 _mesa_bitcount_64(uint64_t n)
 297 {
 298    unsigned int bits;
 299    for (bits = 0; n > 0; n = n >> 1) {
 300       bits += (n & 1);
 301    }
 302    return bits;
 303 }
 304 #endif
 305
 306
 307 /* Using C99 rounding functions for roundToEven() implementation is
 308  * difficult, because round(), rint, and nearbyint() are affected by
 309  * fesetenv(), which the application may have done for its own
 310  * purposes.  Mesa's IROUND macro is close to what we want, but it
 311  * rounds away from 0 on n + 0.5.
 312  */
 313 int
 314 _mesa_round_to_even(float val)
 315 {
 316    int rounded = IROUND(val);
 317
 318    if (val - floor(val) == 0.5) {
 319       if (rounded % 2 != 0)
 320          rounded += val > 0 ? -1 : 1;
 321    }
 322
 323    return rounded;
 324 }
 325
 326
 327 /**
 328  * Convert a 4-byte float to a 2-byte half float.
 329  *
 330  * Not all float32 values can be represented exactly as a float16 value. We
 331  * round such intermediate float32 values to the nearest float16. When the
 332  * float32 lies exactly between to float16 values, we round to the one with
 333  * an even mantissa.
 334  *
 335  * This rounding behavior has several benefits:
 336  *   - It has no sign bias.
 337  *
 338  *   - It reproduces the behavior of real hardware: opcode F32TO16 in Intel's
 339  *     GPU ISA.
 340  *
 341  *   - By reproducing the behavior of the GPU (at least on Intel hardware),
 342  *     compile-time evaluation of constant packHalf2x16 GLSL expressions will
 343  *     result in the same value as if the expression were executed on the GPU.
 344  */
 345 GLhalfARB
 346 _mesa_float_to_half(float val)
 347 {
 348    const fi_type fi = {val};
 349    const int flt_m = fi.i & 0x7fffff;
 350    const int flt_e = (fi.i >> 23) & 0xff;
 351    const int flt_s = (fi.i >> 31) & 0x1;
 352    int s, e, m = 0;
 353    GLhalfARB result;
 354
 355    /* sign bit */
 356    s = flt_s;
 357
 358    /* handle special cases */
 359    if ((flt_e == 0) && (flt_m == 0)) {
 360       /* zero */
 361       /* m = 0; - already set */
 362       e = 0;
 363    }
 364    else if ((flt_e == 0) && (flt_m != 0)) {
 365       /* denorm -- denorm float maps to 0 half */
 366       /* m = 0; - already set */
 367       e = 0;
 368    }
 369    else if ((flt_e == 0xff) && (flt_m == 0)) {
 370       /* infinity */
 371       /* m = 0; - already set */
 372       e = 31;
 373    }
 374    else if ((flt_e == 0xff) && (flt_m != 0)) {
 375       /* NaN */
 376       m = 1;
 377       e = 31;
 378    }
 379    else {
 380       /* regular number */
 381       const int new_exp = flt_e - 127;
 382       if (new_exp < -14) {
 383          /* The float32 lies in the range (0.0, min_normal16) and is rounded
 384           * to a nearby float16 value. The result will be either zero, subnormal,
 385           * or normal.
 386           */
 387          e = 0;
 388          m = _mesa_round_to_even((1 << 24) * fabsf(fi.f));
 389       }
 390       else if (new_exp > 15) {
 391          /* map this value to infinity */
 392          /* m = 0; - already set */
 393          e = 31;
 394       }
 395       else {
 396          /* The float32 lies in the range
 397           *   [min_normal16, max_normal16 + max_step16)
 398           * and is rounded to a nearby float16 value. The result will be
 399           * either normal or infinite.
 400           */
 401          e = new_exp + 15;
 402          m = _mesa_round_to_even(flt_m / (float) (1 << 13));
 403       }
 404    }
 405
 406    assert(0 <= m && m <= 1024);
 407    if (m == 1024) {
 408       /* The float32 was rounded upwards into the range of the next exponent,
 409        * so bump the exponent. This correctly handles the case where f32
 410        * should be rounded up to float16 infinity.
 411        */
 412       ++e;
 413       m = 0;
 414    }
 415
 416    result = (s << 15) | (e << 10) | m;
 417    return result;
 418 }
 419
 420
 421 /**
 422  * Convert a 2-byte half float to a 4-byte float.
 423  * Based on code from:
 424  * http://www.opengl.org/discussion_boards/ubb/Forum3/HTML/008786.html
 425  */
 426 float
 427 _mesa_half_to_float(GLhalfARB val)
 428 {
 429    /* XXX could also use a 64K-entry lookup table */
 430    const int m = val & 0x3ff;
 431    const int e = (val >> 10) & 0x1f;
 432    const int s = (val >> 15) & 0x1;
 433    int flt_m, flt_e, flt_s;
 434    fi_type fi;
 435    float result;
 436
 437    /* sign bit */
 438    flt_s = s;
 439
 440    /* handle special cases */
 441    if ((e == 0) && (m == 0)) {
 442       /* zero */
 443       flt_m = 0;
 444       flt_e = 0;
 445    }
 446    else if ((e == 0) && (m != 0)) {
 447       /* denorm -- denorm half will fit in non-denorm single */
 448       const float half_denorm = 1.0f / 16384.0f; /* 2^-14 */
 449       float mantissa = ((float) (m)) / 1024.0f;
 450       float sign = s ? -1.0f : 1.0f;
 451       return sign * mantissa * half_denorm;
 452    }
 453    else if ((e == 31) && (m == 0)) {
 454       /* infinity */
 455       flt_e = 0xff;
 456       flt_m = 0;
 457    }
 458    else if ((e == 31) && (m != 0)) {
 459       /* NaN */
 460       flt_e = 0xff;
 461       flt_m = 1;
 462    }
 463    else {
 464       /* regular */
 465       flt_e = e + 112;
 466       flt_m = m << 13;
 467    }
 468
 469    fi.i = (flt_s << 31) | (flt_e << 23) | flt_m;
 470    result = fi.f;
 471    return result;
 472 }
 473
 474 /*@}*/
 475
 476
 477 /**********************************************************************/
 478 /** \name Sort & Search */
 479 /*@{*/
 480
 481 /**
 482  * Wrapper for bsearch().
 483  */
 484 void *
 485 _mesa_bsearch( const void *key, const void *base, size_t nmemb, size_t size,
 486                int (*compar)(const void *, const void *) )
 487 {
 488    return bsearch(key, base, nmemb, size, compar);
 489 }
 490
 491 /*@}*/
 492
 493
 494 /**********************************************************************/
 495 /** \name Environment vars */
 496 /*@{*/
 497
 498 /**
 499  * Wrapper for getenv().
 500  */
 501 char *
 502 _mesa_getenv( const char *var )
 503 {
 504    return getenv(var);
 505 }
 506
 507 /*@}*/
 508
 509
 510 /**********************************************************************/
 511 /** \name String */
 512 /*@{*/
 513
 514 /**
 515  * Implemented using malloc() and strcpy.
 516  * Note that NULL is handled accordingly.
 517  */
 518 char *
 519 _mesa_strdup( const char *s )
 520 {
 521    if (s) {
 522       size_t l = strlen(s);
 523       char *s2 = malloc(l + 1);
 524       if (s2)
 525          strcpy(s2, s);
 526       return s2;
 527    }
 528    else {
 529       return NULL;
 530    }
 531 }
 532
 533 /** Wrapper around strtof() */
 534 float
 535 _mesa_strtof( const char *s, char **end )
 536 {
 537 #if defined(_GNU_SOURCE) && !defined(__CYGWIN__) && !defined(__FreeBSD__) && \
 538    !defined(ANDROID) && !defined(__HAIKU__) && !defined(__UCLIBC__) && \
 539    !defined(__NetBSD__)
 540    static locale_t loc = NULL;
 541    if (!loc) {
 542       loc = newlocale(LC_CTYPE_MASK, "C", NULL);
 543    }
 544    return strtof_l(s, end, loc);
 545 #elif defined(_ISOC99_SOURCE) || (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 600)
 546    return strtof(s, end);
 547 #else
 548    return (float)strtod(s, end);
 549 #endif
 550 }
 551
 552 /** Compute simple checksum/hash for a string */
 553 unsigned int
 554 _mesa_str_checksum(const char *str)
 555 {
 556    /* This could probably be much better */
 557    unsigned int sum, i;
 558    const char *c;
 559    sum = i = 1;
 560    for (c = str; *c; c++, i++)
 561       sum += *c * (i % 100);
 562    return sum + i;
 563 }
 564
 565
 566 /*@}*/
 567
 568
 569 /** Needed due to #ifdef's, above. */
 570 int
 571 _mesa_vsnprintf(char *str, size_t size, const char *fmt, va_list args)
 572 {
 573    return vsnprintf( str, size, fmt, args);
 574 }
 575
 576 /** Wrapper around vsnprintf() */
 577 int
 578 _mesa_snprintf( char *str, size_t size, const char *fmt, ... )
 579 {
 580    int r;
 581    va_list args;
 582    va_start( args, fmt );
 583    r = vsnprintf( str, size, fmt, args );
 584    va_end( args );
 585    return r;
 586 }
 587
 588