2 # SPDX-License-Identifier: BSD-3-Clause
3 # Copyright 2015 6WIND S.A.
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
12 VALIDATE_NEW_API=$(dirname $(readlink -f $0))/check-symbol-change.sh
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}
20 # override default Linux options
22 if [ "$codespell" = "enable" ] ; then
23 options="$options --codespell"
24 elif [ -f "$codespell" ] ; then
25 options="$options --codespell"
26 options="$options --codespellfile $codespell"
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"
41 usage: $(basename $0) [-h] [-q] [-v] [-nX|-r range|patch1 [patch2] ...]
43 Run Linux kernel checkpatch.pl with DPDK options.
44 The environment variable DPDK_CHECKPATCH_PATH must be set.
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..").
52 check_forbidden_additions() { # <patch>
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\\\(" \
60 -v MESSAGE='Using rte_panic/rte_exit' \
61 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
64 # refrain from using compiler attribute without defining a common macro
65 awk -v FOLDERS="lib drivers app examples" \
66 -v EXPRESSIONS="__attribute__" \
68 -v MESSAGE='Using compiler attribute directly' \
69 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
72 # forbid variable declaration inside "for" loop
74 -v EXPRESSIONS='for[[:space:]]*\\((char|u?int|unsigned|s?size_t)' \
76 -v MESSAGE='Declaring a variable inside for()' \
77 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
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]_.*\\\(" \
84 -v MESSAGE='Using rte_atomicNN_xxx' \
85 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
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\\\(" \
92 -v MESSAGE='Using rte_smp_[r/w]mb' \
93 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
96 # refrain from using compiler __sync_xxx builtins
97 awk -v FOLDERS="lib drivers app examples" \
98 -v EXPRESSIONS="__sync_.*\\\(" \
100 -v MESSAGE='Using __sync_xxx builtins' \
101 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
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\\\(" \
109 -v MESSAGE='Using __atomic_thread_fence' \
110 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
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' \
117 -v MESSAGE='Using experimental build flag for in-tree compilation' \
118 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
121 # SVG must be included with wildcard extension to allow conversion
122 awk -v FOLDERS='doc' \
123 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
125 -v MESSAGE='Using explicit .svg extension instead of .*' \
126 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
129 # links must prefer https over http
130 awk -v FOLDERS='doc' \
131 -v EXPRESSIONS='http://.*dpdk.org' \
133 -v MESSAGE='Using non https link to dpdk.org' \
134 -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
140 check_experimental_tags() { # <patch>
151 /^+.*__rte_experimental/ {
152 if (current_file ~ ".c$" ) {
153 print "Please only put __rte_experimental tags in " \
154 "headers ("current_file")";
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."
170 check_internal_tags() { # <patch>
181 /^+.*__rte_internal/ {
182 if (current_file ~ ".c$" ) {
183 print "Please only put __rte_internal tags in " \
184 "headers ("current_file")";
187 if ($1 != "+__rte_internal" || $2 != "") {
188 print "__rte_internal must appear alone on the line" \
189 " immediately preceding the return type of" \
202 range='origin/main..'
205 while getopts hn:qr:v ARG ; do
207 n ) number=$OPTARG ;;
211 h ) print_usage ; exit 0 ;;
212 ? ) print_usage ; exit 1 ;;
215 shift $(($OPTIND - 1))
217 if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
220 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
224 print_headline() { # <title>
225 printf '\n### %s\n\n' "$1"
226 headline_printed=true
232 check () { # <patch> <commit> <title>
234 headline_printed=false
236 total=$(($total + 1))
237 ! $verbose || print_headline "$3"
238 if [ -n "$1" ] ; then
241 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
242 trap "rm -f '$tmpinput'" INT
244 if [ -n "$2" ] ; then
245 git format-patch --find-renames \
246 --no-stat --stdout -1 $commit > "$tmpinput"
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'
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"
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"
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"
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"
292 if [ "$tmpinput" != "$1" ]; then
296 [ $ret -eq 0 ] && return 0
298 status=$(($status + 1))
301 if [ -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"
307 elif [ ! -t 0 ] ; then # stdin
308 subject=$(while read header value ; do
309 if [ "$header" = 'Subject:' ] ; then
311 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p')
312 echo $value$continuation
316 check '' '' "$subject"
318 if [ $number -eq 0 ] ; then
319 commits=$(git rev-list --reverse $range)
321 commits=$(git rev-list --reverse --max-count=$number HEAD)
323 for commit in $commits ; do
324 subject=$(git log --format='%s' -1 $commit)
325 check '' $commit "$subject"
328 pass=$(($total - $status))
329 $quiet || printf '\n%d/%d valid patch' $pass $total
330 $quiet || [ $pass -le 1 ] || printf 'es'
331 $quiet || printf '\n'