Important
We are phasing out development and support for roctracer/rocprofiler/rocprof/rocprofv2 in favor of rocprofiler-sdk/rocprofv3 in upcoming ROCm releases. Going forward, only critical defect fixes will be addressed for older versions of profiling tools and libraries. We encourage all users to upgrade to the latest version, rocprofiler-sdk library and rocprofv3 tool, to ensure continued support and access to new features.
Note
The published documentation is available at ROCTracer in an organized, easy-to-read format, with search and a table of contents.
-
ROC-tracer library: Runtimes Generic Callback/Activity APIs
The goal of the implementation is to provide a generic independent from specific runtime profiler to trace API and asynchronous activity.
The API provides functionality for registering the runtimes API callbacks and asynchronous activity records pool support.
-
ROC-TX library: Code Annotation Events API
Includes API for:
roctxMarkroctxRangePushroctxRangePop
To use the rocTracer API you need the API header and to link your application with roctracer .so library:
-
/opt/rocm/include/roctracer/roctracer.hAPI header.
-
/opt/rocm/lib/libroctracer64.so.so library.
To use the rocTX API you need the API header and to link your application with roctx .so library:
-
/opt/rocm/include/roctracer/roctx.hAPI header.
-
/opt/rocm/lib/libroctx64.so.so library.
-
docDocumentation.
-
incInclude header files.
-
roctracer.hrocTracerlibrary public API header. -
roctx.hrocTXlibrary public API header.
-
-
srcLibrary sources.
-
corerocTracerlibrary API sources. -
roctxrocTXlibrary API sources. -
utilLibrary utils sources.
-
-
testTest suit.
-
MatrixTransposeTest based on HIP MatrixTranspose sample.
-
- API description:
- Code examples:
-
ROCm is required
-
Packages required:
- For Ubuntu 18.04 and Ubuntu 20.04 the following adds the needed packages:
apt install python3 python3-pip gcc g++ libatomic1 make rocm-llvm-dev \ cmake doxygen graphviz texlive-full
- For CentOS 8.1 and RHEL 8.1 the following adds the needed packages:
yum install -y python3 python3-pip gcc gcc-g++ make rocm-llvm-devel \ cmake libatomic doxygen graphviz texlive \ texlive-xtab texlive-multirow texlive-sectsty \ texlive-tocloft texlive-tabu texlive-adjustbox
- For SLES 15 Service Pack 15 the following adds the needed packages:
zypper in python3 python3-pip gcc gcc-g++ make rocm-llvm-devel \ cmake libatomic doxygen graphviz \ texlive-scheme-medium texlive-hanging texlive-stackengine \ texlive-tocloft texlive-etoc texlive-tabu -
Python modules requirements:
CppHeaderParser,argparse.To install:
pip3 install CppHeaderParser argparse
-
Clone development branch of
roctracer:git clone -b amd-master https://github.com/ROCm-Developer-Tools/roctracer
-
To build
roctracerlibrary:cd <your path>/roctracer ./build.sh
-
To build and run test:
cd <your path>/roctracer/build make mytest run.sh
Install by:
make installor:
make package && dpkg -i *.deb