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 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
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 get_function_address(self, function):
45 return '__%s' % (function.name,)
47 def wrap_ret(self, function, instance):
48 if function.name in ("glXGetProcAddress", "glXGetProcAddressARB"):
49 print ' %s = __unwrap_proc_addr(procName, %s);' % (instance, instance)
52 if __name__ == '__main__':
54 print '#include <stdlib.h>'
55 print '#include <string.h>'
57 print '#ifndef _GNU_SOURCE'
58 print '#define _GNU_SOURCE // for dladdr'
60 print '#include <dlfcn.h>'
62 print '#include "trace_write.hpp"'
64 print '#include "glproc.hpp"'
65 print '#include "glsize.hpp"'
67 print 'static __GLXextFuncPtr __unwrap_proc_addr(const GLubyte * procName, __GLXextFuncPtr procPtr);'
76 print 'static __GLXextFuncPtr __unwrap_proc_addr(const GLubyte * procName, __GLXextFuncPtr procPtr) {'
77 print ' if (!procPtr) {'
78 print ' return procPtr;'
80 for f in api.functions:
81 ptype = function_pointer_type(f)
82 pvalue = function_pointer_value(f)
83 print ' if (!strcmp("%s", (const char *)procName)) {' % f.name
84 print ' %s = (%s)procPtr;' % (pvalue, ptype)
85 print ' return (__GLXextFuncPtr)&%s;' % (f.name,)
87 print ' return procPtr;'
93 static void *libgl_handle = NULL;
97 * Invoke the true dlopen() function.
99 static void *__dlopen(const char *filename, int flag)
101 typedef void * (*PFNDLOPEN)(const char *, int);
102 static PFNDLOPEN dlopen_ptr = NULL;
105 dlopen_ptr = (PFNDLOPEN)dlsym(RTLD_NEXT, "dlopen");
107 OS::DebugMessage("error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
112 return dlopen_ptr(filename, flag);
117 * Several applications, such as Quake3, use dlopen("libGL.so.1"), but
118 * LD_PRELOAD does not intercept symbols obtained via dlopen/dlsym, therefore
119 * we need to intercept the dlopen() call here, and redirect to our wrapper
123 void * dlopen(const char *filename, int flag)
127 handle = __dlopen(filename, flag);
129 if (filename && handle) {
131 OS::DebugMessage("warning: dlopen(\"%s\", 0x%x)\n", filename, flag);
134 // FIXME: handle absolute paths and other versions
135 if (strcmp(filename, "libGL.so") == 0 ||
136 strcmp(filename, "libGL.so.1") == 0) {
137 // Use the true libGL.so handle instead of RTLD_NEXT from now on
138 libgl_handle = handle;
140 // Get the file path for our shared object, and use it instead
141 static int dummy = 0xdeedbeef;
143 if (dladdr(&dummy, &info)) {
144 OS::DebugMessage("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
145 handle = __dlopen(info.dli_fname, flag);
147 OS::DebugMessage("warning: dladdr() failed\n");
157 * Lookup a libGL symbol
159 static void * __dlsym(const char *symbol)
165 * Try to use whatever libGL.so the library is linked against.
167 result = dlsym(RTLD_NEXT, symbol);
169 libgl_handle = RTLD_NEXT;
174 * The app doesn't directly link against libGL.so, nor does it directly
175 * dlopen it. So we have to load it ourselves.
177 libgl_handle = __dlopen("libGL.so", RTLD_LAZY | RTLD_LOCAL);
179 OS::DebugMessage("error: couldn't find libGL.so\n");
184 return dlsym(libgl_handle, symbol);