Fsphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget//translations/zh_CN/tools/rtla/rtla-osnoise-topmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget//translations/zh_TW/tools/rtla/rtla-osnoise-topmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget//translations/it_IT/tools/rtla/rtla-osnoise-topmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget//translations/ja_JP/tools/rtla/rtla-osnoise-topmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget//translations/ko_KR/tools/rtla/rtla-osnoise-topmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget//translations/sp_SP/tools/rtla/rtla-osnoise-topmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsubstitution_definition)}(h .. |tool| replace:: osnoise top h]h osnoise top}hhsbah}(h]h ]h"]toolah$]h&]uh1hhI/var/lib/git/docbuild/linux/Documentation/tools/rtla/rtla-osnoise-top.rsthKhhhhubhsection)}(hhh](htitle)}(hrtla-osnoise-toph]hrtla-osnoise-top}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h/Display a summary of the operating system noiseh]h/Display a summary of the operating system noise}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh field_list)}(hhh]hfield)}(hhh](h field_name)}(hManual sectionh]hManual section}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhKubh field_body)}(h1 h]h paragraph)}(h1h]h1}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhubah}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhhK hhhhubah}(h]h ]h"]h$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(hSYNOPSISh]hSYNOPSIS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK ubh)}(h **rtla osnoise top** [*OPTIONS*]h](hstrong)}(h**rtla osnoise top**h]hrtla osnoise top}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj,ubh [}(hj,hhhNhNubhemphasis)}(h *OPTIONS*h]hOPTIONS}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj,ubh]}(hj,hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h]synopsisah ]h"]synopsisah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h DESCRIPTIONh]h DESCRIPTION}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfhhhhhKubh)}(hXThe **rtla osnoise** tool is an interface for the *osnoise* tracer. The *osnoise* tracer dispatches a kernel thread per-cpu. These threads read the time in a loop while with preemption, softirq and IRQs enabled, thus allowing all the sources of operating system noise during its execution. The *osnoise*'s tracer threads take note of the delta between each time read, along with an interference counter of all sources of interference. At the end of each period, the *osnoise* tracer displays a summary of the results.h](hThe }(hjwhhhNhNubj1)}(h**rtla osnoise**h]h rtla osnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjwubh tool is an interface for the }(hjwhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjwubh tracer. The }(hjwhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjwubh tracer dispatches a kernel thread per-cpu. These threads read the time in a loop while with preemption, softirq and IRQs enabled, thus allowing all the sources of operating system noise during its execution. The }(hjwhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjwubh’s tracer threads take note of the delta between each time read, along with an interference counter of all sources of interference. At the end of each period, the }(hjwhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjwubh* tracer displays a summary of the results.}(hjwhhhNhNubeh}(h]h ]h"]h$]h&]uh1hh7Documentation/tools/rtla/common_osnoise_description.txthKhjfhhubh)}(h**rtla osnoise top** collects the periodic summary from the *osnoise* tracer, including the counters of the occurrence of the interference source, displaying the results in a user-friendly format.h](j1)}(h**rtla osnoise top**h]hrtla osnoise top}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh( collects the periodic summary from the }(hjhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh tracer, including the counters of the occurrence of the interference source, displaying the results in a user-friendly format.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjfhhubh)}(hiThe tool also allows many configurations of the *osnoise* tracer and the collection of the tracer output.h](h0The tool also allows many configurations of the }(hjhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh0 tracer and the collection of the tracer output.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjfhhubeh}(h] descriptionah ]h"] descriptionah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hOPTIONSh]hOPTIONS}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hhhhhKubh)}(hN.. |threshold| replace:: **-a/--auto**, **-s/--stop**, or **-S/--stop-total**h](j1)}(h **-a/--auto**h]h -a/--auto}hjKsbah}(h]h ]h"]h$]h&]uh1j0hjGubh, }hjGsbj1)}(h **-s/--stop**h]h -s/--stop}hj]sbah}(h]h ]h"]h$]h&]uh1j0hjGubh, or }hjGsbj1)}(h**-S/--stop-total**h]h-S/--stop-total}hjosbah}(h]h ]h"]h$]h&]uh1j0hjGubeh}(h]h ]h"] thresholdah$]h&]uh1hh3Documentation/tools/rtla/common_osnoise_options.txthKhj6hhubh)}(h.. |thresharg| replace:: -sh]h-s}hjsbah}(h]h ]h"] threshargah$]h&]uh1hhjhKhj6hhubh)}(h".. |tracer| replace:: osnoise h]hosnoise}hjsbah}(h]h ]h"]tracerah$]h&]uh1hhjhKhj6hhubh)}(h.. |actionsperf| replace:: Due to implementational limitations, actions might be delayed up to one second after tracing is stopped. h]hhDue to implementational limitations, actions might be delayed up to one second after tracing is stopped.}hjsbah}(h]h ]h"] actionsperfah$]h&]uh1hhjhKhj6hhubh)}(h**-a**, **--auto** *us*h](j1)}(h**-a**h]h-a}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--auto**h]h--auto}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*us*h]hus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhjhK hj6hhubh block_quote)}(hSet the automatic trace mode. This mode sets some commonly used options while debugging the system. It is equivalent to use **-s** *us* **-T 1 -t**. h]h)}(hSet the automatic trace mode. This mode sets some commonly used options while debugging the system. It is equivalent to use **-s** *us* **-T 1 -t**.h](h|Set the automatic trace mode. This mode sets some commonly used options while debugging the system. It is equivalent to use }(hjhhhNhNubj1)}(h**-s**h]h-s}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*us*h]hus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh }hjsbj1)}(h **-T 1 -t**h]h-T 1 -t}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK hjubah}(h]h ]h"]h$]h&]uh1jhjhK hj6hhubh)}(h**-p**, **--period** *us*h](j1)}(h**-p**h]h-p}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj>ubh, }(hj>hhhNhNubj1)}(h **--period**h]h--period}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj>ubh }(hj>hhhNhNubjE)}(h*us*h]hus}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj>ubeh}(h]h ]h"]h$]h&]uh1hhjhKhj6hhubj)}(h1Set the *osnoise* tracer period in microseconds. h]h)}(h0Set the *osnoise* tracer period in microseconds.h](hSet the }(hj~hhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj~ubh tracer period in microseconds.}(hj~hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjzubah}(h]h ]h"]h$]h&]uh1jhjhKhj6hhubh)}(h**-r**, **--runtime** *us*h](j1)}(h**-r**h]h-r}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--runtime**h]h --runtime}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*us*h]hus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhjhKhj6hhubj)}(h2Set the *osnoise* tracer runtime in microseconds. h]h)}(h1Set the *osnoise* tracer runtime in microseconds.h](hSet the }(hjhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh tracer runtime in microseconds.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj6hhubh)}(h**-s**, **--stop** *us*h](j1)}(h**-s**h]h-s}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh, }(hj hhhNhNubj1)}(h **--stop**h]h--stop}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h*us*h]hus}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubeh}(h]h ]h"]h$]h&]uh1hhjhKhj6hhubj)}(hStop the trace if a single sample is higher than the argument in microseconds. If **-T** is set, it will also save the trace to the output. h]h)}(hStop the trace if a single sample is higher than the argument in microseconds. If **-T** is set, it will also save the trace to the output.h](hRStop the trace if a single sample is higher than the argument in microseconds. If }(hjJhhhNhNubj1)}(h**-T**h]h-T}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjJubh3 is set, it will also save the trace to the output.}(hjJhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjFubah}(h]h ]h"]h$]h&]uh1jhjhKhj6hhubh)}(h**-S**, **--stop-total** *us*h](j1)}(h**-S**h]h-S}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjpubh, }(hjphhhNhNubj1)}(h**--stop-total**h]h --stop-total}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjpubh }(hjphhhNhNubjE)}(h*us*h]hus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjpubeh}(h]h ]h"]h$]h&]uh1hhjhKhj6hhubj)}(hStop the trace if the total sample is higher than the argument in microseconds. If **-T** is set, it will also save the trace to the output. h]h)}(hStop the trace if the total sample is higher than the argument in microseconds. If **-T** is set, it will also save the trace to the output.h](hSStop the trace if the total sample is higher than the argument in microseconds. If }(hjhhhNhNubj1)}(h**-T**h]h-T}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh3 is set, it will also save the trace to the output.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj6hhubh)}(h**-T**, **--threshold** *us*h](j1)}(h**-T**h]h-T}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h**--threshold**h]h --threshold}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*us*h]hus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhjhK hj6hhubj)}(hjSpecify the minimum delta between two time reads to be considered noise. The default threshold is *5 us*. h]h)}(hiSpecify the minimum delta between two time reads to be considered noise. The default threshold is *5 us*.h](hbSpecify the minimum delta between two time reads to be considered noise. The default threshold is }(hjhhhNhNubjE)}(h*5 us*h]h5 us}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK"hjubah}(h]h ]h"]h$]h&]uh1jhjhK"hj6hhubh)}(h**-t**, **--trace** \[*file*]h](j1)}(h**-t**h]h-t}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubh, }(hj<hhhNhNubj1)}(h **--trace**h]h--trace}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubh [}(hj<hhhNhNubjE)}(h*file*h]hfile}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj<ubh]}(hj<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK%hj6hhubj)}(h6Save the stopped trace to [*file|osnoise_trace.txt*]. h]h)}(h5Save the stopped trace to [*file|osnoise_trace.txt*].h](hSave the stopped trace to [}(hjhhhNhNubjE)}(h*file|osnoise_trace.txt*h]hfile|osnoise_trace.txt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh].}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhK'hj|ubah}(h]h ]h"]h$]h&]uh1jhjhK'hj6hhubh)}(h**-q**, **--quiet**h](j1)}(h**-q**h]h-q}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--quiet**h]h--quiet}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ]h"]h$]h&]uh1hh/Documentation/tools/rtla/common_top_options.txthKhj6hhubj)}(h0Print only a summary at the end of the session. h]h)}(h/Print only a summary at the end of the session.h]h/Print only a summary at the end of the session.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj6hhubh)}(h**-c**, **--cpus** *cpu-list*h](j1)}(h**-c**h]h-c}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--cpus**h]h--cpus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h *cpu-list*h]hcpu-list}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hh+Documentation/tools/rtla/common_options.txthKhj6hhubj)}(hSet the |tool| tracer to run the sample threads in the cpu-list. By default, the |tool| tracer runs the sample threads on all CPUs. h](h)}(h@Set the |tool| tracer to run the sample threads in the cpu-list.h](hSet the }(hj*hhhNhNubh osnoise top}(hj*hhhNhNubh2 tracer to run the sample threads in the cpu-list.}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj&ubh)}(hBBy default, the |tool| tracer runs the sample threads on all CPUs.h](hBy default, the }(hj@hhhNhNubh osnoise top}(hj@hhhNhNubh, tracer runs the sample threads on all CPUs.}(hj@hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj&ubeh}(h]h ]h"]h$]h&]uh1jhj%hKhj6hhubh)}(h&**-H**, **--house-keeping** *cpu-list*h](j1)}(h**-H**h]h-H}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj\ubh, }(hj\hhhNhNubj1)}(h**--house-keeping**h]h--house-keeping}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj\ubh }(hj\hhhNhNubjE)}(h *cpu-list*h]hcpu-list}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj\ubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj6hhubj)}(hRun rtla control threads only on the given cpu-list. If omitted, rtla will attempt to auto-migrate its main thread to any CPU that is not running any workload threads. h](h)}(h4Run rtla control threads only on the given cpu-list.h]h4Run rtla control threads only on the given cpu-list.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK hjubh)}(hrIf omitted, rtla will attempt to auto-migrate its main thread to any CPU that is not running any workload threads.h]hrIf omitted, rtla will attempt to auto-migrate its main thread to any CPU that is not running any workload threads.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK hjubeh}(h]h ]h"]h$]h&]uh1jhj%hK hj6hhubh)}(h&**-d**, **--duration** *time[s|m|h|d]*h](j1)}(h**-d**h]h-d}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h**--duration**h]h --duration}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*time[s|m|h|d]*h]h time[s|m|h|d]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhj%hK hj6hhubj)}(h!Set the duration of the session. h]h)}(h Set the duration of the session.h]h Set the duration of the session.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKhjubah}(h]h ]h"]h$]h&]uh1jhj%hKhj6hhubh)}(h**-D**, **--debug**h](j1)}(h**-D**h]h-D}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--debug**h]h--debug}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj6hhubj)}(hPrint debug info. h]h)}(hPrint debug info.h]hPrint debug info.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKhj<ubah}(h]h ]h"]h$]h&]uh1jhj%hKhj6hhubh)}(h**-e**, **--event** *sys:event*h](j1)}(h**-e**h]h-e}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjTubh, }(hjThhhNhNubj1)}(h **--event**h]h--event}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjTubh }(hjThhhNhNubjE)}(h *sys:event*h]h sys:event}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjTubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj6hhubj)}(hEnable an event in the trace (**-t**) session. The argument can be a specific event, e.g., **-e** *sched:sched_switch*, or all events of a system group, e.g., **-e** *sched*. Multiple **-e** are allowed. It is only active when **-t** or **-a** are set. h]h)}(hEnable an event in the trace (**-t**) session. The argument can be a specific event, e.g., **-e** *sched:sched_switch*, or all events of a system group, e.g., **-e** *sched*. Multiple **-e** are allowed. It is only active when **-t** or **-a** are set.h](hEnable an event in the trace (}(hjhhhNhNubj1)}(h**-t**h]h-t}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh7) session. The argument can be a specific event, e.g., }(hjhhhNhNubj1)}(h**-e**h]h-e}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*sched:sched_switch*h]hsched:sched_switch}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh), or all events of a system group, e.g., }(hjhhhNhNubj1)}(h**-e**h]h-e}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }hjsbjE)}(h*sched*h]hsched}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh . Multiple }(hjhhhNhNubj1)}(h**-e**h]h-e}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh% are allowed. It is only active when }(hjhhhNhNubj1)}(h**-t**h]h-t}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh or }(hjhhhNhNubj1)}(h**-a**h]h-a}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh are set.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKhjubah}(h]h ]h"]h$]h&]uh1jhj%hKhj6hhubh)}(h**--filter** **h](j1)}(h **--filter**h]h--filter}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj8ubh }(hj8hhhNhNubjE)}(h **h]h}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj8ubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj6hhubj)}(hFilter the previous **-e** *sys:event* event with **. For further information about event filtering see https://www.kernel.org/doc/html/latest/trace/events.html#event-filtering. h]h)}(hFilter the previous **-e** *sys:event* event with **. For further information about event filtering see https://www.kernel.org/doc/html/latest/trace/events.html#event-filtering.h](hFilter the previous }(hjfhhhNhNubj1)}(h**-e**h]h-e}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjfubh }(hjfhhhNhNubjE)}(h *sys:event*h]h sys:event}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjfubh event with }(hjfhhhNhNubjE)}(h **h]h}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjfubh4. For further information about event filtering see }(hjfhhhNhNubh reference)}(hHhttps://www.kernel.org/doc/html/latest/trace/events.html#event-filteringh]hHhttps://www.kernel.org/doc/html/latest/trace/events.html#event-filtering}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1jhjfubh.}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKhjbubah}(h]h ]h"]h$]h&]uh1jhj%hKhj6hhubhdefinition_list)}(hhh]hdefinition_list_item)}(hXj**--trigger** ** Enable a trace event trigger to the previous **-e** *sys:event*. If the *hist:* trigger is activated, the output histogram will be automatically saved to a file named *system_event_hist.txt*. For example, the command: rtla -t -e osnoise:irq_noise --trigger="hist:key=desc,duration/1000:sort=desc,duration/1000:vals=hitcount" Will automatically save the content of the histogram associated to *osnoise:irq_noise* event in *osnoise_irq_noise_hist.txt*. For further information about event trigger see https://www.kernel.org/doc/html/latest/trace/events.html#event-triggers. h](hterm)}(h**--trigger** **h](j1)}(h **--trigger**h]h --trigger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h **h]h }(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1jhj%hK&hjubh definition)}(hhh](h)}(hEnable a trace event trigger to the previous **-e** *sys:event*. If the *hist:* trigger is activated, the output histogram will be automatically saved to a file named *system_event_hist.txt*. For example, the command:h](h-Enable a trace event trigger to the previous }(hj hhhNhNubj1)}(h**-e**h]h-e}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h *sys:event*h]h sys:event}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh . If the }(hj hhhNhNubjE)}(h*hist:*h]hhist:}(hj- hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubhX trigger is activated, the output histogram will be automatically saved to a file named }(hj hhhNhNubjE)}(h*system_event_hist.txt*h]hsystem_event_hist.txt}(hj? hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh. For example, the command:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKhjubh)}(h{rtla -t -e osnoise:irq_noise --trigger="hist:key=desc,duration/1000:sort=desc,duration/1000:vals=hitcount"h]hrtla -t -e osnoise:irq_noise --trigger=”hist:key=desc,duration/1000:sort=desc,duration/1000:vals=hitcount”}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK"hjubh)}(h}Will automatically save the content of the histogram associated to *osnoise:irq_noise* event in *osnoise_irq_noise_hist.txt*.h](hCWill automatically save the content of the histogram associated to }(hje hhhNhNubjE)}(h*osnoise:irq_noise*h]hosnoise:irq_noise}(hjm hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhje ubh event in }(hje hhhNhNubjE)}(h*osnoise_irq_noise_hist.txt*h]hosnoise_irq_noise_hist.txt}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhje ubh.}(hje hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK$hjubh)}(hxFor further information about event trigger see https://www.kernel.org/doc/html/latest/trace/events.html#event-triggers.h](h0For further information about event trigger see }(hj hhhNhNubj)}(hGhttps://www.kernel.org/doc/html/latest/trace/events.html#event-triggersh]hGhttps://www.kernel.org/doc/html/latest/trace/events.html#event-triggers}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1jhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK&hjubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj%hK&hjubah}(h]h ]h"]h$]h&]uh1jhj6hhhj%hNubh)}(h>**-P**, **--priority** *o:prio|r:prio|f:prio|d:runtime:period*h](j1)}(h**-P**h]h-P}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh, }(hj hhhNhNubj1)}(h**--priority**h]h --priority}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h'*o:prio|r:prio|f:prio|d:runtime:period*h]h%o:prio|r:prio|f:prio|d:runtime:period}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubeh}(h]h ]h"]h$]h&]uh1hhj%hK(hj6hhubj)}(hXSet scheduling parameters to the |tool| tracer threads, the format to set the priority are: - *o:prio* - use SCHED_OTHER with *prio*; - *r:prio* - use SCHED_RR with *prio*; - *f:prio* - use SCHED_FIFO with *prio*; - *d:runtime[us|ms|s]:period[us|ms|s]* - use SCHED_DEADLINE with *runtime* and *period* in nanoseconds. If not set, tracer threads keep their default priority. For rtla user threads, it is set to SCHED_FIFO with priority 95. For kernel threads, see *osnoise* and *timerlat* tracer documentation for the running kernel version. h](h)}(h[Set scheduling parameters to the |tool| tracer threads, the format to set the priority are:h](h!Set scheduling parameters to the }(hj hhhNhNubh osnoise top}(hj hhhNhNubh4 tracer threads, the format to set the priority are:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK*hj ubh bullet_list)}(hhh](h list_item)}(h'*o:prio* - use SCHED_OTHER with *prio*;h]h)}(hj) h](jE)}(h*o:prio*h]ho:prio}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj+ ubh - use SCHED_OTHER with }(hj+ hhhNhNubjE)}(h*prio*h]hprio}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj+ ubh;}(hj+ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK,hj' ubah}(h]h ]h"]h$]h&]uh1j% hj" ubj& )}(h$*r:prio* - use SCHED_RR with *prio*;h]h)}(hj` h](jE)}(h*r:prio*h]hr:prio}(hje hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjb ubh - use SCHED_RR with }(hjb hhhNhNubjE)}(h*prio*h]hprio}(hjw hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjb ubh;}(hjb hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK-hj^ ubah}(h]h ]h"]h$]h&]uh1j% hj" ubj& )}(h&*f:prio* - use SCHED_FIFO with *prio*;h]h)}(hj h](jE)}(h*f:prio*h]hf:prio}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh - use SCHED_FIFO with }(hj hhhNhNubjE)}(h*prio*h]hprio}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh;}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK.hj ubah}(h]h ]h"]h$]h&]uh1j% hj" ubj& )}(hf*d:runtime[us|ms|s]:period[us|ms|s]* - use SCHED_DEADLINE with *runtime* and *period* in nanoseconds. h]h)}(he*d:runtime[us|ms|s]:period[us|ms|s]* - use SCHED_DEADLINE with *runtime* and *period* in nanoseconds.h](jE)}(h$*d:runtime[us|ms|s]:period[us|ms|s]*h]h"d:runtime[us|ms|s]:period[us|ms|s]}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh - use SCHED_DEADLINE with }(hj hhhNhNubjE)}(h *runtime*h]hruntime}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh and }(hj hhhNhNubjE)}(h*period*h]hperiod}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh in nanoseconds.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK/hj ubah}(h]h ]h"]h$]h&]uh1j% hj" ubeh}(h]h ]h"]h$]h&]bullet-uh1j hj%hK,hj ubh)}(hIf not set, tracer threads keep their default priority. For rtla user threads, it is set to SCHED_FIFO with priority 95. For kernel threads, see *osnoise* and *timerlat* tracer documentation for the running kernel version.h](hIf not set, tracer threads keep their default priority. For rtla user threads, it is set to SCHED_FIFO with priority 95. For kernel threads, see }(hj hhhNhNubjE)}(h *osnoise*h]hosnoise}(hj& hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh and }(hj hhhNhNubjE)}(h *timerlat*h]htimerlat}(hj8 hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh5 tracer documentation for the running kernel version.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK1hj ubeh}(h]h ]h"]h$]h&]uh1jhj%hK*hj6hhubh)}(h **-C**, **--cgroup** \[*cgroup*]h](j1)}(h**-C**h]h-C}(hjZ hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjV ubh, }(hjV hhhNhNubj1)}(h **--cgroup**h]h--cgroup}(hjl hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjV ubh [}(hjV hhhNhNubjE)}(h*cgroup*h]hcgroup}(hj~ hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjV ubh]}(hjV hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK3hj6hhubj)}(hXSet a *cgroup* to the tracer's threads. If the **-C** option is passed without arguments, the tracer's thread will inherit **rtla**'s *cgroup*. Otherwise, the threads will be placed on the *cgroup* passed to the option. If not set, the behavior differs between workload types. User workloads created by rtla will inherit rtla's cgroup. Kernel workloads are assigned the root cgroup. h](h)}(hSet a *cgroup* to the tracer's threads. If the **-C** option is passed without arguments, the tracer's thread will inherit **rtla**'s *cgroup*. Otherwise, the threads will be placed on the *cgroup* passed to the option.h](hSet a }(hj hhhNhNubjE)}(h*cgroup*h]hcgroup}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh# to the tracer’s threads. If the }(hj hhhNhNubj1)}(h**-C**h]h-C}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubhH option is passed without arguments, the tracer’s thread will inherit }(hj hhhNhNubj1)}(h**rtla**h]hrtla}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh’s }(hj hhhNhNubjE)}(h*cgroup*h]hcgroup}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh/. Otherwise, the threads will be placed on the }(hj hhhNhNubjE)}(h*cgroup*h]hcgroup}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh passed to the option.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK5hj ubh)}(hIf not set, the behavior differs between workload types. User workloads created by rtla will inherit rtla's cgroup. Kernel workloads are assigned the root cgroup.h]hIf not set, the behavior differs between workload types. User workloads created by rtla will inherit rtla’s cgroup. Kernel workloads are assigned the root cgroup.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK7hj ubeh}(h]h ]h"]h$]h&]uh1jhj%hK5hj6hhubh)}(h**--warm-up** *s*h](j1)}(h **--warm-up**h]h --warm-up}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h*s*h]hs}(hj, hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubeh}(h]h ]h"]h$]h&]uh1hhj%hK9hj6hhubj)}(hAfter starting the workload, let it run for *s* seconds before starting collecting the data, allowing the system to warm-up. Statistical data generated during warm-up is discarded. h]h)}(hAfter starting the workload, let it run for *s* seconds before starting collecting the data, allowing the system to warm-up. Statistical data generated during warm-up is discarded.h](h,After starting the workload, let it run for }(hjD hhhNhNubjE)}(h*s*h]hs}(hjL hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjD ubh seconds before starting collecting the data, allowing the system to warm-up. Statistical data generated during warm-up is discarded.}(hjD hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK;hj@ ubah}(h]h ]h"]h$]h&]uh1jhj%hK;hj6hhubj)}(hhh]j)}(h**--trace-buffer-size** *kB* Set the per-cpu trace buffer size in kB for the tracing output. If not set, the default tracefs buffer size is used. h](j)}(h**--trace-buffer-size** *kB*h](j1)}(h**--trace-buffer-size**h]h--trace-buffer-size}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjq ubh }(hjq hhhNhNubjE)}(h*kB*h]hkB}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjq ubeh}(h]h ]h"]h$]h&]uh1jhj%hK@hjm ubj)}(hhh](h)}(h?Set the per-cpu trace buffer size in kB for the tracing output.h]h?Set the per-cpu trace buffer size in kB for the tracing output.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK>hj ubh)}(h4If not set, the default tracefs buffer size is used.h]h4If not set, the default tracefs buffer size is used.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK@hj ubeh}(h]h ]h"]h$]h&]uh1jhjm ubeh}(h]h ]h"]h$]h&]uh1jhj%hK@hjj ubah}(h]h ]h"]h$]h&]uh1jhj6hhhj%hNubh)}(h**--on-threshold** *action*h](j1)}(h**--on-threshold**h]h--on-threshold}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h*action*h]haction}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubeh}(h]h ]h"]h$]h&]uh1hhj%hKBhj6hhubj)}(hXDefines an action to be executed when tracing is stopped on a latency threshold specified by |threshold|. Multiple --on-threshold actions may be specified, and they will be executed in the order they are provided. If any action fails, subsequent actions in the list will not be executed. Supported actions are: - *trace[,file=]* Saves trace output, optionally taking a filename. Alternative to -t/--trace. Note that unlike -t/--trace, specifying this multiple times will result in the trace being saved multiple times. - *signal,num=,pid=* Sends signal to process. "parent" might be specified in place of pid to target the parent process of rtla. - *shell,command=* Execute shell command. - *continue* Continue tracing after actions are executed instead of stopping. Example: $ rtla |tool| |thresharg| 20 --on-threshold trace --on-threshold shell,command="grep ipi_send |tracer|\_trace.txt" --on-threshold signal,num=2,pid=parent This will save a trace with the default filename "|tracer|\_trace.txt", print its lines that contain the text "ipi_send" on standard output, and send signal 2 (SIGINT) to the parent process. Performance Considerations: |actionsperf| h](h)}(hiDefines an action to be executed when tracing is stopped on a latency threshold specified by |threshold|.h](h]Defines an action to be executed when tracing is stopped on a latency threshold specified by }(hj hhhNhNubj1)}(hjMh]h -a/--auto}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hNhNhj hhubh, }(hj hhhNhNubj1)}(hj_h]h -s/--stop}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hNhNhj hhubh, or }(hj hhhNhNubj1)}(hjqh]h-S/--stop-total}(hj$ hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hNhNhj hhubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKDhj ubh)}(hMultiple --on-threshold actions may be specified, and they will be executed in the order they are provided. If any action fails, subsequent actions in the list will not be executed.h]hMultiple --on-threshold actions may be specified, and they will be executed in the order they are provided. If any action fails, subsequent actions in the list will not be executed.}(hj; hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKGhj ubh)}(hSupported actions are:h]hSupported actions are:}(hjI hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKKhj ubj! )}(hhh](j& )}(h*trace[,file=]* Saves trace output, optionally taking a filename. Alternative to -t/--trace. Note that unlike -t/--trace, specifying this multiple times will result in the trace being saved multiple times. h](h)}(h*trace[,file=]*h]jE)}(hj` h]htrace[,file=]}(hjb hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj^ ubah}(h]h ]h"]h$]h&]uh1hhj%hKMhjZ ubh)}(hSaves trace output, optionally taking a filename. Alternative to -t/--trace. Note that unlike -t/--trace, specifying this multiple times will result in the trace being saved multiple times.h]hSaves trace output, optionally taking a filename. Alternative to -t/--trace. Note that unlike -t/--trace, specifying this multiple times will result in the trace being saved multiple times.}(hju hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKOhjZ ubeh}(h]h ]h"]h$]h&]uh1j% hjW ubj& )}(h*signal,num=,pid=* Sends signal to process. "parent" might be specified in place of pid to target the parent process of rtla. h](h)}(h*signal,num=,pid=*h]jE)}(hj h]hsignal,num=,pid=}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubah}(h]h ]h"]h$]h&]uh1hhj%hKShj ubh)}(hjSends signal to process. "parent" might be specified in place of pid to target the parent process of rtla.h]hnSends signal to process. “parent” might be specified in place of pid to target the parent process of rtla.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKUhj ubeh}(h]h ]h"]h$]h&]uh1j% hjW ubj& )}(h2*shell,command=* Execute shell command. h](h)}(h*shell,command=*h]jE)}(hj h]hshell,command=}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubah}(h]h ]h"]h$]h&]uh1hhj%hKXhj ubh)}(hExecute shell command.h]hExecute shell command.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKZhj ubeh}(h]h ]h"]h$]h&]uh1j% hjW ubj& )}(hM*continue* Continue tracing after actions are executed instead of stopping. h](h)}(h *continue*h]jE)}(hj h]hcontinue}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubah}(h]h ]h"]h$]h&]uh1hhj%hK\hj ubh)}(h@Continue tracing after actions are executed instead of stopping.h]h@Continue tracing after actions are executed instead of stopping.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK^hj ubeh}(h]h ]h"]h$]h&]uh1j% hjW ubeh}(h]h ]h"]h$]h&]j j uh1j hj%hKMhj ubh)}(hExample:h]hExample:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK`hj ubh)}(h$ rtla |tool| |thresharg| 20 --on-threshold trace --on-threshold shell,command="grep ipi_send |tracer|\_trace.txt" --on-threshold signal,num=2,pid=parenth](h$ rtla }(hj*hhhNhNubh osnoise top}(hj*hhhNhNubh }(hj*hhhNhNubh-s}(hj*hhhNhNubhG 20 --on-threshold trace --on-threshold shell,command=”grep ipi_send }(hj*hhhNhNubhosnoise}(hj*hhhNhNubh5_trace.txt” --on-threshold signal,num=2,pid=parent}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKbhj ubh)}(hThis will save a trace with the default filename "|tracer|\_trace.txt", print its lines that contain the text "ipi_send" on standard output, and send signal 2 (SIGINT) to the parent process.h](h4This will save a trace with the default filename “}(hjPhhhNhNubhosnoise}(hjPhhhNhNubh_trace.txt”, print its lines that contain the text “ipi_send” on standard output, and send signal 2 (SIGINT) to the parent process.}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKfhj ubh)}(hPerformance Considerations:h]hPerformance Considerations:}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKjhj ubh)}(h |actionsperf|h]hhDue to implementational limitations, actions might be delayed up to one second after tracing is stopped.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKlhj ubeh}(h]h ]h"]h$]h&]uh1jhj%hKDhj6hhubh)}(h**--on-end** *action*h](j1)}(h **--on-end**h]h--on-end}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*action*h]haction}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhj%hKnhj6hhubj)}(hXDefines an action to be executed at the end of tracing. Multiple --on-end actions can be specified, and they will be executed in the order they are provided. If any action fails, subsequent actions in the list will not be executed. See the documentation for **--on-threshold** for the list of supported actions, with the exception that *continue* has no effect. Example: $ rtla |tool| -d 5s --on-end trace This runs rtla with the default options, and saves trace output at the end. h](h)}(h7Defines an action to be executed at the end of tracing.h]h7Defines an action to be executed at the end of tracing.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKphjubh)}(hMultiple --on-end actions can be specified, and they will be executed in the order they are provided. If any action fails, subsequent actions in the list will not be executed.h]hMultiple --on-end actions can be specified, and they will be executed in the order they are provided. If any action fails, subsequent actions in the list will not be executed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKrhjubh)}(hSee the documentation for **--on-threshold** for the list of supported actions, with the exception that *continue* has no effect.h](hSee the documentation for }(hjhhhNhNubj1)}(h**--on-threshold**h]h--on-threshold}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh< for the list of supported actions, with the exception that }(hjhhhNhNubjE)}(h *continue*h]hcontinue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh has no effect.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hKvhjubh)}(hExample:h]hExample:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKyhjubh)}(h"$ rtla |tool| -d 5s --on-end traceh](h$ rtla }(hjhhhNhNubh osnoise top}(hjhhhNhNubh -d 5s --on-end trace}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj%hK{hjubh)}(hKThis runs rtla with the default options, and saves trace output at the end.h]hKThis runs rtla with the default options, and saves trace output at the end.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hK}hjubeh}(h]h ]h"]h$]h&]uh1jhj%hKphj6hhubh)}(h**-h**, **--help**h](j1)}(h**-h**h]h-h}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubh, }(hj<hhhNhNubj1)}(h **--help**h]h--help}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubeh}(h]h ]h"]h$]h&]uh1hhj%hKhj6hhubj)}(hPrint help menu. h]h)}(hPrint help menu.h]hPrint help menu.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hKhjfubah}(h]h ]h"]h$]h&]uh1jhj%hKhj6hhubeh}(h]optionsah ]h"]optionsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hEXAMPLEh]hEXAMPLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK$ubh)}(hXZIn the example below, the **rtla osnoise top** tool is set to run with a real-time priority *FIFO:1*, on CPUs *0-3*, for *900ms* at each period (*1s* by default). The reason for reducing the runtime is to avoid starving the rtla tool. The tool is also set to run for *one minute* and to display a summary of the report at the end of the session::h](hIn the example below, the }(hjhhhNhNubj1)}(h**rtla osnoise top**h]hrtla osnoise top}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh. tool is set to run with a real-time priority }(hjhhhNhNubjE)}(h*FIFO:1*h]hFIFO:1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh , on CPUs }(hjhhhNhNubjE)}(h*0-3*h]h0-3}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh, for }(hjhhhNhNubjE)}(h*900ms*h]h900ms}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh at each period (}(hjhhhNhNubjE)}(h*1s*h]h1s}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubhv by default). The reason for reducing the runtime is to avoid starving the rtla tool. The tool is also set to run for }(hjhhhNhNubjE)}(h *one minute*h]h one minute}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubhB and to display a summary of the report at the end of the session:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK%hjhhubh literal_block)}(hX\[root@f34 ~]# rtla osnoise top -P F:1 -c 0-3 -r 900000 -d 1M -q Operating System Noise duration: 0 00:01:00 | time is in us CPU Period Runtime Noise % CPU Aval Max Noise Max Single HW NMI IRQ Softirq Thread 0 #59 53100000 304896 99.42580 6978 56 549 0 53111 1590 13 1 #59 53100000 338339 99.36282 8092 24 399 0 53130 1448 31 2 #59 53100000 290842 99.45227 6582 39 855 0 53110 1406 12 3 #59 53100000 204935 99.61405 6251 33 290 0 53156 1460 12h]hX\[root@f34 ~]# rtla osnoise top -P F:1 -c 0-3 -r 900000 -d 1M -q Operating System Noise duration: 0 00:01:00 | time is in us CPU Period Runtime Noise % CPU Aval Max Noise Max Single HW NMI IRQ Softirq Thread 0 #59 53100000 304896 99.42580 6978 56 549 0 53111 1590 13 1 #59 53100000 338339 99.36282 8092 24 399 0 53130 1448 31 2 #59 53100000 290842 99.45227 6582 39 855 0 53110 1406 12 3 #59 53100000 204935 99.61405 6251 33 290 0 53156 1460 12}hjsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jhhhK+hjhhubeh}(h]exampleah ]h"]exampleah$]h&]uh1hhhhhhhhK$ubh)}(hhh](h)}(hSEE ALSOh]hSEE ALSO}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hhhhhK5ubh)}(h/**rtla-osnoise**\(1), **rtla-osnoise-hist**\(1)h](j1)}(h**rtla-osnoise**h]h rtla-osnoise}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubh(1), }(hj<hhhNhNubj1)}(h**rtla-osnoise-hist**h]hrtla-osnoise-hist}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubh(1)}(hj<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK7hj+hhubh)}(h`Osnoise tracer documentation: h](hOsnoise tracer documentation: <}(hjjhhhNhNubj)}(h@https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.htmlh]h@https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html}(hjrhhhNhNubah}(h]h ]h"]h$]h&]refurijtuh1jhjjubh>}(hjjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK9hj+hhubeh}(h]see-alsoah ]h"]see alsoah$]h&]uh1hhhhhhhhK5ubh)}(hhh](h)}(hAUTHORh]hAUTHOR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKh](h'Written by Daniel Bristot de Oliveira <}(hjhhhNhNubj)}(hbristot@kernel.orgh]hbristot@kernel.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurimailto:bristot@kernel.orguh1jhjubh>}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK=hjhhubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hjsbah}(h]h ]h"]h$]h&]j!j"uh1jhjhhh,Documentation/tools/rtla/common_appendix.txthKubeh}(h]authorah ]h"]authorah$]h&]uh1hhhhhhhhK and h](hReport bugs to <}(hjhhhNhNubj)}(hlinux-kernel@vger.kernel.orgh]hlinux-kernel@vger.kernel.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refuri#mailto:linux-kernel@vger.kernel.orguh1jhjubh> and <}(hjhhhNhNubj)}(h!linux-trace-devel@vger.kernel.orgh]h!linux-trace-devel@vger.kernel.org}(hj3hhhNhNubah}(h]h ]h"]h$]h&]refuri(mailto:linux-trace-devel@vger.kernel.orguh1jhjubh>}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjhhubeh}(h]reporting-bugsah ]h"]reporting bugsah$]h&]uh1hhhhhhjhK ubh)}(hhh](h)}(hLICENSEh]hLICENSE}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUhhhjhKubh)}(h6**rtla** is Free Software licensed under the GNU GPLv2h](j1)}(h**rtla**h]hrtla}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjfubh. is Free Software licensed under the GNU GPLv2}(hjfhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjUhhubeh}(h]licenseah ]h"]licenseah$]h&]uh1hhhhhhjhKubh)}(hhh](h)}(hCOPYINGh]hCOPYING}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhjhKubh)}(hwCopyright \(C) 2021 Red Hat, Inc. Free use of this software is granted under the terms of the GNU Public License (GPL).h]hwCopyright (C) 2021 Red Hat, Inc. Free use of this software is granted under the terms of the GNU Public License (GPL).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjhhubeh}(h]copyingah ]h"]copyingah$]h&]uh1hhhhhhjhKubeh}(h]/display-a-summary-of-the-operating-system-noiseah ]h"]/display a summary of the operating system noiseah$]h&]uh1hhhhhhhhKubeh}(h]rtla-osnoise-topah ]h"]rtla-osnoise-topah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}(hhjjGjjjjjjusubstitution_names}(toolh thresholdj threshargjtracerj actionsperfjurefnames}refids}nameids}(jjjjjcj`j3j0jjj(j%jjjjjjjRjOjjjju nametypes}(jjjcj3jj(jjjjRjjuh}(jhjhj`jj0jfjj6j%jjj+jjjjjOjjjUjju footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log]-Documentation/tools/rtla/rtla-osnoise-top.rst(NNNNta decorationNhhub.