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 #ifdef __cplusplus 209 extern "C" { 210 #endif 211 212 #include <rte_compat.h> 213 #include <rte_common.h> 214 #include <rte_errno.h> 215 #include <rte_mbuf_pool_ops.h> 216 #include <rte_mempool.h> 217 218 #include "rte_eventdev_trace_fp.h" 219 220 struct rte_mbuf; /* we just use mbuf pointers; no need to include rte_mbuf.h */ 221 struct rte_event; 222 223 /* Event device capability bitmap flags */ 224 #define RTE_EVENT_DEV_CAP_QUEUE_QOS (1ULL << 0) 225 /**< Event scheduling prioritization is based on the priority and weight 226 * associated with each event queue. Events from a queue with highest priority 227 * is scheduled first. If the queues are of same priority, weight of the queues 228 * are considered to select a queue in a weighted round robin fashion. 229 * Subsequent dequeue calls from an event port could see events from the same 230 * event queue, if the queue is configured with an affinity count. Affinity 231 * count is the number of subsequent dequeue calls, in which an event port 232 * should use the same event queue if the queue is non-empty 233 * 234 * @see rte_event_queue_setup(), rte_event_queue_attr_set() 235 */ 236 #define RTE_EVENT_DEV_CAP_EVENT_QOS (1ULL << 1) 237 /**< Event scheduling prioritization is based on the priority associated with 238 * each event. Priority of each event is supplied in *rte_event* structure 239 * on each enqueue operation. 240 * 241 * @see rte_event_enqueue_burst() 242 */ 243 #define RTE_EVENT_DEV_CAP_DISTRIBUTED_SCHED (1ULL << 2) 244 /**< Event device operates in distributed scheduling mode. 245 * In distributed scheduling mode, event scheduling happens in HW or 246 * rte_event_dequeue_burst() or the combination of these two. 247 * If the flag is not set then eventdev is centralized and thus needs a 248 * dedicated service core that acts as a scheduling thread . 249 * 250 * @see rte_event_dequeue_burst() 251 */ 252 #define RTE_EVENT_DEV_CAP_QUEUE_ALL_TYPES (1ULL << 3) 253 /**< Event device is capable of enqueuing events of any type to any queue. 254 * If this capability is not set, the queue only supports events of the 255 * *RTE_SCHED_TYPE_* type that it was created with. 256 * 257 * @see RTE_SCHED_TYPE_* values 258 */ 259 #define RTE_EVENT_DEV_CAP_BURST_MODE (1ULL << 4) 260 /**< Event device is capable of operating in burst mode for enqueue(forward, 261 * release) and dequeue operation. If this capability is not set, application 262 * still uses the rte_event_dequeue_burst() and rte_event_enqueue_burst() but 263 * PMD accepts only one event at a time. 264 * 265 * @see rte_event_dequeue_burst() rte_event_enqueue_burst() 266 */ 267 #define RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE (1ULL << 5) 268 /**< Event device ports support disabling the implicit release feature, in 269 * which the port will release all unreleased events in its dequeue operation. 270 * If this capability is set and the port is configured with implicit release 271 * disabled, the application is responsible for explicitly releasing events 272 * using either the RTE_EVENT_OP_FORWARD or the RTE_EVENT_OP_RELEASE event 273 * enqueue operations. 274 * 275 * @see rte_event_dequeue_burst() rte_event_enqueue_burst() 276 */ 277 278 #define RTE_EVENT_DEV_CAP_NONSEQ_MODE (1ULL << 6) 279 /**< Event device is capable of operating in none sequential mode. The path 280 * of the event is not necessary to be sequential. Application can change 281 * the path of event at runtime. If the flag is not set, then event each event 282 * will follow a path from queue 0 to queue 1 to queue 2 etc. If the flag is 283 * set, events may be sent to queues in any order. If the flag is not set, the 284 * eventdev will return an error when the application enqueues an event for a 285 * qid which is not the next in the sequence. 286 */ 287 288 #define RTE_EVENT_DEV_CAP_RUNTIME_PORT_LINK (1ULL << 7) 289 /**< Event device is capable of configuring the queue/port link at runtime. 290 * If the flag is not set, the eventdev queue/port link is only can be 291 * configured during initialization. 292 */ 293 294 #define RTE_EVENT_DEV_CAP_MULTIPLE_QUEUE_PORT (1ULL << 8) 295 /**< Event device is capable of setting up the link between multiple queue 296 * with single port. If the flag is not set, the eventdev can only map a 297 * single queue to each port or map a single queue to many port. 298 */ 299 300 #define RTE_EVENT_DEV_CAP_CARRY_FLOW_ID (1ULL << 9) 301 /**< Event device preserves the flow ID from the enqueued 302 * event to the dequeued event if the flag is set. Otherwise, 303 * the content of this field is implementation dependent. 304 */ 305 306 #define RTE_EVENT_DEV_CAP_MAINTENANCE_FREE (1ULL << 10) 307 /**< Event device *does not* require calls to rte_event_maintain(). 308 * An event device that does not set this flag requires calls to 309 * rte_event_maintain() during periods when neither 310 * rte_event_dequeue_burst() nor rte_event_enqueue_burst() are called 311 * on a port. This will allow the event device to perform internal 312 * processing, such as flushing buffered events, return credits to a 313 * global pool, or process signaling related to load balancing. 314 */ 315 316 #define RTE_EVENT_DEV_CAP_RUNTIME_QUEUE_ATTR (1ULL << 11) 317 /**< Event device is capable of changing the queue attributes at runtime i.e 318 * after rte_event_queue_setup() or rte_event_start() call sequence. If this 319 * flag is not set, eventdev queue attributes can only be configured during 320 * rte_event_queue_setup(). 321 */ 322 323 /* Event device priority levels */ 324 #define RTE_EVENT_DEV_PRIORITY_HIGHEST 0 325 /**< Highest priority expressed across eventdev subsystem 326 * @see rte_event_queue_setup(), rte_event_enqueue_burst() 327 * @see rte_event_port_link() 328 */ 329 #define RTE_EVENT_DEV_PRIORITY_NORMAL 128 330 /**< Normal priority expressed across eventdev subsystem 331 * @see rte_event_queue_setup(), rte_event_enqueue_burst() 332 * @see rte_event_port_link() 333 */ 334 #define RTE_EVENT_DEV_PRIORITY_LOWEST 255 335 /**< Lowest priority expressed across eventdev subsystem 336 * @see rte_event_queue_setup(), rte_event_enqueue_burst() 337 * @see rte_event_port_link() 338 */ 339 340 /* Event queue scheduling weights */ 341 #define RTE_EVENT_QUEUE_WEIGHT_HIGHEST 255 342 /**< Highest weight of an event queue 343 * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 344 */ 345 #define RTE_EVENT_QUEUE_WEIGHT_LOWEST 0 346 /**< Lowest weight of an event queue 347 * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 348 */ 349 350 /* Event queue scheduling affinity */ 351 #define RTE_EVENT_QUEUE_AFFINITY_HIGHEST 255 352 /**< Highest scheduling affinity of an event queue 353 * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 354 */ 355 #define RTE_EVENT_QUEUE_AFFINITY_LOWEST 0 356 /**< Lowest scheduling affinity of an event queue 357 * @see rte_event_queue_attr_get(), rte_event_queue_attr_set() 358 */ 359 360 /** 361 * Get the total number of event devices that have been successfully 362 * initialised. 363 * 364 * @return 365 * The total number of usable event devices. 366 */ 367 uint8_t 368 rte_event_dev_count(void); 369 370 /** 371 * Get the device identifier for the named event device. 372 * 373 * @param name 374 * Event device name to select the event device identifier. 375 * 376 * @return 377 * Returns event device identifier on success. 378 * - <0: Failure to find named event device. 379 */ 380 int 381 rte_event_dev_get_dev_id(const char *name); 382 383 /** 384 * Return the NUMA socket to which a device is connected. 385 * 386 * @param dev_id 387 * The identifier of the device. 388 * @return 389 * The NUMA socket id to which the device is connected or 390 * a default of zero if the socket could not be determined. 391 * -(-EINVAL) dev_id value is out of range. 392 */ 393 int 394 rte_event_dev_socket_id(uint8_t dev_id); 395 396 /** 397 * Event device information 398 */ 399 struct rte_event_dev_info { 400 const char *driver_name; /**< Event driver name */ 401 struct rte_device *dev; /**< Device information */ 402 uint32_t min_dequeue_timeout_ns; 403 /**< Minimum supported global dequeue timeout(ns) by this device */ 404 uint32_t max_dequeue_timeout_ns; 405 /**< Maximum supported global dequeue timeout(ns) by this device */ 406 uint32_t dequeue_timeout_ns; 407 /**< Configured global dequeue timeout(ns) for this device */ 408 uint8_t max_event_queues; 409 /**< Maximum event_queues supported by this device */ 410 uint32_t max_event_queue_flows; 411 /**< Maximum supported flows in an event queue by this device*/ 412 uint8_t max_event_queue_priority_levels; 413 /**< Maximum number of event queue priority levels by this device. 414 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability 415 */ 416 uint8_t max_event_priority_levels; 417 /**< Maximum number of event priority levels by this device. 418 * Valid when the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability 419 */ 420 uint8_t max_event_ports; 421 /**< Maximum number of event ports supported by this device */ 422 uint8_t max_event_port_dequeue_depth; 423 /**< Maximum number of events can be dequeued at a time from an 424 * event port by this device. 425 * A device that does not support bulk dequeue will set this as 1. 426 */ 427 uint32_t max_event_port_enqueue_depth; 428 /**< Maximum number of events can be enqueued at a time from an 429 * event port by this device. 430 * A device that does not support bulk enqueue will set this as 1. 431 */ 432 uint8_t max_event_port_links; 433 /**< Maximum number of queues that can be linked to a single event 434 * port by this device. 435 */ 436 int32_t max_num_events; 437 /**< A *closed system* event dev has a limit on the number of events it 438 * can manage at a time. An *open system* event dev does not have a 439 * limit and will specify this as -1. 440 */ 441 uint32_t event_dev_cap; 442 /**< Event device capabilities(RTE_EVENT_DEV_CAP_)*/ 443 uint8_t max_single_link_event_port_queue_pairs; 444 /**< Maximum number of event ports and queues that are optimized for 445 * (and only capable of) single-link configurations supported by this 446 * device. These ports and queues are not accounted for in 447 * max_event_ports or max_event_queues. 448 */ 449 }; 450 451 /** 452 * Retrieve the contextual information of an event device. 453 * 454 * @param dev_id 455 * The identifier of the device. 456 * 457 * @param[out] dev_info 458 * A pointer to a structure of type *rte_event_dev_info* to be filled with the 459 * contextual information of the device. 460 * 461 * @return 462 * - 0: Success, driver updates the contextual information of the event device 463 * - <0: Error code returned by the driver info get function. 464 */ 465 int 466 rte_event_dev_info_get(uint8_t dev_id, struct rte_event_dev_info *dev_info); 467 468 /** 469 * The count of ports. 470 */ 471 #define RTE_EVENT_DEV_ATTR_PORT_COUNT 0 472 /** 473 * The count of queues. 474 */ 475 #define RTE_EVENT_DEV_ATTR_QUEUE_COUNT 1 476 /** 477 * The status of the device, zero for stopped, non-zero for started. 478 */ 479 #define RTE_EVENT_DEV_ATTR_STARTED 2 480 481 /** 482 * Get an attribute from a device. 483 * 484 * @param dev_id Eventdev id 485 * @param attr_id The attribute ID to retrieve 486 * @param[out] attr_value A pointer that will be filled in with the attribute 487 * value if successful. 488 * 489 * @return 490 * - 0: Successfully retrieved attribute value 491 * - -EINVAL: Invalid device or *attr_id* provided, or *attr_value* is NULL 492 */ 493 int 494 rte_event_dev_attr_get(uint8_t dev_id, uint32_t attr_id, 495 uint32_t *attr_value); 496 497 498 /* Event device configuration bitmap flags */ 499 #define RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT (1ULL << 0) 500 /**< Override the global *dequeue_timeout_ns* and use per dequeue timeout in ns. 501 * @see rte_event_dequeue_timeout_ticks(), rte_event_dequeue_burst() 502 */ 503 504 /** Event device configuration structure */ 505 struct rte_event_dev_config { 506 uint32_t dequeue_timeout_ns; 507 /**< rte_event_dequeue_burst() timeout on this device. 508 * This value should be in the range of *min_dequeue_timeout_ns* and 509 * *max_dequeue_timeout_ns* which previously provided in 510 * rte_event_dev_info_get() 511 * The value 0 is allowed, in which case, default dequeue timeout used. 512 * @see RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 513 */ 514 int32_t nb_events_limit; 515 /**< In a *closed system* this field is the limit on maximum number of 516 * events that can be inflight in the eventdev at a given time. The 517 * limit is required to ensure that the finite space in a closed system 518 * is not overwhelmed. The value cannot exceed the *max_num_events* 519 * as provided by rte_event_dev_info_get(). 520 * This value should be set to -1 for *open system*. 521 */ 522 uint8_t nb_event_queues; 523 /**< Number of event queues to configure on this device. 524 * This value cannot exceed the *max_event_queues* which previously 525 * provided in rte_event_dev_info_get() 526 */ 527 uint8_t nb_event_ports; 528 /**< Number of event ports to configure on this device. 529 * This value cannot exceed the *max_event_ports* which previously 530 * provided in rte_event_dev_info_get() 531 */ 532 uint32_t nb_event_queue_flows; 533 /**< Number of flows for any event queue on this device. 534 * This value cannot exceed the *max_event_queue_flows* which previously 535 * provided in rte_event_dev_info_get() 536 */ 537 uint32_t nb_event_port_dequeue_depth; 538 /**< Maximum number of events can be dequeued at a time from an 539 * event port by this device. 540 * This value cannot exceed the *max_event_port_dequeue_depth* 541 * which previously provided in rte_event_dev_info_get(). 542 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 543 * @see rte_event_port_setup() 544 */ 545 uint32_t nb_event_port_enqueue_depth; 546 /**< Maximum number of events can be enqueued at a time from an 547 * event port by this device. 548 * This value cannot exceed the *max_event_port_enqueue_depth* 549 * which previously provided in rte_event_dev_info_get(). 550 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 551 * @see rte_event_port_setup() 552 */ 553 uint32_t event_dev_cfg; 554 /**< Event device config flags(RTE_EVENT_DEV_CFG_)*/ 555 uint8_t nb_single_link_event_port_queues; 556 /**< Number of event ports and queues that will be singly-linked to 557 * each other. These are a subset of the overall event ports and 558 * queues; this value cannot exceed *nb_event_ports* or 559 * *nb_event_queues*. If the device has ports and queues that are 560 * optimized for single-link usage, this field is a hint for how many 561 * to allocate; otherwise, regular event ports and queues can be used. 562 */ 563 }; 564 565 /** 566 * Configure an event device. 567 * 568 * This function must be invoked first before any other function in the 569 * API. This function can also be re-invoked when a device is in the 570 * stopped state. 571 * 572 * The caller may use rte_event_dev_info_get() to get the capability of each 573 * resources available for this event device. 574 * 575 * @param dev_id 576 * The identifier of the device to configure. 577 * @param dev_conf 578 * The event device configuration structure. 579 * 580 * @return 581 * - 0: Success, device configured. 582 * - <0: Error code returned by the driver configuration function. 583 */ 584 int 585 rte_event_dev_configure(uint8_t dev_id, 586 const struct rte_event_dev_config *dev_conf); 587 588 /* Event queue specific APIs */ 589 590 /* Event queue configuration bitmap flags */ 591 #define RTE_EVENT_QUEUE_CFG_ALL_TYPES (1ULL << 0) 592 /**< Allow ATOMIC,ORDERED,PARALLEL schedule type enqueue 593 * 594 * @see RTE_SCHED_TYPE_ORDERED, RTE_SCHED_TYPE_ATOMIC, RTE_SCHED_TYPE_PARALLEL 595 * @see rte_event_enqueue_burst() 596 */ 597 #define RTE_EVENT_QUEUE_CFG_SINGLE_LINK (1ULL << 1) 598 /**< This event queue links only to a single event port. 599 * 600 * @see rte_event_port_setup(), rte_event_port_link() 601 */ 602 603 /** Event queue configuration structure */ 604 struct rte_event_queue_conf { 605 uint32_t nb_atomic_flows; 606 /**< The maximum number of active flows this queue can track at any 607 * given time. If the queue is configured for atomic scheduling (by 608 * applying the RTE_EVENT_QUEUE_CFG_ALL_TYPES flag to event_queue_cfg 609 * or RTE_SCHED_TYPE_ATOMIC flag to schedule_type), then the 610 * value must be in the range of [1, nb_event_queue_flows], which was 611 * previously provided in rte_event_dev_configure(). 612 */ 613 uint32_t nb_atomic_order_sequences; 614 /**< The maximum number of outstanding events waiting to be 615 * reordered by this queue. In other words, the number of entries in 616 * this queue’s reorder buffer.When the number of events in the 617 * reorder buffer reaches to *nb_atomic_order_sequences* then the 618 * scheduler cannot schedule the events from this queue and invalid 619 * event will be returned from dequeue until one or more entries are 620 * freed up/released. 621 * If the queue is configured for ordered scheduling (by applying the 622 * RTE_EVENT_QUEUE_CFG_ALL_TYPES flag to event_queue_cfg or 623 * RTE_SCHED_TYPE_ORDERED flag to schedule_type), then the value must 624 * be in the range of [1, nb_event_queue_flows], which was 625 * previously supplied to rte_event_dev_configure(). 626 */ 627 uint32_t event_queue_cfg; 628 /**< Queue cfg flags(EVENT_QUEUE_CFG_) */ 629 uint8_t schedule_type; 630 /**< Queue schedule type(RTE_SCHED_TYPE_*). 631 * Valid when RTE_EVENT_QUEUE_CFG_ALL_TYPES bit is not set in 632 * event_queue_cfg. 633 */ 634 uint8_t priority; 635 /**< Priority for this event queue relative to other event queues. 636 * The requested priority should in the range of 637 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 638 * The implementation shall normalize the requested priority to 639 * event device supported priority value. 640 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability 641 */ 642 uint8_t weight; 643 /**< Weight of the event queue relative to other event queues. 644 * The requested weight should be in the range of 645 * [RTE_EVENT_DEV_WEIGHT_HIGHEST, RTE_EVENT_DEV_WEIGHT_LOWEST]. 646 * The implementation shall normalize the requested weight to event 647 * device supported weight value. 648 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability. 649 */ 650 uint8_t affinity; 651 /**< Affinity of the event queue relative to other event queues. 652 * The requested affinity should be in the range of 653 * [RTE_EVENT_DEV_AFFINITY_HIGHEST, RTE_EVENT_DEV_AFFINITY_LOWEST]. 654 * The implementation shall normalize the requested affinity to event 655 * device supported affinity value. 656 * Valid when the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability. 657 */ 658 }; 659 660 /** 661 * Retrieve the default configuration information of an event queue designated 662 * by its *queue_id* from the event driver for an event device. 663 * 664 * This function intended to be used in conjunction with rte_event_queue_setup() 665 * where caller needs to set up the queue by overriding few default values. 666 * 667 * @param dev_id 668 * The identifier of the device. 669 * @param queue_id 670 * The index of the event queue to get the configuration information. 671 * The value must be in the range [0, nb_event_queues - 1] 672 * previously supplied to rte_event_dev_configure(). 673 * @param[out] queue_conf 674 * The pointer to the default event queue configuration data. 675 * @return 676 * - 0: Success, driver updates the default event queue configuration data. 677 * - <0: Error code returned by the driver info get function. 678 * 679 * @see rte_event_queue_setup() 680 */ 681 int 682 rte_event_queue_default_conf_get(uint8_t dev_id, uint8_t queue_id, 683 struct rte_event_queue_conf *queue_conf); 684 685 /** 686 * Allocate and set up an event queue for an event device. 687 * 688 * @param dev_id 689 * The identifier of the device. 690 * @param queue_id 691 * The index of the event queue to setup. The value must be in the range 692 * [0, nb_event_queues - 1] previously supplied to rte_event_dev_configure(). 693 * @param queue_conf 694 * The pointer to the configuration data to be used for the event queue. 695 * NULL value is allowed, in which case default configuration used. 696 * 697 * @see rte_event_queue_default_conf_get() 698 * 699 * @return 700 * - 0: Success, event queue correctly set up. 701 * - <0: event queue configuration failed 702 */ 703 int 704 rte_event_queue_setup(uint8_t dev_id, uint8_t queue_id, 705 const struct rte_event_queue_conf *queue_conf); 706 707 /** 708 * The priority of the queue. 709 */ 710 #define RTE_EVENT_QUEUE_ATTR_PRIORITY 0 711 /** 712 * The number of atomic flows configured for the queue. 713 */ 714 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_FLOWS 1 715 /** 716 * The number of atomic order sequences configured for the queue. 717 */ 718 #define RTE_EVENT_QUEUE_ATTR_NB_ATOMIC_ORDER_SEQUENCES 2 719 /** 720 * The cfg flags for the queue. 721 */ 722 #define RTE_EVENT_QUEUE_ATTR_EVENT_QUEUE_CFG 3 723 /** 724 * The schedule type of the queue. 725 */ 726 #define RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE 4 727 /** 728 * The weight of the queue. 729 */ 730 #define RTE_EVENT_QUEUE_ATTR_WEIGHT 5 731 /** 732 * Affinity of the queue. 733 */ 734 #define RTE_EVENT_QUEUE_ATTR_AFFINITY 6 735 736 /** 737 * Get an attribute from a queue. 738 * 739 * @param dev_id 740 * Eventdev id 741 * @param queue_id 742 * Eventdev queue id 743 * @param attr_id 744 * The attribute ID to retrieve 745 * @param[out] attr_value 746 * A pointer that will be filled in with the attribute value if successful 747 * 748 * @return 749 * - 0: Successfully returned value 750 * - -EINVAL: invalid device, queue or attr_id provided, or attr_value was 751 * NULL 752 * - -EOVERFLOW: returned when attr_id is set to 753 * RTE_EVENT_QUEUE_ATTR_SCHEDULE_TYPE and event_queue_cfg is set to 754 * RTE_EVENT_QUEUE_CFG_ALL_TYPES 755 */ 756 int 757 rte_event_queue_attr_get(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, 758 uint32_t *attr_value); 759 760 /** 761 * Set an event queue attribute. 762 * 763 * @param dev_id 764 * Eventdev id 765 * @param queue_id 766 * Eventdev queue id 767 * @param attr_id 768 * The attribute ID to set 769 * @param attr_value 770 * The attribute value to set 771 * 772 * @return 773 * - 0: Successfully set attribute. 774 * - -EINVAL: invalid device, queue or attr_id. 775 * - -ENOTSUP: device does not support setting the event attribute. 776 * - <0: failed to set event queue attribute 777 */ 778 __rte_experimental 779 int 780 rte_event_queue_attr_set(uint8_t dev_id, uint8_t queue_id, uint32_t attr_id, 781 uint64_t attr_value); 782 783 /* Event port specific APIs */ 784 785 /* Event port configuration bitmap flags */ 786 #define RTE_EVENT_PORT_CFG_DISABLE_IMPL_REL (1ULL << 0) 787 /**< Configure the port not to release outstanding events in 788 * rte_event_dev_dequeue_burst(). If set, all events received through 789 * the port must be explicitly released with RTE_EVENT_OP_RELEASE or 790 * RTE_EVENT_OP_FORWARD. Must be unset if the device is not 791 * RTE_EVENT_DEV_CAP_IMPLICIT_RELEASE_DISABLE capable. 792 */ 793 #define RTE_EVENT_PORT_CFG_SINGLE_LINK (1ULL << 1) 794 /**< This event port links only to a single event queue. 795 * 796 * @see rte_event_port_setup(), rte_event_port_link() 797 */ 798 #define RTE_EVENT_PORT_CFG_HINT_PRODUCER (1ULL << 2) 799 /**< Hint that this event port will primarily enqueue events to the system. 800 * A PMD can optimize its internal workings by assuming that this port is 801 * primarily going to enqueue NEW events. 802 * 803 * Note that this flag is only a hint, so PMDs must operate under the 804 * assumption that any port can enqueue an event with any type of op. 805 * 806 * @see rte_event_port_setup() 807 */ 808 #define RTE_EVENT_PORT_CFG_HINT_CONSUMER (1ULL << 3) 809 /**< Hint that this event port will primarily dequeue events from the system. 810 * A PMD can optimize its internal workings by assuming that this port is 811 * primarily going to consume events, and not enqueue FORWARD or RELEASE 812 * events. 813 * 814 * Note that this flag is only a hint, so PMDs must operate under the 815 * assumption that any port can enqueue an event with any type of op. 816 * 817 * @see rte_event_port_setup() 818 */ 819 #define RTE_EVENT_PORT_CFG_HINT_WORKER (1ULL << 4) 820 /**< Hint that this event port will primarily pass existing events through. 821 * A PMD can optimize its internal workings by assuming that this port is 822 * primarily going to FORWARD events, and not enqueue NEW or RELEASE events 823 * often. 824 * 825 * Note that this flag is only a hint, so PMDs must operate under the 826 * assumption that any port can enqueue an event with any type of op. 827 * 828 * @see rte_event_port_setup() 829 */ 830 831 /** Event port configuration structure */ 832 struct rte_event_port_conf { 833 int32_t new_event_threshold; 834 /**< A backpressure threshold for new event enqueues on this port. 835 * Use for *closed system* event dev where event capacity is limited, 836 * and cannot exceed the capacity of the event dev. 837 * Configuring ports with different thresholds can make higher priority 838 * traffic less likely to be backpressured. 839 * For example, a port used to inject NIC Rx packets into the event dev 840 * can have a lower threshold so as not to overwhelm the device, 841 * while ports used for worker pools can have a higher threshold. 842 * This value cannot exceed the *nb_events_limit* 843 * which was previously supplied to rte_event_dev_configure(). 844 * This should be set to '-1' for *open system*. 845 */ 846 uint16_t dequeue_depth; 847 /**< Configure number of bulk dequeues for this event port. 848 * This value cannot exceed the *nb_event_port_dequeue_depth* 849 * which previously supplied to rte_event_dev_configure(). 850 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 851 */ 852 uint16_t enqueue_depth; 853 /**< Configure number of bulk enqueues for this event port. 854 * This value cannot exceed the *nb_event_port_enqueue_depth* 855 * which previously supplied to rte_event_dev_configure(). 856 * Ignored when device is not RTE_EVENT_DEV_CAP_BURST_MODE capable. 857 */ 858 uint32_t event_port_cfg; /**< Port cfg flags(EVENT_PORT_CFG_) */ 859 }; 860 861 /** 862 * Retrieve the default configuration information of an event port designated 863 * by its *port_id* from the event driver for an event device. 864 * 865 * This function intended to be used in conjunction with rte_event_port_setup() 866 * where caller needs to set up the port by overriding few default values. 867 * 868 * @param dev_id 869 * The identifier of the device. 870 * @param port_id 871 * The index of the event port to get the configuration information. 872 * The value must be in the range [0, nb_event_ports - 1] 873 * previously supplied to rte_event_dev_configure(). 874 * @param[out] port_conf 875 * The pointer to the default event port configuration data 876 * @return 877 * - 0: Success, driver updates the default event port configuration data. 878 * - <0: Error code returned by the driver info get function. 879 * 880 * @see rte_event_port_setup() 881 */ 882 int 883 rte_event_port_default_conf_get(uint8_t dev_id, uint8_t port_id, 884 struct rte_event_port_conf *port_conf); 885 886 /** 887 * Allocate and set up an event port for an event device. 888 * 889 * @param dev_id 890 * The identifier of the device. 891 * @param port_id 892 * The index of the event port to setup. The value must be in the range 893 * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure(). 894 * @param port_conf 895 * The pointer to the configuration data to be used for the queue. 896 * NULL value is allowed, in which case default configuration used. 897 * 898 * @see rte_event_port_default_conf_get() 899 * 900 * @return 901 * - 0: Success, event port correctly set up. 902 * - <0: Port configuration failed 903 * - (-EDQUOT) Quota exceeded(Application tried to link the queue configured 904 * with RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 905 */ 906 int 907 rte_event_port_setup(uint8_t dev_id, uint8_t port_id, 908 const struct rte_event_port_conf *port_conf); 909 910 typedef void (*rte_eventdev_port_flush_t)(uint8_t dev_id, 911 struct rte_event event, void *arg); 912 /**< Callback function prototype that can be passed during 913 * rte_event_port_release(), invoked once per a released event. 914 */ 915 916 /** 917 * Quiesce any core specific resources consumed by the event port. 918 * 919 * Event ports are generally coupled with lcores, and a given Hardware 920 * implementation might require the PMD to store port specific data in the 921 * lcore. 922 * When the application decides to migrate the event port to another lcore 923 * or teardown the current lcore it may to call `rte_event_port_quiesce` 924 * to make sure that all the data associated with the event port are released 925 * from the lcore, this might also include any prefetched events. 926 * While releasing the event port from the lcore, this function calls the 927 * user-provided flush callback once per event. 928 * 929 * @note Invocation of this API does not affect the existing port configuration. 930 * 931 * @param dev_id 932 * The identifier of the device. 933 * @param port_id 934 * The index of the event port to setup. The value must be in the range 935 * [0, nb_event_ports - 1] previously supplied to rte_event_dev_configure(). 936 * @param release_cb 937 * Callback function invoked once per flushed event. 938 * @param args 939 * Argument supplied to callback. 940 */ 941 __rte_experimental 942 void 943 rte_event_port_quiesce(uint8_t dev_id, uint8_t port_id, 944 rte_eventdev_port_flush_t release_cb, void *args); 945 946 /** 947 * The queue depth of the port on the enqueue side 948 */ 949 #define RTE_EVENT_PORT_ATTR_ENQ_DEPTH 0 950 /** 951 * The queue depth of the port on the dequeue side 952 */ 953 #define RTE_EVENT_PORT_ATTR_DEQ_DEPTH 1 954 /** 955 * The new event threshold of the port 956 */ 957 #define RTE_EVENT_PORT_ATTR_NEW_EVENT_THRESHOLD 2 958 /** 959 * The implicit release disable attribute of the port 960 */ 961 #define RTE_EVENT_PORT_ATTR_IMPLICIT_RELEASE_DISABLE 3 962 963 /** 964 * Get an attribute from a port. 965 * 966 * @param dev_id 967 * Eventdev id 968 * @param port_id 969 * Eventdev port id 970 * @param attr_id 971 * The attribute ID to retrieve 972 * @param[out] attr_value 973 * A pointer that will be filled in with the attribute value if successful 974 * 975 * @return 976 * - 0: Successfully returned value 977 * - (-EINVAL) Invalid device, port or attr_id, or attr_value was NULL 978 */ 979 int 980 rte_event_port_attr_get(uint8_t dev_id, uint8_t port_id, uint32_t attr_id, 981 uint32_t *attr_value); 982 983 /** 984 * Start an event device. 985 * 986 * The device start step is the last one and consists of setting the event 987 * queues to start accepting the events and schedules to event ports. 988 * 989 * On success, all basic functions exported by the API (event enqueue, 990 * event dequeue and so on) can be invoked. 991 * 992 * @param dev_id 993 * Event device identifier 994 * @return 995 * - 0: Success, device started. 996 * - -ESTALE : Not all ports of the device are configured 997 * - -ENOLINK: Not all queues are linked, which could lead to deadlock. 998 */ 999 int 1000 rte_event_dev_start(uint8_t dev_id); 1001 1002 /** 1003 * Stop an event device. 1004 * 1005 * This function causes all queued events to be drained, including those 1006 * residing in event ports. While draining events out of the device, this 1007 * function calls the user-provided flush callback (if one was registered) once 1008 * per event. 1009 * 1010 * The device can be restarted with a call to rte_event_dev_start(). Threads 1011 * that continue to enqueue/dequeue while the device is stopped, or being 1012 * stopped, will result in undefined behavior. This includes event adapters, 1013 * which must be stopped prior to stopping the eventdev. 1014 * 1015 * @param dev_id 1016 * Event device identifier. 1017 * 1018 * @see rte_event_dev_stop_flush_callback_register() 1019 */ 1020 void 1021 rte_event_dev_stop(uint8_t dev_id); 1022 1023 typedef void (*rte_eventdev_stop_flush_t)(uint8_t dev_id, 1024 struct rte_event event, void *arg); 1025 /**< Callback function called during rte_event_dev_stop(), invoked once per 1026 * flushed event. 1027 */ 1028 1029 /** 1030 * Registers a callback function to be invoked during rte_event_dev_stop() for 1031 * each flushed event. This function can be used to properly dispose of queued 1032 * events, for example events containing memory pointers. 1033 * 1034 * The callback function is only registered for the calling process. The 1035 * callback function must be registered in every process that can call 1036 * rte_event_dev_stop(). 1037 * 1038 * To unregister a callback, call this function with a NULL callback pointer. 1039 * 1040 * @param dev_id 1041 * The identifier of the device. 1042 * @param callback 1043 * Callback function invoked once per flushed event. 1044 * @param userdata 1045 * Argument supplied to callback. 1046 * 1047 * @return 1048 * - 0 on success. 1049 * - -EINVAL if *dev_id* is invalid 1050 * 1051 * @see rte_event_dev_stop() 1052 */ 1053 int rte_event_dev_stop_flush_callback_register(uint8_t dev_id, 1054 rte_eventdev_stop_flush_t callback, void *userdata); 1055 1056 /** 1057 * Close an event device. The device cannot be restarted! 1058 * 1059 * @param dev_id 1060 * Event device identifier 1061 * 1062 * @return 1063 * - 0 on successfully closing device 1064 * - <0 on failure to close device 1065 * - (-EAGAIN) if device is busy 1066 */ 1067 int 1068 rte_event_dev_close(uint8_t dev_id); 1069 1070 /** 1071 * Event vector structure. 1072 */ 1073 struct rte_event_vector { 1074 uint16_t nb_elem; 1075 /**< Number of elements valid in this event vector. */ 1076 uint16_t elem_offset : 12; 1077 /**< Offset into the vector array where valid elements start from. */ 1078 uint16_t rsvd : 3; 1079 /**< Reserved for future use */ 1080 uint16_t attr_valid : 1; 1081 /**< Indicates that the below union attributes have valid information. 1082 */ 1083 union { 1084 /* Used by Rx/Tx adapter. 1085 * Indicates that all the elements in this vector belong to the 1086 * same port and queue pair when originating from Rx adapter, 1087 * valid only when event type is ETHDEV_VECTOR or 1088 * ETH_RX_ADAPTER_VECTOR. 1089 * Can also be used to indicate the Tx adapter the destination 1090 * port and queue of the mbufs in the vector 1091 */ 1092 struct { 1093 uint16_t port; 1094 /* Ethernet device port id. */ 1095 uint16_t queue; 1096 /* Ethernet device queue id. */ 1097 }; 1098 }; 1099 /**< Union to hold common attributes of the vector array. */ 1100 uint64_t impl_opaque; 1101 1102 /* empty structures do not have zero size in C++ leading to compilation errors 1103 * with clang about structure having different sizes in C and C++. 1104 * Since these are all zero-sized arrays, we can omit the "union" wrapper for 1105 * C++ builds, removing the warning. 1106 */ 1107 #ifndef __cplusplus 1108 /**< Implementation specific opaque value. 1109 * An implementation may use this field to hold implementation specific 1110 * value to share between dequeue and enqueue operation. 1111 * The application should not modify this field. 1112 */ 1113 union { 1114 #endif 1115 struct rte_mbuf *mbufs[0]; 1116 void *ptrs[0]; 1117 uint64_t u64s[0]; 1118 #ifndef __cplusplus 1119 } __rte_aligned(16); 1120 #endif 1121 /**< Start of the vector array union. Depending upon the event type the 1122 * vector array can be an array of mbufs or pointers or opaque u64 1123 * values. 1124 */ 1125 } __rte_aligned(16); 1126 1127 /* Scheduler type definitions */ 1128 #define RTE_SCHED_TYPE_ORDERED 0 1129 /**< Ordered scheduling 1130 * 1131 * Events from an ordered flow of an event queue can be scheduled to multiple 1132 * ports for concurrent processing while maintaining the original event order. 1133 * This scheme enables the user to achieve high single flow throughput by 1134 * avoiding SW synchronization for ordering between ports which bound to cores. 1135 * 1136 * The source flow ordering from an event queue is maintained when events are 1137 * enqueued to their destination queue within the same ordered flow context. 1138 * An event port holds the context until application call 1139 * rte_event_dequeue_burst() from the same port, which implicitly releases 1140 * the context. 1141 * User may allow the scheduler to release the context earlier than that 1142 * by invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE operation. 1143 * 1144 * Events from the source queue appear in their original order when dequeued 1145 * from a destination queue. 1146 * Event ordering is based on the received event(s), but also other 1147 * (newly allocated or stored) events are ordered when enqueued within the same 1148 * ordered context. Events not enqueued (e.g. released or stored) within the 1149 * context are considered missing from reordering and are skipped at this time 1150 * (but can be ordered again within another context). 1151 * 1152 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE 1153 */ 1154 1155 #define RTE_SCHED_TYPE_ATOMIC 1 1156 /**< Atomic scheduling 1157 * 1158 * Events from an atomic flow of an event queue can be scheduled only to a 1159 * single port at a time. The port is guaranteed to have exclusive (atomic) 1160 * access to the associated flow context, which enables the user to avoid SW 1161 * synchronization. Atomic flows also help to maintain event ordering 1162 * since only one port at a time can process events from a flow of an 1163 * event queue. 1164 * 1165 * The atomic queue synchronization context is dedicated to the port until 1166 * application call rte_event_dequeue_burst() from the same port, 1167 * which implicitly releases the context. User may allow the scheduler to 1168 * release the context earlier than that by invoking rte_event_enqueue_burst() 1169 * with RTE_EVENT_OP_RELEASE operation. 1170 * 1171 * @see rte_event_queue_setup(), rte_event_dequeue_burst(), RTE_EVENT_OP_RELEASE 1172 */ 1173 1174 #define RTE_SCHED_TYPE_PARALLEL 2 1175 /**< Parallel scheduling 1176 * 1177 * The scheduler performs priority scheduling, load balancing, etc. functions 1178 * but does not provide additional event synchronization or ordering. 1179 * It is free to schedule events from a single parallel flow of an event queue 1180 * to multiple events ports for concurrent processing. 1181 * The application is responsible for flow context synchronization and 1182 * event ordering (SW synchronization). 1183 * 1184 * @see rte_event_queue_setup(), rte_event_dequeue_burst() 1185 */ 1186 1187 /* Event types to classify the event source */ 1188 #define RTE_EVENT_TYPE_ETHDEV 0x0 1189 /**< The event generated from ethdev subsystem */ 1190 #define RTE_EVENT_TYPE_CRYPTODEV 0x1 1191 /**< The event generated from crypodev subsystem */ 1192 #define RTE_EVENT_TYPE_TIMER 0x2 1193 /**< The event generated from event timer adapter */ 1194 #define RTE_EVENT_TYPE_CPU 0x3 1195 /**< The event generated from cpu for pipelining. 1196 * Application may use *sub_event_type* to further classify the event 1197 */ 1198 #define RTE_EVENT_TYPE_ETH_RX_ADAPTER 0x4 1199 /**< The event generated from event eth Rx adapter */ 1200 #define RTE_EVENT_TYPE_VECTOR 0x8 1201 /**< Indicates that event is a vector. 1202 * All vector event types should be a logical OR of EVENT_TYPE_VECTOR. 1203 * This simplifies the pipeline design as one can split processing the events 1204 * between vector events and normal event across event types. 1205 * Example: 1206 * if (ev.event_type & RTE_EVENT_TYPE_VECTOR) { 1207 * // Classify and handle vector event. 1208 * } else { 1209 * // Classify and handle event. 1210 * } 1211 */ 1212 #define RTE_EVENT_TYPE_ETHDEV_VECTOR \ 1213 (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_ETHDEV) 1214 /**< The event vector generated from ethdev subsystem */ 1215 #define RTE_EVENT_TYPE_CPU_VECTOR (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_CPU) 1216 /**< The event vector generated from cpu for pipelining. */ 1217 #define RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR \ 1218 (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_ETH_RX_ADAPTER) 1219 /**< The event vector generated from eth Rx adapter. */ 1220 #define RTE_EVENT_TYPE_CRYPTODEV_VECTOR \ 1221 (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_CRYPTODEV) 1222 /**< The event vector generated from cryptodev adapter. */ 1223 1224 #define RTE_EVENT_TYPE_MAX 0x10 1225 /**< Maximum number of event types */ 1226 1227 /* Event enqueue operations */ 1228 #define RTE_EVENT_OP_NEW 0 1229 /**< The event producers use this operation to inject a new event to the 1230 * event device. 1231 */ 1232 #define RTE_EVENT_OP_FORWARD 1 1233 /**< The CPU use this operation to forward the event to different event queue or 1234 * change to new application specific flow or schedule type to enable 1235 * pipelining. 1236 * 1237 * This operation must only be enqueued to the same port that the 1238 * event to be forwarded was dequeued from. 1239 */ 1240 #define RTE_EVENT_OP_RELEASE 2 1241 /**< Release the flow context associated with the schedule type. 1242 * 1243 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ATOMIC* 1244 * then this function hints the scheduler that the user has completed critical 1245 * section processing in the current atomic context. 1246 * The scheduler is now allowed to schedule events from the same flow from 1247 * an event queue to another port. However, the context may be still held 1248 * until the next rte_event_dequeue_burst() call, this call allows but does not 1249 * force the scheduler to release the context early. 1250 * 1251 * Early atomic context release may increase parallelism and thus system 1252 * performance, but the user needs to design carefully the split into critical 1253 * vs non-critical sections. 1254 * 1255 * If current flow's scheduler type method is *RTE_SCHED_TYPE_ORDERED* 1256 * then this function hints the scheduler that the user has done all that need 1257 * to maintain event order in the current ordered context. 1258 * The scheduler is allowed to release the ordered context of this port and 1259 * avoid reordering any following enqueues. 1260 * 1261 * Early ordered context release may increase parallelism and thus system 1262 * performance. 1263 * 1264 * If current flow's scheduler type method is *RTE_SCHED_TYPE_PARALLEL* 1265 * or no scheduling context is held then this function may be an NOOP, 1266 * depending on the implementation. 1267 * 1268 * This operation must only be enqueued to the same port that the 1269 * event to be released was dequeued from. 1270 */ 1271 1272 /** 1273 * The generic *rte_event* structure to hold the event attributes 1274 * for dequeue and enqueue operation 1275 */ 1276 RTE_STD_C11 1277 struct rte_event { 1278 /** WORD0 */ 1279 union { 1280 uint64_t event; 1281 /** Event attributes for dequeue or enqueue operation */ 1282 struct { 1283 uint32_t flow_id:20; 1284 /**< Targeted flow identifier for the enqueue and 1285 * dequeue operation. 1286 * The value must be in the range of 1287 * [0, nb_event_queue_flows - 1] which 1288 * previously supplied to rte_event_dev_configure(). 1289 */ 1290 uint32_t sub_event_type:8; 1291 /**< Sub-event types based on the event source. 1292 * @see RTE_EVENT_TYPE_CPU 1293 */ 1294 uint32_t event_type:4; 1295 /**< Event type to classify the event source. 1296 * @see RTE_EVENT_TYPE_ETHDEV, (RTE_EVENT_TYPE_*) 1297 */ 1298 uint8_t op:2; 1299 /**< The type of event enqueue operation - new/forward/ 1300 * etc.This field is not preserved across an instance 1301 * and is undefined on dequeue. 1302 * @see RTE_EVENT_OP_NEW, (RTE_EVENT_OP_*) 1303 */ 1304 uint8_t rsvd:4; 1305 /**< Reserved for future use */ 1306 uint8_t sched_type:2; 1307 /**< Scheduler synchronization type (RTE_SCHED_TYPE_*) 1308 * associated with flow id on a given event queue 1309 * for the enqueue and dequeue operation. 1310 */ 1311 uint8_t queue_id; 1312 /**< Targeted event queue identifier for the enqueue or 1313 * dequeue operation. 1314 * The value must be in the range of 1315 * [0, nb_event_queues - 1] which previously supplied to 1316 * rte_event_dev_configure(). 1317 */ 1318 uint8_t priority; 1319 /**< Event priority relative to other events in the 1320 * event queue. The requested priority should in the 1321 * range of [RTE_EVENT_DEV_PRIORITY_HIGHEST, 1322 * RTE_EVENT_DEV_PRIORITY_LOWEST]. 1323 * The implementation shall normalize the requested 1324 * priority to supported priority value. 1325 * Valid when the device has 1326 * RTE_EVENT_DEV_CAP_EVENT_QOS capability. 1327 */ 1328 uint8_t impl_opaque; 1329 /**< Implementation specific opaque value. 1330 * An implementation may use this field to hold 1331 * implementation specific value to share between 1332 * dequeue and enqueue operation. 1333 * The application should not modify this field. 1334 */ 1335 }; 1336 }; 1337 /** WORD1 */ 1338 union { 1339 uint64_t u64; 1340 /**< Opaque 64-bit value */ 1341 void *event_ptr; 1342 /**< Opaque event pointer */ 1343 struct rte_mbuf *mbuf; 1344 /**< mbuf pointer if dequeued event is associated with mbuf */ 1345 struct rte_event_vector *vec; 1346 /**< Event vector pointer. */ 1347 }; 1348 }; 1349 1350 /* Ethdev Rx adapter capability bitmap flags */ 1351 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT 0x1 1352 /**< This flag is sent when the packet transfer mechanism is in HW. 1353 * Ethdev can send packets to the event device using internal event port. 1354 */ 1355 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ 0x2 1356 /**< Adapter supports multiple event queues per ethdev. Every ethdev 1357 * Rx queue can be connected to a unique event queue. 1358 */ 1359 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_OVERRIDE_FLOW_ID 0x4 1360 /**< The application can override the adapter generated flow ID in the 1361 * event. This flow ID can be specified when adding an ethdev Rx queue 1362 * to the adapter using the ev.flow_id member. 1363 * @see struct rte_event_eth_rx_adapter_queue_conf::ev 1364 * @see struct rte_event_eth_rx_adapter_queue_conf::rx_queue_flags 1365 */ 1366 #define RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR 0x8 1367 /**< Adapter supports event vectorization per ethdev. */ 1368 1369 /** 1370 * Retrieve the event device's ethdev Rx adapter capabilities for the 1371 * specified ethernet port 1372 * 1373 * @param dev_id 1374 * The identifier of the device. 1375 * 1376 * @param eth_port_id 1377 * The identifier of the ethernet device. 1378 * 1379 * @param[out] caps 1380 * A pointer to memory filled with Rx event adapter capabilities. 1381 * 1382 * @return 1383 * - 0: Success, driver provides Rx event adapter capabilities for the 1384 * ethernet device. 1385 * - <0: Error code returned by the driver function. 1386 */ 1387 int 1388 rte_event_eth_rx_adapter_caps_get(uint8_t dev_id, uint16_t eth_port_id, 1389 uint32_t *caps); 1390 1391 #define RTE_EVENT_TIMER_ADAPTER_CAP_INTERNAL_PORT (1ULL << 0) 1392 /**< This flag is set when the timer mechanism is in HW. */ 1393 1394 #define RTE_EVENT_TIMER_ADAPTER_CAP_PERIODIC (1ULL << 1) 1395 /**< This flag is set if periodic mode is supported. */ 1396 1397 /** 1398 * Retrieve the event device's timer adapter capabilities. 1399 * 1400 * @param dev_id 1401 * The identifier of the device. 1402 * 1403 * @param[out] caps 1404 * A pointer to memory to be filled with event timer adapter capabilities. 1405 * 1406 * @return 1407 * - 0: Success, driver provided event timer adapter capabilities. 1408 * - <0: Error code returned by the driver function. 1409 */ 1410 int 1411 rte_event_timer_adapter_caps_get(uint8_t dev_id, uint32_t *caps); 1412 1413 /* Crypto adapter capability bitmap flag */ 1414 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_OP_NEW 0x1 1415 /**< Flag indicates HW is capable of generating events in 1416 * RTE_EVENT_OP_NEW enqueue operation. Cryptodev will send 1417 * packets to the event device as new events using an internal 1418 * event port. 1419 */ 1420 1421 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_OP_FWD 0x2 1422 /**< Flag indicates HW is capable of generating events in 1423 * RTE_EVENT_OP_FORWARD enqueue operation. Cryptodev will send 1424 * packets to the event device as forwarded event using an 1425 * internal event port. 1426 */ 1427 1428 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_INTERNAL_PORT_QP_EV_BIND 0x4 1429 /**< Flag indicates HW is capable of mapping crypto queue pair to 1430 * event queue. 1431 */ 1432 1433 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_SESSION_PRIVATE_DATA 0x8 1434 /**< Flag indicates HW/SW supports a mechanism to store and retrieve 1435 * the private data information along with the crypto session. 1436 */ 1437 1438 #define RTE_EVENT_CRYPTO_ADAPTER_CAP_EVENT_VECTOR 0x10 1439 /**< Flag indicates HW is capable of aggregating processed 1440 * crypto operations into rte_event_vector. 1441 */ 1442 1443 /** 1444 * Retrieve the event device's crypto adapter capabilities for the 1445 * specified cryptodev device 1446 * 1447 * @param dev_id 1448 * The identifier of the device. 1449 * 1450 * @param cdev_id 1451 * The identifier of the cryptodev device. 1452 * 1453 * @param[out] caps 1454 * A pointer to memory filled with event adapter capabilities. 1455 * It is expected to be pre-allocated & initialized by caller. 1456 * 1457 * @return 1458 * - 0: Success, driver provides event adapter capabilities for the 1459 * cryptodev device. 1460 * - <0: Error code returned by the driver function. 1461 */ 1462 int 1463 rte_event_crypto_adapter_caps_get(uint8_t dev_id, uint8_t cdev_id, 1464 uint32_t *caps); 1465 1466 /* Ethdev Tx adapter capability bitmap flags */ 1467 #define RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT 0x1 1468 /**< This flag is sent when the PMD supports a packet transmit callback 1469 */ 1470 #define RTE_EVENT_ETH_TX_ADAPTER_CAP_EVENT_VECTOR 0x2 1471 /**< Indicates that the Tx adapter is capable of handling event vector of 1472 * mbufs. 1473 */ 1474 1475 /** 1476 * Retrieve the event device's eth Tx adapter capabilities 1477 * 1478 * @param dev_id 1479 * The identifier of the device. 1480 * 1481 * @param eth_port_id 1482 * The identifier of the ethernet device. 1483 * 1484 * @param[out] caps 1485 * A pointer to memory filled with eth Tx adapter capabilities. 1486 * 1487 * @return 1488 * - 0: Success, driver provides eth Tx adapter capabilities. 1489 * - <0: Error code returned by the driver function. 1490 */ 1491 int 1492 rte_event_eth_tx_adapter_caps_get(uint8_t dev_id, uint16_t eth_port_id, 1493 uint32_t *caps); 1494 1495 /** 1496 * Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue_burst() 1497 * 1498 * If the device is configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT flag 1499 * then application can use this function to convert timeout value in 1500 * nanoseconds to implementations specific timeout value supplied in 1501 * rte_event_dequeue_burst() 1502 * 1503 * @param dev_id 1504 * The identifier of the device. 1505 * @param ns 1506 * Wait time in nanosecond 1507 * @param[out] timeout_ticks 1508 * Value for the *timeout_ticks* parameter in rte_event_dequeue_burst() 1509 * 1510 * @return 1511 * - 0 on success. 1512 * - -ENOTSUP if the device doesn't support timeouts 1513 * - -EINVAL if *dev_id* is invalid or *timeout_ticks* is NULL 1514 * - other values < 0 on failure. 1515 * 1516 * @see rte_event_dequeue_burst(), RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 1517 * @see rte_event_dev_configure() 1518 */ 1519 int 1520 rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns, 1521 uint64_t *timeout_ticks); 1522 1523 /** 1524 * Link multiple source event queues supplied in *queues* to the destination 1525 * event port designated by its *port_id* with associated service priority 1526 * supplied in *priorities* on the event device designated by its *dev_id*. 1527 * 1528 * The link establishment shall enable the event port *port_id* from 1529 * receiving events from the specified event queue(s) supplied in *queues* 1530 * 1531 * An event queue may link to one or more event ports. 1532 * The number of links can be established from an event queue to event port is 1533 * implementation defined. 1534 * 1535 * Event queue(s) to event port link establishment can be changed at runtime 1536 * without re-configuring the device to support scaling and to reduce the 1537 * latency of critical work by establishing the link with more event ports 1538 * at runtime. 1539 * 1540 * @param dev_id 1541 * The identifier of the device. 1542 * 1543 * @param port_id 1544 * Event port identifier to select the destination port to link. 1545 * 1546 * @param queues 1547 * Points to an array of *nb_links* event queues to be linked 1548 * to the event port. 1549 * NULL value is allowed, in which case this function links all the configured 1550 * event queues *nb_event_queues* which previously supplied to 1551 * rte_event_dev_configure() to the event port *port_id* 1552 * 1553 * @param priorities 1554 * Points to an array of *nb_links* service priorities associated with each 1555 * event queue link to event port. 1556 * The priority defines the event port's servicing priority for 1557 * event queue, which may be ignored by an implementation. 1558 * The requested priority should in the range of 1559 * [RTE_EVENT_DEV_PRIORITY_HIGHEST, RTE_EVENT_DEV_PRIORITY_LOWEST]. 1560 * The implementation shall normalize the requested priority to 1561 * implementation supported priority value. 1562 * NULL value is allowed, in which case this function links the event queues 1563 * with RTE_EVENT_DEV_PRIORITY_NORMAL servicing priority 1564 * 1565 * @param nb_links 1566 * The number of links to establish. This parameter is ignored if queues is 1567 * NULL. 1568 * 1569 * @return 1570 * The number of links actually established. The return value can be less than 1571 * the value of the *nb_links* parameter when the implementation has the 1572 * limitation on specific queue to port link establishment or if invalid 1573 * parameters are specified in *queues* 1574 * If the return value is less than *nb_links*, the remaining links at the end 1575 * of link[] are not established, and the caller has to take care of them. 1576 * If return value is less than *nb_links* then implementation shall update the 1577 * rte_errno accordingly, Possible rte_errno values are 1578 * (EDQUOT) Quota exceeded(Application tried to link the queue configured with 1579 * RTE_EVENT_QUEUE_CFG_SINGLE_LINK to more than one event ports) 1580 * (EINVAL) Invalid parameter 1581 */ 1582 int 1583 rte_event_port_link(uint8_t dev_id, uint8_t port_id, 1584 const uint8_t queues[], const uint8_t priorities[], 1585 uint16_t nb_links); 1586 1587 /** 1588 * Unlink multiple source event queues supplied in *queues* from the destination 1589 * event port designated by its *port_id* on the event device designated 1590 * by its *dev_id*. 1591 * 1592 * The unlink call issues an async request to disable the event port *port_id* 1593 * from receiving events from the specified event queue *queue_id*. 1594 * Event queue(s) to event port unlink establishment can be changed at runtime 1595 * without re-configuring the device. 1596 * 1597 * @see rte_event_port_unlinks_in_progress() to poll for completed unlinks. 1598 * 1599 * @param dev_id 1600 * The identifier of the device. 1601 * 1602 * @param port_id 1603 * Event port identifier to select the destination port to unlink. 1604 * 1605 * @param queues 1606 * Points to an array of *nb_unlinks* event queues to be unlinked 1607 * from the event port. 1608 * NULL value is allowed, in which case this function unlinks all the 1609 * event queue(s) from the event port *port_id*. 1610 * 1611 * @param nb_unlinks 1612 * The number of unlinks to establish. This parameter is ignored if queues is 1613 * NULL. 1614 * 1615 * @return 1616 * The number of unlinks successfully requested. The return value can be less 1617 * than the value of the *nb_unlinks* parameter when the implementation has the 1618 * limitation on specific queue to port unlink establishment or 1619 * if invalid parameters are specified. 1620 * If the return value is less than *nb_unlinks*, the remaining queues at the 1621 * end of queues[] are not unlinked, and the caller has to take care of them. 1622 * If return value is less than *nb_unlinks* then implementation shall update 1623 * the rte_errno accordingly, Possible rte_errno values are 1624 * (EINVAL) Invalid parameter 1625 */ 1626 int 1627 rte_event_port_unlink(uint8_t dev_id, uint8_t port_id, 1628 uint8_t queues[], uint16_t nb_unlinks); 1629 1630 /** 1631 * Returns the number of unlinks in progress. 1632 * 1633 * This function provides the application with a method to detect when an 1634 * unlink has been completed by the implementation. 1635 * 1636 * @see rte_event_port_unlink() to issue unlink requests. 1637 * 1638 * @param dev_id 1639 * The identifier of the device. 1640 * 1641 * @param port_id 1642 * Event port identifier to select port to check for unlinks in progress. 1643 * 1644 * @return 1645 * The number of unlinks that are in progress. A return of zero indicates that 1646 * there are no outstanding unlink requests. A positive return value indicates 1647 * the number of unlinks that are in progress, but are not yet complete. 1648 * A negative return value indicates an error, -EINVAL indicates an invalid 1649 * parameter passed for *dev_id* or *port_id*. 1650 */ 1651 int 1652 rte_event_port_unlinks_in_progress(uint8_t dev_id, uint8_t port_id); 1653 1654 /** 1655 * Retrieve the list of source event queues and its associated service priority 1656 * linked to the destination event port designated by its *port_id* 1657 * on the event device designated by its *dev_id*. 1658 * 1659 * @param dev_id 1660 * The identifier of the device. 1661 * 1662 * @param port_id 1663 * Event port identifier. 1664 * 1665 * @param[out] queues 1666 * Points to an array of *queues* for output. 1667 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 1668 * store the event queue(s) linked with event port *port_id* 1669 * 1670 * @param[out] priorities 1671 * Points to an array of *priorities* for output. 1672 * The caller has to allocate *RTE_EVENT_MAX_QUEUES_PER_DEV* bytes to 1673 * store the service priority associated with each event queue linked 1674 * 1675 * @return 1676 * The number of links established on the event port designated by its 1677 * *port_id*. 1678 * - <0 on failure. 1679 */ 1680 int 1681 rte_event_port_links_get(uint8_t dev_id, uint8_t port_id, 1682 uint8_t queues[], uint8_t priorities[]); 1683 1684 /** 1685 * Retrieve the service ID of the event dev. If the adapter doesn't use 1686 * a rte_service function, this function returns -ESRCH. 1687 * 1688 * @param dev_id 1689 * The identifier of the device. 1690 * 1691 * @param [out] service_id 1692 * A pointer to a uint32_t, to be filled in with the service id. 1693 * 1694 * @return 1695 * - 0: Success 1696 * - <0: Error code on failure, if the event dev doesn't use a rte_service 1697 * function, this function returns -ESRCH. 1698 */ 1699 int 1700 rte_event_dev_service_id_get(uint8_t dev_id, uint32_t *service_id); 1701 1702 /** 1703 * Dump internal information about *dev_id* to the FILE* provided in *f*. 1704 * 1705 * @param dev_id 1706 * The identifier of the device. 1707 * 1708 * @param f 1709 * A pointer to a file for output 1710 * 1711 * @return 1712 * - 0: on success 1713 * - <0: on failure. 1714 */ 1715 int 1716 rte_event_dev_dump(uint8_t dev_id, FILE *f); 1717 1718 /** Maximum name length for extended statistics counters */ 1719 #define RTE_EVENT_DEV_XSTATS_NAME_SIZE 64 1720 1721 /** 1722 * Selects the component of the eventdev to retrieve statistics from. 1723 */ 1724 enum rte_event_dev_xstats_mode { 1725 RTE_EVENT_DEV_XSTATS_DEVICE, 1726 RTE_EVENT_DEV_XSTATS_PORT, 1727 RTE_EVENT_DEV_XSTATS_QUEUE, 1728 }; 1729 1730 /** 1731 * A name-key lookup element for extended statistics. 1732 * 1733 * This structure is used to map between names and ID numbers 1734 * for extended ethdev statistics. 1735 */ 1736 struct rte_event_dev_xstats_name { 1737 char name[RTE_EVENT_DEV_XSTATS_NAME_SIZE]; 1738 }; 1739 1740 /** 1741 * Retrieve names of extended statistics of an event device. 1742 * 1743 * @param dev_id 1744 * The identifier of the event device. 1745 * @param mode 1746 * The mode of statistics to retrieve. Choices include the device statistics, 1747 * port statistics or queue statistics. 1748 * @param queue_port_id 1749 * Used to specify the port or queue number in queue or port mode, and is 1750 * ignored in device mode. 1751 * @param[out] xstats_names 1752 * Block of memory to insert names into. Must be at least size in capacity. 1753 * If set to NULL, function returns required capacity. 1754 * @param[out] ids 1755 * Block of memory to insert ids into. Must be at least size in capacity. 1756 * If set to NULL, function returns required capacity. The id values returned 1757 * can be passed to *rte_event_dev_xstats_get* to select statistics. 1758 * @param size 1759 * Capacity of xstats_names (number of names). 1760 * @return 1761 * - positive value lower or equal to size: success. The return value 1762 * is the number of entries filled in the stats table. 1763 * - positive value higher than size: error, the given statistics table 1764 * is too small. The return value corresponds to the size that should 1765 * be given to succeed. The entries in the table are not valid and 1766 * shall not be used by the caller. 1767 * - negative value on error: 1768 * -ENODEV for invalid *dev_id* 1769 * -EINVAL for invalid mode, queue port or id parameters 1770 * -ENOTSUP if the device doesn't support this function. 1771 */ 1772 int 1773 rte_event_dev_xstats_names_get(uint8_t dev_id, 1774 enum rte_event_dev_xstats_mode mode, 1775 uint8_t queue_port_id, 1776 struct rte_event_dev_xstats_name *xstats_names, 1777 uint64_t *ids, 1778 unsigned int size); 1779 1780 /** 1781 * Retrieve extended statistics of an event device. 1782 * 1783 * @param dev_id 1784 * The identifier of the device. 1785 * @param mode 1786 * The mode of statistics to retrieve. Choices include the device statistics, 1787 * port statistics or queue statistics. 1788 * @param queue_port_id 1789 * Used to specify the port or queue number in queue or port mode, and is 1790 * ignored in device mode. 1791 * @param ids 1792 * The id numbers of the stats to get. The ids can be got from the stat 1793 * position in the stat list from rte_event_dev_get_xstats_names(), or 1794 * by using rte_event_dev_xstats_by_name_get(). 1795 * @param[out] values 1796 * The values for each stats request by ID. 1797 * @param n 1798 * The number of stats requested 1799 * @return 1800 * - positive value: number of stat entries filled into the values array 1801 * - negative value on error: 1802 * -ENODEV for invalid *dev_id* 1803 * -EINVAL for invalid mode, queue port or id parameters 1804 * -ENOTSUP if the device doesn't support this function. 1805 */ 1806 int 1807 rte_event_dev_xstats_get(uint8_t dev_id, 1808 enum rte_event_dev_xstats_mode mode, 1809 uint8_t queue_port_id, 1810 const uint64_t ids[], 1811 uint64_t values[], unsigned int n); 1812 1813 /** 1814 * Retrieve the value of a single stat by requesting it by name. 1815 * 1816 * @param dev_id 1817 * The identifier of the device 1818 * @param name 1819 * The stat name to retrieve 1820 * @param[out] id 1821 * If non-NULL, the numerical id of the stat will be returned, so that further 1822 * requests for the stat can be got using rte_event_dev_xstats_get, which will 1823 * be faster as it doesn't need to scan a list of names for the stat. 1824 * If the stat cannot be found, the id returned will be (unsigned)-1. 1825 * @return 1826 * - positive value or zero: the stat value 1827 * - negative value: -EINVAL if stat not found, -ENOTSUP if not supported. 1828 */ 1829 uint64_t 1830 rte_event_dev_xstats_by_name_get(uint8_t dev_id, const char *name, 1831 uint64_t *id); 1832 1833 /** 1834 * Reset the values of the xstats of the selected component in the device. 1835 * 1836 * @param dev_id 1837 * The identifier of the device 1838 * @param mode 1839 * The mode of the statistics to reset. Choose from device, queue or port. 1840 * @param queue_port_id 1841 * The queue or port to reset. 0 and positive values select ports and queues, 1842 * while -1 indicates all ports or queues. 1843 * @param ids 1844 * Selects specific statistics to be reset. When NULL, all statistics selected 1845 * by *mode* will be reset. If non-NULL, must point to array of at least 1846 * *nb_ids* size. 1847 * @param nb_ids 1848 * The number of ids available from the *ids* array. Ignored when ids is NULL. 1849 * @return 1850 * - zero: successfully reset the statistics to zero 1851 * - negative value: -EINVAL invalid parameters, -ENOTSUP if not supported. 1852 */ 1853 int 1854 rte_event_dev_xstats_reset(uint8_t dev_id, 1855 enum rte_event_dev_xstats_mode mode, 1856 int16_t queue_port_id, 1857 const uint64_t ids[], 1858 uint32_t nb_ids); 1859 1860 /** 1861 * Trigger the eventdev self test. 1862 * 1863 * @param dev_id 1864 * The identifier of the device 1865 * @return 1866 * - 0: Selftest successful 1867 * - -ENOTSUP if the device doesn't support selftest 1868 * - other values < 0 on failure. 1869 */ 1870 int rte_event_dev_selftest(uint8_t dev_id); 1871 1872 /** 1873 * Get the memory required per event vector based on the number of elements per 1874 * vector. 1875 * This should be used to create the mempool that holds the event vectors. 1876 * 1877 * @param name 1878 * The name of the vector pool. 1879 * @param n 1880 * The number of elements in the mbuf pool. 1881 * @param cache_size 1882 * Size of the per-core object cache. See rte_mempool_create() for 1883 * details. 1884 * @param nb_elem 1885 * The number of elements that a single event vector should be able to hold. 1886 * @param socket_id 1887 * The socket identifier where the memory should be allocated. The 1888 * value can be *SOCKET_ID_ANY* if there is no NUMA constraint for the 1889 * reserved zone 1890 * 1891 * @return 1892 * The pointer to the newly allocated mempool, on success. NULL on error 1893 * with rte_errno set appropriately. Possible rte_errno values include: 1894 * - E_RTE_NO_CONFIG - function could not get pointer to rte_config structure 1895 * - E_RTE_SECONDARY - function was called from a secondary process instance 1896 * - EINVAL - cache size provided is too large, or priv_size is not aligned. 1897 * - ENOSPC - the maximum number of memzones has already been allocated 1898 * - EEXIST - a memzone with the same name already exists 1899 * - ENOMEM - no appropriate memory area found in which to create memzone 1900 * - ENAMETOOLONG - mempool name requested is too long. 1901 */ 1902 struct rte_mempool * 1903 rte_event_vector_pool_create(const char *name, unsigned int n, 1904 unsigned int cache_size, uint16_t nb_elem, 1905 int socket_id); 1906 1907 #include <rte_eventdev_core.h> 1908 1909 static __rte_always_inline uint16_t 1910 __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, 1911 const struct rte_event ev[], uint16_t nb_events, 1912 const event_enqueue_burst_t fn) 1913 { 1914 const struct rte_event_fp_ops *fp_ops; 1915 void *port; 1916 1917 fp_ops = &rte_event_fp_ops[dev_id]; 1918 port = fp_ops->data[port_id]; 1919 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 1920 if (dev_id >= RTE_EVENT_MAX_DEVS || 1921 port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) { 1922 rte_errno = EINVAL; 1923 return 0; 1924 } 1925 1926 if (port == NULL) { 1927 rte_errno = EINVAL; 1928 return 0; 1929 } 1930 #endif 1931 rte_eventdev_trace_enq_burst(dev_id, port_id, ev, nb_events, (void *)fn); 1932 /* 1933 * Allow zero cost non burst mode routine invocation if application 1934 * requests nb_events as const one 1935 */ 1936 if (nb_events == 1) 1937 return (fp_ops->enqueue)(port, ev); 1938 else 1939 return fn(port, ev, nb_events); 1940 } 1941 1942 /** 1943 * Enqueue a burst of events objects or an event object supplied in *rte_event* 1944 * structure on an event device designated by its *dev_id* through the event 1945 * port specified by *port_id*. Each event object specifies the event queue on 1946 * which it will be enqueued. 1947 * 1948 * The *nb_events* parameter is the number of event objects to enqueue which are 1949 * supplied in the *ev* array of *rte_event* structure. 1950 * 1951 * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be 1952 * enqueued to the same port that their associated events were dequeued from. 1953 * 1954 * The rte_event_enqueue_burst() function returns the number of 1955 * events objects it actually enqueued. A return value equal to *nb_events* 1956 * means that all event objects have been enqueued. 1957 * 1958 * @param dev_id 1959 * The identifier of the device. 1960 * @param port_id 1961 * The identifier of the event port. 1962 * @param ev 1963 * Points to an array of *nb_events* objects of type *rte_event* structure 1964 * which contain the event object enqueue operations to be processed. 1965 * @param nb_events 1966 * The number of event objects to enqueue, typically number of 1967 * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 1968 * available for this port. 1969 * 1970 * @return 1971 * The number of event objects actually enqueued on the event device. The 1972 * return value can be less than the value of the *nb_events* parameter when 1973 * the event devices queue is full or if invalid parameters are specified in a 1974 * *rte_event*. If the return value is less than *nb_events*, the remaining 1975 * events at the end of ev[] are not consumed and the caller has to take care 1976 * of them, and rte_errno is set accordingly. Possible errno values include: 1977 * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 1978 * ID is invalid, or an event's sched type doesn't match the 1979 * capabilities of the destination queue. 1980 * - ENOSPC The event port was backpressured and unable to enqueue 1981 * one or more events. This error code is only applicable to 1982 * closed systems. 1983 * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 1984 */ 1985 static inline uint16_t 1986 rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id, 1987 const struct rte_event ev[], uint16_t nb_events) 1988 { 1989 const struct rte_event_fp_ops *fp_ops; 1990 1991 fp_ops = &rte_event_fp_ops[dev_id]; 1992 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 1993 fp_ops->enqueue_burst); 1994 } 1995 1996 /** 1997 * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_NEW* on 1998 * an event device designated by its *dev_id* through the event port specified 1999 * by *port_id*. 2000 * 2001 * Provides the same functionality as rte_event_enqueue_burst(), expect that 2002 * application can use this API when the all objects in the burst contains 2003 * the enqueue operation of the type *RTE_EVENT_OP_NEW*. This specialized 2004 * function can provide the additional hint to the PMD and optimize if possible. 2005 * 2006 * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst 2007 * has event object of operation type != RTE_EVENT_OP_NEW. 2008 * 2009 * @param dev_id 2010 * The identifier of the device. 2011 * @param port_id 2012 * The identifier of the event port. 2013 * @param ev 2014 * Points to an array of *nb_events* objects of type *rte_event* structure 2015 * which contain the event object enqueue operations to be processed. 2016 * @param nb_events 2017 * The number of event objects to enqueue, typically number of 2018 * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 2019 * available for this port. 2020 * 2021 * @return 2022 * The number of event objects actually enqueued on the event device. The 2023 * return value can be less than the value of the *nb_events* parameter when 2024 * the event devices queue is full or if invalid parameters are specified in a 2025 * *rte_event*. If the return value is less than *nb_events*, the remaining 2026 * events at the end of ev[] are not consumed and the caller has to take care 2027 * of them, and rte_errno is set accordingly. Possible errno values include: 2028 * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 2029 * ID is invalid, or an event's sched type doesn't match the 2030 * capabilities of the destination queue. 2031 * - ENOSPC The event port was backpressured and unable to enqueue 2032 * one or more events. This error code is only applicable to 2033 * closed systems. 2034 * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 2035 * @see rte_event_enqueue_burst() 2036 */ 2037 static inline uint16_t 2038 rte_event_enqueue_new_burst(uint8_t dev_id, uint8_t port_id, 2039 const struct rte_event ev[], uint16_t nb_events) 2040 { 2041 const struct rte_event_fp_ops *fp_ops; 2042 2043 fp_ops = &rte_event_fp_ops[dev_id]; 2044 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 2045 fp_ops->enqueue_new_burst); 2046 } 2047 2048 /** 2049 * Enqueue a burst of events objects of operation type *RTE_EVENT_OP_FORWARD* 2050 * on an event device designated by its *dev_id* through the event port 2051 * specified by *port_id*. 2052 * 2053 * Provides the same functionality as rte_event_enqueue_burst(), expect that 2054 * application can use this API when the all objects in the burst contains 2055 * the enqueue operation of the type *RTE_EVENT_OP_FORWARD*. This specialized 2056 * function can provide the additional hint to the PMD and optimize if possible. 2057 * 2058 * The rte_event_enqueue_new_burst() result is undefined if the enqueue burst 2059 * has event object of operation type != RTE_EVENT_OP_FORWARD. 2060 * 2061 * @param dev_id 2062 * The identifier of the device. 2063 * @param port_id 2064 * The identifier of the event port. 2065 * @param ev 2066 * Points to an array of *nb_events* objects of type *rte_event* structure 2067 * which contain the event object enqueue operations to be processed. 2068 * @param nb_events 2069 * The number of event objects to enqueue, typically number of 2070 * rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) 2071 * available for this port. 2072 * 2073 * @return 2074 * The number of event objects actually enqueued on the event device. The 2075 * return value can be less than the value of the *nb_events* parameter when 2076 * the event devices queue is full or if invalid parameters are specified in a 2077 * *rte_event*. If the return value is less than *nb_events*, the remaining 2078 * events at the end of ev[] are not consumed and the caller has to take care 2079 * of them, and rte_errno is set accordingly. Possible errno values include: 2080 * - EINVAL The port ID is invalid, device ID is invalid, an event's queue 2081 * ID is invalid, or an event's sched type doesn't match the 2082 * capabilities of the destination queue. 2083 * - ENOSPC The event port was backpressured and unable to enqueue 2084 * one or more events. This error code is only applicable to 2085 * closed systems. 2086 * @see rte_event_port_attr_get(), RTE_EVENT_PORT_ATTR_ENQ_DEPTH 2087 * @see rte_event_enqueue_burst() 2088 */ 2089 static inline uint16_t 2090 rte_event_enqueue_forward_burst(uint8_t dev_id, uint8_t port_id, 2091 const struct rte_event ev[], uint16_t nb_events) 2092 { 2093 const struct rte_event_fp_ops *fp_ops; 2094 2095 fp_ops = &rte_event_fp_ops[dev_id]; 2096 return __rte_event_enqueue_burst(dev_id, port_id, ev, nb_events, 2097 fp_ops->enqueue_forward_burst); 2098 } 2099 2100 /** 2101 * Dequeue a burst of events objects or an event object from the event port 2102 * designated by its *event_port_id*, on an event device designated 2103 * by its *dev_id*. 2104 * 2105 * rte_event_dequeue_burst() does not dictate the specifics of scheduling 2106 * algorithm as each eventdev driver may have different criteria to schedule 2107 * an event. However, in general, from an application perspective scheduler may 2108 * use the following scheme to dispatch an event to the port. 2109 * 2110 * 1) Selection of event queue based on 2111 * a) The list of event queues are linked to the event port. 2112 * b) If the device has RTE_EVENT_DEV_CAP_QUEUE_QOS capability then event 2113 * queue selection from list is based on event queue priority relative to 2114 * other event queue supplied as *priority* in rte_event_queue_setup() 2115 * c) If the device has RTE_EVENT_DEV_CAP_EVENT_QOS capability then event 2116 * queue selection from the list is based on event priority supplied as 2117 * *priority* in rte_event_enqueue_burst() 2118 * 2) Selection of event 2119 * a) The number of flows available in selected event queue. 2120 * b) Schedule type method associated with the event 2121 * 2122 * The *nb_events* parameter is the maximum number of event objects to dequeue 2123 * which are returned in the *ev* array of *rte_event* structure. 2124 * 2125 * The rte_event_dequeue_burst() function returns the number of events objects 2126 * it actually dequeued. A return value equal to *nb_events* means that all 2127 * event objects have been dequeued. 2128 * 2129 * The number of events dequeued is the number of scheduler contexts held by 2130 * this port. These contexts are automatically released in the next 2131 * rte_event_dequeue_burst() invocation if the port supports implicit 2132 * releases, or invoking rte_event_enqueue_burst() with RTE_EVENT_OP_RELEASE 2133 * operation can be used to release the contexts early. 2134 * 2135 * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be 2136 * enqueued to the same port that their associated events were dequeued from. 2137 * 2138 * @param dev_id 2139 * The identifier of the device. 2140 * @param port_id 2141 * The identifier of the event port. 2142 * @param[out] ev 2143 * Points to an array of *nb_events* objects of type *rte_event* structure 2144 * for output to be populated with the dequeued event objects. 2145 * @param nb_events 2146 * The maximum number of event objects to dequeue, typically number of 2147 * rte_event_port_dequeue_depth() available for this port. 2148 * 2149 * @param timeout_ticks 2150 * - 0 no-wait, returns immediately if there is no event. 2151 * - >0 wait for the event, if the device is configured with 2152 * RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT then this function will wait until 2153 * at least one event is available or *timeout_ticks* time. 2154 * if the device is not configured with RTE_EVENT_DEV_CFG_PER_DEQUEUE_TIMEOUT 2155 * then this function will wait until the event available or 2156 * *dequeue_timeout_ns* ns which was previously supplied to 2157 * rte_event_dev_configure() 2158 * 2159 * @return 2160 * The number of event objects actually dequeued from the port. The return 2161 * value can be less than the value of the *nb_events* parameter when the 2162 * event port's queue is not full. 2163 * 2164 * @see rte_event_port_dequeue_depth() 2165 */ 2166 static inline uint16_t 2167 rte_event_dequeue_burst(uint8_t dev_id, uint8_t port_id, struct rte_event ev[], 2168 uint16_t nb_events, uint64_t timeout_ticks) 2169 { 2170 const struct rte_event_fp_ops *fp_ops; 2171 void *port; 2172 2173 fp_ops = &rte_event_fp_ops[dev_id]; 2174 port = fp_ops->data[port_id]; 2175 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 2176 if (dev_id >= RTE_EVENT_MAX_DEVS || 2177 port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) { 2178 rte_errno = EINVAL; 2179 return 0; 2180 } 2181 2182 if (port == NULL) { 2183 rte_errno = EINVAL; 2184 return 0; 2185 } 2186 #endif 2187 rte_eventdev_trace_deq_burst(dev_id, port_id, ev, nb_events); 2188 /* 2189 * Allow zero cost non burst mode routine invocation if application 2190 * requests nb_events as const one 2191 */ 2192 if (nb_events == 1) 2193 return (fp_ops->dequeue)(port, ev, timeout_ticks); 2194 else 2195 return (fp_ops->dequeue_burst)(port, ev, nb_events, 2196 timeout_ticks); 2197 } 2198 2199 #define RTE_EVENT_DEV_MAINT_OP_FLUSH (1 << 0) 2200 /**< Force an immediately flush of any buffered events in the port, 2201 * potentially at the cost of additional overhead. 2202 * 2203 * @see rte_event_maintain() 2204 */ 2205 2206 /** 2207 * Maintain an event device. 2208 * 2209 * This function is only relevant for event devices which do not have 2210 * the @ref RTE_EVENT_DEV_CAP_MAINTENANCE_FREE flag set. Such devices 2211 * require an application thread using a particular port to 2212 * periodically call rte_event_maintain() on that port during periods 2213 * which it is neither attempting to enqueue events to nor dequeue 2214 * events from the port. rte_event_maintain() is a low-overhead 2215 * function and should be called at a high rate (e.g., in the 2216 * application's poll loop). 2217 * 2218 * No port may be left unmaintained. 2219 * 2220 * At the application thread's convenience, rte_event_maintain() may 2221 * (but is not required to) be called even during periods when enqueue 2222 * or dequeue functions are being called, at the cost of a slight 2223 * increase in overhead. 2224 * 2225 * rte_event_maintain() may be called on event devices which have set 2226 * @ref RTE_EVENT_DEV_CAP_MAINTENANCE_FREE, in which case it is a 2227 * no-operation. 2228 * 2229 * @param dev_id 2230 * The identifier of the device. 2231 * @param port_id 2232 * The identifier of the event port. 2233 * @param op 2234 * 0, or @ref RTE_EVENT_DEV_MAINT_OP_FLUSH. 2235 * @return 2236 * - 0 on success. 2237 * - -EINVAL if *dev_id*, *port_id*, or *op* is invalid. 2238 * 2239 * @see RTE_EVENT_DEV_CAP_MAINTENANCE_FREE 2240 */ 2241 __rte_experimental 2242 static inline int 2243 rte_event_maintain(uint8_t dev_id, uint8_t port_id, int op) 2244 { 2245 const struct rte_event_fp_ops *fp_ops; 2246 void *port; 2247 2248 fp_ops = &rte_event_fp_ops[dev_id]; 2249 port = fp_ops->data[port_id]; 2250 #ifdef RTE_LIBRTE_EVENTDEV_DEBUG 2251 if (dev_id >= RTE_EVENT_MAX_DEVS || 2252 port_id >= RTE_EVENT_MAX_PORTS_PER_DEV) 2253 return -EINVAL; 2254 2255 if (port == NULL) 2256 return -EINVAL; 2257 2258 if (op & (~RTE_EVENT_DEV_MAINT_OP_FLUSH)) 2259 return -EINVAL; 2260 #endif 2261 rte_eventdev_trace_maintain(dev_id, port_id, op); 2262 2263 if (fp_ops->maintain != NULL) 2264 fp_ops->maintain(port, op); 2265 2266 return 0; 2267 } 2268 2269 #ifdef __cplusplus 2270 } 2271 #endif 2272 2273 #endif /* _RTE_EVENTDEV_H_ */ 2274