src/vnet/arp/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/arp/arp.h>
  19 #include <vnet/arp/arp_packet.h>
  20
  21 #include <vnet/fib/ip4_fib.h>
  22 #include <vnet/fib/fib_entry_src.h>
  23 #include <vnet/adj/adj_nbr.h>
  24 #include <vnet/adj/adj_mcast.h>
  25 #include <vnet/pg/pg.h>
  26
  27 #include <vnet/ip-neighbor/ip_neighbor.h>
  28 #include <vnet/ip-neighbor/ip_neighbor_dp.h>
  29
  30 #include <vlibmemory/api.h>
  31
  32 /**
  33  * @file
  34  * @brief IPv4 ARP.
  35  *
  36  * This file contains code to manage the IPv4 ARP tables (IP Address
  37  * to MAC Address lookup).
  38  */
  39
  40 /**
  41  * @brief Per-interface ARP configuration and state
  42  */
  43 typedef struct ethernet_arp_interface_t_
  44 {
  45   /**
  46    * Is ARP enabled on this interface
  47    */
  48   u32 enabled;
  49 } ethernet_arp_interface_t;
  50
  51 typedef struct
  52 {
  53   /* Hash tables mapping name to opcode. */
  54   uword *opcode_by_name;
  55
  56   /** Per interface state */
  57   ethernet_arp_interface_t *ethernet_arp_by_sw_if_index;
  58
  59   /* ARP feature arc index */
  60   u8 feature_arc_index;
  61 } ethernet_arp_main_t;
  62
  63 static ethernet_arp_main_t ethernet_arp_main;
  64
  65 static const u8 vrrp_prefix[] = { 0x00, 0x00, 0x5E, 0x00, 0x01 };
  66
  67 static uword
  68 unformat_ethernet_arp_opcode_host_byte_order (unformat_input_t * input,
  69                                               va_list * args)
  70 {
  71   int *result = va_arg (*args, int *);
  72   ethernet_arp_main_t *am = &ethernet_arp_main;
  73   int x, i;
  74
  75   /* Numeric opcode. */
  76   if (unformat (input, "0x%x", &x) || unformat (input, "%d", &x))
  77     {
  78       if (x >= (1 << 16))
  79         return 0;
  80       *result = x;
  81       return 1;
  82     }
  83
  84   /* Named type. */
  85   if (unformat_user (input, unformat_vlib_number_by_name,
  86                      am->opcode_by_name, &i))
  87     {
  88       *result = i;
  89       return 1;
  90     }
  91
  92   return 0;
  93 }
  94
  95 static uword
  96 unformat_ethernet_arp_opcode_net_byte_order (unformat_input_t * input,
  97                                              va_list * args)
  98 {
  99   int *result = va_arg (*args, int *);
 100   if (!unformat_user
 101       (input, unformat_ethernet_arp_opcode_host_byte_order, result))
 102     return 0;
 103
 104   *result = clib_host_to_net_u16 ((u16) * result);
 105   return 1;
 106 }
 107
 108 typedef struct
 109 {
 110   u8 packet_data[64];
 111 } ethernet_arp_input_trace_t;
 112
 113 static u8 *
 114 format_ethernet_arp_input_trace (u8 * s, va_list * va)
 115 {
 116   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
 117   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
 118   ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
 119
 120   s = format (s, "%U",
 121               format_ethernet_arp_header,
 122               t->packet_data, sizeof (t->packet_data));
 123
 124   return s;
 125 }
 126
 127 static int
 128 arp_is_enabled (ethernet_arp_main_t * am, u32 sw_if_index)
 129 {
 130   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
 131     return 0;
 132
 133   return (am->ethernet_arp_by_sw_if_index[sw_if_index].enabled);
 134 }
 135
 136 static void
 137 arp_enable (ethernet_arp_main_t * am, u32 sw_if_index)
 138 {
 139   if (arp_is_enabled (am, sw_if_index))
 140     return;
 141
 142   vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
 143
 144   am->ethernet_arp_by_sw_if_index[sw_if_index].enabled = 1;
 145
 146   vnet_feature_enable_disable ("arp", "arp-reply", sw_if_index, 1, NULL, 0);
 147   vnet_feature_enable_disable ("arp", "arp-disabled", sw_if_index, 0, NULL,
 148                                0);
 149 }
 150
 151 static void
 152 arp_disable (ethernet_arp_main_t * am, u32 sw_if_index)
 153 {
 154   if (!arp_is_enabled (am, sw_if_index))
 155     return;
 156
 157   vnet_feature_enable_disable ("arp", "arp-disabled", sw_if_index, 1, NULL,
 158                                0);
 159   vnet_feature_enable_disable ("arp", "arp-reply", sw_if_index, 0, NULL, 0);
 160
 161   am->ethernet_arp_by_sw_if_index[sw_if_index].enabled = 0;
 162 }
 163
 164 static int
 165 arp_unnumbered (vlib_buffer_t * p0,
 166                 u32 input_sw_if_index, u32 conn_sw_if_index)
 167 {
 168   vnet_main_t *vnm = vnet_get_main ();
 169   vnet_interface_main_t *vim = &vnm->interface_main;
 170   vnet_sw_interface_t *si;
 171
 172   /* verify that the input interface is unnumbered to the connected.
 173    * the connected interface is the interface on which the subnet is
 174    * configured */
 175   si = &vim->sw_interfaces[input_sw_if_index];
 176
 177   if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
 178         (si->unnumbered_sw_if_index == conn_sw_if_index)))
 179     {
 180       /* the input interface is not unnumbered to the interface on which
 181        * the sub-net is configured that covers the ARP request.
 182        * So this is not the case for unnumbered.. */
 183       return 0;
 184     }
 185
 186   return !0;
 187 }
 188
 189 always_inline u32
 190 arp_learn (u32 sw_if_index,
 191            const ethernet_arp_ip4_over_ethernet_address_t * addr)
 192 {
 193   /* *INDENT-OFF* */
 194   ip_neighbor_learn_t l = {
 195     .ip = {
 196       .ip.ip4 = addr->ip4,
 197       .version = AF_IP4,
 198     },
 199     .mac = addr->mac,
 200     .sw_if_index = sw_if_index,
 201   };
 202   /* *INDENT-ON* */
 203
 204   ip_neighbor_learn_dp (&l);
 205
 206   return (ETHERNET_ARP_ERROR_l3_src_address_learned);
 207 }
 208
 209 typedef enum arp_input_next_t_
 210 {
 211   ARP_INPUT_NEXT_DROP,
 212   ARP_INPUT_NEXT_DISABLED,
 213   ARP_INPUT_N_NEXT,
 214 } arp_input_next_t;
 215
 216 static uword
 217 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 218 {
 219   u32 n_left_from, next_index, *from, *to_next, n_left_to_next;
 220   ethernet_arp_main_t *am = &ethernet_arp_main;
 221
 222   from = vlib_frame_vector_args (frame);
 223   n_left_from = frame->n_vectors;
 224   next_index = node->cached_next_index;
 225
 226   if (node->flags & VLIB_NODE_FLAG_TRACE)
 227     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 228                                    /* stride */ 1,
 229                                    sizeof (ethernet_arp_input_trace_t));
 230
 231   while (n_left_from > 0)
 232     {
 233       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 234
 235       while (n_left_from > 0 && n_left_to_next > 0)
 236         {
 237           const ethernet_arp_header_t *arp0;
 238           arp_input_next_t next0;
 239           vlib_buffer_t *p0;
 240           u32 pi0, error0;
 241
 242           pi0 = to_next[0] = from[0];
 243           from += 1;
 244           to_next += 1;
 245           n_left_from -= 1;
 246           n_left_to_next -= 1;
 247
 248           p0 = vlib_get_buffer (vm, pi0);
 249           arp0 = vlib_buffer_get_current (p0);
 250
 251           error0 = ETHERNET_ARP_ERROR_replies_sent;
 252           next0 = ARP_INPUT_NEXT_DROP;
 253
 254           error0 =
 255             (arp0->l2_type !=
 256              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
 257              ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
 258           error0 =
 259             (arp0->l3_type !=
 260              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
 261              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
 262           error0 =
 263             (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ?
 264              ETHERNET_ARP_ERROR_l3_dst_address_unset : error0);
 265
 266           if (ETHERNET_ARP_ERROR_replies_sent == error0)
 267             {
 268               next0 = ARP_INPUT_NEXT_DISABLED;
 269               vnet_feature_arc_start (am->feature_arc_index,
 270                                       vnet_buffer (p0)->sw_if_index[VLIB_RX],
 271                                       &next0, p0);
 272             }
 273           else
 274             p0->error = node->errors[error0];
 275
 276           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 277                                            n_left_to_next, pi0, next0);
 278         }
 279
 280       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 281     }
 282
 283   return frame->n_vectors;
 284 }
 285
 286 typedef enum arp_disabled_next_t_
 287 {
 288   ARP_DISABLED_NEXT_DROP,
 289   ARP_DISABLED_N_NEXT,
 290 } arp_disabled_next_t;
 291
 292 #define foreach_arp_disabled_error                                      \
 293   _ (DISABLED, "ARP Disabled on this interface")                    \
 294
 295 typedef enum
 296 {
 297 #define _(sym,string) ARP_DISABLED_ERROR_##sym,
 298   foreach_arp_disabled_error
 299 #undef _
 300     ARP_DISABLED_N_ERROR,
 301 } arp_disabled_error_t;
 302
 303 static char *arp_disabled_error_strings[] = {
 304 #define _(sym,string) string,
 305   foreach_arp_disabled_error
 306 #undef _
 307 };
 308
 309 static uword
 310 arp_disabled (vlib_main_t * vm,
 311               vlib_node_runtime_t * node, vlib_frame_t * frame)
 312 {
 313   u32 n_left_from, next_index, *from, *to_next, n_left_to_next;
 314
 315   from = vlib_frame_vector_args (frame);
 316   n_left_from = frame->n_vectors;
 317   next_index = node->cached_next_index;
 318
 319   if (node->flags & VLIB_NODE_FLAG_TRACE)
 320     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 321                                    /* stride */ 1,
 322                                    sizeof (ethernet_arp_input_trace_t));
 323
 324   while (n_left_from > 0)
 325     {
 326       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 327
 328       while (n_left_from > 0 && n_left_to_next > 0)
 329         {
 330           arp_disabled_next_t next0 = ARP_DISABLED_NEXT_DROP;
 331           vlib_buffer_t *p0;
 332           u32 pi0, error0;
 333
 334           next0 = ARP_DISABLED_NEXT_DROP;
 335           error0 = ARP_DISABLED_ERROR_DISABLED;
 336
 337           pi0 = to_next[0] = from[0];
 338           from += 1;
 339           to_next += 1;
 340           n_left_from -= 1;
 341           n_left_to_next -= 1;
 342
 343           p0 = vlib_get_buffer (vm, pi0);
 344           p0->error = node->errors[error0];
 345
 346           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 347                                            n_left_to_next, pi0, next0);
 348         }
 349
 350       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 351     }
 352
 353   return frame->n_vectors;
 354 }
 355
 356 enum arp_dst_fib_type
 357 {
 358   ARP_DST_FIB_NONE,
 359   ARP_DST_FIB_ADJ,
 360   ARP_DST_FIB_CONN
 361 };
 362
 363 /*
 364  * we're looking for FIB sources that indicate the destination
 365  * is attached. There may be interposed DPO prior to the one
 366  * we are looking for
 367  */
 368 static enum arp_dst_fib_type
 369 arp_dst_fib_check (const fib_node_index_t fei, fib_entry_flag_t * flags)
 370 {
 371   const fib_entry_t *entry = fib_entry_get (fei);
 372   const fib_entry_src_t *entry_src;
 373   fib_source_t src;
 374   /* *INDENT-OFF* */
 375   FOR_EACH_SRC_ADDED(entry, entry_src, src,
 376   ({
 377     *flags = fib_entry_get_flags_for_source (fei, src);
 378     if (fib_entry_is_sourced (fei, FIB_SOURCE_ADJ))
 379         return ARP_DST_FIB_ADJ;
 380       else if (FIB_ENTRY_FLAG_CONNECTED & *flags)
 381         return ARP_DST_FIB_CONN;
 382   }))
 383   /* *INDENT-ON* */
 384
 385   return ARP_DST_FIB_NONE;
 386 }
 387
 388 static uword
 389 arp_reply (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
 390 {
 391   vnet_main_t *vnm = vnet_get_main ();
 392   u32 n_left_from, next_index, *from, *to_next;
 393   u32 n_replies_sent = 0;
 394
 395   from = vlib_frame_vector_args (frame);
 396   n_left_from = frame->n_vectors;
 397   next_index = node->cached_next_index;
 398
 399   if (node->flags & VLIB_NODE_FLAG_TRACE)
 400     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
 401                                    /* stride */ 1,
 402                                    sizeof (ethernet_arp_input_trace_t));
 403
 404   while (n_left_from > 0)
 405     {
 406       u32 n_left_to_next;
 407
 408       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 409
 410       while (n_left_from > 0 && n_left_to_next > 0)
 411         {
 412           vlib_buffer_t *p0;
 413           ethernet_arp_header_t *arp0;
 414           ethernet_header_t *eth_rx;
 415           const ip4_address_t *if_addr0;
 416           u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
 417           u8 dst_is_local0, is_vrrp_reply0;
 418           fib_node_index_t dst_fei, src_fei;
 419           const fib_prefix_t *pfx0;
 420           fib_entry_flag_t src_flags, dst_flags;
 421
 422           pi0 = from[0];
 423           to_next[0] = pi0;
 424           from += 1;
 425           to_next += 1;
 426           n_left_from -= 1;
 427           n_left_to_next -= 1;
 428
 429           p0 = vlib_get_buffer (vm, pi0);
 430           arp0 = vlib_buffer_get_current (p0);
 431           /* Fill in ethernet header. */
 432           eth_rx = ethernet_buffer_get_header (p0);
 433
 434           next0 = ARP_REPLY_NEXT_DROP;
 435           error0 = ETHERNET_ARP_ERROR_replies_sent;
 436           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
 437
 438           /* Check that IP address is local and matches incoming interface. */
 439           fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
 440           if (~0 == fib_index0)
 441             {
 442               error0 = ETHERNET_ARP_ERROR_interface_no_table;
 443               goto drop;
 444
 445             }
 446
 447           {
 448             /*
 449              * we're looking for FIB entries that indicate the source
 450              * is attached. There may be more specific non-attached
 451              * routes that match the source, but these do not influence
 452              * whether we respond to an ARP request, i.e. they do not
 453              * influence whether we are the correct way for the sender
 454              * to reach us, they only affect how we reach the sender.
 455              */
 456             fib_entry_t *src_fib_entry;
 457             const fib_prefix_t *pfx;
 458             fib_entry_src_t *src;
 459             fib_source_t source;
 460             int attached;
 461             int mask;
 462
 463             mask = 32;
 464             attached = 0;
 465
 466             do
 467               {
 468                 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
 469                                                 &arp0->
 470                                                 ip4_over_ethernet[0].ip4,
 471                                                 mask);
 472                 src_fib_entry = fib_entry_get (src_fei);
 473
 474                 /*
 475                  * It's possible that the source that provides the
 476                  * flags we need, or the flags we must not have,
 477                  * is not the best source, so check then all.
 478                  */
 479                 /* *INDENT-OFF* */
 480                 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
 481                 ({
 482                   src_flags = fib_entry_get_flags_for_source (src_fei, source);
 483
 484                   /* Reject requests/replies with our local interface
 485                      address. */
 486                   if (FIB_ENTRY_FLAG_LOCAL & src_flags)
 487                     {
 488                       error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
 489                       /*
 490                        * When VPP has an interface whose address is also
 491                        * applied to a TAP interface on the host, then VPP's
 492                        * TAP interface will be unnumbered  to the 'real'
 493                        * interface and do proxy ARP from the host.
 494                        * The curious aspect of this setup is that ARP requests
 495                        * from the host will come from the VPP's own address.
 496                        * So don't drop immediately here, instead go see if this
 497                        * is a proxy ARP case.
 498                        */
 499                       goto next_feature;
 500                     }
 501                   /* A Source must also be local to subnet of matching
 502                    * interface address. */
 503                   if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
 504                       (FIB_ENTRY_FLAG_CONNECTED & src_flags))
 505                     {
 506                       attached = 1;
 507                       break;
 508                     }
 509                   /*
 510                    * else
 511                    *  The packet was sent from an address that is not
 512                    *  connected nor attached i.e. it is not from an
 513                    *  address that is covered by a link's sub-net,
 514                    *  nor is it a already learned host resp.
 515                    */
 516                 }));
 517                 /* *INDENT-ON* */
 518
 519                 /*
 520                  * shorter mask lookup for the next iteration.
 521                  */
 522                 pfx = fib_entry_get_prefix (src_fei);
 523                 mask = pfx->fp_len - 1;
 524
 525                 /*
 526                  * continue until we hit the default route or we find
 527                  * the attached we are looking for. The most likely
 528                  * outcome is we find the attached with the first source
 529                  * on the first lookup.
 530                  */
 531               }
 532             while (!attached &&
 533                    !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
 534
 535             if (!attached)
 536               {
 537                 /*
 538                  * the matching route is a not attached, i.e. it was
 539                  * added as a result of routing, rather than interface/ARP
 540                  * configuration. If the matching route is not a host route
 541                  * (i.e. a /32)
 542                  */
 543                 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
 544                 goto drop;
 545               }
 546           }
 547
 548           dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
 549                                           &arp0->ip4_over_ethernet[1].ip4,
 550                                           32);
 551           conn_sw_if_index0 = fib_entry_get_any_resolving_interface (dst_fei);
 552
 553           switch (arp_dst_fib_check (dst_fei, &dst_flags))
 554             {
 555             case ARP_DST_FIB_ADJ:
 556               /*
 557                * We matched an adj-fib on ths source subnet (a /32 previously
 558                * added as a result of ARP). If this request is a gratuitous
 559                * ARP, then learn from it.
 560                * The check for matching an adj-fib, is to prevent hosts
 561                * from spamming us with gratuitous ARPS that might otherwise
 562                * blow our ARP cache
 563                */
 564               if (conn_sw_if_index0 != sw_if_index0)
 565                 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
 566               else if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
 567                        arp0->ip4_over_ethernet[1].ip4.as_u32)
 568                 error0 = arp_learn (sw_if_index0,
 569                                     &arp0->ip4_over_ethernet[0]);
 570               goto drop;
 571             case ARP_DST_FIB_CONN:
 572               /* destination is connected, continue to process */
 573               break;
 574             case ARP_DST_FIB_NONE:
 575               /* destination is not connected, stop here */
 576               error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
 577               goto next_feature;
 578             }
 579
 580           dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
 581           pfx0 = fib_entry_get_prefix (dst_fei);
 582           if_addr0 = &pfx0->fp_addr.ip4;
 583
 584           is_vrrp_reply0 =
 585             ((arp0->opcode ==
 586               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
 587              &&
 588              (!memcmp
 589               (arp0->ip4_over_ethernet[0].mac.bytes, vrrp_prefix,
 590                sizeof (vrrp_prefix))));
 591
 592           /* Trash ARP packets whose ARP-level source addresses do not
 593              match their L2-frame-level source addresses, unless it's
 594              a reply from a VRRP virtual router */
 595           if (!ethernet_mac_address_equal
 596               (eth_rx->src_address,
 597                arp0->ip4_over_ethernet[0].mac.bytes) && !is_vrrp_reply0)
 598             {
 599               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
 600               goto drop;
 601             }
 602
 603           /* Learn or update sender's mapping only for replies to addresses
 604            * that are local to the subnet */
 605           if (arp0->opcode ==
 606               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
 607             {
 608               if (dst_is_local0)
 609                 error0 =
 610                   arp_learn (sw_if_index0, &arp0->ip4_over_ethernet[0]);
 611               else
 612                 /* a reply for a non-local destination could be a GARP.
 613                  * GARPs for hosts we know were handled above, so this one
 614                  * we drop */
 615                 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
 616
 617               goto next_feature;
 618             }
 619           else if (arp0->opcode ==
 620                    clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
 621                    (dst_is_local0 == 0))
 622             {
 623               goto next_feature;
 624             }
 625
 626           /* Honor unnumbered interface, if any */
 627           if (sw_if_index0 != conn_sw_if_index0 ||
 628               sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
 629             {
 630               /*
 631                * The interface the ARP is sent to or was received on is not the
 632                * interface on which the covering prefix is configured.
 633                * Maybe this is a case for unnumbered.
 634                */
 635               if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
 636                 {
 637                   error0 = ETHERNET_ARP_ERROR_unnumbered_mismatch;
 638                   goto drop;
 639                 }
 640             }
 641           if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
 642               arp0->ip4_over_ethernet[1].ip4.as_u32)
 643             {
 644               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
 645               goto drop;
 646             }
 647
 648           next0 = arp_mk_reply (vnm, p0, sw_if_index0,
 649                                 if_addr0, arp0, eth_rx);
 650
 651           /* We are going to reply to this request, so, in the absence of
 652              errors, learn the sender */
 653           if (!error0)
 654             error0 = arp_learn (sw_if_index0, &arp0->ip4_over_ethernet[1]);
 655
 656           n_replies_sent += 1;
 657           goto enqueue;
 658
 659         next_feature:
 660           vnet_feature_next (&next0, p0);
 661           goto enqueue;
 662
 663         drop:
 664           p0->error = node->errors[error0];
 665
 666         enqueue:
 667           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
 668                                            n_left_to_next, pi0, next0);
 669         }
 670
 671       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 672     }
 673
 674   vlib_error_count (vm, node->node_index,
 675                     ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
 676
 677   return frame->n_vectors;
 678 }
 679
 680
 681 static char *ethernet_arp_error_strings[] = {
 682 #define _(sym,string) string,
 683   foreach_ethernet_arp_error
 684 #undef _
 685 };
 686
 687 /* *INDENT-OFF* */
 688
 689 VLIB_REGISTER_NODE (arp_input_node, static) =
 690 {
 691   .function = arp_input,
 692   .name = "arp-input",
 693   .vector_size = sizeof (u32),
 694   .n_errors = ETHERNET_ARP_N_ERROR,
 695   .error_strings = ethernet_arp_error_strings,
 696   .n_next_nodes = ARP_INPUT_N_NEXT,
 697   .next_nodes = {
 698     [ARP_INPUT_NEXT_DROP] = "error-drop",
 699     [ARP_INPUT_NEXT_DISABLED] = "arp-disabled",
 700   },
 701   .format_buffer = format_ethernet_arp_header,
 702   .format_trace = format_ethernet_arp_input_trace,
 703 };
 704
 705 VLIB_REGISTER_NODE (arp_disabled_node, static) =
 706 {
 707   .function = arp_disabled,
 708   .name = "arp-disabled",
 709   .vector_size = sizeof (u32),
 710   .n_errors = ARP_DISABLED_N_ERROR,
 711   .error_strings = arp_disabled_error_strings,
 712   .n_next_nodes = ARP_DISABLED_N_NEXT,
 713   .next_nodes = {
 714     [ARP_INPUT_NEXT_DROP] = "error-drop",
 715   },
 716   .format_buffer = format_ethernet_arp_header,
 717   .format_trace = format_ethernet_arp_input_trace,
 718 };
 719
 720 VLIB_REGISTER_NODE (arp_reply_node, static) =
 721 {
 722   .function = arp_reply,
 723   .name = "arp-reply",
 724   .vector_size = sizeof (u32),
 725   .n_errors = ETHERNET_ARP_N_ERROR,
 726   .error_strings = ethernet_arp_error_strings,
 727   .n_next_nodes = ARP_REPLY_N_NEXT,
 728   .next_nodes = {
 729     [ARP_REPLY_NEXT_DROP] = "error-drop",
 730     [ARP_REPLY_NEXT_REPLY_TX] = "interface-output",
 731   },
 732   .format_buffer = format_ethernet_arp_header,
 733   .format_trace = format_ethernet_arp_input_trace,
 734 };
 735
 736 /* Built-in ARP rx feature path definition */
 737 VNET_FEATURE_ARC_INIT (arp_feat, static) =
 738 {
 739   .arc_name = "arp",
 740   .start_nodes = VNET_FEATURES ("arp-input"),
 741   .last_in_arc = "error-drop",
 742   .arc_index_ptr = &ethernet_arp_main.feature_arc_index,
 743 };
 744
 745 VNET_FEATURE_INIT (arp_reply_feat_node, static) =
 746 {
 747   .arc_name = "arp",
 748   .node_name = "arp-reply",
 749   .runs_before = VNET_FEATURES ("arp-disabled"),
 750 };
 751
 752 VNET_FEATURE_INIT (arp_proxy_feat_node, static) =
 753 {
 754   .arc_name = "arp",
 755   .node_name = "arp-proxy",
 756   .runs_after = VNET_FEATURES ("arp-reply"),
 757   .runs_before = VNET_FEATURES ("arp-disabled"),
 758 };
 759
 760 VNET_FEATURE_INIT (arp_disabled_feat_node, static) =
 761 {
 762   .arc_name = "arp",
 763   .node_name = "arp-disabled",
 764   .runs_before = VNET_FEATURES ("error-drop"),
 765 };
 766
 767 VNET_FEATURE_INIT (arp_drop_feat_node, static) =
 768 {
 769   .arc_name = "arp",
 770   .node_name = "error-drop",
 771   .runs_before = 0,     /* last feature */
 772 };
 773
 774 /* *INDENT-ON* */
 775
 776 typedef struct
 777 {
 778   pg_edit_t l2_type, l3_type;
 779   pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
 780   pg_edit_t opcode;
 781   struct
 782   {
 783     pg_edit_t mac;
 784     pg_edit_t ip4;
 785   } ip4_over_ethernet[2];
 786 } pg_ethernet_arp_header_t;
 787
 788 static inline void
 789 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
 790 {
 791   /* Initialize fields that are not bit fields in the IP header. */
 792 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
 793   _(l2_type);
 794   _(l3_type);
 795   _(n_l2_address_bytes);
 796   _(n_l3_address_bytes);
 797   _(opcode);
 798   _(ip4_over_ethernet[0].mac);
 799   _(ip4_over_ethernet[0].ip4);
 800   _(ip4_over_ethernet[1].mac);
 801   _(ip4_over_ethernet[1].ip4);
 802 #undef _
 803 }
 804
 805 uword
 806 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
 807 {
 808   pg_stream_t *s = va_arg (*args, pg_stream_t *);
 809   pg_ethernet_arp_header_t *p;
 810   u32 group_index;
 811
 812   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
 813                             &group_index);
 814   pg_ethernet_arp_header_init (p);
 815
 816   /* Defaults. */
 817   pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
 818   pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
 819   pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
 820   pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
 821
 822   if (!unformat (input, "%U: %U/%U -> %U/%U",
 823                  unformat_pg_edit,
 824                  unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
 825                  unformat_pg_edit,
 826                  unformat_mac_address_t, &p->ip4_over_ethernet[0].mac,
 827                  unformat_pg_edit,
 828                  unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
 829                  unformat_pg_edit,
 830                  unformat_mac_address_t, &p->ip4_over_ethernet[1].mac,
 831                  unformat_pg_edit,
 832                  unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
 833     {
 834       /* Free up any edits we may have added. */
 835       pg_free_edit_group (s);
 836       return 0;
 837     }
 838   return 1;
 839 }
 840
 841 /*
 842  * callback when an interface address is added or deleted
 843  */
 844 static void
 845 arp_enable_disable_interface (ip4_main_t * im,
 846                               uword opaque, u32 sw_if_index, u32 is_enable)
 847 {
 848   ethernet_arp_main_t *am = &ethernet_arp_main;
 849
 850   if (is_enable)
 851     arp_enable (am, sw_if_index);
 852   else
 853     arp_disable (am, sw_if_index);
 854 }
 855
 856 /*
 857  * Remove any arp entries associated with the specified interface
 858  */
 859 static clib_error_t *
 860 vnet_arp_add_del_sw_interface (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
 861 {
 862   ethernet_arp_main_t *am = &ethernet_arp_main;
 863   if (is_add)
 864     arp_disable (am, sw_if_index);
 865   return (NULL);
 866 }
 867
 868 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (vnet_arp_add_del_sw_interface);
 869
 870 const static ip_neighbor_vft_t arp_vft = {
 871   .inv_proxy4_add = arp_proxy_add,
 872   .inv_proxy4_del = arp_proxy_del,
 873   .inv_proxy4_enable = arp_proxy_disable,
 874   .inv_proxy4_disable = arp_proxy_disable,
 875 };
 876
 877 static clib_error_t *
 878 ethernet_arp_init (vlib_main_t * vm)
 879 {
 880   ethernet_arp_main_t *am = &ethernet_arp_main;
 881   ip4_main_t *im = &ip4_main;
 882   pg_node_t *pn;
 883
 884   ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
 885
 886   pn = pg_get_node (arp_input_node.index);
 887   pn->unformat_edit = unformat_pg_arp_header;
 888
 889   am->opcode_by_name = hash_create_string (0, sizeof (uword));
 890 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
 891   foreach_ethernet_arp_opcode;
 892 #undef _
 893
 894   /* don't trace ARP error packets */
 895   {
 896     vlib_node_runtime_t *rt =
 897       vlib_node_get_runtime (vm, arp_input_node.index);
 898
 899 #define _(a,b)                                  \
 900     vnet_pcap_drop_trace_filter_add_del         \
 901         (rt->errors[ETHERNET_ARP_ERROR_##a],    \
 902          1 /* is_add */);
 903     foreach_ethernet_arp_error
 904 #undef _
 905   }
 906
 907   {
 908     ip4_enable_disable_interface_callback_t cb = {
 909       .function = arp_enable_disable_interface,
 910     };
 911     vec_add1 (im->enable_disable_interface_callbacks, cb);
 912   }
 913
 914   ip_neighbor_register (AF_IP4, &arp_vft);
 915
 916   return 0;
 917 }
 918
 919 /* *INDENT-OFF* */
 920 VLIB_INIT_FUNCTION (ethernet_arp_init) =
 921 {
 922   .runs_after = VLIB_INITS("ethernet_init",
 923                            "ip_neighbor_init"),
 924 };
 925 /* *INDENT-ON* */
 926
 927 /*
 928  * fd.io coding-style-patch-verification: ON
 929  *
 930  * Local Variables:
 931  * eval: (c-set-style "gnu")
 932  * End:
 933  */