]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - scripts/coccicheck
Merge tag 'for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mst/vhost
[mirror_ubuntu-zesty-kernel.git] / scripts / coccicheck
CommitLineData
9e395550 1#!/bin/bash
c100d537
LR
2# Linux kernel coccicheck
3#
4# Read Documentation/coccinelle.txt
ec97946e
NP
5#
6# This script requires at least spatch
7# version 1.0.0-rc11.
ec97946e 8
a9e064c0 9DIR="$(dirname $(readlink -f $0))/.."
74425eee
NP
10SPATCH="`which ${SPATCH:=spatch}`"
11
13d94865
LR
12if [ ! -x "$SPATCH" ]; then
13 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
14 exit 1
15fi
16
a9e064c0
LR
17SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')
18SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)
19
c930a1b2
LR
20USE_JOBS="no"
21$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes"
90d06a46 22
26e56720
BS
23# The verbosity may be set by the environmental parameter V=
24# as for example with 'make V=1 coccicheck'
25
26if [ -n "$V" -a "$V" != "0" ]; then
90d06a46 27 VERBOSE="$V"
26e56720
BS
28else
29 VERBOSE=0
30fi
31
90d06a46
KC
32if [ -z "$J" ]; then
33 NPROC=$(getconf _NPROCESSORS_ONLN)
34else
35 NPROC="$J"
36fi
37
8e826ad5 38FLAGS="--very-quiet"
9e395550 39
5c384dba
LR
40# You can use SPFLAGS to append extra arguments to coccicheck or override any
41# heuristics done in this file as Coccinelle accepts the last options when
42# options conflict.
43#
44# A good example for use of SPFLAGS is if you want to debug your cocci script,
45# you can for instance use the following:
46#
47# $ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci
48# $ make coccicheck MODE=report DEBUG_FILE="all.err" SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c
49#
50# "--show-trying" should show you what rule is being processed as it goes to
51# stdout, you do not need a debug file for that. The profile output will be
52# be sent to stdout, if you provide a DEBUG_FILE the profiling data can be
53# inspected there.
54#
55# --profile will not output if --very-quiet is used, so avoid it.
56echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null
57if [ $? -eq 0 ]; then
58 FLAGS="--quiet"
59fi
60
9e395550
NP
61# spatch only allows include directories with the syntax "-I include"
62# while gcc also allows "-Iinclude" and "-include include"
63COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
5b169108 64COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
9e395550 65
1e9dea2a
NP
66if [ "$C" = "1" -o "$C" = "2" ]; then
67 ONLINE=1
68
9e395550
NP
69 # Take only the last argument, which is the C file to test
70 shift $(( $# - 1 ))
71 OPTIONS="$COCCIINCLUDE $1"
1e9dea2a
NP
72else
73 ONLINE=0
d0bc1fb4 74 if [ "$KBUILD_EXTMOD" = "" ] ; then
93f14468 75 OPTIONS="--dir $srctree $COCCIINCLUDE"
d0bc1fb4 76 else
93f14468 77 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
d0bc1fb4 78 fi
1e9dea2a
NP
79fi
80
bad6a409 81if [ "$KBUILD_EXTMOD" != "" ] ; then
93f14468 82 OPTIONS="--patch $srctree $OPTIONS"
bad6a409
NP
83fi
84
c930a1b2
LR
85# You can override by using SPFLAGS
86if [ "$USE_JOBS" = "no" ]; then
87 trap kill_running SIGTERM SIGINT
88 declare -a SPATCH_PID
89elif [ "$NPROC" != "1" ]; then
90 # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on
91 # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c
92 OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1"
93fi
94
74425eee 95if [ "$MODE" = "" ] ; then
1e9dea2a 96 if [ "$ONLINE" = "0" ] ; then
1f0a6742
NP
97 echo 'You have not explicitly specified the mode to use. Using default "report" mode.'
98 echo 'Available modes are the following: patch, report, context, org'
1e9dea2a 99 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
1f0a6742
NP
100 echo 'Note however that some modes are not implemented by some semantic patches.'
101 fi
102 MODE="report"
103fi
104
105if [ "$MODE" = "chain" ] ; then
106 if [ "$ONLINE" = "0" ] ; then
107 echo 'You have selected the "chain" mode.'
108 echo 'All available modes will be tried (in that order): patch, report, context, org'
1e9dea2a 109 fi
03ee0c42 110elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
7a2358b3 111 FLAGS="--no-show-diff $FLAGS"
74425eee
NP
112fi
113
1e9dea2a
NP
114if [ "$ONLINE" = "0" ] ; then
115 echo ''
116 echo 'Please check for false positives in the output before submitting a patch.'
117 echo 'When using "patch" mode, carefully review the patch before submitting it.'
118 echo ''
119fi
74425eee 120
c930a1b2
LR
121run_cmd_parmap() {
122 if [ $VERBOSE -ne 0 ] ; then
123 echo "Running ($NPROC in parallel): $@"
124 fi
be1fa900
LR
125 if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then
126 if [ -f $DEBUG_FILE ]; then
127 echo "Debug file $DEBUG_FILE exists, bailing"
128 exit
129 fi
130 else
131 DEBUG_FILE="/dev/null"
132 fi
133 $@ 2>$DEBUG_FILE
c930a1b2
LR
134 if [[ $? -ne 0 ]]; then
135 echo "coccicheck failed"
136 exit $?
137 fi
138}
139
140run_cmd_old() {
90d06a46 141 local i
5303265a 142 if [ $VERBOSE -ne 0 ] ; then
90d06a46 143 echo "Running ($NPROC in parallel): $@"
5303265a 144 fi
90d06a46 145 for i in $(seq 0 $(( NPROC - 1)) ); do
93f14468 146 eval "$@ --max $NPROC --index $i &"
90d06a46
KC
147 SPATCH_PID[$i]=$!
148 if [ $VERBOSE -eq 2 ] ; then
149 echo "${SPATCH_PID[$i]} running"
150 fi
151 done
152 wait
5303265a
BS
153}
154
c930a1b2
LR
155run_cmd() {
156 if [ "$USE_JOBS" = "yes" ]; then
157 run_cmd_parmap $@
158 else
159 run_cmd_old $@
160 fi
161}
162
90d06a46 163kill_running() {
2552a39f 164 for i in $(seq 0 $(( NPROC - 1 )) ); do
90d06a46
KC
165 if [ $VERBOSE -eq 2 ] ; then
166 echo "Killing ${SPATCH_PID[$i]}"
167 fi
168 kill ${SPATCH_PID[$i]} 2>/dev/null
169 done
170}
5303265a 171
8e826ad5
LR
172# You can override heuristics with SPFLAGS, these must always go last
173OPTIONS="$OPTIONS $SPFLAGS"
174
1e9dea2a 175coccinelle () {
74425eee 176 COCCI="$1"
74425eee
NP
177
178 OPT=`grep "Option" $COCCI | cut -d':' -f2`
a9e064c0
LR
179 REQ=`grep "Requires" $COCCI | cut -d':' -f2 | sed "s| ||"`
180 REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh)
181 if [ "$REQ_NUM" != "0" ] ; then
182 if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then
183 echo "Skipping coccinele SmPL patch: $COCCI"
184 echo "You have coccinelle: $SPATCH_VERSION"
185 echo "This SmPL patch requires: $REQ"
186 return
187 fi
188 fi
74425eee 189
93f14468 190# The option '--parse-cocci' can be used to syntactically check the SmPL files.
1e9dea2a
NP
191#
192# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
74425eee 193
35d88a38 194 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
74425eee 195
1e9dea2a 196 FILE=`echo $COCCI | sed "s|$srctree/||"`
74425eee 197
3c908417
NP
198 echo "Processing `basename $COCCI`"
199 echo "with option(s) \"$OPT\""
200 echo ''
1e9dea2a
NP
201 echo 'Message example to submit a patch:'
202
3c908417 203 sed -ne 's|^///||p' $COCCI
1e9dea2a 204
062c1825
NP
205 if [ "$MODE" = "patch" ] ; then
206 echo ' The semantic patch that makes this change is available'
207 elif [ "$MODE" = "report" ] ; then
208 echo ' The semantic patch that makes this report is available'
209 elif [ "$MODE" = "context" ] ; then
210 echo ' The semantic patch that spots this code is available'
211 elif [ "$MODE" = "org" ] ; then
212 echo ' The semantic patch that makes this Org report is available'
213 else
214 echo ' The semantic patch that makes this output is available'
215 fi
1e9dea2a
NP
216 echo " in $FILE."
217 echo ''
218 echo ' More information about semantic patching is available at'
219 echo ' http://coccinelle.lip6.fr/'
220 echo ''
221
3c908417
NP
222 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
223 echo 'Semantic patch information:'
224 sed -ne 's|^//#||p' $COCCI
225 echo ''
226 fi
2c1160c8 227 fi
3c908417 228
2c1160c8 229 if [ "$MODE" = "chain" ] ; then
5303265a 230 run_cmd $SPATCH -D patch \
93f14468 231 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
5303265a 232 run_cmd $SPATCH -D report \
93f14468 233 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
5303265a 234 run_cmd $SPATCH -D context \
93f14468 235 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
5303265a 236 run_cmd $SPATCH -D org \
93f14468 237 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
c05cd6dd 238 elif [ "$MODE" = "rep+ctxt" ] ; then
5303265a 239 run_cmd $SPATCH -D report \
93f14468 240 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
5303265a 241 run_cmd $SPATCH -D context \
93f14468 242 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
1e9dea2a 243 else
93f14468 244 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
1e9dea2a 245 fi
74425eee 246
74425eee
NP
247}
248
249if [ "$COCCI" = "" ] ; then
250 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
1e9dea2a 251 coccinelle $f
74425eee
NP
252 done
253else
1e9dea2a 254 coccinelle $COCCI
74425eee 255fi