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 */
rte_is_same_ether_addr(const struct rte_ether_addr * ea1,const struct rte_ether_addr * ea2)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 */
rte_is_zero_ether_addr(const struct rte_ether_addr * ea)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 */
rte_is_unicast_ether_addr(const struct rte_ether_addr * ea)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 */
rte_is_multicast_ether_addr(const struct rte_ether_addr * ea)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 */
rte_is_broadcast_ether_addr(const struct rte_ether_addr * ea)151 static inline int rte_is_broadcast_ether_addr(const struct rte_ether_addr *ea)
152 {
153 const uint16_t *w = (const uint16_t *)ea;
154
155 return (w[0] & w[1] & w[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 */
rte_is_universal_ether_addr(const struct rte_ether_addr * ea)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 */
rte_is_local_admin_ether_addr(const struct rte_ether_addr * ea)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 */
rte_is_valid_assigned_ether_addr(const struct rte_ether_addr * ea)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 void
211 rte_eth_random_addr(uint8_t *addr);
212
213 /**
214 * Copy an Ethernet address.
215 *
216 * @param ea_from
217 * A pointer to a ether_addr structure holding the Ethernet address to copy.
218 * @param ea_to
219 * A pointer to a ether_addr structure where to copy the Ethernet address.
220 */
221 static inline void
rte_ether_addr_copy(const struct rte_ether_addr * __restrict ea_from,struct rte_ether_addr * __restrict ea_to)222 rte_ether_addr_copy(const struct rte_ether_addr *__restrict ea_from,
223 struct rte_ether_addr *__restrict ea_to)
224 {
225 *ea_to = *ea_from;
226 }
227
228 #define RTE_ETHER_ADDR_FMT_SIZE 18
229 /**
230 * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
231 *
232 * @param buf
233 * A pointer to buffer contains the formatted MAC address.
234 * @param size
235 * The format buffer size.
236 * @param eth_addr
237 * A pointer to a ether_addr structure.
238 */
239 void
240 rte_ether_format_addr(char *buf, uint16_t size,
241 const struct rte_ether_addr *eth_addr);
242 /**
243 * Convert string with Ethernet address to an ether_addr.
244 *
245 * @param str
246 * A pointer to buffer contains the formatted MAC address.
247 * The supported formats are:
248 * XX:XX:XX:XX:XX:XX or XXXX:XXXX:XXXX
249 * where XX is a hex digit: 0-9, a-f, or A-F.
250 * @param eth_addr
251 * A pointer to a ether_addr structure.
252 * @return
253 * 0 if successful
254 * -1 and sets rte_errno if invalid string
255 */
256 __rte_experimental
257 int
258 rte_ether_unformat_addr(const char *str, struct rte_ether_addr *eth_addr);
259
260 /**
261 * Ethernet header: Contains the destination address, source address
262 * and frame type.
263 */
264 struct rte_ether_hdr {
265 struct rte_ether_addr d_addr; /**< Destination address. */
266 struct rte_ether_addr s_addr; /**< Source address. */
267 uint16_t ether_type; /**< Frame type. */
268 } __rte_aligned(2);
269
270 /**
271 * Ethernet VLAN Header.
272 * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
273 * of the encapsulated frame.
274 */
275 struct rte_vlan_hdr {
276 uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
277 uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
278 } __rte_packed;
279
280
281
282 /* Ethernet frame types */
283 #define RTE_ETHER_TYPE_IPV4 0x0800 /**< IPv4 Protocol. */
284 #define RTE_ETHER_TYPE_IPV6 0x86DD /**< IPv6 Protocol. */
285 #define RTE_ETHER_TYPE_ARP 0x0806 /**< Arp Protocol. */
286 #define RTE_ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
287 #define RTE_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
288 #define RTE_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
289 #define RTE_ETHER_TYPE_QINQ1 0x9100 /**< Deprecated QinQ VLAN. */
290 #define RTE_ETHER_TYPE_QINQ2 0x9200 /**< Deprecated QinQ VLAN. */
291 #define RTE_ETHER_TYPE_QINQ3 0x9300 /**< Deprecated QinQ VLAN. */
292 #define RTE_ETHER_TYPE_PPPOE_DISCOVERY 0x8863 /**< PPPoE Discovery Stage. */
293 #define RTE_ETHER_TYPE_PPPOE_SESSION 0x8864 /**< PPPoE Session Stage. */
294 #define RTE_ETHER_TYPE_ETAG 0x893F /**< IEEE 802.1BR E-Tag. */
295 #define RTE_ETHER_TYPE_1588 0x88F7
296 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
297 #define RTE_ETHER_TYPE_SLOW 0x8809 /**< Slow protocols (LACP and Marker). */
298 #define RTE_ETHER_TYPE_TEB 0x6558 /**< Transparent Ethernet Bridging. */
299 #define RTE_ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
300 #define RTE_ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
301 #define RTE_ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
302 #define RTE_ETHER_TYPE_ECPRI 0xAEFE /**< eCPRI ethertype (.1Q supported). */
303
304 /**
305 * Extract VLAN tag information into mbuf
306 *
307 * Software version of VLAN stripping
308 *
309 * @param m
310 * The packet mbuf.
311 * @return
312 * - 0: Success
313 * - 1: not a vlan packet
314 */
rte_vlan_strip(struct rte_mbuf * m)315 static inline int rte_vlan_strip(struct rte_mbuf *m)
316 {
317 struct rte_ether_hdr *eh
318 = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
319 struct rte_vlan_hdr *vh;
320
321 if (eh->ether_type != rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN))
322 return -1;
323
324 vh = (struct rte_vlan_hdr *)(eh + 1);
325 m->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
326 m->vlan_tci = rte_be_to_cpu_16(vh->vlan_tci);
327
328 /* Copy ether header over rather than moving whole packet */
329 memmove(rte_pktmbuf_adj(m, sizeof(struct rte_vlan_hdr)),
330 eh, 2 * RTE_ETHER_ADDR_LEN);
331
332 return 0;
333 }
334
335 /**
336 * Insert VLAN tag into mbuf.
337 *
338 * Software version of VLAN unstripping
339 *
340 * @param m
341 * The packet mbuf.
342 * @return
343 * - 0: On success
344 * -EPERM: mbuf is is shared overwriting would be unsafe
345 * -ENOSPC: not enough headroom in mbuf
346 */
rte_vlan_insert(struct rte_mbuf ** m)347 static inline int rte_vlan_insert(struct rte_mbuf **m)
348 {
349 struct rte_ether_hdr *oh, *nh;
350 struct rte_vlan_hdr *vh;
351
352 /* Can't insert header if mbuf is shared */
353 if (!RTE_MBUF_DIRECT(*m) || rte_mbuf_refcnt_read(*m) > 1)
354 return -EINVAL;
355
356 /* Can't insert header if the first segment is too short */
357 if (rte_pktmbuf_data_len(*m) < 2 * RTE_ETHER_ADDR_LEN)
358 return -EINVAL;
359
360 oh = rte_pktmbuf_mtod(*m, struct rte_ether_hdr *);
361 nh = (struct rte_ether_hdr *)
362 rte_pktmbuf_prepend(*m, sizeof(struct rte_vlan_hdr));
363 if (nh == NULL)
364 return -ENOSPC;
365
366 memmove(nh, oh, 2 * RTE_ETHER_ADDR_LEN);
367 nh->ether_type = rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN);
368
369 vh = (struct rte_vlan_hdr *) (nh + 1);
370 vh->vlan_tci = rte_cpu_to_be_16((*m)->vlan_tci);
371
372 (*m)->ol_flags &= ~(PKT_RX_VLAN_STRIPPED | PKT_TX_VLAN);
373
374 if ((*m)->ol_flags & PKT_TX_TUNNEL_MASK)
375 (*m)->outer_l2_len += sizeof(struct rte_vlan_hdr);
376 else
377 (*m)->l2_len += sizeof(struct rte_vlan_hdr);
378
379 return 0;
380 }
381
382 #ifdef __cplusplus
383 }
384 #endif
385
386 #endif /* _RTE_ETHER_H_ */
387