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 <vnet/ethernet/ethernet.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 static_always_inline void
  40 mac_address_from_bytes (mac_address_t * mac, const u8 * bytes)
  41 {
  42   /* zero out the last 2 bytes, then copy over only 6 */
  43   clib_memcpy (mac->bytes, bytes, 6);
  44 }
  45
  46 static_always_inline void
  47 mac_address_to_bytes (const mac_address_t * mac, u8 * bytes)
  48 {
  49   /* zero out the last 2 bytes, then copy over only 6 */
  50   clib_memcpy (bytes, mac->bytes, 6);
  51 }
  52
  53 static_always_inline int
  54 mac_address_is_zero (const mac_address_t * mac)
  55 {
  56   return (0 == mac->u.first_4 && 0 == mac->u.last_2);
  57 }
  58
  59 static_always_inline u64
  60 mac_address_as_u64 (const mac_address_t * mac)
  61 {
  62   u64 *as_u64;
  63
  64   as_u64 = (u64 *) mac->bytes;
  65
  66   return (*as_u64);
  67 }
  68
  69 static_always_inline void
  70 mac_address_from_u64 (u64 u, mac_address_t * mac)
  71 {
  72   clib_memcpy (mac->bytes, &u, 6);
  73 }
  74
  75 static_always_inline void
  76 mac_address_copy (mac_address_t * dst, const mac_address_t * src)
  77 {
  78   mac_address_from_bytes (dst, src->bytes);
  79 }
  80
  81 extern uword unformat_mac_address_t (unformat_input_t * input,
  82                                      va_list * args);
  83 extern u8 *format_mac_address_t (u8 * s, va_list * args);
  84
  85 #endif
  86
  87 /*
  88  * fd.io coding-style-patch-verification: ON
  89  *
  90  * Local Variables:
  91  * eval: (c-set-style "gnu")
  92  * End:
  93  */