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