summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/upcxx/package.py
blob: 61011a35ace8e70a1c84e53e78068d940616bad9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# Copyright 2013-2021 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

from spack import *


def is_CrayXC():
    return (spack.platforms.host().name == 'cray') and \
           (os.environ.get('CRAYPE_NETWORK_TARGET') == "aries")


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):
    """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 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('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='Builds a CUDA-enabled version of UPC++')

    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('cuda', when='+cuda')
    depends_on('python@2.7.5:', type=("build", "run"))

    # All flags should be passed to the build-env in autoconf-like vars
    flag_handler = env_flags

    def setup_run_environment(self, env):
        env.set('UPCXX_INSTALL', self.prefix)
        env.set('UPCXX', self.prefix.bin.upcxx)
        if is_CrayXC():
            env.set('UPCXX_NETWORK', 'aries')

    def setup_dependent_package(self, module, dep_spec):
        dep_spec.upcxx = self.prefix.bin.upcxx

    def setup_dependent_build_environment(self, env, dependent_spec):
        env.set('UPCXX_INSTALL', self.prefix)
        env.set('UPCXX', self.prefix.bin.upcxx)
        if is_CrayXC():
            env.set('UPCXX_NETWORK', 'aries')

    def install(self, spec, prefix):
        env = os.environ
        # 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(":")))
            # 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)
            if (env.get('GASNET_CONFIGURE_ARGS') is None):
                env['GASNET_CONFIGURE_ARGS'] = ''
            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 '+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('--with-cuda')
            options.append('--with-nvcc=' + spec['cuda'].prefix.bin.nvcc)

        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')