FIB: encode the label stack in the FIB path during table dump
[vpp.git] / src / vnet / mfib / mfib_entry.c
index 117ddc2..ac37665 100644 (file)
 #include <vlib/vlib.h>
 
 #include <vnet/mfib/mfib_entry.h>
+#include <vnet/mfib/mfib_entry_src.h>
+#include <vnet/mfib/mfib_entry_cover.h>
 #include <vnet/fib/fib_path_list.h>
+#include <vnet/fib/fib_walk.h>
 
 #include <vnet/dpo/drop_dpo.h>
 #include <vnet/dpo/replicate_dpo.h>
 
 /**
- * Debug macro
+ * the logger
  */
-#ifdef MFIB_DEBUG
-#DEFIne MFIB_ENTRY_DBG(_e, _fmt, _args...)             \
-{                                                       \
-    u8*__tmp = NULL;                                   \
-    __tmp = format(__tmp, "e:[%d:%U",                   \
-                   mfib_entry_get_index(_e),           \
-                   format_ip46_address,                        \
-                   &_e->mfe_prefix.fp_grp_addr,                \
-                   IP46_TYPE_ANY);                     \
-    __tmp = format(__tmp, "/%d,",                      \
-                   _e->mfe_prefix.fp_len);             \
-    __tmp = format(__tmp, "%U]",                        \
-                   mfib_entry_get_index(_e),           \
-                   format_ip46_address,                        \
-                   &_e->mfe_prefix.fp_src_addr,                \
-                   IP46_TYPE_ANY);                     \
-    __tmp = format(__tmp, _fmt, ##_args);              \
-    clib_warning("%s", __tmp);                         \
-    vec_free(__tmp);                                   \
-}
-#else
-#define MFIB_ENTRY_DBG(_e, _fmt, _args...)
-#endif
+vlib_log_class_t mfib_entry_logger;
 
 /**
- * The source of an MFIB entry
+ * Pool of path extensions
  */
-typedef struct mfib_entry_src_t_
-{
-    /**
-     * Which source this is
-     */
-    mfib_source_t mfes_src;
-
-    /**
-     * The path-list of forwarding interfaces
-     */
-    fib_node_index_t mfes_pl;
-
-    /**
-     * Route flags
-     */
-    mfib_entry_flags_t mfes_flags;
-
-    /**
-     * The hash table of all interfaces
-     */
-    mfib_itf_t *mfes_itfs;
-} mfib_entry_src_t;
+static mfib_path_ext_t *mfib_path_ext_pool;
 
 /**
  * String names for each source
@@ -123,6 +83,24 @@ format_mfib_entry_dpo (u8 * s, va_list * args)
                    MFIB_ENTRY_FORMAT_BRIEF));
 }
 
+static inline mfib_path_ext_t *
+mfib_entry_path_ext_get (index_t mi)
+{
+    return (pool_elt_at_index(mfib_path_ext_pool, mi));
+}
+
+static u8 *
+format_mfib_entry_path_ext (u8 * s, va_list * args)
+{
+    mfib_path_ext_t *path_ext;
+    index_t mpi = va_arg(*args, index_t);
+
+    path_ext = mfib_entry_path_ext_get(mpi);
+    return (format(s, "path:%d flags:%U",
+                   path_ext->mfpe_path,
+                   format_mfib_itf_flags, path_ext->mfpe_flags));
+}
+
 u8 *
 format_mfib_entry (u8 * s, va_list * args)
 {
@@ -141,18 +119,32 @@ format_mfib_entry (u8 * s, va_list * args)
 
     if (level >= MFIB_ENTRY_FORMAT_DETAIL)
     {
+        fib_node_index_t path_index, mpi;
+
         s = format (s, "\n");
         s = format (s, " fib:%d", mfib_entry->mfe_fib_index);
         s = format (s, " index:%d", mfib_entry_get_index(mfib_entry));
         s = format (s, " locks:%d\n", mfib_entry->mfe_node.fn_locks);
         vec_foreach(msrc, mfib_entry->mfe_srcs)
         {
-            s = format (s, "  src:%s", mfib_source_names[msrc->mfes_src]);
-            s = format (s, ": %U\n", format_mfib_entry_flags, msrc->mfes_flags);
+            s = format (s, "  src:%s locks:%d:",
+                        mfib_source_names[msrc->mfes_src],
+                        msrc->mfes_ref_count);
+            if (msrc->mfes_cover != FIB_NODE_INDEX_INVALID)
+            {
+                s = format (s, " cover:%d", msrc->mfes_cover);
+            }
+            s = format (s, " %U\n", format_mfib_entry_flags, msrc->mfes_flags);
             if (FIB_NODE_INDEX_INVALID != msrc->mfes_pl)
             {
                 s = fib_path_list_format(msrc->mfes_pl, s);
             }
+            s = format (s, "    Extensions:\n");
+            hash_foreach(path_index, mpi, msrc->mfes_exts,
+            ({
+                s = format(s, "     %U\n", format_mfib_entry_path_ext, mpi);
+            }));
+            s = format (s, "    Interface-Forwarding:\n");
             hash_foreach(sw_if_index, mfi, msrc->mfes_itfs,
             ({
                 s = format(s, "    %U\n", format_mfib_itf, mfi);
@@ -165,7 +157,10 @@ format_mfib_entry (u8 * s, va_list * args)
     ({
         s = format(s, "\n  %U", format_mfib_itf, mfi);
     }));
-
+    if (MFIB_RPF_ID_NONE != mfib_entry->mfe_rpf_id)
+    {
+        s = format(s, "\n  RPF-ID:%d", mfib_entry->mfe_rpf_id);
+    }
     s = format(s, "\n  %U-chain\n  %U",
                format_fib_forw_chain_type,
                mfib_entry_get_default_chain_type(mfib_entry),
@@ -186,9 +181,7 @@ format_mfib_entry (u8 * s, va_list * args)
 static mfib_entry_t*
 mfib_entry_from_fib_node (fib_node_t *node)
 {
-#if CLIB_DEBUG > 0
     ASSERT(FIB_NODE_TYPE_MFIB_ENTRY == node->fn_type);
-#endif
     return ((mfib_entry_t*)node);
 }
 
@@ -210,6 +203,9 @@ mfib_entry_src_init (mfib_entry_t *mfib_entry,
         .mfes_pl = FIB_NODE_INDEX_INVALID,
         .mfes_flags = MFIB_ENTRY_FLAG_NONE,
         .mfes_src = source,
+        .mfes_cover = FIB_NODE_INDEX_INVALID,
+        .mfes_sibling = FIB_NODE_INDEX_INVALID,
+        .mfes_ref_count = 1,
     };
 
     vec_add1(mfib_entry->mfe_srcs, esrc);
@@ -248,21 +244,53 @@ mfib_entry_src_find (const mfib_entry_t *mfib_entry,
 
 static mfib_entry_src_t *
 mfib_entry_src_find_or_create (mfib_entry_t *mfib_entry,
-                              mfib_source_t source)
+                               mfib_source_t source)
 {
-    mfib_entry_src_t *esrc;
+    mfib_entry_src_t *msrc;
 
-    esrc = mfib_entry_src_find(mfib_entry, source, NULL);
+    msrc = mfib_entry_src_find(mfib_entry, source, NULL);
 
-    if (NULL == esrc)
+    if (NULL == msrc)
     {
         mfib_entry_src_init(mfib_entry, source);
+        msrc = mfib_entry_src_find(mfib_entry, source, NULL);
     }
 
-    return (mfib_entry_src_find(mfib_entry, source, NULL));
+    return (msrc);
+}
+
+static mfib_entry_src_t *
+mfib_entry_src_update (mfib_entry_t *mfib_entry,
+                       mfib_source_t source,
+                       fib_rpf_id_t rpf_id,
+                       mfib_entry_flags_t entry_flags)
+{
+    mfib_entry_src_t *msrc;
+
+    msrc = mfib_entry_src_find_or_create(mfib_entry, source);
+
+    msrc->mfes_flags = entry_flags;
+    msrc->mfes_rpf_id = rpf_id;
+
+    return (msrc);
 }
 
-static mfib_entry_src_t*
+static mfib_entry_src_t *
+mfib_entry_src_update_and_lock (mfib_entry_t *mfib_entry,
+                                mfib_source_t source,
+                                fib_rpf_id_t rpf_id,
+                                mfib_entry_flags_t entry_flags)
+{
+    mfib_entry_src_t *msrc;
+
+    msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
+
+    msrc->mfes_ref_count++;
+
+    return (msrc);
+}
+
+mfib_entry_src_t*
 mfib_entry_get_best_src (const mfib_entry_t *mfib_entry)
 {
     mfib_entry_src_t *bsrc;
@@ -282,6 +310,34 @@ mfib_entry_get_best_src (const mfib_entry_t *mfib_entry)
     return (bsrc);
 }
 
+static mfib_source_t
+mfib_entry_get_best_source (const mfib_entry_t *mfib_entry)
+{
+    mfib_entry_src_t *bsrc;
+
+    bsrc = mfib_entry_get_best_src(mfib_entry);
+
+    return (bsrc->mfes_src);
+}
+
+int
+mfib_entry_is_sourced (fib_node_index_t mfib_entry_index,
+                       mfib_source_t source)
+{
+    mfib_entry_t *mfib_entry;
+
+    mfib_entry = mfib_entry_get(mfib_entry_index);
+
+    return (NULL != mfib_entry_src_find(mfib_entry, source, NULL));
+}
+
+int
+mfib_entry_is_host (fib_node_index_t mfib_entry_index)
+{
+    return (mfib_prefix_is_host(mfib_entry_get_prefix(mfib_entry_index)));
+}
+
+
 static void
 mfib_entry_src_flush (mfib_entry_src_t *msrc)
 {
@@ -309,75 +365,22 @@ mfib_entry_src_remove (mfib_entry_t *mfib_entry,
 
     if (NULL != msrc)
     {
-        mfib_entry_src_flush(msrc);
-        vec_del1(mfib_entry->mfe_srcs, index);
-    }
-}
-
-static int
-mfib_entry_src_n_itfs (const mfib_entry_src_t *msrc)
-{
-    return (hash_elts(msrc->mfes_itfs));
-}
-
-
-static void
-mfib_entry_last_lock_gone (fib_node_t *node)
-{
-    mfib_entry_t *mfib_entry;
-    mfib_entry_src_t *msrc;
-
-    mfib_entry = mfib_entry_from_fib_node(node);
+        ASSERT(0 != msrc->mfes_ref_count);
+        msrc->mfes_ref_count--;
 
-    dpo_reset(&mfib_entry->mfe_rep);
-
-    MFIB_ENTRY_DBG(mfib_entry, "last-lock");
+        if (0 == msrc->mfes_ref_count)
+        {
+            mfib_entry_src_deactivate(mfib_entry, msrc);
+            mfib_entry_src_flush(msrc);
 
-    vec_foreach(msrc, mfib_entry->mfe_srcs)
-    {
-        mfib_entry_src_flush(msrc);
+            vec_del1(mfib_entry->mfe_srcs, index);
+            if (vec_len (mfib_entry->mfe_srcs) > 1)
+                vec_sort_with_function(mfib_entry->mfe_srcs,
+                                       mfib_entry_src_cmp_for_sort);
+        }
     }
-
-    fib_path_list_unlock(mfib_entry->mfe_parent);
-    vec_free(mfib_entry->mfe_srcs);
-
-    fib_node_deinit(&mfib_entry->mfe_node);
-    pool_put(mfib_entry_pool, mfib_entry);
 }
 
-/*
- * mfib_entry_back_walk_notify
- *
- * A back walk has reach this entry.
- */
-static fib_node_back_walk_rc_t
-mfib_entry_back_walk_notify (fib_node_t *node,
-                            fib_node_back_walk_ctx_t *ctx)
-{
-    // FIXME - re-evalute
-
-    return (FIB_NODE_BACK_WALK_CONTINUE);
-}
-
-static void
-mfib_entry_show_memory (void)
-{
-    fib_show_memory_usage("multicast-Entry",
-                          pool_elts(mfib_entry_pool),
-                          pool_len(mfib_entry_pool),
-                          sizeof(mfib_entry_t));
-}
-
-/*
- * The MFIB entry's graph node virtual function table
- */
-static const fib_node_vft_t mfib_entry_vft = {
-    .fnv_get = mfib_entry_get_node,
-    .fnv_last_lock = mfib_entry_last_lock_gone,
-    .fnv_back_walk = mfib_entry_back_walk_notify,
-    .fnv_mem_show = mfib_entry_show_memory,
-};
-
 u32
 mfib_entry_child_add (fib_node_index_t mfib_entry_index,
                       fib_node_type_t child_type,
@@ -405,15 +408,22 @@ mfib_entry_alloc (u32 fib_index,
 {
     mfib_entry_t *mfib_entry;
 
-    pool_get(mfib_entry_pool, mfib_entry);
-    memset(mfib_entry, 0, sizeof(*mfib_entry));
+    pool_get_aligned(mfib_entry_pool, mfib_entry, CLIB_CACHE_LINE_BYTES);
 
     fib_node_init(&mfib_entry->mfe_node,
                   FIB_NODE_TYPE_MFIB_ENTRY);
 
+    /*
+     * Some of the members require non-default initialisation
+     * so we also init those that don't and thus save on the call to clib_memset.
+     */
+    mfib_entry->mfe_flags = 0;
     mfib_entry->mfe_fib_index = fib_index;
     mfib_entry->mfe_prefix = *prefix;
-    mfib_entry->mfe_parent = FIB_NODE_INDEX_INVALID;
+    mfib_entry->mfe_srcs = NULL;
+    mfib_entry->mfe_itfs = NULL;
+    mfib_entry->mfe_rpf_id = MFIB_RPF_ID_NONE;
+    mfib_entry->mfe_pl = FIB_NODE_INDEX_INVALID;
 
     dpo_reset(&mfib_entry->mfe_rep);
 
@@ -424,13 +434,60 @@ mfib_entry_alloc (u32 fib_index,
     return (mfib_entry);
 }
 
+static inline mfib_path_ext_t *
+mfib_entry_path_ext_find (mfib_path_ext_t *exts,
+                          fib_node_index_t path_index)
+{
+    uword *p;
+
+    p = hash_get(exts, path_index);
+
+    if (NULL != p)
+    {
+        return (mfib_entry_path_ext_get(p[0]));
+    }
+
+    return (NULL);
+}
+
+static mfib_path_ext_t*
+mfib_path_ext_add (mfib_entry_src_t *msrc,
+                   fib_node_index_t path_index,
+                   mfib_itf_flags_t mfi_flags)
+{
+    mfib_path_ext_t *path_ext;
+
+    pool_get(mfib_path_ext_pool, path_ext);
+
+    path_ext->mfpe_flags = mfi_flags;
+    path_ext->mfpe_path = path_index;
+
+    hash_set(msrc->mfes_exts, path_index,
+             path_ext - mfib_path_ext_pool);
+
+    return (path_ext);
+}
+
+static void
+mfib_path_ext_remove (mfib_entry_src_t *msrc,
+                      fib_node_index_t path_index)
+{
+    mfib_path_ext_t *path_ext;
+
+    path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
+
+    hash_unset(msrc->mfes_exts, path_index);
+    pool_put(mfib_path_ext_pool, path_ext);
+}
+
 typedef struct mfib_entry_collect_forwarding_ctx_t_
 {
     load_balance_path_t * next_hops;
     fib_forward_chain_type_t fct;
+    mfib_entry_src_t *msrc;
 } mfib_entry_collect_forwarding_ctx_t;
 
-static int
+static fib_path_list_walk_rc_t
 mfib_entry_src_collect_forwarding (fib_node_index_t pl_index,
                                    fib_node_index_t path_index,
                                    void *arg)
@@ -445,9 +502,23 @@ mfib_entry_src_collect_forwarding (fib_node_index_t pl_index,
      */
     if (!fib_path_is_resolved(path_index))
     {
-        return (!0);
+        return (FIB_PATH_LIST_WALK_CONTINUE);
     }
 
+    /*
+     * If the path is not forwarding to use it
+     */
+    mfib_path_ext_t *path_ext;
+    
+    path_ext = mfib_entry_path_ext_find(ctx->msrc->mfes_exts,
+                                        path_index);
+
+    if (NULL != path_ext &&
+        !(path_ext->mfpe_flags & MFIB_ITF_FLAG_FORWARD))
+    {
+        return (FIB_PATH_LIST_WALK_CONTINUE);
+    }
+    
     switch (ctx->fct)
     {
     case FIB_FORW_CHAIN_TYPE_MCAST_IP4:
@@ -468,54 +539,95 @@ mfib_entry_src_collect_forwarding (fib_node_index_t pl_index,
     case FIB_FORW_CHAIN_TYPE_MPLS_EOS:
     case FIB_FORW_CHAIN_TYPE_ETHERNET:
     case FIB_FORW_CHAIN_TYPE_NSH:
+    case FIB_FORW_CHAIN_TYPE_BIER:
         ASSERT(0);
         break;
     }
 
-    return (!0);
+    return (FIB_PATH_LIST_WALK_CONTINUE);
 }
 
 static void
-mfib_entry_stack (mfib_entry_t *mfib_entry)
+mfib_entry_stack (mfib_entry_t *mfib_entry,
+                  mfib_entry_src_t *msrc)
 {
     dpo_proto_t dp;
 
     dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
 
-    if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_parent)
+    /*
+     * unlink the enty from the previous path list.
+     */
+    if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
+    {
+        fib_path_list_child_remove(mfib_entry->mfe_pl,
+                                   mfib_entry->mfe_sibling);
+    }
+
+    if (NULL != msrc)
     {
         mfib_entry_collect_forwarding_ctx_t ctx = {
             .next_hops = NULL,
             .fct = mfib_entry_get_default_chain_type(mfib_entry),
+            .msrc = msrc,
         };
 
-        fib_path_list_walk(mfib_entry->mfe_parent,
-                           mfib_entry_src_collect_forwarding,
-                           &ctx);
+        /*
+         * link the entry to the path-list.
+         * The entry needs to be a child so that we receive the back-walk
+         * updates to recalculate forwarding.
+         */
+        mfib_entry->mfe_pl = msrc->mfes_pl;
+        mfib_entry->mfe_flags = msrc->mfes_flags;
+        mfib_entry->mfe_itfs = msrc->mfes_itfs;
+        mfib_entry->mfe_rpf_id = msrc->mfes_rpf_id;
 
+        if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_pl)
+        {
+            mfib_entry->mfe_sibling =
+                fib_path_list_child_add(mfib_entry->mfe_pl,
+                                        FIB_NODE_TYPE_MFIB_ENTRY,
+                                        mfib_entry_get_index(mfib_entry));
+
+            fib_path_list_walk(mfib_entry->mfe_pl,
+                               mfib_entry_src_collect_forwarding,
+                               &ctx);
+        }
         if (!(MFIB_ENTRY_FLAG_EXCLUSIVE & mfib_entry->mfe_flags))
         {
-            /*
-             * each path contirbutes a next-hop. form a replicate
-             * from those choices.
-             */
-            if (!dpo_id_is_valid(&mfib_entry->mfe_rep) ||
-                dpo_is_drop(&mfib_entry->mfe_rep))
+            if (NULL == ctx.next_hops)
             {
-                dpo_id_t tmp_dpo = DPO_INVALID;
-
-                dpo_set(&tmp_dpo,
-                        DPO_REPLICATE, dp,
-                        replicate_create(0, dp));
-
+                /*
+                 * no next-hops, stack directly on the drop
+                 */
                 dpo_stack(DPO_MFIB_ENTRY, dp,
                           &mfib_entry->mfe_rep,
-                          &tmp_dpo);
-
-                dpo_reset(&tmp_dpo);
+                          drop_dpo_get(dp));
+            }
+            else
+            {
+                /*
+                 * each path contirbutes a next-hop. form a replicate
+                 * from those choices.
+                 */
+                if (!dpo_id_is_valid(&mfib_entry->mfe_rep) ||
+                    dpo_is_drop(&mfib_entry->mfe_rep))
+                {
+                    dpo_id_t tmp_dpo = DPO_INVALID;
+
+                    dpo_set(&tmp_dpo,
+                            DPO_REPLICATE, dp,
+                            replicate_create(0, dp));
+
+                    dpo_stack(DPO_MFIB_ENTRY, dp,
+                              &mfib_entry->mfe_rep,
+                              &tmp_dpo);
+
+                    dpo_reset(&tmp_dpo);
+                }
+                replicate_multipath_update(&mfib_entry->mfe_rep,
+                                           ctx.next_hops);
             }
-            replicate_multipath_update(&mfib_entry->mfe_rep,
-                                       ctx.next_hops);
         }
         else
         {
@@ -539,13 +651,24 @@ mfib_entry_stack (mfib_entry_t *mfib_entry)
                   &mfib_entry->mfe_rep,
                   drop_dpo_get(dp));
     }
+
+    /*
+     * time for walkies fido.
+     */
+    fib_node_back_walk_ctx_t bw_ctx = {
+        .fnbw_reason = FIB_NODE_BW_REASON_FLAG_EVALUATE,
+    };
+
+    fib_walk_sync(FIB_NODE_TYPE_MFIB_ENTRY,
+                  mfib_entry_get_index(mfib_entry),
+                  &bw_ctx);
 }
 
-static void
-mfib_entry_forwarding_path_add (mfib_entry_src_t *msrc,
-                                const fib_route_path_t *rpath)
+static fib_node_index_t
+mfib_entry_src_path_add (mfib_entry_src_t *msrc,
+                         const fib_route_path_t *rpath)
 {
-    fib_node_index_t old_pl_index;
+    fib_node_index_t path_index;
     fib_route_path_t *rpaths;
 
     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
@@ -556,32 +679,26 @@ mfib_entry_forwarding_path_add (mfib_entry_src_t *msrc,
     rpaths = NULL;
     vec_add1(rpaths, rpath[0]);
 
-    old_pl_index = msrc->mfes_pl;
-
     if (FIB_NODE_INDEX_INVALID == msrc->mfes_pl)
     {
-        msrc->mfes_pl =
-            fib_path_list_create(FIB_PATH_LIST_FLAG_NO_URPF,
-                                 rpaths);
-    }
-    else
-    {
-        msrc->mfes_pl =
-            fib_path_list_copy_and_path_add(msrc->mfes_pl,
-                                            FIB_PATH_LIST_FLAG_NO_URPF,
-                                            rpaths);
+        /* A non-shared path-list */
+        msrc->mfes_pl = fib_path_list_create(FIB_PATH_LIST_FLAG_NO_URPF,
+                                             NULL);
+        fib_path_list_lock(msrc->mfes_pl);
     }
-    fib_path_list_lock(msrc->mfes_pl);
-    fib_path_list_unlock(old_pl_index);
+
+    path_index = fib_path_list_path_add(msrc->mfes_pl, rpaths);
 
     vec_free(rpaths);
+
+    return (path_index);
 }
 
-static int
-mfib_entry_forwarding_path_remove (mfib_entry_src_t *msrc,
-                                   const fib_route_path_t *rpath)
+static fib_node_index_t
+mfib_entry_src_path_remove (mfib_entry_src_t *msrc,
+                            const fib_route_path_t *rpath)
 {
-    fib_node_index_t old_pl_index;
+    fib_node_index_t path_index;
     fib_route_path_t *rpaths;
 
     ASSERT(!(MFIB_ENTRY_FLAG_EXCLUSIVE & msrc->mfes_flags));
@@ -592,56 +709,44 @@ mfib_entry_forwarding_path_remove (mfib_entry_src_t *msrc,
     rpaths = NULL;
     vec_add1(rpaths, rpath[0]);
 
-    old_pl_index = msrc->mfes_pl;
-
-    msrc->mfes_pl =
-        fib_path_list_copy_and_path_remove(msrc->mfes_pl,
-                                           FIB_PATH_LIST_FLAG_NONE,
-                                           rpaths);
-
-    fib_path_list_lock(msrc->mfes_pl);
-    fib_path_list_unlock(old_pl_index);
+    path_index = fib_path_list_path_remove(msrc->mfes_pl, rpaths);
 
     vec_free(rpaths);
 
-    return (FIB_NODE_INDEX_INVALID != msrc->mfes_pl);
+    return (path_index);
 }
 
 static void
-mfib_entry_recalculate_forwarding (mfib_entry_t *mfib_entry)
+mfib_entry_recalculate_forwarding (mfib_entry_t *mfib_entry,
+                                   mfib_source_t old_best)
 {
-    fib_node_index_t old_pl_index;
-    mfib_entry_src_t *bsrc;
-
-    old_pl_index = mfib_entry->mfe_parent;
+    mfib_entry_src_t *bsrc, *osrc;
 
     /*
      * copy the forwarding data from the bast source
      */
     bsrc = mfib_entry_get_best_src(mfib_entry);
+    osrc = mfib_entry_src_find(mfib_entry, old_best, NULL);
 
-    if (NULL == bsrc)
+    if (NULL != bsrc)
     {
-        mfib_entry->mfe_parent = FIB_NODE_INDEX_INVALID;
+        if (bsrc->mfes_src != old_best)
+        {
+            /*
+             * we are changing from one source to another
+             * deactivate the old, and activate the new
+             */
+            mfib_entry_src_deactivate(mfib_entry, osrc);
+            mfib_entry_src_activate(mfib_entry, bsrc);
+        }
     }
     else
     {
-        mfib_entry->mfe_parent = bsrc->mfes_pl;
-        mfib_entry->mfe_flags = bsrc->mfes_flags;
-        mfib_entry->mfe_itfs = bsrc->mfes_itfs;
+        mfib_entry_src_deactivate(mfib_entry, osrc);
     }
 
-    /*
-     * re-stack the entry on the best forwarding info.
-     */
-    if (old_pl_index != mfib_entry->mfe_parent ||
-        FIB_NODE_INDEX_INVALID == old_pl_index)
-    {
-        mfib_entry_stack(mfib_entry);
-
-        fib_path_list_lock(mfib_entry->mfe_parent);
-        fib_path_list_unlock(old_pl_index);
-    }
+    mfib_entry_stack(mfib_entry, bsrc);
+    mfib_entry_cover_update_notify(mfib_entry);
 }
 
 
@@ -649,7 +754,9 @@ fib_node_index_t
 mfib_entry_create (u32 fib_index,
                    mfib_source_t source,
                    const mfib_prefix_t *prefix,
-                   mfib_entry_flags_t entry_flags)
+                   fib_rpf_id_t rpf_id,
+                   mfib_entry_flags_t entry_flags,
+                   index_t repi)
 {
     fib_node_index_t mfib_entry_index;
     mfib_entry_t *mfib_entry;
@@ -657,10 +764,37 @@ mfib_entry_create (u32 fib_index,
 
     mfib_entry = mfib_entry_alloc(fib_index, prefix,
                                   &mfib_entry_index);
-    msrc = mfib_entry_src_find_or_create(mfib_entry, source);
-    msrc->mfes_flags = entry_flags;
+    msrc = mfib_entry_src_update(mfib_entry, source,
+                                 rpf_id, entry_flags);
+
+    if (INDEX_INVALID != repi)
+    {
+        /*
+         * The source is providing its own replicate DPO.
+         * Create a sepcial path-list to manage it, that way
+         * this entry and the source are equivalent to a normal
+         * entry
+         */
+        fib_node_index_t old_pl_index;
+        dpo_proto_t dp;
+        dpo_id_t dpo = DPO_INVALID;
 
-    mfib_entry_recalculate_forwarding(mfib_entry);
+        dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
+        old_pl_index = msrc->mfes_pl;
+
+        dpo_set(&dpo, DPO_REPLICATE, dp, repi);
+
+        msrc->mfes_pl =
+            fib_path_list_create_special(dp,
+                                         FIB_PATH_LIST_FLAG_EXCLUSIVE,
+                                         &dpo);
+
+        dpo_reset(&dpo);
+        fib_path_list_lock(msrc->mfes_pl);
+        fib_path_list_unlock(old_pl_index);
+    }
+
+    mfib_entry_recalculate_forwarding(mfib_entry, MFIB_SOURCE_NONE);
 
     return (mfib_entry_index);
 }
@@ -674,23 +808,18 @@ mfib_entry_ok_for_delete (mfib_entry_t *mfib_entry)
 static int
 mfib_entry_src_ok_for_delete (const mfib_entry_src_t *msrc)
 {
-    return ((MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags &&
-             0 == mfib_entry_src_n_itfs(msrc)));
+    return ((INDEX_INVALID == msrc->mfes_cover &&
+             MFIB_ENTRY_FLAG_NONE == msrc->mfes_flags &&
+             0 == fib_path_list_get_n_paths(msrc->mfes_pl)));
 }
 
-int
-mfib_entry_update (fib_node_index_t mfib_entry_index,
-                   mfib_source_t source,
-                   mfib_entry_flags_t entry_flags,
-                   index_t repi)
-{
-    mfib_entry_t *mfib_entry;
-    mfib_entry_src_t *msrc;
-
-    mfib_entry = mfib_entry_get(mfib_entry_index);
-    msrc = mfib_entry_src_find_or_create(mfib_entry, source);
-    msrc->mfes_flags = entry_flags;
 
+static void
+mfib_entry_update_i (mfib_entry_t *mfib_entry,
+                     mfib_entry_src_t *msrc,
+                     mfib_source_t current_best,
+                     index_t repi)
+{
     if (INDEX_INVALID != repi)
     {
         /*
@@ -700,18 +829,16 @@ mfib_entry_update (fib_node_index_t mfib_entry_index,
          * entry
          */
         fib_node_index_t old_pl_index;
-        fib_protocol_t fp;
+        dpo_proto_t dp;
         dpo_id_t dpo = DPO_INVALID;
 
-        fp = mfib_entry_get_proto(mfib_entry);
+        dp = fib_proto_to_dpo(mfib_entry_get_proto(mfib_entry));
         old_pl_index = msrc->mfes_pl;
 
-        dpo_set(&dpo, DPO_REPLICATE,
-                fib_proto_to_dpo(fp),
-                repi);
+        dpo_set(&dpo, DPO_REPLICATE, dp, repi);
 
         msrc->mfes_pl =
-            fib_path_list_create_special(fp,
+            fib_path_list_create_special(dp,
                                          FIB_PATH_LIST_FLAG_EXCLUSIVE,
                                          &dpo);
 
@@ -726,10 +853,50 @@ mfib_entry_update (fib_node_index_t mfib_entry_index,
          * this source has no interfaces and no flags.
          * it has nothing left to give - remove it
          */
-        mfib_entry_src_remove(mfib_entry, source);
+        mfib_entry_src_remove(mfib_entry, msrc->mfes_src);
     }
 
-    mfib_entry_recalculate_forwarding(mfib_entry);
+    mfib_entry_recalculate_forwarding(mfib_entry, current_best);
+}
+
+int
+mfib_entry_special_add (fib_node_index_t mfib_entry_index,
+                        mfib_source_t source,
+                        mfib_entry_flags_t entry_flags,
+                        fib_rpf_id_t rpf_id,
+                        index_t repi)
+{
+    mfib_source_t current_best;
+    mfib_entry_t *mfib_entry;
+    mfib_entry_src_t *msrc;
+
+    mfib_entry = mfib_entry_get(mfib_entry_index);
+    current_best = mfib_entry_get_best_source(mfib_entry);
+
+    msrc = mfib_entry_src_update_and_lock(mfib_entry, source, rpf_id,
+                                          entry_flags);
+
+    mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
+
+    return (mfib_entry_ok_for_delete(mfib_entry));
+}
+
+int
+mfib_entry_update (fib_node_index_t mfib_entry_index,
+                   mfib_source_t source,
+                   mfib_entry_flags_t entry_flags,
+                   fib_rpf_id_t rpf_id,
+                   index_t repi)
+{
+    mfib_source_t current_best;
+    mfib_entry_t *mfib_entry;
+    mfib_entry_src_t *msrc;
+
+    mfib_entry = mfib_entry_get(mfib_entry_index);
+    current_best = mfib_entry_get_best_source(mfib_entry);
+    msrc = mfib_entry_src_update(mfib_entry, source, rpf_id, entry_flags);
+
+    mfib_entry_update_i(mfib_entry, msrc, current_best, repi);
 
     return (mfib_entry_ok_for_delete(mfib_entry));
 }
@@ -761,58 +928,79 @@ mfib_entry_path_update (fib_node_index_t mfib_entry_index,
                         const fib_route_path_t *rpath,
                         mfib_itf_flags_t itf_flags)
 {
+    fib_node_index_t path_index;
+    mfib_source_t current_best;
+    mfib_path_ext_t *path_ext;
     mfib_entry_t *mfib_entry;
     mfib_entry_src_t *msrc;
-    mfib_itf_t *mfib_itf;
+    mfib_itf_flags_t old;
 
     mfib_entry = mfib_entry_get(mfib_entry_index);
     ASSERT(NULL != mfib_entry);
+    current_best = mfib_entry_get_best_source(mfib_entry);
     msrc = mfib_entry_src_find_or_create(mfib_entry, source);
 
     /*
-     * search for the interface in the current set
+     * add the path to the path-list. If it's a duplicate we'll get
+     * back the original path.
+     */
+    path_index = mfib_entry_src_path_add(msrc, rpath);
+
+    /*
+     * find the path extension for that path
      */
-    mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
-                                   rpath[0].frp_sw_if_index);
+    path_ext = mfib_entry_path_ext_find(msrc->mfes_exts, path_index);
 
-    if (NULL == mfib_itf)
+    if (NULL == path_ext)
     {
-        /*
-         * this is a path we do not yet have. If it is forwarding then we
-         * add it to the replication set
-         */
-        if (itf_flags & MFIB_ITF_FLAG_FORWARD)
-        {
-            mfib_entry_forwarding_path_add(msrc, rpath);
-        }
-        /*
-         * construct a new ITF for this entry's list
-         */
-        mfib_entry_itf_add(msrc,
-                           rpath[0].frp_sw_if_index,
-                           mfib_itf_create(rpath[0].frp_sw_if_index,
-                                           itf_flags));
+        old = MFIB_ITF_FLAG_NONE;
+        path_ext = mfib_path_ext_add(msrc, path_index, itf_flags);
     }
     else
     {
-        int was_forwarding = !!(mfib_itf->mfi_flags & MFIB_ITF_FLAG_FORWARD);
-        int is_forwarding  = !!(itf_flags & MFIB_ITF_FLAG_FORWARD);
+        old = path_ext->mfpe_flags;
+        path_ext->mfpe_flags = itf_flags;
+    }
 
-        if (!was_forwarding && is_forwarding)
-        {
-            mfib_entry_forwarding_path_add(msrc, rpath);
-        }
-        else if (was_forwarding && !is_forwarding)
+    /*
+     * Has the path changed its contribution to the input interface set.
+     * Which only paths with interfaces can do...
+     */
+    if (~0 != rpath[0].frp_sw_if_index)
+    {
+        mfib_itf_t *mfib_itf;
+
+        if (old != itf_flags)
         {
-            mfib_entry_forwarding_path_remove(msrc, rpath);
+            /*
+             * change of flag contributions
+             */
+            mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
+                                           rpath[0].frp_sw_if_index);
+
+            if (NULL == mfib_itf)
+            {
+                mfib_entry_itf_add(msrc,
+                                   rpath[0].frp_sw_if_index,
+                                   mfib_itf_create(path_index, itf_flags));
+            }
+            else
+            {
+                if (mfib_itf_update(mfib_itf,
+                                    path_index,
+                                    itf_flags))
+                {
+                    /*
+                     * no more interface flags on this path, remove
+                     * from the data-plane set
+                     */
+                    mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
+                }
+            }
         }
-        /*
-         * packets in flight see these updates.
-         */
-        mfib_itf->mfi_flags = itf_flags;
     }
 
-    mfib_entry_recalculate_forwarding(mfib_entry);
+    mfib_entry_recalculate_forwarding(mfib_entry, current_best);
 }
 
 /*
@@ -826,12 +1014,14 @@ mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
                         mfib_source_t source,
                         const fib_route_path_t *rpath)
 {
+    fib_node_index_t path_index;
+    mfib_source_t current_best;
     mfib_entry_t *mfib_entry;
     mfib_entry_src_t *msrc;
-    mfib_itf_t *mfib_itf;
 
     mfib_entry = mfib_entry_get(mfib_entry_index);
     ASSERT(NULL != mfib_entry);
+    current_best = mfib_entry_get_best_source(mfib_entry);
     msrc = mfib_entry_src_find(mfib_entry, source, NULL);
 
     if (NULL == msrc)
@@ -843,32 +1033,36 @@ mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
     }
 
     /*
-     * search for the interface in the current set
+     * remove the path from the path-list. If it's not there we'll get
+     * back invalid
      */
-    mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
-                                   rpath[0].frp_sw_if_index);
+    path_index = mfib_entry_src_path_remove(msrc, rpath);
 
-    if (NULL == mfib_itf)
+    if (FIB_NODE_INDEX_INVALID != path_index)
     {
         /*
-         * removing a path that does not exist
+         * don't need the extension, nor the interface anymore
          */
-        return (mfib_entry_ok_for_delete(mfib_entry));
-    }
+        mfib_path_ext_remove(msrc, path_index);
+        if (~0 != rpath[0].frp_sw_if_index)
+        {
+            mfib_itf_t *mfib_itf;
 
-    /*
-     * we have this path. If it is forwarding then we
-     * remove it to the replication set
-     */
-    if (mfib_itf->mfi_flags & MFIB_ITF_FLAG_FORWARD)
-    {
-        mfib_entry_forwarding_path_remove(msrc, rpath);
-    }
+            mfib_itf = mfib_entry_itf_find(msrc->mfes_itfs,
+                                           rpath[0].frp_sw_if_index);
 
-    /*
-     * remove the interface/path from this entry's list
-     */
-    mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
+            if (mfib_itf_update(mfib_itf,
+                                path_index,
+                                MFIB_ITF_FLAG_NONE))
+            {
+                /*
+                 * no more interface flags on this path, remove
+                 * from the data-plane set
+                 */
+                mfib_entry_itf_remove(msrc, rpath[0].frp_sw_if_index);
+            }
+        }
+    }
 
     if (mfib_entry_src_ok_for_delete(msrc))
     {
@@ -879,7 +1073,7 @@ mfib_entry_path_remove (fib_node_index_t mfib_entry_index,
         mfib_entry_src_remove(mfib_entry, source);
     }
 
-    mfib_entry_recalculate_forwarding(mfib_entry);
+    mfib_entry_recalculate_forwarding(mfib_entry, current_best);
 
     return (mfib_entry_ok_for_delete(mfib_entry));
 }
@@ -893,12 +1087,14 @@ int
 mfib_entry_delete (fib_node_index_t mfib_entry_index,
                    mfib_source_t source)
 {
+    mfib_source_t current_best;
     mfib_entry_t *mfib_entry;
 
     mfib_entry = mfib_entry_get(mfib_entry_index);
+    current_best = mfib_entry_get_best_source(mfib_entry);
     mfib_entry_src_remove(mfib_entry, source);
 
-    mfib_entry_recalculate_forwarding(mfib_entry);
+    mfib_entry_recalculate_forwarding(mfib_entry, current_best);
 
     return (mfib_entry_ok_for_delete(mfib_entry));
 }
@@ -985,6 +1181,76 @@ mfib_entry_cmp_for_sort (void *i1, void *i2)
                            *mfib_entry_index2));
 }
 
+static void
+mfib_entry_last_lock_gone (fib_node_t *node)
+{
+    mfib_entry_t *mfib_entry;
+    mfib_entry_src_t *msrc;
+
+    mfib_entry = mfib_entry_from_fib_node(node);
+
+    dpo_reset(&mfib_entry->mfe_rep);
+
+    MFIB_ENTRY_DBG(mfib_entry, "last-lock");
+
+    vec_foreach(msrc, mfib_entry->mfe_srcs)
+    {
+        mfib_entry_src_flush(msrc);
+    }
+
+    vec_free(mfib_entry->mfe_srcs);
+
+    fib_node_deinit(&mfib_entry->mfe_node);
+    pool_put(mfib_entry_pool, mfib_entry);
+}
+
+u32
+mfib_entry_get_stats_index (fib_node_index_t fib_entry_index)
+{
+    mfib_entry_t *mfib_entry;
+
+    mfib_entry = mfib_entry_get(fib_entry_index);
+
+    return (mfib_entry->mfe_rep.dpoi_index);
+}
+
+/*
+ * mfib_entry_back_walk_notify
+ *
+ * A back walk has reach this entry.
+ */
+static fib_node_back_walk_rc_t
+mfib_entry_back_walk_notify (fib_node_t *node,
+                            fib_node_back_walk_ctx_t *ctx)
+{
+    mfib_entry_t *mfib_entry;
+
+    mfib_entry = mfib_entry_from_fib_node(node);
+    mfib_entry_recalculate_forwarding(mfib_entry,
+                                      mfib_entry_get_best_source(mfib_entry));
+
+    return (FIB_NODE_BACK_WALK_CONTINUE);
+}
+
+static void
+mfib_entry_show_memory (void)
+{
+    fib_show_memory_usage("multicast-Entry",
+                          pool_elts(mfib_entry_pool),
+                          pool_len(mfib_entry_pool),
+                          sizeof(mfib_entry_t));
+}
+
+/*
+ * The MFIB entry's graph node virtual function table
+ */
+static const fib_node_vft_t mfib_entry_vft = {
+    .fnv_get = mfib_entry_get_node,
+    .fnv_last_lock = mfib_entry_last_lock_gone,
+    .fnv_back_walk = mfib_entry_back_walk_notify,
+    .fnv_mem_show = mfib_entry_show_memory,
+};
+
 void
 mfib_entry_lock (fib_node_index_t mfib_entry_index)
 {
@@ -1043,6 +1309,7 @@ mfib_entry_module_init (void)
 {
     fib_node_register_type (FIB_NODE_TYPE_MFIB_ENTRY, &mfib_entry_vft);
     dpo_register(DPO_MFIB_ENTRY, &mfib_entry_dpo_vft, mfib_entry_nodes);
+    mfib_entry_logger = vlib_log_register_class("mfib", "entry");
 }
 
 void
@@ -1050,25 +1317,28 @@ mfib_entry_encode (fib_node_index_t mfib_entry_index,
                   fib_route_path_encode_t **api_rpaths)
 {
     mfib_entry_t *mfib_entry;
+    mfib_entry_src_t *bsrc;
 
     mfib_entry = mfib_entry_get(mfib_entry_index);
-    if (FIB_NODE_INDEX_INVALID != mfib_entry->mfe_parent)
+    bsrc = mfib_entry_get_best_src(mfib_entry);
+
+    if (FIB_NODE_INDEX_INVALID != bsrc->mfes_pl)
     {
-        fib_path_list_walk(mfib_entry->mfe_parent,
-                           fib_path_encode,
-                           api_rpaths);
+        fib_path_list_walk_w_ext(bsrc->mfes_pl,
+                                 NULL,
+                                 fib_path_encode,
+                                 api_rpaths);
     }
 }
 
-
-void
-mfib_entry_get_prefix (fib_node_index_t mfib_entry_index,
-                      mfib_prefix_t *pfx)
+const mfib_prefix_t *
+mfib_entry_get_prefix (fib_node_index_t mfib_entry_index)
 {
     mfib_entry_t *mfib_entry;
 
     mfib_entry = mfib_entry_get(mfib_entry_index);
-    *pfx = mfib_entry->mfe_prefix;
+
+    return (&mfib_entry->mfe_prefix);
 }
 
 u32
@@ -1081,9 +1351,20 @@ mfib_entry_get_fib_index (fib_node_index_t mfib_entry_index)
     return (mfib_entry->mfe_fib_index);
 }
 
+const dpo_id_t*
+mfib_entry_contribute_ip_forwarding (fib_node_index_t mfib_entry_index)
+{
+    mfib_entry_t *mfib_entry;
+
+    mfib_entry = mfib_entry_get(mfib_entry_index);
+
+    return (&mfib_entry->mfe_rep);
+}
+
 void
 mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
                                   fib_forward_chain_type_t type,
+                                  mfib_entry_fwd_flags_t flags,
                                   dpo_id_t *dpo)
 {
     /*
@@ -1098,9 +1379,26 @@ mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
 
     dp = fib_proto_to_dpo(mfib_entry->mfe_prefix.fp_proto);
 
-    if (type == fib_forw_chain_type_from_dpo_proto(dp))
+    if (type == mfib_forw_chain_type_from_dpo_proto(dp))
     {
-        dpo_copy(dpo, &mfib_entry->mfe_rep);
+        replicate_t * rep;
+
+        rep = replicate_get(mfib_entry->mfe_rep.dpoi_index);
+
+        if ((rep->rep_flags & REPLICATE_FLAGS_HAS_LOCAL) &&
+            (flags & MFIB_ENTRY_FWD_FLAG_NO_LOCAL))
+        {
+            /*
+             * caller does not want the local paths that the entry has
+             */
+            dpo_set(dpo, DPO_REPLICATE, rep->rep_proto,
+                    replicate_dup(REPLICATE_FLAGS_NONE,
+                                  mfib_entry->mfe_rep.dpoi_index));
+        }
+        else
+        {
+            dpo_copy(dpo, &mfib_entry->mfe_rep);
+        }
     }
     else
     {
@@ -1108,6 +1406,55 @@ mfib_entry_contribute_forwarding (fib_node_index_t mfib_entry_index,
     }
 }
 
+/*
+ * fib_entry_cover_changed
+ *
+ * this entry is tracking its cover and that cover has changed.
+ */
+void
+mfib_entry_cover_changed (fib_node_index_t mfib_entry_index)
+{
+    mfib_entry_t *mfib_entry;
+    mfib_entry_src_t *msrc;
+    mfib_src_res_t res;
+
+    mfib_entry = mfib_entry_get(mfib_entry_index);
+    msrc = mfib_entry_get_best_src(mfib_entry);
+
+    res = mfib_entry_src_cover_change(mfib_entry, msrc);
+
+    if (MFIB_SRC_REEVALUATE == res)
+    {
+        mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
+    }
+    MFIB_ENTRY_DBG(mfib_entry, "cover-changed");
+}
+
+/*
+ * mfib_entry_cover_updated
+ *
+ * this entry is tracking its cover and that cover has been updated
+ * (i.e. its forwarding information has changed).
+ */
+void
+mfib_entry_cover_updated (fib_node_index_t mfib_entry_index)
+{
+    mfib_entry_t *mfib_entry;
+    mfib_entry_src_t *msrc;
+    mfib_src_res_t res;
+
+    mfib_entry = mfib_entry_get(mfib_entry_index);
+    msrc = mfib_entry_get_best_src(mfib_entry);
+
+    res = mfib_entry_src_cover_update(mfib_entry, msrc);
+
+    if (MFIB_SRC_REEVALUATE == res)
+    {
+        mfib_entry_recalculate_forwarding(mfib_entry, msrc->mfes_src);
+    }
+    MFIB_ENTRY_DBG(mfib_entry, "cover-updated");
+}
+
 u32
 mfib_entry_pool_size (void)
 {