如何用clang analyzer定制静态分析规则（2）创建定制规则库篇

在上一篇《工程配置篇》里，我们已经了解了如何下载llvm和clang的源码，如何生成Xcode工程并完成编译，现在就开始定制自己的静态分析规则。
首先要明确的两点，一是clang自己的build target基本是静态链接的，但我们要做的是独立发布、独立加载的规则库，必须做成动态链接。二是开发静态分析规则，完全依赖clang提供的能力，考虑到开发、调试的方便，规则库工程将被建立在clang工程下。
我们实现的机制是应用了clang plugin机制，可参考 http://clang.llvm.org/docs/ClangPlugins.html 。具体到静态分析规则开发，可以使用更简单的checker plugin，详细原理会在后面阐述，此处暂只先说工程搭建。

1、CMake配置

clang analyzer的源码在

~/projects/analyzer/llvm/tools/clang/lib/StaticAnalyzer

规则库工程就建立在这里。

为了跟其他target保持一致，先创建CMake配置：
target名：clangSquirrelCheckers
规则库包含文件列表：
SuspiciousSizeofChecker.cpp（规则路径：”squirrel.defect.SuspiciousSizeof”）

~/projects/analyzer/llvm/tools/clang/lib/StaticAnalyzer|-- CMakeLists.txt|-- Checkers   |- ......   `- ......|-- Core   |- ......   `- ......|-- Frontend   |- ......   `- ......|-- README.txt`-- SquirrelCheckers   |-- CMakeLists.txt   `-- SuspiciousSizeofChecker.cpp

#~/projects/analyzer/llvm/tools/clang/lib/StaticAnalyzer/SquirrelCheckers/CMakeLists.txtIF (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")    SET(CMAKE_SHARED_LINKER_FLAGS "-undefined dynamic_lookup")ENDIF()add_clang_library(clangSquirrelCheckers    SuspiciousSizeofChecker.cpp    SHARED    )

这里要备注的是，add_clang_library是clang定义的一个宏，在

~/projects/analyzer/llvm/tools/clang/cmake/modules/AddClang.cmake

我们需要创建动态链接的.dylib，所以使用了SHARED。

2、Xcode工程

按照前文《工程配置篇》里的步骤，Xcode工程打开时会多了一个scheme clangSquirrelCheckers。

直接Build，在Debug/lib（根据Build configuration）下就可以得到libclangSquirrelCheckers.dylib

3、使用

clang的plugin可以通过-load ooxx.dylib来加载。之后，便像内置扫描规则一样使用。例如：
可以检查定制规则是否正常加载

clang -cc1 -load ~/projects/analyzer/build/Debug/lib/libclangSquirrelCheckers.dylib -analyzer-checker-help

可以直接用于扫描

clang -cc1 -load ~/projects/analyzer/build/Debug/lib/libclangSquirrelCheckers.dylib -analyze ooxx.cpp

4、源码

本系列文章源码可见 https://github.com/squirrel-explorer/eagleeye-ios 。