Loading...
1#!/bin/bash
2# SPDX-License-Identifier: GPL-2.0
3# Linux kernel coccicheck
4#
5# Read Documentation/dev-tools/coccinelle.rst
6#
7# This script requires at least spatch
8# version 1.0.0-rc11.
9
10DIR="$(dirname $(readlink -f $0))/.."
11SPATCH="`which ${SPATCH:=spatch}`"
12
13if [ ! -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
18SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')
19SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)
20
21USE_JOBS="no"
22$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes"
23
24# 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
28 VERBOSE="$V"
29else
30 VERBOSE=0
31fi
32
33FLAGS="--very-quiet"
34
35# 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
56# spatch only allows include directories with the syntax "-I include"
57# while gcc also allows "-Iinclude" and "-include include"
58COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
59COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
60
61if [ "$C" = "1" -o "$C" = "2" ]; then
62 ONLINE=1
63
64 # Take only the last argument, which is the C file to test
65 shift $(( $# - 1 ))
66 OPTIONS="$COCCIINCLUDE $1"
67
68 # No need to parallelize Coccinelle since this mode takes one input file.
69 NPROC=1
70else
71 ONLINE=0
72 if [ "$KBUILD_EXTMOD" = "" ] ; then
73 OPTIONS="--dir $srctree $COCCIINCLUDE"
74 else
75 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
76 fi
77
78 if [ -z "$J" ]; then
79 NPROC=$(getconf _NPROCESSORS_ONLN)
80 else
81 NPROC="$J"
82 fi
83fi
84
85if [ "$KBUILD_EXTMOD" != "" ] ; then
86 OPTIONS="--patch $srctree $OPTIONS"
87fi
88
89# 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
99if [ "$MODE" = "" ] ; then
100 if [ "$ONLINE" = "0" ] ; then
101 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'
103 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
104 echo 'Note however that some modes are not implemented by some semantic patches.'
105 fi
106 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
114elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
115 FLAGS="--no-show-diff $FLAGS"
116fi
117
118if [ "$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
124
125run_cmd_parmap() {
126 if [ $VERBOSE -ne 0 ] ; then
127 echo "Running ($NPROC in parallel): $@"
128 fi
129 echo $@ >>$DEBUG_FILE
130 $@ 2>>$DEBUG_FILE
131 if [[ $? -ne 0 ]]; then
132 echo "coccicheck failed"
133 exit $?
134 fi
135}
136
137run_cmd_old() {
138 local i
139 if [ $VERBOSE -ne 0 ] ; then
140 echo "Running ($NPROC in parallel): $@"
141 fi
142 for i in $(seq 0 $(( NPROC - 1)) ); do
143 eval "$@ --max $NPROC --index $i &"
144 SPATCH_PID[$i]=$!
145 if [ $VERBOSE -eq 2 ] ; then
146 echo "${SPATCH_PID[$i]} running"
147 fi
148 done
149 wait
150}
151
152run_cmd() {
153 if [ "$USE_JOBS" = "yes" ]; then
154 run_cmd_parmap $@
155 else
156 run_cmd_old $@
157 fi
158}
159
160kill_running() {
161 for i in $(seq 0 $(( NPROC - 1 )) ); do
162 if [ $VERBOSE -eq 2 ] ; then
163 echo "Killing ${SPATCH_PID[$i]}"
164 fi
165 kill ${SPATCH_PID[$i]} 2>/dev/null
166 done
167}
168
169# You can override heuristics with SPFLAGS, these must always go last
170OPTIONS="$OPTIONS $SPFLAGS"
171
172coccinelle () {
173 COCCI="$1"
174
175 OPT=`grep "Options:" $COCCI | cut -d':' -f2`
176 REQ=`grep "Requires:" $COCCI | cut -d':' -f2 | sed "s| ||"`
177 REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh)
178 if [ "$REQ_NUM" != "0" ] ; then
179 if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then
180 echo "Skipping coccinelle SmPL patch: $COCCI"
181 echo "You have coccinelle: $SPATCH_VERSION"
182 echo "This SmPL patch requires: $REQ"
183 return
184 fi
185 fi
186
187# The option '--parse-cocci' can be used to syntactically check the SmPL files.
188#
189# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
190
191 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
192
193 FILE=${COCCI#$srctree/}
194
195 echo "Processing `basename $COCCI`"
196 echo "with option(s) \"$OPT\""
197 echo ''
198 echo 'Message example to submit a patch:'
199
200 sed -ne 's|^///||p' $COCCI
201
202 if [ "$MODE" = "patch" ] ; then
203 echo ' The semantic patch that makes this change is available'
204 elif [ "$MODE" = "report" ] ; then
205 echo ' The semantic patch that makes this report is available'
206 elif [ "$MODE" = "context" ] ; then
207 echo ' The semantic patch that spots this code is available'
208 elif [ "$MODE" = "org" ] ; then
209 echo ' The semantic patch that makes this Org report is available'
210 else
211 echo ' The semantic patch that makes this output is available'
212 fi
213 echo " in $FILE."
214 echo ''
215 echo ' More information about semantic patching is available at'
216 echo ' http://coccinelle.lip6.fr/'
217 echo ''
218
219 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
220 echo 'Semantic patch information:'
221 sed -ne 's|^//#||p' $COCCI
222 echo ''
223 fi
224 fi
225
226 if [ "$MODE" = "chain" ] ; then
227 run_cmd $SPATCH -D patch \
228 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
229 run_cmd $SPATCH -D report \
230 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \
231 run_cmd $SPATCH -D context \
232 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \
233 run_cmd $SPATCH -D org \
234 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1
235 elif [ "$MODE" = "rep+ctxt" ] ; then
236 run_cmd $SPATCH -D report \
237 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \
238 run_cmd $SPATCH -D context \
239 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
240 else
241 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
242 fi
243
244}
245
246if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then
247 if [ -f $DEBUG_FILE ]; then
248 echo "Debug file $DEBUG_FILE exists, bailing"
249 exit
250 fi
251else
252 DEBUG_FILE="/dev/null"
253fi
254
255if [ "$COCCI" = "" ] ; then
256 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
257 coccinelle $f
258 done
259else
260 coccinelle $COCCI
261fi
1#!/bin/sh
2
3SPATCH="`which ${SPATCH:=spatch}`"
4
5if [ "$C" = "1" -o "$C" = "2" ]; then
6 ONLINE=1
7
8# This requires Coccinelle >= 0.2.3
9# FLAGS="-ignore_unknown_options -very_quiet"
10# OPTIONS=$*
11
12# Workaround for Coccinelle < 0.2.3
13 FLAGS="-I $srctree/include -very_quiet"
14 shift $(( $# - 1 ))
15 OPTIONS=$1
16else
17 ONLINE=0
18 FLAGS="-very_quiet"
19 if [ "$KBUILD_EXTMOD" = "" ] ; then
20 OPTIONS="-dir $srctree"
21 else
22 OPTIONS="-dir $KBUILD_EXTMOD -patch $srctree -I $srctree/include -I $KBUILD_EXTMOD/include"
23 fi
24fi
25
26if [ ! -x "$SPATCH" ]; then
27 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
28 exit 1
29fi
30
31if [ "$MODE" = "" ] ; then
32 if [ "$ONLINE" = "0" ] ; then
33 echo 'You have not explicitly specified the mode to use. Using default "chain" mode.'
34 echo 'All available modes will be tried (in that order): patch, report, context, org'
35 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
36 fi
37 MODE="chain"
38elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
39 FLAGS="$FLAGS -no_show_diff"
40fi
41
42if [ "$ONLINE" = "0" ] ; then
43 echo ''
44 echo 'Please check for false positives in the output before submitting a patch.'
45 echo 'When using "patch" mode, carefully review the patch before submitting it.'
46 echo ''
47fi
48
49coccinelle () {
50 COCCI="$1"
51
52 OPT=`grep "Option" $COCCI | cut -d':' -f2`
53
54# The option '-parse_cocci' can be used to syntactically check the SmPL files.
55#
56# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
57
58 if [ "$ONLINE" = "0" ] ; then
59
60 FILE=`echo $COCCI | sed "s|$srctree/||"`
61
62 echo "Processing `basename $COCCI`"
63 echo "with option(s) \"$OPT\""
64 echo ''
65 echo 'Message example to submit a patch:'
66
67 sed -ne 's|^///||p' $COCCI
68
69 if [ "$MODE" = "patch" ] ; then
70 echo ' The semantic patch that makes this change is available'
71 elif [ "$MODE" = "report" ] ; then
72 echo ' The semantic patch that makes this report is available'
73 elif [ "$MODE" = "context" ] ; then
74 echo ' The semantic patch that spots this code is available'
75 elif [ "$MODE" = "org" ] ; then
76 echo ' The semantic patch that makes this Org report is available'
77 else
78 echo ' The semantic patch that makes this output is available'
79 fi
80 echo " in $FILE."
81 echo ''
82 echo ' More information about semantic patching is available at'
83 echo ' http://coccinelle.lip6.fr/'
84 echo ''
85
86 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
87 echo 'Semantic patch information:'
88 sed -ne 's|^//#||p' $COCCI
89 echo ''
90 fi
91 fi
92
93 if [ "$MODE" = "chain" ] ; then
94 $SPATCH -D patch $FLAGS -sp_file $COCCI $OPT $OPTIONS || \
95 $SPATCH -D report $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || \
96 $SPATCH -D context $FLAGS -sp_file $COCCI $OPT $OPTIONS || \
97 $SPATCH -D org $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || exit 1
98 else
99 $SPATCH -D $MODE $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
100 fi
101
102}
103
104if [ "$COCCI" = "" ] ; then
105 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
106 coccinelle $f
107 done
108else
109 coccinelle $COCCI
110fi