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