common_options.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. **-c**, **--cpus** *cpu-list*
  2. Set the osnoise tracer to run the sample threads in the cpu-list.
  3. **-H**, **--house-keeping** *cpu-list*
  4. Run rtla control threads only on the given cpu-list.
  5. **-d**, **--duration** *time[s|m|h|d]*
  6. Set the duration of the session.
  7. **-D**, **--debug**
  8. Print debug info.
  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. **-C**, **--cgroup**\[*=cgroup*]
  27. 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.
  28. **--warm-up** *s*
  29. After 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.
  30. **--trace-buffer-size** *kB*
  31. Set the per-cpu trace buffer size in kB for the tracing output.
  32. **-h**, **--help**
  33. Print help menu.