git.cworth.org Git - apitrace/blob - retrace.py

   1 ##########################################################################
   2 #
   3 # Copyright 2010 VMware, Inc.
   4 # All Rights Reserved.
   5 #
   6 # Permission is hereby granted, free of charge, to any person obtaining a copy
   7 # of this software and associated documentation files (the "Software"), to deal
   8 # in the Software without restriction, including without limitation the rights
   9 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 # copies of the Software, and to permit persons to whom the Software is
  11 # furnished to do so, subject to the following conditions:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies or substantial portions of the Software.
  15 #
  16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 # THE SOFTWARE.
  23 #
  24 ##########################################################################/
  25
  26
  27 import stdapi
  28 import glapi
  29
  30
  31
  32 class ConstRemover(stdapi.Rebuilder):
  33
  34     def visit_const(self, const):
  35         return const.type
  36
  37     def visit_opaque(self, opaque):
  38         expr = opaque.expr
  39         if expr.startswith('const '):
  40             expr = expr[6:]
  41         return stdapi.Opaque(expr)
  42
  43
  44 class ValueExtractor(stdapi.Visitor):
  45
  46     def visit_literal(self, literal, lvalue, rvalue):
  47         if literal.format == 'Bool':
  48             print '    %s = static_cast<bool>(%s);' % (lvalue, rvalue)
  49         else:
  50             print '    %s = %s;' % (lvalue, rvalue)
  51
  52     def visit_const(self, const, lvalue, rvalue):
  53         self.visit(const.type, lvalue, rvalue)
  54
  55     def visit_alias(self, alias, lvalue, rvalue):
  56         self.visit(alias.type, lvalue, rvalue)
  57
  58     def visit_enum(self, enum, lvalue, rvalue):
  59         print '    %s = %s;' % (lvalue, rvalue)
  60
  61     def visit_bitmask(self, bitmask, lvalue, rvalue):
  62         self.visit(bitmask.type, lvalue, rvalue)
  63
  64     def visit_array(self, array, lvalue, rvalue):
  65         print '    const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (array.id, rvalue)
  66         print '    if (__a%s) {' % (array.id)
  67         length = '__a%s->values.size()' % array.id
  68         print '        %s = new %s[%s];' % (lvalue, array.type, length)
  69         index = '__j' + array.id
  70         print '        for(size_t {i} = 0; {i} < {length}; ++{i}) {{'.format(i = index, length = length)
  71         try:
  72             self.visit(array.type, '%s[%s]' % (lvalue, index), '*__a%s->values[%s]' % (array.id, index))
  73         finally:
  74             print '        }'
  75             print '    } else {'
  76             print '        %s = NULL;' % lvalue
  77             print '    }'
  78
  79     def visit_pointer(self, pointer, lvalue, rvalue):
  80         print '    const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (pointer.id, rvalue)
  81         print '    if (__a%s) {' % (pointer.id)
  82         print '        %s = new %s;' % (lvalue, pointer.type)
  83         try:
  84             self.visit(pointer.type, '%s[0]' % (lvalue,), '*__a%s->values[0]' % (pointer.id,))
  85         finally:
  86             print '    } else {'
  87             print '        %s = NULL;' % lvalue
  88             print '    }'
  89
  90     def visit_handle(self, handle, lvalue, rvalue):
  91         self.visit(handle.type, lvalue, "__%s_map[%s]" %(handle.name, rvalue));
  92         print '    if (verbosity >= 2)'
  93         print '        std::cout << "%s " << static_cast<%s>(%s) << " <- " << %s << "\\n";' % (handle.name, handle.type, rvalue, lvalue)
  94
  95     def visit_blob(self, blob, lvalue, rvalue):
  96         print '    %s = static_cast<%s>((%s).blob());' % (lvalue, blob, rvalue)
  97
  98     def visit_string(self, string, lvalue, rvalue):
  99         print '    %s = (%s)((%s).string());' % (lvalue, string.expr, rvalue)
 100
 101
 102
 103 class ValueWrapper(stdapi.Visitor):
 104
 105     def visit_literal(self, literal, lvalue, rvalue):
 106         pass
 107
 108     def visit_alias(self, alias, lvalue, rvalue):
 109         self.visit(alias.type, lvalue, rvalue)
 110
 111     def visit_enum(self, enum, lvalue, rvalue):
 112         pass
 113
 114     def visit_bitmask(self, bitmask, lvalue, rvalue):
 115         pass
 116
 117     def visit_array(self, array, lvalue, rvalue):
 118         print '    const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (array.id, rvalue)
 119         print '    if (__a%s) {' % (array.id)
 120         length = '__a%s->values.size()' % array.id
 121         index = '__j' + array.id
 122         print '        for(size_t {i} = 0; {i} < {length}; ++{i}) {{'.format(i = index, length = length)
 123         try:
 124             self.visit(array.type, '%s[%s]' % (lvalue, index), '*__a%s->values[%s]' % (array.id, index))
 125         finally:
 126             print '        }'
 127             print '    }'
 128
 129     def visit_pointer(self, pointer, lvalue, rvalue):
 130         print '    const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (pointer.id, rvalue)
 131         print '    if (__a%s) {' % (pointer.id)
 132         try:
 133             self.visit(pointer.type, '%s[0]' % (lvalue,), '*__a%s->values[0]' % (pointer.id,))
 134         finally:
 135             print '    }'
 136
 137
 138     def visit_handle(self, handle, lvalue, rvalue):
 139         if handle.range is None:
 140             print "    __{handle.name}_map[static_cast<{handle.type}>({rvalue})] = {lvalue};".format(**locals())
 141             print '    if (verbosity >= 2)'
 142             print '        std::cout << "{handle.name} " << static_cast<{handle.type}>({rvalue}) << " -> " << {lvalue} << "\\n";'.format(**locals())
 143         else:
 144             i = '__h' + handle.id
 145             print '    for({handle.type} {i} = 0; {i} < {handle.range}; ++{i}) {{'.format(**locals())
 146             print '        __{handle.name}_map[static_cast<{handle.type}>({rvalue}) + {i}] = {lvalue} + {i};'.format(**locals())
 147             print '        if (verbosity >= 2)'
 148             print '            std::cout << "{handle.name} " << (static_cast<{handle.type}>({rvalue}) + {i}) << " -> " << ({lvalue} + {i}) << "\\n";'.format(**locals())
 149             print '    }'
 150
 151     def visit_blob(self, blob, lvalue, rvalue):
 152         pass
 153
 154     def visit_string(self, string, lvalue, rvalue):
 155         pass
 156
 157
 158
 159 class Retracer:
 160
 161     def retrace_function(self, function):
 162         print 'static void retrace_%s(Trace::Call &call) {' % function.name
 163         success = True
 164         for arg in function.args:
 165             arg_type = ConstRemover().visit(arg.type)
 166             #print '    // %s ->  %s' % (arg.type, arg_type)
 167             print '    %s %s;' % (arg_type, arg.name)
 168             rvalue = 'call.arg(%u)' % (arg.index,)
 169             lvalue = arg.name
 170             try:
 171                 self.extract_arg(function, arg, arg_type, lvalue, rvalue)
 172             except NotImplementedError:
 173                 success = False
 174                 print '    %s = 0; // FIXME' % arg.name
 175         if not success:
 176             print '    std::cerr << "warning: unsupported call %s\\n";' % function.name
 177             print '    return;'
 178         arg_names = ", ".join([arg.name for arg in function.args])
 179         if function.type is not stdapi.Void:
 180             print '    %s __result;' % (function.type)
 181             print '    __result = %s(%s);' % (function.name, arg_names)
 182         else:
 183             print '    %s(%s);' % (function.name, arg_names)
 184         for arg in function.args:
 185             if arg.output:
 186                 arg_type = ConstRemover().visit(arg.type)
 187                 rvalue = 'call.arg(%u)' % (arg.index,)
 188                 lvalue = arg.name
 189                 try:
 190                     ValueWrapper().visit(arg_type, lvalue, rvalue)
 191                 except NotImplementedError:
 192                     print '   // FIXME: %s' % arg.name
 193         if function.type is not stdapi.Void:
 194             rvalue = '*call.ret'
 195             lvalue = '__result'
 196             try:
 197                 ValueWrapper().visit(function.type, lvalue, rvalue)
 198             except NotImplementedError:
 199                 print '   // FIXME: result'
 200         print '}'
 201         print
 202
 203     def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
 204         ValueExtractor().visit(arg_type, lvalue, rvalue)
 205
 206     def filter_function(self, function):
 207         return True
 208
 209     def retrace_functions(self, functions):
 210         functions = filter(self.filter_function, functions)
 211
 212         for function in functions:
 213             if function.sideeffects:
 214                 self.retrace_function(function)
 215
 216         print 'static bool retrace_call(Trace::Call &call) {'
 217         for function in functions:
 218             if not function.sideeffects:
 219                 print '    if (call.name == "%s") {' % function.name
 220                 print '        return true;'
 221                 print '    }'
 222         print
 223         print '    if (verbosity >=1 ) {'
 224         print '        std::cout << call;'
 225         print '        std::cout.flush();'
 226         print '    };'
 227         print
 228         for function in functions:
 229             if function.sideeffects:
 230                 print '    if (call.name == "%s") {' % function.name
 231                 print '        retrace_%s(call);' % function.name
 232                 print '        return true;'
 233                 print '    }'
 234         print '    std::cerr << "warning: unknown call " << call.name << "\\n";'
 235         print '    return false;'
 236         print '}'
 237         print
 238
 239
 240     def retrace_api(self, api):
 241
 242         print '#include "trace_parser.hpp"'
 243         print
 244
 245         types = api.all_types()
 246         handles = [type for type in types if isinstance(type, stdapi.Handle)]
 247         handle_names = set()
 248         for handle in handles:
 249             if handle.name not in handle_names:
 250                 print 'static std::map<%s, %s> __%s_map;' % (handle.type, handle.type, handle.name)
 251                 handle_names.add(handle.name)
 252         print
 253
 254         print 'unsigned verbosity = 0;'
 255         print
 256
 257         self.retrace_functions(api.functions)
 258
 259
 260 if __name__ == '__main__':
 261     print
 262     print '#include <stdlib.h>'
 263     print '#include <string.h>'
 264     print
 265     print '#ifdef WIN32'
 266     print '#include <windows.h>'
 267     print '#endif'
 268     print
 269     print '#include <GL/glew.h>'
 270     print '#include <GL/glut.h>'
 271     print
 272     retrace_api(glapi.glapi)
 273     print '''
 274
 275 Trace::Parser parser;
 276
 277 static bool insideGlBeginEnd;
 278
 279 static void display(void) {
 280    Trace::Call *call;
 281
 282    while ((call = parser.parse_call())) {
 283       if (call->name == "glFlush" ||
 284           call->name == "glXSwapBuffers" ||
 285           call->name == "wglSwapBuffers") {
 286          glFlush();
 287          return;
 288       }
 289
 290       retrace_call(*call);
 291
 292       if (call->name == "glBegin") {
 293          insideGlBeginEnd = true;
 294       }
 295
 296       if (call->name == "glEnd") {
 297          insideGlBeginEnd = false;
 298       }
 299
 300       if (!insideGlBeginEnd) {
 301          GLenum error = glGetError();
 302          if (error != GL_NO_ERROR) {
 303             std::cerr << "warning: glGetError() = ";
 304             switch (error) {
 305             case GL_INVALID_ENUM:
 306                std::cerr << "GL_INVALID_ENUM";
 307                break;
 308             case GL_INVALID_VALUE:
 309                std::cerr << "GL_INVALID_VALUE";
 310                break;
 311             case GL_INVALID_OPERATION:
 312                std::cerr << "GL_INVALID_OPERATION";
 313                break;
 314             case GL_STACK_OVERFLOW:
 315                std::cerr << "GL_STACK_OVERFLOW";
 316                break;
 317             case GL_STACK_UNDERFLOW:
 318                std::cerr << "GL_STACK_UNDERFLOW";
 319                break;
 320             case GL_OUT_OF_MEMORY:
 321                std::cerr << "GL_OUT_OF_MEMORY";
 322                break;
 323             case GL_INVALID_FRAMEBUFFER_OPERATION:
 324                std::cerr << "GL_INVALID_FRAMEBUFFER_OPERATION";
 325                break;
 326             case GL_TABLE_TOO_LARGE:
 327                std::cerr << "GL_TABLE_TOO_LARGE";
 328                break;
 329             default:
 330                std::cerr << error;
 331                break;
 332             }
 333             std::cerr << "\\n";
 334          }
 335       }
 336    }
 337
 338    glFlush();
 339    glutIdleFunc(NULL);
 340 }
 341
 342 static void idle(void) {
 343    glutPostRedisplay();
 344 }
 345
 346 int main(int argc, char **argv)
 347 {
 348    glutInit(&argc, argv);
 349    glutInitWindowPosition(0, 0);
 350    glutInitWindowSize(800, 600);
 351    glutInitDisplayMode(GLUT_DEPTH | GLUT_RGB | GLUT_SINGLE);
 352    glutCreateWindow(argv[0]);
 353    glewInit();
 354
 355    glutDisplayFunc(&display);
 356    glutIdleFunc(&idle);
 357
 358     int i;
 359     for (i = 1; i < argc; ++i) {
 360       const char *arg = argv[i];
 361
 362       if (arg[0] != '-') {
 363          break;
 364       }
 365
 366       if (!strcmp(arg, "--")) {
 367          break;
 368       }
 369       else if (!strcmp(arg, "-v")) {
 370          ++verbosity;
 371       } else {
 372          std::cerr << "error: unknown option " << arg << "\\n";
 373          return 1;
 374       }
 375    }
 376
 377    for ( ; i < argc; ++i) {
 378       if (parser.open(argv[i])) {
 379          glutMainLoop();
 380          parser.close();
 381       }
 382    }
 383
 384    return 0;
 385 }
 386
 387 '''