代码检查工具Linux下代码检测工具（sparse）的使用

Posted 2022-04-21 Evan_ZGYF丶

获取更多相关的嵌入式开发工具，可收藏系列博文，持续更新中：
【开发工具】嵌入式常用开发工具汇总帖

---

Linux内核源码里其实包含了相应的代码检测工具【sparse】，位置在：

Documentation/dev-tools/sparse.rst

Documentation/translations/zh_CN/sparse.txt

Documentation/dev-tools/sparse.rst 的中文翻译

以下为正文

---------------------------------------------------------------------

使用 sparse 工具做类型检查

~~~~~~~~~~~~~~~~~~~~~~~~~~

"__bitwise" 是一种类型属性，所以你应该这样使用它：

typedef int __bitwise pm_request_t;

enum pm_request 
        PM_SUSPEND = (__force pm_request_t) 1,
        PM_RESUME = (__force pm_request_t) 2
;

这样会使 PM_SUSPEND 和 PM_RESUME 成为位方式(bitwise)整数（使用"__force"

是因为 sparse 会抱怨改变位方式的类型转换，但是这里我们确实需要强制进行转

换）。而且因为所有枚举值都使用了相同的类型，这里的"enum pm_request"也将

会使用那个类型做为底层实现。

而且使用 gcc 编译的时候，所有的 __bitwise/__force 都会消失，最后在 gcc

看来它们只不过是普通的整数。

坦白来说，你并不需要使用枚举类型。上面那些实际都可以浓缩成一个特殊的"int

__bitwise"类型。

所以更简单的办法只要这样做：

typedef int __bitwise pm_request_t;

#define PM_SUSPEND ((__force pm_request_t) 1)
#define PM_RESUME ((__force pm_request_t) 2)

现在你就有了严格的类型检查所需要的所有基础架构。

一个小提醒：常数整数"0"是特殊的。你可以直接把常数零当作位方式整数使用而

不用担心 sparse 会抱怨。这是因为"bitwise"（恰如其名）是用来确保不同位方

式类型不会被弄混（小尾模式，大尾模式，cpu尾模式，或者其他），对他们来说

常数"0"确实是特殊的。

获取 sparse 工具

~~~~~~~~~~~~~~~~

你可以从 Sparse 的主页获取最新的发布版本：

http://www.kernel.org/pub/linux/kernel/people/josh/sparse/

或者，你也可以使用 git 克隆最新的 sparse 开发版本：

git://git.kernel.org/pub/scm/linux/kernel/git/josh/sparse.git

DaveJ 把每小时自动生成的 git 源码树 tar 包放在以下地址：

http://www.codemonkey.org.uk/projects/git-snapshots/sparse/

一旦你下载了源码，只要以普通用户身份运行：

make

make install

它将会被自动安装到你的 ~/bin 目录下。

使用 sparse 工具

~~~~~~~~~~~~~~~~

用"make C=1"命令来编译内核，会对所有重新编译的 C 文件使用 sparse 工具。

或者使用"make C=2"命令，无论文件是否被重新编译都会对其使用 sparse 工具。

如果你已经编译了内核，用后一种方式可以很快地检查整个源码树。

make 的可选变量 CHECKFLAGS 可以用来向 sparse 工具传递参数。编译系统会自

动向 sparse 工具传递 -Wbitwise 参数。

或者使用sparse工具编译普通的代码：

root@ubuntu:~# gcc test.c
root@ubuntu:~# 
root@ubuntu:~# sparse test.c
test.c:35:6: warning: symbol 'run' was not declared. Should it be static?
test.c:35:6: warning: context imbalance in 'run' - wrong count at exit