# 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

from llnl.util import tty

from spack import *


class Tasmanian(CMakePackage, CudaPackage, ROCmPackage):
    """The Toolkit for Adaptive Stochastic Modeling and Non-Intrusive
    ApproximatioN is a robust library for high dimensional integration and
    interpolation as well as parameter calibration."""

    homepage = 'http://tasmanian.ornl.gov'
    url      = 'https://github.com/ORNL/TASMANIAN/archive/v7.5.tar.gz'
    git      = 'https://github.com/ORNL/TASMANIAN.git'

    tags = ['e4s']
    maintainers = ['mkstoyanov']

    version('develop', branch='master')

    version('7.7', sha256='85fb3a7b302ea21a3b700712767a59a623d9ab93da03308fa47d4413654c3878')
    version('7.5', sha256='d621bd36dced4db86ef638693ba89b336762e7a3d7fedb3b5bcefb03390712b3')
    version('7.3', sha256='5bd1dd89cc5c84506f6900b6569b17e50becd73eb31ec85cfa11d6f1f912c4fa')
    version('7.1', sha256='9c24a591506a478745b802f1fa5c557da7bc80b12d8070855de6bc7aaca7547a')
    version('7.0', sha256='4094ba4ee2f1831c575d00368c8471d3038f813398be2e500739cef5c7c4a47b')  # use for xsdk-0.5.0
    version('6.0', sha256='ceab842e9fbce2f2de971ba6226967caaf1627b3e5d10799c3bd2e7c3285ba8b')  # use for xsdk-0.4.0
    version('5.1', sha256='b0c1be505ce5f8041984c63edca9100d81df655733681858f5cc10e8c0c72711')

    version('5.0', sha256='2540bb63dea987ab205f7b375aff41f320b1de9bd7f1d1064ef96b22eeda1251',
            url='https://tasmanian.ornl.gov/documents/Tasmanian_v5.0.zip')

    variant('xsdkflags', default=False,
            description='enable XSDK defaults for Tasmanian')

    variant('openmp', default=True,
            description='add OpenMP support to Tasmanian')
    # tested with OpenMP 3.1 (clang4) through 4.0-4.5 (gcc 5 - 8)

    variant('blas', default=False,
            description='add BLAS support to Tasmanian')

    variant('mpi', default=False,
            description='add MPI support to Tasmanian')

    variant('cuda', default=False,
            description='add CUDA support to Tasmanian')

    variant('rocm', default=False,
            description='add ROCm support to Tasmanian')

    variant('magma', default=False,
            description='add UTK MAGMA support to Tasmanian')

    variant('python', default=False,
            description='add Python binding for Tasmanian')

    variant('fortran', default=False,
            description='add Fortran 90/95 interface to Tasmanian')

    variant('build_type', default='Release',
            description='CMake build type',
            values=('Debug', 'Release'))

    depends_on('cmake@2.8:', type='build')
    depends_on('cmake@3.5:', type='build', when='@6.0:')
    depends_on('cmake@3.10:', type=('build', 'run'), when='@7.0:')

    depends_on('python@2.7:', when='+python', type=('build', 'run'))
    depends_on('py-numpy', when='+python', type=('build', 'run'))

    extends('python', when='+python', type=('build', 'run'))

    depends_on('mpi', when="+mpi", type=('build', 'run'))  # openmpi 2 and 3 tested

    depends_on('blas', when="+blas", type=('build', 'run'))  # openblas 0.2.18 or newer
    depends_on('lapack', when="+blas @7.1:", type=('build', 'run'))  # lapack used since 7.1

    depends_on('cuda@8.0.61:', when='+cuda', type=('build', 'run'))
    depends_on('cuda@8.0.61:', when='+magma', type=('build', 'run'))

    depends_on('hip@3.8:', when='+rocm', type=('build', 'run'))
    depends_on('rocblas@3.8:', when='+rocm', type=('build', 'run'))
    depends_on('rocsparse@3.8:', when='+rocm', type=('build', 'run'))
    depends_on('rocsolver@3.8:', when='+rocm', type=('build', 'run'))

    depends_on('magma@2.4.0:', when='+magma @6.0:', type=('build', 'run'))
    depends_on('magma@2.5.0:', when='+magma @7.0:', type=('build', 'run'))

    conflicts('-cuda', when='+magma')  # currently MAGMA only works with CUDA
    conflicts('+cuda', when='+rocm')  # can pick CUDA or ROCm, not both

    # old versions
    conflicts('+rocm', when='@:7.3')  # ROCm was added in 7.3, tested in 7.5
    conflicts('+magma', when='@:5.1')  # magma does not work prior to 6.0
    conflicts('+mpi', when='@:5.1')    # MPI is broken prior to 6.0
    conflicts('+xsdkflags', when='@:5.1')  # 6.0 is the first version included in xSDK

    # patching some bugs
    patch('addons70.patch', when='@7.0')
    patch('packageconf70.patch', when='@7.0')

    def setup_build_environment(self, env):
        # needed for the hipcc compiler
        if "+rocm" in self.spec:
            env.set('CXX', self.spec['hip'].hipcc)

    def cmake_args(self):
        spec = self.spec

        # 7.1 is the last version to use xSDK legacy build options
        if '+xsdkflags' in spec and spec.satisfies('@:7.1'):
            args = [
                '-DUSE_XSDK_DEFAULTS:BOOL=ON',
                self.define_from_variant('XSDK_ENABLE_PYTHON', 'python'),
                self.define_from_variant('TPL_ENABLE_MPI', 'mpi'),
                self.define_from_variant('XSDK_ENABLE_OPENMP', 'openmp'),
                self.define_from_variant('TPL_ENABLE_BLAS', 'blas'),
                self.define_from_variant('XSDK_ENABLE_CUDA', 'cuda'),
                self.define_from_variant('TPL_ENABLE_MAGMA', 'magma'),
                self.define_from_variant('XSDK_ENABLE_FORTRAN', 'fortran'), ]
        else:
            args = [
                self.define_from_variant('Tasmanian_ENABLE_OPENMP', 'openmp'),
                self.define_from_variant('Tasmanian_ENABLE_BLAS', 'blas'),
                self.define_from_variant('Tasmanian_ENABLE_PYTHON', 'python'),
                self.define_from_variant('Tasmanian_ENABLE_MPI', 'mpi'),
                self.define_from_variant('Tasmanian_ENABLE_CUDA', 'cuda'),
                self.define_from_variant('Tasmanian_ENABLE_HIP', 'rocm'),
                self.define_from_variant('Tasmanian_ENABLE_MAGMA', 'magma'),
                self.define_from_variant('Tasmanian_ENABLE_FORTRAN',
                                         'fortran'), ]

        if spec.satisfies('+blas'):
            args.append('-DBLAS_LIBRARIES={0}'.format(spec['blas'].libs.joined(';')))
            args.append(
                '-DLAPACK_LIBRARIES={0}'.format(spec['lapack'].libs.joined(';'))
            )

        if spec.satisfies('+python'):
            args.append('-DPYTHON_EXECUTABLE:FILEPATH={0}'.format(
                self.spec['python'].command.path))

        # See https://github.com/ROCmSoftwarePlatform/rocFFT/issues/322
        if self.spec.satisfies('+rocm') and self.spec.satisfies('^cmake@3.21:'):
            args.append(self.define('__skip_rocmclang', 'ON'))

        # _CUBLAS and _CUDA were separate options prior to 6.0
        # skipping _CUBLAS leads to peformance regression
        if spec.satisfies('@:5.1'):
            args.append(self.define_from_variant('Tasmanian_ENABLE_CUBLAS', 'cuda'))

        return args

    # TODO: Replace this method and its 'get' use for cmake path with
    #   join_path(self.spec['cmake'].prefix.bin, 'cmake') once stand-alone
    #   tests can access build dependencies through self.spec['cmake'].
    def cmake_bin(self, set=True):
        """(Hack) Set/get cmake dependency path."""
        filepath = join_path(self.install_test_root, 'cmake_bin_path.txt')
        if set:
            with open(filepath, 'w') as out_file:
                cmake_bin = join_path(self.spec['cmake'].prefix.bin, 'cmake')
                out_file.write('{0}\n'.format(cmake_bin))
        elif os.path.isfile(filepath):
            with open(filepath, 'r') as in_file:
                return in_file.read().strip()

    @run_after('install')
    def setup_smoke_test(self):
        if not self.spec['cmake'].satisfies('@3.10:'):
            tty.msg('Error tasmanian test: CMake 3.10 or higher is required')
            return

        install_tree(self.prefix.share.Tasmanian.testing,
                     join_path(self.install_test_root, 'testing'))
        self.cmake_bin(set=True)

    def test(self):
        cmake_bin = self.cmake_bin(set=False)

        if not cmake_bin:
            tty.msg('Skipping tasmanian test: cmake_bin_path.txt not found')
            return

        # using the tests copied from <prefix>/share/Tasmanian/testing
        cmake_dir = self.test_suite.current_test_cache_dir.testing

        if not self.run_test(cmake_bin,
                             options=[cmake_dir],
                             purpose='Generate the Makefile'):
            tty.msg('Skipping tasmanian test: failed to generate Makefile')
            return

        if not self.run_test('make',
                             purpose='Build test software'):
            tty.msg('Skipping tasmanian test: failed to build test')
            return

        if not self.run_test('make',
                             options=['test'],
                             purpose='Run test'):
            tty.msg('Failed tasmanian test: failed to run test')
