src/vnet/ethernet/mac_address.h

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef __MAC_ADDRESS_H__
  17 #define __MAC_ADDRESS_H__
  18
  19 #include <vlib/vlib.h>
  20
  21 typedef struct mac_address_t_
  22 {
  23   union
  24   {
  25     u8 bytes[6];
  26     struct
  27     {
  28       u32 first_4;
  29       u16 last_2;
  30     } __clib_packed u;
  31   };
  32 } mac_address_t;
  33
  34 STATIC_ASSERT ((sizeof (mac_address_t) == 6),
  35                "MAC address must represent the on wire format");
  36
  37 extern const mac_address_t ZERO_MAC_ADDRESS;
  38
  39 always_inline u64
  40 ethernet_mac_address_u64 (const u8 * a)
  41 {
  42   return (((u64) a[0] << (u64) (5 * 8))
  43           | ((u64) a[1] << (u64) (4 * 8))
  44           | ((u64) a[2] << (u64) (3 * 8))
  45           | ((u64) a[3] << (u64) (2 * 8))
  46           | ((u64) a[4] << (u64) (1 * 8)) | ((u64) a[5] << (u64) (0 * 8)));
  47 }
  48
  49 always_inline void
  50 ethernet_mac_address_from_u64 (u64 u, u8 * a)
  51 {
  52   i8 ii;
  53
  54   for (ii = 5; ii >= 0; ii--)
  55     {
  56       a[ii] = u & 0xFF;
  57       u = u >> 8;
  58     }
  59 }
  60
  61 static inline int
  62 ethernet_mac_address_is_multicast_u64 (u64 a)
  63 {
  64   return (a & (1ULL << (5 * 8))) != 0;
  65 }
  66
  67 static inline int
  68 ethernet_mac_address_is_zero (const u8 * mac)
  69 {
  70   return ((*((u32 *) mac) == 0) && (*((u16 *) (mac + 4)) == 0));
  71 }
  72
  73 static inline int
  74 ethernet_mac_address_equal (const u8 * a, const u8 * b)
  75 {
  76   return ((*((u32 *) a) == (*((u32 *) b))) &&
  77           (*((u16 *) (a + 4)) == (*((u16 *) (b + 4)))));
  78 }
  79
  80 static_always_inline void
  81 mac_address_from_bytes (mac_address_t * mac, const u8 * bytes)
  82 {
  83   /* zero out the last 2 bytes, then copy over only 6 */
  84   clib_memcpy_fast (mac->bytes, bytes, 6);
  85 }
  86
  87 static_always_inline void
  88 mac_address_to_bytes (const mac_address_t * mac, u8 * bytes)
  89 {
  90   /* zero out the last 2 bytes, then copy over only 6 */
  91   clib_memcpy_fast (bytes, mac->bytes, 6);
  92 }
  93
  94 static_always_inline int
  95 mac_address_is_zero (const mac_address_t * mac)
  96 {
  97   return (0 == mac->u.first_4 && 0 == mac->u.last_2);
  98 }
  99
 100 static_always_inline u64
 101 mac_address_as_u64 (const mac_address_t * mac)
 102 {
 103   u64 *as_u64;
 104
 105   as_u64 = (u64 *) mac->bytes;
 106
 107   return (*as_u64);
 108 }
 109
 110 static_always_inline void
 111 mac_address_from_u64 (mac_address_t * mac, u64 u)
 112 {
 113   clib_memcpy (mac->bytes, &u, 6);
 114 }
 115
 116 static_always_inline void
 117 mac_address_copy (mac_address_t * dst, const mac_address_t * src)
 118 {
 119   mac_address_from_bytes (dst, src->bytes);
 120 }
 121
 122 static_always_inline int
 123 mac_address_cmp (const mac_address_t * a, const mac_address_t * b)
 124 {
 125   return (memcmp (a->bytes, b->bytes, 6));
 126 }
 127
 128 static_always_inline int
 129 mac_address_equal (const mac_address_t * a, const mac_address_t * b)
 130 {
 131   return (a->u.last_2 == b->u.last_2 && a->u.first_4 == b->u.first_4);
 132 }
 133
 134 static_always_inline void
 135 mac_address_set_zero (mac_address_t * mac)
 136 {
 137   mac->u.first_4 = 0;
 138   mac->u.last_2 = 0;
 139 }
 140
 141 extern uword unformat_mac_address_t (unformat_input_t * input,
 142                                      va_list * args);
 143 extern u8 *format_mac_address_t (u8 * s, va_list * args);
 144
 145 #endif
 146
 147 /*
 148  * fd.io coding-style-patch-verification: ON
 149  *
 150  * Local Variables:
 151  * eval: (c-set-style "gnu")
 152  * End:
 153  */