1 ##########################################################################
3 # Copyright 2010 VMware, Inc.
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:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
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
24 ##########################################################################/
27 """Generic retracing code generator."""
29 import specs.stdapi as stdapi
30 import specs.glapi as glapi
33 class ConstRemover(stdapi.Rebuilder):
35 def visit_const(self, const):
38 def visit_opaque(self, opaque):
42 def handle_entry(handle, value):
43 if handle.key is None:
44 return "__%s_map[%s]" % (handle.name, value)
46 key_name, key_type = handle.key
47 return "__%s_map[%s][%s]" % (handle.name, key_name, value)
50 class ValueExtractor(stdapi.Visitor):
52 def visit_literal(self, literal, lvalue, rvalue):
53 #if literal.format in ('Bool', 'UInt'):
54 print ' %s = (%s).to%s();' % (lvalue, rvalue, literal.format)
56 def visit_const(self, const, lvalue, rvalue):
57 self.visit(const.type, lvalue, rvalue)
59 def visit_alias(self, alias, lvalue, rvalue):
60 self.visit(alias.type, lvalue, rvalue)
62 def visit_enum(self, enum, lvalue, rvalue):
63 print ' %s = (%s).toSInt();' % (lvalue, rvalue)
65 def visit_bitmask(self, bitmask, lvalue, rvalue):
66 self.visit(bitmask.type, lvalue, rvalue)
68 def visit_array(self, array, lvalue, rvalue):
69 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (array.id, rvalue)
70 print ' if (__a%s) {' % (array.id)
71 length = '__a%s->values.size()' % array.id
72 print ' %s = new %s[%s];' % (lvalue, array.type, length)
73 index = '__j' + array.id
74 print ' for (size_t {i} = 0; {i} < {length}; ++{i}) {{'.format(i = index, length = length)
76 self.visit(array.type, '%s[%s]' % (lvalue, index), '*__a%s->values[%s]' % (array.id, index))
80 print ' %s = NULL;' % lvalue
83 def visit_pointer(self, pointer, lvalue, rvalue):
84 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (pointer.id, rvalue)
85 print ' if (__a%s) {' % (pointer.id)
86 print ' %s = new %s;' % (lvalue, pointer.type)
88 self.visit(pointer.type, '%s[0]' % (lvalue,), '*__a%s->values[0]' % (pointer.id,))
91 print ' %s = NULL;' % lvalue
94 def visit_handle(self, handle, lvalue, rvalue):
95 OpaqueValueExtractor().visit(handle.type, lvalue, rvalue);
96 new_lvalue = handle_entry(handle, lvalue)
97 print ' if (retrace::verbosity >= 2) {'
98 print ' std::cout << "%s " << size_t(%s) << " <- " << size_t(%s) << "\\n";' % (handle.name, lvalue, new_lvalue)
100 print ' %s = %s;' % (lvalue, new_lvalue)
102 def visit_blob(self, blob, lvalue, rvalue):
103 print ' %s = static_cast<%s>((%s).toPointer());' % (lvalue, blob, rvalue)
105 def visit_string(self, string, lvalue, rvalue):
106 print ' %s = (%s)((%s).toString());' % (lvalue, string.expr, rvalue)
109 class OpaqueValueExtractor(ValueExtractor):
110 '''Value extractor that also understands opaque values.
112 Normally opaque values can't be retraced, unless they are being extracted
113 in the context of handles.'''
115 def visit_opaque(self, opaque, lvalue, rvalue):
116 print ' %s = static_cast<%s>((%s).toPointer());' % (lvalue, opaque, rvalue)
119 class ValueWrapper(stdapi.Visitor):
121 def visit_literal(self, literal, lvalue, rvalue):
124 def visit_alias(self, alias, lvalue, rvalue):
125 self.visit(alias.type, lvalue, rvalue)
127 def visit_enum(self, enum, lvalue, rvalue):
130 def visit_bitmask(self, bitmask, lvalue, rvalue):
133 def visit_array(self, array, lvalue, rvalue):
134 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (array.id, rvalue)
135 print ' if (__a%s) {' % (array.id)
136 length = '__a%s->values.size()' % array.id
137 index = '__j' + array.id
138 print ' for (size_t {i} = 0; {i} < {length}; ++{i}) {{'.format(i = index, length = length)
140 self.visit(array.type, '%s[%s]' % (lvalue, index), '*__a%s->values[%s]' % (array.id, index))
145 def visit_pointer(self, pointer, lvalue, rvalue):
146 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (pointer.id, rvalue)
147 print ' if (__a%s) {' % (pointer.id)
149 self.visit(pointer.type, '%s[0]' % (lvalue,), '*__a%s->values[0]' % (pointer.id,))
153 def visit_handle(self, handle, lvalue, rvalue):
154 print ' %s __orig_result;' % handle.type
155 OpaqueValueExtractor().visit(handle.type, '__orig_result', rvalue);
156 if handle.range is None:
157 rvalue = "__orig_result"
158 entry = handle_entry(handle, rvalue)
159 print " %s = %s;" % (entry, lvalue)
160 print ' if (retrace::verbosity >= 2) {'
161 print ' std::cout << "{handle.name} " << {rvalue} << " -> " << {lvalue} << "\\n";'.format(**locals())
164 i = '__h' + handle.id
165 lvalue = "%s + %s" % (lvalue, i)
166 rvalue = "__orig_result + %s" % (i,)
167 entry = handle_entry(handle, rvalue)
168 print ' for ({handle.type} {i} = 0; {i} < {handle.range}; ++{i}) {{'.format(**locals())
169 print ' {entry} = {lvalue};'.format(**locals())
170 print ' if (retrace::verbosity >= 2) {'
171 print ' std::cout << "{handle.name} " << ({rvalue}) << " -> " << ({lvalue}) << "\\n";'.format(**locals())
175 def visit_blob(self, blob, lvalue, rvalue):
178 def visit_string(self, string, lvalue, rvalue):
184 def retrace_function(self, function):
185 print 'static void retrace_%s(Trace::Call &call) {' % function.name
186 self.retrace_function_body(function)
190 def retrace_function_body(self, function):
191 if not function.sideeffects:
196 for arg in function.args:
197 arg_type = ConstRemover().visit(arg.type)
198 #print ' // %s -> %s' % (arg.type, arg_type)
199 print ' %s %s;' % (arg_type, arg.name)
200 rvalue = 'call.arg(%u)' % (arg.index,)
203 self.extract_arg(function, arg, arg_type, lvalue, rvalue)
204 except NotImplementedError:
206 print ' %s = 0; // FIXME' % arg.name
209 self.fail_function(function)
211 self.call_function(function)
212 for arg in function.args:
214 arg_type = ConstRemover().visit(arg.type)
215 rvalue = 'call.arg(%u)' % (arg.index,)
218 ValueWrapper().visit(arg_type, lvalue, rvalue)
219 except NotImplementedError:
220 print ' // FIXME: %s' % arg.name
221 if function.type is not stdapi.Void:
225 ValueWrapper().visit(function.type, lvalue, rvalue)
226 except NotImplementedError:
227 print ' // FIXME: result'
229 def fail_function(self, function):
230 print ' if (retrace::verbosity >= 0) {'
231 print ' retrace::unknown(call);'
235 def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
236 ValueExtractor().visit(arg_type, lvalue, rvalue)
238 def extract_opaque_arg(self, function, arg, arg_type, lvalue, rvalue):
239 OpaqueValueExtractor().visit(arg_type, lvalue, rvalue)
241 def call_function(self, function):
242 arg_names = ", ".join([arg.name for arg in function.args])
243 if function.type is not stdapi.Void:
244 print ' %s __result;' % (function.type)
245 print ' __result = %s(%s);' % (function.name, arg_names)
246 print ' (void)__result;'
248 print ' %s(%s);' % (function.name, arg_names)
250 def filter_function(self, function):
253 table_name = 'retrace::callbacks'
255 def retrace_functions(self, functions):
256 functions = filter(self.filter_function, functions)
258 for function in functions:
259 self.retrace_function(function)
261 print 'const retrace::Entry %s[] = {' % self.table_name
262 for function in functions:
263 print ' {"%s", &retrace_%s},' % (function.name, function.name)
264 print ' {NULL, NULL}'
269 def retrace_api(self, api):
271 print '#include "trace_parser.hpp"'
272 print '#include "retrace.hpp"'
275 types = api.all_types()
276 handles = [type for type in types if isinstance(type, stdapi.Handle)]
278 for handle in handles:
279 if handle.name not in handle_names:
280 if handle.key is None:
281 print 'static retrace::map<%s> __%s_map;' % (handle.type, handle.name)
283 key_name, key_type = handle.key
284 print 'static std::map<%s, retrace::map<%s> > __%s_map;' % (key_type, handle.type, handle.name)
285 handle_names.add(handle.name)
288 self.retrace_functions(api.functions)