Whole Program LLVM (WLLVM) 技术文档

本文档旨在帮助用户了解和掌握 Whole Program LLVM (WLLVM) 的安装、使用和 API 调用方法。

1. 安装指南

WLLVM 现在可以通过 pip 包管理器进行安装。根据您的权限，可以使用以下命令：

pip install wllvm

或者

sudo pip install wllvm

如果您想要开发或使用开发版本的 WLLVM，可以按照以下步骤操作：

git clone https://github.com/travitch/whole-program-llvm
cd whole-program-llvm

然后，您可以选择以下任一方式安装 WLLVM：

• 在系统中全局安装：

sudo pip install -e .

• 在虚拟 Python 环境中安装，以避免全局安装：

virtualenv venv
source venv/bin/activate
pip install -e .

2. 项目使用说明

WLLVM 提供了四个 Python 执行文件：wllvm 用于编译 C 语言代码，wllvm++ 用于编译 C++ 代码，辅助工具 extract-bc 用于从构建产物中提取 bitcode，以及一个健全性检查器 wllvm-sanity-checker。

为了使用这些包装器，必须设置以下环境变量：

• LLVM_COMPILER 应设置为 dragonegg 或 clang。
• LLVM_GCC_PREFIX 应设置为与 dragonegg 一起使用的 gcc 版本的前缀。如果没有前缀，则可以为空。如果 $LLVM_COMPILER 为 clang，则此变量不使用。
• LLVM_DRAGONEGG_PLUGIN 应为 dragonegg 插件的完整路径。如果 $LLVM_COMPILER 为 clang，则此变量不使用。

设置好环境变量后，只需使用 wllvm 和 wllvm++ 作为您的 C 和 C++ 编译器即可。

3. 项目 API 使用文档

WLLVM 的 API 文档可以在其官方文档中找到。文档详细介绍了如何通过 Python 调用 WLLVM 提供的接口。

4. 项目安装方式

请参考本文档的“安装指南”部分，了解如何通过 pip 包管理器或源代码安装 WLLVM。

以下是一些使用 WLLVM 的示例：

编译 C 代码为 bitcode

export LLVM_COMPILER=clang

tar xf pkg-config-0.26.tar.gz
cd pkg-config-0.26
CC=wllvm ./configure
make

提取 bitcode：

extract-bc pkg-config

编译 C++ 代码为 bitcode

export LLVM_COMPILER=dragonegg
export LLVM_GCC_PREFIX=llvm-
export LLVM_DRAGONEGG_PLUGIN=/unsup/llvm-2.9/lib/dragonegg.so

tar xf pkg-config-0.26.tar.gz
cd pkg-config-0.26
CC=wllvm ./configure
make

提取 bitcode：

extract-bc pkg-config

构建和提取 bitcode 归档

export LLVM_COMPILER=clang
tar -xvf bullet-2.81-rev2613.tgz
mkdir bullet-bin
cd bullet-bin
CC=wllvm CXX=wllvm++ cmake ../bullet-2.81-rev2613/
make

# 产生 src/LinearMath/libLinearMath.bca
extract-bc src/LinearMath/libLinearMath.a

注意

本文档仅提供基本的安装和使用说明。更多详细信息，请参考 WLLVM 的官方文档和 GitHub 仓库。