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,
51 * Marker. New types before this one. leave the test last.
54 FIB_NODE_TYPE_LAST = FIB_NODE_TYPE_TEST,
55 } __attribute__ ((packed)) fib_node_type_t;
57 #define FIB_NODE_TYPE_MAX (FIB_NODE_TYPE_LAST + 1)
59 #define FIB_NODE_TYPES { \
60 [FIB_NODE_TYPE_ENTRY] = "entry", \
61 [FIB_NODE_TYPE_MFIB_ENTRY] = "mfib-entry", \
62 [FIB_NODE_TYPE_WALK] = "walk", \
63 [FIB_NODE_TYPE_PATH_LIST] = "path-list", \
64 [FIB_NODE_TYPE_PATH] = "path", \
65 [FIB_NODE_TYPE_MPLS_ENTRY] = "mpls-entry", \
66 [FIB_NODE_TYPE_MPLS_TUNNEL] = "mpls-tunnel", \
67 [FIB_NODE_TYPE_ADJ] = "adj", \
68 [FIB_NODE_TYPE_LISP_GPE_FWD_ENTRY] = "lisp-gpe-fwd-entry", \
69 [FIB_NODE_TYPE_LISP_ADJ] = "lisp-adj", \
70 [FIB_NODE_TYPE_GRE_TUNNEL] = "gre-tunnel", \
71 [FIB_NODE_TYPE_VXLAN_TUNNEL] = "vxlan-tunnel", \
72 [FIB_NODE_TYPE_MAP_E] = "map-e", \
73 [FIB_NODE_TYPE_VXLAN_GPE_TUNNEL] = "vxlan-gpe-tunnel", \
74 [FIB_NODE_TYPE_UDP_ENCAP] = "udp-encap", \
75 [FIB_NODE_TYPE_BIER_FMASK] = "bier-fmask", \
76 [FIB_NODE_TYPE_BIER_ENTRY] = "bier-entry", \
80 * Reasons for backwalking the FIB object graph
82 typedef enum fib_node_back_walk_reason_t_ {
84 * Marker. Add new ones after.
86 FIB_NODE_BW_REASON_FIRST = 0,
88 * Walk to re-resolve the child.
89 * Used when the parent is no longer a valid resolution target
91 FIB_NODE_BW_REASON_RESOLVE = FIB_NODE_BW_REASON_FIRST,
93 * Walk to re-evaluate the forwarding contributed by the parent.
94 * Used when a parent's forwarding changes and the child needs to
95 * incorporate this change in its forwarding.
97 FIB_NODE_BW_REASON_EVALUATE,
99 * A resolving interface has come up
101 FIB_NODE_BW_REASON_INTERFACE_UP,
103 * A resolving interface has gone down
105 FIB_NODE_BW_REASON_INTERFACE_DOWN,
107 * A resolving interface has been deleted.
109 FIB_NODE_BW_REASON_INTERFACE_DELETE,
111 * Walk to re-collapse the multipath adjs when the rewrite of
112 * a unipath adjacency changes
114 FIB_NODE_BW_REASON_ADJ_UPDATE,
116 * Walk to update children to inform them the adjacency is now down.
118 FIB_NODE_BW_REASON_ADJ_DOWN,
120 * Marker. Add new before and update
122 FIB_NODE_BW_REASON_LAST = FIB_NODE_BW_REASON_ADJ_DOWN,
123 } fib_node_back_walk_reason_t;
125 #define FIB_NODE_BW_REASONS { \
126 [FIB_NODE_BW_REASON_RESOLVE] = "resolve", \
127 [FIB_NODE_BW_REASON_EVALUATE] = "evaluate", \
128 [FIB_NODE_BW_REASON_INTERFACE_UP] = "if-up", \
129 [FIB_NODE_BW_REASON_INTERFACE_DOWN] = "if-down", \
130 [FIB_NODE_BW_REASON_INTERFACE_DELETE] = "if-delete", \
131 [FIB_NODE_BW_REASON_ADJ_UPDATE] = "adj-update", \
132 [FIB_NODE_BW_REASON_ADJ_DOWN] = "adj-down", \
135 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
136 for (_item = FIB_NODE_BW_REASON_FIRST; \
137 _item <= FIB_NODE_BW_REASON_LAST; \
141 * Flags enum constructed from the reaons
143 typedef enum fib_node_bw_reason_flag_t_ {
144 FIB_NODE_BW_REASON_FLAG_NONE = 0,
145 FIB_NODE_BW_REASON_FLAG_RESOLVE = (1 << FIB_NODE_BW_REASON_RESOLVE),
146 FIB_NODE_BW_REASON_FLAG_EVALUATE = (1 << FIB_NODE_BW_REASON_EVALUATE),
147 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP = (1 << FIB_NODE_BW_REASON_INTERFACE_UP),
148 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN = (1 << FIB_NODE_BW_REASON_INTERFACE_DOWN),
149 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE = (1 << FIB_NODE_BW_REASON_INTERFACE_DELETE),
150 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE = (1 << FIB_NODE_BW_REASON_ADJ_UPDATE),
151 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN = (1 << FIB_NODE_BW_REASON_ADJ_DOWN),
152 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
154 STATIC_ASSERT(sizeof(fib_node_bw_reason_flag_t) < 2,
155 "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
160 typedef enum fib_node_bw_flags_t_
163 * Force the walk to be synchronous
165 FIB_NODE_BW_FLAG_FORCE_SYNC = (1 << 0),
166 } fib_node_bw_flags_t;
169 * Forward eclarations
174 * A representation of one pointer to another node.
175 * To fully qualify a node, one must know its type and its index so it
176 * can be retrieved from the appropriate pool. Direct pointers to nodes
177 * are forbidden, since all nodes are allocated from pools, which are vectors,
178 * and thus subject to realloc at any time.
180 typedef struct fib_node_ptr_t_ {
184 fib_node_type_t fnp_type;
188 fib_node_index_t fnp_index;
192 * @brief A list of FIB nodes.
194 typedef u32 fib_node_list_t;
197 * Context passed between object during a back walk.
199 typedef struct fib_node_back_walk_ctx_t_ {
201 * The reason/trigger for the backwalk
203 fib_node_bw_reason_flag_t fnbw_reason;
206 * additional flags for the walk
208 fib_node_bw_flags_t fnbw_flags;
211 * the number of levels the walk has already traversed.
212 * this value is maintained by the walk infra, tp limit the depth of
213 * a walk so it does not run indefinately the presence of a loop/cycle
217 } fib_node_back_walk_ctx_t;
220 * We consider a depth of 32 to be sufficient to cover all sane
221 * network topologies. Anything more is then an indication that
222 * there is a loop/cycle in the FIB graph.
223 * Note that all object types contribute to 1 to the depth.
225 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
228 * A callback function for walking a node dependency list
230 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
234 * A list of dependent nodes.
235 * This is currently implemented as a hash_table of fib_node_ptr_t
237 typedef fib_node_ptr_t fib_node_ptr_list_t;
240 * Return code from a back walk function
242 typedef enum fib_node_back_walk_rc_t_ {
243 FIB_NODE_BACK_WALK_MERGE,
244 FIB_NODE_BACK_WALK_CONTINUE,
245 } fib_node_back_walk_rc_t;
248 * Function definition to backwalk a FIB node
250 typedef fib_node_back_walk_rc_t (*fib_node_back_walk_t)(
251 struct fib_node_t_ *node,
252 fib_node_back_walk_ctx_t *ctx);
255 * Function definition to get a FIB node from its index
257 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
260 * Function definition to inform the FIB node that its last lock has gone.
262 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
265 * Function definition to display the amount of memory used by a type.
266 * Implementations should call fib_show_memory_usage()
268 typedef void (*fib_node_memory_show_t)(void);
271 * A FIB graph nodes virtual function table
273 typedef struct fib_node_vft_t_ {
274 fib_node_get_t fnv_get;
275 fib_node_last_lock_gone_t fnv_last_lock;
276 fib_node_back_walk_t fnv_back_walk;
277 format_function_t *fnv_format;
278 fib_node_memory_show_t fnv_mem_show;
282 * An node in the FIB graph
284 * Objects in the FIB form a graph.
286 typedef struct fib_node_t_ {
288 * The node's type. make sure we are dynamic/down casting correctly
290 fib_node_type_t fn_type;
293 * Some pad space the concrete/derived type is free to use
298 * Vector of nodes that depend upon/use/share this node
300 fib_node_list_t fn_children;
303 * Number of dependents on this node. This number includes the number
309 STATIC_ASSERT(sizeof(fib_node_t) == 12, "FIB node type is growing");
313 * Register the function table for a given type
319 * virtual function table
321 extern void fib_node_register_type (fib_node_type_t ft,
322 const fib_node_vft_t *vft);
326 * Create a new FIB node type and Register the function table for it.
329 * virtual function table
331 * @return new FIB node type
333 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
336 * @brief Show the memory usage for a type
338 * This should be invoked by the type in response to the infra calling
339 * its registered memory show function
341 * @param name the name of the type
342 * @param in_use_elts The number of elements in use
343 * @param allocd_elts The number of allocated pool elemenets
344 * @param size_elt The size of one element
346 extern void fib_show_memory_usage(const char *name,
351 extern void fib_node_init(fib_node_t *node,
353 extern void fib_node_deinit(fib_node_t *node);
355 extern void fib_node_lock(fib_node_t *node);
356 extern void fib_node_unlock(fib_node_t *node);
358 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
359 fib_node_index_t parent_index);
360 extern u32 fib_node_child_add(fib_node_type_t parent_type,
361 fib_node_index_t parent_index,
362 fib_node_type_t child_type,
363 fib_node_index_t child_index);
364 extern void fib_node_child_remove(fib_node_type_t parent_type,
365 fib_node_index_t parent_index,
366 fib_node_index_t sibling_index);
368 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
369 fib_node_back_walk_ctx_t *ctx);
371 extern u8* fib_node_children_format(fib_node_list_t list,
374 extern const char* fib_node_type_get_name(fib_node_type_t type);
377 fib_node_index_is_valid (fib_node_index_t ni)
379 return (FIB_NODE_INDEX_INVALID != ni);