2 * ethernet/arp.c: IP v4 ARP node
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:
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include <vnet/ip/ip.h>
19 #include <vnet/ip/ip_neighbor.h>
20 #include <vnet/ip/ip6.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vnet/ethernet/arp.h>
23 #include <vnet/l2/l2_input.h>
24 #include <vppinfra/mhash.h>
25 #include <vnet/fib/ip4_fib.h>
26 #include <vnet/fib/fib_entry_src.h>
27 #include <vnet/adj/adj_nbr.h>
28 #include <vnet/adj/adj_mcast.h>
29 #include <vnet/mpls/mpls.h>
30 #include <vnet/l2/feat_bitmap.h>
32 #include <vlibmemory/api.h>
38 * This file contains code to manage the IPv4 ARP tables (IP Address
39 * to MAC Address lookup).
44 * @brief Per-interface ARP configuration and state
46 typedef struct ethernet_arp_interface_t_
49 * Hash table of ARP entries.
50 * Since this hash table is per-interface, the key is only the IPv4 address.
54 * Is ARP enabled on this interface
58 * Is Proxy ARP enabled on this interface
61 } ethernet_arp_interface_t;
65 ip4_address_t lo_addr;
66 ip4_address_t hi_addr;
68 } ethernet_proxy_arp_t;
76 /* Used for arp event notification only */
77 arp_change_event_cb_t data_callback;
79 } pending_resolution_t;
83 /* Hash tables mapping name to opcode. */
84 uword *opcode_by_name;
86 /* lite beer "glean" adjacency handling */
87 uword *pending_resolutions_by_address;
88 pending_resolution_t *pending_resolutions;
90 /* Mac address change notification */
91 uword *mac_changes_by_address;
92 pending_resolution_t *mac_changes;
94 ethernet_arp_ip4_entry_t *ip4_entry_pool;
96 /* ARP attack mitigation */
98 u32 limit_arp_cache_size;
100 /** Per interface state */
101 ethernet_arp_interface_t *ethernet_arp_by_sw_if_index;
103 /* Proxy arp vector */
104 ethernet_proxy_arp_t *proxy_arps;
106 uword wc_ip4_arp_publisher_node;
107 uword wc_ip4_arp_publisher_et;
109 /* ARP feature arc index */
110 u8 feature_arc_index;
111 } ethernet_arp_main_t;
113 static ethernet_arp_main_t ethernet_arp_main;
120 ip_neighbor_flags_t nbr_flags;
122 #define ETHERNET_ARP_ARGS_REMOVE (1<<0)
123 #define ETHERNET_ARP_ARGS_FLUSH (1<<1)
124 #define ETHERNET_ARP_ARGS_POPULATE (1<<2)
125 #define ETHERNET_ARP_ARGS_WC_PUB (1<<3)
126 } vnet_arp_set_ip4_over_ethernet_rpc_args_t;
128 static const u8 vrrp_prefix[] = { 0x00, 0x00, 0x5E, 0x00, 0x01 };
130 /* Node index for send_garp_na_process */
131 u32 send_garp_na_process_node_index;
134 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
138 format_ethernet_arp_hardware_type (u8 * s, va_list * va)
140 ethernet_arp_hardware_type_t h = va_arg (*va, ethernet_arp_hardware_type_t);
144 #define _(n,f) case n: t = #f; break;
145 foreach_ethernet_arp_hardware_type;
149 return format (s, "unknown 0x%x", h);
152 return format (s, "%s", t);
156 format_ethernet_arp_opcode (u8 * s, va_list * va)
158 ethernet_arp_opcode_t o = va_arg (*va, ethernet_arp_opcode_t);
162 #define _(f) case ETHERNET_ARP_OPCODE_##f: t = #f; break;
163 foreach_ethernet_arp_opcode;
167 return format (s, "unknown 0x%x", o);
170 return format (s, "%s", t);
174 unformat_ethernet_arp_opcode_host_byte_order (unformat_input_t * input,
177 int *result = va_arg (*args, int *);
178 ethernet_arp_main_t *am = ðernet_arp_main;
181 /* Numeric opcode. */
182 if (unformat (input, "0x%x", &x) || unformat (input, "%d", &x))
191 if (unformat_user (input, unformat_vlib_number_by_name,
192 am->opcode_by_name, &i))
202 unformat_ethernet_arp_opcode_net_byte_order (unformat_input_t * input,
205 int *result = va_arg (*args, int *);
207 (input, unformat_ethernet_arp_opcode_host_byte_order, result))
210 *result = clib_host_to_net_u16 ((u16) * result);
215 format_ethernet_arp_header (u8 * s, va_list * va)
217 ethernet_arp_header_t *a = va_arg (*va, ethernet_arp_header_t *);
218 u32 max_header_bytes = va_arg (*va, u32);
220 u16 l2_type, l3_type;
222 if (max_header_bytes != 0 && sizeof (a[0]) > max_header_bytes)
223 return format (s, "ARP header truncated");
225 l2_type = clib_net_to_host_u16 (a->l2_type);
226 l3_type = clib_net_to_host_u16 (a->l3_type);
228 indent = format_get_indent (s);
230 s = format (s, "%U, type %U/%U, address size %d/%d",
231 format_ethernet_arp_opcode, clib_net_to_host_u16 (a->opcode),
232 format_ethernet_arp_hardware_type, l2_type,
233 format_ethernet_type, l3_type,
234 a->n_l2_address_bytes, a->n_l3_address_bytes);
236 if (l2_type == ETHERNET_ARP_HARDWARE_TYPE_ethernet
237 && l3_type == ETHERNET_TYPE_IP4)
239 s = format (s, "\n%U%U/%U -> %U/%U",
240 format_white_space, indent,
241 format_mac_address_t, &a->ip4_over_ethernet[0].mac,
242 format_ip4_address, &a->ip4_over_ethernet[0].ip4,
243 format_mac_address_t, &a->ip4_over_ethernet[1].mac,
244 format_ip4_address, &a->ip4_over_ethernet[1].ip4);
248 uword n2 = a->n_l2_address_bytes;
249 uword n3 = a->n_l3_address_bytes;
250 s = format (s, "\n%U%U/%U -> %U/%U",
251 format_white_space, indent,
252 format_hex_bytes, a->data + 0 * n2 + 0 * n3, n2,
253 format_hex_bytes, a->data + 1 * n2 + 0 * n3, n3,
254 format_hex_bytes, a->data + 1 * n2 + 1 * n3, n2,
255 format_hex_bytes, a->data + 2 * n2 + 1 * n3, n3);
262 format_ethernet_arp_ip4_entry (u8 * s, va_list * va)
264 vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
265 ethernet_arp_ip4_entry_t *e = va_arg (*va, ethernet_arp_ip4_entry_t *);
266 vnet_sw_interface_t *si;
269 return format (s, "%=12s%=16s%=6s%=20s%=24s", "Time", "IP4",
270 "Flags", "Ethernet", "Interface");
272 si = vnet_get_sw_interface (vnm, e->sw_if_index);
274 return format (s, "%=12U%=16U%=6U%=20U%U",
275 format_vlib_time, vnm->vlib_main, e->time_last_updated,
276 format_ip4_address, &e->ip4_address,
277 format_ip_neighbor_flags, e->flags,
278 format_mac_address_t, &e->mac,
279 format_vnet_sw_interface_name, vnm, si);
285 } ethernet_arp_input_trace_t;
288 format_ethernet_arp_input_trace (u8 * s, va_list * va)
290 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
291 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
292 ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
295 format_ethernet_arp_header,
296 t->packet_data, sizeof (t->packet_data));
302 format_arp_term_input_trace (u8 * s, va_list * va)
304 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
305 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
306 ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
308 /* arp-term trace data saved is either arp or ip6/icmp6 packet:
309 - for arp, the 1st 16-bit field is hw type of value of 0x0001.
310 - for ip6, the first nibble has value of 6. */
311 s = format (s, "%U", t->packet_data[0] == 0 ?
312 format_ethernet_arp_header : format_ip6_header,
313 t->packet_data, sizeof (t->packet_data));
319 arp_nbr_probe (ip_adjacency_t * adj)
321 vnet_main_t *vnm = vnet_get_main ();
322 ip4_main_t *im = &ip4_main;
323 ip_interface_address_t *ia;
324 ethernet_arp_header_t *h;
325 vnet_hw_interface_t *hi;
326 vnet_sw_interface_t *si;
332 vm = vlib_get_main ();
334 si = vnet_get_sw_interface (vnm, adj->rewrite_header.sw_if_index);
336 if (!(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
342 ip4_interface_address_matching_destination (im,
343 &adj->sub_type.nbr.next_hop.
353 vlib_packet_template_get_packet (vm, &im->ip4_arp_request_packet_template,
358 hi = vnet_get_sup_hw_interface (vnm, adj->rewrite_header.sw_if_index);
360 mac_address_from_bytes (&h->ip4_over_ethernet[0].mac, hi->hw_address);
362 h->ip4_over_ethernet[0].ip4 = src[0];
363 h->ip4_over_ethernet[1].ip4 = adj->sub_type.nbr.next_hop.ip4;
365 b = vlib_get_buffer (vm, bi);
366 vnet_buffer (b)->sw_if_index[VLIB_RX] =
367 vnet_buffer (b)->sw_if_index[VLIB_TX] = adj->rewrite_header.sw_if_index;
369 /* Add encapsulation string for software interface (e.g. ethernet header). */
370 vnet_rewrite_one_header (adj[0], h, sizeof (ethernet_header_t));
371 vlib_buffer_advance (b, -adj->rewrite_header.data_bytes);
374 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
375 u32 *to_next = vlib_frame_vector_args (f);
378 vlib_put_frame_to_node (vm, hi->output_node_index, f);
383 arp_mk_complete (adj_index_t ai, ethernet_arp_ip4_entry_t * e)
385 adj_nbr_update_rewrite
386 (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
387 ethernet_build_rewrite (vnet_get_main (),
389 adj_get_link_type (ai), &e->mac));
393 arp_mk_incomplete (adj_index_t ai)
395 ip_adjacency_t *adj = adj_get (ai);
397 adj_nbr_update_rewrite
399 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
400 ethernet_build_rewrite (vnet_get_main (),
401 adj->rewrite_header.sw_if_index,
403 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
406 static ethernet_arp_ip4_entry_t *
407 arp_entry_find (ethernet_arp_interface_t * eai, const ip4_address_t * addr)
409 ethernet_arp_main_t *am = ðernet_arp_main;
410 ethernet_arp_ip4_entry_t *e = NULL;
413 if (NULL != eai->arp_entries)
415 p = hash_get (eai->arp_entries, addr->as_u32);
419 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
426 arp_mk_complete_walk (adj_index_t ai, void *ctx)
428 ethernet_arp_ip4_entry_t *e = ctx;
430 arp_mk_complete (ai, e);
432 return (ADJ_WALK_RC_CONTINUE);
436 arp_mk_incomplete_walk (adj_index_t ai, void *ctx)
438 arp_mk_incomplete (ai);
440 return (ADJ_WALK_RC_CONTINUE);
444 arp_is_enabled (ethernet_arp_main_t * am, u32 sw_if_index)
446 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
449 return (am->ethernet_arp_by_sw_if_index[sw_if_index].enabled);
453 arp_enable (ethernet_arp_main_t * am, u32 sw_if_index)
455 if (arp_is_enabled (am, sw_if_index))
458 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
460 am->ethernet_arp_by_sw_if_index[sw_if_index].enabled = 1;
462 vnet_feature_enable_disable ("arp", "arp-reply", sw_if_index, 1, NULL, 0);
463 vnet_feature_enable_disable ("arp", "arp-disabled", sw_if_index, 0, NULL,
468 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
469 vnet_arp_set_ip4_over_ethernet_rpc_args_t
473 arp_disable (ethernet_arp_main_t * am, u32 sw_if_index)
475 ethernet_arp_interface_t *eai;
476 ethernet_arp_ip4_entry_t *e;
477 u32 i, *to_delete = 0;
480 if (!arp_is_enabled (am, sw_if_index))
483 vnet_feature_enable_disable ("arp", "arp-disabled", sw_if_index, 1, NULL,
485 vnet_feature_enable_disable ("arp", "arp-reply", sw_if_index, 0, NULL, 0);
487 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
491 hash_foreach_pair (pair, eai->arp_entries,
493 e = pool_elt_at_index(am->ip4_entry_pool,
495 vec_add1 (to_delete, e - am->ip4_entry_pool);
499 for (i = 0; i < vec_len (to_delete); i++)
501 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
503 vnet_arp_set_ip4_over_ethernet_rpc_args_t delme = {
504 .ip4.as_u32 = e->ip4_address.as_u32,
505 .sw_if_index = e->sw_if_index,
506 .flags = ETHERNET_ARP_ARGS_FLUSH,
508 mac_address_copy (&delme.mac, &e->mac);
510 vnet_arp_flush_ip4_over_ethernet_internal (vnet_get_main (), &delme);
513 vec_free (to_delete);
519 arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
521 ethernet_arp_main_t *am = ðernet_arp_main;
522 ethernet_arp_interface_t *arp_int;
523 ethernet_arp_ip4_entry_t *e;
528 arp_enable (am, sw_if_index);
529 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
530 e = arp_entry_find (arp_int, &adj->sub_type.nbr.next_hop.ip4);
532 switch (adj->lookup_next_index)
534 case IP_LOOKUP_NEXT_GLEAN:
535 adj_glean_update_rewrite (ai);
537 case IP_LOOKUP_NEXT_ARP:
540 adj_nbr_walk_nh4 (sw_if_index,
541 &e->ip4_address, arp_mk_complete_walk, e);
546 * no matching ARP entry.
547 * construct the rewrite required to for an ARP packet, and stick
548 * that in the adj's pipe to smoke.
550 adj_nbr_update_rewrite
552 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
553 ethernet_build_rewrite
557 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
560 * since the FIB has added this adj for a route, it makes sense it
561 * may want to forward traffic sometime soon. Let's send a
562 * speculative ARP. just one. If we were to do periodically that
563 * wouldn't be bad either, but that's more code than i'm prepared to
564 * write at this time for relatively little reward.
569 case IP_LOOKUP_NEXT_BCAST:
570 adj_nbr_update_rewrite (ai,
571 ADJ_NBR_REWRITE_FLAG_COMPLETE,
572 ethernet_build_rewrite
576 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
578 case IP_LOOKUP_NEXT_MCAST:
581 * Construct a partial rewrite from the known ethernet mcast dest MAC
586 rewrite = ethernet_build_rewrite (vnm,
589 ethernet_ip4_mcast_dst_addr ());
590 offset = vec_len (rewrite) - 2;
593 * Complete the remaining fields of the adj's rewrite to direct the
594 * complete of the rewrite at switch time by copying in the IP
595 * dst address's bytes.
596 * Offset is 2 bytes into the MAC destination address.
598 adj_mcast_update_rewrite (ai, rewrite, offset);
602 case IP_LOOKUP_NEXT_DROP:
603 case IP_LOOKUP_NEXT_PUNT:
604 case IP_LOOKUP_NEXT_LOCAL:
605 case IP_LOOKUP_NEXT_REWRITE:
606 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
607 case IP_LOOKUP_NEXT_MIDCHAIN:
608 case IP_LOOKUP_NEXT_ICMP_ERROR:
609 case IP_LOOKUP_N_NEXT:
616 arp_adj_fib_add (ethernet_arp_ip4_entry_t * e, u32 fib_index)
620 .fp_proto = FIB_PROTOCOL_IP4,
621 .fp_addr.ip4 = e->ip4_address,
625 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
626 FIB_ENTRY_FLAG_ATTACHED,
627 DPO_PROTO_IP4, &pfx.fp_addr,
628 e->sw_if_index, ~0, 1, NULL,
629 FIB_ROUTE_PATH_FLAG_NONE);
630 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
634 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
636 if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
640 .fp_proto = FIB_PROTOCOL_IP4,
641 .fp_addr.ip4 = e->ip4_address,
645 fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
647 fib_table_entry_path_remove (fib_index, &pfx,
651 e->sw_if_index, ~0, 1,
652 FIB_ROUTE_PATH_FLAG_NONE);
653 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
657 static ethernet_arp_ip4_entry_t *
658 force_reuse_arp_entry (void)
660 ethernet_arp_ip4_entry_t *e;
661 ethernet_arp_main_t *am = ðernet_arp_main;
663 u32 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
664 if (index == ~0) /* Try again from elt 0 */
665 index = pool_next_index (am->ip4_entry_pool, index);
667 /* Find a non-static random entry to free up for reuse */
670 if ((count++ == 100) || (index == ~0))
671 return NULL; /* give up after 100 entries */
672 e = pool_elt_at_index (am->ip4_entry_pool, index);
673 am->arp_delete_rotor = index;
674 index = pool_next_index (am->ip4_entry_pool, index);
676 while (e->flags & IP_NEIGHBOR_FLAG_STATIC);
678 /* Remove ARP entry from its interface and update fib */
680 (am->ethernet_arp_by_sw_if_index[e->sw_if_index].arp_entries,
681 e->ip4_address.as_u32);
683 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
684 adj_nbr_walk_nh4 (e->sw_if_index,
685 &e->ip4_address, arp_mk_incomplete_walk, e);
690 vnet_arp_set_ip4_over_ethernet_internal (vnet_main_t * vnm,
691 vnet_arp_set_ip4_over_ethernet_rpc_args_t
694 ethernet_arp_ip4_entry_t *e = 0;
695 ethernet_arp_main_t *am = ðernet_arp_main;
696 vlib_main_t *vm = vlib_get_main ();
697 int make_new_arp_cache_entry = 1;
699 pending_resolution_t *pr, *mc;
700 ethernet_arp_interface_t *arp_int;
701 u32 sw_if_index = args->sw_if_index;
703 arp_enable (am, sw_if_index);
705 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
707 if (NULL != arp_int->arp_entries)
709 p = hash_get (arp_int->arp_entries, args->ip4.as_u32);
712 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
714 /* Refuse to over-write static arp. */
715 if (!(args->nbr_flags & IP_NEIGHBOR_FLAG_STATIC) &&
716 (e->flags & IP_NEIGHBOR_FLAG_STATIC))
718 /* if MAC address match, still check to send event */
719 if (mac_address_equal (&e->mac, &args->mac))
720 goto check_customers;
723 make_new_arp_cache_entry = 0;
727 if (make_new_arp_cache_entry)
729 if (am->limit_arp_cache_size &&
730 pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
732 e = force_reuse_arp_entry ();
737 pool_get (am->ip4_entry_pool, e);
739 if (NULL == arp_int->arp_entries)
740 arp_int->arp_entries = hash_create (0, sizeof (u32));
742 hash_set (arp_int->arp_entries, args->ip4.as_u32,
743 e - am->ip4_entry_pool);
745 e->sw_if_index = sw_if_index;
746 e->ip4_address = args->ip4;
747 e->fib_entry_index = FIB_NODE_INDEX_INVALID;
748 mac_address_copy (&e->mac, &args->mac);
750 if (!(args->nbr_flags & IP_NEIGHBOR_FLAG_NO_FIB_ENTRY))
753 ip4_fib_table_get_index_for_sw_if_index
758 e->flags |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
764 * prevent a DoS attack from the data-plane that
765 * spams us with no-op updates to the MAC address
767 if (mac_address_equal (&e->mac, &args->mac))
769 e->time_last_updated = vlib_time_now (vm);
770 goto check_customers;
773 /* Update ethernet address. */
774 mac_address_copy (&e->mac, &args->mac);
777 /* Update time stamp and flags. */
778 e->time_last_updated = vlib_time_now (vm);
779 if (args->nbr_flags & IP_NEIGHBOR_FLAG_STATIC)
781 e->flags &= ~IP_NEIGHBOR_FLAG_DYNAMIC;
782 e->flags |= IP_NEIGHBOR_FLAG_STATIC;
786 e->flags &= ~IP_NEIGHBOR_FLAG_STATIC;
787 e->flags |= IP_NEIGHBOR_FLAG_DYNAMIC;
790 adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
793 /* Customer(s) waiting for this address to be resolved? */
794 p = hash_get (am->pending_resolutions_by_address, args->ip4.as_u32);
800 while (next_index != (u32) ~ 0)
802 pr = pool_elt_at_index (am->pending_resolutions, next_index);
803 vlib_process_signal_event (vm, pr->node_index,
804 pr->type_opaque, pr->data);
805 next_index = pr->next_index;
806 pool_put (am->pending_resolutions, pr);
809 hash_unset (am->pending_resolutions_by_address, args->ip4.as_u32);
812 /* Customer(s) requesting ARP event for this address? */
813 p = hash_get (am->mac_changes_by_address, args->ip4.as_u32);
819 while (next_index != (u32) ~ 0)
822 mc = pool_elt_at_index (am->mac_changes, next_index);
824 /* Call the user's data callback, return 1 to suppress dup events */
825 if (mc->data_callback)
826 rv = (mc->data_callback) (mc->data, &args->mac, sw_if_index, 0);
829 * Signal the resolver process, as long as the user
830 * says they want to be notified
833 vlib_process_signal_event (vm, mc->node_index,
834 mc->type_opaque, mc->data);
835 next_index = mc->next_index;
843 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
846 uword type_opaque, uword data)
848 ethernet_arp_main_t *am = ðernet_arp_main;
849 ip4_address_t *address = address_arg;
851 pending_resolution_t *pr;
853 pool_get (am->pending_resolutions, pr);
856 pr->node_index = node_index;
857 pr->type_opaque = type_opaque;
859 pr->data_callback = 0;
861 p = hash_get (am->pending_resolutions_by_address, address->as_u32);
864 /* Insert new resolution at the head of the list */
865 pr->next_index = p[0];
866 hash_unset (am->pending_resolutions_by_address, address->as_u32);
869 hash_set (am->pending_resolutions_by_address, address->as_u32,
870 pr - am->pending_resolutions);
874 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
875 arp_change_event_cb_t data_callback,
879 uword type_opaque, uword data, int is_add)
881 ethernet_arp_main_t *am = ðernet_arp_main;
882 ip4_address_t *address = address_arg;
884 /* Try to find an existing entry */
885 u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
887 pending_resolution_t *mc;
888 while (p && *p != ~0)
890 mc = pool_elt_at_index (am->mac_changes, *p);
891 if (mc->node_index == node_index && mc->type_opaque == type_opaque
897 int found = p && *p != ~0;
901 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
903 pool_get (am->mac_changes, mc);
905 *mc = (pending_resolution_t)
908 .node_index = node_index,
909 .type_opaque = type_opaque,
911 .data_callback = data_callback,
916 /* Insert new resolution at the end of the list */
917 u32 new_idx = mc - am->mac_changes;
921 hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
926 return VNET_API_ERROR_NO_SUCH_ENTRY;
928 /* Clients may need to clean up pool entries, too */
930 /* no new mac addrs */
931 (data_callback) (mc->data, NULL, ~0, NULL);
933 /* Remove the entry from the list and delete the entry */
935 pool_put (am->mac_changes, mc);
937 /* Remove from hash if we deleted the last entry */
938 if (*p == ~0 && p == first)
939 hash_unset (am->mac_changes_by_address, address->as_u32);
944 /* Either we drop the packet or we send a reply to the sender. */
948 ARP_REPLY_NEXT_REPLY_TX,
952 #define foreach_ethernet_arp_error \
953 _ (replies_sent, "ARP replies sent") \
954 _ (l2_type_not_ethernet, "L2 type not ethernet") \
955 _ (l3_type_not_ip4, "L3 type not IP4") \
956 _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
957 _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
958 _ (l3_dst_address_unset, "IP4 destination address is unset") \
959 _ (l3_src_address_is_local, "IP4 source address matches local interface") \
960 _ (l3_src_address_learned, "ARP request IP4 source address learned") \
961 _ (replies_received, "ARP replies received") \
962 _ (opcode_not_request, "ARP opcode not request") \
963 _ (proxy_arp_replies_sent, "Proxy ARP replies sent") \
964 _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
965 _ (gratuitous_arp, "ARP probe or announcement dropped") \
966 _ (interface_no_table, "Interface is not mapped to an IP table") \
967 _ (interface_not_ip_enabled, "Interface is not IP enabled") \
968 _ (unnumbered_mismatch, "RX interface is unnumbered to different subnet") \
972 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
973 foreach_ethernet_arp_error
975 ETHERNET_ARP_N_ERROR,
976 } ethernet_arp_reply_error_t;
979 arp_unnumbered (vlib_buffer_t * p0,
980 u32 input_sw_if_index, u32 conn_sw_if_index)
982 vnet_main_t *vnm = vnet_get_main ();
983 vnet_interface_main_t *vim = &vnm->interface_main;
984 vnet_sw_interface_t *si;
986 /* verify that the input interface is unnumbered to the connected.
987 * the connected interface is the interface on which the subnet is
989 si = &vim->sw_interfaces[input_sw_if_index];
991 if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
992 (si->unnumbered_sw_if_index == conn_sw_if_index)))
994 /* the input interface is not unnumbered to the interface on which
995 * the sub-net is configured that covers the ARP request.
996 * So this is not the case for unnumbered.. */
1004 arp_learn (vnet_main_t * vnm,
1005 ethernet_arp_main_t * am, u32 sw_if_index,
1006 const ethernet_arp_ip4_over_ethernet_address_t * addr)
1008 vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0);
1009 return (ETHERNET_ARP_ERROR_l3_src_address_learned);
1012 typedef enum arp_input_next_t_
1014 ARP_INPUT_NEXT_DROP,
1015 ARP_INPUT_NEXT_DISABLED,
1020 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
1022 u32 n_left_from, next_index, *from, *to_next, n_left_to_next;
1023 ethernet_arp_main_t *am = ðernet_arp_main;
1025 from = vlib_frame_vector_args (frame);
1026 n_left_from = frame->n_vectors;
1027 next_index = node->cached_next_index;
1029 if (node->flags & VLIB_NODE_FLAG_TRACE)
1030 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
1032 sizeof (ethernet_arp_input_trace_t));
1034 while (n_left_from > 0)
1036 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1038 while (n_left_from > 0 && n_left_to_next > 0)
1040 const ethernet_arp_header_t *arp0;
1041 arp_input_next_t next0;
1045 pi0 = to_next[0] = from[0];
1049 n_left_to_next -= 1;
1051 p0 = vlib_get_buffer (vm, pi0);
1052 arp0 = vlib_buffer_get_current (p0);
1054 error0 = ETHERNET_ARP_ERROR_replies_sent;
1055 next0 = ARP_INPUT_NEXT_DROP;
1059 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
1060 ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
1063 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
1064 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
1066 (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ?
1067 ETHERNET_ARP_ERROR_l3_dst_address_unset : error0);
1069 if (ETHERNET_ARP_ERROR_replies_sent == error0)
1071 next0 = ARP_INPUT_NEXT_DISABLED;
1072 vnet_feature_arc_start (am->feature_arc_index,
1073 vnet_buffer (p0)->sw_if_index[VLIB_RX],
1077 p0->error = node->errors[error0];
1079 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1080 n_left_to_next, pi0, next0);
1083 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1086 return frame->n_vectors;
1089 typedef enum arp_disabled_next_t_
1091 ARP_DISABLED_NEXT_DROP,
1092 ARP_DISABLED_N_NEXT,
1093 } arp_disabled_next_t;
1095 #define foreach_arp_disabled_error \
1096 _ (DISABLED, "ARP Disabled on this interface") \
1100 #define _(sym,string) ARP_DISABLED_ERROR_##sym,
1101 foreach_arp_disabled_error
1103 ARP_DISABLED_N_ERROR,
1104 } arp_disabled_error_t;
1106 static char *arp_disabled_error_strings[] = {
1107 #define _(sym,string) string,
1108 foreach_arp_disabled_error
1113 arp_disabled (vlib_main_t * vm,
1114 vlib_node_runtime_t * node, vlib_frame_t * frame)
1116 u32 n_left_from, next_index, *from, *to_next, n_left_to_next;
1118 from = vlib_frame_vector_args (frame);
1119 n_left_from = frame->n_vectors;
1120 next_index = node->cached_next_index;
1122 if (node->flags & VLIB_NODE_FLAG_TRACE)
1123 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
1125 sizeof (ethernet_arp_input_trace_t));
1127 while (n_left_from > 0)
1129 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1131 while (n_left_from > 0 && n_left_to_next > 0)
1133 arp_disabled_next_t next0 = ARP_DISABLED_NEXT_DROP;
1137 next0 = ARP_DISABLED_NEXT_DROP;
1138 error0 = ARP_DISABLED_ERROR_DISABLED;
1140 pi0 = to_next[0] = from[0];
1144 n_left_to_next -= 1;
1146 p0 = vlib_get_buffer (vm, pi0);
1147 p0->error = node->errors[error0];
1149 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1150 n_left_to_next, pi0, next0);
1153 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1156 return frame->n_vectors;
1159 static_always_inline u32
1160 arp_mk_reply (vnet_main_t * vnm,
1163 const ip4_address_t * if_addr0,
1164 ethernet_arp_header_t * arp0, ethernet_header_t * eth_rx)
1166 vnet_hw_interface_t *hw_if0;
1167 u8 *rewrite0, rewrite0_len;
1168 ethernet_header_t *eth_tx;
1172 An adjacency to the sender is not always present,
1173 so we use the interface to build us a rewrite string
1174 which will contain all the necessary tags. */
1175 rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1176 VNET_LINK_ARP, eth_rx->src_address);
1177 rewrite0_len = vec_len (rewrite0);
1179 /* Figure out how much to rewind current data from adjacency. */
1180 vlib_buffer_advance (p0, -rewrite0_len);
1181 eth_tx = vlib_buffer_get_current (p0);
1183 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1184 hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1186 /* Send reply back through input interface */
1187 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1188 next0 = ARP_REPLY_NEXT_REPLY_TX;
1190 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1192 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1194 mac_address_from_bytes (&arp0->ip4_over_ethernet[0].mac,
1195 hw_if0->hw_address);
1196 clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1199 /* Hardware must be ethernet-like. */
1200 ASSERT (vec_len (hw_if0->hw_address) == 6);
1202 /* the rx nd tx ethernet headers wil overlap in the case
1203 * when we received a tagged VLAN=0 packet, but we are sending
1205 clib_memcpy_fast (eth_tx, rewrite0, vec_len (rewrite0));
1206 vec_free (rewrite0);
1211 enum arp_dst_fib_type
1219 * we're looking for FIB sources that indicate the destination
1220 * is attached. There may be interposed DPO prior to the one
1221 * we are looking for
1223 static enum arp_dst_fib_type
1224 arp_dst_fib_check (const fib_node_index_t fei, fib_entry_flag_t * flags)
1226 const fib_entry_t *entry = fib_entry_get (fei);
1227 const fib_entry_src_t *entry_src;
1230 FOR_EACH_SRC_ADDED(entry, entry_src, src,
1232 *flags = fib_entry_get_flags_for_source (fei, src);
1233 if (fib_entry_is_sourced (fei, FIB_SOURCE_ADJ))
1234 return ARP_DST_FIB_ADJ;
1235 else if (FIB_ENTRY_FLAG_CONNECTED & *flags)
1236 return ARP_DST_FIB_CONN;
1240 return ARP_DST_FIB_NONE;
1244 arp_reply (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
1246 ethernet_arp_main_t *am = ðernet_arp_main;
1247 vnet_main_t *vnm = vnet_get_main ();
1248 u32 n_left_from, next_index, *from, *to_next;
1249 u32 n_replies_sent = 0;
1251 from = vlib_frame_vector_args (frame);
1252 n_left_from = frame->n_vectors;
1253 next_index = node->cached_next_index;
1255 if (node->flags & VLIB_NODE_FLAG_TRACE)
1256 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
1258 sizeof (ethernet_arp_input_trace_t));
1260 while (n_left_from > 0)
1264 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1266 while (n_left_from > 0 && n_left_to_next > 0)
1269 ethernet_arp_header_t *arp0;
1270 ethernet_header_t *eth_rx;
1271 const ip4_address_t *if_addr0;
1272 u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
1273 u8 dst_is_local0, is_vrrp_reply0;
1274 fib_node_index_t dst_fei, src_fei;
1275 const fib_prefix_t *pfx0;
1276 fib_entry_flag_t src_flags, dst_flags;
1283 n_left_to_next -= 1;
1285 p0 = vlib_get_buffer (vm, pi0);
1286 arp0 = vlib_buffer_get_current (p0);
1287 /* Fill in ethernet header. */
1288 eth_rx = ethernet_buffer_get_header (p0);
1290 next0 = ARP_REPLY_NEXT_DROP;
1291 error0 = ETHERNET_ARP_ERROR_replies_sent;
1292 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1294 /* Check that IP address is local and matches incoming interface. */
1295 fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1296 if (~0 == fib_index0)
1298 error0 = ETHERNET_ARP_ERROR_interface_no_table;
1305 * we're looking for FIB entries that indicate the source
1306 * is attached. There may be more specific non-attached
1307 * routes that match the source, but these do not influence
1308 * whether we respond to an ARP request, i.e. they do not
1309 * influence whether we are the correct way for the sender
1310 * to reach us, they only affect how we reach the sender.
1312 fib_entry_t *src_fib_entry;
1313 const fib_prefix_t *pfx;
1314 fib_entry_src_t *src;
1315 fib_source_t source;
1324 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1326 ip4_over_ethernet[0].ip4,
1328 src_fib_entry = fib_entry_get (src_fei);
1331 * It's possible that the source that provides the
1332 * flags we need, or the flags we must not have,
1333 * is not the best source, so check then all.
1336 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1338 src_flags = fib_entry_get_flags_for_source (src_fei, source);
1340 /* Reject requests/replies with our local interface
1342 if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1344 error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1346 * When VPP has an interface whose address is also
1347 * applied to a TAP interface on the host, then VPP's
1348 * TAP interface will be unnumbered to the 'real'
1349 * interface and do proxy ARP from the host.
1350 * The curious aspect of this setup is that ARP requests
1351 * from the host will come from the VPP's own address.
1352 * So don't drop immediately here, instead go see if this
1353 * is a proxy ARP case.
1357 /* A Source must also be local to subnet of matching
1358 * interface address. */
1359 if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1360 (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1367 * The packet was sent from an address that is not
1368 * connected nor attached i.e. it is not from an
1369 * address that is covered by a link's sub-net,
1370 * nor is it a already learned host resp.
1376 * shorter mask lookup for the next iteration.
1378 pfx = fib_entry_get_prefix (src_fei);
1379 mask = pfx->fp_len - 1;
1382 * continue until we hit the default route or we find
1383 * the attached we are looking for. The most likely
1384 * outcome is we find the attached with the first source
1385 * on the first lookup.
1389 !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1394 * the matching route is a not attached, i.e. it was
1395 * added as a result of routing, rather than interface/ARP
1396 * configuration. If the matching route is not a host route
1399 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1404 dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1405 &arp0->ip4_over_ethernet[1].ip4,
1407 switch (arp_dst_fib_check (dst_fei, &dst_flags))
1409 case ARP_DST_FIB_ADJ:
1411 * We matched an adj-fib on ths source subnet (a /32 previously
1412 * added as a result of ARP). If this request is a gratuitous
1413 * ARP, then learn from it.
1414 * The check for matching an adj-fib, is to prevent hosts
1415 * from spamming us with gratuitous ARPS that might otherwise
1416 * blow our ARP cache
1418 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1419 arp0->ip4_over_ethernet[1].ip4.as_u32)
1420 error0 = arp_learn (vnm, am, sw_if_index0,
1421 &arp0->ip4_over_ethernet[0]);
1423 case ARP_DST_FIB_CONN:
1424 /* destination is connected, continue to process */
1426 case ARP_DST_FIB_NONE:
1427 /* destination is not connected, stop here */
1428 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1432 dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1433 pfx0 = fib_entry_get_prefix (dst_fei);
1434 if_addr0 = &pfx0->fp_addr.ip4;
1438 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1441 (arp0->ip4_over_ethernet[0].mac.bytes, vrrp_prefix,
1442 sizeof (vrrp_prefix))));
1444 /* Trash ARP packets whose ARP-level source addresses do not
1445 match their L2-frame-level source addresses, unless it's
1446 a reply from a VRRP virtual router */
1447 if (!ethernet_mac_address_equal
1448 (eth_rx->src_address,
1449 arp0->ip4_over_ethernet[0].mac.bytes) && !is_vrrp_reply0)
1451 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1455 /* Learn or update sender's mapping only for replies to addresses
1456 * that are local to the subnet */
1458 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1461 error0 = arp_learn (vnm, am, sw_if_index0,
1462 &arp0->ip4_over_ethernet[0]);
1464 /* a reply for a non-local destination could be a GARP.
1465 * GARPs for hosts we know were handled above, so this one
1467 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1471 else if (arp0->opcode ==
1472 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1473 (dst_is_local0 == 0))
1478 /* Honor unnumbered interface, if any */
1479 conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
1480 if (sw_if_index0 != conn_sw_if_index0 ||
1481 sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1484 * The interface the ARP is sent to or was received on is not the
1485 * interface on which the covering prefix is configured.
1486 * Maybe this is a case for unnumbered.
1488 if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1490 error0 = ETHERNET_ARP_ERROR_unnumbered_mismatch;
1494 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1495 arp0->ip4_over_ethernet[1].ip4.as_u32)
1497 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1501 next0 = arp_mk_reply (vnm, p0, sw_if_index0,
1502 if_addr0, arp0, eth_rx);
1504 /* We are going to reply to this request, so, in the absence of
1505 errors, learn the sender */
1507 error0 = arp_learn (vnm, am, sw_if_index0,
1508 &arp0->ip4_over_ethernet[1]);
1510 n_replies_sent += 1;
1514 vnet_feature_next (&next0, p0);
1518 p0->error = node->errors[error0];
1521 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1522 n_left_to_next, pi0, next0);
1525 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1528 vlib_error_count (vm, node->node_index,
1529 ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
1531 return frame->n_vectors;
1535 arp_proxy (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
1537 ethernet_arp_main_t *am = ðernet_arp_main;
1538 vnet_main_t *vnm = vnet_get_main ();
1539 u32 n_left_from, next_index, *from, *to_next;
1540 u32 n_arp_replies_sent = 0;
1542 from = vlib_frame_vector_args (frame);
1543 n_left_from = frame->n_vectors;
1544 next_index = node->cached_next_index;
1546 if (node->flags & VLIB_NODE_FLAG_TRACE)
1547 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
1549 sizeof (ethernet_arp_input_trace_t));
1551 while (n_left_from > 0)
1555 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
1557 while (n_left_from > 0 && n_left_to_next > 0)
1560 ethernet_arp_header_t *arp0;
1561 ethernet_header_t *eth_rx;
1562 ip4_address_t proxy_src;
1563 u32 pi0, error0, next0, sw_if_index0, fib_index0;
1565 ethernet_proxy_arp_t *pa;
1572 n_left_to_next -= 1;
1574 p0 = vlib_get_buffer (vm, pi0);
1575 arp0 = vlib_buffer_get_current (p0);
1576 /* Fill in ethernet header. */
1577 eth_rx = ethernet_buffer_get_header (p0);
1579 is_request0 = arp0->opcode
1580 == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
1582 error0 = ETHERNET_ARP_ERROR_replies_sent;
1583 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1584 next0 = ARP_REPLY_NEXT_DROP;
1586 fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1587 if (~0 == fib_index0)
1589 error0 = ETHERNET_ARP_ERROR_interface_no_table;
1592 if (0 == error0 && is_request0)
1594 u32 this_addr = clib_net_to_host_u32
1595 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1597 vec_foreach (pa, am->proxy_arps)
1599 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr.as_u32);
1600 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr.as_u32);
1602 /* an ARP request hit in the proxy-arp table? */
1603 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1604 (fib_index0 == pa->fib_index))
1607 arp0->ip4_over_ethernet[1].ip4.data_u32;
1610 * change the interface address to the proxied
1612 n_arp_replies_sent++;
1615 arp_mk_reply (vnm, p0, sw_if_index0, &proxy_src, arp0,
1622 p0->error = node->errors[error0];
1625 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1626 n_left_to_next, pi0, next0);
1629 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1632 vlib_error_count (vm, node->node_index,
1633 ETHERNET_ARP_ERROR_replies_sent, n_arp_replies_sent);
1635 return frame->n_vectors;
1638 static char *ethernet_arp_error_strings[] = {
1639 #define _(sym,string) string,
1640 foreach_ethernet_arp_error
1646 VLIB_REGISTER_NODE (arp_input_node, static) =
1648 .function = arp_input,
1649 .name = "arp-input",
1650 .vector_size = sizeof (u32),
1651 .n_errors = ETHERNET_ARP_N_ERROR,
1652 .error_strings = ethernet_arp_error_strings,
1653 .n_next_nodes = ARP_INPUT_N_NEXT,
1655 [ARP_INPUT_NEXT_DROP] = "error-drop",
1656 [ARP_INPUT_NEXT_DISABLED] = "arp-disabled",
1658 .format_buffer = format_ethernet_arp_header,
1659 .format_trace = format_ethernet_arp_input_trace,
1662 VLIB_REGISTER_NODE (arp_disabled_node, static) =
1664 .function = arp_disabled,
1665 .name = "arp-disabled",
1666 .vector_size = sizeof (u32),
1667 .n_errors = ARP_DISABLED_N_ERROR,
1668 .error_strings = arp_disabled_error_strings,
1669 .n_next_nodes = ARP_DISABLED_N_NEXT,
1671 [ARP_INPUT_NEXT_DROP] = "error-drop",
1673 .format_buffer = format_ethernet_arp_header,
1674 .format_trace = format_ethernet_arp_input_trace,
1677 VLIB_REGISTER_NODE (arp_reply_node, static) =
1679 .function = arp_reply,
1680 .name = "arp-reply",
1681 .vector_size = sizeof (u32),
1682 .n_errors = ETHERNET_ARP_N_ERROR,
1683 .error_strings = ethernet_arp_error_strings,
1684 .n_next_nodes = ARP_REPLY_N_NEXT,
1686 [ARP_REPLY_NEXT_DROP] = "error-drop",
1687 [ARP_REPLY_NEXT_REPLY_TX] = "interface-output",
1689 .format_buffer = format_ethernet_arp_header,
1690 .format_trace = format_ethernet_arp_input_trace,
1693 VLIB_REGISTER_NODE (arp_proxy_node, static) =
1695 .function = arp_proxy,
1696 .name = "arp-proxy",
1697 .vector_size = sizeof (u32),
1698 .n_errors = ETHERNET_ARP_N_ERROR,
1699 .error_strings = ethernet_arp_error_strings,
1700 .n_next_nodes = ARP_REPLY_N_NEXT,
1702 [ARP_REPLY_NEXT_DROP] = "error-drop",
1703 [ARP_REPLY_NEXT_REPLY_TX] = "interface-output",
1705 .format_buffer = format_ethernet_arp_header,
1706 .format_trace = format_ethernet_arp_input_trace,
1709 /* Built-in ARP rx feature path definition */
1710 VNET_FEATURE_ARC_INIT (arp_feat, static) =
1713 .start_nodes = VNET_FEATURES ("arp-input"),
1714 .last_in_arc = "arp-disabled",
1715 .arc_index_ptr = ðernet_arp_main.feature_arc_index,
1718 VNET_FEATURE_INIT (arp_reply_feat_node, static) =
1721 .node_name = "arp-reply",
1722 .runs_before = VNET_FEATURES ("arp-disabled"),
1725 VNET_FEATURE_INIT (arp_proxy_feat_node, static) =
1728 .node_name = "arp-proxy",
1729 .runs_after = VNET_FEATURES ("arp-reply"),
1730 .runs_before = VNET_FEATURES ("arp-disabled"),
1733 VNET_FEATURE_INIT (arp_disabled_feat_node, static) =
1736 .node_name = "arp-disabled",
1737 .runs_before = VNET_FEATURES ("error-drop"),
1740 VNET_FEATURE_INIT (arp_drop_feat_node, static) =
1743 .node_name = "error-drop",
1744 .runs_before = 0, /* last feature */
1750 ip4_arp_entry_sort (void *a1, void *a2)
1752 ethernet_arp_ip4_entry_t *e1 = a1;
1753 ethernet_arp_ip4_entry_t *e2 = a2;
1756 vnet_main_t *vnm = vnet_get_main ();
1758 cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1760 cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1764 ethernet_arp_ip4_entry_t *
1765 ip4_neighbors_pool (void)
1767 ethernet_arp_main_t *am = ðernet_arp_main;
1768 return am->ip4_entry_pool;
1771 ethernet_arp_ip4_entry_t *
1772 ip4_neighbor_entries (u32 sw_if_index)
1774 ethernet_arp_main_t *am = ðernet_arp_main;
1775 ethernet_arp_ip4_entry_t *n, *ns = 0;
1778 pool_foreach (n, am->ip4_entry_pool, ({
1779 if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1781 vec_add1 (ns, n[0]);
1786 vec_sort_with_function (ns, ip4_arp_entry_sort);
1790 static clib_error_t *
1791 show_ip4_arp (vlib_main_t * vm,
1792 unformat_input_t * input, vlib_cli_command_t * cmd)
1794 vnet_main_t *vnm = vnet_get_main ();
1795 ethernet_arp_main_t *am = ðernet_arp_main;
1796 ethernet_arp_ip4_entry_t *e, *es;
1797 ethernet_proxy_arp_t *pa;
1798 clib_error_t *error = 0;
1801 /* Filter entries by interface if given. */
1803 (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1805 es = ip4_neighbor_entries (sw_if_index);
1808 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1811 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1816 if (vec_len (am->proxy_arps))
1818 vlib_cli_output (vm, "Proxy arps enabled for:");
1819 vec_foreach (pa, am->proxy_arps)
1821 vlib_cli_output (vm, "Fib_index %d %U - %U ",
1823 format_ip4_address, &pa->lo_addr,
1824 format_ip4_address, &pa->hi_addr);
1832 * Display all the IPv4 ARP entries.
1835 * Example of how to display the IPv4 ARP table:
1836 * @cliexstart{show ip arp}
1837 * Time FIB IP4 Flags Ethernet Interface
1838 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
1839 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
1840 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
1841 * Proxy arps enabled for:
1842 * Fib_index 0 6.0.0.1 - 6.0.0.11
1846 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1847 .path = "show ip arp",
1848 .function = show_ip4_arp,
1849 .short_help = "show ip arp",
1855 pg_edit_t l2_type, l3_type;
1856 pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1862 } ip4_over_ethernet[2];
1863 } pg_ethernet_arp_header_t;
1866 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1868 /* Initialize fields that are not bit fields in the IP header. */
1869 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1872 _(n_l2_address_bytes);
1873 _(n_l3_address_bytes);
1875 _(ip4_over_ethernet[0].mac);
1876 _(ip4_over_ethernet[0].ip4);
1877 _(ip4_over_ethernet[1].mac);
1878 _(ip4_over_ethernet[1].ip4);
1883 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1885 pg_stream_t *s = va_arg (*args, pg_stream_t *);
1886 pg_ethernet_arp_header_t *p;
1889 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1891 pg_ethernet_arp_header_init (p);
1894 pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1895 pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1896 pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1897 pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1899 if (!unformat (input, "%U: %U/%U -> %U/%U",
1901 unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1903 unformat_mac_address_t, &p->ip4_over_ethernet[0].mac,
1905 unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1907 unformat_mac_address_t, &p->ip4_over_ethernet[1].mac,
1909 unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1911 /* Free up any edits we may have added. */
1912 pg_free_edit_group (s);
1919 ip4_set_arp_limit (u32 arp_limit)
1921 ethernet_arp_main_t *am = ðernet_arp_main;
1923 am->limit_arp_cache_size = arp_limit;
1928 * @brief Control Plane hook to remove an ARP entry
1931 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1934 ethernet_arp_ip4_over_ethernet_address_t *
1937 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1938 .sw_if_index = sw_if_index,
1939 .flags = ETHERNET_ARP_ARGS_REMOVE,
1944 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1945 (u8 *) & args, sizeof (args));
1950 * @brief publish wildcard arp event
1951 * @param sw_if_index The interface on which the ARP entries are acted
1954 vnet_arp_wc_publish (u32 sw_if_index,
1955 const ethernet_arp_ip4_over_ethernet_address_t * a)
1957 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1958 .flags = ETHERNET_ARP_ARGS_WC_PUB,
1959 .sw_if_index = sw_if_index,
1964 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1965 (u8 *) & args, sizeof (args));
1970 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1971 vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1974 vlib_main_t *vm = vlib_get_main ();
1975 ethernet_arp_main_t *am = ðernet_arp_main;
1976 uword ni = am->wc_ip4_arp_publisher_node;
1977 uword et = am->wc_ip4_arp_publisher_et;
1979 if (ni == (uword) ~ 0)
1981 wc_arp_report_t *r =
1982 vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1983 r->ip.as_u32 = args->ip4.as_u32;
1984 r->sw_if_index = args->sw_if_index;
1985 mac_address_copy (&r->mac, &args->mac);
1989 wc_arp_set_publisher_node (uword node_index, uword event_type)
1991 ethernet_arp_main_t *am = ðernet_arp_main;
1992 am->wc_ip4_arp_publisher_node = node_index;
1993 am->wc_ip4_arp_publisher_et = event_type;
1997 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e);
2000 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
2001 vnet_arp_set_ip4_over_ethernet_rpc_args_t
2004 ethernet_arp_main_t *am = ðernet_arp_main;
2005 ethernet_arp_ip4_entry_t *e;
2006 ethernet_arp_interface_t *eai;
2008 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
2011 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
2013 e = arp_entry_find (eai, &args->ip4);
2017 adj_nbr_walk_nh4 (e->sw_if_index,
2018 &e->ip4_address, arp_mk_incomplete_walk, e);
2021 * The difference between flush and unset, is that an unset
2022 * means delete for static and dynamic entries. A flush
2023 * means delete only for dynamic. Flushing is what the DP
2024 * does in response to interface events. unset is only done
2025 * by the control plane.
2027 if (e->flags & IP_NEIGHBOR_FLAG_STATIC)
2029 e->flags &= ~IP_NEIGHBOR_FLAG_DYNAMIC;
2031 else if (e->flags & IP_NEIGHBOR_FLAG_DYNAMIC)
2033 arp_entry_free (eai, e);
2040 * arp_add_del_interface_address
2042 * callback when an interface address is added or deleted
2045 arp_enable_disable_interface (ip4_main_t * im,
2046 uword opaque, u32 sw_if_index, u32 is_enable)
2048 ethernet_arp_main_t *am = ðernet_arp_main;
2051 arp_enable (am, sw_if_index);
2053 arp_disable (am, sw_if_index);
2057 * arp_add_del_interface_address
2059 * callback when an interface address is added or deleted
2062 arp_add_del_interface_address (ip4_main_t * im,
2065 ip4_address_t * address,
2067 u32 if_address_index, u32 is_del)
2070 * Flush the ARP cache of all entries covered by the address
2071 * that is being removed.
2073 ethernet_arp_main_t *am = ðernet_arp_main;
2074 ethernet_arp_ip4_entry_t *e;
2076 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
2081 ethernet_arp_interface_t *eai;
2082 u32 i, *to_delete = 0;
2085 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
2088 hash_foreach_pair (pair, eai->arp_entries,
2090 e = pool_elt_at_index(am->ip4_entry_pool,
2092 if (ip4_destination_matches_route (im, &e->ip4_address,
2093 address, address_length))
2095 vec_add1 (to_delete, e - am->ip4_entry_pool);
2100 for (i = 0; i < vec_len (to_delete); i++)
2102 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
2104 vnet_arp_set_ip4_over_ethernet_rpc_args_t delme = {
2105 .ip4.as_u32 = e->ip4_address.as_u32,
2106 .sw_if_index = e->sw_if_index,
2107 .flags = ETHERNET_ARP_ARGS_FLUSH,
2109 mac_address_copy (&delme.mac, &e->mac);
2111 vnet_arp_flush_ip4_over_ethernet_internal (vnet_get_main (),
2115 vec_free (to_delete);
2120 arp_table_bind (ip4_main_t * im,
2122 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
2124 ethernet_arp_main_t *am = ðernet_arp_main;
2125 ethernet_arp_interface_t *eai;
2126 ethernet_arp_ip4_entry_t *e;
2130 * the IP table that the interface is bound to has changed.
2131 * reinstall all the adj fibs.
2134 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
2137 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
2140 hash_foreach_pair (pair, eai->arp_entries,
2142 e = pool_elt_at_index(am->ip4_entry_pool,
2145 * remove the adj-fib from the old table and add to the new
2147 arp_adj_fib_remove(e, old_fib_index);
2148 arp_adj_fib_add(e, new_fib_index);
2154 static clib_error_t *
2155 ethernet_arp_init (vlib_main_t * vm)
2157 ethernet_arp_main_t *am = ðernet_arp_main;
2158 ip4_main_t *im = &ip4_main;
2161 ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
2163 pn = pg_get_node (arp_input_node.index);
2164 pn->unformat_edit = unformat_pg_arp_header;
2166 am->opcode_by_name = hash_create_string (0, sizeof (uword));
2167 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
2168 foreach_ethernet_arp_opcode;
2171 /* $$$ configurable */
2172 am->limit_arp_cache_size = 50000;
2174 am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
2175 am->mac_changes_by_address = hash_create (0, sizeof (uword));
2176 am->wc_ip4_arp_publisher_node = (uword) ~ 0;
2178 /* don't trace ARP error packets */
2180 vlib_node_runtime_t *rt =
2181 vlib_node_get_runtime (vm, arp_input_node.index);
2184 vnet_pcap_drop_trace_filter_add_del \
2185 (rt->errors[ETHERNET_ARP_ERROR_##a], \
2187 foreach_ethernet_arp_error
2191 ip4_add_del_interface_address_callback_t cb;
2192 cb.function = arp_add_del_interface_address;
2193 cb.function_opaque = 0;
2194 vec_add1 (im->add_del_interface_address_callbacks, cb);
2196 ip4_enable_disable_interface_callback_t cbe;
2197 cbe.function = arp_enable_disable_interface;
2198 cbe.function_opaque = 0;
2199 vec_add1 (im->enable_disable_interface_callbacks, cbe);
2201 ip4_table_bind_callback_t cbt;
2202 cbt.function = arp_table_bind;
2203 cbt.function_opaque = 0;
2204 vec_add1 (im->table_bind_callbacks, cbt);
2209 VLIB_INIT_FUNCTION (ethernet_arp_init) =
2211 .runs_after = VLIB_INITS("ethernet_init"),
2216 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
2218 ethernet_arp_main_t *am = ðernet_arp_main;
2221 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
2222 hash_unset (eai->arp_entries, e->ip4_address.as_u32);
2223 pool_put (am->ip4_entry_pool, e);
2227 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
2228 vnet_arp_set_ip4_over_ethernet_rpc_args_t
2231 ethernet_arp_main_t *am = ðernet_arp_main;
2232 ethernet_arp_ip4_entry_t *e;
2233 ethernet_arp_interface_t *eai;
2235 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
2238 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
2240 e = arp_entry_find (eai, &args->ip4);
2244 adj_nbr_walk_nh4 (e->sw_if_index,
2245 &e->ip4_address, arp_mk_incomplete_walk, e);
2246 arp_entry_free (eai, e);
2254 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
2255 vnet_arp_set_ip4_over_ethernet_rpc_args_t
2258 ethernet_arp_main_t *am = ðernet_arp_main;
2259 ethernet_arp_ip4_entry_t *e;
2260 ethernet_arp_interface_t *eai;
2262 arp_enable (am, args->sw_if_index);
2263 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
2265 e = arp_entry_find (eai, &args->ip4);
2269 adj_nbr_walk_nh4 (e->sw_if_index,
2270 &e->ip4_address, arp_mk_complete_walk, e);
2276 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
2279 vnet_main_t *vm = vnet_get_main ();
2280 ASSERT (vlib_get_thread_index () == 0);
2282 if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
2283 vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
2284 else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
2285 vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
2286 else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
2287 vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
2288 else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
2289 vnet_arp_wc_publish_internal (vm, a);
2291 vnet_arp_set_ip4_over_ethernet_internal (vm, a);
2295 * @brief Invoked when the interface's admin state changes
2297 static clib_error_t *
2298 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
2299 u32 sw_if_index, u32 flags)
2301 ethernet_arp_main_t *am = ðernet_arp_main;
2302 ethernet_arp_ip4_entry_t *e;
2303 u32 i, *to_update = 0;
2306 pool_foreach (e, am->ip4_entry_pool,
2308 if (e->sw_if_index == sw_if_index)
2309 vec_add1 (to_update,
2310 e - am->ip4_entry_pool);
2314 for (i = 0; i < vec_len (to_update); i++)
2316 e = pool_elt_at_index (am->ip4_entry_pool, to_update[i]);
2318 vnet_arp_set_ip4_over_ethernet_rpc_args_t update_me = {
2319 .ip4.as_u32 = e->ip4_address.as_u32,
2320 .sw_if_index = e->sw_if_index,
2322 mac_address_copy (&update_me.mac, &e->mac);
2324 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
2326 update_me.flags = ETHERNET_ARP_ARGS_POPULATE;
2327 vnet_arp_populate_ip4_over_ethernet_internal (vnm, &update_me);
2331 update_me.flags = ETHERNET_ARP_ARGS_FLUSH;
2332 vnet_arp_flush_ip4_over_ethernet_internal (vnm, &update_me);
2335 vec_free (to_update);
2340 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
2343 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
2348 for (i = 3; i >= 0; i--)
2350 old = a->ip4.as_u8[i];
2351 a->ip4.as_u8[i] += 1;
2352 if (old < a->ip4.as_u8[i])
2356 for (i = 5; i >= 0; i--)
2358 old = a->mac.bytes[i];
2359 a->mac.bytes[i] += 1;
2360 if (old < a->mac.bytes[i])
2366 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
2368 const ethernet_arp_ip4_over_ethernet_address_t
2369 * a, ip_neighbor_flags_t flags)
2371 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
2372 .sw_if_index = sw_if_index,
2375 .ip4.as_u32 = a->ip4.as_u32,
2379 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
2380 (u8 *) & args, sizeof (args));
2385 proxy_arp_walk (proxy_arp_walk_t cb, void *data)
2387 ethernet_arp_main_t *am = ðernet_arp_main;
2388 ethernet_proxy_arp_t *pa;
2390 vec_foreach (pa, am->proxy_arps)
2392 if (!cb (&pa->lo_addr, &pa->hi_addr, pa->fib_index, data))
2398 vnet_proxy_arp_enable_disable (vnet_main_t * vnm, u32 sw_if_index, u8 enable)
2400 ethernet_arp_main_t *am = ðernet_arp_main;
2401 ethernet_arp_interface_t *eai;
2403 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
2405 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
2409 if (!eai->proxy_enabled)
2411 vnet_feature_enable_disable ("arp", "arp-proxy",
2412 sw_if_index, 1, NULL, 0);
2414 eai->proxy_enabled = 1;
2418 if (eai->proxy_enabled)
2420 vnet_feature_enable_disable ("arp", "arp-proxy",
2421 sw_if_index, 0, NULL, 0);
2423 eai->proxy_enabled = 0;
2430 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
2431 ip4_address_t * hi_addr, u32 fib_index, int is_del)
2433 ethernet_arp_main_t *am = ðernet_arp_main;
2434 ethernet_proxy_arp_t *pa;
2435 u32 found_at_index = ~0;
2437 vec_foreach (pa, am->proxy_arps)
2439 if (pa->lo_addr.as_u32 == lo_addr->as_u32 &&
2440 pa->hi_addr.as_u32 == hi_addr->as_u32 && pa->fib_index == fib_index)
2442 found_at_index = pa - am->proxy_arps;
2447 if (found_at_index != ~0)
2449 /* Delete, otherwise it's already in the table */
2451 vec_delete (am->proxy_arps, 1, found_at_index);
2454 /* delete, no such entry */
2456 return VNET_API_ERROR_NO_SUCH_ENTRY;
2458 /* add, not in table */
2459 vec_add2 (am->proxy_arps, pa, 1);
2460 pa->lo_addr.as_u32 = lo_addr->as_u32;
2461 pa->hi_addr.as_u32 = hi_addr->as_u32;
2462 pa->fib_index = fib_index;
2467 proxy_arp_intfc_walk (proxy_arp_intf_walk_t cb, void *data)
2469 ethernet_arp_main_t *am = ðernet_arp_main;
2470 ethernet_arp_interface_t *eai;
2472 vec_foreach (eai, am->ethernet_arp_by_sw_if_index)
2474 if (eai->proxy_enabled)
2475 cb (eai - am->ethernet_arp_by_sw_if_index, data);
2480 * Remove any proxy arp entries associated with the
2484 vnet_proxy_arp_fib_reset (u32 fib_id)
2486 ethernet_arp_main_t *am = ðernet_arp_main;
2487 ethernet_proxy_arp_t *pa;
2488 u32 *entries_to_delete = 0;
2492 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2493 if (~0 == fib_index)
2494 return VNET_API_ERROR_NO_SUCH_ENTRY;
2496 vec_foreach (pa, am->proxy_arps)
2498 if (pa->fib_index == fib_index)
2500 vec_add1 (entries_to_delete, pa - am->proxy_arps);
2504 for (i = 0; i < vec_len (entries_to_delete); i++)
2506 vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2509 vec_free (entries_to_delete);
2514 static clib_error_t *
2515 ip_arp_add_del_command_fn (vlib_main_t * vm,
2516 unformat_input_t * input, vlib_cli_command_t * cmd)
2518 vnet_main_t *vnm = vnet_get_main ();
2520 ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2527 ip_neighbor_flags_t flags;
2529 flags = IP_NEIGHBOR_FLAG_NONE;
2531 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2533 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2534 if (unformat (input, "%U %U %U",
2535 unformat_vnet_sw_interface, vnm, &sw_if_index,
2536 unformat_ip4_address, &addr.ip4,
2537 unformat_mac_address_t, &addr.mac))
2540 else if (unformat (input, "delete") || unformat (input, "del"))
2543 else if (unformat (input, "static"))
2544 flags |= IP_NEIGHBOR_FLAG_STATIC;
2546 else if (unformat (input, "no-fib-entry"))
2547 flags |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
2549 else if (unformat (input, "count %d", &count))
2552 else if (unformat (input, "fib-id %d", &fib_id))
2554 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2556 if (~0 == fib_index)
2557 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2560 else if (unformat (input, "proxy %U - %U",
2561 unformat_ip4_address, &lo_addr.ip4,
2562 unformat_ip4_address, &hi_addr.ip4))
2570 (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2579 for (i = 0; i < count; i++)
2583 uword event_type, *event_data = 0;
2585 /* Park the debug CLI until the arp entry is installed */
2586 vnet_register_ip4_arp_resolution_event
2587 (vnm, &addr.ip4, vlib_current_process (vm),
2588 1 /* type */ , 0 /* data */ );
2590 vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, &addr, flags);
2592 vlib_process_wait_for_event (vm);
2593 event_type = vlib_process_get_events (vm, &event_data);
2594 vec_reset_length (event_data);
2595 if (event_type != 1)
2596 clib_warning ("event type %d unexpected", event_type);
2599 vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2601 increment_ip4_and_mac_address (&addr);
2606 return clib_error_return (0, "unknown input `%U'",
2607 format_unformat_error, input);
2615 * Add or delete IPv4 ARP cache entries.
2617 * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2618 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2619 * any order and combination.
2623 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2624 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2625 * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2626 * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2628 * To add or delete an IPv4 ARP cache entry to or from a specific fib
2630 * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2631 * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2633 * Add or delete IPv4 static ARP cache entries as follows:
2634 * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2635 * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2637 * For testing / debugging purposes, the 'set ip arp' command can add or
2638 * delete multiple entries. Supply the 'count N' parameter:
2639 * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2642 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2643 .path = "set ip arp",
2645 "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2646 .function = ip_arp_add_del_command_fn,
2650 static clib_error_t *
2651 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2653 input, vlib_cli_command_t * cmd)
2655 vnet_main_t *vnm = vnet_get_main ();
2661 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2663 if (unformat (input, "%U", unformat_vnet_sw_interface,
2666 else if (unformat (input, "enable") || unformat (input, "on"))
2668 else if (unformat (input, "disable") || unformat (input, "off"))
2674 if (~0 == sw_if_index)
2675 return clib_error_return (0, "unknown input '%U'",
2676 format_unformat_error, input);
2678 vnet_proxy_arp_enable_disable (vnm, sw_if_index, enable);
2685 * Enable proxy-arp on an interface. The vpp stack will answer ARP
2686 * requests for the indicated address range. Multiple proxy-arp
2687 * ranges may be provisioned.
2689 * @note Proxy ARP as a technology is infamous for blackholing traffic.
2690 * Also, the underlying implementation has not been performance-tuned.
2691 * Avoid creating an unnecessarily large set of ranges.
2694 * To enable proxy arp on a range of addresses, use:
2695 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2696 * Append 'del' to delete a range of proxy ARP addresses:
2697 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2698 * You must then specifically enable proxy arp on individual interfaces:
2699 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2700 * To disable proxy arp on an individual interface:
2701 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2703 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2704 .path = "set interface proxy-arp",
2706 "set interface proxy-arp <intfc> [enable|disable]",
2707 .function = set_int_proxy_arp_command_fn,
2713 * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2714 * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2718 ARP_TERM_NEXT_L2_OUTPUT,
2723 u32 arp_term_next_node_index[32];
2726 arp_term_l2bd (vlib_main_t * vm,
2727 vlib_node_runtime_t * node, vlib_frame_t * frame)
2729 l2input_main_t *l2im = &l2input_main;
2730 u32 n_left_from, next_index, *from, *to_next;
2731 u32 n_replies_sent = 0;
2732 u16 last_bd_index = ~0;
2733 l2_bridge_domain_t *last_bd_config = 0;
2734 l2_input_config_t *cfg0;
2736 from = vlib_frame_vector_args (frame);
2737 n_left_from = frame->n_vectors;
2738 next_index = node->cached_next_index;
2740 while (n_left_from > 0)
2744 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2746 while (n_left_from > 0 && n_left_to_next > 0)
2749 ethernet_header_t *eth0;
2750 ethernet_arp_header_t *arp0;
2753 u32 pi0, error0, next0, sw_if_index0;
2764 n_left_to_next -= 1;
2766 p0 = vlib_get_buffer (vm, pi0);
2767 // Terminate only local (SHG == 0) ARP
2768 if (vnet_buffer (p0)->l2.shg != 0)
2769 goto next_l2_feature;
2771 eth0 = vlib_buffer_get_current (p0);
2772 l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2773 ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2774 arp0 = (ethernet_arp_header_t *) l3h0;
2776 if (ethertype0 != ETHERNET_TYPE_ARP)
2779 if ((arp0->opcode !=
2780 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request)) &&
2782 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply)))
2785 /* Must be ARP request/reply packet here */
2786 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2787 (p0->flags & VLIB_BUFFER_IS_TRACED)))
2789 u8 *t0 = vlib_add_trace (vm, node, p0,
2790 sizeof (ethernet_arp_input_trace_t));
2791 clib_memcpy_fast (t0, l3h0,
2792 sizeof (ethernet_arp_input_trace_t));
2798 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2799 ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2802 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2803 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2805 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2810 /* Trash ARP packets whose ARP-level source addresses do not
2811 match, or if requester address is mcast */
2813 (!ethernet_mac_address_equal (eth0->src_address,
2814 arp0->ip4_over_ethernet[0].
2816 || ethernet_address_cast (arp0->ip4_over_ethernet[0].mac.bytes))
2818 /* VRRP virtual MAC may be different to SMAC in ARP reply */
2819 if (!ethernet_mac_address_equal
2820 (arp0->ip4_over_ethernet[0].mac.bytes, vrrp_prefix))
2822 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2827 (ip4_address_is_multicast (&arp0->ip4_over_ethernet[0].ip4)))
2829 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
2833 /* Check if anyone want ARP request events for L2 BDs */
2835 ethernet_arp_main_t *am = ðernet_arp_main;
2836 if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2837 vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2840 /* lookup BD mac_by_ip4 hash table for MAC entry */
2841 ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2842 bd_index0 = vnet_buffer (p0)->l2.bd_index;
2843 if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2844 || (last_bd_index == (u16) ~ 0)))
2846 last_bd_index = bd_index0;
2847 last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2849 macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2851 if (PREDICT_FALSE (!macp0))
2852 goto next_l2_feature; /* MAC not found */
2853 if (PREDICT_FALSE (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2854 arp0->ip4_over_ethernet[1].ip4.as_u32))
2855 goto next_l2_feature; /* GARP */
2857 /* MAC found, send ARP reply -
2858 Convert ARP request packet to ARP reply */
2859 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2860 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2861 arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2862 mac_address_from_bytes (&arp0->ip4_over_ethernet[0].mac, macp0);
2863 clib_memcpy_fast (eth0->dst_address, eth0->src_address, 6);
2864 clib_memcpy_fast (eth0->src_address, macp0, 6);
2865 n_replies_sent += 1;
2868 /* For BVI, need to use l2-fwd node to send ARP reply as
2869 l2-output node cannot output packet to BVI properly */
2870 cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2871 if (PREDICT_FALSE (cfg0->bvi))
2873 vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2874 vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2875 goto next_l2_feature;
2878 /* Send ARP/ND reply back out input interface through l2-output */
2879 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2880 next0 = ARP_TERM_NEXT_L2_OUTPUT;
2881 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2882 to_next, n_left_to_next, pi0,
2887 /* IP6 ND event notification or solicitation handling to generate
2888 local response instead of flooding */
2889 iph0 = (ip6_header_t *) l3h0;
2890 if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2891 iph0->protocol == IP_PROTOCOL_ICMP6 &&
2892 !ip6_address_is_unspecified
2893 (&iph0->src_address)))
2895 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2896 if (vnet_ip6_nd_term
2897 (vm, node, p0, eth0, iph0, sw_if_index0,
2898 vnet_buffer (p0)->l2.bd_index))
2899 goto output_response;
2904 next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2905 L2INPUT_FEAT_ARP_TERM);
2906 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2907 to_next, n_left_to_next,
2913 if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2914 (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2915 arp0->ip4_over_ethernet[1].ip4.as_u32))
2917 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2919 next0 = ARP_TERM_NEXT_DROP;
2920 p0->error = node->errors[error0];
2922 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2923 to_next, n_left_to_next, pi0,
2927 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2930 vlib_error_count (vm, node->node_index,
2931 ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2932 return frame->n_vectors;
2936 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2937 .function = arp_term_l2bd,
2938 .name = "arp-term-l2bd",
2939 .vector_size = sizeof (u32),
2940 .n_errors = ETHERNET_ARP_N_ERROR,
2941 .error_strings = ethernet_arp_error_strings,
2942 .n_next_nodes = ARP_TERM_N_NEXT,
2944 [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2945 [ARP_TERM_NEXT_DROP] = "error-drop",
2947 .format_buffer = format_ethernet_arp_header,
2948 .format_trace = format_arp_term_input_trace,
2953 arp_term_init (vlib_main_t * vm)
2955 // Initialize the feature next-node indexes
2956 feat_bitmap_init_next_nodes (vm,
2957 arp_term_l2bd_node.index,
2959 l2input_get_feat_names (),
2960 arp_term_next_node_index);
2964 VLIB_INIT_FUNCTION (arp_term_init);
2967 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2969 if (e->sw_if_index == sw_if_index)
2971 adj_nbr_walk_nh4 (e->sw_if_index,
2972 &e->ip4_address, arp_mk_complete_walk, e);
2977 ethernet_arp_change_mac (u32 sw_if_index)
2979 ethernet_arp_main_t *am = ðernet_arp_main;
2980 ethernet_arp_ip4_entry_t *e;
2984 pool_foreach (e, am->ip4_entry_pool,
2986 change_arp_mac (sw_if_index, e);
2990 ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2992 if (ADJ_INDEX_INVALID != ai)
2993 adj_glean_update_rewrite (ai);
2997 send_ip4_garp (vlib_main_t * vm, u32 sw_if_index)
2999 ip4_main_t *i4m = &ip4_main;
3000 ip4_address_t *ip4_addr = ip4_interface_first_address (i4m, sw_if_index, 0);
3002 send_ip4_garp_w_addr (vm, ip4_addr, sw_if_index);
3006 send_ip4_garp_w_addr (vlib_main_t * vm,
3007 const ip4_address_t * ip4_addr, u32 sw_if_index)
3009 ip4_main_t *i4m = &ip4_main;
3010 vnet_main_t *vnm = vnet_get_main ();
3011 u8 *rewrite, rewrite_len;
3012 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
3016 clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
3017 format_ip4_address, ip4_addr, sw_if_index);
3019 /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
3020 where the interface IP/MAC pair is used for both source and request
3021 MAC/IP pairs in the request */
3023 ethernet_arp_header_t *h = vlib_packet_template_get_packet
3024 (vm, &i4m->ip4_arp_request_packet_template, &bi);
3029 mac_address_from_bytes (&h->ip4_over_ethernet[0].mac, hi->hw_address);
3030 mac_address_from_bytes (&h->ip4_over_ethernet[1].mac, hi->hw_address);
3031 h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
3032 h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
3034 /* Setup MAC header with ARP Etype and broadcast DMAC */
3035 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
3037 ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
3038 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
3039 rewrite_len = vec_len (rewrite);
3040 vlib_buffer_advance (b, -rewrite_len);
3041 ethernet_header_t *e = vlib_buffer_get_current (b);
3042 clib_memcpy_fast (e->dst_address, rewrite, rewrite_len);
3045 /* Send GARP packet out the specified interface */
3046 vnet_buffer (b)->sw_if_index[VLIB_RX] =
3047 vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
3048 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
3049 u32 *to_next = vlib_frame_vector_args (f);
3052 vlib_put_frame_to_node (vm, hi->output_node_index, f);
3057 * Remove any arp entries associated with the specified interface
3059 static clib_error_t *
3060 vnet_arp_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
3062 ethernet_arp_main_t *am = ðernet_arp_main;
3064 if (!is_add && sw_if_index != ~0)
3066 ethernet_arp_ip4_entry_t *e;
3068 pool_foreach (e, am->ip4_entry_pool, ({
3069 if (e->sw_if_index != sw_if_index)
3071 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
3072 .sw_if_index = sw_if_index,
3073 .ip4 = e->ip4_address,
3075 vnet_arp_unset_ip4_over_ethernet_internal (vnm, &args);
3078 arp_disable (am, sw_if_index);
3082 vnet_feature_enable_disable ("arp", "arp-disabled",
3083 sw_if_index, 1, NULL, 0);
3089 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (vnet_arp_delete_sw_interface);
3092 * fd.io coding-style-patch-verification: ON
3095 * eval: (c-set-style "gnu")