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