devtools/checkpatches.sh

   1 #! /bin/sh
   2 # SPDX-License-Identifier: BSD-3-Clause
   3 # Copyright 2015 6WIND S.A.
   4
   5 # Load config options:
   6 # - DPDK_CHECKPATCH_PATH
   7 # - DPDK_CHECKPATCH_CODESPELL
   8 # - DPDK_CHECKPATCH_LINE_LENGTH
   9 . $(dirname $(readlink -e $0))/load-devel-config
  10
  11 VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
  12
  13 # Enable codespell by default. This can be overwritten from a config file.
  14 # Codespell can also be enabled by setting DPDK_CHECKPATCH_CODESPELL to a valid path
  15 # to a dictionary.txt file if dictionary.txt is not in the default location.
  16 codespell=${DPDK_CHECKPATCH_CODESPELL:-enable}
  17 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
  18
  19 # override default Linux options
  20 options="--no-tree"
  21 if [ "$codespell" = "enable" ] ; then
  22     options="$options --codespell"
  23 elif [ -f "$codespell" ] ; then
  24     options="$options --codespell"
  25     options="$options --codespellfile $codespell"
  26 fi
  27 options="$options --max-line-length=$length"
  28 options="$options --show-types"
  29 options="$options --ignore=LINUX_VERSION_CODE,\
  30 FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\
  31 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\
  32 PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
  33 SPLIT_STRING,LONG_LINE_STRING,\
  34 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
  35 NEW_TYPEDEFS,COMPARISON_TO_NULL"
  36
  37 clean_tmp_files() {
  38         if echo $tmpinput | grep -q '^checkpatches\.' ; then
  39                 rm -f "$tmpinput"
  40         fi
  41 }
  42
  43 trap "clean_tmp_files" INT
  44
  45 print_usage () {
  46         cat <<- END_OF_HELP
  47         usage: $(basename $0) [-q] [-v] [-nX|-r range|patch1 [patch2] ...]]
  48
  49         Run Linux kernel checkpatch.pl with DPDK options.
  50         The environment variable DPDK_CHECKPATCH_PATH must be set.
  51
  52         The patches to check can be from stdin, files specified on the command line,
  53         latest git commits limited with -n option, or commits in the git range
  54         specified with -r option (default: "origin/master..").
  55         END_OF_HELP
  56 }
  57
  58 check_forbidden_additions() { # <patch>
  59         res=0
  60
  61         # refrain from new additions of rte_panic() and rte_exit()
  62         # multiple folders and expressions are separated by spaces
  63         awk -v FOLDERS="lib drivers" \
  64                 -v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \
  65                 -v RET_ON_FAIL=1 \
  66                 -v MESSAGE='Using rte_panic/rte_exit' \
  67                 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
  68                 "$1" || res=1
  69
  70         # svg figures must be included with wildcard extension
  71         # because of png conversion for pdf docs
  72         awk -v FOLDERS='doc' \
  73                 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
  74                 -v RET_ON_FAIL=1 \
  75                 -v MESSAGE='Using explicit .svg extension instead of .*' \
  76                 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
  77                 "$1" || res=1
  78
  79         return $res
  80 }
  81
  82 check_experimental_tags() { # <patch>
  83         res=0
  84
  85         cat "$1" |awk '
  86         BEGIN {
  87                 current_file = "";
  88                 ret = 0;
  89         }
  90         /^+++ b\// {
  91                 current_file = $2;
  92         }
  93         /^+.*__rte_experimental/ {
  94                 if (current_file ~ ".c$" ) {
  95                         print "Please only put __rte_experimental tags in " \
  96                                 "headers ("current_file")";
  97                         ret = 1;
  98                 }
  99         }
 100         END {
 101                 exit ret;
 102         }' || res=1
 103
 104         return $res
 105 }
 106
 107 number=0
 108 range='origin/master..'
 109 quiet=false
 110 verbose=false
 111 while getopts hn:qr:v ARG ; do
 112         case $ARG in
 113                 n ) number=$OPTARG ;;
 114                 q ) quiet=true ;;
 115                 r ) range=$OPTARG ;;
 116                 v ) verbose=true ;;
 117                 h ) print_usage ; exit 0 ;;
 118                 ? ) print_usage ; exit 1 ;;
 119         esac
 120 done
 121 shift $(($OPTIND - 1))
 122
 123 if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
 124         print_usage >&2
 125         echo
 126         echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
 127         exit 1
 128 fi
 129
 130 print_headline() { # <title>
 131         printf '\n### %s\n\n' "$1"
 132         headline_printed=true
 133 }
 134
 135 total=0
 136 status=0
 137
 138 check () { # <patch> <commit> <title>
 139         local ret=0
 140         headline_printed=false
 141
 142         total=$(($total + 1))
 143         ! $verbose || print_headline "$3"
 144         if [ -n "$1" ] ; then
 145                 tmpinput=$1
 146         elif [ -n "$2" ] ; then
 147                 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 148                 git format-patch --find-renames \
 149                 --no-stat --stdout -1 $commit > "$tmpinput"
 150         else
 151                 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 152                 cat > "$tmpinput"
 153         fi
 154
 155         ! $verbose || printf 'Running checkpatch.pl:\n'
 156         report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
 157         if [ $? -ne 0 ] ; then
 158                 $headline_printed || print_headline "$3"
 159                 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
 160                 ret=1
 161         fi
 162
 163         ! $verbose || printf '\nChecking API additions/removals:\n'
 164         report=$($VALIDATE_NEW_API "$tmpinput")
 165         if [ $? -ne 0 ] ; then
 166                 $headline_printed || print_headline "$3"
 167                 printf '%s\n' "$report"
 168                 ret=1
 169         fi
 170
 171         ! $verbose || printf '\nChecking forbidden tokens additions:\n'
 172         report=$(check_forbidden_additions "$tmpinput")
 173         if [ $? -ne 0 ] ; then
 174                 $headline_printed || print_headline "$3"
 175                 printf '%s\n' "$report"
 176                 ret=1
 177         fi
 178
 179         ! $verbose || printf '\nChecking __rte_experimental tags:\n'
 180         report=$(check_experimental_tags "$tmpinput")
 181         if [ $? -ne 0 ] ; then
 182                 $headline_printed || print_headline "$3"
 183                 printf '%s\n' "$report"
 184                 ret=1
 185         fi
 186
 187         clean_tmp_files
 188         [ $ret -eq 0 ] && return 0
 189
 190         status=$(($status + 1))
 191 }
 192
 193 if [ -n "$1" ] ; then
 194         for patch in "$@" ; do
 195                 # Subject can be on 2 lines
 196                 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch")
 197                 check "$patch" '' "$subject"
 198         done
 199 elif [ ! -t 0 ] ; then # stdin
 200         subject=$(while read header value ; do
 201                 if [ "$header" = 'Subject:' ] ; then
 202                         IFS= read next
 203                         continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p')
 204                         echo $value$continuation
 205                         break
 206                 fi
 207         done)
 208         check '' '' "$subject"
 209 else
 210         if [ $number -eq 0 ] ; then
 211                 commits=$(git rev-list --reverse $range)
 212         else
 213                 commits=$(git rev-list --reverse --max-count=$number HEAD)
 214         fi
 215         for commit in $commits ; do
 216                 subject=$(git log --format='%s' -1 $commit)
 217                 check '' $commit "$subject"
 218         done
 219 fi
 220 pass=$(($total - $status))
 221 $quiet || printf '\n%d/%d valid patch' $pass $total
 222 $quiet || [ $pass -le 1 ] || printf 'es'
 223 $quiet || printf '\n'
 224 exit $status