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>
34 * This file contains code to manage the IPv4 ARP tables (IP Address
35 * to MAC Address lookup).
39 void vl_api_rpc_call_main_thread (void *fp, u8 * data, u32 data_length);
42 * @brief Per-interface ARP configuration and state
44 typedef struct ethernet_arp_interface_t_
47 * Hash table of ARP entries.
48 * Since this hash table is per-interface, the key is only the IPv4 address.
51 } ethernet_arp_interface_t;
55 ip4_address_t lo_addr;
56 ip4_address_t hi_addr;
58 } ethernet_proxy_arp_t;
66 /* Used for arp event notification only */
69 } pending_resolution_t;
73 /* Hash tables mapping name to opcode. */
74 uword *opcode_by_name;
76 /* lite beer "glean" adjacency handling */
77 uword *pending_resolutions_by_address;
78 pending_resolution_t *pending_resolutions;
80 /* Mac address change notification */
81 uword *mac_changes_by_address;
82 pending_resolution_t *mac_changes;
84 ethernet_arp_ip4_entry_t *ip4_entry_pool;
86 /* ARP attack mitigation */
88 u32 limit_arp_cache_size;
90 /** Per interface state */
91 ethernet_arp_interface_t *ethernet_arp_by_sw_if_index;
93 /* Proxy arp vector */
94 ethernet_proxy_arp_t *proxy_arps;
96 uword wc_ip4_arp_publisher_node;
97 uword wc_ip4_arp_publisher_et;
98 } ethernet_arp_main_t;
100 static ethernet_arp_main_t ethernet_arp_main;
105 ethernet_arp_ip4_over_ethernet_address_t a;
109 #define ETHERNET_ARP_ARGS_REMOVE (1<<0)
110 #define ETHERNET_ARP_ARGS_FLUSH (1<<1)
111 #define ETHERNET_ARP_ARGS_POPULATE (1<<2)
112 #define ETHERNET_ARP_ARGS_WC_PUB (1<<3)
113 } vnet_arp_set_ip4_over_ethernet_rpc_args_t;
115 static const u8 vrrp_prefix[] = { 0x00, 0x00, 0x5E, 0x00, 0x01 };
117 /* Node index for send_garp_na_process */
118 u32 send_garp_na_process_node_index;
121 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
125 format_ethernet_arp_hardware_type (u8 * s, va_list * va)
127 ethernet_arp_hardware_type_t h = va_arg (*va, ethernet_arp_hardware_type_t);
131 #define _(n,f) case n: t = #f; break;
132 foreach_ethernet_arp_hardware_type;
136 return format (s, "unknown 0x%x", h);
139 return format (s, "%s", t);
143 format_ethernet_arp_opcode (u8 * s, va_list * va)
145 ethernet_arp_opcode_t o = va_arg (*va, ethernet_arp_opcode_t);
149 #define _(f) case ETHERNET_ARP_OPCODE_##f: t = #f; break;
150 foreach_ethernet_arp_opcode;
154 return format (s, "unknown 0x%x", o);
157 return format (s, "%s", t);
161 unformat_ethernet_arp_opcode_host_byte_order (unformat_input_t * input,
164 int *result = va_arg (*args, int *);
165 ethernet_arp_main_t *am = ðernet_arp_main;
168 /* Numeric opcode. */
169 if (unformat (input, "0x%x", &x) || unformat (input, "%d", &x))
178 if (unformat_user (input, unformat_vlib_number_by_name,
179 am->opcode_by_name, &i))
189 unformat_ethernet_arp_opcode_net_byte_order (unformat_input_t * input,
192 int *result = va_arg (*args, int *);
194 (input, unformat_ethernet_arp_opcode_host_byte_order, result))
197 *result = clib_host_to_net_u16 ((u16) * result);
202 format_ethernet_arp_header (u8 * s, va_list * va)
204 ethernet_arp_header_t *a = va_arg (*va, ethernet_arp_header_t *);
205 u32 max_header_bytes = va_arg (*va, u32);
207 u16 l2_type, l3_type;
209 if (max_header_bytes != 0 && sizeof (a[0]) > max_header_bytes)
210 return format (s, "ARP header truncated");
212 l2_type = clib_net_to_host_u16 (a->l2_type);
213 l3_type = clib_net_to_host_u16 (a->l3_type);
215 indent = format_get_indent (s);
217 s = format (s, "%U, type %U/%U, address size %d/%d",
218 format_ethernet_arp_opcode, clib_net_to_host_u16 (a->opcode),
219 format_ethernet_arp_hardware_type, l2_type,
220 format_ethernet_type, l3_type,
221 a->n_l2_address_bytes, a->n_l3_address_bytes);
223 if (l2_type == ETHERNET_ARP_HARDWARE_TYPE_ethernet
224 && l3_type == ETHERNET_TYPE_IP4)
226 s = format (s, "\n%U%U/%U -> %U/%U",
227 format_white_space, indent,
228 format_ethernet_address, a->ip4_over_ethernet[0].ethernet,
229 format_ip4_address, &a->ip4_over_ethernet[0].ip4,
230 format_ethernet_address, a->ip4_over_ethernet[1].ethernet,
231 format_ip4_address, &a->ip4_over_ethernet[1].ip4);
235 uword n2 = a->n_l2_address_bytes;
236 uword n3 = a->n_l3_address_bytes;
237 s = format (s, "\n%U%U/%U -> %U/%U",
238 format_white_space, indent,
239 format_hex_bytes, a->data + 0 * n2 + 0 * n3, n2,
240 format_hex_bytes, a->data + 1 * n2 + 0 * n3, n3,
241 format_hex_bytes, a->data + 1 * n2 + 1 * n3, n2,
242 format_hex_bytes, a->data + 2 * n2 + 1 * n3, n3);
249 format_ethernet_arp_ip4_entry (u8 * s, va_list * va)
251 vnet_main_t *vnm = va_arg (*va, vnet_main_t *);
252 ethernet_arp_ip4_entry_t *e = va_arg (*va, ethernet_arp_ip4_entry_t *);
253 vnet_sw_interface_t *si;
257 return format (s, "%=12s%=16s%=6s%=20s%=24s", "Time", "IP4",
258 "Flags", "Ethernet", "Interface");
260 si = vnet_get_sw_interface (vnm, e->sw_if_index);
262 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
263 flags = format (flags, "S");
265 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
266 flags = format (flags, "D");
268 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY)
269 flags = format (flags, "N");
271 s = format (s, "%=12U%=16U%=6s%=20U%U",
272 format_vlib_time, vnm->vlib_main, e->time_last_updated,
273 format_ip4_address, &e->ip4_address,
274 flags ? (char *) flags : "",
275 format_ethernet_address, e->ethernet_address,
276 format_vnet_sw_interface_name, vnm, si);
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 clib_memcpy (h->ip4_over_ethernet[0].ethernet,
361 hi->hw_address, sizeof (h->ip4_over_ethernet[0].ethernet));
363 h->ip4_over_ethernet[0].ip4 = src[0];
364 h->ip4_over_ethernet[1].ip4 = adj->sub_type.nbr.next_hop.ip4;
366 b = vlib_get_buffer (vm, bi);
367 vnet_buffer (b)->sw_if_index[VLIB_RX] =
368 vnet_buffer (b)->sw_if_index[VLIB_TX] = adj->rewrite_header.sw_if_index;
370 /* Add encapsulation string for software interface (e.g. ethernet header). */
371 vnet_rewrite_one_header (adj[0], h, sizeof (ethernet_header_t));
372 vlib_buffer_advance (b, -adj->rewrite_header.data_bytes);
375 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
376 u32 *to_next = vlib_frame_vector_args (f);
379 vlib_put_frame_to_node (vm, hi->output_node_index, f);
384 arp_mk_complete (adj_index_t ai, ethernet_arp_ip4_entry_t * e)
386 adj_nbr_update_rewrite
387 (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
388 ethernet_build_rewrite (vnet_get_main (),
390 adj_get_link_type (ai), e->ethernet_address));
394 arp_mk_incomplete (adj_index_t ai)
396 ip_adjacency_t *adj = adj_get (ai);
398 adj_nbr_update_rewrite
400 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
401 ethernet_build_rewrite (vnet_get_main (),
402 adj->rewrite_header.sw_if_index,
404 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
407 static ethernet_arp_ip4_entry_t *
408 arp_entry_find (ethernet_arp_interface_t * eai, const ip4_address_t * addr)
410 ethernet_arp_main_t *am = ðernet_arp_main;
411 ethernet_arp_ip4_entry_t *e = NULL;
414 if (NULL != eai->arp_entries)
416 p = hash_get (eai->arp_entries, addr->as_u32);
420 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
427 arp_mk_complete_walk (adj_index_t ai, void *ctx)
429 ethernet_arp_ip4_entry_t *e = ctx;
431 arp_mk_complete (ai, e);
433 return (ADJ_WALK_RC_CONTINUE);
437 arp_mk_incomplete_walk (adj_index_t ai, void *ctx)
439 arp_mk_incomplete (ai);
441 return (ADJ_WALK_RC_CONTINUE);
445 arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
447 ethernet_arp_main_t *am = ðernet_arp_main;
448 ethernet_arp_interface_t *arp_int;
449 ethernet_arp_ip4_entry_t *e;
454 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
455 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
456 e = arp_entry_find (arp_int, &adj->sub_type.nbr.next_hop.ip4);
458 switch (adj->lookup_next_index)
460 case IP_LOOKUP_NEXT_GLEAN:
461 adj_glean_update_rewrite (ai);
463 case IP_LOOKUP_NEXT_ARP:
466 adj_nbr_walk_nh4 (sw_if_index,
467 &e->ip4_address, arp_mk_complete_walk, e);
472 * no matching ARP entry.
473 * construct the rewrite required to for an ARP packet, and stick
474 * that in the adj's pipe to smoke.
476 adj_nbr_update_rewrite
478 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
479 ethernet_build_rewrite
483 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
486 * since the FIB has added this adj for a route, it makes sense it
487 * may want to forward traffic sometime soon. Let's send a
488 * speculative ARP. just one. If we were to do periodically that
489 * wouldn't be bad either, but that's more code than i'm prepared to
490 * write at this time for relatively little reward.
495 case IP_LOOKUP_NEXT_BCAST:
496 adj_nbr_update_rewrite (ai,
497 ADJ_NBR_REWRITE_FLAG_COMPLETE,
498 ethernet_build_rewrite
502 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
504 case IP_LOOKUP_NEXT_MCAST:
507 * Construct a partial rewrite from the known ethernet mcast dest MAC
512 rewrite = ethernet_build_rewrite (vnm,
515 ethernet_ip4_mcast_dst_addr ());
516 offset = vec_len (rewrite) - 2;
519 * Complete the remaining fields of the adj's rewrite to direct the
520 * complete of the rewrite at switch time by copying in the IP
521 * dst address's bytes.
522 * Ofset is 2 bytes into the MAC desintation address.
524 adj_mcast_update_rewrite (ai, rewrite, offset);
528 case IP_LOOKUP_NEXT_DROP:
529 case IP_LOOKUP_NEXT_PUNT:
530 case IP_LOOKUP_NEXT_LOCAL:
531 case IP_LOOKUP_NEXT_REWRITE:
532 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
533 case IP_LOOKUP_NEXT_MIDCHAIN:
534 case IP_LOOKUP_NEXT_ICMP_ERROR:
535 case IP_LOOKUP_N_NEXT:
542 arp_adj_fib_add (ethernet_arp_ip4_entry_t * e, u32 fib_index)
546 .fp_proto = FIB_PROTOCOL_IP4,
547 .fp_addr.ip4 = e->ip4_address,
551 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
552 FIB_ENTRY_FLAG_ATTACHED,
553 DPO_PROTO_IP4, &pfx.fp_addr,
554 e->sw_if_index, ~0, 1, NULL,
555 FIB_ROUTE_PATH_FLAG_NONE);
556 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
560 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
562 if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
566 .fp_proto = FIB_PROTOCOL_IP4,
567 .fp_addr.ip4 = e->ip4_address,
571 fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
573 fib_table_entry_path_remove (fib_index, &pfx,
577 e->sw_if_index, ~0, 1,
578 FIB_ROUTE_PATH_FLAG_NONE);
579 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
583 static ethernet_arp_ip4_entry_t *
584 force_reuse_arp_entry (void)
586 ethernet_arp_ip4_entry_t *e;
587 ethernet_arp_main_t *am = ðernet_arp_main;
589 u32 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
590 if (index == ~0) /* Try again from elt 0 */
591 index = pool_next_index (am->ip4_entry_pool, index);
593 /* Find a non-static random entry to free up for reuse */
596 if ((count++ == 100) || (index == ~0))
597 return NULL; /* give up after 100 entries */
598 e = pool_elt_at_index (am->ip4_entry_pool, index);
599 am->arp_delete_rotor = index;
600 index = pool_next_index (am->ip4_entry_pool, index);
602 while (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC);
604 /* Remove ARP entry from its interface and update fib */
606 (am->ethernet_arp_by_sw_if_index[e->sw_if_index].arp_entries,
607 e->ip4_address.as_u32);
609 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
610 adj_nbr_walk_nh4 (e->sw_if_index,
611 &e->ip4_address, arp_mk_incomplete_walk, NULL);
616 vnet_arp_set_ip4_over_ethernet_internal (vnet_main_t * vnm,
617 vnet_arp_set_ip4_over_ethernet_rpc_args_t
620 ethernet_arp_ip4_entry_t *e = 0;
621 ethernet_arp_main_t *am = ðernet_arp_main;
622 ethernet_arp_ip4_over_ethernet_address_t *a = &args->a;
623 vlib_main_t *vm = vlib_get_main ();
624 int make_new_arp_cache_entry = 1;
626 pending_resolution_t *pr, *mc;
627 ethernet_arp_interface_t *arp_int;
628 int is_static = args->is_static;
629 u32 sw_if_index = args->sw_if_index;
630 int is_no_fib_entry = args->is_no_fib_entry;
632 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
634 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
636 if (NULL != arp_int->arp_entries)
638 p = hash_get (arp_int->arp_entries, a->ip4.as_u32);
641 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
643 /* Refuse to over-write static arp. */
644 if (!is_static && (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC))
646 /* if MAC address match, still check to send event */
647 if (0 == memcmp (e->ethernet_address,
648 a->ethernet, sizeof (e->ethernet_address)))
649 goto check_customers;
652 make_new_arp_cache_entry = 0;
656 if (make_new_arp_cache_entry)
658 if (am->limit_arp_cache_size &&
659 pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
661 e = force_reuse_arp_entry ();
666 pool_get (am->ip4_entry_pool, e);
668 if (NULL == arp_int->arp_entries)
669 arp_int->arp_entries = hash_create (0, sizeof (u32));
671 hash_set (arp_int->arp_entries, a->ip4.as_u32, e - am->ip4_entry_pool);
673 e->sw_if_index = sw_if_index;
674 e->ip4_address = a->ip4;
675 e->fib_entry_index = FIB_NODE_INDEX_INVALID;
676 clib_memcpy (e->ethernet_address,
677 a->ethernet, sizeof (e->ethernet_address));
679 if (!is_no_fib_entry)
682 ip4_fib_table_get_index_for_sw_if_index
687 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY;
693 * prevent a DoS attack from the data-plane that
694 * spams us with no-op updates to the MAC address
696 if (0 == memcmp (e->ethernet_address,
697 a->ethernet, sizeof (e->ethernet_address)))
699 e->time_last_updated = vlib_time_now (vm);
700 goto check_customers;
703 /* Update ethernet address. */
704 clib_memcpy (e->ethernet_address, a->ethernet,
705 sizeof (e->ethernet_address));
708 /* Update time stamp and flags. */
709 e->time_last_updated = vlib_time_now (vm);
712 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
713 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
717 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
718 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
721 adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
724 /* Customer(s) waiting for this address to be resolved? */
725 p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
731 while (next_index != (u32) ~ 0)
733 pr = pool_elt_at_index (am->pending_resolutions, next_index);
734 vlib_process_signal_event (vm, pr->node_index,
735 pr->type_opaque, pr->data);
736 next_index = pr->next_index;
737 pool_put (am->pending_resolutions, pr);
740 hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
743 /* Customer(s) requesting ARP event for this address? */
744 p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
750 while (next_index != (u32) ~ 0)
752 int (*fp) (u32, u8 *, u32, u32);
754 mc = pool_elt_at_index (am->mac_changes, next_index);
755 fp = mc->data_callback;
757 /* Call the user's data callback, return 1 to suppress dup events */
759 rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
762 * Signal the resolver process, as long as the user
763 * says they want to be notified
766 vlib_process_signal_event (vm, mc->node_index,
767 mc->type_opaque, mc->data);
768 next_index = mc->next_index;
776 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
779 uword type_opaque, uword data)
781 ethernet_arp_main_t *am = ðernet_arp_main;
782 ip4_address_t *address = address_arg;
784 pending_resolution_t *pr;
786 pool_get (am->pending_resolutions, pr);
789 pr->node_index = node_index;
790 pr->type_opaque = type_opaque;
792 pr->data_callback = 0;
794 p = hash_get (am->pending_resolutions_by_address, address->as_u32);
797 /* Insert new resolution at the head of the list */
798 pr->next_index = p[0];
799 hash_unset (am->pending_resolutions_by_address, address->as_u32);
802 hash_set (am->pending_resolutions_by_address, address->as_u32,
803 pr - am->pending_resolutions);
807 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
812 uword type_opaque, uword data, int is_add)
814 ethernet_arp_main_t *am = ðernet_arp_main;
815 ip4_address_t *address = address_arg;
817 /* Try to find an existing entry */
818 u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
820 pending_resolution_t *mc;
821 while (p && *p != ~0)
823 mc = pool_elt_at_index (am->mac_changes, *p);
824 if (mc->node_index == node_index && mc->type_opaque == type_opaque
830 int found = p && *p != ~0;
834 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
836 pool_get (am->mac_changes, mc);
837 *mc = (pending_resolution_t)
839 .next_index = ~0,.node_index = node_index,.type_opaque =
840 type_opaque,.data = data,.data_callback = data_callback,.pid =
843 /* Insert new resolution at the end of the list */
844 u32 new_idx = mc - am->mac_changes;
848 hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
853 return VNET_API_ERROR_NO_SUCH_ENTRY;
855 /* Clients may need to clean up pool entries, too */
856 void (*fp) (u32, u8 *) = data_callback;
858 (*fp) (mc->data, 0 /* no new mac addrs */ );
860 /* Remove the entry from the list and delete the entry */
862 pool_put (am->mac_changes, mc);
864 /* Remove from hash if we deleted the last entry */
865 if (*p == ~0 && p == first)
866 hash_unset (am->mac_changes_by_address, address->as_u32);
871 /* Either we drop the packet or we send a reply to the sender. */
875 ARP_INPUT_NEXT_REPLY_TX,
879 #define foreach_ethernet_arp_error \
880 _ (replies_sent, "ARP replies sent") \
881 _ (l2_type_not_ethernet, "L2 type not ethernet") \
882 _ (l3_type_not_ip4, "L3 type not IP4") \
883 _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
884 _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
885 _ (l3_dst_address_unset, "IP4 destination address is unset") \
886 _ (l3_src_address_is_local, "IP4 source address matches local interface") \
887 _ (l3_src_address_learned, "ARP request IP4 source address learned") \
888 _ (replies_received, "ARP replies received") \
889 _ (opcode_not_request, "ARP opcode not request") \
890 _ (proxy_arp_replies_sent, "Proxy ARP replies sent") \
891 _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
892 _ (gratuitous_arp, "ARP probe or announcement dropped") \
893 _ (interface_no_table, "Interface is not mapped to an IP table") \
894 _ (interface_not_ip_enabled, "Interface is not IP enabled") \
898 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
899 foreach_ethernet_arp_error
901 ETHERNET_ARP_N_ERROR,
902 } ethernet_arp_input_error_t;
905 arp_unnumbered (vlib_buffer_t * p0,
906 u32 input_sw_if_index, u32 conn_sw_if_index)
908 vnet_main_t *vnm = vnet_get_main ();
909 vnet_interface_main_t *vim = &vnm->interface_main;
910 vnet_sw_interface_t *si;
912 /* verify that the input interface is unnumbered to the connected.
913 * the connected interface is the interface on which the subnet is
915 si = &vim->sw_interfaces[input_sw_if_index];
917 if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
918 (si->unnumbered_sw_if_index == conn_sw_if_index)))
920 /* the input interface is not unnumbered to the interface on which
921 * the sub-net is configured that covers the ARP request.
922 * So this is not the case for unnumbered.. */
930 arp_learn (vnet_main_t * vnm,
931 ethernet_arp_main_t * am, u32 sw_if_index, void *addr)
933 vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
934 return (ETHERNET_ARP_ERROR_l3_src_address_learned);
938 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
940 ethernet_arp_main_t *am = ðernet_arp_main;
941 vnet_main_t *vnm = vnet_get_main ();
942 ip4_main_t *im4 = &ip4_main;
943 u32 n_left_from, next_index, *from, *to_next;
944 u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
946 from = vlib_frame_vector_args (frame);
947 n_left_from = frame->n_vectors;
948 next_index = node->cached_next_index;
950 if (node->flags & VLIB_NODE_FLAG_TRACE)
951 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
953 sizeof (ethernet_arp_input_trace_t));
955 while (n_left_from > 0)
959 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
961 while (n_left_from > 0 && n_left_to_next > 0)
964 vnet_hw_interface_t *hw_if0;
965 ethernet_arp_header_t *arp0;
966 ethernet_header_t *eth_rx, *eth_tx;
967 const ip4_address_t *if_addr0;
968 ip4_address_t proxy_src;
969 u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
970 u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
971 ethernet_proxy_arp_t *pa;
972 fib_node_index_t dst_fei, src_fei;
973 const fib_prefix_t *pfx0;
974 fib_entry_flag_t src_flags, dst_flags;
975 u8 *rewrite0, rewrite0_len;
985 p0 = vlib_get_buffer (vm, pi0);
986 arp0 = vlib_buffer_get_current (p0);
987 /* Fill in ethernet header. */
988 eth_rx = ethernet_buffer_get_header (p0);
990 is_request0 = arp0->opcode
991 == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
993 error0 = ETHERNET_ARP_ERROR_replies_sent;
997 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
998 ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
1001 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
1002 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
1004 (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ?
1005 ETHERNET_ARP_ERROR_l3_dst_address_unset : error0);
1007 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1009 /* not playing the ARP game if the interface is not IPv4 enabled */
1011 (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
1012 ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
1017 /* Check that IP address is local and matches incoming interface. */
1018 fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1019 if (~0 == fib_index0)
1021 error0 = ETHERNET_ARP_ERROR_interface_no_table;
1025 dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1026 &arp0->ip4_over_ethernet[1].ip4,
1028 dst_flags = fib_entry_get_flags (dst_fei);
1030 conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
1032 /* Honor unnumbered interface, if any */
1033 is_unnum0 = sw_if_index0 != conn_sw_if_index0;
1037 * we're looking for FIB entries that indicate the source
1038 * is attached. There may be more specific non-attached
1039 * routes that match the source, but these do not influence
1040 * whether we respond to an ARP request, i.e. they do not
1041 * influence whether we are the correct way for the sender
1042 * to reach us, they only affect how we reach the sender.
1044 fib_entry_t *src_fib_entry;
1045 const fib_prefix_t *pfx;
1046 fib_entry_src_t *src;
1047 fib_source_t source;
1056 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1058 ip4_over_ethernet[0].ip4,
1060 src_fib_entry = fib_entry_get (src_fei);
1063 * It's possible that the source that provides the
1064 * flags we need, or the flags we must not have,
1065 * is not the best source, so check then all.
1068 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1070 src_flags = fib_entry_get_flags_for_source (src_fei, source);
1072 /* Reject requests/replies with our local interface
1074 if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1076 error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1078 * When VPP has an interface whose address is also
1079 * applied to a TAP interface on the host, then VPP's
1080 * TAP interface will be unnumbered to the 'real'
1081 * interface and do proxy ARP from the host.
1082 * The curious aspect of this setup is that ARP requests
1083 * from the host will come from the VPP's own address.
1084 * So don't drop immediately here, instead go see if this
1085 * is a proxy ARP case.
1089 /* A Source must also be local to subnet of matching
1090 * interface address. */
1091 if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1092 (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1099 * The packet was sent from an address that is not
1100 * connected nor attached i.e. it is not from an
1101 * address that is covered by a link's sub-net,
1102 * nor is it a already learned host resp.
1108 * shorter mask lookup for the next iteration.
1110 pfx = fib_entry_get_prefix (src_fei);
1111 mask = pfx->fp_len - 1;
1114 * continue until we hit the default route or we find
1115 * the attached we are looking for. The most likely
1116 * outcome is we find the attached with the first source
1117 * on the first lookup.
1121 !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1126 * the matching route is a not attached, i.e. it was
1127 * added as a result of routing, rather than interface/ARP
1128 * configuration. If the matching route is not a host route
1131 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1136 if (fib_entry_is_sourced (dst_fei, FIB_SOURCE_ADJ))
1139 * We matched an adj-fib on ths source subnet (a /32 previously
1140 * added as a result of ARP). If this request is a gratuitous
1141 * ARP, then learn from it.
1142 * The check for matching an adj-fib, is to prevent hosts
1143 * from spamming us with gratuitous ARPS that might otherwise
1144 * blow our ARP cache
1146 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1147 arp0->ip4_over_ethernet[1].ip4.as_u32)
1148 error0 = arp_learn (vnm, am, sw_if_index0,
1149 &arp0->ip4_over_ethernet[0]);
1152 else if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1154 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1158 if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1161 * The interface the ARP was received on is not the interface
1162 * on which the covering prefix is configured. Maybe this is a
1163 * case for unnumbered.
1168 dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1169 pfx0 = fib_entry_get_prefix (dst_fei);
1170 if_addr0 = &pfx0->fp_addr.ip4;
1174 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1177 (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1178 sizeof (vrrp_prefix))));
1180 /* Trash ARP packets whose ARP-level source addresses do not
1181 match their L2-frame-level source addresses, unless it's
1182 a reply from a VRRP virtual router */
1184 (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1185 sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1187 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1191 /* Learn or update sender's mapping only for replies to addresses
1192 * that are local to the subnet */
1194 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1197 error0 = arp_learn (vnm, am, sw_if_index0,
1198 &arp0->ip4_over_ethernet[0]);
1200 /* a reply for a non-local destination could be a GARP.
1201 * GARPs for hosts we know were handled above, so this one
1203 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1207 else if (arp0->opcode ==
1208 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1209 (dst_is_local0 == 0))
1216 An adjacency to the sender is not always present,
1217 so we use the interface to build us a rewrite string
1218 which will contain all the necessary tags. */
1219 rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1221 eth_rx->src_address);
1222 rewrite0_len = vec_len (rewrite0);
1224 /* Figure out how much to rewind current data from adjacency. */
1225 vlib_buffer_advance (p0, -rewrite0_len);
1226 eth_tx = vlib_buffer_get_current (p0);
1228 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1229 hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1231 /* Send reply back through input interface */
1232 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1233 next0 = ARP_INPUT_NEXT_REPLY_TX;
1235 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1237 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1239 clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1240 hw_if0->hw_address, 6);
1241 clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1244 /* Hardware must be ethernet-like. */
1245 ASSERT (vec_len (hw_if0->hw_address) == 6);
1247 /* the rx nd tx ethernet headers wil overlap in the case
1248 * when we received a tagged VLAN=0 packet, but we are sending
1250 clib_memcpy (eth_tx, rewrite0, vec_len (rewrite0));
1251 vec_free (rewrite0);
1257 if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1262 /* We are going to reply to this request, so, in the absence of
1263 errors, learn the sender */
1265 error0 = arp_learn (vnm, am, sw_if_index0,
1266 &arp0->ip4_over_ethernet[1]);
1268 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1269 n_left_to_next, pi0, next0);
1271 n_replies_sent += 1;
1275 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1276 arp0->ip4_over_ethernet[1].ip4.as_u32)
1278 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1281 /* See if proxy arp is configured for the address */
1284 vnet_sw_interface_t *si;
1285 u32 this_addr = clib_net_to_host_u32
1286 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1289 si = vnet_get_sw_interface (vnm, sw_if_index0);
1291 if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1294 fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1297 vec_foreach (pa, am->proxy_arps)
1299 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr.as_u32);
1300 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr.as_u32);
1302 /* an ARP request hit in the proxy-arp table? */
1303 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1304 (fib_index0 == pa->fib_index))
1307 arp0->ip4_over_ethernet[1].ip4.data_u32;
1310 * change the interface address to the proxied
1312 if_addr0 = &proxy_src;
1314 n_proxy_arp_replies_sent++;
1322 next0 = ARP_INPUT_NEXT_DROP;
1323 p0->error = node->errors[error0];
1325 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1326 n_left_to_next, pi0, next0);
1329 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1332 vlib_error_count (vm, node->node_index,
1333 ETHERNET_ARP_ERROR_replies_sent,
1334 n_replies_sent - n_proxy_arp_replies_sent);
1336 vlib_error_count (vm, node->node_index,
1337 ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1338 n_proxy_arp_replies_sent);
1339 return frame->n_vectors;
1342 static char *ethernet_arp_error_strings[] = {
1343 #define _(sym,string) string,
1344 foreach_ethernet_arp_error
1349 VLIB_REGISTER_NODE (arp_input_node, static) =
1351 .function = arp_input,
1352 .name = "arp-input",
1353 .vector_size = sizeof (u32),
1354 .n_errors = ETHERNET_ARP_N_ERROR,
1355 .error_strings = ethernet_arp_error_strings,
1356 .n_next_nodes = ARP_INPUT_N_NEXT,
1358 [ARP_INPUT_NEXT_DROP] = "error-drop",
1359 [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1361 .format_buffer = format_ethernet_arp_header,
1362 .format_trace = format_ethernet_arp_input_trace,
1367 ip4_arp_entry_sort (void *a1, void *a2)
1369 ethernet_arp_ip4_entry_t *e1 = a1;
1370 ethernet_arp_ip4_entry_t *e2 = a2;
1373 vnet_main_t *vnm = vnet_get_main ();
1375 cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1377 cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1381 ethernet_arp_ip4_entry_t *
1382 ip4_neighbors_pool (void)
1384 ethernet_arp_main_t *am = ðernet_arp_main;
1385 return am->ip4_entry_pool;
1388 ethernet_arp_ip4_entry_t *
1389 ip4_neighbor_entries (u32 sw_if_index)
1391 ethernet_arp_main_t *am = ðernet_arp_main;
1392 ethernet_arp_ip4_entry_t *n, *ns = 0;
1395 pool_foreach (n, am->ip4_entry_pool, ({
1396 if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1398 vec_add1 (ns, n[0]);
1403 vec_sort_with_function (ns, ip4_arp_entry_sort);
1407 static clib_error_t *
1408 show_ip4_arp (vlib_main_t * vm,
1409 unformat_input_t * input, vlib_cli_command_t * cmd)
1411 vnet_main_t *vnm = vnet_get_main ();
1412 ethernet_arp_main_t *am = ðernet_arp_main;
1413 ethernet_arp_ip4_entry_t *e, *es;
1414 ethernet_proxy_arp_t *pa;
1415 clib_error_t *error = 0;
1418 /* Filter entries by interface if given. */
1420 (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1422 es = ip4_neighbor_entries (sw_if_index);
1425 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1428 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1433 if (vec_len (am->proxy_arps))
1435 vlib_cli_output (vm, "Proxy arps enabled for:");
1436 vec_foreach (pa, am->proxy_arps)
1438 vlib_cli_output (vm, "Fib_index %d %U - %U ",
1440 format_ip4_address, &pa->lo_addr,
1441 format_ip4_address, &pa->hi_addr);
1449 * Display all the IPv4 ARP entries.
1452 * Example of how to display the IPv4 ARP table:
1453 * @cliexstart{show ip arp}
1454 * Time FIB IP4 Flags Ethernet Interface
1455 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
1456 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
1457 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
1458 * Proxy arps enabled for:
1459 * Fib_index 0 6.0.0.1 - 6.0.0.11
1463 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1464 .path = "show ip arp",
1465 .function = show_ip4_arp,
1466 .short_help = "show ip arp",
1472 pg_edit_t l2_type, l3_type;
1473 pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1479 } ip4_over_ethernet[2];
1480 } pg_ethernet_arp_header_t;
1483 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1485 /* Initialize fields that are not bit fields in the IP header. */
1486 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1489 _(n_l2_address_bytes);
1490 _(n_l3_address_bytes);
1492 _(ip4_over_ethernet[0].ethernet);
1493 _(ip4_over_ethernet[0].ip4);
1494 _(ip4_over_ethernet[1].ethernet);
1495 _(ip4_over_ethernet[1].ip4);
1500 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1502 pg_stream_t *s = va_arg (*args, pg_stream_t *);
1503 pg_ethernet_arp_header_t *p;
1506 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1508 pg_ethernet_arp_header_init (p);
1511 pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1512 pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1513 pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1514 pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1516 if (!unformat (input, "%U: %U/%U -> %U/%U",
1518 unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1520 unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1522 unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1524 unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1526 unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1528 /* Free up any edits we may have added. */
1529 pg_free_edit_group (s);
1536 ip4_set_arp_limit (u32 arp_limit)
1538 ethernet_arp_main_t *am = ðernet_arp_main;
1540 am->limit_arp_cache_size = arp_limit;
1545 * @brief Control Plane hook to remove an ARP entry
1548 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1549 u32 sw_if_index, void *a_arg)
1551 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1552 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1554 args.sw_if_index = sw_if_index;
1555 args.flags = ETHERNET_ARP_ARGS_REMOVE;
1556 clib_memcpy (&args.a, a, sizeof (*a));
1558 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1559 (u8 *) & args, sizeof (args));
1564 * @brief Internally generated event to flush the ARP cache on an
1565 * interface state change event.
1566 * A flush will remove dynamic ARP entries, and for statics remove the MAC
1567 * address from the corresponding adjacencies.
1570 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1571 u32 sw_if_index, void *a_arg)
1573 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1574 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1576 args.sw_if_index = sw_if_index;
1577 args.flags = ETHERNET_ARP_ARGS_FLUSH;
1578 clib_memcpy (&args.a, a, sizeof (*a));
1580 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1581 (u8 *) & args, sizeof (args));
1586 * @brief Internally generated event to populate the ARP cache on an
1587 * interface state change event.
1588 * For static entries this will re-source the adjacencies.
1590 * @param sw_if_index The interface on which the ARP entires are acted
1593 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1594 u32 sw_if_index, void *a_arg)
1596 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1597 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1599 args.sw_if_index = sw_if_index;
1600 args.flags = ETHERNET_ARP_ARGS_POPULATE;
1601 clib_memcpy (&args.a, a, sizeof (*a));
1603 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1604 (u8 *) & args, sizeof (args));
1609 * @brief publish wildcard arp event
1610 * @param sw_if_index The interface on which the ARP entires are acted
1613 vnet_arp_wc_publish (u32 sw_if_index, void *a_arg)
1615 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1616 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1617 .flags = ETHERNET_ARP_ARGS_WC_PUB,
1618 .sw_if_index = sw_if_index,
1622 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1623 (u8 *) & args, sizeof (args));
1628 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1629 vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1632 vlib_main_t *vm = vlib_get_main ();
1633 ethernet_arp_main_t *am = ðernet_arp_main;
1634 uword ni = am->wc_ip4_arp_publisher_node;
1635 uword et = am->wc_ip4_arp_publisher_et;
1637 if (ni == (uword) ~ 0)
1639 wc_arp_report_t *r =
1640 vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1641 r->ip4 = args->a.ip4.as_u32;
1642 r->sw_if_index = args->sw_if_index;
1643 memcpy (r->mac, args->a.ethernet, sizeof r->mac);
1647 wc_arp_set_publisher_node (uword node_index, uword event_type)
1649 ethernet_arp_main_t *am = ðernet_arp_main;
1650 am->wc_ip4_arp_publisher_node = node_index;
1651 am->wc_ip4_arp_publisher_et = event_type;
1655 * arp_add_del_interface_address
1657 * callback when an interface address is added or deleted
1660 arp_add_del_interface_address (ip4_main_t * im,
1663 ip4_address_t * address,
1665 u32 if_address_index, u32 is_del)
1668 * Flush the ARP cache of all entries covered by the address
1669 * that is being removed.
1671 ethernet_arp_main_t *am = ðernet_arp_main;
1672 ethernet_arp_ip4_entry_t *e;
1674 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1679 ethernet_arp_interface_t *eai;
1680 u32 i, *to_delete = 0;
1683 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1686 hash_foreach_pair (pair, eai->arp_entries,
1688 e = pool_elt_at_index(am->ip4_entry_pool,
1690 if (ip4_destination_matches_route (im, &e->ip4_address,
1691 address, address_length))
1693 vec_add1 (to_delete, e - am->ip4_entry_pool);
1698 for (i = 0; i < vec_len (to_delete); i++)
1700 ethernet_arp_ip4_over_ethernet_address_t delme;
1701 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1703 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1704 delme.ip4.as_u32 = e->ip4_address.as_u32;
1706 vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1707 e->sw_if_index, &delme);
1710 vec_free (to_delete);
1715 arp_table_bind (ip4_main_t * im,
1717 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
1719 ethernet_arp_main_t *am = ðernet_arp_main;
1720 ethernet_arp_interface_t *eai;
1721 ethernet_arp_ip4_entry_t *e;
1725 * the IP table that the interface is bound to has changed.
1726 * reinstall all the adj fibs.
1729 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1732 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1735 hash_foreach_pair (pair, eai->arp_entries,
1737 e = pool_elt_at_index(am->ip4_entry_pool,
1740 * remove the adj-fib from the old table and add to the new
1742 arp_adj_fib_remove(e, old_fib_index);
1743 arp_adj_fib_add(e, new_fib_index);
1749 static clib_error_t *
1750 ethernet_arp_init (vlib_main_t * vm)
1752 ethernet_arp_main_t *am = ðernet_arp_main;
1753 ip4_main_t *im = &ip4_main;
1754 clib_error_t *error;
1757 if ((error = vlib_call_init_function (vm, ethernet_init)))
1760 ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1762 pn = pg_get_node (arp_input_node.index);
1763 pn->unformat_edit = unformat_pg_arp_header;
1765 am->opcode_by_name = hash_create_string (0, sizeof (uword));
1766 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1767 foreach_ethernet_arp_opcode;
1770 /* $$$ configurable */
1771 am->limit_arp_cache_size = 50000;
1773 am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1774 am->mac_changes_by_address = hash_create (0, sizeof (uword));
1775 am->wc_ip4_arp_publisher_node = (uword) ~ 0;
1777 /* don't trace ARP error packets */
1779 vlib_node_runtime_t *rt =
1780 vlib_node_get_runtime (vm, arp_input_node.index);
1783 vnet_pcap_drop_trace_filter_add_del \
1784 (rt->errors[ETHERNET_ARP_ERROR_##a], \
1786 foreach_ethernet_arp_error
1790 ip4_add_del_interface_address_callback_t cb;
1791 cb.function = arp_add_del_interface_address;
1792 cb.function_opaque = 0;
1793 vec_add1 (im->add_del_interface_address_callbacks, cb);
1795 ip4_table_bind_callback_t cbt;
1796 cbt.function = arp_table_bind;
1797 cbt.function_opaque = 0;
1798 vec_add1 (im->table_bind_callbacks, cbt);
1803 VLIB_INIT_FUNCTION (ethernet_arp_init);
1806 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1808 ethernet_arp_main_t *am = ðernet_arp_main;
1811 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
1812 hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1813 pool_put (am->ip4_entry_pool, e);
1817 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1818 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1821 ethernet_arp_main_t *am = ðernet_arp_main;
1822 ethernet_arp_ip4_entry_t *e;
1823 ethernet_arp_interface_t *eai;
1825 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1828 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1830 e = arp_entry_find (eai, &args->a.ip4);
1834 adj_nbr_walk_nh4 (e->sw_if_index,
1835 &e->ip4_address, arp_mk_incomplete_walk, NULL);
1836 arp_entry_free (eai, e);
1843 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1844 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1847 ethernet_arp_main_t *am = ðernet_arp_main;
1848 ethernet_arp_ip4_entry_t *e;
1849 ethernet_arp_interface_t *eai;
1851 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1854 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1856 e = arp_entry_find (eai, &args->a.ip4);
1860 adj_nbr_walk_nh4 (e->sw_if_index,
1861 &e->ip4_address, arp_mk_incomplete_walk, e);
1864 * The difference between flush and unset, is that an unset
1865 * means delete for static and dynamic entries. A flush
1866 * means delete only for dynamic. Flushing is what the DP
1867 * does in response to interface events. unset is only done
1868 * by the control plane.
1870 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
1872 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
1874 else if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1876 arp_entry_free (eai, e);
1883 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1884 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1887 ethernet_arp_main_t *am = ðernet_arp_main;
1888 ethernet_arp_ip4_entry_t *e;
1889 ethernet_arp_interface_t *eai;
1891 vec_validate (am->ethernet_arp_by_sw_if_index, args->sw_if_index);
1892 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1894 e = arp_entry_find (eai, &args->a.ip4);
1898 adj_nbr_walk_nh4 (e->sw_if_index,
1899 &e->ip4_address, arp_mk_complete_walk, e);
1905 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1908 vnet_main_t *vm = vnet_get_main ();
1909 ASSERT (vlib_get_thread_index () == 0);
1911 if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1912 vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1913 else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1914 vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1915 else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1916 vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1917 else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
1918 vnet_arp_wc_publish_internal (vm, a);
1920 vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1924 * @brief Invoked when the interface's admin state changes
1926 static clib_error_t *
1927 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1928 u32 sw_if_index, u32 flags)
1930 ethernet_arp_main_t *am = ðernet_arp_main;
1931 ethernet_arp_ip4_entry_t *e;
1932 u32 i, *to_delete = 0;
1935 pool_foreach (e, am->ip4_entry_pool,
1937 if (e->sw_if_index == sw_if_index)
1938 vec_add1 (to_delete,
1939 e - am->ip4_entry_pool);
1943 for (i = 0; i < vec_len (to_delete); i++)
1945 ethernet_arp_ip4_over_ethernet_address_t delme;
1946 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1948 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1949 delme.ip4.as_u32 = e->ip4_address.as_u32;
1951 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1953 vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1957 vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1961 vec_free (to_delete);
1966 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1969 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1974 for (i = 3; i >= 0; i--)
1976 old = a->ip4.as_u8[i];
1977 a->ip4.as_u8[i] += 1;
1978 if (old < a->ip4.as_u8[i])
1982 for (i = 5; i >= 0; i--)
1984 old = a->ethernet[i];
1985 a->ethernet[i] += 1;
1986 if (old < a->ethernet[i])
1992 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1993 u32 sw_if_index, void *a_arg,
1994 int is_static, int is_no_fib_entry)
1996 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1997 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1999 args.sw_if_index = sw_if_index;
2000 args.is_static = is_static;
2001 args.is_no_fib_entry = is_no_fib_entry;
2003 clib_memcpy (&args.a, a, sizeof (*a));
2005 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
2006 (u8 *) & args, sizeof (args));
2011 proxy_arp_walk (proxy_arp_walk_t cb, void *data)
2013 ethernet_arp_main_t *am = ðernet_arp_main;
2014 ethernet_proxy_arp_t *pa;
2016 vec_foreach (pa, am->proxy_arps)
2018 if (!cb (&pa->lo_addr, &pa->hi_addr, pa->fib_index, data))
2024 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
2025 ip4_address_t * hi_addr, u32 fib_index, int is_del)
2027 ethernet_arp_main_t *am = ðernet_arp_main;
2028 ethernet_proxy_arp_t *pa;
2029 u32 found_at_index = ~0;
2031 vec_foreach (pa, am->proxy_arps)
2033 if (pa->lo_addr.as_u32 == lo_addr->as_u32 &&
2034 pa->hi_addr.as_u32 == hi_addr->as_u32 && pa->fib_index == fib_index)
2036 found_at_index = pa - am->proxy_arps;
2041 if (found_at_index != ~0)
2043 /* Delete, otherwise it's already in the table */
2045 vec_delete (am->proxy_arps, 1, found_at_index);
2048 /* delete, no such entry */
2050 return VNET_API_ERROR_NO_SUCH_ENTRY;
2052 /* add, not in table */
2053 vec_add2 (am->proxy_arps, pa, 1);
2054 pa->lo_addr.as_u32 = lo_addr->as_u32;
2055 pa->hi_addr.as_u32 = hi_addr->as_u32;
2056 pa->fib_index = fib_index;
2061 * Remove any proxy arp entries asdociated with the
2065 vnet_proxy_arp_fib_reset (u32 fib_id)
2067 ethernet_arp_main_t *am = ðernet_arp_main;
2068 ethernet_proxy_arp_t *pa;
2069 u32 *entries_to_delete = 0;
2073 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2074 if (~0 == fib_index)
2075 return VNET_API_ERROR_NO_SUCH_ENTRY;
2077 vec_foreach (pa, am->proxy_arps)
2079 if (pa->fib_index == fib_index)
2081 vec_add1 (entries_to_delete, pa - am->proxy_arps);
2085 for (i = 0; i < vec_len (entries_to_delete); i++)
2087 vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2090 vec_free (entries_to_delete);
2095 static clib_error_t *
2096 ip_arp_add_del_command_fn (vlib_main_t * vm,
2097 unformat_input_t * input, vlib_cli_command_t * cmd)
2099 vnet_main_t *vnm = vnet_get_main ();
2101 ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2108 int is_no_fib_entry = 0;
2111 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2113 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2114 if (unformat (input, "%U %U %U",
2115 unformat_vnet_sw_interface, vnm, &sw_if_index,
2116 unformat_ip4_address, &addr.ip4,
2117 unformat_ethernet_address, &addr.ethernet))
2120 else if (unformat (input, "delete") || unformat (input, "del"))
2123 else if (unformat (input, "static"))
2126 else if (unformat (input, "no-fib-entry"))
2127 is_no_fib_entry = 1;
2129 else if (unformat (input, "count %d", &count))
2132 else if (unformat (input, "fib-id %d", &fib_id))
2134 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2136 if (~0 == fib_index)
2137 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2140 else if (unformat (input, "proxy %U - %U",
2141 unformat_ip4_address, &lo_addr.ip4,
2142 unformat_ip4_address, &hi_addr.ip4))
2150 (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2159 for (i = 0; i < count; i++)
2163 uword event_type, *event_data = 0;
2165 /* Park the debug CLI until the arp entry is installed */
2166 vnet_register_ip4_arp_resolution_event
2167 (vnm, &addr.ip4, vlib_current_process (vm),
2168 1 /* type */ , 0 /* data */ );
2170 vnet_arp_set_ip4_over_ethernet
2171 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
2173 vlib_process_wait_for_event (vm);
2174 event_type = vlib_process_get_events (vm, &event_data);
2175 vec_reset_length (event_data);
2176 if (event_type != 1)
2177 clib_warning ("event type %d unexpected", event_type);
2180 vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2182 increment_ip4_and_mac_address (&addr);
2187 return clib_error_return (0, "unknown input `%U'",
2188 format_unformat_error, input);
2196 * Add or delete IPv4 ARP cache entries.
2198 * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2199 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2200 * any order and combination.
2204 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2205 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2206 * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2207 * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2209 * To add or delete an IPv4 ARP cache entry to or from a specific fib
2211 * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2212 * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2214 * Add or delete IPv4 static ARP cache entries as follows:
2215 * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2216 * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2218 * For testing / debugging purposes, the 'set ip arp' command can add or
2219 * delete multiple entries. Supply the 'count N' parameter:
2220 * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2223 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2224 .path = "set ip arp",
2226 "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2227 .function = ip_arp_add_del_command_fn,
2231 static clib_error_t *
2232 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2234 input, vlib_cli_command_t * cmd)
2236 vnet_main_t *vnm = vnet_get_main ();
2238 vnet_sw_interface_t *si;
2242 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2244 if (unformat (input, "%U", unformat_vnet_sw_interface,
2247 else if (unformat (input, "enable") || unformat (input, "on"))
2249 else if (unformat (input, "disable") || unformat (input, "off"))
2256 return clib_error_return (0, "unknown input '%U'",
2257 format_unformat_error, input);
2259 si = vnet_get_sw_interface (vnm, sw_if_index);
2262 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2264 si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2271 * Enable proxy-arp on an interface. The vpp stack will answer ARP
2272 * requests for the indicated address range. Multiple proxy-arp
2273 * ranges may be provisioned.
2275 * @note Proxy ARP as a technology is infamous for blackholing traffic.
2276 * Also, the underlying implementation has not been performance-tuned.
2277 * Avoid creating an unnecessarily large set of ranges.
2280 * To enable proxy arp on a range of addresses, use:
2281 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2282 * Append 'del' to delete a range of proxy ARP addresses:
2283 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2284 * You must then specifically enable proxy arp on individual interfaces:
2285 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2286 * To disable proxy arp on an individual interface:
2287 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2289 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2290 .path = "set interface proxy-arp",
2292 "set interface proxy-arp <intfc> [enable|disable]",
2293 .function = set_int_proxy_arp_command_fn,
2299 * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2300 * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2304 ARP_TERM_NEXT_L2_OUTPUT,
2309 u32 arp_term_next_node_index[32];
2312 arp_term_l2bd (vlib_main_t * vm,
2313 vlib_node_runtime_t * node, vlib_frame_t * frame)
2315 l2input_main_t *l2im = &l2input_main;
2316 u32 n_left_from, next_index, *from, *to_next;
2317 u32 n_replies_sent = 0;
2318 u16 last_bd_index = ~0;
2319 l2_bridge_domain_t *last_bd_config = 0;
2320 l2_input_config_t *cfg0;
2322 from = vlib_frame_vector_args (frame);
2323 n_left_from = frame->n_vectors;
2324 next_index = node->cached_next_index;
2326 while (n_left_from > 0)
2330 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2332 while (n_left_from > 0 && n_left_to_next > 0)
2335 ethernet_header_t *eth0;
2336 ethernet_arp_header_t *arp0;
2339 u32 pi0, error0, next0, sw_if_index0;
2350 n_left_to_next -= 1;
2352 p0 = vlib_get_buffer (vm, pi0);
2353 // Terminate only local (SHG == 0) ARP
2354 if (vnet_buffer (p0)->l2.shg != 0)
2355 goto next_l2_feature;
2357 eth0 = vlib_buffer_get_current (p0);
2358 l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2359 ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2360 arp0 = (ethernet_arp_header_t *) l3h0;
2362 if (ethertype0 != ETHERNET_TYPE_ARP)
2365 if ((arp0->opcode !=
2366 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request)) &&
2368 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply)))
2371 /* Must be ARP request/reply packet here */
2372 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2373 (p0->flags & VLIB_BUFFER_IS_TRACED)))
2375 u8 *t0 = vlib_add_trace (vm, node, p0,
2376 sizeof (ethernet_arp_input_trace_t));
2377 clib_memcpy (t0, l3h0, sizeof (ethernet_arp_input_trace_t));
2383 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2384 ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2387 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2388 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2390 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2395 /* Trash ARP packets whose ARP-level source addresses do not
2396 match, or if requester address is mcast */
2398 (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2399 sizeof (eth0->src_address)) ||
2400 ethernet_address_cast (arp0->ip4_over_ethernet[0].ethernet)))
2402 /* VRRP virtual MAC may be different to SMAC in ARP reply */
2403 if (memcmp (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2404 sizeof (vrrp_prefix)))
2406 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2411 (ip4_address_is_multicast (&arp0->ip4_over_ethernet[0].ip4)))
2413 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
2417 /* Check if anyone want ARP request events for L2 BDs */
2419 ethernet_arp_main_t *am = ðernet_arp_main;
2420 if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2421 vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2424 /* lookup BD mac_by_ip4 hash table for MAC entry */
2425 ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2426 bd_index0 = vnet_buffer (p0)->l2.bd_index;
2427 if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2428 || (last_bd_index == (u16) ~ 0)))
2430 last_bd_index = bd_index0;
2431 last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2433 macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2435 if (PREDICT_FALSE (!macp0))
2436 goto next_l2_feature; /* MAC not found */
2438 /* MAC found, send ARP reply -
2439 Convert ARP request packet to ARP reply */
2440 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2441 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2442 arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2443 clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2444 clib_memcpy (eth0->dst_address, eth0->src_address, 6);
2445 clib_memcpy (eth0->src_address, macp0, 6);
2446 n_replies_sent += 1;
2449 /* For BVI, need to use l2-fwd node to send ARP reply as
2450 l2-output node cannot output packet to BVI properly */
2451 cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2452 if (PREDICT_FALSE (cfg0->bvi))
2454 vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2455 vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2456 goto next_l2_feature;
2459 /* Send ARP/ND reply back out input interface through l2-output */
2460 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2461 next0 = ARP_TERM_NEXT_L2_OUTPUT;
2462 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2463 to_next, n_left_to_next, pi0,
2468 /* IP6 ND event notification or solicitation handling to generate
2469 local response instead of flooding */
2470 iph0 = (ip6_header_t *) l3h0;
2471 if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2472 iph0->protocol == IP_PROTOCOL_ICMP6 &&
2473 !ip6_address_is_unspecified
2474 (&iph0->src_address)))
2476 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2477 if (vnet_ip6_nd_term
2478 (vm, node, p0, eth0, iph0, sw_if_index0,
2479 vnet_buffer (p0)->l2.bd_index))
2480 goto output_response;
2485 next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2486 L2INPUT_FEAT_ARP_TERM);
2487 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2488 to_next, n_left_to_next,
2494 if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2495 (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2496 arp0->ip4_over_ethernet[1].ip4.as_u32))
2498 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2500 next0 = ARP_TERM_NEXT_DROP;
2501 p0->error = node->errors[error0];
2503 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2504 to_next, n_left_to_next, pi0,
2508 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2511 vlib_error_count (vm, node->node_index,
2512 ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2513 return frame->n_vectors;
2517 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2518 .function = arp_term_l2bd,
2519 .name = "arp-term-l2bd",
2520 .vector_size = sizeof (u32),
2521 .n_errors = ETHERNET_ARP_N_ERROR,
2522 .error_strings = ethernet_arp_error_strings,
2523 .n_next_nodes = ARP_TERM_N_NEXT,
2525 [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2526 [ARP_TERM_NEXT_DROP] = "error-drop",
2528 .format_buffer = format_ethernet_arp_header,
2529 .format_trace = format_arp_term_input_trace,
2534 arp_term_init (vlib_main_t * vm)
2536 // Initialize the feature next-node indexes
2537 feat_bitmap_init_next_nodes (vm,
2538 arp_term_l2bd_node.index,
2540 l2input_get_feat_names (),
2541 arp_term_next_node_index);
2545 VLIB_INIT_FUNCTION (arp_term_init);
2548 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2550 if (e->sw_if_index == sw_if_index)
2552 adj_nbr_walk_nh4 (e->sw_if_index,
2553 &e->ip4_address, arp_mk_complete_walk, e);
2558 ethernet_arp_change_mac (u32 sw_if_index)
2560 ethernet_arp_main_t *am = ðernet_arp_main;
2561 ethernet_arp_ip4_entry_t *e;
2565 pool_foreach (e, am->ip4_entry_pool,
2567 change_arp_mac (sw_if_index, e);
2571 ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2573 if (ADJ_INDEX_INVALID != ai)
2574 adj_glean_update_rewrite (ai);
2578 send_ip4_garp (vlib_main_t * vm, u32 sw_if_index)
2580 ip4_main_t *i4m = &ip4_main;
2581 ip4_address_t *ip4_addr = ip4_interface_first_address (i4m, sw_if_index, 0);
2583 send_ip4_garp_w_addr (vm, ip4_addr, sw_if_index);
2587 send_ip4_garp_w_addr (vlib_main_t * vm,
2588 const ip4_address_t * ip4_addr, u32 sw_if_index)
2590 ip4_main_t *i4m = &ip4_main;
2591 vnet_main_t *vnm = vnet_get_main ();
2592 u8 *rewrite, rewrite_len;
2593 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
2597 clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2598 format_ip4_address, ip4_addr, sw_if_index);
2600 /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2601 where the interface IP/MAC pair is used for both source and request
2602 MAC/IP pairs in the request */
2604 ethernet_arp_header_t *h = vlib_packet_template_get_packet
2605 (vm, &i4m->ip4_arp_request_packet_template, &bi);
2610 clib_memcpy (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2611 sizeof (h->ip4_over_ethernet[0].ethernet));
2612 clib_memcpy (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2613 sizeof (h->ip4_over_ethernet[1].ethernet));
2614 h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2615 h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2617 /* Setup MAC header with ARP Etype and broadcast DMAC */
2618 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2620 ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
2621 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
2622 rewrite_len = vec_len (rewrite);
2623 vlib_buffer_advance (b, -rewrite_len);
2624 ethernet_header_t *e = vlib_buffer_get_current (b);
2625 clib_memcpy (e->dst_address, rewrite, rewrite_len);
2628 /* Send GARP packet out the specified interface */
2629 vnet_buffer (b)->sw_if_index[VLIB_RX] =
2630 vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2631 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2632 u32 *to_next = vlib_frame_vector_args (f);
2635 vlib_put_frame_to_node (vm, hi->output_node_index, f);
2640 * fd.io coding-style-patch-verification: ON
2643 * eval: (c-set-style "gnu")