LLVM系列第十八章：写一个简单的IR处理流程Pass

原创

已于 2023-08-15 16:22:52 修改 · 4.2k 阅读

于 2022-06-25 06:26:26 首次发布

这篇博客详细介绍了如何使用LLVM创建一个简单的IR处理流程Pass，包括项目结构、CMake配置、Pass实现及编译运行步骤。通过实例展示了如何编写一个打印函数名称的Pass，并给出了完整的CMake脚本和源代码。

系列文章目录

flex&bison系列

本文目录

前言
一、项目结构
二、项目细节
- 1. 程序模块
- 3. My 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
└── ...

二、项目细节

1. 程序模块

这个简单的项目只包含了一个模块：

MyPass，一个简单的Pass模块

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)
...

3. My Pass

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 granular