Commit | Line | Data |
---|---|---|
9e395550 | 1 | #!/bin/bash |
74425eee | 2 | |
ec97946e NP |
3 | # |
4 | # This script requires at least spatch | |
5 | # version 1.0.0-rc11. | |
6 | # | |
7 | ||
74425eee NP |
8 | SPATCH="`which ${SPATCH:=spatch}`" |
9 | ||
13d94865 LR |
10 | if [ ! -x "$SPATCH" ]; then |
11 | echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' | |
12 | exit 1 | |
13 | fi | |
14 | ||
c930a1b2 LR |
15 | USE_JOBS="no" |
16 | $SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes" | |
90d06a46 | 17 | |
26e56720 BS |
18 | # The verbosity may be set by the environmental parameter V= |
19 | # as for example with 'make V=1 coccicheck' | |
20 | ||
21 | if [ -n "$V" -a "$V" != "0" ]; then | |
90d06a46 | 22 | VERBOSE="$V" |
26e56720 BS |
23 | else |
24 | VERBOSE=0 | |
25 | fi | |
26 | ||
90d06a46 KC |
27 | if [ -z "$J" ]; then |
28 | NPROC=$(getconf _NPROCESSORS_ONLN) | |
29 | else | |
30 | NPROC="$J" | |
31 | fi | |
32 | ||
8e826ad5 | 33 | FLAGS="--very-quiet" |
9e395550 | 34 | |
5c384dba LR |
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. | |
51 | echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null | |
52 | if [ $? -eq 0 ]; then | |
53 | FLAGS="--quiet" | |
54 | fi | |
55 | ||
9e395550 NP |
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 } | |
5b169108 | 59 | COCCIINCLUDE=${COCCIINCLUDE// -include/ --include} |
9e395550 | 60 | |
1e9dea2a NP |
61 | if [ "$C" = "1" -o "$C" = "2" ]; then |
62 | ONLINE=1 | |
63 | ||
9e395550 NP |
64 | # Take only the last argument, which is the C file to test |
65 | shift $(( $# - 1 )) | |
66 | OPTIONS="$COCCIINCLUDE $1" | |
1e9dea2a NP |
67 | else |
68 | ONLINE=0 | |
d0bc1fb4 | 69 | if [ "$KBUILD_EXTMOD" = "" ] ; then |
93f14468 | 70 | OPTIONS="--dir $srctree $COCCIINCLUDE" |
d0bc1fb4 | 71 | else |
93f14468 | 72 | OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" |
d0bc1fb4 | 73 | fi |
1e9dea2a NP |
74 | fi |
75 | ||
bad6a409 | 76 | if [ "$KBUILD_EXTMOD" != "" ] ; then |
93f14468 | 77 | OPTIONS="--patch $srctree $OPTIONS" |
bad6a409 NP |
78 | fi |
79 | ||
c930a1b2 LR |
80 | # You can override by using SPFLAGS |
81 | if [ "$USE_JOBS" = "no" ]; then | |
82 | trap kill_running SIGTERM SIGINT | |
83 | declare -a SPATCH_PID | |
84 | elif [ "$NPROC" != "1" ]; then | |
85 | # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on | |
86 | # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c | |
87 | OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1" | |
88 | fi | |
89 | ||
74425eee | 90 | if [ "$MODE" = "" ] ; then |
1e9dea2a | 91 | if [ "$ONLINE" = "0" ] ; then |
1f0a6742 NP |
92 | echo 'You have not explicitly specified the mode to use. Using default "report" mode.' |
93 | echo 'Available modes are the following: patch, report, context, org' | |
1e9dea2a | 94 | echo 'You can specify the mode with "make coccicheck MODE=<mode>"' |
1f0a6742 NP |
95 | echo 'Note however that some modes are not implemented by some semantic patches.' |
96 | fi | |
97 | MODE="report" | |
98 | fi | |
99 | ||
100 | if [ "$MODE" = "chain" ] ; then | |
101 | if [ "$ONLINE" = "0" ] ; then | |
102 | echo 'You have selected the "chain" mode.' | |
103 | echo 'All available modes will be tried (in that order): patch, report, context, org' | |
1e9dea2a | 104 | fi |
03ee0c42 | 105 | elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then |
7a2358b3 | 106 | FLAGS="--no-show-diff $FLAGS" |
74425eee NP |
107 | fi |
108 | ||
1e9dea2a NP |
109 | if [ "$ONLINE" = "0" ] ; then |
110 | echo '' | |
111 | echo 'Please check for false positives in the output before submitting a patch.' | |
112 | echo 'When using "patch" mode, carefully review the patch before submitting it.' | |
113 | echo '' | |
114 | fi | |
74425eee | 115 | |
c930a1b2 LR |
116 | run_cmd_parmap() { |
117 | if [ $VERBOSE -ne 0 ] ; then | |
118 | echo "Running ($NPROC in parallel): $@" | |
119 | fi | |
be1fa900 LR |
120 | if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then |
121 | if [ -f $DEBUG_FILE ]; then | |
122 | echo "Debug file $DEBUG_FILE exists, bailing" | |
123 | exit | |
124 | fi | |
125 | else | |
126 | DEBUG_FILE="/dev/null" | |
127 | fi | |
128 | $@ 2>$DEBUG_FILE | |
c930a1b2 LR |
129 | if [[ $? -ne 0 ]]; then |
130 | echo "coccicheck failed" | |
131 | exit $? | |
132 | fi | |
133 | } | |
134 | ||
135 | run_cmd_old() { | |
90d06a46 | 136 | local i |
5303265a | 137 | if [ $VERBOSE -ne 0 ] ; then |
90d06a46 | 138 | echo "Running ($NPROC in parallel): $@" |
5303265a | 139 | fi |
90d06a46 | 140 | for i in $(seq 0 $(( NPROC - 1)) ); do |
93f14468 | 141 | eval "$@ --max $NPROC --index $i &" |
90d06a46 KC |
142 | SPATCH_PID[$i]=$! |
143 | if [ $VERBOSE -eq 2 ] ; then | |
144 | echo "${SPATCH_PID[$i]} running" | |
145 | fi | |
146 | done | |
147 | wait | |
5303265a BS |
148 | } |
149 | ||
c930a1b2 LR |
150 | run_cmd() { |
151 | if [ "$USE_JOBS" = "yes" ]; then | |
152 | run_cmd_parmap $@ | |
153 | else | |
154 | run_cmd_old $@ | |
155 | fi | |
156 | } | |
157 | ||
90d06a46 | 158 | kill_running() { |
2552a39f | 159 | for i in $(seq 0 $(( NPROC - 1 )) ); do |
90d06a46 KC |
160 | if [ $VERBOSE -eq 2 ] ; then |
161 | echo "Killing ${SPATCH_PID[$i]}" | |
162 | fi | |
163 | kill ${SPATCH_PID[$i]} 2>/dev/null | |
164 | done | |
165 | } | |
5303265a | 166 | |
8e826ad5 LR |
167 | # You can override heuristics with SPFLAGS, these must always go last |
168 | OPTIONS="$OPTIONS $SPFLAGS" | |
169 | ||
1e9dea2a | 170 | coccinelle () { |
74425eee | 171 | COCCI="$1" |
74425eee NP |
172 | |
173 | OPT=`grep "Option" $COCCI | cut -d':' -f2` | |
74425eee | 174 | |
93f14468 | 175 | # The option '--parse-cocci' can be used to syntactically check the SmPL files. |
1e9dea2a NP |
176 | # |
177 | # $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null | |
74425eee | 178 | |
35d88a38 | 179 | if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then |
74425eee | 180 | |
1e9dea2a | 181 | FILE=`echo $COCCI | sed "s|$srctree/||"` |
74425eee | 182 | |
3c908417 NP |
183 | echo "Processing `basename $COCCI`" |
184 | echo "with option(s) \"$OPT\"" | |
185 | echo '' | |
1e9dea2a NP |
186 | echo 'Message example to submit a patch:' |
187 | ||
3c908417 | 188 | sed -ne 's|^///||p' $COCCI |
1e9dea2a | 189 | |
062c1825 NP |
190 | if [ "$MODE" = "patch" ] ; then |
191 | echo ' The semantic patch that makes this change is available' | |
192 | elif [ "$MODE" = "report" ] ; then | |
193 | echo ' The semantic patch that makes this report is available' | |
194 | elif [ "$MODE" = "context" ] ; then | |
195 | echo ' The semantic patch that spots this code is available' | |
196 | elif [ "$MODE" = "org" ] ; then | |
197 | echo ' The semantic patch that makes this Org report is available' | |
198 | else | |
199 | echo ' The semantic patch that makes this output is available' | |
200 | fi | |
1e9dea2a NP |
201 | echo " in $FILE." |
202 | echo '' | |
203 | echo ' More information about semantic patching is available at' | |
204 | echo ' http://coccinelle.lip6.fr/' | |
205 | echo '' | |
206 | ||
3c908417 NP |
207 | if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then |
208 | echo 'Semantic patch information:' | |
209 | sed -ne 's|^//#||p' $COCCI | |
210 | echo '' | |
211 | fi | |
2c1160c8 | 212 | fi |
3c908417 | 213 | |
2c1160c8 | 214 | if [ "$MODE" = "chain" ] ; then |
5303265a | 215 | run_cmd $SPATCH -D patch \ |
93f14468 | 216 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ |
5303265a | 217 | run_cmd $SPATCH -D report \ |
93f14468 | 218 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ |
5303265a | 219 | run_cmd $SPATCH -D context \ |
93f14468 | 220 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ |
5303265a | 221 | run_cmd $SPATCH -D org \ |
93f14468 | 222 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 |
c05cd6dd | 223 | elif [ "$MODE" = "rep+ctxt" ] ; then |
5303265a | 224 | run_cmd $SPATCH -D report \ |
93f14468 | 225 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ |
5303265a | 226 | run_cmd $SPATCH -D context \ |
93f14468 | 227 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 |
1e9dea2a | 228 | else |
93f14468 | 229 | run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 |
1e9dea2a | 230 | fi |
74425eee | 231 | |
74425eee NP |
232 | } |
233 | ||
234 | if [ "$COCCI" = "" ] ; then | |
235 | for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do | |
1e9dea2a | 236 | coccinelle $f |
74425eee NP |
237 | done |
238 | else | |
1e9dea2a | 239 | coccinelle $COCCI |
74425eee | 240 | fi |