rte_ether.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2010-2014 Intel Corporation
 */

#ifndef _RTE_ETHER_H_
#define _RTE_ETHER_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdio.h>

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

#define ETHER_ADDR_LEN  6 
#define ETHER_TYPE_LEN  2 
#define ETHER_CRC_LEN   4 
#define ETHER_HDR_LEN   \
    (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) 
#define ETHER_MIN_LEN   64    
#define ETHER_MAX_LEN   1518  
#define ETHER_MTU       \
    (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) 
#define ETHER_MAX_VLAN_FRAME_LEN \
    (ETHER_MAX_LEN + 4) 
#define ETHER_MAX_JUMBO_FRAME_LEN \
    0x3F00 
#define ETHER_MAX_VLAN_ID  4095 
#define ETHER_MIN_MTU 68 
struct ether_addr {
    uint8_t addr_bytes[ETHER_ADDR_LEN]; 
} __attribute__((__packed__));

#define ETHER_LOCAL_ADMIN_ADDR 0x02 
#define ETHER_GROUP_ADDR       0x01 
static inline int is_same_ether_addr(const struct ether_addr *ea1,
                     const struct ether_addr *ea2)
{
    int i;
    for (i = 0; i < ETHER_ADDR_LEN; i++)
        if (ea1->addr_bytes[i] != ea2->addr_bytes[i])
            return 0;
    return 1;
}

static inline int is_zero_ether_addr(const struct ether_addr *ea)
{
    int i;
    for (i = 0; i < ETHER_ADDR_LEN; i++)
        if (ea->addr_bytes[i] != 0x00)
            return 0;
    return 1;
}

static inline int is_unicast_ether_addr(const struct ether_addr *ea)
{
    return (ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0;
}

static inline int is_multicast_ether_addr(const struct ether_addr *ea)
{
    return ea->addr_bytes[0] & ETHER_GROUP_ADDR;
}

static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
{
    const unaligned_uint16_t *ea_words = (const unaligned_uint16_t *)ea;

    return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
        ea_words[2] == 0xFFFF);
}

static inline int is_universal_ether_addr(const struct ether_addr *ea)
{
    return (ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0;
}

static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
{
    return (ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) != 0;
}

static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
{
    return is_unicast_ether_addr(ea) && (!is_zero_ether_addr(ea));
}

static inline void eth_random_addr(uint8_t *addr)
{
    uint64_t rand = rte_rand();
    uint8_t *p = (uint8_t *)&rand;

    rte_memcpy(addr, p, ETHER_ADDR_LEN);
    addr[0] &= (uint8_t)~ETHER_GROUP_ADDR;       /* clear multicast bit */
    addr[0] |= ETHER_LOCAL_ADMIN_ADDR;  /* set local assignment bit */
}

static inline void ether_addr_copy(const struct ether_addr *ea_from,
                   struct ether_addr *ea_to)
{
#ifdef __INTEL_COMPILER
    uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
    uint16_t *to_words   = (uint16_t *)(ea_to->addr_bytes);

    to_words[0] = from_words[0];
    to_words[1] = from_words[1];
    to_words[2] = from_words[2];
#else
    /*
     * Use the common way, because of a strange gcc warning.
     */
    *ea_to = *ea_from;
#endif
}

#define ETHER_ADDR_FMT_SIZE         18

static inline void
ether_format_addr(char *buf, uint16_t size,
          const struct ether_addr *eth_addr)
{
    snprintf(buf, size, "%02X:%02X:%02X:%02X:%02X:%02X",
         eth_addr->addr_bytes[0],
         eth_addr->addr_bytes[1],
         eth_addr->addr_bytes[2],
         eth_addr->addr_bytes[3],
         eth_addr->addr_bytes[4],
         eth_addr->addr_bytes[5]);
}

struct ether_hdr {
    struct ether_addr d_addr; 
    struct ether_addr s_addr; 
    uint16_t ether_type;      
} __attribute__((__packed__));

struct vlan_hdr {
    uint16_t vlan_tci; 
    uint16_t eth_proto;
} __attribute__((__packed__));

struct vxlan_hdr {
    uint32_t vx_flags; 
    uint32_t vx_vni;   
} __attribute__((__packed__));

/* Ethernet frame types */
#define ETHER_TYPE_IPv4 0x0800 
#define ETHER_TYPE_IPv6 0x86DD 
#define ETHER_TYPE_ARP  0x0806 
#define ETHER_TYPE_RARP 0x8035 
#define ETHER_TYPE_VLAN 0x8100 
#define ETHER_TYPE_QINQ 0x88A8 
#define ETHER_TYPE_ETAG 0x893F 
#define ETHER_TYPE_1588 0x88F7 
#define ETHER_TYPE_SLOW 0x8809 
#define ETHER_TYPE_TEB  0x6558 
#define ETHER_TYPE_LLDP 0x88CC 
#define ETHER_TYPE_MPLS 0x8847 
#define ETHER_TYPE_MPLSM 0x8848 
#define ETHER_VXLAN_HLEN (sizeof(struct udp_hdr) + sizeof(struct vxlan_hdr))

struct vxlan_gpe_hdr {
    uint8_t vx_flags;    
    uint8_t reserved[2]; 
    uint8_t proto;       
    uint32_t vx_vni;     
} __attribute__((__packed__));

/* VXLAN-GPE next protocol types */
#define VXLAN_GPE_TYPE_IPV4 1 
#define VXLAN_GPE_TYPE_IPV6 2 
#define VXLAN_GPE_TYPE_ETH  3 
#define VXLAN_GPE_TYPE_NSH  4 
#define VXLAN_GPE_TYPE_MPLS 5 
#define VXLAN_GPE_TYPE_GBP  6 
#define VXLAN_GPE_TYPE_VBNG 7 
#define ETHER_VXLAN_GPE_HLEN (sizeof(struct udp_hdr) + \
                  sizeof(struct vxlan_gpe_hdr))

static inline int rte_vlan_strip(struct rte_mbuf *m)
{
    struct ether_hdr *eh
         = rte_pktmbuf_mtod(m, struct ether_hdr *);
    struct vlan_hdr *vh;

    if (eh->ether_type != rte_cpu_to_be_16(ETHER_TYPE_VLAN))
        return -1;

    vh = (struct vlan_hdr *)(eh + 1);
    m->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
    m->vlan_tci = rte_be_to_cpu_16(vh->vlan_tci);

    /* Copy ether header over rather than moving whole packet */
    memmove(rte_pktmbuf_adj(m, sizeof(struct vlan_hdr)),
        eh, 2 * ETHER_ADDR_LEN);

    return 0;
}

static inline int rte_vlan_insert(struct rte_mbuf **m)
{
    struct ether_hdr *oh, *nh;
    struct vlan_hdr *vh;

    /* Can't insert header if mbuf is shared */
    if (rte_mbuf_refcnt_read(*m) > 1) {
        struct rte_mbuf *copy;

        copy = rte_pktmbuf_clone(*m, (*m)->pool);
        if (unlikely(copy == NULL))
            return -ENOMEM;
        rte_pktmbuf_free(*m);
        *m = copy;
    }

    oh = rte_pktmbuf_mtod(*m, struct ether_hdr *);
    nh = (struct ether_hdr *)
        rte_pktmbuf_prepend(*m, sizeof(struct vlan_hdr));
    if (nh == NULL)
        return -ENOSPC;

    memmove(nh, oh, 2 * ETHER_ADDR_LEN);
    nh->ether_type = rte_cpu_to_be_16(ETHER_TYPE_VLAN);

    vh = (struct vlan_hdr *) (nh + 1);
    vh->vlan_tci = rte_cpu_to_be_16((*m)->vlan_tci);

    (*m)->ol_flags &= ~(PKT_RX_VLAN_STRIPPED | PKT_TX_VLAN);

    if ((*m)->ol_flags & PKT_TX_TUNNEL_MASK)
        (*m)->outer_l2_len += sizeof(struct vlan_hdr);
    else
        (*m)->l2_len += sizeof(struct vlan_hdr);

    return 0;
}

#ifdef __cplusplus
}
#endif

#endif /* _RTE_ETHER_H_ */