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