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