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