2 *------------------------------------------------------------------
3 * bier_api.c - vnet BIER api
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/api_errno.h>
24 #include <vnet/bier/bier_table.h>
25 #include <vnet/bier/bier_imp.h>
26 #include <vnet/bier/bier_disp_table.h>
27 #include <vnet/bier/bier_disp_entry.h>
28 #include <vnet/bier/bier_bit_string.h>
29 #include <vnet/bier/bier_hdr_inlines.h>
30 #include <vnet/fib/fib_path_list.h>
31 #include <vnet/fib/fib_api.h>
32 #include <vnet/fib/fib_table.h>
33 #include <vnet/mfib/mfib_table.h>
35 #include <vnet/vnet_msg_enum.h>
37 #define vl_typedefs /* define message structures */
38 #include <vnet/vnet_all_api_h.h>
41 #define vl_endianfun /* define message structures */
42 #include <vnet/vnet_all_api_h.h>
45 /* instantiate all the print functions we know about */
46 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
48 #include <vnet/vnet_all_api_h.h>
51 #include <vlibapi/api_helper_macros.h>
53 #define foreach_bier_api_msg \
54 _(BIER_TABLE_ADD_DEL, bier_table_add_del) \
55 _(BIER_TABLE_DUMP, bier_table_dump) \
56 _(BIER_ROUTE_ADD_DEL, bier_route_add_del) \
57 _(BIER_ROUTE_DUMP, bier_route_dump) \
58 _(BIER_IMP_ADD, bier_imp_add) \
59 _(BIER_IMP_DEL, bier_imp_del) \
60 _(BIER_IMP_DUMP, bier_imp_dump) \
61 _(BIER_DISP_TABLE_ADD_DEL, bier_disp_table_add_del) \
62 _(BIER_DISP_TABLE_DUMP, bier_disp_table_dump) \
63 _(BIER_DISP_ENTRY_ADD_DEL, bier_disp_entry_add_del) \
64 _(BIER_DISP_ENTRY_DUMP, bier_disp_entry_dump)
67 vl_api_bier_table_add_del_t_handler (vl_api_bier_table_add_del_t * mp)
69 vl_api_bier_table_add_del_reply_t *rmp;
73 vnm = vnet_get_main ();
76 if (mp->bt_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
78 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
82 bier_table_id_t bti = {
83 .bti_set = mp->bt_tbl_id.bt_set,
84 .bti_sub_domain = mp->bt_tbl_id.bt_sub_domain,
85 .bti_hdr_len = mp->bt_tbl_id.bt_hdr_len_id,
86 .bti_type = BIER_TABLE_MPLS_SPF,
87 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
92 mpls_label_t label = ntohl(mp->bt_label);
95 * convert acceptable 'don't want a label' values from
96 * the API to the correct internal INVLID value
98 if ((0 == label) || (~0 == label))
100 label = MPLS_LABEL_INVALID;
102 bier_table_add_or_lock(&bti, label);
106 bier_table_unlock(&bti);
112 REPLY_MACRO (VL_API_BIER_TABLE_ADD_DEL_REPLY);
116 send_bier_table_details (vl_api_registration_t * reg,
118 const bier_table_t *bt)
120 vl_api_bier_table_details_t *mp;
122 mp = vl_msg_api_alloc(sizeof(*mp));
125 memset(mp, 0, sizeof(*mp));
126 mp->_vl_msg_id = ntohs(VL_API_BIER_TABLE_DETAILS);
127 mp->context = context;
129 mp->bt_label = bt->bt_ll;
130 mp->bt_tbl_id.bt_set = bt->bt_id.bti_set;
131 mp->bt_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
132 mp->bt_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
134 vl_api_send_msg (reg, (u8 *) mp);
138 vl_api_bier_table_dump_t_handler (vl_api_bier_table_dump_t * mp)
140 vl_api_registration_t *reg;
143 reg = vl_api_client_index_to_registration (mp->client_index);
147 pool_foreach(bt, bier_table_pool,
150 * skip the ecmp tables.
152 if (bier_table_is_main(bt))
154 send_bier_table_details(reg, mp->context, bt);
160 vl_api_bier_route_add_del_t_handler (vl_api_bier_route_add_del_t * mp)
162 vl_api_bier_route_add_del_reply_t *rmp;
163 fib_route_path_t *brpaths, *brpath;
169 vnm = vnet_get_main ();
171 bp = ntohl(mp->br_bp);
174 if (mp->br_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
176 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
179 if (0 == bp || bp > BIER_BP_MAX)
185 bier_table_id_t bti = {
186 .bti_set = mp->br_tbl_id.bt_set,
187 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
188 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
189 .bti_type = BIER_TABLE_MPLS_SPF,
190 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
193 vec_validate(brpaths, mp->br_n_paths - 1);
195 vec_foreach_index(ii, brpaths)
197 brpath = &brpaths[ii];
198 memset(brpath, 0, sizeof(*brpath));
199 brpath->frp_sw_if_index = ~0;
201 vec_validate(brpath->frp_label_stack,
202 mp->br_paths[ii].n_labels - 1);
203 for (jj = 0; jj < mp->br_paths[ii].n_labels; jj++)
205 brpath->frp_label_stack[jj].fml_value =
206 ntohl(mp->br_paths[ii].label_stack[jj].label);
207 brpath->frp_label_stack[jj].fml_ttl =
208 mp->br_paths[ii].label_stack[jj].ttl;
209 brpath->frp_label_stack[jj].fml_exp =
210 mp->br_paths[ii].label_stack[jj].exp;
211 brpath->frp_label_stack[jj].fml_mode =
212 (mp->br_paths[ii].label_stack[jj].is_uniform ?
213 FIB_MPLS_LSP_MODE_UNIFORM :
214 FIB_MPLS_LSP_MODE_PIPE);
217 if (mp->br_paths[ii].is_udp_encap)
219 brpath->frp_flags |= FIB_ROUTE_PATH_UDP_ENCAP;
220 brpath->frp_udp_encap_id = ntohl(mp->br_paths[ii].next_hop_id);
224 if (0 == mp->br_paths[ii].afi)
226 clib_memcpy (&brpath->frp_addr.ip4,
227 mp->br_paths[ii].next_hop,
228 sizeof (brpath->frp_addr.ip4));
232 clib_memcpy (&brpath->frp_addr.ip6,
233 mp->br_paths[ii].next_hop,
234 sizeof (brpath->frp_addr.ip6));
236 if (ip46_address_is_zero(&brpath->frp_addr))
240 bdti = bier_disp_table_find(ntohl(mp->br_paths[ii].table_id));
242 if (INDEX_INVALID != bdti)
244 brpath->frp_fib_index = bdti;
245 brpath->frp_proto = DPO_PROTO_BIER;
249 rv = VNET_API_ERROR_NO_SUCH_FIB;
258 bier_table_route_add(&bti, bp, brpaths);
262 bier_table_route_remove(&bti, bp, brpaths);
267 rv = (rv == 0) ? vnm->api_errno : rv;
269 REPLY_MACRO (VL_API_BIER_ROUTE_ADD_DEL_REPLY);
272 typedef struct bier_route_details_walk_t_
274 vl_api_registration_t * reg;
276 } bier_route_details_walk_t;
279 send_bier_route_details (const bier_table_t *bt,
280 const bier_entry_t *be,
283 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
284 bier_route_details_walk_t *ctx = args;
285 vl_api_bier_route_details_t *mp;
286 vl_api_fib_path_t *fp;
289 n_paths = fib_path_list_get_n_paths(be->be_path_list);
290 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
291 mp = vl_msg_api_alloc(m_size);
295 memset(mp, 0, m_size);
296 mp->_vl_msg_id = ntohs(VL_API_BIER_ROUTE_DETAILS);
297 mp->context = ctx->context;
299 mp->br_tbl_id.bt_set = bt->bt_id.bti_set;
300 mp->br_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
301 mp->br_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
302 mp->br_bp = htons(be->be_bp);
303 mp->br_n_paths = htonl(n_paths);
305 fib_path_list_walk(be->be_path_list, fib_path_encode, &api_rpaths);
308 vec_foreach (api_rpath, api_rpaths)
310 fp->weight = api_rpath->rpath.frp_weight;
311 fp->preference = api_rpath->rpath.frp_preference;
312 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
314 copy_fib_next_hop (api_rpath, fp);
318 vl_api_send_msg (ctx->reg, (u8 *) mp);
322 vl_api_bier_route_dump_t_handler (vl_api_bier_route_dump_t * mp)
324 vl_api_registration_t *reg;
326 reg = vl_api_client_index_to_registration (mp->client_index);
330 bier_table_id_t bti = {
331 .bti_set = mp->br_tbl_id.bt_set,
332 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
333 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
334 .bti_type = BIER_TABLE_MPLS_SPF,
335 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
337 bier_route_details_walk_t ctx = {
339 .context = mp->context,
341 bier_table_walk(&bti, send_bier_route_details, &ctx);
345 vl_api_bier_imp_add_t_handler (vl_api_bier_imp_add_t * mp)
347 vl_api_bier_imp_add_reply_t *rmp;
352 vnm = vnet_get_main ();
356 * The BSL support by VPP is limited to the size of the
357 * available space in the vlib_buffer_t
359 if (mp->bi_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
361 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
365 bier_table_id_t bti = {
366 .bti_set = mp->bi_tbl_id.bt_set,
367 .bti_sub_domain = mp->bi_tbl_id.bt_sub_domain,
368 .bti_hdr_len = mp->bi_tbl_id.bt_hdr_len_id,
369 .bti_type = BIER_TABLE_MPLS_SPF,
370 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
372 bier_bit_string_t bs = {
373 .bbs_len = mp->bi_n_bytes,
374 .bbs_buckets = mp->bi_bytes,
377 bii = bier_imp_add_or_lock(&bti, ntohs(mp->bi_src), &bs);
380 REPLY_MACRO2 (VL_API_BIER_IMP_ADD_REPLY,
382 rmp->bi_index = ntohl (bii);
387 vl_api_bier_imp_del_t_handler (vl_api_bier_imp_del_t * mp)
389 vl_api_bier_imp_del_reply_t *rmp;
393 vnm = vnet_get_main ();
396 bier_imp_unlock(ntohl(mp->bi_index));
398 REPLY_MACRO(VL_API_BIER_IMP_DEL_REPLY);
402 send_bier_imp_details (vl_api_registration_t * reg,
404 const bier_imp_t *bi)
406 vl_api_bier_imp_details_t *mp;
411 bier_hdr_ntoh(©);
413 n_bytes = bier_hdr_len_id_to_num_bytes(
414 bier_hdr_get_len_id(©));
415 mp = vl_msg_api_alloc(sizeof(*mp) + n_bytes);
418 memset(mp, 0, sizeof(*mp)+n_bytes);
419 mp->_vl_msg_id = ntohs(VL_API_BIER_IMP_DETAILS);
420 mp->context = context;
422 mp->bi_tbl_id.bt_set = bi->bi_tbl.bti_set;
423 mp->bi_tbl_id.bt_sub_domain = bi->bi_tbl.bti_sub_domain;
424 mp->bi_tbl_id.bt_hdr_len_id = bi->bi_tbl.bti_hdr_len;
426 mp->bi_src = htons(bier_hdr_get_src_id(©));
427 mp->bi_n_bytes = n_bytes;
428 memcpy(mp->bi_bytes, bi->bi_bits, n_bytes);
430 vl_api_send_msg (reg, (u8 *) mp);
434 vl_api_bier_imp_dump_t_handler (vl_api_bier_imp_dump_t * mp)
436 vl_api_registration_t *reg;
439 reg = vl_api_client_index_to_registration (mp->client_index);
443 pool_foreach(bi, bier_imp_pool,
445 send_bier_imp_details(reg, mp->context, bi);
450 vl_api_bier_disp_table_add_del_t_handler (vl_api_bier_disp_table_add_del_t * mp)
452 vl_api_bier_disp_table_add_del_reply_t *rmp;
457 vnm = vnet_get_main ();
459 table_id = ntohl(mp->bdt_tbl_id);
463 bier_disp_table_add_or_lock(table_id);
467 bier_disp_table_unlock_w_table_id(table_id);
472 REPLY_MACRO (VL_API_BIER_DISP_TABLE_ADD_DEL_REPLY);
476 send_bier_disp_table_details (vl_api_registration_t * reg,
478 const bier_disp_table_t *bdt)
480 vl_api_bier_disp_table_details_t *mp;
482 mp = vl_msg_api_alloc(sizeof(*mp));
485 memset(mp, 0, sizeof(*mp));
486 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_TABLE_DETAILS);
487 mp->context = context;
489 mp->bdt_tbl_id = htonl(bdt->bdt_table_id);
491 vl_api_send_msg (reg, (u8 *) mp);
495 vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp)
497 vl_api_registration_t *reg;
498 bier_disp_table_t *bdt;
500 reg = vl_api_client_index_to_registration (mp->client_index);
504 pool_foreach(bdt, bier_disp_table_pool,
506 send_bier_disp_table_details(reg, mp->context, bdt);
511 vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp)
513 vl_api_bier_disp_entry_add_del_reply_t *rmp;
514 fib_route_path_t *brps = NULL, *brp;
521 vnm = vnet_get_main ();
523 table_id = ntohl(mp->bde_tbl_id);
524 bp = ntohs(mp->bde_bp);
527 * BP=0 is the default route
535 vec_validate(brps, mp->bde_n_paths - 1);
536 vec_foreach_index(ii, brps)
539 brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id);
540 brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index);
542 if (~0 != ntohl(mp->bde_paths[ii].rpf_id))
544 brp->frp_flags = FIB_ROUTE_PATH_RPF_ID;
545 brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id);
548 if (0 == mp->bde_paths[ii].afi)
550 clib_memcpy (&brp->frp_addr.ip4,
551 mp->bde_paths[ii].next_hop,
552 sizeof (brp->frp_addr.ip4));
556 clib_memcpy (&brp->frp_addr.ip6,
557 mp->bde_paths[ii].next_hop,
558 sizeof (brp->frp_addr.ip6));
560 if (ip46_address_is_zero(&brp->frp_addr))
564 switch (mp->bde_payload_proto)
566 case BIER_HDR_PROTO_INVALID:
567 case BIER_HDR_PROTO_MPLS_DOWN_STREAM:
568 case BIER_HDR_PROTO_MPLS_UP_STREAM:
569 case BIER_HDR_PROTO_ETHERNET:
570 case BIER_HDR_PROTO_VXLAN:
571 case BIER_HDR_PROTO_CTRL:
572 case BIER_HDR_PROTO_OAM:
573 rv = VNET_API_ERROR_UNSUPPORTED;
576 case BIER_HDR_PROTO_IPV4:
577 case BIER_HDR_PROTO_IPV6:
579 fib_protocol_t fproto;
581 fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ?
585 if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID)
587 fti = mfib_table_find (fproto,
588 ntohl (mp->bde_paths[ii].table_id));
592 fti = fib_table_find (fproto,
593 ntohl (mp->bde_paths[ii].table_id));
596 if (INDEX_INVALID != fti)
598 brp->frp_fib_index = fti;
602 rv = VNET_API_ERROR_NO_SUCH_FIB;
613 bier_disp_table_entry_path_add(table_id, bp,
614 mp->bde_payload_proto,
619 bier_disp_table_entry_path_remove(table_id, bp,
620 mp->bde_payload_proto,
626 rv = (rv == 0) ? vnm->api_errno : rv;
628 REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY);
631 typedef struct bier_disp_entry_details_walk_t_
633 vl_api_registration_t * reg;
635 } bier_disp_entry_details_walk_t;
638 send_bier_disp_entry_details (const bier_disp_table_t *bdt,
639 const bier_disp_entry_t *bde,
643 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
644 bier_disp_entry_details_walk_t *ctx = args;
645 vl_api_bier_disp_entry_details_t *mp;
646 bier_hdr_proto_id_t pproto;
647 vl_api_fib_path_t *fp;
650 FOR_EACH_BIER_HDR_PROTO(pproto)
652 fib_node_index_t pl = bde->bde_pl[pproto];
653 if (INDEX_INVALID != pl)
655 n_paths = fib_path_list_get_n_paths(pl);
656 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
657 mp = vl_msg_api_alloc(m_size);
661 memset(mp, 0, m_size);
662 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_ENTRY_DETAILS);
663 mp->context = ctx->context;
665 mp->bde_tbl_id = htonl(bdt->bdt_table_id);
666 mp->bde_n_paths = htonl(n_paths);
667 mp->bde_payload_proto = pproto;
668 mp->bde_bp = htons(bp);
670 fib_path_list_walk(pl, fib_path_encode, &api_rpaths);
673 vec_foreach (api_rpath, api_rpaths)
675 fp->weight = api_rpath->rpath.frp_weight;
676 fp->preference = api_rpath->rpath.frp_preference;
677 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
679 copy_fib_next_hop (api_rpath, fp);
683 vl_api_send_msg (ctx->reg, (u8 *) mp);
689 vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp)
691 vl_api_registration_t *reg;
693 reg = vl_api_client_index_to_registration (mp->client_index);
697 bier_disp_entry_details_walk_t ctx = {
699 .context = mp->context,
701 bier_disp_table_walk(ntohl(mp->bde_tbl_id),
702 send_bier_disp_entry_details,
706 #define vl_msg_name_crc_list
707 #include <vnet/bier/bier.api.h>
708 #undef vl_msg_name_crc_list
711 setup_message_id_table (api_main_t * am)
713 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
714 foreach_vl_msg_name_crc_bier;
718 static clib_error_t *
719 bier_api_hookup (vlib_main_t * vm)
721 api_main_t *am = &api_main;
724 vl_msg_api_set_handlers(VL_API_##N, #n, \
725 vl_api_##n##_t_handler, \
727 vl_api_##n##_t_endian, \
728 vl_api_##n##_t_print, \
729 sizeof(vl_api_##n##_t), 1);
730 foreach_bier_api_msg;
734 * Set up the (msg_name, crc, message-id) table
736 setup_message_id_table (am);
741 VLIB_API_INIT_FUNCTION (bier_api_hookup);