Files
TheRock/compiler/amd-llvm/amd/hipcc/docs/env.rst
T
derek.holloway 7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

66 lines
2.5 KiB
ReStructuredText

.. meta::
:description: HIPCC environment variables
:keywords: HIPCC, ROCm, HIP tools, HIP compiler
.. _hipcc_vars:
******************************************
HIPCC environment variables
******************************************
This topic provides descriptions of the HIPCC environment
variables. For more information about other ROCm environment variables, see
`HIP environment variables <https://rocm.docs.amd.com/projects/HIP/en/latest/reference/env_variables.html>`_.
.. list-table::
:header-rows: 1
:widths: 50,50
* - Environment variable
- Value
* - | ``HIP_PLATFORM``
| The platform targeted by HIP. If ``HIP_PLATFORM`` isn't set, then :doc:`HIPCC <hipcc:index>` attempts to auto-detect the platform based on whether the ``nvcc`` tool is found.
- ``amd``, ``nvidia``
* - | ``HIP_PATH``
| The path of the HIP SDK on Microsoft Windows for AMD platforms.
- Default: ``C:/hip``
* - | ``ROCM_PATH``
| The path of the installed ROCm software stack on Linux for AMD platforms.
- Default: ``/opt/rocm``
* - | ``CUDA_PATH``
| Path to the CUDA SDK, which is only used for NVIDIA platforms.
- Default: ``/usr/local/cuda``
* - | ``HIP_CLANG_PATH``
| Path to the clang, which is only used for AMD platforms.
- Default: ``ROCM_PATH/llvm/bin`` or ``HIP_PATH/../llvm/bin"``
* - | ``HIP_LIB_PATH``
| The HIP device library installation path.
- Default: ``HIP_PATH/lib``
* - | ``HIP_DEVICE_LIB_PATH``
| The HIP device library installation path.
-
* - | ``HIPCC_COMPILE_FLAGS_APPEND``
| Append extra flags as compilation options to ``hipcc``.
-
* - | ``HIPCC_LINK_FLAGS_APPEND``
| Append extra flags as compilation options to ``hipcc``.
-
* - | ``HIPCC_VERBOSE``
| Outputs detailed information on subcommands executed during compilation.
- | 1: Displays the command to ``clang++`` or ``nvcc`` with all options (``hipcc-cmd``).
| 2: Displays all relevant environment variables and their values.
| 4: Displays only the arguments passed to the ``hipcc`` command (``hipcc_args``).
| 5: Displays both the command to ``clang++`` or ``nvcc`` and ``hipcc`` arguments (``hipcc-cmd`` and ``hipcc-args``).
| 6: Displays all relevant environment variables and their values, along with the arguments to the ``hipcc`` command.
| 7: Displays all of the above: ``hipcc-cmd``, ``hipcc-args``, and environment variables.