admin/containers/scripted_gmx_docker_builds.py

   1 #!/usr/bin/env python
   2 #
   3 # This file is part of the GROMACS molecular simulation package.
   4 #
   5 # Copyright (c) 2020, by the GROMACS development team, led by
   6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
   7 # and including many others, as listed in the AUTHORS file in the
   8 # top-level source directory and at http://www.gromacs.org.
   9 #
  10 # GROMACS is free software; you can redistribute it and/or
  11 # modify it under the terms of the GNU Lesser General Public License
  12 # as published by the Free Software Foundation; either version 2.1
  13 # of the License, or (at your option) any later version.
  14 #
  15 # GROMACS is distributed in the hope that it will be useful,
  16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18 # Lesser General Public License for more details.
  19 #
  20 # You should have received a copy of the GNU Lesser General Public
  21 # License along with GROMACS; if not, see
  22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
  23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
  24 #
  25 # If you want to redistribute modifications to GROMACS, please
  26 # consider that scientific software is very special. Version
  27 # control is crucial - bugs must be traceable. We will be happy to
  28 # consider code for inclusion in the official distribution, but
  29 # derived work must not be called official GROMACS. Details are found
  30 # in the README & COPYING files - if they are missing, get the
  31 # official version at http://www.gromacs.org.
  32 #
  33 # To help us fund GROMACS development, we humbly ask that you cite
  34 # the research papers on the package. Check out http://www.gromacs.org.
  35
  36 """Building block based Dockerfile generation for CI testing images.
  37
  38 Generates a set of docker images used for running GROMACS CI on Gitlab.
  39 The images are prepared according to a selection of build configuration targets
  40 that hope to cover a broad enough scope of different possible systems,
  41 allowing us to check compiler types and versions, as well as libraries used
  42 for accelerators and parallel communication systems. Each combinations is
  43 described as an entry in the build_configs dictionary, with the script
  44 analysing the logic and adding build stages as needed.
  45
  46 Based on the example script provided by the NVidia HPCCM repository.
  47
  48 Reference:
  49     `NVidia HPC Container Maker <https://github.com/NVIDIA/hpc-container-maker>`__
  50
  51 Authors:
  52     * Paul Bauer <paul.bauer.q@gmail.com>
  53     * Eric Irrgang <ericirrgang@gmail.com>
  54     * Joe Jordan <e.jjordan12@gmail.com>
  55     * Mark Abraham <mark.j.abraham@gmail.com>
  56
  57 Usage::
  58
  59     $ python3 scripted_gmx_docker_builds.py --help
  60     $ python3 scripted_gmx_docker_builds.py --format docker > Dockerfile && docker build .
  61     $ python3 scripted_gmx_docker_builds.py | docker build -
  62
  63 See Also:
  64     :file:`buildall.sh`
  65
  66 """
  67
  68 import argparse
  69 import collections
  70 import typing
  71 from distutils.version import StrictVersion
  72
  73 import hpccm
  74 import hpccm.config
  75 from hpccm.building_blocks.base import bb_base
  76
  77 try:
  78     import utility
  79 except ImportError:
  80     raise RuntimeError(
  81         'This module assumes availability of supporting modules in the same directory. Add the directory to '
  82         'PYTHONPATH or invoke Python from within the module directory so module location can be resolved.')
  83
  84 # Basic packages for all final images.
  85 _common_packages = ['build-essential',
  86                     'ca-certificates',
  87                     'ccache',
  88                     'git',
  89                     'gnupg',
  90                     'gpg-agent',
  91                     'libfftw3-dev',
  92                     'libhwloc-dev',
  93                     'liblapack-dev',
  94                     'libx11-dev',
  95                     'moreutils',
  96                     'ninja-build',
  97                     'rsync',
  98                     'valgrind',
  99                     'vim',
 100                     'wget',
 101                     'xsltproc']
 102
 103 _opencl_extra_packages = [
 104     'nvidia-opencl-dev',
 105     # The following require apt_ppas=['ppa:intel-opencl/intel-opencl']
 106     'intel-opencl-icd',
 107     'ocl-icd-libopencl1',
 108     'ocl-icd-opencl-dev',
 109     'opencl-headers',
 110     # The following require
 111     #             apt_keys=['http://repo.radeon.com/rocm/apt/debian/rocm.gpg.key'],
 112     #             apt_repositories=['deb [arch=amd64] http://repo.radeon.com/rocm/apt/debian/ xenial main']
 113     'libelf1',
 114     'rocm-opencl',
 115     'rocm-dev',
 116     'clinfo'
 117 ]
 118
 119 # Extra packages needed to build Python installations from source.
 120 _python_extra_packages = ['build-essential',
 121                           'ca-certificates',
 122                           'ccache',
 123                           'curl',
 124                           'git',
 125                           'libbz2-dev',
 126                           'libffi-dev',
 127                           'liblzma-dev',
 128                           'libncurses5-dev',
 129                           'libncursesw5-dev',
 130                           'libreadline-dev',
 131                           'libsqlite3-dev',
 132                           'libssl-dev',
 133                           'llvm',
 134                           'python-openssl',
 135                           'vim',
 136                           'wget',
 137                           'zlib1g-dev']
 138
 139 # Extra packages needed for images for building documentation.
 140 _docs_extra_packages = ['autoconf',
 141                         'automake',
 142                         'autopoint',
 143                         'autotools-dev',
 144                         'bison',
 145                         'flex',
 146                         'ghostscript',
 147                         'graphviz',
 148                         'help2man',
 149                         'imagemagick',
 150                         'libtool',
 151                         'linkchecker',
 152                         'mscgen',
 153                         'm4',
 154                         'openssh-client',
 155                         'texinfo',
 156                         'texlive-latex-base',
 157                         'texlive-latex-extra',
 158                         'texlive-fonts-recommended',
 159                         'texlive-fonts-extra']
 160
 161 # Parse command line arguments
 162 parser = argparse.ArgumentParser(description='GROMACS CI image creation script',
 163                                  parents=[utility.parser])
 164
 165 parser.add_argument('--format', type=str, default='docker',
 166                     choices=['docker', 'singularity'],
 167                     help='Container specification format (default: docker)')
 168
 169
 170 def base_image_tag(args) -> str:
 171     # Check if we use CUDA images or plain linux images
 172     if args.cuda is not None:
 173         cuda_version_tag = 'nvidia/cuda:' + args.cuda + '-devel'
 174         if args.centos is not None:
 175             cuda_version_tag += '-centos' + args.centos
 176         elif args.ubuntu is not None:
 177             cuda_version_tag += '-ubuntu' + args.ubuntu
 178         else:
 179             raise RuntimeError('Logic error: no Linux distribution selected.')
 180
 181         base_image_tag = cuda_version_tag
 182     else:
 183         if args.centos is not None:
 184             base_image_tag = 'centos:centos' + args.centos
 185         elif args.ubuntu is not None:
 186             base_image_tag = 'ubuntu:' + args.ubuntu
 187         else:
 188             raise RuntimeError('Logic error: no Linux distribution selected.')
 189     return base_image_tag
 190
 191
 192 def get_llvm_packages(args) -> typing.Iterable[str]:
 193     # If we use the package version of LLVM, we need to install extra packages for it.
 194     if (args.llvm is not None) and (args.tsan is None):
 195         return ['libomp-dev',
 196                 'libomp5',
 197                 'clang-format-' + str(args.llvm),
 198                 'clang-tidy-' + str(args.llvm)]
 199     else:
 200         return []
 201
 202
 203 def get_opencl_packages(args) -> typing.Iterable[str]:
 204     if (args.doxygen is None) and (args.oneapi is None):
 205         return _opencl_extra_packages
 206     else:
 207         return []
 208
 209
 210 def get_compiler(args, compiler_build_stage: hpccm.Stage = None) -> bb_base:
 211     # Compiler
 212     if args.icc is not None:
 213         raise RuntimeError('Intel compiler toolchain recipe not implemented yet')
 214
 215     if args.llvm is not None:
 216         # Build our own version instead to get TSAN + OMP
 217         if args.tsan is not None:
 218             if compiler_build_stage is not None:
 219                 compiler = compiler_build_stage.runtime(_from='tsan')
 220             else:
 221                 raise RuntimeError('No TSAN compiler build stage!')
 222         # Build the default compiler if we don't need special support
 223         else:
 224             compiler = hpccm.building_blocks.llvm(extra_repository=True, version=args.llvm)
 225
 226     elif args.oneapi is not None:
 227         if compiler_build_stage is not None:
 228             compiler = compiler_build_stage.runtime(_from='oneapi')
 229             # Prepare the toolchain (needed only for builds done within the Dockerfile, e.g.
 230             # OpenMPI builds, which don't currently work for other reasons)
 231             oneapi_toolchain = hpccm.toolchain(CC='/opt/intel/oneapi/compiler/latest/linux/bin/intel64/icc',
 232                                                CXX='/opt/intel/oneapi/compiler/latest/linux/bin/intel64/icpc')
 233             setattr(compiler, 'toolchain', oneapi_toolchain)
 234
 235         else:
 236             raise RuntimeError('No oneAPI compiler build stage!')
 237
 238     elif args.gcc is not None:
 239         compiler = hpccm.building_blocks.gnu(extra_repository=True,
 240                                              version=args.gcc,
 241                                              fortran=False)
 242     else:
 243         raise RuntimeError('Logic error: no compiler toolchain selected.')
 244     return compiler
 245
 246
 247 def get_mpi(args, compiler):
 248     # If needed, add MPI to the image
 249     if args.mpi is not None:
 250         if args.mpi == 'openmpi':
 251             use_cuda = False
 252             if args.cuda is not None:
 253                 use_cuda = True
 254
 255             if hasattr(compiler, 'toolchain'):
 256                 if args.oneapi is not None:
 257                     raise RuntimeError('oneAPI building OpenMPI is not supported')
 258                 return hpccm.building_blocks.openmpi(toolchain=compiler.toolchain, cuda=use_cuda, infiniband=False)
 259             else:
 260                 raise RuntimeError('compiler is not an HPCCM compiler building block!')
 261
 262         elif args.mpi == 'impi':
 263             # TODO Intel MPI from the oneAPI repo is not working reliably,
 264             # reasons are unclear. When solved, add packagages called:
 265             # 'intel-oneapi-mpi', 'intel-oneapi-mpi-devel'
 266             # during the compiler stage.
 267             # TODO also consider hpccm's intel_mpi package if that doesn't need
 268             # a license to run.
 269             raise RuntimeError('Intel MPI recipe not implemented yet.')
 270         else:
 271             raise RuntimeError('Requested unknown MPI implementation.')
 272     else:
 273         return None
 274
 275
 276 def get_clfft(args):
 277     if (args.clfft is not None):
 278         return hpccm.building_blocks.generic_cmake(
 279             repository='https://github.com/clMathLibraries/clFFT.git',
 280             prefix='/usr/local', recursive=True, branch=args.clfft, directory='clFFT/src')
 281     else:
 282         return None
 283
 284
 285 def add_tsan_compiler_build_stage(input_args, output_stages: typing.Mapping[str, hpccm.Stage]):
 286     """Isolate the expensive TSAN preparation stage.
 287
 288     This is a very expensive stage, but has few and disjoint dependencies, and
 289     its output is easily compartmentalized (/usr/local) so we can isolate this
 290     build stage to maximize build cache hits and reduce rebuild time, bookkeeping,
 291     and final image size.
 292     """
 293     if not isinstance(output_stages, collections.abc.MutableMapping):
 294         raise RuntimeError('Need output_stages container.')
 295     tsan_stage = hpccm.Stage()
 296     tsan_stage += hpccm.primitives.baseimage(image=base_image_tag(input_args), _as='tsan')
 297
 298     tsan_stage += hpccm.building_blocks.packages(ospackages=['git', 'ca-certificates', 'build-essential', 'cmake'])
 299     # CMake will get duplicated later, but this is an expensive image, and it isn't worth optimizing
 300     # out that duplication...
 301     tsan_stage += hpccm.building_blocks.python(python3=True, python2=False, devel=False)
 302
 303     compiler_branch = 'release_' + str(input_args.llvm) + '0'
 304     tsan_stage += hpccm.building_blocks.generic_cmake(
 305         repository='https://git.llvm.org/git/llvm.git',
 306         prefix='/usr/local', recursive=True, branch=compiler_branch,
 307         cmake_opts=['-D CMAKE_BUILD_TYPE=Release', '-D LLVM_ENABLE_PROJECTS="clang;openmp;clang-tools-extra"',
 308                     '-D LIBOMP_TSAN_SUPPORT=on'],
 309         preconfigure=['export branch=' + compiler_branch,
 310                       '(cd projects; git clone --depth=1 --branch $branch https://git.llvm.org/git/libcxx.git)',
 311                       '(cd projects; git clone --depth=1 --branch $branch https://git.llvm.org/git/libcxxabi.git)',
 312                       '(cd projects; git clone --depth=1 --branch $branch https://git.llvm.org/git/compiler-rt.git)',
 313                       '(cd ..; git clone --depth=1 --branch $branch https://git.llvm.org/git/openmp.git)',
 314                       '(cd ..; git clone --depth=1 --branch $branch https://git.llvm.org/git/clang.git)',
 315                       '(cd ..; git clone --depth=1 --branch $branch https://git.llvm.org/git/clang-tools-extra.git)'],
 316         postinstall=['ln -s /usr/local/bin/clang++ /usr/local/bin/clang++-' + str(input_args.llvm),
 317                      'ln -s /usr/local/bin/clang-format /usr/local/bin/clang-format-' + str(input_args.llvm),
 318                      'ln -s /usr/local/bin/clang-tidy /usr/local/bin/clang-tidy-' + str(input_args.llvm),
 319                      'ln -s /usr/local/libexec/c++-analyzer /usr/local/bin/c++-analyzer-' + str(input_args.llvm)])
 320     output_stages['compiler_build'] = tsan_stage
 321
 322 def oneapi_runtime(_from='0'):
 323     oneapi_runtime_stage = hpccm.Stage()
 324     oneapi_runtime_stage += hpccm.primitives.copy(_from='oneapi-build',
 325                                                   files={"/opt/intel": "/opt/intel",
 326                                                          "/etc/bash.bashrc": "/etc/bash.bashrc"})
 327     return oneapi_runtime_stage
 328
 329 def add_oneapi_compiler_build_stage(input_args, output_stages: typing.Mapping[str, hpccm.Stage]):
 330     """Isolate the oneAPI preparation stage.
 331
 332     This stage is isolated so that its installed components are minimized in the
 333     final image (chiefly /opt/intel) and its environment setup script can be
 334     sourced. This also helps with rebuild time and final image size.
 335
 336     Note that the ICC compiler inside oneAPI on linux also needs
 337     gcc to build other components and provide libstdc++.
 338     """
 339     if not isinstance(output_stages, collections.abc.MutableMapping):
 340         raise RuntimeError('Need output_stages container.')
 341     oneapi_stage = hpccm.Stage()
 342     oneapi_stage += hpccm.primitives.baseimage(image=base_image_tag(input_args), _as='oneapi-build')
 343
 344     version = str(input_args.oneapi)
 345
 346     # Add required components for the next stage (both for hpccm and Intel's setvars.sh script)
 347     oneapi_stage += hpccm.building_blocks.packages(ospackages=['wget', 'gnupg2', 'ca-certificates', 'lsb-release'])
 348     oneapi_stage += hpccm.building_blocks.packages(
 349         apt_keys=['https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB'],
 350         apt_repositories=['deb https://apt.repos.intel.com/oneapi all main'],
 351         # Add minimal packages (not the whole HPC toolkit!)
 352         ospackages=['intel-oneapi-dpcpp-cpp-compiler-pro-{}'.format(version),
 353             'intel-oneapi-openmp-{}'.format(version),
 354             'intel-oneapi-mkl-{}'.format(version),
 355             'intel-oneapi-mkl-devel-{}'.format(version)]
 356     )
 357     # Ensure that all bash shells on the final container will have access to oneAPI
 358     oneapi_stage += hpccm.primitives.shell(
 359             commands=['echo "source /opt/intel/oneapi/setvars.sh" >> /etc/bash.bashrc']
 360             )
 361     setattr(oneapi_stage, 'runtime', oneapi_runtime)
 362
 363     output_stages['compiler_build'] = oneapi_stage
 364
 365 def prepare_venv(version: StrictVersion) -> typing.Sequence[str]:
 366     """Get shell commands to set up the venv for the requested Python version."""
 367     major = version.version[0]
 368     minor = version.version[1]  # type: int
 369
 370     pyenv = '$HOME/.pyenv/bin/pyenv'
 371
 372     py_ver = '{}.{}'.format(major, minor)
 373     venv_path = '$HOME/venv/py{}'.format(py_ver)
 374     commands = ['$({pyenv} prefix `{pyenv} whence python{py_ver}`)/bin/python -m venv {path}'.format(
 375         pyenv=pyenv,
 376         py_ver=py_ver,
 377         path=venv_path
 378     )]
 379
 380     commands.append('{path}/bin/python -m pip install --upgrade pip setuptools'.format(
 381         path=venv_path
 382     ))
 383     # Install dependencies for building and testing gmxapi Python package.
 384     # WARNING: Please keep this list synchronized with python_packaging/requirements-test.txt
 385     # TODO: Get requirements.txt from an input argument.
 386     commands.append("""{path}/bin/python -m pip install --upgrade \
 387             'cmake>=3.13' \
 388             'flake8>=3.7.7' \
 389             'mpi4py>=3.0.3' \
 390             'networkx>=2.0' \
 391             'numpy>=1' \
 392             'pip>=10.1' \
 393             'pytest>=3.9' \
 394             'setuptools>=42' \
 395             'scikit-build>=0.10'""".format(path=venv_path))
 396
 397     # TODO: Remove 'importlib_resources' dependency when Python >=3.7 is required.
 398     if minor == 6:
 399         commands.append("""{path}/bin/python -m pip install --upgrade \
 400                 'importlib_resources'""".format(path=venv_path))
 401
 402     return commands
 403
 404
 405 def add_python_stages(building_blocks: typing.Mapping[str, bb_base],
 406                       input_args,
 407                       output_stages: typing.MutableMapping[str, hpccm.Stage]):
 408     """Add the stage(s) necessary for the requested venvs.
 409
 410     One intermediate build stage is created for each venv (see --venv option).
 411
 412     Each stage partially populates Python installations and venvs in the home
 413     directory. The home directory is collected by the 'pyenv' stage for use by
 414     the main build stage.
 415     """
 416     if len(input_args.venvs) < 1:
 417         raise RuntimeError('No venvs to build...')
 418     if output_stages is None or not isinstance(output_stages, collections.abc.Mapping):
 419         raise RuntimeError('Need a container for output stages.')
 420
 421     # Main Python stage that collects the environments from individual stages.
 422     # We collect the stages individually, rather than chaining them, because the
 423     # copy is a bit slow and wastes local Docker image space for each filesystem
 424     # layer.
 425     pyenv_stage = hpccm.Stage()
 426     pyenv_stage += hpccm.primitives.baseimage(image=base_image_tag(input_args), _as='pyenv')
 427     pyenv_stage += building_blocks['compiler']
 428     pyenv_stage += building_blocks['mpi']
 429     pyenv_stage += hpccm.building_blocks.packages(ospackages=_python_extra_packages)
 430
 431     for version in [StrictVersion(py_ver) for py_ver in sorted(input_args.venvs)]:
 432         stage_name = 'py' + str(version)
 433         stage = hpccm.Stage()
 434         stage += hpccm.primitives.baseimage(image=base_image_tag(input_args), _as=stage_name)
 435         stage += building_blocks['compiler']
 436         stage += building_blocks['mpi']
 437         stage += hpccm.building_blocks.packages(ospackages=_python_extra_packages)
 438
 439         # TODO: Use a non-root user for testing and Python virtual environments.
 440         stage += hpccm.primitives.shell(commands=[
 441             'curl https://pyenv.run | bash',
 442             """echo 'export PYENV_ROOT="$HOME/.pyenv"' >> $HOME/.bashrc""",
 443             """echo 'export PATH="$PYENV_ROOT/bin:$PATH"' >> $HOME/.bashrc""",
 444             """echo 'eval "$(pyenv init -)"' >> $HOME/.bashrc""",
 445             """echo 'eval "$(pyenv virtualenv-init -)"' >> $HOME/.bashrc"""])
 446         pyenv = '$HOME/.pyenv/bin/pyenv'
 447         commands = ['PYTHON_CONFIGURE_OPTS="--enable-shared" {pyenv} install -s {version}'.format(
 448             pyenv=pyenv,
 449             version=str(version))]
 450         stage += hpccm.primitives.shell(commands=commands)
 451
 452         commands = prepare_venv(version)
 453         stage += hpccm.primitives.shell(commands=commands)
 454
 455         # TODO: Update user home directory.
 456         pyenv_stage += hpccm.primitives.copy(_from=stage_name, _mkdir=True, src=['/root/'],
 457                                              dest='/root')
 458
 459         # Add the intermediate build stage to the sequence
 460         output_stages[stage_name] = stage
 461
 462     # TODO: If we activate pyenv for login shells, the `global` "version" should be full-featured.
 463     # # `version` should be a system installation or pyenv environment (or pyenv-virtualenv)
 464     # # with the dependencies for all of the Python aspects of CMake-driven builds.
 465     # commands = '{pyenv} global {version}'.format(
 466     #             pyenv=pyenv,
 467     #             version=...)
 468     # pyenv_stage += hpccm.primitives.shell(commands=commands)
 469
 470     # Add the aggregating build stage to the sequence. This allows the main stage to copy
 471     # the files in a single stage, potentially reducing the overall output image size.
 472     output_stages['pyenv'] = pyenv_stage
 473
 474
 475 def add_documentation_dependencies(input_args,
 476                                    output_stages: typing.MutableMapping[str, hpccm.Stage]):
 477     """Add appropriate layers according to doxygen input arguments."""
 478     if input_args.doxygen is None:
 479         return
 480     output_stages['main'] += hpccm.primitives.shell(
 481         commands=['sed -i \'/\"XPS\"/d;/\"PDF\"/d;/\"PS\"/d;/\"EPS\"/d;/disable ghostscript format types/d\' /etc/ImageMagick-6/policy.xml'])
 482     output_stages['main'] += hpccm.building_blocks.pip(pip='pip3', packages=['sphinx==1.6.1', 'gcovr'])
 483     if input_args.doxygen == '1.8.5':
 484         doxygen_commit = 'ed4ed873ab0e7f15116e2052119a6729d4589f7a'
 485         output_stages['main'] += hpccm.building_blocks.generic_autotools(
 486             repository='https://github.com/westes/flex.git',
 487             commit='f7788a9a0ecccdc953ed12043ccb59ca25714018',
 488             prefix='/tmp/install-of-flex',
 489             configure_opts=['--disable-shared'],
 490             preconfigure=['./autogen.sh'])
 491         output_stages['main'] += hpccm.building_blocks.generic_autotools(
 492             repository='https://github.com/doxygen/doxygen.git',
 493             commit=doxygen_commit,
 494             prefix='',
 495             configure_opts=[
 496                 '--flex /tmp/install-of-flex/bin/flex',
 497                 '--static'])
 498     else:
 499         version = input_args.doxygen
 500         archive_name = 'doxygen-{}.linux.bin.tar.gz'.format(version)
 501         archive_url = 'https://sourceforge.net/projects/doxygen/files/rel-{}/{}'.format(
 502             version,
 503             archive_name
 504         )
 505         binary_path = 'doxygen-{}/bin/doxygen'.format(version)
 506         commands = [
 507             'mkdir doxygen && cd doxygen',
 508             'wget {}'.format(archive_url),
 509             'tar xf {} {}'.format(archive_name, binary_path),
 510             'cp {} /usr/local/bin/'.format(binary_path),
 511             'cd .. && rm -rf doxygen'
 512         ]
 513         output_stages['main'] += hpccm.primitives.shell(commands=commands)
 514
 515
 516 def build_stages(args) -> typing.Iterable[hpccm.Stage]:
 517     """Define and sequence the stages for the recipe corresponding to *args*."""
 518
 519     # A Dockerfile or Singularity recipe can have multiple build stages.
 520     # The main build stage can copy files from previous stages, though only
 521     # the last stage is included in the tagged output image. This means that
 522     # large or expensive sets of build instructions can be isolated in
 523     # local/temporary images, but all of the stages need to be output by this
 524     # script, and need to occur in the correct order, so we create a sequence
 525     # object early in this function.
 526     stages = collections.OrderedDict()
 527
 528     # If we need TSAN or oneAPI support the early build is more complex,
 529     # so that our compiler images don't have all the cruft needed to get those things
 530     # installed.
 531     if args.llvm is not None and args.tsan is not None:
 532         add_tsan_compiler_build_stage(input_args=args, output_stages=stages)
 533     if args.oneapi is not None:
 534         add_oneapi_compiler_build_stage(input_args=args, output_stages=stages)
 535
 536     # Building blocks are chunks of container-builder instructions that can be
 537     # copied to any build stage with the addition operator.
 538     building_blocks = collections.OrderedDict()
 539     building_blocks['base_packages'] = hpccm.building_blocks.packages(
 540         ospackages=_common_packages)
 541
 542     # These are the most expensive and most reusable layers, so we put them first.
 543     building_blocks['compiler'] = get_compiler(args, compiler_build_stage=stages.get('compiler_build'))
 544     building_blocks['mpi'] = get_mpi(args, building_blocks['compiler'])
 545     for i, cmake in enumerate(args.cmake):
 546         building_blocks['cmake' + str(i)] = hpccm.building_blocks.cmake(
 547             eula=True,
 548             prefix='/usr/local/cmake-{}'.format(cmake),
 549             version=cmake)
 550
 551     # Install additional packages early in the build to optimize Docker build layer cache.
 552     os_packages = list(get_llvm_packages(args)) + get_opencl_packages(args)
 553     if args.doxygen is not None:
 554         os_packages += _docs_extra_packages
 555     if args.oneapi is not None:
 556         os_packages += ['lsb-release']
 557     building_blocks['extra_packages'] = hpccm.building_blocks.packages(
 558         ospackages=os_packages,
 559         apt_ppas=['ppa:intel-opencl/intel-opencl'],
 560         apt_keys=['http://repo.radeon.com/rocm/apt/debian/rocm.gpg.key'],
 561         apt_repositories=['deb [arch=amd64] http://repo.radeon.com/rocm/apt/debian/ xenial main']
 562     )
 563
 564     building_blocks['clfft'] = get_clfft(args)
 565
 566     # Add Python environments to MPI images, only, so we don't have to worry
 567     # about whether to install mpi4py.
 568     if args.mpi is not None and len(args.venvs) > 0:
 569         add_python_stages(building_blocks=building_blocks, input_args=args, output_stages=stages)
 570
 571     # Create the stage from which the targeted image will be tagged.
 572     stages['main'] = hpccm.Stage()
 573
 574     stages['main'] += hpccm.primitives.baseimage(image=base_image_tag(args))
 575     for bb in building_blocks.values():
 576         if bb is not None:
 577             stages['main'] += bb
 578
 579     # We always add Python3 and Pip
 580     stages['main'] += hpccm.building_blocks.python(python3=True, python2=False, devel=True)
 581     stages['main'] += hpccm.building_blocks.pip(upgrade=True, pip='pip3',
 582                                                 packages=['pytest', 'networkx', 'numpy'])
 583
 584     # Add documentation requirements (doxygen and sphinx + misc).
 585     if args.doxygen is not None:
 586         add_documentation_dependencies(args, stages)
 587
 588     if 'pyenv' in stages and stages['pyenv'] is not None:
 589         stages['main'] += hpccm.primitives.copy(_from='pyenv', _mkdir=True, src=['/root/.pyenv/'],
 590                                                 dest='/root/.pyenv')
 591         stages['main'] += hpccm.primitives.copy(_from='pyenv', _mkdir=True, src=['/root/venv/'],
 592                                                 dest='/root/venv')
 593         # TODO: Update user home directory.
 594         # TODO: If we activate pyenv for login shells, the `global` "version" should be full-featured.
 595         # stages['main'] += hpccm.primitives.copy(_from='pyenv', src=['/root/.bashrc'],
 596         #                                         dest='/root/')
 597
 598     # Make sure that `python` resolves to something.
 599     stages['main'] += hpccm.primitives.shell(commands=['test -x /usr/bin/python || '
 600                                                        'update-alternatives --install /usr/bin/python python /usr/bin/python3 1 && '
 601                                                        '/usr/bin/python --version'])
 602
 603     # Note that the list of stages should be sorted in dependency order.
 604     for build_stage in stages.values():
 605         if build_stage is not None:
 606             yield build_stage
 607
 608
 609 if __name__ == '__main__':
 610     args = parser.parse_args()
 611
 612     # Set container specification output format
 613     hpccm.config.set_container_format(args.format)
 614
 615     container_recipe = build_stages(args)
 616
 617     # Output container specification
 618     for stage in container_recipe:
 619         print(stage)