src/vnet/adj/adj_glean.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/fib/fib_walk.h>
  19
  20 /*
  21  * The 'DB' of all glean adjs.
  22  * There is one glean per-{interface, protocol, connected prefix}
  23  */
  24 static uword **adj_gleans[FIB_PROTOCOL_IP_MAX];
  25
  26 static inline u32
  27 adj_get_glean_node (fib_protocol_t proto)
  28 {
  29     switch (proto) {
  30     case FIB_PROTOCOL_IP4:
  31         return (ip4_glean_node.index);
  32     case FIB_PROTOCOL_IP6:
  33         return (ip6_glean_node.index);
  34     case FIB_PROTOCOL_MPLS:
  35         break;
  36     }
  37     ASSERT(0);
  38     return (~0);
  39 }
  40
  41 static adj_index_t
  42 adj_glean_db_lookup (fib_protocol_t proto,
  43                      u32 sw_if_index,
  44                      const ip46_address_t *nh_addr)
  45 {
  46     uword *p;
  47
  48     if (vec_len(adj_gleans[proto]) <= sw_if_index)
  49         return (ADJ_INDEX_INVALID);
  50
  51     p = hash_get_mem (adj_gleans[proto][sw_if_index], nh_addr);
  52
  53     if (p)
  54         return (p[0]);
  55
  56     return (ADJ_INDEX_INVALID);
  57 }
  58
  59 static void
  60 adj_glean_db_insert (fib_protocol_t proto,
  61                      u32 sw_if_index,
  62                      const ip46_address_t *nh_addr,
  63                      adj_index_t ai)
  64 {
  65     vlib_main_t *vm = vlib_get_main();
  66
  67     vlib_worker_thread_barrier_sync(vm);
  68
  69     vec_validate(adj_gleans[proto], sw_if_index);
  70
  71     if (NULL == adj_gleans[proto][sw_if_index])
  72     {
  73         adj_gleans[proto][sw_if_index] =
  74             hash_create_mem (0, sizeof(ip46_address_t), sizeof(adj_index_t));
  75     }
  76
  77     hash_set_mem_alloc (&adj_gleans[proto][sw_if_index],
  78                         nh_addr, ai);
  79
  80     vlib_worker_thread_barrier_release(vm);
  81 }
  82
  83 static void
  84 adj_glean_db_remove (fib_protocol_t proto,
  85                      u32 sw_if_index,
  86                      const ip46_address_t *nh_addr)
  87 {
  88     vlib_main_t *vm = vlib_get_main();
  89
  90     vlib_worker_thread_barrier_sync(vm);
  91
  92     ASSERT(ADJ_INDEX_INVALID != adj_glean_db_lookup(proto, sw_if_index, nh_addr));
  93     hash_unset_mem_free (&adj_gleans[proto][sw_if_index],
  94                          nh_addr);
  95
  96     if (0 == hash_elts(adj_gleans[proto][sw_if_index]))
  97     {
  98         hash_free(adj_gleans[proto][sw_if_index]);
  99         adj_gleans[proto][sw_if_index] = NULL;
 100     }
 101     vlib_worker_thread_barrier_release(vm);
 102 }
 103
 104 /*
 105  * adj_glean_add_or_lock
 106  *
 107  * The next_hop address here is used for source address selection in the DP.
 108  * The glean adj is added to an interface's connected prefix, the next-hop
 109  * passed here is the local prefix on the same interface.
 110  */
 111 adj_index_t
 112 adj_glean_add_or_lock (fib_protocol_t proto,
 113                        vnet_link_t linkt,
 114                        u32 sw_if_index,
 115                        const fib_prefix_t *conn)
 116 {
 117     ip_adjacency_t * adj;
 118     adj_index_t ai;
 119
 120     ai = adj_glean_db_lookup(proto, sw_if_index, &conn->fp_addr);
 121
 122     if (ADJ_INDEX_INVALID == ai)
 123     {
 124         adj = adj_alloc(proto);
 125
 126         adj->lookup_next_index = IP_LOOKUP_NEXT_GLEAN;
 127         adj->ia_nh_proto = proto;
 128         adj->ia_link = linkt;
 129         adj->ia_node_index = adj_get_glean_node(proto);
 130         ai = adj_get_index(adj);
 131         adj_lock(ai);
 132
 133         ASSERT(conn);
 134         fib_prefix_normalize(conn, &adj->sub_type.glean.rx_pfx);
 135         adj->rewrite_header.sw_if_index = sw_if_index;
 136         adj->rewrite_header.data_bytes = 0;
 137         adj->rewrite_header.max_l3_packet_bytes =
 138           vnet_sw_interface_get_mtu(vnet_get_main(), sw_if_index,
 139                                     vnet_link_to_mtu(linkt));
 140
 141         vnet_update_adjacency_for_sw_interface(vnet_get_main(),
 142                                                sw_if_index,
 143                                                ai);
 144
 145         adj_glean_db_insert(proto, sw_if_index,
 146                             &adj->sub_type.glean.rx_pfx.fp_addr, ai);
 147     }
 148     else
 149     {
 150         adj = adj_get(ai);
 151         adj_lock(ai);
 152     }
 153
 154     adj_delegate_adj_created(adj);
 155
 156     return (ai);
 157 }
 158
 159 /**
 160  * adj_glean_update_rewrite
 161  */
 162 void
 163 adj_glean_update_rewrite (adj_index_t adj_index)
 164 {
 165     ip_adjacency_t *adj;
 166
 167     ASSERT(ADJ_INDEX_INVALID != adj_index);
 168
 169     adj = adj_get(adj_index);
 170
 171     vnet_rewrite_for_sw_interface(vnet_get_main(),
 172                                   adj_fib_proto_2_nd(adj->ia_nh_proto),
 173                                   adj->rewrite_header.sw_if_index,
 174                                   adj->ia_node_index,
 175                                   VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST,
 176                                   &adj->rewrite_header,
 177                                   sizeof (adj->rewrite_data));
 178 }
 179
 180 static adj_walk_rc_t
 181 adj_glean_update_rewrite_walk (adj_index_t ai,
 182                                void *data)
 183 {
 184     adj_glean_update_rewrite(ai);
 185
 186     return (ADJ_WALK_RC_CONTINUE);
 187 }
 188
 189 void
 190 adj_glean_update_rewrite_itf (u32 sw_if_index)
 191 {
 192     adj_glean_walk (sw_if_index, adj_glean_update_rewrite_walk, NULL);
 193 }
 194
 195 void
 196 adj_glean_walk (u32 sw_if_index,
 197                 adj_walk_cb_t cb,
 198                 void *data)
 199 {
 200     fib_protocol_t proto;
 201
 202     FOR_EACH_FIB_IP_PROTOCOL(proto)
 203     {
 204         adj_index_t ai, *aip, *ais = NULL;
 205         ip46_address_t *conn;
 206
 207         if (vec_len(adj_gleans[proto]) <= sw_if_index ||
 208             NULL == adj_gleans[proto][sw_if_index])
 209             continue;
 210
 211         /*
 212          * Walk first to collect the indices
 213          * then walk the collection. This is safe
 214          * to modifications of the hash table
 215          */
 216         hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
 217         ({
 218             vec_add1(ais, ai);
 219         }));
 220
 221         vec_foreach(aip, ais)
 222         {
 223             if (ADJ_WALK_RC_STOP == cb(*aip, data))
 224                 break;
 225         }
 226         vec_free(ais);
 227     }
 228 }
 229
 230 adj_index_t
 231 adj_glean_get (fib_protocol_t proto,
 232                u32 sw_if_index,
 233                const ip46_address_t *nh)
 234 {
 235     if (NULL != nh)
 236     {
 237         return adj_glean_db_lookup(proto, sw_if_index, nh);
 238     }
 239     else
 240     {
 241         ip46_address_t *conn;
 242         adj_index_t ai;
 243
 244         if (vec_len(adj_gleans[proto]) <= sw_if_index ||
 245             NULL == adj_gleans[proto][sw_if_index])
 246             return (ADJ_INDEX_INVALID);
 247
 248         hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
 249         ({
 250             return (ai);
 251         }));
 252     }
 253     return (ADJ_INDEX_INVALID);
 254 }
 255
 256 const ip46_address_t *
 257 adj_glean_get_src (fib_protocol_t proto,
 258                    u32 sw_if_index,
 259                    const ip46_address_t *nh)
 260 {
 261     const ip46_address_t *conn, *source;
 262     const ip_adjacency_t *adj;
 263     adj_index_t ai;
 264
 265     if (vec_len(adj_gleans[proto]) <= sw_if_index ||
 266         NULL == adj_gleans[proto][sw_if_index])
 267         return (NULL);
 268
 269     fib_prefix_t pfx = {
 270         .fp_len = fib_prefix_get_host_length(proto),
 271         .fp_proto = proto,
 272     };
 273
 274     if (nh)
 275         pfx.fp_addr = *nh;
 276
 277     /*
 278      * An interface can have more than one glean address. Where
 279      * possible we want to return a source address from the same
 280      * subnet as the destination. If this is not possible then any address
 281      * will do.
 282      */
 283     source = NULL;
 284
 285     hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
 286     ({
 287         adj = adj_get(ai);
 288
 289         if (adj->sub_type.glean.rx_pfx.fp_len > 0)
 290         {
 291             source = &adj->sub_type.glean.rx_pfx.fp_addr;
 292
 293             /* if no destination is specified use the just glean */
 294             if (NULL == nh)
 295                 return (source);
 296
 297             /* check the clean covers the desintation */
 298             if (fib_prefix_is_cover(&adj->sub_type.glean.rx_pfx, &pfx))
 299                 return (source);
 300         }
 301     }));
 302
 303     return (source);
 304 }
 305
 306 void
 307 adj_glean_remove (ip_adjacency_t *adj)
 308 {
 309     fib_prefix_t norm;
 310
 311     fib_prefix_normalize(&adj->sub_type.glean.rx_pfx,
 312                          &norm);
 313     adj_glean_db_remove(adj->ia_nh_proto,
 314                         adj->rewrite_header.sw_if_index,
 315                         &norm.fp_addr);
 316 }
 317
 318 static adj_walk_rc_t
 319 adj_glean_start_backwalk (adj_index_t ai,
 320                           void *data)
 321 {
 322     fib_node_back_walk_ctx_t bw_ctx = *(fib_node_back_walk_ctx_t*) data;
 323
 324     fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
 325
 326     return (ADJ_WALK_RC_CONTINUE);
 327 }
 328
 329 static clib_error_t *
 330 adj_glean_interface_state_change (vnet_main_t * vnm,
 331                                   u32 sw_if_index,
 332                                   u32 flags)
 333 {
 334     /*
 335      * for each glean on the interface trigger a walk back to the children
 336      */
 337     fib_node_back_walk_ctx_t bw_ctx = {
 338         .fnbw_reason = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
 339                         FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
 340                         FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
 341     };
 342
 343     adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
 344
 345     return (NULL);
 346 }
 347
 348 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_glean_interface_state_change);
 349
 350 /**
 351  * @brief Invoked on each SW interface of a HW interface when the
 352  * HW interface state changes
 353  */
 354 static walk_rc_t
 355 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
 356                                       u32 sw_if_index,
 357                                       void *arg)
 358 {
 359     adj_glean_interface_state_change(vnm, sw_if_index, (uword) arg);
 360
 361     return (WALK_CONTINUE);
 362 }
 363
 364 /**
 365  * @brief Registered callback for HW interface state changes
 366  */
 367 static clib_error_t *
 368 adj_glean_hw_interface_state_change (vnet_main_t * vnm,
 369                                      u32 hw_if_index,
 370                                      u32 flags)
 371 {
 372     /*
 373      * walk SW interfaces on the HW
 374      */
 375     uword sw_flags;
 376
 377     sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
 378                 VNET_SW_INTERFACE_FLAG_ADMIN_UP :
 379                 0);
 380
 381     vnet_hw_interface_walk_sw(vnm, hw_if_index,
 382                               adj_nbr_hw_sw_interface_state_change,
 383                               (void*) sw_flags);
 384
 385     return (NULL);
 386 }
 387
 388 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(
 389     adj_glean_hw_interface_state_change);
 390
 391 static clib_error_t *
 392 adj_glean_interface_delete (vnet_main_t * vnm,
 393                             u32 sw_if_index,
 394                             u32 is_add)
 395 {
 396     if (is_add)
 397     {
 398         /*
 399          * not interested in interface additions. we will not back walk
 400          * to resolve paths through newly added interfaces. Why? The control
 401          * plane should have the brains to add interfaces first, then routes.
 402          * So the case where there are paths with a interface that matches
 403          * one just created is the case where the path resolved through an
 404          * interface that was deleted, and still has not been removed. The
 405          * new interface added, is NO GUARANTEE that the interface being
 406          * added now, even though it may have the same sw_if_index, is the
 407          * same interface that the path needs. So tough!
 408          * If the control plane wants these routes to resolve it needs to
 409          * remove and add them again.
 410          */
 411         return (NULL);
 412     }
 413
 414     /*
 415      * for each glean on the interface trigger a walk back to the children
 416      */
 417     fib_node_back_walk_ctx_t bw_ctx = {
 418         .fnbw_reason =  FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
 419     };
 420
 421     adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
 422
 423     return (NULL);
 424 }
 425
 426 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_glean_interface_delete);
 427
 428 u8*
 429 format_adj_glean (u8* s, va_list *ap)
 430 {
 431     index_t index = va_arg(*ap, index_t);
 432     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 433     ip_adjacency_t * adj = adj_get(index);
 434
 435     s = format(s, "%U-glean: [src:%U] %U",
 436                format_fib_protocol, adj->ia_nh_proto,
 437                format_fib_prefix, &adj->sub_type.glean.rx_pfx,
 438                format_vnet_rewrite,
 439                &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
 440
 441     return (s);
 442 }
 443
 444 u32
 445 adj_glean_db_size (void)
 446 {
 447     fib_protocol_t proto;
 448     u32 sw_if_index = 0;
 449     u64 count = 0;
 450
 451     FOR_EACH_FIB_IP_PROTOCOL(proto)
 452     {
 453         vec_foreach_index(sw_if_index, adj_gleans[proto])
 454         {
 455             if (NULL != adj_gleans[proto][sw_if_index])
 456             {
 457                 count += hash_elts(adj_gleans[proto][sw_if_index]);
 458             }
 459         }
 460     }
 461     return (count);
 462 }
 463
 464 static void
 465 adj_dpo_lock (dpo_id_t *dpo)
 466 {
 467     adj_lock(dpo->dpoi_index);
 468 }
 469 static void
 470 adj_dpo_unlock (dpo_id_t *dpo)
 471 {
 472     adj_unlock(dpo->dpoi_index);
 473 }
 474
 475 const static dpo_vft_t adj_glean_dpo_vft = {
 476     .dv_lock = adj_dpo_lock,
 477     .dv_unlock = adj_dpo_unlock,
 478     .dv_format = format_adj_glean,
 479     .dv_get_urpf = adj_dpo_get_urpf,
 480     .dv_get_mtu = adj_dpo_get_mtu,
 481 };
 482
 483 /**
 484  * @brief The per-protocol VLIB graph nodes that are assigned to a glean
 485  *        object.
 486  *
 487  * this means that these graph nodes are ones from which a glean is the
 488  * parent object in the DPO-graph.
 489  */
 490 const static char* const glean_ip4_nodes[] =
 491 {
 492     "ip4-glean",
 493     NULL,
 494 };
 495 const static char* const glean_ip6_nodes[] =
 496 {
 497     "ip6-glean",
 498     NULL,
 499 };
 500
 501 const static char* const * const glean_nodes[DPO_PROTO_NUM] =
 502 {
 503     [DPO_PROTO_IP4]  = glean_ip4_nodes,
 504     [DPO_PROTO_IP6]  = glean_ip6_nodes,
 505     [DPO_PROTO_MPLS] = NULL,
 506 };
 507
 508 void
 509 adj_glean_module_init (void)
 510 {
 511     dpo_register(DPO_ADJACENCY_GLEAN, &adj_glean_dpo_vft, glean_nodes);
 512 }