Genric API types format/unformat support for VAT and custom dump

Change-Id: I8bc3a991f0ede0605d78b51ba609fbe5889513f2
Signed-off-by: Neale Ranns <nranns@cisco.com>

12 files changed, 162 insertions, 57 deletions

diff --git a/src/vat/CMakeLists.txt b/src/vat/CMakeLists.txt
index 2ff907026db..e7f26d4491e 100644
--- a/src/vat/CMakeLists.txt
+++ b/src/vat/CMakeLists.txt
@@ -28,6 +28,7 @@ add_vpp_executable(vpp_api_test ENABLE_EXPORTS
   main.c
   plugin.c
   json_format.c
+  types.c
 
   LINK_LIBRARIES
   vlibmemoryclient
diff --git a/src/vat/api_format.c b/src/vat/api_format.c
index efd116dd7a7..8b8d0c9fdc0 100644
--- a/src/vat/api_format.c
+++ b/src/vat/api_format.c
@@ -18,6 +18,7 @@
  */
 
 #include <vat/vat.h>
+#include <vpp/api/types.h>
 #include <vppinfra/socket.h>
 #include <vlibapi/api.h>
 #include <vlibmemory/api.h>
@@ -53,6 +54,8 @@
 #include <vnet/bonding/node.h>
 #include <vnet/qos/qos_types.h>
 #include "vat/json_format.h"
+#include <vnet/ip/ip_types_api.h>
+#include <vnet/ethernet/ethernet_types_api.h>
 
 #include <inttypes.h>
 #include <sys/stat.h>
@@ -79,6 +82,14 @@
 #if VPP_API_TEST_BUILTIN == 0
 #include <netdb.h>
 
+/* *INDENT-OFF* */
+const mac_address_t ZERO_MAC_ADDRESS = {
+  .bytes = {
+    0, 0, 0, 0, 0, 0,
+  },
+};
+/* *INDENT-ON* */
+
 u32
 vl (void *p)
 {
diff --git a/src/vat/types.c b/src/vat/types.c
new file mode 120000
index 00000000000..8bcab8874ef
--- /dev/null
+++ b/src/vat/types.c
@@ -0,0 +1 @@
+../vpp/api/types.c
\ No newline at end of file
diff --git a/src/vnet/ethernet/ethernet_types_api.c b/src/vnet/ethernet/ethernet_types_api.c
index 9b2e99a6371..67e6231cfc8 100644
--- a/src/vnet/ethernet/ethernet_types_api.c
+++ b/src/vnet/ethernet/ethernet_types_api.c
@@ -41,14 +41,6 @@ mac_address_encode (const mac_address_t * in, vl_api_mac_address_t * out)
   clib_memcpy (out->bytes, in->bytes, 6);
 }
 
-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
  *
diff --git a/src/vnet/ethernet/ethernet_types_api.h b/src/vnet/ethernet/ethernet_types_api.h
index f326f8afa56..b65d9d46c86 100644
--- a/src/vnet/ethernet/ethernet_types_api.h
+++ b/src/vnet/ethernet/ethernet_types_api.h
@@ -32,8 +32,6 @@ extern void mac_address_decode (const struct _vl_api_mac_address *in,
 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
 
 /*
diff --git a/src/vnet/ethernet/mac_address.c b/src/vnet/ethernet/mac_address.c
index 72725c8e593..419a5b0879f 100644
--- a/src/vnet/ethernet/mac_address.c
+++ b/src/vnet/ethernet/mac_address.c
@@ -15,20 +15,36 @@
 
 #include <vnet/ethernet/mac_address.h>
 
+/* *INDENT-OFF* */
 const mac_address_t ZERO_MAC_ADDRESS = {
   .bytes = {
-	    0, 0, 0, 0, 0, 0,
-	    },
+    0, 0, 0, 0, 0, 0,
+  },
 };
+/* *INDENT-ON* */
 
 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));
+  return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
+		 mac->bytes[0], mac->bytes[1], mac->bytes[2],
+		 mac->bytes[3], mac->bytes[4], mac->bytes[5]);
 }
 
+uword
+unformat_mac_address_t (unformat_input_t * input, va_list * args)
+{
+  mac_address_t *mac = va_arg (*args, mac_address_t *);
+
+  if (!unformat (input, "%_%x:%x:%x:%x:%x:%x%_",
+		 &mac->bytes[0], &mac->bytes[1], &mac->bytes[2],
+		 &mac->bytes[3], &mac->bytes[4], &mac->bytes[5]))
+    return 0;
+
+  return 1;
+}
 
 /*
  * fd.io coding-style-patch-verification: ON
diff --git a/src/vnet/ethernet/mac_address.h b/src/vnet/ethernet/mac_address.h
index e97eab6c3d7..8e1559b8654 100644
--- a/src/vnet/ethernet/mac_address.h
+++ b/src/vnet/ethernet/mac_address.h
@@ -49,6 +49,8 @@ mac_address_from_u64 (u64 u, mac_address_t * mac)
   ethernet_mac_address_from_u64 (u, mac->bytes);
 }
 
+extern uword unformat_mac_address_t (unformat_input_t * input,
+				     va_list * args);
 extern u8 *format_mac_address_t (u8 * s, va_list * args);
 
 #endif
diff --git a/src/vnet/ip/ip_types_api.c b/src/vnet/ip/ip_types_api.c
index d5a56fa5547..11b52760fad 100644
--- a/src/vnet/ip/ip_types_api.c
+++ b/src/vnet/ip/ip_types_api.c
@@ -140,45 +140,6 @@ ip_mprefix_decode (const vl_api_mprefix_t * in, mfib_prefix_t * out)
   ip_address_union_decode (&in->src_address, in->af, &out->fp_src_addr);
 }
 
-u8 *
-format_vl_api_address (u8 * s, va_list * args)
-{
-  const vl_api_address_t *addr = va_arg (*args, vl_api_address_t *);
-
-  if (ADDRESS_IP6 == clib_net_to_host_u32 (addr->af))
-    s = format (s, "ip6:%U", format_ip6_address, addr->un.ip6.address);
-  else
-    s = format (s, "ip4:%U", format_ip4_address, addr->un.ip4.address);
-
-  return s;
-}
-
-u8 *
-format_vl_api_address_union (u8 * s, va_list * args)
-{
-  const vl_api_address_union_t *addr =
-    va_arg (*args, vl_api_address_union_t *);
-  vl_api_address_family_t af = va_arg (*args, vl_api_address_family_t);
-
-  if (ADDRESS_IP6 == af)
-    s = format (s, "ip6:%U", format_ip6_address, addr->ip6.address);
-  else
-    s = format (s, "ip4:%U", format_ip4_address, addr->ip4.address);
-
-  return s;
-}
-
-u8 *
-format_vl_api_prefix (u8 * s, va_list * args)
-{
-  const vl_api_prefix_t *pfx = va_arg (*args, vl_api_prefix_t *);
-
-  s = format (s, "%U/%d", format_vl_api_address,
-	      &pfx->address, pfx->address_length);
-
-  return s;
-}
-
 /*
  * fd.io coding-style-patch-verification: ON
  *
diff --git a/src/vnet/ip/ip_types_api.h b/src/vnet/ip/ip_types_api.h
index 1bc899a4588..be41bf59ec3 100644
--- a/src/vnet/ip/ip_types_api.h
+++ b/src/vnet/ip/ip_types_api.h
@@ -46,11 +46,6 @@ extern void ip_mprefix_decode (const struct _vl_api_mprefix *in,
 extern void ip_mprefix_encode (const mfib_prefix_t * in,
 			       struct _vl_api_mprefix *out);
 
-extern u8 *format_vl_api_address (u8 * s, va_list * args);
-extern u8 *format_vl_api_address_union (u8 * s, va_list * args);
-extern u8 *format_vl_api_prefix (u8 * s, va_list * args);
-extern u8 *format_vl_api_mprefix (u8 * s, va_list * args);
-
 #endif
 
 /*
diff --git a/src/vpp/CMakeLists.txt b/src/vpp/CMakeLists.txt
index 16843f73e8a..98e98e5d7ae 100644
--- a/src/vpp/CMakeLists.txt
+++ b/src/vpp/CMakeLists.txt
@@ -61,6 +61,7 @@ set(VPP_SOURCES
   api/api.c
   api/json_format.c
   api/custom_dump.c
+  api/types.c
 )
 
 if(VPP_API_TEST_BUILTIN)
@@ -68,6 +69,7 @@ if(VPP_API_TEST_BUILTIN)
     api/api_format.c
     api/api_main.c
     api/plugin.c
+    api/types.c
   )
   add_definitions(-DVPP_API_TEST_BUILTIN=1)
 endif()
diff --git a/src/vpp/api/types.c b/src/vpp/api/types.c
new file mode 100644
index 00000000000..b1f16564c59
--- /dev/null
+++ b/src/vpp/api/types.c
@@ -0,0 +1,91 @@
+/*
+ *------------------------------------------------------------------
+ * 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 <vlib/vlib.h>
+#include <vpp/api/types.h>
+#include <vat/vat.h>
+
+u8 *
+format_vl_api_address (u8 * s, va_list * args)
+{
+  const vl_api_address_t *addr = va_arg (*args, vl_api_address_t *);
+
+  if (ADDRESS_IP6 == clib_net_to_host_u32 (addr->af))
+    s = format (s, "ip6:%U", format_ip6_address, addr->un.ip6.address);
+  else
+    s = format (s, "ip4:%U", format_ip4_address, addr->un.ip4.address);
+
+  return s;
+}
+
+u8 *
+format_vl_api_address_union (u8 * s, va_list * args)
+{
+  const vl_api_address_union_t *addr =
+    va_arg (*args, vl_api_address_union_t *);
+  vl_api_address_family_t af = va_arg (*args, vl_api_address_family_t);
+
+  if (ADDRESS_IP6 == af)
+    s = format (s, "ip6:%U", format_ip6_address, addr->ip6.address);
+  else
+    s = format (s, "ip4:%U", format_ip4_address, addr->ip4.address);
+
+  return s;
+}
+
+u8 *
+format_vl_api_prefix (u8 * s, va_list * args)
+{
+  const vl_api_prefix_t *pfx = va_arg (*args, vl_api_prefix_t *);
+
+  s = format (s, "%U/%d", format_vl_api_address,
+	      &pfx->address, pfx->address_length);
+
+  return s;
+}
+
+uword
+unformat_vl_api_mac_address (unformat_input_t * input, va_list * args)
+{
+  vl_api_mac_address_t *mac = va_arg (*args, vl_api_mac_address_t *);
+
+  return (unformat (input, "%U",unformat_ethernet_address, mac->bytes));
+}
+
+uword
+unformat_vl_api_address (unformat_input_t * input, va_list * args)
+{
+  vl_api_address_t *ip = va_arg (*args, vl_api_address_t *);
+
+  if (unformat (input, "%U", unformat_ip4_address, &ip->un.ip4))
+      ip->af = clib_host_to_net_u32(ADDRESS_IP4);
+  else if (unformat (input, "%U", unformat_ip6_address, &ip->un.ip6))
+      ip->af = clib_host_to_net_u32(ADDRESS_IP6);
+  else
+      return (0);
+
+  return (1);
+}
+
+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_ethernet_address, mac->bytes));
+}
+
diff --git a/src/vpp/api/types.h b/src/vpp/api/types.h
new file mode 100644
index 00000000000..252caa2d626
--- /dev/null
+++ b/src/vpp/api/types.h
@@ -0,0 +1,35 @@
+/*
+ * 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 __API_TYPES_H__
+#define __API_TYPES_H__
+
+#define vl_typedefs		/* define message structures */
+#include <vpp/api/vpe_all_api_h.h>
+#undef vl_typedefs
+
+const vl_api_mac_address_t VL_API_ZERO_MAC_ADDRESS;
+const vl_api_address_t VL_API_ZERO_ADDRESS;
+
+extern uword unformat_vl_api_mac_address (unformat_input_t * input, va_list * args);
+extern uword unformat_vl_api_address (unformat_input_t * input, va_list * args);
+
+extern u8 *format_vl_api_address (u8 * s, va_list * args);
+extern u8 *format_vl_api_address_union (u8 * s, va_list * args);
+extern u8 *format_vl_api_prefix (u8 * s, va_list * args);
+extern u8 *format_vl_api_mprefix (u8 * s, va_list * args);
+extern u8 *format_vl_api_mac_address (u8 * s, va_list * args);
+
+#endif