doc: announce library refactor for ABI improvement
Checks
Commit Message
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(+)
Comments
> 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>
> ---
Acked-by: Akhil Goyal <gakhil@marvell.com>
On Thu, Aug 26, 2021 at 4:16 PM Akhil Goyal <gakhil@marvell.com> wrote:
>
> > 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>
> > ---
> Acked-by: Akhil Goyal <gakhil@marvell.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
On Thu, Aug 26, 2021 at 10:46:35AM +0000, Akhil Goyal wrote:
> > 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>
> > ---
> Acked-by: Akhil Goyal <gakhil@marvell.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
On 8/26/21 2:04 PM, Bruce Richardson wrote:
> On Thu, Aug 26, 2021 at 10:46:35AM +0000, Akhil Goyal wrote:
>>> 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>
>>> ---
>> Acked-by: Akhil Goyal <gakhil@marvell.com>
>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
On 26/08/2021 16:44, Andrew Rybchenko wrote:
> On 8/26/21 2:04 PM, Bruce Richardson wrote:
>> On Thu, Aug 26, 2021 at 10:46:35AM +0000, Akhil Goyal wrote:
>>>> 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>
>>>> ---
>>> Acked-by: Akhil Goyal <gakhil@marvell.com>
>>
>> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
>>
>
> Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
>
Acked-by: Ray Kinsella <mdr@ashroe.eu>
@@ -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.