Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
rte_event(3)			     DPDK			  rte_event(3)

NAME
       rte_event

SYNOPSIS
       #include	<rte_eventdev.h>

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

       Definition at line 1676 of file rte_eventdev.h.

Field Documentation
   uint32_t flow_id
       Target flow identifier for the enqueue and dequeue operation.

       For RTE_SCHED_TYPE_ATOMIC, this field is	used to	identify a flow	for
       atomicity within	a queue	& priority level, such that events from	each
       individual flow will only be scheduled to one port at a time.

       This field is preserved between enqueue and dequeue when	a device
       reports the RTE_EVENT_DEV_CAP_CARRY_FLOW_ID capability. Otherwise the
       value is	implementation dependent on dequeue.

       Definition at line 1682 of file rte_eventdev.h.

   uint32_t sub_event_type
       Sub-event types based on	the event source.

       This field is preserved between enqueue and dequeue.

       See also
	   RTE_EVENT_TYPE_CPU

       Definition at line 1694 of file rte_eventdev.h.

   uint32_t event_type
       Event type to classify the event	source.	(RTE_EVENT_TYPE_*)

       This field is preserved between enqueue and dequeue

       Definition at line 1701 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 implementation
       dependent on dequeue.

       See also
	   RTE_EVENT_OP_NEW

	   RTE_EVENT_OP_FORWARD

	   RTE_EVENT_OP_RELEASE

       Definition at line 1706 of file rte_eventdev.h.

   uint8_t rsvd
       Reserved	for future use.

       Should be set to	zero when initializing event structures.

       When forwarding or releasing existing events dequeued from the
       scheduler, this field can be ignored.

       Definition at line 1716 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.

       This field is used to determine the scheduling type for events sent to
       queues where RTE_EVENT_QUEUE_CFG_ALL_TYPES is configured. For queues
       where only a single scheduling type is available, this field must be
       set to match the	configured scheduling type.

       This field is preserved between enqueue and dequeue.

       See also
	   RTE_SCHED_TYPE_ORDERED

	   RTE_SCHED_TYPE_ATOMIC

	   RTE_SCHED_TYPE_PARALLEL

       Definition at line 1724 of file rte_eventdev.h.

   uint8_t queue_id
       Targeted	event queue identifier for the enqueue or dequeue operation.
       The value must be less than rte_event_dev_config::nb_event_queues which
       was previously supplied to rte_event_dev_configure().

       This field is preserved between enqueue on dequeue.

       Definition at line 1741 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. [For devices with where the supported priority range is
       a power-of-2, the normalization will be done via	bit-shifting, so only
       the highest log2(num_priorities)	bits will be used by the event device]

       Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability	and
       this field is preserved between enqueue and dequeue, though with
       possible	loss of	precision due to normalization and subsequent de-
       normalization. (For example, if a device	only supports 8	priority
       levels, only the	high 3 bits of this field will be used by that device,
       and hence only the value	of those 3 bits	are guaranteed to be preserved
       between enqueue and dequeue.)

       Ignored when device does	not support RTE_EVENT_DEV_CAP_EVENT_QOS
       capability, and it is implementation dependent if this field is
       preserved between enqueue and dequeue.

       Definition at line 1749 of file rte_eventdev.h.

   uint8_t impl_opaque
       Opaque field for	event device use.

       An event	driver implementation may use this field to hold an
       implementation specific value to	share between dequeue and enqueue
       operation.

       The application must not	modify this field. Its value is	implementation
       dependent on dequeue, and must be returned unmodified on	enqueue	when
       op type is RTE_EVENT_OP_FORWARD or RTE_EVENT_OP_RELEASE.	This field is
       ignored on events with op type RTE_EVENT_OP_NEW.

       Definition at line 1773 of file rte_eventdev.h.

   uint64_t u64
       Opaque 64-bit value

       Definition at line 1791 of file rte_eventdev.h.

   void* event_ptr
       Opaque event pointer

       Definition at line 1793 of file rte_eventdev.h.

   struct rte_mbuf* mbuf
       mbuf pointer if dequeued	event is associated with mbuf

       Definition at line 1795 of file rte_eventdev.h.

   struct rte_event_vector* vec
       Event vector pointer.

       Definition at line 1797 of file rte_eventdev.h.

Author
       Generated automatically by Doxygen for DPDK from	the source code.

Version	25.11.0			Thu Jun	11 2026			  rte_event(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mbuf&manpath=FreeBSD+15.1-RELEASE+and+Ports.quarterly>

home | help