git.notmuchmail.org Git - apitrace/blob - glxtrace.py

   1 ##########################################################################
   2 #
   3 # Copyright 2011 Jose Fonseca
   4 # Copyright 2008-2010 VMware, Inc.
   5 # All Rights Reserved.
   6 #
   7 # Permission is hereby granted, free of charge, to any person obtaining a copy
   8 # of this software and associated documentation files (the "Software"), to deal
   9 # in the Software without restriction, including without limitation the rights
  10 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 # copies of the Software, and to permit persons to whom the Software is
  12 # furnished to do so, subject to the following conditions:
  13 #
  14 # The above copyright notice and this permission notice shall be included in
  15 # all copies or substantial portions of the Software.
  16 #
  17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23 # THE SOFTWARE.
  24 #
  25 ##########################################################################/
  26
  27
  28 """GLX tracing generator."""
  29
  30
  31 from stdapi import API
  32 from glapi import glapi
  33 from glxapi import glxapi
  34 from gltrace import GlTracer
  35 from dispatch import function_pointer_type, function_pointer_value
  36
  37
  38 class GlxTracer(GlTracer):
  39
  40     def is_public_function(self, function):
  41         # The symbols visible in libGL.so can vary, so expose them all
  42         return True
  43
  44     def get_function_address(self, function):
  45         return '__%s' % (function.name,)
  46
  47     def wrap_ret(self, function, instance):
  48         GlTracer.wrap_ret(self, function, instance)
  49
  50         if function.name in ("glXGetProcAddress", "glXGetProcAddressARB"):
  51             print '    %s = __unwrap_proc_addr(procName, %s);' % (instance, instance)
  52
  53
  54 if __name__ == '__main__':
  55     print
  56     print '#include <stdlib.h>'
  57     print '#include <string.h>'
  58     print
  59     print '#ifndef _GNU_SOURCE'
  60     print '#define _GNU_SOURCE // for dladdr'
  61     print '#endif'
  62     print '#include <dlfcn.h>'
  63     print
  64     print '#include "trace_write.hpp"'
  65     print
  66     print '#include "glproc.hpp"'
  67     print '#include "glsize.hpp"'
  68     print
  69     print 'static __GLXextFuncPtr __unwrap_proc_addr(const GLubyte * procName, __GLXextFuncPtr procPtr);'
  70     print
  71
  72     api = API()
  73     api.add_api(glxapi)
  74     api.add_api(glapi)
  75     tracer = GlxTracer()
  76     tracer.trace_api(api)
  77
  78     print 'static __GLXextFuncPtr __unwrap_proc_addr(const GLubyte * procName, __GLXextFuncPtr procPtr) {'
  79     print '    if (!procPtr) {'
  80     print '        return procPtr;'
  81     print '    }'
  82     for f in api.functions:
  83         ptype = function_pointer_type(f)
  84         pvalue = function_pointer_value(f)
  85         print '    if (!strcmp("%s", (const char *)procName)) {' % f.name
  86         print '        %s = (%s)procPtr;' % (pvalue, ptype)
  87         print '        return (__GLXextFuncPtr)&%s;' % (f.name,)
  88         print '    }'
  89     print '    return procPtr;'
  90     print '}'
  91     print
  92     print r'''
  93
  94
  95 /*
  96  * Handle to the true libGL.so
  97  */
  98 static void *libgl_handle = NULL;
  99
 100
 101 /*
 102  * Invoke the true dlopen() function.
 103  */
 104 static void *__dlopen(const char *filename, int flag)
 105 {
 106     typedef void * (*PFNDLOPEN)(const char *, int);
 107     static PFNDLOPEN dlopen_ptr = NULL;
 108
 109     if (!dlopen_ptr) {
 110         dlopen_ptr = (PFNDLOPEN)dlsym(RTLD_NEXT, "dlopen");
 111         if (!dlopen_ptr) {
 112             OS::DebugMessage("error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
 113             return NULL;
 114         }
 115     }
 116
 117     return dlopen_ptr(filename, flag);
 118 }
 119
 120
 121 /*
 122  * Several applications, such as Quake3, use dlopen("libGL.so.1"), but
 123  * LD_PRELOAD does not intercept symbols obtained via dlopen/dlsym, therefore
 124  * we need to intercept the dlopen() call here, and redirect to our wrapper
 125  * shared object.
 126  */
 127 extern "C" PUBLIC
 128 void * dlopen(const char *filename, int flag)
 129 {
 130     void *handle;
 131
 132     handle = __dlopen(filename, flag);
 133
 134     const char * libgl_filename = getenv("TRACE_LIBGL");
 135
 136     if (filename && handle && !libgl_filename) {
 137         if (0) {
 138             OS::DebugMessage("warning: dlopen(\"%s\", 0x%x)\n", filename, flag);
 139         }
 140
 141         // FIXME: handle absolute paths and other versions
 142         if (strcmp(filename, "libGL.so") == 0 ||
 143             strcmp(filename, "libGL.so.1") == 0) {
 144
 145             // Use the true libGL.so handle instead of RTLD_NEXT from now on
 146             libgl_handle = handle;
 147
 148             // Get the file path for our shared object, and use it instead
 149             static int dummy = 0xdeedbeef;
 150             Dl_info info;
 151             if (dladdr(&dummy, &info)) {
 152                 OS::DebugMessage("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
 153                 handle = __dlopen(info.dli_fname, flag);
 154             } else {
 155                 OS::DebugMessage("warning: dladdr() failed\n");
 156             }
 157         }
 158     }
 159
 160     return handle;
 161 }
 162
 163
 164 /*
 165  * Lookup a libGL symbol
 166  */
 167 static void * __dlsym(const char *symbol)
 168 {
 169     void *result;
 170
 171     if (!libgl_handle) {
 172         /*
 173          * The app doesn't directly link against libGL.so, nor does it directly
 174          * dlopen it.  So we have to load it ourselves.
 175          */
 176
 177         const char * libgl_filename = getenv("TRACE_LIBGL");
 178
 179         if (!libgl_filename) {
 180             /*
 181              * Try to use whatever libGL.so the library is linked against.
 182              */
 183
 184             result = dlsym(RTLD_NEXT, symbol);
 185             if (result) {
 186                 libgl_handle = RTLD_NEXT;
 187                 return result;
 188             }
 189
 190             libgl_filename = "libGL.so.1";
 191         }
 192
 193         /*
 194          * It would have been preferable to use RTLD_LOCAL to ensure that the
 195          * application can never access libGL.so symbols directly, but this
 196          * won't work, given libGL.so often loads a driver specific SO and
 197          * exposes symbols to it.
 198          */
 199
 200         libgl_handle = __dlopen(libgl_filename, RTLD_GLOBAL | RTLD_LAZY);
 201         if (!libgl_handle) {
 202             OS::DebugMessage("error: couldn't find libGL.so\n");
 203             return NULL;
 204         }
 205     }
 206
 207     return dlsym(libgl_handle, symbol);
 208 }
 209
 210
 211 '''