4 * Copyright 2016 Cavium, Inc.
5 * Copyright 2016 Intel Corporation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * * Neither the name of Cavium, Inc nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #ifndef _RTE_EVENTDEV_H_
36 #define _RTE_EVENTDEV_H_
41 * RTE Event Device API
43 * In a polling model, lcores poll ethdev ports and associated rx queues
44 * directly to look for packet. In an event driven model, by contrast, lcores
45 * call the scheduler that selects packets for them based on programmer
46 * specified criteria. Eventdev library adds support for event driven
47 * programming model, which offer applications automatic multicore scaling,
48 * dynamic load balancing, pipelining, packet ingress order maintenance and
49 * synchronization services to simplify application packet processing.
51 * The Event Device API is composed of two parts:
53 * - The application-oriented Event API that includes functions to setup
54 * an event device (configure it, setup its queues, ports and start it), to
55 * establish the link between queues to port and to receive events, and so on.
57 * - The driver-oriented Event API that exports a function allowing
58 * an event poll Mode Driver (PMD) to simultaneously register itself as
59 * an event device driver.
61 * Event device components:
65 * +-------+ | | flow 0 | |
66 * |Packet | | +-------------+ |
67 * |event | | +-------------+ |
68 * | | | | flow 1 | |port_link(port0, queue0)
69 * +-------+ | +-------------+ | | +--------+
70 * +-------+ | +-------------+ o-----v-----o |dequeue +------+
71 * |Crypto | | | flow n | | | event +------->|Core 0|
72 * |work | | +-------------+ o----+ | port 0 | | |
73 * |done ev| | event queue 0 | | +--------+ +------+
74 * +-------+ +-----------------+ |
76 * |Timer | +-----------------+ | +--------+
77 * |expiry | | +-------------+ | +------o |dequeue +------+
78 * |event | | | flow 0 | o-----------o event +------->|Core 1|
79 * +-------+ | +-------------+ | +----o port 1 | | |
80 * Event enqueue | +-------------+ | | +--------+ +------+
81 * o-------------> | | flow 1 | | |
82 * enqueue( | +-------------+ | |
83 * queue_id, | | | +--------+ +------+
84 * flow_id, | +-------------+ | | | |dequeue |Core 2|
85 * sched_type, | | flow n | o-----------o event +------->| |
86 * event_type, | +-------------+ | | | port 2 | +------+
87 * subev_type, | event queue 1 | | +--------+
88 * event) +-----------------+ | +--------+
89 * | | |dequeue +------+
90 * +-------+ +-----------------+ | | event +------->|Core n|
91 * |Core | | +-------------+ o-----------o port n | | |
92 * |(SW) | | | flow 0 | | | +--------+ +--+---+
93 * |event | | +-------------+ | | |
94 * +-------+ | +-------------+ | | |
95 * ^ | | flow 1 | | | |
96 * | | +-------------+ o------+ |
97 * | | +-------------+ | |
99 * | | +-------------+ | |
100 * | | event queue n | |
101 * | +-----------------+ |
103 * +-----------------------------------------------------------+
105 * Event device: A hardware or software-based event scheduler.
107 * Event: A unit of scheduling that encapsulates a packet or other datatype
108 * like SW generated event from the CPU, Crypto work completion notification,
109 * Timer expiry event notification etc as well as metadata.
110 * The metadata includes flow ID, scheduling type, event priority, event_type,
111 * sub_event_type etc.
113 * Event queue: A queue containing events that are scheduled by the event dev.
114 * An event queue contains events of different flows associated with scheduling
115 * types, such as atomic, ordered, or parallel.
117 * Event port: An application's interface into the event dev for enqueue and
118 * dequeue operations. Each event port can be linked with one or more
119 * event queues for dequeue operations.
121 * By default, all the functions of the Event Device API exported by a PMD
122 * are lock-free functions which assume to not be invoked in parallel on
123 * different logical cores to work on the same target object. For instance,
124 * the dequeue function of a PMD cannot be invoked in parallel on two logical
125 * cores to operates on same event port. Of course, this function
126 * can be invoked in parallel by different logical cores on different ports.
127 * It is the responsibility of the upper level application to enforce this rule.
129 * In all functions of the Event API, the Event device is
130 * designated by an integer >= 0 named the device identifier *dev_id*
132 * At the Event driver level, Event devices are represented by a generic
133 * data structure of type *rte_event_dev*.
135 * Event devices are dynamically registered during the PCI/SoC device probing
136 * phase performed at EAL initialization time.
137 * When an Event device is being probed, a *rte_event_dev* structure and
138 * a new device identifier are allocated for that device. Then, the
139 * event_dev_init() function supplied by the Event driver matching the probed
140 * device is invoked to properly initialize the device.
142 * The role of the device init function consists of resetting the hardware or
143 * software event driver implementations.
145 * If the device init operation is successful, the correspondence between
146 * the device identifier assigned to the new device and its associated
147 * *rte_event_dev* structure is effectively registered.
148 * Otherwise, both the *rte_event_dev* structure and the device identifier are
151 * The functions exported by the application Event API to setup a device
152 * designated by its device identifier must be invoked in the following order:
153 * - rte_event_dev_configure()
154 * - rte_event_queue_setup()
155 * - rte_event_port_setup()
156 * - rte_event_port_link()
157 * - rte_event_dev_start()
159 * Then, the application can invoke, in any order, the functions
160 * exported by the Event API to schedule events, dequeue events, enqueue events,
161 * change event queue(s) to event port [un]link establishment and so on.
163 * Application may use rte_event_[queue/port]_default_conf_get() to get the
164 * default configuration to set up an event queue or event port by
165 * overriding few default values.
167 * If the application wants to change the configuration (i.e. call
168 * rte_event_dev_configure(), rte_event_queue_setup(), or
169 * rte_event_port_setup()), it must call rte_event_dev_stop() first to stop the
170 * device and then do the reconfiguration before calling rte_event_dev_start()
171 * again. The schedule, enqueue and dequeue functions should not be invoked
172 * when the device is stopped.
174 * Finally, an application can close an Event device by invoking the
175 * rte_event_dev_close() function.
177 * Each function of the application Event API invokes a specific function
178 * of the PMD that controls the target device designated by its device
181 * For this purpose, all device-specific functions of an Event driver are
182 * supplied through a set of pointers contained in a generic structure of type
184 * The address of the *event_dev_ops* structure is stored in the *rte_event_dev*
185 * structure by the device init function of the Event driver, which is
186 * invoked during the PCI/SoC device probing phase, as explained earlier.
188 * In other words, each function of the Event API simply retrieves the
189 * *rte_event_dev* structure associated with the device identifier and
190 * performs an indirect invocation of the corresponding driver function
191 * supplied in the *event_dev_ops* structure of the *rte_event_dev* structure.
193 * For performance reasons, the address of the fast-path functions of the
194 * Event driver is not contained in the *event_dev_ops* structure.
195 * Instead, they are directly stored at the beginning of the *rte_event_dev*
196 * structure to avoid an extra indirect memory access during their invocation.
198 * RTE event device drivers do not use interrupts for enqueue or dequeue
199 * operation. Instead, Event drivers export Poll-Mode enqueue and dequeue
200 * functions to applications.
202 * The events are injected to event device through *enqueue* operation by
203 * event producers in the system. The typical event producers are ethdev
204 * subsystem for generating packet events, CPU(SW) for generating events based
205 * on different stages of application processing, cryptodev for generating
206 * crypto work completion notification etc
208 * The *dequeue* operation gets one or more events from the event ports.
209 * The application process the events and send to downstream event queue through
210 * rte_event_enqueue_burst() if it is an intermediate stage of event processing,
211 * on the final stage, the application may send to different subsystem like
212 * ethdev to send the packet/event on the wire using ethdev
213 * rte_eth_tx_burst() API.
215 * The point at which events are scheduled to ports depends on the device.
216 * For hardware devices, scheduling occurs asynchronously without any software
217 * intervention. Software schedulers can either be distributed
218 * (each worker thread schedules events to its own port) or centralized
219 * (a dedicated thread schedules to all ports). Distributed software schedulers
220 * perform the scheduling in rte_event_dequeue_burst(), whereas centralized
221 * scheduler logic is located in rte_event_schedule().
222 * The RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED capability flag is not set
223 * indicates the device is centralized and thus needs a dedicated scheduling
224 * thread that repeatedly calls rte_event_schedule().
226 * An event driven worker thread has following typical workflow on fastpath:
229 * rte_event_dequeue_burst(...);
231 * rte_event_enqueue_burst(...);
241 #include <rte_common.h>
242 #include <rte_memory.h>
243 #include <rte_errno.h>
245 struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */
247 /* Event device capability bitmap flags */
248 #define RTE_EVENT_DEV_CAP_QUEUE_QOS (1ULL << 0)
249 /**< Event scheduling prioritization is based on the priority associated with
252 * @see rte_event_queue_setup()
254 #define RTE_EVENT_DEV_CAP_EVENT_QOS (1ULL << 1)
255 /**< Event scheduling prioritization is based on the priority associated with
256 * each event. Priority of each event is supplied in *rte_event* structure
257 * on each enqueue operation.
259 * @see rte_event_enqueue_burst()
261 #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2)
262 /**< Event device operates in distributed scheduling mode.
263 * In distributed scheduling mode, event scheduling happens in HW or
264 * rte_event_dequeue_burst() or the combination of these two.
265 * If the flag is not set then eventdev is centralized and thus needs a
266 * dedicated scheduling thread that repeatedly calls rte_event_schedule().
268 * @see rte_event_schedule(), rte_event_dequeue_burst()
270 #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3)
271 /**< Event device is capable of enqueuing events of any type to any queue.
272 * If this capability is not set, the queue only supports events of the
273 * *RTE_EVENT_QUEUE_CFG_* type that it was created with.
275 * @see RTE_EVENT_QUEUE_CFG_* values
277 #define RTE_EVENT_DEV_CAP_BURST_MODE (1ULL << 4)
278 /**< Event device is capable of operating in burst mode for enqueue(forward,
279 * release) and dequeue operation. If this capability is not set, application
280 * still uses the rte_event_dequeue_burst() and rte_event_enqueue_burst() but
281 * PMD accepts only one event at a time.
283 * @see rte_event_dequeue_burst() rte_event_enqueue_burst()
286 /* Event device priority levels */
287 #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0
288 /**< Highest priority expressed across eventdev subsystem
289 * @see rte_event_queue_setup(), rte_event_enqueue_burst()
290 * @see rte_event_port_link()
292 #define RTE_EVENT_DEV_PRIORITY_NORMAL 128
293 /**< Normal priority expressed across eventdev subsystem
294 * @see rte_event_queue_setup(), rte_event_enqueue_burst()
295 * @see rte_event_port_link()
297 #define RTE_EVENT_DEV_PRIORITY_LOWEST 255
298 /**< Lowest priority expressed across eventdev subsystem
299 * @see rte_event_queue_setup(), rte_event_enqueue_burst()
300 * @see rte_event_port_link()
304 * Get the total number of event devices that have been successfully
308 * The total number of usable event devices.
311 rte_event_dev_count(void);
314 * Get the device identifier for the named event device.
317 * Event device name to select the event device identifier.
320 * Returns event device identifier on success.
321 * - <0: Failure to find named event device.
324 rte_event_dev_get_dev_id(const char *name);
327 * Return the NUMA socket to which a device is connected.
330 * The identifier of the device.
332 * The NUMA socket id to which the device is connected or
333 * a default of zero if the socket could not be determined.
334 * -(-EINVAL) dev_id value is out of range.
337 rte_event_dev_socket_id(uint8_t dev_id);
340 * Event device information
342 struct rte_event_dev_info {
343 const char *driver_name; /**< Event driver name */
344 struct rte_device *dev; /**< Device information */
345 uint32_t min_dequeue_timeout_ns;
346 /**< Minimum supported global dequeue timeout(ns) by this device */
347 uint32_t max_dequeue_timeout_ns;
348 /**< Maximum supported global dequeue timeout(ns) by this device */
349 uint32_t dequeue_timeout_ns;
350 /**< Configured global dequeue timeout(ns) for this device */
351 uint8_t max_event_queues;
352 /**< Maximum event_queues supported by this device */
353 uint32_t max_event_queue_flows;
354 /**< Maximum supported flows in an event queue by this device*/
355 uint8_t max_event_queue_priority_levels;
356 /**< Maximum number of event queue priority levels by this device.
357 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability
359 uint8_t max_event_priority_levels;
360 /**< Maximum number of event priority levels by this device.
361 * Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability
363 uint8_t max_event_ports;
364 /**< Maximum number of event ports supported by this device */
365 uint8_t max_event_port_dequeue_depth;
366 /**< Maximum number of events can be dequeued at a time from an
367 * event port by this device.
368 * A device that does not support bulk dequeue will set this as 1.
370 uint32_t max_event_port_enqueue_depth;
371 /**< Maximum number of events can be enqueued at a time from an
372 * event port by this device.
373 * A device that does not support bulk enqueue will set this as 1.
375 int32_t max_num_events;
376 /**< A *closed system* event dev has a limit on the number of events it
377 * can manage at a time. An *open system* event dev does not have a
378 * limit and will specify this as -1.
380 uint32_t event_dev_cap;
381 /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
385 * Retrieve the contextual information of an event device.
388 * The identifier of the device.
390 * @param[out] dev_info
391 * A pointer to a structure of type *rte_event_dev_info* to be filled with the
392 * contextual information of the device.
395 * - 0: Success, driver updates the contextual information of the event device
396 * - <0: Error code returned by the driver info get function.
400 rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info);
403 * The count of ports.
405 #define RTE_EVENT_DEV_ATTR_PORT_COUNT 0
407 * The count of queues.
409 #define RTE_EVENT_DEV_ATTR_QUEUE_COUNT 1
411 * The status of the device, zero for stopped, non-zero for started.
413 #define RTE_EVENT_DEV_ATTR_STARTED 2
416 * Get an attribute from a device.
418 * @param dev_id Eventdev id
419 * @param attr_id The attribute ID to retrieve
420 * @param[out] attr_value A pointer that will be filled in with the attribute
421 * value if successful.
423 * @retval 0 Successfully retrieved attribute value
424 * -EINVAL Invalid device or *attr_id* provided, or *attr_value*
428 rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id,
429 uint32_t *attr_value);
432 /* Event device configuration bitmap flags */
433 #define RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT (1ULL << 0)
434 /**< Override the global *dequeue_timeout_ns* and use per dequeue timeout in ns.
435 * @see rte_event_dequeue_timeout_ticks(), rte_event_dequeue_burst()
438 /** Event device configuration structure */
439 struct rte_event_dev_config {
440 uint32_t dequeue_timeout_ns;
441 /**< rte_event_dequeue_burst() timeout on this device.
442 * This value should be in the range of *min_dequeue_timeout_ns* and
443 * *max_dequeue_timeout_ns* which previously provided in
444 * rte_event_dev_info_get()
445 * The value 0 is allowed, in which case, default dequeue timeout used.
446 * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
448 int32_t nb_events_limit;
449 /**< In a *closed system* this field is the limit on maximum number of
450 * events that can be inflight in the eventdev at a given time. The
451 * limit is required to ensure that the finite space in a closed system
452 * is not overwhelmed. The value cannot exceed the *max_num_events*
453 * as provided by rte_event_dev_info_get().
454 * This value should be set to -1 for *open system*.
456 uint8_t nb_event_queues;
457 /**< Number of event queues to configure on this device.
458 * This value cannot exceed the *max_event_queues* which previously
459 * provided in rte_event_dev_info_get()
461 uint8_t nb_event_ports;
462 /**< Number of event ports to configure on this device.
463 * This value cannot exceed the *max_event_ports* which previously
464 * provided in rte_event_dev_info_get()
466 uint32_t nb_event_queue_flows;
467 /**< Number of flows for any event queue on this device.
468 * This value cannot exceed the *max_event_queue_flows* which previously
469 * provided in rte_event_dev_info_get()
471 uint32_t nb_event_port_dequeue_depth;
472 /**< Maximum number of events can be dequeued at a time from an
473 * event port by this device.
474 * This value cannot exceed the *max_event_port_dequeue_depth*
475 * which previously provided in rte_event_dev_info_get().
476 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.
477 * @see rte_event_port_setup()
479 uint32_t nb_event_port_enqueue_depth;
480 /**< Maximum number of events can be enqueued at a time from an
481 * event port by this device.
482 * This value cannot exceed the *max_event_port_enqueue_depth*
483 * which previously provided in rte_event_dev_info_get().
484 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.
485 * @see rte_event_port_setup()
487 uint32_t event_dev_cfg;
488 /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/
492 * Configure an event device.
494 * This function must be invoked first before any other function in the
495 * API. This function can also be re-invoked when a device is in the
498 * The caller may use rte_event_dev_info_get() to get the capability of each
499 * resources available for this event device.
502 * The identifier of the device to configure.
504 * The event device configuration structure.
507 * - 0: Success, device configured.
508 * - <0: Error code returned by the driver configuration function.
511 rte_event_dev_configure(uint8_t dev_id,
512 const struct rte_event_dev_config *dev_conf);
515 /* Event queue specific APIs */
517 /* Event queue configuration bitmap flags */
518 #define RTE_EVENT_QUEUE_CFG_TYPE_MASK (3ULL << 0)
519 /**< Mask for event queue schedule type configuration request */
520 #define RTE_EVENT_QUEUE_CFG_ALL_TYPES (0ULL << 0)
521 /**< Allow ATOMIC,ORDERED,PARALLEL schedule type enqueue
523 * @see RTE_SCHED_TYPE_ORDERED, RTE_SCHED_TYPE_ATOMIC, RTE_SCHED_TYPE_PARALLEL
524 * @see rte_event_enqueue_burst()
526 #define RTE_EVENT_QUEUE_CFG_ATOMIC_ONLY (1ULL << 0)
527 /**< Allow only ATOMIC schedule type enqueue
529 * The rte_event_enqueue_burst() result is undefined if the queue configured
530 * with ATOMIC only and sched_type != RTE_SCHED_TYPE_ATOMIC
532 * @see RTE_SCHED_TYPE_ATOMIC, rte_event_enqueue_burst()
534 #define RTE_EVENT_QUEUE_CFG_ORDERED_ONLY (2ULL << 0)
535 /**< Allow only ORDERED schedule type enqueue
537 * The rte_event_enqueue_burst() result is undefined if the queue configured
538 * with ORDERED only and sched_type != RTE_SCHED_TYPE_ORDERED
540 * @see RTE_SCHED_TYPE_ORDERED, rte_event_enqueue_burst()
542 #define RTE_EVENT_QUEUE_CFG_PARALLEL_ONLY (3ULL << 0)
543 /**< Allow only PARALLEL schedule type enqueue
545 * The rte_event_enqueue_burst() result is undefined if the queue configured
546 * with PARALLEL only and sched_type != RTE_SCHED_TYPE_PARALLEL
548 * @see RTE_SCHED_TYPE_PARALLEL, rte_event_enqueue_burst()
550 #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK (1ULL << 2)
551 /**< This event queue links only to a single event port.
553 * @see rte_event_port_setup(), rte_event_port_link()
556 /** Event queue configuration structure */
557 struct rte_event_queue_conf {
558 uint32_t nb_atomic_flows;
559 /**< The maximum number of active flows this queue can track at any
560 * given time. If the queue is configured for atomic scheduling (by
561 * applying the RTE_EVENT_QUEUE_CFG_ALL_TYPES or
562 * RTE_EVENT_QUEUE_CFG_ATOMIC_ONLY flags to event_queue_cfg), then the
563 * value must be in the range of [1, nb_event_queue_flows], which was
564 * previously provided in rte_event_dev_configure().
566 uint32_t nb_atomic_order_sequences;
567 /**< The maximum number of outstanding events waiting to be
568 * reordered by this queue. In other words, the number of entries in
569 * this queue’s reorder buffer.When the number of events in the
570 * reorder buffer reaches to *nb_atomic_order_sequences* then the
571 * scheduler cannot schedule the events from this queue and invalid
572 * event will be returned from dequeue until one or more entries are
574 * If the queue is configured for ordered scheduling (by applying the
575 * RTE_EVENT_QUEUE_CFG_ALL_TYPES or RTE_EVENT_QUEUE_CFG_ORDERED_ONLY
576 * flags to event_queue_cfg), then the value must be in the range of
577 * [1, nb_event_queue_flows], which was previously supplied to
578 * rte_event_dev_configure().
580 uint32_t event_queue_cfg; /**< Queue cfg flags(EVENT_QUEUE_CFG_) */
582 /**< Priority for this event queue relative to other event queues.
583 * The requested priority should in the range of
584 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST].
585 * The implementation shall normalize the requested priority to
586 * event device supported priority value.
587 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability
592 * Retrieve the default configuration information of an event queue designated
593 * by its *queue_id* from the event driver for an event device.
595 * This function intended to be used in conjunction with rte_event_queue_setup()
596 * where caller needs to set up the queue by overriding few default values.
599 * The identifier of the device.
601 * The index of the event queue to get the configuration information.
602 * The value must be in the range [0, nb_event_queues - 1]
603 * previously supplied to rte_event_dev_configure().
604 * @param[out] queue_conf
605 * The pointer to the default event queue configuration data.
607 * - 0: Success, driver updates the default event queue configuration data.
608 * - <0: Error code returned by the driver info get function.
610 * @see rte_event_queue_setup()
614 rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id,
615 struct rte_event_queue_conf *queue_conf);
618 * Allocate and set up an event queue for an event device.
621 * The identifier of the device.
623 * The index of the event queue to setup. The value must be in the range
624 * [0, nb_event_queues - 1] previously supplied to rte_event_dev_configure().
626 * The pointer to the configuration data to be used for the event queue.
627 * NULL value is allowed, in which case default configuration used.
629 * @see rte_event_queue_default_conf_get()
632 * - 0: Success, event queue correctly set up.
633 * - <0: event queue configuration failed
636 rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id,
637 const struct rte_event_queue_conf *queue_conf);
640 * The priority of the queue.
642 #define RTE_EVENT_QUEUE_ATTR_PRIORITY 0
644 * The number of atomic flows configured for the queue.
646 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_FLOWS 1
648 * The number of atomic order sequences configured for the queue.
650 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_ORDER_SEQUENCES 2
652 * The cfg flags for the queue.
654 #define RTE_EVENT_QUEUE_ATTR_EVENT_QUEUE_CFG 3
657 * Get an attribute from a queue.
659 * @param dev_id Eventdev id
660 * @param queue_id Eventdev queue id
661 * @param attr_id The attribute ID to retrieve
662 * @param[out] attr_value A pointer that will be filled in with the attribute
663 * value if successful
665 * @retval 0 Successfully returned value
666 * -EINVAL invalid device, queue or attr_id provided, or attr_value
670 rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id,
671 uint32_t *attr_value);
673 /* Event port specific APIs */
675 /** Event port configuration structure */
676 struct rte_event_port_conf {
677 int32_t new_event_threshold;
678 /**< A backpressure threshold for new event enqueues on this port.
679 * Use for *closed system* event dev where event capacity is limited,
680 * and cannot exceed the capacity of the event dev.
681 * Configuring ports with different thresholds can make higher priority
682 * traffic less likely to be backpressured.
683 * For example, a port used to inject NIC Rx packets into the event dev
684 * can have a lower threshold so as not to overwhelm the device,
685 * while ports used for worker pools can have a higher threshold.
686 * This value cannot exceed the *nb_events_limit*
687 * which was previously supplied to rte_event_dev_configure().
688 * This should be set to '-1' for *open system*.
690 uint16_t dequeue_depth;
691 /**< Configure number of bulk dequeues for this event port.
692 * This value cannot exceed the *nb_event_port_dequeue_depth*
693 * which previously supplied to rte_event_dev_configure().
694 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.
696 uint16_t enqueue_depth;
697 /**< Configure number of bulk enqueues for this event port.
698 * This value cannot exceed the *nb_event_port_enqueue_depth*
699 * which previously supplied to rte_event_dev_configure().
700 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable.
705 * Retrieve the default configuration information of an event port designated
706 * by its *port_id* from the event driver for an event device.
708 * This function intended to be used in conjunction with rte_event_port_setup()
709 * where caller needs to set up the port by overriding few default values.
712 * The identifier of the device.
714 * The index of the event port to get the configuration information.
715 * The value must be in the range [0, nb_event_ports - 1]
716 * previously supplied to rte_event_dev_configure().
717 * @param[out] port_conf
718 * The pointer to the default event port configuration data
720 * - 0: Success, driver updates the default event port configuration data.
721 * - <0: Error code returned by the driver info get function.
723 * @see rte_event_port_setup()
727 rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id,
728 struct rte_event_port_conf *port_conf);
731 * Allocate and set up an event port for an event device.
734 * The identifier of the device.
736 * The index of the event port to setup. The value must be in the range
737 * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure().
739 * The pointer to the configuration data to be used for the queue.
740 * NULL value is allowed, in which case default configuration used.
742 * @see rte_event_port_default_conf_get()
745 * - 0: Success, event port correctly set up.
746 * - <0: Port configuration failed
747 * - (-EDQUOT) Quota exceeded(Application tried to link the queue configured
748 * with RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports)
751 rte_event_port_setup(uint8_t dev_id, uint8_t port_id,
752 const struct rte_event_port_conf *port_conf);
755 * The queue depth of the port on the enqueue side
757 #define RTE_EVENT_PORT_ATTR_ENQ_DEPTH 0
759 * The queue depth of the port on the dequeue side
761 #define RTE_EVENT_PORT_ATTR_DEQ_DEPTH 1
764 * Get an attribute from a port.
766 * @param dev_id Eventdev id
767 * @param port_id Eventdev port id
768 * @param attr_id The attribute ID to retrieve
769 * @param[out] attr_value A pointer that will be filled in with the attribute
770 * value if successful
772 * @retval 0 Successfully returned value
773 * -EINVAL Invalid device, port or attr_id, or attr_value was NULL
776 rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id,
777 uint32_t *attr_value);
780 * Start an event device.
782 * The device start step is the last one and consists of setting the event
783 * queues to start accepting the events and schedules to event ports.
785 * On success, all basic functions exported by the API (event enqueue,
786 * event dequeue and so on) can be invoked.
789 * Event device identifier
791 * - 0: Success, device started.
792 * - -ESTALE : Not all ports of the device are configured
793 * - -ENOLINK: Not all queues are linked, which could lead to deadlock.
796 rte_event_dev_start(uint8_t dev_id);
799 * Stop an event device. The device can be restarted with a call to
800 * rte_event_dev_start()
803 * Event device identifier.
806 rte_event_dev_stop(uint8_t dev_id);
809 * Close an event device. The device cannot be restarted!
812 * Event device identifier
815 * - 0 on successfully closing device
816 * - <0 on failure to close device
817 * - (-EAGAIN) if device is busy
820 rte_event_dev_close(uint8_t dev_id);
822 /* Scheduler type definitions */
823 #define RTE_SCHED_TYPE_ORDERED 0
824 /**< Ordered scheduling
826 * Events from an ordered flow of an event queue can be scheduled to multiple
827 * ports for concurrent processing while maintaining the original event order.
828 * This scheme enables the user to achieve high single flow throughput by
829 * avoiding SW synchronization for ordering between ports which bound to cores.
831 * The source flow ordering from an event queue is maintained when events are
832 * enqueued to their destination queue within the same ordered flow context.
833 * An event port holds the context until application call
834 * rte_event_dequeue_burst() from the same port, which implicitly releases
836 * User may allow the scheduler to release the context earlier than that
837 * by invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE operation.
839 * Events from the source queue appear in their original order when dequeued
840 * from a destination queue.
841 * Event ordering is based on the received event(s), but also other
842 * (newly allocated or stored) events are ordered when enqueued within the same
843 * ordered context. Events not enqueued (e.g. released or stored) within the
844 * context are considered missing from reordering and are skipped at this time
845 * (but can be ordered again within another context).
847 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE
850 #define RTE_SCHED_TYPE_ATOMIC 1
851 /**< Atomic scheduling
853 * Events from an atomic flow of an event queue can be scheduled only to a
854 * single port at a time. The port is guaranteed to have exclusive (atomic)
855 * access to the associated flow context, which enables the user to avoid SW
856 * synchronization. Atomic flows also help to maintain event ordering
857 * since only one port at a time can process events from a flow of an
860 * The atomic queue synchronization context is dedicated to the port until
861 * application call rte_event_dequeue_burst() from the same port,
862 * which implicitly releases the context. User may allow the scheduler to
863 * release the context earlier than that by invoking rte_event_enqueue_burst()
864 * with RTE_EVENT_OP_RELEASE operation.
866 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE
869 #define RTE_SCHED_TYPE_PARALLEL 2
870 /**< Parallel scheduling
872 * The scheduler performs priority scheduling, load balancing, etc. functions
873 * but does not provide additional event synchronization or ordering.
874 * It is free to schedule events from a single parallel flow of an event queue
875 * to multiple events ports for concurrent processing.
876 * The application is responsible for flow context synchronization and
877 * event ordering (SW synchronization).
879 * @see rte_event_queue_setup(), rte_event_dequeue_burst()
882 /* Event types to classify the event source */
883 #define RTE_EVENT_TYPE_ETHDEV 0x0
884 /**< The event generated from ethdev subsystem */
885 #define RTE_EVENT_TYPE_CRYPTODEV 0x1
886 /**< The event generated from crypodev subsystem */
887 #define RTE_EVENT_TYPE_TIMERDEV 0x2
888 /**< The event generated from timerdev subsystem */
889 #define RTE_EVENT_TYPE_CPU 0x3
890 /**< The event generated from cpu for pipelining.
891 * Application may use *sub_event_type* to further classify the event
893 #define RTE_EVENT_TYPE_MAX 0x10
894 /**< Maximum number of event types */
896 /* Event enqueue operations */
897 #define RTE_EVENT_OP_NEW 0
898 /**< The event producers use this operation to inject a new event to the
901 #define RTE_EVENT_OP_FORWARD 1
902 /**< The CPU use this operation to forward the event to different event queue or
903 * change to new application specific flow or schedule type to enable
906 * This operation must only be enqueued to the same port that the
907 * event to be forwarded was dequeued from.
909 #define RTE_EVENT_OP_RELEASE 2
910 /**< Release the flow context associated with the schedule type.
912 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ATOMIC*
913 * then this function hints the scheduler that the user has completed critical
914 * section processing in the current atomic context.
915 * The scheduler is now allowed to schedule events from the same flow from
916 * an event queue to another port. However, the context may be still held
917 * until the next rte_event_dequeue_burst() call, this call allows but does not
918 * force the scheduler to release the context early.
920 * Early atomic context release may increase parallelism and thus system
921 * performance, but the user needs to design carefully the split into critical
922 * vs non-critical sections.
924 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ORDERED*
925 * then this function hints the scheduler that the user has done all that need
926 * to maintain event order in the current ordered context.
927 * The scheduler is allowed to release the ordered context of this port and
928 * avoid reordering any following enqueues.
930 * Early ordered context release may increase parallelism and thus system
933 * If current flow's scheduler type method is *RTE_SCHED_TYPE_PARALLEL*
934 * or no scheduling context is held then this function may be an NOOP,
935 * depending on the implementation.
937 * This operation must only be enqueued to the same port that the
938 * event to be released was dequeued from.
943 * The generic *rte_event* structure to hold the event attributes
944 * for dequeue and enqueue operation
951 /** Event attributes for dequeue or enqueue operation */
954 /**< Targeted flow identifier for the enqueue and
956 * The value must be in the range of
957 * [0, nb_event_queue_flows - 1] which
958 * previously supplied to rte_event_dev_configure().
960 uint32_t sub_event_type:8;
961 /**< Sub-event types based on the event source.
962 * @see RTE_EVENT_TYPE_CPU
964 uint32_t event_type:4;
965 /**< Event type to classify the event source.
966 * @see RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*)
969 /**< The type of event enqueue operation - new/forward/
970 * etc.This field is not preserved across an instance
971 * and is undefined on dequeue.
972 * @see RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*)
975 /**< Reserved for future use */
976 uint8_t sched_type:2;
977 /**< Scheduler synchronization type (RTE_SCHED_TYPE_*)
978 * associated with flow id on a given event queue
979 * for the enqueue and dequeue operation.
982 /**< Targeted event queue identifier for the enqueue or
984 * The value must be in the range of
985 * [0, nb_event_queues - 1] which previously supplied to
986 * rte_event_dev_configure().
989 /**< Event priority relative to other events in the
990 * event queue. The requested priority should in the
991 * range of [RTE_EVENT_DEV_PRIORITY_HIGHEST,
992 * RTE_EVENT_DEV_PRIORITY_LOWEST].
993 * The implementation shall normalize the requested
994 * priority to supported priority value.
995 * Valid when the device has
996 * RTE_EVENT_DEV_CAP_EVENT_QOS capability.
999 /**< Implementation specific opaque value.
1000 * An implementation may use this field to hold
1001 * implementation specific value to share between
1002 * dequeue and enqueue operation.
1003 * The application should not modify this field.
1010 /**< Opaque 64-bit value */
1012 /**< Opaque event pointer */
1013 struct rte_mbuf *mbuf;
1014 /**< mbuf pointer if dequeued event is associated with mbuf */
1019 struct rte_eventdev_driver;
1020 struct rte_eventdev_ops;
1021 struct rte_eventdev;
1023 typedef void (*event_schedule_t)(struct rte_eventdev *dev);
1024 /**< @internal Schedule one or more events in the event dev. */
1026 typedef uint16_t (*event_enqueue_t)(void *port, const struct rte_event *ev);
1027 /**< @internal Enqueue event on port of a device */
1029 typedef uint16_t (*event_enqueue_burst_t)(void *port,
1030 const struct rte_event ev[], uint16_t nb_events);
1031 /**< @internal Enqueue burst of events on port of a device */
1033 typedef uint16_t (*event_dequeue_t)(void *port, struct rte_event *ev,
1034 uint64_t timeout_ticks);
1035 /**< @internal Dequeue event from port of a device */
1037 typedef uint16_t (*event_dequeue_burst_t)(void *port, struct rte_event ev[],
1038 uint16_t nb_events, uint64_t timeout_ticks);
1039 /**< @internal Dequeue burst of events from port of a device */
1041 #define RTE_EVENTDEV_NAME_MAX_LEN (64)
1042 /**< @internal Max length of name of event PMD */
1046 * The data part, with no function pointers, associated with each device.
1048 * This structure is safe to place in shared memory to be common among
1049 * different processes in a multi-process configuration.
1051 struct rte_eventdev_data {
1053 /**< Socket ID where memory is allocated */
1055 /**< Device ID for this instance */
1057 /**< Number of event queues. */
1059 /**< Number of event ports. */
1061 /**< Array of pointers to ports. */
1062 uint8_t *ports_dequeue_depth;
1063 /**< Array of port dequeue depth. */
1064 uint8_t *ports_enqueue_depth;
1065 /**< Array of port enqueue depth. */
1066 struct rte_event_queue_conf *queues_cfg;
1067 /**< Array of queue configuration structures. */
1068 uint16_t *links_map;
1069 /**< Memory to store queues to port connections. */
1071 /**< PMD-specific private data */
1072 uint32_t event_dev_cap;
1073 /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
1074 struct rte_event_dev_config dev_conf;
1075 /**< Configuration applied to device. */
1078 uint8_t dev_started : 1;
1079 /**< Device state: STARTED(1)/STOPPED(0) */
1081 char name[RTE_EVENTDEV_NAME_MAX_LEN];
1082 /**< Unique identifier name */
1083 } __rte_cache_aligned;
1085 /** @internal The data structure associated with each event device. */
1086 struct rte_eventdev {
1087 event_schedule_t schedule;
1088 /**< Pointer to PMD schedule function. */
1089 event_enqueue_t enqueue;
1090 /**< Pointer to PMD enqueue function. */
1091 event_enqueue_burst_t enqueue_burst;
1092 /**< Pointer to PMD enqueue burst function. */
1093 event_enqueue_burst_t enqueue_new_burst;
1094 /**< Pointer to PMD enqueue burst function(op new variant) */
1095 event_enqueue_burst_t enqueue_forward_burst;
1096 /**< Pointer to PMD enqueue burst function(op forward variant) */
1097 event_dequeue_t dequeue;
1098 /**< Pointer to PMD dequeue function. */
1099 event_dequeue_burst_t dequeue_burst;
1100 /**< Pointer to PMD dequeue burst function. */
1102 struct rte_eventdev_data *data;
1103 /**< Pointer to device data */
1104 const struct rte_eventdev_ops *dev_ops;
1105 /**< Functions exported by PMD */
1106 struct rte_device *dev;
1107 /**< Device info. supplied by probing */
1110 uint8_t attached : 1;
1111 /**< Flag indicating the device is attached */
1112 } __rte_cache_aligned;
1114 extern struct rte_eventdev *rte_eventdevs;
1115 /** @internal The pool of rte_eventdev structures. */
1119 * Schedule one or more events in the event dev.
1121 * An event dev implementation may define this is a NOOP, for instance if
1122 * the event dev performs its scheduling in hardware.
1125 * The identifier of the device.
1128 rte_event_schedule(uint8_t dev_id)
1130 struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1132 (*dev->schedule)(dev);
1135 static __rte_always_inline uint16_t
1136 __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1137 const struct rte_event ev[], uint16_t nb_events,
1138 const event_enqueue_burst_t fn)
1140 const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1142 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
1143 if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) {
1144 rte_errno = -EINVAL;
1148 if (port_id >= dev->data->nb_ports) {
1149 rte_errno = -EINVAL;
1154 * Allow zero cost non burst mode routine invocation if application
1155 * requests nb_events as const one
1158 return (*dev->enqueue)(dev->data->ports[port_id], ev);
1160 return fn(dev->data->ports[port_id], ev, nb_events);
1164 * Enqueue a burst of events objects or an event object supplied in *rte_event*
1165 * structure on an event device designated by its *dev_id* through the event
1166 * port specified by *port_id*. Each event object specifies the event queue on
1167 * which it will be enqueued.
1169 * The *nb_events* parameter is the number of event objects to enqueue which are
1170 * supplied in the *ev* array of *rte_event* structure.
1172 * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
1173 * enqueued to the same port that their associated events were dequeued from.
1175 * The rte_event_enqueue_burst() function returns the number of
1176 * events objects it actually enqueued. A return value equal to *nb_events*
1177 * means that all event objects have been enqueued.
1180 * The identifier of the device.
1182 * The identifier of the event port.
1184 * Points to an array of *nb_events* objects of type *rte_event* structure
1185 * which contain the event object enqueue operations to be processed.
1187 * The number of event objects to enqueue, typically number of
1188 * rte_event_port_enqueue_depth() available for this port.
1191 * The number of event objects actually enqueued on the event device. The
1192 * return value can be less than the value of the *nb_events* parameter when
1193 * the event devices queue is full or if invalid parameters are specified in a
1194 * *rte_event*. If the return value is less than *nb_events*, the remaining
1195 * events at the end of ev[] are not consumed and the caller has to take care
1196 * of them, and rte_errno is set accordingly. Possible errno values include:
1197 * - -EINVAL The port ID is invalid, device ID is invalid, an event's queue
1198 * ID is invalid, or an event's sched type doesn't match the
1199 * capabilities of the destination queue.
1200 * - -ENOSPC The event port was backpressured and unable to enqueue
1201 * one or more events. This error code is only applicable to
1203 * @see rte_event_port_enqueue_depth()
1205 static inline uint16_t
1206 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1207 const struct rte_event ev[], uint16_t nb_events)
1209 const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1211 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1212 dev->enqueue_burst);
1216 * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_NEW* on
1217 * an event device designated by its *dev_id* through the event port specified
1220 * Provides the same functionality as rte_event_enqueue_burst(), expect that
1221 * application can use this API when the all objects in the burst contains
1222 * the enqueue operation of the type *RTE_EVENT_OP_NEW*. This specialized
1223 * function can provide the additional hint to the PMD and optimize if possible.
1225 * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst
1226 * has event object of operation type != RTE_EVENT_OP_NEW.
1229 * The identifier of the device.
1231 * The identifier of the event port.
1233 * Points to an array of *nb_events* objects of type *rte_event* structure
1234 * which contain the event object enqueue operations to be processed.
1236 * The number of event objects to enqueue, typically number of
1237 * rte_event_port_enqueue_depth() available for this port.
1240 * The number of event objects actually enqueued on the event device. The
1241 * return value can be less than the value of the *nb_events* parameter when
1242 * the event devices queue is full or if invalid parameters are specified in a
1243 * *rte_event*. If the return value is less than *nb_events*, the remaining
1244 * events at the end of ev[] are not consumed and the caller has to take care
1245 * of them, and rte_errno is set accordingly. Possible errno values include:
1246 * - -EINVAL The port ID is invalid, device ID is invalid, an event's queue
1247 * ID is invalid, or an event's sched type doesn't match the
1248 * capabilities of the destination queue.
1249 * - -ENOSPC The event port was backpressured and unable to enqueue
1250 * one or more events. This error code is only applicable to
1252 * @see rte_event_port_enqueue_depth() rte_event_enqueue_burst()
1254 static inline uint16_t
1255 rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id,
1256 const struct rte_event ev[], uint16_t nb_events)
1258 const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1260 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1261 dev->enqueue_new_burst);
1265 * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_FORWARD*
1266 * on an event device designated by its *dev_id* through the event port
1267 * specified by *port_id*.
1269 * Provides the same functionality as rte_event_enqueue_burst(), expect that
1270 * application can use this API when the all objects in the burst contains
1271 * the enqueue operation of the type *RTE_EVENT_OP_FORWARD*. This specialized
1272 * function can provide the additional hint to the PMD and optimize if possible.
1274 * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst
1275 * has event object of operation type != RTE_EVENT_OP_FORWARD.
1278 * The identifier of the device.
1280 * The identifier of the event port.
1282 * Points to an array of *nb_events* objects of type *rte_event* structure
1283 * which contain the event object enqueue operations to be processed.
1285 * The number of event objects to enqueue, typically number of
1286 * rte_event_port_enqueue_depth() available for this port.
1289 * The number of event objects actually enqueued on the event device. The
1290 * return value can be less than the value of the *nb_events* parameter when
1291 * the event devices queue is full or if invalid parameters are specified in a
1292 * *rte_event*. If the return value is less than *nb_events*, the remaining
1293 * events at the end of ev[] are not consumed and the caller has to take care
1294 * of them, and rte_errno is set accordingly. Possible errno values include:
1295 * - -EINVAL The port ID is invalid, device ID is invalid, an event's queue
1296 * ID is invalid, or an event's sched type doesn't match the
1297 * capabilities of the destination queue.
1298 * - -ENOSPC The event port was backpressured and unable to enqueue
1299 * one or more events. This error code is only applicable to
1301 * @see rte_event_port_enqueue_depth() rte_event_enqueue_burst()
1303 static inline uint16_t
1304 rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id,
1305 const struct rte_event ev[], uint16_t nb_events)
1307 const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1309 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1310 dev->enqueue_forward_burst);
1314 * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue_burst()
1316 * If the device is configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT flag
1317 * then application can use this function to convert timeout value in
1318 * nanoseconds to implementations specific timeout value supplied in
1319 * rte_event_dequeue_burst()
1322 * The identifier of the device.
1324 * Wait time in nanosecond
1325 * @param[out] timeout_ticks
1326 * Value for the *timeout_ticks* parameter in rte_event_dequeue_burst()
1330 * - -ENOTSUP if the device doesn't support timeouts
1331 * - -EINVAL if *dev_id* is invalid or *timeout_ticks* is NULL
1332 * - other values < 0 on failure.
1334 * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
1335 * @see rte_event_dev_configure()
1339 rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
1340 uint64_t *timeout_ticks);
1343 * Dequeue a burst of events objects or an event object from the event port
1344 * designated by its *event_port_id*, on an event device designated
1347 * rte_event_dequeue_burst() does not dictate the specifics of scheduling
1348 * algorithm as each eventdev driver may have different criteria to schedule
1349 * an event. However, in general, from an application perspective scheduler may
1350 * use the following scheme to dispatch an event to the port.
1352 * 1) Selection of event queue based on
1353 * a) The list of event queues are linked to the event port.
1354 * b) If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then event
1355 * queue selection from list is based on event queue priority relative to
1356 * other event queue supplied as *priority* in rte_event_queue_setup()
1357 * c) If the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability then event
1358 * queue selection from the list is based on event priority supplied as
1359 * *priority* in rte_event_enqueue_burst()
1360 * 2) Selection of event
1361 * a) The number of flows available in selected event queue.
1362 * b) Schedule type method associated with the event
1364 * The *nb_events* parameter is the maximum number of event objects to dequeue
1365 * which are returned in the *ev* array of *rte_event* structure.
1367 * The rte_event_dequeue_burst() function returns the number of events objects
1368 * it actually dequeued. A return value equal to *nb_events* means that all
1369 * event objects have been dequeued.
1371 * The number of events dequeued is the number of scheduler contexts held by
1372 * this port. These contexts are automatically released in the next
1373 * rte_event_dequeue_burst() invocation, or invoking rte_event_enqueue_burst()
1374 * with RTE_EVENT_OP_RELEASE operation can be used to release the
1377 * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
1378 * enqueued to the same port that their associated events were dequeued from.
1381 * The identifier of the device.
1383 * The identifier of the event port.
1385 * Points to an array of *nb_events* objects of type *rte_event* structure
1386 * for output to be populated with the dequeued event objects.
1388 * The maximum number of event objects to dequeue, typically number of
1389 * rte_event_port_dequeue_depth() available for this port.
1391 * @param timeout_ticks
1392 * - 0 no-wait, returns immediately if there is no event.
1393 * - >0 wait for the event, if the device is configured with
1394 * RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT then this function will wait until
1395 * at least one event is available or *timeout_ticks* time.
1396 * if the device is not configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
1397 * then this function will wait until the event available or
1398 * *dequeue_timeout_ns* ns which was previously supplied to
1399 * rte_event_dev_configure()
1402 * The number of event objects actually dequeued from the port. The return
1403 * value can be less than the value of the *nb_events* parameter when the
1404 * event port's queue is not full.
1406 * @see rte_event_port_dequeue_depth()
1408 static inline uint16_t
1409 rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[],
1410 uint16_t nb_events, uint64_t timeout_ticks)
1412 struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1414 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
1415 if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) {
1416 rte_errno = -EINVAL;
1420 if (port_id >= dev->data->nb_ports) {
1421 rte_errno = -EINVAL;
1427 * Allow zero cost non burst mode routine invocation if application
1428 * requests nb_events as const one
1431 return (*dev->dequeue)(
1432 dev->data->ports[port_id], ev, timeout_ticks);
1434 return (*dev->dequeue_burst)(
1435 dev->data->ports[port_id], ev, nb_events,
1440 * Link multiple source event queues supplied in *queues* to the destination
1441 * event port designated by its *port_id* with associated service priority
1442 * supplied in *priorities* on the event device designated by its *dev_id*.
1444 * The link establishment shall enable the event port *port_id* from
1445 * receiving events from the specified event queue(s) supplied in *queues*
1447 * An event queue may link to one or more event ports.
1448 * The number of links can be established from an event queue to event port is
1449 * implementation defined.
1451 * Event queue(s) to event port link establishment can be changed at runtime
1452 * without re-configuring the device to support scaling and to reduce the
1453 * latency of critical work by establishing the link with more event ports
1457 * The identifier of the device.
1460 * Event port identifier to select the destination port to link.
1463 * Points to an array of *nb_links* event queues to be linked
1464 * to the event port.
1465 * NULL value is allowed, in which case this function links all the configured
1466 * event queues *nb_event_queues* which previously supplied to
1467 * rte_event_dev_configure() to the event port *port_id*
1470 * Points to an array of *nb_links* service priorities associated with each
1471 * event queue link to event port.
1472 * The priority defines the event port's servicing priority for
1473 * event queue, which may be ignored by an implementation.
1474 * The requested priority should in the range of
1475 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST].
1476 * The implementation shall normalize the requested priority to
1477 * implementation supported priority value.
1478 * NULL value is allowed, in which case this function links the event queues
1479 * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority
1482 * The number of links to establish. This parameter is ignored if queues is
1486 * The number of links actually established. The return value can be less than
1487 * the value of the *nb_links* parameter when the implementation has the
1488 * limitation on specific queue to port link establishment or if invalid
1489 * parameters are specified in *queues*
1490 * If the return value is less than *nb_links*, the remaining links at the end
1491 * of link[] are not established, and the caller has to take care of them.
1492 * If return value is less than *nb_links* then implementation shall update the
1493 * rte_errno accordingly, Possible rte_errno values are
1494 * (-EDQUOT) Quota exceeded(Application tried to link the queue configured with
1495 * RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports)
1496 * (-EINVAL) Invalid parameter
1500 rte_event_port_link(uint8_t dev_id, uint8_t port_id,
1501 const uint8_t queues[], const uint8_t priorities[],
1505 * Unlink multiple source event queues supplied in *queues* from the destination
1506 * event port designated by its *port_id* on the event device designated
1509 * The unlink establishment shall disable the event port *port_id* from
1510 * receiving events from the specified event queue *queue_id*
1512 * Event queue(s) to event port unlink establishment can be changed at runtime
1513 * without re-configuring the device.
1516 * The identifier of the device.
1519 * Event port identifier to select the destination port to unlink.
1522 * Points to an array of *nb_unlinks* event queues to be unlinked
1523 * from the event port.
1524 * NULL value is allowed, in which case this function unlinks all the
1525 * event queue(s) from the event port *port_id*.
1528 * The number of unlinks to establish. This parameter is ignored if queues is
1532 * The number of unlinks actually established. The return value can be less
1533 * than the value of the *nb_unlinks* parameter when the implementation has the
1534 * limitation on specific queue to port unlink establishment or
1535 * if invalid parameters are specified.
1536 * If the return value is less than *nb_unlinks*, the remaining queues at the
1537 * end of queues[] are not established, and the caller has to take care of them.
1538 * If return value is less than *nb_unlinks* then implementation shall update
1539 * the rte_errno accordingly, Possible rte_errno values are
1540 * (-EINVAL) Invalid parameter
1544 rte_event_port_unlink(uint8_t dev_id, uint8_t port_id,
1545 uint8_t queues[], uint16_t nb_unlinks);
1548 * Retrieve the list of source event queues and its associated service priority
1549 * linked to the destination event port designated by its *port_id*
1550 * on the event device designated by its *dev_id*.
1553 * The identifier of the device.
1556 * Event port identifier.
1558 * @param[out] queues
1559 * Points to an array of *queues* for output.
1560 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to
1561 * store the event queue(s) linked with event port *port_id*
1563 * @param[out] priorities
1564 * Points to an array of *priorities* for output.
1565 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to
1566 * store the service priority associated with each event queue linked
1569 * The number of links established on the event port designated by its
1575 rte_event_port_links_get(uint8_t dev_id, uint8_t port_id,
1576 uint8_t queues[], uint8_t priorities[]);
1579 * Dump internal information about *dev_id* to the FILE* provided in *f*.
1582 * The identifier of the device.
1585 * A pointer to a file for output
1592 rte_event_dev_dump(uint8_t dev_id, FILE *f);
1594 /** Maximum name length for extended statistics counters */
1595 #define RTE_EVENT_DEV_XSTATS_NAME_SIZE 64
1598 * Selects the component of the eventdev to retrieve statistics from.
1600 enum rte_event_dev_xstats_mode {
1601 RTE_EVENT_DEV_XSTATS_DEVICE,
1602 RTE_EVENT_DEV_XSTATS_PORT,
1603 RTE_EVENT_DEV_XSTATS_QUEUE,
1607 * A name-key lookup element for extended statistics.
1609 * This structure is used to map between names and ID numbers
1610 * for extended ethdev statistics.
1612 struct rte_event_dev_xstats_name {
1613 char name[RTE_EVENT_DEV_XSTATS_NAME_SIZE];
1617 * Retrieve names of extended statistics of an event device.
1620 * The identifier of the event device.
1622 * The mode of statistics to retrieve. Choices include the device statistics,
1623 * port statistics or queue statistics.
1624 * @param queue_port_id
1625 * Used to specify the port or queue number in queue or port mode, and is
1626 * ignored in device mode.
1627 * @param[out] xstats_names
1628 * Block of memory to insert names into. Must be at least size in capacity.
1629 * If set to NULL, function returns required capacity.
1631 * Block of memory to insert ids into. Must be at least size in capacity.
1632 * If set to NULL, function returns required capacity. The id values returned
1633 * can be passed to *rte_event_dev_xstats_get* to select statistics.
1635 * Capacity of xstats_names (number of names).
1637 * - positive value lower or equal to size: success. The return value
1638 * is the number of entries filled in the stats table.
1639 * - positive value higher than size: error, the given statistics table
1640 * is too small. The return value corresponds to the size that should
1641 * be given to succeed. The entries in the table are not valid and
1642 * shall not be used by the caller.
1643 * - negative value on error:
1644 * -ENODEV for invalid *dev_id*
1645 * -EINVAL for invalid mode, queue port or id parameters
1646 * -ENOTSUP if the device doesn't support this function.
1649 rte_event_dev_xstats_names_get(uint8_t dev_id,
1650 enum rte_event_dev_xstats_mode mode,
1651 uint8_t queue_port_id,
1652 struct rte_event_dev_xstats_name *xstats_names,
1657 * Retrieve extended statistics of an event device.
1660 * The identifier of the device.
1662 * The mode of statistics to retrieve. Choices include the device statistics,
1663 * port statistics or queue statistics.
1664 * @param queue_port_id
1665 * Used to specify the port or queue number in queue or port mode, and is
1666 * ignored in device mode.
1668 * The id numbers of the stats to get. The ids can be got from the stat
1669 * position in the stat list from rte_event_dev_get_xstats_names(), or
1670 * by using rte_eventdev_get_xstats_by_name()
1671 * @param[out] values
1672 * The values for each stats request by ID.
1674 * The number of stats requested
1676 * - positive value: number of stat entries filled into the values array
1677 * - negative value on error:
1678 * -ENODEV for invalid *dev_id*
1679 * -EINVAL for invalid mode, queue port or id parameters
1680 * -ENOTSUP if the device doesn't support this function.
1683 rte_event_dev_xstats_get(uint8_t dev_id,
1684 enum rte_event_dev_xstats_mode mode,
1685 uint8_t queue_port_id,
1686 const unsigned int ids[],
1687 uint64_t values[], unsigned int n);
1690 * Retrieve the value of a single stat by requesting it by name.
1693 * The identifier of the device
1695 * The stat name to retrieve
1697 * If non-NULL, the numerical id of the stat will be returned, so that further
1698 * requests for the stat can be got using rte_eventdev_xstats_get, which will
1699 * be faster as it doesn't need to scan a list of names for the stat.
1700 * If the stat cannot be found, the id returned will be (unsigned)-1.
1702 * - positive value or zero: the stat value
1703 * - negative value: -EINVAL if stat not found, -ENOTSUP if not supported.
1706 rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name,
1710 * Reset the values of the xstats of the selected component in the device.
1713 * The identifier of the device
1715 * The mode of the statistics to reset. Choose from device, queue or port.
1716 * @param queue_port_id
1717 * The queue or port to reset. 0 and positive values select ports and queues,
1718 * while -1 indicates all ports or queues.
1720 * Selects specific statistics to be reset. When NULL, all statistics selected
1721 * by *mode* will be reset. If non-NULL, must point to array of at least
1724 * The number of ids available from the *ids* array. Ignored when ids is NULL.
1726 * - zero: successfully reset the statistics to zero
1727 * - negative value: -EINVAL invalid parameters, -ENOTSUP if not supported.
1730 rte_event_dev_xstats_reset(uint8_t dev_id,
1731 enum rte_event_dev_xstats_mode mode,
1732 int16_t queue_port_id,
1733 const uint32_t ids[],
1740 #endif /* _RTE_EVENTDEV_H_ */