src/vnet/ethernet/arp.c

   1 /*
   2  * ethernet/arp.c: IP v4 ARP node
   3  *
   4  * Copyright (c) 2010 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #include <vnet/ip/ip.h>
  19 #include <vnet/ip/ip6.h>
  20 #include <vnet/ethernet/ethernet.h>
  21 #include <vnet/ethernet/arp.h>
  22 #include <vnet/l2/l2_input.h>
  23 #include <vppinfra/mhash.h>
  24 #include <vnet/fib/ip4_fib.h>
  25 #include <vnet/fib/fib_entry_src.h>
  26 #include <vnet/adj/adj_nbr.h>
  27 #include <vnet/adj/adj_mcast.h>
  28 #include <vnet/mpls/mpls.h>
  29 #include <vnet/l2/feat_bitmap.h>
  30
  31 /**
  32  * @file
  33  * @brief IPv4 ARP.
  34  *
  35  * This file contains code to manage the IPv4 ARP tables (IP Address
  36  * to MAC Address lookup).
  37  */
  38
  39
  40 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
  41
  42 /**
  43  * @brief Per-interface ARP configuration and state
  44  */
  45 typedef struct ethernet_arp_interface_t_
  46 {
  47   /**
  48    * Hash table of ARP entries.
  49    * Since this hash table is per-interface, the key is only the IPv4 address.
  50    */
  51   uword *arp_entries;
  52 } ethernet_arp_interface_t;
  53
  54 typedef struct
  55 {
  56   ip4_address_t lo_addr;
  57   ip4_address_t hi_addr;
  58   u32 fib_index;
  59 } ethernet_proxy_arp_t;
  60
  61 typedef struct
  62 {
  63   u32 next_index;
  64   uword node_index;
  65   uword type_opaque;
  66   uword data;
  67   /* Used for arp event notification only */
  68   void *data_callback;
  69   u32 pid;
  70 } pending_resolution_t;
  71
  72 typedef struct
  73 {
  74   /* Hash tables mapping name to opcode. */
  75   uword *opcode_by_name;
  76
  77   /* lite beer "glean" adjacency handling */
  78   uword *pending_resolutions_by_address;
  79   pending_resolution_t *pending_resolutions;
  80
  81   /* Mac address change notification */
  82   uword *mac_changes_by_address;
  83   pending_resolution_t *mac_changes;
  84
  85   ethernet_arp_ip4_entry_t *ip4_entry_pool;
  86
  87   /* ARP attack mitigation */
  88   u32 arp_delete_rotor;
  89   u32 limit_arp_cache_size;
  90
  91   /** Per interface state */
  92   ethernet_arp_interface_t *ethernet_arp_by_sw_if_index;
  93
  94   /* Proxy arp vector */
  95   ethernet_proxy_arp_t *proxy_arps;
  96
  97   uword wc_ip4_arp_publisher_node;
  98   uword wc_ip4_arp_publisher_et;
  99 } ethernet_arp_main_t;
 100
 101 static ethernet_arp_main_t ethernet_arp_main;
 102
 103 typedef struct
 104 {
 105   u32 sw_if_index;
 106   ethernet_arp_ip4_over_ethernet_address_t a;
 107   int is_static;
 108   int is_no_fib_entry;
 109   int flags;
 110 #define ETHERNET_ARP_ARGS_REMOVE (1<<0)
 111 #define ETHERNET_ARP_ARGS_FLUSH  (1<<1)
 112 #define ETHERNET_ARP_ARGS_POPULATE  (1<<2)
 113 #define ETHERNET_ARP_ARGS_WC_PUB  (1<<3)
 114 } vnet_arp_set_ip4_over_ethernet_rpc_args_t;
 115
 116 static const u8 vrrp_prefix[] = { 0x00, 0x00, 0x5E, 0x00, 0x01 };
 117
 118 /* Node index for send_garp_na_process */
 119 u32 send_garp_na_process_node_index;
 120
 121 static void
 122 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
 123                                     * a);
 124
 125 static u8 *
 126 format_ethernet_arp_hardware_type (u8 * s, va_list * va)
 127 {
 128   ethernet_arp_hardware_type_t h = va_arg (*va, ethernet_arp_hardware_type_t);
 129   char *t = 0;
 130   switch (h)
 131     {
 132 #define _(n,f) case n: t = #f; break;
 133       foreach_ethernet_arp_hardware_type;
 134 #undef _
 135
 136     default:
 137       return format (s, "unknown 0x%x", h);
 138     }
 139
 140   return format (s, "%s", t);
 141 }
 142
 143 static u8 *
 144 format_ethernet_arp_opcode (u8 * s, va_list * va)
 145 {
 146   ethernet_arp_opcode_t o = va_arg (*va, ethernet_arp_opcode_t);
 147   char *t = 0;
 148   switch (o)
 149     {
 150 #define _(f) case ETHERNET_ARP_OPCODE_##f: t = #f; break;
 151       foreach_ethernet_arp_opcode;
 152 #undef _
 153
 154     default:
 155       return format (s, "unknown 0x%x", o);
 156     }
 157
 158   return format (s, "%s", t);
 159 }
 160
 161 static uword
 162 unformat_ethernet_arp_opcode_host_byte_order (unformat_input_t * input,
 163                                               va_list * args)
 164 {
 165   int *result = va_arg (*args, int *);
 166   ethernet_arp_main_t *am = &ethernet_arp_main;
 167   int x, i;
 168
 169   /* Numeric opcode. */
 170   if (unformat (input, "0x%x", &x) || unformat (input, "%d", &x))
 171     {
 172       if (x >= (1 << 16))
 173         return 0;
 174       *result = x;
 175       return 1;
 176     }
 177
 178   /* Named type. */
 179   if (unformat_user (input, unformat_vlib_number_by_name,
 180                      am->opcode_by_name, &i))
 181     {
 182       *result = i;
 183       return 1;
 184     }
 185
 186   return 0;
 187 }
 188
 189 static uword
 190 unformat_ethernet_arp_opcode_net_byte_order (unformat_input_t * input,
 191                                              va_list * args)
 192 {
 193   int *result = va_arg (*args, int *);
 194   if (!unformat_user
 195       (input, unformat_ethernet_arp_opcode_host_byte_order, result))
 196     return 0;
 197
 198   *result = clib_host_to_net_u16 ((u16) * result);
 199   return 1;
 200 }
 201
 202 static u8 *
 203 format_ethernet_arp_header (u8 * s, va_list * va)
 204 {
 205   ethernet_arp_header_t *a = va_arg (*va, ethernet_arp_header_t *);
 206   u32 max_header_bytes = va_arg (*va, u32);
 207   u32 indent;
 208   u16 l2_type, l3_type;
 209
 210   if (max_header_bytes != 0 && sizeof (a[0]) > max_header_bytes)
 211     return format (s, "ARP header truncated");
 212
 213   l2_type = clib_net_to_host_u16 (a->l2_type);
 214   l3_type = clib_net_to_host_u16 (a->l3_type);
 215
 216   indent = format_get_indent (s);
 217
 218   s = format (s, "%U, type %U/%U, address size %d/%d",
 219               format_ethernet_arp_opcode, clib_net_to_host_u16 (a->opcode),
 220               format_ethernet_arp_hardware_type, l2_type,
 221               format_ethernet_type, l3_type,
 222               a->n_l2_address_bytes, a->n_l3_address_bytes);
 223
 224   if (l2_type == ETHERNET_ARP_HARDWARE_TYPE_ethernet
 225       && l3_type == ETHERNET_TYPE_IP4)
 226     {
 227       s = format (s, "\n%U%U/%U -> %U/%U",
 228                   format_white_space, indent,
 229                   format_ethernet_address, a->ip4_over_ethernet[0].ethernet,
 230                   format_ip4_address, &a->ip4_over_ethernet[0].ip4,
 231                   format_ethernet_address, a->ip4_over_ethernet[1].ethernet,
 232                   format_ip4_address, &a->ip4_over_ethernet[1].ip4);
 233     }
 234   else
 235     {
 236       uword n2 = a->n_l2_address_bytes;
 237       uword n3 = a->n_l3_address_bytes;
 238       s = format (s, "\n%U%U/%U -> %U/%U",
 239                   format_white_space, indent,
 240                   format_hex_bytes, a->data + 0 * n2 + 0 * n3, n2,
 241                   format_hex_bytes, a->data + 1 * n2 + 0 * n3, n3,
 242                   format_hex_bytes, a->data + 1 * n2 + 1 * n3, n2,
 243                   format_hex_bytes, a->data + 2 * n2 + 1 * n3, n3);
 244     }
 245
 246   return s;
 247 }
 248
 249 u8 *
 250 format_ethernet_arp_ip4_entry (u8 * s, va_list * va)
 251 {
 252   vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
 253   ethernet_arp_ip4_entry_t *e = va_arg (*va, ethernet_arp_ip4_entry_t *);
 254   vnet_sw_interface_t *si;
 255   u8 *flags = 0;
 256
 257   if (!e)
 258     return format (s, "%=12s%=16s%=6s%=20s%=24s", "Time", "IP4",
 259                    "Flags", "Ethernet", "Interface");
 260
 261   si = vnet_get_sw_interface (vnm, e->sw_if_index);
 262
 263   if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
 264     flags = format (flags, "S");
 265
 266   if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
 267     flags = format (flags, "D");
 268
 269   if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY)
 270     flags = format (flags, "N");
 271
 272   s = format (s, "%=12U%=16U%=6s%=20U%U",
 273               format_vlib_time, vnm->vlib_main, e->time_last_updated,
 274               format_ip4_address, &e->ip4_address,
 275               flags ? (char *) flags : "",
 276               format_ethernet_address, e->ethernet_address,
 277               format_vnet_sw_interface_name, vnm, si);
 278
 279   vec_free (flags);
 280   return s;
 281 }
 282
 283 typedef struct
 284 {
 285   u8 packet_data[64];
 286 } ethernet_arp_input_trace_t;
 287
 288 static u8 *
 289 format_ethernet_arp_input_trace (u8 * s, va_list * va)
 290 {
 291   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
 292   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
 293   ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
 294
 295   s = format (s, "%U",
 296               format_ethernet_arp_header,
 297               t->packet_data, sizeof (t->packet_data));
 298
 299   return s;
 300 }
 301
 302 static u8 *
 303 format_arp_term_input_trace (u8 * s, va_list * va)
 304 {
 305   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
 306   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
 307   ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
 308
 309   /* arp-term trace data saved is either arp or ip6/icmp6 packet:
 310      - for arp, the 1st 16-bit field is hw type of value of 0x0001.
 311      - for ip6, the first nibble has value of 6. */
 312   s = format (s, "%U", t->packet_data[0] == 0 ?
 313               format_ethernet_arp_header : format_ip6_header,
 314               t->packet_data, sizeof (t->packet_data));
 315
 316   return s;
 317 }
 318
 319 static void
 320 arp_nbr_probe (ip_adjacency_t * adj)
 321 {
 322   vnet_main_t *vnm = vnet_get_main ();
 323   ip4_main_t *im = &ip4_main;
 324   ip_interface_address_t *ia;
 325   ethernet_arp_header_t *h;
 326   vnet_hw_interface_t *hi;
 327   vnet_sw_interface_t *si;
 328   ip4_address_t *src;
 329   vlib_buffer_t *b;
 330   vlib_main_t *vm;
 331   u32 bi = 0;
 332
 333   vm = vlib_get_main ();
 334
 335   si = vnet_get_sw_interface (vnm, adj->rewrite_header.sw_if_index);
 336
 337   if (!(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
 338     {
 339       return;
 340     }
 341
 342   src =
 343     ip4_interface_address_matching_destination (im,
 344                                                 &adj->sub_type.nbr.next_hop.
 345                                                 ip4,
 346                                                 adj->rewrite_header.
 347                                                 sw_if_index, &ia);
 348   if (!src)
 349     {
 350       return;
 351     }
 352
 353   h =
 354     vlib_packet_template_get_packet (vm, &im->ip4_arp_request_packet_template,
 355                                      &bi);
 356   if (!h)
 357     return;
 358
 359   hi = vnet_get_sup_hw_interface (vnm, adj->rewrite_header.sw_if_index);
 360
 361   clib_memcpy (h->ip4_over_ethernet[0].ethernet,
 362                hi->hw_address, sizeof (h->ip4_over_ethernet[0].ethernet));
 363
 364   h->ip4_over_ethernet[0].ip4 = src[0];
 365   h->ip4_over_ethernet[1].ip4 = adj->sub_type.nbr.next_hop.ip4;
 366
 367   b = vlib_get_buffer (vm, bi);
 368   vnet_buffer (b)->sw_if_index[VLIB_RX] =
 369     vnet_buffer (b)->sw_if_index[VLIB_TX] = adj->rewrite_header.sw_if_index;
 370
 371   /* Add encapsulation string for software interface (e.g. ethernet header). */
 372   vnet_rewrite_one_header (adj[0], h, sizeof (ethernet_header_t));
 373   vlib_buffer_advance (b, -adj->rewrite_header.data_bytes);
 374
 375   {
 376     vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
 377     u32 *to_next = vlib_frame_vector_args (f);
 378     to_next[0] = bi;
 379     f->n_vectors = 1;
 380     vlib_put_frame_to_node (vm, hi->output_node_index, f);
 381   }
 382 }
 383
 384 static void
 385 arp_mk_complete (adj_index_t ai, ethernet_arp_ip4_entry_t * e)
 386 {
 387   adj_nbr_update_rewrite
 388     (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
 389      ethernet_build_rewrite (vnet_get_main (),
 390                              e->sw_if_index,
 391                              adj_get_link_type (ai), e->ethernet_address));
 392 }
 393
 394 static void
 395 arp_mk_incomplete (adj_index_t ai)
 396 {
 397   ip_adjacency_t *adj = adj_get (ai);
 398
 399   adj_nbr_update_rewrite
 400     (ai,
 401      ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
 402      ethernet_build_rewrite (vnet_get_main (),
 403                              adj->rewrite_header.sw_if_index,
 404                              VNET_LINK_ARP,
 405                              VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
 406 }
 407
 408 static ethernet_arp_ip4_entry_t *
 409 arp_entry_find (ethernet_arp_interface_t * eai, const ip4_address_t * addr)
 410 {
 411   ethernet_arp_main_t *am = &ethernet_arp_main;
 412   ethernet_arp_ip4_entry_t *e = NULL;
 413   uword *p;
 414
 415   if (NULL != eai->arp_entries)
 416     {
 417       p = hash_get (eai->arp_entries, addr->as_u32);
 418       if (!p)
 419         return (NULL);
 420
 421       e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
 422     }
 423
 424   return (e);
 425 }
 426
 427 static adj_walk_rc_t
 428 arp_mk_complete_walk (adj_index_t ai, void *ctx)
 429 {
 430   ethernet_arp_ip4_entry_t *e = ctx;
 431
 432   arp_mk_complete (ai, e);
 433
 434   return (ADJ_WALK_RC_CONTINUE);
 435 }
 436
 437 static adj_walk_rc_t
 438 arp_mk_incomplete_walk (adj_index_t ai, void *ctx)
 439 {
 440   arp_mk_incomplete (ai);
 441
 442   return (ADJ_WALK_RC_CONTINUE);
 443 }
 444
 445 void
 446 arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
 447 {
 448   ethernet_arp_main_t *am = &ethernet_arp_main;
 449   ethernet_arp_interface_t *arp_int;
 450   ethernet_arp_ip4_entry_t *e;
 451   ip_adjacency_t *adj;
 452
 453   adj = adj_get (ai);
 454
 455   vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
 456   arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
 457   e = arp_entry_find (arp_int, &adj->sub_type.nbr.next_hop.ip4);
 458
 459   switch (adj->lookup_next_index)
 460     {
 461     case IP_LOOKUP_NEXT_GLEAN:
 462       adj_glean_update_rewrite (ai);
 463       break;
 464     case IP_LOOKUP_NEXT_ARP:
 465       if (NULL != e)
 466         {
 467           adj_nbr_walk_nh4 (sw_if_index,
 468                             &e->ip4_address, arp_mk_complete_walk, e);
 469         }
 470       else
 471         {
 472           /*
 473            * no matching ARP entry.
 474            * construct the rewrite required to for an ARP packet, and stick
 475            * that in the adj's pipe to smoke.
 476            */
 477           adj_nbr_update_rewrite
 478             (ai,
 479              ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
 480              ethernet_build_rewrite
 481              (vnm,
 482               sw_if_index,
 483               VNET_LINK_ARP,
 484               VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
 485
 486           /*
 487            * since the FIB has added this adj for a route, it makes sense it
 488            * may want to forward traffic sometime soon. Let's send a
 489            * speculative ARP. just one. If we were to do periodically that
 490            * wouldn't be bad either, but that's more code than i'm prepared to
 491            * write at this time for relatively little reward.
 492            */
 493           arp_nbr_probe (adj);
 494         }
 495       break;
 496     case IP_LOOKUP_NEXT_BCAST:
 497       adj_nbr_update_rewrite (ai,
 498                               ADJ_NBR_REWRITE_FLAG_COMPLETE,
 499                               ethernet_build_rewrite
 500                               (vnm,
 501                                sw_if_index,
 502                                VNET_LINK_IP4,
 503                                VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
 504       break;
 505     case IP_LOOKUP_NEXT_MCAST:
 506       {
 507         /*
 508          * Construct a partial rewrite from the known ethernet mcast dest MAC
 509          */
 510         u8 *rewrite;
 511         u8 offset;
 512
 513         rewrite = ethernet_build_rewrite (vnm,
 514                                           sw_if_index,
 515                                           adj->ia_link,
 516                                           ethernet_ip4_mcast_dst_addr ());
 517         offset = vec_len (rewrite) - 2;
 518
 519         /*
 520          * Complete the remaining fields of the adj's rewrite to direct the
 521          * complete of the rewrite at switch time by copying in the IP
 522          * dst address's bytes.
 523          * Ofset is 2 bytes into the MAC desintation address.
 524          */
 525         adj_mcast_update_rewrite (ai, rewrite, offset);
 526
 527         break;
 528       }
 529     case IP_LOOKUP_NEXT_DROP:
 530     case IP_LOOKUP_NEXT_PUNT:
 531     case IP_LOOKUP_NEXT_LOCAL:
 532     case IP_LOOKUP_NEXT_REWRITE:
 533     case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
 534     case IP_LOOKUP_NEXT_MIDCHAIN:
 535     case IP_LOOKUP_NEXT_ICMP_ERROR:
 536     case IP_LOOKUP_N_NEXT:
 537       ASSERT (0);
 538       break;
 539     }
 540 }
 541
 542 static void
 543 arp_adj_fib_add (ethernet_arp_ip4_entry_t * e, u32 fib_index)
 544 {
 545   fib_prefix_t pfx = {
 546     .fp_len = 32,
 547     .fp_proto = FIB_PROTOCOL_IP4,
 548     .fp_addr.ip4 = e->ip4_address,
 549   };
 550
 551   e->fib_entry_index =
 552     fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
 553                               FIB_ENTRY_FLAG_ATTACHED,
 554                               DPO_PROTO_IP4, &pfx.fp_addr,
 555                               e->sw_if_index, ~0, 1, NULL,
 556                               FIB_ROUTE_PATH_FLAG_NONE);
 557   fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
 558 }
 559
 560 void
 561 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
 562 {
 563   if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
 564     {
 565       fib_prefix_t pfx = {
 566         .fp_len = 32,
 567         .fp_proto = FIB_PROTOCOL_IP4,
 568         .fp_addr.ip4 = e->ip4_address,
 569       };
 570       u32 fib_index;
 571
 572       fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
 573
 574       fib_table_entry_path_remove (fib_index, &pfx,
 575                                    FIB_SOURCE_ADJ,
 576                                    DPO_PROTO_IP4,
 577                                    &pfx.fp_addr,
 578                                    e->sw_if_index, ~0, 1,
 579                                    FIB_ROUTE_PATH_FLAG_NONE);
 580       fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
 581     }
 582 }
 583
 584 static ethernet_arp_ip4_entry_t *
 585 force_reuse_arp_entry (void)
 586 {
 587   ethernet_arp_ip4_entry_t *e;
 588   ethernet_arp_main_t *am = &ethernet_arp_main;
 589   u32 count = 0;
 590   u32 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
 591   if (index == ~0)              /* Try again from elt 0 */
 592     index = pool_next_index (am->ip4_entry_pool, index);
 593
 594   /* Find a non-static random entry to free up for reuse */
 595   do
 596     {
 597       if ((count++ == 100) || (index == ~0))
 598         return NULL;            /* give up after 100 entries */
 599       e = pool_elt_at_index (am->ip4_entry_pool, index);
 600       am->arp_delete_rotor = index;
 601       index = pool_next_index (am->ip4_entry_pool, index);
 602     }
 603   while (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC);
 604
 605   /* Remove ARP entry from its interface and update fib */
 606   hash_unset
 607     (am->ethernet_arp_by_sw_if_index[e->sw_if_index].arp_entries,
 608      e->ip4_address.as_u32);
 609   arp_adj_fib_remove
 610     (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
 611   adj_nbr_walk_nh4 (e->sw_if_index,
 612                     &e->ip4_address, arp_mk_incomplete_walk, NULL);
 613   return e;
 614 }
 615
 616 static int
 617 vnet_arp_set_ip4_over_ethernet_internal (vnet_main_t * vnm,
 618                                          vnet_arp_set_ip4_over_ethernet_rpc_args_t
 619                                          * args)
 620 {
 621   ethernet_arp_ip4_entry_t *e = 0;
 622   ethernet_arp_main_t *am = &ethernet_arp_main;
 623   ethernet_arp_ip4_over_ethernet_address_t *a = &args->a;
 624   vlib_main_t *vm = vlib_get_main ();
 625   int make_new_arp_cache_entry = 1;
 626   uword *p;
 627   pending_resolution_t *pr, *mc;
 628   ethernet_arp_interface_t *arp_int;
 629   int is_static = args->is_static;
 630   u32 sw_if_index = args->sw_if_index;
 631   int is_no_fib_entry = args->is_no_fib_entry;
 632
 633   vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
 634
 635   arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
 636
 637   if (NULL != arp_int->arp_entries)
 638     {
 639       p = hash_get (arp_int->arp_entries, a->ip4.as_u32);
 640       if (p)
 641         {
 642           e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
 643
 644           /* Refuse to over-write static arp. */
 645           if (!is_static && (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC))
 646             {
 647               /* if MAC address match, still check to send event */
 648               if (0 == memcmp (e->ethernet_address,
 649                                a->ethernet, sizeof (e->ethernet_address)))
 650                 goto check_customers;
 651               return -2;
 652             }
 653           make_new_arp_cache_entry = 0;
 654         }
 655     }
 656
 657   if (make_new_arp_cache_entry)
 658     {
 659       if (am->limit_arp_cache_size &&
 660           pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
 661         {
 662           e = force_reuse_arp_entry ();
 663           if (NULL == e)
 664             return -2;
 665         }
 666       else
 667         pool_get (am->ip4_entry_pool, e);
 668
 669       if (NULL == arp_int->arp_entries)
 670         arp_int->arp_entries = hash_create (0, sizeof (u32));
 671
 672       hash_set (arp_int->arp_entries, a->ip4.as_u32, e - am->ip4_entry_pool);
 673
 674       e->sw_if_index = sw_if_index;
 675       e->ip4_address = a->ip4;
 676       e->fib_entry_index = FIB_NODE_INDEX_INVALID;
 677       clib_memcpy (e->ethernet_address,
 678                    a->ethernet, sizeof (e->ethernet_address));
 679
 680       if (!is_no_fib_entry)
 681         {
 682           arp_adj_fib_add (e,
 683                            ip4_fib_table_get_index_for_sw_if_index
 684                            (e->sw_if_index));
 685         }
 686       else
 687         {
 688           e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY;
 689         }
 690     }
 691   else
 692     {
 693       /*
 694        * prevent a DoS attack from the data-plane that
 695        * spams us with no-op updates to the MAC address
 696        */
 697       if (0 == memcmp (e->ethernet_address,
 698                        a->ethernet, sizeof (e->ethernet_address)))
 699         {
 700           e->time_last_updated = vlib_time_now (vm);
 701           goto check_customers;
 702         }
 703
 704       /* Update ethernet address. */
 705       clib_memcpy (e->ethernet_address, a->ethernet,
 706                    sizeof (e->ethernet_address));
 707     }
 708
 709   /* Update time stamp and flags. */
 710   e->time_last_updated = vlib_time_now (vm);
 711   if (is_static)
 712     {
 713       e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
 714       e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
 715     }
 716   else
 717     {
 718       e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
 719       e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
 720     }
 721
 722   adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
 723
 724 check_customers:
 725   /* Customer(s) waiting for this address to be resolved? */
 726   p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
 727   if (p)
 728     {
 729       u32 next_index;
 730       next_index = p[0];
 731
 732       while (next_index != (u32) ~ 0)
 733         {
 734           pr = pool_elt_at_index (am->pending_resolutions, next_index);
 735           vlib_process_signal_event (vm, pr->node_index,
 736                                      pr->type_opaque, pr->data);
 737           next_index = pr->next_index;
 738           pool_put (am->pending_resolutions, pr);
 739         }
 740
 741       hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
 742     }
 743
 744   /* Customer(s) requesting ARP event for this address? */
 745   p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
 746   if (p)
 747     {
 748       u32 next_index;
 749       next_index = p[0];
 750
 751       while (next_index != (u32) ~ 0)
 752         {
 753           int (*fp) (u32, u8 *, u32, u32);
 754           int rv = 1;
 755           mc = pool_elt_at_index (am->mac_changes, next_index);
 756           fp = mc->data_callback;
 757
 758           /* Call the user's data callback, return 1 to suppress dup events */
 759           if (fp)
 760             rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
 761
 762           /*
 763            * Signal the resolver process, as long as the user
 764            * says they want to be notified
 765            */
 766           if (rv == 0)
 767             vlib_process_signal_event (vm, mc->node_index,
 768                                        mc->type_opaque, mc->data);
 769           next_index = mc->next_index;
 770         }
 771     }
 772
 773   return 0;
 774 }
 775
 776 void
 777 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
 778                                         void *address_arg,
 779                                         uword node_index,
 780                                         uword type_opaque, uword data)
 781 {
 782   ethernet_arp_main_t *am = &ethernet_arp_main;
 783   ip4_address_t *address = address_arg;
 784   uword *p;
 785   pending_resolution_t *pr;
 786
 787   pool_get (am->pending_resolutions, pr);
 788
 789   pr->next_index = ~0;
 790   pr->node_index = node_index;
 791   pr->type_opaque = type_opaque;
 792   pr->data = data;
 793   pr->data_callback = 0;
 794
 795   p = hash_get (am->pending_resolutions_by_address, address->as_u32);
 796   if (p)
 797     {
 798       /* Insert new resolution at the head of the list */
 799       pr->next_index = p[0];
 800       hash_unset (am->pending_resolutions_by_address, address->as_u32);
 801     }
 802
 803   hash_set (am->pending_resolutions_by_address, address->as_u32,
 804             pr - am->pending_resolutions);
 805 }
 806
 807 int
 808 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
 809                                    void *data_callback,
 810                                    u32 pid,
 811                                    void *address_arg,
 812                                    uword node_index,
 813                                    uword type_opaque, uword data, int is_add)
 814 {
 815   ethernet_arp_main_t *am = &ethernet_arp_main;
 816   ip4_address_t *address = address_arg;
 817
 818   /* Try to find an existing entry */
 819   u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
 820   u32 *p = first;
 821   pending_resolution_t *mc;
 822   while (p && *p != ~0)
 823     {
 824       mc = pool_elt_at_index (am->mac_changes, *p);
 825       if (mc->node_index == node_index && mc->type_opaque == type_opaque
 826           && mc->pid == pid)
 827         break;
 828       p = &mc->next_index;
 829     }
 830
 831   int found = p && *p != ~0;
 832   if (is_add)
 833     {
 834       if (found)
 835         return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 836
 837       pool_get (am->mac_changes, mc);
 838       *mc = (pending_resolution_t)
 839       {
 840       .next_index = ~0,.node_index = node_index,.type_opaque =
 841           type_opaque,.data = data,.data_callback = data_callback,.pid =
 842           pid,};
 843
 844       /* Insert new resolution at the end of the list */
 845       u32 new_idx = mc - am->mac_changes;
 846       if (p)
 847         p[0] = new_idx;
 848       else
 849         hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
 850     }
 851   else
 852     {
 853       if (!found)
 854         return VNET_API_ERROR_NO_SUCH_ENTRY;
 855
 856       /* Clients may need to clean up pool entries, too */
 857       void (*fp) (u32, u8 *) = data_callback;
 858       if (fp)
 859         (*fp) (mc->data, 0 /* no new mac addrs */ );
 860
 861       /* Remove the entry from the list and delete the entry */
 862       *p = mc->next_index;
 863       pool_put (am->mac_changes, mc);
 864
 865       /* Remove from hash if we deleted the last entry */
 866       if (*p == ~0 && p == first)
 867         hash_unset (am->mac_changes_by_address, address->as_u32);
 868     }
 869   return 0;
 870 }
 871
 872 /* Either we drop the packet or we send a reply to the sender. */
 873 typedef enum
 874 {
 875   ARP_INPUT_NEXT_DROP,
 876   ARP_INPUT_NEXT_REPLY_TX,
 877   ARP_INPUT_N_NEXT,
 878 } arp_input_next_t;
 879
 880 #define foreach_ethernet_arp_error                                      \
 881   _ (replies_sent, "ARP replies sent")                                  \
 882   _ (l2_type_not_ethernet, "L2 type not ethernet")                      \
 883   _ (l3_type_not_ip4, "L3 type not IP4")                                \
 884   _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
 885   _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
 886   _ (l3_dst_address_unset, "IP4 destination address is unset")          \
 887   _ (l3_src_address_is_local, "IP4 source address matches local interface") \
 888   _ (l3_src_address_learned, "ARP request IP4 source address learned")  \
 889   _ (replies_received, "ARP replies received")                          \
 890   _ (opcode_not_request, "ARP opcode not request")                      \
 891   _ (proxy_arp_replies_sent, "Proxy ARP replies sent")                  \
 892   _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
 893   _ (gratuitous_arp, "ARP probe or announcement dropped") \
 894   _ (interface_no_table, "Interface is not mapped to an IP table") \
 895   _ (interface_not_ip_enabled, "Interface is not IP enabled") \
 896
 897 typedef enum
 898 {
 899 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
 900   foreach_ethernet_arp_error
 901 #undef _
 902     ETHERNET_ARP_N_ERROR,
 903 } ethernet_arp_input_error_t;
 904
 905 static int
 906 arp_unnumbered (vlib_buffer_t * p0,
 907                 u32 input_sw_if_index, u32 conn_sw_if_index)
 908 {
 909   vnet_main_t *vnm = vnet_get_main ();
 910   vnet_interface_main_t *vim = &vnm->interface_main;
 911   vnet_sw_interface_t *si;
 912
 913   /* verify that the input interface is unnumbered to the connected.
 914    * the connected interface is the interface on which the subnet is
 915    * configured */
 916   si = &vim->sw_interfaces[input_sw_if_index];
 917
 918   if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
 919         (si->unnumbered_sw_if_index == conn_sw_if_index)))
 920     {
 921       /* the input interface is not unnumbered to the interface on which
 922        * the sub-net is configured that covers the ARP request.
 923        * So this is not the case for unnumbered.. */
 924       return 0;
 925     }
 926
 927   return !0;
 928 }
 929
 930 static u32
 931 arp_learn (vnet_main_t * vnm,
 932            ethernet_arp_main_t * am, u32 sw_if_index, void *addr)
 933 {
 934   vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
 935   return (ETHERNET_ARP_ERROR_l3_src_address_learned);
 936 }
 937
 938 static uword
 939 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 940 {
 941   ethernet_arp_main_t *am = &ethernet_arp_main;
 942   vnet_main_t *vnm = vnet_get_main ();
 943   ip4_main_t *im4 = &ip4_main;
 944   u32 n_left_from, next_index, *from, *to_next;
 945   u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
 946
 947   from = vlib_frame_vector_args (frame);
 948   n_left_from = frame->n_vectors;
 949   next_index = node->cached_next_index;
 950
 951   if (node->flags & VLIB_NODE_FLAG_TRACE)
 952     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 953                                    /* stride */ 1,
 954                                    sizeof (ethernet_arp_input_trace_t));
 955
 956   while (n_left_from > 0)
 957     {
 958       u32 n_left_to_next;
 959
 960       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 961
 962       while (n_left_from > 0 && n_left_to_next > 0)
 963         {
 964           vlib_buffer_t *p0;
 965           vnet_hw_interface_t *hw_if0;
 966           ethernet_arp_header_t *arp0;
 967           ethernet_header_t *eth_rx, *eth_tx;
 968           const ip4_address_t *if_addr0;
 969           ip4_address_t proxy_src;
 970           u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
 971           u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
 972           ethernet_proxy_arp_t *pa;
 973           fib_node_index_t dst_fei, src_fei;
 974           const fib_prefix_t *pfx0;
 975           fib_entry_flag_t src_flags, dst_flags;
 976           u8 *rewrite0, rewrite0_len;
 977
 978           pi0 = from[0];
 979           to_next[0] = pi0;
 980           from += 1;
 981           to_next += 1;
 982           n_left_from -= 1;
 983           n_left_to_next -= 1;
 984           pa = 0;
 985
 986           p0 = vlib_get_buffer (vm, pi0);
 987           arp0 = vlib_buffer_get_current (p0);
 988           /* Fill in ethernet header. */
 989           eth_rx = ethernet_buffer_get_header (p0);
 990
 991           is_request0 = arp0->opcode
 992             == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
 993
 994           error0 = ETHERNET_ARP_ERROR_replies_sent;
 995
 996           error0 =
 997             (arp0->l2_type !=
 998              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
 999              ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
1000           error0 =
1001             (arp0->l3_type !=
1002              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
1003              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
1004           error0 =
1005             (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ?
1006              ETHERNET_ARP_ERROR_l3_dst_address_unset : error0);
1007
1008           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1009
1010           /* not playing the ARP game if the interface is not IPv4 enabled */
1011           error0 =
1012             (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
1013              ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
1014
1015           if (error0)
1016             goto drop2;
1017
1018           /* Check that IP address is local and matches incoming interface. */
1019           fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1020           if (~0 == fib_index0)
1021             {
1022               error0 = ETHERNET_ARP_ERROR_interface_no_table;
1023               goto drop2;
1024
1025             }
1026           dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1027                                           &arp0->ip4_over_ethernet[1].ip4,
1028                                           32);
1029           dst_flags = fib_entry_get_flags (dst_fei);
1030
1031           conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
1032
1033           /* Honor unnumbered interface, if any */
1034           is_unnum0 = sw_if_index0 != conn_sw_if_index0;
1035
1036           {
1037             /*
1038              * we're looking for FIB entries that indicate the source
1039              * is attached. There may be more specific non-attached
1040              * routes that match the source, but these do not influence
1041              * whether we respond to an ARP request, i.e. they do not
1042              * influence whether we are the correct way for the sender
1043              * to reach us, they only affect how we reach the sender.
1044              */
1045             fib_entry_t *src_fib_entry;
1046             const fib_prefix_t *pfx;
1047             fib_entry_src_t *src;
1048             fib_source_t source;
1049             int attached;
1050             int mask;
1051
1052             mask = 32;
1053             attached = 0;
1054
1055             do
1056               {
1057                 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1058                                                 &arp0->
1059                                                 ip4_over_ethernet[0].ip4,
1060                                                 mask);
1061                 src_fib_entry = fib_entry_get (src_fei);
1062
1063                 /*
1064                  * It's possible that the source that provides the
1065                  * flags we need, or the flags we must not have,
1066                  * is not the best source, so check then all.
1067                  */
1068                 /* *INDENT-OFF* */
1069                 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1070                 ({
1071                   src_flags = fib_entry_get_flags_for_source (src_fei, source);
1072
1073                   /* Reject requests/replies with our local interface
1074                      address. */
1075                   if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1076                     {
1077                       error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1078                       /*
1079                        * When VPP has an interface whose address is also
1080                        * applied to a TAP interface on the host, then VPP's
1081                        * TAP interface will be unnumbered  to the 'real'
1082                        * interface and do proxy ARP from the host.
1083                        * The curious aspect of this setup is that ARP requests
1084                        * from the host will come from the VPP's own address.
1085                        * So don't drop immediately here, instead go see if this
1086                        * is a proxy ARP case.
1087                        */
1088                       goto drop1;
1089                     }
1090                   /* A Source must also be local to subnet of matching
1091                    * interface address. */
1092                   if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1093                       (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1094                     {
1095                       attached = 1;
1096                       break;
1097                     }
1098                   /*
1099                    * else
1100                    *  The packet was sent from an address that is not
1101                    *  connected nor attached i.e. it is not from an
1102                    *  address that is covered by a link's sub-net,
1103                    *  nor is it a already learned host resp.
1104                    */
1105                 }));
1106                 /* *INDENT-ON* */
1107
1108                 /*
1109                  * shorter mask lookup for the next iteration.
1110                  */
1111                 pfx = fib_entry_get_prefix (src_fei);
1112                 mask = pfx->fp_len - 1;
1113
1114                 /*
1115                  * continue until we hit the default route or we find
1116                  * the attached we are looking for. The most likely
1117                  * outcome is we find the attached with the first source
1118                  * on the first lookup.
1119                  */
1120               }
1121             while (!attached &&
1122                    !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1123
1124             if (!attached)
1125               {
1126                 /*
1127                  * the matching route is a not attached, i.e. it was
1128                  * added as a result of routing, rather than interface/ARP
1129                  * configuration. If the matching route is not a host route
1130                  * (i.e. a /32)
1131                  */
1132                 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1133                 goto drop2;
1134               }
1135           }
1136
1137           if (fib_entry_is_sourced (dst_fei, FIB_SOURCE_ADJ))
1138             {
1139               /*
1140                * We matched an adj-fib on ths source subnet (a /32 previously
1141                * added as a result of ARP). If this request is a gratuitous
1142                * ARP, then learn from it.
1143                * The check for matching an adj-fib, is to prevent hosts
1144                * from spamming us with gratuitous ARPS that might otherwise
1145                * blow our ARP cache
1146                */
1147               if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1148                   arp0->ip4_over_ethernet[1].ip4.as_u32)
1149                 error0 = arp_learn (vnm, am, sw_if_index0,
1150                                     &arp0->ip4_over_ethernet[0]);
1151               goto drop2;
1152             }
1153           else if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1154             {
1155               error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1156               goto drop1;
1157             }
1158
1159           if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1160             {
1161               /*
1162                * The interface the ARP was received on is not the interface
1163                * on which the covering prefix is configured. Maybe this is a
1164                * case for unnumbered.
1165                */
1166               is_unnum0 = 1;
1167             }
1168
1169           dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1170           pfx0 = fib_entry_get_prefix (dst_fei);
1171           if_addr0 = &pfx0->fp_addr.ip4;
1172
1173           is_vrrp_reply0 =
1174             ((arp0->opcode ==
1175               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1176              &&
1177              (!memcmp
1178               (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1179                sizeof (vrrp_prefix))));
1180
1181           /* Trash ARP packets whose ARP-level source addresses do not
1182              match their L2-frame-level source addresses, unless it's
1183              a reply from a VRRP virtual router */
1184           if (memcmp
1185               (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1186                sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1187             {
1188               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1189               goto drop2;
1190             }
1191
1192           /* Learn or update sender's mapping only for replies to addresses
1193            * that are local to the subnet */
1194           if (arp0->opcode ==
1195               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1196             {
1197               if (dst_is_local0)
1198                 error0 = arp_learn (vnm, am, sw_if_index0,
1199                                     &arp0->ip4_over_ethernet[0]);
1200               else
1201                 /* a reply for a non-local destination could be a GARP.
1202                  * GARPs for hosts we know were handled above, so this one
1203                  * we drop */
1204                 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1205
1206               goto drop1;
1207             }
1208           else if (arp0->opcode ==
1209                    clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1210                    (dst_is_local0 == 0))
1211             {
1212               goto drop1;
1213             }
1214
1215         send_reply:
1216           /* Send a reply.
1217              An adjacency to the sender is not always present,
1218              so we use the interface to build us a rewrite string
1219              which will contain all the necessary tags. */
1220           rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1221                                              VNET_LINK_ARP,
1222                                              eth_rx->src_address);
1223           rewrite0_len = vec_len (rewrite0);
1224
1225           /* Figure out how much to rewind current data from adjacency. */
1226           vlib_buffer_advance (p0, -rewrite0_len);
1227           eth_tx = vlib_buffer_get_current (p0);
1228
1229           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1230           hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1231
1232           /* Send reply back through input interface */
1233           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1234           next0 = ARP_INPUT_NEXT_REPLY_TX;
1235
1236           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1237
1238           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1239
1240           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1241                        hw_if0->hw_address, 6);
1242           clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1243             if_addr0->data_u32;
1244
1245           /* Hardware must be ethernet-like. */
1246           ASSERT (vec_len (hw_if0->hw_address) == 6);
1247
1248           /* the rx nd tx ethernet headers wil overlap in the case
1249            * when we received a tagged VLAN=0 packet, but we are sending
1250            * back untagged */
1251           clib_memcpy (eth_tx, rewrite0, vec_len (rewrite0));
1252           vec_free (rewrite0);
1253
1254           if (NULL == pa)
1255             {
1256               if (is_unnum0)
1257                 {
1258                   if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1259                     goto drop2;
1260                 }
1261             }
1262
1263           /* We are going to reply to this request, so, in the absence of
1264              errors, learn the sender */
1265           if (!error0)
1266             error0 = arp_learn (vnm, am, sw_if_index0,
1267                                 &arp0->ip4_over_ethernet[1]);
1268
1269           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1270                                            n_left_to_next, pi0, next0);
1271
1272           n_replies_sent += 1;
1273           continue;
1274
1275         drop1:
1276           if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1277               arp0->ip4_over_ethernet[1].ip4.as_u32)
1278             {
1279               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1280               goto drop2;
1281             }
1282           /* See if proxy arp is configured for the address */
1283           if (is_request0)
1284             {
1285               vnet_sw_interface_t *si;
1286               u32 this_addr = clib_net_to_host_u32
1287                 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1288               u32 fib_index0;
1289
1290               si = vnet_get_sw_interface (vnm, sw_if_index0);
1291
1292               if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1293                 goto drop2;
1294
1295               fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1296                                     sw_if_index0);
1297
1298               vec_foreach (pa, am->proxy_arps)
1299               {
1300                 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr.as_u32);
1301                 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr.as_u32);
1302
1303                 /* an ARP request hit in the proxy-arp table? */
1304                 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1305                     (fib_index0 == pa->fib_index))
1306                   {
1307                     proxy_src.as_u32 =
1308                       arp0->ip4_over_ethernet[1].ip4.data_u32;
1309
1310                     /*
1311                      * change the interface address to the proxied
1312                      */
1313                     if_addr0 = &proxy_src;
1314                     is_unnum0 = 0;
1315                     n_proxy_arp_replies_sent++;
1316                     goto send_reply;
1317                   }
1318               }
1319             }
1320
1321         drop2:
1322
1323           next0 = ARP_INPUT_NEXT_DROP;
1324           p0->error = node->errors[error0];
1325
1326           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1327                                            n_left_to_next, pi0, next0);
1328         }
1329
1330       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1331     }
1332
1333   vlib_error_count (vm, node->node_index,
1334                     ETHERNET_ARP_ERROR_replies_sent,
1335                     n_replies_sent - n_proxy_arp_replies_sent);
1336
1337   vlib_error_count (vm, node->node_index,
1338                     ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1339                     n_proxy_arp_replies_sent);
1340   return frame->n_vectors;
1341 }
1342
1343 static char *ethernet_arp_error_strings[] = {
1344 #define _(sym,string) string,
1345   foreach_ethernet_arp_error
1346 #undef _
1347 };
1348
1349 /* *INDENT-OFF* */
1350 VLIB_REGISTER_NODE (arp_input_node, static) =
1351 {
1352   .function = arp_input,
1353   .name = "arp-input",
1354   .vector_size = sizeof (u32),
1355   .n_errors = ETHERNET_ARP_N_ERROR,
1356   .error_strings = ethernet_arp_error_strings,
1357   .n_next_nodes = ARP_INPUT_N_NEXT,
1358   .next_nodes = {
1359     [ARP_INPUT_NEXT_DROP] = "error-drop",
1360     [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1361   },
1362   .format_buffer = format_ethernet_arp_header,
1363   .format_trace = format_ethernet_arp_input_trace,
1364 };
1365 /* *INDENT-ON* */
1366
1367 static int
1368 ip4_arp_entry_sort (void *a1, void *a2)
1369 {
1370   ethernet_arp_ip4_entry_t *e1 = a1;
1371   ethernet_arp_ip4_entry_t *e2 = a2;
1372
1373   int cmp;
1374   vnet_main_t *vnm = vnet_get_main ();
1375
1376   cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1377   if (!cmp)
1378     cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1379   return cmp;
1380 }
1381
1382 ethernet_arp_ip4_entry_t *
1383 ip4_neighbors_pool (void)
1384 {
1385   ethernet_arp_main_t *am = &ethernet_arp_main;
1386   return am->ip4_entry_pool;
1387 }
1388
1389 ethernet_arp_ip4_entry_t *
1390 ip4_neighbor_entries (u32 sw_if_index)
1391 {
1392   ethernet_arp_main_t *am = &ethernet_arp_main;
1393   ethernet_arp_ip4_entry_t *n, *ns = 0;
1394
1395   /* *INDENT-OFF* */
1396   pool_foreach (n, am->ip4_entry_pool, ({
1397     if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1398       continue;
1399     vec_add1 (ns, n[0]);
1400   }));
1401   /* *INDENT-ON* */
1402
1403   if (ns)
1404     vec_sort_with_function (ns, ip4_arp_entry_sort);
1405   return ns;
1406 }
1407
1408 static clib_error_t *
1409 show_ip4_arp (vlib_main_t * vm,
1410               unformat_input_t * input, vlib_cli_command_t * cmd)
1411 {
1412   vnet_main_t *vnm = vnet_get_main ();
1413   ethernet_arp_main_t *am = &ethernet_arp_main;
1414   ethernet_arp_ip4_entry_t *e, *es;
1415   ethernet_proxy_arp_t *pa;
1416   clib_error_t *error = 0;
1417   u32 sw_if_index;
1418
1419   /* Filter entries by interface if given. */
1420   sw_if_index = ~0;
1421   (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1422
1423   es = ip4_neighbor_entries (sw_if_index);
1424   if (es)
1425     {
1426       vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1427       vec_foreach (e, es)
1428       {
1429         vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1430       }
1431       vec_free (es);
1432     }
1433
1434   if (vec_len (am->proxy_arps))
1435     {
1436       vlib_cli_output (vm, "Proxy arps enabled for:");
1437       vec_foreach (pa, am->proxy_arps)
1438       {
1439         vlib_cli_output (vm, "Fib_index %d   %U - %U ",
1440                          pa->fib_index,
1441                          format_ip4_address, &pa->lo_addr,
1442                          format_ip4_address, &pa->hi_addr);
1443       }
1444     }
1445
1446   return error;
1447 }
1448
1449 /*?
1450  * Display all the IPv4 ARP entries.
1451  *
1452  * @cliexpar
1453  * Example of how to display the IPv4 ARP table:
1454  * @cliexstart{show ip arp}
1455  *    Time      FIB        IP4       Flags      Ethernet              Interface
1456  *    346.3028   0       6.1.1.3            de:ad:be:ef:ba:be   GigabitEthernet2/0/0
1457  *   3077.4271   0       6.1.1.4       S    de:ad:be:ef:ff:ff   GigabitEthernet2/0/0
1458  *   2998.6409   1       6.2.2.3            de:ad:be:ef:00:01   GigabitEthernet2/0/0
1459  * Proxy arps enabled for:
1460  * Fib_index 0   6.0.0.1 - 6.0.0.11
1461  * @cliexend
1462  ?*/
1463 /* *INDENT-OFF* */
1464 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1465   .path = "show ip arp",
1466   .function = show_ip4_arp,
1467   .short_help = "show ip arp",
1468 };
1469 /* *INDENT-ON* */
1470
1471 typedef struct
1472 {
1473   pg_edit_t l2_type, l3_type;
1474   pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1475   pg_edit_t opcode;
1476   struct
1477   {
1478     pg_edit_t ethernet;
1479     pg_edit_t ip4;
1480   } ip4_over_ethernet[2];
1481 } pg_ethernet_arp_header_t;
1482
1483 static inline void
1484 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1485 {
1486   /* Initialize fields that are not bit fields in the IP header. */
1487 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1488   _(l2_type);
1489   _(l3_type);
1490   _(n_l2_address_bytes);
1491   _(n_l3_address_bytes);
1492   _(opcode);
1493   _(ip4_over_ethernet[0].ethernet);
1494   _(ip4_over_ethernet[0].ip4);
1495   _(ip4_over_ethernet[1].ethernet);
1496   _(ip4_over_ethernet[1].ip4);
1497 #undef _
1498 }
1499
1500 uword
1501 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1502 {
1503   pg_stream_t *s = va_arg (*args, pg_stream_t *);
1504   pg_ethernet_arp_header_t *p;
1505   u32 group_index;
1506
1507   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1508                             &group_index);
1509   pg_ethernet_arp_header_init (p);
1510
1511   /* Defaults. */
1512   pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1513   pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1514   pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1515   pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1516
1517   if (!unformat (input, "%U: %U/%U -> %U/%U",
1518                  unformat_pg_edit,
1519                  unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1520                  unformat_pg_edit,
1521                  unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1522                  unformat_pg_edit,
1523                  unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1524                  unformat_pg_edit,
1525                  unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1526                  unformat_pg_edit,
1527                  unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1528     {
1529       /* Free up any edits we may have added. */
1530       pg_free_edit_group (s);
1531       return 0;
1532     }
1533   return 1;
1534 }
1535
1536 clib_error_t *
1537 ip4_set_arp_limit (u32 arp_limit)
1538 {
1539   ethernet_arp_main_t *am = &ethernet_arp_main;
1540
1541   am->limit_arp_cache_size = arp_limit;
1542   return 0;
1543 }
1544
1545 /**
1546  * @brief Control Plane hook to remove an ARP entry
1547  */
1548 int
1549 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1550                                   u32 sw_if_index, void *a_arg)
1551 {
1552   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1553   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1554
1555   args.sw_if_index = sw_if_index;
1556   args.flags = ETHERNET_ARP_ARGS_REMOVE;
1557   clib_memcpy (&args.a, a, sizeof (*a));
1558
1559   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1560                                (u8 *) & args, sizeof (args));
1561   return 0;
1562 }
1563
1564 /**
1565  * @brief Internally generated event to flush the ARP cache on an
1566  * interface state change event.
1567  * A flush will remove dynamic ARP entries, and for statics remove the MAC
1568  * address from the corresponding adjacencies.
1569  */
1570 static int
1571 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1572                                   u32 sw_if_index, void *a_arg)
1573 {
1574   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1575   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1576
1577   args.sw_if_index = sw_if_index;
1578   args.flags = ETHERNET_ARP_ARGS_FLUSH;
1579   clib_memcpy (&args.a, a, sizeof (*a));
1580
1581   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1582                                (u8 *) & args, sizeof (args));
1583   return 0;
1584 }
1585
1586 /**
1587  * @brief Internally generated event to populate the ARP cache on an
1588  * interface state change event.
1589  * For static entries this will re-source the adjacencies.
1590  *
1591  * @param sw_if_index The interface on which the ARP entires are acted
1592  */
1593 static int
1594 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1595                                      u32 sw_if_index, void *a_arg)
1596 {
1597   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1598   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1599
1600   args.sw_if_index = sw_if_index;
1601   args.flags = ETHERNET_ARP_ARGS_POPULATE;
1602   clib_memcpy (&args.a, a, sizeof (*a));
1603
1604   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1605                                (u8 *) & args, sizeof (args));
1606   return 0;
1607 }
1608
1609 /**
1610  * @brief publish wildcard arp event
1611  * @param sw_if_index The interface on which the ARP entires are acted
1612  */
1613 static int
1614 vnet_arp_wc_publish (u32 sw_if_index, void *a_arg)
1615 {
1616   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1617   vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1618     .flags = ETHERNET_ARP_ARGS_WC_PUB,
1619     .sw_if_index = sw_if_index,
1620     .a = *a
1621   };
1622
1623   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1624                                (u8 *) & args, sizeof (args));
1625   return 0;
1626 }
1627
1628 static void
1629 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1630                               vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1631                               args)
1632 {
1633   vlib_main_t *vm = vlib_get_main ();
1634   ethernet_arp_main_t *am = &ethernet_arp_main;
1635   uword ni = am->wc_ip4_arp_publisher_node;
1636   uword et = am->wc_ip4_arp_publisher_et;
1637
1638   if (ni == (uword) ~ 0)
1639     return;
1640   wc_arp_report_t *r =
1641     vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1642   r->ip4 = args->a.ip4.as_u32;
1643   r->sw_if_index = args->sw_if_index;
1644   memcpy (r->mac, args->a.ethernet, sizeof r->mac);
1645 }
1646
1647 void
1648 wc_arp_set_publisher_node (uword node_index, uword event_type)
1649 {
1650   ethernet_arp_main_t *am = &ethernet_arp_main;
1651   am->wc_ip4_arp_publisher_node = node_index;
1652   am->wc_ip4_arp_publisher_et = event_type;
1653 }
1654
1655 /*
1656  * arp_add_del_interface_address
1657  *
1658  * callback when an interface address is added or deleted
1659  */
1660 static void
1661 arp_add_del_interface_address (ip4_main_t * im,
1662                                uword opaque,
1663                                u32 sw_if_index,
1664                                ip4_address_t * address,
1665                                u32 address_length,
1666                                u32 if_address_index, u32 is_del)
1667 {
1668   /*
1669    * Flush the ARP cache of all entries covered by the address
1670    * that is being removed.
1671    */
1672   ethernet_arp_main_t *am = &ethernet_arp_main;
1673   ethernet_arp_ip4_entry_t *e;
1674
1675   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1676     return;
1677
1678   if (is_del)
1679     {
1680       ethernet_arp_interface_t *eai;
1681       u32 i, *to_delete = 0;
1682       hash_pair_t *pair;
1683
1684       eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1685
1686       /* *INDENT-OFF* */
1687       hash_foreach_pair (pair, eai->arp_entries,
1688       ({
1689         e = pool_elt_at_index(am->ip4_entry_pool,
1690                               pair->value[0]);
1691         if (ip4_destination_matches_route (im, &e->ip4_address,
1692                                            address, address_length))
1693           {
1694             vec_add1 (to_delete, e - am->ip4_entry_pool);
1695           }
1696       }));
1697       /* *INDENT-ON* */
1698
1699       for (i = 0; i < vec_len (to_delete); i++)
1700         {
1701           ethernet_arp_ip4_over_ethernet_address_t delme;
1702           e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1703
1704           clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1705           delme.ip4.as_u32 = e->ip4_address.as_u32;
1706
1707           vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1708                                             e->sw_if_index, &delme);
1709         }
1710
1711       vec_free (to_delete);
1712     }
1713 }
1714
1715 static void
1716 arp_table_bind (ip4_main_t * im,
1717                 uword opaque,
1718                 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
1719 {
1720   ethernet_arp_main_t *am = &ethernet_arp_main;
1721   ethernet_arp_interface_t *eai;
1722   ethernet_arp_ip4_entry_t *e;
1723   hash_pair_t *pair;
1724
1725   /*
1726    * the IP table that the interface is bound to has changed.
1727    * reinstall all the adj fibs.
1728    */
1729
1730   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1731     return;
1732
1733   eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1734
1735   /* *INDENT-OFF* */
1736   hash_foreach_pair (pair, eai->arp_entries,
1737   ({
1738     e = pool_elt_at_index(am->ip4_entry_pool,
1739                           pair->value[0]);
1740     /*
1741      * remove the adj-fib from the old table and add to the new
1742      */
1743     arp_adj_fib_remove(e, old_fib_index);
1744     arp_adj_fib_add(e, new_fib_index);
1745   }));
1746   /* *INDENT-ON* */
1747
1748 }
1749
1750 static clib_error_t *
1751 ethernet_arp_init (vlib_main_t * vm)
1752 {
1753   ethernet_arp_main_t *am = &ethernet_arp_main;
1754   ip4_main_t *im = &ip4_main;
1755   clib_error_t *error;
1756   pg_node_t *pn;
1757
1758   if ((error = vlib_call_init_function (vm, ethernet_init)))
1759     return error;
1760
1761   ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1762
1763   pn = pg_get_node (arp_input_node.index);
1764   pn->unformat_edit = unformat_pg_arp_header;
1765
1766   am->opcode_by_name = hash_create_string (0, sizeof (uword));
1767 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1768   foreach_ethernet_arp_opcode;
1769 #undef _
1770
1771   /* $$$ configurable */
1772   am->limit_arp_cache_size = 50000;
1773
1774   am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1775   am->mac_changes_by_address = hash_create (0, sizeof (uword));
1776   am->wc_ip4_arp_publisher_node = (uword) ~ 0;
1777
1778   /* don't trace ARP error packets */
1779   {
1780     vlib_node_runtime_t *rt =
1781       vlib_node_get_runtime (vm, arp_input_node.index);
1782
1783 #define _(a,b)                                  \
1784     vnet_pcap_drop_trace_filter_add_del         \
1785         (rt->errors[ETHERNET_ARP_ERROR_##a],    \
1786          1 /* is_add */);
1787     foreach_ethernet_arp_error
1788 #undef _
1789   }
1790
1791   ip4_add_del_interface_address_callback_t cb;
1792   cb.function = arp_add_del_interface_address;
1793   cb.function_opaque = 0;
1794   vec_add1 (im->add_del_interface_address_callbacks, cb);
1795
1796   ip4_table_bind_callback_t cbt;
1797   cbt.function = arp_table_bind;
1798   cbt.function_opaque = 0;
1799   vec_add1 (im->table_bind_callbacks, cbt);
1800
1801   return 0;
1802 }
1803
1804 VLIB_INIT_FUNCTION (ethernet_arp_init);
1805
1806 static void
1807 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1808 {
1809   ethernet_arp_main_t *am = &ethernet_arp_main;
1810
1811   arp_adj_fib_remove
1812     (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
1813   hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1814   pool_put (am->ip4_entry_pool, e);
1815 }
1816
1817 static inline int
1818 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1819                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1820                                            * args)
1821 {
1822   ethernet_arp_main_t *am = &ethernet_arp_main;
1823   ethernet_arp_ip4_entry_t *e;
1824   ethernet_arp_interface_t *eai;
1825
1826   if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1827     return 0;
1828
1829   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1830
1831   e = arp_entry_find (eai, &args->a.ip4);
1832
1833   if (NULL != e)
1834     {
1835       adj_nbr_walk_nh4 (e->sw_if_index,
1836                         &e->ip4_address, arp_mk_incomplete_walk, NULL);
1837       arp_entry_free (eai, e);
1838     }
1839
1840   return 0;
1841 }
1842
1843 static int
1844 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1845                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1846                                            * args)
1847 {
1848   ethernet_arp_main_t *am = &ethernet_arp_main;
1849   ethernet_arp_ip4_entry_t *e;
1850   ethernet_arp_interface_t *eai;
1851
1852   if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1853     return 0;
1854
1855   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1856
1857   e = arp_entry_find (eai, &args->a.ip4);
1858
1859   if (NULL != e)
1860     {
1861       adj_nbr_walk_nh4 (e->sw_if_index,
1862                         &e->ip4_address, arp_mk_incomplete_walk, e);
1863
1864       /*
1865        * The difference between flush and unset, is that an unset
1866        * means delete for static and dynamic entries. A flush
1867        * means delete only for dynamic. Flushing is what the DP
1868        * does in response to interface events. unset is only done
1869        * by the control plane.
1870        */
1871       if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
1872         {
1873           e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
1874         }
1875       else if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1876         {
1877           arp_entry_free (eai, e);
1878         }
1879     }
1880   return (0);
1881 }
1882
1883 static int
1884 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1885                                               vnet_arp_set_ip4_over_ethernet_rpc_args_t
1886                                               * args)
1887 {
1888   ethernet_arp_main_t *am = &ethernet_arp_main;
1889   ethernet_arp_ip4_entry_t *e;
1890   ethernet_arp_interface_t *eai;
1891
1892   vec_validate (am->ethernet_arp_by_sw_if_index, args->sw_if_index);
1893   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1894
1895   e = arp_entry_find (eai, &args->a.ip4);
1896
1897   if (NULL != e)
1898     {
1899       adj_nbr_walk_nh4 (e->sw_if_index,
1900                         &e->ip4_address, arp_mk_complete_walk, e);
1901     }
1902   return (0);
1903 }
1904
1905 static void
1906 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1907                                     * a)
1908 {
1909   vnet_main_t *vm = vnet_get_main ();
1910   ASSERT (vlib_get_thread_index () == 0);
1911
1912   if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1913     vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1914   else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1915     vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1916   else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1917     vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1918   else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
1919     vnet_arp_wc_publish_internal (vm, a);
1920   else
1921     vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1922 }
1923
1924 /**
1925  * @brief Invoked when the interface's admin state changes
1926  */
1927 static clib_error_t *
1928 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1929                                    u32 sw_if_index, u32 flags)
1930 {
1931   ethernet_arp_main_t *am = &ethernet_arp_main;
1932   ethernet_arp_ip4_entry_t *e;
1933   u32 i, *to_delete = 0;
1934
1935   /* *INDENT-OFF* */
1936   pool_foreach (e, am->ip4_entry_pool,
1937   ({
1938     if (e->sw_if_index == sw_if_index)
1939       vec_add1 (to_delete,
1940                 e - am->ip4_entry_pool);
1941   }));
1942   /* *INDENT-ON* */
1943
1944   for (i = 0; i < vec_len (to_delete); i++)
1945     {
1946       ethernet_arp_ip4_over_ethernet_address_t delme;
1947       e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1948
1949       clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1950       delme.ip4.as_u32 = e->ip4_address.as_u32;
1951
1952       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1953         {
1954           vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1955         }
1956       else
1957         {
1958           vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1959         }
1960
1961     }
1962   vec_free (to_delete);
1963
1964   return 0;
1965 }
1966
1967 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1968
1969 static void
1970 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1971 {
1972   u8 old;
1973   int i;
1974
1975   for (i = 3; i >= 0; i--)
1976     {
1977       old = a->ip4.as_u8[i];
1978       a->ip4.as_u8[i] += 1;
1979       if (old < a->ip4.as_u8[i])
1980         break;
1981     }
1982
1983   for (i = 5; i >= 0; i--)
1984     {
1985       old = a->ethernet[i];
1986       a->ethernet[i] += 1;
1987       if (old < a->ethernet[i])
1988         break;
1989     }
1990 }
1991
1992 int
1993 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1994                                 u32 sw_if_index, void *a_arg,
1995                                 int is_static, int is_no_fib_entry)
1996 {
1997   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1998   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1999
2000   args.sw_if_index = sw_if_index;
2001   args.is_static = is_static;
2002   args.is_no_fib_entry = is_no_fib_entry;
2003   args.flags = 0;
2004   clib_memcpy (&args.a, a, sizeof (*a));
2005
2006   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
2007                                (u8 *) & args, sizeof (args));
2008   return 0;
2009 }
2010
2011 void
2012 proxy_arp_walk (proxy_arp_walk_t cb, void *data)
2013 {
2014   ethernet_arp_main_t *am = &ethernet_arp_main;
2015   ethernet_proxy_arp_t *pa;
2016
2017   vec_foreach (pa, am->proxy_arps)
2018   {
2019     if (!cb (&pa->lo_addr, &pa->hi_addr, pa->fib_index, data))
2020       break;
2021   }
2022 }
2023
2024 int
2025 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
2026                         ip4_address_t * hi_addr, u32 fib_index, int is_del)
2027 {
2028   ethernet_arp_main_t *am = &ethernet_arp_main;
2029   ethernet_proxy_arp_t *pa;
2030   u32 found_at_index = ~0;
2031
2032   vec_foreach (pa, am->proxy_arps)
2033   {
2034     if (pa->lo_addr.as_u32 == lo_addr->as_u32 &&
2035         pa->hi_addr.as_u32 == hi_addr->as_u32 && pa->fib_index == fib_index)
2036       {
2037         found_at_index = pa - am->proxy_arps;
2038         break;
2039       }
2040   }
2041
2042   if (found_at_index != ~0)
2043     {
2044       /* Delete, otherwise it's already in the table */
2045       if (is_del)
2046         vec_delete (am->proxy_arps, 1, found_at_index);
2047       return 0;
2048     }
2049   /* delete, no such entry */
2050   if (is_del)
2051     return VNET_API_ERROR_NO_SUCH_ENTRY;
2052
2053   /* add, not in table */
2054   vec_add2 (am->proxy_arps, pa, 1);
2055   pa->lo_addr.as_u32 = lo_addr->as_u32;
2056   pa->hi_addr.as_u32 = hi_addr->as_u32;
2057   pa->fib_index = fib_index;
2058   return 0;
2059 }
2060
2061 /*
2062  * Remove any proxy arp entries asdociated with the
2063  * specificed fib.
2064  */
2065 int
2066 vnet_proxy_arp_fib_reset (u32 fib_id)
2067 {
2068   ethernet_arp_main_t *am = &ethernet_arp_main;
2069   ethernet_proxy_arp_t *pa;
2070   u32 *entries_to_delete = 0;
2071   u32 fib_index;
2072   int i;
2073
2074   fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2075   if (~0 == fib_index)
2076     return VNET_API_ERROR_NO_SUCH_ENTRY;
2077
2078   vec_foreach (pa, am->proxy_arps)
2079   {
2080     if (pa->fib_index == fib_index)
2081       {
2082         vec_add1 (entries_to_delete, pa - am->proxy_arps);
2083       }
2084   }
2085
2086   for (i = 0; i < vec_len (entries_to_delete); i++)
2087     {
2088       vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2089     }
2090
2091   vec_free (entries_to_delete);
2092
2093   return 0;
2094 }
2095
2096 static clib_error_t *
2097 ip_arp_add_del_command_fn (vlib_main_t * vm,
2098                            unformat_input_t * input, vlib_cli_command_t * cmd)
2099 {
2100   vnet_main_t *vnm = vnet_get_main ();
2101   u32 sw_if_index;
2102   ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2103   int addr_valid = 0;
2104   int is_del = 0;
2105   int count = 1;
2106   u32 fib_index = 0;
2107   u32 fib_id;
2108   int is_static = 0;
2109   int is_no_fib_entry = 0;
2110   int is_proxy = 0;
2111
2112   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2113     {
2114       /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2115       if (unformat (input, "%U %U %U",
2116                     unformat_vnet_sw_interface, vnm, &sw_if_index,
2117                     unformat_ip4_address, &addr.ip4,
2118                     unformat_ethernet_address, &addr.ethernet))
2119         addr_valid = 1;
2120
2121       else if (unformat (input, "delete") || unformat (input, "del"))
2122         is_del = 1;
2123
2124       else if (unformat (input, "static"))
2125         is_static = 1;
2126
2127       else if (unformat (input, "no-fib-entry"))
2128         is_no_fib_entry = 1;
2129
2130       else if (unformat (input, "count %d", &count))
2131         ;
2132
2133       else if (unformat (input, "fib-id %d", &fib_id))
2134         {
2135           fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2136
2137           if (~0 == fib_index)
2138             return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2139         }
2140
2141       else if (unformat (input, "proxy %U - %U",
2142                          unformat_ip4_address, &lo_addr.ip4,
2143                          unformat_ip4_address, &hi_addr.ip4))
2144         is_proxy = 1;
2145       else
2146         break;
2147     }
2148
2149   if (is_proxy)
2150     {
2151       (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2152                                      fib_index, is_del);
2153       return 0;
2154     }
2155
2156   if (addr_valid)
2157     {
2158       int i;
2159
2160       for (i = 0; i < count; i++)
2161         {
2162           if (is_del == 0)
2163             {
2164               uword event_type, *event_data = 0;
2165
2166               /* Park the debug CLI until the arp entry is installed */
2167               vnet_register_ip4_arp_resolution_event
2168                 (vnm, &addr.ip4, vlib_current_process (vm),
2169                  1 /* type */ , 0 /* data */ );
2170
2171               vnet_arp_set_ip4_over_ethernet
2172                 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
2173
2174               vlib_process_wait_for_event (vm);
2175               event_type = vlib_process_get_events (vm, &event_data);
2176               vec_reset_length (event_data);
2177               if (event_type != 1)
2178                 clib_warning ("event type %d unexpected", event_type);
2179             }
2180           else
2181             vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2182
2183           increment_ip4_and_mac_address (&addr);
2184         }
2185     }
2186   else
2187     {
2188       return clib_error_return (0, "unknown input `%U'",
2189                                 format_unformat_error, input);
2190     }
2191
2192   return 0;
2193 }
2194
2195 /* *INDENT-OFF* */
2196 /*?
2197  * Add or delete IPv4 ARP cache entries.
2198  *
2199  * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2200  * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2201  * any order and combination.
2202  *
2203  * @cliexpar
2204  * @parblock
2205  * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2206  * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2207  * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2208  * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2209  *
2210  * To add or delete an IPv4 ARP cache entry to or from a specific fib
2211  * table:
2212  * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2213  * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2214  *
2215  * Add or delete IPv4 static ARP cache entries as follows:
2216  * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2217  * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2218  *
2219  * For testing / debugging purposes, the 'set ip arp' command can add or
2220  * delete multiple entries. Supply the 'count N' parameter:
2221  * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2222  * @endparblock
2223  ?*/
2224 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2225   .path = "set ip arp",
2226   .short_help =
2227   "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2228   .function = ip_arp_add_del_command_fn,
2229 };
2230 /* *INDENT-ON* */
2231
2232 static clib_error_t *
2233 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2234                               unformat_input_t *
2235                               input, vlib_cli_command_t * cmd)
2236 {
2237   vnet_main_t *vnm = vnet_get_main ();
2238   u32 sw_if_index;
2239   vnet_sw_interface_t *si;
2240   int enable = 0;
2241   int intfc_set = 0;
2242
2243   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2244     {
2245       if (unformat (input, "%U", unformat_vnet_sw_interface,
2246                     vnm, &sw_if_index))
2247         intfc_set = 1;
2248       else if (unformat (input, "enable") || unformat (input, "on"))
2249         enable = 1;
2250       else if (unformat (input, "disable") || unformat (input, "off"))
2251         enable = 0;
2252       else
2253         break;
2254     }
2255
2256   if (intfc_set == 0)
2257     return clib_error_return (0, "unknown input '%U'",
2258                               format_unformat_error, input);
2259
2260   si = vnet_get_sw_interface (vnm, sw_if_index);
2261   ASSERT (si);
2262   if (enable)
2263     si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2264   else
2265     si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2266
2267   return 0;
2268 }
2269
2270 /* *INDENT-OFF* */
2271 /*?
2272  * Enable proxy-arp on an interface. The vpp stack will answer ARP
2273  * requests for the indicated address range. Multiple proxy-arp
2274  * ranges may be provisioned.
2275  *
2276  * @note Proxy ARP as a technology is infamous for blackholing traffic.
2277  * Also, the underlying implementation has not been performance-tuned.
2278  * Avoid creating an unnecessarily large set of ranges.
2279  *
2280  * @cliexpar
2281  * To enable proxy arp on a range of addresses, use:
2282  * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2283  * Append 'del' to delete a range of proxy ARP addresses:
2284  * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2285  * You must then specifically enable proxy arp on individual interfaces:
2286  * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2287  * To disable proxy arp on an individual interface:
2288  * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2289  ?*/
2290 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2291   .path = "set interface proxy-arp",
2292   .short_help =
2293   "set interface proxy-arp <intfc> [enable|disable]",
2294   .function = set_int_proxy_arp_command_fn,
2295 };
2296 /* *INDENT-ON* */
2297
2298
2299 /*
2300  * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2301  * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2302  */
2303 typedef enum
2304 {
2305   ARP_TERM_NEXT_L2_OUTPUT,
2306   ARP_TERM_NEXT_DROP,
2307   ARP_TERM_N_NEXT,
2308 } arp_term_next_t;
2309
2310 u32 arp_term_next_node_index[32];
2311
2312 static uword
2313 arp_term_l2bd (vlib_main_t * vm,
2314                vlib_node_runtime_t * node, vlib_frame_t * frame)
2315 {
2316   l2input_main_t *l2im = &l2input_main;
2317   u32 n_left_from, next_index, *from, *to_next;
2318   u32 n_replies_sent = 0;
2319   u16 last_bd_index = ~0;
2320   l2_bridge_domain_t *last_bd_config = 0;
2321   l2_input_config_t *cfg0;
2322
2323   from = vlib_frame_vector_args (frame);
2324   n_left_from = frame->n_vectors;
2325   next_index = node->cached_next_index;
2326
2327   while (n_left_from > 0)
2328     {
2329       u32 n_left_to_next;
2330
2331       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2332
2333       while (n_left_from > 0 && n_left_to_next > 0)
2334         {
2335           vlib_buffer_t *p0;
2336           ethernet_header_t *eth0;
2337           ethernet_arp_header_t *arp0;
2338           ip6_header_t *iph0;
2339           u8 *l3h0;
2340           u32 pi0, error0, next0, sw_if_index0;
2341           u16 ethertype0;
2342           u16 bd_index0;
2343           u32 ip0;
2344           u8 *macp0;
2345
2346           pi0 = from[0];
2347           to_next[0] = pi0;
2348           from += 1;
2349           to_next += 1;
2350           n_left_from -= 1;
2351           n_left_to_next -= 1;
2352
2353           p0 = vlib_get_buffer (vm, pi0);
2354           // Terminate only local (SHG == 0) ARP
2355           if (vnet_buffer (p0)->l2.shg != 0)
2356             goto next_l2_feature;
2357
2358           eth0 = vlib_buffer_get_current (p0);
2359           l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2360           ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2361           arp0 = (ethernet_arp_header_t *) l3h0;
2362
2363           if (ethertype0 != ETHERNET_TYPE_ARP)
2364             goto check_ip6_nd;
2365
2366           if ((arp0->opcode !=
2367                clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request)) &&
2368               (arp0->opcode !=
2369                clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply)))
2370             goto check_ip6_nd;
2371
2372           /* Must be ARP request/reply packet here */
2373           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2374                              (p0->flags & VLIB_BUFFER_IS_TRACED)))
2375             {
2376               u8 *t0 = vlib_add_trace (vm, node, p0,
2377                                        sizeof (ethernet_arp_input_trace_t));
2378               clib_memcpy (t0, l3h0, sizeof (ethernet_arp_input_trace_t));
2379             }
2380
2381           error0 = 0;
2382           error0 =
2383             (arp0->l2_type !=
2384              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2385              ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2386           error0 =
2387             (arp0->l3_type !=
2388              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2389              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2390
2391           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2392
2393           if (error0)
2394             goto drop;
2395
2396           /* Trash ARP packets whose ARP-level source addresses do not
2397              match, or if requester address is mcast */
2398           if (PREDICT_FALSE
2399               (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2400                        sizeof (eth0->src_address)) ||
2401                ethernet_address_cast (arp0->ip4_over_ethernet[0].ethernet)))
2402             {
2403               /* VRRP virtual MAC may be different to SMAC in ARP reply */
2404               if (memcmp (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2405                           sizeof (vrrp_prefix)))
2406                 {
2407                   error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2408                   goto drop;
2409                 }
2410             }
2411           if (PREDICT_FALSE
2412               (ip4_address_is_multicast (&arp0->ip4_over_ethernet[0].ip4)))
2413             {
2414               error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
2415               goto drop;
2416             }
2417
2418           /* Check if anyone want ARP request events for L2 BDs */
2419           {
2420             ethernet_arp_main_t *am = &ethernet_arp_main;
2421             if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2422               vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2423           }
2424
2425           /* lookup BD mac_by_ip4 hash table for MAC entry */
2426           ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2427           bd_index0 = vnet_buffer (p0)->l2.bd_index;
2428           if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2429                              || (last_bd_index == (u16) ~ 0)))
2430             {
2431               last_bd_index = bd_index0;
2432               last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2433             }
2434           macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2435
2436           if (PREDICT_FALSE (!macp0))
2437             goto next_l2_feature;       /* MAC not found */
2438
2439           /* MAC found, send ARP reply -
2440              Convert ARP request packet to ARP reply */
2441           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2442           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2443           arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2444           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2445           clib_memcpy (eth0->dst_address, eth0->src_address, 6);
2446           clib_memcpy (eth0->src_address, macp0, 6);
2447           n_replies_sent += 1;
2448
2449         output_response:
2450           /* For BVI, need to use l2-fwd node to send ARP reply as
2451              l2-output node cannot output packet to BVI properly */
2452           cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2453           if (PREDICT_FALSE (cfg0->bvi))
2454             {
2455               vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2456               vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2457               goto next_l2_feature;
2458             }
2459
2460           /* Send ARP/ND reply back out input interface through l2-output */
2461           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2462           next0 = ARP_TERM_NEXT_L2_OUTPUT;
2463           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2464                                            to_next, n_left_to_next, pi0,
2465                                            next0);
2466           continue;
2467
2468         check_ip6_nd:
2469           /* IP6 ND event notification or solicitation handling to generate
2470              local response instead of flooding */
2471           iph0 = (ip6_header_t *) l3h0;
2472           if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2473                              iph0->protocol == IP_PROTOCOL_ICMP6 &&
2474                              !ip6_address_is_unspecified
2475                              (&iph0->src_address)))
2476             {
2477               sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2478               if (vnet_ip6_nd_term
2479                   (vm, node, p0, eth0, iph0, sw_if_index0,
2480                    vnet_buffer (p0)->l2.bd_index))
2481                 goto output_response;
2482             }
2483
2484         next_l2_feature:
2485           {
2486             next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2487                                           L2INPUT_FEAT_ARP_TERM);
2488             vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2489                                              to_next, n_left_to_next,
2490                                              pi0, next0);
2491             continue;
2492           }
2493
2494         drop:
2495           if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2496               (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2497                arp0->ip4_over_ethernet[1].ip4.as_u32))
2498             {
2499               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2500             }
2501           next0 = ARP_TERM_NEXT_DROP;
2502           p0->error = node->errors[error0];
2503
2504           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2505                                            to_next, n_left_to_next, pi0,
2506                                            next0);
2507         }
2508
2509       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2510     }
2511
2512   vlib_error_count (vm, node->node_index,
2513                     ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2514   return frame->n_vectors;
2515 }
2516
2517 /* *INDENT-OFF* */
2518 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2519   .function = arp_term_l2bd,
2520   .name = "arp-term-l2bd",
2521   .vector_size = sizeof (u32),
2522   .n_errors = ETHERNET_ARP_N_ERROR,
2523   .error_strings = ethernet_arp_error_strings,
2524   .n_next_nodes = ARP_TERM_N_NEXT,
2525   .next_nodes = {
2526     [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2527     [ARP_TERM_NEXT_DROP] = "error-drop",
2528   },
2529   .format_buffer = format_ethernet_arp_header,
2530   .format_trace = format_arp_term_input_trace,
2531 };
2532 /* *INDENT-ON* */
2533
2534 clib_error_t *
2535 arp_term_init (vlib_main_t * vm)
2536 {
2537   // Initialize the feature next-node indexes
2538   feat_bitmap_init_next_nodes (vm,
2539                                arp_term_l2bd_node.index,
2540                                L2INPUT_N_FEAT,
2541                                l2input_get_feat_names (),
2542                                arp_term_next_node_index);
2543   return 0;
2544 }
2545
2546 VLIB_INIT_FUNCTION (arp_term_init);
2547
2548 void
2549 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2550 {
2551   if (e->sw_if_index == sw_if_index)
2552     {
2553       adj_nbr_walk_nh4 (e->sw_if_index,
2554                         &e->ip4_address, arp_mk_complete_walk, e);
2555     }
2556 }
2557
2558 void
2559 ethernet_arp_change_mac (u32 sw_if_index)
2560 {
2561   ethernet_arp_main_t *am = &ethernet_arp_main;
2562   ethernet_arp_ip4_entry_t *e;
2563   adj_index_t ai;
2564
2565   /* *INDENT-OFF* */
2566   pool_foreach (e, am->ip4_entry_pool,
2567   ({
2568     change_arp_mac (sw_if_index, e);
2569   }));
2570   /* *INDENT-ON* */
2571
2572   ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2573
2574   if (ADJ_INDEX_INVALID != ai)
2575     adj_glean_update_rewrite (ai);
2576 }
2577
2578 void
2579 send_ip4_garp (vlib_main_t * vm, u32 sw_if_index)
2580 {
2581   ip4_main_t *i4m = &ip4_main;
2582   ip4_address_t *ip4_addr = ip4_interface_first_address (i4m, sw_if_index, 0);
2583
2584   send_ip4_garp_w_addr (vm, ip4_addr, sw_if_index);
2585 }
2586
2587 void
2588 send_ip4_garp_w_addr (vlib_main_t * vm,
2589                       const ip4_address_t * ip4_addr, u32 sw_if_index)
2590 {
2591   ip4_main_t *i4m = &ip4_main;
2592   vnet_main_t *vnm = vnet_get_main ();
2593   u8 *rewrite, rewrite_len;
2594   vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
2595
2596   if (ip4_addr)
2597     {
2598       clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2599                     format_ip4_address, ip4_addr, sw_if_index);
2600
2601       /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2602          where the interface IP/MAC pair is used for both source and request
2603          MAC/IP pairs in the request */
2604       u32 bi = 0;
2605       ethernet_arp_header_t *h = vlib_packet_template_get_packet
2606         (vm, &i4m->ip4_arp_request_packet_template, &bi);
2607
2608       if (!h)
2609         return;
2610
2611       clib_memcpy (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2612                    sizeof (h->ip4_over_ethernet[0].ethernet));
2613       clib_memcpy (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2614                    sizeof (h->ip4_over_ethernet[1].ethernet));
2615       h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2616       h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2617
2618       /* Setup MAC header with ARP Etype and broadcast DMAC */
2619       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2620       rewrite =
2621         ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
2622                                 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
2623       rewrite_len = vec_len (rewrite);
2624       vlib_buffer_advance (b, -rewrite_len);
2625       ethernet_header_t *e = vlib_buffer_get_current (b);
2626       clib_memcpy (e->dst_address, rewrite, rewrite_len);
2627       vec_free (rewrite);
2628
2629       /* Send GARP packet out the specified interface */
2630       vnet_buffer (b)->sw_if_index[VLIB_RX] =
2631         vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2632       vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2633       u32 *to_next = vlib_frame_vector_args (f);
2634       to_next[0] = bi;
2635       f->n_vectors = 1;
2636       vlib_put_frame_to_node (vm, hi->output_node_index, f);
2637     }
2638 }
2639
2640 /*
2641  * fd.io coding-style-patch-verification: ON
2642  *
2643  * Local Variables:
2644  * eval: (c-set-style "gnu")
2645  * End:
2646  */