Add a ring walk routine for debugging and other uses.
This routine walks the list of rings and allows the
called function to stop, remove ring from list or continue.
Signed-off-by: Keith Wiles <keith.wi...@intel.com>
---
V6
Remove warning
V5
Fixup checkpatch warning on commit message
V4
Add TAILQ_FOREACH_SAFE and have function being called return a value
to be used to stop walking, free tailq_entry or continue walking.
V3
Fix checkpatch warnings adding a commit message.
Must be using a different checkpatch then on my Ubuntu 18.04 system
V2
Fix checkpatch warnings.
lib/librte_ring/rte_ring.c | 29 ++++++++++++++++++++++++++++
lib/librte_ring/rte_ring.h | 17 ++++++++++++++++
lib/librte_ring/rte_ring_version.map | 7 +++++++
3 files changed, 53 insertions(+)
diff --git a/lib/librte_ring/rte_ring.c b/lib/librte_ring/rte_ring.c
index d215acecc..17c9780df 100644
--- a/lib/librte_ring/rte_ring.c
+++ b/lib/librte_ring/rte_ring.c
@@ -280,3 +280,32 @@ rte_ring_lookup(const char *name)
return r;
}
+
+void
+rte_ring_walk(int (*func)(struct rte_ring *r, void *arg), void *arg)
+{
+ const struct rte_tailq_entry *te, *tv;
+ struct rte_ring_list *ring_list;
+
+ if (!func)
+ return;
+
+ ring_list = RTE_TAILQ_CAST(rte_ring_tailq.head, rte_ring_list);
+
+ rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
+
+ TAILQ_FOREACH_SAFE(te, ring_list, next, tv) {
+ int ret;
+
+ ret = func((struct rte_ring *) te->data, arg);
+ if (ret < 0)
+ break;
+
+ if (ret > 0) {
+ TAILQ_REMOVE(ring_list, te, next);
+ rte_free((void *)(uintptr_t)te);
+ }
+ }
+
+ rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
+}
diff --git a/lib/librte_ring/rte_ring.h b/lib/librte_ring/rte_ring.h
index af5444a9f..ed6a44773 100644
--- a/lib/librte_ring/rte_ring.h
+++ b/lib/librte_ring/rte_ring.h
@@ -769,6 +769,23 @@ rte_ring_get_capacity(const struct rte_ring *r)
*/
void rte_ring_list_dump(FILE *f);
+/**
+ * Walk the list of ring entries and call the function provided.
+ *
+ * @param func
+ * The function to call for each ring entry using the following prototype.
+ * If the function returns < 0 then stop walking the list.
+ * If the function returns > 0 then remove and free the tailq entry.
+ * and do not free the tailq entry ring pointer. Leave ring pointer
+ * to the function to handle the ring pointer freeing.
+ * If the function returns 0 then continue walking the list.
+ * The RTE_EAL_TAILQ_RWLOCK write lock is taken while walking the list.
+ * @param arg
+ * argument for the call to function.
+ */
+void __rte_experimental
+rte_ring_walk(int (*func)(struct rte_ring *r, void *arg), void *arg);
+
/**
* Search a ring from its name
*
diff --git a/lib/librte_ring/rte_ring_version.map
b/lib/librte_ring/rte_ring_version.map
index d935efd0d..17c05c1b2 100644
--- 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_walk;
+};
+
--
2.17.1
