mbuf: add pool create helper for specific mempool ops
authorHemant Agrawal <hemant.agrawal@nxp.com>
Mon, 29 Jan 2018 08:10:46 +0000 (13:40 +0530)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 29 Jan 2018 18:02:05 +0000 (19:02 +0100)
Introduce a new helper for pktmbuf pool, which will allow
the application to optionally specify the mempool ops name
as well.

Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Santosh Shukla <santosh.shukla@caviumnetworks.com>
lib/librte_mbuf/rte_mbuf.c
lib/librte_mbuf/rte_mbuf.h
lib/librte_mbuf/rte_mbuf_version.map

index 0c4d374..a256b42 100644 (file)
@@ -149,15 +149,15 @@ rte_pktmbuf_init(struct rte_mempool *mp,
        m->next = NULL;
 }
 
-/* helper to create a mbuf pool */
+/* Helper to create a mbuf pool with given mempool ops name*/
 struct rte_mempool *
-rte_pktmbuf_pool_create(const char *name, unsigned n,
-       unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
-       int socket_id)
+rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
+       unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
+       int socket_id, const char *ops_name)
 {
        struct rte_mempool *mp;
        struct rte_pktmbuf_pool_private mbp_priv;
-       const char *mp_ops_name;
+       const char *mp_ops_name = ops_name;
        unsigned elt_size;
        int ret;
 
@@ -177,7 +177,8 @@ rte_pktmbuf_pool_create(const char *name, unsigned n,
        if (mp == NULL)
                return NULL;
 
-       mp_ops_name = rte_mbuf_best_mempool_ops();
+       if (mp_ops_name == NULL)
+               mp_ops_name = rte_mbuf_best_mempool_ops();
        ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
        if (ret != 0) {
                RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
@@ -199,6 +200,16 @@ rte_pktmbuf_pool_create(const char *name, unsigned n,
        return mp;
 }
 
+/* helper to create a mbuf pool */
+struct rte_mempool *
+rte_pktmbuf_pool_create(const char *name, unsigned int n,
+       unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
+       int socket_id)
+{
+       return rte_pktmbuf_pool_create_by_ops(name, n, cache_size, priv_size,
+                       data_room_size, socket_id, NULL);
+}
+
 /* do some sanity checks on a mbuf: panic if it fails */
 void
 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
index 719d04d..e559f68 100644 (file)
@@ -1107,6 +1107,48 @@ rte_pktmbuf_pool_create(const char *name, unsigned n,
        unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
        int socket_id);
 
+/**
+ * Create a mbuf pool with a given mempool ops name
+ *
+ * This function creates and initializes a packet mbuf pool. It is
+ * a wrapper to rte_mempool functions.
+ *
+ * @param name
+ *   The name of the mbuf pool.
+ * @param n
+ *   The number of elements in the mbuf pool. The optimum size (in terms
+ *   of memory usage) for a mempool is when n is a power of two minus one:
+ *   n = (2^q - 1).
+ * @param cache_size
+ *   Size of the per-core object cache. See rte_mempool_create() for
+ *   details.
+ * @param priv_size
+ *   Size of application private are between the rte_mbuf structure
+ *   and the data buffer. This value must be aligned to RTE_MBUF_PRIV_ALIGN.
+ * @param data_room_size
+ *   Size of data buffer in each mbuf, including RTE_PKTMBUF_HEADROOM.
+ * @param socket_id
+ *   The socket identifier where the memory should be allocated. The
+ *   value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the
+ *   reserved zone.
+ * @param ops_name
+ *   The mempool ops name to be used for this mempool instead of
+ *   default mempool. The value can be *NULL* to use default mempool.
+ * @return
+ *   The pointer to the new allocated mempool, on success. NULL on error
+ *   with rte_errno set appropriately. Possible rte_errno values include:
+ *    - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure
+ *    - E_RTE_SECONDARY - function was called from a secondary process instance
+ *    - EINVAL - cache size provided is too large, or priv_size is not aligned.
+ *    - ENOSPC - the maximum number of memzones has already been allocated
+ *    - EEXIST - a memzone with the same name already exists
+ *    - ENOMEM - no appropriate memory area found in which to create memzone
+ */
+struct rte_mempool *
+rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
+       unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
+       int socket_id, const char *ops_name);
+
 /**
  * Get the data room size of mbufs stored in a pktmbuf_pool
  *
index db87819..d418dcb 100644 (file)
@@ -44,5 +44,6 @@ EXPERIMENTAL {
        rte_mbuf_set_platform_mempool_ops;
        rte_mbuf_set_user_mempool_ops;
        rte_mbuf_user_mempool_ops;
+       rte_pktmbuf_pool_create_by_ops;
 
 } DPDK_16.11;