From patchwork Thu Aug 26 10:35:00 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 97356 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5609EA0C43; Thu, 26 Aug 2021 12:35:06 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0108D40140; Thu, 26 Aug 2021 12:35:06 +0200 (CEST) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by mails.dpdk.org (Postfix) with ESMTP id A51FE4013F for ; Thu, 26 Aug 2021 12:35:04 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10087"; a="215867884" X-IronPort-AV: E=Sophos;i="5.84,353,1620716400"; d="scan'208";a="215867884" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 26 Aug 2021 03:35:03 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.84,353,1620716400"; d="scan'208";a="527826893" Received: from silpixa00399752.ir.intel.com (HELO silpixa00399752.ger.corp.intel.com) ([10.237.222.27]) by FMSMGA003.fm.intel.com with ESMTP; 26 Aug 2021 03:35:02 -0700 From: Ferruh Yigit To: Ray Kinsella Cc: Ferruh Yigit , dev@dpdk.org, Konstantin Ananyev , Jerin Jacob Kollanukkaran , Akhil Goyal Date: Thu, 26 Aug 2021 11:35:00 +0100 Message-Id: <20210826103500.2172550-1-ferruh.yigit@intel.com> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 Subject: [dpdk-dev] [PATCH] doc: announce library refactor for ABI improvement X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 Acked-by: Akhil Goyal Acked-by: Jerin Jacob Acked-by: Bruce Richardson Acked-by: Andrew Rybchenko Acked-by: Ray Kinsella --- Cc: Konstantin Ananyev Cc: Jerin Jacob Kollanukkaran Cc: Akhil Goyal CC: Ray Kinsella --- 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.