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_NODE_H__
17 #define __FIB_NODE_H__
19 #include <vnet/fib/fib_types.h>
22 * The types of nodes in a FIB graph
24 typedef enum fib_node_type_t_ {
26 * Marker. New types after this one.
28 FIB_NODE_TYPE_FIRST = 0,
30 * See the respective fib_*.h files for descriptions of these objects.
34 FIB_NODE_TYPE_MFIB_ENTRY,
35 FIB_NODE_TYPE_PATH_LIST,
38 FIB_NODE_TYPE_MPLS_ENTRY,
39 FIB_NODE_TYPE_MPLS_TUNNEL,
40 FIB_NODE_TYPE_LISP_GPE_FWD_ENTRY,
41 FIB_NODE_TYPE_LISP_ADJ,
42 FIB_NODE_TYPE_GRE_TUNNEL,
43 FIB_NODE_TYPE_VXLAN_TUNNEL,
45 FIB_NODE_TYPE_VXLAN_GPE_TUNNEL,
46 FIB_NODE_TYPE_GENEVE_TUNNEL,
47 FIB_NODE_TYPE_UDP_ENCAP,
48 FIB_NODE_TYPE_BIER_FMASK,
49 FIB_NODE_TYPE_BIER_ENTRY,
50 FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
51 FIB_NODE_TYPE_IPSEC_SA,
53 * Marker. New types before this one. leave the test last.
56 FIB_NODE_TYPE_LAST = FIB_NODE_TYPE_TEST,
57 } __attribute__ ((packed)) fib_node_type_t;
59 #define FIB_NODE_TYPE_MAX (FIB_NODE_TYPE_LAST + 1)
61 #define FIB_NODE_TYPES { \
62 [FIB_NODE_TYPE_ENTRY] = "entry", \
63 [FIB_NODE_TYPE_MFIB_ENTRY] = "mfib-entry", \
64 [FIB_NODE_TYPE_WALK] = "walk", \
65 [FIB_NODE_TYPE_PATH_LIST] = "path-list", \
66 [FIB_NODE_TYPE_PATH] = "path", \
67 [FIB_NODE_TYPE_MPLS_ENTRY] = "mpls-entry", \
68 [FIB_NODE_TYPE_MPLS_TUNNEL] = "mpls-tunnel", \
69 [FIB_NODE_TYPE_ADJ] = "adj", \
70 [FIB_NODE_TYPE_LISP_GPE_FWD_ENTRY] = "lisp-gpe-fwd-entry", \
71 [FIB_NODE_TYPE_LISP_ADJ] = "lisp-adj", \
72 [FIB_NODE_TYPE_GRE_TUNNEL] = "gre-tunnel", \
73 [FIB_NODE_TYPE_VXLAN_TUNNEL] = "vxlan-tunnel", \
74 [FIB_NODE_TYPE_MAP_E] = "map-e", \
75 [FIB_NODE_TYPE_VXLAN_GPE_TUNNEL] = "vxlan-gpe-tunnel", \
76 [FIB_NODE_TYPE_UDP_ENCAP] = "udp-encap", \
77 [FIB_NODE_TYPE_BIER_FMASK] = "bier-fmask", \
78 [FIB_NODE_TYPE_BIER_ENTRY] = "bier-entry", \
79 [FIB_NODE_TYPE_VXLAN_GBP_TUNNEL] = "vxlan-gbp-tunnel", \
80 [FIB_NODE_TYPE_IPSEC_SA] = "ipsec-sa" \
84 * Reasons for backwalking the FIB object graph
86 typedef enum fib_node_back_walk_reason_t_ {
88 * Marker. Add new ones after.
90 FIB_NODE_BW_REASON_FIRST = 0,
92 * Walk to re-resolve the child.
93 * Used when the parent is no longer a valid resolution target
95 FIB_NODE_BW_REASON_RESOLVE = FIB_NODE_BW_REASON_FIRST,
97 * Walk to re-evaluate the forwarding contributed by the parent.
98 * Used when a parent's forwarding changes and the child needs to
99 * incorporate this change in its forwarding.
101 FIB_NODE_BW_REASON_EVALUATE,
103 * A resolving interface has come up
105 FIB_NODE_BW_REASON_INTERFACE_UP,
107 * A resolving interface has gone down
109 FIB_NODE_BW_REASON_INTERFACE_DOWN,
111 * A resolving interface has been deleted.
113 FIB_NODE_BW_REASON_INTERFACE_DELETE,
115 * Walk to re-collapse the multipath adjs when the rewrite of
116 * a unipath adjacency changes
118 FIB_NODE_BW_REASON_ADJ_UPDATE,
120 * Walk to update children to inform them the adjacency is now down.
122 FIB_NODE_BW_REASON_ADJ_DOWN,
124 * Marker. Add new before and update
126 FIB_NODE_BW_REASON_LAST = FIB_NODE_BW_REASON_ADJ_DOWN,
127 } fib_node_back_walk_reason_t;
129 #define FIB_NODE_BW_REASONS { \
130 [FIB_NODE_BW_REASON_RESOLVE] = "resolve", \
131 [FIB_NODE_BW_REASON_EVALUATE] = "evaluate", \
132 [FIB_NODE_BW_REASON_INTERFACE_UP] = "if-up", \
133 [FIB_NODE_BW_REASON_INTERFACE_DOWN] = "if-down", \
134 [FIB_NODE_BW_REASON_INTERFACE_DELETE] = "if-delete", \
135 [FIB_NODE_BW_REASON_ADJ_UPDATE] = "adj-update", \
136 [FIB_NODE_BW_REASON_ADJ_DOWN] = "adj-down", \
139 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
140 for (_item = FIB_NODE_BW_REASON_FIRST; \
141 _item <= FIB_NODE_BW_REASON_LAST; \
145 * Flags enum constructed from the reaons
147 typedef enum fib_node_bw_reason_flag_t_ {
148 FIB_NODE_BW_REASON_FLAG_NONE = 0,
149 FIB_NODE_BW_REASON_FLAG_RESOLVE = (1 << FIB_NODE_BW_REASON_RESOLVE),
150 FIB_NODE_BW_REASON_FLAG_EVALUATE = (1 << FIB_NODE_BW_REASON_EVALUATE),
151 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP = (1 << FIB_NODE_BW_REASON_INTERFACE_UP),
152 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN = (1 << FIB_NODE_BW_REASON_INTERFACE_DOWN),
153 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE = (1 << FIB_NODE_BW_REASON_INTERFACE_DELETE),
154 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE = (1 << FIB_NODE_BW_REASON_ADJ_UPDATE),
155 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN = (1 << FIB_NODE_BW_REASON_ADJ_DOWN),
156 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
158 STATIC_ASSERT(sizeof(fib_node_bw_reason_flag_t) < 2,
159 "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
161 extern u8 *format_fib_node_bw_reason(u8 *s, va_list *args);
166 typedef enum fib_node_bw_flags_t_
168 FIB_NODE_BW_FLAG_NONE = 0,
170 * Force the walk to be synchronous
172 FIB_NODE_BW_FLAG_FORCE_SYNC = (1 << 0),
173 } fib_node_bw_flags_t;
176 * Forward eclarations
181 * A representation of one pointer to another node.
182 * To fully qualify a node, one must know its type and its index so it
183 * can be retrieved from the appropriate pool. Direct pointers to nodes
184 * are forbidden, since all nodes are allocated from pools, which are vectors,
185 * and thus subject to realloc at any time.
187 typedef struct fib_node_ptr_t_ {
191 fib_node_type_t fnp_type;
195 fib_node_index_t fnp_index;
199 * @brief A list of FIB nodes.
201 typedef u32 fib_node_list_t;
204 * Context passed between object during a back walk.
206 typedef struct fib_node_back_walk_ctx_t_ {
208 * The reason/trigger for the backwalk
210 fib_node_bw_reason_flag_t fnbw_reason;
213 * additional flags for the walk
215 fib_node_bw_flags_t fnbw_flags;
218 * the number of levels the walk has already traversed.
219 * this value is maintained by the walk infra, tp limit the depth of
220 * a walk so it does not run indefinately the presence of a loop/cycle
224 } fib_node_back_walk_ctx_t;
227 * We consider a depth of 32 to be sufficient to cover all sane
228 * network topologies. Anything more is then an indication that
229 * there is a loop/cycle in the FIB graph.
230 * Note that all object types contribute to 1 to the depth.
232 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
235 * A callback function for walking a node dependency list
237 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
241 * A list of dependent nodes.
242 * This is currently implemented as a hash_table of fib_node_ptr_t
244 typedef fib_node_ptr_t fib_node_ptr_list_t;
247 * Return code from a back walk function
249 typedef enum fib_node_back_walk_rc_t_ {
250 FIB_NODE_BACK_WALK_MERGE,
251 FIB_NODE_BACK_WALK_CONTINUE,
252 } fib_node_back_walk_rc_t;
255 * Function definition to backwalk a FIB node
257 typedef fib_node_back_walk_rc_t (*fib_node_back_walk_t)(
258 struct fib_node_t_ *node,
259 fib_node_back_walk_ctx_t *ctx);
262 * Function definition to get a FIB node from its index
264 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
267 * Function definition to inform the FIB node that its last lock has gone.
269 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
272 * Function definition to display the amount of memory used by a type.
273 * Implementations should call fib_show_memory_usage()
275 typedef void (*fib_node_memory_show_t)(void);
278 * A FIB graph nodes virtual function table
280 typedef struct fib_node_vft_t_ {
281 fib_node_get_t fnv_get;
282 fib_node_last_lock_gone_t fnv_last_lock;
283 fib_node_back_walk_t fnv_back_walk;
284 format_function_t *fnv_format;
285 fib_node_memory_show_t fnv_mem_show;
289 * An node in the FIB graph
291 * Objects in the FIB form a graph.
293 typedef struct fib_node_t_ {
295 * The node's type. make sure we are dynamic/down casting correctly
297 fib_node_type_t fn_type;
300 * Some pad space the concrete/derived type is free to use
305 * Vector of nodes that depend upon/use/share this node
307 fib_node_list_t fn_children;
310 * Number of dependents on this node. This number includes the number
316 STATIC_ASSERT(sizeof(fib_node_t) == 12, "FIB node type is growing");
320 * Register the function table for a given type
326 * virtual function table
328 extern void fib_node_register_type (fib_node_type_t ft,
329 const fib_node_vft_t *vft);
333 * Create a new FIB node type and Register the function table for it.
336 * virtual function table
338 * @return new FIB node type
340 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
343 * @brief Show the memory usage for a type
345 * This should be invoked by the type in response to the infra calling
346 * its registered memory show function
348 * @param name the name of the type
349 * @param in_use_elts The number of elements in use
350 * @param allocd_elts The number of allocated pool elemenets
351 * @param size_elt The size of one element
353 extern void fib_show_memory_usage(const char *name,
358 extern void fib_node_init(fib_node_t *node,
360 extern void fib_node_deinit(fib_node_t *node);
362 extern void fib_node_lock(fib_node_t *node);
363 extern void fib_node_unlock(fib_node_t *node);
365 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
366 fib_node_index_t parent_index);
367 extern u32 fib_node_child_add(fib_node_type_t parent_type,
368 fib_node_index_t parent_index,
369 fib_node_type_t child_type,
370 fib_node_index_t child_index);
371 extern void fib_node_child_remove(fib_node_type_t parent_type,
372 fib_node_index_t parent_index,
373 fib_node_index_t sibling_index);
375 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
376 fib_node_back_walk_ctx_t *ctx);
378 extern u8* fib_node_children_format(fib_node_list_t list,
381 extern const char* fib_node_type_get_name(fib_node_type_t type);
384 fib_node_index_is_valid (fib_node_index_t ni)
386 return (FIB_NODE_INDEX_INVALID != ni);