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/format_fns.h>
36 #include <bier/bier.api_enum.h>
37 #include <bier/bier.api_types.h>
39 #define REPLY_MSG_ID_BASE bier_main.msg_id_base
40 #include <vlibapi/api_helper_macros.h>
47 bier_main_t bier_main;
50 vl_api_bier_table_add_del_t_handler (vl_api_bier_table_add_del_t * mp)
52 vl_api_bier_table_add_del_reply_t *rmp;
56 vnm = vnet_get_main ();
59 if (mp->bt_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
61 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
65 bier_table_id_t bti = {
66 .bti_set = mp->bt_tbl_id.bt_set,
67 .bti_sub_domain = mp->bt_tbl_id.bt_sub_domain,
68 .bti_hdr_len = mp->bt_tbl_id.bt_hdr_len_id,
69 .bti_type = BIER_TABLE_MPLS_SPF,
70 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
75 mpls_label_t label = ntohl(mp->bt_label);
78 * convert acceptable 'don't want a label' values from
79 * the API to the correct internal INVLID value
81 if ((0 == label) || (~0 == label))
83 label = MPLS_LABEL_INVALID;
85 bier_table_add_or_lock(&bti, label);
89 bier_table_unlock(&bti);
95 REPLY_MACRO (VL_API_BIER_TABLE_ADD_DEL_REPLY);
99 send_bier_table_details (vl_api_registration_t * reg,
101 const bier_table_t *bt)
103 vl_api_bier_table_details_t *mp;
105 mp = vl_msg_api_alloc(sizeof(*mp));
108 clib_memset(mp, 0, sizeof(*mp));
109 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_BIER_TABLE_DETAILS);
110 mp->context = context;
112 mp->bt_label = bt->bt_ll;
113 mp->bt_tbl_id.bt_set = bt->bt_id.bti_set;
114 mp->bt_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
115 mp->bt_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
117 vl_api_send_msg (reg, (u8 *) mp);
121 vl_api_bier_table_dump_t_handler (vl_api_bier_table_dump_t * mp)
123 vl_api_registration_t *reg;
126 reg = vl_api_client_index_to_registration (mp->client_index);
130 pool_foreach (bt, bier_table_pool)
133 * skip the ecmp tables.
135 if (bier_table_is_main(bt))
137 send_bier_table_details(reg, mp->context, bt);
143 vl_api_bier_route_add_del_t_handler (vl_api_bier_route_add_del_t * mp)
145 vl_api_bier_route_add_del_reply_t *rmp;
146 fib_route_path_t *brpaths, *brpath;
152 vnm = vnet_get_main ();
154 bp = ntohl(mp->br_route.br_bp);
157 if (mp->br_route.br_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
159 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
162 if (0 == bp || bp > BIER_BP_MAX)
168 bier_table_id_t bti = {
169 .bti_set = mp->br_route.br_tbl_id.bt_set,
170 .bti_sub_domain = mp->br_route.br_tbl_id.bt_sub_domain,
171 .bti_hdr_len = mp->br_route.br_tbl_id.bt_hdr_len_id,
172 .bti_type = BIER_TABLE_MPLS_SPF,
173 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
176 vec_validate(brpaths, mp->br_route.br_n_paths - 1);
178 vec_foreach_index(ii, brpaths)
180 brpath = &brpaths[ii];
181 rv = fib_api_path_decode(&mp->br_route.br_paths[ii], brpath);
189 if (mp->br_is_replace)
191 if (0 == vec_len(brpaths))
193 bier_table_route_delete(&bti, bp);
197 bier_table_route_path_update(&bti, bp, brpaths);
200 else if (mp->br_is_add)
202 bier_table_route_path_add(&bti, bp, brpaths);
206 bier_table_route_path_remove(&bti, bp, brpaths);
211 rv = (rv == 0) ? vnm->api_errno : rv;
213 REPLY_MACRO (VL_API_BIER_ROUTE_ADD_DEL_REPLY);
216 typedef struct bier_route_details_walk_t_
218 vl_api_registration_t * reg;
220 } bier_route_details_walk_t;
223 send_bier_route_details (const bier_table_t *bt,
224 const bier_entry_t *be,
227 bier_route_details_walk_t *ctx = args;
228 vl_api_bier_route_details_t *mp;
229 fib_path_encode_ctx_t path_ctx = {
232 fib_route_path_t *rpath;
233 vl_api_fib_path_t *fp;
236 n_paths = fib_path_list_get_n_paths(be->be_path_list);
237 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
238 mp = vl_msg_api_alloc(m_size);
242 clib_memset(mp, 0, m_size);
243 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_BIER_ROUTE_DETAILS);
244 mp->context = ctx->context;
246 mp->br_route.br_tbl_id.bt_set = bt->bt_id.bti_set;
247 mp->br_route.br_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
248 mp->br_route.br_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
249 mp->br_route.br_bp = htonl(be->be_bp);
250 mp->br_route.br_n_paths = htonl(n_paths);
252 fib_path_list_walk_w_ext(be->be_path_list,
257 fp = mp->br_route.br_paths;
258 vec_foreach (rpath, path_ctx.rpaths)
260 fib_api_path_encode(rpath, fp);
264 vec_free(path_ctx.rpaths);
265 vl_api_send_msg (ctx->reg, (u8 *) mp);
269 vl_api_bier_route_dump_t_handler (vl_api_bier_route_dump_t * mp)
271 vl_api_registration_t *reg;
273 reg = vl_api_client_index_to_registration (mp->client_index);
277 bier_table_id_t bti = {
278 .bti_set = mp->br_tbl_id.bt_set,
279 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
280 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
281 .bti_type = BIER_TABLE_MPLS_SPF,
282 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
284 bier_route_details_walk_t ctx = {
286 .context = mp->context,
288 bier_table_walk(&bti, send_bier_route_details, &ctx);
292 vl_api_bier_imp_add_t_handler (vl_api_bier_imp_add_t * mp)
294 vl_api_bier_imp_add_reply_t *rmp;
299 vnm = vnet_get_main ();
303 * The BSL support by VPP is limited to the size of the
304 * available space in the vlib_buffer_t
306 if (mp->bi_tbl_id.bt_hdr_len_id >= BIER_HDR_LEN_2048)
308 rv = VNET_API_ERROR_BIER_BSL_UNSUP;
312 bier_table_id_t bti = {
313 .bti_set = mp->bi_tbl_id.bt_set,
314 .bti_sub_domain = mp->bi_tbl_id.bt_sub_domain,
315 .bti_hdr_len = mp->bi_tbl_id.bt_hdr_len_id,
316 .bti_type = BIER_TABLE_MPLS_SPF,
317 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
319 bier_bit_string_t bs = {
320 .bbs_len = mp->bi_n_bytes,
321 .bbs_buckets = mp->bi_bytes,
324 bii = bier_imp_add_or_lock(&bti, ntohs(mp->bi_src), &bs);
327 REPLY_MACRO2 (VL_API_BIER_IMP_ADD_REPLY,
329 rmp->bi_index = ntohl (bii);
334 vl_api_bier_imp_del_t_handler (vl_api_bier_imp_del_t * mp)
336 vl_api_bier_imp_del_reply_t *rmp;
340 vnm = vnet_get_main ();
343 bier_imp_unlock(ntohl(mp->bi_index));
345 REPLY_MACRO(VL_API_BIER_IMP_DEL_REPLY);
349 send_bier_imp_details (vl_api_registration_t * reg,
351 const bier_imp_t *bi)
353 vl_api_bier_imp_details_t *mp;
358 bier_hdr_ntoh(©);
360 n_bytes = bier_hdr_len_id_to_num_bytes(
361 bier_hdr_get_len_id(©));
362 mp = vl_msg_api_alloc(sizeof(*mp) + n_bytes);
365 clib_memset(mp, 0, sizeof(*mp)+n_bytes);
366 mp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_BIER_IMP_DETAILS);
367 mp->context = context;
369 mp->bi_tbl_id.bt_set = bi->bi_tbl.bti_set;
370 mp->bi_tbl_id.bt_sub_domain = bi->bi_tbl.bti_sub_domain;
371 mp->bi_tbl_id.bt_hdr_len_id = bi->bi_tbl.bti_hdr_len;
373 mp->bi_src = htons(bier_hdr_get_src_id(©));
374 mp->bi_n_bytes = n_bytes;
375 memcpy(mp->bi_bytes, bi->bi_bits, n_bytes);
377 vl_api_send_msg (reg, (u8 *) mp);
381 vl_api_bier_imp_dump_t_handler (vl_api_bier_imp_dump_t * mp)
383 vl_api_registration_t *reg;
386 reg = vl_api_client_index_to_registration (mp->client_index);
390 pool_foreach (bi, bier_imp_pool)
392 send_bier_imp_details(reg, mp->context, bi);
397 vl_api_bier_disp_table_add_del_t_handler (vl_api_bier_disp_table_add_del_t * mp)
399 vl_api_bier_disp_table_add_del_reply_t *rmp;
404 vnm = vnet_get_main ();
406 table_id = ntohl(mp->bdt_tbl_id);
410 bier_disp_table_add_or_lock(table_id);
414 bier_disp_table_unlock_w_table_id(table_id);
419 REPLY_MACRO (VL_API_BIER_DISP_TABLE_ADD_DEL_REPLY);
423 send_bier_disp_table_details (vl_api_registration_t * reg,
425 const bier_disp_table_t *bdt)
427 vl_api_bier_disp_table_details_t *mp;
429 mp = vl_msg_api_alloc(sizeof(*mp));
432 clib_memset(mp, 0, sizeof(*mp));
434 ntohs (REPLY_MSG_ID_BASE + VL_API_BIER_DISP_TABLE_DETAILS);
435 mp->context = context;
437 mp->bdt_tbl_id = htonl(bdt->bdt_table_id);
439 vl_api_send_msg (reg, (u8 *) mp);
443 vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp)
445 vl_api_registration_t *reg;
446 bier_disp_table_t *bdt;
448 reg = vl_api_client_index_to_registration (mp->client_index);
452 pool_foreach (bdt, bier_disp_table_pool)
454 send_bier_disp_table_details(reg, mp->context, bdt);
459 vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp)
461 vl_api_bier_disp_entry_add_del_reply_t *rmp;
462 fib_route_path_t *brps = NULL, *brp;
469 vnm = vnet_get_main ();
471 table_id = ntohl(mp->bde_tbl_id);
472 bp = ntohs(mp->bde_bp);
475 * BP=0 is the default route
483 vec_validate(brps, mp->bde_n_paths - 1);
484 vec_foreach_index(ii, brps)
487 brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id);
488 brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index);
490 if (~0 != ntohl(mp->bde_paths[ii].rpf_id))
492 brp->frp_flags = FIB_ROUTE_PATH_RPF_ID;
493 brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id);
496 if (FIB_API_PATH_NH_PROTO_IP4 == mp->bde_paths[ii].proto)
498 clib_memcpy (&brp->frp_addr.ip4,
499 &mp->bde_paths[ii].nh.address.ip4,
500 sizeof (brp->frp_addr.ip4));
502 else if (FIB_API_PATH_NH_PROTO_IP6 == mp->bde_paths[ii].proto)
504 clib_memcpy (&brp->frp_addr.ip6,
505 &mp->bde_paths[ii].nh.address.ip6,
506 sizeof (brp->frp_addr.ip6));
508 if (ip46_address_is_zero(&brp->frp_addr))
512 switch (mp->bde_payload_proto)
514 case BIER_HDR_PROTO_INVALID:
515 case BIER_HDR_PROTO_MPLS_DOWN_STREAM:
516 case BIER_HDR_PROTO_MPLS_UP_STREAM:
517 case BIER_HDR_PROTO_ETHERNET:
518 case BIER_HDR_PROTO_VXLAN:
519 case BIER_HDR_PROTO_CTRL:
520 case BIER_HDR_PROTO_OAM:
521 rv = VNET_API_ERROR_UNSUPPORTED;
524 case BIER_HDR_PROTO_IPV4:
525 case BIER_HDR_PROTO_IPV6:
527 fib_protocol_t fproto;
529 fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ?
533 if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID)
535 fti = mfib_table_find (fproto,
536 ntohl (mp->bde_paths[ii].table_id));
540 fti = fib_table_find (fproto,
541 ntohl (mp->bde_paths[ii].table_id));
544 if (INDEX_INVALID != fti)
546 brp->frp_fib_index = fti;
550 rv = VNET_API_ERROR_NO_SUCH_FIB;
561 bier_disp_table_entry_path_add(table_id, bp,
562 mp->bde_payload_proto,
567 bier_disp_table_entry_path_remove(table_id, bp,
568 mp->bde_payload_proto,
574 rv = (rv == 0) ? vnm->api_errno : rv;
576 REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY);
579 typedef struct bier_disp_entry_details_walk_t_
581 vl_api_registration_t * reg;
583 } bier_disp_entry_details_walk_t;
586 send_bier_disp_entry_details (const bier_disp_table_t *bdt,
587 const bier_disp_entry_t *bde,
591 bier_disp_entry_details_walk_t *ctx = args;
592 vl_api_bier_disp_entry_details_t *mp;
593 bier_hdr_proto_id_t pproto;
594 vl_api_fib_path_t *fp;
597 FOR_EACH_BIER_HDR_PROTO(pproto)
599 fib_node_index_t pl = bde->bde_pl[pproto];
601 if (INDEX_INVALID != pl)
603 fib_path_encode_ctx_t path_ctx = {
606 fib_route_path_t *rpath;
608 n_paths = fib_path_list_get_n_paths(pl);
609 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
610 mp = vl_msg_api_alloc(m_size);
614 clib_memset(mp, 0, m_size);
616 ntohs (REPLY_MSG_ID_BASE + VL_API_BIER_DISP_ENTRY_DETAILS);
617 mp->context = ctx->context;
619 mp->bde_tbl_id = htonl (bdt->bdt_table_id);
620 mp->bde_n_paths = htonl (n_paths);
621 mp->bde_payload_proto = pproto;
622 mp->bde_bp = htons (bp);
624 fib_path_list_walk_w_ext (pl, NULL, fib_path_encode, &path_ctx);
627 vec_foreach (rpath, path_ctx.rpaths)
629 fib_api_path_encode (rpath, fp);
633 vl_api_send_msg (ctx->reg, (u8 *) mp);
634 vec_free (path_ctx.rpaths);
640 vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp)
642 vl_api_registration_t *reg;
644 reg = vl_api_client_index_to_registration (mp->client_index);
648 bier_disp_entry_details_walk_t ctx = {
650 .context = mp->context,
652 bier_disp_table_walk(ntohl(mp->bde_tbl_id),
653 send_bier_disp_entry_details,
657 #include <bier/bier.api.c>
659 static clib_error_t *
660 bier_api_hookup (vlib_main_t * vm)
662 bier_main.msg_id_base = setup_message_id_table ();
667 VLIB_API_INIT_FUNCTION (bier_api_hookup);