mirror of
https://gitlab.com/qemu-project/qemu
synced 2024-09-06 18:05:37 +00:00
simpletrace: document Analyzer method signatures
Users can inherit from the simpletrace.Analyzer class and receive callbacks when events of interest occur in a trace file. The method signature is a little magic because the timestamp and pid arguments are optional. Document this. Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Alex Bennée <alex.bennee@linaro.org> Message-id: 20170411095654.18383-1-stefanha@redhat.com Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
This commit is contained in:
parent
3d1baccb08
commit
659370f71f
|
@ -116,7 +116,28 @@ class Analyzer(object):
|
||||||
is invoked.
|
is invoked.
|
||||||
|
|
||||||
If a method matching a trace event name exists, it is invoked to process
|
If a method matching a trace event name exists, it is invoked to process
|
||||||
that trace record. Otherwise the catchall() method is invoked."""
|
that trace record. Otherwise the catchall() method is invoked.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
The following method handles the runstate_set(int new_state) trace event::
|
||||||
|
|
||||||
|
def runstate_set(self, new_state):
|
||||||
|
...
|
||||||
|
|
||||||
|
The method can also take a timestamp argument before the trace event
|
||||||
|
arguments::
|
||||||
|
|
||||||
|
def runstate_set(self, timestamp, new_state):
|
||||||
|
...
|
||||||
|
|
||||||
|
Timestamps have the uint64_t type and are in nanoseconds.
|
||||||
|
|
||||||
|
The pid can be included in addition to the timestamp and is useful when
|
||||||
|
dealing with traces from multiple processes::
|
||||||
|
|
||||||
|
def runstate_set(self, timestamp, pid, new_state):
|
||||||
|
...
|
||||||
|
"""
|
||||||
|
|
||||||
def begin(self):
|
def begin(self):
|
||||||
"""Called at the start of the trace."""
|
"""Called at the start of the trace."""
|
||||||
|
|
Loading…
Reference in a new issue