.. title:: trace lisa.trace ========== .. toctree:: :hidden: AndTraceEventChecker AssociativeTraceEventChecker CPU CollectorBase ComposedCollector CustomFieldsTxtEventParser DmesgCollector DynamicTraceEventChecker EmptyTraceEventChecker EventParserBase FtraceCollector FtraceConf HRTxtTraceParser MetaTxtTraceParser MockTraceParser OptionalTraceEventChecker OrTraceEventChecker PrintTxtEventParser SimpleTxtTraceParser SysTraceParser Trace TraceBase TraceDumpTraceParser TraceEventChecker TraceEventCheckerBase TraceParserBase TxtEventParser TxtTraceParser TxtTraceParserBase __getattr__ may_use_events requires_events requires_one_event_of will_use_events_from DroppedTraceEventError MissingMetadataError MissingTraceEventError TraceDumpError .. module:: lisa.trace .. withrefctx:: :module: lisa.trace .. automodule:: lisa.trace :no-index: :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Classes .. list-table:: :align: left * - :class:`~lisa.trace.AndTraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.AndTraceEventChecker Check that all the given event checkers are satisfied. * - :class:`~lisa.trace.AssociativeTraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.AssociativeTraceEventChecker Base class for associative operators like `and` and `or`. * - :class:`~lisa.trace.CPU` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.CPU Alias to ``int`` used for CPU IDs. * - :class:`~lisa.trace.CollectorBase` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.CollectorBase Base class for :class:`devlib.collector.CollectorBase`-based collectors using composition. * - :class:`~lisa.trace.ComposedCollector` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.ComposedCollector Compose multiple :class:`lisa.trace.CollectorBase` together. * - :class:`~lisa.trace.CustomFieldsTxtEventParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.CustomFieldsTxtEventParser Subclass of :class:`TxtEventParser` to be used for funky formats. * - :class:`~lisa.trace.DmesgCollector` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.DmesgCollector Wrapper around :class:`devlib.collector.dmesg.DmesgCollector`. * - :class:`~lisa.trace.DynamicTraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.DynamicTraceEventChecker Do not check anything, but exposes the information that one of the group of events will be used. * - :class:`~lisa.trace.EmptyTraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.EmptyTraceEventChecker Check for no event at all. * - :class:`~lisa.trace.EventParserBase` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.EventParserBase Base class for trace event parser. * - :class:`~lisa.trace.FtraceCollector` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.FtraceCollector Thin wrapper around :class:`devlib.collector.ftrace.FtraceCollector`. * - :class:`~lisa.trace.FtraceConf` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.FtraceConf Configuration class of :class:`FtraceCollector`. * - :class:`~lisa.trace.HRTxtTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.HRTxtTraceParser Parse text trace in their human readable format (as opposed to the raw format). * - :class:`~lisa.trace.MetaTxtTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.MetaTxtTraceParser Textual trace parser to parse meta-events. * - :class:`~lisa.trace.MockTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.MockTraceParser Mock parser that just returns the dataframes it was given. * - :class:`~lisa.trace.OptionalTraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.OptionalTraceEventChecker Do not check anything, but exposes the information that the events may be used if present. * - :class:`~lisa.trace.OrTraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.OrTraceEventChecker Check that one of the given event checkers is satisfied. * - :class:`~lisa.trace.PrintTxtEventParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.PrintTxtEventParser Event parser for the folling events, displayed in non-raw format by ``trace-cmd``:. * - :class:`~lisa.trace.SimpleTxtTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.SimpleTxtTraceParser Simple text trace parser (base) class. * - :class:`~lisa.trace.SysTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.SysTraceParser Parse Google's systrace format. * - :class:`~lisa.trace.Trace` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.Trace This class provides a way to access event dataframes and ties together various low-level moving pieces to make that happen. * - :class:`~lisa.trace.TraceBase` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TraceBase Base class for all public trace classes. * - :class:`~lisa.trace.TraceDumpTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TraceDumpTraceParser trace.dat parser shipped by LISA. * - :class:`~lisa.trace.TraceEventChecker` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TraceEventChecker Check for one single event. * - :class:`~lisa.trace.TraceEventCheckerBase` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TraceEventCheckerBase ABC for events checker classes. * - :class:`~lisa.trace.TraceParserBase` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TraceParserBase Abstract Base Class for trace parsers. * - :class:`~lisa.trace.TxtEventParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TxtEventParser Trace event parser for raw output of ``trace-cmd report -R trace.dat``. * - :class:`~lisa.trace.TxtTraceParser` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TxtTraceParser Text trace parser for the raw output of ``trace-cmd report -R trace.dat``. * - :class:`~lisa.trace.TxtTraceParserBase` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TxtTraceParserBase Text trace parser base class. .. rubric:: Functions .. list-table:: :align: left * - :func:`~lisa.trace.__getattr__` - .. withrefctx:: :module: lisa.trace * - :func:`~lisa.trace.may_use_events` - .. withrefctx:: :module: lisa.trace Same as :func:`requires_events` but just exposes some events that may be used if presents. * - :func:`~lisa.trace.requires_events` - .. withrefctx:: :module: lisa.trace Decorator for methods that require some given trace events. * - :func:`~lisa.trace.requires_one_event_of` - .. withrefctx:: :module: lisa.trace Same as :func:`requires_events` with logical `OR` semantic. * - :func:`~lisa.trace.will_use_events_from` - .. withrefctx:: :module: lisa.trace Same as :func:`requires_events` but just exposes some events groups that will be used, depending on some dynamic factor. .. rubric:: Exceptions .. list-table:: :align: left * - :class:`~lisa.trace.DroppedTraceEventError` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.DroppedTraceEventError Raised when some events were dropped from the ftrace ring buffer because of lack of space. * - :class:`~lisa.trace.MissingMetadataError` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.MissingMetadataError Raised when a given metadata is not available. * - :class:`~lisa.trace.MissingTraceEventError` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.MissingTraceEventError :param missing_events: The missing trace events :type missing_events: TraceEventCheckerBase or list(str). * - :class:`~lisa.trace.TraceDumpError` - .. withrefctx:: :module: lisa.trace :class: lisa.trace.TraceDumpError Exception containing errors forwarded from the trace-dump parser.