aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOle Troan <ot@cisco.com>2019-10-02 17:09:01 +0200
committerDamjan Marion <dmarion@me.com>2019-10-03 12:36:47 +0000
commit2e7a43ca453c677c00d371ea5dfdba71267ab185 (patch)
treef00a18d7b9a8d85af128d76fc7f7829174524e0e
parent025166dc79a6931ea24384b2f27c6c11081d06c9 (diff)
nsim: remove api boilerplate
Type: refactor Signed-off-by: Ole Troan <ot@cisco.com> Change-Id: Idf2206ae3e3d8dd05e98528ee1f02c4c7d567f37
-rw-r--r--src/plugins/nsim/CMakeLists.txt4
-rw-r--r--src/plugins/nsim/nsim.api3
-rw-r--r--src/plugins/nsim/nsim.c79
-rw-r--r--src/plugins/nsim/nsim_all_api_h.h19
-rw-r--r--src/plugins/nsim/nsim_msg_enum.h31
-rw-r--r--src/plugins/nsim/nsim_test.c98
6 files changed, 11 insertions, 223 deletions
diff --git a/src/plugins/nsim/CMakeLists.txt b/src/plugins/nsim/CMakeLists.txt
index 6b261f8d266..e4cd79cc3da 100644
--- a/src/plugins/nsim/CMakeLists.txt
+++ b/src/plugins/nsim/CMakeLists.txt
@@ -24,10 +24,6 @@ add_vpp_plugin(nsim
API_FILES
nsim.api
- INSTALL_HEADERS
- nsim_all_api_h.h
- nsim_msg_enum.h
-
API_TEST_SOURCES
nsim_test.c
)
diff --git a/src/plugins/nsim/nsim.api b/src/plugins/nsim/nsim.api
index 42531cd2e0f..722aac17fed 100644
--- a/src/plugins/nsim/nsim.api
+++ b/src/plugins/nsim/nsim.api
@@ -26,6 +26,7 @@ autoreply define nsim_cross_connect_enable_disable
/* Interface handles */
u32 sw_if_index0;
u32 sw_if_index1;
+ option vat_help = "[<intfc0> | sw_if_index <swif0>] [<intfc1> | sw_if_index <swif1>] [disable]";
};
/** \brief enable / disable the network delay simulation output feature
@@ -47,6 +48,7 @@ autoreply define nsim_output_feature_enable_disable
/* Interface handles */
u32 sw_if_index;
+ option vat_help = "[<intfc> | sw_if_index <nnn> [disable]";
};
/** \brief configure the network delay simulation cross-connect
@@ -69,6 +71,7 @@ autoreply define nsim_configure
u32 average_packet_size;
u64 bandwidth_in_bits_per_second;
u32 packets_per_drop;
+ option vat_help = "delay <time> bandwidth <bw> [packet-size <nn>] [packets-per-drop <nnnn>]";
};
diff --git a/src/plugins/nsim/nsim.c b/src/plugins/nsim/nsim.c
index a8c00337364..5bc9eaecdd6 100644
--- a/src/plugins/nsim/nsim.c
+++ b/src/plugins/nsim/nsim.c
@@ -30,41 +30,14 @@
#include <vpp/app/version.h>
/* define message IDs */
-#include <nsim/nsim_msg_enum.h>
-
-/* define message structures */
-#define vl_typedefs
-#include <nsim/nsim_all_api_h.h>
-#undef vl_typedefs
-
-/* define generated endian-swappers */
-#define vl_endianfun
-#include <nsim/nsim_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 <nsim/nsim_all_api_h.h>
-#undef vl_printfun
-
-/* Get the API version number */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <nsim/nsim_all_api_h.h>
-#undef vl_api_version
+#include <nsim/nsim.api_enum.h>
+#include <nsim/nsim.api_types.h>
#define REPLY_MSG_ID_BASE nsm->msg_id_base
#include <vlibapi/api_helper_macros.h>
nsim_main_t nsim_main;
-/* List of message types that this plugin understands */
-
-#define foreach_nsim_plugin_api_msg \
-_(NSIM_CROSS_CONNECT_ENABLE_DISABLE, nsim_cross_connect_enable_disable) \
-_(NSIM_OUTPUT_FEATURE_ENABLE_DISABLE, nsim_output_feature_enable_disable) \
-_(NSIM_CONFIGURE, nsim_configure)
-
/* Action functions shared between message handlers and debug CLI */
int
@@ -503,61 +476,19 @@ VLIB_CLI_COMMAND (nsim_output_feature_enable_disable_command, static) =
};
/* *INDENT-ON* */
-/* Set up the API message handling tables */
-static clib_error_t *
-nsim_plugin_api_hookup (vlib_main_t * vm)
-{
- nsim_main_t *nsm = &nsim_main;
-#define _(N,n) \
- vl_msg_api_set_handlers((VL_API_##N + nsm->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_nsim_plugin_api_msg;
-#undef _
-
- return 0;
-}
-
-#define vl_msg_name_crc_list
-#include <nsim/nsim_all_api_h.h>
-#undef vl_msg_name_crc_list
-
-static void
-setup_message_id_table (nsim_main_t * nsm, api_main_t * am)
-{
-#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + nsm->msg_id_base);
- foreach_vl_msg_name_crc_nsim;
-#undef _
-}
-
+#include <nsim/nsim.api.c>
static clib_error_t *
nsim_init (vlib_main_t * vm)
{
nsim_main_t *nsm = &nsim_main;
- clib_error_t *error = 0;
- u8 *name;
nsm->vlib_main = vm;
nsm->vnet_main = vnet_get_main ();
- name = format (0, "nsim_%08x%c", api_version, 0);
-
/* Ask for a correctly-sized block of API message decode slots */
- nsm->msg_id_base = vl_msg_api_get_msg_ids
- ((char *) name, VL_MSG_FIRST_AVAILABLE);
-
- error = nsim_plugin_api_hookup (vm);
-
- /* Add our API messages to the global name_crc hash table */
- setup_message_id_table (nsm, &api_main);
+ nsm->msg_id_base = setup_message_id_table ();
- vec_free (name);
-
- return error;
+ return 0;
}
VLIB_INIT_FUNCTION (nsim_init);
diff --git a/src/plugins/nsim/nsim_all_api_h.h b/src/plugins/nsim/nsim_all_api_h.h
deleted file mode 100644
index ca54bba2e6c..00000000000
--- a/src/plugins/nsim/nsim_all_api_h.h
+++ /dev/null
@@ -1,19 +0,0 @@
-
-/*
- * nsim_all_api_h.h - skeleton vpp engine plug-in api #include file
- *
- * Copyright (c) <current-year> <your-organization>
- * 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 <nsim/nsim.api.h>
diff --git a/src/plugins/nsim/nsim_msg_enum.h b/src/plugins/nsim/nsim_msg_enum.h
deleted file mode 100644
index 116146f5d13..00000000000
--- a/src/plugins/nsim/nsim_msg_enum.h
+++ /dev/null
@@ -1,31 +0,0 @@
-
-/*
- * nsim_msg_enum.h - skeleton vpp engine plug-in message enumeration
- *
- * Copyright (c) <current-year> <your-organization>
- * 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_nsim_msg_enum_h
-#define included_nsim_msg_enum_h
-
-#include <vppinfra/byte_order.h>
-
-#define vl_msg_id(n,h) n,
-typedef enum {
-#include <nsim/nsim_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_nsim_msg_enum_h */
diff --git a/src/plugins/nsim/nsim_test.c b/src/plugins/nsim/nsim_test.c
index 3e38bd04305..b155c923f87 100644
--- a/src/plugins/nsim/nsim_test.c
+++ b/src/plugins/nsim/nsim_test.c
@@ -22,30 +22,8 @@
uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
/* Declare message IDs */
-#include <nsim/nsim_msg_enum.h>
-
-/* define message structures */
-#define vl_typedefs
-#include <nsim/nsim_all_api_h.h>
-#undef vl_typedefs
-
-/* declare message handlers for each api */
-
-#define vl_endianfun /* define message structures */
-#include <nsim/nsim_all_api_h.h>
-#undef vl_endianfun
-
-/* instantiate all the print functions we know about */
-#define vl_print(handle, ...)
-#define vl_printfun
-#include <nsim/nsim_all_api_h.h>
-#undef vl_printfun
-
-/* Get the API version number. */
-#define vl_api_version(n,v) static u32 api_version=(v);
-#include <nsim/nsim_all_api_h.h>
-#undef vl_api_version
-
+#include <nsim/nsim.api_enum.h>
+#include <nsim/nsim.api_types.h>
typedef struct
{
@@ -59,38 +37,6 @@ nsim_test_main_t nsim_test_main;
#define __plugin_msg_base nsim_test_main.msg_id_base
#include <vlibapi/vat_helper_macros.h>
-#define foreach_standard_reply_retval_handler \
-_(nsim_cross_connect_enable_disable_reply) \
-_(nsim_output_feature_enable_disable_reply) \
-_(nsim_configure_reply)
-
-#define _(n) \
- static void vl_api_##n##_t_handler \
- (vl_api_##n##_t * mp) \
- { \
- vat_main_t * vam = nsim_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 \
-_(NSIM_CROSS_CONNECT_ENABLE_DISABLE_REPLY, \
-nsim_cross_connect_enable_disable_reply) \
-_(NSIM_OUTPUT_FEATURE_ENABLE_DISABLE_REPLY, \
-nsim_output_feature_enable_disable_reply) \
-_(NSIM_CONFIGURE_REPLY, nsim_configure_reply)
-
static int
api_nsim_cross_connect_enable_disable (vat_main_t * vam)
{
@@ -268,45 +214,7 @@ api_nsim_configure (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 \
-_(nsim_cross_connect_enable_disable, \
-"[<intfc0> | sw_if_index <swif0>] [<intfc1> | sw_if_index <swif1>] [disable]") \
-_(nsim_output_feature_enable_disable,"[<intfc> | sw_if_index <nnn> [disable]") \
-_(nsim_configure, "delay <time> bandwidth <bw> [packet-size <nn>]" \
-"[packets-per-drop <nnnn>]")
-
-static void
-nsim_api_hookup (vat_main_t * vam)
-{
- nsim_test_main_t *sm = &nsim_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 (nsim);
+#include <nsim/nsim.api_test.c>
/*
* fd.io coding-style-patch-verification: ON