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