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