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);
209 bier_table_route_add(&bti, bp, brpaths);
213 bier_table_route_remove(&bti, bp, brpaths);
218 rv = (rv == 0) ? vnm->api_errno : rv;
220 REPLY_MACRO (VL_API_BIER_ROUTE_ADD_DEL_REPLY);
223 typedef struct bier_route_details_walk_t_
225 vl_api_registration_t * reg;
227 } bier_route_details_walk_t;
230 send_bier_route_details (const bier_table_t *bt,
231 const bier_entry_t *be,
234 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
235 bier_route_details_walk_t *ctx = args;
236 vl_api_bier_route_details_t *mp;
237 vl_api_fib_path_t *fp;
240 n_paths = fib_path_list_get_n_paths(be->be_path_list);
241 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
242 mp = vl_msg_api_alloc(m_size);
246 memset(mp, 0, m_size);
247 mp->_vl_msg_id = ntohs(VL_API_BIER_ROUTE_DETAILS);
248 mp->context = ctx->context;
250 mp->br_tbl_id.bt_set = bt->bt_id.bti_set;
251 mp->br_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
252 mp->br_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
253 mp->br_bp = htons(be->be_bp);
254 mp->br_n_paths = htonl(n_paths);
256 fib_path_list_walk(be->be_path_list, fib_path_encode, &api_rpaths);
259 vec_foreach (api_rpath, api_rpaths)
261 fib_api_path_encode(api_rpath, fp);
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 memset(mp, 0, sizeof(*mp)+n_bytes);
366 mp->_vl_msg_id = ntohs(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 memset(mp, 0, sizeof(*mp));
433 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_TABLE_DETAILS);
434 mp->context = context;
436 mp->bdt_tbl_id = htonl(bdt->bdt_table_id);
438 vl_api_send_msg (reg, (u8 *) mp);
442 vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp)
444 vl_api_registration_t *reg;
445 bier_disp_table_t *bdt;
447 reg = vl_api_client_index_to_registration (mp->client_index);
451 pool_foreach(bdt, bier_disp_table_pool,
453 send_bier_disp_table_details(reg, mp->context, bdt);
458 vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp)
460 vl_api_bier_disp_entry_add_del_reply_t *rmp;
461 fib_route_path_t *brps = NULL, *brp;
468 vnm = vnet_get_main ();
470 table_id = ntohl(mp->bde_tbl_id);
471 bp = ntohs(mp->bde_bp);
474 * BP=0 is the default route
482 vec_validate(brps, mp->bde_n_paths - 1);
483 vec_foreach_index(ii, brps)
486 brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id);
487 brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index);
489 if (~0 != ntohl(mp->bde_paths[ii].rpf_id))
491 brp->frp_flags = FIB_ROUTE_PATH_RPF_ID;
492 brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id);
495 if (0 == mp->bde_paths[ii].afi)
497 clib_memcpy (&brp->frp_addr.ip4,
498 mp->bde_paths[ii].next_hop,
499 sizeof (brp->frp_addr.ip4));
503 clib_memcpy (&brp->frp_addr.ip6,
504 mp->bde_paths[ii].next_hop,
505 sizeof (brp->frp_addr.ip6));
507 if (ip46_address_is_zero(&brp->frp_addr))
511 switch (mp->bde_payload_proto)
513 case BIER_HDR_PROTO_INVALID:
514 case BIER_HDR_PROTO_MPLS_DOWN_STREAM:
515 case BIER_HDR_PROTO_MPLS_UP_STREAM:
516 case BIER_HDR_PROTO_ETHERNET:
517 case BIER_HDR_PROTO_VXLAN:
518 case BIER_HDR_PROTO_CTRL:
519 case BIER_HDR_PROTO_OAM:
520 rv = VNET_API_ERROR_UNSUPPORTED;
523 case BIER_HDR_PROTO_IPV4:
524 case BIER_HDR_PROTO_IPV6:
526 fib_protocol_t fproto;
528 fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ?
532 if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID)
534 fti = mfib_table_find (fproto,
535 ntohl (mp->bde_paths[ii].table_id));
539 fti = fib_table_find (fproto,
540 ntohl (mp->bde_paths[ii].table_id));
543 if (INDEX_INVALID != fti)
545 brp->frp_fib_index = fti;
549 rv = VNET_API_ERROR_NO_SUCH_FIB;
560 bier_disp_table_entry_path_add(table_id, bp,
561 mp->bde_payload_proto,
566 bier_disp_table_entry_path_remove(table_id, bp,
567 mp->bde_payload_proto,
573 rv = (rv == 0) ? vnm->api_errno : rv;
575 REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY);
578 typedef struct bier_disp_entry_details_walk_t_
580 vl_api_registration_t * reg;
582 } bier_disp_entry_details_walk_t;
585 send_bier_disp_entry_details (const bier_disp_table_t *bdt,
586 const bier_disp_entry_t *bde,
590 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
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];
600 if (INDEX_INVALID != pl)
602 n_paths = fib_path_list_get_n_paths(pl);
603 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path_t));
604 mp = vl_msg_api_alloc(m_size);
608 memset(mp, 0, m_size);
609 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_ENTRY_DETAILS);
610 mp->context = ctx->context;
612 mp->bde_tbl_id = htonl(bdt->bdt_table_id);
613 mp->bde_n_paths = htonl(n_paths);
614 mp->bde_payload_proto = pproto;
615 mp->bde_bp = htons(bp);
617 fib_path_list_walk(pl, fib_path_encode, &api_rpaths);
620 vec_foreach (api_rpath, api_rpaths)
622 fib_api_path_encode(api_rpath, fp);
626 vl_api_send_msg (ctx->reg, (u8 *) mp);
632 vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp)
634 vl_api_registration_t *reg;
636 reg = vl_api_client_index_to_registration (mp->client_index);
640 bier_disp_entry_details_walk_t ctx = {
642 .context = mp->context,
644 bier_disp_table_walk(ntohl(mp->bde_tbl_id),
645 send_bier_disp_entry_details,
649 #define vl_msg_name_crc_list
650 #include <vnet/bier/bier.api.h>
651 #undef vl_msg_name_crc_list
654 setup_message_id_table (api_main_t * am)
656 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
657 foreach_vl_msg_name_crc_bier;
661 static clib_error_t *
662 bier_api_hookup (vlib_main_t * vm)
664 api_main_t *am = &api_main;
667 vl_msg_api_set_handlers(VL_API_##N, #n, \
668 vl_api_##n##_t_handler, \
670 vl_api_##n##_t_endian, \
671 vl_api_##n##_t_print, \
672 sizeof(vl_api_##n##_t), 1);
673 foreach_bier_api_msg;
677 * Set up the (msg_name, crc, message-id) table
679 setup_message_id_table (am);
684 VLIB_API_INIT_FUNCTION (bier_api_hookup);