使用TscanCode和scan-build进行静态分析

做过iOS开发的都知道Xcode集成的Analyzer可以进行代码静态检查,而且确实可以帮助分析一些潜在的bug。今天就说一说在Linux开发环境下的两款静态分析工具TscanCodescan-build

目前市面上的静态分析工具很多,为什么只拿这两个工具呢?相对于商业软件,它们的性能不是最优的,但却是免费工具中比较出色的。

TscanCode是腾讯出品的开源静态代码扫描工具,scan-build则是LLVM的前端工具Clang所提供的静态分析工具,XcodeAnalyzer就是借助于scan-build来完成静态分析的,作为苹果开源的项目,其质量还是有保证的。

TscanCode

TscanCode是一款静态代码扫描工具,TscanCode旨在助力开发与测试人员从代码层面挖掘问题,将那些长期困扰项目的诸如空指针宕机等问题,扼杀于萌芽阶段。支持用户根据不同需求自定义配置检查项,有极强的扩展性和可维护性。平均扫描速度10W行/分钟。

TscanCode支持以下类型规则扫描:

  1. 空指针检查,包含可疑的空指针,判空后解引用比如Crash等共3类subid检查。
  2. 数据越界,Sprintf_S越界共1类subid检查。
  3. 内存泄漏,分配和释放不匹配同1类subid检查。
  4. 逻辑错误,重复的代码分支,bool类型和INT进行比较,表达式永远True或者false等共18类检查。
  5. 可疑代码检查,if判断中含有可疑的=号,自由变量返回局部变量等共计15类检查。
  6. 运算错误,判断无符号数小于0,对bool类型进行++自增等,共计11类检查。

详细的使用文档在其github仓库中,有专门的用户手册可以查阅。

我们以开源的cgdb为例,用TscanCode来扫描一下这个项目。

  1. 我们将TscanCode工程release/linux_bin目录下Linux平台的可执行文件TscanCode和规则配置文件夹TscanCodeConfig拷贝到cgdb工程的根目录。

  2. cgdb的根目录执行以下命令:

./TscanCode --xml ./ --writefile=./result.xml --configpath=./TscanCodeConfig

参数解析:
--xml:按照xml格式输出结果文件
./ : 需要扫描检查的代码路径,此处为所有文件。
--writefile :结果输出文件
--configpath: 指定配置文件的路径
更多参数可以直接执行TscanCode查看

  1. 执行完毕以后,我们可以打开result.xml看看扫描结果。


    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-ccanalyze-cc作为一个伪编译器,转发命令行参数给gccclang来执行静态分析。

然后执行以下命令,即可开始进行静态分析。

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中进行查看。

result

打开index.html,会有惊喜等着你。因为scan-build是在随着编译过程进行分析,所以其分析结果非常漂亮,和Xcode中的 Analyzer几乎一模一样。

先看看概要


Bug Summary

详细内容可以点击查看


Paste_Image.png

随便挑一个Memory leak看看

Paste_Image.png
Paste_Image.png
Paste_Image.png

详细的出错步骤,是不是很清楚?日常开发中,可以结合两种工具进行分析。

我是咕咕鸡,一个还在不停学习的全栈工程师。
热爱生活,喜欢跑步,家庭是我不断向前进步的动力。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,133评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,682评论 3 390
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,784评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,508评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,603评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,607评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,604评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,359评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,805评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,121评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,280评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,959评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,588评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,206评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,193评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,144评论 2 352

推荐阅读更多精彩内容