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         (0 == fib_urpf_check_size(ui)))
 452     {
 453         /*
 454          * The uRPF list we get from the path-list is shared by all
 455          * other users of the list, but the uRPF exemption applies
 456          * only to this prefix. So we need our own list.
 457          */
 458         ui = fib_urpf_list_alloc_and_lock();
 459         fib_urpf_list_append(ui, 0);
 460         fib_urpf_list_bake(ui);
 461         load_balance_set_urpf(dpo_lb->dpoi_index, ui);
 462         fib_urpf_list_unlock(ui);
 463     }
 464     else
 465     {
 466         load_balance_set_urpf(dpo_lb->dpoi_index, ui);
 467     }
 468     load_balance_set_fib_entry_flags(dpo_lb->dpoi_index,
 469                                      fib_entry_get_flags_i(fib_entry));
 470 }
 471
 472 void
 473 fib_entry_src_action_install (fib_entry_t *fib_entry,
 474                               fib_source_t source)
 475 {
 476     /*
 477      * Install the forwarding chain for the given source into the forwarding
 478      * tables
 479      */
 480     fib_forward_chain_type_t fct;
 481     fib_entry_src_t *esrc;
 482     int insert;
 483
 484     fct = fib_entry_get_default_chain_type(fib_entry);
 485     esrc = fib_entry_src_find(fib_entry, source, NULL);
 486
 487     /*
 488      * Every entry has its own load-balance object. All changes to the entry's
 489      * forwarding result in an inplace modify of the load-balance. This means
 490      * the load-balance object only needs to be added to the forwarding
 491      * DB once, when it is created.
 492      */
 493     insert = !dpo_id_is_valid(&fib_entry->fe_lb);
 494
 495     fib_entry_src_mk_lb(fib_entry, esrc, fct, &fib_entry->fe_lb);
 496
 497     ASSERT(dpo_id_is_valid(&fib_entry->fe_lb));
 498     FIB_ENTRY_DBG(fib_entry, "install: %d", fib_entry->fe_lb);
 499
 500     /*
 501      * insert the adj into the data-plane forwarding trie
 502      */
 503     if (insert)
 504     {
 505        fib_table_fwding_dpo_update(fib_entry->fe_fib_index,
 506                                    &fib_entry->fe_prefix,
 507                                    &fib_entry->fe_lb);
 508     }
 509
 510     /*
 511      * if any of the other chain types are already created they will need
 512      * updating too
 513      */
 514     fib_entry_delegate_type_t fdt;
 515     fib_entry_delegate_t *fed;
 516
 517     FOR_EACH_DELEGATE_CHAIN(fib_entry, fdt, fed,
 518     {
 519         fib_entry_src_mk_lb(fib_entry, esrc,
 520                             fib_entry_delegate_type_to_chain_type(fdt),
 521                             &fed->fd_dpo);
 522     });
 523 }
 524
 525 void
 526 fib_entry_src_action_uninstall (fib_entry_t *fib_entry)
 527 {
 528     /*
 529      * uninstall the forwarding chain from the forwarding tables
 530      */
 531     FIB_ENTRY_DBG(fib_entry, "uninstall: %d",
 532                   fib_entry->fe_adj_index);
 533
 534     if (dpo_id_is_valid(&fib_entry->fe_lb))
 535     {
 536         fib_table_fwding_dpo_remove(
 537             fib_entry->fe_fib_index,
 538             &fib_entry->fe_prefix,
 539             &fib_entry->fe_lb);
 540
 541         dpo_reset(&fib_entry->fe_lb);
 542     }
 543 }
 544
 545 static void
 546 fib_entry_recursive_loop_detect_i (fib_node_index_t path_list_index)
 547 {
 548     fib_node_index_t *entries = NULL;
 549
 550     fib_path_list_recursive_loop_detect(path_list_index, &entries);
 551
 552     vec_free(entries);
 553 }
 554
 555 void
 556 fib_entry_src_action_activate (fib_entry_t *fib_entry,
 557                                fib_source_t source)
 558
 559 {
 560     int houston_we_are_go_for_install;
 561     fib_entry_src_t *esrc;
 562
 563     esrc = fib_entry_src_find(fib_entry, source, NULL);
 564
 565     ASSERT(!(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE));
 566     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED);
 567
 568     esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ACTIVE;
 569
 570     if (NULL != fib_entry_src_vft[source].fesv_activate)
 571     {
 572         houston_we_are_go_for_install =
 573             fib_entry_src_vft[source].fesv_activate(esrc, fib_entry);
 574     }
 575     else
 576     {
 577         /*
 578          * the source is not providing an activate function, we'll assume
 579          * therefore it has no objection to installing the entry
 580          */
 581         houston_we_are_go_for_install = !0;
 582     }
 583
 584     /*
 585      * link to the path-list provided by the source, and go check
 586      * if that forms any loops in the graph.
 587      */
 588     fib_entry->fe_parent = esrc->fes_pl;
 589     fib_entry->fe_sibling =
 590         fib_path_list_child_add(fib_entry->fe_parent,
 591                                 FIB_NODE_TYPE_ENTRY,
 592                                 fib_entry_get_index(fib_entry));
 593
 594     fib_entry_recursive_loop_detect_i(fib_entry->fe_parent);
 595
 596     FIB_ENTRY_DBG(fib_entry, "activate: %d",
 597                   fib_entry->fe_parent);
 598
 599     if (0 != houston_we_are_go_for_install)
 600     {
 601         fib_entry_src_action_install(fib_entry, source);
 602     }
 603     else
 604     {
 605         fib_entry_src_action_uninstall(fib_entry);
 606     }
 607 }
 608
 609 void
 610 fib_entry_src_action_deactivate (fib_entry_t *fib_entry,
 611                                  fib_source_t source)
 612
 613 {
 614     fib_node_index_t path_list_index;
 615     fib_entry_src_t *esrc;
 616
 617     esrc = fib_entry_src_find(fib_entry, source, NULL);
 618
 619     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE);
 620
 621     if (NULL != fib_entry_src_vft[source].fesv_deactivate)
 622     {
 623         fib_entry_src_vft[source].fesv_deactivate(esrc, fib_entry);
 624     }
 625
 626     esrc->fes_flags &= ~FIB_ENTRY_SRC_FLAG_ACTIVE;
 627
 628     FIB_ENTRY_DBG(fib_entry, "deactivate: %d", fib_entry->fe_parent);
 629
 630     /*
 631      * un-link from an old path-list. Check for any loops this will clear
 632      */
 633     path_list_index = fib_entry->fe_parent;
 634     fib_entry->fe_parent = FIB_NODE_INDEX_INVALID;
 635
 636     fib_entry_recursive_loop_detect_i(path_list_index);
 637
 638     /*
 639      * this will unlock the path-list, so it may be invalid thereafter.
 640      */
 641     fib_path_list_child_remove(path_list_index, fib_entry->fe_sibling);
 642     fib_entry->fe_sibling = FIB_NODE_INDEX_INVALID;
 643 }
 644
 645 static void
 646 fib_entry_src_action_fwd_update (const fib_entry_t *fib_entry,
 647                                  fib_source_t source)
 648 {
 649     fib_entry_src_t *esrc;
 650
 651     vec_foreach(esrc, fib_entry->fe_srcs)
 652     {
 653         if (NULL != fib_entry_src_vft[esrc->fes_src].fesv_fwd_update)
 654         {
 655             fib_entry_src_vft[esrc->fes_src].fesv_fwd_update(esrc,
 656                                                              fib_entry,
 657                                                              source);
 658         }
 659     }
 660 }
 661
 662 void
 663 fib_entry_src_action_reactivate (fib_entry_t *fib_entry,
 664                                  fib_source_t source)
 665 {
 666     fib_node_index_t path_list_index;
 667     fib_entry_src_t *esrc;
 668
 669     esrc = fib_entry_src_find(fib_entry, source, NULL);
 670
 671     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE);
 672
 673     FIB_ENTRY_DBG(fib_entry, "reactivate: %d to %d",
 674                   fib_entry->fe_parent,
 675                   esrc->fes_pl);
 676
 677     if (fib_entry->fe_parent != esrc->fes_pl)
 678     {
 679         /*
 680          * un-link from an old path-list. Check for any loops this will clear
 681          */
 682         path_list_index = fib_entry->fe_parent;
 683         fib_entry->fe_parent = FIB_NODE_INDEX_INVALID;
 684
 685         /*
 686          * temporary lock so it doesn't get deleted when this entry is no
 687          * longer a child.
 688          */
 689         fib_path_list_lock(path_list_index);
 690
 691         /*
 692          * this entry is no longer a child. after unlinking check if any loops
 693          * were broken
 694          */
 695         fib_path_list_child_remove(path_list_index,
 696                                    fib_entry->fe_sibling);
 697
 698         fib_entry_recursive_loop_detect_i(path_list_index);
 699
 700         /*
 701          * link to the path-list provided by the source, and go check
 702          * if that forms any loops in the graph.
 703          */
 704         fib_entry->fe_parent = esrc->fes_pl;
 705         fib_entry->fe_sibling =
 706             fib_path_list_child_add(fib_entry->fe_parent,
 707                                     FIB_NODE_TYPE_ENTRY,
 708                                     fib_entry_get_index(fib_entry));
 709
 710         fib_entry_recursive_loop_detect_i(fib_entry->fe_parent);
 711         fib_path_list_unlock(path_list_index);
 712     }
 713     fib_entry_src_action_install(fib_entry, source);
 714     fib_entry_src_action_fwd_update(fib_entry, source);
 715 }
 716
 717 void
 718 fib_entry_src_action_installed (const fib_entry_t *fib_entry,
 719                                 fib_source_t source)
 720 {
 721     fib_entry_src_t *esrc;
 722
 723     esrc = fib_entry_src_find(fib_entry, source, NULL);
 724
 725     if (NULL != fib_entry_src_vft[source].fesv_installed)
 726     {
 727         fib_entry_src_vft[source].fesv_installed(esrc,
 728                                                  fib_entry);
 729     }
 730
 731     fib_entry_src_action_fwd_update(fib_entry, source);
 732 }
 733
 734 /*
 735  * fib_entry_src_action_add
 736  *
 737  * Adding a source can result in a new fib_entry being created, which
 738  * can inturn mean the pool is realloc'd and thus the entry passed as
 739  * an argument it also realloc'd
 740  * @return the original entry
 741  */
 742 fib_entry_t *
 743 fib_entry_src_action_add (fib_entry_t *fib_entry,
 744                           fib_source_t source,
 745                           fib_entry_flag_t flags,
 746                           const dpo_id_t *dpo)
 747 {
 748     fib_node_index_t fib_entry_index;
 749     fib_entry_src_t *esrc;
 750
 751     esrc = fib_entry_src_find_or_create(fib_entry, source, NULL);
 752
 753     esrc->fes_ref_count++;
 754
 755     if (1 != esrc->fes_ref_count)
 756     {
 757         /*
 758          * we only want to add the source on the 0->1 transition
 759          */
 760         return (fib_entry);
 761     }
 762
 763     esrc->fes_entry_flags = flags;
 764
 765     /*
 766      * save variable so we can recover from a fib_entry realloc.
 767      */
 768     fib_entry_index = fib_entry_get_index(fib_entry);
 769
 770     if (NULL != fib_entry_src_vft[source].fesv_add)
 771     {
 772         fib_entry_src_vft[source].fesv_add(esrc,
 773                                            fib_entry,
 774                                            flags,
 775                                            fib_entry_get_proto(fib_entry),
 776                                            dpo);
 777     }
 778
 779     fib_entry = fib_entry_get(fib_entry_index);
 780
 781     esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ADDED;
 782
 783     fib_path_list_lock(esrc->fes_pl);
 784
 785     /*
 786      * the source owns a lock on the entry
 787      */
 788     fib_entry_lock(fib_entry_get_index(fib_entry));
 789
 790     return (fib_entry);
 791 }
 792
 793 /*
 794  * fib_entry_src_action_update
 795  *
 796  * Adding a source can result in a new fib_entry being created, which
 797  * can inturn mean the pool is realloc'd and thus the entry passed as
 798  * an argument it also realloc'd
 799  * @return the original entry
 800  */
 801 fib_entry_t *
 802 fib_entry_src_action_update (fib_entry_t *fib_entry,
 803                              fib_source_t source,
 804                              fib_entry_flag_t flags,
 805                              const dpo_id_t *dpo)
 806 {
 807     fib_node_index_t fib_entry_index, old_path_list_index;
 808     fib_entry_src_t *esrc;
 809
 810     esrc = fib_entry_src_find_or_create(fib_entry, source, NULL);
 811
 812     if (NULL == esrc)
 813         return (fib_entry_src_action_add(fib_entry, source, flags, dpo));
 814
 815     old_path_list_index = esrc->fes_pl;
 816     esrc->fes_entry_flags = flags;
 817
 818     /*
 819      * save variable so we can recover from a fib_entry realloc.
 820      */
 821     fib_entry_index = fib_entry_get_index(fib_entry);
 822
 823     if (NULL != fib_entry_src_vft[source].fesv_add)
 824     {
 825         fib_entry_src_vft[source].fesv_add(esrc,
 826                                            fib_entry,
 827                                            flags,
 828                                            fib_entry_get_proto(fib_entry),
 829                                            dpo);
 830     }
 831
 832     fib_entry = fib_entry_get(fib_entry_index);
 833
 834     esrc->fes_flags |= FIB_ENTRY_SRC_FLAG_ADDED;
 835
 836     fib_path_list_lock(esrc->fes_pl);
 837     fib_path_list_unlock(old_path_list_index);
 838
 839     return (fib_entry);
 840 }
 841
 842
 843 fib_entry_src_flag_t
 844 fib_entry_src_action_remove (fib_entry_t *fib_entry,
 845                              fib_source_t source)
 846
 847 {
 848     fib_node_index_t old_path_list;
 849     fib_entry_src_flag_t sflags;
 850     fib_entry_src_t *esrc;
 851
 852     esrc = fib_entry_src_find(fib_entry, source, NULL);
 853
 854     if (NULL == esrc)
 855         return (FIB_ENTRY_SRC_FLAG_ACTIVE);
 856
 857     esrc->fes_ref_count--;
 858     sflags = esrc->fes_flags;
 859
 860     if (0 != esrc->fes_ref_count)
 861     {
 862         /*
 863          * only remove the source on the 1->0 transisition
 864          */
 865         return (sflags);
 866     }
 867
 868     if (esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ACTIVE)
 869     {
 870         fib_entry_src_action_deactivate(fib_entry, source);
 871     }
 872
 873     old_path_list = esrc->fes_pl;
 874
 875     if (NULL != fib_entry_src_vft[source].fesv_remove)
 876     {
 877         fib_entry_src_vft[source].fesv_remove(esrc);
 878     }
 879
 880     fib_path_list_unlock(old_path_list);
 881     fib_entry_unlock(fib_entry_get_index(fib_entry));
 882
 883     sflags &= ~FIB_ENTRY_SRC_FLAG_ADDED;
 884     fib_entry_src_action_deinit(fib_entry, source);
 885
 886     return (sflags);
 887 }
 888
 889 static inline int
 890 fib_route_recurses_via_self (const fib_prefix_t *prefix,
 891                              const fib_route_path_t *rpath)
 892 {
 893     /*
 894      * not all zeros next hop &&
 895      * is recursive path &&
 896      * nexthop is same as the route's address
 897      */
 898     return ((!ip46_address_is_zero(&rpath->frp_addr)) &&
 899             (~0 == rpath->frp_sw_if_index) &&
 900             (0 == ip46_address_cmp(&rpath->frp_addr, &prefix->fp_addr)));
 901
 902 }
 903
 904 /*
 905  * fib_route_attached_cross_table
 906  *
 907  * Return true the the route is attached via an interface that
 908  * is not in the same table as the route
 909  */
 910 static inline int
 911 fib_route_attached_cross_table (const fib_entry_t *fib_entry,
 912                                 const fib_route_path_t *rpath)
 913 {
 914     /*
 915      * - All zeros next-hop
 916      * - a valid interface
 917      * - entry's fib index not equeal to interface's index
 918      */
 919     if (ip46_address_is_zero(&rpath->frp_addr) &&
 920         (~0 != rpath->frp_sw_if_index) &&
 921         (fib_entry->fe_fib_index !=
 922          fib_table_get_index_for_sw_if_index(fib_entry_get_proto(fib_entry),
 923                                              rpath->frp_sw_if_index)))
 924     {
 925         return (!0);
 926     }
 927     return (0);
 928 }
 929
 930 /*
 931  * fib_route_attached_cross_table
 932  *
 933  * Return true the the route is attached via an interface that
 934  * is not in the same table as the route
 935  */
 936 static inline int
 937 fib_path_is_attached (const fib_route_path_t *rpath)
 938 {
 939     /*
 940      * - All zeros next-hop
 941      * - a valid interface
 942      */
 943     if (ip46_address_is_zero(&rpath->frp_addr) &&
 944         (~0 != rpath->frp_sw_if_index))
 945     {
 946         return (!0);
 947     }
 948     return (0);
 949 }
 950
 951 fib_path_list_flags_t
 952 fib_entry_src_flags_2_path_list_flags (fib_entry_flag_t eflags)
 953 {
 954     fib_path_list_flags_t plf = FIB_PATH_LIST_FLAG_NONE;
 955
 956     if (eflags & FIB_ENTRY_FLAG_DROP)
 957     {
 958         plf |= FIB_PATH_LIST_FLAG_DROP;
 959     }
 960     if (eflags & FIB_ENTRY_FLAG_LOCAL)
 961     {
 962         plf |= FIB_PATH_LIST_FLAG_LOCAL;
 963     }
 964     if (eflags & FIB_ENTRY_FLAG_EXCLUSIVE)
 965     {
 966         plf |= FIB_PATH_LIST_FLAG_EXCLUSIVE;
 967     }
 968
 969     return (plf);
 970 }
 971
 972 static void
 973 fib_entry_flags_update (const fib_entry_t *fib_entry,
 974                         const fib_route_path_t *rpath,
 975                         fib_path_list_flags_t *pl_flags,
 976                         fib_entry_src_t *esrc)
 977 {
 978     /*
 979      * don't allow the addition of a recursive looped path for prefix
 980      * via itself.
 981      */
 982     if (fib_route_recurses_via_self(&fib_entry->fe_prefix, rpath))
 983     {
 984         /*
 985          * force the install of a drop path-list.
 986          * we want the entry to have some path-list, mainly so
 987          * the dodgy path can be rmeoved when the source stops playing
 988          * silly buggers.
 989          */
 990         *pl_flags |= FIB_PATH_LIST_FLAG_DROP;
 991     }
 992     else
 993     {
 994         *pl_flags &= ~FIB_PATH_LIST_FLAG_DROP;
 995     }
 996
 997     if ((esrc->fes_src == FIB_SOURCE_API) ||
 998         (esrc->fes_src == FIB_SOURCE_CLI))
 999     {
1000         if (fib_path_is_attached(rpath))
1001         {
1002             esrc->fes_entry_flags |= FIB_ENTRY_FLAG_ATTACHED;
1003         }
1004         else
1005         {
1006             esrc->fes_entry_flags &= ~FIB_ENTRY_FLAG_ATTACHED;
1007         }
1008     }
1009     if (fib_route_attached_cross_table(fib_entry, rpath))
1010     {
1011         esrc->fes_entry_flags |= FIB_ENTRY_FLAG_IMPORT;
1012     }
1013     else
1014     {
1015         esrc->fes_entry_flags &= ~FIB_ENTRY_FLAG_IMPORT;
1016     }
1017 }
1018
1019 /*
1020  * fib_entry_src_path_ext_add
1021  *
1022  * append a path extension to the entry's list
1023  */
1024 static void
1025 fib_entry_src_path_ext_append (fib_entry_src_t *esrc,
1026                                const fib_route_path_t *rpath)
1027 {
1028     if (NULL != rpath->frp_label_stack)
1029     {
1030         fib_path_ext_t *path_ext;
1031
1032         vec_add2(esrc->fes_path_exts, path_ext, 1);
1033
1034         fib_path_ext_init(path_ext, esrc->fes_pl, rpath);
1035     }
1036 }
1037
1038 /*
1039  * fib_entry_src_path_ext_insert
1040  *
1041  * insert, sorted, a path extension to the entry's list.
1042  * It's not strictly necessary in sort the path extensions, since each
1043  * extension has the path index to which it resolves. However, by being
1044  * sorted the load-balance produced has a deterministic order, not an order
1045  * based on the sequence of extension additions. this is a considerable benefit.
1046  */
1047 static void
1048 fib_entry_src_path_ext_insert (fib_entry_src_t *esrc,
1049                                const fib_route_path_t *rpath)
1050 {
1051     if (0 == vec_len(esrc->fes_path_exts))
1052         return (fib_entry_src_path_ext_append(esrc, rpath));
1053
1054     if (NULL != rpath->frp_label_stack)
1055     {
1056         fib_path_ext_t path_ext;
1057         int i = 0;
1058
1059         fib_path_ext_init(&path_ext, esrc->fes_pl, rpath);
1060
1061         while (i < vec_len(esrc->fes_path_exts) &&
1062                (fib_path_ext_cmp(&esrc->fes_path_exts[i], rpath) < 0))
1063         {
1064             i++;
1065         }
1066
1067         vec_insert_elts(esrc->fes_path_exts, &path_ext, 1, i);
1068     }
1069 }
1070
1071 /*
1072  * fib_entry_src_action_add
1073  *
1074  * Adding a source can result in a new fib_entry being created, which
1075  * can inturn mean the pool is realloc'd and thus the entry passed as
1076  * an argument it also realloc'd
1077  * @return the entry
1078  */
1079 fib_entry_t*
1080 fib_entry_src_action_path_add (fib_entry_t *fib_entry,
1081                                fib_source_t source,
1082                                fib_entry_flag_t flags,
1083                                const fib_route_path_t *rpath)
1084 {
1085     fib_node_index_t old_path_list, fib_entry_index;
1086     fib_path_list_flags_t pl_flags;
1087     fib_path_ext_t *path_ext;
1088     fib_entry_src_t *esrc;
1089
1090     /*
1091      * save variable so we can recover from a fib_entry realloc.
1092      */
1093     fib_entry_index = fib_entry_get_index(fib_entry);
1094
1095     esrc = fib_entry_src_find(fib_entry, source, NULL);
1096     if (NULL == esrc)
1097     {
1098         fib_entry =
1099             fib_entry_src_action_add(fib_entry,
1100                                      source,
1101                                      flags,
1102                                      drop_dpo_get(
1103                                          fib_proto_to_dpo(
1104                                              fib_entry_get_proto(fib_entry))));
1105         esrc = fib_entry_src_find(fib_entry, source, NULL);
1106     }
1107
1108     /*
1109      * we are no doubt modifying a path-list. If the path-list
1110      * is shared, and hence not modifiable, then the index returned
1111      * will be for a different path-list. This FIB entry to needs
1112      * to maintain its lock appropriately.
1113      */
1114     old_path_list = esrc->fes_pl;
1115
1116     ASSERT(NULL != fib_entry_src_vft[source].fesv_path_add);
1117
1118     pl_flags = fib_entry_src_flags_2_path_list_flags(fib_entry_get_flags_i(fib_entry));
1119     fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1120
1121     fib_entry_src_vft[source].fesv_path_add(esrc, fib_entry, pl_flags, rpath);
1122     fib_entry = fib_entry_get(fib_entry_index);
1123
1124     /*
1125      * re-resolve all the path-extensions with the new path-list
1126      */
1127     vec_foreach(path_ext, esrc->fes_path_exts)
1128     {
1129         fib_path_ext_resolve(path_ext, esrc->fes_pl);
1130     }
1131     /*
1132      * if the path has a label we need to add a path extension
1133      */
1134     fib_entry_src_path_ext_insert(esrc, rpath);
1135
1136     fib_path_list_lock(esrc->fes_pl);
1137     fib_path_list_unlock(old_path_list);
1138
1139     return (fib_entry);
1140 }
1141
1142 /*
1143  * fib_entry_src_action_swap
1144  *
1145  * The source is providing new paths to replace the old ones.
1146  * Adding a source can result in a new fib_entry being created, which
1147  * can inturn mean the pool is realloc'd and thus the entry passed as
1148  * an argument it also realloc'd
1149  * @return the entry
1150  */
1151 fib_entry_t*
1152 fib_entry_src_action_path_swap (fib_entry_t *fib_entry,
1153                                 fib_source_t source,
1154                                 fib_entry_flag_t flags,
1155                                 const fib_route_path_t *rpaths)
1156 {
1157     fib_node_index_t old_path_list, fib_entry_index;
1158     fib_path_list_flags_t pl_flags;
1159     const fib_route_path_t *rpath;
1160     fib_path_ext_t *path_ext;
1161     fib_entry_src_t *esrc;
1162
1163     esrc = fib_entry_src_find(fib_entry, source, NULL);
1164
1165     /*
1166      * save variable so we can recover from a fib_entry realloc.
1167      */
1168     fib_entry_index = fib_entry_get_index(fib_entry);
1169
1170     if (NULL == esrc)
1171     {
1172         fib_entry = fib_entry_src_action_add(fib_entry,
1173                                              source,
1174                                              flags,
1175                                              drop_dpo_get(
1176                                                  fib_proto_to_dpo(
1177                                                      fib_entry_get_proto(fib_entry))));
1178         esrc = fib_entry_src_find(fib_entry, source, NULL);
1179     }
1180
1181     /*
1182      * swapping paths may create a new path-list (or may use an existing shared)
1183      * but we are certainly getting a different one. This FIB entry to needs
1184      * to maintain its lock appropriately.
1185      */
1186     old_path_list = esrc->fes_pl;
1187
1188     ASSERT(NULL != fib_entry_src_vft[source].fesv_path_swap);
1189
1190     pl_flags = fib_entry_src_flags_2_path_list_flags(flags);
1191
1192     vec_foreach(rpath, rpaths)
1193     {
1194         fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1195     }
1196
1197     fib_entry_src_vft[source].fesv_path_swap(esrc,
1198                                              fib_entry,
1199                                              pl_flags,
1200                                              rpaths);
1201
1202     vec_foreach(path_ext, esrc->fes_path_exts)
1203     {
1204         vec_free(path_ext->fpe_label_stack);
1205     }
1206     vec_free(esrc->fes_path_exts);
1207
1208     vec_foreach(rpath, rpaths)
1209     {
1210         fib_entry_src_path_ext_append(esrc, rpath);
1211     }
1212
1213     fib_entry = fib_entry_get(fib_entry_index);
1214
1215     fib_path_list_lock(esrc->fes_pl);
1216     fib_path_list_unlock(old_path_list);
1217
1218     return (fib_entry);
1219 }
1220
1221 fib_entry_src_flag_t
1222 fib_entry_src_action_path_remove (fib_entry_t *fib_entry,
1223                                   fib_source_t source,
1224                                   const fib_route_path_t *rpath)
1225 {
1226     fib_path_list_flags_t pl_flags;
1227     fib_node_index_t old_path_list;
1228     fib_path_ext_t *path_ext;
1229     fib_entry_src_t *esrc;
1230
1231     esrc = fib_entry_src_find(fib_entry, source, NULL);
1232
1233     ASSERT(NULL != esrc);
1234     ASSERT(esrc->fes_flags & FIB_ENTRY_SRC_FLAG_ADDED);
1235
1236     /*
1237      * we no doubt modifying a path-list. If the path-list
1238      * is shared, and hence not modifiable, then the index returned
1239      * will be for a different path-list. This FIB entry to needs
1240      * to maintain its lock appropriately.
1241      */
1242     old_path_list = esrc->fes_pl;
1243
1244     ASSERT(NULL != fib_entry_src_vft[source].fesv_path_remove);
1245
1246     pl_flags = fib_entry_src_flags_2_path_list_flags(fib_entry_get_flags_i(fib_entry));
1247     fib_entry_flags_update(fib_entry, rpath, &pl_flags, esrc);
1248
1249     fib_entry_src_vft[source].fesv_path_remove(esrc, pl_flags, rpath);
1250     /*
1251      * find the matching path extension and remove it
1252      */
1253     vec_foreach(path_ext, esrc->fes_path_exts)
1254     {
1255         if (!fib_path_ext_cmp(path_ext, rpath))
1256         {
1257             /*
1258              * delete the element moving the remaining elements down 1 position.
1259              * this preserves the sorted order.
1260              */
1261             vec_free(path_ext->fpe_label_stack);
1262             vec_delete(esrc->fes_path_exts, 1, (path_ext - esrc->fes_path_exts));
1263             break;
1264         }
1265     }
1266     /*
1267      * re-resolve all the path-extensions with the new path-list
1268      */
1269     vec_foreach(path_ext, esrc->fes_path_exts)
1270     {
1271         fib_path_ext_resolve(path_ext, esrc->fes_pl);
1272     }
1273
1274     /*
1275      * lock the new path-list, unlock the old if it had one
1276      */
1277     fib_path_list_unlock(old_path_list);
1278
1279     if (FIB_NODE_INDEX_INVALID != esrc->fes_pl) {
1280         fib_path_list_lock(esrc->fes_pl);
1281         return (FIB_ENTRY_SRC_FLAG_ADDED);
1282     }
1283     else
1284     {
1285         /*
1286          * no more paths left from this source
1287          */
1288         fib_entry_src_action_remove(fib_entry, source);
1289         return (FIB_ENTRY_SRC_FLAG_NONE);
1290     }
1291 }
1292
1293 u8*
1294 fib_entry_src_format (fib_entry_t *fib_entry,
1295                       fib_source_t source,
1296                       u8* s)
1297 {
1298     fib_entry_src_t *esrc;
1299
1300     esrc = fib_entry_src_find(fib_entry, source, NULL);
1301
1302     if (NULL != fib_entry_src_vft[source].fesv_format)
1303     {
1304         return (fib_entry_src_vft[source].fesv_format(esrc, s));
1305     }
1306     return (s);
1307 }
1308
1309 adj_index_t
1310 fib_entry_get_adj_for_source (fib_node_index_t fib_entry_index,
1311                               fib_source_t source)
1312 {
1313     fib_entry_t *fib_entry;
1314     fib_entry_src_t *esrc;
1315
1316     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
1317         return (ADJ_INDEX_INVALID);
1318
1319     fib_entry = fib_entry_get(fib_entry_index);
1320     esrc = fib_entry_src_find(fib_entry, source, NULL);
1321
1322     if (NULL != esrc)
1323     {
1324         if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1325         {
1326             return (fib_path_list_get_adj(
1327                         esrc->fes_pl,
1328                         fib_entry_get_default_chain_type(fib_entry)));
1329         }
1330     }
1331     return (ADJ_INDEX_INVALID);
1332 }
1333
1334 const int
1335 fib_entry_get_dpo_for_source (fib_node_index_t fib_entry_index,
1336                               fib_source_t source,
1337                               dpo_id_t *dpo)
1338 {
1339     fib_entry_t *fib_entry;
1340     fib_entry_src_t *esrc;
1341
1342     if (FIB_NODE_INDEX_INVALID == fib_entry_index)
1343         return (0);
1344
1345     fib_entry = fib_entry_get(fib_entry_index);
1346     esrc = fib_entry_src_find(fib_entry, source, NULL);
1347
1348     if (NULL != esrc)
1349     {
1350         if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1351         {
1352             fib_path_list_contribute_forwarding(
1353                 esrc->fes_pl,
1354                 fib_entry_get_default_chain_type(fib_entry),
1355                 dpo);
1356
1357             return (dpo_id_is_valid(dpo));
1358         }
1359     }
1360     return (0);
1361 }
1362
1363 u32
1364 fib_entry_get_resolving_interface_for_source (fib_node_index_t entry_index,
1365                                               fib_source_t source)
1366 {
1367     fib_entry_t *fib_entry;
1368     fib_entry_src_t *esrc;
1369
1370     fib_entry = fib_entry_get(entry_index);
1371
1372     esrc = fib_entry_src_find(fib_entry, source, NULL);
1373
1374     if (NULL != esrc)
1375     {
1376         if (FIB_NODE_INDEX_INVALID != esrc->fes_pl)
1377         {
1378             return (fib_path_list_get_resolving_interface(esrc->fes_pl));
1379         }
1380     }
1381     return (~0);
1382 }
1383
1384 fib_entry_flag_t
1385 fib_entry_get_flags_for_source (fib_node_index_t entry_index,
1386                                 fib_source_t source)
1387 {
1388     fib_entry_t *fib_entry;
1389     fib_entry_src_t *esrc;
1390
1391     fib_entry = fib_entry_get(entry_index);
1392
1393     esrc = fib_entry_src_find(fib_entry, source, NULL);
1394
1395     if (NULL != esrc)
1396     {
1397         return (esrc->fes_entry_flags);
1398     }
1399
1400     return (FIB_ENTRY_FLAG_NONE);
1401 }
1402
1403 fib_entry_flag_t
1404 fib_entry_get_flags_i (const fib_entry_t *fib_entry)
1405 {
1406     fib_entry_flag_t flags;
1407
1408     /*
1409      * the vector of sources is deliberately arranged in priority order
1410      */
1411     if (0 == vec_len(fib_entry->fe_srcs))
1412     {
1413         flags = FIB_ENTRY_FLAG_NONE;
1414     }
1415     else
1416     {
1417         fib_entry_src_t *esrc;
1418
1419         esrc = vec_elt_at_index(fib_entry->fe_srcs, 0);
1420         flags = esrc->fes_entry_flags;
1421     }
1422
1423     return (flags);
1424 }
1425
1426 void
1427 fib_entry_set_source_data (fib_node_index_t fib_entry_index,
1428                            fib_source_t source,
1429                            const void *data)
1430 {
1431     fib_entry_t *fib_entry;
1432     fib_entry_src_t *esrc;
1433
1434     fib_entry = fib_entry_get(fib_entry_index);
1435     esrc = fib_entry_src_find(fib_entry, source, NULL);
1436
1437     if (NULL != esrc &&
1438         NULL != fib_entry_src_vft[source].fesv_set_data)
1439     {
1440         fib_entry_src_vft[source].fesv_set_data(esrc, fib_entry, data);
1441     }
1442 }
1443
1444 const void*
1445 fib_entry_get_source_data (fib_node_index_t fib_entry_index,
1446                            fib_source_t source)
1447 {
1448     fib_entry_t *fib_entry;
1449     fib_entry_src_t *esrc;
1450
1451     fib_entry = fib_entry_get(fib_entry_index);
1452     esrc = fib_entry_src_find(fib_entry, source, NULL);
1453
1454     if (NULL != esrc &&
1455         NULL != fib_entry_src_vft[source].fesv_get_data)
1456     {
1457         return (fib_entry_src_vft[source].fesv_get_data(esrc, fib_entry));
1458     }
1459     return (NULL);
1460 }
1461
1462 void
1463 fib_entry_src_module_init (void)
1464 {
1465     fib_entry_src_rr_register();
1466     fib_entry_src_interface_register();
1467     fib_entry_src_default_route_register();
1468     fib_entry_src_special_register();
1469     fib_entry_src_api_register();
1470     fib_entry_src_adj_register();
1471     fib_entry_src_mpls_register();
1472     fib_entry_src_lisp_register();
1473 }