From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Ray Kinsella <mdr@ashroe.eu>
Cc: Ferruh Yigit <ferruh.yigit@intel.com>,
dev@dpdk.org, Konstantin Ananyev <konstantin.ananyev@intel.com>,
Jerin Jacob Kollanukkaran <jerinj@marvell.com>,
Akhil Goyal <gakhil@marvell.com>
Subject: [dpdk-dev] [PATCH] doc: announce library refactor for ABI improvement
Date: Thu, 26 Aug 2021 11:35:00 +0100 [thread overview]
Message-ID: <20210826103500.2172550-1-ferruh.yigit@intel.com> (raw)
Target is to reduce the public interface surface to improve the ABI
stability and this is preparation for the longer term stable ABI
support.
Mainly device abstraction layer libraries are impacted because they have
two interfaces, one is public interface to the applications and other is
internal interface to the drivers. Some driver/internal interface
structures/symbols are in the public interface by mistake, this work is
to clean them.
Also some libraries has 'static inline' functions for performance
reasons (like ones in the ethdev), this work plans to split the
structures and hide the part that is not used by inline functions.
The need of the work for the stable ABI already discussed and planned by
the DPDK technical board:
https://mails.dpdk.org/archives/dev/2021-July/214662.html
Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
Cc: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
Cc: Akhil Goyal <gakhil@marvell.com>
CC: Ray Kinsella <mdr@ashroe.eu>
---
doc/guides/rel_notes/deprecation.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 76a4abfd6b0b..1f02d9e14501 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -63,6 +63,11 @@ Deprecation Notices
us extending existing enum/define.
One solution can be using a fixed size array instead of ``.*MAX.*`` value.
+* lib: Will hide internal data structures and symbols from the public interfaces
+ as much as possible in v21.11.
+ This ABI break is done to improve the ABI stability in the long term and will
+ be done mainly, but not limited to, in device abstraction layer libraries.
+
* ethdev: Will add ``RTE_ETH_`` prefix to all ethdev macros/enums in v21.11.
Macros will be added for backward compatibility.
Backward compatibility macros will be removed on v22.11.
--
2.31.1
next reply other threads:[~2021-08-26 10:35 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-08-26 10:35 Ferruh Yigit [this message]
2021-08-26 10:46 ` [dpdk-dev] [EXT] " Akhil Goyal
2021-08-26 10:47 ` Jerin Jacob
2021-08-26 11:04 ` Bruce Richardson
2021-08-26 15:44 ` Andrew Rybchenko
2021-08-31 15:48 ` Kinsella, Ray
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=20210826103500.2172550-1-ferruh.yigit@intel.com \
--to=ferruh.yigit@intel.com \
--cc=dev@dpdk.org \
--cc=gakhil@marvell.com \
--cc=jerinj@marvell.com \
--cc=konstantin.ananyev@intel.com \
--cc=mdr@ashroe.eu \
/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
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).