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 * Marker. New types before this one. leave the test last.
48 FIB_NODE_TYPE_LAST = FIB_NODE_TYPE_TEST,
51 #define FIB_NODE_TYPE_MAX (FIB_NODE_TYPE_LAST + 1)
53 #define FIB_NODE_TYPES { \
54 [FIB_NODE_TYPE_ENTRY] = "entry", \
55 [FIB_NODE_TYPE_MFIB_ENTRY] = "mfib-entry", \
56 [FIB_NODE_TYPE_WALK] = "walk", \
57 [FIB_NODE_TYPE_PATH_LIST] = "path-list", \
58 [FIB_NODE_TYPE_PATH] = "path", \
59 [FIB_NODE_TYPE_MPLS_ENTRY] = "mpls-entry", \
60 [FIB_NODE_TYPE_MPLS_TUNNEL] = "mpls-tunnel", \
61 [FIB_NODE_TYPE_ADJ] = "adj", \
62 [FIB_NODE_TYPE_LISP_GPE_FWD_ENTRY] = "lisp-gpe-fwd-entry", \
63 [FIB_NODE_TYPE_LISP_ADJ] = "lisp-adj", \
64 [FIB_NODE_TYPE_GRE_TUNNEL] = "gre-tunnel", \
65 [FIB_NODE_TYPE_VXLAN_TUNNEL] = "vxlan-tunnel", \
69 * Reasons for backwalking the FIB object graph
71 typedef enum fib_node_back_walk_reason_t_ {
73 * Marker. Add new ones after.
75 FIB_NODE_BW_REASON_FIRST = 0,
77 * Walk to re-resolve the child.
78 * Used when the parent is no longer a valid resolution target
80 FIB_NODE_BW_REASON_RESOLVE = FIB_NODE_BW_REASON_FIRST,
82 * Walk to re-evaluate the forwarding contributed by the parent.
83 * Used when a parent's forwarding changes and the child needs to
84 * incorporate this change in its forwarding.
86 FIB_NODE_BW_REASON_EVALUATE,
88 * A resolving interface has come up
90 FIB_NODE_BW_REASON_INTERFACE_UP,
92 * A resolving interface has gone down
94 FIB_NODE_BW_REASON_INTERFACE_DOWN,
96 * A resolving interface has been deleted.
98 FIB_NODE_BW_REASON_INTERFACE_DELETE,
100 * Walk to re-collapse the multipath adjs when the rewrite of
101 * a unipath adjacency changes
103 FIB_NODE_BW_REASON_ADJ_UPDATE,
105 * Walk to update children to inform them the adjacency is now down.
107 FIB_NODE_BW_REASON_ADJ_DOWN,
109 * Marker. Add new before and update
111 FIB_NODE_BW_REASON_LAST = FIB_NODE_BW_REASON_ADJ_DOWN,
112 } fib_node_back_walk_reason_t;
114 #define FIB_NODE_BW_REASONS { \
115 [FIB_NODE_BW_REASON_RESOLVE] = "resolve", \
116 [FIB_NODE_BW_REASON_EVALUATE] = "evaluate", \
117 [FIB_NODE_BW_REASON_INTERFACE_UP] = "if-up", \
118 [FIB_NODE_BW_REASON_INTERFACE_DOWN] = "if-down", \
119 [FIB_NODE_BW_REASON_INTERFACE_DELETE] = "if-delete", \
120 [FIB_NODE_BW_REASON_ADJ_UPDATE] = "adj-update", \
121 [FIB_NODE_BW_REASON_ADJ_DOWN] = "adj-down", \
124 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
125 for (_item = FIB_NODE_BW_REASON_FIRST; \
126 _item <= FIB_NODE_BW_REASON_LAST; \
130 * Flags enum constructed from the reaons
132 typedef enum fib_node_bw_reason_flag_t_ {
133 FIB_NODE_BW_REASON_FLAG_NONE = 0,
134 FIB_NODE_BW_REASON_FLAG_RESOLVE = (1 << FIB_NODE_BW_REASON_RESOLVE),
135 FIB_NODE_BW_REASON_FLAG_EVALUATE = (1 << FIB_NODE_BW_REASON_EVALUATE),
136 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP = (1 << FIB_NODE_BW_REASON_INTERFACE_UP),
137 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN = (1 << FIB_NODE_BW_REASON_INTERFACE_DOWN),
138 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE = (1 << FIB_NODE_BW_REASON_INTERFACE_DELETE),
139 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE = (1 << FIB_NODE_BW_REASON_ADJ_UPDATE),
140 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN = (1 << FIB_NODE_BW_REASON_ADJ_DOWN),
141 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
143 STATIC_ASSERT(sizeof(fib_node_bw_reason_flag_t) < 2,
144 "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
149 typedef enum fib_node_bw_flags_t_
152 * Force the walk to be synchronous
154 FIB_NODE_BW_FLAG_FORCE_SYNC = (1 << 0),
155 } fib_node_bw_flags_t;
158 * Forward eclarations
163 * A representation of one pointer to another node.
164 * To fully qualify a node, one must know its type and its index so it
165 * can be retrieved from the appropriate pool. Direct pointers to nodes
166 * are forbidden, since all nodes are allocated from pools, which are vectors,
167 * and thus subject to realloc at any time.
169 typedef struct fib_node_ptr_t_ {
173 fib_node_type_t fnp_type;
177 fib_node_index_t fnp_index;
181 * @brief A list of FIB nodes.
183 typedef u32 fib_node_list_t;
186 * Context passed between object during a back walk.
188 typedef struct fib_node_back_walk_ctx_t_ {
190 * The reason/trigger for the backwalk
192 fib_node_bw_reason_flag_t fnbw_reason;
195 * additional flags for the walk
197 fib_node_bw_flags_t fnbw_flags;
200 * the number of levels the walk has already traversed.
201 * this value is maintained by the walk infra, tp limit the depth of
202 * a walk so it does not run indefinately the presence of a loop/cycle
206 } fib_node_back_walk_ctx_t;
209 * We consider a depth of 32 to be sufficient to cover all sane
210 * network topologies. Anything more is then an indication that
211 * there is a loop/cycle in the FIB graph.
212 * Note that all object types contribute to 1 to the depth.
214 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
217 * A callback function for walking a node dependency list
219 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
223 * A list of dependent nodes.
224 * This is currently implemented as a hash_table of fib_node_ptr_t
226 typedef fib_node_ptr_t fib_node_ptr_list_t;
229 * Return code from a back walk function
231 typedef enum fib_node_back_walk_rc_t_ {
232 FIB_NODE_BACK_WALK_MERGE,
233 FIB_NODE_BACK_WALK_CONTINUE,
234 } fib_node_back_walk_rc_t;
237 * Function definition to backwalk a FIB node
239 typedef fib_node_back_walk_rc_t (*fib_node_back_walk_t)(
240 struct fib_node_t_ *node,
241 fib_node_back_walk_ctx_t *ctx);
244 * Function definition to get a FIB node from its index
246 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
249 * Function definition to inform the FIB node that its last lock has gone.
251 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
254 * Function definition to display the amount of memory used by a type.
255 * Implementations should call fib_show_memory_usage()
257 typedef void (*fib_node_memory_show_t)(void);
260 * A FIB graph nodes virtual function table
262 typedef struct fib_node_vft_t_ {
263 fib_node_get_t fnv_get;
264 fib_node_last_lock_gone_t fnv_last_lock;
265 fib_node_back_walk_t fnv_back_walk;
266 format_function_t *fnv_format;
267 fib_node_memory_show_t fnv_mem_show;
271 * An node in the FIB graph
273 * Objects in the FIB form a graph.
275 typedef struct fib_node_t_ {
278 * The node's type. make sure we are dynamic/down casting correctly
280 fib_node_type_t fn_type;
284 * we could store the type here instead, and lookup the VFT using that. But
285 * I like this better,
287 const fib_node_vft_t *fn_vft;
290 * Vector of nodes that depend upon/use/share this node
292 fib_node_list_t fn_children;
295 * Number of dependents on this node. This number includes the number
303 * Register the function table for a given type
309 * virtual function table
311 extern void fib_node_register_type (fib_node_type_t ft,
312 const fib_node_vft_t *vft);
316 * Create a new FIB node type and Register the function table for it.
319 * virtual function table
321 * @return new FIB node type
323 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
326 * @brief Show the memory usage for a type
328 * This should be invoked by the type in response to the infra calling
329 * its registered memory show function
331 * @param name the name of the type
332 * @param in_use_elts The number of elements in use
333 * @param allocd_elts The number of allocated pool elemenets
334 * @param size_elt The size of one element
336 extern void fib_show_memory_usage(const char *name,
341 extern void fib_node_init(fib_node_t *node,
343 extern void fib_node_deinit(fib_node_t *node);
345 extern void fib_node_lock(fib_node_t *node);
346 extern void fib_node_unlock(fib_node_t *node);
348 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
349 fib_node_index_t parent_index);
350 extern u32 fib_node_child_add(fib_node_type_t parent_type,
351 fib_node_index_t parent_index,
352 fib_node_type_t child_type,
353 fib_node_index_t child_index);
354 extern void fib_node_child_remove(fib_node_type_t parent_type,
355 fib_node_index_t parent_index,
356 fib_node_index_t sibling_index);
358 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
359 fib_node_back_walk_ctx_t *ctx);
361 extern u8* fib_node_children_format(fib_node_list_t list,
364 extern const char* fib_node_type_get_name(fib_node_type_t type);
367 fib_node_index_is_valid (fib_node_index_t ni)
369 return (FIB_NODE_INDEX_INVALID != ni);