From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <gage.eads@intel.com>
Received: from mga04.intel.com (mga04.intel.com [192.55.52.120])
by dpdk.org (Postfix) with ESMTP id 9711110A3
for <dev@dpdk.org>; Wed, 16 Jan 2019 01:00:48 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga002.jf.intel.com ([10.7.209.21])
by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
15 Jan 2019 16:00:47 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.56,483,1539673200"; d="scan'208";a="126349687"
Received: from txasoft-yocto.an.intel.com (HELO txasoft-yocto.an.intel.com.)
([10.123.72.192])
by orsmga002.jf.intel.com with ESMTP; 15 Jan 2019 16:00:46 -0800
From: Gage Eads <gage.eads@intel.com>
To: dev@dpdk.org
Cc: olivier.matz@6wind.com, arybchenko@solarflare.com,
bruce.richardson@intel.com, konstantin.ananyev@intel.com,
stephen@networkplumber.org
Date: Tue, 15 Jan 2019 17:59:34 -0600
Message-Id: <20190115235934.16065-1-gage.eads@intel.com>
X-Mailer: git-send-email 2.13.6
Subject: [dpdk-dev] [PATCH] doc: announce ring ABI and API changes
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 16 Jan 2019 00:00:49 -0000
In order to support the non-blocking ring[1], one ABI change and one API
change are required in librte_ring. This commit updates the deprecation
notice to pave the way for their inclusion in 19.05.
[1] http://mails.dpdk.org/archives/dev/2019-January/123475.html
Signed-off-by: Gage Eads <gage.eads@intel.com>
---
doc/guides/rel_notes/deprecation.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d4aea4b46..d74cff467 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -83,3 +83,14 @@ Deprecation Notices
- The size and layout of ``rte_cryptodev_qp_conf`` and syntax of
``rte_cryptodev_queue_pair_setup`` will change to to allow to use
two different mempools for crypto and device private sessions.
+
+* ring: two changes are planned for rte_ring in v19.05:
+
+ - The ring head and tail values are planned to be changed from ``uint32_t``
+ to ``size_t``. This reduces the likelihood of wrap-around to effectively
+ zero for 64-bit builds, which is important in avoiding the ABA problem in
+ the upcoming non-blocking ring implementation. (32-bit builds are
+ unaffected by this change.)
+ - rte_ring_get_memsize() will get a new ``flags`` parameter, so it can
+ calculate the memory required for rings that require more than 8B per entry
+ (such as the upcoming non-blocking ring).
--
2.13.6