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 fib_api_path_encode(api_rpath, fp);
314 vl_api_send_msg (ctx->reg, (u8 *) mp);
318 vl_api_bier_route_dump_t_handler (vl_api_bier_route_dump_t * mp)
320 vl_api_registration_t *reg;
322 reg = vl_api_client_index_to_registration (mp->client_index);
326 bier_table_id_t bti = {
327 .bti_set = mp->br_tbl_id.bt_set,
328 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
329 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
330 .bti_type = BIER_TABLE_MPLS_SPF,
331 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
333 bier_route_details_walk_t ctx = {
335 .context = mp->context,
337 bier_table_walk(&bti, send_bier_route_details, &ctx);
341 vl_api_bier_imp_add_t_handler (vl_api_bier_imp_add_t * mp)
343 vl_api_bier_imp_add_reply_t *rmp;
348 vnm = vnet_get_main ();
352 * The BSL support by VPP is limited to the size of the
353 * available space in the vlib_buffer_t
355 if (mp->bi_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
357 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
361 bier_table_id_t bti = {
362 .bti_set = mp->bi_tbl_id.bt_set,
363 .bti_sub_domain = mp->bi_tbl_id.bt_sub_domain,
364 .bti_hdr_len = mp->bi_tbl_id.bt_hdr_len_id,
365 .bti_type = BIER_TABLE_MPLS_SPF,
366 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
368 bier_bit_string_t bs = {
369 .bbs_len = mp->bi_n_bytes,
370 .bbs_buckets = mp->bi_bytes,
373 bii = bier_imp_add_or_lock(&bti, ntohs(mp->bi_src), &bs);
376 REPLY_MACRO2 (VL_API_BIER_IMP_ADD_REPLY,
378 rmp->bi_index = ntohl (bii);
383 vl_api_bier_imp_del_t_handler (vl_api_bier_imp_del_t * mp)
385 vl_api_bier_imp_del_reply_t *rmp;
389 vnm = vnet_get_main ();
392 bier_imp_unlock(ntohl(mp->bi_index));
394 REPLY_MACRO(VL_API_BIER_IMP_DEL_REPLY);
398 send_bier_imp_details (vl_api_registration_t * reg,
400 const bier_imp_t *bi)
402 vl_api_bier_imp_details_t *mp;
407 bier_hdr_ntoh(©);
409 n_bytes = bier_hdr_len_id_to_num_bytes(
410 bier_hdr_get_len_id(©));
411 mp = vl_msg_api_alloc(sizeof(*mp) + n_bytes);
414 memset(mp, 0, sizeof(*mp)+n_bytes);
415 mp->_vl_msg_id = ntohs(VL_API_BIER_IMP_DETAILS);
416 mp->context = context;
418 mp->bi_tbl_id.bt_set = bi->bi_tbl.bti_set;
419 mp->bi_tbl_id.bt_sub_domain = bi->bi_tbl.bti_sub_domain;
420 mp->bi_tbl_id.bt_hdr_len_id = bi->bi_tbl.bti_hdr_len;
422 mp->bi_src = htons(bier_hdr_get_src_id(©));
423 mp->bi_n_bytes = n_bytes;
424 memcpy(mp->bi_bytes, bi->bi_bits, n_bytes);
426 vl_api_send_msg (reg, (u8 *) mp);
430 vl_api_bier_imp_dump_t_handler (vl_api_bier_imp_dump_t * mp)
432 vl_api_registration_t *reg;
435 reg = vl_api_client_index_to_registration (mp->client_index);
439 pool_foreach(bi, bier_imp_pool,
441 send_bier_imp_details(reg, mp->context, bi);
446 vl_api_bier_disp_table_add_del_t_handler (vl_api_bier_disp_table_add_del_t * mp)
448 vl_api_bier_disp_table_add_del_reply_t *rmp;
453 vnm = vnet_get_main ();
455 table_id = ntohl(mp->bdt_tbl_id);
459 bier_disp_table_add_or_lock(table_id);
463 bier_disp_table_unlock_w_table_id(table_id);
468 REPLY_MACRO (VL_API_BIER_DISP_TABLE_ADD_DEL_REPLY);
472 send_bier_disp_table_details (vl_api_registration_t * reg,
474 const bier_disp_table_t *bdt)
476 vl_api_bier_disp_table_details_t *mp;
478 mp = vl_msg_api_alloc(sizeof(*mp));
481 memset(mp, 0, sizeof(*mp));
482 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_TABLE_DETAILS);
483 mp->context = context;
485 mp->bdt_tbl_id = htonl(bdt->bdt_table_id);
487 vl_api_send_msg (reg, (u8 *) mp);
491 vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp)
493 vl_api_registration_t *reg;
494 bier_disp_table_t *bdt;
496 reg = vl_api_client_index_to_registration (mp->client_index);
500 pool_foreach(bdt, bier_disp_table_pool,
502 send_bier_disp_table_details(reg, mp->context, bdt);
507 vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp)
509 vl_api_bier_disp_entry_add_del_reply_t *rmp;
510 fib_route_path_t *brps = NULL, *brp;
517 vnm = vnet_get_main ();
519 table_id = ntohl(mp->bde_tbl_id);
520 bp = ntohs(mp->bde_bp);
523 * BP=0 is the default route
531 vec_validate(brps, mp->bde_n_paths - 1);
532 vec_foreach_index(ii, brps)
535 brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id);
536 brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index);
538 if (~0 != ntohl(mp->bde_paths[ii].rpf_id))
540 brp->frp_flags = FIB_ROUTE_PATH_RPF_ID;
541 brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id);
544 if (0 == mp->bde_paths[ii].afi)
546 clib_memcpy (&brp->frp_addr.ip4,
547 mp->bde_paths[ii].next_hop,
548 sizeof (brp->frp_addr.ip4));
552 clib_memcpy (&brp->frp_addr.ip6,
553 mp->bde_paths[ii].next_hop,
554 sizeof (brp->frp_addr.ip6));
556 if (ip46_address_is_zero(&brp->frp_addr))
560 switch (mp->bde_payload_proto)
562 case BIER_HDR_PROTO_INVALID:
563 case BIER_HDR_PROTO_MPLS_DOWN_STREAM:
564 case BIER_HDR_PROTO_MPLS_UP_STREAM:
565 case BIER_HDR_PROTO_ETHERNET:
566 case BIER_HDR_PROTO_VXLAN:
567 case BIER_HDR_PROTO_CTRL:
568 case BIER_HDR_PROTO_OAM:
569 rv = VNET_API_ERROR_UNSUPPORTED;
572 case BIER_HDR_PROTO_IPV4:
573 case BIER_HDR_PROTO_IPV6:
575 fib_protocol_t fproto;
577 fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ?
581 if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID)
583 fti = mfib_table_find (fproto,
584 ntohl (mp->bde_paths[ii].table_id));
588 fti = fib_table_find (fproto,
589 ntohl (mp->bde_paths[ii].table_id));
592 if (INDEX_INVALID != fti)
594 brp->frp_fib_index = fti;
598 rv = VNET_API_ERROR_NO_SUCH_FIB;
609 bier_disp_table_entry_path_add(table_id, bp,
610 mp->bde_payload_proto,
615 bier_disp_table_entry_path_remove(table_id, bp,
616 mp->bde_payload_proto,
622 rv = (rv == 0) ? vnm->api_errno : rv;
624 REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY);
627 typedef struct bier_disp_entry_details_walk_t_
629 vl_api_registration_t * reg;
631 } bier_disp_entry_details_walk_t;
634 send_bier_disp_entry_details (const bier_disp_table_t *bdt,
635 const bier_disp_entry_t *bde,
639 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
640 bier_disp_entry_details_walk_t *ctx = args;
641 vl_api_bier_disp_entry_details_t *mp;
642 bier_hdr_proto_id_t pproto;
643 vl_api_fib_path_t *fp;
646 FOR_EACH_BIER_HDR_PROTO(pproto)
648 fib_node_index_t pl = bde->bde_pl[pproto];
649 if (INDEX_INVALID != pl)
651 n_paths = fib_path_list_get_n_paths(pl);
652 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
653 mp = vl_msg_api_alloc(m_size);
657 memset(mp, 0, m_size);
658 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_ENTRY_DETAILS);
659 mp->context = ctx->context;
661 mp->bde_tbl_id = htonl(bdt->bdt_table_id);
662 mp->bde_n_paths = htonl(n_paths);
663 mp->bde_payload_proto = pproto;
664 mp->bde_bp = htons(bp);
666 fib_path_list_walk(pl, fib_path_encode, &api_rpaths);
669 vec_foreach (api_rpath, api_rpaths)
671 fib_api_path_encode(api_rpath, fp);
675 vl_api_send_msg (ctx->reg, (u8 *) mp);
681 vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp)
683 vl_api_registration_t *reg;
685 reg = vl_api_client_index_to_registration (mp->client_index);
689 bier_disp_entry_details_walk_t ctx = {
691 .context = mp->context,
693 bier_disp_table_walk(ntohl(mp->bde_tbl_id),
694 send_bier_disp_entry_details,
698 #define vl_msg_name_crc_list
699 #include <vnet/bier/bier.api.h>
700 #undef vl_msg_name_crc_list
703 setup_message_id_table (api_main_t * am)
705 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
706 foreach_vl_msg_name_crc_bier;
710 static clib_error_t *
711 bier_api_hookup (vlib_main_t * vm)
713 api_main_t *am = &api_main;
716 vl_msg_api_set_handlers(VL_API_##N, #n, \
717 vl_api_##n##_t_handler, \
719 vl_api_##n##_t_endian, \
720 vl_api_##n##_t_print, \
721 sizeof(vl_api_##n##_t), 1);
722 foreach_bier_api_msg;
726 * Set up the (msg_name, crc, message-id) table
728 setup_message_id_table (am);
733 VLIB_API_INIT_FUNCTION (bier_api_hookup);