cdp: remove api boilerplate 70/22270/5
authorOle Troan <ot@cisco.com>
Wed, 25 Sep 2019 16:24:42 +0000 (18:24 +0200)
committerNeale Ranns <nranns@cisco.com>
Fri, 27 Sep 2019 11:49:11 +0000 (11:49 +0000)
Type: refactor
Signed-off-by: Ole Troan <ot@cisco.com>
Change-Id: I3b4bbbf2574faf8d06546eb72f127fa47479e988
Signed-off-by: Ole Troan <ot@cisco.com>
MAINTAINERS
src/plugins/cdp/CMakeLists.txt
src/plugins/cdp/cdp.c
src/plugins/cdp/cdp_all_api_h.h [deleted file]
src/plugins/cdp/cdp_msg_enum.h [deleted file]
src/plugins/cdp/cdp_test.c

index dcd7bc6..f05688e 100644 (file)
@@ -524,6 +524,10 @@ Plugin - SCTP
 I:     sctp
 F:     src/plugins/sctp/
 
+Cisco Discovery Protocol
+I:     cdp
+F:     src/plugins/cdp/
+
 THE REST
 I:     misc
 C:     Contact vpp-dev Mailing List <vpp-dev@fd.io>
index 53542f0..8220326 100644 (file)
@@ -25,9 +25,7 @@ add_vpp_plugin(cdp
   cdp_test.c
 
   INSTALL_HEADERS
-  cdp_all_api_h.h
   cdp.h
-  cdp_msg_enum.h
   cdp_protocol.h
 )
 
index 2c947a7..1fe557f 100644 (file)
 #include <vpp/app/version.h>
 
 /* define message IDs */
-#include <cdp/cdp_msg_enum.h>
-
-/* define message structures */
-#define vl_typedefs
-#include <cdp/cdp_all_api_h.h>
-#undef vl_typedefs
-
-/* define generated endian-swappers */
-#define vl_endianfun
-#include <cdp/cdp_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 <cdp/cdp_all_api_h.h>
-#undef vl_printfun
-
-/* Get the API version number */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <cdp/cdp_all_api_h.h>
-#undef vl_api_version
+#include <cdp/cdp.api_enum.h>
+#include <cdp/cdp.api_types.h>
 
 #define REPLY_MSG_ID_BASE cm->msg_id_base
 #include <vlibapi/api_helper_macros.h>
 
-/* List of message types that this plugin understands */
-
-#define foreach_cdp_plugin_api_msg                           \
-_(CDP_ENABLE_DISABLE, cdp_enable_disable)
-
 /* Action function shared between message handler and debug CLI */
 
 int
@@ -133,60 +108,18 @@ static void vl_api_cdp_enable_disable_t_handler
   REPLY_MACRO (VL_API_CDP_ENABLE_DISABLE_REPLY);
 }
 
-/* Set up the API message handling tables */
-static clib_error_t *
-cdp_plugin_api_hookup (vlib_main_t * vm)
-{
-  cdp_main_t *cm = &cdp_main;
-#define _(N,n)                                                  \
-    vl_msg_api_set_handlers((VL_API_##N + cm->msg_id_base),     \
-                           #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_cdp_plugin_api_msg;
-#undef _
-
-  return 0;
-}
-
-#define vl_msg_name_crc_list
-#include <cdp/cdp_all_api_h.h>
-#undef vl_msg_name_crc_list
-
-static void
-setup_message_id_table (cdp_main_t * cm, api_main_t * am)
-{
-#define _(id,n,crc)   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + cm->msg_id_base);
-  foreach_vl_msg_name_crc_cdp;
-#undef _
-}
-
+#include <cdp/cdp.api.c>
 static clib_error_t *
 cdp_init (vlib_main_t * vm)
 {
   cdp_main_t *cm = &cdp_main;
-  clib_error_t *error = 0;
-  u8 *name;
 
   cm->vlib_main = vm;
 
-  name = format (0, "cdp_%08x%c", api_version, 0);
-
   /* Ask for a correctly-sized block of API message decode slots */
-  cm->msg_id_base = vl_msg_api_get_msg_ids
-    ((char *) name, VL_MSG_FIRST_AVAILABLE);
-
-  error = cdp_plugin_api_hookup (vm);
-
-  /* Add our API messages to the global name_crc hash table */
-  setup_message_id_table (cm, &api_main);
+  cm->msg_id_base = setup_message_id_table ();
 
-  vec_free (name);
-
-  return error;
+  return 0;
 }
 
 VLIB_INIT_FUNCTION (cdp_init);
diff --git a/src/plugins/cdp/cdp_all_api_h.h b/src/plugins/cdp/cdp_all_api_h.h
deleted file mode 100644 (file)
index cc0047e..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-
-/*
- * cdp_all_api_h.h - cdp plug-in api #include file
- *
- * Copyright (c) 2011-2018 by 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 the generated file, see BUILT_SOURCES in Makefile.am */
-#include <cdp/cdp.api.h>
diff --git a/src/plugins/cdp/cdp_msg_enum.h b/src/plugins/cdp/cdp_msg_enum.h
deleted file mode 100644 (file)
index 0a7bf06..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-
-/*
- * cdp_msg_enum.h - cdp plug-in message enumeration
- *
- * Copyright (c) 2011-2018 by 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 included_cdp_msg_enum_h
-#define included_cdp_msg_enum_h
-
-#include <vppinfra/byte_order.h>
-
-#define vl_msg_id(n,h) n,
-typedef enum {
-#include <cdp/cdp_all_api_h.h>
-    /* We'll want to know how many messages IDs we need... */
-    VL_MSG_FIRST_AVAILABLE,
-} vl_msg_id_t;
-#undef vl_msg_id
-
-#endif /* included_cdp_msg_enum_h */
index 2e24ddc..a936596 100644 (file)
 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
 
 /* Declare message IDs */
-#include <cdp/cdp_msg_enum.h>
-
-/* define message structures */
-#define vl_typedefs
-#include <cdp/cdp_all_api_h.h>
-#undef vl_typedefs
-
-/* declare message handlers for each api */
-
-#define vl_endianfun           /* define message structures */
-#include <cdp/cdp_all_api_h.h>
-#undef vl_endianfun
-
-/* instantiate all the print functions we know about */
-#define vl_print(handle, ...)
-#define vl_printfun
-#include <cdp/cdp_all_api_h.h>
-#undef vl_printfun
-
-/* Get the API version number. */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <cdp/cdp_all_api_h.h>
-#undef vl_api_version
-
+#include <cdp/cdp.api_enum.h>
+#include <cdp/cdp.api_types.h>
 
 typedef struct
 {
@@ -59,25 +37,6 @@ cdp_test_main_t cdp_test_main;
 #define __plugin_msg_base cdp_test_main.msg_id_base
 #include <vlibapi/vat_helper_macros.h>
 
-#define foreach_standard_reply_retval_handler   \
-_(cdp_enable_disable_reply)
-
-#define _(n)                                            \
-    static void vl_api_##n##_t_handler                  \
-    (vl_api_##n##_t * mp)                               \
-    {                                                   \
-        vat_main_t * vam = cdp_test_main.vat_main;   \
-        i32 retval = ntohl(mp->retval);                 \
-        if (vam->async_mode) {                          \
-            vam->async_errors += (retval < 0);          \
-        } else {                                        \
-            vam->retval = retval;                       \
-            vam->result_ready = 1;                      \
-        }                                               \
-    }
-foreach_standard_reply_retval_handler;
-#undef _
-
 /*
  * Table of message reply handlers, must include boilerplate handlers
  * we just generated
@@ -116,41 +75,7 @@ api_cdp_enable_disable (vat_main_t * vam)
   return ret;
 }
 
-/*
- * List of messages that the api test plugin sends,
- * and that the data plane plugin processes
- */
-#define foreach_vpe_api_msg \
-_(cdp_enable_disable, "enable | disable")
-
-static void
-cdp_api_hookup (vat_main_t * vam)
-{
-  cdp_test_main_t *sm = &cdp_test_main;
-  /* Hook up handlers for replies from the data plane plug-in */
-#define _(N,n)                                                  \
-    vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base),     \
-                           #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_reply_msg;
-#undef _
-
-  /* API messages we can send */
-#define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
-  foreach_vpe_api_msg;
-#undef _
-
-  /* Help strings */
-#define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
-  foreach_vpe_api_msg;
-#undef _
-}
-
-VAT_PLUGIN_REGISTER (cdp);
+#include <cdp/cdp.api_test.c>
 
 /*
  * fd.io coding-style-patch-verification: ON