ARP reply: use interface to build rewrite string
[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%U",
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                                       DPO_PROTO_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   _ (gratuitous_arp, "ARP probe or announcement dropped") \
791   _ (interface_no_table, "Interface is not mapped to an IP table") \
792   _ (interface_not_ip_enabled, "Interface is not IP enabled") \
793
794 typedef enum
795 {
796 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
797   foreach_ethernet_arp_error
798 #undef _
799     ETHERNET_ARP_N_ERROR,
800 } ethernet_arp_input_error_t;
801
802
803 static void
804 unset_random_arp_entry (void)
805 {
806   ethernet_arp_main_t *am = &ethernet_arp_main;
807   ethernet_arp_ip4_entry_t *e;
808   vnet_main_t *vnm = vnet_get_main ();
809   ethernet_arp_ip4_over_ethernet_address_t delme;
810   u32 index;
811
812   index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
813   am->arp_delete_rotor = index;
814
815   /* Try again from elt 0, could happen if an intfc goes down */
816   if (index == ~0)
817     {
818       index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
819       am->arp_delete_rotor = index;
820     }
821
822   /* Nothing left in the pool */
823   if (index == ~0)
824     return;
825
826   e = pool_elt_at_index (am->ip4_entry_pool, index);
827
828   clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
829   delme.ip4.as_u32 = e->ip4_address.as_u32;
830
831   vnet_arp_unset_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
832 }
833
834 static int
835 arp_unnumbered (vlib_buffer_t * p0,
836                 u32 input_sw_if_index, u32 conn_sw_if_index)
837 {
838   vnet_main_t *vnm = vnet_get_main ();
839   vnet_interface_main_t *vim = &vnm->interface_main;
840   vnet_sw_interface_t *si;
841
842   /* verify that the input interface is unnumbered to the connected.
843    * the connected interface is the interface on which the subnet is
844    * configured */
845   si = &vim->sw_interfaces[input_sw_if_index];
846
847   if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
848         (si->unnumbered_sw_if_index == conn_sw_if_index)))
849     {
850       /* the input interface is not unnumbered to the interface on which
851        * the sub-net is configured that covers the ARP request.
852        * So this is not the case for unnumbered.. */
853       return 0;
854     }
855
856   return !0;
857 }
858
859 static u32
860 arp_learn (vnet_main_t * vnm,
861            ethernet_arp_main_t * am, u32 sw_if_index, void *addr)
862 {
863   if (am->limit_arp_cache_size &&
864       pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
865     unset_random_arp_entry ();
866
867   vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
868   return (ETHERNET_ARP_ERROR_l3_src_address_learned);
869 }
870
871 static uword
872 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
873 {
874   ethernet_arp_main_t *am = &ethernet_arp_main;
875   vnet_main_t *vnm = vnet_get_main ();
876   ip4_main_t *im4 = &ip4_main;
877   u32 n_left_from, next_index, *from, *to_next;
878   u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
879
880   from = vlib_frame_vector_args (frame);
881   n_left_from = frame->n_vectors;
882   next_index = node->cached_next_index;
883
884   if (node->flags & VLIB_NODE_FLAG_TRACE)
885     vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
886                                    /* stride */ 1,
887                                    sizeof (ethernet_arp_input_trace_t));
888
889   while (n_left_from > 0)
890     {
891       u32 n_left_to_next;
892
893       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
894
895       while (n_left_from > 0 && n_left_to_next > 0)
896         {
897           vlib_buffer_t *p0;
898           vnet_hw_interface_t *hw_if0;
899           ethernet_arp_header_t *arp0;
900           ethernet_header_t *eth_rx, *eth_tx;
901           ip4_address_t *if_addr0, proxy_src;
902           u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
903           u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
904           ethernet_proxy_arp_t *pa;
905           fib_node_index_t dst_fei, src_fei;
906           fib_prefix_t pfx0;
907           fib_entry_flag_t src_flags, dst_flags;
908           u8 *rewrite0, rewrite0_len;
909
910           pi0 = from[0];
911           to_next[0] = pi0;
912           from += 1;
913           to_next += 1;
914           n_left_from -= 1;
915           n_left_to_next -= 1;
916           pa = 0;
917
918           p0 = vlib_get_buffer (vm, pi0);
919           arp0 = vlib_buffer_get_current (p0);
920           /* Fill in ethernet header. */
921           eth_rx = ethernet_buffer_get_header (p0);
922
923           is_request0 = arp0->opcode
924             == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
925
926           error0 = ETHERNET_ARP_ERROR_replies_sent;
927
928           error0 =
929             (arp0->l2_type !=
930              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
931              ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
932           error0 =
933             (arp0->l3_type !=
934              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
935              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
936
937           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
938
939           /* not playing the ARP game if the interface is not IPv4 enabled */
940           error0 =
941             (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
942              ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
943
944           if (error0)
945             goto drop2;
946
947           /* Check that IP address is local and matches incoming interface. */
948           fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
949           if (~0 == fib_index0)
950             {
951               error0 = ETHERNET_ARP_ERROR_interface_no_table;
952               goto drop2;
953
954             }
955           dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
956                                           &arp0->ip4_over_ethernet[1].ip4,
957                                           32);
958           dst_flags = fib_entry_get_flags (dst_fei);
959
960           conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
961
962           /* Honor unnumbered interface, if any */
963           is_unnum0 = sw_if_index0 != conn_sw_if_index0;
964
965           {
966             /*
967              * we're looking for FIB entries that indicate the source
968              * is attached. There may be more specific non-attached
969              * routes tht match the source, but these do not influence
970              * whether we respond to an ARP request, i.e. they do not
971              * influence whether we are the correct way for the sender
972              * to reach us, they only affect how we reach the sender.
973              */
974             fib_entry_t *src_fib_entry;
975             fib_entry_src_t *src;
976             fib_source_t source;
977             fib_prefix_t pfx;
978             int attached;
979             int mask;
980
981             mask = 32;
982             attached = 0;
983
984             do
985               {
986                 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
987                                                 &arp0->
988                                                 ip4_over_ethernet[0].ip4,
989                                                 mask);
990                 src_fib_entry = fib_entry_get (src_fei);
991
992                 /*
993                  * It's possible that the source that provides the
994                  * flags we need, or the flags we must not have,
995                  * is not the best source, so check then all.
996                  */
997                 /* *INDENT-OFF* */
998                 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
999                 ({
1000                   src_flags = fib_entry_get_flags_for_source (src_fei, source);
1001
1002                   /* Reject requests/replies with our local interface
1003                      address. */
1004                   if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1005                     {
1006                       error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1007                       goto drop2;
1008                     }
1009                   /* A Source must also be local to subnet of matching
1010                    * interface address. */
1011                   if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1012                       (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1013                     {
1014                       attached = 1;
1015                       break;
1016                     }
1017                   /*
1018                    * else
1019                    *  The packet was sent from an address that is not
1020                    *  connected nor attached i.e. it is not from an
1021                    *  address that is covered by a link's sub-net,
1022                    *  nor is it a already learned host resp.
1023                    */
1024                 }));
1025                 /* *INDENT-ON* */
1026
1027                 /*
1028                  * shorter mask lookup for the next iteration.
1029                  */
1030                 fib_entry_get_prefix (src_fei, &pfx);
1031                 mask = pfx.fp_len - 1;
1032
1033                 /*
1034                  * continue until we hit the default route or we find
1035                  * the attached we are looking for. The most likely
1036                  * outcome is we find the attached with the first source
1037                  * on the first lookup.
1038                  */
1039               }
1040             while (!attached &&
1041                    !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1042
1043             if (!attached)
1044               {
1045                 /*
1046                  * the matching route is a not attached, i.e. it was
1047                  * added as a result of routing, rather than interface/ARP
1048                  * configuration. If the matching route is not a host route
1049                  * (i.e. a /32)
1050                  */
1051                 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1052                 goto drop2;
1053               }
1054           }
1055
1056           if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1057             {
1058               error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1059               goto drop1;
1060             }
1061
1062           if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1063             {
1064               /*
1065                * The interface the ARP was received on is not the interface
1066                * on which the covering prefix is configured. Maybe this is a
1067                * case for unnumbered.
1068                */
1069               is_unnum0 = 1;
1070             }
1071
1072           dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1073           fib_entry_get_prefix (dst_fei, &pfx0);
1074           if_addr0 = &pfx0.fp_addr.ip4;
1075
1076           is_vrrp_reply0 =
1077             ((arp0->opcode ==
1078               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1079              &&
1080              (!memcmp
1081               (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1082                sizeof (vrrp_prefix))));
1083
1084           /* Trash ARP packets whose ARP-level source addresses do not
1085              match their L2-frame-level source addresses, unless it's
1086              a reply from a VRRP virtual router */
1087           if (memcmp
1088               (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1089                sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1090             {
1091               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1092               goto drop2;
1093             }
1094
1095           /* Learn or update sender's mapping only for replies to addresses
1096            * that are local to the subnet */
1097           if (arp0->opcode ==
1098               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply) &&
1099               dst_is_local0)
1100             {
1101               error0 = arp_learn (vnm, am, sw_if_index0,
1102                                   &arp0->ip4_over_ethernet[0]);
1103               goto drop1;
1104             }
1105
1106         send_reply:
1107           /* Send a reply.
1108              An adjacency to the sender is not always present,
1109              so we use the interface to build us a rewrite string
1110              which will contain all the necessary tags. */
1111           rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1112                                              VNET_LINK_ARP,
1113                                              eth_rx->src_address);
1114           rewrite0_len = vec_len (rewrite0);
1115
1116           /* Figure out how much to rewind current data from adjacency. */
1117           vlib_buffer_advance (p0, -rewrite0_len);
1118           eth_tx = vlib_buffer_get_current (p0);
1119
1120           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1121           hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1122
1123           /* Send reply back through input interface */
1124           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1125           next0 = ARP_INPUT_NEXT_REPLY_TX;
1126
1127           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1128
1129           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1130
1131           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1132                        hw_if0->hw_address, 6);
1133           clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1134             if_addr0->data_u32;
1135
1136           /* Hardware must be ethernet-like. */
1137           ASSERT (vec_len (hw_if0->hw_address) == 6);
1138
1139           /* the rx nd tx ethernet headers wil overlap in the case
1140            * when we received a tagged VLAN=0 packet, but we are sending
1141            * back untagged */
1142           clib_memcpy (eth_tx, rewrite0, vec_len (rewrite0));
1143           vec_free (rewrite0);
1144
1145           if (NULL == pa)
1146             {
1147               if (is_unnum0)
1148                 {
1149                   if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1150                     goto drop2;
1151                 }
1152             }
1153
1154           /* We are going to reply to this request, so learn the sender */
1155           error0 = arp_learn (vnm, am, sw_if_index0,
1156                               &arp0->ip4_over_ethernet[1]);
1157
1158           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1159                                            n_left_to_next, pi0, next0);
1160
1161           n_replies_sent += 1;
1162           continue;
1163
1164         drop1:
1165           if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
1166               (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1167                arp0->ip4_over_ethernet[1].ip4.as_u32))
1168             {
1169               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1170               goto drop2;
1171             }
1172           /* See if proxy arp is configured for the address */
1173           if (is_request0)
1174             {
1175               vnet_sw_interface_t *si;
1176               u32 this_addr = clib_net_to_host_u32
1177                 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1178               u32 fib_index0;
1179
1180               si = vnet_get_sw_interface (vnm, sw_if_index0);
1181
1182               if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1183                 goto drop2;
1184
1185               fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1186                                     sw_if_index0);
1187
1188               vec_foreach (pa, am->proxy_arps)
1189               {
1190                 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr);
1191                 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr);
1192
1193                 /* an ARP request hit in the proxy-arp table? */
1194                 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1195                     (fib_index0 == pa->fib_index))
1196                   {
1197                     proxy_src.as_u32 =
1198                       arp0->ip4_over_ethernet[1].ip4.data_u32;
1199
1200                     /*
1201                      * change the interface address to the proxied
1202                      */
1203                     if_addr0 = &proxy_src;
1204                     is_unnum0 = 0;
1205                     n_proxy_arp_replies_sent++;
1206                     goto send_reply;
1207                   }
1208               }
1209             }
1210
1211         drop2:
1212
1213           next0 = ARP_INPUT_NEXT_DROP;
1214           p0->error = node->errors[error0];
1215
1216           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1217                                            n_left_to_next, pi0, next0);
1218         }
1219
1220       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1221     }
1222
1223   vlib_error_count (vm, node->node_index,
1224                     ETHERNET_ARP_ERROR_replies_sent,
1225                     n_replies_sent - n_proxy_arp_replies_sent);
1226
1227   vlib_error_count (vm, node->node_index,
1228                     ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1229                     n_proxy_arp_replies_sent);
1230   return frame->n_vectors;
1231 }
1232
1233 static char *ethernet_arp_error_strings[] = {
1234 #define _(sym,string) string,
1235   foreach_ethernet_arp_error
1236 #undef _
1237 };
1238
1239 /* *INDENT-OFF* */
1240 VLIB_REGISTER_NODE (arp_input_node, static) =
1241 {
1242   .function = arp_input,
1243   .name = "arp-input",
1244   .vector_size = sizeof (u32),
1245   .n_errors = ETHERNET_ARP_N_ERROR,
1246   .error_strings = ethernet_arp_error_strings,
1247   .n_next_nodes = ARP_INPUT_N_NEXT,
1248   .next_nodes = {
1249     [ARP_INPUT_NEXT_DROP] = "error-drop",
1250     [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1251   },
1252   .format_buffer = format_ethernet_arp_header,
1253   .format_trace = format_ethernet_arp_input_trace,
1254 };
1255 /* *INDENT-ON* */
1256
1257 static int
1258 ip4_arp_entry_sort (void *a1, void *a2)
1259 {
1260   ethernet_arp_ip4_entry_t *e1 = a1;
1261   ethernet_arp_ip4_entry_t *e2 = a2;
1262
1263   int cmp;
1264   vnet_main_t *vnm = vnet_get_main ();
1265
1266   cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1267   if (!cmp)
1268     cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1269   return cmp;
1270 }
1271
1272 ethernet_arp_ip4_entry_t *
1273 ip4_neighbor_entries (u32 sw_if_index)
1274 {
1275   ethernet_arp_main_t *am = &ethernet_arp_main;
1276   ethernet_arp_ip4_entry_t *n, *ns = 0;
1277
1278   /* *INDENT-OFF* */
1279   pool_foreach (n, am->ip4_entry_pool, ({
1280     if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1281       continue;
1282     vec_add1 (ns, n[0]);
1283   }));
1284   /* *INDENT-ON* */
1285
1286   if (ns)
1287     vec_sort_with_function (ns, ip4_arp_entry_sort);
1288   return ns;
1289 }
1290
1291 static clib_error_t *
1292 show_ip4_arp (vlib_main_t * vm,
1293               unformat_input_t * input, vlib_cli_command_t * cmd)
1294 {
1295   vnet_main_t *vnm = vnet_get_main ();
1296   ethernet_arp_main_t *am = &ethernet_arp_main;
1297   ethernet_arp_ip4_entry_t *e, *es;
1298   ethernet_proxy_arp_t *pa;
1299   clib_error_t *error = 0;
1300   u32 sw_if_index;
1301
1302   /* Filter entries by interface if given. */
1303   sw_if_index = ~0;
1304   (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1305
1306   es = ip4_neighbor_entries (sw_if_index);
1307   if (es)
1308     {
1309       vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1310       vec_foreach (e, es)
1311       {
1312         vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1313       }
1314       vec_free (es);
1315     }
1316
1317   if (vec_len (am->proxy_arps))
1318     {
1319       vlib_cli_output (vm, "Proxy arps enabled for:");
1320       vec_foreach (pa, am->proxy_arps)
1321       {
1322         vlib_cli_output (vm, "Fib_index %d   %U - %U ",
1323                          pa->fib_index,
1324                          format_ip4_address, &pa->lo_addr,
1325                          format_ip4_address, &pa->hi_addr);
1326       }
1327     }
1328
1329   return error;
1330 }
1331
1332 /*?
1333  * Display all the IPv4 ARP entries.
1334  *
1335  * @cliexpar
1336  * Example of how to display the IPv4 ARP table:
1337  * @cliexstart{show ip arp}
1338  *    Time      FIB        IP4       Flags      Ethernet              Interface
1339  *    346.3028   0       6.1.1.3            de:ad:be:ef:ba:be   GigabitEthernet2/0/0
1340  *   3077.4271   0       6.1.1.4       S    de:ad:be:ef:ff:ff   GigabitEthernet2/0/0
1341  *   2998.6409   1       6.2.2.3            de:ad:be:ef:00:01   GigabitEthernet2/0/0
1342  * Proxy arps enabled for:
1343  * Fib_index 0   6.0.0.1 - 6.0.0.11
1344  * @cliexend
1345  ?*/
1346 /* *INDENT-OFF* */
1347 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1348   .path = "show ip arp",
1349   .function = show_ip4_arp,
1350   .short_help = "show ip arp",
1351 };
1352 /* *INDENT-ON* */
1353
1354 typedef struct
1355 {
1356   pg_edit_t l2_type, l3_type;
1357   pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1358   pg_edit_t opcode;
1359   struct
1360   {
1361     pg_edit_t ethernet;
1362     pg_edit_t ip4;
1363   } ip4_over_ethernet[2];
1364 } pg_ethernet_arp_header_t;
1365
1366 static inline void
1367 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1368 {
1369   /* Initialize fields that are not bit fields in the IP header. */
1370 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1371   _(l2_type);
1372   _(l3_type);
1373   _(n_l2_address_bytes);
1374   _(n_l3_address_bytes);
1375   _(opcode);
1376   _(ip4_over_ethernet[0].ethernet);
1377   _(ip4_over_ethernet[0].ip4);
1378   _(ip4_over_ethernet[1].ethernet);
1379   _(ip4_over_ethernet[1].ip4);
1380 #undef _
1381 }
1382
1383 uword
1384 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1385 {
1386   pg_stream_t *s = va_arg (*args, pg_stream_t *);
1387   pg_ethernet_arp_header_t *p;
1388   u32 group_index;
1389
1390   p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1391                             &group_index);
1392   pg_ethernet_arp_header_init (p);
1393
1394   /* Defaults. */
1395   pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1396   pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1397   pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1398   pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1399
1400   if (!unformat (input, "%U: %U/%U -> %U/%U",
1401                  unformat_pg_edit,
1402                  unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1403                  unformat_pg_edit,
1404                  unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1405                  unformat_pg_edit,
1406                  unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1407                  unformat_pg_edit,
1408                  unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1409                  unformat_pg_edit,
1410                  unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1411     {
1412       /* Free up any edits we may have added. */
1413       pg_free_edit_group (s);
1414       return 0;
1415     }
1416   return 1;
1417 }
1418
1419 clib_error_t *
1420 ip4_set_arp_limit (u32 arp_limit)
1421 {
1422   ethernet_arp_main_t *am = &ethernet_arp_main;
1423
1424   am->limit_arp_cache_size = arp_limit;
1425   return 0;
1426 }
1427
1428 /**
1429  * @brief Control Plane hook to remove an ARP entry
1430  */
1431 int
1432 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1433                                   u32 sw_if_index, void *a_arg)
1434 {
1435   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1436   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1437
1438   args.sw_if_index = sw_if_index;
1439   args.flags = ETHERNET_ARP_ARGS_REMOVE;
1440   clib_memcpy (&args.a, a, sizeof (*a));
1441
1442   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1443                                (u8 *) & args, sizeof (args));
1444   return 0;
1445 }
1446
1447 /**
1448  * @brief Internally generated event to flush the ARP cache on an
1449  * interface state change event.
1450  * A flush will remove dynamic ARP entries, and for statics remove the MAC
1451  * address from the corresponding adjacencies.
1452  */
1453 static int
1454 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1455                                   u32 sw_if_index, void *a_arg)
1456 {
1457   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1458   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1459
1460   args.sw_if_index = sw_if_index;
1461   args.flags = ETHERNET_ARP_ARGS_FLUSH;
1462   clib_memcpy (&args.a, a, sizeof (*a));
1463
1464   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1465                                (u8 *) & args, sizeof (args));
1466   return 0;
1467 }
1468
1469 /**
1470  * @brief Internally generated event to populate the ARP cache on an
1471  * interface state change event.
1472  * For static entries this will re-source the adjacencies.
1473  *
1474  * @param sw_if_index The interface on which the ARP entires are acted
1475  */
1476 static int
1477 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1478                                      u32 sw_if_index, void *a_arg)
1479 {
1480   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1481   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1482
1483   args.sw_if_index = sw_if_index;
1484   args.flags = ETHERNET_ARP_ARGS_POPULATE;
1485   clib_memcpy (&args.a, a, sizeof (*a));
1486
1487   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1488                                (u8 *) & args, sizeof (args));
1489   return 0;
1490 }
1491
1492 /*
1493  * arp_add_del_interface_address
1494  *
1495  * callback when an interface address is added or deleted
1496  */
1497 static void
1498 arp_add_del_interface_address (ip4_main_t * im,
1499                                uword opaque,
1500                                u32 sw_if_index,
1501                                ip4_address_t * address,
1502                                u32 address_length,
1503                                u32 if_address_index, u32 is_del)
1504 {
1505   /*
1506    * Flush the ARP cache of all entries covered by the address
1507    * that is being removed.
1508    */
1509   ethernet_arp_main_t *am = &ethernet_arp_main;
1510   ethernet_arp_ip4_entry_t *e;
1511
1512   if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1513     return;
1514
1515   if (is_del)
1516     {
1517       ethernet_arp_interface_t *eai;
1518       u32 i, *to_delete = 0;
1519       hash_pair_t *pair;
1520
1521       eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1522
1523       /* *INDENT-OFF* */
1524       hash_foreach_pair (pair, eai->arp_entries,
1525       ({
1526         e = pool_elt_at_index(am->ip4_entry_pool,
1527                               pair->value[0]);
1528         if (ip4_destination_matches_route (im, &e->ip4_address,
1529                                            address, address_length))
1530           {
1531             vec_add1 (to_delete, e - am->ip4_entry_pool);
1532           }
1533       }));
1534       /* *INDENT-ON* */
1535
1536       for (i = 0; i < vec_len (to_delete); i++)
1537         {
1538           ethernet_arp_ip4_over_ethernet_address_t delme;
1539           e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1540
1541           clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1542           delme.ip4.as_u32 = e->ip4_address.as_u32;
1543
1544           vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1545                                             e->sw_if_index, &delme);
1546         }
1547
1548       vec_free (to_delete);
1549     }
1550 }
1551
1552 static clib_error_t *
1553 ethernet_arp_init (vlib_main_t * vm)
1554 {
1555   ethernet_arp_main_t *am = &ethernet_arp_main;
1556   ip4_main_t *im = &ip4_main;
1557   clib_error_t *error;
1558   pg_node_t *pn;
1559
1560   if ((error = vlib_call_init_function (vm, ethernet_init)))
1561     return error;
1562
1563   ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1564
1565   pn = pg_get_node (arp_input_node.index);
1566   pn->unformat_edit = unformat_pg_arp_header;
1567
1568   am->opcode_by_name = hash_create_string (0, sizeof (uword));
1569 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1570   foreach_ethernet_arp_opcode;
1571 #undef _
1572
1573   /* $$$ configurable */
1574   am->limit_arp_cache_size = 50000;
1575
1576   am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1577   am->mac_changes_by_address = hash_create (0, sizeof (uword));
1578
1579   /* don't trace ARP error packets */
1580   {
1581     vlib_node_runtime_t *rt =
1582       vlib_node_get_runtime (vm, arp_input_node.index);
1583
1584 #define _(a,b)                                  \
1585     vnet_pcap_drop_trace_filter_add_del         \
1586         (rt->errors[ETHERNET_ARP_ERROR_##a],    \
1587          1 /* is_add */);
1588     foreach_ethernet_arp_error
1589 #undef _
1590   }
1591
1592   ip4_add_del_interface_address_callback_t cb;
1593   cb.function = arp_add_del_interface_address;
1594   cb.function_opaque = 0;
1595   vec_add1 (im->add_del_interface_address_callbacks, cb);
1596
1597   return 0;
1598 }
1599
1600 VLIB_INIT_FUNCTION (ethernet_arp_init);
1601
1602 static void
1603 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1604 {
1605   ethernet_arp_main_t *am = &ethernet_arp_main;
1606
1607   if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
1608     {
1609       fib_prefix_t pfx = {
1610         .fp_len = 32,
1611         .fp_proto = FIB_PROTOCOL_IP4,
1612         .fp_addr.ip4 = e->ip4_address,
1613       };
1614       u32 fib_index;
1615
1616       fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
1617
1618       fib_table_entry_path_remove (fib_index, &pfx,
1619                                    FIB_SOURCE_ADJ,
1620                                    DPO_PROTO_IP4,
1621                                    &pfx.fp_addr,
1622                                    e->sw_if_index, ~0, 1,
1623                                    FIB_ROUTE_PATH_FLAG_NONE);
1624     }
1625   hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1626   pool_put (am->ip4_entry_pool, e);
1627 }
1628
1629 static inline int
1630 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1631                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1632                                            * args)
1633 {
1634   ethernet_arp_main_t *am = &ethernet_arp_main;
1635   ethernet_arp_ip4_entry_t *e;
1636   ethernet_arp_interface_t *eai;
1637
1638   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1639
1640   e = arp_entry_find (eai, &args->a.ip4);
1641
1642   if (NULL != e)
1643     {
1644       arp_entry_free (eai, e);
1645
1646       adj_nbr_walk_nh4 (e->sw_if_index,
1647                         &e->ip4_address, arp_mk_incomplete_walk, NULL);
1648     }
1649
1650   return 0;
1651 }
1652
1653 static int
1654 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1655                                            vnet_arp_set_ip4_over_ethernet_rpc_args_t
1656                                            * args)
1657 {
1658   ethernet_arp_main_t *am = &ethernet_arp_main;
1659   ethernet_arp_ip4_entry_t *e;
1660   ethernet_arp_interface_t *eai;
1661
1662   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1663
1664   e = arp_entry_find (eai, &args->a.ip4);
1665
1666   if (NULL != e)
1667     {
1668       adj_nbr_walk_nh4 (e->sw_if_index,
1669                         &e->ip4_address, arp_mk_incomplete_walk, e);
1670
1671       /*
1672        * The difference between flush and unset, is that an unset
1673        * means delete for static and dynamic entries. A flush
1674        * means delete only for dynamic. Flushing is what the DP
1675        * does in response to interface events. unset is only done
1676        * by the control plane.
1677        */
1678       if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1679         {
1680           arp_entry_free (eai, e);
1681         }
1682     }
1683   return (0);
1684 }
1685
1686 static int
1687 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1688                                               vnet_arp_set_ip4_over_ethernet_rpc_args_t
1689                                               * args)
1690 {
1691   ethernet_arp_main_t *am = &ethernet_arp_main;
1692   ethernet_arp_ip4_entry_t *e;
1693   ethernet_arp_interface_t *eai;
1694
1695   eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1696
1697   e = arp_entry_find (eai, &args->a.ip4);
1698
1699   if (NULL != e)
1700     {
1701       adj_nbr_walk_nh4 (e->sw_if_index,
1702                         &e->ip4_address, arp_mk_complete_walk, e);
1703     }
1704   return (0);
1705 }
1706
1707 static void
1708 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1709                                     * a)
1710 {
1711   vnet_main_t *vm = vnet_get_main ();
1712   ASSERT (vlib_get_thread_index () == 0);
1713
1714   if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1715     vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1716   else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1717     vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1718   else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1719     vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1720   else
1721     vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1722 }
1723
1724 /**
1725  * @brief Invoked when the interface's admin state changes
1726  */
1727 static clib_error_t *
1728 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1729                                    u32 sw_if_index, u32 flags)
1730 {
1731   ethernet_arp_main_t *am = &ethernet_arp_main;
1732   ethernet_arp_ip4_entry_t *e;
1733   u32 i, *to_delete = 0;
1734
1735   /* *INDENT-OFF* */
1736   pool_foreach (e, am->ip4_entry_pool,
1737   ({
1738     if (e->sw_if_index == sw_if_index)
1739       vec_add1 (to_delete,
1740                 e - am->ip4_entry_pool);
1741   }));
1742   /* *INDENT-ON* */
1743
1744   for (i = 0; i < vec_len (to_delete); i++)
1745     {
1746       ethernet_arp_ip4_over_ethernet_address_t delme;
1747       e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1748
1749       clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1750       delme.ip4.as_u32 = e->ip4_address.as_u32;
1751
1752       if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1753         {
1754           vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1755         }
1756       else
1757         {
1758           vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1759         }
1760
1761     }
1762   vec_free (to_delete);
1763
1764   return 0;
1765 }
1766
1767 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1768
1769 static void
1770 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1771 {
1772   u8 old;
1773   int i;
1774
1775   for (i = 3; i >= 0; i--)
1776     {
1777       old = a->ip4.as_u8[i];
1778       a->ip4.as_u8[i] += 1;
1779       if (old < a->ip4.as_u8[i])
1780         break;
1781     }
1782
1783   for (i = 5; i >= 0; i--)
1784     {
1785       old = a->ethernet[i];
1786       a->ethernet[i] += 1;
1787       if (old < a->ethernet[i])
1788         break;
1789     }
1790 }
1791
1792 int
1793 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1794                                 u32 sw_if_index, void *a_arg,
1795                                 int is_static, int is_no_fib_entry)
1796 {
1797   ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1798   vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1799
1800   args.sw_if_index = sw_if_index;
1801   args.is_static = is_static;
1802   args.is_no_fib_entry = is_no_fib_entry;
1803   args.flags = 0;
1804   clib_memcpy (&args.a, a, sizeof (*a));
1805
1806   vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1807                                (u8 *) & args, sizeof (args));
1808   return 0;
1809 }
1810
1811 int
1812 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1813                         ip4_address_t * hi_addr, u32 fib_index, int is_del)
1814 {
1815   ethernet_arp_main_t *am = &ethernet_arp_main;
1816   ethernet_proxy_arp_t *pa;
1817   u32 found_at_index = ~0;
1818
1819   vec_foreach (pa, am->proxy_arps)
1820   {
1821     if (pa->lo_addr == lo_addr->as_u32
1822         && pa->hi_addr == hi_addr->as_u32 && pa->fib_index == fib_index)
1823       {
1824         found_at_index = pa - am->proxy_arps;
1825         break;
1826       }
1827   }
1828
1829   if (found_at_index != ~0)
1830     {
1831       /* Delete, otherwise it's already in the table */
1832       if (is_del)
1833         vec_delete (am->proxy_arps, 1, found_at_index);
1834       return 0;
1835     }
1836   /* delete, no such entry */
1837   if (is_del)
1838     return VNET_API_ERROR_NO_SUCH_ENTRY;
1839
1840   /* add, not in table */
1841   vec_add2 (am->proxy_arps, pa, 1);
1842   pa->lo_addr = lo_addr->as_u32;
1843   pa->hi_addr = hi_addr->as_u32;
1844   pa->fib_index = fib_index;
1845   return 0;
1846 }
1847
1848 /*
1849  * Remove any proxy arp entries asdociated with the
1850  * specificed fib.
1851  */
1852 int
1853 vnet_proxy_arp_fib_reset (u32 fib_id)
1854 {
1855   ethernet_arp_main_t *am = &ethernet_arp_main;
1856   ethernet_proxy_arp_t *pa;
1857   u32 *entries_to_delete = 0;
1858   u32 fib_index;
1859   int i;
1860
1861   fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
1862   if (~0 == fib_index)
1863     return VNET_API_ERROR_NO_SUCH_ENTRY;
1864
1865   vec_foreach (pa, am->proxy_arps)
1866   {
1867     if (pa->fib_index == fib_index)
1868       {
1869         vec_add1 (entries_to_delete, pa - am->proxy_arps);
1870       }
1871   }
1872
1873   for (i = 0; i < vec_len (entries_to_delete); i++)
1874     {
1875       vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
1876     }
1877
1878   vec_free (entries_to_delete);
1879
1880   return 0;
1881 }
1882
1883 static clib_error_t *
1884 ip_arp_add_del_command_fn (vlib_main_t * vm,
1885                            unformat_input_t * input, vlib_cli_command_t * cmd)
1886 {
1887   vnet_main_t *vnm = vnet_get_main ();
1888   u32 sw_if_index;
1889   ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
1890   int addr_valid = 0;
1891   int is_del = 0;
1892   int count = 1;
1893   u32 fib_index = 0;
1894   u32 fib_id;
1895   int is_static = 0;
1896   int is_no_fib_entry = 0;
1897   int is_proxy = 0;
1898
1899   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1900     {
1901       /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
1902       if (unformat (input, "%U %U %U",
1903                     unformat_vnet_sw_interface, vnm, &sw_if_index,
1904                     unformat_ip4_address, &addr.ip4,
1905                     unformat_ethernet_address, &addr.ethernet))
1906         addr_valid = 1;
1907
1908       else if (unformat (input, "delete") || unformat (input, "del"))
1909         is_del = 1;
1910
1911       else if (unformat (input, "static"))
1912         is_static = 1;
1913
1914       else if (unformat (input, "no-fib-entry"))
1915         is_no_fib_entry = 1;
1916
1917       else if (unformat (input, "count %d", &count))
1918         ;
1919
1920       else if (unformat (input, "fib-id %d", &fib_id))
1921         {
1922           fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
1923
1924           if (~0 == fib_index)
1925             return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
1926         }
1927
1928       else if (unformat (input, "proxy %U - %U",
1929                          unformat_ip4_address, &lo_addr.ip4,
1930                          unformat_ip4_address, &hi_addr.ip4))
1931         is_proxy = 1;
1932       else
1933         break;
1934     }
1935
1936   if (is_proxy)
1937     {
1938       (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
1939                                      fib_index, is_del);
1940       return 0;
1941     }
1942
1943   if (addr_valid)
1944     {
1945       int i;
1946
1947       for (i = 0; i < count; i++)
1948         {
1949           if (is_del == 0)
1950             {
1951               uword event_type, *event_data = 0;
1952
1953               /* Park the debug CLI until the arp entry is installed */
1954               vnet_register_ip4_arp_resolution_event
1955                 (vnm, &addr.ip4, vlib_current_process (vm),
1956                  1 /* type */ , 0 /* data */ );
1957
1958               vnet_arp_set_ip4_over_ethernet
1959                 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
1960
1961               vlib_process_wait_for_event (vm);
1962               event_type = vlib_process_get_events (vm, &event_data);
1963               vec_reset_length (event_data);
1964               if (event_type != 1)
1965                 clib_warning ("event type %d unexpected", event_type);
1966             }
1967           else
1968             vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
1969
1970           increment_ip4_and_mac_address (&addr);
1971         }
1972     }
1973   else
1974     {
1975       return clib_error_return (0, "unknown input `%U'",
1976                                 format_unformat_error, input);
1977     }
1978
1979   return 0;
1980 }
1981
1982 /* *INDENT-OFF* */
1983 /*?
1984  * Add or delete IPv4 ARP cache entries.
1985  *
1986  * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
1987  * 'count <number>', 'interface ip4_addr mac_addr') can be added in
1988  * any order and combination.
1989  *
1990  * @cliexpar
1991  * @parblock
1992  * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
1993  * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
1994  * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
1995  * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
1996  *
1997  * To add or delete an IPv4 ARP cache entry to or from a specific fib
1998  * table:
1999  * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2000  * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2001  *
2002  * Add or delete IPv4 static ARP cache entries as follows:
2003  * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2004  * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2005  *
2006  * For testing / debugging purposes, the 'set ip arp' command can add or
2007  * delete multiple entries. Supply the 'count N' parameter:
2008  * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2009  * @endparblock
2010  ?*/
2011 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2012   .path = "set ip arp",
2013   .short_help =
2014   "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2015   .function = ip_arp_add_del_command_fn,
2016 };
2017 /* *INDENT-ON* */
2018
2019 static clib_error_t *
2020 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2021                               unformat_input_t *
2022                               input, vlib_cli_command_t * cmd)
2023 {
2024   vnet_main_t *vnm = vnet_get_main ();
2025   u32 sw_if_index;
2026   vnet_sw_interface_t *si;
2027   int enable = 0;
2028   int intfc_set = 0;
2029
2030   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2031     {
2032       if (unformat (input, "%U", unformat_vnet_sw_interface,
2033                     vnm, &sw_if_index))
2034         intfc_set = 1;
2035       else if (unformat (input, "enable") || unformat (input, "on"))
2036         enable = 1;
2037       else if (unformat (input, "disable") || unformat (input, "off"))
2038         enable = 0;
2039       else
2040         break;
2041     }
2042
2043   if (intfc_set == 0)
2044     return clib_error_return (0, "unknown input '%U'",
2045                               format_unformat_error, input);
2046
2047   si = vnet_get_sw_interface (vnm, sw_if_index);
2048   ASSERT (si);
2049   if (enable)
2050     si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2051   else
2052     si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2053
2054   return 0;
2055 }
2056
2057 /* *INDENT-OFF* */
2058 /*?
2059  * Enable proxy-arp on an interface. The vpp stack will answer ARP
2060  * requests for the indicated address range. Multiple proxy-arp
2061  * ranges may be provisioned.
2062  *
2063  * @note Proxy ARP as a technology is infamous for blackholing traffic.
2064  * Also, the underlying implementation has not been performance-tuned.
2065  * Avoid creating an unnecessarily large set of ranges.
2066  *
2067  * @cliexpar
2068  * To enable proxy arp on a range of addresses, use:
2069  * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2070  * Append 'del' to delete a range of proxy ARP addresses:
2071  * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2072  * You must then specifically enable proxy arp on individual interfaces:
2073  * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2074  * To disable proxy arp on an individual interface:
2075  * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2076  ?*/
2077 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2078   .path = "set interface proxy-arp",
2079   .short_help =
2080   "set interface proxy-arp <intfc> [enable|disable]",
2081   .function = set_int_proxy_arp_command_fn,
2082 };
2083 /* *INDENT-ON* */
2084
2085
2086 /*
2087  * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2088  * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2089  */
2090 typedef enum
2091 {
2092   ARP_TERM_NEXT_L2_OUTPUT,
2093   ARP_TERM_NEXT_DROP,
2094   ARP_TERM_N_NEXT,
2095 } arp_term_next_t;
2096
2097 u32 arp_term_next_node_index[32];
2098
2099 static uword
2100 arp_term_l2bd (vlib_main_t * vm,
2101                vlib_node_runtime_t * node, vlib_frame_t * frame)
2102 {
2103   l2input_main_t *l2im = &l2input_main;
2104   u32 n_left_from, next_index, *from, *to_next;
2105   u32 n_replies_sent = 0;
2106   u16 last_bd_index = ~0;
2107   l2_bridge_domain_t *last_bd_config = 0;
2108   l2_input_config_t *cfg0;
2109
2110   from = vlib_frame_vector_args (frame);
2111   n_left_from = frame->n_vectors;
2112   next_index = node->cached_next_index;
2113
2114   while (n_left_from > 0)
2115     {
2116       u32 n_left_to_next;
2117
2118       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2119
2120       while (n_left_from > 0 && n_left_to_next > 0)
2121         {
2122           vlib_buffer_t *p0;
2123           ethernet_header_t *eth0;
2124           ethernet_arp_header_t *arp0;
2125           ip6_header_t *iph0;
2126           u8 *l3h0;
2127           u32 pi0, error0, next0, sw_if_index0;
2128           u16 ethertype0;
2129           u16 bd_index0;
2130           u32 ip0;
2131           u8 *macp0;
2132           u8 is_vrrp_reply0;
2133
2134           pi0 = from[0];
2135           to_next[0] = pi0;
2136           from += 1;
2137           to_next += 1;
2138           n_left_from -= 1;
2139           n_left_to_next -= 1;
2140
2141           p0 = vlib_get_buffer (vm, pi0);
2142           // Terminate only local (SHG == 0) ARP
2143           if (vnet_buffer (p0)->l2.shg != 0)
2144             goto next_l2_feature;
2145
2146           eth0 = vlib_buffer_get_current (p0);
2147           l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2148           ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2149           arp0 = (ethernet_arp_header_t *) l3h0;
2150
2151           if (PREDICT_FALSE ((ethertype0 != ETHERNET_TYPE_ARP) ||
2152                              (arp0->opcode !=
2153                               clib_host_to_net_u16
2154                               (ETHERNET_ARP_OPCODE_request))))
2155             goto check_ip6_nd;
2156
2157           /* Must be ARP request packet here */
2158           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2159                              (p0->flags & VLIB_BUFFER_IS_TRACED)))
2160             {
2161               u8 *t0 = vlib_add_trace (vm, node, p0,
2162                                        sizeof (ethernet_arp_input_trace_t));
2163               clib_memcpy (t0, l3h0, sizeof (ethernet_arp_input_trace_t));
2164             }
2165
2166           error0 = ETHERNET_ARP_ERROR_replies_sent;
2167           error0 =
2168             (arp0->l2_type !=
2169              clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2170              ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2171           error0 =
2172             (arp0->l3_type !=
2173              clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2174              ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2175
2176           sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2177
2178           if (error0)
2179             goto drop;
2180
2181           is_vrrp_reply0 =
2182             ((arp0->opcode ==
2183               clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
2184              &&
2185              (!memcmp
2186               (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2187                sizeof (vrrp_prefix))));
2188
2189           /* Trash ARP packets whose ARP-level source addresses do not
2190              match their L2-frame-level source addresses, unless it's
2191              a reply from a VRRP virtual router */
2192           if (PREDICT_FALSE
2193               (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2194                        sizeof (eth0->src_address)) && !is_vrrp_reply0))
2195             {
2196               error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2197               goto drop;
2198             }
2199
2200           /* Check if anyone want ARP request events for L2 BDs */
2201           {
2202             pending_resolution_t *mc;
2203             ethernet_arp_main_t *am = &ethernet_arp_main;
2204             uword *p = hash_get (am->mac_changes_by_address, 0);
2205             if (p)
2206               {
2207                 u32 next_index = p[0];
2208                 while (next_index != (u32) ~ 0)
2209                   {
2210                     int (*fp) (u32, u8 *, u32, u32);
2211                     int rv = 1;
2212                     mc = pool_elt_at_index (am->mac_changes, next_index);
2213                     fp = mc->data_callback;
2214                     /* Call the callback, return 1 to suppress dup events */
2215                     if (fp)
2216                       rv = (*fp) (mc->data,
2217                                   arp0->ip4_over_ethernet[0].ethernet,
2218                                   sw_if_index0,
2219                                   arp0->ip4_over_ethernet[0].ip4.as_u32);
2220                     /* Signal the resolver process */
2221                     if (rv == 0)
2222                       vlib_process_signal_event (vm, mc->node_index,
2223                                                  mc->type_opaque, mc->data);
2224                     next_index = mc->next_index;
2225                   }
2226               }
2227           }
2228
2229           /* lookup BD mac_by_ip4 hash table for MAC entry */
2230           ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2231           bd_index0 = vnet_buffer (p0)->l2.bd_index;
2232           if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2233                              || (last_bd_index == (u16) ~ 0)))
2234             {
2235               last_bd_index = bd_index0;
2236               last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2237             }
2238           macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2239
2240           if (PREDICT_FALSE (!macp0))
2241             goto next_l2_feature;       /* MAC not found */
2242
2243           /* MAC found, send ARP reply -
2244              Convert ARP request packet to ARP reply */
2245           arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2246           arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2247           arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2248           clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2249           clib_memcpy (eth0->dst_address, eth0->src_address, 6);
2250           clib_memcpy (eth0->src_address, macp0, 6);
2251           n_replies_sent += 1;
2252
2253         output_response:
2254           /* For BVI, need to use l2-fwd node to send ARP reply as
2255              l2-output node cannot output packet to BVI properly */
2256           cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2257           if (PREDICT_FALSE (cfg0->bvi))
2258             {
2259               vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2260               vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2261               goto next_l2_feature;
2262             }
2263
2264           /* Send ARP/ND reply back out input interface through l2-output */
2265           vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2266           next0 = ARP_TERM_NEXT_L2_OUTPUT;
2267           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2268                                            to_next, n_left_to_next, pi0,
2269                                            next0);
2270           continue;
2271
2272         check_ip6_nd:
2273           /* IP6 ND event notification or solicitation handling to generate
2274              local response instead of flooding */
2275           iph0 = (ip6_header_t *) l3h0;
2276           if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2277                              iph0->protocol == IP_PROTOCOL_ICMP6 &&
2278                              !ip6_address_is_unspecified
2279                              (&iph0->src_address)))
2280             {
2281               sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2282               if (vnet_ip6_nd_term
2283                   (vm, node, p0, eth0, iph0, sw_if_index0,
2284                    vnet_buffer (p0)->l2.bd_index))
2285                 goto output_response;
2286             }
2287
2288         next_l2_feature:
2289           {
2290             next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2291                                           L2INPUT_FEAT_ARP_TERM);
2292             vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2293                                              to_next, n_left_to_next,
2294                                              pi0, next0);
2295             continue;
2296           }
2297
2298         drop:
2299           if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2300               (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2301                arp0->ip4_over_ethernet[1].ip4.as_u32))
2302             {
2303               error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2304             }
2305           next0 = ARP_TERM_NEXT_DROP;
2306           p0->error = node->errors[error0];
2307
2308           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2309                                            to_next, n_left_to_next, pi0,
2310                                            next0);
2311         }
2312
2313       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2314     }
2315
2316   vlib_error_count (vm, node->node_index,
2317                     ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2318   return frame->n_vectors;
2319 }
2320
2321 /* *INDENT-OFF* */
2322 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2323   .function = arp_term_l2bd,
2324   .name = "arp-term-l2bd",
2325   .vector_size = sizeof (u32),
2326   .n_errors = ETHERNET_ARP_N_ERROR,
2327   .error_strings = ethernet_arp_error_strings,
2328   .n_next_nodes = ARP_TERM_N_NEXT,
2329   .next_nodes = {
2330     [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2331     [ARP_TERM_NEXT_DROP] = "error-drop",
2332   },
2333   .format_buffer = format_ethernet_arp_header,
2334   .format_trace = format_arp_term_input_trace,
2335 };
2336 /* *INDENT-ON* */
2337
2338 clib_error_t *
2339 arp_term_init (vlib_main_t * vm)
2340 {
2341   // Initialize the feature next-node indexes
2342   feat_bitmap_init_next_nodes (vm,
2343                                arp_term_l2bd_node.index,
2344                                L2INPUT_N_FEAT,
2345                                l2input_get_feat_names (),
2346                                arp_term_next_node_index);
2347   return 0;
2348 }
2349
2350 VLIB_INIT_FUNCTION (arp_term_init);
2351
2352 void
2353 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2354 {
2355   if (e->sw_if_index == sw_if_index)
2356     {
2357       adj_nbr_walk_nh4 (e->sw_if_index,
2358                         &e->ip4_address, arp_mk_complete_walk, e);
2359     }
2360 }
2361
2362 void
2363 ethernet_arp_change_mac (u32 sw_if_index)
2364 {
2365   ethernet_arp_main_t *am = &ethernet_arp_main;
2366   ethernet_arp_ip4_entry_t *e;
2367
2368   /* *INDENT-OFF* */
2369   pool_foreach (e, am->ip4_entry_pool,
2370   ({
2371     change_arp_mac (sw_if_index, e);
2372   }));
2373   /* *INDENT-ON* */
2374 }
2375
2376 void static
2377 send_ip4_garp (vlib_main_t * vm, vnet_hw_interface_t * hi)
2378 {
2379   ip4_main_t *i4m = &ip4_main;
2380   u32 sw_if_index = hi->sw_if_index;
2381   ip4_address_t *ip4_addr = ip4_interface_first_address (i4m, sw_if_index, 0);
2382
2383   if (ip4_addr)
2384     {
2385       clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2386                     format_ip4_address, ip4_addr, sw_if_index);
2387
2388       /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2389          where the interface IP/MAC pair is used for both source and request
2390          MAC/IP pairs in the request */
2391       u32 bi = 0;
2392       ethernet_arp_header_t *h = vlib_packet_template_get_packet
2393         (vm, &i4m->ip4_arp_request_packet_template, &bi);
2394       clib_memcpy (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2395                    sizeof (h->ip4_over_ethernet[0].ethernet));
2396       clib_memcpy (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2397                    sizeof (h->ip4_over_ethernet[1].ethernet));
2398       h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2399       h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2400
2401       /* Setup MAC header with ARP Etype and broadcast DMAC */
2402       vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2403       vlib_buffer_advance (b, -sizeof (ethernet_header_t));
2404       ethernet_header_t *e = vlib_buffer_get_current (b);
2405       e->type = clib_host_to_net_u16 (ETHERNET_TYPE_ARP);
2406       clib_memcpy (e->src_address, hi->hw_address, sizeof (e->src_address));
2407       memset (e->dst_address, 0xff, sizeof (e->dst_address));
2408
2409       /* Send GARP packet out the specified interface */
2410       vnet_buffer (b)->sw_if_index[VLIB_RX] =
2411         vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2412       vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2413       u32 *to_next = vlib_frame_vector_args (f);
2414       to_next[0] = bi;
2415       f->n_vectors = 1;
2416       vlib_put_frame_to_node (vm, hi->output_node_index, f);
2417     }
2418 }
2419
2420 static vlib_node_registration_t send_garp_na_proc_node;
2421
2422 static uword
2423 send_garp_na_process (vlib_main_t * vm,
2424                       vlib_node_runtime_t * rt, vlib_frame_t * f)
2425 {
2426   vnet_main_t *vnm = vnet_get_main ();
2427   uword event_type, *event_data = 0;
2428
2429   send_garp_na_process_node_index = send_garp_na_proc_node.index;
2430
2431   while (1)
2432     {
2433       vlib_process_wait_for_event (vm);
2434       event_type = vlib_process_get_events (vm, &event_data);
2435       if ((event_type == SEND_GARP_NA) && (vec_len (event_data) >= 1))
2436         {
2437           u32 hw_if_index = event_data[0];
2438           vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, hw_if_index);
2439           send_ip4_garp (vm, hi);
2440           send_ip6_na (vm, hi);
2441         }
2442       vec_reset_length (event_data);
2443     }
2444   return 0;
2445 }
2446
2447
2448 /* *INDENT-OFF* */
2449 VLIB_REGISTER_NODE (send_garp_na_proc_node, static) = {
2450     .function = send_garp_na_process,
2451     .type = VLIB_NODE_TYPE_PROCESS,
2452     .name = "send-garp-na-process",
2453 };
2454 /* *INDENT-ON* */
2455
2456 /*
2457  * fd.io coding-style-patch-verification: ON
2458  *
2459  * Local Variables:
2460  * eval: (c-set-style "gnu")
2461  * End:
2462  */