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