scripts/coccicheck

   1 #!/bin/bash
   2
   3 SPATCH="`which ${SPATCH:=spatch}`"
   4
   5 # The verbosity may be set by the environmental parameter V=
   6 # as for example with 'make V=1 coccicheck'
   7
   8 if [ -n "$V" -a "$V" != "0" ]; then
   9         VERBOSE=1
  10 else
  11         VERBOSE=0
  12 fi
  13
  14 FLAGS="$SPFLAGS -very_quiet"
  15
  16 # spatch only allows include directories with the syntax "-I include"
  17 # while gcc also allows "-Iinclude" and "-include include"
  18 COCCIINCLUDE=${LINUXINCLUDE//-I/-I }
  19 COCCIINCLUDE=${COCCIINCLUDE//-include/-I}
  20
  21 if [ "$C" = "1" -o "$C" = "2" ]; then
  22     ONLINE=1
  23
  24     # Take only the last argument, which is the C file to test
  25     shift $(( $# - 1 ))
  26     OPTIONS="$COCCIINCLUDE $1"
  27 else
  28     ONLINE=0
  29     if [ "$KBUILD_EXTMOD" = "" ] ; then
  30         OPTIONS="-dir $srctree $COCCIINCLUDE"
  31     else
  32         OPTIONS="-dir $KBUILD_EXTMOD $COCCIINCLUDE"
  33     fi
  34 fi
  35
  36 if [ "$KBUILD_EXTMOD" != "" ] ; then
  37     OPTIONS="-patch $srctree $OPTIONS"
  38 fi
  39
  40 if [ ! -x "$SPATCH" ]; then
  41     echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
  42     exit 1
  43 fi
  44
  45 if [ "$MODE" = "" ] ; then
  46     if [ "$ONLINE" = "0" ] ; then
  47         echo 'You have not explicitly specified the mode to use. Using default "report" mode.'
  48         echo 'Available modes are the following: patch, report, context, org'
  49         echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
  50         echo 'Note however that some modes are not implemented by some semantic patches.'
  51     fi
  52     MODE="report"
  53 fi
  54
  55 if [ "$MODE" = "chain" ] ; then
  56     if [ "$ONLINE" = "0" ] ; then
  57         echo 'You have selected the "chain" mode.'
  58         echo 'All available modes will be tried (in that order): patch, report, context, org'
  59     fi
  60 elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then
  61     FLAGS="$FLAGS -no_show_diff"
  62 fi
  63
  64 if [ "$ONLINE" = "0" ] ; then
  65     echo ''
  66     echo 'Please check for false positives in the output before submitting a patch.'
  67     echo 'When using "patch" mode, carefully review the patch before submitting it.'
  68     echo ''
  69 fi
  70
  71 run_cmd() {
  72         if [ $VERBOSE -ne 0 ] ; then
  73                 echo "Running: $@"
  74         fi
  75         eval $@
  76 }
  77
  78
  79 coccinelle () {
  80     COCCI="$1"
  81
  82     OPT=`grep "Option" $COCCI | cut -d':' -f2`
  83
  84 #   The option '-parse_cocci' can be used to syntactically check the SmPL files.
  85 #
  86 #    $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
  87
  88     if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then
  89
  90         FILE=`echo $COCCI | sed "s|$srctree/||"`
  91
  92         echo "Processing `basename $COCCI`"
  93         echo "with option(s) \"$OPT\""
  94         echo ''
  95         echo 'Message example to submit a patch:'
  96
  97         sed -ne 's|^///||p' $COCCI
  98
  99         if [ "$MODE" = "patch" ] ; then
 100             echo ' The semantic patch that makes this change is available'
 101         elif [ "$MODE" = "report" ] ; then
 102             echo ' The semantic patch that makes this report is available'
 103         elif [ "$MODE" = "context" ] ; then
 104             echo ' The semantic patch that spots this code is available'
 105         elif [ "$MODE" = "org" ] ; then
 106             echo ' The semantic patch that makes this Org report is available'
 107         else
 108             echo ' The semantic patch that makes this output is available'
 109         fi
 110         echo " in $FILE."
 111         echo ''
 112         echo ' More information about semantic patching is available at'
 113         echo ' http://coccinelle.lip6.fr/'
 114         echo ''
 115
 116         if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
 117             echo 'Semantic patch information:'
 118             sed -ne 's|^//#||p' $COCCI
 119             echo ''
 120         fi
 121     fi
 122
 123     if [ "$MODE" = "chain" ] ; then
 124         run_cmd $SPATCH -D patch   \
 125                 $FLAGS -sp_file $COCCI $OPT $OPTIONS               || \
 126         run_cmd $SPATCH -D report  \
 127                 $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || \
 128         run_cmd $SPATCH -D context \
 129                 $FLAGS -sp_file $COCCI $OPT $OPTIONS               || \
 130         run_cmd $SPATCH -D org     \
 131                 $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff || exit 1
 132     elif [ "$MODE" = "rep+ctxt" ] ; then
 133         run_cmd $SPATCH -D report  \
 134                 $FLAGS -sp_file $COCCI $OPT $OPTIONS -no_show_diff && \
 135         run_cmd $SPATCH -D context \
 136                 $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
 137     else
 138         run_cmd $SPATCH -D $MODE   $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
 139     fi
 140
 141 }
 142
 143 if [ "$COCCI" = "" ] ; then
 144     for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
 145         coccinelle $f
 146     done
 147 else
 148     coccinelle $COCCI
 149 fi