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 to update children to inform them the adjacency is now down.
 123      */
 124     FIB_NODE_BW_REASON_ADJ_DOWN,
 125     /**
 126      * Marker. Add new before and update
 127      */
 128     FIB_NODE_BW_REASON_LAST = FIB_NODE_BW_REASON_ADJ_DOWN,
 129 } fib_node_back_walk_reason_t;
 130
 131 #define FIB_NODE_BW_REASONS {                               \
 132     [FIB_NODE_BW_REASON_RESOLVE] = "resolve",               \
 133     [FIB_NODE_BW_REASON_EVALUATE] = "evaluate",             \
 134     [FIB_NODE_BW_REASON_INTERFACE_UP] = "if-up",            \
 135     [FIB_NODE_BW_REASON_INTERFACE_DOWN] = "if-down",        \
 136     [FIB_NODE_BW_REASON_INTERFACE_DELETE] = "if-delete",    \
 137     [FIB_NODE_BW_REASON_ADJ_UPDATE] = "adj-update",         \
 138     [FIB_NODE_BW_REASON_ADJ_DOWN] = "adj-down",             \
 139 }
 140
 141 #define FOR_EACH_FIB_NODE_BW_REASON(_item) \
 142     for (_item = FIB_NODE_BW_REASON_FIRST; \
 143          _item <= FIB_NODE_BW_REASON_LAST; \
 144          _item++)
 145
 146 /**
 147  * Flags enum constructed from the reaons
 148  */
 149 typedef enum fib_node_bw_reason_flag_t_ {
 150     FIB_NODE_BW_REASON_FLAG_NONE = 0,
 151     FIB_NODE_BW_REASON_FLAG_RESOLVE = (1 << FIB_NODE_BW_REASON_RESOLVE),
 152     FIB_NODE_BW_REASON_FLAG_EVALUATE = (1 << FIB_NODE_BW_REASON_EVALUATE),
 153     FIB_NODE_BW_REASON_FLAG_INTERFACE_UP = (1 << FIB_NODE_BW_REASON_INTERFACE_UP),
 154     FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN = (1 << FIB_NODE_BW_REASON_INTERFACE_DOWN),
 155     FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE = (1 << FIB_NODE_BW_REASON_INTERFACE_DELETE),
 156     FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE = (1 << FIB_NODE_BW_REASON_ADJ_UPDATE),
 157     FIB_NODE_BW_REASON_FLAG_ADJ_DOWN = (1 << FIB_NODE_BW_REASON_ADJ_DOWN),
 158 } __attribute__ ((packed)) fib_node_bw_reason_flag_t;
 159
 160 STATIC_ASSERT(sizeof(fib_node_bw_reason_flag_t) < 2,
 161               "BW Reason enum < 2 byte. Consequences for cover_upd_res_t");
 162
 163 extern u8 *format_fib_node_bw_reason(u8 *s, va_list *args);
 164
 165 /**
 166  * Flags on the walk
 167  */
 168 typedef enum fib_node_bw_flags_t_
 169 {
 170     FIB_NODE_BW_FLAG_NONE = 0,
 171     /**
 172      * Force the walk to be synchronous
 173      */
 174     FIB_NODE_BW_FLAG_FORCE_SYNC = (1 << 0),
 175 } fib_node_bw_flags_t;
 176
 177 /**
 178  * Forward declarations
 179  */
 180 struct fib_node_t_;
 181
 182 /**
 183  * A representation of one pointer to another node.
 184  * To fully qualify a node, one must know its type and its index so it
 185  * can be retrieved from the appropriate pool. Direct pointers to nodes
 186  * are forbidden, since all nodes are allocated from pools, which are vectors,
 187  * and thus subject to realloc at any time.
 188  */
 189 typedef struct fib_node_ptr_t_ {
 190     /**
 191      * node type
 192      */
 193     fib_node_type_t fnp_type;
 194     /**
 195      * node's index
 196      */
 197     fib_node_index_t fnp_index;
 198 } fib_node_ptr_t;
 199
 200 /**
 201  * @brief A list of FIB nodes.
 202  */
 203 typedef u32 fib_node_list_t;
 204
 205 /**
 206  * Context passed between object during a back walk.
 207  */
 208 typedef struct fib_node_back_walk_ctx_t_ {
 209     /**
 210      * The reason/trigger for the backwalk
 211      */
 212     fib_node_bw_reason_flag_t fnbw_reason;
 213
 214     /**
 215      * additional flags for the walk
 216      */
 217     fib_node_bw_flags_t fnbw_flags;
 218
 219     /**
 220      * the number of levels the walk has already traversed.
 221      * this value is maintained by the walk infra, tp limit the depth of
 222      * a walk so it does not run indefinately the presence of a loop/cycle
 223      * in the graph.
 224      */
 225     u32 fnbw_depth;
 226 } fib_node_back_walk_ctx_t;
 227
 228 /**
 229  * We consider a depth of 32 to be sufficient to cover all sane
 230  * network topologies. Anything more is then an indication that
 231  * there is a loop/cycle in the FIB graph.
 232  * Note that all object types contribute to 1 to the depth.
 233  */
 234 #define FIB_NODE_GRAPH_MAX_DEPTH ((u32)32)
 235
 236 /**
 237  * A callback function for walking a node dependency list
 238  */
 239 typedef int (*fib_node_ptr_walk_t)(fib_node_ptr_t *depend,
 240                                    void *ctx);
 241
 242 /**
 243  * A list of dependent nodes.
 244  * This is currently implemented as a hash_table of fib_node_ptr_t
 245  */
 246 typedef fib_node_ptr_t fib_node_ptr_list_t;
 247
 248 /**
 249  * Return code from a back walk function
 250  */
 251 typedef enum fib_node_back_walk_rc_t_ {
 252     FIB_NODE_BACK_WALK_MERGE,
 253     FIB_NODE_BACK_WALK_CONTINUE,
 254 } fib_node_back_walk_rc_t;
 255
 256 /**
 257  * Function definition to backwalk a FIB node
 258  */
 259 typedef fib_node_back_walk_rc_t (*fib_node_back_walk_t)(
 260     struct fib_node_t_ *node,
 261     fib_node_back_walk_ctx_t *ctx);
 262
 263 /**
 264  * Function definition to get a FIB node from its index
 265  */
 266 typedef struct fib_node_t_* (*fib_node_get_t)(fib_node_index_t index);
 267
 268 /**
 269  * Function definition to inform the FIB node that its last lock has gone.
 270  */
 271 typedef void (*fib_node_last_lock_gone_t)(struct fib_node_t_ *node);
 272
 273 /**
 274  * Function definition to display the amount of memory used by a type.
 275  * Implementations should call fib_show_memory_usage()
 276  */
 277 typedef void (*fib_node_memory_show_t)(void);
 278
 279 /**
 280  * A FIB graph nodes virtual function table
 281  */
 282 typedef struct fib_node_vft_t_ {
 283     fib_node_get_t fnv_get;
 284     fib_node_last_lock_gone_t fnv_last_lock;
 285     fib_node_back_walk_t fnv_back_walk;
 286     format_function_t *fnv_format;
 287     fib_node_memory_show_t fnv_mem_show;
 288 } fib_node_vft_t;
 289
 290 /**
 291  * An node in the FIB graph
 292  *
 293  * Objects in the FIB form a graph.
 294  */
 295 typedef struct fib_node_t_ {
 296     /**
 297      * The node's type. make sure we are dynamic/down casting correctly
 298      */
 299     fib_node_type_t fn_type;
 300
 301     /**
 302      * Some pad space the concrete/derived type is free to use
 303      */
 304     u16 fn_pad;
 305
 306     /**
 307      * Vector of nodes that depend upon/use/share this node
 308      */
 309     fib_node_list_t fn_children;
 310
 311     /**
 312      * Number of dependents on this node. This number includes the number
 313      * of children
 314      */
 315     u32 fn_locks;
 316 } fib_node_t;
 317
 318 STATIC_ASSERT(sizeof(fib_node_t) == 12, "FIB node type is growing");
 319
 320 /**
 321  * @brief
 322  *  Register the function table for a given type
 323  *
 324  * @param ft
 325  *  FIB node type
 326  *
 327  * @param vft
 328  * virtual function table
 329  */
 330 extern void fib_node_register_type (fib_node_type_t ft,
 331                                     const fib_node_vft_t *vft);
 332
 333 /**
 334  * @brief
 335  *  Create a new FIB node type and Register the function table for it.
 336  *
 337  * @param vft
 338  * virtual function table
 339  *
 340  * @return new FIB node type
 341  */
 342 extern fib_node_type_t fib_node_register_new_type (const fib_node_vft_t *vft);
 343
 344 /**
 345  * @brief Show the memory usage for a type
 346  *
 347  * This should be invoked by the type in response to the infra calling
 348  * its registered memory show function
 349  *
 350  * @param name the name of the type
 351  * @param in_use_elts The number of elements in use
 352  * @param allocd_elts The number of allocated pool elemenets
 353  * @param size_elt The size of one element
 354  */
 355 extern void fib_show_memory_usage(const char *name,
 356                                   u32 in_use_elts,
 357                                   u32 allocd_elts,
 358                                   size_t size_elt);
 359
 360 extern void fib_node_init(fib_node_t *node,
 361                           fib_node_type_t ft);
 362 extern void fib_node_deinit(fib_node_t *node);
 363
 364 extern void fib_node_lock(fib_node_t *node);
 365 extern void fib_node_unlock(fib_node_t *node);
 366
 367 extern u32 fib_node_get_n_children(fib_node_type_t parent_type,
 368                                    fib_node_index_t parent_index);
 369 extern u32 fib_node_child_add(fib_node_type_t parent_type,
 370                               fib_node_index_t parent_index,
 371                               fib_node_type_t child_type,
 372                               fib_node_index_t child_index);
 373 extern void fib_node_child_remove(fib_node_type_t parent_type,
 374                                   fib_node_index_t parent_index,
 375                                   fib_node_index_t sibling_index);
 376
 377 extern fib_node_back_walk_rc_t fib_node_back_walk_one(fib_node_ptr_t *ptr,
 378                                                       fib_node_back_walk_ctx_t *ctx);
 379
 380 extern u8* fib_node_children_format(fib_node_list_t list,
 381                                     u8 *s);
 382
 383 extern const char* fib_node_type_get_name(fib_node_type_t type);
 384
 385 static inline int
 386 fib_node_index_is_valid (fib_node_index_t ni)
 387 {
 388     return (FIB_NODE_INDEX_INVALID != ni);
 389 }
 390
 391 #endif
 392