Introduce __rte_internal tag to mark internal ABI function, this kind of function can't be called by external application.
Signed-off-by: Haiyue Wang <haiyue.w...@intel.com> --- buildtools/check-internal-syms.sh | 57 +++++++++++++++++++++++++++++ devtools/check-symbol-change.sh | 7 ++++ devtools/libabigail.abignore | 5 +++ drivers/meson.build | 2 +- lib/librte_eal/include/rte_compat.h | 13 +++++++ lib/meson.build | 2 +- mk/internal/rte.compile-pre.mk | 3 ++ mk/target/generic/rte.vars.mk | 1 + 8 files changed, 88 insertions(+), 2 deletions(-) create mode 100755 buildtools/check-internal-syms.sh diff --git a/buildtools/check-internal-syms.sh b/buildtools/check-internal-syms.sh new file mode 100755 index 000000000..5043acf87 --- /dev/null +++ b/buildtools/check-internal-syms.sh @@ -0,0 +1,57 @@ +#!/bin/sh + +# SPDX-License-Identifier: BSD-3-Clause + +MAPFILE=$1 +OBJFILE=$2 + +LIST_SYMBOL=$(dirname $(readlink -f $0))/map-list-symbol.sh + +# added check for "make -C test/" usage +if [ ! -e $MAPFILE ] || [ ! -f $OBJFILE ] +then + exit 0 +fi + +if [ -d $MAPFILE ] +then + exit 0 +fi + +DUMPFILE=$(mktemp -t dpdk.${0##*/}.XXX.objdump) +trap 'rm -f "$DUMPFILE"' EXIT +objdump -t $OBJFILE >$DUMPFILE + +ret=0 +for SYM in `$LIST_SYMBOL -S INTERNAL $MAPFILE |cut -d ' ' -f 3` +do + if grep -q "\.text.*[[:space:]]$SYM$" $DUMPFILE && + ! grep -q "\.text\.internal.*[[:space:]]$SYM$" $DUMPFILE + then + cat >&2 <<- END_OF_MESSAGE + $SYM is not flagged as internal + but is listed in version map + Please add __rte_internal to the definition of $SYM + END_OF_MESSAGE + ret=1 + fi +done + +# Filter out symbols suffixed with a . for icc +for SYM in `awk '{ + if ($2 != "l" && $4 == ".text.internal" && !($NF ~ /\.$/)) { + print $NF + } +}' $DUMPFILE` +do + $LIST_SYMBOL -S INTERNAL -s $SYM -q $MAPFILE || { + cat >&2 <<- END_OF_MESSAGE + $SYM is flagged as internal + but is not listed in version map + Please add $SYM to the version map + END_OF_MESSAGE + ret=1 + } +done + +exit $ret diff --git a/devtools/check-symbol-change.sh b/devtools/check-symbol-change.sh index ed2178e36..978979077 100755 --- a/devtools/check-symbol-change.sh +++ b/devtools/check-symbol-change.sh @@ -91,6 +91,13 @@ check_for_rule_violations() if [ "$ar" = "add" ] then + if [ "$secname" = "INTERNAL" ] + then + # these are absolved from any further checking + echo "Skipping symbol $symname in INTERNAL" + continue + fi + if [ "$secname" = "unknown" ] then # Just inform the user of this occurrence, but diff --git a/devtools/libabigail.abignore b/devtools/libabigail.abignore index cd86d89ca..3e8e2ea74 100644 --- a/devtools/libabigail.abignore +++ b/devtools/libabigail.abignore @@ -3,6 +3,11 @@ [suppress_variable] symbol_version = EXPERIMENTAL +[suppress_function] + symbol_version = INTERNAL +[suppress_variable] + symbol_version = INTERNAL + ; Explicit ignore for driver-only ABI [suppress_type] name = rte_cryptodev_ops diff --git a/drivers/meson.build b/drivers/meson.build index 4d8f842ab..cac07161f 100644 --- a/drivers/meson.build +++ b/drivers/meson.build @@ -20,7 +20,7 @@ dpdk_driver_classes = ['common', disabled_drivers = run_command(list_dir_globs, get_option('disable_drivers'), ).stdout().split() -default_cflags = machine_args + ['-DALLOW_EXPERIMENTAL_API'] +default_cflags = machine_args + ['-DALLOW_EXPERIMENTAL_API'] + ['-DALLOW_INTERNAL_API'] if cc.has_argument('-Wno-format-truncation') default_cflags += '-Wno-format-truncation' endif diff --git a/lib/librte_eal/include/rte_compat.h b/lib/librte_eal/include/rte_compat.h index 3eb33784b..4cd8f68d6 100644 --- a/lib/librte_eal/include/rte_compat.h +++ b/lib/librte_eal/include/rte_compat.h @@ -19,4 +19,17 @@ __attribute__((section(".text.experimental"))) #endif +#ifndef ALLOW_INTERNAL_API + +#define __rte_internal \ +__attribute__((error("Symbol is not public ABI"), \ +section(".text.internal"))) + +#else + +#define __rte_internal \ +__attribute__((section(".text.internal"))) + +#endif + #endif /* _RTE_COMPAT_H_ */ diff --git a/lib/meson.build b/lib/meson.build index 63c17ee75..981c2e397 100644 --- a/lib/meson.build +++ b/lib/meson.build @@ -36,7 +36,7 @@ if is_windows libraries = ['kvargs','eal'] # only supported libraries for windows endif -default_cflags = machine_args + ['-DALLOW_EXPERIMENTAL_API'] +default_cflags = machine_args + ['-DALLOW_EXPERIMENTAL_API'] + ['-DALLOW_INTERNAL_API'] if cc.has_argument('-Wno-format-truncation') default_cflags += '-Wno-format-truncation' endif diff --git a/mk/internal/rte.compile-pre.mk b/mk/internal/rte.compile-pre.mk index 82fe098f7..0369786a5 100644 --- a/mk/internal/rte.compile-pre.mk +++ b/mk/internal/rte.compile-pre.mk @@ -58,6 +58,8 @@ C_TO_O_DISP = $(if $(V),"$(C_TO_O_STR)"," CC $(@)") endif EXPERIMENTAL_CHECK = $(RTE_SDK)/buildtools/check-experimental-syms.sh CHECK_EXPERIMENTAL = $(EXPERIMENTAL_CHECK) $(SRCDIR)/$(EXPORT_MAP) $@ +INTERNAL_CHECK = $(RTE_SDK)/buildtools/check-internal-syms.sh +CHECK_INTERNAL = $(INTERNAL_CHECK) $(SRCDIR)/$(EXPORT_MAP) $@ PMDINFO_GEN = $(RTE_SDK_BIN)/app/dpdk-pmdinfogen $@ $@.pmd.c PMDINFO_CC = $(CC) $(CPPFLAGS) $(CFLAGS) $(EXTRA_CFLAGS) -c -o $@.pmd.o $@.pmd.c @@ -76,6 +78,7 @@ C_TO_O_DO = @set -e; \ $(C_TO_O) && \ $(PMDINFO_TO_O) && \ $(CHECK_EXPERIMENTAL) && \ + $(CHECK_INTERNAL) && \ echo $(C_TO_O_CMD) > $(call obj2cmd,$(@)) && \ sed 's,'$@':,dep_'$@' =,' $(call obj2dep,$(@)).tmp > $(call obj2dep,$(@)) && \ rm -f $(call obj2dep,$(@)).tmp diff --git a/mk/target/generic/rte.vars.mk b/mk/target/generic/rte.vars.mk index ec2672897..11b0418e5 100644 --- a/mk/target/generic/rte.vars.mk +++ b/mk/target/generic/rte.vars.mk @@ -106,6 +106,7 @@ ifeq ($(BUILDING_RTE_SDK),1) # building sdk CFLAGS += -include $(RTE_OUTPUT)/include/rte_config.h CFLAGS += -DALLOW_EXPERIMENTAL_API +CFLAGS += -DALLOW_INTERNAL_API else # if we are building an external application, include SDK's lib and # includes too -- 2.26.2