|
API Reference Manual 1.52.0
|
External memory pool capabilities. More...
#include <pool_types.h>
Data Fields | ||
| odp_pool_type_t | type | |
| Requested pool type. | ||
| uint32_t | max_pools | |
| Maximum number of pools. | ||
| uint32_t | min_cache_size | |
| Minimum size of thread local cache. | ||
| uint32_t | max_cache_size | |
| Maximum size of thread local cache. | ||
| odp_pool_stats_opt_t | stats | |
| Supported statistics counters. | ||
| struct { | ||
| uint32_t max_num_buf | ||
| Maximum number of buffers. More... | ||
| uint32_t max_buf_size | ||
| Maximum buffer size in bytes. More... | ||
| uint32_t odp_header_size | ||
| ODP header size in bytes. More... | ||
| uint32_t odp_trailer_size | ||
| ODP trailer size in bytes. More... | ||
| uint32_t min_mem_align | ||
| Minimum buffer pool memory area alignment in bytes. More... | ||
| uint32_t min_buf_align | ||
| Minimum buffer pointer alignment in bytes. More... | ||
| uint32_t min_data_align | ||
| Minimum buffer data alignment in bytes. More... | ||
| struct { | ||
| uint16_t buf_size_aligned: 1 | ||
| Buffers are size aligned. More... | ||
| } | ||
| Buffer alignment flags. | ||
| uint32_t max_uarea_size | ||
| Maximum user area size in bytes. More... | ||
| odp_bool_t uarea_persistence | ||
| Pool user area persistence. More... | ||
| } | buf | |
| Buffer pool capabilities | ||
| struct { | ||
| uint32_t max_num_buf | ||
| Maximum number of packet buffers. More... | ||
| uint32_t max_buf_size | ||
| Maximum packet buffer size in bytes. More... | ||
| uint32_t odp_header_size | ||
| ODP header size in bytes. More... | ||
| uint32_t odp_trailer_size | ||
| ODP trailer size in bytes. More... | ||
| uint32_t min_mem_align | ||
| Minimum packet pool memory area alignment in bytes. More... | ||
| uint32_t min_buf_align | ||
| Minimum packet buffer pointer alignment in bytes. More... | ||
| uint32_t min_head_align | ||
| Minimum packet headroom alignment in bytes. More... | ||
| struct { | ||
| uint16_t buf_size_aligned: 1 | ||
| Packet buffers are size aligned. More... | ||
| } | ||
| Packet buffer alignment flags. | ||
| uint32_t max_headroom | ||
| Maximum headroom parameter value. More... | ||
| uint32_t max_headroom_size | ||
| Maximum headroom size in bytes. More... | ||
| uint32_t max_segs_per_pkt | ||
| Maximum number of segments per packet. More... | ||
| uint32_t max_uarea_size | ||
| Maximum user area size in bytes. More... | ||
| odp_bool_t uarea_persistence | ||
| Pool user area persistence. More... | ||
| } | pkt | |
| Packet pool capabilities | ||
External memory pool capabilities.
Generic fields (not specific to a pool type) contain capabilities of the requested pool type.
Definition at line 728 of file api/spec/pool_types.h.
| odp_pool_type_t odp_pool_ext_capability_t::type |
Requested pool type.
Pool type from the odp_pool_ext_capability() call is recorded here for reference.
Definition at line 732 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_pools |
Maximum number of pools.
Maximum number of external memory pools of the requested type.
Definition at line 737 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::min_cache_size |
Minimum size of thread local cache.
Definition at line 740 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_cache_size |
Maximum size of thread local cache.
Definition at line 743 of file api/spec/pool_types.h.
| odp_pool_stats_opt_t odp_pool_ext_capability_t::stats |
Supported statistics counters.
Definition at line 746 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_num_buf |
Maximum number of buffers.
Maximum number of packet buffers.
Definition at line 751 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_buf_size |
Maximum buffer size in bytes.
Maximum packet buffer size in bytes.
Definition at line 754 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::odp_header_size |
ODP header size in bytes.
Application must reserve this many bytes from the start of a buffer for ODP implementation usage. When the value is zero, ODP implementation does not need header space to be reserved for it. Application will not modify this memory area (after buffer populate call).
Application must reserve this many bytes from the start of a packet buffer for ODP implementation usage. When the value is zero, ODP implementation does not need header space to be reserved for it. Application will not modify this memory area (after buffer populate call).
Definition at line 763 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::odp_trailer_size |
ODP trailer size in bytes.
Application must reserve this many bytes from the end of a buffer for ODP implementation usage. When the value is zero, ODP implementation does not need trailer space to be reserved for it. Application will not modify this memory area (after buffer populate call).
Application must reserve this many bytes from the end of a packet buffer for ODP implementation usage. When the value is zero, ODP implementation does not need trailer space to be reserved for it. Application will not modify this memory area (after buffer populate call).
Definition at line 772 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::min_mem_align |
Minimum buffer pool memory area alignment in bytes.
Minimum packet pool memory area alignment in bytes.
The memory area used for a buffer pool, starting from (or before) the lowest addressed buffer and extending to the end (or after) of the highest addressed buffer, must have at least this (power of two) alignment. The value is 1 when there is no alignment requirement.
The memory area used for a packet pool, starting from (or before) the lowest addressed buffer and extending to the end (or after) of the highest addressed buffer, must have at least this (power of two) alignment. The value is 1 when there is no alignment requirement.
Definition at line 781 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::min_buf_align |
Minimum buffer pointer alignment in bytes.
Minimum packet buffer pointer alignment in bytes.
Buffer pointers populated into a pool must be evenly divisible with this value. The value is 1 when there is no alignment requirement.
Packet buffer pointers populated into a pool must be evenly divisible with this value. The value is 1 when there is no alignment requirement.
Definition at line 788 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::min_data_align |
Minimum buffer data alignment in bytes.
Buffers populated into a pool must have their data area start address (odp_buffer_addr()) evenly divisible with this value. The value is 1 when there is no alignment requirement.
Definition at line 796 of file api/spec/pool_types.h.
| uint16_t odp_pool_ext_capability_t::buf_size_aligned |
Buffers are size aligned.
Packet buffers are size aligned.
When set, buffer pointers must be aligned to the buffer size. For example, if the buffer size would be 2304 bytes (0x900), each buffer start address must be a multiple of 0x900 (e.g. 0x12000900, 0x12001200, 0x12004800, etc).
When set, packet buffer pointers must be aligned to the buffer size. For example, if the buffer size would be 2304 bytes (0x900), each buffer start address must be a multiple of 0x900 (e.g. 0x12000900, 0x12001200, 0x12004800, etc).
Definition at line 812 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_uarea_size |
Maximum user area size in bytes.
Definition at line 817 of file api/spec/pool_types.h.
| odp_bool_t odp_pool_ext_capability_t::uarea_persistence |
Pool user area persistence.
See buf.uarea_persistence of odp_pool_capability_t for details (odp_pool_capability_t::uarea_persistence).
Definition at line 824 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::min_head_align |
Minimum packet headroom alignment in bytes.
Packet buffers populated into a pool must have their headroom start address evenly divisible with this value. The value is 1 when there is no alignment requirement.
Definition at line 876 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_headroom |
Maximum headroom parameter value.
The packet pool headroom parameter may not exceed this value.
Definition at line 899 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_headroom_size |
Maximum headroom size in bytes.
Any newly allocated packet will have at most this much headroom. Application may use this to ensure that packet buffer size is large enough to fit both buffer headers, headroom and data.
Definition at line 907 of file api/spec/pool_types.h.
| uint32_t odp_pool_ext_capability_t::max_segs_per_pkt |
Maximum number of segments per packet.
Definition at line 910 of file api/spec/pool_types.h.