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,
64 u32 * result_if_address_index)
66 vnet_main_t * vnm = vnet_get_main();
67 ip_interface_address_t * a, * prev, * next;
68 uword * p = mhash_get (&lm->address_to_if_address_index, addr_fib);
70 vec_validate_init_empty (lm->if_address_pool_index_by_sw_if_index, sw_if_index, ~0);
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)
98 prev = pool_elt_at_index (lm->if_address_pool, a->prev_this_sw_interface);
99 prev->next_this_sw_interface = a->next_this_sw_interface;
101 if (a->next_this_sw_interface != ~0)
103 next = pool_elt_at_index (lm->if_address_pool, a->next_this_sw_interface);
104 next->prev_this_sw_interface = a->prev_this_sw_interface;
106 if(a->prev_this_sw_interface == ~0)
107 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = a->next_this_sw_interface;
110 if ((a->next_this_sw_interface == ~0) && (a->prev_this_sw_interface == ~0))
111 lm->if_address_pool_index_by_sw_if_index[sw_if_index] = ~0;
113 mhash_unset (&lm->address_to_if_address_index, addr_fib,
115 pool_put (lm->if_address_pool, a);
117 if (result_if_address_index)
118 *result_if_address_index = ~0;
123 u32 pi; /* previous index */
125 u32 hi; /* head index */
127 pool_get (lm->if_address_pool, a);
128 memset (a, ~0, sizeof (a[0]));
129 ai = a - lm->if_address_pool;
131 hi = pi = lm->if_address_pool_index_by_sw_if_index[sw_if_index];
133 while (pi != (u32)~0)
135 prev = pool_elt_at_index(lm->if_address_pool, pi);
136 pi = prev->next_this_sw_interface;
138 pi = prev ? prev - lm->if_address_pool : (u32)~0;
140 a->address_key = mhash_set (&lm->address_to_if_address_index,
141 addr_fib, ai, /* old_value */ 0);
142 a->address_length = address_length;
143 a->sw_if_index = sw_if_index;
145 a->prev_this_sw_interface = pi;
146 a->next_this_sw_interface = ~0;
148 prev->next_this_sw_interface = ai;
150 lm->if_address_pool_index_by_sw_if_index[sw_if_index] =
151 (hi != ~0) ? hi : ai;
152 if (result_if_address_index)
153 *result_if_address_index = ai;
157 if (result_if_address_index)
158 *result_if_address_index = a - lm->if_address_pool;
162 return /* no error */ 0;
165 void ip_lookup_init (ip_lookup_main_t * lm, u32 is_ip6)
167 /* ensure that adjacency is cacheline aligned and sized */
168 ASSERT(STRUCT_OFFSET_OF(ip_adjacency_t, cacheline0) == 0);
169 ASSERT(STRUCT_OFFSET_OF(ip_adjacency_t, cacheline1) == CLIB_CACHE_LINE_BYTES);
171 /* Preallocate three "special" adjacencies */
172 lm->adjacency_heap = adj_pool;
174 if (! lm->fib_result_n_bytes)
175 lm->fib_result_n_bytes = sizeof (uword);
180 lm->format_address_and_length = format_ip6_address_and_length;
181 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
182 sizeof (ip6_address_fib_t));
186 lm->format_address_and_length = format_ip4_address_and_length;
187 mhash_init (&lm->address_to_if_address_index, sizeof (uword),
188 sizeof (ip4_address_fib_t));
194 /* Setup all IP protocols to be punted and builtin-unknown. */
195 for (i = 0; i < 256; i++)
197 lm->local_next_by_ip_protocol[i] = IP_LOCAL_NEXT_PUNT;
198 lm->builtin_protocol_by_ip_protocol[i] = IP_BUILTIN_PROTOCOL_UNKNOWN;
201 lm->local_next_by_ip_protocol[IP_PROTOCOL_UDP] = IP_LOCAL_NEXT_UDP_LOOKUP;
202 lm->local_next_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 : IP_PROTOCOL_ICMP] = IP_LOCAL_NEXT_ICMP;
203 lm->builtin_protocol_by_ip_protocol[IP_PROTOCOL_UDP] = IP_BUILTIN_PROTOCOL_UDP;
204 lm->builtin_protocol_by_ip_protocol[is_ip6 ? IP_PROTOCOL_ICMP6 : IP_PROTOCOL_ICMP] = IP_BUILTIN_PROTOCOL_ICMP;
208 u8 * format_ip_flow_hash_config (u8 * s, va_list * args)
210 flow_hash_config_t flow_hash_config = va_arg (*args, u32);
212 #define _(n,v) if (flow_hash_config & v) s = format (s, "%s ", #n);
213 foreach_flow_hash_bit;
219 u8 * format_ip_lookup_next (u8 * s, va_list * args)
221 ip_lookup_next_t n = va_arg (*args, ip_lookup_next_t);
227 s = format (s, "unknown %d", n);
230 case IP_LOOKUP_NEXT_DROP: t = "drop"; break;
231 case IP_LOOKUP_NEXT_PUNT: t = "punt"; break;
232 case IP_LOOKUP_NEXT_ARP: t = "arp"; break;
233 case IP_LOOKUP_NEXT_MIDCHAIN: t="midchain"; break;
234 case IP_LOOKUP_NEXT_GLEAN: t="glean"; break;
235 case IP_LOOKUP_NEXT_REWRITE:
240 vec_add (s, t, strlen (t));
245 u8 * format_ip_adjacency_packet_data (u8 * s, va_list * args)
247 vnet_main_t * vnm = va_arg (*args, vnet_main_t *);
248 u32 adj_index = va_arg (*args, u32);
249 u8 * packet_data = va_arg (*args, u8 *);
250 u32 n_packet_data_bytes = va_arg (*args, u32);
251 ip_adjacency_t * adj = adj_get(adj_index);
253 switch (adj->lookup_next_index)
255 case IP_LOOKUP_NEXT_REWRITE:
257 format_vnet_rewrite_header,
258 vnm->vlib_main, &adj->rewrite_header, packet_data, n_packet_data_bytes);
268 static uword unformat_dpo (unformat_input_t * input, va_list * args)
270 dpo_id_t *dpo = va_arg (*args, dpo_id_t *);
271 fib_protocol_t fp = va_arg (*args, int);
274 proto = fib_proto_to_dpo(fp);
276 if (unformat (input, "drop"))
277 dpo_copy(dpo, drop_dpo_get(proto));
278 else if (unformat (input, "punt"))
279 dpo_copy(dpo, punt_dpo_get(proto));
280 else if (unformat (input, "local"))
281 receive_dpo_add_or_lock(proto, ~0, NULL, dpo);
282 else if (unformat (input, "null-send-unreach"))
283 ip_null_dpo_add_and_lock(proto, IP_NULL_ACTION_SEND_ICMP_UNREACH, dpo);
284 else if (unformat (input, "null-send-prohibit"))
285 ip_null_dpo_add_and_lock(proto, IP_NULL_ACTION_SEND_ICMP_PROHIBIT, dpo);
286 else if (unformat (input, "null"))
287 ip_null_dpo_add_and_lock(proto, IP_NULL_ACTION_NONE, dpo);
288 else if (unformat (input, "classify"))
290 u32 classify_table_index;
292 if (!unformat (input, "%d", &classify_table_index))
294 clib_warning ("classify adj must specify table index");
298 dpo_set(dpo, DPO_CLASSIFY, proto,
299 classify_dpo_create(proto, classify_table_index));
307 const ip46_address_t zero_addr = {
314 fib_table_id_find_fib_index (fib_protocol_t proto,
317 ip4_main_t *im4 = &ip4_main;
318 ip6_main_t *im6 = &ip6_main;
323 case FIB_PROTOCOL_IP4:
324 p = hash_get(im4->fib_index_by_table_id, table_id);
326 case FIB_PROTOCOL_IP6:
327 p = hash_get(im6->fib_index_by_table_id, table_id);
341 vnet_ip_route_cmd (vlib_main_t * vm,
342 unformat_input_t * main_input,
343 vlib_cli_command_t * cmd)
345 unformat_input_t _line_input, * line_input = &_line_input;
346 fib_route_path_t *rpaths = NULL, rpath;
347 dpo_id_t dpo = DPO_INVALID, *dpos = NULL;
348 fib_prefix_t *prefixs = NULL, pfx;
349 clib_error_t * error = NULL;
350 mpls_label_t out_label;
351 u32 table_id, is_del;
357 vnm = vnet_get_main();
361 memset(&pfx, 0, sizeof(pfx));
363 /* Get a line of input. */
364 if (! unformat_user (main_input, unformat_line_input, line_input))
367 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
369 memset(&rpath, 0, sizeof(rpath));
371 if (unformat (line_input, "table %d", &table_id))
373 else if (unformat (line_input, "del"))
375 else if (unformat (line_input, "add"))
377 else if (unformat (line_input, "resolve-via-host"))
379 if (vec_len(rpaths) == 0)
381 error = clib_error_return(0 , "Paths then flags");
384 rpaths[vec_len(rpaths)-1].frp_flags |= FIB_ROUTE_PATH_RESOLVE_VIA_HOST;
386 else if (unformat (line_input, "resolve-via-attached"))
388 if (vec_len(rpaths) == 0)
390 error = clib_error_return(0 , "Paths then flags");
393 rpaths[vec_len(rpaths)-1].frp_flags |=
394 FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED;
396 else if (unformat (line_input, "out-label %U",
397 unformat_mpls_unicast_label, &out_label))
399 if (vec_len(rpaths) == 0)
401 error = clib_error_return(0 , "Paths then labels");
404 rpaths[vec_len(rpaths)-1].frp_label = out_label;
406 else if (unformat (line_input, "count %f", &count))
409 else if (unformat (line_input, "%U/%d",
410 unformat_ip4_address,
414 pfx.fp_proto = FIB_PROTOCOL_IP4;
415 vec_add1(prefixs, pfx);
417 else if (unformat (line_input, "%U/%d",
418 unformat_ip6_address,
422 pfx.fp_proto = FIB_PROTOCOL_IP6;
423 vec_add1(prefixs, pfx);
425 else if (unformat (line_input, "via %U %U weight %u",
426 unformat_ip4_address,
428 unformat_vnet_sw_interface, vnm,
429 &rpath.frp_sw_if_index,
432 rpath.frp_label = MPLS_LABEL_INVALID;
433 rpath.frp_proto = FIB_PROTOCOL_IP4;
434 vec_add1(rpaths, rpath);
437 else if (unformat (line_input, "via %U %U weight %u",
438 unformat_ip6_address,
440 unformat_vnet_sw_interface, vnm,
441 &rpath.frp_sw_if_index,
444 rpath.frp_label = MPLS_LABEL_INVALID;
445 rpath.frp_proto = FIB_PROTOCOL_IP6;
446 vec_add1(rpaths, rpath);
449 else if (unformat (line_input, "via %U %U",
450 unformat_ip4_address,
452 unformat_vnet_sw_interface, vnm,
453 &rpath.frp_sw_if_index))
455 rpath.frp_label = MPLS_LABEL_INVALID;
456 rpath.frp_weight = 1;
457 rpath.frp_proto = FIB_PROTOCOL_IP4;
458 vec_add1(rpaths, rpath);
461 else if (unformat (line_input, "via %U %U",
462 unformat_ip6_address,
464 unformat_vnet_sw_interface, vnm,
465 &rpath.frp_sw_if_index))
467 rpath.frp_label = MPLS_LABEL_INVALID;
468 rpath.frp_weight = 1;
469 rpath.frp_proto = FIB_PROTOCOL_IP6;
470 vec_add1(rpaths, rpath);
472 else if (unformat (line_input, "via %U next-hop-table %d",
473 unformat_ip4_address,
475 &rpath.frp_fib_index))
477 rpath.frp_weight = 1;
478 rpath.frp_sw_if_index = ~0;
479 rpath.frp_label = MPLS_LABEL_INVALID;
480 rpath.frp_proto = FIB_PROTOCOL_IP4;
481 vec_add1(rpaths, rpath);
483 else if (unformat (line_input, "via %U next-hop-table %d",
484 unformat_ip6_address,
486 &rpath.frp_fib_index))
488 rpath.frp_weight = 1;
489 rpath.frp_sw_if_index = ~0;
490 rpath.frp_label = MPLS_LABEL_INVALID;
491 rpath.frp_proto = FIB_PROTOCOL_IP6;
492 vec_add1(rpaths, rpath);
494 else if (unformat (line_input, "via %U",
495 unformat_ip4_address,
496 &rpath.frp_addr.ip4))
499 * the recursive next-hops are by default in the same table
502 rpath.frp_fib_index = table_id;
503 rpath.frp_weight = 1;
504 rpath.frp_sw_if_index = ~0;
505 rpath.frp_label = MPLS_LABEL_INVALID;
506 rpath.frp_proto = FIB_PROTOCOL_IP4;
507 vec_add1(rpaths, rpath);
509 else if (unformat (line_input, "via %U",
510 unformat_ip6_address,
511 &rpath.frp_addr.ip6))
513 rpath.frp_fib_index = table_id;
514 rpath.frp_weight = 1;
515 rpath.frp_sw_if_index = ~0;
516 rpath.frp_label = MPLS_LABEL_INVALID;
517 rpath.frp_proto = FIB_PROTOCOL_IP6;
518 vec_add1(rpaths, rpath);
520 else if (unformat (line_input,
521 "lookup in table %d",
522 &rpath.frp_fib_index))
524 rpath.frp_label = MPLS_LABEL_INVALID;
525 rpath.frp_proto = pfx.fp_proto;
526 rpath.frp_sw_if_index = ~0;
527 vec_add1(rpaths, rpath);
529 else if (vec_len (prefixs) > 0 &&
530 unformat (line_input, "via %U",
531 unformat_dpo, &dpo, prefixs[0].fp_proto))
533 rpath.frp_label = MPLS_LABEL_INVALID;
534 vec_add1 (dpos, dpo);
538 error = unformat_parse_error (line_input);
543 unformat_free (line_input);
545 if (vec_len (prefixs) == 0)
547 error = clib_error_return (0, "expected ip4/ip6 destination address/length.");
551 if (!is_del && vec_len (rpaths) + vec_len (dpos) == 0)
553 error = clib_error_return (0, "expected paths.");
560 * if no table_id is passed we will manipulate the default
566 fib_index = fib_table_id_find_fib_index(prefixs[0].fp_proto,
571 error = clib_error_return (0,
572 "Nonexistent table id %d",
578 for (i = 0; i < vec_len (prefixs); i++)
580 if (is_del && 0 == vec_len (rpaths))
582 fib_table_entry_delete(fib_index,
586 else if (!is_del && 1 == vec_len (dpos))
588 fib_table_entry_special_dpo_add(fib_index,
591 FIB_ENTRY_FLAG_EXCLUSIVE,
595 else if (vec_len (dpos) > 0)
597 error = clib_error_return(0 , "Load-balancing over multiple special adjacencies is unsupported");
600 else if (0 < vec_len (rpaths))
603 ip46_address_t dst = prefixs[i].fp_addr;
606 t[0] = vlib_time_now (vm);
607 incr = 1 << ((FIB_PROTOCOL_IP4 == prefixs[0].fp_proto ? 32 : 128) -
610 for (k = 0; k < n; k++)
612 for (j = 0; j < vec_len (rpaths); j++)
616 * the CLI parsing stored table Ids, swap to FIB indicies
618 fi = fib_table_id_find_fib_index(prefixs[i].fp_proto,
619 rpaths[i].frp_fib_index);
623 error = clib_error_return(0 , "Via table %d does not exist",
624 rpaths[i].frp_fib_index);
627 rpaths[i].frp_fib_index = fi;
629 fib_prefix_t rpfx = {
630 .fp_len = prefixs[i].fp_len,
631 .fp_proto = prefixs[i].fp_proto,
636 fib_table_entry_path_remove2(fib_index,
641 fib_table_entry_path_add2(fib_index,
648 if (FIB_PROTOCOL_IP4 == prefixs[0].fp_proto)
651 clib_host_to_net_u32(incr +
652 clib_net_to_host_u32 (dst.ip4.as_u32));
656 int bucket = (incr < 64 ? 0 : 1);
657 dst.ip6.as_u64[bucket] =
658 clib_host_to_net_u64(incr +
659 clib_net_to_host_u64 (
660 dst.ip6.as_u64[bucket]));
664 t[1] = vlib_time_now (vm);
666 vlib_cli_output (vm, "%.6e routes/sec", count / (t[1] - t[0]));
670 error = clib_error_return(0 , "Don't understand what you want...");
683 VLIB_CLI_COMMAND (vlib_cli_ip_command, static) = {
685 .short_help = "Internet protocol (IP) commands",
688 VLIB_CLI_COMMAND (vlib_cli_ip6_command, static) = {
690 .short_help = "Internet protocol version 6 (IPv6) commands",
693 VLIB_CLI_COMMAND (vlib_cli_show_ip_command, static) = {
695 .short_help = "Internet protocol (IP) show commands",
698 VLIB_CLI_COMMAND (vlib_cli_show_ip6_command, static) = {
700 .short_help = "Internet protocol version 6 (IPv6) show commands",
704 * This command is used to add or delete IPv4 or IPv6 routes. All
705 * IP Addresses ('<em><dst-ip-addr>/<width></em>',
706 * '<em><next-hop-ip-addr></em>' and '<em><adj-hop-ip-addr></em>')
707 * can be IPv4 or IPv6, but all must be of the same form in a single
708 * command. To display the current set of routes, use the commands
709 * '<em>show ip fib</em>' and '<em>show ip6 fib</em>'.
712 * Example of how to add a straight forward static route:
713 * @cliexcmd{ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
714 * Example of how to delete a straight forward static route:
715 * @cliexcmd{ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0}
716 * Mainly for route add/del performance testing, one can add or delete
717 * multiple routes by adding 'count N' to the previous item:
718 * @cliexcmd{ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0}
719 * Add multiple routes for the same destination to create equal-cost multipath:
720 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0}
721 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0}
722 * For unequal-cost multipath, specify the desired weights. This
723 * combination of weights results in 3/4 of the traffic following the
724 * second path, 1/4 following the first path:
725 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1}
726 * @cliexcmd{ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3}
727 * To add a route to a particular FIB table (VRF), use:
728 * @cliexcmd{ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0}
731 VLIB_CLI_COMMAND (ip_route_command, static) = {
733 .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>]",
734 .function = vnet_ip_route_cmd,
740 * The next two routines address a longstanding script hemorrhoid.
741 * Probing a v4 or v6 neighbor needs to appear to be synchronous,
742 * or dependent route-adds will simply fail.
744 static clib_error_t *
745 ip6_probe_neighbor_wait (vlib_main_t *vm, ip6_address_t * a, u32 sw_if_index,
748 vnet_main_t * vnm = vnet_get_main();
753 uword *event_data = 0;
755 ASSERT (vlib_in_process_context(vm));
758 vnet_register_ip6_neighbor_resolution_event
759 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
760 1 /* event */, 0 /* data */);
762 for (i = 0; i < retry_count; i++)
764 /* The interface may be down, etc. */
765 e = ip6_probe_neighbor (vm, a, sw_if_index);
770 vlib_process_wait_for_event_or_clock (vm, 1.0);
771 event_type = vlib_process_get_events (vm, &event_data);
774 case 1: /* resolved... */
775 vlib_cli_output (vm, "Resolved %U",
776 format_ip6_address, a);
780 case ~0: /* timeout */
784 clib_warning ("unknown event_type %d", event_type);
786 vec_reset_length (event_data);
792 return clib_error_return (0, "Resolution failed for %U",
793 format_ip6_address, a);
797 static clib_error_t *
798 ip4_probe_neighbor_wait (vlib_main_t *vm, ip4_address_t * a, u32 sw_if_index,
801 vnet_main_t * vnm = vnet_get_main();
806 uword *event_data = 0;
808 ASSERT (vlib_in_process_context(vm));
811 vnet_register_ip4_arp_resolution_event
812 (vnm, a, vlib_get_current_process (vm)->node_runtime.node_index,
813 1 /* event */, 0 /* data */);
815 for (i = 0; i < retry_count; i++)
817 /* The interface may be down, etc. */
818 e = ip4_probe_neighbor (vm, a, sw_if_index);
823 vlib_process_wait_for_event_or_clock (vm, 1.0);
824 event_type = vlib_process_get_events (vm, &event_data);
827 case 1: /* resolved... */
828 vlib_cli_output (vm, "Resolved %U",
829 format_ip4_address, a);
833 case ~0: /* timeout */
837 clib_warning ("unknown event_type %d", event_type);
839 vec_reset_length (event_data);
844 vec_reset_length (event_data);
847 return clib_error_return (0, "Resolution failed for %U",
848 format_ip4_address, a);
852 static clib_error_t *
853 probe_neighbor_address (vlib_main_t * vm,
854 unformat_input_t * input,
855 vlib_cli_command_t * cmd)
857 vnet_main_t * vnm = vnet_get_main();
858 unformat_input_t _line_input, * line_input = &_line_input;
861 clib_error_t * error = 0;
862 u32 sw_if_index = ~0;
867 /* Get a line of input. */
868 if (! unformat_user (input, unformat_line_input, line_input))
871 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
873 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm,
876 else if (unformat (line_input, "retry %d", &retry_count))
879 else if (unformat (line_input, "%U", unformat_ip4_address, &a4))
881 else if (unformat (line_input, "%U", unformat_ip6_address, &a6))
887 return clib_error_return (0, "unknown input '%U'",
888 format_unformat_error, line_input);
891 unformat_free (line_input);
893 if (sw_if_index == ~0)
894 return clib_error_return (0, "Interface required, not set.");
895 if (address_set == 0)
896 return clib_error_return (0, "ip address required, not set.");
898 return clib_error_return (0, "Multiple ip addresses not supported.");
901 error = ip4_probe_neighbor_wait (vm, &a4, sw_if_index, retry_count);
903 error = ip6_probe_neighbor_wait (vm, &a6, sw_if_index, retry_count);
909 * The '<em>ip probe-neighbor</em>' command ARPs for IPv4 addresses or
910 * attempts IPv6 neighbor discovery depending on the supplied IP address
913 * @note This command will not immediately affect the indicated FIB; it
914 * is not suitable for use in establishing a FIB entry prior to adding
915 * recursive FIB entries. As in: don't use it in a script to probe a
916 * gateway prior to adding a default route. It won't work. Instead,
917 * configure a static ARP cache entry [see '<em>set ip arp</em>'], or
918 * a static IPv6 neighbor [see '<em>set ip6 neighbor</em>'].
921 * Example of probe for an IPv4 address:
922 * @cliexcmd{ip probe-neighbor GigabitEthernet2/0/0 172.16.1.2}
925 VLIB_CLI_COMMAND (ip_probe_neighbor_command, static) = {
926 .path = "ip probe-neighbor",
927 .function = probe_neighbor_address,
928 .short_help = "ip probe-neighbor <interface> <ip4-addr> | <ip6-addr> [retry nn]",