vat: add infrastructure to align vnet test code and plugin test code

Split vat/api_format.c also for VNET features.
Use auto-generated VAT test code and support dynamic message ID allocation as for plugins.
The arp and geneve features as Guinea pigs.

Type: improvement
Signed-off-by: Ole Troan <ot@cisco.com>
Change-Id: I461591496766bdf10c5f950fd30f1a0ae05909da
Signed-off-by: Ole Troan <ot@cisco.com>

6 files changed, 398 insertions, 56 deletions

diff --git a/src/vnet/arp/arp_test.c b/src/vnet/arp/arp_test.c
index 861d0739406..29eeeb59d0f 100644
--- a/src/vnet/arp/arp_test.c
+++ b/src/vnet/arp/arp_test.c
@@ -41,8 +41,8 @@ arp_test_main_t arp_test_main;
 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
 
 /* Declare message IDs */
-#include <arp/arp.api_enum.h>
-#include <arp/arp.api_types.h>
+#include <vnet/arp/arp.api_enum.h>
+#include <vnet/arp/arp.api_types.h>
 #include <vpp/api/vpe.api_types.h>
 
 static int
@@ -156,8 +156,9 @@ api_proxy_arp_intfc_enable_disable (vat_main_t * vam)
   return ret;
 }
 
-#include <arp/arp.api_test.c>
+#include <vnet/arp/arp.api_test.c>
 
+VAT_REGISTER_FEATURE_FUNCTION (vat_arp_plugin_register);
 
 /*
  * fd.io coding-style-patch-verification: ON
diff --git a/src/vnet/geneve/geneve.api b/src/vnet/geneve/geneve.api
index ef2cd5ed8ae..fd871733fb9 100644
--- a/src/vnet/geneve/geneve.api
+++ b/src/vnet/geneve/geneve.api
@@ -31,6 +31,7 @@ define geneve_add_del_tunnel
   u32 encap_vrf_id;
   u32 decap_next_index;
   u32 vni;
+  option vat_help="src <ip-addr> { dst <ip-addr> | group <mcast-ip-addr> { <intfc> | mcast_sw_if_index <nn> } } vni <vni> [encap-vrf-id <nn>] [decap-next <l2|nn>] [del]";
 };
 
 define geneve_add_del_tunnel_reply
@@ -66,6 +67,7 @@ define geneve_tunnel_dump
   u32 client_index;
   u32 context;
   vl_api_interface_index_t sw_if_index;
+  option vat_help="[<intfc> | sw_if_index <nn>]";
 };
 
 define geneve_tunnel_details
@@ -94,4 +96,5 @@ autoreply define sw_interface_set_geneve_bypass
   vl_api_interface_index_t sw_if_index;
   bool is_ipv6;
   bool enable;
+  option vat_help="<intfc> | sw_if_index <id> [ip4 | ip6] [enable | disable]";
 };
diff --git a/src/vnet/geneve/geneve.h b/src/vnet/geneve/geneve.h
index 0b962e79883..46b048ada3f 100644
--- a/src/vnet/geneve/geneve.h
+++ b/src/vnet/geneve/geneve.h
@@ -181,6 +181,8 @@ typedef struct
   /* convenience */
   vlib_main_t *vlib_main;
   vnet_main_t *vnet_main;
+
+  u16 msg_id_base;
 } geneve_main_t;
 
 extern geneve_main_t geneve_main;
diff --git a/src/vnet/geneve/geneve_api.c b/src/vnet/geneve/geneve_api.c
index 10dafd2d63b..8c4a4cadc28 100644
--- a/src/vnet/geneve/geneve_api.c
+++ b/src/vnet/geneve/geneve_api.c
@@ -24,34 +24,17 @@
 #include <vnet/fib/fib_table.h>
 #include <vnet/ip/ip_types_api.h>
 
-#include <vnet/vnet_msg_enum.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
+#include <vnet/geneve/geneve.api_enum.h>
+#include <vnet/geneve/geneve.api_types.h>
 
+#define REPLY_MSG_ID_BASE gm->msg_id_base
 #include <vlibapi/api_helper_macros.h>
 
-#define foreach_vpe_api_msg                             \
-_(SW_INTERFACE_SET_GENEVE_BYPASS, sw_interface_set_geneve_bypass)         \
-_(GENEVE_ADD_DEL_TUNNEL, geneve_add_del_tunnel)                           \
-_(GENEVE_ADD_DEL_TUNNEL2, geneve_add_del_tunnel2)                         \
-_(GENEVE_TUNNEL_DUMP, geneve_tunnel_dump)
-
 static void
   vl_api_sw_interface_set_geneve_bypass_t_handler
   (vl_api_sw_interface_set_geneve_bypass_t * mp)
 {
+  geneve_main_t *gm = &geneve_main;
   vl_api_sw_interface_set_geneve_bypass_reply_t *rmp;
   int rv = 0;
   u32 sw_if_index = ntohl (mp->sw_if_index);
@@ -67,6 +50,7 @@ static void
 static void vl_api_geneve_add_del_tunnel_t_handler
   (vl_api_geneve_add_del_tunnel_t * mp)
 {
+  geneve_main_t *gm = &geneve_main;
   vl_api_geneve_add_del_tunnel_reply_t *rmp;
   int rv = 0;
   ip4_main_t *im = &ip4_main;
@@ -118,6 +102,7 @@ out:
 static void vl_api_geneve_add_del_tunnel2_t_handler
   (vl_api_geneve_add_del_tunnel2_t * mp)
 {
+  geneve_main_t *gm = &geneve_main;
   vl_api_geneve_add_del_tunnel2_reply_t *rmp;
   int rv = 0;
   ip4_main_t *im = &ip4_main;
@@ -170,6 +155,7 @@ out:
 static void send_geneve_tunnel_details
   (geneve_tunnel_t * t, vl_api_registration_t * reg, u32 context)
 {
+  geneve_main_t *gm = &geneve_main;
   vl_api_geneve_tunnel_details_t *rmp;
   ip4_main_t *im4 = &ip4_main;
   ip6_main_t *im6 = &ip6_main;
@@ -177,7 +163,7 @@ static void send_geneve_tunnel_details
 
   rmp = vl_msg_api_alloc (sizeof (*rmp));
   clib_memset (rmp, 0, sizeof (*rmp));
-  rmp->_vl_msg_id = ntohs (VL_API_GENEVE_TUNNEL_DETAILS);
+  rmp->_vl_msg_id = ntohs (VL_API_GENEVE_TUNNEL_DETAILS + gm->msg_id_base);
   ip_address_encode (&t->local, is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
 		     &rmp->src_address);
   ip_address_encode (&t->remote, is_ipv6 ? IP46_TYPE_IP6 : IP46_TYPE_IP4,
@@ -231,45 +217,22 @@ static void vl_api_geneve_tunnel_dump_t_handler
 }
 
 /*
- * vpe_api_hookup
- * Add vpe's API message handlers to the table.
- * vlib has already mapped shared memory and
- * added the client registration handlers.
- * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
+ * geneve_api_hookup
+ * Add geneve's API message handlers to the table.
  */
-#define vl_msg_name_crc_list
-#include <vnet/vnet_all_api_h.h>
-#undef vl_msg_name_crc_list
-
-static void
-setup_message_id_table (api_main_t * am)
-{
-#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
-  foreach_vl_msg_name_crc_geneve;
-#undef _
-}
+/* API definitions */
+#include <vnet/format_fns.h>
+#include <vnet/geneve/geneve.api.c>
 
 static clib_error_t *
 geneve_api_hookup (vlib_main_t * vm)
 {
-  api_main_t *am = vlibapi_get_main ();
-
-#define _(N,n)                                                  \
-    vl_msg_api_set_handlers(VL_API_##N, #n,                     \
-                           vl_api_##n##_t_handler,              \
-                           vl_noop_handler,                     \
-                           vl_api_##n##_t_endian,               \
-                           vl_api_##n##_t_print,                \
-                           sizeof(vl_api_##n##_t), 1);
-  foreach_vpe_api_msg;
-#undef _
-
-  am->api_trace_cfg[VL_API_GENEVE_ADD_DEL_TUNNEL].size += 16 * sizeof (u32);
+  geneve_main_t *gm = &geneve_main;
 
   /*
    * Set up the (msg_name, crc, message-id) table
    */
-  setup_message_id_table (am);
+  gm->msg_id_base = setup_message_id_table ();
 
   return 0;
 }
diff --git a/src/vnet/geneve/geneve_test.c b/src/vnet/geneve/geneve_test.c
new file mode 100644
index 00000000000..183ce5311de
--- /dev/null
+++ b/src/vnet/geneve/geneve_test.c
@@ -0,0 +1,374 @@
+/*
+ *------------------------------------------------------------------
+ * geneve_test.c
+ *
+ * Copyright (c) 2020 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 <vat/vat.h>
+#include <vlibapi/api.h>
+#include <vlibmemory/api.h>
+#include <vnet/format_fns.h>
+#include <vnet/ip/ip.h>
+#include <vpp/api/types.h>
+#include <vnet/geneve/geneve.h>
+
+typedef struct
+{
+  /* API message ID base */
+  u16 msg_id_base;
+  u32 ping_id;
+  vat_main_t *vat_main;
+} geneve_test_main_t;
+
+geneve_test_main_t geneve_test_main;
+
+/* Declare message IDs */
+#include <vnet/geneve/geneve.api_enum.h>
+#include <vnet/geneve/geneve.api_types.h>
+#include <vpp/api/vpe.api_types.h>
+
+#define __plugin_msg_base geneve_test_main.msg_id_base
+#include <vlibapi/vat_helper_macros.h>
+uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
+
+static void vl_api_geneve_add_del_tunnel2_reply_t_handler
+  (vl_api_geneve_add_del_tunnel2_reply_t * mp)
+{
+}
+static void vl_api_geneve_add_del_tunnel_reply_t_handler
+  (vl_api_geneve_add_del_tunnel_reply_t * mp)
+{
+  vat_main_t *vam = &vat_main;
+  i32 retval = ntohl (mp->retval);
+  if (vam->async_mode)
+    {
+      vam->async_errors += (retval < 0);
+    }
+  else
+    {
+      vam->retval = retval;
+      vam->sw_if_index = ntohl (mp->sw_if_index);
+      vam->result_ready = 1;
+    }
+}
+
+static int
+api_sw_interface_set_geneve_bypass (vat_main_t * vam)
+{
+  unformat_input_t *i = vam->input;
+  vl_api_sw_interface_set_geneve_bypass_t *mp;
+  u32 sw_if_index = 0;
+  u8 sw_if_index_set = 0;
+  u8 is_enable = 1;
+  u8 is_ipv6 = 0;
+  int ret;
+
+  /* Parse args required to build the message */
+  while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (i, "%U", unformat_sw_if_index, vam, &sw_if_index))
+	sw_if_index_set = 1;
+      else if (unformat (i, "sw_if_index %d", &sw_if_index))
+	sw_if_index_set = 1;
+      else if (unformat (i, "enable"))
+	is_enable = 1;
+      else if (unformat (i, "disable"))
+	is_enable = 0;
+      else if (unformat (i, "ip4"))
+	is_ipv6 = 0;
+      else if (unformat (i, "ip6"))
+	is_ipv6 = 1;
+      else
+	break;
+    }
+
+  if (sw_if_index_set == 0)
+    {
+      errmsg ("missing interface name or sw_if_index");
+      return -99;
+    }
+
+  /* Construct the API message */
+  M (SW_INTERFACE_SET_GENEVE_BYPASS, mp);
+
+  mp->sw_if_index = ntohl (sw_if_index);
+  mp->enable = is_enable;
+  mp->is_ipv6 = is_ipv6;
+
+  /* send it... */
+  S (mp);
+
+  /* Wait for a reply... */
+  W (ret);
+  return ret;
+}
+static uword unformat_geneve_decap_next
+  (unformat_input_t * input, va_list * args)
+{
+  u32 *result = va_arg (*args, u32 *);
+  u32 tmp;
+
+  if (unformat (input, "l2"))
+    *result = GENEVE_INPUT_NEXT_L2_INPUT;
+  else if (unformat (input, "%d", &tmp))
+    *result = tmp;
+  else
+    return 0;
+  return 1;
+}
+
+static int
+api_geneve_add_del_tunnel2 (vat_main_t * vam)
+{
+  return 0; // NOT YET IMPLEMENTED
+}
+
+static int
+api_geneve_add_del_tunnel (vat_main_t * vam)
+{
+  unformat_input_t *line_input = vam->input;
+  vl_api_geneve_add_del_tunnel_t *mp;
+  ip46_address_t src, dst;
+  u8 is_add = 1;
+  u8 ipv4_set = 0, ipv6_set = 0;
+  u8 src_set = 0;
+  u8 dst_set = 0;
+  u8 grp_set = 0;
+  u32 mcast_sw_if_index = ~0;
+  u32 encap_vrf_id = 0;
+  u32 decap_next_index = ~0;
+  u32 vni = 0;
+  int ret;
+
+  /* Can't "universally zero init" (={0}) due to GCC bug 53119 */
+  clib_memset (&src, 0, sizeof src);
+  clib_memset (&dst, 0, sizeof dst);
+
+  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (line_input, "del"))
+	is_add = 0;
+      else
+	if (unformat (line_input, "src %U", unformat_ip4_address, &src.ip4))
+	{
+	  ipv4_set = 1;
+	  src_set = 1;
+	}
+      else
+	if (unformat (line_input, "dst %U", unformat_ip4_address, &dst.ip4))
+	{
+	  ipv4_set = 1;
+	  dst_set = 1;
+	}
+      else
+	if (unformat (line_input, "src %U", unformat_ip6_address, &src.ip6))
+	{
+	  ipv6_set = 1;
+	  src_set = 1;
+	}
+      else
+	if (unformat (line_input, "dst %U", unformat_ip6_address, &dst.ip6))
+	{
+	  ipv6_set = 1;
+	  dst_set = 1;
+	}
+      else if (unformat (line_input, "group %U %U",
+			 unformat_ip4_address, &dst.ip4,
+			 unformat_sw_if_index, vam, &mcast_sw_if_index))
+	{
+	  grp_set = dst_set = 1;
+	  ipv4_set = 1;
+	}
+      else if (unformat (line_input, "group %U",
+			 unformat_ip4_address, &dst.ip4))
+	{
+	  grp_set = dst_set = 1;
+	  ipv4_set = 1;
+	}
+      else if (unformat (line_input, "group %U %U",
+			 unformat_ip6_address, &dst.ip6,
+			 unformat_sw_if_index, vam, &mcast_sw_if_index))
+	{
+	  grp_set = dst_set = 1;
+	  ipv6_set = 1;
+	}
+      else if (unformat (line_input, "group %U",
+			 unformat_ip6_address, &dst.ip6))
+	{
+	  grp_set = dst_set = 1;
+	  ipv6_set = 1;
+	}
+      else
+	if (unformat (line_input, "mcast_sw_if_index %u", &mcast_sw_if_index))
+	;
+      else if (unformat (line_input, "encap-vrf-id %d", &encap_vrf_id))
+	;
+      else if (unformat (line_input, "decap-next %U",
+			 unformat_geneve_decap_next, &decap_next_index))
+	;
+      else if (unformat (line_input, "vni %d", &vni))
+	;
+      else
+	{
+	  errmsg ("parse error '%U'", format_unformat_error, line_input);
+	  return -99;
+	}
+    }
+
+  if (src_set == 0)
+    {
+      errmsg ("tunnel src address not specified");
+      return -99;
+    }
+  if (dst_set == 0)
+    {
+      errmsg ("tunnel dst address not specified");
+      return -99;
+    }
+
+  if (grp_set && !ip46_address_is_multicast (&dst))
+    {
+      errmsg ("tunnel group address not multicast");
+      return -99;
+    }
+  if (grp_set && mcast_sw_if_index == ~0)
+    {
+      errmsg ("tunnel nonexistent multicast device");
+      return -99;
+    }
+  if (grp_set == 0 && ip46_address_is_multicast (&dst))
+    {
+      errmsg ("tunnel dst address must be unicast");
+      return -99;
+    }
+
+
+  if (ipv4_set && ipv6_set)
+    {
+      errmsg ("both IPv4 and IPv6 addresses specified");
+      return -99;
+    }
+
+  if ((vni == 0) || (vni >> 24))
+    {
+      errmsg ("vni not specified or out of range");
+      return -99;
+    }
+
+  M (GENEVE_ADD_DEL_TUNNEL, mp);
+
+  if (ipv6_set)
+    {
+      clib_memcpy (&mp->local_address.un.ip6, &src.ip6, sizeof (src.ip6));
+      clib_memcpy (&mp->remote_address.un.ip6, &dst.ip6, sizeof (dst.ip6));
+    }
+  else
+    {
+      clib_memcpy (&mp->local_address.un.ip4, &src.ip4, sizeof (src.ip4));
+      clib_memcpy (&mp->remote_address.un.ip4, &dst.ip4, sizeof (dst.ip4));
+    }
+  mp->encap_vrf_id = ntohl (encap_vrf_id);
+  mp->decap_next_index = ntohl (decap_next_index);
+  mp->mcast_sw_if_index = ntohl (mcast_sw_if_index);
+  mp->vni = ntohl (vni);
+  mp->is_add = is_add;
+
+  S (mp);
+  W (ret);
+  return ret;
+}
+
+static void vl_api_geneve_tunnel_details_t_handler
+  (vl_api_geneve_tunnel_details_t * mp)
+{
+  vat_main_t *vam = &vat_main;
+  ip46_address_t src = {.as_u64[0] = 0,.as_u64[1] = 0 };
+  ip46_address_t dst = {.as_u64[0] = 0,.as_u64[1] = 0 };
+
+  if (mp->src_address.af == ADDRESS_IP6)
+    {
+      clib_memcpy (&src.ip6, &mp->src_address.un.ip6, sizeof (ip6_address_t));
+      clib_memcpy (&dst.ip6, &mp->dst_address.un.ip6, sizeof (ip6_address_t));
+    }
+  else
+    {
+      clib_memcpy (&src.ip4, &mp->src_address.un.ip4, sizeof (ip4_address_t));
+      clib_memcpy (&dst.ip4, &mp->dst_address.un.ip4, sizeof (ip4_address_t));
+    }
+
+  print (vam->ofp, "%11d%24U%24U%14d%18d%13d%19d",
+	 ntohl (mp->sw_if_index),
+	 format_ip46_address, &src, IP46_TYPE_ANY,
+	 format_ip46_address, &dst, IP46_TYPE_ANY,
+	 ntohl (mp->encap_vrf_id),
+	 ntohl (mp->decap_next_index), ntohl (mp->vni),
+	 ntohl (mp->mcast_sw_if_index));
+}
+
+static int
+api_geneve_tunnel_dump (vat_main_t * vam)
+{
+  unformat_input_t *i = vam->input;
+  vl_api_geneve_tunnel_dump_t *mp;
+  vl_api_control_ping_t *mp_ping;
+  u32 sw_if_index;
+  u8 sw_if_index_set = 0;
+  int ret;
+  geneve_test_main_t *gm = &geneve_test_main;
+
+  /* Parse args required to build the message */
+  while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
+    {
+      if (unformat (i, "sw_if_index %d", &sw_if_index))
+	sw_if_index_set = 1;
+      else
+	break;
+    }
+
+  if (sw_if_index_set == 0)
+    {
+      sw_if_index = ~0;
+    }
+
+  if (!vam->json_output)
+    {
+      print (vam->ofp, "%11s%24s%24s%14s%18s%13s%19s",
+	     "sw_if_index", "local_address", "remote_address",
+	     "encap_vrf_id", "decap_next_index", "vni", "mcast_sw_if_index");
+    }
+
+  /* Get list of geneve-tunnel interfaces */
+  M (GENEVE_TUNNEL_DUMP, mp);
+
+  mp->sw_if_index = htonl (sw_if_index);
+
+  S (mp);
+
+  /* Use a control ping for synchronization */
+  if (!gm->ping_id)
+    gm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
+  mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
+  mp_ping->_vl_msg_id = htons (gm->ping_id);
+  mp_ping->client_index = vam->my_client_index;
+  S (mp_ping);
+
+  W (ret);
+  return ret;
+}
+
+#include <vnet/geneve/geneve.api_test.c>
+VAT_REGISTER_FEATURE_FUNCTION(vat_geneve_plugin_register);
+
diff --git a/src/vnet/vnet_all_api_h.h b/src/vnet/vnet_all_api_h.h
index 800c5b75037..88eaa851136 100644
--- a/src/vnet/vnet_all_api_h.h
+++ b/src/vnet/vnet_all_api_h.h
@@ -44,7 +44,6 @@
 #include <vnet/span/span.api.h>
 #include <vnet/ip/ip.api.h>
 #include <vnet/vxlan/vxlan.api.h>
-#include <vnet/geneve/geneve.api.h>
 #include <vnet/lldp/lldp.api.h>
 #include <vnet/vxlan-gpe/vxlan_gpe.api.h>
 #include <vnet/bfd/bfd.api.h>