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_fast (h->ip4_over_ethernet[0].ethernet,
363 sizeof (h->ip4_over_ethernet[0].ethernet));
365 h->ip4_over_ethernet[0].ip4 = src[0];
366 h->ip4_over_ethernet[1].ip4 = adj->sub_type.nbr.next_hop.ip4;
368 b = vlib_get_buffer (vm, bi);
369 vnet_buffer (b)->sw_if_index[VLIB_RX] =
370 vnet_buffer (b)->sw_if_index[VLIB_TX] = adj->rewrite_header.sw_if_index;
372 /* Add encapsulation string for software interface (e.g. ethernet header). */
373 vnet_rewrite_one_header (adj[0], h, sizeof (ethernet_header_t));
374 vlib_buffer_advance (b, -adj->rewrite_header.data_bytes);
377 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
378 u32 *to_next = vlib_frame_vector_args (f);
381 vlib_put_frame_to_node (vm, hi->output_node_index, f);
386 arp_mk_complete (adj_index_t ai, ethernet_arp_ip4_entry_t * e)
388 adj_nbr_update_rewrite
389 (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
390 ethernet_build_rewrite (vnet_get_main (),
392 adj_get_link_type (ai), e->ethernet_address));
396 arp_mk_incomplete (adj_index_t ai)
398 ip_adjacency_t *adj = adj_get (ai);
400 adj_nbr_update_rewrite
402 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
403 ethernet_build_rewrite (vnet_get_main (),
404 adj->rewrite_header.sw_if_index,
406 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
409 static ethernet_arp_ip4_entry_t *
410 arp_entry_find (ethernet_arp_interface_t * eai, const ip4_address_t * addr)
412 ethernet_arp_main_t *am = ðernet_arp_main;
413 ethernet_arp_ip4_entry_t *e = NULL;
416 if (NULL != eai->arp_entries)
418 p = hash_get (eai->arp_entries, addr->as_u32);
422 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
429 arp_mk_complete_walk (adj_index_t ai, void *ctx)
431 ethernet_arp_ip4_entry_t *e = ctx;
433 arp_mk_complete (ai, e);
435 return (ADJ_WALK_RC_CONTINUE);
439 arp_mk_incomplete_walk (adj_index_t ai, void *ctx)
441 arp_mk_incomplete (ai);
443 return (ADJ_WALK_RC_CONTINUE);
447 arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
449 ethernet_arp_main_t *am = ðernet_arp_main;
450 ethernet_arp_interface_t *arp_int;
451 ethernet_arp_ip4_entry_t *e;
456 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
457 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
458 e = arp_entry_find (arp_int, &adj->sub_type.nbr.next_hop.ip4);
460 switch (adj->lookup_next_index)
462 case IP_LOOKUP_NEXT_GLEAN:
463 adj_glean_update_rewrite (ai);
465 case IP_LOOKUP_NEXT_ARP:
468 adj_nbr_walk_nh4 (sw_if_index,
469 &e->ip4_address, arp_mk_complete_walk, e);
474 * no matching ARP entry.
475 * construct the rewrite required to for an ARP packet, and stick
476 * that in the adj's pipe to smoke.
478 adj_nbr_update_rewrite
480 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
481 ethernet_build_rewrite
485 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
488 * since the FIB has added this adj for a route, it makes sense it
489 * may want to forward traffic sometime soon. Let's send a
490 * speculative ARP. just one. If we were to do periodically that
491 * wouldn't be bad either, but that's more code than i'm prepared to
492 * write at this time for relatively little reward.
497 case IP_LOOKUP_NEXT_BCAST:
498 adj_nbr_update_rewrite (ai,
499 ADJ_NBR_REWRITE_FLAG_COMPLETE,
500 ethernet_build_rewrite
504 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
506 case IP_LOOKUP_NEXT_MCAST:
509 * Construct a partial rewrite from the known ethernet mcast dest MAC
514 rewrite = ethernet_build_rewrite (vnm,
517 ethernet_ip4_mcast_dst_addr ());
518 offset = vec_len (rewrite) - 2;
521 * Complete the remaining fields of the adj's rewrite to direct the
522 * complete of the rewrite at switch time by copying in the IP
523 * dst address's bytes.
524 * Ofset is 2 bytes into the MAC desintation address.
526 adj_mcast_update_rewrite (ai, rewrite, offset);
530 case IP_LOOKUP_NEXT_DROP:
531 case IP_LOOKUP_NEXT_PUNT:
532 case IP_LOOKUP_NEXT_LOCAL:
533 case IP_LOOKUP_NEXT_REWRITE:
534 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
535 case IP_LOOKUP_NEXT_MIDCHAIN:
536 case IP_LOOKUP_NEXT_ICMP_ERROR:
537 case IP_LOOKUP_N_NEXT:
544 arp_adj_fib_add (ethernet_arp_ip4_entry_t * e, u32 fib_index)
548 .fp_proto = FIB_PROTOCOL_IP4,
549 .fp_addr.ip4 = e->ip4_address,
553 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
554 FIB_ENTRY_FLAG_ATTACHED,
555 DPO_PROTO_IP4, &pfx.fp_addr,
556 e->sw_if_index, ~0, 1, NULL,
557 FIB_ROUTE_PATH_FLAG_NONE);
558 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
562 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
564 if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
568 .fp_proto = FIB_PROTOCOL_IP4,
569 .fp_addr.ip4 = e->ip4_address,
573 fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
575 fib_table_entry_path_remove (fib_index, &pfx,
579 e->sw_if_index, ~0, 1,
580 FIB_ROUTE_PATH_FLAG_NONE);
581 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
585 static ethernet_arp_ip4_entry_t *
586 force_reuse_arp_entry (void)
588 ethernet_arp_ip4_entry_t *e;
589 ethernet_arp_main_t *am = ðernet_arp_main;
591 u32 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
592 if (index == ~0) /* Try again from elt 0 */
593 index = pool_next_index (am->ip4_entry_pool, index);
595 /* Find a non-static random entry to free up for reuse */
598 if ((count++ == 100) || (index == ~0))
599 return NULL; /* give up after 100 entries */
600 e = pool_elt_at_index (am->ip4_entry_pool, index);
601 am->arp_delete_rotor = index;
602 index = pool_next_index (am->ip4_entry_pool, index);
604 while (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC);
606 /* Remove ARP entry from its interface and update fib */
608 (am->ethernet_arp_by_sw_if_index[e->sw_if_index].arp_entries,
609 e->ip4_address.as_u32);
611 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
612 adj_nbr_walk_nh4 (e->sw_if_index,
613 &e->ip4_address, arp_mk_incomplete_walk, e);
618 vnet_arp_set_ip4_over_ethernet_internal (vnet_main_t * vnm,
619 vnet_arp_set_ip4_over_ethernet_rpc_args_t
622 ethernet_arp_ip4_entry_t *e = 0;
623 ethernet_arp_main_t *am = ðernet_arp_main;
624 ethernet_arp_ip4_over_ethernet_address_t *a = &args->a;
625 vlib_main_t *vm = vlib_get_main ();
626 int make_new_arp_cache_entry = 1;
628 pending_resolution_t *pr, *mc;
629 ethernet_arp_interface_t *arp_int;
630 int is_static = args->is_static;
631 u32 sw_if_index = args->sw_if_index;
632 int is_no_fib_entry = args->is_no_fib_entry;
634 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
636 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
638 if (NULL != arp_int->arp_entries)
640 p = hash_get (arp_int->arp_entries, a->ip4.as_u32);
643 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
645 /* Refuse to over-write static arp. */
646 if (!is_static && (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC))
648 /* if MAC address match, still check to send event */
649 if (0 == memcmp (e->ethernet_address,
650 a->ethernet, sizeof (e->ethernet_address)))
651 goto check_customers;
654 make_new_arp_cache_entry = 0;
658 if (make_new_arp_cache_entry)
660 if (am->limit_arp_cache_size &&
661 pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
663 e = force_reuse_arp_entry ();
668 pool_get (am->ip4_entry_pool, e);
670 if (NULL == arp_int->arp_entries)
671 arp_int->arp_entries = hash_create (0, sizeof (u32));
673 hash_set (arp_int->arp_entries, a->ip4.as_u32, e - am->ip4_entry_pool);
675 e->sw_if_index = sw_if_index;
676 e->ip4_address = a->ip4;
677 e->fib_entry_index = FIB_NODE_INDEX_INVALID;
678 clib_memcpy_fast (e->ethernet_address,
679 a->ethernet, sizeof (e->ethernet_address));
681 if (!is_no_fib_entry)
684 ip4_fib_table_get_index_for_sw_if_index
689 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY;
695 * prevent a DoS attack from the data-plane that
696 * spams us with no-op updates to the MAC address
698 if (0 == memcmp (e->ethernet_address,
699 a->ethernet, sizeof (e->ethernet_address)))
701 e->time_last_updated = vlib_time_now (vm);
702 goto check_customers;
705 /* Update ethernet address. */
706 clib_memcpy_fast (e->ethernet_address, a->ethernet,
707 sizeof (e->ethernet_address));
710 /* Update time stamp and flags. */
711 e->time_last_updated = vlib_time_now (vm);
714 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
715 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
719 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
720 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
723 adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
726 /* Customer(s) waiting for this address to be resolved? */
727 p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
733 while (next_index != (u32) ~ 0)
735 pr = pool_elt_at_index (am->pending_resolutions, next_index);
736 vlib_process_signal_event (vm, pr->node_index,
737 pr->type_opaque, pr->data);
738 next_index = pr->next_index;
739 pool_put (am->pending_resolutions, pr);
742 hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
745 /* Customer(s) requesting ARP event for this address? */
746 p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
752 while (next_index != (u32) ~ 0)
754 int (*fp) (u32, u8 *, u32, u32);
756 mc = pool_elt_at_index (am->mac_changes, next_index);
757 fp = mc->data_callback;
759 /* Call the user's data callback, return 1 to suppress dup events */
761 rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
764 * Signal the resolver process, as long as the user
765 * says they want to be notified
768 vlib_process_signal_event (vm, mc->node_index,
769 mc->type_opaque, mc->data);
770 next_index = mc->next_index;
778 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
781 uword type_opaque, uword data)
783 ethernet_arp_main_t *am = ðernet_arp_main;
784 ip4_address_t *address = address_arg;
786 pending_resolution_t *pr;
788 pool_get (am->pending_resolutions, pr);
791 pr->node_index = node_index;
792 pr->type_opaque = type_opaque;
794 pr->data_callback = 0;
796 p = hash_get (am->pending_resolutions_by_address, address->as_u32);
799 /* Insert new resolution at the head of the list */
800 pr->next_index = p[0];
801 hash_unset (am->pending_resolutions_by_address, address->as_u32);
804 hash_set (am->pending_resolutions_by_address, address->as_u32,
805 pr - am->pending_resolutions);
809 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
814 uword type_opaque, uword data, int is_add)
816 ethernet_arp_main_t *am = ðernet_arp_main;
817 ip4_address_t *address = address_arg;
819 /* Try to find an existing entry */
820 u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
822 pending_resolution_t *mc;
823 while (p && *p != ~0)
825 mc = pool_elt_at_index (am->mac_changes, *p);
826 if (mc->node_index == node_index && mc->type_opaque == type_opaque
832 int found = p && *p != ~0;
836 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
838 pool_get (am->mac_changes, mc);
839 *mc = (pending_resolution_t)
841 .next_index = ~0,.node_index = node_index,.type_opaque =
842 type_opaque,.data = data,.data_callback = data_callback,.pid =
845 /* Insert new resolution at the end of the list */
846 u32 new_idx = mc - am->mac_changes;
850 hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
855 return VNET_API_ERROR_NO_SUCH_ENTRY;
857 /* Clients may need to clean up pool entries, too */
858 void (*fp) (u32, u8 *) = data_callback;
860 (*fp) (mc->data, 0 /* no new mac addrs */ );
862 /* Remove the entry from the list and delete the entry */
864 pool_put (am->mac_changes, mc);
866 /* Remove from hash if we deleted the last entry */
867 if (*p == ~0 && p == first)
868 hash_unset (am->mac_changes_by_address, address->as_u32);
873 /* Either we drop the packet or we send a reply to the sender. */
877 ARP_INPUT_NEXT_REPLY_TX,
881 #define foreach_ethernet_arp_error \
882 _ (replies_sent, "ARP replies sent") \
883 _ (l2_type_not_ethernet, "L2 type not ethernet") \
884 _ (l3_type_not_ip4, "L3 type not IP4") \
885 _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
886 _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
887 _ (l3_dst_address_unset, "IP4 destination address is unset") \
888 _ (l3_src_address_is_local, "IP4 source address matches local interface") \
889 _ (l3_src_address_learned, "ARP request IP4 source address learned") \
890 _ (replies_received, "ARP replies received") \
891 _ (opcode_not_request, "ARP opcode not request") \
892 _ (proxy_arp_replies_sent, "Proxy ARP replies sent") \
893 _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
894 _ (gratuitous_arp, "ARP probe or announcement dropped") \
895 _ (interface_no_table, "Interface is not mapped to an IP table") \
896 _ (interface_not_ip_enabled, "Interface is not IP enabled") \
897 _ (unnumbered_mismatch, "RX interface is unnumbered to different subnet") \
901 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
902 foreach_ethernet_arp_error
904 ETHERNET_ARP_N_ERROR,
905 } ethernet_arp_input_error_t;
908 arp_unnumbered (vlib_buffer_t * p0,
909 u32 input_sw_if_index, u32 conn_sw_if_index)
911 vnet_main_t *vnm = vnet_get_main ();
912 vnet_interface_main_t *vim = &vnm->interface_main;
913 vnet_sw_interface_t *si;
915 /* verify that the input interface is unnumbered to the connected.
916 * the connected interface is the interface on which the subnet is
918 si = &vim->sw_interfaces[input_sw_if_index];
920 if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
921 (si->unnumbered_sw_if_index == conn_sw_if_index)))
923 /* the input interface is not unnumbered to the interface on which
924 * the sub-net is configured that covers the ARP request.
925 * So this is not the case for unnumbered.. */
933 arp_learn (vnet_main_t * vnm,
934 ethernet_arp_main_t * am, u32 sw_if_index,
935 const ethernet_arp_ip4_over_ethernet_address_t * addr)
937 vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
938 return (ETHERNET_ARP_ERROR_l3_src_address_learned);
942 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
944 ethernet_arp_main_t *am = ðernet_arp_main;
945 vnet_main_t *vnm = vnet_get_main ();
946 ip4_main_t *im4 = &ip4_main;
947 u32 n_left_from, next_index, *from, *to_next;
948 u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
950 from = vlib_frame_vector_args (frame);
951 n_left_from = frame->n_vectors;
952 next_index = node->cached_next_index;
954 if (node->flags & VLIB_NODE_FLAG_TRACE)
955 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
957 sizeof (ethernet_arp_input_trace_t));
959 while (n_left_from > 0)
963 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
965 while (n_left_from > 0 && n_left_to_next > 0)
968 vnet_hw_interface_t *hw_if0;
969 ethernet_arp_header_t *arp0;
970 ethernet_header_t *eth_rx, *eth_tx;
971 const ip4_address_t *if_addr0;
972 ip4_address_t proxy_src;
973 u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
974 u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
975 ethernet_proxy_arp_t *pa;
976 fib_node_index_t dst_fei, src_fei;
977 const fib_prefix_t *pfx0;
978 fib_entry_flag_t src_flags, dst_flags;
979 u8 *rewrite0, rewrite0_len;
989 p0 = vlib_get_buffer (vm, pi0);
990 arp0 = vlib_buffer_get_current (p0);
991 /* Fill in ethernet header. */
992 eth_rx = ethernet_buffer_get_header (p0);
994 is_request0 = arp0->opcode
995 == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
997 error0 = ETHERNET_ARP_ERROR_replies_sent;
1001 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
1002 ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
1005 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
1006 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
1008 (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ?
1009 ETHERNET_ARP_ERROR_l3_dst_address_unset : error0);
1011 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
1013 /* not playing the ARP game if the interface is not IPv4 enabled */
1015 (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
1016 ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
1021 /* Check that IP address is local and matches incoming interface. */
1022 fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
1023 if (~0 == fib_index0)
1025 error0 = ETHERNET_ARP_ERROR_interface_no_table;
1029 dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1030 &arp0->ip4_over_ethernet[1].ip4,
1032 dst_flags = fib_entry_get_flags (dst_fei);
1034 conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
1036 /* Honor unnumbered interface, if any */
1037 is_unnum0 = sw_if_index0 != conn_sw_if_index0;
1041 * we're looking for FIB entries that indicate the source
1042 * is attached. There may be more specific non-attached
1043 * routes that match the source, but these do not influence
1044 * whether we respond to an ARP request, i.e. they do not
1045 * influence whether we are the correct way for the sender
1046 * to reach us, they only affect how we reach the sender.
1048 fib_entry_t *src_fib_entry;
1049 const fib_prefix_t *pfx;
1050 fib_entry_src_t *src;
1051 fib_source_t source;
1060 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1062 ip4_over_ethernet[0].ip4,
1064 src_fib_entry = fib_entry_get (src_fei);
1067 * It's possible that the source that provides the
1068 * flags we need, or the flags we must not have,
1069 * is not the best source, so check then all.
1072 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1074 src_flags = fib_entry_get_flags_for_source (src_fei, source);
1076 /* Reject requests/replies with our local interface
1078 if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1080 error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1082 * When VPP has an interface whose address is also
1083 * applied to a TAP interface on the host, then VPP's
1084 * TAP interface will be unnumbered to the 'real'
1085 * interface and do proxy ARP from the host.
1086 * The curious aspect of this setup is that ARP requests
1087 * from the host will come from the VPP's own address.
1088 * So don't drop immediately here, instead go see if this
1089 * is a proxy ARP case.
1093 /* A Source must also be local to subnet of matching
1094 * interface address. */
1095 if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1096 (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1103 * The packet was sent from an address that is not
1104 * connected nor attached i.e. it is not from an
1105 * address that is covered by a link's sub-net,
1106 * nor is it a already learned host resp.
1112 * shorter mask lookup for the next iteration.
1114 pfx = fib_entry_get_prefix (src_fei);
1115 mask = pfx->fp_len - 1;
1118 * continue until we hit the default route or we find
1119 * the attached we are looking for. The most likely
1120 * outcome is we find the attached with the first source
1121 * on the first lookup.
1125 !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1130 * the matching route is a not attached, i.e. it was
1131 * added as a result of routing, rather than interface/ARP
1132 * configuration. If the matching route is not a host route
1135 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1140 if (fib_entry_is_sourced (dst_fei, FIB_SOURCE_ADJ))
1143 * We matched an adj-fib on ths source subnet (a /32 previously
1144 * added as a result of ARP). If this request is a gratuitous
1145 * ARP, then learn from it.
1146 * The check for matching an adj-fib, is to prevent hosts
1147 * from spamming us with gratuitous ARPS that might otherwise
1148 * blow our ARP cache
1150 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1151 arp0->ip4_over_ethernet[1].ip4.as_u32)
1152 error0 = arp_learn (vnm, am, sw_if_index0,
1153 &arp0->ip4_over_ethernet[0]);
1156 else if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1158 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1162 if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1165 * The interface the ARP was received on is not the interface
1166 * on which the covering prefix is configured. Maybe this is a
1167 * case for unnumbered.
1172 dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1173 pfx0 = fib_entry_get_prefix (dst_fei);
1174 if_addr0 = &pfx0->fp_addr.ip4;
1178 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1181 (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1182 sizeof (vrrp_prefix))));
1184 /* Trash ARP packets whose ARP-level source addresses do not
1185 match their L2-frame-level source addresses, unless it's
1186 a reply from a VRRP virtual router */
1188 (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1189 sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1191 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1195 /* Learn or update sender's mapping only for replies to addresses
1196 * that are local to the subnet */
1198 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1201 error0 = arp_learn (vnm, am, sw_if_index0,
1202 &arp0->ip4_over_ethernet[0]);
1204 /* a reply for a non-local destination could be a GARP.
1205 * GARPs for hosts we know were handled above, so this one
1207 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1211 else if (arp0->opcode ==
1212 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1213 (dst_is_local0 == 0))
1220 An adjacency to the sender is not always present,
1221 so we use the interface to build us a rewrite string
1222 which will contain all the necessary tags. */
1223 rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1225 eth_rx->src_address);
1226 rewrite0_len = vec_len (rewrite0);
1228 /* Figure out how much to rewind current data from adjacency. */
1229 vlib_buffer_advance (p0, -rewrite0_len);
1230 eth_tx = vlib_buffer_get_current (p0);
1232 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1233 hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1235 /* Send reply back through input interface */
1236 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1237 next0 = ARP_INPUT_NEXT_REPLY_TX;
1239 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1241 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1243 clib_memcpy_fast (arp0->ip4_over_ethernet[0].ethernet,
1244 hw_if0->hw_address, 6);
1245 clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1248 /* Hardware must be ethernet-like. */
1249 ASSERT (vec_len (hw_if0->hw_address) == 6);
1251 /* the rx nd tx ethernet headers wil overlap in the case
1252 * when we received a tagged VLAN=0 packet, but we are sending
1254 clib_memcpy_fast (eth_tx, rewrite0, vec_len (rewrite0));
1255 vec_free (rewrite0);
1261 if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1263 error0 = ETHERNET_ARP_ERROR_unnumbered_mismatch;
1269 /* We are going to reply to this request, so, in the absence of
1270 errors, learn the sender */
1272 error0 = arp_learn (vnm, am, sw_if_index0,
1273 &arp0->ip4_over_ethernet[1]);
1275 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1276 n_left_to_next, pi0, next0);
1278 n_replies_sent += 1;
1282 if (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1283 arp0->ip4_over_ethernet[1].ip4.as_u32)
1285 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1288 /* See if proxy arp is configured for the address */
1291 vnet_sw_interface_t *si;
1292 u32 this_addr = clib_net_to_host_u32
1293 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1296 si = vnet_get_sw_interface (vnm, sw_if_index0);
1298 if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1301 fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1304 vec_foreach (pa, am->proxy_arps)
1306 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr.as_u32);
1307 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr.as_u32);
1309 /* an ARP request hit in the proxy-arp table? */
1310 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1311 (fib_index0 == pa->fib_index))
1314 arp0->ip4_over_ethernet[1].ip4.data_u32;
1317 * change the interface address to the proxied
1319 if_addr0 = &proxy_src;
1321 n_proxy_arp_replies_sent++;
1329 next0 = ARP_INPUT_NEXT_DROP;
1330 p0->error = node->errors[error0];
1332 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1333 n_left_to_next, pi0, next0);
1336 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1339 vlib_error_count (vm, node->node_index,
1340 ETHERNET_ARP_ERROR_replies_sent,
1341 n_replies_sent - n_proxy_arp_replies_sent);
1343 vlib_error_count (vm, node->node_index,
1344 ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1345 n_proxy_arp_replies_sent);
1346 return frame->n_vectors;
1349 static char *ethernet_arp_error_strings[] = {
1350 #define _(sym,string) string,
1351 foreach_ethernet_arp_error
1356 VLIB_REGISTER_NODE (arp_input_node, static) =
1358 .function = arp_input,
1359 .name = "arp-input",
1360 .vector_size = sizeof (u32),
1361 .n_errors = ETHERNET_ARP_N_ERROR,
1362 .error_strings = ethernet_arp_error_strings,
1363 .n_next_nodes = ARP_INPUT_N_NEXT,
1365 [ARP_INPUT_NEXT_DROP] = "error-drop",
1366 [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1368 .format_buffer = format_ethernet_arp_header,
1369 .format_trace = format_ethernet_arp_input_trace,
1374 ip4_arp_entry_sort (void *a1, void *a2)
1376 ethernet_arp_ip4_entry_t *e1 = a1;
1377 ethernet_arp_ip4_entry_t *e2 = a2;
1380 vnet_main_t *vnm = vnet_get_main ();
1382 cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1384 cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1388 ethernet_arp_ip4_entry_t *
1389 ip4_neighbors_pool (void)
1391 ethernet_arp_main_t *am = ðernet_arp_main;
1392 return am->ip4_entry_pool;
1395 ethernet_arp_ip4_entry_t *
1396 ip4_neighbor_entries (u32 sw_if_index)
1398 ethernet_arp_main_t *am = ðernet_arp_main;
1399 ethernet_arp_ip4_entry_t *n, *ns = 0;
1402 pool_foreach (n, am->ip4_entry_pool, ({
1403 if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1405 vec_add1 (ns, n[0]);
1410 vec_sort_with_function (ns, ip4_arp_entry_sort);
1414 static clib_error_t *
1415 show_ip4_arp (vlib_main_t * vm,
1416 unformat_input_t * input, vlib_cli_command_t * cmd)
1418 vnet_main_t *vnm = vnet_get_main ();
1419 ethernet_arp_main_t *am = ðernet_arp_main;
1420 ethernet_arp_ip4_entry_t *e, *es;
1421 ethernet_proxy_arp_t *pa;
1422 clib_error_t *error = 0;
1425 /* Filter entries by interface if given. */
1427 (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1429 es = ip4_neighbor_entries (sw_if_index);
1432 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1435 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1440 if (vec_len (am->proxy_arps))
1442 vlib_cli_output (vm, "Proxy arps enabled for:");
1443 vec_foreach (pa, am->proxy_arps)
1445 vlib_cli_output (vm, "Fib_index %d %U - %U ",
1447 format_ip4_address, &pa->lo_addr,
1448 format_ip4_address, &pa->hi_addr);
1456 * Display all the IPv4 ARP entries.
1459 * Example of how to display the IPv4 ARP table:
1460 * @cliexstart{show ip arp}
1461 * Time FIB IP4 Flags Ethernet Interface
1462 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
1463 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
1464 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
1465 * Proxy arps enabled for:
1466 * Fib_index 0 6.0.0.1 - 6.0.0.11
1470 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1471 .path = "show ip arp",
1472 .function = show_ip4_arp,
1473 .short_help = "show ip arp",
1479 pg_edit_t l2_type, l3_type;
1480 pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1486 } ip4_over_ethernet[2];
1487 } pg_ethernet_arp_header_t;
1490 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1492 /* Initialize fields that are not bit fields in the IP header. */
1493 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1496 _(n_l2_address_bytes);
1497 _(n_l3_address_bytes);
1499 _(ip4_over_ethernet[0].ethernet);
1500 _(ip4_over_ethernet[0].ip4);
1501 _(ip4_over_ethernet[1].ethernet);
1502 _(ip4_over_ethernet[1].ip4);
1507 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1509 pg_stream_t *s = va_arg (*args, pg_stream_t *);
1510 pg_ethernet_arp_header_t *p;
1513 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1515 pg_ethernet_arp_header_init (p);
1518 pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1519 pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1520 pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1521 pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1523 if (!unformat (input, "%U: %U/%U -> %U/%U",
1525 unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1527 unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1529 unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1531 unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1533 unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1535 /* Free up any edits we may have added. */
1536 pg_free_edit_group (s);
1543 ip4_set_arp_limit (u32 arp_limit)
1545 ethernet_arp_main_t *am = ðernet_arp_main;
1547 am->limit_arp_cache_size = arp_limit;
1552 * @brief Control Plane hook to remove an ARP entry
1555 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1558 ethernet_arp_ip4_over_ethernet_address_t *
1561 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1563 args.sw_if_index = sw_if_index;
1564 args.flags = ETHERNET_ARP_ARGS_REMOVE;
1565 clib_memcpy_fast (&args.a, a, sizeof (*a));
1567 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1568 (u8 *) & args, sizeof (args));
1573 * @brief publish wildcard arp event
1574 * @param sw_if_index The interface on which the ARP entires are acted
1577 vnet_arp_wc_publish (u32 sw_if_index,
1578 const ethernet_arp_ip4_over_ethernet_address_t * a)
1580 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1581 .flags = ETHERNET_ARP_ARGS_WC_PUB,
1582 .sw_if_index = sw_if_index,
1586 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1587 (u8 *) & args, sizeof (args));
1592 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1593 vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1596 vlib_main_t *vm = vlib_get_main ();
1597 ethernet_arp_main_t *am = ðernet_arp_main;
1598 uword ni = am->wc_ip4_arp_publisher_node;
1599 uword et = am->wc_ip4_arp_publisher_et;
1601 if (ni == (uword) ~ 0)
1603 wc_arp_report_t *r =
1604 vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1605 r->ip4 = args->a.ip4.as_u32;
1606 r->sw_if_index = args->sw_if_index;
1607 memcpy (r->mac, args->a.ethernet, sizeof r->mac);
1611 wc_arp_set_publisher_node (uword node_index, uword event_type)
1613 ethernet_arp_main_t *am = ðernet_arp_main;
1614 am->wc_ip4_arp_publisher_node = node_index;
1615 am->wc_ip4_arp_publisher_et = event_type;
1619 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e);
1622 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1623 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1626 ethernet_arp_main_t *am = ðernet_arp_main;
1627 ethernet_arp_ip4_entry_t *e;
1628 ethernet_arp_interface_t *eai;
1630 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1633 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1635 e = arp_entry_find (eai, &args->a.ip4);
1639 adj_nbr_walk_nh4 (e->sw_if_index,
1640 &e->ip4_address, arp_mk_incomplete_walk, e);
1643 * The difference between flush and unset, is that an unset
1644 * means delete for static and dynamic entries. A flush
1645 * means delete only for dynamic. Flushing is what the DP
1646 * does in response to interface events. unset is only done
1647 * by the control plane.
1649 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
1651 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
1653 else if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1655 arp_entry_free (eai, e);
1662 * arp_add_del_interface_address
1664 * callback when an interface address is added or deleted
1667 arp_add_del_interface_address (ip4_main_t * im,
1670 ip4_address_t * address,
1672 u32 if_address_index, u32 is_del)
1675 * Flush the ARP cache of all entries covered by the address
1676 * that is being removed.
1678 ethernet_arp_main_t *am = ðernet_arp_main;
1679 ethernet_arp_ip4_entry_t *e;
1681 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1686 ethernet_arp_interface_t *eai;
1687 u32 i, *to_delete = 0;
1690 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1693 hash_foreach_pair (pair, eai->arp_entries,
1695 e = pool_elt_at_index(am->ip4_entry_pool,
1697 if (ip4_destination_matches_route (im, &e->ip4_address,
1698 address, address_length))
1700 vec_add1 (to_delete, e - am->ip4_entry_pool);
1705 for (i = 0; i < vec_len (to_delete); i++)
1707 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1709 vnet_arp_set_ip4_over_ethernet_rpc_args_t delme = {
1710 .a.ip4.as_u32 = e->ip4_address.as_u32,
1711 .sw_if_index = e->sw_if_index,
1712 .flags = ETHERNET_ARP_ARGS_FLUSH,
1714 clib_memcpy_fast (&delme.a.ethernet, e->ethernet_address, 6);
1716 vnet_arp_flush_ip4_over_ethernet_internal (vnet_get_main (),
1720 vec_free (to_delete);
1725 arp_table_bind (ip4_main_t * im,
1727 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
1729 ethernet_arp_main_t *am = ðernet_arp_main;
1730 ethernet_arp_interface_t *eai;
1731 ethernet_arp_ip4_entry_t *e;
1735 * the IP table that the interface is bound to has changed.
1736 * reinstall all the adj fibs.
1739 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1742 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1745 hash_foreach_pair (pair, eai->arp_entries,
1747 e = pool_elt_at_index(am->ip4_entry_pool,
1750 * remove the adj-fib from the old table and add to the new
1752 arp_adj_fib_remove(e, old_fib_index);
1753 arp_adj_fib_add(e, new_fib_index);
1759 static clib_error_t *
1760 ethernet_arp_init (vlib_main_t * vm)
1762 ethernet_arp_main_t *am = ðernet_arp_main;
1763 ip4_main_t *im = &ip4_main;
1764 clib_error_t *error;
1767 if ((error = vlib_call_init_function (vm, ethernet_init)))
1770 ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1772 pn = pg_get_node (arp_input_node.index);
1773 pn->unformat_edit = unformat_pg_arp_header;
1775 am->opcode_by_name = hash_create_string (0, sizeof (uword));
1776 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1777 foreach_ethernet_arp_opcode;
1780 /* $$$ configurable */
1781 am->limit_arp_cache_size = 50000;
1783 am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1784 am->mac_changes_by_address = hash_create (0, sizeof (uword));
1785 am->wc_ip4_arp_publisher_node = (uword) ~ 0;
1787 /* don't trace ARP error packets */
1789 vlib_node_runtime_t *rt =
1790 vlib_node_get_runtime (vm, arp_input_node.index);
1793 vnet_pcap_drop_trace_filter_add_del \
1794 (rt->errors[ETHERNET_ARP_ERROR_##a], \
1796 foreach_ethernet_arp_error
1800 ip4_add_del_interface_address_callback_t cb;
1801 cb.function = arp_add_del_interface_address;
1802 cb.function_opaque = 0;
1803 vec_add1 (im->add_del_interface_address_callbacks, cb);
1805 ip4_table_bind_callback_t cbt;
1806 cbt.function = arp_table_bind;
1807 cbt.function_opaque = 0;
1808 vec_add1 (im->table_bind_callbacks, cbt);
1813 VLIB_INIT_FUNCTION (ethernet_arp_init);
1816 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1818 ethernet_arp_main_t *am = ðernet_arp_main;
1821 (e, ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index));
1822 hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1823 pool_put (am->ip4_entry_pool, e);
1827 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1828 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1831 ethernet_arp_main_t *am = ðernet_arp_main;
1832 ethernet_arp_ip4_entry_t *e;
1833 ethernet_arp_interface_t *eai;
1835 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1838 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1840 e = arp_entry_find (eai, &args->a.ip4);
1844 adj_nbr_walk_nh4 (e->sw_if_index,
1845 &e->ip4_address, arp_mk_incomplete_walk, e);
1846 arp_entry_free (eai, e);
1854 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1855 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1858 ethernet_arp_main_t *am = ðernet_arp_main;
1859 ethernet_arp_ip4_entry_t *e;
1860 ethernet_arp_interface_t *eai;
1862 vec_validate (am->ethernet_arp_by_sw_if_index, args->sw_if_index);
1863 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1865 e = arp_entry_find (eai, &args->a.ip4);
1869 adj_nbr_walk_nh4 (e->sw_if_index,
1870 &e->ip4_address, arp_mk_complete_walk, e);
1876 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1879 vnet_main_t *vm = vnet_get_main ();
1880 ASSERT (vlib_get_thread_index () == 0);
1882 if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1883 vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1884 else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1885 vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1886 else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1887 vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1888 else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
1889 vnet_arp_wc_publish_internal (vm, a);
1891 vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1895 * @brief Invoked when the interface's admin state changes
1897 static clib_error_t *
1898 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1899 u32 sw_if_index, u32 flags)
1901 ethernet_arp_main_t *am = ðernet_arp_main;
1902 ethernet_arp_ip4_entry_t *e;
1903 u32 i, *to_update = 0;
1906 pool_foreach (e, am->ip4_entry_pool,
1908 if (e->sw_if_index == sw_if_index)
1909 vec_add1 (to_update,
1910 e - am->ip4_entry_pool);
1914 for (i = 0; i < vec_len (to_update); i++)
1916 e = pool_elt_at_index (am->ip4_entry_pool, to_update[i]);
1918 vnet_arp_set_ip4_over_ethernet_rpc_args_t update_me = {
1919 .a.ip4.as_u32 = e->ip4_address.as_u32,
1920 .sw_if_index = e->sw_if_index,
1923 clib_memcpy_fast (&update_me.a.ethernet, e->ethernet_address, 6);
1925 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1927 update_me.flags = ETHERNET_ARP_ARGS_POPULATE;
1928 vnet_arp_populate_ip4_over_ethernet_internal (vnm, &update_me);
1932 update_me.flags = ETHERNET_ARP_ARGS_FLUSH;
1933 vnet_arp_flush_ip4_over_ethernet_internal (vnm, &update_me);
1936 vec_free (to_update);
1941 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1944 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1949 for (i = 3; i >= 0; i--)
1951 old = a->ip4.as_u8[i];
1952 a->ip4.as_u8[i] += 1;
1953 if (old < a->ip4.as_u8[i])
1957 for (i = 5; i >= 0; i--)
1959 old = a->ethernet[i];
1960 a->ethernet[i] += 1;
1961 if (old < a->ethernet[i])
1967 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1969 const ethernet_arp_ip4_over_ethernet_address_t
1970 * a, int is_static, int is_no_fib_entry)
1972 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1974 args.sw_if_index = sw_if_index;
1975 args.is_static = is_static;
1976 args.is_no_fib_entry = is_no_fib_entry;
1978 clib_memcpy_fast (&args.a, a, sizeof (*a));
1980 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1981 (u8 *) & args, sizeof (args));
1986 proxy_arp_walk (proxy_arp_walk_t cb, void *data)
1988 ethernet_arp_main_t *am = ðernet_arp_main;
1989 ethernet_proxy_arp_t *pa;
1991 vec_foreach (pa, am->proxy_arps)
1993 if (!cb (&pa->lo_addr, &pa->hi_addr, pa->fib_index, data))
1999 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
2000 ip4_address_t * hi_addr, u32 fib_index, int is_del)
2002 ethernet_arp_main_t *am = ðernet_arp_main;
2003 ethernet_proxy_arp_t *pa;
2004 u32 found_at_index = ~0;
2006 vec_foreach (pa, am->proxy_arps)
2008 if (pa->lo_addr.as_u32 == lo_addr->as_u32 &&
2009 pa->hi_addr.as_u32 == hi_addr->as_u32 && pa->fib_index == fib_index)
2011 found_at_index = pa - am->proxy_arps;
2016 if (found_at_index != ~0)
2018 /* Delete, otherwise it's already in the table */
2020 vec_delete (am->proxy_arps, 1, found_at_index);
2023 /* delete, no such entry */
2025 return VNET_API_ERROR_NO_SUCH_ENTRY;
2027 /* add, not in table */
2028 vec_add2 (am->proxy_arps, pa, 1);
2029 pa->lo_addr.as_u32 = lo_addr->as_u32;
2030 pa->hi_addr.as_u32 = hi_addr->as_u32;
2031 pa->fib_index = fib_index;
2036 * Remove any proxy arp entries asdociated with the
2040 vnet_proxy_arp_fib_reset (u32 fib_id)
2042 ethernet_arp_main_t *am = ðernet_arp_main;
2043 ethernet_proxy_arp_t *pa;
2044 u32 *entries_to_delete = 0;
2048 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2049 if (~0 == fib_index)
2050 return VNET_API_ERROR_NO_SUCH_ENTRY;
2052 vec_foreach (pa, am->proxy_arps)
2054 if (pa->fib_index == fib_index)
2056 vec_add1 (entries_to_delete, pa - am->proxy_arps);
2060 for (i = 0; i < vec_len (entries_to_delete); i++)
2062 vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2065 vec_free (entries_to_delete);
2070 static clib_error_t *
2071 ip_arp_add_del_command_fn (vlib_main_t * vm,
2072 unformat_input_t * input, vlib_cli_command_t * cmd)
2074 vnet_main_t *vnm = vnet_get_main ();
2076 ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2083 int is_no_fib_entry = 0;
2086 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2088 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2089 if (unformat (input, "%U %U %U",
2090 unformat_vnet_sw_interface, vnm, &sw_if_index,
2091 unformat_ip4_address, &addr.ip4,
2092 unformat_ethernet_address, &addr.ethernet))
2095 else if (unformat (input, "delete") || unformat (input, "del"))
2098 else if (unformat (input, "static"))
2101 else if (unformat (input, "no-fib-entry"))
2102 is_no_fib_entry = 1;
2104 else if (unformat (input, "count %d", &count))
2107 else if (unformat (input, "fib-id %d", &fib_id))
2109 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2111 if (~0 == fib_index)
2112 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2115 else if (unformat (input, "proxy %U - %U",
2116 unformat_ip4_address, &lo_addr.ip4,
2117 unformat_ip4_address, &hi_addr.ip4))
2125 (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2134 for (i = 0; i < count; i++)
2138 uword event_type, *event_data = 0;
2140 /* Park the debug CLI until the arp entry is installed */
2141 vnet_register_ip4_arp_resolution_event
2142 (vnm, &addr.ip4, vlib_current_process (vm),
2143 1 /* type */ , 0 /* data */ );
2145 vnet_arp_set_ip4_over_ethernet
2146 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
2148 vlib_process_wait_for_event (vm);
2149 event_type = vlib_process_get_events (vm, &event_data);
2150 vec_reset_length (event_data);
2151 if (event_type != 1)
2152 clib_warning ("event type %d unexpected", event_type);
2155 vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2157 increment_ip4_and_mac_address (&addr);
2162 return clib_error_return (0, "unknown input `%U'",
2163 format_unformat_error, input);
2171 * Add or delete IPv4 ARP cache entries.
2173 * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2174 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2175 * any order and combination.
2179 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2180 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2181 * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2182 * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2184 * To add or delete an IPv4 ARP cache entry to or from a specific fib
2186 * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2187 * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2189 * Add or delete IPv4 static ARP cache entries as follows:
2190 * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2191 * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2193 * For testing / debugging purposes, the 'set ip arp' command can add or
2194 * delete multiple entries. Supply the 'count N' parameter:
2195 * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2198 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2199 .path = "set ip arp",
2201 "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2202 .function = ip_arp_add_del_command_fn,
2206 static clib_error_t *
2207 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2209 input, vlib_cli_command_t * cmd)
2211 vnet_main_t *vnm = vnet_get_main ();
2213 vnet_sw_interface_t *si;
2217 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2219 if (unformat (input, "%U", unformat_vnet_sw_interface,
2222 else if (unformat (input, "enable") || unformat (input, "on"))
2224 else if (unformat (input, "disable") || unformat (input, "off"))
2231 return clib_error_return (0, "unknown input '%U'",
2232 format_unformat_error, input);
2234 si = vnet_get_sw_interface (vnm, sw_if_index);
2237 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2239 si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2246 * Enable proxy-arp on an interface. The vpp stack will answer ARP
2247 * requests for the indicated address range. Multiple proxy-arp
2248 * ranges may be provisioned.
2250 * @note Proxy ARP as a technology is infamous for blackholing traffic.
2251 * Also, the underlying implementation has not been performance-tuned.
2252 * Avoid creating an unnecessarily large set of ranges.
2255 * To enable proxy arp on a range of addresses, use:
2256 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2257 * Append 'del' to delete a range of proxy ARP addresses:
2258 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2259 * You must then specifically enable proxy arp on individual interfaces:
2260 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2261 * To disable proxy arp on an individual interface:
2262 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2264 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2265 .path = "set interface proxy-arp",
2267 "set interface proxy-arp <intfc> [enable|disable]",
2268 .function = set_int_proxy_arp_command_fn,
2274 * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2275 * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2279 ARP_TERM_NEXT_L2_OUTPUT,
2284 u32 arp_term_next_node_index[32];
2287 arp_term_l2bd (vlib_main_t * vm,
2288 vlib_node_runtime_t * node, vlib_frame_t * frame)
2290 l2input_main_t *l2im = &l2input_main;
2291 u32 n_left_from, next_index, *from, *to_next;
2292 u32 n_replies_sent = 0;
2293 u16 last_bd_index = ~0;
2294 l2_bridge_domain_t *last_bd_config = 0;
2295 l2_input_config_t *cfg0;
2297 from = vlib_frame_vector_args (frame);
2298 n_left_from = frame->n_vectors;
2299 next_index = node->cached_next_index;
2301 while (n_left_from > 0)
2305 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2307 while (n_left_from > 0 && n_left_to_next > 0)
2310 ethernet_header_t *eth0;
2311 ethernet_arp_header_t *arp0;
2314 u32 pi0, error0, next0, sw_if_index0;
2325 n_left_to_next -= 1;
2327 p0 = vlib_get_buffer (vm, pi0);
2328 // Terminate only local (SHG == 0) ARP
2329 if (vnet_buffer (p0)->l2.shg != 0)
2330 goto next_l2_feature;
2332 eth0 = vlib_buffer_get_current (p0);
2333 l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2334 ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2335 arp0 = (ethernet_arp_header_t *) l3h0;
2337 if (ethertype0 != ETHERNET_TYPE_ARP)
2340 if ((arp0->opcode !=
2341 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request)) &&
2343 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply)))
2346 /* Must be ARP request/reply packet here */
2347 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2348 (p0->flags & VLIB_BUFFER_IS_TRACED)))
2350 u8 *t0 = vlib_add_trace (vm, node, p0,
2351 sizeof (ethernet_arp_input_trace_t));
2352 clib_memcpy_fast (t0, l3h0,
2353 sizeof (ethernet_arp_input_trace_t));
2359 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2360 ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2363 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2364 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2366 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2371 /* Trash ARP packets whose ARP-level source addresses do not
2372 match, or if requester address is mcast */
2374 (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2375 sizeof (eth0->src_address)) ||
2376 ethernet_address_cast (arp0->ip4_over_ethernet[0].ethernet)))
2378 /* VRRP virtual MAC may be different to SMAC in ARP reply */
2379 if (memcmp (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2380 sizeof (vrrp_prefix)))
2382 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2387 (ip4_address_is_multicast (&arp0->ip4_over_ethernet[0].ip4)))
2389 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
2393 /* Check if anyone want ARP request events for L2 BDs */
2395 ethernet_arp_main_t *am = ðernet_arp_main;
2396 if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2397 vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2400 /* lookup BD mac_by_ip4 hash table for MAC entry */
2401 ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2402 bd_index0 = vnet_buffer (p0)->l2.bd_index;
2403 if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2404 || (last_bd_index == (u16) ~ 0)))
2406 last_bd_index = bd_index0;
2407 last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2409 macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2411 if (PREDICT_FALSE (!macp0))
2412 goto next_l2_feature; /* MAC not found */
2414 /* MAC found, send ARP reply -
2415 Convert ARP request packet to ARP reply */
2416 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2417 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2418 arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2419 clib_memcpy_fast (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2420 clib_memcpy_fast (eth0->dst_address, eth0->src_address, 6);
2421 clib_memcpy_fast (eth0->src_address, macp0, 6);
2422 n_replies_sent += 1;
2425 /* For BVI, need to use l2-fwd node to send ARP reply as
2426 l2-output node cannot output packet to BVI properly */
2427 cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2428 if (PREDICT_FALSE (cfg0->bvi))
2430 vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2431 vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2432 goto next_l2_feature;
2435 /* Send ARP/ND reply back out input interface through l2-output */
2436 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2437 next0 = ARP_TERM_NEXT_L2_OUTPUT;
2438 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2439 to_next, n_left_to_next, pi0,
2444 /* IP6 ND event notification or solicitation handling to generate
2445 local response instead of flooding */
2446 iph0 = (ip6_header_t *) l3h0;
2447 if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2448 iph0->protocol == IP_PROTOCOL_ICMP6 &&
2449 !ip6_address_is_unspecified
2450 (&iph0->src_address)))
2452 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2453 if (vnet_ip6_nd_term
2454 (vm, node, p0, eth0, iph0, sw_if_index0,
2455 vnet_buffer (p0)->l2.bd_index))
2456 goto output_response;
2461 next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2462 L2INPUT_FEAT_ARP_TERM);
2463 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2464 to_next, n_left_to_next,
2470 if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2471 (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2472 arp0->ip4_over_ethernet[1].ip4.as_u32))
2474 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2476 next0 = ARP_TERM_NEXT_DROP;
2477 p0->error = node->errors[error0];
2479 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2480 to_next, n_left_to_next, pi0,
2484 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2487 vlib_error_count (vm, node->node_index,
2488 ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2489 return frame->n_vectors;
2493 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2494 .function = arp_term_l2bd,
2495 .name = "arp-term-l2bd",
2496 .vector_size = sizeof (u32),
2497 .n_errors = ETHERNET_ARP_N_ERROR,
2498 .error_strings = ethernet_arp_error_strings,
2499 .n_next_nodes = ARP_TERM_N_NEXT,
2501 [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2502 [ARP_TERM_NEXT_DROP] = "error-drop",
2504 .format_buffer = format_ethernet_arp_header,
2505 .format_trace = format_arp_term_input_trace,
2510 arp_term_init (vlib_main_t * vm)
2512 // Initialize the feature next-node indexes
2513 feat_bitmap_init_next_nodes (vm,
2514 arp_term_l2bd_node.index,
2516 l2input_get_feat_names (),
2517 arp_term_next_node_index);
2521 VLIB_INIT_FUNCTION (arp_term_init);
2524 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2526 if (e->sw_if_index == sw_if_index)
2528 adj_nbr_walk_nh4 (e->sw_if_index,
2529 &e->ip4_address, arp_mk_complete_walk, e);
2534 ethernet_arp_change_mac (u32 sw_if_index)
2536 ethernet_arp_main_t *am = ðernet_arp_main;
2537 ethernet_arp_ip4_entry_t *e;
2541 pool_foreach (e, am->ip4_entry_pool,
2543 change_arp_mac (sw_if_index, e);
2547 ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2549 if (ADJ_INDEX_INVALID != ai)
2550 adj_glean_update_rewrite (ai);
2554 send_ip4_garp (vlib_main_t * vm, u32 sw_if_index)
2556 ip4_main_t *i4m = &ip4_main;
2557 ip4_address_t *ip4_addr = ip4_interface_first_address (i4m, sw_if_index, 0);
2559 send_ip4_garp_w_addr (vm, ip4_addr, sw_if_index);
2563 send_ip4_garp_w_addr (vlib_main_t * vm,
2564 const ip4_address_t * ip4_addr, u32 sw_if_index)
2566 ip4_main_t *i4m = &ip4_main;
2567 vnet_main_t *vnm = vnet_get_main ();
2568 u8 *rewrite, rewrite_len;
2569 vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
2573 clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2574 format_ip4_address, ip4_addr, sw_if_index);
2576 /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2577 where the interface IP/MAC pair is used for both source and request
2578 MAC/IP pairs in the request */
2580 ethernet_arp_header_t *h = vlib_packet_template_get_packet
2581 (vm, &i4m->ip4_arp_request_packet_template, &bi);
2586 clib_memcpy_fast (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2587 sizeof (h->ip4_over_ethernet[0].ethernet));
2588 clib_memcpy_fast (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2589 sizeof (h->ip4_over_ethernet[1].ethernet));
2590 h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2591 h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2593 /* Setup MAC header with ARP Etype and broadcast DMAC */
2594 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2596 ethernet_build_rewrite (vnm, sw_if_index, VNET_LINK_ARP,
2597 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST);
2598 rewrite_len = vec_len (rewrite);
2599 vlib_buffer_advance (b, -rewrite_len);
2600 ethernet_header_t *e = vlib_buffer_get_current (b);
2601 clib_memcpy_fast (e->dst_address, rewrite, rewrite_len);
2604 /* Send GARP packet out the specified interface */
2605 vnet_buffer (b)->sw_if_index[VLIB_RX] =
2606 vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2607 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2608 u32 *to_next = vlib_frame_vector_args (f);
2611 vlib_put_frame_to_node (vm, hi->output_node_index, f);
2616 * Remove any arp entries asociated with the specificed interface
2619 vnet_arp_delete_sw_interface (vnet_main_t * vnm, u32 sw_if_index, u32 is_add)
2621 if (!is_add && sw_if_index != ~0)
2623 ethernet_arp_main_t *am = ðernet_arp_main;
2624 ethernet_arp_ip4_entry_t *e;
2626 pool_foreach (e, am->ip4_entry_pool, ({
2627 if (e->sw_if_index != sw_if_index)
2629 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = { .sw_if_index = sw_if_index,
2630 .a.ip4 = e->ip4_address };
2631 vnet_arp_unset_ip4_over_ethernet_internal (vnm, &args);
2637 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (vnet_arp_delete_sw_interface);
2640 * fd.io coding-style-patch-verification: ON
2643 * eval: (c-set-style "gnu")