devtools/checkpatches.sh

   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_LINE_LENGTH
   8 . $(dirname $(readlink -e $0))/load-devel-config
   9
  10 VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
  11
  12 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
  13
  14 # override default Linux options
  15 options="--no-tree"
  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"
  25
  26 clean_tmp_files() {
  27         if echo $tmpinput | grep -q '^checkpatches\.' ; then
  28                 rm -f "$tmpinput"
  29         fi
  30 }
  31
  32 trap "clean_tmp_files" INT
  33
  34 print_usage () {
  35         cat <<- END_OF_HELP
  36         usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
  37
  38         Run Linux kernel checkpatch.pl with DPDK options.
  39         The environment variable DPDK_CHECKPATCH_PATH must be set.
  40
  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).
  43         END_OF_HELP
  44 }
  45
  46 check_forbidden_additions() {
  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\\\(" \
  51                 -v RET_ON_FAIL=1 \
  52                 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk -
  53 }
  54
  55 number=0
  56 quiet=false
  57 verbose=false
  58 while getopts hn:qv ARG ; do
  59         case $ARG in
  60                 n ) number=$OPTARG ;;
  61                 q ) quiet=true ;;
  62                 v ) verbose=true ;;
  63                 h ) print_usage ; exit 0 ;;
  64                 ? ) print_usage ; exit 1 ;;
  65         esac
  66 done
  67 shift $(($OPTIND - 1))
  68
  69 if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
  70         print_usage >&2
  71         echo
  72         echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
  73         exit 1
  74 fi
  75
  76 print_headline() { # <title>
  77         printf '\n### %s\n\n' "$1"
  78         headline_printed=true
  79 }
  80
  81 total=0
  82 status=0
  83
  84 check () { # <patch> <commit> <title>
  85         local ret=0
  86         headline_printed=false
  87
  88         total=$(($total + 1))
  89         ! $verbose || print_headline "$3"
  90         if [ -n "$1" ] ; then
  91                 tmpinput=$1
  92         elif [ -n "$2" ] ; then
  93                 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
  94                 git format-patch --find-renames \
  95                 --no-stat --stdout -1 $commit > "$tmpinput"
  96         else
  97                 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
  98                 cat > "$tmpinput"
  99         fi
 100
 101         ! $verbose || printf 'Running checkpatch.pl:\n'
 102         report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
 103         if [ $? -ne 0 ] ; then
 104                 $headline_printed || print_headline "$3"
 105                 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
 106                 ret=1
 107         fi
 108
 109         ! $verbose || printf '\nChecking API additions/removals:\n'
 110         report=$($VALIDATE_NEW_API "$tmpinput")
 111         if [ $? -ne 0 ] ; then
 112                 $headline_printed || print_headline "$3"
 113                 printf '%s\n' "$report"
 114                 ret=1
 115         fi
 116
 117         ! $verbose || printf '\nChecking forbidden tokens additions:\n'
 118         report=$(check_forbidden_additions <"$tmpinput")
 119         if [ $? -ne 0 ] ; then
 120                 $headline_printed || print_headline "$3"
 121                 printf '%s\n' "$report"
 122                 ret=1
 123         fi
 124
 125         clean_tmp_files
 126         [ $ret -eq 0 ] && return 0
 127
 128         status=$(($status + 1))
 129 }
 130
 131 if [ -n "$1" ] ; then
 132         for patch in "$@" ; do
 133                 # Subject can be on 2 lines
 134                 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch")
 135                 check "$patch" '' "$subject"
 136         done
 137 elif [ ! -t 0 ] ; then # stdin
 138         subject=$(while read header value ; do
 139                 if [ "$header" = 'Subject:' ] ; then
 140                         IFS= read next
 141                         continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p')
 142                         echo $value$continuation
 143                         break
 144                 fi
 145         done)
 146         check '' '' "$subject"
 147 else
 148         if [ $number -eq 0 ] ; then
 149                 commits=$(git rev-list --reverse origin/master..)
 150         else
 151                 commits=$(git rev-list --reverse --max-count=$number HEAD)
 152         fi
 153         for commit in $commits ; do
 154                 subject=$(git log --format='%s' -1 $commit)
 155                 check '' $commit "$subject"
 156         done
 157 fi
 158 pass=$(($total - $status))
 159 $quiet || printf '\n%d/%d valid patch' $pass $total
 160 $quiet || [ $pass -le 1 ] || printf 'es'
 161 $quiet || printf '\n'
 162 exit $status