]>
git.proxmox.com Git - ceph.git/blob - ceph/src/spdk/dpdk/lib/librte_net/rte_ether.h
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 ETHER_ADDR_LEN 6 /**< Length of Ethernet address. */
27 #define ETHER_TYPE_LEN 2 /**< Length of Ethernet type field. */
28 #define ETHER_CRC_LEN 4 /**< Length of Ethernet CRC. */
29 #define ETHER_HDR_LEN \
30 (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) /**< Length of Ethernet header. */
31 #define ETHER_MIN_LEN 64 /**< Minimum frame len, including CRC. */
32 #define ETHER_MAX_LEN 1518 /**< Maximum frame len, including CRC. */
34 (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
36 #define ETHER_MAX_VLAN_FRAME_LEN \
37 (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
39 #define ETHER_MAX_JUMBO_FRAME_LEN \
40 0x3F00 /**< Maximum Jumbo frame length, including CRC. */
42 #define ETHER_MAX_VLAN_ID 4095 /**< Maximum VLAN ID. */
44 #define ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
48 * A universally administered address is uniquely assigned to a device by its
49 * manufacturer. The first three octets (in transmission order) contain the
50 * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
51 * EUI-48) octets are assigned by that organization with the only constraint
53 * A locally administered address is assigned to a device by a network
54 * administrator and does not contain OUIs.
55 * See http://standards.ieee.org/regauth/groupmac/tutorial.html
58 uint8_t addr_bytes
[ETHER_ADDR_LEN
]; /**< Addr bytes in tx order */
59 } __attribute__((__packed__
));
61 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
62 #define ETHER_GROUP_ADDR 0x01 /**< Multicast or broadcast Eth. address. */
65 * Check if two Ethernet addresses are the same.
68 * A pointer to the first ether_addr structure containing
69 * the ethernet address.
71 * A pointer to the second ether_addr structure containing
72 * the ethernet address.
75 * True (1) if the given two ethernet address are the same;
76 * False (0) otherwise.
78 static inline int is_same_ether_addr(const struct ether_addr
*ea1
,
79 const struct ether_addr
*ea2
)
82 for (i
= 0; i
< ETHER_ADDR_LEN
; i
++)
83 if (ea1
->addr_bytes
[i
] != ea2
->addr_bytes
[i
])
89 * Check if an Ethernet address is filled with zeros.
92 * A pointer to a ether_addr structure containing the ethernet address
95 * True (1) if the given ethernet address is filled with zeros;
96 * false (0) otherwise.
98 static inline int is_zero_ether_addr(const struct ether_addr
*ea
)
101 for (i
= 0; i
< ETHER_ADDR_LEN
; i
++)
102 if (ea
->addr_bytes
[i
] != 0x00)
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 is_unicast_ether_addr(const struct ether_addr
*ea
)
119 return (ea
->addr_bytes
[0] & 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 is_multicast_ether_addr(const struct ether_addr
*ea
)
134 return ea
->addr_bytes
[0] & 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 is_broadcast_ether_addr(const struct 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 is_universal_ether_addr(const struct ether_addr
*ea
)
167 return (ea
->addr_bytes
[0] & 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 is_local_admin_ether_addr(const struct ether_addr
*ea
)
182 return (ea
->addr_bytes
[0] & 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 is_valid_assigned_ether_addr(const struct ether_addr
*ea
)
198 return is_unicast_ether_addr(ea
) && (!is_zero_ether_addr(ea
));
202 * Generate a random Ethernet address that is locally administered
205 * A pointer to Ethernet address.
207 static inline void eth_random_addr(uint8_t *addr
)
209 uint64_t rand
= rte_rand();
210 uint8_t *p
= (uint8_t *)&rand
;
212 rte_memcpy(addr
, p
, ETHER_ADDR_LEN
);
213 addr
[0] &= (uint8_t)~ETHER_GROUP_ADDR
; /* clear multicast bit */
214 addr
[0] |= ETHER_LOCAL_ADMIN_ADDR
; /* set local assignment bit */
218 * Fast copy an Ethernet address.
221 * A pointer to a ether_addr structure holding the Ethernet address to copy.
223 * A pointer to a ether_addr structure where to copy the Ethernet address.
225 static inline void ether_addr_copy(const struct ether_addr
*ea_from
,
226 struct ether_addr
*ea_to
)
228 #ifdef __INTEL_COMPILER
229 uint16_t *from_words
= (uint16_t *)(ea_from
->addr_bytes
);
230 uint16_t *to_words
= (uint16_t *)(ea_to
->addr_bytes
);
232 to_words
[0] = from_words
[0];
233 to_words
[1] = from_words
[1];
234 to_words
[2] = from_words
[2];
237 * Use the common way, because of a strange gcc warning.
243 #define ETHER_ADDR_FMT_SIZE 18
245 * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
248 * A pointer to buffer contains the formatted MAC address.
250 * The format buffer size.
252 * A pointer to a ether_addr structure.
255 ether_format_addr(char *buf
, uint16_t size
,
256 const struct ether_addr
*eth_addr
)
258 snprintf(buf
, size
, "%02X:%02X:%02X:%02X:%02X:%02X",
259 eth_addr
->addr_bytes
[0],
260 eth_addr
->addr_bytes
[1],
261 eth_addr
->addr_bytes
[2],
262 eth_addr
->addr_bytes
[3],
263 eth_addr
->addr_bytes
[4],
264 eth_addr
->addr_bytes
[5]);
268 * Ethernet header: Contains the destination address, source address
272 struct ether_addr d_addr
; /**< Destination address. */
273 struct ether_addr s_addr
; /**< Source address. */
274 uint16_t ether_type
; /**< Frame type. */
275 } __attribute__((__packed__
));
278 * Ethernet VLAN Header.
279 * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
280 * of the encapsulated frame.
283 uint16_t vlan_tci
; /**< Priority (3) + CFI (1) + Identifier Code (12) */
284 uint16_t eth_proto
;/**< Ethernet type of encapsulated frame. */
285 } __attribute__((__packed__
));
288 * VXLAN protocol header.
289 * Contains the 8-bit flag, 24-bit VXLAN Network Identifier and
290 * Reserved fields (24 bits and 8 bits)
293 uint32_t vx_flags
; /**< flag (8) + Reserved (24). */
294 uint32_t vx_vni
; /**< VNI (24) + Reserved (8). */
295 } __attribute__((__packed__
));
297 /* Ethernet frame types */
298 #define ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
299 #define ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
300 #define ETHER_TYPE_ARP 0x0806 /**< Arp Protocol. */
301 #define ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
302 #define ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
303 #define ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
304 #define ETHER_TYPE_PPPOE_DISCOVERY 0x8863 /**< PPPoE Discovery Stage. */
305 #define ETHER_TYPE_PPPOE_SESSION 0x8864 /**< PPPoE Session Stage. */
306 #define ETHER_TYPE_ETAG 0x893F /**< IEEE 802.1BR E-Tag. */
307 #define ETHER_TYPE_1588 0x88F7 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
308 #define ETHER_TYPE_SLOW 0x8809 /**< Slow protocols (LACP and Marker). */
309 #define ETHER_TYPE_TEB 0x6558 /**< Transparent Ethernet Bridging. */
310 #define ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
311 #define ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
312 #define ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
314 #define ETHER_VXLAN_HLEN (sizeof(struct udp_hdr) + sizeof(struct vxlan_hdr))
315 /**< VXLAN tunnel header length. */
318 * VXLAN-GPE protocol header (draft-ietf-nvo3-vxlan-gpe-05).
319 * Contains the 8-bit flag, 8-bit next-protocol, 24-bit VXLAN Network
320 * Identifier and Reserved fields (16 bits and 8 bits).
322 struct vxlan_gpe_hdr
{
323 uint8_t vx_flags
; /**< flag (8). */
324 uint8_t reserved
[2]; /**< Reserved (16). */
325 uint8_t proto
; /**< next-protocol (8). */
326 uint32_t vx_vni
; /**< VNI (24) + Reserved (8). */
327 } __attribute__((__packed__
));
329 /* VXLAN-GPE next protocol types */
330 #define VXLAN_GPE_TYPE_IPV4 1 /**< IPv4 Protocol. */
331 #define VXLAN_GPE_TYPE_IPV6 2 /**< IPv6 Protocol. */
332 #define VXLAN_GPE_TYPE_ETH 3 /**< Ethernet Protocol. */
333 #define VXLAN_GPE_TYPE_NSH 4 /**< NSH Protocol. */
334 #define VXLAN_GPE_TYPE_MPLS 5 /**< MPLS Protocol. */
335 #define VXLAN_GPE_TYPE_GBP 6 /**< GBP Protocol. */
336 #define VXLAN_GPE_TYPE_VBNG 7 /**< vBNG Protocol. */
338 #define ETHER_VXLAN_GPE_HLEN (sizeof(struct udp_hdr) + \
339 sizeof(struct vxlan_gpe_hdr))
340 /**< VXLAN-GPE tunnel header length. */
343 * Extract VLAN tag information into mbuf
345 * Software version of VLAN stripping
351 * - 1: not a vlan packet
353 static inline int rte_vlan_strip(struct rte_mbuf
*m
)
356 = rte_pktmbuf_mtod(m
, struct ether_hdr
*);
359 if (eh
->ether_type
!= rte_cpu_to_be_16(ETHER_TYPE_VLAN
))
362 vh
= (struct vlan_hdr
*)(eh
+ 1);
363 m
->ol_flags
|= PKT_RX_VLAN
| PKT_RX_VLAN_STRIPPED
;
364 m
->vlan_tci
= rte_be_to_cpu_16(vh
->vlan_tci
);
366 /* Copy ether header over rather than moving whole packet */
367 memmove(rte_pktmbuf_adj(m
, sizeof(struct vlan_hdr
)),
368 eh
, 2 * ETHER_ADDR_LEN
);
374 * Insert VLAN tag into mbuf.
376 * Software version of VLAN unstripping
382 * -EPERM: mbuf is is shared overwriting would be unsafe
383 * -ENOSPC: not enough headroom in mbuf
385 static inline int rte_vlan_insert(struct rte_mbuf
**m
)
387 struct ether_hdr
*oh
, *nh
;
390 /* Can't insert header if mbuf is shared */
391 if (rte_mbuf_refcnt_read(*m
) > 1) {
392 struct rte_mbuf
*copy
;
394 copy
= rte_pktmbuf_clone(*m
, (*m
)->pool
);
395 if (unlikely(copy
== NULL
))
397 rte_pktmbuf_free(*m
);
401 oh
= rte_pktmbuf_mtod(*m
, struct ether_hdr
*);
402 nh
= (struct ether_hdr
*)
403 rte_pktmbuf_prepend(*m
, sizeof(struct vlan_hdr
));
407 memmove(nh
, oh
, 2 * ETHER_ADDR_LEN
);
408 nh
->ether_type
= rte_cpu_to_be_16(ETHER_TYPE_VLAN
);
410 vh
= (struct vlan_hdr
*) (nh
+ 1);
411 vh
->vlan_tci
= rte_cpu_to_be_16((*m
)->vlan_tci
);
413 (*m
)->ol_flags
&= ~(PKT_RX_VLAN_STRIPPED
| PKT_TX_VLAN
);
422 #endif /* _RTE_ETHER_H_ */