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 10if [ ! -x "$SPATCH" ]; then 11 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' 12 exit 1 13fi 14 15USE_JOBS="no" 16$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes" 17 18# The verbosity may be set by the environmental parameter V= 19# as for example with 'make V=1 coccicheck' 20 21if [ -n "$V" -a "$V" != "0" ]; then 22 VERBOSE="$V" 23else 24 VERBOSE=0 25fi 26 27if [ -z "$J" ]; then 28 NPROC=$(getconf _NPROCESSORS_ONLN) 29else 30 NPROC="$J" 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" 67else 68 ONLINE=0 69 if [ "$KBUILD_EXTMOD" = "" ] ; then 70 OPTIONS="--dir $srctree $COCCIINCLUDE" 71 else 72 OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" 73 fi 74fi 75 76if [ "$KBUILD_EXTMOD" != "" ] ; then 77 OPTIONS="--patch $srctree $OPTIONS" 78fi 79 80# You can override by using SPFLAGS 81if [ "$USE_JOBS" = "no" ]; then 82 trap kill_running SIGTERM SIGINT 83 declare -a SPATCH_PID 84elif [ "$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" 88fi 89 90if [ "$MODE" = "" ] ; then 91 if [ "$ONLINE" = "0" ] ; then 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' 94 echo 'You can specify the mode with "make coccicheck MODE=<mode>"' 95 echo 'Note however that some modes are not implemented by some semantic patches.' 96 fi 97 MODE="report" 98fi 99 100if [ "$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' 104 fi 105elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then 106 FLAGS="--no-show-diff $FLAGS" 107fi 108 109if [ "$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 '' 114fi 115 116run_cmd_parmap() { 117 if [ $VERBOSE -ne 0 ] ; then 118 echo "Running ($NPROC in parallel): $@" 119 fi 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 129 if [[ $? -ne 0 ]]; then 130 echo "coccicheck failed" 131 exit $? 132 fi 133} 134 135run_cmd_old() { 136 local i 137 if [ $VERBOSE -ne 0 ] ; then 138 echo "Running ($NPROC in parallel): $@" 139 fi 140 for i in $(seq 0 $(( NPROC - 1)) ); do 141 eval "$@ --max $NPROC --index $i &" 142 SPATCH_PID[$i]=$! 143 if [ $VERBOSE -eq 2 ] ; then 144 echo "${SPATCH_PID[$i]} running" 145 fi 146 done 147 wait 148} 149 150run_cmd() { 151 if [ "$USE_JOBS" = "yes" ]; then 152 run_cmd_parmap $@ 153 else 154 run_cmd_old $@ 155 fi 156} 157 158kill_running() { 159 for i in $(seq 0 $(( NPROC - 1 )) ); do 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} 166 167# You can override heuristics with SPFLAGS, these must always go last 168OPTIONS="$OPTIONS $SPFLAGS" 169 170coccinelle () { 171 COCCI="$1" 172 173 OPT=`grep "Option" $COCCI | cut -d':' -f2` 174 175# The option '--parse-cocci' can be used to syntactically check the SmPL files. 176# 177# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null 178 179 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then 180 181 FILE=`echo $COCCI | sed "s|$srctree/||"` 182 183 echo "Processing `basename $COCCI`" 184 echo "with option(s) \"$OPT\"" 185 echo '' 186 echo 'Message example to submit a patch:' 187 188 sed -ne 's|^///||p' $COCCI 189 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 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 207 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then 208 echo 'Semantic patch information:' 209 sed -ne 's|^//#||p' $COCCI 210 echo '' 211 fi 212 fi 213 214 if [ "$MODE" = "chain" ] ; then 215 run_cmd $SPATCH -D patch \ 216 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 217 run_cmd $SPATCH -D report \ 218 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ 219 run_cmd $SPATCH -D context \ 220 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 221 run_cmd $SPATCH -D org \ 222 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 223 elif [ "$MODE" = "rep+ctxt" ] ; then 224 run_cmd $SPATCH -D report \ 225 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ 226 run_cmd $SPATCH -D context \ 227 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 228 else 229 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 230 fi 231 232} 233 234if [ "$COCCI" = "" ] ; then 235 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do 236 coccinelle $f 237 done 238else 239 coccinelle $COCCI 240fi 241