lib/librte_net/rte_ether.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _RTE_ETHER_H_
   6 #define _RTE_ETHER_H_
   7
   8 /**
   9  * @file
  10  *
  11  * Ethernet Helpers in RTE
  12  */
  13
  14 #ifdef __cplusplus
  15 extern "C" {
  16 #endif
  17
  18 #include <stdint.h>
  19 #include <stdio.h>
  20
  21 #include <rte_memcpy.h>
  22 #include <rte_random.h>
  23 #include <rte_mbuf.h>
  24 #include <rte_byteorder.h>
  25
  26 #define RTE_ETHER_ADDR_LEN  6 /**< Length of Ethernet address. */
  27 #define RTE_ETHER_TYPE_LEN  2 /**< Length of Ethernet type field. */
  28 #define RTE_ETHER_CRC_LEN   4 /**< Length of Ethernet CRC. */
  29 #define RTE_ETHER_HDR_LEN   \
  30         (RTE_ETHER_ADDR_LEN * 2 + \
  31                 RTE_ETHER_TYPE_LEN) /**< Length of Ethernet header. */
  32 #define RTE_ETHER_MIN_LEN   64    /**< Minimum frame len, including CRC. */
  33 #define RTE_ETHER_MAX_LEN   1518  /**< Maximum frame len, including CRC. */
  34 #define RTE_ETHER_MTU       \
  35         (RTE_ETHER_MAX_LEN - RTE_ETHER_HDR_LEN - \
  36                 RTE_ETHER_CRC_LEN) /**< Ethernet MTU. */
  37
  38 #define RTE_ETHER_MAX_VLAN_FRAME_LEN \
  39         (RTE_ETHER_MAX_LEN + 4)
  40         /**< Maximum VLAN frame length, including CRC. */
  41
  42 #define RTE_ETHER_MAX_JUMBO_FRAME_LEN \
  43         0x3F00 /**< Maximum Jumbo frame length, including CRC. */
  44
  45 #define RTE_ETHER_MAX_VLAN_ID  4095 /**< Maximum VLAN ID. */
  46
  47 #define RTE_ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
  48
  49 /**
  50  * Ethernet address:
  51  * A universally administered address is uniquely assigned to a device by its
  52  * manufacturer. The first three octets (in transmission order) contain the
  53  * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
  54  * EUI-48) octets are assigned by that organization with the only constraint
  55  * of uniqueness.
  56  * A locally administered address is assigned to a device by a network
  57  * administrator and does not contain OUIs.
  58  * See http://standards.ieee.org/regauth/groupmac/tutorial.html
  59  */
  60 struct rte_ether_addr {
  61         uint8_t addr_bytes[RTE_ETHER_ADDR_LEN]; /**< Addr bytes in tx order */
  62 } __attribute__((__packed__));
  63
  64 #define RTE_ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
  65 #define RTE_ETHER_GROUP_ADDR  0x01 /**< Multicast or broadcast Eth. address. */
  66
  67 /**
  68  * Check if two Ethernet addresses are the same.
  69  *
  70  * @param ea1
  71  *  A pointer to the first ether_addr structure containing
  72  *  the ethernet address.
  73  * @param ea2
  74  *  A pointer to the second ether_addr structure containing
  75  *  the ethernet address.
  76  *
  77  * @return
  78  *  True  (1) if the given two ethernet address are the same;
  79  *  False (0) otherwise.
  80  */
  81 static inline int rte_is_same_ether_addr(const struct rte_ether_addr *ea1,
  82                                      const struct rte_ether_addr *ea2)
  83 {
  84         int i;
  85         for (i = 0; i < RTE_ETHER_ADDR_LEN; i++)
  86                 if (ea1->addr_bytes[i] != ea2->addr_bytes[i])
  87                         return 0;
  88         return 1;
  89 }
  90
  91 /**
  92  * Check if an Ethernet address is filled with zeros.
  93  *
  94  * @param ea
  95  *   A pointer to a ether_addr structure containing the ethernet address
  96  *   to check.
  97  * @return
  98  *   True  (1) if the given ethernet address is filled with zeros;
  99  *   false (0) otherwise.
 100  */
 101 static inline int rte_is_zero_ether_addr(const struct rte_ether_addr *ea)
 102 {
 103         int i;
 104         for (i = 0; i < RTE_ETHER_ADDR_LEN; i++)
 105                 if (ea->addr_bytes[i] != 0x00)
 106                         return 0;
 107         return 1;
 108 }
 109
 110 /**
 111  * Check if an Ethernet address is a unicast address.
 112  *
 113  * @param ea
 114  *   A pointer to a ether_addr structure containing the ethernet address
 115  *   to check.
 116  * @return
 117  *   True  (1) if the given ethernet address is a unicast address;
 118  *   false (0) otherwise.
 119  */
 120 static inline int rte_is_unicast_ether_addr(const struct rte_ether_addr *ea)
 121 {
 122         return (ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR) == 0;
 123 }
 124
 125 /**
 126  * Check if an Ethernet address is a multicast address.
 127  *
 128  * @param ea
 129  *   A pointer to a ether_addr structure containing the ethernet address
 130  *   to check.
 131  * @return
 132  *   True  (1) if the given ethernet address is a multicast address;
 133  *   false (0) otherwise.
 134  */
 135 static inline int rte_is_multicast_ether_addr(const struct rte_ether_addr *ea)
 136 {
 137         return ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR;
 138 }
 139
 140 /**
 141  * Check if an Ethernet address is a broadcast address.
 142  *
 143  * @param ea
 144  *   A pointer to a ether_addr structure containing the ethernet address
 145  *   to check.
 146  * @return
 147  *   True  (1) if the given ethernet address is a broadcast address;
 148  *   false (0) otherwise.
 149  */
 150 static inline int rte_is_broadcast_ether_addr(const struct rte_ether_addr *ea)
 151 {
 152         const unaligned_uint16_t *ea_words = (const unaligned_uint16_t *)ea;
 153
 154         return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
 155                 ea_words[2] == 0xFFFF);
 156 }
 157
 158 /**
 159  * Check if an Ethernet address is a universally assigned address.
 160  *
 161  * @param ea
 162  *   A pointer to a ether_addr structure containing the ethernet address
 163  *   to check.
 164  * @return
 165  *   True  (1) if the given ethernet address is a universally assigned address;
 166  *   false (0) otherwise.
 167  */
 168 static inline int rte_is_universal_ether_addr(const struct rte_ether_addr *ea)
 169 {
 170         return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) == 0;
 171 }
 172
 173 /**
 174  * Check if an Ethernet address is a locally assigned address.
 175  *
 176  * @param ea
 177  *   A pointer to a ether_addr structure containing the ethernet address
 178  *   to check.
 179  * @return
 180  *   True  (1) if the given ethernet address is a locally assigned address;
 181  *   false (0) otherwise.
 182  */
 183 static inline int rte_is_local_admin_ether_addr(const struct rte_ether_addr *ea)
 184 {
 185         return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) != 0;
 186 }
 187
 188 /**
 189  * Check if an Ethernet address is a valid address. Checks that the address is a
 190  * unicast address and is not filled with zeros.
 191  *
 192  * @param ea
 193  *   A pointer to a ether_addr structure containing the ethernet address
 194  *   to check.
 195  * @return
 196  *   True  (1) if the given ethernet address is valid;
 197  *   false (0) otherwise.
 198  */
 199 static inline int rte_is_valid_assigned_ether_addr(const struct rte_ether_addr *ea)
 200 {
 201         return rte_is_unicast_ether_addr(ea) && (!rte_is_zero_ether_addr(ea));
 202 }
 203
 204 /**
 205  * Generate a random Ethernet address that is locally administered
 206  * and not multicast.
 207  * @param addr
 208  *   A pointer to Ethernet address.
 209  */
 210 static inline void rte_eth_random_addr(uint8_t *addr)
 211 {
 212         uint64_t rand = rte_rand();
 213         uint8_t *p = (uint8_t *)&rand;
 214
 215         rte_memcpy(addr, p, RTE_ETHER_ADDR_LEN);
 216         addr[0] &= (uint8_t)~RTE_ETHER_GROUP_ADDR;  /* clear multicast bit */
 217         addr[0] |= RTE_ETHER_LOCAL_ADMIN_ADDR;  /* set local assignment bit */
 218 }
 219
 220 /**
 221  * Fast copy an Ethernet address.
 222  *
 223  * @param ea_from
 224  *   A pointer to a ether_addr structure holding the Ethernet address to copy.
 225  * @param ea_to
 226  *   A pointer to a ether_addr structure where to copy the Ethernet address.
 227  */
 228 static inline void rte_ether_addr_copy(const struct rte_ether_addr *ea_from,
 229                                    struct rte_ether_addr *ea_to)
 230 {
 231 #ifdef __INTEL_COMPILER
 232         uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
 233         uint16_t *to_words   = (uint16_t *)(ea_to->addr_bytes);
 234
 235         to_words[0] = from_words[0];
 236         to_words[1] = from_words[1];
 237         to_words[2] = from_words[2];
 238 #else
 239         /*
 240          * Use the common way, because of a strange gcc warning.
 241          */
 242         *ea_to = *ea_from;
 243 #endif
 244 }
 245
 246 #define RTE_ETHER_ADDR_FMT_SIZE         18
 247 /**
 248  * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
 249  *
 250  * @param buf
 251  *   A pointer to buffer contains the formatted MAC address.
 252  * @param size
 253  *   The format buffer size.
 254  * @param eth_addr
 255  *   A pointer to a ether_addr structure.
 256  */
 257 static inline void
 258 rte_ether_format_addr(char *buf, uint16_t size,
 259                   const struct rte_ether_addr *eth_addr)
 260 {
 261         snprintf(buf, size, "%02X:%02X:%02X:%02X:%02X:%02X",
 262                  eth_addr->addr_bytes[0],
 263                  eth_addr->addr_bytes[1],
 264                  eth_addr->addr_bytes[2],
 265                  eth_addr->addr_bytes[3],
 266                  eth_addr->addr_bytes[4],
 267                  eth_addr->addr_bytes[5]);
 268 }
 269
 270 /**
 271  * Ethernet header: Contains the destination address, source address
 272  * and frame type.
 273  */
 274 struct rte_ether_hdr {
 275         struct rte_ether_addr d_addr; /**< Destination address. */
 276         struct rte_ether_addr s_addr; /**< Source address. */
 277         uint16_t ether_type;      /**< Frame type. */
 278 } __attribute__((__packed__));
 279
 280 /**
 281  * Ethernet VLAN Header.
 282  * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
 283  * of the encapsulated frame.
 284  */
 285 struct rte_vlan_hdr {
 286         uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
 287         uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
 288 } __attribute__((__packed__));
 289
 290 /**
 291  * VXLAN protocol header.
 292  * Contains the 8-bit flag, 24-bit VXLAN Network Identifier and
 293  * Reserved fields (24 bits and 8 bits)
 294  */
 295 struct rte_vxlan_hdr {
 296         uint32_t vx_flags; /**< flag (8) + Reserved (24). */
 297         uint32_t vx_vni;   /**< VNI (24) + Reserved (8). */
 298 } __attribute__((__packed__));
 299
 300 /* Ethernet frame types */
 301 #define RTE_ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
 302 #define RTE_ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
 303 #define RTE_ETHER_TYPE_ARP  0x0806 /**< Arp Protocol. */
 304 #define RTE_ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
 305 #define RTE_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
 306 #define RTE_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
 307 #define ETHER_TYPE_PPPOE_DISCOVERY 0x8863 /**< PPPoE Discovery Stage. */
 308 #define ETHER_TYPE_PPPOE_SESSION 0x8864 /**< PPPoE Session Stage. */
 309 #define RTE_ETHER_TYPE_ETAG 0x893F /**< IEEE 802.1BR E-Tag. */
 310 #define RTE_ETHER_TYPE_1588 0x88F7
 311         /**< IEEE 802.1AS 1588 Precise Time Protocol. */
 312 #define RTE_ETHER_TYPE_SLOW 0x8809 /**< Slow protocols (LACP and Marker). */
 313 #define RTE_ETHER_TYPE_TEB  0x6558 /**< Transparent Ethernet Bridging. */
 314 #define RTE_ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
 315 #define RTE_ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
 316 #define RTE_ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
 317
 318 #define RTE_ETHER_VXLAN_HLEN \
 319         (sizeof(struct rte_udp_hdr) + sizeof(struct rte_vxlan_hdr))
 320         /**< VXLAN tunnel header length. */
 321
 322 /**
 323  * VXLAN-GPE protocol header (draft-ietf-nvo3-vxlan-gpe-05).
 324  * Contains the 8-bit flag, 8-bit next-protocol, 24-bit VXLAN Network
 325  * Identifier and Reserved fields (16 bits and 8 bits).
 326  */
 327 struct rte_vxlan_gpe_hdr {
 328         uint8_t vx_flags;    /**< flag (8). */
 329         uint8_t reserved[2]; /**< Reserved (16). */
 330         uint8_t proto;       /**< next-protocol (8). */
 331         uint32_t vx_vni;     /**< VNI (24) + Reserved (8). */
 332 } __attribute__((__packed__));
 333
 334 /* VXLAN-GPE next protocol types */
 335 #define RTE_VXLAN_GPE_TYPE_IPV4 1 /**< IPv4 Protocol. */
 336 #define RTE_VXLAN_GPE_TYPE_IPV6 2 /**< IPv6 Protocol. */
 337 #define RTE_VXLAN_GPE_TYPE_ETH  3 /**< Ethernet Protocol. */
 338 #define RTE_VXLAN_GPE_TYPE_NSH  4 /**< NSH Protocol. */
 339 #define RTE_VXLAN_GPE_TYPE_MPLS 5 /**< MPLS Protocol. */
 340 #define RTE_VXLAN_GPE_TYPE_GBP  6 /**< GBP Protocol. */
 341 #define RTE_VXLAN_GPE_TYPE_VBNG 7 /**< vBNG Protocol. */
 342
 343 #define RTE_ETHER_VXLAN_GPE_HLEN (sizeof(struct rte_udp_hdr) + \
 344                               sizeof(struct rte_vxlan_gpe_hdr))
 345 /**< VXLAN-GPE tunnel header length. */
 346
 347 /**
 348  * Extract VLAN tag information into mbuf
 349  *
 350  * Software version of VLAN stripping
 351  *
 352  * @param m
 353  *   The packet mbuf.
 354  * @return
 355  *   - 0: Success
 356  *   - 1: not a vlan packet
 357  */
 358 static inline int rte_vlan_strip(struct rte_mbuf *m)
 359 {
 360         struct rte_ether_hdr *eh
 361                  = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
 362         struct rte_vlan_hdr *vh;
 363
 364         if (eh->ether_type != rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN))
 365                 return -1;
 366
 367         vh = (struct rte_vlan_hdr *)(eh + 1);
 368         m->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
 369         m->vlan_tci = rte_be_to_cpu_16(vh->vlan_tci);
 370
 371         /* Copy ether header over rather than moving whole packet */
 372         memmove(rte_pktmbuf_adj(m, sizeof(struct rte_vlan_hdr)),
 373                 eh, 2 * RTE_ETHER_ADDR_LEN);
 374
 375         return 0;
 376 }
 377
 378 /**
 379  * Insert VLAN tag into mbuf.
 380  *
 381  * Software version of VLAN unstripping
 382  *
 383  * @param m
 384  *   The packet mbuf.
 385  * @return
 386  *   - 0: On success
 387  *   -EPERM: mbuf is is shared overwriting would be unsafe
 388  *   -ENOSPC: not enough headroom in mbuf
 389  */
 390 static inline int rte_vlan_insert(struct rte_mbuf **m)
 391 {
 392         struct rte_ether_hdr *oh, *nh;
 393         struct rte_vlan_hdr *vh;
 394
 395         /* Can't insert header if mbuf is shared */
 396         if (rte_mbuf_refcnt_read(*m) > 1) {
 397                 struct rte_mbuf *copy;
 398
 399                 copy = rte_pktmbuf_clone(*m, (*m)->pool);
 400                 if (unlikely(copy == NULL))
 401                         return -ENOMEM;
 402                 rte_pktmbuf_free(*m);
 403                 *m = copy;
 404         }
 405
 406         oh = rte_pktmbuf_mtod(*m, struct rte_ether_hdr *);
 407         nh = (struct rte_ether_hdr *)
 408                 rte_pktmbuf_prepend(*m, sizeof(struct rte_vlan_hdr));
 409         if (nh == NULL)
 410                 return -ENOSPC;
 411
 412         memmove(nh, oh, 2 * RTE_ETHER_ADDR_LEN);
 413         nh->ether_type = rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN);
 414
 415         vh = (struct rte_vlan_hdr *) (nh + 1);
 416         vh->vlan_tci = rte_cpu_to_be_16((*m)->vlan_tci);
 417
 418         (*m)->ol_flags &= ~(PKT_RX_VLAN_STRIPPED | PKT_TX_VLAN);
 419
 420         return 0;
 421 }
 422
 423 #ifdef __cplusplus
 424 }
 425 #endif
 426
 427 #endif /* _RTE_ETHER_H_ */