2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2003 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.
55 #include "glapioffsets.h"
56 #include "glapitable.h"
59 /***** BEGIN NO-OP DISPATCH *****/
61 static GLboolean WarnFlag
= GL_FALSE
;
62 static _glapi_warning_func warning_func
;
64 static void init_glapi_relocs(void);
66 static _glapi_proc
generate_entrypoint(GLuint functionOffset
);
67 static void fill_in_entrypoint_offset(_glapi_proc entrypoint
, GLuint offset
);
70 * Enable/disable printing of warning messages.
73 _glapi_noop_enable_warnings(GLboolean enable
)
79 * Register a callback function for reporting errors.
82 _glapi_set_warning_func( _glapi_warning_func func
)
90 if ((WarnFlag
|| getenv("MESA_DEBUG") || getenv("LIBGL_DEBUG"))
100 #define KEYWORD1 static
101 #define KEYWORD2 GLAPIENTRY
102 #define NAME(func) NoOp##func
106 #define DISPATCH(func, args, msg) \
108 warning_func(NULL, "GL User Error: called without context: %s", #func); \
111 #define RETURN_DISPATCH(func, args, msg) \
113 warning_func(NULL, "GL User Error: called without context: %s", #func); \
117 #define DISPATCH_TABLE_NAME __glapi_noop_table
118 #define UNUSED_TABLE_NAME __unused_noop_functions
120 #define TABLE_ENTRY(name) (_glapi_proc) NoOp##name
122 static GLint
NoOpUnused(void)
125 warning_func(NULL
, "GL User Error: calling extension function without a current context\n");
130 #include "glapitemp.h"
132 /***** END NO-OP DISPATCH *****/
136 /***** BEGIN THREAD-SAFE DISPATCH *****/
140 #if defined(GLX_USE_TLS)
142 __thread
struct _glapi_table
* _glapi_tls_Dispatch
143 __attribute__((tls_model("initial-exec")))
144 = (struct _glapi_table
*) __glapi_noop_table
;
146 static __thread
struct _glapi_table
* _glapi_tls_RealDispatch
147 __attribute__((tls_model("initial-exec")))
148 = (struct _glapi_table
*) __glapi_noop_table
;
150 __thread
void * _glapi_tls_Context
151 __attribute__((tls_model("initial-exec")));
154 * Legacy per-thread dispatch pointer. This is only needed to support
155 * non-TLS DRI drivers.
158 _glthread_TSD _gl_DispatchTSD
;
163 * \name Multi-threaded control support variables
165 * If thread-safety is supported, there are two potential mechanisms that can
166 * be used. The old-style mechanism would set \c _glapi_Dispatch to a special
167 * thread-safe dispatch table. These dispatch routines would call
168 * \c _glapi_get_dispatch to get the actual dispatch pointer. In this
169 * setup \c _glapi_Dispatch could never be \c NULL. This dual layered
170 * dispatch setup performed great for single-threaded apps, but didn't
171 * perform well for multithreaded apps.
173 * In the new mechansim, there are two variables. The first is
174 * \c _glapi_DispatchTSD. In the single-threaded case, this variable points
175 * to the dispatch table. In the multi-threaded case, this variable is
176 * \c NULL, and thread-specific variable \c _gl_DispatchTSD points to the
177 * actual dispatch table. \c _glapi_DispatchTSD is used to signal to the
178 * static dispatch functions to call \c _glapi_get_dispatch to get the real
181 * There is a race condition in setting \c _glapi_DispatchTSD to \c NULL.
182 * It is possible for the original thread to be setting it at the same instant
183 * a new thread, perhaps running on a different processor, is clearing it.
184 * Because of that, \c ThreadSafe, which can only ever be changed to
185 * \c GL_TRUE, is used to determine whether or not the application is
189 static GLboolean ThreadSafe
= GL_FALSE
; /**< In thread-safe mode? */
190 _glthread_TSD _gl_DispatchTSD
; /**< Per-thread dispatch pointer */
191 static _glthread_TSD RealDispatchTSD
; /**< only when using override */
192 static _glthread_TSD ContextTSD
; /**< Per-thread context pointer */
195 #endif /* defined(GLX_USE_TLS) */
197 #define DISPATCH_TABLE_NAME __glapi_threadsafe_table
198 #define UNUSED_TABLE_NAME __unused_threadsafe_functions
200 #define TABLE_ENTRY(name) (_glapi_proc) gl##name
202 static GLint
glUnused(void)
207 #include "glapitemp.h"
211 /***** END THREAD-SAFE DISPATCH *****/
214 #if defined(GLX_USE_TLS)
217 * \name Old dispatch pointers
219 * Very old DRI based drivers assume that \c _glapi_Dispatch will never be
220 * \c NULL. Becuase of that, special "thread-safe" dispatch functions are
221 * needed here. Slightly more recent drivers detect the multi-threaded case
222 * by \c _glapi_DispatchTSD being \c NULL.
227 * \c _glapi_RealDispatch does not exist in TLS builds. I don't think it was
228 * ever used outside libGL.so, so this should be safe.
231 PUBLIC
const struct _glapi_table
*_glapi_Dispatch
= (struct _glapi_table
*) __glapi_threadsafe_table
;
232 PUBLIC
const struct _glapi_table
*_glapi_DispatchTSD
= NULL
;
233 PUBLIC
const void *_glapi_Context
= NULL
;
238 PUBLIC
struct _glapi_table
*_glapi_Dispatch
= (struct _glapi_table
*) __glapi_noop_table
;
239 #if defined( THREADS )
240 PUBLIC
struct _glapi_table
*_glapi_DispatchTSD
= (struct _glapi_table
*) __glapi_noop_table
;
242 PUBLIC
struct _glapi_table
*_glapi_RealDispatch
= (struct _glapi_table
*) __glapi_noop_table
;
244 /* Used when thread safety disabled */
245 PUBLIC
void *_glapi_Context
= NULL
;
247 #endif /* defined(GLX_USE_TLS) */
250 static GLboolean DispatchOverride
= GL_FALSE
;
255 * strdup() is actually not a standard ANSI C or POSIX routine.
256 * Irix will not define it if ANSI mode is in effect.
259 str_dup(const char *str
)
262 copy
= (char*) malloc(strlen(str
) + 1);
272 * We should call this periodically from a function such as glXMakeCurrent
273 * in order to test if multiple threads are being used.
276 _glapi_check_multithread(void)
278 #if defined(THREADS) && !defined(GLX_USE_TLS)
280 static unsigned long knownID
;
281 static GLboolean firstCall
= GL_TRUE
;
283 knownID
= _glthread_GetID();
284 firstCall
= GL_FALSE
;
286 else if (knownID
!= _glthread_GetID()) {
287 ThreadSafe
= GL_TRUE
;
288 _glapi_set_dispatch(NULL
);
291 else if (!_glapi_get_dispatch()) {
292 /* make sure that this thread's dispatch pointer isn't null */
293 _glapi_set_dispatch(NULL
);
301 * Set the current context pointer for this thread.
302 * The context pointer is an opaque type which should be cast to
303 * void from the real context pointer type.
306 _glapi_set_context(void *context
)
308 (void) __unused_noop_functions
; /* silence a warning */
309 #if defined(GLX_USE_TLS)
310 _glapi_tls_Context
= context
;
311 #elif defined(THREADS)
312 (void) __unused_threadsafe_functions
; /* silence a warning */
313 _glthread_SetTSD(&ContextTSD
, context
);
314 _glapi_Context
= (ThreadSafe
) ? NULL
: context
;
316 _glapi_Context
= context
;
323 * Get the current context pointer for this thread.
324 * The context pointer is an opaque type which should be cast from
325 * void to the real context pointer type.
328 _glapi_get_context(void)
330 #if defined(GLX_USE_TLS)
331 return _glapi_tls_Context
;
332 #elif defined(THREADS)
334 return _glthread_GetTSD(&ContextTSD
);
337 return _glapi_Context
;
340 return _glapi_Context
;
347 * Set the global or per-thread dispatch table pointer.
350 _glapi_set_dispatch(struct _glapi_table
*dispatch
)
352 #if defined(PTHREADS) || defined(GLX_USE_TLS)
353 static pthread_once_t once_control
= PTHREAD_ONCE_INIT
;
356 pthread_once( & once_control
, init_glapi_relocs
);
360 /* use the no-op functions */
361 dispatch
= (struct _glapi_table
*) __glapi_noop_table
;
365 _glapi_check_table(dispatch
);
369 #if defined(GLX_USE_TLS)
370 if (DispatchOverride
) {
371 _glapi_tls_RealDispatch
= dispatch
;
374 _glthread_SetTSD(&_gl_DispatchTSD
, (void *) dispatch
);
375 _glapi_tls_Dispatch
= dispatch
;
377 #elif defined(THREADS)
378 if (DispatchOverride
) {
379 _glthread_SetTSD(&RealDispatchTSD
, (void *) dispatch
);
381 _glapi_RealDispatch
= (struct _glapi_table
*) __glapi_threadsafe_table
;
383 _glapi_RealDispatch
= dispatch
;
386 /* normal operation */
387 _glthread_SetTSD(&_gl_DispatchTSD
, (void *) dispatch
);
389 _glapi_Dispatch
= (struct _glapi_table
*) __glapi_threadsafe_table
;
390 _glapi_DispatchTSD
= NULL
;
393 _glapi_Dispatch
= dispatch
;
394 _glapi_DispatchTSD
= dispatch
;
398 if (DispatchOverride
) {
399 _glapi_RealDispatch
= dispatch
;
402 _glapi_Dispatch
= dispatch
;
410 * Return pointer to current dispatch table for calling thread.
412 PUBLIC
struct _glapi_table
*
413 _glapi_get_dispatch(void)
415 #if defined(GLX_USE_TLS)
416 struct _glapi_table
* api
= (DispatchOverride
)
417 ? _glapi_tls_RealDispatch
: _glapi_tls_Dispatch
;
419 assert( api
!= NULL
);
421 #elif defined(THREADS)
423 if (DispatchOverride
) {
424 return (struct _glapi_table
*) _glthread_GetTSD(&RealDispatchTSD
);
427 return (struct _glapi_table
*) _glthread_GetTSD(&_gl_DispatchTSD
);
431 if (DispatchOverride
) {
432 assert(_glapi_RealDispatch
);
433 return _glapi_RealDispatch
;
436 assert(_glapi_DispatchTSD
);
437 return _glapi_DispatchTSD
;
441 return _glapi_Dispatch
;
447 * Notes on dispatch overrride:
449 * Dispatch override allows an external agent to hook into the GL dispatch
450 * mechanism before execution goes into the core rendering library. For
451 * example, a trace mechanism would insert itself as an overrider, print
452 * logging info for each GL function, then dispatch to the real GL function.
454 * libGLS (GL Stream library) is another agent that might use override.
456 * We don't allow more than one layer of overriding at this time.
457 * In the future we may allow nested/layered override. In that case
458 * _glapi_begin_dispatch_override() will return an override layer,
459 * _glapi_end_dispatch_override(layer) will remove an override layer
460 * and _glapi_get_override_dispatch(layer) will return the dispatch
461 * table for a given override layer. layer = 0 will be the "real"
466 * Return: dispatch override layer number.
469 _glapi_begin_dispatch_override(struct _glapi_table
*override
)
471 struct _glapi_table
*real
= _glapi_get_dispatch();
473 assert(!DispatchOverride
); /* can't nest at this time */
474 DispatchOverride
= GL_TRUE
;
476 _glapi_set_dispatch(real
);
478 #if defined(GLX_USE_TLS)
479 _glthread_SetTSD(&_gl_DispatchTSD
, (void *) override
);
480 _glapi_tls_Dispatch
= override
;
481 #elif defined(THREADS)
482 _glthread_SetTSD(&_gl_DispatchTSD
, (void *) override
);
484 _glapi_Dispatch
= (struct _glapi_table
*) __glapi_threadsafe_table
;
485 _glapi_DispatchTSD
= NULL
;
488 _glapi_Dispatch
= override
;
489 _glapi_DispatchTSD
= override
;
492 _glapi_Dispatch
= override
;
499 _glapi_end_dispatch_override(int layer
)
501 struct _glapi_table
*real
= _glapi_get_dispatch();
503 DispatchOverride
= GL_FALSE
;
504 _glapi_set_dispatch(real
);
505 /* the rest of this isn't needed, just play it safe */
506 #if defined(GLX_USE_TLS)
507 _glapi_tls_RealDispatch
= NULL
;
509 # if defined(THREADS)
510 _glthread_SetTSD(&RealDispatchTSD
, NULL
);
512 _glapi_RealDispatch
= NULL
;
517 PUBLIC
struct _glapi_table
*
518 _glapi_get_override_dispatch(int layer
)
521 return _glapi_get_dispatch();
524 if (DispatchOverride
) {
525 #if defined(GLX_USE_TLS)
526 return (struct _glapi_table
*) _glapi_tls_Dispatch
;
527 #elif defined(THREADS)
528 return (struct _glapi_table
*) _glthread_GetTSD(&_gl_DispatchTSD
);
530 return _glapi_Dispatch
;
540 #if !defined( USE_X86_ASM )
541 #define NEED_FUNCTION_POINTER
544 /* The code in this file is auto-generated with Python */
549 * Search the table of static entrypoint functions for the named function
550 * and return the corresponding glprocs_table_t entry.
552 static const glprocs_table_t
*
553 find_entry( const char * n
)
557 for (i
= 0; static_functions
[i
].Name_offset
>= 0; i
++) {
558 const char * test_name
;
560 test_name
= gl_string_table
+ static_functions
[i
].Name_offset
;
561 if (strcmp(test_name
, n
) == 0) {
562 return & static_functions
[i
];
570 * Return dispatch table offset of the named static (built-in) function.
571 * Return -1 if function not found.
574 get_static_proc_offset(const char *funcName
)
576 const glprocs_table_t
* const f
= find_entry( funcName
);
587 #if defined( GLX_USE_TLS )
588 extern GLubyte gl_dispatch_functions_start
[];
589 extern GLubyte gl_dispatch_functions_end
[];
591 extern const GLubyte gl_dispatch_functions_start
[];
594 # if defined(THREADS) && !defined(GLX_USE_TLS)
595 # define X86_DISPATCH_FUNCTION_SIZE 32
597 # define X86_DISPATCH_FUNCTION_SIZE 16
602 * Return dispatch function address the named static (built-in) function.
603 * Return NULL if function not found.
605 static const _glapi_proc
606 get_static_proc_address(const char *funcName
)
608 const glprocs_table_t
* const f
= find_entry( funcName
);
611 return (_glapi_proc
) (gl_dispatch_functions_start
612 + (X86_DISPATCH_FUNCTION_SIZE
* f
->Offset
));
623 * Return pointer to the named static (built-in) function.
624 * \return NULL if function not found.
626 static const _glapi_proc
627 get_static_proc_address(const char *funcName
)
629 const glprocs_table_t
* const f
= find_entry( funcName
);
630 return ( f
!= NULL
) ? f
->Address
: NULL
;
633 #endif /* USE_X86_ASM */
637 * Return the name of the function at the given offset in the dispatch
638 * table. For debugging only.
641 get_static_proc_name( GLuint offset
)
645 for (i
= 0; static_functions
[i
].Name_offset
>= 0; i
++) {
646 if (static_functions
[i
].Offset
== offset
) {
647 return gl_string_table
+ static_functions
[i
].Name_offset
;
655 /**********************************************************************
656 * Extension function management.
660 * Number of extension functions which we can dynamically add at runtime.
662 #define MAX_EXTENSION_FUNCS 300
666 * The dispatch table size (number of entries) is the size of the
667 * _glapi_table struct plus the number of dynamic entries we can add.
668 * The extra slots can be filled in by DRI drivers that register new extension
671 #define DISPATCH_TABLE_SIZE (sizeof(struct _glapi_table) / sizeof(void *) + MAX_EXTENSION_FUNCS)
675 * Track information about a function added to the GL API.
677 struct _glapi_function
{
679 * Name of the function.
685 * Text string that describes the types of the parameters passed to the
686 * named function. Parameter types are converted to characters using the
688 * - 'i' for \c GLint, \c GLuint, and \c GLenum
689 * - 'p' for any pointer type
690 * - 'f' for \c GLfloat and \c GLclampf
691 * - 'd' for \c GLdouble and \c GLclampd
693 const char * parameter_signature
;
697 * Offset in the dispatch table where the pointer to the real function is
698 * located. If the driver has not requested that the named function be
699 * added to the dispatch table, this will have the value ~0.
701 unsigned dispatch_offset
;
705 * Pointer to the dispatch stub for the named function.
708 * The semantic of this field should be changed slightly. Currently, it
709 * is always expected to be non-\c NULL. However, it would be better to
710 * only allocate the entry-point stub when the application requests the
711 * function via \c glXGetProcAddress. This would save memory for all the
712 * functions that the driver exports but that the application never wants
715 _glapi_proc dispatch_stub
;
719 static struct _glapi_function ExtEntryTable
[MAX_EXTENSION_FUNCS
];
720 static GLuint NumExtEntryPoints
= 0;
723 extern void __glapi_sparc_icache_flush(unsigned int *);
727 * Generate a dispatch function (entrypoint) which jumps through
728 * the given slot number (offset) in the current dispatch table.
729 * We need assembly language in order to accomplish this.
732 generate_entrypoint(GLuint functionOffset
)
734 #if defined(USE_X86_ASM)
735 /* 32 is chosen as something of a magic offset. For x86, the dispatch
736 * at offset 32 is the first one where the offset in the
737 * "jmp OFFSET*4(%eax)" can't be encoded in a single byte.
739 const GLubyte
* const template_func
= gl_dispatch_functions_start
740 + (X86_DISPATCH_FUNCTION_SIZE
* 32);
741 GLubyte
* const code
= (GLubyte
*) malloc( X86_DISPATCH_FUNCTION_SIZE
);
744 if ( code
!= NULL
) {
745 (void) memcpy( code
, template_func
, X86_DISPATCH_FUNCTION_SIZE
);
746 fill_in_entrypoint_offset( (_glapi_proc
) code
, functionOffset
);
749 return (_glapi_proc
) code
;
750 #elif defined(USE_SPARC_ASM)
753 static const unsigned int insn_template
[] = {
754 0x05000000, /* sethi %uhi(_glapi_Dispatch), %g2 */
755 0x03000000, /* sethi %hi(_glapi_Dispatch), %g1 */
756 0x8410a000, /* or %g2, %ulo(_glapi_Dispatch), %g2 */
757 0x82106000, /* or %g1, %lo(_glapi_Dispatch), %g1 */
758 0x8528b020, /* sllx %g2, 32, %g2 */
759 0xc2584002, /* ldx [%g1 + %g2], %g1 */
760 0x05000000, /* sethi %hi(8 * glapioffset), %g2 */
761 0x8410a000, /* or %g2, %lo(8 * glapioffset), %g2 */
762 0xc6584002, /* ldx [%g1 + %g2], %g3 */
763 0x81c0c000, /* jmpl %g3, %g0 */
767 static const unsigned int insn_template
[] = {
768 0x03000000, /* sethi %hi(_glapi_Dispatch), %g1 */
769 0xc2006000, /* ld [%g1 + %lo(_glapi_Dispatch)], %g1 */
770 0xc6006000, /* ld [%g1 + %lo(4*glapioffset)], %g3 */
771 0x81c0c000, /* jmpl %g3, %g0 */
775 unsigned int *code
= (unsigned int *) malloc(sizeof(insn_template
));
776 unsigned long glapi_addr
= (unsigned long) &_glapi_Dispatch
;
778 memcpy(code
, insn_template
, sizeof(insn_template
));
781 code
[0] |= (glapi_addr
>> (32 + 10));
782 code
[1] |= ((glapi_addr
& 0xffffffff) >> 10);
783 __glapi_sparc_icache_flush(&code
[0]);
784 code
[2] |= ((glapi_addr
>> 32) & ((1 << 10) - 1));
785 code
[3] |= (glapi_addr
& ((1 << 10) - 1));
786 __glapi_sparc_icache_flush(&code
[2]);
787 code
[6] |= ((functionOffset
* 8) >> 10);
788 code
[7] |= ((functionOffset
* 8) & ((1 << 10) - 1));
789 __glapi_sparc_icache_flush(&code
[6]);
791 code
[0] |= (glapi_addr
>> 10);
792 code
[1] |= (glapi_addr
& ((1 << 10) - 1));
793 __glapi_sparc_icache_flush(&code
[0]);
794 code
[2] |= (functionOffset
* 4);
795 __glapi_sparc_icache_flush(&code
[2]);
798 return (_glapi_proc
) code
;
800 (void) functionOffset
;
802 #endif /* USE_*_ASM */
807 * This function inserts a new dispatch offset into the assembly language
808 * stub that was generated with the preceeding function.
811 fill_in_entrypoint_offset(_glapi_proc entrypoint
, GLuint offset
)
813 #if defined(USE_X86_ASM)
814 GLubyte
* const code
= (GLubyte
*) entrypoint
;
817 #if X86_DISPATCH_FUNCTION_SIZE == 32
818 *((unsigned int *)(code
+ 11)) = 4 * offset
;
819 *((unsigned int *)(code
+ 22)) = 4 * offset
;
820 #elif X86_DISPATCH_FUNCTION_SIZE == 16 && defined( GLX_USE_TLS )
821 *((unsigned int *)(code
+ 8)) = 4 * offset
;
822 #elif X86_DISPATCH_FUNCTION_SIZE == 16
823 *((unsigned int *)(code
+ 7)) = 4 * offset
;
825 # error Invalid X86_DISPATCH_FUNCTION_SIZE!
828 #elif defined(USE_SPARC_ASM)
830 /* XXX this hasn't been tested! */
831 unsigned int *code
= (unsigned int *) entrypoint
;
833 code
[6] = 0x05000000; /* sethi %hi(8 * glapioffset), %g2 */
834 code
[7] = 0x8410a000; /* or %g2, %lo(8 * glapioffset), %g2 */
835 code
[6] |= ((offset
* 8) >> 10);
836 code
[7] |= ((offset
* 8) & ((1 << 10) - 1));
837 __glapi_sparc_icache_flush(&code
[6]);
838 #else /* __arch64__ */
839 code
[2] = 0xc6006000; /* ld [%g1 + %lo(4*glapioffset)], %g3 */
840 code
[2] |= (offset
* 4);
841 __glapi_sparc_icache_flush(&code
[2]);
842 #endif /* __arch64__ */
846 /* an unimplemented architecture */
850 #endif /* USE_*_ASM */
855 * Generate new entrypoint
857 * Use a temporary dispatch offset of ~0 (i.e. -1). Later, when the driver
858 * calls \c _glapi_add_dispatch we'll put in the proper offset. If that
859 * never happens, and the user calls this function, he'll segfault. That's
860 * what you get when you try calling a GL function that doesn't really exist.
862 * \param funcName Name of the function to create an entry-point for.
864 * \sa _glapi_add_entrypoint
867 static struct _glapi_function
*
868 add_function_name( const char * funcName
)
870 struct _glapi_function
* entry
= NULL
;
872 if (NumExtEntryPoints
< MAX_EXTENSION_FUNCS
) {
873 _glapi_proc entrypoint
= generate_entrypoint(~0);
874 if (entrypoint
!= NULL
) {
875 entry
= & ExtEntryTable
[NumExtEntryPoints
];
877 ExtEntryTable
[NumExtEntryPoints
].name
= str_dup(funcName
);
878 ExtEntryTable
[NumExtEntryPoints
].parameter_signature
= NULL
;
879 ExtEntryTable
[NumExtEntryPoints
].dispatch_offset
= ~0;
880 ExtEntryTable
[NumExtEntryPoints
].dispatch_stub
= entrypoint
;
890 * Fill-in the dispatch stub for the named function.
892 * This function is intended to be called by a hardware driver. When called,
893 * a dispatch stub may be created created for the function. A pointer to this
894 * dispatch function will be returned by glXGetProcAddress.
896 * \param function_names Array of pointers to function names that should
897 * share a common dispatch offset.
898 * \param parameter_signature String representing the types of the parameters
899 * passed to the named function. Parameter types
900 * are converted to characters using the following
902 * - 'i' for \c GLint, \c GLuint, and \c GLenum
903 * - 'p' for any pointer type
904 * - 'f' for \c GLfloat and \c GLclampf
905 * - 'd' for \c GLdouble and \c GLclampd
908 * The offset in the dispatch table of the named function. A pointer to the
909 * driver's implementation of the named function should be stored at
910 * \c dispatch_table[\c offset].
912 * \sa glXGetProcAddress
915 * This function can only handle up to 8 names at a time. As far as I know,
916 * the maximum number of names ever associated with an existing GL function is
917 * 4 (\c glPointParameterfSGIS, \c glPointParameterfEXT,
918 * \c glPointParameterfARB, and \c glPointParameterf), so this should not be
919 * too painful of a limitation.
922 * Determine whether or not \c parameter_signature should be allowed to be
923 * \c NULL. It doesn't seem like much of a hardship for drivers to have to
924 * pass in an empty string.
927 * Determine if code should be added to reject function names that start with
931 * Add code to compare \c parameter_signature with the parameter signature of
932 * a static function. In order to do that, we need to find a way to \b get
933 * the parameter signature of a static function.
937 _glapi_add_dispatch( const char * const * function_names
,
938 const char * parameter_signature
)
940 static int next_dynamic_offset
= _gloffset_FIRST_DYNAMIC
;
941 const char * const real_sig
= (parameter_signature
!= NULL
)
942 ? parameter_signature
: "";
943 struct _glapi_function
* entry
[8];
944 GLboolean is_static
[8];
951 (void) memset( is_static
, 0, sizeof( is_static
) );
952 (void) memset( entry
, 0, sizeof( entry
) );
954 for ( i
= 0 ; function_names
[i
] != NULL
; i
++ ) {
955 /* Do some trivial validation on the name of the function.
959 if (!function_names
[i
] || function_names
[i
][0] != 'm' || function_names
[i
][1] != 'g' || function_names
[i
][2] != 'l')
962 if (!function_names
[i
] || function_names
[i
][0] != 'g' || function_names
[i
][1] != 'l')
967 /* Determine if the named function already exists. If the function does
968 * exist, it must have the same parameter signature as the function
972 new_offset
= get_static_proc_offset(function_names
[i
]);
973 if (new_offset
>= 0) {
974 /* FIXME: Make sure the parameter signatures match! How do we get
975 * FIXME: the parameter signature for static functions?
978 if ( (offset
!= ~0) && (new_offset
!= offset
) ) {
982 is_static
[i
] = GL_TRUE
;
987 for ( j
= 0 ; j
< NumExtEntryPoints
; j
++ ) {
988 if (strcmp(ExtEntryTable
[j
].name
, function_names
[i
]) == 0) {
989 /* The offset may be ~0 if the function name was added by
990 * glXGetProcAddress but never filled in by the driver.
993 if (ExtEntryTable
[j
].dispatch_offset
!= ~0) {
994 if (strcmp(real_sig
, ExtEntryTable
[j
].parameter_signature
)
999 if ( (offset
!= ~0) && (ExtEntryTable
[j
].dispatch_offset
!= offset
) ) {
1003 offset
= ExtEntryTable
[j
].dispatch_offset
;
1006 entry
[i
] = & ExtEntryTable
[j
];
1014 offset
= next_dynamic_offset
;
1015 next_dynamic_offset
++;
1019 for ( i
= 0 ; function_names
[i
] != NULL
; i
++ ) {
1020 if (! is_static
[i
] ) {
1021 if (entry
[i
] == NULL
) {
1022 entry
[i
] = add_function_name( function_names
[i
] );
1023 if (entry
[i
] == NULL
) {
1024 /* FIXME: Possible memory leak here.
1031 entry
[i
]->parameter_signature
= str_dup(real_sig
);
1032 fill_in_entrypoint_offset(entry
[i
]->dispatch_stub
, offset
);
1033 entry
[i
]->dispatch_offset
= offset
;
1042 * Return offset of entrypoint for named function within dispatch table.
1045 _glapi_get_proc_offset(const char *funcName
)
1047 /* search extension functions first */
1049 for (i
= 0; i
< NumExtEntryPoints
; i
++) {
1050 if (strcmp(ExtEntryTable
[i
].name
, funcName
) == 0) {
1051 return ExtEntryTable
[i
].dispatch_offset
;
1055 /* search static functions */
1056 return get_static_proc_offset(funcName
);
1062 * Return pointer to the named function. If the function name isn't found
1063 * in the name of static functions, try generating a new API entrypoint on
1064 * the fly with assembly language.
1067 _glapi_get_proc_address(const char *funcName
)
1069 struct _glapi_function
* entry
;
1073 if (funcName
[0] != 'm' || funcName
[1] != 'g' || funcName
[2] != 'l')
1076 if (funcName
[0] != 'g' || funcName
[1] != 'l')
1080 /* search extension functions first */
1081 for (i
= 0; i
< NumExtEntryPoints
; i
++) {
1082 if (strcmp(ExtEntryTable
[i
].name
, funcName
) == 0) {
1083 return ExtEntryTable
[i
].dispatch_stub
;
1087 /* search static functions */
1089 const _glapi_proc func
= get_static_proc_address(funcName
);
1094 entry
= add_function_name(funcName
);
1095 return (entry
== NULL
) ? NULL
: entry
->dispatch_stub
;
1101 * Return the name of the function at the given dispatch offset.
1102 * This is only intended for debugging.
1105 _glapi_get_proc_name(GLuint offset
)
1110 /* search built-in functions */
1111 n
= get_static_proc_name(offset
);
1116 /* search added extension functions */
1117 for (i
= 0; i
< NumExtEntryPoints
; i
++) {
1118 if (ExtEntryTable
[i
].dispatch_offset
== offset
) {
1119 return ExtEntryTable
[i
].name
;
1128 * Return size of dispatch table struct as number of functions (or
1132 _glapi_get_dispatch_table_size(void)
1134 return DISPATCH_TABLE_SIZE
;
1140 * Get API dispatcher version string.
1143 _glapi_get_version(void)
1145 return "20021001"; /* YYYYMMDD */
1151 * Make sure there are no NULL pointers in the given dispatch table.
1152 * Intended for debugging purposes.
1155 _glapi_check_table(const struct _glapi_table
*table
)
1158 const GLuint entries
= _glapi_get_dispatch_table_size();
1159 const void **tab
= (const void **) table
;
1161 for (i
= 1; i
< entries
; i
++) {
1165 /* Do some spot checks to be sure that the dispatch table
1166 * slots are assigned correctly.
1169 GLuint BeginOffset
= _glapi_get_proc_offset("glBegin");
1170 char *BeginFunc
= (char*) &table
->Begin
;
1171 GLuint offset
= (BeginFunc
- (char *) table
) / sizeof(void *);
1172 assert(BeginOffset
== _gloffset_Begin
);
1173 assert(BeginOffset
== offset
);
1176 GLuint viewportOffset
= _glapi_get_proc_offset("glViewport");
1177 char *viewportFunc
= (char*) &table
->Viewport
;
1178 GLuint offset
= (viewportFunc
- (char *) table
) / sizeof(void *);
1179 assert(viewportOffset
== _gloffset_Viewport
);
1180 assert(viewportOffset
== offset
);
1183 GLuint VertexPointerOffset
= _glapi_get_proc_offset("glVertexPointer");
1184 char *VertexPointerFunc
= (char*) &table
->VertexPointer
;
1185 GLuint offset
= (VertexPointerFunc
- (char *) table
) / sizeof(void *);
1186 assert(VertexPointerOffset
== _gloffset_VertexPointer
);
1187 assert(VertexPointerOffset
== offset
);
1190 GLuint ResetMinMaxOffset
= _glapi_get_proc_offset("glResetMinmax");
1191 char *ResetMinMaxFunc
= (char*) &table
->ResetMinmax
;
1192 GLuint offset
= (ResetMinMaxFunc
- (char *) table
) / sizeof(void *);
1193 assert(ResetMinMaxOffset
== _gloffset_ResetMinmax
);
1194 assert(ResetMinMaxOffset
== offset
);
1197 GLuint blendColorOffset
= _glapi_get_proc_offset("glBlendColor");
1198 char *blendColorFunc
= (char*) &table
->BlendColor
;
1199 GLuint offset
= (blendColorFunc
- (char *) table
) / sizeof(void *);
1200 assert(blendColorOffset
== _gloffset_BlendColor
);
1201 assert(blendColorOffset
== offset
);
1204 GLuint istextureOffset
= _glapi_get_proc_offset("glIsTextureEXT");
1205 char *istextureFunc
= (char*) &table
->IsTextureEXT
;
1206 GLuint offset
= (istextureFunc
- (char *) table
) / sizeof(void *);
1207 assert(istextureOffset
== _gloffset_IsTextureEXT
);
1208 assert(istextureOffset
== offset
);
1211 GLuint secondaryColor3fOffset
= _glapi_get_proc_offset("glSecondaryColor3fEXT");
1212 char *secondaryColor3fFunc
= (char*) &table
->SecondaryColor3fEXT
;
1213 GLuint offset
= (secondaryColor3fFunc
- (char *) table
) / sizeof(void *);
1214 assert(secondaryColor3fOffset
== _gloffset_SecondaryColor3fEXT
);
1215 assert(secondaryColor3fOffset
== offset
);
1216 assert(_glapi_get_proc_address("glSecondaryColor3fEXT") == (_glapi_proc
) &glSecondaryColor3fEXT
);
1219 GLuint pointParameterivOffset
= _glapi_get_proc_offset("glPointParameterivNV");
1220 char *pointParameterivFunc
= (char*) &table
->PointParameterivNV
;
1221 GLuint offset
= (pointParameterivFunc
- (char *) table
) / sizeof(void *);
1222 assert(pointParameterivOffset
== _gloffset_PointParameterivNV
);
1223 assert(pointParameterivOffset
== offset
);
1224 assert(_glapi_get_proc_address("glPointParameterivNV") == (_glapi_proc
) &glPointParameterivNV
);
1227 GLuint setFenceOffset
= _glapi_get_proc_offset("glSetFenceNV");
1228 char *setFenceFunc
= (char*) &table
->SetFenceNV
;
1229 GLuint offset
= (setFenceFunc
- (char *) table
) / sizeof(void *);
1230 assert(setFenceOffset
== _gloffset_SetFenceNV
);
1231 assert(setFenceOffset
== offset
);
1232 assert(_glapi_get_proc_address("glSetFenceNV") == (_glapi_proc
) &glSetFenceNV
);
1241 * Perform platform-specific GL API entry-point fixups.
1246 init_glapi_relocs( void )
1248 #if defined( USE_X86_ASM ) && defined( GLX_USE_TLS )
1249 extern void * _x86_get_dispatch(void);
1250 const GLubyte
* const get_disp
= (const GLubyte
*) _x86_get_dispatch
;
1251 GLubyte
* curr_func
= (GLubyte
*) gl_dispatch_functions_start
;
1254 while ( curr_func
!= (GLubyte
*) gl_dispatch_functions_end
) {
1255 (void) memcpy( curr_func
, get_disp
, 6 );
1256 curr_func
+= X86_DISPATCH_FUNCTION_SIZE
;
1258 #endif /* defined( USE_X86_ASM ) && defined( GLX_USE_TLS ) */