.. title:: RTAEventsAnalysis lisa.analysis.rta.RTAEventsAnalysis =================================== .. autoclass:: lisa.analysis.rta::RTAEventsAnalysis :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.analysis.rta.RTAEventsAnalysis.RTAPP_USERSPACE_EVENTS` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis List of ftrace events rtapp is able to emit. * - :attr:`~lisa.analysis.rta.RTAEventsAnalysis.name` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Name of the analysis class. .. rubric:: Properties .. list-table:: :align: left * - :attr:`~lisa.analysis.rta.RTAEventsAnalysis.rtapp_reftime` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Return the tuple representing the ``kernel`` and ``user`` timestamp. * - :attr:`~lisa.analysis.rta.RTAEventsAnalysis.rtapp_tasks` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis List of :class:`lisa.analysis.tasks.TaskID` of the ``rt-app`` tasks present in the trace. * - :attr:`~lisa.analysis.rta.RTAEventsAnalysis.rtapp_window` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Return the time range the rt-app main thread executed. * - :attr:`~lisa.utils.Loggable.logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Convenience short-hand for ``self.get_logger()``. .. rubric:: Methods .. list-table:: :align: left * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_phases` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Get phases actual start times and durations. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_event` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Returns a :class:`pandas.DataFrame` of all the rt-app generated events. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_loop` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Dataframe of events generated by each rt-app generated task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_main` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Dataframe of events generated by the rt-app main task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_phase_end` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis End of the specified phase for a given task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_phase_start` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Start of the specified phase for a given task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_phases_end` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Dataframe of phases end times. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_phases_start` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Dataframe of phases start times. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_stats` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Returns a :class:`pandas.DataFrame` of all the rt-app generated stats. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.df_rtapp_task` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Dataframe of events generated by each rt-app generated task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.plot_latency` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Plot the Latency/Slack and Performance data for the specified task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.plot_perf` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Plot the performance index. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.plot_perf_index_histogram` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Plot the perf index histogram. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.plot_phases` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Draw the task's phases colored bands. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.plot_slack_histogram` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Plot the slack histogram. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.task_phase_at` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Return the :class:`PhaseWindow` for the specified task and timestamp. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.task_phase_window` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Return the window of a requested task phase. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.task_phase_windows` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Yield a :class:`PhaseWindow` for each rt-app phase of the specified task. * - :meth:`~lisa.analysis.rta.RTAEventsAnalysis.task_window` - .. withrefctx:: :module: lisa.analysis.rta :class: lisa.analysis.rta.RTAEventsAnalysis Return the start end end time for the specified task. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.cache` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Decorator to enable caching of the output of dataframe getter function in the trace cache. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.call_on_trace` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Call a method of a subclass on a given trace. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.df_method` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Dataframe function decorator. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_all_events` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Returns the set of all events used by any of the methods. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_analysis_classes` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_default_plot_path` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase Return the default path to use to save plots for the analysis. * - :meth:`~lisa.analysis.base.TraceAnalysisBase.get_df_methods` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.TraceAnalysisBase * - :meth:`~lisa.utils.Loggable.get_logger` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Provides a :class:`logging.Logger` named after ``cls``. * - :meth:`~lisa.analysis.base.AnalysisHelpers.get_plot_methods` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers * - :meth:`~lisa.utils.Loggable.log_locals` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.Loggable Debugging aid: log the local variables of the calling function. * - :meth:`~lisa.analysis.base.AnalysisHelpers.plot_method` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Plot function decorator. * - :meth:`~lisa.analysis.base.AnalysisHelpers.save_plot` :sup:`inherited` - .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Save a holoviews element or :class:`matplotlib.figure.Figure` as an image file. Attributes ---------- .. autoattribute:: lisa.analysis.rta::RTAEventsAnalysis.RTAPP_USERSPACE_EVENTS .. attribute:: RTAEventsAnalysis.name :canonical: lisa.analysis.rta.RTAEventsAnalysis.name :value: 'rta' .. withrefctx:: :module: lisa.analysis.base :class: lisa.analysis.base.AnalysisHelpers Name of the analysis class. Properties ---------- .. autoproperty:: lisa.analysis.rta::RTAEventsAnalysis.rtapp_reftime .. autoproperty:: lisa.analysis.rta::RTAEventsAnalysis.rtapp_tasks .. autoproperty:: lisa.analysis.rta::RTAEventsAnalysis.rtapp_window .. autoproperty:: lisa.analysis.rta::RTAEventsAnalysis.logger Methods ------- .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_phases .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_event .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_loop .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_main .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_phase_end .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_phase_start .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_phases_end .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_phases_start .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_stats .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_rtapp_task .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.plot_latency .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.plot_perf .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.plot_perf_index_histogram .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.plot_phases .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.plot_slack_histogram .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.task_phase_at .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.task_phase_window .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.task_phase_windows .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.task_window .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.cache .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.call_on_trace .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.df_method .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.get_all_events .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.get_analysis_classes .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.get_default_plot_path .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.get_df_methods .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.get_logger .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.get_plot_methods .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.log_locals .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.plot_method .. automethod:: lisa.analysis.rta::RTAEventsAnalysis.save_plot