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 the thier relative priority order.
27 * The lower the value the higher the priority
29 typedef enum fib_source_t_ {
31 * Marker. Add new values after this one.
35 * Special sources. These are for entries that are added to all
36 * FIBs by default, and should never be over-ridden (hence they
37 * are the highest priority)
39 FIB_SOURCE_SPECIAL = FIB_SOURCE_FIRST,
41 * Classify. A route that links directly to a classify adj
45 * Route added as a result of interface configuration.
46 * this will also come from the API/CLI, but the distinction is
47 * that is from confiiguration on an interface, not a 'ip route' command
51 * A high priority source a plugin can use
55 * From the control plane API
84 * routes created as a result of ARP/ND entries. This is lower priority
85 * then the API/CLI. This is on purpose. trust me.
89 * MPLS label. The prefix has been assigned a local label. This source
90 * never provides forwarding information, instead it acts as a place-holder
91 * so the association of label to prefix can be maintained
95 * Attached Export source.
96 * routes created as a result of attahced export. routes thus sourced
97 * will be present in the export tables
101 * Recursive resolution source.
102 * Used to install an entry that is thre resolution traget of another.
106 * The default route source.
107 * The default route is always added to the FIB table (like the
108 * special sources) but we need to be able to over-ride it with
109 * 'ip route' sources when provided
111 FIB_SOURCE_DEFAULT_ROUTE,
113 * Marker. add new entries before this one.
115 FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
116 } __attribute__ ((packed)) fib_source_t;
118 _Static_assert (sizeof(fib_source_t) == 1,
119 "FIB too many sources");
122 * The maximum number of sources
124 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
126 #define FIB_SOURCES { \
127 [FIB_SOURCE_SPECIAL] = "special", \
128 [FIB_SOURCE_INTERFACE] = "interface", \
129 [FIB_SOURCE_API] = "API", \
130 [FIB_SOURCE_CLI] = "CLI", \
131 [FIB_SOURCE_ADJ] = "adjacency", \
132 [FIB_SOURCE_MAP] = "MAP", \
133 [FIB_SOURCE_SR] = "SR", \
134 [FIB_SOURCE_SIXRD] = "SixRD", \
135 [FIB_SOURCE_LISP] = "LISP", \
136 [FIB_SOURCE_CLASSIFY] = "classify", \
137 [FIB_SOURCE_DHCP] = "DHCP", \
138 [FIB_SOURCE_RR] = "recursive-resolution", \
139 [FIB_SOURCE_AE] = "attached_export", \
140 [FIB_SOURCE_MPLS] = "mpls", \
141 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
144 #define FOR_EACH_FIB_SOURCE(_item) \
145 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
148 * The different sources that can create a route.
149 * The sources are defined here the thier relative priority order.
150 * The lower the value the higher the priority
152 typedef enum fib_entry_attribute_t_ {
154 * Marker. Add new values after this one.
156 FIB_ENTRY_ATTRIBUTE_FIRST,
158 * Connected. The prefix is configured on an interface.
160 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
162 * Attached. The prefix is attached to an interface.
164 FIB_ENTRY_ATTRIBUTE_ATTACHED,
166 * The route is an explicit drop.
168 FIB_ENTRY_ATTRIBUTE_DROP,
170 * The route is exclusive. The client creating the route is
171 * providing an exclusive adjacency.
173 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
175 * The route is attached cross tables and thus imports covered
176 * prefixes from the other table.
178 FIB_ENTRY_ATTRIBUTE_IMPORT,
180 * The prefix/address is local to this device
182 FIB_ENTRY_ATTRIBUTE_LOCAL,
184 * Marker. add new entries before this one.
186 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_LOCAL,
187 } fib_entry_attribute_t;
190 * The maximum number of sources
192 #define FIB_ENTRY_ATTRIBUTE_MAX (FIB_ENTRY_ATTRIBUTE_LAST+1)
194 #define FIB_ENTRY_ATTRIBUTES { \
195 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
196 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
197 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
198 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
199 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
200 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
203 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
204 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
205 _item < FIB_ENTRY_ATTRIBUTE_MAX; \
208 typedef enum fib_entry_flag_t_ {
209 FIB_ENTRY_FLAG_NONE = 0,
210 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
211 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
212 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
213 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
214 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
215 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
219 * Flags for the source data
221 typedef enum fib_entry_src_attribute_t_ {
223 * Marker. Add new values after this one.
225 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
227 * the source has been added to the entry
229 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
231 * the source is active/best
233 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
235 * Marker. add new entries before this one.
237 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
238 } fib_entry_src_attribute_t;
240 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
242 #define FIB_ENTRY_SRC_ATTRIBUTES { \
243 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
244 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
247 typedef enum fib_entry_src_flag_t_ {
248 FIB_ENTRY_SRC_FLAG_NONE = 0,
249 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
250 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
251 } __attribute__ ((packed)) fib_entry_src_flag_t;
254 * Keep the size of the flags field to 2 bytes, so it
255 * can be placed next to the 2 bytes reference count
257 _Static_assert (sizeof(fib_entry_src_flag_t) <= 2,
258 "FIB entry flags field size too big");
261 * Information related to the source of a FIB entry
263 typedef struct fib_entry_src_t_ {
265 * The path-list created by the source
267 fib_node_index_t fes_pl;
269 * Which source this info block is for
271 fib_source_t fes_src;
273 * Flags on the source
275 fib_entry_src_flag_t fes_flags;
277 * Flags the source contributes to the entry
279 fib_entry_flag_t fes_entry_flags;
282 * 1 bytes ref count. This is not the number of users of the Entry
283 * (which is itself not large, due to path-list sharing), but the number
284 * of times a given source has been added. Which is even fewer
289 * A vector of path extensions
291 struct fib_path_ext_t_ *fes_path_exts;
294 * Source specific info
299 * the index of the FIB entry that is the covering entry
301 fib_node_index_t fesr_cover;
303 * This source's index in the cover's list
309 * the index of the FIB entry that is the covering entry
311 fib_node_index_t fesa_cover;
313 * This source's index in the cover's list
319 * the index of the FIB entry that is the covering entry
321 fib_node_index_t fesi_cover;
323 * This source's index in the cover's list
329 * This MPLS local label associated with the prefix.
331 mpls_label_t fesm_label;
334 * the indicies of the LFIB entries created
336 fib_node_index_t fesm_lfes[2];
340 * The source FIB index.
342 fib_node_index_t fesl_fib_index;
348 * An entry in a FIB table.
350 * This entry represents a route added to the FIB that is stored
351 * in one of the FIB tables.
353 typedef struct fib_entry_t_ {
355 * Base class. The entry's node representation in the graph.
359 * The prefix of the route
361 fib_prefix_t fe_prefix;
363 * The index of the FIB table this entry is in
367 * The load-balance used for forwarding.
369 * We don't share the EOS and non-EOS even in case when they could be
371 * - complexity & reliability v. memory
372 * determining the conditions where sharing is possible is non-trivial.
373 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
374 * and so save a few clock cycles in the DP imposition node since we can
375 * paint the header straight on without the need to check the packet
376 * type to derive the EOS bit value.
378 dpo_id_t fe_lb[FIB_FORW_CHAIN_NUM];
380 * Vector of source infos.
381 * Most entries will only have 1 source. So we optimise for memory usage,
382 * which is preferable since we have many entries.
384 fib_entry_src_t *fe_srcs;
386 * the path-list for which this entry is a child. This is also the path-list
387 * that is contributing forwarding for this entry.
389 fib_node_index_t fe_parent;
391 * index of this entry in the parent's child list.
392 * This is set when this entry is added as a child, but can also
393 * be changed by the parent as it manages its list.
397 * Dependency list of covered entries.
398 * these are more specific entries that are interested in changes
399 * to their respective cover
401 fib_node_list_t fe_covered;
405 fib_node_index_t fe_export;
406 fib_node_index_t fe_import;
409 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
410 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
412 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
413 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
414 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
416 extern u8 *format_fib_entry (u8 * s, va_list * args);
418 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
419 const fib_prefix_t *prefix,
421 fib_entry_flag_t flags,
422 const dpo_id_t *dpo);
424 extern fib_node_index_t fib_entry_create (u32 fib_index,
425 const fib_prefix_t *prefix,
427 fib_entry_flag_t flags,
428 const fib_route_path_t *paths);
429 extern void fib_entry_update (fib_node_index_t fib_entry_index,
431 fib_entry_flag_t flags,
432 const fib_route_path_t *paths);
434 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
436 fib_entry_flag_t flags,
437 const fib_route_path_t *rpath);
438 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
440 fib_entry_flag_t flags,
441 const dpo_id_t *dpo);
442 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
443 fib_source_t source);
445 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
447 const fib_route_path_t *rpath);
448 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
449 fib_source_t source);
451 extern void fib_entry_contribute_forwarding(
452 fib_node_index_t fib_entry_index,
453 fib_forward_chain_type_t type,
455 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
456 fib_node_index_t fib_entry_index);
457 extern adj_index_t fib_entry_get_adj_for_source(
458 fib_node_index_t fib_entry_index,
459 fib_source_t source);
460 extern const int fib_entry_get_dpo_for_source (
461 fib_node_index_t fib_entry_index,
465 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
467 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
469 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
470 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
471 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
472 fib_node_index_t **entry_indicies);
474 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
475 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
477 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
478 fib_node_type_t type,
479 fib_node_index_t child_index);
480 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
482 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
484 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
486 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
487 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
490 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
491 fib_source_t source);
493 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
494 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
495 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
496 fib_source_t source);
498 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
499 extern u32 fib_entry_get_fib_table_id(fib_node_index_t fib_entry_index);
501 extern void fib_entry_module_init(void);
504 * unsafe... beware the raw pointer.
506 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
507 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
510 * for testing purposes.
512 extern u32 fib_entry_pool_size(void);