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