llvm学习（二十）：动态注册Pass的加载过程（上）

Posted on Edited on In

本文主要讲 clang 使用 Legacy Pass Manager 动态加载Pass的原理。

背景

不知道什么时候，不知道在哪看到，说llvm的 PassManager 更新了。

2021年有读者反馈llvm14加载pass失败，我当时没空处理，而且认为是读者自身问题。

2022年5月7日，immortal学弟使用 llvm13 prebuilt library 加载pass，不报错也没输出。刚巧我一直没验证过 prebuilt的可用性，本地复现后，发现llvm12 prebuilt是完全没问题的，llvm13就不行，才发现可能是版本更替引起的。

于是，找到了高版本 llvm 对 Pass Manager 的变更，https://releases.llvm.org/13.0.0/docs/ReleaseNotes.html#changes-to-the-llvm-ir ， https://releases.llvm.org/14.0.0/docs/ReleaseNotes.html#changes-to-the-llvm-ir ，确认了该问题。

对于 llvm 13 和 14，临时解决方案是使用 -flegacy-pass-manager，让之前写的 pass 继续生效。

最终，只剩一个问题，如何正确使用新版的 PassManager。在这之前，我需要先对 legacy pass manager 做一个总结。

近期 Pass Manager 的变更

版本 默认行为 可选参数
llvm5~llvm12 使用 LegacyPassManager -fno-experimental-new-pass-manager 启用 NewPassManager
llvm13~llvm14 使用 NewPassManager -flegacy-pass-manager 启用 LegacyPassManager
llvm15（开发中） 使用 NewPassManager 可能移除 LegacyPassManager

旧版新版并存已经5年了，很多开发者在 opt 里进行 transform，新版的API长期也没人适配clang。

llvm13 是 2021年10月发布的，过去半年了，居然没人来更新相关的方案，属实不应该。

LegacyPassManager 动态加载过程

本文带大家从源码的角度，分析从命令行输入，到pass动态注册的整个过程，以之前常用做测试的 clang -Xclang -load -Xclang libSkeletonPass.so test.c 为例。

环境准备，见第十九篇 （ https://leadroyal.cn/p/2206/ ），肉眼读源码很费劲，结合调试，可以更快找到核心代码位置，更加理解整个逻辑

clang 和 clang -cc1

clang并不仅仅是c语言前端，它是一个编译器合集，包括了编译、优化、链接的各个过程，可以使用 -v 参数简单观察一下编译全程的细节。它会调用clang -cc1，clang -cc1 是真正编译器。

clang -Xclang -load -Xclang libSkeletonPass.so test.c 的 -Xclang 就是将参数传递给 clang -cc1，最终调用命令是：clang -cc1 -load libSkeletonPass.so test.c，而load功能是 clang -cc1 提供的。

二者的help内容也是完全不一样的，使用 -Xclang 进行参数传递。

1
2
3
4
5
6
7
clang --help
...
  -Xclang <arg>           Pass <arg> to the clang compiler

clang -cc1 --help
...
  -load <dsopath>         Load the named plugin (dynamic shared object)

clang的可执行文件位于：clang/tools/driver/driver.cpp，代码如下：

1
2
3
4
5
6
7
8
9
10
11
12
int main(int argc_, const char **argv_) {
  //**********
    if (FirstArg != argv.end() && StringRef(*FirstArg).startswith("-cc1")) {
    // If -cc1 came from a response file, remove the EOL sentinels.
    if (MarkEOLs) {
      auto newEnd = std::remove(argv.begin(), argv.end(), nullptr);
      argv.resize(newEnd - argv.begin());
    }
    return ExecuteCC1Tool(argv);
  }
  //**********
}

当第一个参数是 -cc1 时，走一套逻辑，否则，走另一套逻辑。

此时，问题转化为：clang -cc1 -load libSkeletonPass.so test.c 的 load 功能在哪实现。

load功能在哪实现

这里盲猜，肯定是用到命令行参数解析技术、动态加载技术，与PassManager有关，朝着相关方向思考。

根据 help 内容搜索关键字，在 clang/include/clang/Driver/Options.td 中找到，它是个描述文件，生成头文件的名字已超出我的认知范围，这条路行不通，但生成的头文件一定是某种格式的。

1
2
def load : Separate<["-"], "load">, MetaVarName<"<dsopath>">,
  HelpText<"Load the named plugin (dynamic shared object)">;

根据编写 Pass 的API，找到 RegisterStandardPasses 的实现，位于llvm/include/llvm/Transforms/IPO/PassManagerBuilder.h。

1
2
3
static RegisterStandardPasses RegisterMyPass(
  PassManagerBuilder::EP_EarlyAsPossible,registerSkeletonPass
);
1
2
3
4
5
6
7
8
class RegisterStandardPasses {
  PassManagerBuilder::GlobalExtensionID ExtensionID;

public:
  RegisterStandardPasses(PassManagerBuilder::ExtensionPointTy Ty,
                         PassManagerBuilder::ExtensionFn Fn) {
    ExtensionID = PassManagerBuilder::addGlobalExtension(Ty, std::move(Fn));
  }

调用了 PassManagerBuilder::addGlobalExtension(Ty, std::move(Fn))，传参为生效时刻、注册回调函数，并返回插件ID。

实现在 llvm/lib/Transforms/IPO/PassManagerBuilder.cpp 中。

将生效时刻、注册回调函数放到 GlobalExtensions 里，之后我们下断点，观察栈回溯，发现很多收获。

1
2
3
4
5
6
7
8
9
llvm::PassManagerBuilder::addGlobalExtension(llvm::PassManagerBuilder::ExtensionPointTy, std::function<…>) PassManagerBuilder.cpp:225
xxxxxxx
[Inlined] llvm::sys::DynamicLibrary::HandleSet::DLOpen DynamicLibrary.inc:28
llvm::sys::DynamicLibrary::getPermanentLibrary DynamicLibrary.cpp:154
[Inlined] llvm::sys::DynamicLibrary::LoadLibraryPermanently DynamicLibrary.h:87
clang::ExecuteCompilerInvocation ExecuteCompilerInvocation.cpp:209
cc1_main cc1_main.cpp:240
ExecuteCC1Tool driver.cpp:330
xxxxx

可以得知，Clang->getFrontendOpts().Plugins中存放动态加载library。

得到阶段性结论：虽然我们不知道 -load 的实现在哪里，但它的作用是将传参结果放到了 Plugins 里，加载 library 已结束，但 pass 并没有加载或执行。此时，问题转化为了：GlobalExtensions 存放的注册时机和回调函数，是何时被 LegacyPassManager 加载的。

GlobalExtensions何时被LegacyPassManager读取

搜索 GlobalExtensions 的引用，很容易找到一处 llvm/lib/Transforms/IPO/PassManagerBuilder.cpp：

1
2
3
4
5
6
7
void PassManagerBuilder::addExtensionsToPM(ExtensionPointTy ETy,
                                           legacy::PassManagerBase &PM) const {
  //*********
  for (unsigned i = 0, e = Extensions.size(); i != e; ++i)
    if (Extensions[i].first == ETy)
      Extensions[i].second(*this, PM);
}

显然这里将 PassManager 传递到了回调函数中，API也是我们非常熟悉的，在恰当的时机，将PassManager 传递给用户自定义的处理函数，用户可以使用 PassManager 的 API将 pass 添加进去。

同样，调试，观察代码和栈回溯：

我随手使用的是llvm11版，默认不使用 NewPassManager，走 else 分支，也就是 LegacyPassManager。甚至还找到了 NewPassManager 的处理逻辑。

1
2
3
4
void PassManagerBuilder::populateFunctionPassManager(
    legacy::FunctionPassManager &FPM) {
  addExtensionsToPM(EP_EarlyAsPossible, FPM);
  FPM.add(createEntryExitInstrumenterPass());

我这个案例走的是 EmitAssembly -> CreatePass -> populateFunctionPassManager，触发的是 EP_EarlyAsPossible ，这个注册时机有多个，搜索 addExtensionsToPM 可以找到其他的 pass 被注册的时机，不是本文的重点。

此时，所有问题都解决了。

llvm13以上的版本呢？

不出所料只是简单修改了判定条件，clang/lib/CodeGen/BackendUtil.cpp文件同样的位置：

1
2
3
4
if (!CGOpts.LegacyPassManager)
  AsmHelper.EmitAssemblyWithNewPassManager(Action, std::move(OS));
else
  AsmHelper.EmitAssembly(Action, std::move(OS));

LegacyPassManager 的总结

  1. clang 命令行传参，传给 clang -cc1
  2. clang -cc1 解析 -load libSkeletonPass.so ，注册时机和回调函数被存储到 GlobalExtensions
  3. 初步编译后，触发优化部分
  4. EmitAssembly -> CreatePass -> populateFunctionPassManager 调用链，最终调用到 addExtensionsToPM，访问 GlobalExtensions，如果当前时机和注册时机相同，就调用回调函数
  5. 回调函数的入参为 legacy::PassManagerBase &PM，调用 addPass 即可将自定义的 Pass 加入到优化流程中。

预告

上文提到了，我偶然发现了 CGOpts.ExperimentalNewPassManager 这个配置项，显然就是 llvm13以上使用的 NewPassManager 了，整好省下了重新编译的时间。因此，下一篇将介绍，如何在 llvm11 上，使用 NewPassManager 动态加载用户的 Pass 的原理。