src/vnet/fib/fib_entry_src.c

   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 #include <vnet/adj/adj.h>
  17 #include <vnet/dpo/load_balance.h>
  18 #include <vnet/dpo/mpls_label_dpo.h>
  19 #include <vnet/dpo/drop_dpo.h>
  20
  21 #include <vnet/fib/fib_entry_src.h>
  22 #include <vnet/fib/fib_table.h>
  23 #include <vnet/fib/fib_path_ext.h>
  24 #include <vnet/fib/fib_urpf_list.h>
  25
  26 /*
  27  * per-source type vft
  28  */
  29 static fib_entry_src_vft_t fib_entry_src_vft[FIB_SOURCE_MAX];
  30
  31 static fib_protocol_t
  32 fib_entry_get_proto (const fib_entry_t * fib_entry)
  33 {
  34     return (fib_entry->fe_prefix.fp_proto);
  35 }
  36
  37 void
  38 fib_entry_src_register (fib_source_t source,
  39                         const fib_entry_src_vft_t *vft)
  40 {
  41     fib_entry_src_vft[source] = *vft;
  42 }
  43
  44 static int
  45 fib_entry_src_cmp_for_sort (void * v1,
  46                             void * v2)
  47 {
  48     fib_entry_src_t *esrc1 = v1, *esrc2 = v2;
  49
  50     return (esrc1->fes_src - esrc2->fes_src);
  51 }
  52
  53 void
  54 fib_entry_src_action_init (fib_entry_t *fib_entry,
  55                            fib_source_t source)
  56
  57 {
  58     fib_entry_src_t esrc = {
  59         .fes_pl = FIB_NODE_INDEX_INVALID,
  60         .fes_flags = FIB_ENTRY_SRC_FLAG_NONE,
  61         .fes_src = source,
  62     };
  63
  64     if (NULL != fib_entry_src_vft[source].fesv_init)
  65     {
  66         fib_entry_src_vft[source].fesv_init(&esrc);
  67     }
  68
  69     vec_add1(fib_entry->fe_srcs, esrc);
  70     vec_sort_with_function(fib_entry->fe_srcs,
  71                            fib_entry_src_cmp_for_sort);
  72 }
  73
  74 static fib_entry_src_t *
  75 fib_entry_src_find (const fib_entry_t *fib_entry,
  76                     fib_source_t source,
  77                     u32 *index)
  78
  79 {
  80     fib_entry_src_t *esrc;
  81     int ii;
  82
  83     ii = 0;
  84     vec_foreach(esrc, fib_entry->fe_srcs)
  85     {
  86         if (esrc->fes_src == source)
  87         {
  88             if (NULL != index)
  89             {
  90                 *index = ii;
  91             }
  92             return (esrc);
  93         }
  94         else
  95         {
  96             ii++;
  97         }
  98     }
  99
 100     return (NULL);
 101 }
 102
 103 int
 104 fib_entry_is_sourced (fib_node_index_t fib_entry_index,
 105                       fib_source_t source)
 106 {
 107     fib_entry_t *fib_entry;
 108
 109     fib_entry = fib_entry_get(fib_entry_index);
 110
 111     return (NULL != fib_entry_src_find(fib_entry, source, NULL));
 112 }
 113
 114 static fib_entry_src_t *
 115 fib_entry_src_find_or_create (fib_entry_t *fib_entry,
 116                               fib_source_t source,
 117                               u32 *index)
 118 {
 119     fib_entry_src_t *esrc;
 120
 121     esrc = fib_entry_src_find(fib_entry, source, NULL);
 122
 123     if (NULL == esrc)
 124     {
 125         fib_entry_src_action_init(fib_entry, source);
 126     }
 127
 128     return (fib_entry_src_find(fib_entry, source, NULL));
 129 }
 130
 131 void
 132 fib_entry_src_action_deinit (fib_entry_t *fib_entry,
 133                              fib_source_t source)
 134
 135 {
 136     fib_entry_src_t *esrc;
 137     u32 index = ~0;
 138
 139     esrc = fib_entry_src_find(fib_entry, source, &index);
 140
 141     ASSERT(NULL != esrc);
 142
 143     if (NULL != fib_entry_src_vft[source].fesv_deinit)
 144     {
 145         fib_entry_src_vft[source].fesv_deinit(esrc);
 146     }
 147
 148     vec_free(esrc->fes_path_exts);
 149     vec_del1(fib_entry->fe_srcs, index);
 150 }
 151
 152 fib_entry_src_cover_res_t
 153 fib_entry_src_action_cover_change (fib_entry_t *fib_entry,
 154                                    fib_source_t source)
 155 {
 156     if (NULL != fib_entry_src_vft[source].fesv_cover_change)
 157     {
 158         return (fib_entry_src_vft[source].fesv_cover_change(
 159                     fib_entry_src_find(fib_entry, source, NULL),
 160                     fib_entry));
 161     }
 162
 163     fib_entry_src_cover_res_t res = {
 164         .install = !0,
 165         .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
 166     };
 167     return (res);
 168 }
 169
 170 fib_entry_src_cover_res_t
 171 fib_entry_src_action_cover_update (fib_entry_t *fib_entry,
 172                                    fib_source_t source)
 173 {
 174     if (NULL != fib_entry_src_vft[source].fesv_cover_update)
 175     {
 176         return (fib_entry_src_vft[source].fesv_cover_update(
 177                     fib_entry_src_find(fib_entry, source, NULL),
 178                     fib_entry));
 179     }
 180
 181     fib_entry_src_cover_res_t res = {
 182         .install = !0,
 183         .bw_reason = FIB_NODE_BW_REASON_FLAG_NONE,
 184     };
 185     return (res);
 186 }
 187
 188 typedef struct fib_entry_src_collect_forwarding_ctx_t_
 189 {
 190     load_balance_path_t * next_hops;
 191     const fib_entry_t *fib_entry;
 192     const fib_entry_src_t *esrc;
 193     fib_forward_chain_type_t fct;
 194     int is_recursive;
 195 } fib_entry_src_collect_forwarding_ctx_t;
 196
 197 /**
 198  * @brief Determine whether this FIB entry should use a load-balance MAP
 199  * to support PIC edge fast convergence
 200  */
 201 load_balance_flags_t
 202 fib_entry_calc_lb_flags (fib_entry_src_collect_forwarding_ctx_t *ctx)
 203 {
 204     /**
 205      * We'll use a LB map is the path-list has recursive paths.
 206      * recursive paths implies BGP, and hence scale.
 207      */
 208     if (ctx->is_recursive)
 209     {
 210         return (LOAD_BALANCE_FLAG_USES_MAP);
 211     }
 212     return (LOAD_BALANCE_FLAG_NONE);
 213 }
 214
 215 static int
 216 fib_entry_src_valid_out_label (mpls_label_t label)
 217 {
 218     return ((MPLS_LABEL_IS_REAL(label) ||
 219              MPLS_IETF_IPV4_EXPLICIT_NULL_LABEL == label ||
 220              MPLS_IETF_IPV6_EXPLICIT_NULL_LABEL == label ||
 221              MPLS_IETF_IMPLICIT_NULL_LABEL == label));
 222 }
 223
 224 /**
 225  * @brief Turn the chain type requested by the client into the one they
 226  * really wanted
 227  */
 228 fib_forward_chain_type_t
 229 fib_entry_chain_type_fixup (const fib_entry_t *entry,
 230                             fib_forward_chain_type_t fct)
 231 {
 232     ASSERT(FIB_FORW_CHAIN_TYPE_MPLS_EOS == fct);
 233
 234     /*
 235      * The EOS chain is a tricky since one cannot know the adjacency
 236      * to link to without knowing what the packets payload protocol
 237      * will be once the label is popped.
 238      */
 239     fib_forward_chain_type_t dfct;
 240
 241     dfct = fib_entry_get_default_chain_type(entry);
 242
 243     if (FIB_FORW_CHAIN_TYPE_MPLS_EOS == dfct)
 244     {
 245         /*
 246          * If the entry being asked is a eos-MPLS label entry,
 247          * then use the payload-protocol field, that we stashed there
 248          * for just this purpose
 249          */
 250         return (fib_forw_chain_type_from_dpo_proto(
 251                     entry->fe_prefix.fp_payload_proto));
 252     }
 253     /*
 254      * else give them what this entry would be by default. i.e. if it's a v6
 255      * entry, then the label its local labelled should be carrying v6 traffic.
 256      * If it's a non-EOS label entry, then there are more labels and we want
 257      * a non-eos chain.
 258      */
 259     return (dfct);
 260 }
 261
 262 static int
 263 fib_entry_src_collect_forwarding (fib_node_index_t pl_index,
 264                                   fib_node_index_t path_index,
 265                                   void *arg)
 266 {
 267     fib_entry_src_collect_forwarding_ctx_t *ctx;
 268     fib_path_ext_t *path_ext;
 269     int have_path_ext;
 270
 271     ctx = arg;
 272
 273     /*
 274      * if the path is not resolved, don't include it.
 275      */
 276     if (!fib_path_is_resolved(path_index))
 277     {
 278         return (!0);
 279     }
 280
 281     if (fib_path_is_recursive(path_index))
 282     {
 283         ctx->is_recursive = 1;
 284     }
 285
 286     /*
 287      * get the matching path-extension for the path being visited.
 288      */
 289     have_path_ext = 0;
 290     vec_foreach(path_ext, ctx->esrc->fes_path_exts)
 291     {
 292         if (path_ext->fpe_path_index == path_index)
 293         {
 294             have_path_ext = 1;
 295             break;
 296         }
 297     }
 298
 299     if (have_path_ext &&
 300         fib_entry_src_valid_out_label(path_ext->fpe_label_stack[0]))
 301     {
 302         /*
 303          * found a matching extension. stack it to obtain the forwarding
 304          * info for this path.
 305          */
 306         ctx->next_hops = fib_path_ext_stack(path_ext, ctx->fib_entry, ctx->fct, ctx->next_hops);
 307     }
 308     else
 309     {
 310         load_balance_path_t *nh;
 311
 312         /*
 313          * no extension => no out-going label for this path. that's OK
 314          * in the case of an IP or EOS chain, but not for non-EOS
 315          */
 316         switch (ctx->fct)
 317         {
 318         case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
 319         case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
 320         case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
 321         case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
 322             /*
 323              * EOS traffic with no label to stack, we need the IP Adj
 324              */
 325             vec_add2(ctx->next_hops, nh, 1);
 326
 327             nh->path_index = path_index;
 328             nh->path_weight = fib_path_get_weight(path_index);
 329             fib_path_contribute_forwarding(path_index, ctx->fct, &nh->path_dpo);
 330
 331             break;
 332         case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
 333             if (fib_path_is_exclusive(path_index) ||
 334                 fib_path_is_deag(path_index))
 335             {
 336                 vec_add2(ctx->next_hops, nh, 1);
 337
 338                 nh->path_index = path_index;
 339                 nh->path_weight = fib_path_get_weight(path_index);
 340                 fib_path_contribute_forwarding(path_index,
 341                                                FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
 342                                                &nh->path_dpo);
 343             }
 344             break;
 345         case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
 346         {
 347             /*
 348              * no label. we need a chain based on the payload. fixup.
 349              */
 350             vec_add2(ctx->next_hops, nh, 1);
 351
 352             nh->path_index = path_index;
 353             nh->path_weight = fib_path_get_weight(path_index);
 354             fib_path_contribute_forwarding(path_index,
 355                                            fib_entry_chain_type_fixup(ctx->fib_entry,
 356                                                                       ctx->fct),
 357                                            &nh->path_dpo);
 358
 359             break;
 360         }
 361         case FIB_FORW_CHAIN_TYPE_ETHERNET:
 362         case FIB_FORW_CHAIN_TYPE_NSH:
 363             ASSERT(0);
 364             break;
 365         }
 366     }
 367
 368     return (!0);
 369 }
 370
 371 void
 372 fib_entry_src_mk_lb (fib_entry_t *fib_entry,
 373                      const fib_entry_src_t *esrc,
 374                      fib_forward_chain_type_t fct,
 375                      dpo_id_t *dpo_lb)
 376 {
 377     dpo_proto_t lb_proto;
 378
 379     /*
 380      * If the entry has path extensions then we construct a load-balance
 381      * by stacking the extensions on the forwarding chains of the paths.
 382      * Otherwise we use the load-balance of the path-list
 383      */
 384     fib_entry_src_collect_forwarding_ctx_t ctx = {
 385         .esrc = esrc,
 386         .fib_entry = fib_entry,
 387         .next_hops = NULL,
 388         .is_recursive = 0,
 389         .fct = fct,
 390     };
 391
 392     /*
 393      * As an optimisation we allocate the vector of next-hops to be sized
 394      * equal to the maximum nuber of paths we will need, which is also the
 395      * most likely number we will need, since in most cases the paths are 'up'.
 396      */
 397     vec_validate(ctx.next_hops, fib_path_list_get_n_paths(esrc->fes_pl));
 398     vec_reset_length(ctx.next_hops);
 399
 400     lb_proto = fib_proto_to_dpo(fib_entry->fe_prefix.fp_proto);
 401
 402     fib_path_list_walk(esrc->fes_pl,
 403                        fib_entry_src_collect_forwarding,
 404                        &ctx);
 405
 406     if (esrc->fes_entry_flags & FIB_ENTRY_FLAG_EXCLUSIVE)
 407     {
 408         /*
 409          * the client provided the DPO that the entry should link to.
 410          * all entries must link to a LB, so if it is an LB already
 411          * then we can use it.
 412          */
 413         if ((1 == vec_len(ctx.next_hops)) &&
 414             (DPO_LOAD_BALANCE == ctx.next_hops[0].path_dpo.dpoi_type))
 415         {
 416             dpo_copy(dpo_lb, &ctx.next_hops[0].path_dpo);
 417             dpo_reset(&ctx.next_hops[0].path_dpo);
 418             return;
 419         }
 420     }
 421
 422     if (!dpo_id_is_valid(dpo_lb))
 423     {
 424         /*
 425          * first time create
 426          */
 427         flow_hash_config_t fhc;
 428
 429         fhc = fib_table_get_flow_hash_config(fib_entry->fe_fib_index,
 430                                              dpo_proto_to_fib(lb_proto));
 431         dpo_set(dpo_lb,
 432                 DPO_LOAD_BALANCE,
 433                 lb_proto,
 434                 load_balance_create(0, lb_proto, fhc));
 435     }
 436
 437     load_balance_multipath_update(dpo_lb,
 438                                   ctx.next_hops,
 439                                   fib_entry_calc_lb_flags(&ctx));
 440     vec_free(ctx.next_hops);
 441
 442     /*
 443      * if this entry is sourced by the uRPF-exempt source then we
 444      * append the always present local0 interface (index 0) to the
 445      * uRPF list so it is not empty. that way packets pass the loose check.
 446      */
 447     index_t ui = fib_path_list_get_urpf(esrc->fes_pl);
 448
 449     if ((fib_entry_is_sourced(fib_entry_get_index(fib_entry),
 450                               FIB_SOURCE_URPF_EXEMPT) ||
 451          (esrc->fes_entry_flags & FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT))&&
 452         (0 == fib_urpf_check_size(ui)))
 453     {
 454         /*
 455          * The uRPF list we get from the path-list is shared by all
 456          * other users of the list, but the uRPF exemption applies
 457          * only to this prefix. So we need our own list.
 458          */
 459         ui = fib_urpf_list_alloc_and_lock();
 460         fib_urpf_list_append(ui, 0);
 461         fib_urpf_list_bake(ui);
 462         load_balance_set_urpf(dpo_lb->dpoi_index, ui);
 463         fib_urpf_list_unlock(ui);
 464     }
 465     else
 466     {
 467         load_balance_set_urpf(dpo_lb->dpoi_index, ui);
 468     }
 469     load_balance_set_fib_entry_flags(dpo_lb->dpoi_index,
 470                                      fib_entry_get_flags_i(fib_entry));
 471 }
 472
 473 void
 474 fib_entry_src_action_install (fib_entry_t *fib_entry,
 475                               fib_source_t source)
 476 {
 477     /*
 478      * Install the forwarding chain for the given source into the forwarding
 479      * tables
 480      */
 481     fib_forward_chain_type_t fct;
 482     fib_entry_src_t *esrc;
 483     int insert;
 484
 485     fct = fib_entry_get_default_chain_type(fib_entry);
 486     esrc = fib_entry_src_find(fib_entry, source, NULL);
 487
 488     /*
 489      * Every entry has its own load-balance object. All changes to the entry's
 490      * forwarding result in an inplace modify of the load-balance. This means
 491      * the load-balance object only needs to be added to the forwarding
 492      * DB once, when it is created.
 493      */
 494     insert = !dpo_id_is_valid(&fib_entry->fe_lb);
 495
 496     fib_entry_src_mk_lb(fib_entry, esrc, fct, &fib_entry->fe_lb);
 497
 498     ASSERT(dpo_id_is_valid(&fib_entry->fe_lb));
 499     FIB_ENTRY_DBG(fib_entry, "install: %d", fib_entry->fe_lb);
 500
 501     /*
 502      * insert the adj into the data-plane forwarding trie
 503      */
 504     if (insert)
 505     {
 506        fib_table_fwding_dpo_update(fib_entry->fe_fib_index,
 507                                    &fib_entry->fe_prefix,
 508                                    &fib_entry->fe_lb);
 509     }
 510
 511     /*
 512      * if any of the other chain types are already created they will need
 513      * updating too
 514      */
 515     fib_entry_delegate_type_t fdt;
 516     fib_entry_delegate_t *fed;
 517
 518     FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
 519     {
 520         fib_entry_src_mk_lb(fib_entry, esrc,
 521                             fib_entry_delegate_type_to_chain_type(fdt),
 522                             &fed->fd_dpo);
 523     });
 524 }
 525
 526 void
 527 fib_entry_src_action_uninstall (fib_entry_t *fib_entry)
 528 {
 529     /*
 530      * uninstall the forwarding chain from the forwarding tables
 531      */
 532     FIB_ENTRY_DBG(fib_entry, "uninstall: %d",
 533                   fib_entry->fe_adj_index);
 534
 535     if (dpo_id_is_valid(&fib_entry->fe_lb))
 536     {
 537         fib_table_fwding_dpo_remove(
 538             fib_entry->fe_fib_index,
 539             &fib_entry->fe_prefix,
 540             &fib_entry->fe_lb);
 541
 542         dpo_reset(&fib_entry->fe_lb);
 543     }
 544 }
 545
 546 static void
 547 fib_entry_recursive_loop_detect_i (fib_node_index_t path_list_index)
 548 {
 549     fib_node_index_t *entries = NULL;
 550
 551     fib_path_list_recursive_loop_detect(path_list_index, &entries);
 552
 553     vec_free(entries);
 554 }
 555
 556 void
 557 fib_entry_src_action_activate (fib_entry_t *fib_entry,
 558                                fib_source_t source)
 559
 560 {
 561     int houston_we_are_go_for_install;
 562     fib_entry_src_t *esrc;
 563
 564     esrc = fib_entry_src_find(fib_entry, source, NULL);
 565
 566     ASSERT(!(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE));
 567     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED);
 568
 569     esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ACTIVE;
 570
 571     if (NULL != fib_entry_src_vft[source].fesv_activate)
 572     {
 573         houston_we_are_go_for_install =
 574             fib_entry_src_vft[source].fesv_activate(esrc, fib_entry);
 575     }
 576     else
 577     {
 578         /*
 579          * the source is not providing an activate function, we'll assume
 580          * therefore it has no objection to installing the entry
 581          */
 582         houston_we_are_go_for_install = !0;
 583     }
 584
 585     /*
 586      * link to the path-list provided by the source, and go check
 587      * if that forms any loops in the graph.
 588      */
 589     fib_entry->fe_parent = esrc->fes_pl;
 590     fib_entry->fe_sibling =
 591         fib_path_list_child_add(fib_entry->fe_parent,
 592                                 FIB_NODE_TYPE_ENTRY,
 593                                 fib_entry_get_index(fib_entry));
 594
 595     fib_entry_recursive_loop_detect_i(fib_entry->fe_parent);
 596
 597     FIB_ENTRY_DBG(fib_entry, "activate: %d",
 598                   fib_entry->fe_parent);
 599
 600     if (0 != houston_we_are_go_for_install)
 601     {
 602         fib_entry_src_action_install(fib_entry, source);
 603     }
 604     else
 605     {
 606         fib_entry_src_action_uninstall(fib_entry);
 607     }
 608 }
 609
 610 void
 611 fib_entry_src_action_deactivate (fib_entry_t *fib_entry,
 612                                  fib_source_t source)
 613
 614 {
 615     fib_node_index_t path_list_index;
 616     fib_entry_src_t *esrc;
 617
 618     esrc = fib_entry_src_find(fib_entry, source, NULL);
 619
 620     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE);
 621
 622     if (NULL != fib_entry_src_vft[source].fesv_deactivate)
 623     {
 624         fib_entry_src_vft[source].fesv_deactivate(esrc, fib_entry);
 625     }
 626
 627     esrc->fes_flags &= ~FIB_ENTRY_SRC_FLAG_ACTIVE;
 628
 629     FIB_ENTRY_DBG(fib_entry, "deactivate: %d", fib_entry->fe_parent);
 630
 631     /*
 632      * un-link from an old path-list. Check for any loops this will clear
 633      */
 634     path_list_index = fib_entry->fe_parent;
 635     fib_entry->fe_parent = FIB_NODE_INDEX_INVALID;
 636
 637     fib_entry_recursive_loop_detect_i(path_list_index);
 638
 639     /*
 640      * this will unlock the path-list, so it may be invalid thereafter.
 641      */
 642     fib_path_list_child_remove(path_list_index, fib_entry->fe_sibling);
 643     fib_entry->fe_sibling = FIB_NODE_INDEX_INVALID;
 644 }
 645
 646 static void
 647 fib_entry_src_action_fwd_update (const fib_entry_t *fib_entry,
 648                                  fib_source_t source)
 649 {
 650     fib_entry_src_t *esrc;
 651
 652     vec_foreach(esrc, fib_entry->fe_srcs)
 653     {
 654         if (NULL != fib_entry_src_vft[esrc->fes_src].fesv_fwd_update)
 655         {
 656             fib_entry_src_vft[esrc->fes_src].fesv_fwd_update(esrc,
 657                                                              fib_entry,
 658                                                              source);
 659         }
 660     }
 661 }
 662
 663 void
 664 fib_entry_src_action_reactivate (fib_entry_t *fib_entry,
 665                                  fib_source_t source)
 666 {
 667     fib_node_index_t path_list_index;
 668     fib_entry_src_t *esrc;
 669
 670     esrc = fib_entry_src_find(fib_entry, source, NULL);
 671
 672     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE);
 673
 674     FIB_ENTRY_DBG(fib_entry, "reactivate: %d to %d",
 675                   fib_entry->fe_parent,
 676                   esrc->fes_pl);
 677
 678     if (fib_entry->fe_parent != esrc->fes_pl)
 679     {
 680         /*
 681          * un-link from an old path-list. Check for any loops this will clear
 682          */
 683         path_list_index = fib_entry->fe_parent;
 684         fib_entry->fe_parent = FIB_NODE_INDEX_INVALID;
 685
 686         /*
 687          * temporary lock so it doesn't get deleted when this entry is no
 688          * longer a child.
 689          */
 690         fib_path_list_lock(path_list_index);
 691
 692         /*
 693          * this entry is no longer a child. after unlinking check if any loops
 694          * were broken
 695          */
 696         fib_path_list_child_remove(path_list_index,
 697                                    fib_entry->fe_sibling);
 698
 699         fib_entry_recursive_loop_detect_i(path_list_index);
 700
 701         /*
 702          * link to the path-list provided by the source, and go check
 703          * if that forms any loops in the graph.
 704          */
 705         fib_entry->fe_parent = esrc->fes_pl;
 706         fib_entry->fe_sibling =
 707             fib_path_list_child_add(fib_entry->fe_parent,
 708                                     FIB_NODE_TYPE_ENTRY,
 709                                     fib_entry_get_index(fib_entry));
 710
 711         fib_entry_recursive_loop_detect_i(fib_entry->fe_parent);
 712         fib_path_list_unlock(path_list_index);
 713     }
 714     fib_entry_src_action_install(fib_entry, source);
 715     fib_entry_src_action_fwd_update(fib_entry, source);
 716 }
 717
 718 void
 719 fib_entry_src_action_installed (const fib_entry_t *fib_entry,
 720                                 fib_source_t source)
 721 {
 722     fib_entry_src_t *esrc;
 723
 724     esrc = fib_entry_src_find(fib_entry, source, NULL);
 725
 726     if (NULL != fib_entry_src_vft[source].fesv_installed)
 727     {
 728         fib_entry_src_vft[source].fesv_installed(esrc,
 729                                                  fib_entry);
 730     }
 731
 732     fib_entry_src_action_fwd_update(fib_entry, source);
 733 }
 734
 735 /*
 736  * fib_entry_src_action_add
 737  *
 738  * Adding a source can result in a new fib_entry being created, which
 739  * can inturn mean the pool is realloc'd and thus the entry passed as
 740  * an argument it also realloc'd
 741  * @return the original entry
 742  */
 743 fib_entry_t *
 744 fib_entry_src_action_add (fib_entry_t *fib_entry,
 745                           fib_source_t source,
 746                           fib_entry_flag_t flags,
 747                           const dpo_id_t *dpo)
 748 {
 749     fib_node_index_t fib_entry_index;
 750     fib_entry_src_t *esrc;
 751
 752     esrc = fib_entry_src_find_or_create(fib_entry, source, NULL);
 753
 754     esrc->fes_ref_count++;
 755
 756     if (1 != esrc->fes_ref_count)
 757     {
 758         /*
 759          * we only want to add the source on the 0->1 transition
 760          */
 761         return (fib_entry);
 762     }
 763
 764     esrc->fes_entry_flags = flags;
 765
 766     /*
 767      * save variable so we can recover from a fib_entry realloc.
 768      */
 769     fib_entry_index = fib_entry_get_index(fib_entry);
 770
 771     if (NULL != fib_entry_src_vft[source].fesv_add)
 772     {
 773         fib_entry_src_vft[source].fesv_add(esrc,
 774                                            fib_entry,
 775                                            flags,
 776                                            fib_entry_get_proto(fib_entry),
 777                                            dpo);
 778     }
 779
 780     fib_entry = fib_entry_get(fib_entry_index);
 781
 782     esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ADDED;
 783
 784     fib_path_list_lock(esrc->fes_pl);
 785
 786     /*
 787      * the source owns a lock on the entry
 788      */
 789     fib_entry_lock(fib_entry_get_index(fib_entry));
 790
 791     return (fib_entry);
 792 }
 793
 794 /*
 795  * fib_entry_src_action_update
 796  *
 797  * Adding a source can result in a new fib_entry being created, which
 798  * can inturn mean the pool is realloc'd and thus the entry passed as
 799  * an argument it also realloc'd
 800  * @return the original entry
 801  */
 802 fib_entry_t *
 803 fib_entry_src_action_update (fib_entry_t *fib_entry,
 804                              fib_source_t source,
 805                              fib_entry_flag_t flags,
 806                              const dpo_id_t *dpo)
 807 {
 808     fib_node_index_t fib_entry_index, old_path_list_index;
 809     fib_entry_src_t *esrc;
 810
 811     esrc = fib_entry_src_find_or_create(fib_entry, source, NULL);
 812
 813     if (NULL == esrc)
 814         return (fib_entry_src_action_add(fib_entry, source, flags, dpo));
 815
 816     old_path_list_index = esrc->fes_pl;
 817     esrc->fes_entry_flags = flags;
 818
 819     /*
 820      * save variable so we can recover from a fib_entry realloc.
 821      */
 822     fib_entry_index = fib_entry_get_index(fib_entry);
 823
 824     if (NULL != fib_entry_src_vft[source].fesv_add)
 825     {
 826         fib_entry_src_vft[source].fesv_add(esrc,
 827                                            fib_entry,
 828                                            flags,
 829                                            fib_entry_get_proto(fib_entry),
 830                                            dpo);
 831     }
 832
 833     fib_entry = fib_entry_get(fib_entry_index);
 834
 835     esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ADDED;
 836
 837     fib_path_list_lock(esrc->fes_pl);
 838     fib_path_list_unlock(old_path_list_index);
 839
 840     return (fib_entry);
 841 }
 842
 843
 844 fib_entry_src_flag_t
 845 fib_entry_src_action_remove (fib_entry_t *fib_entry,
 846                              fib_source_t source)
 847
 848 {
 849     fib_node_index_t old_path_list;
 850     fib_entry_src_flag_t sflags;
 851     fib_entry_src_t *esrc;
 852
 853     esrc = fib_entry_src_find(fib_entry, source, NULL);
 854
 855     if (NULL == esrc)
 856         return (FIB_ENTRY_SRC_FLAG_ACTIVE);
 857
 858     esrc->fes_ref_count--;
 859     sflags = esrc->fes_flags;
 860
 861     if (0 != esrc->fes_ref_count)
 862     {
 863         /*
 864          * only remove the source on the 1->0 transisition
 865          */
 866         return (sflags);
 867     }
 868
 869     if (esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE)
 870     {
 871         fib_entry_src_action_deactivate(fib_entry, source);
 872     }
 873
 874     old_path_list = esrc->fes_pl;
 875
 876     if (NULL != fib_entry_src_vft[source].fesv_remove)
 877     {
 878         fib_entry_src_vft[source].fesv_remove(esrc);
 879     }
 880
 881     fib_path_list_unlock(old_path_list);
 882     fib_entry_unlock(fib_entry_get_index(fib_entry));
 883
 884     sflags &= ~FIB_ENTRY_SRC_FLAG_ADDED;
 885     fib_entry_src_action_deinit(fib_entry, source);
 886
 887     return (sflags);
 888 }
 889
 890 static inline int
 891 fib_route_recurses_via_self (const fib_prefix_t *prefix,
 892                              const fib_route_path_t *rpath)
 893 {
 894     /*
 895      * not all zeros next hop &&
 896      * is recursive path &&
 897      * nexthop is same as the route's address
 898      */
 899     return ((!ip46_address_is_zero(&rpath->frp_addr)) &&
 900             (~0 == rpath->frp_sw_if_index) &&
 901             (0 == ip46_address_cmp(&rpath->frp_addr, &prefix->fp_addr)));
 902
 903 }
 904
 905 /*
 906  * fib_route_attached_cross_table
 907  *
 908  * Return true the the route is attached via an interface that
 909  * is not in the same table as the route
 910  */
 911 static inline int
 912 fib_route_attached_cross_table (const fib_entry_t *fib_entry,
 913                                 const fib_route_path_t *rpath)
 914 {
 915     /*
 916      * - All zeros next-hop
 917      * - a valid interface
 918      * - entry's fib index not equeal to interface's index
 919      */
 920     if (ip46_address_is_zero(&rpath->frp_addr) &&
 921         (~0 != rpath->frp_sw_if_index) &&
 922         (fib_entry->fe_fib_index !=
 923          fib_table_get_index_for_sw_if_index(fib_entry_get_proto(fib_entry),
 924                                              rpath->frp_sw_if_index)))
 925     {
 926         return (!0);
 927     }
 928     return (0);
 929 }
 930
 931 /*
 932  * fib_route_attached_cross_table
 933  *
 934  * Return true the the route is attached via an interface that
 935  * is not in the same table as the route
 936  */
 937 static inline int
 938 fib_path_is_attached (const fib_route_path_t *rpath)
 939 {
 940     /*
 941      * - All zeros next-hop
 942      * - a valid interface
 943      */
 944     if (ip46_address_is_zero(&rpath->frp_addr) &&
 945         (~0 != rpath->frp_sw_if_index))
 946     {
 947         return (!0);
 948     }
 949     return (0);
 950 }
 951
 952 fib_path_list_flags_t
 953 fib_entry_src_flags_2_path_list_flags (fib_entry_flag_t eflags)
 954 {
 955     fib_path_list_flags_t plf = FIB_PATH_LIST_FLAG_NONE;
 956
 957     if (eflags & FIB_ENTRY_FLAG_DROP)
 958     {
 959         plf |= FIB_PATH_LIST_FLAG_DROP;
 960     }
 961     if (eflags & FIB_ENTRY_FLAG_LOCAL)
 962     {
 963         plf |= FIB_PATH_LIST_FLAG_LOCAL;
 964     }
 965     if (eflags & FIB_ENTRY_FLAG_EXCLUSIVE)
 966     {
 967         plf |= FIB_PATH_LIST_FLAG_EXCLUSIVE;
 968     }
 969
 970     return (plf);
 971 }
 972
 973 static void
 974 fib_entry_flags_update (const fib_entry_t *fib_entry,
 975                         const fib_route_path_t *rpath,
 976                         fib_path_list_flags_t *pl_flags,
 977                         fib_entry_src_t *esrc)
 978 {
 979     /*
 980      * don't allow the addition of a recursive looped path for prefix
 981      * via itself.
 982      */
 983     if (fib_route_recurses_via_self(&fib_entry->fe_prefix, rpath))
 984     {
 985         /*
 986          * force the install of a drop path-list.
 987          * we want the entry to have some path-list, mainly so
 988          * the dodgy path can be rmeoved when the source stops playing
 989          * silly buggers.
 990          */
 991         *pl_flags |= FIB_PATH_LIST_FLAG_DROP;
 992     }
 993     else
 994     {
 995         *pl_flags &= ~FIB_PATH_LIST_FLAG_DROP;
 996     }
 997
 998     if ((esrc->fes_src == FIB_SOURCE_API) ||
 999         (esrc->fes_src == FIB_SOURCE_CLI))
1000     {
1001         if (fib_path_is_attached(rpath))
1002         {
1003             esrc->fes_entry_flags |= FIB_ENTRY_FLAG_ATTACHED;
1004         }
1005         else
1006         {
1007             esrc->fes_entry_flags &= ~FIB_ENTRY_FLAG_ATTACHED;
1008         }
1009     }
1010     if (fib_route_attached_cross_table(fib_entry, rpath))
1011     {
1012         esrc->fes_entry_flags |= FIB_ENTRY_FLAG_IMPORT;
1013     }
1014     else
1015     {
1016         esrc->fes_entry_flags &= ~FIB_ENTRY_FLAG_IMPORT;
1017     }
1018 }
1019
1020 /*
1021  * fib_entry_src_path_ext_add
1022  *
1023  * append a path extension to the entry's list
1024  */
1025 static void
1026 fib_entry_src_path_ext_append (fib_entry_src_t *esrc,
1027                                const fib_route_path_t *rpath)
1028 {
1029     if (NULL != rpath->frp_label_stack)
1030     {
1031         fib_path_ext_t *path_ext;
1032
1033         vec_add2(esrc->fes_path_exts, path_ext, 1);
1034
1035         fib_path_ext_init(path_ext, esrc->fes_pl, rpath);
1036     }
1037 }
1038
1039 /*
1040  * fib_entry_src_path_ext_insert
1041  *
1042  * insert, sorted, a path extension to the entry's list.
1043  * It's not strictly necessary in sort the path extensions, since each
1044  * extension has the path index to which it resolves. However, by being
1045  * sorted the load-balance produced has a deterministic order, not an order
1046  * based on the sequence of extension additions. this is a considerable benefit.
1047  */
1048 static void
1049 fib_entry_src_path_ext_insert (fib_entry_src_t *esrc,
1050                                const fib_route_path_t *rpath)
1051 {
1052     if (0 == vec_len(esrc->fes_path_exts))
1053         return (fib_entry_src_path_ext_append(esrc, rpath));
1054
1055     if (NULL != rpath->frp_label_stack)
1056     {
1057         fib_path_ext_t path_ext;
1058         int i = 0;
1059
1060         fib_path_ext_init(&path_ext, esrc->fes_pl, rpath);
1061
1062         while (i < vec_len(esrc->fes_path_exts) &&
1063                (fib_path_ext_cmp(&esrc->fes_path_exts[i], rpath) < 0))
1064         {
1065             i++;
1066         }
1067
1068         vec_insert_elts(esrc->fes_path_exts, &path_ext, 1, i);
1069     }
1070 }
1071
1072 /*
1073  * fib_entry_src_action_add
1074  *
1075  * Adding a source can result in a new fib_entry being created, which
1076  * can inturn mean the pool is realloc'd and thus the entry passed as
1077  * an argument it also realloc'd
1078  * @return the entry
1079  */
1080 fib_entry_t*
1081 fib_entry_src_action_path_add (fib_entry_t *fib_entry,
1082                                fib_source_t source,
1083                                fib_entry_flag_t flags,
1084                                const fib_route_path_t *rpath)
1085 {
1086     fib_node_index_t old_path_list, fib_entry_index;
1087     fib_path_list_flags_t pl_flags;
1088     fib_path_ext_t *path_ext;
1089     fib_entry_src_t *esrc;
1090
1091     /*
1092      * save variable so we can recover from a fib_entry realloc.
1093      */
1094     fib_entry_index = fib_entry_get_index(fib_entry);
1095
1096     esrc = fib_entry_src_find(fib_entry, source, NULL);
1097     if (NULL == esrc)
1098     {
1099         fib_entry =
1100             fib_entry_src_action_add(fib_entry,
1101                                      source,
1102                                      flags,
1103                                      drop_dpo_get(
1104                                          fib_proto_to_dpo(
1105                                              fib_entry_get_proto(fib_entry))));
1106         esrc = fib_entry_src_find(fib_entry, source, NULL);
1107     }
1108
1109     /*
1110      * we are no doubt modifying a path-list. If the path-list
1111      * is shared, and hence not modifiable, then the index returned
1112      * will be for a different path-list. This FIB entry to needs
1113      * to maintain its lock appropriately.
1114      */
1115     old_path_list = esrc->fes_pl;
1116
1117     ASSERT(NULL != fib_entry_src_vft[source].fesv_path_add);
1118
1119     pl_flags = fib_entry_src_flags_2_path_list_flags(fib_entry_get_flags_i(fib_entry));
1120     fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1121
1122     fib_entry_src_vft[source].fesv_path_add(esrc, fib_entry, pl_flags, rpath);
1123     fib_entry = fib_entry_get(fib_entry_index);
1124
1125     /*
1126      * re-resolve all the path-extensions with the new path-list
1127      */
1128     vec_foreach(path_ext, esrc->fes_path_exts)
1129     {
1130         fib_path_ext_resolve(path_ext, esrc->fes_pl);
1131     }
1132     /*
1133      * if the path has a label we need to add a path extension
1134      */
1135     fib_entry_src_path_ext_insert(esrc, rpath);
1136
1137     fib_path_list_lock(esrc->fes_pl);
1138     fib_path_list_unlock(old_path_list);
1139
1140     return (fib_entry);
1141 }
1142
1143 /*
1144  * fib_entry_src_action_swap
1145  *
1146  * The source is providing new paths to replace the old ones.
1147  * Adding a source can result in a new fib_entry being created, which
1148  * can inturn mean the pool is realloc'd and thus the entry passed as
1149  * an argument it also realloc'd
1150  * @return the entry
1151  */
1152 fib_entry_t*
1153 fib_entry_src_action_path_swap (fib_entry_t *fib_entry,
1154                                 fib_source_t source,
1155                                 fib_entry_flag_t flags,
1156                                 const fib_route_path_t *rpaths)
1157 {
1158     fib_node_index_t old_path_list, fib_entry_index;
1159     fib_path_list_flags_t pl_flags;
1160     const fib_route_path_t *rpath;
1161     fib_path_ext_t *path_ext;
1162     fib_entry_src_t *esrc;
1163
1164     esrc = fib_entry_src_find(fib_entry, source, NULL);
1165
1166     /*
1167      * save variable so we can recover from a fib_entry realloc.
1168      */
1169     fib_entry_index = fib_entry_get_index(fib_entry);
1170
1171     if (NULL == esrc)
1172     {
1173         fib_entry = fib_entry_src_action_add(fib_entry,
1174                                              source,
1175                                              flags,
1176                                              drop_dpo_get(
1177                                                  fib_proto_to_dpo(
1178                                                      fib_entry_get_proto(fib_entry))));
1179         esrc = fib_entry_src_find(fib_entry, source, NULL);
1180     }
1181
1182     /*
1183      * swapping paths may create a new path-list (or may use an existing shared)
1184      * but we are certainly getting a different one. This FIB entry to needs
1185      * to maintain its lock appropriately.
1186      */
1187     old_path_list = esrc->fes_pl;
1188
1189     ASSERT(NULL != fib_entry_src_vft[source].fesv_path_swap);
1190
1191     pl_flags = fib_entry_src_flags_2_path_list_flags(flags);
1192
1193     vec_foreach(rpath, rpaths)
1194     {
1195         fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1196     }
1197
1198     fib_entry_src_vft[source].fesv_path_swap(esrc,
1199                                              fib_entry,
1200                                              pl_flags,
1201                                              rpaths);
1202
1203     vec_foreach(path_ext, esrc->fes_path_exts)
1204     {
1205         vec_free(path_ext->fpe_label_stack);
1206     }
1207     vec_free(esrc->fes_path_exts);
1208
1209     vec_foreach(rpath, rpaths)
1210     {
1211         fib_entry_src_path_ext_append(esrc, rpath);
1212     }
1213
1214     fib_entry = fib_entry_get(fib_entry_index);
1215
1216     fib_path_list_lock(esrc->fes_pl);
1217     fib_path_list_unlock(old_path_list);
1218
1219     return (fib_entry);
1220 }
1221
1222 fib_entry_src_flag_t
1223 fib_entry_src_action_path_remove (fib_entry_t *fib_entry,
1224                                   fib_source_t source,
1225                                   const fib_route_path_t *rpath)
1226 {
1227     fib_path_list_flags_t pl_flags;
1228     fib_node_index_t old_path_list;
1229     fib_path_ext_t *path_ext;
1230     fib_entry_src_t *esrc;
1231
1232     esrc = fib_entry_src_find(fib_entry, source, NULL);
1233
1234     ASSERT(NULL != esrc);
1235     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED);
1236
1237     /*
1238      * we no doubt modifying a path-list. If the path-list
1239      * is shared, and hence not modifiable, then the index returned
1240      * will be for a different path-list. This FIB entry to needs
1241      * to maintain its lock appropriately.
1242      */
1243     old_path_list = esrc->fes_pl;
1244
1245     ASSERT(NULL != fib_entry_src_vft[source].fesv_path_remove);
1246
1247     pl_flags = fib_entry_src_flags_2_path_list_flags(fib_entry_get_flags_i(fib_entry));
1248     fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1249
1250     fib_entry_src_vft[source].fesv_path_remove(esrc, pl_flags, rpath);
1251     /*
1252      * find the matching path extension and remove it
1253      */
1254     vec_foreach(path_ext, esrc->fes_path_exts)
1255     {
1256         if (!fib_path_ext_cmp(path_ext, rpath))
1257         {
1258             /*
1259              * delete the element moving the remaining elements down 1 position.
1260              * this preserves the sorted order.
1261              */
1262             vec_free(path_ext->fpe_label_stack);
1263             vec_delete(esrc->fes_path_exts, 1, (path_ext - esrc->fes_path_exts));
1264             break;
1265         }
1266     }
1267     /*
1268      * re-resolve all the path-extensions with the new path-list
1269      */
1270     vec_foreach(path_ext, esrc->fes_path_exts)
1271     {
1272         fib_path_ext_resolve(path_ext, esrc->fes_pl);
1273     }
1274
1275     /*
1276      * lock the new path-list, unlock the old if it had one
1277      */
1278     fib_path_list_unlock(old_path_list);
1279
1280     if (FIB_NODE_INDEX_INVALID != esrc->fes_pl) {
1281         fib_path_list_lock(esrc->fes_pl);
1282         return (FIB_ENTRY_SRC_FLAG_ADDED);
1283     }
1284     else
1285     {
1286         /*
1287          * no more paths left from this source
1288          */
1289         fib_entry_src_action_remove(fib_entry, source);
1290         return (FIB_ENTRY_SRC_FLAG_NONE);
1291     }
1292 }
1293
1294 u8*
1295 fib_entry_src_format (fib_entry_t *fib_entry,
1296                       fib_source_t source,
1297                       u8* s)
1298 {
1299     fib_entry_src_t *esrc;
1300
1301     esrc = fib_entry_src_find(fib_entry, source, NULL);
1302
1303     if (NULL != fib_entry_src_vft[source].fesv_format)
1304     {
1305         return (fib_entry_src_vft[source].fesv_format(esrc, s));
1306     }
1307     return (s);
1308 }
1309
1310 adj_index_t
1311 fib_entry_get_adj_for_source (fib_node_index_t fib_entry_index,
1312                               fib_source_t source)
1313 {
1314     fib_entry_t *fib_entry;
1315     fib_entry_src_t *esrc;
1316
1317     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
1318         return (ADJ_INDEX_INVALID);
1319
1320     fib_entry = fib_entry_get(fib_entry_index);
1321     esrc = fib_entry_src_find(fib_entry, source, NULL);
1322
1323     if (NULL != esrc)
1324     {
1325         if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1326         {
1327             return (fib_path_list_get_adj(
1328                         esrc->fes_pl,
1329                         fib_entry_get_default_chain_type(fib_entry)));
1330         }
1331     }
1332     return (ADJ_INDEX_INVALID);
1333 }
1334
1335 const int
1336 fib_entry_get_dpo_for_source (fib_node_index_t fib_entry_index,
1337                               fib_source_t source,
1338                               dpo_id_t *dpo)
1339 {
1340     fib_entry_t *fib_entry;
1341     fib_entry_src_t *esrc;
1342
1343     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
1344         return (0);
1345
1346     fib_entry = fib_entry_get(fib_entry_index);
1347     esrc = fib_entry_src_find(fib_entry, source, NULL);
1348
1349     if (NULL != esrc)
1350     {
1351         if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1352         {
1353             fib_path_list_contribute_forwarding(
1354                 esrc->fes_pl,
1355                 fib_entry_get_default_chain_type(fib_entry),
1356                 dpo);
1357
1358             return (dpo_id_is_valid(dpo));
1359         }
1360     }
1361     return (0);
1362 }
1363
1364 u32
1365 fib_entry_get_resolving_interface_for_source (fib_node_index_t entry_index,
1366                                               fib_source_t source)
1367 {
1368     fib_entry_t *fib_entry;
1369     fib_entry_src_t *esrc;
1370
1371     fib_entry = fib_entry_get(entry_index);
1372
1373     esrc = fib_entry_src_find(fib_entry, source, NULL);
1374
1375     if (NULL != esrc)
1376     {
1377         if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1378         {
1379             return (fib_path_list_get_resolving_interface(esrc->fes_pl));
1380         }
1381     }
1382     return (~0);
1383 }
1384
1385 fib_entry_flag_t
1386 fib_entry_get_flags_for_source (fib_node_index_t entry_index,
1387                                 fib_source_t source)
1388 {
1389     fib_entry_t *fib_entry;
1390     fib_entry_src_t *esrc;
1391
1392     fib_entry = fib_entry_get(entry_index);
1393
1394     esrc = fib_entry_src_find(fib_entry, source, NULL);
1395
1396     if (NULL != esrc)
1397     {
1398         return (esrc->fes_entry_flags);
1399     }
1400
1401     return (FIB_ENTRY_FLAG_NONE);
1402 }
1403
1404 fib_entry_flag_t
1405 fib_entry_get_flags_i (const fib_entry_t *fib_entry)
1406 {
1407     fib_entry_flag_t flags;
1408
1409     /*
1410      * the vector of sources is deliberately arranged in priority order
1411      */
1412     if (0 == vec_len(fib_entry->fe_srcs))
1413     {
1414         flags = FIB_ENTRY_FLAG_NONE;
1415     }
1416     else
1417     {
1418         fib_entry_src_t *esrc;
1419
1420         esrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
1421         flags = esrc->fes_entry_flags;
1422     }
1423
1424     return (flags);
1425 }
1426
1427 void
1428 fib_entry_set_source_data (fib_node_index_t fib_entry_index,
1429                            fib_source_t source,
1430                            const void *data)
1431 {
1432     fib_entry_t *fib_entry;
1433     fib_entry_src_t *esrc;
1434
1435     fib_entry = fib_entry_get(fib_entry_index);
1436     esrc = fib_entry_src_find(fib_entry, source, NULL);
1437
1438     if (NULL != esrc &&
1439         NULL != fib_entry_src_vft[source].fesv_set_data)
1440     {
1441         fib_entry_src_vft[source].fesv_set_data(esrc, fib_entry, data);
1442     }
1443 }
1444
1445 const void*
1446 fib_entry_get_source_data (fib_node_index_t fib_entry_index,
1447                            fib_source_t source)
1448 {
1449     fib_entry_t *fib_entry;
1450     fib_entry_src_t *esrc;
1451
1452     fib_entry = fib_entry_get(fib_entry_index);
1453     esrc = fib_entry_src_find(fib_entry, source, NULL);
1454
1455     if (NULL != esrc &&
1456         NULL != fib_entry_src_vft[source].fesv_get_data)
1457     {
1458         return (fib_entry_src_vft[source].fesv_get_data(esrc, fib_entry));
1459     }
1460     return (NULL);
1461 }
1462
1463 void
1464 fib_entry_src_module_init (void)
1465 {
1466     fib_entry_src_rr_register();
1467     fib_entry_src_interface_register();
1468     fib_entry_src_default_route_register();
1469     fib_entry_src_special_register();
1470     fib_entry_src_api_register();
1471     fib_entry_src_adj_register();
1472     fib_entry_src_mpls_register();
1473     fib_entry_src_lisp_register();
1474 }