1 #!/usr/bin/env bash !! 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 2
10 DIR="$(dirname $(readlink -f $0))/.." <<
11 SPATCH="`which ${SPATCH:=spatch}`" 3 SPATCH="`which ${SPATCH:=spatch}`"
12 4
13 if [ ! -x "$SPATCH" ]; then <<
14 echo 'spatch is part of the Coccinelle pro <<
15 exit 1 <<
16 fi <<
17 <<
18 SPATCH_VERSION=$($SPATCH --version | head -1 | <<
19 <<
20 USE_JOBS="no" <<
21 $SPATCH --help | grep -e "--jobs" > /dev/null <<
22 <<
23 # The verbosity may be set by the environmenta 5 # The verbosity may be set by the environmental parameter V=
24 # as for example with 'make V=1 coccicheck' 6 # as for example with 'make V=1 coccicheck'
25 7
26 if [ -n "$V" -a "$V" != "0" ]; then 8 if [ -n "$V" -a "$V" != "0" ]; then
27 VERBOSE="$V" !! 9 VERBOSE=1
28 else 10 else
29 VERBOSE=0 11 VERBOSE=0
30 fi 12 fi
31 13
32 FLAGS="--very-quiet" !! 14 FLAGS="$SPFLAGS -very_quiet"
33 <<
34 # You can use SPFLAGS to append extra argument <<
35 # heuristics done in this file as Coccinelle a <<
36 # options conflict. <<
37 # <<
38 # A good example for use of SPFLAGS is if you <<
39 # you can for instance use the following: <<
40 # <<
41 # $ export COCCI=scripts/coccinelle/misc/irqf_ <<
42 # $ make coccicheck MODE=report DEBUG_FILE="al <<
43 # <<
44 # "--show-trying" should show you what rule is <<
45 # stdout, you do not need a debug file for tha <<
46 # be sent to stdout, if you provide a DEBUG_FI <<
47 # inspected there. <<
48 # <<
49 # --profile will not output if --very-quiet is <<
50 echo $SPFLAGS | grep -E -e "--profile|--show-t <<
51 if [ $? -eq 0 ]; then <<
52 FLAGS="--quiet" <<
53 fi <<
54 15
55 # spatch only allows include directories with 16 # spatch only allows include directories with the syntax "-I include"
56 # while gcc also allows "-Iinclude" and "-incl 17 # while gcc also allows "-Iinclude" and "-include include"
57 COCCIINCLUDE=${LINUXINCLUDE//-I/-I } 18 COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
58 COCCIINCLUDE=${COCCIINCLUDE// -include/ --incl !! 19 COCCIINCLUDE=${COCCIINCLUDE//-include/-I}
59 20
60 if [ "$C" = "1" -o "$C" = "2" ]; then 21 if [ "$C" = "1" -o "$C" = "2" ]; then
61 ONLINE=1 22 ONLINE=1
62 23
63 if [[ $# -le 0 ]]; then <<
64 echo '' <<
65 echo 'Specifying both the variable <<
66 command results in a shift count error.' <<
67 echo '' <<
68 echo 'Try specifying "scripts/cocc <<
69 echo '' <<
70 echo 'Example: make C=2 CHECK <<
71 echo '' <<
72 exit 1 <<
73 fi <<
74 <<
75 # Take only the last argument, which is th 24 # Take only the last argument, which is the C file to test
76 shift $(( $# - 1 )) 25 shift $(( $# - 1 ))
77 OPTIONS="$COCCIINCLUDE $1" 26 OPTIONS="$COCCIINCLUDE $1"
78 <<
79 # No need to parallelize Coccinelle since <<
80 NPROC=1 <<
81 else 27 else
82 ONLINE=0 28 ONLINE=0
83 if [ "$KBUILD_EXTMOD" = "" ] ; then 29 if [ "$KBUILD_EXTMOD" = "" ] ; then
84 OPTIONS="--dir $srctree $COCCIINCLUDE" !! 30 OPTIONS="-dir $srctree $COCCIINCLUDE"
85 else 31 else
86 OPTIONS="--dir $KBUILD_EXTMOD $COCCIIN !! 32 OPTIONS="-dir $KBUILD_EXTMOD $COCCIINCLUDE"
87 fi <<
88 <<
89 # Use only one thread per core by default <<
90 THREADS_PER_CORE=$(LANG=C lscpu | grep "Th <<
91 if [ -z "$J" ]; then <<
92 NPROC=$(getconf _NPROCESSORS_ONLN) <<
93 if [ $THREADS_PER_CORE -gt 1 -a $NPROC <<
94 NPROC=$((NPROC/2)) <<
95 fi <<
96 else <<
97 NPROC="$J" <<
98 fi 33 fi
99 fi 34 fi
100 35
101 if [ "$KBUILD_EXTMOD" != "" ] ; then 36 if [ "$KBUILD_EXTMOD" != "" ] ; then
102 OPTIONS="--patch $srctree $OPTIONS" !! 37 OPTIONS="-patch $srctree $OPTIONS"
103 fi 38 fi
104 39
105 # You can override by using SPFLAGS !! 40 if [ ! -x "$SPATCH" ]; then
106 if [ "$USE_JOBS" = "no" ]; then !! 41 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
107 trap kill_running SIGTERM SIGINT !! 42 exit 1
108 declare -a SPATCH_PID <<
109 elif [ "$NPROC" != "1" ]; then <<
110 # Using 0 should work as well, refer t <<
111 # https://github.com/rdicosmo/parmap/b <<
112 OPTIONS="$OPTIONS --jobs $NPROC --chun <<
113 fi 43 fi
114 44
115 if [ "$MODE" = "" ] ; then 45 if [ "$MODE" = "" ] ; then
116 if [ "$ONLINE" = "0" ] ; then 46 if [ "$ONLINE" = "0" ] ; then
117 echo 'You have not explicitly specifie !! 47 echo 'You have not explicitly specified the mode to use. Using default "chain" mode.'
118 echo 'Available modes are the followin <<
119 echo 'You can specify the mode with "m <<
120 echo 'Note however that some modes are <<
121 fi <<
122 MODE="report" <<
123 fi <<
124 <<
125 if [ "$MODE" = "chain" ] ; then <<
126 if [ "$ONLINE" = "0" ] ; then <<
127 echo 'You have selected the "chain" mo <<
128 echo 'All available modes will be trie 48 echo 'All available modes will be tried (in that order): patch, report, context, org'
>> 49 echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
129 fi 50 fi
>> 51 MODE="chain"
130 elif [ "$MODE" = "report" -o "$MODE" = "org" ] 52 elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
131 FLAGS="--no-show-diff $FLAGS" !! 53 FLAGS="$FLAGS -no_show_diff"
132 fi 54 fi
133 55
134 if [ "$ONLINE" = "0" ] ; then 56 if [ "$ONLINE" = "0" ] ; then
135 echo '' 57 echo ''
136 echo 'Please check for false positives in 58 echo 'Please check for false positives in the output before submitting a patch.'
137 echo 'When using "patch" mode, carefully r 59 echo 'When using "patch" mode, carefully review the patch before submitting it.'
138 echo '' 60 echo ''
139 fi 61 fi
140 62
141 run_cmd_parmap() { <<
142 if [ $VERBOSE -ne 0 ] ; then <<
143 echo "Running ($NPROC in paral <<
144 fi <<
145 if [ "$DEBUG_FILE" != "/dev/null" -a " <<
146 echo $@>>$DEBUG_FILE <<
147 $@ 2>>$DEBUG_FILE <<
148 else <<
149 echo $@ <<
150 $@ 2>&1 <<
151 fi <<
152 <<
153 err=$? <<
154 if [[ $err -ne 0 ]]; then <<
155 echo "coccicheck failed" <<
156 exit $err <<
157 fi <<
158 } <<
159 <<
160 run_cmd_old() { <<
161 local i <<
162 if [ $VERBOSE -ne 0 ] ; then <<
163 echo "Running ($NPROC in paral <<
164 fi <<
165 for i in $(seq 0 $(( NPROC - 1)) ); do <<
166 eval "$@ --max $NPROC --index <<
167 SPATCH_PID[$i]=$! <<
168 if [ $VERBOSE -eq 2 ] ; then <<
169 echo "${SPATCH_PID[$i] <<
170 fi <<
171 done <<
172 wait <<
173 } <<
174 <<
175 run_cmd() { 63 run_cmd() {
176 if [ "$USE_JOBS" = "yes" ]; then !! 64 if [ $VERBOSE -ne 0 ] ; then
177 run_cmd_parmap $@ !! 65 echo "Running: $@"
178 else <<
179 run_cmd_old $@ <<
180 fi 66 fi
>> 67 eval $@
181 } 68 }
182 69
183 kill_running() { <<
184 for i in $(seq 0 $(( NPROC - 1 )) ); d <<
185 if [ $VERBOSE -eq 2 ] ; then <<
186 echo "Killing ${SPATCH <<
187 fi <<
188 kill ${SPATCH_PID[$i]} 2>/dev/ <<
189 done <<
190 } <<
191 <<
192 # You can override heuristics with SPFLAGS, th <<
193 OPTIONS="$OPTIONS $SPFLAGS" <<
194 70
195 coccinelle () { 71 coccinelle () {
196 COCCI="$1" 72 COCCI="$1"
197 73
198 OPT=`grep "Options:" $COCCI | cut -d':' -f !! 74 OPT=`grep "Option" $COCCI | cut -d':' -f2`
199 REQ=`grep "Requires:" $COCCI | cut -d':' - <<
200 if [ -n "$REQ" ] && ! { echo "$REQ"; echo <<
201 echo "Skipping coccinelle SmPL pat <<
202 echo "You have coccinelle: <<
203 echo "This SmPL patch requires: <<
204 return <<
205 fi <<
206 75
207 # The option '--parse-cocci' can be used to !! 76 # The option '-parse_cocci' can be used to syntactically check the SmPL files.
208 # 77 #
209 # $SPATCH -D $MODE $FLAGS -parse_cocci $COC 78 # $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
210 79
211 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; t 80 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
212 81
213 FILE=${COCCI#$srctree/} !! 82 FILE=`echo $COCCI | sed "s|$srctree/||"`
214 83
215 echo "Processing `basename $COCCI`" 84 echo "Processing `basename $COCCI`"
216 echo "with option(s) \"$OPT\"" 85 echo "with option(s) \"$OPT\""
217 echo '' 86 echo ''
218 echo 'Message example to submit a patc 87 echo 'Message example to submit a patch:'
219 88
220 sed -ne 's|^///||p' $COCCI 89 sed -ne 's|^///||p' $COCCI
221 90
222 if [ "$MODE" = "patch" ] ; then 91 if [ "$MODE" = "patch" ] ; then
223 echo ' The semantic patch that mak 92 echo ' The semantic patch that makes this change is available'
224 elif [ "$MODE" = "report" ] ; then 93 elif [ "$MODE" = "report" ] ; then
225 echo ' The semantic patch that mak 94 echo ' The semantic patch that makes this report is available'
226 elif [ "$MODE" = "context" ] ; then 95 elif [ "$MODE" = "context" ] ; then
227 echo ' The semantic patch that spo 96 echo ' The semantic patch that spots this code is available'
228 elif [ "$MODE" = "org" ] ; then 97 elif [ "$MODE" = "org" ] ; then
229 echo ' The semantic patch that mak 98 echo ' The semantic patch that makes this Org report is available'
230 else 99 else
231 echo ' The semantic patch that mak 100 echo ' The semantic patch that makes this output is available'
232 fi 101 fi
233 echo " in $FILE." 102 echo " in $FILE."
234 echo '' 103 echo ''
235 echo ' More information about semantic 104 echo ' More information about semantic patching is available at'
236 echo ' http://coccinelle.lip6.fr/' 105 echo ' http://coccinelle.lip6.fr/'
237 echo '' 106 echo ''
238 107
239 if [ "`sed -ne 's|^//#||p' $COCCI`" ] 108 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
240 echo 'Semantic patch information:' 109 echo 'Semantic patch information:'
241 sed -ne 's|^//#||p' $COCCI 110 sed -ne 's|^//#||p' $COCCI
242 echo '' 111 echo ''
243 fi 112 fi
244 fi 113 fi
245 114
246 if [ "$MODE" = "chain" ] ; then 115 if [ "$MODE" = "chain" ] ; then
247 run_cmd $SPATCH -D patch \ 116 run_cmd $SPATCH -D patch \
248 $FLAGS --cocci-file $COCCI $OP !! 117 $FLAGS -sp_file $COCCI $OPT $OPTIONS || \
249 run_cmd $SPATCH -D report \ 118 run_cmd $SPATCH -D report \
250 $FLAGS --cocci-file $COCCI $OP !! 119 $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || \
251 run_cmd $SPATCH -D context \ 120 run_cmd $SPATCH -D context \
252 $FLAGS --cocci-file $COCCI $OP !! 121 $FLAGS -sp_file $COCCI $OPT $OPTIONS || \
253 run_cmd $SPATCH -D org \ 122 run_cmd $SPATCH -D org \
254 $FLAGS --cocci-file $COCCI $OP !! 123 $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || exit 1
255 elif [ "$MODE" = "rep+ctxt" ] ; then 124 elif [ "$MODE" = "rep+ctxt" ] ; then
256 run_cmd $SPATCH -D report \ 125 run_cmd $SPATCH -D report \
257 $FLAGS --cocci-file $COCCI $OP !! 126 $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff && \
258 run_cmd $SPATCH -D context \ 127 run_cmd $SPATCH -D context \
259 $FLAGS --cocci-file $COCCI $OP !! 128 $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
260 else 129 else
261 run_cmd $SPATCH -D $MODE $FLAGS --co !! 130 run_cmd $SPATCH -D $MODE $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
262 fi 131 fi
263 132
264 } 133 }
265 <<
266 if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_F <<
267 if [ -f $DEBUG_FILE ]; then <<
268 echo "Debug file $DEBUG_FILE e <<
269 exit <<
270 fi <<
271 else <<
272 DEBUG_FILE="/dev/null" <<
273 fi <<
274 134
275 if [ "$COCCI" = "" ] ; then 135 if [ "$COCCI" = "" ] ; then
276 for f in `find $srctree/scripts/coccinelle 136 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
277 coccinelle $f 137 coccinelle $f
278 done 138 done
279 else 139 else
280 coccinelle $COCCI 140 coccinelle $COCCI
281 fi 141 fi
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.