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
90 FIB_SOURCE_IP6_ND_PROXY,
92 * IPv6 ND (seen in the link-local tables)
97 * routes created as a result of ARP/ND entries. This is lower priority
98 * then the API/CLI. This is on purpose. trust me.
102 * MPLS label. The prefix has been assigned a local label. This source
103 * never provides forwarding information, instead it acts as a place-holder
104 * so the association of label to prefix can be maintained
108 * Attached Export source.
109 * routes created as a result of attahced export. routes thus sourced
110 * will be present in the export tables
114 * Recursive resolution source.
115 * Used to install an entry that is the resolution traget of another.
119 * uRPF bypass/exemption.
120 * Used to install an entry that is exempt from the loose uRPF check
122 FIB_SOURCE_URPF_EXEMPT,
124 * The default route source.
125 * The default route is always added to the FIB table (like the
126 * special sources) but we need to be able to over-ride it with
127 * 'ip route' sources when provided
129 FIB_SOURCE_DEFAULT_ROUTE,
131 * Marker. add new entries before this one.
133 FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
134 } __attribute__ ((packed)) fib_source_t;
136 STATIC_ASSERT (sizeof(fib_source_t) == 1,
137 "FIB too many sources");
140 * The maximum number of sources
142 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
144 #define FIB_SOURCES { \
145 [FIB_SOURCE_SPECIAL] = "special", \
146 [FIB_SOURCE_INTERFACE] = "interface", \
147 [FIB_SOURCE_PROXY] = "proxy", \
148 [FIB_SOURCE_BIER] = "BIER", \
149 [FIB_SOURCE_API] = "API", \
150 [FIB_SOURCE_CLI] = "CLI", \
151 [FIB_SOURCE_ADJ] = "adjacency", \
152 [FIB_SOURCE_MAP] = "MAP", \
153 [FIB_SOURCE_SR] = "SR", \
154 [FIB_SOURCE_LISP] = "LISP", \
155 [FIB_SOURCE_CLASSIFY] = "classify", \
156 [FIB_SOURCE_DHCP] = "DHCP", \
157 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
158 [FIB_SOURCE_IP6_ND] = "IPv6-nd", \
159 [FIB_SOURCE_RR] = "recursive-resolution", \
160 [FIB_SOURCE_AE] = "attached_export", \
161 [FIB_SOURCE_MPLS] = "mpls", \
162 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
163 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
164 [FIB_SOURCE_PLUGIN_HI] = "plugin-hi", \
167 #define FOR_EACH_FIB_SOURCE(_item) \
168 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
171 * The different sources that can create a route.
172 * The sources are defined here the thier relative priority order.
173 * The lower the value the higher the priority
175 typedef enum fib_entry_attribute_t_ {
177 * Marker. Add new values after this one.
179 FIB_ENTRY_ATTRIBUTE_FIRST,
181 * Connected. The prefix is configured on an interface.
183 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
185 * Attached. The prefix is attached to an interface.
187 FIB_ENTRY_ATTRIBUTE_ATTACHED,
189 * The route is an explicit drop.
191 FIB_ENTRY_ATTRIBUTE_DROP,
193 * The route is exclusive. The client creating the route is
194 * providing an exclusive adjacency.
196 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
198 * The route is attached cross tables and thus imports covered
199 * prefixes from the other table.
201 FIB_ENTRY_ATTRIBUTE_IMPORT,
203 * The prefix/address is local to this device
205 FIB_ENTRY_ATTRIBUTE_LOCAL,
207 * The prefix/address is a multicast prefix.
208 * this aplies only to MPLS. IP multicast is handled by mfib
210 FIB_ENTRY_ATTRIBUTE_MULTICAST,
212 * The prefix/address exempted from loose uRPF check
213 * To be used with caution
215 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
217 * The prefix/address exempted from attached export
219 FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT,
221 * This FIB entry imposes its source information on all prefixes
224 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
226 * Marker. add new entries before this one.
228 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
229 } fib_entry_attribute_t;
231 #define FIB_ENTRY_ATTRIBUTES { \
232 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
233 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
234 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
235 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
236 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
237 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
238 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
239 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
240 [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export", \
241 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
244 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
245 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
246 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
249 typedef enum fib_entry_flag_t_ {
250 FIB_ENTRY_FLAG_NONE = 0,
251 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
252 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
253 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
254 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
255 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
256 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
257 FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT),
258 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
259 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
260 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
261 } __attribute__((packed)) fib_entry_flag_t;
264 * Flags for the source data
266 typedef enum fib_entry_src_attribute_t_ {
268 * Marker. Add new values after this one.
270 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
272 * the source has been added to the entry
274 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
276 * the source is active/best
278 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
280 * the source is inherited from its cover
282 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
284 * Marker. add new entries before this one.
286 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
287 } fib_entry_src_attribute_t;
289 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
291 #define FIB_ENTRY_SRC_ATTRIBUTES { \
292 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
293 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
294 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
297 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
298 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
299 _item < FIB_ENTRY_SRC_ATTRIBUTE_MAX; \
302 typedef enum fib_entry_src_flag_t_ {
303 FIB_ENTRY_SRC_FLAG_NONE = 0,
304 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
305 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
306 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
307 } __attribute__ ((packed)) fib_entry_src_flag_t;
310 * Keep the size of the flags field to 2 bytes, so it
311 * can be placed next to the 2 bytes reference count
313 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
314 "FIB entry flags field size too big");
317 * Information related to the source of a FIB entry
319 typedef struct fib_entry_src_t_ {
321 * A vector of path extensions
323 fib_path_ext_list_t fes_path_exts;
326 * The path-list created by the source
328 fib_node_index_t fes_pl;
330 * Which source this info block is for
332 fib_source_t fes_src;
334 * Flags on the source
336 fib_entry_src_flag_t fes_flags;
339 * 1 bytes ref count. This is not the number of users of the Entry
340 * (which is itself not large, due to path-list sharing), but the number
341 * of times a given source has been added. Which is even fewer
346 * Flags the source contributes to the entry
348 fib_entry_flag_t fes_entry_flags;
351 * Source specific info
356 * the index of the FIB entry that is the covering entry
358 fib_node_index_t fesr_cover;
360 * This source's index in the cover's list
366 * the index of the FIB entry that is the covering entry
368 fib_node_index_t fesa_cover;
370 * This source's index in the cover's list
376 * the index of the FIB entry that is the covering entry
378 fib_node_index_t fesi_cover;
380 * This source's index in the cover's list
386 * This MPLS local label associated with the prefix.
388 mpls_label_t fesm_label;
391 * the indicies of the LFIB entries created
393 fib_node_index_t fesm_lfes[2];
397 * The source FIB index.
399 fib_node_index_t fesl_fib_index;
405 * An entry in a FIB table.
407 * This entry represents a route added to the FIB that is stored
408 * in one of the FIB tables.
410 typedef struct fib_entry_t_ {
412 * Base class. The entry's node representation in the graph.
416 * The prefix of the route. this is const just to be sure.
417 * It is the entry's key/identity and so should never change.
419 const fib_prefix_t fe_prefix;
421 * The index of the FIB table this entry is in
425 * The load-balance used for forwarding.
427 * We don't share the EOS and non-EOS even in case when they could be
429 * - complexity & reliability v. memory
430 * determining the conditions where sharing is possible is non-trivial.
431 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
432 * and so save a few clock cycles in the DP imposition node since we can
433 * paint the header straight on without the need to check the packet
434 * type to derive the EOS bit value.
438 * Vector of source infos.
439 * Most entries will only have 1 source. So we optimise for memory usage,
440 * which is preferable since we have many entries.
442 fib_entry_src_t *fe_srcs;
444 * the path-list for which this entry is a child. This is also the path-list
445 * that is contributing forwarding for this entry.
447 fib_node_index_t fe_parent;
449 * index of this entry in the parent's child list.
450 * This is set when this entry is added as a child, but can also
451 * be changed by the parent as it manages its list.
456 * A vector of delegates.
458 fib_entry_delegate_t *fe_delegates;
461 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
462 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
464 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
465 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
466 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
468 extern u8 *format_fib_entry (u8 * s, va_list * args);
469 extern u8 *format_fib_source (u8 * s, va_list * args);
471 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
472 const fib_prefix_t *prefix,
474 fib_entry_flag_t flags,
475 const dpo_id_t *dpo);
477 extern fib_node_index_t fib_entry_create (u32 fib_index,
478 const fib_prefix_t *prefix,
480 fib_entry_flag_t flags,
481 const fib_route_path_t *paths);
482 extern void fib_entry_update (fib_node_index_t fib_entry_index,
484 fib_entry_flag_t flags,
485 const fib_route_path_t *paths);
487 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
489 fib_entry_flag_t flags,
490 const fib_route_path_t *rpath);
491 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
493 fib_entry_flag_t flags,
494 const dpo_id_t *dpo);
495 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
497 fib_entry_flag_t flags,
498 const dpo_id_t *dpo);
499 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
500 fib_source_t source);
502 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
504 const fib_route_path_t *rpath);
506 extern void fib_entry_inherit(fib_node_index_t cover,
507 fib_node_index_t covered);
509 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
510 fib_source_t source);
512 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
514 extern void fib_entry_contribute_forwarding(
515 fib_node_index_t fib_entry_index,
516 fib_forward_chain_type_t type,
518 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
519 fib_node_index_t fib_entry_index);
520 extern adj_index_t fib_entry_get_adj_for_source(
521 fib_node_index_t fib_entry_index,
522 fib_source_t source);
523 extern const int fib_entry_get_dpo_for_source (
524 fib_node_index_t fib_entry_index,
528 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
530 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
532 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
533 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
534 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
535 fib_node_index_t **entry_indicies);
537 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
538 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
540 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
541 fib_node_type_t type,
542 fib_node_index_t child_index);
543 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
545 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
546 extern u32 fib_entry_get_resolving_interface_for_source(
547 fib_node_index_t fib_entry_index,
548 fib_source_t source);
550 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
551 fib_route_path_encode_t **api_rpaths);
552 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
554 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
555 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
558 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
559 fib_source_t source);
561 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
562 extern fib_entry_flag_t fib_entry_get_flags_for_source(
563 fib_node_index_t fib_entry_index,
564 fib_source_t source);
565 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
566 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
567 fib_source_t source);
569 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
570 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
571 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
572 flow_hash_config_t hash_config);
574 extern void fib_entry_module_init(void);
577 * unsafe... beware the raw pointer.
579 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
580 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
583 * for testing purposes.
585 extern u32 fib_entry_pool_size(void);