src/mapi/glapi/glapi_entrypoint.c

   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  * \file glapi_entrypoint.c
  27  *
  28  * Arch-specific code for manipulating GL API entrypoints (dispatch stubs).
  29  */
  30
  31
  32 #ifdef HAVE_DIX_CONFIG_H
  33 #include <dix-config.h>
  34 #include "glapi/mesa.h"
  35 #else
  36 #include "main/glheader.h"
  37 #include "main/compiler.h"
  38 #endif
  39
  40 #include "glapi/glapi.h"
  41 #include "glapi/glapi_priv.h"
  42
  43
  44 #ifdef USE_X86_ASM
  45
  46 #if defined( GLX_USE_TLS )
  47 extern       GLubyte gl_dispatch_functions_start[];
  48 extern       GLubyte gl_dispatch_functions_end[];
  49 #else
  50 extern const GLubyte gl_dispatch_functions_start[];
  51 #endif
  52
  53 #endif /* USE_X86_ASM */
  54
  55
  56 #if defined(DISPATCH_FUNCTION_SIZE)
  57
  58 _glapi_proc
  59 get_entrypoint_address(unsigned int functionOffset)
  60 {
  61    return (_glapi_proc) (gl_dispatch_functions_start
  62                          + (DISPATCH_FUNCTION_SIZE * functionOffset));
  63 }
  64
  65 #endif
  66
  67
  68 #if defined(USE_X86_ASM)
  69
  70 /**
  71  * Perform platform-specific GL API entry-point fixups.
  72  */
  73 static void
  74 init_glapi_relocs( void )
  75 {
  76 #if defined(GLX_USE_TLS) && !defined(GLX_X86_READONLY_TEXT)
  77     extern unsigned long _x86_get_dispatch(void);
  78     char run_time_patch[] = {
  79        0x65, 0xa1, 0, 0, 0, 0 /* movl %gs:0,%eax */
  80     };
  81     GLuint *offset = (GLuint *) &run_time_patch[2]; /* 32-bits for x86/32 */
  82     const GLubyte * const get_disp = (const GLubyte *) run_time_patch;
  83     GLubyte * curr_func = (GLubyte *) gl_dispatch_functions_start;
  84
  85     *offset = _x86_get_dispatch();
  86     while ( curr_func != (GLubyte *) gl_dispatch_functions_end ) {
  87         (void) memcpy( curr_func, get_disp, sizeof(run_time_patch));
  88         curr_func += DISPATCH_FUNCTION_SIZE;
  89     }
  90 #endif
  91 }
  92
  93
  94 /**
  95  * Generate a dispatch function (entrypoint) which jumps through
  96  * the given slot number (offset) in the current dispatch table.
  97  * We need assembly language in order to accomplish this.
  98  */
  99 _glapi_proc
 100 generate_entrypoint(unsigned int functionOffset)
 101 {
 102    /* 32 is chosen as something of a magic offset.  For x86, the dispatch
 103     * at offset 32 is the first one where the offset in the
 104     * "jmp OFFSET*4(%eax)" can't be encoded in a single byte.
 105     */
 106    const GLubyte * const template_func = gl_dispatch_functions_start
 107      + (DISPATCH_FUNCTION_SIZE * 32);
 108    GLubyte * const code = (GLubyte *) _glapi_exec_malloc(DISPATCH_FUNCTION_SIZE);
 109
 110
 111    if ( code != NULL ) {
 112       (void) memcpy(code, template_func, DISPATCH_FUNCTION_SIZE);
 113       fill_in_entrypoint_offset( (_glapi_proc) code, functionOffset );
 114    }
 115
 116    return (_glapi_proc) code;
 117 }
 118
 119
 120 /**
 121  * This function inserts a new dispatch offset into the assembly language
 122  * stub that was generated with the preceeding function.
 123  */
 124 void
 125 fill_in_entrypoint_offset(_glapi_proc entrypoint, unsigned int offset)
 126 {
 127    GLubyte * const code = (GLubyte *) entrypoint;
 128
 129 #if defined(GLX_USE_TLS)
 130    *((unsigned int *)(code +  8)) = 4 * offset;
 131 #elif defined(THREADS)
 132    *((unsigned int *)(code + 11)) = 4 * offset;
 133    *((unsigned int *)(code + 22)) = 4 * offset;
 134 #else
 135    *((unsigned int *)(code +  7)) = 4 * offset;
 136 #endif
 137 }
 138
 139
 140 #elif defined(USE_SPARC_ASM)
 141
 142 extern void __glapi_sparc_icache_flush(unsigned int *);
 143
 144 static void
 145 init_glapi_relocs( void )
 146 {
 147 #if defined(PTHREADS) || defined(GLX_USE_TLS)
 148     static const unsigned int template[] = {
 149 #ifdef GLX_USE_TLS
 150         0x05000000, /* sethi %hi(_glapi_tls_Dispatch), %g2 */
 151         0x8730e00a, /* srl %g3, 10, %g3 */
 152         0x8410a000, /* or %g2, %lo(_glapi_tls_Dispatch), %g2 */
 153 #ifdef __arch64__
 154         0xc259c002, /* ldx [%g7 + %g2], %g1 */
 155         0xc2584003, /* ldx [%g1 + %g3], %g1 */
 156 #else
 157         0xc201c002, /* ld [%g7 + %g2], %g1 */
 158         0xc2004003, /* ld [%g1 + %g3], %g1 */
 159 #endif
 160         0x81c04000, /* jmp %g1 */
 161         0x01000000, /* nop  */
 162 #else
 163 #ifdef __arch64__
 164         0x03000000, /* 64-bit 0x00 --> sethi %hh(_glapi_Dispatch), %g1 */
 165         0x05000000, /* 64-bit 0x04 --> sethi %lm(_glapi_Dispatch), %g2 */
 166         0x82106000, /* 64-bit 0x08 --> or %g1, %hm(_glapi_Dispatch), %g1 */
 167         0x8730e00a, /* 64-bit 0x0c --> srl %g3, 10, %g3 */
 168         0x83287020, /* 64-bit 0x10 --> sllx %g1, 32, %g1 */
 169         0x82004002, /* 64-bit 0x14 --> add %g1, %g2, %g1 */
 170         0xc2586000, /* 64-bit 0x18 --> ldx [%g1 + %lo(_glapi_Dispatch)], %g1 */
 171 #else
 172         0x03000000, /* 32-bit 0x00 --> sethi %hi(_glapi_Dispatch), %g1 */
 173         0x8730e00a, /* 32-bit 0x04 --> srl %g3, 10, %g3 */
 174         0xc2006000, /* 32-bit 0x08 --> ld [%g1 + %lo(_glapi_Dispatch)], %g1 */
 175 #endif
 176         0x80a06000, /*             --> cmp %g1, 0 */
 177         0x02800005, /*             --> be +4*5 */
 178         0x01000000, /*             -->  nop  */
 179 #ifdef __arch64__
 180         0xc2584003, /* 64-bit      --> ldx [%g1 + %g3], %g1 */
 181 #else
 182         0xc2004003, /* 32-bit      --> ld [%g1 + %g3], %g1 */
 183 #endif
 184         0x81c04000, /*             --> jmp %g1 */
 185         0x01000000, /*             --> nop  */
 186 #ifdef __arch64__
 187         0x9de3bf80, /* 64-bit      --> save  %sp, -128, %sp */
 188 #else
 189         0x9de3bfc0, /* 32-bit      --> save  %sp, -64, %sp */
 190 #endif
 191         0xa0100003, /*             --> mov  %g3, %l0 */
 192         0x40000000, /*             --> call _glapi_get_dispatch */
 193         0x01000000, /*             -->  nop */
 194         0x82100008, /*             --> mov %o0, %g1 */
 195         0x86100010, /*             --> mov %l0, %g3 */
 196         0x10bffff7, /*             --> ba -4*9 */
 197         0x81e80000, /*             -->  restore  */
 198 #endif
 199     };
 200 #ifdef GLX_USE_TLS
 201     extern unsigned int __glapi_sparc_tls_stub;
 202     extern unsigned long __glapi_sparc_get_dispatch(void);
 203     unsigned int *code = &__glapi_sparc_tls_stub;
 204     unsigned long dispatch = __glapi_sparc_get_dispatch();
 205 #else
 206     extern unsigned int __glapi_sparc_pthread_stub;
 207     unsigned int *code = &__glapi_sparc_pthread_stub;
 208     unsigned long dispatch = (unsigned long) &_glapi_Dispatch;
 209     unsigned long call_dest = (unsigned long ) &_glapi_get_dispatch;
 210     int idx;
 211 #endif
 212
 213 #ifdef GLX_USE_TLS
 214     code[0] = template[0] | (dispatch >> 10);
 215     code[1] = template[1];
 216     __glapi_sparc_icache_flush(&code[0]);
 217     code[2] = template[2] | (dispatch & 0x3ff);
 218     code[3] = template[3];
 219     __glapi_sparc_icache_flush(&code[2]);
 220     code[4] = template[4];
 221     code[5] = template[5];
 222     __glapi_sparc_icache_flush(&code[4]);
 223     code[6] = template[6];
 224     __glapi_sparc_icache_flush(&code[6]);
 225 #else
 226 #if defined(__arch64__)
 227     code[0] = template[0] | (dispatch >> (32 + 10));
 228     code[1] = template[1] | ((dispatch & 0xffffffff) >> 10);
 229     __glapi_sparc_icache_flush(&code[0]);
 230     code[2] = template[2] | ((dispatch >> 32) & 0x3ff);
 231     code[3] = template[3];
 232     __glapi_sparc_icache_flush(&code[2]);
 233     code[4] = template[4];
 234     code[5] = template[5];
 235     __glapi_sparc_icache_flush(&code[4]);
 236     code[6] = template[6] | (dispatch & 0x3ff);
 237     idx = 7;
 238 #else
 239     code[0] = template[0] | (dispatch >> 10);
 240     code[1] = template[1];
 241     __glapi_sparc_icache_flush(&code[0]);
 242     code[2] = template[2] | (dispatch & 0x3ff);
 243     idx = 3;
 244 #endif
 245     code[idx + 0] = template[idx + 0];
 246     __glapi_sparc_icache_flush(&code[idx - 1]);
 247     code[idx + 1] = template[idx + 1];
 248     code[idx + 2] = template[idx + 2];
 249     __glapi_sparc_icache_flush(&code[idx + 1]);
 250     code[idx + 3] = template[idx + 3];
 251     code[idx + 4] = template[idx + 4];
 252     __glapi_sparc_icache_flush(&code[idx + 3]);
 253     code[idx + 5] = template[idx + 5];
 254     code[idx + 6] = template[idx + 6];
 255     __glapi_sparc_icache_flush(&code[idx + 5]);
 256     code[idx + 7] = template[idx + 7];
 257     code[idx + 8] = template[idx + 8] |
 258             (((call_dest - ((unsigned long) &code[idx + 8]))
 259               >> 2) & 0x3fffffff);
 260     __glapi_sparc_icache_flush(&code[idx + 7]);
 261     code[idx + 9] = template[idx + 9];
 262     code[idx + 10] = template[idx + 10];
 263     __glapi_sparc_icache_flush(&code[idx + 9]);
 264     code[idx + 11] = template[idx + 11];
 265     code[idx + 12] = template[idx + 12];
 266     __glapi_sparc_icache_flush(&code[idx + 11]);
 267     code[idx + 13] = template[idx + 13];
 268     __glapi_sparc_icache_flush(&code[idx + 13]);
 269 #endif
 270 #endif
 271 }
 272
 273
 274 _glapi_proc
 275 generate_entrypoint(GLuint functionOffset)
 276 {
 277 #if defined(PTHREADS) || defined(GLX_USE_TLS)
 278    static const unsigned int template[] = {
 279       0x07000000, /* sethi %hi(0), %g3 */
 280       0x8210000f, /* mov  %o7, %g1 */
 281       0x40000000, /* call */
 282       0x9e100001, /* mov  %g1, %o7 */
 283    };
 284 #ifdef GLX_USE_TLS
 285    extern unsigned int __glapi_sparc_tls_stub;
 286    unsigned long call_dest = (unsigned long ) &__glapi_sparc_tls_stub;
 287 #else
 288    extern unsigned int __glapi_sparc_pthread_stub;
 289    unsigned long call_dest = (unsigned long ) &__glapi_sparc_pthread_stub;
 290 #endif
 291    unsigned int *code = (unsigned int *) _glapi_exec_malloc(sizeof(template));
 292    if (code) {
 293       code[0] = template[0] | (functionOffset & 0x3fffff);
 294       code[1] = template[1];
 295       __glapi_sparc_icache_flush(&code[0]);
 296       code[2] = template[2] |
 297          (((call_dest - ((unsigned long) &code[2]))
 298            >> 2) & 0x3fffffff);
 299       code[3] = template[3];
 300       __glapi_sparc_icache_flush(&code[2]);
 301    }
 302    return (_glapi_proc) code;
 303 #endif
 304 }
 305
 306
 307 void
 308 fill_in_entrypoint_offset(_glapi_proc entrypoint, GLuint offset)
 309 {
 310    unsigned int *code = (unsigned int *) entrypoint;
 311
 312    code[0] &= ~0x3fffff;
 313    code[0] |= (offset * sizeof(void *)) & 0x3fffff;
 314    __glapi_sparc_icache_flush(&code[0]);
 315 }
 316
 317
 318 #else /* USE_*_ASM */
 319
 320 static void
 321 init_glapi_relocs( void )
 322 {
 323 }
 324
 325
 326 _glapi_proc
 327 generate_entrypoint(GLuint functionOffset)
 328 {
 329    (void) functionOffset;
 330    return NULL;
 331 }
 332
 333
 334 void
 335 fill_in_entrypoint_offset(_glapi_proc entrypoint, GLuint offset)
 336 {
 337    /* an unimplemented architecture */
 338    (void) entrypoint;
 339    (void) offset;
 340 }
 341
 342 #endif /* USE_*_ASM */
 343
 344
 345 void
 346 init_glapi_relocs_once( void )
 347 {
 348 #if defined(PTHREADS) || defined(GLX_USE_TLS)
 349    static pthread_once_t once_control = PTHREAD_ONCE_INIT;
 350    pthread_once( & once_control, init_glapi_relocs );
 351 #endif
 352 }