ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

stn: remove api boilerplate

Browse Source 
Type: refactor
Change-Id: I212c87c03324137c79a674d0842ca4537b28e4b4
Signed-off-by: Ole Troan <ot@cisco.com>
This commit is contained in:
Ole Troan
2019-09-30 12:44:03 +02:00
committed by Neale Ranns
parent 1e582206a3
commit 0d935531f9
6 changed files with 20 additions and 242 deletions
Download Patch File Download Diff File Expand all files Collapse all files
MAINTAINERS
+4
View File
@@ -543,6 +543,10 @@ I: ct6
M: Dave Barach <dave@barachs.net>
F: src/plugins/ct6
Steal The NIC
I: stn
F: src/plugins/stn
THE REST
I: misc
C: Contact vpp-dev Mailing List <vpp-dev@fd.io>
src/plugins/stn/CMakeLists.txt
-2
View File
@@ -21,8 +21,6 @@ add_vpp_plugin(stn
INSTALL_HEADERS
stn.h
stn_all_api_h.h
stn_msg_enum.h
API_TEST_SOURCES
stn_test.c
src/plugins/stn/stn_all_api_h.h
-16
View File
@@ -1,16 +0,0 @@
/*
* Copyright (c) 2018 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 <stn/stn.api.h>
src/plugins/stn/stn_api.c
+6 -91
View File
@@ -22,32 +22,13 @@
#include <vppinfra/byte_order.h>
/* define message IDs */
#include <stn/stn_msg_enum.h>
/* define message structures */
#define vl_typedefs
#include <stn/stn_all_api_h.h>
#undef vl_typedefs
/* define generated endian-swappers */
#define vl_endianfun
#include <stn/stn_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 <stn/stn_all_api_h.h>
#undef vl_printfun
/* Get the API version number */
#define vl_api_version(n,v) static u32 api_version=(v);
#include <stn/stn_all_api_h.h>
#undef vl_api_version
#include <stn/stn.api_enum.h>
#include <stn/stn.api_types.h>
#define REPLY_MSG_ID_BASE stn_main.msg_id_base
#include <vlibapi/api_helper_macros.h>
#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
/* Macro to finish up custom dump fns */
#define FINISH \
vec_add1 (s, 0); \
@@ -145,80 +126,14 @@ vl_api_stn_rules_dump_t_handler (vl_api_stn_rules_dump_t * mp)
/* *INDENT-ON* */
}
/* List of message types that this plugin understands */
#define foreach_stn_plugin_api_msg \
_(STN_ADD_DEL_RULE, stn_add_del_rule) \
_(STN_RULES_DUMP, stn_rules_dump)
/**
* @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 *
stn_plugin_api_hookup (vlib_main_t * vm)
{
stn_main_t *stn = &stn_main;
#define _(N,n) \
vl_msg_api_set_handlers((VL_API_##N + stn->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_stn_plugin_api_msg;
#undef _
return 0;
}
#define vl_msg_name_crc_list
#include <stn/stn.api.h>
#undef vl_msg_name_crc_list
static void
setup_message_id_table (stn_main_t * stn, api_main_t * am)
{
#define _(id,n,crc) \
vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + stn->msg_id_base);
foreach_vl_msg_name_crc_stn;
#undef _
}
static void
plugin_custom_dump_configure (stn_main_t * stn)
{
#define _(n,f) api_main.msg_print_handlers \
[VL_API_##n + stn->msg_id_base] \
= (void *) vl_api_##f##_t_print;
foreach_stn_plugin_api_msg;
#undef _
}
#include <stn/stn.api.c>
clib_error_t *
stn_api_init (vlib_main_t * vm, stn_main_t * sm)
{
u8 *name;
clib_error_t *error = 0;
name = format (0, "stn_%08x%c", api_version, 0);
/* Ask for a correctly-sized block of API message decode slots */
sm->msg_id_base = vl_msg_api_get_msg_ids ((char *) name,
VL_MSG_FIRST_AVAILABLE);
sm->msg_id_base = setup_message_id_table ();
error = stn_plugin_api_hookup (vm);
/* Add our API messages to the global name_crc hash table */
setup_message_id_table (sm, &api_main);
plugin_custom_dump_configure (sm);
vec_free (name);
return error;
return 0;
}
/*
src/plugins/stn/stn_msg_enum.h
-38
View File
@@ -1,38 +0,0 @@
/*
* Copyright (c) 2018 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 SRC_PLUGINS_STN_STN_MSG_ENUM_H_
#define SRC_PLUGINS_STN_STN_MSG_ENUM_H_
#include <vppinfra/byte_order.h>
#define vl_msg_id(n,h) n,
typedef enum
{
#include <stn/stn_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 /* SRC_PLUGINS_STN_STN_MSG_ENUM_H_ */
/*
* fd.io coding-style-patch-verification: ON
*
* Local Variables:
* eval: (c-set-style "gnu")
* End:
*/
src/plugins/stn/stn_test.c
+10 -95
View File
@@ -23,34 +23,9 @@
#include <vlibapi/vat_helper_macros.h>
/* Declare message IDs */
#include <stn/stn_msg_enum.h>
/* Get CRC codes of the messages defined outside of this plugin */
#define vl_msg_name_crc_list
#include <vpp/api/vpe_all_api_h.h>
#undef vl_msg_name_crc_list
/* define message structures */
#define vl_typedefs
#include <vpp/api/vpe_all_api_h.h>
#include <stn/stn_all_api_h.h>
#undef vl_typedefs
/* define message structures */
#define vl_endianfun
#include <stn/stn_all_api_h.h>
#undef vl_endianfun
/* instantiate all the print functions we know about */
#define vl_print(handle, ...)
#define vl_printfun
#include <stn/stn_all_api_h.h>
#undef vl_printfun
/* Get the API version number. */
#define vl_api_version(n,v) static u32 api_version=(v);
#include <stn/stn_all_api_h.h>
#undef vl_api_version
#include <vpp/api/vpe.api_types.h>
#include <stn/stn.api_enum.h>
#include <stn/stn.api_types.h>
typedef struct
{
@@ -62,12 +37,12 @@ typedef struct
stn_test_main_t stn_test_main;
/*
* Table of message reply handlers, must include boilerplate handlers
* we just generated
*/
#define foreach_stn_api_reply_msg \
_(STN_RULES_DETAILS, stn_rules_details)
static int
api_stn_add_del_rule (vat_main_t * vam)
{
// Not yet implemented
return -99;
}
static int
api_stn_rules_dump (vat_main_t * vam)
@@ -110,67 +85,7 @@ vl_api_stn_rules_details_t_handler (vl_api_stn_rules_details_t * mp)
mp->ip_address, clib_net_to_host_u32 (mp->sw_if_index));
}
/*
* List of messages that the api test plugin sends,
* and that the data plane plugin processes
*/
#define foreach_stn_api_msg \
_(stn_rules_dump, "") \
static void
stn_vat_api_hookup (vat_main_t * vam)
{
stn_test_main_t *sm = &stn_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_stn_api_reply_msg;
#undef _
/* API messages we can send */
#define _(n,h) hash_set_mem (vam->function_by_name, #n, api_##n);
foreach_stn_api_msg;
#undef _
/* Help strings */
#define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
foreach_stn_api_msg;
#undef _
}
clib_error_t *
vat_plugin_register (vat_main_t * vam)
{
stn_test_main_t *sm = &stn_test_main;
u8 *name;
sm->vat_main = vam;
name = format (0, "stn_%08x%c", api_version, 0);
sm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
vec_free (name);
if (sm->msg_id_base == (u16) ~ 0)
return clib_error_return (0, "stn plugin not loaded...");
/* Get the control ping ID */
#define _(id,n,crc) \
const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
foreach_vl_msg_name_crc_vpe;
#undef _
sm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
if (sm->msg_id_base != (u16) ~ 0)
stn_vat_api_hookup (vam);
return 0;
}
#include <stn/stn.api_test.c>
/*
* fd.io coding-style-patch-verification: ON