4 * Copyright 2016 Cavium.
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 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 * An event driven based application has following typical workflow on fastpath:
206 * rte_event_schedule(dev_id);
208 * rte_event_dequeue(...);
212 * rte_event_enqueue(...);
216 * The events are injected to event device through *enqueue* operation by
217 * event producers in the system. The typical event producers are ethdev
218 * subsystem for generating packet events, CPU(SW) for generating events based
219 * on different stages of application processing, cryptodev for generating
220 * crypto work completion notification etc
222 * The *dequeue* operation gets one or more events from the event ports.
223 * The application process the events and send to downstream event queue through
224 * rte_event_enqueue_burst() if it is an intermediate stage of event processing,
225 * on the final stage, the application may send to different subsystem like
226 * ethdev to send the packet/event on the wire using ethdev
227 * rte_eth_tx_burst() API.
229 * The point at which events are scheduled to ports depends on the device.
230 * For hardware devices, scheduling occurs asynchronously without any software
231 * intervention. Software schedulers can either be distributed
232 * (each worker thread schedules events to its own port) or centralized
233 * (a dedicated thread schedules to all ports). Distributed software schedulers
234 * perform the scheduling in rte_event_dequeue_burst(), whereas centralized
235 * scheduler logic is located in rte_event_schedule().
236 * The RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED capability flag is not set
237 * indicates the device is centralized and thus needs a dedicated scheduling
238 * thread that repeatedly calls rte_event_schedule().
246 #include <rte_common.h>
248 #include <rte_mbuf.h>
250 /* Event device capability bitmap flags */
251 #define RTE_EVENT_DEV_CAP_QUEUE_QOS (1ULL << 0)
252 /**< Event scheduling prioritization is based on the priority associated with
255 * @see rte_event_queue_setup()
257 #define RTE_EVENT_DEV_CAP_EVENT_QOS (1ULL << 1)
258 /**< Event scheduling prioritization is based on the priority associated with
259 * each event. Priority of each event is supplied in *rte_event* structure
260 * on each enqueue operation.
262 * @see rte_event_enqueue_burst()
264 #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2)
265 /**< Event device operates in distributed scheduling mode.
266 * In distributed scheduling mode, event scheduling happens in HW or
267 * rte_event_dequeue_burst() or the combination of these two.
268 * If the flag is not set then eventdev is centralized and thus needs a
269 * dedicated scheduling thread that repeatedly calls rte_event_schedule().
271 * @see rte_event_schedule(), rte_event_dequeue_burst()
274 /* Event device priority levels */
275 #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0
276 /**< Highest priority expressed across eventdev subsystem
277 * @see rte_event_queue_setup(), rte_event_enqueue_burst()
278 * @see rte_event_port_link()
280 #define RTE_EVENT_DEV_PRIORITY_NORMAL 128
281 /**< Normal priority expressed across eventdev subsystem
282 * @see rte_event_queue_setup(), rte_event_enqueue_burst()
283 * @see rte_event_port_link()
285 #define RTE_EVENT_DEV_PRIORITY_LOWEST 255
286 /**< Lowest priority expressed across eventdev subsystem
287 * @see rte_event_queue_setup(), rte_event_enqueue_burst()
288 * @see rte_event_port_link()
292 * Get the total number of event devices that have been successfully
296 * The total number of usable event devices.
299 rte_event_dev_count(void);
302 * Get the device identifier for the named event device.
305 * Event device name to select the event device identifier.
308 * Returns event device identifier on success.
309 * - <0: Failure to find named event device.
312 rte_event_dev_get_dev_id(const char *name);
315 * Return the NUMA socket to which a device is connected.
318 * The identifier of the device.
320 * The NUMA socket id to which the device is connected or
321 * a default of zero if the socket could not be determined.
322 * -(-EINVAL) dev_id value is out of range.
325 rte_event_dev_socket_id(uint8_t dev_id);
328 * Event device information
330 struct rte_event_dev_info {
331 const char *driver_name; /**< Event driver name */
332 struct rte_pci_device *pci_dev; /**< PCI information */
333 uint32_t min_dequeue_timeout_ns;
334 /**< Minimum supported global dequeue timeout(ns) by this device */
335 uint32_t max_dequeue_timeout_ns;
336 /**< Maximum supported global dequeue timeout(ns) by this device */
337 uint32_t dequeue_timeout_ns;
338 /**< Configured global dequeue timeout(ns) for this device */
339 uint8_t max_event_queues;
340 /**< Maximum event_queues supported by this device */
341 uint32_t max_event_queue_flows;
342 /**< Maximum supported flows in an event queue by this device*/
343 uint8_t max_event_queue_priority_levels;
344 /**< Maximum number of event queue priority levels by this device.
345 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability
347 uint8_t max_event_priority_levels;
348 /**< Maximum number of event priority levels by this device.
349 * Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability
351 uint8_t max_event_ports;
352 /**< Maximum number of event ports supported by this device */
353 uint8_t max_event_port_dequeue_depth;
354 /**< Maximum number of events can be dequeued at a time from an
355 * event port by this device.
356 * A device that does not support bulk dequeue will set this as 1.
358 uint32_t max_event_port_enqueue_depth;
359 /**< Maximum number of events can be enqueued at a time from an
360 * event port by this device.
361 * A device that does not support bulk enqueue will set this as 1.
363 int32_t max_num_events;
364 /**< A *closed system* event dev has a limit on the number of events it
365 * can manage at a time. An *open system* event dev does not have a
366 * limit and will specify this as -1.
368 uint32_t event_dev_cap;
369 /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
373 * Retrieve the contextual information of an event device.
376 * The identifier of the device.
378 * @param[out] dev_info
379 * A pointer to a structure of type *rte_event_dev_info* to be filled with the
380 * contextual information of the device.
383 * - 0: Success, driver updates the contextual information of the event device
384 * - <0: Error code returned by the driver info get function.
388 rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info);
390 /* Event device configuration bitmap flags */
391 #define RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT (1ULL << 0)
392 /**< Override the global *dequeue_timeout_ns* and use per dequeue timeout in ns.
393 * @see rte_event_dequeue_timeout_ticks(), rte_event_dequeue_burst()
396 /** Event device configuration structure */
397 struct rte_event_dev_config {
398 uint32_t dequeue_timeout_ns;
399 /**< rte_event_dequeue_burst() timeout on this device.
400 * This value should be in the range of *min_dequeue_timeout_ns* and
401 * *max_dequeue_timeout_ns* which previously provided in
402 * rte_event_dev_info_get()
403 * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
405 int32_t nb_events_limit;
406 /**< Applies to *closed system* event dev only. This field indicates a
407 * limit to ethdev-like devices to limit the number of events injected
408 * into the system to not overwhelm core-to-core events.
409 * This value cannot exceed the *max_num_events* which previously
410 * provided in rte_event_dev_info_get()
412 uint8_t nb_event_queues;
413 /**< Number of event queues to configure on this device.
414 * This value cannot exceed the *max_event_queues* which previously
415 * provided in rte_event_dev_info_get()
417 uint8_t nb_event_ports;
418 /**< Number of event ports to configure on this device.
419 * This value cannot exceed the *max_event_ports* which previously
420 * provided in rte_event_dev_info_get()
422 uint32_t nb_event_queue_flows;
423 /**< Number of flows for any event queue on this device.
424 * This value cannot exceed the *max_event_queue_flows* which previously
425 * provided in rte_event_dev_info_get()
427 uint8_t nb_event_port_dequeue_depth;
428 /**< Maximum number of events can be dequeued at a time from an
429 * event port by this device.
430 * This value cannot exceed the *max_event_port_dequeue_depth*
431 * which previously provided in rte_event_dev_info_get()
432 * @see rte_event_port_setup()
434 uint32_t nb_event_port_enqueue_depth;
435 /**< Maximum number of events can be enqueued at a time from an
436 * event port by this device.
437 * This value cannot exceed the *max_event_port_enqueue_depth*
438 * which previously provided in rte_event_dev_info_get()
439 * @see rte_event_port_setup()
441 uint32_t event_dev_cfg;
442 /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/
446 * Configure an event device.
448 * This function must be invoked first before any other function in the
449 * API. This function can also be re-invoked when a device is in the
452 * The caller may use rte_event_dev_info_get() to get the capability of each
453 * resources available for this event device.
456 * The identifier of the device to configure.
458 * The event device configuration structure.
461 * - 0: Success, device configured.
462 * - <0: Error code returned by the driver configuration function.
465 rte_event_dev_configure(uint8_t dev_id,
466 const struct rte_event_dev_config *dev_conf);
469 /* Event queue specific APIs */
471 /* Event queue configuration bitmap flags */
472 #define RTE_EVENT_QUEUE_CFG_DEFAULT (0)
473 /**< Default value of *event_queue_cfg* when rte_event_queue_setup() invoked
474 * with queue_conf == NULL
476 * @see rte_event_queue_setup()
478 #define RTE_EVENT_QUEUE_CFG_TYPE_MASK (3ULL << 0)
479 /**< Mask for event queue schedule type configuration request */
480 #define RTE_EVENT_QUEUE_CFG_ALL_TYPES (0ULL << 0)
481 /**< Allow ATOMIC,ORDERED,PARALLEL schedule type enqueue
483 * @see RTE_SCHED_TYPE_ORDERED, RTE_SCHED_TYPE_ATOMIC, RTE_SCHED_TYPE_PARALLEL
484 * @see rte_event_enqueue_burst()
486 #define RTE_EVENT_QUEUE_CFG_ATOMIC_ONLY (1ULL << 0)
487 /**< Allow only ATOMIC schedule type enqueue
489 * The rte_event_enqueue_burst() result is undefined if the queue configured
490 * with ATOMIC only and sched_type != RTE_SCHED_TYPE_ATOMIC
492 * @see RTE_SCHED_TYPE_ATOMIC, rte_event_enqueue_burst()
494 #define RTE_EVENT_QUEUE_CFG_ORDERED_ONLY (2ULL << 0)
495 /**< Allow only ORDERED schedule type enqueue
497 * The rte_event_enqueue_burst() result is undefined if the queue configured
498 * with ORDERED only and sched_type != RTE_SCHED_TYPE_ORDERED
500 * @see RTE_SCHED_TYPE_ORDERED, rte_event_enqueue_burst()
502 #define RTE_EVENT_QUEUE_CFG_PARALLEL_ONLY (3ULL << 0)
503 /**< Allow only PARALLEL schedule type enqueue
505 * The rte_event_enqueue_burst() result is undefined if the queue configured
506 * with PARALLEL only and sched_type != RTE_SCHED_TYPE_PARALLEL
508 * @see RTE_SCHED_TYPE_PARALLEL, rte_event_enqueue_burst()
510 #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK (1ULL << 2)
511 /**< This event queue links only to a single event port.
513 * @see rte_event_port_setup(), rte_event_port_link()
516 /** Event queue configuration structure */
517 struct rte_event_queue_conf {
518 uint32_t nb_atomic_flows;
519 /**< The maximum number of active flows this queue can track at any
520 * given time. The value must be in the range of
521 * [1 - nb_event_queue_flows)] which previously provided in
522 * rte_event_dev_info_get().
524 uint32_t nb_atomic_order_sequences;
525 /**< The maximum number of outstanding events waiting to be
526 * reordered by this queue. In other words, the number of entries in
527 * this queue’s reorder buffer.When the number of events in the
528 * reorder buffer reaches to *nb_atomic_order_sequences* then the
529 * scheduler cannot schedule the events from this queue and invalid
530 * event will be returned from dequeue until one or more entries are
532 * The value must be in the range of [1 - nb_event_queue_flows)]
533 * which previously supplied to rte_event_dev_configure().
535 uint32_t event_queue_cfg; /**< Queue cfg flags(EVENT_QUEUE_CFG_) */
537 /**< Priority for this event queue relative to other event queues.
538 * The requested priority should in the range of
539 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST].
540 * The implementation shall normalize the requested priority to
541 * event device supported priority value.
542 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability
547 * Retrieve the default configuration information of an event queue designated
548 * by its *queue_id* from the event driver for an event device.
550 * This function intended to be used in conjunction with rte_event_queue_setup()
551 * where caller needs to set up the queue by overriding few default values.
554 * The identifier of the device.
556 * The index of the event queue to get the configuration information.
557 * The value must be in the range [0, nb_event_queues - 1]
558 * previously supplied to rte_event_dev_configure().
559 * @param[out] queue_conf
560 * The pointer to the default event queue configuration data.
562 * - 0: Success, driver updates the default event queue configuration data.
563 * - <0: Error code returned by the driver info get function.
565 * @see rte_event_queue_setup()
569 rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id,
570 struct rte_event_queue_conf *queue_conf);
573 * Allocate and set up an event queue for an event device.
576 * The identifier of the device.
578 * The index of the event queue to setup. The value must be in the range
579 * [0, nb_event_queues - 1] previously supplied to rte_event_dev_configure().
581 * The pointer to the configuration data to be used for the event queue.
582 * NULL value is allowed, in which case default configuration used.
584 * @see rte_event_queue_default_conf_get()
587 * - 0: Success, event queue correctly set up.
588 * - <0: event queue configuration failed
591 rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id,
592 const struct rte_event_queue_conf *queue_conf);
595 * Get the number of event queues on a specific event device
598 * Event device identifier.
600 * - The number of configured event queues
603 rte_event_queue_count(uint8_t dev_id);
606 * Get the priority of the event queue on a specific event device
609 * Event device identifier.
611 * Event queue identifier.
613 * - If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then the
614 * configured priority of the event queue in
615 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST] range
616 * else the value RTE_EVENT_DEV_PRIORITY_NORMAL
619 rte_event_queue_priority(uint8_t dev_id, uint8_t queue_id);
621 /* Event port specific APIs */
623 /** Event port configuration structure */
624 struct rte_event_port_conf {
625 int32_t new_event_threshold;
626 /**< A backpressure threshold for new event enqueues on this port.
627 * Use for *closed system* event dev where event capacity is limited,
628 * and cannot exceed the capacity of the event dev.
629 * Configuring ports with different thresholds can make higher priority
630 * traffic less likely to be backpressured.
631 * For example, a port used to inject NIC Rx packets into the event dev
632 * can have a lower threshold so as not to overwhelm the device,
633 * while ports used for worker pools can have a higher threshold.
634 * This value cannot exceed the *nb_events_limit*
635 * which previously supplied to rte_event_dev_configure()
637 uint8_t dequeue_depth;
638 /**< Configure number of bulk dequeues for this event port.
639 * This value cannot exceed the *nb_event_port_dequeue_depth*
640 * which previously supplied to rte_event_dev_configure()
642 uint8_t enqueue_depth;
643 /**< Configure number of bulk enqueues for this event port.
644 * This value cannot exceed the *nb_event_port_enqueue_depth*
645 * which previously supplied to rte_event_dev_configure()
650 * Retrieve the default configuration information of an event port designated
651 * by its *port_id* from the event driver for an event device.
653 * This function intended to be used in conjunction with rte_event_port_setup()
654 * where caller needs to set up the port by overriding few default values.
657 * The identifier of the device.
659 * The index of the event port to get the configuration information.
660 * The value must be in the range [0, nb_event_ports - 1]
661 * previously supplied to rte_event_dev_configure().
662 * @param[out] port_conf
663 * The pointer to the default event port configuration data
665 * - 0: Success, driver updates the default event port configuration data.
666 * - <0: Error code returned by the driver info get function.
668 * @see rte_event_port_setup()
672 rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id,
673 struct rte_event_port_conf *port_conf);
676 * Allocate and set up an event port for an event device.
679 * The identifier of the device.
681 * The index of the event port to setup. The value must be in the range
682 * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure().
684 * The pointer to the configuration data to be used for the queue.
685 * NULL value is allowed, in which case default configuration used.
687 * @see rte_event_port_default_conf_get()
690 * - 0: Success, event port correctly set up.
691 * - <0: Port configuration failed
692 * - (-EDQUOT) Quota exceeded(Application tried to link the queue configured
693 * with RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports)
696 rte_event_port_setup(uint8_t dev_id, uint8_t port_id,
697 const struct rte_event_port_conf *port_conf);
700 * Get the number of dequeue queue depth configured for event port designated
701 * by its *port_id* on a specific event device
704 * Event device identifier.
706 * Event port identifier.
708 * - The number of configured dequeue queue depth
710 * @see rte_event_dequeue_burst()
713 rte_event_port_dequeue_depth(uint8_t dev_id, uint8_t port_id);
716 * Get the number of enqueue queue depth configured for event port designated
717 * by its *port_id* on a specific event device
720 * Event device identifier.
722 * Event port identifier.
724 * - The number of configured enqueue queue depth
726 * @see rte_event_enqueue_burst()
729 rte_event_port_enqueue_depth(uint8_t dev_id, uint8_t port_id);
732 * Get the number of ports on a specific event device
735 * Event device identifier.
737 * - The number of configured ports
740 rte_event_port_count(uint8_t dev_id);
743 * Start an event device.
745 * The device start step is the last one and consists of setting the event
746 * queues to start accepting the events and schedules to event ports.
748 * On success, all basic functions exported by the API (event enqueue,
749 * event dequeue and so on) can be invoked.
752 * Event device identifier
754 * - 0: Success, device started.
755 * - <0: Error code of the driver device start function.
758 rte_event_dev_start(uint8_t dev_id);
761 * Stop an event device. The device can be restarted with a call to
762 * rte_event_dev_start()
765 * Event device identifier.
768 rte_event_dev_stop(uint8_t dev_id);
771 * Close an event device. The device cannot be restarted!
774 * Event device identifier
777 * - 0 on successfully closing device
778 * - <0 on failure to close device
779 * - (-EAGAIN) if device is busy
782 rte_event_dev_close(uint8_t dev_id);
784 /* Scheduler type definitions */
785 #define RTE_SCHED_TYPE_ORDERED 0
786 /**< Ordered scheduling
788 * Events from an ordered flow of an event queue can be scheduled to multiple
789 * ports for concurrent processing while maintaining the original event order.
790 * This scheme enables the user to achieve high single flow throughput by
791 * avoiding SW synchronization for ordering between ports which bound to cores.
793 * The source flow ordering from an event queue is maintained when events are
794 * enqueued to their destination queue within the same ordered flow context.
795 * An event port holds the context until application call
796 * rte_event_dequeue_burst() from the same port, which implicitly releases
798 * User may allow the scheduler to release the context earlier than that
799 * by invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE operation.
801 * Events from the source queue appear in their original order when dequeued
802 * from a destination queue.
803 * Event ordering is based on the received event(s), but also other
804 * (newly allocated or stored) events are ordered when enqueued within the same
805 * ordered context. Events not enqueued (e.g. released or stored) within the
806 * context are considered missing from reordering and are skipped at this time
807 * (but can be ordered again within another context).
809 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE
812 #define RTE_SCHED_TYPE_ATOMIC 1
813 /**< Atomic scheduling
815 * Events from an atomic flow of an event queue can be scheduled only to a
816 * single port at a time. The port is guaranteed to have exclusive (atomic)
817 * access to the associated flow context, which enables the user to avoid SW
818 * synchronization. Atomic flows also help to maintain event ordering
819 * since only one port at a time can process events from a flow of an
822 * The atomic queue synchronization context is dedicated to the port until
823 * application call rte_event_dequeue_burst() from the same port,
824 * which implicitly releases the context. User may allow the scheduler to
825 * release the context earlier than that by invoking rte_event_enqueue_burst()
826 * with RTE_EVENT_OP_RELEASE operation.
828 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE
831 #define RTE_SCHED_TYPE_PARALLEL 2
832 /**< Parallel scheduling
834 * The scheduler performs priority scheduling, load balancing, etc. functions
835 * but does not provide additional event synchronization or ordering.
836 * It is free to schedule events from a single parallel flow of an event queue
837 * to multiple events ports for concurrent processing.
838 * The application is responsible for flow context synchronization and
839 * event ordering (SW synchronization).
841 * @see rte_event_queue_setup(), rte_event_dequeue_burst()
844 /* Event types to classify the event source */
845 #define RTE_EVENT_TYPE_ETHDEV 0x0
846 /**< The event generated from ethdev subsystem */
847 #define RTE_EVENT_TYPE_CRYPTODEV 0x1
848 /**< The event generated from crypodev subsystem */
849 #define RTE_EVENT_TYPE_TIMERDEV 0x2
850 /**< The event generated from timerdev subsystem */
851 #define RTE_EVENT_TYPE_CPU 0x3
852 /**< The event generated from cpu for pipelining.
853 * Application may use *sub_event_type* to further classify the event
855 #define RTE_EVENT_TYPE_MAX 0x10
856 /**< Maximum number of event types */
858 /* Event enqueue operations */
859 #define RTE_EVENT_OP_NEW 0
860 /**< The event producers use this operation to inject a new event to the
863 #define RTE_EVENT_OP_FORWARD 1
864 /**< The CPU use this operation to forward the event to different event queue or
865 * change to new application specific flow or schedule type to enable
868 #define RTE_EVENT_OP_RELEASE 2
869 /**< Release the flow context associated with the schedule type.
871 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ATOMIC*
872 * then this function hints the scheduler that the user has completed critical
873 * section processing in the current atomic context.
874 * The scheduler is now allowed to schedule events from the same flow from
875 * an event queue to another port. However, the context may be still held
876 * until the next rte_event_dequeue_burst() call, this call allows but does not
877 * force the scheduler to release the context early.
879 * Early atomic context release may increase parallelism and thus system
880 * performance, but the user needs to design carefully the split into critical
881 * vs non-critical sections.
883 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ORDERED*
884 * then this function hints the scheduler that the user has done all that need
885 * to maintain event order in the current ordered context.
886 * The scheduler is allowed to release the ordered context of this port and
887 * avoid reordering any following enqueues.
889 * Early ordered context release may increase parallelism and thus system
892 * If current flow's scheduler type method is *RTE_SCHED_TYPE_PARALLEL*
893 * or no scheduling context is held then this function may be an NOOP,
894 * depending on the implementation.
899 * The generic *rte_event* structure to hold the event attributes
900 * for dequeue and enqueue operation
907 /** Event attributes for dequeue or enqueue operation */
910 /**< Targeted flow identifier for the enqueue and
912 * The value must be in the range of
913 * [0, nb_event_queue_flows - 1] which
914 * previously supplied to rte_event_dev_configure().
916 uint32_t sub_event_type:8;
917 /**< Sub-event types based on the event source.
918 * @see RTE_EVENT_TYPE_CPU
920 uint32_t event_type:4;
921 /**< Event type to classify the event source.
922 * @see RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*)
925 /**< The type of event enqueue operation - new/forward/
926 * etc.This field is not preserved across an instance
927 * and is undefined on dequeue.
928 * @see RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*)
931 /**< Reserved for future use */
932 uint8_t sched_type:2;
933 /**< Scheduler synchronization type (RTE_SCHED_TYPE_*)
934 * associated with flow id on a given event queue
935 * for the enqueue and dequeue operation.
938 /**< Targeted event queue identifier for the enqueue or
940 * The value must be in the range of
941 * [0, nb_event_queues - 1] which previously supplied to
942 * rte_event_dev_configure().
945 /**< Event priority relative to other events in the
946 * event queue. The requested priority should in the
947 * range of [RTE_EVENT_DEV_PRIORITY_HIGHEST,
948 * RTE_EVENT_DEV_PRIORITY_LOWEST].
949 * The implementation shall normalize the requested
950 * priority to supported priority value.
951 * Valid when the device has
952 * RTE_EVENT_DEV_CAP_EVENT_QOS capability.
955 /**< Implementation specific opaque value.
956 * An implementation may use this field to hold
957 * implementation specific value to share between
958 * dequeue and enqueue operation.
959 * The application should not modify this field.
967 /**< Opaque 64-bit value */
969 /**< Opaque event pointer */
970 struct rte_mbuf *mbuf;
971 /**< mbuf pointer if dequeued event is associated with mbuf */
976 * Schedule one or more events in the event dev.
978 * An event dev implementation may define this is a NOOP, for instance if
979 * the event dev performs its scheduling in hardware.
982 * The identifier of the device.
985 rte_event_schedule(uint8_t dev_id);
988 * Enqueue a burst of events objects or an event object supplied in *rte_event*
989 * structure on an event device designated by its *dev_id* through the event
990 * port specified by *port_id*. Each event object specifies the event queue on
991 * which it will be enqueued.
993 * The *nb_events* parameter is the number of event objects to enqueue which are
994 * supplied in the *ev* array of *rte_event* structure.
996 * The rte_event_enqueue_burst() function returns the number of
997 * events objects it actually enqueued. A return value equal to *nb_events*
998 * means that all event objects have been enqueued.
1001 * The identifier of the device.
1003 * The identifier of the event port.
1005 * Points to an array of *nb_events* objects of type *rte_event* structure
1006 * which contain the event object enqueue operations to be processed.
1008 * The number of event objects to enqueue, typically number of
1009 * rte_event_port_enqueue_depth() available for this port.
1012 * The number of event objects actually enqueued on the event device. The
1013 * return value can be less than the value of the *nb_events* parameter when
1014 * the event devices queue is full or if invalid parameters are specified in a
1015 * *rte_event*. If return value is less than *nb_events*, the remaining events
1016 * at the end of ev[] are not consumed,and the caller has to take care of them
1018 * @see rte_event_port_enqueue_depth()
1021 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1022 const struct rte_event ev[], uint16_t nb_events);
1025 * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue_burst()
1027 * If the device is configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT flag
1028 * then application can use this function to convert timeout value in
1029 * nanoseconds to implementations specific timeout value supplied in
1030 * rte_event_dequeue_burst()
1033 * The identifier of the device.
1035 * Wait time in nanosecond
1036 * @param[out] timeout_ticks
1037 * Value for the *timeout_ticks* parameter in rte_event_dequeue_burst()
1043 * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
1044 * @see rte_event_dev_configure()
1048 rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
1049 uint64_t *timeout_ticks);
1052 * Dequeue a burst of events objects or an event object from the event port
1053 * designated by its *event_port_id*, on an event device designated
1056 * rte_event_dequeue_burst() does not dictate the specifics of scheduling
1057 * algorithm as each eventdev driver may have different criteria to schedule
1058 * an event. However, in general, from an application perspective scheduler may
1059 * use the following scheme to dispatch an event to the port.
1061 * 1) Selection of event queue based on
1062 * a) The list of event queues are linked to the event port.
1063 * b) If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then event
1064 * queue selection from list is based on event queue priority relative to
1065 * other event queue supplied as *priority* in rte_event_queue_setup()
1066 * c) If the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability then event
1067 * queue selection from the list is based on event priority supplied as
1068 * *priority* in rte_event_enqueue_burst()
1069 * 2) Selection of event
1070 * a) The number of flows available in selected event queue.
1071 * b) Schedule type method associated with the event
1073 * The *nb_events* parameter is the maximum number of event objects to dequeue
1074 * which are returned in the *ev* array of *rte_event* structure.
1076 * The rte_event_dequeue_burst() function returns the number of events objects
1077 * it actually dequeued. A return value equal to *nb_events* means that all
1078 * event objects have been dequeued.
1080 * The number of events dequeued is the number of scheduler contexts held by
1081 * this port. These contexts are automatically released in the next
1082 * rte_event_dequeue_burst() invocation, or invoking rte_event_enqueue_burst()
1083 * with RTE_EVENT_OP_RELEASE operation can be used to release the
1087 * The identifier of the device.
1089 * The identifier of the event port.
1091 * Points to an array of *nb_events* objects of type *rte_event* structure
1092 * for output to be populated with the dequeued event objects.
1094 * The maximum number of event objects to dequeue, typically number of
1095 * rte_event_port_dequeue_depth() available for this port.
1097 * @param timeout_ticks
1098 * - 0 no-wait, returns immediately if there is no event.
1099 * - >0 wait for the event, if the device is configured with
1100 * RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT then this function will wait until
1101 * the event available or *timeout_ticks* time.
1102 * if the device is not configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
1103 * then this function will wait until the event available or
1104 * *dequeue_timeout_ns* ns which was previously supplied to
1105 * rte_event_dev_configure()
1108 * The number of event objects actually dequeued from the port. The return
1109 * value can be less than the value of the *nb_events* parameter when the
1110 * event port's queue is not full.
1112 * @see rte_event_port_dequeue_depth()
1115 rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[],
1116 uint16_t nb_events, uint64_t timeout_ticks);
1119 * Link multiple source event queues supplied in *queues* to the destination
1120 * event port designated by its *port_id* with associated service priority
1121 * supplied in *priorities* on the event device designated by its *dev_id*.
1123 * The link establishment shall enable the event port *port_id* from
1124 * receiving events from the specified event queue(s) supplied in *queues*
1126 * An event queue may link to one or more event ports.
1127 * The number of links can be established from an event queue to event port is
1128 * implementation defined.
1130 * Event queue(s) to event port link establishment can be changed at runtime
1131 * without re-configuring the device to support scaling and to reduce the
1132 * latency of critical work by establishing the link with more event ports
1136 * The identifier of the device.
1139 * Event port identifier to select the destination port to link.
1142 * Points to an array of *nb_links* event queues to be linked
1143 * to the event port.
1144 * NULL value is allowed, in which case this function links all the configured
1145 * event queues *nb_event_queues* which previously supplied to
1146 * rte_event_dev_configure() to the event port *port_id*
1149 * Points to an array of *nb_links* service priorities associated with each
1150 * event queue link to event port.
1151 * The priority defines the event port's servicing priority for
1152 * event queue, which may be ignored by an implementation.
1153 * The requested priority should in the range of
1154 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST].
1155 * The implementation shall normalize the requested priority to
1156 * implementation supported priority value.
1157 * NULL value is allowed, in which case this function links the event queues
1158 * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority
1161 * The number of links to establish
1164 * The number of links actually established. The return value can be less than
1165 * the value of the *nb_links* parameter when the implementation has the
1166 * limitation on specific queue to port link establishment or if invalid
1167 * parameters are specified in *queues*
1168 * If the return value is less than *nb_links*, the remaining links at the end
1169 * of link[] are not established, and the caller has to take care of them.
1170 * If return value is less than *nb_links* then implementation shall update the
1171 * rte_errno accordingly, Possible rte_errno values are
1172 * (-EDQUOT) Quota exceeded(Application tried to link the queue configured with
1173 * RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports)
1174 * (-EINVAL) Invalid parameter
1178 rte_event_port_link(uint8_t dev_id, uint8_t port_id,
1179 const uint8_t queues[], const uint8_t priorities[],
1183 * Unlink multiple source event queues supplied in *queues* from the destination
1184 * event port designated by its *port_id* on the event device designated
1187 * The unlink establishment shall disable the event port *port_id* from
1188 * receiving events from the specified event queue *queue_id*
1190 * Event queue(s) to event port unlink establishment can be changed at runtime
1191 * without re-configuring the device.
1194 * The identifier of the device.
1197 * Event port identifier to select the destination port to unlink.
1200 * Points to an array of *nb_unlinks* event queues to be unlinked
1201 * from the event port.
1202 * NULL value is allowed, in which case this function unlinks all the
1203 * event queue(s) from the event port *port_id*.
1206 * The number of unlinks to establish
1209 * The number of unlinks actually established. The return value can be less
1210 * than the value of the *nb_unlinks* parameter when the implementation has the
1211 * limitation on specific queue to port unlink establishment or
1212 * if invalid parameters are specified.
1213 * If the return value is less than *nb_unlinks*, the remaining queues at the
1214 * end of queues[] are not established, and the caller has to take care of them.
1215 * If return value is less than *nb_unlinks* then implementation shall update
1216 * the rte_errno accordingly, Possible rte_errno values are
1217 * (-EINVAL) Invalid parameter
1221 rte_event_port_unlink(uint8_t dev_id, uint8_t port_id,
1222 uint8_t queues[], uint16_t nb_unlinks);
1225 * Retrieve the list of source event queues and its associated service priority
1226 * linked to the destination event port designated by its *port_id*
1227 * on the event device designated by its *dev_id*.
1230 * The identifier of the device.
1233 * Event port identifier.
1235 * @param[out] queues
1236 * Points to an array of *queues* for output.
1237 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to
1238 * store the event queue(s) linked with event port *port_id*
1240 * @param[out] priorities
1241 * Points to an array of *priorities* for output.
1242 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to
1243 * store the service priority associated with each event queue linked
1246 * The number of links established on the event port designated by its
1252 rte_event_port_links_get(uint8_t dev_id, uint8_t port_id,
1253 uint8_t queues[], uint8_t priorities[]);
1256 * Dump internal information about *dev_id* to the FILE* provided in *f*.
1259 * The identifier of the device.
1262 * A pointer to a file for output
1269 rte_event_dev_dump(uint8_t dev_id, FILE *f);
1275 #endif /* _RTE_EVENTDEV_H_ */