spack/var/spack/repos/builtin/packages/upcxx/package.py
Tom Scogland 18c2f1a57a
refactor: packages import spack.package explicitly (#30404)
Explicitly import package utilities in all packages, and corresponding fallout.

This includes:

* rename `spack.package` to `spack.package_base`
* rename `spack.pkgkit` to `spack.package`
* update all packages in builtin, builtin_mock and tutorials to include `from spack.package import *`
* update spack style
  * ensure packages include the import
  * automatically add the new import and remove any/all imports of `spack` and `spack.pkgkit`
    from packages when using `--fix`
  * add support for type-checking packages with mypy when SPACK_MYPY_CHECK_PACKAGES
    is set in the environment
* fix all type checking errors in packages in spack upstream
* update spack create to include the new imports
* update spack repo to inject the new import, injection persists to allow for a deprecation period

Original message below:
 
As requested @adamjstewart, update all packages to use pkgkit.  I ended up using isort to do this,
so repro is easy:

```console
$ isort -a 'from spack.pkgkit import *' --rm 'spack' ./var/spack/repos/builtin/packages/*/package.py
$ spack style --fix
```

There were several line spacing fixups caused either by space manipulation in isort or by packages
that haven't been touched since we added requirements, but there are no functional changes in here.

* [x] add config to isort to make sure this is maintained going forward
2022-05-28 12:55:44 -04:00

253 lines
9.7 KiB
Python

# Copyright 2013-2022 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 *
def is_CrayXC():
return (spack.platforms.host().name == 'cray') and \
(os.environ.get('CRAYPE_NETWORK_TARGET') == "aries")
def is_CrayEX():
return (spack.platforms.host().name == 'cray') and \
(os.environ.get('CRAYPE_NETWORK_TARGET') in ['ofi', 'ucx'])
def cross_detect():
if is_CrayXC():
if which('srun'):
return 'cray-aries-slurm'
if which('aprun'):
return 'cray-aries-alps'
return 'none'
class Upcxx(Package, CudaPackage, ROCmPackage):
"""UPC++ is a C++ library that supports Partitioned Global Address Space
(PGAS) programming, and is designed to interoperate smoothly and
efficiently with MPI, OpenMP, CUDA, ROCm/HIP and AMTs. It leverages GASNet-EX to
deliver low-overhead, fine-grained communication, including Remote Memory
Access (RMA) and Remote Procedure Call (RPC)."""
homepage = "https://upcxx.lbl.gov"
maintainers = ['bonachea']
url = "https://bitbucket.org/berkeleylab/upcxx/downloads/upcxx-2021.3.0.tar.gz"
git = 'https://bitbucket.org/berkeleylab/upcxx.git'
tags = ['e4s']
version('develop', branch='develop')
version('master', branch='master')
version('2022.3.0', sha256='72bccfc9dfab5c2351ee964232b3754957ecfdbe6b4de640e1b1387d45019496')
version('2021.9.0', sha256='9299e17602bcc8c05542cdc339897a9c2dba5b5c3838d6ef2df7a02250f42177')
version('2021.3.0', sha256='3433714cd4162ffd8aad9a727c12dbf1c207b7d6664879fc41259a4b351595b7')
version('2020.11.0', sha256='f6f212760a485a9f346ca11bb4751e7095bbe748b8e5b2389ff9238e9e321317',
url='https://bitbucket.org/berkeleylab/upcxx/downloads/upcxx-2020.11.0-memory_kinds_prototype.tar.gz')
version('2020.10.0', sha256='623e074b512bf8cad770a04040272e1cc660d2749760398b311f9bcc9d381a37')
version('2020.3.2', sha256='978adc315d21089c739d5efda764b77fc9a2a7c5860f169fe5cd2ca1d840620f')
version('2020.3.0', sha256='01be35bef4c0cfd24e9b3d50c88866521b9cac3ad4cbb5b1fc97aea55078810f')
# Do NOT add older versions here.
# UPC++ releases over 2 years old are not supported.
variant('mpi', default=False,
description='Enables MPI-based spawners and mpi-conduit')
variant('cuda', default=False,
description='Enables UPC++ support for the CUDA memory kind.\n' +
'NOTE: Requires CUDA Driver library be present on the build system')
variant('rocm', default=False,
description='Enables UPC++ support for the ROCm/HIP memory kind')
variant('cross', default=cross_detect(),
description="UPC++ cross-compile target (autodetect by default)")
conflicts('cross=none', when=is_CrayXC(),
msg='cross=none is unacceptable on Cray XC.' +
'Please specify an appropriate "cross" value')
# UPC++ always relies on GASNet-EX.
# The default (and recommendation) is to use the implicit, embedded version.
# This variant allows overriding with a particular version of GASNet-EX sources.
variant('gasnet', default=False,
description="Override embedded GASNet-EX version")
depends_on('gasnet conduits=none', when='+gasnet')
depends_on('mpi', when='+mpi')
depends_on('python@2.7.5:', type=("build", "run"))
conflicts('hip@:4.4.0', when='+rocm')
# All flags should be passed to the build-env in autoconf-like vars
flag_handler = env_flags
def set_variables(self, env):
env.set('UPCXX_INSTALL', self.prefix)
env.set('UPCXX', self.prefix.bin.upcxx)
if is_CrayXC():
env.set('UPCXX_NETWORK', 'aries')
elif is_CrayEX():
env.set('UPCXX_NETWORK', 'ofi')
env.set('GASNET_SPAWN_CONTROL', 'pmi')
def setup_run_environment(self, env):
self.set_variables(env)
def setup_dependent_build_environment(self, env, dependent_spec):
self.set_variables(env)
def setup_dependent_package(self, module, dep_spec):
dep_spec.upcxx = self.prefix.bin.upcxx
def install(self, spec, prefix):
env = os.environ
if (env.get('GASNET_CONFIGURE_ARGS') is None):
env['GASNET_CONFIGURE_ARGS'] = ''
# UPC++ follows autoconf naming convention for LDLIBS, which is 'LIBS'
if (env.get('LDLIBS')):
env['LIBS'] = env['LDLIBS']
options = ["--prefix=%s" % prefix]
if 'cross=none' in spec:
options.append('--without-cross')
else:
options.append('--with-cross=' + spec.variants['cross'].value)
if is_CrayXC():
# Spack loads the cray-libsci module incorrectly on ALCF theta,
# breaking the Cray compiler wrappers
# cray-libsci is irrelevant to our build, so disable it
for var in ['PE_PKGCONFIG_PRODUCTS', 'PE_PKGCONFIG_LIBS']:
env[var] = ":".join(
filter(lambda x: "libsci" not in x.lower(),
env[var].split(":")))
if is_CrayXC() or is_CrayEX():
# Undo spack compiler wrappers:
# the C/C++ compilers must work post-install
real_cc = join_path(env['CRAYPE_DIR'], 'bin', 'cc')
real_cxx = join_path(env['CRAYPE_DIR'], 'bin', 'CC')
# workaround a bug in the UPC++ installer: (issue #346)
env['GASNET_CONFIGURE_ARGS'] += \
" --with-cc=" + real_cc + " --with-cxx=" + real_cxx
if '+mpi' in spec:
env['GASNET_CONFIGURE_ARGS'] += " --with-mpicc=" + real_cc
else:
real_cc = self.compiler.cc
real_cxx = self.compiler.cxx
if '+mpi' in spec:
real_cxx = spec['mpi'].mpicxx
options.append('--with-cc=' + real_cc)
options.append('--with-cxx=' + real_cxx)
if is_CrayEX():
# Probe to find the right libfabric provider (SlingShot 10 vs 11)
fi_info = which('fi_info')('-l', output=str)
if fi_info.find('cxi') >= 0:
provider = 'cxi'
else:
provider = 'verbs;ofi_rxm'
# Append the recommended options for Cray Shasta
options.append('--with-pmi-version=cray')
options.append('--with-pmi-runcmd=\'srun -n %N -- %C\'')
options.append('--disable-ibv')
options.append('--enable-ofi')
options.append('--with-default-network=ofi')
options.append('--with-ofi-provider=' + provider)
env['GASNET_CONFIGURE_ARGS'] = \
'--with-ofi-spawner=pmi ' + env['GASNET_CONFIGURE_ARGS']
if '+gasnet' in spec:
options.append('--with-gasnet=' + spec['gasnet'].prefix.src)
options.append('--with-python=' + spec['python'].command.path)
if '+mpi' in spec:
options.append('--enable-mpi')
options.append('--enable-mpi-compat')
else:
options.append('--without-mpicc')
if '+cuda' in spec:
options.append('--enable-cuda')
options.append('--with-nvcc=' + spec['cuda'].prefix.bin.nvcc)
if '+rocm' in spec:
options.append('--enable-hip')
options.append('--with-ld-flags=' +
self.compiler.cc_rpath_arg + spec['hip'].prefix.lib)
env['GASNET_CONFIGURE_ARGS'] = '--enable-rpath ' + env['GASNET_CONFIGURE_ARGS']
configure(*options)
make()
make('install')
install_tree('example', prefix.example)
@run_after('install')
@on_package_attributes(run_tests=True)
def test_install(self):
# enable testing of unofficial conduits (mpi)
test_networks = 'NETWORKS=$(CONDUITS)'
# build hello world against installed tree in all configurations
make('test_install', test_networks)
make('tests-clean') # cleanup
# build all tests for all networks in debug mode
make('tests', test_networks)
if 'cross=none' in self.spec:
make('run-tests', 'NETWORKS=smp') # runs tests for smp backend
make('tests-clean') # cleanup
def test(self):
# run post-install smoke test:
test_install = join_path(self.prefix.bin, 'test-upcxx-install.sh')
self.run_test(test_install, expected=['SUCCESS'], status=0,
installed=True,
purpose='Checking UPC++ compile+link ' +
'for all installed backends')
# `spack external find` support
executables = ['^upcxx$']
@classmethod
def determine_version(cls, exe):
"""Return either the version of the executable passed as argument
or ``None`` if the version cannot be determined.
exe (str): absolute path to the executable being examined
"""
output = Executable(exe)('--version', output=str, error=str)
match = re.search(r"UPC\+\+ version\s+(\S+)\s+(?:upcxx-(\S+))?", output)
if match is None:
return None
elif match.group(2): # Git snapshot
return match.group(2)
else: # official release
return match.group(1)
@classmethod
def determine_variants(cls, exes, version_str):
meta = exes[0] + "-meta" # find upcxx-meta
output = Executable(meta)('CPPFLAGS', output=str, error=str)
variants = ""
if re.search(r"-DUPCXXI_CUDA_ENABLED=1", output):
variants += "+cuda"
else:
variants += "~cuda"
if re.search(r"-DUPCXXI_HIP_ENABLED=1", output):
variants += "+rocm"
else:
variants += "~rocm"
return variants