2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * ip/ip_lookup.c: ip4/6 adjacency and lookup table managment
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vnet/ip/ip.h>
41 #include <vnet/adj/adj.h>
42 #include <vnet/fib/fib_table.h>
43 #include <vnet/fib/ip4_fib.h>
44 #include <vnet/fib/ip6_fib.h>
45 #include <vnet/mpls/mpls.h>
46 #include <vnet/dpo/drop_dpo.h>
47 #include <vnet/dpo/classify_dpo.h>
48 #include <vnet/dpo/punt_dpo.h>
49 #include <vnet/dpo/receive_dpo.h>
50 #include <vnet/dpo/ip_null_dpo.h>
54 * @brief IPv4 and IPv6 adjacency and lookup table managment.
59 ip_interface_address_add_del (ip_lookup_main_t * lm,
63 u32 is_del, u32 * result_if_address_index)
65 vnet_main_t *vnm = vnet_get_main ();
66 ip_interface_address_t *a, *prev, *next;
67 uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
69 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index,
71 a = p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
73 /* Verify given length. */
74 if ((a && (address_length != a->address_length)) || (address_length == 0))
76 vnm->api_errno = VNET_API_ERROR_ADDRESS_LENGTH_MISMATCH;
77 return clib_error_create
78 ("%U wrong length (expected %d) for interface %U",
79 lm->format_address_and_length, addr_fib,
80 address_length, a ? a->address_length : -1,
81 format_vnet_sw_if_index_name, vnm, sw_if_index);
88 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
89 vnm->api_errno = VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
90 return clib_error_create ("%U not found for interface %U",
91 lm->format_address_and_length,
92 addr_fib, address_length,
93 format_vnet_sw_interface_name, vnm, si);
96 if (a->prev_this_sw_interface != ~0)
99 pool_elt_at_index (lm->if_address_pool,
100 a->prev_this_sw_interface);
101 prev->next_this_sw_interface = a->next_this_sw_interface;
103 if (a->next_this_sw_interface != ~0)
106 pool_elt_at_index (lm->if_address_pool,
107 a->next_this_sw_interface);
108 next->prev_this_sw_interface = a->prev_this_sw_interface;
110 if (a->prev_this_sw_interface == ~0)
111 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
112 a->next_this_sw_interface;
115 if ((a->next_this_sw_interface == ~0)
116 && (a->prev_this_sw_interface == ~0))
117 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
119 mhash_unset (&lm->address_to_if_address_index, addr_fib,
121 pool_put (lm->if_address_pool, a);
123 if (result_if_address_index)
124 *result_if_address_index = ~0;
129 u32 pi; /* previous index */
131 u32 hi; /* head index */
133 pool_get (lm->if_address_pool, a);
134 memset (a, ~0, sizeof (a[0]));
135 ai = a - lm->if_address_pool;
137 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
139 while (pi != (u32) ~ 0)
141 prev = pool_elt_at_index (lm->if_address_pool, pi);
142 pi = prev->next_this_sw_interface;
144 pi = prev ? prev - lm->if_address_pool : (u32) ~ 0;
146 a->address_key = mhash_set (&lm->address_to_if_address_index,
147 addr_fib, ai, /* old_value */ 0);
148 a->address_length = address_length;
149 a->sw_if_index = sw_if_index;
151 a->prev_this_sw_interface = pi;
152 a->next_this_sw_interface = ~0;
154 prev->next_this_sw_interface = ai;
156 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
157 (hi != ~0) ? hi : ai;
158 if (result_if_address_index)
159 *result_if_address_index = ai;
163 if (result_if_address_index)
164 *result_if_address_index = a - lm->if_address_pool;
168 return /* no error */ 0;
172 ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
174 /* ensure that adjacency is cacheline aligned and sized */
175 STATIC_ASSERT (STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0,
176 "Cache line marker must be 1st element in struct");
177 STATIC_ASSERT (STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
178 CLIB_CACHE_LINE_BYTES,
179 "Data in cache line 0 is bigger than cache line size");
181 /* Preallocate three "special" adjacencies */
182 lm->adjacency_heap = adj_pool;
184 if (!lm->fib_result_n_bytes)
185 lm->fib_result_n_bytes = sizeof (uword);
190 lm->format_address_and_length = format_ip6_address_and_length;
191 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
192 sizeof (ip6_address_fib_t));
196 lm->format_address_and_length = format_ip4_address_and_length;
197 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
198 sizeof (ip4_address_fib_t));
204 /* Setup all IP protocols to be punted and builtin-unknown. */
205 for (i = 0; i < 256; i++)
207 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
208 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
211 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
212 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
213 IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
214 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] =
215 IP_BUILTIN_PROTOCOL_UDP;
216 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 :
218 IP_BUILTIN_PROTOCOL_ICMP;
223 format_ip_flow_hash_config (u8 * s, va_list * args)
225 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
227 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
228 foreach_flow_hash_bit;
235 format_ip_lookup_next (u8 * s, va_list * args)
237 ip_lookup_next_t n = va_arg (*args, ip_lookup_next_t);
243 s = format (s, "unknown %d", n);
246 case IP_LOOKUP_NEXT_DROP:
249 case IP_LOOKUP_NEXT_PUNT:
252 case IP_LOOKUP_NEXT_ARP:
255 case IP_LOOKUP_NEXT_MIDCHAIN:
258 case IP_LOOKUP_NEXT_GLEAN:
261 case IP_LOOKUP_NEXT_REWRITE:
266 vec_add (s, t, strlen (t));
272 format_ip_adjacency_packet_data (u8 * s, va_list * args)
274 vnet_main_t *vnm = va_arg (*args, vnet_main_t *);
275 u32 adj_index = va_arg (*args, u32);
276 u8 *packet_data = va_arg (*args, u8 *);
277 u32 n_packet_data_bytes = va_arg (*args, u32);
278 ip_adjacency_t *adj = adj_get (adj_index);
280 switch (adj->lookup_next_index)
282 case IP_LOOKUP_NEXT_REWRITE:
284 format_vnet_rewrite_header,
285 vnm->vlib_main, &adj->rewrite_header, packet_data,
286 n_packet_data_bytes);
297 unformat_dpo (unformat_input_t * input, va_list * args)
299 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
300 fib_protocol_t fp = va_arg (*args, int);
303 proto = fib_proto_to_dpo (fp);
305 if (unformat (input, "drop"))
306 dpo_copy (dpo, drop_dpo_get (proto));
307 else if (unformat (input, "punt"))
308 dpo_copy (dpo, punt_dpo_get (proto));
309 else if (unformat (input, "local"))
310 receive_dpo_add_or_lock (proto, ~0, NULL, dpo);
311 else if (unformat (input, "null-send-unreach"))
312 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
313 else if (unformat (input, "null-send-prohibit"))
314 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
315 else if (unformat (input, "null"))
316 ip_null_dpo_add_and_lock (proto, IP_NULL_ACTION_NONE, dpo);
317 else if (unformat (input, "classify"))
319 u32 classify_table_index;
321 if (!unformat (input, "%d", &classify_table_index))
323 clib_warning ("classify adj must specify table index");
327 dpo_set (dpo, DPO_CLASSIFY, proto,
328 classify_dpo_create (proto, classify_table_index));
336 const ip46_address_t zero_addr = {
342 fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id)
344 ip4_main_t *im4 = &ip4_main;
345 ip6_main_t *im6 = &ip6_main;
350 case FIB_PROTOCOL_IP4:
351 p = hash_get (im4->fib_index_by_table_id, table_id);
353 case FIB_PROTOCOL_IP6:
354 p = hash_get (im6->fib_index_by_table_id, table_id);
368 vnet_ip_route_cmd (vlib_main_t * vm,
369 unformat_input_t * main_input, vlib_cli_command_t * cmd)
371 unformat_input_t _line_input, *line_input = &_line_input;
372 fib_route_path_t *rpaths = NULL, rpath;
373 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
374 fib_prefix_t *prefixs = NULL, pfx;
375 mpls_label_t out_label, via_label;
376 clib_error_t *error = NULL;
377 u32 table_id, is_del;
383 vnm = vnet_get_main ();
387 memset (&pfx, 0, sizeof (pfx));
388 out_label = via_label = MPLS_LABEL_INVALID;
390 /* Get a line of input. */
391 if (!unformat_user (main_input, unformat_line_input, line_input))
394 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
396 memset (&rpath, 0, sizeof (rpath));
398 if (unformat (line_input, "table %d", &table_id))
400 else if (unformat (line_input, "del"))
402 else if (unformat (line_input, "add"))
404 else if (unformat (line_input, "resolve-via-host"))
406 if (vec_len (rpaths) == 0)
408 error = clib_error_return (0, "Paths then flags");
411 rpaths[vec_len (rpaths) - 1].frp_flags |=
412 FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
414 else if (unformat (line_input, "resolve-via-attached"))
416 if (vec_len (rpaths) == 0)
418 error = clib_error_return (0, "Paths then flags");
421 rpaths[vec_len (rpaths) - 1].frp_flags |=
422 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
424 else if (unformat (line_input, "out-label %U",
425 unformat_mpls_unicast_label, &out_label))
427 if (vec_len (rpaths) == 0)
429 error = clib_error_return (0, "Paths then labels");
432 vec_add1 (rpaths[vec_len (rpaths) - 1].frp_label_stack, out_label);
434 else if (unformat (line_input, "via-label %U",
435 unformat_mpls_unicast_label, &rpath.frp_local_label))
437 rpath.frp_weight = 1;
438 rpath.frp_proto = FIB_PROTOCOL_MPLS;
439 rpath.frp_sw_if_index = ~0;
440 vec_add1 (rpaths, rpath);
442 else if (unformat (line_input, "count %f", &count))
445 else if (unformat (line_input, "%U/%d",
446 unformat_ip4_address, &pfx.fp_addr.ip4, &pfx.fp_len))
448 pfx.fp_proto = FIB_PROTOCOL_IP4;
449 vec_add1 (prefixs, pfx);
451 else if (unformat (line_input, "%U/%d",
452 unformat_ip6_address, &pfx.fp_addr.ip6, &pfx.fp_len))
454 pfx.fp_proto = FIB_PROTOCOL_IP6;
455 vec_add1 (prefixs, pfx);
457 else if (unformat (line_input, "via %U %U weight %u",
458 unformat_ip4_address,
460 unformat_vnet_sw_interface, vnm,
461 &rpath.frp_sw_if_index, &rpath.frp_weight))
463 rpath.frp_proto = FIB_PROTOCOL_IP4;
464 vec_add1 (rpaths, rpath);
467 else if (unformat (line_input, "via %U %U weight %u",
468 unformat_ip6_address,
470 unformat_vnet_sw_interface, vnm,
471 &rpath.frp_sw_if_index, &rpath.frp_weight))
473 rpath.frp_proto = FIB_PROTOCOL_IP6;
474 vec_add1 (rpaths, rpath);
477 else if (unformat (line_input, "via %U %U",
478 unformat_ip4_address,
480 unformat_vnet_sw_interface, vnm,
481 &rpath.frp_sw_if_index))
483 rpath.frp_weight = 1;
484 rpath.frp_proto = FIB_PROTOCOL_IP4;
485 vec_add1 (rpaths, rpath);
488 else if (unformat (line_input, "via %U %U",
489 unformat_ip6_address,
491 unformat_vnet_sw_interface, vnm,
492 &rpath.frp_sw_if_index))
494 rpath.frp_weight = 1;
495 rpath.frp_proto = FIB_PROTOCOL_IP6;
496 vec_add1 (rpaths, rpath);
498 else if (unformat (line_input, "via %U next-hop-table %d",
499 unformat_ip4_address,
500 &rpath.frp_addr.ip4, &rpath.frp_fib_index))
502 rpath.frp_weight = 1;
503 rpath.frp_sw_if_index = ~0;
504 rpath.frp_proto = FIB_PROTOCOL_IP4;
505 vec_add1 (rpaths, rpath);
507 else if (unformat (line_input, "via %U next-hop-table %d",
508 unformat_ip6_address,
509 &rpath.frp_addr.ip6, &rpath.frp_fib_index))
511 rpath.frp_weight = 1;
512 rpath.frp_sw_if_index = ~0;
513 rpath.frp_proto = FIB_PROTOCOL_IP6;
514 vec_add1 (rpaths, rpath);
516 else if (unformat (line_input, "via %U",
517 unformat_ip4_address, &rpath.frp_addr.ip4))
520 * the recursive next-hops are by default in the same table
523 rpath.frp_fib_index = table_id;
524 rpath.frp_weight = 1;
525 rpath.frp_sw_if_index = ~0;
526 rpath.frp_proto = FIB_PROTOCOL_IP4;
527 vec_add1 (rpaths, rpath);
529 else if (unformat (line_input, "via %U",
530 unformat_ip6_address, &rpath.frp_addr.ip6))
532 rpath.frp_fib_index = table_id;
533 rpath.frp_weight = 1;
534 rpath.frp_sw_if_index = ~0;
535 rpath.frp_proto = FIB_PROTOCOL_IP6;
536 vec_add1 (rpaths, rpath);
538 else if (unformat (line_input,
539 "lookup in table %d", &rpath.frp_fib_index))
541 rpath.frp_proto = pfx.fp_proto;
542 rpath.frp_sw_if_index = ~0;
543 vec_add1 (rpaths, rpath);
545 else if (vec_len (prefixs) > 0 &&
546 unformat (line_input, "via %U",
547 unformat_dpo, &dpo, prefixs[0].fp_proto))
549 vec_add1 (dpos, dpo);
553 error = unformat_parse_error (line_input);
558 unformat_free (line_input);
560 if (vec_len (prefixs) == 0)
563 clib_error_return (0, "expected ip4/ip6 destination address/length.");
567 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
569 error = clib_error_return (0, "expected paths.");
576 * if no table_id is passed we will manipulate the default
582 fib_index = fib_table_id_find_fib_index (prefixs[0].fp_proto, table_id);
586 error = clib_error_return (0, "Nonexistent table id %d", table_id);
591 for (i = 0; i < vec_len (prefixs); i++)
593 if (is_del && 0 == vec_len (rpaths))
595 fib_table_entry_delete (fib_index, &prefixs[i], FIB_SOURCE_CLI);
597 else if (!is_del && 1 == vec_len (dpos))
599 fib_table_entry_special_dpo_add (fib_index,
602 FIB_ENTRY_FLAG_EXCLUSIVE,
604 dpo_reset (&dpos[0]);
606 else if (vec_len (dpos) > 0)
609 clib_error_return (0,
610 "Load-balancing over multiple special adjacencies is unsupported");
613 else if (0 < vec_len (rpaths))
616 ip46_address_t dst = prefixs[i].fp_addr;
619 t[0] = vlib_time_now (vm);
620 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
623 for (k = 0; k < n; k++)
625 for (j = 0; j < vec_len (rpaths); j++)
629 * the CLI parsing stored table Ids, swap to FIB indicies
631 fi = fib_table_id_find_fib_index (prefixs[i].fp_proto,
632 rpaths[i].frp_fib_index);
637 clib_error_return (0, "Via table %d does not exist",
638 rpaths[i].frp_fib_index);
641 rpaths[i].frp_fib_index = fi;
643 fib_prefix_t rpfx = {
644 .fp_len = prefixs[i].fp_len,
645 .fp_proto = prefixs[i].fp_proto,
650 fib_table_entry_path_remove2 (fib_index,
652 FIB_SOURCE_CLI, &rpaths[j]);
654 fib_table_entry_path_add2 (fib_index,
661 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
664 clib_host_to_net_u32 (incr +
665 clib_net_to_host_u32 (dst.
670 int bucket = (incr < 64 ? 0 : 1);
671 dst.ip6.as_u64[bucket] =
672 clib_host_to_net_u64 (incr +
673 clib_net_to_host_u64 (dst.ip6.as_u64
678 t[1] = vlib_time_now (vm);
680 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
684 error = clib_error_return (0, "Don't understand what you want...");
698 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
700 .short_help = "Internet protocol (IP) commands",
705 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
707 .short_help = "Internet protocol version 6 (IPv6) commands",
712 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
714 .short_help = "Internet protocol (IP) show commands",
719 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
721 .short_help = "Internet protocol version 6 (IPv6) show commands",
726 * This command is used to add or delete IPv4 or IPv6 routes. All
727 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
728 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
729 * can be IPv4 or IPv6, but all must be of the same form in a single
730 * command. To display the current set of routes, use the commands
731 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
734 * Example of how to add a straight forward static route:
735 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
736 * Example of how to delete a straight forward static route:
737 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
738 * Mainly for route add/del performance testing, one can add or delete
739 * multiple routes by adding 'count N' to the previous item:
740 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
741 * Add multiple routes for the same destination to create equal-cost multipath:
742 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
743 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
744 * For unequal-cost multipath, specify the desired weights. This
745 * combination of weights results in 3/4 of the traffic following the
746 * second path, 1/4 following the first path:
747 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
748 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
749 * To add a route to a particular FIB table (VRF), use:
750 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
753 VLIB_CLI_COMMAND (ip_route_command, static) = {
755 .short_help = "ip route [add|del] [count <n>] <dst-ip-addr>/<width> [table <table-id>] [via <next-hop-ip-addr> [<interface>] [weight <weight>]] | [via arp <interface> <adj-hop-ip-addr>] | [via drop|punt|local<id>|arp|classify <classify-idx>] [lookup in table <out-table-id>]",
756 .function = vnet_ip_route_cmd,
762 * The next two routines address a longstanding script hemorrhoid.
763 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
764 * or dependent route-adds will simply fail.
766 static clib_error_t *
767 ip6_probe_neighbor_wait (vlib_main_t * vm, ip6_address_t * a, u32 sw_if_index,
770 vnet_main_t *vnm = vnet_get_main ();
775 uword *event_data = 0;
777 ASSERT (vlib_in_process_context (vm));
780 vnet_register_ip6_neighbor_resolution_event
781 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
782 1 /* event */ , 0 /* data */ );
784 for (i = 0; i < retry_count; i++)
786 /* The interface may be down, etc. */
787 e = ip6_probe_neighbor (vm, a, sw_if_index);
792 vlib_process_wait_for_event_or_clock (vm, 1.0);
793 event_type = vlib_process_get_events (vm, &event_data);
796 case 1: /* resolved... */
797 vlib_cli_output (vm, "Resolved %U", format_ip6_address, a);
801 case ~0: /* timeout */
805 clib_warning ("unknown event_type %d", event_type);
807 vec_reset_length (event_data);
813 return clib_error_return (0, "Resolution failed for %U",
814 format_ip6_address, a);
818 static clib_error_t *
819 ip4_probe_neighbor_wait (vlib_main_t * vm, ip4_address_t * a, u32 sw_if_index,
822 vnet_main_t *vnm = vnet_get_main ();
827 uword *event_data = 0;
829 ASSERT (vlib_in_process_context (vm));
832 vnet_register_ip4_arp_resolution_event
833 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
834 1 /* event */ , 0 /* data */ );
836 for (i = 0; i < retry_count; i++)
838 /* The interface may be down, etc. */
839 e = ip4_probe_neighbor (vm, a, sw_if_index);
844 vlib_process_wait_for_event_or_clock (vm, 1.0);
845 event_type = vlib_process_get_events (vm, &event_data);
848 case 1: /* resolved... */
849 vlib_cli_output (vm, "Resolved %U", format_ip4_address, a);
853 case ~0: /* timeout */
857 clib_warning ("unknown event_type %d", event_type);
859 vec_reset_length (event_data);
864 vec_reset_length (event_data);
867 return clib_error_return (0, "Resolution failed for %U",
868 format_ip4_address, a);
872 static clib_error_t *
873 probe_neighbor_address (vlib_main_t * vm,
874 unformat_input_t * input, vlib_cli_command_t * cmd)
876 vnet_main_t *vnm = vnet_get_main ();
877 unformat_input_t _line_input, *line_input = &_line_input;
880 clib_error_t *error = 0;
881 u32 sw_if_index = ~0;
886 /* Get a line of input. */
887 if (!unformat_user (input, unformat_line_input, line_input))
890 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
892 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
895 else if (unformat (line_input, "retry %d", &retry_count))
898 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
900 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
906 return clib_error_return (0, "unknown input '%U'",
907 format_unformat_error, line_input);
910 unformat_free (line_input);
912 if (sw_if_index == ~0)
913 return clib_error_return (0, "Interface required, not set.");
914 if (address_set == 0)
915 return clib_error_return (0, "ip address required, not set.");
917 return clib_error_return (0, "Multiple ip addresses not supported.");
920 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
922 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
928 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
929 * attempts IPv6 neighbor discovery depending on the supplied IP address
932 * @note This command will not immediately affect the indicated FIB; it
933 * is not suitable for use in establishing a FIB entry prior to adding
934 * recursive FIB entries. As in: don't use it in a script to probe a
935 * gateway prior to adding a default route. It won't work. Instead,
936 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
937 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
940 * Example of probe for an IPv4 address:
941 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
944 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
945 .path = "ip probe-neighbor",
946 .function = probe_neighbor_address,
947 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",
953 * fd.io coding-style-patch-verification: ON
956 * eval: (c-set-style "gnu")