Dave Barach 557d128b68 Add client-side msg_name_and_crc -> msg_index table
vppapigen now generates per-message crcs. Verified that whitespace
and real changes in message A don't change the crc for message B, etc.

Fixed the sample and flowperpkt plugins to participate. Others need
the same treatment. They don't build due to python/java language binding
build issues.

To use the scheme:

Client connects as usual.

Then call: u32 vl_api_get_msg_index(char * name_and_crc)
name_and_crc is a string like: "flowperpkt_tx_interface_add_del_753301f3",
aka the message name with _%08x <expected crc> appended.

Try these vpp-api-test commands to play with it:

vat# dump_msg_api_table
     <snip>
 [366]: punt_reply_cca27fbe
 [367]: ipsec_spd_dump_5e9ae88e
 [368]: ipsec_spd_details_6f7821b0
 [369]: sample_macswap_enable_disable_0f2813e2
 [370]: sample_macswap_enable_disable_reply_476738e5
 [371]: flowperpkt_tx_interface_add_del_753301f3
 [372]: flowperpkt_tx_interface_add_del_reply_d47e6e0b

vat# get_msg_id sample_macswap_enable_disable_reply_476738e5
 'sample_macswap_enable_disable_reply_476738e5' has message index 370

vat# get_msg_id sample_macswap_enable_disable_reply_476738e3
 'sample_macswap_enable_disable_reply_476738e3' not found

CRCs may vary, etc.

vppapigen is used to build a set of JSON representations
of each API file from vpp-api/Makefile.am and that is in
turn used by each language binding (Java, Python, Lua).

Change-Id: I3d64582e779dac5f20cddec79c562c288d8fd9c6
Signed-off-by: Dave Barach <dave@barachs.net>
Signed-off-by: Ole Troan <ot@cisco.com>
2016-11-21 18:11:41 +00:00

275 lines
8.2 KiB
C

/*
* Copyright (c) 2016 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.
*/
/*
*------------------------------------------------------------------
* ioam_export.c - ioam export API / debug CLI handling
*------------------------------------------------------------------
*/
#include <vnet/vnet.h>
#include <vnet/plugin/plugin.h>
#include <ioam/export/ioam_export.h>
#include <vlibapi/api.h>
#include <vlibmemory/api.h>
#include <vlibsocket/api.h>
#include <vnet/ip/ip6_hop_by_hop.h>
#include "ioam_export.h"
/* define message IDs */
#include <ioam/export/ioam_export_msg_enum.h>
/* define message structures */
#define vl_typedefs
#include <ioam/export/ioam_export_all_api_h.h>
#undef vl_typedefs
/* define generated endian-swappers */
#define vl_endianfun
#include <ioam/export/ioam_export_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 <ioam/export/ioam_export_all_api_h.h>
#undef vl_printfun
/* Get the API version number */
#define vl_api_version(n,v) static u32 api_version=(v);
#include <ioam/export/ioam_export_all_api_h.h>
#undef vl_api_version
/*
* A handy macro to set up a message reply.
* Assumes that the following variables are available:
* mp - pointer to request message
* rmp - pointer to reply message type
* rv - return value
*/
#define REPLY_MACRO(t) \
do { \
unix_shared_memory_queue_t * q = \
vl_api_client_index_to_input_queue (mp->client_index); \
if (!q) \
return; \
\
rmp = vl_msg_api_alloc (sizeof (*rmp)); \
rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \
rmp->context = mp->context; \
rmp->retval = ntohl(rv); \
\
vl_msg_api_send_shmem (q, (u8 *)&rmp); \
} while(0);
/* List of message types that this plugin understands */
#define foreach_ioam_export_plugin_api_msg \
_(IOAM_EXPORT_IP6_ENABLE_DISABLE, ioam_export_ip6_enable_disable)
/*
* This routine exists to convince the vlib plugin framework that
* we haven't accidentally copied a random .dll into the plugin directory.
*
* Also collects global variable pointers passed from the vpp engine
*/
clib_error_t *
vlib_plugin_register (vlib_main_t * vm, vnet_plugin_handoff_t * h,
int from_early_init)
{
ioam_export_main_t *em = &ioam_export_main;
clib_error_t *error = 0;
em->vlib_main = vm;
em->vnet_main = h->vnet_main;
em->ethernet_main = h->ethernet_main;
return error;
}
/* Action function shared between message handler and debug CLI */
int
ioam_export_ip6_enable_disable (ioam_export_main_t * em,
u8 is_disable,
ip4_address_t * collector_address,
ip4_address_t * src_address)
{
vlib_main_t *vm = em->vlib_main;
if (is_disable == 0)
{
if (1 == ioam_export_header_create (collector_address, src_address))
{
ioam_export_thread_buffer_init (vm);
ip6_hbh_set_next_override (em->my_hbh_slot);
/* Turn on the export buffer check process */
vlib_process_signal_event (vm, em->export_process_node_index, 1, 0);
}
else
{
return (-2);
}
}
else
{
ip6_hbh_set_next_override (IP6_LOOKUP_NEXT_POP_HOP_BY_HOP);
ioam_export_header_cleanup (collector_address, src_address);
ioam_export_thread_buffer_free ();
/* Turn off the export buffer check process */
vlib_process_signal_event (vm, em->export_process_node_index, 2, 0);
}
return 0;
}
/* API message handler */
static void vl_api_ioam_export_ip6_enable_disable_t_handler
(vl_api_ioam_export_ip6_enable_disable_t * mp)
{
vl_api_ioam_export_ip6_enable_disable_reply_t *rmp;
ioam_export_main_t *sm = &ioam_export_main;
int rv;
rv = ioam_export_ip6_enable_disable (sm, (int) (mp->is_disable),
(ip4_address_t *) mp->
collector_address,
(ip4_address_t *) mp->src_address);
REPLY_MACRO (VL_API_IOAM_EXPORT_IP6_ENABLE_DISABLE_REPLY);
}
/* Set up the API message handling tables */
static clib_error_t *
ioam_export_plugin_api_hookup (vlib_main_t * vm)
{
ioam_export_main_t *sm = &ioam_export_main;
#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_ioam_export_plugin_api_msg;
#undef _
return 0;
}
#define vl_msg_name_crc_list
#include <ioam/export/ioam_export_all_api_h.h>
#undef vl_msg_name_crc_list
static void
setup_message_id_table (ioam_export_main_t * sm, api_main_t * am)
{
#define _(id,n,crc) \
vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + sm->msg_id_base);
foreach_vl_msg_name_crc_ioam_export;
#undef _
}
static clib_error_t *
set_ioam_export_ipfix_command_fn (vlib_main_t * vm,
unformat_input_t * input,
vlib_cli_command_t * cmd)
{
ioam_export_main_t *em = &ioam_export_main;
ip4_address_t collector, src;
u8 is_disable = 0;
collector.as_u32 = 0;
src.as_u32 = 0;
while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
{
if (unformat (input, "collector %U", unformat_ip4_address, &collector))
;
else if (unformat (input, "src %U", unformat_ip4_address, &src))
;
else if (unformat (input, "disable"))
is_disable = 1;
else
break;
}
if (collector.as_u32 == 0)
return clib_error_return (0, "collector address required");
if (src.as_u32 == 0)
return clib_error_return (0, "src address required");
em->ipfix_collector.as_u32 = collector.as_u32;
em->src_address.as_u32 = src.as_u32;
vlib_cli_output (vm, "Collector %U, src address %U",
format_ip4_address, &em->ipfix_collector,
format_ip4_address, &em->src_address);
/* Turn on the export timer process */
// vlib_process_signal_event (vm, flow_report_process_node.index,
//1, 0);
ioam_export_ip6_enable_disable (em, is_disable, &collector, &src);
return 0;
}
VLIB_CLI_COMMAND (set_ipfix_command, static) =
{
.path = "set ioam export ipfix",.short_help =
"set ioam export ipfix collector <ip4-address> src <ip4-address>",.
function = set_ioam_export_ipfix_command_fn,};
static clib_error_t *
ioam_export_init (vlib_main_t * vm)
{
ioam_export_main_t *em = &ioam_export_main;
clib_error_t *error = 0;
u8 *name;
u32 node_index = export_node.index;
vlib_node_t *ip6_hbyh_node = NULL;
name = format (0, "ioam_export_%08x%c", api_version, 0);
/* Ask for a correctly-sized block of API message decode slots */
em->msg_id_base = vl_msg_api_get_msg_ids
((char *) name, VL_MSG_FIRST_AVAILABLE);
em->unix_time_0 = (u32) time (0); /* Store starting time */
em->vlib_time_0 = vlib_time_now (vm);
error = ioam_export_plugin_api_hookup (vm);
/* Add our API messages to the global name_crc hash table */
setup_message_id_table (em, &api_main);
/* Hook this export node to ip6-hop-by-hop */
ip6_hbyh_node = vlib_get_node_by_name (vm, (u8 *) "ip6-hop-by-hop");
em->my_hbh_slot = vlib_node_add_next (vm, ip6_hbyh_node->index, node_index);
vec_free (name);
return error;
}
VLIB_INIT_FUNCTION (ioam_export_init);