.. title:: RTA lisa.wlgen.rta.RTA ================== .. autoclass:: lisa.wlgen.rta::RTA :no-members: :no-inherited-members: :no-undoc-members: :no-private-members: :no-special-members: .. rubric:: Attributes .. list-table:: :align: left * - :attr:`~lisa.wlgen.rta.RTA.REQUIRED_TOOLS` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload The tools required to execute the workload. See :meth:`lisa.target.Target.install_tools`. .. rubric:: Properties .. list-table:: :align: left * - :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.wlgen.rta.RTA.__del__` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA * - :meth:`~lisa.wlgen.rta.RTA.from_conf` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Create an rt-app workload using a :class:`RTAConf`. * - :meth:`~lisa.wlgen.rta.RTA.from_profile` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Create an rt-app workload using :class:`RTATask` instances. * - :meth:`~lisa.wlgen.rta.RTA.from_str` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Create an rt-app workload using a pure string description. * - :meth:`~lisa.wlgen.rta.RTA.get_cpu_calibrations` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Get the rt-ap calibration value for all CPUs. * - :meth:`~lisa.wlgen.rta.RTA.get_cpu_capacities_from_calibrations` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Compute the CPU capacities out of the rt-app calibration values. * - :meth:`~lisa.wlgen.rta.RTA.get_trace_task_names` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Get a dictionnary of :class:`lisa.analysis.tasks.TaskID` used in the given trace for this task. * - :meth:`~lisa.wlgen.rta.RTA.resolve_trace_task_names` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Translate an RTA profile task name to a list of :class:`lisa.analysis.tasks.TaskID` as found in a :class:`lisa.trace.Trace`. * - :meth:`~lisa.wlgen.rta.RTA.warn_capacities_mismatch` - .. withrefctx:: :module: lisa.wlgen.rta :class: lisa.wlgen.rta.RTA Compare ``orig_capacities`` and ``new_capacities`` and log warnings if they are not consistent. * - :meth:`~lisa.wlgen.workload.Workload.__enter__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload * - :meth:`~lisa.wlgen.workload.Workload.__exit__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload Cleanup the artifacts of the workload on the target. * - :meth:`~lisa.wlgen.workload.Workload.__init_subclass__` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload._WorkloadBase Automatically decorate ``_run()`` so that it returns a context manager. * - :meth:`~lisa.wlgen.workload.Workload.cleanup` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload Remove all the artifacts installed on the target with :meth:`deploy`. * - :meth:`~lisa.wlgen.workload.Workload.deploy` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload Deploy the workload on the target. * - :meth:`~lisa.utils.PartialInit.factory` :sup:`inherited` - .. withrefctx:: :module: lisa.utils :class: lisa.utils.PartialInit Decorator to use on alternative constructors, i.e. classmethods that return instances of the class. * - :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.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.wlgen.workload.Workload.run` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload Run the workload and returns the post-processed output. * - :meth:`~lisa.wlgen.workload.Workload.run_background` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload Run the command asynchronously and give control back to the caller. * - :meth:`~lisa.wlgen.workload.Workload.wipe_run_dir` :sup:`inherited` - .. withrefctx:: :module: lisa.wlgen.workload :class: lisa.wlgen.workload.Workload Wipe all content from the ``run_dir`` target directory and all its empty parents. Attributes ---------- .. autoattribute:: lisa.wlgen.rta::RTA.REQUIRED_TOOLS Properties ---------- .. autoproperty:: lisa.wlgen.rta::RTA.logger Methods ------- .. automethod:: lisa.wlgen.rta::RTA.__del__ .. automethod:: lisa.wlgen.rta::RTA.from_conf .. automethod:: lisa.wlgen.rta::RTA.from_profile .. automethod:: lisa.wlgen.rta::RTA.from_str .. automethod:: lisa.wlgen.rta::RTA.get_cpu_calibrations .. automethod:: lisa.wlgen.rta::RTA.get_cpu_capacities_from_calibrations .. automethod:: lisa.wlgen.rta::RTA.get_trace_task_names .. automethod:: lisa.wlgen.rta::RTA.resolve_trace_task_names .. automethod:: lisa.wlgen.rta::RTA.warn_capacities_mismatch .. automethod:: lisa.wlgen.rta::RTA.__enter__ .. automethod:: lisa.wlgen.rta::RTA.__exit__ .. automethod:: lisa.wlgen.rta::RTA.__init_subclass__ .. automethod:: lisa.wlgen.rta::RTA.cleanup .. automethod:: lisa.wlgen.rta::RTA.deploy .. automethod:: lisa.wlgen.rta::RTA.factory .. automethod:: lisa.wlgen.rta::RTA.get_logger .. automethod:: lisa.wlgen.rta::RTA.log_locals .. automethod:: lisa.wlgen.rta::RTA.run .. automethod:: lisa.wlgen.rta::RTA.run_background .. automethod:: lisa.wlgen.rta::RTA.wipe_run_dir .. automethod:: lisa.wlgen.rta::RTA.by_profile .. automethod:: lisa.wlgen.rta::RTA.by_str