yangdw@Kody LLVM % clang -ccc-print-phases main.m
+- 0: input, "main.m", objective-c
+- 1: preprocessor, {0}, objective-c-cpp-output
+- 2: compiler, {1}, ir
+- 3: backend, {2}, assembler
+- 4: assembler, {3}, object
+- 5: linker, {4}, image
6: bind-arch, "x86_64", {5}, image
int test(int a,int b){
return a + b + 3;
}
int main(int argc, const char * argv[]) {
@autoreleasepool {
int a = test(1, 2);
printf("%d",a);
}
return 0;
}
# 9 "main.m" 2
int test(int a,int b){
return a + b + 3;
}
int main(int argc, const char * argv[]) {
@autoreleasepool {
int a = test(1, 2);
printf("%d",a);
}
return 0;
}
clang -fmodules -fsyntax-only -Xclang -dump-tokens main.m
yangdw@Kody LLVM % clang -fmodules -fsyntax-only -Xclang -dump-tokens main.m
annot_module_include '#import <Foundation/Foundation.h>
int test(int a,int b){
return a + b + 3;
}
int main(int argc, con' Loc=<main.m:8:1>
int 'int' [StartOfLine] Loc=<main.m:10:1>
identifier 'test' [LeadingSpace] Loc=<main.m:10:5>
l_paren '(' Loc=<main.m:10:9>
int 'int' Loc=<main.m:10:10>
identifier 'a' [LeadingSpace] Loc=<main.m:10:14>
comma ',' Loc=<main.m:10:15>
int 'int' Loc=<main.m:10:16>
identifier 'b' [LeadingSpace] Loc=<main.m:10:20>
r_paren ')' Loc=<main.m:10:21>
l_brace '{' Loc=<main.m:10:22>
return 'return' [StartOfLine] [LeadingSpace] Loc=<main.m:11:5>
identifier 'a' [LeadingSpace] Loc=<main.m:11:12>
plus '+' [LeadingSpace] Loc=<main.m:11:14>
identifier 'b' [LeadingSpace] Loc=<main.m:11:16>
plus '+' [LeadingSpace] Loc=<main.m:11:18>
numeric_constant '3' [LeadingSpace] Loc=<main.m:11:20>
clang -isysroot (自己SDK路径) -fmodules -fsyntax-only -Xclang -dump-tokens main.m
clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.1.sdk/ -fmodules -fsyntax-only -Xclang -dump-tokens main.m
clang -fmodules -fsyntax-only -Xclang -ast-dump main.m
clang -isysroot (自己SDK路径) -fmodules -fsyntax-only -Xclang -ast-dump main.m
clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.1.sdk/ -fmodules -fsyntax-only -Xclang -ast-dump main.m
clang -S -fobjc-arc -emit-llvm main.m
clang -Os -S -fobjc-arc -emit-llvm main.m -o main.ll
clang -emit-llvm -c main.ll -o main.bc
clang -S -fobjc-arc main.bc -o main.s
clang -S -fobjc-arc main.ll -o main.s
clang -Os -S -fobjc-arc main.m -o main.s
yangdw@Kody LLVM % clang -emit-llvm -c main.ll -o main.bc
yangdw@Kody LLVM % clang -S -fobjc-arc main.bc -o main.s
yangdw@Kody LLVM % clang -Os -S -fobjc-arc main.m -o main.s
yangdw@Kody LLVM % file main.s
main.s: assembler source text, ASCII text
clang -fmodules -c main.s -o main.o
$xcrun nm -nm main.o
yangdw@Kody LLVM % clang -fmodules -c main.s -o main.o
yangdw@Kody LLVM % $xcrun nm -nm main.o
(undefined) external _objc_autoreleasePoolPop
(undefined) external _objc_autoreleasePoolPush
(undefined) external _printf
0000000000000000 (__TEXT,__text) external _test
000000000000000a (__TEXT,__text) external _main
yangdw@Kody LLVM % file main.o
main.o: Mach-O 64-bit object x86_64
clang main.o -o main
$xcrun nm -nm main
clang main.o -o main
$xcrun nm -nm main
(undefined) external _printf(from libSystem)
(undefined) external dyld_stub_binder(from libSystem)
0000000100000000 (__TEXT,__text)[referenced dynamically] external __execute_header
0000000100003f20 (__TEXT,__text) external _test
0000000100003f40 (__TEXT,__text) external _main
0000000100008008 (__DATA,__data) non_external _dyld_private
yangdw@Kody LLVM % file main
main:Mach-O 64-bit executable x86_64
绑定主要是通过不同的架构,生成对应的mach-o格式可执行文件
git clone https://github.com/llvm/llvm-project.git
或者
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/llvm.git
cd llvm/tools
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/clang.git
cd ../projects
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/compiler-rt.g
it
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/libcxx.git
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/libcxxabi.git
cd ../tools/clang/tools
git clone https://mirrors.tuna.tsinghua.edu.cn/git/llvm/clang-tools-extra.git
由于最新的 LLVM 只支持 cmake 来编译,所以需要安装 cmake。
brew list
brew install cmake
// 在llvm同级目录下新建一个build_xcode文件
mkdir build_xcode
cd build_xcode
// 编译llvm
cmake -G Xcode ../llvm
CMake Error: Error: generator : Xcode
Does not match the generator used previously: Ninja
Either remove the CMakeCache.txt file and CMakeFiles directory or choose a different binary directory.
brew install ninja
cd llvm_build
// -DCMAKE_INSTALL_PREFIX 指定 LLVM 的安装路径,注意:DCMAKE_INSTALL_PREFIX后面不能有空格
cmake -G Ninja ../llvm -DCMAKE_INSTALL_PREFIX= 安装路径(本机为/ Users/xxx/xxx/LLVM/llvm_release)
ninja
ninja install
// 通过终端在YDWPlugin目录下创建
touch YDWPlugin.cpp
touch CMakeLists.txt
// CMakeLists.txt中添加以下代码
add_llvm_library(YDWPlugin MODULE BUILDTREE_ONLY
YDWPlugin.cpp
)
cmake -G Xcode ../llvm
// create by YDW
// 2020/11/25
#include
#include "clang/AST/AST.h"
#include "clang/AST/DeclObjC.h"
#include "clang/AST/ASTConsumer.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Frontend/CompilerInstance.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/Frontend/FrontendPluginRegistry.h"
using namespace clang;
using namespace std;
using namespace llvm;
using namespace clang::ast_matchers;
//命名空间,和插件同名
namespace YDWPlugin {
//第三步:扫描完毕的回调函数
//4、自定义回调类,继承自MatchCallback
class YDWMatchCallback: public MatchFinder::MatchCallback {
private:
//CI传递路径:YDWASTAction类中的CreateASTConsumer方法参数 - YDWConsumer的构造函数 - YDWMatchCallback的私有属性,通过构造函数从YDWASTConsumer构造函数中获取
CompilerInstance &CI;
//判断是否是用户源文件
bool isUserSourceCode(const string filename) {
//文件名不为空
if (filename.empty()) return false;
//非xcode中的源码都认为是用户的
if (filename.find("/Applications/Xcode.app/") == 0) return false;
return true;
}
//判断是否应该用copy修饰
bool isShouldUseCopy(const string typeStr) {
//判断类型是否是NSString | NSArray | NSDictionary
if (typeStr.find("NSString") != string::npos ||
typeStr.find("NSArray") != string::npos ||
typeStr.find("NSDictionary") != string::npos/*...*/)
{
return true;
}
return false;
}
public:
YDWMatchCallback(CompilerInstance &CI) :CI(CI) {}
//重写run方法
void run(const MatchFinder::MatchResult &Result) {
//通过result获取到相关节点 -- 根据节点标记获取(标记需要与YDWASTConsumer构造方法中一致)
const ObjCPropertyDecl *propertyDecl = Result.Nodes.getNodeAs<ObjCPropertyDecl>("objcPropertyDecl");
//判断节点有值,并且是用户文件
if (propertyDecl && isUserSourceCode(CI.getSourceManager().getFilename(propertyDecl->getSourceRange().getBegin()).str()) ) {
//15、获取节点的描述信息
ObjCPropertyDecl::PropertyAttributeKind attrKind = propertyDecl->getPropertyAttributes();
//获取节点的类型,并转成字符串
string typeStr = propertyDecl->getType().getAsString();
// cout<<"---------拿到了:"<
//判断应该使用copy,但是没有使用copy
if (propertyDecl->getTypeSourceInfo() && isShouldUseCopy(typeStr) && !(attrKind & ObjCPropertyDecl::OBJC_PR_copy)) {
//使用CI发警告信息
//通过CI获取诊断引擎
DiagnosticsEngine &diag = CI.getDiagnostics();
//通过诊断引擎 report报告 错误,即抛出异常
/*
错误位置:getBeginLoc 节点开始位置
错误:getCustomDiagID(等级,提示)
*/
diag.Report(propertyDecl->getBeginLoc(), diag.getCustomDiagID(DiagnosticsEngine::Warning, "%0 - 这个地方推荐使用copy!!"))<< typeStr;
}
}
}
};
//第二步:扫描配置完毕
//3、自定义YDWASTConsumer,继承自ASTConsumer,用于监听AST节点的信息 -- 过滤器
class YDWASTConsumer: public ASTConsumer {
private:
//AST节点的查找过滤器
MatchFinder matcher;
//定义回调类对象
YDWMatchCallback callback;
public:
//构造方法中创建matcherFinder对象
YDWASTConsumer(CompilerInstance &CI) : callback(CI) {
//添加一个MatchFinder,每个objcPropertyDecl节点绑定一个objcPropertyDecl标识(去匹配objcPropertyDecl节点)
//回调callback,其实是在YDWMatchCallback里面重写run方法(真正回调的是回调run方法)
matcher.addMatcher(objcPropertyDecl().bind("objcPropertyDecl"), &callback);
}
//实现两个回调方法 HandleTopLevelDecl 和 HandleTranslationUnit
//解析完一个顶级的声明,就回调一次(顶级节点,相当于一个全局变量、函数声明)
bool HandleTopLevelDecl(DeclGroupRef D){
// cout<<"正在解析..."<
return true;
}
//整个文件都解析完成的回调
void HandleTranslationUnit(ASTContext &context) {
// cout<<"文件解析完毕!"<
//将文件解析完毕后的上下文context(即AST语法树) 给 matcher
matcher.matchAST(context);
}
};
//2、继承PluginASTAction,实现我们自定义的Action,即自定义AST语法树行为
class YDWASTAction: public PluginASTAction {
public:
//重载ParseArgs 和 CreateASTConsumer方法
bool ParseArgs(const CompilerInstance &ci, const std::vector<std::string> &args) {
return true;
}
//返回ASTConsumer类型对象,其中ASTConsumer是一个抽象类,即基类
/*
解析给定的插件命令行参数。
- param CI 编译器实例,用于报告诊断。
- return 如果解析成功,则为true;否则,插件将被销毁,并且不执行任何操作。该插件负责使用CompilerInstance的Diagnostic对象报告错误。
*/
unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, StringRef iFile) {
//返回自定义的YDWASTConsumer,即ASTConsumer的子类对象
/*
CI用于:
- 判断文件是否使用户的
- 抛出警告
*/
return unique_ptr<YDWASTConsumer> (new YDWASTConsumer(CI));
}
};
}
// 第一步:注册插件,并自定义AST语法树Action类
// 1、注册插件
static FrontendPluginRegistry::Add<YDWPlugin::YDWASTAction> YDW("YDWPlugin", "This is YDWPlugin");
// 命令格式
自己编译的clang文件路径 -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.1.sdk/ -Xclang -load -Xclang 插件(.dyld)路径 -Xclang -add-plugin -Xclang 插件名 -c 源码路径
// 举例
/Users/XXX/Desktop/build_xcode/Debug/bin/clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.1.sdk/ -Xclang -load -Xclang /Users/XXXX/Desktop/build_xcode/Debug/lib/YDWPlugin.dylib -Xclang -add-plugin -Xclang YDWPlugin -c /Users/XXXX/Desktop/XXX/XXXX/测试demo/testClang/testClang/ViewController.m
/Users/XXX/Desktop/build_xcode/Debug/bin/clang -isysroot /Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator14.1.sdk/ -Xclang -load -Xclang /Users/XXXX/Desktop/build_xcode/Debug/lib/YDWPlugin.dylib -Xclang -add-plugin -Xclang YDWPlugin -c /Users/XXXX/Desktop/XXX/XXXX/测试demo/testClang/testClang/ViewController.m
...
Controller.m:12: Warning:
------- NSString* 没用 copy 修饰 --------
@property (nonatomic, strong) NSString *name;
------- NSArray* 没用 copy 修饰 --------
@property (nonatomic, strong) NSArray *list;
...
-Xclang -load -Xclang (.dylib)动态库路径 -Xclang -add-plugin -Xclang YDWPlugin