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
  49 #include <rte_memcpy.h>
  50 #include <rte_random.h>
  51
  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. */
  59 #define ETHER_MTU       \
  60         (ETHER_MAX_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN) /**< Ethernet MTU. */
  61
  62 #define ETHER_MAX_VLAN_FRAME_LEN \
  63         (ETHER_MAX_LEN + 4) /**< Maximum VLAN frame length, including CRC. */
  64
  65 #define ETHER_MAX_JUMBO_FRAME_LEN \
  66         0x3F00 /**< Maximum Jumbo frame length, including CRC. */
  67
  68 #define ETHER_MAX_VLAN_ID  4095 /**< Maximum VLAN ID. */
  69
  70 #define ETHER_MIN_MTU 68 /**< Minimum MTU for IPv4 packets, see RFC 791. */
  71
  72 /**
  73  * Ethernet address:
  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
  78  * of uniqueness.
  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
  82  */
  83 struct ether_addr {
  84         uint8_t addr_bytes[ETHER_ADDR_LEN]; /**< Address bytes in transmission order */
  85 } __attribute__((__packed__));
  86
  87 #define ETHER_LOCAL_ADMIN_ADDR 0x02 /**< Locally assigned Eth. address. */
  88 #define ETHER_GROUP_ADDR       0x01 /**< Multicast or broadcast Eth. address. */
  89
  90 /**
  91  * Check if two Ethernet addresses are the same.
  92  *
  93  * @param ea1
  94  *  A pointer to the first ether_addr structure containing
  95  *  the ethernet address.
  96  * @param ea2
  97  *  A pointer to the second ether_addr structure containing
  98  *  the ethernet address.
  99  *
 100  * @return
 101  *  True  (1) if the given two ethernet address are the same;
 102  *  False (0) otherwise.
 103  */
 104 static inline int is_same_ether_addr(const struct ether_addr *ea1,
 105                                      const struct ether_addr *ea2)
 106 {
 107         int i;
 108         for (i = 0; i < ETHER_ADDR_LEN; i++)
 109                 if (ea1->addr_bytes[i] != ea2->addr_bytes[i])
 110                         return 0;
 111         return 1;
 112 }
 113
 114 /**
 115  * Check if an Ethernet address is filled with zeros.
 116  *
 117  * @param ea
 118  *   A pointer to a ether_addr structure containing the ethernet address
 119  *   to check.
 120  * @return
 121  *   True  (1) if the given ethernet address is filled with zeros;
 122  *   false (0) otherwise.
 123  */
 124 static inline int is_zero_ether_addr(const struct ether_addr *ea)
 125 {
 126         int i;
 127         for (i = 0; i < ETHER_ADDR_LEN; i++)
 128                 if (ea->addr_bytes[i] != 0x00)
 129                         return 0;
 130         return 1;
 131 }
 132
 133 /**
 134  * Check if an Ethernet address is a unicast address.
 135  *
 136  * @param ea
 137  *   A pointer to a ether_addr structure containing the ethernet address
 138  *   to check.
 139  * @return
 140  *   True  (1) if the given ethernet address is a unicast address;
 141  *   false (0) otherwise.
 142  */
 143 static inline int is_unicast_ether_addr(const struct ether_addr *ea)
 144 {
 145         return ((ea->addr_bytes[0] & ETHER_GROUP_ADDR) == 0);
 146 }
 147
 148 /**
 149  * Check if an Ethernet address is a multicast address.
 150  *
 151  * @param ea
 152  *   A pointer to a ether_addr structure containing the ethernet address
 153  *   to check.
 154  * @return
 155  *   True  (1) if the given ethernet address is a multicast address;
 156  *   false (0) otherwise.
 157  */
 158 static inline int is_multicast_ether_addr(const struct ether_addr *ea)
 159 {
 160         return (ea->addr_bytes[0] & ETHER_GROUP_ADDR);
 161 }
 162
 163 /**
 164  * Check if an Ethernet address is a broadcast address.
 165  *
 166  * @param ea
 167  *   A pointer to a ether_addr structure containing the ethernet address
 168  *   to check.
 169  * @return
 170  *   True  (1) if the given ethernet address is a broadcast address;
 171  *   false (0) otherwise.
 172  */
 173 static inline int is_broadcast_ether_addr(const struct ether_addr *ea)
 174 {
 175         const uint16_t *ea_words = (const uint16_t *)ea;
 176
 177         return (ea_words[0] == 0xFFFF && ea_words[1] == 0xFFFF &&
 178                 ea_words[2] == 0xFFFF);
 179 }
 180
 181 /**
 182  * Check if an Ethernet address is a universally assigned address.
 183  *
 184  * @param ea
 185  *   A pointer to a ether_addr structure containing the ethernet address
 186  *   to check.
 187  * @return
 188  *   True  (1) if the given ethernet address is a universally assigned address;
 189  *   false (0) otherwise.
 190  */
 191 static inline int is_universal_ether_addr(const struct ether_addr *ea)
 192 {
 193         return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) == 0);
 194 }
 195
 196 /**
 197  * Check if an Ethernet address is a locally assigned address.
 198  *
 199  * @param ea
 200  *   A pointer to a ether_addr structure containing the ethernet address
 201  *   to check.
 202  * @return
 203  *   True  (1) if the given ethernet address is a locally assigned address;
 204  *   false (0) otherwise.
 205  */
 206 static inline int is_local_admin_ether_addr(const struct ether_addr *ea)
 207 {
 208         return ((ea->addr_bytes[0] & ETHER_LOCAL_ADMIN_ADDR) != 0);
 209 }
 210
 211 /**
 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.
 214  *
 215  * @param ea
 216  *   A pointer to a ether_addr structure containing the ethernet address
 217  *   to check.
 218  * @return
 219  *   True  (1) if the given ethernet address is valid;
 220  *   false (0) otherwise.
 221  */
 222 static inline int is_valid_assigned_ether_addr(const struct ether_addr *ea)
 223 {
 224         return (is_unicast_ether_addr(ea) && (! is_zero_ether_addr(ea)));
 225 }
 226
 227 /**
 228  * Generate a random Ethernet address that is locally administered
 229  * and not multicast.
 230  * @param addr
 231  *   A pointer to Ethernet address.
 232  */
 233 static inline void eth_random_addr(uint8_t *addr)
 234 {
 235         uint64_t rand = rte_rand();
 236         uint8_t *p = (uint8_t*)&rand;
 237
 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 */
 241 }
 242
 243 /**
 244  * Fast copy an Ethernet address.
 245  *
 246  * @param ea_from
 247  *   A pointer to a ether_addr structure holding the Ethernet address to copy.
 248  * @param ea_to
 249  *   A pointer to a ether_addr structure where to copy the Ethernet address.
 250  */
 251 static inline void ether_addr_copy(const struct ether_addr *ea_from,
 252                                    struct ether_addr *ea_to)
 253 {
 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);
 257
 258         to_words[0] = from_words[0];
 259         to_words[1] = from_words[1];
 260         to_words[2] = from_words[2];
 261 #else
 262         /*
 263          * Use the common way, because of a strange gcc warning.
 264          */
 265         *ea_to = *ea_from;
 266 #endif
 267 }
 268
 269 /**
 270  * Ethernet header: Contains the destination address, source address
 271  * and frame type.
 272  */
 273 struct ether_hdr {
 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__));
 278
 279 /**
 280  * Ethernet VLAN Header.
 281  * Contains the 16-bit VLAN Tag Control Identifier and the Ethernet type
 282  * of the encapsulated frame.
 283  */
 284 struct vlan_hdr {
 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__));
 288
 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. */
 296
 297 #ifdef __cplusplus
 298 }
 299 #endif
 300
 301 #endif /* _RTE_ETHER_H_ */