summaryrefslogtreecommitdiffstats
path: root/doxygen/siphon/parsers.py
blob: 162205de4ca4947153eef43e8e048cd111342ec0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# 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.

import html
import pyparsing as pp

# Some useful primitives
ident = pp.Word(pp.alphas + "_", pp.alphas + pp.nums + "_")
intNum = pp.Word(pp.nums)
hexNum = pp.Literal("0x") + pp.Word(pp.hexnums)
octalNum = pp.Literal("0") + pp.Word("01234567")
integer = (hexNum | octalNum | intNum) + \
    pp.Optional(pp.Literal("ULL") | pp.Literal("LL") | pp.Literal("L"))
floatNum = pp.Regex(r'\d+(\.\d*)?([eE]\d+)?') + pp.Optional(pp.Literal("f"))
char = pp.Literal("'") + pp.Word(pp.printables, exact=1) + pp.Literal("'")
arrayIndex = integer | ident

lbracket = pp.Literal("(").suppress()
rbracket = pp.Literal(")").suppress()
lbrace = pp.Literal("{").suppress()
rbrace = pp.Literal("}").suppress()
comma = pp.Literal(",").suppress()
equals = pp.Literal("=").suppress()
dot = pp.Literal(".").suppress()
semicolon = pp.Literal(";").suppress()

# initializer := { [member = ] (variable | expression | { initializer } ) }
typeName = ident
varName = ident
typeSpec = pp.Optional("unsigned") + \
           pp.oneOf("int long short float double char u8 i8 void") + \
           pp.Optional(pp.Word("*"), default="")
typeCast = pp.Combine( "(" + ( typeSpec | typeName ) + ")" ).suppress()

string = pp.Combine(pp.OneOrMore(pp.QuotedString(quoteChar='"',
    escChar='\\', multiline=True)), adjacent=False)
literal = pp.Optional(typeCast) + (integer | floatNum | char | string)
var = pp.Combine(pp.Optional(typeCast) + varName +
    pp.Optional("[" + arrayIndex + "]"))

# This could be more complete, but suffices for our uses
expr = (literal | var)

"""Parse and render a block of text into a Python dictionary."""
class Parser(object):
    """Compiled PyParsing BNF"""
    _parser = None

    def __init__(self):
        super(Parser, self).__init__()
        self._parser = self.BNF()

    def BNF(self):
        raise NotImplementedError

    def item(self, item):
        raise NotImplementedError

    def parse(self, input):
        item = self._parser.parseString(input).asList()
        return self.item(item)


"""Parser for function-like macros - without the closing semi-colon."""
class ParserFunctionMacro(Parser):
    def BNF(self):
        # VLIB_CONFIG_FUNCTION (unix_config, "unix")
        macroName = ident
        params = pp.Group(pp.ZeroOrMore(expr + comma) + expr)
        macroParams = lbracket + params + rbracket

        return macroName + macroParams

    def item(self, item):
        r = {
            "macro": item[0],
            "name": item[1][1],
            "function": item[1][0],
        }

        return r


"""Parser for function-like macros with a closing semi-colon."""
class ParseFunctionMacroStmt(ParserFunctionMacro):
    def BNF(self):
        # VLIB_CONFIG_FUNCTION (unix_config, "unix");
        function_macro = super(ParseFunctionMacroStmt, self).BNF()
        mi = function_macro + semicolon
        mi.ignore(pp.cppStyleComment)

        return mi


"""
Parser for our struct initializers which are composed from a
function-like macro, equals sign, and then a normal C struct initializer
block.
"""
class MacroInitializer(ParserFunctionMacro):
    def BNF(self):
        # VLIB_CLI_COMMAND (show_sr_tunnel_command, static) = {
        #    .path = "show sr tunnel",
        #    .short_help = "show sr tunnel [name <sr-tunnel-name>]",
        #    .function = show_sr_tunnel_fn,
        # };
        cs = pp.Forward()


        member = pp.Combine(dot + varName + pp.Optional("[" + arrayIndex + "]"),
            adjacent=False)
        value = (expr | cs)

        entry = pp.Group(pp.Optional(member + equals, default="") + value)
        entries = (pp.ZeroOrMore(entry + comma) + entry + pp.Optional(comma)) | \
                  (pp.ZeroOrMore(entry + comma))

        cs << (lbrace + entries + rbrace)

        macroName = ident
        params = pp.Group(pp.ZeroOrMore(expr + comma) + expr)
        macroParams = lbracket + params + rbracket

        function_macro = super(MacroInitializer, self).BNF()
        mi = function_macro + equals + pp.Group(cs) + semicolon
        mi.ignore(pp.cppStyleComment)

        return mi

    def item(self, item):
        r = {
            "macro": item[0],
            "name": item[1][0],
            "params": item[2],
            "value": {},
        }

        for param in item[2]:
            r["value"][param[0]] = html.escape(param[1])

        return r
span class="n">bt_sub_domain, .bti_hdr_len = mp->bt_tbl_id.bt_hdr_len_id, .bti_type = BIER_TABLE_MPLS_SPF, .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN, }; if (mp->bt_is_add) { mpls_label_t label = ntohl(mp->bt_label); /* * convert acceptable 'don't want a label' values from * the API to the correct internal INVLID value */ if ((0 == label) || (~0 == label)) { label = MPLS_LABEL_INVALID; } bier_table_add_or_lock(&bti, label); } else { bier_table_unlock(&bti); } rv = vnm->api_errno; REPLY_MACRO (VL_API_BIER_TABLE_ADD_DEL_REPLY); } static void send_bier_table_details (svm_queue_t * q, u32 context, const bier_table_t *bt) { vl_api_bier_table_details_t *mp; mp = vl_msg_api_alloc(sizeof(*mp)); if (!mp) return; memset(mp, 0, sizeof(*mp)); mp->_vl_msg_id = ntohs(VL_API_BIER_TABLE_DETAILS); mp->context = context; mp->bt_label = bt->bt_ll; mp->bt_tbl_id.bt_set = bt->bt_id.bti_set; mp->bt_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain; mp->bt_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len; vl_msg_api_send_shmem (q, (u8 *) & mp); } static void vl_api_bier_table_dump_t_handler (vl_api_bier_table_dump_t * mp) { svm_queue_t *q; bier_table_t *bt; q = vl_api_client_index_to_input_queue (mp->client_index); if (q == 0) return; pool_foreach(bt, bier_table_pool, ({ /* * skip the ecmp tables. */ if (bier_table_is_main(bt)) { send_bier_table_details(q, mp->context, bt); } })); } static void vl_api_bier_route_add_del_t_handler (vl_api_bier_route_add_del_t * mp) { vl_api_bier_route_add_del_reply_t *rmp; fib_route_path_t *brpaths, *brpath; vnet_main_t *vnm; bier_bp_t bp; int rv = 0; u8 ii, jj; vnm = vnet_get_main (); vnm->api_errno = 0; bp = ntohl(mp->br_bp); brpaths = NULL; if (0 == bp || bp > BIER_BP_MAX) { rv = -1; goto done; } bier_table_id_t bti = { .bti_set = mp->br_tbl_id.bt_set, .bti_sub_domain = mp->br_tbl_id.bt_sub_domain, .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id, .bti_type = BIER_TABLE_MPLS_SPF, .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN, }; vec_validate(brpaths, mp->br_n_paths - 1); vec_foreach_index(ii, brpaths) { brpath = &brpaths[ii]; memset(brpath, 0, sizeof(*brpath)); brpath->frp_sw_if_index = ~0; vec_validate(brpath->frp_label_stack, mp->br_paths[ii].n_labels - 1); for (jj = 0; jj < mp->br_paths[ii].n_labels; jj++) { brpath->frp_label_stack[jj] = ntohl(mp->br_paths[ii].label_stack[jj]); } if (mp->br_paths[ii].is_udp_encap) { brpath->frp_flags |= FIB_ROUTE_PATH_UDP_ENCAP; brpath->frp_udp_encap_id = ntohl(mp->br_paths[ii].next_hop_id); } else { if (0 == mp->br_paths[ii].afi) { clib_memcpy (&brpath->frp_addr.ip4, mp->br_paths[ii].next_hop, sizeof (brpath->frp_addr.ip4)); } else { clib_memcpy (&brpath->frp_addr.ip6, mp->br_paths[ii].next_hop, sizeof (brpath->frp_addr.ip6)); } if (ip46_address_is_zero(&brpath->frp_addr)) { index_t bdti; bdti = bier_disp_table_find(ntohl(mp->br_paths[ii].table_id)); if (INDEX_INVALID != bdti) { brpath->frp_fib_index = bdti; brpath->frp_proto = DPO_PROTO_BIER; } else { rv = VNET_API_ERROR_NO_SUCH_FIB; goto done; } } } } if (mp->br_is_add) { bier_table_route_add(&bti, bp, brpaths); } else { bier_table_route_remove(&bti, bp, brpaths); } done: vec_free(brpaths); rv = (rv == 0) ? vnm->api_errno : rv; REPLY_MACRO (VL_API_BIER_ROUTE_ADD_DEL_REPLY); } typedef struct bier_route_details_walk_t_ { svm_queue_t * q; u32 context; } bier_route_details_walk_t; static void send_bier_route_details (const bier_table_t *bt, const bier_entry_t *be, void *args) { fib_route_path_encode_t *api_rpaths = NULL, *api_rpath; bier_route_details_walk_t *ctx = args; vl_api_bier_route_details_t *mp; vl_api_fib_path3_t *fp; u32 n_paths, m_size; n_paths = fib_path_list_get_n_paths(be->be_path_list); m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path3_t)); mp = vl_msg_api_alloc(m_size); if (!mp) return; memset(mp, 0, m_size); mp->_vl_msg_id = ntohs(VL_API_BIER_ROUTE_DETAILS); mp->context = ctx->context; mp->br_tbl_id.bt_set = bt->bt_id.bti_set; mp->br_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain; mp->br_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len; mp->br_bp = htons(be->be_bp); mp->br_n_paths = htonl(n_paths); fib_path_list_walk(be->be_path_list, fib_path_encode, &api_rpaths); fp = mp->br_paths; vec_foreach (api_rpath, api_rpaths) { fp->weight = api_rpath->rpath.frp_weight; fp->preference = api_rpath->rpath.frp_preference; fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index); fp->n_labels = 0; copy_fib_next_hop (api_rpath, fp); fp++; } vl_msg_api_send_shmem (ctx->q, (u8 *) & mp); } static void vl_api_bier_route_dump_t_handler (vl_api_bier_route_dump_t * mp) { svm_queue_t *q; q = vl_api_client_index_to_input_queue (mp->client_index); if (q == 0) return; bier_table_id_t bti = { .bti_set = mp->br_tbl_id.bt_set, .bti_sub_domain = mp->br_tbl_id.bt_sub_domain, .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id, .bti_type = BIER_TABLE_MPLS_SPF, .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN, }; bier_route_details_walk_t ctx = { .q = q, .context = mp->context, }; bier_table_walk(&bti, send_bier_route_details, &ctx); } static void vl_api_bier_imp_add_t_handler (vl_api_bier_imp_add_t * mp) { vl_api_bier_imp_add_reply_t *rmp; vnet_main_t *vnm; index_t bii; int rv = 0; vnm = vnet_get_main (); vnm->api_errno = 0; bier_table_id_t bti = { .bti_set = mp->bi_tbl_id.bt_set, .bti_sub_domain = mp->bi_tbl_id.bt_sub_domain, .bti_hdr_len = mp->bi_tbl_id.bt_hdr_len_id, .bti_type = BIER_TABLE_MPLS_SPF, .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN, }; bier_bit_string_t bs = { .bbs_len = mp->bi_n_bytes, .bbs_buckets = mp->bi_bytes, }; bii = bier_imp_add_or_lock(&bti, ntohs(mp->bi_src), &bs); /* *INDENT-OFF* */ REPLY_MACRO2 (VL_API_BIER_IMP_ADD_REPLY, ({ rmp->bi_index = ntohl (bii); })); /* *INDENT-OM* */ } static void vl_api_bier_imp_del_t_handler (vl_api_bier_imp_del_t * mp) { vl_api_bier_imp_del_reply_t *rmp; vnet_main_t *vnm; int rv = 0; vnm = vnet_get_main (); vnm->api_errno = 0; bier_imp_unlock(ntohl(mp->bi_index)); REPLY_MACRO(VL_API_BIER_IMP_DEL_REPLY); } static void send_bier_imp_details (svm_queue_t * q, u32 context, const bier_imp_t *bi) { vl_api_bier_imp_details_t *mp; bier_hdr_t copy; u8 n_bytes; copy = bi->bi_hdr; bier_hdr_ntoh(&copy); n_bytes = bier_hdr_len_id_to_num_bytes( bier_hdr_get_len_id(&copy)); mp = vl_msg_api_alloc(sizeof(*mp) + n_bytes); if (!mp) return; memset(mp, 0, sizeof(*mp)+n_bytes); mp->_vl_msg_id = ntohs(VL_API_BIER_IMP_DETAILS); mp->context = context; mp->bi_tbl_id.bt_set = bi->bi_tbl.bti_set; mp->bi_tbl_id.bt_sub_domain = bi->bi_tbl.bti_sub_domain; mp->bi_tbl_id.bt_hdr_len_id = bi->bi_tbl.bti_hdr_len; mp->bi_src = htons(bier_hdr_get_src_id(&copy)); mp->bi_n_bytes = n_bytes; memcpy(mp->bi_bytes, bi->bi_bits.bits, n_bytes); vl_msg_api_send_shmem (q, (u8 *) & mp); } static void vl_api_bier_imp_dump_t_handler (vl_api_bier_imp_dump_t * mp) { svm_queue_t *q; bier_imp_t *bi; q = vl_api_client_index_to_input_queue (mp->client_index); if (q == 0) return; pool_foreach(bi, bier_imp_pool, ({ send_bier_imp_details(q, mp->context, bi); })); } static void vl_api_bier_disp_table_add_del_t_handler (vl_api_bier_disp_table_add_del_t * mp) { vl_api_bier_disp_table_add_del_reply_t *rmp; vnet_main_t *vnm; u32 table_id; int rv; vnm = vnet_get_main (); vnm->api_errno = 0; table_id = ntohl(mp->bdt_tbl_id); if (mp->bdt_is_add) { bier_disp_table_add_or_lock(table_id); } else { bier_disp_table_unlock_w_table_id(table_id); } rv = vnm->api_errno; REPLY_MACRO (VL_API_BIER_DISP_TABLE_ADD_DEL_REPLY); } static void send_bier_disp_table_details (svm_queue_t * q, u32 context, const bier_disp_table_t *bdt) { vl_api_bier_disp_table_details_t *mp; mp = vl_msg_api_alloc(sizeof(*mp)); if (!mp) return; memset(mp, 0, sizeof(*mp)); mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_TABLE_DETAILS); mp->context = context; mp->bdt_tbl_id = htonl(bdt->bdt_table_id); vl_msg_api_send_shmem (q, (u8 *) & mp); } static void vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp) { svm_queue_t *q; bier_disp_table_t *bdt; q = vl_api_client_index_to_input_queue (mp->client_index); if (q == 0) return; pool_foreach(bdt, bier_disp_table_pool, ({ send_bier_disp_table_details(q, mp->context, bdt); })); } static void vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp) { vl_api_bier_disp_entry_add_del_reply_t *rmp; fib_route_path_t *brps = NULL, *brp; vnet_main_t *vnm; bier_bp_t bp; u32 table_id; int rv = 0; u32 ii; vnm = vnet_get_main (); vnm->api_errno = 0; table_id = ntohl(mp->bde_tbl_id); bp = ntohs(mp->bde_bp); /* * BP=0 is the default route */ if (bp > 0xffff) { rv = -1; goto done; } vec_validate(brps, mp->bde_n_paths - 1); vec_foreach_index(ii, brps) { brp = &brps[ii]; brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id); brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index); if (~0 != ntohl(mp->bde_paths[ii].rpf_id)) { brp->frp_flags = FIB_ROUTE_PATH_RPF_ID; brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id); } if (0 == mp->bde_paths[ii].afi) { clib_memcpy (&brp->frp_addr.ip4, mp->bde_paths[ii].next_hop, sizeof (brp->frp_addr.ip4)); } else { clib_memcpy (&brp->frp_addr.ip6, mp->bde_paths[ii].next_hop, sizeof (brp->frp_addr.ip6)); } if (ip46_address_is_zero(&brp->frp_addr)) { index_t fti; switch (mp->bde_payload_proto) { case BIER_HDR_PROTO_INVALID: case BIER_HDR_PROTO_MPLS_DOWN_STREAM: case BIER_HDR_PROTO_MPLS_UP_STREAM: case BIER_HDR_PROTO_ETHERNET: case BIER_HDR_PROTO_VXLAN: case BIER_HDR_PROTO_CTRL: case BIER_HDR_PROTO_OAM: rv = VNET_API_ERROR_UNSUPPORTED; goto done; break; case BIER_HDR_PROTO_IPV4: case BIER_HDR_PROTO_IPV6: { fib_protocol_t fproto; fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ? FIB_PROTOCOL_IP4 : FIB_PROTOCOL_IP6); if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID) { fti = mfib_table_find (fproto, ntohl (mp->bde_paths[ii].table_id)); } else { fti = fib_table_find (fproto, ntohl (mp->bde_paths[ii].table_id)); } if (INDEX_INVALID != fti) { brp->frp_fib_index = fti; } else { rv = VNET_API_ERROR_NO_SUCH_FIB; goto done; } break; } } } } if (mp->bde_is_add) { bier_disp_table_entry_path_add(table_id, bp, mp->bde_payload_proto, brps); } else { bier_disp_table_entry_path_remove(table_id, bp, mp->bde_payload_proto, brps); } done: vec_free(brps); rv = (rv == 0) ? vnm->api_errno : rv; REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY); } typedef struct bier_disp_entry_details_walk_t_ { svm_queue_t * q; u32 context; } bier_disp_entry_details_walk_t; static void send_bier_disp_entry_details (const bier_disp_table_t *bdt, const bier_disp_entry_t *bde, u16 bp, void *args) { fib_route_path_encode_t *api_rpaths = NULL, *api_rpath; bier_disp_entry_details_walk_t *ctx = args; vl_api_bier_disp_entry_details_t *mp; bier_hdr_proto_id_t pproto; vl_api_fib_path3_t *fp; u32 n_paths, m_size; FOR_EACH_BIER_HDR_PROTO(pproto) { fib_node_index_t pl = bde->bde_pl[pproto]; if (INDEX_INVALID != pl) { n_paths = fib_path_list_get_n_paths(pl); m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path3_t)); mp = vl_msg_api_alloc(m_size); if (!mp) return; memset(mp, 0, m_size); mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_ENTRY_DETAILS); mp->context = ctx->context; mp->bde_tbl_id = htonl(bdt->bdt_table_id); mp->bde_n_paths = htonl(n_paths); mp->bde_payload_proto = pproto; mp->bde_bp = htons(bp); fib_path_list_walk(pl, fib_path_encode, &api_rpaths); fp = mp->bde_paths; vec_foreach (api_rpath, api_rpaths) { fp->weight = api_rpath->rpath.frp_weight; fp->preference = api_rpath->rpath.frp_preference; fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index); fp->n_labels = 0; copy_fib_next_hop (api_rpath, fp); fp++; } vl_msg_api_send_shmem (ctx->q, (u8 *) & mp); } } } static void vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp) { svm_queue_t *q; q = vl_api_client_index_to_input_queue (mp->client_index); if (q == 0) return; bier_disp_entry_details_walk_t ctx = { .q = q, .context = mp->context, }; bier_disp_table_walk(ntohl(mp->bde_tbl_id), send_bier_disp_entry_details, &ctx); } #define vl_msg_name_crc_list #include <vnet/bier/bier.api.h> #undef vl_msg_name_crc_list static void setup_message_id_table (api_main_t * am) { #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id); foreach_vl_msg_name_crc_bier; #undef _ } static clib_error_t * bier_api_hookup (vlib_main_t * vm) { api_main_t *am = &api_main; #define _(N,n) \ vl_msg_api_set_handlers(VL_API_##N, #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_bier_api_msg; #undef _ /* * Set up the (msg_name, crc, message-id) table */ setup_message_id_table (am); return 0; } VLIB_API_INIT_FUNCTION (bier_api_hookup);