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 bier_table_id_t bti = {
77 .bti_set = mp->bt_tbl_id.bt_set,
78 .bti_sub_domain = mp->bt_tbl_id.bt_sub_domain,
79 .bti_hdr_len = mp->bt_tbl_id.bt_hdr_len_id,
80 .bti_type = BIER_TABLE_MPLS_SPF,
81 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
86 bier_table_add_or_lock(&bti, ntohl(mp->bt_label));
90 bier_table_unlock(&bti);
95 REPLY_MACRO (VL_API_BIER_TABLE_ADD_DEL_REPLY);
99 send_bier_table_details (unix_shared_memory_queue_t * q,
101 const bier_table_t *bt)
103 vl_api_bier_table_details_t *mp;
105 mp = vl_msg_api_alloc(sizeof(*mp));
108 memset(mp, 0, sizeof(*mp));
109 mp->_vl_msg_id = ntohs(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_msg_api_send_shmem (q, (u8 *) & mp);
121 vl_api_bier_table_dump_t_handler (vl_api_bier_table_dump_t * mp)
123 unix_shared_memory_queue_t *q;
126 q = vl_api_client_index_to_input_queue (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(q, 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 ();
155 bp = ntohs(mp->br_bp);
158 if (0 == bp || bp > 0xffff)
164 bier_table_id_t bti = {
165 .bti_set = mp->br_tbl_id.bt_set,
166 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
167 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
168 .bti_type = BIER_TABLE_MPLS_SPF,
169 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
172 vec_validate(brpaths, mp->br_n_paths - 1);
174 vec_foreach_index(ii, brpaths)
176 brpath = &brpaths[ii];
177 memset(brpath, 0, sizeof(*brpath));
178 brpath->frp_flags = FIB_ROUTE_PATH_BIER_FMASK;
180 vec_validate(brpath->frp_label_stack,
181 mp->br_paths[ii].n_labels - 1);
182 for (jj = 0; jj < mp->br_paths[ii].n_labels; jj++)
184 brpath->frp_label_stack[jj] =
185 ntohl(mp->br_paths[ii].label_stack[jj]);
188 if (0 == mp->br_paths[ii].afi)
190 clib_memcpy (&brpath->frp_addr.ip4,
191 mp->br_paths[ii].next_hop,
192 sizeof (brpath->frp_addr.ip4));
196 clib_memcpy (&brpath->frp_addr.ip6,
197 mp->br_paths[ii].next_hop,
198 sizeof (brpath->frp_addr.ip6));
200 if (ip46_address_is_zero(&brpath->frp_addr))
204 bdti = bier_disp_table_find(ntohl(mp->br_paths[ii].table_id));
206 if (INDEX_INVALID != bdti)
207 brpath->frp_fib_index = bdti;
210 rv = VNET_API_ERROR_NO_SUCH_FIB;
218 bier_table_route_add(&bti, ntohs(mp->br_bp), brpaths);
222 bier_table_route_remove(&bti, ntohs(mp->br_bp), brpaths);
227 rv = (rv == 0) ? vnm->api_errno : rv;
229 REPLY_MACRO (VL_API_BIER_ROUTE_ADD_DEL_REPLY);
232 typedef struct bier_route_details_walk_t_
234 unix_shared_memory_queue_t * q;
236 } bier_route_details_walk_t;
239 send_bier_route_details (const bier_table_t *bt,
240 const bier_entry_t *be,
243 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
244 bier_route_details_walk_t *ctx = args;
245 vl_api_bier_route_details_t *mp;
246 vl_api_fib_path3_t *fp;
249 n_paths = fib_path_list_get_n_paths(be->be_path_list);
250 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path3_t));
251 mp = vl_msg_api_alloc(m_size);
255 memset(mp, 0, m_size);
256 mp->_vl_msg_id = ntohs(VL_API_BIER_ROUTE_DETAILS);
257 mp->context = ctx->context;
259 mp->br_tbl_id.bt_set = bt->bt_id.bti_set;
260 mp->br_tbl_id.bt_sub_domain = bt->bt_id.bti_sub_domain;
261 mp->br_tbl_id.bt_hdr_len_id = bt->bt_id.bti_hdr_len;
262 mp->br_bp = htons(be->be_bp);
263 mp->br_n_paths = htonl(n_paths);
265 fib_path_list_walk(be->be_path_list, fib_path_encode, &api_rpaths);
268 vec_foreach (api_rpath, api_rpaths)
270 fp->weight = api_rpath->rpath.frp_weight;
271 fp->preference = api_rpath->rpath.frp_preference;
272 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
274 copy_fib_next_hop (api_rpath, fp);
278 vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
282 vl_api_bier_route_dump_t_handler (vl_api_bier_route_dump_t * mp)
284 unix_shared_memory_queue_t *q;
286 q = vl_api_client_index_to_input_queue (mp->client_index);
290 bier_table_id_t bti = {
291 .bti_set = mp->br_tbl_id.bt_set,
292 .bti_sub_domain = mp->br_tbl_id.bt_sub_domain,
293 .bti_hdr_len = mp->br_tbl_id.bt_hdr_len_id,
294 .bti_type = BIER_TABLE_MPLS_SPF,
295 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
297 bier_route_details_walk_t ctx = {
299 .context = mp->context,
301 bier_table_walk(&bti, send_bier_route_details, &ctx);
305 vl_api_bier_imp_add_t_handler (vl_api_bier_imp_add_t * mp)
307 vl_api_bier_imp_add_reply_t *rmp;
312 vnm = vnet_get_main ();
315 bier_table_id_t bti = {
316 .bti_set = mp->bi_tbl_id.bt_set,
317 .bti_sub_domain = mp->bi_tbl_id.bt_sub_domain,
318 .bti_hdr_len = mp->bi_tbl_id.bt_hdr_len_id,
319 .bti_type = BIER_TABLE_MPLS_SPF,
320 .bti_ecmp = BIER_ECMP_TABLE_ID_MAIN,
322 bier_bit_string_t bs = {
323 .bbs_len = mp->bi_n_bytes,
324 .bbs_buckets = mp->bi_bytes,
327 bii = bier_imp_add_or_lock(&bti, ntohs(mp->bi_src), &bs);
330 REPLY_MACRO2 (VL_API_BIER_IMP_ADD_REPLY,
338 vl_api_bier_imp_del_t_handler (vl_api_bier_imp_del_t * mp)
340 vl_api_bier_imp_del_reply_t *rmp;
344 vnm = vnet_get_main ();
347 bier_imp_unlock(ntohl(mp->bi_index));
349 REPLY_MACRO(VL_API_BIER_IMP_DEL_REPLY);
353 send_bier_imp_details (unix_shared_memory_queue_t * q,
355 const bier_imp_t *bi)
357 vl_api_bier_imp_details_t *mp;
362 bier_hdr_ntoh(©);
364 n_bytes = bier_hdr_len_id_to_num_bytes(
365 bier_hdr_get_len_id(©));
366 mp = vl_msg_api_alloc(sizeof(*mp) + n_bytes);
369 memset(mp, 0, sizeof(*mp)+n_bytes);
370 mp->_vl_msg_id = ntohs(VL_API_BIER_IMP_DETAILS);
371 mp->context = context;
373 mp->bi_tbl_id.bt_set = bi->bi_tbl.bti_set;
374 mp->bi_tbl_id.bt_sub_domain = bi->bi_tbl.bti_sub_domain;
375 mp->bi_tbl_id.bt_hdr_len_id = bi->bi_tbl.bti_hdr_len;
378 mp->bi_src = htons(bier_hdr_get_src_id(©));
379 mp->bi_n_bytes = n_bytes;
380 memcpy(mp->bi_bytes, bi->bi_bits.bits, n_bytes);
382 vl_msg_api_send_shmem (q, (u8 *) & mp);
386 vl_api_bier_imp_dump_t_handler (vl_api_bier_imp_dump_t * mp)
388 unix_shared_memory_queue_t *q;
391 q = vl_api_client_index_to_input_queue (mp->client_index);
395 pool_foreach(bi, bier_imp_pool,
397 send_bier_imp_details(q, mp->context, bi);
402 vl_api_bier_disp_table_add_del_t_handler (vl_api_bier_disp_table_add_del_t * mp)
404 vl_api_bier_disp_table_add_del_reply_t *rmp;
409 vnm = vnet_get_main ();
411 table_id = ntohl(mp->bdt_tbl_id);
415 bier_disp_table_add_or_lock(table_id);
419 bier_disp_table_unlock_w_table_id(table_id);
424 REPLY_MACRO (VL_API_BIER_DISP_TABLE_ADD_DEL_REPLY);
428 send_bier_disp_table_details (unix_shared_memory_queue_t * q,
430 const bier_disp_table_t *bdt)
432 vl_api_bier_disp_table_details_t *mp;
434 mp = vl_msg_api_alloc(sizeof(*mp));
437 memset(mp, 0, sizeof(*mp));
438 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_TABLE_DETAILS);
439 mp->context = context;
441 mp->bdt_tbl_id = htonl(bdt->bdt_table_id);
443 vl_msg_api_send_shmem (q, (u8 *) & mp);
447 vl_api_bier_disp_table_dump_t_handler (vl_api_bier_disp_table_dump_t * mp)
449 unix_shared_memory_queue_t *q;
450 bier_disp_table_t *bdt;
452 q = vl_api_client_index_to_input_queue (mp->client_index);
456 pool_foreach(bdt, bier_disp_table_pool,
458 send_bier_disp_table_details(q, mp->context, bdt);
463 vl_api_bier_disp_entry_add_del_t_handler (vl_api_bier_disp_entry_add_del_t * mp)
465 vl_api_bier_disp_entry_add_del_reply_t *rmp;
466 fib_route_path_t *brps = NULL, *brp;
473 vnm = vnet_get_main ();
475 table_id = ntohl(mp->bde_tbl_id);
476 bp = ntohs(mp->bde_bp);
478 if (0 == bp || bp > 0xffff)
484 vec_validate(brps, mp->bde_n_paths - 1);
485 vec_foreach_index(ii, brps)
488 brp->frp_fib_index = ntohl(mp->bde_paths[ii].table_id);
489 brp->frp_sw_if_index = ntohl(mp->bde_paths[ii].sw_if_index);
491 if (~0 != ntohl(mp->bde_paths[ii].rpf_id))
493 brp->frp_flags = FIB_ROUTE_PATH_RPF_ID;
494 brp->frp_rpf_id = ntohl(mp->bde_paths[ii].rpf_id);
497 if (0 == mp->bde_paths[ii].afi)
499 clib_memcpy (&brp->frp_addr.ip4,
500 mp->bde_paths[ii].next_hop,
501 sizeof (brp->frp_addr.ip4));
505 clib_memcpy (&brp->frp_addr.ip6,
506 mp->bde_paths[ii].next_hop,
507 sizeof (brp->frp_addr.ip6));
509 if (ip46_address_is_zero(&brp->frp_addr))
513 switch (mp->bde_payload_proto)
515 case BIER_HDR_PROTO_INVALID:
516 case BIER_HDR_PROTO_MPLS_DOWN_STREAM:
517 case BIER_HDR_PROTO_MPLS_UP_STREAM:
518 case BIER_HDR_PROTO_ETHERNET:
519 case BIER_HDR_PROTO_VXLAN:
520 case BIER_HDR_PROTO_CTRL:
521 case BIER_HDR_PROTO_OAM:
522 rv = VNET_API_ERROR_UNSUPPORTED;
525 case BIER_HDR_PROTO_IPV4:
526 case BIER_HDR_PROTO_IPV6:
528 fib_protocol_t fproto;
530 fproto = (mp->bde_payload_proto == BIER_HDR_PROTO_IPV4 ?
534 if (brp->frp_flags & FIB_ROUTE_PATH_RPF_ID)
536 fti = mfib_table_find (fproto,
537 ntohl (mp->bde_paths[ii].table_id));
541 fti = fib_table_find (fproto,
542 ntohl (mp->bde_paths[ii].table_id));
545 if (INDEX_INVALID != fti)
547 brp->frp_fib_index = fti;
551 rv = VNET_API_ERROR_NO_SUCH_FIB;
562 bier_disp_table_entry_path_add(table_id, bp,
563 mp->bde_payload_proto,
568 bier_disp_table_entry_path_remove(table_id, bp,
569 mp->bde_payload_proto,
575 rv = (rv == 0) ? vnm->api_errno : rv;
577 REPLY_MACRO (VL_API_BIER_DISP_ENTRY_ADD_DEL_REPLY);
580 typedef struct bier_disp_entry_details_walk_t_
582 unix_shared_memory_queue_t * q;
584 } bier_disp_entry_details_walk_t;
587 send_bier_disp_entry_details (const bier_disp_table_t *bdt,
588 const bier_disp_entry_t *bde,
592 fib_route_path_encode_t *api_rpaths = NULL, *api_rpath;
593 bier_disp_entry_details_walk_t *ctx = args;
594 vl_api_bier_disp_entry_details_t *mp;
595 bier_hdr_proto_id_t pproto;
596 vl_api_fib_path3_t *fp;
599 FOR_EACH_BIER_HDR_PROTO(pproto)
601 fib_node_index_t pl = bde->bde_pl[pproto];
602 if (INDEX_INVALID != pl)
604 n_paths = fib_path_list_get_n_paths(pl);
605 m_size = sizeof(*mp) + (n_paths * sizeof(vl_api_fib_path3_t));
606 mp = vl_msg_api_alloc(m_size);
610 memset(mp, 0, m_size);
611 mp->_vl_msg_id = ntohs(VL_API_BIER_DISP_ENTRY_DETAILS);
612 mp->context = ctx->context;
614 mp->bde_tbl_id = htonl(bdt->bdt_table_id);
615 mp->bde_n_paths = htonl(n_paths);
616 mp->bde_payload_proto = pproto;
617 mp->bde_bp = htons(bp);
619 fib_path_list_walk(pl, fib_path_encode, &api_rpaths);
622 vec_foreach (api_rpath, api_rpaths)
624 fp->weight = api_rpath->rpath.frp_weight;
625 fp->preference = api_rpath->rpath.frp_preference;
626 fp->sw_if_index = htonl (api_rpath->rpath.frp_sw_if_index);
628 copy_fib_next_hop (api_rpath, fp);
632 vl_msg_api_send_shmem (ctx->q, (u8 *) & mp);
638 vl_api_bier_disp_entry_dump_t_handler (vl_api_bier_disp_entry_dump_t * mp)
640 unix_shared_memory_queue_t *q;
642 q = vl_api_client_index_to_input_queue (mp->client_index);
646 bier_disp_entry_details_walk_t ctx = {
648 .context = mp->context,
650 bier_disp_table_walk(ntohl(mp->bde_tbl_id),
651 send_bier_disp_entry_details,
655 #define vl_msg_name_crc_list
656 #include <vnet/bier/bier.api.h>
657 #undef vl_msg_name_crc_list
660 setup_message_id_table (api_main_t * am)
662 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
663 foreach_vl_msg_name_crc_bier;
667 static clib_error_t *
668 bier_api_hookup (vlib_main_t * vm)
670 api_main_t *am = &api_main;
673 vl_msg_api_set_handlers(VL_API_##N, #n, \
674 vl_api_##n##_t_handler, \
676 vl_api_##n##_t_endian, \
677 vl_api_##n##_t_print, \
678 sizeof(vl_api_##n##_t), 1);
679 foreach_bier_api_msg;
683 * Set up the (msg_name, crc, message-id) table
685 setup_message_id_table (am);
690 VLIB_API_INIT_FUNCTION (bier_api_hookup);