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/adj/adj.h>
21 #include <vnet/ip/ip.h>
22 #include <vnet/dpo/dpo.h>
25 * The different sources that can create a route.
26 * The sources are defined here with their relative priority order.
27 * The lower the value the higher the priority
29 typedef enum fib_source_t_ {
32 * This is not a real source, so don't use it to source a prefix.
33 * It exists here to provide a value for inexistant/uninitialized source
35 FIB_SOURCE_INVALID = 0,
37 * Marker. Add new values after this one.
41 * Special sources. These are for entries that are added to all
42 * FIBs by default, and should never be over-ridden (hence they
43 * are the highest priority)
45 FIB_SOURCE_SPECIAL = FIB_SOURCE_FIRST,
47 * Classify. A route that links directly to a classify adj
51 * A route the is being 'proxied' on behalf of another device
55 * Route added as a result of interface configuration.
56 * this will also come from the API/CLI, but the distinction is
57 * that is from confiiguration on an interface, not a 'ip route' command
65 * A high priority source a plugin can use
69 * From the BIER subsystem
77 * From the control plane API
85 * A low (below routing) priority source a plugin can use
87 FIB_SOURCE_PLUGIN_LOW,
103 FIB_SOURCE_IP6_ND_PROXY,
105 * IPv6 ND (seen in the link-local tables)
110 * routes created as a result of ARP/ND entries. This is lower priority
111 * then the API/CLI. This is on purpose. trust me.
115 * MPLS label. The prefix has been assigned a local label. This source
116 * never provides forwarding information, instead it acts as a place-holder
117 * so the association of label to prefix can be maintained
121 * Attached Export source.
122 * routes created as a result of attahced export. routes thus sourced
123 * will be present in the export tables
127 * Recursive resolution source.
128 * Used to install an entry that is the resolution traget of another.
132 * uRPF bypass/exemption.
133 * Used to install an entry that is exempt from the loose uRPF check
135 FIB_SOURCE_URPF_EXEMPT,
137 * The default route source.
138 * The default route is always added to the FIB table (like the
139 * special sources) but we need to be able to over-ride it with
140 * 'ip route' sources when provided
142 FIB_SOURCE_DEFAULT_ROUTE,
144 * The interpose source.
145 * This is not a real source, so don't use it to source a prefix.
146 * It exists here to provide a value against which to register to the
147 * VFT for providing the interpose actions to a real source.
149 FIB_SOURCE_INTERPOSE,
151 * Marker. add new entries before this one.
153 FIB_SOURCE_LAST = FIB_SOURCE_INTERPOSE,
154 } __attribute__ ((packed)) fib_source_t;
156 STATIC_ASSERT (sizeof(fib_source_t) == 1,
157 "FIB too many sources");
160 * The maximum number of sources
162 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
164 #define FIB_SOURCES { \
165 [FIB_SOURCE_INVALID] = "invalid", \
166 [FIB_SOURCE_SPECIAL] = "special", \
167 [FIB_SOURCE_INTERFACE] = "interface", \
168 [FIB_SOURCE_PROXY] = "proxy", \
169 [FIB_SOURCE_BIER] = "BIER", \
170 [FIB_SOURCE_6RD] = "6RD", \
171 [FIB_SOURCE_API] = "API", \
172 [FIB_SOURCE_CLI] = "CLI", \
173 [FIB_SOURCE_ADJ] = "adjacency", \
174 [FIB_SOURCE_MAP] = "MAP", \
175 [FIB_SOURCE_SR] = "SR", \
176 [FIB_SOURCE_LISP] = "LISP", \
177 [FIB_SOURCE_CLASSIFY] = "classify", \
178 [FIB_SOURCE_DHCP] = "DHCP", \
179 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
180 [FIB_SOURCE_IP6_ND] = "IPv6-nd", \
181 [FIB_SOURCE_RR] = "recursive-resolution", \
182 [FIB_SOURCE_AE] = "attached_export", \
183 [FIB_SOURCE_MPLS] = "mpls", \
184 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
185 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
186 [FIB_SOURCE_PLUGIN_HI] = "plugin-hi", \
187 [FIB_SOURCE_PLUGIN_LOW] = "plugin-low", \
188 [FIB_SOURCE_INTERPOSE] = "interpose", \
191 #define FOR_EACH_FIB_SOURCE(_item) \
192 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
195 * The different sources that can create a route.
196 * The sources are defined here with their relative priority order.
197 * The lower the value the higher the priority
199 typedef enum fib_entry_attribute_t_ {
201 * Marker. Add new values after this one.
203 FIB_ENTRY_ATTRIBUTE_FIRST,
205 * Connected. The prefix is configured on an interface.
207 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
209 * Attached. The prefix is attached to an interface.
211 FIB_ENTRY_ATTRIBUTE_ATTACHED,
213 * The route is an explicit drop.
215 FIB_ENTRY_ATTRIBUTE_DROP,
217 * The route is exclusive. The client creating the route is
218 * providing an exclusive adjacency.
220 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
222 * The route is attached cross tables and thus imports covered
223 * prefixes from the other table.
225 FIB_ENTRY_ATTRIBUTE_IMPORT,
227 * The prefix/address is local to this device
229 FIB_ENTRY_ATTRIBUTE_LOCAL,
231 * The prefix/address is a multicast prefix.
232 * this aplies only to MPLS. IP multicast is handled by mfib
234 FIB_ENTRY_ATTRIBUTE_MULTICAST,
236 * The prefix/address exempted from loose uRPF check
237 * To be used with caution
239 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
241 * The prefix/address exempted from attached export
243 FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT,
245 * This FIB entry imposes its source information on all prefixes
248 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
250 * The interpose attribute.
251 * place the forwarding provided by the source infront of the forwarding
252 * provided by the best source, or failing that, by the cover.
254 FIB_ENTRY_ATTRIBUTE_INTERPOSE,
256 * Marker. add new entries before this one.
258 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_INTERPOSE,
259 } fib_entry_attribute_t;
261 #define FIB_ENTRY_ATTRIBUTES { \
262 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
263 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
264 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
265 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
266 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
267 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
268 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
269 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
270 [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export", \
271 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
272 [FIB_ENTRY_ATTRIBUTE_INTERPOSE] = "interpose", \
275 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
276 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
277 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
280 typedef enum fib_entry_flag_t_ {
281 FIB_ENTRY_FLAG_NONE = 0,
282 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
283 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
284 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
285 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
286 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
287 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
288 FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT),
289 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
290 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
291 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
292 FIB_ENTRY_FLAG_INTERPOSE = (1 << FIB_ENTRY_ATTRIBUTE_INTERPOSE),
293 } __attribute__((packed)) fib_entry_flag_t;
295 extern u8 * format_fib_entry_flags(u8 *s, va_list *args);
298 * Flags for the source data
300 typedef enum fib_entry_src_attribute_t_ {
302 * Marker. Add new values after this one.
304 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
306 * the source has been added to the entry
308 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
310 * the source is contributing forwarding
312 FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING,
314 * the source is active/best
316 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
318 * the source is stale
320 FIB_ENTRY_SRC_ATTRIBUTE_STALE,
322 * the source is inherited from its cover
324 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
326 * Marker. add new entries before this one.
328 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
329 } fib_entry_src_attribute_t;
332 #define FIB_ENTRY_SRC_ATTRIBUTES { \
333 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
334 [FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING] = "contributing", \
335 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
336 [FIB_ENTRY_SRC_ATTRIBUTE_STALE] = "stale", \
337 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
340 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
341 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
342 _item <= FIB_ENTRY_SRC_ATTRIBUTE_LAST; \
345 typedef enum fib_entry_src_flag_t_ {
346 FIB_ENTRY_SRC_FLAG_NONE = 0,
347 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
348 FIB_ENTRY_SRC_FLAG_CONTRIBUTING = (1 << FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING),
349 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
350 FIB_ENTRY_SRC_FLAG_STALE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_STALE),
351 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
352 } __attribute__ ((packed)) fib_entry_src_flag_t;
354 extern u8 * format_fib_entry_src_flags(u8 *s, va_list *args);
357 * Keep the size of the flags field to 2 bytes, so it
358 * can be placed next to the 2 bytes reference count
360 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
361 "FIB entry flags field size too big");
364 * Information related to the source of a FIB entry
366 typedef struct fib_entry_src_t_ {
368 * A vector of path extensions
370 fib_path_ext_list_t fes_path_exts;
373 * The path-list created by the source
375 fib_node_index_t fes_pl;
378 * Flags the source contributes to the entry
380 fib_entry_flag_t fes_entry_flags;
383 * Which source this info block is for
385 fib_source_t fes_src;
388 * Flags on the source
390 fib_entry_src_flag_t fes_flags;
393 * 1 bytes ref count. This is not the number of users of the Entry
394 * (which is itself not large, due to path-list sharing), but the number
395 * of times a given source has been added. Which is even fewer
400 * Source specific info
405 * the index of the FIB entry that is the covering entry
407 fib_node_index_t fesr_cover;
409 * This source's index in the cover's list
415 * the index of the FIB entry that is the covering entry
417 fib_node_index_t fesi_cover;
419 * This source's index in the cover's list
423 * DPO type to interpose. The dpo type needs to have registered
424 * it's 'contribute interpose' callback function.
430 * the index of the FIB entry that is the covering entry
432 fib_node_index_t fesa_cover;
434 * This source's index in the cover's list
440 * the index of the FIB entry that is the covering entry
442 fib_node_index_t fesi_cover;
444 * This source's index in the cover's list
450 * This MPLS local label associated with the prefix.
452 mpls_label_t fesm_label;
455 * the indicies of the LFIB entries created
457 fib_node_index_t fesm_lfes[2];
461 * The source FIB index.
463 fib_node_index_t fesl_fib_index;
469 * An entry in a FIB table.
471 * This entry represents a route added to the FIB that is stored
472 * in one of the FIB tables.
474 typedef struct fib_entry_t_ {
476 * Base class. The entry's node representation in the graph.
480 * The prefix of the route. this is const just to be sure.
481 * It is the entry's key/identity and so should never change.
483 const fib_prefix_t fe_prefix;
485 * The index of the FIB table this entry is in
489 * The load-balance used for forwarding.
491 * We don't share the EOS and non-EOS even in case when they could be
493 * - complexity & reliability v. memory
494 * determining the conditions where sharing is possible is non-trivial.
495 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
496 * and so save a few clock cycles in the DP imposition node since we can
497 * paint the header straight on without the need to check the packet
498 * type to derive the EOS bit value.
502 * Vector of source infos.
503 * Most entries will only have 1 source. So we optimise for memory usage,
504 * which is preferable since we have many entries.
506 fib_entry_src_t *fe_srcs;
508 * the path-list for which this entry is a child. This is also the path-list
509 * that is contributing forwarding for this entry.
511 fib_node_index_t fe_parent;
513 * index of this entry in the parent's child list.
514 * This is set when this entry is added as a child, but can also
515 * be changed by the parent as it manages its list.
520 * A vector of delegate indices.
522 index_t *fe_delegates;
525 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
526 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
528 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
529 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
530 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
532 extern u8 *format_fib_entry (u8 * s, va_list * args);
533 extern u8 *format_fib_source (u8 * s, va_list * args);
535 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
536 const fib_prefix_t *prefix,
538 fib_entry_flag_t flags,
539 const dpo_id_t *dpo);
541 extern fib_node_index_t fib_entry_create (u32 fib_index,
542 const fib_prefix_t *prefix,
544 fib_entry_flag_t flags,
545 const fib_route_path_t *paths);
546 extern void fib_entry_update (fib_node_index_t fib_entry_index,
548 fib_entry_flag_t flags,
549 const fib_route_path_t *paths);
551 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
553 fib_entry_flag_t flags,
554 const fib_route_path_t *rpaths);
555 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
557 fib_entry_flag_t flags,
558 const dpo_id_t *dpo);
559 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
561 fib_entry_flag_t flags,
562 const dpo_id_t *dpo);
563 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
564 fib_source_t source);
566 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
568 const fib_route_path_t *rpaths);
570 extern void fib_entry_inherit(fib_node_index_t cover,
571 fib_node_index_t covered);
573 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
574 fib_source_t source);
576 extern void fib_entry_recalculate_forwarding(
577 fib_node_index_t fib_entry_index);
578 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
580 extern void fib_entry_contribute_forwarding(
581 fib_node_index_t fib_entry_index,
582 fib_forward_chain_type_t type,
584 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
585 fib_node_index_t fib_entry_index);
586 extern adj_index_t fib_entry_get_adj_for_source(
587 fib_node_index_t fib_entry_index,
588 fib_source_t source);
589 extern const int fib_entry_get_dpo_for_source (
590 fib_node_index_t fib_entry_index,
594 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
596 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
598 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
599 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
600 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
601 fib_node_index_t **entry_indicies);
603 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
604 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
606 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
607 fib_node_type_t type,
608 fib_node_index_t child_index);
609 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
611 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
612 extern u32 fib_entry_get_resolving_interface_for_source(
613 fib_node_index_t fib_entry_index,
614 fib_source_t source);
616 extern fib_route_path_t* fib_entry_encode(fib_node_index_t fib_entry_index);
617 extern const fib_prefix_t* fib_entry_get_prefix(fib_node_index_t fib_entry_index);
618 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
619 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
622 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
623 fib_source_t source);
625 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
626 extern fib_entry_flag_t fib_entry_get_flags_for_source(
627 fib_node_index_t fib_entry_index,
628 fib_source_t source);
629 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
630 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
631 fib_source_t source);
633 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
634 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
635 extern int fib_entry_is_host(fib_node_index_t fib_entry_index);
636 extern int fib_entry_is_marked(fib_node_index_t fib_entry_index, fib_source_t source);
637 extern void fib_entry_mark(fib_node_index_t fib_entry_index, fib_source_t source);
638 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
639 flow_hash_config_t hash_config);
641 extern void fib_entry_module_init(void);
643 extern u32 fib_entry_get_stats_index(fib_node_index_t fib_entry_index);
646 * unsafe... beware the raw pointer.
648 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
649 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
652 * for testing purposes.
654 extern u32 fib_entry_pool_size(void);