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>
17 #include <vnet/dpo/drop_dpo.h>
19 #include <vnet/mfib/mfib_table.h>
20 #include <vnet/mfib/ip4_mfib.h>
21 #include <vnet/mfib/ip6_mfib.h>
22 #include <vnet/mfib/mfib_entry.h>
23 #include <vnet/mfib/mfib_entry_src.h>
24 #include <vnet/mfib/mfib_entry_cover.h>
25 #include <vnet/mfib/mfib_signal.h>
27 const static char * mfib_table_flags_strings[] = MFIB_TABLE_ATTRIBUTES;
30 mfib_table_get (fib_node_index_t index,
35 case FIB_PROTOCOL_IP4:
36 return (pool_elt_at_index(ip4_main.mfibs, index));
37 case FIB_PROTOCOL_IP6:
38 return (pool_elt_at_index(ip6_main.mfibs, index));
39 case FIB_PROTOCOL_MPLS:
46 static inline fib_node_index_t
47 mfib_table_lookup_i (const mfib_table_t *mfib_table,
48 const mfib_prefix_t *prefix)
50 switch (prefix->fp_proto)
52 case FIB_PROTOCOL_IP4:
53 return (ip4_mfib_table_lookup(&mfib_table->v4,
54 &prefix->fp_src_addr.ip4,
55 &prefix->fp_grp_addr.ip4,
57 case FIB_PROTOCOL_IP6:
58 return (ip6_mfib_table_lookup(&mfib_table->v6,
59 &prefix->fp_src_addr.ip6,
60 &prefix->fp_grp_addr.ip6,
62 case FIB_PROTOCOL_MPLS:
65 return (FIB_NODE_INDEX_INVALID);
69 mfib_table_lookup (u32 fib_index,
70 const mfib_prefix_t *prefix)
72 return (mfib_table_lookup_i(mfib_table_get(fib_index, prefix->fp_proto), prefix));
75 static inline fib_node_index_t
76 mfib_table_lookup_exact_match_i (const mfib_table_t *mfib_table,
77 const mfib_prefix_t *prefix)
79 switch (prefix->fp_proto)
81 case FIB_PROTOCOL_IP4:
82 return (ip4_mfib_table_lookup_exact_match(&mfib_table->v4,
83 &prefix->fp_grp_addr.ip4,
84 &prefix->fp_src_addr.ip4,
86 case FIB_PROTOCOL_IP6:
87 return (ip6_mfib_table_lookup_exact_match(&mfib_table->v6,
88 &prefix->fp_grp_addr.ip6,
89 &prefix->fp_src_addr.ip6,
91 case FIB_PROTOCOL_MPLS:
94 return (FIB_NODE_INDEX_INVALID);
98 mfib_table_lookup_exact_match (u32 fib_index,
99 const mfib_prefix_t *prefix)
101 return (mfib_table_lookup_exact_match_i(mfib_table_get(fib_index,
106 static fib_node_index_t
107 mfib_table_get_less_specific_i (const mfib_table_t *mfib_table,
108 const mfib_prefix_t *prefix)
110 switch (prefix->fp_proto)
112 case FIB_PROTOCOL_IP4:
113 return (ip4_mfib_table_get_less_specific(&mfib_table->v4,
114 &prefix->fp_src_addr.ip4,
115 &prefix->fp_grp_addr.ip4,
117 case FIB_PROTOCOL_IP6:
118 return (ip6_mfib_table_get_less_specific(&mfib_table->v6,
119 &prefix->fp_src_addr.ip6,
120 &prefix->fp_grp_addr.ip6,
122 case FIB_PROTOCOL_MPLS:
125 return (FIB_NODE_INDEX_INVALID);
129 mfib_table_get_less_specific (u32 fib_index,
130 const mfib_prefix_t *prefix)
132 return (mfib_table_get_less_specific_i(mfib_table_get(fib_index,
138 mfib_table_entry_remove (mfib_table_t *mfib_table,
139 const mfib_prefix_t *prefix,
140 fib_node_index_t mfib_entry_index)
142 vlib_smp_unsafe_warning();
144 mfib_table->mft_total_route_counts--;
146 switch (prefix->fp_proto)
148 case FIB_PROTOCOL_IP4:
149 ip4_mfib_table_entry_remove(&mfib_table->v4,
150 &prefix->fp_grp_addr.ip4,
151 &prefix->fp_src_addr.ip4,
154 case FIB_PROTOCOL_IP6:
155 ip6_mfib_table_entry_remove(&mfib_table->v6,
156 &prefix->fp_grp_addr.ip6,
157 &prefix->fp_src_addr.ip6,
160 case FIB_PROTOCOL_MPLS:
165 mfib_entry_cover_change_notify(mfib_entry_index,
166 FIB_NODE_INDEX_INVALID);
167 mfib_entry_unlock(mfib_entry_index);
171 mfib_table_post_insert_actions (mfib_table_t *mfib_table,
172 const mfib_prefix_t *prefix,
173 fib_node_index_t mfib_entry_index)
175 fib_node_index_t mfib_entry_cover_index;
178 * find the covering entry
180 mfib_entry_cover_index = mfib_table_get_less_specific_i(mfib_table,
183 * the indicies are the same when the default route is first added
185 if (mfib_entry_cover_index != mfib_entry_index)
188 * inform the covering entry that a new more specific
189 * has been inserted beneath it.
190 * If the prefix that has been inserted is a host route
191 * then it is not possible that it will be the cover for any
192 * other entry, so we can elide the walk.
194 if (!mfib_entry_is_host(mfib_entry_index))
196 mfib_entry_cover_change_notify(mfib_entry_cover_index,
204 mfib_table_entry_insert (mfib_table_t *mfib_table,
205 const mfib_prefix_t *prefix,
206 fib_node_index_t mfib_entry_index)
208 vlib_smp_unsafe_warning();
210 mfib_entry_lock(mfib_entry_index);
211 mfib_table->mft_total_route_counts++;
213 switch (prefix->fp_proto)
215 case FIB_PROTOCOL_IP4:
216 ip4_mfib_table_entry_insert(&mfib_table->v4,
217 &prefix->fp_grp_addr.ip4,
218 &prefix->fp_src_addr.ip4,
222 case FIB_PROTOCOL_IP6:
223 ip6_mfib_table_entry_insert(&mfib_table->v6,
224 &prefix->fp_grp_addr.ip6,
225 &prefix->fp_src_addr.ip6,
229 case FIB_PROTOCOL_MPLS:
233 mfib_table_post_insert_actions(mfib_table, prefix, mfib_entry_index);
237 mfib_table_entry_update (u32 fib_index,
238 const mfib_prefix_t *prefix,
239 mfib_source_t source,
241 mfib_entry_flags_t entry_flags)
243 fib_node_index_t mfib_entry_index;
244 mfib_table_t *mfib_table;
246 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
247 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
249 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
251 if (MFIB_ENTRY_FLAG_NONE != entry_flags)
254 * update to a non-existing entry with non-zero flags
256 mfib_entry_index = mfib_entry_create(fib_index, source,
261 mfib_table_entry_insert(mfib_table, prefix, mfib_entry_index);
265 * the entry doesn't exist and the request is to set no flags
266 * the result would be an entry that doesn't exist - so do nothing
271 mfib_entry_lock(mfib_entry_index);
273 if (mfib_entry_update(mfib_entry_index,
280 * this update means we can now remove the entry.
282 mfib_table_entry_remove(mfib_table, prefix, mfib_entry_index);
285 mfib_entry_unlock(mfib_entry_index);
288 return (mfib_entry_index);
291 static fib_node_index_t
292 mfib_table_entry_paths_update_i (u32 fib_index,
293 const mfib_prefix_t *prefix,
294 mfib_source_t source,
295 const fib_route_path_t *rpaths)
297 fib_node_index_t mfib_entry_index;
298 mfib_table_t *mfib_table;
300 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
301 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
303 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
305 mfib_entry_index = mfib_entry_create(fib_index,
309 MFIB_ENTRY_FLAG_NONE,
312 mfib_entry_path_update(mfib_entry_index, source, rpaths);
314 mfib_table_entry_insert(mfib_table, prefix, mfib_entry_index);
318 mfib_entry_path_update(mfib_entry_index, source, rpaths);
320 return (mfib_entry_index);
325 mfib_table_entry_path_update (u32 fib_index,
326 const mfib_prefix_t *prefix,
327 mfib_source_t source,
328 const fib_route_path_t *rpath)
330 fib_node_index_t mfib_entry_index;
331 fib_route_path_t *rpaths = NULL;
333 vec_add1(rpaths, *rpath);
335 mfib_entry_index = mfib_table_entry_paths_update_i(fib_index, prefix,
339 return (mfib_entry_index);
343 mfib_table_entry_paths_update (u32 fib_index,
344 const mfib_prefix_t *prefix,
345 mfib_source_t source,
346 const fib_route_path_t *rpaths)
348 return (mfib_table_entry_paths_update_i(fib_index, prefix,
353 mfib_table_entry_paths_remove_i (u32 fib_index,
354 const mfib_prefix_t *prefix,
355 mfib_source_t source,
356 const fib_route_path_t *rpaths)
358 fib_node_index_t mfib_entry_index;
359 mfib_table_t *mfib_table;
361 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
362 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
364 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
367 * removing an entry that does not exist. i'll allow it.
375 * don't nobody go nowhere
377 mfib_entry_lock(mfib_entry_index);
379 no_more_sources = mfib_entry_path_remove(mfib_entry_index,
386 * last source gone. remove from the table
388 mfib_table_entry_remove(mfib_table, prefix, mfib_entry_index);
391 mfib_entry_unlock(mfib_entry_index);
395 mfib_table_entry_paths_remove (u32 fib_index,
396 const mfib_prefix_t *prefix,
397 mfib_source_t source,
398 const fib_route_path_t *rpaths)
400 mfib_table_entry_paths_remove_i(fib_index,
407 mfib_table_entry_path_remove (u32 fib_index,
408 const mfib_prefix_t *prefix,
409 mfib_source_t source,
410 const fib_route_path_t *rpath)
412 fib_route_path_t *rpaths = NULL;
414 vec_add1(rpaths, *rpath);
416 mfib_table_entry_paths_remove_i(fib_index,
425 mfib_table_entry_special_add (u32 fib_index,
426 const mfib_prefix_t *prefix,
427 mfib_source_t source,
428 mfib_entry_flags_t entry_flags,
431 fib_node_index_t mfib_entry_index;
432 mfib_table_t *mfib_table;
434 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
435 mfib_entry_index = mfib_table_lookup_exact_match_i(mfib_table, prefix);
437 if (INDEX_INVALID != repi)
439 entry_flags |= MFIB_ENTRY_FLAG_EXCLUSIVE;
442 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
444 mfib_entry_index = mfib_entry_create(fib_index,
451 mfib_table_entry_insert(mfib_table, prefix, mfib_entry_index);
455 mfib_entry_special_add(mfib_entry_index, source, entry_flags,
456 MFIB_RPF_ID_NONE, repi);
459 return (mfib_entry_index);
463 mfib_table_entry_delete_i (u32 fib_index,
464 fib_node_index_t mfib_entry_index,
465 const mfib_prefix_t *prefix,
466 mfib_source_t source)
468 mfib_table_t *mfib_table;
470 mfib_table = mfib_table_get(fib_index, prefix->fp_proto);
473 * don't nobody go nowhere
475 mfib_entry_lock(mfib_entry_index);
477 if (mfib_entry_delete(mfib_entry_index, source))
480 * last source gone. remove from the table
482 mfib_table_entry_remove(mfib_table, prefix, mfib_entry_index);
486 * still has sources, leave it be.
489 mfib_entry_unlock(mfib_entry_index);
493 mfib_table_entry_delete (u32 fib_index,
494 const mfib_prefix_t *prefix,
495 mfib_source_t source)
497 fib_node_index_t mfib_entry_index;
499 mfib_entry_index = mfib_table_lookup_exact_match(fib_index, prefix);
501 if (FIB_NODE_INDEX_INVALID == mfib_entry_index)
504 * removing an etry that does not exist.
505 * i'll allow it, but i won't like it.
507 clib_warning("%U not in FIB", format_mfib_prefix, prefix);
511 mfib_table_entry_delete_i(fib_index, mfib_entry_index,
517 mfib_table_entry_delete_index (fib_node_index_t mfib_entry_index,
518 mfib_source_t source)
520 mfib_table_entry_delete_i(mfib_entry_get_fib_index(mfib_entry_index),
522 mfib_entry_get_prefix(mfib_entry_index),
527 mfib_table_get_index_for_sw_if_index (fib_protocol_t proto,
532 case FIB_PROTOCOL_IP4:
533 return (ip4_mfib_table_get_index_for_sw_if_index(sw_if_index));
534 case FIB_PROTOCOL_IP6:
535 return (ip6_mfib_table_get_index_for_sw_if_index(sw_if_index));
536 case FIB_PROTOCOL_MPLS:
544 mfib_table_get_table_id (u32 fib_index,
545 fib_protocol_t proto)
547 mfib_table_t *mfib_table;
549 mfib_table = mfib_table_get(fib_index, proto);
551 return ((NULL != mfib_table ? mfib_table->mft_table_id : ~0));
555 mfib_table_find (fib_protocol_t proto,
560 case FIB_PROTOCOL_IP4:
561 return (ip4_mfib_index_from_table_id(table_id));
562 case FIB_PROTOCOL_IP6:
563 return (ip6_mfib_index_from_table_id(table_id));
564 case FIB_PROTOCOL_MPLS:
572 mfib_table_find_or_create_and_lock_i (fib_protocol_t proto,
577 mfib_table_t *mfib_table;
582 case FIB_PROTOCOL_IP4:
583 fi = ip4_mfib_table_find_or_create_and_lock(table_id, src);
585 case FIB_PROTOCOL_IP6:
586 fi = ip6_mfib_table_find_or_create_and_lock(table_id, src);
588 case FIB_PROTOCOL_MPLS:
593 mfib_table = mfib_table_get(fi, proto);
595 if (NULL == mfib_table->mft_desc)
599 mfib_table->mft_desc = format(NULL, "%s", name);
603 mfib_table->mft_desc = format(NULL, "%U-VRF:%d",
604 format_fib_protocol, proto,
613 mfib_table_find_or_create_and_lock (fib_protocol_t proto,
617 return (mfib_table_find_or_create_and_lock_i(proto, table_id,
622 mfib_table_find_or_create_and_lock_w_name (fib_protocol_t proto,
627 return (mfib_table_find_or_create_and_lock_i(proto, table_id,
632 * @brief Table flush context. Store the indicies of matching FIB entries
633 * that need to be removed.
635 typedef struct mfib_table_flush_ctx_t_
638 * The list of entries to flush
640 fib_node_index_t *mftf_entries;
643 * The source we are flushing
645 mfib_source_t mftf_source;
646 } mfib_table_flush_ctx_t;
649 mfib_table_flush_cb (fib_node_index_t mfib_entry_index,
652 mfib_table_flush_ctx_t *ctx = arg;
654 if (mfib_entry_is_sourced(mfib_entry_index, ctx->mftf_source))
656 vec_add1(ctx->mftf_entries, mfib_entry_index);
658 return (WALK_CONTINUE);
662 mfib_table_flush (u32 mfib_index,
663 fib_protocol_t proto,
664 mfib_source_t source)
666 fib_node_index_t *mfib_entry_index;
667 mfib_table_flush_ctx_t ctx = {
668 .mftf_entries = NULL,
669 .mftf_source = source,
672 mfib_table_walk(mfib_index, proto,
676 vec_foreach(mfib_entry_index, ctx.mftf_entries)
678 mfib_table_entry_delete_index(*mfib_entry_index, source);
681 vec_free(ctx.mftf_entries);
685 mfib_table_mark_cb (fib_node_index_t fib_entry_index,
688 mfib_table_flush_ctx_t *ctx = arg;
690 if (mfib_entry_is_sourced(fib_entry_index, ctx->mftf_source))
692 mfib_entry_mark(fib_entry_index, ctx->mftf_source);
694 return (WALK_CONTINUE);
698 mfib_table_mark (u32 fib_index,
699 fib_protocol_t proto,
700 mfib_source_t source)
702 mfib_table_flush_ctx_t ctx = {
703 .mftf_source = source,
705 mfib_table_t *mfib_table;
707 mfib_table = mfib_table_get(fib_index, proto);
709 mfib_table->mft_epoch++;
710 mfib_table->mft_flags |= MFIB_TABLE_FLAG_RESYNC;
712 mfib_table_walk(fib_index, proto,
718 mfib_table_sweep_cb (fib_node_index_t fib_entry_index,
721 mfib_table_flush_ctx_t *ctx = arg;
723 if (mfib_entry_is_marked(fib_entry_index, ctx->mftf_source))
725 vec_add1(ctx->mftf_entries, fib_entry_index);
727 return (WALK_CONTINUE);
731 mfib_table_sweep (u32 fib_index,
732 fib_protocol_t proto,
733 mfib_source_t source)
735 mfib_table_flush_ctx_t ctx = {
736 .mftf_source = source,
738 fib_node_index_t *fib_entry_index;
739 mfib_table_t *mfib_table;
741 mfib_table = mfib_table_get(fib_index, proto);
743 mfib_table->mft_flags &= ~MFIB_TABLE_FLAG_RESYNC;
745 mfib_table_walk(fib_index, proto,
749 vec_foreach(fib_entry_index, ctx.mftf_entries)
751 mfib_table_entry_delete_index(*fib_entry_index, source);
754 vec_free(ctx.mftf_entries);
758 mfib_table_destroy (mfib_table_t *mfib_table)
760 vec_free(mfib_table->mft_desc);
762 switch (mfib_table->mft_proto)
764 case FIB_PROTOCOL_IP4:
765 ip4_mfib_table_destroy(&mfib_table->v4);
767 case FIB_PROTOCOL_IP6:
768 ip6_mfib_table_destroy(&mfib_table->v6);
770 case FIB_PROTOCOL_MPLS:
777 mfib_table_unlock (u32 fib_index,
778 fib_protocol_t proto,
779 mfib_source_t source)
781 mfib_table_t *mfib_table;
783 mfib_table = mfib_table_get(fib_index, proto);
784 mfib_table->mft_locks[source]--;
785 mfib_table->mft_locks[MFIB_TABLE_TOTAL_LOCKS]--;
787 if (0 == mfib_table->mft_locks[source])
790 * The source no longer needs the table. flush any routes
791 * from it just in case
793 mfib_table_flush(fib_index, proto, source);
796 if (0 == mfib_table->mft_locks[MFIB_TABLE_TOTAL_LOCKS])
799 * no more locak from any source - kill it
801 mfib_table_destroy(mfib_table);
806 mfib_table_lock (u32 fib_index,
807 fib_protocol_t proto,
808 mfib_source_t source)
810 mfib_table_t *mfib_table;
812 mfib_table = mfib_table_get(fib_index, proto);
813 mfib_table->mft_locks[source]++;
814 mfib_table->mft_locks[MFIB_TABLE_TOTAL_LOCKS]++;
818 mfib_table_get_n_routes (fib_node_index_t fib_index,
819 fib_protocol_t proto)
821 mfib_table_t *mfib_table;
823 mfib_table = mfib_table_get(fib_index, proto);
825 return (mfib_table->mft_total_route_counts);
829 mfib_table_walk (u32 fib_index,
830 fib_protocol_t proto,
831 mfib_table_walk_fn_t fn,
836 case FIB_PROTOCOL_IP4:
837 ip4_mfib_table_walk(ip4_mfib_get(fib_index), fn, ctx);
839 case FIB_PROTOCOL_IP6:
840 ip6_mfib_table_walk(ip6_mfib_get(fib_index), fn, ctx);
842 case FIB_PROTOCOL_MPLS:
848 format_mfib_table_flags (u8 *s, va_list *args)
850 mfib_table_flags_t flags = va_arg(*args, int);
851 mfib_table_attribute_t attr;
855 return format(s, "none");
858 FOR_EACH_MFIB_TABLE_ATTRIBUTE(attr) {
859 if (1 << attr & flags) {
860 s = format(s, "%s", mfib_table_flags_strings[attr]);
868 format_mfib_table_name (u8* s, va_list *ap)
870 fib_node_index_t fib_index = va_arg(*ap, fib_node_index_t);
871 fib_protocol_t proto = va_arg(*ap, int); // int promotion
872 mfib_table_t *mfib_table;
874 mfib_table = mfib_table_get(fib_index, proto);
876 s = format(s, "%v", mfib_table->mft_desc);
882 format_mfib_table_memory (u8 *s, va_list *args)
884 s = format(s, "%U", format_ip4_mfib_table_memory);
885 s = format(s, "%U", format_ip6_mfib_table_memory);
890 static clib_error_t *
891 mfib_module_init (vlib_main_t * vm)
893 clib_error_t * error;
895 mfib_entry_src_module_init();
896 mfib_entry_module_init();
897 mfib_signal_module_init();
899 if ((error = vlib_call_init_function (vm, fib_module_init)))
901 if ((error = vlib_call_init_function (vm, rn_module_init)))
907 VLIB_INIT_FUNCTION(mfib_module_init);