[PATCH 5/5] rtla: Documentation: Add --disable-idle-states

From: tglozar
Date: Wed Jun 12 2024 - 10:57:11 EST


From: Tomas Glozar <tglozar@xxxxxxxxxx>

Add --disable-idle-states to manpage and mention libcpupower dependency
in README.txt.

Signed-off-by: Tomas Glozar <tglozar@xxxxxxxxxx>
---
Documentation/tools/rtla/common_timerlat_options.rst | 6 ++++++
tools/tracing/rtla/README.txt | 4 ++++
2 files changed, 10 insertions(+)

diff --git a/Documentation/tools/rtla/common_timerlat_options.rst b/Documentation/tools/rtla/common_timerlat_options.rst
index cef6651f1435..7429e77f95ca 100644
--- a/Documentation/tools/rtla/common_timerlat_options.rst
+++ b/Documentation/tools/rtla/common_timerlat_options.rst
@@ -31,6 +31,12 @@
*cyclictest* sets this value to *0* by default, use **--dma-latency** *0* to have
similar results.

+**--disable-idle-states**
+ Set the /sys/devices/system/cpu/cpu<n>/cpuidle/state*/disable files to 1 for cpus
+ that are running timerlat threads to avoid exit from idle latencies. On exit from
+ timerlat, the state*/disable setting is restored to its original value before
+ running timerlat.
+
**-k**, **--kernel-threads**

Use timerlat kernel-space threads, in contrast of **-u**.
diff --git a/tools/tracing/rtla/README.txt b/tools/tracing/rtla/README.txt
index 4af3fd40f171..6617b9911c81 100644
--- a/tools/tracing/rtla/README.txt
+++ b/tools/tracing/rtla/README.txt
@@ -11,6 +11,7 @@ RTLA depends on the following libraries and tools:

- libtracefs
- libtraceevent
+ - libcpupower

It also depends on python3-docutils to compile man pages.

@@ -26,6 +27,9 @@ For development, we suggest the following steps for compiling rtla:
$ make
$ sudo make install
$ cd ..
+ $ cd $libcpupower_src
+ $ make
+ $ sudo make install
$ cd $rtla_src
$ make
$ sudo make install
--
2.43.0