Introduce a mac_address_t on the API and in VPP

Change-Id: I05d6c2cb5d34de469eb050e4ee10dc6b954c986d
Signed-off-by: Neale Ranns <neale.ranns@cisco.com>

8 files changed, 239 insertions, 2 deletions

diff --git a/src/vnet/CMakeLists.txt b/src/vnet/CMakeLists.txt
index a10ec821e9a..61945a41867 100644
--- a/src/vnet/CMakeLists.txt
+++ b/src/vnet/CMakeLists.txt
@@ -109,9 +109,11 @@ list(APPEND VNET_API_FILES cop/cop.api)
 # Layer 2 protocol: Ethernet
 ##############################################################################
 list(APPEND VNET_SOURCES
+  ethernet/ethernet_types_api.c
   ethernet/format.c
   ethernet/init.c
   ethernet/interface.c
+  ethernet/mac_address.c
   ethernet/node.c
   ethernet/pg.c
   ethernet/sfp.c
diff --git a/src/vnet/ethernet/ethernet.h b/src/vnet/ethernet/ethernet.h
index 0bfd48723e2..9a23448b3e6 100644
--- a/src/vnet/ethernet/ethernet.h
+++ b/src/vnet/ethernet/ethernet.h
@@ -46,7 +46,7 @@
 #include <vnet/feature/feature.h>
 
 always_inline u64
-ethernet_mac_address_u64 (u8 * a)
+ethernet_mac_address_u64 (const u8 * a)
 {
   return (((u64) a[0] << (u64) (5 * 8))
 	  | ((u64) a[1] << (u64) (4 * 8))
@@ -55,6 +55,18 @@ ethernet_mac_address_u64 (u8 * a)
 	  | ((u64) a[4] << (u64) (1 * 8)) | ((u64) a[5] << (u64) (0 * 8)));
 }
 
+always_inline void
+ethernet_mac_address_from_u64 (u64 u, u8 * a)
+{
+  i8 ii;
+
+  for (ii = 5; ii >= 0; ii--)
+    {
+      a[ii] = u & 0xFF;
+      u = u >> 8;
+    }
+}
+
 static inline int
 ethernet_mac_address_is_multicast_u64 (u64 a)
 {
@@ -62,7 +74,7 @@ ethernet_mac_address_is_multicast_u64 (u64 a)
 }
 
 static inline int
-ethernet_mac_address_is_zero (u8 * mac)
+ethernet_mac_address_is_zero (const u8 * mac)
 {
   return ((*((u32 *) mac) == 0) && (*((u16 *) (mac + 4)) == 0));
 }
diff --git a/src/vnet/ethernet/ethernet_types.api b/src/vnet/ethernet/ethernet_types.api
new file mode 100644
index 00000000000..c33a02c377a
--- /dev/null
+++ b/src/vnet/ethernet/ethernet_types.api
@@ -0,0 +1,19 @@
+/* Hey Emacs use -*- mode: C -*- */
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+typedef mac_address {
+  u8 bytes[6];
+};
diff --git a/src/vnet/ethernet/ethernet_types_api.c b/src/vnet/ethernet/ethernet_types_api.c
new file mode 100644
index 00000000000..d9e06012870
--- /dev/null
+++ b/src/vnet/ethernet/ethernet_types_api.c
@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <vnet/ethernet/ethernet_types_api.h>
+
+#define vl_typedefs		/* define message structures */
+#include <vnet/vnet_all_api_h.h>
+#undef vl_typedefs
+
+#define vl_endianfun		/* define message structures */
+#include <vnet/vnet_all_api_h.h>
+#undef vl_endianfun
+
+/* instantiate all the print functions we know about */
+#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
+#define vl_printfun
+#include <vnet/vnet_all_api_h.h>
+#undef vl_printfun
+
+void
+mac_address_decode (const vl_api_mac_address_t * in, mac_address_t * out)
+{
+  mac_address_from_bytes (out, in->bytes);
+}
+
+void
+mac_address_encode (const mac_address_t * in, vl_api_mac_address_t * out)
+{
+}
+
+extern u8 *
+format_vl_api_mac_address (u8 * s, va_list * args)
+{
+  vl_api_mac_address_t *mac = va_arg (args, vl_api_mac_address_t *);
+
+  return (format (s, "%U", format_mac_address, mac->bytes));
+}
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vnet/ethernet/ethernet_types_api.h b/src/vnet/ethernet/ethernet_types_api.h
new file mode 100644
index 00000000000..f326f8afa56
--- /dev/null
+++ b/src/vnet/ethernet/ethernet_types_api.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __ETHERNET_TYPES_API_H__
+#define __ETHERNET_TYPES_API_H__
+
+/**
+ * Conversion functions to/from (decode/encode) API types to VPP internal types
+ */
+
+#include <vnet/ethernet/mac_address.h>
+
+/**
+ * Forward declarations so we need not #include the API definitions here
+ */
+struct _vl_api_mac_address;
+
+extern void mac_address_decode (const struct _vl_api_mac_address *in,
+				mac_address_t * out);
+extern void mac_address_encode (const mac_address_t * in,
+				struct _vl_api_mac_address *out);
+
+extern u8 *format_vl_api_mac_address (u8 * s, va_list * args);
+
+#endif
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vnet/ethernet/mac_address.c b/src/vnet/ethernet/mac_address.c
new file mode 100644
index 00000000000..72725c8e593
--- /dev/null
+++ b/src/vnet/ethernet/mac_address.c
@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include <vnet/ethernet/mac_address.h>
+
+const mac_address_t ZERO_MAC_ADDRESS = {
+  .bytes = {
+	    0, 0, 0, 0, 0, 0,
+	    },
+};
+
+u8 *
+format_mac_address_t (u8 * s, va_list * args)
+{
+  const mac_address_t *mac = va_arg (*args, mac_address_t *);
+
+  return (format (s, "%U", format_mac_address, mac->bytes));
+}
+
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vnet/ethernet/mac_address.h b/src/vnet/ethernet/mac_address.h
new file mode 100644
index 00000000000..e97eab6c3d7
--- /dev/null
+++ b/src/vnet/ethernet/mac_address.h
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2018 Cisco and/or its affiliates.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at:
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef __MAC_ADDRESS_H__
+#define __MAC_ADDRESS_H__
+
+#include <vnet/ethernet/ethernet.h>
+
+typedef struct mac_address_t_
+{
+  u8 bytes[6];
+} mac_address_t;
+
+extern const mac_address_t ZERO_MAC_ADDRESS;
+
+static_always_inline void
+mac_address_from_bytes (mac_address_t * mac, const u8 * bytes)
+{
+  clib_memcpy (mac->bytes, bytes, sizeof (*mac));
+}
+
+static_always_inline int
+mac_address_is_zero (const mac_address_t * mac)
+{
+  return (ethernet_mac_address_is_zero (mac->bytes));
+}
+
+static_always_inline u64
+mac_address_as_u64 (const mac_address_t * mac)
+{
+  return (ethernet_mac_address_u64 (mac->bytes));
+}
+
+static_always_inline void
+mac_address_from_u64 (u64 u, mac_address_t * mac)
+{
+  ethernet_mac_address_from_u64 (u, mac->bytes);
+}
+
+extern u8 *format_mac_address_t (u8 * s, va_list * args);
+
+#endif
+
+/*
+ * fd.io coding-style-patch-verification: ON
+ *
+ * Local Variables:
+ * eval: (c-set-style "gnu")
+ * End:
+ */
diff --git a/src/vnet/ip/ip.api b/src/vnet/ip/ip.api
index 5f664f33cf6..616d621577d 100644
--- a/src/vnet/ip/ip.api
+++ b/src/vnet/ip/ip.api
@@ -22,6 +22,7 @@
 option version = "1.3.0";
 import "vnet/ip/ip_types.api";
 import "vnet/fib/fib_types.api";
+import "vnet/ethernet/ethernet_types.api";
 
 /** \brief Add / del table request
            A table can be added multiple times, but need be deleted only once.