José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 1 | ########################################################################## |
| 2 | # |
| 3 | # Copyright 2008-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 | |
José Fonseca | 73d0a96 | 2010-11-29 14:49:34 +0000 | [diff] [blame] | 26 | """Common trace code generation.""" |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 27 | |
| 28 | |
José Fonseca | 452d325 | 2012-04-14 15:55:40 +0100 | [diff] [blame] | 29 | # Adjust path |
| 30 | import os.path |
| 31 | import sys |
| 32 | sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..')) |
| 33 | |
| 34 | |
José Fonseca | bd86a22 | 2011-09-27 09:21:38 +0100 | [diff] [blame] | 35 | import specs.stdapi as stdapi |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 36 | |
| 37 | |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 38 | def getWrapperInterfaceName(interface): |
José Fonseca | 87d1cc6 | 2010-11-29 15:57:25 +0000 | [diff] [blame] | 39 | return "Wrap" + interface.expr |
| 40 | |
José Fonseca | 6fac5ae | 2010-11-29 16:09:13 +0000 | [diff] [blame] | 41 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 42 | class ComplexValueSerializer(stdapi.OnceVisitor): |
| 43 | '''Type visitors which generates serialization functions for |
| 44 | complex types. |
| 45 | |
| 46 | Simple types are serialized inline. |
| 47 | ''' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 48 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 49 | def __init__(self, serializer): |
| 50 | stdapi.OnceVisitor.__init__(self) |
| 51 | self.serializer = serializer |
| 52 | |
| 53 | def visitVoid(self, literal): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 54 | pass |
| 55 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 56 | def visitLiteral(self, literal): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 57 | pass |
| 58 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 59 | def visitString(self, string): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 60 | pass |
| 61 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 62 | def visitConst(self, const): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 63 | self.visit(const.type) |
| 64 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 65 | def visitStruct(self, struct): |
José Fonseca | 30fb4c3 | 2012-11-04 11:07:45 +0000 | [diff] [blame] | 66 | print 'static const char * _struct%s_members[%u] = {' % (struct.tag, len(struct.members)) |
José Fonseca | 7eef8ce | 2010-11-26 15:46:36 +0000 | [diff] [blame] | 67 | for type, name, in struct.members: |
José Fonseca | 30fb4c3 | 2012-11-04 11:07:45 +0000 | [diff] [blame] | 68 | print ' "%s",' % (name,) |
| 69 | print '};' |
| 70 | print 'static const trace::StructSig _struct%s_sig = {' % (struct.tag,) |
| 71 | print ' %u, "%s", %u, _struct%s_members' % (struct.id, struct.name, len(struct.members), struct.tag) |
| 72 | print '};' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 73 | print |
| 74 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 75 | def visitArray(self, array): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 76 | self.visit(array.type) |
| 77 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 78 | def visitBlob(self, array): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 79 | pass |
| 80 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 81 | def visitEnum(self, enum): |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 82 | print 'static const trace::EnumValue _enum%s_values[] = {' % (enum.tag) |
José Fonseca | eb64451 | 2011-12-11 10:33:55 +0000 | [diff] [blame] | 83 | for value in enum.values: |
| 84 | print ' {"%s", %s},' % (value, value) |
| 85 | print '};' |
| 86 | print |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 87 | print 'static const trace::EnumSig _enum%s_sig = {' % (enum.tag) |
| 88 | print ' %u, %u, _enum%s_values' % (enum.id, len(enum.values), enum.tag) |
José Fonseca | eb64451 | 2011-12-11 10:33:55 +0000 | [diff] [blame] | 89 | print '};' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 90 | print |
| 91 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 92 | def visitBitmask(self, bitmask): |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 93 | print 'static const trace::BitmaskFlag _bitmask%s_flags[] = {' % (bitmask.tag) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 94 | for value in bitmask.values: |
José Fonseca | d35973c | 2010-11-26 14:14:45 +0000 | [diff] [blame] | 95 | print ' {"%s", %s},' % (value, value) |
| 96 | print '};' |
| 97 | print |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 98 | print 'static const trace::BitmaskSig _bitmask%s_sig = {' % (bitmask.tag) |
| 99 | print ' %u, %u, _bitmask%s_flags' % (bitmask.id, len(bitmask.values), bitmask.tag) |
José Fonseca | d35973c | 2010-11-26 14:14:45 +0000 | [diff] [blame] | 100 | print '};' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 101 | print |
| 102 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 103 | def visitPointer(self, pointer): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 104 | self.visit(pointer.type) |
| 105 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 106 | def visitIntPointer(self, pointer): |
| 107 | pass |
| 108 | |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 109 | def visitObjPointer(self, pointer): |
| 110 | self.visit(pointer.type) |
| 111 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 112 | def visitLinearPointer(self, pointer): |
| 113 | self.visit(pointer.type) |
| 114 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 115 | def visitHandle(self, handle): |
José Fonseca | 50d78d8 | 2010-11-23 22:13:14 +0000 | [diff] [blame] | 116 | self.visit(handle.type) |
| 117 | |
José Fonseca | b89c593 | 2012-04-01 22:47:11 +0200 | [diff] [blame] | 118 | def visitReference(self, reference): |
| 119 | self.visit(reference.type) |
| 120 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 121 | def visitAlias(self, alias): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 122 | self.visit(alias.type) |
| 123 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 124 | def visitOpaque(self, opaque): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 125 | pass |
| 126 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 127 | def visitInterface(self, interface): |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 128 | pass |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 129 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 130 | def visitPolymorphic(self, polymorphic): |
José Fonseca | b95e372 | 2012-04-16 14:01:15 +0100 | [diff] [blame] | 131 | if not polymorphic.contextLess: |
| 132 | return |
José Fonseca | 06e8519 | 2011-10-16 14:15:36 +0100 | [diff] [blame] | 133 | print 'static void _write__%s(int selector, const %s & value) {' % (polymorphic.tag, polymorphic.expr) |
José Fonseca | c636b9d | 2011-10-14 10:15:02 +0100 | [diff] [blame] | 134 | print ' switch (selector) {' |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 135 | for cases, type in polymorphic.iterSwitch(): |
José Fonseca | c636b9d | 2011-10-14 10:15:02 +0100 | [diff] [blame] | 136 | for case in cases: |
| 137 | print ' %s:' % case |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 138 | self.serializer.visit(type, 'static_cast<%s>(value)' % (type,)) |
José Fonseca | c636b9d | 2011-10-14 10:15:02 +0100 | [diff] [blame] | 139 | print ' break;' |
| 140 | print ' }' |
| 141 | print '}' |
| 142 | print |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 143 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 144 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 145 | class ValueSerializer(stdapi.Visitor): |
| 146 | '''Visitor which generates code to serialize any type. |
| 147 | |
| 148 | Simple types are serialized inline here, whereas the serialization of |
| 149 | complex types is dispatched to the serialization functions generated by |
| 150 | ComplexValueSerializer visitor above. |
| 151 | ''' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 152 | |
José Fonseca | 30fb4c3 | 2012-11-04 11:07:45 +0000 | [diff] [blame] | 153 | def __init__(self): |
| 154 | #stdapi.Visitor.__init__(self) |
| 155 | self.indices = [] |
| 156 | self.instances = [] |
| 157 | |
| 158 | def expand(self, expr): |
| 159 | # Expand a C expression, replacing certain variables |
| 160 | variables = {} |
| 161 | try: |
| 162 | variables['self'] = self.instances[-1] |
| 163 | except IndexError: |
| 164 | pass |
| 165 | try: |
| 166 | variables['i'] = self.indices[-1] |
| 167 | except IndexError: |
| 168 | pass |
| 169 | expandedExpr = expr.format(**variables) |
| 170 | if expandedExpr != expr: |
| 171 | sys.stderr.write(" %r -> %r\n" % (expr, expandedExpr)) |
| 172 | return expandedExpr |
| 173 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 174 | def visitLiteral(self, literal, instance): |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 175 | print ' trace::localWriter.write%s(%s);' % (literal.kind, instance) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 176 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 177 | def visitString(self, string, instance): |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 178 | if not string.wide: |
José Fonseca | 280a176 | 2012-01-31 15:10:13 +0000 | [diff] [blame] | 179 | cast = 'const char *' |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 180 | suffix = 'String' |
José Fonseca | e6a50bd | 2010-11-24 10:12:22 +0000 | [diff] [blame] | 181 | else: |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 182 | cast = 'const wchar_t *' |
| 183 | suffix = 'WString' |
José Fonseca | 280a176 | 2012-01-31 15:10:13 +0000 | [diff] [blame] | 184 | if cast != string.expr: |
| 185 | # reinterpret_cast is necessary for GLubyte * <=> char * |
| 186 | instance = 'reinterpret_cast<%s>(%s)' % (cast, instance) |
| 187 | if string.length is not None: |
| 188 | length = ', %s' % string.length |
| 189 | else: |
| 190 | length = '' |
José Fonseca | bcfc81b | 2012-08-07 21:07:22 +0100 | [diff] [blame] | 191 | print ' trace::localWriter.write%s(%s%s);' % (suffix, instance, length) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 192 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 193 | def visitConst(self, const, instance): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 194 | self.visit(const.type, instance) |
| 195 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 196 | def visitStruct(self, struct, instance): |
José Fonseca | 30fb4c3 | 2012-11-04 11:07:45 +0000 | [diff] [blame] | 197 | print ' trace::localWriter.beginStruct(&_struct%s_sig);' % (struct.tag,) |
| 198 | self.instances.append(instance) |
| 199 | try: |
| 200 | for type, name in struct.members: |
| 201 | self.visit(type, '(%s).%s' % (instance, name,)) |
| 202 | finally: |
| 203 | self.instances.pop() |
| 204 | print ' trace::localWriter.endStruct();' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 205 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 206 | def visitArray(self, array, instance): |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 207 | length = '_c' + array.type.tag |
| 208 | index = '_i' + array.type.tag |
José Fonseca | fd34e4e | 2011-06-03 19:34:29 +0100 | [diff] [blame] | 209 | print ' if (%s) {' % instance |
Carl Worth | 6141744 | 2012-06-04 14:47:33 -0700 | [diff] [blame] | 210 | print ' size_t %s = %s > 0 ? %s : 0;' % (length, array.length, array.length) |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 211 | print ' trace::localWriter.beginArray(%s);' % length |
José Fonseca | fd34e4e | 2011-06-03 19:34:29 +0100 | [diff] [blame] | 212 | print ' for (size_t %s = 0; %s < %s; ++%s) {' % (index, index, length, index) |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 213 | print ' trace::localWriter.beginElement();' |
José Fonseca | 30fb4c3 | 2012-11-04 11:07:45 +0000 | [diff] [blame] | 214 | self.indices.append(index) |
| 215 | try: |
| 216 | self.visit(array.type, '(%s)[%s]' % (instance, index)) |
| 217 | finally: |
| 218 | self.indices.pop() |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 219 | print ' trace::localWriter.endElement();' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 220 | print ' }' |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 221 | print ' trace::localWriter.endArray();' |
José Fonseca | fd34e4e | 2011-06-03 19:34:29 +0100 | [diff] [blame] | 222 | print ' } else {' |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 223 | print ' trace::localWriter.writeNull();' |
José Fonseca | fd34e4e | 2011-06-03 19:34:29 +0100 | [diff] [blame] | 224 | print ' }' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 225 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 226 | def visitBlob(self, blob, instance): |
José Fonseca | 30fb4c3 | 2012-11-04 11:07:45 +0000 | [diff] [blame] | 227 | print ' trace::localWriter.writeBlob(%s, %s);' % (instance, self.expand(blob.size)) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 228 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 229 | def visitEnum(self, enum, instance): |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 230 | print ' trace::localWriter.writeEnum(&_enum%s_sig, %s);' % (enum.tag, instance) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 231 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 232 | def visitBitmask(self, bitmask, instance): |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 233 | print ' trace::localWriter.writeBitmask(&_bitmask%s_sig, %s);' % (bitmask.tag, instance) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 234 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 235 | def visitPointer(self, pointer, instance): |
José Fonseca | dbaae49 | 2011-04-21 09:28:10 +0100 | [diff] [blame] | 236 | print ' if (%s) {' % instance |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 237 | print ' trace::localWriter.beginArray(1);' |
| 238 | print ' trace::localWriter.beginElement();' |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 239 | self.visit(pointer.type, "*" + instance) |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 240 | print ' trace::localWriter.endElement();' |
| 241 | print ' trace::localWriter.endArray();' |
José Fonseca | fd34e4e | 2011-06-03 19:34:29 +0100 | [diff] [blame] | 242 | print ' } else {' |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 243 | print ' trace::localWriter.writeNull();' |
José Fonseca | fd34e4e | 2011-06-03 19:34:29 +0100 | [diff] [blame] | 244 | print ' }' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 245 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 246 | def visitIntPointer(self, pointer, instance): |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 247 | print ' trace::localWriter.writePointer((uintptr_t)%s);' % instance |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 248 | |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 249 | def visitObjPointer(self, pointer, instance): |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 250 | print ' trace::localWriter.writePointer((uintptr_t)%s);' % instance |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 251 | |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 252 | def visitLinearPointer(self, pointer, instance): |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 253 | print ' trace::localWriter.writePointer((uintptr_t)%s);' % instance |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 254 | |
José Fonseca | b89c593 | 2012-04-01 22:47:11 +0200 | [diff] [blame] | 255 | def visitReference(self, reference, instance): |
| 256 | self.visit(reference.type, instance) |
| 257 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 258 | def visitHandle(self, handle, instance): |
José Fonseca | 50d78d8 | 2010-11-23 22:13:14 +0000 | [diff] [blame] | 259 | self.visit(handle.type, instance) |
| 260 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 261 | def visitAlias(self, alias, instance): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 262 | self.visit(alias.type, instance) |
| 263 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 264 | def visitOpaque(self, opaque, instance): |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 265 | print ' trace::localWriter.writePointer((uintptr_t)%s);' % instance |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 266 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 267 | def visitInterface(self, interface, instance): |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 268 | assert False |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 269 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 270 | def visitPolymorphic(self, polymorphic, instance): |
José Fonseca | b95e372 | 2012-04-16 14:01:15 +0100 | [diff] [blame] | 271 | if polymorphic.contextLess: |
| 272 | print ' _write__%s(%s, %s);' % (polymorphic.tag, polymorphic.switchExpr, instance) |
| 273 | else: |
| 274 | print ' switch (%s) {' % polymorphic.switchExpr |
| 275 | for cases, type in polymorphic.iterSwitch(): |
| 276 | for case in cases: |
| 277 | print ' %s:' % case |
| 278 | self.visit(type, 'static_cast<%s>(%s)' % (type, instance)) |
| 279 | print ' break;' |
| 280 | print ' }' |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 281 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 282 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 283 | class WrapDecider(stdapi.Traverser): |
| 284 | '''Type visitor which will decide wheter this type will need wrapping or not. |
| 285 | |
| 286 | For complex types (arrays, structures), we need to know this before hand. |
| 287 | ''' |
| 288 | |
| 289 | def __init__(self): |
| 290 | self.needsWrapping = False |
| 291 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 292 | def visitLinearPointer(self, void): |
| 293 | pass |
| 294 | |
| 295 | def visitInterface(self, interface): |
| 296 | self.needsWrapping = True |
| 297 | |
| 298 | |
| 299 | class ValueWrapper(stdapi.Traverser): |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 300 | '''Type visitor which will generate the code to wrap an instance. |
| 301 | |
| 302 | Wrapping is necessary mostly for interfaces, however interface pointers can |
| 303 | appear anywhere inside complex types. |
| 304 | ''' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 305 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 306 | def visitStruct(self, struct, instance): |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 307 | for type, name in struct.members: |
| 308 | self.visit(type, "(%s).%s" % (instance, name)) |
| 309 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 310 | def visitArray(self, array, instance): |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 311 | print " if (%s) {" % instance |
| 312 | print " for (size_t _i = 0, _s = %s; _i < _s; ++_i) {" % array.length |
| 313 | self.visit(array.type, instance + "[_i]") |
| 314 | print " }" |
| 315 | print " }" |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 316 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 317 | def visitPointer(self, pointer, instance): |
José Fonseca | 3a2a476 | 2011-05-26 11:37:30 +0100 | [diff] [blame] | 318 | print " if (%s) {" % instance |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 319 | self.visit(pointer.type, "*" + instance) |
José Fonseca | 3a2a476 | 2011-05-26 11:37:30 +0100 | [diff] [blame] | 320 | print " }" |
José Fonseca | 59ee88e | 2012-01-15 14:24:10 +0000 | [diff] [blame] | 321 | |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 322 | def visitObjPointer(self, pointer, instance): |
José Fonseca | 9782b29 | 2012-04-14 22:02:42 +0100 | [diff] [blame] | 323 | elem_type = pointer.type.mutable() |
| 324 | if isinstance(elem_type, stdapi.Interface): |
| 325 | self.visitInterfacePointer(elem_type, instance) |
| 326 | else: |
José Fonseca | 467a42a | 2012-05-04 11:49:19 +0100 | [diff] [blame] | 327 | self.visitPointer(pointer, instance) |
José Fonseca | fbcf683 | 2012-04-05 07:10:30 +0100 | [diff] [blame] | 328 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 329 | def visitInterface(self, interface, instance): |
José Fonseca | 9782b29 | 2012-04-14 22:02:42 +0100 | [diff] [blame] | 330 | raise NotImplementedError |
| 331 | |
| 332 | def visitInterfacePointer(self, interface, instance): |
José Fonseca | 3a2a476 | 2011-05-26 11:37:30 +0100 | [diff] [blame] | 333 | print " if (%s) {" % instance |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 334 | print " %s = new %s(%s);" % (instance, getWrapperInterfaceName(interface), instance) |
José Fonseca | 3a2a476 | 2011-05-26 11:37:30 +0100 | [diff] [blame] | 335 | print " }" |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 336 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 337 | def visitPolymorphic(self, type, instance): |
José Fonseca | 16d46dd | 2011-10-13 09:52:52 +0100 | [diff] [blame] | 338 | # XXX: There might be polymorphic values that need wrapping in the future |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 339 | raise NotImplementedError |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 340 | |
| 341 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 342 | class ValueUnwrapper(ValueWrapper): |
| 343 | '''Reverse of ValueWrapper.''' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 344 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 345 | allocated = False |
| 346 | |
| 347 | def visitArray(self, array, instance): |
| 348 | if self.allocated or isinstance(instance, stdapi.Interface): |
| 349 | return ValueWrapper.visitArray(self, array, instance) |
| 350 | elem_type = array.type.mutable() |
| 351 | print " if (%s && %s) {" % (instance, array.length) |
| 352 | print " %s * _t = static_cast<%s *>(alloca(%s * sizeof *_t));" % (elem_type, elem_type, array.length) |
| 353 | print " for (size_t _i = 0, _s = %s; _i < _s; ++_i) {" % array.length |
| 354 | print " _t[_i] = %s[_i];" % instance |
| 355 | self.allocated = True |
| 356 | self.visit(array.type, "_t[_i]") |
| 357 | print " }" |
| 358 | print " %s = _t;" % instance |
| 359 | print " }" |
| 360 | |
José Fonseca | 9782b29 | 2012-04-14 22:02:42 +0100 | [diff] [blame] | 361 | def visitInterfacePointer(self, interface, instance): |
José Fonseca | 7aa8690 | 2012-01-31 20:14:31 +0000 | [diff] [blame] | 362 | print r' if (%s) {' % instance |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 363 | print r' const %s *pWrapper = static_cast<const %s*>(%s);' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), instance) |
José Fonseca | 7aa8690 | 2012-01-31 20:14:31 +0000 | [diff] [blame] | 364 | print r' if (pWrapper && pWrapper->m_dwMagic == 0xd8365d6c) {' |
| 365 | print r' %s = pWrapper->m_pInstance;' % (instance,) |
| 366 | print r' } else {' |
| 367 | print r' os::log("apitrace: warning: %%s: unexpected %%s pointer\n", __FUNCTION__, "%s");' % interface.name |
| 368 | print r' }' |
| 369 | print r' }' |
José Fonseca | 87d1cc6 | 2010-11-29 15:57:25 +0000 | [diff] [blame] | 370 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 371 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 372 | class Tracer: |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 373 | '''Base class to orchestrate the code generation of API tracing.''' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 374 | |
José Fonseca | bb8760b | 2011-05-25 23:21:18 +0100 | [diff] [blame] | 375 | def __init__(self): |
| 376 | self.api = None |
| 377 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 378 | def serializerFactory(self): |
| 379 | '''Create a serializer. |
| 380 | |
| 381 | Can be overriden by derived classes to inject their own serialzer. |
| 382 | ''' |
| 383 | |
| 384 | return ValueSerializer() |
| 385 | |
José Fonseca | 1b6c875 | 2012-04-15 14:33:00 +0100 | [diff] [blame] | 386 | def traceApi(self, api): |
José Fonseca | bb8760b | 2011-05-25 23:21:18 +0100 | [diff] [blame] | 387 | self.api = api |
| 388 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 389 | self.header(api) |
| 390 | |
| 391 | # Includes |
| 392 | for header in api.headers: |
José Fonseca | e6a50bd | 2010-11-24 10:12:22 +0000 | [diff] [blame] | 393 | print header |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 394 | print |
| 395 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 396 | # Generate the serializer functions |
José Fonseca | 4470382 | 2012-01-31 10:48:58 +0000 | [diff] [blame] | 397 | types = api.getAllTypes() |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 398 | visitor = ComplexValueSerializer(self.serializerFactory()) |
José Fonseca | e6a50bd | 2010-11-24 10:12:22 +0000 | [diff] [blame] | 399 | map(visitor.visit, types) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 400 | print |
| 401 | |
| 402 | # Interfaces wrapers |
José Fonseca | 143e925 | 2012-04-15 09:31:18 +0100 | [diff] [blame] | 403 | self.traceInterfaces(api) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 404 | |
| 405 | # Function wrappers |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 406 | self.interface = None |
| 407 | self.base = None |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 408 | map(self.traceFunctionDecl, api.functions) |
| 409 | map(self.traceFunctionImpl, api.functions) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 410 | print |
| 411 | |
| 412 | self.footer(api) |
| 413 | |
| 414 | def header(self, api): |
José Fonseca | ba2f08c | 2012-05-10 17:28:31 +0100 | [diff] [blame] | 415 | print '#ifdef _WIN32' |
| 416 | print '# include <malloc.h> // alloca' |
| 417 | print '# ifndef alloca' |
| 418 | print '# define alloca _alloca' |
| 419 | print '# endif' |
| 420 | print '#else' |
| 421 | print '# include <alloca.h> // alloca' |
| 422 | print '#endif' |
José Fonseca | 537c507 | 2012-07-07 12:54:09 +0100 | [diff] [blame] | 423 | print |
| 424 | print '#include "trace.hpp"' |
| 425 | print |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 426 | |
| 427 | def footer(self, api): |
| 428 | pass |
| 429 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 430 | def traceFunctionDecl(self, function): |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 431 | # Per-function declarations |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 432 | |
José Fonseca | 84cea3b | 2012-05-09 21:12:30 +0100 | [diff] [blame] | 433 | if not function.internal: |
| 434 | if function.args: |
| 435 | print 'static const char * _%s_args[%u] = {%s};' % (function.name, len(function.args), ', '.join(['"%s"' % arg.name for arg in function.args])) |
| 436 | else: |
| 437 | print 'static const char ** _%s_args = NULL;' % (function.name,) |
| 438 | print 'static const trace::FunctionSig _%s_sig = {%u, "%s", %u, _%s_args};' % (function.name, function.id, function.name, len(function.args), function.name) |
| 439 | print |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 440 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 441 | def isFunctionPublic(self, function): |
José Fonseca | 2369129 | 2011-04-22 10:40:25 +0100 | [diff] [blame] | 442 | return True |
| 443 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 444 | def traceFunctionImpl(self, function): |
| 445 | if self.isFunctionPublic(function): |
José Fonseca | 2369129 | 2011-04-22 10:40:25 +0100 | [diff] [blame] | 446 | print 'extern "C" PUBLIC' |
| 447 | else: |
| 448 | print 'extern "C" PRIVATE' |
| 449 | print function.prototype() + ' {' |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 450 | if function.type is not stdapi.Void: |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 451 | print ' %s _result;' % function.type |
José Fonseca | 537c507 | 2012-07-07 12:54:09 +0100 | [diff] [blame] | 452 | |
| 453 | # No-op if tracing is disabled |
| 454 | print ' if (!trace::isTracingEnabled()) {' |
Imre Deak | 1242ab5 | 2012-03-30 15:46:26 +0300 | [diff] [blame] | 455 | Tracer.invokeFunction(self, function) |
| 456 | if function.type is not stdapi.Void: |
| 457 | print ' return _result;' |
| 458 | else: |
| 459 | print ' return;' |
| 460 | print ' }' |
José Fonseca | 537c507 | 2012-07-07 12:54:09 +0100 | [diff] [blame] | 461 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 462 | self.traceFunctionImplBody(function) |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 463 | if function.type is not stdapi.Void: |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 464 | print ' return _result;' |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 465 | print '}' |
| 466 | print |
| 467 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 468 | def traceFunctionImplBody(self, function): |
José Fonseca | 84cea3b | 2012-05-09 21:12:30 +0100 | [diff] [blame] | 469 | if not function.internal: |
| 470 | print ' unsigned _call = trace::localWriter.beginEnter(&_%s_sig);' % (function.name,) |
| 471 | for arg in function.args: |
| 472 | if not arg.output: |
| 473 | self.unwrapArg(function, arg) |
| 474 | self.serializeArg(function, arg) |
| 475 | print ' trace::localWriter.endEnter();' |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 476 | self.invokeFunction(function) |
José Fonseca | 84cea3b | 2012-05-09 21:12:30 +0100 | [diff] [blame] | 477 | if not function.internal: |
| 478 | print ' trace::localWriter.beginLeave(_call);' |
| 479 | for arg in function.args: |
| 480 | if arg.output: |
| 481 | self.serializeArg(function, arg) |
| 482 | self.wrapArg(function, arg) |
| 483 | if function.type is not stdapi.Void: |
| 484 | self.serializeRet(function, "_result") |
| 485 | print ' trace::localWriter.endLeave();' |
| 486 | if function.type is not stdapi.Void: |
| 487 | self.wrapRet(function, "_result") |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 488 | |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 489 | def invokeFunction(self, function, prefix='_', suffix=''): |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 490 | if function.type is stdapi.Void: |
| 491 | result = '' |
| 492 | else: |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 493 | result = '_result = ' |
José Fonseca | a08d275 | 2011-08-25 13:26:43 +0100 | [diff] [blame] | 494 | dispatch = prefix + function.name + suffix |
José Fonseca | 14c21bc | 2011-02-20 23:32:22 +0000 | [diff] [blame] | 495 | print ' %s%s(%s);' % (result, dispatch, ', '.join([str(arg.name) for arg in function.args])) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 496 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 497 | def serializeArg(self, function, arg): |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 498 | print ' trace::localWriter.beginArg(%u);' % (arg.index,) |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 499 | self.serializeArgValue(function, arg) |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 500 | print ' trace::localWriter.endArg();' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 501 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 502 | def serializeArgValue(self, function, arg): |
| 503 | self.serializeValue(arg.type, arg.name) |
José Fonseca | 9922183 | 2011-03-22 22:15:46 +0000 | [diff] [blame] | 504 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 505 | def wrapArg(self, function, arg): |
José Fonseca | 9782b29 | 2012-04-14 22:02:42 +0100 | [diff] [blame] | 506 | assert not isinstance(arg.type, stdapi.ObjPointer) |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 507 | |
| 508 | from specs.winapi import REFIID |
| 509 | riid = None |
| 510 | for other_arg in function.args: |
| 511 | if not other_arg.output and other_arg.type is REFIID: |
| 512 | riid = other_arg |
José Fonseca | c328b8c | 2012-04-28 21:45:38 +0100 | [diff] [blame] | 513 | if riid is not None \ |
| 514 | and isinstance(arg.type, stdapi.Pointer) \ |
| 515 | and isinstance(arg.type.type, stdapi.ObjPointer): |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 516 | self.wrapIid(function, riid, arg) |
| 517 | return |
| 518 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 519 | self.wrapValue(arg.type, arg.name) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 520 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 521 | def unwrapArg(self, function, arg): |
| 522 | self.unwrapValue(arg.type, arg.name) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 523 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 524 | def serializeRet(self, function, instance): |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 525 | print ' trace::localWriter.beginReturn();' |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 526 | self.serializeValue(function.type, instance) |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 527 | print ' trace::localWriter.endReturn();' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 528 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 529 | def serializeValue(self, type, instance): |
| 530 | serializer = self.serializerFactory() |
| 531 | serializer.visit(type, instance) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 532 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 533 | def wrapRet(self, function, instance): |
| 534 | self.wrapValue(function.type, instance) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 535 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 536 | def unwrapRet(self, function, instance): |
| 537 | self.unwrapValue(function.type, instance) |
| 538 | |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 539 | def needsWrapping(self, type): |
| 540 | visitor = WrapDecider() |
| 541 | visitor.visit(type) |
| 542 | return visitor.needsWrapping |
| 543 | |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 544 | def wrapValue(self, type, instance): |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 545 | if self.needsWrapping(type): |
| 546 | visitor = ValueWrapper() |
| 547 | visitor.visit(type, instance) |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 548 | |
| 549 | def unwrapValue(self, type, instance): |
José Fonseca | 0075f15 | 2012-04-14 20:25:52 +0100 | [diff] [blame] | 550 | if self.needsWrapping(type): |
| 551 | visitor = ValueUnwrapper() |
| 552 | visitor.visit(type, instance) |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 553 | |
José Fonseca | 143e925 | 2012-04-15 09:31:18 +0100 | [diff] [blame] | 554 | def traceInterfaces(self, api): |
| 555 | interfaces = api.getAllInterfaces() |
| 556 | if not interfaces: |
| 557 | return |
| 558 | map(self.declareWrapperInterface, interfaces) |
| 559 | self.implementIidWrapper(api) |
| 560 | map(self.implementWrapperInterface, interfaces) |
| 561 | print |
| 562 | |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 563 | def declareWrapperInterface(self, interface): |
| 564 | print "class %s : public %s " % (getWrapperInterfaceName(interface), interface.name) |
| 565 | print "{" |
| 566 | print "public:" |
| 567 | print " %s(%s * pInstance);" % (getWrapperInterfaceName(interface), interface.name) |
| 568 | print " virtual ~%s();" % getWrapperInterfaceName(interface) |
| 569 | print |
| 570 | for method in interface.iterMethods(): |
| 571 | print " " + method.prototype() + ";" |
| 572 | print |
José Fonseca | acc9062 | 2012-05-02 13:10:07 +0100 | [diff] [blame] | 573 | #print "private:" |
| 574 | for type, name, value in self.enumWrapperInterfaceVariables(interface): |
| 575 | print ' %s %s;' % (type, name) |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 576 | print "};" |
| 577 | print |
| 578 | |
José Fonseca | acc9062 | 2012-05-02 13:10:07 +0100 | [diff] [blame] | 579 | def enumWrapperInterfaceVariables(self, interface): |
| 580 | return [ |
| 581 | ("DWORD", "m_dwMagic", "0xd8365d6c"), |
| 582 | ("%s *" % interface.name, "m_pInstance", "pInstance"), |
| 583 | ] |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 584 | |
| 585 | def implementWrapperInterface(self, interface): |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 586 | self.interface = interface |
| 587 | |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 588 | print '%s::%s(%s * pInstance) {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), interface.name) |
José Fonseca | acc9062 | 2012-05-02 13:10:07 +0100 | [diff] [blame] | 589 | for type, name, value in self.enumWrapperInterfaceVariables(interface): |
| 590 | print ' %s = %s;' % (name, value) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 591 | print '}' |
| 592 | print |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 593 | print '%s::~%s() {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface)) |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 594 | print '}' |
| 595 | print |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 596 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 597 | for base, method in interface.iterBaseMethods(): |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 598 | self.base = base |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 599 | self.implementWrapperInterfaceMethod(interface, base, method) |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 600 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 601 | print |
| 602 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 603 | def implementWrapperInterfaceMethod(self, interface, base, method): |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 604 | print method.prototype(getWrapperInterfaceName(interface) + '::' + method.name) + ' {' |
| 605 | if method.type is not stdapi.Void: |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 606 | print ' %s _result;' % method.type |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 607 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 608 | self.implementWrapperInterfaceMethodBody(interface, base, method) |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 609 | |
| 610 | if method.type is not stdapi.Void: |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 611 | print ' return _result;' |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 612 | print '}' |
| 613 | print |
| 614 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 615 | def implementWrapperInterfaceMethodBody(self, interface, base, method): |
José Fonseca | 84cea3b | 2012-05-09 21:12:30 +0100 | [diff] [blame] | 616 | assert not method.internal |
| 617 | |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 618 | print ' static const char * _args[%u] = {%s};' % (len(method.args) + 1, ', '.join(['"this"'] + ['"%s"' % arg.name for arg in method.args])) |
| 619 | print ' static const trace::FunctionSig _sig = {%u, "%s", %u, _args};' % (method.id, interface.name + '::' + method.name, len(method.args) + 1) |
José Fonseca | a0e9786 | 2012-04-29 23:22:52 +0100 | [diff] [blame] | 620 | |
| 621 | print ' %s *_this = static_cast<%s *>(m_pInstance);' % (base, base) |
| 622 | |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 623 | print ' unsigned _call = trace::localWriter.beginEnter(&_sig);' |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 624 | print ' trace::localWriter.beginArg(0);' |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 625 | print ' trace::localWriter.writePointer((uintptr_t)m_pInstance);' |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 626 | print ' trace::localWriter.endArg();' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 627 | for arg in method.args: |
| 628 | if not arg.output: |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 629 | self.unwrapArg(method, arg) |
| 630 | self.serializeArg(method, arg) |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 631 | print ' trace::localWriter.endEnter();' |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 632 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 633 | self.invokeMethod(interface, base, method) |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 634 | |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 635 | print ' trace::localWriter.beginLeave(_call);' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 636 | for arg in method.args: |
| 637 | if arg.output: |
José Fonseca | 54f304a | 2012-01-14 19:33:08 +0000 | [diff] [blame] | 638 | self.serializeArg(method, arg) |
| 639 | self.wrapArg(method, arg) |
José Fonseca | 1ce52f0 | 2012-01-31 12:19:57 +0000 | [diff] [blame] | 640 | |
José Fonseca | 87d1cc6 | 2010-11-29 15:57:25 +0000 | [diff] [blame] | 641 | if method.type is not stdapi.Void: |
José Fonseca | 3a259b8 | 2012-05-09 19:33:33 +0100 | [diff] [blame] | 642 | self.serializeRet(method, '_result') |
José Fonseca | b4a3d14 | 2011-10-27 07:43:19 +0100 | [diff] [blame] | 643 | print ' trace::localWriter.endLeave();' |
José Fonseca | 3a259b8 | 2012-05-09 19:33:33 +0100 | [diff] [blame] | 644 | if method.type is not stdapi.Void: |
| 645 | self.wrapRet(method, '_result') |
| 646 | |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 647 | if method.name == 'Release': |
José Fonseca | 87d1cc6 | 2010-11-29 15:57:25 +0000 | [diff] [blame] | 648 | assert method.type is not stdapi.Void |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 649 | print ' if (!_result)' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 650 | print ' delete this;' |
José Fonseca | 8fbdd3a | 2010-11-23 20:55:07 +0000 | [diff] [blame] | 651 | |
José Fonseca | 143e925 | 2012-04-15 09:31:18 +0100 | [diff] [blame] | 652 | def implementIidWrapper(self, api): |
| 653 | print r'static void' |
| 654 | print r'warnIID(const char *functionName, REFIID riid, const char *reason) {' |
| 655 | print r' os::log("apitrace: warning: %s: %s IID {0x%08lX,0x%04X,0x%04X,{0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X}}\n",' |
| 656 | print r' functionName, reason,' |
| 657 | print r' riid.Data1, riid.Data2, riid.Data3,' |
| 658 | print r' riid.Data4[0], riid.Data4[1], riid.Data4[2], riid.Data4[3], riid.Data4[4], riid.Data4[5], riid.Data4[6], riid.Data4[7]);' |
| 659 | print r'}' |
| 660 | print |
| 661 | print r'static void' |
| 662 | print r'wrapIID(const char *functionName, REFIID riid, void * * ppvObj) {' |
| 663 | print r' if (!ppvObj || !*ppvObj) {' |
| 664 | print r' return;' |
| 665 | print r' }' |
| 666 | else_ = '' |
| 667 | for iface in api.getAllInterfaces(): |
| 668 | print r' %sif (riid == IID_%s) {' % (else_, iface.name) |
| 669 | print r' *ppvObj = new Wrap%s((%s *) *ppvObj);' % (iface.name, iface.name) |
| 670 | print r' }' |
| 671 | else_ = 'else ' |
| 672 | print r' %s{' % else_ |
| 673 | print r' warnIID(functionName, riid, "unknown");' |
| 674 | print r' }' |
| 675 | print r'}' |
| 676 | print |
| 677 | |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 678 | def wrapIid(self, function, riid, out): |
José Fonseca | c328b8c | 2012-04-28 21:45:38 +0100 | [diff] [blame] | 679 | # Cast output arg to `void **` if necessary |
| 680 | out_name = out.name |
| 681 | obj_type = out.type.type.type |
| 682 | if not obj_type is stdapi.Void: |
| 683 | assert isinstance(obj_type, stdapi.Interface) |
| 684 | out_name = 'reinterpret_cast<void * *>(%s)' % out_name |
| 685 | |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 686 | print r' if (%s && *%s) {' % (out.name, out.name) |
José Fonseca | 143e925 | 2012-04-15 09:31:18 +0100 | [diff] [blame] | 687 | functionName = function.name |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 688 | else_ = '' |
| 689 | if self.interface is not None: |
José Fonseca | 143e925 | 2012-04-15 09:31:18 +0100 | [diff] [blame] | 690 | functionName = self.interface.name + '::' + functionName |
José Fonseca | c328b8c | 2012-04-28 21:45:38 +0100 | [diff] [blame] | 691 | print r' if (*%s == m_pInstance &&' % (out_name,) |
José Fonseca | 828bf10 | 2012-04-16 20:48:59 +0100 | [diff] [blame] | 692 | print r' (%s)) {' % ' || '.join('%s == IID_%s' % (riid.name, iface.name) for iface in self.interface.iterBases()) |
José Fonseca | c328b8c | 2012-04-28 21:45:38 +0100 | [diff] [blame] | 693 | print r' *%s = this;' % (out_name,) |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 694 | print r' }' |
| 695 | else_ = 'else ' |
| 696 | print r' %s{' % else_ |
José Fonseca | c328b8c | 2012-04-28 21:45:38 +0100 | [diff] [blame] | 697 | print r' wrapIID("%s", %s, %s);' % (functionName, riid.name, out_name) |
José Fonseca | bcb26b2 | 2012-04-15 08:42:25 +0100 | [diff] [blame] | 698 | print r' }' |
| 699 | print r' }' |
José Fonseca | 1ce52f0 | 2012-01-31 12:19:57 +0000 | [diff] [blame] | 700 | |
José Fonseca | 4220b1b | 2012-02-03 19:05:29 +0000 | [diff] [blame] | 701 | def invokeMethod(self, interface, base, method): |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 702 | if method.type is stdapi.Void: |
| 703 | result = '' |
| 704 | else: |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 705 | result = '_result = ' |
José Fonseca | a0e9786 | 2012-04-29 23:22:52 +0100 | [diff] [blame] | 706 | print ' %s_this->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args])) |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 707 | |
| 708 | def emit_memcpy(self, dest, src, length): |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 709 | print ' unsigned _call = trace::localWriter.beginEnter(&trace::memcpy_sig);' |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 710 | print ' trace::localWriter.beginArg(0);' |
José Fonseca | d559f02 | 2012-04-15 16:13:51 +0100 | [diff] [blame] | 711 | print ' trace::localWriter.writePointer((uintptr_t)%s);' % dest |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 712 | print ' trace::localWriter.endArg();' |
| 713 | print ' trace::localWriter.beginArg(1);' |
| 714 | print ' trace::localWriter.writeBlob(%s, %s);' % (src, length) |
| 715 | print ' trace::localWriter.endArg();' |
| 716 | print ' trace::localWriter.beginArg(2);' |
| 717 | print ' trace::localWriter.writeUInt(%s);' % length |
| 718 | print ' trace::localWriter.endArg();' |
| 719 | print ' trace::localWriter.endEnter();' |
José Fonseca | 632a78d | 2012-04-19 07:18:59 +0100 | [diff] [blame] | 720 | print ' trace::localWriter.beginLeave(_call);' |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 721 | print ' trace::localWriter.endLeave();' |
José Fonseca | 122c987 | 2012-08-02 08:42:24 +0100 | [diff] [blame] | 722 | |
| 723 | def fake_call(self, function, args): |
| 724 | print ' unsigned _fake_call = trace::localWriter.beginEnter(&_%s_sig);' % (function.name,) |
| 725 | for arg, instance in zip(function.args, args): |
| 726 | assert not arg.output |
| 727 | print ' trace::localWriter.beginArg(%u);' % (arg.index,) |
| 728 | self.serializeValue(arg.type, instance) |
| 729 | print ' trace::localWriter.endArg();' |
| 730 | print ' trace::localWriter.endEnter();' |
| 731 | print ' trace::localWriter.beginLeave(_fake_call);' |
| 732 | print ' trace::localWriter.endLeave();' |
José Fonseca | 0423d2c | 2012-01-20 19:16:17 +0000 | [diff] [blame] | 733 | |