API Reference Manual  1.45.1
odp_stash_capability_t Struct Reference

Stash capabilities (per stash type) More...

#include <stash_types.h>

Collaboration diagram for odp_stash_capability_t:
[legend]

Data Fields

uint32_t max_stashes_any_type
 Maximum number of stashes of any type.
 
uint32_t max_stashes
 Maximum number of stashes of this type. More...
 
uint64_t max_num_obj
 Maximum common number of object handles per stash for any object size. More...
 
struct {
   uint64_t   u8
 Maximum number of 1 byte object handles.
 
   uint64_t   u16
 Maximum number of 2 byte object handles.
 
   uint64_t   u32
 Maximum number of 4 byte object handles.
 
   uint64_t   u64
 Maximum number of 8 byte object handles.
 
   uint64_t   u128
 Maximum number of 16 byte object handles.
 
   uint64_t   max_obj_size
 Maximum number of 'max_obj_size' object handles.
 
max_num
 Maximum number of object handles per stash for each object size. More...
 
uint32_t max_obj_size
 Maximum object handle size in bytes. More...
 
uint32_t max_cache_size
 Maximum size of thread local cache.
 
uint32_t max_get_batch
 Maximum number of object handles in batch get operations. More...
 
uint32_t max_put_batch
 Maximum number of object handles in batch put operations. More...
 
odp_stash_stats_opt_t stats
 Supported statistics counters.
 

Detailed Description

Stash capabilities (per stash type)

Examples
odp_dmafwd.c, odp_stash_perf.c, and odp_sysinfo.c.

Definition at line 146 of file api/spec/stash_types.h.

Field Documentation

◆ max_stashes

uint32_t odp_stash_capability_t::max_stashes

Maximum number of stashes of this type.

The value of zero means that the requested stash type is not supported.

Examples
odp_dmafwd.c, odp_stash_perf.c, and odp_sysinfo.c.

Definition at line 155 of file api/spec/stash_types.h.

◆ max_num_obj

uint64_t odp_stash_capability_t::max_num_obj

Maximum common number of object handles per stash for any object size.

An application is able to store at least this many objects when using any of the supported object sizes. Some of the per object size values listed in 'max_num' may be larger than this common value.

Examples
odp_stash_perf.c, and odp_sysinfo.c.

Definition at line 163 of file api/spec/stash_types.h.

◆ 

struct { ... } odp_stash_capability_t::max_num

Maximum number of object handles per stash for each object size.

Values for unsupported object handle sizes are set to zero.

Examples
odp_dmafwd.c, and odp_sysinfo.c.

◆ max_obj_size

uint32_t odp_stash_capability_t::max_obj_size

Maximum object handle size in bytes.

At least 4 byte object handle size is always supported.

Definition at line 193 of file api/spec/stash_types.h.

◆ max_get_batch

uint32_t odp_stash_capability_t::max_get_batch

Maximum number of object handles in batch get operations.

At least 1 object batch size is always supported.

Examples
odp_sysinfo.c.

Definition at line 202 of file api/spec/stash_types.h.

◆ max_put_batch

uint32_t odp_stash_capability_t::max_put_batch

Maximum number of object handles in batch put operations.

At least 1 object batch size is always supported.

Examples
odp_sysinfo.c.

Definition at line 208 of file api/spec/stash_types.h.


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