2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2008 Brian Paul All Rights Reserved.
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:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
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.
27 * This file manages the OpenGL API dispatch layer.
28 * The dispatch table (struct _glapi_table) is basically just a list
29 * of function pointers.
30 * There are functions to set/get the current dispatch table for the
31 * current thread and to manage registration/dispatch of dynamically
32 * added extension functions.
34 * It's intended that this file and the other glapi*.[ch] files are
35 * flexible enough to be reused in several places: XFree86, DRI-
36 * based libGL.so, and perhaps the SGI SI.
38 * NOTE: There are no dependencies on Mesa in this code.
40 * Versions (API changes):
41 * 2000/02/23 - original version for Mesa 3.3 and XFree86 4.0
42 * 2001/01/16 - added dispatch override feature for Mesa 3.5
43 * 2002/06/28 - added _glapi_set_warning_func(), Mesa 4.1.
44 * 2002/10/01 - _glapi_get_proc_address() will now generate new entrypoints
45 * itself (using offset ~0). _glapi_add_entrypoint() can be
46 * called afterward and it'll fill in the correct dispatch
47 * offset. This allows DRI libGL to avoid probing for DRI
48 * drivers! No changes to the public glapi interface.
53 #ifdef HAVE_DIX_CONFIG_H
55 #include <dix-config.h>
60 #include "main/glheader.h"
64 #include "main/compiler.h"
73 #include "glapioffsets.h"
74 #include "glapitable.h"
77 /***** BEGIN NO-OP DISPATCH *****/
79 static GLboolean WarnFlag
= GL_FALSE
;
80 static _glapi_warning_func warning_func
;
83 * Enable/disable printing of warning messages.
86 _glapi_noop_enable_warnings(GLboolean enable
)
92 * Register a callback function for reporting errors.
95 _glapi_set_warning_func( _glapi_warning_func func
)
103 #if !defined(_WIN32_WCE)
104 if ((WarnFlag
|| getenv("MESA_DEBUG") || getenv("LIBGL_DEBUG"))
117 #define KEYWORD1 static
118 #define KEYWORD1_ALT static
119 #define KEYWORD2 GLAPIENTRY
120 #define NAME(func) NoOp##func
124 #define DISPATCH(func, args, msg) \
126 warning_func(NULL, "GL User Error: called without context: %s", #func); \
129 #define RETURN_DISPATCH(func, args, msg) \
131 warning_func(NULL, "GL User Error: called without context: %s", #func); \
135 #define DISPATCH_TABLE_NAME __glapi_noop_table
136 #define UNUSED_TABLE_NAME __unused_noop_functions
138 #define TABLE_ENTRY(name) (_glapi_proc) NoOp##name
140 static GLint
NoOpUnused(void)
143 warning_func(NULL
, "GL User Error: calling extension function without a current context\n");
148 #include "glapitemp.h"
150 /***** END NO-OP DISPATCH *****/
155 * \name Current dispatch and current context control variables
157 * Depending on whether or not multithreading is support, and the type of
158 * support available, several variables are used to store the current context
159 * pointer and the current dispatch table pointer. In the non-threaded case,
160 * the variables \c _glapi_Dispatch and \c _glapi_Context are used for this
163 * In the "normal" threaded case, the variables \c _glapi_Dispatch and
164 * \c _glapi_Context will be \c NULL if an application is detected as being
165 * multithreaded. Single-threaded applications will use \c _glapi_Dispatch
166 * and \c _glapi_Context just like the case without any threading support.
167 * When \c _glapi_Dispatch and \c _glapi_Context are \c NULL, the thread state
168 * data \c _gl_DispatchTSD and \c ContextTSD are used. Drivers and the
169 * static dispatch functions access these variables via \c _glapi_get_dispatch
170 * and \c _glapi_get_context.
172 * There is a race condition in setting \c _glapi_Dispatch to \c NULL. It is
173 * possible for the original thread to be setting it at the same instant a new
174 * thread, perhaps running on a different processor, is clearing it. Because
175 * of that, \c ThreadSafe, which can only ever be changed to \c GL_TRUE, is
176 * used to determine whether or not the application is multithreaded.
178 * In the TLS case, the variables \c _glapi_Dispatch and \c _glapi_Context are
179 * hardcoded to \c NULL. Instead the TLS variables \c _glapi_tls_Dispatch and
180 * \c _glapi_tls_Context are used. Having \c _glapi_Dispatch and
181 * \c _glapi_Context be hardcoded to \c NULL maintains binary compatability
182 * between TLS enabled loaders and non-TLS DRI drivers.
185 #if defined(GLX_USE_TLS)
187 PUBLIC __thread
struct _glapi_table
* _glapi_tls_Dispatch
188 __attribute__((tls_model("initial-exec")))
189 = (struct _glapi_table
*) __glapi_noop_table
;
191 PUBLIC __thread
void * _glapi_tls_Context
192 __attribute__((tls_model("initial-exec")));
194 PUBLIC
const struct _glapi_table
*_glapi_Dispatch
= NULL
;
195 PUBLIC
const void *_glapi_Context
= NULL
;
202 /* _glthread_DECLARE_STATIC_MUTEX is broken on windows. There will be race! */
203 #define CHECK_MULTITHREAD_LOCK()
204 #define CHECK_MULTITHREAD_UNLOCK()
206 _glthread_DECLARE_STATIC_MUTEX(ThreadCheckMutex
);
207 #define CHECK_MULTITHREAD_LOCK() _glthread_LOCK_MUTEX(ThreadCheckMutex)
208 #define CHECK_MULTITHREAD_UNLOCK() _glthread_UNLOCK_MUTEX(ThreadCheckMutex)
211 static GLboolean ThreadSafe
= GL_FALSE
; /**< In thread-safe mode? */
212 _glthread_TSD _gl_DispatchTSD
; /**< Per-thread dispatch pointer */
213 static _glthread_TSD ContextTSD
; /**< Per-thread context pointer */
215 #if defined(WIN32_THREADS)
216 void FreeTSD(_glthread_TSD
*p
);
217 void FreeAllTSD(void)
219 FreeTSD(&_gl_DispatchTSD
);
220 FreeTSD(&ContextTSD
);
222 #endif /* defined(WIN32_THREADS) */
224 #endif /* defined(THREADS) */
226 PUBLIC
struct _glapi_table
*_glapi_Dispatch
=
227 (struct _glapi_table
*) __glapi_noop_table
;
228 PUBLIC
void *_glapi_Context
= NULL
;
230 #endif /* defined(GLX_USE_TLS) */
237 * We should call this periodically from a function such as glXMakeCurrent
238 * in order to test if multiple threads are being used.
241 _glapi_check_multithread(void)
243 #if defined(THREADS) && !defined(GLX_USE_TLS)
244 static unsigned long knownID
;
245 static GLboolean firstCall
= GL_TRUE
;
250 CHECK_MULTITHREAD_LOCK();
252 /* initialize TSDs */
253 (void) _glthread_GetTSD(&ContextTSD
);
254 (void) _glthread_GetTSD(&_gl_DispatchTSD
);
256 knownID
= _glthread_GetID();
257 firstCall
= GL_FALSE
;
259 else if (knownID
!= _glthread_GetID()) {
260 ThreadSafe
= GL_TRUE
;
261 _glapi_set_dispatch(NULL
);
262 _glapi_set_context(NULL
);
264 CHECK_MULTITHREAD_UNLOCK();
271 * Set the current context pointer for this thread.
272 * The context pointer is an opaque type which should be cast to
273 * void from the real context pointer type.
276 _glapi_set_context(void *context
)
278 (void) __unused_noop_functions
; /* silence a warning */
279 #if defined(GLX_USE_TLS)
280 _glapi_tls_Context
= context
;
281 #elif defined(THREADS)
282 _glthread_SetTSD(&ContextTSD
, context
);
283 _glapi_Context
= (ThreadSafe
) ? NULL
: context
;
285 _glapi_Context
= context
;
292 * Get the current context pointer for this thread.
293 * The context pointer is an opaque type which should be cast from
294 * void to the real context pointer type.
297 _glapi_get_context(void)
299 #if defined(GLX_USE_TLS)
300 return _glapi_tls_Context
;
301 #elif defined(THREADS)
303 return _glthread_GetTSD(&ContextTSD
);
306 return _glapi_Context
;
309 return _glapi_Context
;
315 #if defined( GLX_USE_TLS )
316 extern GLubyte gl_dispatch_functions_start
[];
317 extern GLubyte gl_dispatch_functions_end
[];
319 extern const GLubyte gl_dispatch_functions_start
[];
322 #endif /* USE_X86_ASM */
325 #if defined(USE_X64_64_ASM) && defined(GLX_USE_TLS)
326 # define DISPATCH_FUNCTION_SIZE 16
327 #elif defined(USE_X86_ASM)
328 # if defined(THREADS) && !defined(GLX_USE_TLS)
329 # define DISPATCH_FUNCTION_SIZE 32
331 # define DISPATCH_FUNCTION_SIZE 16
337 extern unsigned int __glapi_sparc_tls_stub
;
339 extern unsigned int __glapi_sparc_pthread_stub
;
343 #if !defined(DISPATCH_FUNCTION_SIZE) && !defined(XFree86Server) && !defined(XGLServer)
344 # define NEED_FUNCTION_POINTER
347 #if defined(PTHREADS) || defined(GLX_USE_TLS)
349 * Perform platform-specific GL API entry-point fixups.
352 init_glapi_relocs( void )
354 #if defined(USE_X86_ASM) && defined(GLX_USE_TLS) && !defined(GLX_X86_READONLY_TEXT)
355 extern unsigned long _x86_get_dispatch(void);
356 char run_time_patch
[] = {
357 0x65, 0xa1, 0, 0, 0, 0 /* movl %gs:0,%eax */
359 GLuint
*offset
= (GLuint
*) &run_time_patch
[2]; /* 32-bits for x86/32 */
360 const GLubyte
* const get_disp
= (const GLubyte
*) run_time_patch
;
361 GLubyte
* curr_func
= (GLubyte
*) gl_dispatch_functions_start
;
363 *offset
= _x86_get_dispatch();
364 while ( curr_func
!= (GLubyte
*) gl_dispatch_functions_end
) {
365 (void) memcpy( curr_func
, get_disp
, sizeof(run_time_patch
));
366 curr_func
+= DISPATCH_FUNCTION_SIZE
;
370 extern void __glapi_sparc_icache_flush(unsigned int *);
371 static const unsigned int template[] = {
373 0x05000000, /* sethi %hi(_glapi_tls_Dispatch), %g2 */
374 0x8730e00a, /* srl %g3, 10, %g3 */
375 0x8410a000, /* or %g2, %lo(_glapi_tls_Dispatch), %g2 */
377 0xc259c002, /* ldx [%g7 + %g2], %g1 */
378 0xc2584003, /* ldx [%g1 + %g3], %g1 */
380 0xc201c002, /* ld [%g7 + %g2], %g1 */
381 0xc2004003, /* ld [%g1 + %g3], %g1 */
383 0x81c04000, /* jmp %g1 */
384 0x01000000, /* nop */
387 0x03000000, /* 64-bit 0x00 --> sethi %hh(_glapi_Dispatch), %g1 */
388 0x05000000, /* 64-bit 0x04 --> sethi %lm(_glapi_Dispatch), %g2 */
389 0x82106000, /* 64-bit 0x08 --> or %g1, %hm(_glapi_Dispatch), %g1 */
390 0x8730e00a, /* 64-bit 0x0c --> srl %g3, 10, %g3 */
391 0x83287020, /* 64-bit 0x10 --> sllx %g1, 32, %g1 */
392 0x82004002, /* 64-bit 0x14 --> add %g1, %g2, %g1 */
393 0xc2586000, /* 64-bit 0x18 --> ldx [%g1 + %lo(_glapi_Dispatch)], %g1 */
395 0x03000000, /* 32-bit 0x00 --> sethi %hi(_glapi_Dispatch), %g1 */
396 0x8730e00a, /* 32-bit 0x04 --> srl %g3, 10, %g3 */
397 0xc2006000, /* 32-bit 0x08 --> ld [%g1 + %lo(_glapi_Dispatch)], %g1 */
399 0x80a06000, /* --> cmp %g1, 0 */
400 0x02800005, /* --> be +4*5 */
401 0x01000000, /* --> nop */
403 0xc2584003, /* 64-bit --> ldx [%g1 + %g3], %g1 */
405 0xc2004003, /* 32-bit --> ld [%g1 + %g3], %g1 */
407 0x81c04000, /* --> jmp %g1 */
408 0x01000000, /* --> nop */
410 0x9de3bf80, /* 64-bit --> save %sp, -128, %sp */
412 0x9de3bfc0, /* 32-bit --> save %sp, -64, %sp */
414 0xa0100003, /* --> mov %g3, %l0 */
415 0x40000000, /* --> call _glapi_get_dispatch */
416 0x01000000, /* --> nop */
417 0x82100008, /* --> mov %o0, %g1 */
418 0x86100010, /* --> mov %l0, %g3 */
419 0x10bffff7, /* --> ba -4*9 */
420 0x81e80000, /* --> restore */
424 extern unsigned long __glapi_sparc_get_dispatch(void);
425 unsigned int *code
= &__glapi_sparc_tls_stub
;
426 unsigned long dispatch
= __glapi_sparc_get_dispatch();
428 unsigned int *code
= &__glapi_sparc_pthread_stub
;
429 unsigned long dispatch
= (unsigned long) &_glapi_Dispatch
;
430 unsigned long call_dest
= (unsigned long ) &_glapi_get_dispatch
;
434 #if defined(GLX_USE_TLS)
435 code
[0] = template[0] | (dispatch
>> 10);
436 code
[1] = template[1];
437 __glapi_sparc_icache_flush(&code
[0]);
438 code
[2] = template[2] | (dispatch
& 0x3ff);
439 code
[3] = template[3];
440 __glapi_sparc_icache_flush(&code
[2]);
441 code
[4] = template[4];
442 code
[5] = template[5];
443 __glapi_sparc_icache_flush(&code
[4]);
444 code
[6] = template[6];
445 __glapi_sparc_icache_flush(&code
[6]);
447 #if defined(__arch64__)
448 code
[0] = template[0] | (dispatch
>> (32 + 10));
449 code
[1] = template[1] | ((dispatch
& 0xffffffff) >> 10);
450 __glapi_sparc_icache_flush(&code
[0]);
451 code
[2] = template[2] | ((dispatch
>> 32) & 0x3ff);
452 code
[3] = template[3];
453 __glapi_sparc_icache_flush(&code
[2]);
454 code
[4] = template[4];
455 code
[5] = template[5];
456 __glapi_sparc_icache_flush(&code
[4]);
457 code
[6] = template[6] | (dispatch
& 0x3ff);
460 code
[0] = template[0] | (dispatch
>> 10);
461 code
[1] = template[1];
462 __glapi_sparc_icache_flush(&code
[0]);
463 code
[2] = template[2] | (dispatch
& 0x3ff);
466 code
[idx
+ 0] = template[idx
+ 0];
467 __glapi_sparc_icache_flush(&code
[idx
- 1]);
468 code
[idx
+ 1] = template[idx
+ 1];
469 code
[idx
+ 2] = template[idx
+ 2];
470 __glapi_sparc_icache_flush(&code
[idx
+ 1]);
471 code
[idx
+ 3] = template[idx
+ 3];
472 code
[idx
+ 4] = template[idx
+ 4];
473 __glapi_sparc_icache_flush(&code
[idx
+ 3]);
474 code
[idx
+ 5] = template[idx
+ 5];
475 code
[idx
+ 6] = template[idx
+ 6];
476 __glapi_sparc_icache_flush(&code
[idx
+ 5]);
477 code
[idx
+ 7] = template[idx
+ 7];
478 code
[idx
+ 8] = template[idx
+ 8] |
479 (((call_dest
- ((unsigned long) &code
[idx
+ 8]))
481 __glapi_sparc_icache_flush(&code
[idx
+ 7]);
482 code
[idx
+ 9] = template[idx
+ 9];
483 code
[idx
+ 10] = template[idx
+ 10];
484 __glapi_sparc_icache_flush(&code
[idx
+ 9]);
485 code
[idx
+ 11] = template[idx
+ 11];
486 code
[idx
+ 12] = template[idx
+ 12];
487 __glapi_sparc_icache_flush(&code
[idx
+ 11]);
488 code
[idx
+ 13] = template[idx
+ 13];
489 __glapi_sparc_icache_flush(&code
[idx
+ 13]);
493 #endif /* defined(PTHREADS) || defined(GLX_USE_TLS) */
497 * Set the global or per-thread dispatch table pointer.
498 * If the dispatch parameter is NULL we'll plug in the no-op dispatch
499 * table (__glapi_noop_table).
502 _glapi_set_dispatch(struct _glapi_table
*dispatch
)
504 #if defined(PTHREADS) || defined(GLX_USE_TLS)
505 static pthread_once_t once_control
= PTHREAD_ONCE_INIT
;
506 pthread_once( & once_control
, init_glapi_relocs
);
510 /* use the no-op functions */
511 dispatch
= (struct _glapi_table
*) __glapi_noop_table
;
515 _glapi_check_table(dispatch
);
519 #if defined(GLX_USE_TLS)
520 _glapi_tls_Dispatch
= dispatch
;
521 #elif defined(THREADS)
522 _glthread_SetTSD(&_gl_DispatchTSD
, (void *) dispatch
);
523 _glapi_Dispatch
= (ThreadSafe
) ? NULL
: dispatch
;
525 _glapi_Dispatch
= dispatch
;
532 * Return pointer to current dispatch table for calling thread.
534 PUBLIC
struct _glapi_table
*
535 _glapi_get_dispatch(void)
537 struct _glapi_table
* api
;
538 #if defined(GLX_USE_TLS)
539 api
= _glapi_tls_Dispatch
;
540 #elif defined(THREADS)
542 ? (struct _glapi_table
*) _glthread_GetTSD(&_gl_DispatchTSD
)
545 api
= _glapi_Dispatch
;
554 * The dispatch table size (number of entries) is the size of the
555 * _glapi_table struct plus the number of dynamic entries we can add.
556 * The extra slots can be filled in by DRI drivers that register new extension
559 #define DISPATCH_TABLE_SIZE (sizeof(struct _glapi_table) / sizeof(void *) + MAX_EXTENSION_FUNCS)
563 * Return size of dispatch table struct as number of functions (or
567 _glapi_get_dispatch_table_size(void)
569 return DISPATCH_TABLE_SIZE
;
574 * Make sure there are no NULL pointers in the given dispatch table.
575 * Intended for debugging purposes.
578 _glapi_check_table(const struct _glapi_table
*table
)
581 const GLuint entries
= _glapi_get_dispatch_table_size();
582 const void **tab
= (const void **) table
;
584 for (i
= 1; i
< entries
; i
++) {
588 /* Do some spot checks to be sure that the dispatch table
589 * slots are assigned correctly.
592 GLuint BeginOffset
= _glapi_get_proc_offset("glBegin");
593 char *BeginFunc
= (char*) &table
->Begin
;
594 GLuint offset
= (BeginFunc
- (char *) table
) / sizeof(void *);
595 assert(BeginOffset
== _gloffset_Begin
);
596 assert(BeginOffset
== offset
);
599 GLuint viewportOffset
= _glapi_get_proc_offset("glViewport");
600 char *viewportFunc
= (char*) &table
->Viewport
;
601 GLuint offset
= (viewportFunc
- (char *) table
) / sizeof(void *);
602 assert(viewportOffset
== _gloffset_Viewport
);
603 assert(viewportOffset
== offset
);
606 GLuint VertexPointerOffset
= _glapi_get_proc_offset("glVertexPointer");
607 char *VertexPointerFunc
= (char*) &table
->VertexPointer
;
608 GLuint offset
= (VertexPointerFunc
- (char *) table
) / sizeof(void *);
609 assert(VertexPointerOffset
== _gloffset_VertexPointer
);
610 assert(VertexPointerOffset
== offset
);
613 GLuint ResetMinMaxOffset
= _glapi_get_proc_offset("glResetMinmax");
614 char *ResetMinMaxFunc
= (char*) &table
->ResetMinmax
;
615 GLuint offset
= (ResetMinMaxFunc
- (char *) table
) / sizeof(void *);
616 assert(ResetMinMaxOffset
== _gloffset_ResetMinmax
);
617 assert(ResetMinMaxOffset
== offset
);
620 GLuint blendColorOffset
= _glapi_get_proc_offset("glBlendColor");
621 char *blendColorFunc
= (char*) &table
->BlendColor
;
622 GLuint offset
= (blendColorFunc
- (char *) table
) / sizeof(void *);
623 assert(blendColorOffset
== _gloffset_BlendColor
);
624 assert(blendColorOffset
== offset
);
627 GLuint secondaryColor3fOffset
= _glapi_get_proc_offset("glSecondaryColor3fEXT");
628 char *secondaryColor3fFunc
= (char*) &table
->SecondaryColor3fEXT
;
629 GLuint offset
= (secondaryColor3fFunc
- (char *) table
) / sizeof(void *);
630 assert(secondaryColor3fOffset
== _gloffset_SecondaryColor3fEXT
);
631 assert(secondaryColor3fOffset
== offset
);
634 GLuint pointParameterivOffset
= _glapi_get_proc_offset("glPointParameterivNV");
635 char *pointParameterivFunc
= (char*) &table
->PointParameterivNV
;
636 GLuint offset
= (pointParameterivFunc
- (char *) table
) / sizeof(void *);
637 assert(pointParameterivOffset
== _gloffset_PointParameterivNV
);
638 assert(pointParameterivOffset
== offset
);
641 GLuint setFenceOffset
= _glapi_get_proc_offset("glSetFenceNV");
642 char *setFenceFunc
= (char*) &table
->SetFenceNV
;
643 GLuint offset
= (setFenceFunc
- (char *) table
) / sizeof(void *);
644 assert(setFenceOffset
== _gloffset_SetFenceNV
);
645 assert(setFenceOffset
== offset
);