#include <stdint.h>
#include <stdio.h>
#include <rte_memcpy.h>
#include <rte_random.h>
#include <rte_mbuf.h>
#include <rte_byteorder.h>

Data Structures
struct	rte_ether_addr

struct	rte_ether_hdr

struct	rte_vlan_hdr

Macros
#define	RTE_ETHER_ADDR_LEN 6

#define	RTE_ETHER_TYPE_LEN 2

#define	RTE_ETHER_CRC_LEN 4

#define	RTE_ETHER_HDR_LEN

#define	RTE_ETHER_MIN_LEN 64

#define	RTE_ETHER_MAX_LEN 1518

#define	RTE_ETHER_MTU

#define	RTE_ETHER_MAX_VLAN_FRAME_LEN (RTE_ETHER_MAX_LEN + 4)

#define	RTE_ETHER_MAX_JUMBO_FRAME_LEN 0x3F00

#define	RTE_ETHER_MAX_VLAN_ID 4095

#define	RTE_ETHER_MIN_MTU 68

#define	RTE_ETHER_LOCAL_ADMIN_ADDR 0x02

#define	RTE_ETHER_GROUP_ADDR 0x01

#define	RTE_ETHER_TYPE_IPV4 0x0800

#define	RTE_ETHER_TYPE_IPV6 0x86DD

#define	RTE_ETHER_TYPE_ARP 0x0806

#define	RTE_ETHER_TYPE_RARP 0x8035

#define	RTE_ETHER_TYPE_VLAN 0x8100

#define	RTE_ETHER_TYPE_QINQ 0x88A8

#define	RTE_ETHER_TYPE_QINQ1 0x9100

#define	RTE_ETHER_TYPE_QINQ2 0x9200

#define	RTE_ETHER_TYPE_QINQ3 0x9300

#define	RTE_ETHER_TYPE_PPPOE_DISCOVERY 0x8863

#define	RTE_ETHER_TYPE_PPPOE_SESSION 0x8864

#define	RTE_ETHER_TYPE_ETAG 0x893F

#define	RTE_ETHER_TYPE_1588 0x88F7

#define	RTE_ETHER_TYPE_SLOW 0x8809

#define	RTE_ETHER_TYPE_TEB 0x6558

#define	RTE_ETHER_TYPE_LLDP 0x88CC

#define	RTE_ETHER_TYPE_MPLS 0x8847

#define	RTE_ETHER_TYPE_MPLSM 0x8848

#define	RTE_ETHER_TYPE_ECPRI 0xAEFE

Functions
static int	rte_is_same_ether_addr (const struct rte_ether_addr ea1, const struct rte_ether_addr ea2)

static int	rte_is_zero_ether_addr (const struct rte_ether_addr *ea)

static int	rte_is_unicast_ether_addr (const struct rte_ether_addr *ea)

static int	rte_is_multicast_ether_addr (const struct rte_ether_addr *ea)

static int	rte_is_broadcast_ether_addr (const struct rte_ether_addr *ea)

static int	rte_is_universal_ether_addr (const struct rte_ether_addr *ea)

static int	rte_is_local_admin_ether_addr (const struct rte_ether_addr *ea)

static int	rte_is_valid_assigned_ether_addr (const struct rte_ether_addr *ea)

void	rte_eth_random_addr (uint8_t *addr)

static void	rte_ether_addr_copy (const struct rte_ether_addr __restrict ea_from, struct rte_ether_addr __restrict ea_to)

void	rte_ether_format_addr (char buf, uint16_t size, const struct rte_ether_addr eth_addr)

__rte_experimental int	rte_ether_unformat_addr (const char str, struct rte_ether_addr eth_addr)

static int	rte_vlan_strip (struct rte_mbuf *m)

static int	rte_vlan_insert (struct rte_mbuf **m)

Variables
uint8_t	addr_bytes [RTE_ETHER_ADDR_LEN]

struct rte_ether_addr	d_addr

struct rte_ether_addr	s_addr

uint16_t	ether_type

Detailed Description

Ethernet Helpers in RTE

Definition in file rte_ether.h.

Macro Definition Documentation

◆ RTE_ETHER_ADDR_LEN

#define RTE_ETHER_ADDR_LEN 6

Length of Ethernet address.

Examples:: examples/bond/main.c, examples/ip_pipeline/parser.c, examples/ipsec-secgw/ipsec_worker.c, examples/vhost/main.c, and examples/vm_power_manager/channel_monitor.c.

Definition at line 30 of file rte_ether.h.

◆ RTE_ETHER_TYPE_LEN

#define RTE_ETHER_TYPE_LEN 2

Length of Ethernet type field.

Definition at line 31 of file rte_ether.h.

◆ RTE_ETHER_CRC_LEN

#define RTE_ETHER_CRC_LEN 4

Length of Ethernet CRC.

Definition at line 32 of file rte_ether.h.

◆ RTE_ETHER_HDR_LEN

#define RTE_ETHER_HDR_LEN

Value:

(RTE_ETHER_ADDR_LEN * 2 + \

RTE_ETHER_TYPE_LEN)

RTE_ETHER_ADDR_LEN

#define RTE_ETHER_ADDR_LEN

Definition: rte_ether.h:30

Length of Ethernet header.

Examples:: examples/ipsec-secgw/ipsec-secgw.c, and examples/ipsec-secgw/ipsec_worker.c.

Definition at line 33 of file rte_ether.h.

◆ RTE_ETHER_MIN_LEN

#define RTE_ETHER_MIN_LEN 64

Minimum frame len, including CRC.

Definition at line 36 of file rte_ether.h.

◆ RTE_ETHER_MAX_LEN

#define RTE_ETHER_MAX_LEN 1518

Maximum frame len, including CRC.

Examples:: examples/bbdev_app/main.c, examples/bond/main.c, examples/distributor/main.c, examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/flow_classify/flow_classify.c, examples/ioat/ioatfwd.c, examples/ip_pipeline/kni.c, examples/ipsec-secgw/ipsec-secgw.c, examples/kni/main.c, examples/l2fwd-cat/l2fwd-cat.c, examples/l2fwd-crypto/main.c, examples/l2fwd-event/l2fwd_common.c, examples/l3fwd-acl/main.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/qos_sched/init.c, examples/rxtx_callbacks/main.c, examples/skeleton/basicfwd.c, and examples/vm_power_manager/main.c.

Definition at line 37 of file rte_ether.h.

◆ RTE_ETHER_MTU

#define RTE_ETHER_MTU

Value:

(RTE_ETHER_MAX_LEN - RTE_ETHER_HDR_LEN - \

RTE_ETHER_CRC_LEN)

RTE_ETHER_MAX_LEN

#define RTE_ETHER_MAX_LEN

Definition: rte_ether.h:37

RTE_ETHER_HDR_LEN

#define RTE_ETHER_HDR_LEN

Definition: rte_ether.h:33

Ethernet MTU.

Examples:: examples/ipsec-secgw/ipsec-secgw.c.

Definition at line 38 of file rte_ether.h.

◆ RTE_ETHER_MAX_VLAN_FRAME_LEN

#define RTE_ETHER_MAX_VLAN_FRAME_LEN (RTE_ETHER_MAX_LEN + 4)

Maximum VLAN frame length, including CRC.

Definition at line 42 of file rte_ether.h.

◆ RTE_ETHER_MAX_JUMBO_FRAME_LEN

#define RTE_ETHER_MAX_JUMBO_FRAME_LEN 0x3F00

Maximum Jumbo frame length, including CRC.

Examples:: examples/ethtool/ethtool-app/ethapp.c.

Definition at line 46 of file rte_ether.h.

◆ RTE_ETHER_MAX_VLAN_ID

#define RTE_ETHER_MAX_VLAN_ID 4095

Maximum VLAN ID.

Definition at line 49 of file rte_ether.h.

◆ RTE_ETHER_MIN_MTU

#define RTE_ETHER_MIN_MTU 68

Minimum MTU for IPv4 packets, see RFC 791.

Examples:: examples/ethtool/ethtool-app/ethapp.c.

Definition at line 51 of file rte_ether.h.

◆ RTE_ETHER_LOCAL_ADMIN_ADDR

#define RTE_ETHER_LOCAL_ADMIN_ADDR 0x02

Locally assigned Eth. address.

Examples:: examples/l3fwd-acl/main.c, examples/l3fwd-graph/main.c, examples/l3fwd/main.c, and examples/performance-thread/l3fwd-thread/main.c.

Definition at line 68 of file rte_ether.h.

◆ RTE_ETHER_GROUP_ADDR

#define RTE_ETHER_GROUP_ADDR 0x01

Multicast or broadcast Eth. address.

Definition at line 69 of file rte_ether.h.

◆ RTE_ETHER_TYPE_IPV4

#define RTE_ETHER_TYPE_IPV4 0x0800

IPv4 Protocol.

Examples:: examples/bond/main.c, examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/ipsec_worker.c, examples/ipv4_multicast/main.c, examples/l2fwd-crypto/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_lpm.c, and examples/performance-thread/l3fwd-thread/main.c.

Definition at line 283 of file rte_ether.h.

◆ RTE_ETHER_TYPE_IPV6

#define RTE_ETHER_TYPE_IPV6 0x86DD

IPv6 Protocol.

Examples:: examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/ipsec_worker.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_lpm.c, and examples/performance-thread/l3fwd-thread/main.c.

Definition at line 284 of file rte_ether.h.

◆ RTE_ETHER_TYPE_ARP

#define RTE_ETHER_TYPE_ARP 0x0806

Arp Protocol.

Examples:: examples/bond/main.c.

Definition at line 285 of file rte_ether.h.

◆ RTE_ETHER_TYPE_RARP

#define RTE_ETHER_TYPE_RARP 0x8035

Reverse Arp Protocol.

Definition at line 286 of file rte_ether.h.

◆ RTE_ETHER_TYPE_VLAN

#define RTE_ETHER_TYPE_VLAN 0x8100

IEEE 802.1Q VLAN tagging.

Examples:: examples/bond/main.c, and examples/vhost/main.c.

Definition at line 287 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ

#define RTE_ETHER_TYPE_QINQ 0x88A8

IEEE 802.1ad QinQ tagging.

Definition at line 288 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ1

#define RTE_ETHER_TYPE_QINQ1 0x9100

Deprecated QinQ VLAN.

Definition at line 289 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ2

#define RTE_ETHER_TYPE_QINQ2 0x9200

Deprecated QinQ VLAN.

Definition at line 290 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ3

#define RTE_ETHER_TYPE_QINQ3 0x9300

Deprecated QinQ VLAN.

Definition at line 291 of file rte_ether.h.

◆ RTE_ETHER_TYPE_PPPOE_DISCOVERY

#define RTE_ETHER_TYPE_PPPOE_DISCOVERY 0x8863

PPPoE Discovery Stage.

Definition at line 292 of file rte_ether.h.

◆ RTE_ETHER_TYPE_PPPOE_SESSION

#define RTE_ETHER_TYPE_PPPOE_SESSION 0x8864

PPPoE Session Stage.

Definition at line 293 of file rte_ether.h.

◆ RTE_ETHER_TYPE_ETAG

#define RTE_ETHER_TYPE_ETAG 0x893F

IEEE 802.1BR E-Tag.

Definition at line 294 of file rte_ether.h.

◆ RTE_ETHER_TYPE_1588

#define RTE_ETHER_TYPE_1588 0x88F7

IEEE 802.1AS 1588 Precise Time Protocol.

Definition at line 295 of file rte_ether.h.

◆ RTE_ETHER_TYPE_SLOW

#define RTE_ETHER_TYPE_SLOW 0x8809

Slow protocols (LACP and Marker).

Definition at line 297 of file rte_ether.h.

◆ RTE_ETHER_TYPE_TEB

#define RTE_ETHER_TYPE_TEB 0x6558

Transparent Ethernet Bridging.

Definition at line 298 of file rte_ether.h.

◆ RTE_ETHER_TYPE_LLDP

#define RTE_ETHER_TYPE_LLDP 0x88CC

LLDP Protocol.

Definition at line 299 of file rte_ether.h.

◆ RTE_ETHER_TYPE_MPLS

#define RTE_ETHER_TYPE_MPLS 0x8847

MPLS ethertype.

Definition at line 300 of file rte_ether.h.

◆ RTE_ETHER_TYPE_MPLSM

#define RTE_ETHER_TYPE_MPLSM 0x8848

MPLS multicast ethertype.

Definition at line 301 of file rte_ether.h.

◆ RTE_ETHER_TYPE_ECPRI

#define RTE_ETHER_TYPE_ECPRI 0xAEFE

eCPRI ethertype (.1Q supported).

Definition at line 302 of file rte_ether.h.

Function Documentation

◆ rte_is_same_ether_addr()

static int rte_is_same_ether_addr	(	const struct rte_ether_addr *	ea1,
		const struct rte_ether_addr *	ea2
	)

inlinestatic

Check if two Ethernet addresses are the same.

Parameters

ea1	A pointer to the first ether_addr structure containing the ethernet address.
ea2	A pointer to the second ether_addr structure containing the ethernet address.

Returns: True (1) if the given two ethernet address are the same; False (0) otherwise.

Examples:: examples/vhost/main.c.

Definition at line 85 of file rte_ether.h.

◆ rte_is_zero_ether_addr()

static int rte_is_zero_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is filled with zeros.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is filled with zeros; false (0) otherwise.

Definition at line 104 of file rte_ether.h.

◆ rte_is_unicast_ether_addr()

static int rte_is_unicast_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is a unicast address.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is a unicast address; false (0) otherwise.

Definition at line 121 of file rte_ether.h.

◆ rte_is_multicast_ether_addr()

static int rte_is_multicast_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is a multicast address.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is a multicast address; false (0) otherwise.

Definition at line 136 of file rte_ether.h.

◆ rte_is_broadcast_ether_addr()

static int rte_is_broadcast_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is a broadcast address.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is a broadcast address; false (0) otherwise.

Examples:: examples/vhost/main.c.

Definition at line 151 of file rte_ether.h.

◆ rte_is_universal_ether_addr()

static int rte_is_universal_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is a universally assigned address.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is a universally assigned address; false (0) otherwise.

Definition at line 168 of file rte_ether.h.

◆ rte_is_local_admin_ether_addr()

static int rte_is_local_admin_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is a locally assigned address.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is a locally assigned address; false (0) otherwise.

Definition at line 183 of file rte_ether.h.

◆ rte_is_valid_assigned_ether_addr()

static int rte_is_valid_assigned_ether_addr ( const struct rte_ether_addr * ea )

inlinestatic

Check if an Ethernet address is a valid address. Checks that the address is a unicast address and is not filled with zeros.

Parameters

ea	A pointer to a ether_addr structure containing the ethernet address to check.

Returns: True (1) if the given ethernet address is valid; false (0) otherwise.

Examples:: examples/ethtool/lib/rte_ethtool.c.

Definition at line 199 of file rte_ether.h.

◆ rte_eth_random_addr()

void rte_eth_random_addr ( uint8_t * addr )

Generate a random Ethernet address that is locally administered and not multicast.

Parameters

addr	A pointer to Ethernet address.

◆ rte_ether_addr_copy()

static void rte_ether_addr_copy	(	const struct rte_ether_addr *__restrict	ea_from,
		struct rte_ether_addr *__restrict	ea_to
	)

inlinestatic

Copy an Ethernet address.

Parameters

ea_from	A pointer to a ether_addr structure holding the Ethernet address to copy.
ea_to	A pointer to a ether_addr structure where to copy the Ethernet address.

Examples:: examples/bond/main.c, examples/ethtool/ethtool-app/main.c, examples/ioat/ioatfwd.c, examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipv4_multicast/main.c, examples/l2fwd-crypto/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd/main.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_event.c, examples/l3fwd/l3fwd_lpm.c, examples/l3fwd/main.c, examples/link_status_interrupt/main.c, examples/performance-thread/l3fwd-thread/main.c, examples/ptpclient/ptpclient.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 222 of file rte_ether.h.

◆ rte_ether_format_addr()

void rte_ether_format_addr	(	char *	buf,
		uint16_t	size,
		const struct rte_ether_addr *	eth_addr
	)

Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.

Parameters

buf	A pointer to buffer contains the formatted MAC address.
size	The format buffer size.
eth_addr	A pointer to a ether_addr structure.

Examples:: examples/flow_filtering/main.c, examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipv4_multicast/main.c, examples/kni/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_event.c, examples/l3fwd/main.c, examples/multi_process/client_server_mp/mp_server/main.c, and examples/performance-thread/l3fwd-thread/main.c.

◆ rte_ether_unformat_addr()

__rte_experimental int rte_ether_unformat_addr	(	const char *	str,
		struct rte_ether_addr *	eth_addr
	)

Convert string with Ethernet address to an ether_addr.

Parameters

str	A pointer to buffer contains the formatted MAC address. The supported formats are: XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX where XX is a hex digit: 0-9, a-f, or A-F.
eth_addr	A pointer to a ether_addr structure.

Returns: 0 if successful -1 and sets rte_errno if invalid string

◆ rte_vlan_strip()

static int rte_vlan_strip ( struct rte_mbuf * m )

inlinestatic

Extract VLAN tag information into mbuf

Software version of VLAN stripping

Parameters

m	The packet mbuf.

Returns

0: Success
1: not a vlan packet

Definition at line 315 of file rte_ether.h.

◆ rte_vlan_insert()

static int rte_vlan_insert ( struct rte_mbuf ** m )

inlinestatic

Insert VLAN tag into mbuf.

Software version of VLAN unstripping

Parameters

m	The packet mbuf.

Returns

0: On success -EPERM: mbuf is is shared overwriting would be unsafe -ENOSPC: not enough headroom in mbuf

Definition at line 347 of file rte_ether.h.

Variable Documentation

◆ addr_bytes

uint8_t addr_bytes[RTE_ETHER_ADDR_LEN]

Addr bytes in tx order

Examples:: examples/ioat/ioatfwd.c, examples/l2fwd-crypto/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd/main.c, examples/link_status_interrupt/main.c, examples/vhost/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 34 of file rte_ether.h.

◆ d_addr

struct rte_ether_addr d_addr

Destination address.

Examples:: examples/l3fwd-acl/main.c, and examples/performance-thread/l3fwd-thread/main.c.

Definition at line 259 of file rte_ether.h.

◆ s_addr

struct rte_ether_addr s_addr

Source address.

Examples:: examples/l3fwd-acl/main.c, and examples/performance-thread/l3fwd-thread/main.c.

Definition at line 260 of file rte_ether.h.

◆ ether_type

uint16_t ether_type

Frame type.

Examples:: examples/bond/main.c, examples/ip_fragmentation/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_lpm.c, and examples/performance-thread/l3fwd-thread/main.c.

Definition at line 261 of file rte_ether.h.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ RTE_ETHER_ADDR_LEN

◆ RTE_ETHER_TYPE_LEN

◆ RTE_ETHER_CRC_LEN

◆ RTE_ETHER_HDR_LEN

◆ RTE_ETHER_MIN_LEN

◆ RTE_ETHER_MAX_LEN

◆ RTE_ETHER_MTU

◆ RTE_ETHER_MAX_VLAN_FRAME_LEN

◆ RTE_ETHER_MAX_JUMBO_FRAME_LEN

◆ RTE_ETHER_MAX_VLAN_ID

◆ RTE_ETHER_MIN_MTU

◆ RTE_ETHER_LOCAL_ADMIN_ADDR

◆ RTE_ETHER_GROUP_ADDR

◆ RTE_ETHER_TYPE_IPV4

◆ RTE_ETHER_TYPE_IPV6

◆ RTE_ETHER_TYPE_ARP

◆ RTE_ETHER_TYPE_RARP

◆ RTE_ETHER_TYPE_VLAN

◆ RTE_ETHER_TYPE_QINQ

◆ RTE_ETHER_TYPE_QINQ1

◆ RTE_ETHER_TYPE_QINQ2

◆ RTE_ETHER_TYPE_QINQ3

◆ RTE_ETHER_TYPE_PPPOE_DISCOVERY

◆ RTE_ETHER_TYPE_PPPOE_SESSION

◆ RTE_ETHER_TYPE_ETAG

◆ RTE_ETHER_TYPE_1588

◆ RTE_ETHER_TYPE_SLOW

◆ RTE_ETHER_TYPE_TEB

◆ RTE_ETHER_TYPE_LLDP

◆ RTE_ETHER_TYPE_MPLS

◆ RTE_ETHER_TYPE_MPLSM

◆ RTE_ETHER_TYPE_ECPRI

Function Documentation

◆ rte_is_same_ether_addr()

◆ rte_is_zero_ether_addr()

◆ rte_is_unicast_ether_addr()

◆ rte_is_multicast_ether_addr()

◆ rte_is_broadcast_ether_addr()

◆ rte_is_universal_ether_addr()

◆ rte_is_local_admin_ether_addr()

◆ rte_is_valid_assigned_ether_addr()

◆ rte_eth_random_addr()

◆ rte_ether_addr_copy()

◆ rte_ether_format_addr()

◆ rte_ether_unformat_addr()

◆ rte_vlan_strip()

◆ rte_vlan_insert()

Variable Documentation

◆ addr_bytes

◆ d_addr

◆ s_addr

◆ ether_type