LLVM Pass 教程项目文档

1. 项目目录结构及介绍

llvm-pass-tutorial/
├── Armariris/
│   ├── ...
│   └── ...
├── Hikari/
│   ├── ...
│   └── ...
├── ollvm/
│   ├── ...
│   └── ...
├── skeleton/
│   ├── ...
│   └── ...
├── .gitignore
├── CMakeLists.txt
├── LICENSE
└── README.md

目录结构介绍

• Armariris/: 包含与Armariris相关的文件和代码。
• Hikari/: 包含与Hikari相关的文件和代码。
• ollvm/: 包含与ollvm相关的文件和代码。
• skeleton/: 包含项目的骨架代码，用于构建LLVM Pass的基础结构。
• .gitignore: Git忽略文件，指定哪些文件和目录不需要被Git跟踪。
• CMakeLists.txt: CMake配置文件，用于构建项目。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文件。

2. 项目的启动文件介绍

在llvm-pass-tutorial项目中，没有明确的“启动文件”，因为LLVM Pass的构建和运行通常是通过CMake和LLVM工具链来完成的。项目的启动过程主要包括以下步骤：

1. 配置项目: 使用CMake配置项目，生成构建文件。
2. 构建项目: 使用生成的构建文件进行编译和构建。
3. 运行Pass: 通过LLVM工具链（如opt工具）运行生成的Pass。

3. 项目的配置文件介绍

CMakeLists.txt

CMakeLists.txt是项目的配置文件，用于配置和构建项目。以下是该文件的主要内容和功能：

cmake_minimum_required(VERSION 3.13)
project(llvm-pass-tutorial)

set(CMAKE_CXX_STANDARD 14)

find_package(LLVM REQUIRED CONFIG)

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

add_subdirectory(Armariris)
add_subdirectory(Hikari)
add_subdirectory(ollvm)
add_subdirectory(skeleton)

add_library(llvm-pass-tutorial SHARED
    Armariris/...
    Hikari/...
    ollvm/...
    skeleton/...
)

target_link_libraries(llvm-pass-tutorial ${LLVM_LIBRARIES})

配置文件功能介绍

• cmake_minimum_required: 指定所需的CMake最低版本。
• project: 定义项目的名称。
• set(CMAKE_CXX_STANDARD 14): 设置C++标准为C++14。
• find_package(LLVM REQUIRED CONFIG): 查找并配置LLVM库。
• include_directories: 包含LLVM的头文件目录。
• add_definitions: 添加LLVM的定义。
• add_subdirectory: 添加子目录，包含各个模块的代码。
• add_library: 定义一个共享库，包含各个模块的代码。
• target_link_libraries: 链接LLVM库。

通过这些配置，项目可以正确地构建和运行LLVM Pass。