1 ##########################################################################
3 # Copyright 2011 LunarG, Inc.
6 # Based on glxtrace.py, which has
8 # Copyright 2011 Jose Fonseca
9 # Copyright 2008-2010 VMware, Inc.
11 # Permission is hereby granted, free of charge, to any person obtaining a copy
12 # of this software and associated documentation files (the "Software"), to deal
13 # in the Software without restriction, including without limitation the rights
14 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 # copies of the Software, and to permit persons to whom the Software is
16 # furnished to do so, subject to the following conditions:
18 # The above copyright notice and this permission notice shall be included in
19 # all copies or substantial portions of the Software.
21 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 ##########################################################################/
32 """EGL tracing generator."""
35 from gltrace import GlTracer
36 from specs.stdapi import API
37 from specs.glapi import glapi
38 from specs.eglapi import eglapi
39 from specs.glesapi import glesapi
42 class EglTracer(GlTracer):
44 def isFunctionPublic(self, function):
45 # The symbols visible in libEGL.so can vary, so expose them all
48 getProcAddressFunctionNames = [
52 def traceFunctionImplBody(self, function):
53 GlTracer.traceFunctionImplBody(self, function)
55 if function.name == 'eglCreateContext':
56 print ' if (_result != EGL_NO_CONTEXT)'
57 print ' gltrace::createContext((uintptr_t)_result);'
59 if function.name == 'eglMakeCurrent':
60 print ' if (_result) {'
61 print ' // update the profile'
62 print ' if (ctx != EGL_NO_CONTEXT) {'
63 print ' EGLint api = EGL_OPENGL_ES_API, version = 1;'
64 print ' gltrace::setContext((uintptr_t)ctx);'
65 print ' gltrace::Context *tr = gltrace::getContext();'
66 print ' _eglQueryContext(dpy, ctx, EGL_CONTEXT_CLIENT_TYPE, &api);'
67 print ' _eglQueryContext(dpy, ctx, EGL_CONTEXT_CLIENT_VERSION, &version);'
68 print ' if (api == EGL_OPENGL_API)'
69 print ' tr->profile = gltrace::PROFILE_COMPAT;'
70 print ' else if (version == 1)'
71 print ' tr->profile = gltrace::PROFILE_ES1;'
73 print ' tr->profile = gltrace::PROFILE_ES2;'
75 print ' gltrace::clearContext();'
79 if function.name == 'eglDestroyContext':
80 print ' if (_result) {'
81 print ' gltrace::releaseContext((uintptr_t)ctx);'
84 if __name__ == '__main__':
85 print '#include <stdlib.h>'
86 print '#include <string.h>'
87 print '#include <dlfcn.h>'
89 print '#include "trace_writer_local.hpp"'
91 print '// To validate our prototypes'
92 print '#define GL_GLEXT_PROTOTYPES'
93 print '#define EGL_EGLEXT_PROTOTYPES'
95 print '#include "glproc.hpp"'
96 print '#include "glsize.hpp"'
110 * Android does not support LD_PRELOAD.
112 #if !defined(ANDROID)
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)
144 bool intercept = false;
148 strcmp(filename, "libEGL.so") == 0 ||
149 strcmp(filename, "libEGL.so.1") == 0 ||
150 strcmp(filename, "libGLESv1_CM.so") == 0 ||
151 strcmp(filename, "libGLESv1_CM.so.1") == 0 ||
152 strcmp(filename, "libGLESv2.so") == 0 ||
153 strcmp(filename, "libGLESv2.so.2") == 0 ||
154 strcmp(filename, "libGL.so") == 0 ||
155 strcmp(filename, "libGL.so.1") == 0;
158 os::log("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
160 /* The current dispatch implementation relies on core entry-points to be globally available, so force this.
162 * TODO: A better approach would be note down the entry points here and
163 * use them latter. Another alternative would be to reopen the library
164 * with RTLD_NOLOAD | RTLD_GLOBAL.
171 void *handle = _dlopen(filename, flag);
174 // Get the file path for our shared object, and use it instead
175 static int dummy = 0xdeedbeef;
177 if (dladdr(&dummy, &info)) {
178 handle = _dlopen(info.dli_fname, flag);
180 os::log("apitrace: warning: dladdr() failed\n");
188 #endif /* !ANDROID */
194 * Undocumented Android extensions used by Dalvik which have bound information
195 * passed to it, but is currently ignored, so probably unreliable.
198 * https://github.com/android/platform_frameworks_base/blob/master/opengl/libs/GLES_CM/gl.cpp
202 void APIENTRY glColorPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
204 glColorPointer(size, type, stride, pointer);
208 void APIENTRY glNormalPointerBounds(GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
210 glNormalPointer(type, stride, pointer);
214 void APIENTRY glTexCoordPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
216 glTexCoordPointer(size, type, stride, pointer);
220 void APIENTRY glVertexPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
222 glVertexPointer(size, type, stride, pointer);
226 void GL_APIENTRY glPointSizePointerOESBounds(GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
228 glPointSizePointerOES(type, stride, pointer);
232 void APIENTRY glMatrixIndexPointerOESBounds(GLint size, GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
234 glMatrixIndexPointerOES(size, type, stride, pointer);
238 void APIENTRY glWeightPointerOESBounds(GLint size, GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
240 glWeightPointerOES(size, type, stride, pointer);
244 * There is also a glVertexAttribPointerBounds in
245 * https://github.com/android/platform_frameworks_base/blob/master/opengl/tools/glgen/stubs/gles11/GLES20cHeader.cpp
246 * but is it not exported.