src/vnet/mfib/mfib_entry.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 <vlib/vlib.h>
  17
  18 #include <vnet/mfib/mfib_entry.h>
  19 #include <vnet/mfib/mfib_entry_src.h>
  20 #include <vnet/mfib/mfib_entry_cover.h>
  21 #include <vnet/fib/fib_path_list.h>
  22 #include <vnet/fib/fib_walk.h>
  23
  24 #include <vnet/dpo/drop_dpo.h>
  25 #include <vnet/dpo/replicate_dpo.h>
  26
  27 /**
  28  * the logger
  29  */
  30 vlib_log_class_t mfib_entry_logger;
  31
  32 /**
  33  * Pool of path extensions
  34  */
  35 static mfib_path_ext_t *mfib_path_ext_pool;
  36
  37 /**
  38  * String names for each source
  39  */
  40 static const char *mfib_source_names[] = MFIB_SOURCE_NAMES;
  41
  42 /*
  43  * Pool for all fib_entries
  44  */
  45 mfib_entry_t *mfib_entry_pool;
  46
  47 static fib_node_t *
  48 mfib_entry_get_node (fib_node_index_t index)
  49 {
  50     return ((fib_node_t*)mfib_entry_get(index));
  51 }
  52
  53 static fib_protocol_t
  54 mfib_entry_get_proto (const mfib_entry_t * mfib_entry)
  55 {
  56     return (mfib_entry->mfe_prefix.fp_proto);
  57 }
  58
  59 fib_forward_chain_type_t
  60 mfib_entry_get_default_chain_type (const mfib_entry_t *mfib_entry)
  61 {
  62     switch (mfib_entry->mfe_prefix.fp_proto)
  63     {
  64     case FIB_PROTOCOL_IP4:
  65         return (FIB_FORW_CHAIN_TYPE_MCAST_IP4);
  66     case FIB_PROTOCOL_IP6:
  67         return (FIB_FORW_CHAIN_TYPE_MCAST_IP6);
  68     case FIB_PROTOCOL_MPLS:
  69         ASSERT(0);
  70         break;
  71     }
  72     return (FIB_FORW_CHAIN_TYPE_MCAST_IP4);
  73 }
  74
  75 static u8 *
  76 format_mfib_entry_dpo (u8 * s, va_list * args)
  77 {
  78     index_t fei = va_arg(*args, index_t);
  79     CLIB_UNUSED(u32 indent) = va_arg(*args, u32);
  80
  81     return (format(s, "%U",
  82                    format_mfib_entry, fei,
  83                    MFIB_ENTRY_FORMAT_BRIEF));
  84 }
  85
  86 static inline mfib_path_ext_t *
  87 mfib_entry_path_ext_get (index_t mi)
  88 {
  89     return (pool_elt_at_index(mfib_path_ext_pool, mi));
  90 }
  91
  92 static u8 *
  93 format_mfib_entry_path_ext (u8 * s, va_list * args)
  94 {
  95     mfib_path_ext_t *path_ext;
  96     index_t mpi = va_arg(*args, index_t);
  97
  98     path_ext = mfib_entry_path_ext_get(mpi);
  99     return (format(s, "path:%d flags:%U",
 100                    path_ext->mfpe_path,
 101                    format_mfib_itf_flags, path_ext->mfpe_flags));
 102 }
 103
 104 u8 *
 105 format_mfib_entry (u8 * s, va_list * args)
 106 {
 107     fib_node_index_t fei, mfi;
 108     mfib_entry_t *mfib_entry;
 109     mfib_entry_src_t *msrc;
 110     u32 sw_if_index;
 111     int level;
 112
 113     fei = va_arg (*args, fib_node_index_t);
 114     level = va_arg (*args, int);
 115     mfib_entry = mfib_entry_get(fei);
 116
 117     s = format (s, "%U", format_mfib_prefix, &mfib_entry->mfe_prefix);
 118     s = format (s, ": %U", format_mfib_entry_flags, mfib_entry->mfe_flags);
 119
 120     if (level >= MFIB_ENTRY_FORMAT_DETAIL)
 121     {
 122         fib_node_index_t path_index, mpi;
 123
 124         s = format (s, "\n");
 125         s = format (s, " fib:%d", mfib_entry->mfe_fib_index);
 126         s = format (s, " index:%d", mfib_entry_get_index(mfib_entry));
 127         s = format (s, " locks:%d\n", mfib_entry->mfe_node.fn_locks);
 128         vec_foreach(msrc, mfib_entry->mfe_srcs)
 129         {
 130             s = format (s, "  src:%s locks:%d:",
 131                         mfib_source_names[msrc->mfes_src],
 132                         msrc->mfes_ref_count);
 133             if (msrc->mfes_cover != FIB_NODE_INDEX_INVALID)
 134             {
 135                 s = format (s, " cover:%d", msrc->mfes_cover);
 136             }
 137             s = format (s, " %U\n", format_mfib_entry_flags, msrc->mfes_flags);
 138             if (FIB_NODE_INDEX_INVALID != msrc->mfes_pl)
 139             {
 140                 s = fib_path_list_format(msrc->mfes_pl, s);
 141             }
 142             s = format (s, "    Extensions:\n");
 143             hash_foreach(path_index, mpi, msrc->mfes_exts,
 144             ({
 145                 s = format(s, "     %U\n", format_mfib_entry_path_ext, mpi);
 146             }));
 147             s = format (s, "    Interface-Forwarding:\n");
 148             hash_foreach(sw_if_index, mfi, msrc->mfes_itfs,
 149             ({
 150                 s = format(s, "    %U\n", format_mfib_itf, mfi);
 151             }));
 152         }
 153     }
 154
 155     s = format(s, "\n  Interfaces:");
 156     hash_foreach(sw_if_index, mfi, mfib_entry->mfe_itfs,
 157     ({
 158         s = format(s, "\n  %U", format_mfib_itf, mfi);
 159     }));
 160     if (MFIB_RPF_ID_NONE != mfib_entry->mfe_rpf_id)
 161     {
 162         s = format(s, "\n  RPF-ID:%d", mfib_entry->mfe_rpf_id);
 163     }
 164     s = format(s, "\n  %U-chain\n  %U",
 165                format_fib_forw_chain_type,
 166                mfib_entry_get_default_chain_type(mfib_entry),
 167                format_dpo_id,
 168                &mfib_entry->mfe_rep,
 169                2);
 170     s = format(s, "\n");
 171
 172     if (level >= MFIB_ENTRY_FORMAT_DETAIL2)
 173     {
 174         s = format(s, "\nchildren:");
 175         s = fib_node_children_format(mfib_entry->mfe_node.fn_children, s);
 176     }
 177
 178     return (s);
 179 }
 180
 181 static mfib_entry_t*
 182 mfib_entry_from_fib_node (fib_node_t *node)
 183 {
 184     ASSERT(FIB_NODE_TYPE_MFIB_ENTRY == node->fn_type);
 185     return ((mfib_entry_t*)node);
 186 }
 187
 188 static int
 189 mfib_entry_src_cmp_for_sort (void * v1,
 190                              void * v2)
 191 {
 192     mfib_entry_src_t *esrc1 = v1, *esrc2 = v2;
 193
 194     return (esrc1->mfes_src - esrc2->mfes_src);
 195 }
 196
 197 static void
 198 mfib_entry_src_init (mfib_entry_t *mfib_entry,
 199                      mfib_source_t source)
 200
 201 {
 202     mfib_entry_src_t esrc = {
 203         .mfes_pl = FIB_NODE_INDEX_INVALID,
 204         .mfes_flags = MFIB_ENTRY_FLAG_NONE,
 205         .mfes_src = source,
 206         .mfes_cover = FIB_NODE_INDEX_INVALID,
 207         .mfes_sibling = FIB_NODE_INDEX_INVALID,
 208         .mfes_ref_count = 1,
 209     };
 210
 211     vec_add1(mfib_entry->mfe_srcs, esrc);
 212     vec_sort_with_function(mfib_entry->mfe_srcs,
 213                            mfib_entry_src_cmp_for_sort);
 214 }
 215
 216 static mfib_entry_src_t *
 217 mfib_entry_src_find (const mfib_entry_t *mfib_entry,
 218                     mfib_source_t source,
 219                     u32 *index)
 220
 221 {
 222     mfib_entry_src_t *esrc;
 223     int ii;
 224
 225     ii = 0;
 226     vec_foreach(esrc, mfib_entry->mfe_srcs)
 227     {
 228         if (esrc->mfes_src == source)
 229         {
 230             if (NULL != index)
 231             {
 232                 *index = ii;
 233             }
 234             return (esrc);
 235         }
 236         else
 237         {
 238             ii++;
 239         }
 240     }
 241
 242     return (NULL);
 243 }
 244
 245 static mfib_entry_src_t *
 246 mfib_entry_src_find_or_create (mfib_entry_t *mfib_entry,
 247                                mfib_source_t source)
 248 {
 249     mfib_entry_src_t *msrc;
 250
 251     msrc = mfib_entry_src_find(mfib_entry, source, NULL);
 252
 253     if (NULL == msrc)
 254     {
 255         mfib_entry_src_init(mfib_entry, source);
 256         msrc = mfib_entry_src_find(mfib_entry, source, NULL);
 257     }
 258
 259     return (msrc);
 260 }
 261
 262 static mfib_entry_src_t *
 263 mfib_entry_src_update (mfib_entry_t *mfib_entry,
 264                        mfib_source_t source,
 265                        fib_rpf_id_t rpf_id,
 266                        mfib_entry_flags_t entry_flags)
 267 {
 268     mfib_entry_src_t *msrc;
 269
 270     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 271
 272     msrc->mfes_flags = entry_flags;
 273     msrc->mfes_rpf_id = rpf_id;
 274
 275     return (msrc);
 276 }
 277
 278 static mfib_entry_src_t *
 279 mfib_entry_src_update_and_lock (mfib_entry_t *mfib_entry,
 280                                 mfib_source_t source,
 281                                 fib_rpf_id_t rpf_id,
 282                                 mfib_entry_flags_t entry_flags)
 283 {
 284     mfib_entry_src_t *msrc;
 285
 286     msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
 287
 288     msrc->mfes_ref_count++;
 289
 290     return (msrc);
 291 }
 292
 293 mfib_entry_src_t*
 294 mfib_entry_get_best_src (const mfib_entry_t *mfib_entry)
 295 {
 296     mfib_entry_src_t *bsrc;
 297
 298     /*
 299      * the enum of sources is deliberately arranged in priority order
 300      */
 301     if (0 == vec_len(mfib_entry->mfe_srcs))
 302     {
 303         bsrc = NULL;
 304     }
 305     else
 306     {
 307         bsrc = vec_elt_at_index(mfib_entry->mfe_srcs, 0);
 308     }
 309
 310     return (bsrc);
 311 }
 312
 313 static mfib_source_t
 314 mfib_entry_get_best_source (const mfib_entry_t *mfib_entry)
 315 {
 316     mfib_entry_src_t *bsrc;
 317
 318     bsrc = mfib_entry_get_best_src(mfib_entry);
 319
 320     return (bsrc->mfes_src);
 321 }
 322
 323 int
 324 mfib_entry_is_sourced (fib_node_index_t mfib_entry_index,
 325                        mfib_source_t source)
 326 {
 327     mfib_entry_t *mfib_entry;
 328
 329     mfib_entry = mfib_entry_get(mfib_entry_index);
 330
 331     return (NULL != mfib_entry_src_find(mfib_entry, source, NULL));
 332 }
 333
 334 int
 335 mfib_entry_is_host (fib_node_index_t mfib_entry_index)
 336 {
 337     return (mfib_prefix_is_host(mfib_entry_get_prefix(mfib_entry_index)));
 338 }
 339
 340
 341 static void
 342 mfib_entry_src_flush (mfib_entry_src_t *msrc)
 343 {
 344     u32 sw_if_index;
 345     index_t mfii;
 346
 347     hash_foreach(sw_if_index, mfii, msrc->mfes_itfs,
 348     ({
 349         mfib_itf_delete(mfib_itf_get(mfii));
 350     }));
 351     hash_free(msrc->mfes_itfs);
 352     msrc->mfes_itfs = NULL;
 353     fib_path_list_unlock(msrc->mfes_pl);
 354 }
 355
 356 static void
 357 mfib_entry_src_remove (mfib_entry_t *mfib_entry,
 358                        mfib_source_t source)
 359
 360 {
 361     mfib_entry_src_t *msrc;
 362     u32 index = ~0;
 363
 364     msrc = mfib_entry_src_find(mfib_entry, source, &index);
 365
 366     if (NULL != msrc)
 367     {
 368         ASSERT(0 != msrc->mfes_ref_count);
 369         msrc->mfes_ref_count--;
 370
 371         if (0 == msrc->mfes_ref_count)
 372         {
 373             mfib_entry_src_deactivate(mfib_entry, msrc);
 374             mfib_entry_src_flush(msrc);
 375
 376             vec_del1(mfib_entry->mfe_srcs, index);
 377             if (vec_len (mfib_entry->mfe_srcs) > 1)
 378                 vec_sort_with_function(mfib_entry->mfe_srcs,
 379                                        mfib_entry_src_cmp_for_sort);
 380         }
 381     }
 382 }
 383
 384 u32
 385 mfib_entry_child_add (fib_node_index_t mfib_entry_index,
 386                       fib_node_type_t child_type,
 387                       fib_node_index_t child_index)
 388 {
 389     return (fib_node_child_add(FIB_NODE_TYPE_MFIB_ENTRY,
 390                                mfib_entry_index,
 391                                child_type,
 392                                child_index));
 393 };
 394
 395 void
 396 mfib_entry_child_remove (fib_node_index_t mfib_entry_index,
 397                          u32 sibling_index)
 398 {
 399     fib_node_child_remove(FIB_NODE_TYPE_MFIB_ENTRY,
 400                           mfib_entry_index,
 401                           sibling_index);
 402 }
 403
 404 static mfib_entry_t *
 405 mfib_entry_alloc (u32 fib_index,
 406                   const mfib_prefix_t *prefix,
 407                   fib_node_index_t *mfib_entry_index)
 408 {
 409     mfib_entry_t *mfib_entry;
 410
 411     pool_get_aligned(mfib_entry_pool, mfib_entry, CLIB_CACHE_LINE_BYTES);
 412
 413     fib_node_init(&mfib_entry->mfe_node,
 414                   FIB_NODE_TYPE_MFIB_ENTRY);
 415
 416     /*
 417      * Some of the members require non-default initialisation
 418      * so we also init those that don't and thus save on the call to clib_memset.
 419      */
 420     mfib_entry->mfe_flags = 0;
 421     mfib_entry->mfe_fib_index = fib_index;
 422     mfib_entry->mfe_prefix = *prefix;
 423     mfib_entry->mfe_srcs = NULL;
 424     mfib_entry->mfe_itfs = NULL;
 425     mfib_entry->mfe_rpf_id = MFIB_RPF_ID_NONE;
 426     mfib_entry->mfe_pl = FIB_NODE_INDEX_INVALID;
 427
 428     dpo_reset(&mfib_entry->mfe_rep);
 429
 430     *mfib_entry_index = mfib_entry_get_index(mfib_entry);
 431
 432     MFIB_ENTRY_DBG(mfib_entry, "alloc");
 433
 434     return (mfib_entry);
 435 }
 436
 437 static inline mfib_path_ext_t *
 438 mfib_entry_path_ext_find (mfib_path_ext_t *exts,
 439                           fib_node_index_t path_index)
 440 {
 441     uword *p;
 442
 443     p = hash_get(exts, path_index);
 444
 445     if (NULL != p)
 446     {
 447         return (mfib_entry_path_ext_get(p[0]));
 448     }
 449
 450     return (NULL);
 451 }
 452
 453 static mfib_path_ext_t*
 454 mfib_path_ext_add (mfib_entry_src_t *msrc,
 455                    fib_node_index_t path_index,
 456                    mfib_itf_flags_t mfi_flags)
 457 {
 458     mfib_path_ext_t *path_ext;
 459
 460     pool_get(mfib_path_ext_pool, path_ext);
 461
 462     path_ext->mfpe_flags = mfi_flags;
 463     path_ext->mfpe_path = path_index;
 464
 465     hash_set(msrc->mfes_exts, path_index,
 466              path_ext - mfib_path_ext_pool);
 467
 468     return (path_ext);
 469 }
 470
 471 static void
 472 mfib_path_ext_remove (mfib_entry_src_t *msrc,
 473                       fib_node_index_t path_index)
 474 {
 475     mfib_path_ext_t *path_ext;
 476
 477     path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
 478
 479     hash_unset(msrc->mfes_exts, path_index);
 480     pool_put(mfib_path_ext_pool, path_ext);
 481 }
 482
 483 typedef struct mfib_entry_collect_forwarding_ctx_t_
 484 {
 485     load_balance_path_t * next_hops;
 486     fib_forward_chain_type_t fct;
 487     mfib_entry_src_t *msrc;
 488 } mfib_entry_collect_forwarding_ctx_t;
 489
 490 static fib_path_list_walk_rc_t
 491 mfib_entry_src_collect_forwarding (fib_node_index_t pl_index,
 492                                    fib_node_index_t path_index,
 493                                    void *arg)
 494 {
 495     mfib_entry_collect_forwarding_ctx_t *ctx;
 496     load_balance_path_t *nh;
 497
 498     ctx = arg;
 499
 500     /*
 501      * if the path is not resolved, don't include it.
 502      */
 503     if (!fib_path_is_resolved(path_index))
 504     {
 505         return (FIB_PATH_LIST_WALK_CONTINUE);
 506     }
 507
 508     /*
 509      * If the path is not forwarding to use it
 510      */
 511     mfib_path_ext_t *path_ext;
 512
 513     path_ext = mfib_entry_path_ext_find(ctx->msrc->mfes_exts,
 514                                         path_index);
 515
 516     if (NULL != path_ext &&
 517         !(path_ext->mfpe_flags & MFIB_ITF_FLAG_FORWARD))
 518     {
 519         return (FIB_PATH_LIST_WALK_CONTINUE);
 520     }
 521
 522     switch (ctx->fct)
 523     {
 524     case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
 525     case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
 526         /*
 527          * EOS traffic with no label to stack, we need the IP Adj
 528          */
 529         vec_add2(ctx->next_hops, nh, 1);
 530
 531         nh->path_index = path_index;
 532         nh->path_weight = fib_path_get_weight(path_index);
 533         fib_path_contribute_forwarding(path_index, ctx->fct, &nh->path_dpo);
 534         break;
 535
 536     case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
 537     case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
 538     case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
 539     case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
 540     case FIB_FORW_CHAIN_TYPE_ETHERNET:
 541     case FIB_FORW_CHAIN_TYPE_NSH:
 542     case FIB_FORW_CHAIN_TYPE_BIER:
 543         ASSERT(0);
 544         break;
 545     }
 546
 547     return (FIB_PATH_LIST_WALK_CONTINUE);
 548 }
 549
 550 static void
 551 mfib_entry_stack (mfib_entry_t *mfib_entry,
 552                   mfib_entry_src_t *msrc)
 553 {
 554     dpo_proto_t dp;
 555
 556     dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 557
 558     /*
 559      * unlink the enty from the previous path list.
 560      */
 561     if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
 562     {
 563         fib_path_list_child_remove(mfib_entry->mfe_pl,
 564                                    mfib_entry->mfe_sibling);
 565     }
 566
 567     if (NULL != msrc)
 568     {
 569         mfib_entry_collect_forwarding_ctx_t ctx = {
 570             .next_hops = NULL,
 571             .fct = mfib_entry_get_default_chain_type(mfib_entry),
 572             .msrc = msrc,
 573         };
 574
 575         /*
 576          * link the entry to the path-list.
 577          * The entry needs to be a child so that we receive the back-walk
 578          * updates to recalculate forwarding.
 579          */
 580         mfib_entry->mfe_pl = msrc->mfes_pl;
 581         mfib_entry->mfe_flags = msrc->mfes_flags;
 582         mfib_entry->mfe_itfs = msrc->mfes_itfs;
 583         mfib_entry->mfe_rpf_id = msrc->mfes_rpf_id;
 584
 585         if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
 586         {
 587             mfib_entry->mfe_sibling =
 588                 fib_path_list_child_add(mfib_entry->mfe_pl,
 589                                         FIB_NODE_TYPE_MFIB_ENTRY,
 590                                         mfib_entry_get_index(mfib_entry));
 591
 592             fib_path_list_walk(mfib_entry->mfe_pl,
 593                                mfib_entry_src_collect_forwarding,
 594                                &ctx);
 595         }
 596         if (!(MFIB_ENTRY_FLAG_EXCLUSIVE & mfib_entry->mfe_flags))
 597         {
 598             if (NULL == ctx.next_hops)
 599             {
 600                 /*
 601                  * no next-hops, stack directly on the drop
 602                  */
 603                 dpo_stack(DPO_MFIB_ENTRY, dp,
 604                           &mfib_entry->mfe_rep,
 605                           drop_dpo_get(dp));
 606             }
 607             else
 608             {
 609                 /*
 610                  * each path contirbutes a next-hop. form a replicate
 611                  * from those choices.
 612                  */
 613                 if (!dpo_id_is_valid(&mfib_entry->mfe_rep) ||
 614                     dpo_is_drop(&mfib_entry->mfe_rep))
 615                 {
 616                     dpo_id_t tmp_dpo = DPO_INVALID;
 617
 618                     dpo_set(&tmp_dpo,
 619                             DPO_REPLICATE, dp,
 620                             replicate_create(0, dp));
 621
 622                     dpo_stack(DPO_MFIB_ENTRY, dp,
 623                               &mfib_entry->mfe_rep,
 624                               &tmp_dpo);
 625
 626                     dpo_reset(&tmp_dpo);
 627                 }
 628                 replicate_multipath_update(&mfib_entry->mfe_rep,
 629                                            ctx.next_hops);
 630             }
 631         }
 632         else
 633         {
 634             /*
 635              * for exclusive routes the source provided a replicate DPO
 636              * we we stashed inthe special path list with one path
 637              * so we can stack directly on that.
 638              */
 639             ASSERT(1 == vec_len(ctx.next_hops));
 640
 641             dpo_stack(DPO_MFIB_ENTRY, dp,
 642                       &mfib_entry->mfe_rep,
 643                       &ctx.next_hops[0].path_dpo);
 644             dpo_reset(&ctx.next_hops[0].path_dpo);
 645             vec_free(ctx.next_hops);
 646         }
 647     }
 648     else
 649     {
 650         dpo_stack(DPO_MFIB_ENTRY, dp,
 651                   &mfib_entry->mfe_rep,
 652                   drop_dpo_get(dp));
 653     }
 654
 655     /*
 656      * time for walkies fido.
 657      */
 658     fib_node_back_walk_ctx_t bw_ctx = {
 659         .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
 660     };
 661
 662     fib_walk_sync(FIB_NODE_TYPE_MFIB_ENTRY,
 663                   mfib_entry_get_index(mfib_entry),
 664                   &bw_ctx);
 665 }
 666
 667 static fib_node_index_t
 668 mfib_entry_src_path_add (mfib_entry_src_t *msrc,
 669                          const fib_route_path_t *rpath)
 670 {
 671     fib_node_index_t path_index;
 672     fib_route_path_t *rpaths;
 673
 674     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
 675
 676     /*
 677      * path-lists require a vector of paths
 678      */
 679     rpaths = NULL;
 680     vec_add1(rpaths, rpath[0]);
 681
 682     if (FIB_NODE_INDEX_INVALID == msrc->mfes_pl)
 683     {
 684         /* A non-shared path-list */
 685         msrc->mfes_pl = fib_path_list_create(FIB_PATH_LIST_FLAG_NO_URPF,
 686                                              NULL);
 687         fib_path_list_lock(msrc->mfes_pl);
 688     }
 689
 690     path_index = fib_path_list_path_add(msrc->mfes_pl, rpaths);
 691
 692     vec_free(rpaths);
 693
 694     return (path_index);
 695 }
 696
 697 static fib_node_index_t
 698 mfib_entry_src_path_remove (mfib_entry_src_t *msrc,
 699                             const fib_route_path_t *rpath)
 700 {
 701     fib_node_index_t path_index;
 702     fib_route_path_t *rpaths;
 703
 704     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
 705
 706     /*
 707      * path-lists require a vector of paths
 708      */
 709     rpaths = NULL;
 710     vec_add1(rpaths, rpath[0]);
 711
 712     path_index = fib_path_list_path_remove(msrc->mfes_pl, rpaths);
 713
 714     vec_free(rpaths);
 715
 716     return (path_index);
 717 }
 718
 719 static void
 720 mfib_entry_recalculate_forwarding (mfib_entry_t *mfib_entry,
 721                                    mfib_source_t old_best)
 722 {
 723     mfib_entry_src_t *bsrc, *osrc;
 724
 725     /*
 726      * copy the forwarding data from the bast source
 727      */
 728     bsrc = mfib_entry_get_best_src(mfib_entry);
 729     osrc = mfib_entry_src_find(mfib_entry, old_best, NULL);
 730
 731     if (NULL != bsrc)
 732     {
 733         if (bsrc->mfes_src != old_best)
 734         {
 735             /*
 736              * we are changing from one source to another
 737              * deactivate the old, and activate the new
 738              */
 739             mfib_entry_src_deactivate(mfib_entry, osrc);
 740             mfib_entry_src_activate(mfib_entry, bsrc);
 741         }
 742     }
 743     else
 744     {
 745         mfib_entry_src_deactivate(mfib_entry, osrc);
 746     }
 747
 748     mfib_entry_stack(mfib_entry, bsrc);
 749     mfib_entry_cover_update_notify(mfib_entry);
 750 }
 751
 752
 753 fib_node_index_t
 754 mfib_entry_create (u32 fib_index,
 755                    mfib_source_t source,
 756                    const mfib_prefix_t *prefix,
 757                    fib_rpf_id_t rpf_id,
 758                    mfib_entry_flags_t entry_flags,
 759                    index_t repi)
 760 {
 761     fib_node_index_t mfib_entry_index;
 762     mfib_entry_t *mfib_entry;
 763     mfib_entry_src_t *msrc;
 764
 765     mfib_entry = mfib_entry_alloc(fib_index, prefix,
 766                                   &mfib_entry_index);
 767     msrc = mfib_entry_src_update(mfib_entry, source,
 768                                  rpf_id, entry_flags);
 769
 770     if (INDEX_INVALID != repi)
 771     {
 772         /*
 773          * The source is providing its own replicate DPO.
 774          * Create a sepcial path-list to manage it, that way
 775          * this entry and the source are equivalent to a normal
 776          * entry
 777          */
 778         fib_node_index_t old_pl_index;
 779         dpo_proto_t dp;
 780         dpo_id_t dpo = DPO_INVALID;
 781
 782         dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 783         old_pl_index = msrc->mfes_pl;
 784
 785         dpo_set(&dpo, DPO_REPLICATE, dp, repi);
 786
 787         msrc->mfes_pl =
 788             fib_path_list_create_special(dp,
 789                                          FIB_PATH_LIST_FLAG_EXCLUSIVE,
 790                                          &dpo);
 791
 792         dpo_reset(&dpo);
 793         fib_path_list_lock(msrc->mfes_pl);
 794         fib_path_list_unlock(old_pl_index);
 795     }
 796
 797     mfib_entry_recalculate_forwarding(mfib_entry, MFIB_SOURCE_NONE);
 798
 799     return (mfib_entry_index);
 800 }
 801
 802 static int
 803 mfib_entry_ok_for_delete (mfib_entry_t *mfib_entry)
 804 {
 805     return (0 == vec_len(mfib_entry->mfe_srcs));
 806 }
 807
 808 static int
 809 mfib_entry_src_ok_for_delete (const mfib_entry_src_t *msrc)
 810 {
 811     return ((INDEX_INVALID == msrc->mfes_cover &&
 812              MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags &&
 813              0 == fib_path_list_get_n_paths(msrc->mfes_pl)));
 814 }
 815
 816
 817 static void
 818 mfib_entry_update_i (mfib_entry_t *mfib_entry,
 819                      mfib_entry_src_t *msrc,
 820                      mfib_source_t current_best,
 821                      index_t repi)
 822 {
 823     if (INDEX_INVALID != repi)
 824     {
 825         /*
 826          * The source is providing its own replicate DPO.
 827          * Create a sepcial path-list to manage it, that way
 828          * this entry and the source are equivalent to a normal
 829          * entry
 830          */
 831         fib_node_index_t old_pl_index;
 832         dpo_proto_t dp;
 833         dpo_id_t dpo = DPO_INVALID;
 834
 835         dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 836         old_pl_index = msrc->mfes_pl;
 837
 838         dpo_set(&dpo, DPO_REPLICATE, dp, repi);
 839
 840         msrc->mfes_pl =
 841             fib_path_list_create_special(dp,
 842                                          FIB_PATH_LIST_FLAG_EXCLUSIVE,
 843                                          &dpo);
 844
 845         dpo_reset(&dpo);
 846         fib_path_list_lock(msrc->mfes_pl);
 847         fib_path_list_unlock(old_pl_index);
 848     }
 849
 850     if (mfib_entry_src_ok_for_delete(msrc))
 851     {
 852         /*
 853          * this source has no interfaces and no flags.
 854          * it has nothing left to give - remove it
 855          */
 856         mfib_entry_src_remove(mfib_entry, msrc->mfes_src);
 857     }
 858
 859     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
 860 }
 861
 862 int
 863 mfib_entry_special_add (fib_node_index_t mfib_entry_index,
 864                         mfib_source_t source,
 865                         mfib_entry_flags_t entry_flags,
 866                         fib_rpf_id_t rpf_id,
 867                         index_t repi)
 868 {
 869     mfib_source_t current_best;
 870     mfib_entry_t *mfib_entry;
 871     mfib_entry_src_t *msrc;
 872
 873     mfib_entry = mfib_entry_get(mfib_entry_index);
 874     current_best = mfib_entry_get_best_source(mfib_entry);
 875
 876     msrc = mfib_entry_src_update_and_lock(mfib_entry, source, rpf_id,
 877                                           entry_flags);
 878
 879     mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
 880
 881     return (mfib_entry_ok_for_delete(mfib_entry));
 882 }
 883
 884 int
 885 mfib_entry_update (fib_node_index_t mfib_entry_index,
 886                    mfib_source_t source,
 887                    mfib_entry_flags_t entry_flags,
 888                    fib_rpf_id_t rpf_id,
 889                    index_t repi)
 890 {
 891     mfib_source_t current_best;
 892     mfib_entry_t *mfib_entry;
 893     mfib_entry_src_t *msrc;
 894
 895     mfib_entry = mfib_entry_get(mfib_entry_index);
 896     current_best = mfib_entry_get_best_source(mfib_entry);
 897     msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
 898
 899     mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
 900
 901     return (mfib_entry_ok_for_delete(mfib_entry));
 902 }
 903
 904 static void
 905 mfib_entry_itf_add (mfib_entry_src_t *msrc,
 906                     u32 sw_if_index,
 907                     index_t mi)
 908 {
 909     hash_set(msrc->mfes_itfs, sw_if_index, mi);
 910 }
 911
 912 static void
 913 mfib_entry_itf_remove (mfib_entry_src_t *msrc,
 914                        u32 sw_if_index)
 915 {
 916     mfib_itf_t *mfi;
 917
 918     mfi = mfib_entry_itf_find(msrc->mfes_itfs, sw_if_index);
 919
 920     mfib_itf_delete(mfi);
 921
 922     hash_unset(msrc->mfes_itfs, sw_if_index);
 923 }
 924
 925 void
 926 mfib_entry_path_update (fib_node_index_t mfib_entry_index,
 927                         mfib_source_t source,
 928                         const fib_route_path_t *rpath,
 929                         mfib_itf_flags_t itf_flags)
 930 {
 931     fib_node_index_t path_index;
 932     mfib_source_t current_best;
 933     mfib_path_ext_t *path_ext;
 934     mfib_entry_t *mfib_entry;
 935     mfib_entry_src_t *msrc;
 936     mfib_itf_flags_t old;
 937
 938     mfib_entry = mfib_entry_get(mfib_entry_index);
 939     ASSERT(NULL != mfib_entry);
 940     current_best = mfib_entry_get_best_source(mfib_entry);
 941     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 942
 943     /*
 944      * add the path to the path-list. If it's a duplicate we'll get
 945      * back the original path.
 946      */
 947     path_index = mfib_entry_src_path_add(msrc, rpath);
 948
 949     /*
 950      * find the path extension for that path
 951      */
 952     path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
 953
 954     if (NULL == path_ext)
 955     {
 956         old = MFIB_ITF_FLAG_NONE;
 957         path_ext = mfib_path_ext_add(msrc, path_index, itf_flags);
 958     }
 959     else
 960     {
 961         old = path_ext->mfpe_flags;
 962         path_ext->mfpe_flags = itf_flags;
 963     }
 964
 965     /*
 966      * Has the path changed its contribution to the input interface set.
 967      * Which only paths with interfaces can do...
 968      */
 969     if (~0 != rpath[0].frp_sw_if_index)
 970     {
 971         mfib_itf_t *mfib_itf;
 972
 973         if (old != itf_flags)
 974         {
 975             /*
 976              * change of flag contributions
 977              */
 978             mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
 979                                            rpath[0].frp_sw_if_index);
 980
 981             if (NULL == mfib_itf)
 982             {
 983                 mfib_entry_itf_add(msrc,
 984                                    rpath[0].frp_sw_if_index,
 985                                    mfib_itf_create(path_index, itf_flags));
 986             }
 987             else
 988             {
 989                 if (mfib_itf_update(mfib_itf,
 990                                     path_index,
 991                                     itf_flags))
 992                 {
 993                     /*
 994                      * no more interface flags on this path, remove
 995                      * from the data-plane set
 996                      */
 997                     mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
 998                 }
 999             }
1000         }
1001     }
1002
1003     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1004 }
1005
1006 /*
1007  * mfib_entry_path_remove
1008  *
1009  * remove a path from the entry.
1010  * return the mfib_entry's index if it is still present, INVALID otherwise.
1011  */
1012 int
1013 mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
1014                         mfib_source_t source,
1015                         const fib_route_path_t *rpath)
1016 {
1017     fib_node_index_t path_index;
1018     mfib_source_t current_best;
1019     mfib_entry_t *mfib_entry;
1020     mfib_entry_src_t *msrc;
1021
1022     mfib_entry = mfib_entry_get(mfib_entry_index);
1023     ASSERT(NULL != mfib_entry);
1024     current_best = mfib_entry_get_best_source(mfib_entry);
1025     msrc = mfib_entry_src_find(mfib_entry, source, NULL);
1026
1027     if (NULL == msrc)
1028     {
1029         /*
1030          * there are no paths left for this source
1031          */
1032         return (mfib_entry_ok_for_delete(mfib_entry));
1033     }
1034
1035     /*
1036      * remove the path from the path-list. If it's not there we'll get
1037      * back invalid
1038      */
1039     path_index = mfib_entry_src_path_remove(msrc, rpath);
1040
1041     if (FIB_NODE_INDEX_INVALID != path_index)
1042     {
1043         /*
1044          * don't need the extension, nor the interface anymore
1045          */
1046         mfib_path_ext_remove(msrc, path_index);
1047         if (~0 != rpath[0].frp_sw_if_index)
1048         {
1049             mfib_itf_t *mfib_itf;
1050
1051             mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
1052                                            rpath[0].frp_sw_if_index);
1053
1054             if (mfib_itf_update(mfib_itf,
1055                                 path_index,
1056                                 MFIB_ITF_FLAG_NONE))
1057             {
1058                 /*
1059                  * no more interface flags on this path, remove
1060                  * from the data-plane set
1061                  */
1062                 mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
1063             }
1064         }
1065     }
1066
1067     if (mfib_entry_src_ok_for_delete(msrc))
1068     {
1069         /*
1070          * this source has no interfaces and no flags.
1071          * it has nothing left to give - remove it
1072          */
1073         mfib_entry_src_remove(mfib_entry, source);
1074     }
1075
1076     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1077
1078     return (mfib_entry_ok_for_delete(mfib_entry));
1079 }
1080
1081 /**
1082  * mfib_entry_delete
1083  *
1084  * The source is withdrawing all the paths it provided
1085  */
1086 int
1087 mfib_entry_delete (fib_node_index_t mfib_entry_index,
1088                    mfib_source_t source)
1089 {
1090     mfib_source_t current_best;
1091     mfib_entry_t *mfib_entry;
1092
1093     mfib_entry = mfib_entry_get(mfib_entry_index);
1094     current_best = mfib_entry_get_best_source(mfib_entry);
1095     mfib_entry_src_remove(mfib_entry, source);
1096
1097     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1098
1099     return (mfib_entry_ok_for_delete(mfib_entry));
1100 }
1101
1102 static int
1103 fib_ip4_address_compare (ip4_address_t * a1,
1104                          ip4_address_t * a2)
1105 {
1106     /*
1107      * IP addresses are unsiged ints. the return value here needs to be signed
1108      * a simple subtraction won't cut it.
1109      * If the addresses are the same, the sort order is undefiend, so phoey.
1110      */
1111     return ((clib_net_to_host_u32(a1->data_u32) >
1112              clib_net_to_host_u32(a2->data_u32) ) ?
1113             1 : -1);
1114 }
1115
1116 static int
1117 fib_ip6_address_compare (ip6_address_t * a1,
1118                          ip6_address_t * a2)
1119 {
1120   int i;
1121   for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1122   {
1123       int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1124                  clib_net_to_host_u16 (a2->as_u16[i]));
1125       if (cmp != 0)
1126           return cmp;
1127   }
1128   return 0;
1129 }
1130
1131 static int
1132 mfib_entry_cmp (fib_node_index_t mfib_entry_index1,
1133                 fib_node_index_t mfib_entry_index2)
1134 {
1135     mfib_entry_t *mfib_entry1, *mfib_entry2;
1136     int cmp = 0;
1137
1138     mfib_entry1 = mfib_entry_get(mfib_entry_index1);
1139     mfib_entry2 = mfib_entry_get(mfib_entry_index2);
1140
1141     switch (mfib_entry1->mfe_prefix.fp_proto)
1142     {
1143     case FIB_PROTOCOL_IP4:
1144         cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip4,
1145                                       &mfib_entry2->mfe_prefix.fp_grp_addr.ip4);
1146
1147         if (0 == cmp)
1148         {
1149             cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip4,
1150                                           &mfib_entry2->mfe_prefix.fp_src_addr.ip4);
1151         }
1152         break;
1153     case FIB_PROTOCOL_IP6:
1154         cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip6,
1155                                       &mfib_entry2->mfe_prefix.fp_grp_addr.ip6);
1156
1157         if (0 == cmp)
1158         {
1159             cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip6,
1160                                           &mfib_entry2->mfe_prefix.fp_src_addr.ip6);
1161         }
1162         break;
1163     case FIB_PROTOCOL_MPLS:
1164         ASSERT(0);
1165         cmp = 0;
1166         break;
1167     }
1168
1169     if (0 == cmp) {
1170         cmp = (mfib_entry1->mfe_prefix.fp_len - mfib_entry2->mfe_prefix.fp_len);
1171     }
1172     return (cmp);
1173 }
1174
1175 int
1176 mfib_entry_cmp_for_sort (void *i1, void *i2)
1177 {
1178     fib_node_index_t *mfib_entry_index1 = i1, *mfib_entry_index2 = i2;
1179
1180     return (mfib_entry_cmp(*mfib_entry_index1,
1181                            *mfib_entry_index2));
1182 }
1183
1184 static void
1185 mfib_entry_last_lock_gone (fib_node_t *node)
1186 {
1187     mfib_entry_t *mfib_entry;
1188     mfib_entry_src_t *msrc;
1189
1190     mfib_entry = mfib_entry_from_fib_node(node);
1191
1192     dpo_reset(&mfib_entry->mfe_rep);
1193
1194     MFIB_ENTRY_DBG(mfib_entry, "last-lock");
1195
1196     vec_foreach(msrc, mfib_entry->mfe_srcs)
1197     {
1198         mfib_entry_src_flush(msrc);
1199     }
1200
1201     vec_free(mfib_entry->mfe_srcs);
1202
1203     fib_node_deinit(&mfib_entry->mfe_node);
1204     pool_put(mfib_entry_pool, mfib_entry);
1205 }
1206
1207 u32
1208 mfib_entry_get_stats_index (fib_node_index_t fib_entry_index)
1209 {
1210     mfib_entry_t *mfib_entry;
1211
1212     mfib_entry = mfib_entry_get(fib_entry_index);
1213
1214     return (mfib_entry->mfe_rep.dpoi_index);
1215 }
1216
1217 /*
1218  * mfib_entry_back_walk_notify
1219  *
1220  * A back walk has reach this entry.
1221  */
1222 static fib_node_back_walk_rc_t
1223 mfib_entry_back_walk_notify (fib_node_t *node,
1224                             fib_node_back_walk_ctx_t *ctx)
1225 {
1226     mfib_entry_t *mfib_entry;
1227
1228     mfib_entry = mfib_entry_from_fib_node(node);
1229     mfib_entry_recalculate_forwarding(mfib_entry,
1230                                       mfib_entry_get_best_source(mfib_entry));
1231
1232     return (FIB_NODE_BACK_WALK_CONTINUE);
1233 }
1234
1235 static void
1236 mfib_entry_show_memory (void)
1237 {
1238     fib_show_memory_usage("multicast-Entry",
1239                           pool_elts(mfib_entry_pool),
1240                           pool_len(mfib_entry_pool),
1241                           sizeof(mfib_entry_t));
1242 }
1243
1244 /*
1245  * The MFIB entry's graph node virtual function table
1246  */
1247 static const fib_node_vft_t mfib_entry_vft = {
1248     .fnv_get = mfib_entry_get_node,
1249     .fnv_last_lock = mfib_entry_last_lock_gone,
1250     .fnv_back_walk = mfib_entry_back_walk_notify,
1251     .fnv_mem_show = mfib_entry_show_memory,
1252 };
1253
1254 void
1255 mfib_entry_lock (fib_node_index_t mfib_entry_index)
1256 {
1257     mfib_entry_t *mfib_entry;
1258
1259     mfib_entry = mfib_entry_get(mfib_entry_index);
1260
1261     fib_node_lock(&mfib_entry->mfe_node);
1262 }
1263
1264 void
1265 mfib_entry_unlock (fib_node_index_t mfib_entry_index)
1266 {
1267     mfib_entry_t *mfib_entry;
1268
1269     mfib_entry = mfib_entry_get(mfib_entry_index);
1270
1271     fib_node_unlock(&mfib_entry->mfe_node);
1272 }
1273
1274 static void
1275 mfib_entry_dpo_lock (dpo_id_t *dpo)
1276 {
1277 }
1278 static void
1279 mfib_entry_dpo_unlock (dpo_id_t *dpo)
1280 {
1281 }
1282
1283 const static dpo_vft_t mfib_entry_dpo_vft = {
1284     .dv_lock = mfib_entry_dpo_lock,
1285     .dv_unlock = mfib_entry_dpo_unlock,
1286     .dv_format = format_mfib_entry_dpo,
1287     .dv_mem_show = mfib_entry_show_memory,
1288 };
1289
1290 const static char* const mfib_entry_ip4_nodes[] =
1291 {
1292     "ip4-mfib-forward-rpf",
1293     NULL,
1294 };
1295 const static char* const mfib_entry_ip6_nodes[] =
1296 {
1297     "ip6-mfib-forward-rpf",
1298     NULL,
1299 };
1300
1301 const static char* const * const mfib_entry_nodes[DPO_PROTO_NUM] =
1302 {
1303     [DPO_PROTO_IP4]  = mfib_entry_ip4_nodes,
1304     [DPO_PROTO_IP6]  = mfib_entry_ip6_nodes,
1305 };
1306
1307 void
1308 mfib_entry_module_init (void)
1309 {
1310     fib_node_register_type (FIB_NODE_TYPE_MFIB_ENTRY, &mfib_entry_vft);
1311     dpo_register(DPO_MFIB_ENTRY, &mfib_entry_dpo_vft, mfib_entry_nodes);
1312     mfib_entry_logger = vlib_log_register_class("mfib", "entry");
1313 }
1314
1315 void
1316 mfib_entry_encode (fib_node_index_t mfib_entry_index,
1317                   fib_route_path_encode_t **api_rpaths)
1318 {
1319     mfib_entry_t *mfib_entry;
1320     mfib_entry_src_t *bsrc;
1321
1322     mfib_entry = mfib_entry_get(mfib_entry_index);
1323     bsrc = mfib_entry_get_best_src(mfib_entry);
1324
1325     if (FIB_NODE_INDEX_INVALID != bsrc->mfes_pl)
1326     {
1327         fib_path_list_walk_w_ext(bsrc->mfes_pl,
1328                                  NULL,
1329                                  fib_path_encode,
1330                                  api_rpaths);
1331     }
1332 }
1333
1334 const mfib_prefix_t *
1335 mfib_entry_get_prefix (fib_node_index_t mfib_entry_index)
1336 {
1337     mfib_entry_t *mfib_entry;
1338
1339     mfib_entry = mfib_entry_get(mfib_entry_index);
1340
1341     return (&mfib_entry->mfe_prefix);
1342 }
1343
1344 u32
1345 mfib_entry_get_fib_index (fib_node_index_t mfib_entry_index)
1346 {
1347     mfib_entry_t *mfib_entry;
1348
1349     mfib_entry = mfib_entry_get(mfib_entry_index);
1350
1351     return (mfib_entry->mfe_fib_index);
1352 }
1353
1354 const dpo_id_t*
1355 mfib_entry_contribute_ip_forwarding (fib_node_index_t mfib_entry_index)
1356 {
1357     mfib_entry_t *mfib_entry;
1358
1359     mfib_entry = mfib_entry_get(mfib_entry_index);
1360
1361     return (&mfib_entry->mfe_rep);
1362 }
1363
1364 void
1365 mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
1366                                   fib_forward_chain_type_t type,
1367                                   mfib_entry_fwd_flags_t flags,
1368                                   dpo_id_t *dpo)
1369 {
1370     /*
1371      * An IP mFIB entry can only provide a forwarding chain that
1372      * is the same IP proto as the prefix.
1373      * No use-cases (i know of) for other combinations.
1374      */
1375     mfib_entry_t *mfib_entry;
1376     dpo_proto_t dp;
1377
1378     mfib_entry = mfib_entry_get(mfib_entry_index);
1379
1380     dp = fib_proto_to_dpo(mfib_entry->mfe_prefix.fp_proto);
1381
1382     if (type == mfib_forw_chain_type_from_dpo_proto(dp))
1383     {
1384         replicate_t * rep;
1385
1386         rep = replicate_get(mfib_entry->mfe_rep.dpoi_index);
1387
1388         if ((rep->rep_flags & REPLICATE_FLAGS_HAS_LOCAL) &&
1389             (flags & MFIB_ENTRY_FWD_FLAG_NO_LOCAL))
1390         {
1391             /*
1392              * caller does not want the local paths that the entry has
1393              */
1394             dpo_set(dpo, DPO_REPLICATE, rep->rep_proto,
1395                     replicate_dup(REPLICATE_FLAGS_NONE,
1396                                   mfib_entry->mfe_rep.dpoi_index));
1397         }
1398         else
1399         {
1400             dpo_copy(dpo, &mfib_entry->mfe_rep);
1401         }
1402     }
1403     else
1404     {
1405         dpo_copy(dpo, drop_dpo_get(dp));
1406     }
1407 }
1408
1409 /*
1410  * fib_entry_cover_changed
1411  *
1412  * this entry is tracking its cover and that cover has changed.
1413  */
1414 void
1415 mfib_entry_cover_changed (fib_node_index_t mfib_entry_index)
1416 {
1417     mfib_entry_t *mfib_entry;
1418     mfib_entry_src_t *msrc;
1419     mfib_src_res_t res;
1420
1421     mfib_entry = mfib_entry_get(mfib_entry_index);
1422     msrc = mfib_entry_get_best_src(mfib_entry);
1423
1424     res = mfib_entry_src_cover_change(mfib_entry, msrc);
1425
1426     if (MFIB_SRC_REEVALUATE == res)
1427     {
1428         mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
1429     }
1430     MFIB_ENTRY_DBG(mfib_entry, "cover-changed");
1431 }
1432
1433 /*
1434  * mfib_entry_cover_updated
1435  *
1436  * this entry is tracking its cover and that cover has been updated
1437  * (i.e. its forwarding information has changed).
1438  */
1439 void
1440 mfib_entry_cover_updated (fib_node_index_t mfib_entry_index)
1441 {
1442     mfib_entry_t *mfib_entry;
1443     mfib_entry_src_t *msrc;
1444     mfib_src_res_t res;
1445
1446     mfib_entry = mfib_entry_get(mfib_entry_index);
1447     msrc = mfib_entry_get_best_src(mfib_entry);
1448
1449     res = mfib_entry_src_cover_update(mfib_entry, msrc);
1450
1451     if (MFIB_SRC_REEVALUATE == res)
1452     {
1453         mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
1454     }
1455     MFIB_ENTRY_DBG(mfib_entry, "cover-updated");
1456 }
1457
1458 u32
1459 mfib_entry_pool_size (void)
1460 {
1461     return (pool_elts(mfib_entry_pool));
1462 }
1463
1464 static clib_error_t *
1465 show_mfib_entry_command (vlib_main_t * vm,
1466                         unformat_input_t * input,
1467                         vlib_cli_command_t * cmd)
1468 {
1469     fib_node_index_t fei;
1470
1471     if (unformat (input, "%d", &fei))
1472     {
1473         /*
1474          * show one in detail
1475          */
1476         if (!pool_is_free_index(mfib_entry_pool, fei))
1477         {
1478             vlib_cli_output (vm, "%d@%U",
1479                              fei,
1480                              format_mfib_entry, fei,
1481                              MFIB_ENTRY_FORMAT_DETAIL2);
1482         }
1483         else
1484         {
1485             vlib_cli_output (vm, "entry %d invalid", fei);
1486         }
1487     }
1488     else
1489     {
1490         /*
1491          * show all
1492          */
1493         vlib_cli_output (vm, "FIB Entries:");
1494         pool_foreach_index(fei, mfib_entry_pool,
1495         ({
1496             vlib_cli_output (vm, "%d@%U",
1497                              fei,
1498                              format_mfib_entry, fei,
1499                              MFIB_ENTRY_FORMAT_BRIEF);
1500         }));
1501     }
1502
1503     return (NULL);
1504 }
1505
1506 /*?
1507  * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique
1508  * numerical indentifier.
1509  ?*/
1510 VLIB_CLI_COMMAND (show_mfib_entry, static) = {
1511   .path = "show mfib entry",
1512   .function = show_mfib_entry_command,
1513   .short_help = "show mfib entry",
1514 };