Commit | Line | Data |
---|---|---|
9e395550 | 1 | #!/bin/bash |
b2441318 | 2 | # SPDX-License-Identifier: GPL-2.0 |
c100d537 LR |
3 | # Linux kernel coccicheck |
4 | # | |
1e01892e | 5 | # Read Documentation/dev-tools/coccinelle.rst |
ec97946e NP |
6 | # |
7 | # This script requires at least spatch | |
8 | # version 1.0.0-rc11. | |
ec97946e | 9 | |
a9e064c0 | 10 | DIR="$(dirname $(readlink -f $0))/.." |
74425eee NP |
11 | SPATCH="`which ${SPATCH:=spatch}`" |
12 | ||
13d94865 LR |
13 | if [ ! -x "$SPATCH" ]; then |
14 | echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' | |
15 | exit 1 | |
16 | fi | |
17 | ||
a9e064c0 LR |
18 | SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}') |
19 | SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh) | |
20 | ||
c930a1b2 LR |
21 | USE_JOBS="no" |
22 | $SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes" | |
90d06a46 | 23 | |
26e56720 BS |
24 | # The verbosity may be set by the environmental parameter V= |
25 | # as for example with 'make V=1 coccicheck' | |
26 | ||
27 | if [ -n "$V" -a "$V" != "0" ]; then | |
90d06a46 | 28 | VERBOSE="$V" |
26e56720 BS |
29 | else |
30 | VERBOSE=0 | |
31 | fi | |
32 | ||
90d06a46 KC |
33 | if [ -z "$J" ]; then |
34 | NPROC=$(getconf _NPROCESSORS_ONLN) | |
35 | else | |
36 | NPROC="$J" | |
37 | fi | |
38 | ||
8e826ad5 | 39 | FLAGS="--very-quiet" |
9e395550 | 40 | |
5c384dba LR |
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 | |
43 | # options conflict. | |
44 | # | |
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: | |
47 | # | |
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 | |
50 | # | |
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 | |
54 | # inspected there. | |
55 | # | |
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 | |
58 | if [ $? -eq 0 ]; then | |
59 | FLAGS="--quiet" | |
60 | fi | |
61 | ||
9e395550 NP |
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 } | |
5b169108 | 65 | COCCIINCLUDE=${COCCIINCLUDE// -include/ --include} |
9e395550 | 66 | |
1e9dea2a NP |
67 | if [ "$C" = "1" -o "$C" = "2" ]; then |
68 | ONLINE=1 | |
69 | ||
9e395550 NP |
70 | # Take only the last argument, which is the C file to test |
71 | shift $(( $# - 1 )) | |
72 | OPTIONS="$COCCIINCLUDE $1" | |
1e9dea2a NP |
73 | else |
74 | ONLINE=0 | |
d0bc1fb4 | 75 | if [ "$KBUILD_EXTMOD" = "" ] ; then |
93f14468 | 76 | OPTIONS="--dir $srctree $COCCIINCLUDE" |
d0bc1fb4 | 77 | else |
93f14468 | 78 | OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" |
d0bc1fb4 | 79 | fi |
1e9dea2a NP |
80 | fi |
81 | ||
bad6a409 | 82 | if [ "$KBUILD_EXTMOD" != "" ] ; then |
93f14468 | 83 | OPTIONS="--patch $srctree $OPTIONS" |
bad6a409 NP |
84 | fi |
85 | ||
c930a1b2 LR |
86 | # You can override by using SPFLAGS |
87 | if [ "$USE_JOBS" = "no" ]; then | |
88 | trap kill_running SIGTERM SIGINT | |
89 | declare -a SPATCH_PID | |
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" | |
94 | fi | |
95 | ||
74425eee | 96 | if [ "$MODE" = "" ] ; then |
1e9dea2a | 97 | if [ "$ONLINE" = "0" ] ; then |
1f0a6742 NP |
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' | |
1e9dea2a | 100 | echo 'You can specify the mode with "make coccicheck MODE=<mode>"' |
1f0a6742 NP |
101 | echo 'Note however that some modes are not implemented by some semantic patches.' |
102 | fi | |
103 | MODE="report" | |
104 | fi | |
105 | ||
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' | |
1e9dea2a | 110 | fi |
03ee0c42 | 111 | elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then |
7a2358b3 | 112 | FLAGS="--no-show-diff $FLAGS" |
74425eee NP |
113 | fi |
114 | ||
1e9dea2a NP |
115 | if [ "$ONLINE" = "0" ] ; then |
116 | echo '' | |
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.' | |
119 | echo '' | |
120 | fi | |
74425eee | 121 | |
c930a1b2 LR |
122 | run_cmd_parmap() { |
123 | if [ $VERBOSE -ne 0 ] ; then | |
124 | echo "Running ($NPROC in parallel): $@" | |
125 | fi | |
be1fa900 LR |
126 | if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then |
127 | if [ -f $DEBUG_FILE ]; then | |
128 | echo "Debug file $DEBUG_FILE exists, bailing" | |
129 | exit | |
130 | fi | |
131 | else | |
132 | DEBUG_FILE="/dev/null" | |
133 | fi | |
134 | $@ 2>$DEBUG_FILE | |
c930a1b2 LR |
135 | if [[ $? -ne 0 ]]; then |
136 | echo "coccicheck failed" | |
137 | exit $? | |
138 | fi | |
139 | } | |
140 | ||
141 | run_cmd_old() { | |
90d06a46 | 142 | local i |
5303265a | 143 | if [ $VERBOSE -ne 0 ] ; then |
90d06a46 | 144 | echo "Running ($NPROC in parallel): $@" |
5303265a | 145 | fi |
90d06a46 | 146 | for i in $(seq 0 $(( NPROC - 1)) ); do |
93f14468 | 147 | eval "$@ --max $NPROC --index $i &" |
90d06a46 KC |
148 | SPATCH_PID[$i]=$! |
149 | if [ $VERBOSE -eq 2 ] ; then | |
150 | echo "${SPATCH_PID[$i]} running" | |
151 | fi | |
152 | done | |
153 | wait | |
5303265a BS |
154 | } |
155 | ||
c930a1b2 LR |
156 | run_cmd() { |
157 | if [ "$USE_JOBS" = "yes" ]; then | |
158 | run_cmd_parmap $@ | |
159 | else | |
160 | run_cmd_old $@ | |
161 | fi | |
162 | } | |
163 | ||
90d06a46 | 164 | kill_running() { |
2552a39f | 165 | for i in $(seq 0 $(( NPROC - 1 )) ); do |
90d06a46 KC |
166 | if [ $VERBOSE -eq 2 ] ; then |
167 | echo "Killing ${SPATCH_PID[$i]}" | |
168 | fi | |
169 | kill ${SPATCH_PID[$i]} 2>/dev/null | |
170 | done | |
171 | } | |
5303265a | 172 | |
8e826ad5 LR |
173 | # You can override heuristics with SPFLAGS, these must always go last |
174 | OPTIONS="$OPTIONS $SPFLAGS" | |
175 | ||
1e9dea2a | 176 | coccinelle () { |
74425eee | 177 | COCCI="$1" |
74425eee NP |
178 | |
179 | OPT=`grep "Option" $COCCI | cut -d':' -f2` | |
a9e064c0 LR |
180 | REQ=`grep "Requires" $COCCI | cut -d':' -f2 | sed "s| ||"` |
181 | REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh) | |
182 | if [ "$REQ_NUM" != "0" ] ; then | |
183 | if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then | |
184 | echo "Skipping coccinele SmPL patch: $COCCI" | |
185 | echo "You have coccinelle: $SPATCH_VERSION" | |
186 | echo "This SmPL patch requires: $REQ" | |
187 | return | |
188 | fi | |
189 | fi | |
74425eee | 190 | |
93f14468 | 191 | # The option '--parse-cocci' can be used to syntactically check the SmPL files. |
1e9dea2a NP |
192 | # |
193 | # $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null | |
74425eee | 194 | |
35d88a38 | 195 | if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then |
74425eee | 196 | |
1e9dea2a | 197 | FILE=`echo $COCCI | sed "s|$srctree/||"` |
74425eee | 198 | |
3c908417 NP |
199 | echo "Processing `basename $COCCI`" |
200 | echo "with option(s) \"$OPT\"" | |
201 | echo '' | |
1e9dea2a NP |
202 | echo 'Message example to submit a patch:' |
203 | ||
3c908417 | 204 | sed -ne 's|^///||p' $COCCI |
1e9dea2a | 205 | |
062c1825 NP |
206 | if [ "$MODE" = "patch" ] ; then |
207 | echo ' The semantic patch that makes this change is available' | |
208 | elif [ "$MODE" = "report" ] ; then | |
209 | echo ' The semantic patch that makes this report is available' | |
210 | elif [ "$MODE" = "context" ] ; then | |
211 | echo ' The semantic patch that spots this code is available' | |
212 | elif [ "$MODE" = "org" ] ; then | |
213 | echo ' The semantic patch that makes this Org report is available' | |
214 | else | |
215 | echo ' The semantic patch that makes this output is available' | |
216 | fi | |
1e9dea2a NP |
217 | echo " in $FILE." |
218 | echo '' | |
219 | echo ' More information about semantic patching is available at' | |
220 | echo ' http://coccinelle.lip6.fr/' | |
221 | echo '' | |
222 | ||
3c908417 NP |
223 | if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then |
224 | echo 'Semantic patch information:' | |
225 | sed -ne 's|^//#||p' $COCCI | |
226 | echo '' | |
227 | fi | |
2c1160c8 | 228 | fi |
3c908417 | 229 | |
2c1160c8 | 230 | if [ "$MODE" = "chain" ] ; then |
5303265a | 231 | run_cmd $SPATCH -D patch \ |
93f14468 | 232 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ |
5303265a | 233 | run_cmd $SPATCH -D report \ |
93f14468 | 234 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ |
5303265a | 235 | run_cmd $SPATCH -D context \ |
93f14468 | 236 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ |
5303265a | 237 | run_cmd $SPATCH -D org \ |
93f14468 | 238 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 |
c05cd6dd | 239 | elif [ "$MODE" = "rep+ctxt" ] ; then |
5303265a | 240 | run_cmd $SPATCH -D report \ |
93f14468 | 241 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ |
5303265a | 242 | run_cmd $SPATCH -D context \ |
93f14468 | 243 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 |
1e9dea2a | 244 | else |
93f14468 | 245 | run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 |
1e9dea2a | 246 | fi |
74425eee | 247 | |
74425eee NP |
248 | } |
249 | ||
250 | if [ "$COCCI" = "" ] ; then | |
251 | for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do | |
1e9dea2a | 252 | coccinelle $f |
74425eee NP |
253 | done |
254 | else | |
1e9dea2a | 255 | coccinelle $COCCI |
74425eee | 256 | fi |