Blame view
Documentation/coccinelle.txt
7.89 KB
e228b1e65 Add Documentation... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
Copyright 2010 Nicolas Palix <npalix@diku.dk> Copyright 2010 Julia Lawall <julia@diku.dk> Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr> Getting Coccinelle ~~~~~~~~~~~~~~~~~~~~ The semantic patches included in the kernel use the 'virtual rule' feature which was introduced in Coccinelle version 0.1.11. Coccinelle (>=0.2.0) is available through the package manager of many distributions, e.g. : - Debian (>=squeeze) - Fedora (>=13) |
fbe3290f4 Documentation: fi... |
17 |
- Ubuntu (>=10.04 Lucid Lynx) |
e228b1e65 Add Documentation... |
18 19 20 21 22 23 24 25 |
- OpenSUSE - Arch Linux - NetBSD - FreeBSD You can get the latest version released from the Coccinelle homepage at http://coccinelle.lip6.fr/ |
32af08987 Coccinelle: Updat... |
26 27 |
Information and tips about Coccinelle are also provided on the wiki pages at http://cocci.ekstranet.diku.dk/wiki/doku.php |
e228b1e65 Add Documentation... |
28 29 30 31 32 33 34 35 |
Once you have it, run the following command: ./configure make as a regular user, and install it with sudo make install |
a1087ef6a scripts/coccinell... |
36 37 38 39 |
The semantic patches in the kernel will work best with Coccinelle version 0.2.4 or later. Using earlier versions may incur some parse errors in the semantic patch code, but any results that are obtained should still be correct. |
e228b1e65 Add Documentation... |
40 41 42 43 44 45 46 |
Using Coccinelle on the Linux kernel ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A Coccinelle-specific target is defined in the top level Makefile. This target is named 'coccicheck' and calls the 'coccicheck' front-end in the 'scripts' directory. |
32af08987 Coccinelle: Updat... |
47 |
Four modes are defined: patch, report, context, and org. The mode to |
e228b1e65 Add Documentation... |
48 |
use is specified by setting the MODE variable with 'MODE=<mode>'. |
32af08987 Coccinelle: Updat... |
49 |
'patch' proposes a fix, when possible. |
e228b1e65 Add Documentation... |
50 51 |
'report' generates a list in the following format: file:line:column-column: message |
e228b1e65 Add Documentation... |
52 53 54 55 |
'context' highlights lines of interest and their context in a diff-like style.Lines of interest are indicated with '-'. 'org' generates a report in the Org mode format of Emacs. |
32af08987 Coccinelle: Updat... |
56 57 58 |
Note that not all semantic patches implement all modes. For easy use of Coccinelle, the default mode is "chain" which tries the previous modes in the order above until one succeeds. |
e228b1e65 Add Documentation... |
59 60 61 62 63 64 65 66 67 68 69 70 71 |
To make a report for every semantic patch, run the following command: make coccicheck MODE=report NB: The 'report' mode is the default one. To produce patches, run: make coccicheck MODE=patch The coccicheck target applies every semantic patch available in the |
32af08987 Coccinelle: Updat... |
72 |
sub-directories of 'scripts/coccinelle' to the entire Linux kernel. |
e228b1e65 Add Documentation... |
73 |
|
32af08987 Coccinelle: Updat... |
74 |
For each semantic patch, a commit message is proposed. It gives a |
e228b1e65 Add Documentation... |
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
description of the problem being checked by the semantic patch, and includes a reference to Coccinelle. As any static code analyzer, Coccinelle produces false positives. Thus, reports must be carefully checked, and patches reviewed. Using Coccinelle with a single semantic patch ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The optional make variable COCCI can be used to check a single semantic patch. In that case, the variable must be initialized with the name of the semantic patch to apply. For instance: make coccicheck COCCI=<my_SP.cocci> MODE=patch or make coccicheck COCCI=<my_SP.cocci> MODE=report |
32af08987 Coccinelle: Updat... |
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 |
Using Coccinelle on (modified) files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ To apply Coccinelle on a file basis, instead of a directory basis, the following command may be used: make C=1 CHECK="scripts/coccicheck" To check only newly edited code, use the value 2 for the C flag, i.e. make C=2 CHECK="scripts/coccicheck" This runs every semantic patch in scripts/coccinelle by default. The COCCI variable may additionally be used to only apply a single semantic patch as shown in the previous section. The "chain" mode is the default. You can select another one with the MODE variable explained above. In this mode, there is no information about semantic patches displayed, and no commit message proposed. |
e228b1e65 Add Documentation... |
116 117 118 119 120 |
Proposing new semantic patches ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ New semantic patches can be proposed and submitted by kernel developers. For sake of clarity, they should be organized in the |
32af08987 Coccinelle: Updat... |
121 |
sub-directories of 'scripts/coccinelle/'. |
e228b1e65 Add Documentation... |
122 123 124 125 126 127 128 129 130 131 132 |
Detailed description of the 'report' mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 'report' generates a list in the following format: file:line:column-column: message Example: Running |
9dcf7990c Coccinelle: Fix d... |
133 |
make coccicheck MODE=report COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e65 Add Documentation... |
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
will execute the following part of the SmPL script. <smpl> @r depends on !context && !patch && (org || report)@ expression x; position p; @@ ERR_PTR@p(PTR_ERR(x)) @script:python depends on report@ p << r.p; x << r.x; @@ msg="ERR_CAST can be used with %s" % (x) coccilib.report.print_report(p[0], msg) </smpl> This SmPL excerpt generates entries on the standard output, as illustrated below: /home/user/linux/crypto/ctr.c:188:9-16: ERR_CAST can be used with alg /home/user/linux/crypto/authenc.c:619:9-16: ERR_CAST can be used with auth /home/user/linux/crypto/xts.c:227:9-16: ERR_CAST can be used with alg Detailed description of the 'patch' mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When the 'patch' mode is available, it proposes a fix for each problem identified. Example: Running |
9dcf7990c Coccinelle: Fix d... |
171 |
make coccicheck MODE=patch COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e65 Add Documentation... |
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
will execute the following part of the SmPL script. <smpl> @ depends on !context && patch && !org && !report @ expression x; @@ - ERR_PTR(PTR_ERR(x)) + ERR_CAST(x) </smpl> This SmPL excerpt generates patch hunks on the standard output, as illustrated below: diff -u -p a/crypto/ctr.c b/crypto/ctr.c --- a/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200 +++ b/crypto/ctr.c 2010-06-03 23:44:49.000000000 +0200 @@ -185,7 +185,7 @@ static struct crypto_instance *crypto_ct alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER, CRYPTO_ALG_TYPE_MASK); if (IS_ERR(alg)) - return ERR_PTR(PTR_ERR(alg)); + return ERR_CAST(alg); /* Block size must be >= 4 bytes. */ err = -EINVAL; Detailed description of the 'context' mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 'context' highlights lines of interest and their context in a diff-like style. NOTE: The diff-like output generated is NOT an applicable patch. The intent of the 'context' mode is to highlight the important lines (annotated with minus, '-') and gives some surrounding context lines around. This output can be used with the diff mode of Emacs to review the code. Example: Running |
9dcf7990c Coccinelle: Fix d... |
215 |
make coccicheck MODE=context COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e65 Add Documentation... |
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
will execute the following part of the SmPL script. <smpl> @ depends on context && !patch && !org && !report@ expression x; @@ * ERR_PTR(PTR_ERR(x)) </smpl> This SmPL excerpt generates diff hunks on the standard output, as illustrated below: diff -u -p /home/user/linux/crypto/ctr.c /tmp/nothing --- /home/user/linux/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200 +++ /tmp/nothing @@ -185,7 +185,6 @@ static struct crypto_instance *crypto_ct alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER, CRYPTO_ALG_TYPE_MASK); if (IS_ERR(alg)) - return ERR_PTR(PTR_ERR(alg)); /* Block size must be >= 4 bytes. */ err = -EINVAL; Detailed description of the 'org' mode ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 'org' generates a report in the Org mode format of Emacs. Example: Running |
9dcf7990c Coccinelle: Fix d... |
250 |
make coccicheck MODE=org COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e65 Add Documentation... |
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
will execute the following part of the SmPL script. <smpl> @r depends on !context && !patch && (org || report)@ expression x; position p; @@ ERR_PTR@p(PTR_ERR(x)) @script:python depends on org@ p << r.p; x << r.x; @@ msg="ERR_CAST can be used with %s" % (x) msg_safe=msg.replace("[","@(").replace("]",")") coccilib.org.print_todo(p[0], msg_safe) </smpl> This SmPL excerpt generates Org entries on the standard output, as illustrated below: * TODO [[view:/home/user/linux/crypto/ctr.c::face=ovl-face1::linb=188::colb=9::cole=16][ERR_CAST can be used with alg]] * TODO [[view:/home/user/linux/crypto/authenc.c::face=ovl-face1::linb=619::colb=9::cole=16][ERR_CAST can be used with auth]] * TODO [[view:/home/user/linux/crypto/xts.c::face=ovl-face1::linb=227::colb=9::cole=16][ERR_CAST can be used with alg]] |