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