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