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)
79 * If the entry being asked is a eos-MPLS label entry,
80 * then use the payload-protocol field, that we stashed there
81 * for just this purpose
83 return (fib_forw_chain_type_from_dpo_proto(
84 fib_entry->fe_prefix.fp_payload_proto));
86 return (FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS);
89 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
93 format_fib_entry (u8 * s, va_list * args)
95 fib_forward_chain_type_t fct;
96 fib_entry_attribute_t attr;
97 fib_path_ext_t *path_ext;
98 fib_entry_t *fib_entry;
100 fib_node_index_t fei;
105 fei = va_arg (*args, fib_node_index_t);
106 level = va_arg (*args, int);
107 fib_entry = fib_entry_get(fei);
109 s = format (s, "%U", format_fib_prefix, &fib_entry->fe_prefix);
111 if (level >= FIB_ENTRY_FORMAT_DETAIL)
113 s = format (s, " fib:%d", fib_entry->fe_fib_index);
114 s = format (s, " index:%d", fib_entry_get_index(fib_entry));
115 s = format (s, " locks:%d", fib_entry->fe_node.fn_locks);
117 FOR_EACH_SRC_ADDED(fib_entry, src, source,
119 s = format (s, "\n src:%s ",
120 fib_source_names[source]);
121 s = fib_entry_src_format(fib_entry, source, s);
122 s = format (s, " refs:%d ", src->fes_ref_count);
123 if (FIB_ENTRY_FLAG_NONE != src->fes_entry_flags) {
124 s = format(s, "flags:");
125 FOR_EACH_FIB_ATTRIBUTE(attr) {
126 if ((1<<attr) & src->fes_entry_flags) {
127 s = format (s, "%s,", fib_attribute_names[attr]);
131 s = format (s, "\n");
132 if (FIB_NODE_INDEX_INVALID != src->fes_pl)
134 s = fib_path_list_format(src->fes_pl, s);
136 if (NULL != src->fes_path_exts)
138 s = format(s, " Extensions:");
139 vec_foreach(path_ext, src->fes_path_exts)
141 s = format(s, "\n %U", format_fib_path_ext, path_ext);
146 n_covered = fib_entry_cover_get_size(fib_entry);
148 s = format(s, "\n tracking %d covered: ", n_covered);
149 s = fib_entry_cover_list_format(fib_entry, s);
151 s = fib_ae_import_format(fib_entry, s);
152 s = fib_ae_export_format(fib_entry, s);
154 s = format (s, "\n forwarding: ");
158 s = format (s, "\n");
161 fct = fib_entry_get_default_chain_type(fib_entry);
163 if (!dpo_id_is_valid(&fib_entry->fe_lb))
165 s = format (s, " UNRESOLVED\n");
170 s = format(s, " %U-chain\n %U",
171 format_fib_forw_chain_type, fct,
177 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
179 fib_entry_delegate_type_t fdt;
180 fib_entry_delegate_t *fed;
182 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
184 s = format(s, " %U-chain\n %U",
185 format_fib_forw_chain_type,
186 fib_entry_delegate_type_to_chain_type(fdt),
187 format_dpo_id, &fed->fd_dpo, 2);
193 if (level >= FIB_ENTRY_FORMAT_DETAIL2)
195 s = format(s, "\nchildren:");
196 s = fib_node_children_format(fib_entry->fe_node.fn_children, s);
203 fib_entry_from_fib_node (fib_node_t *node)
206 ASSERT(FIB_NODE_TYPE_ENTRY == node->fn_type);
208 return ((fib_entry_t*)node);
212 fib_entry_last_lock_gone (fib_node_t *node)
214 fib_entry_delegate_type_t fdt;
215 fib_entry_delegate_t *fed;
216 fib_entry_t *fib_entry;
218 fib_entry = fib_entry_from_fib_node(node);
220 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
222 dpo_reset(&fed->fd_dpo);
223 fib_entry_delegate_remove(fib_entry, fdt);
226 FIB_ENTRY_DBG(fib_entry, "last-lock");
228 fib_node_deinit(&fib_entry->fe_node);
229 // FIXME -RR Backwalk
231 ASSERT(0 == vec_len(fib_entry->fe_delegates));
232 vec_free(fib_entry->fe_delegates);
233 pool_put(fib_entry_pool, fib_entry);
236 static fib_entry_src_t*
237 fib_entry_get_best_src_i (const fib_entry_t *fib_entry)
239 fib_entry_src_t *bsrc;
242 * the enum of sources is deliberately arranged in priority order
244 if (0 == vec_len(fib_entry->fe_srcs))
250 bsrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
257 fib_entry_src_get_source (const fib_entry_src_t *esrc)
261 return (esrc->fes_src);
263 return (FIB_SOURCE_MAX);
266 static fib_entry_flag_t
267 fib_entry_src_get_flags (const fib_entry_src_t *esrc)
271 return (esrc->fes_entry_flags);
273 return (FIB_ENTRY_FLAG_NONE);
277 fib_entry_get_flags (fib_node_index_t fib_entry_index)
279 return (fib_entry_get_flags_i(fib_entry_get(fib_entry_index)));
283 * fib_entry_back_walk_notify
285 * A back walk has reach this entry.
287 static fib_node_back_walk_rc_t
288 fib_entry_back_walk_notify (fib_node_t *node,
289 fib_node_back_walk_ctx_t *ctx)
291 fib_entry_t *fib_entry;
293 fib_entry = fib_entry_from_fib_node(node);
295 if (FIB_NODE_BW_REASON_FLAG_EVALUATE & ctx->fnbw_reason ||
296 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE & ctx->fnbw_reason ||
297 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN & ctx->fnbw_reason ||
298 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP & ctx->fnbw_reason ||
299 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN & ctx->fnbw_reason ||
300 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE & ctx->fnbw_reason)
302 fib_entry_src_action_reactivate(fib_entry,
303 fib_entry_get_best_source(
304 fib_entry_get_index(fib_entry)));
308 * all other walk types can be reclassifed to a re-evaluate to
309 * all recursive dependents.
310 * By reclassifying we ensure that should any of these walk types meet
311 * they can be merged.
313 ctx->fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE;
316 * ... and nothing is forced sync from now on.
318 ctx->fnbw_flags &= ~FIB_NODE_BW_FLAG_FORCE_SYNC;
321 * propagate the backwalk further if we haven't already reached the
324 fib_walk_sync(FIB_NODE_TYPE_ENTRY,
325 fib_entry_get_index(fib_entry),
328 return (FIB_NODE_BACK_WALK_CONTINUE);
332 fib_entry_show_memory (void)
334 u32 n_srcs = 0, n_exts = 0;
335 fib_entry_src_t *esrc;
338 fib_show_memory_usage("Entry",
339 pool_elts(fib_entry_pool),
340 pool_len(fib_entry_pool),
341 sizeof(fib_entry_t));
343 pool_foreach(entry, fib_entry_pool,
345 n_srcs += vec_len(entry->fe_srcs);
346 vec_foreach(esrc, entry->fe_srcs)
348 n_exts += vec_len(esrc->fes_path_exts);
352 fib_show_memory_usage("Entry Source",
353 n_srcs, n_srcs, sizeof(fib_entry_src_t));
354 fib_show_memory_usage("Entry Path-Extensions",
356 sizeof(fib_path_ext_t));
360 * The FIB path-list's graph node virtual function table
362 static const fib_node_vft_t fib_entry_vft = {
363 .fnv_get = fib_entry_get_node,
364 .fnv_last_lock = fib_entry_last_lock_gone,
365 .fnv_back_walk = fib_entry_back_walk_notify,
366 .fnv_mem_show = fib_entry_show_memory,
370 * @brief Contribute the set of Adjacencies that this entry forwards with
371 * to build the uRPF list of its children
374 fib_entry_contribute_urpf (fib_node_index_t entry_index,
377 fib_entry_t *fib_entry;
379 fib_entry = fib_entry_get(entry_index);
381 return (fib_path_list_contribute_urpf(fib_entry->fe_parent, urpf));
385 * fib_entry_contribute_forwarding
387 * Get an lock the forwarding information (DPO) contributed by the FIB entry.
390 fib_entry_contribute_forwarding (fib_node_index_t fib_entry_index,
391 fib_forward_chain_type_t fct,
394 fib_entry_delegate_t *fed;
395 fib_entry_t *fib_entry;
397 fib_entry = fib_entry_get(fib_entry_index);
399 if (fct == fib_entry_get_default_chain_type(fib_entry))
401 dpo_copy(dpo, &fib_entry->fe_lb);
405 fed = fib_entry_delegate_get(fib_entry,
406 fib_entry_chain_type_to_delegate_type(fct));
410 fed = fib_entry_delegate_find_or_add(
412 fib_entry_chain_type_to_delegate_type(fct));
414 * on-demand create eos/non-eos.
415 * There is no on-demand delete because:
416 * - memory versus complexity & reliability:
417 * leaving unrequired [n]eos LB arounds wastes memory, cleaning
418 * then up on the right trigger is more code. i favour the latter.
420 fib_entry_src_mk_lb(fib_entry,
421 fib_entry_get_best_src_i(fib_entry),
426 dpo_copy(dpo, &fed->fd_dpo);
431 fib_entry_contribute_ip_forwarding (fib_node_index_t fib_entry_index)
433 fib_forward_chain_type_t fct;
434 fib_entry_t *fib_entry;
436 fib_entry = fib_entry_get(fib_entry_index);
437 fct = fib_entry_get_default_chain_type(fib_entry);
439 ASSERT((fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP4 ||
440 fct == FIB_FORW_CHAIN_TYPE_UNICAST_IP6));
442 return (&fib_entry->fe_lb);
446 fib_entry_get_adj (fib_node_index_t fib_entry_index)
450 dpo = fib_entry_contribute_ip_forwarding(fib_entry_index);
451 dpo = load_balance_get_bucket(dpo->dpoi_index, 0);
455 return (dpo->dpoi_index);
457 return (ADJ_INDEX_INVALID);
461 fib_entry_get_path_list (fib_node_index_t fib_entry_index)
463 fib_entry_t *fib_entry;
465 fib_entry = fib_entry_get(fib_entry_index);
467 return (fib_entry->fe_parent);
471 fib_entry_child_add (fib_node_index_t fib_entry_index,
472 fib_node_type_t child_type,
473 fib_node_index_t child_index)
475 return (fib_node_child_add(FIB_NODE_TYPE_ENTRY,
482 fib_entry_child_remove (fib_node_index_t fib_entry_index,
485 fib_node_child_remove(FIB_NODE_TYPE_ENTRY,
489 if (0 == fib_node_get_n_children(FIB_NODE_TYPE_ENTRY,
493 * if there are no children left then there is no reason to keep
494 * the non-default forwarding chains. those chains are built only
495 * because the children want them.
497 fib_entry_delegate_type_t fdt;
498 fib_entry_delegate_t *fed;
499 fib_entry_t *fib_entry;
501 fib_entry = fib_entry_get(fib_entry_index);
503 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
505 dpo_reset(&fed->fd_dpo);
506 fib_entry_delegate_remove(fib_entry, fdt);
512 fib_entry_alloc (u32 fib_index,
513 const fib_prefix_t *prefix,
514 fib_node_index_t *fib_entry_index)
516 fib_entry_t *fib_entry;
519 pool_get(fib_entry_pool, fib_entry);
520 memset(fib_entry, 0, sizeof(*fib_entry));
522 fib_node_init(&fib_entry->fe_node,
523 FIB_NODE_TYPE_ENTRY);
525 fib_entry->fe_fib_index = fib_index;
528 * the one time we need to update the const prefix is when
529 * the entry is first created
531 fep = (fib_prefix_t*)&(fib_entry->fe_prefix);
534 if (FIB_PROTOCOL_MPLS == fib_entry->fe_prefix.fp_proto)
537 if (MPLS_NON_EOS == fep->fp_eos)
539 fep->fp_payload_proto = DPO_PROTO_MPLS;
541 ASSERT(DPO_PROTO_NONE != fib_entry->fe_prefix.fp_payload_proto);
544 dpo_reset(&fib_entry->fe_lb);
546 *fib_entry_index = fib_entry_get_index(fib_entry);
548 FIB_ENTRY_DBG(fib_entry, "alloc");
554 fib_entry_post_flag_update_actions (fib_entry_t *fib_entry,
556 fib_entry_flag_t old_flags)
559 * handle changes to attached export for import entries
561 int is_import = (FIB_ENTRY_FLAG_IMPORT & fib_entry_get_flags_i(fib_entry));
562 int was_import = (FIB_ENTRY_FLAG_IMPORT & old_flags);
564 if (!was_import && is_import)
567 * transition from not exported to exported
571 * there is an assumption here that the entry resolves via only
572 * one interface and that it is the cross VRF interface.
574 u32 sw_if_index = fib_path_list_get_resolving_interface(fib_entry->fe_parent);
576 fib_attached_export_import(fib_entry,
577 fib_table_get_index_for_sw_if_index(
578 fib_entry_get_proto(fib_entry),
581 else if (was_import && !is_import)
584 * transition from exported to not exported
586 fib_attached_export_purge(fib_entry);
590 * no change. nothing to do.
594 * handle changes to attached export for export entries
596 int is_attached = (FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags_i(fib_entry));
597 int was_attached = (FIB_ENTRY_FLAG_ATTACHED & old_flags);
599 if (!was_attached && is_attached)
602 * transition to attached. time to export
610 fib_entry_post_install_actions (fib_entry_t *fib_entry,
612 fib_entry_flag_t old_flags)
614 fib_entry_post_flag_update_actions(fib_entry, source, old_flags);
615 fib_entry_src_action_installed(fib_entry, source);
619 fib_entry_create (u32 fib_index,
620 const fib_prefix_t *prefix,
622 fib_entry_flag_t flags,
623 const fib_route_path_t *paths)
625 fib_node_index_t fib_entry_index;
626 fib_entry_t *fib_entry;
628 ASSERT(0 < vec_len(paths));
630 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
633 * since this is a new entry create, we don't need to check for winning
634 * sources - there is only one.
636 fib_entry = fib_entry_src_action_add(fib_entry, source, flags,
639 fib_entry_get_proto(fib_entry))));
640 fib_entry_src_action_path_swap(fib_entry,
645 * handle possible realloc's by refetching the pointer
647 fib_entry = fib_entry_get(fib_entry_index);
648 fib_entry_src_action_activate(fib_entry, source);
650 fib_entry_post_install_actions(fib_entry, source, FIB_ENTRY_FLAG_NONE);
652 return (fib_entry_index);
656 fib_entry_create_special (u32 fib_index,
657 const fib_prefix_t *prefix,
659 fib_entry_flag_t flags,
662 fib_node_index_t fib_entry_index;
663 fib_entry_t *fib_entry;
666 * create and initiliase the new enty
668 fib_entry = fib_entry_alloc(fib_index, prefix, &fib_entry_index);
671 * create the path-list
673 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
674 fib_entry_src_action_activate(fib_entry, source);
676 fib_entry_post_install_actions(fib_entry, source, FIB_ENTRY_FLAG_NONE);
678 return (fib_entry_index);
682 fib_entry_post_update_actions (fib_entry_t *fib_entry,
684 fib_entry_flag_t old_flags)
687 * backwalk to children to inform then of the change to forwarding.
689 fib_node_back_walk_ctx_t bw_ctx = {
690 .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
693 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_get_index(fib_entry), &bw_ctx);
696 * then inform any covered prefixes
698 fib_entry_cover_update_notify(fib_entry);
700 fib_entry_post_install_actions(fib_entry, source, old_flags);
704 fib_entry_source_change (fib_entry_t *fib_entry,
705 fib_source_t best_source,
706 fib_source_t new_source,
707 fib_entry_flag_t old_flags)
710 * if the path list for the source passed is invalid,
711 * then we need to create a new one. else we are updating
714 if (new_source < best_source)
717 * we have a new winning source.
719 fib_entry_src_action_deactivate(fib_entry, best_source);
720 fib_entry_src_action_activate(fib_entry, new_source);
722 else if (new_source > best_source)
725 * the new source loses. nothing to do here.
726 * the data from the source is saved in the path-list created
733 * the new source is one this entry already has.
734 * But the path-list was updated, which will contribute new forwarding,
737 fib_entry_src_action_deactivate(fib_entry, new_source);
738 fib_entry_src_action_activate(fib_entry, new_source);
741 fib_entry_post_update_actions(fib_entry, new_source, old_flags);
745 fib_entry_special_add (fib_node_index_t fib_entry_index,
747 fib_entry_flag_t flags,
750 fib_source_t best_source;
751 fib_entry_flag_t bflags;
752 fib_entry_t *fib_entry;
753 fib_entry_src_t *bsrc;
755 fib_entry = fib_entry_get(fib_entry_index);
757 bsrc = fib_entry_get_best_src_i(fib_entry);
758 best_source = fib_entry_src_get_source(bsrc);
759 bflags = fib_entry_src_get_flags(bsrc);
761 fib_entry = fib_entry_src_action_add(fib_entry, source, flags, dpo);
762 fib_entry_source_change(fib_entry, best_source, source, bflags);
766 fib_entry_special_update (fib_node_index_t fib_entry_index,
768 fib_entry_flag_t flags,
771 fib_source_t best_source;
772 fib_entry_flag_t bflags;
773 fib_entry_t *fib_entry;
774 fib_entry_src_t *bsrc;
776 fib_entry = fib_entry_get(fib_entry_index);
778 bsrc = fib_entry_get_best_src_i(fib_entry);
779 best_source = fib_entry_src_get_source(bsrc);
780 bflags = fib_entry_src_get_flags(bsrc);
782 fib_entry = fib_entry_src_action_update(fib_entry, source, flags, dpo);
783 fib_entry_source_change(fib_entry, best_source, source, bflags);
788 fib_entry_path_add (fib_node_index_t fib_entry_index,
790 fib_entry_flag_t flags,
791 const fib_route_path_t *rpath)
793 fib_source_t best_source;
794 fib_entry_flag_t bflags;
795 fib_entry_t *fib_entry;
796 fib_entry_src_t *bsrc;
798 ASSERT(1 == vec_len(rpath));
800 fib_entry = fib_entry_get(fib_entry_index);
801 ASSERT(NULL != fib_entry);
803 bsrc = fib_entry_get_best_src_i(fib_entry);
804 best_source = fib_entry_src_get_source(bsrc);
805 bflags = fib_entry_src_get_flags(bsrc);
807 fib_entry = fib_entry_src_action_path_add(fib_entry, source, flags, rpath);
810 * if the path list for the source passed is invalid,
811 * then we need to create a new one. else we are updating
814 if (source < best_source)
817 * we have a new winning source.
819 fib_entry_src_action_deactivate(fib_entry, best_source);
820 fib_entry_src_action_activate(fib_entry, source);
822 else if (source > best_source)
825 * the new source loses. nothing to do here.
826 * the data from the source is saved in the path-list created
833 * the new source is one this entry already has.
834 * But the path-list was updated, which will contribute new forwarding,
837 fib_entry_src_action_deactivate(fib_entry, source);
838 fib_entry_src_action_activate(fib_entry, source);
841 fib_entry_post_update_actions(fib_entry, source, bflags);
845 * fib_entry_path_remove
847 * remove a path from the entry.
848 * return the fib_entry's index if it is still present, INVALID otherwise.
851 fib_entry_path_remove (fib_node_index_t fib_entry_index,
853 const fib_route_path_t *rpath)
855 fib_entry_src_flag_t sflag;
856 fib_source_t best_source;
857 fib_entry_flag_t bflags;
858 fib_entry_t *fib_entry;
859 fib_entry_src_t *bsrc;
861 ASSERT(1 == vec_len(rpath));
863 fib_entry = fib_entry_get(fib_entry_index);
864 ASSERT(NULL != fib_entry);
866 bsrc = fib_entry_get_best_src_i(fib_entry);
867 best_source = fib_entry_src_get_source(bsrc);
868 bflags = fib_entry_src_get_flags(bsrc);
870 sflag = fib_entry_src_action_path_remove(fib_entry, source, rpath);
873 * if the path list for the source passed is invalid,
874 * then we need to create a new one. else we are updating
877 if (source < best_source )
880 * Que! removing a path from a source that is better than the
881 * one this entry is using.
885 else if (source > best_source )
888 * the source is not the best. nothing to do.
890 return (FIB_ENTRY_SRC_FLAG_ADDED);
895 * removing a path from the path-list we were using.
897 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
900 * the last path from the source was removed.
901 * fallback to lower source
903 bsrc = fib_entry_get_best_src_i(fib_entry);
904 best_source = fib_entry_src_get_source(bsrc);
906 if (FIB_SOURCE_MAX == best_source) {
908 * no more sources left. this entry is toast.
910 fib_entry_src_action_uninstall(fib_entry);
911 fib_entry_post_flag_update_actions(fib_entry, source, bflags);
913 return (FIB_ENTRY_SRC_FLAG_NONE);
917 fib_entry_src_action_activate(fib_entry, best_source);
918 source = best_source;
924 * re-install the new forwarding information
926 fib_entry_src_action_deactivate(fib_entry, source);
927 fib_entry_src_action_activate(fib_entry, source);
931 fib_entry_post_update_actions(fib_entry, source, bflags);
936 return (FIB_ENTRY_SRC_FLAG_ADDED);
940 * fib_entry_special_remove
942 * remove a special source from the entry.
943 * return the fib_entry's index if it is still present, INVALID otherwise.
946 fib_entry_special_remove (fib_node_index_t fib_entry_index,
949 fib_entry_src_flag_t sflag;
950 fib_source_t best_source;
951 fib_entry_flag_t bflags;
952 fib_entry_t *fib_entry;
953 fib_entry_src_t *bsrc;
955 fib_entry = fib_entry_get(fib_entry_index);
956 ASSERT(NULL != fib_entry);
958 bsrc = fib_entry_get_best_src_i(fib_entry);
959 best_source = fib_entry_src_get_source(bsrc);
960 bflags = fib_entry_src_get_flags(bsrc);
962 sflag = fib_entry_src_action_remove(fib_entry, source);
965 * if the path list for the source passed is invalid,
966 * then we need to create a new one. else we are updating
969 if (source < best_source )
972 * Que! removing a path from a source that is better than the
973 * one this entry is using. This can only mean it is a source
974 * this prefix does not have.
976 return (FIB_ENTRY_SRC_FLAG_ADDED);
978 else if (source > best_source ) {
980 * the source is not the best. nothing to do.
982 return (FIB_ENTRY_SRC_FLAG_ADDED);
986 if (!(FIB_ENTRY_SRC_FLAG_ADDED & sflag))
989 * the source was removed. use the next best.
991 bsrc = fib_entry_get_best_src_i(fib_entry);
992 best_source = fib_entry_src_get_source(bsrc);
994 if (FIB_SOURCE_MAX == best_source) {
996 * no more sources left. this entry is toast.
998 fib_entry_src_action_uninstall(fib_entry);
999 fib_entry_post_flag_update_actions(fib_entry, source, bflags);
1001 return (FIB_ENTRY_SRC_FLAG_NONE);
1005 fib_entry_src_action_activate(fib_entry, best_source);
1006 source = best_source;
1012 * re-install the new forwarding information
1014 fib_entry_src_action_reactivate(fib_entry, source);
1018 fib_entry_post_update_actions(fib_entry, source, bflags);
1021 * still have sources
1023 return (FIB_ENTRY_SRC_FLAG_ADDED);
1029 * The source is withdrawing all the paths it provided
1031 fib_entry_src_flag_t
1032 fib_entry_delete (fib_node_index_t fib_entry_index,
1033 fib_source_t source)
1035 return (fib_entry_special_remove(fib_entry_index, source));
1041 * The source has provided a new set of paths that will replace the old.
1044 fib_entry_update (fib_node_index_t fib_entry_index,
1045 fib_source_t source,
1046 fib_entry_flag_t flags,
1047 const fib_route_path_t *paths)
1049 fib_source_t best_source;
1050 fib_entry_flag_t bflags;
1051 fib_entry_t *fib_entry;
1052 fib_entry_src_t *bsrc;
1054 fib_entry = fib_entry_get(fib_entry_index);
1055 ASSERT(NULL != fib_entry);
1057 bsrc = fib_entry_get_best_src_i(fib_entry);
1058 best_source = fib_entry_src_get_source(bsrc);
1059 bflags = fib_entry_src_get_flags(bsrc);
1061 fib_entry_src_action_path_swap(fib_entry,
1066 * handle possible realloc's by refetching the pointer
1068 fib_entry = fib_entry_get(fib_entry_index);
1071 * if the path list for the source passed is invalid,
1072 * then we need to create a new one. else we are updating
1075 if (source < best_source)
1078 * we have a new winning source.
1080 fib_entry_src_action_deactivate(fib_entry, best_source);
1081 fib_entry_src_action_activate(fib_entry, source);
1083 else if (source > best_source) {
1085 * the new source loses. nothing to do here.
1086 * the data from the source is saved in the path-list created
1093 * the new source is one this entry already has.
1094 * But the path-list was updated, which will contribute new forwarding,
1097 fib_entry_src_action_deactivate(fib_entry, source);
1098 fib_entry_src_action_activate(fib_entry, source);
1101 fib_entry_post_update_actions(fib_entry, source, bflags);
1106 * fib_entry_cover_changed
1108 * this entry is tracking its cover and that cover has changed.
1111 fib_entry_cover_changed (fib_node_index_t fib_entry_index)
1113 fib_entry_src_cover_res_t res = {
1115 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1117 fib_source_t source, best_source;
1118 fib_entry_flag_t bflags;
1119 fib_entry_t *fib_entry;
1120 fib_entry_src_t *esrc;
1123 bflags = FIB_ENTRY_FLAG_NONE;
1124 best_source = FIB_SOURCE_FIRST;
1125 fib_entry = fib_entry_get(fib_entry_index);
1127 fib_attached_export_cover_change(fib_entry);
1130 * propagate the notificuation to each of the added sources
1133 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1138 * only the best source gets to set the back walk flags
1140 res = fib_entry_src_action_cover_change(fib_entry, source);
1141 bflags = fib_entry_src_get_flags(esrc);
1142 best_source = fib_entry_src_get_source(esrc);
1146 fib_entry_src_action_cover_change(fib_entry, source);
1153 fib_entry_src_action_reactivate(fib_entry,
1154 fib_entry_src_get_source(
1155 fib_entry_get_best_src_i(fib_entry)));
1156 fib_entry_post_install_actions(fib_entry, best_source, bflags);
1160 fib_entry_src_action_uninstall(fib_entry);
1163 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1166 * time for walkies fido.
1168 fib_node_back_walk_ctx_t bw_ctx = {
1169 .fnbw_reason = res.bw_reason,
1172 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1177 * fib_entry_cover_updated
1179 * this entry is tracking its cover and that cover has been updated
1180 * (i.e. its forwarding information has changed).
1183 fib_entry_cover_updated (fib_node_index_t fib_entry_index)
1185 fib_entry_src_cover_res_t res = {
1187 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
1189 fib_source_t source, best_source;
1190 fib_entry_flag_t bflags;
1191 fib_entry_t *fib_entry;
1192 fib_entry_src_t *esrc;
1195 bflags = FIB_ENTRY_FLAG_NONE;
1196 best_source = FIB_SOURCE_FIRST;
1197 fib_entry = fib_entry_get(fib_entry_index);
1199 fib_attached_export_cover_update(fib_entry);
1202 * propagate the notificuation to each of the added sources
1205 FOR_EACH_SRC_ADDED(fib_entry, esrc, source,
1210 * only the best source gets to set the back walk flags
1212 res = fib_entry_src_action_cover_update(fib_entry, source);
1213 bflags = fib_entry_src_get_flags(esrc);
1214 best_source = fib_entry_src_get_source(esrc);
1218 fib_entry_src_action_cover_update(fib_entry, source);
1225 fib_entry_src_action_reactivate(fib_entry,
1226 fib_entry_src_get_source(
1227 fib_entry_get_best_src_i(fib_entry)));
1228 fib_entry_post_install_actions(fib_entry, best_source, bflags);
1232 fib_entry_src_action_uninstall(fib_entry);
1235 if (FIB_NODE_BW_REASON_FLAG_NONE != res.bw_reason)
1238 * time for walkies fido.
1240 fib_node_back_walk_ctx_t bw_ctx = {
1241 .fnbw_reason = res.bw_reason,
1244 fib_walk_sync(FIB_NODE_TYPE_ENTRY, fib_entry_index, &bw_ctx);
1249 fib_entry_recursive_loop_detect (fib_node_index_t entry_index,
1250 fib_node_index_t **entry_indicies)
1252 fib_entry_t *fib_entry;
1253 int was_looped, is_looped;
1255 fib_entry = fib_entry_get(entry_index);
1257 if (FIB_NODE_INDEX_INVALID != fib_entry->fe_parent)
1259 fib_node_index_t *entries = *entry_indicies;
1261 vec_add1(entries, entry_index);
1262 was_looped = fib_path_list_is_looped(fib_entry->fe_parent);
1263 is_looped = fib_path_list_recursive_loop_detect(fib_entry->fe_parent,
1266 *entry_indicies = entries;
1268 if (!!was_looped != !!is_looped)
1271 * re-evaluate all the entry's forwarding
1272 * NOTE: this is an inplace modify
1274 fib_entry_delegate_type_t fdt;
1275 fib_entry_delegate_t *fed;
1277 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
1279 fib_entry_src_mk_lb(fib_entry,
1280 fib_entry_get_best_src_i(fib_entry),
1281 fib_entry_delegate_type_to_chain_type(fdt),
1289 * the entry is currently not linked to a path-list. this happens
1290 * when it is this entry that is re-linking path-lists and has thus
1300 fib_entry_get_resolving_interface (fib_node_index_t entry_index)
1302 fib_entry_t *fib_entry;
1304 fib_entry = fib_entry_get(entry_index);
1306 return (fib_path_list_get_resolving_interface(fib_entry->fe_parent));
1310 fib_entry_get_best_source (fib_node_index_t entry_index)
1312 fib_entry_t *fib_entry;
1313 fib_entry_src_t *bsrc;
1315 fib_entry = fib_entry_get(entry_index);
1317 bsrc = fib_entry_get_best_src_i(fib_entry);
1318 return (fib_entry_src_get_source(bsrc));
1322 fib_ip4_address_compare (const ip4_address_t * a1,
1323 const ip4_address_t * a2)
1326 * IP addresses are unsiged ints. the return value here needs to be signed
1327 * a simple subtraction won't cut it.
1328 * If the addresses are the same, the sort order is undefiend, so phoey.
1330 return ((clib_net_to_host_u32(a1->data_u32) >
1331 clib_net_to_host_u32(a2->data_u32) ) ?
1336 fib_ip6_address_compare (const ip6_address_t * a1,
1337 const ip6_address_t * a2)
1340 for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1342 int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1343 clib_net_to_host_u16 (a2->as_u16[i]));
1351 fib_entry_cmp (fib_node_index_t fib_entry_index1,
1352 fib_node_index_t fib_entry_index2)
1354 fib_entry_t *fib_entry1, *fib_entry2;
1357 fib_entry1 = fib_entry_get(fib_entry_index1);
1358 fib_entry2 = fib_entry_get(fib_entry_index2);
1360 switch (fib_entry1->fe_prefix.fp_proto)
1362 case FIB_PROTOCOL_IP4:
1363 cmp = fib_ip4_address_compare(&fib_entry1->fe_prefix.fp_addr.ip4,
1364 &fib_entry2->fe_prefix.fp_addr.ip4);
1366 case FIB_PROTOCOL_IP6:
1367 cmp = fib_ip6_address_compare(&fib_entry1->fe_prefix.fp_addr.ip6,
1368 &fib_entry2->fe_prefix.fp_addr.ip6);
1370 case FIB_PROTOCOL_MPLS:
1371 cmp = (fib_entry1->fe_prefix.fp_label - fib_entry2->fe_prefix.fp_label);
1375 cmp = (fib_entry1->fe_prefix.fp_eos - fib_entry2->fe_prefix.fp_eos);
1381 cmp = (fib_entry1->fe_prefix.fp_len - fib_entry2->fe_prefix.fp_len);
1387 fib_entry_cmp_for_sort (void *i1, void *i2)
1389 fib_node_index_t *fib_entry_index1 = i1, *fib_entry_index2 = i2;
1391 return (fib_entry_cmp(*fib_entry_index1,
1392 *fib_entry_index2));
1396 fib_entry_lock (fib_node_index_t fib_entry_index)
1398 fib_entry_t *fib_entry;
1400 fib_entry = fib_entry_get(fib_entry_index);
1402 fib_node_lock(&fib_entry->fe_node);
1406 fib_entry_unlock (fib_node_index_t fib_entry_index)
1408 fib_entry_t *fib_entry;
1410 fib_entry = fib_entry_get(fib_entry_index);
1412 fib_node_unlock(&fib_entry->fe_node);
1416 fib_entry_module_init (void)
1418 fib_node_register_type (FIB_NODE_TYPE_ENTRY, &fib_entry_vft);
1422 fib_entry_encode (fib_node_index_t fib_entry_index,
1423 fib_route_path_encode_t **api_rpaths)
1425 fib_entry_t *fib_entry;
1427 fib_entry = fib_entry_get(fib_entry_index);
1428 fib_path_list_walk(fib_entry->fe_parent, fib_path_encode, api_rpaths);
1432 fib_entry_get_prefix (fib_node_index_t fib_entry_index,
1435 fib_entry_t *fib_entry;
1437 fib_entry = fib_entry_get(fib_entry_index);
1438 *pfx = fib_entry->fe_prefix;
1442 fib_entry_get_fib_index (fib_node_index_t fib_entry_index)
1444 fib_entry_t *fib_entry;
1446 fib_entry = fib_entry_get(fib_entry_index);
1448 return (fib_entry->fe_fib_index);
1452 fib_entry_pool_size (void)
1454 return (pool_elts(fib_entry_pool));
1457 static clib_error_t *
1458 show_fib_entry_command (vlib_main_t * vm,
1459 unformat_input_t * input,
1460 vlib_cli_command_t * cmd)
1462 fib_node_index_t fei;
1464 if (unformat (input, "%d", &fei))
1467 * show one in detail
1469 if (!pool_is_free_index(fib_entry_pool, fei))
1471 vlib_cli_output (vm, "%d@%U",
1473 format_fib_entry, fei,
1474 FIB_ENTRY_FORMAT_DETAIL2);
1478 vlib_cli_output (vm, "entry %d invalid", fei);
1486 vlib_cli_output (vm, "FIB Entries:");
1487 pool_foreach_index(fei, fib_entry_pool,
1489 vlib_cli_output (vm, "%d@%U",
1491 format_fib_entry, fei,
1492 FIB_ENTRY_FORMAT_BRIEF);
1499 VLIB_CLI_COMMAND (show_fib_entry, static) = {
1500 .path = "show fib entry",
1501 .function = show_fib_entry_command,
1502 .short_help = "show fib entry",