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 #ifdef RTE_EXEC_ENV_WINDOWS /* Workaround conflict with rte_ether_hdr. */
  27 #undef s_addr /* Defined in winsock2.h included in windows.h. */
  28 #endif
  29
  30 #define RTE_ETHER_ADDR_LEN  6 /**< Length of Ethernet address. */
  31 #define RTE_ETHER_TYPE_LEN  2 /**< Length of Ethernet type field. */
  32 #define RTE_ETHER_CRC_LEN   4 /**< Length of Ethernet CRC. */
  33 #define RTE_ETHER_HDR_LEN   \
  34         (RTE_ETHER_ADDR_LEN * 2 + \
  35                 RTE_ETHER_TYPE_LEN) /**< Length of Ethernet header. */
  36 #define RTE_ETHER_MIN_LEN   64    /**< Minimum frame len, including CRC. */
  37 #define RTE_ETHER_MAX_LEN   1518  /**< Maximum frame len, including CRC. */
  38 #define RTE_ETHER_MTU       \
  39         (RTE_ETHER_MAX_LEN - RTE_ETHER_HDR_LEN - \
  40                 RTE_ETHER_CRC_LEN) /**< Ethernet MTU. */
  41
  42 #define RTE_ETHER_MAX_VLAN_FRAME_LEN \
  43         (RTE_ETHER_MAX_LEN + 4)
  44         /**< Maximum VLAN frame length, including CRC. */
  45
  46 #define RTE_ETHER_MAX_JUMBO_FRAME_LEN \
  47         0x3F00 /**< Maximum Jumbo frame length, including CRC. */
  48
  49 #define RTE_ETHER_MAX_VLAN_ID  4095 /**< Maximum VLAN ID. */
  50
  51 #define RTE_ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
  52
  53 /**
  54  * Ethernet address:
  55  * A universally administered address is uniquely assigned to a device by its
  56  * manufacturer. The first three octets (in transmission order) contain the
  57  * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
  58  * EUI-48) octets are assigned by that organization with the only constraint
  59  * of uniqueness.
  60  * A locally administered address is assigned to a device by a network
  61  * administrator and does not contain OUIs.
  62  * See http://standards.ieee.org/regauth/groupmac/tutorial.html
  63  */
  64 struct rte_ether_addr {
  65         uint8_t addr_bytes[RTE_ETHER_ADDR_LEN]; /**< Addr bytes in tx order */
  66 } __rte_aligned(2);
  67
  68 #define RTE_ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
  69 #define RTE_ETHER_GROUP_ADDR  0x01 /**< Multicast or broadcast Eth. address. */
  70
  71 /**
  72  * Check if two Ethernet addresses are the same.
  73  *
  74  * @param ea1
  75  *  A pointer to the first ether_addr structure containing
  76  *  the ethernet address.
  77  * @param ea2
  78  *  A pointer to the second ether_addr structure containing
  79  *  the ethernet address.
  80  *
  81  * @return
  82  *  True  (1) if the given two ethernet address are the same;
  83  *  False (0) otherwise.
  84  */
  85 static inline int rte_is_same_ether_addr(const struct rte_ether_addr *ea1,
  86                                      const struct rte_ether_addr *ea2)
  87 {
  88         const uint16_t *w1 = (const uint16_t *)ea1;
  89         const uint16_t *w2 = (const uint16_t *)ea2;
  90
  91         return ((w1[0] ^ w2[0]) | (w1[1] ^ w2[1]) | (w1[2] ^ w2[2])) == 0;
  92 }
  93
  94 /**
  95  * Check if an Ethernet address is filled with zeros.
  96  *
  97  * @param ea
  98  *   A pointer to a ether_addr structure containing the ethernet address
  99  *   to check.
 100  * @return
 101  *   True  (1) if the given ethernet address is filled with zeros;
 102  *   false (0) otherwise.
 103  */
 104 static inline int rte_is_zero_ether_addr(const struct rte_ether_addr *ea)
 105 {
 106         const uint16_t *w = (const uint16_t *)ea;
 107
 108         return (w[0] | w[1] | w[2]) == 0;
 109 }
 110
 111 /**
 112  * Check if an Ethernet address is a unicast address.
 113  *
 114  * @param ea
 115  *   A pointer to a ether_addr structure containing the ethernet address
 116  *   to check.
 117  * @return
 118  *   True  (1) if the given ethernet address is a unicast address;
 119  *   false (0) otherwise.
 120  */
 121 static inline int rte_is_unicast_ether_addr(const struct rte_ether_addr *ea)
 122 {
 123         return (ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR) == 0;
 124 }
 125
 126 /**
 127  * Check if an Ethernet address is a multicast address.
 128  *
 129  * @param ea
 130  *   A pointer to a ether_addr structure containing the ethernet address
 131  *   to check.
 132  * @return
 133  *   True  (1) if the given ethernet address is a multicast address;
 134  *   false (0) otherwise.
 135  */
 136 static inline int rte_is_multicast_ether_addr(const struct rte_ether_addr *ea)
 137 {
 138         return ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR;
 139 }
 140
 141 /**
 142  * Check if an Ethernet address is a broadcast address.
 143  *
 144  * @param ea
 145  *   A pointer to a ether_addr structure containing the ethernet address
 146  *   to check.
 147  * @return
 148  *   True  (1) if the given ethernet address is a broadcast address;
 149  *   false (0) otherwise.
 150  */
 151 static inline int rte_is_broadcast_ether_addr(const struct rte_ether_addr *ea)
 152 {
 153         const uint16_t *ea_words = (const uint16_t *)ea;
 154
 155         return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
 156                 ea_words[2] == 0xFFFF);
 157 }
 158
 159 /**
 160  * Check if an Ethernet address is a universally assigned address.
 161  *
 162  * @param ea
 163  *   A pointer to a ether_addr structure containing the ethernet address
 164  *   to check.
 165  * @return
 166  *   True  (1) if the given ethernet address is a universally assigned address;
 167  *   false (0) otherwise.
 168  */
 169 static inline int rte_is_universal_ether_addr(const struct rte_ether_addr *ea)
 170 {
 171         return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) == 0;
 172 }
 173
 174 /**
 175  * Check if an Ethernet address is a locally assigned address.
 176  *
 177  * @param ea
 178  *   A pointer to a ether_addr structure containing the ethernet address
 179  *   to check.
 180  * @return
 181  *   True  (1) if the given ethernet address is a locally assigned address;
 182  *   false (0) otherwise.
 183  */
 184 static inline int rte_is_local_admin_ether_addr(const struct rte_ether_addr *ea)
 185 {
 186         return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) != 0;
 187 }
 188
 189 /**
 190  * Check if an Ethernet address is a valid address. Checks that the address is a
 191  * unicast address and is not filled with zeros.
 192  *
 193  * @param ea
 194  *   A pointer to a ether_addr structure containing the ethernet address
 195  *   to check.
 196  * @return
 197  *   True  (1) if the given ethernet address is valid;
 198  *   false (0) otherwise.
 199  */
 200 static inline int rte_is_valid_assigned_ether_addr(const struct rte_ether_addr *ea)
 201 {
 202         return rte_is_unicast_ether_addr(ea) && (!rte_is_zero_ether_addr(ea));
 203 }
 204
 205 /**
 206  * Generate a random Ethernet address that is locally administered
 207  * and not multicast.
 208  * @param addr
 209  *   A pointer to Ethernet address.
 210  */
 211 void
 212 rte_eth_random_addr(uint8_t *addr);
 213
 214 /**
 215  * Fast copy an Ethernet address.
 216  *
 217  * @param ea_from
 218  *   A pointer to a ether_addr structure holding the Ethernet address to copy.
 219  * @param ea_to
 220  *   A pointer to a ether_addr structure where to copy the Ethernet address.
 221  */
 222 static inline void rte_ether_addr_copy(const struct rte_ether_addr *ea_from,
 223                                    struct rte_ether_addr *ea_to)
 224 {
 225 #ifdef __INTEL_COMPILER
 226         uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
 227         uint16_t *to_words   = (uint16_t *)(ea_to->addr_bytes);
 228
 229         to_words[0] = from_words[0];
 230         to_words[1] = from_words[1];
 231         to_words[2] = from_words[2];
 232 #else
 233         /*
 234          * Use the common way, because of a strange gcc warning.
 235          */
 236         *ea_to = *ea_from;
 237 #endif
 238 }
 239
 240 #define RTE_ETHER_ADDR_FMT_SIZE         18
 241 /**
 242  * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
 243  *
 244  * @param buf
 245  *   A pointer to buffer contains the formatted MAC address.
 246  * @param size
 247  *   The format buffer size.
 248  * @param eth_addr
 249  *   A pointer to a ether_addr structure.
 250  */
 251 void
 252 rte_ether_format_addr(char *buf, uint16_t size,
 253                       const struct rte_ether_addr *eth_addr);
 254 /**
 255  * Convert string with Ethernet address to an ether_addr.
 256  *
 257  * @param str
 258  *   A pointer to buffer contains the formatted MAC address.
 259  *   The supported formats are:
 260  *     XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX
 261  *   where XX is a hex digit: 0-9, a-f, or A-F.
 262  * @param eth_addr
 263  *   A pointer to a ether_addr structure.
 264  * @return
 265  *   0 if successful
 266  *   -1 and sets rte_errno if invalid string
 267  */
 268 __rte_experimental
 269 int
 270 rte_ether_unformat_addr(const char *str, struct rte_ether_addr *eth_addr);
 271
 272 /**
 273  * Ethernet header: Contains the destination address, source address
 274  * and frame type.
 275  */
 276 struct rte_ether_hdr {
 277         struct rte_ether_addr d_addr; /**< Destination address. */
 278         struct rte_ether_addr s_addr; /**< Source address. */
 279         uint16_t ether_type;      /**< Frame type. */
 280 } __rte_aligned(2);
 281
 282 /**
 283  * Ethernet VLAN Header.
 284  * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
 285  * of the encapsulated frame.
 286  */
 287 struct rte_vlan_hdr {
 288         uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
 289         uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
 290 } __rte_packed;
 291
 292
 293
 294 /* Ethernet frame types */
 295 #define RTE_ETHER_TYPE_IPV4 0x0800 /**< IPv4 Protocol. */
 296 #define RTE_ETHER_TYPE_IPV6 0x86DD /**< IPv6 Protocol. */
 297 #define RTE_ETHER_TYPE_ARP  0x0806 /**< Arp Protocol. */
 298 #define RTE_ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
 299 #define RTE_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
 300 #define RTE_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
 301 #define RTE_ETHER_TYPE_QINQ1 0x9100 /**< Deprecated QinQ VLAN. */
 302 #define RTE_ETHER_TYPE_QINQ2 0x9200 /**< Deprecated QinQ VLAN. */
 303 #define RTE_ETHER_TYPE_QINQ3 0x9300 /**< Deprecated QinQ VLAN. */
 304 #define RTE_ETHER_TYPE_PPPOE_DISCOVERY 0x8863 /**< PPPoE Discovery Stage. */
 305 #define RTE_ETHER_TYPE_PPPOE_SESSION 0x8864 /**< PPPoE Session Stage. */
 306 #define RTE_ETHER_TYPE_ETAG 0x893F /**< IEEE 802.1BR E-Tag. */
 307 #define RTE_ETHER_TYPE_1588 0x88F7
 308         /**< IEEE 802.1AS 1588 Precise Time Protocol. */
 309 #define RTE_ETHER_TYPE_SLOW 0x8809 /**< Slow protocols (LACP and Marker). */
 310 #define RTE_ETHER_TYPE_TEB  0x6558 /**< Transparent Ethernet Bridging. */
 311 #define RTE_ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
 312 #define RTE_ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
 313 #define RTE_ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
 314 #define RTE_ETHER_TYPE_ECPRI 0xAEFE /**< eCPRI ethertype (.1Q supported). */
 315
 316 /**
 317  * Extract VLAN tag information into mbuf
 318  *
 319  * Software version of VLAN stripping
 320  *
 321  * @param m
 322  *   The packet mbuf.
 323  * @return
 324  *   - 0: Success
 325  *   - 1: not a vlan packet
 326  */
 327 static inline int rte_vlan_strip(struct rte_mbuf *m)
 328 {
 329         struct rte_ether_hdr *eh
 330                  = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
 331         struct rte_vlan_hdr *vh;
 332
 333         if (eh->ether_type != rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN))
 334                 return -1;
 335
 336         vh = (struct rte_vlan_hdr *)(eh + 1);
 337         m->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
 338         m->vlan_tci = rte_be_to_cpu_16(vh->vlan_tci);
 339
 340         /* Copy ether header over rather than moving whole packet */
 341         memmove(rte_pktmbuf_adj(m, sizeof(struct rte_vlan_hdr)),
 342                 eh, 2 * RTE_ETHER_ADDR_LEN);
 343
 344         return 0;
 345 }
 346
 347 /**
 348  * Insert VLAN tag into mbuf.
 349  *
 350  * Software version of VLAN unstripping
 351  *
 352  * @param m
 353  *   The packet mbuf.
 354  * @return
 355  *   - 0: On success
 356  *   -EPERM: mbuf is is shared overwriting would be unsafe
 357  *   -ENOSPC: not enough headroom in mbuf
 358  */
 359 static inline int rte_vlan_insert(struct rte_mbuf **m)
 360 {
 361         struct rte_ether_hdr *oh, *nh;
 362         struct rte_vlan_hdr *vh;
 363
 364         /* Can't insert header if mbuf is shared */
 365         if (!RTE_MBUF_DIRECT(*m) || rte_mbuf_refcnt_read(*m) > 1)
 366                 return -EINVAL;
 367
 368         oh = rte_pktmbuf_mtod(*m, struct rte_ether_hdr *);
 369         nh = (struct rte_ether_hdr *)
 370                 rte_pktmbuf_prepend(*m, sizeof(struct rte_vlan_hdr));
 371         if (nh == NULL)
 372                 return -ENOSPC;
 373
 374         memmove(nh, oh, 2 * RTE_ETHER_ADDR_LEN);
 375         nh->ether_type = rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN);
 376
 377         vh = (struct rte_vlan_hdr *) (nh + 1);
 378         vh->vlan_tci = rte_cpu_to_be_16((*m)->vlan_tci);
 379
 380         (*m)->ol_flags &= ~(PKT_RX_VLAN_STRIPPED | PKT_TX_VLAN);
 381
 382         if ((*m)->ol_flags & PKT_TX_TUNNEL_MASK)
 383                 (*m)->outer_l2_len += sizeof(struct rte_vlan_hdr);
 384         else
 385                 (*m)->l2_len += sizeof(struct rte_vlan_hdr);
 386
 387         return 0;
 388 }
 389
 390 #ifdef __cplusplus
 391 }
 392 #endif
 393
 394 #endif /* _RTE_ETHER_H_ */