Scroll to navigation

rte_mbuf_pool_ops.h(3) DPDK rte_mbuf_pool_ops.h(3)

NAME

rte_mbuf_pool_ops.h

SYNOPSIS

Functions


int rte_mbuf_set_platform_mempool_ops (const char *ops_name)
const char * rte_mbuf_platform_mempool_ops (void)
int rte_mbuf_set_user_mempool_ops (const char *ops_name)
const char * rte_mbuf_user_mempool_ops (void)
const char * rte_mbuf_best_mempool_ops (void)

Detailed Description

RTE Mbuf Pool Ops

These APIs are for configuring the mbuf pool ops names to be largely used by rte_pktmbuf_pool_create(). However, this can also be used to set and inquire the best mempool ops available.

Definition in file rte_mbuf_pool_ops.h.

Function Documentation

int rte_mbuf_set_platform_mempool_ops (const char * ops_name)

Set the platform supported pktmbuf HW mempool ops name

This function allow the HW to register the actively supported HW mempool ops_name. Only one HW mempool ops can be registered at any point of time.

Parameters

ops_name

Returns

  • On success, zero.
  • On failure, a negative value.

const char* rte_mbuf_platform_mempool_ops (void)

Get configured platform supported pktmbuf HW mempool ops name

This function returns the platform supported mempool ops name.

Returns

  • On success, platform pool ops name.
  • On failure, NULL.

int rte_mbuf_set_user_mempool_ops (const char * ops_name)

Set the user preferred pktmbuf mempool ops name

This function can be used by the user to configure user preferred mempool ops name.

Parameters

ops_name

Returns

  • On success, zero.
  • On failure, a negative value.

const char* rte_mbuf_user_mempool_ops (void)

Get user preferred pool ops name for mbuf

This function returns the user configured mempool ops name.

Returns

  • On success, user pool ops name..
  • On failure, NULL.

const char* rte_mbuf_best_mempool_ops (void)

Get the best mempool ops name for pktmbuf.

This function is used to determine the best options for mempool ops for pktmbuf allocations. Following are the priority order:

1.
User defined, 2. Platform HW supported, 3. Compile time configured. This function is also used by the rte_pktmbuf_pool_create to get the best mempool ops name.

Returns

returns preferred mbuf pool ops name

Author

Generated automatically by Doxygen for DPDK from the source code.

Fri Dec 15 2023 Version 23.11.0