3 * Standard C library function wrappers.
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,
10 * Some drivers will want to override/replace this file with something
11 * specialized, but that'll be rare.
13 * Eventually, I want to move roll the glheader.h file into this.
15 * \todo Functions still needed:
22 * Mesa 3-D graphics library
25 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
27 * Permission is hereby granted, free of charge, to any person obtaining a
28 * copy of this software and associated documentation files (the "Software"),
29 * to deal in the Software without restriction, including without limitation
30 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
31 * and/or sell copies of the Software, and to permit persons to whom the
32 * Software is furnished to do so, subject to the following conditions:
34 * The above copyright notice and this permission notice shall be included
35 * in all copies or substantial portions of the Software.
37 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
38 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
39 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
40 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
41 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
42 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
59 #define MAXSTRING 4000 /* for vsnprintf() */
62 #define vsnprintf _vsnprintf
63 #elif defined(__IBMC__) || defined(__IBMCPP__) || ( defined(__VMS) && __CRTL_VER < 70312000 )
64 extern int vsnprintf(char *str
, size_t count
, const char *fmt
, va_list arg
);
66 #include "vsnprintf.c"
70 /**********************************************************************/
75 * Allocate aligned memory.
77 * \param bytes number of bytes to allocate.
78 * \param alignment alignment (must be greater than zero).
80 * Allocates extra memory to accommodate rounding up the address for
81 * alignment and to record the real malloc address.
83 * \sa _mesa_align_free().
86 _mesa_align_malloc(size_t bytes
, unsigned long alignment
)
88 #if defined(HAVE_POSIX_MEMALIGN)
90 int err
= posix_memalign(& mem
, alignment
, bytes
);
93 #elif defined(_WIN32) && defined(_MSC_VER)
94 return _aligned_malloc(bytes
, alignment
);
98 ASSERT( alignment
> 0 );
100 ptr
= (uintptr_t) malloc(bytes
+ alignment
+ sizeof(void *));
104 buf
= (ptr
+ alignment
+ sizeof(void *)) & ~(uintptr_t)(alignment
- 1);
105 *(uintptr_t *)(buf
- sizeof(void *)) = ptr
;
108 /* mark the non-aligned area */
109 while ( ptr
< buf
- sizeof(void *) ) {
110 *(unsigned long *)ptr
= 0xcdcdcdcd;
111 ptr
+= sizeof(unsigned long);
116 #endif /* defined(HAVE_POSIX_MEMALIGN) */
120 * Same as _mesa_align_malloc(), but using calloc(1, ) instead of
124 _mesa_align_calloc(size_t bytes
, unsigned long alignment
)
126 #if defined(HAVE_POSIX_MEMALIGN)
129 mem
= _mesa_align_malloc(bytes
, alignment
);
131 (void) memset(mem
, 0, bytes
);
135 #elif defined(_WIN32) && defined(_MSC_VER)
138 mem
= _aligned_malloc(bytes
, alignment
);
140 (void) memset(mem
, 0, bytes
);
147 ASSERT( alignment
> 0 );
149 ptr
= (uintptr_t) calloc(1, bytes
+ alignment
+ sizeof(void *));
153 buf
= (ptr
+ alignment
+ sizeof(void *)) & ~(uintptr_t)(alignment
- 1);
154 *(uintptr_t *)(buf
- sizeof(void *)) = ptr
;
157 /* mark the non-aligned area */
158 while ( ptr
< buf
- sizeof(void *) ) {
159 *(unsigned long *)ptr
= 0xcdcdcdcd;
160 ptr
+= sizeof(unsigned long);
165 #endif /* defined(HAVE_POSIX_MEMALIGN) */
169 * Free memory which was allocated with either _mesa_align_malloc()
170 * or _mesa_align_calloc().
171 * \param ptr pointer to the memory to be freed.
172 * The actual address to free is stored in the word immediately before the
173 * address the client sees.
176 _mesa_align_free(void *ptr
)
178 #if defined(HAVE_POSIX_MEMALIGN)
180 #elif defined(_WIN32) && defined(_MSC_VER)
183 void **cubbyHole
= (void **) ((char *) ptr
- sizeof(void *));
184 void *realAddr
= *cubbyHole
;
186 #endif /* defined(HAVE_POSIX_MEMALIGN) */
190 * Reallocate memory, with alignment.
193 _mesa_align_realloc(void *oldBuffer
, size_t oldSize
, size_t newSize
,
194 unsigned long alignment
)
196 #if defined(_WIN32) && defined(_MSC_VER)
198 return _aligned_realloc(oldBuffer
, newSize
, alignment
);
200 const size_t copySize
= (oldSize
< newSize
) ? oldSize
: newSize
;
201 void *newBuf
= _mesa_align_malloc(newSize
, alignment
);
202 if (newBuf
&& oldBuffer
&& copySize
> 0) {
203 memcpy(newBuf
, oldBuffer
, copySize
);
206 _mesa_align_free(oldBuffer
);
213 /** Reallocate memory */
215 _mesa_realloc(void *oldBuffer
, size_t oldSize
, size_t newSize
)
217 const size_t copySize
= (oldSize
< newSize
) ? oldSize
: newSize
;
218 void *newBuffer
= malloc(newSize
);
219 if (newBuffer
&& oldBuffer
&& copySize
> 0)
220 memcpy(newBuffer
, oldBuffer
, copySize
);
227 * Fill memory with a constant 16bit word.
228 * \param dst destination pointer.
230 * \param n number of words.
233 _mesa_memset16( unsigned short *dst
, unsigned short val
, size_t n
)
242 /**********************************************************************/
246 /** Wrapper around sqrt() */
248 _mesa_sqrtd(double x
)
255 * A High Speed, Low Precision Square Root
256 * by Paul Lalonde and Robert Dawson
257 * from "Graphics Gems", Academic Press, 1990
259 * SPARC implementation of a fast square root by table
261 * SPARC floating point format is as follows:
264 * sign exponent mantissa
266 static short sqrttab
[0x100]; /* declare table of square roots */
269 _mesa_init_sqrt_table(void)
271 #if defined(USE_IEEE) && !defined(DEBUG)
273 fi_type fi
; /* to access the bits of a float in C quickly */
274 /* we use a union defined in glheader.h */
276 for(i
=0; i
<= 0x7f; i
++) {
280 * Build a float with the bit pattern i as mantissa
281 * and an exponent of 0, stored as 127
284 fi
.i
= (i
<< 16) | (127 << 23);
285 fi
.f
= _mesa_sqrtd(fi
.f
);
288 * Take the square root then strip the first 7 bits of
289 * the mantissa into the table
292 sqrttab
[i
] = (fi
.i
& 0x7fffff) >> 16;
295 * Repeat the process, this time with an exponent of
300 fi
.i
= (i
<< 16) | (128 << 23);
302 sqrttab
[i
+0x80] = (fi
.i
& 0x7fffff) >> 16;
305 (void) sqrttab
; /* silence compiler warnings */
306 #endif /*HAVE_FAST_MATH*/
311 * Single precision square root.
314 _mesa_sqrtf( float x
)
316 #if defined(USE_IEEE) && !defined(DEBUG)
318 /* to access the bits of a float in C
319 * we use a union from glheader.h */
321 short e
; /* the exponent */
322 if (x
== 0.0F
) return 0.0F
; /* check for square root of 0 */
324 e
= (num
.i
>> 23) - 127; /* get the exponent - on a SPARC the */
325 /* exponent is stored with 127 added */
326 num
.i
&= 0x7fffff; /* leave only the mantissa */
327 if (e
& 0x01) num
.i
|= 0x800000;
328 /* the exponent is odd so we have to */
329 /* look it up in the second half of */
330 /* the lookup table, so we set the */
332 e
>>= 1; /* divide the exponent by two */
333 /* note that in C the shift */
334 /* operators are sign preserving */
335 /* for signed operands */
336 /* Do the table lookup, based on the quaternary mantissa,
337 * then reconstruct the result back into a float
339 num
.i
= ((sqrttab
[num
.i
>> 16]) << 16) | ((e
+ 127) << 23);
343 return (float) _mesa_sqrtd((double) x
);
349 inv_sqrt - A single precision 1/sqrt routine for IEEE format floats.
350 written by Josh Vanderhoof, based on newsgroup posts by James Van Buskirk
354 _mesa_inv_sqrtf(float n
)
356 #if defined(USE_IEEE) && !defined(DEBUG)
360 #if 0 /* not used, see below -BP */
367 Exponent part of the magic number -
370 1. subtract the bias from the exponent,
372 3. divide by two (rounding towards -inf)
375 Which is the same as subtracting the exponent from 381 and dividing
378 floor(-(x - 127) / 2) + 127 = floor((381 - x) / 2)
384 Significand part of magic number -
386 With the current magic number, "(magic - u.i) >> 1" will give you:
388 for 1 <= u.f <= 2: 1.25 - u.f / 4
389 for 2 <= u.f <= 4: 1.00 - u.f / 8
391 This isn't a bad approximation of 1/sqrt. The maximum difference from
392 1/sqrt will be around .06. After three Newton-Raphson iterations, the
393 maximum difference is less than 4.5e-8. (Which is actually close
394 enough to make the following bias academic...)
396 To get a better approximation you can add a bias to the magic
397 number. For example, if you subtract 1/2 of the maximum difference in
398 the first approximation (.03), you will get the following function:
400 for 1 <= u.f <= 2: 1.22 - u.f / 4
401 for 2 <= u.f <= 3.76: 0.97 - u.f / 8
402 for 3.76 <= u.f <= 4: 0.72 - u.f / 16
403 (The 3.76 to 4 range is where the result is < .5.)
405 This is the closest possible initial approximation, but with a maximum
406 error of 8e-11 after three NR iterations, it is still not perfect. If
407 you subtract 0.0332281 instead of .03, the maximum error will be
408 2.5e-11 after three NR iterations, which should be about as close as
411 for 1 <= u.f <= 2: 1.2167719 - u.f / 4
412 for 2 <= u.f <= 3.73: 0.9667719 - u.f / 8
413 for 3.73 <= u.f <= 4: 0.7167719 - u.f / 16
417 magic
-= (int)(0.0332281 * (1 << 25));
420 u
.i
= (magic
- u
.i
) >> 1;
423 Instead of Newton-Raphson, we use Goldschmidt's algorithm, which
424 allows more parallelism. From what I understand, the parallelism
425 comes at the cost of less precision, because it lets error
426 accumulate across iterations.
441 return x2
* r2
; /* we can stop here, and be conformant -BP */
450 return (float) (1.0 / sqrt(n
));
455 * Find the first bit set in a word.
460 #if (defined(_WIN32) ) || defined(__IBMC__) || defined(__IBMCPP__)
461 register int bit
= 0;
463 if ((i
& 0xffff) == 0) {
467 if ((i
& 0xff) == 0) {
471 if ((i
& 0xf) == 0) {
475 while ((i
& 1) == 0) {
489 * Find position of first bit set in given value.
490 * XXX Warning: this function can only be used on 64-bit systems!
491 * \return position of least-significant bit set, starting at 1, return zero
495 _mesa_ffsll(int64_t val
)
502 assert(sizeof(val
) == 8);
504 bit
= _mesa_ffs((int32_t)val
);
508 bit
= _mesa_ffs((int32_t)(val
>> 32));
518 * Return number of bits set in given GLuint.
521 _mesa_bitcount(unsigned int n
)
523 #if defined(__GNUC__) && \
524 ((_GNUC__ == 3 && __GNUC_MINOR__ >= 4) || __GNUC__ >= 4)
525 return __builtin_popcount(n
);
528 for (bits
= 0; n
> 0; n
= n
>> 1) {
537 * Convert a 4-byte float to a 2-byte half float.
538 * Based on code from:
539 * http://www.opengl.org/discussion_boards/ubb/Forum3/HTML/008786.html
542 _mesa_float_to_half(float val
)
544 const fi_type fi
= {val
};
545 const int flt_m
= fi
.i
& 0x7fffff;
546 const int flt_e
= (fi
.i
>> 23) & 0xff;
547 const int flt_s
= (fi
.i
>> 31) & 0x1;
554 /* handle special cases */
555 if ((flt_e
== 0) && (flt_m
== 0)) {
557 /* m = 0; - already set */
560 else if ((flt_e
== 0) && (flt_m
!= 0)) {
561 /* denorm -- denorm float maps to 0 half */
562 /* m = 0; - already set */
565 else if ((flt_e
== 0xff) && (flt_m
== 0)) {
567 /* m = 0; - already set */
570 else if ((flt_e
== 0xff) && (flt_m
!= 0)) {
577 const int new_exp
= flt_e
- 127;
580 /* m = 0; - already set */
583 else if (new_exp
< -14) {
584 /* this maps to a denorm */
585 unsigned int exp_val
= (unsigned int) (-14 - new_exp
); /* 2^-exp_val*/
590 "float_to_half: logical error in denorm creation!\n");
591 /* m = 0; - already set */
593 case 1: m
= 512 + (flt_m
>> 14); break;
594 case 2: m
= 256 + (flt_m
>> 15); break;
595 case 3: m
= 128 + (flt_m
>> 16); break;
596 case 4: m
= 64 + (flt_m
>> 17); break;
597 case 5: m
= 32 + (flt_m
>> 18); break;
598 case 6: m
= 16 + (flt_m
>> 19); break;
599 case 7: m
= 8 + (flt_m
>> 20); break;
600 case 8: m
= 4 + (flt_m
>> 21); break;
601 case 9: m
= 2 + (flt_m
>> 22); break;
602 case 10: m
= 1; break;
605 else if (new_exp
> 15) {
606 /* map this value to infinity */
607 /* m = 0; - already set */
617 result
= (s
<< 15) | (e
<< 10) | m
;
623 * Convert a 2-byte half float to a 4-byte float.
624 * Based on code from:
625 * http://www.opengl.org/discussion_boards/ubb/Forum3/HTML/008786.html
628 _mesa_half_to_float(GLhalfARB val
)
630 /* XXX could also use a 64K-entry lookup table */
631 const int m
= val
& 0x3ff;
632 const int e
= (val
>> 10) & 0x1f;
633 const int s
= (val
>> 15) & 0x1;
634 int flt_m
, flt_e
, flt_s
;
641 /* handle special cases */
642 if ((e
== 0) && (m
== 0)) {
647 else if ((e
== 0) && (m
!= 0)) {
648 /* denorm -- denorm half will fit in non-denorm single */
649 const float half_denorm
= 1.0f
/ 16384.0f
; /* 2^-14 */
650 float mantissa
= ((float) (m
)) / 1024.0f
;
651 float sign
= s
? -1.0f
: 1.0f
;
652 return sign
* mantissa
* half_denorm
;
654 else if ((e
== 31) && (m
== 0)) {
659 else if ((e
== 31) && (m
!= 0)) {
670 fi
.i
= (flt_s
<< 31) | (flt_e
<< 23) | flt_m
;
678 /**********************************************************************/
679 /** \name Sort & Search */
683 * Wrapper for bsearch().
686 _mesa_bsearch( const void *key
, const void *base
, size_t nmemb
, size_t size
,
687 int (*compar
)(const void *, const void *) )
689 #if defined(_WIN32_WCE)
694 mid
= (char *)base
+ nmemb
* size
;
695 cmp
= (*compar
)(key
, mid
);
699 base
= (char *)mid
+ size
;
705 return bsearch(key
, base
, nmemb
, size
, compar
);
712 /**********************************************************************/
713 /** \name Environment vars */
717 * Wrapper for getenv().
720 _mesa_getenv( const char *var
)
722 #if defined(_XBOX) || defined(_WIN32_WCE)
732 /**********************************************************************/
737 * Implemented using malloc() and strcpy.
738 * Note that NULL is handled accordingly.
741 _mesa_strdup( const char *s
)
744 size_t l
= strlen(s
);
745 char *s2
= (char *) malloc(l
+ 1);
755 /** Wrapper around strtof() */
757 _mesa_strtof( const char *s
, char **end
)
760 static locale_t loc
= NULL
;
762 loc
= newlocale(LC_CTYPE_MASK
, "C", NULL
);
764 return strtof_l(s
, end
, loc
);
765 #elif defined(_ISOC99_SOURCE) || (defined(_XOPEN_SOURCE) && _XOPEN_SOURCE >= 600)
766 return strtof(s
, end
);
768 return (float)strtod(s
, end
);
772 /** Compute simple checksum/hash for a string */
774 _mesa_str_checksum(const char *str
)
776 /* This could probably be much better */
780 for (c
= str
; *c
; c
++, i
++)
781 sum
+= *c
* (i
% 100);
789 /** Wrapper around vsnprintf() */
791 _mesa_snprintf( char *str
, size_t size
, const char *fmt
, ... )
795 va_start( args
, fmt
);
796 r
= vsnprintf( str
, size
, fmt
, args
);
802 /**********************************************************************/
803 /** \name Diagnostics */
807 output_if_debug(const char *prefixString
, const char *outputString
,
810 static int debug
= -1;
812 /* Check the MESA_DEBUG environment variable if it hasn't
813 * been checked yet. We only have to check it once...
816 char *env
= _mesa_getenv("MESA_DEBUG");
818 /* In a debug build, we print warning messages *unless*
819 * MESA_DEBUG is 0. In a non-debug build, we don't
820 * print warning messages *unless* MESA_DEBUG is
821 * set *to any value*.
824 debug
= (env
!= NULL
&& atoi(env
) == 0) ? 0 : 1;
826 debug
= (env
!= NULL
) ? 1 : 0;
830 /* Now only print the string if we're required to do so. */
832 fprintf(stderr
, "%s: %s", prefixString
, outputString
);
834 fprintf(stderr
, "\n");
836 #if defined(_WIN32) && !defined(_WIN32_WCE)
837 /* stderr from windows applications without console is not usually
838 * visible, so communicate with the debugger instead */
841 _mesa_snprintf(buf
, sizeof(buf
), "%s: %s%s", prefixString
, outputString
, newline
? "\n" : "");
842 OutputDebugStringA(buf
);
850 * Return string version of GL error code.
853 error_string( GLenum error
)
857 return "GL_NO_ERROR";
858 case GL_INVALID_VALUE
:
859 return "GL_INVALID_VALUE";
860 case GL_INVALID_ENUM
:
861 return "GL_INVALID_ENUM";
862 case GL_INVALID_OPERATION
:
863 return "GL_INVALID_OPERATION";
864 case GL_STACK_OVERFLOW
:
865 return "GL_STACK_OVERFLOW";
866 case GL_STACK_UNDERFLOW
:
867 return "GL_STACK_UNDERFLOW";
868 case GL_OUT_OF_MEMORY
:
869 return "GL_OUT_OF_MEMORY";
870 case GL_TABLE_TOO_LARGE
:
871 return "GL_TABLE_TOO_LARGE";
872 case GL_INVALID_FRAMEBUFFER_OPERATION_EXT
:
873 return "GL_INVALID_FRAMEBUFFER_OPERATION";
881 * When a new type of error is recorded, print a message describing
882 * previous errors which were accumulated.
885 flush_delayed_errors( GLcontext
*ctx
)
889 if (ctx
->ErrorDebugCount
) {
890 _mesa_snprintf(s
, MAXSTRING
, "%d similar %s errors",
891 ctx
->ErrorDebugCount
,
892 error_string(ctx
->ErrorValue
));
894 output_if_debug("Mesa", s
, GL_TRUE
);
896 ctx
->ErrorDebugCount
= 0;
902 * Report a warning (a recoverable error condition) to stderr if
903 * either DEBUG is defined or the MESA_DEBUG env var is set.
905 * \param ctx GL context.
906 * \param fmtString printf()-like format string.
909 _mesa_warning( GLcontext
*ctx
, const char *fmtString
, ... )
913 va_start( args
, fmtString
);
914 (void) vsnprintf( str
, MAXSTRING
, fmtString
, args
);
918 flush_delayed_errors( ctx
);
920 output_if_debug("Mesa warning", str
, GL_TRUE
);
925 * Report an internal implementation problem.
926 * Prints the message to stderr via fprintf().
928 * \param ctx GL context.
929 * \param fmtString problem description string.
932 _mesa_problem( const GLcontext
*ctx
, const char *fmtString
, ... )
938 va_start( args
, fmtString
);
939 vsnprintf( str
, MAXSTRING
, fmtString
, args
);
942 fprintf(stderr
, "Mesa %s implementation error: %s\n", MESA_VERSION_STRING
, str
);
943 fprintf(stderr
, "Please report at bugzilla.freedesktop.org\n");
948 * Record an OpenGL state error. These usually occur when the user
949 * passes invalid parameters to a GL function.
951 * If debugging is enabled (either at compile-time via the DEBUG macro, or
952 * run-time via the MESA_DEBUG environment variable), report the error with
955 * \param ctx the GL context.
956 * \param error the error value.
957 * \param fmtString printf() style format string, followed by optional args
960 _mesa_error( GLcontext
*ctx
, GLenum error
, const char *fmtString
, ... )
962 static GLint debug
= -1;
964 /* Check debug environment variable only once:
967 const char *debugEnv
= _mesa_getenv("MESA_DEBUG");
970 if (debugEnv
&& strstr(debugEnv
, "silent"))
983 if (ctx
->ErrorValue
== error
&&
984 ctx
->ErrorDebugFmtString
== fmtString
) {
985 ctx
->ErrorDebugCount
++;
988 char s
[MAXSTRING
], s2
[MAXSTRING
];
991 flush_delayed_errors( ctx
);
993 va_start(args
, fmtString
);
994 vsnprintf(s
, MAXSTRING
, fmtString
, args
);
997 _mesa_snprintf(s2
, MAXSTRING
, "%s in %s", error_string(error
), s
);
998 output_if_debug("Mesa: User error", s2
, GL_TRUE
);
1000 ctx
->ErrorDebugFmtString
= fmtString
;
1001 ctx
->ErrorDebugCount
= 0;
1005 _mesa_record_error(ctx
, error
);
1010 * Report debug information. Print error message to stderr via fprintf().
1011 * No-op if DEBUG mode not enabled.
1013 * \param ctx GL context.
1014 * \param fmtString printf()-style format string, followed by optional args.
1017 _mesa_debug( const GLcontext
*ctx
, const char *fmtString
, ... )
1022 va_start(args
, fmtString
);
1023 vsnprintf(s
, MAXSTRING
, fmtString
, args
);
1025 output_if_debug("Mesa", s
, GL_FALSE
);