FD.io VPP  v17.07.01-10-g3be13f0
Vector Packet Processing
fib_node.h
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 
16 #ifndef __FIB_NODE_H__
17 #define __FIB_NODE_H__
18 
19 #include <vnet/fib/fib_types.h>
20 
21 /**
22  * The types of nodes in a FIB graph
23  */
24 typedef enum fib_node_type_t_ {
25  /**
26  * Marker. New types after this one.
27  */
29  /**
30  * See the respective fib_*.h files for descriptions of these objects.
31  */
46  /**
47  * Marker. New types before this one. leave the test last.
48  */
52 
53 #define FIB_NODE_TYPE_MAX (FIB_NODE_TYPE_LAST + 1)
54 
55 #define FIB_NODE_TYPES { \
56  [FIB_NODE_TYPE_ENTRY] = "entry", \
57  [FIB_NODE_TYPE_MFIB_ENTRY] = "mfib-entry", \
58  [FIB_NODE_TYPE_WALK] = "walk", \
59  [FIB_NODE_TYPE_PATH_LIST] = "path-list", \
60  [FIB_NODE_TYPE_PATH] = "path", \
61  [FIB_NODE_TYPE_MPLS_ENTRY] = "mpls-entry", \
62  [FIB_NODE_TYPE_MPLS_TUNNEL] = "mpls-tunnel", \
63  [FIB_NODE_TYPE_ADJ] = "adj", \
64  [FIB_NODE_TYPE_LISP_GPE_FWD_ENTRY] = "lisp-gpe-fwd-entry", \
65  [FIB_NODE_TYPE_LISP_ADJ] = "lisp-adj", \
66  [FIB_NODE_TYPE_GRE_TUNNEL] = "gre-tunnel", \
67  [FIB_NODE_TYPE_VXLAN_TUNNEL] = "vxlan-tunnel", \
68  [FIB_NODE_TYPE_MAP_E] = "map-e", \
69  [FIB_NODE_TYPE_VXLAN_GPE_TUNNEL] = "vxlan-gpe-tunnel", \
70 }
71 
72 /**
73  * Reasons for backwalking the FIB object graph
74  */
76  /**
77  * Marker. Add new ones after.
78  */
80  /**
81  * Walk to re-resolve the child.
82  * Used when the parent is no longer a valid resolution target
83  */
85  /**
86  * Walk to re-evaluate the forwarding contributed by the parent.
87  * Used when a parent's forwarding changes and the child needs to
88  * incorporate this change in its forwarding.
89  */
91  /**
92  * A resolving interface has come up
93  */
95  /**
96  * A resolving interface has gone down
97  */
99  /**
100  * A resolving interface has been deleted.
101  */
103  /**
104  * Walk to re-collapse the multipath adjs when the rewrite of
105  * a unipath adjacency changes
106  */
108  /**
109  * Walk to update children to inform them the adjacency is now down.
110  */
112  /**
113  * Marker. Add new before and update
114  */
117 
118 #define FIB_NODE_BW_REASONS { \
119  [FIB_NODE_BW_REASON_RESOLVE] = "resolve", \
120  [FIB_NODE_BW_REASON_EVALUATE] = "evaluate", \
121  [FIB_NODE_BW_REASON_INTERFACE_UP] = "if-up", \
122  [FIB_NODE_BW_REASON_INTERFACE_DOWN] = "if-down", \
123  [FIB_NODE_BW_REASON_INTERFACE_DELETE] = "if-delete", \
124  [FIB_NODE_BW_REASON_ADJ_UPDATE] = "adj-update", \
125  [FIB_NODE_BW_REASON_ADJ_DOWN] = "adj-down", \
126 }
127 
128 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
129  for (_item = FIB_NODE_BW_REASON_FIRST; \
130  _item <= FIB_NODE_BW_REASON_LAST; \
131  _item++)
132 
133 /**
134  * Flags enum constructed from the reaons
135  */
145 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
146 
148  "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
149 
150 /**
151  * Flags on the walk
152  */
154 {
155  /**
156  * Force the walk to be synchronous
157  */
160 
161 /**
162  * Forward eclarations
163  */
164 struct fib_node_t_;
165 
166 /**
167  * A representation of one pointer to another node.
168  * To fully qualify a node, one must know its type and its index so it
169  * can be retrieved from the appropriate pool. Direct pointers to nodes
170  * are forbidden, since all nodes are allocated from pools, which are vectors,
171  * and thus subject to realloc at any time.
172  */
173 typedef struct fib_node_ptr_t_ {
174  /**
175  * node type
176  */
177  fib_node_type_t fnp_type;
178  /**
179  * node's index
180  */
183 
184 /**
185  * @brief A list of FIB nodes.
186  */
188 
189 /**
190  * Context passed between object during a back walk.
191  */
193  /**
194  * The reason/trigger for the backwalk
195  */
197 
198  /**
199  * additional flags for the walk
200  */
202 
203  /**
204  * the number of levels the walk has already traversed.
205  * this value is maintained by the walk infra, tp limit the depth of
206  * a walk so it does not run indefinately the presence of a loop/cycle
207  * in the graph.
208  */
211 
212 /**
213  * We consider a depth of 32 to be sufficient to cover all sane
214  * network topologies. Anything more is then an indication that
215  * there is a loop/cycle in the FIB graph.
216  * Note that all object types contribute to 1 to the depth.
217  */
218 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
219 
220 /**
221  * A callback function for walking a node dependency list
222  */
223 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
224  void *ctx);
225 
226 /**
227  * A list of dependent nodes.
228  * This is currently implemented as a hash_table of fib_node_ptr_t
229  */
231 
232 /**
233  * Return code from a back walk function
234  */
239 
240 /**
241  * Function definition to backwalk a FIB node
242  */
244  struct fib_node_t_ *node,
246 
247 /**
248  * Function definition to get a FIB node from its index
249  */
250 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
251 
252 /**
253  * Function definition to inform the FIB node that its last lock has gone.
254  */
255 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
256 
257 /**
258  * Function definition to display the amount of memory used by a type.
259  * Implementations should call fib_show_memory_usage()
260  */
261 typedef void (*fib_node_memory_show_t)(void);
262 
263 /**
264  * A FIB graph nodes virtual function table
265  */
266 typedef struct fib_node_vft_t_ {
273 
274 /**
275  * An node in the FIB graph
276  *
277  * Objects in the FIB form a graph.
278  */
279 typedef struct fib_node_t_ {
280 #if CLIB_DEBUG > 0
281  /**
282  * The node's type. make sure we are dynamic/down casting correctly
283  */
284  fib_node_type_t fn_type;
285 #endif
286  /**
287  * The node's VFT.
288  * we could store the type here instead, and lookup the VFT using that. But
289  * I like this better,
290  */
292 
293  /**
294  * Vector of nodes that depend upon/use/share this node
295  */
296  fib_node_list_t fn_children;
297 
298  /**
299  * Number of dependents on this node. This number includes the number
300  * of children
301  */
303 } fib_node_t;
304 
305 /**
306  * @brief
307  * Register the function table for a given type
308  *
309  * @param ft
310  * FIB node type
311  *
312  * @param vft
313  * virtual function table
314  */
315 extern void fib_node_register_type (fib_node_type_t ft,
316  const fib_node_vft_t *vft);
317 
318 /**
319  * @brief
320  * Create a new FIB node type and Register the function table for it.
321  *
322  * @param vft
323  * virtual function table
324  *
325  * @return new FIB node type
326  */
327 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
328 
329 /**
330  * @brief Show the memory usage for a type
331  *
332  * This should be invoked by the type in response to the infra calling
333  * its registered memory show function
334  *
335  * @param name the name of the type
336  * @param in_use_elts The number of elements in use
337  * @param allocd_elts The number of allocated pool elemenets
338  * @param size_elt The size of one element
339  */
340 extern void fib_show_memory_usage(const char *name,
341  u32 in_use_elts,
342  u32 allocd_elts,
343  size_t size_elt);
344 
345 extern void fib_node_init(fib_node_t *node,
346  fib_node_type_t ft);
347 extern void fib_node_deinit(fib_node_t *node);
348 
349 extern void fib_node_lock(fib_node_t *node);
350 extern void fib_node_unlock(fib_node_t *node);
351 
352 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
353  fib_node_index_t parent_index);
354 extern u32 fib_node_child_add(fib_node_type_t parent_type,
355  fib_node_index_t parent_index,
356  fib_node_type_t child_type,
357  fib_node_index_t child_index);
358 extern void fib_node_child_remove(fib_node_type_t parent_type,
359  fib_node_index_t parent_index,
360  fib_node_index_t sibling_index);
361 
362 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
364 
365 extern u8* fib_node_children_format(fib_node_list_t list,
366  u8 *s);
367 
368 extern const char* fib_node_type_get_name(fib_node_type_t type);
369 
370 static inline int
372 {
373  return (FIB_NODE_INDEX_INVALID != ni);
374 }
375 
376 #endif
377 
const fib_node_vft_t * fn_vft
The node&#39;s VFT.
Definition: fib_node.h:291
enum fib_node_type_t_ fib_node_type_t
The types of nodes in a FIB graph.
enum fib_node_back_walk_rc_t_ fib_node_back_walk_rc_t
Return code from a back walk function.
Walk to update children to inform them the adjacency is now down.
Definition: fib_node.h:111
const char * fib_node_type_get_name(fib_node_type_t type)
Definition: fib_node.c:35
u8 *( format_function_t)(u8 *s, va_list *args)
Definition: format.h:48
void fib_node_lock(fib_node_t *node)
Definition: fib_node.c:204
Walk to re-collapse the multipath adjs when the rewrite of a unipath adjacency changes.
Definition: fib_node.h:107
fib_node_back_walk_reason_t_
Reasons for backwalking the FIB object graph.
Definition: fib_node.h:75
Walk to re-resolve the child.
Definition: fib_node.h:84
fib_node_index_t fnp_index
node&#39;s index
Definition: fib_node.h:181
fib_node_bw_reason_flag_t_
Flags enum constructed from the reaons.
Definition: fib_node.h:136
fib_node_last_lock_gone_t fnv_last_lock
Definition: fib_node.h:268
fib_node_back_walk_rc_t(* fib_node_back_walk_t)(struct fib_node_t_ *node, fib_node_back_walk_ctx_t *ctx)
Function definition to backwalk a FIB node.
Definition: fib_node.h:243
fib_node_ptr_t fib_node_ptr_list_t
A list of dependent nodes.
Definition: fib_node.h:230
A representation of one pointer to another node.
Definition: fib_node.h:173
A resolving interface has gone down.
Definition: fib_node.h:98
u32 fib_node_get_n_children(fib_node_type_t parent_type, fib_node_index_t parent_index)
Definition: fib_node.c:140
struct fib_node_back_walk_ctx_t_ fib_node_back_walk_ctx_t
Context passed between object during a back walk.
void(* fib_node_last_lock_gone_t)(struct fib_node_t_ *node)
Function definition to inform the FIB node that its last lock has gone.
Definition: fib_node.h:255
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:196
struct fib_node_t_ *(* fib_node_get_t)(fib_node_index_t index)
Function definition to get a FIB node from its index.
Definition: fib_node.h:250
struct fib_node_ptr_t_ fib_node_ptr_t
A representation of one pointer to another node.
fib_node_type_t fnp_type
node type
Definition: fib_node.h:177
u32 fnbw_depth
the number of levels the walk has already traversed.
Definition: fib_node.h:209
int(* fib_node_ptr_walk_t)(fib_node_ptr_t *depend, void *ctx)
A callback function for walking a node dependency list.
Definition: fib_node.h:223
fib_node_type_t fib_node_register_new_type(const fib_node_vft_t *vft)
Create a new FIB node type and Register the function table for it.
Definition: fib_node.c:78
fib_node_bw_flags_t fnbw_flags
additional flags for the walk
Definition: fib_node.h:201
void fib_node_register_type(fib_node_type_t ft, const fib_node_vft_t *vft)
Register the function table for a given type.
Definition: fib_node.c:58
STATIC_ASSERT(sizeof(fib_node_bw_reason_flag_t)< 2,"BW Reason enum < 2 byte. Consequences for cover_upd_res_t")
fib_node_type_t fn_type
The node&#39;s type.
Definition: fib_node.h:284
An node in the FIB graph.
Definition: fib_node.h:279
format_function_t * fnv_format
Definition: fib_node.h:270
enum fib_node_bw_reason_flag_t_ fib_node_bw_reason_flag_t
Flags enum constructed from the reaons.
fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr, fib_node_back_walk_ctx_t *ctx)
Definition: fib_node.c:152
enum fib_node_bw_flags_t_ fib_node_bw_flags_t
Flags on the walk.
fib_node_list_t fn_children
Vector of nodes that depend upon/use/share this node.
Definition: fib_node.h:296
void fib_show_memory_usage(const char *name, u32 in_use_elts, u32 allocd_elts, size_t size_elt)
Show the memory usage for a type.
Definition: fib_node.c:221
Force the walk to be synchronous.
Definition: fib_node.h:158
fib_node_get_t fnv_get
Definition: fib_node.h:267
fib_node_back_walk_t fnv_back_walk
Definition: fib_node.h:269
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:28
A resolving interface has been deleted.
Definition: fib_node.h:102
Context passed between object during a back walk.
Definition: fib_node.h:192
unsigned int u32
Definition: types.h:88
u8 * fib_node_children_format(fib_node_list_t list, u8 *s)
Definition: fib_node.c:174
fib_node_type_t_
The types of nodes in a FIB graph.
Definition: fib_node.h:24
void fib_node_init(fib_node_t *node, fib_node_type_t ft)
Definition: fib_node.c:183
enum fib_node_back_walk_reason_t_ fib_node_back_walk_reason_t
Reasons for backwalking the FIB object graph.
u32 fib_node_child_add(fib_node_type_t parent_type, fib_node_index_t parent_index, fib_node_type_t child_type, fib_node_index_t child_index)
Definition: fib_node.c:96
void(* fib_node_memory_show_t)(void)
Function definition to display the amount of memory used by a type.
Definition: fib_node.h:261
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:29
unsigned char u8
Definition: types.h:56
u32 fn_locks
Number of dependents on this node.
Definition: fib_node.h:302
Walk to re-evaluate the forwarding contributed by the parent.
Definition: fib_node.h:90
A resolving interface has come up.
Definition: fib_node.h:94
struct fib_node_vft_t_ fib_node_vft_t
A FIB graph nodes virtual function table.
fib_node_bw_flags_t_
Flags on the walk.
Definition: fib_node.h:153
See the respective fib_*.h files for descriptions of these objects.
Definition: fib_node.h:32
static int fib_node_index_is_valid(fib_node_index_t ni)
Definition: fib_node.h:371
A FIB graph nodes virtual function table.
Definition: fib_node.h:266
u32 fib_node_list_t
A list of FIB nodes.
Definition: fib_node.h:187
fib_node_back_walk_rc_t_
Return code from a back walk function.
Definition: fib_node.h:235
void fib_node_unlock(fib_node_t *node)
Definition: fib_node.c:210
void fib_node_child_remove(fib_node_type_t parent_type, fib_node_index_t parent_index, fib_node_index_t sibling_index)
Definition: fib_node.c:121
struct fib_node_t_ fib_node_t
An node in the FIB graph.
void fib_node_deinit(fib_node_t *node)
Definition: fib_node.c:198
fib_node_memory_show_t fnv_mem_show
Definition: fib_node.h:271