Pool capabilities. More...

#include <pool_types.h>

Collaboration diagram for odp_pool_capability_t:

Data Fields
uint32_t	max_pools
	Maximum number of pools of any type (odp_pool_type_t)

struct {

uint32_t max_pools
	Maximum number of buffer pools. More...

uint32_t max_align
	Maximum buffer data alignment in bytes. More...

uint32_t max_size
	Maximum buffer data size in bytes. More...

uint32_t max_num
	Maximum number of buffers of any size. More...

uint32_t max_uarea_size
	Maximum user area size in bytes. More...

odp_bool_t uarea_persistence
	Pool user area persistence. More...

uint32_t min_cache_size
	Minimum size of thread local cache. More...

uint32_t max_cache_size
	Maximum size of thread local cache. More...

odp_pool_stats_opt_t stats
	Supported statistics counters. More...

}	buf
	Buffer pool capabilities

struct {

uint32_t max_pools
	Maximum number of packet pools. More...

uint32_t max_len
	Maximum packet data length in bytes. More...

uint32_t max_num
	Maximum number of packets of any length. More...

uint32_t max_align
	Maximum packet data alignment in bytes. More...

uint32_t min_headroom
	Minimum packet level headroom length in bytes. More...

uint32_t max_headroom
	Maximum packet level headroom length in bytes. More...

uint32_t min_tailroom
	Minimum packet level tailroom length in bytes. More...

uint32_t max_segs_per_pkt
	Maximum number of segments per packet. More...

uint32_t min_seg_len
	Minimum packet segment data length in bytes. More...

uint32_t max_seg_len
	Maximum packet segment data length in bytes. More...

uint32_t max_uarea_size
	Maximum user area size in bytes. More...

odp_bool_t uarea_persistence
	Pool user area persistence. More...

uint8_t max_num_subparam
	Maximum number of subparameters. More...

uint32_t min_cache_size
	Minimum size of thread local cache. More...

uint32_t max_cache_size
	Maximum size of thread local cache. More...

odp_pool_stats_opt_t stats
	Supported statistics counters. More...

}	pkt
	Packet pool capabilities

struct {

uint32_t max_pools
	Maximum number of timeout pools. More...

uint32_t max_num
	Maximum number of timeout events in a pool. More...

uint32_t max_uarea_size
	Maximum user area size in bytes. More...

odp_bool_t uarea_persistence
	Pool user area persistence. More...

uint32_t min_cache_size
	Minimum size of thread local cache. More...

uint32_t max_cache_size
	Maximum size of thread local cache. More...

odp_pool_stats_opt_t stats
	Supported statistics counters. More...

}	tmo
	Timeout pool capabilities

struct {

uint32_t max_pools
	Maximum number of vector pools. More...

uint32_t max_num
	Maximum number of vector events in a pool. More...

uint32_t max_size
	Maximum number of handles (such as odp_packet_t) in a vector. More...

uint32_t max_uarea_size
	Maximum user area size in bytes. More...

odp_bool_t uarea_persistence
	Pool user area persistence. More...

uint32_t min_cache_size
	Minimum size of thread local cache. More...

uint32_t max_cache_size
	Maximum size of thread local cache. More...

odp_pool_stats_opt_t stats
	Supported statistics counters. More...

}	vector
	Vector pool capabilities.

struct {

uint32_t max_pools
	Maximum number of event vector pools. More...

uint32_t max_num
	Maximum number of vector events in a pool. More...

uint32_t max_size
	Maximum number of handles (such as odp_packet_t) in a vector. More...

uint32_t max_uarea_size
	Maximum user area size in bytes. More...

odp_bool_t uarea_persistence
	Pool user area persistence. More...

uint32_t min_cache_size
	Minimum size of thread local cache. More...

uint32_t max_cache_size
	Maximum size of thread local cache. More...

odp_pool_stats_opt_t stats
	Supported statistics counters. More...

}	event_vector
	Event vector pool capabilities.

Detailed Description

Pool capabilities.

Definition at line 184 of file api/spec/pool_types.h.

Field Documentation

◆ max_pools

uint32_t odp_pool_capability_t::max_pools

Maximum number of pools of any type (odp_pool_type_t)

Maximum number of event vector pools.

Maximum number of vector pools.

Maximum number of timeout pools.

Maximum number of packet pools.

Maximum number of buffer pools.

Examples: odp_bench_event_vector.c, odp_bench_packet.c, odp_dma_perf.c, odp_ipsec.c, odp_l2fwd.c, odp_pool_latency.c, odp_sched_perf.c, and odp_sysinfo.c.

Definition at line 186 of file api/spec/pool_types.h.

◆ max_align

uint32_t odp_pool_capability_t::max_align

Maximum buffer data alignment in bytes.

Maximum packet data alignment in bytes.

This is the maximum value of packet pool alignment (pkt.align) parameter.

Examples: odp_sysinfo.c.

Definition at line 194 of file api/spec/pool_types.h.

◆ max_size

uint32_t odp_pool_capability_t::max_size

Maximum buffer data size in bytes.

Maximum number of handles (such as odp_packet_t) in a vector.

The value of zero means that size is limited only by the available memory size for the pool.

Examples: odp_bench_buffer.c, odp_bench_event_vector.c, odp_bench_packet.c, odp_bench_queue.c, odp_ipsec.c, odp_l2fwd.c, odp_pool_latency.c, odp_pool_perf.c, odp_sched_perf.c, and odp_sysinfo.c.

Definition at line 200 of file api/spec/pool_types.h.

◆ max_num

uint32_t odp_pool_capability_t::max_num

Maximum number of buffers of any size.

Maximum number of vector events in a pool.

Maximum number of timeout events in a pool.

Maximum number of packets of any length.

The value of zero means that limited only by the available memory size for the pool.

Definition at line 206 of file api/spec/pool_types.h.

◆ max_uarea_size

uint32_t odp_pool_capability_t::max_uarea_size

Maximum user area size in bytes.

Examples: odp_bench_buffer.c, odp_bench_event_vector.c, odp_bench_packet.c, odp_bench_timer.c, odp_cpu_bench.c, odp_pool_latency.c, odp_sched_perf.c, and odp_sysinfo.c.

Definition at line 209 of file api/spec/pool_types.h.

◆ uarea_persistence

odp_bool_t odp_pool_capability_t::uarea_persistence

Pool user area persistence.

When supported, implementation does not overwrite buffer user area content at any point of buffer lifetime nor after freeing a buffer back into pool.

0: User area content is maintained throughout regular buffer usage after allocation, but may be modified after free (default) 1: User area content is maintained throughout regular buffer usage and additionally also after buffer is freed into the pool (between buffer free and allocation)

See buf.uarea_persistence for details.

Examples: odp_sysinfo.c.

Definition at line 222 of file api/spec/pool_types.h.

◆ min_cache_size

uint32_t odp_pool_capability_t::min_cache_size

Minimum size of thread local cache.

Examples: odp_bench_event_vector.c, odp_dma_perf.c, odp_dmafwd.c, odp_pool_latency.c, odp_pool_perf.c, and odp_sysinfo.c.

Definition at line 225 of file api/spec/pool_types.h.

◆ max_cache_size

uint32_t odp_pool_capability_t::max_cache_size

Maximum size of thread local cache.

Examples: odp_bench_buffer.c, odp_bench_event_vector.c, odp_bench_packet.c, odp_dma_perf.c, odp_dmafwd.c, odp_pool_latency.c, odp_pool_perf.c, and odp_sysinfo.c.

Definition at line 228 of file api/spec/pool_types.h.

◆ stats

odp_pool_stats_opt_t odp_pool_capability_t::stats

Supported statistics counters.

Examples: odp_pool_perf.c, and odp_sysinfo.c.

Definition at line 231 of file api/spec/pool_types.h.

◆ max_len

uint32_t odp_pool_capability_t::max_len

Maximum packet data length in bytes.

This defines the maximum packet data length that can be stored into a packet. Attempts to allocate or extend packets to sizes larger than this limit will fail.

The value of zero means that limited only by the available memory size for the pool.

Examples: odp_bench_packet.c, odp_bench_pktio_sp.c, odp_cpu_bench.c, odp_dma_perf.c, odp_dmafwd.c, odp_ipsecfwd.c, odp_l2fwd.c, odp_l2fwd_perf.c, odp_packet_gen.c, odp_pool_latency.c, odp_pool_perf.c, odp_sched_pktio.c, odp_simple_pipeline.c, and odp_sysinfo.c.

Definition at line 247 of file api/spec/pool_types.h.

◆ min_headroom

uint32_t odp_pool_capability_t::min_headroom

Minimum packet level headroom length in bytes.

The minimum number of headroom bytes that newly created packets have by default. The default apply to both ODP packet input and user allocated packets.

Examples: odp_sysinfo.c.

Definition at line 266 of file api/spec/pool_types.h.

◆ max_headroom

uint32_t odp_pool_capability_t::max_headroom

Maximum packet level headroom length in bytes.

The maximum value of packet pool headroom parameter that can be configured. This value applies to both ODP packet input and user allocated packets.

Examples: odp_sysinfo.c.

Definition at line 273 of file api/spec/pool_types.h.

◆ min_tailroom

uint32_t odp_pool_capability_t::min_tailroom

Minimum packet level tailroom length in bytes.

The minimum number of tailroom bytes that newly created packets have by default. The default apply to both ODP packet input and user allocated packets.

Examples: odp_sysinfo.c.

Definition at line 280 of file api/spec/pool_types.h.

◆ max_segs_per_pkt

uint32_t odp_pool_capability_t::max_segs_per_pkt

Maximum number of segments per packet.

Examples: odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 283 of file api/spec/pool_types.h.

◆ min_seg_len

uint32_t odp_pool_capability_t::min_seg_len

Minimum packet segment data length in bytes.

The user defined segment length (seg_len in odp_pool_param_t) will be rounded up into this value.

Examples: odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 289 of file api/spec/pool_types.h.

◆ max_seg_len

uint32_t odp_pool_capability_t::max_seg_len

Maximum packet segment data length in bytes.

The user defined segment length (seg_len in odp_pool_param_t) must not be larger than this.

The value of zero means that limited only by the available memory size for the pool.

Examples: odp_bench_packet.c, odp_cpu_bench.c, odp_crypto.c, odp_ipsec.c, odp_l2fwd.c, odp_packet_gen.c, odp_pool_latency.c, odp_sched_perf.c, odp_simple_pipeline.c, and odp_sysinfo.c.

Definition at line 298 of file api/spec/pool_types.h.

◆ max_num_subparam

uint8_t odp_pool_capability_t::max_num_subparam

Maximum number of subparameters.

Maximum number of packet pool subparameters. Valid range is 0 ... ODP_POOL_MAX_SUBPARAMS.

Examples: odp_sysinfo.c.

Definition at line 312 of file api/spec/pool_types.h.

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

api/spec/pool_types.h

Data Fields

Detailed Description

Field Documentation

◆ max_pools

◆ max_align

◆ max_size

◆ max_num

◆ max_uarea_size

◆ uarea_persistence

◆ min_cache_size

◆ max_cache_size

◆ stats

◆ max_len

◆ min_headroom

◆ max_headroom

◆ min_tailroom

◆ max_segs_per_pkt

◆ min_seg_len

◆ max_seg_len

◆ max_num_subparam