src/vnet/fib/ip4_fib.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  * @brief The IPv4 FIB
  17  *
  18  * FIBs are composed of two prefix data-bases (akak tables). The non-forwarding
  19  * table contains all the routes that the control plane has programmed, the
  20  * forwarding table contains the sub-set of those routes that can be used to
  21  * forward packets.
  22  * In the IPv4 FIB the non-forwarding table is an array of hash tables indexed
  23  * by mask length, the forwarding table is an mtrie
  24  *
  25  * This IPv4 FIB is used by the protocol independent FIB. So directly using
  26  * this APIs in client code is not encouraged. However, this IPv4 FIB can be
  27  * used if all the client wants is an IPv4 prefix data-base
  28  */
  29
  30 #ifndef __IP4_FIB_H__
  31 #define __IP4_FIB_H__
  32
  33 #include <vlib/vlib.h>
  34 #include <vnet/ip/ip.h>
  35 #include <vnet/fib/fib_entry.h>
  36 #include <vnet/fib/fib_table.h>
  37 #include <vnet/ip/ip4_mtrie.h>
  38
  39 typedef struct ip4_fib_t_
  40 {
  41   /**
  42    * Mtrie for fast lookups. Hash is used to maintain overlapping prefixes.
  43    * First member so it's in the first cacheline.
  44    */
  45   ip4_fib_mtrie_t mtrie;
  46
  47   /* Hash table for each prefix length mapping. */
  48   uword *fib_entry_by_dst_address[33];
  49
  50   /* Table ID (hash key) for this FIB. */
  51   u32 table_id;
  52
  53   /* Index into FIB vector. */
  54   u32 index;
  55
  56   /* N-tuple classifier indices */
  57   u32 fwd_classify_table_index;
  58   u32 rev_classify_table_index;
  59
  60 } ip4_fib_t;
  61
  62 extern fib_node_index_t ip4_fib_table_lookup(const ip4_fib_t *fib,
  63                                              const ip4_address_t *addr,
  64                                              u32 len);
  65 extern fib_node_index_t ip4_fib_table_lookup_exact_match(const ip4_fib_t *fib,
  66                                                          const ip4_address_t *addr,
  67                                                          u32 len);
  68
  69 extern void ip4_fib_table_entry_remove(ip4_fib_t *fib,
  70                                        const ip4_address_t *addr,
  71                                        u32 len);
  72
  73 extern void ip4_fib_table_entry_insert(ip4_fib_t *fib,
  74                                        const ip4_address_t *addr,
  75                                        u32 len,
  76                                        fib_node_index_t fib_entry_index);
  77 extern void ip4_fib_table_destroy(u32 fib_index);
  78
  79 extern void ip4_fib_table_fwding_dpo_update(ip4_fib_t *fib,
  80                                             const ip4_address_t *addr,
  81                                             u32 len,
  82                                             const dpo_id_t *dpo);
  83
  84 extern void ip4_fib_table_fwding_dpo_remove(ip4_fib_t *fib,
  85                                             const ip4_address_t *addr,
  86                                             u32 len,
  87                                             const dpo_id_t *dpo,
  88                                             fib_node_index_t cover_index);
  89 extern u32 ip4_fib_table_lookup_lb (ip4_fib_t *fib,
  90                                     const ip4_address_t * dst);
  91
  92 /**
  93  * @brief Walk all entries in a FIB table
  94  * N.B: This is NOT safe to deletes. If you need to delete walk the whole
  95  * table and store elements in a vector, then delete the elements
  96  */
  97 extern void ip4_fib_table_walk(ip4_fib_t *fib,
  98                                fib_table_walk_fn_t fn,
  99                                void *ctx);
 100
 101 /**
 102  * @brief Walk all entries in a sub-tree of the FIB table
 103  * N.B: This is NOT safe to deletes. If you need to delete walk the whole
 104  * table and store elements in a vector, then delete the elements
 105  */
 106 extern void ip4_fib_table_sub_tree_walk(ip4_fib_t *fib,
 107                                         const fib_prefix_t *root,
 108                                         fib_table_walk_fn_t fn,
 109                                         void *ctx);
 110
 111 /**
 112  * @brief Get the FIB at the given index
 113  */
 114 static inline ip4_fib_t *
 115 ip4_fib_get (u32 index)
 116 {
 117     return (pool_elt_at_index(ip4_main.v4_fibs, index));
 118 }
 119
 120 always_inline u32
 121 ip4_fib_lookup (ip4_main_t * im, u32 sw_if_index, ip4_address_t * dst)
 122 {
 123     return (ip4_fib_table_lookup_lb(
 124                 ip4_fib_get(vec_elt (im->fib_index_by_sw_if_index, sw_if_index)),
 125                 dst));
 126 }
 127
 128 /**
 129  * @brief Get or create an IPv4 fib.
 130  *
 131  * Get or create an IPv4 fib with the provided table ID.
 132  *
 133  * @param table_id
 134  *      When set to \c ~0, an arbitrary and unused fib ID is picked
 135  *      and can be retrieved with \c ret->table_id.
 136  *      Otherwise, the fib ID to be used to retrieve or create the desired fib.
 137  * @returns A pointer to the retrieved or created fib.
 138  *
 139  */
 140 extern u32 ip4_fib_table_find_or_create_and_lock(u32 table_id,
 141                                                  fib_source_t src);
 142 extern u32 ip4_fib_table_create_and_lock(fib_source_t src);
 143
 144 extern u8 *format_ip4_fib_table_memory(u8 * s, va_list * args);
 145
 146 static inline
 147 u32 ip4_fib_index_from_table_id (u32 table_id)
 148 {
 149   ip4_main_t * im = &ip4_main;
 150   uword * p;
 151
 152   p = hash_get (im->fib_index_by_table_id, table_id);
 153   if (!p)
 154     return ~0;
 155
 156   return p[0];
 157 }
 158
 159 extern u32 ip4_fib_table_get_index_for_sw_if_index(u32 sw_if_index);
 160
 161 always_inline index_t
 162 ip4_fib_forwarding_lookup (u32 fib_index,
 163                            const ip4_address_t * addr)
 164 {
 165     ip4_fib_mtrie_leaf_t leaf;
 166     ip4_fib_mtrie_t * mtrie;
 167
 168     mtrie = &ip4_fib_get(fib_index)->mtrie;
 169
 170     leaf = ip4_fib_mtrie_lookup_step_one (mtrie, addr);
 171     leaf = ip4_fib_mtrie_lookup_step (mtrie, leaf, addr, 2);
 172     leaf = ip4_fib_mtrie_lookup_step (mtrie, leaf, addr, 3);
 173
 174     return (ip4_fib_mtrie_leaf_get_adj_index(leaf));
 175 }
 176
 177
 178 #endif
 179