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