>sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget0/translations/zh_CN/tools/rtla/rtla-osnoise-histmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget0/translations/zh_TW/tools/rtla/rtla-osnoise-histmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget0/translations/it_IT/tools/rtla/rtla-osnoise-histmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget0/translations/ja_JP/tools/rtla/rtla-osnoise-histmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget0/translations/ko_KR/tools/rtla/rtla-osnoise-histmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget0/translations/sp_SP/tools/rtla/rtla-osnoise-histmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsubstitution_definition)}(h!.. |tool| replace:: osnoise hist h]h osnoise hist}hhsbah}(h]h ]h"]toolah$]h&]uh1hhJ/var/lib/git/docbuild/linux/Documentation/tools/rtla/rtla-osnoise-hist.rsthKhhhhubhsection)}(hhh](htitle)}(hrtla-osnoise-histh]hrtla-osnoise-hist}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h1Display a histogram of the osnoise tracer samplesh]h1Display a histogram of the osnoise tracer samples}(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 hist** [*OPTIONS*]h](hstrong)}(h**rtla osnoise hist**h]hrtla osnoise hist}(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)}(hThe **rtla osnoise hist** tool collects all **osnoise:sample_threshold** occurrence in a histogram, displaying the results in a user-friendly way. The tool also allows many configurations of the *osnoise* tracer and the collection of the tracer output.h](hThe }(hjhhhNhNubj1)}(h**rtla osnoise hist**h]hrtla osnoise hist}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh tool collects all }(hjhhhNhNubj1)}(h**osnoise:sample_threshold**h]hosnoise:sample_threshold}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh{ occurrence in a histogram, displaying the results in a user-friendly way. The tool also allows many configurations of the }(hjhhhNhNubjE)}(h *osnoise*h]hosnoise}(hj hhhNhNubah}(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}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hhhhhKubh)}(hN.. |threshold| replace:: **-a/--auto**, **-s/--stop**, or **-S/--stop-total**h](j1)}(h **-a/--auto**h]h -a/--auto}hjAsbah}(h]h ]h"]h$]h&]uh1j0hj=ubh, }hj=sbj1)}(h **-s/--stop**h]h -s/--stop}hjSsbah}(h]h ]h"]h$]h&]uh1j0hj=ubh, or }hj=sbj1)}(h**-S/--stop-total**h]h-S/--stop-total}hjesbah}(h]h ]h"]h$]h&]uh1j0hj=ubeh}(h]h ]h"] thresholdah$]h&]uh1hh3Documentation/tools/rtla/common_osnoise_options.txthKhj,hhubh)}(h.. |thresharg| replace:: -sh]h-s}hj{sbah}(h]h ]h"] threshargah$]h&]uh1hhjzhKhj,hhubh)}(h".. |tracer| replace:: osnoise h]hosnoise}hjsbah}(h]h ]h"]tracerah$]h&]uh1hhjzhKhj,hhubh)}(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&]uh1hhjzhKhj,hhubh)}(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&]uh1hhjzhK hj,hhubh 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}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhK hjubah}(h]h ]h"]h$]h&]uh1jhjzhK hj,hhubh)}(h**-p**, **--period** *us*h](j1)}(h**-p**h]h-p}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj4ubh, }(hj4hhhNhNubj1)}(h **--period**h]h--period}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj4ubh }(hj4hhhNhNubjE)}(h*us*h]hus}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj4ubeh}(h]h ]h"]h$]h&]uh1hhjzhKhj,hhubj)}(h1Set the *osnoise* tracer period in microseconds. h]h)}(h0Set the *osnoise* tracer period in microseconds.h](hSet the }(hjthhhNhNubjE)}(h *osnoise*h]hosnoise}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjtubh tracer period in microseconds.}(hjthhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhKhjpubah}(h]h ]h"]h$]h&]uh1jhjzhKhj,hhubh)}(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&]uh1hhjzhKhj,hhubj)}(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&]uh1hhjzhKhjubah}(h]h ]h"]h$]h&]uh1jhjzhKhj,hhubh)}(h**-s**, **--stop** *us*h](j1)}(h**-s**h]h-s}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--stop**h]h--stop}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*us*h]hus}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhjzhKhj,hhubj)}(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 }(hj@hhhNhNubj1)}(h**-T**h]h-T}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj@ubh3 is set, it will also save the trace to the output.}(hj@hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhKhj<ubah}(h]h ]h"]h$]h&]uh1jhjzhKhj,hhubh)}(h**-S**, **--stop-total** *us*h](j1)}(h**-S**h]h-S}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjfubh, }(hjfhhhNhNubj1)}(h**--stop-total**h]h --stop-total}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjfubh }(hjfhhhNhNubjE)}(h*us*h]hus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjfubeh}(h]h ]h"]h$]h&]uh1hhjzhKhj,hhubj)}(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&]uh1hhjzhKhjubah}(h]h ]h"]h$]h&]uh1jhjzhKhj,hhubh)}(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&]uh1hhjzhK hj,hhubj)}(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 }(hj hhhNhNubjE)}(h*5 us*h]h5 us}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhK"hjubah}(h]h ]h"]h$]h&]uh1jhjzhK"hj,hhubh)}(h**-t**, **--trace** \[*file*]h](j1)}(h**-t**h]h-t}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj2ubh, }(hj2hhhNhNubj1)}(h **--trace**h]h--trace}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj2ubh [}(hj2hhhNhNubjE)}(h*file*h]hfile}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj2ubh]}(hj2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhK%hj,hhubj)}(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 [}(hjvhhhNhNubjE)}(h*file|osnoise_trace.txt*h]hfile|osnoise_trace.txt}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjvubh].}(hjvhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjzhK'hjrubah}(h]h ]h"]h$]h&]uh1jhjzhK'hj,hhubh)}(h**-b**, **--bucket-size** *N*h](j1)}(h**-b**h]h-b}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h**--bucket-size**h]h --bucket-size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*N*h]hN}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hh0Documentation/tools/rtla/common_hist_options.txthKhj,hhubj)}(h-Set the histogram bucket size (default *1*). h]h)}(h,Set the histogram bucket size (default *1*).h](h'Set the histogram bucket size (default }(hjhhhNhNubjE)}(h*1*h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj,hhubh)}(h**-E**, **--entries** *N*h](j1)}(h**-E**h]h-E}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h **--entries**h]h --entries}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h*N*h]hN}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hhjhKhj,hhubj)}(h:Set the number of entries of the histogram (default 256). h]h)}(h9Set the number of entries of the histogram (default 256).h]h9Set the number of entries of the histogram (default 256).}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhj?ubah}(h]h ]h"]h$]h&]uh1jhjhKhj,hhubh)}(h**--no-header**h]j1)}(hjYh]h --no-header}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjWubah}(h]h ]h"]h$]h&]uh1hhjhK hj,hhubj)}(hDo not print header. h]h)}(hDo not print header.h]hDo not print header.}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK hjnubah}(h]h ]h"]h$]h&]uh1jhjhK hj,hhubh)}(h**--no-summary**h]j1)}(hjh]h --no-summary}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubah}(h]h ]h"]h$]h&]uh1hhjhK hj,hhubj)}(hDo not print summary. h]h)}(hDo not print summary.h]hDo not print summary.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj,hhubh)}(h**--no-index**h]j1)}(hjh]h --no-index}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubah}(h]h ]h"]h$]h&]uh1hhjhKhj,hhubj)}(hDo not print index. h]h)}(hDo not print index.h]hDo not print index.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj,hhubh)}(h**--with-zeros**h]j1)}(hjh]h --with-zeros}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubah}(h]h ]h"]h$]h&]uh1hhjhKhj,hhubj)}(hPrint zero only entries. h]h)}(hPrint zero only entries.h]hPrint zero only entries.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjhKhj,hhubh)}(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}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh }(hjhhhNhNubjE)}(h *cpu-list*h]hcpu-list}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubeh}(h]h ]h"]h$]h&]uh1hh+Documentation/tools/rtla/common_options.txthKhj,hhubj)}(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 }(hjThhhNhNubh osnoise hist}(hjThhhNhNubh2 tracer to run the sample threads in the cpu-list.}(hjThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKhjPubh)}(hBBy default, the |tool| tracer runs the sample threads on all CPUs.h](hBy default, the }(hjjhhhNhNubh osnoise hist}(hjjhhhNhNubh, tracer runs the sample threads on all CPUs.}(hjjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKhjPubeh}(h]h ]h"]h$]h&]uh1jhjOhKhj,hhubh)}(h&**-H**, **--house-keeping** *cpu-list*h](j1)}(h**-H**h]h-H}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh, }(hjhhhNhNubj1)}(h**--house-keeping**h]h--house-keeping}(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&]uh1hhjOhKhj,hhubj)}(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&]uh1hhjOhK 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&]uh1hhjOhK hjubeh}(h]h ]h"]h$]h&]uh1jhjOhK hj,hhubh)}(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&]uh1hhjOhK hj,hhubj)}(h!Set the duration of the session. h]h)}(h Set the duration of the session.h]h Set the duration of the session.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKhj$ubah}(h]h ]h"]h$]h&]uh1jhjOhKhj,hhubh)}(h**-D**, **--debug**h](j1)}(h**-D**h]h-D}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubh, }(hj<hhhNhNubj1)}(h **--debug**h]h--debug}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj<ubeh}(h]h ]h"]h$]h&]uh1hhjOhKhj,hhubj)}(hPrint debug info. h]h)}(hPrint debug info.h]hPrint debug info.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKhjfubah}(h]h ]h"]h$]h&]uh1jhjOhKhj,hhubh)}(h**-e**, **--event** *sys:event*h](j1)}(h**-e**h]h-e}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj~ubh, }(hj~hhhNhNubj1)}(h **--event**h]h--event}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj~ubh }(hj~hhhNhNubjE)}(h *sys:event*h]h sys:event}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj~ubeh}(h]h ]h"]h$]h&]uh1hhjOhKhj,hhubj)}(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}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh . Multiple }(hjhhhNhNubj1)}(h**-e**h]h-e}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh% are allowed. It is only active when }(hjhhhNhNubj1)}(h**-t**h]h-t}(hj2 hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh or }(hjhhhNhNubj1)}(h**-a**h]h-a}(hjD hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh are set.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKhjubah}(h]h ]h"]h$]h&]uh1jhjOhKhj,hhubh)}(h**--filter** **h](j1)}(h **--filter**h]h--filter}(hjf hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjb ubh }(hjb hhhNhNubjE)}(h **h]h}(hjx hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjb ubeh}(h]h ]h"]h$]h&]uh1hhjOhKhj,hhubj)}(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 }(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 event with }(hj hhhNhNubjE)}(h **h]h}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh4. For further information about event filtering see }(hj hhhNhNubh 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}(hj hhhNhNubah}(h]h ]h"]h$]h&]refurij uh1j hj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKhj ubah}(h]h ]h"]h$]h&]uh1jhjOhKhj,hhubhdefinition_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}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h **h]h }(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubeh}(h]h ]h"]h$]h&]uh1j hjOhK&hj ubh 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}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj+ ubh }(hj+ hhhNhNubjE)}(h *sys:event*h]h sys:event}(hjE hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj+ ubh . If the }(hj+ hhhNhNubjE)}(h*hist:*h]hhist:}(hjW 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}(hji hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj+ ubh. For example, the command:}(hj+ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKhj( ubh)}(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”}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhK"hj( ubh)}(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 }(hj hhhNhNubjE)}(h*osnoise:irq_noise*h]hosnoise:irq_noise}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh event in }(hj hhhNhNubjE)}(h*osnoise_irq_noise_hist.txt*h]hosnoise_irq_noise_hist.txt}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK$hj( ubh)}(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 uh1j hj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK&hj( ubeh}(h]h ]h"]h$]h&]uh1j& hj ubeh}(h]h ]h"]h$]h&]uh1j hjOhK&hj ubah}(h]h ]h"]h$]h&]uh1j hj,hhhjOhNubh)}(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&]uh1hhjOhK(hj,hhubj)}(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 }(hj4 hhhNhNubh osnoise hist}(hj4 hhhNhNubh4 tracer threads, the format to set the priority are:}(hj4 hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK*hj0 ubh bullet_list)}(hhh](h list_item)}(h'*o:prio* - use SCHED_OTHER with *prio*;h]h)}(hjS h](jE)}(h*o:prio*h]ho:prio}(hjX hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjU ubh - use SCHED_OTHER with }(hjU hhhNhNubjE)}(h*prio*h]hprio}(hjj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjU ubh;}(hjU hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK,hjQ ubah}(h]h ]h"]h$]h&]uh1jO hjL ubjP )}(h$*r:prio* - use SCHED_RR with *prio*;h]h)}(hj h](jE)}(h*r:prio*h]hr:prio}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh - use SCHED_RR with }(hj hhhNhNubjE)}(h*prio*h]hprio}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh;}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK-hj ubah}(h]h ]h"]h$]h&]uh1jO hjL ubjP )}(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&]uh1hhjOhK.hj ubah}(h]h ]h"]h$]h&]uh1jO hjL ubjP )}(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&]uh1hhjOhK/hj ubah}(h]h ]h"]h$]h&]uh1jO hjL ubeh}(h]h ]h"]h$]h&]bullet-uh1jJ hjOhK,hj0 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 }(hjH hhhNhNubjE)}(h *osnoise*h]hosnoise}(hjP hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjH ubh and }(hjH hhhNhNubjE)}(h *timerlat*h]htimerlat}(hjb hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjH ubh5 tracer documentation for the running kernel version.}(hjH hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK1hj0 ubeh}(h]h ]h"]h$]h&]uh1jhjOhK*hj,hhubh)}(h **-C**, **--cgroup** \[*cgroup*]h](j1)}(h**-C**h]h-C}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh, }(hj hhhNhNubj1)}(h **--cgroup**h]h--cgroup}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh [}(hj hhhNhNubjE)}(h*cgroup*h]hcgroup}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubh]}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK3hj,hhubj)}(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&]uh1hhjOhK5hj 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&]uh1hhjOhK7hj ubeh}(h]h ]h"]h$]h&]uh1jhjOhK5hj,hhubh)}(h**--warm-up** *s*h](j1)}(h **--warm-up**h]h --warm-up}(hjD hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj@ ubh }(hj@ hhhNhNubjE)}(h*s*h]hs}(hjV hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj@ ubeh}(h]h ]h"]h$]h&]uh1hhjOhK9hj,hhubj)}(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 }(hjn hhhNhNubjE)}(h*s*h]hs}(hjv hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjn ubh seconds before starting collecting the data, allowing the system to warm-up. Statistical data generated during warm-up is discarded.}(hjn hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK;hjj ubah}(h]h ]h"]h$]h&]uh1jhjOhK;hj,hhubj )}(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}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hj ubh }(hj hhhNhNubjE)}(h*kB*h]hkB}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhj ubeh}(h]h ]h"]h$]h&]uh1j hjOhK@hj 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&]uh1hhjOhK>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&]uh1hhjOhK@hj ubeh}(h]h ]h"]h$]h&]uh1j& hj ubeh}(h]h ]h"]h$]h&]uh1j hjOhK@hj ubah}(h]h ]h"]h$]h&]uh1j hj,hhhjOhNubh)}(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&]uh1hhjOhKBhj,hhubj)}(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)}(hjCh]h -a/--auto}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hNhNhj$hhubh, }(hj$hhhNhNubj1)}(hjUh]h -s/--stop}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hNhNhj$hhubh, or }(hj$hhhNhNubj1)}(hjgh]h-S/--stop-total}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hNhNhj$hhubh.}(hj$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKDhj 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.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKGhj ubh)}(hSupported actions are:h]hSupported actions are:}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKKhj ubjK )}(hhh](jP )}(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)}(hjh]htrace[,file=]}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1hhjOhKMhjubh)}(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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKOhjubeh}(h]h ]h"]h$]h&]uh1jO hjubjP )}(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)}(hjh]hsignal,num=,pid=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1hhjOhKShjubh)}(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.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKUhjubeh}(h]h ]h"]h$]h&]uh1jO hjubjP )}(h2*shell,command=* Execute shell command. h](h)}(h*shell,command=*h]jE)}(hjh]hshell,command=}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1hhjOhKXhjubh)}(hExecute shell command.h]hExecute shell command.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKZhjubeh}(h]h ]h"]h$]h&]uh1jO hjubjP )}(hM*continue* Continue tracing after actions are executed instead of stopping. h](h)}(h *continue*h]jE)}(hjh]hcontinue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1hhjOhK\hjubh)}(h@Continue tracing after actions are executed instead of stopping.h]h@Continue tracing after actions are executed instead of stopping.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhK^hjubeh}(h]h ]h"]h$]h&]uh1jO hjubeh}(h]h ]h"]h$]h&]jF jG uh1jJ hjOhKMhj ubh)}(hExample:h]hExample:}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhK`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 }(hjThhhNhNubh osnoise hist}(hjThhhNhNubh }(hjThhhNhNubh-s}(hjThhhNhNubhG 20 --on-threshold trace --on-threshold shell,command=”grep ipi_send }(hjThhhNhNubhosnoise}(hjThhhNhNubh5_trace.txt” --on-threshold signal,num=2,pid=parent}(hjThhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKbhj 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 “}(hjzhhhNhNubhosnoise}(hjzhhhNhNubh_trace.txt”, print its lines that contain the text “ipi_send” on standard output, and send signal 2 (SIGINT) to the parent process.}(hjzhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhKfhj ubh)}(hPerformance Considerations:h]hPerformance Considerations:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKjhj ubh)}(h |actionsperf|h]hhDue to implementational limitations, actions might be delayed up to one second after tracing is stopped.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKlhj ubeh}(h]h ]h"]h$]h&]uh1jhjOhKDhj,hhubh)}(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&]uh1hhjOhKnhj,hhubj)}(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&]uh1hhjOhKphjubh)}(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&]uh1hhjOhKrhjubh)}(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&]uh1hhjOhKvhjubh)}(hExample:h]hExample:}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKyhjubh)}(h"$ rtla |tool| -d 5s --on-end traceh](h$ rtla }(hj<hhhNhNubh osnoise hist}(hj<hhhNhNubh -d 5s --on-end trace}(hj<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjOhK{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.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhK}hjubeh}(h]h ]h"]h$]h&]uh1jhjOhKphj,hhubh)}(h**-h**, **--help**h](j1)}(h**-h**h]h-h}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjfubh, }(hjfhhhNhNubj1)}(h **--help**h]h--help}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjfubeh}(h]h ]h"]h$]h&]uh1hhjOhKhj,hhubj)}(hPrint help menu. h]h)}(hPrint help menu.h]hPrint help menu.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhKhjubah}(h]h ]h"]h$]h&]uh1jhjOhKhj,hhubeh}(h]optionsah ]h"]optionsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hEXAMPLEh]hEXAMPLE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK"ubh)}(hXlIn the example below, *osnoise* tracer threads are set to run with real-time priority *FIFO:1*, on CPUs *0-11*, 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*. The output histogram is set to group outputs in buckets of *10us* and *25* entries::h](hIn the example below, }(hjhhhNhNubjE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh7 tracer threads are set to run with real-time priority }(hjhhhNhNubjE)}(h*FIFO:1*h]hFIFO:1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh , on CPUs }(hjhhhNhNubjE)}(h*0-11*h]h0-11}(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&]uh1jDhjubhK by default). The reason for reducing the runtime is to avoid starving the }(hjhhhNhNubj1)}(h**rtla**h]hrtla}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh' tool. The tool is also set to run for }(hjhhhNhNubjE)}(h *one minute*h]h one minute}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh=. The output histogram is set to group outputs in buckets of }(hjhhhNhNubjE)}(h*10us*h]h10us}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh and }(hjhhhNhNubjE)}(h*25*h]h25}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh entries:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK#hjhhubh literal_block)}(hX[root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -E 25 # RTLA osnoise histogram # Time unit is microseconds (us) # Duration: 0 00:01:00 Index CPU-000 CPU-001 CPU-002 CPU-003 CPU-004 CPU-005 CPU-006 CPU-007 CPU-008 CPU-009 CPU-010 CPU-011 0 42982 46287 51779 53740 52024 44817 49898 36500 50408 50128 49523 52377 10 12224 8356 2912 878 2667 10155 4573 18894 4214 4836 5708 2413 20 8 5 12 2 13 24 20 41 29 53 39 39 30 1 1 0 0 10 3 6 19 15 31 30 38 40 0 0 0 0 0 4 2 7 2 3 8 11 50 0 0 0 0 0 0 0 0 0 1 1 2 over: 0 0 0 0 0 0 0 0 0 0 0 0 count: 55215 54649 54703 54620 54714 55003 54499 55461 54668 55052 55309 54880 min: 0 0 0 0 0 0 0 0 0 0 0 0 avg: 0 0 0 0 0 0 0 0 0 0 0 0 max: 30 30 20 20 30 40 40 40 40 50 50 50h]hX[root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -E 25 # RTLA osnoise histogram # Time unit is microseconds (us) # Duration: 0 00:01:00 Index CPU-000 CPU-001 CPU-002 CPU-003 CPU-004 CPU-005 CPU-006 CPU-007 CPU-008 CPU-009 CPU-010 CPU-011 0 42982 46287 51779 53740 52024 44817 49898 36500 50408 50128 49523 52377 10 12224 8356 2912 878 2667 10155 4573 18894 4214 4836 5708 2413 20 8 5 12 2 13 24 20 41 29 53 39 39 30 1 1 0 0 10 3 6 19 15 31 30 38 40 0 0 0 0 0 4 2 7 2 3 8 11 50 0 0 0 0 0 0 0 0 0 1 1 2 over: 0 0 0 0 0 0 0 0 0 0 0 0 count: 55215 54649 54703 54620 54714 55003 54499 55461 54668 55052 55309 54880 min: 0 0 0 0 0 0 0 0 0 0 0 0 avg: 0 0 0 0 0 0 0 0 0 0 0 0 max: 30 30 20 20 30 40 40 40 40 50 50 50}hjssbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jqhhhK)hjhhubeh}(h]exampleah ]h"]exampleah$]h&]uh1hhhhhhhhK"ubh)}(hhh](h)}(hSEE ALSOh]hSEE ALSO}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK;ubh)}(h.**rtla-osnoise**\(1), **rtla-osnoise-top**\(1)h](j1)}(h**rtla-osnoise**h]h rtla-osnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh(1), }(hjhhhNhNubj1)}(h**rtla-osnoise-top**h]hrtla-osnoise-top}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh(1)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKh](jE)}(h *osnoise*h]hosnoise}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jDhjubh tracer documentation: <}(hjhhhNhNubj )}(h@https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.htmlh]h@https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1j hjubh>}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK>hjhhubeh}(h]see-alsoah ]h"]see alsoah$]h&]uh1hhhhhhhhK;ubh)}(hhh](h)}(hAUTHORh]hAUTHOR}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKAubh)}(h:Written by Daniel Bristot de Oliveira h](h'Written by Daniel Bristot de Oliveira <}(hjhhhNhNubj )}(hbristot@kernel.orgh]hbristot@kernel.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurimailto:bristot@kernel.orguh1j hjubh>}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKBhjhhubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hj6sbah}(h]h ]h"]h$]h&]jjuh1j4hjhhh,Documentation/tools/rtla/common_appendix.txthKubeh}(h]authorah ]h"]authorah$]h&]uh1hhhhhhhhKAubh)}(hhh](h)}(h EXIT STATUSh]h EXIT STATUS}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjMhhhjDhKubjr)}(h0 Passed: the test did not hit the stop tracing condition 1 Error: invalid argument 2 Failed: the test hit the stop tracing conditionh]h0 Passed: the test did not hit the stop tracing condition 1 Error: invalid argument 2 Failed: the test hit the stop tracing condition}hj^sbah}(h]h ]h"]h$]h&]jjuh1jqhjDhKhjMhhubeh}(h] exit-statusah ]h"] exit statusah$]h&]uh1hhhhhhjDhKubh)}(hhh](h)}(hREPORTING BUGSh]hREPORTING BUGS}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjthhhjDhK ubh)}(hUReport bugs to 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.orguh1j hjubh> and <}(hjhhhNhNubj )}(h!linux-trace-devel@vger.kernel.orgh]h!linux-trace-devel@vger.kernel.org}(hjhhhNhNubah}(h]h ]h"]h$]h&]refuri(mailto:linux-trace-devel@vger.kernel.orguh1j hjubh>}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjDhKhjthhubeh}(h]reporting-bugsah ]h"]reporting bugsah$]h&]uh1hhhhhhjDhK ubh)}(hhh](h)}(hLICENSEh]hLICENSE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhjDhKubh)}(h6**rtla** is Free Software licensed under the GNU GPLv2h](j1)}(h**rtla**h]hrtla}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j0hjubh. is Free Software licensed under the GNU GPLv2}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjDhKhjhhubeh}(h]licenseah ]h"]licenseah$]h&]uh1hhhhhhjDhKubh)}(hhh](h)}(hCOPYINGh]hCOPYING}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhjDhKubh)}(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).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhKhjhhubeh}(h]copyingah ]h"]copyingah$]h&]uh1hhhhhhjDhKubeh}(h]1display-a-histogram-of-the-osnoise-tracer-samplesah ]h"]1display a histogram of the osnoise tracer samplesah$]h&]uh1hhhhhhhhKubeh}(h]rtla-osnoise-histah ]h"]rtla-osnoise-histah$]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_handlerjRerror_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}(hhjwj=jj{jjjjusubstitution_names}(toolh thresholdjw threshargjtracerj actionsperfjurefnames}refids}nameids}(j,j)j$j!jcj`j)j&jjjjjjjJjGjqjnjjjjjju nametypes}(j,j$jcj)jjjjJjqjjjuh}(j)hj!hj`jj&jfjj,jjjjjGjjnjMjjtjjjju 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-hist.rst(NNNNta decorationNhhub.