src/mesa/glapi/glapi.h

   1 /*
   2  * Mesa 3-D graphics library
   3  * Version:  7.1
   4  *
   5  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a
   8  * copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation
  10  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  11  * and/or sell copies of the Software, and to permit persons to whom the
  12  * Software is furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included
  15  * in all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  21  * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \mainpage Mesa GL API Module
  28  *
  29  * \section GLAPIIntroduction Introduction
  30  *
  31  * The Mesa GL API module is responsible for dispatching all the
  32  * gl*() functions.  All GL functions are dispatched by jumping through
  33  * the current dispatch table (basically a struct full of function
  34  * pointers.)
  35  *
  36  * A per-thread current dispatch table and per-thread current context
  37  * pointer are managed by this module too.
  38  *
  39  * This module is intended to be non-Mesa-specific so it can be used
  40  * with the X/DRI libGL also.
  41  */
  42
  43
  44 #ifndef _GLAPI_H
  45 #define _GLAPI_H
  46
  47 #include "glthread.h"
  48
  49
  50 struct _glapi_table;
  51
  52 typedef void (*_glapi_proc)(void); /* generic function pointer */
  53
  54
  55 #if defined(USE_MGL_NAMESPACE)
  56 #define _glapi_set_dispatch _mglapi_set_dispatch
  57 #define _glapi_get_dispatch _mglapi_get_dispatch
  58 #define _glapi_set_context _mglapi_set_context
  59 #define _glapi_get_context _mglapi_get_context
  60 #define _glapi_Dispatch _mglapi_Dispatch
  61 #define _glapi_Context _mglapi_Context
  62 #endif
  63
  64
  65 #if defined(__GNUC__)
  66 #  define likely(x)   __builtin_expect(!!(x), 1)
  67 #  define unlikely(x) __builtin_expect(!!(x), 0)
  68 #else
  69 #  define likely(x)   (x)
  70 #  define unlikely(x) (x)
  71 #endif
  72
  73
  74 /**
  75  ** Define the GET_DISPATCH() and GET_CURRENT_CONTEXT() macros.
  76  **
  77  ** \param C local variable which will hold the current context.
  78  **/
  79 #if defined (GLX_USE_TLS)
  80
  81 extern const struct _glapi_table *_glapi_Dispatch;
  82
  83 extern const void *_glapi_Context;
  84
  85 extern __thread struct _glapi_table * _glapi_tls_Dispatch
  86     __attribute__((tls_model("initial-exec")));
  87
  88 extern __thread void * _glapi_tls_Context
  89     __attribute__((tls_model("initial-exec")));
  90
  91 # define GET_DISPATCH() _glapi_tls_Dispatch
  92
  93 # define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_tls_Context
  94
  95 #else
  96
  97 extern struct _glapi_table *_glapi_Dispatch;
  98
  99 extern void *_glapi_Context;
 100
 101 # ifdef THREADS
 102
 103 #  define GET_DISPATCH() \
 104      (likely(_glapi_Dispatch) ? _glapi_Dispatch : _glapi_get_dispatch())
 105
 106 #  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) \
 107      (likely(_glapi_Context) ? _glapi_Context : _glapi_get_context())
 108
 109 # else
 110
 111 #  define GET_DISPATCH() _glapi_Dispatch
 112
 113 #  define GET_CURRENT_CONTEXT(C)  GLcontext *C = (GLcontext *) _glapi_Context
 114
 115 # endif
 116
 117 #endif /* defined (GLX_USE_TLS) */
 118
 119
 120 /**
 121  ** GL API public functions
 122  **/
 123
 124 extern void
 125 _glapi_init_multithread(void);
 126
 127
 128 extern void
 129 _glapi_destroy_multithread(void);
 130
 131
 132 extern void
 133 _glapi_check_multithread(void);
 134
 135
 136 extern void
 137 _glapi_set_context(void *context);
 138
 139
 140 extern void *
 141 _glapi_get_context(void);
 142
 143
 144 extern void
 145 _glapi_set_dispatch(struct _glapi_table *dispatch);
 146
 147
 148 extern struct _glapi_table *
 149 _glapi_get_dispatch(void);
 150
 151
 152 extern unsigned int
 153 _glapi_get_dispatch_table_size(void);
 154
 155
 156 extern int
 157 _glapi_add_dispatch( const char * const * function_names,
 158                      const char * parameter_signature );
 159
 160 extern int
 161 _glapi_get_proc_offset(const char *funcName);
 162
 163
 164 extern _glapi_proc
 165 _glapi_get_proc_address(const char *funcName);
 166
 167
 168 extern const char *
 169 _glapi_get_proc_name(unsigned int offset);
 170
 171
 172 #endif