2 # -*- coding: utf-8 -*-
5 Machinery for generating tracing-related intermediate files.
8 __author__
= "Lluís Vilanova <vilanova@ac.upc.edu>"
9 __copyright__
= "Copyright 2012-2016, Lluís Vilanova <vilanova@ac.upc.edu>"
10 __license__
= "GPL version 2 or (at your option) any later version"
12 __maintainer__
= "Stefan Hajnoczi"
13 __email__
= "stefanha@linux.vnet.ibm.com"
20 import tracetool
.format
21 import tracetool
.backend
22 import tracetool
.transform
25 def error_write(*lines
):
26 """Write a set of error lines."""
27 sys
.stderr
.writelines("\n".join(lines
) + "\n")
30 """Write a set of error lines and exit."""
35 def out(*lines
, **kwargs
):
36 """Write a set of output lines.
38 You can use kwargs as a shorthand for mapping variables when formating all
41 lines
= [ l
% kwargs
for l
in lines
]
42 sys
.stdout
.writelines("\n".join(lines
) + "\n")
46 """Event arguments description."""
48 def __init__(self
, args
):
53 List of (type, name) tuples or Arguments objects.
57 if isinstance(arg
, Arguments
):
58 self
._args
.extend(arg
._args
)
60 self
._args
.append(arg
)
63 """Create a new copy."""
64 return Arguments(list(self
._args
))
68 """Build and Arguments instance from an argument string.
73 String describing the event arguments.
76 for arg
in arg_str
.split(","):
82 arg_type
, identifier
= arg
.rsplit('*', 1)
84 identifier
= identifier
.strip()
86 arg_type
, identifier
= arg
.rsplit(None, 1)
88 res
.append((arg_type
, identifier
))
91 def __getitem__(self
, index
):
92 if isinstance(index
, slice):
93 return Arguments(self
._args
[index
])
95 return self
._args
[index
]
98 """Iterate over the (type, name) pairs."""
99 return iter(self
._args
)
102 """Number of arguments."""
103 return len(self
._args
)
106 """String suitable for declaring function arguments."""
107 if len(self
._args
) == 0:
110 return ", ".join([ " ".join([t
, n
]) for t
,n
in self
._args
])
113 """Evaluable string representation for this object."""
114 return "Arguments(\"%s\")" % str(self
)
117 """List of argument names."""
118 return [ name
for _
, name
in self
._args
]
121 """List of argument types."""
122 return [ type_
for type_
, _
in self
._args
]
125 """List of argument names casted to their type."""
126 return ["(%s)%s" % (type_
, name
) for type_
, name
in self
._args
]
128 def transform(self
, *trans
):
129 """Return a new Arguments instance with transformed types.
131 The types in the resulting Arguments instance are transformed according
132 to tracetool.transform.transform_type.
135 for type_
, name
in self
._args
:
136 res
.append((tracetool
.transform
.transform_type(type_
, *trans
),
138 return Arguments(res
)
142 """Event description.
149 The event format string.
150 properties : set(str)
151 Properties of the event.
157 _CRE
= re
.compile("((?P<props>[\w\s]+)\s+)?"
159 "\((?P<args>[^)]*)\)"
161 "(?:(?:(?P<fmt_trans>\".+),)?\s*(?P<fmt>\".+))?"
164 _VALID_PROPS
= set(["disable", "tcg", "tcg-trans", "tcg-exec"])
166 def __init__(self
, name
, props
, fmt
, args
, orig
=None):
174 fmt : str, list of str
175 Event printing format (or formats).
179 Original Event before transformation.
183 self
.properties
= props
188 self
.original
= weakref
.ref(self
)
192 unknown_props
= set(self
.properties
) - self
._VALID
_PROPS
193 if len(unknown_props
) > 0:
194 raise ValueError("Unknown properties: %s"
195 % ", ".join(unknown_props
))
196 assert isinstance(self
.fmt
, str) or len(self
.fmt
) == 2
199 """Create a new copy."""
200 return Event(self
.name
, list(self
.properties
), self
.fmt
,
201 self
.args
.copy(), self
)
205 """Build an Event instance from a string.
210 Line describing the event.
212 m
= Event
._CRE
.match(line_str
)
214 groups
= m
.groupdict('')
216 name
= groups
["name"]
217 props
= groups
["props"].split()
219 fmt_trans
= groups
["fmt_trans"]
220 if len(fmt_trans
) > 0:
221 fmt
= [fmt_trans
, fmt
]
222 args
= Arguments
.build(groups
["args"])
224 if "tcg-trans" in props
:
225 raise ValueError("Invalid property 'tcg-trans'")
226 if "tcg-exec" in props
:
227 raise ValueError("Invalid property 'tcg-exec'")
228 if "tcg" not in props
and not isinstance(fmt
, str):
229 raise ValueError("Only events with 'tcg' property can have two formats")
230 if "tcg" in props
and isinstance(fmt
, str):
231 raise ValueError("Events with 'tcg' property must have two formats")
233 return Event(name
, props
, fmt
, args
)
236 """Evaluable string representation for this object."""
237 if isinstance(self
.fmt
, str):
240 fmt
= "%s, %s" % (self
.fmt
[0], self
.fmt
[1])
241 return "Event('%s %s(%s) %s')" % (" ".join(self
.properties
),
246 _FMT
= re
.compile("(%[\d\.]*\w+|%.*PRI\S+)")
249 """List of argument print formats."""
250 assert not isinstance(self
.fmt
, list)
251 return self
._FMT
.findall(self
.fmt
)
253 QEMU_TRACE
= "trace_%(name)s"
254 QEMU_TRACE_TCG
= QEMU_TRACE
+ "_tcg"
256 def api(self
, fmt
=None):
258 fmt
= Event
.QEMU_TRACE
259 return fmt
% {"name": self
.name
}
261 def transform(self
, *trans
):
262 """Return a new Event with transformed Arguments."""
263 return Event(self
.name
,
264 list(self
.properties
),
266 self
.args
.transform(*trans
),
270 def _read_events(fobj
):
275 if line
.lstrip().startswith('#'):
278 event
= Event
.build(line
)
280 # transform TCG-enabled events
281 if "tcg" not in event
.properties
:
284 event_trans
= event
.copy()
285 event_trans
.name
+= "_trans"
286 event_trans
.properties
+= ["tcg-trans"]
287 event_trans
.fmt
= event
.fmt
[0]
289 for atrans
, aorig
in zip(
290 event_trans
.transform(tracetool
.transform
.TCG_2_HOST
).args
,
293 args_trans
.append(atrans
)
294 event_trans
.args
= Arguments(args_trans
)
296 event_exec
= event
.copy()
297 event_exec
.name
+= "_exec"
298 event_exec
.properties
+= ["tcg-exec"]
299 event_exec
.fmt
= event
.fmt
[1]
300 event_exec
.args
= event_exec
.args
.transform(tracetool
.transform
.TCG_2_HOST
)
302 new_event
= [event_trans
, event_exec
]
303 event
.event_trans
, event
.event_exec
= new_event
305 events
.extend(new_event
)
310 class TracetoolError (Exception):
311 """Exception for calls to generate."""
315 def try_import(mod_name
, attr_name
=None, attr_default
=None):
316 """Try to import a module and get an attribute from it.
322 attr_name : str, optional
323 Name of an attribute in the module.
324 attr_default : optional
325 Default value if the attribute does not exist in the module.
329 A pair indicating whether the module could be imported and the module or
330 object or attribute value.
333 module
= __import__(mod_name
, globals(), locals(), ["__package__"])
334 if attr_name
is None:
336 return True, getattr(module
, str(attr_name
), attr_default
)
341 def generate(fevents
, format
, backends
,
342 binary
=None, probe_prefix
=None):
343 """Generate the output for the given (format, backends) pair.
348 Event description file.
352 Output backend names.
354 See tracetool.backend.dtrace.BINARY.
355 probe_prefix : str or None
356 See tracetool.backend.dtrace.PROBEPREFIX.
358 # fix strange python error (UnboundLocalError tracetool)
363 raise TracetoolError("format not set")
364 if not tracetool
.format
.exists(format
):
365 raise TracetoolError("unknown format: %s" % format
)
367 if len(backends
) is 0:
368 raise TracetoolError("no backends specified")
369 for backend
in backends
:
370 if not tracetool
.backend
.exists(backend
):
371 raise TracetoolError("unknown backend: %s" % backend
)
372 backend
= tracetool
.backend
.Wrapper(backends
, format
)
374 import tracetool
.backend
.dtrace
375 tracetool
.backend
.dtrace
.BINARY
= binary
376 tracetool
.backend
.dtrace
.PROBEPREFIX
= probe_prefix
378 events
= _read_events(fevents
)
380 tracetool
.format
.generate(events
, format
, backend
)