📚 课程目录第1章搭建LLVM/Clang开发环境

1. 搭建LLVM/Clang开发环境

任务目标

从源码构建 LLVM/Clang（版本 17.x），完成开发环境配置，并验证 clang 编译器与 llvm-config、opt 等核心工具可用。本案例面向后续 LLVM Pass 开发与 Clang 插件调试，因此采用 Release 构建类型并启用 LLVM_ENABLE_ASSERTIONS，兼顾运行效率与断言检查。

环境与依赖

操作系统：Ubuntu 22.04 x86_64（其他 Linux 发行版需调整包管理器命令）
内存/磁盘：建议 ≥ 16GB 内存，≥ 60GB 可用磁盘空间
基础依赖：build-essential、cmake（≥3.20）、ninja-build、python3、git

sudo apt update
sudo apt install -y build-essential cmake ninja-build python3 git

源码获取与构建

使用 Git 拉取 LLVM 官方仓库并切换到 release/17.x 分支。构建目录与源码目录分离，避免污染源码树。

git clone --depth 1 -b release/17.x https://github.com/llvm/llvm-project.git
cd llvm-project
mkdir build && cd build

执行 CMake 配置。此处仅构建 LLVM 核心与 Clang，不包含其他子项目以缩短构建时间。启用 LLVM_ENABLE_PROJECTS=clang 使 Clang 随 LLVM 一起编译，LLVM_TARGETS_TO_BUILD=X86 仅生成 X86 后端（若需其他架构可自行添加）。

cmake -G Ninja ../llvm \
  -DCMAKE_BUILD_TYPE=Release \
  -DLLVM_ENABLE_PROJECTS=clang \
  -DLLVM_TARGETS_TO_BUILD=X86 \
  -DLLVM_ENABLE_ASSERTIONS=ON \
  -DCMAKE_INSTALL_PREFIX=$HOME/llvm-install

开始编译并安装。使用 ninja 并行构建，-j$(nproc) 自动使用全部 CPU 核心。首次构建约需 30–60 分钟，取决于机器性能。

ninja -j$(nproc)
ninja install

环境变量配置

将安装路径加入 PATH 与 LD_LIBRARY_PATH，便于后续直接调用工具。将以下内容追加到 ~/.bashrc：

export LLVM_HOME=$HOME/llvm-install
export PATH=$LLVM_HOME/bin:$PATH
export LD_LIBRARY_PATH=$LLVM_HOME/lib:$LD_LIBRARY_PATH

执行 source ~/.bashrc 使配置立即生效。

验证方法与通过条件

依次执行以下命令，全部满足即视为环境搭建成功：

clang --version
llvm-config --version
llvm-config --libs core support
opt --version

预期输出：

clang --version 显示 clang version 17.0.x，且包含 Target: x86_64-unknown-linux-gnu 字样；
llvm-config --version 输出 17.0.x（与 clang 版本号一致）；
llvm-config --libs core support 输出形如 -lLLVMCore -lLLVMSupport ... 的链接选项列表；
opt --version 显示 LLVM 版本信息且无报错。

最后编写一个最小 C 程序验证编译链路完整性：

// hello.c
#include <stdio.h>
int main() { printf("LLVM OK\n"); return 0; }

clang hello.c -o hello && ./hello

若终端输出 LLVM OK，说明 Clang 能正常编译链接可执行文件，整个工具链可用。

常见问题

CMake 版本过低：报错提示需要更高版本时，使用 pip3 install --user cmake 或从官网安装新版 CMake。
磁盘空间不足：构建目录约需 40–50GB，安装目录约 5–8GB。可在 CMake 配置前用 df -h 检查剩余空间。
内存不足导致编译中断：降低并行度，如 ninja -j4；或改用 CMAKE_BUILD_TYPE=Debug 减少优化内存占用（但运行速度较慢）。
找不到 libtinfo.so.5：Ubuntu 22.04 需执行 sudo apt install libtinfo5 解决链接依赖。