2 # SPDX-License-Identifier: GPL-2.0
3 # Linux kernel coccicheck
5 # Read Documentation/dev-tools/coccinelle.rst
7 # This script requires at least spatch
10 DIR="$(dirname $(readlink -f $0))/.."
11 SPATCH="`which ${SPATCH:=spatch}`"
13 if [ ! -x "$SPATCH" ]; then
14 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
18 SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')
19 SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)
22 $SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes"
24 # The verbosity may be set by the environmental parameter V=
25 # as for example with 'make V=1 coccicheck'
27 if [ -n "$V" -a "$V" != "0" ]; then
34 NPROC=$(getconf _NPROCESSORS_ONLN)
41 # 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
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:
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
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
56 # --profile will not output if --very-quiet is used, so avoid it.
57 echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null
62 # spatch only allows include directories with the syntax "-I include"
63 # while gcc also allows "-Iinclude" and "-include include"
64 COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
65 COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
67 if [ "$C" = "1" -o "$C" = "2" ]; then
70 # Take only the last argument, which is the C file to test
72 OPTIONS="$COCCIINCLUDE $1"
75 if [ "$KBUILD_EXTMOD" = "" ] ; then
76 OPTIONS="--dir $srctree $COCCIINCLUDE"
78 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
82 if [ "$KBUILD_EXTMOD" != "" ] ; then
83 OPTIONS="--patch $srctree $OPTIONS"
86 # You can override by using SPFLAGS
87 if [ "$USE_JOBS" = "no" ]; then
88 trap kill_running SIGTERM SIGINT
90 elif [ "$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"
96 if [ "$MODE" = "" ] ; then
97 if [ "$ONLINE" = "0" ] ; then
98 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'
100 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
101 echo 'Note however that some modes are not implemented by some semantic patches.'
106 if [ "$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'
111 elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
112 FLAGS="--no-show-diff $FLAGS"
115 if [ "$ONLINE" = "0" ] ; then
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.'
123 if [ $VERBOSE -ne 0 ] ; then
124 echo "Running ($NPROC in parallel): $@"
126 echo $@ >>$DEBUG_FILE
128 if [[ $? -ne 0 ]]; then
129 echo "coccicheck failed"
136 if [ $VERBOSE -ne 0 ] ; then
137 echo "Running ($NPROC in parallel): $@"
139 for i in $(seq 0 $(( NPROC - 1)) ); do
140 eval "$@ --max $NPROC --index $i &"
142 if [ $VERBOSE -eq 2 ] ; then
143 echo "${SPATCH_PID[$i]} running"
150 if [ "$USE_JOBS" = "yes" ]; then
158 for i in $(seq 0 $(( NPROC - 1 )) ); do
159 if [ $VERBOSE -eq 2 ] ; then
160 echo "Killing ${SPATCH_PID[$i]}"
162 kill ${SPATCH_PID[$i]} 2>/dev/null
166 # You can override heuristics with SPFLAGS, these must always go last
167 OPTIONS="$OPTIONS $SPFLAGS"
172 OPT=`grep "Options:" $COCCI | cut -d':' -f2`
173 REQ=`grep "Requires:" $COCCI | cut -d':' -f2 | sed "s| ||"`
174 REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh)
175 if [ "$REQ_NUM" != "0" ] ; then
176 if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then
177 echo "Skipping coccinele SmPL patch: $COCCI"
178 echo "You have coccinelle: $SPATCH_VERSION"
179 echo "This SmPL patch requires: $REQ"
184 # The option '--parse-cocci' can be used to syntactically check the SmPL files.
186 # $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
188 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
190 FILE=${COCCI#$srctree/}
192 echo "Processing `basename $COCCI`"
193 echo "with option(s) \"$OPT\""
195 echo 'Message example to submit a patch:'
197 sed -ne 's|^///||p' $COCCI
199 if [ "$MODE" = "patch" ] ; then
200 echo ' The semantic patch that makes this change is available'
201 elif [ "$MODE" = "report" ] ; then
202 echo ' The semantic patch that makes this report is available'
203 elif [ "$MODE" = "context" ] ; then
204 echo ' The semantic patch that spots this code is available'
205 elif [ "$MODE" = "org" ] ; then
206 echo ' The semantic patch that makes this Org report is available'
208 echo ' The semantic patch that makes this output is available'
212 echo ' More information about semantic patching is available at'
213 echo ' http://coccinelle.lip6.fr/'
216 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
217 echo 'Semantic patch information:'
218 sed -ne 's|^//#||p' $COCCI
223 if [ "$MODE" = "chain" ] ; then
224 run_cmd $SPATCH -D patch \
225 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
226 run_cmd $SPATCH -D report \
227 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
228 run_cmd $SPATCH -D context \
229 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
230 run_cmd $SPATCH -D org \
231 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
232 elif [ "$MODE" = "rep+ctxt" ] ; then
233 run_cmd $SPATCH -D report \
234 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
235 run_cmd $SPATCH -D context \
236 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
238 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
243 if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then
244 if [ -f $DEBUG_FILE ]; then
245 echo "Debug file $DEBUG_FILE exists, bailing"
249 DEBUG_FILE="/dev/null"
252 if [ "$COCCI" = "" ] ; then
253 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do