##############################################################################
# Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.
# Produced at the Lawrence Livermore National Laboratory.
#
# This file is part of Spack.
# Created by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
# LLNL-CODE-647188
#
# For details, see https://github.com/llnl/spack
# Please also see the LICENSE file for our notice and the LGPL.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License (as
# published by the Free Software Foundation) version 2.1, February 1999.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the IMPLIED WARRANTY OF
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the terms and
# conditions of the GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *


class SuiteSparse(Package):
    """
    SuiteSparse is a suite of sparse matrix algorithms
    """
    homepage = 'http://faculty.cse.tamu.edu/davis/suitesparse.html'
    url = 'http://faculty.cse.tamu.edu/davis/SuiteSparse/SuiteSparse-4.5.1.tar.gz'

    version('4.5.3', '8ec57324585df3c6483ad7f556afccbd')
    version('4.5.1', 'f0ea9aad8d2d1ffec66a5b6bfeff5319')

    variant('tbb', default=False, description='Build with Intel TBB')
    variant('pic', default=True, description='Build position independent code (required to link with shared libraries)')

    depends_on('blas')
    depends_on('lapack')

    depends_on('metis@5.1.0', when='@4.5.1:')
    # in @4.5.1. TBB support in SPQR seems to be broken as TBB-related linkng
    # flags does not seem to be used, which leads to linking errors on Linux.
    depends_on('tbb', when='@4.5.3:+tbb')

    patch('tbb_453.patch', when='@4.5.3:+tbb')

    def install(self, spec, prefix):
        # The build system of SuiteSparse is quite old-fashioned.
        # It's basically a plain Makefile which include an header
        # (SuiteSparse_config/SuiteSparse_config.mk)with a lot of convoluted
        # logic in it. Any kind of customization will need to go through
        # filtering of that file

        make_args = ['INSTALL=%s' % prefix]

        # inject Spack compiler wrappers
        make_args.extend([
            'AUTOCC=no',
            'CC=%s' % self.compiler.cc,
            'CXX=%s' % self.compiler.cxx,
            'F77=%s' % self.compiler.f77,
            'CUDA_ROOT     =',
            'GPU_BLAS_PATH =',
            'GPU_CONFIG    =',
            'CUDA_PATH     =',
            'CUDART_LIB    =',
            'CUBLAS_LIB    =',
            'CUDA_INC_PATH =',
            'NV20          =',
            'NV30          =',
            'NV35          =',
            'NVCC          = echo',
            'NVCCFLAGS     =',
        ])
        if '+pic' in spec:
            make_args.extend([
                'CFLAGS={0}'.format(self.compiler.pic_flag),
                'FFLAGS={0}'.format(self.compiler.pic_flag)
            ])

        if '%xl' in spec or '%xl_r' in spec:
            make_args.extend(['CFLAGS+=-DBLAS_NO_UNDERSCORE'])

        # use Spack's metis in CHOLMOD/Partition module,
        # otherwise internal Metis will be compiled
        make_args.extend([
            'MY_METIS_LIB=-L%s -lmetis' % spec['metis'].prefix.lib,
            'MY_METIS_INC=%s' % spec['metis'].prefix.include,
        ])

        # Intel TBB in SuiteSparseQR
        if 'tbb' in spec:
            make_args.extend([
                'SPQR_CONFIG=-DHAVE_TBB',
                'TBB=-L%s -ltbb' % spec['tbb'].prefix.lib,
            ])

        # Make sure Spack's Blas/Lapack is used. Otherwise System's
        # Blas/Lapack might be picked up.
        blas = spec['blas'].libs.ld_flags
        lapack = spec['lapack'].libs.ld_flags
        if '@4.5.1' in spec:
            # adding -lstdc++ is clearly an ugly way to do this, but it follows
            # with the TCOV path of SparseSuite 4.5.1's Suitesparse_config.mk
            blas += ' -lstdc++'

        make_args.extend([
            'BLAS=%s' % blas,
            'LAPACK=%s' % lapack
        ])

        make('install', *make_args)

@@ -1488,16 +1488,73 @@
 ar.gz'%0A%0A
+    version('4.5.4', 'f6ab689442e64a1624a47aa220072d1b')%0A
     vers

add 4.5.4 (#3558)