ring: add reset function for flushing

Currently, the flush is done by dequeuing the ring in a while loop. It is
much simpler to flush the queue by resetting the head and tail indices.

Signed-off-by: Gavin Hu <gavin.hu@arm.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>

diff --git a/lib/librte_ring/rte_ring.c b/lib/librte_ring/rte_ring.c
index b30b2aa7bbf0253c2cfb55398a7f9bd79ac7284b..d9b308036c58f903cde76fe0f306ad9bde0ef0e3 100644 (file)
--- a/lib/librte_ring/rte_ring.c
+++ b/lib/librte_ring/rte_ring.c
@@ -63,6 +63,13 @@ rte_ring_get_memsize(unsigned count)
        return sz;
 }
 
+void
+rte_ring_reset(struct rte_ring *r)
+{
+       r->prod.head = r->cons.head = 0;
+       r->prod.tail = r->cons.tail = 0;
+}
+
 int
 rte_ring_init(struct rte_ring *r, const char *name, unsigned count,
        unsigned flags)

diff --git a/lib/librte_ring/rte_ring.h b/lib/librte_ring/rte_ring.h
index e5a175cb3900147cd8295849bb58c89d09163b0c..2a9f768a1cafc64c2c279b3bf1122d5ae35e7d46 100644 (file)
--- a/lib/librte_ring/rte_ring.h
+++ b/lib/librte_ring/rte_ring.h
@@ -668,6 +668,23 @@ rte_ring_dequeue(struct rte_ring *r, void **obj_p)
        return rte_ring_dequeue_bulk(r, obj_p, 1, NULL) ? 0 : -ENOENT;
 }
 
+/**
+ * Flush a ring.
+ *
+ * This function flush all the elements in a ring
+ *
+ * @b EXPERIMENTAL: this API may change without prior notice
+ *
+ * @warning
+ * Make sure the ring is not in use while calling this function.
+ *
+ * @param r
+ *   A pointer to the ring structure.
+ */
+__rte_experimental
+void
+rte_ring_reset(struct rte_ring *r);
+
 /**
  * Return the number of entries in a ring.
  *

diff --git a/lib/librte_ring/rte_ring_version.map b/lib/librte_ring/rte_ring_version.map
index d935efd0dc65b1161f653a35d9b6a637f841d0c3..510c1386e038be703c2808e5613a53a236be6e38 100644 (file)
--- a/lib/librte_ring/rte_ring_version.map
+++ b/lib/librte_ring/rte_ring_version.map
@@ -17,3 +17,10 @@ DPDK_2.2 {
        rte_ring_free;
 
 } DPDK_2.0;
+
+EXPERIMENTAL {
+       global:
+
+       rte_ring_reset;
+
+};