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

builtinurl: remove api boilerplate

Browse Source 
Type: refactor
Change-Id: Iaf728642e489acfd63e1da88aa8daa44ceca21e9
Signed-off-by: Ole Troan <ot@cisco.com>
This commit is contained in:
Ole Troan
2019-09-25 18:20:20 +02:00
committed by Neale Ranns
parent 1bc96680c4
commit 51e70b6f19
5 changed files with 9 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/plugins/builtinurl/CMakeLists.txt
View File

@@ -21,10 +21,6 @@ add_vpp_plugin(builtinurl
API_FILES
builtinurl.api
INSTALL_HEADERS
builtinurl_all_api_h.h
builtinurl_msg_enum.h
API_TEST_SOURCES
builtinurl_test.c
)

77
src/plugins/builtinurl/builtinurl.c
View File

@@ -25,39 +25,14 @@
#include <stdbool.h>
/* define message IDs */
#include <builtinurl/builtinurl_msg_enum.h>
/* define message structures */
#define vl_typedefs
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_typedefs
/* define generated endian-swappers */
#define vl_endianfun
#include <builtinurl/builtinurl_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 <builtinurl/builtinurl_all_api_h.h>
#undef vl_printfun
/* Get the API version number */
#define vl_api_version(n,v) static u32 api_version=(v);
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_api_version
#include <builtinurl/builtinurl.api_enum.h>
#include <builtinurl/builtinurl.api_types.h>
#define REPLY_MSG_ID_BASE bmp->msg_id_base
#include <vlibapi/api_helper_macros.h>
builtinurl_main_t builtinurl_main;
/* List of message types that this plugin understands */
#define foreach_builtinurl_plugin_api_msg \
_(BUILTINURL_ENABLE, builtinurl_enable)
/* Action function shared between message handler and debug CLI */
int
@@ -132,61 +107,19 @@ static void vl_api_builtinurl_enable_t_handler
REPLY_MACRO (VL_API_BUILTINURL_ENABLE_REPLY);
}
/* Set up the API message handling tables */
static clib_error_t *
builtinurl_plugin_api_hookup (vlib_main_t * vm)
{
builtinurl_main_t *bmp = &builtinurl_main;
#define _(N,n) \
vl_msg_api_set_handlers((VL_API_##N + bmp->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_builtinurl_plugin_api_msg;
#undef _
return 0;
}
#define vl_msg_name_crc_list
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_msg_name_crc_list
static void
setup_message_id_table (builtinurl_main_t * bmp, api_main_t * am)
{
#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + bmp->msg_id_base);
foreach_vl_msg_name_crc_builtinurl;
#undef _
}
#include <builtinurl/builtinurl.api.c>
static clib_error_t *
builtinurl_init (vlib_main_t * vm)
{
builtinurl_main_t *bmp = &builtinurl_main;
clib_error_t *error = 0;
u8 *name;
bmp->vlib_main = vm;
bmp->vnet_main = vnet_get_main ();
name = format (0, "builtinurl_%08x%c", api_version, 0);
/* Ask for a correctly-sized block of API message decode slots */
bmp->msg_id_base = vl_msg_api_get_msg_ids
((char *) name, VL_MSG_FIRST_AVAILABLE);
bmp->msg_id_base = setup_message_id_table ();
error = builtinurl_plugin_api_hookup (vm);
/* Add our API messages to the global name_crc hash table */
setup_message_id_table (bmp, &api_main);
vec_free (name);
return error;
return 0;
}
VLIB_INIT_FUNCTION (builtinurl_init);

19
src/plugins/builtinurl/builtinurl_all_api_h.h
View File

@@ -1,19 +0,0 @@
/*
* builtinurl_all_api_h.h - skeleton vpp engine plug-in api #include file
*
* Copyright (c) 2019 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 <builtinurl/builtinurl.api.h>

31
src/plugins/builtinurl/builtinurl_msg_enum.h
View File

@@ -1,31 +0,0 @@
/*
* builtinurl_msg_enum.h - skeleton vpp engine plug-in message enumeration
*
* Copyright (c) 2019 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_builtinurl_msg_enum_h
#define included_builtinurl_msg_enum_h
#include <vppinfra/byte_order.h>
#define vl_msg_id(n,h) n,
typedef enum {
#include <builtinurl/builtinurl_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_builtinurl_msg_enum_h */

91
src/plugins/builtinurl/builtinurl_test.c
View File

@@ -23,30 +23,8 @@
uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
/* Declare message IDs */
#include <builtinurl/builtinurl_msg_enum.h>
/* define message structures */
#define vl_typedefs
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_typedefs
/* declare message handlers for each api */
#define vl_endianfun /* define message structures */
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_endianfun
/* instantiate all the print functions we know about */
#define vl_print(handle, ...)
#define vl_printfun
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_printfun
/* Get the API version number. */
#define vl_api_version(n,v) static u32 api_version=(v);
#include <builtinurl/builtinurl_all_api_h.h>
#undef vl_api_version
#include <builtinurl/builtinurl.api_enum.h>
#include <builtinurl/builtinurl.api_types.h>
typedef struct
{
@@ -60,35 +38,8 @@ builtinurl_test_main_t builtinurl_test_main;
#define __plugin_msg_base builtinurl_test_main.msg_id_base
#include <vlibapi/vat_helper_macros.h>
#define foreach_standard_reply_retval_handler \
_(builtinurl_enable_reply)
#define _(n) \
static void vl_api_##n##_t_handler \
(vl_api_##n##_t * mp) \
{ \
vat_main_t * vam = builtinurl_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 \
_(BUILTINURL_ENABLE_REPLY, builtinurl_enable_reply)
static int
api_builtinurl_enable_disable (vat_main_t * vam)
api_builtinurl_enable (vat_main_t * vam)
{
vl_api_builtinurl_enable_t *mp;
int ret;
@@ -104,41 +55,7 @@ api_builtinurl_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 \
_(builtinurl_enable_disable, "")
static void
builtinurl_api_hookup (vat_main_t * vam)
{
builtinurl_test_main_t *btmp = &builtinurl_test_main;
/* Hook up handlers for replies from the data plane plug-in */
#define _(N,n) \
vl_msg_api_set_handlers((VL_API_##N + btmp->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 (builtinurl);
#include <builtinurl/builtinurl.api_test.c>
/*
* fd.io coding-style-patch-verification: ON