Clang 之旅--使用 Xcode 開發(fā) Clang 插件

Clang 之旅系列文章:
Clang 之旅--使用 Xcode 開發(fā) Clang 插件
Clang 之旅--[翻譯]添加自定義的 attribute
Clang 之旅--實現(xiàn)一個自定義檢查規(guī)范的 Clang 插件

前言

最近在跟老大的聊天中聊到了一個比較特殊的需求:是否有辦法在編譯階段檢查某個方法的參數(shù)與返回值的類型相同,如果類型不一致的話能拋出編譯錯誤的提示。這似乎已經(jīng)不是 Objective-C 或者 Swift 的語言語法本身所能解決的了,老大還指點了可以從編譯器等底層中進行研究。于是,我踏進了 Clang 和 LLVM 的大門。

我打算將 Clang 的研究心得分為幾篇文章來寫,這是 Clang 之旅的第一篇,主要講如何用 Xcode 編譯 Clang,以及實現(xiàn)一個簡單的 Clang 插件并掛載到 Xcode 中參與編譯流程,算是進入 Clang 的門檻。只是,這門檻就狠狠地讓我吃了苦頭,Google 找到好幾篇博客講怎么編譯 Clang 的,但是也有一些年頭了,版本比較舊,編譯出來的 Clang 不能運行在現(xiàn)在的系統(tǒng)上;還有一些寫的比較含糊,漏了某些關(guān)鍵步驟,導致花了好幾個小時跟著教程做下來最后還是一堆 error;而且試錯的成本還是比較高的,下載的源碼有1G多(考慮從 Github 下載的速度??,需要掛個代理),完整編譯出來有20G左右,我的15款 Macbook Pro 大概需要瘋狂編譯2個小時…...如果不能接受這些的話,還是別嘗試了,很遺憾,你連見到 Clang 真容的機會都沒有┑( ̄Д  ̄)┍

llvm大小

編譯源碼

準備工作

Clang 需要用 CMake 來編譯,CMake 的安裝方法可以參考這篇文章:Mac 安裝 CMake & CMake Command Line Tools,建議對 CMake 完全不了解的同學可以先補充一點 CMake 的基本知識,這樣能更容易理解接下來要做的事情,CMake 的入門知識可以參考:CMake 入門實戰(zhàn)

下載源碼

首先創(chuàng)建 LLVM 的源碼路徑及編譯路徑:

cd /opt
sudo mkdir llvm
sudo chown `whoami` llvm    // 將 llvm 目錄的所有者指定為當前用戶
cd llvm
export LLVM_HOME=`pwd`      // 設(shè)置當前目錄(/opt/llvm)為 LLVM_HOME 目錄

接下來從 Github clone 源代碼(注意這幾條語句中的 release_60,在當前時間2018.3.18時,我試過了 release_33、release_39,編譯出來的 Clang 插件在運行的時候都會報 NSUUID 的 Nullability 錯誤,應(yīng)該是這些版本不支持 Objective-C 后來加的 Nullability 特性,所以我下載了當前最新的 release_60 分支。一般來說,最新分支是兼容已有特性的,所以優(yōu)先下載最新分支,分支查看可以參照下圖):

git clone -b release_60 git@github.com:llvm-mirror/llvm.git llvm
git clone -b release_60 git@github.com:llvm-mirror/clang.git llvm/tools/clang
git clone -b release_60 git@github.com:llvm-mirror/clang-tools-extra.git llvm/tools/clang/tools/extra
git clone -b release_60 git@github.com:llvm-mirror/compiler-rt.git llvm/projects/compiler-rt
llvm最新分支.png

編譯源碼

生成 Xcode 工程(也可以直接用命令行編譯,不過大家平時可能看習慣了 Xcode 工程,所以用 Xcode 編譯比較習慣)

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

生成的文件如下:

Xcode工程.png

打開 Xcode 工程,選擇自動創(chuàng)建 Schemes:

自動創(chuàng)建Schemes.png

然后編譯 Clang 和 libClang(可以隨時終止編譯,再次點擊編譯會從上次停止的地方繼續(xù)進行):

編譯Clang和libClang

這里可能需要1個多小時才能完成編譯,如無意外,編譯成功!

編寫你的第一個插件

這個插件實現(xiàn)的功能就是打印語法樹上所有節(jié)點的類名以及父類名,創(chuàng)建 Clang 插件的整體步驟如下圖:

創(chuàng)建插件.png
  1. 首先修改源代碼目錄 /opt/llvm/llvm/tools/clang/tools 下的 CMakeLists.txt 文件,添加一個新的編譯目標,直接在 CMakeLists.txt 的最后面添加上一行,如下圖:


    添加新的編譯目標.png
  2. 然后在 tools 目錄下添加 MyPlugin 文件夾,文件夾里面新增兩個文件 CMakeLists.txt 和 MyPlugin.cpp,這里先不講解具體文件中的內(nèi)容,目的是想讓插件跑起來,看到運行效果。

    CMakeLists.txt 文件如下:

    add_llvm_loadable_module(MyPlugin 
    MyPlugin.cpp
    PLUGIN_TOOL clang
    )
    
    if(LLVM_ENABLE_PLUGINS AND (WIN32 OR CYGWIN))
      target_link_libraries(MyPlugin PRIVATE
        clangAST
        clangBasic
        clangFrontend
        clangLex
        LLVMSupport
        )
    endif()
    

    MyPlugin.cpp 文件如下:

    #include <iostream>
    #include "clang/AST/AST.h"
    #include "clang/AST/ASTConsumer.h"
    #include "clang/AST/RecursiveASTVisitor.h"
    #include "clang/Frontend/CompilerInstance.h"
    #include "clang/Frontend/FrontendPluginRegistry.h"
    using namespace clang;
    using namespace std;
    using namespace llvm;
    namespace MyPlugin
    {
        class MyASTVisitor: public
        RecursiveASTVisitor < MyASTVisitor >
        {
    private:
            ASTContext *context;
    public:
            void setContext(ASTContext &context)
            {
                this->context = &context;
            }
    
            bool VisitDecl(Decl *decl)
            {
                if (isa < ObjCInterfaceDecl > (decl)) {
                    ObjCInterfaceDecl *interDecl = (ObjCInterfaceDecl *)decl;
                    if (interDecl->getSuperClass()) {
                        string interName = interDecl->getNameAsString();
                        string superClassName = interDecl->getSuperClass()->getNameAsString();
    
                        cout << "-------- ClassName:" << interName << " superClassName:" << superClassName << endl;
                    }
                }
    
                return true;
            }
        };
        
        class MyASTConsumer: public ASTConsumer
        {
    private:
            MyASTVisitor visitor;
            void HandleTranslationUnit(ASTContext &context)
            {
                visitor.setContext(context);
                visitor.TraverseDecl(context.getTranslationUnitDecl());
            }
        };
        class MyASTAction: public PluginASTAction
        {
    public:
            unique_ptr < ASTConsumer > CreateASTConsumer(CompilerInstance & Compiler, StringRef InFile) {
                return unique_ptr < MyASTConsumer > (new MyASTConsumer);
            }
            bool ParseArgs(const CompilerInstance &CI, const std::vector < std::string >& args)
            {
                return true;
            }
        };
    }
    static clang::FrontendPluginRegistry::Add
    < MyPlugin::MyASTAction > X("MyPlugin",
                                "MyPlugin desc");
    

再次在 llvm_build 目錄下 CMake 一下

cmake -G Xcode ../llvm -DCMAKE_BUILD_TYPE:STRING=MinSizeRel
  1. 然后重新打開 LLVM.xcodeproj 工程,會發(fā)現(xiàn)多了一個 MyPlugin 的編譯目標,選中進行編譯。
編譯myPlugin.png

編譯成功之后,就可以得到一個 MyPlugin.dylib 的 Clang 插件了~為了方便,我將 MyPlugin.dylib 放在桌面上:

MyPlugin插件.png

使用插件

命令行中使用插件

首先用命令行對單文件測試一下剛剛生成的 Clang 插件是否正確,新建一個測試用文件 test.m 放在桌面,test.m 如下:

#import<UIKit/UIKit.h>
@interface ViewController : UIViewController
@end
@implementation ViewController
- (instancetype)init
{
    if(self = [super init]){
    }
    return self;
}
@end

現(xiàn)在我的 test.m 和 MyPlugin.dylib 都在桌面上了(當然也可以放在不同的目錄下,只要在待會用到這兩個文件的地方指定各自的絕對路徑就行,這里是為了方便敘述)

文件結(jié)構(gòu)

接著命令行 cd 到桌面,然后執(zhí)行以下命令就可以看到結(jié)果了:

/opt/llvm/llvm_build/Debug/bin/clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator11.2.sdk -Xclang -load -Xclang ./MyPlugin.dylib -Xclang -add-plugin -Xclang MyPlugin -c ./test.m

注意:

  1. 我編譯出來的 clang 在 /opt/llvm/llvm_build/Debug/bin/clang 目錄中,如果你與我的路徑不一樣則指定為你對應(yīng)的路徑

  2. 在我寫這篇文章時 Xcode 版本是9.2,對應(yīng)的是 iPhoneSimulator11.2.sdk,你需要進入該目錄查看你的 sdk 版本

如無意外,命令行中會出現(xiàn)一大堆輸出:

命令行輸出

Xcode 中使用插件

接下來講怎么樣在 Xcode 使用我們剛剛編譯出來的插件(隨著 Xcode 變得封閉,插件掛載到 Xcode 上運行在未來的版本中可能會被禁止)。

  1. 首先 hack Xcode,才能使 Xcode 指向我們自己編譯的 Clang:

下載 XcodeHacking.zip 并解壓,里面有 HackedBuildSystem.xcspec 和 HackedClang.xcplugin 兩個文件,這里可能需要修改一下 HackedClang.xcplugin/Contents/Resources/HackedClang.xcspec 文件,將 ExecPath 的值修改為你編譯出來的 Clang 的目錄:

修改HackedClang.xcspec

然后 cd 到解壓的 XcodeHacking 目錄,將這兩個文件用命令行移動到對應(yīng)的目錄下:

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

?

  1. 然后重啟 Xcode,點擊 Target 的 Build Settings,修改 Compiler for C/C++/Objective-C 項為 Clang LLVM Trunk(不進行第1步中 hack Xcode 操作的話是不會有這個選項的)
Complier.png

然后修改 OTHER_CFLAGS 選項:


OTHER_CFLAGS.png
-Xclang -load -Xclang /Users/Vernon/Desktop/MyPlugin.dylib -Xclang -add-plugin -Xclang MyPlugin

注意

  1. 將 /Users/Vernon/Desktop/MyPlugin.dylib 修改為你生成的插件對應(yīng)的目錄
  2. 如果編譯中出現(xiàn)一大堆系統(tǒng)庫的 symbol not found 錯誤的話,可以在上述命令的最后手動指定你的 SDK 目錄,加上這句:-isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator11.2.sdk
  1. 最后編譯你的項目,然后快捷鍵 Command+9 跳到 Show the Report navigator,選中剛剛的編譯報告,注意下圖中每個文件右上角都有可以點擊展開的按鈕,展開后就能看到我們插件的輸出了(下圖4為對應(yīng)輸出)。Nice~


    查看結(jié)果

結(jié)語

文章不長,只是這看似簡單的過程也花了我一個多星期的業(yè)余時間,寫下這個系列文章一是為了記錄自己這鉆研的過程,以后也可查詢,二是希望如果有人能看到這篇拙文可以省下一點時間,更快的踏進 LLVM 和 Clang 的世界探索。

接下來會根據(jù)我的個人需求嘗試給 Clang 添加自定義的 attribute,如果有所心得,會撰文分享,敬請期待~

PS:如果是在 Xcode 10 編譯遇到問題的話可以參考這篇文章:https://github.com/CYBoys/Blogs/blob/master/LLVM_Clang/LLVM%20%26%20Clang%20%E5%85%A5%E9%97%A8.md

PPS:我建了一個 Clang & LLVM 微信交流群,可以交流 Clang 相關(guān)問題、iOS 相關(guān)問題、發(fā)招聘信息,拒絕廣告、拒絕刷屏。想要加入的可以加我微信拉你進群~


微信二維碼
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容