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