From 2a1ca787b9ca0021bd5da73450caedc2ff41c76d Mon Sep 17 00:00:00 2001 From: Ole Troan Date: Thu, 19 Sep 2019 01:08:30 +0200 Subject: api: split api generated files Split generation of API message enum and the typedefs into separate files, so that the type file can be included from elsewhere. Generate a C file for VPP that contains the API registration, this was previously done via X macros by the C pre- processor. This allows deleting lots of skeleton/copy paste code for each feature. plugins/flowprobe plugins/map examples/sample-plugin vnet/ipip used as Guinea pigs. Generate a C Test file for VAT, that does the same for VAT plugins. Also add support for a per-message CLI option, that is currently limited to VAT help text. option vat_help = ""; Type: refactor Change-Id: I245e3104bb76f7e1fb69a59ab20cc7c8dfcdd460 Signed-off-by: Ole Troan --- src/plugins/flowprobe/CMakeLists.txt | 4 -- src/plugins/flowprobe/flowprobe.api | 2 + src/plugins/flowprobe/flowprobe.c | 83 ++------------------------- src/plugins/flowprobe/flowprobe_all_api_h.h | 18 ------ src/plugins/flowprobe/flowprobe_msg_enum.h | 31 ---------- src/plugins/flowprobe/flowprobe_test.c | 87 +---------------------------- 6 files changed, 11 insertions(+), 214 deletions(-) delete mode 100644 src/plugins/flowprobe/flowprobe_all_api_h.h delete mode 100644 src/plugins/flowprobe/flowprobe_msg_enum.h (limited to 'src/plugins/flowprobe') diff --git a/src/plugins/flowprobe/CMakeLists.txt b/src/plugins/flowprobe/CMakeLists.txt index b6e4996b20b..4c1d4f33320 100644 --- a/src/plugins/flowprobe/CMakeLists.txt +++ b/src/plugins/flowprobe/CMakeLists.txt @@ -19,10 +19,6 @@ add_vpp_plugin(flowprobe API_FILES flowprobe.api - INSTALL_HEADERS - flowprobe_all_api_h.h - flowprobe_msg_enum.h - API_TEST_SOURCES flowprobe_test.c ) diff --git a/src/plugins/flowprobe/flowprobe.api b/src/plugins/flowprobe/flowprobe.api index 5bbe011f363..830e4420e4e 100644 --- a/src/plugins/flowprobe/flowprobe.api +++ b/src/plugins/flowprobe/flowprobe.api @@ -28,6 +28,7 @@ autoreply manual_print define flowprobe_tx_interface_add_del /* Interface handle */ u32 sw_if_index; + option vat_help = " [disable]"; }; autoreply define flowprobe_params @@ -39,4 +40,5 @@ autoreply define flowprobe_params u8 record_l4; u32 active_timer; /* ~0 is off, 0 is default */ u32 passive_timer; /* ~0 is off, 0 is default */ + option vat_help = "record <[l2] [l3] [l4]> [active passive ]"; }; diff --git a/src/plugins/flowprobe/flowprobe.c b/src/plugins/flowprobe/flowprobe.c index 45de3a76be6..0b070219abd 100644 --- a/src/plugins/flowprobe/flowprobe.c +++ b/src/plugins/flowprobe/flowprobe.c @@ -32,34 +32,14 @@ #include /* define message IDs */ -#include - -/* define message structures */ -#define vl_typedefs -#include -#undef vl_typedefs - -/* define generated endian-swappers */ -#define vl_endianfun -#include -#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 -#undef vl_printfun +#include +#include flowprobe_main_t flowprobe_main; static vlib_node_registration_t flowprobe_timer_node; uword flowprobe_walker_process (vlib_main_t * vm, vlib_node_runtime_t * rt, vlib_frame_t * f); -/* Get the API version number */ -#define vl_api_version(n,v) static u32 api_version=(v); -#include -#undef vl_api_version - #define REPLY_MSG_ID_BASE fm->msg_id_base #include @@ -88,6 +68,7 @@ VNET_FEATURE_INIT (flow_perpacket_l2, static) = /* *INDENT-ON* */ /* Macro to finish up custom dump fns */ +#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__) #define FINISH \ vec_add1 (s, 0); \ vl_print (handle, (char *)s); \ @@ -756,11 +737,6 @@ vl_api_flowprobe_params_t_handler (vl_api_flowprobe_params_t * mp) REPLY_MACRO (VL_API_FLOWPROBE_PARAMS_REPLY); } -/* List of message types that this plugin understands */ -#define foreach_flowprobe_plugin_api_msg \ -_(FLOWPROBE_TX_INTERFACE_ADD_DEL, flowprobe_tx_interface_add_del) \ -_(FLOWPROBE_PARAMS, flowprobe_params) - /* *INDENT-OFF* */ VLIB_PLUGIN_REGISTER () = { .version = VPP_BUILD_VER, @@ -980,42 +956,6 @@ VLIB_CLI_COMMAND (flowprobe_show_stats_command, static) = { }; /* *INDENT-ON* */ -/** - * @brief Set up the API message handling tables - * @param vm vlib_main_t * vlib main data structure pointer - * @returns 0 to indicate all is well - */ -static clib_error_t * -flowprobe_plugin_api_hookup (vlib_main_t * vm) -{ - flowprobe_main_t *fm = &flowprobe_main; -#define _(N,n) \ - vl_msg_api_set_handlers((VL_API_##N + fm->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_flowprobe_plugin_api_msg; -#undef _ - - return 0; -} - -#define vl_msg_name_crc_list -#include -#undef vl_msg_name_crc_list - -static void -setup_message_id_table (flowprobe_main_t * fm, api_main_t * am) -{ -#define _(id,n,crc) \ - vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + fm->msg_id_base); - foreach_vl_msg_name_crc_flowprobe; -#undef _ -} - /* * Main-core process, sending an interrupt to the per worker input * process that spins the per worker timer wheel. @@ -1076,6 +1016,8 @@ VLIB_REGISTER_NODE (flowprobe_timer_node,static) = { }; /* *INDENT-ON* */ +#include + /** * @brief Set up the API message handling tables * @param vm vlib_main_t * vlib main data structure pointer @@ -1087,26 +1029,13 @@ flowprobe_init (vlib_main_t * vm) flowprobe_main_t *fm = &flowprobe_main; vlib_thread_main_t *tm = &vlib_thread_main; clib_error_t *error = 0; - u8 *name; u32 num_threads; int i; fm->vnet_main = vnet_get_main (); - /* Construct the API name */ - name = format (0, "flowprobe_%08x%c", api_version, 0); - /* Ask for a correctly-sized block of API message decode slots */ - fm->msg_id_base = vl_msg_api_get_msg_ids - ((char *) name, VL_MSG_FIRST_AVAILABLE); - - /* Hook up message handlers */ - error = flowprobe_plugin_api_hookup (vm); - - /* Add our API messages to the global name_crc hash table */ - setup_message_id_table (fm, &api_main); - - vec_free (name); + fm->msg_id_base = setup_message_id_table (); /* Set up time reference pair */ fm->vlib_time_0 = vlib_time_now (vm); diff --git a/src/plugins/flowprobe/flowprobe_all_api_h.h b/src/plugins/flowprobe/flowprobe_all_api_h.h deleted file mode 100644 index 1f30ecccf98..00000000000 --- a/src/plugins/flowprobe/flowprobe_all_api_h.h +++ /dev/null @@ -1,18 +0,0 @@ -/* - * flowprobe_all_api_h.h - plug-in api #include file - * - * Copyright (c) - * 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 diff --git a/src/plugins/flowprobe/flowprobe_msg_enum.h b/src/plugins/flowprobe/flowprobe_msg_enum.h deleted file mode 100644 index bc0b21c96c1..00000000000 --- a/src/plugins/flowprobe/flowprobe_msg_enum.h +++ /dev/null @@ -1,31 +0,0 @@ -/* - * flowprobe_msg_enum.h - vpp engine plug-in message enumeration - * - * Copyright (c) - * 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_flowprobe_msg_enum_h -#define included_flowprobe_msg_enum_h - -#include - -#define vl_msg_id(n,h) n, -typedef enum -{ -#include - /* 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_flowprobe_msg_enum_h */ diff --git a/src/plugins/flowprobe/flowprobe_test.c b/src/plugins/flowprobe/flowprobe_test.c index 53fdb23be5d..245707d417d 100644 --- a/src/plugins/flowprobe/flowprobe_test.c +++ b/src/plugins/flowprobe/flowprobe_test.c @@ -30,29 +30,8 @@ uword unformat_sw_if_index (unformat_input_t * input, va_list * args); /* Declare message IDs */ -#include - -/* define message structures */ -#define vl_typedefs -#include -#undef vl_typedefs - -/* declare message handlers for each api */ - -#define vl_endianfun /* define message structures */ -#include -#undef vl_endianfun - -/* instantiate all the print functions we know about */ -#define vl_print(handle, ...) -#define vl_printfun -#include -#undef vl_printfun - -/* Get the API version number. */ -#define vl_api_version(n,v) static u32 api_version=(v); -#include -#undef vl_api_version +#include +#include typedef struct { @@ -64,35 +43,6 @@ typedef struct flowprobe_test_main_t flowprobe_test_main; -#define foreach_standard_reply_retval_handler \ -_(flowprobe_tx_interface_add_del_reply) \ -_(flowprobe_params_reply) - -#define _(n) \ - static void vl_api_##n##_t_handler \ - (vl_api_##n##_t * mp) \ - { \ - vat_main_t * vam = flowprobe_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 \ -_(FLOWPROBE_TX_INTERFACE_ADD_DEL_REPLY, \ - flowprobe_tx_interface_add_del_reply) \ -_(FLOWPROBE_PARAMS_REPLY, flowprobe_params_reply) - static int api_flowprobe_tx_interface_add_del (vat_main_t * vam) { @@ -201,38 +151,7 @@ api_flowprobe_params (vat_main_t * vam) * List of messages that the api test plugin sends, * and that the data plane plugin processes */ -#define foreach_vpe_api_msg \ -_(flowprobe_tx_interface_add_del, " [disable]") \ -_(flowprobe_params, "record <[l2] [l3] [l4]> [active passive ]") - -static void -flowprobe_api_hookup (vat_main_t * vam) -{ - flowprobe_test_main_t *sm = &flowprobe_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 (flowprobe); +#include /* * fd.io coding-style-patch-verification: ON -- cgit 1.2.3-korg