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