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.
17 * Given a route of the form;
19 * via <interface> <next-hop>
21 * The prefix is: q.r.s.t./Y
22 * the path is: 'via <interface> <next-hop>
24 * The path is the description of where to send the traffic, and the
25 * the prefix is a description of which traffic to send.
26 * It is the aim of the FIB to resolve the path, i.e. to find the corresponding
27 * adjacency to match the path's description.
30 #ifndef __FIB_PATH_H__
31 #define __FIB_PATH_H__
33 #include <vnet/ip/ip.h>
34 #include <vnet/dpo/load_balance.h>
36 #include <vnet/fib/fib_types.h>
37 #include <vnet/adj/adj_types.h>
38 #include <vnet/bier/bier_types.h>
41 * Enurmeration of path configuration attributes
43 typedef enum fib_path_cfg_attribute_t_ {
45 * Marker. Add new types after this one.
47 FIB_PATH_CFG_ATTRIBUTE_FIRST = 0,
49 * The path is forced to a drop, whatever the next-hop info says.
50 * something somewhere knows better...
52 FIB_PATH_CFG_ATTRIBUTE_DROP = FIB_PATH_CFG_ATTRIBUTE_FIRST,
54 * The path uses an adj that is exclusive. I.e. it is known only by
55 * the source of the route.
57 FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE,
59 * Recursion constraint via host
61 FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST,
63 * Recursion constraint via attached
65 FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED,
67 * The path is attached
69 FIB_PATH_CFG_ATTRIBUTE_ATTACHED,
71 * The path is a for-us path
73 FIB_PATH_CFG_ATTRIBUTE_INTF_RX,
75 * The path is a deag with rpf-id
77 FIB_PATH_CFG_ATTRIBUTE_RPF_ID,
79 * The path is an interface recieve
81 FIB_PATH_CFG_ATTRIBUTE_LOCAL,
83 * The path reolves via an ICMP unreachable
85 FIB_PATH_CFG_ATTRIBUTE_ICMP_UNREACH,
87 * The path reolves via an ICMP prohibit
89 FIB_PATH_CFG_ATTRIBUTE_ICMP_PROHIBIT,
91 * The path reolves via a classify
93 FIB_PATH_CFG_ATTRIBUTE_CLASSIFY,
95 * The deag path does a source lookup
97 FIB_PATH_CFG_ATTRIBUTE_DEAG_SRC,
99 * The path pops a Psuedo Wire Control Word
101 FIB_PATH_CFG_ATTRIBUTE_POP_PW_CW,
103 * Marker. Add new types before this one, then update it.
105 FIB_PATH_CFG_ATTRIBUTE_LAST = FIB_PATH_CFG_ATTRIBUTE_POP_PW_CW,
106 } __attribute__ ((packed)) fib_path_cfg_attribute_t;
109 * The maximum number of path attributes
111 #define FIB_PATH_CFG_ATTRIBUTE_MAX (FIB_PATH_CFG_ATTRIBUTE_LAST + 1)
113 #define FIB_PATH_CFG_ATTRIBUTES { \
114 [FIB_PATH_CFG_ATTRIBUTE_DROP] = "drop", \
115 [FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
116 [FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST] = "resolve-host", \
117 [FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED] = "resolve-attached", \
118 [FIB_PATH_CFG_ATTRIBUTE_LOCAL] = "local", \
119 [FIB_PATH_CFG_ATTRIBUTE_ICMP_UNREACH] = "icmp-unreach", \
120 [FIB_PATH_CFG_ATTRIBUTE_ICMP_PROHIBIT] = "icmp-prohibit", \
121 [FIB_PATH_CFG_ATTRIBUTE_CLASSIFY] = "classify", \
122 [FIB_PATH_CFG_ATTRIBUTE_ATTACHED] = "attached", \
123 [FIB_PATH_CFG_ATTRIBUTE_INTF_RX] = "interface-rx", \
124 [FIB_PATH_CFG_ATTRIBUTE_RPF_ID] = "rpf-id", \
125 [FIB_PATH_CFG_ATTRIBUTE_DEAG_SRC] = "deag-src", \
126 [FIB_PATH_CFG_ATTRIBUTE_POP_PW_CW] = "pop-pw-cw", \
129 #define FOR_EACH_FIB_PATH_CFG_ATTRIBUTE(_item) \
130 for (_item = FIB_PATH_CFG_ATTRIBUTE_FIRST; \
131 _item <= FIB_PATH_CFG_ATTRIBUTE_LAST; \
135 * Path config flags from the attributes
137 typedef enum fib_path_cfg_flags_t_ {
138 FIB_PATH_CFG_FLAG_NONE = 0,
139 FIB_PATH_CFG_FLAG_DROP = (1 << FIB_PATH_CFG_ATTRIBUTE_DROP),
140 FIB_PATH_CFG_FLAG_EXCLUSIVE = (1 << FIB_PATH_CFG_ATTRIBUTE_EXCLUSIVE),
141 FIB_PATH_CFG_FLAG_RESOLVE_HOST = (1 << FIB_PATH_CFG_ATTRIBUTE_RESOLVE_HOST),
142 FIB_PATH_CFG_FLAG_RESOLVE_ATTACHED = (1 << FIB_PATH_CFG_ATTRIBUTE_RESOLVE_ATTACHED),
143 FIB_PATH_CFG_FLAG_LOCAL = (1 << FIB_PATH_CFG_ATTRIBUTE_LOCAL),
144 FIB_PATH_CFG_FLAG_ICMP_UNREACH = (1 << FIB_PATH_CFG_ATTRIBUTE_ICMP_UNREACH),
145 FIB_PATH_CFG_FLAG_ICMP_PROHIBIT = (1 << FIB_PATH_CFG_ATTRIBUTE_ICMP_PROHIBIT),
146 FIB_PATH_CFG_FLAG_CLASSIFY = (1 << FIB_PATH_CFG_ATTRIBUTE_CLASSIFY),
147 FIB_PATH_CFG_FLAG_ATTACHED = (1 << FIB_PATH_CFG_ATTRIBUTE_ATTACHED),
148 FIB_PATH_CFG_FLAG_INTF_RX = (1 << FIB_PATH_CFG_ATTRIBUTE_INTF_RX),
149 FIB_PATH_CFG_FLAG_RPF_ID = (1 << FIB_PATH_CFG_ATTRIBUTE_RPF_ID),
150 FIB_PATH_CFG_FLAG_DEAG_SRC = (1 << FIB_PATH_CFG_ATTRIBUTE_DEAG_SRC),
151 FIB_PATH_CFG_FLAG_POP_PW_CW = (1 << FIB_PATH_CFG_ATTRIBUTE_POP_PW_CW),
152 } __attribute__ ((packed)) fib_path_cfg_flags_t;
154 typedef enum fib_path_format_flags_t_
156 FIB_PATH_FORMAT_FLAGS_NONE = 0,
157 FIB_PATH_FORMAT_FLAGS_ONE_LINE = (1 << 0),
158 } fib_format_path_flags_t;
160 extern u8 *format_fib_path(u8 *s, va_list *args);
162 extern fib_node_index_t fib_path_create(fib_node_index_t pl_index,
163 const fib_route_path_t *path);
164 extern fib_node_index_t fib_path_create_special(fib_node_index_t pl_index,
165 dpo_proto_t nh_proto,
166 fib_path_cfg_flags_t flags,
167 const dpo_id_t *dpo);
169 extern int fib_path_cmp(fib_node_index_t path_index1,
170 fib_node_index_t path_index2);
171 extern int fib_path_cmp_for_sort(void * a1, void * a2);
172 extern int fib_path_cmp_w_route_path(fib_node_index_t path_index,
173 const fib_route_path_t *rpath);
174 extern fib_node_index_t fib_path_copy(fib_node_index_t path_index,
175 fib_node_index_t path_list_index);
176 extern int fib_path_resolve(fib_node_index_t path_index);
177 extern int fib_path_is_resolved(fib_node_index_t path_index);
178 extern int fib_path_is_recursive_constrained(fib_node_index_t path_index);
179 extern int fib_path_is_exclusive(fib_node_index_t path_index);
180 extern int fib_path_is_deag(fib_node_index_t path_index);
181 extern int fib_path_is_looped(fib_node_index_t path_index);
182 extern dpo_proto_t fib_path_get_proto(fib_node_index_t path_index);
183 extern void fib_path_destroy(fib_node_index_t path_index);
184 extern uword fib_path_hash(fib_node_index_t path_index);
185 extern load_balance_path_t * fib_path_append_nh_for_multipath_hash(
186 fib_node_index_t path_index,
187 fib_forward_chain_type_t fct,
188 load_balance_path_t *hash_key);
189 extern void fib_path_stack_mpls_disp(fib_node_index_t path_index,
190 dpo_proto_t payload_proto,
191 fib_mpls_lsp_mode_t mode,
193 extern void fib_path_contribute_forwarding(fib_node_index_t path_index,
194 fib_forward_chain_type_t type,
196 extern void fib_path_contribute_urpf(fib_node_index_t path_index,
198 extern adj_index_t fib_path_get_adj(fib_node_index_t path_index);
199 extern int fib_path_recursive_loop_detect(fib_node_index_t path_index,
200 fib_node_index_t **entry_indicies);
201 extern u32 fib_path_get_resolving_interface(fib_node_index_t fib_entry_index);
202 extern index_t fib_path_get_resolving_index(fib_node_index_t path_index);
203 extern u16 fib_path_get_weight(fib_node_index_t path_index);
204 extern u16 fib_path_get_preference(fib_node_index_t path_index);
205 extern u32 fib_path_get_rpf_id(fib_node_index_t path_index);
207 extern void fib_path_module_init(void);
210 * Path encode context to use when walking a path-list
213 typedef struct fib_path_encode_ctx_t_
215 fib_route_path_t *rpaths;
216 } fib_path_encode_ctx_t;
218 extern fib_path_list_walk_rc_t fib_path_encode(fib_node_index_t path_list_index,
219 fib_node_index_t path_index,
220 const struct fib_path_ext_t_ *ext_list,