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              * which we stashed in the 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             if (NULL != ctx.next_hops)
 642             {
 643                 dpo_stack(DPO_MFIB_ENTRY, dp,
 644                           &mfib_entry->mfe_rep,
 645                           &ctx.next_hops[0].path_dpo);
 646                 dpo_reset(&ctx.next_hops[0].path_dpo);
 647                 vec_free(ctx.next_hops);
 648             }
 649             else
 650             {
 651                 dpo_stack(DPO_MFIB_ENTRY, dp,
 652                           &mfib_entry->mfe_rep,
 653                           drop_dpo_get(dp));
 654             }
 655         }
 656     }
 657     else
 658     {
 659         dpo_stack(DPO_MFIB_ENTRY, dp,
 660                   &mfib_entry->mfe_rep,
 661                   drop_dpo_get(dp));
 662     }
 663
 664     /*
 665      * time for walkies fido.
 666      */
 667     fib_node_back_walk_ctx_t bw_ctx = {
 668         .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
 669     };
 670
 671     fib_walk_sync(FIB_NODE_TYPE_MFIB_ENTRY,
 672                   mfib_entry_get_index(mfib_entry),
 673                   &bw_ctx);
 674 }
 675
 676 static fib_node_index_t*
 677 mfib_entry_src_paths_add (mfib_entry_src_t *msrc,
 678                           const fib_route_path_t *rpaths)
 679 {
 680     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
 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     return (fib_path_list_paths_add(msrc->mfes_pl, rpaths));
 691 }
 692
 693 static fib_node_index_t*
 694 mfib_entry_src_paths_remove (mfib_entry_src_t *msrc,
 695                              const fib_route_path_t *rpaths)
 696 {
 697     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
 698
 699     return (fib_path_list_paths_remove(msrc->mfes_pl, rpaths));
 700 }
 701
 702 static void
 703 mfib_entry_recalculate_forwarding (mfib_entry_t *mfib_entry,
 704                                    mfib_source_t old_best)
 705 {
 706     mfib_entry_src_t *bsrc, *osrc;
 707
 708     /*
 709      * copy the forwarding data from the bast source
 710      */
 711     bsrc = mfib_entry_get_best_src(mfib_entry);
 712     osrc = mfib_entry_src_find(mfib_entry, old_best, NULL);
 713
 714     if (NULL != bsrc)
 715     {
 716         if (bsrc->mfes_src != old_best)
 717         {
 718             /*
 719              * we are changing from one source to another
 720              * deactivate the old, and activate the new
 721              */
 722             mfib_entry_src_deactivate(mfib_entry, osrc);
 723             mfib_entry_src_activate(mfib_entry, bsrc);
 724         }
 725     }
 726     else
 727     {
 728         mfib_entry_src_deactivate(mfib_entry, osrc);
 729     }
 730
 731     mfib_entry_stack(mfib_entry, bsrc);
 732     mfib_entry_cover_update_notify(mfib_entry);
 733 }
 734
 735
 736 fib_node_index_t
 737 mfib_entry_create (u32 fib_index,
 738                    mfib_source_t source,
 739                    const mfib_prefix_t *prefix,
 740                    fib_rpf_id_t rpf_id,
 741                    mfib_entry_flags_t entry_flags,
 742                    index_t repi)
 743 {
 744     fib_node_index_t mfib_entry_index;
 745     mfib_entry_t *mfib_entry;
 746     mfib_entry_src_t *msrc;
 747
 748     mfib_entry = mfib_entry_alloc(fib_index, prefix,
 749                                   &mfib_entry_index);
 750     msrc = mfib_entry_src_update(mfib_entry, source,
 751                                  rpf_id, entry_flags);
 752
 753     if (INDEX_INVALID != repi)
 754     {
 755         /*
 756          * The source is providing its own replicate DPO.
 757          * Create a sepcial path-list to manage it, that way
 758          * this entry and the source are equivalent to a normal
 759          * entry
 760          */
 761         fib_node_index_t old_pl_index;
 762         dpo_proto_t dp;
 763         dpo_id_t dpo = DPO_INVALID;
 764
 765         dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 766         old_pl_index = msrc->mfes_pl;
 767
 768         dpo_set(&dpo, DPO_REPLICATE, dp, repi);
 769
 770         msrc->mfes_pl =
 771             fib_path_list_create_special(dp,
 772                                          FIB_PATH_LIST_FLAG_EXCLUSIVE,
 773                                          &dpo);
 774
 775         dpo_reset(&dpo);
 776         fib_path_list_lock(msrc->mfes_pl);
 777         fib_path_list_unlock(old_pl_index);
 778     }
 779
 780     mfib_entry_recalculate_forwarding(mfib_entry, MFIB_SOURCE_NONE);
 781
 782     return (mfib_entry_index);
 783 }
 784
 785 static int
 786 mfib_entry_ok_for_delete (mfib_entry_t *mfib_entry)
 787 {
 788     return (0 == vec_len(mfib_entry->mfe_srcs));
 789 }
 790
 791 static int
 792 mfib_entry_src_ok_for_delete (const mfib_entry_src_t *msrc)
 793 {
 794     return ((INDEX_INVALID == msrc->mfes_cover &&
 795              MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags &&
 796              0 == fib_path_list_get_n_paths(msrc->mfes_pl)) &&
 797             (0 == hash_elts(msrc->mfes_itfs)));
 798
 799     /* return ((MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags) && */
 800     /*         (0 == fib_path_list_get_n_paths(msrc->mfes_pl)) && */
 801     /*         (0 == hash_elts(msrc->mfes_itfs))); */
 802 }
 803
 804
 805 static void
 806 mfib_entry_update_i (mfib_entry_t *mfib_entry,
 807                      mfib_entry_src_t *msrc,
 808                      mfib_source_t current_best,
 809                      index_t repi)
 810 {
 811     if (INDEX_INVALID != repi)
 812     {
 813         /*
 814          * The source is providing its own replicate DPO.
 815          * Create a sepcial path-list to manage it, that way
 816          * this entry and the source are equivalent to a normal
 817          * entry
 818          */
 819         fib_node_index_t old_pl_index;
 820         dpo_proto_t dp;
 821         dpo_id_t dpo = DPO_INVALID;
 822
 823         dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 824         old_pl_index = msrc->mfes_pl;
 825
 826         dpo_set(&dpo, DPO_REPLICATE, dp, repi);
 827
 828         msrc->mfes_pl =
 829             fib_path_list_create_special(dp,
 830                                          FIB_PATH_LIST_FLAG_EXCLUSIVE,
 831                                          &dpo);
 832
 833         dpo_reset(&dpo);
 834         fib_path_list_lock(msrc->mfes_pl);
 835         fib_path_list_unlock(old_pl_index);
 836     }
 837
 838     if (mfib_entry_src_ok_for_delete(msrc))
 839     {
 840         /*
 841          * this source has no interfaces and no flags.
 842          * it has nothing left to give - remove it
 843          */
 844         mfib_entry_src_remove(mfib_entry, msrc->mfes_src);
 845     }
 846
 847     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
 848 }
 849
 850 int
 851 mfib_entry_special_add (fib_node_index_t mfib_entry_index,
 852                         mfib_source_t source,
 853                         mfib_entry_flags_t entry_flags,
 854                         fib_rpf_id_t rpf_id,
 855                         index_t repi)
 856 {
 857     mfib_source_t current_best;
 858     mfib_entry_t *mfib_entry;
 859     mfib_entry_src_t *msrc;
 860
 861     mfib_entry = mfib_entry_get(mfib_entry_index);
 862     current_best = mfib_entry_get_best_source(mfib_entry);
 863
 864     msrc = mfib_entry_src_update_and_lock(mfib_entry, source, rpf_id,
 865                                           entry_flags);
 866
 867     mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
 868
 869     return (mfib_entry_ok_for_delete(mfib_entry));
 870 }
 871
 872 int
 873 mfib_entry_update (fib_node_index_t mfib_entry_index,
 874                    mfib_source_t source,
 875                    mfib_entry_flags_t entry_flags,
 876                    fib_rpf_id_t rpf_id,
 877                    index_t repi)
 878 {
 879     mfib_source_t current_best;
 880     mfib_entry_t *mfib_entry;
 881     mfib_entry_src_t *msrc;
 882
 883     mfib_entry = mfib_entry_get(mfib_entry_index);
 884     current_best = mfib_entry_get_best_source(mfib_entry);
 885     msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
 886
 887     mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
 888
 889     return (mfib_entry_ok_for_delete(mfib_entry));
 890 }
 891
 892 static void
 893 mfib_entry_itf_add (mfib_entry_src_t *msrc,
 894                     u32 sw_if_index,
 895                     index_t mi)
 896 {
 897     hash_set(msrc->mfes_itfs, sw_if_index, mi);
 898 }
 899
 900 static void
 901 mfib_entry_itf_remove (mfib_entry_src_t *msrc,
 902                        u32 sw_if_index)
 903 {
 904     mfib_itf_t *mfi;
 905
 906     mfi = mfib_entry_itf_find(msrc->mfes_itfs, sw_if_index);
 907
 908     mfib_itf_delete(mfi);
 909
 910     hash_unset(msrc->mfes_itfs, sw_if_index);
 911 }
 912
 913 static int
 914 mfib_entry_path_itf_based (const fib_route_path_t *rpath)
 915 {
 916     return (!(rpath->frp_flags & FIB_ROUTE_PATH_BIER_IMP) &&
 917             ~0 != rpath->frp_sw_if_index);
 918 }
 919
 920 void
 921 mfib_entry_path_update (fib_node_index_t mfib_entry_index,
 922                         mfib_source_t source,
 923                         const fib_route_path_t *rpaths)
 924 {
 925     fib_node_index_t* path_indices, path_index;
 926     const fib_route_path_t *rpath;
 927     mfib_source_t current_best;
 928     mfib_path_ext_t *path_ext;
 929     mfib_entry_t *mfib_entry;
 930     mfib_entry_src_t *msrc;
 931     mfib_itf_flags_t old;
 932     u32 ii;
 933
 934     mfib_entry = mfib_entry_get(mfib_entry_index);
 935     ASSERT(NULL != mfib_entry);
 936     current_best = mfib_entry_get_best_source(mfib_entry);
 937     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 938
 939     /*
 940      * add the path to the path-list. If it's a duplicate we'll get
 941      * back the original path.
 942      */
 943     path_indices = mfib_entry_src_paths_add(msrc, rpaths);
 944
 945     vec_foreach_index(ii, path_indices)
 946     {
 947         path_index = path_indices[ii];
 948         rpath = &rpaths[ii];
 949
 950         if (FIB_NODE_INDEX_INVALID == path_index)
 951             continue;
 952
 953         /*
 954          * find the path extension for that path
 955          */
 956         path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
 957
 958         if (NULL == path_ext)
 959         {
 960             old = MFIB_ITF_FLAG_NONE;
 961             path_ext = mfib_path_ext_add(msrc, path_index,
 962                                          rpath->frp_mitf_flags);
 963         }
 964         else
 965         {
 966             old = path_ext->mfpe_flags;
 967             path_ext->mfpe_flags = rpath->frp_mitf_flags;
 968         }
 969
 970         /*
 971          * Has the path changed its contribution to the input interface set.
 972          * Which only paths with interfaces can do...
 973          */
 974         if (mfib_entry_path_itf_based(rpath))
 975         {
 976             mfib_itf_t *mfib_itf;
 977
 978             if (old != rpath->frp_mitf_flags)
 979             {
 980                 /*
 981                  * change of flag contributions
 982                  */
 983                 mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
 984                                                rpath->frp_sw_if_index);
 985
 986                 if (NULL == mfib_itf)
 987                 {
 988                     mfib_entry_itf_add(msrc,
 989                                        rpath->frp_sw_if_index,
 990                                        mfib_itf_create(path_index,
 991                                                        rpath->frp_mitf_flags));
 992                 }
 993                 else
 994                 {
 995                     if (mfib_itf_update(mfib_itf,
 996                                         path_index,
 997                                         rpath->frp_mitf_flags))
 998                     {
 999                         /*
1000                          * no more interface flags on this path, remove
1001                          * from the data-plane set
1002                          */
1003                         mfib_entry_itf_remove(msrc, rpath->frp_sw_if_index);
1004                     }
1005                 }
1006             }
1007         }
1008     }
1009     vec_free(path_indices);
1010
1011     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1012 }
1013
1014 /*
1015  * mfib_entry_path_remove
1016  *
1017  * remove a path from the entry.
1018  * return the mfib_entry's index if it is still present, INVALID otherwise.
1019  */
1020 int
1021 mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
1022                         mfib_source_t source,
1023                         const fib_route_path_t *rpaths)
1024 {
1025     fib_node_index_t path_index, *path_indices;
1026     const fib_route_path_t *rpath;
1027     mfib_source_t current_best;
1028     mfib_entry_t *mfib_entry;
1029     mfib_entry_src_t *msrc;
1030     u32 ii;
1031
1032     mfib_entry = mfib_entry_get(mfib_entry_index);
1033     ASSERT(NULL != mfib_entry);
1034     current_best = mfib_entry_get_best_source(mfib_entry);
1035     msrc = mfib_entry_src_find(mfib_entry, source, NULL);
1036
1037     if (NULL == msrc)
1038     {
1039         /*
1040          * there are no paths left for this source
1041          */
1042         return (mfib_entry_ok_for_delete(mfib_entry));
1043     }
1044
1045     /*
1046      * remove the paths from the path-list. If it's not there we'll get
1047      * back an empty vector
1048      */
1049     path_indices = mfib_entry_src_paths_remove(msrc, rpaths);
1050
1051     vec_foreach_index(ii, path_indices)
1052     {
1053         path_index = path_indices[ii];
1054         rpath = &rpaths[ii];
1055
1056         if (FIB_NODE_INDEX_INVALID == path_index)
1057             continue;
1058
1059         /*
1060          * don't need the extension, nor the interface anymore
1061          */
1062         mfib_path_ext_remove(msrc, path_index);
1063         if (mfib_entry_path_itf_based(rpath))
1064         {
1065             mfib_itf_t *mfib_itf;
1066
1067             mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
1068                                            rpath->frp_sw_if_index);
1069
1070             if (mfib_itf_update(mfib_itf,
1071                                 path_index,
1072                                 MFIB_ITF_FLAG_NONE))
1073             {
1074                 /*
1075                  * no more interface flags on this path, remove
1076                  * from the data-plane set
1077                  */
1078                 mfib_entry_itf_remove(msrc, rpath->frp_sw_if_index);
1079             }
1080         }
1081
1082         if (mfib_entry_src_ok_for_delete(msrc))
1083         {
1084             /*
1085              * this source has no interfaces and no flags.
1086              * it has nothing left to give - remove it
1087              */
1088             mfib_entry_src_remove(mfib_entry, source);
1089         }
1090     }
1091     vec_free(path_indices);
1092
1093     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1094
1095     return (mfib_entry_ok_for_delete(mfib_entry));
1096 }
1097
1098 /**
1099  * mfib_entry_delete
1100  *
1101  * The source is withdrawing all the paths it provided
1102  */
1103 int
1104 mfib_entry_delete (fib_node_index_t mfib_entry_index,
1105                    mfib_source_t source)
1106 {
1107     mfib_source_t current_best;
1108     mfib_entry_t *mfib_entry;
1109
1110     mfib_entry = mfib_entry_get(mfib_entry_index);
1111     current_best = mfib_entry_get_best_source(mfib_entry);
1112     mfib_entry_src_remove(mfib_entry, source);
1113
1114     mfib_entry_recalculate_forwarding(mfib_entry, current_best);
1115
1116     return (mfib_entry_ok_for_delete(mfib_entry));
1117 }
1118
1119 static int
1120 fib_ip4_address_compare (ip4_address_t * a1,
1121                          ip4_address_t * a2)
1122 {
1123     /*
1124      * IP addresses are unsiged ints. the return value here needs to be signed
1125      * a simple subtraction won't cut it.
1126      * If the addresses are the same, the sort order is undefiend, so phoey.
1127      */
1128     return ((clib_net_to_host_u32(a1->data_u32) >
1129              clib_net_to_host_u32(a2->data_u32) ) ?
1130             1 : -1);
1131 }
1132
1133 static int
1134 fib_ip6_address_compare (ip6_address_t * a1,
1135                          ip6_address_t * a2)
1136 {
1137   int i;
1138   for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1139   {
1140       int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1141                  clib_net_to_host_u16 (a2->as_u16[i]));
1142       if (cmp != 0)
1143           return cmp;
1144   }
1145   return 0;
1146 }
1147
1148 static int
1149 mfib_entry_cmp (fib_node_index_t mfib_entry_index1,
1150                 fib_node_index_t mfib_entry_index2)
1151 {
1152     mfib_entry_t *mfib_entry1, *mfib_entry2;
1153     int cmp = 0;
1154
1155     mfib_entry1 = mfib_entry_get(mfib_entry_index1);
1156     mfib_entry2 = mfib_entry_get(mfib_entry_index2);
1157
1158     switch (mfib_entry1->mfe_prefix.fp_proto)
1159     {
1160     case FIB_PROTOCOL_IP4:
1161         cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip4,
1162                                       &mfib_entry2->mfe_prefix.fp_grp_addr.ip4);
1163
1164         if (0 == cmp)
1165         {
1166             cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip4,
1167                                           &mfib_entry2->mfe_prefix.fp_src_addr.ip4);
1168         }
1169         break;
1170     case FIB_PROTOCOL_IP6:
1171         cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip6,
1172                                       &mfib_entry2->mfe_prefix.fp_grp_addr.ip6);
1173
1174         if (0 == cmp)
1175         {
1176             cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip6,
1177                                           &mfib_entry2->mfe_prefix.fp_src_addr.ip6);
1178         }
1179         break;
1180     case FIB_PROTOCOL_MPLS:
1181         ASSERT(0);
1182         cmp = 0;
1183         break;
1184     }
1185
1186     if (0 == cmp) {
1187         cmp = (mfib_entry1->mfe_prefix.fp_len - mfib_entry2->mfe_prefix.fp_len);
1188     }
1189     return (cmp);
1190 }
1191
1192 int
1193 mfib_entry_cmp_for_sort (void *i1, void *i2)
1194 {
1195     fib_node_index_t *mfib_entry_index1 = i1, *mfib_entry_index2 = i2;
1196
1197     return (mfib_entry_cmp(*mfib_entry_index1,
1198                            *mfib_entry_index2));
1199 }
1200
1201 static void
1202 mfib_entry_last_lock_gone (fib_node_t *node)
1203 {
1204     mfib_entry_t *mfib_entry;
1205     mfib_entry_src_t *msrc;
1206
1207     mfib_entry = mfib_entry_from_fib_node(node);
1208
1209     dpo_reset(&mfib_entry->mfe_rep);
1210
1211     MFIB_ENTRY_DBG(mfib_entry, "last-lock");
1212
1213     vec_foreach(msrc, mfib_entry->mfe_srcs)
1214     {
1215         mfib_entry_src_flush(msrc);
1216     }
1217
1218     vec_free(mfib_entry->mfe_srcs);
1219
1220     fib_node_deinit(&mfib_entry->mfe_node);
1221     pool_put(mfib_entry_pool, mfib_entry);
1222 }
1223
1224 u32
1225 mfib_entry_get_stats_index (fib_node_index_t fib_entry_index)
1226 {
1227     mfib_entry_t *mfib_entry;
1228
1229     mfib_entry = mfib_entry_get(fib_entry_index);
1230
1231     return (mfib_entry->mfe_rep.dpoi_index);
1232 }
1233
1234 /*
1235  * mfib_entry_back_walk_notify
1236  *
1237  * A back walk has reach this entry.
1238  */
1239 static fib_node_back_walk_rc_t
1240 mfib_entry_back_walk_notify (fib_node_t *node,
1241                             fib_node_back_walk_ctx_t *ctx)
1242 {
1243     mfib_entry_t *mfib_entry;
1244
1245     mfib_entry = mfib_entry_from_fib_node(node);
1246     mfib_entry_recalculate_forwarding(mfib_entry,
1247                                       mfib_entry_get_best_source(mfib_entry));
1248
1249     return (FIB_NODE_BACK_WALK_CONTINUE);
1250 }
1251
1252 static void
1253 mfib_entry_show_memory (void)
1254 {
1255     fib_show_memory_usage("multicast-Entry",
1256                           pool_elts(mfib_entry_pool),
1257                           pool_len(mfib_entry_pool),
1258                           sizeof(mfib_entry_t));
1259 }
1260
1261 /*
1262  * The MFIB entry's graph node virtual function table
1263  */
1264 static const fib_node_vft_t mfib_entry_vft = {
1265     .fnv_get = mfib_entry_get_node,
1266     .fnv_last_lock = mfib_entry_last_lock_gone,
1267     .fnv_back_walk = mfib_entry_back_walk_notify,
1268     .fnv_mem_show = mfib_entry_show_memory,
1269 };
1270
1271 void
1272 mfib_entry_lock (fib_node_index_t mfib_entry_index)
1273 {
1274     mfib_entry_t *mfib_entry;
1275
1276     mfib_entry = mfib_entry_get(mfib_entry_index);
1277
1278     fib_node_lock(&mfib_entry->mfe_node);
1279 }
1280
1281 void
1282 mfib_entry_unlock (fib_node_index_t mfib_entry_index)
1283 {
1284     mfib_entry_t *mfib_entry;
1285
1286     mfib_entry = mfib_entry_get(mfib_entry_index);
1287
1288     fib_node_unlock(&mfib_entry->mfe_node);
1289 }
1290
1291 static void
1292 mfib_entry_dpo_lock (dpo_id_t *dpo)
1293 {
1294 }
1295 static void
1296 mfib_entry_dpo_unlock (dpo_id_t *dpo)
1297 {
1298 }
1299
1300 const static dpo_vft_t mfib_entry_dpo_vft = {
1301     .dv_lock = mfib_entry_dpo_lock,
1302     .dv_unlock = mfib_entry_dpo_unlock,
1303     .dv_format = format_mfib_entry_dpo,
1304     .dv_mem_show = mfib_entry_show_memory,
1305 };
1306
1307 const static char* const mfib_entry_ip4_nodes[] =
1308 {
1309     "ip4-mfib-forward-rpf",
1310     NULL,
1311 };
1312 const static char* const mfib_entry_ip6_nodes[] =
1313 {
1314     "ip6-mfib-forward-rpf",
1315     NULL,
1316 };
1317
1318 const static char* const * const mfib_entry_nodes[DPO_PROTO_NUM] =
1319 {
1320     [DPO_PROTO_IP4]  = mfib_entry_ip4_nodes,
1321     [DPO_PROTO_IP6]  = mfib_entry_ip6_nodes,
1322 };
1323
1324 void
1325 mfib_entry_module_init (void)
1326 {
1327     fib_node_register_type (FIB_NODE_TYPE_MFIB_ENTRY, &mfib_entry_vft);
1328     dpo_register(DPO_MFIB_ENTRY, &mfib_entry_dpo_vft, mfib_entry_nodes);
1329     mfib_entry_logger = vlib_log_register_class("mfib", "entry");
1330 }
1331
1332 fib_route_path_t*
1333 mfib_entry_encode (fib_node_index_t mfib_entry_index)
1334 {
1335     fib_path_encode_ctx_t ctx = {
1336         .rpaths = NULL,
1337     };
1338     mfib_entry_t *mfib_entry;
1339     fib_route_path_t *rpath;
1340     mfib_entry_src_t *bsrc;
1341
1342     mfib_entry = mfib_entry_get(mfib_entry_index);
1343     bsrc = mfib_entry_get_best_src(mfib_entry);
1344
1345     if (FIB_NODE_INDEX_INVALID != bsrc->mfes_pl)
1346     {
1347         fib_path_list_walk_w_ext(bsrc->mfes_pl,
1348                                  NULL,
1349                                  fib_path_encode,
1350                                  &ctx);
1351     }
1352
1353     vec_foreach(rpath, ctx.rpaths)
1354     {
1355         mfib_itf_t *mfib_itf;
1356
1357         mfib_itf = mfib_entry_itf_find(bsrc->mfes_itfs,
1358                                        rpath->frp_sw_if_index);
1359         if (mfib_itf)
1360         {
1361             rpath->frp_mitf_flags = mfib_itf->mfi_flags;
1362         }
1363     }
1364
1365     return (ctx.rpaths);
1366 }
1367
1368 const mfib_prefix_t *
1369 mfib_entry_get_prefix (fib_node_index_t mfib_entry_index)
1370 {
1371     mfib_entry_t *mfib_entry;
1372
1373     mfib_entry = mfib_entry_get(mfib_entry_index);
1374
1375     return (&mfib_entry->mfe_prefix);
1376 }
1377
1378 u32
1379 mfib_entry_get_fib_index (fib_node_index_t mfib_entry_index)
1380 {
1381     mfib_entry_t *mfib_entry;
1382
1383     mfib_entry = mfib_entry_get(mfib_entry_index);
1384
1385     return (mfib_entry->mfe_fib_index);
1386 }
1387
1388 const dpo_id_t*
1389 mfib_entry_contribute_ip_forwarding (fib_node_index_t mfib_entry_index)
1390 {
1391     mfib_entry_t *mfib_entry;
1392
1393     mfib_entry = mfib_entry_get(mfib_entry_index);
1394
1395     return (&mfib_entry->mfe_rep);
1396 }
1397
1398 void
1399 mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
1400                                   fib_forward_chain_type_t type,
1401                                   mfib_entry_fwd_flags_t flags,
1402                                   dpo_id_t *dpo)
1403 {
1404     /*
1405      * An IP mFIB entry can only provide a forwarding chain that
1406      * is the same IP proto as the prefix.
1407      * No use-cases (i know of) for other combinations.
1408      */
1409     mfib_entry_t *mfib_entry;
1410     dpo_proto_t dp;
1411
1412     mfib_entry = mfib_entry_get(mfib_entry_index);
1413
1414     dp = fib_proto_to_dpo(mfib_entry->mfe_prefix.fp_proto);
1415
1416     if (type == mfib_forw_chain_type_from_dpo_proto(dp))
1417     {
1418         replicate_t * rep;
1419
1420         rep = replicate_get(mfib_entry->mfe_rep.dpoi_index);
1421
1422         if ((rep->rep_flags & REPLICATE_FLAGS_HAS_LOCAL) &&
1423             (flags & MFIB_ENTRY_FWD_FLAG_NO_LOCAL))
1424         {
1425             /*
1426              * caller does not want the local paths that the entry has
1427              */
1428             dpo_set(dpo, DPO_REPLICATE, rep->rep_proto,
1429                     replicate_dup(REPLICATE_FLAGS_NONE,
1430                                   mfib_entry->mfe_rep.dpoi_index));
1431         }
1432         else
1433         {
1434             dpo_copy(dpo, &mfib_entry->mfe_rep);
1435         }
1436     }
1437     else
1438     {
1439         dpo_copy(dpo, drop_dpo_get(dp));
1440     }
1441 }
1442
1443 /*
1444  * fib_entry_cover_changed
1445  *
1446  * this entry is tracking its cover and that cover has changed.
1447  */
1448 void
1449 mfib_entry_cover_changed (fib_node_index_t mfib_entry_index)
1450 {
1451     mfib_entry_t *mfib_entry;
1452     mfib_entry_src_t *msrc;
1453     mfib_src_res_t res;
1454
1455     mfib_entry = mfib_entry_get(mfib_entry_index);
1456     msrc = mfib_entry_get_best_src(mfib_entry);
1457
1458     res = mfib_entry_src_cover_change(mfib_entry, msrc);
1459
1460     if (MFIB_SRC_REEVALUATE == res)
1461     {
1462         mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
1463     }
1464     MFIB_ENTRY_DBG(mfib_entry, "cover-changed");
1465 }
1466
1467 /*
1468  * mfib_entry_cover_updated
1469  *
1470  * this entry is tracking its cover and that cover has been updated
1471  * (i.e. its forwarding information has changed).
1472  */
1473 void
1474 mfib_entry_cover_updated (fib_node_index_t mfib_entry_index)
1475 {
1476     mfib_entry_t *mfib_entry;
1477     mfib_entry_src_t *msrc;
1478     mfib_src_res_t res;
1479
1480     mfib_entry = mfib_entry_get(mfib_entry_index);
1481     msrc = mfib_entry_get_best_src(mfib_entry);
1482
1483     res = mfib_entry_src_cover_update(mfib_entry, msrc);
1484
1485     if (MFIB_SRC_REEVALUATE == res)
1486     {
1487         mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
1488     }
1489     MFIB_ENTRY_DBG(mfib_entry, "cover-updated");
1490 }
1491
1492 u32
1493 mfib_entry_pool_size (void)
1494 {
1495     return (pool_elts(mfib_entry_pool));
1496 }
1497
1498 static clib_error_t *
1499 show_mfib_entry_command (vlib_main_t * vm,
1500                         unformat_input_t * input,
1501                         vlib_cli_command_t * cmd)
1502 {
1503     fib_node_index_t fei;
1504
1505     if (unformat (input, "%d", &fei))
1506     {
1507         /*
1508          * show one in detail
1509          */
1510         if (!pool_is_free_index(mfib_entry_pool, fei))
1511         {
1512             vlib_cli_output (vm, "%d@%U",
1513                              fei,
1514                              format_mfib_entry, fei,
1515                              MFIB_ENTRY_FORMAT_DETAIL2);
1516         }
1517         else
1518         {
1519             vlib_cli_output (vm, "entry %d invalid", fei);
1520         }
1521     }
1522     else
1523     {
1524         /*
1525          * show all
1526          */
1527         vlib_cli_output (vm, "FIB Entries:");
1528         pool_foreach_index(fei, mfib_entry_pool,
1529         ({
1530             vlib_cli_output (vm, "%d@%U",
1531                              fei,
1532                              format_mfib_entry, fei,
1533                              MFIB_ENTRY_FORMAT_BRIEF);
1534         }));
1535     }
1536
1537     return (NULL);
1538 }
1539
1540 /*?
1541  * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique
1542  * numerical indentifier.
1543  ?*/
1544 VLIB_CLI_COMMAND (show_mfib_entry, static) = {
1545   .path = "show mfib entry",
1546   .function = show_mfib_entry_command,
1547   .short_help = "show mfib entry",
1548 };