2 * Copyright (c) 2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #include <vlib/vlib.h>
18 #include <vnet/mfib/mfib_entry.h>
19 #include <vnet/fib/fib_path_list.h>
21 #include <vnet/dpo/drop_dpo.h>
22 #include <vnet/dpo/replicate_dpo.h>
28 #DEFIne MFIB_ENTRY_DBG(_e, _fmt, _args...) \
31 __tmp = format(__tmp, "e:[%d:%U", \
32 mfib_entry_get_index(_e), \
33 format_ip46_address, \
34 &_e->mfe_prefix.fp_grp_addr, \
36 __tmp = format(__tmp, "/%d,", \
37 _e->mfe_prefix.fp_len); \
38 __tmp = format(__tmp, "%U]", \
39 mfib_entry_get_index(_e), \
40 format_ip46_address, \
41 &_e->mfe_prefix.fp_src_addr, \
43 __tmp = format(__tmp, _fmt, ##_args); \
44 clib_warning("%s", __tmp); \
48 #define MFIB_ENTRY_DBG(_e, _fmt, _args...)
52 * MFIB extensions to each path
54 typedef struct mfib_path_ext_t_
56 mfib_itf_flags_t mfpe_flags;
57 fib_node_index_t mfpe_path;
61 * The source of an MFIB entry
63 typedef struct mfib_entry_src_t_
66 * Which source this is
68 mfib_source_t mfes_src;
73 mfib_entry_flags_t mfes_flags;
76 * The path-list of forwarding interfaces
78 fib_node_index_t mfes_pl;
83 fib_rpf_id_t mfes_rpf_id;
86 * Hash table of path extensions
88 mfib_path_ext_t *mfes_exts;
91 * The hash table of all interfaces.
92 * This is forwarding time information derived from the paths
93 * and their extensions.
95 mfib_itf_t *mfes_itfs;
99 * Pool of path extensions
101 static mfib_path_ext_t *mfib_path_ext_pool;
104 * String names for each source
106 static const char *mfib_source_names[] = MFIB_SOURCE_NAMES;
109 * Pool for all fib_entries
111 mfib_entry_t *mfib_entry_pool;
114 mfib_entry_get_node (fib_node_index_t index)
116 return ((fib_node_t*)mfib_entry_get(index));
119 static fib_protocol_t
120 mfib_entry_get_proto (const mfib_entry_t * mfib_entry)
122 return (mfib_entry->mfe_prefix.fp_proto);
125 fib_forward_chain_type_t
126 mfib_entry_get_default_chain_type (const mfib_entry_t *mfib_entry)
128 switch (mfib_entry->mfe_prefix.fp_proto)
130 case FIB_PROTOCOL_IP4:
131 return (FIB_FORW_CHAIN_TYPE_MCAST_IP4);
132 case FIB_PROTOCOL_IP6:
133 return (FIB_FORW_CHAIN_TYPE_MCAST_IP6);
134 case FIB_PROTOCOL_MPLS:
138 return (FIB_FORW_CHAIN_TYPE_MCAST_IP4);
142 format_mfib_entry_dpo (u8 * s, va_list * args)
144 index_t fei = va_arg(*args, index_t);
145 CLIB_UNUSED(u32 indent) = va_arg(*args, u32);
147 return (format(s, "%U",
148 format_mfib_entry, fei,
149 MFIB_ENTRY_FORMAT_BRIEF));
152 static inline mfib_path_ext_t *
153 mfib_entry_path_ext_get (index_t mi)
155 return (pool_elt_at_index(mfib_path_ext_pool, mi));
159 format_mfib_entry_path_ext (u8 * s, va_list * args)
161 mfib_path_ext_t *path_ext;
162 index_t mpi = va_arg(*args, index_t);
164 path_ext = mfib_entry_path_ext_get(mpi);
165 return (format(s, "path:%d flags:%U",
167 format_mfib_itf_flags, path_ext->mfpe_flags));
171 format_mfib_entry (u8 * s, va_list * args)
173 fib_node_index_t fei, mfi;
174 mfib_entry_t *mfib_entry;
175 mfib_entry_src_t *msrc;
179 fei = va_arg (*args, fib_node_index_t);
180 level = va_arg (*args, int);
181 mfib_entry = mfib_entry_get(fei);
183 s = format (s, "%U", format_mfib_prefix, &mfib_entry->mfe_prefix);
184 s = format (s, ": %U", format_mfib_entry_flags, mfib_entry->mfe_flags);
186 if (level >= MFIB_ENTRY_FORMAT_DETAIL)
188 fib_node_index_t path_index, mpi;
190 s = format (s, "\n");
191 s = format (s, " fib:%d", mfib_entry->mfe_fib_index);
192 s = format (s, " index:%d", mfib_entry_get_index(mfib_entry));
193 s = format (s, " locks:%d\n", mfib_entry->mfe_node.fn_locks);
194 vec_foreach(msrc, mfib_entry->mfe_srcs)
196 s = format (s, " src:%s", mfib_source_names[msrc->mfes_src]);
197 s = format (s, ": %U\n", format_mfib_entry_flags, msrc->mfes_flags);
198 if (FIB_NODE_INDEX_INVALID != msrc->mfes_pl)
200 s = fib_path_list_format(msrc->mfes_pl, s);
202 s = format (s, " Extensions:\n");
203 hash_foreach(path_index, mpi, msrc->mfes_exts,
205 s = format(s, " %U\n", format_mfib_entry_path_ext, mpi);
207 s = format (s, " Interface-Forwarding:\n");
208 hash_foreach(sw_if_index, mfi, msrc->mfes_itfs,
210 s = format(s, " %U\n", format_mfib_itf, mfi);
215 s = format(s, "\n Interfaces:");
216 hash_foreach(sw_if_index, mfi, mfib_entry->mfe_itfs,
218 s = format(s, "\n %U", format_mfib_itf, mfi);
220 s = format(s, "\n RPF-ID:%d", mfib_entry->mfe_rpf_id);
221 s = format(s, "\n %U-chain\n %U",
222 format_fib_forw_chain_type,
223 mfib_entry_get_default_chain_type(mfib_entry),
225 &mfib_entry->mfe_rep,
229 if (level >= MFIB_ENTRY_FORMAT_DETAIL2)
231 s = format(s, "\nchildren:");
232 s = fib_node_children_format(mfib_entry->mfe_node.fn_children, s);
239 mfib_entry_from_fib_node (fib_node_t *node)
242 ASSERT(FIB_NODE_TYPE_MFIB_ENTRY == node->fn_type);
244 return ((mfib_entry_t*)node);
248 mfib_entry_src_cmp_for_sort (void * v1,
251 mfib_entry_src_t *esrc1 = v1, *esrc2 = v2;
253 return (esrc1->mfes_src - esrc2->mfes_src);
257 mfib_entry_src_init (mfib_entry_t *mfib_entry,
258 mfib_source_t source)
261 mfib_entry_src_t esrc = {
262 .mfes_pl = FIB_NODE_INDEX_INVALID,
263 .mfes_flags = MFIB_ENTRY_FLAG_NONE,
267 vec_add1(mfib_entry->mfe_srcs, esrc);
268 vec_sort_with_function(mfib_entry->mfe_srcs,
269 mfib_entry_src_cmp_for_sort);
272 static mfib_entry_src_t *
273 mfib_entry_src_find (const mfib_entry_t *mfib_entry,
274 mfib_source_t source,
278 mfib_entry_src_t *esrc;
282 vec_foreach(esrc, mfib_entry->mfe_srcs)
284 if (esrc->mfes_src == source)
301 static mfib_entry_src_t *
302 mfib_entry_src_find_or_create (mfib_entry_t *mfib_entry,
303 mfib_source_t source)
305 mfib_entry_src_t *esrc;
307 esrc = mfib_entry_src_find(mfib_entry, source, NULL);
311 mfib_entry_src_init(mfib_entry, source);
314 return (mfib_entry_src_find(mfib_entry, source, NULL));
317 static mfib_entry_src_t*
318 mfib_entry_get_best_src (const mfib_entry_t *mfib_entry)
320 mfib_entry_src_t *bsrc;
323 * the enum of sources is deliberately arranged in priority order
325 if (0 == vec_len(mfib_entry->mfe_srcs))
331 bsrc = vec_elt_at_index(mfib_entry->mfe_srcs, 0);
338 mfib_entry_is_sourced (fib_node_index_t mfib_entry_index,
339 mfib_source_t source)
341 mfib_entry_t *mfib_entry;
343 mfib_entry = mfib_entry_get(mfib_entry_index);
345 return (NULL != mfib_entry_src_find(mfib_entry, source, NULL));
349 mfib_entry_src_flush (mfib_entry_src_t *msrc)
354 hash_foreach(sw_if_index, mfii, msrc->mfes_itfs,
356 mfib_itf_delete(mfib_itf_get(mfii));
358 hash_free(msrc->mfes_itfs);
359 msrc->mfes_itfs = NULL;
360 fib_path_list_unlock(msrc->mfes_pl);
364 mfib_entry_src_remove (mfib_entry_t *mfib_entry,
365 mfib_source_t source)
368 mfib_entry_src_t *msrc;
371 msrc = mfib_entry_src_find(mfib_entry, source, &index);
375 mfib_entry_src_flush(msrc);
376 vec_del1(mfib_entry->mfe_srcs, index);
381 mfib_entry_child_add (fib_node_index_t mfib_entry_index,
382 fib_node_type_t child_type,
383 fib_node_index_t child_index)
385 return (fib_node_child_add(FIB_NODE_TYPE_MFIB_ENTRY,
392 mfib_entry_child_remove (fib_node_index_t mfib_entry_index,
395 fib_node_child_remove(FIB_NODE_TYPE_MFIB_ENTRY,
400 static mfib_entry_t *
401 mfib_entry_alloc (u32 fib_index,
402 const mfib_prefix_t *prefix,
403 fib_node_index_t *mfib_entry_index)
405 mfib_entry_t *mfib_entry;
407 pool_get_aligned(mfib_entry_pool, mfib_entry, CLIB_CACHE_LINE_BYTES);
409 fib_node_init(&mfib_entry->mfe_node,
410 FIB_NODE_TYPE_MFIB_ENTRY);
413 * Some of the members require non-default initialisation
414 * so we also init those that don't and thus save on the call to memset.
416 mfib_entry->mfe_flags = 0;
417 mfib_entry->mfe_fib_index = fib_index;
418 mfib_entry->mfe_prefix = *prefix;
419 mfib_entry->mfe_srcs = NULL;
420 mfib_entry->mfe_itfs = NULL;
421 mfib_entry->mfe_rpf_id = MFIB_RPF_ID_NONE;
422 mfib_entry->mfe_pl = FIB_NODE_INDEX_INVALID;
424 dpo_reset(&mfib_entry->mfe_rep);
426 *mfib_entry_index = mfib_entry_get_index(mfib_entry);
428 MFIB_ENTRY_DBG(mfib_entry, "alloc");
433 static inline mfib_path_ext_t *
434 mfib_entry_path_ext_find (mfib_path_ext_t *exts,
435 fib_node_index_t path_index)
439 p = hash_get(exts, path_index);
443 return (mfib_entry_path_ext_get(p[0]));
449 static mfib_path_ext_t*
450 mfib_path_ext_add (mfib_entry_src_t *msrc,
451 fib_node_index_t path_index,
452 mfib_itf_flags_t mfi_flags)
454 mfib_path_ext_t *path_ext;
456 pool_get(mfib_path_ext_pool, path_ext);
458 path_ext->mfpe_flags = mfi_flags;
459 path_ext->mfpe_path = path_index;
461 hash_set(msrc->mfes_exts, path_index,
462 path_ext - mfib_path_ext_pool);
468 mfib_path_ext_remove (mfib_entry_src_t *msrc,
469 fib_node_index_t path_index)
471 mfib_path_ext_t *path_ext;
473 path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
475 hash_unset(msrc->mfes_exts, path_index);
476 pool_put(mfib_path_ext_pool, path_ext);
479 typedef struct mfib_entry_collect_forwarding_ctx_t_
481 load_balance_path_t * next_hops;
482 fib_forward_chain_type_t fct;
483 mfib_entry_src_t *msrc;
484 } mfib_entry_collect_forwarding_ctx_t;
486 static fib_path_list_walk_rc_t
487 mfib_entry_src_collect_forwarding (fib_node_index_t pl_index,
488 fib_node_index_t path_index,
491 mfib_entry_collect_forwarding_ctx_t *ctx;
492 load_balance_path_t *nh;
497 * if the path is not resolved, don't include it.
499 if (!fib_path_is_resolved(path_index))
501 return (FIB_PATH_LIST_WALK_CONTINUE);
505 * If the path is not forwarding to use it
507 mfib_path_ext_t *path_ext;
509 path_ext = mfib_entry_path_ext_find(ctx->msrc->mfes_exts,
512 if (NULL != path_ext &&
513 !(path_ext->mfpe_flags & MFIB_ITF_FLAG_FORWARD))
515 return (FIB_PATH_LIST_WALK_CONTINUE);
520 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
521 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
523 * EOS traffic with no label to stack, we need the IP Adj
525 vec_add2(ctx->next_hops, nh, 1);
527 nh->path_index = path_index;
528 nh->path_weight = fib_path_get_weight(path_index);
529 fib_path_contribute_forwarding(path_index, ctx->fct, &nh->path_dpo);
532 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
533 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
534 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
535 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
536 case FIB_FORW_CHAIN_TYPE_ETHERNET:
537 case FIB_FORW_CHAIN_TYPE_NSH:
538 case FIB_FORW_CHAIN_TYPE_BIER:
543 return (FIB_PATH_LIST_WALK_CONTINUE);
547 mfib_entry_stack (mfib_entry_t *mfib_entry,
548 mfib_entry_src_t *msrc)
552 dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
555 * unlink the enty from the previous path list.
557 if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
559 fib_path_list_child_remove(mfib_entry->mfe_pl,
560 mfib_entry->mfe_sibling);
564 FIB_NODE_INDEX_INVALID != msrc->mfes_pl)
566 mfib_entry_collect_forwarding_ctx_t ctx = {
568 .fct = mfib_entry_get_default_chain_type(mfib_entry),
572 fib_path_list_walk(msrc->mfes_pl,
573 mfib_entry_src_collect_forwarding,
576 if (!(MFIB_ENTRY_FLAG_EXCLUSIVE & mfib_entry->mfe_flags))
578 if (NULL == ctx.next_hops)
581 * no next-hops, stack directly on the drop
583 dpo_stack(DPO_MFIB_ENTRY, dp,
584 &mfib_entry->mfe_rep,
590 * each path contirbutes a next-hop. form a replicate
591 * from those choices.
593 if (!dpo_id_is_valid(&mfib_entry->mfe_rep) ||
594 dpo_is_drop(&mfib_entry->mfe_rep))
596 dpo_id_t tmp_dpo = DPO_INVALID;
600 replicate_create(0, dp));
602 dpo_stack(DPO_MFIB_ENTRY, dp,
603 &mfib_entry->mfe_rep,
608 replicate_multipath_update(&mfib_entry->mfe_rep,
615 * for exclusive routes the source provided a replicate DPO
616 * we we stashed inthe special path list with one path
617 * so we can stack directly on that.
619 ASSERT(1 == vec_len(ctx.next_hops));
621 dpo_stack(DPO_MFIB_ENTRY, dp,
622 &mfib_entry->mfe_rep,
623 &ctx.next_hops[0].path_dpo);
624 dpo_reset(&ctx.next_hops[0].path_dpo);
625 vec_free(ctx.next_hops);
629 * link the entry to the path-list.
630 * The entry needs to be a child so that we receive the back-walk
631 * updates to recalculate forwarding.
633 mfib_entry->mfe_pl = msrc->mfes_pl;
634 mfib_entry->mfe_sibling =
635 fib_path_list_child_add(mfib_entry->mfe_pl,
636 FIB_NODE_TYPE_MFIB_ENTRY,
637 mfib_entry_get_index(mfib_entry));
641 dpo_stack(DPO_MFIB_ENTRY, dp,
642 &mfib_entry->mfe_rep,
647 static fib_node_index_t
648 mfib_entry_src_path_add (mfib_entry_src_t *msrc,
649 const fib_route_path_t *rpath)
651 fib_node_index_t path_index;
652 fib_route_path_t *rpaths;
654 ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
657 * path-lists require a vector of paths
660 vec_add1(rpaths, rpath[0]);
662 if (FIB_NODE_INDEX_INVALID == msrc->mfes_pl)
664 /* A non-shared path-list */
665 msrc->mfes_pl = fib_path_list_create(FIB_PATH_LIST_FLAG_NO_URPF,
667 fib_path_list_lock(msrc->mfes_pl);
670 path_index = fib_path_list_path_add(msrc->mfes_pl, rpaths);
677 static fib_node_index_t
678 mfib_entry_src_path_remove (mfib_entry_src_t *msrc,
679 const fib_route_path_t *rpath)
681 fib_node_index_t path_index;
682 fib_route_path_t *rpaths;
684 ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
687 * path-lists require a vector of paths
690 vec_add1(rpaths, rpath[0]);
692 path_index = fib_path_list_path_remove(msrc->mfes_pl, rpaths);
700 mfib_entry_recalculate_forwarding (mfib_entry_t *mfib_entry)
702 mfib_entry_src_t *bsrc;
705 * copy the forwarding data from the bast source
707 bsrc = mfib_entry_get_best_src(mfib_entry);
711 mfib_entry->mfe_flags = bsrc->mfes_flags;
712 mfib_entry->mfe_itfs = bsrc->mfes_itfs;
713 mfib_entry->mfe_rpf_id = bsrc->mfes_rpf_id;
716 mfib_entry_stack(mfib_entry, bsrc);
721 mfib_entry_create (u32 fib_index,
722 mfib_source_t source,
723 const mfib_prefix_t *prefix,
725 mfib_entry_flags_t entry_flags)
727 fib_node_index_t mfib_entry_index;
728 mfib_entry_t *mfib_entry;
729 mfib_entry_src_t *msrc;
731 mfib_entry = mfib_entry_alloc(fib_index, prefix,
733 msrc = mfib_entry_src_find_or_create(mfib_entry, source);
734 msrc->mfes_flags = entry_flags;
735 msrc->mfes_rpf_id = rpf_id;
737 mfib_entry_recalculate_forwarding(mfib_entry);
739 return (mfib_entry_index);
743 mfib_entry_ok_for_delete (mfib_entry_t *mfib_entry)
745 return (0 == vec_len(mfib_entry->mfe_srcs));
749 mfib_entry_src_ok_for_delete (const mfib_entry_src_t *msrc)
751 return ((MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags &&
752 0 == fib_path_list_get_n_paths(msrc->mfes_pl)));
756 mfib_entry_update (fib_node_index_t mfib_entry_index,
757 mfib_source_t source,
758 mfib_entry_flags_t entry_flags,
762 mfib_entry_t *mfib_entry;
763 mfib_entry_src_t *msrc;
765 mfib_entry = mfib_entry_get(mfib_entry_index);
766 msrc = mfib_entry_src_find_or_create(mfib_entry, source);
767 msrc->mfes_flags = entry_flags;
768 msrc->mfes_rpf_id = rpf_id;
770 if (INDEX_INVALID != repi)
773 * The source is providing its own replicate DPO.
774 * Create a sepcial path-list to manage it, that way
775 * this entry and the source are equivalent to a normal
778 fib_node_index_t old_pl_index;
780 dpo_id_t dpo = DPO_INVALID;
782 dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
783 old_pl_index = msrc->mfes_pl;
785 dpo_set(&dpo, DPO_REPLICATE, dp, repi);
788 fib_path_list_create_special(dp,
789 FIB_PATH_LIST_FLAG_EXCLUSIVE,
793 fib_path_list_lock(msrc->mfes_pl);
794 fib_path_list_unlock(old_pl_index);
797 if (mfib_entry_src_ok_for_delete(msrc))
800 * this source has no interfaces and no flags.
801 * it has nothing left to give - remove it
803 mfib_entry_src_remove(mfib_entry, source);
806 mfib_entry_recalculate_forwarding(mfib_entry);
808 return (mfib_entry_ok_for_delete(mfib_entry));
812 mfib_entry_itf_add (mfib_entry_src_t *msrc,
816 hash_set(msrc->mfes_itfs, sw_if_index, mi);
820 mfib_entry_itf_remove (mfib_entry_src_t *msrc,
825 mfi = mfib_entry_itf_find(msrc->mfes_itfs, sw_if_index);
827 mfib_itf_delete(mfi);
829 hash_unset(msrc->mfes_itfs, sw_if_index);
833 mfib_entry_path_update (fib_node_index_t mfib_entry_index,
834 mfib_source_t source,
835 const fib_route_path_t *rpath,
836 mfib_itf_flags_t itf_flags)
838 fib_node_index_t path_index;
839 mfib_path_ext_t *path_ext;
840 mfib_itf_flags_t old, new;
841 mfib_entry_t *mfib_entry;
842 mfib_entry_src_t *msrc;
844 mfib_entry = mfib_entry_get(mfib_entry_index);
845 ASSERT(NULL != mfib_entry);
846 msrc = mfib_entry_src_find_or_create(mfib_entry, source);
849 * add the path to the path-list. If it's a duplicate we'll get
850 * back the original path.
852 path_index = mfib_entry_src_path_add(msrc, rpath);
855 * find the path extension for that path
857 path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
859 if (NULL == path_ext)
861 old = MFIB_ITF_FLAG_NONE;
862 path_ext = mfib_path_ext_add(msrc, path_index, itf_flags);
866 old = path_ext->mfpe_flags;
867 path_ext->mfpe_flags = itf_flags;
871 * Has the path changed its contribution to the input interface set.
872 * Which only paths with interfaces can do...
874 if (~0 != rpath[0].frp_sw_if_index)
876 mfib_itf_t *mfib_itf;
882 if (MFIB_ITF_FLAG_NONE == new)
885 * no more interface flags on this path, remove
886 * from the data-plane set
888 mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
890 else if (MFIB_ITF_FLAG_NONE == old)
893 * This interface is now contributing
895 mfib_entry_itf_add(msrc,
896 rpath[0].frp_sw_if_index,
897 mfib_itf_create(rpath[0].frp_sw_if_index,
903 * change of flag contributions
905 mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
906 rpath[0].frp_sw_if_index);
907 /* Seen by packets inflight */
908 mfib_itf->mfi_flags = new;
913 mfib_entry_recalculate_forwarding(mfib_entry);
917 * mfib_entry_path_remove
919 * remove a path from the entry.
920 * return the mfib_entry's index if it is still present, INVALID otherwise.
923 mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
924 mfib_source_t source,
925 const fib_route_path_t *rpath)
927 fib_node_index_t path_index;
928 mfib_entry_t *mfib_entry;
929 mfib_entry_src_t *msrc;
931 mfib_entry = mfib_entry_get(mfib_entry_index);
932 ASSERT(NULL != mfib_entry);
933 msrc = mfib_entry_src_find(mfib_entry, source, NULL);
938 * there are no paths left for this source
940 return (mfib_entry_ok_for_delete(mfib_entry));
944 * remove the path from the path-list. If it's not there we'll get
947 path_index = mfib_entry_src_path_remove(msrc, rpath);
949 if (FIB_NODE_INDEX_INVALID != path_index)
952 * don't need the extension, nor the interface anymore
954 mfib_path_ext_remove(msrc, path_index);
955 if (~0 != rpath[0].frp_sw_if_index)
957 mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
961 if (mfib_entry_src_ok_for_delete(msrc))
964 * this source has no interfaces and no flags.
965 * it has nothing left to give - remove it
967 mfib_entry_src_remove(mfib_entry, source);
970 mfib_entry_recalculate_forwarding(mfib_entry);
972 return (mfib_entry_ok_for_delete(mfib_entry));
978 * The source is withdrawing all the paths it provided
981 mfib_entry_delete (fib_node_index_t mfib_entry_index,
982 mfib_source_t source)
984 mfib_entry_t *mfib_entry;
986 mfib_entry = mfib_entry_get(mfib_entry_index);
987 mfib_entry_src_remove(mfib_entry, source);
989 mfib_entry_recalculate_forwarding(mfib_entry);
991 return (mfib_entry_ok_for_delete(mfib_entry));
995 fib_ip4_address_compare (ip4_address_t * a1,
999 * IP addresses are unsiged ints. the return value here needs to be signed
1000 * a simple subtraction won't cut it.
1001 * If the addresses are the same, the sort order is undefiend, so phoey.
1003 return ((clib_net_to_host_u32(a1->data_u32) >
1004 clib_net_to_host_u32(a2->data_u32) ) ?
1009 fib_ip6_address_compare (ip6_address_t * a1,
1013 for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1015 int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1016 clib_net_to_host_u16 (a2->as_u16[i]));
1024 mfib_entry_cmp (fib_node_index_t mfib_entry_index1,
1025 fib_node_index_t mfib_entry_index2)
1027 mfib_entry_t *mfib_entry1, *mfib_entry2;
1030 mfib_entry1 = mfib_entry_get(mfib_entry_index1);
1031 mfib_entry2 = mfib_entry_get(mfib_entry_index2);
1033 switch (mfib_entry1->mfe_prefix.fp_proto)
1035 case FIB_PROTOCOL_IP4:
1036 cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip4,
1037 &mfib_entry2->mfe_prefix.fp_grp_addr.ip4);
1041 cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip4,
1042 &mfib_entry2->mfe_prefix.fp_src_addr.ip4);
1045 case FIB_PROTOCOL_IP6:
1046 cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip6,
1047 &mfib_entry2->mfe_prefix.fp_grp_addr.ip6);
1051 cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip6,
1052 &mfib_entry2->mfe_prefix.fp_src_addr.ip6);
1055 case FIB_PROTOCOL_MPLS:
1062 cmp = (mfib_entry1->mfe_prefix.fp_len - mfib_entry2->mfe_prefix.fp_len);
1068 mfib_entry_cmp_for_sort (void *i1, void *i2)
1070 fib_node_index_t *mfib_entry_index1 = i1, *mfib_entry_index2 = i2;
1072 return (mfib_entry_cmp(*mfib_entry_index1,
1073 *mfib_entry_index2));
1077 mfib_entry_last_lock_gone (fib_node_t *node)
1079 mfib_entry_t *mfib_entry;
1080 mfib_entry_src_t *msrc;
1082 mfib_entry = mfib_entry_from_fib_node(node);
1084 dpo_reset(&mfib_entry->mfe_rep);
1086 MFIB_ENTRY_DBG(mfib_entry, "last-lock");
1088 vec_foreach(msrc, mfib_entry->mfe_srcs)
1090 mfib_entry_src_flush(msrc);
1093 vec_free(mfib_entry->mfe_srcs);
1095 fib_node_deinit(&mfib_entry->mfe_node);
1096 pool_put(mfib_entry_pool, mfib_entry);
1100 * mfib_entry_back_walk_notify
1102 * A back walk has reach this entry.
1104 static fib_node_back_walk_rc_t
1105 mfib_entry_back_walk_notify (fib_node_t *node,
1106 fib_node_back_walk_ctx_t *ctx)
1108 mfib_entry_recalculate_forwarding(mfib_entry_from_fib_node(node));
1110 return (FIB_NODE_BACK_WALK_CONTINUE);
1114 mfib_entry_show_memory (void)
1116 fib_show_memory_usage("multicast-Entry",
1117 pool_elts(mfib_entry_pool),
1118 pool_len(mfib_entry_pool),
1119 sizeof(mfib_entry_t));
1123 * The MFIB entry's graph node virtual function table
1125 static const fib_node_vft_t mfib_entry_vft = {
1126 .fnv_get = mfib_entry_get_node,
1127 .fnv_last_lock = mfib_entry_last_lock_gone,
1128 .fnv_back_walk = mfib_entry_back_walk_notify,
1129 .fnv_mem_show = mfib_entry_show_memory,
1133 mfib_entry_lock (fib_node_index_t mfib_entry_index)
1135 mfib_entry_t *mfib_entry;
1137 mfib_entry = mfib_entry_get(mfib_entry_index);
1139 fib_node_lock(&mfib_entry->mfe_node);
1143 mfib_entry_unlock (fib_node_index_t mfib_entry_index)
1145 mfib_entry_t *mfib_entry;
1147 mfib_entry = mfib_entry_get(mfib_entry_index);
1149 fib_node_unlock(&mfib_entry->mfe_node);
1153 mfib_entry_dpo_lock (dpo_id_t *dpo)
1157 mfib_entry_dpo_unlock (dpo_id_t *dpo)
1161 const static dpo_vft_t mfib_entry_dpo_vft = {
1162 .dv_lock = mfib_entry_dpo_lock,
1163 .dv_unlock = mfib_entry_dpo_unlock,
1164 .dv_format = format_mfib_entry_dpo,
1165 .dv_mem_show = mfib_entry_show_memory,
1168 const static char* const mfib_entry_ip4_nodes[] =
1170 "ip4-mfib-forward-rpf",
1173 const static char* const mfib_entry_ip6_nodes[] =
1175 "ip6-mfib-forward-rpf",
1179 const static char* const * const mfib_entry_nodes[DPO_PROTO_NUM] =
1181 [DPO_PROTO_IP4] = mfib_entry_ip4_nodes,
1182 [DPO_PROTO_IP6] = mfib_entry_ip6_nodes,
1186 mfib_entry_module_init (void)
1188 fib_node_register_type (FIB_NODE_TYPE_MFIB_ENTRY, &mfib_entry_vft);
1189 dpo_register(DPO_MFIB_ENTRY, &mfib_entry_dpo_vft, mfib_entry_nodes);
1193 mfib_entry_encode (fib_node_index_t mfib_entry_index,
1194 fib_route_path_encode_t **api_rpaths)
1196 mfib_entry_t *mfib_entry;
1197 mfib_entry_src_t *bsrc;
1199 mfib_entry = mfib_entry_get(mfib_entry_index);
1200 bsrc = mfib_entry_get_best_src(mfib_entry);
1202 if (FIB_NODE_INDEX_INVALID != bsrc->mfes_pl)
1204 fib_path_list_walk(bsrc->mfes_pl,
1212 mfib_entry_get_prefix (fib_node_index_t mfib_entry_index,
1215 mfib_entry_t *mfib_entry;
1217 mfib_entry = mfib_entry_get(mfib_entry_index);
1218 *pfx = mfib_entry->mfe_prefix;
1222 mfib_entry_get_fib_index (fib_node_index_t mfib_entry_index)
1224 mfib_entry_t *mfib_entry;
1226 mfib_entry = mfib_entry_get(mfib_entry_index);
1228 return (mfib_entry->mfe_fib_index);
1232 mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
1233 fib_forward_chain_type_t type,
1237 * An IP mFIB entry can only provide a forwarding chain that
1238 * is the same IP proto as the prefix.
1239 * No use-cases (i know of) for other combinations.
1241 mfib_entry_t *mfib_entry;
1244 mfib_entry = mfib_entry_get(mfib_entry_index);
1246 dp = fib_proto_to_dpo(mfib_entry->mfe_prefix.fp_proto);
1248 if (type == fib_forw_chain_type_from_dpo_proto(dp))
1250 dpo_copy(dpo, &mfib_entry->mfe_rep);
1254 dpo_copy(dpo, drop_dpo_get(dp));
1259 mfib_entry_pool_size (void)
1261 return (pool_elts(mfib_entry_pool));
1264 static clib_error_t *
1265 show_mfib_entry_command (vlib_main_t * vm,
1266 unformat_input_t * input,
1267 vlib_cli_command_t * cmd)
1269 fib_node_index_t fei;
1271 if (unformat (input, "%d", &fei))
1274 * show one in detail
1276 if (!pool_is_free_index(mfib_entry_pool, fei))
1278 vlib_cli_output (vm, "%d@%U",
1280 format_mfib_entry, fei,
1281 MFIB_ENTRY_FORMAT_DETAIL2);
1285 vlib_cli_output (vm, "entry %d invalid", fei);
1293 vlib_cli_output (vm, "FIB Entries:");
1294 pool_foreach_index(fei, mfib_entry_pool,
1296 vlib_cli_output (vm, "%d@%U",
1298 format_mfib_entry, fei,
1299 MFIB_ENTRY_FORMAT_BRIEF);
1307 * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique
1308 * numerical indentifier.
1310 VLIB_CLI_COMMAND (show_mfib_entry, static) = {
1311 .path = "show mfib entry",
1312 .function = show_mfib_entry_command,
1313 .short_help = "show mfib entry",