0001 Copyright 2004 Linus Torvalds
0002 Copyright 2004 Pavel Machek <pavel@ucw.cz>
0003 Copyright 2006 Bob Copeland <me@bobcopeland.com>
0004
0005 .. include:: ../disclaimer-zh_CN.rst
0006
0007 :Original: Documentation/dev-tools/sparse.rst
0008
0009 :翻译:
0010
0011 Li Yang <leoyang.li@nxp.com>
0012
0013 :校译:
0014
0015 司延腾 Yanteng Si <siyanteng@loongson.cn>
0016
0017 .. _cn_sparse:
0018
0019 Sparse
0020 ======
0021
0022 Sparse是一个C程序的语义检查器；它可以用来发现内核代码的一些潜在问题。 关
0023 于sparse的概述，请参见https://lwn.net/Articles/689907/；本文档包含
0024 一些针对内核的sparse信息。
0025 关于sparse的更多信息，主要是关于它的内部结构，可以在它的官方网页上找到：
0026 https://sparse.docs.kernel.org。
0027
0028 使用 sparse 工具做类型检查
0029 ~~~~~~~~~~~~~~~~~~~~~~~~~~
0030
0031 "__bitwise" 是一种类型属性，所以你应该这样使用它::
0032
0033 typedef int __bitwise pm_request_t;
0034
0035 enum pm_request {
0036 PM_SUSPEND = (__force pm_request_t) 1,
0037 PM_RESUME = (__force pm_request_t) 2
0038 };
0039
0040 这样会使 PM_SUSPEND 和 PM_RESUME 成为位方式(bitwise)整数（使用"__force"
0041 是因为 sparse 会抱怨改变位方式的类型转换，但是这里我们确实需要强制进行转
0042 换）。而且因为所有枚举值都使用了相同的类型，这里的"enum pm_request"也将
0043 会使用那个类型做为底层实现。
0044
0045 而且使用 gcc 编译的时候，所有的 __bitwise/__force 都会消失，最后在 gcc
0046 看来它们只不过是普通的整数。
0047
0048 坦白来说，你并不需要使用枚举类型。上面那些实际都可以浓缩成一个特殊的"int
0049 __bitwise"类型。
0050
0051 所以更简单的办法只要这样做::
0052
0053 typedef int __bitwise pm_request_t;
0054
0055 #define PM_SUSPEND ((__force pm_request_t) 1)
0056 #define PM_RESUME ((__force pm_request_t) 2)
0057
0058 现在你就有了严格的类型检查所需要的所有基础架构。
0059
0060 一个小提醒：常数整数"0"是特殊的。你可以直接把常数零当作位方式整数使用而
0061 不用担心 sparse 会抱怨。这是因为"bitwise"（恰如其名）是用来确保不同位方
0062 式类型不会被弄混（小尾模式，大尾模式，cpu尾模式，或者其他），对他们来说
0063 常数"0"确实 **是** 特殊的。
0064
0065 使用sparse进行锁检查
0066 --------------------
0067
0068 下面的宏对于 gcc 来说是未定义的，在 sparse 运行时定义，以使用sparse的“上下文”
0069 跟踪功能，应用于锁定。 这些注释告诉 sparse 什么时候有锁，以及注释的函数的进入和
0070 退出。
0071
0072 __must_hold - 指定的锁在函数进入和退出时被持有。
0073
0074 __acquires - 指定的锁在函数退出时被持有，但在进入时不被持有。
0075
0076 __releases - 指定的锁在函数进入时被持有，但在退出时不被持有。
0077
0078 如果函数在不持有锁的情况下进入和退出，在函数内部以平衡的方式获取和释放锁，则不
0079 需要注释。
0080 上面的三个注释是针对sparse否则会报告上下文不平衡的情况。
0081
0082 获取 sparse 工具
0083 ~~~~~~~~~~~~~~~~
0084
0085 你可以从 Sparse 的主页获取最新的发布版本：
0086
0087 https://www.kernel.org/pub/software/devel/sparse/dist/
0088
0089 或者，你也可以使用 git 克隆最新的 sparse 开发版本：
0090
0091 git://git.kernel.org/pub/scm/devel/sparse/sparse.git
0092
0093 一旦你下载了源码，只要以普通用户身份运行：
0094
0095 make
0096 make install
0097
0098 如果是标准的用户，它将会被自动安装到你的~/bin目录下。
0099
0100 使用 sparse 工具
0101 ~~~~~~~~~~~~~~~~
0102
0103 用"make C=1"命令来编译内核，会对所有重新编译的 C 文件使用 sparse 工具。
0104 或者使用"make C=2"命令，无论文件是否被重新编译都会对其使用 sparse 工具。
0105 如果你已经编译了内核，用后一种方式可以很快地检查整个源码树。
0106
0107 make 的可选变量 CHECKFLAGS 可以用来向 sparse 工具传递参数。编译系统会自
0108 动向 sparse 工具传递 -Wbitwise 参数。
0109
0110 注意sparse定义了__CHECKER__预处理器符号。
