More GL_EXT_framebuffer_object: rename some things, added device driver hooks.
[mesa.git] / src / mesa / main / imports.h
index 2f5c38f046de969cf2e5e5de1dd1115d6925de2e..5158bcd8b252e1a66d548f3a6c969e3ea8bab1dd 100644 (file)
@@ -1,10 +1,8 @@
-/* $Id: imports.h,v 1.14 2003/03/02 19:36:09 brianp Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  5.1
+ * Version:  6.2
  *
- * Copyright (C) 1999-2003  Brian Paul   All Rights Reserved.
+ * Copyright (C) 1999-2004  Brian Paul   All Rights Reserved.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
  */
 
 
-/*
+/**
+ * \file imports.h
+ * Standard C library function wrappers.
+ *
  * This file provides wrappers for all the standard C library functions
- * like malloc, free, printf, getenv, etc.
+ * like malloc(), free(), printf(), getenv(), etc.
  */
 
 
 #include "glheader.h"
 
 
-/**********************************************************************
- * General macros
- */
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+
+/**********************************************************************/
+/** \name General macros */
+/*@{*/
 
 #ifndef NULL
 #define NULL 0
 #endif
 
+/*@}*/
 
 
-/**********************************************************************
- * Memory macros
- */
+/**********************************************************************/
+/** Memory macros */
+/*@{*/
 
+/** Allocate \p BYTES bytes */
 #define MALLOC(BYTES)      _mesa_malloc(BYTES)
+/** Allocate and zero \p BYTES bytes */
 #define CALLOC(BYTES)      _mesa_calloc(BYTES)
+/** Allocate a structure of type \p T */
 #define MALLOC_STRUCT(T)   (struct T *) _mesa_malloc(sizeof(struct T))
+/** Allocate and zero a structure of type \p T */
 #define CALLOC_STRUCT(T)   (struct T *) _mesa_calloc(sizeof(struct T))
+/** Free memory */
 #define FREE(PTR)          _mesa_free(PTR)
 
+/** Allocate \p BYTES aligned at \p N bytes */
 #define ALIGN_MALLOC(BYTES, N)     _mesa_align_malloc(BYTES, N)
+/** Allocate and zero \p BYTES bytes aligned at \p N bytes */
 #define ALIGN_CALLOC(BYTES, N)     _mesa_align_calloc(BYTES, N)
+/** Allocate a structure of type \p T aligned at \p N bytes */
 #define ALIGN_MALLOC_STRUCT(T, N)  (struct T *) _mesa_align_malloc(sizeof(struct T), N)
+/** Allocate and zero a structure of type \p T aligned at \p N bytes */
 #define ALIGN_CALLOC_STRUCT(T, N)  (struct T *) _mesa_align_calloc(sizeof(struct T), N)
+/** Free aligned memory */
 #define ALIGN_FREE(PTR)            _mesa_align_free(PTR)
 
+/** Copy \p BYTES bytes from \p SRC into \p DST */
 #define MEMCPY( DST, SRC, BYTES)   _mesa_memcpy(DST, SRC, BYTES)
+/** Set \p N bytes in \p DST to \p VAL */
 #define MEMSET( DST, VAL, N )      _mesa_memset(DST, VAL, N)
 
 #define MEMSET16( DST, VAL, N )   _mesa_memset16( (DST), (VAL), (size_t) (N) )
 
+/*@}*/
+
+
+/*
+ * For GL_ARB_vertex_buffer_object we need to treat vertex array pointers
+ * as offsets into buffer stores.  Since the vertex array pointer and
+ * buffer store pointer are both pointers and we need to add them, we use
+ * this macro.
+ * Both pointers/offsets are expressed in bytes.
+ */
+#define ADD_POINTERS(A, B)  ( (GLubyte *) (A) + (unsigned long) (B) )
+
+
+/**********************************************************************/
+/** \name [Pseudo] static array declaration.
+ *
+ * MACs and BeOS don't support static larger than 32kb, so ...
+ */
+/*@{*/
+
+/**
+ * \def DEFARRAY
+ * Define a [static] unidimensional array
+ */
+
+/**
+ * \def DEFMARRAY
+ * Define a [static] bi-dimensional array
+ */
+
+/**
+ * \def DEFMNARRAY
+ * Define a [static] tri-dimensional array
+ */
+
+/**
+ * \def CHECKARRAY
+ * Verifies a [static] array was properly allocated.
+ */
+
+/**
+ * \def UNDEFARRAY
+ * Undefine (free) a [static] array.
+ */
 
-/* MACs and BeOS don't support static larger than 32kb, so... */
 #if defined(macintosh) && !defined(__MRC__)
 /*extern char *AGLAlloc(int size);*/
 /*extern void AGLFree(char* ptr);*/
 #  define DEFARRAY(TYPE,NAME,SIZE)                     TYPE *NAME = (TYPE*)_mesa_alloc(sizeof(TYPE)*(SIZE))
 #  define DEFMARRAY(TYPE,NAME,SIZE1,SIZE2)             TYPE (*NAME)[SIZE2] = (TYPE(*)[SIZE2])_mesa_alloc(sizeof(TYPE)*(SIZE1)*(SIZE2))
 #  define DEFMNARRAY(TYPE,NAME,SIZE1,SIZE2,SIZE3)      TYPE (*NAME)[SIZE2][SIZE3] = (TYPE(*)[SIZE2][SIZE3])_mesa_alloc(sizeof(TYPE)*(SIZE1)*(SIZE2)*(SIZE3))
-
 #  define CHECKARRAY(NAME,CMD)                         do {if (!(NAME)) {CMD;}} while (0)
 #  define UNDEFARRAY(NAME)                             do {if ((NAME)) {_mesa_free((char*)NAME);}  }while (0)
 #elif defined(__BEOS__)
 #  define UNDEFARRAY(NAME)
 #endif
 
+/*@}*/
 
-#ifdef MESA_EXTERNAL_BUFFERALLOC
-/*
- * If you want Mesa's depth/stencil/accum/etc buffers to be allocated
- * with a specialized allocator you can define MESA_EXTERNAL_BUFFERALLOC
- * and implement _ext_mesa_alloc/free_pixelbuffer() in your app.
+
+/**********************************************************************/
+/** \name External pixel buffer allocation.
+ *
+ * If you want Mesa's depth/stencil/accum/etc buffers to be allocated with a
+ * specialized allocator you can define MESA_EXTERNAL_BUFFERALLOC and implement
+ * _ext_mesa_alloc_pixelbuffer() _ext_mesa_free_pixelbuffer() in your
+ * application.
+ *
+ * \author
  * Contributed by Gerk Huisma (gerk@five-d.demon.nl).
  */
+/*@{*/
+
+/**
+ * \def MESA_PBUFFER_ALLOC
+ * Allocate a pixel buffer.
+ */
+
+/**
+ * \def MESA_PBUFFER_FREE
+ * Free a pixel buffer.
+ */
+
+#ifdef MESA_EXTERNAL_BUFFERALLOC
 extern void *_ext_mesa_alloc_pixelbuffer( unsigned int size );
 extern void _ext_mesa_free_pixelbuffer( void *pb );
 
@@ -115,6 +195,22 @@ extern void _ext_mesa_free_pixelbuffer( void *pb );
 #define MESA_PBUFFER_FREE(PTR)     _mesa_align_free(PTR)
 #endif
 
+/*@}*/
+
+
+/**********************************************************************/
+
+
+/**
+ * Sometimes we treat GLfloats as GLints.  On x86 systems, moving a float
+ * as a int (thereby using integer registers instead of FP registers) is
+ * a performance win.  Typically, this can be done with ordinary casts.
+ * But with gcc's -fstrict-aliasing flag (which defaults to on in gcc 3.0)
+ * these casts generate warnings.
+ * The following union typedef is used to solve that.
+ */
+typedef union { GLfloat f; GLint i; } fi_type;
+
 
 
 /**********************************************************************
@@ -125,7 +221,12 @@ extern void _ext_mesa_free_pixelbuffer( void *pb );
 #define MAX_GLUINT     0xffffffff
 
 #ifndef M_PI
-#define M_PI (3.1415926)
+#define M_PI (3.1415926536)
+#endif
+
+/* XXX this is a bit of a hack needed for compilation within XFree86 */
+#ifndef FLT_MIN
+#define FLT_MIN (1.0e-37)
 #endif
 
 /* Degrees to radians conversion: */
@@ -135,9 +236,14 @@ extern void _ext_mesa_free_pixelbuffer( void *pb );
 /***
  *** USE_IEEE: Determine if we're using IEEE floating point
  ***/
-#if defined(__i386__) || defined(__sparc__) || defined(__s390x__) || \
-    defined(__powerpc__) || \
-    ( defined(__alpha__) && ( defined(__IEEE_FLOAT) || !defined(VMS) ) )
+#if defined(__i386__) || defined(__386__) || defined(__sparc__) || \
+    defined(__s390x__) || defined(__powerpc__) || \
+    defined(__amd64__) || \
+    defined(ia64) || defined(__ia64__) || \
+    defined(__hppa__) || defined(hpux) || \
+    defined(__mips) || defined(_MIPS_ARCH) || \
+    defined(__arm__) || \
+    (defined(__alpha__) && (defined(__IEEE_FLOAT) || !defined(VMS)))
 #define USE_IEEE
 #define IEEE_ONE 0x3f800000
 #endif
@@ -146,18 +252,22 @@ extern void _ext_mesa_free_pixelbuffer( void *pb );
 /***
  *** SQRTF: single-precision square root
  ***/
-#ifdef DEBUG
-#  define SQRTF(X)  ((float)_mesa_sqrtd((float) X))
-#elif defined(__WATCOMC__) && defined(USE_X86_ASM)
-float asm_sqrt (float x);
-#pragma aux asm_sqrt =                      \
-       "fsqrt"                             \
-       parm [8087]                         \
-       value [8087]                        \
-       modify exact [];
-#  define SQRTF(X)  asm_sqrt(X)
-#else
+#if 0 /* _mesa_sqrtf() not accurate enough - temporarily disabled */
 #  define SQRTF(X)  _mesa_sqrtf(X)
+#elif defined(XFree86LOADER) && defined(IN_MODULE)
+#  define SQRTF(X)  (float) xf86sqrt((float) (X))
+#else
+#  define SQRTF(X)  (float) sqrt((float) (X))
+#endif
+
+
+/***
+ *** INV_SQRTF: single-precision inverse square root
+ ***/
+#if 0
+#define INV_SQRTF(X) _mesa_inv_sqrt(X)
+#else
+#define INV_SQRTF(X) (1.0F / SQRTF(X))  /* this is faster on a P4 */
 #endif
 
 
@@ -183,14 +293,14 @@ static INLINE GLfloat LOG2(GLfloat x)
  */
 static INLINE GLfloat LOG2(GLfloat val)
 {
-   GLint *exp_ptr = (GLint *) &val;
-   GLint x = *exp_ptr;
-   const GLint log_2 = ((x >> 23) & 255) - 128;
-   x &= ~(255 << 23);
-   x += 127 << 23;
-   *exp_ptr = x;
-   val = ((-1.0f/3) * val + 2) * val - 2.0f/3;
-   return val + log_2;
+   fi_type num;
+   GLint log_2;
+   num.f = val;
+   log_2 = ((num.i >> 23) & 255) - 128;
+   num.i &= ~(255 << 23);
+   num.i += 127 << 23;
+   num.f = ((-1.0f/3) * num.f + 2) * num.f - 2.0f/3;
+   return num.f + log_2;
 }
 #elif defined(XFree86LOADER) && defined(IN_MODULE)
 #define LOG2(x) ((GLfloat) (xf86log(x) * 1.442695))
@@ -217,21 +327,26 @@ static INLINE int IS_INF_OR_NAN( float x )
 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 #elif defined(finite)
 #define IS_INF_OR_NAN(x)        (!finite(x))
-#elif __VMS
+#elif defined(__VMS)
 #define IS_INF_OR_NAN(x)        (!finite(x))
 #elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
 #define IS_INF_OR_NAN(x)        (!isfinite(x))
 #else
 #define IS_INF_OR_NAN(x)        (!finite(x))
-#endif 
+#endif
 
 
 /***
  *** IS_NEGATIVE: test if float is negative
  ***/
 #if defined(USE_IEEE)
-#define GET_FLOAT_BITS(x) ((fi_type *) &(x))->i
-#define IS_NEGATIVE(x) (GET_FLOAT_BITS(x) & (1<<31))
+static INLINE int GET_FLOAT_BITS( float x )
+{
+   fi_type fi;
+   fi.f = x;
+   return fi.i;
+}
+#define IS_NEGATIVE(x) (GET_FLOAT_BITS(x) < 0)
 #else
 #define IS_NEGATIVE(x) (x < 0.0F)
 #endif
@@ -255,22 +370,19 @@ static INLINE int IS_INF_OR_NAN( float x )
  *** FLOORF: floor of float
  *** FABSF: absolute value of float
  ***/
-#if defined(__sparc__) || defined(__NeXT__) /* XXX improve? */
-#define CEILF(x)   ceil(x)
-#define FLOORF(x)  floor(x)
-#define FABSF(x)   fabs(x)
-#elif defined(__WIN32__) || defined(__IBMC__) || defined(__IBMCPP__)
-#define CEILF(x)   ((GLfloat) ceil(x))
-#define FLOORF(x)  ((GLfloat) floor(x))
-#define FABSF(x)   ((GLfloat) fabs(x))
-#elif defined(XFree86LOADER) && defined(IN_MODULE)
+#if defined(XFree86LOADER) && defined(IN_MODULE)
 #define CEILF(x)   ((GLfloat) xf86ceil(x))
 #define FLOORF(x)  ((GLfloat) xf86floor(x))
 #define FABSF(x)   ((GLfloat) xf86fabs(x))
-#else
+#elif defined(__gnu_linux__)
+/* C99 functions */
 #define CEILF(x)   ceilf(x)
 #define FLOORF(x)  floorf(x)
 #define FABSF(x)   fabsf(x)
+#else
+#define CEILF(x)   ((GLfloat) ceil(x))
+#define FLOORF(x)  ((GLfloat) floor(x))
+#define FABSF(x)   ((GLfloat) fabs(x))
 #endif
 
 
@@ -280,12 +392,13 @@ static INLINE int IS_INF_OR_NAN( float x )
 #if defined(USE_SPARC_ASM) && defined(__GNUC__) && defined(__sparc__)
 static INLINE int iround(float f)
 {
-       int r;
-       __asm__ ("fstoi %1, %0" : "=f" (r) : "f" (f));
-       return r;
+   int r;
+   __asm__ ("fstoi %1, %0" : "=f" (r) : "f" (f));
+   return r;
 }
 #define IROUND(x)  iround(x)
-#elif defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__)
+#elif defined(USE_X86_ASM) && defined(__GNUC__) && defined(__i386__) && \
+                       (!defined(__BEOS__) || (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 95)))
 static INLINE int iround(float f)
 {
    int r;
@@ -304,16 +417,15 @@ static INLINE int iround(float f)
    return r;
 }
 #define IROUND(x)  iround(x)
-#elif defined(USE_X86_ASM) && defined(__WATCOMC__)
+#elif defined(__WATCOMC__) && defined(__386__)
 long iround(float f);
-#pragma aux iround =                        \
+#pragma aux iround =                    \
        "push   eax"                        \
        "fistp  dword ptr [esp]"            \
        "pop    eax"                        \
        parm [8087]                         \
        value [eax]                         \
        modify exact [eax];
-
 #define IROUND(x)  iround(x)
 #else
 #define IROUND(f)  ((int) (((f) >= 0.0F) ? ((f) + 0.5F) : ((f) - 0.5F)))
@@ -362,8 +474,8 @@ static INLINE int ifloor(float f)
 
    af = (3 << 22) + 0.5 + (double)f;
    bf = (3 << 22) + 0.5 - (double)f;
-   u.f = af; ai = u.i;
-   u.f = bf; bi = u.i;
+   u.f = (float) af;  ai = u.i;
+   u.f = (float) bf;  bi = u.i;
    return (ai - bi) >> 1;
 }
 #define IFLOOR(x)  ifloor(x)
@@ -408,8 +520,8 @@ static INLINE int iceil(float f)
    fi_type u;
    af = (3 << 22) + 0.5 + (double)f;
    bf = (3 << 22) + 0.5 - (double)f;
-   u.f = af; ai = u.i;
-   u.f = bf; bi = u.i;
+   u.f = (float) af; ai = u.i;
+   u.f = (float) bf; bi = u.i;
    return (ai - bi + 1) >> 1;
 }
 #define ICEIL(x)  iceil(x)
@@ -424,8 +536,8 @@ static INLINE int iceil(float f)
 
 
 /***
- *** UNCLAMPED_FLOAT_TO_UBYTE: map float from {0,1} to ubyte in [0,255]
- *** CLAMPED_FLOAT_TO_UBYTE: map float in [0,1] to ubyte in [0,255]
+ *** UNCLAMPED_FLOAT_TO_UBYTE: clamp float to [0,1] and map to ubyte in [0,255]
+ *** CLAMPED_FLOAT_TO_UBYTE: map float known to be in [0,1] to ubyte in [0,255]
  ***/
 #if defined(USE_IEEE) && !defined(DEBUG)
 #define IEEE_0996 0x3f7f0000   /* 0.996 or so */
@@ -436,13 +548,21 @@ static INLINE int iceil(float f)
         do {                                                           \
            fi_type __tmp;                                              \
            __tmp.f = (F);                                              \
-           UB = ((__tmp.i >= IEEE_0996)                                        \
-               ? ((GLint)__tmp.i < 0) ? (GLubyte)0 : (GLubyte)255      \
-               : (__tmp.f = __tmp.f*(255.0F/256.0F) + 32768.0F,                \
-                  (GLubyte)__tmp.i));                                  \
+           if (__tmp.i < 0)                                            \
+              UB = (GLubyte) 0;                                                \
+           else if (__tmp.i >= IEEE_0996)                              \
+              UB = (GLubyte) 255;                                      \
+           else {                                                      \
+              __tmp.f = __tmp.f * (255.0F/256.0F) + 32768.0F;          \
+              UB = (GLubyte) __tmp.i;                                  \
+           }                                                           \
+        } while (0)
+#define CLAMPED_FLOAT_TO_UBYTE(UB, F)                                  \
+        do {                                                           \
+           fi_type __tmp;                                              \
+           __tmp.f = (F) * (255.0F/256.0F) + 32768.0F;                 \
+           UB = (GLubyte) __tmp.i;                                     \
         } while (0)
-#define CLAMPED_FLOAT_TO_UBYTE(ub, f) \
-        UNCLAMPED_FLOAT_TO_UBYTE(ub, f)
 #else
 #define UNCLAMPED_FLOAT_TO_UBYTE(ub, f) \
        ub = ((GLubyte) IROUND(CLAMP((f), 0.0F, 1.0F) * 255.0F))
@@ -452,14 +572,9 @@ static INLINE int iceil(float f)
 
 
 /***
- *** COPY_FLOAT: copy a float from src to dest, avoid slow FP regs if possible
+ *** COPY_FLOAT: copy a float from src to dest.
  ***/
-#if defined(USE_IEEE) && !defined(DEBUG)
-#define COPY_FLOAT( dst, src )                                 \
-       ((fi_type *) &(dst))->i = ((fi_type *) &(src))->i
-#else
 #define COPY_FLOAT( dst, src )         (dst) = (src)
-#endif
 
 
 /***
@@ -512,21 +627,35 @@ do {                                                                      \
    __asm__ ( "fnclex ; fldcw %0" : : "m" (*&(x)) );                    \
 } while (0)
 
-#elif defined(__WATCOMC__) && !defined(NO_FAST_MATH)
-void _wacom_start_fast_math(unsigned short *x);
-#pragma aux _wacom_start_fast_math =    \
-    "fstcw   word ptr [esi]"            \
-    "or      word ptr [esi], 0x3f"      \
-    "fldcw   word ptr [esi]"            \
-    parm [esi]                          \
-    modify exact [];
-void _wacom_end_fast_math(unsigned short *x);
-#pragma aux _wacom_end_fast_math =      \
-    "fldcw   word ptr [esi]"            \
-    parm [esi]                          \
-    modify exact [];
-#define START_FAST_MATH(x)  _wacom_start_fast_math(& x)
-#define END_FAST_MATH(x)  _wacom_end_fast_math(& x)
+#elif defined(__WATCOMC__) && defined(__386__)
+#define DEFAULT_X86_FPU                0x037f /* See GCC comments above */
+#define FAST_X86_FPU           0x003f /* See GCC comments above */
+void _watcom_start_fast_math(unsigned short *x,unsigned short *mask);
+#pragma aux _watcom_start_fast_math =                                   \
+   "fnstcw  word ptr [eax]"                                             \
+   "fldcw   word ptr [ecx]"                                             \
+   parm [eax] [ecx]                                                     \
+   modify exact [];
+void _watcom_end_fast_math(unsigned short *x);
+#pragma aux _watcom_end_fast_math =                                     \
+   "fnclex"                                                             \
+   "fldcw   word ptr [eax]"                                             \
+   parm [eax]                                                           \
+   modify exact [];
+#if defined(NO_FAST_MATH)
+#define START_FAST_MATH(x)                                              \
+do {                                                                    \
+   static GLushort mask = DEFAULT_X86_FPU;                                 \
+   _watcom_start_fast_math(&x,&mask);                                   \
+} while (0)
+#else
+#define START_FAST_MATH(x)                                              \
+do {                                                                    \
+   static GLushort mask = FAST_X86_FPU;                                 \
+   _watcom_start_fast_math(&x,&mask);                                   \
+} while (0)
+#endif
+#define END_FAST_MATH(x)  _watcom_end_fast_math(&x)
 #else
 #define START_FAST_MATH(x)  x = 0
 #define END_FAST_MATH(x)  (void)(x)
@@ -556,6 +685,9 @@ _mesa_align_calloc( size_t bytes, unsigned long alignment );
 extern void
 _mesa_align_free( void *ptr );
 
+extern void *
+_mesa_realloc( void *oldBuffer, size_t oldSize, size_t newSize );
+
 extern void *
 _mesa_memcpy( void *dest, const void *src, size_t n );
 
@@ -581,6 +713,9 @@ _mesa_sqrtd(double x);
 extern float
 _mesa_sqrtf(float x);
 
+extern float
+_mesa_inv_sqrtf(float x);
+
 extern double
 _mesa_pow(double x, double y);
 
@@ -590,6 +725,12 @@ _mesa_log2(float x);
 extern unsigned int
 _mesa_bitcount(unsigned int n);
 
+extern GLhalfARB
+_mesa_float_to_half(float f);
+
+extern float
+_mesa_half_to_float(GLhalfARB h);
+
 
 extern char *
 _mesa_getenv( const char *var );
@@ -648,5 +789,9 @@ extern void
 _mesa_init_default_imports( __GLimports *imports, void *driverCtx );
 
 
-#endif /* IMPORTS_H */
+#ifdef __cplusplus
+}
+#endif
+
 
+#endif /* IMPORTS_H */