rte_event Struct Reference

#include <rte_eventdev.h>

Data Fields
union {
struct {
uint32_t   flow_id:20
uint32_t   sub_event_type:8
uint32_t   event_type:4
uint8_t   op:2
uint8_t   rsvd:4
uint8_t   sched_type:2
uint8_t   queue_id
uint8_t   priority
uint8_t   impl_opaque
}
};
union {
uint64_t   u64
void *   event_ptr
struct rte_mbuf *   mbuf
};

Detailed Description

The generic rte_event structure to hold the event attributes for dequeue and enqueue operation

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/ipsec-secgw/ipsec_worker.c, examples/l2fwd-event/l2fwd_event.c, examples/l3fwd/l3fwd_em.c, and examples/l3fwd/l3fwd_lpm.c.

Definition at line 1043 of file rte_eventdev.h.

Field Documentation

uint32_t flow_id

Targeted flow identifier for the enqueue and dequeue operation. The value must be in the range of [0, nb_event_queue_flows - 1] which previously supplied to rte_event_dev_configure().

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c.

Definition at line 1049 of file rte_eventdev.h.

uint32_t sub_event_type

Sub-event types based on the event source.

See also

RTE_EVENT_TYPE_CPU

Examples:

examples/eventdev_pipeline/pipeline_worker_tx.c.

Definition at line 1056 of file rte_eventdev.h.

uint32_t event_type

Event type to classify the event source.

See also

RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*)

Examples:

examples/eventdev_pipeline/pipeline_worker_tx.c, examples/ipsec-secgw/event_helper.c, and examples/ipsec-secgw/ipsec_worker.c.

Definition at line 1060 of file rte_eventdev.h.

uint8_t op

The type of event enqueue operation - new/forward/ etc.This field is not preserved across an instance and is undefined on dequeue.

See also

RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*)

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, and examples/l2fwd-event/l2fwd_event.c.

Definition at line 1064 of file rte_eventdev.h.

uint8_t rsvd

Reserved for future use

Definition at line 1070 of file rte_eventdev.h.

uint8_t sched_type

Scheduler synchronization type (RTE_SCHED_TYPE_*) associated with flow id on a given event queue for the enqueue and dequeue operation.

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, and examples/ipsec-secgw/event_helper.c.

Definition at line 1072 of file rte_eventdev.h.

uint8_t queue_id

Targeted event queue identifier for the enqueue or dequeue operation. The value must be in the range of [0, nb_event_queues - 1] which previously supplied to rte_event_dev_configure().

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/ipsec-secgw/event_helper.c, and examples/l2fwd-event/l2fwd_event.c.

Definition at line 1077 of file rte_eventdev.h.

uint8_t priority

Event priority relative to other events in the event queue. The requested priority should in the range of [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. The implementation shall normalize the requested priority to supported priority value. Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability.

Definition at line 1084 of file rte_eventdev.h.

uint8_t impl_opaque

Implementation specific opaque value. An implementation may use this field to hold implementation specific value to share between dequeue and enqueue operation. The application should not modify this field.

Definition at line 1094 of file rte_eventdev.h.

union { ... }

WORD0

uint64_t u64

Opaque 64-bit value

Definition at line 1105 of file rte_eventdev.h.

void* event_ptr

Opaque event pointer

Definition at line 1107 of file rte_eventdev.h.

struct rte_mbuf* mbuf

mbuf pointer if dequeued event is associated with mbuf

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/ipsec-secgw/ipsec_worker.c, and examples/l2fwd-event/l2fwd_event.c.

Definition at line 1109 of file rte_eventdev.h.

union { ... }

WORD1

---

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

• lib/librte_eventdev/rte_eventdev.h