src/vnet/mfib/mfib_entry.h

   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 #ifndef __MFIB_ENTRY_H__
  17 #define __MFIB_ENTRY_H__
  18
  19 #include <vnet/fib/fib_node.h>
  20 #include <vnet/mfib/mfib_types.h>
  21 #include <vnet/mfib/mfib_itf.h>
  22 #include <vnet/ip/ip.h>
  23 #include <vnet/dpo/dpo.h>
  24
  25 /**
  26  * An entry in a FIB table.
  27  *
  28  * This entry represents a route added to the FIB that is stored
  29  * in one of the FIB tables.
  30  */
  31 typedef struct mfib_entry_t_ {
  32     CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
  33     /**
  34      * Base class. The entry's node representation in the graph.
  35      */
  36     fib_node_t mfe_node;
  37     /**
  38      * The prefix of the route
  39      */
  40     mfib_prefix_t mfe_prefix;
  41     /**
  42      * The index of the FIB table this entry is in
  43      */
  44     u32 mfe_fib_index;
  45     /**
  46      * the path-list for which this entry is a child. This is also the path-list
  47      * that is contributing forwarding for this entry.
  48      */
  49     fib_node_index_t mfe_parent;
  50     /**
  51      * index of this entry in the parent's child list.
  52      * This is set when this entry is added as a child, but can also
  53      * be changed by the parent as it manages its list.
  54      */
  55     u32 mfe_sibling;
  56
  57     /**
  58      * A vector of sources contributing forwarding
  59      */
  60     struct mfib_entry_src_t_ *mfe_srcs;
  61
  62     /**
  63      * 2nd cache line has the members used in the data plane
  64      */
  65     CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
  66
  67     /**
  68      * The Replicate DPO used for forwarding.
  69      */
  70     dpo_id_t mfe_rep;
  71
  72     /**
  73      * Route flags
  74      */
  75     mfib_entry_flags_t mfe_flags;
  76
  77     /**
  78      * A hash table of interfaces
  79      */
  80     mfib_itf_t *mfe_itfs;
  81 } mfib_entry_t;
  82
  83 #define MFIB_ENTRY_FORMAT_BRIEF   (0x0)
  84 #define MFIB_ENTRY_FORMAT_DETAIL  (0x1)
  85 #define MFIB_ENTRY_FORMAT_DETAIL2 (0x2)
  86
  87 extern u8 *format_mfib_entry(u8 * s, va_list * args);
  88
  89
  90 extern fib_node_index_t mfib_entry_create(u32 fib_index,
  91                                           mfib_source_t source,
  92                                           const mfib_prefix_t *prefix,
  93                                           mfib_entry_flags_t entry_flags);
  94
  95 extern int mfib_entry_update(fib_node_index_t fib_entry_index,
  96                              mfib_source_t source,
  97                              mfib_entry_flags_t entry_flags,
  98                              index_t rep_dpo);
  99
 100 extern void mfib_entry_path_update(fib_node_index_t fib_entry_index,
 101                                    mfib_source_t source,
 102                                    const fib_route_path_t *rpath,
 103                                    mfib_itf_flags_t itf_flags);
 104
 105
 106 extern int mfib_entry_path_remove(fib_node_index_t fib_entry_index,
 107                                   mfib_source_t source,
 108                                   const fib_route_path_t *rpath);
 109
 110 extern int mfib_entry_delete(fib_node_index_t mfib_entry_index,
 111                              mfib_source_t source);
 112
 113 extern int mfib_entry_cmp_for_sort(void *i1, void *i2);
 114
 115 extern u32 mfib_entry_child_add(fib_node_index_t mfib_entry_index,
 116                                 fib_node_type_t type,
 117                                 fib_node_index_t child_index);
 118 extern void mfib_entry_child_remove(fib_node_index_t mfib_entry_index,
 119                                     u32 sibling_index);
 120
 121 extern void mfib_entry_lock(fib_node_index_t fib_entry_index);
 122 extern void mfib_entry_unlock(fib_node_index_t fib_entry_index);
 123
 124 extern void mfib_entry_get_prefix(fib_node_index_t fib_entry_index,
 125                                   mfib_prefix_t *pfx);
 126 extern u32 mfib_entry_get_fib_index(fib_node_index_t fib_entry_index);
 127
 128 extern void mfib_entry_contribute_forwarding(
 129     fib_node_index_t mfib_entry_index,
 130     fib_forward_chain_type_t type,
 131     dpo_id_t *dpo);
 132
 133 extern void mfib_entry_encode(fib_node_index_t fib_entry_index,
 134                               fib_route_path_encode_t **api_rpaths);
 135
 136 extern void mfib_entry_module_init(void);
 137
 138
 139 extern mfib_entry_t *mfib_entry_pool;
 140
 141 static inline mfib_entry_t *
 142 mfib_entry_get (fib_node_index_t index)
 143 {
 144     return (pool_elt_at_index(mfib_entry_pool, index));
 145 }
 146 static inline fib_node_index_t
 147 mfib_entry_get_index (const mfib_entry_t *mfe)
 148 {
 149     return (mfe - mfib_entry_pool);
 150 }
 151
 152
 153 static inline mfib_itf_t *
 154 mfib_entry_itf_find (mfib_itf_t *itfs,
 155                      u32 sw_if_index)
 156 {
 157     uword *p;
 158
 159     p = hash_get(itfs, sw_if_index);
 160
 161     if (NULL != p)
 162     {
 163         return (mfib_itf_get(p[0]));
 164     }
 165
 166     return (NULL);
 167 }
 168
 169 static inline mfib_itf_t *
 170 mfib_entry_get_itf (const mfib_entry_t *mfe,
 171                     u32 sw_if_index)
 172 {
 173     return (mfib_entry_itf_find(mfe->mfe_itfs, sw_if_index));
 174 }
 175
 176 #endif