Skip to content

Update NSVHMEM block for new releases on Github #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mhrywniak wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update NSVHMEM block for new releases on Github #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ba2b6b
Update NSVHMEM block for GH release, fix MPI
mhrywniak Apr 24, 2026
759cc07
Update NVSHMEM test
mhrywniak Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions hpccm/building_blocks/nvshmem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@
import os
import posixpath

from packaging.version import Version

import hpccm.templates.downloader
import hpccm.templates.envvars
import hpccm.templates.ldconfig
Expand Down Expand Up @@ -71,8 +73,10 @@ class nvshmem(bb_base, hpccm.templates.downloader, hpccm.templates.envvars,
`LD_LIBRARY_PATH` is modified to include the NVSHMEM library
directory. The default value is False.

mpi: Flag to specify the path to the MPI installation. The
default is empty, i.e., do not build NVSHMEM with MPI support.
mpi: Flag to enable MPI support. If True, enables MPI and relies
on CMake's FindMPI to locate the installation. If a string, uses
the value as the MPI installation path (MPI_HOME). The default is
empty, i.e., do not build NVSHMEM with MPI support.

ospackages: List of OS packages to install prior to building. The
default values are `make` and `wget`.
Expand Down Expand Up @@ -115,6 +119,12 @@ def __init__(self, **kwargs):
self.__download()
kwargs['url'] = self.url

# GitHub release tarballs use paths like .../v3.6.5-0.tar.gz; tar strips the
# extension but the top-level directory is nvshmem-3.6.5-0, not v3.6.5-0.
if (kwargs.get('directory') is None and self.url
and 'github.com/NVIDIA/nvshmem' in self.url):
kwargs['directory'] = 'nvshmem-{0}'.format(self.__version)

# Setup the environment variables
self.environment_variables['CPATH'] = '{}:$CPATH'.format(
posixpath.join(self.__prefix, 'include'))
Expand All @@ -134,6 +144,15 @@ def __init__(self, **kwargs):
# Set the build options
self.__configure()

# Ensure cuda/lib64 can be found, build environment needs LD_LIBRARY_PATH
if self.__mpi and self.__cuda:
be = kwargs.get('build_environment', {})
cuda_lib = posixpath.join(self.__cuda, 'lib64')
existing = be.get('LD_LIBRARY_PATH', '')
if cuda_lib not in existing:
be['LD_LIBRARY_PATH'] = '{}:{}'.format(cuda_lib, existing).rstrip(':')
kwargs['build_environment'] = be

self.__bb = generic_cmake(
cmake_opts=self.__cmake_opts,
comment=False,
Expand Down Expand Up @@ -161,20 +180,27 @@ def __configure(self):
self.__cmake_opts.append('-DGDRCOPY_HOME={}'.format(self.__gdrcopy))

if self.__mpi:
self.__cmake_opts.append('-DNVSHMEM_MPI_SUPPORT=1')
self.__cmake_opts.append('-DMPI_HOME={}'.format(self.__mpi))
#else:
# self.__cmake_opts.append('-DNVSHMEM_MPI_SUPPORT=0')
Copy link
Copy Markdown
Collaborator

@samcmill samcmill Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the else branch still needed? Or does NVSHMEM now default to that case?

Copy link
Copy Markdown
Author

@mhrywniak mhrywniak Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point - I will double-check the default, but I think the else can go away.

self.__cmake_opts.append('-DNVSHMEM_MPI_SUPPORT=ON')
if isinstance(self.__mpi, str):
self.__cmake_opts.append('-DMPI_HOME={}'.format(self.__mpi))

if self.__shmem:
self.__cmake_opts.append('-DNVSHMEM_SHMEM_SUPPORT=1')
self.__cmake_opts.append('-DSHMEM_HOME={}'.format(self.__shmem))

# First NVSHMEM version published as a GitHub release tarball
__github_min_version = Version('3.4.5')

def __download(self):
"""Set download source based on user parameters"""

if not self.package and not self.repository and not self.url:
self.url = 'https://developer.download.nvidia.com/compute/redist/nvshmem/{0}/source/nvshmem_src_{1}.txz'.format(self.__version.split('-')[0], self.__version)
v = Version(self.__version.split('-')[0])
if v >= self.__github_min_version:
tag = self.__version if self.__version.startswith('v') else 'v{}'.format(self.__version)
self.url = 'https://github.com/NVIDIA/nvshmem/archive/refs/tags/{}.tar.gz'.format(tag)
else:
self.url = 'https://developer.download.nvidia.com/compute/redist/nvshmem/{0}/source/nvshmem_src_{1}.txz'.format(self.__version.split('-')[0], self.__version)

def runtime(self, _from='0'):
"""Generate the set of instructions to install the runtime specific
Expand Down
2 changes: 1 addition & 1 deletion test/test_nvshmem.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ def test_cmake_options_centos(self):
rm -rf /var/cache/yum/*
RUN mkdir -p /var/tmp && wget -q -nc -P /var/tmp https://developer.download.nvidia.com/compute/redist/nvshmem/2.9.0/source/nvshmem_src_2.9.0-2.txz && \
mkdir -p /var/tmp && tar -x -f /var/tmp/nvshmem_src_2.9.0-2.txz -C /var/tmp -J && \
mkdir -p /var/tmp/nvshmem_src_2.9.0-2/build && cd /var/tmp/nvshmem_src_2.9.0-2/build && cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nvshmem -DNVSHMEM_USE_NCCL=1 -DNVSHMEM_UCX_SUPPORT=1 -DNVSHMEM_BUILD_EXAMPLES=OFF -DNVSHMEM_BUILD_PACKAGES=OFF -DNVSHMEM_BUILD_DEB_PACKAGES=OFF -DNVSHMEM_BUILD_RPM_PACKAGES=OFF -DCUDA_HOME=/usr/local/cuda -DGDRCOPY_HOME=/usr/local/gdrcopy -DNVSHMEM_MPI_SUPPORT=1 -DMPI_HOME=/usr/local/openmpi -DNVSHMEM_SHMEM_SUPPORT=1 -DSHMEM_HOME=/usr/local/openmpi /var/tmp/nvshmem_src_2.9.0-2 && \
mkdir -p /var/tmp/nvshmem_src_2.9.0-2/build && cd /var/tmp/nvshmem_src_2.9.0-2/build && LD_LIBRARY_PATH=/usr/local/cuda/lib64 cmake -DCMAKE_INSTALL_PREFIX=/usr/local/nvshmem -DNVSHMEM_USE_NCCL=1 -DNVSHMEM_UCX_SUPPORT=1 -DNVSHMEM_BUILD_EXAMPLES=OFF -DNVSHMEM_BUILD_PACKAGES=OFF -DNVSHMEM_BUILD_DEB_PACKAGES=OFF -DNVSHMEM_BUILD_RPM_PACKAGES=OFF -DCUDA_HOME=/usr/local/cuda -DGDRCOPY_HOME=/usr/local/gdrcopy -DNVSHMEM_MPI_SUPPORT=ON -DMPI_HOME=/usr/local/openmpi -DNVSHMEM_SHMEM_SUPPORT=1 -DSHMEM_HOME=/usr/local/openmpi /var/tmp/nvshmem_src_2.9.0-2 && \
cmake --build /var/tmp/nvshmem_src_2.9.0-2/build --target all -- -j$(nproc) && \
cmake --build /var/tmp/nvshmem_src_2.9.0-2/build --target install -- -j$(nproc) && \
rm -rf /var/tmp/nvshmem_src_2.9.0-2 /var/tmp/nvshmem_src_2.9.0-2.txz
Expand Down
Loading