summaryrefslogtreecommitdiff
path: root/buildtools
diff options
context:
space:
mode:
authorNeil Horman <nhorman@tuxdriver.com>2018-01-21 20:48:03 -0500
committerThomas Monjalon <thomas@monjalon.net>2018-01-29 22:44:00 +0100
commita4bcd61de82d821b7e81c186c9254f816e9653bd (patch)
treea455057805461a726b86fe83f11aa54d82b6b8fd /buildtools
parent0d68533617e3fb6daab43ed30f32ab5697c45069 (diff)
downloaddpdk-a4bcd61de82d821b7e81c186c9254f816e9653bd.zip
dpdk-a4bcd61de82d821b7e81c186c9254f816e9653bd.tar.gz
dpdk-a4bcd61de82d821b7e81c186c9254f816e9653bd.tar.xz
buildtools: add script to check experimental API exports
This tools reads the given version map for a directory, and checks to ensure that, for each symbol listed in the export list, the corresponding definition is tagged as __rte_experimental, erroring out if its not. In this way, we can ensure that the EXPERIMENTAL api is kept in sync with the tags Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
Diffstat (limited to 'buildtools')
-rwxr-xr-xbuildtools/check-experimental-syms.sh32
1 files changed, 32 insertions, 0 deletions
diff --git a/buildtools/check-experimental-syms.sh b/buildtools/check-experimental-syms.sh
new file mode 100755
index 0000000..7d21de3
--- /dev/null
+++ b/buildtools/check-experimental-syms.sh
@@ -0,0 +1,32 @@
+#!/bin/sh
+
+# SPDX-License-Identifier: BSD-3-Clause
+
+MAPFILE=$1
+OBJFILE=$2
+
+if [ -d $MAPFILE ]
+then
+ exit 0
+fi
+
+for i in `awk 'BEGIN {found=0}
+ /.*EXPERIMENTAL.*/ {found=1}
+ /.*}.*;/ {found=0}
+ /.*;/ {if (found == 1) print $1}' $MAPFILE`
+do
+ SYM=`echo $i | sed -e"s/;//"`
+ objdump -t $OBJFILE | grep -q "\.text.*$SYM"
+ IN_TEXT=$?
+ objdump -t $OBJFILE | grep -q "\.text\.experimental.*$SYM"
+ IN_EXP=$?
+ if [ $IN_TEXT -eq 0 -a $IN_EXP -ne 0 ]
+ then
+ echo "$SYM is not flagged as experimental"
+ echo "but is listed in version map"
+ echo "Please add __rte_experimental to the definition of $SYM"
+ exit 1
+ fi
+done
+exit 0
+