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