blob: e04d328210ac2bd55c946230f2c8f3a9fc2ba38d [file] [log] [blame]
Nicolas Palix9e395552013-03-02 22:36:26 +01001#!/bin/bash
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01002# SPDX-License-Identifier: GPL-2.0
Luis R. Rodriguezc100d532016-06-29 15:14:58 -07003# Linux kernel coccicheck
4#
Markus Elfring1e018922016-10-07 16:06:15 +02005# Read Documentation/dev-tools/coccinelle.rst
Nicolas Palixec979462013-07-03 16:41:01 +02006#
7# This script requires at least spatch
8# version 1.0.0-rc11.
Nicolas Palixec979462013-07-03 16:41:01 +02009
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -070010DIR="$(dirname $(readlink -f $0))/.."
Nicolas Palix74425ee2010-06-06 17:15:01 +020011SPATCH="`which ${SPATCH:=spatch}`"
12
Luis R. Rodriguez13d94862016-06-29 15:14:51 -070013if [ ! -x "$SPATCH" ]; then
14 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
15 exit 1
16fi
17
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -070018SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')
19SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)
20
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -070021USE_JOBS="no"
22$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes"
Kees Cook90d06a42013-06-18 14:49:29 -070023
Bernd Schubert26e56722013-01-29 17:03:37 +010024# The verbosity may be set by the environmental parameter V=
25# as for example with 'make V=1 coccicheck'
26
27if [ -n "$V" -a "$V" != "0" ]; then
Kees Cook90d06a42013-06-18 14:49:29 -070028 VERBOSE="$V"
Bernd Schubert26e56722013-01-29 17:03:37 +010029else
30 VERBOSE=0
31fi
32
Luis R. Rodriguez8e826ad2016-06-29 15:14:52 -070033FLAGS="--very-quiet"
Nicolas Palix9e395552013-03-02 22:36:26 +010034
Luis R. Rodriguez5c384db2016-06-29 15:14:55 -070035# You can use SPFLAGS to append extra arguments to coccicheck or override any
36# heuristics done in this file as Coccinelle accepts the last options when
37# options conflict.
38#
39# A good example for use of SPFLAGS is if you want to debug your cocci script,
40# you can for instance use the following:
41#
42# $ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci
43# $ make coccicheck MODE=report DEBUG_FILE="all.err" SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c
44#
45# "--show-trying" should show you what rule is being processed as it goes to
46# stdout, you do not need a debug file for that. The profile output will be
47# be sent to stdout, if you provide a DEBUG_FILE the profiling data can be
48# inspected there.
49#
50# --profile will not output if --very-quiet is used, so avoid it.
51echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null
52if [ $? -eq 0 ]; then
53 FLAGS="--quiet"
54fi
55
Nicolas Palix9e395552013-03-02 22:36:26 +010056# spatch only allows include directories with the syntax "-I include"
57# while gcc also allows "-Iinclude" and "-include include"
58COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
Andrzej Hajda5b169102015-09-22 15:15:30 +020059COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
Nicolas Palix9e395552013-03-02 22:36:26 +010060
Nicolas Palix1e9dea22010-06-13 09:26:34 +020061if [ "$C" = "1" -o "$C" = "2" ]; then
62 ONLINE=1
63
Nicolas Palix9e395552013-03-02 22:36:26 +010064 # Take only the last argument, which is the C file to test
65 shift $(( $# - 1 ))
66 OPTIONS="$COCCIINCLUDE $1"
Masahiro Yamadad7059ca2017-11-14 20:38:07 +090067
68 # No need to parallelize Coccinelle since this mode takes one input file.
69 NPROC=1
Nicolas Palix1e9dea22010-06-13 09:26:34 +020070else
71 ONLINE=0
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050072 if [ "$KBUILD_EXTMOD" = "" ] ; then
Nicolas Palix93f14462013-06-20 13:10:56 +020073 OPTIONS="--dir $srctree $COCCIINCLUDE"
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050074 else
Nicolas Palix93f14462013-06-20 13:10:56 +020075 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050076 fi
Masahiro Yamadad7059ca2017-11-14 20:38:07 +090077
78 if [ -z "$J" ]; then
79 NPROC=$(getconf _NPROCESSORS_ONLN)
80 else
81 NPROC="$J"
82 fi
Nicolas Palix1e9dea22010-06-13 09:26:34 +020083fi
84
Nicolas Palixbad6a402013-03-02 22:36:28 +010085if [ "$KBUILD_EXTMOD" != "" ] ; then
Nicolas Palix93f14462013-06-20 13:10:56 +020086 OPTIONS="--patch $srctree $OPTIONS"
Nicolas Palixbad6a402013-03-02 22:36:28 +010087fi
88
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -070089# You can override by using SPFLAGS
90if [ "$USE_JOBS" = "no" ]; then
91 trap kill_running SIGTERM SIGINT
92 declare -a SPATCH_PID
93elif [ "$NPROC" != "1" ]; then
94 # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on
95 # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c
96 OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1"
97fi
98
Nicolas Palix74425ee2010-06-06 17:15:01 +020099if [ "$MODE" = "" ] ; then
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200100 if [ "$ONLINE" = "0" ] ; then
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200101 echo 'You have not explicitly specified the mode to use. Using default "report" mode.'
102 echo 'Available modes are the following: patch, report, context, org'
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200103 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200104 echo 'Note however that some modes are not implemented by some semantic patches.'
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200105 fi
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200106 MODE="report"
107fi
108
109if [ "$MODE" = "chain" ] ; then
110 if [ "$ONLINE" = "0" ] ; then
111 echo 'You have selected the "chain" mode.'
112 echo 'All available modes will be tried (in that order): patch, report, context, org'
113 fi
Nicolas Palix03ee0c42010-10-08 21:27:41 +0200114elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
Deepa Dinamani7a2358b2016-06-12 12:04:39 -0700115 FLAGS="--no-show-diff $FLAGS"
Nicolas Palix74425ee2010-06-06 17:15:01 +0200116fi
117
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200118if [ "$ONLINE" = "0" ] ; then
119 echo ''
120 echo 'Please check for false positives in the output before submitting a patch.'
121 echo 'When using "patch" mode, carefully review the patch before submitting it.'
122 echo ''
123fi
Nicolas Palix74425ee2010-06-06 17:15:01 +0200124
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700125run_cmd_parmap() {
126 if [ $VERBOSE -ne 0 ] ; then
127 echo "Running ($NPROC in parallel): $@"
128 fi
Julia Lawall9ed07ad2017-10-15 11:55:53 +0200129 echo $@ >>$DEBUG_FILE
130 $@ 2>>$DEBUG_FILE
Denis Efremov512ddf72018-08-10 23:25:55 +0300131 err=$?
132 if [[ $err -ne 0 ]]; then
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700133 echo "coccicheck failed"
Denis Efremov512ddf72018-08-10 23:25:55 +0300134 exit $err
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700135 fi
136}
137
138run_cmd_old() {
Kees Cook90d06a42013-06-18 14:49:29 -0700139 local i
Bernd Schubert53032652013-01-29 17:03:42 +0100140 if [ $VERBOSE -ne 0 ] ; then
Kees Cook90d06a42013-06-18 14:49:29 -0700141 echo "Running ($NPROC in parallel): $@"
Bernd Schubert53032652013-01-29 17:03:42 +0100142 fi
Kees Cook90d06a42013-06-18 14:49:29 -0700143 for i in $(seq 0 $(( NPROC - 1)) ); do
Nicolas Palix93f14462013-06-20 13:10:56 +0200144 eval "$@ --max $NPROC --index $i &"
Kees Cook90d06a42013-06-18 14:49:29 -0700145 SPATCH_PID[$i]=$!
146 if [ $VERBOSE -eq 2 ] ; then
147 echo "${SPATCH_PID[$i]} running"
148 fi
149 done
150 wait
Bernd Schubert53032652013-01-29 17:03:42 +0100151}
152
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700153run_cmd() {
154 if [ "$USE_JOBS" = "yes" ]; then
155 run_cmd_parmap $@
156 else
157 run_cmd_old $@
158 fi
159}
160
Kees Cook90d06a42013-06-18 14:49:29 -0700161kill_running() {
Kees Cook2552a392016-05-16 05:55:58 -0700162 for i in $(seq 0 $(( NPROC - 1 )) ); do
Kees Cook90d06a42013-06-18 14:49:29 -0700163 if [ $VERBOSE -eq 2 ] ; then
164 echo "Killing ${SPATCH_PID[$i]}"
165 fi
166 kill ${SPATCH_PID[$i]} 2>/dev/null
167 done
168}
Bernd Schubert53032652013-01-29 17:03:42 +0100169
Luis R. Rodriguez8e826ad2016-06-29 15:14:52 -0700170# You can override heuristics with SPFLAGS, these must always go last
171OPTIONS="$OPTIONS $SPFLAGS"
172
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200173coccinelle () {
Nicolas Palix74425ee2010-06-06 17:15:01 +0200174 COCCI="$1"
Nicolas Palix74425ee2010-06-06 17:15:01 +0200175
Masahiro Yamadae0be3482017-10-26 13:50:38 +0900176 OPT=`grep "Options:" $COCCI | cut -d':' -f2`
177 REQ=`grep "Requires:" $COCCI | cut -d':' -f2 | sed "s| ||"`
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -0700178 REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh)
179 if [ "$REQ_NUM" != "0" ] ; then
180 if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then
Julia Lawall1640eea2018-02-01 10:20:55 +0100181 echo "Skipping coccinelle SmPL patch: $COCCI"
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -0700182 echo "You have coccinelle: $SPATCH_VERSION"
183 echo "This SmPL patch requires: $REQ"
184 return
185 fi
186 fi
Nicolas Palix74425ee2010-06-06 17:15:01 +0200187
Nicolas Palix93f14462013-06-20 13:10:56 +0200188# The option '--parse-cocci' can be used to syntactically check the SmPL files.
Nicolas Palix74425ee2010-06-06 17:15:01 +0200189#
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200190# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
Nicolas Palix74425ee2010-06-06 17:15:01 +0200191
Nicolas Palix35d88a32013-03-02 22:36:25 +0100192 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200193
Masahiro Yamadacd1af7c2017-10-26 13:55:51 +0900194 FILE=${COCCI#$srctree/}
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200195
Nicolas Palix3c908412010-10-08 21:27:38 +0200196 echo "Processing `basename $COCCI`"
197 echo "with option(s) \"$OPT\""
198 echo ''
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200199 echo 'Message example to submit a patch:'
200
Nicolas Palix3c908412010-10-08 21:27:38 +0200201 sed -ne 's|^///||p' $COCCI
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200202
Nicolas Palix062c1822010-10-24 23:37:34 +0200203 if [ "$MODE" = "patch" ] ; then
204 echo ' The semantic patch that makes this change is available'
205 elif [ "$MODE" = "report" ] ; then
206 echo ' The semantic patch that makes this report is available'
207 elif [ "$MODE" = "context" ] ; then
208 echo ' The semantic patch that spots this code is available'
209 elif [ "$MODE" = "org" ] ; then
210 echo ' The semantic patch that makes this Org report is available'
211 else
212 echo ' The semantic patch that makes this output is available'
213 fi
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200214 echo " in $FILE."
215 echo ''
216 echo ' More information about semantic patching is available at'
217 echo ' http://coccinelle.lip6.fr/'
218 echo ''
219
Nicolas Palix3c908412010-10-08 21:27:38 +0200220 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
221 echo 'Semantic patch information:'
222 sed -ne 's|^//#||p' $COCCI
223 echo ''
224 fi
Nicolas Palix2c1160c82010-10-08 21:27:40 +0200225 fi
Nicolas Palix3c908412010-10-08 21:27:38 +0200226
Nicolas Palix2c1160c82010-10-08 21:27:40 +0200227 if [ "$MODE" = "chain" ] ; then
Bernd Schubert53032652013-01-29 17:03:42 +0100228 run_cmd $SPATCH -D patch \
Nicolas Palix93f14462013-06-20 13:10:56 +0200229 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
Bernd Schubert53032652013-01-29 17:03:42 +0100230 run_cmd $SPATCH -D report \
Nicolas Palix93f14462013-06-20 13:10:56 +0200231 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
Bernd Schubert53032652013-01-29 17:03:42 +0100232 run_cmd $SPATCH -D context \
Nicolas Palix93f14462013-06-20 13:10:56 +0200233 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
Bernd Schubert53032652013-01-29 17:03:42 +0100234 run_cmd $SPATCH -D org \
Nicolas Palix93f14462013-06-20 13:10:56 +0200235 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
Nicolas Palixc05cd6d2012-09-20 22:30:46 +0200236 elif [ "$MODE" = "rep+ctxt" ] ; then
Bernd Schubert53032652013-01-29 17:03:42 +0100237 run_cmd $SPATCH -D report \
Nicolas Palix93f14462013-06-20 13:10:56 +0200238 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
Bernd Schubert53032652013-01-29 17:03:42 +0100239 run_cmd $SPATCH -D context \
Nicolas Palix93f14462013-06-20 13:10:56 +0200240 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200241 else
Nicolas Palix93f14462013-06-20 13:10:56 +0200242 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200243 fi
244
Nicolas Palix74425ee2010-06-06 17:15:01 +0200245}
246
Julia Lawall9ed07ad2017-10-15 11:55:53 +0200247if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then
248 if [ -f $DEBUG_FILE ]; then
249 echo "Debug file $DEBUG_FILE exists, bailing"
250 exit
251 fi
252else
253 DEBUG_FILE="/dev/null"
254fi
255
Nicolas Palix74425ee2010-06-06 17:15:01 +0200256if [ "$COCCI" = "" ] ; then
257 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200258 coccinelle $f
Nicolas Palix74425ee2010-06-06 17:15:01 +0200259 done
260else
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200261 coccinelle $COCCI
Nicolas Palix74425ee2010-06-06 17:15:01 +0200262fi