2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
18 This file defines vpp BIER control-plane API messages which are generally
19 called through a shared memory interface.
23 /** \brief BIER Table Indentifier
26 @param bt_bit_header_length
28 typeonly define bier_table_id
35 /** \brief BIER Table Add / del route
36 @param client_index - opaque cookie to identify the sender
37 @param context - sender context, to match reply w/ request
38 @param bt_tbl_id - The BIER table-id the route is added in
39 @param bt_label - The MPLS label for the table (0 or all ones means not set)
40 If the label is not set, then it is assumed that non-MPLS
42 @param bt_is_add - Is this a route add or delete
44 autoreply define bier_table_add_del
48 vl_api_bier_table_id_t bt_tbl_id;
53 define bier_table_dump
59 define bier_table_details
63 vl_api_bier_table_id_t bt_tbl_id;
67 @param sw_if_index - index of the interface
68 @param weight - The weight, for UCMP
69 @param preference - The preference of the path. lowest preference is prefered
70 @param is_local - local if non-zero, else remote
71 @param is_drop - Drop the packet
72 @param is_udp_encap - The path describes a UDP-o-IP encapsulation.
73 @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
74 @param next_hop[16] - the next hop address
75 @param next_hop_id - Used when the path resolves via an object that has a unique
76 identifier. e.g. the UDP encap object
78 WARNING: this type is replicated, pending cleanup completion
80 typeonly define fib_path3
97 /** \brief BIER Route Add / del route
98 @param client_index - opaque cookie to identify the sender
99 @param context - sender context, to match reply w/ request
100 @param br_bp - The Bit-position value
101 @param br_tbl_id - The BIER table-id the route is added in
102 @param br_is_add - Is this a route add or delete
103 @param br_is_replace - Are the paths specfied replacing those already
104 present or are they to be combined.
105 @param br_n_paths - The number of paths
106 @param br_paths - The array of paths
108 autoreply define bier_route_add_del
115 vl_api_bier_table_id_t br_tbl_id;
117 vl_api_fib_path3_t br_paths[br_n_paths];
120 define bier_route_dump
124 vl_api_bier_table_id_t br_tbl_id;
127 define bier_route_details
132 vl_api_bier_table_id_t br_tbl_id;
134 vl_api_fib_path3_t br_paths[br_n_paths];
137 /** \brief BIER Imposition Add
138 @param client_index - opaque cookie to identify the sender
139 @param context - sender context, to match reply w/ request
140 @param bi_tbl_id - The BIER table-id used to forward post encap
141 @param bi_src - The source Bit-position in the encap.
142 @param bi_is_add - Is this a route add or delete
143 @param bi_n_bytes - The number of bytes in the following bit-string
144 @param bi_bytes - The bit-string represented as a byte array
150 vl_api_bier_table_id_t bi_tbl_id;
154 u8 bi_bytes[bi_n_bytes];
157 /** \brief Reply for BIER route add / del request
158 @param context - returned sender context, to match reply w/ request
159 @param retval - return code
160 @param bi_index - The index of the created imposition object.
162 define bier_imp_add_reply
169 /** \brief BIER Imposition Del
170 @param client_index - opaque cookie to identify the sender
171 @param context - sender context, to match reply w/ request
172 @param bi_index - The index of the imposition object (as returned
175 autoreply define bier_imp_del
188 define bier_imp_details
192 vl_api_bier_table_id_t bi_tbl_id;
195 u8 bi_bytes[bi_n_bytes];
198 /** \brief BIER Disposition Table Add / del route
199 @param client_index - opaque cookie to identify the sender
200 @param context - sender context, to match reply w/ request
201 @param bt_tbl_id - The BIER Disposition table-id.
203 autoreply define bier_disp_table_add_del
211 define bier_disp_table_dump
217 define bier_disp_table_details
223 /** \brief BIER Disposition Entry Add / del
224 @param client_index - opaque cookie to identify the sender
225 @param context - sender context, to match reply w/ request
226 @param bde_bp - The Bit-position value for the entry
227 @param bde_tbl_id - The BIER dispositiontable-id the route is added in
228 @param bde_next_hop_sw_if_index - the nextop interface
229 @param bde_is_add - Is this a route add or delete
230 @param bde_payload_proto - The payload protocol for which the next-hop
232 @param bde_next_hop_table_id - The table ID for the next-hop
233 @param bde_next_hop_proto_is_ip4 - The next-hop is IPV4
234 @param bde_next_hop[16] - the nextop address.
235 Set this to all 0s for dispostion.
237 autoreply define bier_disp_entry_add_del
244 u8 bde_payload_proto;
246 vl_api_fib_path3_t bde_paths[bde_n_paths];
249 define bier_disp_entry_dump
256 define bier_disp_entry_details
262 u8 bde_payload_proto;
264 vl_api_fib_path3_t bde_paths[bde_n_paths];
269 * eval: (c-set-style "gnu")