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 12VALIDATE_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. 17codespell=${DPDK_CHECKPATCH_CODESPELL:-enable} 18length=${DPDK_CHECKPATCH_LINE_LENGTH:-80} 19 20# override default Linux options 21options="--no-tree" 22if [ "$codespell" = "enable" ] ; then 23 options="$options --codespell" 24elif [ -f "$codespell" ] ; then 25 options="$options --codespell" 26 options="$options --codespellfile $codespell" 27fi 28options="$options --max-line-length=$length" 29options="$options --show-types" 30options="$options --ignore=LINUX_VERSION_CODE,ENOSYS,\ 31FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\ 32VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\ 33PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,BIT_MACRO,CONST_STRUCT,\ 34SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\ 35LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\ 36NEW_TYPEDEFS,COMPARISON_TO_NULL" 37options="$options $DPDK_CHECKPATCH_OPTIONS" 38 39print_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 52check_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 # SVG must be included with wildcard extension to allow conversion 130 awk -v FOLDERS='doc' \ 131 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \ 132 -v RET_ON_FAIL=1 \ 133 -v MESSAGE='Using explicit .svg extension instead of .*' \ 134 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 135 "$1" || res=1 136 137 # links must prefer https over http 138 awk -v FOLDERS='doc' \ 139 -v EXPRESSIONS='http://.*dpdk.org' \ 140 -v RET_ON_FAIL=1 \ 141 -v MESSAGE='Using non https link to dpdk.org' \ 142 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 143 "$1" || res=1 144 145 return $res 146} 147 148check_experimental_tags() { # <patch> 149 res=0 150 151 cat "$1" |awk ' 152 BEGIN { 153 current_file = ""; 154 ret = 0; 155 } 156 /^+++ b\// { 157 current_file = $2; 158 } 159 /^+.*__rte_experimental/ { 160 if (current_file ~ ".c$" ) { 161 print "Please only put __rte_experimental tags in " \ 162 "headers ("current_file")"; 163 ret = 1; 164 } 165 if ($1 != "+__rte_experimental" || $2 != "") { 166 print "__rte_experimental must appear alone on the line" \ 167 " immediately preceding the return type of a function." 168 ret = 1; 169 } 170 } 171 END { 172 exit ret; 173 }' || res=1 174 175 return $res 176} 177 178check_internal_tags() { # <patch> 179 res=0 180 181 cat "$1" |awk ' 182 BEGIN { 183 current_file = ""; 184 ret = 0; 185 } 186 /^+++ b\// { 187 current_file = $2; 188 } 189 /^+.*__rte_internal/ { 190 if (current_file ~ ".c$" ) { 191 print "Please only put __rte_internal tags in " \ 192 "headers ("current_file")"; 193 ret = 1; 194 } 195 if ($1 != "+__rte_internal" || $2 != "") { 196 print "__rte_internal must appear alone on the line" \ 197 " immediately preceding the return type of" \ 198 " a function." 199 ret = 1; 200 } 201 } 202 END { 203 exit ret; 204 }' || res=1 205 206 return $res 207} 208 209check_release_notes() { # <patch> 210 rel_notes_prefix=doc/guides/rel_notes/release_ 211 IFS=. read year month release < VERSION 212 current_rel_notes=${rel_notes_prefix}${year}_${month}.rst 213 214 ! grep -e '^--- a/'$rel_notes_prefix -e '^+++ b/'$rel_notes_prefix "$1" | 215 grep -v $current_rel_notes 216} 217 218number=0 219range='origin/main..' 220quiet=false 221verbose=false 222while getopts hn:qr:v ARG ; do 223 case $ARG in 224 n ) number=$OPTARG ;; 225 q ) quiet=true ;; 226 r ) range=$OPTARG ;; 227 v ) verbose=true ;; 228 h ) print_usage ; exit 0 ;; 229 ? ) print_usage ; exit 1 ;; 230 esac 231done 232shift $(($OPTIND - 1)) 233 234if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then 235 print_usage >&2 236 echo 237 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2 238 exit 1 239fi 240 241print_headline() { # <title> 242 printf '\n### %s\n\n' "$1" 243 headline_printed=true 244} 245 246total=0 247status=0 248 249check () { # <patch> <commit> <title> 250 local ret=0 251 headline_printed=false 252 253 total=$(($total + 1)) 254 ! $verbose || print_headline "$3" 255 if [ -n "$1" ] ; then 256 tmpinput=$1 257 else 258 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX) 259 trap "rm -f '$tmpinput'" INT 260 261 if [ -n "$2" ] ; then 262 git format-patch --find-renames \ 263 --no-stat --stdout -1 $commit > "$tmpinput" 264 else 265 cat > "$tmpinput" 266 fi 267 fi 268 269 ! $verbose || printf 'Running checkpatch.pl:\n' 270 report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null) 271 if [ $? -ne 0 ] ; then 272 $headline_printed || print_headline "$3" 273 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' 274 ret=1 275 fi 276 277 ! $verbose || printf '\nChecking API additions/removals:\n' 278 report=$($VALIDATE_NEW_API "$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 forbidden tokens additions:\n' 286 report=$(check_forbidden_additions "$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 __rte_experimental tags:\n' 294 report=$(check_experimental_tags "$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_internal tags:\n' 302 report=$(check_internal_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 release notes updates:\n' 310 report=$(check_release_notes "$tmpinput") 311 if [ $? -ne 0 ] ; then 312 $headline_printed || print_headline "$3" 313 printf '%s\n' "$report" 314 ret=1 315 fi 316 317 if [ "$tmpinput" != "$1" ]; then 318 rm -f "$tmpinput" 319 trap - INT 320 fi 321 [ $ret -eq 0 ] && return 0 322 323 status=$(($status + 1)) 324} 325 326if [ -n "$1" ] ; then 327 for patch in "$@" ; do 328 # Subject can be on 2 lines 329 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch") 330 check "$patch" '' "$subject" 331 done 332elif [ ! -t 0 ] ; then # stdin 333 subject=$(while read header value ; do 334 if [ "$header" = 'Subject:' ] ; then 335 IFS= read next 336 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p') 337 echo $value$continuation 338 break 339 fi 340 done) 341 check '' '' "$subject" 342else 343 if [ $number -eq 0 ] ; then 344 commits=$(git rev-list --reverse $range) 345 else 346 commits=$(git rev-list --reverse --max-count=$number HEAD) 347 fi 348 for commit in $commits ; do 349 subject=$(git log --format='%s' -1 $commit) 350 check '' $commit "$subject" 351 done 352fi 353pass=$(($total - $status)) 354$quiet || printf '\n%d/%d valid patch' $pass $total 355$quiet || [ $pass -le 1 ] || printf 'es' 356$quiet || printf '\n' 357exit $status 358