Nicolas Palix | 9e39555 | 2013-03-02 22:36:26 +0100 | [diff] [blame] | 1 | #!/bin/bash |
Greg Kroah-Hartman | b244131 | 2017-11-01 15:07:57 +0100 | [diff] [blame] | 2 | # SPDX-License-Identifier: GPL-2.0 |
Luis R. Rodriguez | c100d53 | 2016-06-29 15:14:58 -0700 | [diff] [blame] | 3 | # Linux kernel coccicheck |
| 4 | # |
Markus Elfring | 1e01892 | 2016-10-07 16:06:15 +0200 | [diff] [blame] | 5 | # Read Documentation/dev-tools/coccinelle.rst |
Nicolas Palix | ec97946 | 2013-07-03 16:41:01 +0200 | [diff] [blame] | 6 | # |
| 7 | # This script requires at least spatch |
| 8 | # version 1.0.0-rc11. |
Nicolas Palix | ec97946 | 2013-07-03 16:41:01 +0200 | [diff] [blame] | 9 | |
Luis R. Rodriguez | a9e064c | 2016-06-29 15:14:57 -0700 | [diff] [blame] | 10 | DIR="$(dirname $(readlink -f $0))/.." |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 11 | SPATCH="`which ${SPATCH:=spatch}`" |
| 12 | |
Luis R. Rodriguez | 13d9486 | 2016-06-29 15:14:51 -0700 | [diff] [blame] | 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 | |
Luis R. Rodriguez | a9e064c | 2016-06-29 15:14:57 -0700 | [diff] [blame] | 18 | SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}') |
| 19 | SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh) |
| 20 | |
Luis R. Rodriguez | c930a1b | 2016-06-29 15:14:53 -0700 | [diff] [blame] | 21 | USE_JOBS="no" |
| 22 | $SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes" |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 23 | |
Bernd Schubert | 26e5672 | 2013-01-29 17:03:37 +0100 | [diff] [blame] | 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 |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 28 | VERBOSE="$V" |
Bernd Schubert | 26e5672 | 2013-01-29 17:03:37 +0100 | [diff] [blame] | 29 | else |
| 30 | VERBOSE=0 |
| 31 | fi |
| 32 | |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 33 | if [ -z "$J" ]; then |
| 34 | NPROC=$(getconf _NPROCESSORS_ONLN) |
| 35 | else |
| 36 | NPROC="$J" |
| 37 | fi |
| 38 | |
Luis R. Rodriguez | 8e826ad | 2016-06-29 15:14:52 -0700 | [diff] [blame] | 39 | FLAGS="--very-quiet" |
Nicolas Palix | 9e39555 | 2013-03-02 22:36:26 +0100 | [diff] [blame] | 40 | |
Luis R. Rodriguez | 5c384db | 2016-06-29 15:14:55 -0700 | [diff] [blame] | 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 | |
Nicolas Palix | 9e39555 | 2013-03-02 22:36:26 +0100 | [diff] [blame] | 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 } |
Andrzej Hajda | 5b16910 | 2015-09-22 15:15:30 +0200 | [diff] [blame] | 65 | COCCIINCLUDE=${COCCIINCLUDE// -include/ --include} |
Nicolas Palix | 9e39555 | 2013-03-02 22:36:26 +0100 | [diff] [blame] | 66 | |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 67 | if [ "$C" = "1" -o "$C" = "2" ]; then |
| 68 | ONLINE=1 |
| 69 | |
Nicolas Palix | 9e39555 | 2013-03-02 22:36:26 +0100 | [diff] [blame] | 70 | # Take only the last argument, which is the C file to test |
| 71 | shift $(( $# - 1 )) |
| 72 | OPTIONS="$COCCIINCLUDE $1" |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 73 | else |
| 74 | ONLINE=0 |
Greg Dietsche | d0bc1fb | 2011-11-05 20:59:43 -0500 | [diff] [blame] | 75 | if [ "$KBUILD_EXTMOD" = "" ] ; then |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 76 | OPTIONS="--dir $srctree $COCCIINCLUDE" |
Greg Dietsche | d0bc1fb | 2011-11-05 20:59:43 -0500 | [diff] [blame] | 77 | else |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 78 | OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" |
Greg Dietsche | d0bc1fb | 2011-11-05 20:59:43 -0500 | [diff] [blame] | 79 | fi |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 80 | fi |
| 81 | |
Nicolas Palix | bad6a40 | 2013-03-02 22:36:28 +0100 | [diff] [blame] | 82 | if [ "$KBUILD_EXTMOD" != "" ] ; then |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 83 | OPTIONS="--patch $srctree $OPTIONS" |
Nicolas Palix | bad6a40 | 2013-03-02 22:36:28 +0100 | [diff] [blame] | 84 | fi |
| 85 | |
Luis R. Rodriguez | c930a1b | 2016-06-29 15:14:53 -0700 | [diff] [blame] | 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 | |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 96 | if [ "$MODE" = "" ] ; then |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 97 | if [ "$ONLINE" = "0" ] ; then |
Nicolas Palix | 1f0a674 | 2013-06-06 23:39:52 +0200 | [diff] [blame] | 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' |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 100 | echo 'You can specify the mode with "make coccicheck MODE=<mode>"' |
Nicolas Palix | 1f0a674 | 2013-06-06 23:39:52 +0200 | [diff] [blame] | 101 | echo 'Note however that some modes are not implemented by some semantic patches.' |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 102 | fi |
Nicolas Palix | 1f0a674 | 2013-06-06 23:39:52 +0200 | [diff] [blame] | 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 |
Nicolas Palix | 03ee0c4 | 2010-10-08 21:27:41 +0200 | [diff] [blame] | 111 | elif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then |
Deepa Dinamani | 7a2358b | 2016-06-12 12:04:39 -0700 | [diff] [blame] | 112 | FLAGS="--no-show-diff $FLAGS" |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 113 | fi |
| 114 | |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 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 |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 121 | |
Luis R. Rodriguez | c930a1b | 2016-06-29 15:14:53 -0700 | [diff] [blame] | 122 | run_cmd_parmap() { |
| 123 | if [ $VERBOSE -ne 0 ] ; then |
| 124 | echo "Running ($NPROC in parallel): $@" |
| 125 | fi |
Luis R. Rodriguez | be1fa90 | 2016-06-29 15:14:54 -0700 | [diff] [blame] | 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 |
Luis R. Rodriguez | c930a1b | 2016-06-29 15:14:53 -0700 | [diff] [blame] | 135 | if [[ $? -ne 0 ]]; then |
| 136 | echo "coccicheck failed" |
| 137 | exit $? |
| 138 | fi |
| 139 | } |
| 140 | |
| 141 | run_cmd_old() { |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 142 | local i |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 143 | if [ $VERBOSE -ne 0 ] ; then |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 144 | echo "Running ($NPROC in parallel): $@" |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 145 | fi |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 146 | for i in $(seq 0 $(( NPROC - 1)) ); do |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 147 | eval "$@ --max $NPROC --index $i &" |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 148 | SPATCH_PID[$i]=$! |
| 149 | if [ $VERBOSE -eq 2 ] ; then |
| 150 | echo "${SPATCH_PID[$i]} running" |
| 151 | fi |
| 152 | done |
| 153 | wait |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 154 | } |
| 155 | |
Luis R. Rodriguez | c930a1b | 2016-06-29 15:14:53 -0700 | [diff] [blame] | 156 | run_cmd() { |
| 157 | if [ "$USE_JOBS" = "yes" ]; then |
| 158 | run_cmd_parmap $@ |
| 159 | else |
| 160 | run_cmd_old $@ |
| 161 | fi |
| 162 | } |
| 163 | |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 164 | kill_running() { |
Kees Cook | 2552a39 | 2016-05-16 05:55:58 -0700 | [diff] [blame] | 165 | for i in $(seq 0 $(( NPROC - 1 )) ); do |
Kees Cook | 90d06a4 | 2013-06-18 14:49:29 -0700 | [diff] [blame] | 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 | } |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 172 | |
Luis R. Rodriguez | 8e826ad | 2016-06-29 15:14:52 -0700 | [diff] [blame] | 173 | # You can override heuristics with SPFLAGS, these must always go last |
| 174 | OPTIONS="$OPTIONS $SPFLAGS" |
| 175 | |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 176 | coccinelle () { |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 177 | COCCI="$1" |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 178 | |
| 179 | OPT=`grep "Option" $COCCI | cut -d':' -f2` |
Luis R. Rodriguez | a9e064c | 2016-06-29 15:14:57 -0700 | [diff] [blame] | 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 |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 190 | |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 191 | # The option '--parse-cocci' can be used to syntactically check the SmPL files. |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 192 | # |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 193 | # $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 194 | |
Nicolas Palix | 35d88a3 | 2013-03-02 22:36:25 +0100 | [diff] [blame] | 195 | if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 196 | |
| 197 | FILE=`echo $COCCI | sed "s|$srctree/||"` |
| 198 | |
Nicolas Palix | 3c90841 | 2010-10-08 21:27:38 +0200 | [diff] [blame] | 199 | echo "Processing `basename $COCCI`" |
| 200 | echo "with option(s) \"$OPT\"" |
| 201 | echo '' |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 202 | echo 'Message example to submit a patch:' |
| 203 | |
Nicolas Palix | 3c90841 | 2010-10-08 21:27:38 +0200 | [diff] [blame] | 204 | sed -ne 's|^///||p' $COCCI |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 205 | |
Nicolas Palix | 062c182 | 2010-10-24 23:37:34 +0200 | [diff] [blame] | 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 |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 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 | |
Nicolas Palix | 3c90841 | 2010-10-08 21:27:38 +0200 | [diff] [blame] | 223 | if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then |
| 224 | echo 'Semantic patch information:' |
| 225 | sed -ne 's|^//#||p' $COCCI |
| 226 | echo '' |
| 227 | fi |
Nicolas Palix | 2c1160c8 | 2010-10-08 21:27:40 +0200 | [diff] [blame] | 228 | fi |
Nicolas Palix | 3c90841 | 2010-10-08 21:27:38 +0200 | [diff] [blame] | 229 | |
Nicolas Palix | 2c1160c8 | 2010-10-08 21:27:40 +0200 | [diff] [blame] | 230 | if [ "$MODE" = "chain" ] ; then |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 231 | run_cmd $SPATCH -D patch \ |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 232 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 233 | run_cmd $SPATCH -D report \ |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 234 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 235 | run_cmd $SPATCH -D context \ |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 236 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 237 | run_cmd $SPATCH -D org \ |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 238 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 |
Nicolas Palix | c05cd6d | 2012-09-20 22:30:46 +0200 | [diff] [blame] | 239 | elif [ "$MODE" = "rep+ctxt" ] ; then |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 240 | run_cmd $SPATCH -D report \ |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 241 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ |
Bernd Schubert | 5303265 | 2013-01-29 17:03:42 +0100 | [diff] [blame] | 242 | run_cmd $SPATCH -D context \ |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 243 | $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 244 | else |
Nicolas Palix | 93f1446 | 2013-06-20 13:10:56 +0200 | [diff] [blame] | 245 | run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 246 | fi |
| 247 | |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 248 | } |
| 249 | |
| 250 | if [ "$COCCI" = "" ] ; then |
| 251 | for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 252 | coccinelle $f |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 253 | done |
| 254 | else |
Nicolas Palix | 1e9dea2 | 2010-06-13 09:26:34 +0200 | [diff] [blame] | 255 | coccinelle $COCCI |
Nicolas Palix | 74425ee | 2010-06-06 17:15:01 +0200 | [diff] [blame] | 256 | fi |