pppoe: remove api boilerplate 82/22482/2
authorOle Troan <ot@cisco.com>
Wed, 2 Oct 2019 14:53:58 +0000 (16:53 +0200)
committerDamjan Marion <dmarion@me.com>
Thu, 3 Oct 2019 12:38:46 +0000 (12:38 +0000)
Type: refactor
Signed-off-by: Ole Troan <ot@cisco.com>
Change-Id: I42705c508e88dae40a4c19ab20a1340623a57e16

src/plugins/pppoe/CMakeLists.txt
src/plugins/pppoe/pppoe.api
src/plugins/pppoe/pppoe_all_api_h.h [deleted file]
src/plugins/pppoe/pppoe_api.c
src/plugins/pppoe/pppoe_msg_enum.h [deleted file]
src/plugins/pppoe/pppoe_test.c

index 33f9b57..4da57a6 100644 (file)
@@ -26,10 +26,6 @@ add_vpp_plugin(pppoe
   API_FILES
   pppoe.api
 
-  INSTALL_HEADERS
-  pppoe_all_api_h.h
-  pppoe_msg_enum.h
-
   API_TEST_SOURCES
   pppoe_test.c
 )
index b687d51..5f04233 100644 (file)
@@ -35,6 +35,7 @@ define pppoe_add_del_session
   u8 client_ip[16];
   u32 decap_vrf_id;
   u8 client_mac[6];
+  option vat_help = "client-addr <client-addr> session-id <nn> [encap-if-index <nn>] [decap-next [ip4|ip6|node <name>]] local-mac <local-mac> client-mac <client-mac> [del]";
 };
 
 /** \brief reply for set or delete an PPPOE session
@@ -59,6 +60,7 @@ define pppoe_session_dump
   u32 client_index;
   u32 context;
   u32 sw_if_index;
+  option vat_help = "[<intfc> | sw_if_index <nn>]";
 };
 
 /** \brief dump details of an PPPOE session
diff --git a/src/plugins/pppoe/pppoe_all_api_h.h b/src/plugins/pppoe/pppoe_all_api_h.h
deleted file mode 100644 (file)
index 393c768..0000000
+++ /dev/null
@@ -1,18 +0,0 @@
-/*
- * pppoe_all_api_h.h - plug-in api #include file
- *
- * Copyright (c) 2017 Intel 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 <pppoe/pppoe.api.h>
index 638505c..ccff405 100644 (file)
 
 #include <pppoe/pppoe.h>
 
-
-#define vl_msg_id(n,h) n,
-typedef enum
-{
-#include <pppoe/pppoe.api.h>
-  /* We'll want to know how many messages IDs we need... */
-  VL_MSG_FIRST_AVAILABLE,
-} vl_msg_id_t;
-#undef vl_msg_id
-
-/* define message structures */
-#define vl_typedefs
-#include <pppoe/pppoe.api.h>
-#undef vl_typedefs
-
-/* define generated endian-swappers */
-#define vl_endianfun
-#include <pppoe/pppoe.api.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 <pppoe/pppoe.api.h>
-#undef vl_printfun
-
-/* Get the API version number */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <pppoe/pppoe.api.h>
-#undef vl_api_version
-
-#define vl_msg_name_crc_list
-#include <pppoe/pppoe.api.h>
-#undef vl_msg_name_crc_list
+#include <pppoe/pppoe.api_enum.h>
+#include <pppoe/pppoe.api_types.h>
 
 #define REPLY_MSG_ID_BASE pem->msg_id_base
 #include <vlibapi/api_helper_macros.h>
 
-static void
-setup_message_id_table (pppoe_main_t * pem, api_main_t * am)
-{
-#define _(id,n,crc) \
-  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + pem->msg_id_base);
-  foreach_vl_msg_name_crc_pppoe;
-#undef _
-}
-
-#define foreach_pppoe_plugin_api_msg                             \
-_(PPPOE_ADD_DEL_SESSION, pppoe_add_del_session)                           \
-_(PPPOE_SESSION_DUMP, pppoe_session_dump)
-
 static void vl_api_pppoe_add_del_session_t_handler
   (vl_api_pppoe_add_del_session_t * mp)
 {
@@ -184,30 +139,13 @@ vl_api_pppoe_session_dump_t_handler (vl_api_pppoe_session_dump_t * mp)
     }
 }
 
-
+#include <pppoe/pppoe.api.c>
 static clib_error_t *
 pppoe_api_hookup (vlib_main_t * vm)
 {
   pppoe_main_t *pem = &pppoe_main;
 
-  u8 *name = format (0, "pppoe_%08x%c", api_version, 0);
-  pem->msg_id_base = vl_msg_api_get_msg_ids
-    ((char *) name, VL_MSG_FIRST_AVAILABLE);
-
-#define _(N,n)                                                  \
-    vl_msg_api_set_handlers((VL_API_##N + pem->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_pppoe_plugin_api_msg;
-#undef _
-
-  /* Add our API messages to the global name_crc hash table */
-  setup_message_id_table (pem, &api_main);
-
+  pem->msg_id_base = setup_message_id_table ();
   return 0;
 }
 
diff --git a/src/plugins/pppoe/pppoe_msg_enum.h b/src/plugins/pppoe/pppoe_msg_enum.h
deleted file mode 100644 (file)
index 7ca1918..0000000
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * pppoe_msg_enum.h - vpp engine plug-in message enumeration
- *
- * Copyright (c) 2017 Intel 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_pppoe_msg_enum_h
-#define included_pppoe_msg_enum_h
-
-#include <vppinfra/byte_order.h>
-
-#define vl_msg_id(n,h) n,
-typedef enum
-{
-#include <pppoe/pppoe_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_pppoe_msg_enum_h */
index d8ad19d..72d1865 100644 (file)
@@ -61,35 +61,8 @@ uword unformat_ip46_prefix (unformat_input_t * input, va_list * args)
 }
 /////////////////////////
 
-#define vl_msg_id(n,h) n,
-typedef enum {
-#include <pppoe/pppoe.api.h>
-    /* We'll want to know how many messages IDs we need... */
-    VL_MSG_FIRST_AVAILABLE,
-} vl_msg_id_t;
-#undef vl_msg_id
-
-/* define message structures */
-#define vl_typedefs
-#include <pppoe/pppoe.api.h>
-#undef vl_typedefs
-
-/* declare message handlers for each api */
-
-#define vl_endianfun             /* define message structures */
-#include <pppoe/pppoe.api.h>
-#undef vl_endianfun
-
-/* instantiate all the print functions we know about */
-#define vl_print(handle, ...)
-#define vl_printfun
-#include <pppoe/pppoe.api.h>
-#undef vl_printfun
-
-/* Get the API version number. */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <pppoe/pppoe.api.h>
-#undef vl_api_version
+#include <pppoe/pppoe.api_enum.h>
+#include <pppoe/pppoe.api_types.h>
 
 typedef struct {
     /* API message ID base */
@@ -116,16 +89,6 @@ static void vl_api_pppoe_add_del_session_reply_t_handler
     }
 }
 
-
-/*
- * Table of message reply handlers, must include boilerplate handlers
- * we just generated
- */
-#define foreach_vpe_api_reply_msg                               \
-  _(PPPOE_ADD_DEL_SESSION_REPLY, pppoe_add_del_session_reply)               \
-  _(PPPOE_SESSION_DETAILS, pppoe_session_details)
-
-
 static int
 api_pppoe_add_del_session (vat_main_t * vam)
 {
@@ -271,42 +234,4 @@ api_pppoe_session_dump (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                                            \
-_(pppoe_add_del_session,                                                 \
-  " client-addr <client-addr> session-id <nn>"                            \
-  " [encap-if-index <nn>] [decap-next [ip4|ip6|node <name>]]"             \
-  " local-mac <local-mac> client-mac <client-mac> [del]") \
-_(pppoe_session_dump, "[<intfc> | sw_if_index <nn>]")                    \
-
-static void
-pppoe_api_hookup (vat_main_t *vam)
-{
-  pppoe_test_main_t * pem = &pppoe_test_main;
-  /* Hook up handlers for replies from the data plane plug-in */
-#define _(N,n)                                                  \
-  vl_msg_api_set_handlers((VL_API_##N + pem->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(pppoe);
+#include <pppoe/pppoe.api_test.c>