2 * src/vnet/ip/ip_neighboor.c: ip neighbor generic handling
4 * Copyright (c) 2018 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 <vppinfra/llist.h>
20 #include <vnet/ip-neighbor/ip_neighbor.h>
21 #include <vnet/ip-neighbor/ip4_neighbor.h>
22 #include <vnet/ip-neighbor/ip6_neighbor.h>
23 #include <vnet/ip-neighbor/ip_neighbor_watch.h>
25 #include <vnet/ip/ip6_ll_table.h>
26 #include <vnet/ip/ip46_address.h>
27 #include <vnet/fib/fib_table.h>
28 #include <vnet/adj/adj_mcast.h>
30 ip_neighbor_counters_t ip_neighbor_counters[] =
35 [IP_NEIGHBOR_CTR_REPLY] = {
36 .name = "arp-rx-replies",
37 .stat_segment_name = "/net/arp/rx/replies",
39 [IP_NEIGHBOR_CTR_REQUEST] = {
40 .name = "arp-rx-requests",
41 .stat_segment_name = "/net/arp/rx/requests",
43 [IP_NEIGHBOR_CTR_GRAT] = {
44 .name = "arp-rx-gratuitous",
45 .stat_segment_name = "/net/arp/rx/gratuitous",
49 [IP_NEIGHBOR_CTR_REPLY] = {
50 .name = "arp-tx-replies",
51 .stat_segment_name = "/net/arp/tx/replies",
53 [IP_NEIGHBOR_CTR_REQUEST] = {
54 .name = "arp-tx-requests",
55 .stat_segment_name = "/net/arp/tx/requests",
57 [IP_NEIGHBOR_CTR_GRAT] = {
58 .name = "arp-tx-gratuitous",
59 .stat_segment_name = "/net/arp/tx/gratuitous",
67 [IP_NEIGHBOR_CTR_REPLY] = {
68 .name = "ip6-nd-rx-replies",
69 .stat_segment_name = "/net/ip6-nd/rx/replies",
71 [IP_NEIGHBOR_CTR_REQUEST] = {
72 .name = "ip6-nd-rx-requests",
73 .stat_segment_name = "/net/ip6-nd/rx/requests",
75 [IP_NEIGHBOR_CTR_GRAT] = {
76 .name = "ip6-nd-rx-gratuitous",
77 .stat_segment_name = "/net/ip6-nd/rx/gratuitous",
81 [IP_NEIGHBOR_CTR_REPLY] = {
82 .name = "ip6-nd-tx-replies",
83 .stat_segment_name = "/net/ip6-nd/tx/replies",
85 [IP_NEIGHBOR_CTR_REQUEST] = {
86 .name = "ip6-nd-tx-requests",
87 .stat_segment_name = "/net/ip6-nd/tx/requests",
89 [IP_NEIGHBOR_CTR_GRAT] = {
90 .name = "ip6-nd-tx-gratuitous",
91 .stat_segment_name = "/net/ip6-nd/tx/gratuitous",
98 /** Pool for All IP neighbors */
99 static ip_neighbor_t *ip_neighbor_pool;
101 /** protocol specific lists of time sorted neighbors */
102 index_t ip_neighbor_list_head[N_AF];
104 typedef struct ip_neighbor_elt_t_
106 clib_llist_anchor_t ipne_anchor;
110 /** Pool of linked list elemeents */
111 ip_neighbor_elt_t *ip_neighbor_elt_pool;
113 typedef struct ip_neighbor_db_t_
115 /** per interface hash */
117 /** per-protocol limit - max number of neighbors*/
119 /** max age of a neighbor before it's forcibly evicted */
121 /** when the limit is reached and new neighbors are created, should
122 * we recycle an old one */
124 /** per-protocol number of elements */
126 /** per-protocol number of elements per-fib-index*/
127 u32 *ipndb_n_elts_per_fib;
130 static vlib_log_class_t ipn_logger;
132 /* DBs of neighbours one per AF */
134 static ip_neighbor_db_t ip_neighbor_db[N_AF] = {
136 .ipndb_limit = 50000,
137 /* Default to not aging and not recycling */
139 .ipndb_recycle = false,
142 .ipndb_limit = 50000,
143 /* Default to not aging and not recycling */
145 .ipndb_recycle = false,
150 #define IP_NEIGHBOR_DBG(...) \
151 vlib_log_debug (ipn_logger, __VA_ARGS__);
153 #define IP_NEIGHBOR_INFO(...) \
154 vlib_log_notice (ipn_logger, __VA_ARGS__);
157 ip_neighbor_get (index_t ipni)
159 if (pool_is_free_index (ip_neighbor_pool, ipni))
162 return (pool_elt_at_index (ip_neighbor_pool, ipni));
166 ip_neighbor_get_index (const ip_neighbor_t * ipn)
168 return (ipn - ip_neighbor_pool);
172 ip_neighbor_touch (ip_neighbor_t * ipn)
174 ipn->ipn_flags &= ~IP_NEIGHBOR_FLAG_STALE;
178 ip_neighbor_is_dynamic (const ip_neighbor_t * ipn)
180 return (ipn->ipn_flags & IP_NEIGHBOR_FLAG_DYNAMIC);
184 ip_neighbor_get_ip (const ip_neighbor_t * ipn)
186 return (&ipn->ipn_key->ipnk_ip);
190 ip_neighbor_get_af (const ip_neighbor_t * ipn)
192 return (ip_addr_version (&ipn->ipn_key->ipnk_ip));
195 const mac_address_t *
196 ip_neighbor_get_mac (const ip_neighbor_t * ipn)
198 return (&ipn->ipn_mac);
202 ip_neighbor_get_sw_if_index (const ip_neighbor_t * ipn)
204 return (ipn->ipn_key->ipnk_sw_if_index);
208 ip_neighbor_list_remove (ip_neighbor_t * ipn)
210 /* new neighbours, are added to the head of the list, since the
211 * list is time sorted, newest first */
212 ip_neighbor_elt_t *elt;
214 if (~0 != ipn->ipn_elt)
216 elt = pool_elt_at_index (ip_neighbor_elt_pool, ipn->ipn_elt);
218 clib_llist_remove (ip_neighbor_elt_pool, ipne_anchor, elt);
225 ip_neighbor_refresh (ip_neighbor_t * ipn)
227 /* new neighbours, are added to the head of the list, since the
228 * list is time sorted, newest first */
229 ip_neighbor_elt_t *elt, *head;
231 ip_neighbor_touch (ipn);
232 ipn->ipn_time_last_updated = vlib_time_now (vlib_get_main ());
233 ipn->ipn_n_probes = 0;
235 if (ip_neighbor_is_dynamic (ipn))
237 if (~0 == ipn->ipn_elt)
238 /* first time insertion */
239 pool_get_zero (ip_neighbor_elt_pool, elt);
242 /* already inserted - extract first */
243 elt = pool_elt_at_index (ip_neighbor_elt_pool, ipn->ipn_elt);
245 clib_llist_remove (ip_neighbor_elt_pool, ipne_anchor, elt);
247 head = pool_elt_at_index (ip_neighbor_elt_pool,
248 ip_neighbor_list_head[ip_neighbor_get_af
251 elt->ipne_index = ip_neighbor_get_index (ipn);
252 clib_llist_add (ip_neighbor_elt_pool, ipne_anchor, elt, head);
253 ipn->ipn_elt = elt - ip_neighbor_elt_pool;
258 ip_neighbor_db_add (const ip_neighbor_t * ipn)
260 ip_address_family_t af;
263 af = ip_neighbor_get_af (ipn);
264 sw_if_index = ipn->ipn_key->ipnk_sw_if_index;
266 vec_validate (ip_neighbor_db[af].ipndb_hash, sw_if_index);
268 if (!ip_neighbor_db[af].ipndb_hash[sw_if_index])
269 ip_neighbor_db[af].ipndb_hash[sw_if_index]
270 = hash_create_mem (0, sizeof (ip_neighbor_key_t), sizeof (index_t));
272 hash_set_mem (ip_neighbor_db[af].ipndb_hash[sw_if_index],
273 ipn->ipn_key, ip_neighbor_get_index (ipn));
275 ip_neighbor_db[af].ipndb_n_elts++;
279 ip_neighbor_db_remove (const ip_neighbor_t * ipn)
281 ip_address_family_t af;
284 af = ip_neighbor_get_af (ipn);
285 sw_if_index = ipn->ipn_key->ipnk_sw_if_index;
287 vec_validate (ip_neighbor_db[af].ipndb_hash, sw_if_index);
289 hash_unset_mem (ip_neighbor_db[af].ipndb_hash[sw_if_index], ipn->ipn_key);
291 ip_neighbor_db[af].ipndb_n_elts--;
294 static ip_neighbor_t *
295 ip_neighbor_db_find (const ip_neighbor_key_t * key)
297 ip_address_family_t af;
300 af = ip_addr_version (&key->ipnk_ip);
302 if (key->ipnk_sw_if_index >= vec_len (ip_neighbor_db[af].ipndb_hash))
305 p = hash_get_mem (ip_neighbor_db[af].ipndb_hash
306 [key->ipnk_sw_if_index], key);
309 return ip_neighbor_get (p[0]);
315 ip_af_type_pfx_len (ip_address_family_t type)
317 return (type == AF_IP4 ? 32 : 128);
321 ip_neighbor_adj_fib_add (ip_neighbor_t * ipn, u32 fib_index)
323 ip_address_family_t af;
325 af = ip_neighbor_get_af (ipn);
328 ip6_address_is_link_local_unicast (&ip_addr_v6
329 (&ipn->ipn_key->ipnk_ip)))
331 ip6_ll_prefix_t pfx = {
332 .ilp_addr = ip_addr_v6 (&ipn->ipn_key->ipnk_ip),
333 .ilp_sw_if_index = ipn->ipn_key->ipnk_sw_if_index,
335 ipn->ipn_fib_entry_index =
336 ip6_ll_table_entry_update (&pfx, FIB_ROUTE_PATH_FLAG_NONE);
340 fib_protocol_t fproto;
342 fproto = ip_address_family_to_fib_proto (af);
345 .fp_len = ip_af_type_pfx_len (af),
347 .fp_addr = ip_addr_46 (&ipn->ipn_key->ipnk_ip),
350 ipn->ipn_fib_entry_index =
351 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
352 FIB_ENTRY_FLAG_ATTACHED,
353 fib_proto_to_dpo (fproto),
355 ipn->ipn_key->ipnk_sw_if_index,
356 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
358 vec_validate (ip_neighbor_db[af].ipndb_n_elts_per_fib, fib_index);
360 ip_neighbor_db[af].ipndb_n_elts_per_fib[fib_index]++;
362 if (1 == ip_neighbor_db[af].ipndb_n_elts_per_fib[fib_index])
363 fib_table_lock (fib_index, fproto, FIB_SOURCE_ADJ);
368 ip_neighbor_adj_fib_remove (ip_neighbor_t * ipn, u32 fib_index)
370 ip_address_family_t af;
372 af = ip_neighbor_get_af (ipn);
374 if (FIB_NODE_INDEX_INVALID != ipn->ipn_fib_entry_index)
377 ip6_address_is_link_local_unicast (&ip_addr_v6
378 (&ipn->ipn_key->ipnk_ip)))
380 ip6_ll_prefix_t pfx = {
381 .ilp_addr = ip_addr_v6 (&ipn->ipn_key->ipnk_ip),
382 .ilp_sw_if_index = ipn->ipn_key->ipnk_sw_if_index,
384 ip6_ll_table_entry_delete (&pfx);
388 fib_protocol_t fproto;
390 fproto = ip_address_family_to_fib_proto (af);
393 .fp_len = ip_af_type_pfx_len (af),
395 .fp_addr = ip_addr_46 (&ipn->ipn_key->ipnk_ip),
398 fib_table_entry_path_remove (fib_index,
401 fib_proto_to_dpo (fproto),
403 ipn->ipn_key->ipnk_sw_if_index,
404 ~0, 1, FIB_ROUTE_PATH_FLAG_NONE);
406 ip_neighbor_db[af].ipndb_n_elts_per_fib[fib_index]--;
408 if (0 == ip_neighbor_db[af].ipndb_n_elts_per_fib[fib_index])
409 fib_table_unlock (fib_index, fproto, FIB_SOURCE_ADJ);
415 ip_neighbor_mk_complete (adj_index_t ai, ip_neighbor_t * ipn)
417 adj_nbr_update_rewrite (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
418 ethernet_build_rewrite (vnet_get_main (),
420 ipn_key->ipnk_sw_if_index,
421 adj_get_link_type (ai),
422 ipn->ipn_mac.bytes));
426 ip_neighbor_mk_incomplete (adj_index_t ai)
428 ip_adjacency_t *adj = adj_get (ai);
430 adj_nbr_update_rewrite (ai,
431 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
432 ethernet_build_rewrite (vnet_get_main (),
434 rewrite_header.sw_if_index,
436 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
440 ip_neighbor_mk_complete_walk (adj_index_t ai, void *ctx)
442 ip_neighbor_t *ipn = ctx;
444 ip_neighbor_mk_complete (ai, ipn);
446 return (ADJ_WALK_RC_CONTINUE);
450 ip_neighbor_mk_incomplete_walk (adj_index_t ai, void *ctx)
452 ip_neighbor_mk_incomplete (ai);
454 return (ADJ_WALK_RC_CONTINUE);
458 ip_neighbor_destroy (ip_neighbor_t * ipn)
460 ip_address_family_t af;
462 af = ip_neighbor_get_af (ipn);
464 IP_NEIGHBOR_DBG ("free: %U", format_ip_neighbor,
465 ip_neighbor_get_index (ipn));
467 ip_neighbor_publish (ip_neighbor_get_index (ipn),
468 IP_NEIGHBOR_EVENT_REMOVED);
470 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
471 ip_address_family_to_fib_proto (af),
472 &ip_addr_46 (&ipn->ipn_key->ipnk_ip),
473 ip_neighbor_mk_incomplete_walk, ipn);
474 ip_neighbor_adj_fib_remove
476 fib_table_get_index_for_sw_if_index
477 (ip_address_family_to_fib_proto (af), ipn->ipn_key->ipnk_sw_if_index));
479 ip_neighbor_list_remove (ipn);
480 ip_neighbor_db_remove (ipn);
481 clib_mem_free (ipn->ipn_key);
483 pool_put (ip_neighbor_pool, ipn);
487 ip_neighbor_force_reuse (ip_address_family_t af)
489 if (!ip_neighbor_db[af].ipndb_recycle)
492 /* pluck the oldest entry, which is the one from the end of the list */
493 ip_neighbor_elt_t *elt, *head;
495 head = pool_elt_at_index (ip_neighbor_elt_pool, ip_neighbor_list_head[af]);
497 if (clib_llist_is_empty (ip_neighbor_elt_pool, ipne_anchor, head))
500 elt = clib_llist_prev (ip_neighbor_elt_pool, ipne_anchor, head);
501 ip_neighbor_destroy (ip_neighbor_get (elt->ipne_index));
506 static ip_neighbor_t *
507 ip_neighbor_alloc (const ip_neighbor_key_t * key,
508 const mac_address_t * mac, ip_neighbor_flags_t flags)
510 ip_address_family_t af;
513 af = ip_addr_version (&key->ipnk_ip);
515 if (ip_neighbor_db[af].ipndb_limit &&
516 (ip_neighbor_db[af].ipndb_n_elts >= ip_neighbor_db[af].ipndb_limit))
518 if (!ip_neighbor_force_reuse (af))
522 pool_get_zero (ip_neighbor_pool, ipn);
524 ipn->ipn_key = clib_mem_alloc (sizeof (*ipn->ipn_key));
525 clib_memcpy (ipn->ipn_key, key, sizeof (*ipn->ipn_key));
527 ipn->ipn_fib_entry_index = FIB_NODE_INDEX_INVALID;
528 ipn->ipn_flags = flags;
531 mac_address_copy (&ipn->ipn_mac, mac);
533 ip_neighbor_db_add (ipn);
535 /* create the adj-fib. the entry in the FIB table for the peer's interface */
536 if (!(ipn->ipn_flags & IP_NEIGHBOR_FLAG_NO_FIB_ENTRY))
537 ip_neighbor_adj_fib_add
538 (ipn, fib_table_get_index_for_sw_if_index
539 (ip_address_family_to_fib_proto (af), ipn->ipn_key->ipnk_sw_if_index));
545 ip_neighbor_add (const ip_address_t * ip,
546 const mac_address_t * mac,
548 ip_neighbor_flags_t flags, u32 * stats_index)
550 fib_protocol_t fproto;
553 /* main thread only */
554 ASSERT (0 == vlib_get_thread_index ());
556 fproto = ip_address_family_to_fib_proto (ip_addr_version (ip));
558 const ip_neighbor_key_t key = {
560 .ipnk_sw_if_index = sw_if_index,
563 ipn = ip_neighbor_db_find (&key);
567 IP_NEIGHBOR_DBG ("update: %U, %U",
568 format_vnet_sw_if_index_name, vnet_get_main (),
569 sw_if_index, format_ip_address, ip,
570 format_ip_neighbor_flags, flags, format_mac_address_t,
573 ip_neighbor_touch (ipn);
575 /* Refuse to over-write static neighbor entry. */
576 if (!(flags & IP_NEIGHBOR_FLAG_STATIC) &&
577 (ipn->ipn_flags & IP_NEIGHBOR_FLAG_STATIC))
579 /* if MAC address match, still check to send event */
580 if (0 == mac_address_cmp (&ipn->ipn_mac, mac))
581 goto check_customers;
585 /* A dynamic entry can become static, but not vice-versa.
586 * i.e. since if it was programmed by the CP then it must
587 * be removed by the CP */
588 if ((flags & IP_NEIGHBOR_FLAG_STATIC) &&
589 !(ipn->ipn_flags & IP_NEIGHBOR_FLAG_STATIC))
591 ip_neighbor_list_remove (ipn);
592 ipn->ipn_flags |= IP_NEIGHBOR_FLAG_STATIC;
593 ipn->ipn_flags &= ~IP_NEIGHBOR_FLAG_DYNAMIC;
597 * prevent a DoS attack from the data-plane that
598 * spams us with no-op updates to the MAC address
600 if (0 == mac_address_cmp (&ipn->ipn_mac, mac))
602 ip_neighbor_refresh (ipn);
603 goto check_customers;
606 mac_address_copy (&ipn->ipn_mac, mac);
610 IP_NEIGHBOR_INFO ("add: %U, %U",
611 format_vnet_sw_if_index_name, vnet_get_main (),
612 sw_if_index, format_ip_address, ip,
613 format_ip_neighbor_flags, flags, format_mac_address_t,
616 ipn = ip_neighbor_alloc (&key, mac, flags);
619 return VNET_API_ERROR_LIMIT_EXCEEDED;
622 /* Update time stamp and flags. */
623 ip_neighbor_refresh (ipn);
625 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
626 fproto, &ip_addr_46 (&ipn->ipn_key->ipnk_ip),
627 ip_neighbor_mk_complete_walk, ipn);
630 /* Customer(s) requesting event for this address? */
631 ip_neighbor_publish (ip_neighbor_get_index (ipn), IP_NEIGHBOR_EVENT_ADDED);
634 *stats_index = adj_nbr_find (fproto,
635 fib_proto_to_link (fproto),
636 &ip_addr_46 (&ipn->ipn_key->ipnk_ip),
637 ipn->ipn_key->ipnk_sw_if_index);
642 ip_neighbor_del (const ip_address_t * ip, u32 sw_if_index)
646 /* main thread only */
647 ASSERT (0 == vlib_get_thread_index ());
649 IP_NEIGHBOR_INFO ("delete: %U, %U",
650 format_vnet_sw_if_index_name, vnet_get_main (),
651 sw_if_index, format_ip_address, ip);
653 const ip_neighbor_key_t key = {
655 .ipnk_sw_if_index = sw_if_index,
658 ipn = ip_neighbor_db_find (&key);
661 return (VNET_API_ERROR_NO_SUCH_ENTRY);
663 ip_neighbor_destroy (ipn);
668 typedef struct ip_neighbor_del_all_ctx_t_
671 } ip_neighbor_del_all_ctx_t;
674 ip_neighbor_del_all_walk_cb (index_t ipni, void *arg)
676 ip_neighbor_del_all_ctx_t *ctx = arg;
678 vec_add1 (ctx->ipn_del, ipni);
680 return (WALK_CONTINUE);
684 ip_neighbor_del_all (ip_address_family_t af, u32 sw_if_index)
686 IP_NEIGHBOR_INFO ("delete-all: %U, %U",
687 format_ip_address_family, af,
688 format_vnet_sw_if_index_name, vnet_get_main (),
691 ip_neighbor_del_all_ctx_t ctx = {
696 ip_neighbor_walk (af, sw_if_index, ip_neighbor_del_all_walk_cb, &ctx);
699 ctx.ipn_del) ip_neighbor_destroy (ip_neighbor_get (*ipni));
700 vec_free (ctx.ipn_del);
704 ip_neighbor_update (vnet_main_t * vnm, adj_index_t ai)
711 ip_neighbor_key_t key = {
712 .ipnk_sw_if_index = adj->rewrite_header.sw_if_index,
715 ip_address_from_46 (&adj->sub_type.nbr.next_hop,
716 adj->ia_nh_proto, &key.ipnk_ip);
718 ipn = ip_neighbor_db_find (&key);
720 switch (adj->lookup_next_index)
722 case IP_LOOKUP_NEXT_ARP:
725 adj_nbr_walk_nh (adj->rewrite_header.sw_if_index,
727 &adj->sub_type.nbr.next_hop,
728 ip_neighbor_mk_complete_walk, ipn);
733 * no matching ARP entry.
734 * construct the rewrite required to for an ARP packet, and stick
735 * that in the adj's pipe to smoke.
737 adj_nbr_update_rewrite
739 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
740 ethernet_build_rewrite
742 adj->rewrite_header.sw_if_index,
744 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
747 * since the FIB has added this adj for a route, it makes sense it
748 * may want to forward traffic sometime soon. Let's send a
749 * speculative ARP. just one. If we were to do periodically that
750 * wouldn't be bad either, but that's more code than i'm prepared to
751 * write at this time for relatively little reward.
754 * adj_nbr_update_rewrite may actually call fib_walk_sync.
755 * fib_walk_sync may allocate a new adjacency and potentially cause
756 * a realloc for adj_pool. When that happens, adj pointer is no
757 * longer valid here.x We refresh adj pointer accordingly.
760 ip_neighbor_probe (adj);
763 case IP_LOOKUP_NEXT_REWRITE:
764 /* Update of an existing rewrite adjacency happens e.g. when the
765 * interface's MAC address changes */
767 ip_neighbor_mk_complete (ai, ipn);
769 case IP_LOOKUP_NEXT_GLEAN:
770 case IP_LOOKUP_NEXT_BCAST:
771 case IP_LOOKUP_NEXT_MCAST:
772 case IP_LOOKUP_NEXT_DROP:
773 case IP_LOOKUP_NEXT_PUNT:
774 case IP_LOOKUP_NEXT_LOCAL:
775 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
776 case IP_LOOKUP_NEXT_MIDCHAIN:
777 case IP_LOOKUP_NEXT_ICMP_ERROR:
778 case IP_LOOKUP_N_NEXT:
785 ip_neighbor_learn (const ip_neighbor_learn_t * l)
787 ip_neighbor_add (&l->ip, &l->mac, l->sw_if_index,
788 IP_NEIGHBOR_FLAG_DYNAMIC, NULL);
791 static clib_error_t *
792 ip_neighbor_cmd (vlib_main_t * vm,
793 unformat_input_t * input, vlib_cli_command_t * cmd)
795 ip_address_t ip = IP_ADDRESS_V6_ALL_0S;
796 mac_address_t mac = ZERO_MAC_ADDRESS;
797 vnet_main_t *vnm = vnet_get_main ();
798 ip_neighbor_flags_t flags;
799 u32 sw_if_index = ~0;
800 int is_add = 1, is_flush = 0;
803 flags = IP_NEIGHBOR_FLAG_DYNAMIC;
805 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
807 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
808 if (unformat (input, "%U %U %U",
809 unformat_vnet_sw_interface, vnm, &sw_if_index,
810 unformat_ip_address, &ip, unformat_mac_address_t, &mac))
812 else if (unformat (input, "delete") || unformat (input, "del"))
814 else if (unformat (input, "flush"))
816 else if (unformat (input, "static"))
818 flags |= IP_NEIGHBOR_FLAG_STATIC;
819 flags &= ~IP_NEIGHBOR_FLAG_DYNAMIC;
821 else if (unformat (input, "no-fib-entry"))
822 flags |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
823 else if (unformat (input, "count %d", &count))
831 ip_neighbor_del_all (AF_IP4, sw_if_index);
832 ip_neighbor_del_all (AF_IP6, sw_if_index);
836 if (sw_if_index == ~0 ||
837 ip_address_is_zero (&ip) || mac_address_is_zero (&mac))
838 return clib_error_return (0,
839 "specify interface, IP address and MAC: `%U'",
840 format_unformat_error, input);
845 ip_neighbor_add (&ip, &mac, sw_if_index, flags, NULL);
847 ip_neighbor_del (&ip, sw_if_index);
849 ip_address_increment (&ip);
850 mac_address_increment (&mac);
860 * Add or delete IPv4 ARP cache entries.
862 * @note 'set ip neighbor' options (e.g. delete, static,
863 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
864 * any order and combination.
868 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
869 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
870 * @cliexcmd{set ip neighbor GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
871 * @cliexcmd{set ip neighbor delete GigabitEthernet2/0/0 6.0.0.3
874 * To add or delete an IPv4 ARP cache entry
876 * @cliexcmd{set ip neighbor GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
877 * @cliexcmd{set ip neighbor delete GigabitEthernet2/0/0 6.0.0.3
880 * Add or delete IPv4 static ARP cache entries as follows:
881 * @cliexcmd{set ip neighbor static GigabitEthernet2/0/0 6.0.0.3
883 * @cliexcmd{set ip neighbor static delete GigabitEthernet2/0/0 6.0.0.3
886 * For testing / debugging purposes, the 'set ip neighbor' command can add or
887 * delete multiple entries. Supply the 'count N' parameter:
888 * @cliexcmd{set ip neighbor count 10 GigabitEthernet2/0/0 6.0.0.3
892 VLIB_CLI_COMMAND (ip_neighbor_command, static) = {
893 .path = "set ip neighbor",
894 .short_help = "set ip neighbor [del] <intfc> <ip-address> <mac-address> "
895 "[static] [no-fib-entry] [count <count>]",
896 .function = ip_neighbor_cmd,
898 VLIB_CLI_COMMAND (ip_neighbor_command2, static) = {
899 .path = "ip neighbor",
900 .short_help = "ip neighbor [del] [flush] <intfc> <ip-address> <mac-address> "
901 "[static] [no-fib-entry] [count <count>]",
902 .function = ip_neighbor_cmd,
907 ip_neighbor_sort (void *a1, void *a2)
909 index_t *ipni1 = a1, *ipni2 = a2;
910 ip_neighbor_t *ipn1, *ipn2;
913 ipn1 = ip_neighbor_get (*ipni1);
914 ipn2 = ip_neighbor_get (*ipni2);
916 cmp = vnet_sw_interface_compare (vnet_get_main (),
917 ipn1->ipn_key->ipnk_sw_if_index,
918 ipn2->ipn_key->ipnk_sw_if_index);
920 cmp = ip_address_cmp (&ipn1->ipn_key->ipnk_ip, &ipn2->ipn_key->ipnk_ip);
925 ip_neighbor_entries (u32 sw_if_index, ip_address_family_t af)
927 index_t *ipnis = NULL;
931 pool_foreach (ipn, ip_neighbor_pool)
933 if ((sw_if_index == ~0 ||
934 ipn->ipn_key->ipnk_sw_if_index == sw_if_index) &&
936 ip_neighbor_get_af(ipn) == af))
937 vec_add1 (ipnis, ip_neighbor_get_index(ipn));
943 vec_sort_with_function (ipnis, ip_neighbor_sort);
947 static clib_error_t *
948 ip_neighbor_show_sorted_i (vlib_main_t * vm,
949 unformat_input_t * input,
950 vlib_cli_command_t * cmd, ip_address_family_t af)
952 ip_neighbor_elt_t *elt, *head;
954 head = pool_elt_at_index (ip_neighbor_elt_pool, ip_neighbor_list_head[af]);
957 vlib_cli_output (vm, "%=12s%=40s%=6s%=20s%=24s", "Time", "IP",
958 "Flags", "Ethernet", "Interface");
961 /* the list is time sorted, newest first, so start from the back
962 * and work forwards. Stop when we get to one that is alive */
963 clib_llist_foreach_reverse(ip_neighbor_elt_pool,
964 ipne_anchor, head, elt,
966 vlib_cli_output (vm, "%U", format_ip_neighbor, elt->ipne_index);
973 static clib_error_t *
974 ip_neighbor_show_i (vlib_main_t * vm,
975 unformat_input_t * input,
976 vlib_cli_command_t * cmd, ip_address_family_t af)
978 index_t *ipni, *ipnis = NULL;
981 /* Filter entries by interface if given. */
983 (void) unformat_user (input, unformat_vnet_sw_interface, vnet_get_main (),
986 ipnis = ip_neighbor_entries (sw_if_index, af);
989 vlib_cli_output (vm, "%=12s%=40s%=6s%=20s%=24s", "Time", "IP",
990 "Flags", "Ethernet", "Interface");
992 vec_foreach (ipni, ipnis)
994 vlib_cli_output (vm, "%U", format_ip_neighbor, *ipni);
1001 static clib_error_t *
1002 ip_neighbor_show (vlib_main_t * vm,
1003 unformat_input_t * input, vlib_cli_command_t * cmd)
1005 return (ip_neighbor_show_i (vm, input, cmd, N_AF));
1008 static clib_error_t *
1009 ip6_neighbor_show (vlib_main_t * vm,
1010 unformat_input_t * input, vlib_cli_command_t * cmd)
1012 return (ip_neighbor_show_i (vm, input, cmd, AF_IP6));
1015 static clib_error_t *
1016 ip4_neighbor_show (vlib_main_t * vm,
1017 unformat_input_t * input, vlib_cli_command_t * cmd)
1019 return (ip_neighbor_show_i (vm, input, cmd, AF_IP4));
1022 static clib_error_t *
1023 ip6_neighbor_show_sorted (vlib_main_t * vm,
1024 unformat_input_t * input, vlib_cli_command_t * cmd)
1026 return (ip_neighbor_show_sorted_i (vm, input, cmd, AF_IP6));
1029 static clib_error_t *
1030 ip4_neighbor_show_sorted (vlib_main_t * vm,
1031 unformat_input_t * input, vlib_cli_command_t * cmd)
1033 return (ip_neighbor_show_sorted_i (vm, input, cmd, AF_IP4));
1037 * Display all the IP neighbor entries.
1040 * Example of how to display the IPv4 ARP table:
1041 * @cliexstart{show ip neighbor}
1042 * Time FIB IP4 Flags Ethernet Interface
1043 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
1044 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
1045 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
1046 * Proxy arps enabled for:
1047 * Fib_index 0 6.0.0.1 - 6.0.0.11
1051 VLIB_CLI_COMMAND (show_ip_neighbors_cmd_node, static) = {
1052 .path = "show ip neighbors",
1053 .function = ip_neighbor_show,
1054 .short_help = "show ip neighbors [interface]",
1056 VLIB_CLI_COMMAND (show_ip4_neighbors_cmd_node, static) = {
1057 .path = "show ip4 neighbors",
1058 .function = ip4_neighbor_show,
1059 .short_help = "show ip4 neighbors [interface]",
1061 VLIB_CLI_COMMAND (show_ip6_neighbors_cmd_node, static) = {
1062 .path = "show ip6 neighbors",
1063 .function = ip6_neighbor_show,
1064 .short_help = "show ip6 neighbors [interface]",
1066 VLIB_CLI_COMMAND (show_ip_neighbor_cmd_node, static) = {
1067 .path = "show ip neighbor",
1068 .function = ip_neighbor_show,
1069 .short_help = "show ip neighbor [interface]",
1071 VLIB_CLI_COMMAND (show_ip4_neighbor_cmd_node, static) = {
1072 .path = "show ip4 neighbor",
1073 .function = ip4_neighbor_show,
1074 .short_help = "show ip4 neighbor [interface]",
1076 VLIB_CLI_COMMAND (show_ip6_neighbor_cmd_node, static) = {
1077 .path = "show ip6 neighbor",
1078 .function = ip6_neighbor_show,
1079 .short_help = "show ip6 neighbor [interface]",
1081 VLIB_CLI_COMMAND (show_ip4_neighbor_sorted_cmd_node, static) = {
1082 .path = "show ip4 neighbor-sorted",
1083 .function = ip4_neighbor_show_sorted,
1084 .short_help = "show ip4 neighbor-sorted",
1086 VLIB_CLI_COMMAND (show_ip6_neighbor_sorted_cmd_node, static) = {
1087 .path = "show ip6 neighbor-sorted",
1088 .function = ip6_neighbor_show_sorted,
1089 .short_help = "show ip6 neighbor-sorted",
1093 static ip_neighbor_vft_t ip_nbr_vfts[N_AF];
1096 ip_neighbor_register (ip_address_family_t af, const ip_neighbor_vft_t * vft)
1098 ip_nbr_vfts[af] = *vft;
1102 ip_neighbor_probe_dst (u32 sw_if_index, u32 thread_index,
1103 ip_address_family_t af, const ip46_address_t *dst)
1105 if (!vnet_sw_interface_is_admin_up (vnet_get_main (), sw_if_index))
1111 ip6_neighbor_probe_dst (sw_if_index, thread_index, &dst->ip6);
1114 ip4_neighbor_probe_dst (sw_if_index, thread_index, &dst->ip4);
1120 ip_neighbor_probe (const ip_adjacency_t * adj)
1122 ip_neighbor_probe_dst (adj->rewrite_header.sw_if_index,
1123 vlib_get_thread_index (),
1124 ip_address_family_from_fib_proto (adj->ia_nh_proto),
1125 &adj->sub_type.nbr.next_hop);
1129 ip_neighbor_walk (ip_address_family_t af,
1130 u32 sw_if_index, ip_neighbor_walk_cb_t cb, void *ctx)
1132 ip_neighbor_key_t *key;
1135 if (~0 == sw_if_index)
1139 vec_foreach (hash, ip_neighbor_db[af].ipndb_hash)
1142 hash_foreach (key, ipni, *hash,
1144 if (WALK_STOP == cb (ipni, ctx))
1154 if (vec_len (ip_neighbor_db[af].ipndb_hash) <= sw_if_index)
1156 hash = ip_neighbor_db[af].ipndb_hash[sw_if_index];
1159 hash_foreach (key, ipni, hash,
1161 if (WALK_STOP == cb (ipni, ctx))
1169 ip4_neighbor_proxy_add (u32 fib_index,
1170 const ip4_address_t * start,
1171 const ip4_address_t * end)
1173 if (ip_nbr_vfts[AF_IP4].inv_proxy4_add)
1175 return (ip_nbr_vfts[AF_IP4].inv_proxy4_add (fib_index, start, end));
1182 ip4_neighbor_proxy_delete (u32 fib_index,
1183 const ip4_address_t * start,
1184 const ip4_address_t * end)
1186 if (ip_nbr_vfts[AF_IP4].inv_proxy4_del)
1188 return (ip_nbr_vfts[AF_IP4].inv_proxy4_del (fib_index, start, end));
1194 ip4_neighbor_proxy_enable (u32 sw_if_index)
1196 if (ip_nbr_vfts[AF_IP4].inv_proxy4_enable)
1198 return (ip_nbr_vfts[AF_IP4].inv_proxy4_enable (sw_if_index));
1204 ip4_neighbor_proxy_disable (u32 sw_if_index)
1206 if (ip_nbr_vfts[AF_IP4].inv_proxy4_disable)
1208 return (ip_nbr_vfts[AF_IP4].inv_proxy4_disable (sw_if_index));
1214 ip6_neighbor_proxy_add (u32 sw_if_index, const ip6_address_t * addr)
1216 if (ip_nbr_vfts[AF_IP6].inv_proxy6_add)
1218 return (ip_nbr_vfts[AF_IP6].inv_proxy6_add (sw_if_index, addr));
1224 ip6_neighbor_proxy_del (u32 sw_if_index, const ip6_address_t * addr)
1226 if (ip_nbr_vfts[AF_IP6].inv_proxy6_del)
1228 return (ip_nbr_vfts[AF_IP6].inv_proxy6_del (sw_if_index, addr));
1234 ip_neighbor_populate (ip_address_family_t af, u32 sw_if_index)
1236 index_t *ipnis = NULL, *ipni;
1239 IP_NEIGHBOR_DBG ("populate: %U %U",
1240 format_vnet_sw_if_index_name, vnet_get_main (),
1241 sw_if_index, format_ip_address_family, af);
1244 pool_foreach (ipn, ip_neighbor_pool)
1246 if (ip_neighbor_get_af(ipn) == af &&
1247 ipn->ipn_key->ipnk_sw_if_index == sw_if_index)
1248 vec_add1 (ipnis, ipn - ip_neighbor_pool);
1252 vec_foreach (ipni, ipnis)
1254 ipn = ip_neighbor_get (*ipni);
1256 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
1257 ip_address_family_to_fib_proto (ip_neighbor_get_af
1259 &ip_addr_46 (&ipn->ipn_key->ipnk_ip),
1260 ip_neighbor_mk_complete_walk, ipn);
1266 ip_neighbor_flush (ip_address_family_t af, u32 sw_if_index)
1268 index_t *ipnis = NULL, *ipni;
1272 IP_NEIGHBOR_DBG ("flush: %U %U",
1273 format_vnet_sw_if_index_name, vnet_get_main (),
1274 sw_if_index, format_ip_address_family, af);
1277 pool_foreach (ipn, ip_neighbor_pool)
1279 if (ip_neighbor_get_af(ipn) == af &&
1280 ipn->ipn_key->ipnk_sw_if_index == sw_if_index &&
1281 ip_neighbor_is_dynamic (ipn))
1282 vec_add1 (ipnis, ipn - ip_neighbor_pool);
1286 vec_foreach (ipni, ipnis) ip_neighbor_destroy (ip_neighbor_get (*ipni));
1291 ip_neighbor_mark_one (index_t ipni, void *ctx)
1295 ipn = ip_neighbor_get (ipni);
1297 ipn->ipn_flags |= IP_NEIGHBOR_FLAG_STALE;
1299 return (WALK_CONTINUE);
1303 ip_neighbor_mark (ip_address_family_t af)
1305 ip_neighbor_walk (af, ~0, ip_neighbor_mark_one, NULL);
1308 typedef struct ip_neighbor_sweep_ctx_t_
1310 index_t *ipnsc_stale;
1311 } ip_neighbor_sweep_ctx_t;
1314 ip_neighbor_sweep_one (index_t ipni, void *arg)
1316 ip_neighbor_sweep_ctx_t *ctx = arg;
1319 ipn = ip_neighbor_get (ipni);
1321 if (ipn->ipn_flags & IP_NEIGHBOR_FLAG_STALE)
1323 vec_add1 (ctx->ipnsc_stale, ipni);
1326 return (WALK_CONTINUE);
1330 ip_neighbor_sweep (ip_address_family_t af)
1332 ip_neighbor_sweep_ctx_t ctx = { };
1335 ip_neighbor_walk (af, ~0, ip_neighbor_sweep_one, &ctx);
1337 vec_foreach (ipni, ctx.ipnsc_stale)
1339 ip_neighbor_destroy (ip_neighbor_get (*ipni));
1341 vec_free (ctx.ipnsc_stale);
1345 * Remove any arp entries associated with the specified interface
1347 static clib_error_t *
1348 ip_neighbor_interface_admin_change (vnet_main_t * vnm,
1349 u32 sw_if_index, u32 flags)
1351 ip_address_family_t af;
1353 IP_NEIGHBOR_DBG ("interface-admin: %U %s",
1354 format_vnet_sw_if_index_name, vnet_get_main (),
1356 (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ? "up" : "down"));
1358 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1360 FOR_EACH_IP_ADDRESS_FAMILY (af) ip_neighbor_populate (af, sw_if_index);
1364 /* admin down, flush all neighbours */
1365 FOR_EACH_IP_ADDRESS_FAMILY (af) ip_neighbor_flush (af, sw_if_index);
1371 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ip_neighbor_interface_admin_change);
1374 * Remove any arp entries associated with the specified interface
1376 static clib_error_t *
1377 ip_neighbor_add_del_sw_interface (vnet_main_t *vnm, u32 sw_if_index,
1380 IP_NEIGHBOR_DBG ("interface-change: %U %s",
1381 format_vnet_sw_if_index_name, vnet_get_main (),
1382 sw_if_index, (is_add ? "add" : "del"));
1384 if (!is_add && sw_if_index != ~0)
1386 ip_address_family_t af;
1388 FOR_EACH_IP_ADDRESS_FAMILY (af) ip_neighbor_flush (af, sw_if_index);
1393 ip_neighbor_alloc_ctr (&ip_neighbor_counters[AF_IP4], sw_if_index);
1394 ip_neighbor_alloc_ctr (&ip_neighbor_counters[AF_IP6], sw_if_index);
1400 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_neighbor_add_del_sw_interface);
1402 typedef struct ip_neighbor_walk_covered_ctx_t_
1407 } ip_neighbor_walk_covered_ctx_t;
1410 ip_neighbor_walk_covered (index_t ipni, void *arg)
1412 ip_neighbor_walk_covered_ctx_t *ctx = arg;
1415 ipn = ip_neighbor_get (ipni);
1417 if (AF_IP4 == ip_addr_version (&ctx->addr))
1419 if (ip4_destination_matches_route (&ip4_main,
1420 &ip_addr_v4 (&ipn->ipn_key->ipnk_ip),
1421 &ip_addr_v4 (&ctx->addr),
1423 ip_neighbor_is_dynamic (ipn))
1425 vec_add1 (ctx->ipnis, ip_neighbor_get_index (ipn));
1428 else if (AF_IP6 == ip_addr_version (&ctx->addr))
1430 if (ip6_destination_matches_route (&ip6_main,
1431 &ip_addr_v6 (&ipn->ipn_key->ipnk_ip),
1432 &ip_addr_v6 (&ctx->addr),
1434 ip_neighbor_is_dynamic (ipn))
1436 vec_add1 (ctx->ipnis, ip_neighbor_get_index (ipn));
1439 return (WALK_CONTINUE);
1444 * callback when an interface address is added or deleted
1447 ip_neighbor_add_del_interface_address_v4 (ip4_main_t * im,
1450 ip4_address_t * address,
1452 u32 if_address_index, u32 is_del)
1455 * Flush the ARP cache of all entries covered by the address
1456 * that is being removed.
1458 IP_NEIGHBOR_DBG ("addr-%s: %U, %U/%d", (is_del ? "del" : "add"),
1459 format_vnet_sw_if_index_name, vnet_get_main (), sw_if_index,
1460 format_ip4_address, address, address_length);
1465 ip_neighbor_walk_covered_ctx_t ctx = {
1470 .length = address_length,
1475 ip_neighbor_walk (AF_IP4, sw_if_index, ip_neighbor_walk_covered, &ctx);
1477 vec_foreach (ipni, ctx.ipnis)
1478 ip_neighbor_destroy (ip_neighbor_get (*ipni));
1480 vec_free (ctx.ipnis);
1485 * callback when an interface address is added or deleted
1488 ip_neighbor_add_del_interface_address_v6 (ip6_main_t * im,
1491 ip6_address_t * address,
1493 u32 if_address_index, u32 is_del)
1496 * Flush the ARP cache of all entries covered by the address
1497 * that is being removed.
1499 IP_NEIGHBOR_DBG ("addr-change: %U, %U/%d %s",
1500 format_vnet_sw_if_index_name, vnet_get_main (),
1501 sw_if_index, format_ip6_address, address, address_length,
1502 (is_del ? "del" : "add"));
1507 ip_neighbor_walk_covered_ctx_t ctx = {
1512 .length = address_length,
1517 ip_neighbor_walk (AF_IP6, sw_if_index, ip_neighbor_walk_covered, &ctx);
1519 vec_foreach (ipni, ctx.ipnis)
1520 ip_neighbor_destroy (ip_neighbor_get (*ipni));
1522 vec_free (ctx.ipnis);
1526 typedef struct ip_neighbor_table_bind_ctx_t_
1530 } ip_neighbor_table_bind_ctx_t;
1533 ip_neighbor_walk_table_bind (index_t ipni, void *arg)
1535 ip_neighbor_table_bind_ctx_t *ctx = arg;
1538 ipn = ip_neighbor_get (ipni);
1539 ip_neighbor_adj_fib_remove (ipn, ctx->old_fib_index);
1540 ip_neighbor_adj_fib_add (ipn, ctx->new_fib_index);
1542 return (WALK_CONTINUE);
1546 ip_neighbor_table_bind_v4 (ip4_main_t * im,
1549 u32 new_fib_index, u32 old_fib_index)
1551 ip_neighbor_table_bind_ctx_t ctx = {
1552 .old_fib_index = old_fib_index,
1553 .new_fib_index = new_fib_index,
1556 ip_neighbor_walk (AF_IP4, sw_if_index, ip_neighbor_walk_table_bind, &ctx);
1560 ip_neighbor_table_bind_v6 (ip6_main_t * im,
1563 u32 new_fib_index, u32 old_fib_index)
1565 ip_neighbor_table_bind_ctx_t ctx = {
1566 .old_fib_index = old_fib_index,
1567 .new_fib_index = new_fib_index,
1570 ip_neighbor_walk (AF_IP6, sw_if_index, ip_neighbor_walk_table_bind, &ctx);
1573 typedef enum ip_neighbor_age_state_t_
1575 IP_NEIGHBOR_AGE_ALIVE,
1576 IP_NEIGHBOR_AGE_PROBE,
1577 IP_NEIGHBOR_AGE_DEAD,
1578 } ip_neighbor_age_state_t;
1580 #define IP_NEIGHBOR_PROCESS_SLEEP_LONG (0)
1582 static ip_neighbor_age_state_t
1583 ip_neighbour_age_out (index_t ipni, f64 now, f64 * wait)
1585 ip_address_family_t af;
1590 ipn = ip_neighbor_get (ipni);
1591 af = ip_neighbor_get_af (ipn);
1592 ipndb_age = ip_neighbor_db[af].ipndb_age;
1593 ttl = now - ipn->ipn_time_last_updated;
1596 if (ttl > ipndb_age)
1598 IP_NEIGHBOR_DBG ("aged: %U @%f - %f > %d",
1599 format_ip_neighbor, ipni, now,
1600 ipn->ipn_time_last_updated, ipndb_age);
1601 if (ipn->ipn_n_probes > 2)
1603 /* 3 strikes and yea-re out */
1604 IP_NEIGHBOR_DBG ("dead: %U", format_ip_neighbor, ipni);
1606 return (IP_NEIGHBOR_AGE_DEAD);
1610 ip_neighbor_probe_dst (ip_neighbor_get_sw_if_index (ipn),
1611 vlib_get_thread_index (), af,
1612 &ip_addr_46 (&ipn->ipn_key->ipnk_ip));
1614 ipn->ipn_n_probes++;
1620 /* here we are sure that ttl <= ipndb_age */
1621 *wait = ipndb_age - ttl + 1;
1622 return (IP_NEIGHBOR_AGE_ALIVE);
1625 return (IP_NEIGHBOR_AGE_PROBE);
1628 typedef enum ip_neighbor_process_event_t_
1630 IP_NEIGHBOR_AGE_PROCESS_WAKEUP,
1631 } ip_neighbor_process_event_t;
1634 ip_neighbor_age_loop (vlib_main_t * vm,
1635 vlib_node_runtime_t * rt,
1636 vlib_frame_t * f, ip_address_family_t af)
1638 uword event_type, *event_data = NULL;
1641 /* Set the timeout to an effectively infinite value when the process starts */
1642 timeout = IP_NEIGHBOR_PROCESS_SLEEP_LONG;
1649 vlib_process_wait_for_event (vm);
1651 vlib_process_wait_for_event_or_clock (vm, timeout);
1653 event_type = vlib_process_get_events (vm, &event_data);
1654 vec_reset_length (event_data);
1656 now = vlib_time_now (vm);
1663 ip_neighbor_elt_t *elt, *head;
1666 timeout = ip_neighbor_db[af].ipndb_age;
1667 head = pool_elt_at_index (ip_neighbor_elt_pool,
1668 ip_neighbor_list_head[af]);
1671 /* the list is time sorted, newest first, so start from the back
1672 * and work forwards. Stop when we get to one that is alive */
1674 clib_llist_foreach_reverse(ip_neighbor_elt_pool,
1675 ipne_anchor, head, elt,
1677 ip_neighbor_age_state_t res;
1679 res = ip_neighbour_age_out(elt->ipne_index, now, &wait);
1681 if (IP_NEIGHBOR_AGE_ALIVE == res) {
1682 /* the oldest neighbor has not yet expired, go back to sleep */
1683 timeout = clib_min (wait, timeout);
1686 else if (IP_NEIGHBOR_AGE_DEAD == res) {
1687 /* the oldest neighbor is dead, pop it, then restart the walk
1688 * again from the back */
1689 ip_neighbor_destroy (ip_neighbor_get(elt->ipne_index));
1693 timeout = clib_min (wait, timeout);
1698 case IP_NEIGHBOR_AGE_PROCESS_WAKEUP:
1701 if (!ip_neighbor_db[af].ipndb_age)
1703 /* aging has been disabled */
1707 ip_neighbor_elt_t *elt, *head;
1709 head = pool_elt_at_index (ip_neighbor_elt_pool,
1710 ip_neighbor_list_head[af]);
1711 /* no neighbors yet */
1712 if (clib_llist_is_empty (ip_neighbor_elt_pool, ipne_anchor, head))
1714 timeout = ip_neighbor_db[af].ipndb_age;
1718 /* poke the oldset neighbour for aging, which returns how long we sleep for */
1719 elt = clib_llist_prev (ip_neighbor_elt_pool, ipne_anchor, head);
1720 ip_neighbour_age_out (elt->ipne_index, now, &timeout);
1729 ip4_neighbor_age_process (vlib_main_t * vm,
1730 vlib_node_runtime_t * rt, vlib_frame_t * f)
1732 return (ip_neighbor_age_loop (vm, rt, f, AF_IP4));
1736 ip6_neighbor_age_process (vlib_main_t * vm,
1737 vlib_node_runtime_t * rt, vlib_frame_t * f)
1739 return (ip_neighbor_age_loop (vm, rt, f, AF_IP6));
1743 VLIB_REGISTER_NODE (ip4_neighbor_age_process_node,static) = {
1744 .function = ip4_neighbor_age_process,
1745 .type = VLIB_NODE_TYPE_PROCESS,
1746 .name = "ip4-neighbor-age-process",
1748 VLIB_REGISTER_NODE (ip6_neighbor_age_process_node,static) = {
1749 .function = ip6_neighbor_age_process,
1750 .type = VLIB_NODE_TYPE_PROCESS,
1751 .name = "ip6-neighbor-age-process",
1756 ip_neighbor_config (ip_address_family_t af, u32 limit, u32 age, bool recycle)
1758 ip_neighbor_db[af].ipndb_limit = limit;
1759 ip_neighbor_db[af].ipndb_recycle = recycle;
1760 ip_neighbor_db[af].ipndb_age = age;
1762 vlib_process_signal_event (vlib_get_main (),
1764 ip4_neighbor_age_process_node.index :
1765 ip6_neighbor_age_process_node.index),
1766 IP_NEIGHBOR_AGE_PROCESS_WAKEUP, 0);
1772 ip_neighbor_get_config (ip_address_family_t af, u32 *limit, u32 *age,
1775 *limit = ip_neighbor_db[af].ipndb_limit;
1776 *age = ip_neighbor_db[af].ipndb_age;
1777 *recycle = ip_neighbor_db[af].ipndb_recycle;
1782 static clib_error_t *
1783 ip_neighbor_config_show (vlib_main_t * vm,
1784 unformat_input_t * input, vlib_cli_command_t * cmd)
1786 ip_address_family_t af;
1789 FOR_EACH_IP_ADDRESS_FAMILY(af) {
1790 vlib_cli_output (vm, "%U:", format_ip_address_family, af);
1791 vlib_cli_output (vm, " limit:%d, age:%d, recycle:%d",
1792 ip_neighbor_db[af].ipndb_limit,
1793 ip_neighbor_db[af].ipndb_age,
1794 ip_neighbor_db[af].ipndb_recycle);
1801 static clib_error_t *
1802 ip_neighbor_config_set (vlib_main_t *vm, unformat_input_t *input,
1803 vlib_cli_command_t *cmd)
1805 unformat_input_t _line_input, *line_input = &_line_input;
1806 clib_error_t *error = NULL;
1807 ip_address_family_t af;
1811 if (!unformat_user (input, unformat_line_input, line_input))
1814 if (!unformat (line_input, "%U", unformat_ip_address_family, &af))
1816 error = unformat_parse_error (line_input);
1820 limit = ip_neighbor_db[af].ipndb_limit;
1821 age = ip_neighbor_db[af].ipndb_age;
1822 recycle = ip_neighbor_db[af].ipndb_recycle;
1824 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1826 if (unformat (line_input, "limit %u", &limit))
1828 else if (unformat (line_input, "age %u", &age))
1830 else if (unformat (line_input, "recycle"))
1832 else if (unformat (line_input, "norecycle"))
1836 error = unformat_parse_error (line_input);
1841 ip_neighbor_config (af, limit, age, recycle);
1844 unformat_free (line_input);
1849 ip_neighbor_stats_show_one (vlib_main_t *vm, vnet_main_t *vnm, u32 sw_if_index)
1851 vlib_cli_output (vm, " %U", format_vnet_sw_if_index_name, vnm, sw_if_index);
1852 vlib_cli_output (vm, " arp:%U", format_ip_neighbor_counters,
1853 &ip_neighbor_counters[AF_IP4], sw_if_index);
1854 vlib_cli_output (vm, " nd: %U", format_ip_neighbor_counters,
1855 &ip_neighbor_counters[AF_IP6], sw_if_index);
1859 ip_neighbor_stats_show_cb (vnet_main_t *vnm, vnet_sw_interface_t *si,
1862 ip_neighbor_stats_show_one (ctx, vnm, si->sw_if_index);
1864 return (WALK_CONTINUE);
1867 static clib_error_t *
1868 ip_neighbor_stats_show (vlib_main_t *vm, unformat_input_t *input,
1869 vlib_cli_command_t *cmd)
1874 vnm = vnet_get_main ();
1876 (void) unformat_user (input, unformat_vnet_sw_interface, vnm, &sw_if_index);
1878 if (~0 == sw_if_index)
1880 vnet_sw_interface_walk (vnm, ip_neighbor_stats_show_cb, vm);
1884 ip_neighbor_stats_show_one (vm, vnm, sw_if_index);
1890 VLIB_CLI_COMMAND (show_ip_neighbor_cfg_cmd_node, static) = {
1891 .path = "show ip neighbor-config",
1892 .function = ip_neighbor_config_show,
1893 .short_help = "show ip neighbor-config",
1895 VLIB_CLI_COMMAND (set_ip_neighbor_cfg_cmd_node, static) = {
1896 .path = "set ip neighbor-config",
1897 .function = ip_neighbor_config_set,
1898 .short_help = "set ip neighbor-config ip4|ip6 [limit <limit>] [age <age>] "
1899 "[recycle|norecycle]",
1901 VLIB_CLI_COMMAND (show_ip_neighbor_stats_cmd_node, static) = {
1902 .path = "show ip neighbor-stats",
1903 .function = ip_neighbor_stats_show,
1904 .short_help = "show ip neighbor-stats [interface]",
1908 static clib_error_t *
1909 ip_neighbor_init (vlib_main_t * vm)
1912 ip4_add_del_interface_address_callback_t cb = {
1913 .function = ip_neighbor_add_del_interface_address_v4,
1915 vec_add1 (ip4_main.add_del_interface_address_callbacks, cb);
1918 ip6_add_del_interface_address_callback_t cb = {
1919 .function = ip_neighbor_add_del_interface_address_v6,
1921 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
1924 ip4_table_bind_callback_t cb = {
1925 .function = ip_neighbor_table_bind_v4,
1927 vec_add1 (ip4_main.table_bind_callbacks, cb);
1930 ip6_table_bind_callback_t cb = {
1931 .function = ip_neighbor_table_bind_v6,
1933 vec_add1 (ip6_main.table_bind_callbacks, cb);
1935 ipn_logger = vlib_log_register_class ("ip", "neighbor");
1937 ip_address_family_t af;
1939 FOR_EACH_IP_ADDRESS_FAMILY (af)
1940 ip_neighbor_list_head[af] =
1941 clib_llist_make_head (ip_neighbor_elt_pool, ipne_anchor);
1947 VLIB_INIT_FUNCTION (ip_neighbor_init) =
1949 .runs_after = VLIB_INITS("ip_main_init"),
1954 * fd.io coding-style-patch-verification: ON
1957 * eval: (c-set-style "gnu")