diff --git a/docs/hipify-clang.rst b/docs/hipify-clang.rst index 153b86dc..acb73b44 100644 --- a/docs/hipify-clang.rst +++ b/docs/hipify-clang.rst @@ -37,7 +37,7 @@ Dependencies * `LLVM+Clang `_ of at least version `4.0.0 `_; the latest stable and recommended release: - `19.1.2 `_. + `19.1.3 `_. * `CUDA `_ of at least version `7.0 `_, the latest supported version is @@ -186,7 +186,8 @@ Dependencies - ✅ * - `19.1.0 `_, `19.1.1 `_, - `19.1.2 `_:sup:`4` + `19.1.2 `_, + `19.1.3 `_:sup:`4` - `12.6.1 `_:sup:`4` - **Latest stable config** - **Latest stable config** @@ -229,7 +230,7 @@ Dependencies In most cases, you can get a suitable version of ``LLVM+Clang`` with your package manager. However, you can also `download a release archive `_ and build or install it. In case of multiple versions of ``LLVM`` installed, set `CMAKE_PREFIX_PATH `_ so that -``CMake`` can find the desired version of ``LLVM``. For example, ``-DCMAKE_PREFIX_PATH=D:\LLVM\19.1.2\dist``. +``CMake`` can find the desired version of ``LLVM``. For example, ``-DCMAKE_PREFIX_PATH=D:\LLVM\19.1.3\dist``. Usage ============================================================ @@ -262,7 +263,7 @@ header files used during the hipification process: .. code:: shell - ./hipify-clang square.cu --cuda-path=/usr/local/cuda-12.6 --clang-resource-directory=/usr/llvm/19.1.2/dist/lib/clang/19 + ./hipify-clang square.cu --cuda-path=/usr/local/cuda-12.6 --clang-resource-directory=/usr/llvm/19.1.3/dist/lib/clang/19 For more information, refer to the `Clang manual for compiling CUDA `_. @@ -399,7 +400,7 @@ To ensure LLVM being found or in case of multiple LLVM instances, specify the pa .. code-block:: bash - -DCMAKE_PREFIX_PATH=/usr/llvm/19.1.2/dist + -DCMAKE_PREFIX_PATH=/usr/llvm/19.1.3/dist On Windows, specify the following option for CMake in the first place: ``-G "Visual Studio 17 2022"``. @@ -473,7 +474,7 @@ LLVM <= 9.0.1 LLVM >= 10.0.0 ----------------- -1. Download `LLVM project `_ sources. +1. Download `LLVM project `_ sources. 2. Build `LLVM project `_: @@ -576,13 +577,13 @@ LLVM >= 10.0.0 .. code-block:: bash - python /usr/llvm/19.1.2/llvm-project/llvm/utils/lit/setup.py install + python /usr/llvm/19.1.3/llvm-project/llvm/utils/lit/setup.py install **Windows**: .. code-block:: shell - python D:/LLVM/19.1.2/llvm-project/llvm/utils/lit/setup.py install + python D:/LLVM/19.1.3/llvm-project/llvm/utils/lit/setup.py install In case of errors similar to ``ModuleNotFoundError: No module named 'setuptools'``, upgrade the ``setuptools`` package: @@ -596,23 +597,23 @@ LLVM >= 10.0.0 .. code-block:: bash - -DLLVM_EXTERNAL_LIT=/usr/llvm/19.1.2/build/bin/llvm-lit + -DLLVM_EXTERNAL_LIT=/usr/llvm/19.1.3/build/bin/llvm-lit **Windows**: .. code-block:: shell - -DLLVM_EXTERNAL_LIT=D:/LLVM/19.1.2/build/Release/bin/llvm-lit.py + -DLLVM_EXTERNAL_LIT=D:/LLVM/19.1.3/build/Release/bin/llvm-lit.py * ``FileCheck``: **Linux**: - Copy from ``/usr/llvm/19.1.2/build/bin/`` to ``CMAKE_INSTALL_PREFIX/dist/bin``. + Copy from ``/usr/llvm/19.1.3/build/bin/`` to ``CMAKE_INSTALL_PREFIX/dist/bin``. **Windows**: - Copy from ``D:/LLVM/19.1.2/build/Release/bin`` to ``CMAKE_INSTALL_PREFIX/dist/bin``. + Copy from ``D:/LLVM/19.1.3/build/Release/bin`` to ``CMAKE_INSTALL_PREFIX/dist/bin``. Alternatively, specify the path to ``FileCheck`` in the ``CMAKE_INSTALL_PREFIX`` option. @@ -639,8 +640,8 @@ On Linux, the following configurations are tested: * Ubuntu 14: LLVM 4.0.0 - 7.1.0, CUDA 7.0 - 9.0, cuDNN 5.0.5 - 7.6.5 * Ubuntu 16-19: LLVM 8.0.0 - 14.0.6, CUDA 7.0 - 10.2, cuDNN 5.1.10 - 8.0.5 -* Ubuntu 20-21: LLVM 9.0.0 - 19.1.2, CUDA 7.0 - 12.6.1, cuDNN 5.1.10 - 9.5.1 -* Ubuntu 22-23: LLVM 13.0.0 - 19.1.2, CUDA 7.0 - 12.6.1, cuDNN 8.0.5 - 9.5.1 +* Ubuntu 20-21: LLVM 9.0.0 - 19.1.3, CUDA 7.0 - 12.6.1, cuDNN 5.1.10 - 9.5.1 +* Ubuntu 22-23: LLVM 13.0.0 - 19.1.3, CUDA 7.0 - 12.6.1, cuDNN 8.0.5 - 9.5.1 Minimum build system requirements for the above configurations: @@ -658,10 +659,10 @@ Here's how to build ``hipify-clang`` with testing support on ``Ubuntu 23.10.01`` -DHIPIFY_CLANG_TESTS=ON \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=../dist \ - -DCMAKE_PREFIX_PATH=/usr/llvm/19.1.2/dist \ + -DCMAKE_PREFIX_PATH=/usr/llvm/19.1.3/dist \ -DCUDA_TOOLKIT_ROOT_DIR=/usr/local/cuda-12.6.1 \ -DCUDA_DNN_ROOT_DIR=/usr/local/cudnn-9.5.1 \ - -DLLVM_EXTERNAL_LIT=/usr/llvm/19.1.2/build/bin/llvm-lit \ + -DLLVM_EXTERNAL_LIT=/usr/llvm/19.1.3/build/bin/llvm-lit \ ../hipify The corresponding successful output is: @@ -685,11 +686,11 @@ The corresponding successful output is: -- - Test hipify-clang : ON -- - Is part of HIP SDK : OFF -- Found ZLIB: /usr/lib/x86_64-linux-gnu/libz.so (found version "1.2.13") - -- Found LLVM 19.1.2: - -- - CMake module path : /usr/llvm/19.1.2/dist/lib/cmake/llvm - -- - Clang include path : /usr/llvm/19.1.2/dist/include - -- - LLVM Include path : /usr/llvm/19.1.2/dist/include - -- - Binary path : /usr/llvm/19.1.2/dist/bin + -- Found LLVM 19.1.3: + -- - CMake module path : /usr/llvm/19.1.3/dist/lib/cmake/llvm + -- - Clang include path : /usr/llvm/19.1.3/dist/include + -- - LLVM Include path : /usr/llvm/19.1.3/dist/include + -- - Binary path : /usr/llvm/19.1.3/dist/bin -- Linker detection: GNU ld -- ---- The below configuring for hipify-clang testing only ---- -- Found Python: /usr/bin/python3.13 (found version "3.13.0") found components: Interpreter @@ -724,7 +725,7 @@ The corresponding successful output is: Running HIPify regression tests =============================================================== CUDA 12.6.68 - will be used for testing - LLVM 19.1.2 - will be used for testing + LLVM 19.1.3 - will be used for testing x86_64 - Platform architecture Linux 6.5.0-15-generic - Platform OS 64 - hipify-clang binary bitness @@ -824,7 +825,7 @@ Tested configurations: - ``2019.16.11.40, 2022.17.11.4`` - ``3.30.4`` - ``3.13.0`` - * - ``19.1.0 - 19.1.2`` + * - ``19.1.0 - 19.1.3`` - ``7.0 - 12.6.1`` - ``8.0.5 - 9.5.1`` - ``2019.16.11.40, 2022.17.11.4`` @@ -854,11 +855,11 @@ Building with testing support using ``Visual Studio 17 2022`` on ``Windows 11``: -DHIPIFY_CLANG_TESTS=ON \ -DCMAKE_BUILD_TYPE=Release \ -DCMAKE_INSTALL_PREFIX=../dist \ - -DCMAKE_PREFIX_PATH=D:/LLVM/19.1.2/dist \ + -DCMAKE_PREFIX_PATH=D:/LLVM/19.1.3/dist \ -DCUDA_TOOLKIT_ROOT_DIR="C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v12.6" \ -DCUDA_SDK_ROOT_DIR="C:/ProgramData/NVIDIA Corporation/CUDA Samples/v12.5" \ -DCUDA_DNN_ROOT_DIR=D:/CUDA/cuDNN/9.5.1 \ - -DLLVM_EXTERNAL_LIT=D:/LLVM/19.1.2/build/Release/bin/llvm-lit.py \ + -DLLVM_EXTERNAL_LIT=D:/LLVM/19.1.3/build/Release/bin/llvm-lit.py \ ../hipify The corresponding successful output is: @@ -882,15 +883,15 @@ The corresponding successful output is: -- - Build hipify-clang : ON -- - Test hipify-clang : ON -- - Is part of HIP SDK : OFF - -- Found LLVM 19.1.2: - -- - CMake module path : D:/LLVM/19.1.2/dist/lib/cmake/llvm - -- - Clang include path : D:/LLVM/19.1.2/dist/include - -- - LLVM Include path : D:/LLVM/19.1.2/dist/include - -- - Binary path : D:/LLVM/19.1.2/dist/bin + -- Found LLVM 19.1.3: + -- - CMake module path : D:/LLVM/19.1.3/dist/lib/cmake/llvm + -- - Clang include path : D:/LLVM/19.1.3/dist/include + -- - LLVM Include path : D:/LLVM/19.1.3/dist/include + -- - Binary path : D:/LLVM/19.1.3/dist/bin -- ---- The below configuring for hipify-clang testing only ---- -- Found Python: C:/Users/TT/AppData/Local/Programs/Python/Python313/python.exe (found version "3.13.0") found components: Interpreter -- Found lit: C:/Users/TT/AppData/Local/Programs/Python/Python313/Scripts/lit.exe - -- Found FileCheck: D:/LLVM/19.1.2/dist/bin/FileCheck.exe + -- Found FileCheck: D:/LLVM/19.1.3/dist/bin/FileCheck.exe -- Initial CUDA to configure: -- - CUDA Toolkit path : C:/Program Files/NVIDIA GPU Computing Toolkit/CUDA/v12.6 -- - CUDA Samples path : C:/ProgramData/NVIDIA Corporation/CUDA Samples/v12.5