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     /**
  47      * A vector of sources contributing forwarding
  48      */
  49     struct mfib_entry_src_t_ *mfe_srcs;
  50
  51     /**
  52      * The path-list of which this entry is a child
  53      */
  54     fib_node_index_t mfe_pl;
  55
  56     /**
  57      * The sibling index on the path-list
  58      */
  59     u32 mfe_sibling;
  60
  61     /**
  62      * 2nd cache line has the members used in the data plane
  63      */
  64     CLIB_CACHE_LINE_ALIGN_MARK(cacheline1);
  65
  66     /**
  67      * The DPO used for forwarding; replicate, drop, etc..
  68      */
  69     dpo_id_t mfe_rep;
  70
  71     /**
  72      * Route flags
  73      */
  74     mfib_entry_flags_t mfe_flags;
  75
  76     /**
  77      * RPF-ID used when the packets ingress not from an interface
  78      */
  79     fib_rpf_id_t mfe_rpf_id;
  80
  81     /**
  82      * A hash table of interfaces
  83      */
  84     mfib_itf_t *mfe_itfs;
  85 } mfib_entry_t;
  86
  87 #define MFIB_ENTRY_FORMAT_BRIEF   (0x0)
  88 #define MFIB_ENTRY_FORMAT_DETAIL  (0x1)
  89 #define MFIB_ENTRY_FORMAT_DETAIL2 (0x2)
  90
  91 extern u8 *format_mfib_entry(u8 * s, va_list * args);
  92
  93
  94 extern fib_node_index_t mfib_entry_create(u32 fib_index,
  95                                           mfib_source_t source,
  96                                           const mfib_prefix_t *prefix,
  97                                           fib_rpf_id_t rpf_id,
  98                                           mfib_entry_flags_t entry_flags);
  99
 100 extern int mfib_entry_update(fib_node_index_t fib_entry_index,
 101                              mfib_source_t source,
 102                              mfib_entry_flags_t entry_flags,
 103                              fib_rpf_id_t rpf_id,
 104                              index_t rep_dpo);
 105
 106 extern void mfib_entry_path_update(fib_node_index_t fib_entry_index,
 107                                    mfib_source_t source,
 108                                    const fib_route_path_t *rpath,
 109                                    mfib_itf_flags_t itf_flags);
 110
 111
 112 extern int mfib_entry_path_remove(fib_node_index_t fib_entry_index,
 113                                   mfib_source_t source,
 114                                   const fib_route_path_t *rpath);
 115
 116 extern int mfib_entry_delete(fib_node_index_t mfib_entry_index,
 117                              mfib_source_t source);
 118
 119 extern int mfib_entry_cmp_for_sort(void *i1, void *i2);
 120
 121 extern u32 mfib_entry_child_add(fib_node_index_t mfib_entry_index,
 122                                 fib_node_type_t type,
 123                                 fib_node_index_t child_index);
 124 extern void mfib_entry_child_remove(fib_node_index_t mfib_entry_index,
 125                                     u32 sibling_index);
 126
 127 extern void mfib_entry_lock(fib_node_index_t fib_entry_index);
 128 extern void mfib_entry_unlock(fib_node_index_t fib_entry_index);
 129
 130 extern void mfib_entry_get_prefix(fib_node_index_t fib_entry_index,
 131                                   mfib_prefix_t *pfx);
 132 extern u32 mfib_entry_get_fib_index(fib_node_index_t fib_entry_index);
 133 extern int mfib_entry_is_sourced(fib_node_index_t fib_entry_index,
 134                                  mfib_source_t source);
 135 extern u32 mfib_entry_get_stats_index(fib_node_index_t fib_entry_index);
 136
 137 extern const dpo_id_t*mfib_entry_contribute_ip_forwarding(
 138     fib_node_index_t mfib_entry_index);
 139
 140 extern void mfib_entry_contribute_forwarding(
 141     fib_node_index_t mfib_entry_index,
 142     fib_forward_chain_type_t type,
 143     dpo_id_t *dpo);
 144
 145 extern void mfib_entry_encode(fib_node_index_t fib_entry_index,
 146                               fib_route_path_encode_t **api_rpaths);
 147
 148 extern void mfib_entry_module_init(void);
 149
 150
 151 extern mfib_entry_t *mfib_entry_pool;
 152
 153 static inline mfib_entry_t *
 154 mfib_entry_get (fib_node_index_t index)
 155 {
 156     return (pool_elt_at_index(mfib_entry_pool, index));
 157 }
 158 static inline fib_node_index_t
 159 mfib_entry_get_index (const mfib_entry_t *mfe)
 160 {
 161     return (mfe - mfib_entry_pool);
 162 }
 163
 164
 165 static inline mfib_itf_t *
 166 mfib_entry_itf_find (mfib_itf_t *itfs,
 167                      u32 sw_if_index)
 168 {
 169     uword *p;
 170
 171     p = hash_get(itfs, sw_if_index);
 172
 173     if (NULL != p)
 174     {
 175         return (mfib_itf_get(p[0]));
 176     }
 177
 178     return (NULL);
 179 }
 180
 181 static inline mfib_itf_t *
 182 mfib_entry_get_itf (const mfib_entry_t *mfe,
 183                     u32 sw_if_index)
 184 {
 185     return (mfib_entry_itf_find(mfe->mfe_itfs, sw_if_index));
 186 }
 187
 188 #endif