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
94 FIB_SOURCE_IP6_ND_PROXY,
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_SIXRD] = "SixRD", \
155 [FIB_SOURCE_LISP] = "LISP", \
156 [FIB_SOURCE_CLASSIFY] = "classify", \
157 [FIB_SOURCE_DHCP] = "DHCP", \
158 [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-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", \
166 #define FOR_EACH_FIB_SOURCE(_item) \
167 for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
170 * The different sources that can create a route.
171 * The sources are defined here the thier relative priority order.
172 * The lower the value the higher the priority
174 typedef enum fib_entry_attribute_t_ {
176 * Marker. Add new values after this one.
178 FIB_ENTRY_ATTRIBUTE_FIRST,
180 * Connected. The prefix is configured on an interface.
182 FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
184 * Attached. The prefix is attached to an interface.
186 FIB_ENTRY_ATTRIBUTE_ATTACHED,
188 * The route is an explicit drop.
190 FIB_ENTRY_ATTRIBUTE_DROP,
192 * The route is exclusive. The client creating the route is
193 * providing an exclusive adjacency.
195 FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
197 * The route is attached cross tables and thus imports covered
198 * prefixes from the other table.
200 FIB_ENTRY_ATTRIBUTE_IMPORT,
202 * The prefix/address is local to this device
204 FIB_ENTRY_ATTRIBUTE_LOCAL,
206 * The prefix/address is a multicast prefix.
207 * this aplies only to MPLS. IP multicast is handled by mfib
209 FIB_ENTRY_ATTRIBUTE_MULTICAST,
211 * The prefix/address exempted from loose uRPF check
212 * To be used with caution
214 FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
216 * Marker. add new entries before this one.
218 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT,
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", \
232 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
233 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
234 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
237 typedef enum fib_entry_flag_t_ {
238 FIB_ENTRY_FLAG_NONE = 0,
239 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
240 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
241 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
242 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
243 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
244 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
245 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
246 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
247 } __attribute__((packed)) fib_entry_flag_t;
250 * Flags for the source data
252 typedef enum fib_entry_src_attribute_t_ {
254 * Marker. Add new values after this one.
256 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
258 * the source has been added to the entry
260 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
262 * the source is active/best
264 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
266 * Marker. add new entries before this one.
268 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
269 } fib_entry_src_attribute_t;
271 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
273 #define FIB_ENTRY_SRC_ATTRIBUTES { \
274 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
275 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
278 typedef enum fib_entry_src_flag_t_ {
279 FIB_ENTRY_SRC_FLAG_NONE = 0,
280 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
281 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
282 } __attribute__ ((packed)) fib_entry_src_flag_t;
285 * Keep the size of the flags field to 2 bytes, so it
286 * can be placed next to the 2 bytes reference count
288 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
289 "FIB entry flags field size too big");
292 * Information related to the source of a FIB entry
294 typedef struct fib_entry_src_t_ {
296 * A vector of path extensions
298 fib_path_ext_list_t fes_path_exts;
301 * The path-list created by the source
303 fib_node_index_t fes_pl;
305 * Which source this info block is for
307 fib_source_t fes_src;
309 * Flags on the source
311 fib_entry_src_flag_t fes_flags;
314 * 1 bytes ref count. This is not the number of users of the Entry
315 * (which is itself not large, due to path-list sharing), but the number
316 * of times a given source has been added. Which is even fewer
321 * Flags the source contributes to the entry
323 fib_entry_flag_t fes_entry_flags;
326 * Source specific info
331 * the index of the FIB entry that is the covering entry
333 fib_node_index_t fesr_cover;
335 * This source's index in the cover's list
341 * the index of the FIB entry that is the covering entry
343 fib_node_index_t fesa_cover;
345 * This source's index in the cover's list
351 * the index of the FIB entry that is the covering entry
353 fib_node_index_t fesi_cover;
355 * This source's index in the cover's list
361 * This MPLS local label associated with the prefix.
363 mpls_label_t fesm_label;
366 * the indicies of the LFIB entries created
368 fib_node_index_t fesm_lfes[2];
372 * The source FIB index.
374 fib_node_index_t fesl_fib_index;
380 * An entry in a FIB table.
382 * This entry represents a route added to the FIB that is stored
383 * in one of the FIB tables.
385 typedef struct fib_entry_t_ {
387 * Base class. The entry's node representation in the graph.
391 * The prefix of the route. this is const just to be sure.
392 * It is the entry's key/identity and so should never change.
394 const fib_prefix_t fe_prefix;
396 * The index of the FIB table this entry is in
400 * The load-balance used for forwarding.
402 * We don't share the EOS and non-EOS even in case when they could be
404 * - complexity & reliability v. memory
405 * determining the conditions where sharing is possible is non-trivial.
406 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
407 * and so save a few clock cycles in the DP imposition node since we can
408 * paint the header straight on without the need to check the packet
409 * type to derive the EOS bit value.
413 * Vector of source infos.
414 * Most entries will only have 1 source. So we optimise for memory usage,
415 * which is preferable since we have many entries.
417 fib_entry_src_t *fe_srcs;
419 * the path-list for which this entry is a child. This is also the path-list
420 * that is contributing forwarding for this entry.
422 fib_node_index_t fe_parent;
424 * index of this entry in the parent's child list.
425 * This is set when this entry is added as a child, but can also
426 * be changed by the parent as it manages its list.
431 * A vector of delegates.
433 fib_entry_delegate_t *fe_delegates;
436 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
437 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
439 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
440 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
441 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
443 extern u8 *format_fib_entry (u8 * s, va_list * args);
444 extern u8 *format_fib_source (u8 * s, va_list * args);
446 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
447 const fib_prefix_t *prefix,
449 fib_entry_flag_t flags,
450 const dpo_id_t *dpo);
452 extern fib_node_index_t fib_entry_create (u32 fib_index,
453 const fib_prefix_t *prefix,
455 fib_entry_flag_t flags,
456 const fib_route_path_t *paths);
457 extern void fib_entry_update (fib_node_index_t fib_entry_index,
459 fib_entry_flag_t flags,
460 const fib_route_path_t *paths);
462 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
464 fib_entry_flag_t flags,
465 const fib_route_path_t *rpath);
466 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
468 fib_entry_flag_t flags,
469 const dpo_id_t *dpo);
470 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
472 fib_entry_flag_t flags,
473 const dpo_id_t *dpo);
474 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
475 fib_source_t source);
477 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
479 const fib_route_path_t *rpath);
480 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
481 fib_source_t source);
483 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
485 extern void fib_entry_contribute_forwarding(
486 fib_node_index_t fib_entry_index,
487 fib_forward_chain_type_t type,
489 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
490 fib_node_index_t fib_entry_index);
491 extern adj_index_t fib_entry_get_adj_for_source(
492 fib_node_index_t fib_entry_index,
493 fib_source_t source);
494 extern const int fib_entry_get_dpo_for_source (
495 fib_node_index_t fib_entry_index,
499 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
501 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
503 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
504 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
505 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
506 fib_node_index_t **entry_indicies);
508 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
509 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
511 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
512 fib_node_type_t type,
513 fib_node_index_t child_index);
514 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
516 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
517 extern u32 fib_entry_get_resolving_interface_for_source(
518 fib_node_index_t fib_entry_index,
519 fib_source_t source);
521 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
522 fib_route_path_encode_t **api_rpaths);
523 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
525 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
526 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
529 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
530 fib_source_t source);
532 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
533 extern fib_entry_flag_t fib_entry_get_flags_for_source(
534 fib_node_index_t fib_entry_index,
535 fib_source_t source);
536 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
537 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
538 fib_source_t source);
540 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
541 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
542 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
543 flow_hash_config_t hash_config);
545 extern void fib_entry_module_init(void);
548 * unsafe... beware the raw pointer.
550 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
551 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
554 * for testing purposes.
556 extern u32 fib_entry_pool_size(void);