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_time, vnm->vlib_main, e->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         {
 620           e->time_last_updated = vlib_time_now (vm);
 621           goto check_customers;
 622         }
 623
 624       /* Update time stamp and ethernet address. */
 625       clib_memcpy (e->ethernet_address, a->ethernet,
 626                    sizeof (e->ethernet_address));
 627     }
 628
 629   e->time_last_updated = vlib_time_now (vm);
 630   if (is_static)
 631     e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
 632   else
 633     e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
 634
 635   adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
 636
 637 check_customers:
 638   /* Customer(s) waiting for this address to be resolved? */
 639   p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
 640   if (p)
 641     {
 642       u32 next_index;
 643       next_index = p[0];
 644
 645       while (next_index != (u32) ~ 0)
 646         {
 647           pr = pool_elt_at_index (am->pending_resolutions, next_index);
 648           vlib_process_signal_event (vm, pr->node_index,
 649                                      pr->type_opaque, pr->data);
 650           next_index = pr->next_index;
 651           pool_put (am->pending_resolutions, pr);
 652         }
 653
 654       hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
 655     }
 656
 657   /* Customer(s) requesting ARP event for this address? */
 658   p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
 659   if (p)
 660     {
 661       u32 next_index;
 662       next_index = p[0];
 663
 664       while (next_index != (u32) ~ 0)
 665         {
 666           int (*fp) (u32, u8 *, u32, u32);
 667           int rv = 1;
 668           mc = pool_elt_at_index (am->mac_changes, next_index);
 669           fp = mc->data_callback;
 670
 671           /* Call the user's data callback, return 1 to suppress dup events */
 672           if (fp)
 673             rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
 674
 675           /*
 676            * Signal the resolver process, as long as the user
 677            * says they want to be notified
 678            */
 679           if (rv == 0)
 680             vlib_process_signal_event (vm, mc->node_index,
 681                                        mc->type_opaque, mc->data);
 682           next_index = mc->next_index;
 683         }
 684     }
 685
 686   return 0;
 687 }
 688
 689 void
 690 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
 691                                         void *address_arg,
 692                                         uword node_index,
 693                                         uword type_opaque, uword data)
 694 {
 695   ethernet_arp_main_t *am = &ethernet_arp_main;
 696   ip4_address_t *address = address_arg;
 697   uword *p;
 698   pending_resolution_t *pr;
 699
 700   pool_get (am->pending_resolutions, pr);
 701
 702   pr->next_index = ~0;
 703   pr->node_index = node_index;
 704   pr->type_opaque = type_opaque;
 705   pr->data = data;
 706   pr->data_callback = 0;
 707
 708   p = hash_get (am->pending_resolutions_by_address, address->as_u32);
 709   if (p)
 710     {
 711       /* Insert new resolution at the head of the list */
 712       pr->next_index = p[0];
 713       hash_unset (am->pending_resolutions_by_address, address->as_u32);
 714     }
 715
 716   hash_set (am->pending_resolutions_by_address, address->as_u32,
 717             pr - am->pending_resolutions);
 718 }
 719
 720 int
 721 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
 722                                    void *data_callback,
 723                                    u32 pid,
 724                                    void *address_arg,
 725                                    uword node_index,
 726                                    uword type_opaque, uword data, int is_add)
 727 {
 728   ethernet_arp_main_t *am = &ethernet_arp_main;
 729   ip4_address_t *address = address_arg;
 730
 731   /* Try to find an existing entry */
 732   u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
 733   u32 *p = first;
 734   pending_resolution_t *mc;
 735   while (p && *p != ~0)
 736     {
 737       mc = pool_elt_at_index (am->mac_changes, *p);
 738       if (mc->node_index == node_index && mc->type_opaque == type_opaque
 739           && mc->pid == pid)
 740         break;
 741       p = &mc->next_index;
 742     }
 743
 744   int found = p && *p != ~0;
 745   if (is_add)
 746     {
 747       if (found)
 748         return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 749
 750       pool_get (am->mac_changes, mc);
 751       *mc = (pending_resolution_t)
 752       {
 753       .next_index = ~0,.node_index = node_index,.type_opaque =
 754           type_opaque,.data = data,.data_callback = data_callback,.pid =
 755           pid,};
 756
 757       /* Insert new resolution at the end of the list */
 758       u32 new_idx = mc - am->mac_changes;
 759       if (p)
 760         p[0] = new_idx;
 761       else
 762         hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
 763     }
 764   else
 765     {
 766       if (!found)
 767         return VNET_API_ERROR_NO_SUCH_ENTRY;
 768
 769       /* Clients may need to clean up pool entries, too */
 770       void (*fp) (u32, u8 *) = data_callback;
 771       if (fp)
 772         (*fp) (mc->data, 0 /* no new mac addrs */ );
 773
 774       /* Remove the entry from the list and delete the entry */
 775       *p = mc->next_index;
 776       pool_put (am->mac_changes, mc);
 777
 778       /* Remove from hash if we deleted the last entry */
 779       if (*p == ~0 && p == first)
 780         hash_unset (am->mac_changes_by_address, address->as_u32);
 781     }
 782   return 0;
 783 }
 784
 785 /* Either we drop the packet or we send a reply to the sender. */
 786 typedef enum
 787 {
 788   ARP_INPUT_NEXT_DROP,
 789   ARP_INPUT_NEXT_REPLY_TX,
 790   ARP_INPUT_N_NEXT,
 791 } arp_input_next_t;
 792
 793 #define foreach_ethernet_arp_error                                      \
 794   _ (replies_sent, "ARP replies sent")                                  \
 795   _ (l2_type_not_ethernet, "L2 type not ethernet")                      \
 796   _ (l3_type_not_ip4, "L3 type not IP4")                                \
 797   _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
 798   _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
 799   _ (l3_src_address_is_local, "IP4 source address matches local interface") \
 800   _ (l3_src_address_learned, "ARP request IP4 source address learned")  \
 801   _ (replies_received, "ARP replies received")                          \
 802   _ (opcode_not_request, "ARP opcode not request")                      \
 803   _ (proxy_arp_replies_sent, "Proxy ARP replies sent")                  \
 804   _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
 805   _ (gratuitous_arp, "ARP probe or announcement dropped") \
 806   _ (interface_no_table, "Interface is not mapped to an IP table") \
 807   _ (interface_not_ip_enabled, "Interface is not IP enabled") \
 808
 809 typedef enum
 810 {
 811 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
 812   foreach_ethernet_arp_error
 813 #undef _
 814     ETHERNET_ARP_N_ERROR,
 815 } ethernet_arp_input_error_t;
 816
 817
 818 static void
 819 unset_random_arp_entry (void)
 820 {
 821   ethernet_arp_main_t *am = &ethernet_arp_main;
 822   ethernet_arp_ip4_entry_t *e;
 823   vnet_main_t *vnm = vnet_get_main ();
 824   ethernet_arp_ip4_over_ethernet_address_t delme;
 825   u32 index;
 826
 827   index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
 828   am->arp_delete_rotor = index;
 829
 830   /* Try again from elt 0, could happen if an intfc goes down */
 831   if (index == ~0)
 832     {
 833       index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
 834       am->arp_delete_rotor = index;
 835     }
 836
 837   /* Nothing left in the pool */
 838   if (index == ~0)
 839     return;
 840
 841   e = pool_elt_at_index (am->ip4_entry_pool, index);
 842
 843   clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
 844   delme.ip4.as_u32 = e->ip4_address.as_u32;
 845
 846   vnet_arp_unset_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
 847 }
 848
 849 static int
 850 arp_unnumbered (vlib_buffer_t * p0,
 851                 u32 input_sw_if_index, u32 conn_sw_if_index)
 852 {
 853   vnet_main_t *vnm = vnet_get_main ();
 854   vnet_interface_main_t *vim = &vnm->interface_main;
 855   vnet_sw_interface_t *si;
 856
 857   /* verify that the input interface is unnumbered to the connected.
 858    * the connected interface is the interface on which the subnet is
 859    * configured */
 860   si = &vim->sw_interfaces[input_sw_if_index];
 861
 862   if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
 863         (si->unnumbered_sw_if_index == conn_sw_if_index)))
 864     {
 865       /* the input interface is not unnumbered to the interface on which
 866        * the sub-net is configured that covers the ARP request.
 867        * So this is not the case for unnumbered.. */
 868       return 0;
 869     }
 870
 871   return !0;
 872 }
 873
 874 static u32
 875 arp_learn (vnet_main_t * vnm,
 876            ethernet_arp_main_t * am, u32 sw_if_index, void *addr)
 877 {
 878   if (am->limit_arp_cache_size &&
 879       pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
 880     unset_random_arp_entry ();
 881
 882   vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
 883   return (ETHERNET_ARP_ERROR_l3_src_address_learned);
 884 }
 885
 886 static uword
 887 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 888 {
 889   ethernet_arp_main_t *am = &ethernet_arp_main;
 890   vnet_main_t *vnm = vnet_get_main ();
 891   ip4_main_t *im4 = &ip4_main;
 892   u32 n_left_from, next_index, *from, *to_next;
 893   u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
 894
 895   from = vlib_frame_vector_args (frame);
 896   n_left_from = frame->n_vectors;
 897   next_index = node->cached_next_index;
 898
 899   if (node->flags & VLIB_NODE_FLAG_TRACE)
 900     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 901                                    /* stride */ 1,
 902                                    sizeof (ethernet_arp_input_trace_t));
 903
 904   while (n_left_from > 0)
 905     {
 906       u32 n_left_to_next;
 907
 908       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 909
 910       while (n_left_from > 0 && n_left_to_next > 0)
 911         {
 912           vlib_buffer_t *p0;
 913           vnet_hw_interface_t *hw_if0;
 914           ethernet_arp_header_t *arp0;
 915           ethernet_header_t *eth_rx, *eth_tx;
 916           ip4_address_t *if_addr0, proxy_src;
 917           u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
 918           u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
 919           ethernet_proxy_arp_t *pa;
 920           fib_node_index_t dst_fei, src_fei;
 921           fib_prefix_t pfx0;
 922           fib_entry_flag_t src_flags, dst_flags;
 923           u8 *rewrite0, rewrite0_len;
 924
 925           pi0 = from[0];
 926           to_next[0] = pi0;
 927           from += 1;
 928           to_next += 1;
 929           n_left_from -= 1;
 930           n_left_to_next -= 1;
 931           pa = 0;
 932
 933           p0 = vlib_get_buffer (vm, pi0);
 934           arp0 = vlib_buffer_get_current (p0);
 935           /* Fill in ethernet header. */
 936           eth_rx = ethernet_buffer_get_header (p0);
 937
 938           is_request0 = arp0->opcode
 939             == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
 940
 941           error0 = ETHERNET_ARP_ERROR_replies_sent;
 942
 943           error0 =
 944             (arp0->l2_type !=
 945              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
 946              ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
 947           error0 =
 948             (arp0->l3_type !=
 949              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
 950              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
 951
 952           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
 953
 954           /* not playing the ARP game if the interface is not IPv4 enabled */
 955           error0 =
 956             (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
 957              ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
 958
 959           if (error0)
 960             goto drop2;
 961
 962           /* Check that IP address is local and matches incoming interface. */
 963           fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
 964           if (~0 == fib_index0)
 965             {
 966               error0 = ETHERNET_ARP_ERROR_interface_no_table;
 967               goto drop2;
 968
 969             }
 970           dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
 971                                           &arp0->ip4_over_ethernet[1].ip4,
 972                                           32);
 973           dst_flags = fib_entry_get_flags (dst_fei);
 974
 975           conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
 976
 977           /* Honor unnumbered interface, if any */
 978           is_unnum0 = sw_if_index0 != conn_sw_if_index0;
 979
 980           {
 981             /*
 982              * we're looking for FIB entries that indicate the source
 983              * is attached. There may be more specific non-attached
 984              * routes that match the source, but these do not influence
 985              * whether we respond to an ARP request, i.e. they do not
 986              * influence whether we are the correct way for the sender
 987              * to reach us, they only affect how we reach the sender.
 988              */
 989             fib_entry_t *src_fib_entry;
 990             fib_entry_src_t *src;
 991             fib_source_t source;
 992             fib_prefix_t pfx;
 993             int attached;
 994             int mask;
 995
 996             mask = 32;
 997             attached = 0;
 998
 999             do
1000               {
1001                 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1002                                                 &arp0->
1003                                                 ip4_over_ethernet[0].ip4,
1004                                                 mask);
1005                 src_fib_entry = fib_entry_get (src_fei);
1006
1007                 /*
1008                  * It's possible that the source that provides the
1009                  * flags we need, or the flags we must not have,
1010                  * is not the best source, so check then all.
1011                  */
1012                 /* *INDENT-OFF* */
1013                 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1014                 ({
1015                   src_flags = fib_entry_get_flags_for_source (src_fei, source);
1016
1017                   /* Reject requests/replies with our local interface
1018                      address. */
1019                   if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1020                     {
1021                       error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1022                       /*
1023                        * When VPP has an interface whose address is also
1024                        * applied to a TAP interface on the host, then VPP's
1025                        * TAP interface will be unnumbered  to the 'real'
1026                        * interface and do proxy ARP from the host.
1027                        * The curious aspect of this setup is that ARP requests
1028                        * from the host will come from the VPP's own address.
1029                        * So don't drop immediately here, instead go see if this
1030                        * is a proxy ARP case.
1031                        */
1032                       goto drop1;
1033                     }
1034                   /* A Source must also be local to subnet of matching
1035                    * interface address. */
1036                   if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1037                       (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1038                     {
1039                       attached = 1;
1040                       break;
1041                     }
1042                   /*
1043                    * else
1044                    *  The packet was sent from an address that is not
1045                    *  connected nor attached i.e. it is not from an
1046                    *  address that is covered by a link's sub-net,
1047                    *  nor is it a already learned host resp.
1048                    */
1049                 }));
1050                 /* *INDENT-ON* */
1051
1052                 /*
1053                  * shorter mask lookup for the next iteration.
1054                  */
1055                 fib_entry_get_prefix (src_fei, &pfx);
1056                 mask = pfx.fp_len - 1;
1057
1058                 /*
1059                  * continue until we hit the default route or we find
1060                  * the attached we are looking for. The most likely
1061                  * outcome is we find the attached with the first source
1062                  * on the first lookup.
1063                  */
1064               }
1065             while (!attached &&
1066                    !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1067
1068             if (!attached)
1069               {
1070                 /*
1071                  * the matching route is a not attached, i.e. it was
1072                  * added as a result of routing, rather than interface/ARP
1073                  * configuration. If the matching route is not a host route
1074                  * (i.e. a /32)
1075                  */
1076                 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1077                 goto drop2;
1078               }
1079           }
1080
1081           if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1082             {
1083               error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1084               goto drop1;
1085             }
1086
1087           if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1088             {
1089               /*
1090                * The interface the ARP was received on is not the interface
1091                * on which the covering prefix is configured. Maybe this is a
1092                * case for unnumbered.
1093                */
1094               is_unnum0 = 1;
1095             }
1096
1097           dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1098           fib_entry_get_prefix (dst_fei, &pfx0);
1099           if_addr0 = &pfx0.fp_addr.ip4;
1100
1101           is_vrrp_reply0 =
1102             ((arp0->opcode ==
1103               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1104              &&
1105              (!memcmp
1106               (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1107                sizeof (vrrp_prefix))));
1108
1109           /* Trash ARP packets whose ARP-level source addresses do not
1110              match their L2-frame-level source addresses, unless it's
1111              a reply from a VRRP virtual router */
1112           if (memcmp
1113               (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1114                sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1115             {
1116               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1117               goto drop2;
1118             }
1119
1120           /* Learn or update sender's mapping only for replies to addresses
1121            * that are local to the subnet */
1122           if (arp0->opcode ==
1123               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply) &&
1124               dst_is_local0)
1125             {
1126               error0 = arp_learn (vnm, am, sw_if_index0,
1127                                   &arp0->ip4_over_ethernet[0]);
1128               goto drop1;
1129             }
1130           else if (arp0->opcode ==
1131                    clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1132                    (dst_is_local0 == 0))
1133             {
1134               goto drop1;
1135             }
1136
1137         send_reply:
1138           /* Send a reply.
1139              An adjacency to the sender is not always present,
1140              so we use the interface to build us a rewrite string
1141              which will contain all the necessary tags. */
1142           rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1143                                              VNET_LINK_ARP,
1144                                              eth_rx->src_address);
1145           rewrite0_len = vec_len (rewrite0);
1146
1147           /* Figure out how much to rewind current data from adjacency. */
1148           vlib_buffer_advance (p0, -rewrite0_len);
1149           eth_tx = vlib_buffer_get_current (p0);
1150
1151           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1152           hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1153
1154           /* Send reply back through input interface */
1155           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1156           next0 = ARP_INPUT_NEXT_REPLY_TX;
1157
1158           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1159
1160           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1161
1162           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1163                        hw_if0->hw_address, 6);
1164           clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1165             if_addr0->data_u32;
1166
1167           /* Hardware must be ethernet-like. */
1168           ASSERT (vec_len (hw_if0->hw_address) == 6);
1169
1170           /* the rx nd tx ethernet headers wil overlap in the case
1171            * when we received a tagged VLAN=0 packet, but we are sending
1172            * back untagged */
1173           clib_memcpy (eth_tx, rewrite0, vec_len (rewrite0));
1174           vec_free (rewrite0);
1175
1176           if (NULL == pa)
1177             {
1178               if (is_unnum0)
1179                 {
1180                   if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1181                     goto drop2;
1182                 }
1183             }
1184
1185           /* We are going to reply to this request, so, in the absence of
1186              errors, learn the sender */
1187           if (!error0)
1188             error0 = arp_learn (vnm, am, sw_if_index0,
1189                                 &arp0->ip4_over_ethernet[1]);
1190
1191           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1192                                            n_left_to_next, pi0, next0);
1193
1194           n_replies_sent += 1;
1195           continue;
1196
1197         drop1:
1198           if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
1199               (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1200                arp0->ip4_over_ethernet[1].ip4.as_u32))
1201             {
1202               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1203               goto drop2;
1204             }
1205           /* See if proxy arp is configured for the address */
1206           if (is_request0)
1207             {
1208               vnet_sw_interface_t *si;
1209               u32 this_addr = clib_net_to_host_u32
1210                 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1211               u32 fib_index0;
1212
1213               si = vnet_get_sw_interface (vnm, sw_if_index0);
1214
1215               if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1216                 goto drop2;
1217
1218               fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1219                                     sw_if_index0);
1220
1221               vec_foreach (pa, am->proxy_arps)
1222               {
1223                 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr);
1224                 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr);
1225
1226                 /* an ARP request hit in the proxy-arp table? */
1227                 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1228                     (fib_index0 == pa->fib_index))
1229                   {
1230                     proxy_src.as_u32 =
1231                       arp0->ip4_over_ethernet[1].ip4.data_u32;
1232
1233                     /*
1234                      * change the interface address to the proxied
1235                      */
1236                     if_addr0 = &proxy_src;
1237                     is_unnum0 = 0;
1238                     n_proxy_arp_replies_sent++;
1239                     goto send_reply;
1240                   }
1241               }
1242             }
1243
1244         drop2:
1245
1246           next0 = ARP_INPUT_NEXT_DROP;
1247           p0->error = node->errors[error0];
1248
1249           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1250                                            n_left_to_next, pi0, next0);
1251         }
1252
1253       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1254     }
1255
1256   vlib_error_count (vm, node->node_index,
1257                     ETHERNET_ARP_ERROR_replies_sent,
1258                     n_replies_sent - n_proxy_arp_replies_sent);
1259
1260   vlib_error_count (vm, node->node_index,
1261                     ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1262                     n_proxy_arp_replies_sent);
1263   return frame->n_vectors;
1264 }
1265
1266 static char *ethernet_arp_error_strings[] = {
1267 #define _(sym,string) string,
1268   foreach_ethernet_arp_error
1269 #undef _
1270 };
1271
1272 /* *INDENT-OFF* */
1273 VLIB_REGISTER_NODE (arp_input_node, static) =
1274 {
1275   .function = arp_input,
1276   .name = "arp-input",
1277   .vector_size = sizeof (u32),
1278   .n_errors = ETHERNET_ARP_N_ERROR,
1279   .error_strings = ethernet_arp_error_strings,
1280   .n_next_nodes = ARP_INPUT_N_NEXT,
1281   .next_nodes = {
1282     [ARP_INPUT_NEXT_DROP] = "error-drop",
1283     [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1284   },
1285   .format_buffer = format_ethernet_arp_header,
1286   .format_trace = format_ethernet_arp_input_trace,
1287 };
1288 /* *INDENT-ON* */
1289
1290 static int
1291 ip4_arp_entry_sort (void *a1, void *a2)
1292 {
1293   ethernet_arp_ip4_entry_t *e1 = a1;
1294   ethernet_arp_ip4_entry_t *e2 = a2;
1295
1296   int cmp;
1297   vnet_main_t *vnm = vnet_get_main ();
1298
1299   cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1300   if (!cmp)
1301     cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1302   return cmp;
1303 }
1304
1305 ethernet_arp_ip4_entry_t *
1306 ip4_neighbors_pool (void)
1307 {
1308   ethernet_arp_main_t *am = &ethernet_arp_main;
1309   return am->ip4_entry_pool;
1310 }
1311
1312 ethernet_arp_ip4_entry_t *
1313 ip4_neighbor_entries (u32 sw_if_index)
1314 {
1315   ethernet_arp_main_t *am = &ethernet_arp_main;
1316   ethernet_arp_ip4_entry_t *n, *ns = 0;
1317
1318   /* *INDENT-OFF* */
1319   pool_foreach (n, am->ip4_entry_pool, ({
1320     if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1321       continue;
1322     vec_add1 (ns, n[0]);
1323   }));
1324   /* *INDENT-ON* */
1325
1326   if (ns)
1327     vec_sort_with_function (ns, ip4_arp_entry_sort);
1328   return ns;
1329 }
1330
1331 static clib_error_t *
1332 show_ip4_arp (vlib_main_t * vm,
1333               unformat_input_t * input, vlib_cli_command_t * cmd)
1334 {
1335   vnet_main_t *vnm = vnet_get_main ();
1336   ethernet_arp_main_t *am = &ethernet_arp_main;
1337   ethernet_arp_ip4_entry_t *e, *es;
1338   ethernet_proxy_arp_t *pa;
1339   clib_error_t *error = 0;
1340   u32 sw_if_index;
1341
1342   /* Filter entries by interface if given. */
1343   sw_if_index = ~0;
1344   (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1345
1346   es = ip4_neighbor_entries (sw_if_index);
1347   if (es)
1348     {
1349       vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1350       vec_foreach (e, es)
1351       {
1352         vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1353       }
1354       vec_free (es);
1355     }
1356
1357   if (vec_len (am->proxy_arps))
1358     {
1359       vlib_cli_output (vm, "Proxy arps enabled for:");
1360       vec_foreach (pa, am->proxy_arps)
1361       {
1362         vlib_cli_output (vm, "Fib_index %d   %U - %U ",
1363                          pa->fib_index,
1364                          format_ip4_address, &pa->lo_addr,
1365                          format_ip4_address, &pa->hi_addr);
1366       }
1367     }
1368
1369   return error;
1370 }
1371
1372 /*?
1373  * Display all the IPv4 ARP entries.
1374  *
1375  * @cliexpar
1376  * Example of how to display the IPv4 ARP table:
1377  * @cliexstart{show ip arp}
1378  *    Time      FIB        IP4       Flags      Ethernet              Interface
1379  *    346.3028   0       6.1.1.3            de:ad:be:ef:ba:be   GigabitEthernet2/0/0
1380  *   3077.4271   0       6.1.1.4       S    de:ad:be:ef:ff:ff   GigabitEthernet2/0/0
1381  *   2998.6409   1       6.2.2.3            de:ad:be:ef:00:01   GigabitEthernet2/0/0
1382  * Proxy arps enabled for:
1383  * Fib_index 0   6.0.0.1 - 6.0.0.11
1384  * @cliexend
1385  ?*/
1386 /* *INDENT-OFF* */
1387 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1388   .path = "show ip arp",
1389   .function = show_ip4_arp,
1390   .short_help = "show ip arp",
1391 };
1392 /* *INDENT-ON* */
1393
1394 typedef struct
1395 {
1396   pg_edit_t l2_type, l3_type;
1397   pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1398   pg_edit_t opcode;
1399   struct
1400   {
1401     pg_edit_t ethernet;
1402     pg_edit_t ip4;
1403   } ip4_over_ethernet[2];
1404 } pg_ethernet_arp_header_t;
1405
1406 static inline void
1407 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1408 {
1409   /* Initialize fields that are not bit fields in the IP header. */
1410 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1411   _(l2_type);
1412   _(l3_type);
1413   _(n_l2_address_bytes);
1414   _(n_l3_address_bytes);
1415   _(opcode);
1416   _(ip4_over_ethernet[0].ethernet);
1417   _(ip4_over_ethernet[0].ip4);
1418   _(ip4_over_ethernet[1].ethernet);
1419   _(ip4_over_ethernet[1].ip4);
1420 #undef _
1421 }
1422
1423 uword
1424 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1425 {
1426   pg_stream_t *s = va_arg (*args, pg_stream_t *);
1427   pg_ethernet_arp_header_t *p;
1428   u32 group_index;
1429
1430   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1431                             &group_index);
1432   pg_ethernet_arp_header_init (p);
1433
1434   /* Defaults. */
1435   pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1436   pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1437   pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1438   pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1439
1440   if (!unformat (input, "%U: %U/%U -> %U/%U",
1441                  unformat_pg_edit,
1442                  unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1443                  unformat_pg_edit,
1444                  unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1445                  unformat_pg_edit,
1446                  unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1447                  unformat_pg_edit,
1448                  unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1449                  unformat_pg_edit,
1450                  unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1451     {
1452       /* Free up any edits we may have added. */
1453       pg_free_edit_group (s);
1454       return 0;
1455     }
1456   return 1;
1457 }
1458
1459 clib_error_t *
1460 ip4_set_arp_limit (u32 arp_limit)
1461 {
1462   ethernet_arp_main_t *am = &ethernet_arp_main;
1463
1464   am->limit_arp_cache_size = arp_limit;
1465   return 0;
1466 }
1467
1468 /**
1469  * @brief Control Plane hook to remove an ARP entry
1470  */
1471 int
1472 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1473                                   u32 sw_if_index, void *a_arg)
1474 {
1475   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1476   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1477
1478   args.sw_if_index = sw_if_index;
1479   args.flags = ETHERNET_ARP_ARGS_REMOVE;
1480   clib_memcpy (&args.a, a, sizeof (*a));
1481
1482   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1483                                (u8 *) & args, sizeof (args));
1484   return 0;
1485 }
1486
1487 /**
1488  * @brief Internally generated event to flush the ARP cache on an
1489  * interface state change event.
1490  * A flush will remove dynamic ARP entries, and for statics remove the MAC
1491  * address from the corresponding adjacencies.
1492  */
1493 static int
1494 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1495                                   u32 sw_if_index, void *a_arg)
1496 {
1497   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1498   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1499
1500   args.sw_if_index = sw_if_index;
1501   args.flags = ETHERNET_ARP_ARGS_FLUSH;
1502   clib_memcpy (&args.a, a, sizeof (*a));
1503
1504   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1505                                (u8 *) & args, sizeof (args));
1506   return 0;
1507 }
1508
1509 /**
1510  * @brief Internally generated event to populate the ARP cache on an
1511  * interface state change event.
1512  * For static entries this will re-source the adjacencies.
1513  *
1514  * @param sw_if_index The interface on which the ARP entires are acted
1515  */
1516 static int
1517 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1518                                      u32 sw_if_index, void *a_arg)
1519 {
1520   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1521   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1522
1523   args.sw_if_index = sw_if_index;
1524   args.flags = ETHERNET_ARP_ARGS_POPULATE;
1525   clib_memcpy (&args.a, a, sizeof (*a));
1526
1527   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1528                                (u8 *) & args, sizeof (args));
1529   return 0;
1530 }
1531
1532 /**
1533  * @brief publish wildcard arp event
1534  * @param sw_if_index The interface on which the ARP entires are acted
1535  */
1536 static int
1537 vnet_arp_wc_publish (u32 sw_if_index, void *a_arg)
1538 {
1539   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1540   vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1541     .flags = ETHERNET_ARP_ARGS_WC_PUB,
1542     .sw_if_index = sw_if_index,
1543     .a = *a
1544   };
1545
1546   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1547                                (u8 *) & args, sizeof (args));
1548   return 0;
1549 }
1550
1551 static void
1552 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1553                               vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1554                               args)
1555 {
1556   vlib_main_t *vm = vlib_get_main ();
1557   ethernet_arp_main_t *am = &ethernet_arp_main;
1558   uword ni = am->wc_ip4_arp_publisher_node;
1559   uword et = am->wc_ip4_arp_publisher_et;
1560
1561   if (ni == (uword) ~ 0)
1562     return;
1563   wc_arp_report_t *r =
1564     vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1565   r->ip4 = args->a.ip4.as_u32;
1566   r->sw_if_index = args->sw_if_index;
1567   memcpy (r->mac, args->a.ethernet, sizeof r->mac);
1568 }
1569
1570 void
1571 wc_arp_set_publisher_node (uword node_index, uword event_type)
1572 {
1573   ethernet_arp_main_t *am = &ethernet_arp_main;
1574   am->wc_ip4_arp_publisher_node = node_index;
1575   am->wc_ip4_arp_publisher_et = event_type;
1576 }
1577
1578 /*
1579  * arp_add_del_interface_address
1580  *
1581  * callback when an interface address is added or deleted
1582  */
1583 static void
1584 arp_add_del_interface_address (ip4_main_t * im,
1585                                uword opaque,
1586                                u32 sw_if_index,
1587                                ip4_address_t * address,
1588                                u32 address_length,
1589                                u32 if_address_index, u32 is_del)
1590 {
1591   /*
1592    * Flush the ARP cache of all entries covered by the address
1593    * that is being removed.
1594    */
1595   ethernet_arp_main_t *am = &ethernet_arp_main;
1596   ethernet_arp_ip4_entry_t *e;
1597
1598   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1599     return;
1600
1601   if (is_del)
1602     {
1603       ethernet_arp_interface_t *eai;
1604       u32 i, *to_delete = 0;
1605       hash_pair_t *pair;
1606
1607       eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1608
1609       /* *INDENT-OFF* */
1610       hash_foreach_pair (pair, eai->arp_entries,
1611       ({
1612         e = pool_elt_at_index(am->ip4_entry_pool,
1613                               pair->value[0]);
1614         if (ip4_destination_matches_route (im, &e->ip4_address,
1615                                            address, address_length))
1616           {
1617             vec_add1 (to_delete, e - am->ip4_entry_pool);
1618           }
1619       }));
1620       /* *INDENT-ON* */
1621
1622       for (i = 0; i < vec_len (to_delete); i++)
1623         {
1624           ethernet_arp_ip4_over_ethernet_address_t delme;
1625           e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1626
1627           clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1628           delme.ip4.as_u32 = e->ip4_address.as_u32;
1629
1630           vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1631                                             e->sw_if_index, &delme);
1632         }
1633
1634       vec_free (to_delete);
1635     }
1636 }
1637
1638 void
1639 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
1640 {
1641   if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
1642     {
1643       fib_prefix_t pfx = {
1644         .fp_len = 32,
1645         .fp_proto = FIB_PROTOCOL_IP4,
1646         .fp_addr.ip4 = e->ip4_address,
1647       };
1648       u32 fib_index;
1649
1650       fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
1651
1652       fib_table_entry_path_remove (fib_index, &pfx,
1653                                    FIB_SOURCE_ADJ,
1654                                    DPO_PROTO_IP4,
1655                                    &pfx.fp_addr,
1656                                    e->sw_if_index, ~0, 1,
1657                                    FIB_ROUTE_PATH_FLAG_NONE);
1658       fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
1659     }
1660 }
1661
1662 static void
1663 arp_table_bind (ip4_main_t * im,
1664                 uword opaque,
1665                 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
1666 {
1667   ethernet_arp_main_t *am = &ethernet_arp_main;
1668   ethernet_arp_interface_t *eai;
1669   ethernet_arp_ip4_entry_t *e;
1670   hash_pair_t *pair;
1671
1672   /*
1673    * the IP table that the interface is bound to has changed.
1674    * reinstall all the adj fibs.
1675    */
1676
1677   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1678     return;
1679
1680   eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1681
1682   /* *INDENT-OFF* */
1683   hash_foreach_pair (pair, eai->arp_entries,
1684   ({
1685     e = pool_elt_at_index(am->ip4_entry_pool,
1686                           pair->value[0]);
1687     /*
1688      * remove the adj-fib from the old table and add to the new
1689      */
1690     arp_adj_fib_remove(e, old_fib_index);
1691     arp_adj_fib_add(e, new_fib_index);
1692   }));
1693   /* *INDENT-ON* */
1694
1695 }
1696
1697 static clib_error_t *
1698 ethernet_arp_init (vlib_main_t * vm)
1699 {
1700   ethernet_arp_main_t *am = &ethernet_arp_main;
1701   ip4_main_t *im = &ip4_main;
1702   clib_error_t *error;
1703   pg_node_t *pn;
1704
1705   if ((error = vlib_call_init_function (vm, ethernet_init)))
1706     return error;
1707
1708   ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1709
1710   pn = pg_get_node (arp_input_node.index);
1711   pn->unformat_edit = unformat_pg_arp_header;
1712
1713   am->opcode_by_name = hash_create_string (0, sizeof (uword));
1714 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1715   foreach_ethernet_arp_opcode;
1716 #undef _
1717
1718   /* $$$ configurable */
1719   am->limit_arp_cache_size = 50000;
1720
1721   am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1722   am->mac_changes_by_address = hash_create (0, sizeof (uword));
1723   am->wc_ip4_arp_publisher_node = (uword) ~ 0;
1724
1725   /* don't trace ARP error packets */
1726   {
1727     vlib_node_runtime_t *rt =
1728       vlib_node_get_runtime (vm, arp_input_node.index);
1729
1730 #define _(a,b)                                  \
1731     vnet_pcap_drop_trace_filter_add_del         \
1732         (rt->errors[ETHERNET_ARP_ERROR_##a],    \
1733          1 /* is_add */);
1734     foreach_ethernet_arp_error
1735 #undef _
1736   }
1737
1738   ip4_add_del_interface_address_callback_t cb;
1739   cb.function = arp_add_del_interface_address;
1740   cb.function_opaque = 0;
1741   vec_add1 (im->add_del_interface_address_callbacks, cb);
1742
1743   ip4_table_bind_callback_t cbt;
1744   cbt.function = arp_table_bind;
1745   cbt.function_opaque = 0;
1746   vec_add1 (im->table_bind_callbacks, cbt);
1747
1748   return 0;
1749 }
1750
1751 VLIB_INIT_FUNCTION (ethernet_arp_init);
1752
1753 static void
1754 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1755 {
1756   ethernet_arp_main_t *am = &ethernet_arp_main;
1757
1758   arp_adj_fib_remove (e,
1759                       ip4_fib_table_get_index_for_sw_if_index
1760                       (e->sw_if_index));
1761   hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1762   pool_put (am->ip4_entry_pool, e);
1763 }
1764
1765 static inline int
1766 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1767                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1768                                            * args)
1769 {
1770   ethernet_arp_main_t *am = &ethernet_arp_main;
1771   ethernet_arp_ip4_entry_t *e;
1772   ethernet_arp_interface_t *eai;
1773
1774   if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1775     return 0;
1776
1777   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1778
1779   e = arp_entry_find (eai, &args->a.ip4);
1780
1781   if (NULL != e)
1782     {
1783       arp_entry_free (eai, e);
1784
1785       adj_nbr_walk_nh4 (e->sw_if_index,
1786                         &e->ip4_address, arp_mk_incomplete_walk, NULL);
1787     }
1788
1789   return 0;
1790 }
1791
1792 static int
1793 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1794                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1795                                            * args)
1796 {
1797   ethernet_arp_main_t *am = &ethernet_arp_main;
1798   ethernet_arp_ip4_entry_t *e;
1799   ethernet_arp_interface_t *eai;
1800
1801   if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1802     return 0;
1803
1804   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1805
1806   e = arp_entry_find (eai, &args->a.ip4);
1807
1808   if (NULL != e)
1809     {
1810       adj_nbr_walk_nh4 (e->sw_if_index,
1811                         &e->ip4_address, arp_mk_incomplete_walk, e);
1812
1813       /*
1814        * The difference between flush and unset, is that an unset
1815        * means delete for static and dynamic entries. A flush
1816        * means delete only for dynamic. Flushing is what the DP
1817        * does in response to interface events. unset is only done
1818        * by the control plane.
1819        */
1820       if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
1821         {
1822           e->flags &= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
1823         }
1824       else if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1825         {
1826           arp_entry_free (eai, e);
1827         }
1828     }
1829   return (0);
1830 }
1831
1832 static int
1833 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1834                                               vnet_arp_set_ip4_over_ethernet_rpc_args_t
1835                                               * args)
1836 {
1837   ethernet_arp_main_t *am = &ethernet_arp_main;
1838   ethernet_arp_ip4_entry_t *e;
1839   ethernet_arp_interface_t *eai;
1840
1841   vec_validate (am->ethernet_arp_by_sw_if_index, args->sw_if_index);
1842   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1843
1844   e = arp_entry_find (eai, &args->a.ip4);
1845
1846   if (NULL != e)
1847     {
1848       adj_nbr_walk_nh4 (e->sw_if_index,
1849                         &e->ip4_address, arp_mk_complete_walk, e);
1850     }
1851   return (0);
1852 }
1853
1854 static void
1855 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1856                                     * a)
1857 {
1858   vnet_main_t *vm = vnet_get_main ();
1859   ASSERT (vlib_get_thread_index () == 0);
1860
1861   if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1862     vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1863   else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1864     vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1865   else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1866     vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1867   else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
1868     vnet_arp_wc_publish_internal (vm, a);
1869   else
1870     vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1871 }
1872
1873 /**
1874  * @brief Invoked when the interface's admin state changes
1875  */
1876 static clib_error_t *
1877 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1878                                    u32 sw_if_index, u32 flags)
1879 {
1880   ethernet_arp_main_t *am = &ethernet_arp_main;
1881   ethernet_arp_ip4_entry_t *e;
1882   u32 i, *to_delete = 0;
1883
1884   /* *INDENT-OFF* */
1885   pool_foreach (e, am->ip4_entry_pool,
1886   ({
1887     if (e->sw_if_index == sw_if_index)
1888       vec_add1 (to_delete,
1889                 e - am->ip4_entry_pool);
1890   }));
1891   /* *INDENT-ON* */
1892
1893   for (i = 0; i < vec_len (to_delete); i++)
1894     {
1895       ethernet_arp_ip4_over_ethernet_address_t delme;
1896       e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1897
1898       clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1899       delme.ip4.as_u32 = e->ip4_address.as_u32;
1900
1901       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1902         {
1903           vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1904         }
1905       else
1906         {
1907           vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1908         }
1909
1910     }
1911   vec_free (to_delete);
1912
1913   return 0;
1914 }
1915
1916 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1917
1918 static void
1919 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1920 {
1921   u8 old;
1922   int i;
1923
1924   for (i = 3; i >= 0; i--)
1925     {
1926       old = a->ip4.as_u8[i];
1927       a->ip4.as_u8[i] += 1;
1928       if (old < a->ip4.as_u8[i])
1929         break;
1930     }
1931
1932   for (i = 5; i >= 0; i--)
1933     {
1934       old = a->ethernet[i];
1935       a->ethernet[i] += 1;
1936       if (old < a->ethernet[i])
1937         break;
1938     }
1939 }
1940
1941 int
1942 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1943                                 u32 sw_if_index, void *a_arg,
1944                                 int is_static, int is_no_fib_entry)
1945 {
1946   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1947   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1948
1949   args.sw_if_index = sw_if_index;
1950   args.is_static = is_static;
1951   args.is_no_fib_entry = is_no_fib_entry;
1952   args.flags = 0;
1953   clib_memcpy (&args.a, a, sizeof (*a));
1954
1955   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1956                                (u8 *) & args, sizeof (args));
1957   return 0;
1958 }
1959
1960 int
1961 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1962                         ip4_address_t * hi_addr, u32 fib_index, int is_del)
1963 {
1964   ethernet_arp_main_t *am = &ethernet_arp_main;
1965   ethernet_proxy_arp_t *pa;
1966   u32 found_at_index = ~0;
1967
1968   vec_foreach (pa, am->proxy_arps)
1969   {
1970     if (pa->lo_addr == lo_addr->as_u32
1971         && pa->hi_addr == hi_addr->as_u32 && pa->fib_index == fib_index)
1972       {
1973         found_at_index = pa - am->proxy_arps;
1974         break;
1975       }
1976   }
1977
1978   if (found_at_index != ~0)
1979     {
1980       /* Delete, otherwise it's already in the table */
1981       if (is_del)
1982         vec_delete (am->proxy_arps, 1, found_at_index);
1983       return 0;
1984     }
1985   /* delete, no such entry */
1986   if (is_del)
1987     return VNET_API_ERROR_NO_SUCH_ENTRY;
1988
1989   /* add, not in table */
1990   vec_add2 (am->proxy_arps, pa, 1);
1991   pa->lo_addr = lo_addr->as_u32;
1992   pa->hi_addr = hi_addr->as_u32;
1993   pa->fib_index = fib_index;
1994   return 0;
1995 }
1996
1997 /*
1998  * Remove any proxy arp entries asdociated with the
1999  * specificed fib.
2000  */
2001 int
2002 vnet_proxy_arp_fib_reset (u32 fib_id)
2003 {
2004   ethernet_arp_main_t *am = &ethernet_arp_main;
2005   ethernet_proxy_arp_t *pa;
2006   u32 *entries_to_delete = 0;
2007   u32 fib_index;
2008   int i;
2009
2010   fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2011   if (~0 == fib_index)
2012     return VNET_API_ERROR_NO_SUCH_ENTRY;
2013
2014   vec_foreach (pa, am->proxy_arps)
2015   {
2016     if (pa->fib_index == fib_index)
2017       {
2018         vec_add1 (entries_to_delete, pa - am->proxy_arps);
2019       }
2020   }
2021
2022   for (i = 0; i < vec_len (entries_to_delete); i++)
2023     {
2024       vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2025     }
2026
2027   vec_free (entries_to_delete);
2028
2029   return 0;
2030 }
2031
2032 static clib_error_t *
2033 ip_arp_add_del_command_fn (vlib_main_t * vm,
2034                            unformat_input_t * input, vlib_cli_command_t * cmd)
2035 {
2036   vnet_main_t *vnm = vnet_get_main ();
2037   u32 sw_if_index;
2038   ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2039   int addr_valid = 0;
2040   int is_del = 0;
2041   int count = 1;
2042   u32 fib_index = 0;
2043   u32 fib_id;
2044   int is_static = 0;
2045   int is_no_fib_entry = 0;
2046   int is_proxy = 0;
2047
2048   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2049     {
2050       /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2051       if (unformat (input, "%U %U %U",
2052                     unformat_vnet_sw_interface, vnm, &sw_if_index,
2053                     unformat_ip4_address, &addr.ip4,
2054                     unformat_ethernet_address, &addr.ethernet))
2055         addr_valid = 1;
2056
2057       else if (unformat (input, "delete") || unformat (input, "del"))
2058         is_del = 1;
2059
2060       else if (unformat (input, "static"))
2061         is_static = 1;
2062
2063       else if (unformat (input, "no-fib-entry"))
2064         is_no_fib_entry = 1;
2065
2066       else if (unformat (input, "count %d", &count))
2067         ;
2068
2069       else if (unformat (input, "fib-id %d", &fib_id))
2070         {
2071           fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2072
2073           if (~0 == fib_index)
2074             return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2075         }
2076
2077       else if (unformat (input, "proxy %U - %U",
2078                          unformat_ip4_address, &lo_addr.ip4,
2079                          unformat_ip4_address, &hi_addr.ip4))
2080         is_proxy = 1;
2081       else
2082         break;
2083     }
2084
2085   if (is_proxy)
2086     {
2087       (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2088                                      fib_index, is_del);
2089       return 0;
2090     }
2091
2092   if (addr_valid)
2093     {
2094       int i;
2095
2096       for (i = 0; i < count; i++)
2097         {
2098           if (is_del == 0)
2099             {
2100               uword event_type, *event_data = 0;
2101
2102               /* Park the debug CLI until the arp entry is installed */
2103               vnet_register_ip4_arp_resolution_event
2104                 (vnm, &addr.ip4, vlib_current_process (vm),
2105                  1 /* type */ , 0 /* data */ );
2106
2107               vnet_arp_set_ip4_over_ethernet
2108                 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
2109
2110               vlib_process_wait_for_event (vm);
2111               event_type = vlib_process_get_events (vm, &event_data);
2112               vec_reset_length (event_data);
2113               if (event_type != 1)
2114                 clib_warning ("event type %d unexpected", event_type);
2115             }
2116           else
2117             vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2118
2119           increment_ip4_and_mac_address (&addr);
2120         }
2121     }
2122   else
2123     {
2124       return clib_error_return (0, "unknown input `%U'",
2125                                 format_unformat_error, input);
2126     }
2127
2128   return 0;
2129 }
2130
2131 /* *INDENT-OFF* */
2132 /*?
2133  * Add or delete IPv4 ARP cache entries.
2134  *
2135  * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2136  * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2137  * any order and combination.
2138  *
2139  * @cliexpar
2140  * @parblock
2141  * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2142  * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2143  * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2144  * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2145  *
2146  * To add or delete an IPv4 ARP cache entry to or from a specific fib
2147  * table:
2148  * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2149  * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2150  *
2151  * Add or delete IPv4 static ARP cache entries as follows:
2152  * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2153  * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2154  *
2155  * For testing / debugging purposes, the 'set ip arp' command can add or
2156  * delete multiple entries. Supply the 'count N' parameter:
2157  * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2158  * @endparblock
2159  ?*/
2160 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2161   .path = "set ip arp",
2162   .short_help =
2163   "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2164   .function = ip_arp_add_del_command_fn,
2165 };
2166 /* *INDENT-ON* */
2167
2168 static clib_error_t *
2169 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2170                               unformat_input_t *
2171                               input, vlib_cli_command_t * cmd)
2172 {
2173   vnet_main_t *vnm = vnet_get_main ();
2174   u32 sw_if_index;
2175   vnet_sw_interface_t *si;
2176   int enable = 0;
2177   int intfc_set = 0;
2178
2179   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2180     {
2181       if (unformat (input, "%U", unformat_vnet_sw_interface,
2182                     vnm, &sw_if_index))
2183         intfc_set = 1;
2184       else if (unformat (input, "enable") || unformat (input, "on"))
2185         enable = 1;
2186       else if (unformat (input, "disable") || unformat (input, "off"))
2187         enable = 0;
2188       else
2189         break;
2190     }
2191
2192   if (intfc_set == 0)
2193     return clib_error_return (0, "unknown input '%U'",
2194                               format_unformat_error, input);
2195
2196   si = vnet_get_sw_interface (vnm, sw_if_index);
2197   ASSERT (si);
2198   if (enable)
2199     si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2200   else
2201     si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2202
2203   return 0;
2204 }
2205
2206 /* *INDENT-OFF* */
2207 /*?
2208  * Enable proxy-arp on an interface. The vpp stack will answer ARP
2209  * requests for the indicated address range. Multiple proxy-arp
2210  * ranges may be provisioned.
2211  *
2212  * @note Proxy ARP as a technology is infamous for blackholing traffic.
2213  * Also, the underlying implementation has not been performance-tuned.
2214  * Avoid creating an unnecessarily large set of ranges.
2215  *
2216  * @cliexpar
2217  * To enable proxy arp on a range of addresses, use:
2218  * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2219  * Append 'del' to delete a range of proxy ARP addresses:
2220  * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2221  * You must then specifically enable proxy arp on individual interfaces:
2222  * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2223  * To disable proxy arp on an individual interface:
2224  * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2225  ?*/
2226 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2227   .path = "set interface proxy-arp",
2228   .short_help =
2229   "set interface proxy-arp <intfc> [enable|disable]",
2230   .function = set_int_proxy_arp_command_fn,
2231 };
2232 /* *INDENT-ON* */
2233
2234
2235 /*
2236  * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2237  * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2238  */
2239 typedef enum
2240 {
2241   ARP_TERM_NEXT_L2_OUTPUT,
2242   ARP_TERM_NEXT_DROP,
2243   ARP_TERM_N_NEXT,
2244 } arp_term_next_t;
2245
2246 u32 arp_term_next_node_index[32];
2247
2248 static uword
2249 arp_term_l2bd (vlib_main_t * vm,
2250                vlib_node_runtime_t * node, vlib_frame_t * frame)
2251 {
2252   l2input_main_t *l2im = &l2input_main;
2253   u32 n_left_from, next_index, *from, *to_next;
2254   u32 n_replies_sent = 0;
2255   u16 last_bd_index = ~0;
2256   l2_bridge_domain_t *last_bd_config = 0;
2257   l2_input_config_t *cfg0;
2258
2259   from = vlib_frame_vector_args (frame);
2260   n_left_from = frame->n_vectors;
2261   next_index = node->cached_next_index;
2262
2263   while (n_left_from > 0)
2264     {
2265       u32 n_left_to_next;
2266
2267       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2268
2269       while (n_left_from > 0 && n_left_to_next > 0)
2270         {
2271           vlib_buffer_t *p0;
2272           ethernet_header_t *eth0;
2273           ethernet_arp_header_t *arp0;
2274           ip6_header_t *iph0;
2275           u8 *l3h0;
2276           u32 pi0, error0, next0, sw_if_index0;
2277           u16 ethertype0;
2278           u16 bd_index0;
2279           u32 ip0;
2280           u8 *macp0;
2281           u8 is_vrrp_reply0;
2282
2283           pi0 = from[0];
2284           to_next[0] = pi0;
2285           from += 1;
2286           to_next += 1;
2287           n_left_from -= 1;
2288           n_left_to_next -= 1;
2289
2290           p0 = vlib_get_buffer (vm, pi0);
2291           // Terminate only local (SHG == 0) ARP
2292           if (vnet_buffer (p0)->l2.shg != 0)
2293             goto next_l2_feature;
2294
2295           eth0 = vlib_buffer_get_current (p0);
2296           l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2297           ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2298           arp0 = (ethernet_arp_header_t *) l3h0;
2299
2300           if (PREDICT_FALSE ((ethertype0 != ETHERNET_TYPE_ARP) ||
2301                              (arp0->opcode !=
2302                               clib_host_to_net_u16
2303                               (ETHERNET_ARP_OPCODE_request))))
2304             goto check_ip6_nd;
2305
2306           /* Must be ARP request packet here */
2307           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2308                              (p0->flags & VLIB_BUFFER_IS_TRACED)))
2309             {
2310               u8 *t0 = vlib_add_trace (vm, node, p0,
2311                                        sizeof (ethernet_arp_input_trace_t));
2312               clib_memcpy (t0, l3h0, sizeof (ethernet_arp_input_trace_t));
2313             }
2314
2315           error0 = ETHERNET_ARP_ERROR_replies_sent;
2316           error0 =
2317             (arp0->l2_type !=
2318              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2319              ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2320           error0 =
2321             (arp0->l3_type !=
2322              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2323              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2324
2325           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2326
2327           if (error0)
2328             goto drop;
2329
2330           is_vrrp_reply0 =
2331             ((arp0->opcode ==
2332               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
2333              &&
2334              (!memcmp
2335               (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2336                sizeof (vrrp_prefix))));
2337
2338           /* Trash ARP packets whose ARP-level source addresses do not
2339              match their L2-frame-level source addresses, unless it's
2340              a reply from a VRRP virtual router */
2341           if (PREDICT_FALSE
2342               (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2343                        sizeof (eth0->src_address)) && !is_vrrp_reply0))
2344             {
2345               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2346               goto drop;
2347             }
2348
2349           /* Check if anyone want ARP request events for L2 BDs */
2350           {
2351             ethernet_arp_main_t *am = &ethernet_arp_main;
2352             if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2353               vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2354           }
2355
2356           /* lookup BD mac_by_ip4 hash table for MAC entry */
2357           ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2358           bd_index0 = vnet_buffer (p0)->l2.bd_index;
2359           if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2360                              || (last_bd_index == (u16) ~ 0)))
2361             {
2362               last_bd_index = bd_index0;
2363               last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2364             }
2365           macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2366
2367           if (PREDICT_FALSE (!macp0))
2368             goto next_l2_feature;       /* MAC not found */
2369
2370           /* MAC found, send ARP reply -
2371              Convert ARP request packet to ARP reply */
2372           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2373           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2374           arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2375           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2376           clib_memcpy (eth0->dst_address, eth0->src_address, 6);
2377           clib_memcpy (eth0->src_address, macp0, 6);
2378           n_replies_sent += 1;
2379
2380         output_response:
2381           /* For BVI, need to use l2-fwd node to send ARP reply as
2382              l2-output node cannot output packet to BVI properly */
2383           cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2384           if (PREDICT_FALSE (cfg0->bvi))
2385             {
2386               vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2387               vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2388               goto next_l2_feature;
2389             }
2390
2391           /* Send ARP/ND reply back out input interface through l2-output */
2392           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2393           next0 = ARP_TERM_NEXT_L2_OUTPUT;
2394           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2395                                            to_next, n_left_to_next, pi0,
2396                                            next0);
2397           continue;
2398
2399         check_ip6_nd:
2400           /* IP6 ND event notification or solicitation handling to generate
2401              local response instead of flooding */
2402           iph0 = (ip6_header_t *) l3h0;
2403           if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2404                              iph0->protocol == IP_PROTOCOL_ICMP6 &&
2405                              !ip6_address_is_unspecified
2406                              (&iph0->src_address)))
2407             {
2408               sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2409               if (vnet_ip6_nd_term
2410                   (vm, node, p0, eth0, iph0, sw_if_index0,
2411                    vnet_buffer (p0)->l2.bd_index))
2412                 goto output_response;
2413             }
2414
2415         next_l2_feature:
2416           {
2417             next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2418                                           L2INPUT_FEAT_ARP_TERM);
2419             vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2420                                              to_next, n_left_to_next,
2421                                              pi0, next0);
2422             continue;
2423           }
2424
2425         drop:
2426           if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2427               (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2428                arp0->ip4_over_ethernet[1].ip4.as_u32))
2429             {
2430               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2431             }
2432           next0 = ARP_TERM_NEXT_DROP;
2433           p0->error = node->errors[error0];
2434
2435           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2436                                            to_next, n_left_to_next, pi0,
2437                                            next0);
2438         }
2439
2440       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2441     }
2442
2443   vlib_error_count (vm, node->node_index,
2444                     ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2445   return frame->n_vectors;
2446 }
2447
2448 /* *INDENT-OFF* */
2449 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2450   .function = arp_term_l2bd,
2451   .name = "arp-term-l2bd",
2452   .vector_size = sizeof (u32),
2453   .n_errors = ETHERNET_ARP_N_ERROR,
2454   .error_strings = ethernet_arp_error_strings,
2455   .n_next_nodes = ARP_TERM_N_NEXT,
2456   .next_nodes = {
2457     [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2458     [ARP_TERM_NEXT_DROP] = "error-drop",
2459   },
2460   .format_buffer = format_ethernet_arp_header,
2461   .format_trace = format_arp_term_input_trace,
2462 };
2463 /* *INDENT-ON* */
2464
2465 clib_error_t *
2466 arp_term_init (vlib_main_t * vm)
2467 {
2468   // Initialize the feature next-node indexes
2469   feat_bitmap_init_next_nodes (vm,
2470                                arp_term_l2bd_node.index,
2471                                L2INPUT_N_FEAT,
2472                                l2input_get_feat_names (),
2473                                arp_term_next_node_index);
2474   return 0;
2475 }
2476
2477 VLIB_INIT_FUNCTION (arp_term_init);
2478
2479 void
2480 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2481 {
2482   if (e->sw_if_index == sw_if_index)
2483     {
2484       adj_nbr_walk_nh4 (e->sw_if_index,
2485                         &e->ip4_address, arp_mk_complete_walk, e);
2486     }
2487 }
2488
2489 void
2490 ethernet_arp_change_mac (u32 sw_if_index)
2491 {
2492   ethernet_arp_main_t *am = &ethernet_arp_main;
2493   ethernet_arp_ip4_entry_t *e;
2494   adj_index_t ai;
2495
2496   /* *INDENT-OFF* */
2497   pool_foreach (e, am->ip4_entry_pool,
2498   ({
2499     change_arp_mac (sw_if_index, e);
2500   }));
2501   /* *INDENT-ON* */
2502
2503   ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2504
2505   if (ADJ_INDEX_INVALID != ai)
2506     adj_glean_update_rewrite (ai);
2507 }
2508
2509 void
2510 send_ip4_garp (vlib_main_t * vm, const vnet_hw_interface_t * hi)
2511 {
2512   ip4_main_t *i4m = &ip4_main;
2513   ip4_address_t *ip4_addr =
2514     ip4_interface_first_address (i4m, hi->sw_if_index, 0);
2515
2516   send_ip4_garp_w_addr (vm, ip4_addr, hi);
2517 }
2518
2519 void
2520 send_ip4_garp_w_addr (vlib_main_t * vm,
2521                       const ip4_address_t * ip4_addr,
2522                       const vnet_hw_interface_t * hi)
2523 {
2524   ip4_main_t *i4m = &ip4_main;
2525   u32 sw_if_index = hi->sw_if_index;
2526
2527   if (ip4_addr)
2528     {
2529       clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2530                     format_ip4_address, ip4_addr, sw_if_index);
2531
2532       /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2533          where the interface IP/MAC pair is used for both source and request
2534          MAC/IP pairs in the request */
2535       u32 bi = 0;
2536       ethernet_arp_header_t *h = vlib_packet_template_get_packet
2537         (vm, &i4m->ip4_arp_request_packet_template, &bi);
2538       clib_memcpy (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2539                    sizeof (h->ip4_over_ethernet[0].ethernet));
2540       clib_memcpy (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2541                    sizeof (h->ip4_over_ethernet[1].ethernet));
2542       h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2543       h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2544
2545       /* Setup MAC header with ARP Etype and broadcast DMAC */
2546       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2547       vlib_buffer_advance (b, -sizeof (ethernet_header_t));
2548       ethernet_header_t *e = vlib_buffer_get_current (b);
2549       e->type = clib_host_to_net_u16 (ETHERNET_TYPE_ARP);
2550       clib_memcpy (e->src_address, hi->hw_address, sizeof (e->src_address));
2551       memset (e->dst_address, 0xff, sizeof (e->dst_address));
2552
2553       /* Send GARP packet out the specified interface */
2554       vnet_buffer (b)->sw_if_index[VLIB_RX] =
2555         vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2556       vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2557       u32 *to_next = vlib_frame_vector_args (f);
2558       to_next[0] = bi;
2559       f->n_vectors = 1;
2560       vlib_put_frame_to_node (vm, hi->output_node_index, f);
2561     }
2562 }
2563
2564 /*
2565  * fd.io coding-style-patch-verification: ON
2566  *
2567  * Local Variables:
2568  * eval: (c-set-style "gnu")
2569  * End:
2570  */