xref: /aosp_15_r20/external/trace-cmd/README (revision 58e6ee5f017f6a8912852c892d18457e4bafb554)
1*58e6ee5fSAndroid Build Coastguard Worker
2*58e6ee5fSAndroid Build Coastguard Worker
3*58e6ee5fSAndroid Build Coastguard Worker  For more information on contributing please see: https://www.trace-cmd.org
4*58e6ee5fSAndroid Build Coastguard Worker
5*58e6ee5fSAndroid Build Coastguard WorkerNote: The official repositiory for trace-cmd and KernelShark is here:
6*58e6ee5fSAndroid Build Coastguard Worker
7*58e6ee5fSAndroid Build Coastguard Worker git://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git
8*58e6ee5fSAndroid Build Coastguard Worker
9*58e6ee5fSAndroid Build Coastguard WorkerFor bug reports and issues, please file it here:
10*58e6ee5fSAndroid Build Coastguard Worker
11*58e6ee5fSAndroid Build Coastguard Worker https://bugzilla.kernel.org/buglist.cgi?component=Trace-cmd%2FKernelshark&product=Tools&resolution=---
12*58e6ee5fSAndroid Build Coastguard Worker
13*58e6ee5fSAndroid Build Coastguard WorkerThese files make up the code that create the trace-cmd programs.
14*58e6ee5fSAndroid Build Coastguard WorkerThis includes the GUI interface application kernelshark as well
15*58e6ee5fSAndroid Build Coastguard Workeras trace-graph and trace-view.
16*58e6ee5fSAndroid Build Coastguard Worker
17*58e6ee5fSAndroid Build Coastguard WorkerThese files also make up the code to create the libtracecmd library.
18*58e6ee5fSAndroid Build Coastguard Worker
19*58e6ee5fSAndroid Build Coastguard WorkerThe applications are licensed under the GNU General Public License 2.0
20*58e6ee5fSAndroid Build Coastguard Worker(see COPYING) and the libraries are licensed under the GNU
21*58e6ee5fSAndroid Build Coastguard WorkerLesser General Public License 2.1 (See COPYING.LIB).
22*58e6ee5fSAndroid Build Coastguard Worker
23*58e6ee5fSAndroid Build Coastguard WorkerBUILDING:
24*58e6ee5fSAndroid Build Coastguard Worker
25*58e6ee5fSAndroid Build Coastguard WorkerIn order to install build dependencies on Debian / Ubuntu do the following:
26*58e6ee5fSAndroid Build Coastguard Worker    sudo apt-get install build-essential git pkg-config -y
27*58e6ee5fSAndroid Build Coastguard Worker    sudo apt-get install libtracefs-dev libtraceevent-dev -y
28*58e6ee5fSAndroid Build Coastguard Worker
29*58e6ee5fSAndroid Build Coastguard WorkerIn order to install build dependencies on Fedora, as root do the following:
30*58e6ee5fSAndroid Build Coastguard Worker    dnf install gcc make git pkg-config -y
31*58e6ee5fSAndroid Build Coastguard Worker    dnf install libtracefs-devel libtraceevent-devel -y
32*58e6ee5fSAndroid Build Coastguard Worker
33*58e6ee5fSAndroid Build Coastguard WorkerIn case your distribution does not have the required libtracefs and
34*58e6ee5fSAndroid Build Coastguard Workerlibtraceevent libraries, build and install them manually:
35*58e6ee5fSAndroid Build Coastguard Worker
36*58e6ee5fSAndroid Build Coastguard Worker    git clone https://git.kernel.org/pub/scm/libs/libtrace/libtraceevent.git/
37*58e6ee5fSAndroid Build Coastguard Worker    cd libtraceevent
38*58e6ee5fSAndroid Build Coastguard Worker    make
39*58e6ee5fSAndroid Build Coastguard Worker    sudo make install
40*58e6ee5fSAndroid Build Coastguard Worker
41*58e6ee5fSAndroid Build Coastguard Worker    git clone https://git.kernel.org/pub/scm/libs/libtrace/libtracefs.git/
42*58e6ee5fSAndroid Build Coastguard Worker    cd libtracefs
43*58e6ee5fSAndroid Build Coastguard Worker    make
44*58e6ee5fSAndroid Build Coastguard Worker    sudo make install
45*58e6ee5fSAndroid Build Coastguard Worker
46*58e6ee5fSAndroid Build Coastguard WorkerTo make trace-cmd
47*58e6ee5fSAndroid Build Coastguard Worker    make
48*58e6ee5fSAndroid Build Coastguard Worker
49*58e6ee5fSAndroid Build Coastguard WorkerTo make the gui
50*58e6ee5fSAndroid Build Coastguard Worker    make gui
51*58e6ee5fSAndroid Build Coastguard Worker
52*58e6ee5fSAndroid Build Coastguard WorkerINSTALL:
53*58e6ee5fSAndroid Build Coastguard Worker
54*58e6ee5fSAndroid Build Coastguard WorkerTo install trace-cmd
55*58e6ee5fSAndroid Build Coastguard Worker    make install
56*58e6ee5fSAndroid Build Coastguard Worker
57*58e6ee5fSAndroid Build Coastguard WorkerTo install the gui
58*58e6ee5fSAndroid Build Coastguard Worker    make install_gui
59*58e6ee5fSAndroid Build Coastguard Worker
60*58e6ee5fSAndroid Build Coastguard WorkerNote: The default install is relative to /usr/local
61*58e6ee5fSAndroid Build Coastguard Worker    The default install directory is /usr/local/bin
62*58e6ee5fSAndroid Build Coastguard Worker    The default plugin directory is /usr/local/lib/trace-cmd/plugins
63*58e6ee5fSAndroid Build Coastguard Worker
64*58e6ee5fSAndroid Build Coastguard WorkerTo change the default, you can set 'prefix', eg
65*58e6ee5fSAndroid Build Coastguard Workermkdir $HOME/test-trace
66*58e6ee5fSAndroid Build Coastguard Workermake prefix=$HOME/test-trace
67*58e6ee5fSAndroid Build Coastguard Workermake prefix=$HOME/test-trace install
68*58e6ee5fSAndroid Build Coastguard Worker
69