FD.io VPP  v18.01.2-1-g9b554f3
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  */
50  /**
51  * Marker. New types before this one. leave the test last.
52  */
55 } __attribute__ ((packed)) fib_node_type_t;
56 
57 #define FIB_NODE_TYPE_MAX (FIB_NODE_TYPE_LAST + 1)
58 
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", \
77 }
78 
79 /**
80  * Reasons for backwalking the FIB object graph
81  */
83  /**
84  * Marker. Add new ones after.
85  */
87  /**
88  * Walk to re-resolve the child.
89  * Used when the parent is no longer a valid resolution target
90  */
92  /**
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.
96  */
98  /**
99  * A resolving interface has come up
100  */
102  /**
103  * A resolving interface has gone down
104  */
106  /**
107  * A resolving interface has been deleted.
108  */
110  /**
111  * Walk to re-collapse the multipath adjs when the rewrite of
112  * a unipath adjacency changes
113  */
115  /**
116  * Walk to update children to inform them the adjacency is now down.
117  */
119  /**
120  * Marker. Add new before and update
121  */
124 
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", \
133 }
134 
135 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
136  for (_item = FIB_NODE_BW_REASON_FIRST; \
137  _item <= FIB_NODE_BW_REASON_LAST; \
138  _item++)
139 
140 /**
141  * Flags enum constructed from the reaons
142  */
152 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
153 
155  "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
156 
157 /**
158  * Flags on the walk
159  */
161 {
162  /**
163  * Force the walk to be synchronous
164  */
167 
168 /**
169  * Forward eclarations
170  */
171 struct fib_node_t_;
172 
173 /**
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.
179  */
180 typedef struct fib_node_ptr_t_ {
181  /**
182  * node type
183  */
184  fib_node_type_t fnp_type;
185  /**
186  * node's index
187  */
190 
191 /**
192  * @brief A list of FIB nodes.
193  */
195 
196 /**
197  * Context passed between object during a back walk.
198  */
200  /**
201  * The reason/trigger for the backwalk
202  */
204 
205  /**
206  * additional flags for the walk
207  */
209 
210  /**
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
214  * in the graph.
215  */
218 
219 /**
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.
224  */
225 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
226 
227 /**
228  * A callback function for walking a node dependency list
229  */
230 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
231  void *ctx);
232 
233 /**
234  * A list of dependent nodes.
235  * This is currently implemented as a hash_table of fib_node_ptr_t
236  */
238 
239 /**
240  * Return code from a back walk function
241  */
246 
247 /**
248  * Function definition to backwalk a FIB node
249  */
251  struct fib_node_t_ *node,
253 
254 /**
255  * Function definition to get a FIB node from its index
256  */
257 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
258 
259 /**
260  * Function definition to inform the FIB node that its last lock has gone.
261  */
262 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
263 
264 /**
265  * Function definition to display the amount of memory used by a type.
266  * Implementations should call fib_show_memory_usage()
267  */
268 typedef void (*fib_node_memory_show_t)(void);
269 
270 /**
271  * A FIB graph nodes virtual function table
272  */
273 typedef struct fib_node_vft_t_ {
280 
281 /**
282  * An node in the FIB graph
283  *
284  * Objects in the FIB form a graph.
285  */
286 typedef struct fib_node_t_ {
287  /**
288  * The node's type. make sure we are dynamic/down casting correctly
289  */
290  fib_node_type_t fn_type;
291 
292  /**
293  * Some pad space the concrete/derived type is free to use
294  */
296  /**
297  * The node's VFT.
298  * we could store the type here instead, and lookup the VFT using that. But
299  * I like this better,
300  */
301 // const fib_node_vft_t *fn_vft;
302 
303  /**
304  * Vector of nodes that depend upon/use/share this node
305  */
306  fib_node_list_t fn_children;
307 
308  /**
309  * Number of dependents on this node. This number includes the number
310  * of children
311  */
313 } fib_node_t;
314 
315 STATIC_ASSERT(sizeof(fib_node_t) == 12, "FIB node type is growing");
316 
317 /**
318  * @brief
319  * Register the function table for a given type
320  *
321  * @param ft
322  * FIB node type
323  *
324  * @param vft
325  * virtual function table
326  */
327 extern void fib_node_register_type (fib_node_type_t ft,
328  const fib_node_vft_t *vft);
329 
330 /**
331  * @brief
332  * Create a new FIB node type and Register the function table for it.
333  *
334  * @param vft
335  * virtual function table
336  *
337  * @return new FIB node type
338  */
339 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
340 
341 /**
342  * @brief Show the memory usage for a type
343  *
344  * This should be invoked by the type in response to the infra calling
345  * its registered memory show function
346  *
347  * @param name the name of the type
348  * @param in_use_elts The number of elements in use
349  * @param allocd_elts The number of allocated pool elemenets
350  * @param size_elt The size of one element
351  */
352 extern void fib_show_memory_usage(const char *name,
353  u32 in_use_elts,
354  u32 allocd_elts,
355  size_t size_elt);
356 
357 extern void fib_node_init(fib_node_t *node,
358  fib_node_type_t ft);
359 extern void fib_node_deinit(fib_node_t *node);
360 
361 extern void fib_node_lock(fib_node_t *node);
362 extern void fib_node_unlock(fib_node_t *node);
363 
364 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
365  fib_node_index_t parent_index);
366 extern u32 fib_node_child_add(fib_node_type_t parent_type,
367  fib_node_index_t parent_index,
368  fib_node_type_t child_type,
369  fib_node_index_t child_index);
370 extern void fib_node_child_remove(fib_node_type_t parent_type,
371  fib_node_index_t parent_index,
372  fib_node_index_t sibling_index);
373 
374 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
376 
377 extern u8* fib_node_children_format(fib_node_list_t list,
378  u8 *s);
379 
380 extern const char* fib_node_type_get_name(fib_node_type_t type);
381 
382 static inline int
384 {
385  return (FIB_NODE_INDEX_INVALID != ni);
386 }
387 
388 #endif
389 
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:118
const char * fib_node_type_get_name(fib_node_type_t type)
Definition: fib_node.c:37
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:203
Walk to re-collapse the multipath adjs when the rewrite of a unipath adjacency changes.
Definition: fib_node.h:114
fib_node_back_walk_reason_t_
Reasons for backwalking the FIB object graph.
Definition: fib_node.h:82
Walk to re-resolve the child.
Definition: fib_node.h:91
fib_node_index_t fnp_index
node&#39;s index
Definition: fib_node.h:188
fib_node_bw_reason_flag_t_
Flags enum constructed from the reaons.
Definition: fib_node.h:143
fib_node_last_lock_gone_t fnv_last_lock
Definition: fib_node.h:275
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:250
fib_node_ptr_t fib_node_ptr_list_t
A list of dependent nodes.
Definition: fib_node.h:237
A representation of one pointer to another node.
Definition: fib_node.h:180
A resolving interface has gone down.
Definition: fib_node.h:105
u32 fib_node_get_n_children(fib_node_type_t parent_type, fib_node_index_t parent_index)
Definition: fib_node.c:142
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:262
fib_node_bw_reason_flag_t fnbw_reason
The reason/trigger for the backwalk.
Definition: fib_node.h:203
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:257
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:184
u32 fnbw_depth
the number of levels the walk has already traversed.
Definition: fib_node.h:216
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:230
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:80
fib_node_bw_flags_t fnbw_flags
additional flags for the walk
Definition: fib_node.h:208
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:60
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:290
An node in the FIB graph.
Definition: fib_node.h:286
format_function_t * fnv_format
Definition: fib_node.h:277
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:154
enum fib_node_bw_flags_t_ fib_node_bw_flags_t
Flags on the walk.
fib_node_list_t fn_children
The node&#39;s VFT.
Definition: fib_node.h:306
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:220
Force the walk to be synchronous.
Definition: fib_node.h:165
fib_node_get_t fnv_get
Definition: fib_node.h:274
fib_node_back_walk_t fnv_back_walk
Definition: fib_node.h:276
u32 fib_node_index_t
A typedef of a node index.
Definition: fib_types.h:29
A resolving interface has been deleted.
Definition: fib_node.h:109
Context passed between object during a back walk.
Definition: fib_node.h:199
unsigned int u32
Definition: types.h:88
long ctx[MAX_CONNS]
Definition: main.c:122
u8 * fib_node_children_format(fib_node_list_t list, u8 *s)
Definition: fib_node.c:176
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:185
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:98
u16 fn_pad
Some pad space the concrete/derived type is free to use.
Definition: fib_node.h:295
void(* fib_node_memory_show_t)(void)
Function definition to display the amount of memory used by a type.
Definition: fib_node.h:268
unsigned short u16
Definition: types.h:57
#define FIB_NODE_INDEX_INVALID
Definition: fib_types.h:30
unsigned char u8
Definition: types.h:56
u32 fn_locks
Number of dependents on this node.
Definition: fib_node.h:312
Walk to re-evaluate the forwarding contributed by the parent.
Definition: fib_node.h:97
A resolving interface has come up.
Definition: fib_node.h:101
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:160
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:383
A FIB graph nodes virtual function table.
Definition: fib_node.h:273
u32 fib_node_list_t
A list of FIB nodes.
Definition: fib_node.h:194
fib_node_back_walk_rc_t_
Return code from a back walk function.
Definition: fib_node.h:242
void fib_node_unlock(fib_node_t *node)
Definition: fib_node.c:209
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:123
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:197
fib_node_memory_show_t fnv_mem_show
Definition: fib_node.h:278