指令替換

項目需求：將加法指令替換為減法

項目目錄如下

/MyProject
├── CMakeLists.txt # CMake 配置文件
├── build/ #構建目錄
│   └── test.c #測試編譯代碼
└── mypass2.cpp # pass 項目代碼

一，測試代碼示例

test.c

// test.c
#include <stdio.h>

int my_add(int a, int b) {
    return a + b; 
}

int main() {
    int x = 10;
    int y = 20;
    printf("Result: %d\n", my_add(x, y));
    return 0;
}

二，編寫Pass

其他的固定的模板之前文章註釋有，這裏我只註釋當前項目重要的部分
代碼流程： 遍歷指令並匹配ADD指令->替換為sub指令

#include "llvm/IR/PassManager.h"
#include "llvm/Passes/PassBuilder.h"
#include "llvm/Passes/PassPlugin.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/IRBuilder.h" // <--- 【新增】必須包含這個頭文件！

using namespace llvm;

namespace {
	struct mypass3 : public PassInfoMixin<mypass3> {
	    PreservedAnalyses run(Function &F, FunctionAnalysisManager &) {
	        errs() << "Analyzing Function: " << F.getName() << "\n";
	        
	        bool changed = false; 
			
			//這裏的2個循環獲取的是遍歷函數的指令(函數->代碼塊->指令)
	        for (BasicBlock &BB : F) {
	            for (Instruction &Inst : BB) {
		            ]//判斷當前的指令是ADD指令(加法)
	                if (Inst.getOpcode() == Instruction::Add) {
						
	                    errs() << "Found ADD, changing to SUB...\n" << Inst << "\n";
						//創建IR構建器
						//在修改IR時需要用到構建器
	                    IRBuilder<> builder(&Inst);
	                    
	                    //這裏時獲取ADD的操作數：
	                    //%add = add nsw i32 %0, %1中的%0和%1
	                    Value *lhs = Inst.getOperand(0); // 左操作數
	                    Value *rhs = Inst.getOperand(1); // 右操作數
	                    //這裏是構建新的指令：sub
	                    //其中參數是：
	                    //1：左操作數
	                    //2：操作數
	                    //3：返回的變量名，相當於：%add = add nsw i32 %0, %1中的%add
	                    Value *newSub = builder.CreateSub(lhs, rhs, "new_sub");
	                    
	                    //替換指令
	                    Inst.replaceAllUsesWith(newSub);
	                    errs() << "Replaced with SUB: \n" << *lhs << "\n" << *rhs << "\n" << *newSub << "\n";
	                    changed = true;
	                    
	                }
	            }
	        }
			
	        if (changed) {
	            return PreservedAnalyses::none();
	        }
	
	        return PreservedAnalyses::all();
	    }
	};

} 

extern "C" LLVM_ATTRIBUTE_WEAK ::llvm::PassPluginLibraryInfo
llvmGetPassPluginInfo() {
    return {
        LLVM_PLUGIN_API_VERSION,
        "mypass3",
        "v0.1",
        [](PassBuilder &PB) {
            PB.registerPipelineParsingCallback(
                [](StringRef Name, FunctionPassManager &FPM,
                   ArrayRef<PassBuilder::PipelineElement>) {
                    if (Name == "mypass3") {
                        FPM.addPass(mypass3());
                        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(mypass2) #---->修改 項目名稱

#導入項目的 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(mypass2 MODULE mypass1.cpp) #---->修改 項目名稱，文件名
#windows不用會報錯：導出符號
#LLVM Pass 需要暴露一些特定的入口點（如 getAnalysisUsage）給 opt 工具調用。
set_target_properties(mypass2 PROPERTIES WINDOWS_EXPORT_ALL_SYMBOLS ON) #---->修改 項目名稱
# 指定該 Pass 需要鏈接的 LLVM 核心組件。 
# LLVMCore: 提供 IR、Function、Module 等核心類。 
# LLVMSupport: 提供各種輔助工具類（如 errs() 輸出）。
target_link_libraries(mypass2 LLVMCore LLVMSupport) #---->修改 項目名稱，文件名  
# 為該目標設置特定的編譯器選項。 
# /utf-8: 告訴 MSVC 編譯器使用 UTF-8 編碼處理源代碼，防止中文註釋引起的亂碼或編譯錯誤。  
target_compile_options(mypass2 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 mypass2.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=mypass2.dll -passes=mypass2  test.ll -S -o test_opt.ll

#編譯使用pass後的exe
clang test_opt.ll -o test_opt.exe
#編譯使用pass前的exe
clang test.ll -o test.exe

輸出結果
運行test.exe：不使用pass，輸出結果如下：

Result: 30

運行test_opt.exe：使用pass後，輸出結果如下：

Result: -10

我們成功讓我們的代碼 加法 變 減法

如果❤喜歡❤本系列教程，就點個關注吧，後續不定期更新~