src/vnet/adj/adj_nbr.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_nbr.h>
  17 #include <vnet/adj/adj_internal.h>
  18 #include <vnet/ethernet/arp_packet.h>
  19 #include <vnet/fib/fib_walk.h>
  20
  21 /*
  22  * Vector Hash tables of neighbour (traditional) adjacencies
  23  *  Key: interface(for the vector index), address (and its proto),
  24  *       link-type/ether-type.
  25  */
  26 static BVT(clib_bihash) **adj_nbr_tables[FIB_PROTOCOL_MAX];
  27
  28 // FIXME SIZE APPROPRIATELY. ASK DAVEB.
  29 #define ADJ_NBR_DEFAULT_HASH_NUM_BUCKETS (64 * 64)
  30 #define ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE (32<<20)
  31
  32
  33 #define ADJ_NBR_SET_KEY(_key, _lt, _nh)         \
  34 {                                               \
  35     _key.key[0] = (_nh)->as_u64[0];             \
  36     _key.key[1] = (_nh)->as_u64[1];             \
  37     _key.key[2] = (_lt);                        \
  38 }
  39
  40 #define ADJ_NBR_ITF_OK(_proto, _itf)                    \
  41     (((_itf) < vec_len(adj_nbr_tables[_proto])) &&      \
  42      (NULL != adj_nbr_tables[_proto][sw_if_index]))
  43
  44 static void
  45 adj_nbr_insert (fib_protocol_t nh_proto,
  46                 vnet_link_t link_type,
  47                 const ip46_address_t *nh_addr,
  48                 u32 sw_if_index,
  49                 adj_index_t adj_index)
  50 {
  51     BVT(clib_bihash_kv) kv;
  52
  53     if (sw_if_index >= vec_len(adj_nbr_tables[nh_proto]))
  54     {
  55         vec_validate(adj_nbr_tables[nh_proto], sw_if_index);
  56     }
  57     if (NULL == adj_nbr_tables[nh_proto][sw_if_index])
  58     {
  59         adj_nbr_tables[nh_proto][sw_if_index] =
  60             clib_mem_alloc_aligned(sizeof(BVT(clib_bihash)),
  61                                    CLIB_CACHE_LINE_BYTES);
  62         memset(adj_nbr_tables[nh_proto][sw_if_index],
  63                0,
  64                sizeof(BVT(clib_bihash)));
  65
  66         BV(clib_bihash_init) (adj_nbr_tables[nh_proto][sw_if_index],
  67                               "Adjacency Neighbour table",
  68                               ADJ_NBR_DEFAULT_HASH_NUM_BUCKETS,
  69                               ADJ_NBR_DEFAULT_HASH_MEMORY_SIZE);
  70     }
  71
  72     ADJ_NBR_SET_KEY(kv, link_type, nh_addr);
  73     kv.value = adj_index;
  74
  75     BV(clib_bihash_add_del) (adj_nbr_tables[nh_proto][sw_if_index], &kv, 1);
  76 }
  77
  78 void
  79 adj_nbr_remove (adj_index_t ai,
  80                 fib_protocol_t nh_proto,
  81                 vnet_link_t link_type,
  82                 const ip46_address_t *nh_addr,
  83                 u32 sw_if_index)
  84 {
  85     BVT(clib_bihash_kv) kv;
  86
  87     if (!ADJ_NBR_ITF_OK(nh_proto, sw_if_index))
  88         return;
  89
  90     ADJ_NBR_SET_KEY(kv, link_type, nh_addr);
  91     kv.value = ai;
  92
  93     BV(clib_bihash_add_del) (adj_nbr_tables[nh_proto][sw_if_index], &kv, 0);
  94 }
  95
  96 static adj_index_t
  97 adj_nbr_find (fib_protocol_t nh_proto,
  98               vnet_link_t link_type,
  99               const ip46_address_t *nh_addr,
 100               u32 sw_if_index)
 101 {
 102     BVT(clib_bihash_kv) kv;
 103
 104     ADJ_NBR_SET_KEY(kv, link_type, nh_addr);
 105
 106     if (!ADJ_NBR_ITF_OK(nh_proto, sw_if_index))
 107         return (ADJ_INDEX_INVALID);
 108
 109     if (BV(clib_bihash_search)(adj_nbr_tables[nh_proto][sw_if_index],
 110                                &kv, &kv) < 0)
 111     {
 112         return (ADJ_INDEX_INVALID);
 113     }
 114     else
 115     {
 116         return (kv.value);
 117     }
 118 }
 119
 120 static inline u32
 121 adj_get_nd_node (fib_protocol_t proto)
 122 {
 123     switch (proto) {
 124     case FIB_PROTOCOL_IP4:
 125         return (ip4_arp_node.index);
 126     case FIB_PROTOCOL_IP6:
 127         return (ip6_discover_neighbor_node.index);
 128     case FIB_PROTOCOL_MPLS:
 129         break;
 130     }
 131     ASSERT(0);
 132     return (ip4_arp_node.index);
 133 }
 134
 135 static ip_adjacency_t*
 136 adj_nbr_alloc (fib_protocol_t nh_proto,
 137                vnet_link_t link_type,
 138                const ip46_address_t *nh_addr,
 139                u32 sw_if_index)
 140 {
 141     ip_adjacency_t *adj;
 142
 143     adj = adj_alloc(nh_proto);
 144
 145     adj_nbr_insert(nh_proto, link_type, nh_addr,
 146                    sw_if_index,
 147                    adj_get_index(adj));
 148
 149     /*
 150      * since we just added the ADJ we have no rewrite string for it,
 151      * so its for ARP
 152      */
 153     adj->lookup_next_index = IP_LOOKUP_NEXT_ARP;
 154     adj->sub_type.nbr.next_hop = *nh_addr;
 155     adj->ia_link = link_type;
 156     adj->ia_nh_proto = nh_proto;
 157     adj->rewrite_header.sw_if_index = sw_if_index;
 158     memset(&adj->sub_type.midchain.next_dpo, 0,
 159            sizeof(adj->sub_type.midchain.next_dpo));
 160
 161     return (adj);
 162 }
 163
 164 /*
 165  * adj_nbr_add_or_lock
 166  *
 167  * Add an adjacency for the neighbour requested.
 168  *
 169  * The key for an adj is:
 170  *   - the Next-hops protocol (i.e. v4 or v6)
 171  *   - the address of the next-hop
 172  *   - the interface the next-hop is reachable through
 173  */
 174 adj_index_t
 175 adj_nbr_add_or_lock (fib_protocol_t nh_proto,
 176                      vnet_link_t link_type,
 177                      const ip46_address_t *nh_addr,
 178                      u32 sw_if_index)
 179 {
 180     adj_index_t adj_index;
 181     ip_adjacency_t *adj;
 182
 183     adj_index = adj_nbr_find(nh_proto, link_type, nh_addr, sw_if_index);
 184
 185     if (ADJ_INDEX_INVALID == adj_index)
 186     {
 187         vnet_main_t *vnm;
 188
 189         vnm = vnet_get_main();
 190         adj = adj_nbr_alloc(nh_proto, link_type, nh_addr, sw_if_index);
 191         adj_index = adj_get_index(adj);
 192         adj_lock(adj_index);
 193
 194         vnet_rewrite_init(vnm, sw_if_index,
 195                           adj_get_nd_node(nh_proto),
 196                           vnet_tx_node_index_for_sw_interface(vnm, sw_if_index),
 197                           &adj->rewrite_header);
 198
 199         /*
 200          * we need a rewrite where the destination IP address is converted
 201          * to the appropriate link-layer address. This is interface specific.
 202          * So ask the interface to do it.
 203          */
 204         vnet_update_adjacency_for_sw_interface(vnm, sw_if_index, adj_index);
 205     }
 206     else
 207     {
 208         adj_lock(adj_index);
 209     }
 210
 211     return (adj_index);
 212 }
 213
 214 adj_index_t
 215 adj_nbr_add_or_lock_w_rewrite (fib_protocol_t nh_proto,
 216                                vnet_link_t link_type,
 217                                const ip46_address_t *nh_addr,
 218                                u32 sw_if_index,
 219                                u8 *rewrite)
 220 {
 221     adj_index_t adj_index;
 222     ip_adjacency_t *adj;
 223
 224     adj_index = adj_nbr_find(nh_proto, link_type, nh_addr, sw_if_index);
 225
 226     if (ADJ_INDEX_INVALID == adj_index)
 227     {
 228         adj = adj_nbr_alloc(nh_proto, link_type, nh_addr, sw_if_index);
 229         adj->rewrite_header.sw_if_index = sw_if_index;
 230     }
 231     else
 232     {
 233         adj = adj_get(adj_index);
 234     }
 235
 236     adj_lock(adj_get_index(adj));
 237     adj_nbr_update_rewrite(adj_get_index(adj),
 238                            ADJ_NBR_REWRITE_FLAG_COMPLETE,
 239                            rewrite);
 240
 241     return (adj_get_index(adj));
 242 }
 243
 244 /**
 245  * adj_nbr_update_rewrite
 246  *
 247  * Update the adjacency's rewrite string. A NULL string implies the
 248  * rewirte is reset (i.e. when ARP/ND etnry is gone).
 249  * NB: the adj being updated may be handling traffic in the DP.
 250  */
 251 void
 252 adj_nbr_update_rewrite (adj_index_t adj_index,
 253                         adj_nbr_rewrite_flag_t flags,
 254                         u8 *rewrite)
 255 {
 256     ip_adjacency_t *adj;
 257
 258     ASSERT(ADJ_INDEX_INVALID != adj_index);
 259
 260     adj = adj_get(adj_index);
 261
 262     if (flags & ADJ_NBR_REWRITE_FLAG_COMPLETE)
 263     {
 264         /*
 265          * update the adj's rewrite string and build the arc
 266          * from the rewrite node to the interface's TX node
 267          */
 268         adj_nbr_update_rewrite_internal(adj, IP_LOOKUP_NEXT_REWRITE,
 269                                         adj_get_rewrite_node(adj->ia_link),
 270                                         vnet_tx_node_index_for_sw_interface(
 271                                             vnet_get_main(),
 272                                             adj->rewrite_header.sw_if_index),
 273                                         rewrite);
 274     }
 275     else
 276     {
 277         adj_nbr_update_rewrite_internal(adj, IP_LOOKUP_NEXT_ARP,
 278                                         adj_get_nd_node(adj->ia_nh_proto),
 279                                         vnet_tx_node_index_for_sw_interface(
 280                                             vnet_get_main(),
 281                                             adj->rewrite_header.sw_if_index),
 282                                         rewrite);
 283     }
 284 }
 285
 286 /**
 287  * adj_nbr_update_rewrite_internal
 288  *
 289  * Update the adjacency's rewrite string. A NULL string implies the
 290  * rewirte is reset (i.e. when ARP/ND etnry is gone).
 291  * NB: the adj being updated may be handling traffic in the DP.
 292  */
 293 void
 294 adj_nbr_update_rewrite_internal (ip_adjacency_t *adj,
 295                                  u32 adj_next_index,
 296                                  u32 this_node,
 297                                  u32 next_node,
 298                                  u8 *rewrite)
 299 {
 300     ip_adjacency_t *walk_adj;
 301     adj_index_t walk_ai;
 302     vlib_main_t * vm;
 303     u32 old_next;
 304     int do_walk;
 305
 306     vm = vlib_get_main();
 307     old_next = adj->lookup_next_index;
 308
 309     walk_ai = adj_get_index(adj);
 310     if (VNET_LINK_MPLS == adj->ia_link)
 311     {
 312         /*
 313          * The link type MPLS has no children in the control plane graph, it only
 314          * has children in the data-palne graph. The backwalk is up the former.
 315          * So we need to walk from its IP cousin.
 316          */
 317         walk_ai = adj_nbr_find(adj->ia_nh_proto,
 318                                fib_proto_to_link(adj->ia_nh_proto),
 319                                &adj->sub_type.nbr.next_hop,
 320                                adj->rewrite_header.sw_if_index);
 321     }
 322
 323     /*
 324      * Don't call the walk re-entrantly
 325      */
 326     if (ADJ_INDEX_INVALID != walk_ai)
 327     {
 328         walk_adj = adj_get(walk_ai);
 329         if (IP_ADJ_SYNC_WALK_ACTIVE & walk_adj->ia_flags)
 330         {
 331             do_walk = 0;
 332         }
 333         else
 334         {
 335             /*
 336              * Prevent re-entrant walk of the same adj
 337              */
 338             walk_adj->ia_flags |= IP_ADJ_SYNC_WALK_ACTIVE;
 339             do_walk = 1;
 340         }
 341     }
 342     else
 343     {
 344         do_walk = 0;
 345     }
 346
 347     /*
 348      * lock the adjacencies that are affected by updates this walk will provoke.
 349      * Since the aim of the walk is to update children to link to a different
 350      * DPO, this adj will no longer be in use and its lock count will drop to 0.
 351      * We don't want it to be deleted as part of this endevour.
 352      */
 353     adj_lock(adj_get_index(adj));
 354     adj_lock(walk_ai);
 355
 356     /*
 357      * Updating a rewrite string is not atomic;
 358      *  - the rewrite string is too long to write in one instruction
 359      *  - when swapping from incomplete to complete, we also need to update
 360      *    the VLIB graph next-index of the adj.
 361      * ideally we would only want to suspend forwarding via this adj whilst we
 362      * do this, but we do not have that level of granularity - it's suspend all
 363      * worker threads or nothing.
 364      * The other chioces are:
 365      *  - to mark the adj down and back walk so child load-balances drop this adj
 366      *    from the set.
 367      *  - update the next_node index of this adj to point to error-drop
 368      * both of which will mean for MAC change we will drop for this adj
 369      * which is not acceptable. However, when the adj changes type (from
 370      * complete to incomplete and vice-versa) the child DPOs, which have the
 371      * VLIB graph next node index, will be sending packets to the wrong graph
 372      * node. So from the options above, updating the next_node of the adj to
 373      * be drop will work, but it relies on each graph node v4/v6/mpls, rewrite/
 374      * arp/midchain always be valid w.r.t. a mis-match of adj type and node type
 375      * (i.e. a rewrite adj in the arp node). This is not enforcable. Getting it
 376      * wrong will lead to hard to find bugs since its a race condition. So we
 377      * choose the more reliable method of updating the children to use the drop,
 378      * then switching adj's type, then updating the children again. Did I mention
 379      * that this doesn't happen often...
 380      * So we need to distinguish between the two cases:
 381      *  1 - mac change
 382      *  2 - adj type change
 383      */
 384     if (do_walk &&
 385         old_next != adj_next_index &&
 386         ADJ_INDEX_INVALID != walk_ai)
 387     {
 388         /*
 389          * the adj is changing type. we need to fix all children so that they
 390          * stack momentarily on a drop, while the adj changes. If we don't do
 391          * this  the children will send packets to a VLIB graph node that does
 392          * not correspond to the adj's type - and it goes downhill from there.
 393          */
 394         fib_node_back_walk_ctx_t bw_ctx = {
 395             .fnbw_reason = FIB_NODE_BW_REASON_FLAG_ADJ_DOWN,
 396             /*
 397              * force this walk to be synchrous. if we don't and a node in the graph
 398              * (a heavily shared path-list) chooses to back-ground the walk (make it
 399              * async) then it will pause and we will do the adj update below, before
 400              * all the children are updated. not good.
 401              */
 402             .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
 403         };
 404
 405         fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
 406     }
 407
 408     /*
 409      * If we are just updating the MAC string of the adj (which we also can't
 410      * do atomically), then we need to stop packets switching through the adj.
 411      * We can't do that on a per-adj basis, so it's all the packets.
 412      * If we are updating the type, and we walked back to the children above,
 413      * then this barrier serves to flush the queues/frames.
 414      */
 415     vlib_worker_thread_barrier_sync(vm);
 416
 417     adj->lookup_next_index = adj_next_index;
 418
 419     if (NULL != rewrite)
 420     {
 421         /*
 422          * new rewrite provided.
 423          * fill in the adj's rewrite string, and build the VLIB graph arc.
 424          */
 425         vnet_rewrite_set_data_internal(&adj->rewrite_header,
 426                                        sizeof(adj->rewrite_data),
 427                                        rewrite,
 428                                        vec_len(rewrite));
 429         vec_free(rewrite);
 430     }
 431     else
 432     {
 433         vnet_rewrite_clear_data_internal(&adj->rewrite_header,
 434                                          sizeof(adj->rewrite_data));
 435     }
 436     adj->rewrite_header.next_index = vlib_node_add_next(vlib_get_main(),
 437                                                         this_node,
 438                                                         next_node);
 439
 440     /*
 441      * done with the rewirte update - let the workers loose.
 442      */
 443     vlib_worker_thread_barrier_release(vm);
 444
 445     if (do_walk &&
 446         (old_next != adj->lookup_next_index) &&
 447         (ADJ_INDEX_INVALID != walk_ai))
 448     {
 449         /*
 450          * backwalk to the children so they can stack on the now updated
 451          * adjacency
 452          */
 453         fib_node_back_walk_ctx_t bw_ctx = {
 454             .fnbw_reason = FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE,
 455         };
 456
 457         fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
 458     }
 459     /*
 460      * Prevent re-entrant walk of the same adj
 461      */
 462     if (do_walk)
 463     {
 464         walk_adj->ia_flags &= ~IP_ADJ_SYNC_WALK_ACTIVE;
 465     }
 466
 467     adj_unlock(adj_get_index(adj));
 468     adj_unlock(walk_ai);
 469 }
 470
 471 typedef struct adj_db_count_ctx_t_ {
 472     u64 count;
 473 } adj_db_count_ctx_t;
 474
 475 static void
 476 adj_db_count (BVT(clib_bihash_kv) * kvp,
 477               void *arg)
 478 {
 479     adj_db_count_ctx_t * ctx = arg;
 480     ctx->count++;
 481 }
 482
 483 u32
 484 adj_nbr_db_size (void)
 485 {
 486     adj_db_count_ctx_t ctx = {
 487         .count = 0,
 488     };
 489     fib_protocol_t proto;
 490     u32 sw_if_index = 0;
 491
 492     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 493     {
 494         vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
 495         {
 496             if (NULL != adj_nbr_tables[proto][sw_if_index])
 497             {
 498                 BV(clib_bihash_foreach_key_value_pair) (
 499                     adj_nbr_tables[proto][sw_if_index],
 500                     adj_db_count,
 501                     &ctx);
 502             }
 503         }
 504     }
 505     return (ctx.count);
 506 }
 507
 508 /**
 509  * @brief Context for a walk of the adjacency neighbour DB
 510  */
 511 typedef struct adj_walk_ctx_t_
 512 {
 513     adj_walk_cb_t awc_cb;
 514     void *awc_ctx;
 515 } adj_walk_ctx_t;
 516
 517 static void
 518 adj_nbr_walk_cb (BVT(clib_bihash_kv) * kvp,
 519                  void *arg)
 520 {
 521     adj_walk_ctx_t *ctx = arg;
 522
 523     // FIXME: can't stop early...
 524     ctx->awc_cb(kvp->value, ctx->awc_ctx);
 525 }
 526
 527 void
 528 adj_nbr_walk (u32 sw_if_index,
 529               fib_protocol_t adj_nh_proto,
 530               adj_walk_cb_t cb,
 531               void *ctx)
 532 {
 533     if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
 534         return;
 535
 536     adj_walk_ctx_t awc = {
 537         .awc_ctx = ctx,
 538         .awc_cb = cb,
 539     };
 540
 541     BV(clib_bihash_foreach_key_value_pair) (
 542         adj_nbr_tables[adj_nh_proto][sw_if_index],
 543         adj_nbr_walk_cb,
 544         &awc);
 545 }
 546
 547 /**
 548  * @brief Context for a walk of the adjacency neighbour DB
 549  */
 550 typedef struct adj_walk_nh_ctx_t_
 551 {
 552     adj_walk_cb_t awc_cb;
 553     void *awc_ctx;
 554     const ip46_address_t *awc_nh;
 555 } adj_walk_nh_ctx_t;
 556
 557 static void
 558 adj_nbr_walk_nh_cb (BVT(clib_bihash_kv) * kvp,
 559                     void *arg)
 560 {
 561     ip_adjacency_t *adj;
 562     adj_walk_nh_ctx_t *ctx = arg;
 563
 564     adj = adj_get(kvp->value);
 565
 566     if (!ip46_address_cmp(&adj->sub_type.nbr.next_hop, ctx->awc_nh))
 567         ctx->awc_cb(kvp->value, ctx->awc_ctx);
 568 }
 569
 570 /**
 571  * @brief Walk adjacencies on a link with a given v4 next-hop.
 572  * that is visit the adjacencies with different link types.
 573  */
 574 void
 575 adj_nbr_walk_nh4 (u32 sw_if_index,
 576                  const ip4_address_t *addr,
 577                  adj_walk_cb_t cb,
 578                  void *ctx)
 579 {
 580     if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP4, sw_if_index))
 581         return;
 582
 583     ip46_address_t nh = {
 584         .ip4 = *addr,
 585     };
 586
 587     adj_walk_nh_ctx_t awc = {
 588         .awc_ctx = ctx,
 589         .awc_cb = cb,
 590         .awc_nh = &nh,
 591     };
 592
 593     BV(clib_bihash_foreach_key_value_pair) (
 594         adj_nbr_tables[FIB_PROTOCOL_IP4][sw_if_index],
 595         adj_nbr_walk_nh_cb,
 596         &awc);
 597 }
 598
 599 /**
 600  * @brief Walk adjacencies on a link with a given v6 next-hop.
 601  * that is visit the adjacencies with different link types.
 602  */
 603 void
 604 adj_nbr_walk_nh6 (u32 sw_if_index,
 605                  const ip6_address_t *addr,
 606                  adj_walk_cb_t cb,
 607                  void *ctx)
 608 {
 609     if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP6, sw_if_index))
 610         return;
 611
 612     ip46_address_t nh = {
 613         .ip6 = *addr,
 614     };
 615
 616     adj_walk_nh_ctx_t awc = {
 617         .awc_ctx = ctx,
 618         .awc_cb = cb,
 619         .awc_nh = &nh,
 620     };
 621
 622     BV(clib_bihash_foreach_key_value_pair) (
 623         adj_nbr_tables[FIB_PROTOCOL_IP6][sw_if_index],
 624         adj_nbr_walk_nh_cb,
 625         &awc);
 626 }
 627
 628 /**
 629  * @brief Walk adjacencies on a link with a given next-hop.
 630  * that is visit the adjacencies with different link types.
 631  */
 632 void
 633 adj_nbr_walk_nh (u32 sw_if_index,
 634                  fib_protocol_t adj_nh_proto,
 635                  const ip46_address_t *nh,
 636                  adj_walk_cb_t cb,
 637                  void *ctx)
 638 {
 639     if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
 640         return;
 641
 642     adj_walk_nh_ctx_t awc = {
 643         .awc_ctx = ctx,
 644         .awc_cb = cb,
 645         .awc_nh = nh,
 646     };
 647
 648     BV(clib_bihash_foreach_key_value_pair) (
 649         adj_nbr_tables[adj_nh_proto][sw_if_index],
 650         adj_nbr_walk_nh_cb,
 651         &awc);
 652 }
 653
 654 /**
 655  * Flags associated with the interface state walks
 656  */
 657 typedef enum adj_nbr_interface_flags_t_
 658 {
 659     ADJ_NBR_INTERFACE_UP = (1 << 0),
 660 } adj_nbr_interface_flags_t;
 661
 662 /**
 663  * Context for the state change walk of the DB
 664  */
 665 typedef struct adj_nbr_interface_state_change_ctx_t_
 666 {
 667     /**
 668      * Flags on the interface
 669      */
 670     adj_nbr_interface_flags_t flags;
 671 } adj_nbr_interface_state_change_ctx_t;
 672
 673 static adj_walk_rc_t
 674 adj_nbr_interface_state_change_one (adj_index_t ai,
 675                                     void *arg)
 676 {
 677     /*
 678      * Back walk the graph to inform the forwarding entries
 679      * that this interface state has changed. Do this synchronously
 680      * since this is the walk that provides convergence
 681      */
 682     adj_nbr_interface_state_change_ctx_t *ctx = arg;
 683
 684     fib_node_back_walk_ctx_t bw_ctx = {
 685         .fnbw_reason = ((ctx->flags & ADJ_NBR_INTERFACE_UP) ?
 686                         FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
 687                         FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
 688         /*
 689          * the force sync applies only as far as the first fib_entry.
 690          * And it's the fib_entry's we need to converge away from
 691          * the adjacencies on the now down link
 692          */
 693         .fnbw_flags = (!(ctx->flags & ADJ_NBR_INTERFACE_UP) ?
 694                        FIB_NODE_BW_FLAG_FORCE_SYNC :
 695                        0),
 696     };
 697
 698     fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
 699
 700     return (ADJ_WALK_RC_CONTINUE);
 701 }
 702
 703 /**
 704  * @brief Registered function for SW interface state changes
 705  */
 706 static clib_error_t *
 707 adj_nbr_sw_interface_state_change (vnet_main_t * vnm,
 708                                    u32 sw_if_index,
 709                                    u32 flags)
 710 {
 711     fib_protocol_t proto;
 712
 713     /*
 714      * walk each adj on the interface and trigger a walk from that adj
 715      */
 716     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 717     {
 718         adj_nbr_interface_state_change_ctx_t ctx = {
 719             .flags = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
 720                       ADJ_NBR_INTERFACE_UP :
 721                       0),
 722         };
 723
 724         adj_nbr_walk(sw_if_index, proto,
 725                      adj_nbr_interface_state_change_one,
 726                      &ctx);
 727     }
 728
 729     return (NULL);
 730 }
 731
 732 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(
 733     adj_nbr_sw_interface_state_change,
 734     VNET_ITF_FUNC_PRIORITY_HIGH);
 735
 736 /**
 737  * @brief Invoked on each SW interface of a HW interface when the
 738  * HW interface state changes
 739  */
 740 static void
 741 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
 742                                       u32 sw_if_index,
 743                                       void *arg)
 744 {
 745     adj_nbr_interface_state_change_ctx_t *ctx = arg;
 746     fib_protocol_t proto;
 747
 748     /*
 749      * walk each adj on the interface and trigger a walk from that adj
 750      */
 751     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 752     {
 753         adj_nbr_walk(sw_if_index, proto,
 754                      adj_nbr_interface_state_change_one,
 755                      ctx);
 756     }
 757 }
 758
 759 /**
 760  * @brief Registered callback for HW interface state changes
 761  */
 762 static clib_error_t *
 763 adj_nbr_hw_interface_state_change (vnet_main_t * vnm,
 764                                    u32 hw_if_index,
 765                                    u32 flags)
 766 {
 767     /*
 768      * walk SW interface on the HW
 769      */
 770     adj_nbr_interface_state_change_ctx_t ctx = {
 771         .flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
 772                   ADJ_NBR_INTERFACE_UP :
 773                   0),
 774     };
 775
 776     vnet_hw_interface_walk_sw(vnm, hw_if_index,
 777                               adj_nbr_hw_sw_interface_state_change,
 778                               &ctx);
 779
 780     return (NULL);
 781 }
 782
 783 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(
 784     adj_nbr_hw_interface_state_change,
 785     VNET_ITF_FUNC_PRIORITY_HIGH);
 786
 787 static adj_walk_rc_t
 788 adj_nbr_interface_delete_one (adj_index_t ai,
 789                               void *arg)
 790 {
 791     /*
 792      * Back walk the graph to inform the forwarding entries
 793      * that this interface has been deleted.
 794      */
 795     fib_node_back_walk_ctx_t bw_ctx = {
 796         .fnbw_reason = FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
 797     };
 798
 799     fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
 800
 801     return (ADJ_WALK_RC_CONTINUE);
 802 }
 803
 804 /**
 805  * adj_nbr_interface_add_del
 806  *
 807  * Registered to receive interface Add and delete notifications
 808  */
 809 static clib_error_t *
 810 adj_nbr_interface_add_del (vnet_main_t * vnm,
 811                            u32 sw_if_index,
 812                            u32 is_add)
 813 {
 814     fib_protocol_t proto;
 815
 816     if (is_add)
 817     {
 818         /*
 819          * not interested in interface additions. we will not back walk
 820          * to resolve paths through newly added interfaces. Why? The control
 821          * plane should have the brains to add interfaces first, then routes.
 822          * So the case where there are paths with a interface that matches
 823          * one just created is the case where the path resolved through an
 824          * interface that was deleted, and still has not been removed. The
 825          * new interface added, is NO GUARANTEE that the interface being
 826          * added now, even though it may have the same sw_if_index, is the
 827          * same interface that the path needs. So tough!
 828          * If the control plane wants these routes to resolve it needs to
 829          * remove and add them again.
 830          */
 831         return (NULL);
 832     }
 833
 834     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 835     {
 836         adj_nbr_walk(sw_if_index, proto,
 837                      adj_nbr_interface_delete_one,
 838                      NULL);
 839     }
 840
 841     return (NULL);
 842
 843 }
 844
 845 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_nbr_interface_add_del);
 846
 847
 848 static adj_walk_rc_t
 849 adj_nbr_show_one (adj_index_t ai,
 850                   void *arg)
 851 {
 852     vlib_cli_output (arg, "[@%d]  %U",
 853                      ai,
 854                      format_ip_adjacency, ai,
 855                      FORMAT_IP_ADJACENCY_NONE);
 856
 857     return (ADJ_WALK_RC_CONTINUE);
 858 }
 859
 860 static clib_error_t *
 861 adj_nbr_show (vlib_main_t * vm,
 862               unformat_input_t * input,
 863               vlib_cli_command_t * cmd)
 864 {
 865     adj_index_t ai = ADJ_INDEX_INVALID;
 866     u32 sw_if_index = ~0;
 867
 868     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 869     {
 870         if (unformat (input, "%d", &ai))
 871             ;
 872         else if (unformat (input, "%U",
 873                            unformat_vnet_sw_interface, vnet_get_main(),
 874                            &sw_if_index))
 875             ;
 876         else
 877             break;
 878     }
 879
 880     if (ADJ_INDEX_INVALID != ai)
 881     {
 882         vlib_cli_output (vm, "[@%d] %U",
 883                          ai,
 884                          format_ip_adjacency, ai,
 885                          FORMAT_IP_ADJACENCY_DETAIL);
 886     }
 887     else if (~0 != sw_if_index)
 888     {
 889         fib_protocol_t proto;
 890
 891         for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 892         {
 893             adj_nbr_walk(sw_if_index, proto,
 894                          adj_nbr_show_one,
 895                          vm);
 896         }
 897     }
 898     else
 899     {
 900         fib_protocol_t proto;
 901
 902         for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 903         {
 904             vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
 905             {
 906                 adj_nbr_walk(sw_if_index, proto,
 907                              adj_nbr_show_one,
 908                              vm);
 909             }
 910         }
 911     }
 912
 913     return 0;
 914 }
 915
 916 /*?
 917  * Show all neighbour adjacencies.
 918  * @cliexpar
 919  * @cliexstart{sh adj nbr}
 920  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 921  * [@3] mpls via 1.0.0.2 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 922  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 923  * [@5] mpls via 1.0.0.3 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 924  * @cliexend
 925  ?*/
 926 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
 927     .path = "show adj nbr",
 928     .short_help = "show adj nbr [<adj_index>] [interface]",
 929     .function = adj_nbr_show,
 930 };
 931
 932 static ip46_type_t
 933 adj_proto_to_46 (fib_protocol_t proto)
 934 {
 935     switch (proto)
 936     {
 937     case FIB_PROTOCOL_IP4:
 938         return (IP46_TYPE_IP4);
 939     case FIB_PROTOCOL_IP6:
 940         return (IP46_TYPE_IP6);
 941     default:
 942         return (IP46_TYPE_IP4);
 943     }
 944     return (IP46_TYPE_IP4);
 945 }
 946
 947 u8*
 948 format_adj_nbr_incomplete (u8* s, va_list *ap)
 949 {
 950     index_t index = va_arg(*ap, index_t);
 951     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 952     vnet_main_t * vnm = vnet_get_main();
 953     ip_adjacency_t * adj = adj_get(index);
 954
 955     s = format (s, "arp-%U", format_vnet_link, adj->ia_link);
 956     s = format (s, ": via %U",
 957                 format_ip46_address, &adj->sub_type.nbr.next_hop,
 958                 adj_proto_to_46(adj->ia_nh_proto));
 959     s = format (s, " %U",
 960                 format_vnet_sw_interface_name,
 961                 vnm,
 962                 vnet_get_sw_interface(vnm,
 963                                       adj->rewrite_header.sw_if_index));
 964
 965     return (s);
 966 }
 967
 968 u8*
 969 format_adj_nbr (u8* s, va_list *ap)
 970 {
 971     index_t index = va_arg(*ap, index_t);
 972     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 973     ip_adjacency_t * adj = adj_get(index);
 974
 975     s = format (s, "%U", format_vnet_link, adj->ia_link);
 976     s = format (s, " via %U ",
 977                 format_ip46_address, &adj->sub_type.nbr.next_hop,
 978                 adj_proto_to_46(adj->ia_nh_proto));
 979     s = format (s, "%U",
 980                 format_vnet_rewrite,
 981                 &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
 982
 983     return (s);
 984 }
 985
 986 static void
 987 adj_dpo_lock (dpo_id_t *dpo)
 988 {
 989     adj_lock(dpo->dpoi_index);
 990 }
 991 static void
 992 adj_dpo_unlock (dpo_id_t *dpo)
 993 {
 994     adj_unlock(dpo->dpoi_index);
 995 }
 996
 997 static void
 998 adj_mem_show (void)
 999 {
1000     fib_show_memory_usage("Adjacency",
1001                           pool_elts(adj_pool),
1002                           pool_len(adj_pool),
1003                           sizeof(ip_adjacency_t));
1004 }
1005
1006 const static dpo_vft_t adj_nbr_dpo_vft = {
1007     .dv_lock = adj_dpo_lock,
1008     .dv_unlock = adj_dpo_unlock,
1009     .dv_format = format_adj_nbr,
1010     .dv_mem_show = adj_mem_show,
1011 };
1012 const static dpo_vft_t adj_nbr_incompl_dpo_vft = {
1013     .dv_lock = adj_dpo_lock,
1014     .dv_unlock = adj_dpo_unlock,
1015     .dv_format = format_adj_nbr_incomplete,
1016 };
1017
1018 /**
1019  * @brief The per-protocol VLIB graph nodes that are assigned to an adjacency
1020  *        object.
1021  *
1022  * this means that these graph nodes are ones from which a nbr is the
1023  * parent object in the DPO-graph.
1024  */
1025 const static char* const nbr_ip4_nodes[] =
1026 {
1027     "ip4-rewrite",
1028     NULL,
1029 };
1030 const static char* const nbr_ip6_nodes[] =
1031 {
1032     "ip6-rewrite",
1033     NULL,
1034 };
1035 const static char* const nbr_mpls_nodes[] =
1036 {
1037     "mpls-output",
1038     NULL,
1039 };
1040 const static char* const nbr_ethernet_nodes[] =
1041 {
1042     "adj-l2-rewrite",
1043     NULL,
1044 };
1045 const static char* const * const nbr_nodes[DPO_PROTO_NUM] =
1046 {
1047     [DPO_PROTO_IP4]  = nbr_ip4_nodes,
1048     [DPO_PROTO_IP6]  = nbr_ip6_nodes,
1049     [DPO_PROTO_MPLS] = nbr_mpls_nodes,
1050     [DPO_PROTO_ETHERNET] = nbr_ethernet_nodes,
1051 };
1052
1053 const static char* const nbr_incomplete_ip4_nodes[] =
1054 {
1055     "ip4-arp",
1056     NULL,
1057 };
1058 const static char* const nbr_incomplete_ip6_nodes[] =
1059 {
1060     "ip6-discover-neighbor",
1061     NULL,
1062 };
1063 const static char* const nbr_incomplete_mpls_nodes[] =
1064 {
1065     "mpls-adj-incomplete",
1066     NULL,
1067 };
1068
1069 const static char* const * const nbr_incomplete_nodes[DPO_PROTO_NUM] =
1070 {
1071     [DPO_PROTO_IP4]  = nbr_incomplete_ip4_nodes,
1072     [DPO_PROTO_IP6]  = nbr_incomplete_ip6_nodes,
1073     [DPO_PROTO_MPLS] = nbr_incomplete_mpls_nodes,
1074 };
1075
1076 void
1077 adj_nbr_module_init (void)
1078 {
1079     dpo_register(DPO_ADJACENCY,
1080                  &adj_nbr_dpo_vft,
1081                  nbr_nodes);
1082     dpo_register(DPO_ADJACENCY_INCOMPLETE,
1083                  &adj_nbr_incompl_dpo_vft,
1084                  nbr_incomplete_nodes);
1085 }