scripts/coccicheck

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