Data Structures¶

struct rte_eth_stats
struct rte_eth_link
struct rte_eth_thresh
struct rte_eth_rxmode
struct rte_vlan_filter_conf
struct rte_eth_rss_conf
struct rte_eth_rss_reta_entry64
struct rte_eth_vmdq_dcb_conf
struct rte_eth_vmdq_rx_conf
struct rte_eth_txmode
struct rte_eth_rxseg_split
union rte_eth_rxseg
struct rte_eth_rxconf
struct rte_eth_txconf
struct rte_eth_hairpin_queue_cap
struct rte_eth_hairpin_cap
struct rte_eth_hairpin_peer
struct rte_eth_hairpin_conf
struct rte_eth_desc_lim
struct rte_eth_fc_conf
struct rte_eth_pfc_conf
struct rte_eth_pfc_queue_info
struct rte_eth_pfc_queue_conf
struct rte_eth_udp_tunnel
struct rte_eth_intr_conf
struct rte_eth_conf
struct rte_eth_dev_portconf
struct rte_eth_switch_info
struct rte_eth_rxseg_capa
struct rte_eth_dev_info
struct rte_eth_rxq_info
struct rte_eth_txq_info
struct rte_eth_recycle_rxq_info
struct rte_eth_burst_mode
struct rte_eth_xstat
struct rte_eth_xstat_name
struct rte_eth_dcb_tc_queue_mapping
struct rte_eth_dcb_info
struct rte_eth_dev_tx_buffer
struct rte_eth_event_macsec_desc
struct rte_eth_event_ipsec_desc
struct rte_eth_representor_range
struct rte_eth_representor_info
struct rte_eth_ip_reassembly_params
struct rte_eth_ip_reassembly_dynfield_t
struct rte_eth_cman_info
struct rte_eth_cman_config

Macros¶

#define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter)
#define RTE_ETH_FLOW_PORT 18
#define RTE_ETH_FLOW_VXLAN 19
#define RTE_ETH_FLOW_GENEVE 20
#define RTE_ETH_FLOW_NVGRE 21
#define RTE_ETH_FLOW_VXLAN_GPE 22
#define RTE_ETH_FLOW_GTPU 23
#define RTE_ETH_RSS_L4_CHKSUM RTE_BIT64(35)
#define RTE_ETH_RSS_LEVEL_PMD_DEFAULT (UINT64_C(0) << 50)
#define RTE_ETH_RSS_LEVEL_OUTERMOST (UINT64_C(1) << 50)
#define RTE_ETH_RSS_LEVEL_INNERMOST (UINT64_C(2) << 50)
#define RTE_ETH_RSS_PROTO_MASK
#define RTE_ETH_NUM_RECEIVE_MAC_ADDR 128
#define RTE_ETH_VMDQ_NUM_UC_HASH_ARRAY 128
#define RTE_ETH_RX_OFFLOAD_VLAN_STRIP RTE_BIT64(0)
#define RTE_ETH_RX_OFFLOAD_TIMESTAMP RTE_BIT64(14)
#define RTE_ETH_TX_OFFLOAD_VLAN_INSERT RTE_BIT64(0)
#define RTE_ETH_TX_OFFLOAD_OUTER_IPV4_CKSUM RTE_BIT64(7)
#define RTE_ETH_TX_OFFLOAD_VXLAN_TNL_TSO RTE_BIT64(9)
#define RTE_ETH_TX_OFFLOAD_GRE_TNL_TSO RTE_BIT64(10)
#define RTE_ETH_TX_OFFLOAD_IPIP_TNL_TSO RTE_BIT64(11)
#define RTE_ETH_TX_OFFLOAD_GENEVE_TNL_TSO RTE_BIT64(12)
#define RTE_ETH_TX_OFFLOAD_MT_LOCKFREE RTE_BIT64(14)
#define RTE_ETH_TX_OFFLOAD_MULTI_SEGS RTE_BIT64(15)
#define RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE RTE_BIT64(16)
#define RTE_ETH_TX_OFFLOAD_UDP_TNL_TSO RTE_BIT64(18)
#define RTE_ETH_TX_OFFLOAD_IP_TNL_TSO RTE_BIT64(19)
#define RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM RTE_BIT64(20)
#define RTE_ETH_TX_OFFLOAD_SEND_ON_TIMESTAMP RTE_BIT64(21)
#define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (UINT16_MAX)
#define RTE_ETH_BURST_FLAG_PER_QUEUE RTE_BIT64(0)
#define RTE_ETH_BURST_MODE_INFO_SIZE 1024
#define RTE_ETH_XSTATS_NAME_SIZE 64
#define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o)
#define RTE_ETH_FOREACH_DEV(p) RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)
#define RTE_ETH_FOREACH_DEV_OF(port_id, parent)
#define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id)
#define RTE_ETH_TX_BUFFER_SIZE(sz) (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))
#define RTE_ETH_RX_METADATA_USER_FLAG RTE_BIT64(0)
#define RTE_ETH_RX_METADATA_USER_MARK RTE_BIT64(1)
#define RTE_ETH_RX_METADATA_TUNNEL_ID RTE_BIT64(2)
#define RTE_ETH_DEV_REASSEMBLY_F_IPV4 (RTE_BIT32(0))
#define RTE_ETH_DEV_REASSEMBLY_F_IPV6 (RTE_BIT32(1))

Link speed capabilities
Device supported speeds bitmap flags

#define RTE_ETH_LINK_SPEED_AUTONEG 0
#define RTE_ETH_LINK_SPEED_FIXED RTE_BIT32(0)
#define RTE_ETH_LINK_SPEED_10M_HD RTE_BIT32(1)
#define RTE_ETH_LINK_SPEED_10M RTE_BIT32(2)
#define RTE_ETH_LINK_SPEED_100M_HD RTE_BIT32(3)
#define RTE_ETH_LINK_SPEED_100M RTE_BIT32(4)
#define RTE_ETH_LINK_SPEED_1G RTE_BIT32(5)
#define RTE_ETH_LINK_SPEED_2_5G RTE_BIT32(6)
#define RTE_ETH_LINK_SPEED_5G RTE_BIT32(7)
#define RTE_ETH_LINK_SPEED_10G RTE_BIT32(8)
#define RTE_ETH_LINK_SPEED_20G RTE_BIT32(9)
#define RTE_ETH_LINK_SPEED_25G RTE_BIT32(10)
#define RTE_ETH_LINK_SPEED_40G RTE_BIT32(11)
#define RTE_ETH_LINK_SPEED_50G RTE_BIT32(12)
#define RTE_ETH_LINK_SPEED_56G RTE_BIT32(13)
#define RTE_ETH_LINK_SPEED_100G RTE_BIT32(14)
#define RTE_ETH_LINK_SPEED_200G RTE_BIT32(15)
#define RTE_ETH_LINK_SPEED_400G RTE_BIT32(16)

Link speed
Ethernet numeric link speeds in Mbps

#define RTE_ETH_SPEED_NUM_NONE 0
#define RTE_ETH_SPEED_NUM_10M 10
#define RTE_ETH_SPEED_NUM_100M 100
#define RTE_ETH_SPEED_NUM_1G 1000
#define RTE_ETH_SPEED_NUM_2_5G 2500
#define RTE_ETH_SPEED_NUM_5G 5000
#define RTE_ETH_SPEED_NUM_10G 10000
#define RTE_ETH_SPEED_NUM_20G 20000
#define RTE_ETH_SPEED_NUM_25G 25000
#define RTE_ETH_SPEED_NUM_40G 40000
#define RTE_ETH_SPEED_NUM_50G 50000
#define RTE_ETH_SPEED_NUM_56G 56000
#define RTE_ETH_SPEED_NUM_100G 100000
#define RTE_ETH_SPEED_NUM_200G 200000
#define RTE_ETH_SPEED_NUM_400G 400000
#define RTE_ETH_SPEED_NUM_UNKNOWN UINT32_MAX

Link negotiation
Constants used in link management.

#define RTE_ETH_LINK_HALF_DUPLEX 0
#define RTE_ETH_LINK_FULL_DUPLEX 1
#define RTE_ETH_LINK_DOWN 0
#define RTE_ETH_LINK_UP 1
#define RTE_ETH_LINK_FIXED 0
#define RTE_ETH_LINK_AUTONEG 1
#define RTE_ETH_LINK_MAX_STR_LEN 40

Multi-queue mode

See also

#define RTE_ETH_MQ_RX_RSS_FLAG RTE_BIT32(0)
#define RTE_ETH_MQ_RX_DCB_FLAG RTE_BIT32(1)
#define RTE_ETH_MQ_RX_VMDQ_FLAG RTE_BIT32(2)

VMDq and DCB maximums

#define RTE_ETH_VMDQ_MAX_VLAN_FILTERS 64
#define RTE_ETH_DCB_NUM_USER_PRIORITIES 8
#define RTE_ETH_VMDQ_DCB_NUM_QUEUES 128
#define RTE_ETH_DCB_NUM_QUEUES 128

DCB capabilities

#define RTE_ETH_DCB_PG_SUPPORT RTE_BIT32(0)
#define RTE_ETH_DCB_PFC_SUPPORT RTE_BIT32(1)

VLAN offload bits

#define RTE_ETH_VLAN_STRIP_OFFLOAD 0x0001
#define RTE_ETH_VLAN_FILTER_OFFLOAD 0x0002
#define RTE_ETH_VLAN_EXTEND_OFFLOAD 0x0004
#define RTE_ETH_QINQ_STRIP_OFFLOAD 0x0008
#define RTE_ETH_VLAN_STRIP_MASK 0x0001
#define RTE_ETH_VLAN_FILTER_MASK 0x0002
#define RTE_ETH_VLAN_EXTEND_MASK 0x0004
#define RTE_ETH_QINQ_STRIP_MASK 0x0008
#define RTE_ETH_VLAN_ID_MAX 0x0FFF

VMDq Rx mode

See also

#define RTE_ETH_VMDQ_ACCEPT_UNTAG RTE_BIT32(0)
#define RTE_ETH_VMDQ_ACCEPT_HASH_MC RTE_BIT32(1)
#define RTE_ETH_VMDQ_ACCEPT_HASH_UC RTE_BIT32(2)
#define RTE_ETH_VMDQ_ACCEPT_BROADCAST RTE_BIT32(3)
#define RTE_ETH_VMDQ_ACCEPT_MULTICAST RTE_BIT32(4)

Device capabilities
Non-offload capabilities reported in rte_eth_dev_info.dev_capa.

#define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP RTE_BIT64(0)
#define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP RTE_BIT64(1)
#define RTE_ETH_DEV_CAPA_RXQ_SHARE RTE_BIT64(2)
#define RTE_ETH_DEV_CAPA_FLOW_RULE_KEEP RTE_BIT64(3)
#define RTE_ETH_DEV_CAPA_FLOW_SHARED_OBJECT_KEEP RTE_BIT64(4)

Rx/Tx queue states

#define RTE_ETH_QUEUE_STATE_STOPPED 0
#define RTE_ETH_QUEUE_STATE_STARTED 1
#define RTE_ETH_QUEUE_STATE_HAIRPIN 2

Device flags
Flags internally saved in rte_eth_dev_data.dev_flags and reported in rte_eth_dev_info.dev_flags.

#define RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE RTE_BIT32(0)
#define RTE_ETH_DEV_INTR_LSC RTE_BIT32(1)
#define RTE_ETH_DEV_BONDING_MEMBER RTE_BIT32(2)
#define RTE_ETH_DEV_INTR_RMV RTE_BIT32(3)
#define RTE_ETH_DEV_REPRESENTOR RTE_BIT32(4)
#define RTE_ETH_DEV_NOLIVE_MAC_ADDR RTE_BIT32(5)
#define RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS RTE_BIT32(6)

Rx hardware descriptor states

See also

#define RTE_ETH_RX_DESC_AVAIL 0
#define RTE_ETH_RX_DESC_DONE 1
#define RTE_ETH_RX_DESC_UNAVAIL 2

Tx hardware descriptor states

See also

#define RTE_ETH_TX_DESC_FULL 0
#define RTE_ETH_TX_DESC_DONE 1
#define RTE_ETH_TX_DESC_UNAVAIL 2

Typedefs¶

typedef uint16_t(* rte_rx_callback_fn) (uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts, void *user_param)
typedef uint16_t(* rte_tx_callback_fn) (uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param)
typedef int(* rte_eth_dev_cb_fn) (uint16_t port_id, enum rte_eth_event_type event, void *cb_arg, void *ret_param)

Enumerations¶

enum rte_eth_rx_mq_mode { RTE_ETH_MQ_RX_NONE = 0, RTE_ETH_MQ_RX_RSS = RTE_ETH_MQ_RX_RSS_FLAG, RTE_ETH_MQ_RX_DCB = RTE_ETH_MQ_RX_DCB_FLAG, RTE_ETH_MQ_RX_DCB_RSS = RTE_ETH_MQ_RX_RSS_FLAG | RTE_ETH_MQ_RX_DCB_FLAG, RTE_ETH_MQ_RX_VMDQ_ONLY = RTE_ETH_MQ_RX_VMDQ_FLAG, RTE_ETH_MQ_RX_VMDQ_RSS = RTE_ETH_MQ_RX_RSS_FLAG | RTE_ETH_MQ_RX_VMDQ_FLAG, RTE_ETH_MQ_RX_VMDQ_DCB = RTE_ETH_MQ_RX_VMDQ_FLAG | RTE_ETH_MQ_RX_DCB_FLAG, RTE_ETH_MQ_RX_VMDQ_DCB_RSS }
enum rte_eth_tx_mq_mode { RTE_ETH_MQ_TX_NONE = 0, RTE_ETH_MQ_TX_DCB, RTE_ETH_MQ_TX_VMDQ_DCB, RTE_ETH_MQ_TX_VMDQ_ONLY }
enum rte_vlan_type { }
enum rte_eth_hash_function { RTE_ETH_HASH_FUNCTION_DEFAULT = 0, RTE_ETH_HASH_FUNCTION_TOEPLITZ, RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ, RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ_SORT, RTE_ETH_HASH_FUNCTION_MAX }
enum rte_eth_nb_tcs { RTE_ETH_4_TCS = 4, RTE_ETH_8_TCS = 8 }
enum rte_eth_nb_pools { RTE_ETH_8_POOLS = 8, RTE_ETH_16_POOLS = 16, RTE_ETH_32_POOLS = 32, RTE_ETH_64_POOLS = 64 }
enum rte_eth_fc_mode { RTE_ETH_FC_NONE = 0, RTE_ETH_FC_RX_PAUSE, RTE_ETH_FC_TX_PAUSE, RTE_ETH_FC_FULL }
enum rte_eth_tunnel_type
enum rte_eth_representor_type { RTE_ETH_REPRESENTOR_NONE, RTE_ETH_REPRESENTOR_VF, RTE_ETH_REPRESENTOR_SF, RTE_ETH_REPRESENTOR_PF }
enum rte_eth_err_handle_mode { RTE_ETH_ERROR_HANDLE_MODE_NONE, RTE_ETH_ERROR_HANDLE_MODE_PASSIVE, RTE_ETH_ERROR_HANDLE_MODE_PROACTIVE }
enum rte_eth_fec_mode { RTE_ETH_FEC_NOFEC = 0, RTE_ETH_FEC_AUTO, RTE_ETH_FEC_BASER, RTE_ETH_FEC_RS, RTE_ETH_FEC_LLRS }
enum rte_eth_dev_state { RTE_ETH_DEV_UNUSED = 0, RTE_ETH_DEV_ATTACHED, RTE_ETH_DEV_REMOVED }
enum rte_eth_event_macsec_subtype { RTE_ETH_SUBEVENT_MACSEC_UNKNOWN, RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_V_EQ1, RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_E_EQ0_C_EQ1, RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_SL_GTE48, RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_ES_EQ1_SC_EQ1, RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_SC_EQ1_SCB_EQ1 }
enum rte_eth_event_macsec_type { RTE_ETH_EVENT_MACSEC_UNKNOWN, RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR, RTE_ETH_EVENT_MACSEC_RX_SA_PN_HARD_EXP, RTE_ETH_EVENT_MACSEC_RX_SA_PN_SOFT_EXP, RTE_ETH_EVENT_MACSEC_TX_SA_PN_HARD_EXP, RTE_ETH_EVENT_MACSEC_TX_SA_PN_SOFT_EXP, RTE_ETH_EVENT_MACSEC_SA_NOT_VALID }
enum rte_eth_event_ipsec_subtype { RTE_ETH_EVENT_IPSEC_PMD_ERROR_START = -256, RTE_ETH_EVENT_IPSEC_PMD_ERROR_END = -1, RTE_ETH_EVENT_IPSEC_UNKNOWN = 0, RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW, RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY, RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY, RTE_ETH_EVENT_IPSEC_SA_PKT_EXPIRY, RTE_ETH_EVENT_IPSEC_SA_BYTE_HARD_EXPIRY, RTE_ETH_EVENT_IPSEC_SA_PKT_HARD_EXPIRY, RTE_ETH_EVENT_IPSEC_MAX }
enum rte_eth_event_type { RTE_ETH_EVENT_UNKNOWN, RTE_ETH_EVENT_INTR_LSC, RTE_ETH_EVENT_QUEUE_STATE, RTE_ETH_EVENT_INTR_RESET, RTE_ETH_EVENT_VF_MBOX, RTE_ETH_EVENT_MACSEC, RTE_ETH_EVENT_INTR_RMV, RTE_ETH_EVENT_NEW, RTE_ETH_EVENT_DESTROY, RTE_ETH_EVENT_IPSEC, RTE_ETH_EVENT_FLOW_AGED, RTE_ETH_EVENT_RX_AVAIL_THRESH, RTE_ETH_EVENT_ERR_RECOVERING, RTE_ETH_EVENT_RECOVERY_SUCCESS, RTE_ETH_EVENT_RECOVERY_FAILED, RTE_ETH_EVENT_MAX }
enum rte_eth_cman_obj { RTE_ETH_CMAN_OBJ_RX_QUEUE = RTE_BIT32(0), RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL = RTE_BIT32(1) }

Functions¶

int rte_eth_iterator_init (struct rte_dev_iterator *iter, const char *devargs)
uint16_t rte_eth_iterator_next (struct rte_dev_iterator *iter)
void rte_eth_iterator_cleanup (struct rte_dev_iterator *iter)
__extension__ struct rte_eth_link __rte_aligned (8)
static uint64_t rte_eth_rss_hf_refine (uint64_t rss_hf)
uint64_t rte_eth_find_next_owned_by (uint16_t port_id, const uint64_t owner_id)
uint16_t rte_eth_find_next (uint16_t port_id)
uint16_t rte_eth_find_next_of (uint16_t port_id_start, const struct rte_device *parent)
uint16_t rte_eth_find_next_sibling (uint16_t port_id_start, uint16_t ref_port_id)
int rte_eth_dev_owner_new (uint64_t *owner_id)
int rte_eth_dev_owner_set (const uint16_t port_id, const struct rte_eth_dev_owner *owner)
int rte_eth_dev_owner_unset (const uint16_t port_id, const uint64_t owner_id)
int rte_eth_dev_owner_delete (const uint64_t owner_id)
int rte_eth_dev_owner_get (const uint16_t port_id, struct rte_eth_dev_owner *owner)
uint16_t rte_eth_dev_count_avail (void)
uint16_t rte_eth_dev_count_total (void)
uint32_t rte_eth_speed_bitflag (uint32_t speed, int duplex)
const char * rte_eth_dev_rx_offload_name (uint64_t offload)
const char * rte_eth_dev_tx_offload_name (uint64_t offload)
__rte_experimental const char * rte_eth_dev_capability_name (uint64_t capability)
int rte_eth_dev_configure (uint16_t port_id, uint16_t nb_rx_queue, uint16_t nb_tx_queue, const struct rte_eth_conf *eth_conf)
int rte_eth_dev_is_removed (uint16_t port_id)
int rte_eth_rx_queue_setup (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc, unsigned int socket_id, const struct rte_eth_rxconf *rx_conf, struct rte_mempool *mb_pool)
__rte_experimental int rte_eth_rx_hairpin_queue_setup (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc, const struct rte_eth_hairpin_conf *conf)
int rte_eth_tx_queue_setup (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc, unsigned int socket_id, const struct rte_eth_txconf *tx_conf)
__rte_experimental int rte_eth_tx_hairpin_queue_setup (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc, const struct rte_eth_hairpin_conf *conf)
__rte_experimental int rte_eth_hairpin_get_peer_ports (uint16_t port_id, uint16_t *peer_ports, size_t len, uint32_t direction)
__rte_experimental int rte_eth_hairpin_bind (uint16_t tx_port, uint16_t rx_port)
__rte_experimental int rte_eth_hairpin_unbind (uint16_t tx_port, uint16_t rx_port)
__rte_experimental int rte_eth_dev_count_aggr_ports (uint16_t port_id)
__rte_experimental int rte_eth_dev_map_aggr_tx_affinity (uint16_t port_id, uint16_t tx_queue_id, uint8_t affinity)
int rte_eth_dev_socket_id (uint16_t port_id)
int rte_eth_dev_is_valid_port (uint16_t port_id)
__rte_experimental int rte_eth_rx_queue_is_valid (uint16_t port_id, uint16_t queue_id)
__rte_experimental int rte_eth_tx_queue_is_valid (uint16_t port_id, uint16_t queue_id)
int rte_eth_dev_rx_queue_start (uint16_t port_id, uint16_t rx_queue_id)
int rte_eth_dev_rx_queue_stop (uint16_t port_id, uint16_t rx_queue_id)
int rte_eth_dev_tx_queue_start (uint16_t port_id, uint16_t tx_queue_id)
int rte_eth_dev_tx_queue_stop (uint16_t port_id, uint16_t tx_queue_id)
int rte_eth_dev_start (uint16_t port_id)
int rte_eth_dev_stop (uint16_t port_id)
int rte_eth_dev_set_link_up (uint16_t port_id)
int rte_eth_dev_set_link_down (uint16_t port_id)
int rte_eth_dev_close (uint16_t port_id)
int rte_eth_dev_reset (uint16_t port_id)
int rte_eth_promiscuous_enable (uint16_t port_id)
int rte_eth_promiscuous_disable (uint16_t port_id)
int rte_eth_promiscuous_get (uint16_t port_id)
int rte_eth_allmulticast_enable (uint16_t port_id)
int rte_eth_allmulticast_disable (uint16_t port_id)
int rte_eth_allmulticast_get (uint16_t port_id)
int rte_eth_link_get (uint16_t port_id, struct rte_eth_link *link)
int rte_eth_link_get_nowait (uint16_t port_id, struct rte_eth_link *link)
__rte_experimental const char * rte_eth_link_speed_to_str (uint32_t link_speed)
__rte_experimental int rte_eth_link_to_str (char *str, size_t len, const struct rte_eth_link *eth_link)
int rte_eth_stats_get (uint16_t port_id, struct rte_eth_stats *stats)
int rte_eth_stats_reset (uint16_t port_id)
int rte_eth_xstats_get_names (uint16_t port_id, struct rte_eth_xstat_name *xstats_names, unsigned int size)
int rte_eth_xstats_get (uint16_t port_id, struct rte_eth_xstat *xstats, unsigned int n)
int rte_eth_xstats_get_names_by_id (uint16_t port_id, struct rte_eth_xstat_name *xstats_names, unsigned int size, uint64_t *ids)
int rte_eth_xstats_get_by_id (uint16_t port_id, const uint64_t *ids, uint64_t *values, unsigned int size)
int rte_eth_xstats_get_id_by_name (uint16_t port_id, const char *xstat_name, uint64_t *id)
int rte_eth_xstats_reset (uint16_t port_id)
int rte_eth_dev_set_tx_queue_stats_mapping (uint16_t port_id, uint16_t tx_queue_id, uint8_t stat_idx)
int rte_eth_dev_set_rx_queue_stats_mapping (uint16_t port_id, uint16_t rx_queue_id, uint8_t stat_idx)
int rte_eth_macaddr_get (uint16_t port_id, struct rte_ether_addr *mac_addr)
__rte_experimental int rte_eth_macaddrs_get (uint16_t port_id, struct rte_ether_addr *ma, unsigned int num)
int rte_eth_dev_info_get (uint16_t port_id, struct rte_eth_dev_info *dev_info)
__rte_experimental int rte_eth_dev_conf_get (uint16_t port_id, struct rte_eth_conf *dev_conf)
int rte_eth_dev_fw_version_get (uint16_t port_id, char *fw_version, size_t fw_size)
int rte_eth_dev_get_supported_ptypes (uint16_t port_id, uint32_t ptype_mask, uint32_t *ptypes, int num)
int rte_eth_dev_set_ptypes (uint16_t port_id, uint32_t ptype_mask, uint32_t *set_ptypes, unsigned int num)
int rte_eth_dev_get_mtu (uint16_t port_id, uint16_t *mtu)
int rte_eth_dev_set_mtu (uint16_t port_id, uint16_t mtu)
int rte_eth_dev_vlan_filter (uint16_t port_id, uint16_t vlan_id, int on)
int rte_eth_dev_set_vlan_strip_on_queue (uint16_t port_id, uint16_t rx_queue_id, int on)
int rte_eth_dev_set_vlan_ether_type (uint16_t port_id, enum rte_vlan_type vlan_type, uint16_t tag_type)
int rte_eth_dev_set_vlan_offload (uint16_t port_id, int offload_mask)
int rte_eth_dev_get_vlan_offload (uint16_t port_id)
int rte_eth_dev_set_vlan_pvid (uint16_t port_id, uint16_t pvid, int on)
__rte_experimental int rte_eth_rx_avail_thresh_set (uint16_t port_id, uint16_t queue_id, uint8_t avail_thresh)
__rte_experimental int rte_eth_rx_avail_thresh_query (uint16_t port_id, uint16_t *queue_id, uint8_t *avail_thresh)
int rte_eth_tx_buffer_init (struct rte_eth_dev_tx_buffer *buffer, uint16_t size)
int rte_eth_tx_buffer_set_err_callback (struct rte_eth_dev_tx_buffer *buffer, buffer_tx_error_fn callback, void *userdata)
void rte_eth_tx_buffer_drop_callback (struct rte_mbuf **pkts, uint16_t unsent, void *userdata)
void rte_eth_tx_buffer_count_callback (struct rte_mbuf **pkts, uint16_t unsent, void *userdata)
int rte_eth_tx_done_cleanup (uint16_t port_id, uint16_t queue_id, uint32_t free_cnt)
int rte_eth_dev_callback_register (uint16_t port_id, enum rte_eth_event_type event, rte_eth_dev_cb_fn cb_fn, void *cb_arg)
int rte_eth_dev_callback_unregister (uint16_t port_id, enum rte_eth_event_type event, rte_eth_dev_cb_fn cb_fn, void *cb_arg)
int rte_eth_dev_rx_intr_enable (uint16_t port_id, uint16_t queue_id)
int rte_eth_dev_rx_intr_disable (uint16_t port_id, uint16_t queue_id)
int rte_eth_dev_rx_intr_ctl (uint16_t port_id, int epfd, int op, void *data)
int rte_eth_dev_rx_intr_ctl_q (uint16_t port_id, uint16_t queue_id, int epfd, int op, void *data)
int rte_eth_dev_rx_intr_ctl_q_get_fd (uint16_t port_id, uint16_t queue_id)
int rte_eth_led_on (uint16_t port_id)
int rte_eth_led_off (uint16_t port_id)
__rte_experimental int rte_eth_fec_get_capability (uint16_t port_id, struct rte_eth_fec_capa *speed_fec_capa, unsigned int num)
__rte_experimental int rte_eth_fec_get (uint16_t port_id, uint32_t *fec_capa)
__rte_experimental int rte_eth_fec_set (uint16_t port_id, uint32_t fec_capa)
int rte_eth_dev_flow_ctrl_get (uint16_t port_id, struct rte_eth_fc_conf *fc_conf)
int rte_eth_dev_flow_ctrl_set (uint16_t port_id, struct rte_eth_fc_conf *fc_conf)
int rte_eth_dev_priority_flow_ctrl_set (uint16_t port_id, struct rte_eth_pfc_conf *pfc_conf)
int rte_eth_dev_mac_addr_add (uint16_t port_id, struct rte_ether_addr *mac_addr, uint32_t pool)
__rte_experimental int rte_eth_dev_priority_flow_ctrl_queue_info_get (uint16_t port_id, struct rte_eth_pfc_queue_info *pfc_queue_info)
__rte_experimental int rte_eth_dev_priority_flow_ctrl_queue_configure (uint16_t port_id, struct rte_eth_pfc_queue_conf *pfc_queue_conf)
int rte_eth_dev_mac_addr_remove (uint16_t port_id, struct rte_ether_addr *mac_addr)
int rte_eth_dev_default_mac_addr_set (uint16_t port_id, struct rte_ether_addr *mac_addr)
int rte_eth_dev_rss_reta_update (uint16_t port_id, struct rte_eth_rss_reta_entry64 *reta_conf, uint16_t reta_size)
int rte_eth_dev_rss_reta_query (uint16_t port_id, struct rte_eth_rss_reta_entry64 *reta_conf, uint16_t reta_size)
int rte_eth_dev_uc_hash_table_set (uint16_t port_id, struct rte_ether_addr *addr, uint8_t on)
int rte_eth_dev_uc_all_hash_table_set (uint16_t port_id, uint8_t on)
int rte_eth_set_queue_rate_limit (uint16_t port_id, uint16_t queue_idx, uint32_t tx_rate)
int rte_eth_dev_rss_hash_update (uint16_t port_id, struct rte_eth_rss_conf *rss_conf)
int rte_eth_dev_rss_hash_conf_get (uint16_t port_id, struct rte_eth_rss_conf *rss_conf)
__rte_experimental const char * rte_eth_dev_rss_algo_name (enum rte_eth_hash_function rss_algo)
int rte_eth_dev_udp_tunnel_port_add (uint16_t port_id, struct rte_eth_udp_tunnel *tunnel_udp)
int rte_eth_dev_udp_tunnel_port_delete (uint16_t port_id, struct rte_eth_udp_tunnel *tunnel_udp)
int rte_eth_dev_get_dcb_info (uint16_t port_id, struct rte_eth_dcb_info *dcb_info)
const struct rte_eth_rxtx_callback * rte_eth_add_rx_callback (uint16_t port_id, uint16_t queue_id, rte_rx_callback_fn fn, void *user_param)
const struct rte_eth_rxtx_callback * rte_eth_add_first_rx_callback (uint16_t port_id, uint16_t queue_id, rte_rx_callback_fn fn, void *user_param)
const struct rte_eth_rxtx_callback * rte_eth_add_tx_callback (uint16_t port_id, uint16_t queue_id, rte_tx_callback_fn fn, void *user_param)
int rte_eth_remove_rx_callback (uint16_t port_id, uint16_t queue_id, const struct rte_eth_rxtx_callback *user_cb)
int rte_eth_remove_tx_callback (uint16_t port_id, uint16_t queue_id, const struct rte_eth_rxtx_callback *user_cb)
int rte_eth_rx_queue_info_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_rxq_info *qinfo)
int rte_eth_tx_queue_info_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_txq_info *qinfo)
__rte_experimental int rte_eth_recycle_rx_queue_info_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_recycle_rxq_info *recycle_rxq_info)
int rte_eth_rx_burst_mode_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_burst_mode *mode)
int rte_eth_tx_burst_mode_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_burst_mode *mode)
__rte_experimental int rte_eth_get_monitor_addr (uint16_t port_id, uint16_t queue_id, struct rte_power_monitor_cond *pmc)
int rte_eth_dev_get_reg_info (uint16_t port_id, struct rte_dev_reg_info *info)
int rte_eth_dev_get_eeprom_length (uint16_t port_id)
int rte_eth_dev_get_eeprom (uint16_t port_id, struct rte_dev_eeprom_info *info)
int rte_eth_dev_set_eeprom (uint16_t port_id, struct rte_dev_eeprom_info *info)
__rte_experimental int rte_eth_dev_get_module_info (uint16_t port_id, struct rte_eth_dev_module_info *modinfo)
__rte_experimental int rte_eth_dev_get_module_eeprom (uint16_t port_id, struct rte_dev_eeprom_info *info)
int rte_eth_dev_set_mc_addr_list (uint16_t port_id, struct rte_ether_addr *mc_addr_set, uint32_t nb_mc_addr)
int rte_eth_timesync_enable (uint16_t port_id)
int rte_eth_timesync_disable (uint16_t port_id)
int rte_eth_timesync_read_rx_timestamp (uint16_t port_id, struct timespec *timestamp, uint32_t flags)
int rte_eth_timesync_read_tx_timestamp (uint16_t port_id, struct timespec *timestamp)
int rte_eth_timesync_adjust_time (uint16_t port_id, int64_t delta)
int rte_eth_timesync_read_time (uint16_t port_id, struct timespec *time)
int rte_eth_timesync_write_time (uint16_t port_id, const struct timespec *time)
__rte_experimental int rte_eth_read_clock (uint16_t port_id, uint64_t *clock)
int rte_eth_dev_get_port_by_name (const char *name, uint16_t *port_id)
int rte_eth_dev_get_name_by_port (uint16_t port_id, char *name)
int rte_eth_dev_adjust_nb_rx_tx_desc (uint16_t port_id, uint16_t *nb_rx_desc, uint16_t *nb_tx_desc)
int rte_eth_dev_pool_ops_supported (uint16_t port_id, const char *pool)
void * rte_eth_dev_get_sec_ctx (uint16_t port_id)
__rte_experimental int rte_eth_dev_hairpin_capability_get (uint16_t port_id, struct rte_eth_hairpin_cap *cap)
__rte_experimental int rte_eth_representor_info_get (uint16_t port_id, struct rte_eth_representor_info *info)
int rte_eth_rx_metadata_negotiate (uint16_t port_id, uint64_t *features)
__rte_experimental int rte_eth_ip_reassembly_capability_get (uint16_t port_id, struct rte_eth_ip_reassembly_params *capa)
__rte_experimental int rte_eth_ip_reassembly_conf_get (uint16_t port_id, struct rte_eth_ip_reassembly_params *conf)
__rte_experimental int rte_eth_ip_reassembly_conf_set (uint16_t port_id, const struct rte_eth_ip_reassembly_params *conf)
__rte_experimental int rte_eth_dev_priv_dump (uint16_t port_id, FILE *file)
__rte_experimental int rte_eth_rx_descriptor_dump (uint16_t port_id, uint16_t queue_id, uint16_t offset, uint16_t num, FILE *file)
__rte_experimental int rte_eth_tx_descriptor_dump (uint16_t port_id, uint16_t queue_id, uint16_t offset, uint16_t num, FILE *file)
__rte_experimental int rte_eth_cman_info_get (uint16_t port_id, struct rte_eth_cman_info *info)
__rte_experimental int rte_eth_cman_config_init (uint16_t port_id, struct rte_eth_cman_config *config)
__rte_experimental int rte_eth_cman_config_set (uint16_t port_id, const struct rte_eth_cman_config *config)
__rte_experimental int rte_eth_cman_config_get (uint16_t port_id, struct rte_eth_cman_config *config)
static uint16_t rte_eth_rx_burst (uint16_t port_id, uint16_t queue_id, struct rte_mbuf **rx_pkts, const uint16_t nb_pkts)
static int rte_eth_rx_queue_count (uint16_t port_id, uint16_t queue_id)
static int rte_eth_rx_descriptor_status (uint16_t port_id, uint16_t queue_id, uint16_t offset)
static int rte_eth_tx_descriptor_status (uint16_t port_id, uint16_t queue_id, uint16_t offset)
static uint16_t rte_eth_tx_burst (uint16_t port_id, uint16_t queue_id, struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
static uint16_t rte_eth_tx_prepare (uint16_t port_id, uint16_t queue_id, struct rte_mbuf **tx_pkts, uint16_t nb_pkts)
static uint16_t rte_eth_tx_buffer_flush (uint16_t port_id, uint16_t queue_id, struct rte_eth_dev_tx_buffer *buffer)
static __rte_always_inline uint16_t rte_eth_tx_buffer (uint16_t port_id, uint16_t queue_id, struct rte_eth_dev_tx_buffer *buffer, struct rte_mbuf *tx_pkt)
static __rte_experimental uint16_t rte_eth_recycle_mbufs (uint16_t rx_port_id, uint16_t rx_queue_id, uint16_t tx_port_id, uint16_t tx_queue_id, struct rte_eth_recycle_rxq_info *recycle_rxq_info)
__rte_experimental int rte_eth_buffer_split_get_supported_hdr_ptypes (uint16_t port_id, uint32_t *ptypes, int num)

Variables¶

uint32_t link_speed
uint16_t link_duplex
uint16_t link_autoneg
uint16_t link_status

#define RTE_ETH_FOREACH_MATCHING_DEV(id, devargs, iter)¶

Value:

   for (rte_eth_iterator_init(iter, devargs),          id = rte_eth_iterator_next(iter);          id != RTE_MAX_ETHPORTS;          id = rte_eth_iterator_next(iter))

If a break is done before the end of the loop, the function rte_eth_iterator_cleanup() must be called.

Parameters

Definition at line 246 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_AUTONEG 0¶

Autonegotiate (all speeds)

Definition at line 290 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_FIXED RTE_BIT32(0)¶

Disable autoneg (fixed speed)

Definition at line 291 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_10M_HD RTE_BIT32(1)¶

10 Mbps half-duplex

Definition at line 292 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_10M RTE_BIT32(2)¶

10 Mbps full-duplex

Definition at line 293 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_100M_HD RTE_BIT32(3)¶

100 Mbps half-duplex

Definition at line 294 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_100M RTE_BIT32(4)¶

100 Mbps full-duplex

Definition at line 295 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_1G RTE_BIT32(5)¶

1 Gbps

Definition at line 296 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_2_5G RTE_BIT32(6)¶

2.5 Gbps

Definition at line 297 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_5G RTE_BIT32(7)¶

5 Gbps

Definition at line 298 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_10G RTE_BIT32(8)¶

10 Gbps

Definition at line 299 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_20G RTE_BIT32(9)¶

20 Gbps

Definition at line 300 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_25G RTE_BIT32(10)¶

25 Gbps

Definition at line 301 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_40G RTE_BIT32(11)¶

40 Gbps

Definition at line 302 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_50G RTE_BIT32(12)¶

50 Gbps

Definition at line 303 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_56G RTE_BIT32(13)¶

56 Gbps

Definition at line 304 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_100G RTE_BIT32(14)¶

100 Gbps

Definition at line 305 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_200G RTE_BIT32(15)¶

200 Gbps

Definition at line 306 of file rte_ethdev.h.

#define RTE_ETH_LINK_SPEED_400G RTE_BIT32(16)¶

400 Gbps

Definition at line 307 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_NONE 0¶

Not defined

Definition at line 313 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_10M 10¶

10 Mbps

Definition at line 314 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_100M 100¶

100 Mbps

Definition at line 315 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_1G 1000¶

1 Gbps

Definition at line 316 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_2_5G 2500¶

2.5 Gbps

Definition at line 317 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_5G 5000¶

5 Gbps

Definition at line 318 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_10G 10000¶

10 Gbps

Definition at line 319 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_20G 20000¶

20 Gbps

Definition at line 320 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_25G 25000¶

25 Gbps

Definition at line 321 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_40G 40000¶

40 Gbps

Definition at line 322 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_50G 50000¶

50 Gbps

Definition at line 323 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_56G 56000¶

56 Gbps

Definition at line 324 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_100G 100000¶

100 Gbps

Definition at line 325 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_200G 200000¶

200 Gbps

Definition at line 326 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_400G 400000¶

400 Gbps

Definition at line 327 of file rte_ethdev.h.

#define RTE_ETH_SPEED_NUM_UNKNOWN UINT32_MAX¶

Unknown

Definition at line 328 of file rte_ethdev.h.

#define RTE_ETH_LINK_HALF_DUPLEX 0¶

Half-duplex connection (see link_duplex).

Definition at line 345 of file rte_ethdev.h.

#define RTE_ETH_LINK_FULL_DUPLEX 1¶

Full-duplex connection (see link_duplex).

Definition at line 346 of file rte_ethdev.h.

#define RTE_ETH_LINK_DOWN 0¶

Link is down (see link_status).

Definition at line 347 of file rte_ethdev.h.

#define RTE_ETH_LINK_UP 1¶

Link is up (see link_status).

Definition at line 348 of file rte_ethdev.h.

#define RTE_ETH_LINK_FIXED 0¶

No autonegotiation (see link_autoneg).

Definition at line 349 of file rte_ethdev.h.

#define RTE_ETH_LINK_AUTONEG 1¶

Autonegotiated (see link_autoneg).

Definition at line 350 of file rte_ethdev.h.

#define RTE_ETH_LINK_MAX_STR_LEN 40¶

Max length of default link string.

Definition at line 351 of file rte_ethdev.h.

#define RTE_ETH_MQ_RX_RSS_FLAG RTE_BIT32(0)¶

Enable RSS.

See also

Definition at line 367 of file rte_ethdev.h.

#define RTE_ETH_MQ_RX_DCB_FLAG RTE_BIT32(1)¶

Enable DCB.

Definition at line 368 of file rte_ethdev.h.

#define RTE_ETH_MQ_RX_VMDQ_FLAG RTE_BIT32(2)¶

Enable VMDq.

Definition at line 369 of file rte_ethdev.h.

#define RTE_ETH_FLOW_PORT 18¶

Consider device port number as a flow differentiator

Definition at line 529 of file rte_ethdev.h.

#define RTE_ETH_FLOW_VXLAN 19¶

VXLAN protocol based flow

Definition at line 530 of file rte_ethdev.h.

#define RTE_ETH_FLOW_GENEVE 20¶

GENEVE protocol based flow

Definition at line 531 of file rte_ethdev.h.

#define RTE_ETH_FLOW_NVGRE 21¶

NVGRE protocol based flow

Definition at line 532 of file rte_ethdev.h.

#define RTE_ETH_FLOW_VXLAN_GPE 22¶

VXLAN-GPE protocol based flow

Definition at line 533 of file rte_ethdev.h.

#define RTE_ETH_FLOW_GTPU 23¶

GTPU protocol based flow

Definition at line 534 of file rte_ethdev.h.

#define RTE_ETH_RSS_L4_CHKSUM RTE_BIT64(35)¶

The RTE_ETH_RSS_L4_CHKSUM works on checksum field of any L4 header. It is similar to RTE_ETH_RSS_PORT that they don't specify the specific type of L4 header. This macro is defined to replace some specific L4 (TCP/UDP/SCTP) checksum type for constructing the use of RSS offload bits.

Due to above reason, some old APIs (and configuration) don't support RTE_ETH_RSS_L4_CHKSUM. The rte_flow RSS API supports it.

For the case that checksum is not used in an UDP header, it takes the reserved value 0 as input for the hash function.

Definition at line 586 of file rte_ethdev.h.

#define RTE_ETH_RSS_LEVEL_PMD_DEFAULT (UINT64_C(0) << 50)¶

level 0, requests the default behavior. Depending on the packet type, it can mean outermost, innermost, anything in between or even no RSS. It basically stands for the innermost encapsulation level RSS can be performed on according to PMD and device capabilities.

Definition at line 632 of file rte_ethdev.h.

#define RTE_ETH_RSS_LEVEL_OUTERMOST (UINT64_C(1) << 50)¶

level 1, requests RSS to be performed on the outermost packet encapsulation level.

Definition at line 638 of file rte_ethdev.h.

#define RTE_ETH_RSS_LEVEL_INNERMOST (UINT64_C(2) << 50)¶

level 2, requests RSS to be performed on the specified inner packet encapsulation level, from outermost to innermost (lower to higher values).

Definition at line 644 of file rte_ethdev.h.

#define RTE_ETH_RSS_PROTO_MASK¶

Value:

  (     RTE_ETH_RSS_IPV4 |     RTE_ETH_RSS_FRAG_IPV4 |     RTE_ETH_RSS_NONFRAG_IPV4_TCP |     RTE_ETH_RSS_NONFRAG_IPV4_UDP |     RTE_ETH_RSS_NONFRAG_IPV4_SCTP |     RTE_ETH_RSS_NONFRAG_IPV4_OTHER |     RTE_ETH_RSS_IPV6 |     RTE_ETH_RSS_FRAG_IPV6 |     RTE_ETH_RSS_NONFRAG_IPV6_TCP |     RTE_ETH_RSS_NONFRAG_IPV6_UDP |     RTE_ETH_RSS_NONFRAG_IPV6_SCTP |     RTE_ETH_RSS_NONFRAG_IPV6_OTHER |     RTE_ETH_RSS_L2_PAYLOAD |     RTE_ETH_RSS_IPV6_EX |     RTE_ETH_RSS_IPV6_TCP_EX |     RTE_ETH_RSS_IPV6_UDP_EX |     RTE_ETH_RSS_PORT  |     RTE_ETH_RSS_VXLAN |     RTE_ETH_RSS_GENEVE |     RTE_ETH_RSS_NVGRE |     RTE_ETH_RSS_MPLS)

Definition at line 800 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_MAX_VLAN_FILTERS 64¶

Maximum nb. of VMDq VLAN filters.

Definition at line 835 of file rte_ethdev.h.

#define RTE_ETH_DCB_NUM_USER_PRIORITIES 8¶

Maximum nb. of DCB priorities.

Definition at line 836 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_DCB_NUM_QUEUES 128¶

Maximum nb. of VMDq DCB queues.

Definition at line 837 of file rte_ethdev.h.

#define RTE_ETH_DCB_NUM_QUEUES 128¶

Maximum nb. of DCB queues.

Definition at line 838 of file rte_ethdev.h.

#define RTE_ETH_DCB_PG_SUPPORT RTE_BIT32(0)¶

Priority Group(ETS) support.

Definition at line 842 of file rte_ethdev.h.

#define RTE_ETH_DCB_PFC_SUPPORT RTE_BIT32(1)¶

Priority Flow Control support.

Definition at line 843 of file rte_ethdev.h.

#define RTE_ETH_VLAN_STRIP_OFFLOAD 0x0001¶

VLAN Strip On/Off

Definition at line 847 of file rte_ethdev.h.

#define RTE_ETH_VLAN_FILTER_OFFLOAD 0x0002¶

VLAN Filter On/Off

Definition at line 848 of file rte_ethdev.h.

#define RTE_ETH_VLAN_EXTEND_OFFLOAD 0x0004¶

VLAN Extend On/Off

Definition at line 849 of file rte_ethdev.h.

#define RTE_ETH_QINQ_STRIP_OFFLOAD 0x0008¶

QINQ Strip On/Off

Definition at line 850 of file rte_ethdev.h.

#define RTE_ETH_VLAN_STRIP_MASK 0x0001¶

VLAN Strip setting mask

Definition at line 852 of file rte_ethdev.h.

#define RTE_ETH_VLAN_FILTER_MASK 0x0002¶

VLAN Filter setting mask

Definition at line 853 of file rte_ethdev.h.

#define RTE_ETH_VLAN_EXTEND_MASK 0x0004¶

VLAN Extend setting mask

Definition at line 854 of file rte_ethdev.h.

#define RTE_ETH_QINQ_STRIP_MASK 0x0008¶

QINQ Strip setting mask

Definition at line 855 of file rte_ethdev.h.

#define RTE_ETH_VLAN_ID_MAX 0x0FFF¶

VLAN ID is in lower 12 bits

Definition at line 856 of file rte_ethdev.h.

#define RTE_ETH_NUM_RECEIVE_MAC_ADDR 128¶

Maximum nb. of receive mac addr.

Definition at line 860 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_NUM_UC_HASH_ARRAY 128¶

Maximum nb. of UC hash array.

Definition at line 863 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_ACCEPT_UNTAG RTE_BIT32(0)¶

Accept untagged packets.

Definition at line 869 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_ACCEPT_HASH_MC RTE_BIT32(1)¶

Accept packets in multicast table.

Definition at line 871 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_ACCEPT_HASH_UC RTE_BIT32(2)¶

Accept packets in unicast table.

Definition at line 873 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_ACCEPT_BROADCAST RTE_BIT32(3)¶

Accept broadcast packets.

Definition at line 875 of file rte_ethdev.h.

#define RTE_ETH_VMDQ_ACCEPT_MULTICAST RTE_BIT32(4)¶

Multicast promiscuous.

Definition at line 877 of file rte_ethdev.h.

#define RTE_ETH_RX_OFFLOAD_VLAN_STRIP RTE_BIT64(0)¶

Rx offload capabilities of a device.

Definition at line 1528 of file rte_ethdev.h.

#define RTE_ETH_RX_OFFLOAD_TIMESTAMP RTE_BIT64(14)¶

Timestamp is set by the driver in RTE_MBUF_DYNFIELD_TIMESTAMP_NAME and RTE_MBUF_DYNFLAG_RX_TIMESTAMP_NAME is set in ol_flags. The mbuf field and flag are registered when the offload is configured.

Definition at line 1544 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_VLAN_INSERT RTE_BIT64(0)¶

Tx offload capabilities of a device.

Definition at line 1568 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_OUTER_IPV4_CKSUM RTE_BIT64(7)¶

Used for tunneling packet.

Definition at line 1575 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_VXLAN_TNL_TSO RTE_BIT64(9)¶

Used for tunneling packet.

Definition at line 1577 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_GRE_TNL_TSO RTE_BIT64(10)¶

Used for tunneling packet.

Definition at line 1578 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_IPIP_TNL_TSO RTE_BIT64(11)¶

Used for tunneling packet.

Definition at line 1579 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_GENEVE_TNL_TSO RTE_BIT64(12)¶

Used for tunneling packet.

Definition at line 1580 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_MT_LOCKFREE RTE_BIT64(14)¶

Multiple threads can invoke rte_eth_tx_burst() concurrently on the same Tx queue without SW lock.

Definition at line 1586 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_MULTI_SEGS RTE_BIT64(15)¶

Device supports multi segment send.

Definition at line 1588 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_MBUF_FAST_FREE RTE_BIT64(16)¶

Device supports optimization for fast release of mbufs. When set application must guarantee that per-queue all mbufs comes from the same mempool and has refcnt = 1.

Definition at line 1594 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_UDP_TNL_TSO RTE_BIT64(18)¶

Device supports generic UDP tunneled packet TSO. Application must set RTE_MBUF_F_TX_TUNNEL_UDP and other mbuf fields required for tunnel TSO.

Definition at line 1601 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_IP_TNL_TSO RTE_BIT64(19)¶

Device supports generic IP tunneled packet TSO. Application must set RTE_MBUF_F_TX_TUNNEL_IP and other mbuf fields required for tunnel TSO.

Definition at line 1607 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_OUTER_UDP_CKSUM RTE_BIT64(20)¶

Device supports outer UDP checksum

Definition at line 1609 of file rte_ethdev.h.

#define RTE_ETH_TX_OFFLOAD_SEND_ON_TIMESTAMP RTE_BIT64(21)¶

Device sends on time read from RTE_MBUF_DYNFIELD_TIMESTAMP_NAME if RTE_MBUF_DYNFLAG_TX_TIMESTAMP_NAME is set in ol_flags. The mbuf field and flag are registered when the offload is configured.

Definition at line 1615 of file rte_ethdev.h.

#define RTE_ETH_DEV_CAPA_RUNTIME_RX_QUEUE_SETUP RTE_BIT64(0)¶

Device supports Rx queue setup after device started.

Definition at line 1625 of file rte_ethdev.h.

#define RTE_ETH_DEV_CAPA_RUNTIME_TX_QUEUE_SETUP RTE_BIT64(1)¶

Device supports Tx queue setup after device started.

Definition at line 1627 of file rte_ethdev.h.

#define RTE_ETH_DEV_CAPA_RXQ_SHARE RTE_BIT64(2)¶

Device supports shared Rx queue among ports within Rx domain and switch domain. Mbufs are consumed by shared Rx queue instead of each queue. Multiple groups are supported by share_group of Rx queue configuration. Shared Rx queue is identified by PMD using share_qid of Rx queue configuration. Polling any port in the group receive packets of all member ports, source port identified by mbuf->port field.

Definition at line 1637 of file rte_ethdev.h.

#define RTE_ETH_DEV_CAPA_FLOW_RULE_KEEP RTE_BIT64(3)¶

Device supports keeping flow rules across restart.

Definition at line 1639 of file rte_ethdev.h.

#define RTE_ETH_DEV_CAPA_FLOW_SHARED_OBJECT_KEEP RTE_BIT64(4)¶

Device supports keeping shared flow objects across restart.

Definition at line 1641 of file rte_ethdev.h.

#define RTE_ETH_DEV_SWITCH_DOMAIN_ID_INVALID (UINT16_MAX)¶

Default values for switch domain ID when ethdev does not support switch domain definitions.

Definition at line 1669 of file rte_ethdev.h.

#define RTE_ETH_QUEUE_STATE_STOPPED 0¶

Queue stopped.

Definition at line 1828 of file rte_ethdev.h.

#define RTE_ETH_QUEUE_STATE_STARTED 1¶

Queue started.

Definition at line 1829 of file rte_ethdev.h.

#define RTE_ETH_QUEUE_STATE_HAIRPIN 2¶

Queue used for hairpin.

Definition at line 1830 of file rte_ethdev.h.

#define RTE_ETH_BURST_FLAG_PER_QUEUE RTE_BIT64(0)¶

If the queues have different burst mode description, this bit will be set by PMD, then the application can iterate to retrieve burst description for all other queues.

Definition at line 1894 of file rte_ethdev.h.

#define RTE_ETH_BURST_MODE_INFO_SIZE 1024¶

Maximum size for information

Definition at line 1903 of file rte_ethdev.h.

#define RTE_ETH_XSTATS_NAME_SIZE 64¶

Maximum name length for extended statistics counters

Definition at line 1908 of file rte_ethdev.h.

#define RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE RTE_BIT32(0)¶

PMD supports thread-safe flow operations

Definition at line 2100 of file rte_ethdev.h.

#define RTE_ETH_DEV_INTR_LSC RTE_BIT32(1)¶

Device supports link state interrupt

Definition at line 2102 of file rte_ethdev.h.

#define RTE_ETH_DEV_BONDING_MEMBER RTE_BIT32(2)¶

Device is a bonding member

Definition at line 2104 of file rte_ethdev.h.

#define RTE_ETH_DEV_INTR_RMV RTE_BIT32(3)¶

Device supports device removal interrupt

Definition at line 2106 of file rte_ethdev.h.

#define RTE_ETH_DEV_REPRESENTOR RTE_BIT32(4)¶

Device is port representor

Definition at line 2108 of file rte_ethdev.h.

#define RTE_ETH_DEV_NOLIVE_MAC_ADDR RTE_BIT32(5)¶

Device does not support MAC change after started

Definition at line 2110 of file rte_ethdev.h.

#define RTE_ETH_DEV_AUTOFILL_QUEUE_XSTATS RTE_BIT32(6)¶

Queue xstats filled automatically by ethdev layer. PMDs filling the queue xstats themselves should not set this flag

Definition at line 2115 of file rte_ethdev.h.

#define RTE_ETH_FOREACH_DEV_OWNED_BY(p, o)¶

Value:

   for (p = rte_eth_find_next_owned_by(0, o);          (unsigned int)p < (unsigned int)RTE_MAX_ETHPORTS;          p = rte_eth_find_next_owned_by(p + 1, o))

Definition at line 2135 of file rte_ethdev.h.

#define RTE_ETH_FOREACH_DEV(p) RTE_ETH_FOREACH_DEV_OWNED_BY(p, RTE_ETH_DEV_NO_OWNER)¶

Macro to iterate over all enabled and ownerless ethdev ports.

Definition at line 2153 of file rte_ethdev.h.

#define RTE_ETH_FOREACH_DEV_OF(port_id, parent)¶

Value:

   for (port_id = rte_eth_find_next_of(0, parent);         port_id < RTE_MAX_ETHPORTS;         port_id = rte_eth_find_next_of(port_id + 1, parent))

Parameters

Definition at line 2179 of file rte_ethdev.h.

#define RTE_ETH_FOREACH_DEV_SIBLING(port_id, ref_port_id)¶

Value:

    for (port_id = rte_eth_find_next_sibling(0, ref_port_id);         port_id < RTE_MAX_ETHPORTS;         port_id = rte_eth_find_next_sibling(port_id + 1, ref_port_id))

Parameters

Definition at line 2208 of file rte_ethdev.h.

#define RTE_ETH_TX_BUFFER_SIZE(sz) (sizeof(struct rte_eth_dev_tx_buffer) + (sz) * sizeof(struct rte_mbuf *))¶

Calculate the size of the Tx buffer.

Parameters

Definition at line 3747 of file rte_ethdev.h.

#define RTE_ETH_RX_METADATA_USER_FLAG RTE_BIT64(0)¶

The NIC is able to deliver flag (if set) with packets to the PMD.

Definition at line 5514 of file rte_ethdev.h.

#define RTE_ETH_RX_METADATA_USER_MARK RTE_BIT64(1)¶

The NIC is able to deliver mark ID with packets to the PMD.

Definition at line 5517 of file rte_ethdev.h.

#define RTE_ETH_RX_METADATA_TUNNEL_ID RTE_BIT64(2)¶

The NIC is able to deliver tunnel ID with packets to the PMD.

Definition at line 5520 of file rte_ethdev.h.

#define RTE_ETH_DEV_REASSEMBLY_F_IPV4 (RTE_BIT32(0))¶

Flag to offload IP reassembly for IPv4 packets.

Definition at line 5564 of file rte_ethdev.h.

#define RTE_ETH_DEV_REASSEMBLY_F_IPV6 (RTE_BIT32(1))¶

Flag to offload IP reassembly for IPv6 packets.

Definition at line 5566 of file rte_ethdev.h.

#define RTE_ETH_RX_DESC_AVAIL 0¶

Desc available for hw.

Definition at line 6151 of file rte_ethdev.h.

#define RTE_ETH_RX_DESC_DONE 1¶

Desc done, filled by hw.

Definition at line 6152 of file rte_ethdev.h.

#define RTE_ETH_RX_DESC_UNAVAIL 2¶

Desc used by driver or hw.

Definition at line 6153 of file rte_ethdev.h.

#define RTE_ETH_TX_DESC_FULL 0¶

Desc filled for hw, waiting xmit.

Definition at line 6223 of file rte_ethdev.h.

#define RTE_ETH_TX_DESC_DONE 1¶

Desc done, packet is transmitted.

Definition at line 6224 of file rte_ethdev.h.

#define RTE_ETH_TX_DESC_UNAVAIL 2¶

Desc used by driver or hw.

Definition at line 6225 of file rte_ethdev.h.

typedef uint16_t(* rte_rx_callback_fn) (uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[], uint16_t nb_pkts, uint16_t max_pkts, void *user_param)¶

Function type used for Rx packet processing packet callbacks.

The callback function is called on Rx with a burst of packets that have been received on the given port and queue.

Parameters

Returns

Definition at line 2037 of file rte_ethdev.h.

typedef uint16_t(* rte_tx_callback_fn) (uint16_t port_id, uint16_t queue, struct rte_mbuf *pkts[], uint16_t nb_pkts, void *user_param)¶

Function type used for Tx packet processing packet callbacks.

The callback function is called on Tx with a burst of packets immediately before the packets are put onto the hardware queue for transmission.

Parameters

Returns

Definition at line 2061 of file rte_ethdev.h.

typedef int(* rte_eth_dev_cb_fn) (uint16_t port_id, enum rte_eth_event_type event, void *cb_arg, void *ret_param)¶

User application callback to be registered for interrupts.

Definition at line 4093 of file rte_ethdev.h.

enum rte_eth_rx_mq_mode¶

A set of values to identify what method is to be used to route packets to multiple queues.

Enumerator

RTE_ETH_MQ_RX_NONE

None of DCB, RSS or VMDq mode

RTE_ETH_MQ_RX_RSS

For Rx side, only RSS is on

RTE_ETH_MQ_RX_DCB

For Rx side,only DCB is on.

RTE_ETH_MQ_RX_DCB_RSS

Both DCB and RSS enable

RTE_ETH_MQ_RX_VMDQ_ONLY

Only VMDq, no RSS nor DCB

RTE_ETH_MQ_RX_VMDQ_RSS

RSS mode with VMDq

RTE_ETH_MQ_RX_VMDQ_DCB

Use VMDq+DCB to route traffic to queues

RTE_ETH_MQ_RX_VMDQ_DCB_RSS

Enable both VMDq and DCB in VMDq

Definition at line 376 of file rte_ethdev.h.

enum rte_eth_tx_mq_mode¶

A set of values to identify what method is to be used to transmit packets using multi-TCs.

Enumerator

RTE_ETH_MQ_TX_NONE

It is in neither DCB nor VT mode.

RTE_ETH_MQ_TX_DCB

For Tx side,only DCB is on.

RTE_ETH_MQ_TX_VMDQ_DCB

For Tx side,both DCB and VT is on.

RTE_ETH_MQ_TX_VMDQ_ONLY

Only VT on, no DCB

Definition at line 402 of file rte_ethdev.h.

enum rte_vlan_type¶

VLAN types to indicate if it is for single VLAN, inner VLAN or outer VLAN. Note that single VLAN is treated the same as inner VLAN.

Enumerator

RTE_ETH_VLAN_TYPE_INNER

Inner VLAN.

RTE_ETH_VLAN_TYPE_OUTER

Single VLAN, or outer VLAN.

Definition at line 433 of file rte_ethdev.h.

enum rte_eth_hash_function¶

Hash function types.

Enumerator

RTE_ETH_HASH_FUNCTION_DEFAULT

DEFAULT means driver decides which hash algorithm to pick.

RTE_ETH_HASH_FUNCTION_TOEPLITZ

Toeplitz

RTE_ETH_HASH_FUNCTION_SIMPLE_XOR

Simple XOR

RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ

Symmetric Toeplitz: src, dst will be replaced by xor(src, dst). For the case with src/dst only, src or dst address will xor with zero pair.

RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ_SORT

Symmetric Toeplitz: L3 and L4 fields are sorted prior to the hash function. If src_ip > dst_ip, swap src_ip and dst_ip. If src_port > dst_port, swap src_port and dst_port.

Definition at line 451 of file rte_ethdev.h.

enum rte_eth_nb_tcs¶

This enum indicates the possible number of traffic classes in DCB configurations

Enumerator

RTE_ETH_4_TCS

4 TCs with DCB.

RTE_ETH_8_TCS

8 TCs with DCB.

Definition at line 897 of file rte_ethdev.h.

enum rte_eth_nb_pools¶

This enum indicates the possible number of queue pools in VMDq configurations.

Enumerator

RTE_ETH_8_POOLS

8 VMDq pools.

RTE_ETH_16_POOLS

16 VMDq pools.

RTE_ETH_32_POOLS

32 VMDq pools.

RTE_ETH_64_POOLS

64 VMDq pools.

Definition at line 906 of file rte_ethdev.h.

enum rte_eth_fc_mode¶

This enum indicates the flow control mode

Enumerator

RTE_ETH_FC_NONE

Disable flow control.

RTE_ETH_FC_RX_PAUSE

Rx pause frame, enable flowctrl on Tx side.

RTE_ETH_FC_TX_PAUSE

Tx pause frame, enable flowctrl on Rx side.

RTE_ETH_FC_FULL

Enable flow control on both side.

Definition at line 1349 of file rte_ethdev.h.

enum rte_eth_tunnel_type¶

Tunnel type for device-specific classifier configuration.

See also

Definition at line 1438 of file rte_ethdev.h.

enum rte_eth_representor_type¶

Ethernet device information Ethernet device representor port type.

Enumerator

RTE_ETH_REPRESENTOR_NONE

not a representor.

RTE_ETH_REPRESENTOR_VF

representor of Virtual Function.

RTE_ETH_REPRESENTOR_SF

representor of Sub Function.

RTE_ETH_REPRESENTOR_PF

representor of Physical Function.

Definition at line 1715 of file rte_ethdev.h.

enum rte_eth_err_handle_mode¶

Warning

Ethernet device error handling mode.

Enumerator

RTE_ETH_ERROR_HANDLE_MODE_NONE

No error handling modes are supported.

RTE_ETH_ERROR_HANDLE_MODE_PASSIVE

Passive error handling, after the PMD detects that a reset is required, the PMD reports

See also

RTE_ETH_ERROR_HANDLE_MODE_PROACTIVE

Proactive error handling, after the PMD detects that a reset is required, the PMD reports

See also

Definition at line 1728 of file rte_ethdev.h.

enum rte_eth_fec_mode¶

This enum indicates the possible Forward Error Correction (FEC) modes of an ethdev port.

Enumerator

RTE_ETH_FEC_NOFEC

FEC is off

RTE_ETH_FEC_AUTO

FEC autonegotiation modes

RTE_ETH_FEC_BASER

FEC using common algorithm

RTE_ETH_FEC_RS

FEC using RS algorithm

RTE_ETH_FEC_LLRS

FEC using LLRS algorithm

Definition at line 1978 of file rte_ethdev.h.

enum rte_eth_dev_state¶

Possible states of an ethdev port.

Enumerator

RTE_ETH_DEV_UNUSED

Device is unused before being probed.

RTE_ETH_DEV_ATTACHED

Device is attached when allocated in probing.

RTE_ETH_DEV_REMOVED

Device is in removed state when plug-out is detected.

Definition at line 2067 of file rte_ethdev.h.

enum rte_eth_event_macsec_subtype¶

Subtypes for MACsec offload event (RTE_ETH_EVENT_MACSEC) raised by Ethernet device.

Enumerator

RTE_ETH_SUBEVENT_MACSEC_UNKNOWN

Notifies unknown MACsec subevent.

RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_V_EQ1

Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events Validation check: SecTag.TCI.V = 1

RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_E_EQ0_C_EQ1

Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events Validation check: SecTag.TCI.E = 0 && SecTag.TCI.C = 1

RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_SL_GTE48

Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events Validation check: SecTag.SL >= 'd48

RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_ES_EQ1_SC_EQ1

Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events Validation check: SecTag.TCI.ES = 1 && SecTag.TCI.SC = 1

RTE_ETH_SUBEVENT_MACSEC_RX_SECTAG_SC_EQ1_SCB_EQ1

Subevent of RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR sectag validation events Validation check: SecTag.TCI.SC = 1 && SecTag.TCI.SCB = 1

Definition at line 3876 of file rte_ethdev.h.

enum rte_eth_event_macsec_type¶

Event types for MACsec offload event (RTE_ETH_EVENT_MACSEC) raised by eth device.

Enumerator

RTE_ETH_EVENT_MACSEC_UNKNOWN

Notifies unknown MACsec event.

RTE_ETH_EVENT_MACSEC_SECTAG_VAL_ERR

Notifies Sectag validation failure events.

RTE_ETH_EVENT_MACSEC_RX_SA_PN_HARD_EXP

Notifies Rx SA hard expiry events.

RTE_ETH_EVENT_MACSEC_RX_SA_PN_SOFT_EXP

Notifies Rx SA soft expiry events.

RTE_ETH_EVENT_MACSEC_TX_SA_PN_HARD_EXP

Notifies Tx SA hard expiry events.

RTE_ETH_EVENT_MACSEC_TX_SA_PN_SOFT_EXP

Notifies Tx SA soft events.

RTE_ETH_EVENT_MACSEC_SA_NOT_VALID

Notifies Invalid SA event.

Definition at line 3910 of file rte_ethdev.h.

enum rte_eth_event_ipsec_subtype¶

Subtypes for IPsec offload event(RTE_ETH_EVENT_IPSEC) raised by eth device.

Enumerator

RTE_ETH_EVENT_IPSEC_PMD_ERROR_START

PMD specific error start

RTE_ETH_EVENT_IPSEC_PMD_ERROR_END

PMD specific error end

RTE_ETH_EVENT_IPSEC_UNKNOWN

Unknown event type

RTE_ETH_EVENT_IPSEC_ESN_OVERFLOW

Sequence number overflow

RTE_ETH_EVENT_IPSEC_SA_TIME_EXPIRY

Soft time expiry of SA

RTE_ETH_EVENT_IPSEC_SA_BYTE_EXPIRY

Soft byte expiry of SA determined by rte_security_ipsec_lifetime::bytes_soft_limit

RTE_ETH_EVENT_IPSEC_SA_PKT_EXPIRY

Soft packet expiry of SA determined by rte_security_ipsec_lifetime::packets_soft_limit

RTE_ETH_EVENT_IPSEC_SA_BYTE_HARD_EXPIRY

Hard byte expiry of SA determined by rte_security_ipsec_lifetime::bytes_hard_limit

RTE_ETH_EVENT_IPSEC_SA_PKT_HARD_EXPIRY

Hard packet expiry of SA determined by rte_security_ipsec_lifetime::packets_hard_limit

RTE_ETH_EVENT_IPSEC_MAX

Max value of this enum

Definition at line 3952 of file rte_ethdev.h.

enum rte_eth_event_type¶

The eth device event type for interrupt, and maybe others in the future.

Enumerator

RTE_ETH_EVENT_UNKNOWN

unknown event type

RTE_ETH_EVENT_INTR_LSC

lsc interrupt event

RTE_ETH_EVENT_QUEUE_STATE

queue state event (enabled/disabled)

RTE_ETH_EVENT_INTR_RESET

reset interrupt event, sent to VF on PF reset

RTE_ETH_EVENT_VF_MBOX

message from the VF received by PF

RTE_ETH_EVENT_MACSEC

MACsec offload related event

RTE_ETH_EVENT_INTR_RMV

device removal event

RTE_ETH_EVENT_NEW

port is probed

RTE_ETH_EVENT_DESTROY

port is released

RTE_ETH_EVENT_IPSEC

IPsec offload related event

RTE_ETH_EVENT_FLOW_AGED

New aged-out flows is detected

RTE_ETH_EVENT_RX_AVAIL_THRESH

Number of available Rx descriptors is smaller than the threshold.

See also

RTE_ETH_EVENT_ERR_RECOVERING

Port recovering from a hardware or firmware error. If PMD supports proactive error recovery, it should trigger this event to notify application that it detected an error and the recovery is being started. Upon receiving the event, the application should not invoke any control path API (such as rte_eth_dev_configure/rte_eth_dev_stop...) until receiving RTE_ETH_EVENT_RECOVERY_SUCCESS or RTE_ETH_EVENT_RECOVERY_FAILED event. The PMD will set the data path pointers to dummy functions, and re-set the data path pointers to non-dummy functions before reporting RTE_ETH_EVENT_RECOVERY_SUCCESS event. It means that the application cannot send or receive any packets during this period.

Note

RTE_ETH_EVENT_RECOVERY_SUCCESS

Port recovers successfully from the error. The PMD already re-configured the port, and the effect is the same as a restart operation. a) The following operation will be retained: (alphabetically)

• DCB configuration
• FEC configuration
• Flow control configuration
• LRO configuration
• LSC configuration
• MTU
• MAC address (default and those supplied by MAC address array)
• Promiscuous and allmulticast mode
• PTP configuration
• Queue (Rx/Tx) settings
• Queue statistics mappings
• RSS configuration by rte_eth_dev_rss_xxx() family
• Rx checksum configuration
• Rx interrupt settings
• Traffic management configuration
• VLAN configuration (including filtering, tpid, strip, pvid)
• VMDq configuration b) The following configuration maybe retained or not depending on the device capabilities:
• flow rules (

See also

•

shared flow objects (

See also

RTE_ETH_EVENT_RECOVERY_FAILED

Port recovery failed. It means that the port should not be usable anymore. The application should close the port.

RTE_ETH_EVENT_MAX

max value of this enum

Definition at line 4017 of file rte_ethdev.h.

enum rte_eth_cman_obj¶

Enumerate list of ethdev congestion management objects

Enumerator

RTE_ETH_CMAN_OBJ_RX_QUEUE

Congestion management based on Rx queue depth

RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL

Congestion management based on mempool depth associated with Rx queue

See also

Definition at line 5768 of file rte_ethdev.h.

int rte_eth_iterator_init (struct rte_dev_iterator * iter, const char * devargs)¶

Initializes a device iterator.

This iterator allows accessing a list of devices matching some devargs.

Parameters

Returns

uint16_t rte_eth_iterator_next (struct rte_dev_iterator * iter)¶

Iterates on devices with devargs filter. The ownership is not checked.

The next port ID is returned, and the iterator is updated.

Parameters

Returns

void rte_eth_iterator_cleanup (struct rte_dev_iterator * iter)¶

Free some allocated fields of the iterator.

This function is automatically called by rte_eth_iterator_next() on the last iteration (i.e. when no more matching port is found).

It is safe to call this function twice; it will do nothing more.

Parameters

__extension__ struct rte_eth_link __rte_aligned (8)¶

aligned for atomic64 read/write

static uint64_t rte_eth_rss_hf_refine (uint64_t rss_hf) [inline], [static]¶

For input set change of hash filter, if SRC_ONLY and DST_ONLY of the same level are used simultaneously, it is the same case as none of them are added.

Parameters

Returns

Definition at line 660 of file rte_ethdev.h.

uint64_t rte_eth_find_next_owned_by (uint16_t port_id, const uint64_t owner_id)¶

Iterates over valid ethdev ports owned by a specific owner.

Parameters

Returns

uint16_t rte_eth_find_next (uint16_t port_id)¶

Iterates over valid ethdev ports.

Parameters

Returns

uint16_t rte_eth_find_next_of (uint16_t port_id_start, const struct rte_device * parent)¶

Iterates over ethdev ports of a specified device.

Parameters

Returns

uint16_t rte_eth_find_next_sibling (uint16_t port_id_start, uint16_t ref_port_id)¶

Iterates over sibling ethdev ports (i.e. sharing the same rte_device).

Parameters

Returns

int rte_eth_dev_owner_new (uint64_t * owner_id)¶

Get a new unique owner identifier. An owner identifier is used to owns Ethernet devices by only one DPDK entity to avoid multiple management of device by different entities.

Parameters

Returns

int rte_eth_dev_owner_set (const uint16_t port_id, const struct rte_eth_dev_owner * owner)¶

Set an Ethernet device owner.

Parameters

Returns

int rte_eth_dev_owner_unset (const uint16_t port_id, const uint64_t owner_id)¶

Unset Ethernet device owner to make the device ownerless.

Parameters

Returns

int rte_eth_dev_owner_delete (const uint64_t owner_id)¶

Remove owner from all Ethernet devices owned by a specific owner.

Parameters

Returns

int rte_eth_dev_owner_get (const uint16_t port_id, struct rte_eth_dev_owner * owner)¶

Get the owner of an Ethernet device.

Parameters

Returns

uint16_t rte_eth_dev_count_avail (void)¶

Get the number of ports which are usable for the application.

These devices must be iterated by using the macro RTE_ETH_FOREACH_DEV or RTE_ETH_FOREACH_DEV_OWNED_BY to deal with non-contiguous ranges of devices.

Returns

uint16_t rte_eth_dev_count_total (void)¶

Get the total number of ports which are allocated.

Some devices may not be available for the application.

Returns

uint32_t rte_eth_speed_bitflag (uint32_t speed, int duplex)¶

Convert a numerical speed in Mbps to a bitmap flag that can be used in the bitmap link_speeds of the struct rte_eth_conf

Parameters

Returns

const char* rte_eth_dev_rx_offload_name (uint64_t offload)¶

Get RTE_ETH_RX_OFFLOAD_* flag name.

Parameters

Returns

const char* rte_eth_dev_tx_offload_name (uint64_t offload)¶

Get RTE_ETH_TX_OFFLOAD_* flag name.

Parameters

Returns

__rte_experimental const char* rte_eth_dev_capability_name (uint64_t capability)¶

Warning

Get RTE_ETH_DEV_CAPA_* flag name.

Parameters

Returns

int rte_eth_dev_configure (uint16_t port_id, uint16_t nb_rx_queue, uint16_t nb_tx_queue, const struct rte_eth_conf * eth_conf)¶

Configure an Ethernet device. This function must be invoked first before any other function in the Ethernet API. This function can also be re-invoked when a device is in the stopped state.

Parameters

Embedding all configuration information in a single data structure is the more flexible method that allows the addition of new features without changing the syntax of the API.

Returns

int rte_eth_dev_is_removed (uint16_t port_id)¶

Check if an Ethernet device was physically removed.

Parameters

Returns

int rte_eth_rx_queue_setup (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc, unsigned int socket_id, const struct rte_eth_rxconf * rx_conf, struct rte_mempool * mb_pool)¶

Allocate and set up a receive queue for an Ethernet device.

The function allocates a contiguous block of memory for nb_rx_desc receive descriptors from a memory zone associated with socket_id and initializes each receive descriptor with a network buffer allocated from the memory pool mb_pool.

Parameters

Returns

__rte_experimental int rte_eth_rx_hairpin_queue_setup (uint16_t port_id, uint16_t rx_queue_id, uint16_t nb_rx_desc, const struct rte_eth_hairpin_conf * conf)¶

Warning

Allocate and set up a hairpin receive queue for an Ethernet device.

The function set up the selected queue to be used in hairpin.

Parameters

Returns

int rte_eth_tx_queue_setup (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc, unsigned int socket_id, const struct rte_eth_txconf * tx_conf)¶

Allocate and set up a transmit queue for an Ethernet device.

Parameters

Returns

__rte_experimental int rte_eth_tx_hairpin_queue_setup (uint16_t port_id, uint16_t tx_queue_id, uint16_t nb_tx_desc, const struct rte_eth_hairpin_conf * conf)¶

Warning

Allocate and set up a transmit hairpin queue for an Ethernet device.

Parameters

Returns

__rte_experimental int rte_eth_hairpin_get_peer_ports (uint16_t port_id, uint16_t * peer_ports, size_t len, uint32_t direction)¶

Warning

Get all the hairpin peer Rx / Tx ports of the current port. The caller should ensure that the array is large enough to save the ports list.

Parameters

Returns

__rte_experimental int rte_eth_hairpin_bind (uint16_t tx_port, uint16_t rx_port)¶

Warning

Bind all hairpin Tx queues of one port to the Rx queues of the peer port. It is only allowed to call this function after all hairpin queues are configured properly and the devices are in started state.

Parameters

Returns

__rte_experimental int rte_eth_hairpin_unbind (uint16_t tx_port, uint16_t rx_port)¶

Warning

Unbind all hairpin Tx queues of one port from the Rx queues of the peer port. This should be called before closing the Tx or Rx devices, if the bind function is called before. After unbinding the hairpin ports pair, it is allowed to bind them again. Changing queues configuration should be after stopping the device(s).

Parameters

Returns

__rte_experimental int rte_eth_dev_count_aggr_ports (uint16_t port_id)¶

Warning

Get the number of aggregated ports of the DPDK port (specified with port_id). It is used when multiple ports are aggregated into a single one.

For the regular physical port doesn't have aggregated ports, the number of aggregated ports is reported as 0.

Parameters

Returns

__rte_experimental int rte_eth_dev_map_aggr_tx_affinity (uint16_t port_id, uint16_t tx_queue_id, uint8_t affinity)¶

Warning

Map a Tx queue with an aggregated port of the DPDK port (specified with port_id). When multiple ports are aggregated into a single one, it allows to choose which port to use for Tx via a queue.

The application should use rte_eth_dev_map_aggr_tx_affinity() after rte_eth_dev_configure(), rte_eth_tx_queue_setup(), and before rte_eth_dev_start().

Parameters

Returns

int rte_eth_dev_socket_id (uint16_t port_id)¶

Return the NUMA socket to which an Ethernet device is connected

Parameters

Returns

int rte_eth_dev_is_valid_port (uint16_t port_id)¶

Check if port_id of device is attached

Parameters

Returns

__rte_experimental int rte_eth_rx_queue_is_valid (uint16_t port_id, uint16_t queue_id)¶

Warning

Check if Rx queue is valid. If the queue has been setup, it is considered valid.

Parameters

Returns

__rte_experimental int rte_eth_tx_queue_is_valid (uint16_t port_id, uint16_t queue_id)¶

Warning

Check if Tx queue is valid. If the queue has been setup, it is considered valid.

Parameters

Returns

int rte_eth_dev_rx_queue_start (uint16_t port_id, uint16_t rx_queue_id)¶

Start specified Rx queue of a port. It is used when rx_deferred_start flag of the specified queue is true.

Parameters

Returns

int rte_eth_dev_rx_queue_stop (uint16_t port_id, uint16_t rx_queue_id)¶

Stop specified Rx queue of a port

Parameters

Returns

int rte_eth_dev_tx_queue_start (uint16_t port_id, uint16_t tx_queue_id)¶

Start Tx for specified queue of a port. It is used when tx_deferred_start flag of the specified queue is true.

Parameters

Returns

int rte_eth_dev_tx_queue_stop (uint16_t port_id, uint16_t tx_queue_id)¶

Stop specified Tx queue of a port

Parameters

Returns

int rte_eth_dev_start (uint16_t port_id)¶

Start an Ethernet device.

The device start step is the last one and consists of setting the configured offload features and in starting the transmit and the receive units of the device.

Device RTE_ETH_DEV_NOLIVE_MAC_ADDR flag causes MAC address to be set before PMD port start callback function is invoked.

All device queues (except form deferred start queues) status should be RTE_ETH_QUEUE_STATE_STARTED after start.

On success, all basic functions exported by the Ethernet API (link status, receive/transmit, and so on) can be invoked.

Parameters

Returns

int rte_eth_dev_stop (uint16_t port_id)¶

Stop an Ethernet device. The device can be restarted with a call to rte_eth_dev_start()

All device queues status should be RTE_ETH_QUEUE_STATE_STOPPED after stop.

Parameters

Returns

int rte_eth_dev_set_link_up (uint16_t port_id)¶

Link up an Ethernet device.

Set device link up will re-enable the device Rx/Tx functionality after it is previously set device linked down.

Parameters

Returns

int rte_eth_dev_set_link_down (uint16_t port_id)¶

Link down an Ethernet device. The device Rx/Tx functionality will be disabled if success, and it can be re-enabled with a call to rte_eth_dev_set_link_up()

Parameters

int rte_eth_dev_close (uint16_t port_id)¶

Close a stopped Ethernet device. The device cannot be restarted! The function frees all port resources.

Parameters

Returns

int rte_eth_dev_reset (uint16_t port_id)¶

Reset a Ethernet device and keep its port ID.

When a port has to be reset passively, the DPDK application can invoke this function. For example when a PF is reset, all its VFs should also be reset. Normally a DPDK application can invoke this function when RTE_ETH_EVENT_INTR_RESET event is detected, but can also use it to start a port reset in other circumstances.

When this function is called, it first stops the port and then calls the PMD specific dev_uninit( ) and dev_init( ) to return the port to initial state, in which no Tx and Rx queues are setup, as if the port has been reset and not started. The port keeps the port ID it had before the function call.

After calling rte_eth_dev_reset( ), the application should use rte_eth_dev_configure( ), rte_eth_rx_queue_setup( ), rte_eth_tx_queue_setup( ), and rte_eth_dev_start( ) to reconfigure the device as appropriate.

Note: To avoid unexpected behavior, the application should stop calling Tx and Rx functions before calling rte_eth_dev_reset( ). For thread safety, all these controlling functions should be called from the same thread.

Parameters

Returns

int rte_eth_promiscuous_enable (uint16_t port_id)¶

Enable receipt in promiscuous mode for an Ethernet device.

Parameters

Returns

int rte_eth_promiscuous_disable (uint16_t port_id)¶

Disable receipt in promiscuous mode for an Ethernet device.

Parameters

Returns

int rte_eth_promiscuous_get (uint16_t port_id)¶

Return the value of promiscuous mode for an Ethernet device.

Parameters

Returns

int rte_eth_allmulticast_enable (uint16_t port_id)¶

Enable the receipt of any multicast frame by an Ethernet device.

Parameters

Returns

int rte_eth_allmulticast_disable (uint16_t port_id)¶

Disable the receipt of all multicast frames by an Ethernet device.

Parameters

Returns

int rte_eth_allmulticast_get (uint16_t port_id)¶

Return the value of allmulticast mode for an Ethernet device.

Parameters

Returns

int rte_eth_link_get (uint16_t port_id, struct rte_eth_link * link)¶

Retrieve the link status (up/down), the duplex mode (half/full), the negotiation (auto/fixed), and if available, the speed (Mbps).

It might need to wait up to 9 seconds.

See also

Parameters

Returns

int rte_eth_link_get_nowait (uint16_t port_id, struct rte_eth_link * link)¶

Retrieve the link status (up/down), the duplex mode (half/full), the negotiation (auto/fixed), and if available, the speed (Mbps).

Parameters

Returns

__rte_experimental const char* rte_eth_link_speed_to_str (uint32_t link_speed)¶

Warning

The function converts a link_speed to a string. It handles all special values like unknown or none speed.

Parameters

Returns

__rte_experimental int rte_eth_link_to_str (char * str, size_t len, const struct rte_eth_link * eth_link)¶

Warning

The function converts a rte_eth_link struct representing a link status to a string.

Parameters

Returns

int rte_eth_stats_get (uint16_t port_id, struct rte_eth_stats * stats)¶

Retrieve the general I/O statistics of an Ethernet device.

Parameters

Returns

int rte_eth_stats_reset (uint16_t port_id)¶

Reset the general I/O statistics of an Ethernet device.

Parameters

Returns

int rte_eth_xstats_get_names (uint16_t port_id, struct rte_eth_xstat_name * xstats_names, unsigned int size)¶

Retrieve names of extended statistics of an Ethernet device.

There is an assumption that 'xstat_names' and 'xstats' arrays are matched by array index: xstats_names[i].name => xstats[i].value

And the array index is same with id field of 'struct rte_eth_xstat': xstats[i].id == i

This assumption makes key-value pair matching less flexible but simpler.

Parameters

Returns

int rte_eth_xstats_get (uint16_t port_id, struct rte_eth_xstat * xstats, unsigned int n)¶

Retrieve extended statistics of an Ethernet device.

There is an assumption that 'xstat_names' and 'xstats' arrays are matched by array index: xstats_names[i].name => xstats[i].value

And the array index is same with id field of 'struct rte_eth_xstat': xstats[i].id == i

This assumption makes key-value pair matching less flexible but simpler.

Parameters

Returns

int rte_eth_xstats_get_names_by_id (uint16_t port_id, struct rte_eth_xstat_name * xstats_names, unsigned int size, uint64_t * ids)¶

Retrieve names of extended statistics of an Ethernet device.

Parameters

Returns

int rte_eth_xstats_get_by_id (uint16_t port_id, const uint64_t * ids, uint64_t * values, unsigned int size)¶

Retrieve extended statistics of an Ethernet device.

Parameters

Returns

int rte_eth_xstats_get_id_by_name (uint16_t port_id, const char * xstat_name, uint64_t * id)¶

Gets the ID of a statistic from its name.

This function searches for the statistics using string compares, and as such should not be used on the fast-path. For fast-path retrieval of specific statistics, store the ID as provided in id from this function, and pass the ID to rte_eth_xstats_get()

Parameters

Returns

int rte_eth_xstats_reset (uint16_t port_id)¶

Reset extended statistics of an Ethernet device.

Parameters

Returns

int rte_eth_dev_set_tx_queue_stats_mapping (uint16_t port_id, uint16_t tx_queue_id, uint8_t stat_idx)¶

Set a mapping for the specified transmit queue to the specified per-queue statistics counter.

Parameters

Returns

int rte_eth_dev_set_rx_queue_stats_mapping (uint16_t port_id, uint16_t rx_queue_id, uint8_t stat_idx)¶

Set a mapping for the specified receive queue to the specified per-queue statistics counter.

Parameters

Returns

int rte_eth_macaddr_get (uint16_t port_id, struct rte_ether_addr * mac_addr)¶

Retrieve the Ethernet address of an Ethernet device.

Parameters

Returns

__rte_experimental int rte_eth_macaddrs_get (uint16_t port_id, struct rte_ether_addr * ma, unsigned int num)¶

Warning

Retrieve the Ethernet addresses of an Ethernet device.

Parameters

Returns

int rte_eth_dev_info_get (uint16_t port_id, struct rte_eth_dev_info * dev_info)¶

Retrieve the contextual information of an Ethernet device.

This function returns the Ethernet device information based on the values stored internally in the device specific data. For example: number of queues, descriptor limits, device capabilities and offload flags.

Parameters

Returns

__rte_experimental int rte_eth_dev_conf_get (uint16_t port_id, struct rte_eth_conf * dev_conf)¶

Warning

Retrieve the configuration of an Ethernet device.

Parameters

Returns

int rte_eth_dev_fw_version_get (uint16_t port_id, char * fw_version, size_t fw_size)¶

Retrieve the firmware version of a device.

Parameters

Returns

int rte_eth_dev_get_supported_ptypes (uint16_t port_id, uint32_t ptype_mask, uint32_t * ptypes, int num)¶

Retrieve the supported packet types of an Ethernet device.

When a packet type is announced as supported, it must be recognized by the PMD. For instance, if RTE_PTYPE_L2_ETHER, RTE_PTYPE_L2_ETHER_VLAN and RTE_PTYPE_L3_IPV4 are announced, the PMD must return the following packet types for these packets:

• Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
• Ether/VLAN/IPv4 -> RTE_PTYPE_L2_ETHER_VLAN | RTE_PTYPE_L3_IPV4
• Ether/[anything else] -> RTE_PTYPE_L2_ETHER
• Ether/VLAN/[anything else] -> RTE_PTYPE_L2_ETHER_VLAN

When a packet is received by a PMD, the most precise type must be returned among the ones supported. However a PMD is allowed to set packet type that is not in the supported list, at the condition that it is more precise. Therefore, a PMD announcing no supported packet types can still set a matching packet type in a received packet.

Note

Parameters

Returns

int rte_eth_dev_set_ptypes (uint16_t port_id, uint32_t ptype_mask, uint32_t * set_ptypes, unsigned int num)¶

Inform Ethernet device about reduced range of packet types to handle.

Application can use this function to set only specific ptypes that it's interested. This information can be used by the PMD to optimize Rx path.

The function accepts an array set_ptypes allocated by the caller to store the packet types set by the driver, the last element of the array is set to RTE_PTYPE_UNKNOWN. The size of the set_ptype array should be rte_eth_dev_get_supported_ptypes() + 1 else it might only be filled partially.

Parameters

Returns

int rte_eth_dev_get_mtu (uint16_t port_id, uint16_t * mtu)¶

Retrieve the MTU of an Ethernet device.

Parameters

Returns

int rte_eth_dev_set_mtu (uint16_t port_id, uint16_t mtu)¶

Change the MTU of an Ethernet device.

Parameters

Returns

int rte_eth_dev_vlan_filter (uint16_t port_id, uint16_t vlan_id, int on)¶

Enable/Disable hardware filtering by an Ethernet device of received VLAN packets tagged with a given VLAN Tag Identifier.

Parameters

Returns

int rte_eth_dev_set_vlan_strip_on_queue (uint16_t port_id, uint16_t rx_queue_id, int on)¶

Enable/Disable hardware VLAN Strip by a Rx queue of an Ethernet device.

Parameters

Returns

int rte_eth_dev_set_vlan_ether_type (uint16_t port_id, enum rte_vlan_type vlan_type, uint16_t tag_type)¶

Set the Outer VLAN Ether Type by an Ethernet device, it can be inserted to the VLAN header.

Parameters

Returns

int rte_eth_dev_set_vlan_offload (uint16_t port_id, int offload_mask)¶

Set VLAN offload configuration on an Ethernet device.

Parameters

Returns

int rte_eth_dev_get_vlan_offload (uint16_t port_id)¶

Read VLAN Offload configuration from an Ethernet device

Parameters

Returns

int rte_eth_dev_set_vlan_pvid (uint16_t port_id, uint16_t pvid, int on)¶

Set port based Tx VLAN insertion on or off.

Parameters

Returns

__rte_experimental int rte_eth_rx_avail_thresh_set (uint16_t port_id, uint16_t queue_id, uint8_t avail_thresh)¶

Warning

Set Rx queue available descriptors threshold.

Parameters

Returns

__rte_experimental int rte_eth_rx_avail_thresh_query (uint16_t port_id, uint16_t * queue_id, uint8_t * avail_thresh)¶

Warning

Find Rx queue with RTE_ETH_EVENT_RX_AVAIL_THRESH event pending.

Parameters

Returns

int rte_eth_tx_buffer_init (struct rte_eth_dev_tx_buffer * buffer, uint16_t size)¶

Initialize default values for buffered transmitting

Parameters

Returns

int rte_eth_tx_buffer_set_err_callback (struct rte_eth_dev_tx_buffer * buffer, buffer_tx_error_fn callback, void * userdata)¶

Configure a callback for buffered packets which cannot be sent

Register a specific callback to be called when an attempt is made to send all packets buffered on an Ethernet port, but not all packets can successfully be sent. The callback registered here will be called only from calls to rte_eth_tx_buffer() and rte_eth_tx_buffer_flush() APIs. The default callback configured for each queue by default just frees the packets back to the calling mempool. If additional behaviour is required, for example, to count dropped packets, or to retry transmission of packets which cannot be sent, this function should be used to register a suitable callback function to implement the desired behaviour. The example callback 'rte_eth_tx_buffer_count_callback()' is also provided as reference.

Parameters

Returns

void rte_eth_tx_buffer_drop_callback (struct rte_mbuf ** pkts, uint16_t unsent, void * userdata)¶

Callback function for silently dropping unsent buffered packets.

This function can be passed to rte_eth_tx_buffer_set_err_callback() to adjust the default behavior when buffered packets cannot be sent. This function drops any unsent packets silently and is used by Tx buffered operations as default behavior.

NOTE: this function should not be called directly, instead it should be used as a callback for packet buffering.

NOTE: when configuring this function as a callback with rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter should point to an uint64_t value.

Parameters

void rte_eth_tx_buffer_count_callback (struct rte_mbuf ** pkts, uint16_t unsent, void * userdata)¶

Callback function for tracking unsent buffered packets.

This function can be passed to rte_eth_tx_buffer_set_err_callback() to adjust the default behavior when buffered packets cannot be sent. This function drops any unsent packets, but also updates a user-supplied counter to track the overall number of packets dropped. The counter should be an uint64_t variable.

NOTE: this function should not be called directly, instead it should be used as a callback for packet buffering.

NOTE: when configuring this function as a callback with rte_eth_tx_buffer_set_err_callback(), the final, userdata parameter should point to an uint64_t value.

Parameters

int rte_eth_tx_done_cleanup (uint16_t port_id, uint16_t queue_id, uint32_t free_cnt)¶

Request the driver to free mbufs currently cached by the driver. The driver will only free the mbuf if it is no longer in use. It is the application's responsibility to ensure rte_eth_tx_buffer_flush(..) is called if needed.

Parameters

Returns

int rte_eth_dev_callback_register (uint16_t port_id, enum rte_eth_event_type event, rte_eth_dev_cb_fn cb_fn, void * cb_arg)¶

Register a callback function for port event.

Parameters

Returns

int rte_eth_dev_callback_unregister (uint16_t port_id, enum rte_eth_event_type event, rte_eth_dev_cb_fn cb_fn, void * cb_arg)¶

Unregister a callback function for port event.

Parameters

Returns

int rte_eth_dev_rx_intr_enable (uint16_t port_id, uint16_t queue_id)¶

When there is no Rx packet coming in Rx Queue for a long time, we can sleep lcore related to Rx Queue for power saving, and enable Rx interrupt to be triggered when Rx packet arrives.

The rte_eth_dev_rx_intr_enable() function enables Rx queue interrupt on specific Rx queue of a port.

Parameters

Returns

int rte_eth_dev_rx_intr_disable (uint16_t port_id, uint16_t queue_id)¶

When lcore wakes up from Rx interrupt indicating packet coming, disable Rx interrupt and returns to polling mode.

The rte_eth_dev_rx_intr_disable() function disables Rx queue interrupt on specific Rx queue of a port.

Parameters

Returns

int rte_eth_dev_rx_intr_ctl (uint16_t port_id, int epfd, int op, void * data)¶

Rx Interrupt control per port.

Parameters

Returns

int rte_eth_dev_rx_intr_ctl_q (uint16_t port_id, uint16_t queue_id, int epfd, int op, void * data)¶

Rx Interrupt control per queue.

Parameters

Returns

int rte_eth_dev_rx_intr_ctl_q_get_fd (uint16_t port_id, uint16_t queue_id)¶

Get interrupt fd per Rx queue.

Parameters

Returns

int rte_eth_led_on (uint16_t port_id)¶

Turn on the LED on the Ethernet device. This function turns on the LED on the Ethernet device.

Parameters

Returns

int rte_eth_led_off (uint16_t port_id)¶

Turn off the LED on the Ethernet device. This function turns off the LED on the Ethernet device.

Parameters

Returns

__rte_experimental int rte_eth_fec_get_capability (uint16_t port_id, struct rte_eth_fec_capa * speed_fec_capa, unsigned int num)¶

Warning

Get Forward Error Correction(FEC) capability.

Parameters

Returns

__rte_experimental int rte_eth_fec_get (uint16_t port_id, uint32_t * fec_capa)¶

Warning

Get current Forward Error Correction(FEC) mode. If link is down and AUTO is enabled, AUTO is returned, otherwise, configured FEC mode is returned. If link is up, current FEC mode is returned.

Parameters

Returns

__rte_experimental int rte_eth_fec_set (uint16_t port_id, uint32_t fec_capa)¶

Warning

Set Forward Error Correction(FEC) mode.

Parameters

Returns

int rte_eth_dev_flow_ctrl_get (uint16_t port_id, struct rte_eth_fc_conf * fc_conf)¶

Get current status of the Ethernet link flow control for Ethernet device

Parameters

Returns

int rte_eth_dev_flow_ctrl_set (uint16_t port_id, struct rte_eth_fc_conf * fc_conf)¶

Configure the Ethernet link flow control for Ethernet device

Parameters

Returns

int rte_eth_dev_priority_flow_ctrl_set (uint16_t port_id, struct rte_eth_pfc_conf * pfc_conf)¶

Configure the Ethernet priority flow control under DCB environment for Ethernet device.

Parameters

Returns

int rte_eth_dev_mac_addr_add (uint16_t port_id, struct rte_ether_addr * mac_addr, uint32_t pool)¶

Add a MAC address to the set used for filtering incoming packets.

Parameters

Returns

__rte_experimental int rte_eth_dev_priority_flow_ctrl_queue_info_get (uint16_t port_id, struct rte_eth_pfc_queue_info * pfc_queue_info)¶

Warning

Retrieve the information for queue based PFC.

Parameters

Returns

__rte_experimental int rte_eth_dev_priority_flow_ctrl_queue_configure (uint16_t port_id, struct rte_eth_pfc_queue_conf * pfc_queue_conf)¶

Warning

Configure the queue based priority flow control for a given queue for Ethernet device.

Note

Parameters

Returns

int rte_eth_dev_mac_addr_remove (uint16_t port_id, struct rte_ether_addr * mac_addr)¶

Remove a MAC address from the internal array of addresses.

Parameters

Returns

int rte_eth_dev_default_mac_addr_set (uint16_t port_id, struct rte_ether_addr * mac_addr)¶

Set the default MAC address. It replaces the address at index 0 of the MAC address list. If the address was already in the MAC address list, please remove it first.

Parameters

Returns

int rte_eth_dev_rss_reta_update (uint16_t port_id, struct rte_eth_rss_reta_entry64 * reta_conf, uint16_t reta_size)¶

Update Redirection Table(RETA) of Receive Side Scaling of Ethernet device.

Parameters

Returns

int rte_eth_dev_rss_reta_query (uint16_t port_id, struct rte_eth_rss_reta_entry64 * reta_conf, uint16_t reta_size)¶

Query Redirection Table(RETA) of Receive Side Scaling of Ethernet device.

Parameters

Returns

int rte_eth_dev_uc_hash_table_set (uint16_t port_id, struct rte_ether_addr * addr, uint8_t on)¶

Updates unicast hash table for receiving packet with the given destination MAC address, and the packet is routed to all VFs for which the Rx mode is accept packets that match the unicast hash table.

Parameters

Returns

int rte_eth_dev_uc_all_hash_table_set (uint16_t port_id, uint8_t on)¶

Updates all unicast hash bitmaps for receiving packet with any Unicast Ethernet MAC addresses,the packet is routed to all VFs for which the Rx mode is accept packets that match the unicast hash table.

Parameters

Returns

int rte_eth_set_queue_rate_limit (uint16_t port_id, uint16_t queue_idx, uint32_t tx_rate)¶

Set the rate limitation for a queue on an Ethernet device.

Parameters

Returns

int rte_eth_dev_rss_hash_update (uint16_t port_id, struct rte_eth_rss_conf * rss_conf)¶

Configuration of Receive Side Scaling hash computation of Ethernet device.

Parameters

Returns

int rte_eth_dev_rss_hash_conf_get (uint16_t port_id, struct rte_eth_rss_conf * rss_conf)¶

Retrieve current configuration of Receive Side Scaling hash computation of Ethernet device.

Parameters

Returns

__rte_experimental const char* rte_eth_dev_rss_algo_name (enum rte_eth_hash_function rss_algo)¶

Warning

Get the name of RSS hash algorithm.

Parameters

Returns

int rte_eth_dev_udp_tunnel_port_add (uint16_t port_id, struct rte_eth_udp_tunnel * tunnel_udp)¶

Add UDP tunneling port for a type of tunnel.

Some NICs may require such configuration to properly parse a tunnel with any standard or custom UDP port. The packets with this UDP port will be parsed for this type of tunnel. The device parser will also check the rest of the tunnel headers before classifying the packet.

With some devices, this API will affect packet classification, i.e.:

• mbuf.packet_type reported on Rx
• rte_flow rules with tunnel items

Parameters

Returns

int rte_eth_dev_udp_tunnel_port_delete (uint16_t port_id, struct rte_eth_udp_tunnel * tunnel_udp)¶

Delete UDP tunneling port for a type of tunnel.

The packets with this UDP port will not be classified as this type of tunnel anymore if the device use such mapping for tunnel packet classification.

See also

Parameters

Returns

int rte_eth_dev_get_dcb_info (uint16_t port_id, struct rte_eth_dcb_info * dcb_info)¶

Get DCB information on an Ethernet device.

Parameters

Returns

const struct rte_eth_rxtx_callback* rte_eth_add_rx_callback (uint16_t port_id, uint16_t queue_id, rte_rx_callback_fn fn, void * user_param)¶

Add a callback to be called on packet Rx on a given port and queue.

This API configures a function to be called for each burst of packets received on a given NIC port queue. The return value is a pointer that can be used to later remove the callback using rte_eth_remove_rx_callback().

Multiple functions are called in the order that they are added.

Parameters

Returns

const struct rte_eth_rxtx_callback* rte_eth_add_first_rx_callback (uint16_t port_id, uint16_t queue_id, rte_rx_callback_fn fn, void * user_param)¶

Add a callback that must be called first on packet Rx on a given port and queue.

This API configures a first function to be called for each burst of packets received on a given NIC port queue. The return value is a pointer that can be used to later remove the callback using rte_eth_remove_rx_callback().

Multiple functions are called in the order that they are added.

Parameters

Returns

const struct rte_eth_rxtx_callback* rte_eth_add_tx_callback (uint16_t port_id, uint16_t queue_id, rte_tx_callback_fn fn, void * user_param)¶

Add a callback to be called on packet Tx on a given port and queue.

This API configures a function to be called for each burst of packets sent on a given NIC port queue. The return value is a pointer that can be used to later remove the callback using rte_eth_remove_tx_callback().

Multiple functions are called in the order that they are added.

Parameters

Returns

int rte_eth_remove_rx_callback (uint16_t port_id, uint16_t queue_id, const struct rte_eth_rxtx_callback * user_cb)¶

Remove an Rx packet callback from a given port and queue.

This function is used to removed callbacks that were added to a NIC port queue using rte_eth_add_rx_callback().

Note: the callback is removed from the callback list but it isn't freed since the it may still be in use. The memory for the callback can be subsequently freed back by the application by calling rte_free():

• Immediately - if the port is stopped, or the user knows that no callbacks are in flight e.g. if called from the thread doing Rx/Tx on that queue.
• After a short delay - where the delay is sufficient to allow any in-flight callbacks to complete. Alternately, the RCU mechanism can be used to detect when data plane threads have ceased referencing the callback memory.

Parameters

Returns

int rte_eth_remove_tx_callback (uint16_t port_id, uint16_t queue_id, const struct rte_eth_rxtx_callback * user_cb)¶

Remove a Tx packet callback from a given port and queue.

This function is used to removed callbacks that were added to a NIC port queue using rte_eth_add_tx_callback().

Note: the callback is removed from the callback list but it isn't freed since the it may still be in use. The memory for the callback can be subsequently freed back by the application by calling rte_free():

• Immediately - if the port is stopped, or the user knows that no callbacks are in flight e.g. if called from the thread doing Rx/Tx on that queue.
• After a short delay - where the delay is sufficient to allow any in-flight callbacks to complete. Alternately, the RCU mechanism can be used to detect when data plane threads have ceased referencing the callback memory.

Parameters

Returns

int rte_eth_rx_queue_info_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_rxq_info * qinfo)¶

Retrieve information about given port's Rx queue.

Parameters

Returns

int rte_eth_tx_queue_info_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_txq_info * qinfo)¶

Retrieve information about given port's Tx queue.

Parameters

Returns

__rte_experimental int rte_eth_recycle_rx_queue_info_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_recycle_rxq_info * recycle_rxq_info)¶

Warning

Retrieve information about given ports's Rx queue for recycling mbufs.

Parameters

Returns

int rte_eth_rx_burst_mode_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_burst_mode * mode)¶

Retrieve information about the Rx packet burst mode.

Parameters

Returns

int rte_eth_tx_burst_mode_get (uint16_t port_id, uint16_t queue_id, struct rte_eth_burst_mode * mode)¶

Retrieve information about the Tx packet burst mode.

Parameters

Returns

__rte_experimental int rte_eth_get_monitor_addr (uint16_t port_id, uint16_t queue_id, struct rte_power_monitor_cond * pmc)¶

Warning

Retrieve the monitor condition for a given receive queue.

Parameters

Returns

int rte_eth_dev_get_reg_info (uint16_t port_id, struct rte_dev_reg_info * info)¶

Retrieve device registers and register attributes (number of registers and register size)

Parameters

Returns

int rte_eth_dev_get_eeprom_length (uint16_t port_id)¶

Retrieve size of device EEPROM

Parameters

Returns

int rte_eth_dev_get_eeprom (uint16_t port_id, struct rte_dev_eeprom_info * info)¶

Retrieve EEPROM and EEPROM attribute

Parameters

Returns

int rte_eth_dev_set_eeprom (uint16_t port_id, struct rte_dev_eeprom_info * info)¶

Program EEPROM with provided data

Parameters

Returns

__rte_experimental int rte_eth_dev_get_module_info (uint16_t port_id, struct rte_eth_dev_module_info * modinfo)¶

Warning

Retrieve the type and size of plugin module EEPROM

Parameters

Returns

__rte_experimental int rte_eth_dev_get_module_eeprom (uint16_t port_id, struct rte_dev_eeprom_info * info)¶

Warning

Retrieve the data of plugin module EEPROM

Parameters

Returns

int rte_eth_dev_set_mc_addr_list (uint16_t port_id, struct rte_ether_addr * mc_addr_set, uint32_t nb_mc_addr)¶

Set the list of multicast addresses to filter on an Ethernet device.

Parameters

Returns

int rte_eth_timesync_enable (uint16_t port_id)¶

Enable IEEE1588/802.1AS timestamping for an Ethernet device.

Parameters

Returns

int rte_eth_timesync_disable (uint16_t port_id)¶

Disable IEEE1588/802.1AS timestamping for an Ethernet device.

Parameters

Returns

int rte_eth_timesync_read_rx_timestamp (uint16_t port_id, struct timespec * timestamp, uint32_t flags)¶

Read an IEEE1588/802.1AS Rx timestamp from an Ethernet device.

Parameters

Returns

int rte_eth_timesync_read_tx_timestamp (uint16_t port_id, struct timespec * timestamp)¶

Read an IEEE1588/802.1AS Tx timestamp from an Ethernet device.

Parameters

Returns

int rte_eth_timesync_adjust_time (uint16_t port_id, int64_t delta)¶

Adjust the timesync clock on an Ethernet device.

This is usually used in conjunction with other Ethdev timesync functions to synchronize the device time using the IEEE1588/802.1AS protocol.

Parameters

Returns

int rte_eth_timesync_read_time (uint16_t port_id, struct timespec * time)¶

Read the time from the timesync clock on an Ethernet device.

This is usually used in conjunction with other Ethdev timesync functions to synchronize the device time using the IEEE1588/802.1AS protocol.

Parameters

Returns

int rte_eth_timesync_write_time (uint16_t port_id, const struct timespec * time)¶

Set the time of the timesync clock on an Ethernet device.

This is usually used in conjunction with other Ethdev timesync functions to synchronize the device time using the IEEE1588/802.1AS protocol.

Parameters

Returns

__rte_experimental int rte_eth_read_clock (uint16_t port_id, uint64_t * clock)¶

Warning

Read the current clock counter of an Ethernet device

This returns the current raw clock value of an Ethernet device. It is a raw amount of ticks, with no given time reference. The value returned here is from the same clock than the one filling timestamp field of Rx packets when using hardware timestamp offload. Therefore it can be used to compute a precise conversion of the device clock to the real time.

E.g, a simple heuristic to derivate the frequency would be: uint64_t start, end; rte_eth_read_clock(port, start); rte_delay_ms(100); rte_eth_read_clock(port, end); double freq = (end - start) * 10;

Compute a common reference with: uint64_t base_time_sec = current_time(); uint64_t base_clock; rte_eth_read_clock(port, base_clock);

Then, convert the raw mbuf timestamp with: base_time_sec + (double)(*timestamp_dynfield(mbuf) - base_clock) / freq;

This simple example will not provide a very good accuracy. One must at least measure multiple times the frequency and do a regression. To avoid deviation from the system time, the common reference can be repeated from time to time. The integer division can also be converted by a multiplication and a shift for better performance.

Parameters

Returns

int rte_eth_dev_get_port_by_name (const char * name, uint16_t * port_id)¶

Get the port ID from device name. The device name should be specified as below:

• PCIe address (Domain:Bus:Device.Function), for example- 0000:2:00.0
• SoC device name, for example- fsl-gmac0
• vdev dpdk name, for example- net_[pcap0|null0|tap0]

Parameters

Returns

int rte_eth_dev_get_name_by_port (uint16_t port_id, char * name)¶

Get the device name from port ID. The device name is specified as below:

• PCIe address (Domain:Bus:Device.Function), for example- 0000:02:00.0
• SoC device name, for example- fsl-gmac0
• vdev dpdk name, for example- net_[pcap0|null0|tun0|tap0]

Parameters

Returns

int rte_eth_dev_adjust_nb_rx_tx_desc (uint16_t port_id, uint16_t * nb_rx_desc, uint16_t * nb_tx_desc)¶

Check that numbers of Rx and Tx descriptors satisfy descriptors limits from the Ethernet device information, otherwise adjust them to boundaries.

Parameters

Returns

int rte_eth_dev_pool_ops_supported (uint16_t port_id, const char * pool)¶

Test if a port supports specific mempool ops.

Parameters

Returns

void* rte_eth_dev_get_sec_ctx (uint16_t port_id)¶

Get the security context for the Ethernet device.

Parameters

Returns

__rte_experimental int rte_eth_dev_hairpin_capability_get (uint16_t port_id, struct rte_eth_hairpin_cap * cap)¶

Warning

Query the device hairpin capabilities.

Parameters

Returns

__rte_experimental int rte_eth_representor_info_get (uint16_t port_id, struct rte_eth_representor_info * info)¶

Retrieve the representor info of the device.

Get device representor info to be able to calculate a unique representor ID.

See also

Parameters

Returns

int rte_eth_rx_metadata_negotiate (uint16_t port_id, uint64_t * features)¶

Negotiate the NIC's ability to deliver specific kinds of metadata to the PMD.

Invoke this API before the first rte_eth_dev_configure() invocation to let the PMD make preparations that are inconvenient to do later.

The negotiation process is as follows:

• the application requests features intending to use at least some of them;
• the PMD responds with the guaranteed subset of the requested feature set;
• the application can retry negotiation with another set of features;
• the application can pass zero to clear the negotiation result;
• the last negotiated result takes effect upon the ethdev configure and start.

Note

Parameters

Returns

__rte_experimental int rte_eth_ip_reassembly_capability_get (uint16_t port_id, struct rte_eth_ip_reassembly_params * capa)¶

Warning

Get IP reassembly capabilities supported by the PMD. This is the first API to be called for enabling the IP reassembly offload feature. PMD will return the maximum values of parameters that PMD can support and user can call rte_eth_ip_reassembly_conf_set() with param values lower than capability.

Parameters

Returns

__rte_experimental int rte_eth_ip_reassembly_conf_get (uint16_t port_id, struct rte_eth_ip_reassembly_params * conf)¶

Warning

Get IP reassembly configuration parameters currently set in PMD. The API will return error if the configuration is not already set using rte_eth_ip_reassembly_conf_set() before calling this API or if the device is not configured.

Parameters

Returns

__rte_experimental int rte_eth_ip_reassembly_conf_set (uint16_t port_id, const struct rte_eth_ip_reassembly_params * conf)¶

Warning

Set IP reassembly configuration parameters if the PMD supports IP reassembly offload. User should first call rte_eth_ip_reassembly_capability_get() to check the maximum values supported by the PMD before setting the configuration. The use of this API is mandatory to enable this feature and should be called before rte_eth_dev_start().

In datapath, PMD cannot guarantee that IP reassembly is always successful. Hence, PMD shall register mbuf dynamic field and dynamic flag using rte_eth_ip_reassembly_dynfield_register() to denote incomplete IP reassembly. If dynfield is not successfully registered, error will be returned and IP reassembly offload cannot be used.

Parameters

Returns

__rte_experimental int rte_eth_dev_priv_dump (uint16_t port_id, FILE * file)¶

Warning

Dump private info from device to a file. Provided data and the order depends on the PMD.

Parameters

Returns

__rte_experimental int rte_eth_rx_descriptor_dump (uint16_t port_id, uint16_t queue_id, uint16_t offset, uint16_t num, FILE * file)¶

Warning

Dump ethdev Rx descriptor info to a file.

This API is used for debugging, not a dataplane API.

Parameters

Returns

__rte_experimental int rte_eth_tx_descriptor_dump (uint16_t port_id, uint16_t queue_id, uint16_t offset, uint16_t num, FILE * file)¶

Warning

Dump ethdev Tx descriptor info to a file.

This API is used for debugging, not a dataplane API.

Parameters

Returns

__rte_experimental int rte_eth_cman_info_get (uint16_t port_id, struct rte_eth_cman_info * info)¶

Warning

Retrieve the information for ethdev congestion management

Parameters

Returns

__rte_experimental int rte_eth_cman_config_init (uint16_t port_id, struct rte_eth_cman_config * config)¶

Warning

Initialize the ethdev congestion management configuration structure with default values.

Parameters

Returns

__rte_experimental int rte_eth_cman_config_set (uint16_t port_id, const struct rte_eth_cman_config * config)¶

Warning

Configure ethdev congestion management

Parameters

Returns

__rte_experimental int rte_eth_cman_config_get (uint16_t port_id, struct rte_eth_cman_config * config)¶

Warning

Retrieve the applied ethdev congestion management parameters for the given port.

Parameters

Returns

static uint16_t rte_eth_rx_burst (uint16_t port_id, uint16_t queue_id, struct rte_mbuf ** rx_pkts, const uint16_t nb_pkts) [inline], [static]¶

Retrieve a burst of input packets from a receive queue of an Ethernet device. The retrieved packets are stored in rte_mbuf structures whose pointers are supplied in the rx_pkts array.

The rte_eth_rx_burst() function loops, parsing the Rx ring of the receive queue, up to nb_pkts packets, and for each completed Rx descriptor in the ring, it performs the following operations:

• Initialize the rte_mbuf data structure associated with the Rx descriptor according to the information provided by the NIC into that Rx descriptor.
• Store the rte_mbuf data structure into the next entry of the rx_pkts array.
• Replenish the Rx descriptor with a new rte_mbuf buffer allocated from the memory pool associated with the receive queue at initialization time.

When retrieving an input packet that was scattered by the controller into multiple receive descriptors, the rte_eth_rx_burst() function appends the associated rte_mbuf buffers to the first buffer of the packet.

The rte_eth_rx_burst() function returns the number of packets actually retrieved, which is the number of rte_mbuf data structures effectively supplied into the rx_pkts array. A return value equal to nb_pkts indicates that the Rx queue contained at least rx_pkts packets, and this is likely to signify that other received packets remain in the input queue. Applications implementing a 'retrieve as much received packets as possible' policy can check this specific case and keep invoking the rte_eth_rx_burst() function until a value less than nb_pkts is returned.

This receive method has the following advantages:

• It allows a run-to-completion network stack engine to retrieve and to immediately process received packets in a fast burst-oriented approach, avoiding the overhead of unnecessary intermediate packet queue/dequeue operations.
• Conversely, it also allows an asynchronous-oriented processing method to retrieve bursts of received packets and to immediately queue them for further parallel processing by another logical core, for instance. However, instead of having received packets being individually queued by the driver, this approach allows the caller of the rte_eth_rx_burst() function to queue a burst of retrieved packets at a time and therefore dramatically reduce the cost of enqueue/dequeue operations per packet.
• It allows the rte_eth_rx_burst() function of the driver to take advantage of burst-oriented hardware features (CPU cache, prefetch instructions, and so on) to minimize the number of CPU cycles per packet.

To summarize, the proposed receive API enables many burst-oriented optimizations in both synchronous and asynchronous packet processing environments with no overhead in both cases.

Note

The rte_eth_rx_burst() function does not provide any error notification to avoid the corresponding overhead. As a hint, the upper-level application might check the status of the device link once being systematically returned a 0 value for a given number of tries.

Parameters

Returns

Definition at line 6045 of file rte_ethdev.h.

static int rte_eth_rx_queue_count (uint16_t port_id, uint16_t queue_id) [inline], [static]¶

Get the number of used descriptors of a Rx queue

Since it's a dataplane function, no check is performed on port_id and queue_id. The caller must therefore ensure that the port is enabled and the queue is configured and running.

Parameters

Returns

Definition at line 6118 of file rte_ethdev.h.

static int rte_eth_rx_descriptor_status (uint16_t port_id, uint16_t queue_id, uint16_t offset) [inline], [static]¶

Check the status of a Rx descriptor in the queue

It should be called in a similar context than the Rx function:

• on a dataplane core
• not concurrently on the same queue

Since it's a dataplane function, no check is performed on port_id and queue_id. The caller must therefore ensure that the port is enabled and the queue is configured and running.

Note: accessing to a random descriptor in the ring may trigger cache misses and have a performance impact.

Parameters

Returns

Definition at line 6190 of file rte_ethdev.h.

static int rte_eth_tx_descriptor_status (uint16_t port_id, uint16_t queue_id, uint16_t offset) [inline], [static]¶

Check the status of a Tx descriptor in the queue.

It should be called in a similar context than the Tx function:

• on a dataplane core
• not concurrently on the same queue

Since it's a dataplane function, no check is performed on port_id and queue_id. The caller must therefore ensure that the port is enabled and the queue is configured and running.

Note: accessing to a random descriptor in the ring may trigger cache misses and have a performance impact.

Parameters

Returns

Definition at line 6261 of file rte_ethdev.h.

static uint16_t rte_eth_tx_burst (uint16_t port_id, uint16_t queue_id, struct rte_mbuf ** tx_pkts, uint16_t nb_pkts) [inline], [static]¶

Send a burst of output packets on a transmit queue of an Ethernet device.

The rte_eth_tx_burst() function is invoked to transmit output packets on the output queue queue_id of the Ethernet device designated by its port_id. The nb_pkts parameter is the number of packets to send which are supplied in the tx_pkts array of rte_mbuf structures, each of them allocated from a pool created with rte_pktmbuf_pool_create(). The rte_eth_tx_burst() function loops, sending nb_pkts packets, up to the number of transmit descriptors available in the Tx ring of the transmit queue. For each packet to send, the rte_eth_tx_burst() function performs the following operations:

• Pick up the next available descriptor in the transmit ring.
• Free the network buffer previously sent with that descriptor, if any.
• Initialize the transmit descriptor with the information provided in the *rte_mbuf data structure.

In the case of a segmented packet composed of a list of rte_mbuf buffers, the rte_eth_tx_burst() function uses several transmit descriptors of the ring.

The rte_eth_tx_burst() function returns the number of packets it actually sent. A return value equal to nb_pkts means that all packets have been sent, and this is likely to signify that other output packets could be immediately transmitted again. Applications that implement a 'send as many packets to transmit as possible' policy can check this specific case and keep invoking the rte_eth_tx_burst() function until a value less than nb_pkts is returned.

It is the responsibility of the rte_eth_tx_burst() function to transparently free the memory buffers of packets previously sent. This feature is driven by the tx_free_thresh value supplied to the rte_eth_dev_configure() function at device configuration time. When the number of free Tx descriptors drops below this threshold, the rte_eth_tx_burst() function must [attempt to] free the rte_mbuf buffers of those packets whose transmission was effectively completed.

If the PMD is RTE_ETH_TX_OFFLOAD_MT_LOCKFREE capable, multiple threads can invoke this function concurrently on the same Tx queue without SW lock.

See also

Note

Parameters

Returns

Definition at line 6385 of file rte_ethdev.h.

static uint16_t rte_eth_tx_prepare (uint16_t port_id, uint16_t queue_id, struct rte_mbuf ** tx_pkts, uint16_t nb_pkts) [inline], [static]¶

Process a burst of output packets on a transmit queue of an Ethernet device.

The rte_eth_tx_prepare() function is invoked to prepare output packets to be transmitted on the output queue queue_id of the Ethernet device designated by its port_id. The nb_pkts parameter is the number of packets to be prepared which are supplied in the tx_pkts array of rte_mbuf structures, each of them allocated from a pool created with rte_pktmbuf_pool_create(). For each packet to send, the rte_eth_tx_prepare() function performs the following operations:

• Check if packet meets devices requirements for Tx offloads.
• Check limitations about number of segments.
• Check additional requirements when debug is enabled.
• Update and/or reset required checksums when Tx offload is set for packet.

Since this function can modify packet data, provided mbufs must be safely writable (e.g. modified data cannot be in shared segment).

The rte_eth_tx_prepare() function returns the number of packets ready to be sent. A return value equal to nb_pkts means that all packets are valid and ready to be sent, otherwise stops processing on the first invalid packet and leaves the rest packets untouched.

When this functionality is not implemented in the driver, all packets are are returned untouched.

Parameters

Returns

Definition at line 6495 of file rte_ethdev.h.

static uint16_t rte_eth_tx_buffer_flush (uint16_t port_id, uint16_t queue_id, struct rte_eth_dev_tx_buffer * buffer) [inline], [static]¶

Send any packets queued up for transmission on a port and HW queue

This causes an explicit flush of packets previously buffered via the rte_eth_tx_buffer() function. It returns the number of packets successfully sent to the NIC, and calls the error callback for any unsent packets. Unless explicitly set up otherwise, the default callback simply frees the unsent packets back to the owning mempool.

Parameters

Returns

Definition at line 6580 of file rte_ethdev.h.

static __rte_always_inline uint16_t rte_eth_tx_buffer (uint16_t port_id, uint16_t queue_id, struct rte_eth_dev_tx_buffer * buffer, struct rte_mbuf * tx_pkt) [static]¶

Buffer a single packet for future transmission on a port and queue

This function takes a single mbuf/packet and buffers it for later transmission on the particular port and queue specified. Once the buffer is full of packets, an attempt will be made to transmit all the buffered packets. In case of error, where not all packets can be transmitted, a callback is called with the unsent packets as a parameter. If no callback is explicitly set up, the unsent packets are just freed back to the owning mempool. The function returns the number of packets actually sent i.e. 0 if no buffer flush occurred, otherwise the number of packets successfully flushed

Parameters

Returns

Definition at line 6633 of file rte_ethdev.h.

static __rte_experimental uint16_t rte_eth_recycle_mbufs (uint16_t rx_port_id, uint16_t rx_queue_id, uint16_t tx_port_id, uint16_t tx_queue_id, struct rte_eth_recycle_rxq_info * recycle_rxq_info) [inline], [static]¶

Warning

Recycle used mbufs from a transmit queue of an Ethernet device, and move these mbufs into a mbuf ring for a receive queue of an Ethernet device. This can bypass mempool path to save CPU cycles.

The rte_eth_recycle_mbufs() function loops, with rte_eth_rx_burst() and rte_eth_tx_burst() functions, freeing Tx used mbufs and replenishing Rx descriptors. The number of recycling mbufs depends on the request of Rx mbuf ring, with the constraint of enough used mbufs from Tx mbuf ring.

For each recycling mbufs, the rte_eth_recycle_mbufs() function performs the following operations:

• Copy used rte_mbuf buffer pointers from Tx mbuf ring into Rx mbuf ring.
• Replenish the Rx descriptors with the recycling rte_mbuf mbufs freed from the Tx mbuf ring.

This function spilts Rx and Tx path with different callback functions. The callback function recycle_tx_mbufs_reuse is for Tx driver. The callback function recycle_rx_descriptors_refill is for Rx driver. rte_eth_recycle_mbufs() can support the case that Rx Ethernet device is different from Tx Ethernet device.

It is the responsibility of users to select the Rx/Tx queue pair to recycle mbufs. Before call this function, users must call rte_eth_recycle_rxq_info_get function to retrieve selected Rx queue information.

See also

Currently, the rte_eth_recycle_mbufs() function can support to feed 1 Rx queue from 2 Tx queues in the same thread. Do not pair the Rx queue and Tx queue in different threads, in order to avoid memory error rewriting.

Parameters

Returns

Definition at line 6698 of file rte_ethdev.h.

__rte_experimental int rte_eth_buffer_split_get_supported_hdr_ptypes (uint16_t port_id, uint32_t * ptypes, int num)¶

Warning

Get supported header protocols to split on Rx.

When a packet type is announced to be split, it must be supported by the PMD. For instance, if eth-ipv4, eth-ipv4-udp is announced, the PMD must return the following packet types for these packets:

• Ether/IPv4 -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4
• Ether/IPv4/UDP -> RTE_PTYPE_L2_ETHER | RTE_PTYPE_L3_IPV4 | RTE_PTYPE_L4_UDP

Parameters

Returns

uint32_t link_speed¶

RTE_ETH_SPEED_NUM_

Definition at line 0 of file rte_ethdev.h.

uint16_t link_duplex¶

RTE_ETH_LINK_[HALF/FULL]_DUPLEX

Definition at line 1 of file rte_ethdev.h.

uint16_t link_autoneg¶

RTE_ETH_LINK_[AUTONEG/FIXED]

Definition at line 2 of file rte_ethdev.h.

uint16_t link_status¶

RTE_ETH_LINK_[DOWN/UP]

Definition at line 3 of file rte_ethdev.h.