vnet/vnet/fib/fib_entry.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_ENTRY_H__
  17 #define __FIB_ENTRY_H__
  18
  19 #include <vnet/fib/fib_node.h>
  20 #include <vnet/adj/adj.h>
  21 #include <vnet/ip/ip.h>
  22 #include <vnet/dpo/dpo.h>
  23
  24 /**
  25  * The different sources that can create a route.
  26  * The sources are defined here the thier relative priority order.
  27  * The lower the value the higher the priority
  28  */
  29 typedef enum fib_source_t_ {
  30     /**
  31      * Marker. Add new values after this one.
  32      */
  33     FIB_SOURCE_FIRST,
  34     /**
  35      * Special sources. These are for entries that are added to all
  36      * FIBs by default, and should never be over-ridden (hence they
  37      * are the highest priority)
  38      */
  39     FIB_SOURCE_SPECIAL = FIB_SOURCE_FIRST,
  40     /**
  41      * Classify. A route that links directly to a classify adj
  42      */
  43     FIB_SOURCE_CLASSIFY,
  44     /**
  45      * Route added as a result of interface configuration.
  46      * this will also come from the API/CLI, but the distinction is
  47      * that is from confiiguration on an interface, not a 'ip route' command
  48      */
  49     FIB_SOURCE_INTERFACE,
  50     /**
  51      * A high priority source a plugin can use
  52      */
  53     FIB_SOURCE_PLUGIN_HI,
  54     /**
  55      * From the control plane API
  56      */
  57     FIB_SOURCE_API,
  58     /**
  59      * From the CLI.
  60      */
  61     FIB_SOURCE_CLI,
  62     /**
  63      * LISP
  64      */
  65     FIB_SOURCE_LISP,
  66     /**
  67      * SRv6
  68      */
  69     FIB_SOURCE_SR,
  70     /**
  71      * IPv[46] Mapping
  72      */
  73     FIB_SOURCE_MAP,
  74     /**
  75      * SIXRD
  76      */
  77     FIB_SOURCE_SIXRD,
  78     /**
  79      * DHCP
  80      */
  81     FIB_SOURCE_DHCP,
  82     /**
  83      * Adjacency source.
  84      * routes created as a result of ARP/ND entries. This is lower priority
  85      * then the API/CLI. This is on purpose. trust me.
  86      */
  87     FIB_SOURCE_ADJ,
  88     /**
  89      * MPLS label. The prefix has been assigned a local label. This source
  90      * never provides forwarding information, instead it acts as a place-holder
  91      * so the association of label to prefix can be maintained
  92      */
  93     FIB_SOURCE_MPLS,
  94     /**
  95      * Attached Export source.
  96      * routes created as a result of attahced export. routes thus sourced
  97      * will be present in the export tables
  98      */
  99     FIB_SOURCE_AE,
 100     /**
 101      * Recursive resolution source.
 102      * Used to install an entry that is thre resolution traget of another.
 103      */
 104     FIB_SOURCE_RR,
 105     /**
 106      * The default route source.
 107      * The default route is always added to the FIB table (like the
 108      * special sources) but we need to be able to over-ride it with
 109      * 'ip route' sources when provided
 110      */
 111     FIB_SOURCE_DEFAULT_ROUTE,
 112     /**
 113      * Marker. add new entries before this one.
 114      */
 115     FIB_SOURCE_LAST = FIB_SOURCE_DEFAULT_ROUTE,
 116 } __attribute__ ((packed)) fib_source_t;
 117
 118 _Static_assert (sizeof(fib_source_t) == 1,
 119                 "FIB too many sources");
 120
 121 /**
 122  * The maximum number of sources
 123  */
 124 #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1)
 125
 126 #define FIB_SOURCES {                                   \
 127     [FIB_SOURCE_SPECIAL] = "special",                   \
 128     [FIB_SOURCE_INTERFACE] = "interface",               \
 129     [FIB_SOURCE_API] = "API",                           \
 130     [FIB_SOURCE_CLI] = "CLI",                           \
 131     [FIB_SOURCE_ADJ] = "adjacency",                     \
 132     [FIB_SOURCE_MAP] = "MAP",                           \
 133     [FIB_SOURCE_SR] = "SR",                             \
 134     [FIB_SOURCE_SIXRD] = "SixRD",                       \
 135     [FIB_SOURCE_LISP] = "LISP",                         \
 136     [FIB_SOURCE_CLASSIFY] = "classify",                 \
 137     [FIB_SOURCE_DHCP] = "DHCP",                         \
 138     [FIB_SOURCE_RR] = "recursive-resolution",           \
 139     [FIB_SOURCE_AE] = "attached_export",                \
 140     [FIB_SOURCE_MPLS] = "mpls",                         \
 141     [FIB_SOURCE_DEFAULT_ROUTE] = "default-route",       \
 142 }
 143
 144 #define FOR_EACH_FIB_SOURCE(_item) \
 145     for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++)
 146
 147 /**
 148  * The different sources that can create a route.
 149  * The sources are defined here the thier relative priority order.
 150  * The lower the value the higher the priority
 151  */
 152 typedef enum fib_entry_attribute_t_ {
 153     /**
 154      * Marker. Add new values after this one.
 155      */
 156     FIB_ENTRY_ATTRIBUTE_FIRST,
 157     /**
 158      * Connected. The prefix is configured on an interface.
 159      */
 160     FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST,
 161     /**
 162      * Attached. The prefix is attached to an interface.
 163      */
 164     FIB_ENTRY_ATTRIBUTE_ATTACHED,
 165     /**
 166      * The route is an explicit drop.
 167      */
 168     FIB_ENTRY_ATTRIBUTE_DROP,
 169     /**
 170      * The route is exclusive. The client creating the route is
 171      * providing an exclusive adjacency.
 172      */
 173     FIB_ENTRY_ATTRIBUTE_EXCLUSIVE,
 174     /**
 175      * The route is attached cross tables and thus imports covered
 176      * prefixes from the other table.
 177      */
 178     FIB_ENTRY_ATTRIBUTE_IMPORT,
 179     /**
 180      * The prefix/address is local to this device
 181      */
 182     FIB_ENTRY_ATTRIBUTE_LOCAL,
 183     /**
 184      * Marker. add new entries before this one.
 185      */
 186     FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_LOCAL,
 187 } fib_entry_attribute_t;
 188
 189 /**
 190  * The maximum number of sources
 191  */
 192 #define FIB_ENTRY_ATTRIBUTE_MAX (FIB_ENTRY_ATTRIBUTE_LAST+1)
 193
 194 #define FIB_ENTRY_ATTRIBUTES {                          \
 195     [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected",      \
 196     [FIB_ENTRY_ATTRIBUTE_ATTACHED]  = "attached",       \
 197     [FIB_ENTRY_ATTRIBUTE_IMPORT]    = "import",         \
 198     [FIB_ENTRY_ATTRIBUTE_DROP]      = "drop",           \
 199     [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive",      \
 200     [FIB_ENTRY_ATTRIBUTE_LOCAL]     = "local",          \
 201 }
 202
 203 #define FOR_EACH_FIB_ATTRIBUTE(_item)                   \
 204     for (_item = FIB_ENTRY_ATTRIBUTE_FIRST;             \
 205          _item < FIB_ENTRY_ATTRIBUTE_MAX;               \
 206          _item++)
 207
 208 typedef enum fib_entry_flag_t_ {
 209     FIB_ENTRY_FLAG_NONE      = 0,
 210     FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED),
 211     FIB_ENTRY_FLAG_ATTACHED  = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED),
 212     FIB_ENTRY_FLAG_DROP      = (1 << FIB_ENTRY_ATTRIBUTE_DROP),
 213     FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE),
 214     FIB_ENTRY_FLAG_LOCAL     = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL),
 215     FIB_ENTRY_FLAG_IMPORT    = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT),
 216 } fib_entry_flag_t;
 217
 218 /**
 219  * Flags for the source data
 220  */
 221 typedef enum fib_entry_src_attribute_t_ {
 222     /**
 223      * Marker. Add new values after this one.
 224      */
 225     FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
 226     /**
 227      * the source has been added to the entry
 228      */
 229     FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST,
 230     /**
 231      * the source is active/best
 232      */
 233     FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
 234     /**
 235      * Marker. add new entries before this one.
 236      */
 237     FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE,
 238 } fib_entry_src_attribute_t;
 239
 240 #define FIB_ENTRY_SRC_ATTRIBUTE_MAX (FIB_ENTRY_SRC_ATTRIBUTE_LAST+1)
 241
 242 #define FIB_ENTRY_SRC_ATTRIBUTES {               \
 243     [FIB_ENTRY_SRC_ATTRIBUTE_ADDED]  = "added",  \
 244     [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \
 245 }
 246
 247 typedef enum fib_entry_src_flag_t_ {
 248     FIB_ENTRY_SRC_FLAG_NONE   = 0,
 249     FIB_ENTRY_SRC_FLAG_ADDED  = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED),
 250     FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE),
 251 } __attribute__ ((packed)) fib_entry_src_flag_t;
 252
 253 /*
 254  * Keep the size of the flags field to 2 bytes, so it
 255  * can be placed next to the 2 bytes reference count
 256  */
 257 _Static_assert (sizeof(fib_entry_src_flag_t) <= 2,
 258                 "FIB entry flags field size too big");
 259
 260 /**
 261  * Information related to the source of a FIB entry
 262  */
 263 typedef struct fib_entry_src_t_ {
 264     /**
 265      * A vector of path extensions
 266      */
 267     struct fib_path_ext_t_ *fes_path_exts;
 268
 269     /**
 270      * The path-list created by the source
 271      */
 272     fib_node_index_t fes_pl;
 273     /**
 274      * Which source this info block is for
 275      */
 276     fib_source_t fes_src;
 277     /**
 278      * Flags on the source
 279      */
 280     fib_entry_src_flag_t fes_flags;
 281
 282     /**
 283      * 1 bytes ref count. This is not the number of users of the Entry
 284      * (which is itself not large, due to path-list sharing), but the number
 285      * of times a given source has been added. Which is even fewer
 286      */
 287     u8 fes_ref_count;
 288
 289     /**
 290      * Flags the source contributes to the entry
 291      */
 292     fib_entry_flag_t fes_entry_flags;
 293
 294     /**
 295      * Source specific info
 296      */
 297     union {
 298         struct {
 299             /**
 300              * the index of the FIB entry that is the covering entry
 301              */
 302             fib_node_index_t fesr_cover;
 303             /**
 304              * This source's index in the cover's list
 305              */
 306             u32 fesr_sibling;
 307         } rr;
 308         struct {
 309             /**
 310              * the index of the FIB entry that is the covering entry
 311              */
 312             fib_node_index_t fesa_cover;
 313             /**
 314              * This source's index in the cover's list
 315              */
 316             u32 fesa_sibling;
 317         } adj;
 318         struct {
 319             /**
 320              * the index of the FIB entry that is the covering entry
 321              */
 322             fib_node_index_t fesi_cover;
 323             /**
 324              * This source's index in the cover's list
 325              */
 326             u32 fesi_sibling;
 327         } interface;
 328         struct {
 329             /**
 330              * This MPLS local label associated with the prefix.
 331              */
 332             mpls_label_t fesm_label;
 333
 334             /**
 335              * the indicies of the LFIB entries created
 336              */
 337             fib_node_index_t fesm_lfes[2];
 338         } mpls;
 339         struct {
 340             /**
 341              * The source FIB index.
 342              */
 343             fib_node_index_t fesl_fib_index;
 344         } lisp;
 345     };
 346 } fib_entry_src_t;
 347
 348 /**
 349  * An entry in a FIB table.
 350  *
 351  * This entry represents a route added to the FIB that is stored
 352  * in one of the FIB tables.
 353  */
 354 typedef struct fib_entry_t_ {
 355     /**
 356      * Base class. The entry's node representation in the graph.
 357      */
 358     fib_node_t fe_node;
 359     /**
 360      * The prefix of the route
 361      */
 362     fib_prefix_t fe_prefix;
 363     /**
 364      * The index of the FIB table this entry is in
 365      */
 366     u32 fe_fib_index;
 367     /**
 368      * The load-balance used for forwarding.
 369      *
 370      * We don't share the EOS and non-EOS even in case when they could be
 371      * because:
 372      *   - complexity & reliability v. memory
 373      *       determining the conditions where sharing is possible is non-trivial.
 374      *   - separate LBs means we can get the EOS bit right in the MPLS label DPO
 375      *     and so save a few clock cycles in the DP imposition node since we can
 376      *     paint the header straight on without the need to check the packet
 377      *     type to derive the EOS bit value.
 378      */
 379     dpo_id_t fe_lb[FIB_FORW_CHAIN_NUM];
 380     /**
 381      * Vector of source infos.
 382      * Most entries will only have 1 source. So we optimise for memory usage,
 383      * which is preferable since we have many entries.
 384      */
 385     fib_entry_src_t *fe_srcs;
 386     /**
 387      * the path-list for which this entry is a child. This is also the path-list
 388      * that is contributing forwarding for this entry.
 389      */
 390     fib_node_index_t fe_parent;
 391     /**
 392      * index of this entry in the parent's child list.
 393      * This is set when this entry is added as a child, but can also
 394      * be changed by the parent as it manages its list.
 395      */
 396     u32 fe_sibling;
 397     /**
 398      * Dependency list of covered entries.
 399      * these are more specific entries that are interested in changes
 400      * to their respective cover
 401      */
 402     fib_node_list_t fe_covered;
 403     /**
 404      * exporter
 405      */
 406     fib_node_index_t fe_export;
 407     fib_node_index_t fe_import;
 408 } fib_entry_t;
 409
 410 #define FOR_EACH_FIB_ENTRY_FLAG(_item) \
 411     for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++)
 412
 413 #define FIB_ENTRY_FORMAT_BRIEF   (0x0)
 414 #define FIB_ENTRY_FORMAT_DETAIL  (0x1)
 415 #define FIB_ENTRY_FORMAT_DETAIL2 (0x2)
 416
 417 extern u8 *format_fib_entry (u8 * s, va_list * args);
 418
 419 extern fib_node_index_t fib_entry_create_special(u32 fib_index,
 420                                                  const fib_prefix_t *prefix,
 421                                                  fib_source_t source,
 422                                                  fib_entry_flag_t flags,
 423                                                  const dpo_id_t *dpo);
 424
 425 extern fib_node_index_t fib_entry_create (u32 fib_index,
 426                                           const fib_prefix_t *prefix,
 427                                           fib_source_t source,
 428                                           fib_entry_flag_t flags,
 429                                           const fib_route_path_t *paths);
 430 extern void fib_entry_update (fib_node_index_t fib_entry_index,
 431                               fib_source_t source,
 432                               fib_entry_flag_t flags,
 433                               const fib_route_path_t *paths);
 434
 435 extern void fib_entry_path_add(fib_node_index_t fib_entry_index,
 436                                fib_source_t source,
 437                                fib_entry_flag_t flags,
 438                                const fib_route_path_t *rpath);
 439 extern void fib_entry_special_add(fib_node_index_t fib_entry_index,
 440                                   fib_source_t source,
 441                                   fib_entry_flag_t flags,
 442                                   const dpo_id_t *dpo);
 443 extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index,
 444                                                      fib_source_t source);
 445
 446 extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index,
 447                                                   fib_source_t source,
 448                                                   const fib_route_path_t *rpath);
 449 extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index,
 450                                              fib_source_t source);
 451
 452 extern void fib_entry_contribute_forwarding(
 453     fib_node_index_t fib_entry_index,
 454     fib_forward_chain_type_t type,
 455     dpo_id_t *dpo);
 456 extern const dpo_id_t * fib_entry_contribute_ip_forwarding(
 457     fib_node_index_t fib_entry_index);
 458 extern adj_index_t fib_entry_get_adj_for_source(
 459     fib_node_index_t fib_entry_index,
 460     fib_source_t source);
 461 extern const int fib_entry_get_dpo_for_source (
 462     fib_node_index_t fib_entry_index,
 463     fib_source_t source,
 464     dpo_id_t *dpo);
 465
 466 extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index);
 467
 468 extern int fib_entry_cmp_for_sort(void *i1, void *i2);
 469
 470 extern void fib_entry_cover_changed(fib_node_index_t fib_entry);
 471 extern void fib_entry_cover_updated(fib_node_index_t fib_entry);
 472 extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index,
 473                                            fib_node_index_t **entry_indicies);
 474
 475 extern void fib_entry_lock(fib_node_index_t fib_entry_index);
 476 extern void fib_entry_unlock(fib_node_index_t fib_entry_index);
 477
 478 extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index,
 479                                fib_node_type_t type,
 480                                fib_node_index_t child_index);
 481 extern void fib_entry_child_remove(fib_node_index_t fib_entry_index,
 482                                    u32 sibling_index);
 483 extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index);
 484 extern u32 fib_entry_get_resolving_interface_for_source(
 485     fib_node_index_t fib_entry_index,
 486     fib_source_t source);
 487
 488 extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index,
 489                                  fib_prefix_t *pfx);
 490 extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index);
 491 extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index,
 492                                       fib_source_t source,
 493                                       const void *data);
 494 extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index,
 495                                              fib_source_t source);
 496
 497 extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index);
 498 extern fib_entry_flag_t fib_entry_get_flags_for_source(
 499     fib_node_index_t fib_entry_index,
 500     fib_source_t source);
 501 extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index);
 502 extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index,
 503                                 fib_source_t source);
 504
 505 extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index);
 506
 507 extern void fib_entry_module_init(void);
 508
 509 /*
 510  * unsafe... beware the raw pointer.
 511  */
 512 extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry);
 513 extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index);
 514
 515 /*
 516  * for testing purposes.
 517  */
 518 extern u32 fib_entry_pool_size(void);
 519
 520 #endif