spack/var/spack/repos/spack_repo/builtin/packages/caliper/package.py
pauleonix 4d55fe6284
cuda: add v12.9 and new Blackwell targets (#50284)
* cuda: Add 12.9 and new Blackwell targets

Including family-specific architecture features like sm_100f

* tau, caliper: Add cuda v12.9 conflict

Legacy nvtx was dropped.

* petsc: "libnvToolsExt.a" -> "libnvtx3interop.a" for cuda@12.9: and petsc@:3.23.1

* legion: Add upper bound to cuda version range

Avoid build failure due to CUDA driver API incompatibility.
See https://github.com/StanfordLegion/legion/issues/1864

---------

Co-authored-by: Satish Balay <balay@mcs.anl.gov>
2025-05-16 15:17:50 +02:00

307 lines
12 KiB
Python

# Copyright Spack Project Developers. See COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import os
import socket
import sys
from spack.package import *
class Caliper(CachedCMakePackage, CudaPackage, ROCmPackage):
"""Caliper is a program instrumentation and performance measurement
framework. It is designed as a performance analysis toolbox in a
library, allowing one to bake performance analysis capabilities
directly into applications and activate them at runtime.
"""
homepage = "https://github.com/LLNL/Caliper"
git = "https://github.com/LLNL/Caliper.git"
url = "https://github.com/LLNL/Caliper/archive/v2.12.1.tar.gz"
tags = ["e4s", "radiuss"]
maintainers("daboehme", "adrienbernede")
test_requires_compiler = True
license("BSD-3-Clause")
version("master", branch="master")
version("2.12.1", sha256="2b5a8f98382c94dc75cc3f4517c758eaf9a3f9cea0a8dbdc7b38506060d6955c")
version("2.11.0", sha256="b86b733cbb73495d5f3fe06e6a9885ec77365c8aa9195e7654581180adc2217c")
version("2.10.0", sha256="14c4fb5edd5e67808d581523b4f8f05ace8549698c0e90d84b53171a77f58565")
version("2.9.1", sha256="4771d630de505eff9227e0ec498d0da33ae6f9c34df23cb201b56181b8759e9e")
version("2.9.0", sha256="507ea74be64a2dfd111b292c24c4f55f459257528ba51a5242313fa50978371f")
version(
"2.8.0",
sha256="17807b364b5ac4b05997ead41bd173e773f9a26ff573ff2fe61e0e70eab496e4",
deprecated=True,
)
version(
"2.7.0",
sha256="b3bf290ec2692284c6b4f54cc0c507b5700c536571d3e1a66e56626618024b2b",
deprecated=True,
)
version(
"2.6.0",
sha256="6efcd3e4845cc9a6169e0d934840766b12182c6d09aa3ceca4ae776e23b6360f",
deprecated=True,
)
version(
"2.5.0",
sha256="d553e60697d61c53de369b9ca464eb30710bda90fba9671201543b64eeac943c",
deprecated=True,
)
version(
"2.4.0", tag="v2.4.0", commit="30577b4b8beae104b2b35ed487fec52590a99b3d", deprecated=True
)
version(
"2.3.0", tag="v2.3.0", commit="9fd89bb0120750d1f9dfe37bd963e24e478a2a20", deprecated=True
)
version(
"2.2.0", tag="v2.2.0", commit="c408e9b3642c7aa80eff37b0826d819c57e7bc04", deprecated=True
)
version(
"2.1.1", tag="v2.1.1", commit="0593b0e01c1d8d3e50c990399cc0fee403485599", deprecated=True
)
version(
"2.0.1", tag="v2.0.1", commit="4d7ff46381c53a461e62edd949e2d9dea9db7b08", deprecated=True
)
version(
"1.9.1", tag="v1.9.1", commit="cfc1defbbee20b50dd3e3477badd09a92b1df970", deprecated=True
)
version(
"1.9.0", tag="v1.9.0", commit="8356e747349b285aa621c5b74e71559f0babc4a1", deprecated=True
)
version(
"1.8.0", tag="v1.8.0", commit="117c1ef596b617dc71407b8b67eebef094a654f8", deprecated=True
)
version(
"1.7.0", tag="v1.7.0", commit="898277c93d884d4e7ca1ffcf3bbea81d22364f26", deprecated=True
)
is_linux = sys.platform.startswith("linux")
variant("shared", default=True, description="Build shared libraries")
variant("adiak", default=True, description="Enable Adiak support")
variant("mpi", default=True, description="Enable MPI support")
# libunwind has some issues on Mac
variant(
"libunwind", default=sys.platform != "darwin", description="Enable stack unwind support"
)
variant("libdw", default=is_linux, description="Enable DWARF symbol lookup")
# pthread_self() signature is incompatible with PAPI_thread_init() on Mac
variant("papi", default=sys.platform != "darwin", description="Enable PAPI service")
variant("libpfm", default=False, description="Enable libpfm (perf_events) service")
# Gotcha is Linux-only
variant("gotcha", default=is_linux, description="Enable GOTCHA support")
variant("sampler", default=is_linux, description="Enable sampling support on Linux")
variant("sosflow", default=False, description="Enable SOSflow support")
variant("fortran", default=False, description="Enable Fortran support")
variant("variorum", default=False, description="Enable Variorum support")
variant("vtune", default=False, description="Enable Intel Vtune support")
variant("kokkos", default=True, when="@2.3.0:", description="Enable Kokkos profiling support")
variant("tests", default=False, description="Enable tests")
variant("tools", default=True, description="Enable tools")
variant("python", default=False, when="@v2.12:", description="Build Python bindings")
depends_on("c", type="build") # generated
depends_on("cxx", type="build") # generated
depends_on("fortran", type="build") # generated
depends_on("adiak@0.1:0", when="@2.2:2.10 +adiak")
depends_on("adiak@0.4:0", when="@2.11: +adiak")
depends_on("papi@5.3:5", when="@:2.2 +papi")
depends_on("papi@5.3:", when="@2.3: +papi")
depends_on("libpfm4@4.8:4", when="+libpfm")
depends_on("mpi", when="+mpi")
depends_on("unwind@1.2:1", when="+libunwind")
depends_on("elfutils", when="+libdw")
depends_on("variorum", when="+variorum")
depends_on("intel-oneapi-vtune", when="+vtune")
depends_on("sosflow@spack", when="@1.0:1+sosflow")
depends_on("cmake", type="build")
depends_on("python", type="build")
depends_on("python@3", when="+python", type=("build", "link", "run"))
depends_on("py-pybind11", when="+python", type=("build", "link", "run"))
# sosflow support not yet in 2.0
conflicts("+sosflow", "@2:")
conflicts("+adiak", "@:2.1")
conflicts("+libdw", "@:2.4")
conflicts("+rocm", "@:2.7")
conflicts("+rocm+cuda")
# Legacy nvtx is only supported until cuda@12.8, newer cuda only provides nvtx3.
conflicts("^cuda@12.9:", "@:2.12.1")
patch("for_aarch64.patch", when="@:2.11 target=aarch64:")
patch(
"sampler-service-missing-libunwind-include-dir.patch",
when="@2.9.0:2.9.1 +libunwind +sampler",
)
def _get_sys_type(self, spec):
sys_type = spec.architecture
if "SYS_TYPE" in env:
sys_type = env["SYS_TYPE"]
return sys_type
@property
def cache_name(self):
hostname = socket.gethostname()
if "SYS_TYPE" in env:
hostname = hostname.rstrip("1234567890")
return "{0}-{1}-{2}@{3}-{4}.cmake".format(
hostname,
self._get_sys_type(self.spec),
self.spec.compiler.name,
self.spec.compiler.version,
self.spec.dag_hash(8),
)
def initconfig_compiler_entries(self):
spec = self.spec
entries = super().initconfig_compiler_entries()
if spec.satisfies("+rocm"):
entries.insert(0, cmake_cache_path("CMAKE_CXX_COMPILER", spec["hip"].hipcc))
entries.append(cmake_cache_option("WITH_FORTRAN", spec.satisfies("+fortran")))
entries.append(cmake_cache_option("BUILD_SHARED_LIBS", spec.satisfies("+shared")))
entries.append(cmake_cache_option("BUILD_TESTING", spec.satisfies("+tests")))
entries.append(cmake_cache_option("WITH_TOOLS", spec.satisfies("+tools")))
entries.append(cmake_cache_option("BUILD_DOCS", False))
entries.append(cmake_cache_path("PYTHON_EXECUTABLE", spec["python"].command.path))
return entries
def initconfig_hardware_entries(self):
spec = self.spec
entries = super().initconfig_hardware_entries()
if spec.satisfies("+cuda"):
entries.append(cmake_cache_option("WITH_CUPTI", True))
entries.append(cmake_cache_option("WITH_NVTX", True))
entries.append(cmake_cache_path("CUDA_TOOLKIT_ROOT_DIR", spec["cuda"].prefix))
entries.append(cmake_cache_path("CUPTI_PREFIX", spec["cuda"].prefix))
else:
entries.append(cmake_cache_option("WITH_CUPTI", False))
entries.append(cmake_cache_option("WITH_NVTX", False))
if spec.satisfies("+rocm"):
entries.append(cmake_cache_option("WITH_ROCTRACER", True))
entries.append(cmake_cache_option("WITH_ROCTX", True))
else:
entries.append(cmake_cache_option("WITH_ROCTRACER", False))
entries.append(cmake_cache_option("WITH_ROCTX", False))
return entries
def initconfig_mpi_entries(self):
spec = self.spec
entries = super().initconfig_mpi_entries()
entries.append(cmake_cache_option("WITH_MPI", spec.satisfies("+mpi")))
return entries
def initconfig_package_entries(self):
spec = self.spec
entries = []
# TPL locations
entries.append("#------------------{0}".format("-" * 60))
entries.append("# TPLs")
entries.append("#------------------{0}\n".format("-" * 60))
if spec.satisfies("+adiak"):
entries.append(cmake_cache_path("adiak_DIR", spec["adiak"].prefix))
if spec.satisfies("+papi"):
entries.append(cmake_cache_path("PAPI_PREFIX", spec["papi"].prefix))
if spec.satisfies("+libdw"):
entries.append(cmake_cache_path("LIBDW_PREFIX", spec["elfutils"].prefix))
if spec.satisfies("+libpfm"):
entries.append(cmake_cache_path("LIBPFM_INSTALL", spec["libpfm4"].prefix))
if spec.satisfies("+sosflow"):
entries.append(cmake_cache_path("SOS_PREFIX", spec["sosflow"].prefix))
if spec.satisfies("+variorum"):
entries.append(cmake_cache_path("VARIORUM_PREFIX", spec["variorum"].prefix))
if spec.satisfies("+vtune"):
itt_dir = join_path(spec["intel-oneapi-vtune"].prefix, "vtune", "latest")
entries.append(cmake_cache_path("ITT_PREFIX", itt_dir))
if spec.satisfies("+libunwind"):
entries.append(cmake_cache_path("LIBUNWIND_PREFIX", spec["unwind"].prefix))
# Build options
entries.append("#------------------{0}".format("-" * 60))
entries.append("# Build Options")
entries.append("#------------------{0}\n".format("-" * 60))
entries.append(cmake_cache_option("WITH_ADIAK", spec.satisfies("+adiak")))
entries.append(cmake_cache_option("WITH_GOTCHA", spec.satisfies("+gotcha")))
entries.append(cmake_cache_option("WITH_SAMPLER", spec.satisfies("+sampler")))
entries.append(cmake_cache_option("WITH_PAPI", spec.satisfies("+papi")))
entries.append(cmake_cache_option("WITH_LIBDW", spec.satisfies("+libdw")))
entries.append(cmake_cache_option("WITH_LIBPFM", spec.satisfies("+libpfm")))
entries.append(cmake_cache_option("WITH_SOSFLOW", spec.satisfies("+sosflow")))
entries.append(cmake_cache_option("WITH_KOKKOS", spec.satisfies("+kokkos")))
entries.append(cmake_cache_option("WITH_VARIORUM", spec.satisfies("+variorum")))
entries.append(cmake_cache_option("WITH_VTUNE", spec.satisfies("+vtune")))
entries.append(cmake_cache_option("WITH_PYTHON_BINDINGS", spec.satisfies("+python")))
# -DWITH_CALLPATH was renamed -DWITH_LIBUNWIND in 2.5
callpath_flag = "LIBUNWIND" if spec.satisfies("@2.5:") else "CALLPATH"
entries.append(cmake_cache_option("WITH_%s" % callpath_flag, spec.satisfies("+libunwind")))
return entries
def cmake_args(self):
return []
def setup_run_environment(self, env: EnvironmentModifications) -> None:
if self.spec.satisfies("+python"):
env.prepend_path("PYTHONPATH", self.spec.prefix.join(python_platlib))
env.prepend_path("PYTHONPATH", self.spec.prefix.join(python_purelib))
@run_after("install")
def cache_test_sources(self):
"""Copy the example source files after the package is installed to an
install test subdirectory for use during `spack test run`."""
cache_extra_test_sources(self, [join_path("examples", "apps")])
def test_cxx_example(self):
"""build and run cxx-example"""
exe = "cxx-example"
source_file = "{0}.cpp".format(exe)
source_path = find_required_file(
self.test_suite.current_test_cache_dir, source_file, expected=1, recursive=True
)
lib_dir = self.prefix.lib if os.path.exists(self.prefix.lib) else self.prefix.lib64
cxx = which(os.environ["CXX"])
test_dir = os.path.dirname(source_path)
with working_dir(test_dir):
cxx(
"-L{0}".format(lib_dir),
"-I{0}".format(self.prefix.include),
source_path,
"-o",
exe,
"-std=c++11",
"-lcaliper",
"-lstdc++",
)
cxx_example = which(exe)
cxx_example()