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
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
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:
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
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
50 # --profile will not output if --very-quiet is used, so avoid it.
51 echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null
56 # spatch only allows include directories with the syntax "-I include"
57 # while gcc also allows "-Iinclude" and "-include include"
58 COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
59 COCCIINCLUDE=${COCCIINCLUDE// -include/ --include}
61 if [ "$C" = "1" -o "$C" = "2" ]; then
64 # Take only the last argument, which is the C file to test
66 OPTIONS="$COCCIINCLUDE $1"
68 # No need to parallelize Coccinelle since this mode takes one input file.
72 if [ "$KBUILD_EXTMOD" = "" ] ; then
73 OPTIONS="--dir $srctree $COCCIINCLUDE"
75 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
79 NPROC=$(getconf _NPROCESSORS_ONLN)
85 if [ "$KBUILD_EXTMOD" != "" ] ; then
86 OPTIONS="--patch $srctree $OPTIONS"
89 # You can override by using SPFLAGS
90 if [ "$USE_JOBS" = "no" ]; then
91 trap kill_running SIGTERM SIGINT
93 elif [ "$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"
99 if [ "$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.'
109 if [ "$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'
114 elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
115 FLAGS="--no-show-diff $FLAGS"
118 if [ "$ONLINE" = "0" ] ; then
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.'
126 if [ $VERBOSE -ne 0 ] ; then
127 echo "Running ($NPROC in parallel): $@"
129 echo $@ >>$DEBUG_FILE
131 if [[ $? -ne 0 ]]; then
132 echo "coccicheck failed"
139 if [ $VERBOSE -ne 0 ] ; then
140 echo "Running ($NPROC in parallel): $@"
142 for i in $(seq 0 $(( NPROC - 1)) ); do
143 eval "$@ --max $NPROC --index $i &"
145 if [ $VERBOSE -eq 2 ] ; then
146 echo "${SPATCH_PID[$i]} running"
153 if [ "$USE_JOBS" = "yes" ]; then
161 for i in $(seq 0 $(( NPROC - 1 )) ); do
162 if [ $VERBOSE -eq 2 ] ; then
163 echo "Killing ${SPATCH_PID[$i]}"
165 kill ${SPATCH_PID[$i]} 2>/dev/null
169 # You can override heuristics with SPFLAGS, these must always go last
170 OPTIONS="$OPTIONS $SPFLAGS"
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"
187 # The option '--parse-cocci' can be used to syntactically check the SmPL files.
189 # $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
191 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
193 FILE=${COCCI#$srctree/}
195 echo "Processing `basename $COCCI`"
196 echo "with option(s) \"$OPT\""
198 echo 'Message example to submit a patch:'
200 sed -ne 's|^///||p' $COCCI
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'
211 echo ' The semantic patch that makes this output is available'
215 echo ' More information about semantic patching is available at'
216 echo ' http://coccinelle.lip6.fr/'
219 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
220 echo 'Semantic patch information:'
221 sed -ne 's|^//#||p' $COCCI
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
241 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1
246 if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then
247 if [ -f $DEBUG_FILE ]; then
248 echo "Debug file $DEBUG_FILE exists, bailing"
252 DEBUG_FILE="/dev/null"
255 if [ "$COCCI" = "" ] ; then
256 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do