From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp.tuxdriver.com (charlotte.tuxdriver.com [70.61.120.58]) by dpdk.org (Postfix) with ESMTP id 53B8D322C for ; Mon, 15 Jan 2018 20:06:09 +0100 (CET) Received: from [107.15.66.59] (helo=hmswarspite.think-freely.org) by smtp.tuxdriver.com with esmtpsa (TLSv1:AES256-SHA:256) (Exim 4.63) (envelope-from ) id 1ebA4y-0001B8-Iy; Mon, 15 Jan 2018 14:06:02 -0500 Received: from hmswarspite.think-freely.org (localhost [127.0.0.1]) by hmswarspite.think-freely.org (8.15.2/8.15.2) with ESMTP id w0FJ5qT9025738; Mon, 15 Jan 2018 14:05:52 -0500 Received: (from nhorman@localhost) by hmswarspite.think-freely.org (8.15.2/8.15.2/Submit) id w0FJ5pGZ025737; Mon, 15 Jan 2018 14:05:51 -0500 From: Neil Horman To: dev@dpdk.org Cc: Neil Horman , thomas@monjalon.net, john.mcnamara@intel.com, bruce.richardson@intel.com, Ferruh Yigit Date: Mon, 15 Jan 2018 14:05:45 -0500 Message-Id: <20180115190545.25687-1-nhorman@tuxdriver.com> X-Mailer: git-send-email 2.14.3 X-Spam-Score: -2.9 (--) X-Spam-Status: No Subject: [dpdk-dev] [PATCH] checkpatches.sh: Add checks for ABI symbol addition X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 15 Jan 2018 19:06:09 -0000 Recently, some additional patches were added to allow for programmatic marking of C symbols as experimental. The addition of these markers is dependent on the manual addition of exported symbols to the EXPERIMENTAL section of the corresponding libraries version map file. The consensus on review is that, in addition to mandating the addition of symbols to the EXPERIMENTAL version in the map, we need a mechanism to enforce our documented process of mandating that addition when they are introduced. To that end, I am proposing this change. It is an addition to the checkpatches script, which scan incoming patches for additions and removals of symbols to the map file, and warns the user appropriately Signed-off-by: Neil Horman CC: thomas@monjalon.net CC: john.mcnamara@intel.com CC: bruce.richardson@intel.com CC: Ferruh Yigit --- devtools/checkpatches.sh | 89 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 88 insertions(+), 1 deletion(-) diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 7676a6b50..d0e2120fe 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -61,6 +61,77 @@ print_usage () { END_OF_HELP } +build_map_changes() +{ + local fname=$1 + local mapdb=$2 + + cat $fname | filterdiff -i *.map | awk ' + BEGIN {map="";sym="";ar="";sec=""; in_sec=0} + /[-+] a\/.*\.map/ {map=$2} + /+.*{/ {gsub("+","");sec=$1; in_sec=1} + /.*}/ {in_sec=0} + /^+.*[^:*];/ {gsub(";","");sym=$2; + if (in_sec == 1) { + print map " " sym " " sec " add" + } + } + /^-.*[^:*];/ {gsub(";","");sym=$2; + if (in_sec == 1) { + print map " " sym " " sec " del" + } + }' > ./$mapdb + + sort $mapdb | uniq > ./$mapdb.2 + mv -f $mapdb.2 $mapdb + +} + +check_for_rule_violations() +{ + local mapdb=$1 + local mname + local symname + local secname + local ar + + cat $mapdb | while read mname symname secname ar + do + if [ "$ar" == "add" -a "$secname" != "EXPERIMENTAL" ] + then + # Symbols that are getting added in a section other + # Than the experimental section need to be moving + # from an already supported section or its a violation + grep -q "$mname $symname [^EXPERIMENTAL] del" $mapdb + if [ $? -ne 0 ] + then + echo "ERROR: symbol $symname is added in a section other than the EXPERIMENTAL section of the version map" + fi + fi + + if [ "$ar" == "del" -a "$secname" != "EXPERIMENTAL" ] + then + # Just inform users that non-experimenal symbols need + # to go through a deprecation process + echo "INFO: symbol $symname is being removed, ensure that it has gone through the deprecation process" + fi + + done +} + +validate_api_changes() +{ + mapfile=`mktemp mapdb.XXXXXX` + patch=$1 + + build_map_changes $patch $mapfile + result=$(check_for_rule_violations $mapfile) + + rm -f $mapfile + + echo $result +} + number=0 quiet=false verbose=false @@ -96,9 +167,25 @@ check () { # else report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null) fi - [ $? -ne 0 ] || return 0 + reta=$? + $verbose || printf '\n### %s\n\n' "$3" printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' + + echo + echo "Checking API additions/removals:" + if [ -n "$1" ] ; then + report=$(validate_api_changes $1) + elif [ -n "$2" ] ; then + report=$(git format-patch \ + --find-renames --no-stat --stdout -1 $commit | + validate_api_changes /dev/stdin) + else + report=$(validate_api_changes /dev/stdin) + fi + [ $? -ne 0 -o $reta -ne 0 ] || return 0 + printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' + status=$(($status + 1)) } -- 2.14.3