path: root/var/spack/repos/builtin/packages/llvm-amdgpu/package.py

# Copyright 2013-2023 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)


import os
import re

from spack.package import *


class LlvmAmdgpu(CMakePackage):
    """Toolkit for the construction of highly optimized compilers,
    optimizers, and run-time environments."""

    homepage = "https://github.com/RadeonOpenCompute/llvm-project"
    git = "https://github.com/RadeonOpenCompute/llvm-project.git"
    url = "https://github.com/RadeonOpenCompute/llvm-project/archive/rocm-5.5.0.tar.gz"
    tags = ["rocm"]
    executables = [r"amdclang", r"amdclang\+\+", r"amdflang", r"clang.*", r"flang.*", "llvm-.*"]
    generator("ninja")

    maintainers("srekolam", "renjithravindrankannath", "haampie")

    license("Apache-2.0")

    version("master", branch="amd-stg-open")
    version("5.7.1", sha256="6b54c422e45ad19c9bf5ab090ec21753e7f7d854ca78132c30eb146657b168eb")
    version("5.7.0", sha256="4abdf00b297a77c5886cedb37e63acda2ba11cb9f4c0a64e133b05800aadfcf0")
    version("5.6.1", sha256="045e43c0c4a3f4f2f1db9fb603a4f1ea3d56e128147e19ba17909eb57d7f08e5")
    version("5.6.0", sha256="e922bd492b54d99e56ed88c81e2009ed6472059a180b10cc56ce1f9bd2d7b6ed")
    version("5.5.1", sha256="7d7181f20f89cb0715191aa32914186c67a34258c13457055570d47e15296553")
    version("5.5.0", sha256="5dc6c99f612b69ff73145bee17524e3712990100e16445b71634106acf7927cf")
    version("5.4.3", sha256="a844d3cc01613f6284a75d44db67c495ac1e9b600eacbb1eb13d2649f5d5404d")
    version("5.4.0", sha256="ff54f45a17723892cd775c1eaff9e5860527fcfd33d98759223c70e3362335bf")
    version("5.3.3", sha256="5296d5e474811c7d1e456cb6d5011db248b79b8d0512155e8a6c2aa5b5f12d38")
    version("5.3.0", sha256="4e3fcddb5b8ea8dcaa4417e0e31a9c2bbdc9e7d4ac3401635a636df32905c93e")
    version("5.2.3", sha256="1b852711aec3137b568fb65f93606d37fdcd62e06f5da3766f2ffcd4e0c646df")
    version("5.2.1", sha256="3644e927d943d61e22672422591c47a62ff83e3d87ced68439822156d8f79abf")
    version("5.2.0", sha256="0f892174111b78a02d1a00f8f46d9f80b9abb95513a7af38ecf2a5a0882fe87f")
    version("5.1.3", sha256="d236a2064363c0278f7ba1bb2ff1545ee4c52278c50640e8bb2b9cfef8a2f128")
    version("5.1.0", sha256="db5d45c4a7842a908527c1b7b8d4a40c688225a41d23cfa382eab23edfffdd10")
    version(
        "5.0.2",
        sha256="99a14394b406263576ed3d8d10334de7c78d42b349109f375d178b11492eecaf",
        deprecated=True,
    )
    version(
        "5.0.0",
        sha256="bca2db4aaab71541cac588d6a708fde60f0ebe744809bde8a3847044a1a77413",
        deprecated=True,
    )
    version(
        "4.5.2",
        sha256="36a4f7dd961cf373b743fc679bdf622089d2a905de2cfd6fd6c9e7ff8d8ad61f",
        deprecated=True,
    )
    version(
        "4.5.0",
        sha256="b71451bf26650ba06c0c5c4c7df70f13975151eaa673ef0cc77c1ab0000ccc97",
        deprecated=True,
    )
    version(
        "4.3.1",
        sha256="b53c6b13be7d77dc93a7c62e4adbb414701e4e601e1af2d1e98da4ee07c9837f",
        deprecated=True,
    )
    version(
        "4.3.0",
        sha256="1567d349cd3bcd2c217b3ecec2f70abccd5e9248bd2c3c9f21d4cdb44897fc87",
        deprecated=True,
    )
    version(
        "4.2.0",
        sha256="751eca1d18595b565cfafa01c3cb43efb9107874865a60c80d6760ba83edb661",
        deprecated=True,
    )
    version(
        "4.1.0",
        sha256="244e38d824fa7dfa8d0edf3c036b3c84e9c17a16791828e4b745a8d31eb374ae",
        deprecated=True,
    )
    version(
        "4.0.0",
        sha256="aa1f80f429fded465e86bcfaef72255da1af1c5c52d58a4c979bc2f6c2da5a69",
        deprecated=True,
    )
    version(
        "3.10.0",
        sha256="8262aff88c1ff6c4deb4da5a4f8cda1bf90668950e2b911f93f73edaee53b370",
        deprecated=True,
    )
    version(
        "3.9.0",
        sha256="1ff14b56d10c2c44d36c3c412b190d3d8cd1bb12cfc7cd58af004c16fd9987d1",
        deprecated=True,
    )
    version(
        "3.8.0",
        sha256="93a28464a4d0c1c9f4ba55e473e5d1cde4c5c0e6d087ec8a0a3aef1f5f5208e8",
        deprecated=True,
    )
    version(
        "3.7.0",
        sha256="3e2542ce54b91b5c841f33d542143e0e43eae95e8785731405af29f08ace725b",
        deprecated=True,
    )
    version(
        "3.5.0",
        sha256="4878fa85473b24d88edcc89938441edc85d2e8a785e567b7bd7ce274ecc2fd9c",
        deprecated=True,
    )

    variant(
        "rocm-device-libs",
        default=True,
        description=(
            "Build ROCm device libs as external LLVM project instead of a "
            "standalone spack package."
        ),
    )
    variant("openmp", default=False, description="Enable OpenMP")
    variant(
        "llvm_dylib",
        default=False,
        description="Build LLVM shared library, containing all "
        "components in a single shared library",
    )
    variant(
        "link_llvm_dylib",
        default=False,
        description="Link LLVM tools against the LLVM shared library",
    )

    provides("libllvm@11", when="@3.5:3.8")
    provides("libllvm@12", when="@3.9:4.2")
    provides("libllvm@13", when="@4.3:4.9")
    provides("libllvm@14", when="@5:5.2")
    provides("libllvm@15", when="@5.3:5.4")
    provides("libllvm@16", when="@5.5:5.6")
    provides("libllvm@17", when="@5.7:")

    depends_on("cmake@3.4.3:", type="build", when="@:3.8")
    depends_on("cmake@3.13.4:", type="build", when="@3.9.0:")
    depends_on("python", type="build")
    depends_on("z3", type="link")
    depends_on("zlib-api", type="link")
    depends_on("ncurses+termlib", type="link")
    depends_on("pkgconfig", type="build")

    # openmp dependencies
    depends_on("perl-data-dumper", type=("build"), when="+openmp")
    depends_on("hwloc", when="+openmp")
    depends_on("elf", type="link", when="+openmp")

    # Will likely only be fixed in LLVM 12 upstream
    patch("fix-system-zlib-ncurses.patch", when="@3.5.0:3.8.0")
    patch("fix-ncurses-3.9.0.patch", when="@3.9.0:4.0.0")

    # This is already fixed in upstream but not in 4.2.0 rocm release
    patch("fix-spack-detection-4.2.0.patch", when="@4.2.0:4.5.2")

    patch("remove-cyclades-inclusion-in-sanitizer.patch", when="@4.2.0:4.5.2")

    # OpenMP clang toolchain looks for bitcode files in llvm/bin/../lib
    # as per 5.2.0 llvm code. It used to be llvm/bin/../lib/libdevice.
    # Below patch is to look in the old path.
    patch("adjust-openmp-bitcode-directory-for-llvm-link.patch", when="@5.2.0:5.6")
    patch("0001-update-HIP_PATH-deduction-for-5.7.0.patch", when="@5.7.0:5.7")

    # Below patch is to set the flag -mcode-object-version=none until
    # the below fix is available in device-libs release code.
    # https://github.com/RadeonOpenCompute/ROCm-Device-Libs/commit/f0356159dbdc93ea9e545f9b61a7842f9c881fdf
    patch("patch-llvm-5.5.0.patch", when="@5.5: +rocm-device-libs")

    # i1 muls can sometimes happen after SCEV.
    # They resulted in ISel failures because we were missing the patterns for them.
    # This fix is targeting 6.1 rocm release.
    # Need patch until https://github.com/llvm/llvm-project/pull/67291 is merged.
    patch("001-Add-i1-mul-patterns.patch", when="@5.6")
    patch("001-Add-i1-mul-patterns-5.7.patch", when="@5.7")

    conflicts("^cmake@3.19.0")

    root_cmakelists_dir = "llvm"
    install_targets = ["clang-tidy", "install"]

    # Add device libs sources so they can be an external LLVM project
    for d_version, d_shasum in [
        ("5.7.1", "703de8403c0bd0d80f37c970a698f10f148daf144d34f982e4484d04f7c7bbef"),
        ("5.7.0", "0f8780b9098573f1c456bdc84358de924dcf00604330770a383983e1775bf61e"),
        ("5.6.1", "f0dfab272ff936225bfa1e9dabeb3c5d12ce08b812bf53ffbddd2ddfac49761c"),
        ("5.6.0", "efb5dcdca9b3a9fbe408d494fb4a23e0b78417eb5fa8eebd4a5d226088f28921"),
        ("5.5.1", "3b5f6dd85f0e3371f6078da7b59bf77d5b210e30f1cc66ef1e2de6bbcb775833"),
        ("5.5.0", "5ab95aeb9c8bed0514f96f7847e21e165ed901ed826cdc9382c14d199cbadbd3"),
        ("5.4.3", "f4f7281f2cea6d268fcc3662b37410957d4f0bc23e0df9f60b12eb0fcdf9e26e"),
        ("5.4.0", "d68813ded47179c39914c8d1b76af3dad8c714b10229d1e2246af67609473951"),
        ("5.3.3", "963c9a0561111788b55a8c3b492e2a5737047914752376226c97a28122a4d768"),
        ("5.3.0", "f7e1665a1650d3d0481bec68252e8a5e68adc2c867c63c570f6190a1d2fe735c"),
        ("5.2.3", "16b7fc7db4759bd6fb54852e9855fa16ead76c97871d7e1e9392e846381d611a"),
        ("5.2.1", "e5855387ce73ed483ed0d03dbfef31f297c6ca66cf816f6816fd5ee373fc8225"),
        ("5.2.0", "901674bc941115c72f82c5def61d42f2bebee687aefd30a460905996f838e16c"),
        ("5.1.3", "c41958560ec29c8bf91332b9f668793463904a2081c330c0d828bf2f91d4f04e"),
        ("5.1.0", "47dbcb41fb4739219cadc9f2b5f21358ed2f9895ce786d2f7a1b2c4fd044d30f"),
        ("5.0.2", "49cfa8f8fc276ba27feef40546788a2aabe259a924a97af8bef24e295d19aa5e"),
        ("5.0.0", "83ed7aa1c9322b4fc1f57c48a63fc7718eb4195ee6fde433009b4bc78cb363f0"),
        ("4.5.2", "50e9e87ecd6b561cad0d471295d29f7220e195528e567fcabe2ec73838979f61"),
        ("4.5.0", "78412fb10ceb215952b5cc722ed08fa82501b5848d599dc00744ae1bdc196f77"),
        ("4.3.1", "a7291813168e500bfa8aaa5d1dccf5250764ddfe27535def01b51eb5021d4592"),
        ("4.3.0", "055a67e63da6491c84cd45865500043553fb33c44d538313dd87040a6f3826f2"),
        ("4.2.0", "34a2ac39b9bb7cfa8175cbab05d30e7f3c06aaffce99eed5f79c616d0f910f5f"),
        ("4.1.0", "f5f5aa6bfbd83ff80a968fa332f80220256447c4ccb71c36f1fbd2b4a8e9fc1b"),
        ("4.0.0", "d0aa495f9b63f6d8cf8ac668f4dc61831d996e9ae3f15280052a37b9d7670d2a"),
        ("3.10.0", "bca9291385d6bdc91a8b39a46f0fd816157d38abb1725ff5222e6a0daa0834cc"),
        ("3.9.0", "c99f45dacf5967aef9a31e3731011b9c142446d4a12bac69774998976f2576d7"),
        ("3.8.0", "e82cc9a8eb7d92de02cabb856583e28f17a05c8cf9c97aec5275608ef1a38574"),
        ("3.7.0", "b3a114180bf184b3b829c356067bc6a98021d52c1c6f9db6bc57272ebafc5f1d"),
        ("3.5.0", "dce3a4ba672c4a2da4c2260ee4dc96ff6dd51877f5e7e1993cb107372a35a378"),
    ]:
        resource(
            name="rocm-device-libs",
            placement="rocm-device-libs",
            url="https://github.com/RadeonOpenCompute/ROCm-Device-Libs/archive/rocm-{0}.tar.gz".format(
                d_version
            ),
            sha256=d_shasum,
            when="@{0} +rocm-device-libs".format(d_version),
        )

    resource(
        name="rocm-device-libs",
        placement="rocm-device-libs",
        git="https://github.com/RadeonOpenCompute/ROCm-Device-Libs.git",
        branch="amd-stg-open",
        when="@master +rocm-device-libs",
    )
    for d_version, d_shasum in [
        ("5.7.1", "655e9bfef4b0b6ad3f9b89c934dc0a8377273bb0bccbda6c399ac5d5d2c1c04c"),
        ("5.7.0", "2c56ec5c78a36f2b847afd4632cb25dbf6ecc58661eb2ae038c2552342e6ce23"),
        ("5.6.1", "4de9a57c2092edf9398d671c8a2c60626eb7daf358caf710da70d9c105490221"),
        ("5.6.0", "30875d440df9d8481ffb24d87755eae20a0efc1114849a72619ea954f1e9206c"),
    ]:
        resource(
            name="hsa-runtime",
            placement="hsa-runtime",
            url=f"https://github.com/RadeonOpenCompute/ROCR-Runtime/archive/rocm-{d_version}.tar.gz",
            sha256=d_shasum,
            when="@{0}".format(d_version),
        )
    resource(
        name="hsa-runtime",
        placement="hsa-runtime",
        git="https://github.com/RadeonOpenCompute/ROCR-Runtime.git",
        branch="master",
        when="@master",
    )

    for d_version, d_shasum in [
        ("5.7.1", "3b9433b4a0527167c3e9dfc37a3c54e0550744b8d4a8e1be298c8d4bcedfee7c"),
        ("5.7.0", "e234bcb93d602377cfaaacb59aeac5796edcd842a618162867b7e670c3a2c42c"),
        ("5.6.1", "0a85d84619f98be26ca7a32c71f94ed3c4e9866133789eabb451be64ce739300"),
        ("5.6.0", "9396a7238b547ee68146c669b10b9d5de8f1d76527c649133c75d8076a185a72"),
    ]:
        resource(
            name="comgr",
            placement="comgr",
            url=f"https://github.com/RadeonOpenCompute/ROCm-CompilerSupport/archive/rocm-{d_version}.tar.gz",
            sha256=d_shasum,
            when="@{0}".format(d_version),
        )
    resource(
        name="comgr",
        placement="comgr",
        git="https://github.com/RadeonOpenCompute/ROCm-CompilerSupport.git",
        branch="amd-stg-open",
        when="@master",
    )

    def cmake_args(self):
        llvm_projects = ["clang", "lld", "clang-tools-extra", "compiler-rt"]
        llvm_runtimes = []
        args = []
        if self.spec.satisfies("@4.3.0:"):
            args = [
                self.define("LLVM_ENABLE_Z3_SOLVER", "OFF"),
                self.define("LLLVM_ENABLE_ZLIB", "ON"),
                self.define("CLANG_DEFAULT_LINKER", "lld"),
                self.define("LIBCXX_ENABLE_SHARED", "OFF"),
                self.define("LIBCXX_ENABLE_STATIC", "ON"),
                self.define("LIBCXX_INSTALL_LIBRARY", "OFF"),
                self.define("LIBCXX_INSTALL_HEADERS", "OFF"),
                self.define("LIBCXXABI_ENABLE_SHARED", "OFF"),
                self.define("LIBCXXABI_ENABLE_STATIC", "ON"),
                self.define("LIBCXXABI_INSTALL_STATIC_LIBRARY", "OFF"),
            ]
        args.append(self.define("LLVM_ENABLE_RTTI", "ON"))
        if self.spec.satisfies("@4.3.0:4.5.2"):
            llvm_projects.append("libcxx")
            llvm_projects.append("libcxxabi")
        if self.spec.satisfies("@5.0.0:"):
            llvm_runtimes.append("libcxx")
            llvm_runtimes.append("libcxxabi")
            args.append(self.define("LLVM_TARGETS_TO_BUILD", "AMDGPU;X86"))
            args.append(self.define("LLVM_AMDGPU_ALLOW_NPI_TARGETS", "ON"))
            args.extend([self.define("LLVM_ENABLE_RUNTIMES", ";".join(llvm_runtimes))])
        if "+openmp" in self.spec:
            llvm_projects.append("openmp")

        args.extend([self.define("LLVM_ENABLE_PROJECTS", ";".join(llvm_projects))])

        if self.spec.satisfies("@4.5.0:"):
            args.append(self.define("PACKAGE_VENDOR", "AMD"))

        if self.spec.satisfies("@5.0.0:"):
            args.append(self.define("CLANG_ENABLE_AMDCLANG", "ON"))
        if self.spec.satisfies("@5.3.0:"):
            args.append(self.define("LLVM_TARGETS_TO_BUILD", "AMDGPU;X86"))
            args.append(self.define("LLLVM_AMDGPU_ALLOW_NPI_TARGETS", True))
        # Enable rocm-device-libs as a external project
        if "+rocm-device-libs" in self.spec:
            dir = os.path.join(self.stage.source_path, "rocm-device-libs")
            args.extend(
                [
                    self.define("LLVM_EXTERNAL_PROJECTS", "device-libs"),
                    self.define("LLVM_EXTERNAL_DEVICE_LIBS_SOURCE_DIR", dir),
                ]
            )

        if "+llvm_dylib" in self.spec:
            args.append("-DLLVM_BUILD_LLVM_DYLIB:Bool=ON")

        if "+link_llvm_dylib" in self.spec:
            args.append("-DLLVM_LINK_LLVM_DYLIB:Bool=ON")
            args.append("-DCLANG_LINK_CLANG_DYLIB:Bool=ON")

        # Get the GCC prefix for LLVM.
        if self.compiler.name == "gcc":
            args.append(self.define("GCC_INSTALL_PREFIX", self.compiler.prefix))
        if self.spec.satisfies("@5.4.3:"):
            args.append("-DCMAKE_INSTALL_LIBDIR=lib")
        if self.spec.satisfies("@5.5.0:"):
            args.append("-DCLANG_DEFAULT_RTLIB=compiler-rt")
            args.append("-DCLANG_DEFAULT_UNWINDLIB=libgcc")
        if self.spec.satisfies("@5.5.0:"):
            args.append("-DCLANG_DEFAULT_RTLIB=compiler-rt")
            args.append("-DCLANG_DEFAULT_UNWINDLIB=libgcc")
        if self.spec.satisfies("@5.6.0:"):
            hsainc_path = os.path.join(self.stage.source_path, "hsa-runtime/src/inc")
            comgrinc_path = os.path.join(self.stage.source_path, "comgr/lib/comgr/include")
            args.append("-DSANITIZER_HSA_INCLUDE_PATH={0}".format(hsainc_path))
            args.append("-DSANITIZER_COMGR_INCLUDE_PATH={0}".format(comgrinc_path))
            args.append("-DSANITIZER_AMDGPU:Bool=ON")
        return args

    @run_after("install")
    def post_install(self):
        # TODO:Enabling LLVM_ENABLE_RUNTIMES for libcxx,libcxxabi did not build.
        # bootstraping the libcxx with the just built clang
        if self.spec.satisfies("@4.5.0:4.5.2"):
            spec = self.spec
            define = self.define
            libcxxdir = "build-bootstrapped-libcxx"
            with working_dir(libcxxdir, create=True):
                cmake_args = [
                    self.stage.source_path + "/libcxx",
                    define("CMAKE_C_COMPILER", spec.prefix.bin + "/clang"),
                    define("CMAKE_CXX_COMPILER", spec.prefix.bin + "/clang++"),
                    define("CMAKE_INSTALL_PREFIX", spec.prefix),
                ]
                cmake_args.extend(self.cmake_args())
                cmake(*cmake_args)
                cmake("--build", ".")

    @classmethod
    def determine_version(cls, path):
        match = re.search(r"amdclang", path)
        detected_version = None
        if match:
            version_query = Executable(path)("--version", output=str)
            match = re.search(r"roc-(\d)\.(\d).(\d)", version_query)
            if match:
                detected_version = "{0}.{1}.{2}".format(
                    int(match.group(1)), int(match.group(2)), int(match.group(3))
                )
        return detected_version

    # Make sure that the compiler paths are in the LD_LIBRARY_PATH
    def setup_run_environment(self, env):
        llvm_amdgpu_home = self.spec["llvm-amdgpu"].prefix
        env.prepend_path("LD_LIBRARY_PATH", llvm_amdgpu_home + "/llvm/lib")

    # Make sure that the compiler paths are in the LD_LIBRARY_PATH
    def setup_dependent_run_environment(self, env, dependent_spec):
        llvm_amdgpu_home = self.spec["llvm-amdgpu"].prefix
        env.prepend_path("LD_LIBRARY_PATH", llvm_amdgpu_home + "/llvm/lib")