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