2 # SPDX-License-Identifier: BSD-3-Clause
3 # Copyright 2015 6WIND S.A.
6 # - DPDK_CHECKPATCH_PATH
7 # - DPDK_CHECKPATCH_LINE_LENGTH
8 . $(dirname $(readlink -e $0))/load-devel-config
10 VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
12 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
14 # override default Linux options
16 options="$options --max-line-length=$length"
17 options="$options --show-types"
18 options="$options --ignore=LINUX_VERSION_CODE,\
19 FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\
20 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\
21 PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
22 SPLIT_STRING,LONG_LINE_STRING,\
23 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
24 NEW_TYPEDEFS,COMPARISON_TO_NULL"
27 if echo $tmpinput | grep -q '^checkpatches\.' ; then
32 trap "clean_tmp_files" INT
36 usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
38 Run Linux kernel checkpatch.pl with DPDK options.
39 The environment variable DPDK_CHECKPATCH_PATH must be set.
41 The patches to check can be from stdin, files specified on the command line,
42 or latest git commits limited with -n option (default limit: origin/master).
46 check_forbidden_additions() { # <patch>
47 # refrain from new additions of rte_panic() and rte_exit()
48 # multiple folders and expressions are separated by spaces
49 awk -v FOLDERS="lib drivers" \
50 -v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \
52 -v MESSAGE='Using rte_panic/rte_exit' \
53 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
55 # svg figures must be included with wildcard extension
56 # because of png conversion for pdf docs
57 awk -v FOLDERS='doc' \
58 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
60 -v MESSAGE='Using explicit .svg extension instead of .*' \
61 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
68 while getopts hn:qv ARG ; do
73 h ) print_usage ; exit 0 ;;
74 ? ) print_usage ; exit 1 ;;
77 shift $(($OPTIND - 1))
79 if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
82 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
86 print_headline() { # <title>
87 printf '\n### %s\n\n' "$1"
94 check () { # <patch> <commit> <title>
96 headline_printed=false
99 ! $verbose || print_headline "$3"
100 if [ -n "$1" ] ; then
102 elif [ -n "$2" ] ; then
103 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
104 git format-patch --find-renames \
105 --no-stat --stdout -1 $commit > "$tmpinput"
107 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
111 ! $verbose || printf 'Running checkpatch.pl:\n'
112 report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
113 if [ $? -ne 0 ] ; then
114 $headline_printed || print_headline "$3"
115 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
119 ! $verbose || printf '\nChecking API additions/removals:\n'
120 report=$($VALIDATE_NEW_API "$tmpinput")
121 if [ $? -ne 0 ] ; then
122 $headline_printed || print_headline "$3"
123 printf '%s\n' "$report"
127 ! $verbose || printf '\nChecking forbidden tokens additions:\n'
128 report=$(check_forbidden_additions "$tmpinput")
129 if [ $? -ne 0 ] ; then
130 $headline_printed || print_headline "$3"
131 printf '%s\n' "$report"
136 [ $ret -eq 0 ] && return 0
138 status=$(($status + 1))
141 if [ -n "$1" ] ; then
142 for patch in "$@" ; do
143 # Subject can be on 2 lines
144 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch")
145 check "$patch" '' "$subject"
147 elif [ ! -t 0 ] ; then # stdin
148 subject=$(while read header value ; do
149 if [ "$header" = 'Subject:' ] ; then
151 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p')
152 echo $value$continuation
156 check '' '' "$subject"
158 if [ $number -eq 0 ] ; then
159 commits=$(git rev-list --reverse origin/master..)
161 commits=$(git rev-list --reverse --max-count=$number HEAD)
163 for commit in $commits ; do
164 subject=$(git log --format='%s' -1 $commit)
165 check '' $commit "$subject"
168 pass=$(($total - $status))
169 $quiet || printf '\n%d/%d valid patch' $pass $total
170 $quiet || [ $pass -le 1 ] || printf 'es'
171 $quiet || printf '\n'