vnet/vnet/adj/adj.c

   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 #include <vnet/adj/adj.h>
  17 #include <vnet/adj/adj_internal.h>
  18 #include <vnet/adj/adj_glean.h>
  19 #include <vnet/adj/adj_midchain.h>
  20 #include <vnet/fib/fib_node_list.h>
  21
  22 /*
  23  * Special Adj with index zero. we need to define this since the v4 mtrie
  24  * assumes an index of 0 implies the ply is empty. therefore all 'real'
  25  * adjs need a non-zero index.
  26  */
  27 static ip_adjacency_t *special_v4_miss_adj_with_index_zero;
  28
  29 /* Adjacency packet/byte counters indexed by adjacency index. */
  30 vlib_combined_counter_main_t adjacency_counters;
  31
  32 /*
  33  * the single adj pool
  34  */
  35 ip_adjacency_t *adj_pool;
  36
  37 always_inline void
  38 adj_poison (ip_adjacency_t * adj)
  39 {
  40     if (CLIB_DEBUG > 0)
  41     {
  42         memset (adj, 0xfe, sizeof (adj[0]));
  43     }
  44 }
  45
  46 ip_adjacency_t *
  47 adj_alloc (fib_protocol_t proto)
  48 {
  49     ip_adjacency_t *adj;
  50
  51     pool_get(adj_pool, adj);
  52
  53     adj_poison(adj);
  54
  55     /* Make sure certain fields are always initialized. */
  56     /* Validate adjacency counters. */
  57     vlib_validate_combined_counter(&adjacency_counters,
  58                                    adj_get_index(adj));
  59
  60     adj->rewrite_header.sw_if_index = ~0;
  61     adj->mcast_group_index = ~0;
  62     adj->saved_lookup_next_index = 0;
  63     adj->n_adj = 1;
  64
  65     fib_node_init(&adj->ia_node,
  66                   FIB_NODE_TYPE_ADJ);
  67     adj->ia_nh_proto = proto;
  68
  69     ip4_main.lookup_main.adjacency_heap = adj_pool;
  70     ip6_main.lookup_main.adjacency_heap = adj_pool;
  71
  72     return (adj);
  73 }
  74
  75 static int
  76 adj_index_is_special (adj_index_t adj_index)
  77 {
  78     if (ADJ_INDEX_INVALID == adj_index)
  79         return (!0);
  80
  81     return (0);
  82 }
  83
  84 /**
  85  * @brief Pretty print helper function for formatting specific adjacencies.
  86  * @param s - input string to format
  87  * @param args - other args passed to format function such as:
  88  *                 - vnet_main_t
  89  *                 - ip_lookup_main_t
  90  *                 - adj_index
  91  */
  92 u8 *
  93 format_ip_adjacency (u8 * s, va_list * args)
  94 {
  95   vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
  96   u32 adj_index = va_arg (*args, u32);
  97   format_ip_adjacency_flags_t fiaf = va_arg (*args, format_ip_adjacency_flags_t);
  98   ip_adjacency_t * adj = adj_get(adj_index);
  99
 100   switch (adj->lookup_next_index)
 101   {
 102   case IP_LOOKUP_NEXT_REWRITE:
 103       s = format (s, "%U", format_adj_nbr, adj_index, 0);
 104       break;
 105   case IP_LOOKUP_NEXT_ARP:
 106       s = format (s, "%U", format_adj_nbr_incomplete, adj_index, 0);
 107       break;
 108   case IP_LOOKUP_NEXT_GLEAN:
 109       s = format (s, " %U",
 110                   format_vnet_sw_interface_name,
 111                   vnm,
 112                   vnet_get_sw_interface(vnm,
 113                                         adj->rewrite_header.sw_if_index));
 114       break;
 115
 116   case IP_LOOKUP_NEXT_MIDCHAIN:
 117       s = format (s, "%U", format_adj_midchain, adj_index, 2);
 118       break;
 119   default:
 120       break;
 121   }
 122   s = format (s, " index:%d", adj_index);
 123
 124   if (fiaf & FORMAT_IP_ADJACENCY_DETAIL)
 125   {
 126       s = format (s, " locks:%d", adj->ia_node.fn_locks);
 127       s = format(s, "\nchildren:\n ");
 128       s = fib_node_children_format(adj->ia_node.fn_children, s);
 129   }
 130
 131   return s;
 132 }
 133
 134 /*
 135  * adj_last_lock_gone
 136  *
 137  * last lock/reference to the adj has gone, we no longer need it.
 138  */
 139 static void
 140 adj_last_lock_gone (ip_adjacency_t *adj)
 141 {
 142     ASSERT(0 == fib_node_list_get_size(adj->ia_node.fn_children));
 143     ADJ_DBG(adj, "last-lock-gone");
 144
 145     switch (adj->lookup_next_index)
 146     {
 147     case IP_LOOKUP_NEXT_MIDCHAIN:
 148         dpo_reset(&adj->sub_type.midchain.next_dpo);
 149         /* FALL THROUGH */
 150     case IP_LOOKUP_NEXT_ARP:
 151     case IP_LOOKUP_NEXT_REWRITE:
 152         /*
 153          * complete and incomplete nbr adjs
 154          */
 155         adj_nbr_remove(adj->ia_nh_proto,
 156                        adj->ia_link,
 157                        &adj->sub_type.nbr.next_hop,
 158                        adj->rewrite_header.sw_if_index);
 159         break;
 160     case IP_LOOKUP_NEXT_GLEAN:
 161         adj_glean_remove(adj->ia_nh_proto,
 162                          adj->rewrite_header.sw_if_index);
 163         break;
 164     default:
 165         /*
 166          * type not stored in any DB from which we need to remove it
 167          */
 168         break;
 169     }
 170
 171     fib_node_deinit(&adj->ia_node);
 172     pool_put(adj_pool, adj);
 173 }
 174
 175 void
 176 adj_lock (adj_index_t adj_index)
 177 {
 178     ip_adjacency_t *adj;
 179
 180     if (adj_index_is_special(adj_index))
 181     {
 182         return;
 183     }
 184
 185     adj = adj_get(adj_index);
 186     ASSERT(adj);
 187
 188     ADJ_DBG(adj, "lock");
 189     fib_node_lock(&adj->ia_node);
 190 }
 191
 192 void
 193 adj_unlock (adj_index_t adj_index)
 194 {
 195     ip_adjacency_t *adj;
 196
 197     if (adj_index_is_special(adj_index))
 198     {
 199         return;
 200     }
 201
 202     adj = adj_get(adj_index);
 203     ASSERT(adj);
 204
 205     ADJ_DBG(adj, "unlock");
 206     ASSERT(adj);
 207
 208     fib_node_unlock(&adj->ia_node);
 209 }
 210
 211 u32
 212 adj_child_add (adj_index_t adj_index,
 213                fib_node_type_t child_type,
 214                fib_node_index_t child_index)
 215 {
 216     ASSERT(ADJ_INDEX_INVALID != adj_index);
 217     if (adj_index_is_special(adj_index))
 218     {
 219         return (~0);
 220     }
 221
 222     return (fib_node_child_add(FIB_NODE_TYPE_ADJ,
 223                                adj_index,
 224                                child_type,
 225                                child_index));
 226 }
 227
 228 void
 229 adj_child_remove (adj_index_t adj_index,
 230                   u32 sibling_index)
 231 {
 232     if (adj_index_is_special(adj_index))
 233     {
 234         return;
 235     }
 236
 237     fib_node_child_remove(FIB_NODE_TYPE_ADJ,
 238                           adj_index,
 239                           sibling_index);
 240 }
 241
 242 static fib_node_t *
 243 adj_get_node (fib_node_index_t index)
 244 {
 245     ip_adjacency_t *adj;
 246
 247     adj = adj_get(index);
 248
 249     return (&adj->ia_node);
 250 }
 251
 252 #define ADJ_FROM_NODE(_node)                                            \
 253     ((ip_adjacency_t*)((char*)_node - STRUCT_OFFSET_OF(ip_adjacency_t, ia_node)))
 254
 255 static void
 256 adj_node_last_lock_gone (fib_node_t *node)
 257 {
 258     adj_last_lock_gone(ADJ_FROM_NODE(node));
 259 }
 260
 261 static fib_node_back_walk_rc_t
 262 adj_back_walk_notify (fib_node_t *node,
 263                       fib_node_back_walk_ctx_t *ctx)
 264 {
 265     /*
 266      * Que pasa. yo soj en el final!
 267      */
 268     ASSERT(0);
 269
 270     return (FIB_NODE_BACK_WALK_CONTINUE);
 271 }
 272
 273 /*
 274  * Adjacency's graph node virtual function table
 275  */
 276 static const fib_node_vft_t adj_vft = {
 277     .fnv_get = adj_get_node,
 278     .fnv_last_lock = adj_node_last_lock_gone,
 279     .fnv_back_walk = adj_back_walk_notify,
 280 };
 281
 282 static clib_error_t *
 283 adj_module_init (vlib_main_t * vm)
 284 {
 285     fib_node_register_type(FIB_NODE_TYPE_ADJ, &adj_vft);
 286
 287     adj_nbr_module_init();
 288     adj_glean_module_init();
 289     adj_midchain_module_init();
 290
 291     /*
 292      * 4 special adjs for v4 and v6 resp.
 293      */
 294     special_v4_miss_adj_with_index_zero = adj_alloc(FIB_PROTOCOL_IP4);
 295
 296     return (NULL);
 297 }
 298
 299 VLIB_INIT_FUNCTION (adj_module_init);
 300
 301 /*
 302  * DEPRECATED: DO NOT USE
 303  *
 304  * Create new block of given number of contiguous adjacencies.
 305  */
 306 ip_adjacency_t *
 307 ip_add_adjacency (ip_lookup_main_t * lm,
 308                   ip_adjacency_t * copy_adj,
 309                   u32 n_adj,
 310                   u32 * adj_index_return)
 311 {
 312   ip_adjacency_t * adj;
 313
 314   ASSERT(1==n_adj);
 315
 316   adj = adj_alloc(FIB_PROTOCOL_IP4);
 317
 318   if (copy_adj)
 319       *adj = *copy_adj;
 320
 321   *adj_index_return = adj_get_index(adj);
 322   return adj;
 323 }