blob: c92c1528a54dd54589878df99c2d9bb8dd4c09aa [file] [log] [blame]
Nicolas Palix9e395552013-03-02 22:36:26 +01001#!/bin/bash
Luis R. Rodriguezc100d532016-06-29 15:14:58 -07002# Linux kernel coccicheck
3#
4# Read Documentation/coccinelle.txt
Nicolas Palixec979462013-07-03 16:41:01 +02005#
6# This script requires at least spatch
7# version 1.0.0-rc11.
Nicolas Palixec979462013-07-03 16:41:01 +02008
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -07009DIR="$(dirname $(readlink -f $0))/.."
Nicolas Palix74425ee2010-06-06 17:15:01 +020010SPATCH="`which ${SPATCH:=spatch}`"
11
Luis R. Rodriguez13d94862016-06-29 15:14:51 -070012if [ ! -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
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -070017SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')
18SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)
19
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -070020USE_JOBS="no"
21$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes"
Kees Cook90d06a42013-06-18 14:49:29 -070022
Bernd Schubert26e56722013-01-29 17:03:37 +010023# 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
Kees Cook90d06a42013-06-18 14:49:29 -070027 VERBOSE="$V"
Bernd Schubert26e56722013-01-29 17:03:37 +010028else
29 VERBOSE=0
30fi
31
Kees Cook90d06a42013-06-18 14:49:29 -070032if [ -z "$J" ]; then
33 NPROC=$(getconf _NPROCESSORS_ONLN)
34else
35 NPROC="$J"
36fi
37
Luis R. Rodriguez8e826ad2016-06-29 15:14:52 -070038FLAGS="--very-quiet"
Nicolas Palix9e395552013-03-02 22:36:26 +010039
Luis R. Rodriguez5c384db2016-06-29 15:14:55 -070040# 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
Nicolas Palix9e395552013-03-02 22:36:26 +010061# spatch only allows include directories with the syntax "-I include"
62# while gcc also allows "-Iinclude" and "-include include"
63COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
Andrzej Hajda5b169102015-09-22 15:15:30 +020064COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
Nicolas Palix9e395552013-03-02 22:36:26 +010065
Nicolas Palix1e9dea22010-06-13 09:26:34 +020066if [ "$C" = "1" -o "$C" = "2" ]; then
67 ONLINE=1
68
Nicolas Palix9e395552013-03-02 22:36:26 +010069 # Take only the last argument, which is the C file to test
70 shift $(( $# - 1 ))
71 OPTIONS="$COCCIINCLUDE $1"
Nicolas Palix1e9dea22010-06-13 09:26:34 +020072else
73 ONLINE=0
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050074 if [ "$KBUILD_EXTMOD" = "" ] ; then
Nicolas Palix93f14462013-06-20 13:10:56 +020075 OPTIONS="--dir $srctree $COCCIINCLUDE"
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050076 else
Nicolas Palix93f14462013-06-20 13:10:56 +020077 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050078 fi
Nicolas Palix1e9dea22010-06-13 09:26:34 +020079fi
80
Nicolas Palixbad6a402013-03-02 22:36:28 +010081if [ "$KBUILD_EXTMOD" != "" ] ; then
Nicolas Palix93f14462013-06-20 13:10:56 +020082 OPTIONS="--patch $srctree $OPTIONS"
Nicolas Palixbad6a402013-03-02 22:36:28 +010083fi
84
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -070085# 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
Nicolas Palix74425ee2010-06-06 17:15:01 +020095if [ "$MODE" = "" ] ; then
Nicolas Palix1e9dea22010-06-13 09:26:34 +020096 if [ "$ONLINE" = "0" ] ; then
Nicolas Palix1f0a6742013-06-06 23:39:52 +020097 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'
Nicolas Palix1e9dea22010-06-13 09:26:34 +020099 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200100 echo 'Note however that some modes are not implemented by some semantic patches.'
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200101 fi
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200102 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'
109 fi
Nicolas Palix03ee0c42010-10-08 21:27:41 +0200110elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
Deepa Dinamani7a2358b2016-06-12 12:04:39 -0700111 FLAGS="--no-show-diff $FLAGS"
Nicolas Palix74425ee2010-06-06 17:15:01 +0200112fi
113
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200114if [ "$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
Nicolas Palix74425ee2010-06-06 17:15:01 +0200120
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700121run_cmd_parmap() {
122 if [ $VERBOSE -ne 0 ] ; then
123 echo "Running ($NPROC in parallel): $@"
124 fi
Luis R. Rodriguezbe1fa902016-06-29 15:14:54 -0700125 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
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700134 if [[ $? -ne 0 ]]; then
135 echo "coccicheck failed"
136 exit $?
137 fi
138}
139
140run_cmd_old() {
Kees Cook90d06a42013-06-18 14:49:29 -0700141 local i
Bernd Schubert53032652013-01-29 17:03:42 +0100142 if [ $VERBOSE -ne 0 ] ; then
Kees Cook90d06a42013-06-18 14:49:29 -0700143 echo "Running ($NPROC in parallel): $@"
Bernd Schubert53032652013-01-29 17:03:42 +0100144 fi
Kees Cook90d06a42013-06-18 14:49:29 -0700145 for i in $(seq 0 $(( NPROC - 1)) ); do
Nicolas Palix93f14462013-06-20 13:10:56 +0200146 eval "$@ --max $NPROC --index $i &"
Kees Cook90d06a42013-06-18 14:49:29 -0700147 SPATCH_PID[$i]=$!
148 if [ $VERBOSE -eq 2 ] ; then
149 echo "${SPATCH_PID[$i]} running"
150 fi
151 done
152 wait
Bernd Schubert53032652013-01-29 17:03:42 +0100153}
154
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700155run_cmd() {
156 if [ "$USE_JOBS" = "yes" ]; then
157 run_cmd_parmap $@
158 else
159 run_cmd_old $@
160 fi
161}
162
Kees Cook90d06a42013-06-18 14:49:29 -0700163kill_running() {
Kees Cook2552a392016-05-16 05:55:58 -0700164 for i in $(seq 0 $(( NPROC - 1 )) ); do
Kees Cook90d06a42013-06-18 14:49:29 -0700165 if [ $VERBOSE -eq 2 ] ; then
166 echo "Killing ${SPATCH_PID[$i]}"
167 fi
168 kill ${SPATCH_PID[$i]} 2>/dev/null
169 done
170}
Bernd Schubert53032652013-01-29 17:03:42 +0100171
Luis R. Rodriguez8e826ad2016-06-29 15:14:52 -0700172# You can override heuristics with SPFLAGS, these must always go last
173OPTIONS="$OPTIONS $SPFLAGS"
174
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200175coccinelle () {
Nicolas Palix74425ee2010-06-06 17:15:01 +0200176 COCCI="$1"
Nicolas Palix74425ee2010-06-06 17:15:01 +0200177
178 OPT=`grep "Option" $COCCI | cut -d':' -f2`
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -0700179 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
Nicolas Palix74425ee2010-06-06 17:15:01 +0200189
Nicolas Palix93f14462013-06-20 13:10:56 +0200190# The option '--parse-cocci' can be used to syntactically check the SmPL files.
Nicolas Palix74425ee2010-06-06 17:15:01 +0200191#
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200192# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
Nicolas Palix74425ee2010-06-06 17:15:01 +0200193
Nicolas Palix35d88a32013-03-02 22:36:25 +0100194 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200195
196 FILE=`echo $COCCI | sed "s|$srctree/||"`
197
Nicolas Palix3c908412010-10-08 21:27:38 +0200198 echo "Processing `basename $COCCI`"
199 echo "with option(s) \"$OPT\""
200 echo ''
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200201 echo 'Message example to submit a patch:'
202
Nicolas Palix3c908412010-10-08 21:27:38 +0200203 sed -ne 's|^///||p' $COCCI
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200204
Nicolas Palix062c1822010-10-24 23:37:34 +0200205 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
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200216 echo " in $FILE."
217 echo ''
218 echo ' More information about semantic patching is available at'
219 echo ' http://coccinelle.lip6.fr/'
220 echo ''
221
Nicolas Palix3c908412010-10-08 21:27:38 +0200222 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
223 echo 'Semantic patch information:'
224 sed -ne 's|^//#||p' $COCCI
225 echo ''
226 fi
Nicolas Palix2c1160c82010-10-08 21:27:40 +0200227 fi
Nicolas Palix3c908412010-10-08 21:27:38 +0200228
Nicolas Palix2c1160c82010-10-08 21:27:40 +0200229 if [ "$MODE" = "chain" ] ; then
Bernd Schubert53032652013-01-29 17:03:42 +0100230 run_cmd $SPATCH -D patch \
Nicolas Palix93f14462013-06-20 13:10:56 +0200231 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
Bernd Schubert53032652013-01-29 17:03:42 +0100232 run_cmd $SPATCH -D report \
Nicolas Palix93f14462013-06-20 13:10:56 +0200233 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
Bernd Schubert53032652013-01-29 17:03:42 +0100234 run_cmd $SPATCH -D context \
Nicolas Palix93f14462013-06-20 13:10:56 +0200235 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
Bernd Schubert53032652013-01-29 17:03:42 +0100236 run_cmd $SPATCH -D org \
Nicolas Palix93f14462013-06-20 13:10:56 +0200237 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
Nicolas Palixc05cd6d2012-09-20 22:30:46 +0200238 elif [ "$MODE" = "rep+ctxt" ] ; then
Bernd Schubert53032652013-01-29 17:03:42 +0100239 run_cmd $SPATCH -D report \
Nicolas Palix93f14462013-06-20 13:10:56 +0200240 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
Bernd Schubert53032652013-01-29 17:03:42 +0100241 run_cmd $SPATCH -D context \
Nicolas Palix93f14462013-06-20 13:10:56 +0200242 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200243 else
Nicolas Palix93f14462013-06-20 13:10:56 +0200244 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200245 fi
246
Nicolas Palix74425ee2010-06-06 17:15:01 +0200247}
248
249if [ "$COCCI" = "" ] ; then
250 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200251 coccinelle $f
Nicolas Palix74425ee2010-06-06 17:15:01 +0200252 done
253else
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200254 coccinelle $COCCI
Nicolas Palix74425ee2010-06-06 17:15:01 +0200255fi