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 specs.stdapi import API
32 from specs.glapi import glapi
33 from specs.glxapi import glxapi
34 from gltrace import GlTracer
35 from dispatch import function_pointer_type, function_pointer_value
38 class GlxTracer(GlTracer):
40 def is_public_function(self, function):
41 # The symbols visible in libGL.so can vary, so expose them all
44 def wrap_ret(self, function, instance):
45 GlTracer.wrap_ret(self, function, instance)
47 if function.name in ("glXGetProcAddress", "glXGetProcAddressARB"):
48 print ' %s = __unwrap_proc_addr(procName, %s);' % (instance, instance)
51 if __name__ == '__main__':
53 print '#include <stdlib.h>'
54 print '#include <string.h>'
56 print '#ifndef _GNU_SOURCE'
57 print '#define _GNU_SOURCE // for dladdr'
59 print '#include <dlfcn.h>'
61 print '#include "trace_writer.hpp"'
63 print '// To validate our prototypes'
64 print '#define GL_GLEXT_PROTOTYPES'
65 print '#define GLX_GLXEXT_PROTOTYPES'
67 print '#include "glproc.hpp"'
68 print '#include "glsize.hpp"'
70 print 'static __GLXextFuncPtr __unwrap_proc_addr(const GLubyte * procName, __GLXextFuncPtr procPtr);'
79 print 'static __GLXextFuncPtr __unwrap_proc_addr(const GLubyte * procName, __GLXextFuncPtr procPtr) {'
80 print ' if (!procPtr) {'
81 print ' return procPtr;'
83 for f in api.functions:
84 ptype = function_pointer_type(f)
85 pvalue = function_pointer_value(f)
86 print ' if (strcmp("%s", (const char *)procName) == 0) {' % f.name
87 print ' %s = (%s)procPtr;' % (pvalue, ptype)
88 print ' return (__GLXextFuncPtr)&%s;' % (f.name,)
90 print ' os::log("apitrace: warning: unknown function \\"%s\\"\\n", (const char *)procName);'
91 print ' return procPtr;'
98 * Handle to the true libGL.so
100 static void *libgl_handle = NULL;
104 * Invoke the true dlopen() function.
106 static void *__dlopen(const char *filename, int flag)
108 typedef void * (*PFNDLOPEN)(const char *, int);
109 static PFNDLOPEN dlopen_ptr = NULL;
112 dlopen_ptr = (PFNDLOPEN)dlsym(RTLD_NEXT, "dlopen");
114 os::log("apitrace: error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
119 return dlopen_ptr(filename, flag);
124 * Several applications, such as Quake3, use dlopen("libGL.so.1"), but
125 * LD_PRELOAD does not intercept symbols obtained via dlopen/dlsym, therefore
126 * we need to intercept the dlopen() call here, and redirect to our wrapper
130 void * dlopen(const char *filename, int flag)
134 handle = __dlopen(filename, flag);
136 const char * libgl_filename = getenv("TRACE_LIBGL");
138 if (filename && handle && !libgl_filename) {
140 os::log("apitrace: warning: dlopen(\"%s\", 0x%x)\n", filename, flag);
143 // FIXME: handle absolute paths and other versions
144 if (strcmp(filename, "libGL.so") == 0 ||
145 strcmp(filename, "libGL.so.1") == 0) {
147 // Use the true libGL.so handle instead of RTLD_NEXT from now on
148 libgl_handle = handle;
150 // Get the file path for our shared object, and use it instead
151 static int dummy = 0xdeedbeef;
153 if (dladdr(&dummy, &info)) {
154 os::log("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
155 handle = __dlopen(info.dli_fname, flag);
157 os::log("apitrace: warning: dladdr() failed\n");
167 * Lookup a libGL symbol
169 void * __libgl_sym(const char *symbol)
175 * The app doesn't directly link against libGL.so, nor does it directly
176 * dlopen it. So we have to load it ourselves.
179 const char * libgl_filename = getenv("TRACE_LIBGL");
181 if (!libgl_filename) {
183 * Try to use whatever libGL.so the library is linked against.
186 result = dlsym(RTLD_NEXT, symbol);
188 libgl_handle = RTLD_NEXT;
192 libgl_filename = "libGL.so.1";
196 * It would have been preferable to use RTLD_LOCAL to ensure that the
197 * application can never access libGL.so symbols directly, but this
198 * won't work, given libGL.so often loads a driver specific SO and
199 * exposes symbols to it.
202 libgl_handle = __dlopen(libgl_filename, RTLD_GLOBAL | RTLD_LAZY);
204 os::log("apitrace: error: couldn't find libGL.so\n");
209 return dlsym(libgl_handle, symbol);