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