1 .. Copyright 2010 Nicolas Palix <npalix@diku.dk 1 .. Copyright 2010 Nicolas Palix <npalix@diku.dk>
2 .. Copyright 2010 Julia Lawall <julia@diku.dk> 2 .. Copyright 2010 Julia Lawall <julia@diku.dk>
3 .. Copyright 2010 Gilles Muller <Gilles.Muller@ 3 .. Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr>
4 4
5 .. highlight:: none 5 .. highlight:: none
6 6
7 .. _devtools_coccinelle: <<
8 <<
9 Coccinelle 7 Coccinelle
10 ========== 8 ==========
11 9
12 Coccinelle is a tool for pattern matching and 10 Coccinelle is a tool for pattern matching and text transformation that has
13 many uses in kernel development, including the 11 many uses in kernel development, including the application of complex,
14 tree-wide patches and detection of problematic 12 tree-wide patches and detection of problematic programming patterns.
15 13
16 Getting Coccinelle 14 Getting Coccinelle
17 ------------------ !! 15 -------------------
18 16
19 The semantic patches included in the kernel us 17 The semantic patches included in the kernel use features and options
20 which are provided by Coccinelle version 1.0.0 18 which are provided by Coccinelle version 1.0.0-rc11 and above.
21 Using earlier versions will fail as the option 19 Using earlier versions will fail as the option names used by
22 the Coccinelle files and coccicheck have been 20 the Coccinelle files and coccicheck have been updated.
23 21
24 Coccinelle is available through the package ma 22 Coccinelle is available through the package manager
25 of many distributions, e.g. : 23 of many distributions, e.g. :
26 24
27 - Debian 25 - Debian
28 - Fedora 26 - Fedora
29 - Ubuntu 27 - Ubuntu
30 - OpenSUSE 28 - OpenSUSE
31 - Arch Linux 29 - Arch Linux
32 - NetBSD 30 - NetBSD
33 - FreeBSD 31 - FreeBSD
34 32
35 Some distribution packages are obsolete and it !! 33 You can get the latest version released from the Coccinelle homepage at
36 to use the latest version released from the Co <<
37 http://coccinelle.lip6.fr/ 34 http://coccinelle.lip6.fr/
38 35
39 Or from Github at: !! 36 Information and tips about Coccinelle are also provided on the wiki
40 !! 37 pages at http://cocci.ekstranet.diku.dk/wiki/doku.php
41 https://github.com/coccinelle/coccinelle <<
42 38
43 Once you have it, run the following commands:: !! 39 Once you have it, run the following command::
44 40
45 ./autogen !! 41 ./configure
46 ./configure <<
47 make 42 make
48 43
49 as a regular user, and install it with:: 44 as a regular user, and install it with::
50 45
51 sudo make install 46 sudo make install
52 47
53 More detailed installation instructions to bui <<
54 found at: <<
55 <<
56 https://github.com/coccinelle/coccinelle/blob/ <<
57 <<
58 Supplemental documentation 48 Supplemental documentation
59 -------------------------- !! 49 ---------------------------
60 50
61 For supplemental documentation refer to the wi 51 For supplemental documentation refer to the wiki:
62 52
63 https://bottest.wiki.kernel.org/coccicheck 53 https://bottest.wiki.kernel.org/coccicheck
64 54
65 The wiki documentation always refers to the li 55 The wiki documentation always refers to the linux-next version of the script.
66 56
67 For Semantic Patch Language(SmPL) grammar docu <<
68 <<
69 https://coccinelle.gitlabpages.inria.fr/websit <<
70 <<
71 Using Coccinelle on the Linux kernel 57 Using Coccinelle on the Linux kernel
72 ------------------------------------ 58 ------------------------------------
73 59
74 A Coccinelle-specific target is defined in the 60 A Coccinelle-specific target is defined in the top level
75 Makefile. This target is named ``coccicheck`` 61 Makefile. This target is named ``coccicheck`` and calls the ``coccicheck``
76 front-end in the ``scripts`` directory. 62 front-end in the ``scripts`` directory.
77 63
78 Four basic modes are defined: ``patch``, ``rep 64 Four basic modes are defined: ``patch``, ``report``, ``context``, and
79 ``org``. The mode to use is specified by setti 65 ``org``. The mode to use is specified by setting the MODE variable with
80 ``MODE=<mode>``. 66 ``MODE=<mode>``.
81 67
82 - ``patch`` proposes a fix, when possible. 68 - ``patch`` proposes a fix, when possible.
83 69
84 - ``report`` generates a list in the following 70 - ``report`` generates a list in the following format:
85 file:line:column-column: message 71 file:line:column-column: message
86 72
87 - ``context`` highlights lines of interest and 73 - ``context`` highlights lines of interest and their context in a
88 diff-like style. Lines of interest are indic !! 74 diff-like style.Lines of interest are indicated with ``-``.
89 75
90 - ``org`` generates a report in the Org mode f 76 - ``org`` generates a report in the Org mode format of Emacs.
91 77
92 Note that not all semantic patches implement a 78 Note that not all semantic patches implement all modes. For easy use
93 of Coccinelle, the default mode is "report". 79 of Coccinelle, the default mode is "report".
94 80
95 Two other modes provide some common combinatio 81 Two other modes provide some common combinations of these modes.
96 82
97 - ``chain`` tries the previous modes in the or 83 - ``chain`` tries the previous modes in the order above until one succeeds.
98 84
99 - ``rep+ctxt`` runs successively the report mo 85 - ``rep+ctxt`` runs successively the report mode and the context mode.
100 It should be used with the C option (describ 86 It should be used with the C option (described later)
101 which checks the code on a file basis. 87 which checks the code on a file basis.
102 88
103 Examples 89 Examples
104 ~~~~~~~~ 90 ~~~~~~~~
105 91
106 To make a report for every semantic patch, run 92 To make a report for every semantic patch, run the following command::
107 93
108 make coccicheck MODE=report 94 make coccicheck MODE=report
109 95
110 To produce patches, run:: 96 To produce patches, run::
111 97
112 make coccicheck MODE=patch 98 make coccicheck MODE=patch
113 99
114 100
115 The coccicheck target applies every semantic p 101 The coccicheck target applies every semantic patch available in the
116 sub-directories of ``scripts/coccinelle`` to t 102 sub-directories of ``scripts/coccinelle`` to the entire Linux kernel.
117 103
118 For each semantic patch, a commit message is p 104 For each semantic patch, a commit message is proposed. It gives a
119 description of the problem being checked by th 105 description of the problem being checked by the semantic patch, and
120 includes a reference to Coccinelle. 106 includes a reference to Coccinelle.
121 107
122 As with any static code analyzer, Coccinelle p !! 108 As any static code analyzer, Coccinelle produces false
123 positives. Thus, reports must be carefully che 109 positives. Thus, reports must be carefully checked, and patches
124 reviewed. 110 reviewed.
125 111
126 To enable verbose messages set the V= variable 112 To enable verbose messages set the V= variable, for example::
127 113
128 make coccicheck MODE=report V=1 114 make coccicheck MODE=report V=1
129 115
130 Coccinelle parallelization 116 Coccinelle parallelization
131 -------------------------- !! 117 ---------------------------
132 118
133 By default, coccicheck tries to run as paralle 119 By default, coccicheck tries to run as parallel as possible. To change
134 the parallelism, set the J= variable. For exam 120 the parallelism, set the J= variable. For example, to run across 4 CPUs::
135 121
136 make coccicheck MODE=report J=4 122 make coccicheck MODE=report J=4
137 123
138 As of Coccinelle 1.0.2 Coccinelle uses Ocaml p !! 124 As of Coccinelle 1.0.2 Coccinelle uses Ocaml parmap for parallelization,
139 if support for this is detected you will benef 125 if support for this is detected you will benefit from parmap parallelization.
140 126
141 When parmap is enabled coccicheck will enable 127 When parmap is enabled coccicheck will enable dynamic load balancing by using
142 ``--chunksize 1`` argument. This ensures we ke !! 128 ``--chunksize 1`` argument, this ensures we keep feeding threads with work
143 one by one, so that we avoid the situation whe 129 one by one, so that we avoid the situation where most work gets done by only
144 a few threads. With dynamic load balancing, if 130 a few threads. With dynamic load balancing, if a thread finishes early we keep
145 feeding it more work. 131 feeding it more work.
146 132
147 When parmap is enabled, if an error occurs in 133 When parmap is enabled, if an error occurs in Coccinelle, this error
148 value is propagated back, and the return value !! 134 value is propagated back, the return value of the ``make coccicheck``
149 command captures this return value. !! 135 captures this return value.
150 136
151 Using Coccinelle with a single semantic patch 137 Using Coccinelle with a single semantic patch
152 --------------------------------------------- 138 ---------------------------------------------
153 139
154 The optional make variable COCCI can be used t 140 The optional make variable COCCI can be used to check a single
155 semantic patch. In that case, the variable mus 141 semantic patch. In that case, the variable must be initialized with
156 the name of the semantic patch to apply. 142 the name of the semantic patch to apply.
157 143
158 For instance:: 144 For instance::
159 145
160 make coccicheck COCCI=<my_SP.cocci> MO 146 make coccicheck COCCI=<my_SP.cocci> MODE=patch
161 147
162 or:: 148 or::
163 149
164 make coccicheck COCCI=<my_SP.cocci> MO 150 make coccicheck COCCI=<my_SP.cocci> MODE=report
165 151
166 152
167 Controlling Which Files are Processed by Cocci 153 Controlling Which Files are Processed by Coccinelle
168 ---------------------------------------------- 154 ---------------------------------------------------
169 155
170 By default the entire kernel source tree is ch 156 By default the entire kernel source tree is checked.
171 157
172 To apply Coccinelle to a specific directory, ` 158 To apply Coccinelle to a specific directory, ``M=`` can be used.
173 For example, to check drivers/net/wireless/ on 159 For example, to check drivers/net/wireless/ one may write::
174 160
175 make coccicheck M=drivers/net/wireless/ 161 make coccicheck M=drivers/net/wireless/
176 162
177 To apply Coccinelle on a file basis, instead o 163 To apply Coccinelle on a file basis, instead of a directory basis, the
178 C variable is used by the makefile to select w !! 164 following command may be used::
179 This variable can be used to run scripts for t <<
180 specific directory, or for a single file. <<
181 <<
182 For example, to check drivers/bluetooth/bfusb. <<
183 passed to the C variable to check files that m <<
184 need to be compiled.:: <<
185 165
186 make C=1 CHECK=scripts/coccicheck drivers/ !! 166 make C=1 CHECK="scripts/coccicheck"
187 167
188 The value 2 is passed to the C variable to che !! 168 To check only newly edited code, use the value 2 for the C flag, i.e.::
189 whether they need to be compiled or not.:: <<
190 169
191 make C=2 CHECK=scripts/coccicheck drivers/ !! 170 make C=2 CHECK="scripts/coccicheck"
192 171
193 In these modes, which work on a file basis, th !! 172 In these modes, which works on a file basis, there is no information
194 about semantic patches displayed, and no commi 173 about semantic patches displayed, and no commit message proposed.
195 174
196 This runs every semantic patch in scripts/cocc 175 This runs every semantic patch in scripts/coccinelle by default. The
197 COCCI variable may additionally be used to onl 176 COCCI variable may additionally be used to only apply a single
198 semantic patch as shown in the previous sectio 177 semantic patch as shown in the previous section.
199 178
200 The "report" mode is the default. You can sele 179 The "report" mode is the default. You can select another one with the
201 MODE variable explained above. 180 MODE variable explained above.
202 181
203 Debugging Coccinelle SmPL patches 182 Debugging Coccinelle SmPL patches
204 --------------------------------- 183 ---------------------------------
205 184
206 Using coccicheck is best as it provides in the 185 Using coccicheck is best as it provides in the spatch command line
207 include options matching the options used when 186 include options matching the options used when we compile the kernel.
208 You can learn what these options are by using !! 187 You can learn what these options are by using V=1, you could then
209 manually run Coccinelle with debug options add 188 manually run Coccinelle with debug options added.
210 189
211 Alternatively you can debug running Coccinelle 190 Alternatively you can debug running Coccinelle against SmPL patches
212 by asking for stderr to be redirected to stder !! 191 by asking for stderr to be redirected to stderr, by default stderr
213 is redirected to /dev/null; if you'd like to c !! 192 is redirected to /dev/null, if you'd like to capture stderr you
214 can specify the ``DEBUG_FILE="file.txt"`` opti 193 can specify the ``DEBUG_FILE="file.txt"`` option to coccicheck. For
215 instance:: 194 instance::
216 195
217 rm -f cocci.err 196 rm -f cocci.err
218 make coccicheck COCCI=scripts/coccinelle/f 197 make coccicheck COCCI=scripts/coccinelle/free/kfree.cocci MODE=report DEBUG_FILE=cocci.err
219 cat cocci.err 198 cat cocci.err
220 199
221 You can use SPFLAGS to add debugging flags; fo !! 200 You can use SPFLAGS to add debugging flags, for instance you may want to
222 add both ``--profile --show-trying`` to SPFLAG !! 201 add both --profile --show-trying to SPFLAGS when debugging. For instance
223 you may want to use:: 202 you may want to use::
224 203
225 rm -f err.log 204 rm -f err.log
226 export COCCI=scripts/coccinelle/misc/irqf_ 205 export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci
227 make coccicheck DEBUG_FILE="err.log" MODE= !! 206 make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c
228 207
229 err.log will now have the profiling informatio 208 err.log will now have the profiling information, while stdout will
230 provide some progress information as Coccinell 209 provide some progress information as Coccinelle moves forward with
231 work. 210 work.
232 211
233 NOTE: !! 212 DEBUG_FILE support is only supported when using coccinelle >= 1.2.
234 <<
235 DEBUG_FILE support is only supported when usin <<
236 <<
237 Currently, DEBUG_FILE support is only availabl <<
238 not single files. This is because checking a s <<
239 to be called twice leading to DEBUG_FILE being <<
240 giving rise to an error. <<
241 213
242 .cocciconfig support 214 .cocciconfig support
243 -------------------- 215 --------------------
244 216
245 Coccinelle supports reading .cocciconfig for d 217 Coccinelle supports reading .cocciconfig for default Coccinelle options that
246 should be used every time spatch is spawned. T !! 218 should be used every time spatch is spawned, the order of precedence for
247 variables for .cocciconfig is as follows: 219 variables for .cocciconfig is as follows:
248 220
249 - Your current user's home directory is proces 221 - Your current user's home directory is processed first
250 - Your directory from which spatch is called i 222 - Your directory from which spatch is called is processed next
251 - The directory provided with the ``--dir`` op !! 223 - The directory provided with the --dir option is processed last, if used
252 224
253 Since coccicheck runs through make, it natural 225 Since coccicheck runs through make, it naturally runs from the kernel
254 proper dir; as such the second rule above woul !! 226 proper dir, as such the second rule above would be implied for picking up a
255 .cocciconfig when using ``make coccicheck``. 227 .cocciconfig when using ``make coccicheck``.
256 228
257 ``make coccicheck`` also supports using M= tar !! 229 ``make coccicheck`` also supports using M= targets.If you do not supply
258 any M= target, it is assumed you want to targe 230 any M= target, it is assumed you want to target the entire kernel.
259 The kernel coccicheck script has:: 231 The kernel coccicheck script has::
260 232
261 if [ "$KBUILD_EXTMOD" = "" ] ; then 233 if [ "$KBUILD_EXTMOD" = "" ] ; then
262 OPTIONS="--dir $srctree $COCCIINCLUDE" 234 OPTIONS="--dir $srctree $COCCIINCLUDE"
263 else 235 else
264 OPTIONS="--dir $KBUILD_EXTMOD $COCCIIN 236 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
265 fi 237 fi
266 238
267 KBUILD_EXTMOD is set when an explicit target w 239 KBUILD_EXTMOD is set when an explicit target with M= is used. For both cases
268 the spatch ``--dir`` argument is used, as such !! 240 the spatch --dir argument is used, as such third rule applies when whether M=
269 M= is used or not, and when M= is used the tar !! 241 is used or not, and when M= is used the target directory can have its own
270 .cocciconfig file. When M= is not passed as an 242 .cocciconfig file. When M= is not passed as an argument to coccicheck the
271 target directory is the same as the directory 243 target directory is the same as the directory from where spatch was called.
272 244
273 If not using the kernel's coccicheck target, k 245 If not using the kernel's coccicheck target, keep the above precedence
274 order logic of .cocciconfig reading. If using 246 order logic of .cocciconfig reading. If using the kernel's coccicheck target,
275 override any of the kernel's .coccicheck's set 247 override any of the kernel's .coccicheck's settings using SPFLAGS.
276 248
277 We help Coccinelle when used against Linux wit !! 249 We help Coccinelle when used against Linux with a set of sensible defaults
278 options for Linux with our own Linux .coccicon 250 options for Linux with our own Linux .cocciconfig. This hints to coccinelle
279 that git can be used for ``git grep`` queries !! 251 git can be used for ``git grep`` queries over coccigrep. A timeout of 200
280 seconds should suffice for now. 252 seconds should suffice for now.
281 253
282 The options picked up by coccinelle when readi 254 The options picked up by coccinelle when reading a .cocciconfig do not appear
283 as arguments to spatch processes running on yo !! 255 as arguments to spatch processes running on your system, to confirm what
284 options will be used by Coccinelle run:: 256 options will be used by Coccinelle run::
285 257
286 spatch --print-options-only 258 spatch --print-options-only
287 259
288 You can override with your own preferred index 260 You can override with your own preferred index option by using SPFLAGS. Take
289 note that when there are conflicting options C 261 note that when there are conflicting options Coccinelle takes precedence for
290 the last options passed. Using .cocciconfig is 262 the last options passed. Using .cocciconfig is possible to use idutils, however
291 given the order of precedence followed by Cocc 263 given the order of precedence followed by Coccinelle, since the kernel now
292 carries its own .cocciconfig, you will need to 264 carries its own .cocciconfig, you will need to use SPFLAGS to use idutils if
293 desired. See below section "Additional flags" 265 desired. See below section "Additional flags" for more details on how to use
294 idutils. 266 idutils.
295 267
296 Additional flags 268 Additional flags
297 ---------------- 269 ----------------
298 270
299 Additional flags can be passed to spatch throu 271 Additional flags can be passed to spatch through the SPFLAGS
300 variable. This works as Coccinelle respects th 272 variable. This works as Coccinelle respects the last flags
301 given to it when options are in conflict. :: 273 given to it when options are in conflict. ::
302 274
303 make SPFLAGS=--use-glimpse coccicheck 275 make SPFLAGS=--use-glimpse coccicheck
304 276
305 Coccinelle supports idutils as well but requir 277 Coccinelle supports idutils as well but requires coccinelle >= 1.0.6.
306 When no ID file is specified coccinelle assume 278 When no ID file is specified coccinelle assumes your ID database file
307 is in the file .id-utils.index on the top leve !! 279 is in the file .id-utils.index on the top level of the kernel, coccinelle
308 carries a script scripts/idutils_index.sh whic 280 carries a script scripts/idutils_index.sh which creates the database with::
309 281
310 mkid -i C --output .id-utils.index 282 mkid -i C --output .id-utils.index
311 283
312 If you have another database filename you can 284 If you have another database filename you can also just symlink with this
313 name. :: 285 name. ::
314 286
315 make SPFLAGS=--use-idutils coccicheck 287 make SPFLAGS=--use-idutils coccicheck
316 288
317 Alternatively you can specify the database fil 289 Alternatively you can specify the database filename explicitly, for
318 instance:: 290 instance::
319 291
320 make SPFLAGS="--use-idutils /full-path/to/ 292 make SPFLAGS="--use-idutils /full-path/to/ID" coccicheck
321 293
322 See ``spatch --help`` to learn more about spat 294 See ``spatch --help`` to learn more about spatch options.
323 295
324 Note that the ``--use-glimpse`` and ``--use-id 296 Note that the ``--use-glimpse`` and ``--use-idutils`` options
325 require external tools for indexing the code. 297 require external tools for indexing the code. None of them is
326 thus active by default. However, by indexing t 298 thus active by default. However, by indexing the code with
327 one of these tools, and according to the cocci 299 one of these tools, and according to the cocci file used,
328 spatch could proceed the entire code base more 300 spatch could proceed the entire code base more quickly.
329 301
330 SmPL patch specific options 302 SmPL patch specific options
331 --------------------------- 303 ---------------------------
332 304
333 SmPL patches can have their own requirements f 305 SmPL patches can have their own requirements for options passed
334 to Coccinelle. SmPL patch-specific options can !! 306 to Coccinelle. SmPL patch specific options can be provided by
335 providing them at the top of the SmPL patch, f 307 providing them at the top of the SmPL patch, for instance::
336 308
337 // Options: --no-includes --include-he 309 // Options: --no-includes --include-headers
338 310
339 SmPL patch Coccinelle requirements 311 SmPL patch Coccinelle requirements
340 ---------------------------------- 312 ----------------------------------
341 313
342 As Coccinelle features get added some more adv 314 As Coccinelle features get added some more advanced SmPL patches
343 may require newer versions of Coccinelle. If a 315 may require newer versions of Coccinelle. If an SmPL patch requires
344 a minimum version of Coccinelle, this can be s !! 316 at least a version of Coccinelle, this can be specified as follows,
345 as an example if requiring at least Coccinelle 317 as an example if requiring at least Coccinelle >= 1.0.5::
346 318
347 // Requires: 1.0.5 319 // Requires: 1.0.5
348 320
349 Proposing new semantic patches 321 Proposing new semantic patches
350 ------------------------------ !! 322 -------------------------------
351 323
352 New semantic patches can be proposed and submi 324 New semantic patches can be proposed and submitted by kernel
353 developers. For sake of clarity, they should b 325 developers. For sake of clarity, they should be organized in the
354 sub-directories of ``scripts/coccinelle/``. 326 sub-directories of ``scripts/coccinelle/``.
355 327
356 328
357 Detailed description of the ``report`` mode 329 Detailed description of the ``report`` mode
358 ------------------------------------------- 330 -------------------------------------------
359 331
360 ``report`` generates a list in the following f 332 ``report`` generates a list in the following format::
361 333
362 file:line:column-column: message 334 file:line:column-column: message
363 335
364 Example 336 Example
365 ~~~~~~~ 337 ~~~~~~~
366 338
367 Running:: 339 Running::
368 340
369 make coccicheck MODE=report COCCI=scri 341 make coccicheck MODE=report COCCI=scripts/coccinelle/api/err_cast.cocci
370 342
371 will execute the following part of the SmPL sc 343 will execute the following part of the SmPL script::
372 344
373 <smpl> 345 <smpl>
374 @r depends on !context && !patch && (org || 346 @r depends on !context && !patch && (org || report)@
375 expression x; 347 expression x;
376 position p; 348 position p;
377 @@ 349 @@
378 350
379 ERR_PTR@p(PTR_ERR(x)) 351 ERR_PTR@p(PTR_ERR(x))
380 352
381 @script:python depends on report@ 353 @script:python depends on report@
382 p << r.p; 354 p << r.p;
383 x << r.x; 355 x << r.x;
384 @@ 356 @@
385 357
386 msg="ERR_CAST can be used with %s" % (x) 358 msg="ERR_CAST can be used with %s" % (x)
387 coccilib.report.print_report(p[0], msg) 359 coccilib.report.print_report(p[0], msg)
388 </smpl> 360 </smpl>
389 361
390 This SmPL excerpt generates entries on the sta 362 This SmPL excerpt generates entries on the standard output, as
391 illustrated below:: 363 illustrated below::
392 364
393 /home/user/linux/crypto/ctr.c:188:9-16: ER 365 /home/user/linux/crypto/ctr.c:188:9-16: ERR_CAST can be used with alg
394 /home/user/linux/crypto/authenc.c:619:9-16 366 /home/user/linux/crypto/authenc.c:619:9-16: ERR_CAST can be used with auth
395 /home/user/linux/crypto/xts.c:227:9-16: ER 367 /home/user/linux/crypto/xts.c:227:9-16: ERR_CAST can be used with alg
396 368
397 369
398 Detailed description of the ``patch`` mode 370 Detailed description of the ``patch`` mode
399 ------------------------------------------ 371 ------------------------------------------
400 372
401 When the ``patch`` mode is available, it propo 373 When the ``patch`` mode is available, it proposes a fix for each problem
402 identified. 374 identified.
403 375
404 Example 376 Example
405 ~~~~~~~ 377 ~~~~~~~
406 378
407 Running:: 379 Running::
408 380
409 make coccicheck MODE=patch COCCI=scrip 381 make coccicheck MODE=patch COCCI=scripts/coccinelle/api/err_cast.cocci
410 382
411 will execute the following part of the SmPL sc 383 will execute the following part of the SmPL script::
412 384
413 <smpl> 385 <smpl>
414 @ depends on !context && patch && !org && 386 @ depends on !context && patch && !org && !report @
415 expression x; 387 expression x;
416 @@ 388 @@
417 389
418 - ERR_PTR(PTR_ERR(x)) 390 - ERR_PTR(PTR_ERR(x))
419 + ERR_CAST(x) 391 + ERR_CAST(x)
420 </smpl> 392 </smpl>
421 393
422 This SmPL excerpt generates patch hunks on the 394 This SmPL excerpt generates patch hunks on the standard output, as
423 illustrated below:: 395 illustrated below::
424 396
425 diff -u -p a/crypto/ctr.c b/crypto/ctr.c 397 diff -u -p a/crypto/ctr.c b/crypto/ctr.c
426 --- a/crypto/ctr.c 2010-05-26 10:49:38.000 398 --- a/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200
427 +++ b/crypto/ctr.c 2010-06-03 23:44:49.000 399 +++ b/crypto/ctr.c 2010-06-03 23:44:49.000000000 +0200
428 @@ -185,7 +185,7 @@ static struct crypto_i 400 @@ -185,7 +185,7 @@ static struct crypto_instance *crypto_ct
429 alg = crypto_attr_alg(tb[1], CRYPTO_AL 401 alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER,
430 CRYPTO_ALG_T 402 CRYPTO_ALG_TYPE_MASK);
431 if (IS_ERR(alg)) 403 if (IS_ERR(alg))
432 - return ERR_PTR(PTR_ERR(alg)); 404 - return ERR_PTR(PTR_ERR(alg));
433 + return ERR_CAST(alg); 405 + return ERR_CAST(alg);
434 406
435 /* Block size must be >= 4 bytes. */ 407 /* Block size must be >= 4 bytes. */
436 err = -EINVAL; 408 err = -EINVAL;
437 409
438 Detailed description of the ``context`` mode 410 Detailed description of the ``context`` mode
439 -------------------------------------------- 411 --------------------------------------------
440 412
441 ``context`` highlights lines of interest and t 413 ``context`` highlights lines of interest and their context
442 in a diff-like style. 414 in a diff-like style.
443 415
444 **NOTE**: The diff-like output generated 416 **NOTE**: The diff-like output generated is NOT an applicable patch. The
445 intent of the ``context`` mode is to hig 417 intent of the ``context`` mode is to highlight the important lines
446 (annotated with minus, ``-``) and gives 418 (annotated with minus, ``-``) and gives some surrounding context
447 lines around. This output can be used wi 419 lines around. This output can be used with the diff mode of
448 Emacs to review the code. 420 Emacs to review the code.
449 421
450 Example 422 Example
451 ~~~~~~~ 423 ~~~~~~~
452 424
453 Running:: 425 Running::
454 426
455 make coccicheck MODE=context COCCI=scr 427 make coccicheck MODE=context COCCI=scripts/coccinelle/api/err_cast.cocci
456 428
457 will execute the following part of the SmPL sc 429 will execute the following part of the SmPL script::
458 430
459 <smpl> 431 <smpl>
460 @ depends on context && !patch && !org && 432 @ depends on context && !patch && !org && !report@
461 expression x; 433 expression x;
462 @@ 434 @@
463 435
464 * ERR_PTR(PTR_ERR(x)) 436 * ERR_PTR(PTR_ERR(x))
465 </smpl> 437 </smpl>
466 438
467 This SmPL excerpt generates diff hunks on the 439 This SmPL excerpt generates diff hunks on the standard output, as
468 illustrated below:: 440 illustrated below::
469 441
470 diff -u -p /home/user/linux/crypto/ctr.c / 442 diff -u -p /home/user/linux/crypto/ctr.c /tmp/nothing
471 --- /home/user/linux/crypto/ctr.c 2010-0 443 --- /home/user/linux/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200
472 +++ /tmp/nothing 444 +++ /tmp/nothing
473 @@ -185,7 +185,6 @@ static struct crypto_i 445 @@ -185,7 +185,6 @@ static struct crypto_instance *crypto_ct
474 alg = crypto_attr_alg(tb[1], CRYPTO_AL 446 alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER,
475 CRYPTO_ALG_T 447 CRYPTO_ALG_TYPE_MASK);
476 if (IS_ERR(alg)) 448 if (IS_ERR(alg))
477 - return ERR_PTR(PTR_ERR(alg)); 449 - return ERR_PTR(PTR_ERR(alg));
478 450
479 /* Block size must be >= 4 bytes. */ 451 /* Block size must be >= 4 bytes. */
480 err = -EINVAL; 452 err = -EINVAL;
481 453
482 Detailed description of the ``org`` mode 454 Detailed description of the ``org`` mode
483 ---------------------------------------- 455 ----------------------------------------
484 456
485 ``org`` generates a report in the Org mode for 457 ``org`` generates a report in the Org mode format of Emacs.
486 458
487 Example 459 Example
488 ~~~~~~~ 460 ~~~~~~~
489 461
490 Running:: 462 Running::
491 463
492 make coccicheck MODE=org COCCI=scripts 464 make coccicheck MODE=org COCCI=scripts/coccinelle/api/err_cast.cocci
493 465
494 will execute the following part of the SmPL sc 466 will execute the following part of the SmPL script::
495 467
496 <smpl> 468 <smpl>
497 @r depends on !context && !patch && (org | 469 @r depends on !context && !patch && (org || report)@
498 expression x; 470 expression x;
499 position p; 471 position p;
500 @@ 472 @@
501 473
502 ERR_PTR@p(PTR_ERR(x)) 474 ERR_PTR@p(PTR_ERR(x))
503 475
504 @script:python depends on org@ 476 @script:python depends on org@
505 p << r.p; 477 p << r.p;
506 x << r.x; 478 x << r.x;
507 @@ 479 @@
508 480
509 msg="ERR_CAST can be used with %s" % (x) 481 msg="ERR_CAST can be used with %s" % (x)
510 msg_safe=msg.replace("[","@(").replace("]" 482 msg_safe=msg.replace("[","@(").replace("]",")")
511 coccilib.org.print_todo(p[0], msg_safe) 483 coccilib.org.print_todo(p[0], msg_safe)
512 </smpl> 484 </smpl>
513 485
514 This SmPL excerpt generates Org entries on the 486 This SmPL excerpt generates Org entries on the standard output, as
515 illustrated below:: 487 illustrated below::
516 488
517 * TODO [[view:/home/user/linux/crypto/ctr. 489 * TODO [[view:/home/user/linux/crypto/ctr.c::face=ovl-face1::linb=188::colb=9::cole=16][ERR_CAST can be used with alg]]
518 * TODO [[view:/home/user/linux/crypto/auth 490 * TODO [[view:/home/user/linux/crypto/authenc.c::face=ovl-face1::linb=619::colb=9::cole=16][ERR_CAST can be used with auth]]
519 * TODO [[view:/home/user/linux/crypto/xts. 491 * TODO [[view:/home/user/linux/crypto/xts.c::face=ovl-face1::linb=227::colb=9::cole=16][ERR_CAST can be used with alg]]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.