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