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