src/vnet/fib/fib_node.h

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