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