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