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/fib/fib_table.h>
27 #include <vnet/adj/adj_mcast.h>
29 /** Pool for All IP neighbors */
30 static ip_neighbor_t *ip_neighbor_pool;
32 /** protocol specific lists of time sorted neighbors */
33 index_t ip_neighbor_list_head[IP46_N_TYPES];
35 typedef struct ip_neighbor_elt_t_
37 clib_llist_anchor_t ipne_anchor;
41 /** Pool of linked list elemeents */
42 ip_neighbor_elt_t *ip_neighbor_elt_pool;
44 typedef struct ip_neighbor_db_t_
46 /** per interface hash */
48 /** per-protocol limit - max number of neighbors*/
50 /** max age of a neighbor before it's forcibly evicted */
52 /** when the limit is reached and new neighbors are created, should
53 * we recycle an old one */
55 /** per-protocol number of elements */
57 /** per-protocol number of elements per-fib-index*/
58 u32 *ipndb_n_elts_per_fib;
61 static vlib_log_class_t ipn_logger;
63 /* DBs of neighbours one per AF */
65 static ip_neighbor_db_t ip_neighbor_db[IP46_N_TYPES] = {
68 /* Default to not aging and not recycling */
70 .ipndb_recycle = false,
74 /* Default to not aging and not recycling */
76 .ipndb_recycle = false,
81 #define IP_NEIGHBOR_DBG(...) \
82 vlib_log_debug (ipn_logger, __VA_ARGS__);
84 #define IP_NEIGHBOR_INFO(...) \
85 vlib_log_notice (ipn_logger, __VA_ARGS__);
88 ip_neighbor_get (index_t ipni)
90 if (pool_is_free_index (ip_neighbor_pool, ipni))
93 return (pool_elt_at_index (ip_neighbor_pool, ipni));
97 ip_neighbor_get_index (const ip_neighbor_t * ipn)
99 return (ipn - ip_neighbor_pool);
103 ip_neighbor_touch (ip_neighbor_t * ipn)
105 ipn->ipn_flags &= ~IP_NEIGHBOR_FLAG_STALE;
109 ip_neighbor_is_dynamic (const ip_neighbor_t * ipn)
111 return (ipn->ipn_flags & IP_NEIGHBOR_FLAG_DYNAMIC);
114 const ip46_address_t *
115 ip_neighbor_get_ip (const ip_neighbor_t * ipn)
117 return (&ipn->ipn_key->ipnk_ip);
120 const mac_address_t *
121 ip_neighbor_get_mac (const ip_neighbor_t * ipn)
123 return (&ipn->ipn_mac);
127 ip_neighbor_get_sw_if_index (const ip_neighbor_t * ipn)
129 return (ipn->ipn_key->ipnk_sw_if_index);
133 ip_neighbor_list_remove (ip_neighbor_t * ipn)
135 /* new neighbours, are added to the head of the list, since the
136 * list is time sorted, newest first */
137 ip_neighbor_elt_t *elt;
139 if (~0 != ipn->ipn_elt)
141 elt = pool_elt_at_index (ip_neighbor_elt_pool, ipn->ipn_elt);
143 clib_llist_remove (ip_neighbor_elt_pool, ipne_anchor, elt);
148 ip_neighbor_refresh (ip_neighbor_t * ipn)
150 /* new neighbours, are added to the head of the list, since the
151 * list is time sorted, newest first */
152 ip_neighbor_elt_t *elt, *head;
154 ip_neighbor_touch (ipn);
155 ipn->ipn_time_last_updated = vlib_time_now (vlib_get_main ());
156 ipn->ipn_n_probes = 0;
158 if (ip_neighbor_is_dynamic (ipn))
160 if (~0 == ipn->ipn_elt)
161 /* first time insertion */
162 pool_get_zero (ip_neighbor_elt_pool, elt);
165 /* already inserted - extract first */
166 elt = pool_elt_at_index (ip_neighbor_elt_pool, ipn->ipn_elt);
168 clib_llist_remove (ip_neighbor_elt_pool, ipne_anchor, elt);
170 head = pool_elt_at_index (ip_neighbor_elt_pool,
171 ip_neighbor_list_head[ipn->
172 ipn_key->ipnk_type]);
174 elt->ipne_index = ip_neighbor_get_index (ipn);
175 clib_llist_add (ip_neighbor_elt_pool, ipne_anchor, elt, head);
176 ipn->ipn_elt = elt - ip_neighbor_elt_pool;
181 ip_neighbor_db_add (const ip_neighbor_t * ipn)
183 vec_validate (ip_neighbor_db[ipn->ipn_key->ipnk_type].ipndb_hash,
184 ipn->ipn_key->ipnk_sw_if_index);
186 if (!ip_neighbor_db[ipn->ipn_key->ipnk_type].ipndb_hash
187 [ipn->ipn_key->ipnk_sw_if_index])
188 ip_neighbor_db[ipn->ipn_key->ipnk_type].ipndb_hash[ipn->
189 ipn_key->ipnk_sw_if_index]
190 = hash_create_mem (0, sizeof (ip_neighbor_key_t), sizeof (index_t));
192 hash_set_mem (ip_neighbor_db[ipn->ipn_key->ipnk_type].ipndb_hash
193 [ipn->ipn_key->ipnk_sw_if_index], ipn->ipn_key,
194 ip_neighbor_get_index (ipn));
196 ip_neighbor_db[ipn->ipn_key->ipnk_type].ipndb_n_elts++;
200 ip_neighbor_db_remove (const ip_neighbor_key_t * key)
202 vec_validate (ip_neighbor_db[key->ipnk_type].ipndb_hash,
203 key->ipnk_sw_if_index);
205 hash_unset_mem (ip_neighbor_db[key->ipnk_type].ipndb_hash
206 [key->ipnk_sw_if_index], key);
208 ip_neighbor_db[key->ipnk_type].ipndb_n_elts--;
211 static ip_neighbor_t *
212 ip_neighbor_db_find (const ip_neighbor_key_t * key)
216 if (key->ipnk_sw_if_index >=
217 vec_len (ip_neighbor_db[key->ipnk_type].ipndb_hash))
221 hash_get_mem (ip_neighbor_db[key->ipnk_type].ipndb_hash
222 [key->ipnk_sw_if_index], key);
225 return ip_neighbor_get (p[0]);
231 ip46_type_pfx_len (ip46_type_t type)
233 return (type == IP46_TYPE_IP4 ? 32 : 128);
237 ip_neighbor_adj_fib_add (ip_neighbor_t * ipn, u32 fib_index)
239 if (ipn->ipn_key->ipnk_type == IP46_TYPE_IP6 &&
240 ip6_address_is_link_local_unicast (&ipn->ipn_key->ipnk_ip.ip6))
242 ip6_ll_prefix_t pfx = {
243 .ilp_addr = ipn->ipn_key->ipnk_ip.ip6,
244 .ilp_sw_if_index = ipn->ipn_key->ipnk_sw_if_index,
246 ipn->ipn_fib_entry_index =
247 ip6_ll_table_entry_update (&pfx, FIB_ROUTE_PATH_FLAG_NONE);
251 fib_protocol_t fproto;
253 fproto = fib_proto_from_ip46 (ipn->ipn_key->ipnk_type);
256 .fp_len = ip46_type_pfx_len (ipn->ipn_key->ipnk_type),
258 .fp_addr = ipn->ipn_key->ipnk_ip,
261 ipn->ipn_fib_entry_index =
262 fib_table_entry_path_add (fib_index, &pfx, FIB_SOURCE_ADJ,
263 FIB_ENTRY_FLAG_ATTACHED,
264 fib_proto_to_dpo (fproto),
266 ipn->ipn_key->ipnk_sw_if_index,
267 ~0, 1, NULL, FIB_ROUTE_PATH_FLAG_NONE);
269 vec_validate (ip_neighbor_db
270 [ipn->ipn_key->ipnk_type].ipndb_n_elts_per_fib,
273 ip_neighbor_db[ipn->ipn_key->
274 ipnk_type].ipndb_n_elts_per_fib[fib_index]++;
277 ip_neighbor_db[ipn->ipn_key->
278 ipnk_type].ipndb_n_elts_per_fib[fib_index])
279 fib_table_lock (fib_index, fproto, FIB_SOURCE_ADJ);
284 ip_neighbor_adj_fib_remove (ip_neighbor_t * ipn, u32 fib_index)
286 if (FIB_NODE_INDEX_INVALID != ipn->ipn_fib_entry_index)
288 if (ipn->ipn_key->ipnk_type == IP46_TYPE_IP6 &&
289 ip6_address_is_link_local_unicast (&ipn->ipn_key->ipnk_ip.ip6))
291 ip6_ll_prefix_t pfx = {
292 .ilp_addr = ipn->ipn_key->ipnk_ip.ip6,
293 .ilp_sw_if_index = ipn->ipn_key->ipnk_sw_if_index,
295 ip6_ll_table_entry_delete (&pfx);
299 fib_protocol_t fproto;
301 fproto = fib_proto_from_ip46 (ipn->ipn_key->ipnk_type);
304 .fp_len = ip46_type_pfx_len (ipn->ipn_key->ipnk_type),
306 .fp_addr = ipn->ipn_key->ipnk_ip,
309 fib_table_entry_path_remove (fib_index,
312 fib_proto_to_dpo (fproto),
314 ipn->ipn_key->ipnk_sw_if_index,
315 ~0, 1, FIB_ROUTE_PATH_FLAG_NONE);
317 ip_neighbor_db[ipn->ipn_key->
318 ipnk_type].ipndb_n_elts_per_fib[fib_index]--;
321 ip_neighbor_db[ipn->ipn_key->
322 ipnk_type].ipndb_n_elts_per_fib[fib_index])
323 fib_table_unlock (fib_index, fproto, FIB_SOURCE_ADJ);
329 ip_neighbor_mk_complete (adj_index_t ai, ip_neighbor_t * ipn)
331 adj_nbr_update_rewrite (ai, ADJ_NBR_REWRITE_FLAG_COMPLETE,
332 ethernet_build_rewrite (vnet_get_main (),
334 ipn_key->ipnk_sw_if_index,
335 adj_get_link_type (ai),
336 ipn->ipn_mac.bytes));
340 ip_neighbor_mk_incomplete (adj_index_t ai)
342 ip_adjacency_t *adj = adj_get (ai);
344 adj_nbr_update_rewrite (ai,
345 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
346 ethernet_build_rewrite (vnet_get_main (),
348 rewrite_header.sw_if_index,
350 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
354 ip_neighbor_mk_complete_walk (adj_index_t ai, void *ctx)
356 ip_neighbor_t *ipn = ctx;
358 ip_neighbor_mk_complete (ai, ipn);
360 return (ADJ_WALK_RC_CONTINUE);
364 ip_neighbor_mk_incomplete_walk (adj_index_t ai, void *ctx)
366 ip_neighbor_mk_incomplete (ai);
368 return (ADJ_WALK_RC_CONTINUE);
372 ip_neighbor_free (ip_neighbor_t * ipn)
374 IP_NEIGHBOR_DBG ("free: %U", format_ip_neighbor,
375 ip_neighbor_get_index (ipn));
377 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
378 fib_proto_from_ip46 (ipn->ipn_key->ipnk_type),
379 &ipn->ipn_key->ipnk_ip,
380 ip_neighbor_mk_incomplete_walk, ipn);
381 ip_neighbor_adj_fib_remove
383 fib_table_get_index_for_sw_if_index
384 (fib_proto_from_ip46 (ipn->ipn_key->ipnk_type),
385 ipn->ipn_key->ipnk_sw_if_index));
387 ip_neighbor_list_remove (ipn);
388 ip_neighbor_db_remove (ipn->ipn_key);
389 clib_mem_free (ipn->ipn_key);
391 pool_put (ip_neighbor_pool, ipn);
395 ip_neighbor_force_reuse (ip46_type_t type)
397 if (!ip_neighbor_db[type].ipndb_recycle)
400 /* pluck the oldest entry, which is the one from the end of the list */
401 ip_neighbor_elt_t *elt, *head;
404 pool_elt_at_index (ip_neighbor_elt_pool, ip_neighbor_list_head[type]);
406 if (clib_llist_is_empty (ip_neighbor_elt_pool, ipne_anchor, head))
409 elt = clib_llist_prev (ip_neighbor_elt_pool, ipne_anchor, head);
410 ip_neighbor_free (ip_neighbor_get (elt->ipne_index));
415 static ip_neighbor_t *
416 ip_neighbor_alloc (const ip_neighbor_key_t * key,
417 const mac_address_t * mac, ip_neighbor_flags_t flags)
421 if (ip_neighbor_db[key->ipnk_type].ipndb_limit &&
422 (ip_neighbor_db[key->ipnk_type].ipndb_n_elts >=
423 ip_neighbor_db[key->ipnk_type].ipndb_limit))
425 if (!ip_neighbor_force_reuse (key->ipnk_type))
429 pool_get_zero (ip_neighbor_pool, ipn);
431 ipn->ipn_key = clib_mem_alloc (sizeof (*ipn->ipn_key));
432 clib_memcpy (ipn->ipn_key, key, sizeof (*ipn->ipn_key));
434 ipn->ipn_fib_entry_index = FIB_NODE_INDEX_INVALID;
435 ipn->ipn_flags = flags;
438 mac_address_copy (&ipn->ipn_mac, mac);
440 ip_neighbor_db_add (ipn);
442 /* create the adj-fib. the entry in the FIB table for the peer's interface */
443 if (!(ipn->ipn_flags & IP_NEIGHBOR_FLAG_NO_FIB_ENTRY))
444 ip_neighbor_adj_fib_add
445 (ipn, fib_table_get_index_for_sw_if_index
446 (fib_proto_from_ip46 (ipn->ipn_key->ipnk_type),
447 ipn->ipn_key->ipnk_sw_if_index));
453 ip_neighbor_add (const ip46_address_t * ip,
455 const mac_address_t * mac,
457 ip_neighbor_flags_t flags, u32 * stats_index)
459 fib_protocol_t fproto;
462 /* main thread only */
463 ASSERT (0 == vlib_get_thread_index ());
465 fproto = fib_proto_from_ip46 (type);
467 const ip_neighbor_key_t key = {
469 .ipnk_sw_if_index = sw_if_index,
473 ipn = ip_neighbor_db_find (&key);
477 IP_NEIGHBOR_DBG ("update: %U, %U",
478 format_vnet_sw_if_index_name, vnet_get_main (),
479 sw_if_index, format_ip46_address, ip, type,
480 format_ip_neighbor_flags, flags, format_mac_address_t,
483 ip_neighbor_touch (ipn);
485 /* Refuse to over-write static neighbor entry. */
486 if (!(flags & IP_NEIGHBOR_FLAG_STATIC) &&
487 (ipn->ipn_flags & IP_NEIGHBOR_FLAG_STATIC))
489 /* if MAC address match, still check to send event */
490 if (0 == mac_address_cmp (&ipn->ipn_mac, mac))
491 goto check_customers;
496 * prevent a DoS attack from the data-plane that
497 * spams us with no-op updates to the MAC address
499 if (0 == mac_address_cmp (&ipn->ipn_mac, mac))
501 ip_neighbor_refresh (ipn);
502 goto check_customers;
505 mac_address_copy (&ipn->ipn_mac, mac);
507 /* A dynamic entry can become static, but not vice-versa.
508 * i.e. since if it was programmed by the CP then it must
509 * be removed by the CP */
510 if ((flags & IP_NEIGHBOR_FLAG_STATIC) &&
511 !(ipn->ipn_flags & IP_NEIGHBOR_FLAG_STATIC))
513 ip_neighbor_list_remove (ipn);
514 ipn->ipn_flags |= IP_NEIGHBOR_FLAG_STATIC;
515 ipn->ipn_flags &= ~IP_NEIGHBOR_FLAG_DYNAMIC;
520 IP_NEIGHBOR_INFO ("add: %U, %U",
521 format_vnet_sw_if_index_name, vnet_get_main (),
522 sw_if_index, format_ip46_address, ip, type,
523 format_ip_neighbor_flags, flags, format_mac_address_t,
526 ipn = ip_neighbor_alloc (&key, mac, flags);
529 return VNET_API_ERROR_LIMIT_EXCEEDED;
532 /* Update time stamp and flags. */
533 ip_neighbor_refresh (ipn);
535 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
536 fproto, &ipn->ipn_key->ipnk_ip,
537 ip_neighbor_mk_complete_walk, ipn);
540 /* Customer(s) requesting event for this address? */
541 ip_neighbor_publish (ip_neighbor_get_index (ipn));
544 *stats_index = adj_nbr_find (fproto,
545 fib_proto_to_link (fproto),
546 &ipn->ipn_key->ipnk_ip,
547 ipn->ipn_key->ipnk_sw_if_index);
552 ip_neighbor_del (const ip46_address_t * ip, ip46_type_t type, u32 sw_if_index)
556 /* main thread only */
557 ASSERT (0 == vlib_get_thread_index ());
559 IP_NEIGHBOR_INFO ("delete: %U, %U",
560 format_vnet_sw_if_index_name, vnet_get_main (),
561 sw_if_index, format_ip46_address, ip, type);
563 const ip_neighbor_key_t key = {
565 .ipnk_sw_if_index = sw_if_index,
569 ipn = ip_neighbor_db_find (&key);
572 return (VNET_API_ERROR_NO_SUCH_ENTRY);
574 ip_neighbor_free (ipn);
579 typedef struct ip_neighbor_del_all_ctx_t_
582 } ip_neighbor_del_all_ctx_t;
585 ip_neighbor_del_all_walk_cb (index_t ipni, void *arg)
587 ip_neighbor_del_all_ctx_t *ctx = arg;
589 vec_add1 (ctx->ipn_del, ipni);
591 return (WALK_CONTINUE);
595 ip_neighbor_del_all (ip46_type_t type, u32 sw_if_index)
597 IP_NEIGHBOR_INFO ("delete-all: %U, %U",
598 format_ip46_type, type,
599 format_vnet_sw_if_index_name, vnet_get_main (),
602 ip_neighbor_del_all_ctx_t ctx = {
607 ip_neighbor_walk (type, sw_if_index, ip_neighbor_del_all_walk_cb, &ctx);
609 vec_foreach (ipni, ctx.ipn_del) ip_neighbor_free (ip_neighbor_get (*ipni));
610 vec_free (ctx.ipn_del);
614 ip_neighbor_update (vnet_main_t * vnm, adj_index_t ai)
621 ip_neighbor_key_t key = {
622 .ipnk_ip = adj->sub_type.nbr.next_hop,
623 .ipnk_type = fib_proto_to_ip46 (adj->ia_nh_proto),
624 .ipnk_sw_if_index = adj->rewrite_header.sw_if_index,
626 ipn = ip_neighbor_db_find (&key);
628 switch (adj->lookup_next_index)
630 case IP_LOOKUP_NEXT_ARP:
633 adj_nbr_walk_nh (adj->rewrite_header.sw_if_index,
635 &ipn->ipn_key->ipnk_ip,
636 ip_neighbor_mk_complete_walk, ipn);
641 * no matching ARP entry.
642 * construct the rewrite required to for an ARP packet, and stick
643 * that in the adj's pipe to smoke.
645 adj_nbr_update_rewrite
647 ADJ_NBR_REWRITE_FLAG_INCOMPLETE,
648 ethernet_build_rewrite
650 adj->rewrite_header.sw_if_index,
652 VNET_REWRITE_FOR_SW_INTERFACE_ADDRESS_BROADCAST));
655 * since the FIB has added this adj for a route, it makes sense it
656 * may want to forward traffic sometime soon. Let's send a
657 * speculative ARP. just one. If we were to do periodically that
658 * wouldn't be bad either, but that's more code than i'm prepared to
659 * write at this time for relatively little reward.
662 * adj_nbr_update_rewrite may actually call fib_walk_sync.
663 * fib_walk_sync may allocate a new adjacency and potentially cause
664 * a realloc for adj_pool. When that happens, adj pointer is no
665 * longer valid here.x We refresh adj pointer accordingly.
668 ip_neighbor_probe (adj);
671 case IP_LOOKUP_NEXT_GLEAN:
672 case IP_LOOKUP_NEXT_BCAST:
673 case IP_LOOKUP_NEXT_MCAST:
674 case IP_LOOKUP_NEXT_DROP:
675 case IP_LOOKUP_NEXT_PUNT:
676 case IP_LOOKUP_NEXT_LOCAL:
677 case IP_LOOKUP_NEXT_REWRITE:
678 case IP_LOOKUP_NEXT_MCAST_MIDCHAIN:
679 case IP_LOOKUP_NEXT_MIDCHAIN:
680 case IP_LOOKUP_NEXT_ICMP_ERROR:
681 case IP_LOOKUP_N_NEXT:
688 ip_neighbor_learn (const ip_neighbor_learn_t * l)
690 ip_neighbor_add (&l->ip, l->type, &l->mac, l->sw_if_index,
691 IP_NEIGHBOR_FLAG_DYNAMIC, NULL);
694 static clib_error_t *
695 ip_neighbor_cmd (vlib_main_t * vm,
696 unformat_input_t * input, vlib_cli_command_t * cmd)
698 ip46_address_t ip = ip46_address_initializer;
699 mac_address_t mac = ZERO_MAC_ADDRESS;
700 vnet_main_t *vnm = vnet_get_main ();
701 ip_neighbor_flags_t flags;
702 u32 sw_if_index = ~0;
706 flags = IP_NEIGHBOR_FLAG_DYNAMIC;
708 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
710 /* set ip arp TenGigE1/1/0/1 1.2.3.4 aa:bb:... or aabb.ccdd... */
711 if (unformat (input, "%U %U %U",
712 unformat_vnet_sw_interface, vnm, &sw_if_index,
713 unformat_ip46_address, &ip, IP46_TYPE_ANY,
714 unformat_mac_address_t, &mac))
716 else if (unformat (input, "delete") || unformat (input, "del"))
718 else if (unformat (input, "static"))
720 flags |= IP_NEIGHBOR_FLAG_STATIC;
721 flags &= ~IP_NEIGHBOR_FLAG_DYNAMIC;
723 else if (unformat (input, "no-fib-entry"))
724 flags |= IP_NEIGHBOR_FLAG_NO_FIB_ENTRY;
725 else if (unformat (input, "count %d", &count))
731 if (sw_if_index == ~0 ||
732 ip46_address_is_zero (&ip) || mac_address_is_zero (&mac))
733 return clib_error_return (0,
734 "specify interface, IP address and MAC: `%U'",
735 format_unformat_error, input);
740 ip_neighbor_add (&ip, ip46_address_get_type (&ip), &mac, sw_if_index,
743 ip_neighbor_del (&ip, ip46_address_get_type (&ip), sw_if_index);
745 ip46_address_increment (ip46_address_get_type (&ip), &ip);
746 mac_address_increment (&mac);
756 * Add or delete IPv4 ARP cache entries.
758 * @note 'set ip neighbor' options (e.g. delete, static, 'fib-id <id>',
759 * 'count <number>', 'interface ip4_addr mac_addr') can be added in
760 * any order and combination.
764 * Add or delete IPv4 ARP cache entries as follows. MAC Address can be in
765 * either aa:bb:cc:dd:ee:ff format or aabb.ccdd.eeff format.
766 * @cliexcmd{set ip neighbor GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
767 * @cliexcmd{set ip neighbor delete GigabitEthernet2/0/0 6.0.0.3 de:ad:be:ef:ba:be}
769 * To add or delete an IPv4 ARP cache entry to or from a specific fib
771 * @cliexcmd{set ip neighbor fib-id 1 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
772 * @cliexcmd{set ip neighbor fib-id 1 delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
774 * Add or delete IPv4 static ARP cache entries as follows:
775 * @cliexcmd{set ip neighbor static GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
776 * @cliexcmd{set ip neighbor static delete GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
778 * For testing / debugging purposes, the 'set ip neighbor' command can add or
779 * delete multiple entries. Supply the 'count N' parameter:
780 * @cliexcmd{set ip neighbor count 10 GigabitEthernet2/0/0 6.0.0.3 dead.beef.babe}
783 VLIB_CLI_COMMAND (ip_neighbor_command, static) = {
784 .path = "set ip neighbor",
786 "set ip neighbor [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
787 .function = ip_neighbor_cmd,
789 VLIB_CLI_COMMAND (ip_neighbor_command2, static) = {
790 .path = "ip neighbor",
792 "ip neighbor [del] <intfc> <ip-address> <mac-address> [static] [no-fib-entry] [count <count>] [fib-id <fib-id>] [proxy <lo-addr> - <hi-addr>]",
793 .function = ip_neighbor_cmd,
798 ip_neighbor_sort (void *a1, void *a2)
800 index_t *ipni1 = a1, *ipni2 = a2;
801 ip_neighbor_t *ipn1, *ipn2;
804 ipn1 = ip_neighbor_get (*ipni1);
805 ipn2 = ip_neighbor_get (*ipni2);
807 cmp = vnet_sw_interface_compare (vnet_get_main (),
808 ipn1->ipn_key->ipnk_sw_if_index,
809 ipn2->ipn_key->ipnk_sw_if_index);
811 cmp = ip46_address_cmp (&ipn1->ipn_key->ipnk_ip, &ipn2->ipn_key->ipnk_ip);
816 ip_neighbor_entries (u32 sw_if_index, ip46_type_t type)
818 index_t *ipnis = NULL;
822 pool_foreach (ipn, ip_neighbor_pool,
824 if ((sw_if_index == ~0 ||
825 ipn->ipn_key->ipnk_sw_if_index == sw_if_index) &&
826 (IP46_TYPE_ANY == type ||
827 ipn->ipn_key->ipnk_type == type))
828 vec_add1 (ipnis, ip_neighbor_get_index(ipn));
834 vec_sort_with_function (ipnis, ip_neighbor_sort);
838 static clib_error_t *
839 ip_neighbor_show_sorted_i (vlib_main_t * vm,
840 unformat_input_t * input,
841 vlib_cli_command_t * cmd, ip46_type_t type)
843 ip_neighbor_elt_t *elt, *head;
845 head = pool_elt_at_index (ip_neighbor_elt_pool,
846 ip_neighbor_list_head[type]);
849 vlib_cli_output (vm, "%=12s%=40s%=6s%=20s%=24s", "Time", "IP",
850 "Flags", "Ethernet", "Interface");
853 /* the list is time sorted, newest first, so start from the back
854 * and work forwards. Stop when we get to one that is alive */
855 clib_llist_foreach_reverse(ip_neighbor_elt_pool,
856 ipne_anchor, head, elt,
858 vlib_cli_output (vm, "%U", format_ip_neighbor, elt->ipne_index);
865 static clib_error_t *
866 ip_neighbor_show_i (vlib_main_t * vm,
867 unformat_input_t * input,
868 vlib_cli_command_t * cmd, ip46_type_t type)
870 index_t *ipni, *ipnis = NULL;
873 /* Filter entries by interface if given. */
875 (void) unformat_user (input, unformat_vnet_sw_interface, vnet_get_main (),
878 ipnis = ip_neighbor_entries (sw_if_index, type);
881 vlib_cli_output (vm, "%=12s%=40s%=6s%=20s%=24s", "Time", "IP",
882 "Flags", "Ethernet", "Interface");
884 vec_foreach (ipni, ipnis)
886 vlib_cli_output (vm, "%U", format_ip_neighbor, *ipni);
893 static clib_error_t *
894 ip_neighbor_show (vlib_main_t * vm,
895 unformat_input_t * input, vlib_cli_command_t * cmd)
897 return (ip_neighbor_show_i (vm, input, cmd, IP46_TYPE_ANY));
900 static clib_error_t *
901 ip6_neighbor_show (vlib_main_t * vm,
902 unformat_input_t * input, vlib_cli_command_t * cmd)
904 return (ip_neighbor_show_i (vm, input, cmd, IP46_TYPE_IP6));
907 static clib_error_t *
908 ip4_neighbor_show (vlib_main_t * vm,
909 unformat_input_t * input, vlib_cli_command_t * cmd)
911 return (ip_neighbor_show_i (vm, input, cmd, IP46_TYPE_IP4));
914 static clib_error_t *
915 ip6_neighbor_show_sorted (vlib_main_t * vm,
916 unformat_input_t * input, vlib_cli_command_t * cmd)
918 return (ip_neighbor_show_sorted_i (vm, input, cmd, IP46_TYPE_IP6));
921 static clib_error_t *
922 ip4_neighbor_show_sorted (vlib_main_t * vm,
923 unformat_input_t * input, vlib_cli_command_t * cmd)
925 return (ip_neighbor_show_sorted_i (vm, input, cmd, IP46_TYPE_IP4));
929 * Display all the IP neighbor entries.
932 * Example of how to display the IPv4 ARP table:
933 * @cliexstart{show ip neighbor}
934 * Time FIB IP4 Flags Ethernet Interface
935 * 346.3028 0 6.1.1.3 de:ad:be:ef:ba:be GigabitEthernet2/0/0
936 * 3077.4271 0 6.1.1.4 S de:ad:be:ef:ff:ff GigabitEthernet2/0/0
937 * 2998.6409 1 6.2.2.3 de:ad:be:ef:00:01 GigabitEthernet2/0/0
938 * Proxy arps enabled for:
939 * Fib_index 0 6.0.0.1 - 6.0.0.11
943 VLIB_CLI_COMMAND (show_ip_neighbors_cmd_node, static) = {
944 .path = "show ip neighbors",
945 .function = ip_neighbor_show,
946 .short_help = "show ip neighbors [interface]",
948 VLIB_CLI_COMMAND (show_ip4_neighbors_cmd_node, static) = {
949 .path = "show ip4 neighbors",
950 .function = ip4_neighbor_show,
951 .short_help = "show ip4 neighbors [interface]",
953 VLIB_CLI_COMMAND (show_ip6_neighbors_cmd_node, static) = {
954 .path = "show ip6 neighbors",
955 .function = ip6_neighbor_show,
956 .short_help = "show ip6 neighbors [interface]",
958 VLIB_CLI_COMMAND (show_ip_neighbor_cmd_node, static) = {
959 .path = "show ip neighbor",
960 .function = ip_neighbor_show,
961 .short_help = "show ip neighbor [interface]",
963 VLIB_CLI_COMMAND (show_ip4_neighbor_cmd_node, static) = {
964 .path = "show ip4 neighbor",
965 .function = ip4_neighbor_show,
966 .short_help = "show ip4 neighbor [interface]",
968 VLIB_CLI_COMMAND (show_ip6_neighbor_cmd_node, static) = {
969 .path = "show ip6 neighbor",
970 .function = ip6_neighbor_show,
971 .short_help = "show ip6 neighbor [interface]",
973 VLIB_CLI_COMMAND (show_ip4_neighbor_sorted_cmd_node, static) = {
974 .path = "show ip4 neighbor-sorted",
975 .function = ip4_neighbor_show_sorted,
976 .short_help = "show ip4 neighbor-sorted",
978 VLIB_CLI_COMMAND (show_ip6_neighbor_sorted_cmd_node, static) = {
979 .path = "show ip6 neighbor-sorted",
980 .function = ip6_neighbor_show_sorted,
981 .short_help = "show ip6 neighbor-sorted",
985 static ip_neighbor_vft_t ip_nbr_vfts[IP46_N_TYPES];
988 ip_neighbor_register (ip46_type_t type, const ip_neighbor_vft_t * vft)
990 ip_nbr_vfts[type] = *vft;
994 ip_neighbor_probe_dst (const ip_adjacency_t * adj, const ip46_address_t * dst)
996 if (!vnet_sw_interface_is_admin_up (vnet_get_main (),
997 adj->rewrite_header.sw_if_index))
1000 switch (adj->ia_nh_proto)
1002 case FIB_PROTOCOL_IP6:
1003 ip6_neighbor_probe_dst (adj, &dst->ip6);
1005 case FIB_PROTOCOL_IP4:
1006 ip4_neighbor_probe_dst (adj, &dst->ip4);
1008 case FIB_PROTOCOL_MPLS:
1015 ip_neighbor_probe (const ip_adjacency_t * adj)
1017 ip_neighbor_probe_dst (adj, &adj->sub_type.nbr.next_hop);
1021 ip_neighbor_advertise (vlib_main_t * vm,
1023 const ip46_address_t * addr, u32 sw_if_index)
1025 vnet_main_t *vnm = vnet_get_main ();
1027 if (type == IP46_TYPE_IP4 || type == IP46_TYPE_BOTH)
1028 ip4_neighbor_advertise (vm, vnm, sw_if_index, (addr) ? &addr->ip4 : NULL);
1029 if (type == IP46_TYPE_IP6 || type == IP46_TYPE_BOTH)
1030 ip6_neighbor_advertise (vm, vnm, sw_if_index, (addr) ? &addr->ip6 : NULL);
1034 ip_neighbor_walk (ip46_type_t type,
1035 u32 sw_if_index, ip_neighbor_walk_cb_t cb, void *ctx)
1037 ip_neighbor_key_t *key;
1040 if (~0 == sw_if_index)
1044 vec_foreach (hash, ip_neighbor_db[type].ipndb_hash)
1047 hash_foreach (key, ipni, *hash,
1049 if (WALK_STOP == cb (ipni, ctx))
1059 if (vec_len (ip_neighbor_db[type].ipndb_hash) <= sw_if_index)
1061 hash = ip_neighbor_db[type].ipndb_hash[sw_if_index];
1064 hash_foreach (key, ipni, hash,
1066 if (WALK_STOP == cb (ipni, ctx))
1074 ip4_neighbor_proxy_add (u32 fib_index,
1075 const ip4_address_t * start,
1076 const ip4_address_t * end)
1078 if (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_add)
1080 return (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_add
1081 (fib_index, start, end));
1088 ip4_neighbor_proxy_delete (u32 fib_index,
1089 const ip4_address_t * start,
1090 const ip4_address_t * end)
1092 if (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_del)
1094 return (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_del
1095 (fib_index, start, end));
1101 ip4_neighbor_proxy_enable (u32 sw_if_index)
1103 if (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_enable)
1105 return (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_enable (sw_if_index));
1111 ip4_neighbor_proxy_disable (u32 sw_if_index)
1113 if (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_disable)
1115 return (ip_nbr_vfts[IP46_TYPE_IP4].inv_proxy4_disable (sw_if_index));
1121 ip6_neighbor_proxy_add (u32 sw_if_index, const ip6_address_t * addr)
1123 if (ip_nbr_vfts[IP46_TYPE_IP6].inv_proxy6_add)
1125 return (ip_nbr_vfts[IP46_TYPE_IP6].inv_proxy6_add (sw_if_index, addr));
1131 ip6_neighbor_proxy_del (u32 sw_if_index, const ip6_address_t * addr)
1133 if (ip_nbr_vfts[IP46_TYPE_IP6].inv_proxy6_del)
1135 return (ip_nbr_vfts[IP46_TYPE_IP6].inv_proxy6_del (sw_if_index, addr));
1141 ip_neighbor_ethernet_change_mac (ethernet_main_t * em,
1142 u32 sw_if_index, uword opaque)
1147 IP_NEIGHBOR_DBG ("mac-change: %U",
1148 format_vnet_sw_if_index_name, vnet_get_main (),
1152 pool_foreach (ipn, ip_neighbor_pool,
1154 if (ipn->ipn_key->ipnk_sw_if_index == sw_if_index)
1155 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
1156 fib_proto_from_ip46(ipn->ipn_key->ipnk_type),
1157 &ipn->ipn_key->ipnk_ip,
1158 ip_neighbor_mk_complete_walk,
1163 ai = adj_glean_get (FIB_PROTOCOL_IP4, sw_if_index);
1165 if (ADJ_INDEX_INVALID != ai)
1166 adj_glean_update_rewrite (ai);
1170 ip_neighbor_populate (ip46_type_t type, u32 sw_if_index)
1172 index_t *ipnis = NULL, *ipni;
1175 IP_NEIGHBOR_DBG ("populate: %U %U",
1176 format_vnet_sw_if_index_name, vnet_get_main (),
1177 sw_if_index, format_ip46_type, type);
1180 pool_foreach (ipn, ip_neighbor_pool,
1182 if (ipn->ipn_key->ipnk_type == type &&
1183 ipn->ipn_key->ipnk_sw_if_index == sw_if_index)
1184 vec_add1 (ipnis, ipn - ip_neighbor_pool);
1188 vec_foreach (ipni, ipnis)
1190 ipn = ip_neighbor_get (*ipni);
1192 adj_nbr_walk_nh (ipn->ipn_key->ipnk_sw_if_index,
1193 fib_proto_from_ip46 (ipn->ipn_key->ipnk_type),
1194 &ipn->ipn_key->ipnk_ip,
1195 ip_neighbor_mk_complete_walk, ipn);
1201 ip_neighbor_flush (ip46_type_t type, u32 sw_if_index)
1203 index_t *ipnis = NULL, *ipni;
1206 IP_NEIGHBOR_DBG ("flush: %U %U",
1207 format_vnet_sw_if_index_name, vnet_get_main (),
1208 sw_if_index, format_ip46_type, type);
1211 pool_foreach (ipn, ip_neighbor_pool,
1213 if (ipn->ipn_key->ipnk_type == type &&
1214 ipn->ipn_key->ipnk_sw_if_index == sw_if_index &&
1215 ip_neighbor_is_dynamic (ipn))
1216 vec_add1 (ipnis, ipn - ip_neighbor_pool);
1220 vec_foreach (ipni, ipnis) ip_neighbor_free (ip_neighbor_get (*ipni));
1225 ip_neighbor_mark_one (index_t ipni, void *ctx)
1229 ipn = ip_neighbor_get (ipni);
1231 ipn->ipn_flags |= IP_NEIGHBOR_FLAG_STALE;
1233 return (WALK_CONTINUE);
1237 ip_neighbor_mark (ip46_type_t type)
1239 ip_neighbor_walk (type, ~0, ip_neighbor_mark_one, NULL);
1242 typedef struct ip_neighbor_sweep_ctx_t_
1244 index_t *ipnsc_stale;
1245 } ip_neighbor_sweep_ctx_t;
1248 ip_neighbor_sweep_one (index_t ipni, void *arg)
1250 ip_neighbor_sweep_ctx_t *ctx = arg;
1253 ipn = ip_neighbor_get (ipni);
1255 if (ipn->ipn_flags & IP_NEIGHBOR_FLAG_STALE)
1257 vec_add1 (ctx->ipnsc_stale, ipni);
1260 return (WALK_CONTINUE);
1264 ip_neighbor_sweep (ip46_type_t type)
1266 ip_neighbor_sweep_ctx_t ctx = { };
1269 ip_neighbor_walk (type, ~0, ip_neighbor_sweep_one, &ctx);
1271 vec_foreach (ipni, ctx.ipnsc_stale)
1273 ip_neighbor_free (ip_neighbor_get (*ipni));
1275 vec_free (ctx.ipnsc_stale);
1279 * Remove any arp entries associated with the specified interface
1281 static clib_error_t *
1282 ip_neighbor_interface_admin_change (vnet_main_t * vnm,
1283 u32 sw_if_index, u32 flags)
1287 IP_NEIGHBOR_DBG ("interface-admin: %U %s",
1288 format_vnet_sw_if_index_name, vnet_get_main (),
1290 (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP ? "up" : "down"));
1292 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1294 FOREACH_IP46_TYPE (type) ip_neighbor_populate (type, sw_if_index);
1298 /* admin down, flush all neighbours */
1299 FOREACH_IP46_TYPE (type) ip_neighbor_flush (type, sw_if_index);
1305 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (ip_neighbor_interface_admin_change);
1308 * Remove any arp entries associated with the specified interface
1310 static clib_error_t *
1311 ip_neighbor_delete_sw_interface (vnet_main_t * vnm,
1312 u32 sw_if_index, u32 is_add)
1314 IP_NEIGHBOR_DBG ("interface-change: %U %s",
1315 format_vnet_sw_if_index_name, vnet_get_main (),
1316 sw_if_index, (is_add ? "add" : "del"));
1318 if (!is_add && sw_if_index != ~0)
1322 FOREACH_IP46_TYPE (type) ip_neighbor_flush (type, sw_if_index);
1328 VNET_SW_INTERFACE_ADD_DEL_FUNCTION (ip_neighbor_delete_sw_interface);
1330 typedef struct ip_neighbor_walk_covered_ctx_t_
1333 ip46_address_t addr;
1336 } ip_neighbor_walk_covered_ctx_t;
1339 ip_neighbor_walk_covered (index_t ipni, void *arg)
1341 ip_neighbor_walk_covered_ctx_t *ctx = arg;
1344 ipn = ip_neighbor_get (ipni);
1346 ASSERT (ipn->ipn_key->ipnk_type == ctx->type);
1348 if (IP46_TYPE_IP4 == ctx->type)
1350 if (ip4_destination_matches_route (&ip4_main,
1351 &ipn->ipn_key->ipnk_ip.ip4,
1354 ip_neighbor_is_dynamic (ipn))
1356 vec_add1 (ctx->ipnis, ip_neighbor_get_index (ipn));
1359 return (WALK_CONTINUE);
1364 * callback when an interface address is added or deleted
1367 ip_neighbor_add_del_interface_address_v4 (ip4_main_t * im,
1370 ip4_address_t * address,
1372 u32 if_address_index, u32 is_del)
1375 * Flush the ARP cache of all entries covered by the address
1376 * that is being removed.
1378 IP_NEIGHBOR_DBG ("addr-%d: %U, %U/%d",
1379 (is_del ? "del" : "add"),
1380 format_vnet_sw_if_index_name, vnet_get_main (),
1381 sw_if_index, format_ip4_address, address, address_length);
1385 ip_neighbor_walk_covered_ctx_t ctx = {
1386 .addr.ip4 = *address,
1387 .type = IP46_TYPE_IP4,
1388 .length = address_length,
1392 ip_neighbor_walk (IP46_TYPE_IP4, sw_if_index,
1393 ip_neighbor_walk_covered, &ctx);
1395 vec_foreach (ipni, ctx.ipnis)
1396 ip_neighbor_free (ip_neighbor_get (*ipni));
1398 vec_free (ctx.ipnis);
1403 * callback when an interface address is added or deleted
1406 ip_neighbor_add_del_interface_address_v6 (ip6_main_t * im,
1409 ip6_address_t * address,
1411 u32 if_address_index, u32 is_del)
1414 * Flush the ARP cache of all entries covered by the address
1415 * that is being removed.
1417 IP_NEIGHBOR_DBG ("addr-change: %U, %U/%d %s",
1418 format_vnet_sw_if_index_name, vnet_get_main (),
1419 sw_if_index, format_ip6_address, address, address_length,
1420 (is_del ? "del" : "add"));
1424 ip_neighbor_walk_covered_ctx_t ctx = {
1425 .addr.ip6 = *address,
1426 .type = IP46_TYPE_IP6,
1427 .length = address_length,
1431 ip_neighbor_walk (IP46_TYPE_IP6, sw_if_index,
1432 ip_neighbor_walk_covered, &ctx);
1434 vec_foreach (ipni, ctx.ipnis)
1435 ip_neighbor_free (ip_neighbor_get (*ipni));
1437 vec_free (ctx.ipnis);
1441 typedef struct ip_neighbor_table_bind_ctx_t_
1445 } ip_neighbor_table_bind_ctx_t;
1448 ip_neighbor_walk_table_bind (index_t ipni, void *arg)
1450 ip_neighbor_table_bind_ctx_t *ctx = arg;
1453 ipn = ip_neighbor_get (ipni);
1454 ip_neighbor_adj_fib_remove (ipn, ctx->old_fib_index);
1455 ip_neighbor_adj_fib_add (ipn, ctx->new_fib_index);
1457 return (WALK_CONTINUE);
1461 ip_neighbor_table_bind_v4 (ip4_main_t * im,
1464 u32 new_fib_index, u32 old_fib_index)
1466 ip_neighbor_table_bind_ctx_t ctx = {
1467 .old_fib_index = old_fib_index,
1468 .new_fib_index = new_fib_index,
1471 ip_neighbor_walk (IP46_TYPE_IP4, sw_if_index,
1472 ip_neighbor_walk_table_bind, &ctx);
1476 ip_neighbor_table_bind_v6 (ip6_main_t * im,
1479 u32 new_fib_index, u32 old_fib_index)
1481 ip_neighbor_table_bind_ctx_t ctx = {
1482 .old_fib_index = old_fib_index,
1483 .new_fib_index = new_fib_index,
1486 ip_neighbor_walk (IP46_TYPE_IP6, sw_if_index,
1487 ip_neighbor_walk_table_bind, &ctx);
1490 typedef enum ip_neighbor_age_state_t_
1492 IP_NEIGHBOR_AGE_ALIVE,
1493 IP_NEIGHBOR_AGE_PROBE,
1494 IP_NEIGHBOR_AGE_DEAD,
1495 } ip_neighbor_age_state_t;
1497 #define IP_NEIGHBOR_PROCESS_SLEEP_LONG (0)
1499 static ip_neighbor_age_state_t
1500 ip_neighbour_age_out (index_t ipni, f64 now, f64 * wait)
1506 ipn = ip_neighbor_get (ipni);
1507 ipndb_age = ip_neighbor_db[ipn->ipn_key->ipnk_type].ipndb_age;
1508 ttl = now - ipn->ipn_time_last_updated;
1511 if (ttl > ipndb_age)
1513 IP_NEIGHBOR_DBG ("aged: %U @%f - %f > %d",
1514 format_ip_neighbor, ipni, now,
1515 ipn->ipn_time_last_updated, ipndb_age);
1516 if (ipn->ipn_n_probes > 2)
1518 /* 3 strikes and yea-re out */
1519 IP_NEIGHBOR_DBG ("dead: %U", format_ip_neighbor, ipni);
1521 return (IP_NEIGHBOR_AGE_DEAD);
1527 ai = adj_glean_get (fib_proto_from_ip46 (ipn->ipn_key->ipnk_type),
1528 ip_neighbor_get_sw_if_index (ipn));
1530 if (ADJ_INDEX_INVALID != ai)
1531 ip_neighbor_probe_dst (adj_get (ai), ip_neighbor_get_ip (ipn));
1533 ipn->ipn_n_probes++;
1539 /* here we are sure that ttl <= ipndb_age */
1540 *wait = ipndb_age - ttl + 1;
1541 return (IP_NEIGHBOR_AGE_ALIVE);
1544 return (IP_NEIGHBOR_AGE_PROBE);
1547 typedef enum ip_neighbor_process_event_t_
1549 IP_NEIGHBOR_AGE_PROCESS_WAKEUP,
1550 } ip_neighbor_process_event_t;
1553 ip_neighbor_age_loop (vlib_main_t * vm,
1554 vlib_node_runtime_t * rt,
1555 vlib_frame_t * f, ip46_type_t type)
1557 uword event_type, *event_data = NULL;
1560 /* Set the timeout to an effectively infinite value when the process starts */
1561 timeout = IP_NEIGHBOR_PROCESS_SLEEP_LONG;
1568 vlib_process_wait_for_event (vm);
1570 vlib_process_wait_for_event_or_clock (vm, timeout);
1572 event_type = vlib_process_get_events (vm, &event_data);
1573 vec_reset_length (event_data);
1575 now = vlib_time_now (vm);
1582 ip_neighbor_elt_t *elt, *head;
1585 timeout = ip_neighbor_db[type].ipndb_age;
1586 head = pool_elt_at_index (ip_neighbor_elt_pool,
1587 ip_neighbor_list_head[type]);
1590 /* the list is time sorted, newest first, so start from the back
1591 * and work forwards. Stop when we get to one that is alive */
1593 clib_llist_foreach_reverse(ip_neighbor_elt_pool,
1594 ipne_anchor, head, elt,
1596 ip_neighbor_age_state_t res;
1598 res = ip_neighbour_age_out(elt->ipne_index, now, &wait);
1600 if (IP_NEIGHBOR_AGE_ALIVE == res) {
1601 /* the oldest neighbor has not yet expired, go back to sleep */
1602 timeout = clib_min (wait, timeout);
1605 else if (IP_NEIGHBOR_AGE_DEAD == res) {
1606 /* the oldest neighbor is dead, pop it, then restart the walk
1607 * again from the back */
1608 ip_neighbor_free (ip_neighbor_get(elt->ipne_index));
1612 timeout = clib_min (wait, timeout);
1617 case IP_NEIGHBOR_AGE_PROCESS_WAKEUP:
1620 if (!ip_neighbor_db[type].ipndb_age)
1622 /* aging has been disabled */
1626 ip_neighbor_elt_t *elt, *head;
1628 head = pool_elt_at_index (ip_neighbor_elt_pool,
1629 ip_neighbor_list_head[type]);
1630 /* no neighbors yet */
1631 if (clib_llist_is_empty (ip_neighbor_elt_pool, ipne_anchor, head))
1633 timeout = ip_neighbor_db[type].ipndb_age;
1637 /* poke the oldset neighbour for aging, which returns how long we sleep for */
1638 elt = clib_llist_prev (ip_neighbor_elt_pool, ipne_anchor, head);
1639 ip_neighbour_age_out (elt->ipne_index, now, &timeout);
1648 ip4_neighbor_age_process (vlib_main_t * vm,
1649 vlib_node_runtime_t * rt, vlib_frame_t * f)
1651 return (ip_neighbor_age_loop (vm, rt, f, IP46_TYPE_IP4));
1655 ip6_neighbor_age_process (vlib_main_t * vm,
1656 vlib_node_runtime_t * rt, vlib_frame_t * f)
1658 return (ip_neighbor_age_loop (vm, rt, f, IP46_TYPE_IP6));
1662 VLIB_REGISTER_NODE (ip4_neighbor_age_process_node,static) = {
1663 .function = ip4_neighbor_age_process,
1664 .type = VLIB_NODE_TYPE_PROCESS,
1665 .name = "ip4-neighbor-age-process",
1667 VLIB_REGISTER_NODE (ip6_neighbor_age_process_node,static) = {
1668 .function = ip6_neighbor_age_process,
1669 .type = VLIB_NODE_TYPE_PROCESS,
1670 .name = "ip6-neighbor-age-process",
1675 ip_neighbor_config (ip46_type_t type, u32 limit, u32 age, bool recycle)
1677 ip_neighbor_db[type].ipndb_limit = limit;
1678 ip_neighbor_db[type].ipndb_recycle = recycle;
1679 ip_neighbor_db[type].ipndb_age = age;
1681 vlib_process_signal_event (vlib_get_main (),
1682 (IP46_TYPE_IP4 == type ?
1683 ip4_neighbor_age_process_node.index :
1684 ip6_neighbor_age_process_node.index),
1685 IP_NEIGHBOR_AGE_PROCESS_WAKEUP, 0);
1690 static clib_error_t *
1691 ip_neighbor_config_show (vlib_main_t * vm,
1692 unformat_input_t * input, vlib_cli_command_t * cmd)
1697 FOREACH_IP46_TYPE(type) {
1698 vlib_cli_output (vm, "%U:", format_ip46_type, type);
1699 vlib_cli_output (vm, " limit:%d, age:%d, recycle:%d",
1700 ip_neighbor_db[type].ipndb_limit,
1701 ip_neighbor_db[type].ipndb_age,
1702 ip_neighbor_db[type].ipndb_recycle);
1710 VLIB_CLI_COMMAND (show_ip_neighbor_cfg_cmd_node, static) = {
1711 .path = "show ip neighbor-config",
1712 .function = ip_neighbor_config_show,
1713 .short_help = "show ip neighbor-config",
1717 static clib_error_t *
1718 ip_neighbor_init (vlib_main_t * vm)
1721 ip4_add_del_interface_address_callback_t cb = {
1722 .function = ip_neighbor_add_del_interface_address_v4,
1724 vec_add1 (ip4_main.add_del_interface_address_callbacks, cb);
1727 ip6_add_del_interface_address_callback_t cb = {
1728 .function = ip_neighbor_add_del_interface_address_v6,
1730 vec_add1 (ip6_main.add_del_interface_address_callbacks, cb);
1733 ip4_table_bind_callback_t cb = {
1734 .function = ip_neighbor_table_bind_v4,
1736 vec_add1 (ip4_main.table_bind_callbacks, cb);
1739 ip6_table_bind_callback_t cb = {
1740 .function = ip_neighbor_table_bind_v6,
1742 vec_add1 (ip6_main.table_bind_callbacks, cb);
1745 ethernet_address_change_ctx_t ctx = {
1746 .function = ip_neighbor_ethernet_change_mac,
1747 .function_opaque = 0,
1749 vec_add1 (ethernet_main.address_change_callbacks, ctx);
1752 ipn_logger = vlib_log_register_class ("ip", "neighbor");
1756 FOREACH_IP46_TYPE (type)
1757 ip_neighbor_list_head[type] =
1758 clib_llist_make_head (ip_neighbor_elt_pool, ipne_anchor);
1764 VLIB_INIT_FUNCTION (ip_neighbor_init) =
1766 .runs_after = VLIB_INITS("ip_main_init"),
1771 * fd.io coding-style-patch-verification: ON
1774 * eval: (c-set-style "gnu")