Add documentation
[deliverable/exatracer.git] / README.md
CommitLineData
c75d6f3f
OD
1# Exatracer
2
3The Exatracer is powered by the LTTng ecosystem and can instrument the HIP and
4HSA runtimes and ROC-TX.
5
6## Usage
7
8Link program against `libexatracer.so` or `LD_PRELOAD` it.
9
10```sh
11TRACE_OUTPUT="$(pwd)/my-application-trace"
12lttng create --output $TRACE_OUTPUT
13lttng enable-event --userspace 'hip:*'
14lttng enable-event --userspace 'hsa:*'
15lttng enable-event --userspace 'roctx:*'
16lttng start
17LD_PRELOAD=libexatracer.so ./my-application
18lttng destroy
19babeltrace2 $TRACE_OUTPUT
20```
21
22## Dependencies
23
24### Runtime
25
26- lttng-ust
27- rocprofiler-sdk
28
29### Development
30
31- babeltrace2
32- coreutils
33- clang-toolchain
34- g++
35- lttng-tools
36- make
37- pkg-config
38- python3 >= 3.8
39- python3-clang
40- sed
41
42## Compilation
43
44See top of `Makefile` for configuration.
45
46- `make ROCM_VERSION=VERSION`
47- `make check`
48
49
This page took 0.024091 seconds and 4 git commands to generate.