LLVM系列第一章：编译LLVM源码
LLVM系列第二章：模块Module
LLVM系列第三章：函数Function
LLVM系列第四章：逻辑代码块Block
LLVM系列第五章：全局变量Global Variable
LLVM系列第六章：函数返回值Return
LLVM系列第七章：函数参数Function Arguments
LLVM系列第八章：算术运算语句Arithmetic Statement
LLVM系列第九章：控制流语句if-else
LLVM系列第十章：控制流语句if-else-phi
LLVM系列第十一章：写一个Hello World
LLVM系列第十二章：写一个简单的词法分析器Lexer
LLVM系列第十三章：写一个简单的语法分析器Parser
LLVM系列第十四章：写一个简单的语义分析器Semantic Analyzer
LLVM系列第十五章：写一个简单的中间代码生成器IR Generator
LLVM系列第十六章：写一个简单的编译器
LLVM系列第十七章：for循环
LLVM系列第十八章：写一个简单的IR处理流程Pass
在此记录下用LLVM创建一个简单的IR处理流程(Pass)的过程，以备查阅。
开发环境的配置请参考第一章 《LLVM系列第一章：编译LLVM源码》。
Pass是LLVM中很重要的部分。Pass大体上可以理解为一个“处理”，它处理的对象是IR代码。LLVM对代码的分析、转换和优化等处理工作都是由Pass来做的。LLVM以流水线的方式把各个Pass组合起来，让它们成为一个有序的流程。LLVM Pass可以处理的对象有模块(Module)、函数(Function)、循环(Loop)，甚至函数调用栈(Function Call Graph)等等。
本章我们就来写一个最简单的Pass。
我们把这个简单的项目命名为MyPass。可以参考LLVM的源码中其它Pass流程的组织结构，来组织我们自己的代码（示例）：
llvm-project/llvm
├── ...
├── lib
│ └── Transforms
│ ├── CMakeLists.txt
│ └── MyPass.cpp
│ ├── CMakeLists.txt
│ └── MyPass.cpp
└── ...
这个简单的项目只包含了一个模块：
MyPass将会对每一个函数进行处理，即把其函数名打印出来。
注意，我们需要把MyPass项目加入到LLVM Transforms父项目中，即指示CMake在编译LLVM源码的同时，也要编译MyPass项目。
以下是跟项目组织结构相关的部分CMake脚本。
(1) lib/Transforms/MyPass/CMakeLists.txt文件（示例）：
# CMakeLists.txt
add_llvm_library(MyPass MODULE BUILDTREE_ONLY
MyPass.cpp
PLUGIN_TOOL
opt
)
(2) lib/Transforms/CMakeLists.txt文件（示例）：
...
add_subdirectory(MyPass)
...
MyPass的实现在文件lib/Transforms/MyPass/MyPass.cpp中：
// MyPass.cpp
#include "llvm/IR/PassManager.h"
#include "llvm/Passes/PassBuilder.h"
#include "llvm/Passes/PassPlugin.h"
#include "llvm/Support/raw_ostream.h"
// Only needed for printing
#include <iostream>
using namespace llvm;
namespace
{
class MyPass : public PassInfoMixin<MyPass>
{
public:
// The first argument of the run() function defines on what level
// of granularity your pass will run (e.g. Module, Function).
// The second argument is the corresponding AnalysisManager
// (e.g ModuleAnalysisManager, FunctionAnalysisManager)
PreservedAnalyses run(Function& function, FunctionAnalysisManager& analysisManager)
{
std::cout << "MyPass in function: " << function.getName().str() << std::endl;
// Here goes what you want to do with a pass
// Assuming we did not change anything of the IR code
return PreservedAnalyses::all();
}
};
}
// This part is the new way of registering your pass
extern "C" PassPluginLibraryInfo LLVM_ATTRIBUTE_WEAK llvmGetPassPluginInfo()
{
return
{
LLVM_PLUGIN_API_VERSION,
"MyPass",
"v0.1",
[](PassBuilder &passBuilder) {
passBuilder.registerPipelineParsingCallback(
[](StringRef name, FunctionPassManager &passManager, ArrayRef<PassBuilder::PipelineElement>) {
if(name == "my-pass")
{
passManager.addPass(MyPass());
return true;
}
return false;
}
);
}
};
}
用CMake工具生成项目文件（示例）：
cd /path/to/llvm-project
mkdir build
cd build
cmake -G Ninja -DLLVM_ENABLE_PROJECTS=clang ../llvm
输出log如下（示例）：
-- clang project is enabled
-- clang-tools-extra project is disabled
-- compiler-rt project is disabled
-- debuginfo-tests project is disabled
-- libc project is disabled
-- libclc project is disabled
-- libcxx project is disabled
-- libcxxabi project is disabled
-- libunwind project is disabled
-- lld project is disabled
-- lldb project is disabled
-- mlir project is disabled
-- openmp project is disabled
-- parallel-libs project is disabled
-- polly project is disabled
-- pstl project is disabled
-- flang project is disabled
-- Found libtool - /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/libtool
-- Native target architecture is X86
-- Threads enabled.
-- Doxygen disabled.
-- Go bindings enabled.
-- Ninja version: 1.10.2
-- Found ld64 - /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/ld
-- Could NOT find OCaml (missing: OCAMLFIND OCAML_VERSION OCAML_STDLIB_PATH)
-- Could NOT find OCaml (missing: OCAMLFIND OCAML_VERSION OCAML_STDLIB_PATH)
-- OCaml bindings disabled.
-- LLVM host triple: x86_64-apple-darwin20.6.0
-- LLVM default target triple: x86_64-apple-darwin20.6.0
-- Building with -fPIC
-- Targeting AArch64
-- Targeting AMDGPU
-- Targeting ARM
-- Targeting AVR
-- Targeting BPF
-- Targeting Hexagon
-- Targeting Lanai
-- Targeting Mips
-- Targeting MSP430
-- Targeting NVPTX
-- Targeting PowerPC
-- Targeting RISCV
-- Targeting Sparc
-- Targeting SystemZ
-- Targeting WebAssembly
-- Targeting X86
-- Targeting XCore
-- Clang version: 12.0.1
-- Host linker version: 711
-- Registering Bye as a pass plugin (static build: OFF)
-- Failed to find LLVM FileCheck
-- Version: 0.0.0
-- Performing Test HAVE_THREAD_SAFETY_ATTRIBUTES -- failed to compile
-- Performing Test HAVE_GNU_POSIX_REGEX -- failed to compile
-- Performing Test HAVE_POSIX_REGEX -- success
-- Performing Test HAVE_STEADY_CLOCK -- success
-- Configuring done
-- Generating done
-- Build files have been written to: .../llvm-project/build
用ninja进行编译（示例）：
ninja
如果我们是在第一章的编译LLVM完成之后，再编译此项目，则仅仅需要编译MyPass项目即可。当然，这是ninja自动就能识别出来的，即所谓的增量编译技术。输出log如下（示例）：
[4/4] Linking CXX shared module lib/MyPass.dylib
为了简单起见，假设我们要对以下test.ll文件中的IR代码进行处理（示例）：
define i32 @Foo() {
%a = add i32 2, 3
ret i32 %a
}
define i32 @Bar() {
ret i32 0
}
运行My Pass（示例）：
./bin/opt -load-pass-plugin=lib/MyPass.dylib -passes="my-pass" -disable-output test.ll
输出结果如下（示例）：
MyPass in function: Foo
MyPass in function: Bar
我们用LLVM提供的C++ API，创建了一个简单的Pass，并且编译运行成功。完整源码示例请参看：
https://github.com/wuzhanglin/llvm-pass-examples