blob: 28ad1feff9e12d07fbf1ff2369ca1ecf7e76dd85 [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
Kees Cook90d06a42013-06-18 14:49:29 -070033if [ -z "$J" ]; then
34 NPROC=$(getconf _NPROCESSORS_ONLN)
35else
36 NPROC="$J"
37fi
38
Luis R. Rodriguez8e826ad2016-06-29 15:14:52 -070039FLAGS="--very-quiet"
Nicolas Palix9e395552013-03-02 22:36:26 +010040
Luis R. Rodriguez5c384db2016-06-29 15:14:55 -070041# You can use SPFLAGS to append extra arguments to coccicheck or override any
42# heuristics done in this file as Coccinelle accepts the last options when
43# options conflict.
44#
45# A good example for use of SPFLAGS is if you want to debug your cocci script,
46# you can for instance use the following:
47#
48# $ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci
49# $ make coccicheck MODE=report DEBUG_FILE="all.err" SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c
50#
51# "--show-trying" should show you what rule is being processed as it goes to
52# stdout, you do not need a debug file for that. The profile output will be
53# be sent to stdout, if you provide a DEBUG_FILE the profiling data can be
54# inspected there.
55#
56# --profile will not output if --very-quiet is used, so avoid it.
57echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null
58if [ $? -eq 0 ]; then
59 FLAGS="--quiet"
60fi
61
Nicolas Palix9e395552013-03-02 22:36:26 +010062# spatch only allows include directories with the syntax "-I include"
63# while gcc also allows "-Iinclude" and "-include include"
64COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
Andrzej Hajda5b169102015-09-22 15:15:30 +020065COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
Nicolas Palix9e395552013-03-02 22:36:26 +010066
Nicolas Palix1e9dea22010-06-13 09:26:34 +020067if [ "$C" = "1" -o "$C" = "2" ]; then
68 ONLINE=1
69
Nicolas Palix9e395552013-03-02 22:36:26 +010070 # Take only the last argument, which is the C file to test
71 shift $(( $# - 1 ))
72 OPTIONS="$COCCIINCLUDE $1"
Nicolas Palix1e9dea22010-06-13 09:26:34 +020073else
74 ONLINE=0
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050075 if [ "$KBUILD_EXTMOD" = "" ] ; then
Nicolas Palix93f14462013-06-20 13:10:56 +020076 OPTIONS="--dir $srctree $COCCIINCLUDE"
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050077 else
Nicolas Palix93f14462013-06-20 13:10:56 +020078 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
Greg Dietsched0bc1fb2011-11-05 20:59:43 -050079 fi
Nicolas Palix1e9dea22010-06-13 09:26:34 +020080fi
81
Nicolas Palixbad6a402013-03-02 22:36:28 +010082if [ "$KBUILD_EXTMOD" != "" ] ; then
Nicolas Palix93f14462013-06-20 13:10:56 +020083 OPTIONS="--patch $srctree $OPTIONS"
Nicolas Palixbad6a402013-03-02 22:36:28 +010084fi
85
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -070086# You can override by using SPFLAGS
87if [ "$USE_JOBS" = "no" ]; then
88 trap kill_running SIGTERM SIGINT
89 declare -a SPATCH_PID
90elif [ "$NPROC" != "1" ]; then
91 # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on
92 # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c
93 OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1"
94fi
95
Nicolas Palix74425ee2010-06-06 17:15:01 +020096if [ "$MODE" = "" ] ; then
Nicolas Palix1e9dea22010-06-13 09:26:34 +020097 if [ "$ONLINE" = "0" ] ; then
Nicolas Palix1f0a6742013-06-06 23:39:52 +020098 echo 'You have not explicitly specified the mode to use. Using default "report" mode.'
99 echo 'Available modes are the following: patch, report, context, org'
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200100 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200101 echo 'Note however that some modes are not implemented by some semantic patches.'
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200102 fi
Nicolas Palix1f0a6742013-06-06 23:39:52 +0200103 MODE="report"
104fi
105
106if [ "$MODE" = "chain" ] ; then
107 if [ "$ONLINE" = "0" ] ; then
108 echo 'You have selected the "chain" mode.'
109 echo 'All available modes will be tried (in that order): patch, report, context, org'
110 fi
Nicolas Palix03ee0c42010-10-08 21:27:41 +0200111elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
Deepa Dinamani7a2358b2016-06-12 12:04:39 -0700112 FLAGS="--no-show-diff $FLAGS"
Nicolas Palix74425ee2010-06-06 17:15:01 +0200113fi
114
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200115if [ "$ONLINE" = "0" ] ; then
116 echo ''
117 echo 'Please check for false positives in the output before submitting a patch.'
118 echo 'When using "patch" mode, carefully review the patch before submitting it.'
119 echo ''
120fi
Nicolas Palix74425ee2010-06-06 17:15:01 +0200121
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700122run_cmd_parmap() {
123 if [ $VERBOSE -ne 0 ] ; then
124 echo "Running ($NPROC in parallel): $@"
125 fi
Luis R. Rodriguezbe1fa902016-06-29 15:14:54 -0700126 if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then
127 if [ -f $DEBUG_FILE ]; then
128 echo "Debug file $DEBUG_FILE exists, bailing"
129 exit
130 fi
131 else
132 DEBUG_FILE="/dev/null"
133 fi
134 $@ 2>$DEBUG_FILE
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700135 if [[ $? -ne 0 ]]; then
136 echo "coccicheck failed"
137 exit $?
138 fi
139}
140
141run_cmd_old() {
Kees Cook90d06a42013-06-18 14:49:29 -0700142 local i
Bernd Schubert53032652013-01-29 17:03:42 +0100143 if [ $VERBOSE -ne 0 ] ; then
Kees Cook90d06a42013-06-18 14:49:29 -0700144 echo "Running ($NPROC in parallel): $@"
Bernd Schubert53032652013-01-29 17:03:42 +0100145 fi
Kees Cook90d06a42013-06-18 14:49:29 -0700146 for i in $(seq 0 $(( NPROC - 1)) ); do
Nicolas Palix93f14462013-06-20 13:10:56 +0200147 eval "$@ --max $NPROC --index $i &"
Kees Cook90d06a42013-06-18 14:49:29 -0700148 SPATCH_PID[$i]=$!
149 if [ $VERBOSE -eq 2 ] ; then
150 echo "${SPATCH_PID[$i]} running"
151 fi
152 done
153 wait
Bernd Schubert53032652013-01-29 17:03:42 +0100154}
155
Luis R. Rodriguezc930a1b2016-06-29 15:14:53 -0700156run_cmd() {
157 if [ "$USE_JOBS" = "yes" ]; then
158 run_cmd_parmap $@
159 else
160 run_cmd_old $@
161 fi
162}
163
Kees Cook90d06a42013-06-18 14:49:29 -0700164kill_running() {
Kees Cook2552a392016-05-16 05:55:58 -0700165 for i in $(seq 0 $(( NPROC - 1 )) ); do
Kees Cook90d06a42013-06-18 14:49:29 -0700166 if [ $VERBOSE -eq 2 ] ; then
167 echo "Killing ${SPATCH_PID[$i]}"
168 fi
169 kill ${SPATCH_PID[$i]} 2>/dev/null
170 done
171}
Bernd Schubert53032652013-01-29 17:03:42 +0100172
Luis R. Rodriguez8e826ad2016-06-29 15:14:52 -0700173# You can override heuristics with SPFLAGS, these must always go last
174OPTIONS="$OPTIONS $SPFLAGS"
175
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200176coccinelle () {
Nicolas Palix74425ee2010-06-06 17:15:01 +0200177 COCCI="$1"
Nicolas Palix74425ee2010-06-06 17:15:01 +0200178
179 OPT=`grep "Option" $COCCI | cut -d':' -f2`
Luis R. Rodrigueza9e064c2016-06-29 15:14:57 -0700180 REQ=`grep "Requires" $COCCI | cut -d':' -f2 | sed "s| ||"`
181 REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh)
182 if [ "$REQ_NUM" != "0" ] ; then
183 if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then
184 echo "Skipping coccinele SmPL patch: $COCCI"
185 echo "You have coccinelle: $SPATCH_VERSION"
186 echo "This SmPL patch requires: $REQ"
187 return
188 fi
189 fi
Nicolas Palix74425ee2010-06-06 17:15:01 +0200190
Nicolas Palix93f14462013-06-20 13:10:56 +0200191# The option '--parse-cocci' can be used to syntactically check the SmPL files.
Nicolas Palix74425ee2010-06-06 17:15:01 +0200192#
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200193# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
Nicolas Palix74425ee2010-06-06 17:15:01 +0200194
Nicolas Palix35d88a32013-03-02 22:36:25 +0100195 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200196
197 FILE=`echo $COCCI | sed "s|$srctree/||"`
198
Nicolas Palix3c908412010-10-08 21:27:38 +0200199 echo "Processing `basename $COCCI`"
200 echo "with option(s) \"$OPT\""
201 echo ''
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200202 echo 'Message example to submit a patch:'
203
Nicolas Palix3c908412010-10-08 21:27:38 +0200204 sed -ne 's|^///||p' $COCCI
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200205
Nicolas Palix062c1822010-10-24 23:37:34 +0200206 if [ "$MODE" = "patch" ] ; then
207 echo ' The semantic patch that makes this change is available'
208 elif [ "$MODE" = "report" ] ; then
209 echo ' The semantic patch that makes this report is available'
210 elif [ "$MODE" = "context" ] ; then
211 echo ' The semantic patch that spots this code is available'
212 elif [ "$MODE" = "org" ] ; then
213 echo ' The semantic patch that makes this Org report is available'
214 else
215 echo ' The semantic patch that makes this output is available'
216 fi
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200217 echo " in $FILE."
218 echo ''
219 echo ' More information about semantic patching is available at'
220 echo ' http://coccinelle.lip6.fr/'
221 echo ''
222
Nicolas Palix3c908412010-10-08 21:27:38 +0200223 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
224 echo 'Semantic patch information:'
225 sed -ne 's|^//#||p' $COCCI
226 echo ''
227 fi
Nicolas Palix2c1160c82010-10-08 21:27:40 +0200228 fi
Nicolas Palix3c908412010-10-08 21:27:38 +0200229
Nicolas Palix2c1160c82010-10-08 21:27:40 +0200230 if [ "$MODE" = "chain" ] ; then
Bernd Schubert53032652013-01-29 17:03:42 +0100231 run_cmd $SPATCH -D patch \
Nicolas Palix93f14462013-06-20 13:10:56 +0200232 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
Bernd Schubert53032652013-01-29 17:03:42 +0100233 run_cmd $SPATCH -D report \
Nicolas Palix93f14462013-06-20 13:10:56 +0200234 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
Bernd Schubert53032652013-01-29 17:03:42 +0100235 run_cmd $SPATCH -D context \
Nicolas Palix93f14462013-06-20 13:10:56 +0200236 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
Bernd Schubert53032652013-01-29 17:03:42 +0100237 run_cmd $SPATCH -D org \
Nicolas Palix93f14462013-06-20 13:10:56 +0200238 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
Nicolas Palixc05cd6d2012-09-20 22:30:46 +0200239 elif [ "$MODE" = "rep+ctxt" ] ; then
Bernd Schubert53032652013-01-29 17:03:42 +0100240 run_cmd $SPATCH -D report \
Nicolas Palix93f14462013-06-20 13:10:56 +0200241 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
Bernd Schubert53032652013-01-29 17:03:42 +0100242 run_cmd $SPATCH -D context \
Nicolas Palix93f14462013-06-20 13:10:56 +0200243 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200244 else
Nicolas Palix93f14462013-06-20 13:10:56 +0200245 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200246 fi
247
Nicolas Palix74425ee2010-06-06 17:15:01 +0200248}
249
250if [ "$COCCI" = "" ] ; then
251 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200252 coccinelle $f
Nicolas Palix74425ee2010-06-06 17:15:01 +0200253 done
254else
Nicolas Palix1e9dea22010-06-13 09:26:34 +0200255 coccinelle $COCCI
Nicolas Palix74425ee2010-06-06 17:15:01 +0200256fi