README.md

   1 <!--
   2 SPDX-FileCopyrightText: 2024 EfficiOS, Inc.
   3
   4 SPDX-License-Identifier: MIT
   5 -->
   6
   7 # Exatracer
   8
   9 The Exatracer is powered by the LTTng ecosystem and can instrument the HIP and
  10 HSA runtimes and ROC-TX.
  11
  12 ## Usage
  13
  14 Link program against `libexatracer.so` or `LD_PRELOAD` it.
  15
  16 ```sh
  17 TRACE_OUTPUT="$(pwd)/my-application-trace"
  18 lttng create --output $TRACE_OUTPUT
  19 lttng enable-event --userspace 'hip:*'
  20 lttng enable-event --userspace 'hsa:*'
  21 lttng enable-event --userspace 'roctx:*'
  22 lttng start
  23 LD_PRELOAD=libexatracer.so ./my-application
  24 lttng destroy
  25 babeltrace2 $TRACE_OUTPUT
  26 ```
  27
  28 ## Dependencies
  29
  30 ### Runtime
  31
  32 - lttng-ust
  33 - rocprofiler-sdk
  34
  35 ### Development
  36
  37 - babeltrace2
  38 - coreutils
  39 - clang-toolchain
  40 - g++
  41 - lttng-tools
  42 - make
  43 - pkg-config
  44 - python3 >= 3.8
  45 - python3-clang
  46 - sed
  47
  48 ## Compilation
  49
  50 See top of `Makefile` for configuration.
  51
  52 - `make ROCM_VERSION=VERSION`
  53 - `make check`
  54
  55