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/ip6.h>
20 #include <vnet/ethernet/ethernet.h>
21 #include <vnet/ethernet/arp.h>
22 #include <vnet/l2/l2_input.h>
23 #include <vppinfra/mhash.h>
24 #include <vnet/fib/ip4_fib.h>
25 #include <vnet/fib/fib_entry_src.h>
26 #include <vnet/adj/adj_nbr.h>
27 #include <vnet/adj/adj_mcast.h>
28 #include <vnet/mpls/mpls.h>
29 #include <vnet/l2/feat_bitmap.h>
35 * This file contains code to manage the IPv4 ARP tables (IP Address
36 * to MAC Address lookup).
40 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
43 * @brief Per-interface ARP configuration and state
45 typedef struct ethernet_arp_interface_t_
48 * Hash table of ARP entries.
49 * Since this hash table is per-interface, the key is only the IPv4 address.
52 } ethernet_arp_interface_t;
56 ip4_address_t lo_addr;
57 ip4_address_t hi_addr;
59 } ethernet_proxy_arp_t;
67 /* Used for arp event notification only */
70 } pending_resolution_t;
74 /* Hash tables mapping name to opcode. */
75 uword *opcode_by_name;
77 /* lite beer "glean" adjacency handling */
78 uword *pending_resolutions_by_address;
79 pending_resolution_t *pending_resolutions;
81 /* Mac address change notification */
82 uword *mac_changes_by_address;
83 pending_resolution_t *mac_changes;
85 ethernet_arp_ip4_entry_t *ip4_entry_pool;
87 /* ARP attack mitigation */
89 u32 limit_arp_cache_size;
91 /** Per interface state */
92 ethernet_arp_interface_t *ethernet_arp_by_sw_if_index;
94 /* Proxy arp vector */
95 ethernet_proxy_arp_t *proxy_arps;
97 uword wc_ip4_arp_publisher_node;
98 uword wc_ip4_arp_publisher_et;
99 } ethernet_arp_main_t;
101 static ethernet_arp_main_t ethernet_arp_main;
106 ethernet_arp_ip4_over_ethernet_address_t a;
110 #define ETHERNET_ARP_ARGS_REMOVE (1<<0)
111 #define ETHERNET_ARP_ARGS_FLUSH (1<<1)
112 #define ETHERNET_ARP_ARGS_POPULATE (1<<2)
113 #define ETHERNET_ARP_ARGS_WC_PUB (1<<3)
114 } vnet_arp_set_ip4_over_ethernet_rpc_args_t;
116 static const u8 vrrp_prefix[] = { 0x00, 0x00, 0x5E, 0x00, 0x01 };
118 /* Node index for send_garp_na_process */
119 u32 send_garp_na_process_node_index;
122 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
126 format_ethernet_arp_hardware_type (u8 * s, va_list * va)
128 ethernet_arp_hardware_type_t h = va_arg (*va, ethernet_arp_hardware_type_t);
132 #define _(n,f) case n: t = #f; break;
133 foreach_ethernet_arp_hardware_type;
137 return format (s, "unknown 0x%x", h);
140 return format (s, "%s", t);
144 format_ethernet_arp_opcode (u8 * s, va_list * va)
146 ethernet_arp_opcode_t o = va_arg (*va, ethernet_arp_opcode_t);
150 #define _(f) case ETHERNET_ARP_OPCODE_##f: t = #f; break;
151 foreach_ethernet_arp_opcode;
155 return format (s, "unknown 0x%x", o);
158 return format (s, "%s", t);
162 unformat_ethernet_arp_opcode_host_byte_order (unformat_input_t * input,
165 int *result = va_arg (*args, int *);
166 ethernet_arp_main_t *am = ðernet_arp_main;
169 /* Numeric opcode. */
170 if (unformat (input, "0x%x", &x) || unformat (input, "%d", &x))
179 if (unformat_user (input, unformat_vlib_number_by_name,
180 am->opcode_by_name, &i))
190 unformat_ethernet_arp_opcode_net_byte_order (unformat_input_t * input,
193 int *result = va_arg (*args, int *);
195 (input, unformat_ethernet_arp_opcode_host_byte_order, result))
198 *result = clib_host_to_net_u16 ((u16) * result);
203 format_ethernet_arp_header (u8 * s, va_list * va)
205 ethernet_arp_header_t *a = va_arg (*va, ethernet_arp_header_t *);
206 u32 max_header_bytes = va_arg (*va, u32);
208 u16 l2_type, l3_type;
210 if (max_header_bytes != 0 && sizeof (a[0]) > max_header_bytes)
211 return format (s, "ARP header truncated");
213 l2_type = clib_net_to_host_u16 (a->l2_type);
214 l3_type = clib_net_to_host_u16 (a->l3_type);
216 indent = format_get_indent (s);
218 s = format (s, "%U, type %U/%U, address size %d/%d",
219 format_ethernet_arp_opcode, clib_net_to_host_u16 (a->opcode),
220 format_ethernet_arp_hardware_type, l2_type,
221 format_ethernet_type, l3_type,
222 a->n_l2_address_bytes, a->n_l3_address_bytes);
224 if (l2_type == ETHERNET_ARP_HARDWARE_TYPE_ethernet
225 && l3_type == ETHERNET_TYPE_IP4)
227 s = format (s, "\n%U%U/%U -> %U/%U",
228 format_white_space, indent,
229 format_ethernet_address, a->ip4_over_ethernet[0].ethernet,
230 format_ip4_address, &a->ip4_over_ethernet[0].ip4,
231 format_ethernet_address, a->ip4_over_ethernet[1].ethernet,
232 format_ip4_address, &a->ip4_over_ethernet[1].ip4);
236 uword n2 = a->n_l2_address_bytes;
237 uword n3 = a->n_l3_address_bytes;
238 s = format (s, "\n%U%U/%U -> %U/%U",
239 format_white_space, indent,
240 format_hex_bytes, a->data + 0 * n2 + 0 * n3, n2,
241 format_hex_bytes, a->data + 1 * n2 + 0 * n3, n3,
242 format_hex_bytes, a->data + 1 * n2 + 1 * n3, n2,
243 format_hex_bytes, a->data + 2 * n2 + 1 * n3, n3);
250 format_ethernet_arp_ip4_entry (u8 * s, va_list * va)
252 vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
253 ethernet_arp_ip4_entry_t *e = va_arg (*va, ethernet_arp_ip4_entry_t *);
254 vnet_sw_interface_t *si;
258 return format (s, "%=12s%=16s%=6s%=20s%=24s", "Time", "IP4",
259 "Flags", "Ethernet", "Interface");
261 si = vnet_get_sw_interface (vnm, e->sw_if_index);
263 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
264 flags = format (flags, "S");
266 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
267 flags = format (flags, "D");
269 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY)
270 flags = format (flags, "N");
272 s = format (s, "%=12U%=16U%=6s%=20U%U",
273 format_vlib_time, vnm->vlib_main, e->time_last_updated,
274 format_ip4_address, &e->ip4_address,
275 flags ? (char *) flags : "",
276 format_ethernet_address, e->ethernet_address,
277 format_vnet_sw_interface_name, vnm, si);
286 } ethernet_arp_input_trace_t;
289 format_ethernet_arp_input_trace (u8 * s, va_list * va)
291 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
292 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
293 ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
296 format_ethernet_arp_header,
297 t->packet_data, sizeof (t->packet_data));
303 format_arp_term_input_trace (u8 * s, va_list * va)
305 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
306 CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
307 ethernet_arp_input_trace_t *t = va_arg (*va, ethernet_arp_input_trace_t *);
309 /* arp-term trace data saved is either arp or ip6/icmp6 packet:
310 - for arp, the 1st 16-bit field is hw type of value of 0x0001.
311 - for ip6, the first nibble has value of 6. */
312 s = format (s, "%U", t->packet_data[0] == 0 ?
313 format_ethernet_arp_header : format_ip6_header,
314 t->packet_data, sizeof (t->packet_data));
320 arp_nbr_probe (ip_adjacency_t * adj)
322 vnet_main_t *vnm = vnet_get_main ();
323 ip4_main_t *im = &ip4_main;
324 ip_interface_address_t *ia;
325 ethernet_arp_header_t *h;
326 vnet_hw_interface_t *hi;
327 vnet_sw_interface_t *si;
333 vm = vlib_get_main ();
335 si = vnet_get_sw_interface (vnm, adj->rewrite_header.sw_if_index);
337 if (!(si->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
343 ip4_interface_address_matching_destination (im,
344 &adj->sub_type.nbr.next_hop.
354 vlib_packet_template_get_packet (vm, &im->ip4_arp_request_packet_template,
359 hi = vnet_get_sup_hw_interface (vnm, adj->rewrite_header.sw_if_index);
361 clib_memcpy (h->ip4_over_ethernet[0].ethernet,
362 hi->hw_address, sizeof (h->ip4_over_ethernet[0].ethernet));
364 h->ip4_over_ethernet[0].ip4 = src[0];
365 h->ip4_over_ethernet[1].ip4 = adj->sub_type.nbr.next_hop.ip4;
367 b = vlib_get_buffer (vm, bi);
368 vnet_buffer (b)->sw_if_index[VLIB_RX] =
369 vnet_buffer (b)->sw_if_index[VLIB_TX] = adj->rewrite_header.sw_if_index;
371 /* Add encapsulation string for software interface (e.g. ethernet header). */
372 vnet_rewrite_one_header (adj[0], h, sizeof (ethernet_header_t));
373 vlib_buffer_advance (b, -adj->rewrite_header.data_bytes);
376 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
377 u32 *to_next = vlib_frame_vector_args (f);
380 vlib_put_frame_to_node (vm, hi->output_node_index, f);
385 arp_mk_complete (adj_index_t ai, ethernet_arp_ip4_entry_t * e)
387 adj_nbr_update_rewrite
388 (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
389 ethernet_build_rewrite (vnet_get_main (),
391 adj_get_link_type (ai), e->ethernet_address));
395 arp_mk_incomplete (adj_index_t ai)
397 ip_adjacency_t *adj = adj_get (ai);
399 adj_nbr_update_rewrite
401 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
402 ethernet_build_rewrite (vnet_get_main (),
403 adj->rewrite_header.sw_if_index,
405 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
408 static ethernet_arp_ip4_entry_t *
409 arp_entry_find (ethernet_arp_interface_t * eai, const ip4_address_t * addr)
411 ethernet_arp_main_t *am = ðernet_arp_main;
412 ethernet_arp_ip4_entry_t *e = NULL;
415 if (NULL != eai->arp_entries)
417 p = hash_get (eai->arp_entries, addr->as_u32);
421 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
428 arp_mk_complete_walk (adj_index_t ai, void *ctx)
430 ethernet_arp_ip4_entry_t *e = ctx;
432 arp_mk_complete (ai, e);
434 return (ADJ_WALK_RC_CONTINUE);
438 arp_mk_incomplete_walk (adj_index_t ai, void *ctx)
440 arp_mk_incomplete (ai);
442 return (ADJ_WALK_RC_CONTINUE);
446 arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
448 ethernet_arp_main_t *am = ðernet_arp_main;
449 ethernet_arp_interface_t *arp_int;
450 ethernet_arp_ip4_entry_t *e;
455 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
456 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
457 e = arp_entry_find (arp_int, &adj->sub_type.nbr.next_hop.ip4);
459 switch (adj->lookup_next_index)
461 case IP_LOOKUP_NEXT_GLEAN:
462 adj_glean_update_rewrite (ai);
464 case IP_LOOKUP_NEXT_ARP:
467 adj_nbr_walk_nh4 (sw_if_index,
468 &e->ip4_address, arp_mk_complete_walk, e);
473 * no matching ARP entry.
474 * construct the rewrite required to for an ARP packet, and stick
475 * that in the adj's pipe to smoke.
477 adj_nbr_update_rewrite
479 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
480 ethernet_build_rewrite
484 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
487 * since the FIB has added this adj for a route, it makes sense it
488 * may want to forward traffic sometime soon. Let's send a
489 * speculative ARP. just one. If we were to do periodically that
490 * wouldn't be bad either, but that's more code than i'm prepared to
491 * write at this time for relatively little reward.
496 case IP_LOOKUP_NEXT_BCAST:
497 adj_nbr_update_rewrite (ai,
498 ADJ_NBR_REWRITE_FLAG_COMPLETE,
499 ethernet_build_rewrite
503 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
505 case IP_LOOKUP_NEXT_MCAST:
508 * Construct a partial rewrite from the known ethernet mcast dest MAC
513 rewrite = ethernet_build_rewrite (vnm,
516 ethernet_ip4_mcast_dst_addr ());
517 offset = vec_len (rewrite) - 2;
520 * Complete the remaining fields of the adj's rewrite to direct the
521 * complete of the rewrite at switch time by copying in the IP
522 * dst address's bytes.
523 * Ofset is 2 bytes into the MAC desintation address.
525 adj_mcast_update_rewrite (ai, rewrite, offset);
529 case IP_LOOKUP_NEXT_DROP:
530 case IP_LOOKUP_NEXT_PUNT:
531 case IP_LOOKUP_NEXT_LOCAL:
532 case IP_LOOKUP_NEXT_REWRITE:
533 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
534 case IP_LOOKUP_NEXT_MIDCHAIN:
535 case IP_LOOKUP_NEXT_ICMP_ERROR:
536 case IP_LOOKUP_N_NEXT:
543 arp_adj_fib_add (ethernet_arp_ip4_entry_t * e, u32 fib_index)
547 .fp_proto = FIB_PROTOCOL_IP4,
548 .fp_addr.ip4 = e->ip4_address,
552 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
553 FIB_ENTRY_FLAG_ATTACHED,
554 DPO_PROTO_IP4, &pfx.fp_addr,
555 e->sw_if_index, ~0, 1, NULL,
556 FIB_ROUTE_PATH_FLAG_NONE);
557 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
561 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
563 if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
567 .fp_proto = FIB_PROTOCOL_IP4,
568 .fp_addr.ip4 = e->ip4_address,
572 fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
574 fib_table_entry_path_remove (fib_index, &pfx,
578 e->sw_if_index, ~0, 1,
579 FIB_ROUTE_PATH_FLAG_NONE);
580 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
584 static ethernet_arp_ip4_entry_t *
585 force_reuse_arp_entry (void)
587 ethernet_arp_ip4_entry_t *e;
588 ethernet_arp_main_t *am = ðernet_arp_main;
590 u32 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
591 if (index == ~0) /* Try again from elt 0 */
592 index = pool_next_index (am->ip4_entry_pool, index);
594 /* Find a non-static random entry to free up for reuse */
597 if ((count++ == 100) || (index == ~0))
598 return NULL; /* give up after 100 entries */
599 e = pool_elt_at_index (am->ip4_entry_pool, index);
600 am->arp_delete_rotor = index;
601 index = pool_next_index (am->ip4_entry_pool, index);
603 while (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC);
605 /* Remove ARP entry from its interface and update fib */
607 (am->ethernet_arp_by_sw_if_index[e->sw_if_index].arp_entries,
608 e->ip4_address.as_u32);
610 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
611 adj_nbr_walk_nh4 (e->sw_if_index,
612 &e->ip4_address, arp_mk_incomplete_walk, NULL);
617 vnet_arp_set_ip4_over_ethernet_internal (vnet_main_t * vnm,
618 vnet_arp_set_ip4_over_ethernet_rpc_args_t
621 ethernet_arp_ip4_entry_t *e = 0;
622 ethernet_arp_main_t *am = ðernet_arp_main;
623 ethernet_arp_ip4_over_ethernet_address_t *a = &args->a;
624 vlib_main_t *vm = vlib_get_main ();
625 int make_new_arp_cache_entry = 1;
627 pending_resolution_t *pr, *mc;
628 ethernet_arp_interface_t *arp_int;
629 int is_static = args->is_static;
630 u32 sw_if_index = args->sw_if_index;
631 int is_no_fib_entry = args->is_no_fib_entry;
633 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
635 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
637 if (NULL != arp_int->arp_entries)
639 p = hash_get (arp_int->arp_entries, a->ip4.as_u32);
642 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
644 /* Refuse to over-write static arp. */
645 if (!is_static && (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC))
647 /* if MAC address match, still check to send event */
648 if (0 == memcmp (e->ethernet_address,
649 a->ethernet, sizeof (e->ethernet_address)))
650 goto check_customers;
653 make_new_arp_cache_entry = 0;
657 if (make_new_arp_cache_entry)
659 if (am->limit_arp_cache_size &&
660 pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
662 e = force_reuse_arp_entry ();
667 pool_get (am->ip4_entry_pool, e);
669 if (NULL == arp_int->arp_entries)
670 arp_int->arp_entries = hash_create (0, sizeof (u32));
672 hash_set (arp_int->arp_entries, a->ip4.as_u32, e - am->ip4_entry_pool);
674 e->sw_if_index = sw_if_index;
675 e->ip4_address = a->ip4;
676 e->fib_entry_index = FIB_NODE_INDEX_INVALID;
677 clib_memcpy (e->ethernet_address,
678 a->ethernet, sizeof (e->ethernet_address));
680 if (!is_no_fib_entry)
683 ip4_fib_table_get_index_for_sw_if_index
688 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY;
694 * prevent a DoS attack from the data-plane that
695 * spams us with no-op updates to the MAC address
697 if (0 == memcmp (e->ethernet_address,
698 a->ethernet, sizeof (e->ethernet_address)))
700 e->time_last_updated = vlib_time_now (vm);
701 goto check_customers;
704 /* Update ethernet address. */
705 clib_memcpy (e->ethernet_address, a->ethernet,
706 sizeof (e->ethernet_address));
709 /* Update time stamp and flags. */
710 e->time_last_updated = vlib_time_now (vm);
713 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
714 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
718 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
719 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
722 adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
725 /* Customer(s) waiting for this address to be resolved? */
726 p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
732 while (next_index != (u32) ~ 0)
734 pr = pool_elt_at_index (am->pending_resolutions, next_index);
735 vlib_process_signal_event (vm, pr->node_index,
736 pr->type_opaque, pr->data);
737 next_index = pr->next_index;
738 pool_put (am->pending_resolutions, pr);
741 hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
744 /* Customer(s) requesting ARP event for this address? */
745 p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
751 while (next_index != (u32) ~ 0)
753 int (*fp) (u32, u8 *, u32, u32);
755 mc = pool_elt_at_index (am->mac_changes, next_index);
756 fp = mc->data_callback;
758 /* Call the user's data callback, return 1 to suppress dup events */
760 rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
763 * Signal the resolver process, as long as the user
764 * says they want to be notified
767 vlib_process_signal_event (vm, mc->node_index,
768 mc->type_opaque, mc->data);
769 next_index = mc->next_index;
777 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
780 uword type_opaque, uword data)
782 ethernet_arp_main_t *am = ðernet_arp_main;
783 ip4_address_t *address = address_arg;
785 pending_resolution_t *pr;
787 pool_get (am->pending_resolutions, pr);
790 pr->node_index = node_index;
791 pr->type_opaque = type_opaque;
793 pr->data_callback = 0;
795 p = hash_get (am->pending_resolutions_by_address, address->as_u32);
798 /* Insert new resolution at the head of the list */
799 pr->next_index = p[0];
800 hash_unset (am->pending_resolutions_by_address, address->as_u32);
803 hash_set (am->pending_resolutions_by_address, address->as_u32,
804 pr - am->pending_resolutions);
808 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
813 uword type_opaque, uword data, int is_add)
815 ethernet_arp_main_t *am = ðernet_arp_main;
816 ip4_address_t *address = address_arg;
818 /* Try to find an existing entry */
819 u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
821 pending_resolution_t *mc;
822 while (p && *p != ~0)
824 mc = pool_elt_at_index (am->mac_changes, *p);
825 if (mc->node_index == node_index && mc->type_opaque == type_opaque
831 int found = p && *p != ~0;
835 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
837 pool_get (am->mac_changes, mc);
838 *mc = (pending_resolution_t)
840 .next_index = ~0,.node_index = node_index,.type_opaque =
841 type_opaque,.data = data,.data_callback = data_callback,.pid =
844 /* Insert new resolution at the end of the list */
845 u32 new_idx = mc - am->mac_changes;
849 hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
854 return VNET_API_ERROR_NO_SUCH_ENTRY;
856 /* Clients may need to clean up pool entries, too */
857 void (*fp) (u32, u8 *) = data_callback;
859 (*fp) (mc->data, 0 /* no new mac addrs */ );
861 /* Remove the entry from the list and delete the entry */
863 pool_put (am->mac_changes, mc);
865 /* Remove from hash if we deleted the last entry */
866 if (*p == ~0 && p == first)
867 hash_unset (am->mac_changes_by_address, address->as_u32);
872 /* Either we drop the packet or we send a reply to the sender. */
876 ARP_INPUT_NEXT_REPLY_TX,
880 #define foreach_ethernet_arp_error \
881 _ (replies_sent, "ARP replies sent") \
882 _ (l2_type_not_ethernet, "L2 type not ethernet") \
883 _ (l3_type_not_ip4, "L3 type not IP4") \
884 _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
885 _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
886 _ (l3_dst_address_unset, "IP4 destination address is unset") \
887 _ (l3_src_address_is_local, "IP4 source address matches local interface") \
888 _ (l3_src_address_learned, "ARP request IP4 source address learned") \
889 _ (replies_received, "ARP replies received") \
890 _ (opcode_not_request, "ARP opcode not request") \
891 _ (proxy_arp_replies_sent, "Proxy ARP replies sent") \
892 _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
893 _ (gratuitous_arp, "ARP probe or announcement dropped") \
894 _ (interface_no_table, "Interface is not mapped to an IP table") \
895 _ (interface_not_ip_enabled, "Interface is not IP enabled") \
899 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
900 foreach_ethernet_arp_error
902 ETHERNET_ARP_N_ERROR,
903 } ethernet_arp_input_error_t;
906 arp_unnumbered (vlib_buffer_t * p0,
907 u32 input_sw_if_index, u32 conn_sw_if_index)
909 vnet_main_t *vnm = vnet_get_main ();
910 vnet_interface_main_t *vim = &vnm->interface_main;
911 vnet_sw_interface_t *si;
913 /* verify that the input interface is unnumbered to the connected.
914 * the connected interface is the interface on which the subnet is
916 si = &vim->sw_interfaces[input_sw_if_index];
918 if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
919 (si->unnumbered_sw_if_index == conn_sw_if_index)))
921 /* the input interface is not unnumbered to the interface on which
922 * the sub-net is configured that covers the ARP request.
923 * So this is not the case for unnumbered.. */
931 arp_learn (vnet_main_t * vnm,
932 ethernet_arp_main_t * am, u32 sw_if_index, void *addr)
934 vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
935 return (ETHERNET_ARP_ERROR_l3_src_address_learned);
939 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
941 ethernet_arp_main_t *am = ðernet_arp_main;
942 vnet_main_t *vnm = vnet_get_main ();
943 ip4_main_t *im4 = &ip4_main;
944 u32 n_left_from, next_index, *from, *to_next;
945 u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
947 from = vlib_frame_vector_args (frame);
948 n_left_from = frame->n_vectors;
949 next_index = node->cached_next_index;
951 if (node->flags & VLIB_NODE_FLAG_TRACE)
952 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
954 sizeof (ethernet_arp_input_trace_t));
956 while (n_left_from > 0)
960 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
962 while (n_left_from > 0 && n_left_to_next > 0)
965 vnet_hw_interface_t *hw_if0;
966 ethernet_arp_header_t *arp0;
967 ethernet_header_t *eth_rx, *eth_tx;
968 const ip4_address_t *if_addr0;
969 ip4_address_t proxy_src;
970 u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
971 u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
972 ethernet_proxy_arp_t *pa;
973 fib_node_index_t dst_fei, src_fei;
974 const fib_prefix_t *pfx0;
975 fib_entry_flag_t src_flags, dst_flags;
976 u8 *rewrite0, rewrite0_len;
986 p0 = vlib_get_buffer (vm, pi0);
987 arp0 = vlib_buffer_get_current (p0);
988 /* Fill in ethernet header. */
989 eth_rx = ethernet_buffer_get_header (p0);
991 is_request0 = arp0->opcode
992 == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
994 error0 = ETHERNET_ARP_ERROR_replies_sent;
998 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
999 ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
1002 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
1003 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
1005 (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ?
1006 ETHERNET_ARP_ERROR_l3_dst_address_unset : error0);
1008 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1010 /* not playing the ARP game if the interface is not IPv4 enabled */
1012 (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
1013 ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
1018 /* Check that IP address is local and matches incoming interface. */
1019 fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1020 if (~0 == fib_index0)
1022 error0 = ETHERNET_ARP_ERROR_interface_no_table;
1026 dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1027 &arp0->ip4_over_ethernet[1].ip4,
1029 dst_flags = fib_entry_get_flags (dst_fei);
1031 conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
1033 /* Honor unnumbered interface, if any */
1034 is_unnum0 = sw_if_index0 != conn_sw_if_index0;
1038 * we're looking for FIB entries that indicate the source
1039 * is attached. There may be more specific non-attached
1040 * routes that match the source, but these do not influence
1041 * whether we respond to an ARP request, i.e. they do not
1042 * influence whether we are the correct way for the sender
1043 * to reach us, they only affect how we reach the sender.
1045 fib_entry_t *src_fib_entry;
1046 const fib_prefix_t *pfx;
1047 fib_entry_src_t *src;
1048 fib_source_t source;
1057 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1059 ip4_over_ethernet[0].ip4,
1061 src_fib_entry = fib_entry_get (src_fei);
1064 * It's possible that the source that provides the
1065 * flags we need, or the flags we must not have,
1066 * is not the best source, so check then all.
1069 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1071 src_flags = fib_entry_get_flags_for_source (src_fei, source);
1073 /* Reject requests/replies with our local interface
1075 if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1077 error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1079 * When VPP has an interface whose address is also
1080 * applied to a TAP interface on the host, then VPP's
1081 * TAP interface will be unnumbered to the 'real'
1082 * interface and do proxy ARP from the host.
1083 * The curious aspect of this setup is that ARP requests
1084 * from the host will come from the VPP's own address.
1085 * So don't drop immediately here, instead go see if this
1086 * is a proxy ARP case.
1090 /* A Source must also be local to subnet of matching
1091 * interface address. */
1092 if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1093 (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1100 * The packet was sent from an address that is not
1101 * connected nor attached i.e. it is not from an
1102 * address that is covered by a link's sub-net,
1103 * nor is it a already learned host resp.
1109 * shorter mask lookup for the next iteration.
1111 pfx = fib_entry_get_prefix (src_fei);
1112 mask = pfx->fp_len - 1;
1115 * continue until we hit the default route or we find
1116 * the attached we are looking for. The most likely
1117 * outcome is we find the attached with the first source
1118 * on the first lookup.
1122 !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1127 * the matching route is a not attached, i.e. it was
1128 * added as a result of routing, rather than interface/ARP
1129 * configuration. If the matching route is not a host route
1132 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1137 if (fib_entry_is_sourced (dst_fei, FIB_SOURCE_ADJ))
1140 * We matched an adj-fib on ths source subnet (a /32 previously
1141 * added as a result of ARP). If this request is a gratuitous
1142 * ARP, then learn from it.
1143 * The check for matching an adj-fib, is to prevent hosts
1144 * from spamming us with gratuitous ARPS that might otherwise
1145 * blow our ARP cache
1147 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1148 arp0->ip4_over_ethernet[1].ip4.as_u32)
1149 error0 = arp_learn (vnm, am, sw_if_index0,
1150 &arp0->ip4_over_ethernet[0]);
1153 else if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1155 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1159 if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1162 * The interface the ARP was received on is not the interface
1163 * on which the covering prefix is configured. Maybe this is a
1164 * case for unnumbered.
1169 dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1170 pfx0 = fib_entry_get_prefix (dst_fei);
1171 if_addr0 = &pfx0->fp_addr.ip4;
1175 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1178 (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1179 sizeof (vrrp_prefix))));
1181 /* Trash ARP packets whose ARP-level source addresses do not
1182 match their L2-frame-level source addresses, unless it's
1183 a reply from a VRRP virtual router */
1185 (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1186 sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1188 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1192 /* Learn or update sender's mapping only for replies to addresses
1193 * that are local to the subnet */
1195 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1198 error0 = arp_learn (vnm, am, sw_if_index0,
1199 &arp0->ip4_over_ethernet[0]);
1201 /* a reply for a non-local destination could be a GARP.
1202 * GARPs for hosts we know were handled above, so this one
1204 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1208 else if (arp0->opcode ==
1209 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1210 (dst_is_local0 == 0))
1217 An adjacency to the sender is not always present,
1218 so we use the interface to build us a rewrite string
1219 which will contain all the necessary tags. */
1220 rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1222 eth_rx->src_address);
1223 rewrite0_len = vec_len (rewrite0);
1225 /* Figure out how much to rewind current data from adjacency. */
1226 vlib_buffer_advance (p0, -rewrite0_len);
1227 eth_tx = vlib_buffer_get_current (p0);
1229 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1230 hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1232 /* Send reply back through input interface */
1233 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1234 next0 = ARP_INPUT_NEXT_REPLY_TX;
1236 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1238 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1240 clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1241 hw_if0->hw_address, 6);
1242 clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1245 /* Hardware must be ethernet-like. */
1246 ASSERT (vec_len (hw_if0->hw_address) == 6);
1248 /* the rx nd tx ethernet headers wil overlap in the case
1249 * when we received a tagged VLAN=0 packet, but we are sending
1251 clib_memcpy (eth_tx, rewrite0, vec_len (rewrite0));
1252 vec_free (rewrite0);
1258 if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1263 /* We are going to reply to this request, so, in the absence of
1264 errors, learn the sender */
1266 error0 = arp_learn (vnm, am, sw_if_index0,
1267 &arp0->ip4_over_ethernet[1]);
1269 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1270 n_left_to_next, pi0, next0);
1272 n_replies_sent += 1;
1276 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1277 arp0->ip4_over_ethernet[1].ip4.as_u32)
1279 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1282 /* See if proxy arp is configured for the address */
1285 vnet_sw_interface_t *si;
1286 u32 this_addr = clib_net_to_host_u32
1287 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1290 si = vnet_get_sw_interface (vnm, sw_if_index0);
1292 if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1295 fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1298 vec_foreach (pa, am->proxy_arps)
1300 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr.as_u32);
1301 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr.as_u32);
1303 /* an ARP request hit in the proxy-arp table? */
1304 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1305 (fib_index0 == pa->fib_index))
1308 arp0->ip4_over_ethernet[1].ip4.data_u32;
1311 * change the interface address to the proxied
1313 if_addr0 = &proxy_src;
1315 n_proxy_arp_replies_sent++;
1323 next0 = ARP_INPUT_NEXT_DROP;
1324 p0->error = node->errors[error0];
1326 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1327 n_left_to_next, pi0, next0);
1330 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1333 vlib_error_count (vm, node->node_index,
1334 ETHERNET_ARP_ERROR_replies_sent,
1335 n_replies_sent - n_proxy_arp_replies_sent);
1337 vlib_error_count (vm, node->node_index,
1338 ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1339 n_proxy_arp_replies_sent);
1340 return frame->n_vectors;
1343 static char *ethernet_arp_error_strings[] = {
1344 #define _(sym,string) string,
1345 foreach_ethernet_arp_error
1350 VLIB_REGISTER_NODE (arp_input_node, static) =
1352 .function = arp_input,
1353 .name = "arp-input",
1354 .vector_size = sizeof (u32),
1355 .n_errors = ETHERNET_ARP_N_ERROR,
1356 .error_strings = ethernet_arp_error_strings,
1357 .n_next_nodes = ARP_INPUT_N_NEXT,
1359 [ARP_INPUT_NEXT_DROP] = "error-drop",
1360 [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1362 .format_buffer = format_ethernet_arp_header,
1363 .format_trace = format_ethernet_arp_input_trace,
1368 ip4_arp_entry_sort (void *a1, void *a2)
1370 ethernet_arp_ip4_entry_t *e1 = a1;
1371 ethernet_arp_ip4_entry_t *e2 = a2;
1374 vnet_main_t *vnm = vnet_get_main ();
1376 cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1378 cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1382 ethernet_arp_ip4_entry_t *
1383 ip4_neighbors_pool (void)
1385 ethernet_arp_main_t *am = ðernet_arp_main;
1386 return am->ip4_entry_pool;
1389 ethernet_arp_ip4_entry_t *
1390 ip4_neighbor_entries (u32 sw_if_index)
1392 ethernet_arp_main_t *am = ðernet_arp_main;
1393 ethernet_arp_ip4_entry_t *n, *ns = 0;
1396 pool_foreach (n, am->ip4_entry_pool, ({
1397 if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1399 vec_add1 (ns, n[0]);
1404 vec_sort_with_function (ns, ip4_arp_entry_sort);
1408 static clib_error_t *
1409 show_ip4_arp (vlib_main_t * vm,
1410 unformat_input_t * input, vlib_cli_command_t * cmd)
1412 vnet_main_t *vnm = vnet_get_main ();
1413 ethernet_arp_main_t *am = ðernet_arp_main;
1414 ethernet_arp_ip4_entry_t *e, *es;
1415 ethernet_proxy_arp_t *pa;
1416 clib_error_t *error = 0;
1419 /* Filter entries by interface if given. */
1421 (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1423 es = ip4_neighbor_entries (sw_if_index);
1426 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1429 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1434 if (vec_len (am->proxy_arps))
1436 vlib_cli_output (vm, "Proxy arps enabled for:");
1437 vec_foreach (pa, am->proxy_arps)
1439 vlib_cli_output (vm, "Fib_index %d %U - %U ",
1441 format_ip4_address, &pa->lo_addr,
1442 format_ip4_address, &pa->hi_addr);
1450 * Display all the IPv4 ARP entries.
1453 * Example of how to display the IPv4 ARP table:
1454 * @cliexstart{show ip arp}
1455 * Time FIB IP4 Flags Ethernet Interface
1456 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
1457 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
1458 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
1459 * Proxy arps enabled for:
1460 * Fib_index 0 6.0.0.1 - 6.0.0.11
1464 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1465 .path = "show ip arp",
1466 .function = show_ip4_arp,
1467 .short_help = "show ip arp",
1473 pg_edit_t l2_type, l3_type;
1474 pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1480 } ip4_over_ethernet[2];
1481 } pg_ethernet_arp_header_t;
1484 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1486 /* Initialize fields that are not bit fields in the IP header. */
1487 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1490 _(n_l2_address_bytes);
1491 _(n_l3_address_bytes);
1493 _(ip4_over_ethernet[0].ethernet);
1494 _(ip4_over_ethernet[0].ip4);
1495 _(ip4_over_ethernet[1].ethernet);
1496 _(ip4_over_ethernet[1].ip4);
1501 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1503 pg_stream_t *s = va_arg (*args, pg_stream_t *);
1504 pg_ethernet_arp_header_t *p;
1507 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1509 pg_ethernet_arp_header_init (p);
1512 pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1513 pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1514 pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1515 pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1517 if (!unformat (input, "%U: %U/%U -> %U/%U",
1519 unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1521 unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1523 unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1525 unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1527 unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1529 /* Free up any edits we may have added. */
1530 pg_free_edit_group (s);
1537 ip4_set_arp_limit (u32 arp_limit)
1539 ethernet_arp_main_t *am = ðernet_arp_main;
1541 am->limit_arp_cache_size = arp_limit;
1546 * @brief Control Plane hook to remove an ARP entry
1549 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1550 u32 sw_if_index, void *a_arg)
1552 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1553 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1555 args.sw_if_index = sw_if_index;
1556 args.flags = ETHERNET_ARP_ARGS_REMOVE;
1557 clib_memcpy (&args.a, a, sizeof (*a));
1559 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1560 (u8 *) & args, sizeof (args));
1565 * @brief Internally generated event to flush the ARP cache on an
1566 * interface state change event.
1567 * A flush will remove dynamic ARP entries, and for statics remove the MAC
1568 * address from the corresponding adjacencies.
1571 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1572 u32 sw_if_index, void *a_arg)
1574 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1575 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1577 args.sw_if_index = sw_if_index;
1578 args.flags = ETHERNET_ARP_ARGS_FLUSH;
1579 clib_memcpy (&args.a, a, sizeof (*a));
1581 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1582 (u8 *) & args, sizeof (args));
1587 * @brief Internally generated event to populate the ARP cache on an
1588 * interface state change event.
1589 * For static entries this will re-source the adjacencies.
1591 * @param sw_if_index The interface on which the ARP entires are acted
1594 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1595 u32 sw_if_index, void *a_arg)
1597 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1598 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1600 args.sw_if_index = sw_if_index;
1601 args.flags = ETHERNET_ARP_ARGS_POPULATE;
1602 clib_memcpy (&args.a, a, sizeof (*a));
1604 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1605 (u8 *) & args, sizeof (args));
1610 * @brief publish wildcard arp event
1611 * @param sw_if_index The interface on which the ARP entires are acted
1614 vnet_arp_wc_publish (u32 sw_if_index, void *a_arg)
1616 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1617 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1618 .flags = ETHERNET_ARP_ARGS_WC_PUB,
1619 .sw_if_index = sw_if_index,
1623 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1624 (u8 *) & args, sizeof (args));
1629 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1630 vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1633 vlib_main_t *vm = vlib_get_main ();
1634 ethernet_arp_main_t *am = ðernet_arp_main;
1635 uword ni = am->wc_ip4_arp_publisher_node;
1636 uword et = am->wc_ip4_arp_publisher_et;
1638 if (ni == (uword) ~ 0)
1640 wc_arp_report_t *r =
1641 vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1642 r->ip4 = args->a.ip4.as_u32;
1643 r->sw_if_index = args->sw_if_index;
1644 memcpy (r->mac, args->a.ethernet, sizeof r->mac);
1648 wc_arp_set_publisher_node (uword node_index, uword event_type)
1650 ethernet_arp_main_t *am = ðernet_arp_main;
1651 am->wc_ip4_arp_publisher_node = node_index;
1652 am->wc_ip4_arp_publisher_et = event_type;
1656 * arp_add_del_interface_address
1658 * callback when an interface address is added or deleted
1661 arp_add_del_interface_address (ip4_main_t * im,
1664 ip4_address_t * address,
1666 u32 if_address_index, u32 is_del)
1669 * Flush the ARP cache of all entries covered by the address
1670 * that is being removed.
1672 ethernet_arp_main_t *am = ðernet_arp_main;
1673 ethernet_arp_ip4_entry_t *e;
1675 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1680 ethernet_arp_interface_t *eai;
1681 u32 i, *to_delete = 0;
1684 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1687 hash_foreach_pair (pair, eai->arp_entries,
1689 e = pool_elt_at_index(am->ip4_entry_pool,
1691 if (ip4_destination_matches_route (im, &e->ip4_address,
1692 address, address_length))
1694 vec_add1 (to_delete, e - am->ip4_entry_pool);
1699 for (i = 0; i < vec_len (to_delete); i++)
1701 ethernet_arp_ip4_over_ethernet_address_t delme;
1702 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1704 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1705 delme.ip4.as_u32 = e->ip4_address.as_u32;
1707 vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1708 e->sw_if_index, &delme);
1711 vec_free (to_delete);
1716 arp_table_bind (ip4_main_t * im,
1718 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
1720 ethernet_arp_main_t *am = ðernet_arp_main;
1721 ethernet_arp_interface_t *eai;
1722 ethernet_arp_ip4_entry_t *e;
1726 * the IP table that the interface is bound to has changed.
1727 * reinstall all the adj fibs.
1730 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1733 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1736 hash_foreach_pair (pair, eai->arp_entries,
1738 e = pool_elt_at_index(am->ip4_entry_pool,
1741 * remove the adj-fib from the old table and add to the new
1743 arp_adj_fib_remove(e, old_fib_index);
1744 arp_adj_fib_add(e, new_fib_index);
1750 static clib_error_t *
1751 ethernet_arp_init (vlib_main_t * vm)
1753 ethernet_arp_main_t *am = ðernet_arp_main;
1754 ip4_main_t *im = &ip4_main;
1755 clib_error_t *error;
1758 if ((error = vlib_call_init_function (vm, ethernet_init)))
1761 ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1763 pn = pg_get_node (arp_input_node.index);
1764 pn->unformat_edit = unformat_pg_arp_header;
1766 am->opcode_by_name = hash_create_string (0, sizeof (uword));
1767 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1768 foreach_ethernet_arp_opcode;
1771 /* $$$ configurable */
1772 am->limit_arp_cache_size = 50000;
1774 am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1775 am->mac_changes_by_address = hash_create (0, sizeof (uword));
1776 am->wc_ip4_arp_publisher_node = (uword) ~ 0;
1778 /* don't trace ARP error packets */
1780 vlib_node_runtime_t *rt =
1781 vlib_node_get_runtime (vm, arp_input_node.index);
1784 vnet_pcap_drop_trace_filter_add_del \
1785 (rt->errors[ETHERNET_ARP_ERROR_##a], \
1787 foreach_ethernet_arp_error
1791 ip4_add_del_interface_address_callback_t cb;
1792 cb.function = arp_add_del_interface_address;
1793 cb.function_opaque = 0;
1794 vec_add1 (im->add_del_interface_address_callbacks, cb);
1796 ip4_table_bind_callback_t cbt;
1797 cbt.function = arp_table_bind;
1798 cbt.function_opaque = 0;
1799 vec_add1 (im->table_bind_callbacks, cbt);
1804 VLIB_INIT_FUNCTION (ethernet_arp_init);
1807 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1809 ethernet_arp_main_t *am = ðernet_arp_main;
1812 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
1813 hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1814 pool_put (am->ip4_entry_pool, e);
1818 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1819 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1822 ethernet_arp_main_t *am = ðernet_arp_main;
1823 ethernet_arp_ip4_entry_t *e;
1824 ethernet_arp_interface_t *eai;
1826 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1829 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1831 e = arp_entry_find (eai, &args->a.ip4);
1835 adj_nbr_walk_nh4 (e->sw_if_index,
1836 &e->ip4_address, arp_mk_incomplete_walk, NULL);
1837 arp_entry_free (eai, e);
1844 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1845 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1848 ethernet_arp_main_t *am = ðernet_arp_main;
1849 ethernet_arp_ip4_entry_t *e;
1850 ethernet_arp_interface_t *eai;
1852 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1855 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1857 e = arp_entry_find (eai, &args->a.ip4);
1861 adj_nbr_walk_nh4 (e->sw_if_index,
1862 &e->ip4_address, arp_mk_incomplete_walk, e);
1865 * The difference between flush and unset, is that an unset
1866 * means delete for static and dynamic entries. A flush
1867 * means delete only for dynamic. Flushing is what the DP
1868 * does in response to interface events. unset is only done
1869 * by the control plane.
1871 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
1873 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
1875 else if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1877 arp_entry_free (eai, e);
1884 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1885 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1888 ethernet_arp_main_t *am = ðernet_arp_main;
1889 ethernet_arp_ip4_entry_t *e;
1890 ethernet_arp_interface_t *eai;
1892 vec_validate (am->ethernet_arp_by_sw_if_index, args->sw_if_index);
1893 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1895 e = arp_entry_find (eai, &args->a.ip4);
1899 adj_nbr_walk_nh4 (e->sw_if_index,
1900 &e->ip4_address, arp_mk_complete_walk, e);
1906 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1909 vnet_main_t *vm = vnet_get_main ();
1910 ASSERT (vlib_get_thread_index () == 0);
1912 if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1913 vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1914 else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1915 vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1916 else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1917 vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1918 else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
1919 vnet_arp_wc_publish_internal (vm, a);
1921 vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1925 * @brief Invoked when the interface's admin state changes
1927 static clib_error_t *
1928 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1929 u32 sw_if_index, u32 flags)
1931 ethernet_arp_main_t *am = ðernet_arp_main;
1932 ethernet_arp_ip4_entry_t *e;
1933 u32 i, *to_delete = 0;
1936 pool_foreach (e, am->ip4_entry_pool,
1938 if (e->sw_if_index == sw_if_index)
1939 vec_add1 (to_delete,
1940 e - am->ip4_entry_pool);
1944 for (i = 0; i < vec_len (to_delete); i++)
1946 ethernet_arp_ip4_over_ethernet_address_t delme;
1947 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1949 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1950 delme.ip4.as_u32 = e->ip4_address.as_u32;
1952 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1954 vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1958 vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1962 vec_free (to_delete);
1967 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1970 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1975 for (i = 3; i >= 0; i--)
1977 old = a->ip4.as_u8[i];
1978 a->ip4.as_u8[i] += 1;
1979 if (old < a->ip4.as_u8[i])
1983 for (i = 5; i >= 0; i--)
1985 old = a->ethernet[i];
1986 a->ethernet[i] += 1;
1987 if (old < a->ethernet[i])
1993 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1994 u32 sw_if_index, void *a_arg,
1995 int is_static, int is_no_fib_entry)
1997 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1998 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
2000 args.sw_if_index = sw_if_index;
2001 args.is_static = is_static;
2002 args.is_no_fib_entry = is_no_fib_entry;
2004 clib_memcpy (&args.a, a, sizeof (*a));
2006 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
2007 (u8 *) & args, sizeof (args));
2012 proxy_arp_walk (proxy_arp_walk_t cb, void *data)
2014 ethernet_arp_main_t *am = ðernet_arp_main;
2015 ethernet_proxy_arp_t *pa;
2017 vec_foreach (pa, am->proxy_arps)
2019 if (!cb (&pa->lo_addr, &pa->hi_addr, pa->fib_index, data))
2025 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
2026 ip4_address_t * hi_addr, u32 fib_index, int is_del)
2028 ethernet_arp_main_t *am = ðernet_arp_main;
2029 ethernet_proxy_arp_t *pa;
2030 u32 found_at_index = ~0;
2032 vec_foreach (pa, am->proxy_arps)
2034 if (pa->lo_addr.as_u32 == lo_addr->as_u32 &&
2035 pa->hi_addr.as_u32 == hi_addr->as_u32 && pa->fib_index == fib_index)
2037 found_at_index = pa - am->proxy_arps;
2042 if (found_at_index != ~0)
2044 /* Delete, otherwise it's already in the table */
2046 vec_delete (am->proxy_arps, 1, found_at_index);
2049 /* delete, no such entry */
2051 return VNET_API_ERROR_NO_SUCH_ENTRY;
2053 /* add, not in table */
2054 vec_add2 (am->proxy_arps, pa, 1);
2055 pa->lo_addr.as_u32 = lo_addr->as_u32;
2056 pa->hi_addr.as_u32 = hi_addr->as_u32;
2057 pa->fib_index = fib_index;
2062 * Remove any proxy arp entries asdociated with the
2066 vnet_proxy_arp_fib_reset (u32 fib_id)
2068 ethernet_arp_main_t *am = ðernet_arp_main;
2069 ethernet_proxy_arp_t *pa;
2070 u32 *entries_to_delete = 0;
2074 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2075 if (~0 == fib_index)
2076 return VNET_API_ERROR_NO_SUCH_ENTRY;
2078 vec_foreach (pa, am->proxy_arps)
2080 if (pa->fib_index == fib_index)
2082 vec_add1 (entries_to_delete, pa - am->proxy_arps);
2086 for (i = 0; i < vec_len (entries_to_delete); i++)
2088 vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2091 vec_free (entries_to_delete);
2096 static clib_error_t *
2097 ip_arp_add_del_command_fn (vlib_main_t * vm,
2098 unformat_input_t * input, vlib_cli_command_t * cmd)
2100 vnet_main_t *vnm = vnet_get_main ();
2102 ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2109 int is_no_fib_entry = 0;
2112 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2114 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2115 if (unformat (input, "%U %U %U",
2116 unformat_vnet_sw_interface, vnm, &sw_if_index,
2117 unformat_ip4_address, &addr.ip4,
2118 unformat_ethernet_address, &addr.ethernet))
2121 else if (unformat (input, "delete") || unformat (input, "del"))
2124 else if (unformat (input, "static"))
2127 else if (unformat (input, "no-fib-entry"))
2128 is_no_fib_entry = 1;
2130 else if (unformat (input, "count %d", &count))
2133 else if (unformat (input, "fib-id %d", &fib_id))
2135 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2137 if (~0 == fib_index)
2138 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2141 else if (unformat (input, "proxy %U - %U",
2142 unformat_ip4_address, &lo_addr.ip4,
2143 unformat_ip4_address, &hi_addr.ip4))
2151 (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2160 for (i = 0; i < count; i++)
2164 uword event_type, *event_data = 0;
2166 /* Park the debug CLI until the arp entry is installed */
2167 vnet_register_ip4_arp_resolution_event
2168 (vnm, &addr.ip4, vlib_current_process (vm),
2169 1 /* type */ , 0 /* data */ );
2171 vnet_arp_set_ip4_over_ethernet
2172 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
2174 vlib_process_wait_for_event (vm);
2175 event_type = vlib_process_get_events (vm, &event_data);
2176 vec_reset_length (event_data);
2177 if (event_type != 1)
2178 clib_warning ("event type %d unexpected", event_type);
2181 vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2183 increment_ip4_and_mac_address (&addr);
2188 return clib_error_return (0, "unknown input `%U'",
2189 format_unformat_error, input);
2197 * Add or delete IPv4 ARP cache entries.
2199 * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2200 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2201 * any order and combination.
2205 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2206 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2207 * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2208 * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2210 * To add or delete an IPv4 ARP cache entry to or from a specific fib
2212 * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2213 * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2215 * Add or delete IPv4 static ARP cache entries as follows:
2216 * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2217 * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2219 * For testing / debugging purposes, the 'set ip arp' command can add or
2220 * delete multiple entries. Supply the 'count N' parameter:
2221 * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2224 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2225 .path = "set ip arp",
2227 "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2228 .function = ip_arp_add_del_command_fn,
2232 static clib_error_t *
2233 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2235 input, vlib_cli_command_t * cmd)
2237 vnet_main_t *vnm = vnet_get_main ();
2239 vnet_sw_interface_t *si;
2243 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2245 if (unformat (input, "%U", unformat_vnet_sw_interface,
2248 else if (unformat (input, "enable") || unformat (input, "on"))
2250 else if (unformat (input, "disable") || unformat (input, "off"))
2257 return clib_error_return (0, "unknown input '%U'",
2258 format_unformat_error, input);
2260 si = vnet_get_sw_interface (vnm, sw_if_index);
2263 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2265 si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2272 * Enable proxy-arp on an interface. The vpp stack will answer ARP
2273 * requests for the indicated address range. Multiple proxy-arp
2274 * ranges may be provisioned.
2276 * @note Proxy ARP as a technology is infamous for blackholing traffic.
2277 * Also, the underlying implementation has not been performance-tuned.
2278 * Avoid creating an unnecessarily large set of ranges.
2281 * To enable proxy arp on a range of addresses, use:
2282 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2283 * Append 'del' to delete a range of proxy ARP addresses:
2284 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2285 * You must then specifically enable proxy arp on individual interfaces:
2286 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2287 * To disable proxy arp on an individual interface:
2288 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2290 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2291 .path = "set interface proxy-arp",
2293 "set interface proxy-arp <intfc> [enable|disable]",
2294 .function = set_int_proxy_arp_command_fn,
2300 * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2301 * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2305 ARP_TERM_NEXT_L2_OUTPUT,
2310 u32 arp_term_next_node_index[32];
2313 arp_term_l2bd (vlib_main_t * vm,
2314 vlib_node_runtime_t * node, vlib_frame_t * frame)
2316 l2input_main_t *l2im = &l2input_main;
2317 u32 n_left_from, next_index, *from, *to_next;
2318 u32 n_replies_sent = 0;
2319 u16 last_bd_index = ~0;
2320 l2_bridge_domain_t *last_bd_config = 0;
2321 l2_input_config_t *cfg0;
2323 from = vlib_frame_vector_args (frame);
2324 n_left_from = frame->n_vectors;
2325 next_index = node->cached_next_index;
2327 while (n_left_from > 0)
2331 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2333 while (n_left_from > 0 && n_left_to_next > 0)
2336 ethernet_header_t *eth0;
2337 ethernet_arp_header_t *arp0;
2340 u32 pi0, error0, next0, sw_if_index0;
2351 n_left_to_next -= 1;
2353 p0 = vlib_get_buffer (vm, pi0);
2354 // Terminate only local (SHG == 0) ARP
2355 if (vnet_buffer (p0)->l2.shg != 0)
2356 goto next_l2_feature;
2358 eth0 = vlib_buffer_get_current (p0);
2359 l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2360 ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2361 arp0 = (ethernet_arp_header_t *) l3h0;
2363 if (ethertype0 != ETHERNET_TYPE_ARP)
2366 if ((arp0->opcode !=
2367 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request)) &&
2369 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply)))
2372 /* Must be ARP request/reply packet here */
2373 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2374 (p0->flags & VLIB_BUFFER_IS_TRACED)))
2376 u8 *t0 = vlib_add_trace (vm, node, p0,
2377 sizeof (ethernet_arp_input_trace_t));
2378 clib_memcpy (t0, l3h0, sizeof (ethernet_arp_input_trace_t));
2384 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2385 ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2388 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2389 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2391 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2396 /* Trash ARP packets whose ARP-level source addresses do not
2397 match, or if requester address is mcast */
2399 (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2400 sizeof (eth0->src_address)) ||
2401 ethernet_address_cast (arp0->ip4_over_ethernet[0].ethernet)))
2403 /* VRRP virtual MAC may be different to SMAC in ARP reply */
2404 if (memcmp (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2405 sizeof (vrrp_prefix)))
2407 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2412 (ip4_address_is_multicast (&arp0->ip4_over_ethernet[0].ip4)))
2414 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
2418 /* Check if anyone want ARP request events for L2 BDs */
2420 ethernet_arp_main_t *am = ðernet_arp_main;
2421 if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2422 vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2425 /* lookup BD mac_by_ip4 hash table for MAC entry */
2426 ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2427 bd_index0 = vnet_buffer (p0)->l2.bd_index;
2428 if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2429 || (last_bd_index == (u16) ~ 0)))
2431 last_bd_index = bd_index0;
2432 last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2434 macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2436 if (PREDICT_FALSE (!macp0))
2437 goto next_l2_feature; /* MAC not found */
2439 /* MAC found, send ARP reply -
2440 Convert ARP request packet to ARP reply */
2441 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2442 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2443 arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2444 clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2445 clib_memcpy (eth0->dst_address, eth0->src_address, 6);
2446 clib_memcpy (eth0->src_address, macp0, 6);
2447 n_replies_sent += 1;
2450 /* For BVI, need to use l2-fwd node to send ARP reply as
2451 l2-output node cannot output packet to BVI properly */
2452 cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2453 if (PREDICT_FALSE (cfg0->bvi))
2455 vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2456 vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2457 goto next_l2_feature;
2460 /* Send ARP/ND reply back out input interface through l2-output */
2461 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2462 next0 = ARP_TERM_NEXT_L2_OUTPUT;
2463 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2464 to_next, n_left_to_next, pi0,
2469 /* IP6 ND event notification or solicitation handling to generate
2470 local response instead of flooding */
2471 iph0 = (ip6_header_t *) l3h0;
2472 if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2473 iph0->protocol == IP_PROTOCOL_ICMP6 &&
2474 !ip6_address_is_unspecified
2475 (&iph0->src_address)))
2477 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2478 if (vnet_ip6_nd_term
2479 (vm, node, p0, eth0, iph0, sw_if_index0,
2480 vnet_buffer (p0)->l2.bd_index))
2481 goto output_response;
2486 next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2487 L2INPUT_FEAT_ARP_TERM);
2488 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2489 to_next, n_left_to_next,
2495 if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2496 (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2497 arp0->ip4_over_ethernet[1].ip4.as_u32))
2499 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2501 next0 = ARP_TERM_NEXT_DROP;
2502 p0->error = node->errors[error0];
2504 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2505 to_next, n_left_to_next, pi0,
2509 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2512 vlib_error_count (vm, node->node_index,
2513 ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2514 return frame->n_vectors;
2518 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2519 .function = arp_term_l2bd,
2520 .name = "arp-term-l2bd",
2521 .vector_size = sizeof (u32),
2522 .n_errors = ETHERNET_ARP_N_ERROR,
2523 .error_strings = ethernet_arp_error_strings,
2524 .n_next_nodes = ARP_TERM_N_NEXT,
2526 [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2527 [ARP_TERM_NEXT_DROP] = "error-drop",
2529 .format_buffer = format_ethernet_arp_header,
2530 .format_trace = format_arp_term_input_trace,
2535 arp_term_init (vlib_main_t * vm)
2537 // Initialize the feature next-node indexes
2538 feat_bitmap_init_next_nodes (vm,
2539 arp_term_l2bd_node.index,
2541 l2input_get_feat_names (),
2542 arp_term_next_node_index);
2546 VLIB_INIT_FUNCTION (arp_term_init);
2549 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2551 if (e->sw_if_index == sw_if_index)
2553 adj_nbr_walk_nh4 (e->sw_if_index,
2554 &e->ip4_address, arp_mk_complete_walk, e);
2559 ethernet_arp_change_mac (u32 sw_if_index)
2561 ethernet_arp_main_t *am = ðernet_arp_main;
2562 ethernet_arp_ip4_entry_t *e;
2566 pool_foreach (e, am->ip4_entry_pool,
2568 change_arp_mac (sw_if_index, e);
2572 ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2574 if (ADJ_INDEX_INVALID != ai)
2575 adj_glean_update_rewrite (ai);
2579 send_ip4_garp (vlib_main_t * vm, u32 sw_if_index)
2581 ip4_main_t *i4m = &ip4_main;
2582 ip4_address_t *ip4_addr = ip4_interface_first_address (i4m, sw_if_index, 0);
2584 send_ip4_garp_w_addr (vm, ip4_addr, sw_if_index);
2588 send_ip4_garp_w_addr (vlib_main_t * vm,
2589 const ip4_address_t * ip4_addr, u32 sw_if_index)
2591 ip4_main_t *i4m = &ip4_main;
2592 vnet_main_t *vnm = vnet_get_main ();
2593 u8 *rewrite, rewrite_len;
2594 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
2598 clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2599 format_ip4_address, ip4_addr, sw_if_index);
2601 /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2602 where the interface IP/MAC pair is used for both source and request
2603 MAC/IP pairs in the request */
2605 ethernet_arp_header_t *h = vlib_packet_template_get_packet
2606 (vm, &i4m->ip4_arp_request_packet_template, &bi);
2611 clib_memcpy (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2612 sizeof (h->ip4_over_ethernet[0].ethernet));
2613 clib_memcpy (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2614 sizeof (h->ip4_over_ethernet[1].ethernet));
2615 h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2616 h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2618 /* Setup MAC header with ARP Etype and broadcast DMAC */
2619 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2621 ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
2622 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
2623 rewrite_len = vec_len (rewrite);
2624 vlib_buffer_advance (b, -rewrite_len);
2625 ethernet_header_t *e = vlib_buffer_get_current (b);
2626 clib_memcpy (e->dst_address, rewrite, rewrite_len);
2629 /* Send GARP packet out the specified interface */
2630 vnet_buffer (b)->sw_if_index[VLIB_RX] =
2631 vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2632 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2633 u32 *to_next = vlib_frame_vector_args (f);
2636 vlib_put_frame_to_node (vm, hi->output_node_index, f);
2641 * fd.io coding-style-patch-verification: ON
2644 * eval: (c-set-style "gnu")