1 ##########################################################################
3 # Copyright 2011 Jose Fonseca
4 # Copyright 2008-2010 VMware, Inc.
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:
14 # The above copyright notice and this permission notice shall be included in
15 # all copies or substantial portions of the Software.
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
25 ##########################################################################/
28 """GLX tracing generator."""
31 from gltrace import GlTracer
32 from specs.stdapi import Module, API
33 from specs.glapi import glapi
34 from specs.glxapi import glxapi
37 class GlxTracer(GlTracer):
39 def isFunctionPublic(self, function):
40 # The symbols visible in libGL.so can vary, so expose them all
43 getProcAddressFunctionNames = [
45 "glXGetProcAddressARB",
48 createContextFunctionNames = [
50 'glXCreateContextAttribsARB',
51 'glXCreateContextWithConfigSGIX',
52 'glXCreateNewContext',
55 destroyContextFunctionNames = [
59 makeCurrentFunctionNames = [
61 'glXMakeContextCurrent',
62 'glXMakeCurrentReadSGI',
65 def traceFunctionImplBody(self, function):
66 if function.name in self.destroyContextFunctionNames:
67 print ' gltrace::releaseContext((uintptr_t)ctx);'
69 GlTracer.traceFunctionImplBody(self, function)
71 if function.name in self.createContextFunctionNames:
72 print ' if (_result != NULL)'
73 print ' gltrace::createContext((uintptr_t)_result);'
75 if function.name in self.makeCurrentFunctionNames:
76 print ' if (_result) {'
77 print ' if (ctx != NULL)'
78 print ' gltrace::setContext((uintptr_t)ctx);'
80 print ' gltrace::clearContext();'
84 if __name__ == '__main__':
86 print '#include <stdlib.h>'
87 print '#include <string.h>'
89 print '#ifndef _GNU_SOURCE'
90 print '#define _GNU_SOURCE // for dladdr'
92 print '#include <dlfcn.h>'
94 print '#include "trace_writer_local.hpp"'
96 print '// To validate our prototypes'
97 print '#define GL_GLEXT_PROTOTYPES'
98 print '#define GLX_GLXEXT_PROTOTYPES'
100 print '#include "glproc.hpp"'
101 print '#include "glsize.hpp"'
105 module.mergeModule(glxapi)
106 module.mergeModule(glapi)
108 api.addModule(module)
116 * Invoke the true dlopen() function.
118 static void *_dlopen(const char *filename, int flag)
120 typedef void * (*PFN_DLOPEN)(const char *, int);
121 static PFN_DLOPEN dlopen_ptr = NULL;
124 dlopen_ptr = (PFN_DLOPEN)dlsym(RTLD_NEXT, "dlopen");
126 os::log("apitrace: error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
131 return dlopen_ptr(filename, flag);
136 * Several applications, such as Quake3, use dlopen("libGL.so.1"), but
137 * LD_PRELOAD does not intercept symbols obtained via dlopen/dlsym, therefore
138 * we need to intercept the dlopen() call here, and redirect to our wrapper
142 void * dlopen(const char *filename, int flag)
146 handle = _dlopen(filename, flag);
148 const char * libgl_filename = getenv("TRACE_LIBGL");
150 if (filename && handle && !libgl_filename) {
152 os::log("apitrace: warning: dlopen(\"%s\", 0x%x)\n", filename, flag);
155 // FIXME: handle absolute paths and other versions
156 if (strcmp(filename, "libGL.so") == 0 ||
157 strcmp(filename, "libGL.so.1") == 0) {
159 // Use the true libGL.so handle instead of RTLD_NEXT from now on
160 _libGlHandle = handle;
162 // Get the file path for our shared object, and use it instead
163 static int dummy = 0xdeedbeef;
165 if (dladdr(&dummy, &info)) {
166 os::log("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
167 handle = _dlopen(info.dli_fname, flag);
169 os::log("apitrace: warning: dladdr() failed\n");