spack/var/spack/repos/builtin/packages/charmpp/package.py
Abhinav Bhatele 055b0a442c Charmpp: rename charm to charmpp according to ++ conventions (#9216)
* Charmpp: rename charm to charmpp according to ++ conventions
* modify packages that depend on charmpp
2018-09-14 17:01:07 -07:00

264 lines
11 KiB
Python

##############################################################################
# Copyright (c) 2013-2018, 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/spack/spack
# Please also see the NOTICE and LICENSE files 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
##############################################################################
import os
import platform
import shutil
import sys
from spack import *
class Charmpp(Package):
"""Charm++ is a parallel programming framework in C++ supported by
an adaptive runtime system, which enhances user productivity and
allows programs to run portably from small multicore computers
(your laptop) to the largest supercomputers."""
homepage = "http://charmplusplus.org"
url = "http://charm.cs.illinois.edu/distrib/charm-6.8.2.tar.gz"
git = "https://github.com/UIUC-PPL/charm.git"
version("develop", branch="charm")
version("6.8.2", "a887a34b638a5b2f7fcf7ff3c262496d")
version("6.8.1", "3e95ffa760909154ef16b643c9bb8193")
version("6.8.0", "54df066a5aefb0bbc1a263c2383c2bba")
version("6.7.1", "a8e20cf85e9c8721158f5bbd0ade48d9")
version("6.7.0", "35a39a7975f1954a7db2d76736158231")
version("6.6.1", "9554230f741e2599deaaac4d9d93d7ab")
version("6.6.0", "31e95901b3f7324d52107e6ad000fcc8")
version("6.5.1", "034d99458474a3ab96d8bede8a691a5d")
# Support OpenMPI; see
# <https://charm.cs.illinois.edu/redmine/issues/1206>
# Patch is no longer needed in versions 6.8.0+
patch("mpi.patch", when="@:6.7.1")
# Ignore compiler warnings while configuring
patch("strictpass.patch", when="@:6.8.2")
# Build targets
# "target" is reserved, so we have to use something else.
variant(
"build-target",
default="LIBS",
# AMPI also builds charm++, LIBS also builds AMPI and charm++
values=("charm++", "AMPI", "LIBS"),
description="Specify the target to build"
)
# Communication mechanisms (choose exactly one)
variant(
"backend",
default="netlrts",
values=("mpi", "multicore", "netlrts", "verbs", "gni",
"ofi", "pami", "pamilrts"),
description="Set the backend to use"
)
# Other options
variant("papi", default=False, description="Enable PAPI integration")
variant("syncft", default=False, description="Compile with Charm++ fault tolerance support")
variant("smp", default=True,
description=(
"Enable SMP parallelism (does not work with +multicore)"))
variant("tcp", default=False,
description="Use TCP as transport mechanism (requires +net)")
variant("omp", default=False, description="Support for the integrated LLVM OpenMP runtime")
variant("pthreads", default=False, description="Compile with pthreads Converse threads")
variant("cuda", default=False, description="Enable CUDA toolkit")
variant("shared", default=True, description="Enable shared link support")
variant("production", default=True, description="Build charm++ with all optimizations")
variant("tracing", default=False, description="Enable tracing modules")
# FIXME: backend=mpi also provides mpi, but spack does not support
# depends_on("mpi") and provides("mpi") in the same package currently.
for b in ['multicore', 'netlrts', 'verbs', 'gni', 'ofi', 'pami',
'pamilrts']:
provides('mpi@2', when='@6.7.1: build-target=AMPI backend={0}'.format(b))
provides('mpi@2', when='@6.7.1: build-target=LIBS backend={0}'.format(b))
def setup_dependent_environment(self, spack_env, run_env, dependent_spec):
spack_env.set('MPICC', join_path(self.prefix.bin, 'ampicc'))
spack_env.set('MPICXX', join_path(self.prefix.bin, 'ampicxx'))
spack_env.set('MPIF77', join_path(self.prefix.bin, 'ampif77'))
spack_env.set('MPIF90', join_path(self.prefix.bin, 'ampif90'))
def setup_dependent_package(self, module, dependent_spec):
self.spec.mpicc = join_path(self.prefix.bin, 'ampicc')
self.spec.mpicxx = join_path(self.prefix.bin, 'ampicxx')
self.spec.mpifc = join_path(self.prefix.bin, 'ampif90')
self.spec.mpif77 = join_path(self.prefix.bin, 'ampif77')
depends_on("mpi", when="backend=mpi")
depends_on("papi", when="+papi")
depends_on("cuda", when="+cuda")
# Git versions of Charm++ require automake and autoconf
depends_on("automake", when="@develop")
depends_on("autoconf", when="@develop")
conflicts("~tracing", "+papi")
conflicts("backend=multicore", "+smp")
def install(self, spec, prefix):
target = spec.variants["build-target"].value
plat = sys.platform
if plat.startswith("linux"):
plat = "linux"
elif plat.startswith("win"):
plat = "win"
elif plat.startswith("cnl"):
plat = "cnl"
elif plat.startswith("cnk"):
plat = "cnk"
mach = platform.machine()
if mach.startswith("ppc"):
mach = "ppc"
elif mach.startswith("arm"):
mach = "arm"
comm = spec.variants['backend'].value
# Define Charm++ version names for various (plat, mach, comm)
# combinations. Note that not all combinations are supported.
versions = {
("darwin", "x86_64", "mpi"): "mpi-darwin-x86_64",
("darwin", "x86_64", "multicore"): "multicore-darwin-x86_64",
("darwin", "x86_64", "netlrts"): "netlrts-darwin-x86_64",
("linux", "i386", "mpi"): "mpi-linux",
("linux", "i386", "multicore"): "multicore-linux",
("linux", "i386", "netlrts"): "netlrts-linux",
("linux", "i386", "uth"): "uth-linux",
("linux", "x86_64", "mpi"): "mpi-linux-x86_64",
("linux", "x86_64", "multicore"): "multicore-linux-x86_64",
("linux", "x86_64", "netlrts"): "netlrts-linux-x86_64",
("linux", "x86_64", "verbs"): "verbs-linux-x86_64",
("linux", "x86_64", "ofi"): "ofi-linux-x86_64",
("linux", "x86_64", "uth"): "uth-linux-x86_64",
("linux", "ppc", "mpi"): "mpi-linux-ppc",
("linux", "ppc", "multicore"): "multicore-linux-ppc",
("linux", "ppc", "netlrts"): "netlrts-linux-ppc",
("linux", "ppc", "pami"): "pami-linux-ppc64le",
("linux", "ppc", "verbs"): "verbs-linux-ppc64le",
("linux", "arm", "netlrts"): "netlrts-linux-arm7",
("linux", "arm", "multicore"): "multicore-arm7",
("win", "x86_64", "mpi"): "mpi-win-x86_64",
("win", "x86_64", "multicore"): "multicore-win-x86_64",
("win", "x86_64", "netlrts"): "netlrts-win-x86_64",
("cnl", "x86_64", "gni"): "gni-crayxc",
("cnl", "x86_64", "mpi"): "mpi-crayxc",
("cnk", "x86_64", "mpi"): "mpi-bluegeneq",
("cnk", "x86_64", "pami"): "pami-bluegeneq",
("cnk", "x86_64", "pamilrts"): "pamilrts-bluegeneq",
}
if (plat, mach, comm) not in versions:
raise InstallError(
"The communication mechanism %s is not supported "
"on a %s platform with a %s CPU" %
(comm, plat, mach))
version = versions[(plat, mach, comm)]
# We assume that Spack's compiler wrappers make this work. If
# not, then we need to query the compiler vendor from Spack
# here.
options = [
os.path.basename(self.compiler.cc),
os.path.basename(self.compiler.fc),
"-j%d" % make_jobs,
"--destination=%s" % prefix,
]
if 'backend=mpi' in spec:
# in intelmpi <prefix>/include and <prefix>/lib fails so --basedir
# cannot be used
options.extend([
'--incdir={0}'.format(incdir)
for incdir in spec["mpi"].headers.directories
])
options.extend([
'--libdir={0}'.format(libdir)
for libdir in spec["mpi"].libs.directories
])
if "+papi" in spec:
options.extend(["papi", "--basedir=%s" % spec["papi"].prefix])
if "+smp" in spec:
options.append("smp")
if "+tcp" in spec:
if 'backend=netlrts' not in spec:
# This is a Charm++ limitation; it would lead to a
# build error
raise InstallError(
"The +tcp variant requires "
"the backend=netlrts communication mechanism")
options.append("tcp")
if "+omp" in spec:
options.append("omp")
if "+pthreads" in spec:
options.append("pthreads")
if "+cuda" in spec:
options.append("cuda")
if "+shared" in spec:
options.append("--build-shared")
if "+production" in spec:
options.append("--with-production")
if "+tracing" in spec:
options.append("--enable-tracing")
# Call "make" via the build script
# Note: This builds Charm++ in the "tmp" subdirectory of the
# install directory. Maybe we could set up a symbolic link
# back to the build tree to prevent this? Alternatively, we
# could dissect the build script; the build instructions say
# this wouldn't be difficult.
build = Executable(join_path(".", "build"))
build(target, version, *options)
# Charm++'s install script does not copy files, it only creates
# symbolic links. Fix this.
for dirpath, dirnames, filenames in os.walk(prefix):
for filename in filenames:
filepath = join_path(dirpath, filename)
if os.path.islink(filepath):
tmppath = filepath + ".tmp"
# Skip dangling symbolic links
try:
copy(filepath, tmppath)
os.remove(filepath)
os.rename(tmppath, filepath)
except (IOError, OSError):
pass
shutil.rmtree(join_path(prefix, "tmp"))
@run_after('install')
@on_package_attributes(run_tests=True)
def check_build(self):
make('-C', join_path(self.stage.path, 'charm/tests'),
'test', parallel=False)