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/vnet.h>
18 #include <vnet/ip/format.h>
19 #include <vnet/ip/ip.h>
20 #include <vnet/dpo/drop_dpo.h>
21 #include <vnet/dpo/receive_dpo.h>
22 #include <vnet/dpo/load_balance_map.h>
23 #include <vnet/dpo/lookup_dpo.h>
24 #include <vnet/dpo/interface_dpo.h>
25 #include <vnet/dpo/mpls_disposition.h>
27 #include <vnet/adj/adj.h>
28 #include <vnet/adj/adj_mcast.h>
30 #include <vnet/fib/fib_path.h>
31 #include <vnet/fib/fib_node.h>
32 #include <vnet/fib/fib_table.h>
33 #include <vnet/fib/fib_entry.h>
34 #include <vnet/fib/fib_path_list.h>
35 #include <vnet/fib/fib_internal.h>
36 #include <vnet/fib/fib_urpf_list.h>
37 #include <vnet/fib/mpls_fib.h>
40 * Enurmeration of path types
42 typedef enum fib_path_type_t_ {
44 * Marker. Add new types after this one.
46 FIB_PATH_TYPE_FIRST = 0,
48 * Attached-nexthop. An interface and a nexthop are known.
50 FIB_PATH_TYPE_ATTACHED_NEXT_HOP = FIB_PATH_TYPE_FIRST,
52 * attached. Only the interface is known.
54 FIB_PATH_TYPE_ATTACHED,
56 * recursive. Only the next-hop is known.
58 FIB_PATH_TYPE_RECURSIVE,
60 * special. nothing is known. so we drop.
62 FIB_PATH_TYPE_SPECIAL,
64 * exclusive. user provided adj.
66 FIB_PATH_TYPE_EXCLUSIVE,
68 * deag. Link to a lookup adj in the next table
74 FIB_PATH_TYPE_INTF_RX,
76 * receive. it's for-us.
78 FIB_PATH_TYPE_RECEIVE,
80 * Marker. Add new types before this one, then update it.
82 FIB_PATH_TYPE_LAST = FIB_PATH_TYPE_RECEIVE,
83 } __attribute__ ((packed)) fib_path_type_t;
86 * The maximum number of path_types
88 #define FIB_PATH_TYPE_MAX (FIB_PATH_TYPE_LAST + 1)
90 #define FIB_PATH_TYPES { \
91 [FIB_PATH_TYPE_ATTACHED_NEXT_HOP] = "attached-nexthop", \
92 [FIB_PATH_TYPE_ATTACHED] = "attached", \
93 [FIB_PATH_TYPE_RECURSIVE] = "recursive", \
94 [FIB_PATH_TYPE_SPECIAL] = "special", \
95 [FIB_PATH_TYPE_EXCLUSIVE] = "exclusive", \
96 [FIB_PATH_TYPE_DEAG] = "deag", \
97 [FIB_PATH_TYPE_INTF_RX] = "intf-rx", \
98 [FIB_PATH_TYPE_RECEIVE] = "receive", \
101 #define FOR_EACH_FIB_PATH_TYPE(_item) \
102 for (_item = FIB_PATH_TYPE_FIRST; _item <= FIB_PATH_TYPE_LAST; _item++)
105 * Enurmeration of path operational (i.e. derived) attributes
107 typedef enum fib_path_oper_attribute_t_ {
109 * Marker. Add new types after this one.
111 FIB_PATH_OPER_ATTRIBUTE_FIRST = 0,
113 * The path forms part of a recursive loop.
115 FIB_PATH_OPER_ATTRIBUTE_RECURSIVE_LOOP = FIB_PATH_OPER_ATTRIBUTE_FIRST,
117 * The path is resolved
119 FIB_PATH_OPER_ATTRIBUTE_RESOLVED,
121 * The path is attached, despite what the next-hop may say.
123 FIB_PATH_OPER_ATTRIBUTE_ATTACHED,
125 * The path has become a permanent drop.
127 FIB_PATH_OPER_ATTRIBUTE_DROP,
129 * Marker. Add new types before this one, then update it.
131 FIB_PATH_OPER_ATTRIBUTE_LAST = FIB_PATH_OPER_ATTRIBUTE_DROP,
132 } __attribute__ ((packed)) fib_path_oper_attribute_t;
135 * The maximum number of path operational attributes
137 #define FIB_PATH_OPER_ATTRIBUTE_MAX (FIB_PATH_OPER_ATTRIBUTE_LAST + 1)
139 #define FIB_PATH_OPER_ATTRIBUTES { \
140 [FIB_PATH_OPER_ATTRIBUTE_RECURSIVE_LOOP] = "recursive-loop", \
141 [FIB_PATH_OPER_ATTRIBUTE_RESOLVED] = "resolved", \
142 [FIB_PATH_OPER_ATTRIBUTE_DROP] = "drop", \
145 #define FOR_EACH_FIB_PATH_OPER_ATTRIBUTE(_item) \
146 for (_item = FIB_PATH_OPER_ATTRIBUTE_FIRST; \
147 _item <= FIB_PATH_OPER_ATTRIBUTE_LAST; \
151 * Path flags from the attributes
153 typedef enum fib_path_oper_flags_t_ {
154 FIB_PATH_OPER_FLAG_NONE = 0,
155 FIB_PATH_OPER_FLAG_RECURSIVE_LOOP = (1 << FIB_PATH_OPER_ATTRIBUTE_RECURSIVE_LOOP),
156 FIB_PATH_OPER_FLAG_DROP = (1 << FIB_PATH_OPER_ATTRIBUTE_DROP),
157 FIB_PATH_OPER_FLAG_RESOLVED = (1 << FIB_PATH_OPER_ATTRIBUTE_RESOLVED),
158 FIB_PATH_OPER_FLAG_ATTACHED = (1 << FIB_PATH_OPER_ATTRIBUTE_ATTACHED),
159 } __attribute__ ((packed)) fib_path_oper_flags_t;
164 typedef struct fib_path_t_ {
166 * A path is a node in the FIB graph.
171 * The index of the path-list to which this path belongs
176 * This marks the start of the memory area used to hash
179 STRUCT_MARK(path_hash_start);
182 * Configuration Flags
184 fib_path_cfg_flags_t fp_cfg_flags;
187 * The type of the path. This is the selector for the union
189 fib_path_type_t fp_type;
192 * The protocol of the next-hop, i.e. the address family of the
193 * next-hop's address. We can't derive this from the address itself
194 * since the address can be all zeros
196 fib_protocol_t fp_nh_proto;
199 * UCMP [unnormalised] weigth
204 * A path preference. 0 is the best.
205 * Only paths of the best preference, that are 'up', are considered
211 * per-type union of the data required to resolve the path
218 ip46_address_t fp_nh;
236 ip46_address_t fp_ip;
239 * The local label to resolve through.
241 mpls_label_t fp_local_label;
243 * The EOS bit of the resolving label
245 mpls_eos_bit_t fp_eos;
249 * The FIB table index in which to find the next-hop.
251 fib_node_index_t fp_tbl_id;
255 * The FIB index in which to perfom the next lookup
257 fib_node_index_t fp_tbl_id;
259 * The RPF-ID to tag the packets with
261 fib_rpf_id_t fp_rpf_id;
267 * The user provided 'exclusive' DPO
273 * The interface on which the local address is configured
279 ip46_address_t fp_addr;
283 * The interface on which the packets will be input.
288 STRUCT_MARK(path_hash_end);
291 * Memebers in this last section represent information that is
292 * dervied during resolution. It should not be copied to new paths
299 fib_path_oper_flags_t fp_oper_flags;
302 * the resolving via fib. not part of the union, since it it not part
303 * of the path's hash.
305 fib_node_index_t fp_via_fib;
308 * The Data-path objects through which this path resolves for IP.
313 * the index of this path in the parent's child list.
319 * Array of strings/names for the path types and attributes
321 static const char *fib_path_type_names[] = FIB_PATH_TYPES;
322 static const char *fib_path_oper_attribute_names[] = FIB_PATH_OPER_ATTRIBUTES;
323 static const char *fib_path_cfg_attribute_names[] = FIB_PATH_CFG_ATTRIBUTES;
326 * The memory pool from which we allocate all the paths
328 static fib_path_t *fib_path_pool;
334 #define FIB_PATH_DBG(_p, _fmt, _args...) \
337 _tmp = fib_path_format(fib_path_get_index(_p), _tmp); \
338 clib_warning("path:[%d:%s]:" _fmt, \
339 fib_path_get_index(_p), _tmp, \
344 #define FIB_PATH_DBG(_p, _fmt, _args...)
348 fib_path_get (fib_node_index_t index)
350 return (pool_elt_at_index(fib_path_pool, index));
353 static fib_node_index_t
354 fib_path_get_index (fib_path_t *path)
356 return (path - fib_path_pool);
360 fib_path_get_node (fib_node_index_t index)
362 return ((fib_node_t*)fib_path_get(index));
366 fib_path_from_fib_node (fib_node_t *node)
369 ASSERT(FIB_NODE_TYPE_PATH == node->fn_type);
371 return ((fib_path_t*)node);
375 format_fib_path (u8 * s, va_list * args)
377 fib_path_t *path = va_arg (*args, fib_path_t *);
378 vnet_main_t * vnm = vnet_get_main();
379 fib_path_oper_attribute_t oattr;
380 fib_path_cfg_attribute_t cattr;
382 s = format (s, " index:%d ", fib_path_get_index(path));
383 s = format (s, "pl-index:%d ", path->fp_pl_index);
384 s = format (s, "%U ", format_fib_protocol, path->fp_nh_proto);
385 s = format (s, "weight=%d ", path->fp_weight);
386 s = format (s, "pref=%d ", path->fp_preference);
387 s = format (s, "%s: ", fib_path_type_names[path->fp_type]);
388 if (FIB_PATH_OPER_FLAG_NONE != path->fp_oper_flags) {
389 s = format(s, " oper-flags:");
390 FOR_EACH_FIB_PATH_OPER_ATTRIBUTE(oattr) {
391 if ((1<<oattr) & path->fp_oper_flags) {
392 s = format (s, "%s,", fib_path_oper_attribute_names[oattr]);
396 if (FIB_PATH_CFG_FLAG_NONE != path->fp_cfg_flags) {
397 s = format(s, " cfg-flags:");
398 FOR_EACH_FIB_PATH_CFG_ATTRIBUTE(cattr) {
399 if ((1<<cattr) & path->fp_cfg_flags) {
400 s = format (s, "%s,", fib_path_cfg_attribute_names[cattr]);
404 s = format(s, "\n ");
406 switch (path->fp_type)
408 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
409 s = format (s, "%U", format_ip46_address,
410 &path->attached_next_hop.fp_nh,
412 if (path->fp_oper_flags & FIB_PATH_OPER_FLAG_DROP)
414 s = format (s, " if_index:%d", path->attached_next_hop.fp_interface);
418 s = format (s, " %U",
419 format_vnet_sw_interface_name,
421 vnet_get_sw_interface(
423 path->attached_next_hop.fp_interface));
424 if (vnet_sw_interface_is_p2p(vnet_get_main(),
425 path->attached_next_hop.fp_interface))
427 s = format (s, " (p2p)");
430 if (!dpo_id_is_valid(&path->fp_dpo))
432 s = format(s, "\n unresolved");
436 s = format(s, "\n %U",
441 case FIB_PATH_TYPE_ATTACHED:
442 if (path->fp_oper_flags & FIB_PATH_OPER_FLAG_DROP)
444 s = format (s, " if_index:%d", path->attached_next_hop.fp_interface);
448 s = format (s, " %U",
449 format_vnet_sw_interface_name,
451 vnet_get_sw_interface(
453 path->attached.fp_interface));
456 case FIB_PATH_TYPE_RECURSIVE:
457 if (FIB_PROTOCOL_MPLS == path->fp_nh_proto)
459 s = format (s, "via %U %U",
460 format_mpls_unicast_label,
461 path->recursive.fp_nh.fp_local_label,
463 path->recursive.fp_nh.fp_eos);
467 s = format (s, "via %U",
469 &path->recursive.fp_nh.fp_ip,
472 s = format (s, " in fib:%d",
473 path->recursive.fp_tbl_id,
475 s = format (s, " via-fib:%d", path->fp_via_fib);
476 s = format (s, " via-dpo:[%U:%d]",
477 format_dpo_type, path->fp_dpo.dpoi_type,
478 path->fp_dpo.dpoi_index);
481 case FIB_PATH_TYPE_RECEIVE:
482 case FIB_PATH_TYPE_INTF_RX:
483 case FIB_PATH_TYPE_SPECIAL:
484 case FIB_PATH_TYPE_DEAG:
485 case FIB_PATH_TYPE_EXCLUSIVE:
486 if (dpo_id_is_valid(&path->fp_dpo))
488 s = format(s, "%U", format_dpo_id,
497 fib_path_format (fib_node_index_t pi, u8 *s)
501 path = fib_path_get(pi);
502 ASSERT(NULL != path);
504 return (format (s, "%U", format_fib_path, path));
508 fib_path_adj_format (fib_node_index_t pi,
514 path = fib_path_get(pi);
515 ASSERT(NULL != path);
517 if (!dpo_id_is_valid(&path->fp_dpo))
519 s = format(s, " unresolved");
523 s = format(s, "%U", format_dpo_id,
531 * fib_path_last_lock_gone
533 * We don't share paths, we share path lists, so the [un]lock functions
537 fib_path_last_lock_gone (fib_node_t *node)
542 static const adj_index_t
543 fib_path_attached_next_hop_get_adj (fib_path_t *path,
546 if (vnet_sw_interface_is_p2p(vnet_get_main(),
547 path->attached_next_hop.fp_interface))
550 * if the interface is p2p then the adj for the specific
551 * neighbour on that link will never exist. on p2p links
552 * the subnet address (the attached route) links to the
553 * auto-adj (see below), we want that adj here too.
555 return (adj_nbr_add_or_lock(path->fp_nh_proto,
558 path->attached_next_hop.fp_interface));
562 return (adj_nbr_add_or_lock(path->fp_nh_proto,
564 &path->attached_next_hop.fp_nh,
565 path->attached_next_hop.fp_interface));
570 fib_path_attached_next_hop_set (fib_path_t *path)
573 * resolve directly via the adjacnecy discribed by the
574 * interface and next-hop
576 dpo_set(&path->fp_dpo,
578 fib_proto_to_dpo(path->fp_nh_proto),
579 fib_path_attached_next_hop_get_adj(
581 fib_proto_to_link(path->fp_nh_proto)));
584 * become a child of the adjacency so we receive updates
585 * when its rewrite changes
587 path->fp_sibling = adj_child_add(path->fp_dpo.dpoi_index,
589 fib_path_get_index(path));
591 if (!vnet_sw_interface_is_admin_up(vnet_get_main(),
592 path->attached_next_hop.fp_interface) ||
593 !adj_is_up(path->fp_dpo.dpoi_index))
595 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
599 static const adj_index_t
600 fib_path_attached_get_adj (fib_path_t *path,
603 if (vnet_sw_interface_is_p2p(vnet_get_main(),
604 path->attached.fp_interface))
607 * point-2-point interfaces do not require a glean, since
608 * there is nothing to ARP. Install a rewrite/nbr adj instead
610 return (adj_nbr_add_or_lock(path->fp_nh_proto,
613 path->attached.fp_interface));
617 return (adj_glean_add_or_lock(path->fp_nh_proto,
618 path->attached.fp_interface,
624 * create of update the paths recursive adj
627 fib_path_recursive_adj_update (fib_path_t *path,
628 fib_forward_chain_type_t fct,
631 dpo_id_t via_dpo = DPO_INVALID;
634 * get the DPO to resolve through from the via-entry
636 fib_entry_contribute_forwarding(path->fp_via_fib,
642 * hope for the best - clear if restrictions apply.
644 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RESOLVED;
647 * Validate any recursion constraints and over-ride the via
650 if (path->fp_oper_flags & FIB_PATH_OPER_FLAG_RECURSIVE_LOOP)
652 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
653 dpo_copy(&via_dpo, drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
655 else if (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_RESOLVE_HOST)
658 * the via FIB must be a host route.
659 * note the via FIB just added will always be a host route
660 * since it is an RR source added host route. So what we need to
661 * check is whether the route has other sources. If it does then
662 * some other source has added it as a host route. If it doesn't
663 * then it was added only here and inherits forwarding from a cover.
664 * the cover is not a host route.
665 * The RR source is the lowest priority source, so we check if it
666 * is the best. if it is there are no other sources.
668 if (fib_entry_get_best_source(path->fp_via_fib) >= FIB_SOURCE_RR)
670 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
671 dpo_copy(&via_dpo, drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
674 * PIC edge trigger. let the load-balance maps know
676 load_balance_map_path_state_change(fib_path_get_index(path));
679 else if (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED)
682 * RR source entries inherit the flags from the cover, so
683 * we can check the via directly
685 if (!(FIB_ENTRY_FLAG_ATTACHED & fib_entry_get_flags(path->fp_via_fib)))
687 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
688 dpo_copy(&via_dpo, drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
691 * PIC edge trigger. let the load-balance maps know
693 load_balance_map_path_state_change(fib_path_get_index(path));
697 * check for over-riding factors on the FIB entry itself
699 if (!fib_entry_is_resolved(path->fp_via_fib))
701 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
702 dpo_copy(&via_dpo, drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
705 * PIC edge trigger. let the load-balance maps know
707 load_balance_map_path_state_change(fib_path_get_index(path));
711 * If this path is contributing a drop, then it's not resolved
713 if (dpo_is_drop(&via_dpo) || load_balance_is_drop(&via_dpo))
715 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
719 * update the path's contributed DPO
721 dpo_copy(dpo, &via_dpo);
723 FIB_PATH_DBG(path, "recursive update: %U",
724 fib_get_lookup_main(path->fp_nh_proto),
731 * fib_path_is_permanent_drop
733 * Return !0 if the path is configured to permanently drop,
734 * despite other attributes.
737 fib_path_is_permanent_drop (fib_path_t *path)
739 return ((path->fp_cfg_flags & FIB_PATH_CFG_FLAG_DROP) ||
740 (path->fp_oper_flags & FIB_PATH_OPER_FLAG_DROP));
746 * Remove our dependency on the resolution target
749 fib_path_unresolve (fib_path_t *path)
752 * the forced drop path does not need unresolving
754 if (fib_path_is_permanent_drop(path))
759 switch (path->fp_type)
761 case FIB_PATH_TYPE_RECURSIVE:
762 if (FIB_NODE_INDEX_INVALID != path->fp_via_fib)
766 fib_entry_get_prefix(path->fp_via_fib, &pfx);
767 fib_entry_child_remove(path->fp_via_fib,
769 fib_table_entry_special_remove(path->recursive.fp_tbl_id,
772 path->fp_via_fib = FIB_NODE_INDEX_INVALID;
775 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
776 case FIB_PATH_TYPE_ATTACHED:
777 adj_child_remove(path->fp_dpo.dpoi_index,
779 adj_unlock(path->fp_dpo.dpoi_index);
781 case FIB_PATH_TYPE_EXCLUSIVE:
782 dpo_reset(&path->exclusive.fp_ex_dpo);
784 case FIB_PATH_TYPE_SPECIAL:
785 case FIB_PATH_TYPE_RECEIVE:
786 case FIB_PATH_TYPE_INTF_RX:
787 case FIB_PATH_TYPE_DEAG:
789 * these hold only the path's DPO, which is reset below.
795 * release the adj we were holding and pick up the
798 dpo_reset(&path->fp_dpo);
799 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
804 static fib_forward_chain_type_t
805 fib_path_to_chain_type (const fib_path_t *path)
807 switch (path->fp_nh_proto)
809 case FIB_PROTOCOL_IP4:
810 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
811 case FIB_PROTOCOL_IP6:
812 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP6);
813 case FIB_PROTOCOL_MPLS:
814 if (FIB_PATH_TYPE_RECURSIVE == path->fp_type &&
815 MPLS_EOS == path->recursive.fp_nh.fp_eos)
817 return (FIB_FORW_CHAIN_TYPE_MPLS_EOS);
821 return (FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS);
824 return (FIB_FORW_CHAIN_TYPE_UNICAST_IP4);
828 * fib_path_back_walk_notify
830 * A back walk has reach this path.
832 static fib_node_back_walk_rc_t
833 fib_path_back_walk_notify (fib_node_t *node,
834 fib_node_back_walk_ctx_t *ctx)
838 path = fib_path_from_fib_node(node);
840 switch (path->fp_type)
842 case FIB_PATH_TYPE_RECURSIVE:
843 if (FIB_NODE_BW_REASON_FLAG_EVALUATE & ctx->fnbw_reason)
846 * modify the recursive adjacency to use the new forwarding
848 * this update is visible to packets in flight in the DP.
850 fib_path_recursive_adj_update(
852 fib_path_to_chain_type(path),
855 if ((FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE & ctx->fnbw_reason) ||
856 (FIB_NODE_BW_REASON_FLAG_ADJ_DOWN & ctx->fnbw_reason))
859 * ADJ updates (complete<->incomplete) do not need to propagate to
861 * The only reason its needed as far back as here, is that the adj
862 * and the incomplete adj are a different DPO type, so the LBs need
864 * If this walk was quashed in the fib_entry, then any non-fib_path
865 * children (like tunnels that collapse out the LB when they stack)
866 * would not see the update.
868 return (FIB_NODE_BACK_WALK_CONTINUE);
871 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
874 * ADJ_UPDATE backwalk pass silently through here and up to
875 * the path-list when the multipath adj collapse occurs.
876 * The reason we do this is that the assumtption is that VPP
877 * runs in an environment where the Control-Plane is remote
878 * and hence reacts slowly to link up down. In order to remove
879 * this down link from the ECMP set quickly, we back-walk.
880 * VPP also has dedicated CPUs, so we are not stealing resources
881 * from the CP to do so.
883 if (FIB_NODE_BW_REASON_FLAG_INTERFACE_UP & ctx->fnbw_reason)
885 if (path->fp_oper_flags & FIB_PATH_OPER_FLAG_RESOLVED)
888 * alreday resolved. no need to walk back again
890 return (FIB_NODE_BACK_WALK_CONTINUE);
892 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RESOLVED;
894 if (FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN & ctx->fnbw_reason)
896 if (!(path->fp_oper_flags & FIB_PATH_OPER_FLAG_RESOLVED))
899 * alreday unresolved. no need to walk back again
901 return (FIB_NODE_BACK_WALK_CONTINUE);
903 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
905 if (FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE & ctx->fnbw_reason)
908 * The interface this path resolves through has been deleted.
909 * This will leave the path in a permanent drop state. The route
910 * needs to be removed and readded (and hence the path-list deleted)
911 * before it can forward again.
913 fib_path_unresolve(path);
914 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_DROP;
916 if (FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE & ctx->fnbw_reason)
919 * restack the DPO to pick up the correct DPO sub-type
924 if_is_up = vnet_sw_interface_is_admin_up(
926 path->attached_next_hop.fp_interface);
928 ai = fib_path_attached_next_hop_get_adj(
930 fib_proto_to_link(path->fp_nh_proto));
932 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
933 if (if_is_up && adj_is_up(ai))
935 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RESOLVED;
938 dpo_set(&path->fp_dpo, DPO_ADJACENCY,
939 fib_proto_to_dpo(path->fp_nh_proto),
946 * If the interface is not up there is no reason to walk
947 * back to children. if we did they would only evalute
948 * that this path is unresolved and hence it would
949 * not contribute the adjacency - so it would be wasted
952 return (FIB_NODE_BACK_WALK_CONTINUE);
955 if (FIB_NODE_BW_REASON_FLAG_ADJ_DOWN & ctx->fnbw_reason)
957 if (!(path->fp_oper_flags & FIB_PATH_OPER_FLAG_RESOLVED))
960 * alreday unresolved. no need to walk back again
962 return (FIB_NODE_BACK_WALK_CONTINUE);
965 * the adj has gone down. the path is no longer resolved.
967 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
970 case FIB_PATH_TYPE_ATTACHED:
972 * FIXME; this could schedule a lower priority walk, since attached
973 * routes are not usually in ECMP configurations so the backwalk to
974 * the FIB entry does not need to be high priority
976 if (FIB_NODE_BW_REASON_FLAG_INTERFACE_UP & ctx->fnbw_reason)
978 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RESOLVED;
980 if (FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN & ctx->fnbw_reason)
982 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
984 if (FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE & ctx->fnbw_reason)
986 fib_path_unresolve(path);
987 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_DROP;
990 case FIB_PATH_TYPE_INTF_RX:
992 case FIB_PATH_TYPE_DEAG:
994 * FIXME When VRF delete is allowed this will need a poke.
996 case FIB_PATH_TYPE_SPECIAL:
997 case FIB_PATH_TYPE_RECEIVE:
998 case FIB_PATH_TYPE_EXCLUSIVE:
1000 * these path types have no parents. so to be
1001 * walked from one is unexpected.
1008 * propagate the backwalk further to the path-list
1010 fib_path_list_back_walk(path->fp_pl_index, ctx);
1012 return (FIB_NODE_BACK_WALK_CONTINUE);
1016 fib_path_memory_show (void)
1018 fib_show_memory_usage("Path",
1019 pool_elts(fib_path_pool),
1020 pool_len(fib_path_pool),
1021 sizeof(fib_path_t));
1025 * The FIB path's graph node virtual function table
1027 static const fib_node_vft_t fib_path_vft = {
1028 .fnv_get = fib_path_get_node,
1029 .fnv_last_lock = fib_path_last_lock_gone,
1030 .fnv_back_walk = fib_path_back_walk_notify,
1031 .fnv_mem_show = fib_path_memory_show,
1034 static fib_path_cfg_flags_t
1035 fib_path_route_flags_to_cfg_flags (const fib_route_path_t *rpath)
1037 fib_path_cfg_flags_t cfg_flags = FIB_PATH_CFG_FLAG_NONE;
1039 if (rpath->frp_flags & FIB_ROUTE_PATH_RESOLVE_VIA_HOST)
1040 cfg_flags |= FIB_PATH_CFG_FLAG_RESOLVE_HOST;
1041 if (rpath->frp_flags & FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED)
1042 cfg_flags |= FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED;
1043 if (rpath->frp_flags & FIB_ROUTE_PATH_LOCAL)
1044 cfg_flags |= FIB_PATH_CFG_FLAG_LOCAL;
1045 if (rpath->frp_flags & FIB_ROUTE_PATH_ATTACHED)
1046 cfg_flags |= FIB_PATH_CFG_FLAG_ATTACHED;
1047 if (rpath->frp_flags & FIB_ROUTE_PATH_INTF_RX)
1048 cfg_flags |= FIB_PATH_CFG_FLAG_INTF_RX;
1049 if (rpath->frp_flags & FIB_ROUTE_PATH_RPF_ID)
1050 cfg_flags |= FIB_PATH_CFG_FLAG_RPF_ID;
1051 if (rpath->frp_flags & FIB_ROUTE_PATH_EXCLUSIVE)
1052 cfg_flags |= FIB_PATH_CFG_FLAG_EXCLUSIVE;
1053 if (rpath->frp_flags & FIB_ROUTE_PATH_DROP)
1054 cfg_flags |= FIB_PATH_CFG_FLAG_DROP;
1062 * Create and initialise a new path object.
1063 * return the index of the path.
1066 fib_path_create (fib_node_index_t pl_index,
1067 const fib_route_path_t *rpath)
1071 pool_get(fib_path_pool, path);
1072 memset(path, 0, sizeof(*path));
1074 fib_node_init(&path->fp_node,
1075 FIB_NODE_TYPE_PATH);
1077 dpo_reset(&path->fp_dpo);
1078 path->fp_pl_index = pl_index;
1079 path->fp_nh_proto = rpath->frp_proto;
1080 path->fp_via_fib = FIB_NODE_INDEX_INVALID;
1081 path->fp_weight = rpath->frp_weight;
1082 if (0 == path->fp_weight)
1085 * a weight of 0 is a meaningless value. We could either reject it, and thus force
1086 * clients to always use 1, or we can accept it and fixup approrpiately.
1088 path->fp_weight = 1;
1090 path->fp_preference = rpath->frp_preference;
1091 path->fp_cfg_flags = fib_path_route_flags_to_cfg_flags(rpath);
1094 * deduce the path's tpye from the parementers and save what is needed.
1096 if (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_LOCAL)
1098 path->fp_type = FIB_PATH_TYPE_RECEIVE;
1099 path->receive.fp_interface = rpath->frp_sw_if_index;
1100 path->receive.fp_addr = rpath->frp_addr;
1102 else if (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_INTF_RX)
1104 path->fp_type = FIB_PATH_TYPE_INTF_RX;
1105 path->intf_rx.fp_interface = rpath->frp_sw_if_index;
1107 else if (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_RPF_ID)
1109 path->fp_type = FIB_PATH_TYPE_DEAG;
1110 path->deag.fp_tbl_id = rpath->frp_fib_index;
1111 path->deag.fp_rpf_id = rpath->frp_rpf_id;
1113 else if (~0 != rpath->frp_sw_if_index)
1115 if (ip46_address_is_zero(&rpath->frp_addr))
1117 path->fp_type = FIB_PATH_TYPE_ATTACHED;
1118 path->attached.fp_interface = rpath->frp_sw_if_index;
1122 path->fp_type = FIB_PATH_TYPE_ATTACHED_NEXT_HOP;
1123 path->attached_next_hop.fp_interface = rpath->frp_sw_if_index;
1124 path->attached_next_hop.fp_nh = rpath->frp_addr;
1129 if (ip46_address_is_zero(&rpath->frp_addr))
1131 if (~0 == rpath->frp_fib_index)
1133 path->fp_type = FIB_PATH_TYPE_SPECIAL;
1137 path->fp_type = FIB_PATH_TYPE_DEAG;
1138 path->deag.fp_tbl_id = rpath->frp_fib_index;
1143 path->fp_type = FIB_PATH_TYPE_RECURSIVE;
1144 if (FIB_PROTOCOL_MPLS == path->fp_nh_proto)
1146 path->recursive.fp_nh.fp_local_label = rpath->frp_local_label;
1147 path->recursive.fp_nh.fp_eos = rpath->frp_eos;
1151 path->recursive.fp_nh.fp_ip = rpath->frp_addr;
1153 path->recursive.fp_tbl_id = rpath->frp_fib_index;
1157 FIB_PATH_DBG(path, "create");
1159 return (fib_path_get_index(path));
1163 * fib_path_create_special
1165 * Create and initialise a new path object.
1166 * return the index of the path.
1169 fib_path_create_special (fib_node_index_t pl_index,
1170 fib_protocol_t nh_proto,
1171 fib_path_cfg_flags_t flags,
1172 const dpo_id_t *dpo)
1176 pool_get(fib_path_pool, path);
1177 memset(path, 0, sizeof(*path));
1179 fib_node_init(&path->fp_node,
1180 FIB_NODE_TYPE_PATH);
1181 dpo_reset(&path->fp_dpo);
1183 path->fp_pl_index = pl_index;
1184 path->fp_weight = 1;
1185 path->fp_preference = 0;
1186 path->fp_nh_proto = nh_proto;
1187 path->fp_via_fib = FIB_NODE_INDEX_INVALID;
1188 path->fp_cfg_flags = flags;
1190 if (FIB_PATH_CFG_FLAG_DROP & flags)
1192 path->fp_type = FIB_PATH_TYPE_SPECIAL;
1194 else if (FIB_PATH_CFG_FLAG_LOCAL & flags)
1196 path->fp_type = FIB_PATH_TYPE_RECEIVE;
1197 path->attached.fp_interface = FIB_NODE_INDEX_INVALID;
1201 path->fp_type = FIB_PATH_TYPE_EXCLUSIVE;
1202 ASSERT(NULL != dpo);
1203 dpo_copy(&path->exclusive.fp_ex_dpo, dpo);
1206 return (fib_path_get_index(path));
1212 * Copy a path. return index of new path.
1215 fib_path_copy (fib_node_index_t path_index,
1216 fib_node_index_t path_list_index)
1218 fib_path_t *path, *orig_path;
1220 pool_get(fib_path_pool, path);
1222 orig_path = fib_path_get(path_index);
1223 ASSERT(NULL != orig_path);
1225 memcpy(path, orig_path, sizeof(*path));
1227 FIB_PATH_DBG(path, "create-copy:%d", path_index);
1230 * reset the dynamic section
1232 fib_node_init(&path->fp_node, FIB_NODE_TYPE_PATH);
1233 path->fp_oper_flags = FIB_PATH_OPER_FLAG_NONE;
1234 path->fp_pl_index = path_list_index;
1235 path->fp_via_fib = FIB_NODE_INDEX_INVALID;
1236 memset(&path->fp_dpo, 0, sizeof(path->fp_dpo));
1237 dpo_reset(&path->fp_dpo);
1239 return (fib_path_get_index(path));
1245 * destroy a path that is no longer required
1248 fib_path_destroy (fib_node_index_t path_index)
1252 path = fib_path_get(path_index);
1254 ASSERT(NULL != path);
1255 FIB_PATH_DBG(path, "destroy");
1257 fib_path_unresolve(path);
1259 fib_node_deinit(&path->fp_node);
1260 pool_put(fib_path_pool, path);
1266 * destroy a path that is no longer required
1269 fib_path_hash (fib_node_index_t path_index)
1273 path = fib_path_get(path_index);
1275 return (hash_memory(STRUCT_MARK_PTR(path, path_hash_start),
1276 (STRUCT_OFFSET_OF(fib_path_t, path_hash_end) -
1277 STRUCT_OFFSET_OF(fib_path_t, path_hash_start)),
1284 * Compare two paths for equivalence.
1287 fib_path_cmp_i (const fib_path_t *path1,
1288 const fib_path_t *path2)
1295 * paths of different types and protocol are not equal.
1296 * different weights and/or preference only are the same path.
1298 if (path1->fp_type != path2->fp_type)
1300 res = (path1->fp_type - path2->fp_type);
1302 else if (path1->fp_nh_proto != path2->fp_nh_proto)
1304 res = (path1->fp_nh_proto - path2->fp_nh_proto);
1309 * both paths are of the same type.
1310 * consider each type and its attributes in turn.
1312 switch (path1->fp_type)
1314 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1315 res = ip46_address_cmp(&path1->attached_next_hop.fp_nh,
1316 &path2->attached_next_hop.fp_nh);
1318 res = (path1->attached_next_hop.fp_interface -
1319 path2->attached_next_hop.fp_interface);
1322 case FIB_PATH_TYPE_ATTACHED:
1323 res = (path1->attached.fp_interface -
1324 path2->attached.fp_interface);
1326 case FIB_PATH_TYPE_RECURSIVE:
1327 res = ip46_address_cmp(&path1->recursive.fp_nh,
1328 &path2->recursive.fp_nh);
1332 res = (path1->recursive.fp_tbl_id - path2->recursive.fp_tbl_id);
1335 case FIB_PATH_TYPE_DEAG:
1336 res = (path1->deag.fp_tbl_id - path2->deag.fp_tbl_id);
1339 res = (path1->deag.fp_rpf_id - path2->deag.fp_rpf_id);
1342 case FIB_PATH_TYPE_INTF_RX:
1343 res = (path1->intf_rx.fp_interface - path2->intf_rx.fp_interface);
1345 case FIB_PATH_TYPE_SPECIAL:
1346 case FIB_PATH_TYPE_RECEIVE:
1347 case FIB_PATH_TYPE_EXCLUSIVE:
1356 * fib_path_cmp_for_sort
1358 * Compare two paths for equivalence. Used during path sorting.
1359 * As usual 0 means equal.
1362 fib_path_cmp_for_sort (void * v1,
1365 fib_node_index_t *pi1 = v1, *pi2 = v2;
1366 fib_path_t *path1, *path2;
1368 path1 = fib_path_get(*pi1);
1369 path2 = fib_path_get(*pi2);
1372 * when sorting paths we want the highest preference paths
1373 * first, so that the choices set built is in prefernce order
1375 if (path1->fp_preference != path2->fp_preference)
1377 return (path1->fp_preference - path2->fp_preference);
1380 return (fib_path_cmp_i(path1, path2));
1386 * Compare two paths for equivalence.
1389 fib_path_cmp (fib_node_index_t pi1,
1390 fib_node_index_t pi2)
1392 fib_path_t *path1, *path2;
1394 path1 = fib_path_get(pi1);
1395 path2 = fib_path_get(pi2);
1397 return (fib_path_cmp_i(path1, path2));
1401 fib_path_cmp_w_route_path (fib_node_index_t path_index,
1402 const fib_route_path_t *rpath)
1407 path = fib_path_get(path_index);
1411 if (path->fp_weight != rpath->frp_weight)
1413 res = (path->fp_weight - rpath->frp_weight);
1418 * both paths are of the same type.
1419 * consider each type and its attributes in turn.
1421 switch (path->fp_type)
1423 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1424 res = ip46_address_cmp(&path->attached_next_hop.fp_nh,
1428 res = (path->attached_next_hop.fp_interface -
1429 rpath->frp_sw_if_index);
1432 case FIB_PATH_TYPE_ATTACHED:
1433 res = (path->attached.fp_interface - rpath->frp_sw_if_index);
1435 case FIB_PATH_TYPE_RECURSIVE:
1436 if (FIB_PROTOCOL_MPLS == path->fp_nh_proto)
1438 res = path->recursive.fp_nh.fp_local_label - rpath->frp_local_label;
1442 res = path->recursive.fp_nh.fp_eos - rpath->frp_eos;
1447 res = ip46_address_cmp(&path->recursive.fp_nh.fp_ip,
1453 res = (path->recursive.fp_tbl_id - rpath->frp_fib_index);
1456 case FIB_PATH_TYPE_INTF_RX:
1457 res = (path->intf_rx.fp_interface - rpath->frp_sw_if_index);
1459 case FIB_PATH_TYPE_DEAG:
1460 res = (path->deag.fp_tbl_id - rpath->frp_fib_index);
1463 res = (path->deag.fp_rpf_id - rpath->frp_rpf_id);
1466 case FIB_PATH_TYPE_SPECIAL:
1467 case FIB_PATH_TYPE_RECEIVE:
1468 case FIB_PATH_TYPE_EXCLUSIVE:
1477 * fib_path_recursive_loop_detect
1479 * A forward walk of the FIB object graph to detect for a cycle/loop. This
1480 * walk is initiated when an entry is linking to a new path list or from an old.
1481 * The entry vector passed contains all the FIB entrys that are children of this
1482 * path (it is all the entries encountered on the walk so far). If this vector
1483 * contains the entry this path resolve via, then a loop is about to form.
1484 * The loop must be allowed to form, since we need the dependencies in place
1485 * so that we can track when the loop breaks.
1486 * However, we MUST not produce a loop in the forwarding graph (else packets
1487 * would loop around the switch path until the loop breaks), so we mark recursive
1488 * paths as looped so that they do not contribute forwarding information.
1489 * By marking the path as looped, an etry such as;
1491 * via a.a.a.a (looped)
1492 * via b.b.b.b (not looped)
1493 * can still forward using the info provided by b.b.b.b only
1496 fib_path_recursive_loop_detect (fib_node_index_t path_index,
1497 fib_node_index_t **entry_indicies)
1501 path = fib_path_get(path_index);
1504 * the forced drop path is never looped, cos it is never resolved.
1506 if (fib_path_is_permanent_drop(path))
1511 switch (path->fp_type)
1513 case FIB_PATH_TYPE_RECURSIVE:
1515 fib_node_index_t *entry_index, *entries;
1517 entries = *entry_indicies;
1519 vec_foreach(entry_index, entries) {
1520 if (*entry_index == path->fp_via_fib)
1523 * the entry that is about to link to this path-list (or
1524 * one of this path-list's children) is the same entry that
1525 * this recursive path resolves through. this is a cycle.
1535 FIB_PATH_DBG(path, "recursive loop formed");
1536 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RECURSIVE_LOOP;
1538 dpo_copy(&path->fp_dpo,
1539 drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
1544 * no loop here yet. keep forward walking the graph.
1546 if (fib_entry_recursive_loop_detect(path->fp_via_fib, entry_indicies))
1548 FIB_PATH_DBG(path, "recursive loop formed");
1549 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RECURSIVE_LOOP;
1553 FIB_PATH_DBG(path, "recursive loop cleared");
1554 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RECURSIVE_LOOP;
1559 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1560 case FIB_PATH_TYPE_ATTACHED:
1561 case FIB_PATH_TYPE_SPECIAL:
1562 case FIB_PATH_TYPE_DEAG:
1563 case FIB_PATH_TYPE_RECEIVE:
1564 case FIB_PATH_TYPE_INTF_RX:
1565 case FIB_PATH_TYPE_EXCLUSIVE:
1567 * these path types cannot be part of a loop, since they are the leaves
1573 return (fib_path_is_looped(path_index));
1577 fib_path_resolve (fib_node_index_t path_index)
1581 path = fib_path_get(path_index);
1584 * hope for the best.
1586 path->fp_oper_flags |= FIB_PATH_OPER_FLAG_RESOLVED;
1589 * the forced drop path resolves via the drop adj
1591 if (fib_path_is_permanent_drop(path))
1593 dpo_copy(&path->fp_dpo,
1594 drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
1595 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
1596 return (fib_path_is_resolved(path_index));
1599 switch (path->fp_type)
1601 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1602 fib_path_attached_next_hop_set(path);
1604 case FIB_PATH_TYPE_ATTACHED:
1606 * path->attached.fp_interface
1608 if (!vnet_sw_interface_is_admin_up(vnet_get_main(),
1609 path->attached.fp_interface))
1611 path->fp_oper_flags &= ~FIB_PATH_OPER_FLAG_RESOLVED;
1613 dpo_set(&path->fp_dpo,
1615 fib_proto_to_dpo(path->fp_nh_proto),
1616 fib_path_attached_get_adj(path,
1617 fib_proto_to_link(path->fp_nh_proto)));
1620 * become a child of the adjacency so we receive updates
1621 * when the interface state changes
1623 path->fp_sibling = adj_child_add(path->fp_dpo.dpoi_index,
1625 fib_path_get_index(path));
1628 case FIB_PATH_TYPE_RECURSIVE:
1631 * Create a RR source entry in the table for the address
1632 * that this path recurses through.
1633 * This resolve action is recursive, hence we may create
1634 * more paths in the process. more creates mean maybe realloc
1637 fib_node_index_t fei;
1640 ASSERT(FIB_NODE_INDEX_INVALID == path->fp_via_fib);
1642 if (FIB_PROTOCOL_MPLS == path->fp_nh_proto)
1644 fib_prefix_from_mpls_label(path->recursive.fp_nh.fp_local_label,
1645 path->recursive.fp_nh.fp_eos,
1650 fib_prefix_from_ip46_addr(&path->recursive.fp_nh.fp_ip, &pfx);
1653 fei = fib_table_entry_special_add(path->recursive.fp_tbl_id,
1656 FIB_ENTRY_FLAG_NONE);
1658 path = fib_path_get(path_index);
1659 path->fp_via_fib = fei;
1662 * become a dependent child of the entry so the path is
1663 * informed when the forwarding for the entry changes.
1665 path->fp_sibling = fib_entry_child_add(path->fp_via_fib,
1667 fib_path_get_index(path));
1670 * create and configure the IP DPO
1672 fib_path_recursive_adj_update(
1674 fib_path_to_chain_type(path),
1679 case FIB_PATH_TYPE_SPECIAL:
1681 * Resolve via the drop
1683 dpo_copy(&path->fp_dpo,
1684 drop_dpo_get(fib_proto_to_dpo(path->fp_nh_proto)));
1686 case FIB_PATH_TYPE_DEAG:
1689 * Resolve via a lookup DPO.
1690 * FIXME. control plane should add routes with a table ID
1694 cast = (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_RPF_ID ?
1698 lookup_dpo_add_or_lock_w_fib_index(path->deag.fp_tbl_id,
1699 fib_proto_to_dpo(path->fp_nh_proto),
1701 LOOKUP_INPUT_DST_ADDR,
1702 LOOKUP_TABLE_FROM_CONFIG,
1706 case FIB_PATH_TYPE_RECEIVE:
1708 * Resolve via a receive DPO.
1710 receive_dpo_add_or_lock(fib_proto_to_dpo(path->fp_nh_proto),
1711 path->receive.fp_interface,
1712 &path->receive.fp_addr,
1715 case FIB_PATH_TYPE_INTF_RX: {
1717 * Resolve via a receive DPO.
1719 interface_dpo_add_or_lock(fib_proto_to_dpo(path->fp_nh_proto),
1720 path->intf_rx.fp_interface,
1724 case FIB_PATH_TYPE_EXCLUSIVE:
1726 * Resolve via the user provided DPO
1728 dpo_copy(&path->fp_dpo, &path->exclusive.fp_ex_dpo);
1732 return (fib_path_is_resolved(path_index));
1736 fib_path_get_resolving_interface (fib_node_index_t path_index)
1740 path = fib_path_get(path_index);
1742 switch (path->fp_type)
1744 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1745 return (path->attached_next_hop.fp_interface);
1746 case FIB_PATH_TYPE_ATTACHED:
1747 return (path->attached.fp_interface);
1748 case FIB_PATH_TYPE_RECEIVE:
1749 return (path->receive.fp_interface);
1750 case FIB_PATH_TYPE_RECURSIVE:
1751 if (fib_path_is_resolved(path_index))
1753 return (fib_entry_get_resolving_interface(path->fp_via_fib));
1756 case FIB_PATH_TYPE_INTF_RX:
1757 case FIB_PATH_TYPE_SPECIAL:
1758 case FIB_PATH_TYPE_DEAG:
1759 case FIB_PATH_TYPE_EXCLUSIVE:
1766 fib_path_get_adj (fib_node_index_t path_index)
1770 path = fib_path_get(path_index);
1772 ASSERT(dpo_is_adj(&path->fp_dpo));
1773 if (dpo_is_adj(&path->fp_dpo))
1775 return (path->fp_dpo.dpoi_index);
1777 return (ADJ_INDEX_INVALID);
1781 fib_path_get_weight (fib_node_index_t path_index)
1785 path = fib_path_get(path_index);
1789 return (path->fp_weight);
1793 fib_path_get_preference (fib_node_index_t path_index)
1797 path = fib_path_get(path_index);
1801 return (path->fp_preference);
1805 * @brief Contribute the path's adjacency to the list passed.
1806 * By calling this function over all paths, recursively, a child
1807 * can construct its full set of forwarding adjacencies, and hence its
1811 fib_path_contribute_urpf (fib_node_index_t path_index,
1816 path = fib_path_get(path_index);
1819 * resolved and unresolved paths contribute to the RPF list.
1821 switch (path->fp_type)
1823 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1824 fib_urpf_list_append(urpf, path->attached_next_hop.fp_interface);
1827 case FIB_PATH_TYPE_ATTACHED:
1828 fib_urpf_list_append(urpf, path->attached.fp_interface);
1831 case FIB_PATH_TYPE_RECURSIVE:
1832 if (FIB_NODE_INDEX_INVALID != path->fp_via_fib &&
1833 !fib_path_is_looped(path_index))
1836 * there's unresolved due to constraints, and there's unresolved
1837 * due to ain't got no via. can't do nowt w'out via.
1839 fib_entry_contribute_urpf(path->fp_via_fib, urpf);
1843 case FIB_PATH_TYPE_EXCLUSIVE:
1844 case FIB_PATH_TYPE_SPECIAL:
1846 * these path types may link to an adj, if that's what
1849 if (dpo_is_adj(&path->fp_dpo))
1851 ip_adjacency_t *adj;
1853 adj = adj_get(path->fp_dpo.dpoi_index);
1855 fib_urpf_list_append(urpf, adj->rewrite_header.sw_if_index);
1859 case FIB_PATH_TYPE_DEAG:
1860 case FIB_PATH_TYPE_RECEIVE:
1861 case FIB_PATH_TYPE_INTF_RX:
1863 * these path types don't link to an adj
1870 fib_path_stack_mpls_disp (fib_node_index_t path_index,
1871 dpo_proto_t payload_proto,
1876 path = fib_path_get(path_index);
1880 switch (path->fp_type)
1882 case FIB_PATH_TYPE_DEAG:
1884 dpo_id_t tmp = DPO_INVALID;
1886 dpo_copy(&tmp, dpo);
1888 DPO_MPLS_DISPOSITION,
1890 mpls_disp_dpo_create(payload_proto,
1891 path->deag.fp_rpf_id,
1896 case FIB_PATH_TYPE_RECEIVE:
1897 case FIB_PATH_TYPE_ATTACHED:
1898 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1899 case FIB_PATH_TYPE_RECURSIVE:
1900 case FIB_PATH_TYPE_INTF_RX:
1901 case FIB_PATH_TYPE_EXCLUSIVE:
1902 case FIB_PATH_TYPE_SPECIAL:
1908 fib_path_contribute_forwarding (fib_node_index_t path_index,
1909 fib_forward_chain_type_t fct,
1914 path = fib_path_get(path_index);
1917 ASSERT(FIB_FORW_CHAIN_TYPE_MPLS_EOS != fct);
1919 FIB_PATH_DBG(path, "contribute");
1922 * The DPO stored in the path was created when the path was resolved.
1923 * This then represents the path's 'native' protocol; IP.
1924 * For all others will need to go find something else.
1926 if (fib_path_to_chain_type(path) == fct)
1928 dpo_copy(dpo, &path->fp_dpo);
1932 switch (path->fp_type)
1934 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
1937 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
1938 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
1939 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
1940 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
1941 case FIB_FORW_CHAIN_TYPE_ETHERNET:
1942 case FIB_FORW_CHAIN_TYPE_NSH:
1947 * get a appropriate link type adj.
1949 ai = fib_path_attached_next_hop_get_adj(
1951 fib_forw_chain_type_to_link_type(fct));
1952 dpo_set(dpo, DPO_ADJACENCY,
1953 fib_forw_chain_type_to_dpo_proto(fct), ai);
1958 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
1959 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
1963 case FIB_PATH_TYPE_RECURSIVE:
1966 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
1967 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
1968 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
1969 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
1970 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
1971 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
1972 fib_path_recursive_adj_update(path, fct, dpo);
1974 case FIB_FORW_CHAIN_TYPE_ETHERNET:
1975 case FIB_FORW_CHAIN_TYPE_NSH:
1980 case FIB_PATH_TYPE_DEAG:
1983 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
1984 lookup_dpo_add_or_lock_w_table_id(MPLS_FIB_DEFAULT_TABLE_ID,
1987 LOOKUP_INPUT_DST_ADDR,
1988 LOOKUP_TABLE_FROM_CONFIG,
1991 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
1992 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
1993 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
1994 dpo_copy(dpo, &path->fp_dpo);
1996 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
1997 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
1998 case FIB_FORW_CHAIN_TYPE_ETHERNET:
1999 case FIB_FORW_CHAIN_TYPE_NSH:
2004 case FIB_PATH_TYPE_EXCLUSIVE:
2005 dpo_copy(dpo, &path->exclusive.fp_ex_dpo);
2007 case FIB_PATH_TYPE_ATTACHED:
2010 case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
2011 case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
2012 case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
2013 case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
2014 case FIB_FORW_CHAIN_TYPE_ETHERNET:
2015 case FIB_FORW_CHAIN_TYPE_NSH:
2020 * get a appropriate link type adj.
2022 ai = fib_path_attached_get_adj(
2024 fib_forw_chain_type_to_link_type(fct));
2025 dpo_set(dpo, DPO_ADJACENCY,
2026 fib_forw_chain_type_to_dpo_proto(fct), ai);
2030 case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
2031 case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
2036 * Create the adj needed for sending IP multicast traffic
2038 ai = adj_mcast_add_or_lock(path->fp_nh_proto,
2039 fib_forw_chain_type_to_link_type(fct),
2040 path->attached.fp_interface);
2041 dpo_set(dpo, DPO_ADJACENCY,
2042 fib_forw_chain_type_to_dpo_proto(fct),
2049 case FIB_PATH_TYPE_INTF_RX:
2051 * Create the adj needed for sending IP multicast traffic
2053 interface_dpo_add_or_lock(fib_forw_chain_type_to_dpo_proto(fct),
2054 path->attached.fp_interface,
2057 case FIB_PATH_TYPE_RECEIVE:
2058 case FIB_PATH_TYPE_SPECIAL:
2059 dpo_copy(dpo, &path->fp_dpo);
2065 load_balance_path_t *
2066 fib_path_append_nh_for_multipath_hash (fib_node_index_t path_index,
2067 fib_forward_chain_type_t fct,
2068 load_balance_path_t *hash_key)
2070 load_balance_path_t *mnh;
2073 path = fib_path_get(path_index);
2077 if (fib_path_is_resolved(path_index))
2079 vec_add2(hash_key, mnh, 1);
2081 mnh->path_weight = path->fp_weight;
2082 mnh->path_index = path_index;
2083 fib_path_contribute_forwarding(path_index, fct, &mnh->path_dpo);
2090 fib_path_is_recursive_constrained (fib_node_index_t path_index)
2094 path = fib_path_get(path_index);
2096 return ((FIB_PATH_TYPE_RECURSIVE == path->fp_type) &&
2097 ((path->fp_cfg_flags & FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED) ||
2098 (path->fp_cfg_flags & FIB_PATH_CFG_FLAG_RESOLVE_HOST)));
2102 fib_path_is_exclusive (fib_node_index_t path_index)
2106 path = fib_path_get(path_index);
2108 return (FIB_PATH_TYPE_EXCLUSIVE == path->fp_type);
2112 fib_path_is_deag (fib_node_index_t path_index)
2116 path = fib_path_get(path_index);
2118 return (FIB_PATH_TYPE_DEAG == path->fp_type);
2122 fib_path_is_resolved (fib_node_index_t path_index)
2126 path = fib_path_get(path_index);
2128 return (dpo_id_is_valid(&path->fp_dpo) &&
2129 (path->fp_oper_flags & FIB_PATH_OPER_FLAG_RESOLVED) &&
2130 !fib_path_is_looped(path_index) &&
2131 !fib_path_is_permanent_drop(path));
2135 fib_path_is_looped (fib_node_index_t path_index)
2139 path = fib_path_get(path_index);
2141 return (path->fp_oper_flags & FIB_PATH_OPER_FLAG_RECURSIVE_LOOP);
2144 fib_path_list_walk_rc_t
2145 fib_path_encode (fib_node_index_t path_list_index,
2146 fib_node_index_t path_index,
2149 fib_route_path_encode_t **api_rpaths = ctx;
2150 fib_route_path_encode_t *api_rpath;
2153 path = fib_path_get(path_index);
2155 return (FIB_PATH_LIST_WALK_CONTINUE);
2156 vec_add2(*api_rpaths, api_rpath, 1);
2157 api_rpath->rpath.frp_weight = path->fp_weight;
2158 api_rpath->rpath.frp_preference = path->fp_preference;
2159 api_rpath->rpath.frp_proto = path->fp_nh_proto;
2160 api_rpath->rpath.frp_sw_if_index = ~0;
2161 api_rpath->dpo = path->exclusive.fp_ex_dpo;
2162 switch (path->fp_type)
2164 case FIB_PATH_TYPE_RECEIVE:
2165 api_rpath->rpath.frp_addr = path->receive.fp_addr;
2166 api_rpath->rpath.frp_sw_if_index = path->receive.fp_interface;
2167 api_rpath->dpo = path->fp_dpo;
2169 case FIB_PATH_TYPE_ATTACHED:
2170 api_rpath->rpath.frp_sw_if_index = path->attached.fp_interface;
2171 api_rpath->dpo = path->fp_dpo;
2173 case FIB_PATH_TYPE_ATTACHED_NEXT_HOP:
2174 api_rpath->rpath.frp_sw_if_index = path->attached_next_hop.fp_interface;
2175 api_rpath->rpath.frp_addr = path->attached_next_hop.fp_nh;
2177 case FIB_PATH_TYPE_SPECIAL:
2179 case FIB_PATH_TYPE_DEAG:
2181 case FIB_PATH_TYPE_RECURSIVE:
2182 api_rpath->rpath.frp_addr = path->recursive.fp_nh.fp_ip;
2187 return (FIB_PATH_LIST_WALK_CONTINUE);
2191 fib_path_get_proto (fib_node_index_t path_index)
2195 path = fib_path_get(path_index);
2197 return (path->fp_nh_proto);
2201 fib_path_module_init (void)
2203 fib_node_register_type (FIB_NODE_TYPE_PATH, &fib_path_vft);
2206 static clib_error_t *
2207 show_fib_path_command (vlib_main_t * vm,
2208 unformat_input_t * input,
2209 vlib_cli_command_t * cmd)
2211 fib_node_index_t pi;
2214 if (unformat (input, "%d", &pi))
2217 * show one in detail
2219 if (!pool_is_free_index(fib_path_pool, pi))
2221 path = fib_path_get(pi);
2222 u8 *s = fib_path_format(pi, NULL);
2223 s = format(s, "children:");
2224 s = fib_node_children_format(path->fp_node.fn_children, s);
2225 vlib_cli_output (vm, "%s", s);
2230 vlib_cli_output (vm, "path %d invalid", pi);
2235 vlib_cli_output (vm, "FIB Paths");
2236 pool_foreach(path, fib_path_pool,
2238 vlib_cli_output (vm, "%U", format_fib_path, path);
2245 VLIB_CLI_COMMAND (show_fib_path, static) = {
2246 .path = "show fib paths",
2247 .function = show_fib_path_command,
2248 .short_help = "show fib paths",