mesa: new _mesa_valid_to_render() function
[mesa.git] / src / mesa / glapi / glthread.h
index 600a7616823cd930376b8ca08c290e6086aaeca2..8ec933a85148fef41efcac5e10db9c263ff771fb 100644 (file)
@@ -1,21 +1,19 @@
-/* $Id: glthread.h,v 1.2 2000/01/31 23:10:47 brianp Exp $ */
-
 /*
  * Mesa 3-D graphics library
- * Version:  3.3
- * 
- * Copyright (C) 1999  Brian Paul   All Rights Reserved.
- * 
+ * Version:  6.5.2
+ *
+ * Copyright (C) 1999-2006  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"),
  * to deal in the Software without restriction, including without limitation
  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  * and/or sell copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included
  * in all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  *                and Christoph Poliwoda (poliwoda@volumegraphics.com)
  * Revised by Keith Whitwell
  * Adapted for new gl dispatcher by Brian Paul
+ *
+ *
+ *
+ * DOCUMENTATION
+ *
+ * This thread module exports the following types:
+ *   _glthread_TSD     Thread-specific data area
+ *   _glthread_Thread  Thread datatype
+ *   _glthread_Mutex   Mutual exclusion lock
+ *
+ * Macros:
+ *   _glthread_DECLARE_STATIC_MUTEX(name)   Declare a non-local mutex
+ *   _glthread_INIT_MUTEX(name)             Initialize a mutex
+ *   _glthread_LOCK_MUTEX(name)             Lock a mutex
+ *   _glthread_UNLOCK_MUTEX(name)           Unlock a mutex
+ *
+ * Functions:
+ *   _glthread_GetID(v)      Get integer thread ID
+ *   _glthread_InitTSD()     Initialize thread-specific data
+ *   _glthread_GetTSD()      Get thread-specific data
+ *   _glthread_SetTSD()      Set thread-specific data
+ *
  */
 
-#ifndef GLTHREAD_H
-#define GLTHREAD_H
-
-
 /*
- * If this file is accidentally included by a non-threaded build, 
+ * If this file is accidentally included by a non-threaded build,
  * it should not cause the build to fail, or otherwise cause problems.
  * In general, it should only be included when needed however.
  */
-#ifdef THREADS
-/*
- * It is an error not to select a specific threads API when compiling.
- */
-#if !defined(PTHREADS) && !defined(SOLARIS_THREADS) && !defined(WIN32)
-#error One of PTHREADS, SOLARIS_THREADS or WIN32 must be defined.
+
+#ifndef GLTHREAD_H
+#define GLTHREAD_H
+
+
+#if defined(USE_MGL_NAMESPACE)
+#define _glapi_Dispatch _mglapi_Dispatch
 #endif
 
 
 
+#if (defined(PTHREADS) || defined(SOLARIS_THREADS) ||\
+     defined(WIN32_THREADS) || defined(BEOS_THREADS)) \
+    && !defined(THREADS)
+# define THREADS
+#endif
+
+#ifdef VMS
+#include <GL/vms_x_fix.h>
+#endif
+
 /*
  * POSIX threads. This should be your choice in the Unix world
  * whenever possible.  When building with POSIX threads, be sure
  * compiler flag.  On Solaris with gcc, use -D_REENTRANT to enable
  * proper compiling for MT-safe libc etc.
  */
-#ifdef PTHREADS
+#if defined(PTHREADS)
 #include <pthread.h> /* POSIX threads headers */
 
 typedef struct {
    pthread_key_t  key;
-   pthread_once_t once;
+   int initMagic;
 } _glthread_TSD;
 
 typedef pthread_t _glthread_Thread;
@@ -80,21 +107,64 @@ typedef pthread_mutex_t _glthread_Mutex;
 #define _glthread_INIT_MUTEX(name) \
    pthread_mutex_init(&(name), NULL)
 
+#define _glthread_DESTROY_MUTEX(name) \
+   pthread_mutex_destroy(&(name))
+
 #define _glthread_LOCK_MUTEX(name) \
    (void) pthread_mutex_lock(&(name))
 
 #define _glthread_UNLOCK_MUTEX(name) \
    (void) pthread_mutex_unlock(&(name))
 
-#endif /* PTHREADS */
+typedef pthread_cond_t _glthread_Cond;
+
+#define _glthread_DECLARE_STATIC_COND(name) \
+   static _glthread_Cond name = PTHREAD_COND_INITIALIZER
+
+#define _glthread_INIT_COND(cond)                      \
+   pthread_cond_init(&(cond), NULL)
+
+#define _glthread_DESTROY_COND(name) \
+   pthread_cond_destroy(&(name))
+
+#define _glthread_COND_WAIT(cond, mutex) \
+  pthread_cond_wait(&(cond), &(mutex))
+
+#define _glthread_COND_SIGNAL(cond) \
+  pthread_cond_signal(&(cond))
+
+#define _glthread_COND_BROADCAST(cond) \
+  pthread_cond_broadcast(&(cond))
+
+
+#else /* PTHREADS */
 
+typedef unsigned int _glthread_Cond;
+#define _glthread_DECLARE_STATIC_COND(name) \
+//  #warning Condition variables not implemented.
 
+#define _glthread_INIT_COND(cond)          \
+  ASSERT(0);
+
+#define _glthread_DESTROY_COND(name) \
+  ASSERT(0);
+
+#define _glthread_COND_WAIT(cond, mutex) \
+  ASSERT(0);
+
+#define _glthread_COND_SIGNAL(cond) \
+  ASSERT(0);
+
+#define _glthread_COND_BROADCAST(cond) \
+  ASSERT(0);
+
+#endif
 
 
 /*
- * Solaris threads. Use only up to Solaris 2.4. 
+ * Solaris threads. Use only up to Solaris 2.4.
  * Solaris 2.5 and higher provide POSIX threads.
- * Be sure to compile with -mt on the Solaris compilers, or 
+ * Be sure to compile with -mt on the Solaris compilers, or
  * use -D_REENTRANT if using gcc.
  */
 #ifdef SOLARIS_THREADS
@@ -103,7 +173,7 @@ typedef pthread_mutex_t _glthread_Mutex;
 typedef struct {
    thread_key_t key;
    mutex_t      keylock;
-   int          initfuncCalled;
+   int          initMagic;
 } _glthread_TSD;
 
 typedef thread_t _glthread_Thread;
@@ -113,6 +183,7 @@ typedef mutex_t _glthread_Mutex;
 /* XXX need to really implement mutex-related macros */
 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 #define _glthread_INIT_MUTEX(name)  (void) name
+#define _glthread_DESTROY_MUTEX(name) (void) name
 #define _glthread_LOCK_MUTEX(name)  (void) name
 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 
@@ -122,79 +193,141 @@ typedef mutex_t _glthread_Mutex;
 
 
 /*
- * Windows threads. Should work with Windows NT and 95. 
+ * Windows threads. Should work with Windows NT and 95.
  * IMPORTANT: Link with multithreaded runtime library when THREADS are
  * used!
  */
-
-#ifdef WIN32
+#ifdef WIN32_THREADS
 #include <windows.h>
 
 typedef struct {
    DWORD key;
-   int   initfuncCalled;
+   int   initMagic;
 } _glthread_TSD;
 
 typedef HANDLE _glthread_Thread;
 
 typedef CRITICAL_SECTION _glthread_Mutex;
 
-/* XXX need to really implement mutex-related macros */
-#define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
-#define _glthread_INIT_MUTEX(name)  (void) name
-#define _glthread_LOCK_MUTEX(name)  (void) name
-#define _glthread_UNLOCK_MUTEX(name)  (void) name
-
-#endif /* WIN32 */
-
-
+#define _glthread_DECLARE_STATIC_MUTEX(name)  /*static*/ _glthread_Mutex name = {0,0,0,0,0,0}
+#define _glthread_INIT_MUTEX(name)  InitializeCriticalSection(&name)
+#define _glthread_DESTROY_MUTEX(name)  DeleteCriticalSection(&name)
+#define _glthread_LOCK_MUTEX(name)  EnterCriticalSection(&name)
+#define _glthread_UNLOCK_MUTEX(name)  LeaveCriticalSection(&name)
 
+#endif /* WIN32_THREADS */
 
 
 /*
- * Platform independent thread specific data API. 
+ * BeOS threads. R5.x required.
  */
+#ifdef BEOS_THREADS
 
-extern unsigned long
-_glthread_GetID(void);
+/* Problem with OS.h and this file on haiku */
+#ifndef __HAIKU__
+#include <kernel/OS.h>
+#endif
 
+#include <support/TLS.h>
 
-extern void
-_glthread_InitTSD(_glthread_TSD *);
+/* The only two typedefs required here
+ * this is cause of the OS.h problem
+ */
+#ifdef __HAIKU__
+typedef int32 thread_id;
+typedef int32 sem_id;
+#endif
 
+typedef struct {
+   int32        key;
+   int          initMagic;
+} _glthread_TSD;
 
-extern void *
-_glthread_GetTSD(_glthread_TSD *);
+typedef thread_id _glthread_Thread;
 
+/* Use Benaphore, aka speeder semaphore */
+typedef struct {
+    int32   lock;
+    sem_id  sem;
+} benaphore;
+typedef benaphore _glthread_Mutex;
 
-extern void
-_glthread_SetTSD(_glthread_TSD *, void *, void (*initfunc)(void));
+#define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = { 0, 0 }
+#define _glthread_INIT_MUTEX(name)     name.sem = create_sem(0, #name"_benaphore"), name.lock = 0
+#define _glthread_DESTROY_MUTEX(name)  delete_sem(name.sem), name.lock = 0
+#define _glthread_LOCK_MUTEX(name)     if (name.sem == 0) _glthread_INIT_MUTEX(name); \
+                                                                               if (atomic_add(&(name.lock), 1) >= 1) acquire_sem(name.sem)
+#define _glthread_UNLOCK_MUTEX(name)   if (atomic_add(&(name.lock), -1) > 1) release_sem(name.sem)
 
+#endif /* BEOS_THREADS */
 
 
-#else /* THREADS */
 
+#ifndef THREADS
 
 /*
  * THREADS not defined
  */
 
-typedef GLuint _glthread_TSD;
+typedef unsigned _glthread_TSD;
 
-typedef GLuint _glthread_Thread;
+typedef unsigned _glthread_Thread;
 
-typedef GLuint _glthread_Mutex;
+typedef unsigned _glthread_Mutex;
 
 #define _glthread_DECLARE_STATIC_MUTEX(name)  static _glthread_Mutex name = 0
 
 #define _glthread_INIT_MUTEX(name)  (void) name
 
+#define _glthread_DESTROY_MUTEX(name)  (void) name
+
 #define _glthread_LOCK_MUTEX(name)  (void) name
 
 #define _glthread_UNLOCK_MUTEX(name)  (void) name
 
-
 #endif /* THREADS */
 
-#endif /* THREADS_H */
 
+
+/*
+ * Platform independent thread specific data API.
+ */
+
+extern unsigned long
+_glthread_GetID(void);
+
+
+extern void
+_glthread_InitTSD(_glthread_TSD *);
+
+
+extern void *
+_glthread_GetTSD(_glthread_TSD *);
+
+
+extern void
+_glthread_SetTSD(_glthread_TSD *, void *);
+
+#if !defined __GNUC__ || __GNUC__ < 3
+#  define __builtin_expect(x, y) x
+#endif
+
+#if defined(GLX_USE_TLS)
+
+extern __thread struct _glapi_table * _glapi_tls_Dispatch
+    __attribute__((tls_model("initial-exec")));
+
+#define GET_DISPATCH() _glapi_tls_Dispatch
+
+#elif !defined(GL_CALL)
+# if defined(THREADS)
+#  define GET_DISPATCH() \
+   ((__builtin_expect( _glapi_Dispatch != NULL, 1 )) \
+       ? _glapi_Dispatch : _glapi_get_dispatch())
+# else
+#  define GET_DISPATCH() _glapi_Dispatch
+# endif /* defined(THREADS) */
+#endif  /* ndef GL_CALL */
+
+
+#endif /* THREADS_H */