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
86 FIB_SOURCE_IP6_ND_PROXY,
89 * routes created as a result of ARP/ND entries. This is lower priority
90 * then the API/CLI. This is on purpose. trust me.
94 * MPLS label. The prefix has been assigned a local label. This source
95 * never provides forwarding information, instead it acts as a place-holder
96 * so the association of label to prefix can be maintained
100 * Attached Export source.
101 * routes created as a result of attahced export. routes thus sourced
102 * will be present in the export tables
106 * Recursive resolution source.
107 * Used to install an entry that is the resolution traget of another.
111 * uRPF bypass/exemption.
112 * Used to install an entry that is exempt from the loose uRPF check
114 FIB_SOURCE_URPF_EXEMPT,
116 * The default route source.
117 * The default route is always added to the FIB table (like the
118 * special sources) but we need to be able to over-ride it with
119 * 'ip route' sources when provided
121 FIB_SOURCE_DEFAULT_ROUTE,
123 * Marker. add new entries before this one.
125 FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
126 } __attribute__ ((packed)) fib_source_t;
128 STATIC_ASSERT (sizeof(fib_source_t) == 1,
129 "FIB too many sources");
132 * The maximum number of sources
134 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
136 #define FIB_SOURCES { \
137 [FIB_SOURCE_SPECIAL] = "special", \
138 [FIB_SOURCE_INTERFACE] = "interface", \
139 [FIB_SOURCE_API] = "API", \
140 [FIB_SOURCE_CLI] = "CLI", \
141 [FIB_SOURCE_ADJ] = "adjacency", \
142 [FIB_SOURCE_MAP] = "MAP", \
143 [FIB_SOURCE_SR] = "SR", \
144 [FIB_SOURCE_SIXRD] = "SixRD", \
145 [FIB_SOURCE_LISP] = "LISP", \
146 [FIB_SOURCE_CLASSIFY] = "classify", \
147 [FIB_SOURCE_DHCP] = "DHCP", \
148 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \
149 [FIB_SOURCE_RR] = "recursive-resolution", \
150 [FIB_SOURCE_AE] = "attached_export", \
151 [FIB_SOURCE_MPLS] = "mpls", \
152 [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \
153 [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \
156 #define FOR_EACH_FIB_SOURCE(_item) \
157 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
160 * The different sources that can create a route.
161 * The sources are defined here the thier relative priority order.
162 * The lower the value the higher the priority
164 typedef enum fib_entry_attribute_t_ {
166 * Marker. Add new values after this one.
168 FIB_ENTRY_ATTRIBUTE_FIRST,
170 * Connected. The prefix is configured on an interface.
172 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
174 * Attached. The prefix is attached to an interface.
176 FIB_ENTRY_ATTRIBUTE_ATTACHED,
178 * The route is an explicit drop.
180 FIB_ENTRY_ATTRIBUTE_DROP,
182 * The route is exclusive. The client creating the route is
183 * providing an exclusive adjacency.
185 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
187 * The route is attached cross tables and thus imports covered
188 * prefixes from the other table.
190 FIB_ENTRY_ATTRIBUTE_IMPORT,
192 * The prefix/address is local to this device
194 FIB_ENTRY_ATTRIBUTE_LOCAL,
196 * The prefix/address exempted from loose uRPF check
197 * To be used with caution
199 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
201 * Marker. add new entries before this one.
203 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
204 } fib_entry_attribute_t;
207 * The maximum number of sources
209 #define FIB_ENTRY_ATTRIBUTE_MAX (FIB_ENTRY_ATTRIBUTE_LAST+1)
211 #define FIB_ENTRY_ATTRIBUTES { \
212 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
213 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
214 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
215 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
216 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
217 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
218 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt" \
221 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
222 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
223 _item < FIB_ENTRY_ATTRIBUTE_MAX; \
226 typedef enum fib_entry_flag_t_ {
227 FIB_ENTRY_FLAG_NONE = 0,
228 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
229 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
230 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
231 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
232 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
233 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
234 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
235 } __attribute__((packed)) fib_entry_flag_t;
238 * Flags for the source data
240 typedef enum fib_entry_src_attribute_t_ {
242 * Marker. Add new values after this one.
244 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
246 * the source has been added to the entry
248 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
250 * the source is active/best
252 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
254 * Marker. add new entries before this one.
256 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
257 } fib_entry_src_attribute_t;
259 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
261 #define FIB_ENTRY_SRC_ATTRIBUTES { \
262 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
263 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
266 typedef enum fib_entry_src_flag_t_ {
267 FIB_ENTRY_SRC_FLAG_NONE = 0,
268 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
269 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
270 } __attribute__ ((packed)) fib_entry_src_flag_t;
273 * Keep the size of the flags field to 2 bytes, so it
274 * can be placed next to the 2 bytes reference count
276 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
277 "FIB entry flags field size too big");
280 * Information related to the source of a FIB entry
282 typedef struct fib_entry_src_t_ {
284 * A vector of path extensions
286 struct fib_path_ext_t_ *fes_path_exts;
289 * The path-list created by the source
291 fib_node_index_t fes_pl;
293 * Which source this info block is for
295 fib_source_t fes_src;
297 * Flags on the source
299 fib_entry_src_flag_t fes_flags;
302 * 1 bytes ref count. This is not the number of users of the Entry
303 * (which is itself not large, due to path-list sharing), but the number
304 * of times a given source has been added. Which is even fewer
309 * Flags the source contributes to the entry
311 fib_entry_flag_t fes_entry_flags;
314 * Source specific info
319 * the index of the FIB entry that is the covering entry
321 fib_node_index_t fesr_cover;
323 * This source's index in the cover's list
329 * the index of the FIB entry that is the covering entry
331 fib_node_index_t fesa_cover;
333 * This source's index in the cover's list
339 * the index of the FIB entry that is the covering entry
341 fib_node_index_t fesi_cover;
343 * This source's index in the cover's list
349 * This MPLS local label associated with the prefix.
351 mpls_label_t fesm_label;
354 * the indicies of the LFIB entries created
356 fib_node_index_t fesm_lfes[2];
360 * The source FIB index.
362 fib_node_index_t fesl_fib_index;
368 * An entry in a FIB table.
370 * This entry represents a route added to the FIB that is stored
371 * in one of the FIB tables.
373 typedef struct fib_entry_t_ {
375 * Base class. The entry's node representation in the graph.
379 * The prefix of the route. this is const just to be sure.
380 * It is the entry's key/identity and so should never change.
382 const fib_prefix_t fe_prefix;
384 * The index of the FIB table this entry is in
388 * The load-balance used for forwarding.
390 * We don't share the EOS and non-EOS even in case when they could be
392 * - complexity & reliability v. memory
393 * determining the conditions where sharing is possible is non-trivial.
394 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
395 * and so save a few clock cycles in the DP imposition node since we can
396 * paint the header straight on without the need to check the packet
397 * type to derive the EOS bit value.
399 dpo_id_t fe_lb; // [FIB_FORW_CHAIN_MPLS_NUM];
401 * Vector of source infos.
402 * Most entries will only have 1 source. So we optimise for memory usage,
403 * which is preferable since we have many entries.
405 fib_entry_src_t *fe_srcs;
407 * the path-list for which this entry is a child. This is also the path-list
408 * that is contributing forwarding for this entry.
410 fib_node_index_t fe_parent;
412 * index of this entry in the parent's child list.
413 * This is set when this entry is added as a child, but can also
414 * be changed by the parent as it manages its list.
419 * A vector of delegates.
421 fib_entry_delegate_t *fe_delegates;
424 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
425 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
427 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
428 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
429 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
431 extern u8 *format_fib_entry (u8 * s, va_list * args);
433 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
434 const fib_prefix_t *prefix,
436 fib_entry_flag_t flags,
437 const dpo_id_t *dpo);
439 extern fib_node_index_t fib_entry_create (u32 fib_index,
440 const fib_prefix_t *prefix,
442 fib_entry_flag_t flags,
443 const fib_route_path_t *paths);
444 extern void fib_entry_update (fib_node_index_t fib_entry_index,
446 fib_entry_flag_t flags,
447 const fib_route_path_t *paths);
449 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
451 fib_entry_flag_t flags,
452 const fib_route_path_t *rpath);
453 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
455 fib_entry_flag_t flags,
456 const dpo_id_t *dpo);
457 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
459 fib_entry_flag_t flags,
460 const dpo_id_t *dpo);
461 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
462 fib_source_t source);
464 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
466 const fib_route_path_t *rpath);
467 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
468 fib_source_t source);
470 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
472 extern void fib_entry_contribute_forwarding(
473 fib_node_index_t fib_entry_index,
474 fib_forward_chain_type_t type,
476 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
477 fib_node_index_t fib_entry_index);
478 extern adj_index_t fib_entry_get_adj_for_source(
479 fib_node_index_t fib_entry_index,
480 fib_source_t source);
481 extern const int fib_entry_get_dpo_for_source (
482 fib_node_index_t fib_entry_index,
486 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
488 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
490 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
491 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
492 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
493 fib_node_index_t **entry_indicies);
495 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
496 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
498 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
499 fib_node_type_t type,
500 fib_node_index_t child_index);
501 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
503 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
504 extern u32 fib_entry_get_resolving_interface_for_source(
505 fib_node_index_t fib_entry_index,
506 fib_source_t source);
508 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
509 fib_route_path_encode_t **api_rpaths);
510 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
512 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
513 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
516 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
517 fib_source_t source);
519 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
520 extern fib_entry_flag_t fib_entry_get_flags_for_source(
521 fib_node_index_t fib_entry_index,
522 fib_source_t source);
523 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
524 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
525 fib_source_t source);
527 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
529 extern void fib_entry_module_init(void);
532 * unsafe... beware the raw pointer.
534 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
535 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
538 * for testing purposes.
540 extern u32 fib_entry_pool_size(void);