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