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