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>
52 #include <vnet/fib/fib_api.h>
54 #define foreach_bier_api_msg \
55 _(BIER_TABLE_ADD_DEL, bier_table_add_del) \
56 _(BIER_TABLE_DUMP, bier_table_dump) \
57 _(BIER_ROUTE_ADD_DEL, bier_route_add_del) \
58 _(BIER_ROUTE_DUMP, bier_route_dump) \
59 _(BIER_IMP_ADD, bier_imp_add) \
60 _(BIER_IMP_DEL, bier_imp_del) \
61 _(BIER_IMP_DUMP, bier_imp_dump) \
62 _(BIER_DISP_TABLE_ADD_DEL, bier_disp_table_add_del) \
63 _(BIER_DISP_TABLE_DUMP, bier_disp_table_dump) \
64 _(BIER_DISP_ENTRY_ADD_DEL, bier_disp_entry_add_del) \
65 _(BIER_DISP_ENTRY_DUMP, bier_disp_entry_dump)
68 vl_api_bier_table_add_del_t_handler (vl_api_bier_table_add_del_t * mp)
70 vl_api_bier_table_add_del_reply_t *rmp;
74 vnm = vnet_get_main ();
77 if (mp->bt_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
79 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
83 bier_table_id_t bti = {
84 .bti_set = mp->bt_tbl_id.bt_set,
85 .bti_sub_domain = mp->bt_tbl_id.bt_sub_domain,
86 .bti_hdr_len = mp->bt_tbl_id.bt_hdr_len_id,
87 .bti_type = BIER_TABLE_MPLS_SPF,
88 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
93 mpls_label_t label = ntohl(mp->bt_label);
96 * convert acceptable 'don't want a label' values from
97 * the API to the correct internal INVLID value
99 if ((0 == label) || (~0 == label))
101 label = MPLS_LABEL_INVALID;
103 bier_table_add_or_lock(&bti, label);
107 bier_table_unlock(&bti);
113 REPLY_MACRO (VL_API_BIER_TABLE_ADD_DEL_REPLY);
117 send_bier_table_details (vl_api_registration_t * reg,
119 const bier_table_t *bt)
121 vl_api_bier_table_details_t *mp;
123 mp = vl_msg_api_alloc(sizeof(*mp));
126 memset(mp, 0, sizeof(*mp));
127 mp->_vl_msg_id = ntohs(VL_API_BIER_TABLE_DETAILS);
128 mp->context = context;
130 mp->bt_label = bt->bt_ll;
131 mp->bt_tbl_id.bt_set = bt->bt_id.bti_set;
132 mp->bt_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
133 mp->bt_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
135 vl_api_send_msg (reg, (u8 *) mp);
139 vl_api_bier_table_dump_t_handler (vl_api_bier_table_dump_t * mp)
141 vl_api_registration_t *reg;
144 reg = vl_api_client_index_to_registration (mp->client_index);
148 pool_foreach(bt, bier_table_pool,
151 * skip the ecmp tables.
153 if (bier_table_is_main(bt))
155 send_bier_table_details(reg, mp->context, bt);
161 vl_api_bier_route_add_del_t_handler (vl_api_bier_route_add_del_t * mp)
163 vl_api_bier_route_add_del_reply_t *rmp;
164 fib_route_path_t *brpaths, *brpath;
170 vnm = vnet_get_main ();
172 bp = ntohl(mp->br_bp);
175 if (mp->br_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
177 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
180 if (0 == bp || bp > BIER_BP_MAX)
186 bier_table_id_t bti = {
187 .bti_set = mp->br_tbl_id.bt_set,
188 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
189 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
190 .bti_type = BIER_TABLE_MPLS_SPF,
191 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
194 vec_validate(brpaths, mp->br_n_paths - 1);
196 vec_foreach_index(ii, brpaths)
198 brpath = &brpaths[ii];
199 rv = fib_path_api_parse(&mp->br_paths[ii], brpath);
207 if (mp->br_is_replace)
209 if (0 == vec_len(brpaths))
211 bier_table_route_delete(&bti, bp);
215 bier_table_route_path_update(&bti, bp, brpaths);
218 else if (mp->br_is_add)
220 bier_table_route_path_add(&bti, bp, brpaths);
224 bier_table_route_path_remove(&bti, bp, brpaths);
229 rv = (rv == 0) ? vnm->api_errno : rv;
231 REPLY_MACRO (VL_API_BIER_ROUTE_ADD_DEL_REPLY);
234 typedef struct bier_route_details_walk_t_
236 vl_api_registration_t * reg;
238 } bier_route_details_walk_t;
241 send_bier_route_details (const bier_table_t *bt,
242 const bier_entry_t *be,
245 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
246 bier_route_details_walk_t *ctx = args;
247 vl_api_bier_route_details_t *mp;
248 vl_api_fib_path_t *fp;
251 n_paths = fib_path_list_get_n_paths(be->be_path_list);
252 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
253 mp = vl_msg_api_alloc(m_size);
257 memset(mp, 0, m_size);
258 mp->_vl_msg_id = ntohs(VL_API_BIER_ROUTE_DETAILS);
259 mp->context = ctx->context;
261 mp->br_tbl_id.bt_set = bt->bt_id.bti_set;
262 mp->br_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
263 mp->br_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
264 mp->br_bp = htons(be->be_bp);
265 mp->br_n_paths = htonl(n_paths);
267 fib_path_list_walk(be->be_path_list, fib_path_encode, &api_rpaths);
270 vec_foreach (api_rpath, api_rpaths)
272 fib_api_path_encode(api_rpath, fp);
276 vl_api_send_msg (ctx->reg, (u8 *) mp);
280 vl_api_bier_route_dump_t_handler (vl_api_bier_route_dump_t * mp)
282 vl_api_registration_t *reg;
284 reg = vl_api_client_index_to_registration (mp->client_index);
288 bier_table_id_t bti = {
289 .bti_set = mp->br_tbl_id.bt_set,
290 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
291 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
292 .bti_type = BIER_TABLE_MPLS_SPF,
293 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
295 bier_route_details_walk_t ctx = {
297 .context = mp->context,
299 bier_table_walk(&bti, send_bier_route_details, &ctx);
303 vl_api_bier_imp_add_t_handler (vl_api_bier_imp_add_t * mp)
305 vl_api_bier_imp_add_reply_t *rmp;
310 vnm = vnet_get_main ();
314 * The BSL support by VPP is limited to the size of the
315 * available space in the vlib_buffer_t
317 if (mp->bi_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
319 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
323 bier_table_id_t bti = {
324 .bti_set = mp->bi_tbl_id.bt_set,
325 .bti_sub_domain = mp->bi_tbl_id.bt_sub_domain,
326 .bti_hdr_len = mp->bi_tbl_id.bt_hdr_len_id,
327 .bti_type = BIER_TABLE_MPLS_SPF,
328 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
330 bier_bit_string_t bs = {
331 .bbs_len = mp->bi_n_bytes,
332 .bbs_buckets = mp->bi_bytes,
335 bii = bier_imp_add_or_lock(&bti, ntohs(mp->bi_src), &bs);
338 REPLY_MACRO2 (VL_API_BIER_IMP_ADD_REPLY,
340 rmp->bi_index = ntohl (bii);
345 vl_api_bier_imp_del_t_handler (vl_api_bier_imp_del_t * mp)
347 vl_api_bier_imp_del_reply_t *rmp;
351 vnm = vnet_get_main ();
354 bier_imp_unlock(ntohl(mp->bi_index));
356 REPLY_MACRO(VL_API_BIER_IMP_DEL_REPLY);
360 send_bier_imp_details (vl_api_registration_t * reg,
362 const bier_imp_t *bi)
364 vl_api_bier_imp_details_t *mp;
369 bier_hdr_ntoh(©);
371 n_bytes = bier_hdr_len_id_to_num_bytes(
372 bier_hdr_get_len_id(©));
373 mp = vl_msg_api_alloc(sizeof(*mp) + n_bytes);
376 memset(mp, 0, sizeof(*mp)+n_bytes);
377 mp->_vl_msg_id = ntohs(VL_API_BIER_IMP_DETAILS);
378 mp->context = context;
380 mp->bi_tbl_id.bt_set = bi->bi_tbl.bti_set;
381 mp->bi_tbl_id.bt_sub_domain = bi->bi_tbl.bti_sub_domain;
382 mp->bi_tbl_id.bt_hdr_len_id = bi->bi_tbl.bti_hdr_len;
384 mp->bi_src = htons(bier_hdr_get_src_id(©));
385 mp->bi_n_bytes = n_bytes;
386 memcpy(mp->bi_bytes, bi->bi_bits, n_bytes);
388 vl_api_send_msg (reg, (u8 *) mp);
392 vl_api_bier_imp_dump_t_handler (vl_api_bier_imp_dump_t * mp)
394 vl_api_registration_t *reg;
397 reg = vl_api_client_index_to_registration (mp->client_index);
401 pool_foreach(bi, bier_imp_pool,
403 send_bier_imp_details(reg, mp->context, bi);
408 vl_api_bier_disp_table_add_del_t_handler (vl_api_bier_disp_table_add_del_t * mp)
410 vl_api_bier_disp_table_add_del_reply_t *rmp;
415 vnm = vnet_get_main ();
417 table_id = ntohl(mp->bdt_tbl_id);
421 bier_disp_table_add_or_lock(table_id);
425 bier_disp_table_unlock_w_table_id(table_id);
430 REPLY_MACRO (VL_API_BIER_DISP_TABLE_ADD_DEL_REPLY);
434 send_bier_disp_table_details (vl_api_registration_t * reg,
436 const bier_disp_table_t *bdt)
438 vl_api_bier_disp_table_details_t *mp;
440 mp = vl_msg_api_alloc(sizeof(*mp));
443 memset(mp, 0, sizeof(*mp));
444 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_TABLE_DETAILS);
445 mp->context = context;
447 mp->bdt_tbl_id = htonl(bdt->bdt_table_id);
449 vl_api_send_msg (reg, (u8 *) mp);
453 vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp)
455 vl_api_registration_t *reg;
456 bier_disp_table_t *bdt;
458 reg = vl_api_client_index_to_registration (mp->client_index);
462 pool_foreach(bdt, bier_disp_table_pool,
464 send_bier_disp_table_details(reg, mp->context, bdt);
469 vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp)
471 vl_api_bier_disp_entry_add_del_reply_t *rmp;
472 fib_route_path_t *brps = NULL, *brp;
479 vnm = vnet_get_main ();
481 table_id = ntohl(mp->bde_tbl_id);
482 bp = ntohs(mp->bde_bp);
485 * BP=0 is the default route
493 vec_validate(brps, mp->bde_n_paths - 1);
494 vec_foreach_index(ii, brps)
497 brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id);
498 brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index);
500 if (~0 != ntohl(mp->bde_paths[ii].rpf_id))
502 brp->frp_flags = FIB_ROUTE_PATH_RPF_ID;
503 brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id);
506 if (0 == mp->bde_paths[ii].afi)
508 clib_memcpy (&brp->frp_addr.ip4,
509 mp->bde_paths[ii].next_hop,
510 sizeof (brp->frp_addr.ip4));
514 clib_memcpy (&brp->frp_addr.ip6,
515 mp->bde_paths[ii].next_hop,
516 sizeof (brp->frp_addr.ip6));
518 if (ip46_address_is_zero(&brp->frp_addr))
522 switch (mp->bde_payload_proto)
524 case BIER_HDR_PROTO_INVALID:
525 case BIER_HDR_PROTO_MPLS_DOWN_STREAM:
526 case BIER_HDR_PROTO_MPLS_UP_STREAM:
527 case BIER_HDR_PROTO_ETHERNET:
528 case BIER_HDR_PROTO_VXLAN:
529 case BIER_HDR_PROTO_CTRL:
530 case BIER_HDR_PROTO_OAM:
531 rv = VNET_API_ERROR_UNSUPPORTED;
534 case BIER_HDR_PROTO_IPV4:
535 case BIER_HDR_PROTO_IPV6:
537 fib_protocol_t fproto;
539 fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ?
543 if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID)
545 fti = mfib_table_find (fproto,
546 ntohl (mp->bde_paths[ii].table_id));
550 fti = fib_table_find (fproto,
551 ntohl (mp->bde_paths[ii].table_id));
554 if (INDEX_INVALID != fti)
556 brp->frp_fib_index = fti;
560 rv = VNET_API_ERROR_NO_SUCH_FIB;
571 bier_disp_table_entry_path_add(table_id, bp,
572 mp->bde_payload_proto,
577 bier_disp_table_entry_path_remove(table_id, bp,
578 mp->bde_payload_proto,
584 rv = (rv == 0) ? vnm->api_errno : rv;
586 REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY);
589 typedef struct bier_disp_entry_details_walk_t_
591 vl_api_registration_t * reg;
593 } bier_disp_entry_details_walk_t;
596 send_bier_disp_entry_details (const bier_disp_table_t *bdt,
597 const bier_disp_entry_t *bde,
601 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
602 bier_disp_entry_details_walk_t *ctx = args;
603 vl_api_bier_disp_entry_details_t *mp;
604 bier_hdr_proto_id_t pproto;
605 vl_api_fib_path_t *fp;
608 FOR_EACH_BIER_HDR_PROTO(pproto)
610 fib_node_index_t pl = bde->bde_pl[pproto];
611 if (INDEX_INVALID != pl)
613 n_paths = fib_path_list_get_n_paths(pl);
614 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
615 mp = vl_msg_api_alloc(m_size);
619 memset(mp, 0, m_size);
620 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_ENTRY_DETAILS);
621 mp->context = ctx->context;
623 mp->bde_tbl_id = htonl(bdt->bdt_table_id);
624 mp->bde_n_paths = htonl(n_paths);
625 mp->bde_payload_proto = pproto;
626 mp->bde_bp = htons(bp);
628 fib_path_list_walk(pl, fib_path_encode, &api_rpaths);
631 vec_foreach (api_rpath, api_rpaths)
633 fib_api_path_encode(api_rpath, fp);
637 vl_api_send_msg (ctx->reg, (u8 *) mp);
643 vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp)
645 vl_api_registration_t *reg;
647 reg = vl_api_client_index_to_registration (mp->client_index);
651 bier_disp_entry_details_walk_t ctx = {
653 .context = mp->context,
655 bier_disp_table_walk(ntohl(mp->bde_tbl_id),
656 send_bier_disp_entry_details,
660 #define vl_msg_name_crc_list
661 #include <vnet/bier/bier.api.h>
662 #undef vl_msg_name_crc_list
665 setup_message_id_table (api_main_t * am)
667 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
668 foreach_vl_msg_name_crc_bier;
672 static clib_error_t *
673 bier_api_hookup (vlib_main_t * vm)
675 api_main_t *am = &api_main;
678 vl_msg_api_set_handlers(VL_API_##N, #n, \
679 vl_api_##n##_t_handler, \
681 vl_api_##n##_t_endian, \
682 vl_api_##n##_t_print, \
683 sizeof(vl_api_##n##_t), 1);
684 foreach_bier_api_msg;
688 * Set up the (msg_name, crc, message-id) table
690 setup_message_id_table (am);
695 VLIB_API_INIT_FUNCTION (bier_api_hookup);