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>
31 #include <vnet/fib/fib_entry_delegate.h>
32 #include <vnet/fib/fib_entry_track.h>
35 * Array of strings/names for the FIB sources
37 static const char *fib_attribute_names[] = FIB_ENTRY_ATTRIBUTES;
38 static const char *fib_src_attribute_names[] = FIB_ENTRY_SRC_ATTRIBUTES;
41 * Pool for all fib_entries
43 static fib_entry_t *fib_entry_pool;
48 vlib_log_class_t fib_entry_logger;
51 fib_entry_get (fib_node_index_t index)
53 return (pool_elt_at_index(fib_entry_pool, index));
57 fib_entry_get_node (fib_node_index_t index)
59 return ((fib_node_t*)fib_entry_get(index));
63 fib_entry_get_index (const fib_entry_t * fib_entry)
65 return (fib_entry - fib_entry_pool);
69 fib_entry_get_proto (const fib_entry_t * fib_entry)
71 return (fib_entry->fe_prefix.fp_proto);
75 fib_entry_get_dpo_proto (const fib_entry_t * fib_entry)
77 return (fib_proto_to_dpo(fib_entry->fe_prefix.fp_proto));
80 fib_forward_chain_type_t
81 fib_entry_get_default_chain_type (const fib_entry_t *fib_entry)
83 switch (fib_entry->fe_prefix.fp_proto)
85 case FIB_PROTOCOL_IP4:
86 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
87 case FIB_PROTOCOL_IP6:
88 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP6);
89 case FIB_PROTOCOL_MPLS:
90 if (MPLS_EOS == fib_entry->fe_prefix.fp_eos)
91 return (FIB_FORW_CHAIN_TYPE_MPLS_EOS);
93 return (FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS);
96 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
100 format_fib_entry_flags (u8 *s, va_list *args)
102 fib_entry_attribute_t attr;
103 fib_entry_flag_t flag = va_arg(*args, int);
105 FOR_EACH_FIB_ATTRIBUTE(attr) {
106 if ((1<<attr) & flag) {
107 s = format (s, "%s,", fib_attribute_names[attr]);
115 format_fib_entry_src_flags (u8 *s, va_list *args)
117 fib_entry_src_attribute_t sattr;
118 fib_entry_src_flag_t flag = va_arg(*args, int);
120 FOR_EACH_FIB_SRC_ATTRIBUTE(sattr) {
121 if ((1<<sattr) & flag) {
122 s = format (s, "%s,", fib_src_attribute_names[sattr]);
130 format_fib_entry (u8 * s, va_list * args)
132 fib_forward_chain_type_t fct;
133 fib_entry_t *fib_entry;
134 fib_entry_src_t *src;
135 fib_node_index_t fei;
139 fei = va_arg (*args, fib_node_index_t);
140 level = va_arg (*args, int);
141 fib_entry = fib_entry_get(fei);
143 s = format (s, "%U", format_fib_prefix, &fib_entry->fe_prefix);
145 if (level >= FIB_ENTRY_FORMAT_DETAIL)
147 s = format (s, " fib:%d", fib_entry->fe_fib_index);
148 s = format (s, " index:%d", fib_entry_get_index(fib_entry));
149 s = format (s, " locks:%d", fib_entry->fe_node.fn_locks);
151 FOR_EACH_SRC_ADDED(fib_entry, src, source,
153 s = format (s, "\n %U", format_fib_source, source);
154 s = format (s, " refs:%d", src->fes_ref_count);
155 if (FIB_ENTRY_FLAG_NONE != src->fes_entry_flags) {
156 s = format(s, " entry-flags:%U",
157 format_fib_entry_flags, src->fes_entry_flags);
159 if (FIB_ENTRY_SRC_FLAG_NONE != src->fes_flags) {
160 s = format(s, " src-flags:%U",
161 format_fib_entry_src_flags, src->fes_flags);
163 s = fib_entry_src_format(fib_entry, source, s);
164 s = format (s, "\n");
165 if (FIB_NODE_INDEX_INVALID != src->fes_pl)
167 s = fib_path_list_format(src->fes_pl, s);
169 s = format(s, "%U", format_fib_path_ext_list, &src->fes_path_exts);
172 s = format (s, "\n forwarding: ");
176 s = format (s, "\n");
179 fct = fib_entry_get_default_chain_type(fib_entry);
181 if (!dpo_id_is_valid(&fib_entry->fe_lb))
183 s = format (s, " UNRESOLVED\n");
188 s = format(s, " %U-chain\n %U",
189 format_fib_forw_chain_type, fct,
195 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
199 s = format (s, " Delegates:\n");
200 vec_foreach(fedi, fib_entry->fe_delegates)
202 s = format(s, " %U\n", format_fib_entry_delegate, *fedi);
207 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
209 s = format(s, " Children:");
210 s = fib_node_children_format(fib_entry->fe_node.fn_children, s);
217 fib_entry_from_fib_node (fib_node_t *node)
219 ASSERT(FIB_NODE_TYPE_ENTRY == node->fn_type);
220 return ((fib_entry_t*)node);
224 fib_entry_last_lock_gone (fib_node_t *node)
226 fib_entry_delegate_type_t fdt;
227 fib_entry_delegate_t *fed;
228 fib_entry_t *fib_entry;
230 fib_entry = fib_entry_from_fib_node(node);
232 ASSERT(!dpo_id_is_valid(&fib_entry->fe_lb));
234 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
236 dpo_reset(&fed->fd_dpo);
237 fib_entry_delegate_remove(fib_entry, fdt);
240 FIB_ENTRY_DBG(fib_entry, "last-lock");
242 fib_node_deinit(&fib_entry->fe_node);
244 ASSERT(0 == vec_len(fib_entry->fe_delegates));
245 vec_free(fib_entry->fe_delegates);
246 vec_free(fib_entry->fe_srcs);
247 pool_put(fib_entry_pool, fib_entry);
250 static fib_entry_src_t*
251 fib_entry_get_best_src_i (const fib_entry_t *fib_entry)
253 fib_entry_src_t *bsrc;
256 * the enum of sources is deliberately arranged in priority order
258 if (0 == vec_len(fib_entry->fe_srcs))
264 bsrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
271 fib_entry_src_get_source (const fib_entry_src_t *esrc)
275 return (esrc->fes_src);
277 return (FIB_SOURCE_INVALID);
280 static fib_entry_flag_t
281 fib_entry_src_get_flags (const fib_entry_src_t *esrc)
285 return (esrc->fes_entry_flags);
287 return (FIB_ENTRY_FLAG_NONE);
291 fib_entry_get_flags (fib_node_index_t fib_entry_index)
293 return (fib_entry_get_flags_i(fib_entry_get(fib_entry_index)));
297 * fib_entry_back_walk_notify
299 * A back walk has reach this entry.
301 static fib_node_back_walk_rc_t
302 fib_entry_back_walk_notify (fib_node_t *node,
303 fib_node_back_walk_ctx_t *ctx)
305 fib_entry_t *fib_entry;
307 fib_entry = fib_entry_from_fib_node(node);
309 if (FIB_NODE_BW_REASON_FLAG_EVALUATE & ctx->fnbw_reason ||
310 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE & ctx->fnbw_reason ||
311 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN & ctx->fnbw_reason ||
312 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP & ctx->fnbw_reason ||
313 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN & ctx->fnbw_reason ||
314 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE & ctx->fnbw_reason)
316 fib_entry_src_action_reactivate(fib_entry,
317 fib_entry_get_best_source(
318 fib_entry_get_index(fib_entry)));
322 * all other walk types can be reclassifed to a re-evaluate to
323 * all recursive dependents.
324 * By reclassifying we ensure that should any of these walk types meet
325 * they can be merged.
327 ctx->fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE;
330 * ... and nothing is forced sync from now on.
332 ctx->fnbw_flags &= ~FIB_NODE_BW_FLAG_FORCE_SYNC;
334 FIB_ENTRY_DBG(fib_entry, "bw:%U",
335 format_fib_node_bw_reason, ctx->fnbw_reason);
338 * propagate the backwalk further if we haven't already reached the
341 fib_walk_sync(FIB_NODE_TYPE_ENTRY,
342 fib_entry_get_index(fib_entry),
345 return (FIB_NODE_BACK_WALK_CONTINUE);
349 fib_entry_show_memory (void)
351 u32 n_srcs = 0, n_exts = 0;
352 fib_entry_src_t *esrc;
355 fib_show_memory_usage("Entry",
356 pool_elts(fib_entry_pool),
357 pool_len(fib_entry_pool),
358 sizeof(fib_entry_t));
360 pool_foreach(entry, fib_entry_pool,
362 n_srcs += vec_len(entry->fe_srcs);
363 vec_foreach(esrc, entry->fe_srcs)
365 n_exts += fib_path_ext_list_length(&esrc->fes_path_exts);
369 fib_show_memory_usage("Entry Source",
370 n_srcs, n_srcs, sizeof(fib_entry_src_t));
371 fib_show_memory_usage("Entry Path-Extensions",
373 sizeof(fib_path_ext_t));
377 * The FIB path-list's graph node virtual function table
379 static const fib_node_vft_t fib_entry_vft = {
380 .fnv_get = fib_entry_get_node,
381 .fnv_last_lock = fib_entry_last_lock_gone,
382 .fnv_back_walk = fib_entry_back_walk_notify,
383 .fnv_mem_show = fib_entry_show_memory,
387 * @brief Contribute the set of Adjacencies that this entry forwards with
388 * to build the uRPF list of its children
391 fib_entry_contribute_urpf (fib_node_index_t entry_index,
394 fib_entry_t *fib_entry;
396 fib_entry = fib_entry_get(entry_index);
398 return (fib_path_list_contribute_urpf(fib_entry->fe_parent, urpf));
402 * If the client is request a chain for multicast forwarding then swap
403 * the chain type to one that can provide such transport.
405 static fib_forward_chain_type_t
406 fib_entry_chain_type_mcast_to_ucast (fib_forward_chain_type_t fct)
410 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
411 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
413 * we can only transport IP multicast packets if there is an
416 fct = FIB_FORW_CHAIN_TYPE_MPLS_EOS;
418 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
419 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
420 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
421 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
422 case FIB_FORW_CHAIN_TYPE_ETHERNET:
423 case FIB_FORW_CHAIN_TYPE_NSH:
424 case FIB_FORW_CHAIN_TYPE_BIER:
432 * fib_entry_contribute_forwarding
434 * Get an lock the forwarding information (DPO) contributed by the FIB entry.
437 fib_entry_contribute_forwarding (fib_node_index_t fib_entry_index,
438 fib_forward_chain_type_t fct,
441 fib_entry_delegate_t *fed;
442 fib_entry_t *fib_entry;
444 fib_entry = fib_entry_get(fib_entry_index);
447 * mfib children ask for mcast chains. fix these to the appropriate ucast types.
449 fct = fib_entry_chain_type_mcast_to_ucast(fct);
451 if (fct == fib_entry_get_default_chain_type(fib_entry))
453 dpo_copy(dpo, &fib_entry->fe_lb);
457 fed = fib_entry_delegate_find(fib_entry,
458 fib_entry_chain_type_to_delegate_type(fct));
463 * use a temporary DPO lest the delegate realloc in the recursive
466 dpo_id_t tmp = DPO_INVALID;
469 * on-demand create eos/non-eos.
470 * There is no on-demand delete because:
471 * - memory versus complexity & reliability:
472 * leaving unrequired [n]eos LB arounds wastes memory, cleaning
473 * then up on the right trigger is more code. i favour the latter.
475 fib_entry_src_mk_lb(fib_entry,
476 fib_entry_get_best_src_i(fib_entry),
480 fed = fib_entry_delegate_find_or_add(
482 fib_entry_chain_type_to_delegate_type(fct));
484 dpo_copy(&fed->fd_dpo, &tmp);
488 dpo_copy(dpo, &fed->fd_dpo);
491 * use the drop DPO is nothing else is present
493 if (!dpo_id_is_valid(dpo))
495 dpo_copy(dpo, drop_dpo_get(fib_forw_chain_type_to_dpo_proto(fct)));
499 * don't allow the special index indicating replicate.vs.load-balance
500 * to escape to the clients
502 dpo->dpoi_index &= ~MPLS_IS_REPLICATE;
506 fib_entry_contribute_ip_forwarding (fib_node_index_t fib_entry_index)
508 fib_forward_chain_type_t fct;
509 fib_entry_t *fib_entry;
511 fib_entry = fib_entry_get(fib_entry_index);
512 fct = fib_entry_get_default_chain_type(fib_entry);
514 ASSERT((fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP4 ||
515 fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP6));
517 if (dpo_id_is_valid(&fib_entry->fe_lb))
519 return (&fib_entry->fe_lb);
522 return (drop_dpo_get(fib_forw_chain_type_to_dpo_proto(fct)));
526 fib_entry_get_adj (fib_node_index_t fib_entry_index)
530 dpo = fib_entry_contribute_ip_forwarding(fib_entry_index);
532 if (dpo_id_is_valid(dpo))
534 dpo = load_balance_get_bucket(dpo->dpoi_index, 0);
538 return (dpo->dpoi_index);
541 return (ADJ_INDEX_INVALID);
545 fib_entry_get_path_list (fib_node_index_t fib_entry_index)
547 fib_entry_t *fib_entry;
549 fib_entry = fib_entry_get(fib_entry_index);
551 return (fib_entry->fe_parent);
555 fib_entry_child_add (fib_node_index_t fib_entry_index,
556 fib_node_type_t child_type,
557 fib_node_index_t child_index)
559 return (fib_node_child_add(FIB_NODE_TYPE_ENTRY,
566 fib_entry_child_remove (fib_node_index_t fib_entry_index,
569 fib_node_child_remove(FIB_NODE_TYPE_ENTRY,
573 if (0 == fib_node_get_n_children(FIB_NODE_TYPE_ENTRY,
577 * if there are no children left then there is no reason to keep
578 * the non-default forwarding chains. those chains are built only
579 * because the children want them.
581 fib_entry_delegate_type_t fdt;
582 fib_entry_delegate_t *fed;
583 fib_entry_t *fib_entry;
585 fib_entry = fib_entry_get(fib_entry_index);
587 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
589 dpo_reset(&fed->fd_dpo);
590 fib_entry_delegate_remove(fib_entry, fdt);
596 fib_entry_alloc (u32 fib_index,
597 const fib_prefix_t *prefix,
598 fib_node_index_t *fib_entry_index)
600 fib_entry_t *fib_entry;
603 pool_get(fib_entry_pool, fib_entry);
604 clib_memset(fib_entry, 0, sizeof(*fib_entry));
606 fib_node_init(&fib_entry->fe_node,
607 FIB_NODE_TYPE_ENTRY);
609 fib_entry->fe_fib_index = fib_index;
612 * the one time we need to update the const prefix is when
613 * the entry is first created
615 fep = (fib_prefix_t*)&(fib_entry->fe_prefix);
618 if (FIB_PROTOCOL_MPLS == fib_entry->fe_prefix.fp_proto)
621 if (MPLS_NON_EOS == fep->fp_eos)
623 fep->fp_payload_proto = DPO_PROTO_MPLS;
625 ASSERT(DPO_PROTO_NONE != fib_entry->fe_prefix.fp_payload_proto);
628 dpo_reset(&fib_entry->fe_lb);
630 *fib_entry_index = fib_entry_get_index(fib_entry);
636 fib_entry_post_flag_update_actions (fib_entry_t *fib_entry,
637 fib_entry_flag_t old_flags)
639 fib_node_index_t fei;
642 * save the index so we can recover from pool reallocs
644 fei = fib_entry_get_index(fib_entry);
647 * handle changes to attached export for import entries
649 int is_import = (FIB_ENTRY_FLAG_IMPORT & fib_entry_get_flags_i(fib_entry));
650 int was_import = (FIB_ENTRY_FLAG_IMPORT & old_flags);
652 if (!was_import && is_import)
655 * transition from not exported to exported
659 * there is an assumption here that the entry resolves via only
660 * one interface and that it is the cross VRF interface.
662 u32 sw_if_index = fib_path_list_get_resolving_interface(fib_entry->fe_parent);
664 fib_attached_export_import(fib_entry,
665 fib_table_get_index_for_sw_if_index(
666 fib_entry_get_proto(fib_entry),
669 else if (was_import && !is_import)
672 * transition from exported to not exported
674 fib_attached_export_purge(fib_entry);
678 * no change. nothing to do.
682 * reload the entry address post possible pool realloc
684 fib_entry = fib_entry_get(fei);
687 * handle changes to attached export for export entries
689 int is_attached = (FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags_i(fib_entry));
690 int was_attached = (FIB_ENTRY_FLAG_ATTACHED & old_flags);
692 if (!was_attached && is_attached)
695 * transition to attached. time to export
705 fib_entry_post_install_actions (fib_entry_t *fib_entry,
707 fib_entry_flag_t old_flags)
709 fib_entry = fib_entry_post_flag_update_actions(fib_entry,
711 fib_entry = fib_entry_src_action_installed(fib_entry, source);
717 fib_entry_create (u32 fib_index,
718 const fib_prefix_t *prefix,
720 fib_entry_flag_t flags,
721 const fib_route_path_t *paths)
723 fib_node_index_t fib_entry_index;
724 fib_entry_t *fib_entry;
726 ASSERT(0 < vec_len(paths));
728 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
731 * since this is a new entry create, we don't need to check for winning
732 * sources - there is only one.
734 fib_entry = fib_entry_src_action_add(fib_entry, source, flags,
737 fib_entry_get_proto(fib_entry))));
738 fib_entry_src_action_path_swap(fib_entry,
743 * handle possible realloc's by refetching the pointer
745 fib_entry = fib_entry_get(fib_entry_index);
746 fib_entry_src_action_activate(fib_entry, source);
748 fib_entry = fib_entry_post_install_actions(fib_entry, source,
749 FIB_ENTRY_FLAG_NONE);
751 FIB_ENTRY_DBG(fib_entry, "create");
753 return (fib_entry_index);
757 fib_entry_create_special (u32 fib_index,
758 const fib_prefix_t *prefix,
760 fib_entry_flag_t flags,
763 fib_node_index_t fib_entry_index;
764 fib_entry_t *fib_entry;
767 * create and initialize the new enty
769 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
772 * create the path-list
774 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
775 fib_entry_src_action_activate(fib_entry, source);
777 fib_entry = fib_entry_post_install_actions(fib_entry, source,
778 FIB_ENTRY_FLAG_NONE);
780 FIB_ENTRY_DBG(fib_entry, "create-special");
782 return (fib_entry_index);
786 fib_entry_post_update_actions (fib_entry_t *fib_entry,
788 fib_entry_flag_t old_flags)
791 * backwalk to children to inform then of the change to forwarding.
793 fib_node_back_walk_ctx_t bw_ctx = {
794 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
797 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_get_index(fib_entry), &bw_ctx);
800 * then inform any covered prefixes
802 fib_entry_cover_update_notify(fib_entry);
804 fib_entry_post_install_actions(fib_entry, source, old_flags);
808 fib_entry_recalculate_forwarding (fib_node_index_t fib_entry_index)
810 fib_source_t best_source;
811 fib_entry_t *fib_entry;
812 fib_entry_src_t *bsrc;
814 fib_entry = fib_entry_get(fib_entry_index);
816 bsrc = fib_entry_get_best_src_i(fib_entry);
817 best_source = fib_entry_src_get_source(bsrc);
819 fib_entry_src_action_reactivate(fib_entry, best_source);
823 fib_entry_source_change_w_flags (fib_entry_t *fib_entry,
824 fib_source_t old_source,
825 fib_entry_flag_t old_flags,
826 fib_source_t new_source)
828 switch (fib_source_cmp(new_source, old_source))
830 case FIB_SOURCE_CMP_BETTER:
832 * we have a new winning source.
834 fib_entry_src_action_deactivate(fib_entry, old_source);
835 fib_entry_src_action_activate(fib_entry, new_source);
838 case FIB_SOURCE_CMP_WORSE:
840 * the new source loses. Re-activate the winning sources
841 * in case it is an interposer and hence relied on the losing
842 * source's path-list.
844 fib_entry_src_action_reactivate(fib_entry, old_source);
847 case FIB_SOURCE_CMP_EQUAL:
849 * the new source is one this entry already has.
850 * But the path-list was updated, which will contribute new forwarding,
853 fib_entry_src_action_reactivate(fib_entry, new_source);
857 fib_entry_post_update_actions(fib_entry, new_source, old_flags);
861 fib_entry_source_change (fib_entry_t *fib_entry,
862 fib_source_t old_source,
863 fib_source_t new_source)
865 fib_entry_flag_t old_flags;
867 old_flags = fib_entry_get_flags_for_source(
868 fib_entry_get_index(fib_entry), old_source);
870 return (fib_entry_source_change_w_flags(fib_entry, old_source,
871 old_flags, new_source));
875 fib_entry_special_add (fib_node_index_t fib_entry_index,
877 fib_entry_flag_t flags,
880 fib_source_t best_source;
881 fib_entry_t *fib_entry;
883 fib_entry = fib_entry_get(fib_entry_index);
884 best_source = fib_entry_get_best_source(fib_entry_index);
886 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
887 fib_entry_source_change(fib_entry, best_source, source);
888 FIB_ENTRY_DBG(fib_entry, "special-add:%U", format_fib_source, source);
892 fib_entry_special_update (fib_node_index_t fib_entry_index,
894 fib_entry_flag_t flags,
897 fib_source_t best_source;
898 fib_entry_t *fib_entry;
900 fib_entry = fib_entry_get(fib_entry_index);
901 best_source = fib_entry_get_best_source(fib_entry_index);
903 fib_entry = fib_entry_src_action_update(fib_entry, source, flags, dpo);
904 fib_entry_source_change(fib_entry, best_source, source);
906 FIB_ENTRY_DBG(fib_entry, "special-updated:%U", format_fib_source, source);
911 fib_entry_path_add (fib_node_index_t fib_entry_index,
913 fib_entry_flag_t flags,
914 const fib_route_path_t *rpaths)
916 fib_source_t best_source;
917 fib_entry_t *fib_entry;
918 fib_entry_src_t *bsrc;
920 fib_entry = fib_entry_get(fib_entry_index);
921 ASSERT(NULL != fib_entry);
923 bsrc = fib_entry_get_best_src_i(fib_entry);
924 best_source = fib_entry_src_get_source(bsrc);
926 fib_entry = fib_entry_src_action_path_add(fib_entry, source, flags, rpaths);
928 fib_entry_source_change(fib_entry, best_source, source);
930 FIB_ENTRY_DBG(fib_entry, "path add:%U", format_fib_source, source);
933 static fib_entry_src_flag_t
934 fib_entry_src_burn_only_inherited (fib_entry_t *fib_entry)
936 fib_entry_src_t *src;
938 int has_only_inherited_sources = 1;
940 FOR_EACH_SRC_ADDED(fib_entry, src, source,
942 if (!(src->fes_flags & FIB_ENTRY_SRC_FLAG_INHERITED))
944 has_only_inherited_sources = 0;
948 if (has_only_inherited_sources)
950 FOR_EACH_SRC_ADDED(fib_entry, src, source,
952 fib_entry_src_action_remove(fib_entry, source);
954 return (FIB_ENTRY_SRC_FLAG_NONE);
958 return (FIB_ENTRY_SRC_FLAG_ADDED);
962 static fib_entry_src_flag_t
963 fib_entry_source_removed (fib_entry_t *fib_entry,
964 fib_entry_flag_t old_flags)
966 const fib_entry_src_t *bsrc;
967 fib_source_t best_source;
970 * if all that is left are inherited sources, then burn them
972 fib_entry_src_burn_only_inherited(fib_entry);
974 bsrc = fib_entry_get_best_src_i(fib_entry);
975 best_source = fib_entry_src_get_source(bsrc);
977 if (FIB_SOURCE_INVALID == best_source)
980 * no more sources left. this entry is toast.
982 fib_entry = fib_entry_post_flag_update_actions(fib_entry, old_flags);
983 fib_entry_src_action_uninstall(fib_entry);
985 return (FIB_ENTRY_SRC_FLAG_NONE);
989 fib_entry_src_action_activate(fib_entry, best_source);
992 fib_entry_post_update_actions(fib_entry, best_source, old_flags);
997 return (FIB_ENTRY_SRC_FLAG_ADDED);
1001 * fib_entry_path_remove
1003 * remove a path from the entry.
1004 * return the fib_entry's index if it is still present, INVALID otherwise.
1006 fib_entry_src_flag_t
1007 fib_entry_path_remove (fib_node_index_t fib_entry_index,
1008 fib_source_t source,
1009 const fib_route_path_t *rpaths)
1011 fib_entry_src_flag_t sflag;
1012 fib_source_t best_source;
1013 fib_entry_flag_t bflags;
1014 fib_entry_t *fib_entry;
1015 fib_entry_src_t *bsrc;
1017 fib_entry = fib_entry_get(fib_entry_index);
1018 ASSERT(NULL != fib_entry);
1020 bsrc = fib_entry_get_best_src_i(fib_entry);
1021 best_source = fib_entry_src_get_source(bsrc);
1022 bflags = fib_entry_src_get_flags(bsrc);
1024 sflag = fib_entry_src_action_path_remove(fib_entry, source, rpaths);
1026 FIB_ENTRY_DBG(fib_entry, "path remove:%U", format_fib_source, source);
1029 * if the path list for the source passed is invalid,
1030 * then we need to create a new one. else we are updating
1033 switch (fib_source_cmp(source, best_source))
1035 case FIB_SOURCE_CMP_BETTER:
1037 * Que! removing a path from a source that is better than the
1038 * one this entry is using.
1042 case FIB_SOURCE_CMP_WORSE:
1044 * the source is not the best. no need to update forwarding
1046 if (FIB_ENTRY_SRC_FLAG_ADDED & sflag)
1049 * the source being removed still has paths
1051 return (FIB_ENTRY_SRC_FLAG_ADDED);
1056 * that was the last path from this source, check if those
1057 * that remain are non-inherited
1059 return (fib_entry_src_burn_only_inherited(fib_entry));
1062 case FIB_SOURCE_CMP_EQUAL:
1064 * removing a path from the path-list we were using.
1066 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
1069 * the last path from the source was removed.
1070 * fallback to lower source
1072 return (fib_entry_source_removed(fib_entry, bflags));
1077 * re-install the new forwarding information
1079 fib_entry_src_action_reactivate(fib_entry, source);
1084 fib_entry_post_update_actions(fib_entry, source, bflags);
1087 * still have sources
1089 return (FIB_ENTRY_SRC_FLAG_ADDED);
1093 * fib_entry_special_remove
1095 * remove a special source from the entry.
1096 * return the fib_entry's index if it is still present, INVALID otherwise.
1098 fib_entry_src_flag_t
1099 fib_entry_special_remove (fib_node_index_t fib_entry_index,
1100 fib_source_t source)
1102 fib_entry_src_flag_t sflag;
1103 fib_source_t best_source;
1104 fib_entry_flag_t bflags;
1105 fib_entry_t *fib_entry;
1106 fib_entry_src_t *bsrc;
1108 fib_entry = fib_entry_get(fib_entry_index);
1109 ASSERT(NULL != fib_entry);
1111 bsrc = fib_entry_get_best_src_i(fib_entry);
1112 best_source = fib_entry_src_get_source(bsrc);
1113 bflags = fib_entry_src_get_flags(bsrc);
1115 FIB_ENTRY_DBG(fib_entry, "special remove:%U", format_fib_source, source);
1117 sflag = fib_entry_src_action_remove_or_update_inherit(fib_entry, source);
1120 * if the path list for the source passed is invalid,
1121 * then we need to create a new one. else we are updating
1124 switch (fib_source_cmp(source, best_source))
1126 case FIB_SOURCE_CMP_BETTER:
1128 * Que! removing a path from a source that is better than the
1129 * one this entry is using. This can only mean it is a source
1130 * this prefix does not have.
1132 return (FIB_ENTRY_SRC_FLAG_ADDED);
1134 case FIB_SOURCE_CMP_WORSE:
1136 * the source is not the best. no need to update forwarding
1138 if (FIB_ENTRY_SRC_FLAG_ADDED & sflag)
1141 * the source being removed still has paths
1143 return (FIB_ENTRY_SRC_FLAG_ADDED);
1148 * that was the last path from this source, check if those
1149 * that remain are non-inherited
1151 if (FIB_ENTRY_SRC_FLAG_NONE == fib_entry_src_burn_only_inherited(fib_entry))
1154 * no more sources left. this entry is toast.
1156 fib_entry = fib_entry_post_flag_update_actions(fib_entry, bflags);
1157 fib_entry_src_action_uninstall(fib_entry);
1158 return (FIB_ENTRY_SRC_FLAG_NONE);
1162 * reactivate the best source so the interposer gets restacked
1164 fib_entry_src_action_reactivate(fib_entry, best_source);
1166 return (FIB_ENTRY_SRC_FLAG_ADDED);
1170 case FIB_SOURCE_CMP_EQUAL:
1171 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
1174 * the source was removed. use the next best.
1176 return (fib_entry_source_removed(fib_entry, bflags));
1181 * re-install the new forwarding information
1183 fib_entry_src_action_reactivate(fib_entry, source);
1188 fib_entry_post_update_actions(fib_entry, source, bflags);
1191 * still have sources
1193 return (FIB_ENTRY_SRC_FLAG_ADDED);
1199 * If the source on the cover is inheriting then push this source
1200 * down to the covered.
1203 fib_entry_inherit (fib_node_index_t cover,
1204 fib_node_index_t covered)
1206 fib_entry_src_inherit(fib_entry_get(cover),
1207 fib_entry_get(covered));
1213 * The source is withdrawing all the paths it provided
1215 fib_entry_src_flag_t
1216 fib_entry_delete (fib_node_index_t fib_entry_index,
1217 fib_source_t source)
1219 return (fib_entry_special_remove(fib_entry_index, source));
1225 * The source has provided a new set of paths that will replace the old.
1228 fib_entry_update (fib_node_index_t fib_entry_index,
1229 fib_source_t source,
1230 fib_entry_flag_t flags,
1231 const fib_route_path_t *paths)
1233 fib_source_t best_source;
1234 fib_entry_flag_t bflags;
1235 fib_entry_t *fib_entry;
1236 fib_entry_src_t *bsrc;
1238 fib_entry = fib_entry_get(fib_entry_index);
1239 ASSERT(NULL != fib_entry);
1241 bsrc = fib_entry_get_best_src_i(fib_entry);
1242 best_source = fib_entry_src_get_source(bsrc);
1243 bflags = fib_entry_get_flags_i(fib_entry);
1245 fib_entry = fib_entry_src_action_path_swap(fib_entry,
1250 fib_entry_source_change_w_flags(fib_entry, best_source, bflags, source);
1251 FIB_ENTRY_DBG(fib_entry, "update");
1256 * fib_entry_cover_changed
1258 * this entry is tracking its cover and that cover has changed.
1261 fib_entry_cover_changed (fib_node_index_t fib_entry_index)
1263 fib_entry_src_cover_res_t res = {
1265 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1267 CLIB_UNUSED(fib_source_t source);
1268 fib_source_t best_source;
1269 fib_entry_flag_t bflags;
1270 fib_entry_t *fib_entry;
1271 fib_entry_src_t *esrc;
1274 bflags = FIB_ENTRY_FLAG_NONE;
1275 best_source = FIB_SOURCE_FIRST;
1276 fib_entry = fib_entry_get(fib_entry_index);
1278 fib_attached_export_cover_change(fib_entry);
1281 * propagate the notification to each of the added sources
1284 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1289 * only the best source gets to set the back walk flags
1291 res = fib_entry_src_action_cover_change(fib_entry, esrc);
1292 bflags = fib_entry_src_get_flags(esrc);
1293 best_source = fib_entry_src_get_source(esrc);
1297 fib_entry_src_action_cover_change(fib_entry, esrc);
1304 fib_entry_src_action_reactivate(fib_entry,
1305 fib_entry_src_get_source(
1306 fib_entry_get_best_src_i(fib_entry)));
1307 fib_entry = fib_entry_post_install_actions(fib_entry,
1313 fib_entry_src_action_uninstall(fib_entry);
1316 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1319 * time for walkies fido.
1321 fib_node_back_walk_ctx_t bw_ctx = {
1322 .fnbw_reason = res.bw_reason,
1325 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1327 FIB_ENTRY_DBG(fib_entry, "cover-changed");
1331 * fib_entry_cover_updated
1333 * this entry is tracking its cover and that cover has been updated
1334 * (i.e. its forwarding information has changed).
1337 fib_entry_cover_updated (fib_node_index_t fib_entry_index)
1339 fib_entry_src_cover_res_t res = {
1341 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1343 CLIB_UNUSED(fib_source_t source);
1344 fib_source_t best_source;
1345 fib_entry_flag_t bflags;
1346 fib_entry_t *fib_entry;
1347 fib_entry_src_t *esrc;
1350 bflags = FIB_ENTRY_FLAG_NONE;
1351 best_source = FIB_SOURCE_FIRST;
1352 fib_entry = fib_entry_get(fib_entry_index);
1354 fib_attached_export_cover_update(fib_entry);
1357 * propagate the notification to each of the added sources
1360 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1365 * only the best source gets to set the back walk flags
1367 res = fib_entry_src_action_cover_update(fib_entry, esrc);
1368 bflags = fib_entry_src_get_flags(esrc);
1369 best_source = fib_entry_src_get_source(esrc);
1373 fib_entry_src_action_cover_update(fib_entry, esrc);
1380 fib_entry_src_action_reactivate(fib_entry,
1381 fib_entry_src_get_source(
1382 fib_entry_get_best_src_i(fib_entry)));
1383 fib_entry = fib_entry_post_install_actions(fib_entry,
1389 fib_entry_src_action_uninstall(fib_entry);
1392 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1395 * time for walkies fido.
1397 fib_node_back_walk_ctx_t bw_ctx = {
1398 .fnbw_reason = res.bw_reason,
1401 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1403 FIB_ENTRY_DBG(fib_entry, "cover-updated");
1407 fib_entry_recursive_loop_detect (fib_node_index_t entry_index,
1408 fib_node_index_t **entry_indicies)
1410 fib_entry_t *fib_entry;
1411 int was_looped, is_looped;
1413 fib_entry = fib_entry_get(entry_index);
1415 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1417 fib_node_index_t *entries = *entry_indicies;
1419 vec_add1(entries, entry_index);
1420 was_looped = fib_path_list_is_looped(fib_entry->fe_parent);
1421 is_looped = fib_path_list_recursive_loop_detect(fib_entry->fe_parent,
1424 *entry_indicies = entries;
1426 if (!!was_looped != !!is_looped)
1429 * re-evaluate all the entry's forwarding
1430 * NOTE: this is an inplace modify
1432 fib_entry_delegate_type_t fdt;
1433 fib_entry_delegate_t *fed;
1435 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
1437 fib_entry_src_mk_lb(fib_entry,
1438 fib_entry_get_best_src_i(fib_entry),
1439 fib_entry_delegate_type_to_chain_type(fdt),
1447 * the entry is currently not linked to a path-list. this happens
1448 * when it is this entry that is re-linking path-lists and has thus
1458 fib_entry_get_resolving_interface (fib_node_index_t entry_index)
1460 fib_entry_t *fib_entry;
1462 fib_entry = fib_entry_get(entry_index);
1464 return (fib_path_list_get_resolving_interface(fib_entry->fe_parent));
1468 fib_entry_get_any_resolving_interface (fib_node_index_t entry_index)
1470 const fib_entry_src_t *src;
1471 fib_entry_t *fib_entry;
1472 fib_source_t source;
1475 fib_entry = fib_entry_get(entry_index);
1477 FOR_EACH_SRC_ADDED(fib_entry, src, source,
1479 sw_if_index = fib_entry_get_resolving_interface_for_source (entry_index,
1482 if (~0 != sw_if_index)
1485 return (sw_if_index);
1489 fib_entry_get_best_source (fib_node_index_t entry_index)
1491 fib_entry_t *fib_entry;
1492 fib_entry_src_t *bsrc;
1494 fib_entry = fib_entry_get(entry_index);
1496 bsrc = fib_entry_get_best_src_i(fib_entry);
1497 return (fib_entry_src_get_source(bsrc));
1501 * Return !0 is the entry represents a host prefix
1504 fib_entry_is_host (fib_node_index_t fib_entry_index)
1506 return (fib_prefix_is_host(fib_entry_get_prefix(fib_entry_index)));
1510 * Return !0 is the entry is resolved, i.e. will return a valid forwarding
1514 fib_entry_is_resolved (fib_node_index_t fib_entry_index)
1516 fib_entry_delegate_t *fed;
1517 fib_entry_t *fib_entry;
1519 fib_entry = fib_entry_get(fib_entry_index);
1521 fed = fib_entry_delegate_find(fib_entry, FIB_ENTRY_DELEGATE_BFD);
1526 * no BFD tracking - consider it resolved.
1533 * defer to the state of the BFD tracking
1535 return (FIB_BFD_STATE_UP == fed->fd_bfd_state);
1540 fib_entry_set_flow_hash_config (fib_node_index_t fib_entry_index,
1541 flow_hash_config_t hash_config)
1543 fib_entry_t *fib_entry;
1545 fib_entry = fib_entry_get(fib_entry_index);
1548 * pass the hash-config on to the load-balance object where it is cached.
1549 * we can ignore LBs in the delegate chains, since they will not be of the
1550 * correct protocol type (i.e. they are not IP)
1551 * There's no way, nor need, to change the hash config for MPLS.
1553 if (dpo_id_is_valid(&fib_entry->fe_lb))
1557 ASSERT(DPO_LOAD_BALANCE == fib_entry->fe_lb.dpoi_type);
1559 lb = load_balance_get(fib_entry->fe_lb.dpoi_index);
1562 * atomic update for packets in flight
1564 lb->lb_hash_config = hash_config;
1569 fib_entry_get_stats_index (fib_node_index_t fib_entry_index)
1571 fib_entry_t *fib_entry;
1573 fib_entry = fib_entry_get(fib_entry_index);
1575 return (fib_entry->fe_lb.dpoi_index);
1579 fib_ip4_address_compare (const ip4_address_t * a1,
1580 const ip4_address_t * a2)
1583 * IP addresses are unsigned ints. the return value here needs to be signed
1584 * a simple subtraction won't cut it.
1585 * If the addresses are the same, the sort order is undefined, so phoey.
1587 return ((clib_net_to_host_u32(a1->data_u32) >
1588 clib_net_to_host_u32(a2->data_u32) ) ?
1593 fib_ip6_address_compare (const ip6_address_t * a1,
1594 const ip6_address_t * a2)
1597 for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1599 int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1600 clib_net_to_host_u16 (a2->as_u16[i]));
1608 fib_entry_cmp (fib_node_index_t fib_entry_index1,
1609 fib_node_index_t fib_entry_index2)
1611 fib_entry_t *fib_entry1, *fib_entry2;
1614 fib_entry1 = fib_entry_get(fib_entry_index1);
1615 fib_entry2 = fib_entry_get(fib_entry_index2);
1617 switch (fib_entry1->fe_prefix.fp_proto)
1619 case FIB_PROTOCOL_IP4:
1620 cmp = fib_ip4_address_compare(&fib_entry1->fe_prefix.fp_addr.ip4,
1621 &fib_entry2->fe_prefix.fp_addr.ip4);
1623 case FIB_PROTOCOL_IP6:
1624 cmp = fib_ip6_address_compare(&fib_entry1->fe_prefix.fp_addr.ip6,
1625 &fib_entry2->fe_prefix.fp_addr.ip6);
1627 case FIB_PROTOCOL_MPLS:
1628 cmp = (fib_entry1->fe_prefix.fp_label - fib_entry2->fe_prefix.fp_label);
1632 cmp = (fib_entry1->fe_prefix.fp_eos - fib_entry2->fe_prefix.fp_eos);
1638 cmp = (fib_entry1->fe_prefix.fp_len - fib_entry2->fe_prefix.fp_len);
1644 fib_entry_cmp_for_sort (void *i1, void *i2)
1646 fib_node_index_t *fib_entry_index1 = i1, *fib_entry_index2 = i2;
1648 return (fib_entry_cmp(*fib_entry_index1,
1649 *fib_entry_index2));
1653 fib_entry_lock (fib_node_index_t fib_entry_index)
1655 fib_entry_t *fib_entry;
1657 fib_entry = fib_entry_get(fib_entry_index);
1659 fib_node_lock(&fib_entry->fe_node);
1663 fib_entry_unlock (fib_node_index_t fib_entry_index)
1665 fib_entry_t *fib_entry;
1667 fib_entry = fib_entry_get(fib_entry_index);
1669 fib_node_unlock(&fib_entry->fe_node);
1673 fib_entry_module_init (void)
1675 fib_node_register_type(FIB_NODE_TYPE_ENTRY, &fib_entry_vft);
1676 fib_entry_logger = vlib_log_register_class("fib", "entry");
1678 fib_entry_track_module_init();
1682 fib_entry_encode (fib_node_index_t fib_entry_index)
1684 fib_path_ext_list_t *ext_list;
1685 fib_path_encode_ctx_t ctx = {
1688 fib_entry_t *fib_entry;
1689 fib_entry_src_t *bsrc;
1692 fib_entry = fib_entry_get(fib_entry_index);
1693 bsrc = fib_entry_get_best_src_i(fib_entry);
1697 ext_list = &bsrc->fes_path_exts;
1700 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1702 fib_path_list_walk_w_ext(fib_entry->fe_parent,
1708 return (ctx.rpaths);
1711 const fib_prefix_t *
1712 fib_entry_get_prefix (fib_node_index_t fib_entry_index)
1714 fib_entry_t *fib_entry;
1716 fib_entry = fib_entry_get(fib_entry_index);
1718 return (&fib_entry->fe_prefix);
1722 fib_entry_get_fib_index (fib_node_index_t fib_entry_index)
1724 fib_entry_t *fib_entry;
1726 fib_entry = fib_entry_get(fib_entry_index);
1728 return (fib_entry->fe_fib_index);
1732 fib_entry_pool_size (void)
1734 return (pool_elts(fib_entry_pool));
1739 fib_table_assert_empty (const fib_table_t *fib_table)
1741 fib_node_index_t *fei, *feis = NULL;
1742 fib_entry_t *fib_entry;
1744 pool_foreach (fib_entry, fib_entry_pool,
1746 if (fib_entry->fe_fib_index == fib_table->ft_index)
1747 vec_add1 (feis, fib_entry_get_index(fib_entry));
1752 vec_foreach (fei, feis)
1753 clib_error ("%U", format_fib_entry, *fei, FIB_ENTRY_FORMAT_DETAIL);
1760 static clib_error_t *
1761 show_fib_entry_command (vlib_main_t * vm,
1762 unformat_input_t * input,
1763 vlib_cli_command_t * cmd)
1765 fib_node_index_t fei;
1767 if (unformat (input, "%d", &fei))
1770 * show one in detail
1772 if (!pool_is_free_index(fib_entry_pool, fei))
1774 vlib_cli_output (vm, "%d@%U",
1776 format_fib_entry, fei,
1777 FIB_ENTRY_FORMAT_DETAIL2);
1781 vlib_cli_output (vm, "entry %d invalid", fei);
1789 vlib_cli_output (vm, "FIB Entries:");
1790 pool_foreach_index(fei, fib_entry_pool,
1792 vlib_cli_output (vm, "%d@%U",
1794 format_fib_entry, fei,
1795 FIB_ENTRY_FORMAT_BRIEF);
1802 VLIB_CLI_COMMAND (show_fib_entry, static) = {
1803 .path = "show fib entry",
1804 .function = show_fib_entry_command,
1805 .short_help = "show fib entry",