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