llvm_pass

2021-06-13

llvm pass的编写

可以参考一下官网，本文基于llvm11.0.1,也是参考官网来编写的。
https://releases.llvm.org/11.0.1/docs/WritingAnLLVMPass.html

在/home/juziss/llvm-project-11.0.1.src/llvm/lib/Transforms该目录下创建一个目录，这里就叫EncodeFunctionName,然后在该目录创建.cpp文件和CMakeLists.txt。
在../llvm-project-11.0.1.src/llvm/lib/Transforms目录的CMakeLists.txt加上add_subdirectory(EncodeFunctionName),括号里的内容为刚才创建的目录名
在刚才创建的CMakeLists.txt添加

add_llvm_library( LLVMEncodeFunctionName MODULE
        EncodeFunctionName.cpp

        PLUGIN_TOOL
        opt
        )

从示例Hello处copy示例进行修改

最终修改成的代码如下

//
// Created by juziss on 6/13/21.
//
//===- Hello.cpp - Example code from "Writing an LLVM Pass" ---------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file implements two versions of the LLVM "Hello World" pass described
// in docs/WritingAnLLVMPass.html
//
//===----------------------------------------------------------------------===//

#include "llvm/ADT/Statistic.h"
#include "llvm/IR/Function.h"
#include "llvm/Pass.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/IR/LegacyPassManager.h"
#include <llvm/Transforms/IPO/PassManagerBuilder.h>
using namespace llvm;

#define DEBUG_TYPE "encodeFunctionName"

STATISTIC(EncodeFunctionNameCounter, "Counts number of functions greeted");

namespace {
  // Hello - The first implementation, without getAnalysisUsage.
  struct EncodeFunctionName : public FunctionPass {
    static char ID; // Pass identification, replacement for typeid
    EncodeFunctionName() : FunctionPass(ID) {}

    bool runOnFunction(Function &F) override {
      ++EncodeFunctionNameCounter;
      StringRef funcName = F.getName();
      if (!funcName.contains("main")){
        F.setName("juziss" + funcName);
      }      errs() << "EncodeFunctionName: ";
      errs().write_escaped(F.getName()) << '\n';
      return false;
    }
  };
} // namespace

char EncodeFunctionName::ID = 0;
static RegisterPass<EncodeFunctionName>
    X("encodeFuntionName", "Change the Function Name", false, false);

static llvm::RegisterStandardPasses
    Y(llvm::PassManagerBuilder::EP_EarlyAsPossible,
      [](const llvm::PassManagerBuilder &Builder,
         llvm::legacy::PassManagerBase &PM) {
        PM.add(new EncodeFunctionName());
      });

直接在clion里build project

编写示例代码查看llvm pass效果

编写简单的c/cpp代码

#include <stdio.h>

void hello_2(){
    printf("hello 2");
}

void hello_1(){
    printf("hello 1");
}

int main(){
    
    printf("hello world!");
    return 0;
}

clang -emit-llvm -S ./hello_c.c编译生成.ll文件

opt -load /home/juziss/llvm-project-11.0.1.src/llvm/cmake-build-debug/lib/LLVMEncodeFunctionName.so -encodeFuntionName hello_c.ll -o hello_c.bc

opt -load /home/juziss/llvm-project-11.0.1.src/llvm/cmake-build-debug/lib/LLVMEncodeFunctionName.so -encodeFuntionName /home/juziss/c_workspace/hello_c.ll -o hello_c.bc
clang hello_c.cb -o hello_c
用IDA打开编译生成后的文件

在llvm源码外编译llvm项目

官方文档位置 https://llvm.org/docs/CMake.html#cmake-out-of-source-pass

按照以下目录结构创建项目

<project dir>/
    |
    CMakeLists.txt
    <pass name>/
        |
        CMakeLists.txt
        Pass.cpp
        ...

在项目根目录下的CMakeLists.txt文件添加如下内容

find_package(LLVM REQUIRED CONFIG)

add_definitions(${LLVM_DEFINITIONS})
include_directories(${LLVM_INCLUDE_DIRS})

add_subdirectory(<pass name>)

在pass的目录里的CMakeLists.txt添加这行命令
在<project dir>/CMakeLists.txt (after find_package(LLVM …))添加如下命令

1 2	list(APPEND CMAKE_MODULE_PATH "${LLVM_CMAKE_DIR}") include(AddLLVM)

在<project dir>/<pass name>/CMakeLists.txt下添加如下命令
1
2
3
add_llvm_library(LLVMPassname MODULE
Pass.cpp
)

把llvm源码外创建的pass项目添加到llvm源码目录下(可选项)
复制目录到 /lib/Transform目录下。
.添加add_subdirectory(<pass name>)到<LLVM root>/lib/Transform/CMakeLists.txt下。
用clion打开该项目

配置好cmake之后会报错，按报错的内容来进行项目修改即可

编译一个带我们编写的pass的llvm()

在<LLVM root>/include/Transforms下创建与<LLVM root>/lib/Transforms创建的目录一致。
在该目录下创建.h文件，该.h文件是为了创建刚才在<LLVM root>/lib/Transforms创建的.cpp文件的那个类能自由通过引入.h文件来创建类。

然后再源文件里引入该.h文件，并实现该函数。
在<LLVM root>/lib/Transforms/IPO/PassManageBuilder.cpp添加如下代码

并在<LLVM root>/lib/Transforms/EncodeFunctionName/创建LLVMBuild.txt

在<LLVM root>/lib/Transforms/EncodeFunctionName/下的CMakeLists.txt当中添加如下内容

1
2
3

ADDITIONAL_HEADER_DIRS
${LLVM_MAIN_INCLUDE_DIR}/llvm/Transforms
${LLVM_MAIN_INCLUDE_DIR}/llvm/Transforms/EncodeFunctionName

在以下文件添加EncodeFunctionName
编译

出现截图的.a文件就可以了~

附：EncodeFunctionName的CMakeLists.txt如下所示

add_llvm_library( LLVMEncodeFunctionName
        EncodeFunctionName.cpp


        ADDITIONAL_HEADER_DIRS
        ${LLVM_MAIN_INCLUDE_DIR}/llvm/Transforms
        ${LLVM_MAIN_INCLUDE_DIR}/llvm/Transforms/EncodeFunctionName

        DEPENDS
        intrinsics_gen
        )

注意，Module是删掉了！！！