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. Rodriguez 20c930a1b2SLuis R. RodriguezUSE_JOBS="no" 21c930a1b2SLuis R. Rodriguez$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes" 2290d06a46SKees Cook 2326e56720SBernd Schubert# The verbosity may be set by the environmental parameter V= 2426e56720SBernd Schubert# as for example with 'make V=1 coccicheck' 2526e56720SBernd Schubert 2626e56720SBernd Schubertif [ -n "$V" -a "$V" != "0" ]; then 2790d06a46SKees Cook VERBOSE="$V" 2826e56720SBernd Schubertelse 2926e56720SBernd Schubert VERBOSE=0 3026e56720SBernd Schubertfi 3126e56720SBernd Schubert 328e826ad5SLuis R. RodriguezFLAGS="--very-quiet" 339e395550SNicolas Palix 345c384dbaSLuis R. Rodriguez# You can use SPFLAGS to append extra arguments to coccicheck or override any 355c384dbaSLuis R. Rodriguez# heuristics done in this file as Coccinelle accepts the last options when 365c384dbaSLuis R. Rodriguez# options conflict. 375c384dbaSLuis R. Rodriguez# 385c384dbaSLuis R. Rodriguez# A good example for use of SPFLAGS is if you want to debug your cocci script, 395c384dbaSLuis R. Rodriguez# you can for instance use the following: 405c384dbaSLuis R. Rodriguez# 415c384dbaSLuis R. Rodriguez# $ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci 425c384dbaSLuis R. Rodriguez# $ make coccicheck MODE=report DEBUG_FILE="all.err" SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c 435c384dbaSLuis R. Rodriguez# 445c384dbaSLuis R. Rodriguez# "--show-trying" should show you what rule is being processed as it goes to 455c384dbaSLuis R. Rodriguez# stdout, you do not need a debug file for that. The profile output will be 465c384dbaSLuis R. Rodriguez# be sent to stdout, if you provide a DEBUG_FILE the profiling data can be 475c384dbaSLuis R. Rodriguez# inspected there. 485c384dbaSLuis R. Rodriguez# 495c384dbaSLuis R. Rodriguez# --profile will not output if --very-quiet is used, so avoid it. 505c384dbaSLuis R. Rodriguezecho $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null 515c384dbaSLuis R. Rodriguezif [ $? -eq 0 ]; then 525c384dbaSLuis R. Rodriguez FLAGS="--quiet" 535c384dbaSLuis R. Rodriguezfi 545c384dbaSLuis R. Rodriguez 559e395550SNicolas Palix# spatch only allows include directories with the syntax "-I include" 569e395550SNicolas Palix# while gcc also allows "-Iinclude" and "-include include" 579e395550SNicolas PalixCOCCIINCLUDE=${LINUXINCLUDE//-I/-I } 585b169108SAndrzej HajdaCOCCIINCLUDE=${COCCIINCLUDE// -include/ --include} 599e395550SNicolas Palix 601e9dea2aSNicolas Palixif [ "$C" = "1" -o "$C" = "2" ]; then 611e9dea2aSNicolas Palix ONLINE=1 621e9dea2aSNicolas Palix 639e395550SNicolas Palix # Take only the last argument, which is the C file to test 641e9dea2aSNicolas Palix shift $(( $# - 1 )) 659e395550SNicolas Palix OPTIONS="$COCCIINCLUDE $1" 66d7059ca0SMasahiro Yamada 67d7059ca0SMasahiro Yamada # No need to parallelize Coccinelle since this mode takes one input file. 68d7059ca0SMasahiro Yamada NPROC=1 691e9dea2aSNicolas Palixelse 701e9dea2aSNicolas Palix ONLINE=0 71d0bc1fb4SGreg Dietsche if [ "$KBUILD_EXTMOD" = "" ] ; then 7293f14468SNicolas Palix OPTIONS="--dir $srctree $COCCIINCLUDE" 73d0bc1fb4SGreg Dietsche else 7493f14468SNicolas Palix OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" 75d0bc1fb4SGreg Dietsche fi 76d7059ca0SMasahiro Yamada 77e16a7c47SSumera Priyadarsini # Use only one thread per core by default if hyperthreading is enabled 782f324dd8SSumera Priyadarsini THREADS_PER_CORE=$(lscpu | grep "Thread(s) per core: " | tr -cd "[:digit:]") 79d7059ca0SMasahiro Yamada if [ -z "$J" ]; then 80d7059ca0SMasahiro Yamada NPROC=$(getconf _NPROCESSORS_ONLN) 81c5864560SSumera Priyadarsini if [ $THREADS_PER_CORE -gt 1 -a $NPROC -gt 4 ] ; then 82e16a7c47SSumera Priyadarsini NPROC=$((NPROC/2)) 83e16a7c47SSumera Priyadarsini fi 84d7059ca0SMasahiro Yamada else 85d7059ca0SMasahiro Yamada NPROC="$J" 86d7059ca0SMasahiro Yamada fi 871e9dea2aSNicolas Palixfi 881e9dea2aSNicolas Palix 89bad6a409SNicolas Palixif [ "$KBUILD_EXTMOD" != "" ] ; then 9093f14468SNicolas Palix OPTIONS="--patch $srctree $OPTIONS" 91bad6a409SNicolas Palixfi 92bad6a409SNicolas Palix 93c930a1b2SLuis R. Rodriguez# You can override by using SPFLAGS 94c930a1b2SLuis R. Rodriguezif [ "$USE_JOBS" = "no" ]; then 95c930a1b2SLuis R. Rodriguez trap kill_running SIGTERM SIGINT 96c930a1b2SLuis R. Rodriguez declare -a SPATCH_PID 97c930a1b2SLuis R. Rodriguezelif [ "$NPROC" != "1" ]; then 98c930a1b2SLuis R. Rodriguez # Using 0 should work as well, refer to _SC_NPROCESSORS_ONLN use on 99c930a1b2SLuis R. Rodriguez # https://github.com/rdicosmo/parmap/blob/master/setcore_stubs.c 100c930a1b2SLuis R. Rodriguez OPTIONS="$OPTIONS --jobs $NPROC --chunksize 1" 101c930a1b2SLuis R. Rodriguezfi 102c930a1b2SLuis R. Rodriguez 10374425eeeSNicolas Palixif [ "$MODE" = "" ] ; then 1041e9dea2aSNicolas Palix if [ "$ONLINE" = "0" ] ; then 1051f0a6742SNicolas Palix echo 'You have not explicitly specified the mode to use. Using default "report" mode.' 1064b2bd20cSSumera Priyadarsini echo 'Available modes are the following: patch, report, context, org, chain' 10774425eeeSNicolas Palix echo 'You can specify the mode with "make coccicheck MODE=<mode>"' 1081f0a6742SNicolas Palix echo 'Note however that some modes are not implemented by some semantic patches.' 1091e9dea2aSNicolas Palix fi 1101f0a6742SNicolas Palix MODE="report" 1111f0a6742SNicolas Palixfi 1121f0a6742SNicolas Palix 1131f0a6742SNicolas Palixif [ "$MODE" = "chain" ] ; then 1141f0a6742SNicolas Palix if [ "$ONLINE" = "0" ] ; then 1151f0a6742SNicolas Palix echo 'You have selected the "chain" mode.' 1161f0a6742SNicolas Palix echo 'All available modes will be tried (in that order): patch, report, context, org' 1171f0a6742SNicolas Palix fi 11803ee0c42SNicolas Palixelif [ "$MODE" = "report" -o "$MODE" = "org" ] ; then 1197a2358b3SDeepa Dinamani FLAGS="--no-show-diff $FLAGS" 12074425eeeSNicolas Palixfi 12174425eeeSNicolas Palix 1221e9dea2aSNicolas Palixif [ "$ONLINE" = "0" ] ; then 12374425eeeSNicolas Palix echo '' 12474425eeeSNicolas Palix echo 'Please check for false positives in the output before submitting a patch.' 12574425eeeSNicolas Palix echo 'When using "patch" mode, carefully review the patch before submitting it.' 12674425eeeSNicolas Palix echo '' 1271e9dea2aSNicolas Palixfi 12874425eeeSNicolas Palix 129c930a1b2SLuis R. Rodriguezrun_cmd_parmap() { 130c930a1b2SLuis R. Rodriguez if [ $VERBOSE -ne 0 ] ; then 131c930a1b2SLuis R. Rodriguez echo "Running ($NPROC in parallel): $@" 132c930a1b2SLuis R. Rodriguez fi 133a19d1358SSumera Priyadarsini if [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then 1349ed07adaSJulia Lawall echo $@>>$DEBUG_FILE 1359ed07adaSJulia Lawall $@ 2>>$DEBUG_FILE 136a19d1358SSumera Priyadarsini else 137a19d1358SSumera Priyadarsini echo $@ 138a19d1358SSumera Priyadarsini $@ 2>&1 139a19d1358SSumera Priyadarsini fi 140a19d1358SSumera Priyadarsini 141512ddf7dSDenis Efremov err=$? 142512ddf7dSDenis Efremov if [[ $err -ne 0 ]]; then 143c930a1b2SLuis R. Rodriguez echo "coccicheck failed" 144512ddf7dSDenis Efremov exit $err 145c930a1b2SLuis R. Rodriguez fi 146c930a1b2SLuis R. Rodriguez} 147c930a1b2SLuis R. Rodriguez 148c930a1b2SLuis R. Rodriguezrun_cmd_old() { 14990d06a46SKees Cook local i 1505303265aSBernd Schubert if [ $VERBOSE -ne 0 ] ; then 15190d06a46SKees Cook echo "Running ($NPROC in parallel): $@" 1525303265aSBernd Schubert fi 15390d06a46SKees Cook for i in $(seq 0 $(( NPROC - 1)) ); do 15493f14468SNicolas Palix eval "$@ --max $NPROC --index $i &" 15590d06a46SKees Cook SPATCH_PID[$i]=$! 15690d06a46SKees Cook if [ $VERBOSE -eq 2 ] ; then 15790d06a46SKees Cook echo "${SPATCH_PID[$i]} running" 15890d06a46SKees Cook fi 15990d06a46SKees Cook done 16090d06a46SKees Cook wait 1615303265aSBernd Schubert} 1625303265aSBernd Schubert 163c930a1b2SLuis R. Rodriguezrun_cmd() { 164c930a1b2SLuis R. Rodriguez if [ "$USE_JOBS" = "yes" ]; then 165c930a1b2SLuis R. Rodriguez run_cmd_parmap $@ 166c930a1b2SLuis R. Rodriguez else 167c930a1b2SLuis R. Rodriguez run_cmd_old $@ 168c930a1b2SLuis R. Rodriguez fi 169c930a1b2SLuis R. Rodriguez} 170c930a1b2SLuis R. Rodriguez 17190d06a46SKees Cookkill_running() { 1722552a39fSKees Cook for i in $(seq 0 $(( NPROC - 1 )) ); do 17390d06a46SKees Cook if [ $VERBOSE -eq 2 ] ; then 17490d06a46SKees Cook echo "Killing ${SPATCH_PID[$i]}" 17590d06a46SKees Cook fi 17690d06a46SKees Cook kill ${SPATCH_PID[$i]} 2>/dev/null 17790d06a46SKees Cook done 17890d06a46SKees Cook} 1795303265aSBernd Schubert 1808e826ad5SLuis R. Rodriguez# You can override heuristics with SPFLAGS, these must always go last 1818e826ad5SLuis R. RodriguezOPTIONS="$OPTIONS $SPFLAGS" 1828e826ad5SLuis R. Rodriguez 1831e9dea2aSNicolas Palixcoccinelle () { 18474425eeeSNicolas Palix COCCI="$1" 18574425eeeSNicolas Palix 186e0be348eSMasahiro Yamada OPT=`grep "Options:" $COCCI | cut -d':' -f2` 187e0be348eSMasahiro Yamada REQ=`grep "Requires:" $COCCI | cut -d':' -f2 | sed "s| ||"` 188*33114c43SMasahiro Yamada if [ -n "$REQ" ] && ! { echo "$REQ"; echo "$SPATCH_VERSION"; } | sort -CV ; then 1891640eea3SJulia Lawall echo "Skipping coccinelle SmPL patch: $COCCI" 190a9e064c0SLuis R. Rodriguez echo "You have coccinelle: $SPATCH_VERSION" 191a9e064c0SLuis R. Rodriguez echo "This SmPL patch requires: $REQ" 192a9e064c0SLuis R. Rodriguez return 193a9e064c0SLuis R. Rodriguez fi 1941e9dea2aSNicolas Palix 19593f14468SNicolas Palix# The option '--parse-cocci' can be used to syntactically check the SmPL files. 1961e9dea2aSNicolas Palix# 1971e9dea2aSNicolas Palix# $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null 1981e9dea2aSNicolas Palix 19935d88a38SNicolas Palix if [ $VERBOSE -ne 0 -a $ONLINE -eq 0 ] ; then 2001e9dea2aSNicolas Palix 201cd1af7cfSMasahiro Yamada FILE=${COCCI#$srctree/} 20274425eeeSNicolas Palix 2033c908417SNicolas Palix echo "Processing `basename $COCCI`" 2043c908417SNicolas Palix echo "with option(s) \"$OPT\"" 2053c908417SNicolas Palix echo '' 20674425eeeSNicolas Palix echo 'Message example to submit a patch:' 20774425eeeSNicolas Palix 2083c908417SNicolas Palix sed -ne 's|^///||p' $COCCI 20974425eeeSNicolas Palix 210062c1825SNicolas Palix if [ "$MODE" = "patch" ] ; then 21174425eeeSNicolas Palix echo ' The semantic patch that makes this change is available' 212062c1825SNicolas Palix elif [ "$MODE" = "report" ] ; then 213062c1825SNicolas Palix echo ' The semantic patch that makes this report is available' 214062c1825SNicolas Palix elif [ "$MODE" = "context" ] ; then 215062c1825SNicolas Palix echo ' The semantic patch that spots this code is available' 216062c1825SNicolas Palix elif [ "$MODE" = "org" ] ; then 217062c1825SNicolas Palix echo ' The semantic patch that makes this Org report is available' 218062c1825SNicolas Palix else 219062c1825SNicolas Palix echo ' The semantic patch that makes this output is available' 220062c1825SNicolas Palix fi 22174425eeeSNicolas Palix echo " in $FILE." 22274425eeeSNicolas Palix echo '' 22374425eeeSNicolas Palix echo ' More information about semantic patching is available at' 22474425eeeSNicolas Palix echo ' http://coccinelle.lip6.fr/' 22574425eeeSNicolas Palix echo '' 22674425eeeSNicolas Palix 2273c908417SNicolas Palix if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then 2283c908417SNicolas Palix echo 'Semantic patch information:' 2293c908417SNicolas Palix sed -ne 's|^//#||p' $COCCI 2303c908417SNicolas Palix echo '' 2313c908417SNicolas Palix fi 2322c1160c8SNicolas Palix fi 2333c908417SNicolas Palix 2342c1160c8SNicolas Palix if [ "$MODE" = "chain" ] ; then 2355303265aSBernd Schubert run_cmd $SPATCH -D patch \ 23693f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 2375303265aSBernd Schubert run_cmd $SPATCH -D report \ 23893f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || \ 2395303265aSBernd Schubert run_cmd $SPATCH -D context \ 24093f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS || \ 2415303265aSBernd Schubert run_cmd $SPATCH -D org \ 24293f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff || exit 1 243c05cd6ddSNicolas Palix elif [ "$MODE" = "rep+ctxt" ] ; then 2445303265aSBernd Schubert run_cmd $SPATCH -D report \ 24593f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS --no-show-diff && \ 2465303265aSBernd Schubert run_cmd $SPATCH -D context \ 24793f14468SNicolas Palix $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 2481e9dea2aSNicolas Palix else 24993f14468SNicolas Palix run_cmd $SPATCH -D $MODE $FLAGS --cocci-file $COCCI $OPT $OPTIONS || exit 1 2501e9dea2aSNicolas Palix fi 25174425eeeSNicolas Palix 25274425eeeSNicolas Palix} 25374425eeeSNicolas Palix 2549ed07adaSJulia Lawallif [ "$DEBUG_FILE" != "/dev/null" -a "$DEBUG_FILE" != "" ]; then 2559ed07adaSJulia Lawall if [ -f $DEBUG_FILE ]; then 2569ed07adaSJulia Lawall echo "Debug file $DEBUG_FILE exists, bailing" 2579ed07adaSJulia Lawall exit 2589ed07adaSJulia Lawall fi 2599ed07adaSJulia Lawallelse 2609ed07adaSJulia Lawall DEBUG_FILE="/dev/null" 2619ed07adaSJulia Lawallfi 2629ed07adaSJulia Lawall 26374425eeeSNicolas Palixif [ "$COCCI" = "" ] ; then 26474425eeeSNicolas Palix for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do 2651e9dea2aSNicolas Palix coccinelle $f 26674425eeeSNicolas Palix done 26774425eeeSNicolas Palixelse 2681e9dea2aSNicolas Palix coccinelle $COCCI 26974425eeeSNicolas Palixfi 270