一种将LLVM Pass集成到NDK中的通用方法

源码资源网 · 发表于 2024-10-24 09:29:01

关于“如何将自己写的LLVM Pass集成到NDK中”这个问题，目前网上并没有很完美的方法，并且大多数已经过时。经过我的一番折腾，最终摸索出了一种比较简单实用的方法，可供参考。

0x00. 概览

简单来说，本文要介绍的方法是下载NDK中llvm-android部分的源码，在llvm-android中的llvm-project子项目中加入自己的Pass后与整个项目一起编译，用编译好的文件替换掉NDK中的工具链。
该方法有以下优点：

Windows、macOS、Linux通用，各NDK版本也通用
理论上加入自己的Pass后不会出现不兼容的问题
操作过程简单易懂

当然也有缺点：

无法直接照搬OLLVM、Hikari、Armariris等现成项目的源码，需要手动做一些迁移
第一次编译比较耗时

0x01. 操作流程

本文并不是直接将最终的操作方法摆在大家面前，还讲解了为什么要这么操作，因此过程会显得较冗长，需要有一点耐心看下去。

1. 环境准备

如果是Windows，首先需要准备Linux虚拟机进行交叉编译，因为NDK不支持在Windows上直接编译，我这里使用的是Ubuntu 20.04.3；macOS则不需要。NDK版本我选择的是23.1.7779620。
本文以Windows+Linux虚拟机为例讲解，macOS下的操作大同小异。
以下使用的指令全部以root权限执行。

2. 下载 llvm-android 源代码

NDK使用的是git-repo这一工具管理，而不是git，所以首先需要安装git-repo：

1 2	curl https://storage.googleapis.com/git-repo-downloads/repo > /usr/bin/repo chmod a+x /usr/bin/repo

上面这个地址需要科学上网才能访问，我们可以换成国内的清华源：

1 2	curl https://mirrors.tuna.tsinghua.edu.cn/git/git-repo > /usr/bin/repo chmod a+x /usr/bin/repo

在$NDK_PATH oolchainsllvmprebuiltwindows-x86_64AndroidVersion.txt中查看NDK使用的LLVM版本，在我使用的NDK中，AndroidVersion.txt 的内容是：

1 2	12.0.8 based on r416183c1

在https://android.googlesource.com/toolchain/llvm_android/中找到对应版本的 llvm-android 源码：

一种将LLVM Pass集成到NDK中的通用方法

Google的文档中给出了下载 llvm-android 源代码的方法，但这里默认下载的是最新版本：

1
2
3

mkdir llvm-toolchain && cd llvm-toolchain
repo init -u https://android.googlesource.com/platform/manifest -b llvm-toolchain
repo sync -c

我们需要做一些操作来换成我们想要的版本，在$NDK_PATH oolchainsllvmprebuiltwindows-x86_64目录下找到一个 manifest_xxxx.xml 文件，我这里是 manifest_7714059.xml。执行完下列指令后：

1 2	mkdir llvm-toolchain && cd llvm-toolchain repo init -u

将 manifest_7714059.xml 复制到.repo/mainifests文件夹中（注意.repo是隐藏文件夹，并且从Windows复制到Linux会有格式转换的问题，这里建议使用VSCode的SSH-Remote插件避免上述问题）：

一种将LLVM Pass集成到NDK中的通用方法

继续执行：

1 2	repo init -m manifest_7714059.xml repo sync -c

这里也要把Google的地址换成清华源，替换规则见 Android 镜像使用帮助，替换后完整的指令如下：

1
2
3
4
5

mkdir llvm-toolchain && cd llvm-toolchain
repo init -u
https://mirrors.tuna.tsinghua.edu.cn/git/AOSP/platform/manifest -b llvm-toolchain
repo init -m manifest_7714059.xml
repo sync -c

并且 manifest_7714059.xml 中的包含地址也要替换，否则即使科学上网，在下载的时候也非常慢：

一种将LLVM Pass集成到NDK中的通用方法

repo sync -c指令会下载一大堆的源代码和预编译文件，需要耗费十来分钟的样子，喝杯茶慢慢等吧。

3. 编译 llvm-android 源代码

在编译之前需要提前安装一些环境，否则编译会出错：

1	apt install cmake bison

如果是在Ubuntu 20.04.3下还需要做一个软链接，否则会报错ImportError: libffi.so.6: cannot open shared object file: No such file or directory。具体操作如下：

一种将LLVM Pass集成到NDK中的通用方法

然后就可以开始愉快且漫长的编译了（大概需要一两个小时，取决于机器性能）：

1	python toolchain/llvm_android/build.py --no-build linux

因为我是在Windows环境使用NDK，所以无需编译Linux下的toolchain，这里加上--no-build linux参数。
另外编译的时候最好把虚拟机内存开到8G以上，我开的是8G内存，编译的时候还会因为内存不足时不时中断，如果中断了重新运行编译指令就好。
编译结束后可以在out文件夹中找到编译好的内容：

一种将LLVM Pass集成到NDK中的通用方法