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."""
34 class ConstRemover(stdapi.Rebuilder):
36 def visit_const(self, const):
39 def visit_opaque(self, opaque):
43 def handle_entry(handle, value):
44 if handle.key is None:
45 return "__%s_map[%s]" % (handle.name, value)
47 key_name, key_type = handle.key
48 return "__%s_map[%s][%s]" % (handle.name, key_name, value)
51 class ValueExtractor(stdapi.Visitor):
53 def visit_literal(self, literal, lvalue, rvalue):
54 if literal.format == 'Bool':
55 print ' %s = static_cast<bool>(%s);' % (lvalue, rvalue)
57 print ' %s = %s;' % (lvalue, rvalue)
59 def visit_const(self, const, lvalue, rvalue):
60 self.visit(const.type, lvalue, rvalue)
62 def visit_alias(self, alias, lvalue, rvalue):
63 self.visit(alias.type, lvalue, rvalue)
65 def visit_enum(self, enum, lvalue, rvalue):
66 print ' %s = %s;' % (lvalue, rvalue)
68 def visit_bitmask(self, bitmask, lvalue, rvalue):
69 self.visit(bitmask.type, lvalue, rvalue)
71 def visit_array(self, array, lvalue, rvalue):
72 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (array.id, rvalue)
73 print ' if (__a%s) {' % (array.id)
74 length = '__a%s->values.size()' % array.id
75 print ' %s = new %s[%s];' % (lvalue, array.type, length)
76 index = '__j' + array.id
77 print ' for (size_t {i} = 0; {i} < {length}; ++{i}) {{'.format(i = index, length = length)
79 self.visit(array.type, '%s[%s]' % (lvalue, index), '*__a%s->values[%s]' % (array.id, index))
83 print ' %s = NULL;' % lvalue
86 def visit_pointer(self, pointer, lvalue, rvalue):
87 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (pointer.id, rvalue)
88 print ' if (__a%s) {' % (pointer.id)
89 print ' %s = new %s;' % (lvalue, pointer.type)
91 self.visit(pointer.type, '%s[0]' % (lvalue,), '*__a%s->values[0]' % (pointer.id,))
94 print ' %s = NULL;' % lvalue
97 def visit_handle(self, handle, lvalue, rvalue):
98 OpaqueValueExtractor().visit(handle.type, lvalue, rvalue);
99 new_lvalue = handle_entry(handle, lvalue)
100 print ' if (retrace::verbosity >= 2)'
101 print ' std::cout << "%s " << size_t(%s) << " <- " << size_t(%s) << "\\n";' % (handle.name, lvalue, new_lvalue)
102 print ' %s = %s;' % (lvalue, new_lvalue)
104 def visit_blob(self, blob, lvalue, rvalue):
105 print ' %s = static_cast<%s>((%s).blob());' % (lvalue, blob, rvalue)
107 def visit_string(self, string, lvalue, rvalue):
108 print ' %s = (%s)((%s).string());' % (lvalue, string.expr, rvalue)
111 class OpaqueValueExtractor(ValueExtractor):
112 '''Value extractor that also understands opaque values.
114 Normally opaque values can't be retraced, unless they are being extracted
115 in the context of handles.'''
117 def visit_opaque(self, opaque, lvalue, rvalue):
118 print ' %s = static_cast<%s>((%s).blob());' % (lvalue, opaque, rvalue)
121 class ValueWrapper(stdapi.Visitor):
123 def visit_literal(self, literal, lvalue, rvalue):
126 def visit_alias(self, alias, lvalue, rvalue):
127 self.visit(alias.type, lvalue, rvalue)
129 def visit_enum(self, enum, lvalue, rvalue):
132 def visit_bitmask(self, bitmask, lvalue, rvalue):
135 def visit_array(self, array, lvalue, rvalue):
136 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (array.id, rvalue)
137 print ' if (__a%s) {' % (array.id)
138 length = '__a%s->values.size()' % array.id
139 index = '__j' + array.id
140 print ' for (size_t {i} = 0; {i} < {length}; ++{i}) {{'.format(i = index, length = length)
142 self.visit(array.type, '%s[%s]' % (lvalue, index), '*__a%s->values[%s]' % (array.id, index))
147 def visit_pointer(self, pointer, lvalue, rvalue):
148 print ' const Trace::Array *__a%s = dynamic_cast<const Trace::Array *>(&%s);' % (pointer.id, rvalue)
149 print ' if (__a%s) {' % (pointer.id)
151 self.visit(pointer.type, '%s[0]' % (lvalue,), '*__a%s->values[0]' % (pointer.id,))
155 def visit_handle(self, handle, lvalue, rvalue):
156 print ' %s __orig_result;' % handle.type
157 OpaqueValueExtractor().visit(handle.type, '__orig_result', rvalue);
158 if handle.range is None:
159 rvalue = "__orig_result"
160 entry = handle_entry(handle, rvalue)
161 print " %s = %s;" % (entry, lvalue)
162 print ' if (retrace::verbosity >= 2)'
163 print ' std::cout << "{handle.name} " << {rvalue} << " -> " << {lvalue} << "\\n";'.format(**locals())
165 i = '__h' + handle.id
166 lvalue = "%s + %s" % (lvalue, i)
167 rvalue = "__orig_result + %s" % (i,)
168 entry = handle_entry(handle, rvalue)
169 print ' for ({handle.type} {i} = 0; {i} < {handle.range}; ++{i}) {{'.format(**locals())
170 print ' {entry} = {lvalue};'.format(**locals())
171 print ' if (retrace::verbosity >= 2)'
172 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):
192 for arg in function.args:
193 arg_type = ConstRemover().visit(arg.type)
194 #print ' // %s -> %s' % (arg.type, arg_type)
195 print ' %s %s;' % (arg_type, arg.name)
196 rvalue = 'call.arg(%u)' % (arg.index,)
199 self.extract_arg(function, arg, arg_type, lvalue, rvalue)
200 except NotImplementedError:
202 print ' %s = 0; // FIXME' % arg.name
204 self.fail_function(function)
205 self.call_function(function)
206 for arg in function.args:
208 arg_type = ConstRemover().visit(arg.type)
209 rvalue = 'call.arg(%u)' % (arg.index,)
212 ValueWrapper().visit(arg_type, lvalue, rvalue)
213 except NotImplementedError:
214 print ' // FIXME: %s' % arg.name
215 if function.type is not stdapi.Void:
219 ValueWrapper().visit(function.type, lvalue, rvalue)
220 except NotImplementedError:
221 print ' // FIXME: result'
223 def fail_function(self, function):
224 print ' if (retrace::verbosity >= 0)'
225 print ' std::cerr << "warning: unsupported call %s\\n";' % function.name
228 def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
229 ValueExtractor().visit(arg_type, lvalue, rvalue)
231 def call_function(self, function):
232 arg_names = ", ".join([arg.name for arg in function.args])
233 if function.type is not stdapi.Void:
234 print ' %s __result;' % (function.type)
235 print ' __result = %s(%s);' % (function.name, arg_names)
237 print ' %s(%s);' % (function.name, arg_names)
239 def filter_function(self, function):
242 def retrace_functions(self, functions):
243 functions = filter(self.filter_function, functions)
245 for function in functions:
246 if function.sideeffects:
247 self.retrace_function(function)
249 print 'bool retrace::retrace_call(Trace::Call &call) {'
250 print ' const char *name = call.name().c_str();'
252 print ' if (retrace::verbosity >= 1) {'
253 print ' std::cout << call;'
254 print ' std::cout.flush();'
258 func_dict = dict([(function.name, function) for function in functions])
260 def handle_case(function_name):
261 function = func_dict[function_name]
262 if function.sideeffects:
263 print ' retrace_%s(call);' % function.name
264 print ' return true;'
266 string_switch('name', func_dict.keys(), handle_case)
268 print ' if (retrace::verbosity >= 0)'
269 print ' std::cerr << call.no << ": warning: unknown call " << call.name() << "\\n";'
270 print ' return false;'
275 def retrace_api(self, api):
277 print '#include "trace_parser.hpp"'
278 print '#include "retrace.hpp"'
281 types = api.all_types()
282 handles = [type for type in types if isinstance(type, stdapi.Handle)]
284 for handle in handles:
285 if handle.name not in handle_names:
286 if handle.key is None:
287 print 'static retrace::map<%s> __%s_map;' % (handle.type, handle.name)
289 key_name, key_type = handle.key
290 print 'static std::map<%s, retrace::map<%s> > __%s_map;' % (key_type, handle.type, handle.name)
291 handle_names.add(handle.name)
294 self.retrace_functions(api.functions)