From: Haiyue Wang <haiyue.wang@intel.com> To: dev@dpdk.org, thomas@monjalon.net, david.marchand@redhat.com, bruce.richardson@intel.com, ferruh.yigit@intel.com Cc: Haiyue Wang <haiyue.wang@intel.com> Subject: [dpdk-dev] [PATCH v3 1/1] eal: add internal ABI mark support Date: Wed, 22 Apr 2020 21:52:41 +0800 Message-ID: <20200422135241.57667-2-haiyue.wang@intel.com> (raw) In-Reply-To: <20200422135241.57667-1-haiyue.wang@intel.com> 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.wang@intel.com> --- buildtools/check-internal-syms.sh | 57 +++++++++++++++++++++++++++++ devtools/check-symbol-change.sh | 7 ++++ 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 + 7 files changed, 83 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/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
next prev parent reply index Thread overview: 104+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-05-25 18:43 [dpdk-dev] [RFC PATCH 0/2] introduce __rte_internal tag Neil Horman 2019-05-25 18:43 ` [dpdk-dev] [RFC PATCH 1/2] Add __rte_internal tag for functions and version target Neil Horman 2019-06-05 16:14 ` [dpdk-dev] [EXT] " Jerin Jacob Kollanukkaran 2019-05-25 18:43 ` [dpdk-dev] [RFC PATCH 2/2] Convert dpaa driver to tag internal-only symbols appropriately Neil Horman 2019-06-05 16:24 ` [dpdk-dev] [EXT] [RFC PATCH 0/2] introduce __rte_internal tag Jerin Jacob Kollanukkaran 2019-06-05 16:45 ` Bruce Richardson 2019-06-05 18:11 ` Neil Horman 2019-06-06 9:44 ` Jerin Jacob Kollanukkaran 2019-06-06 11:34 ` Neil Horman 2019-06-06 12:04 ` Jerin Jacob Kollanukkaran 2019-06-06 13:18 ` Wiles, Keith 2019-06-06 13:43 ` Neil Horman 2019-06-06 13:53 ` Wiles, Keith 2019-06-06 14:46 ` Neil Horman 2019-06-06 13:35 ` Neil Horman 2019-06-06 14:02 ` Jerin Jacob Kollanukkaran 2019-06-06 15:03 ` Neil Horman 2019-06-06 15:14 ` Jerin Jacob Kollanukkaran 2019-06-06 15:26 ` Neil Horman 2019-06-06 16:23 ` Jerin Jacob Kollanukkaran 2019-06-06 16:55 ` Neil Horman 2019-06-07 9:41 ` Jerin Jacob Kollanukkaran 2019-06-07 10:35 ` Neil Horman 2019-06-07 15:42 ` Ray Kinsella 2019-06-07 18:21 ` Wiles, Keith 2020-01-09 15:49 ` Neil Horman 2019-06-12 20:38 ` [dpdk-dev] [PATCH v1 0/9] dpdk: " Neil Horman 2019-06-12 20:38 ` [dpdk-dev] [PATCH v1 1/9] Add __rte_internal tag for functions and version target Neil Horman 2019-06-12 20:38 ` [dpdk-dev] [PATCH v1 2/9] Exempt INTERNAL symbols from checking Neil Horman 2019-06-12 20:38 ` [dpdk-dev] [PATCH v1 3/9] mark dpaa driver internal-only symbols with __rte_internal Neil Horman 2019-06-12 20:38 ` [dpdk-dev] [PATCH v1 4/9] fslmc: identify internal only functions and tag them as __rte_internal Neil Horman 2019-06-12 20:38 ` [dpdk-dev] [PATCH v1 5/9] dpaa2: Adjust dpaa2 driver to mark internal symbols with __rte_internal Neil Horman 2019-06-12 20:39 ` [dpdk-dev] [PATCH v1 6/9] dpaax: mark internal functions " Neil Horman 2019-06-12 20:39 ` [dpdk-dev] [PATCH v1 7/9] cpt: " Neil Horman 2019-06-17 5:27 ` [dpdk-dev] [EXT] " Anoob Joseph 2019-06-12 20:39 ` [dpdk-dev] [PATCH v1 8/9] octeonx: " Neil Horman 2019-06-12 20:39 ` [dpdk-dev] [PATCH v1 9/9] dpaa2: " Neil Horman 2019-06-12 21:14 ` Aaron Conole 2019-06-13 10:24 ` Neil Horman 2019-06-13 7:53 ` [dpdk-dev] [PATCH v1 0/9] dpdk: introduce __rte_internal tag David Marchand 2019-06-13 10:30 ` Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 0/10] " Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 01/10] Add __rte_internal tag for functions and version target Neil Horman 2020-04-17 2:04 ` Wang, Haiyue 2020-04-17 2:38 ` Neil Horman 2020-04-17 4:40 ` Wang, Haiyue 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 02/10] meson: add BUILDING_RTE_SDK Neil Horman 2019-06-13 14:44 ` Bruce Richardson 2019-06-19 10:39 ` Neil Horman 2019-06-19 10:46 ` Bruce Richardson 2019-06-19 18:34 ` Neil Horman 2019-06-20 10:20 ` Bruce Richardson 2019-06-20 10:21 ` Bruce Richardson 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 03/10] Exempt INTERNAL symbols from checking Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 04/10] mark dpaa driver internal-only symbols with __rte_internal Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 05/10] fslmc: identify internal only functions and tag them as __rte_internal Neil Horman 2019-06-17 7:30 ` Hemant Agrawal 2019-06-19 10:45 ` Neil Horman 2020-04-02 9:49 ` Hemant Agrawal 2020-04-02 11:30 ` Neil Horman 2020-04-02 15:44 ` Hemant Agrawal 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 06/10] dpaa2: Adjust dpaa2 driver to mark internal symbols with __rte_internal Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 07/10] dpaax: mark internal functions " Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 08/10] cpt: " Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 09/10] octeonx: " Neil Horman 2019-06-13 14:23 ` [dpdk-dev] [PATCH v2 10/10] dpaa2: " Neil Horman 2019-08-06 10:03 ` [dpdk-dev] [PATCH v2 0/10] dpdk: introduce __rte_internal tag Thomas Monjalon 2019-08-06 12:21 ` Neil Horman 2020-01-09 9:55 ` David Marchand 2020-01-09 11:46 ` Neil Horman 2020-01-09 11:53 ` David Marchand 2020-04-22 13:52 ` [dpdk-dev] [PATCH v3 0/1] " Haiyue Wang 2020-04-22 13:52 ` Haiyue Wang [this message] 2020-04-22 14:13 ` [dpdk-dev] [PATCH v3 1/1] eal: add internal ABI mark support David Marchand 2020-04-22 16:44 ` Wang, Haiyue 2020-04-22 16:37 ` [dpdk-dev] [PATCH v4 0/1] dpdk: introduce __rte_internal tag Haiyue Wang 2020-04-22 16:37 ` [dpdk-dev] [PATCH v4 1/1] eal: add internal ABI mark support Haiyue Wang 2020-04-23 3:19 ` [dpdk-dev] [PATCH v5 0/1] dpdk: introduce __rte_internal tag Haiyue Wang 2020-04-23 3:19 ` [dpdk-dev] [PATCH v5 1/1] eal: add internal ABI marking support Haiyue Wang 2020-04-24 14:52 ` David Marchand 2020-04-25 6:10 ` Wang, Haiyue 2020-04-25 14:21 ` David Marchand 2020-04-25 14:24 ` Thomas Monjalon 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 0/6] dpdk: introduce __rte_internal tag Haiyue Wang 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 1/6] eal: add internal ABI tag definition Haiyue Wang 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 2/6] build: enable internal API tag Haiyue Wang 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 3/6] mk: add internal tag check Haiyue Wang 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 4/6] devtools: ignore internal ABI check Haiyue Wang 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 5/6] devtools: exempt internal ABI checking Haiyue Wang 2020-04-25 6:04 ` [dpdk-dev] [PATCH v6 6/6] devtools: enforce internal tag at the beginning Haiyue Wang 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 0/6] dpdk: introduce __rte_internal tag Haiyue Wang 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 1/6] eal: add internal ABI tag definition Haiyue Wang 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 2/6] build: enable internal API tag Haiyue Wang 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 3/6] mk: add internal tag check Haiyue Wang 2020-04-25 14:34 ` David Marchand 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 4/6] devtools: ignore internal ABI check Haiyue Wang 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 5/6] devtools: exempt internal ABI checking Haiyue Wang 2020-04-25 14:34 ` David Marchand 2020-04-25 10:56 ` [dpdk-dev] [PATCH v7 6/6] devtools: enforce internal tag at the beginning Haiyue Wang 2020-04-25 14:39 ` [dpdk-dev] [PATCH v7 0/6] dpdk: introduce __rte_internal tag David Marchand 2020-04-25 16:34 ` Wang, Haiyue 2020-04-25 18:09 ` Wang, Haiyue 2020-04-29 8:22 ` David Marchand 2020-04-29 8:24 ` Wang, Haiyue
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20200422135241.57667-2-haiyue.wang@intel.com \ --to=haiyue.wang@intel.com \ --cc=bruce.richardson@intel.com \ --cc=david.marchand@redhat.com \ --cc=dev@dpdk.org \ --cc=ferruh.yigit@intel.com \ --cc=thomas@monjalon.net \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: link
DPDK-dev Archive on lore.kernel.org Archives are clonable: git clone --mirror https://lore.kernel.org/dpdk-dev/0 dpdk-dev/git/0.git # If you have public-inbox 1.1+ installed, you may # initialize and index your mirror using the following commands: public-inbox-init -V2 dpdk-dev dpdk-dev/ https://lore.kernel.org/dpdk-dev \ dev@dpdk.org public-inbox-index dpdk-dev Example config snippet for mirrors Newsgroup available over NNTP: nntp://nntp.lore.kernel.org/org.dpdk.dev AGPL code for this site: git clone https://public-inbox.org/public-inbox.git