認識Pass層級結構
Pass範圍從上到下一共分為5個層級：
- 模塊層級：單個
.ll或.bc文件 - 調用圖層級：函數調用的關係。
- 函數層級：單個函數。
- 基本塊層級：單個代碼塊。例如C語言中
{}括起來的最小代碼。 - 指令層級：單個IR指令。
注意：下面代碼最好不要用中文，使用起來非常麻煩，控制枱，編譯，目標文件的編碼不同會造成亂碼。
項目目錄如下
/MyProject
├── CMakeLists.txt # CMake 配置文件
├── build/ #構建目錄
│ └── test.c #測試編譯代碼
└── mypass1.cpp # pass 項目代碼
一，測試代碼示例
test.c
#include <stdio.h>
void secret_function() {
printf("I am secret\n");
}
int main() {
secret_function();
return 0;
}
二，Pass編寫
項目描述：通過解析下面代碼的IR，將下面代碼中的函數名打印出來。
mypass1.cpp
#include "llvm/IR/PassManager.h"
#include "llvm/Passes/PassBuilder.h"
#include "llvm/Passes/PassPlugin.h"
#include "llvm/Support/raw_ostream.h"
using namespace llvm;
// 這個結構體基本是固定模板
namespace {
struct mypass1 : public PassInfoMixin<mypass1> {
//函數回調，每次遇到函數時調用（這裏有重載，存在多種入口方式，可以以模塊為入口）
PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
//這裏是主要的邏輯代碼，我們主要學習的代碼在這
//打印出當前函數的名字
errs() << "Found Function: " << F.getName() << "\n";
//只讀時返回：PreservedAnalyses::all()
//存在修改時：PreservedAnalyses::none()
return PreservedAnalyses::all();
}
};
}
//下面基本上是固定的模板，每個pass沒什麼變化，可以直接複製粘貼，或者背熟。
//直接使用需要修改的是下面的<模塊名稱，版本號，調用參數，和調用的pass結構體>
extern "C" LLVM_ATTRIBUTE_WEAK::llvm::PassPluginLibraryInfo
llvmGetPassPluginInfo() {
return {
LLVM_PLUGIN_API_VERSION,//版本信息
"mypass1",//模塊信息，自定義
"v0.1",//版本號，自定義
[](PassBuilder &PB) {
PB.registerPipelineParsingCallback(
[](StringRef Name, FunctionPassManager &FPM,
ArrayRef<PassBuilder::PipelineElement>) {
if (Name == "mypass1") {//調用參數
FPM.addPass(mypass1());//上面pass結構體
return true;
}
return false;
}
);
}
};
}
三，Pass的構建
構建LLVM Pass需要寫CMakeLists.txt構建聲明
1. 配置CMake配置文件
CMakeLists.txt
下面的cmake配置可以直接拿去用，我已經標註好需要修改的位置
#cmake 版本，可通過 cmake --version 判斷
cmake_minimum_required(VERSION 4.1.1) #---->修改 cmake版本號
#項目名字
project(mypass1) #---->修改 項目名稱
#導入項目的 LLVM cmake 配置文件路徑(如果根據我之前文章安裝這裏就相同)
set(LLVM_DIR "D:/LLVM/llvm-project/build/lib/cmake/llvm")#---->修改 llvm cmake配置路徑
#尋找 LLVM 的包文件
#REQUIRED 找不到 LLVM 則停止構建
#強制使用 LLVM 安裝時生成的配置文件進行定位
find_package(LLVM REQUIRED CONFIG)
#將 LLVM 的 CMake 模塊路徑添加到當前 CMake 搜索路徑中，以便後續使用 include(AddLLVM)。
list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}")
#引入 LLVM 提供的專用 CMake 宏
include(AddLLVM)
#將 LLVM 的頭文件目錄（如 llvm/IR/Function.h）加入編譯器的搜索路徑
include_directories(${LLVM_INCLUDE_DIRS})
#導入 LLVM 編譯時使用的宏定義
add_definitions(${LLVM_DEFINITIONS})
#設置 C++ 標準為 C++17。(這裏如果不用17編譯會報錯)
set(CMAKE_CXX_STANDARD 17)
#強制要求必須支持 C++17，如果編譯器不支持則失敗。
set(CMAKE_CXX_STANDARD_REQUIRED ON)
#創建一個模塊化的庫(.dll)
add_library(mypass8 MODULE mypass8.cpp) #---->修改 項目名稱，文件名
#windows不用會報錯：導出符號
#LLVM Pass 需要暴露一些特定的入口點（如 getAnalysisUsage）給 opt 工具調用。
set_target_properties(mypass8 PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON) #---->修改 項目名稱
# 指定該 Pass 需要鏈接的 LLVM 核心組件。
# LLVMCore: 提供 IR、Function、Module 等核心類。
# LLVMSupport: 提供各種輔助工具類（如 errs() 輸出）。
target_link_libraries(mypass8 LLVMCore LLVMSupport) #---->修改 項目名稱，文件名
# 為該目標設置特定的編譯器選項。
# /utf-8: 告訴 MSVC 編譯器使用 UTF-8 編碼處理源代碼，防止中文註釋引起的亂碼或編譯錯誤。
target_compile_options(mypass8 PRIVATE /utf-8)#---->修改 項目名稱，文件名
2.編譯並構建Pass
打開visual studio的工作台，我這裏是x64 Native Tools Command Prompt for VS 2022`
進到build目錄
#構建項目
#其中-DCMAKE_BUILD_TYPE=RelWithDebInfo不選會報錯，由於我之前編譯的是帶符號的relase版本
cmake -G "Ninja" -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
#編譯
ninja
最後出現下面提示，即為編譯成功
[2/2] Linking CXX shared module mypass1.dll
四，使用你第一個Pass
進到build目錄
#把.c文件編譯為.ll
#-O1 使用O1優化（這裏我嘗試-O0不優化，會導致我的pass無法應用）
#-Xclang -disable-llvm-passes 不使用默認的pass優化
clang -S -emit-llvm -O1 -Xclang -disable-llvm-passes test.c -S -o test.ll
#使用pass
opt -load-pass-plugin=mypass1.dll -passes=mypass1 test.ll -S -o test_opt.ll
輸出結果
Found Function: sprintf
Found Function: vsprintf
Found Function: _snprintf
Found Function: _vsnprintf
Found Function: secret_function
Found Function: printf
Found Function: main
Found Function: _vsprintf_l
Found Function: _vsnprintf_l
Found Function: __local_stdio_printf_options
Found Function: _vfprintf_l
如果❤喜歡❤本系列教程，就點個關注吧，後續不定期更新~
