rte_mempool Struct Reference

#include <rte_mempool.h>

Data Fields
char	name [RTE_MEMZONE_NAMESIZE]
void *	pool_config
const struct rte_memzone *	mz
unsigned int	flags
int	socket_id
uint32_t	size
uint32_t	cache_size
uint32_t	elt_size
uint32_t	header_size
uint32_t	trailer_size
unsigned	private_data_size
int32_t	ops_index
struct rte_mempool_cache *	local_cache
uint32_t	populated_size
struct rte_mempool_objhdr_list	elt_list
uint32_t	nb_mem_chunks
struct rte_mempool_memhdr_list	mem_list
void *	pool_data
uint64_t	pool_id

Detailed Description

The RTE mempool structure.

Examples:

examples/bbdev_app/main.c, examples/bond/main.c, examples/distributor/main.c, examples/ethtool/ethtool-app/main.c, examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/fips_validation/fips_dev_self_test.c, examples/fips_validation/main.c, examples/flow_classify/flow_classify.c, examples/flow_filtering/main.c, examples/ioat/ioatfwd.c, examples/ip_fragmentation/main.c, examples/ip_pipeline/mempool.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipv4_multicast/main.c, examples/kni/main.c, examples/l2fwd-cat/l2fwd-cat.c, examples/l2fwd-crypto/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/main.c, examples/link_status_interrupt/main.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/client_server_mp/mp_server/init.c, examples/multi_process/simple_mp/main.c, examples/multi_process/symmetric_mp/main.c, examples/ntb/ntb_fwd.c, examples/packet_ordering/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/pipeline/obj.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/qos_sched/init.c, examples/rxtx_callbacks/main.c, examples/server_node_efd/node/node.c, examples/server_node_efd/server/init.c, examples/skeleton/basicfwd.c, examples/vhost/main.c, examples/vhost/virtio_net.c, examples/vhost_crypto/main.c, examples/vm_power_manager/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 207 of file rte_mempool.h.

Field Documentation

char name[RTE_MEMZONE_NAMESIZE]

Name of mempool.

Examples:

examples/ioat/ioatfwd.c.

Definition at line 213 of file rte_mempool.h.

void* pool_data

Ring or pool to store objects.

Definition at line 216 of file rte_mempool.h.

uint64_t pool_id

External mempool identifier.

Definition at line 217 of file rte_mempool.h.

void* pool_config

optional args for ops alloc.

Definition at line 219 of file rte_mempool.h.

const struct rte_memzone* mz

Memzone where pool is alloc'd.

Examples:

examples/ntb/ntb_fwd.c.

Definition at line 220 of file rte_mempool.h.

unsigned int flags

Flags of the mempool.

Examples:

examples/multi_process/simple_mp/main.c.

Definition at line 221 of file rte_mempool.h.

int socket_id

Socket id passed at create.

Examples:

examples/distributor/main.c, examples/flow_classify/flow_classify.c, and examples/ntb/ntb_fwd.c.

Definition at line 222 of file rte_mempool.h.

uint32_t size

Max size of the mempool.

Examples:

examples/ip_pipeline/parser.c.

Definition at line 223 of file rte_mempool.h.

uint32_t cache_size

Size of per-lcore default local cache.

Definition at line 224 of file rte_mempool.h.

uint32_t elt_size

Size of an element.

Examples:

examples/ntb/ntb_fwd.c.

Definition at line 227 of file rte_mempool.h.

uint32_t header_size

Size of header (before elt).

Examples:

examples/ntb/ntb_fwd.c.

Definition at line 228 of file rte_mempool.h.

uint32_t trailer_size

Size of trailer (after elt).

Examples:

examples/ntb/ntb_fwd.c.

Definition at line 229 of file rte_mempool.h.

unsigned private_data_size

Size of private data.

Definition at line 231 of file rte_mempool.h.

int32_t ops_index

Index into rte_mempool_ops_table array of mempool ops structs, which contain callback function pointers. We're using an index here rather than pointers to the callbacks to facilitate any secondary processes that may want to use this mempool.

Definition at line 239 of file rte_mempool.h.

struct rte_mempool_cache* local_cache

Per-lcore local cache

Definition at line 241 of file rte_mempool.h.

uint32_t populated_size

Number of populated objects.

Definition at line 243 of file rte_mempool.h.

struct rte_mempool_objhdr_list elt_list

List of objects in pool

Definition at line 244 of file rte_mempool.h.

uint32_t nb_mem_chunks

Number of memory chunks

Definition at line 245 of file rte_mempool.h.

struct rte_mempool_memhdr_list mem_list

List of memory chunks

Definition at line 246 of file rte_mempool.h.

---

The documentation for this struct was generated from the following file:

• lib/librte_mempool/rte_mempool.h