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_walk (u32 sw_if_index,
 191                 adj_walk_cb_t cb,
 192                 void *data)
 193 {
 194     fib_protocol_t proto;
 195
 196     FOR_EACH_FIB_IP_PROTOCOL(proto)
 197     {
 198         adj_index_t ai, *aip, *ais = NULL;
 199         ip46_address_t *conn;
 200
 201         if (vec_len(adj_gleans[proto]) <= sw_if_index ||
 202             NULL == adj_gleans[proto][sw_if_index])
 203             continue;
 204
 205         /*
 206          * Walk first to collect the indices
 207          * then walk the collection. This is safe
 208          * to modifications of the hash table
 209          */
 210         hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
 211         ({
 212             vec_add1(ais, ai);
 213         }));
 214
 215         vec_foreach(aip, ais)
 216         {
 217             if (ADJ_WALK_RC_STOP == cb(*aip, data))
 218                 break;
 219         }
 220         vec_free(ais);
 221     }
 222 }
 223
 224 adj_index_t
 225 adj_glean_get (fib_protocol_t proto,
 226                u32 sw_if_index,
 227                const ip46_address_t *nh)
 228 {
 229     if (NULL != nh)
 230     {
 231         return adj_glean_db_lookup(proto, sw_if_index, nh);
 232     }
 233     else
 234     {
 235         ip46_address_t *conn;
 236         adj_index_t ai;
 237
 238         if (vec_len(adj_gleans[proto]) <= sw_if_index ||
 239             NULL == adj_gleans[proto][sw_if_index])
 240             return (ADJ_INDEX_INVALID);
 241
 242         hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
 243         ({
 244             return (ai);
 245         }));
 246     }
 247     return (ADJ_INDEX_INVALID);
 248 }
 249
 250 const ip46_address_t *
 251 adj_glean_get_src (fib_protocol_t proto,
 252                    u32 sw_if_index,
 253                    const ip46_address_t *nh)
 254 {
 255     const ip46_address_t *conn, *source;
 256     const ip_adjacency_t *adj;
 257     adj_index_t ai;
 258
 259     if (vec_len(adj_gleans[proto]) <= sw_if_index ||
 260         NULL == adj_gleans[proto][sw_if_index])
 261         return (NULL);
 262
 263     fib_prefix_t pfx = {
 264         .fp_len = fib_prefix_get_host_length(proto),
 265         .fp_proto = proto,
 266     };
 267
 268     if (nh)
 269         pfx.fp_addr = *nh;
 270
 271     /*
 272      * An interface can have more than one glean address. Where
 273      * possible we want to return a source address from the same
 274      * subnet as the destination. If this is not possible then any address
 275      * will do.
 276      */
 277     source = NULL;
 278
 279     hash_foreach_mem(conn, ai, adj_gleans[proto][sw_if_index],
 280     ({
 281         adj = adj_get(ai);
 282
 283         if (adj->sub_type.glean.rx_pfx.fp_len > 0)
 284         {
 285             source = &adj->sub_type.glean.rx_pfx.fp_addr;
 286
 287             /* if no destination is specified use the just glean */
 288             if (NULL == nh)
 289                 return (source);
 290
 291             /* check the clean covers the desintation */
 292             if (fib_prefix_is_cover(&adj->sub_type.glean.rx_pfx, &pfx))
 293                 return (source);
 294         }
 295     }));
 296
 297     return (source);
 298 }
 299
 300 void
 301 adj_glean_remove (ip_adjacency_t *adj)
 302 {
 303     fib_prefix_t norm;
 304
 305     fib_prefix_normalize(&adj->sub_type.glean.rx_pfx,
 306                          &norm);
 307     adj_glean_db_remove(adj->ia_nh_proto,
 308                         adj->rewrite_header.sw_if_index,
 309                         &norm.fp_addr);
 310 }
 311
 312 static adj_walk_rc_t
 313 adj_glean_start_backwalk (adj_index_t ai,
 314                           void *data)
 315 {
 316     fib_node_back_walk_ctx_t bw_ctx = *(fib_node_back_walk_ctx_t*) data;
 317
 318     fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
 319
 320     return (ADJ_WALK_RC_CONTINUE);
 321 }
 322
 323 static clib_error_t *
 324 adj_glean_interface_state_change (vnet_main_t * vnm,
 325                                   u32 sw_if_index,
 326                                   u32 flags)
 327 {
 328     /*
 329      * for each glean on the interface trigger a walk back to the children
 330      */
 331     fib_node_back_walk_ctx_t bw_ctx = {
 332         .fnbw_reason = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ?
 333                         FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
 334                         FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
 335     };
 336
 337     adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
 338
 339     return (NULL);
 340 }
 341
 342 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION(adj_glean_interface_state_change);
 343
 344 /**
 345  * @brief Invoked on each SW interface of a HW interface when the
 346  * HW interface state changes
 347  */
 348 static walk_rc_t
 349 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
 350                                       u32 sw_if_index,
 351                                       void *arg)
 352 {
 353     adj_glean_interface_state_change(vnm, sw_if_index, (uword) arg);
 354
 355     return (WALK_CONTINUE);
 356 }
 357
 358 /**
 359  * @brief Registered callback for HW interface state changes
 360  */
 361 static clib_error_t *
 362 adj_glean_hw_interface_state_change (vnet_main_t * vnm,
 363                                      u32 hw_if_index,
 364                                      u32 flags)
 365 {
 366     /*
 367      * walk SW interfaces on the HW
 368      */
 369     uword sw_flags;
 370
 371     sw_flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
 372                 VNET_SW_INTERFACE_FLAG_ADMIN_UP :
 373                 0);
 374
 375     vnet_hw_interface_walk_sw(vnm, hw_if_index,
 376                               adj_nbr_hw_sw_interface_state_change,
 377                               (void*) sw_flags);
 378
 379     return (NULL);
 380 }
 381
 382 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION(
 383     adj_glean_hw_interface_state_change);
 384
 385 static clib_error_t *
 386 adj_glean_interface_delete (vnet_main_t * vnm,
 387                             u32 sw_if_index,
 388                             u32 is_add)
 389 {
 390     if (is_add)
 391     {
 392         /*
 393          * not interested in interface additions. we will not back walk
 394          * to resolve paths through newly added interfaces. Why? The control
 395          * plane should have the brains to add interfaces first, then routes.
 396          * So the case where there are paths with a interface that matches
 397          * one just created is the case where the path resolved through an
 398          * interface that was deleted, and still has not been removed. The
 399          * new interface added, is NO GUARANTEE that the interface being
 400          * added now, even though it may have the same sw_if_index, is the
 401          * same interface that the path needs. So tough!
 402          * If the control plane wants these routes to resolve it needs to
 403          * remove and add them again.
 404          */
 405         return (NULL);
 406     }
 407
 408     /*
 409      * for each glean on the interface trigger a walk back to the children
 410      */
 411     fib_node_back_walk_ctx_t bw_ctx = {
 412         .fnbw_reason =  FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
 413     };
 414
 415     adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
 416
 417     return (NULL);
 418 }
 419
 420 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_glean_interface_delete);
 421
 422 /**
 423  * Callback function invoked when an interface's MAC Address changes
 424  */
 425 static void
 426 adj_glean_ethernet_change_mac (ethernet_main_t * em,
 427                                u32 sw_if_index,
 428                                uword opaque)
 429 {
 430     adj_glean_walk (sw_if_index, adj_glean_update_rewrite_walk, NULL);
 431 }
 432
 433 static void
 434 adj_glean_table_bind (fib_protocol_t fproto,
 435                       u32 sw_if_index,
 436                       u32 itf_fib_index)
 437 {
 438     /*
 439      * for each glean on the interface trigger a walk back to the children
 440      */
 441     fib_node_back_walk_ctx_t bw_ctx = {
 442         .fnbw_reason =  FIB_NODE_BW_REASON_FLAG_INTERFACE_BIND,
 443         .interface_bind = {
 444             .fnbw_to_fib_index = itf_fib_index,
 445         },
 446     };
 447
 448     adj_glean_walk (sw_if_index, adj_glean_start_backwalk, &bw_ctx);
 449 }
 450
 451
 452 /**
 453  * Callback function invoked when an interface's IPv6 Table
 454  * binding changes
 455  */
 456 static void
 457 adj_glean_ip6_table_bind (ip6_main_t * im,
 458                           uword opaque,
 459                           u32 sw_if_index,
 460                           u32 new_fib_index,
 461                           u32 old_fib_index)
 462 {
 463   adj_glean_table_bind (FIB_PROTOCOL_IP6, sw_if_index, new_fib_index);
 464 }
 465
 466 /**
 467  * Callback function invoked when an interface's IPv4 Table
 468  * binding changes
 469  */
 470 static void
 471 adj_glean_ip4_table_bind (ip4_main_t * im,
 472                           uword opaque,
 473                           u32 sw_if_index,
 474                           u32 new_fib_index,
 475                           u32 old_fib_index)
 476 {
 477   adj_glean_table_bind (FIB_PROTOCOL_IP4, sw_if_index, new_fib_index);
 478 }
 479
 480 u8*
 481 format_adj_glean (u8* s, va_list *ap)
 482 {
 483     index_t index = va_arg(*ap, index_t);
 484     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 485     ip_adjacency_t * adj = adj_get(index);
 486
 487     s = format(s, "%U-glean: [src:%U] %U",
 488                format_fib_protocol, adj->ia_nh_proto,
 489                format_fib_prefix, &adj->sub_type.glean.rx_pfx,
 490                format_vnet_rewrite,
 491                &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
 492
 493     return (s);
 494 }
 495
 496 u32
 497 adj_glean_db_size (void)
 498 {
 499     fib_protocol_t proto;
 500     u32 sw_if_index = 0;
 501     u64 count = 0;
 502
 503     FOR_EACH_FIB_IP_PROTOCOL(proto)
 504     {
 505         vec_foreach_index(sw_if_index, adj_gleans[proto])
 506         {
 507             if (NULL != adj_gleans[proto][sw_if_index])
 508             {
 509                 count += hash_elts(adj_gleans[proto][sw_if_index]);
 510             }
 511         }
 512     }
 513     return (count);
 514 }
 515
 516 static void
 517 adj_dpo_lock (dpo_id_t *dpo)
 518 {
 519     adj_lock(dpo->dpoi_index);
 520 }
 521 static void
 522 adj_dpo_unlock (dpo_id_t *dpo)
 523 {
 524     adj_unlock(dpo->dpoi_index);
 525 }
 526
 527 const static dpo_vft_t adj_glean_dpo_vft = {
 528     .dv_lock = adj_dpo_lock,
 529     .dv_unlock = adj_dpo_unlock,
 530     .dv_format = format_adj_glean,
 531     .dv_get_urpf = adj_dpo_get_urpf,
 532     .dv_get_mtu = adj_dpo_get_mtu,
 533 };
 534
 535 /**
 536  * @brief The per-protocol VLIB graph nodes that are assigned to a glean
 537  *        object.
 538  *
 539  * this means that these graph nodes are ones from which a glean is the
 540  * parent object in the DPO-graph.
 541  */
 542 const static char* const glean_ip4_nodes[] =
 543 {
 544     "ip4-glean",
 545     NULL,
 546 };
 547 const static char* const glean_ip6_nodes[] =
 548 {
 549     "ip6-glean",
 550     NULL,
 551 };
 552
 553 const static char* const * const glean_nodes[DPO_PROTO_NUM] =
 554 {
 555     [DPO_PROTO_IP4]  = glean_ip4_nodes,
 556     [DPO_PROTO_IP6]  = glean_ip6_nodes,
 557     [DPO_PROTO_MPLS] = NULL,
 558 };
 559
 560 void
 561 adj_glean_module_init (void)
 562 {
 563     dpo_register(DPO_ADJACENCY_GLEAN, &adj_glean_dpo_vft, glean_nodes);
 564
 565     ethernet_address_change_ctx_t ctx = {
 566         .function = adj_glean_ethernet_change_mac,
 567         .function_opaque = 0,
 568     };
 569     vec_add1 (ethernet_main.address_change_callbacks, ctx);
 570
 571     ip6_table_bind_callback_t cbt6 = {
 572         .function = adj_glean_ip6_table_bind,
 573     };
 574     vec_add1 (ip6_main.table_bind_callbacks, cbt6);
 575
 576     ip4_table_bind_callback_t cbt4 = {
 577         .function = adj_glean_ip4_table_bind,
 578     };
 579     vec_add1 (ip4_main.table_bind_callbacks, cbt4);
 580 }