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         }
 588       else
 589         {
 590           e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY;
 591         }
 592     }
 593   else
 594     {
 595       /*
 596        * prevent a DoS attack from the data-plane that
 597        * spams us with no-op updates to the MAC address
 598        */
 599       if (0 == memcmp (e->ethernet_address,
 600                        a->ethernet, sizeof (e->ethernet_address)))
 601         return -1;
 602
 603       /* Update time stamp and ethernet address. */
 604       clib_memcpy (e->ethernet_address, a->ethernet,
 605                    sizeof (e->ethernet_address));
 606     }
 607
 608   e->cpu_time_last_updated = clib_cpu_time_now ();
 609   if (is_static)
 610     e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
 611   else
 612     e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
 613
 614   adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
 615
 616   /* Customer(s) waiting for this address to be resolved? */
 617   p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
 618   if (p)
 619     {
 620       u32 next_index;
 621       next_index = p[0];
 622
 623       while (next_index != (u32) ~ 0)
 624         {
 625           pr = pool_elt_at_index (am->pending_resolutions, next_index);
 626           vlib_process_signal_event (vm, pr->node_index,
 627                                      pr->type_opaque, pr->data);
 628           next_index = pr->next_index;
 629           pool_put (am->pending_resolutions, pr);
 630         }
 631
 632       hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
 633     }
 634
 635   /* Customer(s) requesting ARP event for this address? */
 636   p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
 637   if (p)
 638     {
 639       u32 next_index;
 640       next_index = p[0];
 641
 642       while (next_index != (u32) ~ 0)
 643         {
 644           int (*fp) (u32, u8 *, u32, u32);
 645           int rv = 1;
 646           mc = pool_elt_at_index (am->mac_changes, next_index);
 647           fp = mc->data_callback;
 648
 649           /* Call the user's data callback, return 1 to suppress dup events */
 650           if (fp)
 651             rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
 652
 653           /*
 654            * Signal the resolver process, as long as the user
 655            * says they want to be notified
 656            */
 657           if (rv == 0)
 658             vlib_process_signal_event (vm, mc->node_index,
 659                                        mc->type_opaque, mc->data);
 660           next_index = mc->next_index;
 661         }
 662     }
 663
 664   return 0;
 665 }
 666
 667 void
 668 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
 669                                         void *address_arg,
 670                                         uword node_index,
 671                                         uword type_opaque, uword data)
 672 {
 673   ethernet_arp_main_t *am = &ethernet_arp_main;
 674   ip4_address_t *address = address_arg;
 675   uword *p;
 676   pending_resolution_t *pr;
 677
 678   pool_get (am->pending_resolutions, pr);
 679
 680   pr->next_index = ~0;
 681   pr->node_index = node_index;
 682   pr->type_opaque = type_opaque;
 683   pr->data = data;
 684   pr->data_callback = 0;
 685
 686   p = hash_get (am->pending_resolutions_by_address, address->as_u32);
 687   if (p)
 688     {
 689       /* Insert new resolution at the head of the list */
 690       pr->next_index = p[0];
 691       hash_unset (am->pending_resolutions_by_address, address->as_u32);
 692     }
 693
 694   hash_set (am->pending_resolutions_by_address, address->as_u32,
 695             pr - am->pending_resolutions);
 696 }
 697
 698 int
 699 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
 700                                    void *data_callback,
 701                                    u32 pid,
 702                                    void *address_arg,
 703                                    uword node_index,
 704                                    uword type_opaque, uword data, int is_add)
 705 {
 706   ethernet_arp_main_t *am = &ethernet_arp_main;
 707   ip4_address_t *address = address_arg;
 708
 709   /* Try to find an existing entry */
 710   u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
 711   u32 *p = first;
 712   pending_resolution_t *mc;
 713   while (p && *p != ~0)
 714     {
 715       mc = pool_elt_at_index (am->mac_changes, *p);
 716       if (mc->node_index == node_index && mc->type_opaque == type_opaque
 717           && mc->pid == pid)
 718         break;
 719       p = &mc->next_index;
 720     }
 721
 722   int found = p && *p != ~0;
 723   if (is_add)
 724     {
 725       if (found)
 726         return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 727
 728       pool_get (am->mac_changes, mc);
 729       *mc = (pending_resolution_t)
 730       {
 731       .next_index = ~0,.node_index = node_index,.type_opaque =
 732           type_opaque,.data = data,.data_callback = data_callback,.pid =
 733           pid,};
 734
 735       /* Insert new resolution at the end of the list */
 736       u32 new_idx = mc - am->mac_changes;
 737       if (p)
 738         p[0] = new_idx;
 739       else
 740         hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
 741     }
 742   else
 743     {
 744       if (!found)
 745         return VNET_API_ERROR_NO_SUCH_ENTRY;
 746
 747       /* Clients may need to clean up pool entries, too */
 748       void (*fp) (u32, u8 *) = data_callback;
 749       if (fp)
 750         (*fp) (mc->data, 0 /* no new mac addrs */ );
 751
 752       /* Remove the entry from the list and delete the entry */
 753       *p = mc->next_index;
 754       pool_put (am->mac_changes, mc);
 755
 756       /* Remove from hash if we deleted the last entry */
 757       if (*p == ~0 && p == first)
 758         hash_unset (am->mac_changes_by_address, address->as_u32);
 759     }
 760   return 0;
 761 }
 762
 763 /* Either we drop the packet or we send a reply to the sender. */
 764 typedef enum
 765 {
 766   ARP_INPUT_NEXT_DROP,
 767   ARP_INPUT_NEXT_REPLY_TX,
 768   ARP_INPUT_N_NEXT,
 769 } arp_input_next_t;
 770
 771 #define foreach_ethernet_arp_error                                      \
 772   _ (replies_sent, "ARP replies sent")                                  \
 773   _ (l2_type_not_ethernet, "L2 type not ethernet")                      \
 774   _ (l3_type_not_ip4, "L3 type not IP4")                                \
 775   _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
 776   _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
 777   _ (l3_src_address_is_local, "IP4 source address matches local interface") \
 778   _ (l3_src_address_learned, "ARP request IP4 source address learned")  \
 779   _ (replies_received, "ARP replies received")                          \
 780   _ (opcode_not_request, "ARP opcode not request")                      \
 781   _ (proxy_arp_replies_sent, "Proxy ARP replies sent")                  \
 782   _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
 783   _ (missing_interface_address, "ARP missing interface address") \
 784   _ (gratuitous_arp, "ARP probe or announcement dropped") \
 785   _ (interface_no_table, "Interface is not mapped to an IP table") \
 786   _ (interface_not_ip_enabled, "Interface is not IP enabled") \
 787
 788 typedef enum
 789 {
 790 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
 791   foreach_ethernet_arp_error
 792 #undef _
 793     ETHERNET_ARP_N_ERROR,
 794 } ethernet_arp_input_error_t;
 795
 796
 797 static void
 798 unset_random_arp_entry (void)
 799 {
 800   ethernet_arp_main_t *am = &ethernet_arp_main;
 801   ethernet_arp_ip4_entry_t *e;
 802   vnet_main_t *vnm = vnet_get_main ();
 803   ethernet_arp_ip4_over_ethernet_address_t delme;
 804   u32 index;
 805
 806   index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
 807   am->arp_delete_rotor = index;
 808
 809   /* Try again from elt 0, could happen if an intfc goes down */
 810   if (index == ~0)
 811     {
 812       index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
 813       am->arp_delete_rotor = index;
 814     }
 815
 816   /* Nothing left in the pool */
 817   if (index == ~0)
 818     return;
 819
 820   e = pool_elt_at_index (am->ip4_entry_pool, index);
 821
 822   clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
 823   delme.ip4.as_u32 = e->ip4_address.as_u32;
 824
 825   vnet_arp_unset_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
 826 }
 827
 828 static int
 829 arp_unnumbered (vlib_buffer_t * p0,
 830                 u32 pi0, ethernet_header_t * eth0, u32 sw_if_index)
 831 {
 832   vlib_main_t *vm = vlib_get_main ();
 833   vnet_main_t *vnm = vnet_get_main ();
 834   vnet_interface_main_t *vim = &vnm->interface_main;
 835   vnet_sw_interface_t *si;
 836   vnet_hw_interface_t *hi;
 837   u32 unnum_src_sw_if_index;
 838   u32 *broadcast_swifs = 0;
 839   u32 *buffers = 0;
 840   u32 n_alloc = 0;
 841   vlib_buffer_t *b0;
 842   int i;
 843   u8 dst_mac_address[6];
 844   i16 header_size;
 845   ethernet_arp_header_t *arp0;
 846
 847   /* Save the dst mac address */
 848   clib_memcpy (dst_mac_address, eth0->dst_address, sizeof (dst_mac_address));
 849
 850   /* Figure out which sw_if_index supplied the address */
 851   unnum_src_sw_if_index = sw_if_index;
 852
 853   /* Track down all users of the unnumbered source */
 854   /* *INDENT-OFF* */
 855   pool_foreach (si, vim->sw_interfaces,
 856   ({
 857     if (si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
 858         (si->unnumbered_sw_if_index == unnum_src_sw_if_index))
 859       {
 860         vec_add1 (broadcast_swifs, si->sw_if_index);
 861       }
 862   }));
 863   /* *INDENT-ON* */
 864
 865   /* If there are no interfaces un-unmbered to this interface,
 866      we are done  here. */
 867   if (0 == vec_len (broadcast_swifs))
 868     return 0;
 869
 870   /* Allocate buffering if we need it */
 871   if (vec_len (broadcast_swifs) > 1)
 872     {
 873       vec_validate (buffers, vec_len (broadcast_swifs) - 2);
 874       n_alloc = vlib_buffer_alloc (vm, buffers, vec_len (buffers));
 875       _vec_len (buffers) = n_alloc;
 876       for (i = 0; i < n_alloc; i++)
 877         {
 878           b0 = vlib_get_buffer (vm, buffers[i]);
 879
 880           /* xerox (partially built) ARP pkt */
 881           clib_memcpy (b0->data, p0->data,
 882                        p0->current_length + p0->current_data);
 883           b0->current_data = p0->current_data;
 884           b0->current_length = p0->current_length;
 885           vnet_buffer (b0)->sw_if_index[VLIB_RX] =
 886             vnet_buffer (p0)->sw_if_index[VLIB_RX];
 887         }
 888     }
 889
 890   vec_insert (buffers, 1, 0);
 891   buffers[0] = pi0;
 892
 893   for (i = 0; i < vec_len (buffers); i++)
 894     {
 895       b0 = vlib_get_buffer (vm, buffers[i]);
 896       arp0 = vlib_buffer_get_current (b0);
 897
 898       hi = vnet_get_sup_hw_interface (vnm, broadcast_swifs[i]);
 899       si = vnet_get_sw_interface (vnm, broadcast_swifs[i]);
 900
 901       /* For decoration, most likely */
 902       vnet_buffer (b0)->sw_if_index[VLIB_TX] = hi->sw_if_index;
 903
 904       /* Fix ARP pkt src address */
 905       clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, hi->hw_address, 6);
 906
 907       /* Build L2 encaps for this swif */
 908       header_size = sizeof (ethernet_header_t);
 909       if (si->sub.eth.flags.one_tag)
 910         header_size += 4;
 911       else if (si->sub.eth.flags.two_tags)
 912         header_size += 8;
 913
 914       vlib_buffer_advance (b0, -header_size);
 915       eth0 = vlib_buffer_get_current (b0);
 916
 917       if (si->sub.eth.flags.one_tag)
 918         {
 919           ethernet_vlan_header_t *outer = (void *) (eth0 + 1);
 920
 921           eth0->type = si->sub.eth.flags.dot1ad ?
 922             clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
 923             clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
 924           outer->priority_cfi_and_id =
 925             clib_host_to_net_u16 (si->sub.eth.outer_vlan_id);
 926           outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_ARP);
 927
 928         }
 929       else if (si->sub.eth.flags.two_tags)
 930         {
 931           ethernet_vlan_header_t *outer = (void *) (eth0 + 1);
 932           ethernet_vlan_header_t *inner = (void *) (outer + 1);
 933
 934           eth0->type = si->sub.eth.flags.dot1ad ?
 935             clib_host_to_net_u16 (ETHERNET_TYPE_DOT1AD) :
 936             clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
 937           outer->priority_cfi_and_id =
 938             clib_host_to_net_u16 (si->sub.eth.outer_vlan_id);
 939           outer->type = clib_host_to_net_u16 (ETHERNET_TYPE_VLAN);
 940           inner->priority_cfi_and_id =
 941             clib_host_to_net_u16 (si->sub.eth.inner_vlan_id);
 942           inner->type = clib_host_to_net_u16 (ETHERNET_TYPE_ARP);
 943
 944         }
 945       else
 946         {
 947           eth0->type = clib_host_to_net_u16 (ETHERNET_TYPE_ARP);
 948         }
 949
 950       /* Restore the original dst address, set src address */
 951       clib_memcpy (eth0->dst_address, dst_mac_address,
 952                    sizeof (eth0->dst_address));
 953       clib_memcpy (eth0->src_address, hi->hw_address,
 954                    sizeof (eth0->src_address));
 955
 956       /* Transmit replicas */
 957       if (i > 0)
 958         {
 959           vlib_frame_t *f =
 960             vlib_get_frame_to_node (vm, hi->output_node_index);
 961           u32 *to_next = vlib_frame_vector_args (f);
 962           to_next[0] = buffers[i];
 963           f->n_vectors = 1;
 964           vlib_put_frame_to_node (vm, hi->output_node_index, f);
 965         }
 966     }
 967
 968   /* The regular path outputs the original pkt.. */
 969   vnet_buffer (p0)->sw_if_index[VLIB_TX] = broadcast_swifs[0];
 970
 971   vec_free (broadcast_swifs);
 972   vec_free (buffers);
 973
 974   return !0;
 975 }
 976
 977 static uword
 978 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 979 {
 980   ethernet_arp_main_t *am = &ethernet_arp_main;
 981   vnet_main_t *vnm = vnet_get_main ();
 982   ip4_main_t *im4 = &ip4_main;
 983   u32 n_left_from, next_index, *from, *to_next;
 984   u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
 985
 986   from = vlib_frame_vector_args (frame);
 987   n_left_from = frame->n_vectors;
 988   next_index = node->cached_next_index;
 989
 990   if (node->flags & VLIB_NODE_FLAG_TRACE)
 991     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 992                                    /* stride */ 1,
 993                                    sizeof (ethernet_arp_input_trace_t));
 994
 995   while (n_left_from > 0)
 996     {
 997       u32 n_left_to_next;
 998
 999       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1000
1001       while (n_left_from > 0 && n_left_to_next > 0)
1002         {
1003           vlib_buffer_t *p0;
1004           vnet_hw_interface_t *hw_if0;
1005           ethernet_arp_header_t *arp0;
1006           ethernet_header_t *eth0;
1007           ip4_address_t *if_addr0, proxy_src;
1008           u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
1009           u8 is_request0, dst_is_local0, is_unnum0;
1010           ethernet_proxy_arp_t *pa;
1011           fib_node_index_t dst_fei, src_fei;
1012           fib_prefix_t pfx0;
1013           fib_entry_flag_t src_flags, dst_flags;
1014
1015           pi0 = from[0];
1016           to_next[0] = pi0;
1017           from += 1;
1018           to_next += 1;
1019           n_left_from -= 1;
1020           n_left_to_next -= 1;
1021           pa = 0;
1022
1023           p0 = vlib_get_buffer (vm, pi0);
1024           arp0 = vlib_buffer_get_current (p0);
1025
1026           is_request0 = arp0->opcode
1027             == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
1028
1029           error0 = ETHERNET_ARP_ERROR_replies_sent;
1030
1031           error0 =
1032             (arp0->l2_type !=
1033              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
1034              ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
1035           error0 =
1036             (arp0->l3_type !=
1037              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
1038              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
1039
1040           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1041
1042           /* not playing the ARP game if the interface is not IPv4 enabled */
1043           error0 =
1044             (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
1045              ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
1046
1047           if (error0)
1048             goto drop2;
1049
1050           /* Check that IP address is local and matches incoming interface. */
1051           fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1052           if (~0 == fib_index0)
1053             {
1054               error0 = ETHERNET_ARP_ERROR_interface_no_table;
1055               goto drop2;
1056
1057             }
1058           dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1059                                           &arp0->ip4_over_ethernet[1].ip4,
1060                                           32);
1061           dst_flags = fib_entry_get_flags (dst_fei);
1062
1063           src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1064                                           &arp0->ip4_over_ethernet[0].ip4,
1065                                           32);
1066           src_flags = fib_entry_get_flags (src_fei);
1067
1068           conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
1069
1070           if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1071             {
1072               error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1073               goto drop1;
1074             }
1075
1076           /* Honor unnumbered interface, if any */
1077           is_unnum0 = sw_if_index0 != conn_sw_if_index0;
1078
1079           /* Source must also be local to subnet of matching interface address. */
1080           if (!((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1081                 (FIB_ENTRY_FLAG_CONNECTED & src_flags)))
1082             {
1083               /*
1084                * The packet was sent from an address that is not connected nor attached
1085                * i.e. it is not from an address that is covered by a link's sub-net,
1086                * nor is it a already learned host resp.
1087                */
1088               error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1089               goto drop2;
1090             }
1091           if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1092             {
1093               /*
1094                * The interface the ARP was received on is not the interface
1095                * on which the covering prefix is configured. Maybe this is a case
1096                * for unnumbered.
1097                */
1098               is_unnum0 = 1;
1099             }
1100
1101           /* Reject requests/replies with our local interface address. */
1102           if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1103             {
1104               error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1105               goto drop2;
1106             }
1107
1108           dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1109           fib_entry_get_prefix (dst_fei, &pfx0);
1110           if_addr0 = &pfx0.fp_addr.ip4;
1111
1112           /* Fill in ethernet header. */
1113           eth0 = ethernet_buffer_get_header (p0);
1114
1115           /* Trash ARP packets whose ARP-level source addresses do not
1116              match their L2-frame-level source addresses */
1117           if (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
1118                       sizeof (eth0->src_address)))
1119             {
1120               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1121               goto drop2;
1122             }
1123
1124           /* Learn or update sender's mapping only for requests or unicasts
1125              that don't match local interface address. */
1126           if (ethernet_address_cast (eth0->dst_address) ==
1127               ETHERNET_ADDRESS_UNICAST || is_request0)
1128             {
1129               if (am->limit_arp_cache_size &&
1130                   pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
1131                 unset_random_arp_entry ();
1132
1133               vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index0,
1134                                               &arp0->ip4_over_ethernet[0],
1135                                               0 /* is_static */ , 0);
1136               error0 = ETHERNET_ARP_ERROR_l3_src_address_learned;
1137             }
1138
1139           /* Only send a reply for requests sent which match a local interface. */
1140           if (!(is_request0 && dst_is_local0))
1141             {
1142               error0 =
1143                 (arp0->opcode ==
1144                  clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply) ?
1145                  ETHERNET_ARP_ERROR_replies_received : error0);
1146               goto drop1;
1147             }
1148
1149           /* Send a reply. */
1150         send_reply:
1151           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1152           hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1153
1154           /* Send reply back through input interface */
1155           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1156           next0 = ARP_INPUT_NEXT_REPLY_TX;
1157
1158           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1159
1160           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1161
1162           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1163                        hw_if0->hw_address, 6);
1164           clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1165             if_addr0->data_u32;
1166
1167           /* Hardware must be ethernet-like. */
1168           ASSERT (vec_len (hw_if0->hw_address) == 6);
1169
1170           clib_memcpy (eth0->dst_address, eth0->src_address, 6);
1171           clib_memcpy (eth0->src_address, hw_if0->hw_address, 6);
1172
1173           /* Figure out how much to rewind current data from adjacency. */
1174           /* get the adj from the destination's covering connected */
1175           if (NULL == pa)
1176             {
1177               if (is_unnum0)
1178                 {
1179                   if (!arp_unnumbered (p0, pi0, eth0, conn_sw_if_index0))
1180                     goto drop2;
1181                 }
1182               else
1183                 {
1184                   ip_adjacency_t *adj0 = NULL;
1185                   adj_index_t ai;
1186
1187                   if (FIB_ENTRY_FLAG_ATTACHED & src_flags)
1188                     {
1189                       /*
1190                        * If the source is attached use the adj from that source.
1191                        */
1192                       ai = fib_entry_get_adj (src_fei);
1193                       if (ADJ_INDEX_INVALID != ai)
1194                         {
1195                           adj0 = adj_get (ai);
1196                         }
1197                     }
1198                   else
1199                     {
1200                       /*
1201                        * Get the glean adj from the cover. This is presumably interface
1202                        * sourced, and therefre needs to be a glean adj.
1203                        */
1204                       ai = fib_entry_get_adj_for_source
1205                         (ip4_fib_table_lookup
1206                          (ip4_fib_get (fib_index0),
1207                           &arp0->ip4_over_ethernet[1].ip4, 31),
1208                          FIB_SOURCE_INTERFACE);
1209
1210                       if (ADJ_INDEX_INVALID != ai)
1211                         {
1212                           adj0 = adj_get (ai);
1213
1214                           if (adj0->lookup_next_index == IP_LOOKUP_NEXT_GLEAN)
1215                             {
1216                               adj0 = NULL;
1217                             }
1218                         }
1219                     }
1220                   if (NULL != adj0)
1221                     {
1222                       vlib_buffer_advance (p0,
1223                                            -adj0->rewrite_header.data_bytes);
1224                     }
1225                   else
1226                     {
1227                       error0 = ETHERNET_ARP_ERROR_missing_interface_address;
1228                       goto drop2;
1229                     }
1230                 }
1231             }
1232
1233           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1234                                            n_left_to_next, pi0, next0);
1235
1236           n_replies_sent += 1;
1237           continue;
1238
1239         drop1:
1240           if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
1241               (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1242                arp0->ip4_over_ethernet[1].ip4.as_u32))
1243             {
1244               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1245               goto drop2;
1246             }
1247           /* See if proxy arp is configured for the address */
1248           if (is_request0)
1249             {
1250               vnet_sw_interface_t *si;
1251               u32 this_addr = clib_net_to_host_u32
1252                 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1253               u32 fib_index0;
1254
1255               si = vnet_get_sw_interface (vnm, sw_if_index0);
1256
1257               if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1258                 goto drop2;
1259
1260               fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1261                                     sw_if_index0);
1262
1263               vec_foreach (pa, am->proxy_arps)
1264               {
1265                 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr);
1266                 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr);
1267
1268                 /* an ARP request hit in the proxy-arp table? */
1269                 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1270                     (fib_index0 == pa->fib_index))
1271                   {
1272                     eth0 = ethernet_buffer_get_header (p0);
1273                     proxy_src.as_u32 =
1274                       arp0->ip4_over_ethernet[1].ip4.data_u32;
1275
1276                     /*
1277                      * Rewind buffer, direct code above not to
1278                      * think too hard about it.
1279                      */
1280                     if_addr0 = &proxy_src;
1281                     is_unnum0 = 0;
1282                     i32 ethernet_start =
1283                       vnet_buffer (p0)->ethernet.start_of_ethernet_header;
1284                     i32 rewind = p0->current_data - ethernet_start;
1285                     vlib_buffer_advance (p0, -rewind);
1286                     n_proxy_arp_replies_sent++;
1287                     goto send_reply;
1288                   }
1289               }
1290             }
1291
1292         drop2:
1293
1294           next0 = ARP_INPUT_NEXT_DROP;
1295           p0->error = node->errors[error0];
1296
1297           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1298                                            n_left_to_next, pi0, next0);
1299         }
1300
1301       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1302     }
1303
1304   vlib_error_count (vm, node->node_index,
1305                     ETHERNET_ARP_ERROR_replies_sent,
1306                     n_replies_sent - n_proxy_arp_replies_sent);
1307
1308   vlib_error_count (vm, node->node_index,
1309                     ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1310                     n_proxy_arp_replies_sent);
1311   return frame->n_vectors;
1312 }
1313
1314 static char *ethernet_arp_error_strings[] = {
1315 #define _(sym,string) string,
1316   foreach_ethernet_arp_error
1317 #undef _
1318 };
1319
1320 /* *INDENT-OFF* */
1321 VLIB_REGISTER_NODE (arp_input_node, static) =
1322 {
1323   .function = arp_input,
1324   .name = "arp-input",
1325   .vector_size = sizeof (u32),
1326   .n_errors = ETHERNET_ARP_N_ERROR,
1327   .error_strings = ethernet_arp_error_strings,
1328   .n_next_nodes = ARP_INPUT_N_NEXT,
1329   .next_nodes = {
1330     [ARP_INPUT_NEXT_DROP] = "error-drop",
1331     [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1332   },
1333   .format_buffer = format_ethernet_arp_header,
1334   .format_trace = format_ethernet_arp_input_trace,
1335 };
1336 /* *INDENT-ON* */
1337
1338 static int
1339 ip4_arp_entry_sort (void *a1, void *a2)
1340 {
1341   ethernet_arp_ip4_entry_t *e1 = a1;
1342   ethernet_arp_ip4_entry_t *e2 = a2;
1343
1344   int cmp;
1345   vnet_main_t *vnm = vnet_get_main ();
1346
1347   cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1348   if (!cmp)
1349     cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1350   return cmp;
1351 }
1352
1353 ethernet_arp_ip4_entry_t *
1354 ip4_neighbor_entries (u32 sw_if_index)
1355 {
1356   ethernet_arp_main_t *am = &ethernet_arp_main;
1357   ethernet_arp_ip4_entry_t *n, *ns = 0;
1358
1359   /* *INDENT-OFF* */
1360   pool_foreach (n, am->ip4_entry_pool, ({
1361     if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1362       continue;
1363     vec_add1 (ns, n[0]);
1364   }));
1365   /* *INDENT-ON* */
1366
1367   if (ns)
1368     vec_sort_with_function (ns, ip4_arp_entry_sort);
1369   return ns;
1370 }
1371
1372 static clib_error_t *
1373 show_ip4_arp (vlib_main_t * vm,
1374               unformat_input_t * input, vlib_cli_command_t * cmd)
1375 {
1376   vnet_main_t *vnm = vnet_get_main ();
1377   ethernet_arp_main_t *am = &ethernet_arp_main;
1378   ethernet_arp_ip4_entry_t *e, *es;
1379   ethernet_proxy_arp_t *pa;
1380   clib_error_t *error = 0;
1381   u32 sw_if_index;
1382
1383   /* Filter entries by interface if given. */
1384   sw_if_index = ~0;
1385   (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1386
1387   es = ip4_neighbor_entries (sw_if_index);
1388   if (es)
1389     {
1390       vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1391       vec_foreach (e, es)
1392       {
1393         vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1394       }
1395       vec_free (es);
1396     }
1397
1398   if (vec_len (am->proxy_arps))
1399     {
1400       vlib_cli_output (vm, "Proxy arps enabled for:");
1401       vec_foreach (pa, am->proxy_arps)
1402       {
1403         vlib_cli_output (vm, "Fib_index %d   %U - %U ",
1404                          pa->fib_index,
1405                          format_ip4_address, &pa->lo_addr,
1406                          format_ip4_address, &pa->hi_addr);
1407       }
1408     }
1409
1410   return error;
1411 }
1412
1413 /*?
1414  * Display all the IPv4 ARP entries.
1415  *
1416  * @cliexpar
1417  * Example of how to display the IPv4 ARP table:
1418  * @cliexstart{show ip arp}
1419  *    Time      FIB        IP4       Flags      Ethernet              Interface
1420  *    346.3028   0       6.1.1.3            de:ad:be:ef:ba:be   GigabitEthernet2/0/0
1421  *   3077.4271   0       6.1.1.4       S    de:ad:be:ef:ff:ff   GigabitEthernet2/0/0
1422  *   2998.6409   1       6.2.2.3            de:ad:be:ef:00:01   GigabitEthernet2/0/0
1423  * Proxy arps enabled for:
1424  * Fib_index 0   6.0.0.1 - 6.0.0.11
1425  * @cliexend
1426  ?*/
1427 /* *INDENT-OFF* */
1428 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1429   .path = "show ip arp",
1430   .function = show_ip4_arp,
1431   .short_help = "show ip arp",
1432 };
1433 /* *INDENT-ON* */
1434
1435 typedef struct
1436 {
1437   pg_edit_t l2_type, l3_type;
1438   pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1439   pg_edit_t opcode;
1440   struct
1441   {
1442     pg_edit_t ethernet;
1443     pg_edit_t ip4;
1444   } ip4_over_ethernet[2];
1445 } pg_ethernet_arp_header_t;
1446
1447 static inline void
1448 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1449 {
1450   /* Initialize fields that are not bit fields in the IP header. */
1451 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1452   _(l2_type);
1453   _(l3_type);
1454   _(n_l2_address_bytes);
1455   _(n_l3_address_bytes);
1456   _(opcode);
1457   _(ip4_over_ethernet[0].ethernet);
1458   _(ip4_over_ethernet[0].ip4);
1459   _(ip4_over_ethernet[1].ethernet);
1460   _(ip4_over_ethernet[1].ip4);
1461 #undef _
1462 }
1463
1464 uword
1465 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1466 {
1467   pg_stream_t *s = va_arg (*args, pg_stream_t *);
1468   pg_ethernet_arp_header_t *p;
1469   u32 group_index;
1470
1471   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1472                             &group_index);
1473   pg_ethernet_arp_header_init (p);
1474
1475   /* Defaults. */
1476   pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1477   pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1478   pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1479   pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1480
1481   if (!unformat (input, "%U: %U/%U -> %U/%U",
1482                  unformat_pg_edit,
1483                  unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1484                  unformat_pg_edit,
1485                  unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1486                  unformat_pg_edit,
1487                  unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1488                  unformat_pg_edit,
1489                  unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1490                  unformat_pg_edit,
1491                  unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1492     {
1493       /* Free up any edits we may have added. */
1494       pg_free_edit_group (s);
1495       return 0;
1496     }
1497   return 1;
1498 }
1499
1500 clib_error_t *
1501 ip4_set_arp_limit (u32 arp_limit)
1502 {
1503   ethernet_arp_main_t *am = &ethernet_arp_main;
1504
1505   am->limit_arp_cache_size = arp_limit;
1506   return 0;
1507 }
1508
1509 /**
1510  * @brief Control Plane hook to remove an ARP entry
1511  */
1512 int
1513 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1514                                   u32 sw_if_index, void *a_arg)
1515 {
1516   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1517   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1518
1519   args.sw_if_index = sw_if_index;
1520   args.flags = ETHERNET_ARP_ARGS_REMOVE;
1521   clib_memcpy (&args.a, a, sizeof (*a));
1522
1523   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1524                                (u8 *) & args, sizeof (args));
1525   return 0;
1526 }
1527
1528 /**
1529  * @brief Internally generated event to flush the ARP cache on an
1530  * interface state change event.
1531  * A flush will remove dynamic ARP entries, and for statics remove the MAC
1532  * address from the corresponding adjacencies.
1533  */
1534 static int
1535 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1536                                   u32 sw_if_index, void *a_arg)
1537 {
1538   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1539   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1540
1541   args.sw_if_index = sw_if_index;
1542   args.flags = ETHERNET_ARP_ARGS_FLUSH;
1543   clib_memcpy (&args.a, a, sizeof (*a));
1544
1545   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1546                                (u8 *) & args, sizeof (args));
1547   return 0;
1548 }
1549
1550 /**
1551  * @brief Internally generated event to populate the ARP cache on an
1552  * interface state change event.
1553  * For static entries this will re-source the adjacencies.
1554  *
1555  * @param sw_if_index The interface on which the ARP entires are acted
1556  */
1557 static int
1558 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1559                                      u32 sw_if_index, void *a_arg)
1560 {
1561   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1562   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1563
1564   args.sw_if_index = sw_if_index;
1565   args.flags = ETHERNET_ARP_ARGS_POPULATE;
1566   clib_memcpy (&args.a, a, sizeof (*a));
1567
1568   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1569                                (u8 *) & args, sizeof (args));
1570   return 0;
1571 }
1572
1573 /*
1574  * arp_add_del_interface_address
1575  *
1576  * callback when an interface address is added or deleted
1577  */
1578 static void
1579 arp_add_del_interface_address (ip4_main_t * im,
1580                                uword opaque,
1581                                u32 sw_if_index,
1582                                ip4_address_t * address,
1583                                u32 address_length,
1584                                u32 if_address_index, u32 is_del)
1585 {
1586   /*
1587    * Flush the ARP cache of all entries covered by the address
1588    * that is being removed.
1589    */
1590   ethernet_arp_main_t *am = &ethernet_arp_main;
1591   ethernet_arp_ip4_entry_t *e;
1592
1593   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1594     return;
1595
1596   if (is_del)
1597     {
1598       ethernet_arp_interface_t *eai;
1599       u32 i, *to_delete = 0;
1600       hash_pair_t *pair;
1601
1602       eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1603
1604       /* *INDENT-OFF* */
1605       hash_foreach_pair (pair, eai->arp_entries,
1606       ({
1607         e = pool_elt_at_index(am->ip4_entry_pool,
1608                               pair->value[0]);
1609         if (ip4_destination_matches_route (im, &e->ip4_address,
1610                                            address, address_length))
1611           {
1612             vec_add1 (to_delete, e - am->ip4_entry_pool);
1613           }
1614       }));
1615       /* *INDENT-ON* */
1616
1617       for (i = 0; i < vec_len (to_delete); i++)
1618         {
1619           ethernet_arp_ip4_over_ethernet_address_t delme;
1620           e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1621
1622           clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1623           delme.ip4.as_u32 = e->ip4_address.as_u32;
1624
1625           vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1626                                             e->sw_if_index, &delme);
1627         }
1628
1629       vec_free (to_delete);
1630     }
1631 }
1632
1633 static clib_error_t *
1634 ethernet_arp_init (vlib_main_t * vm)
1635 {
1636   ethernet_arp_main_t *am = &ethernet_arp_main;
1637   ip4_main_t *im = &ip4_main;
1638   clib_error_t *error;
1639   pg_node_t *pn;
1640
1641   if ((error = vlib_call_init_function (vm, ethernet_init)))
1642     return error;
1643
1644   ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1645
1646   pn = pg_get_node (arp_input_node.index);
1647   pn->unformat_edit = unformat_pg_arp_header;
1648
1649   am->opcode_by_name = hash_create_string (0, sizeof (uword));
1650 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1651   foreach_ethernet_arp_opcode;
1652 #undef _
1653
1654   /* $$$ configurable */
1655   am->limit_arp_cache_size = 50000;
1656
1657   am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1658   am->mac_changes_by_address = hash_create (0, sizeof (uword));
1659
1660   /* don't trace ARP error packets */
1661   {
1662     vlib_node_runtime_t *rt =
1663       vlib_node_get_runtime (vm, arp_input_node.index);
1664
1665 #define _(a,b)                                  \
1666     vnet_pcap_drop_trace_filter_add_del         \
1667         (rt->errors[ETHERNET_ARP_ERROR_##a],    \
1668          1 /* is_add */);
1669     foreach_ethernet_arp_error
1670 #undef _
1671   }
1672
1673   ip4_add_del_interface_address_callback_t cb;
1674   cb.function = arp_add_del_interface_address;
1675   cb.function_opaque = 0;
1676   vec_add1 (im->add_del_interface_address_callbacks, cb);
1677
1678   return 0;
1679 }
1680
1681 VLIB_INIT_FUNCTION (ethernet_arp_init);
1682
1683 static void
1684 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1685 {
1686   ethernet_arp_main_t *am = &ethernet_arp_main;
1687
1688   /* it's safe to delete the ADJ source on the FIB entry, even if it
1689    * was added */
1690   fib_table_entry_delete_index (e->fib_entry_index, FIB_SOURCE_ADJ);
1691   hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1692   pool_put (am->ip4_entry_pool, e);
1693 }
1694
1695 static inline int
1696 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1697                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1698                                            * args)
1699 {
1700   ethernet_arp_main_t *am = &ethernet_arp_main;
1701   ethernet_arp_ip4_entry_t *e;
1702   ethernet_arp_interface_t *eai;
1703
1704   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1705
1706   e = arp_entry_find (eai, &args->a.ip4);
1707
1708   if (NULL != e)
1709     {
1710       arp_entry_free (eai, e);
1711
1712       adj_nbr_walk_nh4 (e->sw_if_index,
1713                         &e->ip4_address, arp_mk_incomplete_walk, NULL);
1714     }
1715
1716   return 0;
1717 }
1718
1719 static int
1720 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1721                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1722                                            * args)
1723 {
1724   ethernet_arp_main_t *am = &ethernet_arp_main;
1725   ethernet_arp_ip4_entry_t *e;
1726   ethernet_arp_interface_t *eai;
1727
1728   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1729
1730   e = arp_entry_find (eai, &args->a.ip4);
1731
1732   if (NULL != e)
1733     {
1734       adj_nbr_walk_nh4 (e->sw_if_index,
1735                         &e->ip4_address, arp_mk_incomplete_walk, e);
1736
1737       /*
1738        * The difference between flush and unset, is that an unset
1739        * means delete for static and dynamic entries. A flush
1740        * means delete only for dynamic. Flushing is what the DP
1741        * does in response to interface events. unset is only done
1742        * by the control plane.
1743        */
1744       if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1745         {
1746           arp_entry_free (eai, e);
1747         }
1748     }
1749   return (0);
1750 }
1751
1752 static int
1753 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1754                                               vnet_arp_set_ip4_over_ethernet_rpc_args_t
1755                                               * args)
1756 {
1757   ethernet_arp_main_t *am = &ethernet_arp_main;
1758   ethernet_arp_ip4_entry_t *e;
1759   ethernet_arp_interface_t *eai;
1760
1761   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1762
1763   e = arp_entry_find (eai, &args->a.ip4);
1764
1765   if (NULL != e)
1766     {
1767       adj_nbr_walk_nh4 (e->sw_if_index,
1768                         &e->ip4_address, arp_mk_complete_walk, e);
1769     }
1770   return (0);
1771 }
1772
1773 static void
1774 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1775                                     * a)
1776 {
1777   vnet_main_t *vm = vnet_get_main ();
1778   ASSERT (vlib_get_thread_index () == 0);
1779
1780   if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1781     vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1782   else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1783     vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1784   else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1785     vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1786   else
1787     vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1788 }
1789
1790 /**
1791  * @brief Invoked when the interface's admin state changes
1792  */
1793 static clib_error_t *
1794 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1795                                    u32 sw_if_index, u32 flags)
1796 {
1797   ethernet_arp_main_t *am = &ethernet_arp_main;
1798   ethernet_arp_ip4_entry_t *e;
1799   u32 i, *to_delete = 0;
1800
1801   /* *INDENT-OFF* */
1802   pool_foreach (e, am->ip4_entry_pool,
1803   ({
1804     if (e->sw_if_index == sw_if_index)
1805       vec_add1 (to_delete,
1806                 e - am->ip4_entry_pool);
1807   }));
1808   /* *INDENT-ON* */
1809
1810   for (i = 0; i < vec_len (to_delete); i++)
1811     {
1812       ethernet_arp_ip4_over_ethernet_address_t delme;
1813       e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1814
1815       clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1816       delme.ip4.as_u32 = e->ip4_address.as_u32;
1817
1818       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1819         {
1820           vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1821         }
1822       else
1823         {
1824           vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1825         }
1826
1827     }
1828   vec_free (to_delete);
1829
1830   return 0;
1831 }
1832
1833 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1834
1835 static void
1836 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1837 {
1838   u8 old;
1839   int i;
1840
1841   for (i = 3; i >= 0; i--)
1842     {
1843       old = a->ip4.as_u8[i];
1844       a->ip4.as_u8[i] += 1;
1845       if (old < a->ip4.as_u8[i])
1846         break;
1847     }
1848
1849   for (i = 5; i >= 0; i--)
1850     {
1851       old = a->ethernet[i];
1852       a->ethernet[i] += 1;
1853       if (old < a->ethernet[i])
1854         break;
1855     }
1856 }
1857
1858 int
1859 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1860                                 u32 sw_if_index, void *a_arg,
1861                                 int is_static, int is_no_fib_entry)
1862 {
1863   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1864   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1865
1866   args.sw_if_index = sw_if_index;
1867   args.is_static = is_static;
1868   args.is_no_fib_entry = is_no_fib_entry;
1869   args.flags = 0;
1870   clib_memcpy (&args.a, a, sizeof (*a));
1871
1872   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1873                                (u8 *) & args, sizeof (args));
1874   return 0;
1875 }
1876
1877 int
1878 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1879                         ip4_address_t * hi_addr, u32 fib_index, int is_del)
1880 {
1881   ethernet_arp_main_t *am = &ethernet_arp_main;
1882   ethernet_proxy_arp_t *pa;
1883   u32 found_at_index = ~0;
1884
1885   vec_foreach (pa, am->proxy_arps)
1886   {
1887     if (pa->lo_addr == lo_addr->as_u32
1888         && pa->hi_addr == hi_addr->as_u32 && pa->fib_index == fib_index)
1889       {
1890         found_at_index = pa - am->proxy_arps;
1891         break;
1892       }
1893   }
1894
1895   if (found_at_index != ~0)
1896     {
1897       /* Delete, otherwise it's already in the table */
1898       if (is_del)
1899         vec_delete (am->proxy_arps, 1, found_at_index);
1900       return 0;
1901     }
1902   /* delete, no such entry */
1903   if (is_del)
1904     return VNET_API_ERROR_NO_SUCH_ENTRY;
1905
1906   /* add, not in table */
1907   vec_add2 (am->proxy_arps, pa, 1);
1908   pa->lo_addr = lo_addr->as_u32;
1909   pa->hi_addr = hi_addr->as_u32;
1910   pa->fib_index = fib_index;
1911   return 0;
1912 }
1913
1914 /*
1915  * Remove any proxy arp entries asdociated with the
1916  * specificed fib.
1917  */
1918 int
1919 vnet_proxy_arp_fib_reset (u32 fib_id)
1920 {
1921   ethernet_arp_main_t *am = &ethernet_arp_main;
1922   ethernet_proxy_arp_t *pa;
1923   u32 *entries_to_delete = 0;
1924   u32 fib_index;
1925   int i;
1926
1927   fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
1928   if (~0 == fib_index)
1929     return VNET_API_ERROR_NO_SUCH_ENTRY;
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           fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
1989
1990           if (~0 == fib_index)
1991             return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
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  */