diff options
-rw-r--r-- | Documentation/coccinelle.txt | 258 | ||||
-rw-r--r-- | MAINTAINERS | 10 | ||||
-rw-r--r-- | Makefile | 10 | ||||
-rw-r--r-- | scripts/Makefile.help | 3 | ||||
-rwxr-xr-x | scripts/coccicheck | 54 | ||||
-rw-r--r-- | scripts/coccinelle/alloc/drop_kmalloc_cast.cocci | 67 | ||||
-rw-r--r-- | scripts/coccinelle/alloc/kzalloc-simple.cocci | 82 | ||||
-rw-r--r-- | scripts/coccinelle/deref_null.cocci | 293 | ||||
-rw-r--r-- | scripts/coccinelle/err_cast.cocci | 56 | ||||
-rw-r--r-- | scripts/coccinelle/resource_size.cocci | 93 |
10 files changed, 923 insertions, 3 deletions
diff --git a/Documentation/coccinelle.txt b/Documentation/coccinelle.txt new file mode 100644 index 000000000000..ba3315d545c6 --- /dev/null +++ b/Documentation/coccinelle.txt | |||
@@ -0,0 +1,258 @@ | |||
1 | Copyright 2010 Nicolas Palix <npalix@diku.dk> | ||
2 | Copyright 2010 Julia Lawall <julia@diku.dk> | ||
3 | Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr> | ||
4 | |||
5 | |||
6 | Getting Coccinelle | ||
7 | ~~~~~~~~~~~~~~~~~~~~ | ||
8 | |||
9 | The semantic patches included in the kernel use the 'virtual rule' | ||
10 | feature which was introduced in Coccinelle version 0.1.11. | ||
11 | |||
12 | Coccinelle (>=0.2.0) is available through the package manager | ||
13 | of many distributions, e.g. : | ||
14 | |||
15 | - Debian (>=squeeze) | ||
16 | - Fedora (>=13) | ||
17 | - Ubuntu (>=10.04 Karmic Koala) | ||
18 | - OpenSUSE | ||
19 | - Arch Linux | ||
20 | - NetBSD | ||
21 | - FreeBSD | ||
22 | |||
23 | |||
24 | You can get the latest version released from the Coccinelle homepage at | ||
25 | http://coccinelle.lip6.fr/ | ||
26 | |||
27 | Once you have it, run the following command: | ||
28 | |||
29 | ./configure | ||
30 | make | ||
31 | |||
32 | as a regular user, and install it with | ||
33 | |||
34 | sudo make install | ||
35 | |||
36 | |||
37 | Using Coccinelle on the Linux kernel | ||
38 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
39 | |||
40 | A Coccinelle-specific target is defined in the top level | ||
41 | Makefile. This target is named 'coccicheck' and calls the 'coccicheck' | ||
42 | front-end in the 'scripts' directory. | ||
43 | |||
44 | Four modes are defined: report, patch, context, and org. The mode to | ||
45 | use is specified by setting the MODE variable with 'MODE=<mode>'. | ||
46 | |||
47 | 'report' generates a list in the following format: | ||
48 | file:line:column-column: message | ||
49 | |||
50 | 'patch' proposes a fix, when possible. | ||
51 | |||
52 | 'context' highlights lines of interest and their context in a | ||
53 | diff-like style.Lines of interest are indicated with '-'. | ||
54 | |||
55 | 'org' generates a report in the Org mode format of Emacs. | ||
56 | |||
57 | Note that not all semantic patches implement all modes. | ||
58 | |||
59 | To make a report for every semantic patch, run the following command: | ||
60 | |||
61 | make coccicheck MODE=report | ||
62 | |||
63 | NB: The 'report' mode is the default one. | ||
64 | |||
65 | To produce patches, run: | ||
66 | |||
67 | make coccicheck MODE=patch | ||
68 | |||
69 | |||
70 | The coccicheck target applies every semantic patch available in the | ||
71 | subdirectories of 'scripts/coccinelle' to the entire Linux kernel. | ||
72 | |||
73 | For each semantic patch, a changelog message is proposed. It gives a | ||
74 | description of the problem being checked by the semantic patch, and | ||
75 | includes a reference to Coccinelle. | ||
76 | |||
77 | As any static code analyzer, Coccinelle produces false | ||
78 | positives. Thus, reports must be carefully checked, and patches | ||
79 | reviewed. | ||
80 | |||
81 | |||
82 | Using Coccinelle with a single semantic patch | ||
83 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
84 | |||
85 | The optional make variable COCCI can be used to check a single | ||
86 | semantic patch. In that case, the variable must be initialized with | ||
87 | the name of the semantic patch to apply. | ||
88 | |||
89 | For instance: | ||
90 | |||
91 | make coccicheck COCCI=<my_SP.cocci> MODE=patch | ||
92 | or | ||
93 | make coccicheck COCCI=<my_SP.cocci> MODE=report | ||
94 | |||
95 | |||
96 | Proposing new semantic patches | ||
97 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
98 | |||
99 | New semantic patches can be proposed and submitted by kernel | ||
100 | developers. For sake of clarity, they should be organized in the | ||
101 | subdirectories of 'scripts/coccinelle/'. | ||
102 | |||
103 | |||
104 | Detailed description of the 'report' mode | ||
105 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
106 | |||
107 | 'report' generates a list in the following format: | ||
108 | file:line:column-column: message | ||
109 | |||
110 | Example: | ||
111 | |||
112 | Running | ||
113 | |||
114 | make coccicheck MODE=report COCCI=scripts/coccinelle/err_cast.cocci | ||
115 | |||
116 | will execute the following part of the SmPL script. | ||
117 | |||
118 | <smpl> | ||
119 | @r depends on !context && !patch && (org || report)@ | ||
120 | expression x; | ||
121 | position p; | ||
122 | @@ | ||
123 | |||
124 | ERR_PTR@p(PTR_ERR(x)) | ||
125 | |||
126 | @script:python depends on report@ | ||
127 | p << r.p; | ||
128 | x << r.x; | ||
129 | @@ | ||
130 | |||
131 | msg="ERR_CAST can be used with %s" % (x) | ||
132 | coccilib.report.print_report(p[0], msg) | ||
133 | </smpl> | ||
134 | |||
135 | This SmPL excerpt generates entries on the standard output, as | ||
136 | illustrated below: | ||
137 | |||
138 | /home/user/linux/crypto/ctr.c:188:9-16: ERR_CAST can be used with alg | ||
139 | /home/user/linux/crypto/authenc.c:619:9-16: ERR_CAST can be used with auth | ||
140 | /home/user/linux/crypto/xts.c:227:9-16: ERR_CAST can be used with alg | ||
141 | |||
142 | |||
143 | Detailed description of the 'patch' mode | ||
144 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
145 | |||
146 | When the 'patch' mode is available, it proposes a fix for each problem | ||
147 | identified. | ||
148 | |||
149 | Example: | ||
150 | |||
151 | Running | ||
152 | make coccicheck MODE=patch COCCI=scripts/coccinelle/err_cast.cocci | ||
153 | |||
154 | will execute the following part of the SmPL script. | ||
155 | |||
156 | <smpl> | ||
157 | @ depends on !context && patch && !org && !report @ | ||
158 | expression x; | ||
159 | @@ | ||
160 | |||
161 | - ERR_PTR(PTR_ERR(x)) | ||
162 | + ERR_CAST(x) | ||
163 | </smpl> | ||
164 | |||
165 | This SmPL excerpt generates patch hunks on the standard output, as | ||
166 | illustrated below: | ||
167 | |||
168 | diff -u -p a/crypto/ctr.c b/crypto/ctr.c | ||
169 | --- a/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200 | ||
170 | +++ b/crypto/ctr.c 2010-06-03 23:44:49.000000000 +0200 | ||
171 | @@ -185,7 +185,7 @@ static struct crypto_instance *crypto_ct | ||
172 | alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER, | ||
173 | CRYPTO_ALG_TYPE_MASK); | ||
174 | if (IS_ERR(alg)) | ||
175 | - return ERR_PTR(PTR_ERR(alg)); | ||
176 | + return ERR_CAST(alg); | ||
177 | |||
178 | /* Block size must be >= 4 bytes. */ | ||
179 | err = -EINVAL; | ||
180 | |||
181 | Detailed description of the 'context' mode | ||
182 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
183 | |||
184 | 'context' highlights lines of interest and their context | ||
185 | in a diff-like style. | ||
186 | |||
187 | NOTE: The diff-like output generated is NOT an applicable patch. The | ||
188 | intent of the 'context' mode is to highlight the important lines | ||
189 | (annotated with minus, '-') and gives some surrounding context | ||
190 | lines around. This output can be used with the diff mode of | ||
191 | Emacs to review the code. | ||
192 | |||
193 | Example: | ||
194 | |||
195 | Running | ||
196 | make coccicheck MODE=context COCCI=scripts/coccinelle/err_cast.cocci | ||
197 | |||
198 | will execute the following part of the SmPL script. | ||
199 | |||
200 | <smpl> | ||
201 | @ depends on context && !patch && !org && !report@ | ||
202 | expression x; | ||
203 | @@ | ||
204 | |||
205 | * ERR_PTR(PTR_ERR(x)) | ||
206 | </smpl> | ||
207 | |||
208 | This SmPL excerpt generates diff hunks on the standard output, as | ||
209 | illustrated below: | ||
210 | |||
211 | diff -u -p /home/user/linux/crypto/ctr.c /tmp/nothing | ||
212 | --- /home/user/linux/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200 | ||
213 | +++ /tmp/nothing | ||
214 | @@ -185,7 +185,6 @@ static struct crypto_instance *crypto_ct | ||
215 | alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER, | ||
216 | CRYPTO_ALG_TYPE_MASK); | ||
217 | if (IS_ERR(alg)) | ||
218 | - return ERR_PTR(PTR_ERR(alg)); | ||
219 | |||
220 | /* Block size must be >= 4 bytes. */ | ||
221 | err = -EINVAL; | ||
222 | |||
223 | Detailed description of the 'org' mode | ||
224 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
225 | |||
226 | 'org' generates a report in the Org mode format of Emacs. | ||
227 | |||
228 | Example: | ||
229 | |||
230 | Running | ||
231 | make coccicheck MODE=org COCCI=scripts/coccinelle/err_cast.cocci | ||
232 | |||
233 | will execute the following part of the SmPL script. | ||
234 | |||
235 | <smpl> | ||
236 | @r depends on !context && !patch && (org || report)@ | ||
237 | expression x; | ||
238 | position p; | ||
239 | @@ | ||
240 | |||
241 | ERR_PTR@p(PTR_ERR(x)) | ||
242 | |||
243 | @script:python depends on org@ | ||
244 | p << r.p; | ||
245 | x << r.x; | ||
246 | @@ | ||
247 | |||
248 | msg="ERR_CAST can be used with %s" % (x) | ||
249 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
250 | coccilib.org.print_todo(p[0], msg_safe) | ||
251 | </smpl> | ||
252 | |||
253 | This SmPL excerpt generates Org entries on the standard output, as | ||
254 | illustrated below: | ||
255 | |||
256 | * TODO [[view:/home/user/linux/crypto/ctr.c::face=ovl-face1::linb=188::colb=9::cole=16][ERR_CAST can be used with alg]] | ||
257 | * TODO [[view:/home/user/linux/crypto/authenc.c::face=ovl-face1::linb=619::colb=9::cole=16][ERR_CAST can be used with auth]] | ||
258 | * TODO [[view:/home/user/linux/crypto/xts.c::face=ovl-face1::linb=227::colb=9::cole=16][ERR_CAST can be used with alg]] | ||
diff --git a/MAINTAINERS b/MAINTAINERS index ce3601e5e3c8..0572b7ea5f9f 100644 --- a/MAINTAINERS +++ b/MAINTAINERS | |||
@@ -1476,6 +1476,16 @@ M: Daniel Oliveira Nascimento <don@syst.com.br> | |||
1476 | S: Supported | 1476 | S: Supported |
1477 | F: drivers/platform/x86/classmate-laptop.c | 1477 | F: drivers/platform/x86/classmate-laptop.c |
1478 | 1478 | ||
1479 | COCCINELLE/Semantic Patches (SmPL) | ||
1480 | M: Julia Lawall <julia@diku.dk> | ||
1481 | M: Gilles Muller <Gilles.Muller@lip6.fr> | ||
1482 | M: Nicolas Palix <npalix@diku.dk> | ||
1483 | L: cocci@diku.dk (moderated for non-subscribers) | ||
1484 | W: http://coccinelle.lip6.fr/ | ||
1485 | S: Supported | ||
1486 | F: scripts/coccinelle/ | ||
1487 | F: scripts/coccicheck | ||
1488 | |||
1479 | CODA FILE SYSTEM | 1489 | CODA FILE SYSTEM |
1480 | M: Jan Harkes <jaharkes@cs.cmu.edu> | 1490 | M: Jan Harkes <jaharkes@cs.cmu.edu> |
1481 | M: coda@cs.cmu.edu | 1491 | M: coda@cs.cmu.edu |
@@ -412,7 +412,7 @@ endif | |||
412 | # of make so .config is not included in this case either (for *config). | 412 | # of make so .config is not included in this case either (for *config). |
413 | 413 | ||
414 | no-dot-config-targets := clean mrproper distclean \ | 414 | no-dot-config-targets := clean mrproper distclean \ |
415 | cscope TAGS tags help %docs check% \ | 415 | cscope TAGS tags help %docs check% coccicheck \ |
416 | include/linux/version.h headers_% \ | 416 | include/linux/version.h headers_% \ |
417 | kernelrelease kernelversion | 417 | kernelrelease kernelversion |
418 | 418 | ||
@@ -1279,8 +1279,9 @@ help: | |||
1279 | @echo ' includecheck - Check for duplicate included header files' | 1279 | @echo ' includecheck - Check for duplicate included header files' |
1280 | @echo ' export_report - List the usages of all exported symbols' | 1280 | @echo ' export_report - List the usages of all exported symbols' |
1281 | @echo ' headers_check - Sanity check on exported headers' | 1281 | @echo ' headers_check - Sanity check on exported headers' |
1282 | @echo ' headerdep - Detect inclusion cycles in headers'; \ | 1282 | @echo ' headerdep - Detect inclusion cycles in headers' |
1283 | echo '' | 1283 | @$(MAKE) -f $(srctree)/scripts/Makefile.help checker-help |
1284 | @echo '' | ||
1284 | @echo 'Kernel packaging:' | 1285 | @echo 'Kernel packaging:' |
1285 | @$(MAKE) $(build)=$(package-dir) help | 1286 | @$(MAKE) $(build)=$(package-dir) help |
1286 | @echo '' | 1287 | @echo '' |
@@ -1439,6 +1440,9 @@ versioncheck: | |||
1439 | -name '*.[hcS]' -type f -print | sort \ | 1440 | -name '*.[hcS]' -type f -print | sort \ |
1440 | | xargs $(PERL) -w $(srctree)/scripts/checkversion.pl | 1441 | | xargs $(PERL) -w $(srctree)/scripts/checkversion.pl |
1441 | 1442 | ||
1443 | coccicheck: | ||
1444 | $(Q)$(CONFIG_SHELL) $(srctree)/scripts/$@ | ||
1445 | |||
1442 | namespacecheck: | 1446 | namespacecheck: |
1443 | $(PERL) $(srctree)/scripts/namespace.pl | 1447 | $(PERL) $(srctree)/scripts/namespace.pl |
1444 | 1448 | ||
diff --git a/scripts/Makefile.help b/scripts/Makefile.help new file mode 100644 index 000000000000..d03608f5db04 --- /dev/null +++ b/scripts/Makefile.help | |||
@@ -0,0 +1,3 @@ | |||
1 | |||
2 | checker-help: | ||
3 | @echo ' coccicheck - Check with Coccinelle.' | ||
diff --git a/scripts/coccicheck b/scripts/coccicheck new file mode 100755 index 000000000000..037424b9ede5 --- /dev/null +++ b/scripts/coccicheck | |||
@@ -0,0 +1,54 @@ | |||
1 | #!/bin/sh | ||
2 | |||
3 | SPATCH="`which ${SPATCH:=spatch}`" | ||
4 | |||
5 | if [ ! -x "$SPATCH" ]; then | ||
6 | echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' | ||
7 | exit 1 | ||
8 | fi | ||
9 | |||
10 | if [ "$MODE" = "" ] ; then | ||
11 | echo 'You have not explicitly specify the mode to use. Fallback to "report".' | ||
12 | echo 'You can specify the mode with "make coccicheck MODE=<mode>"' | ||
13 | echo 'Available modes are: report, patch, context, org' | ||
14 | MODE="report" | ||
15 | fi | ||
16 | |||
17 | echo '' | ||
18 | echo 'Please check for false positives in the output before submitting a patch.' | ||
19 | echo 'When using "patch" mode, carefully review the patch before submitting it.' | ||
20 | echo '' | ||
21 | |||
22 | function coccinelle { | ||
23 | COCCI="$1" | ||
24 | DIR="$2" | ||
25 | |||
26 | OPT=`grep "Option" $COCCI | cut -d':' -f2` | ||
27 | FILE=`echo $COCCI | sed "s|$DIR/||"` | ||
28 | |||
29 | echo "Processing `basename $COCCI` with option(s) \"$OPT\"" | ||
30 | echo 'Message example to submit a patch:' | ||
31 | |||
32 | sed -e '/\/\/\//!d' -e 's|^///||' $COCCI | ||
33 | |||
34 | echo ' The semantic patch that makes this change is available' | ||
35 | echo " in $FILE." | ||
36 | echo '' | ||
37 | echo ' More information about semantic patching is available at' | ||
38 | echo ' http://coccinelle.lip6.fr/' | ||
39 | echo '' | ||
40 | |||
41 | # The option '-parse_cocci' can be used to syntaxically check the SmPL files. | ||
42 | # | ||
43 | # $SPATCH -D $MODE -very_quiet -parse_cocci $COCCI $OPT > /dev/null | ||
44 | |||
45 | $SPATCH -D $MODE -very_quiet -sp_file $COCCI $OPT -dir $DIR | ||
46 | } | ||
47 | |||
48 | if [ "$COCCI" = "" ] ; then | ||
49 | for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do | ||
50 | coccinelle $f $srctree; | ||
51 | done | ||
52 | else | ||
53 | coccinelle $COCCI $srctree | ||
54 | fi | ||
diff --git a/scripts/coccinelle/alloc/drop_kmalloc_cast.cocci b/scripts/coccinelle/alloc/drop_kmalloc_cast.cocci new file mode 100644 index 000000000000..7d4771d449c3 --- /dev/null +++ b/scripts/coccinelle/alloc/drop_kmalloc_cast.cocci | |||
@@ -0,0 +1,67 @@ | |||
1 | /// | ||
2 | /// Casting (void *) value returned by kmalloc is useless | ||
3 | /// as mentioned in Documentation/CodingStyle, Chap 14. | ||
4 | /// | ||
5 | // Confidence: High | ||
6 | // Copyright: 2009,2010 Nicolas Palix, DIKU. GPLv2. | ||
7 | // URL: http://coccinelle.lip6.fr/ | ||
8 | // Options: -no_includes -include_headers | ||
9 | // | ||
10 | // Keywords: kmalloc, kzalloc, kcalloc | ||
11 | // Version min: < 2.6.12 kmalloc | ||
12 | // Version min: < 2.6.12 kcalloc | ||
13 | // Version min: 2.6.14 kzalloc | ||
14 | // | ||
15 | |||
16 | virtual context | ||
17 | virtual patch | ||
18 | virtual org | ||
19 | virtual report | ||
20 | |||
21 | //---------------------------------------------------------- | ||
22 | // For context mode | ||
23 | //---------------------------------------------------------- | ||
24 | |||
25 | @depends on context@ | ||
26 | type T; | ||
27 | @@ | ||
28 | |||
29 | * (T *) | ||
30 | \(kmalloc\|kzalloc\|kcalloc\)(...) | ||
31 | |||
32 | //---------------------------------------------------------- | ||
33 | // For patch mode | ||
34 | //---------------------------------------------------------- | ||
35 | |||
36 | @depends on patch@ | ||
37 | type T; | ||
38 | @@ | ||
39 | |||
40 | - (T *) | ||
41 | \(kmalloc\|kzalloc\|kcalloc\)(...) | ||
42 | |||
43 | //---------------------------------------------------------- | ||
44 | // For org and report mode | ||
45 | //---------------------------------------------------------- | ||
46 | |||
47 | @r depends on org || report@ | ||
48 | type T; | ||
49 | position p; | ||
50 | @@ | ||
51 | |||
52 | (T@p *)\(kmalloc\|kzalloc\|kcalloc\)(...) | ||
53 | |||
54 | @script:python depends on org@ | ||
55 | p << r.p; | ||
56 | t << r.T; | ||
57 | @@ | ||
58 | |||
59 | coccilib.org.print_safe_todo(p[0], t) | ||
60 | |||
61 | @script:python depends on report@ | ||
62 | p << r.p; | ||
63 | t << r.T; | ||
64 | @@ | ||
65 | |||
66 | msg="WARNING: casting value returned by k[cmz]alloc to (%s *) is useless." % (t) | ||
67 | coccilib.report.print_report(p[0], msg) | ||
diff --git a/scripts/coccinelle/alloc/kzalloc-simple.cocci b/scripts/coccinelle/alloc/kzalloc-simple.cocci new file mode 100644 index 000000000000..2eae828fc657 --- /dev/null +++ b/scripts/coccinelle/alloc/kzalloc-simple.cocci | |||
@@ -0,0 +1,82 @@ | |||
1 | /// | ||
2 | /// kzalloc should be used rather than kmalloc followed by memset 0 | ||
3 | /// | ||
4 | // Confidence: High | ||
5 | // Copyright: (C) 2009-2010 Julia Lawall, Nicolas Palix, DIKU. GPLv2. | ||
6 | // Copyright: (C) 2009-2010 Gilles Muller, INRIA/LiP6. GPLv2. | ||
7 | // URL: http://coccinelle.lip6.fr/rules/kzalloc.html | ||
8 | // Options: -no_includes -include_headers | ||
9 | // | ||
10 | // Keywords: kmalloc, kzalloc | ||
11 | // Version min: < 2.6.12 kmalloc | ||
12 | // Version min: 2.6.14 kzalloc | ||
13 | // | ||
14 | |||
15 | virtual context | ||
16 | virtual patch | ||
17 | virtual org | ||
18 | virtual report | ||
19 | |||
20 | //---------------------------------------------------------- | ||
21 | // For context mode | ||
22 | //---------------------------------------------------------- | ||
23 | |||
24 | @depends on context@ | ||
25 | type T, T2; | ||
26 | expression x; | ||
27 | expression E1,E2; | ||
28 | statement S; | ||
29 | @@ | ||
30 | |||
31 | * x = (T)kmalloc(E1,E2); | ||
32 | if ((x==NULL) || ...) S | ||
33 | * memset((T2)x,0,E1); | ||
34 | |||
35 | //---------------------------------------------------------- | ||
36 | // For patch mode | ||
37 | //---------------------------------------------------------- | ||
38 | |||
39 | @depends on patch@ | ||
40 | type T, T2; | ||
41 | expression x; | ||
42 | expression E1,E2; | ||
43 | statement S; | ||
44 | @@ | ||
45 | |||
46 | - x = (T)kmalloc(E1,E2); | ||
47 | + x = kzalloc(E1,E2); | ||
48 | if ((x==NULL) || ...) S | ||
49 | - memset((T2)x,0,E1); | ||
50 | |||
51 | //---------------------------------------------------------- | ||
52 | // For org mode | ||
53 | //---------------------------------------------------------- | ||
54 | |||
55 | @r depends on org || report@ | ||
56 | type T, T2; | ||
57 | expression x; | ||
58 | expression E1,E2; | ||
59 | statement S; | ||
60 | position p; | ||
61 | @@ | ||
62 | |||
63 | x = (T)kmalloc@p(E1,E2); | ||
64 | if ((x==NULL) || ...) S | ||
65 | memset((T2)x,0,E1); | ||
66 | |||
67 | @script:python depends on org@ | ||
68 | p << r.p; | ||
69 | x << r.x; | ||
70 | @@ | ||
71 | |||
72 | msg="%s" % (x) | ||
73 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
74 | coccilib.org.print_todo(p[0], msg_safe) | ||
75 | |||
76 | @script:python depends on report@ | ||
77 | p << r.p; | ||
78 | x << r.x; | ||
79 | @@ | ||
80 | |||
81 | msg="WARNING: kzalloc should be used for %s, instead of kmalloc/memset" % (x) | ||
82 | coccilib.report.print_report(p[0], msg) | ||
diff --git a/scripts/coccinelle/deref_null.cocci b/scripts/coccinelle/deref_null.cocci new file mode 100644 index 000000000000..9969d76d0f4b --- /dev/null +++ b/scripts/coccinelle/deref_null.cocci | |||
@@ -0,0 +1,293 @@ | |||
1 | /// | ||
2 | /// A variable is dereference under a NULL test. | ||
3 | /// Even though it is know to be NULL. | ||
4 | /// | ||
5 | // Confidence: Moderate | ||
6 | // Copyright: (C) 2010 Nicolas Palix, DIKU. GPLv2. | ||
7 | // Copyright: (C) 2010 Julia Lawall, DIKU. GPLv2. | ||
8 | // Copyright: (C) 2010 Gilles Muller, INRIA/LiP6. GPLv2. | ||
9 | // URL: http://coccinelle.lip6.fr/ | ||
10 | // Comments: -I ... -all_includes can give more complete results | ||
11 | // Options: | ||
12 | |||
13 | virtual context | ||
14 | virtual patch | ||
15 | virtual org | ||
16 | virtual report | ||
17 | |||
18 | @initialize:python depends on !context && patch && !org && !report@ | ||
19 | |||
20 | import sys | ||
21 | print >> sys.stderr, "This semantic patch does not support the 'patch' mode." | ||
22 | |||
23 | @depends on patch@ | ||
24 | @@ | ||
25 | |||
26 | this_rule_should_never_matches(); | ||
27 | |||
28 | @ifm depends on !patch@ | ||
29 | expression *E; | ||
30 | statement S1,S2; | ||
31 | position p1; | ||
32 | @@ | ||
33 | |||
34 | if@p1 ((E == NULL && ...) || ...) S1 else S2 | ||
35 | |||
36 | // The following two rules are separate, because both can match a single | ||
37 | // expression in different ways | ||
38 | @pr1 depends on !patch expression@ | ||
39 | expression *ifm.E; | ||
40 | identifier f; | ||
41 | position p1; | ||
42 | @@ | ||
43 | |||
44 | (E != NULL && ...) ? <+...E->f@p1...+> : ... | ||
45 | |||
46 | @pr2 depends on !patch expression@ | ||
47 | expression *ifm.E; | ||
48 | identifier f; | ||
49 | position p2; | ||
50 | @@ | ||
51 | |||
52 | ( | ||
53 | (E != NULL) && ... && <+...E->f@p2...+> | ||
54 | | | ||
55 | (E == NULL) || ... || <+...E->f@p2...+> | ||
56 | | | ||
57 | sizeof(<+...E->f@p2...+>) | ||
58 | ) | ||
59 | |||
60 | // For org and report modes | ||
61 | |||
62 | @r depends on !context && !patch && (org || report) exists@ | ||
63 | expression subE <= ifm.E; | ||
64 | expression *ifm.E; | ||
65 | expression E1,E2; | ||
66 | identifier f; | ||
67 | statement S1,S2,S3,S4; | ||
68 | iterator iter; | ||
69 | position p!={pr1.p1,pr2.p2}; | ||
70 | position ifm.p1; | ||
71 | @@ | ||
72 | |||
73 | if@p1 ((E == NULL && ...) || ...) | ||
74 | { | ||
75 | ... when != if (...) S1 else S2 | ||
76 | ( | ||
77 | iter(subE,...) S4 // no use | ||
78 | | | ||
79 | list_remove_head(E2,subE,...) | ||
80 | | | ||
81 | subE = E1 | ||
82 | | | ||
83 | for(subE = E1;...;...) S4 | ||
84 | | | ||
85 | subE++ | ||
86 | | | ||
87 | ++subE | ||
88 | | | ||
89 | --subE | ||
90 | | | ||
91 | subE-- | ||
92 | | | ||
93 | &subE | ||
94 | | | ||
95 | E->f@p // bad use | ||
96 | ) | ||
97 | ... when any | ||
98 | return ...; | ||
99 | } | ||
100 | else S3 | ||
101 | |||
102 | @script:python depends on !context && !patch && !org && report@ | ||
103 | p << r.p; | ||
104 | p1 << ifm.p1; | ||
105 | x << ifm.E; | ||
106 | @@ | ||
107 | |||
108 | msg="ERROR: %s is NULL but dereferenced." % (x) | ||
109 | coccilib.report.print_report(p[0], msg) | ||
110 | cocci.include_match(False) | ||
111 | |||
112 | @script:python depends on !context && !patch && org && !report@ | ||
113 | p << r.p; | ||
114 | p1 << ifm.p1; | ||
115 | x << ifm.E; | ||
116 | @@ | ||
117 | |||
118 | msg="ERROR: %s is NULL but dereferenced." % (x) | ||
119 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
120 | cocci.print_main(msg_safe,p) | ||
121 | cocci.include_match(False) | ||
122 | |||
123 | @s depends on !context && !patch && (org || report) exists@ | ||
124 | expression subE <= ifm.E; | ||
125 | expression *ifm.E; | ||
126 | expression E1,E2; | ||
127 | identifier f; | ||
128 | statement S1,S2,S3,S4; | ||
129 | iterator iter; | ||
130 | position p!={pr1.p1,pr2.p2}; | ||
131 | position ifm.p1; | ||
132 | @@ | ||
133 | |||
134 | if@p1 ((E == NULL && ...) || ...) | ||
135 | { | ||
136 | ... when != if (...) S1 else S2 | ||
137 | ( | ||
138 | iter(subE,...) S4 // no use | ||
139 | | | ||
140 | list_remove_head(E2,subE,...) | ||
141 | | | ||
142 | subE = E1 | ||
143 | | | ||
144 | for(subE = E1;...;...) S4 | ||
145 | | | ||
146 | subE++ | ||
147 | | | ||
148 | ++subE | ||
149 | | | ||
150 | --subE | ||
151 | | | ||
152 | subE-- | ||
153 | | | ||
154 | &subE | ||
155 | | | ||
156 | E->f@p // bad use | ||
157 | ) | ||
158 | ... when any | ||
159 | } | ||
160 | else S3 | ||
161 | |||
162 | @script:python depends on !context && !patch && !org && report@ | ||
163 | p << s.p; | ||
164 | p1 << ifm.p1; | ||
165 | x << ifm.E; | ||
166 | @@ | ||
167 | |||
168 | msg="ERROR: %s is NULL but dereferenced." % (x) | ||
169 | coccilib.report.print_report(p[0], msg) | ||
170 | |||
171 | @script:python depends on !context && !patch && org && !report@ | ||
172 | p << s.p; | ||
173 | p1 << ifm.p1; | ||
174 | x << ifm.E; | ||
175 | @@ | ||
176 | |||
177 | msg="ERROR: %s is NULL but dereferenced." % (x) | ||
178 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
179 | cocci.print_main(msg_safe,p) | ||
180 | |||
181 | // For context mode | ||
182 | |||
183 | @depends on context && !patch && !org && !report exists@ | ||
184 | expression subE <= ifm.E; | ||
185 | expression *ifm.E; | ||
186 | expression E1,E2; | ||
187 | identifier f; | ||
188 | statement S1,S2,S3,S4; | ||
189 | iterator iter; | ||
190 | position p!={pr1.p1,pr2.p2}; | ||
191 | position ifm.p1; | ||
192 | @@ | ||
193 | |||
194 | if@p1 ((E == NULL && ...) || ...) | ||
195 | { | ||
196 | ... when != if (...) S1 else S2 | ||
197 | ( | ||
198 | iter(subE,...) S4 // no use | ||
199 | | | ||
200 | list_remove_head(E2,subE,...) | ||
201 | | | ||
202 | subE = E1 | ||
203 | | | ||
204 | for(subE = E1;...;...) S4 | ||
205 | | | ||
206 | subE++ | ||
207 | | | ||
208 | ++subE | ||
209 | | | ||
210 | --subE | ||
211 | | | ||
212 | subE-- | ||
213 | | | ||
214 | &subE | ||
215 | | | ||
216 | * E->f@p // bad use | ||
217 | ) | ||
218 | ... when any | ||
219 | return ...; | ||
220 | } | ||
221 | else S3 | ||
222 | |||
223 | // The following three rules are duplicates of ifm, pr1 and pr2 respectively. | ||
224 | // It is need because the previous rule as already made a "change". | ||
225 | |||
226 | @ifm1 depends on !patch@ | ||
227 | expression *E; | ||
228 | statement S1,S2; | ||
229 | position p1; | ||
230 | @@ | ||
231 | |||
232 | if@p1 ((E == NULL && ...) || ...) S1 else S2 | ||
233 | |||
234 | @pr11 depends on !patch expression@ | ||
235 | expression *ifm1.E; | ||
236 | identifier f; | ||
237 | position p1; | ||
238 | @@ | ||
239 | |||
240 | (E != NULL && ...) ? <+...E->f@p1...+> : ... | ||
241 | |||
242 | @pr12 depends on !patch expression@ | ||
243 | expression *ifm1.E; | ||
244 | identifier f; | ||
245 | position p2; | ||
246 | @@ | ||
247 | |||
248 | ( | ||
249 | (E != NULL) && ... && <+...E->f@p2...+> | ||
250 | | | ||
251 | (E == NULL) || ... || <+...E->f@p2...+> | ||
252 | | | ||
253 | sizeof(<+...E->f@p2...+>) | ||
254 | ) | ||
255 | |||
256 | @depends on context && !patch && !org && !report exists@ | ||
257 | expression subE <= ifm1.E; | ||
258 | expression *ifm1.E; | ||
259 | expression E1,E2; | ||
260 | identifier f; | ||
261 | statement S1,S2,S3,S4; | ||
262 | iterator iter; | ||
263 | position p!={pr11.p1,pr12.p2}; | ||
264 | position ifm1.p1; | ||
265 | @@ | ||
266 | |||
267 | if@p1 ((E == NULL && ...) || ...) | ||
268 | { | ||
269 | ... when != if (...) S1 else S2 | ||
270 | ( | ||
271 | iter(subE,...) S4 // no use | ||
272 | | | ||
273 | list_remove_head(E2,subE,...) | ||
274 | | | ||
275 | subE = E1 | ||
276 | | | ||
277 | for(subE = E1;...;...) S4 | ||
278 | | | ||
279 | subE++ | ||
280 | | | ||
281 | ++subE | ||
282 | | | ||
283 | --subE | ||
284 | | | ||
285 | subE-- | ||
286 | | | ||
287 | &subE | ||
288 | | | ||
289 | * E->f@p // bad use | ||
290 | ) | ||
291 | ... when any | ||
292 | } | ||
293 | else S3 | ||
diff --git a/scripts/coccinelle/err_cast.cocci b/scripts/coccinelle/err_cast.cocci new file mode 100644 index 000000000000..2ce115000af6 --- /dev/null +++ b/scripts/coccinelle/err_cast.cocci | |||
@@ -0,0 +1,56 @@ | |||
1 | /// | ||
2 | /// Use ERR_CAST inlined function instead of ERR_PTR(PTR_ERR(...)) | ||
3 | /// | ||
4 | // Confidence: High | ||
5 | // Copyright: (C) 2009, 2010 Nicolas Palix, DIKU. GPLv2. | ||
6 | // Copyright: (C) 2009, 2010 Julia Lawall, DIKU. GPLv2. | ||
7 | // Copyright: (C) 2009, 2010 Gilles Muller, INRIA/LiP6. GPLv2. | ||
8 | // URL: http://coccinelle.lip6.fr/ | ||
9 | // Options: | ||
10 | // | ||
11 | // Keywords: ERR_PTR, PTR_ERR, ERR_CAST | ||
12 | // Version min: 2.6.25 | ||
13 | // | ||
14 | |||
15 | virtual context | ||
16 | virtual patch | ||
17 | virtual org | ||
18 | virtual report | ||
19 | |||
20 | |||
21 | @ depends on context && !patch && !org && !report@ | ||
22 | expression x; | ||
23 | @@ | ||
24 | |||
25 | * ERR_PTR(PTR_ERR(x)) | ||
26 | |||
27 | @ depends on !context && patch && !org && !report @ | ||
28 | expression x; | ||
29 | @@ | ||
30 | |||
31 | - ERR_PTR(PTR_ERR(x)) | ||
32 | + ERR_CAST(x) | ||
33 | |||
34 | @r depends on !context && !patch && (org || report)@ | ||
35 | expression x; | ||
36 | position p; | ||
37 | @@ | ||
38 | |||
39 | ERR_PTR@p(PTR_ERR(x)) | ||
40 | |||
41 | @script:python depends on org@ | ||
42 | p << r.p; | ||
43 | x << r.x; | ||
44 | @@ | ||
45 | |||
46 | msg="WARNING ERR_CAST can be used with %s" % (x) | ||
47 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
48 | coccilib.org.print_todo(p[0], msg_safe) | ||
49 | |||
50 | @script:python depends on report@ | ||
51 | p << r.p; | ||
52 | x << r.x; | ||
53 | @@ | ||
54 | |||
55 | msg="WARNING: ERR_CAST can be used with %s" % (x) | ||
56 | coccilib.report.print_report(p[0], msg) | ||
diff --git a/scripts/coccinelle/resource_size.cocci b/scripts/coccinelle/resource_size.cocci new file mode 100644 index 000000000000..1935a58b39d9 --- /dev/null +++ b/scripts/coccinelle/resource_size.cocci | |||
@@ -0,0 +1,93 @@ | |||
1 | /// | ||
2 | /// Use resource_size function on resource object | ||
3 | /// instead of explicit computation. | ||
4 | /// | ||
5 | // Confidence: High | ||
6 | // Copyright: (C) 2009, 2010 Nicolas Palix, DIKU. GPLv2. | ||
7 | // Copyright: (C) 2009, 2010 Julia Lawall, DIKU. GPLv2. | ||
8 | // Copyright: (C) 2009, 2010 Gilles Muller, INRIA/LiP6. GPLv2. | ||
9 | // URL: http://coccinelle.lip6.fr/ | ||
10 | // Options: | ||
11 | // | ||
12 | // Keywords: resource_size | ||
13 | // Version min: 2.6.27 resource_size | ||
14 | // | ||
15 | |||
16 | virtual context | ||
17 | virtual patch | ||
18 | virtual org | ||
19 | virtual report | ||
20 | |||
21 | //---------------------------------------------------------- | ||
22 | // For context mode | ||
23 | //---------------------------------------------------------- | ||
24 | |||
25 | @r_context depends on context && !patch && !org@ | ||
26 | struct resource *res; | ||
27 | @@ | ||
28 | |||
29 | * (res->end - res->start) + 1 | ||
30 | |||
31 | //---------------------------------------------------------- | ||
32 | // For patch mode | ||
33 | //---------------------------------------------------------- | ||
34 | |||
35 | @r_patch depends on !context && patch && !org@ | ||
36 | struct resource *res; | ||
37 | @@ | ||
38 | |||
39 | - (res->end - res->start) + 1 | ||
40 | + resource_size(res) | ||
41 | |||
42 | //---------------------------------------------------------- | ||
43 | // For org mode | ||
44 | //---------------------------------------------------------- | ||
45 | |||
46 | |||
47 | @r_org depends on !context && !patch && (org || report)@ | ||
48 | struct resource *res; | ||
49 | position p; | ||
50 | @@ | ||
51 | |||
52 | (res->end@p - res->start) + 1 | ||
53 | |||
54 | @rbad_org depends on !context && !patch && (org || report)@ | ||
55 | struct resource *res; | ||
56 | position p != r_org.p; | ||
57 | @@ | ||
58 | |||
59 | res->end@p - res->start | ||
60 | |||
61 | @script:python depends on org@ | ||
62 | p << r_org.p; | ||
63 | x << r_org.res; | ||
64 | @@ | ||
65 | |||
66 | msg="ERROR with %s" % (x) | ||
67 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
68 | coccilib.org.print_todo(p[0], msg_safe) | ||
69 | |||
70 | @script:python depends on report@ | ||
71 | p << r_org.p; | ||
72 | x << r_org.res; | ||
73 | @@ | ||
74 | |||
75 | msg="ERROR: Missing resource_size with %s" % (x) | ||
76 | coccilib.report.print_report(p[0], msg) | ||
77 | |||
78 | @script:python depends on org@ | ||
79 | p << rbad_org.p; | ||
80 | x << rbad_org.res; | ||
81 | @@ | ||
82 | |||
83 | msg="WARNING with %s" % (x) | ||
84 | msg_safe=msg.replace("[","@(").replace("]",")") | ||
85 | coccilib.org.print_todo(p[0], msg_safe) | ||
86 | |||
87 | @script:python depends on report@ | ||
88 | p << rbad_org.p; | ||
89 | x << rbad_org.res; | ||
90 | @@ | ||
91 | |||
92 | msg="WARNING: Suspicious code. resource_size is maybe missing with %s" % (x) | ||
93 | coccilib.report.print_report(p[0], msg) | ||