EESSI-extend-easybuild.eb

easyblock = 'Bundle'

name = 'EESSI-extend'
import os
version = os.getenv('EESSI_VERSION', '2023.06')
# May have different ways to extend EESSI in future (manually, other tools,...)
versionsuffix = '-easybuild'

homepage = 'https://eessi.io/docs/'

description = """
 The goal of the European Environment for Scientific Software Installations
 (EESSI, pronounced as "easy") is to build a common stack of scientific
 software installations for HPC systems and beyond, including laptops,
 personal workstations and cloud infrastructure.

 This module allows you to extend EESSI using the same configuration for
 EasyBuild as EESSI itself uses. A number of environment variables control the
 behaviour of the module:
 - EESSI_USER_INSTALL can be set to a location to install modules for use by
   the user only. The location must already exist on the filesystem.
 - EESSI_PROJECT_INSTALL can be set to a location to install modules for use by
   a project. The location must already exist on the filesystem and you should
   ensure that the location has the correct Linux group and the SGID permission
   is set on that directory (`chmod g+s $EESSI_PROJECT_INSTALL`) so that all
   members of the group have permission to read and write installations.
 - EESSI_SITE_INSTALL is either defined or not and cannot be used with another
   environment variable. A site installation is done in a defined location and
   any installations there are (by default) world readable.
 - EESSI_CVMFS_INSTALL is either defined or not and cannot be used with another
   environment variable. A CVMFS installation targets a defined location which
   will be ingested into CVMFS and is only useful for CVMFS administrators.
 - If none of the environment variables above are defined, an EESSI_USER_INSTALL
   is assumed with a value of $HOME/EESSI
 If both EESSI_USER_INSTALL and EESSI_PROJECT_INSTALL are defined, both sets of
 installations are exposed, but new installations are created as user
 installations.

 Strict installation path checking is enforced by EESSI for EESSI and site
 installations involving accelerators. In these cases, if you wish to create an
 accelerator installation you must set the environment variable
 EESSI_ACCELERATOR_INSTALL (and load/reload this module).
"""

toolchain = SYSTEM

# All the dependencies we filter in EESSI
local_deps_to_filter = "binutils,bzip2,DBus,flex,gettext,gperf,help2man,intltool,libreadline,makeinfo,ncurses,NVPL,ParMETIS,util-linux,XZ,zlib"

# Filter extra dependencies based on CPU family
local_arch_specific_deps_to_filter = {'aarch64': ',Yasm', 'riscv64': ',Yasm', 'x86_64': ''}
local_deps_to_filter += local_arch_specific_deps_to_filter[ARCH]

# Only filter Autotools & co for EESSI 2023.06
if version == '2023.06':
    local_deps_to_filter += ",Autoconf,Automake,Autotools,libtool,M4"

# Set the universal EasyBuild variables
modextravars = {
    'EASYBUILD_FILTER_DEPS': local_deps_to_filter,
    'EASYBUILD_IGNORE_OSDEPS': '1',
    'EASYBUILD_DEBUG': '1',
    'EASYBUILD_TRACE': '1',
    'EASYBUILD_ZIP_LOGS': 'bzip2',
    'EASYBUILD_RPATH': '1',
    'EASYBUILD_FILTER_ENV_VARS': 'LD_LIBRARY_PATH',
    'EASYBUILD_READ_ONLY_INSTALLDIR': '1',
    'EASYBUILD_MODULE_EXTENSIONS': '1',
    'EASYBUILD_EXPERIMENTAL': '1',
}

# Need a few other variables, but they are more dynamic
# EASYBUILD_SYSROOT=${EPREFIX}
# EASYBUILD_PREFIX=${WORKDIR}/easybuild
# EASYBUILD_HOOKS=${EESSI_PREFIX}/init/easybuild/eb_hooks.py
# EASYBUILD_INSTALLPATH=${EESSI_PREFIX}/software/${EESSI_OS_TYPE}/${EESSI_SOFTWARE_SUBDIR}
# EASYBUILD_SOURCEPATH=${WORKDIR}/easybuild/sources:${EESSI_SOURCEPATH}
#
# And also some optional ones based on the installation mode
# EASYBUILD_SET_GID_BIT
# EASYBUILD_GROUP_WRITABLE_INSTALLDIR
# EASYBUILD_UMASK
# EASYBUILD_STICKY_BIT
modluafooter = """
if (mode() == "load") then
  -- Use a working directory for temporary build files
  if (os.getenv("WORKING_DIR") == nil) then
    LmodMessage("-- Using /tmp/$USER as a temporary working directory for installations, you can override this by setting the environment variable WORKING_DIR and reloading the module (e.g., /dev/shm is a common option)")
  end
end
working_dir = os.getenv("WORKING_DIR") or pathJoin("/tmp", os.getenv("USER"))

-- Gather the EPREFIX to use as a sysroot
sysroot = os.getenv("EESSI_EPREFIX")

-- Check if we have GPU capabilities and configure AMD/CUDA compute capabilities
eessi_accelerator_target = os.getenv("EESSI_ACCELERATOR_TARGET")
if (eessi_accelerator_target ~= nil) then
  cuda_compute_capability = string.match(eessi_accelerator_target, "^accel/nvidia/cc([0-9]+)$")
  amd_compute_capability = string.match(eessi_accelerator_target, "^accel/amd/(gfx[0-9a-f]+)$")

  if (cuda_compute_capability ~= nil) then
    -- The last digit should be the minor version, insert a dot in the one-but-last position
    major_version = cuda_compute_capability:sub(1, #cuda_compute_capability - 1)
    minor_version = cuda_compute_capability:sub(#cuda_compute_capability)
    easybuild_cuda_compute_capabilities = string.format("%s.%s", major_version, minor_version)

    -- If architectures are 9.0, 10.0 or 12.0, enable architecture or family-specific optimizations
    if easybuild_cuda_compute_capabilities == '9.0' then
      easybuild_cuda_compute_capabilities = '9.0a'
    elseif easybuild_cuda_compute_capabilities == '10.0' then
      easybuild_cuda_compute_capabilities = '10.0f'
    elseif easybuild_cuda_compute_capabilities == '12.0' then
      easybuild_cuda_compute_capabilities = '12.0f'
    end
  elseif (amd_compute_capability ~= nil) then
    easybuild_amdgcn_compute_capabilities = amd_compute_capability
  else
    LmodError("Incorrect value for $EESSI_ACCELERATOR_TARGET: " .. eessi_accelerator_target)
  end
end

-- Some environment variables affect behaviour, let's gather them once
local eessi_cvmfs_install = os.getenv("EESSI_CVMFS_INSTALL") ~= nil
local eessi_site_install = os.getenv("EESSI_SITE_INSTALL") ~= nil
local eessi_project_install = os.getenv("EESSI_PROJECT_INSTALL") ~= nil
local eessi_user_install = os.getenv("EESSI_USER_INSTALL") ~= nil

-- Use an installation prefix that we _should_ have write access to
if eessi_cvmfs_install then
  -- Make sure no other EESSI install environment variables are set
  if (eessi_site_install or eessi_project_install or eessi_user_install) then
    LmodError("You cannot use EESSI_CVMFS_INSTALL in combination with any other EESSI_*_INSTALL environment variables")
  end
  easybuild_installpath = os.getenv("EESSI_SOFTWARE_PATH")
  -- Enforce accelerator subdirectory usage for CVMFS installs (only if an accelerator install is requested)
  if (eessi_accelerator_target ~= nil) and (cuda_compute_capability ~= nil or amd_compute_capability ~= nil) and (os.getenv("EESSI_ACCELERATOR_INSTALL") ~= nil) then
      easybuild_installpath = pathJoin(easybuild_installpath, eessi_accelerator_target)
  end
elseif eessi_site_install then
  -- Make sure no other EESSI install environment variables are set
  if (eessi_project_install or eessi_user_install) then
    LmodError("You cannot use EESSI_SITE_INSTALL in combination with any other EESSI_*_INSTALL environment variables")
  end
  easybuild_installpath = os.getenv("EESSI_SITE_SOFTWARE_PATH")
  -- Check that the plain EESSI_SITE_SOFTWARE_PATH exists
  if not isDir(easybuild_installpath) then
      installpath_warning = "The location of EESSI_SITE_SOFTWARE_PATH (" .. easybuild_installpath .. ") does not exist or is not a directory. "
      installpath_warning = installpath_warning .. "If you have sufficient permissions this location will be created, otherwise you will run into errors."
      LmodWarning(installpath_warning)
  end
  -- Enforce accelerator subdirectory usage for site installs (only if an accelerator install is requested)
  if (eessi_accelerator_target ~= nil) and (cuda_compute_capability ~= nil) and (os.getenv("EESSI_ACCELERATOR_INSTALL") ~= nil) then
      easybuild_installpath = pathJoin(easybuild_installpath, eessi_accelerator_target)
      -- Check that the EESSI_SITE_SOFTWARE_PATH with eessi_accelerator_target prefix exists
      if not isDir(easybuild_installpath) then
      installpath_warning = "The location of EESSI_SITE_SOFTWARE_PATH (" .. easybuild_installpath .. ") does not exist or is not a directory. "
      installpath_warning = installpath_warning .. "If you have sufficient permissions this location will be created, otherwise you will run into errors."
      LmodWarning(installpath_warning)
      end
  end
else
  -- Deal with user and project installs
  project_install_dir = os.getenv("EESSI_PROJECT_INSTALL")
  project_modulepath = nil
  if eessi_project_install then
    -- Check the folder exists
    if not isDir(project_install_dir) then
      LmodError("The location of EESSI_PROJECT_INSTALL (" .. project_install_dir .. ") does not exist or is not a folder")
    end
    if (mode() == "load") then
      LmodMessage("Configuring for use of EESSI_PROJECT_INSTALL under " .. project_install_dir)
    end
    easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), project_install_dir)
    project_modulepath = pathJoin(easybuild_installpath, 'modules', 'all')
  end
  user_install_dir = os.getenv("EESSI_USER_INSTALL")
  user_modulepath = nil
  if eessi_user_install then
    -- Check the folder exists
    if not isDir(user_install_dir) then
      LmodError("The location of EESSI_USER_INSTALL (" .. user_install_dir .. ") does not exist or is not a folder")
    end
  elseif (user_install_dir == nil) and (project_install_dir == nil) then
    -- No need to check for existence when we use a HOME subdir
    user_install_dir = pathJoin(os.getenv("HOME"), "eessi")
  end
  if (user_install_dir ~= nil) then
    if (mode() == "load") then
      LmodMessage("Configuring for use of EESSI_USER_INSTALL under " .. user_install_dir)
    end
    easybuild_installpath = string.gsub(os.getenv("EESSI_SOFTWARE_PATH"), os.getenv("EESSI_CVMFS_REPO"), user_install_dir)
    user_modulepath = pathJoin(easybuild_installpath, 'modules', 'all')
  end
end
if (mode() == "load") then
  LmodMessage("-- To create installations for EESSI, you _must_ have write permissions to " .. easybuild_installpath)
  -- Advise them to reuse sources
  if (os.getenv("EASYBUILD_SOURCEPATH") == nil) then
    LmodMessage("-- You may wish to configure a sources directory for EasyBuild (for example, via setting the environment variable EASYBUILD_SOURCEPATH) to allow you to reuse existing sources for packages.")
  end
end
-- Set the relevant universal environment variables for EasyBuild
setenv ("EASYBUILD_SYSROOT", sysroot)
setenv ("EASYBUILD_PREFIX", pathJoin(working_dir, "easybuild"))
setenv ("EASYBUILD_INSTALLPATH", easybuild_installpath)
eessi_init_prefix = os.getenv("EESSI_INIT_PREFIX") or pathJoin(os.getenv("EESSI_PREFIX"), "init")
eessi_easybuild_hooks_override = os.getenv("EESSI_EASYBUILD_HOOKS_OVERRIDE")
if (eessi_easybuild_hooks_override ~= nil) then
  setenv ("EASYBUILD_HOOKS", eessi_easybuild_hooks_override)
else
  setenv ("EASYBUILD_HOOKS", pathJoin(eessi_init_prefix, "easybuild", "eb_hooks.py"))
end

-- Make sure to use the general umask that allows a global read
setenv ("EASYBUILD_UMASK", "022")

-- Allow this module to be loaded when running EasyBuild
setenv ("EASYBUILD_ALLOW_LOADED_MODULES", "EasyBuild,EESSI-extend")

-- Set environment variables if building for CUDA compute capabilities
if (easybuild_cuda_compute_capabilities ~= nil) then
  setenv ("EASYBUILD_CUDA_COMPUTE_CAPABILITIES", easybuild_cuda_compute_capabilities)
end

-- Set environment variables if building for AMDGCN compute capabilities
if (easybuild_amdgcn_compute_capabilities ~= nil) then
  setenv ("EASYBUILD_AMDGCN_CAPABILITIES", easybuild_amdgcn_compute_capabilities)
end

-- Set all related environment variables if we have project or user installations (including extending MODULEPATH)
if (user_modulepath ~= nil) then
  -- Use a more restrictive umask for this case
  setenv ("EASYBUILD_UMASK", "077")
  setenv ("EASYBUILD_STICKY_BIT", "1")
  -- configure MODULEPATH
  if (project_modulepath ~= nil) then
    prepend_path("MODULEPATH", project_modulepath)
  end
  prepend_path("MODULEPATH", user_modulepath)
elseif (project_modulepath ~= nil) then
  setenv ("EASYBUILD_SET_GID_BIT", "1")
  setenv ("EASYBUILD_GROUP_WRITABLE_INSTALLDIR", "1")
  setenv ("EASYBUILD_STICKY_BIT", "0")
  setenv ("EASYBUILD_UMASK", "002")
  -- configure MODULEPATH
  prepend_path("MODULEPATH", project_modulepath)
end

-- Make sure EasyBuild itself is loaded
-- need to also handle the unload behaviour where the version is defined only before we unload
-- (also provide a sensible default for cases like 'module show' where the modules are never loaded at all)
easybuild_version = os.getenv("EBVERSIONEASYBUILD") or "5.1.1"
if not ( isloaded("EasyBuild") ) then
    load(latest("EasyBuild"))
end
easybuild_version = os.getenv("EBVERSIONEASYBUILD") or easybuild_version
eessi_version = os.getenv("EESSI_VERSION") or "2023.06"

-- Set environment variables that are EasyBuild version specific
-- Do unload unconditionally, so that even if EB versions were switched in the meantime, this gets unset
-- This avoids issues where EESSI-extend is first loaded with EB => 5.1 (which set these vars)
-- but then EB is swapped for a version < 5.1 and then EESSI-extend is unloaded (which would not unset
-- these vars if we did it conditional on the EB version)
if mode() == "unload" or mode() == "dependencyCk" or convertToCanonical(easybuild_version) >= convertToCanonical("5.1") then
  setenv ("EASYBUILD_STRICT_RPATH_SANITY_CHECK", "1")
  setenv ("EASYBUILD_CUDA_SANITY_CHECK_ERROR_ON_FAILED_CHECKS", "1")
  setenv ("EASYBUILD_FAIL_ON_MOD_FILES_GCCCORE", "1")
  setenv ("EASYBUILD_LOCAL_VAR_NAMING_CHECK", "error")
  setenv ("EASYBUILD_PARALLEL_EXTENSIONS_INSTALL", "1")
  -- Set environment variables that are EESSI version specific
  if convertToCanonical(eessi_version) > convertToCanonical("2023.06") then
    setenv ("EASYBUILD_PREFER_PYTHON_SEARCH_PATH", "EBPYTHONPREFIXES")
    -- Note: make sure to *not* use same setting for both module-search-path-headers and search-path-cpp-headers
    -- EasyBuild configuration options, since this leads to trouble because (for example) $C_INCLUDE_PATH
    -- only includes paths for the *direct* dependencies (not transitive dependencies)
    -- when using EasyBuild v5.2.1 or earlier
    setenv ("EASYBUILD_MODULE_SEARCH_PATH_HEADERS", "include_paths")
    setenv ("EASYBUILD_SEARCH_PATH_CPP_HEADERS", "flags")
  end
end

-- Avoid locale related problems by (temporarily) overwriting the locale with one we know exists ('locale -a')
pushenv ("LANG", "C.utf8")
pushenv ("LC_ALL", "C.utf8")
pushenv ("LC_CTYPE", "C.utf8")
pushenv ("LC_MESSAGES", "C.utf8")

"""

moduleclass = 'devel'