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