Skip to contentSkip to conversation

doc: add ABI change notification for ring library

PATCH Applied Bruce Richardson 6 participants 6 messages Feb 13, 2017 – Feb 14, 2017

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add ABI change notification for ring library

Document proposed changes for the rings code in the next release.

---
 doc/guides/rel_notes/deprecation.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
doc/guides/rel_notes/deprecation.rst +19 -0
index b49e0a0..e715fc7 100644
@@ -8,6 +8,25 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
+  changes include:
+    - Removing build time options for the ring:
+      CONFIG_RTE_RING_SPLIT_PROD_CONS
+      CONFIG_RTE_RING_PAUSE_REP_COUNT
+    - Adding an additional parameter to enqueue functions to return the
+      amount of free space in the ring
+    - Adding an additional parameter to dequeue functions to return the
+      number of remaining elements in the ring
+    - Removing direct support for watermarks in the rings, since the
+      additional return value from the enqueue function makes it
+      unneeded
+    - Adjusting the return values of the bulk() enq/deq functions to
+      make them consistent with the burst() equivalents. [Note, parameter
+      to these functions are changing too, per points above, so compiler
+      will flag them as needing update in legacy code]
+    - Updates to some library functions e.g. rte_ring_get_memsize() to
+      allow for variably-sized ring elements.
+
 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
   igb_uio will be removed, because we are able to detect these from what Linux
   has exposed, like the way we have done with uio-pci-generic. This change
Signature · 1 line
2.9.3
Acked-by on v1 1/1
#1 lore raw
Quoted 10 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Bruce Richardson
Sent: Monday, February 13, 2017 5:39 PM
To: [email protected]
Cc: Richardson, Bruce <[email protected]>
Subject: [dpdk-dev] [PATCH] doc: add ABI change notification for ring library

Quoted 3 lines

Document proposed changes for the rings code in the next release.

Acked-by on v1 1/1
#2 lore raw
In reply to Bruce Richardson
Quoted 27 lines · Bruce Richardson

Document proposed changes for the rings code in the next release.

---
 doc/guides/rel_notes/deprecation.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
doc/guides/rel_notes/deprecation.rst +12 -0
index b49e0a0..e715fc7 100644
@@ -8,6 +8,25 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed
+  changes include:
+    - Removing build time options for the ring:
+      CONFIG_RTE_RING_SPLIT_PROD_CONS
+      CONFIG_RTE_RING_PAUSE_REP_COUNT
+    - Adding an additional parameter to enqueue functions to return the
+      amount of free space in the ring
+    - Adding an additional parameter to dequeue functions to return the
+      number of remaining elements in the ring
+    - Removing direct support for watermarks in the rings, since the
+      additional return value from the enqueue function makes it
+      unneeded

doc/guides/rel_notes/deprecation.rst API and ABI deprecation notices are to be posted here. · line 32

Quoted 10 lines
doc/guides/rel_notes/deprecation.rst +7 -0
+    - Adjusting the return values of the bulk() enq/deq functions to
+      make them consistent with the burst() equivalents. [Note, parameter
+      to these functions are changing too, per points above, so compiler
+      will flag them as needing update in legacy code]
+    - Updates to some library functions e.g. rte_ring_get_memsize() to
+      allow for variably-sized ring elements.
+
 * igb_uio: iomem mapping and sysfs files created for iomem and ioport in
   igb_uio will be removed, because we are able to detect these from what Linux
   has exposed, like the way we have done with uio-pci-generic. This change
#4 lore raw
Quoted 10 lines

-----Original Message-----
From: dev [mailto:[email protected]] On Behalf Of Olivier Matz
Sent: Tuesday, February 14, 2017 2:34 AM
To: Bruce Richardson <[email protected]>
Cc: [email protected]
Subject: Re: [dpdk-dev] [PATCH] doc: add ABI change notification for ring library

Quoted 7 lines
Quoted 3 lines · Bruce Richardson

Document proposed changes for the rings code in the next release.