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 10DIR="$(dirname $(readlink -f $0))/.." 11SPATCH="`which ${SPATCH:=spatch}`" 12 13if [ ! -x "$SPATCH" ]; then 14 echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' 15 exit 1 16fi 17 18SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}') 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 # Use only one thread per core by default if hyperthreading is enabled 78 THREADS_PER_CORE=$(lscpu | grep "Thread(s) per core: " | tr -cd "[:digit:]") 79 if [ -z "$J" ]; then 80 NPROC=$(getconf _NPROCESSORS_ONLN) 81 if [ $THREADS_PER_CORE -gt 1 -a $NPROC -gt 4 ] ; then 82 NPROC=$((NPROC/2)) 83 fi 84 else 85 NPROC="$J" 86 fi 87fi 88 89if [ "$KBUILD_EXTMOD" != "" ] ; then 90 OPTIONS="--patch $srctree $OPTIONS" 91fi 92 93# You can override by using SPFLAGS 94if [ "$USE_JOBS" = "no" ]; then 95 trap kill_running SIGTERM SIGINT 96 declare -a SPATCH_PID 97elif [ "$NPROC" != "1" ]; then 98 # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on 99 # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c 100 OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1" 101fi 102 103if [ "$MODE" = "" ] ; then 104 if [ "$ONLINE" = "0" ] ; then 105 echo 'You have not explicitly specified the mode to use. Using default "report" mode.' 106 echo 'Available modes are the following: patch, report, context, org, chain' 107 echo 'You can specify the mode with "make coccicheck MODE=<mode>"' 108 echo 'Note however that some modes are not implemented by some semantic patches.' 109 fi 110 MODE="report" 111fi 112 113if [ "$MODE" = "chain" ] ; then 114 if [ "$ONLINE" = "0" ] ; then 115 echo 'You have selected the "chain" mode.' 116 echo 'All available modes will be tried (in that order): patch, report, context, org' 117 fi 118elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then 119 FLAGS="--no-show-diff $FLAGS" 120fi 121 122if [ "$ONLINE" = "0" ] ; then 123 echo '' 124 echo 'Please check for false positives in the output before submitting a patch.' 125 echo 'When using "patch" mode, carefully review the patch before submitting it.' 126 echo '' 127fi 128 129run_cmd_parmap() { 130 if [ $VERBOSE -ne 0 ] ; then 131 echo "Running ($NPROC in parallel): $@" 132 fi 133 if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then 134 echo $@>>$DEBUG_FILE 135 $@ 2>>$DEBUG_FILE 136 else 137 echo $@ 138 $@ 2>&1 139 fi 140 141 err=$? 142 if [[ $err -ne 0 ]]; then 143 echo "coccicheck failed" 144 exit $err 145 fi 146} 147 148run_cmd_old() { 149 local i 150 if [ $VERBOSE -ne 0 ] ; then 151 echo "Running ($NPROC in parallel): $@" 152 fi 153 for i in $(seq 0 $(( NPROC - 1)) ); do 154 eval "$@ --max $NPROC --index $i &" 155 SPATCH_PID[$i]=$! 156 if [ $VERBOSE -eq 2 ] ; then 157 echo "${SPATCH_PID[$i]} running" 158 fi 159 done 160 wait 161} 162 163run_cmd() { 164 if [ "$USE_JOBS" = "yes" ]; then 165 run_cmd_parmap $@ 166 else 167 run_cmd_old $@ 168 fi 169} 170 171kill_running() { 172 for i in $(seq 0 $(( NPROC - 1 )) ); do 173 if [ $VERBOSE -eq 2 ] ; then 174 echo "Killing ${SPATCH_PID[$i]}" 175 fi 176 kill ${SPATCH_PID[$i]} 2>/dev/null 177 done 178} 179 180# You can override heuristics with SPFLAGS, these must always go last 181OPTIONS="$OPTIONS $SPFLAGS" 182 183coccinelle () { 184 COCCI="$1" 185 186 OPT=`grep "Options:" $COCCI | cut -d':' -f2` 187 REQ=`grep "Requires:" $COCCI | cut -d':' -f2 | sed "s| ||"` 188 if [ -n "$REQ" ] && ! { echo "$REQ"; echo "$SPATCH_VERSION"; } | sort -CV ; then 189 echo "Skipping coccinelle SmPL patch: $COCCI" 190 echo "You have coccinelle: $SPATCH_VERSION" 191 echo "This SmPL patch requires: $REQ" 192 return 193 fi 194 195# The option '--parse-cocci' can be used to syntactically check the SmPL files. 196# 197# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null 198 199 if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then 200 201 FILE=${COCCI#$srctree/} 202 203 echo "Processing `basename $COCCI`" 204 echo "with option(s) \"$OPT\"" 205 echo '' 206 echo 'Message example to submit a patch:' 207 208 sed -ne 's|^///||p' $COCCI 209 210 if [ "$MODE" = "patch" ] ; then 211 echo ' The semantic patch that makes this change is available' 212 elif [ "$MODE" = "report" ] ; then 213 echo ' The semantic patch that makes this report is available' 214 elif [ "$MODE" = "context" ] ; then 215 echo ' The semantic patch that spots this code is available' 216 elif [ "$MODE" = "org" ] ; then 217 echo ' The semantic patch that makes this Org report is available' 218 else 219 echo ' The semantic patch that makes this output is available' 220 fi 221 echo " in $FILE." 222 echo '' 223 echo ' More information about semantic patching is available at' 224 echo ' http://coccinelle.lip6.fr/' 225 echo '' 226 227 if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then 228 echo 'Semantic patch information:' 229 sed -ne 's|^//#||p' $COCCI 230 echo '' 231 fi 232 fi 233 234 if [ "$MODE" = "chain" ] ; then 235 run_cmd $SPATCH -D patch \ 236 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 237 run_cmd $SPATCH -D report \ 238 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ 239 run_cmd $SPATCH -D context \ 240 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 241 run_cmd $SPATCH -D org \ 242 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 243 elif [ "$MODE" = "rep+ctxt" ] ; then 244 run_cmd $SPATCH -D report \ 245 $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ 246 run_cmd $SPATCH -D context \ 247 $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 248 else 249 run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 250 fi 251 252} 253 254if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then 255 if [ -f $DEBUG_FILE ]; then 256 echo "Debug file $DEBUG_FILE exists, bailing" 257 exit 258 fi 259else 260 DEBUG_FILE="/dev/null" 261fi 262 263if [ "$COCCI" = "" ] ; then 264 for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do 265 coccinelle $f 266 done 267else 268 coccinelle $COCCI 269fi 270