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