git.cworth.org Git - apitrace/blob - wrappers/egltrace.py

   1 ##########################################################################
   2 #
   3 # Copyright 2011 LunarG, Inc.
   4 # All Rights Reserved.
   5 #
   6 # Based on glxtrace.py, which has
   7 #
   8 #   Copyright 2011 Jose Fonseca
   9 #   Copyright 2008-2010 VMware, Inc.
  10 #
  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:
  17 #
  18 # The above copyright notice and this permission notice shall be included in
  19 # all copies or substantial portions of the Software.
  20 #
  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
  27 # THE SOFTWARE.
  28 #
  29 ##########################################################################/
  30
  31
  32 """EGL tracing generator."""
  33
  34
  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
  40
  41
  42 class EglTracer(GlTracer):
  43
  44     def isFunctionPublic(self, function):
  45         # The symbols visible in libEGL.so can vary, so expose them all
  46         return True
  47
  48     getProcAddressFunctionNames = [
  49         "eglGetProcAddress",
  50     ]
  51
  52     def traceFunctionImplBody(self, function):
  53         GlTracer.traceFunctionImplBody(self, function)
  54
  55         if function.name == 'eglCreateContext':
  56             print '    if (_result != EGL_NO_CONTEXT)'
  57             print '        gltrace::createContext((uintptr_t)_result);'
  58
  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;'
  72             print '            else'
  73             print '                tr->profile = gltrace::PROFILE_ES2;'
  74             print '        } else {'
  75             print '            gltrace::clearContext();'
  76             print '        }'
  77             print '    }'
  78
  79         if function.name == 'eglDestroyContext':
  80             print '    if (_result) {'
  81             print '        gltrace::releaseContext((uintptr_t)ctx);'
  82             print '    }'
  83
  84 if __name__ == '__main__':
  85     print '#include <stdlib.h>'
  86     print '#include <string.h>'
  87     print '#include <dlfcn.h>'
  88     print
  89     print '#include "trace_writer_local.hpp"'
  90     print
  91     print '// To validate our prototypes'
  92     print '#define GL_GLEXT_PROTOTYPES'
  93     print '#define EGL_EGLEXT_PROTOTYPES'
  94     print
  95     print '#include "glproc.hpp"'
  96     print '#include "glsize.hpp"'
  97     print
  98
  99     api = API()
 100     api.addApi(eglapi)
 101     api.addApi(glapi)
 102     api.addApi(glesapi)
 103     tracer = EglTracer()
 104     tracer.traceApi(api)
 105
 106     print r'''
 107
 108
 109 /*
 110  * Android does not support LD_PRELOAD.
 111  */
 112 #if !defined(ANDROID)
 113
 114
 115 /*
 116  * Invoke the true dlopen() function.
 117  */
 118 static void *_dlopen(const char *filename, int flag)
 119 {
 120     typedef void * (*PFN_DLOPEN)(const char *, int);
 121     static PFN_DLOPEN dlopen_ptr = NULL;
 122
 123     if (!dlopen_ptr) {
 124         dlopen_ptr = (PFN_DLOPEN)dlsym(RTLD_NEXT, "dlopen");
 125         if (!dlopen_ptr) {
 126             os::log("apitrace: error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
 127             return NULL;
 128         }
 129     }
 130
 131     return dlopen_ptr(filename, flag);
 132 }
 133
 134
 135 /*
 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
 139  * shared object.
 140  */
 141 extern "C" PUBLIC
 142 void * dlopen(const char *filename, int flag)
 143 {
 144     bool intercept = false;
 145
 146     if (filename) {
 147         intercept =
 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;
 156
 157         if (intercept) {
 158             os::log("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
 159
 160             /* The current dispatch implementation relies on core entry-points to be globally available, so force this.
 161              *
 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.
 165              */
 166             flag &= ~RTLD_LOCAL;
 167             flag |= RTLD_GLOBAL;
 168         }
 169     }
 170
 171     void *handle = _dlopen(filename, flag);
 172
 173     if (intercept) {
 174         // Get the file path for our shared object, and use it instead
 175         static int dummy = 0xdeedbeef;
 176         Dl_info info;
 177         if (dladdr(&dummy, &info)) {
 178             handle = _dlopen(info.dli_fname, flag);
 179         } else {
 180             os::log("apitrace: warning: dladdr() failed\n");
 181         }
 182     }
 183
 184     return handle;
 185 }
 186
 187
 188 #endif /* !ANDROID */
 189
 190
 191 #if defined(ANDROID)
 192
 193 /*
 194  * Undocumented Android extensions used by Dalvik which have bound information
 195  * passed to it, but is currently ignored, so probably unreliable.
 196  *
 197  * See:
 198  * https://github.com/android/platform_frameworks_base/blob/master/opengl/libs/GLES_CM/gl.cpp
 199  */
 200
 201 extern "C" PUBLIC
 202 void APIENTRY glColorPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 203     (void)count;
 204     glColorPointer(size, type, stride, pointer);
 205 }
 206
 207 extern "C" PUBLIC
 208 void APIENTRY glNormalPointerBounds(GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 209     (void)count;
 210     glNormalPointer(type, stride, pointer);
 211 }
 212
 213 extern "C" PUBLIC
 214 void APIENTRY glTexCoordPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 215     (void)count;
 216     glTexCoordPointer(size, type, stride, pointer);
 217 }
 218
 219 extern "C" PUBLIC
 220 void APIENTRY glVertexPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 221     (void)count;
 222     glVertexPointer(size, type, stride, pointer);
 223 }
 224
 225 extern "C" PUBLIC
 226 void GL_APIENTRY glPointSizePointerOESBounds(GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
 227     (void)count;
 228     glPointSizePointerOES(type, stride, pointer);
 229 }
 230
 231 extern "C" PUBLIC
 232 void APIENTRY glMatrixIndexPointerOESBounds(GLint size, GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
 233     (void)count;
 234     glMatrixIndexPointerOES(size, type, stride, pointer);
 235 }
 236
 237 extern "C" PUBLIC
 238 void APIENTRY glWeightPointerOESBounds(GLint size, GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
 239     (void)count;
 240     glWeightPointerOES(size, type, stride, pointer);
 241 }
 242
 243 /*
 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.
 247  */
 248
 249 #endif /* ANDROID */
 250
 251
 252 '''