spack/var/spack/repos/builtin/packages/kokkos/package.py
2025-01-28 09:45:43 +01:00

548 lines
21 KiB
Python

# Copyright Spack Project Developers. See COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import os
import llnl.util.lang as lang
import spack.build_systems.cmake
from spack.package import *
class Kokkos(CMakePackage, CudaPackage, ROCmPackage):
"""Kokkos implements a programming model in C++ for writing performance
portable applications targeting all major HPC platforms."""
homepage = "https://github.com/kokkos/kokkos"
git = "https://github.com/kokkos/kokkos.git"
url = "https://github.com/kokkos/kokkos/releases/download/4.4.01/kokkos-4.4.01.tar.gz"
tags = ["e4s"]
test_requires_compiler = True
maintainers("cedricchevalier19", "nmm0", "lucbv")
license("Apache-2.0 WITH LLVM-exception")
version("master", branch="master")
version("develop", branch="develop")
version("4.5.01", sha256="52d003ffbbe05f30c89966e4009c017efb1662b02b2b73190670d3418719564c")
version("4.5.00", sha256="cbfb742feeb9e649db9eca0394e6ca9a22aa017a1e6aab8576990772a0e3135b")
version("4.4.01", sha256="3413f0cb39912128d91424ebd92e8832009e7eeaf6fa8da58e99b0d37860d972")
version("4.4.00", sha256="0b46372f38c48aa088411ac1b7c173a5c90f0fdb69ab40271827688fc134f58b")
version(
"4.3.01",
sha256="5998b7c732664d6b5e219ccc445cd3077f0e3968b4be480c29cd194b4f45ec70",
url="https://github.com/kokkos/kokkos/archive/4.3.01.tar.gz",
)
version(
"4.3.00",
sha256="53cf30d3b44dade51d48efefdaee7a6cf109a091b702a443a2eda63992e5fe0d",
url="https://github.com/kokkos/kokkos/archive/4.3.00.tar.gz",
)
version(
"4.2.01",
sha256="cbabbabba021d00923fb357d2e1b905dda3838bd03c885a6752062fe03c67964",
url="https://github.com/kokkos/kokkos/archive/4.2.01.tar.gz",
)
version(
"4.2.00",
sha256="ac08765848a0a6ac584a0a46cd12803f66dd2a2c2db99bb17c06ffc589bf5be8",
url="https://github.com/kokkos/kokkos/archive/4.2.00.tar.gz",
)
version(
"4.1.00",
sha256="cf725ea34ba766fdaf29c884cfe2daacfdc6dc2d6af84042d1c78d0f16866275",
url="https://github.com/kokkos/kokkos/archive/4.1.00.tar.gz",
)
version(
"4.0.01",
sha256="bb942de8afdd519fd6d5d3974706bfc22b6585a62dd565c12e53bdb82cd154f0",
url="https://github.com/kokkos/kokkos/archive/4.0.01.tar.gz",
)
version(
"4.0.00",
sha256="1829a423883d4b44223c7c3a53d3c51671145aad57d7d23e6a1a4bebf710dcf6",
url="https://github.com/kokkos/kokkos/archive/4.0.00.tar.gz",
)
version(
"3.7.02",
sha256="5024979f06bc8da2fb696252a66297f3e0e67098595a0cc7345312b3b4aa0f54",
url="https://github.com/kokkos/kokkos/archive/3.7.02.tar.gz",
)
version(
"3.7.01",
sha256="0481b24893d1bcc808ec68af1d56ef09b82a1138a1226d6be27c3b3c3da65ceb",
url="https://github.com/kokkos/kokkos/archive/3.7.01.tar.gz",
)
version(
"3.7.00",
sha256="62e3f9f51c798998f6493ed36463f66e49723966286ef70a9dcba329b8443040",
url="https://github.com/kokkos/kokkos/archive/3.7.00.tar.gz",
)
version(
"3.6.01",
sha256="1b80a70c5d641da9fefbbb652e857d7c7a76a0ebad1f477c253853e209deb8db",
url="https://github.com/kokkos/kokkos/archive/3.6.01.tar.gz",
)
version(
"3.6.00",
sha256="53b11fffb53c5d48da5418893ac7bc814ca2fde9c86074bdfeaa967598c918f4",
url="https://github.com/kokkos/kokkos/archive/3.6.00.tar.gz",
)
version(
"3.5.00",
sha256="748f06aed63b1e77e3653cd2f896ef0d2c64cb2e2d896d9e5a57fec3ff0244ff",
url="https://github.com/kokkos/kokkos/archive/3.5.00.tar.gz",
)
version(
"3.4.01",
sha256="146d5e233228e75ef59ca497e8f5872d9b272cb93e8e9cdfe05ad34a23f483d1",
url="https://github.com/kokkos/kokkos/archive/3.4.01.tar.gz",
)
version(
"3.4.00",
sha256="2e4438f9e4767442d8a55e65d000cc9cde92277d415ab4913a96cd3ad901d317",
url="https://github.com/kokkos/kokkos/archive/3.4.00.tar.gz",
)
version(
"3.3.01",
sha256="4919b00bb7b6eb80f6c335a32f98ebe262229d82e72d3bae6dd91aaf3d234c37",
url="https://github.com/kokkos/kokkos/archive/3.3.01.tar.gz",
)
version(
"3.3.00",
sha256="170b9deaa1943185e928f8fcb812cd4593a07ed7d220607467e8f0419e147295",
url="https://github.com/kokkos/kokkos/archive/3.3.00.tar.gz",
)
version(
"3.2.01",
sha256="9e27a3d8f81559845e190d60f277d84d6f558412a3df3301d9545e91373bcaf1",
url="https://github.com/kokkos/kokkos/archive/3.2.01.tar.gz",
)
version(
"3.2.00",
sha256="05e1b4dd1ef383ca56fe577913e1ff31614764e65de6d6f2a163b2bddb60b3e9",
url="https://github.com/kokkos/kokkos/archive/3.2.00.tar.gz",
)
version(
"3.1.01",
sha256="ff5024ebe8570887d00246e2793667e0d796b08c77a8227fe271127d36eec9dd",
url="https://github.com/kokkos/kokkos/archive/3.1.01.tar.gz",
)
version(
"3.1.00",
sha256="b935c9b780e7330bcb80809992caa2b66fd387e3a1c261c955d622dae857d878",
url="https://github.com/kokkos/kokkos/archive/3.1.00.tar.gz",
)
version(
"3.0.00",
sha256="c00613d0194a4fbd0726719bbed8b0404ed06275f310189b3493f5739042a92b",
url="https://github.com/kokkos/kokkos/archive/3.0.00.tar.gz",
)
depends_on("c", type="build")
depends_on("cxx", type="build") # Kokkos requires a C++ compiler
depends_on("cmake@3.16:", type="build")
conflicts("cmake@3.28", when="@:4.2.01 +cuda")
devices_variants = {
"cuda": [False, "Whether to build CUDA backend"],
"openmp": [False, "Whether to build OpenMP backend"],
"threads": [False, "Whether to build the C++ threads backend"],
"serial": [True, "Whether to build serial backend"],
"rocm": [False, "Whether to build HIP backend"],
"sycl": [False, "Whether to build the SYCL backend"],
"openmptarget": [False, "Whether to build the OpenMPTarget backend"],
}
conflicts("+rocm", when="@:3.0")
conflicts("+sycl", when="@:3.3")
conflicts("+openmptarget", when="@:3.5")
conflicts(
"".join([f"~{d}" for d in devices_variants]),
msg="Kokkos requires at least one active backend",
)
# https://github.com/spack/spack/issues/29052
conflicts("@:3.5 +sycl", when="%oneapi@2022:")
tpls_variants = {
"hpx": [False, "Whether to enable the HPX library"],
"hwloc": [False, "Whether to enable the HWLOC library"],
"numactl": [False, "Whether to enable the LIBNUMA library"],
"memkind": [False, "Whether to enable the MEMKIND library"],
}
options_variants = {
"aggressive_vectorization": [False, "Aggressively vectorize loops"],
"compiler_warnings": [False, "Print all compiler warnings"],
"complex_align": [True, "Align complex numbers"],
"cuda_constexpr": [False, "Activate experimental constexpr features"],
"cuda_lambda": [False, "Activate experimental lambda features"],
"cuda_ldg_intrinsic": [False, "Use CUDA LDG intrinsics"],
"cuda_relocatable_device_code": [False, "Enable RDC for CUDA"],
"hip_relocatable_device_code": [False, "Enable RDC for HIP"],
"cuda_uvm": [False, "Enable unified virtual memory (UVM) for CUDA"],
"debug": [False, "Activate extra debug features - may increase compiletimes"],
"debug_bounds_check": [False, "Use bounds checking - will increase runtime"],
"debug_dualview_modify_check": [False, "Debug check on dual views"],
"deprecated_code": [False, "Whether to enable deprecated code"],
"examples": [False, "Whether to build examples"],
"hpx_async_dispatch": [False, "Whether HPX supports asynchronous dispath"],
"tuning": [False, "Create bindings for tuning tools"],
"tests": [False, "Build for tests"],
}
spack_micro_arch_map = {
"thunderx2": "THUNDERX2",
"zen": "ZEN",
"zen2": "ZEN2",
"zen3": "ZEN3",
"steamroller": "KAVERI",
"excavator": "CARIZO",
"power7": "POWER7",
"power8": "POWER8",
"power9": "POWER9",
"power8le": "POWER8",
"power9le": "POWER9",
"sandybridge": "SNB",
"haswell": "HSW",
"mic_knl": "KNL",
"cannonlake": "SKX",
"cascadelake": "SKX",
"westmere": "WSM",
"ivybridge": "SNB",
"broadwell": "BDW",
# @AndrewGaspar: Kokkos does not have an arch for plain-skylake - only
# for Skylake-X (i.e. Xeon). For now, I'm mapping this to Broadwell
# until Kokkos learns to optimize for SkyLake without the AVX-512
# extensions. SkyLake with AVX-512 will still be optimized using the
# separate `skylake_avx512` arch.
"skylake": "BDW",
"icelake": "SKX",
"skylake_avx512": "SKX",
}
spack_cuda_arch_map = {
"30": "kepler30",
"32": "kepler32",
"35": "kepler35",
"37": "kepler37",
"50": "maxwell50",
"52": "maxwell52",
"53": "maxwell53",
"60": "pascal60",
"61": "pascal61",
"70": "volta70",
"72": "volta72",
"75": "turing75",
"80": "ampere80",
"86": "ampere86",
"89": "ada89",
"90": "hopper90",
}
cuda_arches = spack_cuda_arch_map.values()
conflicts("+cuda", when="cuda_arch=none")
# Kokkos support only one cuda_arch at a time
variant(
"cuda_arch",
description="CUDA architecture",
values=("none",) + CudaPackage.cuda_arch_values,
default="none",
multi=False,
sticky=True,
when="+cuda",
)
amdgpu_arch_map = {
"gfx900": "vega900",
"gfx906": "vega906",
"gfx908": "vega908",
"gfx90a": "vega90A",
"gfx940": "amd_gfx940",
"gfx942": "amd_gfx942",
"gfx1030": "navi1030",
"gfx1100": "navi1100",
}
amd_support_conflict_msg = (
"{0} is not supported; "
"Kokkos supports the following AMD GPU targets: " + ", ".join(amdgpu_arch_map.keys())
)
for arch in ROCmPackage.amdgpu_targets:
if arch not in amdgpu_arch_map:
conflicts(
"+rocm",
when="amdgpu_target={0}".format(arch),
msg=amd_support_conflict_msg.format(arch),
)
intel_gpu_arches = (
"intel_gen",
"intel_gen9",
"intel_gen11",
"intel_gen12lp",
"intel_dg1",
"intel_xehp",
"intel_pvc",
)
variant(
"intel_gpu_arch",
default="none",
values=("none",) + intel_gpu_arches,
description="Intel GPU architecture",
)
for dev, (dflt, desc) in devices_variants.items():
variant(dev, default=dflt, description=desc)
conflicts("+cuda", when="+rocm", msg="CUDA and ROCm are not compatible in Kokkos.")
depends_on("intel-oneapi-dpl", when="+sycl")
depends_on("rocthrust", when="@4.3: +rocm")
for opt, (dflt, desc) in options_variants.items():
variant(opt, default=dflt, description=desc, when=("+cuda" if "cuda" in opt else None))
for tpl, (dflt, desc) in tpls_variants.items():
variant(tpl, default=dflt, description=desc)
depends_on(tpl, when="+%s" % tpl)
variant("wrapper", default=False, description="Use nvcc-wrapper for CUDA build")
variant(
"cmake_lang",
default=False,
description="Use CMake language support for CUDA/HIP",
when="@3.6:",
)
depends_on("kokkos-nvcc-wrapper", when="+wrapper")
depends_on("kokkos-nvcc-wrapper@develop", when="@develop+wrapper")
depends_on("kokkos-nvcc-wrapper@master", when="@master+wrapper")
conflicts("+wrapper", when="~cuda")
conflicts("+wrapper", when="+cmake_lang")
cxxstds = ["11", "14", "17", "20"]
variant("cxxstd", default="17", values=cxxstds, multi=False, description="C++ standard")
variant("pic", default=False, description="Build position independent code")
conflicts("cxxstd=11", when="@3.7:")
conflicts("cxxstd=14", when="@4.0:")
conflicts("+cuda", when="cxxstd=17 ^cuda@:10")
conflicts("+cuda", when="cxxstd=20 ^cuda@:11")
# Expose a way to disable CudaMallocAsync that can cause problems
# with some MPI such as cray-mpich
variant("alloc_async", default=False, description="Use CudaMallocAsync", when="@4.2: +cuda")
# SYCL and OpenMPTarget require C++17 or higher
for cxxstdver in cxxstds[: cxxstds.index("17")]:
conflicts(
"+sycl", when="cxxstd={0}".format(cxxstdver), msg="SYCL requires C++17 or higher"
)
conflicts(
"+openmptarget",
when="cxxstd={0}".format(cxxstdver),
msg="OpenMPTarget requires C++17 or higher",
)
# HPX should use the same C++ standard
for cxxstd in cxxstds:
depends_on("hpx cxxstd={0}".format(cxxstd), when="+hpx cxxstd={0}".format(cxxstd))
# HPX version constraints
depends_on("hpx@:1.6", when="@:3.5 +hpx")
depends_on("hpx@1.7:", when="@3.6: +hpx")
# Patches
patch("hpx_profiling_fences.patch", when="@3.5.00 +hpx")
patch("sycl_bhalft_test.patch", when="@4.2.00 +sycl")
# adds amd_gfx940 support to Kokkos 4.2.00 (upstreamed in https://github.com/kokkos/kokkos/pull/6671)
patch(
"https://github.com/rbberger/kokkos/commit/293319c5844f4d8eea51eb9cd1457115a5016d3f.patch?full_index=1",
sha256="145619e87dbf26b66ea23e76906576e2a854a3b09f2a2dd70363e61419fa6a6e",
when="@4.2.00",
)
variant("shared", default=True, description="Build shared libraries")
# Filter spack-generated files that may include links to the
# spack compiler wrappers
filter_compiler_wrappers("kokkos_launch_compiler", relative_root="bin")
filter_compiler_wrappers(
"KokkosConfigCommon.cmake", relative_root=os.path.join("lib64", "cmake", "Kokkos")
)
# sanity check
sanity_check_is_file = [
join_path("include", "KokkosCore_config.h"),
join_path("include", "Kokkos_Core.hpp"),
]
sanity_check_is_dir = ["bin", "include"]
@classmethod
def get_microarch(cls, target):
"""Get the Kokkos microarch name for a Spack target (spec.target)."""
smam = cls.spack_micro_arch_map
# Find closest ancestor that has a known microarch optimization
if target.name not in smam:
for target in target.ancestors:
if target.name in smam:
break
else:
# No known microarch optimizatinos
return None
return smam[target.name]
def append_args(self, cmake_prefix, cmake_options, spack_options):
variant_to_cmake_option = {"rocm": "hip"}
for variant_name in cmake_options:
opt = variant_to_cmake_option.get(variant_name, variant_name)
optname = f"Kokkos_{cmake_prefix}_{opt.upper()}"
# Explicitly enable or disable
option = self.define_from_variant(optname, variant_name)
if option:
spack_options.append(option)
def setup_dependent_package(self, module, dependent_spec):
try:
self.spec.kokkos_cxx = self.spec["kokkos-nvcc-wrapper"].kokkos_cxx
except Exception:
self.spec.kokkos_cxx = spack_cxx
def cmake_args(self):
spec = self.spec
from_variant = self.define_from_variant
if spec.satisfies("~wrapper+cuda") and not (
spec.satisfies("%clang") or spec.satisfies("%cce") or spec.satisfies("+cmake_lang")
):
raise InstallError(
"Kokkos requires +wrapper when using +cuda without %clang, %cce or +cmake_lang"
)
options = [
from_variant("CMAKE_POSITION_INDEPENDENT_CODE", "pic"),
from_variant("CMAKE_CXX_STANDARD", "cxxstd"),
from_variant("BUILD_SHARED_LIBS", "shared"),
from_variant("Kokkos_ENABLE_COMPILE_AS_CMAKE_LANGUAGE", "cmake_lang"),
]
spack_microarches = []
if spec.satisfies("+cuda"):
if isinstance(spec.variants["cuda_arch"].value, str):
cuda_arch = spec.variants["cuda_arch"].value
else:
if len(spec.variants["cuda_arch"].value) > 1:
msg = "Kokkos supports only one cuda_arch at a time."
raise InstallError(msg)
cuda_arch = spec.variants["cuda_arch"].value[0]
if cuda_arch != "none":
kokkos_arch_name = self.spack_cuda_arch_map[cuda_arch]
spack_microarches.append(kokkos_arch_name)
kokkos_microarch_name = self.get_microarch(spec.target)
if kokkos_microarch_name:
spack_microarches.append(kokkos_microarch_name)
if spec.satisfies("+rocm"):
for amdgpu_target in spec.variants["amdgpu_target"].value:
if amdgpu_target != "none":
if amdgpu_target in self.amdgpu_arch_map:
spack_microarches.append(self.amdgpu_arch_map[amdgpu_target])
else:
# Note that conflict declarations should prevent
# choosing an unsupported AMD GPU target
raise SpackError("Unsupported target: {0}".format(amdgpu_target))
if self.spec.variants["intel_gpu_arch"].value != "none":
spack_microarches.append(self.spec.variants["intel_gpu_arch"].value)
for arch in spack_microarches:
options.append(self.define("Kokkos_ARCH_" + arch.upper(), True))
self.append_args("ENABLE", self.devices_variants.keys(), options)
self.append_args("ENABLE", self.options_variants.keys(), options)
self.append_args("ENABLE", self.tpls_variants.keys(), options)
for tpl in self.tpls_variants:
if spec.variants[tpl].value:
options.append(self.define(tpl + "_DIR", spec[tpl].prefix))
if self.spec.satisfies("+wrapper"):
options.append(
self.define("CMAKE_CXX_COMPILER", self.spec["kokkos-nvcc-wrapper"].kokkos_cxx)
)
elif "+rocm" in self.spec:
if "+cmake_lang" in self.spec:
options.append(
self.define(
"CMAKE_HIP_COMPILER",
join_path(self.spec["llvm-amdgpu"].prefix.bin, "amdclang++"),
)
)
options.append(from_variant("CMAKE_HIP_STANDARD", "cxxstd"))
else:
options.append(self.define("CMAKE_CXX_COMPILER", self.spec["hip"].hipcc))
options.append(self.define("Kokkos_ENABLE_ROCTHRUST", True))
elif "+cuda" in self.spec and "+cmake_lang" in self.spec:
options.append(
self.define("CMAKE_CUDA_COMPILER", join_path(self.spec["cuda"].prefix.bin, "nvcc"))
)
options.append(from_variant("CMAKE_CUDA_STANDARD", "cxxstd"))
if self.spec.satisfies("%oneapi") or self.spec.satisfies("%intel"):
options.append(self.define("CMAKE_CXX_FLAGS", "-fp-model=precise"))
options.append(
self.define_from_variant("Kokkos_ENABLE_IMPL_CUDA_MALLOC_ASYNC", "alloc_async")
)
# Remove duplicate options
return lang.dedupe(options)
test_script_relative_path = join_path("scripts", "spack_test")
@run_after("install")
def setup_build_tests(self):
# Skip if unsupported version
cmake_source_path = join_path(self.stage.source_path, self.test_script_relative_path)
if not os.path.exists(cmake_source_path):
return
"""Copy test."""
cmake_out_path = join_path(self.test_script_relative_path, "out")
cmake_args = [
cmake_source_path,
"-DSPACK_PACKAGE_SOURCE_DIR:PATH={0}".format(self.stage.source_path),
"-DSPACK_PACKAGE_TEST_ROOT_DIR:PATH={0}".format(
join_path(install_test_root(self), cmake_out_path)
),
"-DSPACK_PACKAGE_INSTALL_DIR:PATH={0}".format(self.prefix),
]
cmake(*cmake_args)
cache_extra_test_sources(self, cmake_out_path)
def test_run(self):
"""Test if kokkos builds and runs"""
cmake_path = join_path(
self.test_suite.current_test_cache_dir, self.test_script_relative_path, "out"
)
if not os.path.exists(cmake_path):
raise SkipTest(f"{cmake_path} is missing")
cmake = self.spec["cmake"].command
cmake_args = ["-DEXECUTABLE_OUTPUT_PATH=" + cmake_path]
if self.spec.satisfies("+rocm"):
prefix_paths = ";".join(spack.build_systems.cmake.get_cmake_prefix_path(self))
cmake_args.append("-DCMAKE_PREFIX_PATH={0}".format(prefix_paths))
cmake(cmake_path, *cmake_args)
make = which("make")
make()
make(cmake_path, "test")