scripts/coccicheck

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