git.cworth.org Git - apitrace/blob - wrappers/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 gltrace import GlTracer
  32 from specs.stdapi import API
  33 from specs.glapi import glapi
  34 from specs.glxapi import glxapi
  35
  36
  37 class GlxTracer(GlTracer):
  38
  39     def isFunctionPublic(self, function):
  40         # The symbols visible in libGL.so can vary, so expose them all
  41         return True
  42
  43     getProcAddressFunctionNames = [
  44         "glXGetProcAddress",
  45         "glXGetProcAddressARB",
  46     ]
  47
  48     createContextFunctionNames = [
  49         'glXCreateContext',
  50         'glXCreateContextAttribsARB',
  51         'glXCreateContextWithConfigSGIX',
  52         'glXCreateNewContext',
  53     ]
  54
  55     destroyContextFunctionNames = [
  56         'glXDestroyContext',
  57     ]
  58
  59     makeCurrentFunctionNames = [
  60         'glXMakeCurrent',
  61         'glXMakeContextCurrent',
  62         'glXMakeCurrentReadSGI',
  63     ]
  64
  65     def traceFunctionImplBody(self, function):
  66         if function.name in self.destroyContextFunctionNames:
  67             print '    gltrace::releaseContext((uintptr_t)ctx);'
  68
  69         GlTracer.traceFunctionImplBody(self, function)
  70
  71         if function.name in self.createContextFunctionNames:
  72             print '    if (_result != NULL)'
  73             print '        gltrace::createContext((uintptr_t)_result);'
  74
  75         if function.name in self.makeCurrentFunctionNames:
  76             print '    if (_result) {'
  77             print '        if (ctx != NULL)'
  78             print '            gltrace::setContext((uintptr_t)ctx);'
  79             print '        else'
  80             print '            gltrace::clearContext();'
  81             print '    }'
  82
  83
  84 if __name__ == '__main__':
  85     print
  86     print '#include <stdlib.h>'
  87     print '#include <string.h>'
  88     print
  89     print '#ifndef _GNU_SOURCE'
  90     print '#define _GNU_SOURCE // for dladdr'
  91     print '#endif'
  92     print '#include <dlfcn.h>'
  93     print
  94     print '#include "trace_writer_local.hpp"'
  95     print
  96     print '// To validate our prototypes'
  97     print '#define GL_GLEXT_PROTOTYPES'
  98     print '#define GLX_GLXEXT_PROTOTYPES'
  99     print
 100     print '#include "glproc.hpp"'
 101     print '#include "glsize.hpp"'
 102     print
 103
 104     api = API()
 105     api.addApi(glxapi)
 106     api.addApi(glapi)
 107     tracer = GlxTracer()
 108     tracer.traceApi(api)
 109
 110     print r'''
 111
 112
 113 /*
 114  * Invoke the true dlopen() function.
 115  */
 116 static void *_dlopen(const char *filename, int flag)
 117 {
 118     typedef void * (*PFN_DLOPEN)(const char *, int);
 119     static PFN_DLOPEN dlopen_ptr = NULL;
 120
 121     if (!dlopen_ptr) {
 122         dlopen_ptr = (PFN_DLOPEN)dlsym(RTLD_NEXT, "dlopen");
 123         if (!dlopen_ptr) {
 124             os::log("apitrace: error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
 125             return NULL;
 126         }
 127     }
 128
 129     return dlopen_ptr(filename, flag);
 130 }
 131
 132
 133 /*
 134  * Several applications, such as Quake3, use dlopen("libGL.so.1"), but
 135  * LD_PRELOAD does not intercept symbols obtained via dlopen/dlsym, therefore
 136  * we need to intercept the dlopen() call here, and redirect to our wrapper
 137  * shared object.
 138  */
 139 extern "C" PUBLIC
 140 void * dlopen(const char *filename, int flag)
 141 {
 142     void *handle;
 143
 144     handle = _dlopen(filename, flag);
 145
 146     const char * libgl_filename = getenv("TRACE_LIBGL");
 147
 148     if (filename && handle && !libgl_filename) {
 149         if (0) {
 150             os::log("apitrace: warning: dlopen(\"%s\", 0x%x)\n", filename, flag);
 151         }
 152
 153         // FIXME: handle absolute paths and other versions
 154         if (strcmp(filename, "libGL.so") == 0 ||
 155             strcmp(filename, "libGL.so.1") == 0) {
 156
 157             // Use the true libGL.so handle instead of RTLD_NEXT from now on
 158             _libGlHandle = handle;
 159
 160             // Get the file path for our shared object, and use it instead
 161             static int dummy = 0xdeedbeef;
 162             Dl_info info;
 163             if (dladdr(&dummy, &info)) {
 164                 os::log("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
 165                 handle = _dlopen(info.dli_fname, flag);
 166             } else {
 167                 os::log("apitrace: warning: dladdr() failed\n");
 168             }
 169         }
 170     }
 171
 172     return handle;
 173 }
 174
 175
 176
 177 '''