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 # 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 must be included with wildcard extension to allow conversion 122 awk -v FOLDERS='doc' \ 123 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \ 124 -v RET_ON_FAIL=1 \ 125 -v MESSAGE='Using explicit .svg extension instead of .*' \ 126 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 127 "$1" || res=1 128 129 # links must prefer https over http 130 awk -v FOLDERS='doc' \ 131 -v EXPRESSIONS='http://.*dpdk.org' \ 132 -v RET_ON_FAIL=1 \ 133 -v MESSAGE='Using non https link to dpdk.org' \ 134 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ 135 "$1" || res=1 136 137 return $res 138} 139 140check_experimental_tags() { # <patch> 141 res=0 142 143 cat "$1" |awk ' 144 BEGIN { 145 current_file = ""; 146 ret = 0; 147 } 148 /^+++ b\// { 149 current_file = $2; 150 } 151 /^+.*__rte_experimental/ { 152 if (current_file ~ ".c$" ) { 153 print "Please only put __rte_experimental tags in " \ 154 "headers ("current_file")"; 155 ret = 1; 156 } 157 if ($1 != "+__rte_experimental" || $2 != "") { 158 print "__rte_experimental must appear alone on the line" \ 159 " immediately preceding the return type of a function." 160 ret = 1; 161 } 162 } 163 END { 164 exit ret; 165 }' || res=1 166 167 return $res 168} 169 170check_internal_tags() { # <patch> 171 res=0 172 173 cat "$1" |awk ' 174 BEGIN { 175 current_file = ""; 176 ret = 0; 177 } 178 /^+++ b\// { 179 current_file = $2; 180 } 181 /^+.*__rte_internal/ { 182 if (current_file ~ ".c$" ) { 183 print "Please only put __rte_internal tags in " \ 184 "headers ("current_file")"; 185 ret = 1; 186 } 187 if ($1 != "+__rte_internal" || $2 != "") { 188 print "__rte_internal must appear alone on the line" \ 189 " immediately preceding the return type of" \ 190 " a function." 191 ret = 1; 192 } 193 } 194 END { 195 exit ret; 196 }' || res=1 197 198 return $res 199} 200 201number=0 202range='origin/main..' 203quiet=false 204verbose=false 205while getopts hn:qr:v ARG ; do 206 case $ARG in 207 n ) number=$OPTARG ;; 208 q ) quiet=true ;; 209 r ) range=$OPTARG ;; 210 v ) verbose=true ;; 211 h ) print_usage ; exit 0 ;; 212 ? ) print_usage ; exit 1 ;; 213 esac 214done 215shift $(($OPTIND - 1)) 216 217if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then 218 print_usage >&2 219 echo 220 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2 221 exit 1 222fi 223 224print_headline() { # <title> 225 printf '\n### %s\n\n' "$1" 226 headline_printed=true 227} 228 229total=0 230status=0 231 232check () { # <patch> <commit> <title> 233 local ret=0 234 headline_printed=false 235 236 total=$(($total + 1)) 237 ! $verbose || print_headline "$3" 238 if [ -n "$1" ] ; then 239 tmpinput=$1 240 else 241 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX) 242 trap "rm -f '$tmpinput'" INT 243 244 if [ -n "$2" ] ; then 245 git format-patch --find-renames \ 246 --no-stat --stdout -1 $commit > "$tmpinput" 247 else 248 cat > "$tmpinput" 249 fi 250 fi 251 252 ! $verbose || printf 'Running checkpatch.pl:\n' 253 report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null) 254 if [ $? -ne 0 ] ; then 255 $headline_printed || print_headline "$3" 256 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' 257 ret=1 258 fi 259 260 ! $verbose || printf '\nChecking API additions/removals:\n' 261 report=$($VALIDATE_NEW_API "$tmpinput") 262 if [ $? -ne 0 ] ; then 263 $headline_printed || print_headline "$3" 264 printf '%s\n' "$report" 265 ret=1 266 fi 267 268 ! $verbose || printf '\nChecking forbidden tokens additions:\n' 269 report=$(check_forbidden_additions "$tmpinput") 270 if [ $? -ne 0 ] ; then 271 $headline_printed || print_headline "$3" 272 printf '%s\n' "$report" 273 ret=1 274 fi 275 276 ! $verbose || printf '\nChecking __rte_experimental tags:\n' 277 report=$(check_experimental_tags "$tmpinput") 278 if [ $? -ne 0 ] ; then 279 $headline_printed || print_headline "$3" 280 printf '%s\n' "$report" 281 ret=1 282 fi 283 284 ! $verbose || printf '\nChecking __rte_internal tags:\n' 285 report=$(check_internal_tags "$tmpinput") 286 if [ $? -ne 0 ] ; then 287 $headline_printed || print_headline "$3" 288 printf '%s\n' "$report" 289 ret=1 290 fi 291 292 if [ "$tmpinput" != "$1" ]; then 293 rm -f "$tmpinput" 294 trap - INT 295 fi 296 [ $ret -eq 0 ] && return 0 297 298 status=$(($status + 1)) 299} 300 301if [ -n "$1" ] ; then 302 for patch in "$@" ; do 303 # Subject can be on 2 lines 304 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch") 305 check "$patch" '' "$subject" 306 done 307elif [ ! -t 0 ] ; then # stdin 308 subject=$(while read header value ; do 309 if [ "$header" = 'Subject:' ] ; then 310 IFS= read next 311 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p') 312 echo $value$continuation 313 break 314 fi 315 done) 316 check '' '' "$subject" 317else 318 if [ $number -eq 0 ] ; then 319 commits=$(git rev-list --reverse $range) 320 else 321 commits=$(git rev-list --reverse --max-count=$number HEAD) 322 fi 323 for commit in $commits ; do 324 subject=$(git log --format='%s' -1 $commit) 325 check '' $commit "$subject" 326 done 327fi 328pass=$(($total - $status)) 329$quiet || printf '\n%d/%d valid patch' $pass $total 330$quiet || [ $pass -le 1 ] || printf 'es' 331$quiet || printf '\n' 332exit $status 333