LLVM Pass快速入门(二)：运行第一个pass

认识Pass层级结构

Pass范围从上到下一共分为5个层级：

• 模块层级：单个.ll或.bc文件
  
• 调用图层级：函数调用的关系。
  
• 函数层级：单个函数。
  
• 基本块层级：单个代码块。例如C语言中{}括起来的最小代码。
  
• 指令层级：单个IR指令。
  

注意：下面代码最好不要用中文，使用起来非常麻烦，控制台，编译，目标文件的编码不同会造成乱码。
项目目录如下

1. /MyProject
2. ├── CMakeLists.txt # CMake 配置文件
3. ├── build/ #构建目录
4. │   └── test.c #测试编译代码
5. └── mypass1.cpp # pass 项目代码

复制代码

一，测试代码示例

test.c

1. #include <stdio.h>
3. void secret_function() {
4.     printf("I am secret\n");
5. }
7. int main() {
8.     secret_function();
9.     return 0;
10. }

复制代码

二，Pass编写

项目描述：通过解析下面代码的IR，将下面代码中的函数名打印出来。
mypass1.cpp

1. #include "llvm/IR/PassManager.h"
2. #include "llvm/Passes/PassBuilder.h"
3. #include "llvm/Passes/PassPlugin.h"
4. #include "llvm/Support/raw_ostream.h"
6. using namespace llvm;
8. // 这个结构体基本是固定模板
9. namespace {
10.     struct mypass1 : public PassInfoMixin<mypass1> {
11.             //函数回调，每次遇到函数时调用（这里有重载，存在多种入口方式，可以以模块为入口）
12.         PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
13.                 //这里是主要的逻辑代码，我们主要学习的代码在这
14.                 
15.                 //打印出当前函数的名字
16.             errs() << "Found Function: " << F.getName() << "\n";
17.             
18.             //只读时返回：PreservedAnalyses::all()
19.             //存在修改时：PreservedAnalyses::none()
20.             return PreservedAnalyses::all();
21.         }
22.     };
24. }
26. //下面基本上是固定的模板，每个pass没什么变化，可以直接复制粘贴，或者背熟。
27. //直接使用需要修改的是下面的<模块名称，版本号，调用参数，和调用的pass结构体>
28. extern "C" LLVM_ATTRIBUTE_WEAK::llvm::PassPluginLibraryInfo
29. llvmGetPassPluginInfo() {
30.     return {
31.         LLVM_PLUGIN_API_VERSION,//版本信息
32.         "mypass1",//模块信息，自定义
33.         "v0.1",//版本号，自定义
34.         [](PassBuilder &PB) {
35.             PB.registerPipelineParsingCallback(
36.                 [](StringRef Name, FunctionPassManager &FPM,
37.                    ArrayRef<PassBuilder::PipelineElement>) {
38.                     if (Name == "mypass1") {//调用参数
39.                         FPM.addPass(mypass1());//上面pass结构体
40.                         return true;
41.                     }
42.                     return false;
43.                 }
44.             );
45.         }
46.     };
47. }

复制代码

2.编译并构建Pass

打开visual studio的工作台，我这里是x64 Native Tools Command Prompt for VS 2022`
进到build目录

1. #cmake 版本，可通过 cmake --version 判断
2. cmake_minimum_required(VERSION 4.1.1) #---->修改 cmake版本号
3. #项目名字
4. project(mypass1) #---->修改 项目名称
6. #导入项目的 LLVM cmake 配置文件路径(如果根据我之前文章安装这里就相同)
7. set(LLVM_DIR "D:/LLVM/llvm-project/build/lib/cmake/llvm")#---->修改 llvm cmake配置路径
8. #寻找 LLVM 的包文件
9. #REQUIRED 找不到 LLVM 则停止构建
10. #强制使用 LLVM 安装时生成的配置文件进行定位
11. find_package(LLVM REQUIRED CONFIG)
12. #将 LLVM 的 CMake 模块路径添加到当前 CMake 搜索路径中，以便后续使用 include(AddLLVM)。
13. list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
15. #引入 LLVM 提供的专用 CMake 宏
16. include(AddLLVM)
17. #将 LLVM 的头文件目录（如 llvm/IR/Function.h）加入编译器的搜索路径
18. include_directories(${LLVM_INCLUDE_DIRS})
19. #导入 LLVM 编译时使用的宏定义
20. add_definitions(${LLVM_DEFINITIONS})
21. #设置 C++ 标准为 C++17。(这里如果不用17编译会报错)
22. set(CMAKE_CXX_STANDARD 17)
23. #强制要求必须支持 C++17，如果编译器不支持则失败。
24. set(CMAKE_CXX_STANDARD_REQUIRED ON)
26. #创建一个模块化的库(.dll)
27. add_library(mypass8 MODULE mypass8.cpp) #---->修改 项目名称，文件名
28. #windows不用会报错：导出符号
29. #LLVM Pass 需要暴露一些特定的入口点（如 getAnalysisUsage）给 opt 工具调用。
30. set_target_properties(mypass8 PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON) #---->修改 项目名称
31. # 指定该 Pass 需要链接的 LLVM 核心组件。
32. # LLVMCore: 提供 IR、Function、Module 等核心类。
33. # LLVMSupport: 提供各种辅助工具类（如 errs() 输出）。
34. target_link_libraries(mypass8 LLVMCore LLVMSupport) #---->修改 项目名称，文件名  
35. # 为该目标设置特定的编译器选项。
36. # /utf-8: 告诉 MSVC 编译器使用 UTF-8 编码处理源代码，防止中文注释引起的乱码或编译错误。  
37. target_compile_options(mypass8 PRIVATE /utf-8)#---->修改 项目名称，文件名

复制代码

最后出现下面提示，即为编译成功

1. #构建项目
2. #其中-DCMAKE_BUILD_TYPE=RelWithDebInfo不选会报错，由于我之前编译的是带符号的relase版本
3. cmake -G "Ninja"  -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
4. #编译
5. ninja

复制代码

四，使用你第一个Pass

进到build目录

1. [2/2] Linking CXX shared module mypass1.dll

复制代码

输出结果

1. #把.c文件编译为.ll
2. #-O1 使用O1优化（这里我尝试-O0不优化，会导致我的pass无法应用）
3. #-Xclang -disable-llvm-passes 不使用默认的pass优化
4. clang -S -emit-llvm -O1 -Xclang -disable-llvm-passes test.c -S -o test.ll
6. #使用pass
7. opt -load-pass-plugin=mypass1.dll -passes=mypass1  test.ll -S -o test_opt.ll

复制代码

如果❤喜欢❤本系列教程，就点个关注吧，后续不定期更新~

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！