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,
356 hi = vnet_get_sup_hw_interface (vnm, adj->rewrite_header.sw_if_index);
358 clib_memcpy (h->ip4_over_ethernet[0].ethernet,
359 hi->hw_address, sizeof (h->ip4_over_ethernet[0].ethernet));
361 h->ip4_over_ethernet[0].ip4 = src[0];
362 h->ip4_over_ethernet[1].ip4 = adj->sub_type.nbr.next_hop.ip4;
364 b = vlib_get_buffer (vm, bi);
365 vnet_buffer (b)->sw_if_index[VLIB_RX] =
366 vnet_buffer (b)->sw_if_index[VLIB_TX] = adj->rewrite_header.sw_if_index;
368 /* Add encapsulation string for software interface (e.g. ethernet header). */
369 vnet_rewrite_one_header (adj[0], h, sizeof (ethernet_header_t));
370 vlib_buffer_advance (b, -adj->rewrite_header.data_bytes);
373 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
374 u32 *to_next = vlib_frame_vector_args (f);
377 vlib_put_frame_to_node (vm, hi->output_node_index, f);
382 arp_mk_complete (adj_index_t ai, ethernet_arp_ip4_entry_t * e)
384 adj_nbr_update_rewrite
385 (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
386 ethernet_build_rewrite (vnet_get_main (),
388 adj_get_link_type (ai), e->ethernet_address));
392 arp_mk_incomplete (adj_index_t ai)
394 ip_adjacency_t *adj = adj_get (ai);
396 adj_nbr_update_rewrite
398 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
399 ethernet_build_rewrite (vnet_get_main (),
400 adj->rewrite_header.sw_if_index,
402 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
405 static ethernet_arp_ip4_entry_t *
406 arp_entry_find (ethernet_arp_interface_t * eai, const ip4_address_t * addr)
408 ethernet_arp_main_t *am = ðernet_arp_main;
409 ethernet_arp_ip4_entry_t *e = NULL;
412 if (NULL != eai->arp_entries)
414 p = hash_get (eai->arp_entries, addr->as_u32);
418 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
425 arp_mk_complete_walk (adj_index_t ai, void *ctx)
427 ethernet_arp_ip4_entry_t *e = ctx;
429 arp_mk_complete (ai, e);
431 return (ADJ_WALK_RC_CONTINUE);
435 arp_mk_incomplete_walk (adj_index_t ai, void *ctx)
437 arp_mk_incomplete (ai);
439 return (ADJ_WALK_RC_CONTINUE);
443 arp_update_adjacency (vnet_main_t * vnm, u32 sw_if_index, u32 ai)
445 ethernet_arp_main_t *am = ðernet_arp_main;
446 ethernet_arp_interface_t *arp_int;
447 ethernet_arp_ip4_entry_t *e;
452 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
453 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
454 e = arp_entry_find (arp_int, &adj->sub_type.nbr.next_hop.ip4);
456 switch (adj->lookup_next_index)
458 case IP_LOOKUP_NEXT_GLEAN:
459 adj_glean_update_rewrite (ai);
461 case IP_LOOKUP_NEXT_ARP:
464 adj_nbr_walk_nh4 (sw_if_index,
465 &e->ip4_address, arp_mk_complete_walk, e);
470 * no matching ARP entry.
471 * construct the rewrite required to for an ARP packet, and stick
472 * that in the adj's pipe to smoke.
474 adj_nbr_update_rewrite
476 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
477 ethernet_build_rewrite
481 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
484 * since the FIB has added this adj for a route, it makes sense it
485 * may want to forward traffic sometime soon. Let's send a
486 * speculative ARP. just one. If we were to do periodically that
487 * wouldn't be bad either, but that's more code than i'm prepared to
488 * write at this time for relatively little reward.
493 case IP_LOOKUP_NEXT_MCAST:
496 * Construct a partial rewrite from the known ethernet mcast dest MAC
501 rewrite = ethernet_build_rewrite (vnm,
504 ethernet_ip4_mcast_dst_addr ());
505 offset = vec_len (rewrite) - 2;
508 * Complete the remaining fields of the adj's rewrite to direct the
509 * complete of the rewrite at switch time by copying in the IP
510 * dst address's bytes.
511 * Ofset is 2 bytes into the MAC desintation address.
513 adj_mcast_update_rewrite (ai, rewrite, offset);
517 case IP_LOOKUP_NEXT_DROP:
518 case IP_LOOKUP_NEXT_PUNT:
519 case IP_LOOKUP_NEXT_LOCAL:
520 case IP_LOOKUP_NEXT_REWRITE:
521 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
522 case IP_LOOKUP_NEXT_MIDCHAIN:
523 case IP_LOOKUP_NEXT_ICMP_ERROR:
524 case IP_LOOKUP_N_NEXT:
531 arp_adj_fib_add (ethernet_arp_ip4_entry_t * e, u32 fib_index)
535 .fp_proto = FIB_PROTOCOL_IP4,
536 .fp_addr.ip4 = e->ip4_address,
540 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
541 FIB_ENTRY_FLAG_ATTACHED,
542 DPO_PROTO_IP4, &pfx.fp_addr,
543 e->sw_if_index, ~0, 1, NULL,
544 FIB_ROUTE_PATH_FLAG_NONE);
545 fib_table_lock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
549 vnet_arp_set_ip4_over_ethernet_internal (vnet_main_t * vnm,
550 vnet_arp_set_ip4_over_ethernet_rpc_args_t
553 ethernet_arp_ip4_entry_t *e = 0;
554 ethernet_arp_main_t *am = ðernet_arp_main;
555 ethernet_arp_ip4_over_ethernet_address_t *a = &args->a;
556 vlib_main_t *vm = vlib_get_main ();
557 int make_new_arp_cache_entry = 1;
559 pending_resolution_t *pr, *mc;
560 ethernet_arp_interface_t *arp_int;
561 int is_static = args->is_static;
562 u32 sw_if_index = args->sw_if_index;
563 int is_no_fib_entry = args->is_no_fib_entry;
565 vec_validate (am->ethernet_arp_by_sw_if_index, sw_if_index);
567 arp_int = &am->ethernet_arp_by_sw_if_index[sw_if_index];
569 if (NULL != arp_int->arp_entries)
571 p = hash_get (arp_int->arp_entries, a->ip4.as_u32);
574 e = pool_elt_at_index (am->ip4_entry_pool, p[0]);
576 /* Refuse to over-write static arp. */
577 if (!is_static && (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC))
579 make_new_arp_cache_entry = 0;
583 if (make_new_arp_cache_entry)
585 pool_get (am->ip4_entry_pool, e);
587 if (NULL == arp_int->arp_entries)
589 arp_int->arp_entries = hash_create (0, sizeof (u32));
592 hash_set (arp_int->arp_entries, a->ip4.as_u32, e - am->ip4_entry_pool);
594 e->sw_if_index = sw_if_index;
595 e->ip4_address = a->ip4;
596 e->fib_entry_index = FIB_NODE_INDEX_INVALID;
597 clib_memcpy (e->ethernet_address,
598 a->ethernet, sizeof (e->ethernet_address));
600 if (!is_no_fib_entry)
603 ip4_fib_table_get_index_for_sw_if_index
608 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_NO_FIB_ENTRY;
614 * prevent a DoS attack from the data-plane that
615 * spams us with no-op updates to the MAC address
617 if (0 == memcmp (e->ethernet_address,
618 a->ethernet, sizeof (e->ethernet_address)))
620 e->time_last_updated = vlib_time_now (vm);
621 goto check_customers;
624 /* Update time stamp and ethernet address. */
625 clib_memcpy (e->ethernet_address, a->ethernet,
626 sizeof (e->ethernet_address));
629 e->time_last_updated = vlib_time_now (vm);
632 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
633 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
637 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC;
638 e->flags |= ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
641 adj_nbr_walk_nh4 (sw_if_index, &e->ip4_address, arp_mk_complete_walk, e);
644 /* Customer(s) waiting for this address to be resolved? */
645 p = hash_get (am->pending_resolutions_by_address, a->ip4.as_u32);
651 while (next_index != (u32) ~ 0)
653 pr = pool_elt_at_index (am->pending_resolutions, next_index);
654 vlib_process_signal_event (vm, pr->node_index,
655 pr->type_opaque, pr->data);
656 next_index = pr->next_index;
657 pool_put (am->pending_resolutions, pr);
660 hash_unset (am->pending_resolutions_by_address, a->ip4.as_u32);
663 /* Customer(s) requesting ARP event for this address? */
664 p = hash_get (am->mac_changes_by_address, a->ip4.as_u32);
670 while (next_index != (u32) ~ 0)
672 int (*fp) (u32, u8 *, u32, u32);
674 mc = pool_elt_at_index (am->mac_changes, next_index);
675 fp = mc->data_callback;
677 /* Call the user's data callback, return 1 to suppress dup events */
679 rv = (*fp) (mc->data, a->ethernet, sw_if_index, 0);
682 * Signal the resolver process, as long as the user
683 * says they want to be notified
686 vlib_process_signal_event (vm, mc->node_index,
687 mc->type_opaque, mc->data);
688 next_index = mc->next_index;
696 vnet_register_ip4_arp_resolution_event (vnet_main_t * vnm,
699 uword type_opaque, uword data)
701 ethernet_arp_main_t *am = ðernet_arp_main;
702 ip4_address_t *address = address_arg;
704 pending_resolution_t *pr;
706 pool_get (am->pending_resolutions, pr);
709 pr->node_index = node_index;
710 pr->type_opaque = type_opaque;
712 pr->data_callback = 0;
714 p = hash_get (am->pending_resolutions_by_address, address->as_u32);
717 /* Insert new resolution at the head of the list */
718 pr->next_index = p[0];
719 hash_unset (am->pending_resolutions_by_address, address->as_u32);
722 hash_set (am->pending_resolutions_by_address, address->as_u32,
723 pr - am->pending_resolutions);
727 vnet_add_del_ip4_arp_change_event (vnet_main_t * vnm,
732 uword type_opaque, uword data, int is_add)
734 ethernet_arp_main_t *am = ðernet_arp_main;
735 ip4_address_t *address = address_arg;
737 /* Try to find an existing entry */
738 u32 *first = (u32 *) hash_get (am->mac_changes_by_address, address->as_u32);
740 pending_resolution_t *mc;
741 while (p && *p != ~0)
743 mc = pool_elt_at_index (am->mac_changes, *p);
744 if (mc->node_index == node_index && mc->type_opaque == type_opaque
750 int found = p && *p != ~0;
754 return VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
756 pool_get (am->mac_changes, mc);
757 *mc = (pending_resolution_t)
759 .next_index = ~0,.node_index = node_index,.type_opaque =
760 type_opaque,.data = data,.data_callback = data_callback,.pid =
763 /* Insert new resolution at the end of the list */
764 u32 new_idx = mc - am->mac_changes;
768 hash_set (am->mac_changes_by_address, address->as_u32, new_idx);
773 return VNET_API_ERROR_NO_SUCH_ENTRY;
775 /* Clients may need to clean up pool entries, too */
776 void (*fp) (u32, u8 *) = data_callback;
778 (*fp) (mc->data, 0 /* no new mac addrs */ );
780 /* Remove the entry from the list and delete the entry */
782 pool_put (am->mac_changes, mc);
784 /* Remove from hash if we deleted the last entry */
785 if (*p == ~0 && p == first)
786 hash_unset (am->mac_changes_by_address, address->as_u32);
791 /* Either we drop the packet or we send a reply to the sender. */
795 ARP_INPUT_NEXT_REPLY_TX,
799 #define foreach_ethernet_arp_error \
800 _ (replies_sent, "ARP replies sent") \
801 _ (l2_type_not_ethernet, "L2 type not ethernet") \
802 _ (l3_type_not_ip4, "L3 type not IP4") \
803 _ (l3_src_address_not_local, "IP4 source address not local to subnet") \
804 _ (l3_dst_address_not_local, "IP4 destination address not local to subnet") \
805 _ (l3_src_address_is_local, "IP4 source address matches local interface") \
806 _ (l3_src_address_learned, "ARP request IP4 source address learned") \
807 _ (replies_received, "ARP replies received") \
808 _ (opcode_not_request, "ARP opcode not request") \
809 _ (proxy_arp_replies_sent, "Proxy ARP replies sent") \
810 _ (l2_address_mismatch, "ARP hw addr does not match L2 frame src addr") \
811 _ (gratuitous_arp, "ARP probe or announcement dropped") \
812 _ (interface_no_table, "Interface is not mapped to an IP table") \
813 _ (interface_not_ip_enabled, "Interface is not IP enabled") \
817 #define _(sym,string) ETHERNET_ARP_ERROR_##sym,
818 foreach_ethernet_arp_error
820 ETHERNET_ARP_N_ERROR,
821 } ethernet_arp_input_error_t;
825 unset_random_arp_entry (void)
827 ethernet_arp_main_t *am = ðernet_arp_main;
828 ethernet_arp_ip4_entry_t *e;
829 vnet_main_t *vnm = vnet_get_main ();
830 ethernet_arp_ip4_over_ethernet_address_t delme;
833 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
834 am->arp_delete_rotor = index;
836 /* Try again from elt 0, could happen if an intfc goes down */
839 index = pool_next_index (am->ip4_entry_pool, am->arp_delete_rotor);
840 am->arp_delete_rotor = index;
843 /* Nothing left in the pool */
847 e = pool_elt_at_index (am->ip4_entry_pool, index);
849 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
850 delme.ip4.as_u32 = e->ip4_address.as_u32;
852 vnet_arp_unset_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
856 arp_unnumbered (vlib_buffer_t * p0,
857 u32 input_sw_if_index, u32 conn_sw_if_index)
859 vnet_main_t *vnm = vnet_get_main ();
860 vnet_interface_main_t *vim = &vnm->interface_main;
861 vnet_sw_interface_t *si;
863 /* verify that the input interface is unnumbered to the connected.
864 * the connected interface is the interface on which the subnet is
866 si = &vim->sw_interfaces[input_sw_if_index];
868 if (!(si->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED &&
869 (si->unnumbered_sw_if_index == conn_sw_if_index)))
871 /* the input interface is not unnumbered to the interface on which
872 * the sub-net is configured that covers the ARP request.
873 * So this is not the case for unnumbered.. */
881 arp_learn (vnet_main_t * vnm,
882 ethernet_arp_main_t * am, u32 sw_if_index, void *addr)
884 if (am->limit_arp_cache_size &&
885 pool_elts (am->ip4_entry_pool) >= am->limit_arp_cache_size)
886 unset_random_arp_entry ();
888 vnet_arp_set_ip4_over_ethernet (vnm, sw_if_index, addr, 0, 0);
889 return (ETHERNET_ARP_ERROR_l3_src_address_learned);
893 arp_input (vlib_main_t * vm, vlib_node_runtime_t * node, vlib_frame_t * frame)
895 ethernet_arp_main_t *am = ðernet_arp_main;
896 vnet_main_t *vnm = vnet_get_main ();
897 ip4_main_t *im4 = &ip4_main;
898 u32 n_left_from, next_index, *from, *to_next;
899 u32 n_replies_sent = 0, n_proxy_arp_replies_sent = 0;
901 from = vlib_frame_vector_args (frame);
902 n_left_from = frame->n_vectors;
903 next_index = node->cached_next_index;
905 if (node->flags & VLIB_NODE_FLAG_TRACE)
906 vlib_trace_frame_buffers_only (vm, node, from, frame->n_vectors,
908 sizeof (ethernet_arp_input_trace_t));
910 while (n_left_from > 0)
914 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
916 while (n_left_from > 0 && n_left_to_next > 0)
919 vnet_hw_interface_t *hw_if0;
920 ethernet_arp_header_t *arp0;
921 ethernet_header_t *eth_rx, *eth_tx;
922 ip4_address_t *if_addr0, proxy_src;
923 u32 pi0, error0, next0, sw_if_index0, conn_sw_if_index0, fib_index0;
924 u8 is_request0, dst_is_local0, is_unnum0, is_vrrp_reply0;
925 ethernet_proxy_arp_t *pa;
926 fib_node_index_t dst_fei, src_fei;
928 fib_entry_flag_t src_flags, dst_flags;
929 u8 *rewrite0, rewrite0_len;
939 p0 = vlib_get_buffer (vm, pi0);
940 arp0 = vlib_buffer_get_current (p0);
941 /* Fill in ethernet header. */
942 eth_rx = ethernet_buffer_get_header (p0);
944 is_request0 = arp0->opcode
945 == clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request);
947 error0 = ETHERNET_ARP_ERROR_replies_sent;
951 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet) ?
952 ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
955 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
956 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
958 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
960 /* not playing the ARP game if the interface is not IPv4 enabled */
962 (im4->ip_enabled_by_sw_if_index[sw_if_index0] == 0 ?
963 ETHERNET_ARP_ERROR_interface_not_ip_enabled : error0);
968 /* Check that IP address is local and matches incoming interface. */
969 fib_index0 = ip4_fib_table_get_index_for_sw_if_index (sw_if_index0);
970 if (~0 == fib_index0)
972 error0 = ETHERNET_ARP_ERROR_interface_no_table;
976 dst_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
977 &arp0->ip4_over_ethernet[1].ip4,
979 dst_flags = fib_entry_get_flags (dst_fei);
981 conn_sw_if_index0 = fib_entry_get_resolving_interface (dst_fei);
983 /* Honor unnumbered interface, if any */
984 is_unnum0 = sw_if_index0 != conn_sw_if_index0;
988 * we're looking for FIB entries that indicate the source
989 * is attached. There may be more specific non-attached
990 * routes that match the source, but these do not influence
991 * whether we respond to an ARP request, i.e. they do not
992 * influence whether we are the correct way for the sender
993 * to reach us, they only affect how we reach the sender.
995 fib_entry_t *src_fib_entry;
996 fib_entry_src_t *src;
1007 src_fei = ip4_fib_table_lookup (ip4_fib_get (fib_index0),
1009 ip4_over_ethernet[0].ip4,
1011 src_fib_entry = fib_entry_get (src_fei);
1014 * It's possible that the source that provides the
1015 * flags we need, or the flags we must not have,
1016 * is not the best source, so check then all.
1019 FOR_EACH_SRC_ADDED(src_fib_entry, src, source,
1021 src_flags = fib_entry_get_flags_for_source (src_fei, source);
1023 /* Reject requests/replies with our local interface
1025 if (FIB_ENTRY_FLAG_LOCAL & src_flags)
1027 error0 = ETHERNET_ARP_ERROR_l3_src_address_is_local;
1029 * When VPP has an interface whose address is also
1030 * applied to a TAP interface on the host, then VPP's
1031 * TAP interface will be unnumbered to the 'real'
1032 * interface and do proxy ARP from the host.
1033 * The curious aspect of this setup is that ARP requests
1034 * from the host will come from the VPP's own address.
1035 * So don't drop immediately here, instead go see if this
1036 * is a proxy ARP case.
1040 /* A Source must also be local to subnet of matching
1041 * interface address. */
1042 if ((FIB_ENTRY_FLAG_ATTACHED & src_flags) ||
1043 (FIB_ENTRY_FLAG_CONNECTED & src_flags))
1050 * The packet was sent from an address that is not
1051 * connected nor attached i.e. it is not from an
1052 * address that is covered by a link's sub-net,
1053 * nor is it a already learned host resp.
1059 * shorter mask lookup for the next iteration.
1061 fib_entry_get_prefix (src_fei, &pfx);
1062 mask = pfx.fp_len - 1;
1065 * continue until we hit the default route or we find
1066 * the attached we are looking for. The most likely
1067 * outcome is we find the attached with the first source
1068 * on the first lookup.
1072 !fib_entry_is_sourced (src_fei, FIB_SOURCE_DEFAULT_ROUTE));
1077 * the matching route is a not attached, i.e. it was
1078 * added as a result of routing, rather than interface/ARP
1079 * configuration. If the matching route is not a host route
1082 error0 = ETHERNET_ARP_ERROR_l3_src_address_not_local;
1087 if (!(FIB_ENTRY_FLAG_CONNECTED & dst_flags))
1089 error0 = ETHERNET_ARP_ERROR_l3_dst_address_not_local;
1093 if (sw_if_index0 != fib_entry_get_resolving_interface (src_fei))
1096 * The interface the ARP was received on is not the interface
1097 * on which the covering prefix is configured. Maybe this is a
1098 * case for unnumbered.
1103 dst_is_local0 = (FIB_ENTRY_FLAG_LOCAL & dst_flags);
1104 fib_entry_get_prefix (dst_fei, &pfx0);
1105 if_addr0 = &pfx0.fp_addr.ip4;
1109 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
1112 (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
1113 sizeof (vrrp_prefix))));
1115 /* Trash ARP packets whose ARP-level source addresses do not
1116 match their L2-frame-level source addresses, unless it's
1117 a reply from a VRRP virtual router */
1119 (eth_rx->src_address, arp0->ip4_over_ethernet[0].ethernet,
1120 sizeof (eth_rx->src_address)) && !is_vrrp_reply0)
1122 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
1126 /* Learn or update sender's mapping only for replies to addresses
1127 * that are local to the subnet */
1129 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply) &&
1132 error0 = arp_learn (vnm, am, sw_if_index0,
1133 &arp0->ip4_over_ethernet[0]);
1136 else if (arp0->opcode ==
1137 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_request) &&
1138 (dst_is_local0 == 0))
1145 An adjacency to the sender is not always present,
1146 so we use the interface to build us a rewrite string
1147 which will contain all the necessary tags. */
1148 rewrite0 = ethernet_build_rewrite (vnm, sw_if_index0,
1150 eth_rx->src_address);
1151 rewrite0_len = vec_len (rewrite0);
1153 /* Figure out how much to rewind current data from adjacency. */
1154 vlib_buffer_advance (p0, -rewrite0_len);
1155 eth_tx = vlib_buffer_get_current (p0);
1157 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1158 hw_if0 = vnet_get_sup_hw_interface (vnm, sw_if_index0);
1160 /* Send reply back through input interface */
1161 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
1162 next0 = ARP_INPUT_NEXT_REPLY_TX;
1164 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
1166 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
1168 clib_memcpy (arp0->ip4_over_ethernet[0].ethernet,
1169 hw_if0->hw_address, 6);
1170 clib_mem_unaligned (&arp0->ip4_over_ethernet[0].ip4.data_u32, u32) =
1173 /* Hardware must be ethernet-like. */
1174 ASSERT (vec_len (hw_if0->hw_address) == 6);
1176 /* the rx nd tx ethernet headers wil overlap in the case
1177 * when we received a tagged VLAN=0 packet, but we are sending
1179 clib_memcpy (eth_tx, rewrite0, vec_len (rewrite0));
1180 vec_free (rewrite0);
1186 if (!arp_unnumbered (p0, sw_if_index0, conn_sw_if_index0))
1191 /* We are going to reply to this request, so, in the absence of
1192 errors, learn the sender */
1194 error0 = arp_learn (vnm, am, sw_if_index0,
1195 &arp0->ip4_over_ethernet[1]);
1197 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1198 n_left_to_next, pi0, next0);
1200 n_replies_sent += 1;
1204 if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
1205 (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
1206 arp0->ip4_over_ethernet[1].ip4.as_u32))
1208 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
1211 /* See if proxy arp is configured for the address */
1214 vnet_sw_interface_t *si;
1215 u32 this_addr = clib_net_to_host_u32
1216 (arp0->ip4_over_ethernet[1].ip4.as_u32);
1219 si = vnet_get_sw_interface (vnm, sw_if_index0);
1221 if (!(si->flags & VNET_SW_INTERFACE_FLAG_PROXY_ARP))
1224 fib_index0 = vec_elt (im4->fib_index_by_sw_if_index,
1227 vec_foreach (pa, am->proxy_arps)
1229 u32 lo_addr = clib_net_to_host_u32 (pa->lo_addr.as_u32);
1230 u32 hi_addr = clib_net_to_host_u32 (pa->hi_addr.as_u32);
1232 /* an ARP request hit in the proxy-arp table? */
1233 if ((this_addr >= lo_addr && this_addr <= hi_addr) &&
1234 (fib_index0 == pa->fib_index))
1237 arp0->ip4_over_ethernet[1].ip4.data_u32;
1240 * change the interface address to the proxied
1242 if_addr0 = &proxy_src;
1244 n_proxy_arp_replies_sent++;
1252 next0 = ARP_INPUT_NEXT_DROP;
1253 p0->error = node->errors[error0];
1255 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
1256 n_left_to_next, pi0, next0);
1259 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
1262 vlib_error_count (vm, node->node_index,
1263 ETHERNET_ARP_ERROR_replies_sent,
1264 n_replies_sent - n_proxy_arp_replies_sent);
1266 vlib_error_count (vm, node->node_index,
1267 ETHERNET_ARP_ERROR_proxy_arp_replies_sent,
1268 n_proxy_arp_replies_sent);
1269 return frame->n_vectors;
1272 static char *ethernet_arp_error_strings[] = {
1273 #define _(sym,string) string,
1274 foreach_ethernet_arp_error
1279 VLIB_REGISTER_NODE (arp_input_node, static) =
1281 .function = arp_input,
1282 .name = "arp-input",
1283 .vector_size = sizeof (u32),
1284 .n_errors = ETHERNET_ARP_N_ERROR,
1285 .error_strings = ethernet_arp_error_strings,
1286 .n_next_nodes = ARP_INPUT_N_NEXT,
1288 [ARP_INPUT_NEXT_DROP] = "error-drop",
1289 [ARP_INPUT_NEXT_REPLY_TX] = "interface-output",
1291 .format_buffer = format_ethernet_arp_header,
1292 .format_trace = format_ethernet_arp_input_trace,
1297 ip4_arp_entry_sort (void *a1, void *a2)
1299 ethernet_arp_ip4_entry_t *e1 = a1;
1300 ethernet_arp_ip4_entry_t *e2 = a2;
1303 vnet_main_t *vnm = vnet_get_main ();
1305 cmp = vnet_sw_interface_compare (vnm, e1->sw_if_index, e2->sw_if_index);
1307 cmp = ip4_address_compare (&e1->ip4_address, &e2->ip4_address);
1311 ethernet_arp_ip4_entry_t *
1312 ip4_neighbors_pool (void)
1314 ethernet_arp_main_t *am = ðernet_arp_main;
1315 return am->ip4_entry_pool;
1318 ethernet_arp_ip4_entry_t *
1319 ip4_neighbor_entries (u32 sw_if_index)
1321 ethernet_arp_main_t *am = ðernet_arp_main;
1322 ethernet_arp_ip4_entry_t *n, *ns = 0;
1325 pool_foreach (n, am->ip4_entry_pool, ({
1326 if (sw_if_index != ~0 && n->sw_if_index != sw_if_index)
1328 vec_add1 (ns, n[0]);
1333 vec_sort_with_function (ns, ip4_arp_entry_sort);
1337 static clib_error_t *
1338 show_ip4_arp (vlib_main_t * vm,
1339 unformat_input_t * input, vlib_cli_command_t * cmd)
1341 vnet_main_t *vnm = vnet_get_main ();
1342 ethernet_arp_main_t *am = ðernet_arp_main;
1343 ethernet_arp_ip4_entry_t *e, *es;
1344 ethernet_proxy_arp_t *pa;
1345 clib_error_t *error = 0;
1348 /* Filter entries by interface if given. */
1350 (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1352 es = ip4_neighbor_entries (sw_if_index);
1355 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, 0);
1358 vlib_cli_output (vm, "%U", format_ethernet_arp_ip4_entry, vnm, e);
1363 if (vec_len (am->proxy_arps))
1365 vlib_cli_output (vm, "Proxy arps enabled for:");
1366 vec_foreach (pa, am->proxy_arps)
1368 vlib_cli_output (vm, "Fib_index %d %U - %U ",
1370 format_ip4_address, &pa->lo_addr,
1371 format_ip4_address, &pa->hi_addr);
1379 * Display all the IPv4 ARP entries.
1382 * Example of how to display the IPv4 ARP table:
1383 * @cliexstart{show ip arp}
1384 * Time FIB IP4 Flags Ethernet Interface
1385 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
1386 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
1387 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
1388 * Proxy arps enabled for:
1389 * Fib_index 0 6.0.0.1 - 6.0.0.11
1393 VLIB_CLI_COMMAND (show_ip4_arp_command, static) = {
1394 .path = "show ip arp",
1395 .function = show_ip4_arp,
1396 .short_help = "show ip arp",
1402 pg_edit_t l2_type, l3_type;
1403 pg_edit_t n_l2_address_bytes, n_l3_address_bytes;
1409 } ip4_over_ethernet[2];
1410 } pg_ethernet_arp_header_t;
1413 pg_ethernet_arp_header_init (pg_ethernet_arp_header_t * p)
1415 /* Initialize fields that are not bit fields in the IP header. */
1416 #define _(f) pg_edit_init (&p->f, ethernet_arp_header_t, f);
1419 _(n_l2_address_bytes);
1420 _(n_l3_address_bytes);
1422 _(ip4_over_ethernet[0].ethernet);
1423 _(ip4_over_ethernet[0].ip4);
1424 _(ip4_over_ethernet[1].ethernet);
1425 _(ip4_over_ethernet[1].ip4);
1430 unformat_pg_arp_header (unformat_input_t * input, va_list * args)
1432 pg_stream_t *s = va_arg (*args, pg_stream_t *);
1433 pg_ethernet_arp_header_t *p;
1436 p = pg_create_edit_group (s, sizeof (p[0]), sizeof (ethernet_arp_header_t),
1438 pg_ethernet_arp_header_init (p);
1441 pg_edit_set_fixed (&p->l2_type, ETHERNET_ARP_HARDWARE_TYPE_ethernet);
1442 pg_edit_set_fixed (&p->l3_type, ETHERNET_TYPE_IP4);
1443 pg_edit_set_fixed (&p->n_l2_address_bytes, 6);
1444 pg_edit_set_fixed (&p->n_l3_address_bytes, 4);
1446 if (!unformat (input, "%U: %U/%U -> %U/%U",
1448 unformat_ethernet_arp_opcode_net_byte_order, &p->opcode,
1450 unformat_ethernet_address, &p->ip4_over_ethernet[0].ethernet,
1452 unformat_ip4_address, &p->ip4_over_ethernet[0].ip4,
1454 unformat_ethernet_address, &p->ip4_over_ethernet[1].ethernet,
1456 unformat_ip4_address, &p->ip4_over_ethernet[1].ip4))
1458 /* Free up any edits we may have added. */
1459 pg_free_edit_group (s);
1466 ip4_set_arp_limit (u32 arp_limit)
1468 ethernet_arp_main_t *am = ðernet_arp_main;
1470 am->limit_arp_cache_size = arp_limit;
1475 * @brief Control Plane hook to remove an ARP entry
1478 vnet_arp_unset_ip4_over_ethernet (vnet_main_t * vnm,
1479 u32 sw_if_index, void *a_arg)
1481 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1482 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1484 args.sw_if_index = sw_if_index;
1485 args.flags = ETHERNET_ARP_ARGS_REMOVE;
1486 clib_memcpy (&args.a, a, sizeof (*a));
1488 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1489 (u8 *) & args, sizeof (args));
1494 * @brief Internally generated event to flush the ARP cache on an
1495 * interface state change event.
1496 * A flush will remove dynamic ARP entries, and for statics remove the MAC
1497 * address from the corresponding adjacencies.
1500 vnet_arp_flush_ip4_over_ethernet (vnet_main_t * vnm,
1501 u32 sw_if_index, void *a_arg)
1503 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1504 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1506 args.sw_if_index = sw_if_index;
1507 args.flags = ETHERNET_ARP_ARGS_FLUSH;
1508 clib_memcpy (&args.a, a, sizeof (*a));
1510 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1511 (u8 *) & args, sizeof (args));
1516 * @brief Internally generated event to populate the ARP cache on an
1517 * interface state change event.
1518 * For static entries this will re-source the adjacencies.
1520 * @param sw_if_index The interface on which the ARP entires are acted
1523 vnet_arp_populate_ip4_over_ethernet (vnet_main_t * vnm,
1524 u32 sw_if_index, void *a_arg)
1526 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1527 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1529 args.sw_if_index = sw_if_index;
1530 args.flags = ETHERNET_ARP_ARGS_POPULATE;
1531 clib_memcpy (&args.a, a, sizeof (*a));
1533 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1534 (u8 *) & args, sizeof (args));
1539 * @brief publish wildcard arp event
1540 * @param sw_if_index The interface on which the ARP entires are acted
1543 vnet_arp_wc_publish (u32 sw_if_index, void *a_arg)
1545 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1546 vnet_arp_set_ip4_over_ethernet_rpc_args_t args = {
1547 .flags = ETHERNET_ARP_ARGS_WC_PUB,
1548 .sw_if_index = sw_if_index,
1552 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1553 (u8 *) & args, sizeof (args));
1558 vnet_arp_wc_publish_internal (vnet_main_t * vnm,
1559 vnet_arp_set_ip4_over_ethernet_rpc_args_t *
1562 vlib_main_t *vm = vlib_get_main ();
1563 ethernet_arp_main_t *am = ðernet_arp_main;
1564 uword ni = am->wc_ip4_arp_publisher_node;
1565 uword et = am->wc_ip4_arp_publisher_et;
1567 if (ni == (uword) ~ 0)
1569 wc_arp_report_t *r =
1570 vlib_process_signal_event_data (vm, ni, et, 1, sizeof *r);
1571 r->ip4 = args->a.ip4.as_u32;
1572 r->sw_if_index = args->sw_if_index;
1573 memcpy (r->mac, args->a.ethernet, sizeof r->mac);
1577 wc_arp_set_publisher_node (uword node_index, uword event_type)
1579 ethernet_arp_main_t *am = ðernet_arp_main;
1580 am->wc_ip4_arp_publisher_node = node_index;
1581 am->wc_ip4_arp_publisher_et = event_type;
1585 * arp_add_del_interface_address
1587 * callback when an interface address is added or deleted
1590 arp_add_del_interface_address (ip4_main_t * im,
1593 ip4_address_t * address,
1595 u32 if_address_index, u32 is_del)
1598 * Flush the ARP cache of all entries covered by the address
1599 * that is being removed.
1601 ethernet_arp_main_t *am = ðernet_arp_main;
1602 ethernet_arp_ip4_entry_t *e;
1604 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1609 ethernet_arp_interface_t *eai;
1610 u32 i, *to_delete = 0;
1613 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1616 hash_foreach_pair (pair, eai->arp_entries,
1618 e = pool_elt_at_index(am->ip4_entry_pool,
1620 if (ip4_destination_matches_route (im, &e->ip4_address,
1621 address, address_length))
1623 vec_add1 (to_delete, e - am->ip4_entry_pool);
1628 for (i = 0; i < vec_len (to_delete); i++)
1630 ethernet_arp_ip4_over_ethernet_address_t delme;
1631 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1633 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1634 delme.ip4.as_u32 = e->ip4_address.as_u32;
1636 vnet_arp_flush_ip4_over_ethernet (vnet_get_main (),
1637 e->sw_if_index, &delme);
1640 vec_free (to_delete);
1645 arp_adj_fib_remove (ethernet_arp_ip4_entry_t * e, u32 fib_index)
1647 if (FIB_NODE_INDEX_INVALID != e->fib_entry_index)
1649 fib_prefix_t pfx = {
1651 .fp_proto = FIB_PROTOCOL_IP4,
1652 .fp_addr.ip4 = e->ip4_address,
1656 fib_index = ip4_fib_table_get_index_for_sw_if_index (e->sw_if_index);
1658 fib_table_entry_path_remove (fib_index, &pfx,
1662 e->sw_if_index, ~0, 1,
1663 FIB_ROUTE_PATH_FLAG_NONE);
1664 fib_table_unlock (fib_index, FIB_PROTOCOL_IP4, FIB_SOURCE_ADJ);
1669 arp_table_bind (ip4_main_t * im,
1671 u32 sw_if_index, u32 new_fib_index, u32 old_fib_index)
1673 ethernet_arp_main_t *am = ðernet_arp_main;
1674 ethernet_arp_interface_t *eai;
1675 ethernet_arp_ip4_entry_t *e;
1679 * the IP table that the interface is bound to has changed.
1680 * reinstall all the adj fibs.
1683 if (vec_len (am->ethernet_arp_by_sw_if_index) <= sw_if_index)
1686 eai = &am->ethernet_arp_by_sw_if_index[sw_if_index];
1689 hash_foreach_pair (pair, eai->arp_entries,
1691 e = pool_elt_at_index(am->ip4_entry_pool,
1694 * remove the adj-fib from the old table and add to the new
1696 arp_adj_fib_remove(e, old_fib_index);
1697 arp_adj_fib_add(e, new_fib_index);
1703 static clib_error_t *
1704 ethernet_arp_init (vlib_main_t * vm)
1706 ethernet_arp_main_t *am = ðernet_arp_main;
1707 ip4_main_t *im = &ip4_main;
1708 clib_error_t *error;
1711 if ((error = vlib_call_init_function (vm, ethernet_init)))
1714 ethernet_register_input_type (vm, ETHERNET_TYPE_ARP, arp_input_node.index);
1716 pn = pg_get_node (arp_input_node.index);
1717 pn->unformat_edit = unformat_pg_arp_header;
1719 am->opcode_by_name = hash_create_string (0, sizeof (uword));
1720 #define _(o) hash_set_mem (am->opcode_by_name, #o, ETHERNET_ARP_OPCODE_##o);
1721 foreach_ethernet_arp_opcode;
1724 /* $$$ configurable */
1725 am->limit_arp_cache_size = 50000;
1727 am->pending_resolutions_by_address = hash_create (0, sizeof (uword));
1728 am->mac_changes_by_address = hash_create (0, sizeof (uword));
1729 am->wc_ip4_arp_publisher_node = (uword) ~ 0;
1731 /* don't trace ARP error packets */
1733 vlib_node_runtime_t *rt =
1734 vlib_node_get_runtime (vm, arp_input_node.index);
1737 vnet_pcap_drop_trace_filter_add_del \
1738 (rt->errors[ETHERNET_ARP_ERROR_##a], \
1740 foreach_ethernet_arp_error
1744 ip4_add_del_interface_address_callback_t cb;
1745 cb.function = arp_add_del_interface_address;
1746 cb.function_opaque = 0;
1747 vec_add1 (im->add_del_interface_address_callbacks, cb);
1749 ip4_table_bind_callback_t cbt;
1750 cbt.function = arp_table_bind;
1751 cbt.function_opaque = 0;
1752 vec_add1 (im->table_bind_callbacks, cbt);
1757 VLIB_INIT_FUNCTION (ethernet_arp_init);
1760 arp_entry_free (ethernet_arp_interface_t * eai, ethernet_arp_ip4_entry_t * e)
1762 ethernet_arp_main_t *am = ðernet_arp_main;
1764 arp_adj_fib_remove (e,
1765 ip4_fib_table_get_index_for_sw_if_index
1767 hash_unset (eai->arp_entries, e->ip4_address.as_u32);
1768 pool_put (am->ip4_entry_pool, e);
1772 vnet_arp_unset_ip4_over_ethernet_internal (vnet_main_t * vnm,
1773 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1776 ethernet_arp_main_t *am = ðernet_arp_main;
1777 ethernet_arp_ip4_entry_t *e;
1778 ethernet_arp_interface_t *eai;
1780 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1783 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1785 e = arp_entry_find (eai, &args->a.ip4);
1789 arp_entry_free (eai, e);
1791 adj_nbr_walk_nh4 (e->sw_if_index,
1792 &e->ip4_address, arp_mk_incomplete_walk, NULL);
1799 vnet_arp_flush_ip4_over_ethernet_internal (vnet_main_t * vnm,
1800 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1803 ethernet_arp_main_t *am = ðernet_arp_main;
1804 ethernet_arp_ip4_entry_t *e;
1805 ethernet_arp_interface_t *eai;
1807 if (vec_len (am->ethernet_arp_by_sw_if_index) <= args->sw_if_index)
1810 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1812 e = arp_entry_find (eai, &args->a.ip4);
1816 adj_nbr_walk_nh4 (e->sw_if_index,
1817 &e->ip4_address, arp_mk_incomplete_walk, e);
1820 * The difference between flush and unset, is that an unset
1821 * means delete for static and dynamic entries. A flush
1822 * means delete only for dynamic. Flushing is what the DP
1823 * does in response to interface events. unset is only done
1824 * by the control plane.
1826 if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_STATIC)
1828 e->flags &= ~ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC;
1830 else if (e->flags & ETHERNET_ARP_IP4_ENTRY_FLAG_DYNAMIC)
1832 arp_entry_free (eai, e);
1839 vnet_arp_populate_ip4_over_ethernet_internal (vnet_main_t * vnm,
1840 vnet_arp_set_ip4_over_ethernet_rpc_args_t
1843 ethernet_arp_main_t *am = ðernet_arp_main;
1844 ethernet_arp_ip4_entry_t *e;
1845 ethernet_arp_interface_t *eai;
1847 vec_validate (am->ethernet_arp_by_sw_if_index, args->sw_if_index);
1848 eai = &am->ethernet_arp_by_sw_if_index[args->sw_if_index];
1850 e = arp_entry_find (eai, &args->a.ip4);
1854 adj_nbr_walk_nh4 (e->sw_if_index,
1855 &e->ip4_address, arp_mk_complete_walk, e);
1861 set_ip4_over_ethernet_rpc_callback (vnet_arp_set_ip4_over_ethernet_rpc_args_t
1864 vnet_main_t *vm = vnet_get_main ();
1865 ASSERT (vlib_get_thread_index () == 0);
1867 if (a->flags & ETHERNET_ARP_ARGS_REMOVE)
1868 vnet_arp_unset_ip4_over_ethernet_internal (vm, a);
1869 else if (a->flags & ETHERNET_ARP_ARGS_FLUSH)
1870 vnet_arp_flush_ip4_over_ethernet_internal (vm, a);
1871 else if (a->flags & ETHERNET_ARP_ARGS_POPULATE)
1872 vnet_arp_populate_ip4_over_ethernet_internal (vm, a);
1873 else if (a->flags & ETHERNET_ARP_ARGS_WC_PUB)
1874 vnet_arp_wc_publish_internal (vm, a);
1876 vnet_arp_set_ip4_over_ethernet_internal (vm, a);
1880 * @brief Invoked when the interface's admin state changes
1882 static clib_error_t *
1883 ethernet_arp_sw_interface_up_down (vnet_main_t * vnm,
1884 u32 sw_if_index, u32 flags)
1886 ethernet_arp_main_t *am = ðernet_arp_main;
1887 ethernet_arp_ip4_entry_t *e;
1888 u32 i, *to_delete = 0;
1891 pool_foreach (e, am->ip4_entry_pool,
1893 if (e->sw_if_index == sw_if_index)
1894 vec_add1 (to_delete,
1895 e - am->ip4_entry_pool);
1899 for (i = 0; i < vec_len (to_delete); i++)
1901 ethernet_arp_ip4_over_ethernet_address_t delme;
1902 e = pool_elt_at_index (am->ip4_entry_pool, to_delete[i]);
1904 clib_memcpy (&delme.ethernet, e->ethernet_address, 6);
1905 delme.ip4.as_u32 = e->ip4_address.as_u32;
1907 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1909 vnet_arp_populate_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1913 vnet_arp_flush_ip4_over_ethernet (vnm, e->sw_if_index, &delme);
1917 vec_free (to_delete);
1922 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ethernet_arp_sw_interface_up_down);
1925 increment_ip4_and_mac_address (ethernet_arp_ip4_over_ethernet_address_t * a)
1930 for (i = 3; i >= 0; i--)
1932 old = a->ip4.as_u8[i];
1933 a->ip4.as_u8[i] += 1;
1934 if (old < a->ip4.as_u8[i])
1938 for (i = 5; i >= 0; i--)
1940 old = a->ethernet[i];
1941 a->ethernet[i] += 1;
1942 if (old < a->ethernet[i])
1948 vnet_arp_set_ip4_over_ethernet (vnet_main_t * vnm,
1949 u32 sw_if_index, void *a_arg,
1950 int is_static, int is_no_fib_entry)
1952 ethernet_arp_ip4_over_ethernet_address_t *a = a_arg;
1953 vnet_arp_set_ip4_over_ethernet_rpc_args_t args;
1955 args.sw_if_index = sw_if_index;
1956 args.is_static = is_static;
1957 args.is_no_fib_entry = is_no_fib_entry;
1959 clib_memcpy (&args.a, a, sizeof (*a));
1961 vl_api_rpc_call_main_thread (set_ip4_over_ethernet_rpc_callback,
1962 (u8 *) & args, sizeof (args));
1967 proxy_arp_walk (proxy_arp_walk_t cb, void *data)
1969 ethernet_arp_main_t *am = ðernet_arp_main;
1970 ethernet_proxy_arp_t *pa;
1972 vec_foreach (pa, am->proxy_arps)
1974 if (!cb (&pa->lo_addr, &pa->hi_addr, pa->fib_index, data))
1980 vnet_proxy_arp_add_del (ip4_address_t * lo_addr,
1981 ip4_address_t * hi_addr, u32 fib_index, int is_del)
1983 ethernet_arp_main_t *am = ðernet_arp_main;
1984 ethernet_proxy_arp_t *pa;
1985 u32 found_at_index = ~0;
1987 vec_foreach (pa, am->proxy_arps)
1989 if (pa->lo_addr.as_u32 == lo_addr->as_u32 &&
1990 pa->hi_addr.as_u32 == hi_addr->as_u32 && pa->fib_index == fib_index)
1992 found_at_index = pa - am->proxy_arps;
1997 if (found_at_index != ~0)
1999 /* Delete, otherwise it's already in the table */
2001 vec_delete (am->proxy_arps, 1, found_at_index);
2004 /* delete, no such entry */
2006 return VNET_API_ERROR_NO_SUCH_ENTRY;
2008 /* add, not in table */
2009 vec_add2 (am->proxy_arps, pa, 1);
2010 pa->lo_addr.as_u32 = lo_addr->as_u32;
2011 pa->hi_addr.as_u32 = hi_addr->as_u32;
2012 pa->fib_index = fib_index;
2017 * Remove any proxy arp entries asdociated with the
2021 vnet_proxy_arp_fib_reset (u32 fib_id)
2023 ethernet_arp_main_t *am = ðernet_arp_main;
2024 ethernet_proxy_arp_t *pa;
2025 u32 *entries_to_delete = 0;
2029 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2030 if (~0 == fib_index)
2031 return VNET_API_ERROR_NO_SUCH_ENTRY;
2033 vec_foreach (pa, am->proxy_arps)
2035 if (pa->fib_index == fib_index)
2037 vec_add1 (entries_to_delete, pa - am->proxy_arps);
2041 for (i = 0; i < vec_len (entries_to_delete); i++)
2043 vec_delete (am->proxy_arps, 1, entries_to_delete[i]);
2046 vec_free (entries_to_delete);
2051 static clib_error_t *
2052 ip_arp_add_del_command_fn (vlib_main_t * vm,
2053 unformat_input_t * input, vlib_cli_command_t * cmd)
2055 vnet_main_t *vnm = vnet_get_main ();
2057 ethernet_arp_ip4_over_ethernet_address_t lo_addr, hi_addr, addr;
2064 int is_no_fib_entry = 0;
2067 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2069 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
2070 if (unformat (input, "%U %U %U",
2071 unformat_vnet_sw_interface, vnm, &sw_if_index,
2072 unformat_ip4_address, &addr.ip4,
2073 unformat_ethernet_address, &addr.ethernet))
2076 else if (unformat (input, "delete") || unformat (input, "del"))
2079 else if (unformat (input, "static"))
2082 else if (unformat (input, "no-fib-entry"))
2083 is_no_fib_entry = 1;
2085 else if (unformat (input, "count %d", &count))
2088 else if (unformat (input, "fib-id %d", &fib_id))
2090 fib_index = fib_table_find (FIB_PROTOCOL_IP4, fib_id);
2092 if (~0 == fib_index)
2093 return clib_error_return (0, "fib ID %d doesn't exist\n", fib_id);
2096 else if (unformat (input, "proxy %U - %U",
2097 unformat_ip4_address, &lo_addr.ip4,
2098 unformat_ip4_address, &hi_addr.ip4))
2106 (void) vnet_proxy_arp_add_del (&lo_addr.ip4, &hi_addr.ip4,
2115 for (i = 0; i < count; i++)
2119 uword event_type, *event_data = 0;
2121 /* Park the debug CLI until the arp entry is installed */
2122 vnet_register_ip4_arp_resolution_event
2123 (vnm, &addr.ip4, vlib_current_process (vm),
2124 1 /* type */ , 0 /* data */ );
2126 vnet_arp_set_ip4_over_ethernet
2127 (vnm, sw_if_index, &addr, is_static, is_no_fib_entry);
2129 vlib_process_wait_for_event (vm);
2130 event_type = vlib_process_get_events (vm, &event_data);
2131 vec_reset_length (event_data);
2132 if (event_type != 1)
2133 clib_warning ("event type %d unexpected", event_type);
2136 vnet_arp_unset_ip4_over_ethernet (vnm, sw_if_index, &addr);
2138 increment_ip4_and_mac_address (&addr);
2143 return clib_error_return (0, "unknown input `%U'",
2144 format_unformat_error, input);
2152 * Add or delete IPv4 ARP cache entries.
2154 * @note 'set ip arp' options (e.g. delete, static, 'fib-id <id>',
2155 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
2156 * any order and combination.
2160 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
2161 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
2162 * @cliexcmd{set ip arp GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2163 * @cliexcmd{set ip arp delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
2165 * To add or delete an IPv4 ARP cache entry to or from a specific fib
2167 * @cliexcmd{set ip arp fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2168 * @cliexcmd{set ip arp fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2170 * Add or delete IPv4 static ARP cache entries as follows:
2171 * @cliexcmd{set ip arp static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2172 * @cliexcmd{set ip arp static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2174 * For testing / debugging purposes, the 'set ip arp' command can add or
2175 * delete multiple entries. Supply the 'count N' parameter:
2176 * @cliexcmd{set ip arp count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
2179 VLIB_CLI_COMMAND (ip_arp_add_del_command, static) = {
2180 .path = "set ip arp",
2182 "set ip arp [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
2183 .function = ip_arp_add_del_command_fn,
2187 static clib_error_t *
2188 set_int_proxy_arp_command_fn (vlib_main_t * vm,
2190 input, vlib_cli_command_t * cmd)
2192 vnet_main_t *vnm = vnet_get_main ();
2194 vnet_sw_interface_t *si;
2198 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
2200 if (unformat (input, "%U", unformat_vnet_sw_interface,
2203 else if (unformat (input, "enable") || unformat (input, "on"))
2205 else if (unformat (input, "disable") || unformat (input, "off"))
2212 return clib_error_return (0, "unknown input '%U'",
2213 format_unformat_error, input);
2215 si = vnet_get_sw_interface (vnm, sw_if_index);
2218 si->flags |= VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2220 si->flags &= ~VNET_SW_INTERFACE_FLAG_PROXY_ARP;
2227 * Enable proxy-arp on an interface. The vpp stack will answer ARP
2228 * requests for the indicated address range. Multiple proxy-arp
2229 * ranges may be provisioned.
2231 * @note Proxy ARP as a technology is infamous for blackholing traffic.
2232 * Also, the underlying implementation has not been performance-tuned.
2233 * Avoid creating an unnecessarily large set of ranges.
2236 * To enable proxy arp on a range of addresses, use:
2237 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11}
2238 * Append 'del' to delete a range of proxy ARP addresses:
2239 * @cliexcmd{set ip arp proxy 6.0.0.1 - 6.0.0.11 del}
2240 * You must then specifically enable proxy arp on individual interfaces:
2241 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 enable}
2242 * To disable proxy arp on an individual interface:
2243 * @cliexcmd{set interface proxy-arp GigabitEthernet0/8/0 disable}
2245 VLIB_CLI_COMMAND (set_int_proxy_enable_command, static) = {
2246 .path = "set interface proxy-arp",
2248 "set interface proxy-arp <intfc> [enable|disable]",
2249 .function = set_int_proxy_arp_command_fn,
2255 * ARP/ND Termination in a L2 Bridge Domain based on IP4/IP6 to MAC
2256 * hash tables mac_by_ip4 and mac_by_ip6 for each BD.
2260 ARP_TERM_NEXT_L2_OUTPUT,
2265 u32 arp_term_next_node_index[32];
2268 arp_term_l2bd (vlib_main_t * vm,
2269 vlib_node_runtime_t * node, vlib_frame_t * frame)
2271 l2input_main_t *l2im = &l2input_main;
2272 u32 n_left_from, next_index, *from, *to_next;
2273 u32 n_replies_sent = 0;
2274 u16 last_bd_index = ~0;
2275 l2_bridge_domain_t *last_bd_config = 0;
2276 l2_input_config_t *cfg0;
2278 from = vlib_frame_vector_args (frame);
2279 n_left_from = frame->n_vectors;
2280 next_index = node->cached_next_index;
2282 while (n_left_from > 0)
2286 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
2288 while (n_left_from > 0 && n_left_to_next > 0)
2291 ethernet_header_t *eth0;
2292 ethernet_arp_header_t *arp0;
2295 u32 pi0, error0, next0, sw_if_index0;
2307 n_left_to_next -= 1;
2309 p0 = vlib_get_buffer (vm, pi0);
2310 // Terminate only local (SHG == 0) ARP
2311 if (vnet_buffer (p0)->l2.shg != 0)
2312 goto next_l2_feature;
2314 eth0 = vlib_buffer_get_current (p0);
2315 l3h0 = (u8 *) eth0 + vnet_buffer (p0)->l2.l2_len;
2316 ethertype0 = clib_net_to_host_u16 (*(u16 *) (l3h0 - 2));
2317 arp0 = (ethernet_arp_header_t *) l3h0;
2319 if (PREDICT_FALSE ((ethertype0 != ETHERNET_TYPE_ARP) ||
2321 clib_host_to_net_u16
2322 (ETHERNET_ARP_OPCODE_request))))
2325 /* Must be ARP request packet here */
2326 if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE) &&
2327 (p0->flags & VLIB_BUFFER_IS_TRACED)))
2329 u8 *t0 = vlib_add_trace (vm, node, p0,
2330 sizeof (ethernet_arp_input_trace_t));
2331 clib_memcpy (t0, l3h0, sizeof (ethernet_arp_input_trace_t));
2334 error0 = ETHERNET_ARP_ERROR_replies_sent;
2337 clib_net_to_host_u16 (ETHERNET_ARP_HARDWARE_TYPE_ethernet)
2338 ? ETHERNET_ARP_ERROR_l2_type_not_ethernet : error0);
2341 clib_net_to_host_u16 (ETHERNET_TYPE_IP4) ?
2342 ETHERNET_ARP_ERROR_l3_type_not_ip4 : error0);
2344 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2351 clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply))
2354 (arp0->ip4_over_ethernet[0].ethernet, vrrp_prefix,
2355 sizeof (vrrp_prefix))));
2357 /* Trash ARP packets whose ARP-level source addresses do not
2358 match their L2-frame-level source addresses, unless it's
2359 a reply from a VRRP virtual router */
2361 (memcmp (eth0->src_address, arp0->ip4_over_ethernet[0].ethernet,
2362 sizeof (eth0->src_address)) && !is_vrrp_reply0))
2364 error0 = ETHERNET_ARP_ERROR_l2_address_mismatch;
2368 /* Check if anyone want ARP request events for L2 BDs */
2370 ethernet_arp_main_t *am = ðernet_arp_main;
2371 if (am->wc_ip4_arp_publisher_node != (uword) ~ 0)
2372 vnet_arp_wc_publish (sw_if_index0, &arp0->ip4_over_ethernet[0]);
2375 /* lookup BD mac_by_ip4 hash table for MAC entry */
2376 ip0 = arp0->ip4_over_ethernet[1].ip4.as_u32;
2377 bd_index0 = vnet_buffer (p0)->l2.bd_index;
2378 if (PREDICT_FALSE ((bd_index0 != last_bd_index)
2379 || (last_bd_index == (u16) ~ 0)))
2381 last_bd_index = bd_index0;
2382 last_bd_config = vec_elt_at_index (l2im->bd_configs, bd_index0);
2384 macp0 = (u8 *) hash_get (last_bd_config->mac_by_ip4, ip0);
2386 if (PREDICT_FALSE (!macp0))
2387 goto next_l2_feature; /* MAC not found */
2389 /* MAC found, send ARP reply -
2390 Convert ARP request packet to ARP reply */
2391 arp0->opcode = clib_host_to_net_u16 (ETHERNET_ARP_OPCODE_reply);
2392 arp0->ip4_over_ethernet[1] = arp0->ip4_over_ethernet[0];
2393 arp0->ip4_over_ethernet[0].ip4.as_u32 = ip0;
2394 clib_memcpy (arp0->ip4_over_ethernet[0].ethernet, macp0, 6);
2395 clib_memcpy (eth0->dst_address, eth0->src_address, 6);
2396 clib_memcpy (eth0->src_address, macp0, 6);
2397 n_replies_sent += 1;
2400 /* For BVI, need to use l2-fwd node to send ARP reply as
2401 l2-output node cannot output packet to BVI properly */
2402 cfg0 = vec_elt_at_index (l2im->configs, sw_if_index0);
2403 if (PREDICT_FALSE (cfg0->bvi))
2405 vnet_buffer (p0)->l2.feature_bitmap |= L2INPUT_FEAT_FWD;
2406 vnet_buffer (p0)->sw_if_index[VLIB_RX] = 0;
2407 goto next_l2_feature;
2410 /* Send ARP/ND reply back out input interface through l2-output */
2411 vnet_buffer (p0)->sw_if_index[VLIB_TX] = sw_if_index0;
2412 next0 = ARP_TERM_NEXT_L2_OUTPUT;
2413 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2414 to_next, n_left_to_next, pi0,
2419 /* IP6 ND event notification or solicitation handling to generate
2420 local response instead of flooding */
2421 iph0 = (ip6_header_t *) l3h0;
2422 if (PREDICT_FALSE (ethertype0 == ETHERNET_TYPE_IP6 &&
2423 iph0->protocol == IP_PROTOCOL_ICMP6 &&
2424 !ip6_address_is_unspecified
2425 (&iph0->src_address)))
2427 sw_if_index0 = vnet_buffer (p0)->sw_if_index[VLIB_RX];
2428 if (vnet_ip6_nd_term
2429 (vm, node, p0, eth0, iph0, sw_if_index0,
2430 vnet_buffer (p0)->l2.bd_index))
2431 goto output_response;
2436 next0 = vnet_l2_feature_next (p0, arp_term_next_node_index,
2437 L2INPUT_FEAT_ARP_TERM);
2438 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2439 to_next, n_left_to_next,
2445 if (0 == arp0->ip4_over_ethernet[0].ip4.as_u32 ||
2446 (arp0->ip4_over_ethernet[0].ip4.as_u32 ==
2447 arp0->ip4_over_ethernet[1].ip4.as_u32))
2449 error0 = ETHERNET_ARP_ERROR_gratuitous_arp;
2451 next0 = ARP_TERM_NEXT_DROP;
2452 p0->error = node->errors[error0];
2454 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
2455 to_next, n_left_to_next, pi0,
2459 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
2462 vlib_error_count (vm, node->node_index,
2463 ETHERNET_ARP_ERROR_replies_sent, n_replies_sent);
2464 return frame->n_vectors;
2468 VLIB_REGISTER_NODE (arp_term_l2bd_node, static) = {
2469 .function = arp_term_l2bd,
2470 .name = "arp-term-l2bd",
2471 .vector_size = sizeof (u32),
2472 .n_errors = ETHERNET_ARP_N_ERROR,
2473 .error_strings = ethernet_arp_error_strings,
2474 .n_next_nodes = ARP_TERM_N_NEXT,
2476 [ARP_TERM_NEXT_L2_OUTPUT] = "l2-output",
2477 [ARP_TERM_NEXT_DROP] = "error-drop",
2479 .format_buffer = format_ethernet_arp_header,
2480 .format_trace = format_arp_term_input_trace,
2485 arp_term_init (vlib_main_t * vm)
2487 // Initialize the feature next-node indexes
2488 feat_bitmap_init_next_nodes (vm,
2489 arp_term_l2bd_node.index,
2491 l2input_get_feat_names (),
2492 arp_term_next_node_index);
2496 VLIB_INIT_FUNCTION (arp_term_init);
2499 change_arp_mac (u32 sw_if_index, ethernet_arp_ip4_entry_t * e)
2501 if (e->sw_if_index == sw_if_index)
2503 adj_nbr_walk_nh4 (e->sw_if_index,
2504 &e->ip4_address, arp_mk_complete_walk, e);
2509 ethernet_arp_change_mac (u32 sw_if_index)
2511 ethernet_arp_main_t *am = ðernet_arp_main;
2512 ethernet_arp_ip4_entry_t *e;
2516 pool_foreach (e, am->ip4_entry_pool,
2518 change_arp_mac (sw_if_index, e);
2522 ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
2524 if (ADJ_INDEX_INVALID != ai)
2525 adj_glean_update_rewrite (ai);
2529 send_ip4_garp (vlib_main_t * vm, const vnet_hw_interface_t * hi)
2531 ip4_main_t *i4m = &ip4_main;
2532 ip4_address_t *ip4_addr =
2533 ip4_interface_first_address (i4m, hi->sw_if_index, 0);
2535 send_ip4_garp_w_addr (vm, ip4_addr, hi);
2539 send_ip4_garp_w_addr (vlib_main_t * vm,
2540 const ip4_address_t * ip4_addr,
2541 const vnet_hw_interface_t * hi)
2543 ip4_main_t *i4m = &ip4_main;
2544 u32 sw_if_index = hi->sw_if_index;
2548 clib_warning ("Sending GARP for IP4 address %U on sw_if_idex %d",
2549 format_ip4_address, ip4_addr, sw_if_index);
2551 /* Form GARP packet for output - Gratuitous ARP is an ARP request packet
2552 where the interface IP/MAC pair is used for both source and request
2553 MAC/IP pairs in the request */
2555 ethernet_arp_header_t *h = vlib_packet_template_get_packet
2556 (vm, &i4m->ip4_arp_request_packet_template, &bi);
2557 clib_memcpy (h->ip4_over_ethernet[0].ethernet, hi->hw_address,
2558 sizeof (h->ip4_over_ethernet[0].ethernet));
2559 clib_memcpy (h->ip4_over_ethernet[1].ethernet, hi->hw_address,
2560 sizeof (h->ip4_over_ethernet[1].ethernet));
2561 h->ip4_over_ethernet[0].ip4 = ip4_addr[0];
2562 h->ip4_over_ethernet[1].ip4 = ip4_addr[0];
2564 /* Setup MAC header with ARP Etype and broadcast DMAC */
2565 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
2566 vlib_buffer_advance (b, -sizeof (ethernet_header_t));
2567 ethernet_header_t *e = vlib_buffer_get_current (b);
2568 e->type = clib_host_to_net_u16 (ETHERNET_TYPE_ARP);
2569 clib_memcpy (e->src_address, hi->hw_address, sizeof (e->src_address));
2570 memset (e->dst_address, 0xff, sizeof (e->dst_address));
2572 /* Send GARP packet out the specified interface */
2573 vnet_buffer (b)->sw_if_index[VLIB_RX] =
2574 vnet_buffer (b)->sw_if_index[VLIB_TX] = sw_if_index;
2575 vlib_frame_t *f = vlib_get_frame_to_node (vm, hi->output_node_index);
2576 u32 *to_next = vlib_frame_vector_args (f);
2579 vlib_put_frame_to_node (vm, hi->output_node_index, f);
2584 * fd.io coding-style-patch-verification: ON
2587 * eval: (c-set-style "gnu")