Skip to content

Spack

概念:spec

A spec is like a name, but it has a version, compiler, architecture, and build options associated with it. In spack, you can have many installations of the same package with different specs.

spec 是 Spack 中按特定选项构建的一个软件包,包含软件包名、版本、编译器、选项等信息。比如 gcc@12.2.0 就是一个 spec。对于一个软件包,我们可以用不同的编译选项选项构建多个 Spec。

使用 spack find -dvf 可以查看 spec 的详细信息:

$ spack find -dfv
-- linux-debian12-icelake / gcc@12.2.0 --------------------------
cuda@11.8.0%gcc ~allow-unsupported-compilers+dev build_system=generic
    gcc-runtime@12.2.0%gcc  build_system=generic
    glibc@2.36%gcc  build_system=autotools
    libxml2@2.10.3%gcc +pic~python+shared build_system=autotools
        gmake@4.3%gcc ~guile build_system=generic patches=599f134
        libiconv@1.17%gcc  build_system=autotools libs=shared,static
        pkgconf@1.8.1%gcc  build_system=autotools
        xz@5.4.6%gcc ~pic build_system=autotools libs=shared,static
        zlib-ng@2.1.6%gcc +compat+new_strategies+opt+pic+shared build_system=autotools

Spec 的常用符号含义如下:

Symbol Example Description
@ @1.2:1.4 指定版本
^ ^gcc@4.7 依赖项
% %gcc@4.7 指定编译器
+-~ +mpi 布尔类型选项
~- 等价,用于某些情况下阻止 shell 解析
++--~~ ++mpi 布尔类型选项,在依赖之间传递
name=<value> build_system=cmake 指定选项的值
name==<value> build_system==cmake 指定选项的值,在依赖之间传递
<flag>=<flags> cflags=-O3 特殊的编译器选项,如:cflags, cxxflags, fflags, cppflags, ldflags, and ldlibs

对于本地安装的 spec,还可以通过 / 哈希值来指定:

$ spack location --install-dir cuda
==> Error: cuda matches multiple packages.
Matching packages:
    ngtuhol cuda@11.8.0%gcc@12.2.0 arch=linux-debian12-icelake
    bthqeln cuda@12.4.0%gcc@12.2.0 arch=linux-debian12-icelake
Use a more specific spec (e.g., prepend '/' to the hash).
$ spack location --install-dir cuda/ngtuhol
/opt/spack/opt/spack/linux-debian12-icelake/gcc-12.2.0/cuda-11.8.0-ngtuholoe4xatxmphodttdett3rmhjrr

一些复杂的 Spec 可以使用引号括起作为一个参数传递,否则 Spack 会识别错误。例如 spack diff <spec> <spec>

$ spack diff intel-oneapi-compilers arch=linux-debian12-icelake intel-oneapi-compilers arch=linux-debian12-zen3
==> Error: You must provide two specs to diff.
$ spack diff 'intel-oneapi-compilers arch=linux-debian12-icelake' 'intel-oneapi-compilers arch=linux-debian12-zen3'

--- intel-oneapi-compilers@2025.0.4/jwh4nndynkcqhogdltdrxjkiilvulwyg
+++ intel-oneapi-compilers@2025.0.4/zc7x2awdl3jriiydjaozmaizjhcsp2u5
@@ hash @@
- intel-oneapi-compilers jwh4nndynkcqhogdltdrxjkiilvulwyg
+ intel-oneapi-compilers zc7x2awdl3jriiydjaozmaizjhcsp2u5
@@ node_target @@
- intel-oneapi-compilers icelake
+ intel-oneapi-compilers zen3

使用软件包

Spack 中的软件包有三种使用方式:

  • spack load:使用单个软件包。比如

    spack load gcc@11.2.0
    
  • Module:Spack 提供对 Environment Modules 和 Lmod 的支持,可以设置在构建 Spec 后自动生成 modulefile,这样就可以通过 module 命令加载 Spack 安装的软件包。

    spack module lmod refresh
    module load gcc@11.2.0
    
  • Environment:与 Conda 环境类似,就是一组可以构建的 Spec。与 modules 相比,它更加稳定、可复现,且可以作为一个整体 load。

    spack env activate -p myenv
    

添加已有的软件包

  • 配置编译器 spack compiler

    • list add=find info
    • spack config edit compilers 可以进一步指定编译选项、设置环境变量。
  • spack external find 自动扫描系统中已有的包 Automatically Find External Packages

  • spack config edit packages ,以 CUDA 为例:
packages:
  all:
    variants: +cuda cuda_arch=80
  cuda:
    externals:
    - spec: "cuda@12.3%gcc@12.2.0 arch=linux-debian12-x86_64"
      prefix: /usr/local/cuda-12.3
      extra_attributes:
        environment:
          prepend_path:
            LD_LIBRAY_PATH: /usr/local/cuda-12.3/lib64
  • Spack 建议如果系统中有这些包就写进去: openssl git 。这些包确实很多系统都有附带,直接使用可以节省一些编译时间。当然很多时候我们用 Spack 就是不想自己解决依赖,希望一行命令解决所有事情,全都让 Spack 自己装一套也行。

有些包必须使用发行版提供的版本

比如 OpenSSL,如果版本不一致,可能会导致 SSH 连接失败。这将直接导致 MPI 程序无法运行。

对于 OpenSSL 这种基础包,每个系统应当固定版本,不要让 Spack 自行编译,很可能发生版本不一致问题。

串联 Spack 实例

修改不同级别的配置

  • 部分 Spack 命令可以使用 --scope= 选项指定配置级别,如 --scope=site--scope=user默认为用户级别
  • 用户 spack 的配置文件位于 ~/.spack 目录下

用户 spack 安装完成后,可以将集群 spack 指定为上游 Spack 实例,从而复用集群 spack 已安装的软件包,节省安装时间。

spack config add upstreams:zjusct-spack:install_tree:/pxe/opt/spack/opt/spack

该配置文件默认没有创建,请在创建后写入以下内容:

~/.spack/upstreams.yaml
upstreams:
  zjusct-spack: 
    install_tree: /pxe/opt/spack/opt/spack

这样,运行 spack find 命令就可以看到集群上的 Spack 安装的软件包了。与此同时,你也可以更改 Spack 的软件包配置,这些更改将会放在你手工安装的 Spack 目录下。

概念:使具体化(concretize)

Spack 安装软件包需要经过 concretize 和 install 两个步骤。concretize 是指确定软件包的依赖关系,生成 spec 树,然后根据 spec 树安装软件包。

spack spec 执行的就是 concretize 操作。

更多信息建议阅读:CSCS Spack Course 2024

使用 spack list 可以查询在线仓库中的软件包,使用 spack info 可以查看软件包的详细信息。

概念:虚包(Virtual Packages)

比如 OpenMPI、IntelMPI、MPICH,它们是 MPI 的不同实现。因此它们都提供一个虚包 mpi,其他程序只会依赖于 mpi 这个包,而不会依赖于某个具体实现。 使用 spack info --all 可以查看提供的虚包,这里以 ATLAS 为例,可以看到:

Virtual Packages:
    atlas provides blas, lapack, lapack@3.6.1

也就是说, atlas 会自动取代 blas/lapack 等的位置,提供它们的服务。

其它常用命令

  • 比较 spec 差异:spack diff
  • 查找安装位置:spack location --install-dir <spec>
  • 移动到安装位置:spack cd -i <spec>

处理头文件和依赖

Spack 只会维护下面的环境变量:

PATH
MANPATH
ACLOCAL_PATH
PKG_CONFIG_PATH
CMAKE_PREFIX_PATH
DYLD_FALLBACK_LIBRARY_PATH on macOS

如果加载的包是编译器(如 nvhpcintel-oneapi-compilers 等),还会修改编译器变量和动态链接库路径:

CC CXX FC F77
LD_LIBRARY_PATH

其他情况下一般不会修改头文件和动态链接库搜索路径:

CPATH
C_INCLUDE_PATH
CPLUS_INCLUDE_PATH
LD_LIBRARY_PATH

在相关文档和 Pull Request 中可以了解原因:

Spack 社区认为环境变量不够透明,作为一种管理选项的方式也十分危险(造成过某些编译器 bug),更加鼓励用户显式使用编译器选项如 -I$(spack location -i <spec>)/include

现代构建工具(如 CMake、pkg-config)已经能够很好地处理头文件搜索路径,移除后用户仍可以通过配置文件手动添加这些路径。

Spack 将维护环境变量的自主选择交给用户和系统管理员,可以通过 modules.yaml 指定修改环境变量。

如果我们需要包含或引用 Spack 管理的包,有以下几种方式:

  • 使用 spack location -i <spec>

    spack cd -i <spec> 进入安装目录,使用 fdfind | fzf 等工具搜索头文件的相对路径,然后添加到编译选项中。例如:

    C_INCLUDE_PATH=$(spack location -i <spec>)/include make
    
  • 使用 pkg-config

    pkg-config 是一个管理库文件和头文件路径的工具。它会搜索 PKG_CONFIG_PATH 中的 .pc 文件,按指定要求返回编译选项。

    Spack 部分包加载时会修改 PKG_CONFIG_PATH,可以使用 pkg-config 来获取头文件和库文件的路径。例如:

    c++ example.cpp $(pkg-config --cflags --libs gtk+-3.0 webkit2gtk-4.0) -o example
    

    pkg-config 支持 --static--shared 等选项,可以指定链接静态库或动态库。

  • 使用 CMake:

    Spack 部分包加载时会修改 CMAKE_PREFIX_PATH,可以使用 find_package 来查找头文件和库文件。例如:

    find_package(OpenMP)
    

自行添加编译、链接选项

这些问题常常是由于编写安装脚本的人没有考虑完善导致的,没有指定链接某些库,导致编译过程中断。如果对 ld 等链接工具熟悉,就能够自行添加相应的选项完成编译。下面记录几个例子:

spack install hwloc@2.9.1%oneapi ^intel-oneapi-mpi%oneapi

使用 intel-oneapi-mpi 依赖安装 hwloc ,提示缺少 MPI 相关符号,很显然是没链接 MPI 库。

检查 786 行的编译命令,并没有指定链接 MPI 库,因此应当添加 -lmpi 选项。更改为:

spack install hwloc@2.9.1%oneapi ldflags="-lmpi" ^intel-oneapi-mpi%oneapi

解决链接错误

发生链接错误表明没有指定链接某些库,这可能是因为:

  • 没有指定链接到某个库包含该符号的库:

    报错一般为未定义符号。

  • 无法找到指定的链接库:

    /usr/bin/ld: cannot find -lzlib
    

打包与维护