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