vpp/vlib-api/vlibmemory/memclnt.api
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

92 lines
2.3 KiB
C

/* Hey Emacs use -*- mode: C -*- */
/*
* Copyright (c) 2015 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.
*/
/*
* Create a client registration
*/
manual_print
define memclnt_create {
i32 ctx_quota; /* requested punt context quota */
u32 context; /* opaque value to be returned in the reply */
u64 input_queue; /* client's queue */
u8 name[64]; /* for show, find by name, whatever */
u32 api_versions[8]; /* client-server pairs use as desired */
};
define memclnt_create_reply {
i32 response; /* Non-negative = success */
u64 handle; /* handle by which vlib knows this client */
u32 index; /* index, used e.g. by API trace replay */
u32 context; /* opaque value from the create request */
u64 message_table; /* serialized message table in shmem */
};
/*
* Delete a client registration
*/
manual_print
define memclnt_delete {
u32 index; /* index, used e.g. by API trace replay */
u64 handle; /* handle by which vlib knows this client */
};
define memclnt_delete_reply {
i32 response; /* Non-negative = success */
u64 handle; /* in case the client wonders */
};
/*
* Client RX thread exit
*/
define rx_thread_exit {
u8 dummy;
};
/*
* RPC
*/
define rpc_call {
u32 client_index;
u32 context;
u64 function;
u8 multicast;
u8 need_barrier_sync;
u8 send_reply;
u8 data[0];
};
define rpc_reply {
i32 retval;
u32 context;
};
/*
* Lookup message-ID base by name
*/
define get_first_msg_id {
u32 client_index;
u32 context;
u8 name[64];
};
define get_first_msg_id_reply {
u32 client_index;
u32 context;
i32 retval;
u16 first_msg_id;
};