def register_dynamic_ftrace(class_name,
unique_word,
scope="all",
parse_raw=False,
pivot=None):
"""Create a Dynamic FTrace parser and register it with any FTrace parsing classes
:param class_name: The name of the class to be registered
(Should be in CamelCase)
:type class_name: str
:param unique_word: The unique_word to be matched in the
trace
:type unique_word: str
:param scope: Registry Scope (Can be used to constrain
the parsing of events and group them together)
:type scope: str
:param parse_raw: If, true, raw trace output (-r flag)
will be used
:type parse_raw: bool
:param pivot: The data column about which the data can be grouped
:type pivot: str
For example if a new unique word :code:`my_unique_word` has
to be registered with TRAPpy:
::
import trappy
custom_class = trappy.register_dynamic_ftrace("MyEvent", "my_unique_word")
trace = trappy.FTrace("/path/to/trace_file")
# New data member created in the ftrace object
trace.my_event
.. note:: The name of the member is :code:`my_event` from **MyEvent**
:return: A class object of type :mod:`trappy.base.Base`
"""
kwords = {
"__init__": default_init,
"unique_word": unique_word,
"name": _get_name(class_name),
"parse_raw": parse_raw,
}
if pivot:
kwords["pivot"] = pivot
dyn_class = DynamicTypeFactory(class_name, (Base, ), kwords)
GenericFTrace.register_parser(dyn_class, scope)
return dyn_class
def unregister_ftrace_parser(ftrace_parser):
"""Unregister an ftrace parser
:param ftrace_parser: An ftrace parser class that was registered
with register_ftrace_parser() or register_dynamic_ftrace().
If done with the latter, the cls parameter is the return value
of register_dynamic_ftrace()
:type ftrace_parser: class derived from :mod:`trappy.base.Base`
"""
GenericFTrace.unregister_parser(ftrace_parser)
def unregister_ftrace_parser(ftrace_parser):
"""Unregister an ftrace parser
:param ftrace_parser: An ftrace parser class that was registered
with register_ftrace_parser() or register_dynamic_ftrace().
If done with the latter, the cls parameter is the return value
of register_dynamic_ftrace()
:type ftrace_parser: class derived from :mod:`trappy.base.Base`
"""
GenericFTrace.unregister_parser(ftrace_parser)
def register_dynamic_ftrace(class_name, unique_word, scope="all",
parse_raw=False, pivot=None):
"""Create a Dynamic FTrace parser and register it with any FTrace parsing classes
:param class_name: The name of the class to be registered
(Should be in CamelCase)
:type class_name: str
:param unique_word: The unique_word to be matched in the
trace
:type unique_word: str
:param scope: Registry Scope (Can be used to constrain
the parsing of events and group them together)
:type scope: str
:param parse_raw: If, true, raw trace output (-R flag)
will be used
:type parse_raw: bool
:param pivot: The data column about which the data can be grouped
:type pivot: str
For example if a new unique word :code:`my_unique_word` has
to be registered with TRAPpy:
::
import trappy
custom_class = trappy.register_dynamic_ftrace("MyEvent", "my_unique_word")
trace = trappy.FTrace("/path/to/trace_file")
# New data member created in the ftrace object
trace.my_event
.. note:: The name of the member is :code:`my_event` from **MyEvent**
:return: A class object of type :mod:`trappy.base.Base`
"""
kwords = {
"__init__": default_init,
"unique_word": unique_word,
"name": _get_name(class_name),
"parse_raw" : parse_raw,
}
if pivot:
kwords["pivot"] = pivot
dyn_class = DynamicTypeFactory(class_name, (Base,), kwords)
GenericFTrace.register_parser(dyn_class, scope)
return dyn_class
def register_ftrace_parser(cls, scope="all"):
"""Register a new FTrace parser class implementation
Should be used when the class has complex helper methods and does
not expect to use the default constructor.
:param cls: The class to be registered for
enabling the parsing of an event in trace
:type cls: :mod:`trappy.base.Base`
:param scope: scope of this parser class. The scope can be used
to restrict the parsing done on an individual file. Currently
the only scopes available are "sched", "thermal" or "all"
:type scope: string
"""
# Check the argspec of the class
GenericFTrace.register_parser(cls, scope)
def register_ftrace_parser(cls, scope="all"):
"""Register a new FTrace parser class implementation
Should be used when the class has complex helper methods and does
not expect to use the default constructor.
:param cls: The class to be registered for
enabling the parsing of an event in trace
:type cls: :mod:`trappy.base.Base`
:param scope: scope of this parser class. The scope can be used
to restrict the parsing done on an individual file. Currently
the only scopes available are "sched", "thermal" or "all"
:type scope: string
"""
# Check the argspec of the class
GenericFTrace.register_parser(cls, scope)
