oddbuf: remove api boilerplate 85/22485/2
authorOle Troan <ot@cisco.com>
Wed, 2 Oct 2019 15:00:30 +0000 (17:00 +0200)
committerDamjan Marion <dmarion@me.com>
Thu, 3 Oct 2019 12:38:03 +0000 (12:38 +0000)
Type: refactor
Change-Id: Ic4922da46bf941249dd74b1a8bc6a98c62c099b7
Signed-off-by: Ole Troan <ot@cisco.com>
MAINTAINERS
src/plugins/oddbuf/CMakeLists.txt
src/plugins/oddbuf/oddbuf.api
src/plugins/oddbuf/oddbuf.c
src/plugins/oddbuf/oddbuf_all_api_h.h [deleted file]
src/plugins/oddbuf/oddbuf_msg_enum.h [deleted file]
src/plugins/oddbuf/oddbuf_test.c

index 268e3c3..03489a8 100644 (file)
@@ -547,6 +547,10 @@ Steal The NIC
 I:     stn
 F:     src/plugins/stn
 
+Awkward chained buffer geometry tool
+I:     oddbuf
+F:     src/plugins/oddbuf
+
 THE REST
 I:     misc
 C:     Contact vpp-dev Mailing List <vpp-dev@fd.io>
index cee0524..9720e92 100644 (file)
@@ -24,10 +24,6 @@ add_vpp_plugin(oddbuf
   API_FILES
   oddbuf.api
 
-  INSTALL_HEADERS
-  oddbuf_all_api_h.h
-  oddbuf_msg_enum.h
-
   API_TEST_SOURCES
   oddbuf_test.c
 )
index b63dc5d..42a63c6 100644 (file)
@@ -48,4 +48,5 @@ autoreply define oddbuf_enable_disable {
 
     /* Interface handle */
     vl_api_interface_index_t sw_if_index;
+    option vat_help = "<intfc> [disable]";
 };
index 9b95fcc..8277836 100644 (file)
 #include <stdbool.h>
 
 /* define message IDs */
-#include <oddbuf/oddbuf_msg_enum.h>
-
-/* define message structures */
-#define vl_typedefs
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_typedefs
-
-/* define generated endian-swappers */
-#define vl_endianfun
-#include <oddbuf/oddbuf_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 <oddbuf/oddbuf_all_api_h.h>
-#undef vl_printfun
-
-/* Get the API version number */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_api_version
+#include <oddbuf/oddbuf.api_enum.h>
+#include <oddbuf/oddbuf.api_types.h>
 
 #define REPLY_MSG_ID_BASE omp->msg_id_base
 #include <vlibapi/api_helper_macros.h>
 
 oddbuf_main_t oddbuf_main;
 
-/* List of message types that this plugin understands */
-
-#define foreach_oddbuf_plugin_api_msg                           \
-_(ODDBUF_ENABLE_DISABLE, oddbuf_enable_disable)
-
 /* Action function shared between message handler and debug CLI */
 
 int
@@ -159,65 +134,24 @@ static void vl_api_oddbuf_enable_disable_t_handler
   REPLY_MACRO (VL_API_ODDBUF_ENABLE_DISABLE_REPLY);
 }
 
-/* Set up the API message handling tables */
-static clib_error_t *
-oddbuf_plugin_api_hookup (vlib_main_t * vm)
-{
-  oddbuf_main_t *omp = &oddbuf_main;
-#define _(N,n)                                                  \
-    vl_msg_api_set_handlers((VL_API_##N + omp->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_oddbuf_plugin_api_msg;
-#undef _
-
-  return 0;
-}
-
-#define vl_msg_name_crc_list
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_msg_name_crc_list
-
-static void
-setup_message_id_table (oddbuf_main_t * omp, api_main_t * am)
-{
-#define _(id,n,crc)   vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + omp->msg_id_base);
-  foreach_vl_msg_name_crc_oddbuf;
-#undef _
-}
-
+#include <oddbuf/oddbuf.api.c>
 static clib_error_t *
 oddbuf_init (vlib_main_t * vm)
 {
   oddbuf_main_t *om = &oddbuf_main;
   clib_error_t *error = 0;
-  u8 *name;
 
   om->vlib_main = vm;
   om->vnet_main = vnet_get_main ();
 
-  name = format (0, "oddbuf_%08x%c", api_version, 0);
-
   /* Ask for a correctly-sized block of API message decode slots */
-  om->msg_id_base = vl_msg_api_get_msg_ids
-    ((char *) name, VL_MSG_FIRST_AVAILABLE);
-
-  error = oddbuf_plugin_api_hookup (vm);
-
-  /* Add our API messages to the global name_crc hash table */
-  setup_message_id_table (om, &api_main);
+  om->msg_id_base = setup_message_id_table ();
 
   /* Basic setup */
   om->n_to_copy = 1;
   om->second_chunk_offset = 1;
   om->first_chunk_offset = 0;
 
-  vec_free (name);
-
   return error;
 }
 
diff --git a/src/plugins/oddbuf/oddbuf_all_api_h.h b/src/plugins/oddbuf/oddbuf_all_api_h.h
deleted file mode 100644 (file)
index 3aac2a0..0000000
+++ /dev/null
@@ -1,19 +0,0 @@
-
-/*
- * oddbuf_all_api_h.h awkward chained buffer geometry test tool
- *
- * Copyright (c) 2019 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 <oddbuf/oddbuf.api.h>
diff --git a/src/plugins/oddbuf/oddbuf_msg_enum.h b/src/plugins/oddbuf/oddbuf_msg_enum.h
deleted file mode 100644 (file)
index 084c049..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-
-/*
- * oddbuf_msg_enum.h - awkward chained buffer geometry test tool
- *
- * Copyright (c) 2019 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_oddbuf_msg_enum_h
-#define included_oddbuf_msg_enum_h
-
-#include <vppinfra/byte_order.h>
-
-#define vl_msg_id(n,h) n,
-typedef enum {
-#include <oddbuf/oddbuf_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_oddbuf_msg_enum_h */
index 25c0bc0..4bae577 100644 (file)
 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
 
 /* Declare message IDs */
-#include <oddbuf/oddbuf_msg_enum.h>
-
-/* define message structures */
-#define vl_typedefs
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_typedefs
-
-/* declare message handlers for each api */
-
-#define vl_endianfun           /* define message structures */
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_endianfun
-
-/* instantiate all the print functions we know about */
-#define vl_print(handle, ...)
-#define vl_printfun
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_printfun
-
-/* Get the API version number. */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <oddbuf/oddbuf_all_api_h.h>
-#undef vl_api_version
-
+#include <oddbuf/oddbuf.api_enum.h>
+#include <oddbuf/oddbuf.api_types.h>
 
 typedef struct
 {
@@ -60,33 +38,6 @@ oddbuf_test_main_t oddbuf_test_main;
 #define __plugin_msg_base oddbuf_test_main.msg_id_base
 #include <vlibapi/vat_helper_macros.h>
 
-#define foreach_standard_reply_retval_handler   \
-_(oddbuf_enable_disable_reply)
-
-#define _(n)                                            \
-    static void vl_api_##n##_t_handler                  \
-    (vl_api_##n##_t * mp)                               \
-    {                                                   \
-        vat_main_t * vam = oddbuf_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
- */
-#define foreach_vpe_api_reply_msg                                       \
-_(ODDBUF_ENABLE_DISABLE_REPLY, oddbuf_enable_disable_reply)
-
-
 static int
 api_oddbuf_enable_disable (vat_main_t * vam)
 {
@@ -128,41 +79,7 @@ api_oddbuf_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 \
-_(oddbuf_enable_disable, "<intfc> [disable]")
-
-static void
-oddbuf_api_hookup (vat_main_t * vam)
-{
-  oddbuf_test_main_t *otmp = &oddbuf_test_main;
-  /* Hook up handlers for replies from the data plane plug-in */
-#define _(N,n)                                                  \
-    vl_msg_api_set_handlers((VL_API_##N + otmp->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 (oddbuf);
+#include <oddbuf/oddbuf.api_test.c>
 
 /*
  * fd.io coding-style-patch-verification: ON