GNU Linux-libre 6.1.90-gnu
[releases.git] / Documentation / tools / rtla / common_options.rst
1 **-c**, **--cpus** *cpu-list*
2
3         Set the osnoise tracer to run the sample threads in the cpu-list.
4
5 **-d**, **--duration** *time[s|m|h|d]*
6
7         Set the duration of the session.
8
9 **-D**, **--debug**
10
11         Print debug info.
12
13 **-t**, **--trace**\[*=file*]
14
15         Save the stopped trace to [*file|osnoise_trace.txt*].
16
17 **-e**, **--event** *sys:event*
18
19         Enable 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.
20
21 **--filter** *<filter>*
22
23         Filter the previous **-e** *sys:event* event with *<filter>*. For further information about event filtering see https://www.kernel.org/doc/html/latest/trace/events.html#event-filtering.
24
25 **--trigger** *<trigger>*
26         Enable a trace event trigger to the previous **-e** *sys:event*.
27         If the *hist:* trigger is activated, the output histogram will be automatically saved to a file named *system_event_hist.txt*.
28         For example, the command:
29
30         rtla <command> <mode> -t -e osnoise:irq_noise --trigger="hist:key=desc,duration/1000:sort=desc,duration/1000:vals=hitcount"
31
32         Will automatically save the content of the histogram associated to *osnoise:irq_noise* event in *osnoise_irq_noise_hist.txt*.
33
34         For further information about event trigger see https://www.kernel.org/doc/html/latest/trace/events.html#event-triggers.
35
36 **-P**, **--priority** *o:prio|r:prio|f:prio|d:runtime:period*
37
38         Set scheduling parameters to the osnoise tracer threads, the format to set the priority are:
39
40         - *o:prio* - use SCHED_OTHER with *prio*;
41         - *r:prio* - use SCHED_RR with *prio*;
42         - *f:prio* - use SCHED_FIFO with *prio*;
43         - *d:runtime[us|ms|s]:period[us|ms|s]* - use SCHED_DEADLINE with *runtime* and *period* in nanoseconds.
44
45 **-h**, **--help**
46
47         Print help menu.