概述

Tiramisu 是一款用于表达快速且可移植的数据并行计算的编译器。它提供了一个简单的 C++ API，用于描述算法（称为“Tiramisu 表达式”）以及如何通过编译器对这些算法进行优化。Tiramisu 可广泛应用于线性代数与张量代数、深度学习、图像处理、模板计算和机器学习等领域。

Tiramisu 编译器基于多面体模型，因此能够表达大量的循环优化和数据布局变换。目前，它支持的目标平台包括：(1) 多核 x86 CPU；(2) NVIDIA GPU；(3) Xilinx FPGA（使用 Vivado HLS）；以及 (4) 分布式机器（使用 MPI）。该编译器的设计旨在方便集成针对新架构的代码生成器。

示例

以下是使用 C++ API 指定的一个 Tiramisu 程序示例：

// 使用 Tiramisu 表达式的 C++ 代码。
#include "tiramisu/tiramisu.h"
using namespace tiramisu;

void generate_code()
{
    // 指定要创建的函数名称。
    tiramisu::init("foo");

    // 声明两个循环变量 i 和 j，满足 0<=i<100 且 0<=j<100。
    var i("i", 0, 100), j("j", 0, 100);

    // 声明一个 Tiramisu 表达式（算法），等价于以下 C 代码：
    // for (i=0; i<100; i++)
    //   for (j=0; j<100; j++)
    //     C(i,j) = 0;
    computation C({i,j}, 0);
    
    // 指定优化策略
    C.parallelize(i);
    C.vectorize(j, 4);
    
    buffer b_C("b_C", {100, 100}, p_int32, a_output);
    C.store_in(&b_C);

    // 生成代码
    C.codegen({&b_C}, "generated_code.o");
}

从源码构建 Tiramisu

本节将介绍如何从源码构建 Tiramisu。以下安装说明已在 Linux Ubuntu (18.04) 和 macOS (13.0.1) 上测试通过，但也应适用于其他版本的 Linux 和 macOS。

先决条件

必需

1. CMake：版本 3.22 或更高。

2. Autoconf 和 libtool。

3. Ninja。

可选

1. OpenMPI 和 OpenSSH：如果您希望生成并运行分布式代码（MPI）。

2. CUDA 工具包：如果您希望生成并运行 CUDA 代码。

3. Python 3.8 或更高版本：如果您希望使用 Python 绑定。（同时需要 Pybind 2.10.2、Cython 和 NumPy）。

构建方法

构建 Tiramisu 有三种方式：

1. 通过 spack 安装，它会为你从源码编译所有依赖。
2. 从源码编译，但使用系统包管理器来安装依赖。
3. 完全从源码编译，并使用我们的安装脚本。

后两种方法的区别仅在于如何设置依赖项。

方法 1：通过 spack 构建

先安装 spack，然后运行：

spack install tiramisu

方法 2：从源码编译，但使用系统包管理器安装依赖

此方法分为两个步骤：

1. 使用 Homebrew 或 Apt 安装依赖。
2. 使用 CMake 构建 Tiramisu。

安装依赖

使用 Homebrew 安装依赖

如果你在 macOS 上并使用 Homebrew，可以运行以下命令来设置依赖：

brew install cmake
brew install llvm@14
brew install halide
brew install isl
brew link halide
brew link isl

如果这些命令提示你更新 PATH，请按照提示操作。例如，你可以通过以下命令找到 isl 的头文件和库目录：

brew info isl
ISL_INCLUDE_DIRECTORY=..
ISL_LIB_DIRECTORY=..

使用 Apt 安装依赖

如果你在 Ubuntu/Debian 上，可以使用 apt 来安装依赖：

wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 14 all
sudo apt-get install liblld-14-dev llvm-14-runtime
sudo apt-get install libllvm14 llvm-14-dev
sudo apt-get install llvm14-*
sudo apt-get install halide
sudo apt-get install libisl-dev

使用以下命令可以找到 isl 的头文件和库目录：

dpkg -L libisl-dev
ISL_INCLUDE_DIRECTORY=..
ISL_LIB_DIRECTORY=..

使用 CMake 构建 Tiramisu

1. 获取 Tiramisu 源码：

git clone https://github.com/Tiramisu-Compiler/tiramisu.git
cd tiramisu
mkdir build

2. 配置 configure.cmake 文件。特别需要选择是否使用 GPU 或 MPI 设置，是否启用 Python 绑定，以及是否启用自动调度器。你可能还需要添加其他选项来支持这些功能。

3. 进行配置：

cmake . -B build -DISL_LIB_DIRECTORY=$ISL_LIB_DIRECTORY -DISL_INCLUDE_DIRECTORY=$ISL_INCLUDE_DIRECTORY -DPython3_EXECUTABLE=`which python3`

如果你想进行安装，可以添加 CMAKE_INSTALL_PREFIX。如果要安装 Python 绑定，还需添加 Tiramisu_INSTALL_PYTHONDIR，以指定 Python 包的安装路径。你需要将这些安装路径添加到相关的环境变量中，如 PYTHONPATH 和 LD_LIBRARY_PATH。

4. 编译：

cmake --build build

如果需要安装，可以使用 cmake --install 命令。

方法 3：从源码编译，但使用我们的脚本安装依赖

此方法同样分为两个步骤：

1. 使用我们的脚本安装依赖。
2. 使用 CMake 构建 Tiramisu。

通过脚本安装依赖

1. 获取 Tiramisu 源码：

git clone https://github.com/Tiramisu-Compiler/tiramisu.git
cd tiramisu

2. 获取并安装 Tiramisu 的子模块（ISL、LLVM 和 Halide）。这一步可能需要几分钟到几小时不等，因为下载和编译 LLVM 需要较长时间。

./utils/scripts/install_submodules.sh <TIRAMISU_ROOT_DIR>

- 注意：请确保 `<TIRAMISU_ROOT_DIR>` 是绝对路径！

3. 可选：编辑 configure.cmake 文件来配置 Tiramisu 的构建。只有当你需要生成 MPI 或 GPU 代码、运行 BLAS 基准测试，或者想要构建自动调度器模块时，才需要进行此步骤。configure.cmake 文件中的注释详细说明了每个变量的作用及如何设置。

   • 若要使用 GPU 后端，需将 USE_GPU 设置为 TRUE。如果在编译 Tiramisu 时未能自动找到 CUDA 库，系统会提示你提供 CUDA 库的路径。
   • 若要使用分布式后端，需将 USE_MPI 设置为 TRUE。如果未自动找到 MPI 库，则需要设置 MPI_INCLUDE_DIR、MPI_LIB_DIR 和 MPI_LIB_FLAGS 等变量。
   • 若要构建自动调度器模块，需将 USE_AUTO_SCHEDULER 设置为 TRUE。

4. 将 Halide 的 CMake 路径添加到 CMAKE_PREFIX_PATH：

export CMAKE_PREFIX_PATH=<TIRAMISU_ROOT_DIR>/3rdParty/Halide/build/:$CMAKE_PREFIX_PATH

5. 构建主 Tiramisu 库：

mkdir build
cd build
cmake ..
cmake --build .

6. 如果你想构建自动调度器模块，在 configure.cmake 中将 USE_AUTO_SCHEDULER 设置为 TRUE，并在完成 Tiramisu 构建后执行：

make tiramisu_auto_scheduler

在虚拟机上使用旧版 Tiramisu

用户可以使用 Tiramisu 的 虚拟机磁盘镜像。该镜像是使用 VirtualBox (5.2.12) 创建的，其中已预编译好 Tiramisu，可以直接使用。编译时使用的指令与本 README 文件中的说明一致。

下载镜像后，解压并使用 VirtualBox 打开 TiramisuVM.vbox 文件。

虚拟机启动后，打开终端并进入 Tiramisu 目录：

cd /home/b/tiramisu/

如果提示输入用户名/密码：

用户名：b
密码：b

开始使用

• 构建 Tiramisu。
• 阅读 教程。
• 阅读 Tiramisu 论文。
• 订阅 Tiramisu 邮件列表。
• 阅读编译器的 内部文档（如果你打算为编译器贡献代码）。

运行测试

假设你在 build/ 目录下，运行所有测试：

make test

或

ctest

若只想运行单个测试（例如 test_01），可以执行：

ctest -R 01

这将编译并运行代码生成器和包装器。

要查看测试的详细输出，可以在 ctest 命令中添加 --verbose 选项。

Tiramisu 快速上手指南

Tiramisu 是一个用于表达快速且可移植的数据并行计算的编译器。它提供简单的 C++ API 来描述算法及其优化策略，支持多核 CPU、Nvidia GPU、Xilinx FPGA 以及分布式集群（MPI）。

环境准备

系统要求

• 操作系统：Linux (推荐 Ubuntu 18.04+) 或 macOS (13.0.1+)
• 构建工具：CMake (≥3.22), Autoconf, libtool, Ninja

前置依赖

根据需求选择安装以下依赖：

必需依赖：

• CMake, Autoconf, libtool, Ninja
• LLVM 14, Halide, ISL (Integer Set Library)

可选依赖（按需安装）：

• GPU 支持：CUDA Toolkit
• 分布式支持：OpenMPI, OpenSSH
• Python 绑定：Python 3.8+, Pybind11 (2.10.2), Cython, Numpy

提示：国内用户可通过清华源或中科大源加速 apt 或 brew 依赖包的下载。

安装步骤

推荐使用 方法二（使用系统包管理器安装依赖），适合大多数开发者。若需完全隔离环境或特定版本控制，可选择方法三。

方法一：使用 Spack（最简单，全自动）

如果你已安装 Spack，可直接一键安装：

spack install tiramisu

方法二：源码编译（使用系统包管理器安装依赖）

1. 安装依赖

macOS (Homebrew):

brew install cmake llvm@14 halide isl
brew link halide
brew link isl
# 记录 ISL 路径（后续配置需要）
brew info isl

Ubuntu/Debian (Apt):

# 安装 LLVM 14
wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 14 all
sudo apt-get install liblld-14-dev llvm-14-runtime libllvm14 llvm-14-dev llvm14-*

# 安装其他依赖
sudo apt-get install halide libisl-dev cmake ninja-build
# 记录 ISL 路径（后续配置需要）
dpkg -L libisl-dev

执行上述命令后，请记下 ISL_INCLUDE_DIRECTORY 和 ISL_LIB_DIRECTORY 的具体路径。

2. 克隆与配置

git clone https://github.com/Tiramisu-Compiler/tiramisu.git
cd tiramisu
mkdir build

配置 CMake（替换 <ISL_LIB_DIR> 和 <ISL_INC_DIR> 为上一步获取的实际路径）：

cmake . -B build \
  -DISL_LIB_DIRECTORY=<ISL_LIB_DIR> \
  -DISL_INCLUDE_DIRECTORY=<ISL_INC_DIR> \
  -DPython3_EXECUTABLE=$(which python3) \
  -DCMAKE_INSTALL_PREFIX=/usr/local

如需启用 GPU 或 MPI，需在 configure.cmake 中设置 USE_GPU=TRUE 或 USE_MPI=TRUE 并指定相应路径。

3. 编译与安装

cmake --build build
sudo cmake --install build

若使用 Python 绑定，请将安装路径添加到 PYTHONPATH 和 LD_LIBRARY_PATH。

方法三：源码编译（使用脚本自动安装依赖）

此方法会下载并编译 LLVM、Halide 等子模块，耗时较长，但环境更独立。

git clone https://github.com/Tiramisu-Compiler/tiramisu.git
cd tiramisu

# 安装子模块 (替换 <绝对路径> 为当前目录的绝对路径)
./utils/scripts/install_submodules.sh <绝对路径>

# 配置 Halide 路径
export CMAKE_PREFIX_PATH=<绝对路径>/3rdParty/Halide/build/:$CMAKE_PREFIX_PATH

# 编译
mkdir build && cd build
cmake ..
cmake --build .

基本使用

以下是一个最简单的 Tiramisu 程序示例，定义了一个双重循环并将结果并行化和向量化。

示例代码 (example.cpp)

// C++ code with a Tiramisu expression.
#include "tiramisu/tiramisu.h"
using namespace tiramisu;

void generate_code()
{
    // 1. 初始化函数名称
    tiramisu::init("foo");

    // 2. 声明迭代变量 (0<=i<100, 0<=j<100)
    var i("i", 0, 100), j("j", 0, 100);

    // 3. 定义计算逻辑: C(i,j) = 0
    computation C({i,j}, 0);
    
    // 4. 指定优化策略
    C.parallelize(i);       // 在外层循环 i 上并行化
    C.vectorize(j, 4);      // 在内层循环 j 上进行宽度为 4 的向量化
    
    // 5. 定义输出缓冲區
    buffer b_C("b_C", {100, 100}, p_int32, a_output);
    C.store_in(&b_C);

    // 6. 生成目标代码
    C.codegen({&b_C}, "generated_code.o");
}

编译与运行

将上述代码保存为 .cpp 文件，链接 Tiramisu 库进行编译：

g++ example.cpp -ltiramisu -lHalide -lisL -llvmCore -o example
./example

(具体链接参数需根据实际安装路径调整)

生成的 generated_code.o 即可集成到你的项目中调用。

验证安装

在构建目录下运行测试套件以验证安装是否成功：

cd build
ctest
# 运行单个测试
ctest -R 01 --verbose