API Reference Manual 1.52.0
Loading...
Searching...
No Matches
odp_event_aggr_capability_t Struct Reference

Event aggregator capabilities. More...

#include <event_vector_types.h>

Collaboration diagram for odp_event_aggr_capability_t:
[legend]

Data Fields

uint32_t max_num
 Maximum number of event aggregators for this queue type.
 
uint32_t max_num_per_queue
 Maximum number of event aggregators per queue.
 
uint32_t max_size
 Maximum number of events that can be aggregated into an event vector.
 
uint32_t min_size
 Minimum number of events that can be aggregated into an event vector.
 
uint64_t max_tmo_ns
 Maximum allowed value of odp_event_aggr_config_t::max_tmo_ns.
 
uint64_t min_tmo_ns
 Minimum time in nanoseconds for an aggregator to form an event vector.
 
union { 
 
   struct { 
 
      uint32_t   queue: 1 
 Events enqueued by the application (odp_queue_enq(), etc.). More...
 
      uint32_t   pktin: 1 
 Packets from packet input. More...
 
      uint32_t   tx_compl: 1 
 Packet transmit completion events. More...
 
      uint32_t   cls: 1 
 Packets from classifier. More...
 
      uint32_t   timer: 1 
 Timeout events. More...
 
      uint32_t   crypto: 1 
 Crypto completion events. More...
 
      uint32_t   comp: 1 
 Compression completion events. More...
 
      uint32_t   ipsec: 1 
 IPsec result events. More...
 
      uint32_t   dma: 1 
 DMA completion events. More...
 
      uint32_t   ml: 1 
 ML completion events. More...
 
   }   bit 
 Event source flags.
 
   uint32_t   all_bits 
 All bits of the bit field structure. More...
 
} source 
 Event aggregation support per event source.
 
odp_queue_stats_opt_t stats
 Supported aggregator statistics counters.
 

Detailed Description

Event aggregator capabilities.

Definition at line 92 of file api/spec/event_vector_types.h.

Field Documentation

◆ max_num

uint32_t odp_event_aggr_capability_t::max_num

Maximum number of event aggregators for this queue type.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 94 of file api/spec/event_vector_types.h.

◆ max_num_per_queue

uint32_t odp_event_aggr_capability_t::max_num_per_queue

Maximum number of event aggregators per queue.

Examples
odp_sysinfo.c.

Definition at line 97 of file api/spec/event_vector_types.h.

◆ max_size

uint32_t odp_event_aggr_capability_t::max_size

Maximum number of events that can be aggregated into an event vector.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 100 of file api/spec/event_vector_types.h.

◆ min_size

uint32_t odp_event_aggr_capability_t::min_size

Minimum number of events that can be aggregated into an event vector.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 103 of file api/spec/event_vector_types.h.

◆ max_tmo_ns

uint64_t odp_event_aggr_capability_t::max_tmo_ns

Maximum allowed value of odp_event_aggr_config_t::max_tmo_ns.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 106 of file api/spec/event_vector_types.h.

◆ min_tmo_ns

uint64_t odp_event_aggr_capability_t::min_tmo_ns

Minimum time in nanoseconds for an aggregator to form an event vector.

odp_event_aggr_config_t::max_tmo_ns must not be less than this value unless it is zero.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 113 of file api/spec/event_vector_types.h.

◆ queue

uint32_t odp_event_aggr_capability_t::queue

Events enqueued by the application (odp_queue_enq(), etc.).

Definition at line 138 of file api/spec/event_vector_types.h.

◆ pktin

uint32_t odp_event_aggr_capability_t::pktin

Packets from packet input.

Examples
odp_l2fwd.c.

Definition at line 141 of file api/spec/event_vector_types.h.

◆ tx_compl

uint32_t odp_event_aggr_capability_t::tx_compl

Packet transmit completion events.

Definition at line 144 of file api/spec/event_vector_types.h.

◆ cls

uint32_t odp_event_aggr_capability_t::cls

Packets from classifier.

Definition at line 147 of file api/spec/event_vector_types.h.

◆ timer

uint32_t odp_event_aggr_capability_t::timer

Timeout events.

Definition at line 150 of file api/spec/event_vector_types.h.

◆ crypto

uint32_t odp_event_aggr_capability_t::crypto

Crypto completion events.

Definition at line 153 of file api/spec/event_vector_types.h.

◆ comp

uint32_t odp_event_aggr_capability_t::comp

Compression completion events.

Definition at line 156 of file api/spec/event_vector_types.h.

◆ ipsec

uint32_t odp_event_aggr_capability_t::ipsec

IPsec result events.

Definition at line 159 of file api/spec/event_vector_types.h.

◆ dma

uint32_t odp_event_aggr_capability_t::dma

DMA completion events.

Definition at line 162 of file api/spec/event_vector_types.h.

◆ ml

uint32_t odp_event_aggr_capability_t::ml

ML completion events.

Definition at line 165 of file api/spec/event_vector_types.h.

◆ all_bits

uint32_t odp_event_aggr_capability_t::all_bits

All bits of the bit field structure.

This field can be used to set/clear all bits, or to perform bitwise operations over those.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

Definition at line 174 of file api/spec/event_vector_types.h.

◆ [union]

union { ... } odp_event_aggr_capability_t::source

Event aggregation support per event source.

Specifies whether events enqueued by a particular event source may be aggregated into event vectors by an event aggregator of this queue type.

A bit set to one indicates a supported event source. When a bit is zero, events from the source are never aggregated. Passing an aggregator queue handle to an unsupported source is still allowed, but has the same effect as passing the handle of the underlying queue (see odp_queue_aggr()). Similarly, unsupported sources which are not passed an aggregator queue handle, but which use an aggregator implicitly based on queue parameters (packet input and classifier), simply enqueue directly to the underlying queue. Queue creation does not fail and the aggregator remains usable by other sources.

Examples
odp_l2fwd.c, and odp_sysinfo.c.

◆ stats

odp_queue_stats_opt_t odp_event_aggr_capability_t::stats

Supported aggregator statistics counters.

Definition at line 179 of file api/spec/event_vector_types.h.


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