Documentation/coccinelle.txt

   1 Copyright 2010 Nicolas Palix <npalix@diku.dk>
   2 Copyright 2010 Julia Lawall <julia@diku.dk>
   3 Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr>
   4
   5
   6  Getting Coccinelle
   7 ~~~~~~~~~~~~~~~~~~~~
   8
   9 The semantic patches included in the kernel use features and options
  10 which are provided by Coccinelle version 1.0.0-rc11 and above.
  11 Using earlier versions will fail as the option names used by
  12 the Coccinelle files and coccicheck have been updated.
  13
  14 Coccinelle is available through the package manager
  15 of many distributions, e.g. :
  16
  17  - Debian
  18  - Fedora
  19  - Ubuntu
  20  - OpenSUSE
  21  - Arch Linux
  22  - NetBSD
  23  - FreeBSD
  24
  25
  26 You can get the latest version released from the Coccinelle homepage at
  27 http://coccinelle.lip6.fr/
  28
  29 Information and tips about Coccinelle are also provided on the wiki
  30 pages at http://cocci.ekstranet.diku.dk/wiki/doku.php
  31
  32 Once you have it, run the following command:
  33
  34         ./configure
  35         make
  36
  37 as a regular user, and install it with
  38
  39         sudo make install
  40
  41  Using Coccinelle on the Linux kernel
  42 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  43
  44 A Coccinelle-specific target is defined in the top level
  45 Makefile. This target is named 'coccicheck' and calls the 'coccicheck'
  46 front-end in the 'scripts' directory.
  47
  48 Four basic modes are defined: patch, report, context, and org. The mode to
  49 use is specified by setting the MODE variable with 'MODE=<mode>'.
  50
  51 'patch' proposes a fix, when possible.
  52
  53 'report' generates a list in the following format:
  54   file:line:column-column: message
  55
  56 'context' highlights lines of interest and their context in a
  57 diff-like style.Lines of interest are indicated with '-'.
  58
  59 'org' generates a report in the Org mode format of Emacs.
  60
  61 Note that not all semantic patches implement all modes. For easy use
  62 of Coccinelle, the default mode is "report".
  63
  64 Two other modes provide some common combinations of these modes.
  65
  66 'chain' tries the previous modes in the order above until one succeeds.
  67
  68 'rep+ctxt' runs successively the report mode and the context mode.
  69            It should be used with the C option (described later)
  70            which checks the code on a file basis.
  71
  72 Examples:
  73         To make a report for every semantic patch, run the following command:
  74
  75                 make coccicheck MODE=report
  76
  77         To produce patches, run:
  78
  79                 make coccicheck MODE=patch
  80
  81
  82 The coccicheck target applies every semantic patch available in the
  83 sub-directories of 'scripts/coccinelle' to the entire Linux kernel.
  84
  85 For each semantic patch, a commit message is proposed.  It gives a
  86 description of the problem being checked by the semantic patch, and
  87 includes a reference to Coccinelle.
  88
  89 As any static code analyzer, Coccinelle produces false
  90 positives. Thus, reports must be carefully checked, and patches
  91 reviewed.
  92
  93 To enable verbose messages set the V= variable, for example:
  94
  95    make coccicheck MODE=report V=1
  96
  97  Coccinelle parallelization
  98 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  99
 100 By default, coccicheck tries to run as parallel as possible. To change
 101 the parallelism, set the J= variable. For example, to run across 4 CPUs:
 102
 103    make coccicheck MODE=report J=4
 104
 105 As of Coccinelle 1.0.2 Coccinelle uses Ocaml parmap for parallelization,
 106 if support for this is detected you will benefit from parmap parallelization.
 107
 108 When parmap is enabled coccicheck will enable dynamic load balancing by using
 109 '--chunksize 1' argument, this ensures we keep feeding threads with work
 110 one by one, so that we avoid the situation where most work gets done by only
 111 a few threads. With dynamic load balancing, if a thread finishes early we keep
 112 feeding it more work.
 113
 114 When parmap is enabled, if an error occurs in Coccinelle, this error
 115 value is propagated back, the return value of the 'make coccicheck'
 116 captures this return value.
 117
 118  Using Coccinelle with a single semantic patch
 119 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 120
 121 The optional make variable COCCI can be used to check a single
 122 semantic patch. In that case, the variable must be initialized with
 123 the name of the semantic patch to apply.
 124
 125 For instance:
 126
 127         make coccicheck COCCI=<my_SP.cocci> MODE=patch
 128 or
 129         make coccicheck COCCI=<my_SP.cocci> MODE=report
 130
 131
 132  Controlling Which Files are Processed by Coccinelle
 133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 134 By default the entire kernel source tree is checked.
 135
 136 To apply Coccinelle to a specific directory, M= can be used.
 137 For example, to check drivers/net/wireless/ one may write:
 138
 139     make coccicheck M=drivers/net/wireless/
 140
 141 To apply Coccinelle on a file basis, instead of a directory basis, the
 142 following command may be used:
 143
 144     make C=1 CHECK="scripts/coccicheck"
 145
 146 To check only newly edited code, use the value 2 for the C flag, i.e.
 147
 148     make C=2 CHECK="scripts/coccicheck"
 149
 150 In these modes, which works on a file basis, there is no information
 151 about semantic patches displayed, and no commit message proposed.
 152
 153 This runs every semantic patch in scripts/coccinelle by default. The
 154 COCCI variable may additionally be used to only apply a single
 155 semantic patch as shown in the previous section.
 156
 157 The "report" mode is the default. You can select another one with the
 158 MODE variable explained above.
 159
 160  Debugging Coccinelle SmPL patches
 161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 162
 163 Using coccicheck is best as it provides in the spatch command line
 164 include options matching the options used when we compile the kernel.
 165 You can learn what these options are by using V=1, you could then
 166 manually run Coccinelle with debug options added.
 167
 168 Alternatively you can debug running Coccinelle against SmPL patches
 169 by asking for stderr to be redirected to stderr, by default stderr
 170 is redirected to /dev/null, if you'd like to capture stderr you
 171 can specify the DEBUG_FILE="file.txt" option to coccicheck. For
 172 instance:
 173
 174     rm -f cocci.err
 175     make coccicheck COCCI=scripts/coccinelle/free/kfree.cocci MODE=report DEBUG_FILE=cocci.err
 176     cat cocci.err
 177
 178 DEBUG_FILE support is only supported when using coccinelle >= 1.2.
 179
 180  Additional flags
 181 ~~~~~~~~~~~~~~~~~~
 182
 183 Additional flags can be passed to spatch through the SPFLAGS
 184 variable. This works as Coccinelle respects the last flags
 185 given to it when options are in conflict.
 186
 187     make SPFLAGS=--use-glimpse coccicheck
 188     make SPFLAGS=--use-idutils coccicheck
 189
 190 See spatch --help to learn more about spatch options.
 191
 192 Note that the '--use-glimpse' and '--use-idutils' options
 193 require external tools for indexing the code. None of them is
 194 thus active by default. However, by indexing the code with
 195 one of these tools, and according to the cocci file used,
 196 spatch could proceed the entire code base more quickly.
 197
 198  Proposing new semantic patches
 199 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 200
 201 New semantic patches can be proposed and submitted by kernel
 202 developers. For sake of clarity, they should be organized in the
 203 sub-directories of 'scripts/coccinelle/'.
 204
 205
 206  Detailed description of the 'report' mode
 207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 208
 209 'report' generates a list in the following format:
 210   file:line:column-column: message
 211
 212 Example:
 213
 214 Running
 215
 216         make coccicheck MODE=report COCCI=scripts/coccinelle/api/err_cast.cocci
 217
 218 will execute the following part of the SmPL script.
 219
 220 <smpl>
 221 @r depends on !context && !patch && (org || report)@
 222 expression x;
 223 position p;
 224 @@
 225
 226  ERR_PTR@p(PTR_ERR(x))
 227
 228 @script:python depends on report@
 229 p << r.p;
 230 x << r.x;
 231 @@
 232
 233 msg="ERR_CAST can be used with %s" % (x)
 234 coccilib.report.print_report(p[0], msg)
 235 </smpl>
 236
 237 This SmPL excerpt generates entries on the standard output, as
 238 illustrated below:
 239
 240 /home/user/linux/crypto/ctr.c:188:9-16: ERR_CAST can be used with alg
 241 /home/user/linux/crypto/authenc.c:619:9-16: ERR_CAST can be used with auth
 242 /home/user/linux/crypto/xts.c:227:9-16: ERR_CAST can be used with alg
 243
 244
 245  Detailed description of the 'patch' mode
 246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 247
 248 When the 'patch' mode is available, it proposes a fix for each problem
 249 identified.
 250
 251 Example:
 252
 253 Running
 254         make coccicheck MODE=patch COCCI=scripts/coccinelle/api/err_cast.cocci
 255
 256 will execute the following part of the SmPL script.
 257
 258 <smpl>
 259 @ depends on !context && patch && !org && !report @
 260 expression x;
 261 @@
 262
 263 - ERR_PTR(PTR_ERR(x))
 264 + ERR_CAST(x)
 265 </smpl>
 266
 267 This SmPL excerpt generates patch hunks on the standard output, as
 268 illustrated below:
 269
 270 diff -u -p a/crypto/ctr.c b/crypto/ctr.c
 271 --- a/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200
 272 +++ b/crypto/ctr.c 2010-06-03 23:44:49.000000000 +0200
 273 @@ -185,7 +185,7 @@ static struct crypto_instance *crypto_ct
 274         alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER,
 275                                   CRYPTO_ALG_TYPE_MASK);
 276         if (IS_ERR(alg))
 277 -               return ERR_PTR(PTR_ERR(alg));
 278 +               return ERR_CAST(alg);
 279
 280         /* Block size must be >= 4 bytes. */
 281         err = -EINVAL;
 282
 283  Detailed description of the 'context' mode
 284 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 285
 286 'context' highlights lines of interest and their context
 287 in a diff-like style.
 288
 289 NOTE: The diff-like output generated is NOT an applicable patch. The
 290       intent of the 'context' mode is to highlight the important lines
 291       (annotated with minus, '-') and gives some surrounding context
 292       lines around. This output can be used with the diff mode of
 293       Emacs to review the code.
 294
 295 Example:
 296
 297 Running
 298         make coccicheck MODE=context COCCI=scripts/coccinelle/api/err_cast.cocci
 299
 300 will execute the following part of the SmPL script.
 301
 302 <smpl>
 303 @ depends on context && !patch && !org && !report@
 304 expression x;
 305 @@
 306
 307 * ERR_PTR(PTR_ERR(x))
 308 </smpl>
 309
 310 This SmPL excerpt generates diff hunks on the standard output, as
 311 illustrated below:
 312
 313 diff -u -p /home/user/linux/crypto/ctr.c /tmp/nothing
 314 --- /home/user/linux/crypto/ctr.c       2010-05-26 10:49:38.000000000 +0200
 315 +++ /tmp/nothing
 316 @@ -185,7 +185,6 @@ static struct crypto_instance *crypto_ct
 317         alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER,
 318                                   CRYPTO_ALG_TYPE_MASK);
 319         if (IS_ERR(alg))
 320 -               return ERR_PTR(PTR_ERR(alg));
 321
 322         /* Block size must be >= 4 bytes. */
 323         err = -EINVAL;
 324
 325  Detailed description of the 'org' mode
 326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 327
 328 'org' generates a report in the Org mode format of Emacs.
 329
 330 Example:
 331
 332 Running
 333         make coccicheck MODE=org COCCI=scripts/coccinelle/api/err_cast.cocci
 334
 335 will execute the following part of the SmPL script.
 336
 337 <smpl>
 338 @r depends on !context && !patch && (org || report)@
 339 expression x;
 340 position p;
 341 @@
 342
 343  ERR_PTR@p(PTR_ERR(x))
 344
 345 @script:python depends on org@
 346 p << r.p;
 347 x << r.x;
 348 @@
 349
 350 msg="ERR_CAST can be used with %s" % (x)
 351 msg_safe=msg.replace("[","@(").replace("]",")")
 352 coccilib.org.print_todo(p[0], msg_safe)
 353 </smpl>
 354
 355 This SmPL excerpt generates Org entries on the standard output, as
 356 illustrated below:
 357
 358 * TODO [[view:/home/user/linux/crypto/ctr.c::face=ovl-face1::linb=188::colb=9::cole=16][ERR_CAST can be used with alg]]
 359 * TODO [[view:/home/user/linux/crypto/authenc.c::face=ovl-face1::linb=619::colb=9::cole=16][ERR_CAST can be used with auth]]
 360 * TODO [[view:/home/user/linux/crypto/xts.c::face=ovl-face1::linb=227::colb=9::cole=16][ERR_CAST can be used with alg]]