01. llvm 在 iOS 插樁
網(wǎng)上我就搜到這一篇文章介紹使用 LLVM Pass 的方式，來實(shí)現(xiàn)函數(shù)插樁。
但是按照他文章的一步步坐下來，發(fā)現(xiàn)各種報(bào)錯(cuò)，要不就是 pass 無法被 xcode 加載，反正遇到了不少的問題。
而且該作者很多核心的部分都沒有寫出來，不知道是因?yàn)樘?jiǎn)單，還是不想讓別人知道 ~
經(jīng)歷了兩周多左右的研究，以 LLVM 小白的身份，終于跑起來了 ~ 不容易 ~
注意：如下內(nèi)容，最好需要你已經(jīng)有 LLVM 環(huán)境?。。?/p>
02. C 函數(shù) 手動(dòng)插樁
long _ly_fun_b()
{
struct timeval star;
gettimeofday(&star, NULL);
long b = star.tv_sec * 1000000 + star.tv_usec;
return b;
}
void _ly_fun_e(char *name, long b)
{
struct timeval end;
gettimeofday(&end, NULL);
long e = end.tv_sec * 1000000 + end.tv_usec;
long t = e - b;
printf("%s %ld us\n",name, t);
}
int main()
{
long b = _ly_fun_b();
printf("hello world!");
_ly_fun_e("main", b);
return 0;
}
手動(dòng)插樁實(shí)際上就是將預(yù)先寫好的開始和結(jié)束兩個(gè)函數(shù)的調(diào)用，手動(dòng)寫入到 main() 執(zhí)行前 和 執(zhí)行后。
那么自動(dòng)插樁了？
就是不需要手動(dòng)在 main() 中進(jìn)行修改，而是在編譯的過程中，自動(dòng)將上面2個(gè)函數(shù)，插入到 main() 執(zhí)行前 和 執(zhí)行后。
那么如何在編譯的時(shí)候，在 main() 插入其他的 函數(shù)調(diào)用 了？
03. 通過 LLVM Pass 自動(dòng)插樁的過程
這里涉及一些 LLVM IR 的東西，在這里就不列舉了，可以自己去學(xué)習(xí)下。
總之，我們可以在如上 橘黃色 Optimizer (優(yōu)化器）這部分，來完成 自動(dòng)插樁 的目的。
而 LLVM 留給開發(fā)者在 Optimizer (優(yōu)化器）階段 讀寫 IR 的方式也有很多，比如：Pass、ClangPlugin ..
至于 Pass 和 ClangPlugin 對(duì)比，可以自己去看下，本文通過 Pass 來實(shí)現(xiàn)。
04. 實(shí)現(xiàn) 函數(shù)插樁 Pass
04-01. $LLVM_SOURCE/lib/Transforms/MyPlacement/MyPlacementPass.cpp
#include <string>
#include <system_error>
#include <iostream>
#include "llvm/Support/raw_ostream.h"
#include "llvm/Pass.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/LegacyPassManager.h"
#include "llvm/IR/IRBuilder.h"
//#include "llvm/IR/BasicBlock.h"
//#include "llvm/IR/Constants.h"
//#include "llvm/IR/LLVMContext.h"
//#include "llvm/IR/Type.h"
#include "llvm/Transforms/IPO/PassManagerBuilder.h"
using namespace llvm;
struct MyPlacementPass : public FunctionPass
{
static char ID;
MyPlacementPass() : FunctionPass(ID){}
bool runOnFunction(Function &F) override
{
printf("------------- runOnFunction --------------\n");
if (F.getName().startswith("_ly_fun"))
{
return false;
}
LLVMContext &context = F.getParent()->getContext();
BasicBlock &bb = F.getEntryBlock();
Instruction *beginInst = dyn_cast<Instruction>(bb.begin());
FunctionType *type = FunctionType::get(Type::getInt64Ty(context), {}, false);
Constant *beginFun = F.getParent()->getOrInsertFunction("_ly_fun_b", type);
Value *beginTime = nullptr;
if (Function *fun = dyn_cast<Function>(beginFun))
{
CallInst *inst = CallInst::Create(fun);
inst->insertBefore(beginInst);
beginTime = inst;
}
for (Function::iterator I = F.begin(), E = F.end(); I != E; ++I)
{
BasicBlock &BB = *I;
for (BasicBlock::iterator I = BB.begin(), E = BB.end(); I != E; ++I)
{
ReturnInst *IST = dyn_cast<ReturnInst>(I);
if (IST)
{
FunctionType *type = FunctionType::get(Type::getVoidTy(context), {Type::getInt8PtrTy(context),Type::getInt64Ty(context)}, false);
Constant *s = BB.getModule()->getOrInsertFunction("_ly_fun_e", type);
if (Function *fun = dyn_cast<Function>(s))
{
IRBuilder<> builder(&BB);
CallInst *inst = CallInst::Create(fun, {builder.CreateGlobalStringPtr(BB.getParent()->getName()), beginTime});
inst->insertBefore(IST);
}
}
}
}
return false;
}
};
char MyPlacementPass::ID = 0;
// Automatically enable the pass.
// http://adriansampson.net/blog/clangpass.html
static void registerSkeletonPass(const PassManagerBuilder &, legacy::PassManagerBase &PM)
{
PM.add(new MyPlacementPass());
}
static RegisterStandardPasses RegisterMyPass(PassManagerBuilder::EP_EarlyAsPossible, registerSkeletonPass);
如上代碼基本與前面的博客文章中的差不太多，但是底部的幾句代碼，那篇博客中并沒有貼出來，這也是我經(jīng)歷了一兩周摸索 ~
不加上這幾句，編譯出來的 dylib ，總是無法被 clang 加載執(zhí)行。
并且注意如上代碼是用的 LLVM 8.0.1 版本的代碼，對(duì)應(yīng) LLVM github 源碼倉(cāng)庫中的是 release_80 分支的代碼。
我當(dāng)時(shí)使用的是 LLVM github 源碼倉(cāng)庫中的是 release_90 分支代碼，如上代碼一直編譯報(bào)錯(cuò)，發(fā)現(xiàn)很多的 API 都已經(jīng)變了，搜搜了很多文檔才找到新的 API 使用。
這是 Pass 的毛病，因?yàn)橐蕾嚨氖?libclang 庫，而這個(gè)庫 API 是不穩(wěn)定的，經(jīng)常會(huì)發(fā)生變化。
04-02. $LLVM_SOURCE/lib/Transforms/MyPlacement/CMakeLists.txt
add_llvm_library( MyPlacementPass MODULE
MyPlacementPass.cpp
)
04-03. 構(gòu)建生成 Pass dylib
╭─xiongzenghui at xiongzenghui的MacBook Pro in ~/llvm-8.0.1.src/build/Debug/lib using ?ruby-2.4.1?
╰─○ ll | grep -i 'MyPlacementPass'
-rwxr-xr-x 1 xiongzenghui staff 149K 10 10 22:52 MyPlacementPass.dylib
MyPlacementPass.dylib 這個(gè)動(dòng)態(tài)庫就是要使用到的 LLVM Pass。
05. 新建一個(gè) Mac App 項(xiàng)目, 使用 Pass
05-01. Build Settings 中新增 CC、CXX 兩項(xiàng)用戶定義設(shè)置, 指向自己編譯的 clang
05-02. Build Settings 修改 OTHER_CFLAGS 加載 pass dylib
05-03. 如果編譯報(bào)錯(cuò): unknown argument index ...
Build Settings 欄目中搜索 index , 然后將 Enable Index-Wihle-Building Functionality 默認(rèn)值 Default 改為 NO
05-04. 運(yùn)行 mac app
?? ?? ?? 成功自動(dòng)插樁
如上 Mac App 項(xiàng)目的代碼: https://gitee.com/garywade/LLVMDemo.git
參考的資料
https://blog.csdn.net/qq_23599965/article/details/86620219
https://www.leadroyal.cn/?p=647
http://www.itdecent.cn/p/4d392b16d831
