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