tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Merge branch 'misc' of git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild
Pull coccinelle updates from Michal Marek:
"The misc branch is reserved for Coccinelle this time:
- 'report' is the default mode
- MAINTAINERS update for Coccinelle
- documentation udate
- use new option format for spatch(1)
- J=<n> variable to mimic make -j for coccicheck
- check for missing pci_free_consistent() calls
There are some patches for rpm-pkg and deb-pkg waiting for the
3.12-rc1 merge window"
* 'misc' of git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild:
Coccinelle: Update information about the minimal version required
Coccinelle: Update the options used to the new option scheme
scripts: Coccinelle script for pci_free_consistent()
Coccinelle: Update the documentation
Coccinelle: Update section of MAINTAINERS
coccicheck: span checks across CPUs
scripts/coccinelle: check for field address argument to kfree
Coccinelle: Update the Coccinelle section of MAINTAINERS
Coccinelle: Make 'report' the default mode
+215
-75
+39
-24
Documentation/coccinelle.txt
+39
-24
Documentation/coccinelle.txt
···
6
6
Getting Coccinelle
7
7
~~~~~~~~~~~~~~~~~~~~
8
8
9
-
The semantic patches included in the kernel use the 'virtual rule'
10
-
feature which was introduced in Coccinelle version 0.1.11.
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.
11
13
12
-
Coccinelle (>=0.2.0) is available through the package manager
14
+
Coccinelle is available through the package manager
13
15
of many distributions, e.g. :
14
16
15
-
- Debian (>=squeeze)
16
-
- Fedora (>=13)
17
-
- Ubuntu (>=10.04 Lucid Lynx)
17
+
- Debian
18
+
- Fedora
19
+
- Ubuntu
18
20
- OpenSUSE
19
21
- Arch Linux
20
22
- NetBSD
···
38
36
39
37
sudo make install
40
38
41
-
The semantic patches in the kernel will work best with Coccinelle version
42
-
0.2.4 or later. Using earlier versions may incur some parse errors in the
43
-
semantic patch code, but any results that are obtained should still be
44
-
correct.
45
-
46
39
Using Coccinelle on the Linux kernel
47
40
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48
41
···
45
48
Makefile. This target is named 'coccicheck' and calls the 'coccicheck'
46
49
front-end in the 'scripts' directory.
47
50
48
-
Four modes are defined: patch, report, context, and org. The mode to
51
+
Four basic modes are defined: patch, report, context, and org. The mode to
49
52
use is specified by setting the MODE variable with 'MODE=<mode>'.
50
53
51
54
'patch' proposes a fix, when possible.
···
59
62
'org' generates a report in the Org mode format of Emacs.
60
63
61
64
Note that not all semantic patches implement all modes. For easy use
62
-
of Coccinelle, the default mode is "chain" which tries the previous
63
-
modes in the order above until one succeeds.
65
+
of Coccinelle, the default mode is "report".
64
66
65
-
To make a report for every semantic patch, run the following command:
67
+
Two other modes provide some common combinations of these modes.
66
68
67
-
make coccicheck MODE=report
69
+
'chain' tries the previous modes in the order above until one succeeds.
68
70
69
-
NB: The 'report' mode is the default one.
71
+
'rep+ctxt' runs successively the report mode and the context mode.
72
+
It should be used with the C option (described later)
73
+
which checks the code on a file basis.
70
74
71
-
To produce patches, run:
75
+
Examples:
76
+
To make a report for every semantic patch, run the following command:
72
77
73
-
make coccicheck MODE=patch
78
+
make coccicheck MODE=report
79
+
80
+
To produce patches, run:
81
+
82
+
make coccicheck MODE=patch
74
83
75
84
76
85
The coccicheck target applies every semantic patch available in the
···
93
90
To enable verbose messages set the V= variable, for example:
94
91
95
92
make coccicheck MODE=report V=1
93
+
94
+
By default, coccicheck tries to run as parallel as possible. To change
95
+
the parallelism, set the J= variable. For example, to run across 4 CPUs:
96
+
97
+
make coccicheck MODE=report J=4
96
98
97
99
98
100
Using Coccinelle with a single semantic patch
···
132
124
133
125
make C=2 CHECK="scripts/coccicheck"
134
126
127
+
In these modes, which works on a file basis, there is no information
128
+
about semantic patches displayed, and no commit message proposed.
129
+
135
130
This runs every semantic patch in scripts/coccinelle by default. The
136
131
COCCI variable may additionally be used to only apply a single
137
132
semantic patch as shown in the previous section.
138
133
139
-
The "chain" mode is the default. You can select another one with the
134
+
The "report" mode is the default. You can select another one with the
140
135
MODE variable explained above.
141
-
142
-
In this mode, there is no information about semantic patches
143
-
displayed, and no commit message proposed.
144
136
145
137
Additional flags
146
138
~~~~~~~~~~~~~~~~~~
···
148
140
Additional flags can be passed to spatch through the SPFLAGS
149
141
variable.
150
142
151
-
make SPFLAGS=--use_glimpse coccicheck
143
+
make SPFLAGS=--use-glimpse coccicheck
144
+
make SPFLAGS=--use-idutils coccicheck
152
145
153
146
See spatch --help to learn more about spatch options.
147
+
148
+
Note that the '--use-glimpse' and '--use-idutils' options
149
+
require external tools for indexing the code. None of them is
150
+
thus active by default. However, by indexing the code with
151
+
one of these tools, and according to the cocci file used,
152
+
spatch could proceed the entire code base more quickly.
154
153
155
154
Proposing new semantic patches
156
155
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+3
MAINTAINERS
+3
MAINTAINERS
···
2135
2135
M: Julia Lawall <Julia.Lawall@lip6.fr>
2136
2136
M: Gilles Muller <Gilles.Muller@lip6.fr>
2137
2137
M: Nicolas Palix <nicolas.palix@imag.fr>
2138
+
M: Michal Marek <mmarek@suse.cz>
2138
2139
L: cocci@systeme.lip6.fr (moderated for non-subscribers)
2140
+
T: git git://git.kernel.org/pub/scm/linux/kernel/git/mmarek/kbuild.git misc
2139
2141
W: http://coccinelle.lip6.fr/
2140
2142
S: Supported
2143
+
F: Documentation/coccinelle.txt
2141
2144
F: scripts/coccinelle/
2142
2145
F: scripts/coccicheck
2143
2146
+57
-19
scripts/coccicheck
+57
-19
scripts/coccicheck
···
1
1
#!/bin/bash
2
2
3
+
#
4
+
# This script requires at least spatch
5
+
# version 1.0.0-rc11.
6
+
#
7
+
3
8
SPATCH="`which ${SPATCH:=spatch}`"
9
+
10
+
trap kill_running SIGTERM SIGINT
11
+
declare -a SPATCH_PID
4
12
5
13
# The verbosity may be set by the environmental parameter V=
6
14
# as for example with 'make V=1 coccicheck'
7
15
8
16
if [ -n "$V" -a "$V" != "0" ]; then
9
-
VERBOSE=1
17
+
VERBOSE="$V"
10
18
else
11
19
VERBOSE=0
12
20
fi
13
21
14
-
FLAGS="$SPFLAGS -very_quiet"
22
+
if [ -z "$J" ]; then
23
+
NPROC=$(getconf _NPROCESSORS_ONLN)
24
+
else
25
+
NPROC="$J"
26
+
fi
27
+
28
+
FLAGS="$SPFLAGS --very-quiet"
15
29
16
30
# spatch only allows include directories with the syntax "-I include"
17
31
# while gcc also allows "-Iinclude" and "-include include"
···
41
27
else
42
28
ONLINE=0
43
29
if [ "$KBUILD_EXTMOD" = "" ] ; then
44
-
OPTIONS="-dir $srctree $COCCIINCLUDE"
30
+
OPTIONS="--dir $srctree $COCCIINCLUDE"
45
31
else
46
-
OPTIONS="-dir $KBUILD_EXTMOD $COCCIINCLUDE"
32
+
OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
47
33
fi
48
34
fi
49
35
50
36
if [ "$KBUILD_EXTMOD" != "" ] ; then
51
-
OPTIONS="-patch $srctree $OPTIONS"
37
+
OPTIONS="--patch $srctree $OPTIONS"
52
38
fi
53
39
54
40
if [ ! -x "$SPATCH" ]; then
···
58
44
59
45
if [ "$MODE" = "" ] ; then
60
46
if [ "$ONLINE" = "0" ] ; then
61
-
echo 'You have not explicitly specified the mode to use. Using default "chain" mode.'
62
-
echo 'All available modes will be tried (in that order): patch, report, context, org'
47
+
echo 'You have not explicitly specified the mode to use. Using default "report" mode.'
48
+
echo 'Available modes are the following: patch, report, context, org'
63
49
echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
50
+
echo 'Note however that some modes are not implemented by some semantic patches.'
64
51
fi
65
-
MODE="chain"
52
+
MODE="report"
53
+
fi
54
+
55
+
if [ "$MODE" = "chain" ] ; then
56
+
if [ "$ONLINE" = "0" ] ; then
57
+
echo 'You have selected the "chain" mode.'
58
+
echo 'All available modes will be tried (in that order): patch, report, context, org'
59
+
fi
66
60
elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
67
-
FLAGS="$FLAGS -no_show_diff"
61
+
FLAGS="$FLAGS --no-show-diff"
68
62
fi
69
63
70
64
if [ "$ONLINE" = "0" ] ; then
···
83
61
fi
84
62
85
63
run_cmd() {
64
+
local i
86
65
if [ $VERBOSE -ne 0 ] ; then
87
-
echo "Running: $@"
66
+
echo "Running ($NPROC in parallel): $@"
88
67
fi
89
-
eval $@
68
+
for i in $(seq 0 $(( NPROC - 1)) ); do
69
+
eval "$@ --max $NPROC --index $i &"
70
+
SPATCH_PID[$i]=$!
71
+
if [ $VERBOSE -eq 2 ] ; then
72
+
echo "${SPATCH_PID[$i]} running"
73
+
fi
74
+
done
75
+
wait
90
76
}
91
77
78
+
kill_running() {
79
+
for i in $(seq $(( NPROC - 1 )) ); do
80
+
if [ $VERBOSE -eq 2 ] ; then
81
+
echo "Killing ${SPATCH_PID[$i]}"
82
+
fi
83
+
kill ${SPATCH_PID[$i]} 2>/dev/null
84
+
done
85
+
}
92
86
93
87
coccinelle () {
94
88
COCCI="$1"
95
89
96
90
OPT=`grep "Option" $COCCI | cut -d':' -f2`
97
91
98
-
# The option '-parse_cocci' can be used to syntactically check the SmPL files.
92
+
# The option '--parse-cocci' can be used to syntactically check the SmPL files.
99
93
#
100
94
# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
101
95
···
152
114
153
115
if [ "$MODE" = "chain" ] ; then
154
116
run_cmd $SPATCH -D patch \
155
-
$FLAGS -sp_file $COCCI $OPT $OPTIONS || \
117
+
$FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
156
118
run_cmd $SPATCH -D report \
157
-
$FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || \
119
+
$FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
158
120
run_cmd $SPATCH -D context \
159
-
$FLAGS -sp_file $COCCI $OPT $OPTIONS || \
121
+
$FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
160
122
run_cmd $SPATCH -D org \
161
-
$FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || exit 1
123
+
$FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
162
124
elif [ "$MODE" = "rep+ctxt" ] ; then
163
125
run_cmd $SPATCH -D report \
164
-
$FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff && \
126
+
$FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
165
127
run_cmd $SPATCH -D context \
166
-
$FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
128
+
$FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
167
129
else
168
-
run_cmd $SPATCH -D $MODE $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
130
+
run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
169
131
fi
170
132
171
133
}
+1
-1
scripts/coccinelle/api/alloc/drop_kmalloc_cast.cocci
+1
-1
scripts/coccinelle/api/alloc/drop_kmalloc_cast.cocci
···
5
5
// Confidence: High
6
6
// Copyright: 2009,2010 Nicolas Palix, DIKU. GPLv2.
7
7
// URL: http://coccinelle.lip6.fr/
8
-
// Options: -no_includes -include_headers
8
+
// Options: --no-includes --include-headers
9
9
//
10
10
// Keywords: kmalloc, kzalloc, kcalloc
11
11
// Version min: < 2.6.12 kmalloc
+1
-1
scripts/coccinelle/api/alloc/kzalloc-simple.cocci
+1
-1
scripts/coccinelle/api/alloc/kzalloc-simple.cocci
···
9
9
// Copyright: (C) 2009-2010 Julia Lawall, Nicolas Palix, DIKU. GPLv2.
10
10
// Copyright: (C) 2009-2010 Gilles Muller, INRIA/LiP6. GPLv2.
11
11
// URL: http://coccinelle.lip6.fr/rules/kzalloc.html
12
-
// Options: -no_includes -include_headers
12
+
// Options: --no-includes --include-headers
13
13
//
14
14
// Keywords: kmalloc, kzalloc
15
15
// Version min: < 2.6.12 kmalloc
+1
-1
scripts/coccinelle/api/d_find_alias.cocci
+1
-1
scripts/coccinelle/api/d_find_alias.cocci
+1
-1
scripts/coccinelle/api/devm_request_and_ioremap.cocci
+1
-1
scripts/coccinelle/api/devm_request_and_ioremap.cocci
+1
-1
scripts/coccinelle/api/kstrdup.cocci
+1
-1
scripts/coccinelle/api/kstrdup.cocci
+1
-1
scripts/coccinelle/api/memdup.cocci
+1
-1
scripts/coccinelle/api/memdup.cocci
+1
-1
scripts/coccinelle/api/memdup_user.cocci
+1
-1
scripts/coccinelle/api/memdup_user.cocci
+1
-1
scripts/coccinelle/api/ptr_ret.cocci
+1
-1
scripts/coccinelle/api/ptr_ret.cocci
···
5
5
// Copyright: (C) 2012 Julia Lawall, INRIA/LIP6. GPLv2.
6
6
// Copyright: (C) 2012 Gilles Muller, INRIA/LiP6. GPLv2.
7
7
// URL: http://coccinelle.lip6.fr/
8
-
// Options: -no_includes -include_headers
8
+
// Options: --no-includes --include-headers
9
9
//
10
10
// Keywords: ERR_PTR, PTR_ERR, PTR_RET
11
11
// Version min: 2.6.39
+1
-1
scripts/coccinelle/api/simple_open.cocci
+1
-1
scripts/coccinelle/api/simple_open.cocci
+1
-1
scripts/coccinelle/free/devm_free.cocci
+1
-1
scripts/coccinelle/free/devm_free.cocci
+1
-1
scripts/coccinelle/free/kfree.cocci
+1
-1
scripts/coccinelle/free/kfree.cocci
+32
scripts/coccinelle/free/kfreeaddr.cocci
+32
scripts/coccinelle/free/kfreeaddr.cocci
···
1
+
/// Free of a structure field
2
+
///
3
+
// Confidence: High
4
+
// Copyright: (C) 2013 Julia Lawall, INRIA/LIP6. GPLv2.
5
+
// URL: http://coccinelle.lip6.fr/
6
+
// Comments:
7
+
// Options: --no-includes --include-headers
8
+
9
+
virtual org
10
+
virtual report
11
+
virtual context
12
+
13
+
@r depends on context || report || org @
14
+
expression e;
15
+
identifier f;
16
+
position p;
17
+
@@
18
+
19
+
* kfree@p(&e->f)
20
+
21
+
@script:python depends on org@
22
+
p << r.p;
23
+
@@
24
+
25
+
cocci.print_main("kfree",p)
26
+
27
+
@script:python depends on report@
28
+
p << r.p;
29
+
@@
30
+
31
+
msg = "ERROR: kfree of structure field"
32
+
coccilib.report.print_report(p[0],msg)
+52
scripts/coccinelle/free/pci_free_consistent.cocci
+52
scripts/coccinelle/free/pci_free_consistent.cocci
···
1
+
/// Find missing pci_free_consistent for every pci_alloc_consistent.
2
+
///
3
+
// Confidence: Moderate
4
+
// Copyright: (C) 2013 Petr Strnad. GPLv2.
5
+
// URL: http://coccinelle.lip6.fr/
6
+
// Keywords: pci_free_consistent, pci_alloc_consistent
7
+
// Options: --no-includes --include-headers
8
+
9
+
virtual report
10
+
virtual org
11
+
12
+
@search@
13
+
local idexpression id;
14
+
expression x,y,z,e;
15
+
position p1,p2;
16
+
type T;
17
+
@@
18
+
19
+
id = pci_alloc_consistent@p1(x,y,&z)
20
+
... when != e = id
21
+
if (id == NULL || ...) { ... return ...; }
22
+
... when != pci_free_consistent(x,y,id,z)
23
+
when != if (id) { ... pci_free_consistent(x,y,id,z) ... }
24
+
when != if (y) { ... pci_free_consistent(x,y,id,z) ... }
25
+
when != e = (T)id
26
+
when exists
27
+
(
28
+
return 0;
29
+
|
30
+
return 1;
31
+
|
32
+
return id;
33
+
|
34
+
return@p2 ...;
35
+
)
36
+
37
+
@script:python depends on report@
38
+
p1 << search.p1;
39
+
p2 << search.p2;
40
+
@@
41
+
42
+
msg = "ERROR: missing pci_free_consistent; pci_alloc_consistent on line %s and return without freeing on line %s" % (p1[0].line,p2[0].line)
43
+
coccilib.report.print_report(p2[0],msg)
44
+
45
+
@script:python depends on org@
46
+
p1 << search.p1;
47
+
p2 << search.p2;
48
+
@@
49
+
50
+
msg = "ERROR: missing pci_free_consistent; pci_alloc_consistent on line %s and return without freeing on line %s" % (p1[0].line,p2[0].line)
51
+
cocci.print_main(msg,p1)
52
+
cocci.print_secs("",p2)
+1
-1
scripts/coccinelle/iterators/fen.cocci
+1
-1
scripts/coccinelle/iterators/fen.cocci
+1
-1
scripts/coccinelle/iterators/itnull.cocci
+1
-1
scripts/coccinelle/iterators/itnull.cocci
+1
-1
scripts/coccinelle/iterators/list_entry_update.cocci
+1
-1
scripts/coccinelle/iterators/list_entry_update.cocci
+1
-1
scripts/coccinelle/iterators/use_after_iter.cocci
+1
-1
scripts/coccinelle/iterators/use_after_iter.cocci
+1
-1
scripts/coccinelle/locks/call_kern.cocci
+1
-1
scripts/coccinelle/locks/call_kern.cocci
+1
-1
scripts/coccinelle/locks/double_lock.cocci
+1
-1
scripts/coccinelle/locks/double_lock.cocci
+1
-1
scripts/coccinelle/locks/flags.cocci
+1
-1
scripts/coccinelle/locks/flags.cocci
+1
-1
scripts/coccinelle/locks/mini_lock.cocci
+1
-1
scripts/coccinelle/locks/mini_lock.cocci
+1
-1
scripts/coccinelle/misc/boolinit.cocci
+1
-1
scripts/coccinelle/misc/boolinit.cocci
+1
-1
scripts/coccinelle/misc/cstptr.cocci
+1
-1
scripts/coccinelle/misc/cstptr.cocci
+1
-1
scripts/coccinelle/misc/doubleinit.cocci
+1
-1
scripts/coccinelle/misc/doubleinit.cocci
···
8
8
// Copyright: (C) 2010-2012 Gilles Muller, INRIA/LiP6. GPLv2.
9
9
// URL: http://coccinelle.lip6.fr/
10
10
// Comments: requires at least Coccinelle 0.2.4, lex or parse error otherwise
11
-
// Options: -no_includes -include_headers
11
+
// Options: --no-includes --include-headers
12
12
13
13
virtual org
14
14
virtual report
+1
-1
scripts/coccinelle/misc/ifaddr.cocci
+1
-1
scripts/coccinelle/misc/ifaddr.cocci
+1
-1
scripts/coccinelle/misc/ifcol.cocci
+1
-1
scripts/coccinelle/misc/ifcol.cocci
+1
-1
scripts/coccinelle/misc/noderef.cocci
+1
-1
scripts/coccinelle/misc/noderef.cocci
+1
-1
scripts/coccinelle/misc/orplus.cocci
+1
-1
scripts/coccinelle/misc/orplus.cocci
+1
-1
scripts/coccinelle/misc/warn.cocci
+1
-1
scripts/coccinelle/misc/warn.cocci
+1
-1
scripts/coccinelle/null/eno.cocci
+1
-1
scripts/coccinelle/null/eno.cocci
+1
-1
scripts/coccinelle/null/kmerr.cocci
+1
-1
scripts/coccinelle/null/kmerr.cocci
+1
-1
scripts/coccinelle/tests/doublebitand.cocci
+1
-1
scripts/coccinelle/tests/doublebitand.cocci
+1
-1
scripts/coccinelle/tests/doubletest.cocci
+1
-1
scripts/coccinelle/tests/doubletest.cocci
+1
-1
scripts/coccinelle/tests/odd_ptr_err.cocci
+1
-1
scripts/coccinelle/tests/odd_ptr_err.cocci