19e395550SNicolas Palix#!/bin/bash 2b2441318SGreg Kroah-Hartman# SPDX-License-Identifier: GPL-2.0 3c100d537SLuis R. Rodriguez# Linux kernel coccicheck 4c100d537SLuis R. Rodriguez# 51e01892eSMarkus Elfring# Read Documentation/dev-tools/coccinelle.rst 6ec97946eSNicolas Palix# 7ec97946eSNicolas Palix# This script requires at least spatch 8ec97946eSNicolas Palix# version 1.0.0-rc11. 9ec97946eSNicolas Palix 10a9e064c0SLuis R. RodriguezDIR="$(dirname $(readlink -f $0))/.." 1174425eeeSNicolas PalixSPATCH="`which ${SPATCH:=spatch}`" 1274425eeeSNicolas Palix 1313d94865SLuis R. Rodriguezif [ ! -x "$SPATCH" ]; then 1413d94865SLuis R. Rodriguez echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/' 1513d94865SLuis R. Rodriguez exit 1 1613d94865SLuis R. Rodriguezfi 1713d94865SLuis R. Rodriguez 18a9e064c0SLuis R. RodriguezSPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}') 19a9e064c0SLuis R. RodriguezSPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh) 20a9e064c0SLuis R. Rodriguez 21c930a1b2SLuis R. RodriguezUSE_JOBS="no" 22c930a1b2SLuis R. Rodriguez$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes" 2390d06a46SKees Cook 2426e56720SBernd Schubert# The verbosity may be set by the environmental parameter V= 2526e56720SBernd Schubert# as for example with 'make V=1 coccicheck' 2626e56720SBernd Schubert 2726e56720SBernd Schubertif [ -n "$V" -a "$V" != "0" ]; then 2890d06a46SKees Cook VERBOSE="$V" 2926e56720SBernd Schubertelse 3026e56720SBernd Schubert VERBOSE=0 3126e56720SBernd Schubertfi 3226e56720SBernd Schubert 338e826ad5SLuis R. RodriguezFLAGS="--very-quiet" 349e395550SNicolas Palix 355c384dbaSLuis R. Rodriguez# You can use SPFLAGS to append extra arguments to coccicheck or override any 365c384dbaSLuis R. Rodriguez# heuristics done in this file as Coccinelle accepts the last options when 375c384dbaSLuis R. Rodriguez# options conflict. 385c384dbaSLuis R. Rodriguez# 395c384dbaSLuis R. Rodriguez# A good example for use of SPFLAGS is if you want to debug your cocci script, 405c384dbaSLuis R. Rodriguez# you can for instance use the following: 415c384dbaSLuis R. Rodriguez# 425c384dbaSLuis R. Rodriguez# $ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci 435c384dbaSLuis R. Rodriguez# $ make coccicheck MODE=report DEBUG_FILE="all.err" SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c 445c384dbaSLuis R. Rodriguez# 455c384dbaSLuis R. Rodriguez# "--show-trying" should show you what rule is being processed as it goes to 465c384dbaSLuis R. Rodriguez# stdout, you do not need a debug file for that. The profile output will be 475c384dbaSLuis R. Rodriguez# be sent to stdout, if you provide a DEBUG_FILE the profiling data can be 485c384dbaSLuis R. Rodriguez# inspected there. 495c384dbaSLuis R. Rodriguez# 505c384dbaSLuis R. Rodriguez# --profile will not output if --very-quiet is used, so avoid it. 515c384dbaSLuis R. Rodriguezecho $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null 525c384dbaSLuis R. Rodriguezif [ $? -eq 0 ]; then 535c384dbaSLuis R. Rodriguez FLAGS="--quiet" 545c384dbaSLuis R. Rodriguezfi 555c384dbaSLuis R. Rodriguez 569e395550SNicolas Palix# spatch only allows include directories with the syntax "-I include" 579e395550SNicolas Palix# while gcc also allows "-Iinclude" and "-include include" 589e395550SNicolas PalixCOCCIINCLUDE=${LINUXINCLUDE//-I/-I } 595b169108SAndrzej HajdaCOCCIINCLUDE=${COCCIINCLUDE// -include/ --include} 609e395550SNicolas Palix 611e9dea2aSNicolas Palixif [ "$C" = "1" -o "$C" = "2" ]; then 621e9dea2aSNicolas Palix ONLINE=1 631e9dea2aSNicolas Palix 649e395550SNicolas Palix # Take only the last argument, which is the C file to test 651e9dea2aSNicolas Palix shift $(( $# - 1 )) 669e395550SNicolas Palix OPTIONS="$COCCIINCLUDE $1" 67d7059ca0SMasahiro Yamada 68d7059ca0SMasahiro Yamada # No need to parallelize Coccinelle since this mode takes one input file. 69d7059ca0SMasahiro Yamada NPROC=1 701e9dea2aSNicolas Palixelse 711e9dea2aSNicolas Palix ONLINE=0 72d0bc1fb4SGreg Dietsche if [ "$KBUILD_EXTMOD" = "" ] ; then 7393f14468SNicolas Palix OPTIONS="--dir $srctree $COCCIINCLUDE" 74d0bc1fb4SGreg Dietsche else 7593f14468SNicolas Palix OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" 76d0bc1fb4SGreg Dietsche fi 77d7059ca0SMasahiro Yamada 78d7059ca0SMasahiro Yamada if [ -z "$J" ]; then 79d7059ca0SMasahiro Yamada NPROC=$(getconf _NPROCESSORS_ONLN) 80d7059ca0SMasahiro Yamada else 81d7059ca0SMasahiro Yamada NPROC="$J" 82d7059ca0SMasahiro Yamada fi 831e9dea2aSNicolas Palixfi 841e9dea2aSNicolas Palix 85bad6a409SNicolas Palixif [ "$KBUILD_EXTMOD" != "" ] ; then 8693f14468SNicolas Palix OPTIONS="--patch $srctree $OPTIONS" 87bad6a409SNicolas Palixfi 88bad6a409SNicolas Palix 89c930a1b2SLuis R. Rodriguez# You can override by using SPFLAGS 90c930a1b2SLuis R. Rodriguezif [ "$USE_JOBS" = "no" ]; then 91c930a1b2SLuis R. Rodriguez trap kill_running SIGTERM SIGINT 92c930a1b2SLuis R. Rodriguez declare -a SPATCH_PID 93c930a1b2SLuis R. Rodriguezelif [ "$NPROC" != "1" ]; then 94c930a1b2SLuis R. Rodriguez # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on 95c930a1b2SLuis R. Rodriguez # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c 96c930a1b2SLuis R. Rodriguez OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1" 97c930a1b2SLuis R. Rodriguezfi 98c930a1b2SLuis R. Rodriguez 9974425eeeSNicolas Palixif [ "$MODE" = "" ] ; then 1001e9dea2aSNicolas Palix if [ "$ONLINE" = "0" ] ; then 1011f0a6742SNicolas Palix echo 'You have not explicitly specified the mode to use. Using default "report" mode.' 1024b2bd20cSSumera Priyadarsini echo 'Available modes are the following: patch, report, context, org, chain' 10374425eeeSNicolas Palix echo 'You can specify the mode with "make coccicheck MODE=<mode>"' 1041f0a6742SNicolas Palix echo 'Note however that some modes are not implemented by some semantic patches.' 1051e9dea2aSNicolas Palix fi 1061f0a6742SNicolas Palix MODE="report" 1071f0a6742SNicolas Palixfi 1081f0a6742SNicolas Palix 1091f0a6742SNicolas Palixif [ "$MODE" = "chain" ] ; then 1101f0a6742SNicolas Palix if [ "$ONLINE" = "0" ] ; then 1111f0a6742SNicolas Palix echo 'You have selected the "chain" mode.' 1121f0a6742SNicolas Palix echo 'All available modes will be tried (in that order): patch, report, context, org' 1131f0a6742SNicolas Palix fi 11403ee0c42SNicolas Palixelif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then 1157a2358b3SDeepa Dinamani FLAGS="--no-show-diff $FLAGS" 11674425eeeSNicolas Palixfi 11774425eeeSNicolas Palix 1181e9dea2aSNicolas Palixif [ "$ONLINE" = "0" ] ; then 11974425eeeSNicolas Palix echo '' 12074425eeeSNicolas Palix echo 'Please check for false positives in the output before submitting a patch.' 12174425eeeSNicolas Palix echo 'When using "patch" mode, carefully review the patch before submitting it.' 12274425eeeSNicolas Palix echo '' 1231e9dea2aSNicolas Palixfi 12474425eeeSNicolas Palix 125c930a1b2SLuis R. Rodriguezrun_cmd_parmap() { 126c930a1b2SLuis R. Rodriguez if [ $VERBOSE -ne 0 ] ; then 127c930a1b2SLuis R. Rodriguez echo "Running ($NPROC in parallel): $@" 128c930a1b2SLuis R. Rodriguez fi 129*a19d1358SSumera Priyadarsini if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then 1309ed07adaSJulia Lawall echo $@>>$DEBUG_FILE 1319ed07adaSJulia Lawall $@ 2>>$DEBUG_FILE 132*a19d1358SSumera Priyadarsini else 133*a19d1358SSumera Priyadarsini echo $@ 134*a19d1358SSumera Priyadarsini $@ 2>&1 135*a19d1358SSumera Priyadarsini fi 136*a19d1358SSumera Priyadarsini 137512ddf7dSDenis Efremov err=$? 138512ddf7dSDenis Efremov if [[ $err -ne 0 ]]; then 139c930a1b2SLuis R. Rodriguez echo "coccicheck failed" 140512ddf7dSDenis Efremov exit $err 141c930a1b2SLuis R. Rodriguez fi 142c930a1b2SLuis R. Rodriguez} 143c930a1b2SLuis R. Rodriguez 144c930a1b2SLuis R. Rodriguezrun_cmd_old() { 14590d06a46SKees Cook local i 1465303265aSBernd Schubert if [ $VERBOSE -ne 0 ] ; then 14790d06a46SKees Cook echo "Running ($NPROC in parallel): $@" 1485303265aSBernd Schubert fi 14990d06a46SKees Cook for i in $(seq 0 $(( NPROC - 1)) ); do 15093f14468SNicolas Palix eval "$@ --max $NPROC --index $i &" 15190d06a46SKees Cook SPATCH_PID[$i]=$! 15290d06a46SKees Cook if [ $VERBOSE -eq 2 ] ; then 15390d06a46SKees Cook echo "${SPATCH_PID[$i]} running" 15490d06a46SKees Cook fi 15590d06a46SKees Cook done 15690d06a46SKees Cook wait 1575303265aSBernd Schubert} 1585303265aSBernd Schubert 159c930a1b2SLuis R. Rodriguezrun_cmd() { 160c930a1b2SLuis R. Rodriguez if [ "$USE_JOBS" = "yes" ]; then 161c930a1b2SLuis R. Rodriguez run_cmd_parmap $@ 162c930a1b2SLuis R. Rodriguez else 163c930a1b2SLuis R. Rodriguez run_cmd_old $@ 164c930a1b2SLuis R. Rodriguez fi 165c930a1b2SLuis R. Rodriguez} 166c930a1b2SLuis R. Rodriguez 16790d06a46SKees Cookkill_running() { 1682552a39fSKees Cook for i in $(seq 0 $(( NPROC - 1 )) ); do 16990d06a46SKees Cook if [ $VERBOSE -eq 2 ] ; then 17090d06a46SKees Cook echo "Killing ${SPATCH_PID[$i]}" 17190d06a46SKees Cook fi 17290d06a46SKees Cook kill ${SPATCH_PID[$i]} 2>/dev/null 17390d06a46SKees Cook done 17490d06a46SKees Cook} 1755303265aSBernd Schubert 1768e826ad5SLuis R. Rodriguez# You can override heuristics with SPFLAGS, these must always go last 1778e826ad5SLuis R. RodriguezOPTIONS="$OPTIONS $SPFLAGS" 1788e826ad5SLuis R. Rodriguez 1791e9dea2aSNicolas Palixcoccinelle () { 18074425eeeSNicolas Palix COCCI="$1" 18174425eeeSNicolas Palix 182e0be348eSMasahiro Yamada OPT=`grep "Options:" $COCCI | cut -d':' -f2` 183e0be348eSMasahiro Yamada REQ=`grep "Requires:" $COCCI | cut -d':' -f2 | sed "s| ||"` 184a9e064c0SLuis R. Rodriguez REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh) 185a9e064c0SLuis R. Rodriguez if [ "$REQ_NUM" != "0" ] ; then 186a9e064c0SLuis R. Rodriguez if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then 1871640eea3SJulia Lawall echo "Skipping coccinelle SmPL patch: $COCCI" 188a9e064c0SLuis R. Rodriguez echo "You have coccinelle: $SPATCH_VERSION" 189a9e064c0SLuis R. Rodriguez echo "This SmPL patch requires: $REQ" 190a9e064c0SLuis R. Rodriguez return 191a9e064c0SLuis R. Rodriguez fi 192a9e064c0SLuis R. Rodriguez fi 1931e9dea2aSNicolas Palix 19493f14468SNicolas Palix# The option '--parse-cocci' can be used to syntactically check the SmPL files. 1951e9dea2aSNicolas Palix# 1961e9dea2aSNicolas Palix# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null 1971e9dea2aSNicolas Palix 19835d88a38SNicolas Palix if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then 1991e9dea2aSNicolas Palix 200cd1af7cfSMasahiro Yamada FILE=${COCCI#$srctree/} 20174425eeeSNicolas Palix 2023c908417SNicolas Palix echo "Processing `basename $COCCI`" 2033c908417SNicolas Palix echo "with option(s) \"$OPT\"" 2043c908417SNicolas Palix echo '' 20574425eeeSNicolas Palix echo 'Message example to submit a patch:' 20674425eeeSNicolas Palix 2073c908417SNicolas Palix sed -ne 's|^///||p' $COCCI 20874425eeeSNicolas Palix 209062c1825SNicolas Palix if [ "$MODE" = "patch" ] ; then 21074425eeeSNicolas Palix echo ' The semantic patch that makes this change is available' 211062c1825SNicolas Palix elif [ "$MODE" = "report" ] ; then 212062c1825SNicolas Palix echo ' The semantic patch that makes this report is available' 213062c1825SNicolas Palix elif [ "$MODE" = "context" ] ; then 214062c1825SNicolas Palix echo ' The semantic patch that spots this code is available' 215062c1825SNicolas Palix elif [ "$MODE" = "org" ] ; then 216062c1825SNicolas Palix echo ' The semantic patch that makes this Org report is available' 217062c1825SNicolas Palix else 218062c1825SNicolas Palix echo ' The semantic patch that makes this output is available' 219062c1825SNicolas Palix fi 22074425eeeSNicolas Palix echo " in $FILE." 22174425eeeSNicolas Palix echo '' 22274425eeeSNicolas Palix echo ' More information about semantic patching is available at' 22374425eeeSNicolas Palix echo ' http://coccinelle.lip6.fr/' 22474425eeeSNicolas Palix echo '' 22574425eeeSNicolas Palix 2263c908417SNicolas Palix if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then 2273c908417SNicolas Palix echo 'Semantic patch information:' 2283c908417SNicolas Palix sed -ne 's|^//#||p' $COCCI 2293c908417SNicolas Palix echo '' 2303c908417SNicolas Palix fi 2312c1160c8SNicolas Palix fi 2323c908417SNicolas Palix 2332c1160c8SNicolas Palix if [ "$MODE" = "chain" ] ; then 2345303265aSBernd Schubert run_cmd $SPATCH -D patch \ 23593f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 2365303265aSBernd Schubert run_cmd $SPATCH -D report \ 23793f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ 2385303265aSBernd Schubert run_cmd $SPATCH -D context \ 23993f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 2405303265aSBernd Schubert run_cmd $SPATCH -D org \ 24193f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 242c05cd6ddSNicolas Palix elif [ "$MODE" = "rep+ctxt" ] ; then 2435303265aSBernd Schubert run_cmd $SPATCH -D report \ 24493f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ 2455303265aSBernd Schubert run_cmd $SPATCH -D context \ 24693f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 2471e9dea2aSNicolas Palix else 24893f14468SNicolas Palix run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 2491e9dea2aSNicolas Palix fi 25074425eeeSNicolas Palix 25174425eeeSNicolas Palix} 25274425eeeSNicolas Palix 2539ed07adaSJulia Lawallif [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then 2549ed07adaSJulia Lawall if [ -f $DEBUG_FILE ]; then 2559ed07adaSJulia Lawall echo "Debug file $DEBUG_FILE exists, bailing" 2569ed07adaSJulia Lawall exit 2579ed07adaSJulia Lawall fi 2589ed07adaSJulia Lawallelse 2599ed07adaSJulia Lawall DEBUG_FILE="/dev/null" 2609ed07adaSJulia Lawallfi 2619ed07adaSJulia Lawall 26274425eeeSNicolas Palixif [ "$COCCI" = "" ] ; then 26374425eeeSNicolas Palix for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do 2641e9dea2aSNicolas Palix coccinelle $f 26574425eeeSNicolas Palix done 26674425eeeSNicolas Palixelse 2671e9dea2aSNicolas Palix coccinelle $COCCI 26874425eeeSNicolas Palixfi 269