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