|
| int | rte_event_eth_tx_adapter_create (uint8_t id, uint8_t dev_id, struct rte_event_port_conf *port_config) |
| |
| int | rte_event_eth_tx_adapter_create_ext (uint8_t id, uint8_t dev_id, rte_event_eth_tx_adapter_conf_cb conf_cb, void *conf_arg) |
| |
| int | rte_event_eth_tx_adapter_free (uint8_t id) |
| |
| int | rte_event_eth_tx_adapter_start (uint8_t id) |
| |
| int | rte_event_eth_tx_adapter_stop (uint8_t id) |
| |
| int | rte_event_eth_tx_adapter_queue_add (uint8_t id, uint16_t eth_dev_id, int32_t queue) |
| |
| int | rte_event_eth_tx_adapter_queue_del (uint8_t id, uint16_t eth_dev_id, int32_t queue) |
| |
| static __rte_always_inline void | rte_event_eth_tx_adapter_txq_set (struct rte_mbuf *pkt, uint16_t queue) |
| |
| static __rte_always_inline uint16_t | rte_event_eth_tx_adapter_txq_get (struct rte_mbuf *pkt) |
| |
| int | rte_event_eth_tx_adapter_event_port_get (uint8_t id, uint8_t *event_port_id) |
| |
| static uint16_t | rte_event_eth_tx_adapter_enqueue (uint8_t dev_id, uint8_t port_id, struct rte_event ev[], uint16_t nb_events, const uint8_t flags) |
| |
| int | rte_event_eth_tx_adapter_stats_get (uint8_t id, struct rte_event_eth_tx_adapter_stats *stats) |
| |
| int | rte_event_eth_tx_adapter_stats_reset (uint8_t id) |
| |
| int | rte_event_eth_tx_adapter_service_id_get (uint8_t id, uint32_t *service_id) |
| |
| int | rte_event_eth_tx_adapter_instance_get (uint16_t eth_dev_id, uint16_t tx_queue_id, uint8_t *txa_inst_id) |
| |
| int | rte_event_eth_tx_adapter_queue_start (uint16_t eth_dev_id, uint16_t tx_queue_id) |
| |
| int | rte_event_eth_tx_adapter_queue_stop (uint16_t eth_dev_id, uint16_t tx_queue_id) |
| |
| __rte_experimental int | rte_event_eth_tx_adapter_runtime_params_init (struct rte_event_eth_tx_adapter_runtime_params *txa_params) |
| |
| __rte_experimental int | rte_event_eth_tx_adapter_runtime_params_set (uint8_t id, struct rte_event_eth_tx_adapter_runtime_params *params) |
| |
| __rte_experimental int | rte_event_eth_tx_adapter_runtime_params_get (uint8_t id, struct rte_event_eth_tx_adapter_runtime_params *params) |
| |
RTE Event Ethernet Tx Adapter
The event ethernet Tx adapter provides configuration and data path APIs for the ethernet transmit stage of an event driven packet processing application. These APIs abstract the implementation of the transmit stage and allow the application to use eventdev PMD support or a common implementation.
In the common implementation, the application enqueues mbufs to the adapter which runs as a rte_service function. The service function dequeues events from its event port and transmits the mbufs referenced by these events.
The ethernet Tx event adapter APIs are:
The application creates the adapter using rte_event_eth_tx_adapter_create() or rte_event_eth_tx_adapter_create_ext().
The adapter will use the common implementation when the eventdev PMD does not have the RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT capability. The common implementation uses an event port that is created using the port configuration parameter passed to rte_event_eth_tx_adapter_create(). The application can get the port identifier using rte_event_eth_tx_adapter_event_port_get() and must link an event queue to this port.
If the eventdev PMD has the RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT flags set, Tx adapter events should be enqueued using the rte_event_eth_tx_adapter_enqueue() function, else the application should use rte_event_enqueue_burst().
Transmit queues can be added and deleted from the adapter using rte_event_eth_tx_adapter_queue_add()/del() APIs respectively.
The application can start and stop the adapter using the rte_event_eth_tx_adapter_start/stop() calls.
The common adapter implementation uses an EAL service function as described before and its execution is controlled using the rte_service APIs. The rte_event_eth_tx_adapter_service_id_get() function can be used to retrieve the adapter's service function ID.
The ethernet port and transmit queue index to transmit the mbuf on are specified using the mbuf port struct rte_mbuf::hash::txadapter:txq. The application should use the rte_event_eth_tx_adapter_txq_set() and rte_event_eth_tx_adapter_txq_get() functions to access the transmit queue index, using these macros will help with minimizing application impact due to a change in how the transmit queue index is specified.
Definition in file rte_event_eth_tx_adapter.h.
| static uint16_t rte_event_eth_tx_adapter_enqueue |
( |
uint8_t |
dev_id, |
|
|
uint8_t |
port_id, |
|
|
struct rte_event |
ev[], |
|
|
uint16_t |
nb_events, |
|
|
const uint8_t |
flags |
|
) |
| |
|
inlinestatic |
Enqueue a burst of events objects or an event object supplied in rte_event structure on an event device designated by its dev_id through the event port specified by port_id. This function is supported if the eventdev PMD has the RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT capability flag set.
The nb_events parameter is the number of event objects to enqueue which are supplied in the ev array of rte_event structure.
The rte_event_eth_tx_adapter_enqueue() function returns the number of events objects it actually enqueued. A return value equal to nb_events means that all event objects have been enqueued.
- Parameters
-
| dev_id | The identifier of the device. |
| port_id | The identifier of the event port. |
| ev | Points to an array of nb_events objects of type rte_event structure which contain the event object enqueue operations to be processed. |
| nb_events | The number of event objects to enqueue, typically number of rte_event_port_attr_get(...RTE_EVENT_PORT_ATTR_ENQ_DEPTH...) available for this port. |
| flags | RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_ flags. RTE_EVENT_ETH_TX_ADAPTER_ENQUEUE_SAME_DEST signifies that all the packets which are enqueued are destined for the same Ethernet port & Tx queue. |
- Returns
- The number of event objects actually enqueued on the event device. The return value can be less than the value of the nb_events parameter when the event devices queue is full or if invalid parameters are specified in a rte_event. If the return value is less than nb_events, the remaining events at the end of ev[] are not consumed and the caller has to take care of them, and rte_errno is set accordingly. Possible errno values include:
- EINVAL The port ID is invalid, device ID is invalid, an event's queue ID is invalid, or an event's sched type doesn't match the capabilities of the destination queue.
- ENOSPC The event port was backpressured and unable to enqueue one or more events. This error code is only applicable to closed systems.
- Examples
- examples/eventdev_pipeline/pipeline_worker_tx.c, examples/ipsec-secgw/ipsec_worker.c, examples/l2fwd-event/l2fwd_event.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_fib.c, and examples/l3fwd/l3fwd_lpm.c.
Definition at line 404 of file rte_event_eth_tx_adapter.h.
| int rte_event_eth_tx_adapter_queue_start |
( |
uint16_t |
eth_dev_id, |
|
|
uint16_t |
tx_queue_id |
|
) |
| |
Enables the adapter to start enqueueing of packets to the Tx queue.
This function is provided so that the application can resume enqueueing packets that reference packets for <eth_dev_id, tx_queue_id> after calling rte_event_eth_tx_adapter_queue_stop().
- See also
- rte_event_eth_tx_adapter_queue_stop
Use case:
The queue start/stop APIs help avoid some unexpected behavior with application stopping ethdev Tx queues and adapter being unaware of it. With these APIs, the application can call stop API to notify adapter that corresponding ethdev Tx queue is stopped and any in-flight packets are freed by adapter dataplane code. Adapter queue stop API is called before stopping the ethdev Tx queue. When ethdev Tx queue is enabled, application can notify adapter to resume processing of the packets for that queue by calling the start API. The ethdev Tx queue is started before calling adapter start API.
- Parameters
-
| eth_dev_id | Port identifier of Ethernet device. |
| tx_queue_id | Ethernet device transmit queue index. |
- Returns
- 0: Success
- <0: Error code on failure
