devtools: avoid explicit experimental build flag

[dpdk.git] / devtools / checkpatches.sh

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index b16bace..0b94a31 100755 (executable)
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -27,11 +27,11 @@ elif [ -f "$codespell" ] ; then
 fi
 options="$options --max-line-length=$length"
 options="$options --show-types"
-options="$options --ignore=LINUX_VERSION_CODE,\
+options="$options --ignore=LINUX_VERSION_CODE,ENOSYS,\
 FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\
 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\
 PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
-SPLIT_STRING,LONG_LINE_STRING,\
+SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\
 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
 NEW_TYPEDEFS,COMPARISON_TO_NULL"
 options="$options $DPDK_CHECKPATCH_OPTIONS"
@@ -61,6 +61,63 @@ check_forbidden_additions() { # <patch>
                -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
                "$1" || res=1
 
+       # refrain from using compiler attribute without defining a common macro
+       awk -v FOLDERS="lib drivers app examples" \
+               -v EXPRESSIONS="__attribute__" \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using compiler attribute directly' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # forbid variable declaration inside "for" loop
+       awk -v FOLDERS='.' \
+               -v EXPRESSIONS='for[[:space:]]*\\((char|u?int|unsigned|s?size_t)' \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Declaring a variable inside for()' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # refrain from new additions of 16/32/64 bits rte_atomicNN_xxx()
+       awk -v FOLDERS="lib drivers app examples" \
+               -v EXPRESSIONS="rte_atomic[0-9][0-9]_.*\\\(" \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using rte_atomicNN_xxx' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # refrain from new additions of rte_smp_[r/w]mb()
+       awk -v FOLDERS="lib drivers app examples" \
+               -v EXPRESSIONS="rte_smp_(r|w)?mb\\\(" \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using rte_smp_[r/w]mb' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # refrain from using compiler __sync_xxx builtins
+       awk -v FOLDERS="lib drivers app examples" \
+               -v EXPRESSIONS="__sync_.*\\\(" \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using __sync_xxx builtins' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # refrain from using compiler __atomic_thread_fence()
+       # It should be avoided on x86 for SMP case.
+       awk -v FOLDERS="lib drivers app examples" \
+               -v EXPRESSIONS="__atomic_thread_fence\\\(" \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using __atomic_thread_fence' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # forbid use of experimental build flag except in examples
+       awk -v FOLDERS='lib drivers app' \
+               -v EXPRESSIONS='-DALLOW_EXPERIMENTAL_API allow_experimental_apis' \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using experimental build flag for in-tree compilation' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
        # svg figures must be included with wildcard extension
        # because of png conversion for pdf docs
        awk -v FOLDERS='doc' \
@@ -70,6 +127,14 @@ check_forbidden_additions() { # <patch>
                -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
                "$1" || res=1
 
+       # links must prefer https over http
+       awk -v FOLDERS='doc' \
+               -v EXPRESSIONS='http://.*dpdk.org' \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using non https link to dpdk.org' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
        return $res
 }
 
@@ -103,6 +168,37 @@ check_experimental_tags() { # <patch>
        return $res
 }
 
+check_internal_tags() { # <patch>
+       res=0
+
+       cat "$1" |awk '
+       BEGIN {
+               current_file = "";
+               ret = 0;
+       }
+       /^+++ b\// {
+               current_file = $2;
+       }
+       /^+.*__rte_internal/ {
+               if (current_file ~ ".c$" ) {
+                       print "Please only put __rte_internal tags in " \
+                               "headers ("current_file")";
+                       ret = 1;
+               }
+               if ($1 != "+__rte_internal" || $2 != "") {
+                       print "__rte_internal must appear alone on the line" \
+                               " immediately preceding the return type of" \
+                               " a function."
+                       ret = 1;
+               }
+       }
+       END {
+               exit ret;
+       }' || res=1
+
+       return $res
+}
+
 number=0
 range='origin/master..'
 quiet=false
@@ -186,6 +282,14 @@ check () { # <patch> <commit> <title>
                ret=1
        fi
 
+       ! $verbose || printf '\nChecking __rte_internal tags:\n'
+       report=$(check_internal_tags "$tmpinput")
+       if [ $? -ne 0 ] ; then
+               $headline_printed || print_headline "$3"
+               printf '%s\n' "$report"
+               ret=1
+       fi
+
        if [ "$tmpinput" != "$1" ]; then
                rm -f "$tmpinput"
                trap - INT