summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/ucx/package.py
blob: eb63e9c767b825b8d3182a5bc9fd1e5f0e3ff6f7 (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
# 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 shutil

from spack.package import *


class Ucx(AutotoolsPackage, CudaPackage):
    """a communication library implementing high-performance messaging for
    MPI/PGAS frameworks"""

    homepage = "http://www.openucx.org"
    url      = "https://github.com/openucx/ucx/releases/download/v1.3.1/ucx-1.3.1.tar.gz"
    git      = "https://github.com/openucx/ucx.git"

    maintainers = ['hppritcha']

    # Current
    version('1.12.1', sha256='40b447c8e7da94a253f2828001b2d76021eb4ad39647107d433d62d61e18ae8e')
    version('1.12.0', sha256='93e994de2d1a4df32381ea92ba4c98a249010d1720eb0f6110dc72c9a7d25db6')
    version('1.11.2', sha256='deebf86a5344fc2bd9e55449f88c650c4514928592807c9bc6fe4190e516c6df')
    version('1.11.1', sha256='29338cad18858517f96b46ff83bdd259a5899e274792cebd269717c660aa86fd')
    version('1.11.0', sha256='b7189b69fe0e16e3c03784ef674e45687a9c520750bd74a45125c460ede37647')
    version('1.10.1', sha256='ae9a108af6842ca135e7ec9b6131469adf9f1e50f899349fafcc69a215368bc9')
    version('1.10.0', sha256='b885e24b1b94724c03cb213c355381e98df1e2d1fd7f633cf8055b6dd05db92d')
    version('1.9-dev', branch='v1.9.x')
    version('1.9.0', sha256='a7a2c8841dc0d5444088a4373dc9b9cc68dbffcd917c1eba92ca8ed8e5e635fb')
    version('1.8.1', sha256='a48820cb8d0761b5ccf3e7ba03a7c8c1dde6276017657178829e07ffc35b556a')
    version('1.8.0', sha256='e400f7aa5354971c8f5ac6b881dc2846143851df868088c37d432c076445628d')
    version('1.7.0', sha256='6ab81ee187bfd554fe7e549da93a11bfac420df87d99ee61ffab7bb19bdd3371')
    version('1.6.1', sha256='1425648aa03f5fa40e4bc5c4a5a83fe0292e2fe44f6054352fbebbf6d8f342a1')
    version('1.6.0', sha256='360e885dd7f706a19b673035a3477397d100a02eb618371697c7f3ee4e143e2c')
    version('1.5.2', sha256='1a333853069860e86ba69b8d071ccc9871209603790e2b673ec61f8086913fad')
    version('1.5.1', sha256='567119cd80ad2ae6968ecaa4bd1d2a80afadd037ccc988740f668de10d2fdb7e')
    version('1.5.0', sha256='84f6e4fa5740afebb9b1c8bb405c07206e58c56f83120dcfcd8dc89e4b7d7458')
    version('1.4.0', sha256='99891a98476bcadc6ac4ef9c9f083bc6ffb188a96b3c3bc89c8bbca64de2c76e')

    # Still supported
    version('1.3.1', sha256='e058c8ec830d2f50d9db1e3aaaee105cd2ad6c1e6df20ae58b9b4179de7a8992')
    version('1.3.0', sha256='71e69e6d78a4950cc5a1edcbe59bf7a8f8e38d59c9f823109853927c4d442952')
    version('1.2.2', sha256='914d10fee8f970d4fb286079dd656cf8a260ec7d724d5f751b3109ed32a6da63')
    version('1.2.1', sha256='fc63760601c03ff60a2531ec3c6637e98f5b743576eb410f245839c84a0ad617')
    version('1.2.0', sha256='1e1a62d6d0f89ce59e384b0b5b30b416b8fd8d7cedec4182a5319d0dfddf649c')

    simd_values = ('avx', 'sse41', 'sse42')

    variant('assertions', default=False, description='Enable assertions')
    variant('backtrace_detail', default=False, description="Enable using BFD support "
            "for detailed backtrace. Note: this adds a dependency on binutils, you may "
            "want to mark binutils as external or depend on binutils~ld to avoid "
            "changing the linker during the build of ucx.")
    variant('debug', default=False, description='Enable debugging')
    variant('examples', default=True, description='Keep examples')
    variant('java', default=False, description='Builds with Java bindings')
    variant('libs', default='shared,static', values=('shared', 'static'), multi=True, description='Build shared libs, static libs or both')
    variant('logging', default=False, description='Enable logging')
    variant('openmp', default=True, description="Use OpenMP")
    variant('opt', default='3', values=('0', '1', '2', '3'), multi=False, description='Set optimization level')
    variant('optimizations', default=True, description='Enable optimizations')
    variant('parameter_checking', default=False, description='Enable parameter checking')
    variant('pic', default=True, description='Builds with PIC support')
    variant('rocm', default=False, description="Enable ROCm support")
    variant('simd', values=disjoint_sets(('auto',), simd_values).with_default('auto').with_non_feature_values('auto'))
    variant('thread_multiple', default=False, description='Enable thread support in UCP and UCT')
    variant('ucg', default=False, description="Enable the group collective operations (experimental component)")
    variant('vfs', default=False, when='@1.11.0:', description='UCX Virtual Filesystem support')

    variant('cm', default=False, when='@:1.10', description="Compile with IB Connection Manager support")
    variant('cma', default=False, description="Enable Cross Memory Attach")
    variant('dc', default=False, description="Compile with IB Dynamic Connection support")
    variant('dm', default=False, description="Compile with Device Memory support")
    variant('gdrcopy', default=False, description='Enable gdrcopy support')
    variant('ib_hw_tm', default=False, description="Compile with IB Tag Matching support")
    variant('knem', default=False, description='Enable KNEM support')
    variant('mlx5_dv', default=False, description="Compile with mlx5 Direct Verbs support")
    variant('rc', default=False, description="Compile with IB Reliable Connection support")
    variant('rdmacm', default=False, description='Enable the use of RDMACM')
    variant('ud', default=False, description="Compile with IB Unreliable Datagram support")
    variant('verbs', default=False, description='Build OpenFabrics support')
    variant('xpmem', default=False, description='Enable XPMEM support')

    depends_on('binutils+ld', when='%aocc', type='build')
    depends_on('binutils', when='+backtrace_detail')
    depends_on('gdrcopy', when='@1.7:+gdrcopy')
    depends_on('gdrcopy@1.3', when='@:1.6+gdrcopy')
    depends_on('java@8', when='+java')
    depends_on('knem', when='+knem')
    depends_on('libfuse@3:', when='+vfs')
    depends_on('maven', when='+java')
    depends_on('numactl')
    depends_on('pkgconfig', type='build')
    depends_on('rdma-core', when='+rdmacm')
    depends_on('rdma-core', when='+verbs')
    depends_on('xpmem', when='+xpmem')

    conflicts('+gdrcopy', when='~cuda', msg='gdrcopy currently requires cuda support')
    conflicts('+rocm', when='+gdrcopy', msg='gdrcopy > 2.0 does not support rocm')

    configure_abs_path = 'contrib/configure-release'

    @when('@1.9-dev')
    def autoreconf(self, spec, prefix):
        Executable('./autogen.sh')()

    def configure_args(self):
        spec = self.spec
        args = [
            '--without-go',  # todo
            '--disable-doxygen-doc'  # todo
        ]

        args += self.enable_or_disable('assertions')
        args.append('--enable-compiler-opt=' + self.spec.variants['opt'].value)
        args += self.with_or_without('java', activation_value='prefix')
        args += self.enable_or_disable('libs')
        args += self.enable_or_disable('logging')
        args += self.enable_or_disable('mt', variant='thread_multiple')
        args += self.with_or_without('openmp')
        args += self.enable_or_disable('optimizations')
        args += self.enable_or_disable('params-check', variant='parameter_checking')
        args += self.with_or_without('pic')

        args += self.with_or_without('cuda', activation_value='prefix')
        args += self.with_or_without('rocm')  # todo, prefix, avoid /opt/rocm guess.

        args += self.with_or_without('cm')
        args += self.enable_or_disable('cma')
        args += self.with_or_without('dc')
        args += self.with_or_without('dm')
        args += self.with_or_without('gdrcopy', activation_value='prefix')
        args += self.with_or_without('ib-hw-tm', variant='ib_hw_tm')
        args += self.with_or_without('knem', activation_value='prefix')
        args += self.with_or_without('mlx5-dv', variant='mlx5_dv')
        args += self.with_or_without('rc')
        args += self.with_or_without('ud')
        args += self.with_or_without('xpmem', activation_value='prefix')

        # Virtual filesystem as of UCX 1.11
        if '+vfs' in spec:
            args.append('--with-fuse3=' + self.spec['libfuse'].prefix)
        else:
            args.append('--without-fuse3')

        # Backtraces
        # UCX <= 1.11: --enable-backtrace-detail
        # UCX >= 1.12: --with-bfd
        if '@:1.11' in spec:
            args += self.enable_or_disable(
                'backtrace-detail', variant='backtrace_detail')
        else:
            if '+backtrace_detail' in spec:
                args.append('--with-bfd=' + self.spec['binutils'].prefix)
            else:
                args.append('--without-bfd')

        if '+rdmacm' in spec:
            args.append('--with-rdmacm=' + self.spec['rdma-core'].prefix)
        else:
            args.append('--without-rdmacm')

        if '+verbs' in spec:
            args.append('--with-verbs=' + self.spec['rdma-core'].prefix)
        else:
            args.append('--without-verbs')

        # SIMD flags.
        if self.spec.satisfies('simd=auto'):
            if 'avx' in self.spec.target:
                args.append('--with-avx')
            else:
                args.append('--without-avx')
        elif self.spec.satisfies('simd=none'):
            for instr in self.simd_values:
                args.append('--without-' + instr)
        else:
            for instr in self.simd_values:
                if instr in spec.variants['simd'].value:
                    args.append('--with-' + instr)
                else:
                    args.append('--without-' + instr)

        # lld doesn't support '-dynamic-list-data'
        if '%aocc' in spec:
            args.append('LDFLAGS=-fuse-ld=bfd')

        return args

    @run_after('install')
    def drop_examples(self):
        if self.spec.satisfies('~examples'):
            shutil.rmtree(join_path(self.spec.prefix, 'share', 'ucx', 'examples'))