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