4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Ethernet Helpers in RTE
49 #include <rte_memcpy.h>
50 #include <rte_random.h>
52 #define ETHER_ADDR_LEN 6 /**< Length of Ethernet address. */
53 #define ETHER_TYPE_LEN 2 /**< Length of Ethernet type field. */
54 #define ETHER_CRC_LEN 4 /**< Length of Ethernet CRC. */
55 #define ETHER_HDR_LEN \
56 (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) /**< Length of Ethernet header. */
57 #define ETHER_MIN_LEN 64 /**< Minimum frame len, including CRC. */
58 #define ETHER_MAX_LEN 1518 /**< Maximum frame len, including CRC. */
60 (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
62 #define ETHER_MAX_VLAN_FRAME_LEN \
63 (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
65 #define ETHER_MAX_JUMBO_FRAME_LEN \
66 0x3F00 /**< Maximum Jumbo frame length, including CRC. */
68 #define ETHER_MAX_VLAN_ID 4095 /**< Maximum VLAN ID. */
70 #define ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
74 * A universally administered address is uniquely assigned to a device by its
75 * manufacturer. The first three octets (in transmission order) contain the
76 * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
77 * EUI-48) octets are assigned by that organization with the only constraint
79 * A locally administered address is assigned to a device by a network
80 * administrator and does not contain OUIs.
81 * See http://standards.ieee.org/regauth/groupmac/tutorial.html
84 uint8_t addr_bytes[ETHER_ADDR_LEN]; /**< Address bytes in transmission order */
85 } __attribute__((__packed__));
87 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
88 #define ETHER_GROUP_ADDR 0x01 /**< Multicast or broadcast Eth. address. */
91 * Check if two Ethernet addresses are the same.
94 * A pointer to the first ether_addr structure containing
95 * the ethernet address.
97 * A pointer to the second ether_addr structure containing
98 * the ethernet address.
101 * True (1) if the given two ethernet address are the same;
102 * False (0) otherwise.
104 static inline int is_same_ether_addr(const struct ether_addr *ea1,
105 const struct ether_addr *ea2)
108 for (i = 0; i < ETHER_ADDR_LEN; i++)
109 if (ea1->addr_bytes[i] != ea2->addr_bytes[i])
115 * Check if an Ethernet address is filled with zeros.
118 * A pointer to a ether_addr structure containing the ethernet address
121 * True (1) if the given ethernet address is filled with zeros;
122 * false (0) otherwise.
124 static inline int is_zero_ether_addr(const struct ether_addr *ea)
127 for (i = 0; i < ETHER_ADDR_LEN; i++)
128 if (ea->addr_bytes[i] != 0x00)
134 * Check if an Ethernet address is a unicast address.
137 * A pointer to a ether_addr structure containing the ethernet address
140 * True (1) if the given ethernet address is a unicast address;
141 * false (0) otherwise.
143 static inline int is_unicast_ether_addr(const struct ether_addr *ea)
145 return ((ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0);
149 * Check if an Ethernet address is a multicast address.
152 * A pointer to a ether_addr structure containing the ethernet address
155 * True (1) if the given ethernet address is a multicast address;
156 * false (0) otherwise.
158 static inline int is_multicast_ether_addr(const struct ether_addr *ea)
160 return (ea->addr_bytes[0] & ETHER_GROUP_ADDR);
164 * Check if an Ethernet address is a broadcast address.
167 * A pointer to a ether_addr structure containing the ethernet address
170 * True (1) if the given ethernet address is a broadcast address;
171 * false (0) otherwise.
173 static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
175 const uint16_t *ea_words = (const uint16_t *)ea;
177 return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
178 ea_words[2] == 0xFFFF);
182 * Check if an Ethernet address is a universally assigned address.
185 * A pointer to a ether_addr structure containing the ethernet address
188 * True (1) if the given ethernet address is a universally assigned address;
189 * false (0) otherwise.
191 static inline int is_universal_ether_addr(const struct ether_addr *ea)
193 return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0);
197 * Check if an Ethernet address is a locally assigned address.
200 * A pointer to a ether_addr structure containing the ethernet address
203 * True (1) if the given ethernet address is a locally assigned address;
204 * false (0) otherwise.
206 static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
208 return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 1);
212 * Check if an Ethernet address is a valid address. Checks that the address is a
213 * unicast address and is not filled with zeros.
216 * A pointer to a ether_addr structure containing the ethernet address
219 * True (1) if the given ethernet address is valid;
220 * false (0) otherwise.
222 static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
224 return (is_unicast_ether_addr(ea) && (! is_zero_ether_addr(ea)));
228 * Generate a random Ethernet address that is locally administered
231 * A pointer to Ethernet address.
233 static inline void eth_random_addr(uint8_t *addr)
235 uint64_t rand = rte_rand();
236 uint8_t *p = (uint8_t*)&rand;
238 rte_memcpy(addr, p, ETHER_ADDR_LEN);
239 addr[0] &= ~ETHER_GROUP_ADDR; /* clear multicast bit */
240 addr[0] |= ETHER_LOCAL_ADMIN_ADDR; /* set local assignment bit */
244 * Fast copy an Ethernet address.
247 * A pointer to a ether_addr structure holding the Ethernet address to copy.
249 * A pointer to a ether_addr structure where to copy the Ethernet address.
251 static inline void ether_addr_copy(const struct ether_addr *ea_from,
252 struct ether_addr *ea_to)
254 #ifdef __INTEL_COMPILER
255 uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
256 uint16_t *to_words = (uint16_t *)(ea_to->addr_bytes);
258 to_words[0] = from_words[0];
259 to_words[1] = from_words[1];
260 to_words[2] = from_words[2];
263 * Use the common way, because of a strange gcc warning.
270 * Ethernet header: Contains the destination address, source address
274 struct ether_addr d_addr; /**< Destination address. */
275 struct ether_addr s_addr; /**< Source address. */
276 uint16_t ether_type; /**< Frame type. */
277 } __attribute__((__packed__));
280 * Ethernet VLAN Header.
281 * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
282 * of the encapsulated frame.
285 uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
286 uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
287 } __attribute__((__packed__));
289 /* Ethernet frame types */
290 #define ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
291 #define ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
292 #define ETHER_TYPE_ARP 0x0806 /**< Arp Protocol. */
293 #define ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
294 #define ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
295 #define ETHER_TYPE_1588 0x88F7 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
301 #endif /* _RTE_ETHER_H_ */