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:-100} 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,STRLCPY,\ 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 __reserved which is a reserved keyword in Windows system headers 122 awk -v FOLDERS="lib drivers app examples" \ 123 -v EXPRESSIONS='\\<__reserved\\>' \ 124 -v RET_ON_FAIL=1 \ 125 -v MESSAGE='Using __reserved' \ 126 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 127 "$1" || res=1 128 129 # forbid use of experimental build flag except in examples 130 awk -v FOLDERS='lib drivers app' \ 131 -v EXPRESSIONS='-DALLOW_EXPERIMENTAL_API allow_experimental_apis' \ 132 -v RET_ON_FAIL=1 \ 133 -v MESSAGE='Using experimental build flag for in-tree compilation' \ 134 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 135 "$1" || res=1 136 137 # refrain from using RTE_LOG_REGISTER for drivers and libs 138 awk -v FOLDERS='lib drivers' \ 139 -v EXPRESSIONS='\\<RTE_LOG_REGISTER\\>' \ 140 -v RET_ON_FAIL=1 \ 141 -v MESSAGE='Using RTE_LOG_REGISTER, prefer RTE_LOG_REGISTER_(DEFAULT|SUFFIX)' \ 142 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 143 "$1" || res=1 144 145 # SVG must be included with wildcard extension to allow conversion 146 awk -v FOLDERS='doc' \ 147 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \ 148 -v RET_ON_FAIL=1 \ 149 -v MESSAGE='Using explicit .svg extension instead of .*' \ 150 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 151 "$1" || res=1 152 153 # links must prefer https over http 154 awk -v FOLDERS='doc' \ 155 -v EXPRESSIONS='http://.*dpdk.org' \ 156 -v RET_ON_FAIL=1 \ 157 -v MESSAGE='Using non https link to dpdk.org' \ 158 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 159 "$1" || res=1 160 161 return $res 162} 163 164check_experimental_tags() { # <patch> 165 res=0 166 167 cat "$1" |awk ' 168 BEGIN { 169 current_file = ""; 170 ret = 0; 171 } 172 /^+++ b\// { 173 current_file = $2; 174 } 175 /^+.*__rte_experimental/ { 176 if (current_file ~ ".c$" ) { 177 print "Please only put __rte_experimental tags in " \ 178 "headers ("current_file")"; 179 ret = 1; 180 } 181 if ($1 != "+__rte_experimental" || $2 != "") { 182 print "__rte_experimental must appear alone on the line" \ 183 " immediately preceding the return type of a function." 184 ret = 1; 185 } 186 } 187 END { 188 exit ret; 189 }' || res=1 190 191 return $res 192} 193 194check_internal_tags() { # <patch> 195 res=0 196 197 cat "$1" |awk ' 198 BEGIN { 199 current_file = ""; 200 ret = 0; 201 } 202 /^+++ b\// { 203 current_file = $2; 204 } 205 /^+.*__rte_internal/ { 206 if (current_file ~ ".c$" ) { 207 print "Please only put __rte_internal tags in " \ 208 "headers ("current_file")"; 209 ret = 1; 210 } 211 if ($1 != "+__rte_internal" || $2 != "") { 212 print "__rte_internal must appear alone on the line" \ 213 " immediately preceding the return type of" \ 214 " a function." 215 ret = 1; 216 } 217 } 218 END { 219 exit ret; 220 }' || res=1 221 222 return $res 223} 224 225check_release_notes() { # <patch> 226 rel_notes_prefix=doc/guides/rel_notes/release_ 227 IFS=. read year month release < VERSION 228 current_rel_notes=${rel_notes_prefix}${year}_${month}.rst 229 230 ! grep -e '^--- a/'$rel_notes_prefix -e '^+++ b/'$rel_notes_prefix "$1" | 231 grep -v $current_rel_notes 232} 233 234number=0 235range='origin/main..' 236quiet=false 237verbose=false 238while getopts hn:qr:v ARG ; do 239 case $ARG in 240 n ) number=$OPTARG ;; 241 q ) quiet=true ;; 242 r ) range=$OPTARG ;; 243 v ) verbose=true ;; 244 h ) print_usage ; exit 0 ;; 245 ? ) print_usage ; exit 1 ;; 246 esac 247done 248shift $(($OPTIND - 1)) 249 250if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then 251 print_usage >&2 252 echo 253 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2 254 exit 1 255fi 256 257print_headline() { # <title> 258 printf '\n### %s\n\n' "$1" 259 headline_printed=true 260} 261 262total=0 263status=0 264 265check () { # <patch> <commit> <title> 266 local ret=0 267 headline_printed=false 268 269 total=$(($total + 1)) 270 ! $verbose || print_headline "$3" 271 if [ -n "$1" ] ; then 272 tmpinput=$1 273 else 274 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX) 275 trap "rm -f '$tmpinput'" INT 276 277 if [ -n "$2" ] ; then 278 git format-patch --find-renames \ 279 --no-stat --stdout -1 $commit > "$tmpinput" 280 else 281 cat > "$tmpinput" 282 fi 283 fi 284 285 ! $verbose || printf 'Running checkpatch.pl:\n' 286 report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null) 287 if [ $? -ne 0 ] ; then 288 $headline_printed || print_headline "$3" 289 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' 290 ret=1 291 fi 292 293 ! $verbose || printf '\nChecking API additions/removals:\n' 294 report=$($VALIDATE_NEW_API "$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 forbidden tokens additions:\n' 302 report=$(check_forbidden_additions "$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_experimental tags:\n' 310 report=$(check_experimental_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 __rte_internal tags:\n' 318 report=$(check_internal_tags "$tmpinput") 319 if [ $? -ne 0 ] ; then 320 $headline_printed || print_headline "$3" 321 printf '%s\n' "$report" 322 ret=1 323 fi 324 325 ! $verbose || printf '\nChecking release notes updates:\n' 326 report=$(check_release_notes "$tmpinput") 327 if [ $? -ne 0 ] ; then 328 $headline_printed || print_headline "$3" 329 printf '%s\n' "$report" 330 ret=1 331 fi 332 333 if [ "$tmpinput" != "$1" ]; then 334 rm -f "$tmpinput" 335 trap - INT 336 fi 337 [ $ret -eq 0 ] && return 0 338 339 status=$(($status + 1)) 340} 341 342if [ -n "$1" ] ; then 343 for patch in "$@" ; do 344 # Subject can be on 2 lines 345 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch") 346 check "$patch" '' "$subject" 347 done 348elif [ ! -t 0 ] ; then # stdin 349 subject=$(while read header value ; do 350 if [ "$header" = 'Subject:' ] ; then 351 IFS= read next 352 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p') 353 echo $value$continuation 354 break 355 fi 356 done) 357 check '' '' "$subject" 358else 359 if [ $number -eq 0 ] ; then 360 commits=$(git rev-list --reverse $range) 361 else 362 commits=$(git rev-list --reverse --max-count=$number HEAD) 363 fi 364 for commit in $commits ; do 365 subject=$(git log --format='%s' -1 $commit) 366 check '' $commit "$subject" 367 done 368fi 369pass=$(($total - $status)) 370$quiet || printf '\n%d/%d valid patch' $pass $total 371$quiet || [ $pass -le 1 ] || printf 'es' 372$quiet || printf '\n' 373exit $status 374