Hi maintainer of DPDK,

 

I’ve noticed an error on comment of DPDK version 23.11 rte_cryptodev.h: 928-930

 

/**

 * Create a symmetric session mempool.

 *

 * @param name

 *   The unique mempool name.

 * @param nb_elts

 *   The number of elements in the mempool.

 * @param elt_size

 *   The size of the element. This value will be ignored if it is smaller than

 *   the minimum session header size required for the system. For the user who

 *   want to use the same mempool for sym session and session private data it

 *   can be the maximum value of all existing devices' private data and session

 *   header sizes.

 * @param cache_size

 *   The number of per-lcore cache elements

 * @param priv_size

 *   The private data size of each session.

 * @param socket_id

 *   The *socket_id* argument is the socket identifier in the case of

 *   NUMA. The value can be *SOCKET_ID_ANY* if there is no NUMA

 *   constraint for the reserved zone.

 *

 * @return

 *  - On success return size of the session

 *  - On failure returns 0

 */

__rte_experimental

struct rte_mempool *

rte_cryptodev_sym_session_pool_create(const char *name, uint32_t nb_elts,

    uint32_t elt_size, uint32_t cache_size, uint16_t priv_size,

    int socket_id);

 

 

But the return value of this function seems to be a pointer to the mempool created or NULL pointer, instead of the mempool size.

 

Could you please check it?

 

Thank you and BR,

Songyi