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_source_names[] = FIB_SOURCES;
38 static const char *fib_attribute_names[] = FIB_ENTRY_ATTRIBUTES;
39 static const char *fib_src_attribute_names[] = FIB_ENTRY_SRC_ATTRIBUTES;
42 * Pool for all fib_entries
44 static fib_entry_t *fib_entry_pool;
49 vlib_log_class_t fib_entry_logger;
52 fib_entry_get (fib_node_index_t index)
54 return (pool_elt_at_index(fib_entry_pool, index));
58 fib_entry_get_node (fib_node_index_t index)
60 return ((fib_node_t*)fib_entry_get(index));
64 fib_entry_get_index (const fib_entry_t * fib_entry)
66 return (fib_entry - fib_entry_pool);
70 fib_entry_get_proto (const fib_entry_t * fib_entry)
72 return (fib_entry->fe_prefix.fp_proto);
76 fib_entry_get_dpo_proto (const fib_entry_t * fib_entry)
78 return (fib_proto_to_dpo(fib_entry->fe_prefix.fp_proto));
81 fib_forward_chain_type_t
82 fib_entry_get_default_chain_type (const fib_entry_t *fib_entry)
84 switch (fib_entry->fe_prefix.fp_proto)
86 case FIB_PROTOCOL_IP4:
87 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
88 case FIB_PROTOCOL_IP6:
89 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP6);
90 case FIB_PROTOCOL_MPLS:
91 if (MPLS_EOS == fib_entry->fe_prefix.fp_eos)
92 return (FIB_FORW_CHAIN_TYPE_MPLS_EOS);
94 return (FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS);
97 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
101 format_fib_source (u8 * s, va_list * args)
103 fib_source_t source = va_arg (*args, int);
105 s = format (s, "src:%s", fib_source_names[source]);
111 format_fib_entry_flags (u8 *s, va_list *args)
113 fib_entry_attribute_t attr;
114 fib_entry_flag_t flag = va_arg(*args, int);
116 FOR_EACH_FIB_ATTRIBUTE(attr) {
117 if ((1<<attr) & flag) {
118 s = format (s, "%s,", fib_attribute_names[attr]);
126 format_fib_entry_src_flags (u8 *s, va_list *args)
128 fib_entry_src_attribute_t sattr;
129 fib_entry_src_flag_t flag = va_arg(*args, int);
131 FOR_EACH_FIB_SRC_ATTRIBUTE(sattr) {
132 if ((1<<sattr) & flag) {
133 s = format (s, "%s,", fib_src_attribute_names[sattr]);
141 format_fib_entry (u8 * s, va_list * args)
143 fib_forward_chain_type_t fct;
144 fib_entry_t *fib_entry;
145 fib_entry_src_t *src;
146 fib_node_index_t fei;
150 fei = va_arg (*args, fib_node_index_t);
151 level = va_arg (*args, int);
152 fib_entry = fib_entry_get(fei);
154 s = format (s, "%U", format_fib_prefix, &fib_entry->fe_prefix);
156 if (level >= FIB_ENTRY_FORMAT_DETAIL)
158 s = format (s, " fib:%d", fib_entry->fe_fib_index);
159 s = format (s, " index:%d", fib_entry_get_index(fib_entry));
160 s = format (s, " locks:%d", fib_entry->fe_node.fn_locks);
162 FOR_EACH_SRC_ADDED(fib_entry, src, source,
164 s = format (s, "\n %U", format_fib_source, source);
165 s = format (s, " refs:%d", src->fes_ref_count);
166 if (FIB_ENTRY_FLAG_NONE != src->fes_entry_flags) {
167 s = format(s, " entry-flags:%U",
168 format_fib_entry_flags, src->fes_entry_flags);
170 if (FIB_ENTRY_SRC_FLAG_NONE != src->fes_flags) {
171 s = format(s, " src-flags:%U",
172 format_fib_entry_src_flags, src->fes_flags);
174 s = fib_entry_src_format(fib_entry, source, s);
175 s = format (s, "\n");
176 if (FIB_NODE_INDEX_INVALID != src->fes_pl)
178 s = fib_path_list_format(src->fes_pl, s);
180 s = format(s, "%U", format_fib_path_ext_list, &src->fes_path_exts);
183 s = format (s, "\n forwarding: ");
187 s = format (s, "\n");
190 fct = fib_entry_get_default_chain_type(fib_entry);
192 if (!dpo_id_is_valid(&fib_entry->fe_lb))
194 s = format (s, " UNRESOLVED\n");
199 s = format(s, " %U-chain\n %U",
200 format_fib_forw_chain_type, fct,
206 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
210 s = format (s, " Delegates:\n");
211 vec_foreach(fedi, fib_entry->fe_delegates)
213 s = format(s, " %U\n", format_fib_entry_delegate, *fedi);
218 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
220 s = format(s, " Children:");
221 s = fib_node_children_format(fib_entry->fe_node.fn_children, s);
228 fib_entry_from_fib_node (fib_node_t *node)
230 ASSERT(FIB_NODE_TYPE_ENTRY == node->fn_type);
231 return ((fib_entry_t*)node);
235 fib_entry_last_lock_gone (fib_node_t *node)
237 fib_entry_delegate_type_t fdt;
238 fib_entry_delegate_t *fed;
239 fib_entry_t *fib_entry;
241 fib_entry = fib_entry_from_fib_node(node);
243 ASSERT(!dpo_id_is_valid(&fib_entry->fe_lb));
245 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
247 dpo_reset(&fed->fd_dpo);
248 fib_entry_delegate_remove(fib_entry, fdt);
251 FIB_ENTRY_DBG(fib_entry, "last-lock");
253 fib_node_deinit(&fib_entry->fe_node);
255 ASSERT(0 == vec_len(fib_entry->fe_delegates));
256 vec_free(fib_entry->fe_delegates);
257 vec_free(fib_entry->fe_srcs);
258 pool_put(fib_entry_pool, fib_entry);
261 static fib_entry_src_t*
262 fib_entry_get_best_src_i (const fib_entry_t *fib_entry)
264 fib_entry_src_t *bsrc;
267 * the enum of sources is deliberately arranged in priority order
269 if (0 == vec_len(fib_entry->fe_srcs))
275 bsrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
282 fib_entry_src_get_source (const fib_entry_src_t *esrc)
286 return (esrc->fes_src);
288 return (FIB_SOURCE_MAX);
291 static fib_entry_flag_t
292 fib_entry_src_get_flags (const fib_entry_src_t *esrc)
296 return (esrc->fes_entry_flags);
298 return (FIB_ENTRY_FLAG_NONE);
302 fib_entry_get_flags (fib_node_index_t fib_entry_index)
304 return (fib_entry_get_flags_i(fib_entry_get(fib_entry_index)));
308 * fib_entry_back_walk_notify
310 * A back walk has reach this entry.
312 static fib_node_back_walk_rc_t
313 fib_entry_back_walk_notify (fib_node_t *node,
314 fib_node_back_walk_ctx_t *ctx)
316 fib_entry_t *fib_entry;
318 fib_entry = fib_entry_from_fib_node(node);
320 if (FIB_NODE_BW_REASON_FLAG_EVALUATE & ctx->fnbw_reason ||
321 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE & ctx->fnbw_reason ||
322 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN & ctx->fnbw_reason ||
323 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP & ctx->fnbw_reason ||
324 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN & ctx->fnbw_reason ||
325 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE & ctx->fnbw_reason)
327 fib_entry_src_action_reactivate(fib_entry,
328 fib_entry_get_best_source(
329 fib_entry_get_index(fib_entry)));
333 * all other walk types can be reclassifed to a re-evaluate to
334 * all recursive dependents.
335 * By reclassifying we ensure that should any of these walk types meet
336 * they can be merged.
338 ctx->fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE;
341 * ... and nothing is forced sync from now on.
343 ctx->fnbw_flags &= ~FIB_NODE_BW_FLAG_FORCE_SYNC;
345 FIB_ENTRY_DBG(fib_entry, "bw:%U",
346 format_fib_node_bw_reason, ctx->fnbw_reason);
349 * propagate the backwalk further if we haven't already reached the
352 fib_walk_sync(FIB_NODE_TYPE_ENTRY,
353 fib_entry_get_index(fib_entry),
356 return (FIB_NODE_BACK_WALK_CONTINUE);
360 fib_entry_show_memory (void)
362 u32 n_srcs = 0, n_exts = 0;
363 fib_entry_src_t *esrc;
366 fib_show_memory_usage("Entry",
367 pool_elts(fib_entry_pool),
368 pool_len(fib_entry_pool),
369 sizeof(fib_entry_t));
371 pool_foreach(entry, fib_entry_pool,
373 n_srcs += vec_len(entry->fe_srcs);
374 vec_foreach(esrc, entry->fe_srcs)
376 n_exts += fib_path_ext_list_length(&esrc->fes_path_exts);
380 fib_show_memory_usage("Entry Source",
381 n_srcs, n_srcs, sizeof(fib_entry_src_t));
382 fib_show_memory_usage("Entry Path-Extensions",
384 sizeof(fib_path_ext_t));
388 * The FIB path-list's graph node virtual function table
390 static const fib_node_vft_t fib_entry_vft = {
391 .fnv_get = fib_entry_get_node,
392 .fnv_last_lock = fib_entry_last_lock_gone,
393 .fnv_back_walk = fib_entry_back_walk_notify,
394 .fnv_mem_show = fib_entry_show_memory,
398 * @brief Contribute the set of Adjacencies that this entry forwards with
399 * to build the uRPF list of its children
402 fib_entry_contribute_urpf (fib_node_index_t entry_index,
405 fib_entry_t *fib_entry;
407 fib_entry = fib_entry_get(entry_index);
409 return (fib_path_list_contribute_urpf(fib_entry->fe_parent, urpf));
413 * If the client is request a chain for multicast forwarding then swap
414 * the chain type to one that can provide such transport.
416 static fib_forward_chain_type_t
417 fib_entry_chain_type_mcast_to_ucast (fib_forward_chain_type_t fct)
421 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
422 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
424 * we can only transport IP multicast packets if there is an
427 fct = FIB_FORW_CHAIN_TYPE_MPLS_EOS;
429 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
430 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
431 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
432 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
433 case FIB_FORW_CHAIN_TYPE_ETHERNET:
434 case FIB_FORW_CHAIN_TYPE_NSH:
435 case FIB_FORW_CHAIN_TYPE_BIER:
443 * fib_entry_contribute_forwarding
445 * Get an lock the forwarding information (DPO) contributed by the FIB entry.
448 fib_entry_contribute_forwarding (fib_node_index_t fib_entry_index,
449 fib_forward_chain_type_t fct,
452 fib_entry_delegate_t *fed;
453 fib_entry_t *fib_entry;
455 fib_entry = fib_entry_get(fib_entry_index);
458 * mfib children ask for mcast chains. fix these to the appropriate ucast types.
460 fct = fib_entry_chain_type_mcast_to_ucast(fct);
462 if (fct == fib_entry_get_default_chain_type(fib_entry))
464 dpo_copy(dpo, &fib_entry->fe_lb);
468 fed = fib_entry_delegate_find(fib_entry,
469 fib_entry_chain_type_to_delegate_type(fct));
474 * use a temporary DPO lest the delegate realloc in the recursive
477 dpo_id_t tmp = DPO_INVALID;
480 * on-demand create eos/non-eos.
481 * There is no on-demand delete because:
482 * - memory versus complexity & reliability:
483 * leaving unrequired [n]eos LB arounds wastes memory, cleaning
484 * then up on the right trigger is more code. i favour the latter.
486 fib_entry_src_mk_lb(fib_entry,
487 fib_entry_get_best_src_i(fib_entry),
491 fed = fib_entry_delegate_find_or_add(
493 fib_entry_chain_type_to_delegate_type(fct));
495 dpo_copy(&fed->fd_dpo, &tmp);
499 dpo_copy(dpo, &fed->fd_dpo);
502 * use the drop DPO is nothing else is present
504 if (!dpo_id_is_valid(dpo))
506 dpo_copy(dpo, drop_dpo_get(fib_forw_chain_type_to_dpo_proto(fct)));
510 * don't allow the special index indicating replicate.vs.load-balance
511 * to escape to the clients
513 dpo->dpoi_index &= ~MPLS_IS_REPLICATE;
517 fib_entry_contribute_ip_forwarding (fib_node_index_t fib_entry_index)
519 fib_forward_chain_type_t fct;
520 fib_entry_t *fib_entry;
522 fib_entry = fib_entry_get(fib_entry_index);
523 fct = fib_entry_get_default_chain_type(fib_entry);
525 ASSERT((fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP4 ||
526 fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP6));
528 if (dpo_id_is_valid(&fib_entry->fe_lb))
530 return (&fib_entry->fe_lb);
533 return (drop_dpo_get(fib_forw_chain_type_to_dpo_proto(fct)));
537 fib_entry_get_adj (fib_node_index_t fib_entry_index)
541 dpo = fib_entry_contribute_ip_forwarding(fib_entry_index);
543 if (dpo_id_is_valid(dpo))
545 dpo = load_balance_get_bucket(dpo->dpoi_index, 0);
549 return (dpo->dpoi_index);
552 return (ADJ_INDEX_INVALID);
556 fib_entry_get_path_list (fib_node_index_t fib_entry_index)
558 fib_entry_t *fib_entry;
560 fib_entry = fib_entry_get(fib_entry_index);
562 return (fib_entry->fe_parent);
566 fib_entry_child_add (fib_node_index_t fib_entry_index,
567 fib_node_type_t child_type,
568 fib_node_index_t child_index)
570 return (fib_node_child_add(FIB_NODE_TYPE_ENTRY,
577 fib_entry_child_remove (fib_node_index_t fib_entry_index,
580 fib_node_child_remove(FIB_NODE_TYPE_ENTRY,
584 if (0 == fib_node_get_n_children(FIB_NODE_TYPE_ENTRY,
588 * if there are no children left then there is no reason to keep
589 * the non-default forwarding chains. those chains are built only
590 * because the children want them.
592 fib_entry_delegate_type_t fdt;
593 fib_entry_delegate_t *fed;
594 fib_entry_t *fib_entry;
596 fib_entry = fib_entry_get(fib_entry_index);
598 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
600 dpo_reset(&fed->fd_dpo);
601 fib_entry_delegate_remove(fib_entry, fdt);
607 fib_entry_alloc (u32 fib_index,
608 const fib_prefix_t *prefix,
609 fib_node_index_t *fib_entry_index)
611 fib_entry_t *fib_entry;
614 pool_get(fib_entry_pool, fib_entry);
615 clib_memset(fib_entry, 0, sizeof(*fib_entry));
617 fib_node_init(&fib_entry->fe_node,
618 FIB_NODE_TYPE_ENTRY);
620 fib_entry->fe_fib_index = fib_index;
623 * the one time we need to update the const prefix is when
624 * the entry is first created
626 fep = (fib_prefix_t*)&(fib_entry->fe_prefix);
629 if (FIB_PROTOCOL_MPLS == fib_entry->fe_prefix.fp_proto)
632 if (MPLS_NON_EOS == fep->fp_eos)
634 fep->fp_payload_proto = DPO_PROTO_MPLS;
636 ASSERT(DPO_PROTO_NONE != fib_entry->fe_prefix.fp_payload_proto);
639 dpo_reset(&fib_entry->fe_lb);
641 *fib_entry_index = fib_entry_get_index(fib_entry);
647 fib_entry_post_flag_update_actions (fib_entry_t *fib_entry,
648 fib_entry_flag_t old_flags)
650 fib_node_index_t fei;
653 * save the index so we can recover from pool reallocs
655 fei = fib_entry_get_index(fib_entry);
658 * handle changes to attached export for import entries
660 int is_import = (FIB_ENTRY_FLAG_IMPORT & fib_entry_get_flags_i(fib_entry));
661 int was_import = (FIB_ENTRY_FLAG_IMPORT & old_flags);
663 if (!was_import && is_import)
666 * transition from not exported to exported
670 * there is an assumption here that the entry resolves via only
671 * one interface and that it is the cross VRF interface.
673 u32 sw_if_index = fib_path_list_get_resolving_interface(fib_entry->fe_parent);
675 fib_attached_export_import(fib_entry,
676 fib_table_get_index_for_sw_if_index(
677 fib_entry_get_proto(fib_entry),
680 else if (was_import && !is_import)
683 * transition from exported to not exported
685 fib_attached_export_purge(fib_entry);
689 * no change. nothing to do.
693 * reload the entry address post possible pool realloc
695 fib_entry = fib_entry_get(fei);
698 * handle changes to attached export for export entries
700 int is_attached = (FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags_i(fib_entry));
701 int was_attached = (FIB_ENTRY_FLAG_ATTACHED & old_flags);
703 if (!was_attached && is_attached)
706 * transition to attached. time to export
716 fib_entry_post_install_actions (fib_entry_t *fib_entry,
718 fib_entry_flag_t old_flags)
720 fib_entry = fib_entry_post_flag_update_actions(fib_entry,
722 fib_entry_src_action_installed(fib_entry, source);
728 fib_entry_create (u32 fib_index,
729 const fib_prefix_t *prefix,
731 fib_entry_flag_t flags,
732 const fib_route_path_t *paths)
734 fib_node_index_t fib_entry_index;
735 fib_entry_t *fib_entry;
737 ASSERT(0 < vec_len(paths));
739 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
742 * since this is a new entry create, we don't need to check for winning
743 * sources - there is only one.
745 fib_entry = fib_entry_src_action_add(fib_entry, source, flags,
748 fib_entry_get_proto(fib_entry))));
749 fib_entry_src_action_path_swap(fib_entry,
754 * handle possible realloc's by refetching the pointer
756 fib_entry = fib_entry_get(fib_entry_index);
757 fib_entry_src_action_activate(fib_entry, source);
759 fib_entry = fib_entry_post_install_actions(fib_entry, source,
760 FIB_ENTRY_FLAG_NONE);
762 FIB_ENTRY_DBG(fib_entry, "create");
764 return (fib_entry_index);
768 fib_entry_create_special (u32 fib_index,
769 const fib_prefix_t *prefix,
771 fib_entry_flag_t flags,
774 fib_node_index_t fib_entry_index;
775 fib_entry_t *fib_entry;
778 * create and initialize the new enty
780 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
783 * create the path-list
785 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
786 fib_entry_src_action_activate(fib_entry, source);
788 fib_entry = fib_entry_post_install_actions(fib_entry, source,
789 FIB_ENTRY_FLAG_NONE);
791 FIB_ENTRY_DBG(fib_entry, "create-special");
793 return (fib_entry_index);
797 fib_entry_post_update_actions (fib_entry_t *fib_entry,
799 fib_entry_flag_t old_flags)
802 * backwalk to children to inform then of the change to forwarding.
804 fib_node_back_walk_ctx_t bw_ctx = {
805 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
808 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_get_index(fib_entry), &bw_ctx);
811 * then inform any covered prefixes
813 fib_entry_cover_update_notify(fib_entry);
815 fib_entry_post_install_actions(fib_entry, source, old_flags);
819 fib_entry_recalculate_forwarding (fib_node_index_t fib_entry_index)
821 fib_source_t best_source;
822 fib_entry_t *fib_entry;
823 fib_entry_src_t *bsrc;
825 fib_entry = fib_entry_get(fib_entry_index);
827 bsrc = fib_entry_get_best_src_i(fib_entry);
828 best_source = fib_entry_src_get_source(bsrc);
830 fib_entry_src_action_reactivate(fib_entry, best_source);
834 fib_entry_source_change_w_flags (fib_entry_t *fib_entry,
835 fib_source_t old_source,
836 fib_entry_flag_t old_flags,
837 fib_source_t new_source)
839 if (new_source < old_source)
842 * we have a new winning source.
844 fib_entry_src_action_deactivate(fib_entry, old_source);
845 fib_entry_src_action_activate(fib_entry, new_source);
847 else if (new_source > old_source)
850 * the new source loses. Re-activate the winning sources
851 * in case it is an interposer and hence relied on the losing
852 * source's path-list.
854 fib_entry_src_action_reactivate(fib_entry, old_source);
860 * the new source is one this entry already has.
861 * But the path-list was updated, which will contribute new forwarding,
864 fib_entry_src_action_reactivate(fib_entry, new_source);
867 fib_entry_post_update_actions(fib_entry, new_source, old_flags);
871 fib_entry_source_change (fib_entry_t *fib_entry,
872 fib_source_t old_source,
873 fib_source_t new_source)
875 fib_entry_flag_t old_flags;
877 old_flags = fib_entry_get_flags_for_source(
878 fib_entry_get_index(fib_entry), old_source);
880 return (fib_entry_source_change_w_flags(fib_entry, old_source,
881 old_flags, new_source));
885 fib_entry_special_add (fib_node_index_t fib_entry_index,
887 fib_entry_flag_t flags,
890 fib_source_t best_source;
891 fib_entry_t *fib_entry;
893 fib_entry = fib_entry_get(fib_entry_index);
894 best_source = fib_entry_get_best_source(fib_entry_index);
896 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
897 fib_entry_source_change(fib_entry, best_source, source);
898 FIB_ENTRY_DBG(fib_entry, "special-add:%U", format_fib_source, source);
902 fib_entry_special_update (fib_node_index_t fib_entry_index,
904 fib_entry_flag_t flags,
907 fib_source_t best_source;
908 fib_entry_t *fib_entry;
910 fib_entry = fib_entry_get(fib_entry_index);
911 best_source = fib_entry_get_best_source(fib_entry_index);
913 fib_entry = fib_entry_src_action_update(fib_entry, source, flags, dpo);
914 fib_entry_source_change(fib_entry, best_source, source);
916 FIB_ENTRY_DBG(fib_entry, "special-updated:%U", format_fib_source, source);
921 fib_entry_path_add (fib_node_index_t fib_entry_index,
923 fib_entry_flag_t flags,
924 const fib_route_path_t *rpaths)
926 fib_source_t best_source;
927 fib_entry_t *fib_entry;
928 fib_entry_src_t *bsrc;
930 fib_entry = fib_entry_get(fib_entry_index);
931 ASSERT(NULL != fib_entry);
933 bsrc = fib_entry_get_best_src_i(fib_entry);
934 best_source = fib_entry_src_get_source(bsrc);
936 fib_entry = fib_entry_src_action_path_add(fib_entry, source, flags, rpaths);
938 fib_entry_source_change(fib_entry, best_source, source);
940 FIB_ENTRY_DBG(fib_entry, "path add:%U", format_fib_source, source);
943 static fib_entry_src_flag_t
944 fib_entry_src_burn_only_inherited (fib_entry_t *fib_entry)
946 fib_entry_src_t *src;
948 int has_only_inherited_sources = 1;
950 FOR_EACH_SRC_ADDED(fib_entry, src, source,
952 if (!(src->fes_flags & FIB_ENTRY_SRC_FLAG_INHERITED))
954 has_only_inherited_sources = 0;
958 if (has_only_inherited_sources)
960 FOR_EACH_SRC_ADDED(fib_entry, src, source,
962 fib_entry_src_action_remove(fib_entry, source);
964 return (FIB_ENTRY_SRC_FLAG_NONE);
968 return (FIB_ENTRY_SRC_FLAG_ADDED);
972 static fib_entry_src_flag_t
973 fib_entry_source_removed (fib_entry_t *fib_entry,
974 fib_entry_flag_t old_flags)
976 const fib_entry_src_t *bsrc;
977 fib_source_t best_source;
980 * if all that is left are inherited sources, then burn them
982 fib_entry_src_burn_only_inherited(fib_entry);
984 bsrc = fib_entry_get_best_src_i(fib_entry);
985 best_source = fib_entry_src_get_source(bsrc);
987 if (FIB_SOURCE_MAX == best_source)
990 * no more sources left. this entry is toast.
992 fib_entry = fib_entry_post_flag_update_actions(fib_entry, old_flags);
993 fib_entry_src_action_uninstall(fib_entry);
995 return (FIB_ENTRY_SRC_FLAG_NONE);
999 fib_entry_src_action_activate(fib_entry, best_source);
1002 fib_entry_post_update_actions(fib_entry, best_source, old_flags);
1005 * still have sources
1007 return (FIB_ENTRY_SRC_FLAG_ADDED);
1011 * fib_entry_path_remove
1013 * remove a path from the entry.
1014 * return the fib_entry's index if it is still present, INVALID otherwise.
1016 fib_entry_src_flag_t
1017 fib_entry_path_remove (fib_node_index_t fib_entry_index,
1018 fib_source_t source,
1019 const fib_route_path_t *rpaths)
1021 fib_entry_src_flag_t sflag;
1022 fib_source_t best_source;
1023 fib_entry_flag_t bflags;
1024 fib_entry_t *fib_entry;
1025 fib_entry_src_t *bsrc;
1027 fib_entry = fib_entry_get(fib_entry_index);
1028 ASSERT(NULL != fib_entry);
1030 bsrc = fib_entry_get_best_src_i(fib_entry);
1031 best_source = fib_entry_src_get_source(bsrc);
1032 bflags = fib_entry_src_get_flags(bsrc);
1034 sflag = fib_entry_src_action_path_remove(fib_entry, source, rpaths);
1036 FIB_ENTRY_DBG(fib_entry, "path remove:%U", format_fib_source, source);
1039 * if the path list for the source passed is invalid,
1040 * then we need to create a new one. else we are updating
1043 if (source < best_source)
1046 * Que! removing a path from a source that is better than the
1047 * one this entry is using.
1051 else if (source > best_source )
1054 * the source is not the best. no need to update forwarding
1056 if (FIB_ENTRY_SRC_FLAG_ADDED & sflag)
1059 * the source being removed still has paths
1061 return (FIB_ENTRY_SRC_FLAG_ADDED);
1066 * that was the last path from this source, check if those
1067 * that remain are non-inherited
1069 return (fib_entry_src_burn_only_inherited(fib_entry));
1075 * removing a path from the path-list we were using.
1077 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
1080 * the last path from the source was removed.
1081 * fallback to lower source
1083 return (fib_entry_source_removed(fib_entry, bflags));
1088 * re-install the new forwarding information
1090 fib_entry_src_action_reactivate(fib_entry, source);
1094 fib_entry_post_update_actions(fib_entry, source, bflags);
1097 * still have sources
1099 return (FIB_ENTRY_SRC_FLAG_ADDED);
1103 * fib_entry_special_remove
1105 * remove a special source from the entry.
1106 * return the fib_entry's index if it is still present, INVALID otherwise.
1108 fib_entry_src_flag_t
1109 fib_entry_special_remove (fib_node_index_t fib_entry_index,
1110 fib_source_t source)
1112 fib_entry_src_flag_t sflag;
1113 fib_source_t best_source;
1114 fib_entry_flag_t bflags;
1115 fib_entry_t *fib_entry;
1116 fib_entry_src_t *bsrc;
1118 fib_entry = fib_entry_get(fib_entry_index);
1119 ASSERT(NULL != fib_entry);
1121 bsrc = fib_entry_get_best_src_i(fib_entry);
1122 best_source = fib_entry_src_get_source(bsrc);
1123 bflags = fib_entry_src_get_flags(bsrc);
1125 FIB_ENTRY_DBG(fib_entry, "special remove:%U", format_fib_source, source);
1127 sflag = fib_entry_src_action_remove_or_update_inherit(fib_entry, source);
1130 * if the path list for the source passed is invalid,
1131 * then we need to create a new one. else we are updating
1134 if (source < best_source )
1137 * Que! removing a path from a source that is better than the
1138 * one this entry is using. This can only mean it is a source
1139 * this prefix does not have.
1141 return (FIB_ENTRY_SRC_FLAG_ADDED);
1143 else if (source > best_source ) {
1145 * the source is not the best. no need to update forwarding
1147 if (FIB_ENTRY_SRC_FLAG_ADDED & sflag)
1150 * the source being removed still has paths
1152 return (FIB_ENTRY_SRC_FLAG_ADDED);
1157 * that was the last path from this source, check if those
1158 * that remain are non-inherited
1160 if (FIB_ENTRY_SRC_FLAG_NONE == fib_entry_src_burn_only_inherited(fib_entry))
1163 * no more sources left. this entry is toast.
1165 fib_entry = fib_entry_post_flag_update_actions(fib_entry, bflags);
1166 fib_entry_src_action_uninstall(fib_entry);
1167 return (FIB_ENTRY_SRC_FLAG_NONE);
1171 * reactivate the best source so the interposer gets restacked
1173 fib_entry_src_action_reactivate(fib_entry, best_source);
1175 return (FIB_ENTRY_SRC_FLAG_ADDED);
1180 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
1183 * the source was removed. use the next best.
1185 return (fib_entry_source_removed(fib_entry, bflags));
1190 * re-install the new forwarding information
1192 fib_entry_src_action_reactivate(fib_entry, source);
1196 fib_entry_post_update_actions(fib_entry, source, bflags);
1199 * still have sources
1201 return (FIB_ENTRY_SRC_FLAG_ADDED);
1207 * If the source on the cover is inheriting then push this source
1208 * down to the covered.
1211 fib_entry_inherit (fib_node_index_t cover,
1212 fib_node_index_t covered)
1214 fib_entry_src_inherit(fib_entry_get(cover),
1215 fib_entry_get(covered));
1221 * The source is withdrawing all the paths it provided
1223 fib_entry_src_flag_t
1224 fib_entry_delete (fib_node_index_t fib_entry_index,
1225 fib_source_t source)
1227 return (fib_entry_special_remove(fib_entry_index, source));
1233 * The source has provided a new set of paths that will replace the old.
1236 fib_entry_update (fib_node_index_t fib_entry_index,
1237 fib_source_t source,
1238 fib_entry_flag_t flags,
1239 const fib_route_path_t *paths)
1241 fib_source_t best_source;
1242 fib_entry_flag_t bflags;
1243 fib_entry_t *fib_entry;
1244 fib_entry_src_t *bsrc;
1246 fib_entry = fib_entry_get(fib_entry_index);
1247 ASSERT(NULL != fib_entry);
1249 bsrc = fib_entry_get_best_src_i(fib_entry);
1250 best_source = fib_entry_src_get_source(bsrc);
1251 bflags = fib_entry_get_flags_i(fib_entry);
1253 fib_entry = fib_entry_src_action_path_swap(fib_entry,
1258 fib_entry_source_change_w_flags(fib_entry, best_source, bflags, source);
1259 FIB_ENTRY_DBG(fib_entry, "update");
1264 * fib_entry_cover_changed
1266 * this entry is tracking its cover and that cover has changed.
1269 fib_entry_cover_changed (fib_node_index_t fib_entry_index)
1271 fib_entry_src_cover_res_t res = {
1273 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1275 CLIB_UNUSED(fib_source_t source);
1276 fib_source_t best_source;
1277 fib_entry_flag_t bflags;
1278 fib_entry_t *fib_entry;
1279 fib_entry_src_t *esrc;
1282 bflags = FIB_ENTRY_FLAG_NONE;
1283 best_source = FIB_SOURCE_FIRST;
1284 fib_entry = fib_entry_get(fib_entry_index);
1286 fib_attached_export_cover_change(fib_entry);
1289 * propagate the notification to each of the added sources
1292 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1297 * only the best source gets to set the back walk flags
1299 res = fib_entry_src_action_cover_change(fib_entry, esrc);
1300 bflags = fib_entry_src_get_flags(esrc);
1301 best_source = fib_entry_src_get_source(esrc);
1305 fib_entry_src_action_cover_change(fib_entry, esrc);
1312 fib_entry_src_action_reactivate(fib_entry,
1313 fib_entry_src_get_source(
1314 fib_entry_get_best_src_i(fib_entry)));
1315 fib_entry = fib_entry_post_install_actions(fib_entry,
1321 fib_entry_src_action_uninstall(fib_entry);
1324 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1327 * time for walkies fido.
1329 fib_node_back_walk_ctx_t bw_ctx = {
1330 .fnbw_reason = res.bw_reason,
1333 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1335 FIB_ENTRY_DBG(fib_entry, "cover-changed");
1339 * fib_entry_cover_updated
1341 * this entry is tracking its cover and that cover has been updated
1342 * (i.e. its forwarding information has changed).
1345 fib_entry_cover_updated (fib_node_index_t fib_entry_index)
1347 fib_entry_src_cover_res_t res = {
1349 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1351 CLIB_UNUSED(fib_source_t source);
1352 fib_source_t best_source;
1353 fib_entry_flag_t bflags;
1354 fib_entry_t *fib_entry;
1355 fib_entry_src_t *esrc;
1358 bflags = FIB_ENTRY_FLAG_NONE;
1359 best_source = FIB_SOURCE_FIRST;
1360 fib_entry = fib_entry_get(fib_entry_index);
1362 fib_attached_export_cover_update(fib_entry);
1365 * propagate the notification to each of the added sources
1368 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1373 * only the best source gets to set the back walk flags
1375 res = fib_entry_src_action_cover_update(fib_entry, esrc);
1376 bflags = fib_entry_src_get_flags(esrc);
1377 best_source = fib_entry_src_get_source(esrc);
1381 fib_entry_src_action_cover_update(fib_entry, esrc);
1388 fib_entry_src_action_reactivate(fib_entry,
1389 fib_entry_src_get_source(
1390 fib_entry_get_best_src_i(fib_entry)));
1391 fib_entry = fib_entry_post_install_actions(fib_entry,
1397 fib_entry_src_action_uninstall(fib_entry);
1400 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1403 * time for walkies fido.
1405 fib_node_back_walk_ctx_t bw_ctx = {
1406 .fnbw_reason = res.bw_reason,
1409 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1411 FIB_ENTRY_DBG(fib_entry, "cover-updated");
1415 fib_entry_recursive_loop_detect (fib_node_index_t entry_index,
1416 fib_node_index_t **entry_indicies)
1418 fib_entry_t *fib_entry;
1419 int was_looped, is_looped;
1421 fib_entry = fib_entry_get(entry_index);
1423 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1425 fib_node_index_t *entries = *entry_indicies;
1427 vec_add1(entries, entry_index);
1428 was_looped = fib_path_list_is_looped(fib_entry->fe_parent);
1429 is_looped = fib_path_list_recursive_loop_detect(fib_entry->fe_parent,
1432 *entry_indicies = entries;
1434 if (!!was_looped != !!is_looped)
1437 * re-evaluate all the entry's forwarding
1438 * NOTE: this is an inplace modify
1440 fib_entry_delegate_type_t fdt;
1441 fib_entry_delegate_t *fed;
1443 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
1445 fib_entry_src_mk_lb(fib_entry,
1446 fib_entry_get_best_src_i(fib_entry),
1447 fib_entry_delegate_type_to_chain_type(fdt),
1455 * the entry is currently not linked to a path-list. this happens
1456 * when it is this entry that is re-linking path-lists and has thus
1466 fib_entry_get_resolving_interface (fib_node_index_t entry_index)
1468 fib_entry_t *fib_entry;
1470 fib_entry = fib_entry_get(entry_index);
1472 return (fib_path_list_get_resolving_interface(fib_entry->fe_parent));
1476 fib_entry_get_best_source (fib_node_index_t entry_index)
1478 fib_entry_t *fib_entry;
1479 fib_entry_src_t *bsrc;
1481 fib_entry = fib_entry_get(entry_index);
1483 bsrc = fib_entry_get_best_src_i(fib_entry);
1484 return (fib_entry_src_get_source(bsrc));
1488 * Return !0 is the entry represents a host prefix
1491 fib_entry_is_host (fib_node_index_t fib_entry_index)
1493 return (fib_prefix_is_host(fib_entry_get_prefix(fib_entry_index)));
1497 * Return !0 is the entry is resolved, i.e. will return a valid forwarding
1501 fib_entry_is_resolved (fib_node_index_t fib_entry_index)
1503 fib_entry_delegate_t *fed;
1504 fib_entry_t *fib_entry;
1506 fib_entry = fib_entry_get(fib_entry_index);
1508 fed = fib_entry_delegate_find(fib_entry, FIB_ENTRY_DELEGATE_BFD);
1513 * no BFD tracking - consider it resolved.
1520 * defer to the state of the BFD tracking
1522 return (FIB_BFD_STATE_UP == fed->fd_bfd_state);
1527 fib_entry_set_flow_hash_config (fib_node_index_t fib_entry_index,
1528 flow_hash_config_t hash_config)
1530 fib_entry_t *fib_entry;
1532 fib_entry = fib_entry_get(fib_entry_index);
1535 * pass the hash-config on to the load-balance object where it is cached.
1536 * we can ignore LBs in the delegate chains, since they will not be of the
1537 * correct protocol type (i.e. they are not IP)
1538 * There's no way, nor need, to change the hash config for MPLS.
1540 if (dpo_id_is_valid(&fib_entry->fe_lb))
1544 ASSERT(DPO_LOAD_BALANCE == fib_entry->fe_lb.dpoi_type);
1546 lb = load_balance_get(fib_entry->fe_lb.dpoi_index);
1549 * atomic update for packets in flight
1551 lb->lb_hash_config = hash_config;
1556 fib_entry_get_stats_index (fib_node_index_t fib_entry_index)
1558 fib_entry_t *fib_entry;
1560 fib_entry = fib_entry_get(fib_entry_index);
1562 return (fib_entry->fe_lb.dpoi_index);
1566 fib_ip4_address_compare (const ip4_address_t * a1,
1567 const ip4_address_t * a2)
1570 * IP addresses are unsigned ints. the return value here needs to be signed
1571 * a simple subtraction won't cut it.
1572 * If the addresses are the same, the sort order is undefined, so phoey.
1574 return ((clib_net_to_host_u32(a1->data_u32) >
1575 clib_net_to_host_u32(a2->data_u32) ) ?
1580 fib_ip6_address_compare (const ip6_address_t * a1,
1581 const ip6_address_t * a2)
1584 for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1586 int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1587 clib_net_to_host_u16 (a2->as_u16[i]));
1595 fib_entry_cmp (fib_node_index_t fib_entry_index1,
1596 fib_node_index_t fib_entry_index2)
1598 fib_entry_t *fib_entry1, *fib_entry2;
1601 fib_entry1 = fib_entry_get(fib_entry_index1);
1602 fib_entry2 = fib_entry_get(fib_entry_index2);
1604 switch (fib_entry1->fe_prefix.fp_proto)
1606 case FIB_PROTOCOL_IP4:
1607 cmp = fib_ip4_address_compare(&fib_entry1->fe_prefix.fp_addr.ip4,
1608 &fib_entry2->fe_prefix.fp_addr.ip4);
1610 case FIB_PROTOCOL_IP6:
1611 cmp = fib_ip6_address_compare(&fib_entry1->fe_prefix.fp_addr.ip6,
1612 &fib_entry2->fe_prefix.fp_addr.ip6);
1614 case FIB_PROTOCOL_MPLS:
1615 cmp = (fib_entry1->fe_prefix.fp_label - fib_entry2->fe_prefix.fp_label);
1619 cmp = (fib_entry1->fe_prefix.fp_eos - fib_entry2->fe_prefix.fp_eos);
1625 cmp = (fib_entry1->fe_prefix.fp_len - fib_entry2->fe_prefix.fp_len);
1631 fib_entry_cmp_for_sort (void *i1, void *i2)
1633 fib_node_index_t *fib_entry_index1 = i1, *fib_entry_index2 = i2;
1635 return (fib_entry_cmp(*fib_entry_index1,
1636 *fib_entry_index2));
1640 fib_entry_lock (fib_node_index_t fib_entry_index)
1642 fib_entry_t *fib_entry;
1644 fib_entry = fib_entry_get(fib_entry_index);
1646 fib_node_lock(&fib_entry->fe_node);
1650 fib_entry_unlock (fib_node_index_t fib_entry_index)
1652 fib_entry_t *fib_entry;
1654 fib_entry = fib_entry_get(fib_entry_index);
1656 fib_node_unlock(&fib_entry->fe_node);
1660 fib_entry_module_init (void)
1662 fib_node_register_type(FIB_NODE_TYPE_ENTRY, &fib_entry_vft);
1663 fib_entry_logger = vlib_log_register_class("fib", "entry");
1665 fib_entry_track_module_init();
1669 fib_entry_encode (fib_node_index_t fib_entry_index)
1671 fib_path_ext_list_t *ext_list;
1672 fib_path_encode_ctx_t ctx = {
1675 fib_entry_t *fib_entry;
1676 fib_entry_src_t *bsrc;
1679 fib_entry = fib_entry_get(fib_entry_index);
1680 bsrc = fib_entry_get_best_src_i(fib_entry);
1684 ext_list = &bsrc->fes_path_exts;
1687 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1689 fib_path_list_walk_w_ext(fib_entry->fe_parent,
1695 return (ctx.rpaths);
1698 const fib_prefix_t *
1699 fib_entry_get_prefix (fib_node_index_t fib_entry_index)
1701 fib_entry_t *fib_entry;
1703 fib_entry = fib_entry_get(fib_entry_index);
1705 return (&fib_entry->fe_prefix);
1709 fib_entry_get_fib_index (fib_node_index_t fib_entry_index)
1711 fib_entry_t *fib_entry;
1713 fib_entry = fib_entry_get(fib_entry_index);
1715 return (fib_entry->fe_fib_index);
1719 fib_entry_pool_size (void)
1721 return (pool_elts(fib_entry_pool));
1724 static clib_error_t *
1725 show_fib_entry_command (vlib_main_t * vm,
1726 unformat_input_t * input,
1727 vlib_cli_command_t * cmd)
1729 fib_node_index_t fei;
1731 if (unformat (input, "%d", &fei))
1734 * show one in detail
1736 if (!pool_is_free_index(fib_entry_pool, fei))
1738 vlib_cli_output (vm, "%d@%U",
1740 format_fib_entry, fei,
1741 FIB_ENTRY_FORMAT_DETAIL2);
1745 vlib_cli_output (vm, "entry %d invalid", fei);
1753 vlib_cli_output (vm, "FIB Entries:");
1754 pool_foreach_index(fei, fib_entry_pool,
1756 vlib_cli_output (vm, "%d@%U",
1758 format_fib_entry, fei,
1759 FIB_ENTRY_FORMAT_BRIEF);
1766 VLIB_CLI_COMMAND (show_fib_entry, static) = {
1767 .path = "show fib entry",
1768 .function = show_fib_entry_command,
1769 .short_help = "show fib entry",