DPDK  21.05.0
Data Structures | Macros | Functions | Variables
rte_ether.h File Reference
#include <stdint.h>
#include <stdio.h>
#include <rte_memcpy.h>
#include <rte_random.h>
#include <rte_mbuf.h>
#include <rte_byteorder.h>

Go to the source code of this file.

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
 
rte_be16_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

◆ RTE_ETHER_TYPE_LEN

#define RTE_ETHER_TYPE_LEN   2

Length of Ethernet type field.

Definition at line 27 of file rte_ether.h.

◆ RTE_ETHER_CRC_LEN

#define RTE_ETHER_CRC_LEN   4

Length of Ethernet CRC.

Definition at line 28 of file rte_ether.h.

◆ RTE_ETHER_HDR_LEN

#define RTE_ETHER_HDR_LEN
Value:
RTE_ETHER_TYPE_LEN)
#define RTE_ETHER_ADDR_LEN
Definition: rte_ether.h:26

Length of Ethernet header.

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

Definition at line 29 of file rte_ether.h.

◆ RTE_ETHER_MIN_LEN

#define RTE_ETHER_MIN_LEN   64

Minimum frame len, including CRC.

Definition at line 32 of file rte_ether.h.

◆ RTE_ETHER_MAX_LEN

#define RTE_ETHER_MAX_LEN   1518

◆ RTE_ETHER_MTU

#define RTE_ETHER_MTU
Value:
RTE_ETHER_CRC_LEN)
#define RTE_ETHER_MAX_LEN
Definition: rte_ether.h:33
#define RTE_ETHER_HDR_LEN
Definition: rte_ether.h:29

Ethernet MTU.

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

Definition at line 34 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 38 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 42 of file rte_ether.h.

◆ RTE_ETHER_MAX_VLAN_ID

#define RTE_ETHER_MAX_VLAN_ID   4095

Maximum VLAN ID.

Definition at line 45 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 47 of file rte_ether.h.

◆ RTE_ETHER_LOCAL_ADMIN_ADDR

#define RTE_ETHER_LOCAL_ADMIN_ADDR   0x02

◆ RTE_ETHER_GROUP_ADDR

#define RTE_ETHER_GROUP_ADDR   0x01

Multicast or broadcast Eth. address.

Definition at line 65 of file rte_ether.h.

◆ RTE_ETHER_TYPE_IPV4

#define RTE_ETHER_TYPE_IPV4   0x0800

◆ RTE_ETHER_TYPE_IPV6

#define RTE_ETHER_TYPE_IPV6   0x86DD

◆ RTE_ETHER_TYPE_ARP

#define RTE_ETHER_TYPE_ARP   0x0806

Arp Protocol.

Examples:
examples/bond/main.c.

Definition at line 299 of file rte_ether.h.

◆ RTE_ETHER_TYPE_RARP

#define RTE_ETHER_TYPE_RARP   0x8035

Reverse Arp Protocol.

Definition at line 300 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 301 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ

#define RTE_ETHER_TYPE_QINQ   0x88A8

IEEE 802.1ad QinQ tagging.

Definition at line 302 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ1

#define RTE_ETHER_TYPE_QINQ1   0x9100

Deprecated QinQ VLAN.

Definition at line 303 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ2

#define RTE_ETHER_TYPE_QINQ2   0x9200

Deprecated QinQ VLAN.

Definition at line 304 of file rte_ether.h.

◆ RTE_ETHER_TYPE_QINQ3

#define RTE_ETHER_TYPE_QINQ3   0x9300

Deprecated QinQ VLAN.

Definition at line 305 of file rte_ether.h.

◆ RTE_ETHER_TYPE_PPPOE_DISCOVERY

#define RTE_ETHER_TYPE_PPPOE_DISCOVERY   0x8863

PPPoE Discovery Stage.

Definition at line 306 of file rte_ether.h.

◆ RTE_ETHER_TYPE_PPPOE_SESSION

#define RTE_ETHER_TYPE_PPPOE_SESSION   0x8864

PPPoE Session Stage.

Definition at line 307 of file rte_ether.h.

◆ RTE_ETHER_TYPE_ETAG

#define RTE_ETHER_TYPE_ETAG   0x893F

IEEE 802.1BR E-Tag.

Definition at line 308 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 309 of file rte_ether.h.

◆ RTE_ETHER_TYPE_SLOW

#define RTE_ETHER_TYPE_SLOW   0x8809

Slow protocols (LACP and Marker).

Definition at line 311 of file rte_ether.h.

◆ RTE_ETHER_TYPE_TEB

#define RTE_ETHER_TYPE_TEB   0x6558

Transparent Ethernet Bridging.

Definition at line 312 of file rte_ether.h.

◆ RTE_ETHER_TYPE_LLDP

#define RTE_ETHER_TYPE_LLDP   0x88CC

LLDP Protocol.

Definition at line 313 of file rte_ether.h.

◆ RTE_ETHER_TYPE_MPLS

#define RTE_ETHER_TYPE_MPLS   0x8847

MPLS ethertype.

Definition at line 314 of file rte_ether.h.

◆ RTE_ETHER_TYPE_MPLSM

#define RTE_ETHER_TYPE_MPLSM   0x8848

MPLS multicast ethertype.

Definition at line 315 of file rte_ether.h.

◆ RTE_ETHER_TYPE_ECPRI

#define RTE_ETHER_TYPE_ECPRI   0xAEFE

eCPRI ethertype (.1Q supported).

Definition at line 316 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
ea1A pointer to the first ether_addr structure containing the ethernet address.
ea2A 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 81 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
eaA 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 100 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
eaA 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 117 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
eaA 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 132 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
eaA 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 147 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
eaA 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 164 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
eaA 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 179 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
eaA 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 195 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
addrA 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

◆ rte_ether_format_addr()

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

◆ 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
strA 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_addrA 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
mThe packet mbuf.
Returns
  • 0: Success
  • 1: not a vlan packet

Definition at line 329 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
mThe packet mbuf.
Returns
  • 0: On success -EPERM: mbuf is is shared overwriting would be unsafe -ENOSPC: not enough headroom in mbuf

Definition at line 361 of file rte_ether.h.

Variable Documentation

◆ addr_bytes

uint8_t addr_bytes[RTE_ETHER_ADDR_LEN]

◆ 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 255 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 258 of file rte_ether.h.

◆ S_un

struct { ... } S_un

Do not use directly; use s_addr instead.

◆ ether_type

rte_be16_t ether_type