1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
11 * Ethernet Helpers in RTE
21 #include <rte_memcpy.h>
22 #include <rte_random.h>
24 #include <rte_byteorder.h>
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. */
38 #define RTE_ETHER_MAX_VLAN_FRAME_LEN \
39 (RTE_ETHER_MAX_LEN + 4)
40 /**< Maximum VLAN frame length, including CRC. */
42 #define RTE_ETHER_MAX_JUMBO_FRAME_LEN \
43 0x3F00 /**< Maximum Jumbo frame length, including CRC. */
45 #define RTE_ETHER_MAX_VLAN_ID 4095 /**< Maximum VLAN ID. */
47 #define RTE_ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
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
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
60 struct rte_ether_addr {
61 uint8_t addr_bytes[RTE_ETHER_ADDR_LEN]; /**< Addr bytes in tx order */
62 } __attribute__((__packed__));
64 #define RTE_ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
65 #define RTE_ETHER_GROUP_ADDR 0x01 /**< Multicast or broadcast Eth. address. */
68 * Check if two Ethernet addresses are the same.
71 * A pointer to the first ether_addr structure containing
72 * the ethernet address.
74 * A pointer to the second ether_addr structure containing
75 * the ethernet address.
78 * True (1) if the given two ethernet address are the same;
79 * False (0) otherwise.
81 static inline int rte_is_same_ether_addr(const struct rte_ether_addr *ea1,
82 const struct rte_ether_addr *ea2)
84 const unaligned_uint16_t *w1 = (const uint16_t *)ea1;
85 const unaligned_uint16_t *w2 = (const uint16_t *)ea2;
87 return ((w1[0] ^ w2[0]) | (w1[1] ^ w2[1]) | (w1[2] ^ w2[2])) == 0;
91 * Check if an Ethernet address is filled with zeros.
94 * A pointer to a ether_addr structure containing the ethernet address
97 * True (1) if the given ethernet address is filled with zeros;
98 * false (0) otherwise.
100 static inline int rte_is_zero_ether_addr(const struct rte_ether_addr *ea)
102 const unaligned_uint16_t *w = (const uint16_t *)ea;
104 return (w[0] | w[1] | w[2]) == 0;
108 * Check if an Ethernet address is a unicast address.
111 * A pointer to a ether_addr structure containing the ethernet address
114 * True (1) if the given ethernet address is a unicast address;
115 * false (0) otherwise.
117 static inline int rte_is_unicast_ether_addr(const struct rte_ether_addr *ea)
119 return (ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR) == 0;
123 * Check if an Ethernet address is a multicast address.
126 * A pointer to a ether_addr structure containing the ethernet address
129 * True (1) if the given ethernet address is a multicast address;
130 * false (0) otherwise.
132 static inline int rte_is_multicast_ether_addr(const struct rte_ether_addr *ea)
134 return ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR;
138 * Check if an Ethernet address is a broadcast address.
141 * A pointer to a ether_addr structure containing the ethernet address
144 * True (1) if the given ethernet address is a broadcast address;
145 * false (0) otherwise.
147 static inline int rte_is_broadcast_ether_addr(const struct rte_ether_addr *ea)
149 const unaligned_uint16_t *ea_words = (const unaligned_uint16_t *)ea;
151 return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
152 ea_words[2] == 0xFFFF);
156 * Check if an Ethernet address is a universally assigned address.
159 * A pointer to a ether_addr structure containing the ethernet address
162 * True (1) if the given ethernet address is a universally assigned address;
163 * false (0) otherwise.
165 static inline int rte_is_universal_ether_addr(const struct rte_ether_addr *ea)
167 return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) == 0;
171 * Check if an Ethernet address is a locally assigned address.
174 * A pointer to a ether_addr structure containing the ethernet address
177 * True (1) if the given ethernet address is a locally assigned address;
178 * false (0) otherwise.
180 static inline int rte_is_local_admin_ether_addr(const struct rte_ether_addr *ea)
182 return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) != 0;
186 * Check if an Ethernet address is a valid address. Checks that the address is a
187 * unicast address and is not filled with zeros.
190 * A pointer to a ether_addr structure containing the ethernet address
193 * True (1) if the given ethernet address is valid;
194 * false (0) otherwise.
196 static inline int rte_is_valid_assigned_ether_addr(const struct rte_ether_addr *ea)
198 return rte_is_unicast_ether_addr(ea) && (!rte_is_zero_ether_addr(ea));
202 * Generate a random Ethernet address that is locally administered
205 * A pointer to Ethernet address.
208 rte_eth_random_addr(uint8_t *addr);
211 * Fast copy an Ethernet address.
214 * A pointer to a ether_addr structure holding the Ethernet address to copy.
216 * A pointer to a ether_addr structure where to copy the Ethernet address.
218 static inline void rte_ether_addr_copy(const struct rte_ether_addr *ea_from,
219 struct rte_ether_addr *ea_to)
221 #ifdef __INTEL_COMPILER
222 uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
223 uint16_t *to_words = (uint16_t *)(ea_to->addr_bytes);
225 to_words[0] = from_words[0];
226 to_words[1] = from_words[1];
227 to_words[2] = from_words[2];
230 * Use the common way, because of a strange gcc warning.
236 #define RTE_ETHER_ADDR_FMT_SIZE 18
238 * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
241 * A pointer to buffer contains the formatted MAC address.
243 * The format buffer size.
245 * A pointer to a ether_addr structure.
248 rte_ether_format_addr(char *buf, uint16_t size,
249 const struct rte_ether_addr *eth_addr);
251 * Convert string with Ethernet address to an ether_addr.
254 * A pointer to buffer contains the formatted MAC address.
255 * The supported formats are:
256 * XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX
257 * where XX is a hex digit: 0-9, a-f, or A-F.
259 * A pointer to a ether_addr structure.
262 * -1 and sets rte_errno if invalid string
266 rte_ether_unformat_addr(const char *str, struct rte_ether_addr *eth_addr);
269 * Ethernet header: Contains the destination address, source address
272 struct rte_ether_hdr {
273 struct rte_ether_addr d_addr; /**< Destination address. */
274 struct rte_ether_addr s_addr; /**< Source address. */
275 uint16_t ether_type; /**< Frame type. */
276 } __attribute__((__packed__));
279 * Ethernet VLAN Header.
280 * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
281 * of the encapsulated frame.
283 struct rte_vlan_hdr {
284 uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
285 uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
286 } __attribute__((__packed__));
289 * VXLAN protocol header.
290 * Contains the 8-bit flag, 24-bit VXLAN Network Identifier and
291 * Reserved fields (24 bits and 8 bits)
293 struct rte_vxlan_hdr {
294 uint32_t vx_flags; /**< flag (8) + Reserved (24). */
295 uint32_t vx_vni; /**< VNI (24) + Reserved (8). */
296 } __attribute__((__packed__));
298 /* Ethernet frame types */
299 #define RTE_ETHER_TYPE_IPV4 0x0800 /**< IPv4 Protocol. */
300 #define RTE_ETHER_TYPE_IPV6 0x86DD /**< IPv6 Protocol. */
301 #define RTE_ETHER_TYPE_ARP 0x0806 /**< Arp Protocol. */
302 #define RTE_ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
303 #define RTE_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
304 #define RTE_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
305 #define ETHER_TYPE_PPPOE_DISCOVERY 0x8863 /**< PPPoE Discovery Stage. */
306 #define ETHER_TYPE_PPPOE_SESSION 0x8864 /**< PPPoE Session Stage. */
307 #define RTE_ETHER_TYPE_ETAG 0x893F /**< IEEE 802.1BR E-Tag. */
308 #define RTE_ETHER_TYPE_1588 0x88F7
309 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
310 #define RTE_ETHER_TYPE_SLOW 0x8809 /**< Slow protocols (LACP and Marker). */
311 #define RTE_ETHER_TYPE_TEB 0x6558 /**< Transparent Ethernet Bridging. */
312 #define RTE_ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
313 #define RTE_ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
314 #define RTE_ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
316 #define RTE_ETHER_VXLAN_HLEN \
317 (sizeof(struct rte_udp_hdr) + sizeof(struct rte_vxlan_hdr))
318 /**< VXLAN tunnel header length. */
321 * VXLAN-GPE protocol header (draft-ietf-nvo3-vxlan-gpe-05).
322 * Contains the 8-bit flag, 8-bit next-protocol, 24-bit VXLAN Network
323 * Identifier and Reserved fields (16 bits and 8 bits).
325 struct rte_vxlan_gpe_hdr {
326 uint8_t vx_flags; /**< flag (8). */
327 uint8_t reserved[2]; /**< Reserved (16). */
328 uint8_t proto; /**< next-protocol (8). */
329 uint32_t vx_vni; /**< VNI (24) + Reserved (8). */
330 } __attribute__((__packed__));
332 /* VXLAN-GPE next protocol types */
333 #define RTE_VXLAN_GPE_TYPE_IPV4 1 /**< IPv4 Protocol. */
334 #define RTE_VXLAN_GPE_TYPE_IPV6 2 /**< IPv6 Protocol. */
335 #define RTE_VXLAN_GPE_TYPE_ETH 3 /**< Ethernet Protocol. */
336 #define RTE_VXLAN_GPE_TYPE_NSH 4 /**< NSH Protocol. */
337 #define RTE_VXLAN_GPE_TYPE_MPLS 5 /**< MPLS Protocol. */
338 #define RTE_VXLAN_GPE_TYPE_GBP 6 /**< GBP Protocol. */
339 #define RTE_VXLAN_GPE_TYPE_VBNG 7 /**< vBNG Protocol. */
341 #define RTE_ETHER_VXLAN_GPE_HLEN (sizeof(struct rte_udp_hdr) + \
342 sizeof(struct rte_vxlan_gpe_hdr))
343 /**< VXLAN-GPE tunnel header length. */
346 * Extract VLAN tag information into mbuf
348 * Software version of VLAN stripping
354 * - 1: not a vlan packet
356 static inline int rte_vlan_strip(struct rte_mbuf *m)
358 struct rte_ether_hdr *eh
359 = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
360 struct rte_vlan_hdr *vh;
362 if (eh->ether_type != rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN))
365 vh = (struct rte_vlan_hdr *)(eh + 1);
366 m->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
367 m->vlan_tci = rte_be_to_cpu_16(vh->vlan_tci);
369 /* Copy ether header over rather than moving whole packet */
370 memmove(rte_pktmbuf_adj(m, sizeof(struct rte_vlan_hdr)),
371 eh, 2 * RTE_ETHER_ADDR_LEN);
377 * Insert VLAN tag into mbuf.
379 * Software version of VLAN unstripping
385 * -EPERM: mbuf is is shared overwriting would be unsafe
386 * -ENOSPC: not enough headroom in mbuf
388 static inline int rte_vlan_insert(struct rte_mbuf **m)
390 struct rte_ether_hdr *oh, *nh;
391 struct rte_vlan_hdr *vh;
393 /* Can't insert header if mbuf is shared */
394 if (!RTE_MBUF_DIRECT(*m) || rte_mbuf_refcnt_read(*m) > 1)
397 oh = rte_pktmbuf_mtod(*m, struct rte_ether_hdr *);
398 nh = (struct rte_ether_hdr *)
399 rte_pktmbuf_prepend(*m, sizeof(struct rte_vlan_hdr));
403 memmove(nh, oh, 2 * RTE_ETHER_ADDR_LEN);
404 nh->ether_type = rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN);
406 vh = (struct rte_vlan_hdr *) (nh + 1);
407 vh->vlan_tci = rte_cpu_to_be_16((*m)->vlan_tci);
409 (*m)->ol_flags &= ~(PKT_RX_VLAN_STRIPPED | PKT_TX_VLAN);
411 if ((*m)->ol_flags & PKT_TX_TUNNEL_MASK)
412 (*m)->outer_l2_len += sizeof(struct rte_vlan_hdr);
414 (*m)->l2_len += sizeof(struct rte_vlan_hdr);
423 #endif /* _RTE_ETHER_H_ */