xref: /linux/tools/tracing/rtla/README.txt (revision 5ea5880764cbb164afb17a62e76ca75dc371409d)
1RTLA: Real-Time Linux Analysis tools
2
3The rtla meta-tool includes a set of commands that aims to analyze
4the real-time properties of Linux. Instead of testing Linux as a black box,
5rtla leverages kernel tracing capabilities to provide precise information
6about the properties and root causes of unexpected results.
7
8Installing RTLA
9
10RTLA depends on the following libraries and tools:
11
12 - libtracefs
13 - libtraceevent
14 - libcpupower (optional, for --deepest-idle-state)
15 - libcheck (optional, for unit tests)
16
17For BPF sample collection support, the following extra dependencies are
18required:
19
20 - libbpf 1.0.0 or later
21 - bpftool with skeleton support
22 - clang with BPF CO-RE support
23
24It also depends on python3-docutils to compile man pages.
25
26For development, we suggest the following steps for compiling rtla:
27
28  $ git clone git://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git
29  $ cd libtraceevent/
30  $ make
31  $ sudo make install
32  $ cd ..
33  $ git clone git://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git
34  $ cd libtracefs/
35  $ make
36  $ sudo make install
37  $ cd ..
38  $ cd $libcpupower_src
39  $ make
40  $ sudo make install
41  $ cd $rtla_src
42  $ make
43  $ sudo make install
44
45For further information, please refer to the rtla man page.
46