scripts/coccicheck

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