eshcherb
77 lines
2.4 KiB
Markdown
77 lines
2.4 KiB
Markdown
# ROC-tracer
|
|
```
|
|
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 asyncronous activity.
|
|
|
|
The API provides functionality for registering the runtimes API callbacks and
|
|
asyncronous activity records pool support.
|
|
|
|
ROC-TX librray: code annotation evemts API
|
|
Includes basic API: roctxMark, roctxRangePush, roctxRangePop.
|
|
```
|
|
|
|
## Usage
|
|
```
|
|
rocTracer API:
|
|
To use the rocTracer API you need the API header and to link your application with roctracer .so librray:
|
|
- the API header: /opt/rocm/roctracer/include/roctracer.h
|
|
- the .so library: /opt/rocm/lib/libroctracer64.so
|
|
|
|
rocTX API:
|
|
To use the rocTX API you need the API header and to link your application with roctx .so librray:
|
|
- the API header: /opt/rocm/roctracer/include/roctx.h
|
|
- the .so library: /opt/rocm/lib/libroctx64.so
|
|
```
|
|
|
|
## The library source tree
|
|
```
|
|
- doc - documentation
|
|
- inc/roctracer.h - rocTacer library public API header
|
|
- inc/roctx.h - rocTX library puiblic API header
|
|
- src - Library sources
|
|
- core - rocTracer library API sources
|
|
- roctx - rocTX library API sources
|
|
- util - library utils sources
|
|
- test - test suit
|
|
- MatrixTranspose - test based on HIP MatrixTranspose sample
|
|
```
|
|
|
|
## Documentation
|
|
- API description:
|
|
- ['roctracer' / 'rocTX' profiling C API specification](doc/roctracer_spec.md)
|
|
- Code examples:
|
|
- [test/MatrixTranspose_test/MatrixTranspose.cpp](test/MatrixTranspose_test/MatrixTranspose.cpp)
|
|
- [test/MatrixTranspose/MatrixTranspose.cpp](test/MatrixTranspose/MatrixTranspose.cpp)
|
|
|
|
## To build and run test
|
|
```
|
|
- ROCm is required
|
|
|
|
- Python modules requirements: CppHeaderParser, argparse.
|
|
To install:
|
|
sudo pip install CppHeaderParser argparse
|
|
|
|
- CLone development branch of roctracer:
|
|
git clone -b amd-master https://github.com/ROCm-Developer-Tools/roctracer
|
|
|
|
- Set environment:
|
|
export CMAKE_PREFIX_PATH=/opt/rocm
|
|
- To use custom HIP/HCC versions:
|
|
export HIP_PATH=/opt/rocm/hip
|
|
export HCC_HOME=/opt/rocm/hcc
|
|
|
|
- To build roctracer library:
|
|
export CMAKE_BUILD_TYPE=<debug|release> # release by default
|
|
cd <your path>/roctracer && mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX=/opt/rocm .. && make -j <nproc>
|
|
|
|
- To build and run test:
|
|
make mytest
|
|
run.sh
|
|
|
|
- To install:
|
|
make install
|
|
or
|
|
make package && dpkg -i *.deb
|
|
```
|