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,ENOSYS,\
  31 FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\
  32 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\
  33 PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,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) [-h] [-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/main..").
  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         # forbid variable declaration inside "for" loop
  73         awk -v FOLDERS='.' \
  74                 -v EXPRESSIONS='for[[:space:]]*\\((char|u?int|unsigned|s?size_t)' \
  75                 -v RET_ON_FAIL=1 \
  76                 -v MESSAGE='Declaring a variable inside for()' \
  77                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
  78                 "$1" || res=1
  79
  80         # refrain from new additions of 16/32/64 bits rte_atomicNN_xxx()
  81         awk -v FOLDERS="lib drivers app examples" \
  82                 -v EXPRESSIONS="rte_atomic[0-9][0-9]_.*\\\(" \
  83                 -v RET_ON_FAIL=1 \
  84                 -v MESSAGE='Using rte_atomicNN_xxx' \
  85                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
  86                 "$1" || res=1
  87
  88         # refrain from new additions of rte_smp_[r/w]mb()
  89         awk -v FOLDERS="lib drivers app examples" \
  90                 -v EXPRESSIONS="rte_smp_(r|w)?mb\\\(" \
  91                 -v RET_ON_FAIL=1 \
  92                 -v MESSAGE='Using rte_smp_[r/w]mb' \
  93                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
  94                 "$1" || res=1
  95
  96         # refrain from using compiler __sync_xxx builtins
  97         awk -v FOLDERS="lib drivers app examples" \
  98                 -v EXPRESSIONS="__sync_.*\\\(" \
  99                 -v RET_ON_FAIL=1 \
 100                 -v MESSAGE='Using __sync_xxx builtins' \
 101                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 102                 "$1" || res=1
 103
 104         # refrain from using compiler __atomic_thread_fence()
 105         # It should be avoided on x86 for SMP case.
 106         awk -v FOLDERS="lib drivers app examples" \
 107                 -v EXPRESSIONS="__atomic_thread_fence\\\(" \
 108                 -v RET_ON_FAIL=1 \
 109                 -v MESSAGE='Using __atomic_thread_fence' \
 110                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 111                 "$1" || res=1
 112
 113         # forbid use of experimental build flag except in examples
 114         awk -v FOLDERS='lib drivers app' \
 115                 -v EXPRESSIONS='-DALLOW_EXPERIMENTAL_API allow_experimental_apis' \
 116                 -v RET_ON_FAIL=1 \
 117                 -v MESSAGE='Using experimental build flag for in-tree compilation' \
 118                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 119                 "$1" || res=1
 120
 121         # svg figures must be included with wildcard extension
 122         # because of png conversion for pdf docs
 123         awk -v FOLDERS='doc' \
 124                 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
 125                 -v RET_ON_FAIL=1 \
 126                 -v MESSAGE='Using explicit .svg extension instead of .*' \
 127                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 128                 "$1" || res=1
 129
 130         # links must prefer https over http
 131         awk -v FOLDERS='doc' \
 132                 -v EXPRESSIONS='http://.*dpdk.org' \
 133                 -v RET_ON_FAIL=1 \
 134                 -v MESSAGE='Using non https link to dpdk.org' \
 135                 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
 136                 "$1" || res=1
 137
 138         return $res
 139 }
 140
 141 check_experimental_tags() { # <patch>
 142         res=0
 143
 144         cat "$1" |awk '
 145         BEGIN {
 146                 current_file = "";
 147                 ret = 0;
 148         }
 149         /^+++ b\// {
 150                 current_file = $2;
 151         }
 152         /^+.*__rte_experimental/ {
 153                 if (current_file ~ ".c$" ) {
 154                         print "Please only put __rte_experimental tags in " \
 155                                 "headers ("current_file")";
 156                         ret = 1;
 157                 }
 158                 if ($1 != "+__rte_experimental" || $2 != "") {
 159                         print "__rte_experimental must appear alone on the line" \
 160                                 " immediately preceding the return type of a function."
 161                         ret = 1;
 162                 }
 163         }
 164         END {
 165                 exit ret;
 166         }' || res=1
 167
 168         return $res
 169 }
 170
 171 check_internal_tags() { # <patch>
 172         res=0
 173
 174         cat "$1" |awk '
 175         BEGIN {
 176                 current_file = "";
 177                 ret = 0;
 178         }
 179         /^+++ b\// {
 180                 current_file = $2;
 181         }
 182         /^+.*__rte_internal/ {
 183                 if (current_file ~ ".c$" ) {
 184                         print "Please only put __rte_internal tags in " \
 185                                 "headers ("current_file")";
 186                         ret = 1;
 187                 }
 188                 if ($1 != "+__rte_internal" || $2 != "") {
 189                         print "__rte_internal must appear alone on the line" \
 190                                 " immediately preceding the return type of" \
 191                                 " a function."
 192                         ret = 1;
 193                 }
 194         }
 195         END {
 196                 exit ret;
 197         }' || res=1
 198
 199         return $res
 200 }
 201
 202 number=0
 203 range='origin/main..'
 204 quiet=false
 205 verbose=false
 206 while getopts hn:qr:v ARG ; do
 207         case $ARG in
 208                 n ) number=$OPTARG ;;
 209                 q ) quiet=true ;;
 210                 r ) range=$OPTARG ;;
 211                 v ) verbose=true ;;
 212                 h ) print_usage ; exit 0 ;;
 213                 ? ) print_usage ; exit 1 ;;
 214         esac
 215 done
 216 shift $(($OPTIND - 1))
 217
 218 if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
 219         print_usage >&2
 220         echo
 221         echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
 222         exit 1
 223 fi
 224
 225 print_headline() { # <title>
 226         printf '\n### %s\n\n' "$1"
 227         headline_printed=true
 228 }
 229
 230 total=0
 231 status=0
 232
 233 check () { # <patch> <commit> <title>
 234         local ret=0
 235         headline_printed=false
 236
 237         total=$(($total + 1))
 238         ! $verbose || print_headline "$3"
 239         if [ -n "$1" ] ; then
 240                 tmpinput=$1
 241         else
 242                 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
 243                 trap "rm -f '$tmpinput'" INT
 244
 245                 if [ -n "$2" ] ; then
 246                         git format-patch --find-renames \
 247                         --no-stat --stdout -1 $commit > "$tmpinput"
 248                 else
 249                         cat > "$tmpinput"
 250                 fi
 251         fi
 252
 253         ! $verbose || printf 'Running checkpatch.pl:\n'
 254         report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
 255         if [ $? -ne 0 ] ; then
 256                 $headline_printed || print_headline "$3"
 257                 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
 258                 ret=1
 259         fi
 260
 261         ! $verbose || printf '\nChecking API additions/removals:\n'
 262         report=$($VALIDATE_NEW_API "$tmpinput")
 263         if [ $? -ne 0 ] ; then
 264                 $headline_printed || print_headline "$3"
 265                 printf '%s\n' "$report"
 266                 ret=1
 267         fi
 268
 269         ! $verbose || printf '\nChecking forbidden tokens additions:\n'
 270         report=$(check_forbidden_additions "$tmpinput")
 271         if [ $? -ne 0 ] ; then
 272                 $headline_printed || print_headline "$3"
 273                 printf '%s\n' "$report"
 274                 ret=1
 275         fi
 276
 277         ! $verbose || printf '\nChecking __rte_experimental tags:\n'
 278         report=$(check_experimental_tags "$tmpinput")
 279         if [ $? -ne 0 ] ; then
 280                 $headline_printed || print_headline "$3"
 281                 printf '%s\n' "$report"
 282                 ret=1
 283         fi
 284
 285         ! $verbose || printf '\nChecking __rte_internal tags:\n'
 286         report=$(check_internal_tags "$tmpinput")
 287         if [ $? -ne 0 ] ; then
 288                 $headline_printed || print_headline "$3"
 289                 printf '%s\n' "$report"
 290                 ret=1
 291         fi
 292
 293         if [ "$tmpinput" != "$1" ]; then
 294                 rm -f "$tmpinput"
 295                 trap - INT
 296         fi
 297         [ $ret -eq 0 ] && return 0
 298
 299         status=$(($status + 1))
 300 }
 301
 302 if [ -n "$1" ] ; then
 303         for patch in "$@" ; do
 304                 # Subject can be on 2 lines
 305                 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch")
 306                 check "$patch" '' "$subject"
 307         done
 308 elif [ ! -t 0 ] ; then # stdin
 309         subject=$(while read header value ; do
 310                 if [ "$header" = 'Subject:' ] ; then
 311                         IFS= read next
 312                         continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p')
 313                         echo $value$continuation
 314                         break
 315                 fi
 316         done)
 317         check '' '' "$subject"
 318 else
 319         if [ $number -eq 0 ] ; then
 320                 commits=$(git rev-list --reverse $range)
 321         else
 322                 commits=$(git rev-list --reverse --max-count=$number HEAD)
 323         fi
 324         for commit in $commits ; do
 325                 subject=$(git log --format='%s' -1 $commit)
 326                 check '' $commit "$subject"
 327         done
 328 fi
 329 pass=$(($total - $status))
 330 $quiet || printf '\n%d/%d valid patch' $pass $total
 331 $quiet || [ $pass -le 1 ] || printf 'es'
 332 $quiet || printf '\n'
 333 exit $status