LLVM Pass快速入门(四)：代码插桩

代码插桩

项目需求：在函数运行时打印出运行的函数名
项目目录如下

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

复制代码

一，测试代码示例

test.c

1. #include <stdio.h>
3. void func_A() {
4.     int a = 1;
5. }
7. void func_B() {
8.     func_A();
9. }
11. int main() {
12.     printf("#把.c文件编译为.ll
13. #-O1 使用O1优化（这里我尝试-O0不优化，会导致我的pass无法应用）
14. #-Xclang -disable-llvm-passes 不使用默认的pass优化
15. clang -S -emit-llvm -O1 -Xclang -disable-llvm-passes test.c -S -o test.ll
17. #使用pass
18. opt -load-pass-plugin=mypass3.dll -passes=mypass3  test.ll -S -o test_opt.ll
20. #编译使用pass后的exe
21. clang test_opt.ll -o test_opt.exe
22. #编译使用pass前的exe
23. clang test.ll -o test.exe\n");
24.     func_A();
25.     func_B();
26.     return 0;
27. }

复制代码

二，编写Pass

其他的固定的模板之前文章注释有，这里我只注释当前项目重要的部分
代码流程： 遍历指令并匹配ADD指令->替换为sub指令

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"
5. #include "llvm/IR/Function.h"
6. #include "llvm/IR/BasicBlock.h"
7. #include "llvm/IR/Instruction.h"
8. #include "llvm/IR/Instructions.h"
9. #include "llvm/IR/IRBuilder.h"
11. using namespace llvm;
13. namespace {
15. struct mypass3 : public PassInfoMixin<mypass3> {
16.    
17.     PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
18.         //过滤函数
19.         //过滤掉printf和printf有关的函数，防止在printf中插入printf造成递归（死循环）
20.         if(F.isDeclaration() || F.getName().starts_with("_") || F.getName().contains("printf")){
21.             return PreservedAnalyses::all();
22.         }
23.         errs() << "handle func:" << F.getName() << "\n";
24.                
25.                 //获取模块
26.         Module *M = F.getParent();
27.         //获取模块上下文
28.         //上下文中包含了数据的类型
29.         LLVMContext &Ctx = M->getContext();
30.         
31.         //下面是创建函数，类比java反射，或者frida的hook
32.         //定义printf的参数类型，相当于函数括号中的内容，这里的PointerType是指针类型
33.         std::vector<Type*> printfArgs = {PointerType::getUnqual(Ctx)};
34.                 //定义函数类型，这里相当于定义：int (void*, ...)
35.         FunctionType *printfType = FunctionType::get(
36.             Type::getInt32Ty(Ctx),//函数返回值类型
37.             printfArgs,//函数的参数类型(vector)
38.             true//是否是可变参数
39.         );
40.                 //如果printf存在则引用，如果不存在，则创建一个新的printf
41.         FunctionCallee printfFunc = M->getOrInsertFunction("printf", printfType);
42.                
43.                 //下面是插入函数
44.                 //将修改的位置定位到要插桩函数的头部
45.         IRBuilder<> builder(&F.getEntryBlock().front());
46.         //声明全局变量（这里是要传给printf的格式化字符串）
47.         Value* formatStr = builder.CreateGlobalStringPtr(">> enter function %s <<\n", "my_format");
48.         //声明全局变量，这里定义了函数名称的字符串变量
49.         Value* funcName = builder.CreateGlobalStringPtr(F.getName(), "my_func_name");
50.         //将上面定义的实际参数传入
51.         std::vector<Value*> printfArgsVec = {formatStr, funcName};
52.         //创建函数调用
53.         builder.CreateCall(printfFunc, printfArgsVec);
54.         
55.         return PreservedAnalyses::none();
56.     }
57. };
59. }
61. extern "C" LLVM_ATTRIBUTE_WEAK ::llvm::PassPluginLibraryInfo
62. llvmGetPassPluginInfo() {
63.     return {
64.         LLVM_PLUGIN_API_VERSION,
65.         "mypass3",
66.         "v0.1",
67.         [](PassBuilder &PB) {
68.             PB.registerPipelineParsingCallback(
69.                 [](StringRef Name, FunctionPassManager &FPM,
70.                    ArrayRef<PassBuilder::PipelineElement>) {
71.                     if (Name == "mypass3") {
72.                         FPM.addPass(mypass3());
73.                         return true;
74.                     }
75.                     return false;
76.                 });
77.         }};
78. }

复制代码

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(mypass3) #---->修改 项目名称
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(mypass3 MODULE mypass3.cpp) #---->修改 项目名称，文件名
28. #windows不用会报错：导出符号
29. #LLVM Pass 需要暴露一些特定的入口点（如 getAnalysisUsage）给 opt 工具调用。
30. set_target_properties(mypass3 PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON) #---->修改 项目名称
31. # 指定该 Pass 需要链接的 LLVM 核心组件。
32. # LLVMCore: 提供 IR、Function、Module 等核心类。
33. # LLVMSupport: 提供各种辅助工具类（如 errs() 输出）。
34. target_link_libraries(mypass3 LLVMCore LLVMSupport) #---->修改 项目名称，文件名  
35. # 为该目标设置特定的编译器选项。
36. # /utf-8: 告诉 MSVC 编译器使用 UTF-8 编码处理源代码，防止中文注释引起的乱码或编译错误。  
37. target_compile_options(mypass3 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 mypass3.dll

复制代码

输出结果
运行test.exe：不使用pass，输出结果如下：

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=mypass3.dll -passes=mypass3  test.ll -S -o test_opt.ll
9. #编译使用pass后的exe
10. clang test_opt.ll -o test_opt.exe
11. #编译使用pass前的exe
12. clang test.ll -o test.exe

复制代码

运行test_opt.exe：使用pass后，输出结果如下：
[code]>> enter function main > enter function func_A > enter function func_B > enter function func_A

谢谢分享，试用一下

感谢分享，下载保存了，貌似很强大

很好很强大  我过来先占个楼 待编辑

热心回复！

懂技术并乐意极积无私分享的人越来越少。珍惜

这个有用。

热心回复！

感谢分享，下载保存了，貌似很强大

这个有用。

感谢分享，下载保存了，貌似很强大

不错，里面软件多更新就更好了

感谢发布原创作品，程序园因你更精彩

很好很强大  我过来先占个楼 待编辑

谢谢分享，试用一下

感谢分享，下载保存了，貌似很强大

喜欢鼓捣这些软件，现在用得少，谢谢分享！