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