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/ip/format.h>
18 #include <vnet/ip/lookup.h>
19 #include <vnet/adj/adj.h>
20 #include <vnet/dpo/load_balance.h>
21 #include <vnet/dpo/drop_dpo.h>
23 #include <vnet/fib/fib_entry.h>
24 #include <vnet/fib/fib_walk.h>
25 #include <vnet/fib/fib_entry_src.h>
26 #include <vnet/fib/fib_entry_cover.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/fib/fib_internal.h>
29 #include <vnet/fib/fib_attached_export.h>
30 #include <vnet/fib/fib_path_ext.h>
33 * Array of strings/names for the FIB sources
35 static const char *fib_source_names[] = FIB_SOURCES;
36 static const char *fib_attribute_names[] = FIB_ENTRY_ATTRIBUTES;
39 * Pool for all fib_entries
41 static fib_entry_t *fib_entry_pool;
44 fib_entry_get (fib_node_index_t index)
46 return (pool_elt_at_index(fib_entry_pool, index));
50 fib_entry_get_node (fib_node_index_t index)
52 return ((fib_node_t*)fib_entry_get(index));
56 fib_entry_get_index (const fib_entry_t * fib_entry)
58 return (fib_entry - fib_entry_pool);
62 fib_entry_get_proto (const fib_entry_t * fib_entry)
64 return (fib_entry->fe_prefix.fp_proto);
67 fib_forward_chain_type_t
68 fib_entry_get_default_chain_type (const fib_entry_t *fib_entry)
70 switch (fib_entry->fe_prefix.fp_proto)
72 case FIB_PROTOCOL_IP4:
73 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
74 case FIB_PROTOCOL_IP6:
75 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP6);
76 case FIB_PROTOCOL_MPLS:
77 if (MPLS_EOS == fib_entry->fe_prefix.fp_eos)
78 return (FIB_FORW_CHAIN_TYPE_MPLS_EOS);
80 return (FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS);
83 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
87 format_fib_entry (u8 * s, va_list * args)
89 fib_forward_chain_type_t fct;
90 fib_entry_attribute_t attr;
91 fib_entry_t *fib_entry;
97 fei = va_arg (*args, fib_node_index_t);
98 level = va_arg (*args, int);
99 fib_entry = fib_entry_get(fei);
101 s = format (s, "%U", format_fib_prefix, &fib_entry->fe_prefix);
103 if (level >= FIB_ENTRY_FORMAT_DETAIL)
105 s = format (s, " fib:%d", fib_entry->fe_fib_index);
106 s = format (s, " index:%d", fib_entry_get_index(fib_entry));
107 s = format (s, " locks:%d", fib_entry->fe_node.fn_locks);
109 FOR_EACH_SRC_ADDED(fib_entry, src, source,
111 s = format (s, "\n src:%s ",
112 fib_source_names[source]);
113 s = fib_entry_src_format(fib_entry, source, s);
114 s = format (s, " refs:%d ", src->fes_ref_count);
115 if (FIB_ENTRY_FLAG_NONE != src->fes_entry_flags) {
116 s = format(s, "flags:");
117 FOR_EACH_FIB_ATTRIBUTE(attr) {
118 if ((1<<attr) & src->fes_entry_flags) {
119 s = format (s, "%s,", fib_attribute_names[attr]);
123 s = format (s, "\n");
124 if (FIB_NODE_INDEX_INVALID != src->fes_pl)
126 s = fib_path_list_format(src->fes_pl, s);
128 s = format(s, "%U", format_fib_path_ext_list, &src->fes_path_exts);
131 s = format (s, "\n forwarding: ");
135 s = format (s, "\n");
138 fct = fib_entry_get_default_chain_type(fib_entry);
140 if (!dpo_id_is_valid(&fib_entry->fe_lb))
142 s = format (s, " UNRESOLVED\n");
147 s = format(s, " %U-chain\n %U",
148 format_fib_forw_chain_type, fct,
154 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
156 fib_entry_delegate_type_t fdt;
157 fib_entry_delegate_t *fed;
159 s = format (s, " Delegates:\n");
160 FOR_EACH_DELEGATE(fib_entry, fdt, fed,
162 s = format(s, " %U\n", format_fib_entry_deletegate, fed);
167 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
169 s = format(s, " Children:");
170 s = fib_node_children_format(fib_entry->fe_node.fn_children, s);
177 fib_entry_from_fib_node (fib_node_t *node)
180 ASSERT(FIB_NODE_TYPE_ENTRY == node->fn_type);
182 return ((fib_entry_t*)node);
186 fib_entry_last_lock_gone (fib_node_t *node)
188 fib_entry_delegate_type_t fdt;
189 fib_entry_delegate_t *fed;
190 fib_entry_t *fib_entry;
192 fib_entry = fib_entry_from_fib_node(node);
194 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
196 dpo_reset(&fed->fd_dpo);
197 fib_entry_delegate_remove(fib_entry, fdt);
200 FIB_ENTRY_DBG(fib_entry, "last-lock");
202 fib_node_deinit(&fib_entry->fe_node);
203 // FIXME -RR Backwalk
205 ASSERT(0 == vec_len(fib_entry->fe_delegates));
206 vec_free(fib_entry->fe_delegates);
207 vec_free(fib_entry->fe_srcs);
208 pool_put(fib_entry_pool, fib_entry);
211 static fib_entry_src_t*
212 fib_entry_get_best_src_i (const fib_entry_t *fib_entry)
214 fib_entry_src_t *bsrc;
217 * the enum of sources is deliberately arranged in priority order
219 if (0 == vec_len(fib_entry->fe_srcs))
225 bsrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
232 fib_entry_src_get_source (const fib_entry_src_t *esrc)
236 return (esrc->fes_src);
238 return (FIB_SOURCE_MAX);
241 static fib_entry_flag_t
242 fib_entry_src_get_flags (const fib_entry_src_t *esrc)
246 return (esrc->fes_entry_flags);
248 return (FIB_ENTRY_FLAG_NONE);
252 fib_entry_get_flags (fib_node_index_t fib_entry_index)
254 return (fib_entry_get_flags_i(fib_entry_get(fib_entry_index)));
258 * fib_entry_back_walk_notify
260 * A back walk has reach this entry.
262 static fib_node_back_walk_rc_t
263 fib_entry_back_walk_notify (fib_node_t *node,
264 fib_node_back_walk_ctx_t *ctx)
266 fib_entry_t *fib_entry;
268 fib_entry = fib_entry_from_fib_node(node);
270 if (FIB_NODE_BW_REASON_FLAG_EVALUATE & ctx->fnbw_reason ||
271 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE & ctx->fnbw_reason ||
272 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN & ctx->fnbw_reason ||
273 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP & ctx->fnbw_reason ||
274 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN & ctx->fnbw_reason ||
275 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE & ctx->fnbw_reason)
277 fib_entry_src_action_reactivate(fib_entry,
278 fib_entry_get_best_source(
279 fib_entry_get_index(fib_entry)));
283 * all other walk types can be reclassifed to a re-evaluate to
284 * all recursive dependents.
285 * By reclassifying we ensure that should any of these walk types meet
286 * they can be merged.
288 ctx->fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE;
291 * ... and nothing is forced sync from now on.
293 ctx->fnbw_flags &= ~FIB_NODE_BW_FLAG_FORCE_SYNC;
296 * propagate the backwalk further if we haven't already reached the
299 fib_walk_sync(FIB_NODE_TYPE_ENTRY,
300 fib_entry_get_index(fib_entry),
303 return (FIB_NODE_BACK_WALK_CONTINUE);
307 fib_entry_show_memory (void)
309 u32 n_srcs = 0, n_exts = 0;
310 fib_entry_src_t *esrc;
313 fib_show_memory_usage("Entry",
314 pool_elts(fib_entry_pool),
315 pool_len(fib_entry_pool),
316 sizeof(fib_entry_t));
318 pool_foreach(entry, fib_entry_pool,
320 n_srcs += vec_len(entry->fe_srcs);
321 vec_foreach(esrc, entry->fe_srcs)
323 n_exts += fib_path_ext_list_length(&esrc->fes_path_exts);
327 fib_show_memory_usage("Entry Source",
328 n_srcs, n_srcs, sizeof(fib_entry_src_t));
329 fib_show_memory_usage("Entry Path-Extensions",
331 sizeof(fib_path_ext_t));
335 * The FIB path-list's graph node virtual function table
337 static const fib_node_vft_t fib_entry_vft = {
338 .fnv_get = fib_entry_get_node,
339 .fnv_last_lock = fib_entry_last_lock_gone,
340 .fnv_back_walk = fib_entry_back_walk_notify,
341 .fnv_mem_show = fib_entry_show_memory,
345 * @brief Contribute the set of Adjacencies that this entry forwards with
346 * to build the uRPF list of its children
349 fib_entry_contribute_urpf (fib_node_index_t entry_index,
352 fib_entry_t *fib_entry;
354 fib_entry = fib_entry_get(entry_index);
356 return (fib_path_list_contribute_urpf(fib_entry->fe_parent, urpf));
360 * If the client is request a chain for multicast forwarding then swap
361 * the chain type to one that can provide such transport.
363 static fib_forward_chain_type_t
364 fib_entry_chain_type_mcast_to_ucast (fib_forward_chain_type_t fct)
368 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
369 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
371 * we can only transport IP multicast packets if there is an
374 fct = FIB_FORW_CHAIN_TYPE_MPLS_EOS;
376 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
377 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
378 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
379 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
380 case FIB_FORW_CHAIN_TYPE_ETHERNET:
381 case FIB_FORW_CHAIN_TYPE_NSH:
389 * fib_entry_contribute_forwarding
391 * Get an lock the forwarding information (DPO) contributed by the FIB entry.
394 fib_entry_contribute_forwarding (fib_node_index_t fib_entry_index,
395 fib_forward_chain_type_t fct,
398 fib_entry_delegate_t *fed;
399 fib_entry_t *fib_entry;
401 fib_entry = fib_entry_get(fib_entry_index);
404 * mfib children ask for mcast chains. fix these to the appropriate ucast types.
406 fct = fib_entry_chain_type_mcast_to_ucast(fct);
408 if (fct == fib_entry_get_default_chain_type(fib_entry))
410 dpo_copy(dpo, &fib_entry->fe_lb);
414 fed = fib_entry_delegate_get(fib_entry,
415 fib_entry_chain_type_to_delegate_type(fct));
419 fed = fib_entry_delegate_find_or_add(
421 fib_entry_chain_type_to_delegate_type(fct));
423 * on-demand create eos/non-eos.
424 * There is no on-demand delete because:
425 * - memory versus complexity & reliability:
426 * leaving unrequired [n]eos LB arounds wastes memory, cleaning
427 * then up on the right trigger is more code. i favour the latter.
429 fib_entry_src_mk_lb(fib_entry,
430 fib_entry_get_best_src_i(fib_entry),
435 dpo_copy(dpo, &fed->fd_dpo);
438 * don't allow the special index indicating replicate.vs.load-balance
439 * to escape to the clients
441 dpo->dpoi_index &= ~MPLS_IS_REPLICATE;
445 fib_entry_contribute_ip_forwarding (fib_node_index_t fib_entry_index)
447 fib_forward_chain_type_t fct;
448 fib_entry_t *fib_entry;
450 fib_entry = fib_entry_get(fib_entry_index);
451 fct = fib_entry_get_default_chain_type(fib_entry);
453 ASSERT((fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP4 ||
454 fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP6));
456 return (&fib_entry->fe_lb);
460 fib_entry_get_adj (fib_node_index_t fib_entry_index)
464 dpo = fib_entry_contribute_ip_forwarding(fib_entry_index);
465 dpo = load_balance_get_bucket(dpo->dpoi_index, 0);
469 return (dpo->dpoi_index);
471 return (ADJ_INDEX_INVALID);
475 fib_entry_get_path_list (fib_node_index_t fib_entry_index)
477 fib_entry_t *fib_entry;
479 fib_entry = fib_entry_get(fib_entry_index);
481 return (fib_entry->fe_parent);
485 fib_entry_child_add (fib_node_index_t fib_entry_index,
486 fib_node_type_t child_type,
487 fib_node_index_t child_index)
489 return (fib_node_child_add(FIB_NODE_TYPE_ENTRY,
496 fib_entry_child_remove (fib_node_index_t fib_entry_index,
499 fib_node_child_remove(FIB_NODE_TYPE_ENTRY,
503 if (0 == fib_node_get_n_children(FIB_NODE_TYPE_ENTRY,
507 * if there are no children left then there is no reason to keep
508 * the non-default forwarding chains. those chains are built only
509 * because the children want them.
511 fib_entry_delegate_type_t fdt;
512 fib_entry_delegate_t *fed;
513 fib_entry_t *fib_entry;
515 fib_entry = fib_entry_get(fib_entry_index);
517 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
519 dpo_reset(&fed->fd_dpo);
520 fib_entry_delegate_remove(fib_entry, fdt);
526 fib_entry_alloc (u32 fib_index,
527 const fib_prefix_t *prefix,
528 fib_node_index_t *fib_entry_index)
530 fib_entry_t *fib_entry;
533 pool_get(fib_entry_pool, fib_entry);
534 memset(fib_entry, 0, sizeof(*fib_entry));
536 fib_node_init(&fib_entry->fe_node,
537 FIB_NODE_TYPE_ENTRY);
539 fib_entry->fe_fib_index = fib_index;
542 * the one time we need to update the const prefix is when
543 * the entry is first created
545 fep = (fib_prefix_t*)&(fib_entry->fe_prefix);
548 if (FIB_PROTOCOL_MPLS == fib_entry->fe_prefix.fp_proto)
551 if (MPLS_NON_EOS == fep->fp_eos)
553 fep->fp_payload_proto = DPO_PROTO_MPLS;
555 ASSERT(DPO_PROTO_NONE != fib_entry->fe_prefix.fp_payload_proto);
558 dpo_reset(&fib_entry->fe_lb);
560 *fib_entry_index = fib_entry_get_index(fib_entry);
562 FIB_ENTRY_DBG(fib_entry, "alloc");
568 fib_entry_post_flag_update_actions (fib_entry_t *fib_entry,
570 fib_entry_flag_t old_flags)
572 fib_node_index_t fei;
575 * save the index so we can recover from pool reallocs
577 fei = fib_entry_get_index(fib_entry);
580 * handle changes to attached export for import entries
582 int is_import = (FIB_ENTRY_FLAG_IMPORT & fib_entry_get_flags_i(fib_entry));
583 int was_import = (FIB_ENTRY_FLAG_IMPORT & old_flags);
585 if (!was_import && is_import)
588 * transition from not exported to exported
592 * there is an assumption here that the entry resolves via only
593 * one interface and that it is the cross VRF interface.
595 u32 sw_if_index = fib_path_list_get_resolving_interface(fib_entry->fe_parent);
597 fib_attached_export_import(fib_entry,
598 fib_table_get_index_for_sw_if_index(
599 fib_entry_get_proto(fib_entry),
602 else if (was_import && !is_import)
605 * transition from exported to not exported
607 fib_attached_export_purge(fib_entry);
611 * no change. nothing to do.
615 * reload the entry address post possible pool realloc
617 fib_entry = fib_entry_get(fei);
620 * handle changes to attached export for export entries
622 int is_attached = (FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags_i(fib_entry));
623 int was_attached = (FIB_ENTRY_FLAG_ATTACHED & old_flags);
625 if (!was_attached && is_attached)
628 * transition to attached. time to export
638 fib_entry_post_install_actions (fib_entry_t *fib_entry,
640 fib_entry_flag_t old_flags)
642 fib_entry = fib_entry_post_flag_update_actions(fib_entry,
645 fib_entry_src_action_installed(fib_entry, source);
649 fib_entry_create (u32 fib_index,
650 const fib_prefix_t *prefix,
652 fib_entry_flag_t flags,
653 const fib_route_path_t *paths)
655 fib_node_index_t fib_entry_index;
656 fib_entry_t *fib_entry;
658 ASSERT(0 < vec_len(paths));
660 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
663 * since this is a new entry create, we don't need to check for winning
664 * sources - there is only one.
666 fib_entry = fib_entry_src_action_add(fib_entry, source, flags,
669 fib_entry_get_proto(fib_entry))));
670 fib_entry_src_action_path_swap(fib_entry,
675 * handle possible realloc's by refetching the pointer
677 fib_entry = fib_entry_get(fib_entry_index);
678 fib_entry_src_action_activate(fib_entry, source);
680 fib_entry_post_install_actions(fib_entry, source, FIB_ENTRY_FLAG_NONE);
682 return (fib_entry_index);
686 fib_entry_create_special (u32 fib_index,
687 const fib_prefix_t *prefix,
689 fib_entry_flag_t flags,
692 fib_node_index_t fib_entry_index;
693 fib_entry_t *fib_entry;
696 * create and initiliase the new enty
698 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
701 * create the path-list
703 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
704 fib_entry_src_action_activate(fib_entry, source);
706 fib_entry_post_install_actions(fib_entry, source, FIB_ENTRY_FLAG_NONE);
708 return (fib_entry_index);
712 fib_entry_post_update_actions (fib_entry_t *fib_entry,
714 fib_entry_flag_t old_flags)
717 * backwalk to children to inform then of the change to forwarding.
719 fib_node_back_walk_ctx_t bw_ctx = {
720 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
723 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_get_index(fib_entry), &bw_ctx);
726 * then inform any covered prefixes
728 fib_entry_cover_update_notify(fib_entry);
730 fib_entry_post_install_actions(fib_entry, source, old_flags);
734 fib_entry_source_change (fib_entry_t *fib_entry,
735 fib_source_t best_source,
736 fib_source_t new_source,
737 fib_entry_flag_t old_flags)
740 * if the path list for the source passed is invalid,
741 * then we need to create a new one. else we are updating
744 if (new_source < best_source)
747 * we have a new winning source.
749 fib_entry_src_action_deactivate(fib_entry, best_source);
750 fib_entry_src_action_activate(fib_entry, new_source);
752 else if (new_source > best_source)
755 * the new source loses. nothing to do here.
756 * the data from the source is saved in the path-list created
763 * the new source is one this entry already has.
764 * But the path-list was updated, which will contribute new forwarding,
767 fib_entry_src_action_deactivate(fib_entry, new_source);
768 fib_entry_src_action_activate(fib_entry, new_source);
771 fib_entry_post_update_actions(fib_entry, new_source, old_flags);
775 fib_entry_special_add (fib_node_index_t fib_entry_index,
777 fib_entry_flag_t flags,
780 fib_source_t best_source;
781 fib_entry_flag_t bflags;
782 fib_entry_t *fib_entry;
783 fib_entry_src_t *bsrc;
785 fib_entry = fib_entry_get(fib_entry_index);
787 bsrc = fib_entry_get_best_src_i(fib_entry);
788 best_source = fib_entry_src_get_source(bsrc);
789 bflags = fib_entry_src_get_flags(bsrc);
791 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
792 fib_entry_source_change(fib_entry, best_source, source, bflags);
796 fib_entry_special_update (fib_node_index_t fib_entry_index,
798 fib_entry_flag_t flags,
801 fib_source_t best_source;
802 fib_entry_flag_t bflags;
803 fib_entry_t *fib_entry;
804 fib_entry_src_t *bsrc;
806 fib_entry = fib_entry_get(fib_entry_index);
808 bsrc = fib_entry_get_best_src_i(fib_entry);
809 best_source = fib_entry_src_get_source(bsrc);
810 bflags = fib_entry_src_get_flags(bsrc);
812 fib_entry = fib_entry_src_action_update(fib_entry, source, flags, dpo);
813 fib_entry_source_change(fib_entry, best_source, source, bflags);
818 fib_entry_path_add (fib_node_index_t fib_entry_index,
820 fib_entry_flag_t flags,
821 const fib_route_path_t *rpath)
823 fib_source_t best_source;
824 fib_entry_flag_t bflags;
825 fib_entry_t *fib_entry;
826 fib_entry_src_t *bsrc;
828 ASSERT(1 == vec_len(rpath));
830 fib_entry = fib_entry_get(fib_entry_index);
831 ASSERT(NULL != fib_entry);
833 bsrc = fib_entry_get_best_src_i(fib_entry);
834 best_source = fib_entry_src_get_source(bsrc);
835 bflags = fib_entry_src_get_flags(bsrc);
837 fib_entry = fib_entry_src_action_path_add(fib_entry, source, flags, rpath);
840 * if the path list for the source passed is invalid,
841 * then we need to create a new one. else we are updating
844 if (source < best_source)
847 * we have a new winning source.
849 fib_entry_src_action_deactivate(fib_entry, best_source);
850 fib_entry_src_action_activate(fib_entry, source);
852 else if (source > best_source)
855 * the new source loses. nothing to do here.
856 * the data from the source is saved in the path-list created
863 * the new source is one this entry already has.
864 * But the path-list was updated, which will contribute new forwarding,
867 fib_entry_src_action_deactivate(fib_entry, source);
868 fib_entry_src_action_activate(fib_entry, source);
871 fib_entry_post_update_actions(fib_entry, source, bflags);
875 * fib_entry_path_remove
877 * remove a path from the entry.
878 * return the fib_entry's index if it is still present, INVALID otherwise.
881 fib_entry_path_remove (fib_node_index_t fib_entry_index,
883 const fib_route_path_t *rpath)
885 fib_entry_src_flag_t sflag;
886 fib_source_t best_source;
887 fib_entry_flag_t bflags;
888 fib_entry_t *fib_entry;
889 fib_entry_src_t *bsrc;
891 ASSERT(1 == vec_len(rpath));
893 fib_entry = fib_entry_get(fib_entry_index);
894 ASSERT(NULL != fib_entry);
896 bsrc = fib_entry_get_best_src_i(fib_entry);
897 best_source = fib_entry_src_get_source(bsrc);
898 bflags = fib_entry_src_get_flags(bsrc);
900 sflag = fib_entry_src_action_path_remove(fib_entry, source, rpath);
903 * if the path list for the source passed is invalid,
904 * then we need to create a new one. else we are updating
907 if (source < best_source )
910 * Que! removing a path from a source that is better than the
911 * one this entry is using.
915 else if (source > best_source )
918 * the source is not the best. nothing to do.
920 return (FIB_ENTRY_SRC_FLAG_ADDED);
925 * removing a path from the path-list we were using.
927 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
930 * the last path from the source was removed.
931 * fallback to lower source
933 bsrc = fib_entry_get_best_src_i(fib_entry);
934 best_source = fib_entry_src_get_source(bsrc);
936 if (FIB_SOURCE_MAX == best_source) {
938 * no more sources left. this entry is toast.
940 fib_entry = fib_entry_post_flag_update_actions(fib_entry,
943 fib_entry_src_action_uninstall(fib_entry);
945 return (FIB_ENTRY_SRC_FLAG_NONE);
949 fib_entry_src_action_activate(fib_entry, best_source);
950 source = best_source;
956 * re-install the new forwarding information
958 fib_entry_src_action_deactivate(fib_entry, source);
959 fib_entry_src_action_activate(fib_entry, source);
963 fib_entry_post_update_actions(fib_entry, source, bflags);
968 return (FIB_ENTRY_SRC_FLAG_ADDED);
972 * fib_entry_special_remove
974 * remove a special source from the entry.
975 * return the fib_entry's index if it is still present, INVALID otherwise.
978 fib_entry_special_remove (fib_node_index_t fib_entry_index,
981 fib_entry_src_flag_t sflag;
982 fib_source_t best_source;
983 fib_entry_flag_t bflags;
984 fib_entry_t *fib_entry;
985 fib_entry_src_t *bsrc;
987 fib_entry = fib_entry_get(fib_entry_index);
988 ASSERT(NULL != fib_entry);
990 bsrc = fib_entry_get_best_src_i(fib_entry);
991 best_source = fib_entry_src_get_source(bsrc);
992 bflags = fib_entry_src_get_flags(bsrc);
994 sflag = fib_entry_src_action_remove(fib_entry, source);
997 * if the path list for the source passed is invalid,
998 * then we need to create a new one. else we are updating
1001 if (source < best_source )
1004 * Que! removing a path from a source that is better than the
1005 * one this entry is using. This can only mean it is a source
1006 * this prefix does not have.
1008 return (FIB_ENTRY_SRC_FLAG_ADDED);
1010 else if (source > best_source ) {
1012 * the source is not the best. nothing to do.
1014 return (FIB_ENTRY_SRC_FLAG_ADDED);
1018 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
1021 * the source was removed. use the next best.
1023 bsrc = fib_entry_get_best_src_i(fib_entry);
1024 best_source = fib_entry_src_get_source(bsrc);
1026 if (FIB_SOURCE_MAX == best_source) {
1028 * no more sources left. this entry is toast.
1030 fib_entry = fib_entry_post_flag_update_actions(fib_entry,
1033 fib_entry_src_action_uninstall(fib_entry);
1035 return (FIB_ENTRY_SRC_FLAG_NONE);
1039 fib_entry_src_action_activate(fib_entry, best_source);
1040 source = best_source;
1046 * re-install the new forwarding information
1048 fib_entry_src_action_reactivate(fib_entry, source);
1052 fib_entry_post_update_actions(fib_entry, source, bflags);
1055 * still have sources
1057 return (FIB_ENTRY_SRC_FLAG_ADDED);
1063 * The source is withdrawing all the paths it provided
1065 fib_entry_src_flag_t
1066 fib_entry_delete (fib_node_index_t fib_entry_index,
1067 fib_source_t source)
1069 return (fib_entry_special_remove(fib_entry_index, source));
1075 * The source has provided a new set of paths that will replace the old.
1078 fib_entry_update (fib_node_index_t fib_entry_index,
1079 fib_source_t source,
1080 fib_entry_flag_t flags,
1081 const fib_route_path_t *paths)
1083 fib_source_t best_source;
1084 fib_entry_flag_t bflags;
1085 fib_entry_t *fib_entry;
1086 fib_entry_src_t *bsrc;
1088 fib_entry = fib_entry_get(fib_entry_index);
1089 ASSERT(NULL != fib_entry);
1091 bsrc = fib_entry_get_best_src_i(fib_entry);
1092 best_source = fib_entry_src_get_source(bsrc);
1093 bflags = fib_entry_src_get_flags(bsrc);
1095 fib_entry_src_action_path_swap(fib_entry,
1100 * handle possible realloc's by refetching the pointer
1102 fib_entry = fib_entry_get(fib_entry_index);
1105 * if the path list for the source passed is invalid,
1106 * then we need to create a new one. else we are updating
1109 if (source < best_source)
1112 * we have a new winning source.
1114 fib_entry_src_action_deactivate(fib_entry, best_source);
1115 fib_entry_src_action_activate(fib_entry, source);
1117 else if (source > best_source) {
1119 * the new source loses. nothing to do here.
1120 * the data from the source is saved in the path-list created
1127 * the new source is one this entry already has.
1128 * But the path-list was updated, which will contribute new forwarding,
1131 fib_entry_src_action_deactivate(fib_entry, source);
1132 fib_entry_src_action_activate(fib_entry, source);
1135 fib_entry_post_update_actions(fib_entry, source, bflags);
1140 * fib_entry_cover_changed
1142 * this entry is tracking its cover and that cover has changed.
1145 fib_entry_cover_changed (fib_node_index_t fib_entry_index)
1147 fib_entry_src_cover_res_t res = {
1149 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1151 fib_source_t source, best_source;
1152 fib_entry_flag_t bflags;
1153 fib_entry_t *fib_entry;
1154 fib_entry_src_t *esrc;
1157 bflags = FIB_ENTRY_FLAG_NONE;
1158 best_source = FIB_SOURCE_FIRST;
1159 fib_entry = fib_entry_get(fib_entry_index);
1161 fib_attached_export_cover_change(fib_entry);
1164 * propagate the notificuation to each of the added sources
1167 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1172 * only the best source gets to set the back walk flags
1174 res = fib_entry_src_action_cover_change(fib_entry, source);
1175 bflags = fib_entry_src_get_flags(esrc);
1176 best_source = fib_entry_src_get_source(esrc);
1180 fib_entry_src_action_cover_change(fib_entry, source);
1187 fib_entry_src_action_reactivate(fib_entry,
1188 fib_entry_src_get_source(
1189 fib_entry_get_best_src_i(fib_entry)));
1190 fib_entry_post_install_actions(fib_entry, best_source, bflags);
1194 fib_entry_src_action_uninstall(fib_entry);
1197 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1200 * time for walkies fido.
1202 fib_node_back_walk_ctx_t bw_ctx = {
1203 .fnbw_reason = res.bw_reason,
1206 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1211 * fib_entry_cover_updated
1213 * this entry is tracking its cover and that cover has been updated
1214 * (i.e. its forwarding information has changed).
1217 fib_entry_cover_updated (fib_node_index_t fib_entry_index)
1219 fib_entry_src_cover_res_t res = {
1221 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1223 fib_source_t source, best_source;
1224 fib_entry_flag_t bflags;
1225 fib_entry_t *fib_entry;
1226 fib_entry_src_t *esrc;
1229 bflags = FIB_ENTRY_FLAG_NONE;
1230 best_source = FIB_SOURCE_FIRST;
1231 fib_entry = fib_entry_get(fib_entry_index);
1233 fib_attached_export_cover_update(fib_entry);
1236 * propagate the notificuation to each of the added sources
1239 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1244 * only the best source gets to set the back walk flags
1246 res = fib_entry_src_action_cover_update(fib_entry, source);
1247 bflags = fib_entry_src_get_flags(esrc);
1248 best_source = fib_entry_src_get_source(esrc);
1252 fib_entry_src_action_cover_update(fib_entry, source);
1259 fib_entry_src_action_reactivate(fib_entry,
1260 fib_entry_src_get_source(
1261 fib_entry_get_best_src_i(fib_entry)));
1262 fib_entry_post_install_actions(fib_entry, best_source, bflags);
1266 fib_entry_src_action_uninstall(fib_entry);
1269 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1272 * time for walkies fido.
1274 fib_node_back_walk_ctx_t bw_ctx = {
1275 .fnbw_reason = res.bw_reason,
1278 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1283 fib_entry_recursive_loop_detect (fib_node_index_t entry_index,
1284 fib_node_index_t **entry_indicies)
1286 fib_entry_t *fib_entry;
1287 int was_looped, is_looped;
1289 fib_entry = fib_entry_get(entry_index);
1291 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1293 fib_node_index_t *entries = *entry_indicies;
1295 vec_add1(entries, entry_index);
1296 was_looped = fib_path_list_is_looped(fib_entry->fe_parent);
1297 is_looped = fib_path_list_recursive_loop_detect(fib_entry->fe_parent,
1300 *entry_indicies = entries;
1302 if (!!was_looped != !!is_looped)
1305 * re-evaluate all the entry's forwarding
1306 * NOTE: this is an inplace modify
1308 fib_entry_delegate_type_t fdt;
1309 fib_entry_delegate_t *fed;
1311 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
1313 fib_entry_src_mk_lb(fib_entry,
1314 fib_entry_get_best_src_i(fib_entry),
1315 fib_entry_delegate_type_to_chain_type(fdt),
1323 * the entry is currently not linked to a path-list. this happens
1324 * when it is this entry that is re-linking path-lists and has thus
1334 fib_entry_get_resolving_interface (fib_node_index_t entry_index)
1336 fib_entry_t *fib_entry;
1338 fib_entry = fib_entry_get(entry_index);
1340 return (fib_path_list_get_resolving_interface(fib_entry->fe_parent));
1344 fib_entry_get_best_source (fib_node_index_t entry_index)
1346 fib_entry_t *fib_entry;
1347 fib_entry_src_t *bsrc;
1349 fib_entry = fib_entry_get(entry_index);
1351 bsrc = fib_entry_get_best_src_i(fib_entry);
1352 return (fib_entry_src_get_source(bsrc));
1356 * Return !0 is the entry is reoslved, i.e. will return a valid forwarding
1360 fib_entry_is_resolved (fib_node_index_t fib_entry_index)
1362 fib_entry_delegate_t *fed;
1363 fib_entry_t *fib_entry;
1365 fib_entry = fib_entry_get(fib_entry_index);
1367 fed = fib_entry_delegate_get(fib_entry, FIB_ENTRY_DELEGATE_BFD);
1372 * no BFD tracking - resolved
1379 * defer to the state of the BFD tracking
1381 return (FIB_BFD_STATE_UP == fed->fd_bfd_state);
1386 fib_entry_set_flow_hash_config (fib_node_index_t fib_entry_index,
1387 flow_hash_config_t hash_config)
1389 fib_entry_t *fib_entry;
1391 fib_entry = fib_entry_get(fib_entry_index);
1394 * pass the hash-config on to the load-balance object where it is cached.
1395 * we can ignore LBs in the delegate chains, since they will not be of the
1396 * correct protocol type (i.e. they are not IP)
1397 * There's no way, nor need, to change the hash config for MPLS.
1399 if (dpo_id_is_valid(&fib_entry->fe_lb))
1403 ASSERT(DPO_LOAD_BALANCE == fib_entry->fe_lb.dpoi_type);
1405 lb = load_balance_get(fib_entry->fe_lb.dpoi_index);
1408 * atomic update for packets in flight
1410 lb->lb_hash_config = hash_config;
1415 fib_ip4_address_compare (const ip4_address_t * a1,
1416 const ip4_address_t * a2)
1419 * IP addresses are unsiged ints. the return value here needs to be signed
1420 * a simple subtraction won't cut it.
1421 * If the addresses are the same, the sort order is undefiend, so phoey.
1423 return ((clib_net_to_host_u32(a1->data_u32) >
1424 clib_net_to_host_u32(a2->data_u32) ) ?
1429 fib_ip6_address_compare (const ip6_address_t * a1,
1430 const ip6_address_t * a2)
1433 for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1435 int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1436 clib_net_to_host_u16 (a2->as_u16[i]));
1444 fib_entry_cmp (fib_node_index_t fib_entry_index1,
1445 fib_node_index_t fib_entry_index2)
1447 fib_entry_t *fib_entry1, *fib_entry2;
1450 fib_entry1 = fib_entry_get(fib_entry_index1);
1451 fib_entry2 = fib_entry_get(fib_entry_index2);
1453 switch (fib_entry1->fe_prefix.fp_proto)
1455 case FIB_PROTOCOL_IP4:
1456 cmp = fib_ip4_address_compare(&fib_entry1->fe_prefix.fp_addr.ip4,
1457 &fib_entry2->fe_prefix.fp_addr.ip4);
1459 case FIB_PROTOCOL_IP6:
1460 cmp = fib_ip6_address_compare(&fib_entry1->fe_prefix.fp_addr.ip6,
1461 &fib_entry2->fe_prefix.fp_addr.ip6);
1463 case FIB_PROTOCOL_MPLS:
1464 cmp = (fib_entry1->fe_prefix.fp_label - fib_entry2->fe_prefix.fp_label);
1468 cmp = (fib_entry1->fe_prefix.fp_eos - fib_entry2->fe_prefix.fp_eos);
1474 cmp = (fib_entry1->fe_prefix.fp_len - fib_entry2->fe_prefix.fp_len);
1480 fib_entry_cmp_for_sort (void *i1, void *i2)
1482 fib_node_index_t *fib_entry_index1 = i1, *fib_entry_index2 = i2;
1484 return (fib_entry_cmp(*fib_entry_index1,
1485 *fib_entry_index2));
1489 fib_entry_lock (fib_node_index_t fib_entry_index)
1491 fib_entry_t *fib_entry;
1493 fib_entry = fib_entry_get(fib_entry_index);
1495 fib_node_lock(&fib_entry->fe_node);
1499 fib_entry_unlock (fib_node_index_t fib_entry_index)
1501 fib_entry_t *fib_entry;
1503 fib_entry = fib_entry_get(fib_entry_index);
1505 fib_node_unlock(&fib_entry->fe_node);
1509 fib_entry_module_init (void)
1511 fib_node_register_type (FIB_NODE_TYPE_ENTRY, &fib_entry_vft);
1515 fib_entry_encode (fib_node_index_t fib_entry_index,
1516 fib_route_path_encode_t **api_rpaths)
1518 fib_entry_t *fib_entry;
1520 fib_entry = fib_entry_get(fib_entry_index);
1521 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1523 fib_path_list_walk(fib_entry->fe_parent, fib_path_encode, api_rpaths);
1528 fib_entry_get_prefix (fib_node_index_t fib_entry_index,
1531 fib_entry_t *fib_entry;
1533 fib_entry = fib_entry_get(fib_entry_index);
1534 *pfx = fib_entry->fe_prefix;
1538 fib_entry_get_fib_index (fib_node_index_t fib_entry_index)
1540 fib_entry_t *fib_entry;
1542 fib_entry = fib_entry_get(fib_entry_index);
1544 return (fib_entry->fe_fib_index);
1548 fib_entry_pool_size (void)
1550 return (pool_elts(fib_entry_pool));
1553 static clib_error_t *
1554 show_fib_entry_command (vlib_main_t * vm,
1555 unformat_input_t * input,
1556 vlib_cli_command_t * cmd)
1558 fib_node_index_t fei;
1560 if (unformat (input, "%d", &fei))
1563 * show one in detail
1565 if (!pool_is_free_index(fib_entry_pool, fei))
1567 vlib_cli_output (vm, "%d@%U",
1569 format_fib_entry, fei,
1570 FIB_ENTRY_FORMAT_DETAIL2);
1574 vlib_cli_output (vm, "entry %d invalid", fei);
1582 vlib_cli_output (vm, "FIB Entries:");
1583 pool_foreach_index(fei, fib_entry_pool,
1585 vlib_cli_output (vm, "%d@%U",
1587 format_fib_entry, fei,
1588 FIB_ENTRY_FORMAT_BRIEF);
1595 VLIB_CLI_COMMAND (show_fib_entry, static) = {
1596 .path = "show fib entry",
1597 .function = show_fib_entry_command,
1598 .short_help = "show fib entry",