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