vpp/vppapigen/node.h
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

95 lines
2.3 KiB
C

/*
*------------------------------------------------------------------
* node.h - definitions for an API generator
*
* Copyright (c) 2004-2009 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 _node_h_
#define _node_h_
/*
* Global prototypes
*/
char *sxerox (const char *s);
enum node_subclass { /* WARNING: indices must match the vft... */
NODE_ILLEGAL=0,
NODE_U8,
NODE_U16,
NODE_U32,
NODE_U64,
NODE_I8,
NODE_I16,
NODE_I32,
NODE_I64,
NODE_F64,
NODE_PACKED,
NODE_DEFINE,
NODE_UNION,
NODE_SCALAR,
NODE_VECTOR,
NODE_COMPLEX,
NODE_NOVERSION,
NODE_UWORD,
NODE_N_TYPES, /* number of node types with VFT's */
/* pseudo-node(s) used in the lexer keyword table, but
NOT in need of a VFT... */
NODE_TYPEONLY,
NODE_MANUAL_PRINT,
NODE_MANUAL_ENDIAN,
NODE_DONT_TRACE,
};
enum passid {
TYPEDEF_PASS=1,
UNION_DEF_PASS,
ENDIANFUN_PASS,
PRINTFUN_PASS,
PYTHON_PASS,
JSON_PASS,
};
extern void *make_node (enum node_subclass type);
typedef struct node_ {
enum node_subclass type;
struct node_ *peer;
struct node_ *deeper;
int flags;
void *data[4];
} node_t;
/* To shut up gcc-4.2.x warnings */
#define CDATA0 ((char *)(this->data[0]))
#define IDATA1 ((int)(uword)(this->data[1]))
#define CDATA2 ((char *)(this->data[2]))
#define CDATA3 ((char *)(this->data[3]))
#define NODE_FLAG_MANUAL_PRINT (1<<0)
#define NODE_FLAG_MANUAL_ENDIAN (1<<1)
#define NODE_FLAG_TYPEONLY (1<<3)
#define NODE_FLAG_DONT_TRACE (1<<4)
typedef struct node_vft_ {
void (*print)(struct node_ *);
void (*generate)(struct node_ *, enum passid id, FILE *ofp);
char *endian_converter;
} node_vft_t;
#endif /* _node_h */