@@ -186,3 +186,41 @@ the event buffer fill level is low. The
``rte_event_eth_rx_adapter_cb_register()`` function allow the application
to register a callback that selects which packets to enqueue to the event
device.
+
+Rx event vectorization
+~~~~~~~~~~~~~~~~~~~~~~
+
+The event devices, ethernet device pairs which support the capability
+``RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR`` can aggregate packets based on
+flow characteristics and generate a ``rte_event`` containing ``rte_event_vector``
+whose event type is either ``RTE_EVENT_TYPE_ETHDEV_VECTOR`` or
+``RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR``.
+The aggregation size and timeout are configurable at a queue level and the
+maximum, minimum vector sizes and timeouts vary based on the device capability
+and can be queried using ``rte_event_eth_rx_adapter_vector_limits_get``.
+The Rx adapter additionally might include useful data such as ethernet device
+port and queue identifier in the ``rte_event_vector::port`` and
+``rte_event_vector::queue`` and mark ``rte_event_vector::attr_valid`` as true.
+
+A loop processing ``rte_event_vector`` containing mbufs is shown below.
+
+.. code-block:: c
+
+ event = rte_event_dequeue_burst(event_dev, event_port, &event,
+ 1, 0);
+ if (!event)
+ continue;
+
+ switch (ev.event_type) {
+ case RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR:
+ case RTE_EVENT_TYPE_ETHDEV_VECTOR:
+ struct rte_mbufs **mbufs;
+
+ mbufs = (struct rte_mbufs **)ev[i].vec->mbufs;
+ for (i = 0; i < ev.vec->nb_elem; i++) {
+ // Process each mbuf.
+ }
+ break;
+ case ...
+ ...
+ }
@@ -92,6 +92,10 @@ extern "C" {
/**< This flag indicates the flow identifier is valid
* @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
*/
+#define RTE_EVENT_ETH_RX_ADAPTER_QUEUE_EVENT_VECTOR 0x2
+/**< This flag indicates that mbufs arriving on the queue need to be vectorized
+ * @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
+ */
/**
* Adapter configuration structure that the adapter configuration callback
@@ -167,6 +171,33 @@ struct rte_event_eth_rx_adapter_queue_conf {
* The event adapter sets ev.event_type to RTE_EVENT_TYPE_ETHDEV in the
* enqueued event.
*/
+ uint16_t vector_sz;
+ /**<
+ * Indicates the maximum number for mbufs to combine and form a vector.
+ * Should be within
+ * @see rte_event_eth_rx_adapter_vector_limits::min_vector_sz
+ * @see rte_event_eth_rx_adapter_vector_limits::max_vector_sz
+ * Valid when RTE_EVENT_ETH_RX_ADAPTER_QUEUE_EVENT_VECTOR flag is set in
+ * @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
+ */
+ uint64_t vector_timeout_ns;
+ /**<
+ * Indicates the maximum number of nanoseconds to wait for receiving
+ * mbufs. Should be within vectorization limits of the
+ * adapter
+ * @see rte_event_eth_rx_adapter_vector_limits::min_vector_ns
+ * @see rte_event_eth_rx_adapter_vector_limits::max_vector_ns
+ * Valid when RTE_EVENT_ETH_RX_ADAPTER_QUEUE_EVENT_VECTOR flag is set in
+ * @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
+ */
+ struct rte_mempool *vector_mp;
+ /**<
+ * Indicates the mempool that should be used for allocating
+ * rte_event_vector container.
+ * Should be created by using `rte_event_vector_pool_create`.
+ * Valid when RTE_EVENT_ETH_RX_ADAPTER_QUEUE_EVENT_VECTOR flag is set in
+ * @see rte_event_eth_rx_adapter_queue_conf::rx_queue_flags.
+ */
};
/**
@@ -199,6 +230,20 @@ struct rte_event_eth_rx_adapter_stats {
/**< Received packet count for interrupt mode Rx queues */
};
+/**
+ * A structure used to retrieve eth rx adapter vector limits.
+ */
+struct rte_event_eth_rx_adapter_vector_limits {
+ uint16_t min_sz;
+ /**< Minimum vector limit configurable. */
+ uint16_t max_sz;
+ /**< Maximum vector limit configurable. */
+ uint64_t min_timeout_ns;
+ /**< Minimum vector timeout configurable. */
+ uint64_t max_timeout_ns;
+ /**< Maximum vector timeout configurable. */
+};
+
/**
*
* Callback function invoked by the SW adapter before it continues
@@ -467,6 +512,27 @@ int rte_event_eth_rx_adapter_cb_register(uint8_t id, uint16_t eth_dev_id,
rte_event_eth_rx_adapter_cb_fn cb_fn,
void *cb_arg);
+/**
+ * Retrieve vector limits for a given event dev and eth dev pair.
+ * @see rte_event_eth_rx_adapter_vector_limits
+ *
+ * @param dev_id
+ * Event device identifier.
+ * @param eth_port_id
+ * Port identifier of the ethernet device.
+ * @param [out] limits
+ * A pointer to rte_event_eth_rx_adapter_vector_limits structure that has to
+ * be filled.
+ *
+ * @return
+ * - 0: Success.
+ * - <0: Error code on failure.
+ */
+__rte_experimental
+int rte_event_eth_rx_adapter_vector_limits_get(
+ uint8_t dev_id, uint16_t eth_port_id,
+ struct rte_event_eth_rx_adapter_vector_limits *limits);
+
#ifdef __cplusplus
}
#endif
@@ -919,9 +919,27 @@ rte_event_dev_close(uint8_t dev_id);
* Event vector structure.
*/
struct rte_event_vector {
- uint64_t nb_elem : 16;
+ uint16_t nb_elem;
/**< Number of elements in this event vector. */
- uint64_t rsvd : 48;
+ uint16_t rsvd : 15;
+ uint16_t attr_valid : 1;
+ /**< Indicates that the below union attributes have valid information.
+ */
+ union {
+ /* Used by Rx adapter.
+ * Indicats that all the elements in this vector belong to same
+ * port and queue pair when originating from Rx adapter, valid
+ * only when event type is ETHDEV_VECTOR or
+ * ETH_RX_ADAPTER_VECTOR.
+ */
+ struct {
+ uint16_t port;
+ /* Ethernet device port id. */
+ uint16_t queue;
+ /* Ethernet device queue id. */
+ };
+ };
+ /**< Union to hold common attributes of the vector array. */
uint64_t impl_opaque;
union {
struct rte_mbuf *mbufs[0];
@@ -1019,8 +1037,14 @@ struct rte_event_vector {
* // Classify and handle event.
* }
*/
+#define RTE_EVENT_TYPE_ETHDEV_VECTOR \
+ (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_ETHDEV)
+/**< The event vector generated from ethdev subsystem */
#define RTE_EVENT_TYPE_CPU_VECTOR (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_CPU)
/**< The event vector generated from cpu for pipelining. */
+#define RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR \
+ (RTE_EVENT_TYPE_VECTOR | RTE_EVENT_TYPE_ETH_RX_ADAPTER)
+/**< The event vector generated from eth Rx adapter. */
#define RTE_EVENT_TYPE_MAX 0x10
/**< Maximum number of event types */
@@ -1165,6 +1189,8 @@ struct rte_event {
* @see struct rte_event_eth_rx_adapter_queue_conf::ev
* @see struct rte_event_eth_rx_adapter_queue_conf::rx_queue_flags
*/
+#define RTE_EVENT_ETH_RX_ADAPTER_CAP_EVENT_VECTOR 0x8
+/**< Adapter supports event vectorization per ethdev. */
/**
* Retrieve the event device's ethdev Rx adapter capabilities for the
@@ -141,6 +141,7 @@ EXPERIMENTAL {
#added in 21.05
rte_event_vector_pool_create;
+ rte_event_eth_rx_adapter_vector_limits_get;
};
INTERNAL {