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 int
 338 mfib_entry_is_sourced (fib_node_index_t mfib_entry_index,
 339                        mfib_source_t source)
 340 {
 341     mfib_entry_t *mfib_entry;
 342
 343     mfib_entry = mfib_entry_get(mfib_entry_index);
 344
 345     return (NULL != mfib_entry_src_find(mfib_entry, source, NULL));
 346 }
 347
 348 static void
 349 mfib_entry_src_flush (mfib_entry_src_t *msrc)
 350 {
 351     u32 sw_if_index;
 352     index_t mfii;
 353
 354     hash_foreach(sw_if_index, mfii, msrc->mfes_itfs,
 355     ({
 356         mfib_itf_delete(mfib_itf_get(mfii));
 357     }));
 358     hash_free(msrc->mfes_itfs);
 359     msrc->mfes_itfs = NULL;
 360     fib_path_list_unlock(msrc->mfes_pl);
 361 }
 362
 363 static void
 364 mfib_entry_src_remove (mfib_entry_t *mfib_entry,
 365                        mfib_source_t source)
 366
 367 {
 368     mfib_entry_src_t *msrc;
 369     u32 index = ~0;
 370
 371     msrc = mfib_entry_src_find(mfib_entry, source, &index);
 372
 373     if (NULL != msrc)
 374     {
 375         mfib_entry_src_flush(msrc);
 376         vec_del1(mfib_entry->mfe_srcs, index);
 377     }
 378 }
 379
 380 u32
 381 mfib_entry_child_add (fib_node_index_t mfib_entry_index,
 382                       fib_node_type_t child_type,
 383                       fib_node_index_t child_index)
 384 {
 385     return (fib_node_child_add(FIB_NODE_TYPE_MFIB_ENTRY,
 386                                mfib_entry_index,
 387                                child_type,
 388                                child_index));
 389 };
 390
 391 void
 392 mfib_entry_child_remove (fib_node_index_t mfib_entry_index,
 393                          u32 sibling_index)
 394 {
 395     fib_node_child_remove(FIB_NODE_TYPE_MFIB_ENTRY,
 396                           mfib_entry_index,
 397                           sibling_index);
 398 }
 399
 400 static mfib_entry_t *
 401 mfib_entry_alloc (u32 fib_index,
 402                   const mfib_prefix_t *prefix,
 403                   fib_node_index_t *mfib_entry_index)
 404 {
 405     mfib_entry_t *mfib_entry;
 406
 407     pool_get_aligned(mfib_entry_pool, mfib_entry, CLIB_CACHE_LINE_BYTES);
 408
 409     fib_node_init(&mfib_entry->mfe_node,
 410                   FIB_NODE_TYPE_MFIB_ENTRY);
 411
 412     /*
 413      * Some of the members require non-default initialisation
 414      * so we also init those that don't and thus save on the call to memset.
 415      */
 416     mfib_entry->mfe_flags = 0;
 417     mfib_entry->mfe_fib_index = fib_index;
 418     mfib_entry->mfe_prefix = *prefix;
 419     mfib_entry->mfe_srcs = NULL;
 420     mfib_entry->mfe_itfs = NULL;
 421     mfib_entry->mfe_rpf_id = MFIB_RPF_ID_NONE;
 422     mfib_entry->mfe_pl = FIB_NODE_INDEX_INVALID;
 423
 424     dpo_reset(&mfib_entry->mfe_rep);
 425
 426     *mfib_entry_index = mfib_entry_get_index(mfib_entry);
 427
 428     MFIB_ENTRY_DBG(mfib_entry, "alloc");
 429
 430     return (mfib_entry);
 431 }
 432
 433 static inline mfib_path_ext_t *
 434 mfib_entry_path_ext_find (mfib_path_ext_t *exts,
 435                           fib_node_index_t path_index)
 436 {
 437     uword *p;
 438
 439     p = hash_get(exts, path_index);
 440
 441     if (NULL != p)
 442     {
 443         return (mfib_entry_path_ext_get(p[0]));
 444     }
 445
 446     return (NULL);
 447 }
 448
 449 static mfib_path_ext_t*
 450 mfib_path_ext_add (mfib_entry_src_t *msrc,
 451                    fib_node_index_t path_index,
 452                    mfib_itf_flags_t mfi_flags)
 453 {
 454     mfib_path_ext_t *path_ext;
 455
 456     pool_get(mfib_path_ext_pool, path_ext);
 457
 458     path_ext->mfpe_flags = mfi_flags;
 459     path_ext->mfpe_path = path_index;
 460
 461     hash_set(msrc->mfes_exts, path_index,
 462              path_ext - mfib_path_ext_pool);
 463
 464     return (path_ext);
 465 }
 466
 467 static void
 468 mfib_path_ext_remove (mfib_entry_src_t *msrc,
 469                       fib_node_index_t path_index)
 470 {
 471     mfib_path_ext_t *path_ext;
 472
 473     path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
 474
 475     hash_unset(msrc->mfes_exts, path_index);
 476     pool_put(mfib_path_ext_pool, path_ext);
 477 }
 478
 479 typedef struct mfib_entry_collect_forwarding_ctx_t_
 480 {
 481     load_balance_path_t * next_hops;
 482     fib_forward_chain_type_t fct;
 483     mfib_entry_src_t *msrc;
 484 } mfib_entry_collect_forwarding_ctx_t;
 485
 486 static fib_path_list_walk_rc_t
 487 mfib_entry_src_collect_forwarding (fib_node_index_t pl_index,
 488                                    fib_node_index_t path_index,
 489                                    void *arg)
 490 {
 491     mfib_entry_collect_forwarding_ctx_t *ctx;
 492     load_balance_path_t *nh;
 493
 494     ctx = arg;
 495
 496     /*
 497      * if the path is not resolved, don't include it.
 498      */
 499     if (!fib_path_is_resolved(path_index))
 500     {
 501         return (FIB_PATH_LIST_WALK_CONTINUE);
 502     }
 503
 504     /*
 505      * If the path is not forwarding to use it
 506      */
 507     mfib_path_ext_t *path_ext;
 508
 509     path_ext = mfib_entry_path_ext_find(ctx->msrc->mfes_exts,
 510                                         path_index);
 511
 512     if (NULL != path_ext &&
 513         !(path_ext->mfpe_flags & MFIB_ITF_FLAG_FORWARD))
 514     {
 515         return (FIB_PATH_LIST_WALK_CONTINUE);
 516     }
 517
 518     switch (ctx->fct)
 519     {
 520     case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
 521     case FIB_FORW_CHAIN_TYPE_MCAST_IP6:
 522         /*
 523          * EOS traffic with no label to stack, we need the IP Adj
 524          */
 525         vec_add2(ctx->next_hops, nh, 1);
 526
 527         nh->path_index = path_index;
 528         nh->path_weight = fib_path_get_weight(path_index);
 529         fib_path_contribute_forwarding(path_index, ctx->fct, &nh->path_dpo);
 530         break;
 531
 532     case FIB_FORW_CHAIN_TYPE_UNICAST_IP4:
 533     case FIB_FORW_CHAIN_TYPE_UNICAST_IP6:
 534     case FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS:
 535     case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
 536     case FIB_FORW_CHAIN_TYPE_ETHERNET:
 537     case FIB_FORW_CHAIN_TYPE_NSH:
 538     case FIB_FORW_CHAIN_TYPE_BIER:
 539         ASSERT(0);
 540         break;
 541     }
 542
 543     return (FIB_PATH_LIST_WALK_CONTINUE);
 544 }
 545
 546 static void
 547 mfib_entry_stack (mfib_entry_t *mfib_entry,
 548                   mfib_entry_src_t *msrc)
 549 {
 550     dpo_proto_t dp;
 551
 552     dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 553
 554     /*
 555      * unlink the enty from the previous path list.
 556      */
 557     if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
 558     {
 559         fib_path_list_child_remove(mfib_entry->mfe_pl,
 560                                    mfib_entry->mfe_sibling);
 561     }
 562
 563     if (NULL != msrc &&
 564         FIB_NODE_INDEX_INVALID != msrc->mfes_pl)
 565     {
 566         mfib_entry_collect_forwarding_ctx_t ctx = {
 567             .next_hops = NULL,
 568             .fct = mfib_entry_get_default_chain_type(mfib_entry),
 569             .msrc = msrc,
 570         };
 571
 572         fib_path_list_walk(msrc->mfes_pl,
 573                            mfib_entry_src_collect_forwarding,
 574                            &ctx);
 575
 576         if (!(MFIB_ENTRY_FLAG_EXCLUSIVE & mfib_entry->mfe_flags))
 577         {
 578             if (NULL == ctx.next_hops)
 579             {
 580                 /*
 581                  * no next-hops, stack directly on the drop
 582                  */
 583                 dpo_stack(DPO_MFIB_ENTRY, dp,
 584                           &mfib_entry->mfe_rep,
 585                           drop_dpo_get(dp));
 586             }
 587             else
 588             {
 589                 /*
 590                  * each path contirbutes a next-hop. form a replicate
 591                  * from those choices.
 592                  */
 593                 if (!dpo_id_is_valid(&mfib_entry->mfe_rep) ||
 594                     dpo_is_drop(&mfib_entry->mfe_rep))
 595                 {
 596                     dpo_id_t tmp_dpo = DPO_INVALID;
 597
 598                     dpo_set(&tmp_dpo,
 599                             DPO_REPLICATE, dp,
 600                             replicate_create(0, dp));
 601
 602                     dpo_stack(DPO_MFIB_ENTRY, dp,
 603                               &mfib_entry->mfe_rep,
 604                               &tmp_dpo);
 605
 606                     dpo_reset(&tmp_dpo);
 607                 }
 608                 replicate_multipath_update(&mfib_entry->mfe_rep,
 609                                            ctx.next_hops);
 610             }
 611         }
 612         else
 613         {
 614             /*
 615              * for exclusive routes the source provided a replicate DPO
 616              * we we stashed inthe special path list with one path
 617              * so we can stack directly on that.
 618              */
 619             ASSERT(1 == vec_len(ctx.next_hops));
 620
 621             dpo_stack(DPO_MFIB_ENTRY, dp,
 622                       &mfib_entry->mfe_rep,
 623                       &ctx.next_hops[0].path_dpo);
 624             dpo_reset(&ctx.next_hops[0].path_dpo);
 625             vec_free(ctx.next_hops);
 626         }
 627
 628         /*
 629          * link the entry to the path-list.
 630          * The entry needs to be a child so that we receive the back-walk
 631          * updates to recalculate forwarding.
 632          */
 633         mfib_entry->mfe_pl = msrc->mfes_pl;
 634         mfib_entry->mfe_sibling =
 635             fib_path_list_child_add(mfib_entry->mfe_pl,
 636                                     FIB_NODE_TYPE_MFIB_ENTRY,
 637                                     mfib_entry_get_index(mfib_entry));
 638     }
 639     else
 640     {
 641         dpo_stack(DPO_MFIB_ENTRY, dp,
 642                   &mfib_entry->mfe_rep,
 643                   drop_dpo_get(dp));
 644     }
 645 }
 646
 647 static fib_node_index_t
 648 mfib_entry_src_path_add (mfib_entry_src_t *msrc,
 649                          const fib_route_path_t *rpath)
 650 {
 651     fib_node_index_t path_index;
 652     fib_route_path_t *rpaths;
 653
 654     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
 655
 656     /*
 657      * path-lists require a vector of paths
 658      */
 659     rpaths = NULL;
 660     vec_add1(rpaths, rpath[0]);
 661
 662     if (FIB_NODE_INDEX_INVALID == msrc->mfes_pl)
 663     {
 664         /* A non-shared path-list */
 665         msrc->mfes_pl = fib_path_list_create(FIB_PATH_LIST_FLAG_NO_URPF,
 666                                              NULL);
 667         fib_path_list_lock(msrc->mfes_pl);
 668     }
 669
 670     path_index = fib_path_list_path_add(msrc->mfes_pl, rpaths);
 671
 672     vec_free(rpaths);
 673
 674     return (path_index);
 675 }
 676
 677 static fib_node_index_t
 678 mfib_entry_src_path_remove (mfib_entry_src_t *msrc,
 679                             const fib_route_path_t *rpath)
 680 {
 681     fib_node_index_t path_index;
 682     fib_route_path_t *rpaths;
 683
 684     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
 685
 686     /*
 687      * path-lists require a vector of paths
 688      */
 689     rpaths = NULL;
 690     vec_add1(rpaths, rpath[0]);
 691
 692     path_index = fib_path_list_path_remove(msrc->mfes_pl, rpaths);
 693
 694     vec_free(rpaths);
 695
 696     return (path_index);
 697 }
 698
 699 static void
 700 mfib_entry_recalculate_forwarding (mfib_entry_t *mfib_entry)
 701 {
 702     mfib_entry_src_t *bsrc;
 703
 704     /*
 705      * copy the forwarding data from the bast source
 706      */
 707     bsrc = mfib_entry_get_best_src(mfib_entry);
 708
 709     if (NULL != bsrc)
 710     {
 711         mfib_entry->mfe_flags = bsrc->mfes_flags;
 712         mfib_entry->mfe_itfs = bsrc->mfes_itfs;
 713         mfib_entry->mfe_rpf_id = bsrc->mfes_rpf_id;
 714     }
 715
 716     mfib_entry_stack(mfib_entry, bsrc);
 717 }
 718
 719
 720 fib_node_index_t
 721 mfib_entry_create (u32 fib_index,
 722                    mfib_source_t source,
 723                    const mfib_prefix_t *prefix,
 724                    fib_rpf_id_t rpf_id,
 725                    mfib_entry_flags_t entry_flags)
 726 {
 727     fib_node_index_t mfib_entry_index;
 728     mfib_entry_t *mfib_entry;
 729     mfib_entry_src_t *msrc;
 730
 731     mfib_entry = mfib_entry_alloc(fib_index, prefix,
 732                                   &mfib_entry_index);
 733     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 734     msrc->mfes_flags = entry_flags;
 735     msrc->mfes_rpf_id = rpf_id;
 736
 737     mfib_entry_recalculate_forwarding(mfib_entry);
 738
 739     return (mfib_entry_index);
 740 }
 741
 742 static int
 743 mfib_entry_ok_for_delete (mfib_entry_t *mfib_entry)
 744 {
 745     return (0 == vec_len(mfib_entry->mfe_srcs));
 746 }
 747
 748 static int
 749 mfib_entry_src_ok_for_delete (const mfib_entry_src_t *msrc)
 750 {
 751     return ((MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags &&
 752              0 == fib_path_list_get_n_paths(msrc->mfes_pl)));
 753 }
 754
 755 int
 756 mfib_entry_update (fib_node_index_t mfib_entry_index,
 757                    mfib_source_t source,
 758                    mfib_entry_flags_t entry_flags,
 759                    fib_rpf_id_t rpf_id,
 760                    index_t repi)
 761 {
 762     mfib_entry_t *mfib_entry;
 763     mfib_entry_src_t *msrc;
 764
 765     mfib_entry = mfib_entry_get(mfib_entry_index);
 766     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 767     msrc->mfes_flags = entry_flags;
 768     msrc->mfes_rpf_id = rpf_id;
 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     if (mfib_entry_src_ok_for_delete(msrc))
 798     {
 799         /*
 800          * this source has no interfaces and no flags.
 801          * it has nothing left to give - remove it
 802          */
 803         mfib_entry_src_remove(mfib_entry, source);
 804     }
 805
 806     mfib_entry_recalculate_forwarding(mfib_entry);
 807
 808     return (mfib_entry_ok_for_delete(mfib_entry));
 809 }
 810
 811 static void
 812 mfib_entry_itf_add (mfib_entry_src_t *msrc,
 813                     u32 sw_if_index,
 814                     index_t mi)
 815 {
 816     hash_set(msrc->mfes_itfs, sw_if_index, mi);
 817 }
 818
 819 static void
 820 mfib_entry_itf_remove (mfib_entry_src_t *msrc,
 821                        u32 sw_if_index)
 822 {
 823     mfib_itf_t *mfi;
 824
 825     mfi = mfib_entry_itf_find(msrc->mfes_itfs, sw_if_index);
 826
 827     mfib_itf_delete(mfi);
 828
 829     hash_unset(msrc->mfes_itfs, sw_if_index);
 830 }
 831
 832 void
 833 mfib_entry_path_update (fib_node_index_t mfib_entry_index,
 834                         mfib_source_t source,
 835                         const fib_route_path_t *rpath,
 836                         mfib_itf_flags_t itf_flags)
 837 {
 838     fib_node_index_t path_index;
 839     mfib_path_ext_t *path_ext;
 840     mfib_itf_flags_t old, new;
 841     mfib_entry_t *mfib_entry;
 842     mfib_entry_src_t *msrc;
 843
 844     mfib_entry = mfib_entry_get(mfib_entry_index);
 845     ASSERT(NULL != mfib_entry);
 846     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 847
 848     /*
 849      * add the path to the path-list. If it's a duplicate we'll get
 850      * back the original path.
 851      */
 852     path_index = mfib_entry_src_path_add(msrc, rpath);
 853
 854     /*
 855      * find the path extension for that path
 856      */
 857     path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
 858
 859     if (NULL == path_ext)
 860     {
 861         old = MFIB_ITF_FLAG_NONE;
 862         path_ext = mfib_path_ext_add(msrc, path_index, itf_flags);
 863     }
 864     else
 865     {
 866         old = path_ext->mfpe_flags;
 867         path_ext->mfpe_flags = itf_flags;
 868     }
 869
 870     /*
 871      * Has the path changed its contribution to the input interface set.
 872      * Which only paths with interfaces can do...
 873      */
 874     if (~0 != rpath[0].frp_sw_if_index)
 875     {
 876         mfib_itf_t *mfib_itf;
 877
 878         new = itf_flags;
 879
 880         if (old != new)
 881         {
 882             if (MFIB_ITF_FLAG_NONE == new)
 883             {
 884                 /*
 885                  * no more interface flags on this path, remove
 886                  * from the data-plane set
 887                  */
 888                 mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
 889             }
 890             else if (MFIB_ITF_FLAG_NONE == old)
 891             {
 892                 /*
 893                  * This interface is now contributing
 894                  */
 895                 mfib_entry_itf_add(msrc,
 896                                    rpath[0].frp_sw_if_index,
 897                                    mfib_itf_create(rpath[0].frp_sw_if_index,
 898                                                    itf_flags));
 899             }
 900             else
 901             {
 902                 /*
 903                  * change of flag contributions
 904                  */
 905                 mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
 906                                                rpath[0].frp_sw_if_index);
 907                 /* Seen by packets inflight */
 908                 mfib_itf->mfi_flags = new;
 909             }
 910         }
 911     }
 912
 913     mfib_entry_recalculate_forwarding(mfib_entry);
 914 }
 915
 916 /*
 917  * mfib_entry_path_remove
 918  *
 919  * remove a path from the entry.
 920  * return the mfib_entry's index if it is still present, INVALID otherwise.
 921  */
 922 int
 923 mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
 924                         mfib_source_t source,
 925                         const fib_route_path_t *rpath)
 926 {
 927     fib_node_index_t path_index;
 928     mfib_entry_t *mfib_entry;
 929     mfib_entry_src_t *msrc;
 930
 931     mfib_entry = mfib_entry_get(mfib_entry_index);
 932     ASSERT(NULL != mfib_entry);
 933     msrc = mfib_entry_src_find(mfib_entry, source, NULL);
 934
 935     if (NULL == msrc)
 936     {
 937         /*
 938          * there are no paths left for this source
 939          */
 940         return (mfib_entry_ok_for_delete(mfib_entry));
 941     }
 942
 943     /*
 944      * remove the path from the path-list. If it's not there we'll get
 945      * back invalid
 946      */
 947     path_index = mfib_entry_src_path_remove(msrc, rpath);
 948
 949     if (FIB_NODE_INDEX_INVALID != path_index)
 950     {
 951         /*
 952          * don't need the extension, nor the interface anymore
 953          */
 954         mfib_path_ext_remove(msrc, path_index);
 955         if (~0 != rpath[0].frp_sw_if_index)
 956         {
 957             mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
 958         }
 959     }
 960
 961     if (mfib_entry_src_ok_for_delete(msrc))
 962     {
 963         /*
 964          * this source has no interfaces and no flags.
 965          * it has nothing left to give - remove it
 966          */
 967         mfib_entry_src_remove(mfib_entry, source);
 968     }
 969
 970     mfib_entry_recalculate_forwarding(mfib_entry);
 971
 972     return (mfib_entry_ok_for_delete(mfib_entry));
 973 }
 974
 975 /**
 976  * mfib_entry_delete
 977  *
 978  * The source is withdrawing all the paths it provided
 979  */
 980 int
 981 mfib_entry_delete (fib_node_index_t mfib_entry_index,
 982                    mfib_source_t source)
 983 {
 984     mfib_entry_t *mfib_entry;
 985
 986     mfib_entry = mfib_entry_get(mfib_entry_index);
 987     mfib_entry_src_remove(mfib_entry, source);
 988
 989     mfib_entry_recalculate_forwarding(mfib_entry);
 990
 991     return (mfib_entry_ok_for_delete(mfib_entry));
 992 }
 993
 994 static int
 995 fib_ip4_address_compare (ip4_address_t * a1,
 996                          ip4_address_t * a2)
 997 {
 998     /*
 999      * IP addresses are unsiged ints. the return value here needs to be signed
1000      * a simple subtraction won't cut it.
1001      * If the addresses are the same, the sort order is undefiend, so phoey.
1002      */
1003     return ((clib_net_to_host_u32(a1->data_u32) >
1004              clib_net_to_host_u32(a2->data_u32) ) ?
1005             1 : -1);
1006 }
1007
1008 static int
1009 fib_ip6_address_compare (ip6_address_t * a1,
1010                          ip6_address_t * a2)
1011 {
1012   int i;
1013   for (i = 0; i < ARRAY_LEN (a1->as_u16); i++)
1014   {
1015       int cmp = (clib_net_to_host_u16 (a1->as_u16[i]) -
1016                  clib_net_to_host_u16 (a2->as_u16[i]));
1017       if (cmp != 0)
1018           return cmp;
1019   }
1020   return 0;
1021 }
1022
1023 static int
1024 mfib_entry_cmp (fib_node_index_t mfib_entry_index1,
1025                 fib_node_index_t mfib_entry_index2)
1026 {
1027     mfib_entry_t *mfib_entry1, *mfib_entry2;
1028     int cmp = 0;
1029
1030     mfib_entry1 = mfib_entry_get(mfib_entry_index1);
1031     mfib_entry2 = mfib_entry_get(mfib_entry_index2);
1032
1033     switch (mfib_entry1->mfe_prefix.fp_proto)
1034     {
1035     case FIB_PROTOCOL_IP4:
1036         cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip4,
1037                                       &mfib_entry2->mfe_prefix.fp_grp_addr.ip4);
1038
1039         if (0 == cmp)
1040         {
1041             cmp = fib_ip4_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip4,
1042                                           &mfib_entry2->mfe_prefix.fp_src_addr.ip4);
1043         }
1044         break;
1045     case FIB_PROTOCOL_IP6:
1046         cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_grp_addr.ip6,
1047                                       &mfib_entry2->mfe_prefix.fp_grp_addr.ip6);
1048
1049         if (0 == cmp)
1050         {
1051             cmp = fib_ip6_address_compare(&mfib_entry1->mfe_prefix.fp_src_addr.ip6,
1052                                           &mfib_entry2->mfe_prefix.fp_src_addr.ip6);
1053         }
1054         break;
1055     case FIB_PROTOCOL_MPLS:
1056         ASSERT(0);
1057         cmp = 0;
1058         break;
1059     }
1060
1061     if (0 == cmp) {
1062         cmp = (mfib_entry1->mfe_prefix.fp_len - mfib_entry2->mfe_prefix.fp_len);
1063     }
1064     return (cmp);
1065 }
1066
1067 int
1068 mfib_entry_cmp_for_sort (void *i1, void *i2)
1069 {
1070     fib_node_index_t *mfib_entry_index1 = i1, *mfib_entry_index2 = i2;
1071
1072     return (mfib_entry_cmp(*mfib_entry_index1,
1073                            *mfib_entry_index2));
1074 }
1075
1076 static void
1077 mfib_entry_last_lock_gone (fib_node_t *node)
1078 {
1079     mfib_entry_t *mfib_entry;
1080     mfib_entry_src_t *msrc;
1081
1082     mfib_entry = mfib_entry_from_fib_node(node);
1083
1084     dpo_reset(&mfib_entry->mfe_rep);
1085
1086     MFIB_ENTRY_DBG(mfib_entry, "last-lock");
1087
1088     vec_foreach(msrc, mfib_entry->mfe_srcs)
1089     {
1090         mfib_entry_src_flush(msrc);
1091     }
1092
1093     vec_free(mfib_entry->mfe_srcs);
1094
1095     fib_node_deinit(&mfib_entry->mfe_node);
1096     pool_put(mfib_entry_pool, mfib_entry);
1097 }
1098
1099 /*
1100  * mfib_entry_back_walk_notify
1101  *
1102  * A back walk has reach this entry.
1103  */
1104 static fib_node_back_walk_rc_t
1105 mfib_entry_back_walk_notify (fib_node_t *node,
1106                             fib_node_back_walk_ctx_t *ctx)
1107 {
1108     mfib_entry_recalculate_forwarding(mfib_entry_from_fib_node(node));
1109
1110     return (FIB_NODE_BACK_WALK_CONTINUE);
1111 }
1112
1113 static void
1114 mfib_entry_show_memory (void)
1115 {
1116     fib_show_memory_usage("multicast-Entry",
1117                           pool_elts(mfib_entry_pool),
1118                           pool_len(mfib_entry_pool),
1119                           sizeof(mfib_entry_t));
1120 }
1121
1122 /*
1123  * The MFIB entry's graph node virtual function table
1124  */
1125 static const fib_node_vft_t mfib_entry_vft = {
1126     .fnv_get = mfib_entry_get_node,
1127     .fnv_last_lock = mfib_entry_last_lock_gone,
1128     .fnv_back_walk = mfib_entry_back_walk_notify,
1129     .fnv_mem_show = mfib_entry_show_memory,
1130 };
1131
1132 void
1133 mfib_entry_lock (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_lock(&mfib_entry->mfe_node);
1140 }
1141
1142 void
1143 mfib_entry_unlock (fib_node_index_t mfib_entry_index)
1144 {
1145     mfib_entry_t *mfib_entry;
1146
1147     mfib_entry = mfib_entry_get(mfib_entry_index);
1148
1149     fib_node_unlock(&mfib_entry->mfe_node);
1150 }
1151
1152 static void
1153 mfib_entry_dpo_lock (dpo_id_t *dpo)
1154 {
1155 }
1156 static void
1157 mfib_entry_dpo_unlock (dpo_id_t *dpo)
1158 {
1159 }
1160
1161 const static dpo_vft_t mfib_entry_dpo_vft = {
1162     .dv_lock = mfib_entry_dpo_lock,
1163     .dv_unlock = mfib_entry_dpo_unlock,
1164     .dv_format = format_mfib_entry_dpo,
1165     .dv_mem_show = mfib_entry_show_memory,
1166 };
1167
1168 const static char* const mfib_entry_ip4_nodes[] =
1169 {
1170     "ip4-mfib-forward-rpf",
1171     NULL,
1172 };
1173 const static char* const mfib_entry_ip6_nodes[] =
1174 {
1175     "ip6-mfib-forward-rpf",
1176     NULL,
1177 };
1178
1179 const static char* const * const mfib_entry_nodes[DPO_PROTO_NUM] =
1180 {
1181     [DPO_PROTO_IP4]  = mfib_entry_ip4_nodes,
1182     [DPO_PROTO_IP6]  = mfib_entry_ip6_nodes,
1183 };
1184
1185 void
1186 mfib_entry_module_init (void)
1187 {
1188     fib_node_register_type (FIB_NODE_TYPE_MFIB_ENTRY, &mfib_entry_vft);
1189     dpo_register(DPO_MFIB_ENTRY, &mfib_entry_dpo_vft, mfib_entry_nodes);
1190 }
1191
1192 void
1193 mfib_entry_encode (fib_node_index_t mfib_entry_index,
1194                   fib_route_path_encode_t **api_rpaths)
1195 {
1196     mfib_entry_t *mfib_entry;
1197     mfib_entry_src_t *bsrc;
1198
1199     mfib_entry = mfib_entry_get(mfib_entry_index);
1200     bsrc = mfib_entry_get_best_src(mfib_entry);
1201
1202     if (FIB_NODE_INDEX_INVALID != bsrc->mfes_pl)
1203     {
1204         fib_path_list_walk(bsrc->mfes_pl,
1205                            fib_path_encode,
1206                            api_rpaths);
1207     }
1208 }
1209
1210
1211 void
1212 mfib_entry_get_prefix (fib_node_index_t mfib_entry_index,
1213                       mfib_prefix_t *pfx)
1214 {
1215     mfib_entry_t *mfib_entry;
1216
1217     mfib_entry = mfib_entry_get(mfib_entry_index);
1218     *pfx = mfib_entry->mfe_prefix;
1219 }
1220
1221 u32
1222 mfib_entry_get_fib_index (fib_node_index_t mfib_entry_index)
1223 {
1224     mfib_entry_t *mfib_entry;
1225
1226     mfib_entry = mfib_entry_get(mfib_entry_index);
1227
1228     return (mfib_entry->mfe_fib_index);
1229 }
1230
1231 void
1232 mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
1233                                   fib_forward_chain_type_t type,
1234                                   dpo_id_t *dpo)
1235 {
1236     /*
1237      * An IP mFIB entry can only provide a forwarding chain that
1238      * is the same IP proto as the prefix.
1239      * No use-cases (i know of) for other combinations.
1240      */
1241     mfib_entry_t *mfib_entry;
1242     dpo_proto_t dp;
1243
1244     mfib_entry = mfib_entry_get(mfib_entry_index);
1245
1246     dp = fib_proto_to_dpo(mfib_entry->mfe_prefix.fp_proto);
1247
1248     if (type == fib_forw_chain_type_from_dpo_proto(dp))
1249     {
1250         dpo_copy(dpo, &mfib_entry->mfe_rep);
1251     }
1252     else
1253     {
1254         dpo_copy(dpo, drop_dpo_get(dp));
1255     }
1256 }
1257
1258 u32
1259 mfib_entry_pool_size (void)
1260 {
1261     return (pool_elts(mfib_entry_pool));
1262 }
1263
1264 static clib_error_t *
1265 show_mfib_entry_command (vlib_main_t * vm,
1266                         unformat_input_t * input,
1267                         vlib_cli_command_t * cmd)
1268 {
1269     fib_node_index_t fei;
1270
1271     if (unformat (input, "%d", &fei))
1272     {
1273         /*
1274          * show one in detail
1275          */
1276         if (!pool_is_free_index(mfib_entry_pool, fei))
1277         {
1278             vlib_cli_output (vm, "%d@%U",
1279                              fei,
1280                              format_mfib_entry, fei,
1281                              MFIB_ENTRY_FORMAT_DETAIL2);
1282         }
1283         else
1284         {
1285             vlib_cli_output (vm, "entry %d invalid", fei);
1286         }
1287     }
1288     else
1289     {
1290         /*
1291          * show all
1292          */
1293         vlib_cli_output (vm, "FIB Entries:");
1294         pool_foreach_index(fei, mfib_entry_pool,
1295         ({
1296             vlib_cli_output (vm, "%d@%U",
1297                              fei,
1298                              format_mfib_entry, fei,
1299                              MFIB_ENTRY_FORMAT_BRIEF);
1300         }));
1301     }
1302
1303     return (NULL);
1304 }
1305
1306 /*?
1307  * This commnad displays an entry, or all entries, in the mfib tables indexed by their unique
1308  * numerical indentifier.
1309  ?*/
1310 VLIB_CLI_COMMAND (show_mfib_entry, static) = {
1311   .path = "show mfib entry",
1312   .function = show_mfib_entry_command,
1313   .short_help = "show mfib entry",
1314 };