lib/librte_ether/rte_ether.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #ifndef _RTE_ETHER_H_
  35 #define _RTE_ETHER_H_
  36
  37 /**
  38  * @file
  39  *
  40  * Ethernet Helpers in RTE
  41  */
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #include <stdint.h>
  48 #include <stdio.h>
  49
  50 #include <rte_memcpy.h>
  51 #include <rte_random.h>
  52
  53 #define ETHER_ADDR_LEN  6 /**< Length of Ethernet address. */
  54 #define ETHER_TYPE_LEN  2 /**< Length of Ethernet type field. */
  55 #define ETHER_CRC_LEN   4 /**< Length of Ethernet CRC. */
  56 #define ETHER_HDR_LEN   \
  57         (ETHER_ADDR_LEN * 2 + ETHER_TYPE_LEN) /**< Length of Ethernet header. */
  58 #define ETHER_MIN_LEN   64    /**< Minimum frame len, including CRC. */
  59 #define ETHER_MAX_LEN   1518  /**< Maximum frame len, including CRC. */
  60 #define ETHER_MTU       \
  61         (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
  62
  63 #define ETHER_MAX_VLAN_FRAME_LEN \
  64         (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
  65
  66 #define ETHER_MAX_JUMBO_FRAME_LEN \
  67         0x3F00 /**< Maximum Jumbo frame length, including CRC. */
  68
  69 #define ETHER_MAX_VLAN_ID  4095 /**< Maximum VLAN ID. */
  70
  71 #define ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
  72
  73 /**
  74  * Ethernet address:
  75  * A universally administered address is uniquely assigned to a device by its
  76  * manufacturer. The first three octets (in transmission order) contain the
  77  * Organizationally Unique Identifier (OUI). The following three (MAC-48 and
  78  * EUI-48) octets are assigned by that organization with the only constraint
  79  * of uniqueness.
  80  * A locally administered address is assigned to a device by a network
  81  * administrator and does not contain OUIs.
  82  * See http://standards.ieee.org/regauth/groupmac/tutorial.html
  83  */
  84 struct ether_addr {
  85         uint8_t addr_bytes[ETHER_ADDR_LEN]; /**< Address bytes in transmission order */
  86 } __attribute__((__packed__));
  87
  88 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
  89 #define ETHER_GROUP_ADDR       0x01 /**< Multicast or broadcast Eth. address. */
  90
  91 /**
  92  * Check if two Ethernet addresses are the same.
  93  *
  94  * @param ea1
  95  *  A pointer to the first ether_addr structure containing
  96  *  the ethernet address.
  97  * @param ea2
  98  *  A pointer to the second ether_addr structure containing
  99  *  the ethernet address.
 100  *
 101  * @return
 102  *  True  (1) if the given two ethernet address are the same;
 103  *  False (0) otherwise.
 104  */
 105 static inline int is_same_ether_addr(const struct ether_addr *ea1,
 106                                      const struct ether_addr *ea2)
 107 {
 108         int i;
 109         for (i = 0; i < ETHER_ADDR_LEN; i++)
 110                 if (ea1->addr_bytes[i] != ea2->addr_bytes[i])
 111                         return 0;
 112         return 1;
 113 }
 114
 115 /**
 116  * Check if an Ethernet address is filled with zeros.
 117  *
 118  * @param ea
 119  *   A pointer to a ether_addr structure containing the ethernet address
 120  *   to check.
 121  * @return
 122  *   True  (1) if the given ethernet address is filled with zeros;
 123  *   false (0) otherwise.
 124  */
 125 static inline int is_zero_ether_addr(const struct ether_addr *ea)
 126 {
 127         int i;
 128         for (i = 0; i < ETHER_ADDR_LEN; i++)
 129                 if (ea->addr_bytes[i] != 0x00)
 130                         return 0;
 131         return 1;
 132 }
 133
 134 /**
 135  * Check if an Ethernet address is a unicast address.
 136  *
 137  * @param ea
 138  *   A pointer to a ether_addr structure containing the ethernet address
 139  *   to check.
 140  * @return
 141  *   True  (1) if the given ethernet address is a unicast address;
 142  *   false (0) otherwise.
 143  */
 144 static inline int is_unicast_ether_addr(const struct ether_addr *ea)
 145 {
 146         return ((ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0);
 147 }
 148
 149 /**
 150  * Check if an Ethernet address is a multicast address.
 151  *
 152  * @param ea
 153  *   A pointer to a ether_addr structure containing the ethernet address
 154  *   to check.
 155  * @return
 156  *   True  (1) if the given ethernet address is a multicast address;
 157  *   false (0) otherwise.
 158  */
 159 static inline int is_multicast_ether_addr(const struct ether_addr *ea)
 160 {
 161         return (ea->addr_bytes[0] & ETHER_GROUP_ADDR);
 162 }
 163
 164 /**
 165  * Check if an Ethernet address is a broadcast address.
 166  *
 167  * @param ea
 168  *   A pointer to a ether_addr structure containing the ethernet address
 169  *   to check.
 170  * @return
 171  *   True  (1) if the given ethernet address is a broadcast address;
 172  *   false (0) otherwise.
 173  */
 174 static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
 175 {
 176         const uint16_t *ea_words = (const uint16_t *)ea;
 177
 178         return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
 179                 ea_words[2] == 0xFFFF);
 180 }
 181
 182 /**
 183  * Check if an Ethernet address is a universally assigned address.
 184  *
 185  * @param ea
 186  *   A pointer to a ether_addr structure containing the ethernet address
 187  *   to check.
 188  * @return
 189  *   True  (1) if the given ethernet address is a universally assigned address;
 190  *   false (0) otherwise.
 191  */
 192 static inline int is_universal_ether_addr(const struct ether_addr *ea)
 193 {
 194         return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0);
 195 }
 196
 197 /**
 198  * Check if an Ethernet address is a locally assigned address.
 199  *
 200  * @param ea
 201  *   A pointer to a ether_addr structure containing the ethernet address
 202  *   to check.
 203  * @return
 204  *   True  (1) if the given ethernet address is a locally assigned address;
 205  *   false (0) otherwise.
 206  */
 207 static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
 208 {
 209         return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) != 0);
 210 }
 211
 212 /**
 213  * Check if an Ethernet address is a valid address. Checks that the address is a
 214  * unicast address and is not filled with zeros.
 215  *
 216  * @param ea
 217  *   A pointer to a ether_addr structure containing the ethernet address
 218  *   to check.
 219  * @return
 220  *   True  (1) if the given ethernet address is valid;
 221  *   false (0) otherwise.
 222  */
 223 static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
 224 {
 225         return (is_unicast_ether_addr(ea) && (! is_zero_ether_addr(ea)));
 226 }
 227
 228 /**
 229  * Generate a random Ethernet address that is locally administered
 230  * and not multicast.
 231  * @param addr
 232  *   A pointer to Ethernet address.
 233  */
 234 static inline void eth_random_addr(uint8_t *addr)
 235 {
 236         uint64_t rand = rte_rand();
 237         uint8_t *p = (uint8_t*)&rand;
 238
 239         rte_memcpy(addr, p, ETHER_ADDR_LEN);
 240         addr[0] &= ~ETHER_GROUP_ADDR;       /* clear multicast bit */
 241         addr[0] |= ETHER_LOCAL_ADMIN_ADDR;  /* set local assignment bit */
 242 }
 243
 244 /**
 245  * Fast copy an Ethernet address.
 246  *
 247  * @param ea_from
 248  *   A pointer to a ether_addr structure holding the Ethernet address to copy.
 249  * @param ea_to
 250  *   A pointer to a ether_addr structure where to copy the Ethernet address.
 251  */
 252 static inline void ether_addr_copy(const struct ether_addr *ea_from,
 253                                    struct ether_addr *ea_to)
 254 {
 255 #ifdef __INTEL_COMPILER
 256         uint16_t *from_words = (uint16_t *)(ea_from->addr_bytes);
 257         uint16_t *to_words   = (uint16_t *)(ea_to->addr_bytes);
 258
 259         to_words[0] = from_words[0];
 260         to_words[1] = from_words[1];
 261         to_words[2] = from_words[2];
 262 #else
 263         /*
 264          * Use the common way, because of a strange gcc warning.
 265          */
 266         *ea_to = *ea_from;
 267 #endif
 268 }
 269
 270 #define ETHER_ADDR_FMT_SIZE         18
 271 /**
 272  * Format 48bits Ethernet address in pattern xx:xx:xx:xx:xx:xx.
 273  *
 274  * @param buf
 275  *   A pointer to buffer contains the formatted MAC address.
 276  * @param size
 277  *   The format buffer size.
 278  * @param ea_to
 279  *   A pointer to a ether_addr structure.
 280  */
 281 static inline void
 282 ether_format_addr(char *buf, uint16_t size,
 283                   const struct ether_addr *eth_addr)
 284 {
 285         snprintf(buf, size, "%02X:%02X:%02X:%02X:%02X:%02X",
 286                  eth_addr->addr_bytes[0],
 287                  eth_addr->addr_bytes[1],
 288                  eth_addr->addr_bytes[2],
 289                  eth_addr->addr_bytes[3],
 290                  eth_addr->addr_bytes[4],
 291                  eth_addr->addr_bytes[5]);
 292 }
 293
 294 /**
 295  * Ethernet header: Contains the destination address, source address
 296  * and frame type.
 297  */
 298 struct ether_hdr {
 299         struct ether_addr d_addr; /**< Destination address. */
 300         struct ether_addr s_addr; /**< Source address. */
 301         uint16_t ether_type;      /**< Frame type. */
 302 } __attribute__((__packed__));
 303
 304 /**
 305  * Ethernet VLAN Header.
 306  * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
 307  * of the encapsulated frame.
 308  */
 309 struct vlan_hdr {
 310         uint16_t vlan_tci; /**< Priority (3) + CFI (1) + Identifier Code (12) */
 311         uint16_t eth_proto;/**< Ethernet type of encapsulated frame. */
 312 } __attribute__((__packed__));
 313
 314 /**
 315  * VXLAN protocol header.
 316  * Contains the 8-bit flag, 24-bit VXLAN Network Identifier and
 317  * Reserved fields (24 bits and 8 bits)
 318  */
 319 struct vxlan_hdr {
 320         uint32_t vx_flags; /**< flag (8) + Reserved (24). */
 321         uint32_t vx_vni;   /**< VNI (24) + Reserved (8). */
 322 } __attribute__((__packed__));
 323
 324 /* Ethernet frame types */
 325 #define ETHER_TYPE_IPv4 0x0800 /**< IPv4 Protocol. */
 326 #define ETHER_TYPE_IPv6 0x86DD /**< IPv6 Protocol. */
 327 #define ETHER_TYPE_ARP  0x0806 /**< Arp Protocol. */
 328 #define ETHER_TYPE_RARP 0x8035 /**< Reverse Arp Protocol. */
 329 #define ETHER_TYPE_VLAN 0x8100 /**< IEEE 802.1Q VLAN tagging. */
 330 #define ETHER_TYPE_1588 0x88F7 /**< IEEE 802.1AS 1588 Precise Time Protocol. */
 331
 332 #define ETHER_VXLAN_HLEN (sizeof(struct udp_hdr) + sizeof(struct vxlan_hdr))
 333 /**< VXLAN tunnel header length. */
 334
 335 #ifdef __cplusplus
 336 }
 337 #endif
 338
 339 #endif /* _RTE_ETHER_H_ */