src/vnet/ethernet/arp.c

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