mem: add function to walk all memsegs
authorAnatoly Burakov <anatoly.burakov@intel.com>
Wed, 11 Apr 2018 12:30:00 +0000 (13:30 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 11 Apr 2018 17:47:25 +0000 (19:47 +0200)
For code that might need to iterate over list of allocated
segments, using this API will make it more resilient to
internal API changes and will prevent copying the same
iteration code over and over again.

Additionally, down the line there will be locking implemented,
so users of this API will not need to care about locking
either.

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
Tested-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
Tested-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Tested-by: Gowrishankar Muthukrishnan <gowrishankar.m@linux.vnet.ibm.com>
lib/librte_eal/common/eal_common_memory.c
lib/librte_eal/common/include/rte_memory.h
lib/librte_eal/rte_eal_version.map

index 5b8ced4..947db1f 100644 (file)
@@ -218,6 +218,27 @@ rte_mem_lock_page(const void *virt)
        return mlock((void *)aligned, page_size);
 }
 
+int __rte_experimental
+rte_memseg_walk(rte_memseg_walk_t func, void *arg)
+{
+       struct rte_mem_config *mcfg = rte_eal_get_configuration()->mem_config;
+       int i, ret;
+
+       for (i = 0; i < RTE_MAX_MEMSEG; i++) {
+               const struct rte_memseg *ms = &mcfg->memseg[i];
+
+               if (ms->addr == NULL)
+                       continue;
+
+               ret = func(ms, arg);
+               if (ret < 0)
+                       return -1;
+               if (ret > 0)
+                       return 1;
+       }
+       return 0;
+}
+
 /* init memory subsystem */
 int
 rte_eal_memory_init(void)
index 302f865..93eadaa 100644 (file)
@@ -20,6 +20,7 @@ extern "C" {
 #endif
 
 #include <rte_common.h>
+#include <rte_compat.h>
 #include <rte_config.h>
 
 __extension__
@@ -129,6 +130,30 @@ phys_addr_t rte_mem_virt2phy(const void *virt);
  */
 rte_iova_t rte_mem_virt2iova(const void *virt);
 
+/**
+ * Memseg walk function prototype.
+ *
+ * Returning 0 will continue walk
+ * Returning 1 will stop the walk
+ * Returning -1 will stop the walk and report error
+ */
+typedef int (*rte_memseg_walk_t)(const struct rte_memseg *ms, void *arg);
+
+/**
+ * Walk list of all memsegs.
+ *
+ * @param func
+ *   Iterator function
+ * @param arg
+ *   Argument passed to iterator
+ * @return
+ *   0 if walked over the entire list
+ *   1 if stopped by the user
+ *   -1 if user function reported error
+ */
+int __rte_experimental
+rte_memseg_walk(rte_memseg_walk_t func, void *arg);
+
 /**
  * Get the layout of the available physical memory.
  *
index d9fc458..716b965 100644 (file)
@@ -223,6 +223,7 @@ EXPERIMENTAL {
        rte_eal_mbuf_user_pool_ops;
        rte_log_register_type_and_pick_level;
        rte_malloc_dump_heaps;
+       rte_memseg_walk;
        rte_mp_action_register;
        rte_mp_action_unregister;
        rte_mp_reply;