derek.holloway
7502bf64a4
HIP compiler driver (hipcc)
Table of Contents
hipcc
hipcc is a compiler driver utility that will call clang or nvcc, depending on target, and pass the appropriate include and library options for the target compiler and HIP infrastructure.
hipcc will pass-through options to the target compiler. The tools calling hipcc must ensure the compiler options are appropriate for the target compiler.
Building
Building on Linux:
mkdir build
cd build
cmake ..
make -j4
The hipcc and hipconfig executables are created in the current build folder. You may also create installable packages with :
make package
Documentation
The published documentation is available at HIPCC in an organized, easy-to-read format, with search and a table of contents. The documentation source files reside in the amd/HIPCC/docs folder of this repository. As with all ROCm projects, the documentation is open source. For more information on contributing to the documentation, see Contribute to ROCm documentation.
Run the steps below to build documentation locally.
cd docs
pip3 install -r sphinx/requirements.txt
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
Environment Variables
The environment variable HIP_PLATFORM may be used to specify amd/nvidia:
- HIP_PLATFORM='amd' or HIP_PLATFORM='nvidia'.
- If HIP_PLATFORM is not set, then hipcc will attempt to auto-detect based on if nvcc is found.
Other environment variable controls:
- CUDA_PATH : Path to CUDA SDK (default /usr/local/cuda). Used on NVIDIA platforms only.
Usage
The built executables can be used the same way as the hipcc/hipconfig perl scripts. To use the newly built executables from the build folder use ./ in front of the executable name - Example:
./hipconfig --help
./hipcc --help
./hipcc --version
./hipconfig --full
hipcc: testing
Currently hipcc/hipconfig executables are tested by building and executing HIP tests: https://github.com/ROCm/hip-tests