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