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 #ifndef __FIB_ENTRY_H__
17 #define __FIB_ENTRY_H__
19 #include <vnet/fib/fib_node.h>
20 #include <vnet/fib/fib_entry_delegate.h>
21 #include <vnet/adj/adj.h>
22 #include <vnet/ip/ip.h>
23 #include <vnet/dpo/dpo.h>
26 * The different sources that can create a route.
27 * The sources are defined here the thier relative priority order.
28 * The lower the value the higher the priority
30 typedef enum fib_source_t_ {
32 * Marker. Add new values after this one.
36 * Special sources. These are for entries that are added to all
37 * FIBs by default, and should never be over-ridden (hence they
38 * are the highest priority)
40 FIB_SOURCE_SPECIAL = FIB_SOURCE_FIRST,
42 * Classify. A route that links directly to a classify adj
46 * A route the is being 'proxied' on behalf of another device
50 * Route added as a result of interface configuration.
51 * this will also come from the API/CLI, but the distinction is
52 * that is from confiiguration on an interface, not a 'ip route' command
60 * A high priority source a plugin can use
64 * From the BIER subsystem
72 * From the control plane API
80 * A low (below routing) priority source a plugin can use
82 FIB_SOURCE_PLUGIN_LOW,
98 FIB_SOURCE_IP6_ND_PROXY,
100 * IPv6 ND (seen in the link-local tables)
105 * routes created as a result of ARP/ND entries. This is lower priority
106 * then the API/CLI. This is on purpose. trust me.
110 * MPLS label. The prefix has been assigned a local label. This source
111 * never provides forwarding information, instead it acts as a place-holder
112 * so the association of label to prefix can be maintained
116 * Attached Export source.
117 * routes created as a result of attahced export. routes thus sourced
118 * will be present in the export tables
122 * Recursive resolution source.
123 * Used to install an entry that is the resolution traget of another.
127 * uRPF bypass/exemption.
128 * Used to install an entry that is exempt from the loose uRPF check
130 FIB_SOURCE_URPF_EXEMPT,
132 * The default route source.
133 * The default route is always added to the FIB table (like the
134 * special sources) but we need to be able to over-ride it with
135 * 'ip route' sources when provided
137 FIB_SOURCE_DEFAULT_ROUTE,
139 * The interpose source.
140 * This is not a real source, so don't use it to source a prefix.
141 * It exists here to provide a value against which to register to the
142 * VFT for providing the interpose actions to a real source.
144 FIB_SOURCE_INTERPOSE,
146 * Marker. add new entries before this one.
148 FIB_SOURCE_LAST = FIB_SOURCE_INTERPOSE,
149 } __attribute__ ((packed)) fib_source_t;
151 STATIC_ASSERT (sizeof(fib_source_t) == 1,
152 "FIB too many sources");
155 * The maximum number of sources
157 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
159 #define FIB_SOURCES { \
160 [FIB_SOURCE_SPECIAL] = "special", \
161 [FIB_SOURCE_INTERFACE] = "interface", \
162 [FIB_SOURCE_PROXY] = "proxy", \
163 [FIB_SOURCE_BIER] = "BIER", \
164 [FIB_SOURCE_6RD] = "6RD", \
165 [FIB_SOURCE_API] = "API", \
166 [FIB_SOURCE_CLI] = "CLI", \
167 [FIB_SOURCE_ADJ] = "adjacency", \
168 [FIB_SOURCE_MAP] = "MAP", \
169 [FIB_SOURCE_SR] = "SR", \
170 [FIB_SOURCE_LISP] = "LISP", \
171 [FIB_SOURCE_CLASSIFY] = "classify", \
172 [FIB_SOURCE_DHCP] = "DHCP", \
173 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
174 [FIB_SOURCE_IP6_ND] = "IPv6-nd", \
175 [FIB_SOURCE_RR] = "recursive-resolution", \
176 [FIB_SOURCE_AE] = "attached_export", \
177 [FIB_SOURCE_MPLS] = "mpls", \
178 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
179 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
180 [FIB_SOURCE_PLUGIN_HI] = "plugin-hi", \
181 [FIB_SOURCE_PLUGIN_LOW] = "plugin-low", \
182 [FIB_SOURCE_INTERPOSE] = "interpose", \
185 #define FOR_EACH_FIB_SOURCE(_item) \
186 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
189 * The different sources that can create a route.
190 * The sources are defined here the thier relative priority order.
191 * The lower the value the higher the priority
193 typedef enum fib_entry_attribute_t_ {
195 * Marker. Add new values after this one.
197 FIB_ENTRY_ATTRIBUTE_FIRST,
199 * Connected. The prefix is configured on an interface.
201 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
203 * Attached. The prefix is attached to an interface.
205 FIB_ENTRY_ATTRIBUTE_ATTACHED,
207 * The route is an explicit drop.
209 FIB_ENTRY_ATTRIBUTE_DROP,
211 * The route is exclusive. The client creating the route is
212 * providing an exclusive adjacency.
214 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
216 * The route is attached cross tables and thus imports covered
217 * prefixes from the other table.
219 FIB_ENTRY_ATTRIBUTE_IMPORT,
221 * The prefix/address is local to this device
223 FIB_ENTRY_ATTRIBUTE_LOCAL,
225 * The prefix/address is a multicast prefix.
226 * this aplies only to MPLS. IP multicast is handled by mfib
228 FIB_ENTRY_ATTRIBUTE_MULTICAST,
230 * The prefix/address exempted from loose uRPF check
231 * To be used with caution
233 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
235 * The prefix/address exempted from attached export
237 FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT,
239 * This FIB entry imposes its source information on all prefixes
242 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
244 * The interpose attribute.
245 * place the forwarding provided by the source infront of the forwarding
246 * provided by the best source, or failing that, by the cover.
248 FIB_ENTRY_ATTRIBUTE_INTERPOSE,
250 * Marker. add new entries before this one.
252 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_INTERPOSE,
253 } fib_entry_attribute_t;
255 #define FIB_ENTRY_ATTRIBUTES { \
256 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
257 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
258 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
259 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
260 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
261 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
262 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
263 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
264 [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export", \
265 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
266 [FIB_ENTRY_ATTRIBUTE_INTERPOSE] = "interpose", \
269 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
270 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
271 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
274 typedef enum fib_entry_flag_t_ {
275 FIB_ENTRY_FLAG_NONE = 0,
276 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
277 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
278 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
279 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
280 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
281 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
282 FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT),
283 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
284 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
285 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
286 FIB_ENTRY_FLAG_INTERPOSE = (1 << FIB_ENTRY_ATTRIBUTE_INTERPOSE),
287 } __attribute__((packed)) fib_entry_flag_t;
289 extern u8 * format_fib_entry_flags(u8 *s, va_list *args);
292 * Flags for the source data
294 typedef enum fib_entry_src_attribute_t_ {
296 * Marker. Add new values after this one.
298 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
300 * the source has been added to the entry
302 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
304 * the source is contributing forwarding
306 FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING,
308 * the source is active/best
310 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
312 * the source is inherited from its cover
314 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
316 * Marker. add new entries before this one.
318 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
319 } fib_entry_src_attribute_t;
322 #define FIB_ENTRY_SRC_ATTRIBUTES { \
323 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
324 [FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING] = "contributing", \
325 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
326 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
329 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
330 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
331 _item <= FIB_ENTRY_SRC_ATTRIBUTE_LAST; \
334 typedef enum fib_entry_src_flag_t_ {
335 FIB_ENTRY_SRC_FLAG_NONE = 0,
336 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
337 FIB_ENTRY_SRC_FLAG_CONTRIBUTING = (1 << FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING),
338 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
339 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
340 } __attribute__ ((packed)) fib_entry_src_flag_t;
342 extern u8 * format_fib_entry_src_flags(u8 *s, va_list *args);
345 * Keep the size of the flags field to 2 bytes, so it
346 * can be placed next to the 2 bytes reference count
348 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
349 "FIB entry flags field size too big");
352 * Information related to the source of a FIB entry
354 typedef struct fib_entry_src_t_ {
356 * A vector of path extensions
358 fib_path_ext_list_t fes_path_exts;
361 * The path-list created by the source
363 fib_node_index_t fes_pl;
366 * Flags the source contributes to the entry
368 fib_entry_flag_t fes_entry_flags;
371 * Which source this info block is for
373 fib_source_t fes_src;
376 * Flags on the source
378 fib_entry_src_flag_t fes_flags;
381 * 1 bytes ref count. This is not the number of users of the Entry
382 * (which is itself not large, due to path-list sharing), but the number
383 * of times a given source has been added. Which is even fewer
388 * Source specific info
393 * the index of the FIB entry that is the covering entry
395 fib_node_index_t fesr_cover;
397 * This source's index in the cover's list
403 * the index of the FIB entry that is the covering entry
405 fib_node_index_t fesi_cover;
407 * This source's index in the cover's list
411 * DPO type to interpose. The dpo type needs to have registered
412 * it's 'contribute interpose' callback function.
418 * the index of the FIB entry that is the covering entry
420 fib_node_index_t fesa_cover;
422 * This source's index in the cover's list
428 * the index of the FIB entry that is the covering entry
430 fib_node_index_t fesi_cover;
432 * This source's index in the cover's list
438 * This MPLS local label associated with the prefix.
440 mpls_label_t fesm_label;
443 * the indicies of the LFIB entries created
445 fib_node_index_t fesm_lfes[2];
449 * The source FIB index.
451 fib_node_index_t fesl_fib_index;
457 * An entry in a FIB table.
459 * This entry represents a route added to the FIB that is stored
460 * in one of the FIB tables.
462 typedef struct fib_entry_t_ {
464 * Base class. The entry's node representation in the graph.
468 * The prefix of the route. this is const just to be sure.
469 * It is the entry's key/identity and so should never change.
471 const fib_prefix_t fe_prefix;
473 * The index of the FIB table this entry is in
477 * The load-balance used for forwarding.
479 * We don't share the EOS and non-EOS even in case when they could be
481 * - complexity & reliability v. memory
482 * determining the conditions where sharing is possible is non-trivial.
483 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
484 * and so save a few clock cycles in the DP imposition node since we can
485 * paint the header straight on without the need to check the packet
486 * type to derive the EOS bit value.
490 * Vector of source infos.
491 * Most entries will only have 1 source. So we optimise for memory usage,
492 * which is preferable since we have many entries.
494 fib_entry_src_t *fe_srcs;
496 * the path-list for which this entry is a child. This is also the path-list
497 * that is contributing forwarding for this entry.
499 fib_node_index_t fe_parent;
501 * index of this entry in the parent's child list.
502 * This is set when this entry is added as a child, but can also
503 * be changed by the parent as it manages its list.
508 * A vector of delegates.
510 fib_entry_delegate_t *fe_delegates;
513 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
514 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
516 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
517 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
518 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
520 extern u8 *format_fib_entry (u8 * s, va_list * args);
521 extern u8 *format_fib_source (u8 * s, va_list * args);
523 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
524 const fib_prefix_t *prefix,
526 fib_entry_flag_t flags,
527 const dpo_id_t *dpo);
529 extern fib_node_index_t fib_entry_create (u32 fib_index,
530 const fib_prefix_t *prefix,
532 fib_entry_flag_t flags,
533 const fib_route_path_t *paths);
534 extern void fib_entry_update (fib_node_index_t fib_entry_index,
536 fib_entry_flag_t flags,
537 const fib_route_path_t *paths);
539 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
541 fib_entry_flag_t flags,
542 const fib_route_path_t *rpath);
543 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
545 fib_entry_flag_t flags,
546 const dpo_id_t *dpo);
547 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
549 fib_entry_flag_t flags,
550 const dpo_id_t *dpo);
551 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
552 fib_source_t source);
554 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
556 const fib_route_path_t *rpath);
558 extern void fib_entry_inherit(fib_node_index_t cover,
559 fib_node_index_t covered);
561 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
562 fib_source_t source);
564 extern void fib_entry_recalculate_forwarding(
565 fib_node_index_t fib_entry_index);
566 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
568 extern void fib_entry_contribute_forwarding(
569 fib_node_index_t fib_entry_index,
570 fib_forward_chain_type_t type,
572 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
573 fib_node_index_t fib_entry_index);
574 extern adj_index_t fib_entry_get_adj_for_source(
575 fib_node_index_t fib_entry_index,
576 fib_source_t source);
577 extern const int fib_entry_get_dpo_for_source (
578 fib_node_index_t fib_entry_index,
582 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
584 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
586 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
587 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
588 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
589 fib_node_index_t **entry_indicies);
591 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
592 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
594 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
595 fib_node_type_t type,
596 fib_node_index_t child_index);
597 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
599 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
600 extern u32 fib_entry_get_resolving_interface_for_source(
601 fib_node_index_t fib_entry_index,
602 fib_source_t source);
604 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
605 fib_route_path_encode_t **api_rpaths);
606 extern const fib_prefix_t *fib_entry_get_prefix(fib_node_index_t fib_entry_index);
607 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
608 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
611 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
612 fib_source_t source);
614 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
615 extern fib_entry_flag_t fib_entry_get_flags_for_source(
616 fib_node_index_t fib_entry_index,
617 fib_source_t source);
618 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
619 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
620 fib_source_t source);
622 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
623 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
624 extern int fib_entry_is_host(fib_node_index_t fib_entry_index);
625 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
626 flow_hash_config_t hash_config);
628 extern void fib_entry_module_init(void);
630 extern u32 fib_entry_get_stats_index(fib_node_index_t fib_entry_index);
633 * unsafe... beware the raw pointer.
635 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
636 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
639 * for testing purposes.
641 extern u32 fib_entry_pool_size(void);