做过iOS
开发的都知道Xcode
集成的Analyzer
可以进行代码静态检查,而且确实可以帮助分析一些潜在的bug。今天就说一说在Linux开发环境下的两款静态分析工具TscanCode
和scan-build
。
目前市面上的静态分析工具很多,为什么只拿这两个工具呢?相对于商业软件,它们的性能不是最优的,但却是免费工具中比较出色的。
TscanCode
是腾讯出品的开源静态代码扫描工具,scan-build
则是LLVM
的前端工具Clang
所提供的静态分析工具,Xcode
的Analyzer
就是借助于scan-build
来完成静态分析的,作为苹果开源的项目,其质量还是有保证的。
TscanCode
TscanCode是一款静态代码扫描工具,TscanCode旨在助力开发与测试人员从代码层面挖掘问题,将那些长期困扰项目的诸如空指针宕机等问题,扼杀于萌芽阶段。支持用户根据不同需求自定义配置检查项,有极强的扩展性和可维护性。平均扫描速度10W行/分钟。
TscanCode支持以下类型规则扫描:
- 空指针检查,包含可疑的空指针,判空后解引用比如Crash等共3类subid检查。
- 数据越界,Sprintf_S越界共1类subid检查。
- 内存泄漏,分配和释放不匹配同1类subid检查。
- 逻辑错误,重复的代码分支,bool类型和INT进行比较,表达式永远True或者false等共18类检查。
- 可疑代码检查,if判断中含有可疑的=号,自由变量返回局部变量等共计15类检查。
- 运算错误,判断无符号数小于0,对bool类型进行++自增等,共计11类检查。
详细的使用文档在其github仓库中,有专门的用户手册可以查阅。
我们以开源的cgdb为例,用TscanCode
来扫描一下这个项目。
我们将
TscanCode
工程release/linux_bin
目录下Linux平台的可执行文件TscanCode
和规则配置文件夹TscanCodeConfig
拷贝到cgdb
工程的根目录。在
cgdb
的根目录执行以下命令:
./TscanCode --xml ./ --writefile=./result.xml --configpath=./TscanCodeConfig
参数解析:
--xml:按照xml格式输出结果文件
./ : 需要扫描检查的代码路径,此处为所有文件。
--writefile :结果输出文件
--configpath: 指定配置文件的路径
更多参数可以直接执行TscanCode查看
-
执行完毕以后,我们可以打开result.xml看看扫描结果。
可以看出来,还是扫描出不少潜在漏洞的。
scan-build
Scan-build 是一个命令行工具,它能够帮助使用者运行静态分析器检查他们的代码, 找出代码的缺陷。
当一个项目在构建中,源文件在编译时同时也被静态分析器有序的检查着。当构建完成时,结构将会作为一个web网页的形式呈现给使用者。
你如何编写代码与scan-build是没有任何关系的。通过重写cc和cxx环境变量来改变你的编译环境,scan-build可以使用一个伪编译器代替原来那个可以正常构建你的项目的编译器。默认情况下,这个伪编译器使用gcc来编译你的代码,然后执行静态分析器进行代码分析。
scan-build的基本使用方式很简单,只需在你的命令行开头输入scan-build即可。详细参数如下:
[root@localhost cgdb]# scan-build
usage: scan-build [-h] [--verbose] [--override-compiler] [--use-cc <path>]
[--use-c++ <path>] [--intercept-first] [--status-bugs]
[--exclude <directory>] [--output <path>] [--keep-empty]
[--html-title <title>] [--plist | --plist-html]
[--use-analyzer <path>] [--no-failure-reports]
[--analyze-headers] [--stats] [--internal-stats]
[--maxloop <loop count>] [--store <model>]
[--constraints <model>] [--analyzer-config <options>]
[--force-analyze-debug-code]
[--load-plugin <plugin library>]
[--enable-checker <checker name>]
[--disable-checker <checker name>] [--help-checkers]
[--help-checkers-verbose]
...
scan-build: error: missing build command
对于那些需用通过configure
命令生成Makefile
的工程来说,需要先执行以下命令:
scan-build ./configure
这个配置脚本需要在scan-build
中运行是因为scan-build
能通过介入到编译器来扫描你的源文件。scan-build
将编译器gcc设置为analyze-cc
。analyze-cc
作为一个伪编译器,转发命令行参数给gcc
和clang
来执行静态分析。
然后执行以下命令,即可开始进行静态分析。
scan-build make
还是用cgdb
来进行测试,因为需要通过configure
生成Makefile
,所以执行以下命令:
sh autogen.sh
scan-build -o cgdb-scan ./configure --prefix=$PWD/build
scan-build -o cgdb-scan make
执行完毕,提示到cgdb-scan
目录下查看结果。我将结果拷贝到Windows中进行查看。
打开index.html,会有惊喜等着你。因为scan-build
是在随着编译过程进行分析,所以其分析结果非常漂亮,和Xcode
中的 Analyzer
几乎一模一样。
先看看概要
详细内容可以点击查看
随便挑一个Memory leak看看
详细的出错步骤,是不是很清楚?日常开发中,可以结合两种工具进行分析。
我是咕咕鸡,一个还在不停学习的全栈工程师。
热爱生活,喜欢跑步,家庭是我不断向前进步的动力。