net/ixgbe: fix statistics in flow control mode
[dpdk.git] / 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 } __rte_aligned(2);
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         const uint16_t *w1 = (const uint16_t *)ea1;
85         const uint16_t *w2 = (const uint16_t *)ea2;
86
87         return ((w1[0] ^ w2[0]) | (w1[1] ^ w2[1]) | (w1[2] ^ w2[2])) == 0;
88 }
89
90 /**
91  * Check if an Ethernet address is filled with zeros.
92  *
93  * @param ea
94  *   A pointer to a ether_addr structure containing the ethernet address
95  *   to check.
96  * @return
97  *   True  (1) if the given ethernet address is filled with zeros;
98  *   false (0) otherwise.
99  */
100 static inline int rte_is_zero_ether_addr(const struct rte_ether_addr *ea)
101 {
102         const uint16_t *w = (const uint16_t *)ea;
103
104         return (w[0] | w[1] | w[2]) == 0;
105 }
106
107 /**
108  * Check if an Ethernet address is a unicast address.
109  *
110  * @param ea
111  *   A pointer to a ether_addr structure containing the ethernet address
112  *   to check.
113  * @return
114  *   True  (1) if the given ethernet address is a unicast address;
115  *   false (0) otherwise.
116  */
117 static inline int rte_is_unicast_ether_addr(const struct rte_ether_addr *ea)
118 {
119         return (ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR) == 0;
120 }
121
122 /**
123  * Check if an Ethernet address is a multicast address.
124  *
125  * @param ea
126  *   A pointer to a ether_addr structure containing the ethernet address
127  *   to check.
128  * @return
129  *   True  (1) if the given ethernet address is a multicast address;
130  *   false (0) otherwise.
131  */
132 static inline int rte_is_multicast_ether_addr(const struct rte_ether_addr *ea)
133 {
134         return ea->addr_bytes[0] & RTE_ETHER_GROUP_ADDR;
135 }
136
137 /**
138  * Check if an Ethernet address is a broadcast address.
139  *
140  * @param ea
141  *   A pointer to a ether_addr structure containing the ethernet address
142  *   to check.
143  * @return
144  *   True  (1) if the given ethernet address is a broadcast address;
145  *   false (0) otherwise.
146  */
147 static inline int rte_is_broadcast_ether_addr(const struct rte_ether_addr *ea)
148 {
149         const uint16_t *ea_words = (const uint16_t *)ea;
150
151         return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
152                 ea_words[2] == 0xFFFF);
153 }
154
155 /**
156  * Check if an Ethernet address is a universally assigned address.
157  *
158  * @param ea
159  *   A pointer to a ether_addr structure containing the ethernet address
160  *   to check.
161  * @return
162  *   True  (1) if the given ethernet address is a universally assigned address;
163  *   false (0) otherwise.
164  */
165 static inline int rte_is_universal_ether_addr(const struct rte_ether_addr *ea)
166 {
167         return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) == 0;
168 }
169
170 /**
171  * Check if an Ethernet address is a locally assigned address.
172  *
173  * @param ea
174  *   A pointer to a ether_addr structure containing the ethernet address
175  *   to check.
176  * @return
177  *   True  (1) if the given ethernet address is a locally assigned address;
178  *   false (0) otherwise.
179  */
180 static inline int rte_is_local_admin_ether_addr(const struct rte_ether_addr *ea)
181 {
182         return (ea->addr_bytes[0] & RTE_ETHER_LOCAL_ADMIN_ADDR) != 0;
183 }
184
185 /**
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.
188  *
189  * @param ea
190  *   A pointer to a ether_addr structure containing the ethernet address
191  *   to check.
192  * @return
193  *   True  (1) if the given ethernet address is valid;
194  *   false (0) otherwise.
195  */
196 static inline int rte_is_valid_assigned_ether_addr(const struct rte_ether_addr *ea)
197 {
198         return rte_is_unicast_ether_addr(ea) && (!rte_is_zero_ether_addr(ea));
199 }
200
201 /**
202  * Generate a random Ethernet address that is locally administered
203  * and not multicast.
204  * @param addr
205  *   A pointer to Ethernet address.
206  */
207 void
208 rte_eth_random_addr(uint8_t *addr);
209
210 /**
211  * Fast copy an Ethernet address.
212  *
213  * @param ea_from
214  *   A pointer to a ether_addr structure holding the Ethernet address to copy.
215  * @param ea_to
216  *   A pointer to a ether_addr structure where to copy the Ethernet address.
217  */
218 static inline void rte_ether_addr_copy(const struct rte_ether_addr *ea_from,
219                                    struct rte_ether_addr *ea_to)
220 {
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);
224
225         to_words[0] = from_words[0];
226         to_words[1] = from_words[1];
227         to_words[2] = from_words[2];
228 #else
229         /*
230          * Use the common way, because of a strange gcc warning.
231          */
232         *ea_to = *ea_from;
233 #endif
234 }
235
236 #define RTE_ETHER_ADDR_FMT_SIZE         18
237 /**
238  * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
239  *
240  * @param buf
241  *   A pointer to buffer contains the formatted MAC address.
242  * @param size
243  *   The format buffer size.
244  * @param eth_addr
245  *   A pointer to a ether_addr structure.
246  */
247 void
248 rte_ether_format_addr(char *buf, uint16_t size,
249                       const struct rte_ether_addr *eth_addr);
250 /**
251  * Convert string with Ethernet address to an ether_addr.
252  *
253  * @param str
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.
258  * @param eth_addr
259  *   A pointer to a ether_addr structure.
260  * @return
261  *   0 if successful
262  *   -1 and sets rte_errno if invalid string
263  */
264 __rte_experimental
265 int
266 rte_ether_unformat_addr(const char *str, struct rte_ether_addr *eth_addr);
267
268 /**
269  * Ethernet header: Contains the destination address, source address
270  * and frame type.
271  */
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 } __rte_aligned(2);
277
278 /**
279  * Ethernet VLAN Header.
280  * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
281  * of the encapsulated frame.
282  */
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 } __rte_packed;
287
288
289
290 /* Ethernet frame types */
291 #define RTE_ETHER_TYPE_IPV4 0x0800 /**< IPv4 Protocol. */
292 #define RTE_ETHER_TYPE_IPV6 0x86DD /**< IPv6 Protocol. */
293 #define RTE_ETHER_TYPE_ARP  0x0806 /**< Arp Protocol. */
294 #define RTE_ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
295 #define RTE_ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
296 #define RTE_ETHER_TYPE_QINQ 0x88A8 /**< IEEE 802.1ad QinQ tagging. */
297 #define RTE_ETHER_TYPE_PPPOE_DISCOVERY 0x8863 /**< PPPoE Discovery Stage. */
298 #define RTE_ETHER_TYPE_PPPOE_SESSION 0x8864 /**< PPPoE Session Stage. */
299 #define RTE_ETHER_TYPE_ETAG 0x893F /**< IEEE 802.1BR E-Tag. */
300 #define RTE_ETHER_TYPE_1588 0x88F7
301         /**< IEEE 802.1AS 1588 Precise Time Protocol. */
302 #define RTE_ETHER_TYPE_SLOW 0x8809 /**< Slow protocols (LACP and Marker). */
303 #define RTE_ETHER_TYPE_TEB  0x6558 /**< Transparent Ethernet Bridging. */
304 #define RTE_ETHER_TYPE_LLDP 0x88CC /**< LLDP Protocol. */
305 #define RTE_ETHER_TYPE_MPLS 0x8847 /**< MPLS ethertype. */
306 #define RTE_ETHER_TYPE_MPLSM 0x8848 /**< MPLS multicast ethertype. */
307
308 /**
309  * Extract VLAN tag information into mbuf
310  *
311  * Software version of VLAN stripping
312  *
313  * @param m
314  *   The packet mbuf.
315  * @return
316  *   - 0: Success
317  *   - 1: not a vlan packet
318  */
319 static inline int rte_vlan_strip(struct rte_mbuf *m)
320 {
321         struct rte_ether_hdr *eh
322                  = rte_pktmbuf_mtod(m, struct rte_ether_hdr *);
323         struct rte_vlan_hdr *vh;
324
325         if (eh->ether_type != rte_cpu_to_be_16(RTE_ETHER_TYPE_VLAN))
326                 return -1;
327
328         vh = (struct rte_vlan_hdr *)(eh + 1);
329         m->ol_flags |= PKT_RX_VLAN | PKT_RX_VLAN_STRIPPED;
330         m->vlan_tci = rte_be_to_cpu_16(vh->vlan_tci);
331
332         /* Copy ether header over rather than moving whole packet */
333         memmove(rte_pktmbuf_adj(m, sizeof(struct rte_vlan_hdr)),
334                 eh, 2 * RTE_ETHER_ADDR_LEN);
335
336         return 0;
337 }
338
339 /**
340  * Insert VLAN tag into mbuf.
341  *
342  * Software version of VLAN unstripping
343  *
344  * @param m
345  *   The packet mbuf.
346  * @return
347  *   - 0: On success
348  *   -EPERM: mbuf is is shared overwriting would be unsafe
349  *   -ENOSPC: not enough headroom in mbuf
350  */
351 static inline int rte_vlan_insert(struct rte_mbuf **m)
352 {
353         struct rte_ether_hdr *oh, *nh;
354         struct rte_vlan_hdr *vh;
355
356         /* Can't insert header if mbuf is shared */
357         if (!RTE_MBUF_DIRECT(*m) || rte_mbuf_refcnt_read(*m) > 1)
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_ */