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 * Route added as a result of interface configuration.
47 * this will also come from the API/CLI, but the distinction is
48 * that is from confiiguration on an interface, not a 'ip route' command
52 * A high priority source a plugin can use
56 * From the control plane API
85 * routes created as a result of ARP/ND entries. This is lower priority
86 * then the API/CLI. This is on purpose. trust me.
90 * MPLS label. The prefix has been assigned a local label. This source
91 * never provides forwarding information, instead it acts as a place-holder
92 * so the association of label to prefix can be maintained
96 * Attached Export source.
97 * routes created as a result of attahced export. routes thus sourced
98 * will be present in the export tables
102 * Recursive resolution source.
103 * Used to install an entry that is the resolution traget of another.
107 * uRPF bypass/exemption.
108 * Used to install an entry that is exempt from the loose uRPF check
110 FIB_SOURCE_URPF_EXEMPT,
112 * The default route source.
113 * The default route is always added to the FIB table (like the
114 * special sources) but we need to be able to over-ride it with
115 * 'ip route' sources when provided
117 FIB_SOURCE_DEFAULT_ROUTE,
119 * Marker. add new entries before this one.
121 FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
122 } __attribute__ ((packed)) fib_source_t;
124 STATIC_ASSERT (sizeof(fib_source_t) == 1,
125 "FIB too many sources");
128 * The maximum number of sources
130 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
132 #define FIB_SOURCES { \
133 [FIB_SOURCE_SPECIAL] = "special", \
134 [FIB_SOURCE_INTERFACE] = "interface", \
135 [FIB_SOURCE_API] = "API", \
136 [FIB_SOURCE_CLI] = "CLI", \
137 [FIB_SOURCE_ADJ] = "adjacency", \
138 [FIB_SOURCE_MAP] = "MAP", \
139 [FIB_SOURCE_SR] = "SR", \
140 [FIB_SOURCE_SIXRD] = "SixRD", \
141 [FIB_SOURCE_LISP] = "LISP", \
142 [FIB_SOURCE_CLASSIFY] = "classify", \
143 [FIB_SOURCE_DHCP] = "DHCP", \
144 [FIB_SOURCE_RR] = "recursive-resolution", \
145 [FIB_SOURCE_AE] = "attached_export", \
146 [FIB_SOURCE_MPLS] = "mpls", \
147 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
148 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
151 #define FOR_EACH_FIB_SOURCE(_item) \
152 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
155 * The different sources that can create a route.
156 * The sources are defined here the thier relative priority order.
157 * The lower the value the higher the priority
159 typedef enum fib_entry_attribute_t_ {
161 * Marker. Add new values after this one.
163 FIB_ENTRY_ATTRIBUTE_FIRST,
165 * Connected. The prefix is configured on an interface.
167 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
169 * Attached. The prefix is attached to an interface.
171 FIB_ENTRY_ATTRIBUTE_ATTACHED,
173 * The route is an explicit drop.
175 FIB_ENTRY_ATTRIBUTE_DROP,
177 * The route is exclusive. The client creating the route is
178 * providing an exclusive adjacency.
180 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
182 * The route is attached cross tables and thus imports covered
183 * prefixes from the other table.
185 FIB_ENTRY_ATTRIBUTE_IMPORT,
187 * The prefix/address is local to this device
189 FIB_ENTRY_ATTRIBUTE_LOCAL,
191 * The prefix/address exempted from loose uRPF check
192 * To be used with caution
194 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
196 * Marker. add new entries before this one.
198 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
199 } fib_entry_attribute_t;
202 * The maximum number of sources
204 #define FIB_ENTRY_ATTRIBUTE_MAX (FIB_ENTRY_ATTRIBUTE_LAST+1)
206 #define FIB_ENTRY_ATTRIBUTES { \
207 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
208 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
209 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
210 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
211 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
212 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
213 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt" \
216 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
217 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
218 _item < FIB_ENTRY_ATTRIBUTE_MAX; \
221 typedef enum fib_entry_flag_t_ {
222 FIB_ENTRY_FLAG_NONE = 0,
223 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
224 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
225 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
226 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
227 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
228 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
229 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
230 } __attribute__((packed)) fib_entry_flag_t;
233 * Flags for the source data
235 typedef enum fib_entry_src_attribute_t_ {
237 * Marker. Add new values after this one.
239 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
241 * the source has been added to the entry
243 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
245 * the source is active/best
247 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
249 * Marker. add new entries before this one.
251 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
252 } fib_entry_src_attribute_t;
254 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
256 #define FIB_ENTRY_SRC_ATTRIBUTES { \
257 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
258 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
261 typedef enum fib_entry_src_flag_t_ {
262 FIB_ENTRY_SRC_FLAG_NONE = 0,
263 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
264 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
265 } __attribute__ ((packed)) fib_entry_src_flag_t;
268 * Keep the size of the flags field to 2 bytes, so it
269 * can be placed next to the 2 bytes reference count
271 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
272 "FIB entry flags field size too big");
275 * Information related to the source of a FIB entry
277 typedef struct fib_entry_src_t_ {
279 * A vector of path extensions
281 struct fib_path_ext_t_ *fes_path_exts;
284 * The path-list created by the source
286 fib_node_index_t fes_pl;
288 * Which source this info block is for
290 fib_source_t fes_src;
292 * Flags on the source
294 fib_entry_src_flag_t fes_flags;
297 * 1 bytes ref count. This is not the number of users of the Entry
298 * (which is itself not large, due to path-list sharing), but the number
299 * of times a given source has been added. Which is even fewer
304 * Flags the source contributes to the entry
306 fib_entry_flag_t fes_entry_flags;
309 * Source specific info
314 * the index of the FIB entry that is the covering entry
316 fib_node_index_t fesr_cover;
318 * This source's index in the cover's list
324 * the index of the FIB entry that is the covering entry
326 fib_node_index_t fesa_cover;
328 * This source's index in the cover's list
334 * the index of the FIB entry that is the covering entry
336 fib_node_index_t fesi_cover;
338 * This source's index in the cover's list
344 * This MPLS local label associated with the prefix.
346 mpls_label_t fesm_label;
349 * the indicies of the LFIB entries created
351 fib_node_index_t fesm_lfes[2];
355 * The source FIB index.
357 fib_node_index_t fesl_fib_index;
363 * An entry in a FIB table.
365 * This entry represents a route added to the FIB that is stored
366 * in one of the FIB tables.
368 typedef struct fib_entry_t_ {
370 * Base class. The entry's node representation in the graph.
374 * The prefix of the route. this is const just to be sure.
375 * It is the entry's key/identity and so should never change.
377 const fib_prefix_t fe_prefix;
379 * The index of the FIB table this entry is in
383 * The load-balance used for forwarding.
385 * We don't share the EOS and non-EOS even in case when they could be
387 * - complexity & reliability v. memory
388 * determining the conditions where sharing is possible is non-trivial.
389 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
390 * and so save a few clock cycles in the DP imposition node since we can
391 * paint the header straight on without the need to check the packet
392 * type to derive the EOS bit value.
394 dpo_id_t fe_lb; // [FIB_FORW_CHAIN_MPLS_NUM];
396 * Vector of source infos.
397 * Most entries will only have 1 source. So we optimise for memory usage,
398 * which is preferable since we have many entries.
400 fib_entry_src_t *fe_srcs;
402 * the path-list for which this entry is a child. This is also the path-list
403 * that is contributing forwarding for this entry.
405 fib_node_index_t fe_parent;
407 * index of this entry in the parent's child list.
408 * This is set when this entry is added as a child, but can also
409 * be changed by the parent as it manages its list.
414 * A vector of delegates.
416 fib_entry_delegate_t *fe_delegates;
419 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
420 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
422 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
423 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
424 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
426 extern u8 *format_fib_entry (u8 * s, va_list * args);
428 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
429 const fib_prefix_t *prefix,
431 fib_entry_flag_t flags,
432 const dpo_id_t *dpo);
434 extern fib_node_index_t fib_entry_create (u32 fib_index,
435 const fib_prefix_t *prefix,
437 fib_entry_flag_t flags,
438 const fib_route_path_t *paths);
439 extern void fib_entry_update (fib_node_index_t fib_entry_index,
441 fib_entry_flag_t flags,
442 const fib_route_path_t *paths);
444 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
446 fib_entry_flag_t flags,
447 const fib_route_path_t *rpath);
448 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
450 fib_entry_flag_t flags,
451 const dpo_id_t *dpo);
452 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
454 fib_entry_flag_t flags,
455 const dpo_id_t *dpo);
456 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
457 fib_source_t source);
459 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
461 const fib_route_path_t *rpath);
462 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
463 fib_source_t source);
465 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
467 extern void fib_entry_contribute_forwarding(
468 fib_node_index_t fib_entry_index,
469 fib_forward_chain_type_t type,
471 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
472 fib_node_index_t fib_entry_index);
473 extern adj_index_t fib_entry_get_adj_for_source(
474 fib_node_index_t fib_entry_index,
475 fib_source_t source);
476 extern const int fib_entry_get_dpo_for_source (
477 fib_node_index_t fib_entry_index,
481 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
483 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
485 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
486 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
487 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
488 fib_node_index_t **entry_indicies);
490 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
491 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
493 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
494 fib_node_type_t type,
495 fib_node_index_t child_index);
496 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
498 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
499 extern u32 fib_entry_get_resolving_interface_for_source(
500 fib_node_index_t fib_entry_index,
501 fib_source_t source);
503 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
504 fib_route_path_encode_t **api_rpaths);
505 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
507 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
508 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
511 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
512 fib_source_t source);
514 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
515 extern fib_entry_flag_t fib_entry_get_flags_for_source(
516 fib_node_index_t fib_entry_index,
517 fib_source_t source);
518 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
519 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
520 fib_source_t source);
522 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
524 extern void fib_entry_module_init(void);
527 * unsafe... beware the raw pointer.
529 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
530 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
533 * for testing purposes.
535 extern u32 fib_entry_pool_size(void);