common_options.rst 1.9 KB

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