From: Neil Horman <nhorman@tuxdriver.com> To: "Wang, Haiyue" <haiyue.wang@intel.com> Cc: "dev@dpdk.org" <dev@dpdk.org>, Jerin Jacob Kollanukkaran <jerinj@marvell.com>, "Richardson, Bruce" <bruce.richardson@intel.com>, Thomas Monjalon <thomas@monjalon.net>, David Marchand <david.marchand@redhat.com>, "Yigit, Ferruh" <ferruh.yigit@intel.com> Subject: Re: [dpdk-dev] [PATCH v2 01/10] Add __rte_internal tag for functions and version target Date: Thu, 16 Apr 2020 22:38:12 -0400 Message-ID: <20200417023812.rrwe5t7rwfsk6j3p@penguin.lxd> (raw) In-Reply-To: <018d2553c44b437387a39d040553cbb6@intel.com> On Fri, Apr 17, 2020 at 02:04:30AM +0000, Wang, Haiyue wrote: > Hi Neil, > > > -----Original Message----- > > From: dev <dev-bounces@dpdk.org> On Behalf Of Neil Horman > > Sent: Thursday, June 13, 2019 22:24 > > To: dev@dpdk.org > > Cc: Neil Horman <nhorman@tuxdriver.com>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Richardson, > > Bruce <bruce.richardson@intel.com>; Thomas Monjalon <thomas@monjalon.net> > > Subject: [dpdk-dev] [PATCH v2 01/10] Add __rte_internal tag for functions and version target > > > > This tag is meant to be used on function prototypes to identify > > functions that are only meant to be used by internal DPDK libraries > > (i.e. libraries that are built while building the SDK itself, as > > identified by the defining of the BUILDING_RTE_SDK macro). When that > > flag is not set, it will resolve to an error function attribute, causing > > build breakage for any compilation unit attempting to build it > > > > Validate the use of this tag in much the same way we validate > > __rte_experimental. By adding an INTERNAL version to library map files, > > we can exempt internal-only functions from ABI checking, and handle them > > to ensure that symbols we wish to only be for internal use between dpdk > > libraries are properly tagged with __rte_experimental > > > > Note this patch updates the check-experimental-syms.sh script, which > > normally only check the EXPERIMENTAL section to also check the INTERNAL > > section now. As such its been renamed to the now more appropriate > > check-special-syms.sh > > > > Signed-off-by: Neil Horman <nhorman@tuxdriver.com> > > CC: Jerin Jacob Kollanukkaran <jerinj@marvell.com> > > CC: Bruce Richardson <bruce.richardson@intel.com> > > CC: Thomas Monjalon <thomas@monjalon.net> > > --- > > ...rimental-syms.sh => check-special-syms.sh} | 24 ++++++++++++++++++- > > lib/librte_eal/common/include/rte_compat.h | 12 ++++++++++ > > mk/internal/rte.compile-pre.mk | 6 ++--- > > mk/target/generic/rte.vars.mk | 2 +- > > 4 files changed, 39 insertions(+), 5 deletions(-) > > rename buildtools/{check-experimental-syms.sh => check-special-syms.sh} (53%) > > > .... > > > diff --git a/lib/librte_eal/common/include/rte_compat.h b/lib/librte_eal/common/include/rte_compat.h > > index 92ff28faf..739e8485c 100644 > > --- a/lib/librte_eal/common/include/rte_compat.h > > +++ b/lib/librte_eal/common/include/rte_compat.h > > @@ -89,4 +89,16 @@ __attribute__((section(".text.experimental"))) > > > > #endif > > > > +/* > > + * __rte_internal tags mark functions as internal only, If specified in public > > + * header files, this tag will resolve to an error directive, preventing > > + * external applications from attempting to make calls to functions not meant > > + * for consumption outside the dpdk library > > + */ > > +#ifdef BUILDING_RTE_SDK > > +#define __rte_internal __attribute__((section(".text.internal"))) > > +#else > > +#define __rte_internal __attribute__((error("This function cannot be used outside of the core DPDK > > library"), \ > > + section(".text.internal"))) > > +#endif > > #endif /* _RTE_COMPAT_H_ */ > > Since struct definition is also a kind of ABI (am I right ? ;-) ), like: > Yes, thats correct, which is why I've advocated for making structs opaque as part of the abi, but I suppose thats not where we are. :) > drivers/bus/pci/rte_bus_pci.h > struct rte_pci_device { > ... > struct rte_intr_handle vfio_req_intr_handle; > /**< Handler of VFIO request interrupt */ > } __rte_internal; > > Then will capture the errors anyway by using one of __rte_internal definition. > error: 'section' attribute does not apply to types [-Werror=attributes] > error: 'error' attribute does not apply to types > As it is currently written, the __rte_internal macro is only written to work on functions. If you don't want a struct to be part of the ABI, we would need to either: a) make a simmilar macro (say __rte_internal_data) which uses a simmilar gcc attibute to catch external usage. or b) just move the strucute definition to a location that isn't exposed as part of the external ABI Neil > > 2.20.1 > >
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 [this message] 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 ` [dpdk-dev] [PATCH v3 1/1] eal: add internal ABI mark support Haiyue Wang 2020-04-22 14:13 ` 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=20200417023812.rrwe5t7rwfsk6j3p@penguin.lxd \ --to=nhorman@tuxdriver.com \ --cc=bruce.richardson@intel.com \ --cc=david.marchand@redhat.com \ --cc=dev@dpdk.org \ --cc=ferruh.yigit@intel.com \ --cc=haiyue.wang@intel.com \ --cc=jerinj@marvell.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