rte_event_eth_rx_adapter.h File Reference

#include <stdint.h>
#include <rte_service.h>
#include "rte_eventdev.h"

Go to the source code of this file.

Data Structures
struct	rte_event_eth_rx_adapter_conf
struct	rte_event_eth_rx_adapter_queue_conf
struct	rte_event_eth_rx_adapter_stats

Macros
#define	RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID   0x1

Typedefs
typedef int(*	rte_event_eth_rx_adapter_conf_cb )(uint8_t id, uint8_t dev_id, struct rte_event_eth_rx_adapter_conf *conf, void *arg)
typedef uint16_t(*	rte_event_eth_rx_adapter_cb_fn )(uint16_t eth_dev_id, uint16_t queue_id, uint32_t enqueue_buf_size, uint32_t enqueue_buf_count, struct rte_mbuf **mbuf, uint16_t nb_mbuf, void *cb_arg, struct rte_mbuf **enq_buf)

Functions
int	rte_event_eth_rx_adapter_create_ext (uint8_t id, uint8_t dev_id, rte_event_eth_rx_adapter_conf_cb conf_cb, void *conf_arg)
int	rte_event_eth_rx_adapter_create (uint8_t id, uint8_t dev_id, struct rte_event_port_conf *port_config)
int	rte_event_eth_rx_adapter_free (uint8_t id)
int	rte_event_eth_rx_adapter_queue_add (uint8_t id, uint16_t eth_dev_id, int32_t rx_queue_id, const struct rte_event_eth_rx_adapter_queue_conf *conf)
int	rte_event_eth_rx_adapter_queue_del (uint8_t id, uint16_t eth_dev_id, int32_t rx_queue_id)
int	rte_event_eth_rx_adapter_start (uint8_t id)
int	rte_event_eth_rx_adapter_stop (uint8_t id)
int	rte_event_eth_rx_adapter_stats_get (uint8_t id, struct rte_event_eth_rx_adapter_stats *stats)
int	rte_event_eth_rx_adapter_stats_reset (uint8_t id)
int	rte_event_eth_rx_adapter_service_id_get (uint8_t id, uint32_t *service_id)
int __rte_experimental	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)

Detailed Description

RTE Event Ethernet Rx Adapter

An eventdev-based packet processing application enqueues/dequeues mbufs to/from the event device. Packet flow from the ethernet device to the event device can be accomplished using either HW or SW mechanisms depending on the platform and the particular combination of ethernet and event devices. The event ethernet Rx adapter provides common APIs to configure the packet flow from the ethernet devices to event devices across both these transfer mechanisms.

The adapter uses a EAL service core function for SW based packet transfer and uses the eventdev PMD functions to configure HW based packet transfer between the ethernet device and the event device. For SW based packet transfer, if the mbuf does not have a timestamp set, the adapter adds a timestamp to the mbuf using rte_get_tsc_cycles(), this provides a more accurate timestamp as compared to if the application were to set the time stamp since it avoids event device schedule latency.

The ethernet Rx event adapter's functions are:

• rte_event_eth_rx_adapter_create_ext()
• rte_event_eth_rx_adapter_create()
• rte_event_eth_rx_adapter_free()
• rte_event_eth_rx_adapter_queue_add()
• rte_event_eth_rx_adapter_queue_del()
• rte_event_eth_rx_adapter_start()
• rte_event_eth_rx_adapter_stop()
• rte_event_eth_rx_adapter_stats_get()
• rte_event_eth_rx_adapter_stats_reset()

The application creates an ethernet to event adapter using rte_event_eth_rx_adapter_create_ext() or rte_event_eth_rx_adapter_create() functions. The adapter needs to know which ethernet rx queues to poll for mbufs as well as event device parameters such as the event queue identifier, event priority and scheduling type that the adapter should use when constructing events. The rte_event_eth_rx_adapter_queue_add() function is provided for this purpose. The servicing weight parameter in the rte_event_eth_rx_adapter_queue_conf is applicable when the Rx adapter uses a service core function and is intended to provide application control of the frequency of polling ethernet device receive queues, for example, the application may want to poll higher priority queues with a higher frequency but at the same time not starve lower priority queues completely. If this parameter is zero and the receive interrupt is enabled when configuring the device, the receive queue is interrupt driven; else, the queue is assigned a servicing weight of one.

The application can start/stop the adapter using the rte_event_eth_rx_adapter_start() and the rte_event_eth_rx_adapter_stop() functions. If the adapter uses a rte_service function, then the application is also required to assign a core to the service function and control the service core using the rte_service APIs. The rte_event_eth_rx_adapter_service_id_get() function can be used to retrieve the service function ID of the adapter in this case.

For SW based packet transfers, i.e., when the RTE_EVENT_ETH_RX_ADAPTER_CAP_INTERNAL_PORT is not set in the adapter's capabilities flags for a particular ethernet device, the service function temporarily enqueues mbufs to an event buffer before batch enqueueing these to the event device. If the buffer fills up, the service function stops dequeueing packets from the ethernet device. The application may want to monitor the buffer fill level and instruct the service function to selectively buffer packets. The application may also use some other criteria to decide which packets should enter the event device even when the event buffer fill level is low. The rte_event_eth_rx_adapter_cb_register() function allows the application to register a callback that selects which packets to enqueue to the event device.

Definition in file rte_event_eth_rx_adapter.h.

Macro Definition Documentation

#define RTE_EVENT_ETH_RX_ADAPTER_QUEUE_FLOW_ID_VALID   0x1

This flag indicates the flow identifier is valid

See Also

rte_event_eth_rx_adapter_queue_conf::rx_queue_flags

Definition at line 94 of file rte_event_eth_rx_adapter.h.

Typedef Documentation

typedef int(* rte_event_eth_rx_adapter_conf_cb)(uint8_t id, uint8_t dev_id, struct rte_event_eth_rx_adapter_conf *conf, void *arg)

Warning

EXPERIMENTAL: this API may change without prior notice

Function type used for adapter configuration callback. The callback is used to fill in members of the struct rte_event_eth_rx_adapter_conf, this callback is invoked when creating a SW service for packet transfer from ethdev queues to the event device. The SW service is created within the rte_event_eth_rx_adapter_queue_add() function if SW based packet transfers from ethdev queues to the event device are required.

Parameters

	id	Adapter identifier.
	dev_id	Event device identifier.
[out]	conf	Structure that needs to be populated by this callback.
	arg	Argument to the callback. This is the same as the conf_arg passed to the rte_event_eth_rx_adapter_create_ext().

Definition at line 143 of file rte_event_eth_rx_adapter.h.

typedef uint16_t(* rte_event_eth_rx_adapter_cb_fn)(uint16_t eth_dev_id, uint16_t queue_id, uint32_t enqueue_buf_size, uint32_t enqueue_buf_count, struct rte_mbuf **mbuf, uint16_t nb_mbuf, void *cb_arg, struct rte_mbuf **enq_buf)

Warning

EXPERIMENTAL: this API may change without prior notice

Callback function invoked by the SW adapter before it continues to process packets. The callback is passed the size of the enqueue buffer in the SW adapter and the occupancy of the buffer. The callback can use these values to decide which mbufs should be enqueued to the event device. If the return value of the callback is less than nb_mbuf then the SW adapter uses the return value to enqueue enq_mbuf[] to the event device.

Parameters

	eth_dev_id	Port identifier of the Ethernet device.
	queue_id	Receive queue index.
	enqueue_buf_size	Total enqueue buffer size.
	enqueue_buf_count	mbuf count in enqueue buffer.
	mbuf	mbuf array.
	nb_mbuf	mbuf count.
	cb_arg	Callback argument.
[out]	enq_mbuf	The adapter enqueues enq_mbuf[] if the return value of the callback is less than nb_mbuf

Returns

Returns the number of mbufs should be enqueued to eventdev

Definition at line 247 of file rte_event_eth_rx_adapter.h.

Function Documentation

int rte_event_eth_rx_adapter_create_ext	(	uint8_t	id,
		uint8_t	dev_id,
		rte_event_eth_rx_adapter_conf_cb	conf_cb,
		void *	conf_arg
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Create a new ethernet Rx event adapter with the specified identifier.

Parameters

id	The identifier of the ethernet Rx event adapter.
dev_id	The identifier of the device to configure.
conf_cb	Callback function that fills in members of a struct rte_event_eth_rx_adapter_conf struct passed into it.
conf_arg	Argument that is passed to the conf_cb function.

Returns

• 0: Success
• <0: Error code on failure

int rte_event_eth_rx_adapter_create	(	uint8_t	id,
		uint8_t	dev_id,
		struct rte_event_port_conf *	port_config
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Create a new ethernet Rx event adapter with the specified identifier. This function uses an internal configuration function that creates an event port. This default function reconfigures the event device with an additional event port and setups up the event port using the port_config parameter passed into this function. In case the application needs more control in configuration of the service, it should use the rte_event_eth_rx_adapter_create_ext() version.

Parameters

id	The identifier of the ethernet Rx event adapter.
dev_id	The identifier of the device to configure.
port_config	Argument of type rte_event_port_conf that is passed to the conf_cb function.

Returns

• 0: Success
• <0: Error code on failure

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, and examples/eventdev_pipeline/pipeline_worker_tx.c.

int rte_event_eth_rx_adapter_free

(

uint8_t

id

)

Warning

EXPERIMENTAL: this API may change without prior notice

Free an event adapter

Parameters

id	Adapter identifier.

Returns

• 0: Success
• <0: Error code on failure, If the adapter still has Rx queues added to it, the function returns -EBUSY.

int rte_event_eth_rx_adapter_queue_add	(	uint8_t	id,
		uint16_t	eth_dev_id,
		int32_t	rx_queue_id,
		const struct rte_event_eth_rx_adapter_queue_conf *	conf
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Add receive queue to an event adapter. After a queue has been added to the event adapter, the result of the application calling rte_eth_rx_burst(eth_dev_id, rx_queue_id, ..) is undefined.

Parameters

id	Adapter identifier.
eth_dev_id	Port identifier of Ethernet device.
rx_queue_id	Ethernet device receive queue index. If rx_queue_id is -1, then all Rx queues configured for the device are added. If the ethdev Rx queues can only be connected to a single event queue then rx_queue_id is required to be -1.

See Also

RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ

Parameters

conf	Additional configuration structure of type rte_event_eth_rx_adapter_conf

Returns

• 0: Success, Receive queue added correctly.
• <0: Error code on failure.
• (-EIO) device reconfiguration and restart error. The adapter reconfigures the event device with an additional port if it is required to use a service function for packet transfer from the ethernet device to the event device. If the device had been started before this call, this error code indicates an error in restart following an error in reconfiguration, i.e., a combination of the two error codes.

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, and examples/eventdev_pipeline/pipeline_worker_tx.c.

int rte_event_eth_rx_adapter_queue_del	(	uint8_t	id,
		uint16_t	eth_dev_id,
		int32_t	rx_queue_id
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Delete receive queue from an event adapter.

Parameters

id	Adapter identifier.
eth_dev_id	Port identifier of Ethernet device.
rx_queue_id	Ethernet device receive queue index. If rx_queue_id is -1, then all Rx queues configured for the device are deleted. If the ethdev Rx queues can only be connected to a single event queue then rx_queue_id is required to be -1.

See Also

RTE_EVENT_ETH_RX_ADAPTER_CAP_MULTI_EVENTQ

Returns

• 0: Success, Receive queue deleted correctly.
• <0: Error code on failure.

int rte_event_eth_rx_adapter_start

(

uint8_t

id

)

Warning

EXPERIMENTAL: this API may change without prior notice

Start ethernet Rx event adapter

Parameters

id	Adapter identifier.

Returns

• 0: Success, Adapter started correctly.
• <0: Error code on failure.

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, and examples/eventdev_pipeline/pipeline_worker_tx.c.

int rte_event_eth_rx_adapter_stop

(

uint8_t

id

)

Warning

EXPERIMENTAL: this API may change without prior notice

Stop ethernet Rx event adapter

Parameters

id	Adapter identifier.

Returns

• 0: Success, Adapter started correctly.
• <0: Error code on failure.

Examples:

examples/eventdev_pipeline/main.c.

int rte_event_eth_rx_adapter_stats_get	(	uint8_t	id,
		struct rte_event_eth_rx_adapter_stats *	stats
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Retrieve statistics for an adapter

Parameters

	id	Adapter identifier.
[out]	stats	A pointer to structure used to retrieve statistics for an adapter.

Returns

• 0: Success, retrieved successfully.
• <0: Error code on failure.

int rte_event_eth_rx_adapter_stats_reset

(

uint8_t

id

)

Warning

EXPERIMENTAL: this API may change without prior notice

Reset statistics for an adapter.

Parameters

id	Adapter identifier.

Returns

• 0: Success, statistics reset successfully.
• <0: Error code on failure.

int rte_event_eth_rx_adapter_service_id_get	(	uint8_t	id,
		uint32_t *	service_id
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Retrieve the service ID of an adapter. If the adapter doesn't use a rte_service function, this function returns -ESRCH.

Parameters

	id	Adapter identifier.
[out]	service_id	A pointer to a uint32_t, to be filled in with the service id.

Returns

• 0: Success
• <0: Error code on failure, if the adapter doesn't use a rte_service function, this function returns -ESRCH.

Examples:

examples/eventdev_pipeline/pipeline_worker_generic.c, and examples/eventdev_pipeline/pipeline_worker_tx.c.

int __rte_experimental 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
	)

Warning

EXPERIMENTAL: this API may change without prior notice

Register callback to process Rx packets, this is supported for SW based packet transfers.

See Also

rte_event_eth_rx_cb_fn

Parameters

id	Adapter identifier.
eth_dev_id	Port identifier of Ethernet device.
cb_fn	Callback function.
cb_arg	Callback arg.

Returns

• 0: Success
• <0: Error code on failure.