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,
93 * routes created as a result of ARP/ND entries. This is lower priority
94 * then the API/CLI. This is on purpose. trust me.
98 * MPLS label. The prefix has been assigned a local label. This source
99 * never provides forwarding information, instead it acts as a place-holder
100 * so the association of label to prefix can be maintained
104 * Attached Export source.
105 * routes created as a result of attahced export. routes thus sourced
106 * will be present in the export tables
110 * Recursive resolution source.
111 * Used to install an entry that is the resolution traget of another.
115 * uRPF bypass/exemption.
116 * Used to install an entry that is exempt from the loose uRPF check
118 FIB_SOURCE_URPF_EXEMPT,
120 * The default route source.
121 * The default route is always added to the FIB table (like the
122 * special sources) but we need to be able to over-ride it with
123 * 'ip route' sources when provided
125 FIB_SOURCE_DEFAULT_ROUTE,
127 * Marker. add new entries before this one.
129 FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
130 } __attribute__ ((packed)) fib_source_t;
132 STATIC_ASSERT (sizeof(fib_source_t) == 1,
133 "FIB too many sources");
136 * The maximum number of sources
138 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
140 #define FIB_SOURCES { \
141 [FIB_SOURCE_SPECIAL] = "special", \
142 [FIB_SOURCE_INTERFACE] = "interface", \
143 [FIB_SOURCE_PROXY] = "proxy", \
144 [FIB_SOURCE_BIER] = "BIER", \
145 [FIB_SOURCE_API] = "API", \
146 [FIB_SOURCE_CLI] = "CLI", \
147 [FIB_SOURCE_ADJ] = "adjacency", \
148 [FIB_SOURCE_MAP] = "MAP", \
149 [FIB_SOURCE_SR] = "SR", \
150 [FIB_SOURCE_LISP] = "LISP", \
151 [FIB_SOURCE_CLASSIFY] = "classify", \
152 [FIB_SOURCE_DHCP] = "DHCP", \
153 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
154 [FIB_SOURCE_RR] = "recursive-resolution", \
155 [FIB_SOURCE_AE] = "attached_export", \
156 [FIB_SOURCE_MPLS] = "mpls", \
157 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
158 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
161 #define FOR_EACH_FIB_SOURCE(_item) \
162 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
165 * The different sources that can create a route.
166 * The sources are defined here the thier relative priority order.
167 * The lower the value the higher the priority
169 typedef enum fib_entry_attribute_t_ {
171 * Marker. Add new values after this one.
173 FIB_ENTRY_ATTRIBUTE_FIRST,
175 * Connected. The prefix is configured on an interface.
177 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
179 * Attached. The prefix is attached to an interface.
181 FIB_ENTRY_ATTRIBUTE_ATTACHED,
183 * The route is an explicit drop.
185 FIB_ENTRY_ATTRIBUTE_DROP,
187 * The route is exclusive. The client creating the route is
188 * providing an exclusive adjacency.
190 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
192 * The route is attached cross tables and thus imports covered
193 * prefixes from the other table.
195 FIB_ENTRY_ATTRIBUTE_IMPORT,
197 * The prefix/address is local to this device
199 FIB_ENTRY_ATTRIBUTE_LOCAL,
201 * The prefix/address is a multicast prefix.
202 * this aplies only to MPLS. IP multicast is handled by mfib
204 FIB_ENTRY_ATTRIBUTE_MULTICAST,
206 * The prefix/address exempted from loose uRPF check
207 * To be used with caution
209 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
211 * This FIB entry imposes its source information on all prefixes
214 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
216 * Marker. add new entries before this one.
218 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
219 } fib_entry_attribute_t;
221 #define FIB_ENTRY_ATTRIBUTES { \
222 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
223 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
224 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
225 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
226 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
227 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
228 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
229 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
230 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
233 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
234 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
235 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
238 typedef enum fib_entry_flag_t_ {
239 FIB_ENTRY_FLAG_NONE = 0,
240 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
241 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
242 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
243 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
244 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
245 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
246 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
247 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
248 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
249 } __attribute__((packed)) fib_entry_flag_t;
252 * Flags for the source data
254 typedef enum fib_entry_src_attribute_t_ {
256 * Marker. Add new values after this one.
258 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
260 * the source has been added to the entry
262 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
264 * the source is active/best
266 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
268 * the source is inherited from its cover
270 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
272 * Marker. add new entries before this one.
274 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
275 } fib_entry_src_attribute_t;
277 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
279 #define FIB_ENTRY_SRC_ATTRIBUTES { \
280 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
281 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
282 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
285 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
286 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
287 _item < FIB_ENTRY_SRC_ATTRIBUTE_MAX; \
290 typedef enum fib_entry_src_flag_t_ {
291 FIB_ENTRY_SRC_FLAG_NONE = 0,
292 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
293 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
294 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
295 } __attribute__ ((packed)) fib_entry_src_flag_t;
298 * Keep the size of the flags field to 2 bytes, so it
299 * can be placed next to the 2 bytes reference count
301 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
302 "FIB entry flags field size too big");
305 * Information related to the source of a FIB entry
307 typedef struct fib_entry_src_t_ {
309 * A vector of path extensions
311 fib_path_ext_list_t fes_path_exts;
314 * The path-list created by the source
316 fib_node_index_t fes_pl;
318 * Which source this info block is for
320 fib_source_t fes_src;
322 * Flags on the source
324 fib_entry_src_flag_t fes_flags;
327 * 1 bytes ref count. This is not the number of users of the Entry
328 * (which is itself not large, due to path-list sharing), but the number
329 * of times a given source has been added. Which is even fewer
334 * Flags the source contributes to the entry
336 fib_entry_flag_t fes_entry_flags;
339 * Source specific info
344 * the index of the FIB entry that is the covering entry
346 fib_node_index_t fesr_cover;
348 * This source's index in the cover's list
354 * the index of the FIB entry that is the covering entry
356 fib_node_index_t fesa_cover;
358 * This source's index in the cover's list
364 * the index of the FIB entry that is the covering entry
366 fib_node_index_t fesi_cover;
368 * This source's index in the cover's list
374 * This MPLS local label associated with the prefix.
376 mpls_label_t fesm_label;
379 * the indicies of the LFIB entries created
381 fib_node_index_t fesm_lfes[2];
385 * The source FIB index.
387 fib_node_index_t fesl_fib_index;
393 * An entry in a FIB table.
395 * This entry represents a route added to the FIB that is stored
396 * in one of the FIB tables.
398 typedef struct fib_entry_t_ {
400 * Base class. The entry's node representation in the graph.
404 * The prefix of the route. this is const just to be sure.
405 * It is the entry's key/identity and so should never change.
407 const fib_prefix_t fe_prefix;
409 * The index of the FIB table this entry is in
413 * The load-balance used for forwarding.
415 * We don't share the EOS and non-EOS even in case when they could be
417 * - complexity & reliability v. memory
418 * determining the conditions where sharing is possible is non-trivial.
419 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
420 * and so save a few clock cycles in the DP imposition node since we can
421 * paint the header straight on without the need to check the packet
422 * type to derive the EOS bit value.
426 * Vector of source infos.
427 * Most entries will only have 1 source. So we optimise for memory usage,
428 * which is preferable since we have many entries.
430 fib_entry_src_t *fe_srcs;
432 * the path-list for which this entry is a child. This is also the path-list
433 * that is contributing forwarding for this entry.
435 fib_node_index_t fe_parent;
437 * index of this entry in the parent's child list.
438 * This is set when this entry is added as a child, but can also
439 * be changed by the parent as it manages its list.
444 * A vector of delegates.
446 fib_entry_delegate_t *fe_delegates;
449 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
450 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
452 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
453 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
454 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
456 extern u8 *format_fib_entry (u8 * s, va_list * args);
457 extern u8 *format_fib_source (u8 * s, va_list * args);
459 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
460 const fib_prefix_t *prefix,
462 fib_entry_flag_t flags,
463 const dpo_id_t *dpo);
465 extern fib_node_index_t fib_entry_create (u32 fib_index,
466 const fib_prefix_t *prefix,
468 fib_entry_flag_t flags,
469 const fib_route_path_t *paths);
470 extern void fib_entry_update (fib_node_index_t fib_entry_index,
472 fib_entry_flag_t flags,
473 const fib_route_path_t *paths);
475 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
477 fib_entry_flag_t flags,
478 const fib_route_path_t *rpath);
479 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
481 fib_entry_flag_t flags,
482 const dpo_id_t *dpo);
483 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
485 fib_entry_flag_t flags,
486 const dpo_id_t *dpo);
487 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
488 fib_source_t source);
490 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
492 const fib_route_path_t *rpath);
494 extern void fib_entry_inherit(fib_node_index_t cover,
495 fib_node_index_t covered);
497 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
498 fib_source_t source);
500 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
502 extern void fib_entry_contribute_forwarding(
503 fib_node_index_t fib_entry_index,
504 fib_forward_chain_type_t type,
506 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
507 fib_node_index_t fib_entry_index);
508 extern adj_index_t fib_entry_get_adj_for_source(
509 fib_node_index_t fib_entry_index,
510 fib_source_t source);
511 extern const int fib_entry_get_dpo_for_source (
512 fib_node_index_t fib_entry_index,
516 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
518 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
520 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
521 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
522 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
523 fib_node_index_t **entry_indicies);
525 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
526 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
528 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
529 fib_node_type_t type,
530 fib_node_index_t child_index);
531 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
533 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
534 extern u32 fib_entry_get_resolving_interface_for_source(
535 fib_node_index_t fib_entry_index,
536 fib_source_t source);
538 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
539 fib_route_path_encode_t **api_rpaths);
540 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
542 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
543 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
546 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
547 fib_source_t source);
549 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
550 extern fib_entry_flag_t fib_entry_get_flags_for_source(
551 fib_node_index_t fib_entry_index,
552 fib_source_t source);
553 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
554 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
555 fib_source_t source);
557 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
558 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
559 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
560 flow_hash_config_t hash_config);
562 extern void fib_entry_module_init(void);
565 * unsafe... beware the raw pointer.
567 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
568 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
571 * for testing purposes.
573 extern u32 fib_entry_pool_size(void);