Clang是llvm的編譯器前端,非常適合進行原始碼分析.目前開源的oclint就是基於clang進行的程式碼靜態檢查.工作中遇到了一些問題需要進行程式碼分析,所以學習了外掛的開發流程.既然開發外掛就要有合適的IDE,Mac上最合適的無疑是xcode了.本文將講述如何使用xcode開發clang外掛,在此之前請先了解clang的相關知識.

1、編譯外掛

1.1、程式碼下載

1.2、新增外掛程式碼

a.建立外掛所在資料夾(示例程式碼見 demo)

b.編寫cmakelists檔案

c.新增外掛程式碼

1.3、編譯程式碼

有兩種編譯方式，一種使用cmake直接編譯，一種使用IDE。這裡介紹下使用xcode的編譯方式。

a. 生成 xcodeproj 檔案

cd /opt
sudo mkdir llvm
sudo chown `whoami` llvm
cd llvm
export LLVM_HOME=`pwd`

git clone -b release_39 [email protected].com:llvm-mirror/llvm.git llvm
git clone -b release_39 [email protected].com:llvm-mirror/clang.git llvm/tools/clang
git clone -b release_39 [email protected]
 
.com:llvm-mirror/clang-tools-extra.git llvm/tools/clang/tools/extra
git clone -b release_39 [email protected].com:llvm-mirror/compiler-rt.git llvm/projects/compiler-rt

mkdir llvm_build
cd llvm_build
cmake -G Xcode ../llvm -DCMAKE_BUILD_TYPE:STRING=MinSizeRel

b. 選擇自動生成 schmema

c. 編譯 clang，myplugin 和 libclang

d. 最終效果

2、使用外掛

2.1、hook xcode

a. 執行以下兩個命令

sudo mv HackedClang.xcplugin `xcode-select -print-path`/../PlugIns/Xcode3Core.ideplugin/Contents/SharedSupport/Developer/Library/Xcode/Plug-ins

sudo mv HackedBuildSystem.xcspec `xcode-select -print-path`/Platforms/iPhoneSimulator.platform/Developer/Library/Xcode/Specifications

如果自定義 clang 路徑和展示的名稱，則修改以下檔案

b. Xcode 配置

c. 新增 other_flags

-Xclang -load -Xclang /opt/llvm/clangplugin/libONEExtractVCPlugin.dylib -Xclang -add-plugin -Xclang ONEExtractVCPlugin -I/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include/c++/v1

/opt/llvm/clangplugin/libMyPlugin.dylib:是動態庫地址
MyPlugin：外掛名稱
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include/c++/v1:使用的c++庫

2.2、命令列呼叫 clang 外掛

直接替換紅框的 clang 為自己編譯的 clang 即可

2.2 常用 API 介紹

a. 註冊外掛

static clang::FrontendPluginRegistry::Add<my::MyASTAction>
X("MyPluginName", "MyPlugin description");

第一個引數是外掛名稱,第二個是外掛描述

b. 傳遞引數到外掛

bool MyASTAction::ParseArgs(const CompilerInstance &CI, const std::vector<std::string>& args) {
        size_t cnt = args.size();
        for(int i = 0;i < cnt;i++){
            cout<<"myparam:"<<args.at(i)<<endl;
        }
       return true;
}

編譯的時候新增plugin對應的param就可以通過該方法將param獲取到.例如在other_cflag除了上期配置外新增中新增-Xclang -plugin-arg-MyPlugin -Xclang $SRCROOT/..,就可以將srcroot的路徑打印出來

• ast 解析完成呼叫
  void MyASTConsumer::HandleTranslationUnit(ASTContext &context){}

• 獲取父類名稱:interfDecl->getSuperClass()->>getNameAsString()


• 是否是實現類：if(isa<ObjCImplDecl>(decl)){}

• 是否是category： if(isa<ObjCCategoryDecl>(decl)){}

• 是否是協議： if(isa<ObjCProtocolDecl>(decl)){}
• 是否是 property：if(isa<ObjCPropertyDecl>(decl)){}

是否是例項變數:objcIsInstanceMethod = propertyDecl->isInstanceProperty();
property型別(修飾符例如NSString):propertyDecl->getType().getAsString();
getter方法名稱:propertyDecl->getGetterName().getAsString()
setter方法名稱:propertyDecl->getSetterName().getAsString()
是否只讀:propertyDecl->isReadOnly()
是否是類property:propertyDecl->isClassProperty()
是否是原子性:propertyDecl->isAtomic()

b. 是否是成員變數 ：if (isa<ObjCIvarDecl>(decl)) {}
成員變數名稱:ivarDecl->getNameAsString()

c. 是否是引數 : if (isa<ObjCTypeParamDecl>(decl)){}

@interface NSDictionary<Key : id<NSCopying>, Value>@end
key,value就是paramter

• 是否是方法 : if(isa<ObjCMethodDecl>(decl)){}

是否是例項方法: methodDecl->isInstanceMethod()
selector名稱: methodDecl->getSelector().getAsString()
返回值型別:methodDecl->getReturnType().getAsString()
引數:
for(ArrayRef<ParmVarDecl *>::iterator it = methodDecl->param_begin();it!=methodDecl->param_end();it++){
    cout<<"引數:"<<((*it)->getNameAsString())<<"引數型別:"<<(*it)->getType().getAsString()<<endl;
}

d. 是否是變數方法列舉等 if(isa<DeclRefExpr>(s)){}

宣告的名稱:callExpr->getDecl()->->getNameAsString()
是否是變數:isa<VarDecl>(decl)
是否是函式:isa<FunctionDecl>(decl)
是否是列舉:isa<EnumConstantDecl>(decl)

e. 向object-c物件傳送訊息 isa<ObjCMessageExpr>(s)

呼叫者:objcExpr->getSelector().getAsString() 
函式本身名稱: objcExpr->getSelector().getAsString() 
接受訊息型別:objcExpr->getReceiverType().getAsString()

3、獲取編譯命令

3.1、獲取編譯命令

xcodebuild clean
xcodebuild -workspace OneTravel.xcworkspace -scheme OneTravel CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO -dry-run -configuration Release| ruby onepretty

解釋：
CODE_SIGN_IDENTITY=”” CODE_SIGNING_REQUIRED=NO：表示不需要證書編譯
-dry-run:只獲取編譯命令，執行

onepretty: 從xcpretty中抽取的工具，移除了無用程式碼，添加了複製標頭檔案軟連線功能

3.2、修改編譯命令

針對 libtool 的命令適配，其他引數見連結

a.移除-gmodules： 這個命令會打包編譯資訊，自定義的libtool不支援，而且也沒有用。

b.移除 -c和-o及其引數: 僅解析ast，這是無用引數

c.新增引用c++庫（如果要解析一些.cpp和.mm檔案）: -I/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include/c++/v1


d.替換工具: 將 clang 替換成自己的工具，如onec -- -x --後面對應對應,雙橫線參見

示例如下（精簡版）：

/Users/xx/Documents/plugin/bin/bin/onec /Users/xx/Documents/conn_connection.cpp  -outdir=~/Desktop -- -x c++ -arch armv7 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS10.3.sdk -I/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/include/c++/v1

4、libtool 工具開發

4.1 新增程式碼和 CMake檔案

進入 llvm_build 資料夾清空原來的檔案，重新編譯程式碼 cmake -G Xcode ../llvm -DCMAKE_BUILD_TYPE:STRING=MinSizeRel

4.2 一些模組的簡介

一些clang元件的作用：
libclangLex：預處理、詞法分析、巨集處理、詞元（token）、語法構造；
libclangAST：該庫是用來建立、管理、遍歷AST
libclangParse：語法分析，用來解析詞法分析後的結果
libclangSema：語義分析
libclangCodeGen：目標相關的程式碼分析
libclangAnaylysis：用於進行靜態分析用的
libclangRewrite：程式碼重新寫入（不知道該怎麼解釋，稍後理解了再做解釋）
libclangBasic：clang的基礎雜項庫

5、 外掛和 libtool 工具簡單對比

由於 libtool 和clang 外掛的大部分api可以通用，因此實際工作用中選擇哪個都可以，如果出現問題，兩者的程式碼可以低成本的相互遷移。

links