reorder: promote experimental API to stable
PATCH 1/1 reorder: promote experimental API to stable
All the experimental symbols in the reorder library were added in DPDK 23.07 or earlier and have not changed since, so remove the experimental tag.
The sequence number accessor rte_reorder_seqn() and the underlying rte_reorder_seqn_dynfield_offset date back to 20.11, rte_reorder_drain_up_to_seqn() and rte_reorder_min_seqn_set() to 23.03, and rte_reorder_memory_footprint_get() to 23.07.
--- doc/guides/rel_notes/release_26_11.rst | 4 ++++ lib/reorder/rte_reorder.c | 8 ++++---- lib/reorder/rte_reorder.h | 16 ---------------- 3 files changed, 8 insertions(+), 20 deletions(-)
doc/guides/rel_notes/release_26_11.rst +4 -0
@@ -95,6 +95,10 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* reorder: Promoted the following experimental API to stable: + ``rte_reorder_seqn``, ``rte_reorder_drain_up_to_seqn``, + ``rte_reorder_min_seqn_set`` and ``rte_reorder_memory_footprint_get``. + ABI Changes -----------
lib/reorder/rte_reorder.c +4 -4
@@ -35,7 +35,7 @@ EAL_REGISTER_TAILQ(rte_reorder_tailq)#define RTE_REORDER_NAMESIZE 32#define RTE_REORDER_SEQN_DYNFIELD_NAME "rte_reorder_seqn_dynfield" -RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_reorder_seqn_dynfield_offset, 20.11) +RTE_EXPORT_SYMBOL (rte_reorder_seqn_dynfield_offset) int rte_reorder_seqn_dynfield_offset = -1;/* A generic circular buffer */
@@ -61,7 +61,7 @@ struct __rte_cache_aligned rte_reorder_buffer {static void rte_reorder_free_mbufs (struct rte_reorder_buffer *b); -RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_reorder_memory_footprint_get, 23.07) +RTE_EXPORT_SYMBOL (rte_reorder_memory_footprint_get) unsigned intrte_reorder_memory_footprint_get (unsigned int size) {
@@ -482,7 +482,7 @@ ready_buffer_seqn_find(const struct cir_buffer *ready_buf, const uint32_t seqn)return low; } -RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_reorder_drain_up_to_seqn, 23.03) +RTE_EXPORT_SYMBOL (rte_reorder_drain_up_to_seqn) unsigned intrte_reorder_drain_up_to_seqn (struct rte_reorder_buffer *b,struct rte_mbuf **mbufs,const unsigned int max_mbufs,const rte_reorder_seqn_t seqn)
@@ -553,7 +553,7 @@ rte_reorder_is_empty(const struct rte_reorder_buffer *b)return true; } -RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_reorder_min_seqn_set, 23.03) +RTE_EXPORT_SYMBOL (rte_reorder_min_seqn_set) unsigned intrte_reorder_min_seqn_set (struct rte_reorder_buffer *b,rte_reorder_seqn_t min_seqn) {
lib/reorder/rte_reorder.h +0 -16
@@ -29,15 +29,11 @@ typedef uint32_t rte_reorder_seqn_t;extern int rte_reorder_seqn_dynfield_offset;/** -* @warning -* @b EXPERIMENTAL: this API may change without prior notice -* * Read reorder sequence number from mbuf. * * @param mbuf Structure to read from. * @return pointer to reorder sequence number. */ -__rte_experimental static inline rte_reorder_seqn_t *rte_reorder_seqn (struct rte_mbuf *mbuf) {
@@ -170,9 +166,6 @@ rte_reorder_drain(struct rte_reorder_buffer *b, struct rte_mbuf **mbufs, unsigned max_mbufs);/** -* @warning -* @b EXPERIMENTAL: this API may change without prior notice -* * Fetch set of reordered packets up to specified sequence number (exclusive). * * Returns a set of in-order packets from the reorder buffer structure.
@@ -190,15 +183,11 @@ rte_reorder_drain(struct rte_reorder_buffer *b, struct rte_mbuf **mbufs,* @return * Number of mbuf pointers written to mbufs. 0 <= N < max_mbufs. */ -__rte_experimental unsigned int rte_reorder_drain_up_to_seqn (struct rte_reorder_buffer *b,struct rte_mbuf **mbufs,unsigned int max_mbufs,rte_reorder_seqn_t seqn);/** -* @warning -* @b EXPERIMENTAL: this API may change without prior notice -* * Set minimum sequence number of packet allowed to be buffered. * To successfully set new value, * reorder buffer has to be empty (after create, reset or drain_all).
@@ -210,14 +199,10 @@ rte_reorder_drain_up_to_seqn(struct rte_reorder_buffer *b, struct rte_mbuf **mbu* @return * 0 on success, a negative value otherwise. */ -__rte_experimental unsigned int rte_reorder_min_seqn_set (struct rte_reorder_buffer *b,rte_reorder_seqn_t min_seqn);/** -* @warning -* @b EXPERIMENTAL: this API may change without prior notice -* * Determine the amount of memory needed by the reorder buffer * to accommodate a given number of elements. * @see rte_reorder_init()
@@ -227,7 +212,6 @@ rte_reorder_min_seqn_set(struct rte_reorder_buffer *b, rte_reorder_seqn_t min_se* @return * Reorder buffer footprint measured in bytes. */ -__rte_experimental unsigned int rte_reorder_memory_footprint_get (unsigned int size);
Signature · 1 line
2.53.0
David Marchand
AppliedQuoted 11 lines · Stephen Hemminger
All the experimental symbols in the reorder library were added in DPDK 23.07 or earlier and have not changed since, so remove the experimental tag.
The sequence number accessor
rte_reorder_seqn()and the underlyingrte_reorder_seqn_dynfield_offsetdate back to 20.11,rte_reorder_drain_up_to_seqn()andrte_reorder_min_seqn_set()to 23.03, andrte_reorder_memory_footprint_get()to 23.07.Signed-off-by Stephen Hemminger <[email protected]>
No objection from the maintainer, and no activity on the API front for this library since 23.07.
Applied, thanks.
Signature · 1 line
David Marchand