1aa01b5c4f5ba0ad98833e85f5ff0a63e07c80c5
[dpdk.git] / lib / librte_eventdev / rte_eventdev.h
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright 2016 Cavium, Inc.
5  *   Copyright 2016 Intel Corporation.
6  *   Copyright 2016 NXP.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
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
17  *       distribution.
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.
21  *
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.
33  */
34
35 #ifndef _RTE_EVENTDEV_H_
36 #define _RTE_EVENTDEV_H_
37
38 /**
39  * @file
40  *
41  * RTE Event Device API
42  *
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.
50  *
51  * The Event Device API is composed of two parts:
52  *
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.
56  *
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.
60  *
61  * Event device components:
62  *
63  *                     +-----------------+
64  *                     | +-------------+ |
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  *        +-------+    +-----------------+    |
75  *        +-------+                           |
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  *            |        | +-------------+ |                                |
98  *            |        | |    flow n   | |                                |
99  *            |        | +-------------+ |                                |
100  *            |        |  event queue n  |                                |
101  *            |        +-----------------+                                |
102  *            |                                                           |
103  *            +-----------------------------------------------------------+
104  *
105  * Event device: A hardware or software-based event scheduler.
106  *
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.
112  *
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.
116  *
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.
120  *
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.
128  *
129  * In all functions of the Event API, the Event device is
130  * designated by an integer >= 0 named the device identifier *dev_id*
131  *
132  * At the Event driver level, Event devices are represented by a generic
133  * data structure of type *rte_event_dev*.
134  *
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.
141  *
142  * The role of the device init function consists of resetting the hardware or
143  * software event driver implementations.
144  *
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
149  * freed.
150  *
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()
158  *
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.
162  *
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.
166  *
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.
173  *
174  * Finally, an application can close an Event device by invoking the
175  * rte_event_dev_close() function.
176  *
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
179  * identifier.
180  *
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
183  * *event_dev_ops*.
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.
187  *
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.
192  *
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.
197  *
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.
201  *
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
207  *
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.
214  *
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().
225  *
226  * An event driven worker thread has following typical workflow on fastpath:
227  * \code{.c}
228  *      while (1) {
229  *              rte_event_dequeue_burst(...);
230  *              (event processing)
231  *              rte_event_enqueue_burst(...);
232  *      }
233  * \endcode
234  *
235  */
236
237 #ifdef __cplusplus
238 extern "C" {
239 #endif
240
241 #include <rte_common.h>
242 #include <rte_memory.h>
243 #include <rte_errno.h>
244
245 struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */
246
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
250  *  each event queue.
251  *
252  *  @see rte_event_queue_setup()
253  */
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.
258  *
259  *  @see rte_event_enqueue_burst()
260  */
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().
267  *
268  * @see rte_event_schedule(), rte_event_dequeue_burst()
269  */
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.
274  *
275  * @see RTE_EVENT_QUEUE_CFG_* values
276  */
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.
282  *
283  * @see rte_event_dequeue_burst() rte_event_enqueue_burst()
284  */
285
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()
291  */
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()
296  */
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()
301  */
302
303 /**
304  * Get the total number of event devices that have been successfully
305  * initialised.
306  *
307  * @return
308  *   The total number of usable event devices.
309  */
310 uint8_t
311 rte_event_dev_count(void);
312
313 /**
314  * Get the device identifier for the named event device.
315  *
316  * @param name
317  *   Event device name to select the event device identifier.
318  *
319  * @return
320  *   Returns event device identifier on success.
321  *   - <0: Failure to find named event device.
322  */
323 int
324 rte_event_dev_get_dev_id(const char *name);
325
326 /**
327  * Return the NUMA socket to which a device is connected.
328  *
329  * @param dev_id
330  *   The identifier of the device.
331  * @return
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.
335  */
336 int
337 rte_event_dev_socket_id(uint8_t dev_id);
338
339 /**
340  * Event device information
341  */
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
358          */
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
362          */
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.
369          */
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.
374          */
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.
379          */
380         uint32_t event_dev_cap;
381         /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
382 };
383
384 /**
385  * Retrieve the contextual information of an event device.
386  *
387  * @param dev_id
388  *   The identifier of the device.
389  *
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.
393  *
394  * @return
395  *   - 0: Success, driver updates the contextual information of the event device
396  *   - <0: Error code returned by the driver info get function.
397  *
398  */
399 int
400 rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info);
401
402 /**
403  * The count of ports.
404  */
405 #define RTE_EVENT_DEV_ATTR_PORT_COUNT 0
406 /**
407  * The count of queues.
408  */
409 #define RTE_EVENT_DEV_ATTR_QUEUE_COUNT 1
410 /**
411  * The status of the device, zero for stopped, non-zero for started.
412  */
413 #define RTE_EVENT_DEV_ATTR_STARTED 2
414
415 /**
416  * Get an attribute from a device.
417  *
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.
422  *
423  * @retval 0 Successfully retrieved attribute value
424  *         -EINVAL Invalid device or  *attr_id* provided, or *attr_value*
425  *         is NULL
426  */
427 int
428 rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id,
429                        uint32_t *attr_value);
430
431
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()
436  */
437
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
447          */
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*.
455          */
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()
460          */
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()
465          */
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()
470          */
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()
478          */
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()
486          */
487         uint32_t event_dev_cfg;
488         /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/
489 };
490
491 /**
492  * Configure an event device.
493  *
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
496  * stopped state.
497  *
498  * The caller may use rte_event_dev_info_get() to get the capability of each
499  * resources available for this event device.
500  *
501  * @param dev_id
502  *   The identifier of the device to configure.
503  * @param dev_conf
504  *   The event device configuration structure.
505  *
506  * @return
507  *   - 0: Success, device configured.
508  *   - <0: Error code returned by the driver configuration function.
509  */
510 int
511 rte_event_dev_configure(uint8_t dev_id,
512                         const struct rte_event_dev_config *dev_conf);
513
514
515 /* Event queue specific APIs */
516
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
522  *
523  * @see RTE_SCHED_TYPE_ORDERED, RTE_SCHED_TYPE_ATOMIC, RTE_SCHED_TYPE_PARALLEL
524  * @see rte_event_enqueue_burst()
525  */
526 #define RTE_EVENT_QUEUE_CFG_ATOMIC_ONLY        (1ULL << 0)
527 /**< Allow only ATOMIC schedule type enqueue
528  *
529  * The rte_event_enqueue_burst() result is undefined if the queue configured
530  * with ATOMIC only and sched_type != RTE_SCHED_TYPE_ATOMIC
531  *
532  * @see RTE_SCHED_TYPE_ATOMIC, rte_event_enqueue_burst()
533  */
534 #define RTE_EVENT_QUEUE_CFG_ORDERED_ONLY       (2ULL << 0)
535 /**< Allow only ORDERED schedule type enqueue
536  *
537  * The rte_event_enqueue_burst() result is undefined if the queue configured
538  * with ORDERED only and sched_type != RTE_SCHED_TYPE_ORDERED
539  *
540  * @see RTE_SCHED_TYPE_ORDERED, rte_event_enqueue_burst()
541  */
542 #define RTE_EVENT_QUEUE_CFG_PARALLEL_ONLY      (3ULL << 0)
543 /**< Allow only PARALLEL schedule type enqueue
544  *
545  * The rte_event_enqueue_burst() result is undefined if the queue configured
546  * with PARALLEL only and sched_type != RTE_SCHED_TYPE_PARALLEL
547  *
548  * @see RTE_SCHED_TYPE_PARALLEL, rte_event_enqueue_burst()
549  */
550 #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK        (1ULL << 2)
551 /**< This event queue links only to a single event port.
552  *
553  *  @see rte_event_port_setup(), rte_event_port_link()
554  */
555
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().
565          */
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
573          * freed up/released.
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().
579          */
580         uint32_t event_queue_cfg; /**< Queue cfg flags(EVENT_QUEUE_CFG_) */
581         uint8_t priority;
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
588          */
589 };
590
591 /**
592  * Retrieve the default configuration information of an event queue designated
593  * by its *queue_id* from the event driver for an event device.
594  *
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.
597  *
598  * @param dev_id
599  *   The identifier of the device.
600  * @param queue_id
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.
606  * @return
607  *   - 0: Success, driver updates the default event queue configuration data.
608  *   - <0: Error code returned by the driver info get function.
609  *
610  * @see rte_event_queue_setup()
611  *
612  */
613 int
614 rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id,
615                                  struct rte_event_queue_conf *queue_conf);
616
617 /**
618  * Allocate and set up an event queue for an event device.
619  *
620  * @param dev_id
621  *   The identifier of the device.
622  * @param queue_id
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().
625  * @param queue_conf
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.
628  *
629  * @see rte_event_queue_default_conf_get()
630  *
631  * @return
632  *   - 0: Success, event queue correctly set up.
633  *   - <0: event queue configuration failed
634  */
635 int
636 rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id,
637                       const struct rte_event_queue_conf *queue_conf);
638
639 /**
640  * The priority of the queue.
641  */
642 #define RTE_EVENT_QUEUE_ATTR_PRIORITY 0
643 /**
644  * The number of atomic flows configured for the queue.
645  */
646 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_FLOWS 1
647 /**
648  * The number of atomic order sequences configured for the queue.
649  */
650 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_ORDER_SEQUENCES 2
651 /**
652  * The cfg flags for the queue.
653  */
654 #define RTE_EVENT_QUEUE_ATTR_EVENT_QUEUE_CFG 3
655
656 /**
657  * Get an attribute from a queue.
658  *
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
664  *
665  * @retval 0 Successfully returned value
666  *         -EINVAL invalid device, queue or attr_id provided, or attr_value
667  *         was NULL
668  */
669 int
670 rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id,
671                         uint32_t *attr_value);
672
673 /* Event port specific APIs */
674
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*.
689          */
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.
695          */
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.
701          */
702 };
703
704 /**
705  * Retrieve the default configuration information of an event port designated
706  * by its *port_id* from the event driver for an event device.
707  *
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.
710  *
711  * @param dev_id
712  *   The identifier of the device.
713  * @param port_id
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
719  * @return
720  *   - 0: Success, driver updates the default event port configuration data.
721  *   - <0: Error code returned by the driver info get function.
722  *
723  * @see rte_event_port_setup()
724  *
725  */
726 int
727 rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id,
728                                 struct rte_event_port_conf *port_conf);
729
730 /**
731  * Allocate and set up an event port for an event device.
732  *
733  * @param dev_id
734  *   The identifier of the device.
735  * @param port_id
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().
738  * @param port_conf
739  *   The pointer to the configuration data to be used for the queue.
740  *   NULL value is allowed, in which case default configuration used.
741  *
742  * @see rte_event_port_default_conf_get()
743  *
744  * @return
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)
749  */
750 int
751 rte_event_port_setup(uint8_t dev_id, uint8_t port_id,
752                      const struct rte_event_port_conf *port_conf);
753
754 /**
755  * The queue depth of the port on the enqueue side
756  */
757 #define RTE_EVENT_PORT_ATTR_ENQ_DEPTH 0
758 /**
759  * The queue depth of the port on the dequeue side
760  */
761 #define RTE_EVENT_PORT_ATTR_DEQ_DEPTH 1
762 /**
763  * The new event threshold of the port
764  */
765 #define RTE_EVENT_PORT_ATTR_NEW_EVENT_THRESHOLD 2
766
767 /**
768  * Get an attribute from a port.
769  *
770  * @param dev_id Eventdev id
771  * @param port_id Eventdev port id
772  * @param attr_id The attribute ID to retrieve
773  * @param[out] attr_value A pointer that will be filled in with the attribute
774  *             value if successful
775  *
776  * @retval 0 Successfully returned value
777  *         -EINVAL Invalid device, port or attr_id, or attr_value was NULL
778  */
779 int
780 rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id,
781                         uint32_t *attr_value);
782
783 /**
784  * Start an event device.
785  *
786  * The device start step is the last one and consists of setting the event
787  * queues to start accepting the events and schedules to event ports.
788  *
789  * On success, all basic functions exported by the API (event enqueue,
790  * event dequeue and so on) can be invoked.
791  *
792  * @param dev_id
793  *   Event device identifier
794  * @return
795  *   - 0: Success, device started.
796  *   - -ESTALE : Not all ports of the device are configured
797  *   - -ENOLINK: Not all queues are linked, which could lead to deadlock.
798  */
799 int
800 rte_event_dev_start(uint8_t dev_id);
801
802 /**
803  * Stop an event device. The device can be restarted with a call to
804  * rte_event_dev_start()
805  *
806  * @param dev_id
807  *   Event device identifier.
808  */
809 void
810 rte_event_dev_stop(uint8_t dev_id);
811
812 /**
813  * Close an event device. The device cannot be restarted!
814  *
815  * @param dev_id
816  *   Event device identifier
817  *
818  * @return
819  *  - 0 on successfully closing device
820  *  - <0 on failure to close device
821  *  - (-EAGAIN) if device is busy
822  */
823 int
824 rte_event_dev_close(uint8_t dev_id);
825
826 /* Scheduler type definitions */
827 #define RTE_SCHED_TYPE_ORDERED          0
828 /**< Ordered scheduling
829  *
830  * Events from an ordered flow of an event queue can be scheduled to multiple
831  * ports for concurrent processing while maintaining the original event order.
832  * This scheme enables the user to achieve high single flow throughput by
833  * avoiding SW synchronization for ordering between ports which bound to cores.
834  *
835  * The source flow ordering from an event queue is maintained when events are
836  * enqueued to their destination queue within the same ordered flow context.
837  * An event port holds the context until application call
838  * rte_event_dequeue_burst() from the same port, which implicitly releases
839  * the context.
840  * User may allow the scheduler to release the context earlier than that
841  * by invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE operation.
842  *
843  * Events from the source queue appear in their original order when dequeued
844  * from a destination queue.
845  * Event ordering is based on the received event(s), but also other
846  * (newly allocated or stored) events are ordered when enqueued within the same
847  * ordered context. Events not enqueued (e.g. released or stored) within the
848  * context are  considered missing from reordering and are skipped at this time
849  * (but can be ordered again within another context).
850  *
851  * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE
852  */
853
854 #define RTE_SCHED_TYPE_ATOMIC           1
855 /**< Atomic scheduling
856  *
857  * Events from an atomic flow of an event queue can be scheduled only to a
858  * single port at a time. The port is guaranteed to have exclusive (atomic)
859  * access to the associated flow context, which enables the user to avoid SW
860  * synchronization. Atomic flows also help to maintain event ordering
861  * since only one port at a time can process events from a flow of an
862  * event queue.
863  *
864  * The atomic queue synchronization context is dedicated to the port until
865  * application call rte_event_dequeue_burst() from the same port,
866  * which implicitly releases the context. User may allow the scheduler to
867  * release the context earlier than that by invoking rte_event_enqueue_burst()
868  * with RTE_EVENT_OP_RELEASE operation.
869  *
870  * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE
871  */
872
873 #define RTE_SCHED_TYPE_PARALLEL         2
874 /**< Parallel scheduling
875  *
876  * The scheduler performs priority scheduling, load balancing, etc. functions
877  * but does not provide additional event synchronization or ordering.
878  * It is free to schedule events from a single parallel flow of an event queue
879  * to multiple events ports for concurrent processing.
880  * The application is responsible for flow context synchronization and
881  * event ordering (SW synchronization).
882  *
883  * @see rte_event_queue_setup(), rte_event_dequeue_burst()
884  */
885
886 /* Event types to classify the event source */
887 #define RTE_EVENT_TYPE_ETHDEV           0x0
888 /**< The event generated from ethdev subsystem */
889 #define RTE_EVENT_TYPE_CRYPTODEV        0x1
890 /**< The event generated from crypodev subsystem */
891 #define RTE_EVENT_TYPE_TIMERDEV         0x2
892 /**< The event generated from timerdev subsystem */
893 #define RTE_EVENT_TYPE_CPU              0x3
894 /**< The event generated from cpu for pipelining.
895  * Application may use *sub_event_type* to further classify the event
896  */
897 #define RTE_EVENT_TYPE_MAX              0x10
898 /**< Maximum number of event types */
899
900 /* Event enqueue operations */
901 #define RTE_EVENT_OP_NEW                0
902 /**< The event producers use this operation to inject a new event to the
903  * event device.
904  */
905 #define RTE_EVENT_OP_FORWARD            1
906 /**< The CPU use this operation to forward the event to different event queue or
907  * change to new application specific flow or schedule type to enable
908  * pipelining.
909  *
910  * This operation must only be enqueued to the same port that the
911  * event to be forwarded was dequeued from.
912  */
913 #define RTE_EVENT_OP_RELEASE            2
914 /**< Release the flow context associated with the schedule type.
915  *
916  * If current flow's scheduler type method is *RTE_SCHED_TYPE_ATOMIC*
917  * then this function hints the scheduler that the user has completed critical
918  * section processing in the current atomic context.
919  * The scheduler is now allowed to schedule events from the same flow from
920  * an event queue to another port. However, the context may be still held
921  * until the next rte_event_dequeue_burst() call, this call allows but does not
922  * force the scheduler to release the context early.
923  *
924  * Early atomic context release may increase parallelism and thus system
925  * performance, but the user needs to design carefully the split into critical
926  * vs non-critical sections.
927  *
928  * If current flow's scheduler type method is *RTE_SCHED_TYPE_ORDERED*
929  * then this function hints the scheduler that the user has done all that need
930  * to maintain event order in the current ordered context.
931  * The scheduler is allowed to release the ordered context of this port and
932  * avoid reordering any following enqueues.
933  *
934  * Early ordered context release may increase parallelism and thus system
935  * performance.
936  *
937  * If current flow's scheduler type method is *RTE_SCHED_TYPE_PARALLEL*
938  * or no scheduling context is held then this function may be an NOOP,
939  * depending on the implementation.
940  *
941  * This operation must only be enqueued to the same port that the
942  * event to be released was dequeued from.
943  *
944  */
945
946 /**
947  * The generic *rte_event* structure to hold the event attributes
948  * for dequeue and enqueue operation
949  */
950 RTE_STD_C11
951 struct rte_event {
952         /** WORD0 */
953         union {
954                 uint64_t event;
955                 /** Event attributes for dequeue or enqueue operation */
956                 struct {
957                         uint32_t flow_id:20;
958                         /**< Targeted flow identifier for the enqueue and
959                          * dequeue operation.
960                          * The value must be in the range of
961                          * [0, nb_event_queue_flows - 1] which
962                          * previously supplied to rte_event_dev_configure().
963                          */
964                         uint32_t sub_event_type:8;
965                         /**< Sub-event types based on the event source.
966                          * @see RTE_EVENT_TYPE_CPU
967                          */
968                         uint32_t event_type:4;
969                         /**< Event type to classify the event source.
970                          * @see RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*)
971                          */
972                         uint8_t op:2;
973                         /**< The type of event enqueue operation - new/forward/
974                          * etc.This field is not preserved across an instance
975                          * and is undefined on dequeue.
976                          * @see RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*)
977                          */
978                         uint8_t rsvd:4;
979                         /**< Reserved for future use */
980                         uint8_t sched_type:2;
981                         /**< Scheduler synchronization type (RTE_SCHED_TYPE_*)
982                          * associated with flow id on a given event queue
983                          * for the enqueue and dequeue operation.
984                          */
985                         uint8_t queue_id;
986                         /**< Targeted event queue identifier for the enqueue or
987                          * dequeue operation.
988                          * The value must be in the range of
989                          * [0, nb_event_queues - 1] which previously supplied to
990                          * rte_event_dev_configure().
991                          */
992                         uint8_t priority;
993                         /**< Event priority relative to other events in the
994                          * event queue. The requested priority should in the
995                          * range of  [RTE_EVENT_DEV_PRIORITY_HIGHEST,
996                          * RTE_EVENT_DEV_PRIORITY_LOWEST].
997                          * The implementation shall normalize the requested
998                          * priority to supported priority value.
999                          * Valid when the device has
1000                          * RTE_EVENT_DEV_CAP_EVENT_QOS capability.
1001                          */
1002                         uint8_t impl_opaque;
1003                         /**< Implementation specific opaque value.
1004                          * An implementation may use this field to hold
1005                          * implementation specific value to share between
1006                          * dequeue and enqueue operation.
1007                          * The application should not modify this field.
1008                          */
1009                 };
1010         };
1011         /** WORD1 */
1012         union {
1013                 uint64_t u64;
1014                 /**< Opaque 64-bit value */
1015                 void *event_ptr;
1016                 /**< Opaque event pointer */
1017                 struct rte_mbuf *mbuf;
1018                 /**< mbuf pointer if dequeued event is associated with mbuf */
1019         };
1020 };
1021
1022 /* Ethdev Rx adapter capability bitmap flags */
1023 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT      0x1
1024 /**< This flag is sent when the packet transfer mechanism is in HW.
1025  * Ethdev can send packets to the event device using internal event port.
1026  */
1027 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ       0x2
1028 /**< Adapter supports multiple event queues per ethdev. Every ethdev
1029  * Rx queue can be connected to a unique event queue.
1030  */
1031 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID   0x4
1032 /**< The application can override the adapter generated flow ID in the
1033  * event. This flow ID can be specified when adding an ethdev Rx queue
1034  * to the adapter using the ev member of struct rte_event_eth_rx_adapter
1035  * @see struct rte_event_eth_rx_adapter_queue_conf::ev
1036  * @see struct rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
1037  */
1038
1039 /**
1040  * Retrieve the event device's ethdev Rx adapter capabilities for the
1041  * specified ethernet port
1042  *
1043  * @param dev_id
1044  *   The identifier of the device.
1045  *
1046  * @param eth_port_id
1047  *   The identifier of the ethernet device.
1048  *
1049  * @param[out] caps
1050  *   A pointer to memory filled with Rx event adapter capabilities.
1051  *
1052  * @return
1053  *   - 0: Success, driver provides Rx event adapter capabilities for the
1054  *      ethernet device.
1055  *   - <0: Error code returned by the driver function.
1056  *
1057  */
1058 int
1059 rte_event_eth_rx_adapter_caps_get(uint8_t dev_id, uint8_t eth_port_id,
1060                                 uint32_t *caps);
1061
1062 struct rte_eventdev_driver;
1063 struct rte_eventdev_ops;
1064 struct rte_eventdev;
1065
1066 typedef void (*event_schedule_t)(struct rte_eventdev *dev);
1067 /**< @internal Schedule one or more events in the event dev. */
1068
1069 typedef uint16_t (*event_enqueue_t)(void *port, const struct rte_event *ev);
1070 /**< @internal Enqueue event on port of a device */
1071
1072 typedef uint16_t (*event_enqueue_burst_t)(void *port,
1073                         const struct rte_event ev[], uint16_t nb_events);
1074 /**< @internal Enqueue burst of events on port of a device */
1075
1076 typedef uint16_t (*event_dequeue_t)(void *port, struct rte_event *ev,
1077                 uint64_t timeout_ticks);
1078 /**< @internal Dequeue event from port of a device */
1079
1080 typedef uint16_t (*event_dequeue_burst_t)(void *port, struct rte_event ev[],
1081                 uint16_t nb_events, uint64_t timeout_ticks);
1082 /**< @internal Dequeue burst of events from port of a device */
1083
1084 #define RTE_EVENTDEV_NAME_MAX_LEN       (64)
1085 /**< @internal Max length of name of event PMD */
1086
1087 /**
1088  * @internal
1089  * The data part, with no function pointers, associated with each device.
1090  *
1091  * This structure is safe to place in shared memory to be common among
1092  * different processes in a multi-process configuration.
1093  */
1094 struct rte_eventdev_data {
1095         int socket_id;
1096         /**< Socket ID where memory is allocated */
1097         uint8_t dev_id;
1098         /**< Device ID for this instance */
1099         uint8_t nb_queues;
1100         /**< Number of event queues. */
1101         uint8_t nb_ports;
1102         /**< Number of event ports. */
1103         void **ports;
1104         /**< Array of pointers to ports. */
1105         struct rte_event_port_conf *ports_cfg;
1106         /**< Array of port configuration structures. */
1107         struct rte_event_queue_conf *queues_cfg;
1108         /**< Array of queue configuration structures. */
1109         uint16_t *links_map;
1110         /**< Memory to store queues to port connections. */
1111         void *dev_private;
1112         /**< PMD-specific private data */
1113         uint32_t event_dev_cap;
1114         /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/
1115         struct rte_event_dev_config dev_conf;
1116         /**< Configuration applied to device. */
1117
1118         RTE_STD_C11
1119         uint8_t dev_started : 1;
1120         /**< Device state: STARTED(1)/STOPPED(0) */
1121
1122         char name[RTE_EVENTDEV_NAME_MAX_LEN];
1123         /**< Unique identifier name */
1124 } __rte_cache_aligned;
1125
1126 /** @internal The data structure associated with each event device. */
1127 struct rte_eventdev {
1128         event_schedule_t schedule;
1129         /**< Pointer to PMD schedule function. */
1130         event_enqueue_t enqueue;
1131         /**< Pointer to PMD enqueue function. */
1132         event_enqueue_burst_t enqueue_burst;
1133         /**< Pointer to PMD enqueue burst function. */
1134         event_enqueue_burst_t enqueue_new_burst;
1135         /**< Pointer to PMD enqueue burst function(op new variant) */
1136         event_enqueue_burst_t enqueue_forward_burst;
1137         /**< Pointer to PMD enqueue burst function(op forward variant) */
1138         event_dequeue_t dequeue;
1139         /**< Pointer to PMD dequeue function. */
1140         event_dequeue_burst_t dequeue_burst;
1141         /**< Pointer to PMD dequeue burst function. */
1142
1143         struct rte_eventdev_data *data;
1144         /**< Pointer to device data */
1145         const struct rte_eventdev_ops *dev_ops;
1146         /**< Functions exported by PMD */
1147         struct rte_device *dev;
1148         /**< Device info. supplied by probing */
1149
1150         RTE_STD_C11
1151         uint8_t attached : 1;
1152         /**< Flag indicating the device is attached */
1153 } __rte_cache_aligned;
1154
1155 extern struct rte_eventdev *rte_eventdevs;
1156 /** @internal The pool of rte_eventdev structures. */
1157
1158
1159 /**
1160  * Schedule one or more events in the event dev.
1161  *
1162  * An event dev implementation may define this is a NOOP, for instance if
1163  * the event dev performs its scheduling in hardware.
1164  *
1165  * @param dev_id
1166  *   The identifier of the device.
1167  */
1168 static inline void
1169 rte_event_schedule(uint8_t dev_id)
1170 {
1171         struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1172         if (*dev->schedule)
1173                 (*dev->schedule)(dev);
1174 }
1175
1176 static __rte_always_inline uint16_t
1177 __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1178                         const struct rte_event ev[], uint16_t nb_events,
1179                         const event_enqueue_burst_t fn)
1180 {
1181         const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1182
1183 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
1184         if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) {
1185                 rte_errno = -EINVAL;
1186                 return 0;
1187         }
1188
1189         if (port_id >= dev->data->nb_ports) {
1190                 rte_errno = -EINVAL;
1191                 return 0;
1192         }
1193 #endif
1194         /*
1195          * Allow zero cost non burst mode routine invocation if application
1196          * requests nb_events as const one
1197          */
1198         if (nb_events == 1)
1199                 return (*dev->enqueue)(dev->data->ports[port_id], ev);
1200         else
1201                 return fn(dev->data->ports[port_id], ev, nb_events);
1202 }
1203
1204 /**
1205  * Enqueue a burst of events objects or an event object supplied in *rte_event*
1206  * structure on an  event device designated by its *dev_id* through the event
1207  * port specified by *port_id*. Each event object specifies the event queue on
1208  * which it will be enqueued.
1209  *
1210  * The *nb_events* parameter is the number of event objects to enqueue which are
1211  * supplied in the *ev* array of *rte_event* structure.
1212  *
1213  * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
1214  * enqueued to the same port that their associated events were dequeued from.
1215  *
1216  * The rte_event_enqueue_burst() function returns the number of
1217  * events objects it actually enqueued. A return value equal to *nb_events*
1218  * means that all event objects have been enqueued.
1219  *
1220  * @param dev_id
1221  *   The identifier of the device.
1222  * @param port_id
1223  *   The identifier of the event port.
1224  * @param ev
1225  *   Points to an array of *nb_events* objects of type *rte_event* structure
1226  *   which contain the event object enqueue operations to be processed.
1227  * @param nb_events
1228  *   The number of event objects to enqueue, typically number of
1229  *   rte_event_port_enqueue_depth() available for this port.
1230  *
1231  * @return
1232  *   The number of event objects actually enqueued on the event device. The
1233  *   return value can be less than the value of the *nb_events* parameter when
1234  *   the event devices queue is full or if invalid parameters are specified in a
1235  *   *rte_event*. If the return value is less than *nb_events*, the remaining
1236  *   events at the end of ev[] are not consumed and the caller has to take care
1237  *   of them, and rte_errno is set accordingly. Possible errno values include:
1238  *   - -EINVAL  The port ID is invalid, device ID is invalid, an event's queue
1239  *              ID is invalid, or an event's sched type doesn't match the
1240  *              capabilities of the destination queue.
1241  *   - -ENOSPC  The event port was backpressured and unable to enqueue
1242  *              one or more events. This error code is only applicable to
1243  *              closed systems.
1244  * @see rte_event_port_enqueue_depth()
1245  */
1246 static inline uint16_t
1247 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
1248                         const struct rte_event ev[], uint16_t nb_events)
1249 {
1250         const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1251
1252         return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1253                         dev->enqueue_burst);
1254 }
1255
1256 /**
1257  * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_NEW* on
1258  * an event device designated by its *dev_id* through the event port specified
1259  * by *port_id*.
1260  *
1261  * Provides the same functionality as rte_event_enqueue_burst(), expect that
1262  * application can use this API when the all objects in the burst contains
1263  * the enqueue operation of the type *RTE_EVENT_OP_NEW*. This specialized
1264  * function can provide the additional hint to the PMD and optimize if possible.
1265  *
1266  * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst
1267  * has event object of operation type != RTE_EVENT_OP_NEW.
1268  *
1269  * @param dev_id
1270  *   The identifier of the device.
1271  * @param port_id
1272  *   The identifier of the event port.
1273  * @param ev
1274  *   Points to an array of *nb_events* objects of type *rte_event* structure
1275  *   which contain the event object enqueue operations to be processed.
1276  * @param nb_events
1277  *   The number of event objects to enqueue, typically number of
1278  *   rte_event_port_enqueue_depth() available for this port.
1279  *
1280  * @return
1281  *   The number of event objects actually enqueued on the event device. The
1282  *   return value can be less than the value of the *nb_events* parameter when
1283  *   the event devices queue is full or if invalid parameters are specified in a
1284  *   *rte_event*. If the return value is less than *nb_events*, the remaining
1285  *   events at the end of ev[] are not consumed and the caller has to take care
1286  *   of them, and rte_errno is set accordingly. Possible errno values include:
1287  *   - -EINVAL  The port ID is invalid, device ID is invalid, an event's queue
1288  *              ID is invalid, or an event's sched type doesn't match the
1289  *              capabilities of the destination queue.
1290  *   - -ENOSPC  The event port was backpressured and unable to enqueue
1291  *              one or more events. This error code is only applicable to
1292  *              closed systems.
1293  * @see rte_event_port_enqueue_depth() rte_event_enqueue_burst()
1294  */
1295 static inline uint16_t
1296 rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id,
1297                         const struct rte_event ev[], uint16_t nb_events)
1298 {
1299         const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1300
1301         return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1302                         dev->enqueue_new_burst);
1303 }
1304
1305 /**
1306  * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_FORWARD*
1307  * on an event device designated by its *dev_id* through the event port
1308  * specified by *port_id*.
1309  *
1310  * Provides the same functionality as rte_event_enqueue_burst(), expect that
1311  * application can use this API when the all objects in the burst contains
1312  * the enqueue operation of the type *RTE_EVENT_OP_FORWARD*. This specialized
1313  * function can provide the additional hint to the PMD and optimize if possible.
1314  *
1315  * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst
1316  * has event object of operation type != RTE_EVENT_OP_FORWARD.
1317  *
1318  * @param dev_id
1319  *   The identifier of the device.
1320  * @param port_id
1321  *   The identifier of the event port.
1322  * @param ev
1323  *   Points to an array of *nb_events* objects of type *rte_event* structure
1324  *   which contain the event object enqueue operations to be processed.
1325  * @param nb_events
1326  *   The number of event objects to enqueue, typically number of
1327  *   rte_event_port_enqueue_depth() available for this port.
1328  *
1329  * @return
1330  *   The number of event objects actually enqueued on the event device. The
1331  *   return value can be less than the value of the *nb_events* parameter when
1332  *   the event devices queue is full or if invalid parameters are specified in a
1333  *   *rte_event*. If the return value is less than *nb_events*, the remaining
1334  *   events at the end of ev[] are not consumed and the caller has to take care
1335  *   of them, and rte_errno is set accordingly. Possible errno values include:
1336  *   - -EINVAL  The port ID is invalid, device ID is invalid, an event's queue
1337  *              ID is invalid, or an event's sched type doesn't match the
1338  *              capabilities of the destination queue.
1339  *   - -ENOSPC  The event port was backpressured and unable to enqueue
1340  *              one or more events. This error code is only applicable to
1341  *              closed systems.
1342  * @see rte_event_port_enqueue_depth() rte_event_enqueue_burst()
1343  */
1344 static inline uint16_t
1345 rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id,
1346                         const struct rte_event ev[], uint16_t nb_events)
1347 {
1348         const struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1349
1350         return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events,
1351                         dev->enqueue_forward_burst);
1352 }
1353
1354 /**
1355  * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue_burst()
1356  *
1357  * If the device is configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT flag
1358  * then application can use this function to convert timeout value in
1359  * nanoseconds to implementations specific timeout value supplied in
1360  * rte_event_dequeue_burst()
1361  *
1362  * @param dev_id
1363  *   The identifier of the device.
1364  * @param ns
1365  *   Wait time in nanosecond
1366  * @param[out] timeout_ticks
1367  *   Value for the *timeout_ticks* parameter in rte_event_dequeue_burst()
1368  *
1369  * @return
1370  *  - 0 on success.
1371  *  - -ENOTSUP if the device doesn't support timeouts
1372  *  - -EINVAL if *dev_id* is invalid or *timeout_ticks* is NULL
1373  *  - other values < 0 on failure.
1374  *
1375  * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
1376  * @see rte_event_dev_configure()
1377  *
1378  */
1379 int
1380 rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
1381                                         uint64_t *timeout_ticks);
1382
1383 /**
1384  * Dequeue a burst of events objects or an event object from the event port
1385  * designated by its *event_port_id*, on an event device designated
1386  * by its *dev_id*.
1387  *
1388  * rte_event_dequeue_burst() does not dictate the specifics of scheduling
1389  * algorithm as each eventdev driver may have different criteria to schedule
1390  * an event. However, in general, from an application perspective scheduler may
1391  * use the following scheme to dispatch an event to the port.
1392  *
1393  * 1) Selection of event queue based on
1394  *   a) The list of event queues are linked to the event port.
1395  *   b) If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then event
1396  *   queue selection from list is based on event queue priority relative to
1397  *   other event queue supplied as *priority* in rte_event_queue_setup()
1398  *   c) If the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability then event
1399  *   queue selection from the list is based on event priority supplied as
1400  *   *priority* in rte_event_enqueue_burst()
1401  * 2) Selection of event
1402  *   a) The number of flows available in selected event queue.
1403  *   b) Schedule type method associated with the event
1404  *
1405  * The *nb_events* parameter is the maximum number of event objects to dequeue
1406  * which are returned in the *ev* array of *rte_event* structure.
1407  *
1408  * The rte_event_dequeue_burst() function returns the number of events objects
1409  * it actually dequeued. A return value equal to *nb_events* means that all
1410  * event objects have been dequeued.
1411  *
1412  * The number of events dequeued is the number of scheduler contexts held by
1413  * this port. These contexts are automatically released in the next
1414  * rte_event_dequeue_burst() invocation, or invoking rte_event_enqueue_burst()
1415  * with RTE_EVENT_OP_RELEASE operation can be used to release the
1416  * contexts early.
1417  *
1418  * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
1419  * enqueued to the same port that their associated events were dequeued from.
1420  *
1421  * @param dev_id
1422  *   The identifier of the device.
1423  * @param port_id
1424  *   The identifier of the event port.
1425  * @param[out] ev
1426  *   Points to an array of *nb_events* objects of type *rte_event* structure
1427  *   for output to be populated with the dequeued event objects.
1428  * @param nb_events
1429  *   The maximum number of event objects to dequeue, typically number of
1430  *   rte_event_port_dequeue_depth() available for this port.
1431  *
1432  * @param timeout_ticks
1433  *   - 0 no-wait, returns immediately if there is no event.
1434  *   - >0 wait for the event, if the device is configured with
1435  *   RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT then this function will wait until
1436  *   at least one event is available or *timeout_ticks* time.
1437  *   if the device is not configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT
1438  *   then this function will wait until the event available or
1439  *   *dequeue_timeout_ns* ns which was previously supplied to
1440  *   rte_event_dev_configure()
1441  *
1442  * @return
1443  * The number of event objects actually dequeued from the port. The return
1444  * value can be less than the value of the *nb_events* parameter when the
1445  * event port's queue is not full.
1446  *
1447  * @see rte_event_port_dequeue_depth()
1448  */
1449 static inline uint16_t
1450 rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[],
1451                         uint16_t nb_events, uint64_t timeout_ticks)
1452 {
1453         struct rte_eventdev *dev = &rte_eventdevs[dev_id];
1454
1455 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG
1456         if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) {
1457                 rte_errno = -EINVAL;
1458                 return 0;
1459         }
1460
1461         if (port_id >= dev->data->nb_ports) {
1462                 rte_errno = -EINVAL;
1463                 return 0;
1464         }
1465 #endif
1466
1467         /*
1468          * Allow zero cost non burst mode routine invocation if application
1469          * requests nb_events as const one
1470          */
1471         if (nb_events == 1)
1472                 return (*dev->dequeue)(
1473                         dev->data->ports[port_id], ev, timeout_ticks);
1474         else
1475                 return (*dev->dequeue_burst)(
1476                         dev->data->ports[port_id], ev, nb_events,
1477                                 timeout_ticks);
1478 }
1479
1480 /**
1481  * Link multiple source event queues supplied in *queues* to the destination
1482  * event port designated by its *port_id* with associated service priority
1483  * supplied in *priorities* on the event device designated by its *dev_id*.
1484  *
1485  * The link establishment shall enable the event port *port_id* from
1486  * receiving events from the specified event queue(s) supplied in *queues*
1487  *
1488  * An event queue may link to one or more event ports.
1489  * The number of links can be established from an event queue to event port is
1490  * implementation defined.
1491  *
1492  * Event queue(s) to event port link establishment can be changed at runtime
1493  * without re-configuring the device to support scaling and to reduce the
1494  * latency of critical work by establishing the link with more event ports
1495  * at runtime.
1496  *
1497  * @param dev_id
1498  *   The identifier of the device.
1499  *
1500  * @param port_id
1501  *   Event port identifier to select the destination port to link.
1502  *
1503  * @param queues
1504  *   Points to an array of *nb_links* event queues to be linked
1505  *   to the event port.
1506  *   NULL value is allowed, in which case this function links all the configured
1507  *   event queues *nb_event_queues* which previously supplied to
1508  *   rte_event_dev_configure() to the event port *port_id*
1509  *
1510  * @param priorities
1511  *   Points to an array of *nb_links* service priorities associated with each
1512  *   event queue link to event port.
1513  *   The priority defines the event port's servicing priority for
1514  *   event queue, which may be ignored by an implementation.
1515  *   The requested priority should in the range of
1516  *   [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST].
1517  *   The implementation shall normalize the requested priority to
1518  *   implementation supported priority value.
1519  *   NULL value is allowed, in which case this function links the event queues
1520  *   with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority
1521  *
1522  * @param nb_links
1523  *   The number of links to establish. This parameter is ignored if queues is
1524  *   NULL.
1525  *
1526  * @return
1527  * The number of links actually established. The return value can be less than
1528  * the value of the *nb_links* parameter when the implementation has the
1529  * limitation on specific queue to port link establishment or if invalid
1530  * parameters are specified in *queues*
1531  * If the return value is less than *nb_links*, the remaining links at the end
1532  * of link[] are not established, and the caller has to take care of them.
1533  * If return value is less than *nb_links* then implementation shall update the
1534  * rte_errno accordingly, Possible rte_errno values are
1535  * (-EDQUOT) Quota exceeded(Application tried to link the queue configured with
1536  *  RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports)
1537  * (-EINVAL) Invalid parameter
1538  *
1539  */
1540 int
1541 rte_event_port_link(uint8_t dev_id, uint8_t port_id,
1542                     const uint8_t queues[], const uint8_t priorities[],
1543                     uint16_t nb_links);
1544
1545 /**
1546  * Unlink multiple source event queues supplied in *queues* from the destination
1547  * event port designated by its *port_id* on the event device designated
1548  * by its *dev_id*.
1549  *
1550  * The unlink establishment shall disable the event port *port_id* from
1551  * receiving events from the specified event queue *queue_id*
1552  *
1553  * Event queue(s) to event port unlink establishment can be changed at runtime
1554  * without re-configuring the device.
1555  *
1556  * @param dev_id
1557  *   The identifier of the device.
1558  *
1559  * @param port_id
1560  *   Event port identifier to select the destination port to unlink.
1561  *
1562  * @param queues
1563  *   Points to an array of *nb_unlinks* event queues to be unlinked
1564  *   from the event port.
1565  *   NULL value is allowed, in which case this function unlinks all the
1566  *   event queue(s) from the event port *port_id*.
1567  *
1568  * @param nb_unlinks
1569  *   The number of unlinks to establish. This parameter is ignored if queues is
1570  *   NULL.
1571  *
1572  * @return
1573  * The number of unlinks actually established. The return value can be less
1574  * than the value of the *nb_unlinks* parameter when the implementation has the
1575  * limitation on specific queue to port unlink establishment or
1576  * if invalid parameters are specified.
1577  * If the return value is less than *nb_unlinks*, the remaining queues at the
1578  * end of queues[] are not established, and the caller has to take care of them.
1579  * If return value is less than *nb_unlinks* then implementation shall update
1580  * the rte_errno accordingly, Possible rte_errno values are
1581  * (-EINVAL) Invalid parameter
1582  *
1583  */
1584 int
1585 rte_event_port_unlink(uint8_t dev_id, uint8_t port_id,
1586                       uint8_t queues[], uint16_t nb_unlinks);
1587
1588 /**
1589  * Retrieve the list of source event queues and its associated service priority
1590  * linked to the destination event port designated by its *port_id*
1591  * on the event device designated by its *dev_id*.
1592  *
1593  * @param dev_id
1594  *   The identifier of the device.
1595  *
1596  * @param port_id
1597  *   Event port identifier.
1598  *
1599  * @param[out] queues
1600  *   Points to an array of *queues* for output.
1601  *   The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to
1602  *   store the event queue(s) linked with event port *port_id*
1603  *
1604  * @param[out] priorities
1605  *   Points to an array of *priorities* for output.
1606  *   The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to
1607  *   store the service priority associated with each event queue linked
1608  *
1609  * @return
1610  * The number of links established on the event port designated by its
1611  *  *port_id*.
1612  * - <0 on failure.
1613  *
1614  */
1615 int
1616 rte_event_port_links_get(uint8_t dev_id, uint8_t port_id,
1617                          uint8_t queues[], uint8_t priorities[]);
1618
1619 /**
1620  * Dump internal information about *dev_id* to the FILE* provided in *f*.
1621  *
1622  * @param dev_id
1623  *   The identifier of the device.
1624  *
1625  * @param f
1626  *   A pointer to a file for output
1627  *
1628  * @return
1629  *   - 0: on success
1630  *   - <0: on failure.
1631  */
1632 int
1633 rte_event_dev_dump(uint8_t dev_id, FILE *f);
1634
1635 /** Maximum name length for extended statistics counters */
1636 #define RTE_EVENT_DEV_XSTATS_NAME_SIZE 64
1637
1638 /**
1639  * Selects the component of the eventdev to retrieve statistics from.
1640  */
1641 enum rte_event_dev_xstats_mode {
1642         RTE_EVENT_DEV_XSTATS_DEVICE,
1643         RTE_EVENT_DEV_XSTATS_PORT,
1644         RTE_EVENT_DEV_XSTATS_QUEUE,
1645 };
1646
1647 /**
1648  * A name-key lookup element for extended statistics.
1649  *
1650  * This structure is used to map between names and ID numbers
1651  * for extended ethdev statistics.
1652  */
1653 struct rte_event_dev_xstats_name {
1654         char name[RTE_EVENT_DEV_XSTATS_NAME_SIZE];
1655 };
1656
1657 /**
1658  * Retrieve names of extended statistics of an event device.
1659  *
1660  * @param dev_id
1661  *   The identifier of the event device.
1662  * @param mode
1663  *   The mode of statistics to retrieve. Choices include the device statistics,
1664  *   port statistics or queue statistics.
1665  * @param queue_port_id
1666  *   Used to specify the port or queue number in queue or port mode, and is
1667  *   ignored in device mode.
1668  * @param[out] xstats_names
1669  *   Block of memory to insert names into. Must be at least size in capacity.
1670  *   If set to NULL, function returns required capacity.
1671  * @param[out] ids
1672  *   Block of memory to insert ids into. Must be at least size in capacity.
1673  *   If set to NULL, function returns required capacity. The id values returned
1674  *   can be passed to *rte_event_dev_xstats_get* to select statistics.
1675  * @param size
1676  *   Capacity of xstats_names (number of names).
1677  * @return
1678  *   - positive value lower or equal to size: success. The return value
1679  *     is the number of entries filled in the stats table.
1680  *   - positive value higher than size: error, the given statistics table
1681  *     is too small. The return value corresponds to the size that should
1682  *     be given to succeed. The entries in the table are not valid and
1683  *     shall not be used by the caller.
1684  *   - negative value on error:
1685  *        -ENODEV for invalid *dev_id*
1686  *        -EINVAL for invalid mode, queue port or id parameters
1687  *        -ENOTSUP if the device doesn't support this function.
1688  */
1689 int
1690 rte_event_dev_xstats_names_get(uint8_t dev_id,
1691                                enum rte_event_dev_xstats_mode mode,
1692                                uint8_t queue_port_id,
1693                                struct rte_event_dev_xstats_name *xstats_names,
1694                                unsigned int *ids,
1695                                unsigned int size);
1696
1697 /**
1698  * Retrieve extended statistics of an event device.
1699  *
1700  * @param dev_id
1701  *   The identifier of the device.
1702  * @param mode
1703  *  The mode of statistics to retrieve. Choices include the device statistics,
1704  *  port statistics or queue statistics.
1705  * @param queue_port_id
1706  *   Used to specify the port or queue number in queue or port mode, and is
1707  *   ignored in device mode.
1708  * @param ids
1709  *   The id numbers of the stats to get. The ids can be got from the stat
1710  *   position in the stat list from rte_event_dev_get_xstats_names(), or
1711  *   by using rte_eventdev_get_xstats_by_name()
1712  * @param[out] values
1713  *   The values for each stats request by ID.
1714  * @param n
1715  *   The number of stats requested
1716  * @return
1717  *   - positive value: number of stat entries filled into the values array
1718  *   - negative value on error:
1719  *        -ENODEV for invalid *dev_id*
1720  *        -EINVAL for invalid mode, queue port or id parameters
1721  *        -ENOTSUP if the device doesn't support this function.
1722  */
1723 int
1724 rte_event_dev_xstats_get(uint8_t dev_id,
1725                          enum rte_event_dev_xstats_mode mode,
1726                          uint8_t queue_port_id,
1727                          const unsigned int ids[],
1728                          uint64_t values[], unsigned int n);
1729
1730 /**
1731  * Retrieve the value of a single stat by requesting it by name.
1732  *
1733  * @param dev_id
1734  *   The identifier of the device
1735  * @param name
1736  *   The stat name to retrieve
1737  * @param[out] id
1738  *   If non-NULL, the numerical id of the stat will be returned, so that further
1739  *   requests for the stat can be got using rte_eventdev_xstats_get, which will
1740  *   be faster as it doesn't need to scan a list of names for the stat.
1741  *   If the stat cannot be found, the id returned will be (unsigned)-1.
1742  * @return
1743  *   - positive value or zero: the stat value
1744  *   - negative value: -EINVAL if stat not found, -ENOTSUP if not supported.
1745  */
1746 uint64_t
1747 rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name,
1748                                  unsigned int *id);
1749
1750 /**
1751  * Reset the values of the xstats of the selected component in the device.
1752  *
1753  * @param dev_id
1754  *   The identifier of the device
1755  * @param mode
1756  *   The mode of the statistics to reset. Choose from device, queue or port.
1757  * @param queue_port_id
1758  *   The queue or port to reset. 0 and positive values select ports and queues,
1759  *   while -1 indicates all ports or queues.
1760  * @param ids
1761  *   Selects specific statistics to be reset. When NULL, all statistics selected
1762  *   by *mode* will be reset. If non-NULL, must point to array of at least
1763  *   *nb_ids* size.
1764  * @param nb_ids
1765  *   The number of ids available from the *ids* array. Ignored when ids is NULL.
1766  * @return
1767  *   - zero: successfully reset the statistics to zero
1768  *   - negative value: -EINVAL invalid parameters, -ENOTSUP if not supported.
1769  */
1770 int
1771 rte_event_dev_xstats_reset(uint8_t dev_id,
1772                            enum rte_event_dev_xstats_mode mode,
1773                            int16_t queue_port_id,
1774                            const uint32_t ids[],
1775                            uint32_t nb_ids);
1776
1777 #ifdef __cplusplus
1778 }
1779 #endif
1780
1781 #endif /* _RTE_EVENTDEV_H_ */