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