summaryrefslogtreecommitdiff
path: root/lib/spack/spack/test/data/unparse/amdfftw.txt
blob: 619dec56651492c1277f4b499565d76f3bab6e8d (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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
# -*- python -*-
# Copyright 2013-2024 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)
"""This is an unparser test package.

``amdfftw`` was chosen for its complexity and because it uses a negative array
index that was not being unparsed consistently from Python 2 to 3.

"""

import os

from spack import *
from spack.pkg.builtin.fftw import FftwBase


class Amdfftw(FftwBase):
    """FFTW (AMD Optimized version) is a comprehensive collection of
    fast C routines for computing the Discrete Fourier Transform (DFT)
    and various special cases thereof.

    It is an open-source implementation of the Fast Fourier transform
    algorithm. It can compute transforms of real and complex-values
    arrays of arbitrary size and dimension.
    AMD Optimized FFTW is the optimized FFTW implementation targeted
    for AMD CPUs.

    For single precision build, please use precision value as float.
    Example : spack install amdfftw precision=float
    """

    _name = "amdfftw"
    homepage = "https://developer.amd.com/amd-aocl/fftw/"
    url = "https://github.com/amd/amd-fftw/archive/3.0.tar.gz"
    git = "https://github.com/amd/amd-fftw.git"

    maintainers("amd-toolchain-support")

    version("3.1", sha256="3e777f3acef13fa1910db097e818b1d0d03a6a36ef41186247c6ab1ab0afc132")
    version("3.0.1", sha256="87030c6bbb9c710f0a64f4f306ba6aa91dc4b182bb804c9022b35aef274d1a4c")
    version("3.0", sha256="a69deaf45478a59a69f77c4f7e9872967f1cfe996592dd12beb6318f18ea0bcd")
    version("2.2", sha256="de9d777236fb290c335860b458131678f75aa0799c641490c644c843f0e246f8")

    variant("shared", default=True, description="Builds a shared version of the library")
    variant("openmp", default=True, description="Enable OpenMP support")
    variant("threads", default=False, description="Enable SMP threads support")
    variant("debug", default=False, description="Builds a debug version of the library")
    variant(
        "amd-fast-planner",
        default=False,
        description="Option to reduce the planning time without much"
        "tradeoff in the performance. It is supported for"
        "Float and double precisions only.",
    )
    variant("amd-top-n-planner", default=False, description="Build with amd-top-n-planner support")
    variant(
        "amd-mpi-vader-limit", default=False, description="Build with amd-mpi-vader-limit support"
    )
    variant("static", default=False, description="Build with static suppport")
    variant("amd-trans", default=False, description="Build with amd-trans suppport")
    variant("amd-app-opt", default=False, description="Build with amd-app-opt suppport")

    depends_on("texinfo")

    provides("fftw-api@3", when="@2:")

    conflicts(
        "precision=quad",
        when="@2.2 %aocc",
        msg="Quad precision is not supported by AOCC clang version 2.2",
    )
    conflicts(
        "+debug", when="@2.2 %aocc", msg="debug mode is not supported by AOCC clang version 2.2"
    )
    conflicts("%gcc@:7.2", when="@2.2:", msg="GCC version above 7.2 is required for AMDFFTW")
    conflicts(
        "+amd-fast-planner ", when="+mpi", msg="mpi thread is not supported with amd-fast-planner"
    )
    conflicts(
        "+amd-fast-planner", when="@2.2", msg="amd-fast-planner is supported from 3.0 onwards"
    )
    conflicts(
        "+amd-fast-planner",
        when="precision=quad",
        msg="Quad precision is not supported with amd-fast-planner",
    )
    conflicts(
        "+amd-fast-planner",
        when="precision=long_double",
        msg="long_double precision is not supported with amd-fast-planner",
    )
    conflicts(
        "+amd-top-n-planner",
        when="@:3.0.0",
        msg="amd-top-n-planner is supported from 3.0.1 onwards",
    )
    conflicts(
        "+amd-top-n-planner",
        when="precision=long_double",
        msg="long_double precision is not supported with amd-top-n-planner",
    )
    conflicts(
        "+amd-top-n-planner",
        when="precision=quad",
        msg="Quad precision is not supported with amd-top-n-planner",
    )
    conflicts(
        "+amd-top-n-planner",
        when="+amd-fast-planner",
        msg="amd-top-n-planner cannot be used with amd-fast-planner",
    )
    conflicts(
        "+amd-top-n-planner", when="+threads", msg="amd-top-n-planner works only for single thread"
    )
    conflicts(
        "+amd-top-n-planner", when="+mpi", msg="mpi thread is not supported with amd-top-n-planner"
    )
    conflicts(
        "+amd-top-n-planner",
        when="+openmp",
        msg="openmp thread is not supported with amd-top-n-planner",
    )
    conflicts(
        "+amd-mpi-vader-limit",
        when="@:3.0.0",
        msg="amd-mpi-vader-limit is supported from 3.0.1 onwards",
    )
    conflicts(
        "+amd-mpi-vader-limit",
        when="precision=quad",
        msg="Quad precision is not supported with amd-mpi-vader-limit",
    )
    conflicts("+amd-trans", when="+threads", msg="amd-trans works only for single thread")
    conflicts("+amd-trans", when="+mpi", msg="mpi thread is not supported with amd-trans")
    conflicts("+amd-trans", when="+openmp", msg="openmp thread is not supported with amd-trans")
    conflicts(
        "+amd-trans",
        when="precision=long_double",
        msg="long_double precision is not supported with amd-trans",
    )
    conflicts(
        "+amd-trans", when="precision=quad", msg="Quad precision is not supported with amd-trans"
    )
    conflicts("+amd-app-opt", when="@:3.0.1", msg="amd-app-opt is supported from 3.1 onwards")
    conflicts("+amd-app-opt", when="+mpi", msg="mpi thread is not supported with amd-app-opt")
    conflicts(
        "+amd-app-opt",
        when="precision=long_double",
        msg="long_double precision is not supported with amd-app-opt",
    )
    conflicts(
        "+amd-app-opt",
        when="precision=quad",
        msg="Quad precision is not supported with amd-app-opt",
    )

    def configure(self, spec, prefix):
        """Configure function"""
        # Base options
        options = ["--prefix={0}".format(prefix), "--enable-amd-opt"]

        # Check if compiler is AOCC
        if "%aocc" in spec:
            options.append("CC={0}".format(os.path.basename(spack_cc)))
            options.append("FC={0}".format(os.path.basename(spack_fc)))
            options.append("F77={0}".format(os.path.basename(spack_fc)))

        if "+debug" in spec:
            options.append("--enable-debug")

        if "+mpi" in spec:
            options.append("--enable-mpi")
            options.append("--enable-amd-mpifft")
        else:
            options.append("--disable-mpi")
            options.append("--disable-amd-mpifft")

        options.extend(self.enable_or_disable("shared"))
        options.extend(self.enable_or_disable("openmp"))
        options.extend(self.enable_or_disable("threads"))
        options.extend(self.enable_or_disable("amd-fast-planner"))
        options.extend(self.enable_or_disable("amd-top-n-planner"))
        options.extend(self.enable_or_disable("amd-mpi-vader-limit"))
        options.extend(self.enable_or_disable("static"))
        options.extend(self.enable_or_disable("amd-trans"))
        options.extend(self.enable_or_disable("amd-app-opt"))

        if not self.compiler.f77 or not self.compiler.fc:
            options.append("--disable-fortran")

        # Cross compilation is supported in amd-fftw by making use of target
        # variable to set AMD_ARCH configure option.
        # Spack user can not directly use AMD_ARCH for this purpose but should
        # use target variable to set appropriate -march option in AMD_ARCH.
        arch = spec.architecture
        options.append(
            "AMD_ARCH={0}".format(arch.target.optimization_flags(spec.compiler).split("=")[-1])
        )

        # Specific SIMD support.
        # float and double precisions are supported
        simd_features = ["sse2", "avx", "avx2"]

        simd_options = []
        for feature in simd_features:
            msg = "--enable-{0}" if feature in spec.target else "--disable-{0}"
            simd_options.append(msg.format(feature))

        # When enabling configure option "--enable-amd-opt", do not use the
        # configure option "--enable-generic-simd128" or
        # "--enable-generic-simd256"

        # Double is the default precision, for all the others we need
        # to enable the corresponding option.
        enable_precision = {
            "float": ["--enable-float"],
            "double": None,
            "long_double": ["--enable-long-double"],
            "quad": ["--enable-quad-precision"],
        }

        # Different precisions must be configured and compiled one at a time
        configure = Executable("../configure")
        for precision in self.selected_precisions:
            opts = (enable_precision[precision] or []) + options[:]

            # SIMD optimizations are available only for float and double
            if precision in ("float", "double"):
                opts += simd_options

            with working_dir(precision, create=True):
                configure(*opts)