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