Ammar ELWazir
d835435b0d
API Spec Documentation link fixed Change-Id: I0d0ef52eaa0e66b161cb042704c083e29b0db06f
166 라인
3.1 KiB
Markdown
166 라인
3.1 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 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:
|
|
|
|
- `roctxMark`
|
|
- `roctxRangePush`
|
|
- `roctxRangePop`
|
|
|
|
## Usage
|
|
|
|
### `rocTracer` API
|
|
|
|
To use the rocTracer API you need the API header and to link your application with `roctracer` .so library:
|
|
|
|
- `/opt/rocm/include/roctracer/roctracer.h`
|
|
|
|
API header.
|
|
|
|
- `/opt/rocm/lib/libroctracer64.so`
|
|
|
|
.so library.
|
|
|
|
### `rocTX` API
|
|
|
|
To use the rocTX API you need the API header and to link your application with `roctx` .so library:
|
|
|
|
- `/opt/rocm/roctracer/include/roctx.h`
|
|
|
|
API header.
|
|
|
|
- `/opt/rocm/lib/libroctx64.so`
|
|
|
|
.so library.
|
|
|
|
## Library source tree
|
|
|
|
- `doc`
|
|
|
|
Documentation.
|
|
|
|
- `inc`
|
|
|
|
Include header files.
|
|
|
|
- `roctracer.h`
|
|
|
|
`rocTacer` library public API header.
|
|
|
|
- `roctx.h`
|
|
|
|
`rocTX` library public 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](testMatrixTranspose_test/MatrixTranspose.cpp)
|
|
- [test/MatrixTranspose/MatrixTranspose.cpp](test/MatrixTranspose/MatrixTranspose.cpp)
|
|
|
|
## Build and run tests
|
|
|
|
- ROCm is required
|
|
|
|
- Packages required:
|
|
|
|
1. For Ubuntu 18.04 and Ubuntu 20.04 the following adds the needed packages:
|
|
|
|
````shell
|
|
apt install python3 python3-pip gcc g++ libatomic1 make \
|
|
cmake doxygen graphviz texlive-full
|
|
````
|
|
|
|
2. For CentOS 8.1 and RHEL 8.1 the following adds the needed packages:
|
|
|
|
````shell
|
|
yum install -y python3 python3-pip gcc gcc-g++ make \
|
|
cmake libatomic doxygen graphviz texlive \
|
|
texlive-xtab texlive-multirow texlive-sectsty \
|
|
texlive-tocloft texlive-tabu texlive-adjustbox
|
|
````
|
|
|
|
3. For SLES 15 Service Pack 15 the following adds the needed packages:
|
|
|
|
````shell
|
|
zypper in python3 python3-pip gcc gcc-g++ make \
|
|
cmake libatomic doxygen graphviz \
|
|
texlive-scheme-medium texlive-hanging texlive-stackengine \
|
|
texlive-tocloft texlive-etoc texlive-tabu
|
|
````
|
|
|
|
- Python modules requirements: `CppHeaderParser`, `argparse`.
|
|
|
|
To install:
|
|
|
|
```sh
|
|
pip3 install CppHeaderParser argparse
|
|
```
|
|
|
|
- Clone development branch of `roctracer`:
|
|
|
|
```sh
|
|
git clone -b amd-master https://github.com/ROCm-Developer-Tools/roctracer
|
|
```
|
|
|
|
- To build `roctracer` library:
|
|
|
|
```sh
|
|
cd <your path>/roctracer
|
|
./build.sh
|
|
```
|
|
|
|
- To build and run test:
|
|
|
|
```sh
|
|
cd <your path>/roctracer/build
|
|
make mytest
|
|
run.sh
|
|
```
|
|
|
|
## Installation
|
|
|
|
Install by:
|
|
|
|
```sh
|
|
make install
|
|
```
|
|
|
|
or:
|
|
|
|
```sh
|
|
make package && dpkg -i *.deb
|
|
```
|