src/vnet/fib/ip6_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 #ifndef __IP6_FIB_H__
  17 #define __IP6_FIB_H__
  18
  19 #include <vlib/vlib.h>
  20 #include <vnet/ip/format.h>
  21 #include <vnet/fib/fib_entry.h>
  22 #include <vnet/fib/fib_table.h>
  23 #include <vnet/ip/lookup.h>
  24 #include <vnet/dpo/load_balance.h>
  25
  26 extern fib_node_index_t ip6_fib_table_lookup(u32 fib_index,
  27                                              const ip6_address_t *addr,
  28                                              u32 len);
  29 extern fib_node_index_t ip6_fib_table_lookup_exact_match(u32 fib_index,
  30                                                          const ip6_address_t *addr,
  31                                                          u32 len);
  32
  33 extern void ip6_fib_table_entry_remove(u32 fib_index,
  34                                        const ip6_address_t *addr,
  35                                        u32 len);
  36
  37 extern void ip6_fib_table_entry_insert(u32 fib_index,
  38                                        const ip6_address_t *addr,
  39                                        u32 len,
  40                                        fib_node_index_t fib_entry_index);
  41 extern void ip6_fib_table_destroy(u32 fib_index);
  42
  43 extern void ip6_fib_table_fwding_dpo_update(u32 fib_index,
  44                                             const ip6_address_t *addr,
  45                                             u32 len,
  46                                             const dpo_id_t *dpo);
  47
  48 extern void ip6_fib_table_fwding_dpo_remove(u32 fib_index,
  49                                             const ip6_address_t *addr,
  50                                             u32 len,
  51                                             const dpo_id_t *dpo);
  52
  53 u32 ip6_fib_table_fwding_lookup_with_if_index(ip6_main_t * im,
  54                                               u32 sw_if_index,
  55                                               const ip6_address_t * dst);
  56
  57 /**
  58  * @brief Walk all entries in a FIB table
  59  * N.B: This is NOT safe to deletes. If you need to delete walk the whole
  60  * table and store elements in a vector, then delete the elements
  61  */
  62 extern void ip6_fib_table_walk(u32 fib_index,
  63                                fib_table_walk_fn_t fn,
  64                                void *ctx);
  65
  66 always_inline u32
  67 ip6_fib_table_fwding_lookup (ip6_main_t * im,
  68                              u32 fib_index,
  69                              const ip6_address_t * dst)
  70 {
  71     ip6_fib_table_instance_t *table;
  72     clib_bihash_kv_24_8_t kv, value;
  73     int i, len;
  74     int rv;
  75     u64 fib;
  76
  77     table = &ip6_main.ip6_table[IP6_FIB_TABLE_FWDING];
  78     len = vec_len (table->prefix_lengths_in_search_order);
  79
  80     kv.key[0] = dst->as_u64[0];
  81     kv.key[1] = dst->as_u64[1];
  82     fib = ((u64)((fib_index))<<32);
  83
  84     for (i = 0; i < len; i++)
  85     {
  86         int dst_address_length = table->prefix_lengths_in_search_order[i];
  87         ip6_address_t * mask = &ip6_main.fib_masks[dst_address_length];
  88
  89         ASSERT(dst_address_length >= 0 && dst_address_length <= 128);
  90         //As lengths are decreasing, masks are increasingly specific.
  91         kv.key[0] &= mask->as_u64[0];
  92         kv.key[1] &= mask->as_u64[1];
  93         kv.key[2] = fib | dst_address_length;
  94
  95         rv = clib_bihash_search_inline_2_24_8(&table->ip6_hash, &kv, &value);
  96         if (rv == 0)
  97             return value.value;
  98     }
  99
 100     /* default route is always present */
 101     ASSERT(0);
 102     return 0;
 103 }
 104
 105 /**
 106  * @brief Walk all entries in a sub-tree of the FIB table
 107  * N.B: This is NOT safe to deletes. If you need to delete walk the whole
 108  * table and store elements in a vector, then delete the elements
 109  */
 110 extern void ip6_fib_table_sub_tree_walk(u32 fib_index,
 111                                         const fib_prefix_t *root,
 112                                         fib_table_walk_fn_t fn,
 113                                         void *ctx);
 114
 115 /**
 116  * @brief return the DPO that the LB stacks on.
 117  */
 118 always_inline u32
 119 ip6_src_lookup_for_packet (ip6_main_t * im,
 120                            vlib_buffer_t * b,
 121                            ip6_header_t * i)
 122 {
 123     if (vnet_buffer (b)->ip.adj_index[VLIB_RX] == ~0)
 124     {
 125         const dpo_id_t *dpo;
 126         index_t lbi;
 127
 128         lbi = ip6_fib_table_fwding_lookup_with_if_index(
 129                   im,
 130                   vnet_buffer (b)->sw_if_index[VLIB_RX],
 131                   &i->src_address);
 132
 133         dpo = load_balance_get_bucket_i(load_balance_get(lbi), 0);
 134
 135         if (dpo_is_adj(dpo))
 136         {
 137             vnet_buffer (b)->ip.adj_index[VLIB_RX] = dpo->dpoi_index;
 138         }
 139     }
 140     return vnet_buffer (b)->ip.adj_index[VLIB_RX];
 141 }
 142
 143 /**
 144  * \brief Get or create an IPv6 fib.
 145  *
 146  * Get or create an IPv4 fib with the provided table ID.
 147  *
 148  * \param im
 149  *      ip4_main pointer.
 150  * \param table_id
 151  *      When set to \c ~0, an arbitrary and unused fib ID is picked
 152  *      and can be retrieved with \c ret->table_id.
 153  *      Otherwise, the fib ID to be used to retrieve or create the desired fib.
 154  * \returns A pointer to the retrieved or created fib.
 155  *
 156  */
 157 extern u32 ip6_fib_table_find_or_create_and_lock(u32 table_id,
 158                                                  fib_source_t src);
 159 extern u32 ip6_fib_table_create_and_lock(fib_source_t src,
 160                                          fib_table_flags_t flags,
 161                                          u8* desc);
 162
 163 extern u8 *format_ip6_fib_table_memory(u8 * s, va_list * args);
 164
 165 static inline ip6_fib_t *
 166 ip6_fib_get (fib_node_index_t index)
 167 {
 168     ASSERT(!pool_is_free_index(ip6_main.fibs, index));
 169     return (pool_elt_at_index (ip6_main.v6_fibs, index));
 170 }
 171
 172 static inline
 173 u32 ip6_fib_index_from_table_id (u32 table_id)
 174 {
 175   ip6_main_t * im = &ip6_main;
 176   uword * p;
 177
 178   p = hash_get (im->fib_index_by_table_id, table_id);
 179   if (!p)
 180     return ~0;
 181
 182   return p[0];
 183 }
 184
 185 extern u32 ip6_fib_table_get_index_for_sw_if_index(u32 sw_if_index);
 186
 187 #endif
 188