sparse.rst (3891B)
1Copyright 2004 Linus Torvalds 2Copyright 2004 Pavel Machek <pavel@ucw.cz> 3Copyright 2006 Bob Copeland <me@bobcopeland.com> 4 5.. include:: ../disclaimer-zh_CN.rst 6 7:Original: Documentation/dev-tools/sparse.rst 8 9:翻译: 10 11 Li Yang <leoyang.li@nxp.com> 12 13:校译: 14 15 司延腾 Yanteng Si <siyanteng@loongson.cn> 16 17.. _cn_sparse: 18 19Sparse 20====== 21 22Sparse是一个C程序的语义检查器；它可以用来发现内核代码的一些潜在问题。 关 23于sparse的概述，请参见https://lwn.net/Articles/689907/；本文档包含 24一些针对内核的sparse信息。 25关于sparse的更多信息，主要是关于它的内部结构，可以在它的官方网页上找到： 26https://sparse.docs.kernel.org。 27 28使用 sparse 工具做类型检查 29~~~~~~~~~~~~~~~~~~~~~~~~~~ 30 31"__bitwise" 是一种类型属性，所以你应该这样使用它:: 32 33 typedef int __bitwise pm_request_t; 34 35 enum pm_request { 36 PM_SUSPEND = (__force pm_request_t) 1, 37 PM_RESUME = (__force pm_request_t) 2 38 }; 39 40这样会使 PM_SUSPEND 和 PM_RESUME 成为位方式(bitwise)整数（使用"__force" 41是因为 sparse 会抱怨改变位方式的类型转换，但是这里我们确实需要强制进行转 42换）。而且因为所有枚举值都使用了相同的类型，这里的"enum pm_request"也将 43会使用那个类型做为底层实现。 44 45而且使用 gcc 编译的时候，所有的 __bitwise/__force 都会消失，最后在 gcc 46看来它们只不过是普通的整数。 47 48坦白来说，你并不需要使用枚举类型。上面那些实际都可以浓缩成一个特殊的"int 49__bitwise"类型。 50 51所以更简单的办法只要这样做:: 52 53 typedef int __bitwise pm_request_t; 54 55 #define PM_SUSPEND ((__force pm_request_t) 1) 56 #define PM_RESUME ((__force pm_request_t) 2) 57 58现在你就有了严格的类型检查所需要的所有基础架构。 59 60一个小提醒：常数整数"0"是特殊的。你可以直接把常数零当作位方式整数使用而 61不用担心 sparse 会抱怨。这是因为"bitwise"（恰如其名）是用来确保不同位方 62式类型不会被弄混（小尾模式，大尾模式，cpu尾模式，或者其他），对他们来说 63常数"0"确实 **是** 特殊的。 64 65使用sparse进行锁检查 66-------------------- 67 68下面的宏对于 gcc 来说是未定义的，在 sparse 运行时定义，以使用sparse的“上下文” 69跟踪功能，应用于锁定。 这些注释告诉 sparse 什么时候有锁，以及注释的函数的进入和 70退出。 71 72__must_hold - 指定的锁在函数进入和退出时被持有。 73 74__acquires - 指定的锁在函数退出时被持有，但在进入时不被持有。 75 76__releases - 指定的锁在函数进入时被持有，但在退出时不被持有。 77 78如果函数在不持有锁的情况下进入和退出，在函数内部以平衡的方式获取和释放锁，则不 79需要注释。 80上面的三个注释是针对sparse否则会报告上下文不平衡的情况。 81 82获取 sparse 工具 83~~~~~~~~~~~~~~~~ 84 85你可以从 Sparse 的主页获取最新的发布版本： 86 87 https://www.kernel.org/pub/software/devel/sparse/dist/ 88 89或者，你也可以使用 git 克隆最新的 sparse 开发版本： 90 91 git://git.kernel.org/pub/scm/devel/sparse/sparse.git 92 93一旦你下载了源码，只要以普通用户身份运行： 94 95 make 96 make install 97 98如果是标准的用户，它将会被自动安装到你的~/bin目录下。 99 100使用 sparse 工具 101~~~~~~~~~~~~~~~~ 102 103用"make C=1"命令来编译内核，会对所有重新编译的 C 文件使用 sparse 工具。 104或者使用"make C=2"命令，无论文件是否被重新编译都会对其使用 sparse 工具。 105如果你已经编译了内核，用后一种方式可以很快地检查整个源码树。 106 107make 的可选变量 CHECKFLAGS 可以用来向 sparse 工具传递参数。编译系统会自 108动向 sparse 工具传递 -Wbitwise 参数。