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 * This FIB entry imposes its source information on all prefixes
219 FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
221 * Marker. add new entries before this one.
223 FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT,
224 } fib_entry_attribute_t;
226 #define FIB_ENTRY_ATTRIBUTES { \
227 [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \
228 [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \
229 [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \
230 [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \
231 [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \
232 [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \
233 [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \
234 [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \
235 [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \
238 #define FOR_EACH_FIB_ATTRIBUTE(_item) \
239 for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \
240 _item <= FIB_ENTRY_ATTRIBUTE_LAST; \
243 typedef enum fib_entry_flag_t_ {
244 FIB_ENTRY_FLAG_NONE = 0,
245 FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
246 FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
247 FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
248 FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
249 FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
250 FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
251 FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT),
252 FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST),
253 FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT),
254 } __attribute__((packed)) fib_entry_flag_t;
257 * Flags for the source data
259 typedef enum fib_entry_src_attribute_t_ {
261 * Marker. Add new values after this one.
263 FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
265 * the source has been added to the entry
267 FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
269 * the source is active/best
271 FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
273 * the source is inherited from its cover
275 FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
277 * Marker. add new entries before this one.
279 FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED,
280 } fib_entry_src_attribute_t;
282 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
284 #define FIB_ENTRY_SRC_ATTRIBUTES { \
285 [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \
286 [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
287 [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \
290 #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \
291 for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \
292 _item < FIB_ENTRY_SRC_ATTRIBUTE_MAX; \
295 typedef enum fib_entry_src_flag_t_ {
296 FIB_ENTRY_SRC_FLAG_NONE = 0,
297 FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
298 FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
299 FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED),
300 } __attribute__ ((packed)) fib_entry_src_flag_t;
303 * Keep the size of the flags field to 2 bytes, so it
304 * can be placed next to the 2 bytes reference count
306 STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2,
307 "FIB entry flags field size too big");
310 * Information related to the source of a FIB entry
312 typedef struct fib_entry_src_t_ {
314 * A vector of path extensions
316 fib_path_ext_list_t fes_path_exts;
319 * The path-list created by the source
321 fib_node_index_t fes_pl;
323 * Which source this info block is for
325 fib_source_t fes_src;
327 * Flags on the source
329 fib_entry_src_flag_t fes_flags;
332 * 1 bytes ref count. This is not the number of users of the Entry
333 * (which is itself not large, due to path-list sharing), but the number
334 * of times a given source has been added. Which is even fewer
339 * Flags the source contributes to the entry
341 fib_entry_flag_t fes_entry_flags;
344 * Source specific info
349 * the index of the FIB entry that is the covering entry
351 fib_node_index_t fesr_cover;
353 * This source's index in the cover's list
359 * the index of the FIB entry that is the covering entry
361 fib_node_index_t fesa_cover;
363 * This source's index in the cover's list
369 * the index of the FIB entry that is the covering entry
371 fib_node_index_t fesi_cover;
373 * This source's index in the cover's list
379 * This MPLS local label associated with the prefix.
381 mpls_label_t fesm_label;
384 * the indicies of the LFIB entries created
386 fib_node_index_t fesm_lfes[2];
390 * The source FIB index.
392 fib_node_index_t fesl_fib_index;
398 * An entry in a FIB table.
400 * This entry represents a route added to the FIB that is stored
401 * in one of the FIB tables.
403 typedef struct fib_entry_t_ {
405 * Base class. The entry's node representation in the graph.
409 * The prefix of the route. this is const just to be sure.
410 * It is the entry's key/identity and so should never change.
412 const fib_prefix_t fe_prefix;
414 * The index of the FIB table this entry is in
418 * The load-balance used for forwarding.
420 * We don't share the EOS and non-EOS even in case when they could be
422 * - complexity & reliability v. memory
423 * determining the conditions where sharing is possible is non-trivial.
424 * - separate LBs means we can get the EOS bit right in the MPLS label DPO
425 * and so save a few clock cycles in the DP imposition node since we can
426 * paint the header straight on without the need to check the packet
427 * type to derive the EOS bit value.
431 * Vector of source infos.
432 * Most entries will only have 1 source. So we optimise for memory usage,
433 * which is preferable since we have many entries.
435 fib_entry_src_t *fe_srcs;
437 * the path-list for which this entry is a child. This is also the path-list
438 * that is contributing forwarding for this entry.
440 fib_node_index_t fe_parent;
442 * index of this entry in the parent's child list.
443 * This is set when this entry is added as a child, but can also
444 * be changed by the parent as it manages its list.
449 * A vector of delegates.
451 fib_entry_delegate_t *fe_delegates;
454 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
455 for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
457 #define FIB_ENTRY_FORMAT_BRIEF (0x0)
458 #define FIB_ENTRY_FORMAT_DETAIL (0x1)
459 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
461 extern u8 *format_fib_entry (u8 * s, va_list * args);
462 extern u8 *format_fib_source (u8 * s, va_list * args);
464 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
465 const fib_prefix_t *prefix,
467 fib_entry_flag_t flags,
468 const dpo_id_t *dpo);
470 extern fib_node_index_t fib_entry_create (u32 fib_index,
471 const fib_prefix_t *prefix,
473 fib_entry_flag_t flags,
474 const fib_route_path_t *paths);
475 extern void fib_entry_update (fib_node_index_t fib_entry_index,
477 fib_entry_flag_t flags,
478 const fib_route_path_t *paths);
480 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
482 fib_entry_flag_t flags,
483 const fib_route_path_t *rpath);
484 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
486 fib_entry_flag_t flags,
487 const dpo_id_t *dpo);
488 extern void fib_entry_special_update(fib_node_index_t fib_entry_index,
490 fib_entry_flag_t flags,
491 const dpo_id_t *dpo);
492 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
493 fib_source_t source);
495 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
497 const fib_route_path_t *rpath);
499 extern void fib_entry_inherit(fib_node_index_t cover,
500 fib_node_index_t covered);
502 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
503 fib_source_t source);
505 extern void fib_entry_contribute_urpf(fib_node_index_t path_index,
507 extern void fib_entry_contribute_forwarding(
508 fib_node_index_t fib_entry_index,
509 fib_forward_chain_type_t type,
511 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
512 fib_node_index_t fib_entry_index);
513 extern adj_index_t fib_entry_get_adj_for_source(
514 fib_node_index_t fib_entry_index,
515 fib_source_t source);
516 extern const int fib_entry_get_dpo_for_source (
517 fib_node_index_t fib_entry_index,
521 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
523 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
525 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
526 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
527 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
528 fib_node_index_t **entry_indicies);
530 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
531 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
533 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
534 fib_node_type_t type,
535 fib_node_index_t child_index);
536 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
538 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
539 extern u32 fib_entry_get_resolving_interface_for_source(
540 fib_node_index_t fib_entry_index,
541 fib_source_t source);
543 extern void fib_entry_encode(fib_node_index_t fib_entry_index,
544 fib_route_path_encode_t **api_rpaths);
545 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
547 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
548 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
551 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
552 fib_source_t source);
554 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
555 extern fib_entry_flag_t fib_entry_get_flags_for_source(
556 fib_node_index_t fib_entry_index,
557 fib_source_t source);
558 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
559 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
560 fib_source_t source);
562 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
563 extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index);
564 extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index,
565 flow_hash_config_t hash_config);
567 extern void fib_entry_module_init(void);
570 * unsafe... beware the raw pointer.
572 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
573 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
576 * for testing purposes.
578 extern u32 fib_entry_pool_size(void);