1f5a46e9dSYanteng SiCopyright 2004 Linus Torvalds 2a2531293SPavel MachekCopyright 2004 Pavel Machek <pavel@ucw.cz> 322033d38SLi YangCopyright 2006 Bob Copeland <me@bobcopeland.com> 422033d38SLi Yang 5f5a46e9dSYanteng Si.. include:: ../disclaimer-zh_CN.rst 6f5a46e9dSYanteng Si 7f5a46e9dSYanteng Si:Original: Documentation/dev-tools/sparse.rst 8f5a46e9dSYanteng Si 9f5a46e9dSYanteng Si:翻译: 10f5a46e9dSYanteng Si 11f5a46e9dSYanteng Si Li Yang <leoyang.li@nxp.com> 12f5a46e9dSYanteng Si 13f5a46e9dSYanteng Si:校译: 14f5a46e9dSYanteng Si 15f5a46e9dSYanteng Si 司延腾 Yanteng Si <siyanteng@loongson.cn> 16f5a46e9dSYanteng Si 17f5a46e9dSYanteng Si.. _cn_sparse: 18f5a46e9dSYanteng Si 19f5a46e9dSYanteng SiSparse 20f5a46e9dSYanteng Si====== 21f5a46e9dSYanteng Si 22f5a46e9dSYanteng SiSparse是一个C程序的语义检查器；它可以用来发现内核代码的一些潜在问题。 关 23f5a46e9dSYanteng Si于sparse的概述，请参见https://lwn.net/Articles/689907/；本文档包含 24f5a46e9dSYanteng Si一些针对内核的sparse信息。 25f5a46e9dSYanteng Si关于sparse的更多信息，主要是关于它的内部结构，可以在它的官方网页上找到： 26f5a46e9dSYanteng Sihttps://sparse.docs.kernel.org。 27f5a46e9dSYanteng Si 2822033d38SLi Yang使用 sparse 工具做类型检查 2922033d38SLi Yang~~~~~~~~~~~~~~~~~~~~~~~~~~ 3022033d38SLi Yang 31f5a46e9dSYanteng Si"__bitwise" 是一种类型属性，所以你应该这样使用它:: 3222033d38SLi Yang 3322033d38SLi Yang typedef int __bitwise pm_request_t; 3422033d38SLi Yang 3522033d38SLi Yang enum pm_request { 3622033d38SLi Yang PM_SUSPEND = (__force pm_request_t) 1, 3722033d38SLi Yang PM_RESUME = (__force pm_request_t) 2 3822033d38SLi Yang }; 3922033d38SLi Yang 4022033d38SLi Yang这样会使 PM_SUSPEND 和 PM_RESUME 成为位方式(bitwise)整数（使用"__force" 4122033d38SLi Yang是因为 sparse 会抱怨改变位方式的类型转换，但是这里我们确实需要强制进行转 4222033d38SLi Yang换）。而且因为所有枚举值都使用了相同的类型，这里的"enum pm_request"也将 4322033d38SLi Yang会使用那个类型做为底层实现。 4422033d38SLi Yang 4522033d38SLi Yang而且使用 gcc 编译的时候，所有的 __bitwise/__force 都会消失，最后在 gcc 4622033d38SLi Yang看来它们只不过是普通的整数。 4722033d38SLi Yang 4822033d38SLi Yang坦白来说，你并不需要使用枚举类型。上面那些实际都可以浓缩成一个特殊的"int 4922033d38SLi Yang__bitwise"类型。 5022033d38SLi Yang 51f5a46e9dSYanteng Si所以更简单的办法只要这样做:: 5222033d38SLi Yang 5322033d38SLi Yang typedef int __bitwise pm_request_t; 5422033d38SLi Yang 5522033d38SLi Yang #define PM_SUSPEND ((__force pm_request_t) 1) 5622033d38SLi Yang #define PM_RESUME ((__force pm_request_t) 2) 5722033d38SLi Yang 5822033d38SLi Yang现在你就有了严格的类型检查所需要的所有基础架构。 5922033d38SLi Yang 6022033d38SLi Yang一个小提醒：常数整数"0"是特殊的。你可以直接把常数零当作位方式整数使用而 6122033d38SLi Yang不用担心 sparse 会抱怨。这是因为"bitwise"（恰如其名）是用来确保不同位方 6222033d38SLi Yang式类型不会被弄混（小尾模式，大尾模式，cpu尾模式，或者其他），对他们来说 63f5a46e9dSYanteng Si常数"0"确实 **是** 特殊的。 64f5a46e9dSYanteng Si 65f5a46e9dSYanteng Si使用sparse进行锁检查 66f5a46e9dSYanteng Si-------------------- 67f5a46e9dSYanteng Si 68f5a46e9dSYanteng Si下面的宏对于 gcc 来说是未定义的，在 sparse 运行时定义，以使用sparse的“上下文” 69f5a46e9dSYanteng Si跟踪功能，应用于锁定。 这些注释告诉 sparse 什么时候有锁，以及注释的函数的进入和 70f5a46e9dSYanteng Si退出。 71f5a46e9dSYanteng Si 72f5a46e9dSYanteng Si__must_hold - 指定的锁在函数进入和退出时被持有。 73f5a46e9dSYanteng Si 74f5a46e9dSYanteng Si__acquires - 指定的锁在函数退出时被持有，但在进入时不被持有。 75f5a46e9dSYanteng Si 76f5a46e9dSYanteng Si__releases - 指定的锁在函数进入时被持有，但在退出时不被持有。 77f5a46e9dSYanteng Si 78f5a46e9dSYanteng Si如果函数在不持有锁的情况下进入和退出，在函数内部以平衡的方式获取和释放锁，则不 79f5a46e9dSYanteng Si需要注释。 80f5a46e9dSYanteng Si上面的三个注释是针对sparse否则会报告上下文不平衡的情况。 8122033d38SLi Yang 8222033d38SLi Yang获取 sparse 工具 8322033d38SLi Yang~~~~~~~~~~~~~~~~ 8422033d38SLi Yang 8522033d38SLi Yang你可以从 Sparse 的主页获取最新的发布版本： 8622033d38SLi Yang 87f5a46e9dSYanteng Si https://www.kernel.org/pub/software/devel/sparse/dist/ 8822033d38SLi Yang 8922033d38SLi Yang或者，你也可以使用 git 克隆最新的 sparse 开发版本： 9022033d38SLi Yang 91f5a46e9dSYanteng Si git://git.kernel.org/pub/scm/devel/sparse/sparse.git 9222033d38SLi Yang 9322033d38SLi Yang一旦你下载了源码，只要以普通用户身份运行： 9422033d38SLi Yang 9522033d38SLi Yang make 9622033d38SLi Yang make install 9722033d38SLi Yang 98f5a46e9dSYanteng Si如果是标准的用户，它将会被自动安装到你的~/bin目录下。 9922033d38SLi Yang 10022033d38SLi Yang使用 sparse 工具 10122033d38SLi Yang~~~~~~~~~~~~~~~~ 10222033d38SLi Yang 10322033d38SLi Yang用"make C=1"命令来编译内核，会对所有重新编译的 C 文件使用 sparse 工具。 10422033d38SLi Yang或者使用"make C=2"命令，无论文件是否被重新编译都会对其使用 sparse 工具。 10522033d38SLi Yang如果你已经编译了内核，用后一种方式可以很快地检查整个源码树。 10622033d38SLi Yang 10722033d38SLi Yangmake 的可选变量 CHECKFLAGS 可以用来向 sparse 工具传递参数。编译系统会自 108dc67a9f7SMichael S. Tsirkin动向 sparse 工具传递 -Wbitwise 参数。 109*6a5057e9SYanteng Si 110*6a5057e9SYanteng Si注意sparse定义了__CHECKER__预处理器符号。