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_VXLAN_TUNNEL,
44 FIB_NODE_TYPE_VXLAN_GPE_TUNNEL,
45 FIB_NODE_TYPE_GENEVE_TUNNEL,
46 FIB_NODE_TYPE_UDP_ENCAP,
47 FIB_NODE_TYPE_BIER_FMASK,
48 FIB_NODE_TYPE_BIER_ENTRY,
49 FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
50 FIB_NODE_TYPE_IPSEC_SA,
51 FIB_NODE_TYPE_IP_PUNT_REDIRECT,
52 FIB_NODE_TYPE_ENTRY_TRACK,
54 * Marker. New types before this one. leave the test last.
57 FIB_NODE_TYPE_LAST = FIB_NODE_TYPE_TEST,
58 } __attribute__ ((packed)) fib_node_type_t;
60 #define FIB_NODE_TYPE_MAX (FIB_NODE_TYPE_LAST + 1)
62 #define FIB_NODE_TYPES { \
63 [FIB_NODE_TYPE_ENTRY] = "entry", \
64 [FIB_NODE_TYPE_MFIB_ENTRY] = "mfib-entry", \
65 [FIB_NODE_TYPE_WALK] = "walk", \
66 [FIB_NODE_TYPE_PATH_LIST] = "path-list", \
67 [FIB_NODE_TYPE_PATH] = "path", \
68 [FIB_NODE_TYPE_MPLS_ENTRY] = "mpls-entry", \
69 [FIB_NODE_TYPE_MPLS_TUNNEL] = "mpls-tunnel", \
70 [FIB_NODE_TYPE_ADJ] = "adj", \
71 [FIB_NODE_TYPE_LISP_GPE_FWD_ENTRY] = "lisp-gpe-fwd-entry", \
72 [FIB_NODE_TYPE_LISP_ADJ] = "lisp-adj", \
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", \
81 [FIB_NODE_TYPE_IP_PUNT_REDIRECT] = "ip-punt-redirect", \
82 [FIB_NODE_TYPE_ENTRY_TRACK] = "fib-entry-track" \
86 * Reasons for backwalking the FIB object graph
88 typedef enum fib_node_back_walk_reason_t_ {
90 * Marker. Add new ones after.
92 FIB_NODE_BW_REASON_FIRST = 0,
94 * Walk to re-resolve the child.
95 * Used when the parent is no longer a valid resolution target
97 FIB_NODE_BW_REASON_RESOLVE = FIB_NODE_BW_REASON_FIRST,
99 * Walk to re-evaluate the forwarding contributed by the parent.
100 * Used when a parent's forwarding changes and the child needs to
101 * incorporate this change in its forwarding.
103 FIB_NODE_BW_REASON_EVALUATE,
105 * A resolving interface has come up
107 FIB_NODE_BW_REASON_INTERFACE_UP,
109 * A resolving interface has gone down
111 FIB_NODE_BW_REASON_INTERFACE_DOWN,
113 * A resolving interface has been deleted.
115 FIB_NODE_BW_REASON_INTERFACE_DELETE,
117 * Walk to re-collapse the multipath adjs when the rewrite of
118 * a unipath adjacency changes
120 FIB_NODE_BW_REASON_ADJ_UPDATE,
122 * Walk to update children to inform them the adjacency is now down.
124 FIB_NODE_BW_REASON_ADJ_DOWN,
126 * Marker. Add new before and update
128 FIB_NODE_BW_REASON_LAST = FIB_NODE_BW_REASON_ADJ_DOWN,
129 } fib_node_back_walk_reason_t;
131 #define FIB_NODE_BW_REASONS { \
132 [FIB_NODE_BW_REASON_RESOLVE] = "resolve", \
133 [FIB_NODE_BW_REASON_EVALUATE] = "evaluate", \
134 [FIB_NODE_BW_REASON_INTERFACE_UP] = "if-up", \
135 [FIB_NODE_BW_REASON_INTERFACE_DOWN] = "if-down", \
136 [FIB_NODE_BW_REASON_INTERFACE_DELETE] = "if-delete", \
137 [FIB_NODE_BW_REASON_ADJ_UPDATE] = "adj-update", \
138 [FIB_NODE_BW_REASON_ADJ_DOWN] = "adj-down", \
141 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
142 for (_item = FIB_NODE_BW_REASON_FIRST; \
143 _item <= FIB_NODE_BW_REASON_LAST; \
147 * Flags enum constructed from the reaons
149 typedef enum fib_node_bw_reason_flag_t_ {
150 FIB_NODE_BW_REASON_FLAG_NONE = 0,
151 FIB_NODE_BW_REASON_FLAG_RESOLVE = (1 << FIB_NODE_BW_REASON_RESOLVE),
152 FIB_NODE_BW_REASON_FLAG_EVALUATE = (1 << FIB_NODE_BW_REASON_EVALUATE),
153 FIB_NODE_BW_REASON_FLAG_INTERFACE_UP = (1 << FIB_NODE_BW_REASON_INTERFACE_UP),
154 FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN = (1 << FIB_NODE_BW_REASON_INTERFACE_DOWN),
155 FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE = (1 << FIB_NODE_BW_REASON_INTERFACE_DELETE),
156 FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE = (1 << FIB_NODE_BW_REASON_ADJ_UPDATE),
157 FIB_NODE_BW_REASON_FLAG_ADJ_DOWN = (1 << FIB_NODE_BW_REASON_ADJ_DOWN),
158 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
160 STATIC_ASSERT(sizeof(fib_node_bw_reason_flag_t) < 2,
161 "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
163 extern u8 *format_fib_node_bw_reason(u8 *s, va_list *args);
168 typedef enum fib_node_bw_flags_t_
170 FIB_NODE_BW_FLAG_NONE = 0,
172 * Force the walk to be synchronous
174 FIB_NODE_BW_FLAG_FORCE_SYNC = (1 << 0),
175 } fib_node_bw_flags_t;
178 * Forward declarations
183 * A representation of one pointer to another node.
184 * To fully qualify a node, one must know its type and its index so it
185 * can be retrieved from the appropriate pool. Direct pointers to nodes
186 * are forbidden, since all nodes are allocated from pools, which are vectors,
187 * and thus subject to realloc at any time.
189 typedef struct fib_node_ptr_t_ {
193 fib_node_type_t fnp_type;
197 fib_node_index_t fnp_index;
201 * @brief A list of FIB nodes.
203 typedef u32 fib_node_list_t;
206 * Context passed between object during a back walk.
208 typedef struct fib_node_back_walk_ctx_t_ {
210 * The reason/trigger for the backwalk
212 fib_node_bw_reason_flag_t fnbw_reason;
215 * additional flags for the walk
217 fib_node_bw_flags_t fnbw_flags;
220 * the number of levels the walk has already traversed.
221 * this value is maintained by the walk infra, tp limit the depth of
222 * a walk so it does not run indefinately the presence of a loop/cycle
226 } fib_node_back_walk_ctx_t;
229 * We consider a depth of 32 to be sufficient to cover all sane
230 * network topologies. Anything more is then an indication that
231 * there is a loop/cycle in the FIB graph.
232 * Note that all object types contribute to 1 to the depth.
234 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
237 * A callback function for walking a node dependency list
239 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
243 * A list of dependent nodes.
244 * This is currently implemented as a hash_table of fib_node_ptr_t
246 typedef fib_node_ptr_t fib_node_ptr_list_t;
249 * Return code from a back walk function
251 typedef enum fib_node_back_walk_rc_t_ {
252 FIB_NODE_BACK_WALK_MERGE,
253 FIB_NODE_BACK_WALK_CONTINUE,
254 } fib_node_back_walk_rc_t;
257 * Function definition to backwalk a FIB node
259 typedef fib_node_back_walk_rc_t (*fib_node_back_walk_t)(
260 struct fib_node_t_ *node,
261 fib_node_back_walk_ctx_t *ctx);
264 * Function definition to get a FIB node from its index
266 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
269 * Function definition to inform the FIB node that its last lock has gone.
271 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
274 * Function definition to display the amount of memory used by a type.
275 * Implementations should call fib_show_memory_usage()
277 typedef void (*fib_node_memory_show_t)(void);
280 * A FIB graph nodes virtual function table
282 typedef struct fib_node_vft_t_ {
283 fib_node_get_t fnv_get;
284 fib_node_last_lock_gone_t fnv_last_lock;
285 fib_node_back_walk_t fnv_back_walk;
286 format_function_t *fnv_format;
287 fib_node_memory_show_t fnv_mem_show;
291 * An node in the FIB graph
293 * Objects in the FIB form a graph.
295 typedef struct fib_node_t_ {
297 * The node's type. make sure we are dynamic/down casting correctly
299 fib_node_type_t fn_type;
302 * Some pad space the concrete/derived type is free to use
307 * Vector of nodes that depend upon/use/share this node
309 fib_node_list_t fn_children;
312 * Number of dependents on this node. This number includes the number
318 STATIC_ASSERT(sizeof(fib_node_t) == 12, "FIB node type is growing");
322 * Register the function table for a given type
328 * virtual function table
330 extern void fib_node_register_type (fib_node_type_t ft,
331 const fib_node_vft_t *vft);
335 * Create a new FIB node type and Register the function table for it.
338 * virtual function table
340 * @return new FIB node type
342 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
345 * @brief Show the memory usage for a type
347 * This should be invoked by the type in response to the infra calling
348 * its registered memory show function
350 * @param name the name of the type
351 * @param in_use_elts The number of elements in use
352 * @param allocd_elts The number of allocated pool elemenets
353 * @param size_elt The size of one element
355 extern void fib_show_memory_usage(const char *name,
360 extern void fib_node_init(fib_node_t *node,
362 extern void fib_node_deinit(fib_node_t *node);
364 extern void fib_node_lock(fib_node_t *node);
365 extern void fib_node_unlock(fib_node_t *node);
367 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
368 fib_node_index_t parent_index);
369 extern u32 fib_node_child_add(fib_node_type_t parent_type,
370 fib_node_index_t parent_index,
371 fib_node_type_t child_type,
372 fib_node_index_t child_index);
373 extern void fib_node_child_remove(fib_node_type_t parent_type,
374 fib_node_index_t parent_index,
375 fib_node_index_t sibling_index);
377 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
378 fib_node_back_walk_ctx_t *ctx);
380 extern u8* fib_node_children_format(fib_node_list_t list,
383 extern const char* fib_node_type_get_name(fib_node_type_t type);
386 fib_node_index_is_valid (fib_node_index_t ni)
388 return (FIB_NODE_INDEX_INVALID != ni);