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