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
68 * From the control plane API
76 * A low (below routing) priority source a plugin can use
78 FIB_SOURCE_PLUGIN_LOW,
94 FIB_SOURCE_IP6_ND_PROXY,
96 * IPv6 ND (seen in the link-local tables)
101 * routes created as a result of ARP/ND entries. This is lower priority
102 * then the API/CLI. This is on purpose. trust me.
106 * MPLS label. The prefix has been assigned a local label. This source
107 * never provides forwarding information, instead it acts as a place-holder
108 * so the association of label to prefix can be maintained
112 * Attached Export source.
113 * routes created as a result of attahced export. routes thus sourced
114 * will be present in the export tables
118 * Recursive resolution source.
119 * Used to install an entry that is the resolution traget of another.
123 * uRPF bypass/exemption.
124 * Used to install an entry that is exempt from the loose uRPF check
126 FIB_SOURCE_URPF_EXEMPT,
128 * The default route source.
129 * The default route is always added to the FIB table (like the
130 * special sources) but we need to be able to over-ride it with
131 * 'ip route' sources when provided
133 FIB_SOURCE_DEFAULT_ROUTE,
135 * The interpose source.
136 * This is not a real source, so don't use it to source a prefix.
137 * It exists here to provide a value against which to register to the
138 * VFT for providing the interpose actions to a real source.
140 FIB_SOURCE_INTERPOSE,
142 * Marker. add new entries before this one.
144 FIB_SOURCE_LAST = FIB_SOURCE_INTERPOSE,
145 } __attribute__ ((packed)) fib_source_t;
147 STATIC_ASSERT (sizeof(fib_source_t) == 1,
148 "FIB too many sources");
151 * The maximum number of sources
153 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
155 #define FIB_SOURCES { \
156 [FIB_SOURCE_SPECIAL] = "special", \
157 [FIB_SOURCE_INTERFACE] = "interface", \
158 [FIB_SOURCE_PROXY] = "proxy", \
159 [FIB_SOURCE_BIER] = "BIER", \
160 [FIB_SOURCE_API] = "API", \
161 [FIB_SOURCE_CLI] = "CLI", \
162 [FIB_SOURCE_ADJ] = "adjacency", \
163 [FIB_SOURCE_MAP] = "MAP", \
164 [FIB_SOURCE_SR] = "SR", \
165 [FIB_SOURCE_LISP] = "LISP", \
166 [FIB_SOURCE_CLASSIFY] = "classify", \
167 [FIB_SOURCE_DHCP] = "DHCP", \
168 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
169 [FIB_SOURCE_IP6_ND] = "IPv6-nd", \
170 [FIB_SOURCE_RR] = "recursive-resolution", \
171 [FIB_SOURCE_AE] = "attached_export", \
172 [FIB_SOURCE_MPLS] = "mpls", \
173 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
174 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
175 [FIB_SOURCE_PLUGIN_HI] = "plugin-hi", \
176 [FIB_SOURCE_PLUGIN_LOW] = "plugin-low", \
177 [FIB_SOURCE_INTERPOSE] = "interpose", \
180 #define FOR_EACH_FIB_SOURCE(_item) \
181 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
184 * The different sources that can create a route.
185 * The sources are defined here the thier relative priority order.
186 * The lower the value the higher the priority
188 typedef enum fib_entry_attribute_t_ {
190 * Marker. Add new values after this one.
192 FIB_ENTRY_ATTRIBUTE_FIRST,
194 * Connected. The prefix is configured on an interface.
196 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
198 * Attached. The prefix is attached to an interface.
200 FIB_ENTRY_ATTRIBUTE_ATTACHED,
202 * The route is an explicit drop.
204 FIB_ENTRY_ATTRIBUTE_DROP,
206 * The route is exclusive. The client creating the route is
207 * providing an exclusive adjacency.
209 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
211 * The route is attached cross tables and thus imports covered
212 * prefixes from the other table.
214 FIB_ENTRY_ATTRIBUTE_IMPORT,
216 * The prefix/address is local to this device
218 FIB_ENTRY_ATTRIBUTE_LOCAL,
220 * The prefix/address is a multicast prefix.
221 * this aplies only to MPLS. IP multicast is handled by mfib
223 FIB_ENTRY_ATTRIBUTE_MULTICAST,
225 * The prefix/address exempted from loose uRPF check
226 * To be used with caution
228 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
230 * The prefix/address exempted from attached export
232 FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT,
234 * This FIB entry imposes its source information on all prefixes
237 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
239 * The interpose attribute.
240 * place the forwarding provided by the source infront of the forwarding
241 * provided by the best source, or failing that, by the cover.
243 FIB_ENTRY_ATTRIBUTE_INTERPOSE,
245 * Marker. add new entries before this one.
247 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_INTERPOSE,
248 } fib_entry_attribute_t;
250 #define FIB_ENTRY_ATTRIBUTES { \
251 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
252 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
253 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
254 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
255 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
256 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
257 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
258 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
259 [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export", \
260 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
261 [FIB_ENTRY_ATTRIBUTE_INTERPOSE] = "interpose", \
264 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
265 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
266 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
269 typedef enum fib_entry_flag_t_ {
270 FIB_ENTRY_FLAG_NONE = 0,
271 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
272 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
273 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
274 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
275 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
276 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
277 FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT),
278 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
279 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
280 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
281 FIB_ENTRY_FLAG_INTERPOSE = (1 << FIB_ENTRY_ATTRIBUTE_INTERPOSE),
282 } __attribute__((packed)) fib_entry_flag_t;
285 * Flags for the source data
287 typedef enum fib_entry_src_attribute_t_ {
289 * Marker. Add new values after this one.
291 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
293 * the source has been added to the entry
295 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
297 * the source is contributing forwarding
299 FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING,
301 * the source is active/best
303 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
305 * the source is inherited from its cover
307 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
309 * Marker. add new entries before this one.
311 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
312 } fib_entry_src_attribute_t;
315 #define FIB_ENTRY_SRC_ATTRIBUTES { \
316 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
317 [FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING] = "contributing", \
318 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
319 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
322 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
323 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
324 _item <= FIB_ENTRY_SRC_ATTRIBUTE_LAST; \
327 typedef enum fib_entry_src_flag_t_ {
328 FIB_ENTRY_SRC_FLAG_NONE = 0,
329 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
330 FIB_ENTRY_SRC_FLAG_CONTRIBUTING = (1 << FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING),
331 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
332 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
333 } __attribute__ ((packed)) fib_entry_src_flag_t;
336 * Keep the size of the flags field to 2 bytes, so it
337 * can be placed next to the 2 bytes reference count
339 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
340 "FIB entry flags field size too big");
343 * Information related to the source of a FIB entry
345 typedef struct fib_entry_src_t_ {
347 * A vector of path extensions
349 fib_path_ext_list_t fes_path_exts;
352 * The path-list created by the source
354 fib_node_index_t fes_pl;
357 * Flags the source contributes to the entry
359 fib_entry_flag_t fes_entry_flags;
362 * Which source this info block is for
364 fib_source_t fes_src;
367 * Flags on the source
369 fib_entry_src_flag_t fes_flags;
372 * 1 bytes ref count. This is not the number of users of the Entry
373 * (which is itself not large, due to path-list sharing), but the number
374 * of times a given source has been added. Which is even fewer
379 * Source specific info
384 * the index of the FIB entry that is the covering entry
386 fib_node_index_t fesr_cover;
388 * This source's index in the cover's list
394 * the index of the FIB entry that is the covering entry
396 fib_node_index_t fesi_cover;
398 * This source's index in the cover's list
402 * DPO type to interpose. The dpo type needs to have registered
403 * it's 'contribute interpose' callback function.
409 * the index of the FIB entry that is the covering entry
411 fib_node_index_t fesa_cover;
413 * This source's index in the cover's list
419 * the index of the FIB entry that is the covering entry
421 fib_node_index_t fesi_cover;
423 * This source's index in the cover's list
429 * This MPLS local label associated with the prefix.
431 mpls_label_t fesm_label;
434 * the indicies of the LFIB entries created
436 fib_node_index_t fesm_lfes[2];
440 * The source FIB index.
442 fib_node_index_t fesl_fib_index;
448 * An entry in a FIB table.
450 * This entry represents a route added to the FIB that is stored
451 * in one of the FIB tables.
453 typedef struct fib_entry_t_ {
455 * Base class. The entry's node representation in the graph.
459 * The prefix of the route. this is const just to be sure.
460 * It is the entry's key/identity and so should never change.
462 const fib_prefix_t fe_prefix;
464 * The index of the FIB table this entry is in
468 * The load-balance used for forwarding.
470 * We don't share the EOS and non-EOS even in case when they could be
472 * - complexity & reliability v. memory
473 * determining the conditions where sharing is possible is non-trivial.
474 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
475 * and so save a few clock cycles in the DP imposition node since we can
476 * paint the header straight on without the need to check the packet
477 * type to derive the EOS bit value.
481 * Vector of source infos.
482 * Most entries will only have 1 source. So we optimise for memory usage,
483 * which is preferable since we have many entries.
485 fib_entry_src_t *fe_srcs;
487 * the path-list for which this entry is a child. This is also the path-list
488 * that is contributing forwarding for this entry.
490 fib_node_index_t fe_parent;
492 * index of this entry in the parent's child list.
493 * This is set when this entry is added as a child, but can also
494 * be changed by the parent as it manages its list.
499 * A vector of delegates.
501 fib_entry_delegate_t *fe_delegates;
504 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
505 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
507 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
508 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
509 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
511 extern u8 *format_fib_entry (u8 * s, va_list * args);
512 extern u8 *format_fib_source (u8 * s, va_list * args);
514 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
515 const fib_prefix_t *prefix,
517 fib_entry_flag_t flags,
518 const dpo_id_t *dpo);
520 extern fib_node_index_t fib_entry_create (u32 fib_index,
521 const fib_prefix_t *prefix,
523 fib_entry_flag_t flags,
524 const fib_route_path_t *paths);
525 extern void fib_entry_update (fib_node_index_t fib_entry_index,
527 fib_entry_flag_t flags,
528 const fib_route_path_t *paths);
530 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
532 fib_entry_flag_t flags,
533 const fib_route_path_t *rpath);
534 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
536 fib_entry_flag_t flags,
537 const dpo_id_t *dpo);
538 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
540 fib_entry_flag_t flags,
541 const dpo_id_t *dpo);
542 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
543 fib_source_t source);
545 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
547 const fib_route_path_t *rpath);
549 extern void fib_entry_inherit(fib_node_index_t cover,
550 fib_node_index_t covered);
552 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
553 fib_source_t source);
555 extern void fib_entry_recalculate_forwarding(
556 fib_node_index_t fib_entry_index);
557 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
559 extern void fib_entry_contribute_forwarding(
560 fib_node_index_t fib_entry_index,
561 fib_forward_chain_type_t type,
563 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
564 fib_node_index_t fib_entry_index);
565 extern adj_index_t fib_entry_get_adj_for_source(
566 fib_node_index_t fib_entry_index,
567 fib_source_t source);
568 extern const int fib_entry_get_dpo_for_source (
569 fib_node_index_t fib_entry_index,
573 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
575 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
577 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
578 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
579 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
580 fib_node_index_t **entry_indicies);
582 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
583 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
585 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
586 fib_node_type_t type,
587 fib_node_index_t child_index);
588 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
590 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
591 extern u32 fib_entry_get_resolving_interface_for_source(
592 fib_node_index_t fib_entry_index,
593 fib_source_t source);
595 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
596 fib_route_path_encode_t **api_rpaths);
597 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
599 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
600 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
603 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
604 fib_source_t source);
606 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
607 extern fib_entry_flag_t fib_entry_get_flags_for_source(
608 fib_node_index_t fib_entry_index,
609 fib_source_t source);
610 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
611 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
612 fib_source_t source);
614 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
615 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
616 extern int fib_entry_is_host(fib_node_index_t fib_entry_index);
617 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
618 flow_hash_config_t hash_config);
620 extern void fib_entry_module_init(void);
623 * unsafe... beware the raw pointer.
625 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
626 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
629 * for testing purposes.
631 extern u32 fib_entry_pool_size(void);