1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2016 Cavium, Inc. 3 * Copyright(c) 2016-2018 Intel Corporation. 4 * Copyright 2016 NXP 5 * All rights reserved. 6 */ 7 8 #ifndef _RTE_EVENTDEV_H_ 9 #define _RTE_EVENTDEV_H_ 10 11 /** 12 * @file 13 * 14 * RTE Event Device API 15 * 16 * In a polling model, lcores poll ethdev ports and associated rx queues 17 * directly to look for packet. In an event driven model, by contrast, lcores 18 * call the scheduler that selects packets for them based on programmer 19 * specified criteria. Eventdev library adds support for event driven 20 * programming model, which offer applications automatic multicore scaling, 21 * dynamic load balancing, pipelining, packet ingress order maintenance and 22 * synchronization services to simplify application packet processing. 23 * 24 * The Event Device API is composed of two parts: 25 * 26 * - The application-oriented Event API that includes functions to setup 27 * an event device (configure it, setup its queues, ports and start it), to 28 * establish the link between queues to port and to receive events, and so on. 29 * 30 * - The driver-oriented Event API that exports a function allowing 31 * an event poll Mode Driver (PMD) to simultaneously register itself as 32 * an event device driver. 33 * 34 * Event device components: 35 * 36 * +-----------------+ 37 * | +-------------+ | 38 * +-------+ | | flow 0 | | 39 * |Packet | | +-------------+ | 40 * |event | | +-------------+ | 41 * | | | | flow 1 | |port_link(port0, queue0) 42 * +-------+ | +-------------+ | | +--------+ 43 * +-------+ | +-------------+ o-----v-----o |dequeue +------+ 44 * |Crypto | | | flow n | | | event +------->|Core 0| 45 * |work | | +-------------+ o----+ | port 0 | | | 46 * |done ev| | event queue 0 | | +--------+ +------+ 47 * +-------+ +-----------------+ | 48 * +-------+ | 49 * |Timer | +-----------------+ | +--------+ 50 * |expiry | | +-------------+ | +------o |dequeue +------+ 51 * |event | | | flow 0 | o-----------o event +------->|Core 1| 52 * +-------+ | +-------------+ | +----o port 1 | | | 53 * Event enqueue | +-------------+ | | +--------+ +------+ 54 * o-------------> | | flow 1 | | | 55 * enqueue( | +-------------+ | | 56 * queue_id, | | | +--------+ +------+ 57 * flow_id, | +-------------+ | | | |dequeue |Core 2| 58 * sched_type, | | flow n | o-----------o event +------->| | 59 * event_type, | +-------------+ | | | port 2 | +------+ 60 * subev_type, | event queue 1 | | +--------+ 61 * event) +-----------------+ | +--------+ 62 * | | |dequeue +------+ 63 * +-------+ +-----------------+ | | event +------->|Core n| 64 * |Core | | +-------------+ o-----------o port n | | | 65 * |(SW) | | | flow 0 | | | +--------+ +--+---+ 66 * |event | | +-------------+ | | | 67 * +-------+ | +-------------+ | | | 68 * ^ | | flow 1 | | | | 69 * | | +-------------+ o------+ | 70 * | | +-------------+ | | 71 * | | | flow n | | | 72 * | | +-------------+ | | 73 * | | event queue n | | 74 * | +-----------------+ | 75 * | | 76 * +-----------------------------------------------------------+ 77 * 78 * Event device: A hardware or software-based event scheduler. 79 * 80 * Event: A unit of scheduling that encapsulates a packet or other datatype 81 * like SW generated event from the CPU, Crypto work completion notification, 82 * Timer expiry event notification etc as well as metadata. 83 * The metadata includes flow ID, scheduling type, event priority, event_type, 84 * sub_event_type etc. 85 * 86 * Event queue: A queue containing events that are scheduled by the event dev. 87 * An event queue contains events of different flows associated with scheduling 88 * types, such as atomic, ordered, or parallel. 89 * 90 * Event port: An application's interface into the event dev for enqueue and 91 * dequeue operations. Each event port can be linked with one or more 92 * event queues for dequeue operations. 93 * 94 * By default, all the functions of the Event Device API exported by a PMD 95 * are lock-free functions which assume to not be invoked in parallel on 96 * different logical cores to work on the same target object. For instance, 97 * the dequeue function of a PMD cannot be invoked in parallel on two logical 98 * cores to operates on same event port. Of course, this function 99 * can be invoked in parallel by different logical cores on different ports. 100 * It is the responsibility of the upper level application to enforce this rule. 101 * 102 * In all functions of the Event API, the Event device is 103 * designated by an integer >= 0 named the device identifier *dev_id* 104 * 105 * At the Event driver level, Event devices are represented by a generic 106 * data structure of type *rte_event_dev*. 107 * 108 * Event devices are dynamically registered during the PCI/SoC device probing 109 * phase performed at EAL initialization time. 110 * When an Event device is being probed, a *rte_event_dev* structure and 111 * a new device identifier are allocated for that device. Then, the 112 * event_dev_init() function supplied by the Event driver matching the probed 113 * device is invoked to properly initialize the device. 114 * 115 * The role of the device init function consists of resetting the hardware or 116 * software event driver implementations. 117 * 118 * If the device init operation is successful, the correspondence between 119 * the device identifier assigned to the new device and its associated 120 * *rte_event_dev* structure is effectively registered. 121 * Otherwise, both the *rte_event_dev* structure and the device identifier are 122 * freed. 123 * 124 * The functions exported by the application Event API to setup a device 125 * designated by its device identifier must be invoked in the following order: 126 * - rte_event_dev_configure() 127 * - rte_event_queue_setup() 128 * - rte_event_port_setup() 129 * - rte_event_port_link() 130 * - rte_event_dev_start() 131 * 132 * Then, the application can invoke, in any order, the functions 133 * exported by the Event API to schedule events, dequeue events, enqueue events, 134 * change event queue(s) to event port [un]link establishment and so on. 135 * 136 * Application may use rte_event_[queue/port]_default_conf_get() to get the 137 * default configuration to set up an event queue or event port by 138 * overriding few default values. 139 * 140 * If the application wants to change the configuration (i.e. call 141 * rte_event_dev_configure(), rte_event_queue_setup(), or 142 * rte_event_port_setup()), it must call rte_event_dev_stop() first to stop the 143 * device and then do the reconfiguration before calling rte_event_dev_start() 144 * again. The schedule, enqueue and dequeue functions should not be invoked 145 * when the device is stopped. 146 * 147 * Finally, an application can close an Event device by invoking the 148 * rte_event_dev_close() function. 149 * 150 * Each function of the application Event API invokes a specific function 151 * of the PMD that controls the target device designated by its device 152 * identifier. 153 * 154 * For this purpose, all device-specific functions of an Event driver are 155 * supplied through a set of pointers contained in a generic structure of type 156 * *event_dev_ops*. 157 * The address of the *event_dev_ops* structure is stored in the *rte_event_dev* 158 * structure by the device init function of the Event driver, which is 159 * invoked during the PCI/SoC device probing phase, as explained earlier. 160 * 161 * In other words, each function of the Event API simply retrieves the 162 * *rte_event_dev* structure associated with the device identifier and 163 * performs an indirect invocation of the corresponding driver function 164 * supplied in the *event_dev_ops* structure of the *rte_event_dev* structure. 165 * 166 * For performance reasons, the address of the fast-path functions of the 167 * Event driver is not contained in the *event_dev_ops* structure. 168 * Instead, they are directly stored at the beginning of the *rte_event_dev* 169 * structure to avoid an extra indirect memory access during their invocation. 170 * 171 * RTE event device drivers do not use interrupts for enqueue or dequeue 172 * operation. Instead, Event drivers export Poll-Mode enqueue and dequeue 173 * functions to applications. 174 * 175 * The events are injected to event device through *enqueue* operation by 176 * event producers in the system. The typical event producers are ethdev 177 * subsystem for generating packet events, CPU(SW) for generating events based 178 * on different stages of application processing, cryptodev for generating 179 * crypto work completion notification etc 180 * 181 * The *dequeue* operation gets one or more events from the event ports. 182 * The application process the events and send to downstream event queue through 183 * rte_event_enqueue_burst() if it is an intermediate stage of event processing, 184 * on the final stage, the application may use Tx adapter API for maintaining 185 * the ingress order and then send the packet/event on the wire. 186 * 187 * The point at which events are scheduled to ports depends on the device. 188 * For hardware devices, scheduling occurs asynchronously without any software 189 * intervention. Software schedulers can either be distributed 190 * (each worker thread schedules events to its own port) or centralized 191 * (a dedicated thread schedules to all ports). Distributed software schedulers 192 * perform the scheduling in rte_event_dequeue_burst(), whereas centralized 193 * scheduler logic need a dedicated service core for scheduling. 194 * The RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED capability flag is not set 195 * indicates the device is centralized and thus needs a dedicated scheduling 196 * thread that repeatedly calls software specific scheduling function. 197 * 198 * An event driven worker thread has following typical workflow on fastpath: 199 * \code{.c} 200 * while (1) { 201 * rte_event_dequeue_burst(...); 202 * (event processing) 203 * rte_event_enqueue_burst(...); 204 * } 205 * \endcode 206 * 207 */ 208 209 #ifdef __cplusplus 210 extern "C" { 211 #endif 212 213 #include <rte_common.h> 214 #include <rte_config.h> 215 #include <rte_memory.h> 216 #include <rte_errno.h> 217 218 struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */ 219 struct rte_event; 220 221 /* Event device capability bitmap flags */ 222 #define RTE_EVENT_DEV_CAP_QUEUE_QOS (1ULL << 0) 223 /**< Event scheduling prioritization is based on the priority associated with 224 * each event queue. 225 * 226 * @see rte_event_queue_setup() 227 */ 228 #define RTE_EVENT_DEV_CAP_EVENT_QOS (1ULL << 1) 229 /**< Event scheduling prioritization is based on the priority associated with 230 * each event. Priority of each event is supplied in *rte_event* structure 231 * on each enqueue operation. 232 * 233 * @see rte_event_enqueue_burst() 234 */ 235 #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2) 236 /**< Event device operates in distributed scheduling mode. 237 * In distributed scheduling mode, event scheduling happens in HW or 238 * rte_event_dequeue_burst() or the combination of these two. 239 * If the flag is not set then eventdev is centralized and thus needs a 240 * dedicated service core that acts as a scheduling thread . 241 * 242 * @see rte_event_dequeue_burst() 243 */ 244 #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3) 245 /**< Event device is capable of enqueuing events of any type to any queue. 246 * If this capability is not set, the queue only supports events of the 247 * *RTE_SCHED_TYPE_* type that it was created with. 248 * 249 * @see RTE_SCHED_TYPE_* values 250 */ 251 #define RTE_EVENT_DEV_CAP_BURST_MODE (1ULL << 4) 252 /**< Event device is capable of operating in burst mode for enqueue(forward, 253 * release) and dequeue operation. If this capability is not set, application 254 * still uses the rte_event_dequeue_burst() and rte_event_enqueue_burst() but 255 * PMD accepts only one event at a time. 256 * 257 * @see rte_event_dequeue_burst() rte_event_enqueue_burst() 258 */ 259 #define RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE (1ULL << 5) 260 /**< Event device ports support disabling the implicit release feature, in 261 * which the port will release all unreleased events in its dequeue operation. 262 * If this capability is set and the port is configured with implicit release 263 * disabled, the application is responsible for explicitly releasing events 264 * using either the RTE_EVENT_OP_FORWARD or the RTE_EVENT_OP_RELEASE event 265 * enqueue operations. 266 * 267 * @see rte_event_dequeue_burst() rte_event_enqueue_burst() 268 */ 269 270 #define RTE_EVENT_DEV_CAP_NONSEQ_MODE (1ULL << 6) 271 /**< Event device is capable of operating in none sequential mode. The path 272 * of the event is not necessary to be sequential. Application can change 273 * the path of event at runtime. If the flag is not set, then event each event 274 * will follow a path from queue 0 to queue 1 to queue 2 etc. If the flag is 275 * set, events may be sent to queues in any order. If the flag is not set, the 276 * eventdev will return an error when the application enqueues an event for a 277 * qid which is not the next in the sequence. 278 */ 279 280 #define RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK (1ULL << 7) 281 /**< Event device is capable of configuring the queue/port link at runtime. 282 * If the flag is not set, the eventdev queue/port link is only can be 283 * configured during initialization. 284 */ 285 286 #define RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT (1ULL << 8) 287 /**< Event device is capable of setting up the link between multiple queue 288 * with single port. If the flag is not set, the eventdev can only map a 289 * single queue to each port or map a single queue to many port. 290 */ 291 292 /* Event device priority levels */ 293 #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0 294 /**< Highest priority expressed across eventdev subsystem 295 * @see rte_event_queue_setup(), rte_event_enqueue_burst() 296 * @see rte_event_port_link() 297 */ 298 #define RTE_EVENT_DEV_PRIORITY_NORMAL 128 299 /**< Normal priority expressed across eventdev subsystem 300 * @see rte_event_queue_setup(), rte_event_enqueue_burst() 301 * @see rte_event_port_link() 302 */ 303 #define RTE_EVENT_DEV_PRIORITY_LOWEST 255 304 /**< Lowest priority expressed across eventdev subsystem 305 * @see rte_event_queue_setup(), rte_event_enqueue_burst() 306 * @see rte_event_port_link() 307 */ 308 309 /** 310 * Get the total number of event devices that have been successfully 311 * initialised. 312 * 313 * @return 314 * The total number of usable event devices. 315 */ 316 uint8_t 317 rte_event_dev_count(void); 318 319 /** 320 * Get the device identifier for the named event device. 321 * 322 * @param name 323 * Event device name to select the event device identifier. 324 * 325 * @return 326 * Returns event device identifier on success. 327 * - <0: Failure to find named event device. 328 */ 329 int 330 rte_event_dev_get_dev_id(const char *name); 331 332 /** 333 * Return the NUMA socket to which a device is connected. 334 * 335 * @param dev_id 336 * The identifier of the device. 337 * @return 338 * The NUMA socket id to which the device is connected or 339 * a default of zero if the socket could not be determined. 340 * -(-EINVAL) dev_id value is out of range. 341 */ 342 int 343 rte_event_dev_socket_id(uint8_t dev_id); 344 345 /** 346 * Event device information 347 */ 348 struct rte_event_dev_info { 349 const char *driver_name; /**< Event driver name */ 350 struct rte_device *dev; /**< Device information */ 351 uint32_t min_dequeue_timeout_ns; 352 /**< Minimum supported global dequeue timeout(ns) by this device */ 353 uint32_t max_dequeue_timeout_ns; 354 /**< Maximum supported global dequeue timeout(ns) by this device */ 355 uint32_t dequeue_timeout_ns; 356 /**< Configured global dequeue timeout(ns) for this device */ 357 uint8_t max_event_queues; 358 /**< Maximum event_queues supported by this device */ 359 uint32_t max_event_queue_flows; 360 /**< Maximum supported flows in an event queue by this device*/ 361 uint8_t max_event_queue_priority_levels; 362 /**< Maximum number of event queue priority levels by this device. 363 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability 364 */ 365 uint8_t max_event_priority_levels; 366 /**< Maximum number of event priority levels by this device. 367 * Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability 368 */ 369 uint8_t max_event_ports; 370 /**< Maximum number of event ports supported by this device */ 371 uint8_t max_event_port_dequeue_depth; 372 /**< Maximum number of events can be dequeued at a time from an 373 * event port by this device. 374 * A device that does not support bulk dequeue will set this as 1. 375 */ 376 uint32_t max_event_port_enqueue_depth; 377 /**< Maximum number of events can be enqueued at a time from an 378 * event port by this device. 379 * A device that does not support bulk enqueue will set this as 1. 380 */ 381 int32_t max_num_events; 382 /**< A *closed system* event dev has a limit on the number of events it 383 * can manage at a time. An *open system* event dev does not have a 384 * limit and will specify this as -1. 385 */ 386 uint32_t event_dev_cap; 387 /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/ 388 }; 389 390 /** 391 * Retrieve the contextual information of an event device. 392 * 393 * @param dev_id 394 * The identifier of the device. 395 * 396 * @param[out] dev_info 397 * A pointer to a structure of type *rte_event_dev_info* to be filled with the 398 * contextual information of the device. 399 * 400 * @return 401 * - 0: Success, driver updates the contextual information of the event device 402 * - <0: Error code returned by the driver info get function. 403 * 404 */ 405 int 406 rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info); 407 408 /** 409 * The count of ports. 410 */ 411 #define RTE_EVENT_DEV_ATTR_PORT_COUNT 0 412 /** 413 * The count of queues. 414 */ 415 #define RTE_EVENT_DEV_ATTR_QUEUE_COUNT 1 416 /** 417 * The status of the device, zero for stopped, non-zero for started. 418 */ 419 #define RTE_EVENT_DEV_ATTR_STARTED 2 420 421 /** 422 * Get an attribute from a device. 423 * 424 * @param dev_id Eventdev id 425 * @param attr_id The attribute ID to retrieve 426 * @param[out] attr_value A pointer that will be filled in with the attribute 427 * value if successful. 428 * 429 * @return 430 * - 0: Successfully retrieved attribute value 431 * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL 432 */ 433 int 434 rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, 435 uint32_t *attr_value); 436 437 438 /* Event device configuration bitmap flags */ 439 #define RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT (1ULL << 0) 440 /**< Override the global *dequeue_timeout_ns* and use per dequeue timeout in ns. 441 * @see rte_event_dequeue_timeout_ticks(), rte_event_dequeue_burst() 442 */ 443 444 /** Event device configuration structure */ 445 struct rte_event_dev_config { 446 uint32_t dequeue_timeout_ns; 447 /**< rte_event_dequeue_burst() timeout on this device. 448 * This value should be in the range of *min_dequeue_timeout_ns* and 449 * *max_dequeue_timeout_ns* which previously provided in 450 * rte_event_dev_info_get() 451 * The value 0 is allowed, in which case, default dequeue timeout used. 452 * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 453 */ 454 int32_t nb_events_limit; 455 /**< In a *closed system* this field is the limit on maximum number of 456 * events that can be inflight in the eventdev at a given time. The 457 * limit is required to ensure that the finite space in a closed system 458 * is not overwhelmed. The value cannot exceed the *max_num_events* 459 * as provided by rte_event_dev_info_get(). 460 * This value should be set to -1 for *open system*. 461 */ 462 uint8_t nb_event_queues; 463 /**< Number of event queues to configure on this device. 464 * This value cannot exceed the *max_event_queues* which previously 465 * provided in rte_event_dev_info_get() 466 */ 467 uint8_t nb_event_ports; 468 /**< Number of event ports to configure on this device. 469 * This value cannot exceed the *max_event_ports* which previously 470 * provided in rte_event_dev_info_get() 471 */ 472 uint32_t nb_event_queue_flows; 473 /**< Number of flows for any event queue on this device. 474 * This value cannot exceed the *max_event_queue_flows* which previously 475 * provided in rte_event_dev_info_get() 476 */ 477 uint32_t nb_event_port_dequeue_depth; 478 /**< Maximum number of events can be dequeued at a time from an 479 * event port by this device. 480 * This value cannot exceed the *max_event_port_dequeue_depth* 481 * which previously provided in rte_event_dev_info_get(). 482 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 483 * @see rte_event_port_setup() 484 */ 485 uint32_t nb_event_port_enqueue_depth; 486 /**< Maximum number of events can be enqueued at a time from an 487 * event port by this device. 488 * This value cannot exceed the *max_event_port_enqueue_depth* 489 * which previously provided in rte_event_dev_info_get(). 490 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 491 * @see rte_event_port_setup() 492 */ 493 uint32_t event_dev_cfg; 494 /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/ 495 }; 496 497 /** 498 * Configure an event device. 499 * 500 * This function must be invoked first before any other function in the 501 * API. This function can also be re-invoked when a device is in the 502 * stopped state. 503 * 504 * The caller may use rte_event_dev_info_get() to get the capability of each 505 * resources available for this event device. 506 * 507 * @param dev_id 508 * The identifier of the device to configure. 509 * @param dev_conf 510 * The event device configuration structure. 511 * 512 * @return 513 * - 0: Success, device configured. 514 * - <0: Error code returned by the driver configuration function. 515 */ 516 int 517 rte_event_dev_configure(uint8_t dev_id, 518 const struct rte_event_dev_config *dev_conf); 519 520 521 /* Event queue specific APIs */ 522 523 /* Event queue configuration bitmap flags */ 524 #define RTE_EVENT_QUEUE_CFG_ALL_TYPES (1ULL << 0) 525 /**< Allow ATOMIC,ORDERED,PARALLEL schedule type enqueue 526 * 527 * @see RTE_SCHED_TYPE_ORDERED, RTE_SCHED_TYPE_ATOMIC, RTE_SCHED_TYPE_PARALLEL 528 * @see rte_event_enqueue_burst() 529 */ 530 #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK (1ULL << 1) 531 /**< This event queue links only to a single event port. 532 * 533 * @see rte_event_port_setup(), rte_event_port_link() 534 */ 535 536 /** Event queue configuration structure */ 537 struct rte_event_queue_conf { 538 uint32_t nb_atomic_flows; 539 /**< The maximum number of active flows this queue can track at any 540 * given time. If the queue is configured for atomic scheduling (by 541 * applying the RTE_EVENT_QUEUE_CFG_ALL_TYPES flag to event_queue_cfg 542 * or RTE_SCHED_TYPE_ATOMIC flag to schedule_type), then the 543 * value must be in the range of [1, nb_event_queue_flows], which was 544 * previously provided in rte_event_dev_configure(). 545 */ 546 uint32_t nb_atomic_order_sequences; 547 /**< The maximum number of outstanding events waiting to be 548 * reordered by this queue. In other words, the number of entries in 549 * this queue’s reorder buffer.When the number of events in the 550 * reorder buffer reaches to *nb_atomic_order_sequences* then the 551 * scheduler cannot schedule the events from this queue and invalid 552 * event will be returned from dequeue until one or more entries are 553 * freed up/released. 554 * If the queue is configured for ordered scheduling (by applying the 555 * RTE_EVENT_QUEUE_CFG_ALL_TYPES flag to event_queue_cfg or 556 * RTE_SCHED_TYPE_ORDERED flag to schedule_type), then the value must 557 * be in the range of [1, nb_event_queue_flows], which was 558 * previously supplied to rte_event_dev_configure(). 559 */ 560 uint32_t event_queue_cfg; 561 /**< Queue cfg flags(EVENT_QUEUE_CFG_) */ 562 uint8_t schedule_type; 563 /**< Queue schedule type(RTE_SCHED_TYPE_*). 564 * Valid when RTE_EVENT_QUEUE_CFG_ALL_TYPES bit is not set in 565 * event_queue_cfg. 566 */ 567 uint8_t priority; 568 /**< Priority for this event queue relative to other event queues. 569 * The requested priority should in the range of 570 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 571 * The implementation shall normalize the requested priority to 572 * event device supported priority value. 573 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability 574 */ 575 }; 576 577 /** 578 * Retrieve the default configuration information of an event queue designated 579 * by its *queue_id* from the event driver for an event device. 580 * 581 * This function intended to be used in conjunction with rte_event_queue_setup() 582 * where caller needs to set up the queue by overriding few default values. 583 * 584 * @param dev_id 585 * The identifier of the device. 586 * @param queue_id 587 * The index of the event queue to get the configuration information. 588 * The value must be in the range [0, nb_event_queues - 1] 589 * previously supplied to rte_event_dev_configure(). 590 * @param[out] queue_conf 591 * The pointer to the default event queue configuration data. 592 * @return 593 * - 0: Success, driver updates the default event queue configuration data. 594 * - <0: Error code returned by the driver info get function. 595 * 596 * @see rte_event_queue_setup() 597 * 598 */ 599 int 600 rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id, 601 struct rte_event_queue_conf *queue_conf); 602 603 /** 604 * Allocate and set up an event queue for an event device. 605 * 606 * @param dev_id 607 * The identifier of the device. 608 * @param queue_id 609 * The index of the event queue to setup. The value must be in the range 610 * [0, nb_event_queues - 1] previously supplied to rte_event_dev_configure(). 611 * @param queue_conf 612 * The pointer to the configuration data to be used for the event queue. 613 * NULL value is allowed, in which case default configuration used. 614 * 615 * @see rte_event_queue_default_conf_get() 616 * 617 * @return 618 * - 0: Success, event queue correctly set up. 619 * - <0: event queue configuration failed 620 */ 621 int 622 rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id, 623 const struct rte_event_queue_conf *queue_conf); 624 625 /** 626 * The priority of the queue. 627 */ 628 #define RTE_EVENT_QUEUE_ATTR_PRIORITY 0 629 /** 630 * The number of atomic flows configured for the queue. 631 */ 632 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_FLOWS 1 633 /** 634 * The number of atomic order sequences configured for the queue. 635 */ 636 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_ORDER_SEQUENCES 2 637 /** 638 * The cfg flags for the queue. 639 */ 640 #define RTE_EVENT_QUEUE_ATTR_EVENT_QUEUE_CFG 3 641 /** 642 * The schedule type of the queue. 643 */ 644 #define RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE 4 645 646 /** 647 * Get an attribute from a queue. 648 * 649 * @param dev_id 650 * Eventdev id 651 * @param queue_id 652 * Eventdev queue id 653 * @param attr_id 654 * The attribute ID to retrieve 655 * @param[out] attr_value 656 * A pointer that will be filled in with the attribute value if successful 657 * 658 * @return 659 * - 0: Successfully returned value 660 * - -EINVAL: invalid device, queue or attr_id provided, or attr_value was 661 * NULL 662 * - -EOVERFLOW: returned when attr_id is set to 663 * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to 664 * RTE_EVENT_QUEUE_CFG_ALL_TYPES 665 */ 666 int 667 rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, 668 uint32_t *attr_value); 669 670 /* Event port specific APIs */ 671 672 /** Event port configuration structure */ 673 struct rte_event_port_conf { 674 int32_t new_event_threshold; 675 /**< A backpressure threshold for new event enqueues on this port. 676 * Use for *closed system* event dev where event capacity is limited, 677 * and cannot exceed the capacity of the event dev. 678 * Configuring ports with different thresholds can make higher priority 679 * traffic less likely to be backpressured. 680 * For example, a port used to inject NIC Rx packets into the event dev 681 * can have a lower threshold so as not to overwhelm the device, 682 * while ports used for worker pools can have a higher threshold. 683 * This value cannot exceed the *nb_events_limit* 684 * which was previously supplied to rte_event_dev_configure(). 685 * This should be set to '-1' for *open system*. 686 */ 687 uint16_t dequeue_depth; 688 /**< Configure number of bulk dequeues for this event port. 689 * This value cannot exceed the *nb_event_port_dequeue_depth* 690 * which previously supplied to rte_event_dev_configure(). 691 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 692 */ 693 uint16_t enqueue_depth; 694 /**< Configure number of bulk enqueues for this event port. 695 * This value cannot exceed the *nb_event_port_enqueue_depth* 696 * which previously supplied to rte_event_dev_configure(). 697 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 698 */ 699 uint8_t disable_implicit_release; 700 /**< Configure the port not to release outstanding events in 701 * rte_event_dev_dequeue_burst(). If true, all events received through 702 * the port must be explicitly released with RTE_EVENT_OP_RELEASE or 703 * RTE_EVENT_OP_FORWARD. Must be false when the device is not 704 * RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE capable. 705 */ 706 }; 707 708 /** 709 * Retrieve the default configuration information of an event port designated 710 * by its *port_id* from the event driver for an event device. 711 * 712 * This function intended to be used in conjunction with rte_event_port_setup() 713 * where caller needs to set up the port by overriding few default values. 714 * 715 * @param dev_id 716 * The identifier of the device. 717 * @param port_id 718 * The index of the event port to get the configuration information. 719 * The value must be in the range [0, nb_event_ports - 1] 720 * previously supplied to rte_event_dev_configure(). 721 * @param[out] port_conf 722 * The pointer to the default event port configuration data 723 * @return 724 * - 0: Success, driver updates the default event port configuration data. 725 * - <0: Error code returned by the driver info get function. 726 * 727 * @see rte_event_port_setup() 728 * 729 */ 730 int 731 rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id, 732 struct rte_event_port_conf *port_conf); 733 734 /** 735 * Allocate and set up an event port for an event device. 736 * 737 * @param dev_id 738 * The identifier of the device. 739 * @param port_id 740 * The index of the event port to setup. The value must be in the range 741 * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure(). 742 * @param port_conf 743 * The pointer to the configuration data to be used for the queue. 744 * NULL value is allowed, in which case default configuration used. 745 * 746 * @see rte_event_port_default_conf_get() 747 * 748 * @return 749 * - 0: Success, event port correctly set up. 750 * - <0: Port configuration failed 751 * - (-EDQUOT) Quota exceeded(Application tried to link the queue configured 752 * with RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 753 */ 754 int 755 rte_event_port_setup(uint8_t dev_id, uint8_t port_id, 756 const struct rte_event_port_conf *port_conf); 757 758 /** 759 * The queue depth of the port on the enqueue side 760 */ 761 #define RTE_EVENT_PORT_ATTR_ENQ_DEPTH 0 762 /** 763 * The queue depth of the port on the dequeue side 764 */ 765 #define RTE_EVENT_PORT_ATTR_DEQ_DEPTH 1 766 /** 767 * The new event threshold of the port 768 */ 769 #define RTE_EVENT_PORT_ATTR_NEW_EVENT_THRESHOLD 2 770 771 /** 772 * Get an attribute from a port. 773 * 774 * @param dev_id 775 * Eventdev id 776 * @param port_id 777 * Eventdev port id 778 * @param attr_id 779 * The attribute ID to retrieve 780 * @param[out] attr_value 781 * A pointer that will be filled in with the attribute value if successful 782 * 783 * @return 784 * - 0: Successfully returned value 785 * - (-EINVAL) Invalid device, port or attr_id, or attr_value was NULL 786 */ 787 int 788 rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id, 789 uint32_t *attr_value); 790 791 /** 792 * Start an event device. 793 * 794 * The device start step is the last one and consists of setting the event 795 * queues to start accepting the events and schedules to event ports. 796 * 797 * On success, all basic functions exported by the API (event enqueue, 798 * event dequeue and so on) can be invoked. 799 * 800 * @param dev_id 801 * Event device identifier 802 * @return 803 * - 0: Success, device started. 804 * - -ESTALE : Not all ports of the device are configured 805 * - -ENOLINK: Not all queues are linked, which could lead to deadlock. 806 */ 807 int 808 rte_event_dev_start(uint8_t dev_id); 809 810 /** 811 * Stop an event device. 812 * 813 * This function causes all queued events to be drained, including those 814 * residing in event ports. While draining events out of the device, this 815 * function calls the user-provided flush callback (if one was registered) once 816 * per event. 817 * 818 * The device can be restarted with a call to rte_event_dev_start(). Threads 819 * that continue to enqueue/dequeue while the device is stopped, or being 820 * stopped, will result in undefined behavior. This includes event adapters, 821 * which must be stopped prior to stopping the eventdev. 822 * 823 * @param dev_id 824 * Event device identifier. 825 * 826 * @see rte_event_dev_stop_flush_callback_register() 827 */ 828 void 829 rte_event_dev_stop(uint8_t dev_id); 830 831 typedef void (*eventdev_stop_flush_t)(uint8_t dev_id, struct rte_event event, 832 void *arg); 833 /**< Callback function called during rte_event_dev_stop(), invoked once per 834 * flushed event. 835 */ 836 837 /** 838 * Registers a callback function to be invoked during rte_event_dev_stop() for 839 * each flushed event. This function can be used to properly dispose of queued 840 * events, for example events containing memory pointers. 841 * 842 * The callback function is only registered for the calling process. The 843 * callback function must be registered in every process that can call 844 * rte_event_dev_stop(). 845 * 846 * To unregister a callback, call this function with a NULL callback pointer. 847 * 848 * @param dev_id 849 * The identifier of the device. 850 * @param callback 851 * Callback function invoked once per flushed event. 852 * @param userdata 853 * Argument supplied to callback. 854 * 855 * @return 856 * - 0 on success. 857 * - -EINVAL if *dev_id* is invalid 858 * 859 * @see rte_event_dev_stop() 860 */ 861 int 862 rte_event_dev_stop_flush_callback_register(uint8_t dev_id, 863 eventdev_stop_flush_t callback, void *userdata); 864 865 /** 866 * Close an event device. The device cannot be restarted! 867 * 868 * @param dev_id 869 * Event device identifier 870 * 871 * @return 872 * - 0 on successfully closing device 873 * - <0 on failure to close device 874 * - (-EAGAIN) if device is busy 875 */ 876 int 877 rte_event_dev_close(uint8_t dev_id); 878 879 /* Scheduler type definitions */ 880 #define RTE_SCHED_TYPE_ORDERED 0 881 /**< Ordered scheduling 882 * 883 * Events from an ordered flow of an event queue can be scheduled to multiple 884 * ports for concurrent processing while maintaining the original event order. 885 * This scheme enables the user to achieve high single flow throughput by 886 * avoiding SW synchronization for ordering between ports which bound to cores. 887 * 888 * The source flow ordering from an event queue is maintained when events are 889 * enqueued to their destination queue within the same ordered flow context. 890 * An event port holds the context until application call 891 * rte_event_dequeue_burst() from the same port, which implicitly releases 892 * the context. 893 * User may allow the scheduler to release the context earlier than that 894 * by invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE operation. 895 * 896 * Events from the source queue appear in their original order when dequeued 897 * from a destination queue. 898 * Event ordering is based on the received event(s), but also other 899 * (newly allocated or stored) events are ordered when enqueued within the same 900 * ordered context. Events not enqueued (e.g. released or stored) within the 901 * context are considered missing from reordering and are skipped at this time 902 * (but can be ordered again within another context). 903 * 904 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE 905 */ 906 907 #define RTE_SCHED_TYPE_ATOMIC 1 908 /**< Atomic scheduling 909 * 910 * Events from an atomic flow of an event queue can be scheduled only to a 911 * single port at a time. The port is guaranteed to have exclusive (atomic) 912 * access to the associated flow context, which enables the user to avoid SW 913 * synchronization. Atomic flows also help to maintain event ordering 914 * since only one port at a time can process events from a flow of an 915 * event queue. 916 * 917 * The atomic queue synchronization context is dedicated to the port until 918 * application call rte_event_dequeue_burst() from the same port, 919 * which implicitly releases the context. User may allow the scheduler to 920 * release the context earlier than that by invoking rte_event_enqueue_burst() 921 * with RTE_EVENT_OP_RELEASE operation. 922 * 923 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE 924 */ 925 926 #define RTE_SCHED_TYPE_PARALLEL 2 927 /**< Parallel scheduling 928 * 929 * The scheduler performs priority scheduling, load balancing, etc. functions 930 * but does not provide additional event synchronization or ordering. 931 * It is free to schedule events from a single parallel flow of an event queue 932 * to multiple events ports for concurrent processing. 933 * The application is responsible for flow context synchronization and 934 * event ordering (SW synchronization). 935 * 936 * @see rte_event_queue_setup(), rte_event_dequeue_burst() 937 */ 938 939 /* Event types to classify the event source */ 940 #define RTE_EVENT_TYPE_ETHDEV 0x0 941 /**< The event generated from ethdev subsystem */ 942 #define RTE_EVENT_TYPE_CRYPTODEV 0x1 943 /**< The event generated from crypodev subsystem */ 944 #define RTE_EVENT_TYPE_TIMER 0x2 945 /**< The event generated from event timer adapter */ 946 #define RTE_EVENT_TYPE_CPU 0x3 947 /**< The event generated from cpu for pipelining. 948 * Application may use *sub_event_type* to further classify the event 949 */ 950 #define RTE_EVENT_TYPE_ETH_RX_ADAPTER 0x4 951 /**< The event generated from event eth Rx adapter */ 952 #define RTE_EVENT_TYPE_MAX 0x10 953 /**< Maximum number of event types */ 954 955 /* Event enqueue operations */ 956 #define RTE_EVENT_OP_NEW 0 957 /**< The event producers use this operation to inject a new event to the 958 * event device. 959 */ 960 #define RTE_EVENT_OP_FORWARD 1 961 /**< The CPU use this operation to forward the event to different event queue or 962 * change to new application specific flow or schedule type to enable 963 * pipelining. 964 * 965 * This operation must only be enqueued to the same port that the 966 * event to be forwarded was dequeued from. 967 */ 968 #define RTE_EVENT_OP_RELEASE 2 969 /**< Release the flow context associated with the schedule type. 970 * 971 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ATOMIC* 972 * then this function hints the scheduler that the user has completed critical 973 * section processing in the current atomic context. 974 * The scheduler is now allowed to schedule events from the same flow from 975 * an event queue to another port. However, the context may be still held 976 * until the next rte_event_dequeue_burst() call, this call allows but does not 977 * force the scheduler to release the context early. 978 * 979 * Early atomic context release may increase parallelism and thus system 980 * performance, but the user needs to design carefully the split into critical 981 * vs non-critical sections. 982 * 983 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ORDERED* 984 * then this function hints the scheduler that the user has done all that need 985 * to maintain event order in the current ordered context. 986 * The scheduler is allowed to release the ordered context of this port and 987 * avoid reordering any following enqueues. 988 * 989 * Early ordered context release may increase parallelism and thus system 990 * performance. 991 * 992 * If current flow's scheduler type method is *RTE_SCHED_TYPE_PARALLEL* 993 * or no scheduling context is held then this function may be an NOOP, 994 * depending on the implementation. 995 * 996 * This operation must only be enqueued to the same port that the 997 * event to be released was dequeued from. 998 * 999 */ 1000 1001 /** 1002 * The generic *rte_event* structure to hold the event attributes 1003 * for dequeue and enqueue operation 1004 */ 1005 RTE_STD_C11 1006 struct rte_event { 1007 /** WORD0 */ 1008 union { 1009 uint64_t event; 1010 /** Event attributes for dequeue or enqueue operation */ 1011 struct { 1012 uint32_t flow_id:20; 1013 /**< Targeted flow identifier for the enqueue and 1014 * dequeue operation. 1015 * The value must be in the range of 1016 * [0, nb_event_queue_flows - 1] which 1017 * previously supplied to rte_event_dev_configure(). 1018 */ 1019 uint32_t sub_event_type:8; 1020 /**< Sub-event types based on the event source. 1021 * @see RTE_EVENT_TYPE_CPU 1022 */ 1023 uint32_t event_type:4; 1024 /**< Event type to classify the event source. 1025 * @see RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*) 1026 */ 1027 uint8_t op:2; 1028 /**< The type of event enqueue operation - new/forward/ 1029 * etc.This field is not preserved across an instance 1030 * and is undefined on dequeue. 1031 * @see RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*) 1032 */ 1033 uint8_t rsvd:4; 1034 /**< Reserved for future use */ 1035 uint8_t sched_type:2; 1036 /**< Scheduler synchronization type (RTE_SCHED_TYPE_*) 1037 * associated with flow id on a given event queue 1038 * for the enqueue and dequeue operation. 1039 */ 1040 uint8_t queue_id; 1041 /**< Targeted event queue identifier for the enqueue or 1042 * dequeue operation. 1043 * The value must be in the range of 1044 * [0, nb_event_queues - 1] which previously supplied to 1045 * rte_event_dev_configure(). 1046 */ 1047 uint8_t priority; 1048 /**< Event priority relative to other events in the 1049 * event queue. The requested priority should in the 1050 * range of [RTE_EVENT_DEV_PRIORITY_HIGHEST, 1051 * RTE_EVENT_DEV_PRIORITY_LOWEST]. 1052 * The implementation shall normalize the requested 1053 * priority to supported priority value. 1054 * Valid when the device has 1055 * RTE_EVENT_DEV_CAP_EVENT_QOS capability. 1056 */ 1057 uint8_t impl_opaque; 1058 /**< Implementation specific opaque value. 1059 * An implementation may use this field to hold 1060 * implementation specific value to share between 1061 * dequeue and enqueue operation. 1062 * The application should not modify this field. 1063 */ 1064 }; 1065 }; 1066 /** WORD1 */ 1067 union { 1068 uint64_t u64; 1069 /**< Opaque 64-bit value */ 1070 void *event_ptr; 1071 /**< Opaque event pointer */ 1072 struct rte_mbuf *mbuf; 1073 /**< mbuf pointer if dequeued event is associated with mbuf */ 1074 }; 1075 }; 1076 1077 /* Ethdev Rx adapter capability bitmap flags */ 1078 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT 0x1 1079 /**< This flag is sent when the packet transfer mechanism is in HW. 1080 * Ethdev can send packets to the event device using internal event port. 1081 */ 1082 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ 0x2 1083 /**< Adapter supports multiple event queues per ethdev. Every ethdev 1084 * Rx queue can be connected to a unique event queue. 1085 */ 1086 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID 0x4 1087 /**< The application can override the adapter generated flow ID in the 1088 * event. This flow ID can be specified when adding an ethdev Rx queue 1089 * to the adapter using the ev member of struct rte_event_eth_rx_adapter 1090 * @see struct rte_event_eth_rx_adapter_queue_conf::ev 1091 * @see struct rte_event_eth_rx_adapter_queue_conf::rx_queue_flags 1092 */ 1093 1094 /** 1095 * Retrieve the event device's ethdev Rx adapter capabilities for the 1096 * specified ethernet port 1097 * 1098 * @param dev_id 1099 * The identifier of the device. 1100 * 1101 * @param eth_port_id 1102 * The identifier of the ethernet device. 1103 * 1104 * @param[out] caps 1105 * A pointer to memory filled with Rx event adapter capabilities. 1106 * 1107 * @return 1108 * - 0: Success, driver provides Rx event adapter capabilities for the 1109 * ethernet device. 1110 * - <0: Error code returned by the driver function. 1111 * 1112 */ 1113 int 1114 rte_event_eth_rx_adapter_caps_get(uint8_t dev_id, uint16_t eth_port_id, 1115 uint32_t *caps); 1116 1117 #define RTE_EVENT_TIMER_ADAPTER_CAP_INTERNAL_PORT (1ULL << 0) 1118 /**< This flag is set when the timer mechanism is in HW. */ 1119 1120 /** 1121 * Retrieve the event device's timer adapter capabilities. 1122 * 1123 * @param dev_id 1124 * The identifier of the device. 1125 * 1126 * @param[out] caps 1127 * A pointer to memory to be filled with event timer adapter capabilities. 1128 * 1129 * @return 1130 * - 0: Success, driver provided event timer adapter capabilities. 1131 * - <0: Error code returned by the driver function. 1132 */ 1133 int __rte_experimental 1134 rte_event_timer_adapter_caps_get(uint8_t dev_id, uint32_t *caps); 1135 1136 /* Crypto adapter capability bitmap flag */ 1137 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_OP_NEW 0x1 1138 /**< Flag indicates HW is capable of generating events in 1139 * RTE_EVENT_OP_NEW enqueue operation. Cryptodev will send 1140 * packets to the event device as new events using an internal 1141 * event port. 1142 */ 1143 1144 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_OP_FWD 0x2 1145 /**< Flag indicates HW is capable of generating events in 1146 * RTE_EVENT_OP_FORWARD enqueue operation. Cryptodev will send 1147 * packets to the event device as forwarded event using an 1148 * internal event port. 1149 */ 1150 1151 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_QP_EV_BIND 0x4 1152 /**< Flag indicates HW is capable of mapping crypto queue pair to 1153 * event queue. 1154 */ 1155 1156 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA 0x8 1157 /**< Flag indicates HW/SW supports a mechanism to store and retrieve 1158 * the private data information along with the crypto session. 1159 */ 1160 1161 /** 1162 * @warning 1163 * @b EXPERIMENTAL: this API may change without prior notice 1164 * 1165 * Retrieve the event device's crypto adapter capabilities for the 1166 * specified cryptodev device 1167 * 1168 * @param dev_id 1169 * The identifier of the device. 1170 * 1171 * @param cdev_id 1172 * The identifier of the cryptodev device. 1173 * 1174 * @param[out] caps 1175 * A pointer to memory filled with event adapter capabilities. 1176 * It is expected to be pre-allocated & initialized by caller. 1177 * 1178 * @return 1179 * - 0: Success, driver provides event adapter capabilities for the 1180 * cryptodev device. 1181 * - <0: Error code returned by the driver function. 1182 * 1183 */ 1184 int __rte_experimental 1185 rte_event_crypto_adapter_caps_get(uint8_t dev_id, uint8_t cdev_id, 1186 uint32_t *caps); 1187 1188 /* Ethdev Tx adapter capability bitmap flags */ 1189 #define RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT 0x1 1190 /**< This flag is sent when the PMD supports a packet transmit callback 1191 */ 1192 1193 /** 1194 * Retrieve the event device's eth Tx adapter capabilities 1195 * 1196 * @param dev_id 1197 * The identifier of the device. 1198 * 1199 * @param eth_port_id 1200 * The identifier of the ethernet device. 1201 * 1202 * @param[out] caps 1203 * A pointer to memory filled with eth Tx adapter capabilities. 1204 * 1205 * @return 1206 * - 0: Success, driver provides eth Tx adapter capabilities. 1207 * - <0: Error code returned by the driver function. 1208 * 1209 */ 1210 int __rte_experimental 1211 rte_event_eth_tx_adapter_caps_get(uint8_t dev_id, uint16_t eth_port_id, 1212 uint32_t *caps); 1213 1214 struct rte_eventdev_ops; 1215 struct rte_eventdev; 1216 1217 typedef uint16_t (*event_enqueue_t)(void *port, const struct rte_event *ev); 1218 /**< @internal Enqueue event on port of a device */ 1219 1220 typedef uint16_t (*event_enqueue_burst_t)(void *port, 1221 const struct rte_event ev[], uint16_t nb_events); 1222 /**< @internal Enqueue burst of events on port of a device */ 1223 1224 typedef uint16_t (*event_dequeue_t)(void *port, struct rte_event *ev, 1225 uint64_t timeout_ticks); 1226 /**< @internal Dequeue event from port of a device */ 1227 1228 typedef uint16_t (*event_dequeue_burst_t)(void *port, struct rte_event ev[], 1229 uint16_t nb_events, uint64_t timeout_ticks); 1230 /**< @internal Dequeue burst of events from port of a device */ 1231 1232 typedef uint16_t (*event_tx_adapter_enqueue)(void *port, 1233 struct rte_event ev[], uint16_t nb_events); 1234 /**< @internal Enqueue burst of events on port of a device */ 1235 1236 #define RTE_EVENTDEV_NAME_MAX_LEN (64) 1237 /**< @internal Max length of name of event PMD */ 1238 1239 /** 1240 * @internal 1241 * The data part, with no function pointers, associated with each device. 1242 * 1243 * This structure is safe to place in shared memory to be common among 1244 * different processes in a multi-process configuration. 1245 */ 1246 struct rte_eventdev_data { 1247 int socket_id; 1248 /**< Socket ID where memory is allocated */ 1249 uint8_t dev_id; 1250 /**< Device ID for this instance */ 1251 uint8_t nb_queues; 1252 /**< Number of event queues. */ 1253 uint8_t nb_ports; 1254 /**< Number of event ports. */ 1255 void **ports; 1256 /**< Array of pointers to ports. */ 1257 struct rte_event_port_conf *ports_cfg; 1258 /**< Array of port configuration structures. */ 1259 struct rte_event_queue_conf *queues_cfg; 1260 /**< Array of queue configuration structures. */ 1261 uint16_t *links_map; 1262 /**< Memory to store queues to port connections. */ 1263 void *dev_private; 1264 /**< PMD-specific private data */ 1265 uint32_t event_dev_cap; 1266 /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/ 1267 struct rte_event_dev_config dev_conf; 1268 /**< Configuration applied to device. */ 1269 uint8_t service_inited; 1270 /* Service initialization state */ 1271 uint32_t service_id; 1272 /* Service ID*/ 1273 void *dev_stop_flush_arg; 1274 /**< User-provided argument for event flush function */ 1275 1276 RTE_STD_C11 1277 uint8_t dev_started : 1; 1278 /**< Device state: STARTED(1)/STOPPED(0) */ 1279 1280 char name[RTE_EVENTDEV_NAME_MAX_LEN]; 1281 /**< Unique identifier name */ 1282 } __rte_cache_aligned; 1283 1284 /** @internal The data structure associated with each event device. */ 1285 struct rte_eventdev { 1286 event_enqueue_t enqueue; 1287 /**< Pointer to PMD enqueue function. */ 1288 event_enqueue_burst_t enqueue_burst; 1289 /**< Pointer to PMD enqueue burst function. */ 1290 event_enqueue_burst_t enqueue_new_burst; 1291 /**< Pointer to PMD enqueue burst function(op new variant) */ 1292 event_enqueue_burst_t enqueue_forward_burst; 1293 /**< Pointer to PMD enqueue burst function(op forward variant) */ 1294 event_dequeue_t dequeue; 1295 /**< Pointer to PMD dequeue function. */ 1296 event_dequeue_burst_t dequeue_burst; 1297 /**< Pointer to PMD dequeue burst function. */ 1298 event_tx_adapter_enqueue txa_enqueue; 1299 /**< Pointer to PMD eth Tx adapter enqueue function. */ 1300 struct rte_eventdev_data *data; 1301 /**< Pointer to device data */ 1302 struct rte_eventdev_ops *dev_ops; 1303 /**< Functions exported by PMD */ 1304 struct rte_device *dev; 1305 /**< Device info. supplied by probing */ 1306 1307 RTE_STD_C11 1308 uint8_t attached : 1; 1309 /**< Flag indicating the device is attached */ 1310 } __rte_cache_aligned; 1311 1312 extern struct rte_eventdev *rte_eventdevs; 1313 /** @internal The pool of rte_eventdev structures. */ 1314 1315 static __rte_always_inline uint16_t 1316 __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, 1317 const struct rte_event ev[], uint16_t nb_events, 1318 const event_enqueue_burst_t fn) 1319 { 1320 const struct rte_eventdev *dev = &rte_eventdevs[dev_id]; 1321 1322 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 1323 if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) { 1324 rte_errno = EINVAL; 1325 return 0; 1326 } 1327 1328 if (port_id >= dev->data->nb_ports) { 1329 rte_errno = EINVAL; 1330 return 0; 1331 } 1332 #endif 1333 /* 1334 * Allow zero cost non burst mode routine invocation if application 1335 * requests nb_events as const one 1336 */ 1337 if (nb_events == 1) 1338 return (*dev->enqueue)(dev->data->ports[port_id], ev); 1339 else 1340 return fn(dev->data->ports[port_id], ev, nb_events); 1341 } 1342 1343 /** 1344 * Enqueue a burst of events objects or an event object supplied in *rte_event* 1345 * structure on an event device designated by its *dev_id* through the event 1346 * port specified by *port_id*. Each event object specifies the event queue on 1347 * which it will be enqueued. 1348 * 1349 * The *nb_events* parameter is the number of event objects to enqueue which are 1350 * supplied in the *ev* array of *rte_event* structure. 1351 * 1352 * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be 1353 * enqueued to the same port that their associated events were dequeued from. 1354 * 1355 * The rte_event_enqueue_burst() function returns the number of 1356 * events objects it actually enqueued. A return value equal to *nb_events* 1357 * means that all event objects have been enqueued. 1358 * 1359 * @param dev_id 1360 * The identifier of the device. 1361 * @param port_id 1362 * The identifier of the event port. 1363 * @param ev 1364 * Points to an array of *nb_events* objects of type *rte_event* structure 1365 * which contain the event object enqueue operations to be processed. 1366 * @param nb_events 1367 * The number of event objects to enqueue, typically number of 1368 * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 1369 * available for this port. 1370 * 1371 * @return 1372 * The number of event objects actually enqueued on the event device. The 1373 * return value can be less than the value of the *nb_events* parameter when 1374 * the event devices queue is full or if invalid parameters are specified in a 1375 * *rte_event*. If the return value is less than *nb_events*, the remaining 1376 * events at the end of ev[] are not consumed and the caller has to take care 1377 * of them, and rte_errno is set accordingly. Possible errno values include: 1378 * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 1379 * ID is invalid, or an event's sched type doesn't match the 1380 * capabilities of the destination queue. 1381 * - ENOSPC The event port was backpressured and unable to enqueue 1382 * one or more events. This error code is only applicable to 1383 * closed systems. 1384 * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 1385 */ 1386 static inline uint16_t 1387 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, 1388 const struct rte_event ev[], uint16_t nb_events) 1389 { 1390 const struct rte_eventdev *dev = &rte_eventdevs[dev_id]; 1391 1392 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 1393 dev->enqueue_burst); 1394 } 1395 1396 /** 1397 * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_NEW* on 1398 * an event device designated by its *dev_id* through the event port specified 1399 * by *port_id*. 1400 * 1401 * Provides the same functionality as rte_event_enqueue_burst(), expect that 1402 * application can use this API when the all objects in the burst contains 1403 * the enqueue operation of the type *RTE_EVENT_OP_NEW*. This specialized 1404 * function can provide the additional hint to the PMD and optimize if possible. 1405 * 1406 * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst 1407 * has event object of operation type != RTE_EVENT_OP_NEW. 1408 * 1409 * @param dev_id 1410 * The identifier of the device. 1411 * @param port_id 1412 * The identifier of the event port. 1413 * @param ev 1414 * Points to an array of *nb_events* objects of type *rte_event* structure 1415 * which contain the event object enqueue operations to be processed. 1416 * @param nb_events 1417 * The number of event objects to enqueue, typically number of 1418 * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 1419 * available for this port. 1420 * 1421 * @return 1422 * The number of event objects actually enqueued on the event device. The 1423 * return value can be less than the value of the *nb_events* parameter when 1424 * the event devices queue is full or if invalid parameters are specified in a 1425 * *rte_event*. If the return value is less than *nb_events*, the remaining 1426 * events at the end of ev[] are not consumed and the caller has to take care 1427 * of them, and rte_errno is set accordingly. Possible errno values include: 1428 * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 1429 * ID is invalid, or an event's sched type doesn't match the 1430 * capabilities of the destination queue. 1431 * - ENOSPC The event port was backpressured and unable to enqueue 1432 * one or more events. This error code is only applicable to 1433 * closed systems. 1434 * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 1435 * @see rte_event_enqueue_burst() 1436 */ 1437 static inline uint16_t 1438 rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id, 1439 const struct rte_event ev[], uint16_t nb_events) 1440 { 1441 const struct rte_eventdev *dev = &rte_eventdevs[dev_id]; 1442 1443 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 1444 dev->enqueue_new_burst); 1445 } 1446 1447 /** 1448 * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_FORWARD* 1449 * on an event device designated by its *dev_id* through the event port 1450 * specified by *port_id*. 1451 * 1452 * Provides the same functionality as rte_event_enqueue_burst(), expect that 1453 * application can use this API when the all objects in the burst contains 1454 * the enqueue operation of the type *RTE_EVENT_OP_FORWARD*. This specialized 1455 * function can provide the additional hint to the PMD and optimize if possible. 1456 * 1457 * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst 1458 * has event object of operation type != RTE_EVENT_OP_FORWARD. 1459 * 1460 * @param dev_id 1461 * The identifier of the device. 1462 * @param port_id 1463 * The identifier of the event port. 1464 * @param ev 1465 * Points to an array of *nb_events* objects of type *rte_event* structure 1466 * which contain the event object enqueue operations to be processed. 1467 * @param nb_events 1468 * The number of event objects to enqueue, typically number of 1469 * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 1470 * available for this port. 1471 * 1472 * @return 1473 * The number of event objects actually enqueued on the event device. The 1474 * return value can be less than the value of the *nb_events* parameter when 1475 * the event devices queue is full or if invalid parameters are specified in a 1476 * *rte_event*. If the return value is less than *nb_events*, the remaining 1477 * events at the end of ev[] are not consumed and the caller has to take care 1478 * of them, and rte_errno is set accordingly. Possible errno values include: 1479 * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 1480 * ID is invalid, or an event's sched type doesn't match the 1481 * capabilities of the destination queue. 1482 * - ENOSPC The event port was backpressured and unable to enqueue 1483 * one or more events. This error code is only applicable to 1484 * closed systems. 1485 * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 1486 * @see rte_event_enqueue_burst() 1487 */ 1488 static inline uint16_t 1489 rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id, 1490 const struct rte_event ev[], uint16_t nb_events) 1491 { 1492 const struct rte_eventdev *dev = &rte_eventdevs[dev_id]; 1493 1494 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 1495 dev->enqueue_forward_burst); 1496 } 1497 1498 /** 1499 * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue_burst() 1500 * 1501 * If the device is configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT flag 1502 * then application can use this function to convert timeout value in 1503 * nanoseconds to implementations specific timeout value supplied in 1504 * rte_event_dequeue_burst() 1505 * 1506 * @param dev_id 1507 * The identifier of the device. 1508 * @param ns 1509 * Wait time in nanosecond 1510 * @param[out] timeout_ticks 1511 * Value for the *timeout_ticks* parameter in rte_event_dequeue_burst() 1512 * 1513 * @return 1514 * - 0 on success. 1515 * - -ENOTSUP if the device doesn't support timeouts 1516 * - -EINVAL if *dev_id* is invalid or *timeout_ticks* is NULL 1517 * - other values < 0 on failure. 1518 * 1519 * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 1520 * @see rte_event_dev_configure() 1521 * 1522 */ 1523 int 1524 rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns, 1525 uint64_t *timeout_ticks); 1526 1527 /** 1528 * Dequeue a burst of events objects or an event object from the event port 1529 * designated by its *event_port_id*, on an event device designated 1530 * by its *dev_id*. 1531 * 1532 * rte_event_dequeue_burst() does not dictate the specifics of scheduling 1533 * algorithm as each eventdev driver may have different criteria to schedule 1534 * an event. However, in general, from an application perspective scheduler may 1535 * use the following scheme to dispatch an event to the port. 1536 * 1537 * 1) Selection of event queue based on 1538 * a) The list of event queues are linked to the event port. 1539 * b) If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then event 1540 * queue selection from list is based on event queue priority relative to 1541 * other event queue supplied as *priority* in rte_event_queue_setup() 1542 * c) If the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability then event 1543 * queue selection from the list is based on event priority supplied as 1544 * *priority* in rte_event_enqueue_burst() 1545 * 2) Selection of event 1546 * a) The number of flows available in selected event queue. 1547 * b) Schedule type method associated with the event 1548 * 1549 * The *nb_events* parameter is the maximum number of event objects to dequeue 1550 * which are returned in the *ev* array of *rte_event* structure. 1551 * 1552 * The rte_event_dequeue_burst() function returns the number of events objects 1553 * it actually dequeued. A return value equal to *nb_events* means that all 1554 * event objects have been dequeued. 1555 * 1556 * The number of events dequeued is the number of scheduler contexts held by 1557 * this port. These contexts are automatically released in the next 1558 * rte_event_dequeue_burst() invocation if the port supports implicit 1559 * releases, or invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE 1560 * operation can be used to release the contexts early. 1561 * 1562 * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be 1563 * enqueued to the same port that their associated events were dequeued from. 1564 * 1565 * @param dev_id 1566 * The identifier of the device. 1567 * @param port_id 1568 * The identifier of the event port. 1569 * @param[out] ev 1570 * Points to an array of *nb_events* objects of type *rte_event* structure 1571 * for output to be populated with the dequeued event objects. 1572 * @param nb_events 1573 * The maximum number of event objects to dequeue, typically number of 1574 * rte_event_port_dequeue_depth() available for this port. 1575 * 1576 * @param timeout_ticks 1577 * - 0 no-wait, returns immediately if there is no event. 1578 * - >0 wait for the event, if the device is configured with 1579 * RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT then this function will wait until 1580 * at least one event is available or *timeout_ticks* time. 1581 * if the device is not configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 1582 * then this function will wait until the event available or 1583 * *dequeue_timeout_ns* ns which was previously supplied to 1584 * rte_event_dev_configure() 1585 * 1586 * @return 1587 * The number of event objects actually dequeued from the port. The return 1588 * value can be less than the value of the *nb_events* parameter when the 1589 * event port's queue is not full. 1590 * 1591 * @see rte_event_port_dequeue_depth() 1592 */ 1593 static inline uint16_t 1594 rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[], 1595 uint16_t nb_events, uint64_t timeout_ticks) 1596 { 1597 struct rte_eventdev *dev = &rte_eventdevs[dev_id]; 1598 1599 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 1600 if (dev_id >= RTE_EVENT_MAX_DEVS || !rte_eventdevs[dev_id].attached) { 1601 rte_errno = EINVAL; 1602 return 0; 1603 } 1604 1605 if (port_id >= dev->data->nb_ports) { 1606 rte_errno = EINVAL; 1607 return 0; 1608 } 1609 #endif 1610 1611 /* 1612 * Allow zero cost non burst mode routine invocation if application 1613 * requests nb_events as const one 1614 */ 1615 if (nb_events == 1) 1616 return (*dev->dequeue)( 1617 dev->data->ports[port_id], ev, timeout_ticks); 1618 else 1619 return (*dev->dequeue_burst)( 1620 dev->data->ports[port_id], ev, nb_events, 1621 timeout_ticks); 1622 } 1623 1624 /** 1625 * Link multiple source event queues supplied in *queues* to the destination 1626 * event port designated by its *port_id* with associated service priority 1627 * supplied in *priorities* on the event device designated by its *dev_id*. 1628 * 1629 * The link establishment shall enable the event port *port_id* from 1630 * receiving events from the specified event queue(s) supplied in *queues* 1631 * 1632 * An event queue may link to one or more event ports. 1633 * The number of links can be established from an event queue to event port is 1634 * implementation defined. 1635 * 1636 * Event queue(s) to event port link establishment can be changed at runtime 1637 * without re-configuring the device to support scaling and to reduce the 1638 * latency of critical work by establishing the link with more event ports 1639 * at runtime. 1640 * 1641 * @param dev_id 1642 * The identifier of the device. 1643 * 1644 * @param port_id 1645 * Event port identifier to select the destination port to link. 1646 * 1647 * @param queues 1648 * Points to an array of *nb_links* event queues to be linked 1649 * to the event port. 1650 * NULL value is allowed, in which case this function links all the configured 1651 * event queues *nb_event_queues* which previously supplied to 1652 * rte_event_dev_configure() to the event port *port_id* 1653 * 1654 * @param priorities 1655 * Points to an array of *nb_links* service priorities associated with each 1656 * event queue link to event port. 1657 * The priority defines the event port's servicing priority for 1658 * event queue, which may be ignored by an implementation. 1659 * The requested priority should in the range of 1660 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 1661 * The implementation shall normalize the requested priority to 1662 * implementation supported priority value. 1663 * NULL value is allowed, in which case this function links the event queues 1664 * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority 1665 * 1666 * @param nb_links 1667 * The number of links to establish. This parameter is ignored if queues is 1668 * NULL. 1669 * 1670 * @return 1671 * The number of links actually established. The return value can be less than 1672 * the value of the *nb_links* parameter when the implementation has the 1673 * limitation on specific queue to port link establishment or if invalid 1674 * parameters are specified in *queues* 1675 * If the return value is less than *nb_links*, the remaining links at the end 1676 * of link[] are not established, and the caller has to take care of them. 1677 * If return value is less than *nb_links* then implementation shall update the 1678 * rte_errno accordingly, Possible rte_errno values are 1679 * (EDQUOT) Quota exceeded(Application tried to link the queue configured with 1680 * RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 1681 * (EINVAL) Invalid parameter 1682 * 1683 */ 1684 int 1685 rte_event_port_link(uint8_t dev_id, uint8_t port_id, 1686 const uint8_t queues[], const uint8_t priorities[], 1687 uint16_t nb_links); 1688 1689 /** 1690 * Unlink multiple source event queues supplied in *queues* from the destination 1691 * event port designated by its *port_id* on the event device designated 1692 * by its *dev_id*. 1693 * 1694 * The unlink call issues an async request to disable the event port *port_id* 1695 * from receiving events from the specified event queue *queue_id*. 1696 * Event queue(s) to event port unlink establishment can be changed at runtime 1697 * without re-configuring the device. 1698 * 1699 * @see rte_event_port_unlinks_in_progress() to poll for completed unlinks. 1700 * 1701 * @param dev_id 1702 * The identifier of the device. 1703 * 1704 * @param port_id 1705 * Event port identifier to select the destination port to unlink. 1706 * 1707 * @param queues 1708 * Points to an array of *nb_unlinks* event queues to be unlinked 1709 * from the event port. 1710 * NULL value is allowed, in which case this function unlinks all the 1711 * event queue(s) from the event port *port_id*. 1712 * 1713 * @param nb_unlinks 1714 * The number of unlinks to establish. This parameter is ignored if queues is 1715 * NULL. 1716 * 1717 * @return 1718 * The number of unlinks successfully requested. The return value can be less 1719 * than the value of the *nb_unlinks* parameter when the implementation has the 1720 * limitation on specific queue to port unlink establishment or 1721 * if invalid parameters are specified. 1722 * If the return value is less than *nb_unlinks*, the remaining queues at the 1723 * end of queues[] are not unlinked, and the caller has to take care of them. 1724 * If return value is less than *nb_unlinks* then implementation shall update 1725 * the rte_errno accordingly, Possible rte_errno values are 1726 * (EINVAL) Invalid parameter 1727 */ 1728 int 1729 rte_event_port_unlink(uint8_t dev_id, uint8_t port_id, 1730 uint8_t queues[], uint16_t nb_unlinks); 1731 1732 /** 1733 * @warning 1734 * @b EXPERIMENTAL: this API may change without prior notice 1735 * 1736 * Returns the number of unlinks in progress. 1737 * 1738 * This function provides the application with a method to detect when an 1739 * unlink has been completed by the implementation. 1740 * 1741 * @see rte_event_port_unlink() to issue unlink requests. 1742 * 1743 * @param dev_id 1744 * The identifier of the device. 1745 * 1746 * @param port_id 1747 * Event port identifier to select port to check for unlinks in progress. 1748 * 1749 * @return 1750 * The number of unlinks that are in progress. A return of zero indicates that 1751 * there are no outstanding unlink requests. A positive return value indicates 1752 * the number of unlinks that are in progress, but are not yet complete. 1753 * A negative return value indicates an error, -EINVAL indicates an invalid 1754 * parameter passed for *dev_id* or *port_id*. 1755 */ 1756 int __rte_experimental 1757 rte_event_port_unlinks_in_progress(uint8_t dev_id, uint8_t port_id); 1758 1759 /** 1760 * Retrieve the list of source event queues and its associated service priority 1761 * linked to the destination event port designated by its *port_id* 1762 * on the event device designated by its *dev_id*. 1763 * 1764 * @param dev_id 1765 * The identifier of the device. 1766 * 1767 * @param port_id 1768 * Event port identifier. 1769 * 1770 * @param[out] queues 1771 * Points to an array of *queues* for output. 1772 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 1773 * store the event queue(s) linked with event port *port_id* 1774 * 1775 * @param[out] priorities 1776 * Points to an array of *priorities* for output. 1777 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 1778 * store the service priority associated with each event queue linked 1779 * 1780 * @return 1781 * The number of links established on the event port designated by its 1782 * *port_id*. 1783 * - <0 on failure. 1784 * 1785 */ 1786 int 1787 rte_event_port_links_get(uint8_t dev_id, uint8_t port_id, 1788 uint8_t queues[], uint8_t priorities[]); 1789 1790 /** 1791 * Retrieve the service ID of the event dev. If the adapter doesn't use 1792 * a rte_service function, this function returns -ESRCH. 1793 * 1794 * @param dev_id 1795 * The identifier of the device. 1796 * 1797 * @param [out] service_id 1798 * A pointer to a uint32_t, to be filled in with the service id. 1799 * 1800 * @return 1801 * - 0: Success 1802 * - <0: Error code on failure, if the event dev doesn't use a rte_service 1803 * function, this function returns -ESRCH. 1804 */ 1805 int 1806 rte_event_dev_service_id_get(uint8_t dev_id, uint32_t *service_id); 1807 1808 /** 1809 * Dump internal information about *dev_id* to the FILE* provided in *f*. 1810 * 1811 * @param dev_id 1812 * The identifier of the device. 1813 * 1814 * @param f 1815 * A pointer to a file for output 1816 * 1817 * @return 1818 * - 0: on success 1819 * - <0: on failure. 1820 */ 1821 int 1822 rte_event_dev_dump(uint8_t dev_id, FILE *f); 1823 1824 /** Maximum name length for extended statistics counters */ 1825 #define RTE_EVENT_DEV_XSTATS_NAME_SIZE 64 1826 1827 /** 1828 * Selects the component of the eventdev to retrieve statistics from. 1829 */ 1830 enum rte_event_dev_xstats_mode { 1831 RTE_EVENT_DEV_XSTATS_DEVICE, 1832 RTE_EVENT_DEV_XSTATS_PORT, 1833 RTE_EVENT_DEV_XSTATS_QUEUE, 1834 }; 1835 1836 /** 1837 * A name-key lookup element for extended statistics. 1838 * 1839 * This structure is used to map between names and ID numbers 1840 * for extended ethdev statistics. 1841 */ 1842 struct rte_event_dev_xstats_name { 1843 char name[RTE_EVENT_DEV_XSTATS_NAME_SIZE]; 1844 }; 1845 1846 /** 1847 * Retrieve names of extended statistics of an event device. 1848 * 1849 * @param dev_id 1850 * The identifier of the event device. 1851 * @param mode 1852 * The mode of statistics to retrieve. Choices include the device statistics, 1853 * port statistics or queue statistics. 1854 * @param queue_port_id 1855 * Used to specify the port or queue number in queue or port mode, and is 1856 * ignored in device mode. 1857 * @param[out] xstats_names 1858 * Block of memory to insert names into. Must be at least size in capacity. 1859 * If set to NULL, function returns required capacity. 1860 * @param[out] ids 1861 * Block of memory to insert ids into. Must be at least size in capacity. 1862 * If set to NULL, function returns required capacity. The id values returned 1863 * can be passed to *rte_event_dev_xstats_get* to select statistics. 1864 * @param size 1865 * Capacity of xstats_names (number of names). 1866 * @return 1867 * - positive value lower or equal to size: success. The return value 1868 * is the number of entries filled in the stats table. 1869 * - positive value higher than size: error, the given statistics table 1870 * is too small. The return value corresponds to the size that should 1871 * be given to succeed. The entries in the table are not valid and 1872 * shall not be used by the caller. 1873 * - negative value on error: 1874 * -ENODEV for invalid *dev_id* 1875 * -EINVAL for invalid mode, queue port or id parameters 1876 * -ENOTSUP if the device doesn't support this function. 1877 */ 1878 int 1879 rte_event_dev_xstats_names_get(uint8_t dev_id, 1880 enum rte_event_dev_xstats_mode mode, 1881 uint8_t queue_port_id, 1882 struct rte_event_dev_xstats_name *xstats_names, 1883 unsigned int *ids, 1884 unsigned int size); 1885 1886 /** 1887 * Retrieve extended statistics of an event device. 1888 * 1889 * @param dev_id 1890 * The identifier of the device. 1891 * @param mode 1892 * The mode of statistics to retrieve. Choices include the device statistics, 1893 * port statistics or queue statistics. 1894 * @param queue_port_id 1895 * Used to specify the port or queue number in queue or port mode, and is 1896 * ignored in device mode. 1897 * @param ids 1898 * The id numbers of the stats to get. The ids can be got from the stat 1899 * position in the stat list from rte_event_dev_get_xstats_names(), or 1900 * by using rte_event_dev_xstats_by_name_get(). 1901 * @param[out] values 1902 * The values for each stats request by ID. 1903 * @param n 1904 * The number of stats requested 1905 * @return 1906 * - positive value: number of stat entries filled into the values array 1907 * - negative value on error: 1908 * -ENODEV for invalid *dev_id* 1909 * -EINVAL for invalid mode, queue port or id parameters 1910 * -ENOTSUP if the device doesn't support this function. 1911 */ 1912 int 1913 rte_event_dev_xstats_get(uint8_t dev_id, 1914 enum rte_event_dev_xstats_mode mode, 1915 uint8_t queue_port_id, 1916 const unsigned int ids[], 1917 uint64_t values[], unsigned int n); 1918 1919 /** 1920 * Retrieve the value of a single stat by requesting it by name. 1921 * 1922 * @param dev_id 1923 * The identifier of the device 1924 * @param name 1925 * The stat name to retrieve 1926 * @param[out] id 1927 * If non-NULL, the numerical id of the stat will be returned, so that further 1928 * requests for the stat can be got using rte_event_dev_xstats_get, which will 1929 * be faster as it doesn't need to scan a list of names for the stat. 1930 * If the stat cannot be found, the id returned will be (unsigned)-1. 1931 * @return 1932 * - positive value or zero: the stat value 1933 * - negative value: -EINVAL if stat not found, -ENOTSUP if not supported. 1934 */ 1935 uint64_t 1936 rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name, 1937 unsigned int *id); 1938 1939 /** 1940 * Reset the values of the xstats of the selected component in the device. 1941 * 1942 * @param dev_id 1943 * The identifier of the device 1944 * @param mode 1945 * The mode of the statistics to reset. Choose from device, queue or port. 1946 * @param queue_port_id 1947 * The queue or port to reset. 0 and positive values select ports and queues, 1948 * while -1 indicates all ports or queues. 1949 * @param ids 1950 * Selects specific statistics to be reset. When NULL, all statistics selected 1951 * by *mode* will be reset. If non-NULL, must point to array of at least 1952 * *nb_ids* size. 1953 * @param nb_ids 1954 * The number of ids available from the *ids* array. Ignored when ids is NULL. 1955 * @return 1956 * - zero: successfully reset the statistics to zero 1957 * - negative value: -EINVAL invalid parameters, -ENOTSUP if not supported. 1958 */ 1959 int 1960 rte_event_dev_xstats_reset(uint8_t dev_id, 1961 enum rte_event_dev_xstats_mode mode, 1962 int16_t queue_port_id, 1963 const uint32_t ids[], 1964 uint32_t nb_ids); 1965 1966 /** 1967 * Trigger the eventdev self test. 1968 * 1969 * @param dev_id 1970 * The identifier of the device 1971 * @return 1972 * - 0: Selftest successful 1973 * - -ENOTSUP if the device doesn't support selftest 1974 * - other values < 0 on failure. 1975 */ 1976 int rte_event_dev_selftest(uint8_t dev_id); 1977 1978 #ifdef __cplusplus 1979 } 1980 #endif 1981 1982 #endif /* _RTE_EVENTDEV_H_ */ 1983