vnet/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_add_for_nbr
 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     adj_index_t walk_ai;
 301     vlib_main_t * vm;
 302     u32 old_next;
 303
 304     vm = vlib_get_main();
 305     old_next = adj->lookup_next_index;
 306
 307     walk_ai = adj_get_index(adj);
 308     if (VNET_LINK_MPLS == adj->ia_link)
 309     {
 310         /*
 311          * The link type MPLS has no children in the control plane graph, it only
 312          * has children in the data-palne graph. The backwalk is up the former.
 313          * So we need to walk from its IP cousin.
 314          */
 315         walk_ai = adj_nbr_find(adj->ia_nh_proto,
 316                                fib_proto_to_link(adj->ia_nh_proto),
 317                                &adj->sub_type.nbr.next_hop,
 318                                adj->rewrite_header.sw_if_index);
 319     }
 320
 321     /*
 322      * Updating a rewrite string is not atomic;
 323      *  - the rewrite string is too long to write in one instruction
 324      *  - when swapping from incomplete to complete, we also need to update
 325      *    the VLIB graph next-index of the adj.
 326      * ideally we would only want to suspend forwarding via this adj whilst we
 327      * do this, but we do not have that level of granularity - it's suspend all
 328      * worker threads or nothing.
 329      * The other chioces are:
 330      *  - to mark the adj down and back walk so child load-balances drop this adj
 331      *    from the set.
 332      *  - update the next_node index of this adj to point to error-drop
 333      * both of which will mean for MAC change we will drop for this adj
 334      * which is not acceptable. However, when the adj changes type (from
 335      * complete to incomplete and vice-versa) the child DPOs, which have the
 336      * VLIB graph next node index, will be sending packets to the wrong graph
 337      * node. So from the options above, updating the next_node of the adj to
 338      * be drop will work, but it relies on each graph node v4/v6/mpls, rewrite/
 339      * arp/midchain always be valid w.r.t. a mis-match of adj type and node type
 340      * (i.e. a rewrite adj in the arp node). This is not enforcable. Getting it
 341      * wrong will lead to hard to find bugs since its a race condition. So we
 342      * choose the more reliable method of updating the children to use the drop,
 343      * then switching adj's type, then updating the children again. Did I mention
 344      * that this doesn't happen often...
 345      * So we need to distinguish between the two cases:
 346      *  1 - mac change
 347      *  2 - adj type change
 348      */
 349     if (old_next != adj_next_index &&
 350         ADJ_INDEX_INVALID != walk_ai)
 351     {
 352         /*
 353          * the adj is changing type. we need to fix all children so that they
 354          * stack momentarily on a drop, while the adj changes. If we don't do
 355          * this  the children will send packets to a VLIB graph node that does
 356          * not correspond to the adj's type - and it goes downhill from there.
 357          */
 358         fib_node_back_walk_ctx_t bw_ctx = {
 359             .fnbw_reason = FIB_NODE_BW_REASON_FLAG_ADJ_DOWN,
 360             /*
 361              * force this walk to be synchrous. if we don't and a node in the graph
 362              * (a heavily shared path-list) chooses to back-ground the walk (make it
 363              * async) then it will pause and we will do the adj update below, before
 364              * all the children are updated. not good.
 365              */
 366             .fnbw_flags = FIB_NODE_BW_FLAG_FORCE_SYNC,
 367         };
 368
 369         fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
 370     }
 371
 372     /*
 373      * If we are just updating the MAC string of the adj (which we also can't
 374      * do atomically), then we need to stop packets switching through the adj.
 375      * We can't do that on a per-adj basis, so it's all the packets.
 376      * If we are updating the type, and we walked back to the children above,
 377      * then this barrier serves to flush the queues/frames.
 378      */
 379     vlib_worker_thread_barrier_sync(vm);
 380
 381     adj->lookup_next_index = adj_next_index;
 382
 383     if (NULL != rewrite)
 384     {
 385         /*
 386          * new rewrite provided.
 387          * fill in the adj's rewrite string, and build the VLIB graph arc.
 388          */
 389         vnet_rewrite_set_data_internal(&adj->rewrite_header,
 390                                        sizeof(adj->rewrite_data),
 391                                        rewrite,
 392                                        vec_len(rewrite));
 393         vec_free(rewrite);
 394     }
 395     else
 396     {
 397         vnet_rewrite_clear_data_internal(&adj->rewrite_header,
 398                                          sizeof(adj->rewrite_data));
 399     }
 400     adj->rewrite_header.node_index = this_node;
 401     adj->rewrite_header.next_index = vlib_node_add_next(vlib_get_main(),
 402                                                         this_node,
 403                                                         next_node);
 404
 405     /*
 406      * done with the rewirte update - let the workers loose.
 407      */
 408     vlib_worker_thread_barrier_release(vm);
 409
 410     if (old_next != adj->lookup_next_index &&
 411         ADJ_INDEX_INVALID != walk_ai)
 412     {
 413         /*
 414          * backwalk to the children so they can stack on the now updated
 415          * adjacency
 416          */
 417         fib_node_back_walk_ctx_t bw_ctx = {
 418             .fnbw_reason = FIB_NODE_BW_REASON_FLAG_ADJ_UPDATE,
 419         };
 420
 421         fib_walk_sync(FIB_NODE_TYPE_ADJ, walk_ai, &bw_ctx);
 422     }
 423 }
 424
 425 typedef struct adj_db_count_ctx_t_ {
 426     u64 count;
 427 } adj_db_count_ctx_t;
 428
 429 static void
 430 adj_db_count (BVT(clib_bihash_kv) * kvp,
 431               void *arg)
 432 {
 433     adj_db_count_ctx_t * ctx = arg;
 434     ctx->count++;
 435 }
 436
 437 u32
 438 adj_nbr_db_size (void)
 439 {
 440     adj_db_count_ctx_t ctx = {
 441         .count = 0,
 442     };
 443     fib_protocol_t proto;
 444     u32 sw_if_index = 0;
 445
 446     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 447     {
 448         vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
 449         {
 450             if (NULL != adj_nbr_tables[proto][sw_if_index])
 451             {
 452                 BV(clib_bihash_foreach_key_value_pair) (
 453                     adj_nbr_tables[proto][sw_if_index],
 454                     adj_db_count,
 455                     &ctx);
 456             }
 457         }
 458     }
 459     return (ctx.count);
 460 }
 461
 462 /**
 463  * @brief Context for a walk of the adjacency neighbour DB
 464  */
 465 typedef struct adj_walk_ctx_t_
 466 {
 467     adj_walk_cb_t awc_cb;
 468     void *awc_ctx;
 469 } adj_walk_ctx_t;
 470
 471 static void
 472 adj_nbr_walk_cb (BVT(clib_bihash_kv) * kvp,
 473                  void *arg)
 474 {
 475     adj_walk_ctx_t *ctx = arg;
 476
 477     // FIXME: can't stop early...
 478     ctx->awc_cb(kvp->value, ctx->awc_ctx);
 479 }
 480
 481 void
 482 adj_nbr_walk (u32 sw_if_index,
 483               fib_protocol_t adj_nh_proto,
 484               adj_walk_cb_t cb,
 485               void *ctx)
 486 {
 487     if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
 488         return;
 489
 490     adj_walk_ctx_t awc = {
 491         .awc_ctx = ctx,
 492         .awc_cb = cb,
 493     };
 494
 495     BV(clib_bihash_foreach_key_value_pair) (
 496         adj_nbr_tables[adj_nh_proto][sw_if_index],
 497         adj_nbr_walk_cb,
 498         &awc);
 499 }
 500
 501 /**
 502  * @brief Context for a walk of the adjacency neighbour DB
 503  */
 504 typedef struct adj_walk_nh_ctx_t_
 505 {
 506     adj_walk_cb_t awc_cb;
 507     void *awc_ctx;
 508     const ip46_address_t *awc_nh;
 509 } adj_walk_nh_ctx_t;
 510
 511 static void
 512 adj_nbr_walk_nh_cb (BVT(clib_bihash_kv) * kvp,
 513                     void *arg)
 514 {
 515     ip_adjacency_t *adj;
 516     adj_walk_nh_ctx_t *ctx = arg;
 517
 518     adj = adj_get(kvp->value);
 519
 520     if (!ip46_address_cmp(&adj->sub_type.nbr.next_hop, ctx->awc_nh))
 521         ctx->awc_cb(kvp->value, ctx->awc_ctx);
 522 }
 523
 524 /**
 525  * @brief Walk adjacencies on a link with a given v4 next-hop.
 526  * that is visit the adjacencies with different link types.
 527  */
 528 void
 529 adj_nbr_walk_nh4 (u32 sw_if_index,
 530                  const ip4_address_t *addr,
 531                  adj_walk_cb_t cb,
 532                  void *ctx)
 533 {
 534     if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP4, sw_if_index))
 535         return;
 536
 537     ip46_address_t nh = {
 538         .ip4 = *addr,
 539     };
 540
 541     adj_walk_nh_ctx_t awc = {
 542         .awc_ctx = ctx,
 543         .awc_cb = cb,
 544         .awc_nh = &nh,
 545     };
 546
 547     BV(clib_bihash_foreach_key_value_pair) (
 548         adj_nbr_tables[FIB_PROTOCOL_IP4][sw_if_index],
 549         adj_nbr_walk_nh_cb,
 550         &awc);
 551 }
 552
 553 /**
 554  * @brief Walk adjacencies on a link with a given v6 next-hop.
 555  * that is visit the adjacencies with different link types.
 556  */
 557 void
 558 adj_nbr_walk_nh6 (u32 sw_if_index,
 559                  const ip6_address_t *addr,
 560                  adj_walk_cb_t cb,
 561                  void *ctx)
 562 {
 563     if (!ADJ_NBR_ITF_OK(FIB_PROTOCOL_IP6, sw_if_index))
 564         return;
 565
 566     ip46_address_t nh = {
 567         .ip6 = *addr,
 568     };
 569
 570     adj_walk_nh_ctx_t awc = {
 571         .awc_ctx = ctx,
 572         .awc_cb = cb,
 573         .awc_nh = &nh,
 574     };
 575
 576     BV(clib_bihash_foreach_key_value_pair) (
 577         adj_nbr_tables[FIB_PROTOCOL_IP6][sw_if_index],
 578         adj_nbr_walk_nh_cb,
 579         &awc);
 580 }
 581
 582 /**
 583  * @brief Walk adjacencies on a link with a given next-hop.
 584  * that is visit the adjacencies with different link types.
 585  */
 586 void
 587 adj_nbr_walk_nh (u32 sw_if_index,
 588                  fib_protocol_t adj_nh_proto,
 589                  const ip46_address_t *nh,
 590                  adj_walk_cb_t cb,
 591                  void *ctx)
 592 {
 593     if (!ADJ_NBR_ITF_OK(adj_nh_proto, sw_if_index))
 594         return;
 595
 596     adj_walk_nh_ctx_t awc = {
 597         .awc_ctx = ctx,
 598         .awc_cb = cb,
 599         .awc_nh = nh,
 600     };
 601
 602     BV(clib_bihash_foreach_key_value_pair) (
 603         adj_nbr_tables[adj_nh_proto][sw_if_index],
 604         adj_nbr_walk_nh_cb,
 605         &awc);
 606 }
 607
 608 /**
 609  * Flags associated with the interface state walks
 610  */
 611 typedef enum adj_nbr_interface_flags_t_
 612 {
 613     ADJ_NBR_INTERFACE_UP = (1 << 0),
 614 } adj_nbr_interface_flags_t;
 615
 616 /**
 617  * Context for the state change walk of the DB
 618  */
 619 typedef struct adj_nbr_interface_state_change_ctx_t_
 620 {
 621     /**
 622      * Flags on the interface
 623      */
 624     adj_nbr_interface_flags_t flags;
 625 } adj_nbr_interface_state_change_ctx_t;
 626
 627 static adj_walk_rc_t
 628 adj_nbr_interface_state_change_one (adj_index_t ai,
 629                                     void *arg)
 630 {
 631     /*
 632      * Back walk the graph to inform the forwarding entries
 633      * that this interface state has changed. Do this synchronously
 634      * since this is the walk that provides convergence
 635      */
 636     adj_nbr_interface_state_change_ctx_t *ctx = arg;
 637
 638     fib_node_back_walk_ctx_t bw_ctx = {
 639         .fnbw_reason = ((ctx->flags & ADJ_NBR_INTERFACE_UP) ?
 640                         FIB_NODE_BW_REASON_FLAG_INTERFACE_UP :
 641                         FIB_NODE_BW_REASON_FLAG_INTERFACE_DOWN),
 642         /*
 643          * the force sync applies only as far as the first fib_entry.
 644          * And it's the fib_entry's we need to converge away from
 645          * the adjacencies on the now down link
 646          */
 647         .fnbw_flags = (!(ctx->flags & ADJ_NBR_INTERFACE_UP) ?
 648                        FIB_NODE_BW_FLAG_FORCE_SYNC :
 649                        0),
 650     };
 651
 652     fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
 653
 654     return (ADJ_WALK_RC_CONTINUE);
 655 }
 656
 657 /**
 658  * @brief Registered function for SW interface state changes
 659  */
 660 static clib_error_t *
 661 adj_nbr_sw_interface_state_change (vnet_main_t * vnm,
 662                                    u32 sw_if_index,
 663                                    u32 flags)
 664 {
 665     fib_protocol_t proto;
 666
 667     /*
 668      * walk each adj on the interface and trigger a walk from that adj
 669      */
 670     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 671     {
 672         adj_nbr_interface_state_change_ctx_t ctx = {
 673             .flags = ((flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
 674                       ADJ_NBR_INTERFACE_UP :
 675                       0),
 676         };
 677
 678         adj_nbr_walk(sw_if_index, proto,
 679                      adj_nbr_interface_state_change_one,
 680                      &ctx);
 681     }
 682
 683     return (NULL);
 684 }
 685
 686 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION_PRIO(
 687     adj_nbr_sw_interface_state_change,
 688     VNET_ITF_FUNC_PRIORITY_HIGH);
 689
 690 /**
 691  * @brief Invoked on each SW interface of a HW interface when the
 692  * HW interface state changes
 693  */
 694 static void
 695 adj_nbr_hw_sw_interface_state_change (vnet_main_t * vnm,
 696                                       u32 sw_if_index,
 697                                       void *arg)
 698 {
 699     adj_nbr_interface_state_change_ctx_t *ctx = arg;
 700     fib_protocol_t proto;
 701
 702     /*
 703      * walk each adj on the interface and trigger a walk from that adj
 704      */
 705     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 706     {
 707         adj_nbr_walk(sw_if_index, proto,
 708                      adj_nbr_interface_state_change_one,
 709                      ctx);
 710     }
 711 }
 712
 713 /**
 714  * @brief Registered callback for HW interface state changes
 715  */
 716 static clib_error_t *
 717 adj_nbr_hw_interface_state_change (vnet_main_t * vnm,
 718                                    u32 hw_if_index,
 719                                    u32 flags)
 720 {
 721     /*
 722      * walk SW interface on the HW
 723      */
 724     adj_nbr_interface_state_change_ctx_t ctx = {
 725         .flags = ((flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
 726                   ADJ_NBR_INTERFACE_UP :
 727                   0),
 728     };
 729
 730     vnet_hw_interface_walk_sw(vnm, hw_if_index,
 731                               adj_nbr_hw_sw_interface_state_change,
 732                               &ctx);
 733
 734     return (NULL);
 735 }
 736
 737 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION_PRIO(
 738     adj_nbr_hw_interface_state_change,
 739     VNET_ITF_FUNC_PRIORITY_HIGH);
 740
 741 static adj_walk_rc_t
 742 adj_nbr_interface_delete_one (adj_index_t ai,
 743                               void *arg)
 744 {
 745     /*
 746      * Back walk the graph to inform the forwarding entries
 747      * that this interface has been deleted.
 748      */
 749     fib_node_back_walk_ctx_t bw_ctx = {
 750         .fnbw_reason = FIB_NODE_BW_REASON_FLAG_INTERFACE_DELETE,
 751     };
 752
 753     fib_walk_sync(FIB_NODE_TYPE_ADJ, ai, &bw_ctx);
 754
 755     return (ADJ_WALK_RC_CONTINUE);
 756 }
 757
 758 /**
 759  * adj_nbr_interface_add_del
 760  *
 761  * Registered to receive interface Add and delete notifications
 762  */
 763 static clib_error_t *
 764 adj_nbr_interface_add_del (vnet_main_t * vnm,
 765                            u32 sw_if_index,
 766                            u32 is_add)
 767 {
 768     fib_protocol_t proto;
 769
 770     if (is_add)
 771     {
 772         /*
 773          * not interested in interface additions. we will not back walk
 774          * to resolve paths through newly added interfaces. Why? The control
 775          * plane should have the brains to add interfaces first, then routes.
 776          * So the case where there are paths with a interface that matches
 777          * one just created is the case where the path resolved through an
 778          * interface that was deleted, and still has not been removed. The
 779          * new interface added, is NO GUARANTEE that the interface being
 780          * added now, even though it may have the same sw_if_index, is the
 781          * same interface that the path needs. So tough!
 782          * If the control plane wants these routes to resolve it needs to
 783          * remove and add them again.
 784          */
 785         return (NULL);
 786     }
 787
 788     for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 789     {
 790         adj_nbr_walk(sw_if_index, proto,
 791                      adj_nbr_interface_delete_one,
 792                      NULL);
 793     }
 794
 795     return (NULL);
 796
 797 }
 798
 799 VNET_SW_INTERFACE_ADD_DEL_FUNCTION(adj_nbr_interface_add_del);
 800
 801
 802 static adj_walk_rc_t
 803 adj_nbr_show_one (adj_index_t ai,
 804                   void *arg)
 805 {
 806     vlib_cli_output (arg, "[@%d]  %U",
 807                      ai,
 808                      format_ip_adjacency, ai,
 809                      FORMAT_IP_ADJACENCY_NONE);
 810
 811     return (ADJ_WALK_RC_CONTINUE);
 812 }
 813
 814 static clib_error_t *
 815 adj_nbr_show (vlib_main_t * vm,
 816               unformat_input_t * input,
 817               vlib_cli_command_t * cmd)
 818 {
 819     adj_index_t ai = ADJ_INDEX_INVALID;
 820     u32 sw_if_index = ~0;
 821
 822     while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 823     {
 824         if (unformat (input, "%d", &ai))
 825             ;
 826         else if (unformat (input, "%U",
 827                            unformat_vnet_sw_interface, vnet_get_main(),
 828                            &sw_if_index))
 829             ;
 830         else
 831             break;
 832     }
 833
 834     if (ADJ_INDEX_INVALID != ai)
 835     {
 836         vlib_cli_output (vm, "[@%d] %U",
 837                          ai,
 838                          format_ip_adjacency, ai,
 839                          FORMAT_IP_ADJACENCY_DETAIL);
 840     }
 841     else if (~0 != sw_if_index)
 842     {
 843         fib_protocol_t proto;
 844
 845         for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 846         {
 847             adj_nbr_walk(sw_if_index, proto,
 848                          adj_nbr_show_one,
 849                          vm);
 850         }
 851     }
 852     else
 853     {
 854         fib_protocol_t proto;
 855
 856         for (proto = FIB_PROTOCOL_IP4; proto <= FIB_PROTOCOL_IP6; proto++)
 857         {
 858             vec_foreach_index(sw_if_index, adj_nbr_tables[proto])
 859             {
 860                 adj_nbr_walk(sw_if_index, proto,
 861                              adj_nbr_show_one,
 862                              vm);
 863             }
 864         }
 865     }
 866
 867     return 0;
 868 }
 869
 870 /*?
 871  * Show all neighbour adjacencies.
 872  * @cliexpar
 873  * @cliexstart{sh adj nbr}
 874  * [@2] ipv4 via 1.0.0.2 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 875  * [@3] mpls via 1.0.0.2 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 876  * [@4] ipv4 via 1.0.0.3 loop0: IP4: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 877  * [@5] mpls via 1.0.0.3 loop0: MPLS_UNICAST: 00:00:22:aa:bb:cc -> 00:00:11:aa:bb:cc
 878  * @cliexend
 879  ?*/
 880 VLIB_CLI_COMMAND (ip4_show_fib_command, static) = {
 881     .path = "show adj nbr",
 882     .short_help = "show adj nbr [<adj_index>] [interface]",
 883     .function = adj_nbr_show,
 884 };
 885
 886 static ip46_type_t
 887 adj_proto_to_46 (fib_protocol_t proto)
 888 {
 889     switch (proto)
 890     {
 891     case FIB_PROTOCOL_IP4:
 892         return (IP46_TYPE_IP4);
 893     case FIB_PROTOCOL_IP6:
 894         return (IP46_TYPE_IP6);
 895     default:
 896         return (IP46_TYPE_IP4);
 897     }
 898     return (IP46_TYPE_IP4);
 899 }
 900
 901 u8*
 902 format_adj_nbr_incomplete (u8* s, va_list *ap)
 903 {
 904     index_t index = va_arg(*ap, index_t);
 905     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 906     vnet_main_t * vnm = vnet_get_main();
 907     ip_adjacency_t * adj = adj_get(index);
 908
 909     s = format (s, "arp-%U", format_vnet_link, adj->ia_link);
 910     s = format (s, ": via %U",
 911                 format_ip46_address, &adj->sub_type.nbr.next_hop,
 912                 adj_proto_to_46(adj->ia_nh_proto));
 913     s = format (s, " %U",
 914                 format_vnet_sw_interface_name,
 915                 vnm,
 916                 vnet_get_sw_interface(vnm,
 917                                       adj->rewrite_header.sw_if_index));
 918
 919     return (s);
 920 }
 921
 922 u8*
 923 format_adj_nbr (u8* s, va_list *ap)
 924 {
 925     index_t index = va_arg(*ap, index_t);
 926     CLIB_UNUSED(u32 indent) = va_arg(*ap, u32);
 927     vnet_main_t * vnm = vnet_get_main();
 928     ip_adjacency_t * adj = adj_get(index);
 929
 930     s = format (s, "%U", format_vnet_link, adj->ia_link);
 931     s = format (s, " via %U ",
 932                 format_ip46_address, &adj->sub_type.nbr.next_hop,
 933                 adj_proto_to_46(adj->ia_nh_proto));
 934     s = format (s, "%U",
 935                 format_vnet_rewrite,
 936                 vnm->vlib_main, &adj->rewrite_header, sizeof (adj->rewrite_data), 0);
 937
 938     return (s);
 939 }
 940
 941 static void
 942 adj_dpo_lock (dpo_id_t *dpo)
 943 {
 944     adj_lock(dpo->dpoi_index);
 945 }
 946 static void
 947 adj_dpo_unlock (dpo_id_t *dpo)
 948 {
 949     adj_unlock(dpo->dpoi_index);
 950 }
 951
 952 static void
 953 adj_mem_show (void)
 954 {
 955     fib_show_memory_usage("Adjacency",
 956                           pool_elts(adj_pool),
 957                           pool_len(adj_pool),
 958                           sizeof(ip_adjacency_t));
 959 }
 960
 961 const static dpo_vft_t adj_nbr_dpo_vft = {
 962     .dv_lock = adj_dpo_lock,
 963     .dv_unlock = adj_dpo_unlock,
 964     .dv_format = format_adj_nbr,
 965     .dv_mem_show = adj_mem_show,
 966 };
 967 const static dpo_vft_t adj_nbr_incompl_dpo_vft = {
 968     .dv_lock = adj_dpo_lock,
 969     .dv_unlock = adj_dpo_unlock,
 970     .dv_format = format_adj_nbr_incomplete,
 971 };
 972
 973 /**
 974  * @brief The per-protocol VLIB graph nodes that are assigned to an adjacency
 975  *        object.
 976  *
 977  * this means that these graph nodes are ones from which a nbr is the
 978  * parent object in the DPO-graph.
 979  */
 980 const static char* const nbr_ip4_nodes[] =
 981 {
 982     "ip4-rewrite-transit",
 983     NULL,
 984 };
 985 const static char* const nbr_ip6_nodes[] =
 986 {
 987     "ip6-rewrite",
 988     NULL,
 989 };
 990 const static char* const nbr_mpls_nodes[] =
 991 {
 992     "mpls-output",
 993     NULL,
 994 };
 995 const static char* const nbr_ethernet_nodes[] =
 996 {
 997     "adj-l2-rewrite",
 998     NULL,
 999 };
1000 const static char* const * const nbr_nodes[DPO_PROTO_NUM] =
1001 {
1002     [DPO_PROTO_IP4]  = nbr_ip4_nodes,
1003     [DPO_PROTO_IP6]  = nbr_ip6_nodes,
1004     [DPO_PROTO_MPLS] = nbr_mpls_nodes,
1005     [DPO_PROTO_ETHERNET] = nbr_ethernet_nodes,
1006 };
1007
1008 const static char* const nbr_incomplete_ip4_nodes[] =
1009 {
1010     "ip4-arp",
1011     NULL,
1012 };
1013 const static char* const nbr_incomplete_ip6_nodes[] =
1014 {
1015     "ip6-discover-neighbor",
1016     NULL,
1017 };
1018 const static char* const nbr_incomplete_mpls_nodes[] =
1019 {
1020     "mpls-adj-incomplete",
1021     NULL,
1022 };
1023
1024 const static char* const * const nbr_incomplete_nodes[DPO_PROTO_NUM] =
1025 {
1026     [DPO_PROTO_IP4]  = nbr_incomplete_ip4_nodes,
1027     [DPO_PROTO_IP6]  = nbr_incomplete_ip6_nodes,
1028     [DPO_PROTO_MPLS] = nbr_incomplete_mpls_nodes,
1029 };
1030
1031 void
1032 adj_nbr_module_init (void)
1033 {
1034     dpo_register(DPO_ADJACENCY,
1035                  &adj_nbr_dpo_vft,
1036                  nbr_nodes);
1037     dpo_register(DPO_ADJACENCY_INCOMPLETE,
1038                  &adj_nbr_incompl_dpo_vft,
1039                  nbr_incomplete_nodes);
1040 }