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 <vnet/adj/adj.h>
17 #include <vnet/dpo/load_balance.h>
18 #include <vnet/dpo/mpls_label_dpo.h>
19 #include <vnet/dpo/drop_dpo.h>
21 #include <vnet/fib/fib_entry_src.h>
22 #include <vnet/fib/fib_table.h>
23 #include <vnet/fib/fib_path_ext.h>
24 #include <vnet/fib/fib_urpf_list.h>
29 static fib_entry_src_vft_t fib_entry_src_vft[FIB_SOURCE_MAX];
32 fib_entry_get_proto (const fib_entry_t * fib_entry)
34 return (fib_entry->fe_prefix.fp_proto);
38 fib_entry_src_register (fib_source_t source,
39 const fib_entry_src_vft_t *vft)
41 fib_entry_src_vft[source] = *vft;
45 fib_entry_src_cmp_for_sort (void * v1,
48 fib_entry_src_t *esrc1 = v1, *esrc2 = v2;
50 return (esrc1->fes_src - esrc2->fes_src);
54 fib_entry_src_action_init (fib_entry_t *fib_entry,
58 fib_entry_src_t esrc = {
59 .fes_pl = FIB_NODE_INDEX_INVALID,
60 .fes_flags = FIB_ENTRY_SRC_FLAG_NONE,
64 if (NULL != fib_entry_src_vft[source].fesv_init)
66 fib_entry_src_vft[source].fesv_init(&esrc);
69 vec_add1(fib_entry->fe_srcs, esrc);
70 vec_sort_with_function(fib_entry->fe_srcs,
71 fib_entry_src_cmp_for_sort);
74 static fib_entry_src_t *
75 fib_entry_src_find (const fib_entry_t *fib_entry,
80 fib_entry_src_t *esrc;
84 vec_foreach(esrc, fib_entry->fe_srcs)
86 if (esrc->fes_src == source)
104 fib_entry_is_sourced (fib_node_index_t fib_entry_index,
107 fib_entry_t *fib_entry;
109 fib_entry = fib_entry_get(fib_entry_index);
111 return (NULL != fib_entry_src_find(fib_entry, source, NULL));
114 static fib_entry_src_t *
115 fib_entry_src_find_or_create (fib_entry_t *fib_entry,
119 fib_entry_src_t *esrc;
121 esrc = fib_entry_src_find(fib_entry, source, NULL);
125 fib_entry_src_action_init(fib_entry, source);
128 return (fib_entry_src_find(fib_entry, source, NULL));
132 fib_entry_src_action_deinit (fib_entry_t *fib_entry,
136 fib_entry_src_t *esrc;
139 esrc = fib_entry_src_find(fib_entry, source, &index);
141 ASSERT(NULL != esrc);
143 if (NULL != fib_entry_src_vft[source].fesv_deinit)
145 fib_entry_src_vft[source].fesv_deinit(esrc);
148 vec_free(esrc->fes_path_exts);
149 vec_del1(fib_entry->fe_srcs, index);
152 fib_entry_src_cover_res_t
153 fib_entry_src_action_cover_change (fib_entry_t *fib_entry,
156 if (NULL != fib_entry_src_vft[source].fesv_cover_change)
158 return (fib_entry_src_vft[source].fesv_cover_change(
159 fib_entry_src_find(fib_entry, source, NULL),
163 fib_entry_src_cover_res_t res = {
165 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
170 fib_entry_src_cover_res_t
171 fib_entry_src_action_cover_update (fib_entry_t *fib_entry,
174 if (NULL != fib_entry_src_vft[source].fesv_cover_update)
176 return (fib_entry_src_vft[source].fesv_cover_update(
177 fib_entry_src_find(fib_entry, source, NULL),
181 fib_entry_src_cover_res_t res = {
183 .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
188 typedef struct fib_entry_src_collect_forwarding_ctx_t_
190 load_balance_path_t * next_hops;
191 const fib_entry_t *fib_entry;
192 const fib_entry_src_t *esrc;
193 fib_forward_chain_type_t fct;
195 } fib_entry_src_collect_forwarding_ctx_t;
198 * @brief Determine whether this FIB entry should use a load-balance MAP
199 * to support PIC edge fast convergence
202 fib_entry_calc_lb_flags (fib_entry_src_collect_forwarding_ctx_t *ctx)
205 * We'll use a LB map is the path-list has recursive paths.
206 * recursive paths implies BGP, and hence scale.
208 if (ctx->is_recursive)
210 return (LOAD_BALANCE_FLAG_USES_MAP);
212 return (LOAD_BALANCE_FLAG_NONE);
216 fib_entry_src_valid_out_label (mpls_label_t label)
218 return ((MPLS_LABEL_IS_REAL(label) ||
219 MPLS_IETF_IPV4_EXPLICIT_NULL_LABEL == label ||
220 MPLS_IETF_IPV6_EXPLICIT_NULL_LABEL == label ||
221 MPLS_IETF_IMPLICIT_NULL_LABEL == label));
225 * @brief Turn the chain type requested by the client into the one they
228 fib_forward_chain_type_t
229 fib_entry_chain_type_fixup (const fib_entry_t *entry,
230 fib_forward_chain_type_t fct)
232 ASSERT(FIB_FORW_CHAIN_TYPE_MPLS_EOS == fct);
235 * The EOS chain is a tricky since one cannot know the adjacency
236 * to link to without knowing what the packets payload protocol
237 * will be once the label is popped.
239 fib_forward_chain_type_t dfct;
241 dfct = fib_entry_get_default_chain_type(entry);
243 if (FIB_FORW_CHAIN_TYPE_MPLS_EOS == dfct)
246 * If the entry being asked is a eos-MPLS label entry,
247 * then use the payload-protocol field, that we stashed there
248 * for just this purpose
250 return (fib_forw_chain_type_from_dpo_proto(
251 entry->fe_prefix.fp_payload_proto));
254 * else give them what this entry would be by default. i.e. if it's a v6
255 * entry, then the label its local labelled should be carrying v6 traffic.
256 * If it's a non-EOS label entry, then there are more labels and we want
263 fib_entry_src_collect_forwarding (fib_node_index_t pl_index,
264 fib_node_index_t path_index,
267 fib_entry_src_collect_forwarding_ctx_t *ctx;
268 fib_path_ext_t *path_ext;
273 * if the path is not resolved, don't include it.
275 if (!fib_path_is_resolved(path_index))
280 if (fib_path_is_recursive(path_index))
282 ctx->is_recursive = 1;
286 * get the matching path-extension for the path being visited.
288 vec_foreach(path_ext, ctx->esrc->fes_path_exts)
290 if (path_ext->fpe_path_index == path_index)
294 if (NULL != path_ext &&
295 path_ext->fpe_path_index == path_index &&
296 fib_entry_src_valid_out_label(path_ext->fpe_label_stack[0]))
299 * found a matching extension. stack it to obtain the forwarding
300 * info for this path.
302 ctx->next_hops = fib_path_ext_stack(path_ext, ctx->fib_entry, ctx->fct, ctx->next_hops);
306 load_balance_path_t *nh;
309 * no extension => no out-going label for this path. that's OK
310 * in the case of an IP or EOS chain, but not for non-EOS
314 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
315 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
316 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
317 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
319 * EOS traffic with no label to stack, we need the IP Adj
321 vec_add2(ctx->next_hops, nh, 1);
323 nh->path_index = path_index;
324 nh->path_weight = fib_path_get_weight(path_index);
325 fib_path_contribute_forwarding(path_index, ctx->fct, &nh->path_dpo);
328 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
329 if (fib_path_is_exclusive(path_index) ||
330 fib_path_is_deag(path_index))
332 vec_add2(ctx->next_hops, nh, 1);
334 nh->path_index = path_index;
335 nh->path_weight = fib_path_get_weight(path_index);
336 fib_path_contribute_forwarding(path_index,
337 FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
341 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
344 * no label. we need a chain based on the payload. fixup.
346 vec_add2(ctx->next_hops, nh, 1);
348 nh->path_index = path_index;
349 nh->path_weight = fib_path_get_weight(path_index);
350 fib_path_contribute_forwarding(path_index,
351 fib_entry_chain_type_fixup(ctx->fib_entry,
357 case FIB_FORW_CHAIN_TYPE_ETHERNET:
367 fib_entry_src_mk_lb (fib_entry_t *fib_entry,
368 const fib_entry_src_t *esrc,
369 fib_forward_chain_type_t fct,
372 dpo_proto_t lb_proto;
375 * If the entry has path extensions then we construct a load-balance
376 * by stacking the extensions on the forwarding chains of the paths.
377 * Otherwise we use the load-balance of the path-list
379 fib_entry_src_collect_forwarding_ctx_t ctx = {
381 .fib_entry = fib_entry,
388 * As an optimisation we allocate the vector of next-hops to be sized
389 * equal to the maximum nuber of paths we will need, which is also the
390 * most likely number we will need, since in most cases the paths are 'up'.
392 vec_validate(ctx.next_hops, fib_path_list_get_n_paths(esrc->fes_pl));
393 vec_reset_length(ctx.next_hops);
395 lb_proto = fib_proto_to_dpo(fib_entry->fe_prefix.fp_proto);
397 fib_path_list_walk(esrc->fes_pl,
398 fib_entry_src_collect_forwarding,
401 if (esrc->fes_entry_flags & FIB_ENTRY_FLAG_EXCLUSIVE)
404 * the client provided the DPO that the entry should link to.
405 * all entries must link to a LB, so if it is an LB already
406 * then we can use it.
408 if ((1 == vec_len(ctx.next_hops)) &&
409 (DPO_LOAD_BALANCE == ctx.next_hops[0].path_dpo.dpoi_type))
411 dpo_copy(dpo_lb, &ctx.next_hops[0].path_dpo);
412 dpo_reset(&ctx.next_hops[0].path_dpo);
417 if (!dpo_id_is_valid(dpo_lb))
422 flow_hash_config_t fhc;
424 fhc = fib_table_get_flow_hash_config(fib_entry->fe_fib_index,
425 dpo_proto_to_fib(lb_proto));
429 load_balance_create(0, lb_proto, fhc));
432 load_balance_multipath_update(dpo_lb,
434 fib_entry_calc_lb_flags(&ctx));
435 vec_free(ctx.next_hops);
438 * if this entry is sourced by the uRPF-exempt source then we
439 * append the always present local0 interface (index 0) to the
440 * uRPF list so it is not empty. that way packets pass the loose check.
442 index_t ui = fib_path_list_get_urpf(esrc->fes_pl);
444 if (fib_entry_is_sourced(fib_entry_get_index(fib_entry),
445 FIB_SOURCE_URPF_EXEMPT) &&
446 (0 == fib_urpf_check_size(ui)))
449 * The uRPF list we get from the path-list is shared by all
450 * other users of the list, but the uRPF exemption applies
451 * only to this prefix. So we need our own list.
453 ui = fib_urpf_list_alloc_and_lock();
454 fib_urpf_list_append(ui, 0);
455 fib_urpf_list_bake(ui);
456 load_balance_set_urpf(dpo_lb->dpoi_index, ui);
457 fib_urpf_list_unlock(ui);
461 load_balance_set_urpf(dpo_lb->dpoi_index, ui);
463 load_balance_set_fib_entry_flags(dpo_lb->dpoi_index,
464 fib_entry_get_flags_i(fib_entry));
468 fib_entry_src_action_install (fib_entry_t *fib_entry,
472 * Install the forwarding chain for the given source into the forwarding
475 fib_forward_chain_type_t fct;
476 fib_entry_src_t *esrc;
479 fct = fib_entry_get_default_chain_type(fib_entry);
480 esrc = fib_entry_src_find(fib_entry, source, NULL);
483 * Every entry has its own load-balance object. All changes to the entry's
484 * forwarding result in an inplace modify of the load-balance. This means
485 * the load-balance object only needs to be added to the forwarding
486 * DB once, when it is created.
488 insert = !dpo_id_is_valid(&fib_entry->fe_lb);
490 fib_entry_src_mk_lb(fib_entry, esrc, fct, &fib_entry->fe_lb);
492 ASSERT(dpo_id_is_valid(&fib_entry->fe_lb));
493 FIB_ENTRY_DBG(fib_entry, "install: %d", fib_entry->fe_lb);
496 * insert the adj into the data-plane forwarding trie
500 fib_table_fwding_dpo_update(fib_entry->fe_fib_index,
501 &fib_entry->fe_prefix,
506 * if any of the other chain types are already created they will need
509 fib_entry_delegate_type_t fdt;
510 fib_entry_delegate_t *fed;
512 FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
514 fib_entry_src_mk_lb(fib_entry, esrc,
515 fib_entry_delegate_type_to_chain_type(fdt),
521 fib_entry_src_action_uninstall (fib_entry_t *fib_entry)
524 * uninstall the forwarding chain from the forwarding tables
526 FIB_ENTRY_DBG(fib_entry, "uninstall: %d",
527 fib_entry->fe_adj_index);
529 if (dpo_id_is_valid(&fib_entry->fe_lb))
531 fib_table_fwding_dpo_remove(
532 fib_entry->fe_fib_index,
533 &fib_entry->fe_prefix,
536 dpo_reset(&fib_entry->fe_lb);
541 fib_entry_recursive_loop_detect_i (fib_node_index_t path_list_index)
543 fib_node_index_t *entries = NULL;
545 fib_path_list_recursive_loop_detect(path_list_index, &entries);
551 fib_entry_src_action_activate (fib_entry_t *fib_entry,
555 int houston_we_are_go_for_install;
556 fib_entry_src_t *esrc;
558 esrc = fib_entry_src_find(fib_entry, source, NULL);
560 ASSERT(!(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE));
561 ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED);
563 esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ACTIVE;
565 if (NULL != fib_entry_src_vft[source].fesv_activate)
567 houston_we_are_go_for_install =
568 fib_entry_src_vft[source].fesv_activate(esrc, fib_entry);
573 * the source is not providing an activate function, we'll assume
574 * therefore it has no objection to installing the entry
576 houston_we_are_go_for_install = !0;
580 * link to the path-list provided by the source, and go check
581 * if that forms any loops in the graph.
583 fib_entry->fe_parent = esrc->fes_pl;
584 fib_entry->fe_sibling =
585 fib_path_list_child_add(fib_entry->fe_parent,
587 fib_entry_get_index(fib_entry));
589 fib_entry_recursive_loop_detect_i(fib_entry->fe_parent);
591 FIB_ENTRY_DBG(fib_entry, "activate: %d",
592 fib_entry->fe_parent);
594 if (0 != houston_we_are_go_for_install)
596 fib_entry_src_action_install(fib_entry, source);
600 fib_entry_src_action_uninstall(fib_entry);
605 fib_entry_src_action_deactivate (fib_entry_t *fib_entry,
609 fib_node_index_t path_list_index;
610 fib_entry_src_t *esrc;
612 esrc = fib_entry_src_find(fib_entry, source, NULL);
614 ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE);
616 if (NULL != fib_entry_src_vft[source].fesv_deactivate)
618 fib_entry_src_vft[source].fesv_deactivate(esrc, fib_entry);
621 esrc->fes_flags &= ~FIB_ENTRY_SRC_FLAG_ACTIVE;
623 FIB_ENTRY_DBG(fib_entry, "deactivate: %d", fib_entry->fe_parent);
626 * un-link from an old path-list. Check for any loops this will clear
628 path_list_index = fib_entry->fe_parent;
629 fib_entry->fe_parent = FIB_NODE_INDEX_INVALID;
631 fib_entry_recursive_loop_detect_i(path_list_index);
634 * this will unlock the path-list, so it may be invalid thereafter.
636 fib_path_list_child_remove(path_list_index, fib_entry->fe_sibling);
637 fib_entry->fe_sibling = FIB_NODE_INDEX_INVALID;
641 fib_entry_src_action_fwd_update (const fib_entry_t *fib_entry,
644 fib_entry_src_t *esrc;
646 vec_foreach(esrc, fib_entry->fe_srcs)
648 if (NULL != fib_entry_src_vft[esrc->fes_src].fesv_fwd_update)
650 fib_entry_src_vft[esrc->fes_src].fesv_fwd_update(esrc,
658 fib_entry_src_action_reactivate (fib_entry_t *fib_entry,
661 fib_node_index_t path_list_index;
662 fib_entry_src_t *esrc;
664 esrc = fib_entry_src_find(fib_entry, source, NULL);
666 ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE);
668 FIB_ENTRY_DBG(fib_entry, "reactivate: %d to %d",
669 fib_entry->fe_parent,
672 if (fib_entry->fe_parent != esrc->fes_pl)
675 * un-link from an old path-list. Check for any loops this will clear
677 path_list_index = fib_entry->fe_parent;
678 fib_entry->fe_parent = FIB_NODE_INDEX_INVALID;
681 * temporary lock so it doesn't get deleted when this entry is no
684 fib_path_list_lock(path_list_index);
687 * this entry is no longer a child. after unlinking check if any loops
690 fib_path_list_child_remove(path_list_index,
691 fib_entry->fe_sibling);
693 fib_entry_recursive_loop_detect_i(path_list_index);
696 * link to the path-list provided by the source, and go check
697 * if that forms any loops in the graph.
699 fib_entry->fe_parent = esrc->fes_pl;
700 fib_entry->fe_sibling =
701 fib_path_list_child_add(fib_entry->fe_parent,
703 fib_entry_get_index(fib_entry));
705 fib_entry_recursive_loop_detect_i(fib_entry->fe_parent);
706 fib_path_list_unlock(path_list_index);
708 fib_entry_src_action_install(fib_entry, source);
709 fib_entry_src_action_fwd_update(fib_entry, source);
713 fib_entry_src_action_installed (const fib_entry_t *fib_entry,
716 fib_entry_src_t *esrc;
718 esrc = fib_entry_src_find(fib_entry, source, NULL);
720 if (NULL != fib_entry_src_vft[source].fesv_installed)
722 fib_entry_src_vft[source].fesv_installed(esrc,
726 fib_entry_src_action_fwd_update(fib_entry, source);
730 * fib_entry_src_action_add
732 * Adding a source can result in a new fib_entry being created, which
733 * can inturn mean the pool is realloc'd and thus the entry passed as
734 * an argument it also realloc'd
735 * @return the original entry
738 fib_entry_src_action_add (fib_entry_t *fib_entry,
740 fib_entry_flag_t flags,
743 fib_node_index_t fib_entry_index;
744 fib_entry_src_t *esrc;
746 esrc = fib_entry_src_find_or_create(fib_entry, source, NULL);
748 esrc->fes_ref_count++;
750 if (1 != esrc->fes_ref_count)
753 * we only want to add the source on the 0->1 transition
758 esrc->fes_entry_flags = flags;
761 * save variable so we can recover from a fib_entry realloc.
763 fib_entry_index = fib_entry_get_index(fib_entry);
765 if (NULL != fib_entry_src_vft[source].fesv_add)
767 fib_entry_src_vft[source].fesv_add(esrc,
770 fib_entry_get_proto(fib_entry),
774 fib_entry = fib_entry_get(fib_entry_index);
776 esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ADDED;
778 fib_path_list_lock(esrc->fes_pl);
781 * the source owns a lock on the entry
783 fib_entry_lock(fib_entry_get_index(fib_entry));
789 * fib_entry_src_action_update
791 * Adding a source can result in a new fib_entry being created, which
792 * can inturn mean the pool is realloc'd and thus the entry passed as
793 * an argument it also realloc'd
794 * @return the original entry
797 fib_entry_src_action_update (fib_entry_t *fib_entry,
799 fib_entry_flag_t flags,
802 fib_node_index_t fib_entry_index, old_path_list_index;
803 fib_entry_src_t *esrc;
805 esrc = fib_entry_src_find_or_create(fib_entry, source, NULL);
808 return (fib_entry_src_action_add(fib_entry, source, flags, dpo));
810 old_path_list_index = esrc->fes_pl;
811 esrc->fes_entry_flags = flags;
814 * save variable so we can recover from a fib_entry realloc.
816 fib_entry_index = fib_entry_get_index(fib_entry);
818 if (NULL != fib_entry_src_vft[source].fesv_add)
820 fib_entry_src_vft[source].fesv_add(esrc,
823 fib_entry_get_proto(fib_entry),
827 fib_entry = fib_entry_get(fib_entry_index);
829 esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ADDED;
831 fib_path_list_lock(esrc->fes_pl);
832 fib_path_list_unlock(old_path_list_index);
839 fib_entry_src_action_remove (fib_entry_t *fib_entry,
843 fib_node_index_t old_path_list;
844 fib_entry_src_flag_t sflags;
845 fib_entry_src_t *esrc;
847 esrc = fib_entry_src_find(fib_entry, source, NULL);
850 return (FIB_ENTRY_SRC_FLAG_ACTIVE);
852 esrc->fes_ref_count--;
853 sflags = esrc->fes_flags;
855 if (0 != esrc->fes_ref_count)
858 * only remove the source on the 1->0 transisition
863 if (esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE)
865 fib_entry_src_action_deactivate(fib_entry, source);
868 old_path_list = esrc->fes_pl;
870 if (NULL != fib_entry_src_vft[source].fesv_remove)
872 fib_entry_src_vft[source].fesv_remove(esrc);
875 fib_path_list_unlock(old_path_list);
876 fib_entry_unlock(fib_entry_get_index(fib_entry));
878 sflags &= ~FIB_ENTRY_SRC_FLAG_ADDED;
879 fib_entry_src_action_deinit(fib_entry, source);
885 fib_route_recurses_via_self (const fib_prefix_t *prefix,
886 const fib_route_path_t *rpath)
889 * not all zeros next hop &&
890 * is recursive path &&
891 * nexthop is same as the route's address
893 return ((!ip46_address_is_zero(&rpath->frp_addr)) &&
894 (~0 == rpath->frp_sw_if_index) &&
895 (0 == ip46_address_cmp(&rpath->frp_addr, &prefix->fp_addr)));
900 * fib_route_attached_cross_table
902 * Return true the the route is attached via an interface that
903 * is not in the same table as the route
906 fib_route_attached_cross_table (const fib_entry_t *fib_entry,
907 const fib_route_path_t *rpath)
910 * - All zeros next-hop
911 * - a valid interface
912 * - entry's fib index not equeal to interface's index
914 if (ip46_address_is_zero(&rpath->frp_addr) &&
915 (~0 != rpath->frp_sw_if_index) &&
916 (fib_entry->fe_fib_index !=
917 fib_table_get_index_for_sw_if_index(fib_entry_get_proto(fib_entry),
918 rpath->frp_sw_if_index)))
926 * fib_route_attached_cross_table
928 * Return true the the route is attached via an interface that
929 * is not in the same table as the route
932 fib_path_is_attached (const fib_route_path_t *rpath)
935 * - All zeros next-hop
936 * - a valid interface
938 if (ip46_address_is_zero(&rpath->frp_addr) &&
939 (~0 != rpath->frp_sw_if_index))
946 fib_path_list_flags_t
947 fib_entry_src_flags_2_path_list_flags (fib_entry_flag_t eflags)
949 fib_path_list_flags_t plf = FIB_PATH_LIST_FLAG_NONE;
951 if (eflags & FIB_ENTRY_FLAG_DROP)
953 plf |= FIB_PATH_LIST_FLAG_DROP;
955 if (eflags & FIB_ENTRY_FLAG_LOCAL)
957 plf |= FIB_PATH_LIST_FLAG_LOCAL;
959 if (eflags & FIB_ENTRY_FLAG_EXCLUSIVE)
961 plf |= FIB_PATH_LIST_FLAG_EXCLUSIVE;
968 fib_entry_flags_update (const fib_entry_t *fib_entry,
969 const fib_route_path_t *rpath,
970 fib_path_list_flags_t *pl_flags,
971 fib_entry_src_t *esrc)
974 * don't allow the addition of a recursive looped path for prefix
977 if (fib_route_recurses_via_self(&fib_entry->fe_prefix, rpath))
980 * force the install of a drop path-list.
981 * we want the entry to have some path-list, mainly so
982 * the dodgy path can be rmeoved when the source stops playing
985 *pl_flags |= FIB_PATH_LIST_FLAG_DROP;
989 *pl_flags &= ~FIB_PATH_LIST_FLAG_DROP;
992 if ((esrc->fes_src == FIB_SOURCE_API) ||
993 (esrc->fes_src == FIB_SOURCE_CLI))
995 if (fib_path_is_attached(rpath))
997 esrc->fes_entry_flags |= FIB_ENTRY_FLAG_ATTACHED;
1001 esrc->fes_entry_flags &= ~FIB_ENTRY_FLAG_ATTACHED;
1004 if (fib_route_attached_cross_table(fib_entry, rpath))
1006 esrc->fes_entry_flags |= FIB_ENTRY_FLAG_IMPORT;
1010 esrc->fes_entry_flags &= ~FIB_ENTRY_FLAG_IMPORT;
1015 * fib_entry_src_path_ext_add
1017 * append a path extension to the entry's list
1020 fib_entry_src_path_ext_append (fib_entry_src_t *esrc,
1021 const fib_route_path_t *rpath)
1023 if (NULL != rpath->frp_label_stack)
1025 fib_path_ext_t *path_ext;
1027 vec_add2(esrc->fes_path_exts, path_ext, 1);
1029 fib_path_ext_init(path_ext, esrc->fes_pl, rpath);
1034 * fib_entry_src_path_ext_insert
1036 * insert, sorted, a path extension to the entry's list.
1037 * It's not strictly necessary in sort the path extensions, since each
1038 * extension has the path index to which it resolves. However, by being
1039 * sorted the load-balance produced has a deterministic order, not an order
1040 * based on the sequence of extension additions. this is a considerable benefit.
1043 fib_entry_src_path_ext_insert (fib_entry_src_t *esrc,
1044 const fib_route_path_t *rpath)
1046 if (0 == vec_len(esrc->fes_path_exts))
1047 return (fib_entry_src_path_ext_append(esrc, rpath));
1049 if (NULL != rpath->frp_label_stack)
1051 fib_path_ext_t path_ext;
1054 fib_path_ext_init(&path_ext, esrc->fes_pl, rpath);
1056 while (i < vec_len(esrc->fes_path_exts) &&
1057 (fib_path_ext_cmp(&esrc->fes_path_exts[i], rpath) < 0))
1062 vec_insert_elts(esrc->fes_path_exts, &path_ext, 1, i);
1067 * fib_entry_src_action_add
1069 * Adding a source can result in a new fib_entry being created, which
1070 * can inturn mean the pool is realloc'd and thus the entry passed as
1071 * an argument it also realloc'd
1075 fib_entry_src_action_path_add (fib_entry_t *fib_entry,
1076 fib_source_t source,
1077 fib_entry_flag_t flags,
1078 const fib_route_path_t *rpath)
1080 fib_node_index_t old_path_list, fib_entry_index;
1081 fib_path_list_flags_t pl_flags;
1082 fib_path_ext_t *path_ext;
1083 fib_entry_src_t *esrc;
1086 * save variable so we can recover from a fib_entry realloc.
1088 fib_entry_index = fib_entry_get_index(fib_entry);
1090 esrc = fib_entry_src_find(fib_entry, source, NULL);
1094 fib_entry_src_action_add(fib_entry,
1099 fib_entry_get_proto(fib_entry))));
1100 esrc = fib_entry_src_find(fib_entry, source, NULL);
1104 * we are no doubt modifying a path-list. If the path-list
1105 * is shared, and hence not modifiable, then the index returned
1106 * will be for a different path-list. This FIB entry to needs
1107 * to maintain its lock appropriately.
1109 old_path_list = esrc->fes_pl;
1111 ASSERT(NULL != fib_entry_src_vft[source].fesv_path_add);
1113 pl_flags = fib_entry_src_flags_2_path_list_flags(fib_entry_get_flags_i(fib_entry));
1114 fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1116 fib_entry_src_vft[source].fesv_path_add(esrc, fib_entry, pl_flags, rpath);
1117 fib_entry = fib_entry_get(fib_entry_index);
1120 * re-resolve all the path-extensions with the new path-list
1122 vec_foreach(path_ext, esrc->fes_path_exts)
1124 fib_path_ext_resolve(path_ext, esrc->fes_pl);
1127 * if the path has a label we need to add a path extension
1129 fib_entry_src_path_ext_insert(esrc, rpath);
1131 fib_path_list_lock(esrc->fes_pl);
1132 fib_path_list_unlock(old_path_list);
1138 * fib_entry_src_action_swap
1140 * The source is providing new paths to replace the old ones.
1141 * Adding a source can result in a new fib_entry being created, which
1142 * can inturn mean the pool is realloc'd and thus the entry passed as
1143 * an argument it also realloc'd
1147 fib_entry_src_action_path_swap (fib_entry_t *fib_entry,
1148 fib_source_t source,
1149 fib_entry_flag_t flags,
1150 const fib_route_path_t *rpaths)
1152 fib_node_index_t old_path_list, fib_entry_index;
1153 fib_path_list_flags_t pl_flags;
1154 const fib_route_path_t *rpath;
1155 fib_path_ext_t *path_ext;
1156 fib_entry_src_t *esrc;
1158 esrc = fib_entry_src_find(fib_entry, source, NULL);
1161 * save variable so we can recover from a fib_entry realloc.
1163 fib_entry_index = fib_entry_get_index(fib_entry);
1167 fib_entry = fib_entry_src_action_add(fib_entry,
1172 fib_entry_get_proto(fib_entry))));
1173 esrc = fib_entry_src_find(fib_entry, source, NULL);
1177 * swapping paths may create a new path-list (or may use an existing shared)
1178 * but we are certainly getting a different one. This FIB entry to needs
1179 * to maintain its lock appropriately.
1181 old_path_list = esrc->fes_pl;
1183 ASSERT(NULL != fib_entry_src_vft[source].fesv_path_swap);
1185 pl_flags = fib_entry_src_flags_2_path_list_flags(flags);
1187 vec_foreach(rpath, rpaths)
1189 fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1192 fib_entry_src_vft[source].fesv_path_swap(esrc,
1197 vec_foreach(path_ext, esrc->fes_path_exts)
1199 vec_free(path_ext->fpe_label_stack);
1201 vec_free(esrc->fes_path_exts);
1203 vec_foreach(rpath, rpaths)
1205 fib_entry_src_path_ext_append(esrc, rpath);
1208 fib_entry = fib_entry_get(fib_entry_index);
1210 fib_path_list_lock(esrc->fes_pl);
1211 fib_path_list_unlock(old_path_list);
1216 fib_entry_src_flag_t
1217 fib_entry_src_action_path_remove (fib_entry_t *fib_entry,
1218 fib_source_t source,
1219 const fib_route_path_t *rpath)
1221 fib_path_list_flags_t pl_flags;
1222 fib_node_index_t old_path_list;
1223 fib_path_ext_t *path_ext;
1224 fib_entry_src_t *esrc;
1226 esrc = fib_entry_src_find(fib_entry, source, NULL);
1228 ASSERT(NULL != esrc);
1229 ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED);
1232 * we no doubt modifying a path-list. If the path-list
1233 * is shared, and hence not modifiable, then the index returned
1234 * will be for a different path-list. This FIB entry to needs
1235 * to maintain its lock appropriately.
1237 old_path_list = esrc->fes_pl;
1239 ASSERT(NULL != fib_entry_src_vft[source].fesv_path_remove);
1241 pl_flags = fib_entry_src_flags_2_path_list_flags(fib_entry_get_flags_i(fib_entry));
1242 fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1244 fib_entry_src_vft[source].fesv_path_remove(esrc, pl_flags, rpath);
1246 * find the matching path extension and remove it
1248 vec_foreach(path_ext, esrc->fes_path_exts)
1250 if (!fib_path_ext_cmp(path_ext, rpath))
1253 * delete the element moving the remaining elements down 1 position.
1254 * this preserves the sorted order.
1256 vec_free(path_ext->fpe_label_stack);
1257 vec_delete(esrc->fes_path_exts, 1, (path_ext - esrc->fes_path_exts));
1262 * re-resolve all the path-extensions with the new path-list
1264 vec_foreach(path_ext, esrc->fes_path_exts)
1266 fib_path_ext_resolve(path_ext, esrc->fes_pl);
1270 * lock the new path-list, unlock the old if it had one
1272 fib_path_list_unlock(old_path_list);
1274 if (FIB_NODE_INDEX_INVALID != esrc->fes_pl) {
1275 fib_path_list_lock(esrc->fes_pl);
1276 return (FIB_ENTRY_SRC_FLAG_ADDED);
1281 * no more paths left from this source
1283 fib_entry_src_action_remove(fib_entry, source);
1284 return (FIB_ENTRY_SRC_FLAG_NONE);
1289 fib_entry_src_format (fib_entry_t *fib_entry,
1290 fib_source_t source,
1293 fib_entry_src_t *esrc;
1295 esrc = fib_entry_src_find(fib_entry, source, NULL);
1297 if (NULL != fib_entry_src_vft[source].fesv_format)
1299 return (fib_entry_src_vft[source].fesv_format(esrc, s));
1305 fib_entry_get_adj_for_source (fib_node_index_t fib_entry_index,
1306 fib_source_t source)
1308 fib_entry_t *fib_entry;
1309 fib_entry_src_t *esrc;
1311 if (FIB_NODE_INDEX_INVALID == fib_entry_index)
1312 return (ADJ_INDEX_INVALID);
1314 fib_entry = fib_entry_get(fib_entry_index);
1315 esrc = fib_entry_src_find(fib_entry, source, NULL);
1319 if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1321 return (fib_path_list_get_adj(
1323 fib_entry_get_default_chain_type(fib_entry)));
1326 return (ADJ_INDEX_INVALID);
1330 fib_entry_get_dpo_for_source (fib_node_index_t fib_entry_index,
1331 fib_source_t source,
1334 fib_entry_t *fib_entry;
1335 fib_entry_src_t *esrc;
1337 if (FIB_NODE_INDEX_INVALID == fib_entry_index)
1340 fib_entry = fib_entry_get(fib_entry_index);
1341 esrc = fib_entry_src_find(fib_entry, source, NULL);
1345 if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1347 fib_path_list_contribute_forwarding(
1349 fib_entry_get_default_chain_type(fib_entry),
1352 return (dpo_id_is_valid(dpo));
1359 fib_entry_get_resolving_interface_for_source (fib_node_index_t entry_index,
1360 fib_source_t source)
1362 fib_entry_t *fib_entry;
1363 fib_entry_src_t *esrc;
1365 fib_entry = fib_entry_get(entry_index);
1367 esrc = fib_entry_src_find(fib_entry, source, NULL);
1371 if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1373 return (fib_path_list_get_resolving_interface(esrc->fes_pl));
1380 fib_entry_get_flags_for_source (fib_node_index_t entry_index,
1381 fib_source_t source)
1383 fib_entry_t *fib_entry;
1384 fib_entry_src_t *esrc;
1386 fib_entry = fib_entry_get(entry_index);
1388 esrc = fib_entry_src_find(fib_entry, source, NULL);
1392 return (esrc->fes_entry_flags);
1395 return (FIB_ENTRY_FLAG_NONE);
1399 fib_entry_get_flags_i (const fib_entry_t *fib_entry)
1401 fib_entry_flag_t flags;
1404 * the vector of sources is deliberately arranged in priority order
1406 if (0 == vec_len(fib_entry->fe_srcs))
1408 flags = FIB_ENTRY_FLAG_NONE;
1412 fib_entry_src_t *esrc;
1414 esrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
1415 flags = esrc->fes_entry_flags;
1422 fib_entry_set_source_data (fib_node_index_t fib_entry_index,
1423 fib_source_t source,
1426 fib_entry_t *fib_entry;
1427 fib_entry_src_t *esrc;
1429 fib_entry = fib_entry_get(fib_entry_index);
1430 esrc = fib_entry_src_find(fib_entry, source, NULL);
1433 NULL != fib_entry_src_vft[source].fesv_set_data)
1435 fib_entry_src_vft[source].fesv_set_data(esrc, fib_entry, data);
1440 fib_entry_get_source_data (fib_node_index_t fib_entry_index,
1441 fib_source_t source)
1443 fib_entry_t *fib_entry;
1444 fib_entry_src_t *esrc;
1446 fib_entry = fib_entry_get(fib_entry_index);
1447 esrc = fib_entry_src_find(fib_entry, source, NULL);
1450 NULL != fib_entry_src_vft[source].fesv_get_data)
1452 return (fib_entry_src_vft[source].fesv_get_data(esrc, fib_entry));
1458 fib_entry_src_module_init (void)
1460 fib_entry_src_rr_register();
1461 fib_entry_src_interface_register();
1462 fib_entry_src_default_route_register();
1463 fib_entry_src_special_register();
1464 fib_entry_src_api_register();
1465 fib_entry_src_adj_register();
1466 fib_entry_src_mpls_register();
1467 fib_entry_src_lisp_register();