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
  85 if __name__ == '__main__':
  86     print '#include <stdlib.h>'
  87     print '#include <string.h>'
  88     print '#include <dlfcn.h>'
  89     print
  90     print '#include "trace_writer_local.hpp"'
  91     print
  92     print '// To validate our prototypes'
  93     print '#define GL_GLEXT_PROTOTYPES'
  94     print '#define EGL_EGLEXT_PROTOTYPES'
  95     print
  96     print '#include "glproc.hpp"'
  97     print '#include "glsize.hpp"'
  98     print
  99
 100     api = API()
 101     api.addApi(eglapi)
 102     api.addApi(glapi)
 103     api.addApi(glesapi)
 104     tracer = EglTracer()
 105     tracer.traceApi(api)
 106
 107     print r'''
 108
 109
 110 /*
 111  * Android does not support LD_PRELOAD.
 112  */
 113 #if !defined(ANDROID)
 114
 115
 116 /*
 117  * Invoke the true dlopen() function.
 118  */
 119 static void *_dlopen(const char *filename, int flag)
 120 {
 121     typedef void * (*PFN_DLOPEN)(const char *, int);
 122     static PFN_DLOPEN dlopen_ptr = NULL;
 123
 124     if (!dlopen_ptr) {
 125         dlopen_ptr = (PFN_DLOPEN)dlsym(RTLD_NEXT, "dlopen");
 126         if (!dlopen_ptr) {
 127             os::log("apitrace: error: dlsym(RTLD_NEXT, \"dlopen\") failed\n");
 128             return NULL;
 129         }
 130     }
 131
 132     return dlopen_ptr(filename, flag);
 133 }
 134
 135
 136 /*
 137  * Several applications, such as Quake3, use dlopen("libGL.so.1"), but
 138  * LD_PRELOAD does not intercept symbols obtained via dlopen/dlsym, therefore
 139  * we need to intercept the dlopen() call here, and redirect to our wrapper
 140  * shared object.
 141  */
 142 extern "C" PUBLIC
 143 void * dlopen(const char *filename, int flag)
 144 {
 145     bool intercept = false;
 146
 147     if (filename) {
 148         intercept =
 149             strcmp(filename, "libEGL.so") == 0 ||
 150             strcmp(filename, "libEGL.so.1") == 0 ||
 151             strcmp(filename, "libGLESv1_CM.so") == 0 ||
 152             strcmp(filename, "libGLESv1_CM.so.1") == 0 ||
 153             strcmp(filename, "libGLESv2.so") == 0 ||
 154             strcmp(filename, "libGLESv2.so.2") == 0 ||
 155             strcmp(filename, "libGL.so") == 0 ||
 156             strcmp(filename, "libGL.so.1") == 0;
 157
 158         if (intercept) {
 159             os::log("apitrace: redirecting dlopen(\"%s\", 0x%x)\n", filename, flag);
 160
 161             /* The current dispatch implementation relies on core entry-points to be globally available, so force this.
 162              *
 163              * TODO: A better approach would be note down the entry points here and
 164              * use them latter. Another alternative would be to reopen the library
 165              * with RTLD_NOLOAD | RTLD_GLOBAL.
 166              */
 167             flag &= ~RTLD_LOCAL;
 168             flag |= RTLD_GLOBAL;
 169         }
 170     }
 171
 172     void *handle = _dlopen(filename, flag);
 173
 174     if (intercept) {
 175         // Get the file path for our shared object, and use it instead
 176         static int dummy = 0xdeedbeef;
 177         Dl_info info;
 178         if (dladdr(&dummy, &info)) {
 179             handle = _dlopen(info.dli_fname, flag);
 180         } else {
 181             os::log("apitrace: warning: dladdr() failed\n");
 182         }
 183     }
 184
 185     return handle;
 186 }
 187
 188
 189 #endif /* !ANDROID */
 190
 191
 192 #if defined(ANDROID)
 193
 194 /*
 195  * Undocumented Android extensions used by Dalvik which have bound information
 196  * passed to it, but is currently ignored, so probably unreliable.
 197  *
 198  * See:
 199  * https://github.com/android/platform_frameworks_base/blob/master/opengl/libs/GLES_CM/gl.cpp
 200  */
 201
 202 extern "C" PUBLIC
 203 void APIENTRY glColorPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 204     (void)count;
 205     glColorPointer(size, type, stride, pointer);
 206 }
 207
 208 extern "C" PUBLIC
 209 void APIENTRY glNormalPointerBounds(GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 210     (void)count;
 211     glNormalPointer(type, stride, pointer);
 212 }
 213
 214 extern "C" PUBLIC
 215 void APIENTRY glTexCoordPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 216     (void)count;
 217     glTexCoordPointer(size, type, stride, pointer);
 218 }
 219
 220 extern "C" PUBLIC
 221 void APIENTRY glVertexPointerBounds(GLint size, GLenum type, GLsizei stride, const GLvoid * pointer, GLsizei count) {
 222     (void)count;
 223     glVertexPointer(size, type, stride, pointer);
 224 }
 225
 226 extern "C" PUBLIC
 227 void GL_APIENTRY glPointSizePointerOESBounds(GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
 228     (void)count;
 229     glPointSizePointerOES(type, stride, pointer);
 230 }
 231
 232 extern "C" PUBLIC
 233 void APIENTRY glMatrixIndexPointerOESBounds(GLint size, GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
 234     (void)count;
 235     glMatrixIndexPointerOES(size, type, stride, pointer);
 236 }
 237
 238 extern "C" PUBLIC
 239 void APIENTRY glWeightPointerOESBounds(GLint size, GLenum type, GLsizei stride, const GLvoid *pointer, GLsizei count) {
 240     (void)count;
 241     glWeightPointerOES(size, type, stride, pointer);
 242 }
 243
 244 /*
 245  * There is also a glVertexAttribPointerBounds in
 246  * https://github.com/android/platform_frameworks_base/blob/master/opengl/tools/glgen/stubs/gles11/GLES20cHeader.cpp
 247  * but is it not exported.
 248  */
 249
 250 #endif /* ANDROID */
 251
 252
 253 '''