|
1 |
| -# HIP compiler driver (HIPCC) |
| 1 | +# HIP compiler driver (hipcc) |
2 | 2 |
|
3 |
| -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. |
| 3 | +## Table of Contents |
4 | 4 |
|
5 |
| -It will pass-through options to the target compiler. The tools calling HIPCC must ensure the compiler options are appropriate for the target compiler. |
| 5 | +<!-- toc --> |
| 6 | + |
| 7 | +- [hipcc](#hipcc) |
| 8 | + * [Environment Variables](#envVar) |
| 9 | + * [Usage](#hipcc-usage) |
| 10 | + * [Building](#building) |
| 11 | + * [Testing](#testing) |
| 12 | + * [Linux](#linux) |
| 13 | + * [Windows](#windows) |
| 14 | + |
| 15 | +<!-- tocstop --> |
| 16 | + |
| 17 | +## <a name="hipcc"></a> hipcc |
| 18 | + |
| 19 | +`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. |
| 20 | + |
| 21 | +It will pass-through options to the target compiler. The tools calling hipcc must ensure the compiler options are appropriate for the target compiler. |
| 22 | + |
| 23 | +### <a name="envVar"></a> Environment Variables |
6 | 24 |
|
7 | 25 | The environment variable HIP_PLATFORM may be used to specify amd/nvidia:
|
8 | 26 | - HIP_PLATFORM='amd' or HIP_PLATFORM='nvidia'.
|
9 | 27 | - If HIP_PLATFORM is not set, then hipcc will attempt to auto-detect based on if nvcc is found.
|
10 | 28 |
|
11 | 29 | Other environment variable controls:
|
12 |
| -- HIP_PATH : Path to HIP directory, default is one dir level above location of HIPCC. |
| 30 | +- HIP_PATH : Path to HIP directory, default is one dir level above location of hipcc. |
13 | 31 | - CUDA_PATH : Path to CUDA SDK (default /usr/local/cuda). Used on NVIDIA platforms only.
|
14 |
| -- HSA_PATH : Path to HSA dir (defaults to ../../hsa relative to abs_path of HIPCC). Used on AMD platforms only. |
| 32 | +- HSA_PATH : Path to HSA dir (defaults to ../../hsa relative to abs_path of hipcc). Used on AMD platforms only. |
15 | 33 | - HIP_ROCCLR_HOME : Path to HIP/ROCclr directory. Used on AMD platforms only.
|
16 |
| -- HIP_CLANG_PATH : Path to HIP-Clang (default to ../../llvm/bin relative to HIPCC's abs_path). Used on AMD platforms only. |
| 34 | +- HIP_CLANG_PATH : Path to HIP-Clang (default to ../../llvm/bin relative to hipcc's abs_path). Used on AMD platforms only. |
| 35 | + |
| 36 | +### <a name="usage"></a> hipcc: usage |
| 37 | + |
| 38 | +- WIP |
| 39 | + |
| 40 | +### <a name="building"></a> hipcc: building |
| 41 | + |
| 42 | +- WIP |
| 43 | + |
| 44 | +### <a name="testing"></a> hipcc: testing |
| 45 | + |
| 46 | +- WIP |
0 commit comments